Documentation
¶
Overview ¶
Package hostsharing provides utilities for applications running in Hostsharing environments.
It offers functionality for:
- Service name detection from environment variables or executable paths
- Parsing domain and user information from filesystem paths
- HTTP server configuration for both standard HTTP and FastCGI protocols
- Configuration file loading with support for domain-specific and user home directories
- Structured logging with request context tracking
The package is designed to integrate with Hostsharing's directory structure where applications are organized as: /home/pacs/{pac}/users/{user}/doms/{domain}
Index ¶
- Variables
- func DomainByWorkingDir() (*domain, error)
- func IsFCGI() bool
- func ListenAndServe(handler http.Handler) error
- func LogError(ctx context.Context, format string, args ...any)
- func LogInfo(ctx context.Context, format string, args ...any)
- func LogWarn(ctx context.Context, format string, args ...any)
- func ParseDomain(p string) (*domain, error)
- func ParseUser(p string) (*user, error)
- func ReadInConfig(rawVal any, app_name string, fs ...mapstructure.DecodeHookFunc) error
- func RequestLogger() func(next http.Handler) http.Handler
- func ServiceName() (string, error)
Constants ¶
This section is empty.
Variables ¶
var ErrNoFcgiEnvironment = fmt.Errorf("no fcgi environment dedected")
ErrNoFcgiEnvironment indicates that the FastCGI environment was not detected.
var ErrShortPath = fmt.Errorf("cannot dedect anything")
Functions ¶
func DomainByWorkingDir ¶
func DomainByWorkingDir() (*domain, error)
DomainByWorkingDir returns the domain parsed from the current working directory. It returns ErrShortPath if the working directory does not contain enough path components to identify a PAC, user, and domain.
func IsFCGI ¶
func IsFCGI() bool
IsFCGI checks if the current executable is running in a FastCGI environment by examining the executable path for a "fastcgi" directory component.
func ListenAndServe ¶
ListenAndServe starts an HTTP server using either FastCGI or standard HTTP, depending on the environment.
It first checks for the FCGI_LISTEN environment variable. If set, it uses FastCGI with the specified address. Otherwise, it falls back to the existing IsFCGI() logic. If neither condition is met, it starts a standard HTTP server on the default port.
Example:
// Caddyfile configuration:
// {
// auto_https off
// http_port 1313
// admin off
// }
// localhost:1313 {
// root * public
// file_server
// reverse_proxy /api/* :9000 {
// transport fastcgi
// }
// }
// Set FCGI_LISTEN=:9000 in your environment to enable FastCGI mode.
Example usage:
r := http.NewServeMux()
r.HandleFunc("/api/hello", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Hello, FastCGI!")
})
if err := hostsharing.ListenAndServe(r); err != nil {
log.Fatalf("Server failed: %v", err)
}
func LogError ¶ added in v1.3.0
LogError logs an error-level message with the request context. If a request ID is present in the context, it is included in the log record.
func LogInfo ¶ added in v1.2.0
LogInfo logs an information-level message with the request context. If a request ID is present in the context, it is included in the log record.
func LogWarn ¶ added in v1.3.0
LogWarn logs a warning-level message with the request context. If a request ID is present in the context, it is included in the log record.
func ParseDomain ¶
func ReadInConfig ¶
func ReadInConfig(rawVal any, app_name string, fs ...mapstructure.DecodeHookFunc) error
ReadInConfig reads and unmarshals configuration from a file into the provided value. It attempts to load configuration from a local file first, then falls back to searching in domain-specific and home directories. The function supports custom decode hooks for type conversion during unmarshaling.
Parameters:
- rawVal: A pointer to a struct where the unmarshaled configuration will be stored.
- app_name: The application name used to construct config file paths. If empty, it will be determined automatically via ServiceName(). Config files are expected to be named as ".<app_name>.conf".
- fs: Optional variadic mapstructure.DecodeHookFunc functions for custom type conversion during unmarshaling. If none are provided, default hooks are applied: base64StringToBytesHookFunc(), StringToTimeDurationHookFunc(), and StringToSliceHookFunc with "," delimiter.
Returns:
- error: Returns nil on success, or an error describing what went wrong during config file reading or unmarshaling.
The function searches for config in the following order:
- Local file: .<app_name>.conf
- Domain-specific path: /home/pacs/xyz00/users/foobar/doms/example.com/etc/{app_name}
- Home directory: $HOME/.<app_name>
func RequestLogger ¶
RequestLogger returns an HTTP middleware that logs requests using structured logging. It sets up a JSON logger configured for Google Cloud Logging schema, and logs request/response details including optional requestID from the request context. Certain static asset types (css, js, fonts, etc.) are excluded from logging.
func ServiceName ¶ added in v1.6.0
ServiceName returns the name of the service by checking the SERVICE_NAME environment variable first, and falling back to the executable name if the variable is not set. The ".fcgi" suffix is trimmed from the executable name if present.
It returns an error if neither the environment variable is set nor the executable path can be determined, or if the resulting name is empty.
Types ¶
This section is empty.
Source Files