Difference between revisions for Users / Eo Ny / dev




← Previous edit
Revision 10 as of 05/05/2026 19:27 ▼
16 05/18/2026 05:05 WikiAdmin 15 05/18/2026 05:04 WikiAdmin 14 05/17/2026 21:10 WikiAdmin 13 05/05/2026 19:29 EoNy 12 05/05/2026 19:28 WikiAdmin 11 05/05/2026 19:28 WikiAdmin 10 05/05/2026 19:27 WikiAdmin 9 05/05/2026 19:25 WikiAdmin 8 05/05/2026 19:24 WikiAdmin 7 05/05/2026 19:23 WikiAdmin 6 05/05/2026 19:21 EoNy 5 05/05/2026 19:11 EoNy 4 05/05/2026 19:10 EoNy 3 05/05/2026 19:10 EoNy 2 05/05/2026 19:08 EoNy 1 05/05/2026 19:06 EoNy

(16.4 KiB)
WikiAdmin
 Next edit →
Revision 17 as of 05/18/2026 15:15 ▼
18 05/21/2026 16:12 WikiAdmin 17 05/18/2026 15:15 WikiAdmin 16 05/18/2026 05:05 WikiAdmin 15 05/18/2026 05:04 WikiAdmin 14 05/17/2026 21:10 WikiAdmin 13 05/05/2026 19:29 EoNy 12 05/05/2026 19:28 WikiAdmin 11 05/05/2026 19:28 WikiAdmin

(18.4 KiB) +2,000
WikiAdmin

Version1 Version2
1 == HTTP Class Technical Documentation == 1 {{toc numerate=1}}
2 2
3 === Overview === 3 === Overview ===
4 4
… … … …
40 ---- 40 ----
41 === Constructor === 41 === Constructor ===
42 42
43 %%php 43 %%(hl php)
44 public function __construct(&$db) 44 public function __construct(&$db)
45 %% 45 %%
46 46
… … … …
58   6. Enforces TLS session upgrade if needed 58   6. Enforces TLS session upgrade if needed
59 59
60 **Example:** 60 **Example:**
61 %%php 61 %%(hl php)
62 $http = new Http($db); 62 $http = new Http($db);
63 %% 63 %%
64 64
… … … …
82   - Recovers diagnostic logs from previous session 82   - Recovers diagnostic logs from previous session
83 83
84 **Example:** 84 **Example:**
85 %%php 85 %%(hl php)
86 $http->session(0); // Normal session 86 $http->session(0); // Normal session
87 $http->session(2); // Static file serving mode 87 $http->session(2); // Static file serving mode
88 %% 88 %%
… … … …
105   - ✅ Only cached for anonymous users (no logged-in users) 105   - ✅ Only cached for anonymous users (no logged-in users)
106 106
107 **Example:** 107 **Example:**
108 %%php 108 %%(hl php)
109 $http->check_cache('HomePage', 'show'); 109 $http->check_cache('HomePage', 'show');
110 %% 110 %%
111 111
112 ---- 112 ----
113 113
114 ===== ##store_cache(): void## ===== 114 =====##store_cache(): void##=====
115 Saves the generated page content to cache file. 115 Saves the generated page content to cache file.
116 116
117 **Features:** 117 **Features:**
… … … …
121   - Only executes if caching flag is set and user is anonymous 121   - Only executes if caching flag is set and user is anonymous
122 122
123 **Example:** 123 **Example:**
124 %%php 124 %%(hl php)
125 // Called at end of page rendering 125 // Called at end of page rendering
126 $http->store_cache(); 126 $http->store_cache();
127 %% 127 %%
… … … …
144   4. Returns count of invalidated caches 144   4. Returns count of invalidated caches
145 145
146 **Example:** 146 **Example:**
147 %%php 147 %%(hl php)
148 $count = $http->invalidate_page('HomePage'); 148 $count = $http->invalidate_page('HomePage');
149 echo "Invalidated $count cache entries"; 149 echo "Invalidated $count cache entries";
150 %% 150 %%
… … … …
162   - Called when TLS session is detected 162   - Called when TLS session is detected
163 163
164 **Example:** 164 **Example:**
165 %%php 165 %%(hl php)
166 $http->secure_base_url(); 166 $http->secure_base_url();
167 // $db->base_url now uses https:// 167 // $db->base_url now uses https://
168 %% 168 %%
… … … …
181   - Converts relative URLs using current server name 181   - Converts relative URLs using current server name
182 182
183 **Example:** 183 **Example:**
184 %%php 184 %%(hl php)
185 $http->ensure_tls('/secure/payment'); 185 $http->ensure_tls('/secure/payment');
186 %% 186 %%
187 187
… … … …
209   - ##reverse_proxy_header## - Custom header name (default: ##X-Forwarded-For##) 209   - ##reverse_proxy_header## - Custom header name (default: ##X-Forwarded-For##)
210 210
211 **Example:** 211 **Example:**
212 %%php 212 %%(hl php)
213 $client_ip = $http->ip; // e.g., "203.0.113.42" 213 $client_ip = $http->ip; // e.g., "203.0.113.42"
214 %% 214 %%
215 215
… … … …
253   - ##2## - Custom policy (from ##csp_custom.conf##) 253   - ##2## - Custom policy (from ##csp_custom.conf##)
254 254
255 **Example:** 255 **Example:**
256 %%php 256 %%(hl php)
257 $http->http_security_headers(); 257 $http->http_security_headers();
258 %% 258 %%
259 259
… … … …
273   - Uses output buffering to work anywhere in page processing 273   - Uses output buffering to work anywhere in page processing
274 274
275 **Example:** 275 **Example:**
276 %%php 276 %%(hl php)
277 $http->redirect('http://example.com/new-page', true); // 301 277 $http->redirect('http://example.com/new-page', true); // 301
278 $http->redirect('/wiki/HomePage'); // 302 278 $http->redirect('/wiki/HomePage'); // 302
279 %% 279 %%
… … … …
288   - Ends script execution 288   - Ends script execution
289 289
290 **Example:** 290 **Example:**
291 %%php 291 %%(hl php)
292 $http->terminate(); 292 $http->terminate();
293 %% 293 %%
294 294
… … … …
298 Sets HTTP response status code. 298 Sets HTTP response status code.
299 299
300 **Supported Status Codes:** 300 **Supported Status Codes:**
301 %%php 301 %%(hl php)
302 200 => 'OK' 302 200 => 'OK'
303 206 => 'Partial Content' 303 206 => 'Partial Content'
304 301 => 'Moved Permanently' 304 301 => 'Moved Permanently'
… … … …
318 %% 318 %%
319 319
320 **Example:** 320 **Example:**
321 %%php 321 %%(hl php)
322 $http->status(404); // Send 404 Not Found 322 $http->status(404); // Send 404 Not Found
323 %% 323 %%
324 324
… … … …
339   - ##Cache-Control: no-store## 339   - ##Cache-Control: no-store##
340 340
341 **Example:** 341 **Example:**
342 %%php 342 %%(hl php)
343 $http->no_cache(); // Client-side only 343 $http->no_cache(); // Client-side only
344 $http->no_cache(false); // Both client & server 344 $http->no_cache(false); // Both client & server
345 %% 345 %%
… … … …
353   - ##Cache-Control: public## 353   - ##Cache-Control: public##
354 354
355 **Example:** 355 **Example:**
356 %%php 356 %%(hl php)
357 $http->cache_promisc(); 357 $http->cache_promisc();
358 %% 358 %%
359 359
… … … …
398   - Associative array: ##['en' => 'en', 'de' => 'de', ...]## 398   - Associative array: ##['en' => 'en', 'de' => 'de', ...]##
399 399
400 **Example:** 400 **Example:**
401 %%php 401 %%(hl php)
402 $all_langs = $http->available_languages(false); 402 $all_langs = $http->available_languages(false);
403 $allowed = $http->available_languages(true); 403 $allowed = $http->available_languages(true);
404 %% 404 %%
… … … …
424   - GZip compression for text files 424   - GZip compression for text files
425 425
426 **Special Paths:** 426 **Special Paths:**
427 %%php 427 %%(hl php)
428 $http->sendfile(404); // Serves file defined by HTTP_404 constant 428 $http->sendfile(404); // Serves file defined by HTTP_404 constant
429 $http->sendfile(403); // Serves file defined by HTTP_403 constant 429 $http->sendfile(403); // Serves file defined by HTTP_403 constant
430 %% 430 %%
431 431
432 **Example:** 432 **Example:**
433 %%php 433 %%(hl php)
434 $http->sendfile('uploads/document.pdf', 'my-document.pdf', 30); 434 $http->sendfile('uploads/document.pdf', 'my-document.pdf', 30);
435 %% 435 %%
436 436
… … … …
444   - Default: ##'application/octet-stream'## 444   - Default: ##'application/octet-stream'##
445 445
446 **Example:** 446 **Example:**
447 %%php 447 %%(hl php)
448 $mime = $http->mime_type('file.pdf'); // 'application/pdf' 448 $mime = $http->mime_type('file.pdf'); // 'application/pdf'
449 %% 449 %%
450 450
… … … …
474   - Headers not already sent 474   - Headers not already sent
475 475
476 **Example:** 476 **Example:**
477 %%php 477 %%(hl php)
478 $http->gzip(); 478 $http->gzip();
479 %% 479 %%
480 480
… … … …
490   - Converts encoding properly 490   - Converts encoding properly
491 491
492 **Example:** 492 **Example:**
493 %%php 493 %%(hl php)
494 $data = $http->parse_str('name=John&age=30'); 494 $data = $http->parse_str('name=John&age=30');
495 %% 495 %%
496 496
… … … …
522 522
523 ---- 523 ----
524 524
525 === Configuration Dependencies === 525 ===Configuration Dependencies===
526 526
527 527 The class relies on these database configuration settings:
528 528
529 === Constants Used === 529 #|
530 530 *| Setting | Type | Purpose |*
531 531 || ##base_url## | string | Wiki's base URL ||
    532 || ##tls## | bool | Enable HTTPS enforcement ||
    533 || ##cache## | bool | Enable page caching ||
    534 || ##cache_ttl## | int | Cache lifetime in seconds ||
    535 || ##session_store## | int | 1=File, 0=Database ||
    536 || ##system_seed_hash## | string | Session encryption seed ||
    537 || ##cookie_prefix## | string | Session cookie prefix ||
    538 || ##cookie_path## | string | Cookie path ||
    539 || ##allow_persistent_cookie## | bool | Allow persistent login ||
    540 || ##session_length## | int | Session lifetime in seconds ||
    541 || ##reverse_proxy_addresses## | string | Comma/space-separated proxy IPs ||
    542 || ##reverse_proxy_header## | string | Custom X-Forwarded header ||
    543 || ##language## | string | Default language code ||
    544 || ##multilanguage## | bool | Enable language negotiation ||
    545 || ##allowed_languages## | string | Comma/space-separated allowed langs ||
    546 || ##enable_security_headers## | bool | Send security headers ||
    547 || ##csp## | int | CSP setting (0/1/2) ||
    548 || ##permissions_policy## | int | Permissions-Policy setting (0/1/2) ||
    549 || ##referrer_policy## | int | Referrer-Policy setting (0-8) ||
    550 |#
    551
    552 ----
    553
    554 ===Constants Used===
    555
    556 #|
    557 *| Constant | Type | Purpose |*
    558 || ##IN_WACKO## | bool | Security check (exit if not defined) ||
    559 || ##CHMOD_SAFE## | int | File permissions for cache files ||
    560 || ##CHMOD_FILE## | int | File permissions for config cache ||
    561 || ##CACHE_PAGE_DIR## | string | Page cache directory ||
    562 || ##CACHE_SESSION_DIR## | string | Session cache directory ||
    563 || ##CACHE_CONFIG_DIR## | string | Config cache directory ||
    564 || ##CONFIG_DIR## | string | Configuration directory ||
    565 || ##LANG_DIR## | string | Language files directory ||
    566 || ##DAYSECS## | int | Seconds in a day (86400) ||
    567 || ##HTTP_404## | string | Path to 404 error page ||
    568 || ##HTTP_403## | string | Path to 403 error page ||
    569 |#
    570
    571 ----
532 572
533 === Workflow Examples === 573 === Workflow Examples ===
534 574
535 ==== Example 1: Handling a GET Request ==== 575 ====Example 1: Handling a GET Request====
536 576
537 %%php 577 %%(hl php)
538 // In main wiki entry point 578 // In main wiki entry point
539 $http = new Http($db); 579 $http = new Http($db);
540 $http->session(0); // Start session 580 $http->session(0); // Start session
… … … …
556 596
557 ==== Example 2: Handling TLS/HTTPS Upgrade ==== 597 ==== Example 2: Handling TLS/HTTPS Upgrade ====
558 598
559 %%php 599 %%(hl php)
560 $http = new Http($db); // Constructor detects TLS requirement 600 $http = new Http($db); // Constructor detects TLS requirement
561 // If TLS is enabled and user wasn't in TLS before: 601 // If TLS is enabled and user wasn't in TLS before:
562 // - Sets TLS session flag 602 // - Sets TLS session flag
… … … …
566 606
567 ==== Example 3: Invalidating Cache After Page Edit ==== 607 ==== Example 3: Invalidating Cache After Page Edit ====
568 608
569 %%php 609 %%(hl php)
570 // User edits a page 610 // User edits a page
571 $http = new Http($db); 611 $http = new Http($db);
572 $count = $http->invalidate_page('HomePage'); 612 $count = $http->invalidate_page('HomePage');
… … … …
575 615
576 ==== Example 4: Serving a File ==== 616 ==== Example 4: Serving a File ====
577 617
578 %%php 618 %%(hl php)
579 $http = new Http($db); 619 $http = new Http($db);
580 $http->session(2); // Static file mode - no session replay prevention 620 $http->session(2); // Static file mode - no session replay prevention
581 621
… … … …
650 690
651 The class integrates with WackoWiki's diagnostic system: 691 The class integrates with WackoWiki's diagnostic system:
652 692
653 %%php 693 %%(hl php)
654 // Diagnostic messages are preserved across redirects 694 // Diagnostic messages are preserved across redirects
655 // via session flash data 695 // via session flash data
656 696