-
Notifications
You must be signed in to change notification settings - Fork 36
Expand file tree
/
Copy pathRequest.php
More file actions
executable file
·787 lines (685 loc) · 17.8 KB
/
Request.php
File metadata and controls
executable file
·787 lines (685 loc) · 17.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
<?php
namespace Utopia;
class Request
{
/**
* HTTP methods
*/
public const METHOD_OPTIONS = 'OPTIONS';
public const METHOD_GET = 'GET';
public const METHOD_HEAD = 'HEAD';
public const METHOD_POST = 'POST';
public const METHOD_PATCH = 'PATCH';
public const METHOD_PUT = 'PUT';
public const METHOD_DELETE = 'DELETE';
public const METHOD_TRACE = 'TRACE';
public const METHOD_CONNECT = 'CONNECT';
/**
* Container for raw php://input parsed stream
*
* @var string
*/
private $rawPayload = '';
/**
* Container for php://input parsed stream as an associative array
*
* @var array|null
*/
protected $payload = null;
/**
* Container for parsed query string params
*
* @var array|null
*/
protected $queryString = null;
/**
* Container for parsed headers
*
* @var array|null
*/
protected $headers = null;
/**
* List of trusted proxy header names to check for client IP address
*
* @var array
*/
protected array $trustedIpHeaders = [];
/**
* Get Param
*
* Get param by current method name
*
* @param string $key
* @param mixed $default
* @return mixed
*/
public function getParam(string $key, mixed $default = null): mixed
{
$params = $this->getParams();
return (isset($params[$key])) ? $params[$key] : $default;
}
/**
* Get Params
*
* Get all params of current method
*
* @return array
*/
public function getParams(): array
{
return $this->generateInput();
}
/**
* Get Query
*
* Method for querying HTTP GET request parameters. If $key is not found $default value will be returned.
*
* @param string $key
* @param mixed $default
* @return mixed
*/
public function getQuery(string $key, mixed $default = null): mixed
{
$this->generateInput();
return $this->queryString[$key] ?? $default;
}
/**
* Get payload
*
* Method for querying HTTP request payload parameters. If $key is not found $default value will be returned.
*
* @param string $key
* @param mixed $default
* @return mixed
*/
public function getPayload(string $key, mixed $default = null): mixed
{
$this->generateInput();
return $this->payload[$key] ?? $default;
}
/**
* Get raw payload
*
* Method for getting the HTTP request payload as a raw string.
*
* @return string
*/
public function getRawPayload(): string
{
$this->generateInput();
return $this->rawPayload;
}
/**
* Get server
*
* Method for querying server parameters. If $key is not found $default value will be returned.
*
* @param string $key
* @param string|null $default
* @return string|null
*/
public function getServer(string $key, ?string $default = null): ?string
{
return $_SERVER[$key] ?? $default;
}
/**
* Set server
*
* Method for setting server parameters.
*
* @param string $key
* @param string $value
* @return static
*/
public function setServer(string $key, string $value): static
{
$_SERVER[$key] = $value;
return $this;
}
/**
* Set trusted ip headers
*
* WARNING: Only set these headers if your application is behind a trusted proxy.
* Trusting these headers when accepting direct client connections is a security risk.
*
* @param array $headers List of header names to trust (e.g., ['x-forwarded-for', 'x-real-ip'])
* @return static
*/
public function setTrustedIpHeaders(array $headers): static
{
$normalized = array_map('strtolower', $headers);
$trimmed = array_map('trim', $normalized);
$this->trustedIpHeaders = array_filter($trimmed);
return $this;
}
/**
* Get IP
*
* Extracts the client's IP address from trusted headers or falls back to the remote address.
* Prioritizes headers like X-Forwarded-For when behind proxies or load balancers,
* defaulting to REMOTE_ADDR when trusted headers are unavailable.
*
* @return string The validated client IP address or '0.0.0.0' if unavailable
*/
public function getIP(): string
{
$remoteAddr = $this->getServer('REMOTE_ADDR') ?? '0.0.0.0';
foreach ($this->trustedIpHeaders as $header) {
$headerValue = $this->getHeader($header);
if (empty($headerValue)) {
continue;
}
// Leftmost IP address is the address of the originating client
$ips = explode(',', $headerValue);
$ip = trim($ips[0]);
// Validate IP format (supports both IPv4 and IPv6)
if (filter_var($ip, FILTER_VALIDATE_IP)) {
return $ip;
}
}
return $remoteAddr;
}
/**
* Get Protocol
*
* Returns request protocol.
* Support HTTP_X_FORWARDED_PROTO header usually return
* from different proxy servers or PHP default REQUEST_SCHEME
*
* @return string
*/
public function getProtocol(): string
{
return $this->getServer('HTTP_X_FORWARDED_PROTO', $this->getServer('REQUEST_SCHEME')) ?? 'https';
}
/**
* Get Port
*
* Returns request port.
*
* @return string
*/
public function getPort(): string
{
return (string) \parse_url($this->getProtocol().'://'.$this->getServer('HTTP_HOST', ''), PHP_URL_PORT);
}
/**
* Get Hostname
*
* Returns request hostname.
*
* @return string
*/
public function getHostname(): string
{
return (string) \parse_url($this->getProtocol().'://'.$this->getServer('HTTP_HOST', ''), PHP_URL_HOST);
}
/**
* Get Method
*
* Return HTTP request method
*
* @return string
*/
public function getMethod(): string
{
return $this->getServer('REQUEST_METHOD') ?? 'UNKNOWN';
}
/**
* Set Method
*
* Set HTTP request method
*
* @param string $method
* @return static
*/
public function setMethod(string $method): static
{
$this->setServer('REQUEST_METHOD', $method);
return $this;
}
/**
* Get URI
*
* Return HTTP request URI
*
* @return string
*/
public function getURI(): string
{
return $this->getServer('REQUEST_URI') ?? '';
}
/**
* Get Path
*
* Return HTTP request path
*
* @param string $uri
* @return static
*/
public function setURI(string $uri): static
{
$this->setServer('REQUEST_URI', $uri);
return $this;
}
/**
* Get files
*
* Method for querying upload files data. If $key is not found empty array will be returned.
*
* @param string $key
* @return array
*/
public function getFiles(string $key): array
{
return (isset($_FILES[$key])) ? $_FILES[$key] : [];
}
/**
* Get Referer
*
* Return HTTP referer header
*
* @param string $default
* @return string
*/
public function getReferer(string $default = ''): string
{
return (string) $this->getServer('HTTP_REFERER', $default);
}
/**
* Get Origin
*
* Return HTTP origin header
*
* @param string $default
* @return string
*/
public function getOrigin(string $default = ''): string
{
return (string) $this->getServer('HTTP_ORIGIN', $default);
}
/**
* Get User Agent
*
* Return HTTP user agent header
*
* @param string $default
* @return string
*/
public function getUserAgent(string $default = ''): string
{
return (string) $this->getServer('HTTP_USER_AGENT', $default);
}
/**
* Get Accept
*
* Return HTTP accept header
*
* @param string $default
* @return string
*/
public function getAccept(string $default = ''): string
{
return (string) $this->getServer('HTTP_ACCEPT', $default);
}
/**
* Get cookie
*
* Method for querying HTTP cookie parameters. If $key is not found $default value will be returned.
*
* @param string $key
* @param string $default
* @return string
*/
public function getCookie(string $key, string $default = ''): string
{
return (isset($_COOKIE[$key])) ? $_COOKIE[$key] : $default;
}
/**
* Get header
*
* Method for querying HTTP header parameters. If $key is not found $default value will be returned.
*
* @param string $key
* @param string $default
* @return string
*/
public function getHeader(string $key, string $default = ''): string
{
$headers = $this->generateHeaders();
return (isset($headers[$key])) ? $headers[$key] : $default;
}
/**
* Get headers
*
* Method for getting all HTTP header parameters.
*
* @return array<string,mixed>
*/
public function getHeaders(): array
{
return $this->generateHeaders();
}
/**
* Set header
*
* Method for adding HTTP header parameters.
*
* @param string $key
* @param string $value
* @return static
*/
public function addHeader(string $key, string $value): static
{
$this->headers[$key] = $value;
return $this;
}
/**
* Remvoe header
*
* Method for removing HTTP header parameters.
*
* @param string $key
* @return static
*/
public function removeHeader(string $key): static
{
if (isset($this->headers[$key])) {
unset($this->headers[$key]);
}
return $this;
}
/**
* Get Request Size
*
* Returns request size in bytes
*
* @return int
*/
public function getSize(): int
{
return \mb_strlen(\implode("\n", $this->generateHeaders()), '8bit') + \mb_strlen(\file_get_contents('php://input'), '8bit');
}
/**
* Get Content Range Start
*
* Returns the start of content range
*
* @return int|null
*/
public function getContentRangeStart(): ?int
{
$data = $this->parseContentRange();
if (!empty($data)) {
return $data['start'];
} else {
return null;
}
}
/**
* Get Content Range End
*
* Returns the end of content range
*
* @return int|null
*/
public function getContentRangeEnd(): ?int
{
$data = $this->parseContentRange();
if (!empty($data)) {
return $data['end'];
} else {
return null;
}
}
/**
* Get Content Range Size
*
* Returns the size of content range
*
* @return int|null
*/
public function getContentRangeSize(): ?int
{
$data = $this->parseContentRange();
if (!empty($data)) {
return $data['size'];
} else {
return null;
}
}
/**
* Get Content Range Unit
*
* Returns the unit of content range
*
* @return string|null
*/
public function getContentRangeUnit(): ?string
{
$data = $this->parseContentRange();
if (!empty($data)) {
return $data['unit'];
} else {
return null;
}
}
/**
* Get Range Start
*
* Returns the start of range header
*
* @return int|null
*/
public function getRangeStart(): ?int
{
$data = $this->parseRange();
if (!empty($data)) {
return $data['start'];
}
return null;
}
/**
* Get Range End
*
* Returns the end of range header
*
* @return int|null
*/
public function getRangeEnd(): ?int
{
$data = $this->parseRange();
if (!empty($data)) {
return $data['end'];
}
return null;
}
/**
* Get Range Unit
*
* Returns the unit of range header
*
* @return string|null
*/
public function getRangeUnit(): ?string
{
$data = $this->parseRange();
if (!empty($data)) {
return $data['unit'];
}
return null;
}
/**
* Set query string parameters
*
* @param array $params
* @return static
*/
public function setQueryString(array $params): static
{
$this->queryString = $params;
return $this;
}
/**
* Set payload parameters
*
* @param array $params
* @return static
*/
public function setPayload(array $params): static
{
$this->payload = $params;
return $this;
}
/**
* Generate input
*
* Generate PHP input stream and parse it as an array in order to handle different content type of requests
*
* @return array
*/
protected function generateInput(): array
{
if (null === $this->queryString) {
$this->queryString = $_GET;
}
if (null === $this->payload) {
$contentType = $this->getHeader('content-type');
// Get content-type without the charset
$length = \strpos($contentType, ';');
$length = (empty($length)) ? \strlen($contentType) : $length;
$contentType = \substr($contentType, 0, $length);
$this->rawPayload = \file_get_contents('php://input');
switch ($contentType) {
case 'application/json':
$this->payload = \json_decode($this->rawPayload, true);
break;
default:
$this->payload = $_POST;
break;
}
if (empty($this->payload)) { // Make sure we return same data type even if json payload is empty or failed
$this->payload = [];
}
}
return match ($this->getServer('REQUEST_METHOD', '')) {
self::METHOD_POST,
self::METHOD_PUT,
self::METHOD_PATCH,
self::METHOD_DELETE => $this->payload,
default => $this->queryString
};
}
/**
* Generate headers
*
* Parse request headers as an array for easy querying using the getHeader method
*
* @return array
*/
protected function generateHeaders(): array
{
if (null === $this->headers) {
/**
* Fallback for older PHP versions
* that do not support generateHeaders
*/
if (!\function_exists('getallheaders')) {
$headers = [];
foreach ($_SERVER as $name => $value) {
if (\substr($name, 0, 5) == 'HTTP_') {
$headers[\str_replace(' ', '-', \strtolower(\str_replace('_', ' ', \substr($name, 5))))] = $value;
}
}
$this->headers = $headers;
return $this->headers;
}
$this->headers = array_change_key_case(getallheaders());
}
return $this->headers;
}
/**
* Content Range Parser
*
* Parse content-range request header for easy access
*
* @return array|null
*/
protected function parseContentRange(): ?array
{
$contentRange = $this->getHeader('content-range', '');
$data = [];
if (!empty($contentRange)) {
$contentRange = explode(' ', $contentRange);
if (count($contentRange) !== 2) {
return null;
}
$data['unit'] = trim($contentRange[0]);
if (empty($data['unit'])) {
return null;
}
$rangeData = explode('/', $contentRange[1]);
if (count($rangeData) !== 2) {
return null;
}
if (!ctype_digit($rangeData[1])) {
return null;
}
$data['size'] = (int) $rangeData[1];
$parts = explode('-', $rangeData[0]);
if (count($parts) != 2) {
return null;
}
if (!ctype_digit($parts[0]) || !ctype_digit($parts[1])) {
return null;
}
$data['start'] = (int) $parts[0];
$data['end'] = (int) $parts[1];
if ($data['start'] > $data['end'] || $data['end'] > $data['size']) {
return null;
}
return $data;
}
return null;
}
/**
* Range Parser
*
* Parse range request header for easy access
*
* @return array|null
*/
protected function parseRange(): ?array
{
$rangeHeader = $this->getHeader('range', '');
if (empty($rangeHeader)) {
return null;
}
$data = [];
$ranges = explode('=', $rangeHeader);
if (count($ranges) !== 2 || empty($ranges[0]) || empty($ranges[1])) {
return null;
}
$data['unit'] = $ranges[0];
$ranges = explode('-', $ranges[1]);
if (count($ranges) !== 2 || strlen($ranges[0]) === 0) {
return null;
}
if (!ctype_digit($ranges[0])) {
return null;
}
$data['start'] = (int) $ranges[0];
if (strlen($ranges[1]) === 0) {
$data['end'] = null;
} else {
if (!ctype_digit($ranges[1])) {
return null;
}
$data['end'] = (int) $ranges[1];
}
if ($data['end'] !== null && $data['start'] >= $data['end']) {
return null;
}
return $data;
}
}