Difference between revisions for Users / Eo Ny / dev
| Version1 | Version2 | Differences |
|---|---|---|
| 41 | 41 | ---- |
| 42 | 42 | === Constructor === |
| 43 | 43 | |
| 44 |
%% |
|
| 44 | %%(hl php) | |
| 45 | 45 | public function __construct(&$db) |
| 46 | 46 | %% |
| 47 | 47 | |
| … | … | … |
| 59 | 59 | 6. Enforces TLS session upgrade if needed |
| 60 | 60 | |
| 61 | 61 | **Example:** |
| 62 |
%% |
|
| 62 | %%(hl php) | |
| 63 | 63 | $http = new Http($db); |
| 64 | 64 | %% |
| 65 | 65 | |
| … | … | … |
| 83 | 83 | - Recovers diagnostic logs from previous session |
| 84 | 84 | |
| 85 | 85 | **Example:** |
| 86 |
%% |
|
| 86 | %%(hl php) | |
| 87 | 87 | $http->session(0); // Normal session |
| 88 | 88 | $http->session(2); // Static file serving mode |
| 89 | 89 | %% |
| … | … | … |
| 106 | 106 | - ✅ Only cached for anonymous users (no logged-in users) |
| 107 | 107 | |
| 108 | 108 | **Example:** |
| 109 |
%% |
|
| 109 | %%(hl php) | |
| 110 | 110 | $http->check_cache('HomePage', 'show'); |
| 111 | 111 | %% |
| 112 | 112 | |
| 113 | 113 | ---- |
| 114 | 114 | |
| 115 |
===== |
|
| 115 | =====##store_cache(): void##===== | |
| 116 | 116 | Saves the generated page content to cache file. |
| 117 | 117 | |
| 118 | 118 | **Features:** |
| … | … | … |
| 122 | 122 | - Only executes if caching flag is set and user is anonymous |
| 123 | 123 | |
| 124 | 124 | **Example:** |
| 125 |
%% |
|
| 125 | %%(hl php) | |
| 126 | 126 | // Called at end of page rendering |
| 127 | 127 | $http->store_cache(); |
| 128 | 128 | %% |
| … | … | … |
| 145 | 145 | 4. Returns count of invalidated caches |
| 146 | 146 | |
| 147 | 147 | **Example:** |
| 148 |
%% |
|
| 148 | %%(hl php) | |
| 149 | 149 | $count = $http->invalidate_page('HomePage'); |
| 150 | 150 | echo "Invalidated $count cache entries"; |
| 151 | 151 | %% |
| … | … | … |
| 163 | 163 | - Called when TLS session is detected |
| 164 | 164 | |
| 165 | 165 | **Example:** |
| 166 |
%% |
|
| 166 | %%(hl php) | |
| 167 | 167 | $http->secure_base_url(); |
| 168 | 168 | // $db->base_url now uses https:// |
| 169 | 169 | %% |
| … | … | … |
| 182 | 182 | - Converts relative URLs using current server name |
| 183 | 183 | |
| 184 | 184 | **Example:** |
| 185 |
%% |
|
| 185 | %%(hl php) | |
| 186 | 186 | $http->ensure_tls('/secure/payment'); |
| 187 | 187 | %% |
| 188 | 188 | |
| … | … | … |
| 210 | 210 | - ##reverse_proxy_header## - Custom header name (default: ##X-Forwarded-For##) |
| 211 | 211 | |
| 212 | 212 | **Example:** |
| 213 |
%% |
|
| 213 | %%(hl php) | |
| 214 | 214 | $client_ip = $http->ip; // e.g., "203.0.113.42" |
| 215 | 215 | %% |
| 216 | 216 | |
| … | … | … |
| 254 | 254 | - ##2## - Custom policy (from ##csp_custom.conf##) |
| 255 | 255 | |
| 256 | 256 | **Example:** |
| 257 |
%% |
|
| 257 | %%(hl php) | |
| 258 | 258 | $http->http_security_headers(); |
| 259 | 259 | %% |
| 260 | 260 | |
| … | … | … |
| 274 | 274 | - Uses output buffering to work anywhere in page processing |
| 275 | 275 | |
| 276 | 276 | **Example:** |
| 277 |
%% |
|
| 277 | %%(hl php) | |
| 278 | 278 | $http->redirect('http://example.com/new-page', true); // 301 |
| 279 | 279 | $http->redirect('/wiki/HomePage'); // 302 |
| 280 | 280 | %% |
| … | … | … |
| 289 | 289 | - Ends script execution |
| 290 | 290 | |
| 291 | 291 | **Example:** |
| 292 |
%% |
|
| 292 | %%(hl php) | |
| 293 | 293 | $http->terminate(); |
| 294 | 294 | %% |
| 295 | 295 | |
| … | … | … |
| 299 | 299 | Sets HTTP response status code. |
| 300 | 300 | |
| 301 | 301 | **Supported Status Codes:** |
| 302 |
%% |
|
| 302 | %%(hl php) | |
| 303 | 303 | 200 => 'OK' |
| 304 | 304 | 206 => 'Partial Content' |
| 305 | 305 | 301 => 'Moved Permanently' |
| … | … | … |
| 319 | 319 | %% |
| 320 | 320 | |
| 321 | 321 | **Example:** |
| 322 |
%% |
|
| 322 | %%(hl php) | |
| 323 | 323 | $http->status(404); // Send 404 Not Found |
| 324 | 324 | %% |
| 325 | 325 | |
| … | … | … |
| 340 | 340 | - ##Cache-Control: no-store## |
| 341 | 341 | |
| 342 | 342 | **Example:** |
| 343 |
%% |
|
| 343 | %%(hl php) | |
| 344 | 344 | $http->no_cache(); // Client-side only |
| 345 | 345 | $http->no_cache(false); // Both client & server |
| 346 | 346 | %% |
| … | … | … |
| 354 | 354 | - ##Cache-Control: public## |
| 355 | 355 | |
| 356 | 356 | **Example:** |
| 357 |
%% |
|
| 357 | %%(hl php) | |
| 358 | 358 | $http->cache_promisc(); |
| 359 | 359 | %% |
| 360 | 360 | |
| … | … | … |
| 399 | 399 | - Associative array: ##['en' => 'en', 'de' => 'de', ...]## |
| 400 | 400 | |
| 401 | 401 | **Example:** |
| 402 |
%% |
|
| 402 | %%(hl php) | |
| 403 | 403 | $all_langs = $http->available_languages(false); |
| 404 | 404 | $allowed = $http->available_languages(true); |
| 405 | 405 | %% |
| … | … | … |
| 425 | 425 | - GZip compression for text files |
| 426 | 426 | |
| 427 | 427 | **Special Paths:** |
| 428 |
%% |
|
| 428 | %%(hl php) | |
| 429 | 429 | $http->sendfile(404); // Serves file defined by HTTP_404 constant |
| 430 | 430 | $http->sendfile(403); // Serves file defined by HTTP_403 constant |
| 431 | 431 | %% |
| 432 | 432 | |
| 433 | 433 | **Example:** |
| 434 |
%% |
|
| 434 | %%(hl php) | |
| 435 | 435 | $http->sendfile('uploads/document.pdf', 'my-document.pdf', 30); |
| 436 | 436 | %% |
| 437 | 437 | |
| … | … | … |
| 445 | 445 | - Default: ##'application/octet-stream'## |
| 446 | 446 | |
| 447 | 447 | **Example:** |
| 448 |
%% |
|
| 448 | %%(hl php) | |
| 449 | 449 | $mime = $http->mime_type('file.pdf'); // 'application/pdf' |
| 450 | 450 | %% |
| 451 | 451 | |
| … | … | … |
| 475 | 475 | - Headers not already sent |
| 476 | 476 | |
| 477 | 477 | **Example:** |
| 478 |
%% |
|
| 478 | %%(hl php) | |
| 479 | 479 | $http->gzip(); |
| 480 | 480 | %% |
| 481 | 481 | |
| … | … | … |
| 491 | 491 | - Converts encoding properly |
| 492 | 492 | |
| 493 | 493 | **Example:** |
| 494 |
%% |
|
| 494 | %%(hl php) | |
| 495 | 495 | $data = $http->parse_str('name=John&age=30'); |
| 496 | 496 | %% |
| 497 | 497 | |
| … | … | … |
| 573 | 573 | |
| 574 | 574 | === Workflow Examples === |
| 575 | 575 | |
| 576 |
==== |
|
| 577 |
|
|
| 578 |
%% |
|
| 576 | ====Example 1: Handling a GET Request==== | |
| 577 | ||
| 578 | %%(hl php) | |
| 579 | 579 | // In main wiki entry point |
| 580 | 580 | $http = new Http($db); |
| 581 | 581 | $http->session(0); // Start session |
| … | … | … |
| 597 | 597 | |
| 598 | 598 | ==== Example 2: Handling TLS/HTTPS Upgrade ==== |
| 599 | 599 | |
| 600 |
%% |
|
| 600 | %%(hl php) | |
| 601 | 601 | $http = new Http($db); // Constructor detects TLS requirement |
| 602 | 602 | // If TLS is enabled and user wasn't in TLS before: |
| 603 | 603 | // - Sets TLS session flag |
| … | … | … |
| 607 | 607 | |
| 608 | 608 | ==== Example 3: Invalidating Cache After Page Edit ==== |
| 609 | 609 | |
| 610 |
%% |
|
| 610 | %%(hl php) | |
| 611 | 611 | // User edits a page |
| 612 | 612 | $http = new Http($db); |
| 613 | 613 | $count = $http->invalidate_page('HomePage'); |
| … | … | … |
| 616 | 616 | |
| 617 | 617 | ==== Example 4: Serving a File ==== |
| 618 | 618 | |
| 619 |
%% |
|
| 619 | %%(hl php) | |
| 620 | 620 | $http = new Http($db); |
| 621 | 621 | $http->session(2); // Static file mode - no session replay prevention |
| 622 | 622 | |
| … | … | … |
| 691 | 691 | |
| 692 | 692 | The class integrates with WackoWiki's diagnostic system: |
| 693 | 693 | |
| 694 |
%% |
|
| 694 | %%(hl php) | |
| 695 | 695 | // Diagnostic messages are preserved across redirects |
| 696 | 696 | // via session flash data |
| 697 | 697 |