Difference between revisions for Users / Eo Ny / dev
Additions:
Private Properties
Constructor
Purpose: Initializes the Http object and sets up HTTP session handling.Parameters:
-
$db- Database object reference
- Stores database reference
- Extracts and normalizes REQUEST_URI
- Detects TLS/HTTPS session status
- Determines client's real IP address
- Sets up TLS mark cookie name
- Enforces TLS session upgrade if needed
Core Methods
Session Management
session($route): void
Initializes the session handler (file-based or database-based).Parameters:
-
$route(int) - Routing flag: - Bit 2 (
$route & 2): Enable static mode for files/freecap (disables replay prevention and ID regeneration)
- Selects storage backend (file or database)
- Configures cookie settings (security, path, httponly)
- Binds IP and TLS validation
- Recovers diagnostic logs from previous session
Caching System
check_cache($page, $method): void
Determines if a page can be cached and prepares the cache check.Parameters:
-
$page(string) - Page name to cache -
$method(string) - Request method/action (e.g., 'show', 'edit')
- ✅ Enabled for GET requests only
- ✅ Disabled for POST requests
- ❌ Never cached for 'edit' or 'watch' methods
- ✅ Only cached for anonymous users (no logged-in users)
store_cache(): void
Saves the generated page content to cache file.Features:
- Retrieves output buffer content
- Saves to cache file with proper permissions
- Records cache metadata in database
- Only executes if caching flag is set and user is anonymous
invalidate_page($page): int
Invalidates all cached versions of a page.Parameters:
-
$page(string) - Page name to invalidate
- Number of cache entries invalidated
- Finds all cached versions (different methods/languages)
- Touches files to past timestamp (faster than deletion)
- Removes entries from cache metadata table
- Returns count of invalidated caches
TLS/HTTPS Security
secure_base_url(): void
Switches base URL from HTTP to HTTPS.Purpose:
- Ensures all subsequent URLs use HTTPS
- Stores original HTTP URL for fallback
- Called when TLS session is detected
ensure_tls($url): void
Enforces HTTPS for a specific URL and redirects if necessary.Parameters:
-
$url(string) - URL to secure
- If not already HTTPS and TLS is enabled, forces HTTPS redirect
- Handles both relative and absolute URLs
- Converts relative URLs using current server name
IP Address Detection
real_ip(): string (Private)
Detects client's real IP address accounting for proxies.Proxy Headers Checked (in order):
-
HTTP_X_CLUSTER_CLIENT_IP -
HTTP_X_FORWARDED_FOR(or custom header) -
HTTP_CLIENT_IP -
HTTP_X_REMOTE_ADDR -
REMOTE_ADDR(fallback)
- Filters out private/reserved IP ranges
- Respects configured reverse proxy addresses
- Returns
'0.0.0.0'as fallback
-
reverse_proxy_addresses- Comma/space-separated proxy IPs -
reverse_proxy_header- Custom header name (default:X-Forwarded-For)
HTTPS Detection
tls_session(): bool (Private)
Detects if current connection uses HTTPS/TLS.Checks (any being true = HTTPS):
-
$_SERVER['HTTPS']is 'on' -
$_SERVER['SERVER_PORT']is 443 -
$_SERVER['HTTP_X_FORWARDED_PROTO']is 'https' -
$_SERVER['HTTP_X_FORWARDED_SSL']is 'on' -
$_SERVER['HTTP_X_FORWARDED_PORT']is 443
Security Headers
http_security_headers(): void
HTTP Methods
redirect($url, $permanent = false): void
Performs an HTTP redirect.Parameters:
-
$url(string) - Target URL -
$permanent(bool) - Use 301 (permanent) vs 302 (temporary)
- Decodes
&entities to prevent broken redirects - Only works if headers not yet sent
- Uses output buffering to work anywhere in page processing
terminate(): void
Safe exit/die with cleanup.Cleanup Operations:
- Saves diagnostic logs to session flash data
- Ends script execution
status($code): void
Sets HTTP response status code.Supported Status Codes:
Example:
Caching Control
no_cache($client_only = true): void
Disables caching of the current page.Parameters:
-
$client_only(bool, default: TRUE) -
TRUE: Disable browser cache only -
FALSE: Disable both browser and server cache
-
Last-Modified: <current-time>(always fresh) -
Cache-Control: no-store
cache_promisc(): void
Marks page as publicly cacheable.Headers Set:
-
Cache-Control: public
Language Negotiation
user_agent_language(): string
Determines best language based on browser preferences.Features:
- Follows RFC 9110 section 12.5.4 (HTTP Accept-Language)
- Parses
Accept-Languageheader with quality factors - Attempts exact match first, then language fallback
- Falls back to default system language
Returns:
- Language code (e.g., 'en', 'en-US', 'de')
available_languages($subset = true): array
Returns list of available language translations.Parameters:
-
$subset(bool, default: TRUE) -
TRUE: Only allowed languages -
FALSE: All available languages
- Scans
LANG_DIRfor language files - Filters by
allowed_languagesconfig if set - Caches result in session
- System language always included
- Associative array:
['en' => 'en', 'de' => 'de', ...]
File Serving
sendfile($path, $filename = null, $age = null): void
Serves files with proper HTTP headers and caching.Parameters:
-
$path(string) - File path (or HTTP_XXX constant for error pages) -
$filename(string, optional) - Custom download filename -
$age(int, optional) - Cache age in days
- HTTP range request support (partial file downloads)
- ETag and Last-Modified conditional requests
- Proper MIME type detection
- Content-Security-Policy for special file types
- Streaming for large files
- GZip compression for text files
Example:
mime_type($path): string
Returns MIME type for a file.Returns:
- MIME type string (e.g., 'application/pdf')
- Default:
'application/octet-stream'
mime_types(): array (Private)
Loads and caches MIME types from configuration.Features:
- Reads from
config/mime.types - Caches to
cache/config/mime.types - Reloads if config is updated
Compression
gzip(): void
Compresses HTTP response with gzip/x-gzip.Features:
- Manually implements gzip (not relying on zlib.output_compression)
- Produces correct
Content-Lengthheader - Only compresses if:
- 860 bytes < content < 1 MB
- Client accepts compression
- Headers not already sent
Utility Methods
parse_str($str): array (Private)
Parses URL-encoded strings with special character handling.Purpose:
- Safely handles special characters in query/form data
- Converts encoding properly
request_uri(): string (Private)
Extracts and normalizes REQUEST_URI from server.Normalization:
- Removes base URL prefix
- Removes spaces
- Collapses multiple slashes
- Removes
..path traversal attempts - Removes leading/trailing slashes
cut_prefix($prefix, $path): string (Private)
Removes prefix from path (case-insensitive). get_header_conf($file_name): string (Private)
Loads security header configuration from files.Files Supported:
-
csp.conf/csp_custom.conf -
permissions_policy.conf/permissions_policy_custom.conf
Configuration Dependencies
Constants Used
Deletions: