Difference between revisions for Users / Eo Ny / dev
=== Overview ===
The
Http class src/class/http.php) is a core component of the WackoWiki system responsible for handling HTTP request/response processing, session management, caching, and security features. This class acts as a bridge between the web server and the wiki engine.
File Location:
src/class/http.php
Language: PHP Dependencies: Database class, Session classes, Utility classes
Ut), Diagnostics class ##
Diag)
=== Class Properties
Public Properties
Private Properties
=== Constructor
`php<!--markup:1:end--> <!--markup:2:begin-->=== %%(hl php)<!--markup:2:end--> public function __construct(&$db) <!--markup:1:begin-->`
<!--markup:2:end--> **Purpose:** Initializes the Http object and sets up HTTP session handling. **Parameters:** - <!--markup:1:begin-->`$db`<!--markup:1:end--> <!--markup:2:begin-->##$db##<!--markup:2:end--> - Database object reference **Initialization Steps:** 1. Stores database reference 2. Extracts and normalizes REQUEST_URI 3. Detects TLS/HTTPS session status 4. Determines client's real IP address 5. Sets up TLS mark cookie name 6. Enforces TLS session upgrade if needed **Example:** <!--markup:1:begin-->```php<!--markup:1:end-->** <!--markup:2:begin-->(hl php) $http = new Http($db);
` --- ##<!--markup:1:end--> <!--markup:2:begin-->%% ---- ===<!--markup:2:end--> Core Methods <!--markup:1:begin-->###<!--markup:1:end--> <!--markup:2:begin-->=== ====<!--markup:2:end--> Session Management <!--markup:1:begin-->#### `session($route): void`<!--markup:1:end--> <!--markup:2:begin-->==== ===== ##session($route): void## =====<!--markup:2:end--> Initializes the session handler (file-based or database-based). **Parameters:** - <!--markup:1:begin-->`$route`<!--markup:1:end--> <!--markup:2:begin-->##$route##<!--markup:2:end--> (int) - Routing flag: - Bit 2 <!--markup:1:begin-->(`$route<!--markup:1:end--> <!--markup:2:begin-->(##$route<!--markup:2:end--> & <!--markup:1:begin-->2`):<!--markup:1:end--> <!--markup:2:begin-->2##):<!--markup:2:end--> Enable static mode for files/freecap (disables replay prevention and ID regeneration) **Features:** - Selects storage backend (file or database) - Configures cookie settings (security, path, httponly) - Binds IP and TLS validation - Recovers diagnostic logs from previous session **Example:** <!--markup:1:begin-->`php
PHP
<!--markup:2:end-->
$http->session(0); // Normal session
$http->session(2); // Static file serving mode
<!--markup:1:begin-->```
---
###<!--markup:1:end-->
<!--markup:2:begin-->
Caching System
`check_cache($page,##check_cache($page, $method):
Parameters:
-
`$page`$page(string) - Page name to cache -
`$method`$method(string) - Request method/action (e.g., 'show', 'edit')
Caching Rules:
- ✅ 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)
Example:
`php<!--markup:1:end-->**
<!--markup:2:begin-->%%(hl php)<!--markup:2:end-->
$http->check_cache('HomePage', 'show');
<!--markup:1:begin-->
`
`store_cache(): void`---- =====##store_cache(): void##=====<!--markup:2:end--> 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 **Example:** <!--markup:1:begin-->```php<!--markup:1:end-->** <!--markup:2:begin-->(hl php) // Called at end of page rendering
$http->store_cache();
` --- #### `invalidate_page($page): int`<!--markup:1:end--> <!--markup:2:begin-->%% ---- ===== ##invalidate_page($page): int## =====<!--markup:2:end--> Invalidates all cached versions of a page. **Parameters:** - <!--markup:1:begin-->`$page`<!--markup:1:end--> <!--markup:2:begin-->##$page##<!--markup:2:end--> (string) - Page name to invalidate **Returns:** - Number of cache entries invalidated **Process:** 1. Finds all cached versions (different methods/languages) 2. Touches files to past timestamp (faster than deletion) 3. Removes entries from cache metadata table 4. Returns count of invalidated caches **Example:** <!--markup:1:begin-->`php
PHP
<!--markup:2:end-->
$count = $http->invalidate_page('HomePage');
echo "Invalidated $count cache entries";
<!--markup:1:begin-->```
---
###<!--markup:1:end-->
<!--markup:2:begin-->
TLS/HTTPS Security
`secure_base_url(): void` 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
Example:
`php<!--markup:1:end-->** <!--markup:2:begin-->%%(hl php)<!--markup:2:end--> $http->secure_base_url(); // $db->base_url now uses https:// <!--markup:1:begin-->`
`ensure_tls($url): void`---- ===== ##ensure_tls($url): void## =====<!--markup:2:end--> Enforces HTTPS for a specific URL and redirects if necessary. **Parameters:** - <!--markup:1:begin-->`$url`<!--markup:1:end--> <!--markup:2:begin-->##$url##<!--markup:2:end--> (string) - URL to secure **Behavior:** - If not already HTTPS and TLS is enabled, forces HTTPS redirect - Handles both relative and absolute URLs - Converts relative URLs using current server name **Example:** <!--markup:1:begin-->```php<!--markup:1:end-->** <!--markup:2:begin-->(hl php) $http->ensure_tls('/secure/payment');
` --- ###<!--markup:1:end--> <!--markup:2:begin-->%% ---- ====<!--markup:2:end--> IP Address Detection <!--markup:1:begin-->#### `real_ip(): string`<!--markup:1:end--> <!--markup:2:begin-->==== ===== ##real_ip(): string##<!--markup:2:end--> (Private) <!--markup:2:begin-->=====<!--markup:2:end--> Detects client's real IP address accounting for proxies. **Proxy Headers Checked (in order):** 1. <!--markup:1:begin-->`HTTP_X_CLUSTER_CLIENT_IP`<!--markup:1:end--> <!--markup:2:begin-->##HTTP_X_CLUSTER_CLIENT_IP##<!--markup:2:end--> 2. <!--markup:1:begin-->`HTTP_X_FORWARDED_FOR`<!--markup:1:end--> <!--markup:2:begin-->##HTTP_X_FORWARDED_FOR##<!--markup:2:end--> (or custom header) 3. <!--markup:1:begin-->`HTTP_CLIENT_IP`<!--markup:1:end--> <!--markup:2:begin-->##HTTP_CLIENT_IP##<!--markup:2:end--> 4. <!--markup:1:begin-->`HTTP_X_REMOTE_ADDR`<!--markup:1:end--> <!--markup:2:begin-->##HTTP_X_REMOTE_ADDR##<!--markup:2:end--> 5. <!--markup:1:begin-->`REMOTE_ADDR`<!--markup:1:end--> <!--markup:2:begin-->##REMOTE_ADDR##<!--markup:2:end--> (fallback) **Features:** - Filters out private/reserved IP ranges - Respects configured reverse proxy addresses - Returns <!--markup:1:begin-->`'0.0.0.0'`<!--markup:1:end--> <!--markup:2:begin-->##'0.0.0.0'##<!--markup:2:end--> as fallback **Configuration in Database:** - <!--markup:1:begin-->`reverse_proxy_addresses`<!--markup:1:end--> <!--markup:2:begin-->##reverse_proxy_addresses##<!--markup:2:end--> - Comma/space-separated proxy IPs - <!--markup:1:begin-->`reverse_proxy_header`<!--markup:1:end--> <!--markup:2:begin-->##reverse_proxy_header##<!--markup:2:end--> - Custom header name (default: <!--markup:1:begin-->`X-Forwarded-For`)<!--markup:1:end--> <!--markup:2:begin-->##X-Forwarded-For##)<!--markup:2:end--> **Example:** <!--markup:1:begin-->`php
PHP
<!--markup:2:end-->
$client_ip = $http->ip; // e.g., "203.0.113.42"
<!--markup:1:begin-->```
---
###<!--markup:1:end-->
<!--markup:2:begin-->
HTTPS Detection
`tls_session(): bool`tls_session(): bool (Private) =====
Detects if current connection uses HTTPS/TLS.Checks (any being true = HTTPS):
-
`$_SERVER['HTTPS']`$_SERVER['HTTPS']is 'on' -
`$_SERVER['SERVER_PORT']`$_SERVER['SERVER_PORT']is 443 -
`$_SERVER['HTTP_X_FORWARDED_PROTO']`$_SERVER['HTTP_X_FORWARDED_PROTO']is 'https' -
`$_SERVER['HTTP_X_FORWARDED_SSL']`$_SERVER['HTTP_X_FORWARDED_SSL']is 'on' -
`$_SERVER['HTTP_X_FORWARDED_PORT']`$_SERVER['HTTP_X_FORWARDED_PORT']is 443
###
Security Headers
`http_security_headers(): void`http_security_headers(): void
Sets security-related HTTP headers.
Headers Set:
CSP Configuration Options:
-
`0`0- Disabled -
`1`1- Default policy (from`csp.conf`)csp.conf) -
`2`2- Custom policy (from`csp_custom.conf`)csp_custom.conf)
Example:
`php<!--markup:1:end-->** <!--markup:2:begin-->%%(hl php)<!--markup:2:end--> $http->http_security_headers(); <!--markup:1:begin-->`
###
---- ====<!--markup:2:end--> HTTP Methods <!--markup:1:begin-->#### `redirect($url,<!--markup:1:end--> <!--markup:2:begin-->==== ===== ##redirect($url,<!--markup:2:end--> $permanent = false): <!--markup:1:begin-->void`<!--markup:1:end--> <!--markup:2:begin-->void## =====<!--markup:2:end--> Performs an HTTP redirect. **Parameters:** - <!--markup:1:begin-->`$url`<!--markup:1:end--> <!--markup:2:begin-->##$url##<!--markup:2:end--> (string) - Target URL - <!--markup:1:begin-->`$permanent`<!--markup:1:end--> <!--markup:2:begin-->##$permanent##<!--markup:2:end--> (bool) - Use 301 (permanent) vs 302 (temporary) **Features:** - Decodes <!--markup:1:begin-->`&`<!--markup:1:end--> <!--markup:2:begin-->##&##<!--markup:2:end--> entities to prevent broken redirects - Only works if headers not yet sent - Uses output buffering to work anywhere in page processing **Example:** <!--markup:1:begin-->```php<!--markup:1:end-->** <!--markup:2:begin-->(hl php) $http->redirect('http://example.com/new-page', true); // 301
$http->redirect('/wiki/HomePage'); // 302
` --- #### `terminate(): void`<!--markup:1:end--> <!--markup:2:begin-->%% ---- ===== ##terminate(): void## =====<!--markup:2:end--> Safe exit/die with cleanup. **Cleanup Operations:** - Saves diagnostic logs to session flash data - Ends script execution **Example:** <!--markup:1:begin-->`php
PHP
<!--markup:2:end-->
$http->terminate();
<!--markup:1:begin-->```
---
#### `status($code): void`<!--markup:1:end-->
<!--markup:2:begin-->
status($code): void
Sets HTTP response status code.Supported Status Codes:
`php<!--markup:1:end-->** <!--markup:2:begin-->%%(hl php)<!--markup:2:end--> 200 => 'OK' 206 => 'Partial Content' 301 => 'Moved Permanently' 302 => 'Moved Temporarily' 304 => 'Not Modified' 400 => 'Bad Request' 401 => 'Unauthorized' 403 => 'Forbidden' 404 => 'Not Found' 405 => 'Method Not Allowed' 409 => 'Conflict' 410 => 'Gone' 416 => 'Requested Range Not Satisfiable' 500 => 'Internal Server Error' 501 => 'Not Implemented' 503 => 'Service Unavailable' <!--markup:1:begin-->`
<!--markup:2:end--> **Example:** <!--markup:1:begin-->```php<!--markup:1:end-->** <!--markup:2:begin-->(hl php) $http->status(404); // Send 404 Not Found
` --- ###<!--markup:1:end--> <!--markup:2:begin-->%% ---- ====<!--markup:2:end--> Caching Control <!--markup:1:begin-->#### `no_cache($client_only<!--markup:1:end--> <!--markup:2:begin-->==== ===== ##no_cache($client_only<!--markup:2:end--> = true): <!--markup:1:begin-->void`<!--markup:1:end--> <!--markup:2:begin-->void## =====<!--markup:2:end--> Disables caching of the current page. **Parameters:** - <!--markup:1:begin-->`$client_only`<!--markup:1:end--> <!--markup:2:begin-->##$client_only##<!--markup:2:end--> (bool, default: TRUE) - <!--markup:1:begin-->`TRUE`:<!--markup:1:end--> <!--markup:2:begin-->##TRUE##:<!--markup:2:end--> Disable browser cache only - <!--markup:1:begin-->`FALSE`:<!--markup:1:end--> <!--markup:2:begin-->##FALSE##:<!--markup:2:end--> Disable both browser and server cache **Headers Set:** - <!--markup:1:begin-->`Last-Modified: <current-time>`<!--markup:1:end--> <!--markup:2:begin-->##Last-Modified: <current-time>##<!--markup:2:end--> (always fresh) - <!--markup:1:begin-->`Cache-Control: no-store`<!--markup:1:end--> <!--markup:2:begin-->##Cache-Control: no-store##<!--markup:2:end--> **Example:** <!--markup:1:begin-->`php
PHP
<!--markup:2:end-->
$http->no_cache(); // Client-side only
$http->no_cache(false); // Both client & server
<!--markup:1:begin-->```
---
#### `cache_promisc(): void`<!--markup:1:end-->
<!--markup:2:begin-->
cache_promisc(): void
Marks page as publicly cacheable.Headers Set:
-
`Cache-Control: public`Cache-Control: public
Example:
`php<!--markup:1:end-->** <!--markup:2:begin-->%%(hl php)<!--markup:2:end--> $http->cache_promisc(); <!--markup:1:begin-->`
###
---- ====<!--markup:2:end--> Language Negotiation <!--markup:1:begin-->#### `user_agent_language(): string`<!--markup:1:end--> <!--markup:2:begin-->==== ===== ##user_agent_language(): string## =====<!--markup:2:end--> Determines best language based on browser preferences. **Features:** - Follows RFC 9110 section 12.5.4 (HTTP Accept-Language) - Parses <!--markup:1:begin-->`Accept-Language`<!--markup:1:end--> <!--markup:2:begin-->##Accept-Language##<!--markup:2:end--> header with quality factors - Attempts exact match first, then language fallback - Falls back to default system language **Example Header:** <!--markup:1:begin-->```<!--markup:1:end-->** <!--markup:2:begin-->Accept-Language: en-US,en;q=0.9,de;q=0.8
`<!--markup:1:end--> <!--markup:2:begin-->%%<!--markup:2:end--> **Returns:** - Language code (e.g., 'en', 'en-US', 'de') <!--markup:1:begin-->--- #### `available_languages($subset<!--markup:1:end--> <!--markup:2:begin-->---- ===== ##available_languages($subset<!--markup:2:end--> = true): <!--markup:1:begin-->array`<!--markup:1:end--> <!--markup:2:begin-->array## =====<!--markup:2:end--> Returns list of available language translations. **Parameters:** - <!--markup:1:begin-->`$subset`<!--markup:1:end--> <!--markup:2:begin-->##$subset##<!--markup:2:end--> (bool, default: TRUE) - <!--markup:1:begin-->`TRUE`:<!--markup:1:end--> <!--markup:2:begin-->##TRUE##:<!--markup:2:end--> Only allowed languages - <!--markup:1:begin-->`FALSE`:<!--markup:1:end--> <!--markup:2:begin-->##FALSE##:<!--markup:2:end--> All available languages **Features:** - Scans <!--markup:1:begin-->`LANG_DIR`<!--markup:1:end--> <!--markup:2:begin-->##LANG_DIR##<!--markup:2:end--> for language files - Filters by <!--markup:1:begin-->`allowed_languages`<!--markup:1:end--> <!--markup:2:begin-->##allowed_languages##<!--markup:2:end--> config if set - Caches result in session - System language always included **Returns:** - Associative array: <!--markup:1:begin-->`['en'<!--markup:1:end--> <!--markup:2:begin-->##['en'<!--markup:2:end--> => 'en', 'de' => 'de', <!--markup:1:begin-->...]`<!--markup:1:end--> <!--markup:2:begin-->...]##<!--markup:2:end--> **Example:** <!--markup:1:begin-->`php
PHP
<!--markup:2:end-->
$all_langs = $http->available_languages(false);
$allowed = $http->available_languages(true);
<!--markup:1:begin-->```
---
###<!--markup:1:end-->
<!--markup:2:begin-->
File Serving
`sendfile($path,##sendfile($path, $filename = null, $age = null):
Parameters:
-
`$path`$path(string) - File path (or HTTP_XXX constant for error pages) -
`$filename`$filename(string, optional) - Custom download filename -
`$age`$age(int, optional) - Cache age in days
Features:
- 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
Special Paths:
`php<!--markup:1:end-->** <!--markup:2:begin-->%%(hl php)<!--markup:2:end--> $http->sendfile(404); // Serves file defined by HTTP_404 constant $http->sendfile(403); // Serves file defined by HTTP_403 constant <!--markup:1:begin-->`
<!--markup:2:end--> **Example:** <!--markup:1:begin-->```php<!--markup:1:end-->** <!--markup:2:begin-->(hl php) $http->sendfile('uploads/document.pdf', 'my-document.pdf', 30);
` --- #### `mime_type($path): string`<!--markup:1:end--> <!--markup:2:begin-->%% ---- ===== ##mime_type($path): string## =====<!--markup:2:end--> Returns MIME type for a file. **Returns:** - MIME type string (e.g., 'application/pdf') - Default: <!--markup:1:begin-->`'application/octet-stream'`<!--markup:1:end--> <!--markup:2:begin-->##'application/octet-stream'##<!--markup:2:end--> **Example:** <!--markup:1:begin-->`php
PHP
<!--markup:2:end-->
$mime = $http->mime_type('file.pdf'); // 'application/pdf'
<!--markup:1:begin-->```
---
#### `mime_types(): array`<!--markup:1:end-->
<!--markup:2:begin-->
mime_types(): array (Private) =====
Loads and caches MIME types from configuration.Features:
- Reads from
`config/mime.types`config/mime.types - Caches to
`cache/config/mime.types`cache/config/mime.types - Reloads if config is updated
###
Compression
`gzip(): void` gzip(): void
Compresses HTTP response with gzip/x-gzip.Features:
- Manually implements gzip (not relying on zlib.output_compression)
- Produces correct
`Content-Length`Content-Lengthheader - Only compresses if:
- 860 bytes < content < 1 MB
- Client accepts compression
- Headers not already sent
Example:
`php<!--markup:1:end-->** <!--markup:2:begin-->%%(hl php)<!--markup:2:end--> $http->gzip(); <!--markup:1:begin-->`
###
---- ====<!--markup:2:end--> Utility Methods <!--markup:1:begin-->#### `parse_str($str): array`<!--markup:1:end--> <!--markup:2:begin-->==== ===== ##parse_str($str): array##<!--markup:2:end--> (Private) <!--markup:2:begin-->=====<!--markup:2:end--> Parses URL-encoded strings with special character handling. **Purpose:** - Safely handles special characters in query/form data - Converts encoding properly **Example:** <!--markup:1:begin-->```php<!--markup:1:end-->** <!--markup:2:begin-->(hl php) $data = $http->parse_str('name=John&age=30');
` --- #### `request_uri(): string`<!--markup:1:end--> <!--markup:2:begin-->%% ---- ===== ##request_uri(): string##<!--markup:2:end--> (Private) <!--markup:2:begin-->=====<!--markup:2:end--> Extracts and normalizes REQUEST_URI from server. **Normalization:** - Removes base URL prefix - Removes spaces - Collapses multiple slashes - Removes <!--markup:1:begin-->`..`<!--markup:1:end--> <!--markup:2:begin-->##..##<!--markup:2:end--> path traversal attempts - Removes leading/trailing slashes <!--markup:1:begin-->--- #### `cut_prefix($prefix,<!--markup:1:end--> <!--markup:2:begin-->---- ===== ##cut_prefix($prefix,<!--markup:2:end--> $path): <!--markup:1:begin-->string`<!--markup:1:end--> <!--markup:2:begin-->string##<!--markup:2:end--> (Private) <!--markup:2:begin-->=====<!--markup:2:end--> Removes prefix from path (case-insensitive). <!--markup:1:begin-->--- #### `get_header_conf($file_name): string`<!--markup:1:end--> <!--markup:2:begin-->---- ===== ##get_header_conf($file_name): string##<!--markup:2:end--> (Private) <!--markup:2:begin-->=====<!--markup:2:end--> Loads security header configuration from files. **Files Supported:** - <!--markup:1:begin-->`csp.conf`<!--markup:1:end--> <!--markup:2:begin-->##csp.conf##<!--markup:2:end--> / <!--markup:1:begin-->`csp_custom.conf`<!--markup:1:end--> <!--markup:2:begin-->##csp_custom.conf##<!--markup:2:end--> - <!--markup:1:begin-->`permissions_policy.conf`<!--markup:1:end--> <!--markup:2:begin-->##permissions_policy.conf##<!--markup:2:end--> / <!--markup:1:begin-->`permissions_policy_custom.conf` --- ## Configuration Dependencies<!--markup:1:end--> <!--markup:2:begin-->##permissions_policy_custom.conf## ---- ===Configuration Dependencies===<!--markup:2:end--> The class relies on these database configuration settings: <!--markup:2:begin-->#|<!--markup:2:end--> *| Setting | Type | Purpose | <!--markup:1:begin-->|---------|------|---------| | `base_url`<!--markup:1:end-->* <!--markup:2:begin-->|| ##base_url##<!--markup:2:end--> | string | Wiki's base URL <!--markup:1:begin-->| | `tls`<!--markup:1:end--> <!--markup:2:begin-->|| || ##tls##<!--markup:2:end--> | bool | Enable HTTPS enforcement <!--markup:1:begin-->| | `cache`<!--markup:1:end--> <!--markup:2:begin-->|| || ##cache##<!--markup:2:end--> | bool | Enable page caching <!--markup:1:begin-->| | `cache_ttl`<!--markup:1:end--> <!--markup:2:begin-->|| || ##cache_ttl##<!--markup:2:end--> | int | Cache lifetime in seconds <!--markup:1:begin-->| | `session_store`<!--markup:1:end--> <!--markup:2:begin-->|| || ##session_store##<!--markup:2:end--> | int | 1=File, 0=Database <!--markup:1:begin-->| | `system_seed_hash`<!--markup:1:end--> <!--markup:2:begin-->|| || ##system_seed_hash##<!--markup:2:end--> | string | Session encryption seed <!--markup:1:begin-->| | `cookie_prefix`<!--markup:1:end--> <!--markup:2:begin-->|| || ##cookie_prefix##<!--markup:2:end--> | string | Session cookie prefix <!--markup:1:begin-->| | `cookie_path`<!--markup:1:end--> <!--markup:2:begin-->|| || ##cookie_path##<!--markup:2:end--> | string | Cookie path <!--markup:1:begin-->| | `allow_persistent_cookie`<!--markup:1:end--> <!--markup:2:begin-->|| || ##allow_persistent_cookie##<!--markup:2:end--> | bool | Allow persistent login <!--markup:1:begin-->| | `session_length`<!--markup:1:end--> <!--markup:2:begin-->|| || ##session_length##<!--markup:2:end--> | int | Session lifetime in seconds <!--markup:1:begin-->| | `reverse_proxy_addresses`<!--markup:1:end--> <!--markup:2:begin-->|| || ##reverse_proxy_addresses##<!--markup:2:end--> | string | Comma/space-separated proxy IPs <!--markup:1:begin-->| | `reverse_proxy_header`<!--markup:1:end--> <!--markup:2:begin-->|| || ##reverse_proxy_header##<!--markup:2:end--> | string | Custom X-Forwarded header <!--markup:1:begin-->| | `language`<!--markup:1:end--> <!--markup:2:begin-->|| || ##language##<!--markup:2:end--> | string | Default language code <!--markup:1:begin-->| | `multilanguage`<!--markup:1:end--> <!--markup:2:begin-->|| || ##multilanguage##<!--markup:2:end--> | bool | Enable language negotiation <!--markup:1:begin-->| | `allowed_languages`<!--markup:1:end--> <!--markup:2:begin-->|| || ##allowed_languages##<!--markup:2:end--> | string | Comma/space-separated allowed langs <!--markup:1:begin-->| | `enable_security_headers`<!--markup:1:end--> <!--markup:2:begin-->|| || ##enable_security_headers##<!--markup:2:end--> | bool | Send security headers <!--markup:1:begin-->| | `csp`<!--markup:1:end--> <!--markup:2:begin-->|| || ##csp##<!--markup:2:end--> | int | CSP setting (0/1/2) <!--markup:1:begin-->| | `permissions_policy`<!--markup:1:end--> <!--markup:2:begin-->|| || ##permissions_policy##<!--markup:2:end--> | int | Permissions-Policy setting (0/1/2) <!--markup:1:begin-->| | `referrer_policy`<!--markup:1:end--> <!--markup:2:begin-->|| || ##referrer_policy##<!--markup:2:end--> | int | Referrer-Policy setting (0-8) <!--markup:1:begin-->| --- ## Constants Used<!--markup:1:end--> <!--markup:2:begin-->|| |# ---- ===Constants Used=== #|<!--markup:2:end--> *| Constant | Type | Purpose | <!--markup:1:begin-->|----------|------|---------| | `IN_WACKO`<!--markup:1:end-->* <!--markup:2:begin-->|| ##IN_WACKO##<!--markup:2:end--> | bool | Security check (exit if not defined) <!--markup:1:begin-->| | `CHMOD_SAFE`<!--markup:1:end--> <!--markup:2:begin-->|| || ##CHMOD_SAFE##<!--markup:2:end--> | int | File permissions for cache files <!--markup:1:begin-->| | `CHMOD_FILE`<!--markup:1:end--> <!--markup:2:begin-->|| || ##CHMOD_FILE##<!--markup:2:end--> | int | File permissions for config cache <!--markup:1:begin-->| | `CACHE_PAGE_DIR`<!--markup:1:end--> <!--markup:2:begin-->|| || ##CACHE_PAGE_DIR##<!--markup:2:end--> | string | Page cache directory <!--markup:1:begin-->| | `CACHE_SESSION_DIR`<!--markup:1:end--> <!--markup:2:begin-->|| || ##CACHE_SESSION_DIR##<!--markup:2:end--> | string | Session cache directory <!--markup:1:begin-->| | `CACHE_CONFIG_DIR`<!--markup:1:end--> <!--markup:2:begin-->|| || ##CACHE_CONFIG_DIR##<!--markup:2:end--> | string | Config cache directory <!--markup:1:begin-->| | `CONFIG_DIR`<!--markup:1:end--> <!--markup:2:begin-->|| || ##CONFIG_DIR##<!--markup:2:end--> | string | Configuration directory <!--markup:1:begin-->| | `LANG_DIR`<!--markup:1:end--> <!--markup:2:begin-->|| || ##LANG_DIR##<!--markup:2:end--> | string | Language files directory <!--markup:1:begin-->| | `DAYSECS`<!--markup:1:end--> <!--markup:2:begin-->|| || ##DAYSECS##<!--markup:2:end--> | int | Seconds in a day (86400) <!--markup:1:begin-->| | `HTTP_404`<!--markup:1:end--> <!--markup:2:begin-->|| || ##HTTP_404##<!--markup:2:end--> | string | Path to 404 error page <!--markup:1:begin-->| | `HTTP_403`<!--markup:1:end--> <!--markup:2:begin-->|| || ##HTTP_403##<!--markup:2:end--> | string | Path to 403 error page <!--markup:1:begin-->| --- ##<!--markup:1:end--> <!--markup:2:begin-->|| |# ---- ===<!--markup:2:end--> Workflow Examples <!--markup:1:begin-->### Example<!--markup:1:end--> <!--markup:2:begin-->=== ====Example<!--markup:2:end--> 1: Handling a GET <!--markup:1:begin-->Request`php
PHP
<!--markup:2:end-->
// In main wiki entry point
$http = new Http($db);
$http->session(0); // Start session
// Check if page can be served from cache
$http->check_cache('HomePage', 'show');
// ... render page content ...
// Store rendered page in cache if applicable
$http->store_cache();
// Send security headers
$http->http_security_headers();
// Possibly compress output
$http->gzip();
<!--markup:1:begin-->```
###<!--markup:1:end-->
<!--markup:2:begin-->
Example 2: Handling TLS/HTTPS Upgrade
`php<!--markup:1:end--> <!--markup:2:begin-->==== %%(hl php)<!--markup:2:end--> $http = new Http($db); // Constructor detects TLS requirement // If TLS is enabled and user wasn't in TLS before: // - Sets TLS session flag // - Marks session with TLS cookie // - Redirects to HTTPS version <!--markup:1:begin-->`
###
====<!--markup:2:end--> Example 3: Invalidating Cache After Page Edit <!--markup:1:begin-->```php<!--markup:1:end--> <!--markup:2:begin-->====(hl php) // User edits a page
$http = new Http($db);
$count = $http->invalidate_page('HomePage');
// All cached versions (different languages, methods) are invalidated
` ###<!--markup:1:end--> <!--markup:2:begin-->%% ====<!--markup:2:end--> Example 4: Serving a File <!--markup:1:begin-->`php
PHP
<!--markup:2:end-->
$http = new Http($db);
$http->session(2); // Static file mode - no session replay prevention
// Serve with 30-day cache
$http->sendfile('uploads/manual.pdf', 'user-manual.pdf', 30);
<!--markup:1:begin-->```
---
##<!--markup:1:end-->
<!--markup:2:begin-->
=== Security Considerations
1. IP Address Spoofing ====
- Validates IPs against private ranges
- Filters proxy-provided IPs appropriately
- Configurable reverse proxy trust
==== 2. Session Security ====
- Binds sessions to IP address
- Binds sessions to TLS status
- Supports both file and database storage
- HttpOnly cookies by default
==== 3. TLS Enforcement ====
- Automatic HTTPS upgrade when configured
- Marks TLS sessions to prevent downgrade attacks
- HSTS header support
==== 4. Content Security ====
- CSP headers to prevent XSS
- X-Frame-Options to prevent clickjacking
- X-Content-Type-Options to prevent MIME sniffing
- Referrer-Policy control
- Permissions-Policy for browser features
==== 5. File Serving ====
- Validates file existence and readability
- Prevents directory traversal via
`realpath()`realpath() - Rejects symbolic links
- Special CSP for SVG and PDF files
==== 6. Cache Security ====
- Cached only for anonymous users
- Disabled for sensitive operations (edit, watch)
- Only GET requests cached
##
=== Performance Optimization
1. Page Caching ====
- Stores full HTML output
- TTL-based expiration
- Language and method-aware caching
- Conditional request support (304 Not Modified)
==== 2. MIME Type Caching ====
- Loads MIME types once and caches
- Regenerates only when config changes
==== 3. Session Options ====
- File-based sessions for simple deployments
- Database sessions for distributed systems
==== 4. Compression ====
- Manual gzip implementation
- Proper Content-Length generation
- Only compresses appropriate sizes
##
=== Debugging ===
The class integrates with WackoWiki's diagnostic system:
`php<!--markup:1:end--> <!--markup:2:begin-->%%(hl php)<!--markup:2:end--> // Diagnostic messages are preserved across redirects // via session flash data // Check cached pages (debug comments in output): // <!-- WackoWiki Caching Engine: page cached at 2024-01-15 12:30:45 GMT --> <!--markup:1:begin-->`
##
%%
=== Related Classes ===
- Session Classes
(`SessionFileStore`, `SessionDbalStore`)** (SessionFileStore,SessionDbalStore) - Session management backends - Database Class - Configuration and cache metadata storage
- Ut Utility Class - String/path utilities
- Diag Class - Diagnostic logging
##
=== Version History ===
- Supports PHP 8.0+ (uses match expressions, union types)
- Follows RFC 9110 for HTTP header handling
- Modern cookie security practices
##
=== Conclusion ===
The
Http class is the central request/response handler in WackoWiki, managing everything from session initialization to security headers to file serving. Understanding this class is essential for:
- Extending WackoWiki with custom request handlers
- Implementing custom session logic
- Adding new security policies
- Optimizing cache strategies
- Debugging HTTP-related issues