/
WebRequest.php
1473 lines (1346 loc) · 42.8 KB
/
WebRequest.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
/**
* Deal with importing all those nasty globals and things
*
* Copyright © 2003 Brion Vibber <brion@pobox.com>
* https://www.mediawiki.org/
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Session\Session;
use MediaWiki\Session\SessionId;
use MediaWiki\Session\SessionManager;
use MediaWiki\User\UserIdentity;
use Wikimedia\IPUtils;
// The point of this class is to be a wrapper around super globals
// phpcs:disable MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
/**
* The WebRequest class encapsulates getting at data passed in the
* URL or via a POSTed form stripping illegal input characters and
* normalizing Unicode sequences.
*
* @ingroup HTTP
*/
class WebRequest {
/**
* The parameters from $_GET, $_POST and the path router
* @var array
*/
protected $data;
/**
* The parameters from $_GET. The parameters from the path router are
* added by interpolateTitle() during Setup.php.
* @var string[]
*/
protected $queryAndPathParams;
/**
* The parameters from $_GET only.
* @var string[]
*/
protected $queryParams;
/**
* Lazy-initialized request headers indexed by upper-case header name
* @var string[]
*/
protected $headers = [];
/**
* Flag to make WebRequest::getHeader return an array of values.
* @since 1.26
*/
public const GETHEADER_LIST = 1;
/**
* The unique request ID.
* @var string
*/
private static $reqId;
/**
* Lazy-init response object
* @var WebResponse
*/
private $response;
/**
* Cached client IP address
* @var string
*/
private $ip;
/**
* The timestamp of the start of the request, with microsecond precision.
* @var float
*/
protected $requestTime;
/**
* Cached URL protocol
* @var string
*/
protected $protocol;
/**
* @var SessionId|null Session ID to use for this
* request. We can't save the session directly due to reference cycles not
* working too well (slow GC).
*
* TODO: Investigate whether this GC slowness concern (added in a73c5b7395 with regard to
* PHP 5.6) still applies in PHP 7.2+.
*/
protected $sessionId = null;
/** @var bool Whether this HTTP request is "safe" (even if it is an HTTP post) */
protected $markedAsSafe = false;
/**
* @codeCoverageIgnore
*/
public function __construct() {
$this->requestTime = $_SERVER['REQUEST_TIME_FLOAT'];
// POST overrides GET data
// We don't use $_REQUEST here to avoid interference from cookies...
$this->data = $_POST + $_GET;
$this->queryAndPathParams = $this->queryParams = $_GET;
}
/**
* Extract relevant query arguments from the http request uri's path
* to be merged with the normal php provided query arguments.
* Tries to use the REQUEST_URI data if available and parses it
* according to the wiki's configuration looking for any known pattern.
*
* If the REQUEST_URI is not provided we'll fall back on the PATH_INFO
* provided by the server if any and use that to set a 'title' parameter.
*
* This internal method handles many odd cases and is tailored specifically for
* used by WebRequest::interpolateTitle, for index.php requests.
* Consider using WebRequest::getRequestPathSuffix for other path-related use cases.
*
* @param string $want If this is not 'all', then the function
* will return an empty array if it determines that the URL is
* inside a rewrite path.
*
* @return string[] Any query arguments found in path matches.
* @throws FatalError If invalid routes are configured (T48998)
*/
protected static function getPathInfo( $want = 'all' ) {
// PATH_INFO is mangled due to https://bugs.php.net/bug.php?id=31892
// And also by Apache 2.x, double slashes are converted to single slashes.
// So we will use REQUEST_URI if possible.
if ( isset( $_SERVER['REQUEST_URI'] ) ) {
// Slurp out the path portion to examine...
$url = $_SERVER['REQUEST_URI'];
if ( !preg_match( '!^https?://!', $url ) ) {
$url = 'http://unused' . $url;
}
$a = parse_url( $url );
if ( !$a ) {
return [];
}
$path = $a['path'] ?? '';
global $wgScript;
if ( $path == $wgScript && $want !== 'all' ) {
// Script inside a rewrite path?
// Abort to keep from breaking...
return [];
}
$router = new PathRouter;
// Raw PATH_INFO style
$router->add( "$wgScript/$1" );
global $wgArticlePath;
if ( $wgArticlePath ) {
$router->validateRoute( $wgArticlePath, 'wgArticlePath' );
$router->add( $wgArticlePath );
}
global $wgActionPaths;
$articlePaths = PathRouter::getActionPaths( $wgActionPaths, $wgArticlePath );
if ( $articlePaths ) {
$router->add( $articlePaths, [ 'action' => '$key' ] );
}
global $wgVariantArticlePath;
if ( $wgVariantArticlePath ) {
$services = MediaWikiServices::getInstance();
$router->validateRoute( $wgVariantArticlePath, 'wgVariantArticlePath' );
$router->add( $wgVariantArticlePath,
[ 'variant' => '$2' ],
[ '$2' => $services->getLanguageConverterFactory()
->getLanguageConverter( $services->getContentLanguage() )
->getVariants() ]
);
}
Hooks::runner()->onWebRequestPathInfoRouter( $router );
$matches = $router->parse( $path );
} else {
global $wgUsePathInfo;
$matches = [];
if ( $wgUsePathInfo ) {
if ( !empty( $_SERVER['ORIG_PATH_INFO'] ) ) {
// Mangled PATH_INFO
// https://bugs.php.net/bug.php?id=31892
// Also reported when ini_get('cgi.fix_pathinfo')==false
$matches['title'] = substr( $_SERVER['ORIG_PATH_INFO'], 1 );
} elseif ( !empty( $_SERVER['PATH_INFO'] ) ) {
// Regular old PATH_INFO yay
$matches['title'] = substr( $_SERVER['PATH_INFO'], 1 );
}
}
}
return $matches;
}
/**
* If the request URL matches a given base path, extract the path part of
* the request URL after that base, and decode escape sequences in it.
*
* If the request URL does not match, false is returned.
*
* @since 1.35
* @param string $basePath The base URL path. Trailing slashes will be
* stripped.
* @return string|false
*/
public static function getRequestPathSuffix( $basePath ) {
$basePath = rtrim( $basePath, '/' ) . '/';
$requestUrl = self::getGlobalRequestURL();
$qpos = strpos( $requestUrl, '?' );
if ( $qpos !== false ) {
$requestPath = substr( $requestUrl, 0, $qpos );
} else {
$requestPath = $requestUrl;
}
if ( !str_starts_with( $requestPath, $basePath ) ) {
return false;
}
return rawurldecode( substr( $requestPath, strlen( $basePath ) ) );
}
/**
* Work out an appropriate URL prefix containing scheme and host, based on
* information detected from $_SERVER
*
* @param bool|null $assumeProxiesUseDefaultProtocolPorts When the wiki is running behind a proxy
* and this is set to true, assumes that the proxy exposes the wiki on the standard ports
* (443 for https and 80 for http). Added in 1.38. Calls without this argument are
* supported for backwards compatibility but deprecated.
*
* @return string
*/
public static function detectServer( $assumeProxiesUseDefaultProtocolPorts = null ) {
if ( $assumeProxiesUseDefaultProtocolPorts === null ) {
$assumeProxiesUseDefaultProtocolPorts = $GLOBALS['wgAssumeProxiesUseDefaultProtocolPorts'];
}
$proto = self::detectProtocol();
$stdPort = $proto === 'https' ? 443 : 80;
$varNames = [ 'HTTP_HOST', 'SERVER_NAME', 'HOSTNAME', 'SERVER_ADDR' ];
$host = 'localhost';
$port = $stdPort;
foreach ( $varNames as $varName ) {
if ( !isset( $_SERVER[$varName] ) ) {
continue;
}
$parts = IPUtils::splitHostAndPort( $_SERVER[$varName] );
if ( !$parts ) {
// Invalid, do not use
continue;
}
$host = $parts[0];
if ( $assumeProxiesUseDefaultProtocolPorts && isset( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) ) {
// T72021: Assume that upstream proxy is running on the default
// port based on the protocol. We have no reliable way to determine
// the actual port in use upstream.
$port = $stdPort;
} elseif ( $parts[1] === false ) {
if ( isset( $_SERVER['SERVER_PORT'] ) ) {
$port = $_SERVER['SERVER_PORT'];
} // else leave it as $stdPort
} else {
$port = $parts[1];
}
break;
}
return $proto . '://' . IPUtils::combineHostAndPort( $host, $port, $stdPort );
}
/**
* Detect the protocol from $_SERVER.
* This is for use prior to Setup.php, when no WebRequest object is available.
* At other times, use the non-static function getProtocol().
*
* @return string
*/
public static function detectProtocol() {
if ( ( !empty( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] !== 'off' ) ||
( isset( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) &&
$_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https' ) ) {
return 'https';
} else {
return 'http';
}
}
/**
* Get the number of seconds to have elapsed since request start,
* in fractional seconds, with microsecond resolution.
*
* @return float
* @since 1.25
*/
public function getElapsedTime() {
return microtime( true ) - $this->requestTime;
}
/**
* Get the current request ID.
*
* This is usually based on the `X-Request-Id` header, or the `UNIQUE_ID`
* environment variable, falling back to (process cached) randomly-generated string.
*
* @return string
* @since 1.27
*/
public static function getRequestId() {
// This method is called from various error handlers and MUST be kept simple and stateless.
if ( !self::$reqId ) {
global $wgAllowExternalReqID;
if ( $wgAllowExternalReqID ) {
$id = $_SERVER['HTTP_X_REQUEST_ID'] ?? $_SERVER['UNIQUE_ID'] ?? wfRandomString( 24 );
} else {
$id = $_SERVER['UNIQUE_ID'] ?? wfRandomString( 24 );
}
self::$reqId = $id;
}
return self::$reqId;
}
/**
* Override the unique request ID. This is for sub-requests, such as jobs,
* that wish to use the same id but are not part of the same execution context.
*
* @param string $id
* @since 1.27
*/
public static function overrideRequestId( $id ) {
self::$reqId = $id;
}
/**
* Get the current URL protocol (http or https)
* @return string
*/
public function getProtocol() {
if ( $this->protocol === null ) {
$this->protocol = self::detectProtocol();
}
return $this->protocol;
}
/**
* Check for title, action, and/or variant data in the URL
* and interpolate it into the GET variables.
* This should only be run after the content language is available,
* as we may need the list of language variants to determine
* available variant URLs.
*/
public function interpolateTitle() {
$matches = self::getPathInfo( 'title' );
foreach ( $matches as $key => $val ) {
$this->data[$key] = $this->queryAndPathParams[$key] = $val;
}
}
/**
* URL rewriting function; tries to extract page title and,
* optionally, one other fixed parameter value from a URL path.
*
* @param string $path The URL path given from the client
* @param array $bases One or more URLs, optionally with $1 at the end
* @param string|false $key If provided, the matching key in $bases will be
* passed on as the value of this URL parameter
* @return array Array of URL variables to interpolate; empty if no match
*/
public static function extractTitle( $path, $bases, $key = false ) {
foreach ( (array)$bases as $keyValue => $base ) {
// Find the part after $wgArticlePath
$base = str_replace( '$1', '', $base );
$baseLen = strlen( $base );
if ( substr( $path, 0, $baseLen ) == $base ) {
$raw = substr( $path, $baseLen );
if ( $raw !== '' ) {
$matches = [ 'title' => rawurldecode( $raw ) ];
if ( $key ) {
$matches[$key] = $keyValue;
}
return $matches;
}
}
}
return [];
}
/**
* Recursively normalizes UTF-8 strings in the given array.
*
* @param string|array $data
* @return array|string Cleaned-up version of the given
* @internal
*/
public function normalizeUnicode( $data ) {
if ( is_array( $data ) ) {
foreach ( $data as $key => $val ) {
$data[$key] = $this->normalizeUnicode( $val );
}
} else {
$contLang = MediaWikiServices::getInstance()->getContentLanguage();
$data = $contLang->normalize( $data );
}
return $data;
}
/**
* Fetch a value from the given array or return $default if it's not set.
*
* @param array $arr
* @param string $name
* @param mixed $default
* @return mixed
*/
private function getGPCVal( $arr, $name, $default ) {
# PHP is so nice to not touch input data, except sometimes:
# https://www.php.net/variables.external#language.variables.external.dot-in-names
# Work around PHP *feature* to avoid *bugs* elsewhere.
$name = strtr( $name, '.', '_' );
if ( !isset( $arr[$name] ) ) {
return $default;
}
$data = $arr[$name];
# Optimisation: Skip UTF-8 normalization and legacy transcoding for simple ASCII strings.
$isAsciiStr = ( is_string( $data ) && preg_match( '/[^\x20-\x7E]/', $data ) === 0 );
if ( !$isAsciiStr ) {
if ( isset( $_GET[$name] ) && is_string( $data ) ) {
# Check for alternate/legacy character encoding.
$data = MediaWikiServices::getInstance()
->getContentLanguage()
->checkTitleEncoding( $data );
}
$data = $this->normalizeUnicode( $data );
}
return $data;
}
/**
* Fetch a string WITHOUT any Unicode or line break normalization. This is a fast alternative
* for values that are known to be simple, e.g. pure ASCII. When reading user input, use
* {@see getText} instead.
*
* Array values are discarded for security reasons. Use {@see getArray} or {@see getIntArray}.
*
* @since 1.28
* @param string $name
* @param string|null $default
* @return string|null The value, or $default if none set
*/
public function getRawVal( $name, $default = null ) {
$name = strtr( $name, '.', '_' ); // See comment in self::getGPCVal()
if ( isset( $this->data[$name] ) && !is_array( $this->data[$name] ) ) {
$val = $this->data[$name];
} else {
$val = $default;
}
return $val === null ? null : (string)$val;
}
/**
* Fetch a text string and partially normalized it.
*
* Use of this method is discouraged. It doesn't normalize line breaks and defaults to null
* instead of the empty string. Instead:
* - Use {@see getText} when reading user input or form fields that are expected to contain
* non-ASCII characters.
* - Use {@see getRawVal} when reading ASCII strings, such as parameters used to select
* predefined behaviour in the software.
*
* Array values are discarded for security reasons. Use {@see getArray} or {@see getIntArray}.
*
* @param string $name
* @param string|null $default
* @return string|null The input value, or $default if none set
*/
public function getVal( $name, $default = null ) {
$val = $this->getGPCVal( $this->data, $name, $default );
if ( is_array( $val ) ) {
$val = $default;
}
return $val === null ? null : (string)$val;
}
/**
* Fetch a text string and return it in normalized form.
*
* This normalizes Unicode sequences (via {@see getGPCVal}) and line breaks.
*
* This should be used for all user input and form fields that are expected to contain non-ASCII
* characters, especially if the value will be stored or compared against stored values. Without
* normalization, logically identically values might not match when they are typed on different
* OS' or keyboards.
*
* Array values are discarded for security reasons. Use {@see getArray} or {@see getIntArray}.
*
* @param string $name
* @param string $default
* @return string The normalized input value, or $default if none set
*/
public function getText( $name, $default = '' ) {
$val = $this->getVal( $name, $default );
return str_replace( "\r\n", "\n", $val );
}
/**
* Set an arbitrary value into our get/post data.
*
* @param string $key Key name to use
* @param mixed $value Value to set
* @return mixed Old value if one was present, null otherwise
*/
public function setVal( $key, $value ) {
$ret = $this->data[$key] ?? null;
$this->data[$key] = $value;
return $ret;
}
/**
* Unset an arbitrary value from our get/post data.
*
* @param string $key Key name to use
* @return mixed Old value if one was present, null otherwise
*/
public function unsetVal( $key ) {
if ( !isset( $this->data[$key] ) ) {
$ret = null;
} else {
$ret = $this->data[$key];
unset( $this->data[$key] );
}
return $ret;
}
/**
* Fetch an array from the input or return $default if it's not set.
* If source was scalar, will return an array with a single element.
* If no source and no default, returns null.
*
* @param string $name
* @param array|null $default Optional default (or null)
* @return array|null
*/
public function getArray( $name, $default = null ) {
$val = $this->getGPCVal( $this->data, $name, $default );
if ( $val === null ) {
return null;
} else {
return (array)$val;
}
}
/**
* Fetch an array of integers, or return $default if it's not set.
* If source was scalar, will return an array with a single element.
* If no source and no default, returns null.
* If an array is returned, contents are guaranteed to be integers.
*
* @param string $name
* @param array|null $default Option default (or null)
* @return int[]|null
*/
public function getIntArray( $name, $default = null ) {
$val = $this->getArray( $name, $default );
if ( is_array( $val ) ) {
$val = array_map( 'intval', $val );
}
return $val;
}
/**
* Fetch an integer value from the input or return $default if not set.
* Guaranteed to return an integer; non-numeric input will typically
* return 0.
*
* @param string $name
* @param int $default
* @return int
*/
public function getInt( $name, $default = 0 ) {
// @phan-suppress-next-line PhanTypeMismatchArgument getRawVal does not return null here
return intval( $this->getRawVal( $name, $default ) );
}
/**
* Fetch an integer value from the input or return null if empty.
* Guaranteed to return an integer or null; non-numeric input will
* typically return null.
*
* @param string $name
* @return int|null
*/
public function getIntOrNull( $name ) {
$val = $this->getRawVal( $name );
return is_numeric( $val )
? intval( $val )
: null;
}
/**
* Fetch a floating point value from the input or return $default if not set.
* Guaranteed to return a float; non-numeric input will typically
* return 0.
*
* @since 1.23
* @param string $name
* @param float $default
* @return float
*/
public function getFloat( $name, $default = 0.0 ) {
// @phan-suppress-next-line PhanTypeMismatchArgument getRawVal does not return null here
return floatval( $this->getRawVal( $name, $default ) );
}
/**
* Fetch a boolean value from the input or return $default if not set.
* Guaranteed to return true or false, with normal PHP semantics for
* boolean interpretation of strings.
*
* @param string $name
* @param bool $default
* @return bool
*/
public function getBool( $name, $default = false ) {
// @phan-suppress-next-line PhanTypeMismatchArgument getRawVal does not return null here
return (bool)$this->getRawVal( $name, $default );
}
/**
* Fetch a boolean value from the input or return $default if not set.
* Unlike getBool, the string "false" will result in boolean false, which is
* useful when interpreting information sent from JavaScript.
*
* @param string $name
* @param bool $default
* @return bool
*/
public function getFuzzyBool( $name, $default = false ) {
return $this->getBool( $name, $default )
&& strcasecmp( $this->getRawVal( $name ), 'false' ) !== 0;
}
/**
* Return true if the named value is set in the input, whatever that
* value is (even "0"). Return false if the named value is not set.
* Example use is checking for the presence of check boxes in forms.
*
* @param string $name
* @return bool
*/
public function getCheck( $name ) {
# Checkboxes and buttons are only present when clicked
# Presence connotes truth, absence false
return $this->getRawVal( $name, null ) !== null;
}
/**
* Extracts the (given) named values into an array.
* No transformation is performed on the values.
*
* @param string ...$names If no arguments are given, returns all input values
* @return array
*/
public function getValues( ...$names ) {
if ( $names === [] ) {
$names = array_keys( $this->data );
}
$retVal = [];
foreach ( $names as $name ) {
$value = $this->getGPCVal( $this->data, $name, null );
if ( $value !== null ) {
$retVal[$name] = $value;
}
}
return $retVal;
}
/**
* Returns the names of all input values excluding those in $exclude.
*
* @param array $exclude
* @return array
*/
public function getValueNames( $exclude = [] ) {
return array_diff( array_keys( $this->getValues() ), $exclude );
}
/**
* Get the values passed in the query string and the path router parameters.
* No transformation is performed on the values.
*
* @codeCoverageIgnore
* @return string[]
*/
public function getQueryValues() {
return $this->queryAndPathParams;
}
/**
* Get the values passed in the query string only, not including the path
* router parameters. This is less suitable for self-links to index.php but
* useful for other entry points. No transformation is performed on the
* values.
*
* @since 1.34
* @return string[]
*/
public function getQueryValuesOnly() {
return $this->queryParams;
}
/**
* Get the values passed via POST.
* No transformation is performed on the values.
*
* @since 1.32
* @codeCoverageIgnore
* @return string[]
*/
public function getPostValues() {
return $_POST;
}
/**
* Return the contents of the Query with no decoding. Use when you need to
* know exactly what was sent, e.g. for an OAuth signature over the elements.
*
* @codeCoverageIgnore
* @return string
*/
public function getRawQueryString() {
return $_SERVER['QUERY_STRING'];
}
/**
* Return the contents of the POST with no decoding. Use when you need to
* know exactly what was sent, e.g. for an OAuth signature over the elements.
*
* @return string
*/
public function getRawPostString() {
if ( !$this->wasPosted() ) {
return '';
}
return $this->getRawInput();
}
/**
* Return the raw request body, with no processing. Cached since some methods
* disallow reading the stream more than once. As stated in the php docs, this
* does not work with enctype="multipart/form-data".
*
* @return string
*/
public function getRawInput() {
static $input = null;
if ( $input === null ) {
$input = file_get_contents( 'php://input' );
}
return $input;
}
/**
* Get the HTTP method used for this request.
*
* @return string
*/
public function getMethod() {
return $_SERVER['REQUEST_METHOD'] ?? 'GET';
}
/**
* Returns true if the present request was reached by a POST operation,
* false otherwise (GET, HEAD, or command-line).
*
* Note that values retrieved by the object may come from the
* GET URL etc even on a POST request.
*
* @return bool
*/
public function wasPosted() {
return $this->getMethod() == 'POST';
}
/**
* Return the session for this request
*
* This might unpersist an existing session if it was invalid.
*
* @since 1.27
* @note For performance, keep the session locally if you will be making
* much use of it instead of calling this method repeatedly.
* @return Session
*/
public function getSession() {
if ( $this->sessionId !== null ) {
$session = SessionManager::singleton()->getSessionById( (string)$this->sessionId, true, $this );
if ( $session ) {
return $session;
}
}
$session = SessionManager::singleton()->getSessionForRequest( $this );
$this->sessionId = $session->getSessionId();
return $session;
}
/**
* Set the session for this request
* @since 1.27
* @internal For use by MediaWiki\Session classes only
* @param SessionId $sessionId
*/
public function setSessionId( SessionId $sessionId ) {
$this->sessionId = $sessionId;
}
/**
* Get the session id for this request, if any
* @since 1.27
* @internal For use by MediaWiki\Session classes only
* @return SessionId|null
*/
public function getSessionId() {
return $this->sessionId;
}
/**
* Get a cookie from the $_COOKIE jar
*
* @param string $key The name of the cookie
* @param string|null $prefix A prefix to use for the cookie name, if not $wgCookiePrefix
* @param mixed|null $default What to return if the value isn't found
* @return mixed Cookie value or $default if the cookie not set
*/
public function getCookie( $key, $prefix = null, $default = null ) {
if ( $prefix === null ) {
global $wgCookiePrefix;
$prefix = $wgCookiePrefix;
}
$name = $prefix . $key;
// Work around mangling of $_COOKIE
$name = strtr( $name, '.', '_' );
if ( isset( $_COOKIE[$name] ) ) {
return $_COOKIE[$name];
} else {
return $default;
}
}
/**
* Get a cookie set with SameSite=None possibly with a legacy fallback cookie.
*
* @param string $key The name of the cookie
* @param string $prefix A prefix to use, empty by default
* @param mixed|null $default What to return if the value isn't found
* @return mixed Cookie value or $default if the cookie is not set
*/
public function getCrossSiteCookie( $key, $prefix = '', $default = null ) {
global $wgUseSameSiteLegacyCookies;
$name = $prefix . $key;
// Work around mangling of $_COOKIE
$name = strtr( $name, '.', '_' );
if ( isset( $_COOKIE[$name] ) ) {
return $_COOKIE[$name];
}
if ( $wgUseSameSiteLegacyCookies ) {
$legacyName = $prefix . "ss0-" . $key;
$legacyName = strtr( $legacyName, '.', '_' );
if ( isset( $_COOKIE[$legacyName] ) ) {
return $_COOKIE[$legacyName];
}
}
return $default;
}
/**
* Return the path and query string portion of the main request URI.
* This will be suitable for use as a relative link in HTML output.
*
* @throws MWException
* @return string
*/
public static function getGlobalRequestURL() {
// This method is called on fatal errors; it should not depend on anything complex.
if ( isset( $_SERVER['REQUEST_URI'] ) && strlen( $_SERVER['REQUEST_URI'] ) ) {
$base = $_SERVER['REQUEST_URI'];
} elseif ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] )
&& strlen( $_SERVER['HTTP_X_ORIGINAL_URL'] )
) {
// Probably IIS; doesn't set REQUEST_URI
$base = $_SERVER['HTTP_X_ORIGINAL_URL'];
} elseif ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
$base = $_SERVER['SCRIPT_NAME'];
if ( isset( $_SERVER['QUERY_STRING'] ) && $_SERVER['QUERY_STRING'] != '' ) {
$base .= '?' . $_SERVER['QUERY_STRING'];
}
} else {
// This shouldn't happen!
throw new MWException( "Web server doesn't provide either " .
"REQUEST_URI, HTTP_X_ORIGINAL_URL or SCRIPT_NAME. Report details " .
"of your web server configuration to https://phabricator.wikimedia.org/" );
}
// User-agents should not send a fragment with the URI, but
// if they do, and the web server passes it on to us, we
// need to strip it or we get false-positive redirect loops
// or weird output URLs
$hash = strpos( $base, '#' );
if ( $hash !== false ) {
$base = substr( $base, 0, $hash );
}
if ( $base[0] == '/' ) {
// More than one slash will look like it is protocol relative
return preg_replace( '!^/+!', '/', $base );
} else {
// We may get paths with a host prepended; strip it.
return preg_replace( '!^[^:]+://[^/]+/+!', '/', $base );
}
}
/**
* Return the path and query string portion of the request URI.
* This will be suitable for use as a relative link in HTML output.
*
* @throws MWException
* @return string
*/
public function getRequestURL() {
return self::getGlobalRequestURL();
}
/**
* Return the request URI with the canonical service and hostname, path,
* and query string. This will be suitable for use as an absolute link
* in HTML or other output.
*
* If $wgServer is protocol-relative, this will return a fully
* qualified URL with the protocol of this request object.
*
* @return string
*/
public function getFullRequestURL() {
// Pass an explicit PROTO constant instead of PROTO_CURRENT so that we
// do not rely on state from the global $wgRequest object (which it would,
// via wfGetServerUrl/wfExpandUrl/$wgRequest->protocol).
if ( $this->getProtocol() === 'http' ) {
return wfGetServerUrl( PROTO_HTTP ) . $this->getRequestURL();
} else {
return wfGetServerUrl( PROTO_HTTPS ) . $this->getRequestURL();
}
}
/**
* @param string $key
* @param string $value
* @return string
*/
public function appendQueryValue( $key, $value ) {
return $this->appendQueryArray( [ $key => $value ] );
}