-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
Request.php
1939 lines (1738 loc) · 57.6 KB
/
Request.php
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
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 2.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Network;
use ArrayAccess;
use BadMethodCallException;
use Cake\Core\Configure;
use Cake\Http\ServerRequestFactory;
use Cake\Network\Exception\MethodNotAllowedException;
use Cake\Utility\Hash;
use InvalidArgumentException;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileInterface;
use Psr\Http\Message\UriInterface;
use Zend\Diactoros\PhpInputStream;
use Zend\Diactoros\Stream;
use Zend\Diactoros\UploadedFile;
/**
* A class that helps wrap Request information and particulars about a single request.
* Provides methods commonly used to introspect on the request headers and request body.
*/
class Request implements ArrayAccess
{
/**
* Array of parameters parsed from the URL.
*
* @var array
* @deprecated 3.4.0 This public property will be removed in 4.0.0. Use param() instead.
*/
public $params = [
'plugin' => null,
'controller' => null,
'action' => null,
'_ext' => null,
'pass' => []
];
/**
* Array of POST data. Will contain form data as well as uploaded files.
* In PUT/PATCH/DELETE requests this property will contain the form-urlencoded
* data.
*
* @var array
* @deprecated 3.4.0 This public property will be removed in 4.0.0. Use data() instead.
*/
public $data = [];
/**
* Array of querystring arguments
*
* @var array
* @deprecated 3.4.0 This public property will be removed in 4.0.0. Use query() instead.
*/
public $query = [];
/**
* Array of cookie data.
*
* @var array
* @deprecated 3.4.0 This public property will be removed in 4.0.0. Use cookie() instead.
*/
public $cookies = [];
/**
* Array of environment data.
*
* @var array
*/
protected $_environment = [];
/**
* The URL string used for the request.
*
* @var string
*/
public $url;
/**
* Base URL path.
*
* @var string
* @deprecated 3.4.0 This public property will be removed in 4.0.0. Use getAttribute('base') instead.
*/
public $base;
/**
* webroot path segment for the request.
*
* @var string
* @deprecated 3.4.0 This public property will be removed in 4.0.0. Use getAttribute('webroot') instead.
*/
public $webroot = '/';
/**
* The full address to the current request
*
* @var string
* @deprecated 3.4.0 This public property will be removed in 4.0.0. Use here() instead.
*/
public $here;
/**
* Whether or not to trust HTTP_X headers set by most load balancers.
* Only set to true if your application runs behind load balancers/proxies
* that you control.
*
* @var bool
*/
public $trustProxy = false;
/**
* The built in detectors used with `is()` can be modified with `addDetector()`.
*
* There are several ways to specify a detector, see Cake\Network\Request::addDetector() for the
* various formats and ways to define detectors.
*
* @var array
*/
protected static $_detectors = [
'get' => ['env' => 'REQUEST_METHOD', 'value' => 'GET'],
'post' => ['env' => 'REQUEST_METHOD', 'value' => 'POST'],
'put' => ['env' => 'REQUEST_METHOD', 'value' => 'PUT'],
'patch' => ['env' => 'REQUEST_METHOD', 'value' => 'PATCH'],
'delete' => ['env' => 'REQUEST_METHOD', 'value' => 'DELETE'],
'head' => ['env' => 'REQUEST_METHOD', 'value' => 'HEAD'],
'options' => ['env' => 'REQUEST_METHOD', 'value' => 'OPTIONS'],
'ssl' => ['env' => 'HTTPS', 'options' => [1, 'on']],
'ajax' => ['env' => 'HTTP_X_REQUESTED_WITH', 'value' => 'XMLHttpRequest'],
'flash' => ['env' => 'HTTP_USER_AGENT', 'pattern' => '/^(Shockwave|Adobe) Flash/'],
'requested' => ['param' => 'requested', 'value' => 1],
'json' => ['accept' => ['application/json'], 'param' => '_ext', 'value' => 'json'],
'xml' => ['accept' => ['application/xml', 'text/xml'], 'param' => '_ext', 'value' => 'xml'],
];
/**
* Instance cache for results of is(something) calls
*
* @var array
*/
protected $_detectorCache = [];
/**
* Request body stream. Contains php://input unless `input` constructor option is used.
*
* @var \Psr\Http\Message\StreamInterface
*/
protected $stream;
/**
* Uri instance
*
* @var \Psr\Http\Message\UriInterface
*/
protected $uri;
/**
* Instance of a Session object relative to this request
*
* @var \Cake\Network\Session
*/
protected $_session;
/**
* Store the additional attributes attached to the request.
*
* @var array
*/
protected $attributes = [];
/**
* A list of propertes that emulated by the PSR7 attribute methods.
*
* @var array
*/
protected $emulatedAttributes = ['webroot', 'base', 'params'];
/**
* Array of Psr\Http\Message\UploadedFileInterface objects.
*
* @var array
*/
protected $uploadedFiles = [];
/**
* The HTTP protocol version used.
*
* @var string|null
*/
protected $protocol;
/**
* Wrapper method to create a new request from PHP superglobals.
*
* Uses the $_GET, $_POST, $_FILES, $_COOKIE, $_SERVER, $_ENV and php://input data to construct
* the request.
*
* @return \Cake\Network\Request
*/
public static function createFromGlobals()
{
$uri = ServerRequestFactory::createUri($_SERVER);
$base = $uri->base;
$webroot = $uri->webroot;
$sessionConfig = (array)Configure::read('Session') + [
'defaults' => 'php',
'cookiePath' => $webroot
];
$config = [
'query' => $_GET,
'post' => $_POST,
'files' => $_FILES,
'cookies' => $_COOKIE,
'environment' => $_SERVER + $_ENV,
'uri' => $uri,
'base' => $base,
'webroot' => $webroot,
'session' => Session::create($sessionConfig)
];
return new static($config);
}
/**
* Create a new request object.
*
* You can supply the data as either an array or as a string. If you use
* a string you can only supply the URL for the request. Using an array will
* let you provide the following keys:
*
* - `post` POST data or non query string data
* - `query` Additional data from the query string.
* - `files` Uploaded file data formatted like $_FILES.
* - `cookies` Cookies for this request.
* - `environment` $_SERVER and $_ENV data.
* - `url` The URL without the base path for the request.
* - `uri` The PSR7 UriInterface object. If null, one will be created.
* - `base` The base URL for the request.
* - `webroot` The webroot directory for the request.
* - `input` The data that would come from php://input this is useful for simulating
* - `session` An instance of a Session object
* requests with put, patch or delete data.
*
* @param string|array $config An array of request data to create a request with.
*/
public function __construct($config = [])
{
if (is_string($config)) {
$config = ['url' => $config];
}
$config += [
'params' => $this->params,
'query' => [],
'post' => [],
'files' => [],
'cookies' => [],
'environment' => [],
'url' => '',
'uri' => null,
'base' => '',
'webroot' => '',
'input' => null,
];
$this->_setConfig($config);
}
/**
* Process the config/settings data into properties.
*
* @param array $config The config data to use.
* @return void
*/
protected function _setConfig($config)
{
if (!empty($config['url']) && $config['url'][0] === '/') {
$config['url'] = substr($config['url'], 1);
}
if (empty($config['session'])) {
$config['session'] = new Session([
'cookiePath' => $config['base']
]);
}
$this->_environment = $config['environment'];
$this->cookies = $config['cookies'];
if (isset($config['uri']) && $config['uri'] instanceof UriInterface) {
$uri = $config['uri'];
} else {
$uri = ServerRequestFactory::createUri($config['environment']);
}
// Extract a query string from config[url] if present.
// This is required for backwards compatbility and keeping
// UriInterface implementations happy.
$querystr = '';
if (strpos($config['url'], '?') !== false) {
list($config['url'], $querystr) = explode('?', $config['url']);
}
if ($config['url']) {
$uri = $uri->withPath('/' . $config['url']);
}
$this->uri = $uri;
$this->base = $config['base'];
$this->webroot = $config['webroot'];
$this->url = substr($uri->getPath(), 1);
$this->here = $this->base . '/' . $this->url;
if (isset($config['input'])) {
$stream = new Stream('php://memory', 'rw');
$stream->write($config['input']);
$stream->rewind();
} else {
$stream = new PhpInputStream();
}
$this->stream = $stream;
$config['post'] = $this->_processPost($config['post']);
$this->data = $this->_processFiles($config['post'], $config['files']);
$this->query = $this->_processGet($config['query'], $querystr);
$this->params = $config['params'];
$this->_session = $config['session'];
}
/**
* Sets the REQUEST_METHOD environment variable based on the simulated _method
* HTTP override value. The 'ORIGINAL_REQUEST_METHOD' is also preserved, if you
* want the read the non-simulated HTTP method the client used.
*
* @param array $data Array of post data.
* @return array
*/
protected function _processPost($data)
{
$method = $this->env('REQUEST_METHOD');
$override = false;
if (in_array($method, ['PUT', 'DELETE', 'PATCH']) &&
strpos($this->contentType(), 'application/x-www-form-urlencoded') === 0
) {
$data = $this->input();
parse_str($data, $data);
}
if ($this->env('HTTP_X_HTTP_METHOD_OVERRIDE')) {
$data['_method'] = $this->env('HTTP_X_HTTP_METHOD_OVERRIDE');
$override = true;
}
$this->_environment['ORIGINAL_REQUEST_METHOD'] = $method;
if (isset($data['_method'])) {
$this->_environment['REQUEST_METHOD'] = $data['_method'];
unset($data['_method']);
$override = true;
}
if ($override && !in_array($this->_environment['REQUEST_METHOD'], ['PUT', 'POST', 'DELETE', 'PATCH'])) {
$data = [];
}
return $data;
}
/**
* Process the GET parameters and move things into the object.
*
* @param string $queryString A query string from the URL if provided
* @param array $query The array to which the parsed keys/values are being added.
* @return array An array containing the parsed querystring keys/values.
*/
protected function _processGet($query, $queryString = '')
{
$unsetUrl = '/' . str_replace(['.', ' '], '_', urldecode($this->url));
unset($query[$unsetUrl]);
unset($query[$this->base . $unsetUrl]);
if (strlen($queryString)) {
parse_str($queryString, $queryArgs);
$query += $queryArgs;
}
return $query;
}
/**
* Get the request uri. Looks in PATH_INFO first, as this is the exact value we need prepared
* by PHP. Following that, REQUEST_URI, PHP_SELF, HTTP_X_REWRITE_URL and argv are checked in that order.
* Each of these server variables have the base path, and query strings stripped off
*
* @param array $config Configuration to set.
* @return string URI The CakePHP request path that is being accessed.
*/
protected static function _url($config)
{
if (!empty($_SERVER['PATH_INFO'])) {
return $_SERVER['PATH_INFO'];
}
if (isset($_SERVER['REQUEST_URI']) && strpos($_SERVER['REQUEST_URI'], '://') === false) {
$uri = $_SERVER['REQUEST_URI'];
} elseif (isset($_SERVER['REQUEST_URI'])) {
$uri = $_SERVER['REQUEST_URI'];
$fullBaseUrl = Configure::read('App.fullBaseUrl');
if (strpos($uri, $fullBaseUrl) === 0) {
$uri = substr($_SERVER['REQUEST_URI'], strlen($fullBaseUrl));
}
} elseif (isset($_SERVER['PHP_SELF'], $_SERVER['SCRIPT_NAME'])) {
$uri = str_replace($_SERVER['SCRIPT_NAME'], '', $_SERVER['PHP_SELF']);
} elseif (isset($_SERVER['HTTP_X_REWRITE_URL'])) {
$uri = $_SERVER['HTTP_X_REWRITE_URL'];
} elseif ($var = env('argv')) {
$uri = $var[0];
}
$base = $config['base'];
if (strlen($base) > 0 && strpos($uri, $base) === 0) {
$uri = substr($uri, strlen($base));
}
if (strpos($uri, '?') !== false) {
list($uri) = explode('?', $uri, 2);
}
if (empty($uri) || $uri === '/' || $uri === '//' || $uri === '/index.php') {
$uri = '/';
}
$endsWithIndex = '/webroot/index.php';
$endsWithLength = strlen($endsWithIndex);
if (strlen($uri) >= $endsWithLength &&
substr($uri, -$endsWithLength) === $endsWithIndex
) {
$uri = '/';
}
return $uri;
}
/**
* Returns a base URL and sets the proper webroot
*
* If CakePHP is called with index.php in the URL even though
* URL Rewriting is activated (and thus not needed) it swallows
* the unnecessary part from $base to prevent issue #3318.
*
* @return array Base URL, webroot dir ending in /
*/
protected static function _base()
{
$base = $webroot = $baseUrl = null;
$config = Configure::read('App');
extract($config);
if ($base !== false && $base !== null) {
return [$base, $base . '/'];
}
if (!$baseUrl) {
$base = dirname(env('PHP_SELF'));
// Clean up additional / which cause following code to fail..
$base = preg_replace('#/+#', '/', $base);
$indexPos = strpos($base, '/' . $webroot . '/index.php');
if ($indexPos !== false) {
$base = substr($base, 0, $indexPos) . '/' . $webroot;
}
if ($webroot === basename($base)) {
$base = dirname($base);
}
if ($base === DIRECTORY_SEPARATOR || $base === '.') {
$base = '';
}
$base = implode('/', array_map('rawurlencode', explode('/', $base)));
return [$base, $base . '/'];
}
$file = '/' . basename($baseUrl);
$base = dirname($baseUrl);
if ($base === DIRECTORY_SEPARATOR || $base === '.') {
$base = '';
}
$webrootDir = $base . '/';
$docRoot = env('DOCUMENT_ROOT');
$docRootContainsWebroot = strpos($docRoot, $webroot);
if (!empty($base) || !$docRootContainsWebroot) {
if (strpos($webrootDir, '/' . $webroot . '/') === false) {
$webrootDir .= $webroot . '/';
}
}
return [$base . $file, $webrootDir];
}
/**
* Process uploaded files and move things onto the post data.
*
* @param array $post Post data to merge files onto.
* @param array $files Uploaded files to merge in.
* @return array merged post + file data.
*/
protected function _processFiles($post, $files)
{
if (!is_array($files)) {
return $post;
}
$fileData = [];
foreach ($files as $key => $value) {
if ($value instanceof UploadedFileInterface) {
$fileData[$key] = $value;
continue;
}
if (is_array($value) && isset($value['tmp_name'])) {
$fileData[$key] = $this->_createUploadedFile($value);
continue;
}
throw new InvalidArgumentException(sprintf(
'Invalid value in FILES "%s"',
json_encode($value)
));
}
$this->uploadedFiles = $fileData;
// Make a flat map that can be inserted into $post for BC.
$fileMap = Hash::flatten($fileData);
foreach ($fileMap as $key => $file) {
$error = $file->getError();
$tmpName = '';
if ($error === UPLOAD_ERR_OK) {
$tmpName = $file->getStream()->getMetadata('uri');
}
$post = Hash::insert($post, $key, [
'tmp_name' => $tmpName,
'error' => $error,
'name' => $file->getClientFilename(),
'type' => $file->getClientMediaType(),
'size' => $file->getSize(),
]);
}
return $post;
}
/**
* Create an UploadedFile instance from a $_FILES array.
*
* If the value represents an array of values, this method will
* recursively process the data.
*
* @param array $value $_FILES struct
* @return array|UploadedFileInterface
*/
protected function _createUploadedFile(array $value)
{
if (is_array($value['tmp_name'])) {
return $this->_normalizeNestedFiles($value);
}
return new UploadedFile(
$value['tmp_name'],
$value['size'],
$value['error'],
$value['name'],
$value['type']
);
}
/**
* Normalize an array of file specifications.
*
* Loops through all nested files and returns a normalized array of
* UploadedFileInterface instances.
*
* @param array $files The file data to normalize & convert.
* @return array An array of UploadedFileInterface objects.
*/
protected function _normalizeNestedFiles(array $files = [])
{
$normalizedFiles = [];
foreach (array_keys($files['tmp_name']) as $key) {
$spec = [
'tmp_name' => $files['tmp_name'][$key],
'size' => $files['size'][$key],
'error' => $files['error'][$key],
'name' => $files['name'][$key],
'type' => $files['type'][$key],
];
$normalizedFiles[$key] = $this->_createUploadedFile($spec);
}
return $normalizedFiles;
}
/**
* Get the content type used in this request.
*
* @return string
*/
public function contentType()
{
$type = $this->env('CONTENT_TYPE');
if ($type) {
return $type;
}
return $this->env('HTTP_CONTENT_TYPE');
}
/**
* Returns the instance of the Session object for this request
*
* If a session object is passed as first argument it will be set as
* the session to use for this request
*
* @param \Cake\Network\Session|null $session the session object to use
* @return \Cake\Network\Session
*/
public function session(Session $session = null)
{
if ($session === null) {
return $this->_session;
}
return $this->_session = $session;
}
/**
* Get the IP the client is using, or says they are using.
*
* @return string The client IP.
*/
public function clientIp()
{
if ($this->trustProxy && $this->env('HTTP_X_FORWARDED_FOR')) {
$ipaddr = preg_replace('/(?:,.*)/', '', $this->env('HTTP_X_FORWARDED_FOR'));
} elseif ($this->trustProxy && $this->env('HTTP_CLIENT_IP')) {
$ipaddr = $this->env('HTTP_CLIENT_IP');
} else {
$ipaddr = $this->env('REMOTE_ADDR');
}
return trim($ipaddr);
}
/**
* Returns the referer that referred this request.
*
* @param bool $local Attempt to return a local address.
* Local addresses do not contain hostnames.
* @return string The referring address for this request.
*/
public function referer($local = false)
{
$ref = $this->env('HTTP_REFERER');
$base = Configure::read('App.fullBaseUrl') . $this->webroot;
if (!empty($ref) && !empty($base)) {
if ($local && strpos($ref, $base) === 0) {
$ref = substr($ref, strlen($base));
if (!strlen($ref)) {
$ref = '/';
}
if ($ref[0] !== '/') {
$ref = '/' . $ref;
}
return $ref;
}
if (!$local) {
return $ref;
}
}
return '/';
}
/**
* Missing method handler, handles wrapping older style isAjax() type methods
*
* @param string $name The method called
* @param array $params Array of parameters for the method call
* @return mixed
* @throws \BadMethodCallException when an invalid method is called.
*/
public function __call($name, $params)
{
if (strpos($name, 'is') === 0) {
$type = strtolower(substr($name, 2));
array_unshift($params, $type);
return call_user_func_array([$this, 'is'], $params);
}
throw new BadMethodCallException(sprintf('Method %s does not exist', $name));
}
/**
* Magic get method allows access to parsed routing parameters directly on the object.
*
* Allows access to `$this->params['controller']` via `$this->controller`
*
* @param string $name The property being accessed.
* @return mixed Either the value of the parameter or null.
* @deprecated 3.4.0 Accessing routing parameters through __get will removed in 4.0.0.
* Use param() instead.
*/
public function __get($name)
{
if (isset($this->params[$name])) {
return $this->params[$name];
}
return null;
}
/**
* Magic isset method allows isset/empty checks
* on routing parameters.
*
* @param string $name The property being accessed.
* @return bool Existence
* @deprecated 3.4.0 Accessing routing parameters through __isset will removed in 4.0.0.
* Use param() instead.
*/
public function __isset($name)
{
return isset($this->params[$name]);
}
/**
* Check whether or not a Request is a certain type.
*
* Uses the built in detection rules as well as additional rules
* defined with Cake\Network\CakeRequest::addDetector(). Any detector can be called
* as `is($type)` or `is$Type()`.
*
* @param string|array $type The type of request you want to check. If an array
* this method will return true if the request matches any type.
* @return bool Whether or not the request is the type you are checking.
*/
public function is($type)
{
if (is_array($type)) {
$result = array_map([$this, 'is'], $type);
return count(array_filter($result)) > 0;
}
$args = func_get_args();
array_shift($args);
$type = strtolower($type);
if (!isset(static::$_detectors[$type])) {
return false;
}
if ($args) {
return $this->_is($type, $args);
}
if (!isset($this->_detectorCache[$type])) {
$this->_detectorCache[$type] = $this->_is($type, $args);
}
return $this->_detectorCache[$type];
}
/**
* Clears the instance detector cache, used by the is() function
*
* @return void
*/
public function clearDetectorCache()
{
$this->_detectorCache = [];
}
/**
* Worker for the public is() function
*
* @param string|array $type The type of request you want to check. If an array
* this method will return true if the request matches any type.
* @param array $args Array of custom detector arguments.
* @return bool Whether or not the request is the type you are checking.
*/
protected function _is($type, $args)
{
$detect = static::$_detectors[$type];
if (is_callable($detect)) {
array_unshift($args, $this);
return call_user_func_array($detect, $args);
}
if (isset($detect['env']) && $this->_environmentDetector($detect)) {
return true;
}
if (isset($detect['header']) && $this->_headerDetector($detect)) {
return true;
}
if (isset($detect['accept']) && $this->_acceptHeaderDetector($detect)) {
return true;
}
if (isset($detect['param']) && $this->_paramDetector($detect)) {
return true;
}
return false;
}
/**
* Detects if a specific accept header is present.
*
* @param array $detect Detector options array.
* @return bool Whether or not the request is the type you are checking.
*/
protected function _acceptHeaderDetector($detect)
{
$acceptHeaders = explode(',', $this->env('HTTP_ACCEPT'));
foreach ($detect['accept'] as $header) {
if (in_array($header, $acceptHeaders)) {
return true;
}
}
return false;
}
/**
* Detects if a specific header is present.
*
* @param array $detect Detector options array.
* @return bool Whether or not the request is the type you are checking.
*/
protected function _headerDetector($detect)
{
foreach ($detect['header'] as $header => $value) {
$header = $this->env('http_' . $header);
if ($header !== null) {
if (!is_string($value) && !is_bool($value) && is_callable($value)) {
return call_user_func($value, $header);
}
return ($header === $value);
}
}
return false;
}
/**
* Detects if a specific request parameter is present.
*
* @param array $detect Detector options array.
* @return bool Whether or not the request is the type you are checking.
*/
protected function _paramDetector($detect)
{
$key = $detect['param'];
if (isset($detect['value'])) {
$value = $detect['value'];
return isset($this->params[$key]) ? $this->params[$key] == $value : false;
}
if (isset($detect['options'])) {
return isset($this->params[$key]) ? in_array($this->params[$key], $detect['options']) : false;
}
return false;
}
/**
* Detects if a specific environment variable is present.
*
* @param array $detect Detector options array.
* @return bool Whether or not the request is the type you are checking.
*/
protected function _environmentDetector($detect)
{
if (isset($detect['env'])) {
if (isset($detect['value'])) {
return $this->env($detect['env']) == $detect['value'];
}
if (isset($detect['pattern'])) {
return (bool)preg_match($detect['pattern'], $this->env($detect['env']));
}
if (isset($detect['options'])) {
$pattern = '/' . implode('|', $detect['options']) . '/i';
return (bool)preg_match($pattern, $this->env($detect['env']));
}
}
return false;
}
/**
* Check that a request matches all the given types.
*
* Allows you to test multiple types and union the results.
* See Request::is() for how to add additional types and the
* built-in types.
*
* @param array $types The types to check.
* @return bool Success.
* @see \Cake\Network\Request::is()
*/
public function isAll(array $types)
{
$result = array_filter(array_map([$this, 'is'], $types));
return count($result) === count($types);
}
/**
* Add a new detector to the list of detectors that a request can use.
* There are several different formats and types of detectors that can be set.
*
* ### Callback detectors
*
* Callback detectors allow you to provide a callable to handle the check.
* The callback will receive the request object as its only parameter.
*
* ```
* addDetector('custom', function ($request) { //Return a boolean });
* addDetector('custom', ['SomeClass', 'somemethod']);
* ```
*
* ### Environment value comparison
*
* An environment value comparison, compares a value fetched from `env()` to a known value
* the environment value is equality checked against the provided value.
*
* e.g `addDetector('post', ['env' => 'REQUEST_METHOD', 'value' => 'POST'])`
*
* ### Pattern value comparison
*
* Pattern value comparison allows you to compare a value fetched from `env()` to a regular expression.
*
* ```
* addDetector('iphone', ['env' => 'HTTP_USER_AGENT', 'pattern' => '/iPhone/i']);
* ```
*
* ### Option based comparison
*
* Option based comparisons use a list of options to create a regular expression. Subsequent calls
* to add an already defined options detector will merge the options.
*
* ```
* addDetector('mobile', ['env' => 'HTTP_USER_AGENT', 'options' => ['Fennec']]);
* ```
*
* ### Request parameter detectors
*
* Allows for custom detectors on the request parameters.
*
* e.g `addDetector('requested', ['param' => 'requested', 'value' => 1]`
*
* You can also make parameter detectors that accept multiple values
* using the `options` key. This is useful when you want to check
* if a request parameter is in a list of options.
*
* `addDetector('extension', ['param' => 'ext', 'options' => ['pdf', 'csv']]`
*
* @param string $name The name of the detector.
* @param callable|array $callable A callable or options array for the detector definition.
* @return void
*/
public static function addDetector($name, $callable)
{
$name = strtolower($name);
if (is_callable($callable)) {
static::$_detectors[$name] = $callable;
return;
}
if (isset(static::$_detectors[$name], $callable['options'])) {
$callable = Hash::merge(static::$_detectors[$name], $callable);
}
static::$_detectors[$name] = $callable;
}
/**
* Add parameters to the request's parsed parameter set. This will overwrite any existing parameters.
* This modifies the parameters available through `$request->params`.