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 
45 function wfLoadExtension( $ext, $path = null ) {
46  if ( !$path ) {
47  global $wgExtensionDirectory;
48  $path = "$wgExtensionDirectory/$ext/extension.json";
49  }
51 }
52 
66 function wfLoadExtensions( array $exts ) {
67  global $wgExtensionDirectory;
68  $registry = ExtensionRegistry::getInstance();
69  foreach ( $exts as $ext ) {
70  $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
71  }
72 }
73 
82 function wfLoadSkin( $skin, $path = null ) {
83  if ( !$path ) {
84  global $wgStyleDirectory;
85  $path = "$wgStyleDirectory/$skin/skin.json";
86  }
88 }
89 
97 function wfLoadSkins( array $skins ) {
98  global $wgStyleDirectory;
99  $registry = ExtensionRegistry::getInstance();
100  foreach ( $skins as $skin ) {
101  $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
102  }
103 }
104 
111 function wfArrayDiff2( $a, $b ) {
112  return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
113 }
114 
120 function wfArrayDiff2_cmp( $a, $b ) {
121  if ( is_string( $a ) && is_string( $b ) ) {
122  return strcmp( $a, $b );
123  } elseif ( count( $a ) !== count( $b ) ) {
124  return count( $a ) <=> count( $b );
125  } else {
126  reset( $a );
127  reset( $b );
128  while ( key( $a ) !== null && key( $b ) !== null ) {
129  $valueA = current( $a );
130  $valueB = current( $b );
131  $cmp = strcmp( $valueA, $valueB );
132  if ( $cmp !== 0 ) {
133  return $cmp;
134  }
135  next( $a );
136  next( $b );
137  }
138  return 0;
139  }
140 }
141 
150 function wfArrayFilter( array $arr, callable $callback ) {
151  wfDeprecated( __FUNCTION__, '1.32' );
152  return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH );
153 }
154 
163 function wfArrayFilterByKey( array $arr, callable $callback ) {
164  wfDeprecated( __FUNCTION__, '1.32' );
165  return array_filter( $arr, $callback, ARRAY_FILTER_USE_KEY );
166 }
167 
177 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
178  if ( is_null( $changed ) ) {
179  throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
180  }
181  if ( $default[$key] !== $value ) {
182  $changed[$key] = $value;
183  }
184 }
185 
205 function wfMergeErrorArrays( ...$args ) {
206  $out = [];
207  foreach ( $args as $errors ) {
208  foreach ( $errors as $params ) {
209  $originalParams = $params;
210  if ( $params[0] instanceof MessageSpecifier ) {
211  $msg = $params[0];
212  $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
213  }
214  # @todo FIXME: Sometimes get nested arrays for $params,
215  # which leads to E_NOTICEs
216  $spec = implode( "\t", $params );
217  $out[$spec] = $originalParams;
218  }
219  }
220  return array_values( $out );
221 }
222 
231 function wfArrayInsertAfter( array $array, array $insert, $after ) {
232  // Find the offset of the element to insert after.
233  $keys = array_keys( $array );
234  $offsetByKey = array_flip( $keys );
235 
236  $offset = $offsetByKey[$after];
237 
238  // Insert at the specified offset
239  $before = array_slice( $array, 0, $offset + 1, true );
240  $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
241 
242  $output = $before + $insert + $after;
243 
244  return $output;
245 }
246 
254 function wfObjectToArray( $objOrArray, $recursive = true ) {
255  $array = [];
256  if ( is_object( $objOrArray ) ) {
257  $objOrArray = get_object_vars( $objOrArray );
258  }
259  foreach ( $objOrArray as $key => $value ) {
260  if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
262  }
263 
264  $array[$key] = $value;
265  }
266 
267  return $array;
268 }
269 
280 function wfRandom() {
281  // The maximum random value is "only" 2^31-1, so get two random
282  // values to reduce the chance of dupes
283  $max = mt_getrandmax() + 1;
284  $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
285  return $rand;
286 }
287 
298 function wfRandomString( $length = 32 ) {
299  $str = '';
300  for ( $n = 0; $n < $length; $n += 7 ) {
301  $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
302  }
303  return substr( $str, 0, $length );
304 }
305 
333 function wfUrlencode( $s ) {
334  static $needle;
335 
336  if ( is_null( $s ) ) {
337  $needle = null;
338  return '';
339  }
340 
341  if ( is_null( $needle ) ) {
342  $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
343  if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
344  ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
345  ) {
346  $needle[] = '%3A';
347  }
348  }
349 
350  $s = urlencode( $s );
351  $s = str_ireplace(
352  $needle,
353  [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
354  $s
355  );
356 
357  return $s;
358 }
359 
370 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
371  if ( !is_null( $array2 ) ) {
372  $array1 = $array1 + $array2;
373  }
374 
375  $cgi = '';
376  foreach ( $array1 as $key => $value ) {
377  if ( !is_null( $value ) && $value !== false ) {
378  if ( $cgi != '' ) {
379  $cgi .= '&';
380  }
381  if ( $prefix !== '' ) {
382  $key = $prefix . "[$key]";
383  }
384  if ( is_array( $value ) ) {
385  $firstTime = true;
386  foreach ( $value as $k => $v ) {
387  $cgi .= $firstTime ? '' : '&';
388  if ( is_array( $v ) ) {
389  $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
390  } else {
391  $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
392  }
393  $firstTime = false;
394  }
395  } else {
396  if ( is_object( $value ) ) {
397  $value = $value->__toString();
398  }
399  $cgi .= urlencode( $key ) . '=' . urlencode( $value );
400  }
401  }
402  }
403  return $cgi;
404 }
405 
415 function wfCgiToArray( $query ) {
416  if ( isset( $query[0] ) && $query[0] == '?' ) {
417  $query = substr( $query, 1 );
418  }
419  $bits = explode( '&', $query );
420  $ret = [];
421  foreach ( $bits as $bit ) {
422  if ( $bit === '' ) {
423  continue;
424  }
425  if ( strpos( $bit, '=' ) === false ) {
426  // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
427  $key = $bit;
428  $value = '';
429  } else {
430  list( $key, $value ) = explode( '=', $bit );
431  }
432  $key = urldecode( $key );
433  $value = urldecode( $value );
434  if ( strpos( $key, '[' ) !== false ) {
435  $keys = array_reverse( explode( '[', $key ) );
436  $key = array_pop( $keys );
437  $temp = $value;
438  foreach ( $keys as $k ) {
439  $k = substr( $k, 0, -1 );
440  $temp = [ $k => $temp ];
441  }
442  if ( isset( $ret[$key] ) ) {
443  $ret[$key] = array_merge( $ret[$key], $temp );
444  } else {
445  $ret[$key] = $temp;
446  }
447  } else {
448  $ret[$key] = $value;
449  }
450  }
451  return $ret;
452 }
453 
462 function wfAppendQuery( $url, $query ) {
463  if ( is_array( $query ) ) {
465  }
466  if ( $query != '' ) {
467  // Remove the fragment, if there is one
468  $fragment = false;
469  $hashPos = strpos( $url, '#' );
470  if ( $hashPos !== false ) {
471  $fragment = substr( $url, $hashPos );
472  $url = substr( $url, 0, $hashPos );
473  }
474 
475  // Add parameter
476  if ( strpos( $url, '?' ) === false ) {
477  $url .= '?';
478  } else {
479  $url .= '&';
480  }
481  $url .= $query;
482 
483  // Put the fragment back
484  if ( $fragment !== false ) {
485  $url .= $fragment;
486  }
487  }
488  return $url;
489 }
490 
514 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
516  $wgHttpsPort;
517  if ( $defaultProto === PROTO_CANONICAL ) {
518  $serverUrl = $wgCanonicalServer;
519  } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
520  // Make $wgInternalServer fall back to $wgServer if not set
521  $serverUrl = $wgInternalServer;
522  } else {
523  $serverUrl = $wgServer;
524  if ( $defaultProto === PROTO_CURRENT ) {
525  $defaultProto = $wgRequest->getProtocol() . '://';
526  }
527  }
528 
529  // Analyze $serverUrl to obtain its protocol
530  $bits = wfParseUrl( $serverUrl );
531  $serverHasProto = $bits && $bits['scheme'] != '';
532 
533  if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
534  if ( $serverHasProto ) {
535  $defaultProto = $bits['scheme'] . '://';
536  } else {
537  // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
538  // This really isn't supposed to happen. Fall back to HTTP in this
539  // ridiculous case.
540  $defaultProto = PROTO_HTTP;
541  }
542  }
543 
544  $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
545 
546  if ( substr( $url, 0, 2 ) == '//' ) {
547  $url = $defaultProtoWithoutSlashes . $url;
548  } elseif ( substr( $url, 0, 1 ) == '/' ) {
549  // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
550  // otherwise leave it alone.
551  if ( $serverHasProto ) {
552  $url = $serverUrl . $url;
553  } else {
554  // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
555  // user to override the port number (T67184)
556  if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
557  if ( isset( $bits['port'] ) ) {
558  throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
559  }
560  $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
561  } else {
562  $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
563  }
564  }
565  }
566 
567  $bits = wfParseUrl( $url );
568 
569  if ( $bits && isset( $bits['path'] ) ) {
570  $bits['path'] = wfRemoveDotSegments( $bits['path'] );
571  return wfAssembleUrl( $bits );
572  } elseif ( $bits ) {
573  # No path to expand
574  return $url;
575  } elseif ( substr( $url, 0, 1 ) != '/' ) {
576  # URL is a relative path
577  return wfRemoveDotSegments( $url );
578  }
579 
580  # Expanded URL is not valid.
581  return false;
582 }
583 
592 function wfGetServerUrl( $proto ) {
593  $url = wfExpandUrl( '/', $proto );
594  return substr( $url, 0, -1 );
595 }
596 
610 function wfAssembleUrl( $urlParts ) {
611  $result = '';
612 
613  if ( isset( $urlParts['delimiter'] ) ) {
614  if ( isset( $urlParts['scheme'] ) ) {
615  $result .= $urlParts['scheme'];
616  }
617 
618  $result .= $urlParts['delimiter'];
619  }
620 
621  if ( isset( $urlParts['host'] ) ) {
622  if ( isset( $urlParts['user'] ) ) {
623  $result .= $urlParts['user'];
624  if ( isset( $urlParts['pass'] ) ) {
625  $result .= ':' . $urlParts['pass'];
626  }
627  $result .= '@';
628  }
629 
630  $result .= $urlParts['host'];
631 
632  if ( isset( $urlParts['port'] ) ) {
633  $result .= ':' . $urlParts['port'];
634  }
635  }
636 
637  if ( isset( $urlParts['path'] ) ) {
638  $result .= $urlParts['path'];
639  }
640 
641  if ( isset( $urlParts['query'] ) ) {
642  $result .= '?' . $urlParts['query'];
643  }
644 
645  if ( isset( $urlParts['fragment'] ) ) {
646  $result .= '#' . $urlParts['fragment'];
647  }
648 
649  return $result;
650 }
651 
664 function wfRemoveDotSegments( $urlPath ) {
665  $output = '';
666  $inputOffset = 0;
667  $inputLength = strlen( $urlPath );
668 
669  while ( $inputOffset < $inputLength ) {
670  $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
671  $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
672  $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
673  $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
674  $trimOutput = false;
675 
676  if ( $prefixLengthTwo == './' ) {
677  # Step A, remove leading "./"
678  $inputOffset += 2;
679  } elseif ( $prefixLengthThree == '../' ) {
680  # Step A, remove leading "../"
681  $inputOffset += 3;
682  } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
683  # Step B, replace leading "/.$" with "/"
684  $inputOffset += 1;
685  $urlPath[$inputOffset] = '/';
686  } elseif ( $prefixLengthThree == '/./' ) {
687  # Step B, replace leading "/./" with "/"
688  $inputOffset += 2;
689  } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
690  # Step C, replace leading "/..$" with "/" and
691  # remove last path component in output
692  $inputOffset += 2;
693  $urlPath[$inputOffset] = '/';
694  $trimOutput = true;
695  } elseif ( $prefixLengthFour == '/../' ) {
696  # Step C, replace leading "/../" with "/" and
697  # remove last path component in output
698  $inputOffset += 3;
699  $trimOutput = true;
700  } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
701  # Step D, remove "^.$"
702  $inputOffset += 1;
703  } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
704  # Step D, remove "^..$"
705  $inputOffset += 2;
706  } else {
707  # Step E, move leading path segment to output
708  if ( $prefixLengthOne == '/' ) {
709  $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
710  } else {
711  $slashPos = strpos( $urlPath, '/', $inputOffset );
712  }
713  if ( $slashPos === false ) {
714  $output .= substr( $urlPath, $inputOffset );
715  $inputOffset = $inputLength;
716  } else {
717  $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
718  $inputOffset += $slashPos - $inputOffset;
719  }
720  }
721 
722  if ( $trimOutput ) {
723  $slashPos = strrpos( $output, '/' );
724  if ( $slashPos === false ) {
725  $output = '';
726  } else {
727  $output = substr( $output, 0, $slashPos );
728  }
729  }
730  }
731 
732  return $output;
733 }
734 
742 function wfUrlProtocols( $includeProtocolRelative = true ) {
743  global $wgUrlProtocols;
744 
745  // Cache return values separately based on $includeProtocolRelative
746  static $withProtRel = null, $withoutProtRel = null;
747  $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
748  if ( !is_null( $cachedValue ) ) {
749  return $cachedValue;
750  }
751 
752  // Support old-style $wgUrlProtocols strings, for backwards compatibility
753  // with LocalSettings files from 1.5
754  if ( is_array( $wgUrlProtocols ) ) {
755  $protocols = [];
756  foreach ( $wgUrlProtocols as $protocol ) {
757  // Filter out '//' if !$includeProtocolRelative
758  if ( $includeProtocolRelative || $protocol !== '//' ) {
759  $protocols[] = preg_quote( $protocol, '/' );
760  }
761  }
762 
763  $retval = implode( '|', $protocols );
764  } else {
765  // Ignore $includeProtocolRelative in this case
766  // This case exists for pre-1.6 compatibility, and we can safely assume
767  // that '//' won't appear in a pre-1.6 config because protocol-relative
768  // URLs weren't supported until 1.18
769  $retval = $wgUrlProtocols;
770  }
771 
772  // Cache return value
773  if ( $includeProtocolRelative ) {
774  $withProtRel = $retval;
775  } else {
776  $withoutProtRel = $retval;
777  }
778  return $retval;
779 }
780 
788  return wfUrlProtocols( false );
789 }
790 
816 function wfParseUrl( $url ) {
817  global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
818 
819  // Protocol-relative URLs are handled really badly by parse_url(). It's so
820  // bad that the easiest way to handle them is to just prepend 'http:' and
821  // strip the protocol out later.
822  $wasRelative = substr( $url, 0, 2 ) == '//';
823  if ( $wasRelative ) {
824  $url = "http:$url";
825  }
826  Wikimedia\suppressWarnings();
827  $bits = parse_url( $url );
828  Wikimedia\restoreWarnings();
829  // parse_url() returns an array without scheme for some invalid URLs, e.g.
830  // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
831  if ( !$bits || !isset( $bits['scheme'] ) ) {
832  return false;
833  }
834 
835  // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
836  $bits['scheme'] = strtolower( $bits['scheme'] );
837 
838  // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
839  if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
840  $bits['delimiter'] = '://';
841  } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
842  $bits['delimiter'] = ':';
843  // parse_url detects for news: and mailto: the host part of an url as path
844  // We have to correct this wrong detection
845  if ( isset( $bits['path'] ) ) {
846  $bits['host'] = $bits['path'];
847  $bits['path'] = '';
848  }
849  } else {
850  return false;
851  }
852 
853  /* Provide an empty host for eg. file:/// urls (see T30627) */
854  if ( !isset( $bits['host'] ) ) {
855  $bits['host'] = '';
856 
857  // See T47069
858  if ( isset( $bits['path'] ) ) {
859  /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
860  if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
861  $bits['path'] = '/' . $bits['path'];
862  }
863  } else {
864  $bits['path'] = '';
865  }
866  }
867 
868  // If the URL was protocol-relative, fix scheme and delimiter
869  if ( $wasRelative ) {
870  $bits['scheme'] = '';
871  $bits['delimiter'] = '//';
872  }
873  return $bits;
874 }
875 
886 function wfExpandIRI( $url ) {
887  return preg_replace_callback(
888  '/((?:%[89A-F][0-9A-F])+)/i',
889  function ( array $matches ) {
890  return urldecode( $matches[1] );
891  },
892  wfExpandUrl( $url )
893  );
894 }
895 
903 function wfMakeUrlIndexes( $url ) {
904  wfDeprecated( __FUNCTION__, '1.33' );
905  return LinkFilter::makeIndexes( $url );
906 }
907 
914 function wfMatchesDomainList( $url, $domains ) {
915  $bits = wfParseUrl( $url );
916  if ( is_array( $bits ) && isset( $bits['host'] ) ) {
917  $host = '.' . $bits['host'];
918  foreach ( (array)$domains as $domain ) {
919  $domain = '.' . $domain;
920  if ( substr( $host, -strlen( $domain ) ) === $domain ) {
921  return true;
922  }
923  }
924  }
925  return false;
926 }
927 
948 function wfDebug( $text, $dest = 'all', array $context = [] ) {
950  global $wgDebugTimestamps;
951 
952  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
953  return;
954  }
955 
956  $text = trim( $text );
957 
958  if ( $wgDebugTimestamps ) {
959  $context['seconds_elapsed'] = sprintf(
960  '%6.4f',
961  microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
962  );
963  $context['memory_used'] = sprintf(
964  '%5.1fM',
965  ( memory_get_usage( true ) / ( 1024 * 1024 ) )
966  );
967  }
968 
969  if ( $wgDebugLogPrefix !== '' ) {
970  $context['prefix'] = $wgDebugLogPrefix;
971  }
972  $context['private'] = ( $dest === false || $dest === 'private' );
973 
974  $logger = LoggerFactory::getInstance( 'wfDebug' );
975  $logger->debug( $text, $context );
976 }
977 
982 function wfIsDebugRawPage() {
983  static $cache;
984  if ( $cache !== null ) {
985  return $cache;
986  }
987  // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
988  // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
989  if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
990  || (
991  isset( $_SERVER['SCRIPT_NAME'] )
992  && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
993  )
994  ) {
995  $cache = true;
996  } else {
997  $cache = false;
998  }
999  return $cache;
1000 }
1001 
1007 function wfDebugMem( $exact = false ) {
1008  $mem = memory_get_usage();
1009  if ( !$exact ) {
1010  $mem = floor( $mem / 1024 ) . ' KiB';
1011  } else {
1012  $mem .= ' B';
1013  }
1014  wfDebug( "Memory usage: $mem\n" );
1015 }
1016 
1042 function wfDebugLog(
1043  $logGroup, $text, $dest = 'all', array $context = []
1044 ) {
1045  $text = trim( $text );
1046 
1047  $logger = LoggerFactory::getInstance( $logGroup );
1048  $context['private'] = ( $dest === false || $dest === 'private' );
1049  $logger->info( $text, $context );
1050 }
1051 
1060 function wfLogDBError( $text, array $context = [] ) {
1061  $logger = LoggerFactory::getInstance( 'wfLogDBError' );
1062  $logger->error( trim( $text ), $context );
1063 }
1064 
1077 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1078  MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1079 }
1080 
1091 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1092  MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1093 }
1094 
1104 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1105  MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1106 }
1107 
1114 
1116  $request = $context->getRequest();
1117 
1118  $profiler = Profiler::instance();
1119  $profiler->setContext( $context );
1120  $profiler->logData();
1121 
1122  // Send out any buffered statsd metrics as needed
1124  MediaWikiServices::getInstance()->getStatsdDataFactory(),
1125  $context->getConfig()
1126  );
1127 
1128  // Profiling must actually be enabled...
1129  if ( $profiler instanceof ProfilerStub ) {
1130  return;
1131  }
1132 
1133  if ( isset( $wgDebugLogGroups['profileoutput'] )
1134  && $wgDebugLogGroups['profileoutput'] === false
1135  ) {
1136  // Explicitly disabled
1137  return;
1138  }
1139  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1140  return;
1141  }
1142 
1143  $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1144  if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1145  $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1146  }
1147  if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1148  $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1149  }
1150  if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1151  $ctx['from'] = $_SERVER['HTTP_FROM'];
1152  }
1153  if ( isset( $ctx['forwarded_for'] ) ||
1154  isset( $ctx['client_ip'] ) ||
1155  isset( $ctx['from'] ) ) {
1156  $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1157  }
1158 
1159  // Don't load $wgUser at this late stage just for statistics purposes
1160  // @todo FIXME: We can detect some anons even if it is not loaded.
1161  // See User::getId()
1162  $user = $context->getUser();
1163  $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1164 
1165  // Command line script uses a FauxRequest object which does not have
1166  // any knowledge about an URL and throw an exception instead.
1167  try {
1168  $ctx['url'] = urldecode( $request->getRequestURL() );
1169  } catch ( Exception $ignored ) {
1170  // no-op
1171  }
1172 
1173  $ctx['output'] = $profiler->getOutput();
1174 
1175  $log = LoggerFactory::getInstance( 'profileoutput' );
1176  $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1177 }
1178 
1186 function wfIncrStats( $key, $count = 1 ) {
1187  $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1188  $stats->updateCount( $key, $count );
1189 }
1190 
1196 function wfReadOnly() {
1197  return MediaWikiServices::getInstance()->getReadOnlyMode()
1198  ->isReadOnly();
1199 }
1200 
1209 function wfReadOnlyReason() {
1210  return MediaWikiServices::getInstance()->getReadOnlyMode()
1211  ->getReason();
1212 }
1213 
1221  return MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1222  ->getReason();
1223 }
1224 
1240 function wfGetLangObj( $langcode = false ) {
1241  # Identify which language to get or create a language object for.
1242  # Using is_object here due to Stub objects.
1243  if ( is_object( $langcode ) ) {
1244  # Great, we already have the object (hopefully)!
1245  return $langcode;
1246  }
1247 
1248  global $wgLanguageCode;
1249  if ( $langcode === true || $langcode === $wgLanguageCode ) {
1250  # $langcode is the language code of the wikis content language object.
1251  # or it is a boolean and value is true
1252  return MediaWikiServices::getInstance()->getContentLanguage();
1253  }
1254 
1255  global $wgLang;
1256  if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1257  # $langcode is the language code of user language object.
1258  # or it was a boolean and value is false
1259  return $wgLang;
1260  }
1261 
1262  $validCodes = array_keys( Language::fetchLanguageNames() );
1263  if ( in_array( $langcode, $validCodes ) ) {
1264  # $langcode corresponds to a valid language.
1265  return Language::factory( $langcode );
1266  }
1267 
1268  # $langcode is a string, but not a valid language code; use content language.
1269  wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1270  return MediaWikiServices::getInstance()->getContentLanguage();
1271 }
1272 
1289 function wfMessage( $key, ...$params ) {
1290  $message = new Message( $key );
1291 
1292  // We call Message::params() to reduce code duplication
1293  if ( $params ) {
1294  $message->params( ...$params );
1295  }
1296 
1297  return $message;
1298 }
1299 
1312 function wfMessageFallback( ...$keys ) {
1313  return Message::newFallbackSequence( ...$keys );
1314 }
1315 
1324 function wfMsgReplaceArgs( $message, $args ) {
1325  # Fix windows line-endings
1326  # Some messages are split with explode("\n", $msg)
1327  $message = str_replace( "\r", '', $message );
1328 
1329  // Replace arguments
1330  if ( is_array( $args ) && $args ) {
1331  if ( is_array( $args[0] ) ) {
1332  $args = array_values( $args[0] );
1333  }
1334  $replacementKeys = [];
1335  foreach ( $args as $n => $param ) {
1336  $replacementKeys['$' . ( $n + 1 )] = $param;
1337  }
1338  $message = strtr( $message, $replacementKeys );
1339  }
1340 
1341  return $message;
1342 }
1343 
1351 function wfHostname() {
1352  static $host;
1353  if ( is_null( $host ) ) {
1354  # Hostname overriding
1355  global $wgOverrideHostname;
1356  if ( $wgOverrideHostname !== false ) {
1357  # Set static and skip any detection
1358  $host = $wgOverrideHostname;
1359  return $host;
1360  }
1361 
1362  if ( function_exists( 'posix_uname' ) ) {
1363  // This function not present on Windows
1364  $uname = posix_uname();
1365  } else {
1366  $uname = false;
1367  }
1368  if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1369  $host = $uname['nodename'];
1370  } elseif ( getenv( 'COMPUTERNAME' ) ) {
1371  # Windows computer name
1372  $host = getenv( 'COMPUTERNAME' );
1373  } else {
1374  # This may be a virtual server.
1375  $host = $_SERVER['SERVER_NAME'];
1376  }
1377  }
1378  return $host;
1379 }
1380 
1391 function wfReportTime( $nonce = null ) {
1392  global $wgShowHostnames;
1393 
1394  $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1395  // seconds to milliseconds
1396  $responseTime = round( $elapsed * 1000 );
1397  $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1398  if ( $wgShowHostnames ) {
1399  $reportVars['wgHostname'] = wfHostname();
1400  }
1401  return Skin::makeVariablesScript( $reportVars, $nonce );
1402 }
1403 
1414 function wfDebugBacktrace( $limit = 0 ) {
1415  static $disabled = null;
1416 
1417  if ( is_null( $disabled ) ) {
1418  $disabled = !function_exists( 'debug_backtrace' );
1419  if ( $disabled ) {
1420  wfDebug( "debug_backtrace() is disabled\n" );
1421  }
1422  }
1423  if ( $disabled ) {
1424  return [];
1425  }
1426 
1427  if ( $limit ) {
1428  return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1429  } else {
1430  return array_slice( debug_backtrace(), 1 );
1431  }
1432 }
1433 
1442 function wfBacktrace( $raw = null ) {
1443  global $wgCommandLineMode;
1444 
1445  if ( $raw === null ) {
1446  $raw = $wgCommandLineMode;
1447  }
1448 
1449  if ( $raw ) {
1450  $frameFormat = "%s line %s calls %s()\n";
1451  $traceFormat = "%s";
1452  } else {
1453  $frameFormat = "<li>%s line %s calls %s()</li>\n";
1454  $traceFormat = "<ul>\n%s</ul>\n";
1455  }
1456 
1457  $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1458  $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1459  $line = $frame['line'] ?? '-';
1460  $call = $frame['function'];
1461  if ( !empty( $frame['class'] ) ) {
1462  $call = $frame['class'] . $frame['type'] . $call;
1463  }
1464  return sprintf( $frameFormat, $file, $line, $call );
1465  }, wfDebugBacktrace() );
1466 
1467  return sprintf( $traceFormat, implode( '', $frames ) );
1468 }
1469 
1479 function wfGetCaller( $level = 2 ) {
1480  $backtrace = wfDebugBacktrace( $level + 1 );
1481  if ( isset( $backtrace[$level] ) ) {
1482  return wfFormatStackFrame( $backtrace[$level] );
1483  } else {
1484  return 'unknown';
1485  }
1486 }
1487 
1495 function wfGetAllCallers( $limit = 3 ) {
1496  $trace = array_reverse( wfDebugBacktrace() );
1497  if ( !$limit || $limit > count( $trace ) - 1 ) {
1498  $limit = count( $trace ) - 1;
1499  }
1500  $trace = array_slice( $trace, -$limit - 1, $limit );
1501  return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1502 }
1503 
1510 function wfFormatStackFrame( $frame ) {
1511  if ( !isset( $frame['function'] ) ) {
1512  return 'NO_FUNCTION_GIVEN';
1513  }
1514  return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1515  $frame['class'] . $frame['type'] . $frame['function'] :
1516  $frame['function'];
1517 }
1518 
1519 /* Some generic result counters, pulled out of SearchEngine */
1520 
1528 function wfShowingResults( $offset, $limit ) {
1529  return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1530 }
1531 
1541 function wfClientAcceptsGzip( $force = false ) {
1542  static $result = null;
1543  if ( $result === null || $force ) {
1544  $result = false;
1545  if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1546  # @todo FIXME: We may want to blacklist some broken browsers
1547  $m = [];
1548  if ( preg_match(
1549  '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1550  $_SERVER['HTTP_ACCEPT_ENCODING'],
1551  $m
1552  )
1553  ) {
1554  if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1555  $result = false;
1556  return $result;
1557  }
1558  wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1559  $result = true;
1560  }
1561  }
1562  }
1563  return $result;
1564 }
1565 
1576 function wfEscapeWikiText( $text ) {
1577  global $wgEnableMagicLinks;
1578  static $repl = null, $repl2 = null;
1579  if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1580  // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1581  // in those situations
1582  $repl = [
1583  '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1584  '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1585  '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1586  "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1587  "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1588  "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1589  "\n " => "\n&#32;", "\r " => "\r&#32;",
1590  "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1591  "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1592  "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1593  "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1594  '__' => '_&#95;', '://' => '&#58;//',
1595  ];
1596 
1597  $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1598  // We have to catch everything "\s" matches in PCRE
1599  foreach ( $magicLinks as $magic ) {
1600  $repl["$magic "] = "$magic&#32;";
1601  $repl["$magic\t"] = "$magic&#9;";
1602  $repl["$magic\r"] = "$magic&#13;";
1603  $repl["$magic\n"] = "$magic&#10;";
1604  $repl["$magic\f"] = "$magic&#12;";
1605  }
1606 
1607  // And handle protocols that don't use "://"
1608  global $wgUrlProtocols;
1609  $repl2 = [];
1610  foreach ( $wgUrlProtocols as $prot ) {
1611  if ( substr( $prot, -1 ) === ':' ) {
1612  $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1613  }
1614  }
1615  $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1616  }
1617  $text = substr( strtr( "\n$text", $repl ), 1 );
1618  $text = preg_replace( $repl2, '$1&#58;', $text );
1619  return $text;
1620 }
1621 
1632 function wfSetVar( &$dest, $source, $force = false ) {
1633  $temp = $dest;
1634  if ( !is_null( $source ) || $force ) {
1635  $dest = $source;
1636  }
1637  return $temp;
1638 }
1639 
1649 function wfSetBit( &$dest, $bit, $state = true ) {
1650  $temp = (bool)( $dest & $bit );
1651  if ( !is_null( $state ) ) {
1652  if ( $state ) {
1653  $dest |= $bit;
1654  } else {
1655  $dest &= ~$bit;
1656  }
1657  }
1658  return $temp;
1659 }
1660 
1667 function wfVarDump( $var ) {
1668  global $wgOut;
1669  $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1670  if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1671  print $s;
1672  } else {
1673  $wgOut->addHTML( $s );
1674  }
1675 }
1676 
1684 function wfHttpError( $code, $label, $desc ) {
1685  global $wgOut;
1687  if ( $wgOut ) {
1688  $wgOut->disable();
1689  $wgOut->sendCacheControl();
1690  }
1691 
1693  header( 'Content-type: text/html; charset=utf-8' );
1694  print '<!DOCTYPE html>' .
1695  '<html><head><title>' .
1696  htmlspecialchars( $label ) .
1697  '</title></head><body><h1>' .
1698  htmlspecialchars( $label ) .
1699  '</h1><p>' .
1700  nl2br( htmlspecialchars( $desc ) ) .
1701  "</p></body></html>\n";
1702 }
1703 
1721 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1722  if ( $resetGzipEncoding ) {
1723  // Suppress Content-Encoding and Content-Length
1724  // headers from OutputHandler::handle.
1726  $wgDisableOutputCompression = true;
1727  }
1728  while ( $status = ob_get_status() ) {
1729  if ( isset( $status['flags'] ) ) {
1730  $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1731  $deleteable = ( $status['flags'] & $flags ) === $flags;
1732  } elseif ( isset( $status['del'] ) ) {
1733  $deleteable = $status['del'];
1734  } else {
1735  // Guess that any PHP-internal setting can't be removed.
1736  $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1737  }
1738  if ( !$deleteable ) {
1739  // Give up, and hope the result doesn't break
1740  // output behavior.
1741  break;
1742  }
1743  if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1744  // Unit testing barrier to prevent this function from breaking PHPUnit.
1745  break;
1746  }
1747  if ( !ob_end_clean() ) {
1748  // Could not remove output buffer handler; abort now
1749  // to avoid getting in some kind of infinite loop.
1750  break;
1751  }
1752  if ( $resetGzipEncoding ) {
1753  if ( $status['name'] == 'ob_gzhandler' ) {
1754  // Reset the 'Content-Encoding' field set by this handler
1755  // so we can start fresh.
1756  header_remove( 'Content-Encoding' );
1757  break;
1758  }
1759  }
1760  }
1761 }
1762 
1776  wfResetOutputBuffers( false );
1777 }
1778 
1787 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1788  # No arg means accept anything (per HTTP spec)
1789  if ( !$accept ) {
1790  return [ $def => 1.0 ];
1791  }
1792 
1793  $prefs = [];
1794 
1795  $parts = explode( ',', $accept );
1796 
1797  foreach ( $parts as $part ) {
1798  # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1799  $values = explode( ';', trim( $part ) );
1800  $match = [];
1801  if ( count( $values ) == 1 ) {
1802  $prefs[$values[0]] = 1.0;
1803  } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1804  $prefs[$values[0]] = floatval( $match[1] );
1805  }
1806  }
1807 
1808  return $prefs;
1809 }
1810 
1823 function mimeTypeMatch( $type, $avail ) {
1824  if ( array_key_exists( $type, $avail ) ) {
1825  return $type;
1826  } else {
1827  $mainType = explode( '/', $type )[0];
1828  if ( array_key_exists( "$mainType/*", $avail ) ) {
1829  return "$mainType/*";
1830  } elseif ( array_key_exists( '*/*', $avail ) ) {
1831  return '*/*';
1832  } else {
1833  return null;
1834  }
1835  }
1836 }
1837 
1851 function wfNegotiateType( $cprefs, $sprefs ) {
1852  $combine = [];
1853 
1854  foreach ( array_keys( $sprefs ) as $type ) {
1855  $subType = explode( '/', $type )[1];
1856  if ( $subType != '*' ) {
1857  $ckey = mimeTypeMatch( $type, $cprefs );
1858  if ( $ckey ) {
1859  $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1860  }
1861  }
1862  }
1863 
1864  foreach ( array_keys( $cprefs ) as $type ) {
1865  $subType = explode( '/', $type )[1];
1866  if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1867  $skey = mimeTypeMatch( $type, $sprefs );
1868  if ( $skey ) {
1869  $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1870  }
1871  }
1872  }
1873 
1874  $bestq = 0;
1875  $besttype = null;
1876 
1877  foreach ( array_keys( $combine ) as $type ) {
1878  if ( $combine[$type] > $bestq ) {
1879  $besttype = $type;
1880  $bestq = $combine[$type];
1881  }
1882  }
1883 
1884  return $besttype;
1885 }
1886 
1893 function wfSuppressWarnings( $end = false ) {
1894  Wikimedia\suppressWarnings( $end );
1895 }
1896 
1901 function wfRestoreWarnings() {
1902  Wikimedia\restoreWarnings();
1903 }
1904 
1913 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1914  $ret = MWTimestamp::convert( $outputtype, $ts );
1915  if ( $ret === false ) {
1916  wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1917  }
1918  return $ret;
1919 }
1920 
1929 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1930  if ( is_null( $ts ) ) {
1931  return null;
1932  } else {
1933  return wfTimestamp( $outputtype, $ts );
1934  }
1935 }
1936 
1942 function wfTimestampNow() {
1943  # return NOW
1944  return MWTimestamp::now( TS_MW );
1945 }
1946 
1952 function wfIsWindows() {
1953  static $isWindows = null;
1954  if ( $isWindows === null ) {
1955  $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
1956  }
1957  return $isWindows;
1958 }
1959 
1965 function wfIsHHVM() {
1966  return defined( 'HHVM_VERSION' );
1967 }
1968 
1975 function wfIsCLI() {
1976  return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
1977 }
1978 
1990 function wfTempDir() {
1991  global $wgTmpDirectory;
1992 
1993  if ( $wgTmpDirectory !== false ) {
1994  return $wgTmpDirectory;
1995  }
1996 
1998 }
1999 
2009 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2010  global $wgDirectoryMode;
2011 
2012  if ( FileBackend::isStoragePath( $dir ) ) { // sanity
2013  throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
2014  }
2015 
2016  if ( !is_null( $caller ) ) {
2017  wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2018  }
2019 
2020  if ( strval( $dir ) === '' || is_dir( $dir ) ) {
2021  return true;
2022  }
2023 
2024  $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
2025 
2026  if ( is_null( $mode ) ) {
2027  $mode = $wgDirectoryMode;
2028  }
2029 
2030  // Turn off the normal warning, we're doing our own below
2031  Wikimedia\suppressWarnings();
2032  $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2033  Wikimedia\restoreWarnings();
2034 
2035  if ( !$ok ) {
2036  // directory may have been created on another request since we last checked
2037  if ( is_dir( $dir ) ) {
2038  return true;
2039  }
2040 
2041  // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2042  wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2043  }
2044  return $ok;
2045 }
2046 
2052 function wfRecursiveRemoveDir( $dir ) {
2053  wfDebug( __FUNCTION__ . "( $dir )\n" );
2054  // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2055  if ( is_dir( $dir ) ) {
2056  $objects = scandir( $dir );
2057  foreach ( $objects as $object ) {
2058  if ( $object != "." && $object != ".." ) {
2059  if ( filetype( $dir . '/' . $object ) == "dir" ) {
2060  wfRecursiveRemoveDir( $dir . '/' . $object );
2061  } else {
2062  unlink( $dir . '/' . $object );
2063  }
2064  }
2065  }
2066  reset( $objects );
2067  rmdir( $dir );
2068  }
2069 }
2070 
2077 function wfPercent( $nr, $acc = 2, $round = true ) {
2078  $ret = sprintf( "%.${acc}f", $nr );
2079  return $round ? round( $ret, $acc ) . '%' : "$ret%";
2080 }
2081 
2105 function wfIniGetBool( $setting ) {
2106  return wfStringToBool( ini_get( $setting ) );
2107 }
2108 
2121 function wfStringToBool( $val ) {
2122  $val = strtolower( $val );
2123  // 'on' and 'true' can't have whitespace around them, but '1' can.
2124  return $val == 'on'
2125  || $val == 'true'
2126  || $val == 'yes'
2127  || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2128 }
2129 
2142 function wfEscapeShellArg( ...$args ) {
2143  return Shell::escape( ...$args );
2144 }
2145 
2169 function wfShellExec( $cmd, &$retval = null, $environ = [],
2170  $limits = [], $options = []
2171 ) {
2172  if ( Shell::isDisabled() ) {
2173  $retval = 1;
2174  // Backwards compatibility be upon us...
2175  return 'Unable to run external programs, proc_open() is disabled.';
2176  }
2177 
2178  if ( is_array( $cmd ) ) {
2179  $cmd = Shell::escape( $cmd );
2180  }
2181 
2182  $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2183  $profileMethod = $options['profileMethod'] ?? wfGetCaller();
2184 
2185  try {
2186  $result = Shell::command( [] )
2187  ->unsafeParams( (array)$cmd )
2188  ->environment( $environ )
2189  ->limits( $limits )
2190  ->includeStderr( $includeStderr )
2191  ->profileMethod( $profileMethod )
2192  // For b/c
2193  ->restrict( Shell::RESTRICT_NONE )
2194  ->execute();
2195  } catch ( ProcOpenError $ex ) {
2196  $retval = -1;
2197  return '';
2198  }
2199 
2200  $retval = $result->getExitCode();
2201 
2202  return $result->getStdout();
2203 }
2204 
2222 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2223  return wfShellExec( $cmd, $retval, $environ, $limits,
2224  [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2225 }
2226 
2241 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2242  global $wgPhpCli;
2243  // Give site config file a chance to run the script in a wrapper.
2244  // The caller may likely want to call wfBasename() on $script.
2245  Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2246  $cmd = [ $options['php'] ?? $wgPhpCli ];
2247  if ( isset( $options['wrapper'] ) ) {
2248  $cmd[] = $options['wrapper'];
2249  }
2250  $cmd[] = $script;
2251  // Escape each parameter for shell
2252  return Shell::escape( array_merge( $cmd, $parameters ) );
2253 }
2254 
2266 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2267  global $wgDiff3;
2268 
2269  # This check may also protect against code injection in
2270  # case of broken installations.
2271  Wikimedia\suppressWarnings();
2272  $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2273  Wikimedia\restoreWarnings();
2274 
2275  if ( !$haveDiff3 ) {
2276  wfDebug( "diff3 not found\n" );
2277  return false;
2278  }
2279 
2280  # Make temporary files
2281  $td = wfTempDir();
2282  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2283  $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2284  $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2285 
2286  # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2287  # a newline character. To avoid this, we normalize the trailing whitespace before
2288  # creating the diff.
2289 
2290  fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2291  fclose( $oldtextFile );
2292  fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2293  fclose( $mytextFile );
2294  fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2295  fclose( $yourtextFile );
2296 
2297  # Check for a conflict
2298  $cmd = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2299  $oldtextName, $yourtextName );
2300  $handle = popen( $cmd, 'r' );
2301 
2302  $mergeAttemptResult = '';
2303  do {
2304  $data = fread( $handle, 8192 );
2305  if ( strlen( $data ) == 0 ) {
2306  break;
2307  }
2308  $mergeAttemptResult .= $data;
2309  } while ( true );
2310  pclose( $handle );
2311 
2312  $conflict = $mergeAttemptResult !== '';
2313 
2314  # Merge differences
2315  $cmd = Shell::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2316  $oldtextName, $yourtextName );
2317  $handle = popen( $cmd, 'r' );
2318  $result = '';
2319  do {
2320  $data = fread( $handle, 8192 );
2321  if ( strlen( $data ) == 0 ) {
2322  break;
2323  }
2324  $result .= $data;
2325  } while ( true );
2326  pclose( $handle );
2327  unlink( $mytextName );
2328  unlink( $oldtextName );
2329  unlink( $yourtextName );
2330 
2331  if ( $result === '' && $old !== '' && !$conflict ) {
2332  wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2333  $conflict = true;
2334  }
2335  return !$conflict;
2336 }
2337 
2349 function wfDiff( $before, $after, $params = '-u' ) {
2350  if ( $before == $after ) {
2351  return '';
2352  }
2353 
2354  global $wgDiff;
2355  Wikimedia\suppressWarnings();
2356  $haveDiff = $wgDiff && file_exists( $wgDiff );
2357  Wikimedia\restoreWarnings();
2358 
2359  # This check may also protect against code injection in
2360  # case of broken installations.
2361  if ( !$haveDiff ) {
2362  wfDebug( "diff executable not found\n" );
2363  $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2364  $format = new UnifiedDiffFormatter();
2365  return $format->format( $diffs );
2366  }
2367 
2368  # Make temporary files
2369  $td = wfTempDir();
2370  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2371  $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2372 
2373  fwrite( $oldtextFile, $before );
2374  fclose( $oldtextFile );
2375  fwrite( $newtextFile, $after );
2376  fclose( $newtextFile );
2377 
2378  // Get the diff of the two files
2379  $cmd = "$wgDiff " . $params . ' ' . Shell::escape( $oldtextName, $newtextName );
2380 
2381  $h = popen( $cmd, 'r' );
2382  if ( !$h ) {
2383  unlink( $oldtextName );
2384  unlink( $newtextName );
2385  throw new Exception( __METHOD__ . '(): popen() failed' );
2386  }
2387 
2388  $diff = '';
2389 
2390  do {
2391  $data = fread( $h, 8192 );
2392  if ( strlen( $data ) == 0 ) {
2393  break;
2394  }
2395  $diff .= $data;
2396  } while ( true );
2397 
2398  // Clean up
2399  pclose( $h );
2400  unlink( $oldtextName );
2401  unlink( $newtextName );
2402 
2403  // Kill the --- and +++ lines. They're not useful.
2404  $diff_lines = explode( "\n", $diff );
2405  if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2406  unset( $diff_lines[0] );
2407  }
2408  if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2409  unset( $diff_lines[1] );
2410  }
2411 
2412  $diff = implode( "\n", $diff_lines );
2413 
2414  return $diff;
2415 }
2416 
2429 function wfBaseName( $path, $suffix = '' ) {
2430  if ( $suffix == '' ) {
2431  $encSuffix = '';
2432  } else {
2433  $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2434  }
2435 
2436  $matches = [];
2437  if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2438  return $matches[1];
2439  } else {
2440  return '';
2441  }
2442 }
2443 
2453 function wfRelativePath( $path, $from ) {
2454  // Normalize mixed input on Windows...
2455  $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2456  $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2457 
2458  // Trim trailing slashes -- fix for drive root
2459  $path = rtrim( $path, DIRECTORY_SEPARATOR );
2460  $from = rtrim( $from, DIRECTORY_SEPARATOR );
2461 
2462  $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2463  $against = explode( DIRECTORY_SEPARATOR, $from );
2464 
2465  if ( $pieces[0] !== $against[0] ) {
2466  // Non-matching Windows drive letters?
2467  // Return a full path.
2468  return $path;
2469  }
2470 
2471  // Trim off common prefix
2472  while ( count( $pieces ) && count( $against )
2473  && $pieces[0] == $against[0] ) {
2474  array_shift( $pieces );
2475  array_shift( $against );
2476  }
2477 
2478  // relative dots to bump us to the parent
2479  while ( count( $against ) ) {
2480  array_unshift( $pieces, '..' );
2481  array_shift( $against );
2482  }
2483 
2484  array_push( $pieces, wfBaseName( $path ) );
2485 
2486  return implode( DIRECTORY_SEPARATOR, $pieces );
2487 }
2488 
2495 function wfResetSessionID() {
2496  wfDeprecated( __FUNCTION__, '1.27' );
2497  $session = SessionManager::getGlobalSession();
2498  $delay = $session->delaySave();
2499 
2500  $session->resetId();
2501 
2502  // Make sure a session is started, since that's what the old
2503  // wfResetSessionID() did.
2504  if ( session_id() !== $session->getId() ) {
2505  wfSetupSession( $session->getId() );
2506  }
2507 
2508  ScopedCallback::consume( $delay );
2509 }
2510 
2520 function wfSetupSession( $sessionId = false ) {
2521  wfDeprecated( __FUNCTION__, '1.27' );
2522 
2523  if ( $sessionId ) {
2524  session_id( $sessionId );
2525  }
2526 
2527  $session = SessionManager::getGlobalSession();
2528  $session->persist();
2529 
2530  if ( session_id() !== $session->getId() ) {
2531  session_id( $session->getId() );
2532  }
2533  Wikimedia\quietCall( 'session_start' );
2534 }
2535 
2543  global $IP;
2544 
2545  $file = "$IP/serialized/$name";
2546  if ( file_exists( $file ) ) {
2547  $blob = file_get_contents( $file );
2548  if ( $blob ) {
2549  return unserialize( $blob );
2550  }
2551  }
2552  return false;
2553 }
2554 
2562 function wfMemcKey( ...$args ) {
2563  return ObjectCache::getLocalClusterInstance()->makeKey( ...$args );
2564 }
2565 
2576 function wfForeignMemcKey( $db, $prefix, ...$args ) {
2577  $keyspace = $prefix ? "$db-$prefix" : $db;
2578  return ObjectCache::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2579 }
2580 
2593 function wfGlobalCacheKey( ...$args ) {
2594  return ObjectCache::getLocalClusterInstance()->makeGlobalKey( ...$args );
2595 }
2596 
2603 function wfWikiID() {
2604  global $wgDBprefix, $wgDBname;
2605  if ( $wgDBprefix ) {
2606  return "$wgDBname-$wgDBprefix";
2607  } else {
2608  return $wgDBname;
2609  }
2610 }
2611 
2620 function wfSplitWikiID( $wiki ) {
2621  $bits = explode( '-', $wiki, 2 );
2622  if ( count( $bits ) < 2 ) {
2623  $bits[] = '';
2624  }
2625  return $bits;
2626 }
2627 
2653 function wfGetDB( $db, $groups = [], $wiki = false ) {
2654  return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2655 }
2656 
2666 function wfGetLB( $wiki = false ) {
2667  if ( $wiki === false ) {
2668  return MediaWikiServices::getInstance()->getDBLoadBalancer();
2669  } else {
2670  $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2671  return $factory->getMainLB( $wiki );
2672  }
2673 }
2674 
2682 function wfGetLBFactory() {
2683  return MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2684 }
2685 
2694 function wfFindFile( $title, $options = [] ) {
2695  return RepoGroup::singleton()->findFile( $title, $options );
2696 }
2697 
2705 function wfLocalFile( $title ) {
2706  return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
2707 }
2708 
2716  global $wgMiserMode;
2717  return $wgMiserMode
2718  || ( SiteStats::pages() > 100000
2719  && SiteStats::edits() > 1000000
2720  && SiteStats::users() > 10000 );
2721 }
2722 
2731 function wfScript( $script = 'index' ) {
2733  if ( $script === 'index' ) {
2734  return $wgScript;
2735  } elseif ( $script === 'load' ) {
2736  return $wgLoadScript;
2737  } else {
2738  return "{$wgScriptPath}/{$script}.php";
2739  }
2740 }
2741 
2747 function wfGetScriptUrl() {
2748  if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2749  /* as it was called, minus the query string.
2750  *
2751  * Some sites use Apache rewrite rules to handle subdomains,
2752  * and have PHP set up in a weird way that causes PHP_SELF
2753  * to contain the rewritten URL instead of the one that the
2754  * outside world sees.
2755  *
2756  * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2757  * provides containing the "before" URL.
2758  */
2759  return $_SERVER['SCRIPT_NAME'];
2760  } else {
2761  return $_SERVER['URL'];
2762  }
2763 }
2764 
2772 function wfBoolToStr( $value ) {
2773  return $value ? 'true' : 'false';
2774 }
2775 
2781 function wfGetNull() {
2782  return wfIsWindows() ? 'NUL' : '/dev/null';
2783 }
2784 
2808  $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2809 ) {
2810  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2811 
2812  if ( $cluster === '*' ) {
2813  $cluster = false;
2814  $domain = false;
2815  } elseif ( $wiki === false ) {
2816  $domain = $lbFactory->getLocalDomainID();
2817  } else {
2818  $domain = $wiki;
2819  }
2820 
2821  $opts = [
2822  'domain' => $domain,
2823  'cluster' => $cluster,
2824  // B/C: first argument used to be "max seconds of lag"; ignore such values
2825  'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
2826  ];
2827  if ( $timeout !== null ) {
2828  $opts['timeout'] = $timeout;
2829  }
2830 
2831  return $lbFactory->waitForReplication( $opts );
2832 }
2833 
2843 function wfCountDown( $seconds ) {
2844  wfDeprecated( __FUNCTION__, '1.31' );
2845  for ( $i = $seconds; $i >= 0; $i-- ) {
2846  if ( $i != $seconds ) {
2847  echo str_repeat( "\x08", strlen( $i + 1 ) );
2848  }
2849  echo $i;
2850  flush();
2851  if ( $i ) {
2852  sleep( 1 );
2853  }
2854  }
2855  echo "\n";
2856 }
2857 
2867  global $wgIllegalFileChars;
2868  $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
2869  $name = preg_replace(
2870  "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
2871  '-',
2872  $name
2873  );
2874  // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2875  $name = wfBaseName( $name );
2876  return $name;
2877 }
2878 
2884 function wfMemoryLimit() {
2885  global $wgMemoryLimit;
2886  $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2887  if ( $memlimit != -1 ) {
2888  $conflimit = wfShorthandToInteger( $wgMemoryLimit );
2889  if ( $conflimit == -1 ) {
2890  wfDebug( "Removing PHP's memory limit\n" );
2891  Wikimedia\suppressWarnings();
2892  ini_set( 'memory_limit', $conflimit );
2893  Wikimedia\restoreWarnings();
2894  return $conflimit;
2895  } elseif ( $conflimit > $memlimit ) {
2896  wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
2897  Wikimedia\suppressWarnings();
2898  ini_set( 'memory_limit', $conflimit );
2899  Wikimedia\restoreWarnings();
2900  return $conflimit;
2901  }
2902  }
2903  return $memlimit;
2904 }
2905 
2914 
2915  $timeLimit = ini_get( 'max_execution_time' );
2916  // Note that CLI scripts use 0
2917  if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2918  set_time_limit( $wgTransactionalTimeLimit );
2919  }
2920 
2921  ignore_user_abort( true ); // ignore client disconnects
2922 
2923  return $timeLimit;
2924 }
2925 
2933 function wfShorthandToInteger( $string = '', $default = -1 ) {
2934  $string = trim( $string );
2935  if ( $string === '' ) {
2936  return $default;
2937  }
2938  $last = $string[strlen( $string ) - 1];
2939  $val = intval( $string );
2940  switch ( $last ) {
2941  case 'g':
2942  case 'G':
2943  $val *= 1024;
2944  // break intentionally missing
2945  case 'm':
2946  case 'M':
2947  $val *= 1024;
2948  // break intentionally missing
2949  case 'k':
2950  case 'K':
2951  $val *= 1024;
2952  }
2953 
2954  return $val;
2955 }
2956 
2967 function wfBCP47( $code ) {
2968  wfDeprecated( __METHOD__, '1.31' );
2969  return LanguageCode::bcp47( $code );
2970 }
2971 
2979 function wfGetCache( $cacheType ) {
2980  return ObjectCache::getInstance( $cacheType );
2981 }
2982 
2989 function wfGetMainCache() {
2991 }
2992 
2999  global $wgMessageCacheType;
3000  return ObjectCache::getInstance( $wgMessageCacheType );
3001 }
3002 
3017 function wfUnpack( $format, $data, $length = false ) {
3018  if ( $length !== false ) {
3019  $realLen = strlen( $data );
3020  if ( $realLen < $length ) {
3021  throw new MWException( "Tried to use wfUnpack on a "
3022  . "string of length $realLen, but needed one "
3023  . "of at least length $length."
3024  );
3025  }
3026  }
3027 
3028  Wikimedia\suppressWarnings();
3029  $result = unpack( $format, $data );
3030  Wikimedia\restoreWarnings();
3031 
3032  if ( $result === false ) {
3033  // If it cannot extract the packed data.
3034  throw new MWException( "unpack could not unpack binary data" );
3035  }
3036  return $result;
3037 }
3038 
3053 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3054  # Handle redirects; callers almost always hit wfFindFile() anyway,
3055  # so just use that method because it has a fast process cache.
3056  $file = wfFindFile( $name ); // get the final name
3057  $name = $file ? $file->getTitle()->getDBkey() : $name;
3058 
3059  # Run the extension hook
3060  $bad = false;
3061  if ( !Hooks::run( 'BadImage', [ $name, &$bad ] ) ) {
3062  return (bool)$bad;
3063  }
3064 
3066  $key = $cache->makeKey(
3067  'bad-image-list', ( $blacklist === null ) ? 'default' : md5( $blacklist )
3068  );
3069  $badImages = $cache->get( $key );
3070 
3071  if ( $badImages === false ) { // cache miss
3072  if ( $blacklist === null ) {
3073  $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3074  }
3075  # Build the list now
3076  $badImages = [];
3077  $lines = explode( "\n", $blacklist );
3078  foreach ( $lines as $line ) {
3079  # List items only
3080  if ( substr( $line, 0, 1 ) !== '*' ) {
3081  continue;
3082  }
3083 
3084  # Find all links
3085  $m = [];
3086  if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3087  continue;
3088  }
3089 
3090  $exceptions = [];
3091  $imageDBkey = false;
3092  foreach ( $m[1] as $i => $titleText ) {
3093  $title = Title::newFromText( $titleText );
3094  if ( !is_null( $title ) ) {
3095  if ( $i == 0 ) {
3096  $imageDBkey = $title->getDBkey();
3097  } else {
3098  $exceptions[$title->getPrefixedDBkey()] = true;
3099  }
3100  }
3101  }
3102 
3103  if ( $imageDBkey !== false ) {
3104  $badImages[$imageDBkey] = $exceptions;
3105  }
3106  }
3107  $cache->set( $key, $badImages, 60 );
3108  }
3109 
3110  $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
3111  $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3112 
3113  return $bad;
3114 }
3115 
3123 function wfCanIPUseHTTPS( $ip ) {
3124  $canDo = true;
3125  Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3126  return (bool)$canDo;
3127 }
3128 
3136 function wfIsInfinity( $str ) {
3137  // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3138  $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3139  return in_array( $str, $infinityValues );
3140 }
3141 
3156 function wfThumbIsStandard( File $file, array $params ) {
3158 
3159  $multipliers = [ 1 ];
3160  if ( $wgResponsiveImages ) {
3161  // These available sizes are hardcoded currently elsewhere in MediaWiki.
3162  // @see Linker::processResponsiveImages
3163  $multipliers[] = 1.5;
3164  $multipliers[] = 2;
3165  }
3166 
3167  $handler = $file->getHandler();
3168  if ( !$handler || !isset( $params['width'] ) ) {
3169  return false;
3170  }
3171 
3172  $basicParams = [];
3173  if ( isset( $params['page'] ) ) {
3174  $basicParams['page'] = $params['page'];
3175  }
3176 
3177  $thumbLimits = [];
3178  $imageLimits = [];
3179  // Expand limits to account for multipliers
3180  foreach ( $multipliers as $multiplier ) {
3181  $thumbLimits = array_merge( $thumbLimits, array_map(
3182  function ( $width ) use ( $multiplier ) {
3183  return round( $width * $multiplier );
3184  }, $wgThumbLimits )
3185  );
3186  $imageLimits = array_merge( $imageLimits, array_map(
3187  function ( $pair ) use ( $multiplier ) {
3188  return [
3189  round( $pair[0] * $multiplier ),
3190  round( $pair[1] * $multiplier ),
3191  ];
3192  }, $wgImageLimits )
3193  );
3194  }
3195 
3196  // Check if the width matches one of $wgThumbLimits
3197  if ( in_array( $params['width'], $thumbLimits ) ) {
3198  $normalParams = $basicParams + [ 'width' => $params['width'] ];
3199  // Append any default values to the map (e.g. "lossy", "lossless", ...)
3200  $handler->normaliseParams( $file, $normalParams );
3201  } else {
3202  // If not, then check if the width matchs one of $wgImageLimits
3203  $match = false;
3204  foreach ( $imageLimits as $pair ) {
3205  $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3206  // Decide whether the thumbnail should be scaled on width or height.
3207  // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3208  $handler->normaliseParams( $file, $normalParams );
3209  // Check if this standard thumbnail size maps to the given width
3210  if ( $normalParams['width'] == $params['width'] ) {
3211  $match = true;
3212  break;
3213  }
3214  }
3215  if ( !$match ) {
3216  return false; // not standard for description pages
3217  }
3218  }
3219 
3220  // Check that the given values for non-page, non-width, params are just defaults
3221  foreach ( $params as $key => $value ) {
3222  if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3223  return false;
3224  }
3225  }
3226 
3227  return true;
3228 }
3229 
3242 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3243  // First merge items that are in both arrays
3244  foreach ( $baseArray as $name => &$groupVal ) {
3245  if ( isset( $newValues[$name] ) ) {
3246  $groupVal += $newValues[$name];
3247  }
3248  }
3249  // Now add items that didn't exist yet
3250  $baseArray += $newValues;
3251 
3252  return $baseArray;
3253 }
3254 
3263 function wfGetRusage() {
3264  if ( !function_exists( 'getrusage' ) ) {
3265  return false;
3266  } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS === 'Linux' ) {
3267  return getrusage( 2 /* RUSAGE_THREAD */ );
3268  } else {
3269  return getrusage( 0 /* RUSAGE_SELF */ );
3270  }
3271 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
wfSuppressWarnings( $end=false)
Reference-counted warning suppression.
mimeTypeMatch( $type, $avail)
Checks if a given MIME type matches any of the keys in the given array.
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
wfBaseName( $path, $suffix='')
Return the final portion of a pathname.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
$wgDebugTimestamps
Prefix debug messages with relative timestamp.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:843
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1598
$wgScript
The URL path to index.php.
wfIsHHVM()
Check if we are running under HHVM.
wfMakeUrlIndexes( $url)
Make URL indexes, appropriate for the el_index field of externallinks.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
$IP
Definition: WebStart.php:41
$wgDebugLogGroups
Map of string log group names to log destinations.
wfLoadSkin( $skin, $path=null)
Load a skin.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1995
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfShellWikiCmd( $script, array $parameters=[], array $options=[])
Generate a shell-escaped command line string to run a MediaWiki cli script.
wfGetRusage()
Get system resource usage of current request context.
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the &#39;bad image list&#39;.
static instance()
Singleton.
Definition: Profiler.php:62
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfGetCache( $cacheType)
Get a specific cache object.
wfGetPrecompiledData( $name)
Get an object from the precompiled serialized directory.
$wgInternalServer
Internal server name as known to CDN, if different.
wfHostname()
Fetch server name for use in error reporting etc.
wfRecursiveRemoveDir( $dir)
Remove a directory and all its content.
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1276
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
$wgHttpsPort
For installations where the canonical server is HTTP but HTTPS is optionally supported, you can specify a non-standard HTTPS port here.
$wgOverrideHostname
Override server hostname detection with a hardcoded value.
wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult=null)
wfMerge attempts to merge differences between three texts.
wfLogProfilingData()
A formatter that outputs unified diffs.
$source
$value
wfForeignMemcKey( $db, $prefix,... $args)
Make a cache key for a foreign DB.
wfIsInfinity( $str)
Determine input string is represents as infinity.
const PROTO_CURRENT
Definition: Defines.php:222
wfStripIllegalFilenameChars( $name)
Replace all invalid characters with &#39;-&#39;.
static getInstance( $id)
Get a cached instance of the specified type of cache object.
Definition: ObjectCache.php:92
Stub profiler that does nothing.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message key
Definition: hooks.txt:2164
static getLocalClusterInstance()
Get the main cluster-local cache object.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
wfUrlProtocolsWithoutProtRel()
Like wfUrlProtocols(), but excludes &#39;//&#39; from the protocol list.
$wgUrlProtocols
URL schemes that should be recognized as valid by wfParseUrl().
$wgDisableOutputCompression
Disable output compression (enabled by default if zlib is available)
wfLogWarning( $msg, $callerOffset=1, $level=E_USER_WARNING)
Send a warning as a PHP error and the debug log.
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
$wgTmpDirectory
The local filesystem path to a temporary directory.
wfGetServerUrl( $proto)
Get the wiki&#39;s "server", i.e.
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
wfIsWindows()
Check if the operating system is Windows.
wfLocalFile( $title)
Get an object referring to a locally registered file.
wfGetMessageCacheStorage()
Get the cache object used by the message cache.
wfPercent( $nr, $acc=2, $round=true)
wfSetupSession( $sessionId=false)
Initialise php session.
wfLogDBError( $text, array $context=[])
Log for database errors.
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2220
wfVarDump( $var)
A wrapper around the PHP function var_export().
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
wfCountDown( $seconds)
Count down from $seconds to zero on the terminal, with a one-second pause between showing each number...
$wgEnableMagicLinks
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links...
if( $line===false) $args
Definition: cdb.php:64
static getUsableTempDirectory()
Definition: TempFSFile.php:85
$wgDebugRawPage
If true, log debugging data from action=raw and load.php.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
wfFormatStackFrame( $frame)
Return a string representation of frame.
wfShellExec( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
$last
$wgPhpCli
Executable path of the PHP cli binary.
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
$wgLanguageCode
Site language code.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
wfArrayFilter(array $arr, callable $callback)
static edits()
Definition: SiteStats.php:94
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$wgExtensionDirectory
Filesystem extensions directory.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:780
wfLoadExtensions(array $exts)
Load multiple extensions at once.
wfIsDebugRawPage()
Returns true if debug logging should be suppressed if $wgDebugRawPage = false.
wfConfiguredReadOnlyReason()
Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
const PROTO_HTTPS
Definition: Defines.php:220
wfReportTime( $nonce=null)
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
wfRemoveDotSegments( $urlPath)
Remove all dot-segments in the provided URL path.
wfMergeErrorArrays(... $args)
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
wfReadOnly()
Check whether the wiki is in read-only mode.
wfSetBit(&$dest, $bit, $state=true)
As for wfSetVar except setting a bit.
wfMatchesDomainList( $url, $domains)
Check whether a given URL has a domain that occurs in a given set of domains.
wfIncrStats( $key, $count=1)
Increment a statistics counter.
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default.
$wgLang
Definition: Setup.php:891
wfTempDir()
Tries to get the system directory for temporary files.
wfClientAcceptsGzip( $force=false)
Whether the client accept gzip encoding.
static getMain()
Get the RequestContext object associated with the main request.
wfNegotiateType( $cprefs, $sprefs)
Returns the &#39;best&#39; match between a client&#39;s requested internet media types and the server&#39;s list of a...
static warning( $msg, $callerOffset=1, $level=E_USER_NOTICE, $log='auto')
Adds a warning entry to the log.
Definition: MWDebug.php:151
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
$wgIllegalFileChars
Additional characters that are not allowed in filenames.
const PROTO_INTERNAL
Definition: Defines.php:224
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
getHandler()
Get a MediaHandler instance for this file.
Definition: File.php:1383
wfFindFile( $title, $options=[])
Find a file.
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:61
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
$wgMessageCacheType
The cache type for storing the contents of the MediaWiki namespace.
$wgMiserMode
Disable database-intensive features.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static warnIfHeadersSent()
Log a warning message if headers have already been sent.
wfShowingResults( $offset, $limit)
wfMsgReplaceArgs( $message, $args)
Replace message parameter keys on the given formatted output.
static newFallbackSequence()
Factory function accepting multiple message keys and returning a message instance for the first messa...
Definition: Message.php:460
wfMessageFallback(... $keys)
This function accepts multiple message keys and returns a message instance for the first message whic...
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
static header( $code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
$wgImageLimits
Limit images on image description pages to a user-selectable limit.
Class representing a &#39;diff&#39; between two sequences of strings.
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
$cache
Definition: mcc.php:33
$params
static makeVariablesScript( $data, $nonce=null)
Definition: Skin.php:400
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1995
$wgThumbLimits
Adjust thumbnails on image pages according to a user setting.
unserialize( $serialized)
wfDiff( $before, $after, $params='-u')
Returns unified plain-text diff of two texts.
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:935
wfIsCLI()
Check if we are running from the commandline.
wfLoadSkins(array $skins)
Load multiple skins at once.
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:214
wfQueriesMustScale()
Should low-performance queries be disabled?
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition: hooks.txt:1995
wfDebugMem( $exact=false)
Send a line giving PHP memory usage.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:780
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
wfGlobalCacheKey(... $args)
Make a cache key with database-agnostic prefix.
const PROTO_HTTP
Definition: Defines.php:219
$wgDebugLogPrefix
Prefix for debug log lines.
wfArrayInsertAfter(array $array, array $insert, $after)
Insert array into another array after the specified KEY
$wgMemoryLimit
The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP&#39;s memory limit i...
$wgDiff3
Path to the GNU diff3 utility.
wfAssembleUrl( $urlParts)
This function will reassemble a URL parsed with wfParseURL.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
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...
wfSplitWikiID( $wiki)
Split a wiki ID into DB name and table prefix.
wfGetLBFactory()
Get the load balancer factory object.
const PROTO_CANONICAL
Definition: Defines.php:223
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:780
wfRandom()
Get a random decimal value in the domain of [0, 1), in a way not likely to give duplicate values for ...
$lines
Definition: router.php:61
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
wfExpandIRI( $url)
Take a URL, make sure it&#39;s expanded to fully qualified, and replace any encoded non-ASCII Unicode cha...
$wgScriptPath
The path we should point to.
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don&#39;t exist.
static emitBufferedStatsdData(IBufferingStatsdDataFactory $stats, Config $config)
Send out any buffered statsd data according to sampling rules.
Definition: MediaWiki.php:935
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
wfGetMainCache()
Get the main cache object.
static pages()
Definition: SiteStats.php:112
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
$line
Definition: cdb.php:59
global $wgCommandLineMode
wfDebugBacktrace( $limit=0)
Safety wrapper for debug_backtrace().
$wgDBprefix
Table name prefix; this should be alphanumeric and not contain spaces nor hyphens.
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
wfRestoreWarnings()
static makeIndexes( $url)
Converts a URL into a format for el_index.
Definition: LinkFilter.php:171
$wgStyleDirectory
Filesystem stylesheets directory.
wfMemoryLimit()
Set PHP&#39;s memory limit to the larger of php.ini or $wgMemoryLimit.
wfClearOutputBuffers()
More legible than passing a &#39;false&#39; parameter to wfResetOutputBuffers():
controlled by the following MediaWiki still creates a BagOStuff but calls it to it are no ops If the cache daemon can t be it should also disable itself fairly $wgDBname
Definition: memcached.txt:93
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
wfTransactionalTimeLimit()
Set PHP&#39;s time limit to the larger of php.ini or $wgTransactionalTimeLimit.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2625
static deprecated( $function, $version=false, $component=false, $callerOffset=2)
Show a warning that $function is deprecated.
Definition: MWDebug.php:193
wfStringToBool( $val)
Convert string value to boolean, when the following are interpreted as true:
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
wfArrayFilterByKey(array $arr, callable $callback)
wfEscapeShellArg(... $args)
Version of escapeshellarg() that works better on Windows.
wfUnpack( $format, $data, $length=false)
Wrapper around php&#39;s unpack.
static legalChars()
Get a regex character class describing the legal characters in a link.
Definition: Title.php:634
wfMemcKey(... $args)
Make a cache key for the local wiki.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:728
$wgServer
URL of the server.
wfRelativePath( $path, $from)
Generate a relative path name to the given file.
$wgOut
Definition: Setup.php:896
wfCanIPUseHTTPS( $ip)
Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS...
wfBacktrace( $raw=null)
Get a debug backtrace as a string.
wfArrayDiff2( $a, $b)
Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
wfResetSessionID()
Reset the session id.
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
wfGetNull()
Get a platform-independent path to the null file, e.g.
wfBCP47( $code)
Get the normalised IETF language tag See unit test for examples.
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed)
Appends to second array if $value differs from that in $default.
wfArrayPlus2d(array $baseArray, array $newValues)
Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:51
wfAcceptToPrefs( $accept, $def=' */*')
Converts an Accept-* header into an array mapping string values to quality factors.
$ext
Definition: router.php:55
$wgResponsiveImages
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
wfLoadExtension( $ext, $path=null)
Load an extension.
$wgDiff
Path to the GNU diff utility.
$wgLoadScript
The URL path to load.php.
wfThumbIsStandard(File $file, array $params)
Returns true if these thumbnail parameters match one that MediaWiki requests from file description pa...
$wgDirectoryMode
Default value for chmoding of new directories.
wfGetLB( $wiki=false)
Get a load balancer object.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2625
wfArrayDiff2_cmp( $a, $b)
static users()
Definition: SiteStats.php:121
static bcp47( $code)
Get the normalised IETF language tag See unit test for examples.
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1486
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
wfObjectToArray( $objOrArray, $recursive=true)
Recursively converts the parameter (an object) to an array with the same data.
wfGetScriptUrl()
Get the script URL.
$matches
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
$wgTransactionalTimeLimit
The minimum amount of time that MediaWiki needs for "slow" write request, particularly ones with mult...
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:280