MediaWiki  1.34.0
GlobalFunctions.php
Go to the documentation of this file.
1 <?php
23 if ( !defined( 'MEDIAWIKI' ) ) {
24  die( "This file is part of MediaWiki, it is not a valid entry point" );
25 }
26 
34 use Wikimedia\AtEase\AtEase;
35 use Wikimedia\WrappedString;
36 
47 function wfLoadExtension( $ext, $path = null ) {
48  if ( !$path ) {
49  global $wgExtensionDirectory;
50  $path = "$wgExtensionDirectory/$ext/extension.json";
51  }
53 }
54 
68 function wfLoadExtensions( array $exts ) {
69  global $wgExtensionDirectory;
70  $registry = ExtensionRegistry::getInstance();
71  foreach ( $exts as $ext ) {
72  $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
73  }
74 }
75 
84 function wfLoadSkin( $skin, $path = null ) {
85  if ( !$path ) {
86  global $wgStyleDirectory;
87  $path = "$wgStyleDirectory/$skin/skin.json";
88  }
90 }
91 
99 function wfLoadSkins( array $skins ) {
100  global $wgStyleDirectory;
101  $registry = ExtensionRegistry::getInstance();
102  foreach ( $skins as $skin ) {
103  $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
104  }
105 }
106 
113 function wfArrayDiff2( $a, $b ) {
114  return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
115 }
116 
122 function wfArrayDiff2_cmp( $a, $b ) {
123  if ( is_string( $a ) && is_string( $b ) ) {
124  return strcmp( $a, $b );
125  } elseif ( count( $a ) !== count( $b ) ) {
126  return count( $a ) <=> count( $b );
127  } else {
128  reset( $a );
129  reset( $b );
130  while ( key( $a ) !== null && key( $b ) !== null ) {
131  $valueA = current( $a );
132  $valueB = current( $b );
133  $cmp = strcmp( $valueA, $valueB );
134  if ( $cmp !== 0 ) {
135  return $cmp;
136  }
137  next( $a );
138  next( $b );
139  }
140  return 0;
141  }
142 }
143 
153 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
154  if ( is_null( $changed ) ) {
155  throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
156  }
157  if ( $default[$key] !== $value ) {
158  $changed[$key] = $value;
159  }
160 }
161 
181 function wfMergeErrorArrays( ...$args ) {
182  $out = [];
183  foreach ( $args as $errors ) {
184  foreach ( $errors as $params ) {
185  $originalParams = $params;
186  if ( $params[0] instanceof MessageSpecifier ) {
187  $msg = $params[0];
188  $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
189  }
190  # @todo FIXME: Sometimes get nested arrays for $params,
191  # which leads to E_NOTICEs
192  $spec = implode( "\t", $params );
193  $out[$spec] = $originalParams;
194  }
195  }
196  return array_values( $out );
197 }
198 
207 function wfArrayInsertAfter( array $array, array $insert, $after ) {
208  // Find the offset of the element to insert after.
209  $keys = array_keys( $array );
210  $offsetByKey = array_flip( $keys );
211 
212  $offset = $offsetByKey[$after];
213 
214  // Insert at the specified offset
215  $before = array_slice( $array, 0, $offset + 1, true );
216  $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
217 
218  $output = $before + $insert + $after;
219 
220  return $output;
221 }
222 
230 function wfObjectToArray( $objOrArray, $recursive = true ) {
231  $array = [];
232  if ( is_object( $objOrArray ) ) {
233  $objOrArray = get_object_vars( $objOrArray );
234  }
235  foreach ( $objOrArray as $key => $value ) {
236  if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
237  $value = wfObjectToArray( $value );
238  }
239 
240  $array[$key] = $value;
241  }
242 
243  return $array;
244 }
245 
256 function wfRandom() {
257  // The maximum random value is "only" 2^31-1, so get two random
258  // values to reduce the chance of dupes
259  $max = mt_getrandmax() + 1;
260  $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
261  return $rand;
262 }
263 
274 function wfRandomString( $length = 32 ) {
275  $str = '';
276  for ( $n = 0; $n < $length; $n += 7 ) {
277  $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
278  }
279  return substr( $str, 0, $length );
280 }
281 
309 function wfUrlencode( $s ) {
310  static $needle;
311 
312  if ( is_null( $s ) ) {
313  // Reset $needle for testing.
314  $needle = null;
315  return '';
316  }
317 
318  if ( is_null( $needle ) ) {
319  $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
320  if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
321  ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
322  ) {
323  $needle[] = '%3A';
324  }
325  }
326 
327  $s = urlencode( $s );
328  $s = str_ireplace(
329  $needle,
330  [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
331  $s
332  );
333 
334  return $s;
335 }
336 
347 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
348  if ( !is_null( $array2 ) ) {
349  $array1 = $array1 + $array2;
350  }
351 
352  $cgi = '';
353  foreach ( $array1 as $key => $value ) {
354  if ( !is_null( $value ) && $value !== false ) {
355  if ( $cgi != '' ) {
356  $cgi .= '&';
357  }
358  if ( $prefix !== '' ) {
359  $key = $prefix . "[$key]";
360  }
361  if ( is_array( $value ) ) {
362  $firstTime = true;
363  foreach ( $value as $k => $v ) {
364  $cgi .= $firstTime ? '' : '&';
365  if ( is_array( $v ) ) {
366  $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
367  } else {
368  $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
369  }
370  $firstTime = false;
371  }
372  } else {
373  if ( is_object( $value ) ) {
374  $value = $value->__toString();
375  }
376  $cgi .= urlencode( $key ) . '=' . urlencode( $value );
377  }
378  }
379  }
380  return $cgi;
381 }
382 
392 function wfCgiToArray( $query ) {
393  if ( isset( $query[0] ) && $query[0] == '?' ) {
394  $query = substr( $query, 1 );
395  }
396  $bits = explode( '&', $query );
397  $ret = [];
398  foreach ( $bits as $bit ) {
399  if ( $bit === '' ) {
400  continue;
401  }
402  if ( strpos( $bit, '=' ) === false ) {
403  // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
404  $key = $bit;
405  $value = '';
406  } else {
407  list( $key, $value ) = explode( '=', $bit );
408  }
409  $key = urldecode( $key );
410  $value = urldecode( $value );
411  if ( strpos( $key, '[' ) !== false ) {
412  $keys = array_reverse( explode( '[', $key ) );
413  $key = array_pop( $keys );
414  $temp = $value;
415  foreach ( $keys as $k ) {
416  $k = substr( $k, 0, -1 );
417  $temp = [ $k => $temp ];
418  }
419  if ( isset( $ret[$key] ) ) {
420  $ret[$key] = array_merge( $ret[$key], $temp );
421  } else {
422  $ret[$key] = $temp;
423  }
424  } else {
425  $ret[$key] = $value;
426  }
427  }
428  return $ret;
429 }
430 
439 function wfAppendQuery( $url, $query ) {
440  if ( is_array( $query ) ) {
441  $query = wfArrayToCgi( $query );
442  }
443  if ( $query != '' ) {
444  // Remove the fragment, if there is one
445  $fragment = false;
446  $hashPos = strpos( $url, '#' );
447  if ( $hashPos !== false ) {
448  $fragment = substr( $url, $hashPos );
449  $url = substr( $url, 0, $hashPos );
450  }
451 
452  // Add parameter
453  if ( strpos( $url, '?' ) === false ) {
454  $url .= '?';
455  } else {
456  $url .= '&';
457  }
458  $url .= $query;
459 
460  // Put the fragment back
461  if ( $fragment !== false ) {
462  $url .= $fragment;
463  }
464  }
465  return $url;
466 }
467 
491 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
493  $wgHttpsPort;
494  if ( $defaultProto === PROTO_CANONICAL ) {
495  $serverUrl = $wgCanonicalServer;
496  } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
497  // Make $wgInternalServer fall back to $wgServer if not set
498  $serverUrl = $wgInternalServer;
499  } else {
500  $serverUrl = $wgServer;
501  if ( $defaultProto === PROTO_CURRENT ) {
502  $defaultProto = $wgRequest->getProtocol() . '://';
503  }
504  }
505 
506  // Analyze $serverUrl to obtain its protocol
507  $bits = wfParseUrl( $serverUrl );
508  $serverHasProto = $bits && $bits['scheme'] != '';
509 
510  if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
511  if ( $serverHasProto ) {
512  $defaultProto = $bits['scheme'] . '://';
513  } else {
514  // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
515  // This really isn't supposed to happen. Fall back to HTTP in this
516  // ridiculous case.
517  $defaultProto = PROTO_HTTP;
518  }
519  }
520 
521  $defaultProtoWithoutSlashes = $defaultProto !== null ? substr( $defaultProto, 0, -2 ) : '';
522 
523  if ( substr( $url, 0, 2 ) == '//' ) {
524  $url = $defaultProtoWithoutSlashes . $url;
525  } elseif ( substr( $url, 0, 1 ) == '/' ) {
526  // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
527  // otherwise leave it alone.
528  if ( $serverHasProto ) {
529  $url = $serverUrl . $url;
530  } else {
531  // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
532  // user to override the port number (T67184)
533  if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
534  if ( isset( $bits['port'] ) ) {
535  throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
536  }
537  $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
538  } else {
539  $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
540  }
541  }
542  }
543 
544  $bits = wfParseUrl( $url );
545 
546  if ( $bits && isset( $bits['path'] ) ) {
547  $bits['path'] = wfRemoveDotSegments( $bits['path'] );
548  return wfAssembleUrl( $bits );
549  } elseif ( $bits ) {
550  # No path to expand
551  return $url;
552  } elseif ( substr( $url, 0, 1 ) != '/' ) {
553  # URL is a relative path
554  return wfRemoveDotSegments( $url );
555  }
556 
557  # Expanded URL is not valid.
558  return false;
559 }
560 
569 function wfGetServerUrl( $proto ) {
570  $url = wfExpandUrl( '/', $proto );
571  return substr( $url, 0, -1 );
572 }
573 
587 function wfAssembleUrl( $urlParts ) {
588  $result = '';
589 
590  if ( isset( $urlParts['delimiter'] ) ) {
591  if ( isset( $urlParts['scheme'] ) ) {
592  $result .= $urlParts['scheme'];
593  }
594 
595  $result .= $urlParts['delimiter'];
596  }
597 
598  if ( isset( $urlParts['host'] ) ) {
599  if ( isset( $urlParts['user'] ) ) {
600  $result .= $urlParts['user'];
601  if ( isset( $urlParts['pass'] ) ) {
602  $result .= ':' . $urlParts['pass'];
603  }
604  $result .= '@';
605  }
606 
607  $result .= $urlParts['host'];
608 
609  if ( isset( $urlParts['port'] ) ) {
610  $result .= ':' . $urlParts['port'];
611  }
612  }
613 
614  if ( isset( $urlParts['path'] ) ) {
615  $result .= $urlParts['path'];
616  }
617 
618  if ( isset( $urlParts['query'] ) ) {
619  $result .= '?' . $urlParts['query'];
620  }
621 
622  if ( isset( $urlParts['fragment'] ) ) {
623  $result .= '#' . $urlParts['fragment'];
624  }
625 
626  return $result;
627 }
628 
641 function wfRemoveDotSegments( $urlPath ) {
642  $output = '';
643  $inputOffset = 0;
644  $inputLength = strlen( $urlPath );
645 
646  while ( $inputOffset < $inputLength ) {
647  $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
648  $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
649  $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
650  $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
651  $trimOutput = false;
652 
653  if ( $prefixLengthTwo == './' ) {
654  # Step A, remove leading "./"
655  $inputOffset += 2;
656  } elseif ( $prefixLengthThree == '../' ) {
657  # Step A, remove leading "../"
658  $inputOffset += 3;
659  } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
660  # Step B, replace leading "/.$" with "/"
661  $inputOffset += 1;
662  $urlPath[$inputOffset] = '/';
663  } elseif ( $prefixLengthThree == '/./' ) {
664  # Step B, replace leading "/./" with "/"
665  $inputOffset += 2;
666  } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
667  # Step C, replace leading "/..$" with "/" and
668  # remove last path component in output
669  $inputOffset += 2;
670  $urlPath[$inputOffset] = '/';
671  $trimOutput = true;
672  } elseif ( $prefixLengthFour == '/../' ) {
673  # Step C, replace leading "/../" with "/" and
674  # remove last path component in output
675  $inputOffset += 3;
676  $trimOutput = true;
677  } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
678  # Step D, remove "^.$"
679  $inputOffset += 1;
680  } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
681  # Step D, remove "^..$"
682  $inputOffset += 2;
683  } else {
684  # Step E, move leading path segment to output
685  if ( $prefixLengthOne == '/' ) {
686  $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
687  } else {
688  $slashPos = strpos( $urlPath, '/', $inputOffset );
689  }
690  if ( $slashPos === false ) {
691  $output .= substr( $urlPath, $inputOffset );
692  $inputOffset = $inputLength;
693  } else {
694  $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
695  $inputOffset += $slashPos - $inputOffset;
696  }
697  }
698 
699  if ( $trimOutput ) {
700  $slashPos = strrpos( $output, '/' );
701  if ( $slashPos === false ) {
702  $output = '';
703  } else {
704  $output = substr( $output, 0, $slashPos );
705  }
706  }
707  }
708 
709  return $output;
710 }
711 
719 function wfUrlProtocols( $includeProtocolRelative = true ) {
720  global $wgUrlProtocols;
721 
722  // Cache return values separately based on $includeProtocolRelative
723  static $withProtRel = null, $withoutProtRel = null;
724  $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
725  if ( !is_null( $cachedValue ) ) {
726  return $cachedValue;
727  }
728 
729  // Support old-style $wgUrlProtocols strings, for backwards compatibility
730  // with LocalSettings files from 1.5
731  if ( is_array( $wgUrlProtocols ) ) {
732  $protocols = [];
733  foreach ( $wgUrlProtocols as $protocol ) {
734  // Filter out '//' if !$includeProtocolRelative
735  if ( $includeProtocolRelative || $protocol !== '//' ) {
736  $protocols[] = preg_quote( $protocol, '/' );
737  }
738  }
739 
740  $retval = implode( '|', $protocols );
741  } else {
742  // Ignore $includeProtocolRelative in this case
743  // This case exists for pre-1.6 compatibility, and we can safely assume
744  // that '//' won't appear in a pre-1.6 config because protocol-relative
745  // URLs weren't supported until 1.18
746  $retval = $wgUrlProtocols;
747  }
748 
749  // Cache return value
750  if ( $includeProtocolRelative ) {
751  $withProtRel = $retval;
752  } else {
753  $withoutProtRel = $retval;
754  }
755  return $retval;
756 }
757 
765  return wfUrlProtocols( false );
766 }
767 
793 function wfParseUrl( $url ) {
794  global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
795 
796  // Protocol-relative URLs are handled really badly by parse_url(). It's so
797  // bad that the easiest way to handle them is to just prepend 'http:' and
798  // strip the protocol out later.
799  $wasRelative = substr( $url, 0, 2 ) == '//';
800  if ( $wasRelative ) {
801  $url = "http:$url";
802  }
803  AtEase::suppressWarnings();
804  $bits = parse_url( $url );
805  AtEase::restoreWarnings();
806  // parse_url() returns an array without scheme for some invalid URLs, e.g.
807  // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
808  if ( !$bits || !isset( $bits['scheme'] ) ) {
809  return false;
810  }
811 
812  // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
813  $bits['scheme'] = strtolower( $bits['scheme'] );
814 
815  // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
816  if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
817  $bits['delimiter'] = '://';
818  } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
819  $bits['delimiter'] = ':';
820  // parse_url detects for news: and mailto: the host part of an url as path
821  // We have to correct this wrong detection
822  if ( isset( $bits['path'] ) ) {
823  $bits['host'] = $bits['path'];
824  $bits['path'] = '';
825  }
826  } else {
827  return false;
828  }
829 
830  /* Provide an empty host for eg. file:/// urls (see T30627) */
831  if ( !isset( $bits['host'] ) ) {
832  $bits['host'] = '';
833 
834  // See T47069
835  if ( isset( $bits['path'] ) ) {
836  /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
837  if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
838  $bits['path'] = '/' . $bits['path'];
839  }
840  } else {
841  $bits['path'] = '';
842  }
843  }
844 
845  // If the URL was protocol-relative, fix scheme and delimiter
846  if ( $wasRelative ) {
847  $bits['scheme'] = '';
848  $bits['delimiter'] = '//';
849  }
850  return $bits;
851 }
852 
863 function wfExpandIRI( $url ) {
864  return preg_replace_callback(
865  '/((?:%[89A-F][0-9A-F])+)/i',
866  function ( array $matches ) {
867  return urldecode( $matches[1] );
868  },
869  wfExpandUrl( $url )
870  );
871 }
872 
879 function wfMatchesDomainList( $url, $domains ) {
880  $bits = wfParseUrl( $url );
881  if ( is_array( $bits ) && isset( $bits['host'] ) ) {
882  $host = '.' . $bits['host'];
883  foreach ( (array)$domains as $domain ) {
884  $domain = '.' . $domain;
885  if ( substr( $host, -strlen( $domain ) ) === $domain ) {
886  return true;
887  }
888  }
889  }
890  return false;
891 }
892 
913 function wfDebug( $text, $dest = 'all', array $context = [] ) {
915  global $wgDebugTimestamps;
916 
917  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
918  return;
919  }
920 
921  $text = trim( $text );
922 
923  if ( $wgDebugTimestamps ) {
924  $context['seconds_elapsed'] = sprintf(
925  '%6.4f',
926  microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
927  );
928  $context['memory_used'] = sprintf(
929  '%5.1fM',
930  ( memory_get_usage( true ) / ( 1024 * 1024 ) )
931  );
932  }
933 
934  if ( $wgDebugLogPrefix !== '' ) {
935  $context['prefix'] = $wgDebugLogPrefix;
936  }
937  $context['private'] = ( $dest === false || $dest === 'private' );
938 
939  $logger = LoggerFactory::getInstance( 'wfDebug' );
940  $logger->debug( $text, $context );
941 }
942 
947 function wfIsDebugRawPage() {
948  static $cache;
949  if ( $cache !== null ) {
950  return $cache;
951  }
952  // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
953  // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
954  if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
955  || (
956  isset( $_SERVER['SCRIPT_NAME'] )
957  && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
958  )
959  ) {
960  $cache = true;
961  } else {
962  $cache = false;
963  }
964  return $cache;
965 }
966 
972 function wfDebugMem( $exact = false ) {
973  $mem = memory_get_usage();
974  if ( !$exact ) {
975  $mem = floor( $mem / 1024 ) . ' KiB';
976  } else {
977  $mem .= ' B';
978  }
979  wfDebug( "Memory usage: $mem\n" );
980 }
981 
1007 function wfDebugLog(
1008  $logGroup, $text, $dest = 'all', array $context = []
1009 ) {
1010  $text = trim( $text );
1011 
1012  $logger = LoggerFactory::getInstance( $logGroup );
1013  $context['private'] = ( $dest === false || $dest === 'private' );
1014  $logger->info( $text, $context );
1015 }
1016 
1025 function wfLogDBError( $text, array $context = [] ) {
1026  $logger = LoggerFactory::getInstance( 'wfLogDBError' );
1027  $logger->error( trim( $text ), $context );
1028 }
1029 
1044 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1045  if ( is_string( $version ) || is_bool( $version ) ) {
1046  MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1047  } else {
1048  throw new Exception(
1049  "MediaWiki version must either be a string or a boolean. " .
1050  "Example valid version: '1.33'"
1051  );
1052  }
1053 }
1054 
1065 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1066  MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1067 }
1068 
1078 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1079  MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1080 }
1081 
1088 
1090  $request = $context->getRequest();
1091 
1092  $profiler = Profiler::instance();
1093  $profiler->setContext( $context );
1094  $profiler->logData();
1095 
1096  // Send out any buffered statsd metrics as needed
1098  MediaWikiServices::getInstance()->getStatsdDataFactory(),
1099  $context->getConfig()
1100  );
1101 
1102  // Profiling must actually be enabled...
1103  if ( $profiler instanceof ProfilerStub ) {
1104  return;
1105  }
1106 
1107  if ( isset( $wgDebugLogGroups['profileoutput'] )
1108  && $wgDebugLogGroups['profileoutput'] === false
1109  ) {
1110  // Explicitly disabled
1111  return;
1112  }
1113  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1114  return;
1115  }
1116 
1117  $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1118  if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1119  $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1120  }
1121  if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1122  $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1123  }
1124  if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1125  $ctx['from'] = $_SERVER['HTTP_FROM'];
1126  }
1127  if ( isset( $ctx['forwarded_for'] ) ||
1128  isset( $ctx['client_ip'] ) ||
1129  isset( $ctx['from'] ) ) {
1130  // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
1131  $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1132  }
1133 
1134  // Don't load $wgUser at this late stage just for statistics purposes
1135  // @todo FIXME: We can detect some anons even if it is not loaded.
1136  // See User::getId()
1137  $user = $context->getUser();
1138  $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1139 
1140  // Command line script uses a FauxRequest object which does not have
1141  // any knowledge about an URL and throw an exception instead.
1142  try {
1143  $ctx['url'] = urldecode( $request->getRequestURL() );
1144  } catch ( Exception $ignored ) {
1145  // no-op
1146  }
1147 
1148  $ctx['output'] = $profiler->getOutput();
1149 
1150  $log = LoggerFactory::getInstance( 'profileoutput' );
1151  $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1152 }
1153 
1161 function wfIncrStats( $key, $count = 1 ) {
1162  $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1163  $stats->updateCount( $key, $count );
1164 }
1165 
1171 function wfReadOnly() {
1172  return MediaWikiServices::getInstance()->getReadOnlyMode()
1173  ->isReadOnly();
1174 }
1175 
1184 function wfReadOnlyReason() {
1185  return MediaWikiServices::getInstance()->getReadOnlyMode()
1186  ->getReason();
1187 }
1188 
1196  return MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1197  ->getReason();
1198 }
1199 
1215 function wfGetLangObj( $langcode = false ) {
1216  # Identify which language to get or create a language object for.
1217  # Using is_object here due to Stub objects.
1218  if ( is_object( $langcode ) ) {
1219  # Great, we already have the object (hopefully)!
1220  return $langcode;
1221  }
1222 
1223  global $wgLanguageCode;
1224  if ( $langcode === true || $langcode === $wgLanguageCode ) {
1225  # $langcode is the language code of the wikis content language object.
1226  # or it is a boolean and value is true
1227  return MediaWikiServices::getInstance()->getContentLanguage();
1228  }
1229 
1230  global $wgLang;
1231  if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1232  # $langcode is the language code of user language object.
1233  # or it was a boolean and value is false
1234  return $wgLang;
1235  }
1236 
1237  $validCodes = array_keys( Language::fetchLanguageNames() );
1238  if ( in_array( $langcode, $validCodes ) ) {
1239  # $langcode corresponds to a valid language.
1240  return Language::factory( $langcode );
1241  }
1242 
1243  # $langcode is a string, but not a valid language code; use content language.
1244  wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1245  return MediaWikiServices::getInstance()->getContentLanguage();
1246 }
1247 
1264 function wfMessage( $key, ...$params ) {
1265  $message = new Message( $key );
1266 
1267  // We call Message::params() to reduce code duplication
1268  if ( $params ) {
1269  $message->params( ...$params );
1270  }
1271 
1272  return $message;
1273 }
1274 
1287 function wfMessageFallback( ...$keys ) {
1288  return Message::newFallbackSequence( ...$keys );
1289 }
1290 
1299 function wfMsgReplaceArgs( $message, $args ) {
1300  # Fix windows line-endings
1301  # Some messages are split with explode("\n", $msg)
1302  $message = str_replace( "\r", '', $message );
1303 
1304  // Replace arguments
1305  if ( is_array( $args ) && $args ) {
1306  if ( is_array( $args[0] ) ) {
1307  $args = array_values( $args[0] );
1308  }
1309  $replacementKeys = [];
1310  foreach ( $args as $n => $param ) {
1311  $replacementKeys['$' . ( $n + 1 )] = $param;
1312  }
1313  $message = strtr( $message, $replacementKeys );
1314  }
1315 
1316  return $message;
1317 }
1318 
1326 function wfHostname() {
1327  static $host;
1328  if ( is_null( $host ) ) {
1329  # Hostname overriding
1330  global $wgOverrideHostname;
1331  if ( $wgOverrideHostname !== false ) {
1332  # Set static and skip any detection
1333  $host = $wgOverrideHostname;
1334  return $host;
1335  }
1336 
1337  if ( function_exists( 'posix_uname' ) ) {
1338  // This function not present on Windows
1339  $uname = posix_uname();
1340  } else {
1341  $uname = false;
1342  }
1343  if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1344  $host = $uname['nodename'];
1345  } elseif ( getenv( 'COMPUTERNAME' ) ) {
1346  # Windows computer name
1347  $host = getenv( 'COMPUTERNAME' );
1348  } else {
1349  # This may be a virtual server.
1350  $host = $_SERVER['SERVER_NAME'];
1351  }
1352  }
1353  return $host;
1354 }
1355 
1366 function wfReportTime( $nonce = null ) {
1367  global $wgShowHostnames;
1368 
1369  $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1370  // seconds to milliseconds
1371  $responseTime = round( $elapsed * 1000 );
1372  $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1373  if ( $wgShowHostnames ) {
1374  $reportVars['wgHostname'] = wfHostname();
1375  }
1376  return Skin::makeVariablesScript( $reportVars, $nonce );
1377 }
1378 
1389 function wfDebugBacktrace( $limit = 0 ) {
1390  static $disabled = null;
1391 
1392  if ( is_null( $disabled ) ) {
1393  $disabled = !function_exists( 'debug_backtrace' );
1394  if ( $disabled ) {
1395  wfDebug( "debug_backtrace() is disabled\n" );
1396  }
1397  }
1398  if ( $disabled ) {
1399  return [];
1400  }
1401 
1402  if ( $limit ) {
1403  return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1404  } else {
1405  return array_slice( debug_backtrace(), 1 );
1406  }
1407 }
1408 
1417 function wfBacktrace( $raw = null ) {
1418  global $wgCommandLineMode;
1419 
1420  if ( $raw === null ) {
1421  $raw = $wgCommandLineMode;
1422  }
1423 
1424  if ( $raw ) {
1425  $frameFormat = "%s line %s calls %s()\n";
1426  $traceFormat = "%s";
1427  } else {
1428  $frameFormat = "<li>%s line %s calls %s()</li>\n";
1429  $traceFormat = "<ul>\n%s</ul>\n";
1430  }
1431 
1432  $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1433  $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1434  $line = $frame['line'] ?? '-';
1435  $call = $frame['function'];
1436  if ( !empty( $frame['class'] ) ) {
1437  $call = $frame['class'] . $frame['type'] . $call;
1438  }
1439  return sprintf( $frameFormat, $file, $line, $call );
1440  }, wfDebugBacktrace() );
1441 
1442  return sprintf( $traceFormat, implode( '', $frames ) );
1443 }
1444 
1454 function wfGetCaller( $level = 2 ) {
1455  $backtrace = wfDebugBacktrace( $level + 1 );
1456  if ( isset( $backtrace[$level] ) ) {
1457  return wfFormatStackFrame( $backtrace[$level] );
1458  } else {
1459  return 'unknown';
1460  }
1461 }
1462 
1470 function wfGetAllCallers( $limit = 3 ) {
1471  $trace = array_reverse( wfDebugBacktrace() );
1472  if ( !$limit || $limit > count( $trace ) - 1 ) {
1473  $limit = count( $trace ) - 1;
1474  }
1475  $trace = array_slice( $trace, -$limit - 1, $limit );
1476  return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1477 }
1478 
1485 function wfFormatStackFrame( $frame ) {
1486  if ( !isset( $frame['function'] ) ) {
1487  return 'NO_FUNCTION_GIVEN';
1488  }
1489  return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1490  $frame['class'] . $frame['type'] . $frame['function'] :
1491  $frame['function'];
1492 }
1493 
1494 /* Some generic result counters, pulled out of SearchEngine */
1495 
1503 function wfShowingResults( $offset, $limit ) {
1504  return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1505 }
1506 
1516 function wfClientAcceptsGzip( $force = false ) {
1517  static $result = null;
1518  if ( $result === null || $force ) {
1519  $result = false;
1520  if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1521  # @todo FIXME: We may want to blacklist some broken browsers
1522  $m = [];
1523  if ( preg_match(
1524  '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1525  $_SERVER['HTTP_ACCEPT_ENCODING'],
1526  $m
1527  )
1528  ) {
1529  if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1530  $result = false;
1531  return $result;
1532  }
1533  wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1534  $result = true;
1535  }
1536  }
1537  }
1538  return $result;
1539 }
1540 
1551 function wfEscapeWikiText( $text ) {
1552  global $wgEnableMagicLinks;
1553  static $repl = null, $repl2 = null;
1554  if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1555  // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1556  // in those situations
1557  $repl = [
1558  '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1559  '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1560  '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1561  "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1562  "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1563  "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1564  "\n " => "\n&#32;", "\r " => "\r&#32;",
1565  "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1566  "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1567  "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1568  "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1569  '__' => '_&#95;', '://' => '&#58;//',
1570  ];
1571 
1572  $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1573  // We have to catch everything "\s" matches in PCRE
1574  foreach ( $magicLinks as $magic ) {
1575  $repl["$magic "] = "$magic&#32;";
1576  $repl["$magic\t"] = "$magic&#9;";
1577  $repl["$magic\r"] = "$magic&#13;";
1578  $repl["$magic\n"] = "$magic&#10;";
1579  $repl["$magic\f"] = "$magic&#12;";
1580  }
1581 
1582  // And handle protocols that don't use "://"
1583  global $wgUrlProtocols;
1584  $repl2 = [];
1585  foreach ( $wgUrlProtocols as $prot ) {
1586  if ( substr( $prot, -1 ) === ':' ) {
1587  $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1588  }
1589  }
1590  $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1591  }
1592  $text = substr( strtr( "\n$text", $repl ), 1 );
1593  $text = preg_replace( $repl2, '$1&#58;', $text );
1594  return $text;
1595 }
1596 
1607 function wfSetVar( &$dest, $source, $force = false ) {
1608  $temp = $dest;
1609  if ( !is_null( $source ) || $force ) {
1610  $dest = $source;
1611  }
1612  return $temp;
1613 }
1614 
1624 function wfSetBit( &$dest, $bit, $state = true ) {
1625  $temp = (bool)( $dest & $bit );
1626  if ( !is_null( $state ) ) {
1627  if ( $state ) {
1628  $dest |= $bit;
1629  } else {
1630  $dest &= ~$bit;
1631  }
1632  }
1633  return $temp;
1634 }
1635 
1642 function wfVarDump( $var ) {
1643  global $wgOut;
1644  $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1645  if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1646  print $s;
1647  } else {
1648  $wgOut->addHTML( $s );
1649  }
1650 }
1651 
1659 function wfHttpError( $code, $label, $desc ) {
1660  global $wgOut;
1661  HttpStatus::header( $code );
1662  if ( $wgOut ) {
1663  $wgOut->disable();
1664  $wgOut->sendCacheControl();
1665  }
1666 
1668  header( 'Content-type: text/html; charset=utf-8' );
1669  print '<!DOCTYPE html>' .
1670  '<html><head><title>' .
1671  htmlspecialchars( $label ) .
1672  '</title></head><body><h1>' .
1673  htmlspecialchars( $label ) .
1674  '</h1><p>' .
1675  nl2br( htmlspecialchars( $desc ) ) .
1676  "</p></body></html>\n";
1677 }
1678 
1696 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1697  if ( $resetGzipEncoding ) {
1698  // Suppress Content-Encoding and Content-Length
1699  // headers from OutputHandler::handle.
1702  }
1703  while ( $status = ob_get_status() ) {
1704  if ( isset( $status['flags'] ) ) {
1705  $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1706  $deleteable = ( $status['flags'] & $flags ) === $flags;
1707  } elseif ( isset( $status['del'] ) ) {
1708  $deleteable = $status['del'];
1709  } else {
1710  // Guess that any PHP-internal setting can't be removed.
1711  $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1712  }
1713  if ( !$deleteable ) {
1714  // Give up, and hope the result doesn't break
1715  // output behavior.
1716  break;
1717  }
1718  if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1719  // Unit testing barrier to prevent this function from breaking PHPUnit.
1720  break;
1721  }
1722  if ( !ob_end_clean() ) {
1723  // Could not remove output buffer handler; abort now
1724  // to avoid getting in some kind of infinite loop.
1725  break;
1726  }
1727  if ( $resetGzipEncoding && $status['name'] == 'ob_gzhandler' ) {
1728  // Reset the 'Content-Encoding' field set by this handler
1729  // so we can start fresh.
1730  header_remove( 'Content-Encoding' );
1731  break;
1732  }
1733  }
1734 }
1735 
1749  wfResetOutputBuffers( false );
1750 }
1751 
1760 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1761  # No arg means accept anything (per HTTP spec)
1762  if ( !$accept ) {
1763  return [ $def => 1.0 ];
1764  }
1765 
1766  $prefs = [];
1767 
1768  $parts = explode( ',', $accept );
1769 
1770  foreach ( $parts as $part ) {
1771  # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1772  $values = explode( ';', trim( $part ) );
1773  $match = [];
1774  if ( count( $values ) == 1 ) {
1775  $prefs[$values[0]] = 1.0;
1776  } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1777  $prefs[$values[0]] = floatval( $match[1] );
1778  }
1779  }
1780 
1781  return $prefs;
1782 }
1783 
1796 function mimeTypeMatch( $type, $avail ) {
1797  if ( array_key_exists( $type, $avail ) ) {
1798  return $type;
1799  } else {
1800  $mainType = explode( '/', $type )[0];
1801  if ( array_key_exists( "$mainType/*", $avail ) ) {
1802  return "$mainType/*";
1803  } elseif ( array_key_exists( '*/*', $avail ) ) {
1804  return '*/*';
1805  } else {
1806  return null;
1807  }
1808  }
1809 }
1810 
1825 function wfNegotiateType( $cprefs, $sprefs ) {
1826  $combine = [];
1827 
1828  foreach ( array_keys( $sprefs ) as $type ) {
1829  $subType = explode( '/', $type )[1];
1830  if ( $subType != '*' ) {
1831  $ckey = mimeTypeMatch( $type, $cprefs );
1832  if ( $ckey ) {
1833  $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1834  }
1835  }
1836  }
1837 
1838  foreach ( array_keys( $cprefs ) as $type ) {
1839  $subType = explode( '/', $type )[1];
1840  if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1841  $skey = mimeTypeMatch( $type, $sprefs );
1842  if ( $skey ) {
1843  $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1844  }
1845  }
1846  }
1847 
1848  $bestq = 0;
1849  $besttype = null;
1850 
1851  foreach ( array_keys( $combine ) as $type ) {
1852  if ( $combine[$type] > $bestq ) {
1853  $besttype = $type;
1854  $bestq = $combine[$type];
1855  }
1856  }
1857 
1858  return $besttype;
1859 }
1860 
1869 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1870  $ret = MWTimestamp::convert( $outputtype, $ts );
1871  if ( $ret === false ) {
1872  wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1873  }
1874  return $ret;
1875 }
1876 
1885 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1886  if ( is_null( $ts ) ) {
1887  return null;
1888  } else {
1889  return wfTimestamp( $outputtype, $ts );
1890  }
1891 }
1892 
1898 function wfTimestampNow() {
1899  return MWTimestamp::now( TS_MW );
1900 }
1901 
1907 function wfIsWindows() {
1908  static $isWindows = null;
1909  if ( $isWindows === null ) {
1910  $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
1911  }
1912  return $isWindows;
1913 }
1914 
1921 function wfIsHHVM() {
1922  // wfDeprecated( __FUNCTION__, '1.34' );
1923  return false;
1924 }
1925 
1932 function wfIsCLI() {
1933  return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
1934 }
1935 
1947 function wfTempDir() {
1948  global $wgTmpDirectory;
1949 
1950  if ( $wgTmpDirectory !== false ) {
1951  return $wgTmpDirectory;
1952  }
1953 
1955 }
1956 
1966 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
1967  global $wgDirectoryMode;
1968 
1969  if ( FileBackend::isStoragePath( $dir ) ) { // sanity
1970  throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
1971  }
1972 
1973  if ( !is_null( $caller ) ) {
1974  wfDebug( "$caller: called wfMkdirParents($dir)\n" );
1975  }
1976 
1977  if ( strval( $dir ) === '' || is_dir( $dir ) ) {
1978  return true;
1979  }
1980 
1981  $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
1982 
1983  if ( is_null( $mode ) ) {
1984  $mode = $wgDirectoryMode;
1985  }
1986 
1987  // Turn off the normal warning, we're doing our own below
1988  AtEase::suppressWarnings();
1989  $ok = mkdir( $dir, $mode, true ); // PHP5 <3
1990  AtEase::restoreWarnings();
1991 
1992  if ( !$ok ) {
1993  // directory may have been created on another request since we last checked
1994  if ( is_dir( $dir ) ) {
1995  return true;
1996  }
1997 
1998  // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
1999  wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2000  }
2001  return $ok;
2002 }
2003 
2009 function wfRecursiveRemoveDir( $dir ) {
2010  wfDebug( __FUNCTION__ . "( $dir )\n" );
2011  // taken from https://www.php.net/manual/en/function.rmdir.php#98622
2012  if ( is_dir( $dir ) ) {
2013  $objects = scandir( $dir );
2014  foreach ( $objects as $object ) {
2015  if ( $object != "." && $object != ".." ) {
2016  if ( filetype( $dir . '/' . $object ) == "dir" ) {
2017  wfRecursiveRemoveDir( $dir . '/' . $object );
2018  } else {
2019  unlink( $dir . '/' . $object );
2020  }
2021  }
2022  }
2023  reset( $objects );
2024  rmdir( $dir );
2025  }
2026 }
2027 
2034 function wfPercent( $nr, $acc = 2, $round = true ) {
2035  $ret = sprintf( "%.${acc}f", $nr );
2036  return $round ? round( (float)$ret, $acc ) . '%' : "$ret%";
2037 }
2038 
2062 function wfIniGetBool( $setting ) {
2063  return wfStringToBool( ini_get( $setting ) );
2064 }
2065 
2078 function wfStringToBool( $val ) {
2079  $val = strtolower( $val );
2080  // 'on' and 'true' can't have whitespace around them, but '1' can.
2081  return $val == 'on'
2082  || $val == 'true'
2083  || $val == 'yes'
2084  || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2085 }
2086 
2099 function wfEscapeShellArg( ...$args ) {
2100  return Shell::escape( ...$args );
2101 }
2102 
2127 function wfShellExec( $cmd, &$retval = null, $environ = [],
2128  $limits = [], $options = []
2129 ) {
2130  if ( Shell::isDisabled() ) {
2131  $retval = 1;
2132  // Backwards compatibility be upon us...
2133  return 'Unable to run external programs, proc_open() is disabled.';
2134  }
2135 
2136  if ( is_array( $cmd ) ) {
2137  $cmd = Shell::escape( $cmd );
2138  }
2139 
2140  $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2141  $profileMethod = $options['profileMethod'] ?? wfGetCaller();
2142 
2143  try {
2144  $result = Shell::command( [] )
2145  ->unsafeParams( (array)$cmd )
2146  ->environment( $environ )
2147  ->limits( $limits )
2148  ->includeStderr( $includeStderr )
2149  ->profileMethod( $profileMethod )
2150  // For b/c
2151  ->restrict( Shell::RESTRICT_NONE )
2152  ->execute();
2153  } catch ( ProcOpenError $ex ) {
2154  $retval = -1;
2155  return '';
2156  }
2157 
2158  $retval = $result->getExitCode();
2159 
2160  return $result->getStdout();
2161 }
2162 
2180 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2181  return wfShellExec( $cmd, $retval, $environ, $limits,
2182  [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2183 }
2184 
2200 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2201  global $wgPhpCli;
2202  // Give site config file a chance to run the script in a wrapper.
2203  // The caller may likely want to call wfBasename() on $script.
2204  Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2205  $cmd = [ $options['php'] ?? $wgPhpCli ];
2206  if ( isset( $options['wrapper'] ) ) {
2207  $cmd[] = $options['wrapper'];
2208  }
2209  $cmd[] = $script;
2210  // Escape each parameter for shell
2211  return Shell::escape( array_merge( $cmd, $parameters ) );
2212 }
2213 
2225 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2226  global $wgDiff3;
2227 
2228  # This check may also protect against code injection in
2229  # case of broken installations.
2230  AtEase::suppressWarnings();
2231  $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2232  AtEase::restoreWarnings();
2233 
2234  if ( !$haveDiff3 ) {
2235  wfDebug( "diff3 not found\n" );
2236  return false;
2237  }
2238 
2239  # Make temporary files
2240  $td = wfTempDir();
2241  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2242  $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2243  $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2244 
2245  # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2246  # a newline character. To avoid this, we normalize the trailing whitespace before
2247  # creating the diff.
2248 
2249  fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2250  fclose( $oldtextFile );
2251  fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2252  fclose( $mytextFile );
2253  fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2254  fclose( $yourtextFile );
2255 
2256  # Check for a conflict
2257  $cmd = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2258  $oldtextName, $yourtextName );
2259  $handle = popen( $cmd, 'r' );
2260 
2261  $mergeAttemptResult = '';
2262  do {
2263  $data = fread( $handle, 8192 );
2264  if ( strlen( $data ) == 0 ) {
2265  break;
2266  }
2267  $mergeAttemptResult .= $data;
2268  } while ( true );
2269  pclose( $handle );
2270 
2271  $conflict = $mergeAttemptResult !== '';
2272 
2273  # Merge differences
2274  $cmd = Shell::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2275  $oldtextName, $yourtextName );
2276  $handle = popen( $cmd, 'r' );
2277  $result = '';
2278  do {
2279  $data = fread( $handle, 8192 );
2280  if ( strlen( $data ) == 0 ) {
2281  break;
2282  }
2283  $result .= $data;
2284  } while ( true );
2285  pclose( $handle );
2286  unlink( $mytextName );
2287  unlink( $oldtextName );
2288  unlink( $yourtextName );
2289 
2290  if ( $result === '' && $old !== '' && !$conflict ) {
2291  wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2292  $conflict = true;
2293  }
2294  return !$conflict;
2295 }
2296 
2308 function wfDiff( $before, $after, $params = '-u' ) {
2309  if ( $before == $after ) {
2310  return '';
2311  }
2312 
2313  global $wgDiff;
2314  AtEase::suppressWarnings();
2315  $haveDiff = $wgDiff && file_exists( $wgDiff );
2316  AtEase::restoreWarnings();
2317 
2318  # This check may also protect against code injection in
2319  # case of broken installations.
2320  if ( !$haveDiff ) {
2321  wfDebug( "diff executable not found\n" );
2322  $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2323  $format = new UnifiedDiffFormatter();
2324  return $format->format( $diffs );
2325  }
2326 
2327  # Make temporary files
2328  $td = wfTempDir();
2329  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2330  $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2331 
2332  fwrite( $oldtextFile, $before );
2333  fclose( $oldtextFile );
2334  fwrite( $newtextFile, $after );
2335  fclose( $newtextFile );
2336 
2337  // Get the diff of the two files
2338  $cmd = "$wgDiff " . $params . ' ' . Shell::escape( $oldtextName, $newtextName );
2339 
2340  $h = popen( $cmd, 'r' );
2341  if ( !$h ) {
2342  unlink( $oldtextName );
2343  unlink( $newtextName );
2344  throw new Exception( __METHOD__ . '(): popen() failed' );
2345  }
2346 
2347  $diff = '';
2348 
2349  do {
2350  $data = fread( $h, 8192 );
2351  if ( strlen( $data ) == 0 ) {
2352  break;
2353  }
2354  $diff .= $data;
2355  } while ( true );
2356 
2357  // Clean up
2358  pclose( $h );
2359  unlink( $oldtextName );
2360  unlink( $newtextName );
2361 
2362  // Kill the --- and +++ lines. They're not useful.
2363  $diff_lines = explode( "\n", $diff );
2364  if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2365  unset( $diff_lines[0] );
2366  }
2367  if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2368  unset( $diff_lines[1] );
2369  }
2370 
2371  $diff = implode( "\n", $diff_lines );
2372 
2373  return $diff;
2374 }
2375 
2388 function wfBaseName( $path, $suffix = '' ) {
2389  if ( $suffix == '' ) {
2390  $encSuffix = '';
2391  } else {
2392  $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2393  }
2394 
2395  $matches = [];
2396  if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2397  return $matches[1];
2398  } else {
2399  return '';
2400  }
2401 }
2402 
2412 function wfRelativePath( $path, $from ) {
2413  // Normalize mixed input on Windows...
2414  $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2415  $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2416 
2417  // Trim trailing slashes -- fix for drive root
2418  $path = rtrim( $path, DIRECTORY_SEPARATOR );
2419  $from = rtrim( $from, DIRECTORY_SEPARATOR );
2420 
2421  $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2422  $against = explode( DIRECTORY_SEPARATOR, $from );
2423 
2424  if ( $pieces[0] !== $against[0] ) {
2425  // Non-matching Windows drive letters?
2426  // Return a full path.
2427  return $path;
2428  }
2429 
2430  // Trim off common prefix
2431  while ( count( $pieces ) && count( $against )
2432  && $pieces[0] == $against[0] ) {
2433  array_shift( $pieces );
2434  array_shift( $against );
2435  }
2436 
2437  // relative dots to bump us to the parent
2438  while ( count( $against ) ) {
2439  array_unshift( $pieces, '..' );
2440  array_shift( $against );
2441  }
2442 
2443  array_push( $pieces, wfBaseName( $path ) );
2444 
2445  return implode( DIRECTORY_SEPARATOR, $pieces );
2446 }
2447 
2457 function wfSetupSession( $sessionId = false ) {
2458  wfDeprecated( __FUNCTION__, '1.27' );
2459 
2460  if ( $sessionId ) {
2461  session_id( $sessionId );
2462  }
2463 
2464  $session = SessionManager::getGlobalSession();
2465  $session->persist();
2466 
2467  if ( session_id() !== $session->getId() ) {
2468  session_id( $session->getId() );
2469  }
2470  AtEase::quietCall( 'session_start' );
2471 }
2472 
2479 function wfGetPrecompiledData( $name ) {
2480  global $IP;
2481 
2482  $file = "$IP/serialized/$name";
2483  if ( file_exists( $file ) ) {
2484  $blob = file_get_contents( $file );
2485  if ( $blob ) {
2486  return unserialize( $blob );
2487  }
2488  }
2489  return false;
2490 }
2491 
2499 function wfMemcKey( ...$args ) {
2500  return ObjectCache::getLocalClusterInstance()->makeKey( ...$args );
2501 }
2502 
2513 function wfForeignMemcKey( $db, $prefix, ...$args ) {
2514  $keyspace = $prefix ? "$db-$prefix" : $db;
2515  return ObjectCache::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2516 }
2517 
2530 function wfGlobalCacheKey( ...$args ) {
2531  wfDeprecated( __METHOD__, '1.30' );
2532  return ObjectCache::getLocalClusterInstance()->makeGlobalKey( ...$args );
2533 }
2534 
2541 function wfWikiID() {
2542  global $wgDBprefix, $wgDBname;
2543  if ( $wgDBprefix ) {
2544  return "$wgDBname-$wgDBprefix";
2545  } else {
2546  return $wgDBname;
2547  }
2548 }
2549 
2575 function wfGetDB( $db, $groups = [], $wiki = false ) {
2576  return wfGetLB( $wiki )->getMaintenanceConnectionRef( $db, $groups, $wiki );
2577 }
2578 
2588 function wfGetLB( $wiki = false ) {
2589  if ( $wiki === false ) {
2590  return MediaWikiServices::getInstance()->getDBLoadBalancer();
2591  } else {
2592  $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2593  return $factory->getMainLB( $wiki );
2594  }
2595 }
2596 
2604 function wfFindFile( $title, $options = [] ) {
2605  return MediaWikiServices::getInstance()->getRepoGroup()->findFile( $title, $options );
2606 }
2607 
2616 function wfLocalFile( $title ) {
2617  return MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()->newFile( $title );
2618 }
2619 
2627  global $wgMiserMode;
2628  return $wgMiserMode
2629  || ( SiteStats::pages() > 100000
2630  && SiteStats::edits() > 1000000
2631  && SiteStats::users() > 10000 );
2632 }
2633 
2642 function wfScript( $script = 'index' ) {
2644  if ( $script === 'index' ) {
2645  return $wgScript;
2646  } elseif ( $script === 'load' ) {
2647  return $wgLoadScript;
2648  } else {
2649  return "{$wgScriptPath}/{$script}.php";
2650  }
2651 }
2652 
2658 function wfGetScriptUrl() {
2659  if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2660  /* as it was called, minus the query string.
2661  *
2662  * Some sites use Apache rewrite rules to handle subdomains,
2663  * and have PHP set up in a weird way that causes PHP_SELF
2664  * to contain the rewritten URL instead of the one that the
2665  * outside world sees.
2666  *
2667  * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2668  * provides containing the "before" URL.
2669  */
2670  return $_SERVER['SCRIPT_NAME'];
2671  } else {
2672  return $_SERVER['URL'];
2673  }
2674 }
2675 
2683 function wfBoolToStr( $value ) {
2684  return $value ? 'true' : 'false';
2685 }
2686 
2692 function wfGetNull() {
2693  return wfIsWindows() ? 'NUL' : '/dev/null';
2694 }
2695 
2719  $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2720 ) {
2721  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2722 
2723  if ( $cluster === '*' ) {
2724  $cluster = false;
2725  $domain = false;
2726  } elseif ( $wiki === false ) {
2727  $domain = $lbFactory->getLocalDomainID();
2728  } else {
2729  $domain = $wiki;
2730  }
2731 
2732  $opts = [
2733  'domain' => $domain,
2734  'cluster' => $cluster,
2735  // B/C: first argument used to be "max seconds of lag"; ignore such values
2736  'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
2737  ];
2738  if ( $timeout !== null ) {
2739  $opts['timeout'] = $timeout;
2740  }
2741 
2742  return $lbFactory->waitForReplication( $opts );
2743 }
2744 
2753 function wfStripIllegalFilenameChars( $name ) {
2754  global $wgIllegalFileChars;
2755  $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
2756  $name = preg_replace(
2757  "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
2758  '-',
2759  $name
2760  );
2761  // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2762  $name = wfBaseName( $name );
2763  return $name;
2764 }
2765 
2771 function wfMemoryLimit( $newLimit ) {
2772  $oldLimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2773  // If the INI config is already unlimited, there is nothing larger
2774  if ( $oldLimit != -1 ) {
2775  $newLimit = wfShorthandToInteger( $newLimit );
2776  if ( $newLimit == -1 ) {
2777  wfDebug( "Removing PHP's memory limit\n" );
2778  Wikimedia\suppressWarnings();
2779  ini_set( 'memory_limit', $newLimit );
2780  Wikimedia\restoreWarnings();
2781  } elseif ( $newLimit > $oldLimit ) {
2782  wfDebug( "Raising PHP's memory limit to $newLimit bytes\n" );
2783  Wikimedia\suppressWarnings();
2784  ini_set( 'memory_limit', $newLimit );
2785  Wikimedia\restoreWarnings();
2786  }
2787  }
2788 }
2789 
2798 
2799  $timeLimit = (int)ini_get( 'max_execution_time' );
2800  // Note that CLI scripts use 0
2801  if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2802  set_time_limit( $wgTransactionalTimeLimit );
2803  }
2804 
2805  ignore_user_abort( true ); // ignore client disconnects
2806 
2807  return $timeLimit;
2808 }
2809 
2817 function wfShorthandToInteger( $string = '', $default = -1 ) {
2818  $string = trim( $string );
2819  if ( $string === '' ) {
2820  return $default;
2821  }
2822  $last = $string[strlen( $string ) - 1];
2823  $val = intval( $string );
2824  switch ( $last ) {
2825  case 'g':
2826  case 'G':
2827  $val *= 1024;
2828  // break intentionally missing
2829  case 'm':
2830  case 'M':
2831  $val *= 1024;
2832  // break intentionally missing
2833  case 'k':
2834  case 'K':
2835  $val *= 1024;
2836  }
2837 
2838  return $val;
2839 }
2840 
2848 function wfGetCache( $cacheType ) {
2849  return ObjectCache::getInstance( $cacheType );
2850 }
2851 
2858 function wfGetMainCache() {
2860 }
2861 
2868  global $wgMessageCacheType;
2870 }
2871 
2886 function wfUnpack( $format, $data, $length = false ) {
2887  if ( $length !== false ) {
2888  $realLen = strlen( $data );
2889  if ( $realLen < $length ) {
2890  throw new MWException( "Tried to use wfUnpack on a "
2891  . "string of length $realLen, but needed one "
2892  . "of at least length $length."
2893  );
2894  }
2895  }
2896 
2897  Wikimedia\suppressWarnings();
2898  $result = unpack( $format, $data );
2899  Wikimedia\restoreWarnings();
2900 
2901  if ( $result === false ) {
2902  // If it cannot extract the packed data.
2903  throw new MWException( "unpack could not unpack binary data" );
2904  }
2905  return $result;
2906 }
2907 
2924 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
2925  $services = MediaWikiServices::getInstance();
2926  if ( $blacklist !== null ) {
2927  wfDeprecated( __METHOD__ . ' with $blacklist parameter', '1.34' );
2928  return ( new BadFileLookup(
2929  function () use ( $blacklist ) {
2930  return $blacklist;
2931  },
2932  $services->getLocalServerObjectCache(),
2933  $services->getRepoGroup(),
2934  $services->getTitleParser()
2935  ) )->isBadFile( $name, $contextTitle ?: null );
2936  }
2937  return $services->getBadFileLookup()->isBadFile( $name, $contextTitle ?: null );
2938 }
2939 
2947 function wfCanIPUseHTTPS( $ip ) {
2948  $canDo = true;
2949  Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
2950  return (bool)$canDo;
2951 }
2952 
2960 function wfIsInfinity( $str ) {
2961  // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
2962  $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
2963  return in_array( $str, $infinityValues );
2964 }
2965 
2980 function wfThumbIsStandard( File $file, array $params ) {
2982 
2983  $multipliers = [ 1 ];
2984  if ( $wgResponsiveImages ) {
2985  // These available sizes are hardcoded currently elsewhere in MediaWiki.
2986  // @see Linker::processResponsiveImages
2987  $multipliers[] = 1.5;
2988  $multipliers[] = 2;
2989  }
2990 
2991  $handler = $file->getHandler();
2992  if ( !$handler || !isset( $params['width'] ) ) {
2993  return false;
2994  }
2995 
2996  $basicParams = [];
2997  if ( isset( $params['page'] ) ) {
2998  $basicParams['page'] = $params['page'];
2999  }
3000 
3001  $thumbLimits = [];
3002  $imageLimits = [];
3003  // Expand limits to account for multipliers
3004  foreach ( $multipliers as $multiplier ) {
3005  $thumbLimits = array_merge( $thumbLimits, array_map(
3006  function ( $width ) use ( $multiplier ) {
3007  return round( $width * $multiplier );
3008  }, $wgThumbLimits )
3009  );
3010  $imageLimits = array_merge( $imageLimits, array_map(
3011  function ( $pair ) use ( $multiplier ) {
3012  return [
3013  round( $pair[0] * $multiplier ),
3014  round( $pair[1] * $multiplier ),
3015  ];
3016  }, $wgImageLimits )
3017  );
3018  }
3019 
3020  // Check if the width matches one of $wgThumbLimits
3021  if ( in_array( $params['width'], $thumbLimits ) ) {
3022  $normalParams = $basicParams + [ 'width' => $params['width'] ];
3023  // Append any default values to the map (e.g. "lossy", "lossless", ...)
3024  $handler->normaliseParams( $file, $normalParams );
3025  } else {
3026  // If not, then check if the width matchs one of $wgImageLimits
3027  $match = false;
3028  foreach ( $imageLimits as $pair ) {
3029  $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3030  // Decide whether the thumbnail should be scaled on width or height.
3031  // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3032  $handler->normaliseParams( $file, $normalParams );
3033  // Check if this standard thumbnail size maps to the given width
3034  if ( $normalParams['width'] == $params['width'] ) {
3035  $match = true;
3036  break;
3037  }
3038  }
3039  if ( !$match ) {
3040  return false; // not standard for description pages
3041  }
3042  }
3043 
3044  // Check that the given values for non-page, non-width, params are just defaults
3045  foreach ( $params as $key => $value ) {
3046  if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3047  return false;
3048  }
3049  }
3050 
3051  return true;
3052 }
3053 
3066 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3067  // First merge items that are in both arrays
3068  foreach ( $baseArray as $name => &$groupVal ) {
3069  if ( isset( $newValues[$name] ) ) {
3070  $groupVal += $newValues[$name];
3071  }
3072  }
3073  // Now add items that didn't exist yet
3074  $baseArray += $newValues;
3075 
3076  return $baseArray;
3077 }
3078 
3087 function wfGetRusage() {
3088  if ( !function_exists( 'getrusage' ) ) {
3089  return false;
3090  } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS === 'Linux' ) {
3091  return getrusage( 2 /* RUSAGE_THREAD */ );
3092  } else {
3093  return getrusage( 0 /* RUSAGE_SELF */ );
3094  }
3095 }
$wgPhpCli
$wgPhpCli
Executable path of the PHP cli binary.
Definition: DefaultSettings.php:8337
wfArrayInsertAfter
wfArrayInsertAfter(array $array, array $insert, $after)
Insert array into another array after the specified KEY
Definition: GlobalFunctions.php:207
MediaWiki\Shell\Shell
Executes shell commands.
Definition: Shell.php:44
wfMergeErrorArrays
wfMergeErrorArrays(... $args)
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
Definition: GlobalFunctions.php:181
wfPercent
wfPercent( $nr, $acc=2, $round=true)
Definition: GlobalFunctions.php:2034
wfResetOutputBuffers
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
Definition: GlobalFunctions.php:1696
wfMessageFallback
wfMessageFallback(... $keys)
This function accepts multiple message keys and returns a message instance for the first message whic...
Definition: GlobalFunctions.php:1287
$wgThumbLimits
$wgThumbLimits
Adjust thumbnails on image pages according to a user setting.
Definition: DefaultSettings.php:1474
PROTO_CANONICAL
const PROTO_CANONICAL
Definition: Defines.php:203
wfCanIPUseHTTPS
wfCanIPUseHTTPS( $ip)
Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS.
Definition: GlobalFunctions.php:2947
ObjectCache\getLocalClusterInstance
static getLocalClusterInstance()
Get the main cluster-local cache object.
Definition: ObjectCache.php:342
SiteStats\users
static users()
Definition: SiteStats.php:121
MediaWiki\emitBufferedStatsdData
static emitBufferedStatsdData(IBufferingStatsdDataFactory $stats, Config $config)
Send out any buffered statsd data according to sampling rules.
Definition: MediaWiki.php:968
PROTO_INTERNAL
const PROTO_INTERNAL
Definition: Defines.php:204
MediaWiki\ProcOpenError
Definition: ProcOpenError.php:25
wfDiff
wfDiff( $before, $after, $params='-u')
Returns unified plain-text diff of two texts.
Definition: GlobalFunctions.php:2308
$wgResponsiveImages
$wgResponsiveImages
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
Definition: DefaultSettings.php:1593
wfSetupSession
wfSetupSession( $sessionId=false)
Initialise php session.
Definition: GlobalFunctions.php:2457
$wgDebugRawPage
$wgDebugRawPage
If true, log debugging data from action=raw and load.php.
Definition: DefaultSettings.php:6140
wfThumbIsStandard
wfThumbIsStandard(File $file, array $params)
Returns true if these thumbnail parameters match one that MediaWiki requests from file description pa...
Definition: GlobalFunctions.php:2980
$wgTmpDirectory
$wgTmpDirectory
The local filesystem path to a temporary directory.
Definition: DefaultSettings.php:352
wfArrayPlus2d
wfArrayPlus2d(array $baseArray, array $newValues)
Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
Definition: GlobalFunctions.php:3066
$wgDBname
$wgDBname
Current wiki database name.
Definition: DefaultSettings.php:1893
Profiler\instance
static instance()
Singleton.
Definition: Profiler.php:63
wfMkdirParents
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
Definition: GlobalFunctions.php:1966
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:117
MediaWiki\BadFileLookup
Definition: BadFileLookup.php:12
$wgDiff3
$wgDiff3
Path to the GNU diff3 utility.
Definition: DefaultSettings.php:6675
wfMerge
wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult=null)
wfMerge attempts to merge differences between three texts.
Definition: GlobalFunctions.php:2225
wfDebugBacktrace
wfDebugBacktrace( $limit=0)
Safety wrapper for debug_backtrace().
Definition: GlobalFunctions.php:1389
wfSetVar
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
Definition: GlobalFunctions.php:1607
wfGetLB
wfGetLB( $wiki=false)
Get a load balancer object.
Definition: GlobalFunctions.php:2588
wfFormatStackFrame
wfFormatStackFrame( $frame)
Return a string representation of frame.
Definition: GlobalFunctions.php:1485
wfRemoveDotSegments
wfRemoveDotSegments( $urlPath)
Remove all dot-segments in the provided URL path.
Definition: GlobalFunctions.php:641
$wgScript
$wgScript
The URL path to index.php.
Definition: DefaultSettings.php:185
wfSetBit
wfSetBit(&$dest, $bit, $state=true)
As for wfSetVar except setting a bit.
Definition: GlobalFunctions.php:1624
Skin\makeVariablesScript
static makeVariablesScript( $data, $nonce=null)
Definition: Skin.php:405
wfNegotiateType
wfNegotiateType( $cprefs, $sprefs)
Returns the 'best' match between a client's requested internet media types and the server's list of a...
Definition: GlobalFunctions.php:1825
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1869
SiteStats\pages
static pages()
Definition: SiteStats.php:112
wfUnpack
wfUnpack( $format, $data, $length=false)
Wrapper around php's unpack.
Definition: GlobalFunctions.php:2886
wfConfiguredReadOnlyReason
wfConfiguredReadOnlyReason()
Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
Definition: GlobalFunctions.php:1195
MessageSpecifier
Definition: MessageSpecifier.php:21
$wgShowHostnames
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
Definition: DefaultSettings.php:6338
wfMemoryLimit
wfMemoryLimit( $newLimit)
Raise PHP's memory limit (if needed).
Definition: GlobalFunctions.php:2771
wfObjectToArray
wfObjectToArray( $objOrArray, $recursive=true)
Recursively converts the parameter (an object) to an array with the same data.
Definition: GlobalFunctions.php:230
wfUrlencode
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness,...
Definition: GlobalFunctions.php:309
wfArrayDiff2_cmp
wfArrayDiff2_cmp( $a, $b)
Definition: GlobalFunctions.php:122
wfGetScriptUrl
wfGetScriptUrl()
Get the script URL.
Definition: GlobalFunctions.php:2658
$wgMessageCacheType
$wgMessageCacheType
The cache type for storing the contents of the MediaWiki namespace.
Definition: DefaultSettings.php:2353
ProfilerStub
Stub profiler that does nothing.
Definition: ProfilerStub.php:29
$wgDiff
$wgDiff
Path to the GNU diff utility.
Definition: DefaultSettings.php:6680
wfBaseName
wfBaseName( $path, $suffix='')
Return the final portion of a pathname.
Definition: GlobalFunctions.php:2388
wfQueriesMustScale
wfQueriesMustScale()
Should low-performance queries be disabled?
Definition: GlobalFunctions.php:2626
$file
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42
wfHostname
wfHostname()
Fetch server name for use in error reporting etc.
Definition: GlobalFunctions.php:1326
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1171
wfMsgReplaceArgs
wfMsgReplaceArgs( $message, $args)
Replace message parameter keys on the given formatted output.
Definition: GlobalFunctions.php:1299
wfMessage
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Definition: GlobalFunctions.php:1264
$s
$s
Definition: mergeMessageFileList.php:185
wfLogWarning
wfLogWarning( $msg, $callerOffset=1, $level=E_USER_WARNING)
Send a warning as a PHP error and the debug log.
Definition: GlobalFunctions.php:1078
$last
$last
Definition: profileinfo.php:419
wfStringToBool
wfStringToBool( $val)
Convert string value to boolean, when the following are interpreted as true:
Definition: GlobalFunctions.php:2078
$wgTransactionalTimeLimit
$wgTransactionalTimeLimit
The minimum amount of time that MediaWiki needs for "slow" write request, particularly ones with mult...
Definition: DefaultSettings.php:2309
Message
$wgDebugLogPrefix
$wgDebugLogPrefix
Prefix for debug log lines.
Definition: DefaultSettings.php:6126
wfExpandIRI
wfExpandIRI( $url)
Take a URL, make sure it's expanded to fully qualified, and replace any encoded non-ASCII Unicode cha...
Definition: GlobalFunctions.php:863
wfWaitForSlaves
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Definition: GlobalFunctions.php:2718
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1007
$wgDBprefix
$wgDBprefix
Current wiki database table name prefix.
Definition: DefaultSettings.php:1913
wfShellWikiCmd
wfShellWikiCmd( $script, array $parameters=[], array $options=[])
Generate a shell-escaped command line string to run a MediaWiki cli script.
Definition: GlobalFunctions.php:2200
wfBoolToStr
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
Definition: GlobalFunctions.php:2683
wfAppendQuery
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Definition: GlobalFunctions.php:439
ExtensionRegistry\getInstance
static getInstance()
Definition: ExtensionRegistry.php:106
wfParseUrl
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Definition: GlobalFunctions.php:793
File
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:61
wfReportTime
wfReportTime( $nonce=null)
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
Definition: GlobalFunctions.php:1366
wfGetMainCache
wfGetMainCache()
Get the main cache object.
Definition: GlobalFunctions.php:2858
MWException
MediaWiki exception.
Definition: MWException.php:26
wfStripIllegalFilenameChars
wfStripIllegalFilenameChars( $name)
Replace all invalid characters with '-'.
Definition: GlobalFunctions.php:2753
wfGetRusage
wfGetRusage()
Get system resource usage of current request context.
Definition: GlobalFunctions.php:3087
mimeTypeMatch
mimeTypeMatch( $type, $avail)
Checks if a given MIME type matches any of the keys in the given array.
Definition: GlobalFunctions.php:1796
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1044
MediaWiki\Logger\LoggerFactory
PSR-3 logger instance factory.
Definition: LoggerFactory.php:45
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2642
wfArrayDiff2
wfArrayDiff2( $a, $b)
Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
Definition: GlobalFunctions.php:113
wfIncrStats
wfIncrStats( $key, $count=1)
Increment a statistics counter.
Definition: GlobalFunctions.php:1161
FileBackend\isStoragePath
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
Definition: FileBackend.php:1508
$blob
$blob
Definition: testCompression.php:65
wfTransactionalTimeLimit
wfTransactionalTimeLimit()
Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit.
Definition: GlobalFunctions.php:2796
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2575
wfUrlProtocolsWithoutProtRel
wfUrlProtocolsWithoutProtRel()
Like wfUrlProtocols(), but excludes '//' from the protocol list.
Definition: GlobalFunctions.php:764
$wgCommandLineMode
global $wgCommandLineMode
Definition: DevelopmentSettings.php:28
$matches
$matches
Definition: NoLocalSettings.php:24
$wgDebugLogGroups
$wgDebugLogGroups
Map of string log group names to log destinations.
Definition: DefaultSettings.php:6249
$wgLang
$wgLang
Definition: Setup.php:881
$wgLoadScript
$wgLoadScript
The URL path to load.php.
Definition: DefaultSettings.php:193
wfTimestampOrNull
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
Definition: GlobalFunctions.php:1885
$IP
$IP
Definition: update.php:3
PROTO_CURRENT
const PROTO_CURRENT
Definition: Defines.php:202
ObjectCache\getInstance
static getInstance( $id)
Get a cached instance of the specified type of cache object.
Definition: ObjectCache.php:80
wfGetLangObj
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
Definition: GlobalFunctions.php:1215
wfCgiToArray
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
Definition: GlobalFunctions.php:392
wfLoadSkins
wfLoadSkins(array $skins)
Load multiple skins at once.
Definition: GlobalFunctions.php:99
$title
$title
Definition: testCompression.php:34
MWDebug\deprecated
static deprecated( $function, $version=false, $component=false, $callerOffset=2)
Show a warning that $function is deprecated.
Definition: MWDebug.php:217
wfGetCache
wfGetCache( $cacheType)
Get a specific cache object.
Definition: GlobalFunctions.php:2848
$wgEnableMagicLinks
$wgEnableMagicLinks
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links.
Definition: DefaultSettings.php:4348
$output
$output
Definition: SyntaxHighlight.php:335
wfTimestampNow
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
Definition: GlobalFunctions.php:1898
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:913
wfAcceptToPrefs
wfAcceptToPrefs( $accept, $def=' */*')
Converts an Accept-* header into an array mapping string values to quality factors.
Definition: GlobalFunctions.php:1760
PROTO_HTTPS
const PROTO_HTTPS
Definition: Defines.php:200
$wgCanonicalServer
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
Definition: DefaultSettings.php:114
wfIsDebugRawPage
wfIsDebugRawPage()
Returns true if debug logging should be suppressed if $wgDebugRawPage = false.
Definition: GlobalFunctions.php:947
wfForeignMemcKey
wfForeignMemcKey( $db, $prefix,... $args)
Make a cache key for a foreign DB.
Definition: GlobalFunctions.php:2513
UnifiedDiffFormatter
A formatter that outputs unified diffs.
Definition: UnifiedDiffFormatter.php:31
$wgDebugTimestamps
$wgDebugTimestamps
Prefix debug messages with relative timestamp.
Definition: DefaultSettings.php:6287
wfUrlProtocols
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
Definition: GlobalFunctions.php:719
$line
$line
Definition: cdb.php:59
wfIsBadImage
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the 'bad image list'.
Definition: GlobalFunctions.php:2924
wfLoadExtensions
wfLoadExtensions(array $exts)
Load multiple extensions at once.
Definition: GlobalFunctions.php:68
wfGlobalCacheKey
wfGlobalCacheKey(... $args)
Make a cache key with database-agnostic prefix.
Definition: GlobalFunctions.php:2530
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2541
wfClearOutputBuffers
wfClearOutputBuffers()
More legible than passing a 'false' parameter to wfResetOutputBuffers():
Definition: GlobalFunctions.php:1748
wfClientAcceptsGzip
wfClientAcceptsGzip( $force=false)
Whether the client accept gzip encoding.
Definition: GlobalFunctions.php:1516
$wgUrlProtocols
$wgUrlProtocols
URL schemes that should be recognized as valid by wfParseUrl().
Definition: DefaultSettings.php:4185
$wgExtensionDirectory
$wgExtensionDirectory
Filesystem extensions directory.
Definition: DefaultSettings.php:229
wfIsCLI
wfIsCLI()
Check if we are running from the commandline.
Definition: GlobalFunctions.php:1932
wfIsWindows
wfIsWindows()
Check if the operating system is Windows.
Definition: GlobalFunctions.php:1907
$wgServer
$wgServer
URL of the server.
Definition: DefaultSettings.php:105
MediaWiki\Session\SessionManager
This serves as the entry point to the MediaWiki session handling system.
Definition: SessionManager.php:50
$wgLanguageCode
$wgLanguageCode
Site language code.
Definition: DefaultSettings.php:2948
wfIsInfinity
wfIsInfinity( $str)
Determine input string is represents as infinity.
Definition: GlobalFunctions.php:2960
wfDebugMem
wfDebugMem( $exact=false)
Send a line giving PHP memory usage.
Definition: GlobalFunctions.php:972
PROTO_HTTP
const PROTO_HTTP
Definition: Defines.php:199
$wgDirectoryMode
$wgDirectoryMode
Default value for chmoding of new directories.
Definition: DefaultSettings.php:1585
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1551
wfAppendToArrayIfNotDefault
wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed)
Appends to second array if $value differs from that in $default.
Definition: GlobalFunctions.php:153
$wgDisableOutputCompression
$wgDisableOutputCompression
Disable output compression (enabled by default if zlib is available)
Definition: DefaultSettings.php:3413
wfVarDump
wfVarDump( $var)
A wrapper around the PHP function var_export().
Definition: GlobalFunctions.php:1642
$wgIllegalFileChars
$wgIllegalFileChars
Additional characters that are not allowed in filenames.
Definition: DefaultSettings.php:431
wfGetNull
wfGetNull()
Get a platform-independent path to the null file, e.g.
Definition: GlobalFunctions.php:2692
TempFSFile\getUsableTempDirectory
static getUsableTempDirectory()
Definition: TempFSFile.php:80
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:431
wfIniGetBool
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
Definition: GlobalFunctions.php:2062
$wgOverrideHostname
$wgOverrideHostname
Override server hostname detection with a hardcoded value.
Definition: DefaultSettings.php:6345
wfFindFile
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:2604
$context
$context
Definition: load.php:45
wfGetAllCallers
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
Definition: GlobalFunctions.php:1470
wfLoadExtension
wfLoadExtension( $ext, $path=null)
Load an extension.
Definition: GlobalFunctions.php:47
wfGetMessageCacheStorage
wfGetMessageCacheStorage()
Get the cache object used by the message cache.
Definition: GlobalFunctions.php:2867
unserialize
unserialize( $serialized)
Definition: ApiMessageTrait.php:146
$args
if( $line===false) $args
Definition: cdb.php:64
wfLoadSkin
wfLoadSkin( $skin, $path=null)
Load a skin.
Definition: GlobalFunctions.php:84
wfShorthandToInteger
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
Definition: GlobalFunctions.php:2817
$wgImageLimits
$wgImageLimits
Limit images on image description pages to a user-selectable limit.
Definition: DefaultSettings.php:1461
$status
return $status
Definition: SyntaxHighlight.php:347
wfRandom
wfRandom()
Get a random decimal value in the domain of [0, 1), in a way not likely to give duplicate values for ...
Definition: GlobalFunctions.php:256
wfTempDir
wfTempDir()
Tries to get the system directory for temporary files.
Definition: GlobalFunctions.php:1947
$wgMiserMode
$wgMiserMode
Disable database-intensive features.
Definition: DefaultSettings.php:2265
wfHttpError
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
Definition: GlobalFunctions.php:1659
wfReadOnlyReason
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
Definition: GlobalFunctions.php:1184
wfMatchesDomainList
wfMatchesDomainList( $url, $domains)
Check whether a given URL has a domain that occurs in a given set of domains.
Definition: GlobalFunctions.php:879
$cache
$cache
Definition: mcc.php:33
HttpStatus\header
static header( $code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
wfGetPrecompiledData
wfGetPrecompiledData( $name)
Get an object from the precompiled serialized directory.
Definition: GlobalFunctions.php:2479
wfRecursiveRemoveDir
wfRecursiveRemoveDir( $dir)
Remove a directory and all its content.
Definition: GlobalFunctions.php:2009
$wgHttpsPort
$wgHttpsPort
For installations where the canonical server is HTTP but HTTPS is optionally supported,...
Definition: DefaultSettings.php:8687
$path
$path
Definition: NoLocalSettings.php:25
$keys
$keys
Definition: testCompression.php:67
wfBacktrace
wfBacktrace( $raw=null)
Get a debug backtrace as a string.
Definition: GlobalFunctions.php:1417
wfEscapeShellArg
wfEscapeShellArg(... $args)
Version of escapeshellarg() that works better on Windows.
Definition: GlobalFunctions.php:2099
$source
$source
Definition: mwdoc-filter.php:34
wfAssembleUrl
wfAssembleUrl( $urlParts)
This function will reassemble a URL parsed with wfParseURL.
Definition: GlobalFunctions.php:587
$ext
if(!is_readable( $file)) $ext
Definition: router.php:48
wfRelativePath
wfRelativePath( $path, $from)
Generate a relative path name to the given file.
Definition: GlobalFunctions.php:2412
Language\factory
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:217
wfWarn
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Definition: GlobalFunctions.php:1065
Title\legalChars
static legalChars()
Get a regex character class describing the legal characters in a link.
Definition: Title.php:695
$wgRequest
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:752
MediaWiki\Linker\LinkTarget
Definition: LinkTarget.php:26
MWDebug\warning
static warning( $msg, $callerOffset=1, $level=E_USER_NOTICE, $log='auto')
Adds a warning entry to the log.
Definition: MWDebug.php:175
wfMemcKey
wfMemcKey(... $args)
Make a cache key for the local wiki.
Definition: GlobalFunctions.php:2499
Language\fetchLanguageNames
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:818
$wgOut
$wgOut
Definition: Setup.php:886
wfGetServerUrl
wfGetServerUrl( $proto)
Get the wiki's "server", i.e.
Definition: GlobalFunctions.php:569
wfIsHHVM
wfIsHHVM()
Check if we are running under HHVM.
Definition: GlobalFunctions.php:1921
$wgScriptPath
$wgScriptPath
The path we should point to.
Definition: DefaultSettings.php:137
wfLocalFile
wfLocalFile( $title)
Get an object referring to a locally registered file.
Definition: GlobalFunctions.php:2616
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
wfShowingResults
wfShowingResults( $offset, $limit)
Definition: GlobalFunctions.php:1503
wfGetCaller
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
Definition: GlobalFunctions.php:1454
$wgStyleDirectory
$wgStyleDirectory
Filesystem stylesheets directory.
Definition: DefaultSettings.php:236
wfLogDBError
wfLogDBError( $text, array $context=[])
Log for database errors.
Definition: GlobalFunctions.php:1025
SiteStats\edits
static edits()
Definition: SiteStats.php:94
$wgInternalServer
$wgInternalServer
Internal server name as known to CDN, if different.
Definition: DefaultSettings.php:2771
wfExpandUrl
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:491
wfShellExecWithStderr
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
Definition: GlobalFunctions.php:2180
MediaWiki\HeaderCallback\warnIfHeadersSent
static warnIfHeadersSent()
Log a warning message if headers have already been sent.
Definition: HeaderCallback.php:70
wfLogProfilingData
wfLogProfilingData()
Definition: GlobalFunctions.php:1086
Diff
Class representing a 'diff' between two sequences of strings.
Definition: Diff.php:32
wfShellExec
wfShellExec( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
Definition: GlobalFunctions.php:2127
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:347
wfRandomString
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
Definition: GlobalFunctions.php:274
$type
$type
Definition: testCompression.php:48