MediaWiki  master
WebRequest.php
Go to the documentation of this file.
1 <?php
30 use Wikimedia\IPUtils;
31 
32 // The point of this class is to be a wrapper around super globals
33 // phpcs:disable MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
34 
42 class WebRequest {
47  protected $data;
48 
55 
60  protected $queryParams;
61 
66  protected $headers = [];
67 
72  public const GETHEADER_LIST = 1;
73 
78  private static $reqId;
79 
84  private $response;
85 
90  private $ip;
91 
96  protected $requestTime;
97 
102  protected $protocol;
103 
112  protected $sessionId = null;
113 
115  protected $markedAsSafe = false;
116 
120  public function __construct() {
121  $this->requestTime = $_SERVER['REQUEST_TIME_FLOAT'];
122 
123  // POST overrides GET data
124  // We don't use $_REQUEST here to avoid interference from cookies...
125  $this->data = $_POST + $_GET;
126 
127  $this->queryAndPathParams = $this->queryParams = $_GET;
128  }
129 
150  protected static function getPathInfo( $want = 'all' ) {
151  // PATH_INFO is mangled due to https://bugs.php.net/bug.php?id=31892
152  // And also by Apache 2.x, double slashes are converted to single slashes.
153  // So we will use REQUEST_URI if possible.
154  if ( isset( $_SERVER['REQUEST_URI'] ) ) {
155  // Slurp out the path portion to examine...
156  $url = $_SERVER['REQUEST_URI'];
157  if ( !preg_match( '!^https?://!', $url ) ) {
158  $url = 'http://unused' . $url;
159  }
160  $a = parse_url( $url );
161  if ( !$a ) {
162  return [];
163  }
164  $path = $a['path'] ?? '';
165 
166  global $wgScript;
167  if ( $path == $wgScript && $want !== 'all' ) {
168  // Script inside a rewrite path?
169  // Abort to keep from breaking...
170  return [];
171  }
172 
173  $router = new PathRouter;
174 
175  // Raw PATH_INFO style
176  $router->add( "$wgScript/$1" );
177 
178  global $wgArticlePath;
179  if ( $wgArticlePath ) {
180  $router->validateRoute( $wgArticlePath, 'wgArticlePath' );
181  $router->add( $wgArticlePath );
182  }
183 
184  global $wgActionPaths;
186  if ( $articlePaths ) {
187  $router->add( $articlePaths, [ 'action' => '$key' ] );
188  }
189 
190  global $wgVariantArticlePath;
191  if ( $wgVariantArticlePath ) {
192  $router->validateRoute( $wgVariantArticlePath, 'wgVariantArticlePath' );
193  $router->add( $wgVariantArticlePath,
194  [ 'variant' => '$2' ],
195  [ '$2' => MediaWikiServices::getInstance()->getContentLanguage()->
196  getVariants() ]
197  );
198  }
199 
200  Hooks::runner()->onWebRequestPathInfoRouter( $router );
201 
202  $matches = $router->parse( $path );
203  } else {
204  global $wgUsePathInfo;
205  $matches = [];
206  if ( $wgUsePathInfo ) {
207  if ( !empty( $_SERVER['ORIG_PATH_INFO'] ) ) {
208  // Mangled PATH_INFO
209  // https://bugs.php.net/bug.php?id=31892
210  // Also reported when ini_get('cgi.fix_pathinfo')==false
211  $matches['title'] = substr( $_SERVER['ORIG_PATH_INFO'], 1 );
212  } elseif ( !empty( $_SERVER['PATH_INFO'] ) ) {
213  // Regular old PATH_INFO yay
214  $matches['title'] = substr( $_SERVER['PATH_INFO'], 1 );
215  }
216  }
217  }
218 
219  return $matches;
220  }
221 
233  public static function getRequestPathSuffix( $basePath ) {
234  $basePath = rtrim( $basePath, '/' ) . '/';
235  $requestUrl = self::getGlobalRequestURL();
236  $qpos = strpos( $requestUrl, '?' );
237  if ( $qpos !== false ) {
238  $requestPath = substr( $requestUrl, 0, $qpos );
239  } else {
240  $requestPath = $requestUrl;
241  }
242  if ( substr( $requestPath, 0, strlen( $basePath ) ) !== $basePath ) {
243  return false;
244  }
245  return rawurldecode( substr( $requestPath, strlen( $basePath ) ) );
246  }
247 
254  public static function detectServer() {
256 
257  $proto = self::detectProtocol();
258  $stdPort = $proto === 'https' ? 443 : 80;
259 
260  $varNames = [ 'HTTP_HOST', 'SERVER_NAME', 'HOSTNAME', 'SERVER_ADDR' ];
261  $host = 'localhost';
262  $port = $stdPort;
263  foreach ( $varNames as $varName ) {
264  if ( !isset( $_SERVER[$varName] ) ) {
265  continue;
266  }
267 
268  $parts = IPUtils::splitHostAndPort( $_SERVER[$varName] );
269  if ( !$parts ) {
270  // Invalid, do not use
271  continue;
272  }
273 
274  $host = $parts[0];
275  if ( $wgAssumeProxiesUseDefaultProtocolPorts && isset( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) ) {
276  // T72021: Assume that upstream proxy is running on the default
277  // port based on the protocol. We have no reliable way to determine
278  // the actual port in use upstream.
279  $port = $stdPort;
280  } elseif ( $parts[1] === false ) {
281  if ( isset( $_SERVER['SERVER_PORT'] ) ) {
282  $port = $_SERVER['SERVER_PORT'];
283  } // else leave it as $stdPort
284  } else {
285  $port = $parts[1];
286  }
287  break;
288  }
289 
290  return $proto . '://' . IPUtils::combineHostAndPort( $host, $port, $stdPort );
291  }
292 
300  public static function detectProtocol() {
301  if ( ( !empty( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] !== 'off' ) ||
302  ( isset( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) &&
303  $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https' ) ) {
304  return 'https';
305  } else {
306  return 'http';
307  }
308  }
309 
317  public function getElapsedTime() {
318  return microtime( true ) - $this->requestTime;
319  }
320 
330  public static function getRequestId() {
331  // This method is called from various error handlers and MUST be kept simple and stateless.
332  if ( !self::$reqId ) {
333  global $wgAllowExternalReqID;
334  if ( $wgAllowExternalReqID ) {
335  $id = $_SERVER['HTTP_X_REQUEST_ID'] ?? $_SERVER['UNIQUE_ID'] ?? wfRandomString( 24 );
336  } else {
337  $id = $_SERVER['UNIQUE_ID'] ?? wfRandomString( 24 );
338  }
339  self::$reqId = $id;
340  }
341 
342  return self::$reqId;
343  }
344 
352  public static function overrideRequestId( $id ) {
353  self::$reqId = $id;
354  }
355 
360  public function getProtocol() {
361  if ( $this->protocol === null ) {
362  $this->protocol = self::detectProtocol();
363  }
364  return $this->protocol;
365  }
366 
374  public function interpolateTitle() {
375  // T18019: title interpolation on API queries is useless and sometimes harmful
376  if ( defined( 'MW_API' ) ) {
377  return;
378  }
379 
380  $matches = self::getPathInfo( 'title' );
381  foreach ( $matches as $key => $val ) {
382  $this->data[$key] = $this->queryAndPathParams[$key] = $val;
383  }
384  }
385 
396  public static function extractTitle( $path, $bases, $key = false ) {
397  foreach ( (array)$bases as $keyValue => $base ) {
398  // Find the part after $wgArticlePath
399  $base = str_replace( '$1', '', $base );
400  $baseLen = strlen( $base );
401  if ( substr( $path, 0, $baseLen ) == $base ) {
402  $raw = substr( $path, $baseLen );
403  if ( $raw !== '' ) {
404  $matches = [ 'title' => rawurldecode( $raw ) ];
405  if ( $key ) {
406  $matches[$key] = $keyValue;
407  }
408  return $matches;
409  }
410  }
411  }
412  return [];
413  }
414 
422  public function normalizeUnicode( $data ) {
423  if ( is_array( $data ) ) {
424  foreach ( $data as $key => $val ) {
425  $data[$key] = $this->normalizeUnicode( $val );
426  }
427  } else {
428  $contLang = MediaWikiServices::getInstance()->getContentLanguage();
429  $data = $contLang->normalize( $data );
430  }
431  return $data;
432  }
433 
442  private function getGPCVal( $arr, $name, $default ) {
443  # PHP is so nice to not touch input data, except sometimes:
444  # https://www.php.net/variables.external#language.variables.external.dot-in-names
445  # Work around PHP *feature* to avoid *bugs* elsewhere.
446  $name = strtr( $name, '.', '_' );
447 
448  if ( !isset( $arr[$name] ) ) {
449  return $default;
450  }
451 
452  $data = $arr[$name];
453  # Optimisation: Skip UTF-8 normalization and legacy transcoding for simple ASCII strings.
454  $isAsciiStr = ( is_string( $data ) && preg_match( '/[^\x20-\x7E]/', $data ) === 0 );
455  if ( !$isAsciiStr ) {
456  if ( isset( $_GET[$name] ) && is_string( $data ) ) {
457  # Check for alternate/legacy character encoding.
458  $data = MediaWikiServices::getInstance()
459  ->getContentLanguage()
460  ->checkTitleEncoding( $data );
461  }
462  $data = $this->normalizeUnicode( $data );
463  }
464 
465  return $data;
466  }
467 
480  public function getRawVal( $name, $default = null ) {
481  $name = strtr( $name, '.', '_' ); // See comment in self::getGPCVal()
482  if ( isset( $this->data[$name] ) && !is_array( $this->data[$name] ) ) {
483  $val = $this->data[$name];
484  } else {
485  $val = $default;
486  }
487  if ( $val === null ) {
488  return $val;
489  } else {
490  return (string)$val;
491  }
492  }
493 
504  public function getVal( $name, $default = null ) {
505  $val = $this->getGPCVal( $this->data, $name, $default );
506  if ( is_array( $val ) ) {
507  $val = $default;
508  }
509  if ( $val === null ) {
510  return $val;
511  } else {
512  return (string)$val;
513  }
514  }
515 
523  public function setVal( $key, $value ) {
524  $ret = $this->data[$key] ?? null;
525  $this->data[$key] = $value;
526  return $ret;
527  }
528 
535  public function unsetVal( $key ) {
536  if ( !isset( $this->data[$key] ) ) {
537  $ret = null;
538  } else {
539  $ret = $this->data[$key];
540  unset( $this->data[$key] );
541  }
542  return $ret;
543  }
544 
554  public function getArray( $name, $default = null ) {
555  $val = $this->getGPCVal( $this->data, $name, $default );
556  if ( $val === null ) {
557  return null;
558  } else {
559  return (array)$val;
560  }
561  }
562 
573  public function getIntArray( $name, $default = null ) {
574  $val = $this->getArray( $name, $default );
575  if ( is_array( $val ) ) {
576  $val = array_map( 'intval', $val );
577  }
578  return $val;
579  }
580 
590  public function getInt( $name, $default = 0 ) {
591  return intval( $this->getRawVal( $name, $default ) );
592  }
593 
602  public function getIntOrNull( $name ) {
603  $val = $this->getRawVal( $name );
604  return is_numeric( $val )
605  ? intval( $val )
606  : null;
607  }
608 
619  public function getFloat( $name, $default = 0.0 ) {
620  return floatval( $this->getRawVal( $name, $default ) );
621  }
622 
632  public function getBool( $name, $default = false ) {
633  return (bool)$this->getRawVal( $name, $default );
634  }
635 
645  public function getFuzzyBool( $name, $default = false ) {
646  return $this->getBool( $name, $default )
647  && strcasecmp( $this->getRawVal( $name ), 'false' ) !== 0;
648  }
649 
658  public function getCheck( $name ) {
659  # Checkboxes and buttons are only present when clicked
660  # Presence connotes truth, absence false
661  return $this->getRawVal( $name, null ) !== null;
662  }
663 
674  public function getText( $name, $default = '' ) {
675  $val = $this->getVal( $name, $default );
676  return str_replace( "\r\n", "\n", $val );
677  }
678 
686  public function getValues( ...$names ) {
687  if ( $names === [] ) {
688  $names = array_keys( $this->data );
689  }
690 
691  $retVal = [];
692  foreach ( $names as $name ) {
693  $value = $this->getGPCVal( $this->data, $name, null );
694  if ( $value !== null ) {
695  $retVal[$name] = $value;
696  }
697  }
698  return $retVal;
699  }
700 
707  public function getValueNames( $exclude = [] ) {
708  return array_diff( array_keys( $this->getValues() ), $exclude );
709  }
710 
718  public function getQueryValues() {
720  }
721 
731  public function getQueryValuesOnly() {
732  return $this->queryParams;
733  }
734 
743  public function getPostValues() {
744  return $_POST;
745  }
746 
754  public function getRawQueryString() {
755  return $_SERVER['QUERY_STRING'];
756  }
757 
764  public function getRawPostString() {
765  if ( !$this->wasPosted() ) {
766  return '';
767  }
768  return $this->getRawInput();
769  }
770 
778  public function getRawInput() {
779  static $input = null;
780  if ( $input === null ) {
781  $input = file_get_contents( 'php://input' );
782  }
783  return $input;
784  }
785 
791  public function getMethod() {
792  return $_SERVER['REQUEST_METHOD'] ?? 'GET';
793  }
794 
804  public function wasPosted() {
805  return $this->getMethod() == 'POST';
806  }
807 
818  public function getSession() {
819  if ( $this->sessionId !== null ) {
820  $session = SessionManager::singleton()->getSessionById( (string)$this->sessionId, true, $this );
821  if ( $session ) {
822  return $session;
823  }
824  }
825 
826  $session = SessionManager::singleton()->getSessionForRequest( $this );
827  $this->sessionId = $session->getSessionId();
828  return $session;
829  }
830 
837  public function setSessionId( SessionId $sessionId ) {
838  $this->sessionId = $sessionId;
839  }
840 
847  public function getSessionId() {
848  return $this->sessionId;
849  }
850 
859  public function getCookie( $key, $prefix = null, $default = null ) {
860  if ( $prefix === null ) {
861  global $wgCookiePrefix;
862  $prefix = $wgCookiePrefix;
863  }
864  $name = $prefix . $key;
865  // Work around mangling of $_COOKIE
866  $name = strtr( $name, '.', '_' );
867  if ( isset( $_COOKIE[$name] ) ) {
868  return $_COOKIE[$name];
869  } else {
870  return $default;
871  }
872  }
873 
882  public function getCrossSiteCookie( $key, $prefix = '', $default = null ) {
884  $name = $prefix . $key;
885  // Work around mangling of $_COOKIE
886  $name = strtr( $name, '.', '_' );
887  if ( isset( $_COOKIE[$name] ) ) {
888  return $_COOKIE[$name];
889  }
891  $legacyName = $prefix . "ss0-" . $key;
892  $legacyName = strtr( $legacyName, '.', '_' );
893  if ( isset( $_COOKIE[$legacyName] ) ) {
894  return $_COOKIE[$legacyName];
895  }
896  }
897  return $default;
898  }
899 
907  public static function getGlobalRequestURL() {
908  // This method is called on fatal errors; it should not depend on anything complex.
909 
910  if ( isset( $_SERVER['REQUEST_URI'] ) && strlen( $_SERVER['REQUEST_URI'] ) ) {
911  $base = $_SERVER['REQUEST_URI'];
912  } elseif ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] )
913  && strlen( $_SERVER['HTTP_X_ORIGINAL_URL'] )
914  ) {
915  // Probably IIS; doesn't set REQUEST_URI
916  $base = $_SERVER['HTTP_X_ORIGINAL_URL'];
917  } elseif ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
918  $base = $_SERVER['SCRIPT_NAME'];
919  if ( isset( $_SERVER['QUERY_STRING'] ) && $_SERVER['QUERY_STRING'] != '' ) {
920  $base .= '?' . $_SERVER['QUERY_STRING'];
921  }
922  } else {
923  // This shouldn't happen!
924  throw new MWException( "Web server doesn't provide either " .
925  "REQUEST_URI, HTTP_X_ORIGINAL_URL or SCRIPT_NAME. Report details " .
926  "of your web server configuration to https://phabricator.wikimedia.org/" );
927  }
928  // User-agents should not send a fragment with the URI, but
929  // if they do, and the web server passes it on to us, we
930  // need to strip it or we get false-positive redirect loops
931  // or weird output URLs
932  $hash = strpos( $base, '#' );
933  if ( $hash !== false ) {
934  $base = substr( $base, 0, $hash );
935  }
936 
937  if ( $base[0] == '/' ) {
938  // More than one slash will look like it is protocol relative
939  return preg_replace( '!^/+!', '/', $base );
940  } else {
941  // We may get paths with a host prepended; strip it.
942  return preg_replace( '!^[^:]+://[^/]+/+!', '/', $base );
943  }
944  }
945 
953  public function getRequestURL() {
954  return self::getGlobalRequestURL();
955  }
956 
967  public function getFullRequestURL() {
968  // Pass an explicit PROTO constant instead of PROTO_CURRENT so that we
969  // do not rely on state from the global $wgRequest object (which it would,
970  // via wfGetServerUrl/wfExpandUrl/$wgRequest->protocol).
971  if ( $this->getProtocol() === 'http' ) {
972  return wfGetServerUrl( PROTO_HTTP ) . $this->getRequestURL();
973  } else {
974  return wfGetServerUrl( PROTO_HTTPS ) . $this->getRequestURL();
975  }
976  }
977 
983  public function appendQueryValue( $key, $value ) {
984  return $this->appendQueryArray( [ $key => $value ] );
985  }
986 
993  public function appendQueryArray( $array ) {
994  $newquery = $this->getQueryValues();
995  unset( $newquery['title'] );
996  $newquery = array_merge( $newquery, $array );
997 
998  return wfArrayToCgi( $newquery );
999  }
1000 
1011  public function getLimitOffsetForUser( User $user, $deflimit = 50, $optionname = 'rclimit' ) {
1012  $limit = $this->getInt( 'limit', 0 );
1013  if ( $limit < 0 ) {
1014  $limit = 0;
1015  }
1016  if ( ( $limit == 0 ) && ( $optionname != '' ) ) {
1017  $limit = $user->getIntOption( $optionname );
1018  }
1019  if ( $limit <= 0 ) {
1020  $limit = $deflimit;
1021  }
1022  if ( $limit > 5000 ) {
1023  $limit = 5000; # We have *some* limits...
1024  }
1025 
1026  $offset = $this->getInt( 'offset', 0 );
1027  if ( $offset < 0 ) {
1028  $offset = 0;
1029  }
1030 
1031  return [ $limit, $offset ];
1032  }
1033 
1040  public function getFileTempname( $key ) {
1041  $file = new WebRequestUpload( $this, $key );
1042  return $file->getTempName();
1043  }
1044 
1051  public function getUploadError( $key ) {
1052  $file = new WebRequestUpload( $this, $key );
1053  return $file->getError();
1054  }
1055 
1067  public function getFileName( $key ) {
1068  $file = new WebRequestUpload( $this, $key );
1069  return $file->getName();
1070  }
1071 
1078  public function getUpload( $key ) {
1079  return new WebRequestUpload( $this, $key );
1080  }
1081 
1088  public function response() {
1089  /* Lazy initialization of response object for this request */
1090  if ( !is_object( $this->response ) ) {
1091  $class = ( $this instanceof FauxRequest ) ? FauxResponse::class : WebResponse::class;
1092  $this->response = new $class();
1093  }
1094  return $this->response;
1095  }
1096 
1100  protected function initHeaders() {
1101  if ( count( $this->headers ) ) {
1102  return;
1103  }
1104 
1105  $this->headers = array_change_key_case( getallheaders(), CASE_UPPER );
1106  }
1107 
1113  public function getAllHeaders() {
1114  $this->initHeaders();
1115  return $this->headers;
1116  }
1117 
1130  public function getHeader( $name, $flags = 0 ) {
1131  $this->initHeaders();
1132  $name = strtoupper( $name );
1133  if ( !isset( $this->headers[$name] ) ) {
1134  return false;
1135  }
1136  $value = $this->headers[$name];
1137  if ( $flags & self::GETHEADER_LIST ) {
1138  $value = array_map( 'trim', explode( ',', $value ) );
1139  }
1140  return $value;
1141  }
1142 
1150  public function getSessionData( $key ) {
1151  return $this->getSession()->get( $key );
1152  }
1153 
1159  public function setSessionData( $key, $data ) {
1160  $this->getSession()->set( $key, $data );
1161  }
1162 
1172  public function checkUrlExtension( $extWhitelist = [] ) {
1173  wfDeprecated( __METHOD__, '1.35' );
1174  return true;
1175  }
1176 
1190  public function getAcceptLang() {
1191  // Modified version of code found at
1192  // http://www.thefutureoftheweb.com/blog/use-accept-language-header
1193  $acceptLang = $this->getHeader( 'Accept-Language' );
1194  if ( !$acceptLang ) {
1195  return [];
1196  }
1197 
1198  // Return the language codes in lower case
1199  $acceptLang = strtolower( $acceptLang );
1200 
1201  // Break up string into pieces (languages and q factors)
1202  if ( !preg_match_all(
1203  '/
1204  # a language code or a star is required
1205  ([a-z]{1,8}(?:-[a-z]{1,8})*|\*)
1206  # from here everything is optional
1207  \s*
1208  (?:
1209  # this accepts only numbers in the range ;q=0.000 to ;q=1.000
1210  ;\s*q\s*=\s*
1211  (1(?:\.0{0,3})?|0(?:\.\d{0,3})?)?
1212  )?
1213  /x',
1214  $acceptLang,
1215  $matches,
1216  PREG_SET_ORDER
1217  ) ) {
1218  return [];
1219  }
1220 
1221  // Create a list like "en" => 0.8
1222  $langs = [];
1223  foreach ( $matches as $match ) {
1224  $languageCode = $match[1];
1225  // When not present, the default value is 1
1226  $qValue = (float)( $match[2] ?? 1.0 );
1227  if ( $qValue ) {
1228  $langs[$languageCode] = $qValue;
1229  }
1230  }
1231 
1232  // Sort list by qValue
1233  arsort( $langs, SORT_NUMERIC );
1234  return $langs;
1235  }
1236 
1245  protected function getRawIP() {
1246  if ( !isset( $_SERVER['REMOTE_ADDR'] ) ) {
1247  return null;
1248  }
1249 
1250  if ( is_array( $_SERVER['REMOTE_ADDR'] ) || strpos( $_SERVER['REMOTE_ADDR'], ',' ) !== false ) {
1251  throw new MWException( __METHOD__
1252  . " : Could not determine the remote IP address due to multiple values." );
1253  } else {
1254  $ipchain = $_SERVER['REMOTE_ADDR'];
1255  }
1256 
1257  return IPUtils::canonicalize( $ipchain );
1258  }
1259 
1269  public function getIP() {
1270  global $wgUsePrivateIPs;
1271 
1272  # Return cached result
1273  if ( $this->ip !== null ) {
1274  return $this->ip;
1275  }
1276 
1277  # collect the originating ips
1278  $ip = $this->getRawIP();
1279  if ( !$ip ) {
1280  throw new MWException( 'Unable to determine IP.' );
1281  }
1282 
1283  # Append XFF
1284  $forwardedFor = $this->getHeader( 'X-Forwarded-For' );
1285  if ( $forwardedFor !== false ) {
1286  $proxyLookup = MediaWikiServices::getInstance()->getProxyLookup();
1287  $isConfigured = $proxyLookup->isConfiguredProxy( $ip );
1288  $ipchain = array_map( 'trim', explode( ',', $forwardedFor ) );
1289  $ipchain = array_reverse( $ipchain );
1290  array_unshift( $ipchain, $ip );
1291 
1292  # Step through XFF list and find the last address in the list which is a
1293  # trusted server. Set $ip to the IP address given by that trusted server,
1294  # unless the address is not sensible (e.g. private). However, prefer private
1295  # IP addresses over proxy servers controlled by this site (more sensible).
1296  # Note that some XFF values might be "unknown" with Squid/Varnish.
1297  foreach ( $ipchain as $i => $curIP ) {
1298  $curIP = IPUtils::sanitizeIP(
1299  IPUtils::canonicalize(
1300  self::canonicalizeIPv6LoopbackAddress( $curIP )
1301  )
1302  );
1303  if ( !$curIP || !isset( $ipchain[$i + 1] ) || $ipchain[$i + 1] === 'unknown'
1304  || !$proxyLookup->isTrustedProxy( $curIP )
1305  ) {
1306  break; // IP is not valid/trusted or does not point to anything
1307  }
1308  if (
1309  IPUtils::isPublic( $ipchain[$i + 1] ) ||
1310  $wgUsePrivateIPs ||
1311  $proxyLookup->isConfiguredProxy( $curIP ) // T50919; treat IP as sane
1312  ) {
1313  $nextIP = $ipchain[$i + 1];
1314 
1315  // Follow the next IP according to the proxy
1316  $nextIP = IPUtils::canonicalize(
1317  self::canonicalizeIPv6LoopbackAddress( $nextIP )
1318  );
1319  if ( !$nextIP && $isConfigured ) {
1320  // We have not yet made it past CDN/proxy servers of this site,
1321  // so either they are misconfigured or there is some IP spoofing.
1322  throw new MWException( "Invalid IP given in XFF '$forwardedFor'." );
1323  }
1324  $ip = $nextIP;
1325 
1326  // keep traversing the chain
1327  continue;
1328  }
1329  break;
1330  }
1331  }
1332 
1333  # Allow extensions to improve our guess
1334  Hooks::runner()->onGetIP( $ip );
1335 
1336  if ( !$ip ) {
1337  throw new MWException( "Unable to determine IP." );
1338  }
1339 
1340  $this->ip = $ip;
1341  return $ip;
1342  }
1343 
1352  public static function canonicalizeIPv6LoopbackAddress( $ip ) {
1353  // Code moved from IPUtils library. See T248237#6614927
1354  $m = [];
1355  if ( preg_match( '/^0*' . IPUtils::RE_IPV6_GAP . '1$/', $ip, $m ) ) {
1356  return '127.0.0.1';
1357  }
1358  return $ip;
1359  }
1360 
1366  public function setIP( $ip ) {
1367  $this->ip = $ip;
1368  }
1369 
1382  public function hasSafeMethod() {
1383  if ( !isset( $_SERVER['REQUEST_METHOD'] ) ) {
1384  return false; // CLI mode
1385  }
1386 
1387  return in_array( $_SERVER['REQUEST_METHOD'], [ 'GET', 'HEAD', 'OPTIONS', 'TRACE' ] );
1388  }
1389 
1408  public function isSafeRequest() {
1409  if ( $this->markedAsSafe && $this->wasPosted() ) {
1410  return true; // marked as a "safe" POST
1411  }
1412 
1413  return $this->hasSafeMethod();
1414  }
1415 
1426  public function markAsSafeRequest() {
1427  $this->markedAsSafe = true;
1428  }
1429 }
PathRouter\add
add( $path, $params=[], $options=[])
Add a new path pattern to the path router.
Definition: PathRouter.php:158
WebRequest\initHeaders
initHeaders()
Initialise the header list.
Definition: WebRequest.php:1100
WebRequest\$sessionId
SessionId null $sessionId
Session ID to use for this request.
Definition: WebRequest.php:112
WebRequest\$headers
string[] $headers
Lazy-initialized request headers indexed by upper-case header name.
Definition: WebRequest.php:66
FauxRequest
WebRequest clone which takes values from a provided array.
Definition: FauxRequest.php:35
WebRequest\getSessionData
getSessionData( $key)
Get data from the session.
Definition: WebRequest.php:1150
WebRequest\getValueNames
getValueNames( $exclude=[])
Returns the names of all input values excluding those in $exclude.
Definition: WebRequest.php:707
PROTO_HTTPS
const PROTO_HTTPS
Definition: Defines.php:204
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:173
WebRequest\$data
array $data
The parameters from $_GET, $_POST and the path router.
Definition: WebRequest.php:47
WebRequest\getRequestPathSuffix
static getRequestPathSuffix( $basePath)
If the request URL matches a given base path, extract the path part of the request URL after that bas...
Definition: WebRequest.php:233
WebRequest\getSessionId
getSessionId()
Get the session id for this request, if any.
Definition: WebRequest.php:847
$wgScript
$wgScript
The URL path to index.php.
Definition: DefaultSettings.php:204
User\getIntOption
getIntOption( $oname, $defaultOverride=0)
Get the user's current setting for a given option, as an integer value.
Definition: User.php:2708
WebRequest\appendQueryValue
appendQueryValue( $key, $value)
Definition: WebRequest.php:983
WebRequest\interpolateTitle
interpolateTitle()
Check for title, action, and/or variant data in the URL and interpolate it into the GET variables.
Definition: WebRequest.php:374
WebRequest\setSessionId
setSessionId(SessionId $sessionId)
Set the session for this request.
Definition: WebRequest.php:837
WebRequest\getAcceptLang
getAcceptLang()
Parse the Accept-Language header sent by the client into an array.
Definition: WebRequest.php:1190
WebRequest\getElapsedTime
getElapsedTime()
Get the number of seconds to have elapsed since request start, in fractional seconds,...
Definition: WebRequest.php:317
RE_IPV6_GAP
const RE_IPV6_GAP
For IPv6 canonicalization (NOT for strict validation; these are quite lax!)
Definition: IP.php:64
WebRequest\getIntOrNull
getIntOrNull( $name)
Fetch an integer value from the input or return null if empty.
Definition: WebRequest.php:602
$file
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42
WebRequest\getRawPostString
getRawPostString()
Return the contents of the POST with no decoding.
Definition: WebRequest.php:764
WebRequest\detectProtocol
static detectProtocol()
Detect the protocol from $_SERVER.
Definition: WebRequest.php:300
WebRequest\getGPCVal
getGPCVal( $arr, $name, $default)
Fetch a value from the given array or return $default if it's not set.
Definition: WebRequest.php:442
$wgUseSameSiteLegacyCookies
bool $wgUseSameSiteLegacyCookies
If true, when a cross-site cookie with SameSite=None is sent, a legacy cookie with an "ss0" prefix wi...
Definition: DefaultSettings.php:6615
WebRequest\hasSafeMethod
hasSafeMethod()
Check if this request uses a "safe" HTTP method.
Definition: WebRequest.php:1382
$base
$base
Definition: generateLocalAutoload.php:11
WebRequest\$queryAndPathParams
string[] $queryAndPathParams
The parameters from $_GET.
Definition: WebRequest.php:54
WebRequest\__construct
__construct()
Definition: WebRequest.php:120
WebRequest\getRawQueryString
getRawQueryString()
Return the contents of the Query with no decoding.
Definition: WebRequest.php:754
WebRequest\appendQueryArray
appendQueryArray( $array)
Appends or replaces value of query variables.
Definition: WebRequest.php:993
$wgAllowExternalReqID
$wgAllowExternalReqID
Whether to respect/honour the request ID provided by the incoming request via the X-Request-Id header...
Definition: DefaultSettings.php:9034
PathRouter\getActionPaths
static getActionPaths(array $actionPaths, $articlePath)
Definition: PathRouter.php:430
WebRequest\getFileTempname
getFileTempname( $key)
Return the path to the temporary file where PHP has stored the upload.
Definition: WebRequest.php:1040
$wgAssumeProxiesUseDefaultProtocolPorts
bool $wgAssumeProxiesUseDefaultProtocolPorts
When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes the w...
Definition: DefaultSettings.php:132
WebRequest\isSafeRequest
isSafeRequest()
Whether this request should be identified as being "safe".
Definition: WebRequest.php:1408
WebRequest\getText
getText( $name, $default='')
Fetch a text string from the given array or return $default if it's not set.
Definition: WebRequest.php:674
WebRequest\$protocol
string $protocol
Cached URL protocol.
Definition: WebRequest.php:102
WebRequest\canonicalizeIPv6LoopbackAddress
static canonicalizeIPv6LoopbackAddress( $ip)
Converts ::1 (IPv6 loopback address) to 127.0.0.1 (IPv4 loopback address); assists in matching truste...
Definition: WebRequest.php:1352
WebRequest\getMethod
getMethod()
Get the HTTP method used for this request.
Definition: WebRequest.php:791
MWException
MediaWiki exception.
Definition: MWException.php:29
WebRequest\getFileName
getFileName( $key)
Return the original filename of the uploaded file, as reported by the submitting user agent.
Definition: WebRequest.php:1067
WebRequest\getQueryValuesOnly
getQueryValuesOnly()
Get the values passed in the query string only, not including the path router parameters.
Definition: WebRequest.php:731
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Logs a warning that $function is deprecated.
Definition: GlobalFunctions.php:1034
MediaWiki\Session\Session
Manages data for an authenticated session.
Definition: Session.php:48
WebRequest\setVal
setVal( $key, $value)
Set an arbitrary value into our get/post data.
Definition: WebRequest.php:523
WebRequest\$reqId
static string $reqId
The unique request ID.
Definition: WebRequest.php:78
$matches
$matches
Definition: NoLocalSettings.php:24
WebRequest\getRawInput
getRawInput()
Return the raw request body, with no processing.
Definition: WebRequest.php:778
WebRequest\getUpload
getUpload( $key)
Return a WebRequestUpload object corresponding to the key.
Definition: WebRequest.php:1078
WebRequest\$queryParams
string[] $queryParams
The parameters from $_GET only.
Definition: WebRequest.php:60
WebRequest\getPathInfo
static getPathInfo( $want='all')
Extract relevant query arguments from the http request uri's path to be merged with the normal php pr...
Definition: WebRequest.php:150
WebRequest\getFullRequestURL
getFullRequestURL()
Return the request URI with the canonical service and hostname, path, and query string.
Definition: WebRequest.php:967
WebRequest\getArray
getArray( $name, $default=null)
Fetch an array from the input or return $default if it's not set.
Definition: WebRequest.php:554
WebRequest\$response
WebResponse $response
Lazy-init response object.
Definition: WebRequest.php:84
WebRequest\markAsSafeRequest
markAsSafeRequest()
Mark this request as identified as being nullipotent even if it is a POST request.
Definition: WebRequest.php:1426
WebRequest\getAllHeaders
getAllHeaders()
Get an array containing all request headers.
Definition: WebRequest.php:1113
WebRequestUpload
Object to access the $_FILES array.
Definition: WebRequestUpload.php:33
WebRequest\normalizeUnicode
normalizeUnicode( $data)
Recursively normalizes UTF-8 strings in the given array.
Definition: WebRequest.php:422
WebRequest\getRawVal
getRawVal( $name, $default=null)
Fetch a scalar from the input without normalization, or return $default if it's not set.
Definition: WebRequest.php:480
WebRequest\getCheck
getCheck( $name)
Return true if the named value is set in the input, whatever that value is (even "0").
Definition: WebRequest.php:658
WebRequest\getProtocol
getProtocol()
Get the current URL protocol (http or https)
Definition: WebRequest.php:360
WebRequest\setIP
setIP( $ip)
Definition: WebRequest.php:1366
WebRequest\getSession
getSession()
Return the session for this request.
Definition: WebRequest.php:818
WebRequest\response
response()
Return a handle to WebResponse style object, for setting cookies, headers and other stuff,...
Definition: WebRequest.php:1088
$wgUsePrivateIPs
$wgUsePrivateIPs
Should forwarded Private IPs be accepted?
Definition: DefaultSettings.php:3172
MediaWiki\Session\SessionManager
This serves as the entry point to the MediaWiki session handling system.
Definition: SessionManager.php:53
Hooks\runner
static runner()
Get a HookRunner instance for calling hooks using the new interfaces.
Definition: Hooks.php:172
WebRequest\getCrossSiteCookie
getCrossSiteCookie( $key, $prefix='', $default=null)
Get a cookie set with SameSite=None possibly with a legacy fallback cookie.
Definition: WebRequest.php:882
WebRequest\checkUrlExtension
checkUrlExtension( $extWhitelist=[])
This function formerly did a security check to prevent an XSS vulnerability in IE6,...
Definition: WebRequest.php:1172
WebRequest\getIntArray
getIntArray( $name, $default=null)
Fetch an array of integers, or return $default if it's not set.
Definition: WebRequest.php:573
WebRequest\$requestTime
float $requestTime
The timestamp of the start of the request, with microsecond precision.
Definition: WebRequest.php:96
WebRequest\getValues
getValues(... $names)
Extracts the (given) named values into an array.
Definition: WebRequest.php:686
WebRequest\$markedAsSafe
bool $markedAsSafe
Whether this HTTP request is "safe" (even if it is an HTTP post)
Definition: WebRequest.php:115
WebRequest\getCookie
getCookie( $key, $prefix=null, $default=null)
Get a cookie from the $_COOKIE jar.
Definition: WebRequest.php:859
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition: WebRequest.php:42
WebRequest\getIP
getIP()
Work out the IP address based on various globals For trusted proxies, use the XFF client IP (first of...
Definition: WebRequest.php:1269
WebRequest\getUploadError
getUploadError( $key)
Return the upload error or 0.
Definition: WebRequest.php:1051
$wgArticlePath
$wgArticlePath
The URL path for primary article page views.
Definition: DefaultSettings.php:264
WebRequest\setSessionData
setSessionData( $key, $data)
Definition: WebRequest.php:1159
$wgActionPaths
$wgActionPaths
To set 'pretty' URL paths for actions other than plain page views, add to this array.
Definition: DefaultSettings.php:488
WebRequest\GETHEADER_LIST
const GETHEADER_LIST
Flag to make WebRequest::getHeader return an array of values.
Definition: WebRequest.php:72
WebRequest\getVal
getVal( $name, $default=null)
Fetch a scalar from the input or return $default if it's not set.
Definition: WebRequest.php:504
WebRequest\getInt
getInt( $name, $default=0)
Fetch an integer value from the input or return $default if not set.
Definition: WebRequest.php:590
MediaWiki\Session\SessionId
Value object holding the session ID in a manner that can be globally updated.
Definition: SessionId.php:40
WebRequest\getRequestId
static getRequestId()
Get the current request ID.
Definition: WebRequest.php:330
WebRequest\getLimitOffsetForUser
getLimitOffsetForUser(User $user, $deflimit=50, $optionname='rclimit')
Check for limit and offset parameters on the input, and return sensible defaults if not given.
Definition: WebRequest.php:1011
$path
$path
Definition: NoLocalSettings.php:25
WebRequest\getFloat
getFloat( $name, $default=0.0)
Fetch a floating point value from the input or return $default if not set.
Definition: WebRequest.php:619
WebRequest\detectServer
static detectServer()
Work out an appropriate URL prefix containing scheme and host, based on information detected from $_S...
Definition: WebRequest.php:254
WebRequest\getHeader
getHeader( $name, $flags=0)
Get a request header, or false if it isn't set.
Definition: WebRequest.php:1130
WebRequest\getGlobalRequestURL
static getGlobalRequestURL()
Return the path and query string portion of the main request URI.
Definition: WebRequest.php:907
WebRequest\$ip
string $ip
Cached client IP address.
Definition: WebRequest.php:90
WebRequest\getPostValues
getPostValues()
Get the values passed via POST.
Definition: WebRequest.php:743
WebRequest\wasPosted
wasPosted()
Returns true if the present request was reached by a POST operation, false otherwise (GET,...
Definition: WebRequest.php:804
WebRequest\unsetVal
unsetVal( $key)
Unset an arbitrary value from our get/post data.
Definition: WebRequest.php:535
wfGetServerUrl
wfGetServerUrl( $proto)
Get the wiki's "server", i.e.
Definition: GlobalFunctions.php:573
WebRequest\getRequestURL
getRequestURL()
Return the path and query string portion of the request URI.
Definition: WebRequest.php:953
WebRequest\overrideRequestId
static overrideRequestId( $id)
Override the unique request ID.
Definition: WebRequest.php:352
WebRequest\extractTitle
static extractTitle( $path, $bases, $key=false)
URL rewriting function; tries to extract page title and, optionally, one other fixed parameter value ...
Definition: WebRequest.php:396
WebResponse
Allow programs to request this object from WebRequest::response() and handle all outputting (or lack ...
Definition: WebResponse.php:30
WebRequest\getRawIP
getRawIP()
Fetch the raw IP from the request.
Definition: WebRequest.php:1245
WebRequest\getQueryValues
getQueryValues()
Get the values passed in the query string and the path router parameters.
Definition: WebRequest.php:718
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:66
WebRequest\getFuzzyBool
getFuzzyBool( $name, $default=false)
Fetch a boolean value from the input or return $default if not set.
Definition: WebRequest.php:645
$wgVariantArticlePath
$wgVariantArticlePath
Like $wgArticlePath, but on multi-variant wikis, this provides a path format that describes which par...
Definition: DefaultSettings.php:3391
PathRouter
PathRouter class.
Definition: PathRouter.php:73
$wgCookiePrefix
$wgCookiePrefix
Cookies generated by MediaWiki have names starting with this prefix.
Definition: DefaultSettings.php:6586
WebRequest\getBool
getBool( $name, $default=false)
Fetch a boolean value from the input or return $default if not set.
Definition: WebRequest.php:632
PROTO_HTTP
const PROTO_HTTP
Definition: Defines.php:203
$wgUsePathInfo
$wgUsePathInfo
Whether to support URLs like index.php/Page_title These often break when PHP is set up in CGI mode.
Definition: DefaultSettings.php:195
wfArrayToCgi
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
Definition: GlobalFunctions.php:351
wfRandomString
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
Definition: GlobalFunctions.php:278