MediaWiki  master
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 ( $changed === null ) {
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 ( $s === null ) {
313  // Reset $needle for testing.
314  $needle = null;
315  return '';
316  }
317 
318  if ( $needle === null ) {
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 ( $array2 !== null ) {
349  $array1 = $array1 + $array2;
350  }
351 
352  $cgi = '';
353  foreach ( $array1 as $key => $value ) {
354  if ( $value !== null && $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 ( $cachedValue !== null ) {
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 
1045 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1046  if ( is_string( $version ) || $version === false ) {
1047  MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1048  } else {
1049  throw new Exception(
1050  "MediaWiki version must either be a string or false. " .
1051  "Example valid version: '1.33'"
1052  );
1053  }
1054 }
1055 
1066 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1067  MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1068 }
1069 
1079 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1080  MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1081 }
1082 
1089 
1091  $request = $context->getRequest();
1092 
1093  $profiler = Profiler::instance();
1094  $profiler->setContext( $context );
1095  $profiler->logData();
1096 
1097  // Send out any buffered statsd metrics as needed
1099  MediaWikiServices::getInstance()->getStatsdDataFactory(),
1100  $context->getConfig()
1101  );
1102 
1103  // Profiling must actually be enabled...
1104  if ( $profiler instanceof ProfilerStub ) {
1105  return;
1106  }
1107 
1108  if ( isset( $wgDebugLogGroups['profileoutput'] )
1109  && $wgDebugLogGroups['profileoutput'] === false
1110  ) {
1111  // Explicitly disabled
1112  return;
1113  }
1114  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1115  return;
1116  }
1117 
1118  $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1119  if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1120  $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1121  }
1122  if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1123  $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1124  }
1125  if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1126  $ctx['from'] = $_SERVER['HTTP_FROM'];
1127  }
1128  if ( isset( $ctx['forwarded_for'] ) ||
1129  isset( $ctx['client_ip'] ) ||
1130  isset( $ctx['from'] ) ) {
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  $services = MediaWikiServices::getInstance();
1225  if ( $langcode === true || $langcode === $wgLanguageCode ) {
1226  # $langcode is the language code of the wikis content language object.
1227  # or it is a boolean and value is true
1228  return $services->getContentLanguage();
1229  }
1230 
1231  global $wgLang;
1232  if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1233  # $langcode is the language code of user language object.
1234  # or it was a boolean and value is false
1235  return $wgLang;
1236  }
1237 
1238  $validCodes = array_keys( $services->getLanguageNameUtils()->getLanguageNames() );
1239  if ( in_array( $langcode, $validCodes ) ) {
1240  # $langcode corresponds to a valid language.
1241  return $services->getLanguageFactory()->getLanguage( $langcode );
1242  }
1243 
1244  # $langcode is a string, but not a valid language code; use content language.
1245  wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1246  return $services->getContentLanguage();
1247 }
1248 
1265 function wfMessage( $key, ...$params ) {
1266  $message = new Message( $key );
1267 
1268  // We call Message::params() to reduce code duplication
1269  if ( $params ) {
1270  $message->params( ...$params );
1271  }
1272 
1273  return $message;
1274 }
1275 
1288 function wfMessageFallback( ...$keys ) {
1289  return Message::newFallbackSequence( ...$keys );
1290 }
1291 
1300 function wfMsgReplaceArgs( $message, $args ) {
1301  # Fix windows line-endings
1302  # Some messages are split with explode("\n", $msg)
1303  $message = str_replace( "\r", '', $message );
1304 
1305  // Replace arguments
1306  if ( is_array( $args ) && $args ) {
1307  if ( is_array( $args[0] ) ) {
1308  $args = array_values( $args[0] );
1309  }
1310  $replacementKeys = [];
1311  foreach ( $args as $n => $param ) {
1312  $replacementKeys['$' . ( $n + 1 )] = $param;
1313  }
1314  $message = strtr( $message, $replacementKeys );
1315  }
1316 
1317  return $message;
1318 }
1319 
1327 function wfHostname() {
1328  static $host;
1329  if ( $host === null ) {
1330  # Hostname overriding
1331  global $wgOverrideHostname;
1332  if ( $wgOverrideHostname !== false ) {
1333  # Set static and skip any detection
1334  $host = $wgOverrideHostname;
1335  return $host;
1336  }
1337 
1338  if ( function_exists( 'posix_uname' ) ) {
1339  // This function not present on Windows
1340  $uname = posix_uname();
1341  } else {
1342  $uname = false;
1343  }
1344  if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1345  $host = $uname['nodename'];
1346  } elseif ( getenv( 'COMPUTERNAME' ) ) {
1347  # Windows computer name
1348  $host = getenv( 'COMPUTERNAME' );
1349  } else {
1350  # This may be a virtual server.
1351  $host = $_SERVER['SERVER_NAME'];
1352  }
1353  }
1354  return $host;
1355 }
1356 
1367 function wfReportTime( $nonce = null ) {
1368  global $wgShowHostnames;
1369 
1370  $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1371  // seconds to milliseconds
1372  $responseTime = round( $elapsed * 1000 );
1373  $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1374  if ( $wgShowHostnames ) {
1375  $reportVars['wgHostname'] = wfHostname();
1376  }
1377  return Skin::makeVariablesScript( $reportVars, $nonce );
1378 }
1379 
1390 function wfDebugBacktrace( $limit = 0 ) {
1391  static $disabled = null;
1392 
1393  if ( $disabled === null ) {
1394  $disabled = !function_exists( 'debug_backtrace' );
1395  if ( $disabled ) {
1396  wfDebug( "debug_backtrace() is disabled\n" );
1397  }
1398  }
1399  if ( $disabled ) {
1400  return [];
1401  }
1402 
1403  if ( $limit ) {
1404  return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1405  } else {
1406  return array_slice( debug_backtrace(), 1 );
1407  }
1408 }
1409 
1418 function wfBacktrace( $raw = null ) {
1419  global $wgCommandLineMode;
1420 
1421  if ( $raw === null ) {
1422  $raw = $wgCommandLineMode;
1423  }
1424 
1425  if ( $raw ) {
1426  $frameFormat = "%s line %s calls %s()\n";
1427  $traceFormat = "%s";
1428  } else {
1429  $frameFormat = "<li>%s line %s calls %s()</li>\n";
1430  $traceFormat = "<ul>\n%s</ul>\n";
1431  }
1432 
1433  $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1434  $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1435  $line = $frame['line'] ?? '-';
1436  $call = $frame['function'];
1437  if ( !empty( $frame['class'] ) ) {
1438  $call = $frame['class'] . $frame['type'] . $call;
1439  }
1440  return sprintf( $frameFormat, $file, $line, $call );
1441  }, wfDebugBacktrace() );
1442 
1443  return sprintf( $traceFormat, implode( '', $frames ) );
1444 }
1445 
1455 function wfGetCaller( $level = 2 ) {
1456  $backtrace = wfDebugBacktrace( $level + 1 );
1457  if ( isset( $backtrace[$level] ) ) {
1458  return wfFormatStackFrame( $backtrace[$level] );
1459  } else {
1460  return 'unknown';
1461  }
1462 }
1463 
1471 function wfGetAllCallers( $limit = 3 ) {
1472  $trace = array_reverse( wfDebugBacktrace() );
1473  if ( !$limit || $limit > count( $trace ) - 1 ) {
1474  $limit = count( $trace ) - 1;
1475  }
1476  $trace = array_slice( $trace, -$limit - 1, $limit );
1477  return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1478 }
1479 
1486 function wfFormatStackFrame( $frame ) {
1487  if ( !isset( $frame['function'] ) ) {
1488  return 'NO_FUNCTION_GIVEN';
1489  }
1490  return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1491  $frame['class'] . $frame['type'] . $frame['function'] :
1492  $frame['function'];
1493 }
1494 
1495 /* Some generic result counters, pulled out of SearchEngine */
1496 
1504 function wfShowingResults( $offset, $limit ) {
1505  return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1506 }
1507 
1517 function wfClientAcceptsGzip( $force = false ) {
1518  static $result = null;
1519  if ( $result === null || $force ) {
1520  $result = false;
1521  if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1522  # @todo FIXME: We may want to blacklist some broken browsers
1523  $m = [];
1524  if ( preg_match(
1525  '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1526  $_SERVER['HTTP_ACCEPT_ENCODING'],
1527  $m
1528  )
1529  ) {
1530  if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1531  $result = false;
1532  return $result;
1533  }
1534  wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1535  $result = true;
1536  }
1537  }
1538  }
1539  return $result;
1540 }
1541 
1552 function wfEscapeWikiText( $text ) {
1553  global $wgEnableMagicLinks;
1554  static $repl = null, $repl2 = null;
1555  if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1556  // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1557  // in those situations
1558  $repl = [
1559  '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1560  '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1561  '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1562  "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1563  "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1564  "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1565  "\n " => "\n&#32;", "\r " => "\r&#32;",
1566  "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1567  "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1568  "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1569  "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1570  '__' => '_&#95;', '://' => '&#58;//',
1571  ];
1572 
1573  $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1574  // We have to catch everything "\s" matches in PCRE
1575  foreach ( $magicLinks as $magic ) {
1576  $repl["$magic "] = "$magic&#32;";
1577  $repl["$magic\t"] = "$magic&#9;";
1578  $repl["$magic\r"] = "$magic&#13;";
1579  $repl["$magic\n"] = "$magic&#10;";
1580  $repl["$magic\f"] = "$magic&#12;";
1581  }
1582 
1583  // And handle protocols that don't use "://"
1584  global $wgUrlProtocols;
1585  $repl2 = [];
1586  foreach ( $wgUrlProtocols as $prot ) {
1587  if ( substr( $prot, -1 ) === ':' ) {
1588  $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1589  }
1590  }
1591  $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1592  }
1593  $text = substr( strtr( "\n$text", $repl ), 1 );
1594  $text = preg_replace( $repl2, '$1&#58;', $text );
1595  return $text;
1596 }
1597 
1608 function wfSetVar( &$dest, $source, $force = false ) {
1609  $temp = $dest;
1610  if ( $source !== null || $force ) {
1611  $dest = $source;
1612  }
1613  return $temp;
1614 }
1615 
1625 function wfSetBit( &$dest, $bit, $state = true ) {
1626  $temp = (bool)( $dest & $bit );
1627  if ( $state !== null ) {
1628  if ( $state ) {
1629  $dest |= $bit;
1630  } else {
1631  $dest &= ~$bit;
1632  }
1633  }
1634  return $temp;
1635 }
1636 
1643 function wfVarDump( $var ) {
1644  global $wgOut;
1645  $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1646  if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1647  print $s;
1648  } else {
1649  $wgOut->addHTML( $s );
1650  }
1651 }
1652 
1660 function wfHttpError( $code, $label, $desc ) {
1661  global $wgOut;
1662  HttpStatus::header( $code );
1663  if ( $wgOut ) {
1664  $wgOut->disable();
1665  $wgOut->sendCacheControl();
1666  }
1667 
1669  header( 'Content-type: text/html; charset=utf-8' );
1670  ob_start();
1671  print '<!DOCTYPE html>' .
1672  '<html><head><title>' .
1673  htmlspecialchars( $label ) .
1674  '</title></head><body><h1>' .
1675  htmlspecialchars( $label ) .
1676  '</h1><p>' .
1677  nl2br( htmlspecialchars( $desc ) ) .
1678  "</p></body></html>\n";
1679  header( 'Content-Length: ' . ob_get_length() );
1680  ob_end_flush();
1681 }
1682 
1700 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1701  if ( $resetGzipEncoding ) {
1702  // Suppress Content-Encoding and Content-Length
1703  // headers from OutputHandler::handle.
1706  }
1707  while ( $status = ob_get_status() ) {
1708  if ( isset( $status['flags'] ) ) {
1709  $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1710  $deleteable = ( $status['flags'] & $flags ) === $flags;
1711  } elseif ( isset( $status['del'] ) ) {
1712  $deleteable = $status['del'];
1713  } else {
1714  // Guess that any PHP-internal setting can't be removed.
1715  $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1716  }
1717  if ( !$deleteable ) {
1718  // Give up, and hope the result doesn't break
1719  // output behavior.
1720  break;
1721  }
1722  if ( $status['name'] === 'MediaWikiIntegrationTestCase::wfResetOutputBuffersBarrier' ) {
1723  // Unit testing barrier to prevent this function from breaking PHPUnit.
1724  break;
1725  }
1726  if ( !ob_end_clean() ) {
1727  // Could not remove output buffer handler; abort now
1728  // to avoid getting in some kind of infinite loop.
1729  break;
1730  }
1731  if ( $resetGzipEncoding && $status['name'] == 'ob_gzhandler' ) {
1732  // Reset the 'Content-Encoding' field set by this handler
1733  // so we can start fresh.
1734  header_remove( 'Content-Encoding' );
1735  break;
1736  }
1737  }
1738 }
1739 
1753  wfResetOutputBuffers( false );
1754 }
1755 
1764 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1765  # No arg means accept anything (per HTTP spec)
1766  if ( !$accept ) {
1767  return [ $def => 1.0 ];
1768  }
1769 
1770  $prefs = [];
1771 
1772  $parts = explode( ',', $accept );
1773 
1774  foreach ( $parts as $part ) {
1775  # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1776  $values = explode( ';', trim( $part ) );
1777  $match = [];
1778  if ( count( $values ) == 1 ) {
1779  $prefs[$values[0]] = 1.0;
1780  } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1781  $prefs[$values[0]] = floatval( $match[1] );
1782  }
1783  }
1784 
1785  return $prefs;
1786 }
1787 
1800 function mimeTypeMatch( $type, $avail ) {
1801  if ( array_key_exists( $type, $avail ) ) {
1802  return $type;
1803  } else {
1804  $mainType = explode( '/', $type )[0];
1805  if ( array_key_exists( "$mainType/*", $avail ) ) {
1806  return "$mainType/*";
1807  } elseif ( array_key_exists( '*/*', $avail ) ) {
1808  return '*/*';
1809  } else {
1810  return null;
1811  }
1812  }
1813 }
1814 
1829 function wfNegotiateType( $cprefs, $sprefs ) {
1830  $combine = [];
1831 
1832  foreach ( array_keys( $sprefs ) as $type ) {
1833  $subType = explode( '/', $type )[1];
1834  if ( $subType != '*' ) {
1835  $ckey = mimeTypeMatch( $type, $cprefs );
1836  if ( $ckey ) {
1837  $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1838  }
1839  }
1840  }
1841 
1842  foreach ( array_keys( $cprefs ) as $type ) {
1843  $subType = explode( '/', $type )[1];
1844  if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1845  $skey = mimeTypeMatch( $type, $sprefs );
1846  if ( $skey ) {
1847  $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1848  }
1849  }
1850  }
1851 
1852  $bestq = 0;
1853  $besttype = null;
1854 
1855  foreach ( array_keys( $combine ) as $type ) {
1856  if ( $combine[$type] > $bestq ) {
1857  $besttype = $type;
1858  $bestq = $combine[$type];
1859  }
1860  }
1861 
1862  return $besttype;
1863 }
1864 
1873 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1874  $ret = MWTimestamp::convert( $outputtype, $ts );
1875  if ( $ret === false ) {
1876  wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1877  }
1878  return $ret;
1879 }
1880 
1889 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1890  if ( $ts === null ) {
1891  return null;
1892  } else {
1893  return wfTimestamp( $outputtype, $ts );
1894  }
1895 }
1896 
1902 function wfTimestampNow() {
1903  return MWTimestamp::now( TS_MW );
1904 }
1905 
1911 function wfIsWindows() {
1912  static $isWindows = null;
1913  if ( $isWindows === null ) {
1914  $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
1915  }
1916  return $isWindows;
1917 }
1918 
1925 function wfIsHHVM() {
1926  wfDeprecated( __FUNCTION__, '1.34' );
1927  return false;
1928 }
1929 
1936 function wfIsCLI() {
1937  return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
1938 }
1939 
1951 function wfTempDir() {
1952  global $wgTmpDirectory;
1953 
1954  if ( $wgTmpDirectory !== false ) {
1955  return $wgTmpDirectory;
1956  }
1957 
1959 }
1960 
1970 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
1971  global $wgDirectoryMode;
1972 
1973  if ( FileBackend::isStoragePath( $dir ) ) { // sanity
1974  throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
1975  }
1976 
1977  if ( $caller !== null ) {
1978  wfDebug( "$caller: called wfMkdirParents($dir)\n" );
1979  }
1980 
1981  if ( strval( $dir ) === '' || is_dir( $dir ) ) {
1982  return true;
1983  }
1984 
1985  $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
1986 
1987  if ( $mode === null ) {
1988  $mode = $wgDirectoryMode;
1989  }
1990 
1991  // Turn off the normal warning, we're doing our own below
1992  AtEase::suppressWarnings();
1993  $ok = mkdir( $dir, $mode, true ); // PHP5 <3
1994  AtEase::restoreWarnings();
1995 
1996  if ( !$ok ) {
1997  // directory may have been created on another request since we last checked
1998  if ( is_dir( $dir ) ) {
1999  return true;
2000  }
2001 
2002  // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2003  wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2004  }
2005  return $ok;
2006 }
2007 
2013 function wfRecursiveRemoveDir( $dir ) {
2014  wfDebug( __FUNCTION__ . "( $dir )\n" );
2015  // taken from https://www.php.net/manual/en/function.rmdir.php#98622
2016  if ( is_dir( $dir ) ) {
2017  $objects = scandir( $dir );
2018  foreach ( $objects as $object ) {
2019  if ( $object != "." && $object != ".." ) {
2020  if ( filetype( $dir . '/' . $object ) == "dir" ) {
2021  wfRecursiveRemoveDir( $dir . '/' . $object );
2022  } else {
2023  unlink( $dir . '/' . $object );
2024  }
2025  }
2026  }
2027  reset( $objects );
2028  rmdir( $dir );
2029  }
2030 }
2031 
2038 function wfPercent( $nr, $acc = 2, $round = true ) {
2039  $ret = sprintf( "%.${acc}f", $nr );
2040  return $round ? round( (float)$ret, $acc ) . '%' : "$ret%";
2041 }
2042 
2066 function wfIniGetBool( $setting ) {
2067  return wfStringToBool( ini_get( $setting ) );
2068 }
2069 
2082 function wfStringToBool( $val ) {
2083  $val = strtolower( $val );
2084  // 'on' and 'true' can't have whitespace around them, but '1' can.
2085  return $val == 'on'
2086  || $val == 'true'
2087  || $val == 'yes'
2088  || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2089 }
2090 
2103 function wfEscapeShellArg( ...$args ) {
2104  return Shell::escape( ...$args );
2105 }
2106 
2131 function wfShellExec( $cmd, &$retval = null, $environ = [],
2132  $limits = [], $options = []
2133 ) {
2134  if ( Shell::isDisabled() ) {
2135  $retval = 1;
2136  // Backwards compatibility be upon us...
2137  return 'Unable to run external programs, proc_open() is disabled.';
2138  }
2139 
2140  if ( is_array( $cmd ) ) {
2141  $cmd = Shell::escape( $cmd );
2142  }
2143 
2144  $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2145  $profileMethod = $options['profileMethod'] ?? wfGetCaller();
2146 
2147  try {
2148  $result = Shell::command( [] )
2149  ->unsafeParams( (array)$cmd )
2150  ->environment( $environ )
2151  ->limits( $limits )
2152  ->includeStderr( $includeStderr )
2153  ->profileMethod( $profileMethod )
2154  // For b/c
2155  ->restrict( Shell::RESTRICT_NONE )
2156  ->execute();
2157  } catch ( ProcOpenError $ex ) {
2158  $retval = -1;
2159  return '';
2160  }
2161 
2162  $retval = $result->getExitCode();
2163 
2164  return $result->getStdout();
2165 }
2166 
2184 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2185  return wfShellExec( $cmd, $retval, $environ, $limits,
2186  [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2187 }
2188 
2204 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2205  global $wgPhpCli;
2206  // Give site config file a chance to run the script in a wrapper.
2207  // The caller may likely want to call wfBasename() on $script.
2208  Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2209  $cmd = [ $options['php'] ?? $wgPhpCli ];
2210  if ( isset( $options['wrapper'] ) ) {
2211  $cmd[] = $options['wrapper'];
2212  }
2213  $cmd[] = $script;
2214  // Escape each parameter for shell
2215  return Shell::escape( array_merge( $cmd, $parameters ) );
2216 }
2217 
2229 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2230  global $wgDiff3;
2231 
2232  # This check may also protect against code injection in
2233  # case of broken installations.
2234  AtEase::suppressWarnings();
2235  $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2236  AtEase::restoreWarnings();
2237 
2238  if ( !$haveDiff3 ) {
2239  wfDebug( "diff3 not found\n" );
2240  return false;
2241  }
2242 
2243  # Make temporary files
2244  $td = wfTempDir();
2245  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2246  $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2247  $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2248 
2249  # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2250  # a newline character. To avoid this, we normalize the trailing whitespace before
2251  # creating the diff.
2252 
2253  fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2254  fclose( $oldtextFile );
2255  fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2256  fclose( $mytextFile );
2257  fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2258  fclose( $yourtextFile );
2259 
2260  # Check for a conflict
2261  $cmd = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2262  $oldtextName, $yourtextName );
2263  $handle = popen( $cmd, 'r' );
2264 
2265  $mergeAttemptResult = '';
2266  do {
2267  $data = fread( $handle, 8192 );
2268  if ( strlen( $data ) == 0 ) {
2269  break;
2270  }
2271  $mergeAttemptResult .= $data;
2272  } while ( true );
2273  pclose( $handle );
2274 
2275  $conflict = $mergeAttemptResult !== '';
2276 
2277  # Merge differences
2278  $cmd = Shell::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2279  $oldtextName, $yourtextName );
2280  $handle = popen( $cmd, 'r' );
2281  $result = '';
2282  do {
2283  $data = fread( $handle, 8192 );
2284  if ( strlen( $data ) == 0 ) {
2285  break;
2286  }
2287  $result .= $data;
2288  } while ( true );
2289  pclose( $handle );
2290  unlink( $mytextName );
2291  unlink( $oldtextName );
2292  unlink( $yourtextName );
2293 
2294  if ( $result === '' && $old !== '' && !$conflict ) {
2295  wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2296  $conflict = true;
2297  }
2298  return !$conflict;
2299 }
2300 
2312 function wfDiff( $before, $after, $params = '-u' ) {
2313  if ( $before == $after ) {
2314  return '';
2315  }
2316 
2317  global $wgDiff;
2318  AtEase::suppressWarnings();
2319  $haveDiff = $wgDiff && file_exists( $wgDiff );
2320  AtEase::restoreWarnings();
2321 
2322  # This check may also protect against code injection in
2323  # case of broken installations.
2324  if ( !$haveDiff ) {
2325  wfDebug( "diff executable not found\n" );
2326  $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2327  $format = new UnifiedDiffFormatter();
2328  return $format->format( $diffs );
2329  }
2330 
2331  # Make temporary files
2332  $td = wfTempDir();
2333  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2334  $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2335 
2336  fwrite( $oldtextFile, $before );
2337  fclose( $oldtextFile );
2338  fwrite( $newtextFile, $after );
2339  fclose( $newtextFile );
2340 
2341  // Get the diff of the two files
2342  $cmd = "$wgDiff " . $params . ' ' . Shell::escape( $oldtextName, $newtextName );
2343 
2344  $h = popen( $cmd, 'r' );
2345  if ( !$h ) {
2346  unlink( $oldtextName );
2347  unlink( $newtextName );
2348  throw new Exception( __FUNCTION__ . '(): popen() failed' );
2349  }
2350 
2351  $diff = '';
2352 
2353  do {
2354  $data = fread( $h, 8192 );
2355  if ( strlen( $data ) == 0 ) {
2356  break;
2357  }
2358  $diff .= $data;
2359  } while ( true );
2360 
2361  // Clean up
2362  pclose( $h );
2363  unlink( $oldtextName );
2364  unlink( $newtextName );
2365 
2366  // Kill the --- and +++ lines. They're not useful.
2367  $diff_lines = explode( "\n", $diff );
2368  if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2369  unset( $diff_lines[0] );
2370  }
2371  if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2372  unset( $diff_lines[1] );
2373  }
2374 
2375  $diff = implode( "\n", $diff_lines );
2376 
2377  return $diff;
2378 }
2379 
2392 function wfBaseName( $path, $suffix = '' ) {
2393  if ( $suffix == '' ) {
2394  $encSuffix = '';
2395  } else {
2396  $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2397  }
2398 
2399  $matches = [];
2400  if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2401  return $matches[1];
2402  } else {
2403  return '';
2404  }
2405 }
2406 
2416 function wfRelativePath( $path, $from ) {
2417  // Normalize mixed input on Windows...
2418  $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2419  $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2420 
2421  // Trim trailing slashes -- fix for drive root
2422  $path = rtrim( $path, DIRECTORY_SEPARATOR );
2423  $from = rtrim( $from, DIRECTORY_SEPARATOR );
2424 
2425  $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2426  $against = explode( DIRECTORY_SEPARATOR, $from );
2427 
2428  if ( $pieces[0] !== $against[0] ) {
2429  // Non-matching Windows drive letters?
2430  // Return a full path.
2431  return $path;
2432  }
2433 
2434  // Trim off common prefix
2435  while ( count( $pieces ) && count( $against )
2436  && $pieces[0] == $against[0] ) {
2437  array_shift( $pieces );
2438  array_shift( $against );
2439  }
2440 
2441  // relative dots to bump us to the parent
2442  while ( count( $against ) ) {
2443  array_unshift( $pieces, '..' );
2444  array_shift( $against );
2445  }
2446 
2447  array_push( $pieces, wfBaseName( $path ) );
2448 
2449  return implode( DIRECTORY_SEPARATOR, $pieces );
2450 }
2451 
2461 function wfSetupSession( $sessionId = false ) {
2462  wfDeprecated( __FUNCTION__, '1.27' );
2463 
2464  if ( $sessionId ) {
2465  session_id( $sessionId );
2466  }
2467 
2468  $session = SessionManager::getGlobalSession();
2469  $session->persist();
2470 
2471  if ( session_id() !== $session->getId() ) {
2472  session_id( $session->getId() );
2473  }
2474  AtEase::quietCall( 'session_start' );
2475 }
2476 
2483 function wfGetPrecompiledData( $name ) {
2484  global $IP;
2485 
2486  $file = "$IP/serialized/$name";
2487  if ( file_exists( $file ) ) {
2488  $blob = file_get_contents( $file );
2489  if ( $blob ) {
2490  return unserialize( $blob );
2491  }
2492  }
2493  return false;
2494 }
2495 
2503 function wfMemcKey( ...$args ) {
2504  return ObjectCache::getLocalClusterInstance()->makeKey( ...$args );
2505 }
2506 
2517 function wfForeignMemcKey( $db, $prefix, ...$args ) {
2518  $keyspace = $prefix ? "$db-$prefix" : $db;
2519  return ObjectCache::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2520 }
2521 
2529 function wfWikiID() {
2530  global $wgDBprefix, $wgDBname;
2531 
2532  if ( $wgDBprefix ) {
2533  return "$wgDBname-$wgDBprefix";
2534  } else {
2535  return $wgDBname;
2536  }
2537 }
2538 
2564 function wfGetDB( $db, $groups = [], $wiki = false ) {
2565  return wfGetLB( $wiki )->getMaintenanceConnectionRef( $db, $groups, $wiki );
2566 }
2567 
2577 function wfGetLB( $wiki = false ) {
2578  if ( $wiki === false ) {
2579  return MediaWikiServices::getInstance()->getDBLoadBalancer();
2580  } else {
2581  $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2582  return $factory->getMainLB( $wiki );
2583  }
2584 }
2585 
2593 function wfFindFile( $title, $options = [] ) {
2594  return MediaWikiServices::getInstance()->getRepoGroup()->findFile( $title, $options );
2595 }
2596 
2605 function wfLocalFile( $title ) {
2606  return MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()->newFile( $title );
2607 }
2608 
2616  global $wgMiserMode;
2617  return $wgMiserMode
2618  || ( SiteStats::pages() > 100000
2619  && SiteStats::edits() > 1000000
2620  && SiteStats::users() > 10000 );
2621 }
2622 
2631 function wfScript( $script = 'index' ) {
2633  if ( $script === 'index' ) {
2634  return $wgScript;
2635  } elseif ( $script === 'load' ) {
2636  return $wgLoadScript;
2637  } else {
2638  return "{$wgScriptPath}/{$script}.php";
2639  }
2640 }
2641 
2647 function wfGetScriptUrl() {
2648  if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2649  /* as it was called, minus the query string.
2650  *
2651  * Some sites use Apache rewrite rules to handle subdomains,
2652  * and have PHP set up in a weird way that causes PHP_SELF
2653  * to contain the rewritten URL instead of the one that the
2654  * outside world sees.
2655  *
2656  * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2657  * provides containing the "before" URL.
2658  */
2659  return $_SERVER['SCRIPT_NAME'];
2660  } else {
2661  return $_SERVER['URL'];
2662  }
2663 }
2664 
2672 function wfBoolToStr( $value ) {
2673  return $value ? 'true' : 'false';
2674 }
2675 
2681 function wfGetNull() {
2682  return wfIsWindows() ? 'NUL' : '/dev/null';
2683 }
2684 
2708  $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2709 ) {
2710  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2711 
2712  if ( $cluster === '*' ) {
2713  $cluster = false;
2714  $domain = false;
2715  } elseif ( $wiki === false ) {
2716  $domain = $lbFactory->getLocalDomainID();
2717  } else {
2718  $domain = $wiki;
2719  }
2720 
2721  $opts = [
2722  'domain' => $domain,
2723  'cluster' => $cluster,
2724  // B/C: first argument used to be "max seconds of lag"; ignore such values
2725  'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
2726  ];
2727  if ( $timeout !== null ) {
2728  $opts['timeout'] = $timeout;
2729  }
2730 
2731  return $lbFactory->waitForReplication( $opts );
2732 }
2733 
2742 function wfStripIllegalFilenameChars( $name ) {
2743  global $wgIllegalFileChars;
2744  $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
2745  $name = preg_replace(
2746  "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
2747  '-',
2748  $name
2749  );
2750  // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2751  $name = wfBaseName( $name );
2752  return $name;
2753 }
2754 
2761 function wfMemoryLimit( $newLimit ) {
2762  $oldLimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2763  // If the INI config is already unlimited, there is nothing larger
2764  if ( $oldLimit != -1 ) {
2765  $newLimit = wfShorthandToInteger( $newLimit );
2766  if ( $newLimit == -1 ) {
2767  wfDebug( "Removing PHP's memory limit\n" );
2768  Wikimedia\suppressWarnings();
2769  ini_set( 'memory_limit', $newLimit );
2770  Wikimedia\restoreWarnings();
2771  } elseif ( $newLimit > $oldLimit ) {
2772  wfDebug( "Raising PHP's memory limit to $newLimit bytes\n" );
2773  Wikimedia\suppressWarnings();
2774  ini_set( 'memory_limit', $newLimit );
2775  Wikimedia\restoreWarnings();
2776  }
2777  }
2778 }
2779 
2788 
2789  $timeLimit = (int)ini_get( 'max_execution_time' );
2790  // Note that CLI scripts use 0
2791  if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2792  set_time_limit( $wgTransactionalTimeLimit );
2793  }
2794 
2795  ignore_user_abort( true ); // ignore client disconnects
2796 
2797  return $timeLimit;
2798 }
2799 
2807 function wfShorthandToInteger( $string = '', $default = -1 ) {
2808  $string = trim( $string );
2809  if ( $string === '' ) {
2810  return $default;
2811  }
2812  $last = $string[strlen( $string ) - 1];
2813  $val = intval( $string );
2814  switch ( $last ) {
2815  case 'g':
2816  case 'G':
2817  $val *= 1024;
2818  // break intentionally missing
2819  case 'm':
2820  case 'M':
2821  $val *= 1024;
2822  // break intentionally missing
2823  case 'k':
2824  case 'K':
2825  $val *= 1024;
2826  }
2827 
2828  return $val;
2829 }
2830 
2838 function wfGetCache( $cacheType ) {
2839  return ObjectCache::getInstance( $cacheType );
2840 }
2841 
2848 function wfGetMainCache() {
2850 }
2851 
2866 function wfUnpack( $format, $data, $length = false ) {
2867  if ( $length !== false ) {
2868  $realLen = strlen( $data );
2869  if ( $realLen < $length ) {
2870  throw new MWException( "Tried to use wfUnpack on a "
2871  . "string of length $realLen, but needed one "
2872  . "of at least length $length."
2873  );
2874  }
2875  }
2876 
2877  Wikimedia\suppressWarnings();
2878  $result = unpack( $format, $data );
2879  Wikimedia\restoreWarnings();
2880 
2881  if ( $result === false ) {
2882  // If it cannot extract the packed data.
2883  throw new MWException( "unpack could not unpack binary data" );
2884  }
2885  return $result;
2886 }
2887 
2904 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
2905  $services = MediaWikiServices::getInstance();
2906  if ( $blacklist !== null ) {
2907  wfDeprecated( __FUNCTION__ . ' with $blacklist parameter', '1.34' );
2908  return ( new BadFileLookup(
2909  function () use ( $blacklist ) {
2910  return $blacklist;
2911  },
2912  $services->getLocalServerObjectCache(),
2913  $services->getRepoGroup(),
2914  $services->getTitleParser()
2915  ) )->isBadFile( $name, $contextTitle ?: null );
2916  }
2917  return $services->getBadFileLookup()->isBadFile( $name, $contextTitle ?: null );
2918 }
2919 
2927 function wfCanIPUseHTTPS( $ip ) {
2928  $canDo = true;
2929  Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
2930  return (bool)$canDo;
2931 }
2932 
2940 function wfIsInfinity( $str ) {
2941  // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
2942  $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
2943  return in_array( $str, $infinityValues );
2944 }
2945 
2960 function wfThumbIsStandard( File $file, array $params ) {
2962 
2963  $multipliers = [ 1 ];
2964  if ( $wgResponsiveImages ) {
2965  // These available sizes are hardcoded currently elsewhere in MediaWiki.
2966  // @see Linker::processResponsiveImages
2967  $multipliers[] = 1.5;
2968  $multipliers[] = 2;
2969  }
2970 
2971  $handler = $file->getHandler();
2972  if ( !$handler || !isset( $params['width'] ) ) {
2973  return false;
2974  }
2975 
2976  $basicParams = [];
2977  if ( isset( $params['page'] ) ) {
2978  $basicParams['page'] = $params['page'];
2979  }
2980 
2981  $thumbLimits = [];
2982  $imageLimits = [];
2983  // Expand limits to account for multipliers
2984  foreach ( $multipliers as $multiplier ) {
2985  $thumbLimits = array_merge( $thumbLimits, array_map(
2986  function ( $width ) use ( $multiplier ) {
2987  return round( $width * $multiplier );
2988  }, $wgThumbLimits )
2989  );
2990  $imageLimits = array_merge( $imageLimits, array_map(
2991  function ( $pair ) use ( $multiplier ) {
2992  return [
2993  round( $pair[0] * $multiplier ),
2994  round( $pair[1] * $multiplier ),
2995  ];
2996  }, $wgImageLimits )
2997  );
2998  }
2999 
3000  // Check if the width matches one of $wgThumbLimits
3001  if ( in_array( $params['width'], $thumbLimits ) ) {
3002  $normalParams = $basicParams + [ 'width' => $params['width'] ];
3003  // Append any default values to the map (e.g. "lossy", "lossless", ...)
3004  $handler->normaliseParams( $file, $normalParams );
3005  } else {
3006  // If not, then check if the width matchs one of $wgImageLimits
3007  $match = false;
3008  foreach ( $imageLimits as $pair ) {
3009  $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3010  // Decide whether the thumbnail should be scaled on width or height.
3011  // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3012  $handler->normaliseParams( $file, $normalParams );
3013  // Check if this standard thumbnail size maps to the given width
3014  if ( $normalParams['width'] == $params['width'] ) {
3015  $match = true;
3016  break;
3017  }
3018  }
3019  if ( !$match ) {
3020  return false; // not standard for description pages
3021  }
3022  }
3023 
3024  // Check that the given values for non-page, non-width, params are just defaults
3025  foreach ( $params as $key => $value ) {
3026  if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3027  return false;
3028  }
3029  }
3030 
3031  return true;
3032 }
3033 
3046 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3047  // First merge items that are in both arrays
3048  foreach ( $baseArray as $name => &$groupVal ) {
3049  if ( isset( $newValues[$name] ) ) {
3050  $groupVal += $newValues[$name];
3051  }
3052  }
3053  // Now add items that didn't exist yet
3054  $baseArray += $newValues;
3055 
3056  return $baseArray;
3057 }
3058 
3068 function wfGetRusage() {
3069  wfDeprecated( __FUNCTION__, '1.35' );
3070  return getrusage( 0 /* RUSAGE_SELF */ );
3071 }
$wgPhpCli
$wgPhpCli
Executable path of the PHP cli binary.
Definition: DefaultSettings.php:8326
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:2038
wfResetOutputBuffers
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
Definition: GlobalFunctions.php:1700
wfMessageFallback
wfMessageFallback(... $keys)
This function accepts multiple message keys and returns a message instance for the first message whic...
Definition: GlobalFunctions.php:1288
$wgThumbLimits
$wgThumbLimits
Adjust thumbnails on image pages according to a user setting.
Definition: DefaultSettings.php:1513
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:2927
ObjectCache\getLocalClusterInstance
static getLocalClusterInstance()
Get the main cluster-local cache object.
Definition: ObjectCache.php:267
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:1077
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:2312
$wgResponsiveImages
$wgResponsiveImages
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
Definition: DefaultSettings.php:1632
wfSetupSession
wfSetupSession( $sessionId=false)
Initialise php session.
Definition: GlobalFunctions.php:2461
$wgDebugRawPage
$wgDebugRawPage
If true, log debugging data from action=raw and load.php.
Definition: DefaultSettings.php:6148
wfThumbIsStandard
wfThumbIsStandard(File $file, array $params)
Returns true if these thumbnail parameters match one that MediaWiki requests from file description pa...
Definition: GlobalFunctions.php:2960
$wgTmpDirectory
$wgTmpDirectory
The local filesystem path to a temporary directory.
Definition: DefaultSettings.php:378
wfArrayPlus2d
wfArrayPlus2d(array $baseArray, array $newValues)
Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
Definition: GlobalFunctions.php:3046
$wgDBname
$wgDBname
Current wiki database name.
Definition: DefaultSettings.php:1932
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:1970
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:134
MediaWiki\BadFileLookup
Definition: BadFileLookup.php:12
$wgDiff3
$wgDiff3
Path to the GNU diff3 utility.
Definition: DefaultSettings.php:6664
wfMerge
wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult=null)
wfMerge attempts to merge differences between three texts.
Definition: GlobalFunctions.php:2229
wfDebugBacktrace
wfDebugBacktrace( $limit=0)
Safety wrapper for debug_backtrace().
Definition: GlobalFunctions.php:1390
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:1608
wfGetLB
wfGetLB( $wiki=false)
Get a load balancer object.
Definition: GlobalFunctions.php:2577
wfFormatStackFrame
wfFormatStackFrame( $frame)
Return a string representation of frame.
Definition: GlobalFunctions.php:1486
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:1625
Skin\makeVariablesScript
static makeVariablesScript( $data, $nonce=null)
Definition: Skin.php:400
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:1829
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1873
SiteStats\pages
static pages()
Definition: SiteStats.php:112
wfUnpack
wfUnpack( $format, $data, $length=false)
Wrapper around php's unpack.
Definition: GlobalFunctions.php:2866
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:6346
wfMemoryLimit
wfMemoryLimit( $newLimit)
Raise PHP's memory limit (if needed).
Definition: GlobalFunctions.php:2761
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:2647
ProfilerStub
Stub profiler that does nothing.
Definition: ProfilerStub.php:26
$wgDiff
$wgDiff
Path to the GNU diff utility.
Definition: DefaultSettings.php:6669
wfBaseName
wfBaseName( $path, $suffix='')
Return the final portion of a pathname.
Definition: GlobalFunctions.php:2392
wfQueriesMustScale
wfQueriesMustScale()
Should low-performance queries be disabled?
Definition: GlobalFunctions.php:2615
$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:1327
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:1300
wfMessage
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Definition: GlobalFunctions.php:1265
$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:1079
wfStringToBool
wfStringToBool( $val)
Convert string value to boolean, when the following are interpreted as true:
Definition: GlobalFunctions.php:2082
$wgTransactionalTimeLimit
$wgTransactionalTimeLimit
The minimum amount of time that MediaWiki needs for "slow" write request, particularly ones with mult...
Definition: DefaultSettings.php:2343
Message
$wgDebugLogPrefix
$wgDebugLogPrefix
Prefix for debug log lines.
Definition: DefaultSettings.php:6134
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:2707
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:1952
wfShellWikiCmd
wfShellWikiCmd( $script, array $parameters=[], array $options=[])
Generate a shell-escaped command line string to run a MediaWiki cli script.
Definition: GlobalFunctions.php:2204
wfBoolToStr
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
Definition: GlobalFunctions.php:2672
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:130
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:1367
wfGetMainCache
wfGetMainCache()
Get the main cache object.
Definition: GlobalFunctions.php:2848
MWException
MediaWiki exception.
Definition: MWException.php:26
wfStripIllegalFilenameChars
wfStripIllegalFilenameChars( $name)
Replace all invalid characters with '-'.
Definition: GlobalFunctions.php:2742
wfGetRusage
wfGetRusage()
Get system resource usage of current request context.
Definition: GlobalFunctions.php:3068
mimeTypeMatch
mimeTypeMatch( $type, $avail)
Checks if a given MIME type matches any of the keys in the given array.
Definition: GlobalFunctions.php:1800
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Logs a warning that $function is deprecated.
Definition: GlobalFunctions.php:1045
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:2631
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:1519
$blob
$blob
Definition: testCompression.php:67
wfTransactionalTimeLimit
wfTransactionalTimeLimit()
Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit.
Definition: GlobalFunctions.php:2786
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2564
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:6257
$wgLang
$wgLang
Definition: Setup.php:852
$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:1889
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:78
$args
if( $line===false) $args
Definition: mcc.php:124
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:36
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:2838
$wgEnableMagicLinks
$wgEnableMagicLinks
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links.
Definition: DefaultSettings.php:4354
wfTimestampNow
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
Definition: GlobalFunctions.php:1902
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:1764
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:2517
UnifiedDiffFormatter
A formatter that outputs unified diffs.
Definition: UnifiedDiffFormatter.php:31
$wgDebugTimestamps
$wgDebugTimestamps
Prefix debug messages with relative timestamp.
Definition: DefaultSettings.php:6295
wfUrlProtocols
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
Definition: GlobalFunctions.php:719
wfIsBadImage
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the 'bad image list'.
Definition: GlobalFunctions.php:2904
wfLoadExtensions
wfLoadExtensions(array $exts)
Load multiple extensions at once.
Definition: GlobalFunctions.php:68
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2529
wfClearOutputBuffers
wfClearOutputBuffers()
More legible than passing a 'false' parameter to wfResetOutputBuffers():
Definition: GlobalFunctions.php:1752
wfClientAcceptsGzip
wfClientAcceptsGzip( $force=false)
Whether the client accept gzip encoding.
Definition: GlobalFunctions.php:1517
$wgUrlProtocols
$wgUrlProtocols
URL schemes that should be recognized as valid by wfParseUrl().
Definition: DefaultSettings.php:4191
$wgExtensionDirectory
$wgExtensionDirectory
Filesystem extensions directory.
Definition: DefaultSettings.php:229
wfIsCLI
wfIsCLI()
Check if we are running from the commandline.
Definition: GlobalFunctions.php:1936
wfIsWindows
wfIsWindows()
Check if the operating system is Windows.
Definition: GlobalFunctions.php:1911
$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
$line
$line
Definition: mcc.php:119
$wgLanguageCode
$wgLanguageCode
Site language code.
Definition: DefaultSettings.php:2988
wfIsInfinity
wfIsInfinity( $str)
Determine input string is represents as infinity.
Definition: GlobalFunctions.php:2940
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:1624
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1552
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:3429
wfVarDump
wfVarDump( $var)
A wrapper around the PHP function var_export().
Definition: GlobalFunctions.php:1643
$wgIllegalFileChars
$wgIllegalFileChars
Additional characters that are not allowed in filenames.
Definition: DefaultSettings.php:457
wfGetNull
wfGetNull()
Get a platform-independent path to the null file, e.g.
Definition: GlobalFunctions.php:2681
TempFSFile\getUsableTempDirectory
static getUsableTempDirectory()
Definition: TempFSFile.php:80
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:451
wfIniGetBool
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
Definition: GlobalFunctions.php:2066
$wgOverrideHostname
$wgOverrideHostname
Override server hostname detection with a hardcoded value.
Definition: DefaultSettings.php:6353
wfFindFile
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:2593
$context
$context
Definition: load.php:43
wfGetAllCallers
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
Definition: GlobalFunctions.php:1471
wfLoadExtension
wfLoadExtension( $ext, $path=null)
Load an extension.
Definition: GlobalFunctions.php:47
unserialize
unserialize( $serialized)
Definition: ApiMessageTrait.php:146
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:2807
$wgImageLimits
$wgImageLimits
Limit images on image description pages to a user-selectable limit.
Definition: DefaultSettings.php:1500
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:1951
$wgMiserMode
$wgMiserMode
Disable database-intensive features.
Definition: DefaultSettings.php:2299
wfHttpError
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
Definition: GlobalFunctions.php:1660
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:2483
wfRecursiveRemoveDir
wfRecursiveRemoveDir( $dir)
Remove a directory and all its content.
Definition: GlobalFunctions.php:2013
$wgHttpsPort
$wgHttpsPort
For installations where the canonical server is HTTP but HTTPS is optionally supported,...
Definition: DefaultSettings.php:8661
$path
$path
Definition: NoLocalSettings.php:25
$keys
$keys
Definition: testCompression.php:69
wfBacktrace
wfBacktrace( $raw=null)
Get a debug backtrace as a string.
Definition: GlobalFunctions.php:1418
wfEscapeShellArg
wfEscapeShellArg(... $args)
Version of escapeshellarg() that works better on Windows.
Definition: GlobalFunctions.php:2103
$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:2416
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:1066
Title\legalChars
static legalChars()
Get a regex character class describing the legal characters in a link.
Definition: Title.php:710
$wgRequest
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:719
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:2503
$wgOut
$wgOut
Definition: Setup.php:857
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:1925
$wgScriptPath
$wgScriptPath
The path we should point to.
Definition: DefaultSettings.php:137
$IP
$IP
Definition: WebStart.php:49
wfLocalFile
wfLocalFile( $title)
Get an object referring to a locally registered file.
Definition: GlobalFunctions.php:2605
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:1504
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:1455
$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:2802
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:2184
MediaWiki\HeaderCallback\warnIfHeadersSent
static warnIfHeadersSent()
Log a warning message if headers have already been sent.
Definition: HeaderCallback.php:70
wfLogProfilingData
wfLogProfilingData()
Definition: GlobalFunctions.php:1087
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:2131
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:50