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  return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH );
152 }
153 
162 function wfArrayFilterByKey( array $arr, callable $callback ) {
163  return array_filter( $arr, $callback, ARRAY_FILTER_USE_KEY );
164 }
165 
175 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
176  if ( is_null( $changed ) ) {
177  throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
178  }
179  if ( $default[$key] !== $value ) {
180  $changed[$key] = $value;
181  }
182 }
183 
203 function wfMergeErrorArrays( ...$args ) {
204  $out = [];
205  foreach ( $args as $errors ) {
206  foreach ( $errors as $params ) {
207  $originalParams = $params;
208  if ( $params[0] instanceof MessageSpecifier ) {
209  $msg = $params[0];
210  $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
211  }
212  # @todo FIXME: Sometimes get nested arrays for $params,
213  # which leads to E_NOTICEs
214  $spec = implode( "\t", $params );
215  $out[$spec] = $originalParams;
216  }
217  }
218  return array_values( $out );
219 }
220 
229 function wfArrayInsertAfter( array $array, array $insert, $after ) {
230  // Find the offset of the element to insert after.
231  $keys = array_keys( $array );
232  $offsetByKey = array_flip( $keys );
233 
234  $offset = $offsetByKey[$after];
235 
236  // Insert at the specified offset
237  $before = array_slice( $array, 0, $offset + 1, true );
238  $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
239 
240  $output = $before + $insert + $after;
241 
242  return $output;
243 }
244 
252 function wfObjectToArray( $objOrArray, $recursive = true ) {
253  $array = [];
254  if ( is_object( $objOrArray ) ) {
255  $objOrArray = get_object_vars( $objOrArray );
256  }
257  foreach ( $objOrArray as $key => $value ) {
258  if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
260  }
261 
262  $array[$key] = $value;
263  }
264 
265  return $array;
266 }
267 
278 function wfRandom() {
279  // The maximum random value is "only" 2^31-1, so get two random
280  // values to reduce the chance of dupes
281  $max = mt_getrandmax() + 1;
282  $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
283  return $rand;
284 }
285 
296 function wfRandomString( $length = 32 ) {
297  $str = '';
298  for ( $n = 0; $n < $length; $n += 7 ) {
299  $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
300  }
301  return substr( $str, 0, $length );
302 }
303 
331 function wfUrlencode( $s ) {
332  static $needle;
333 
334  if ( is_null( $s ) ) {
335  $needle = null;
336  return '';
337  }
338 
339  if ( is_null( $needle ) ) {
340  $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
341  if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
342  ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
343  ) {
344  $needle[] = '%3A';
345  }
346  }
347 
348  $s = urlencode( $s );
349  $s = str_ireplace(
350  $needle,
351  [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
352  $s
353  );
354 
355  return $s;
356 }
357 
368 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
369  if ( !is_null( $array2 ) ) {
370  $array1 = $array1 + $array2;
371  }
372 
373  $cgi = '';
374  foreach ( $array1 as $key => $value ) {
375  if ( !is_null( $value ) && $value !== false ) {
376  if ( $cgi != '' ) {
377  $cgi .= '&';
378  }
379  if ( $prefix !== '' ) {
380  $key = $prefix . "[$key]";
381  }
382  if ( is_array( $value ) ) {
383  $firstTime = true;
384  foreach ( $value as $k => $v ) {
385  $cgi .= $firstTime ? '' : '&';
386  if ( is_array( $v ) ) {
387  $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
388  } else {
389  $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
390  }
391  $firstTime = false;
392  }
393  } else {
394  if ( is_object( $value ) ) {
395  $value = $value->__toString();
396  }
397  $cgi .= urlencode( $key ) . '=' . urlencode( $value );
398  }
399  }
400  }
401  return $cgi;
402 }
403 
413 function wfCgiToArray( $query ) {
414  if ( isset( $query[0] ) && $query[0] == '?' ) {
415  $query = substr( $query, 1 );
416  }
417  $bits = explode( '&', $query );
418  $ret = [];
419  foreach ( $bits as $bit ) {
420  if ( $bit === '' ) {
421  continue;
422  }
423  if ( strpos( $bit, '=' ) === false ) {
424  // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
425  $key = $bit;
426  $value = '';
427  } else {
428  list( $key, $value ) = explode( '=', $bit );
429  }
430  $key = urldecode( $key );
431  $value = urldecode( $value );
432  if ( strpos( $key, '[' ) !== false ) {
433  $keys = array_reverse( explode( '[', $key ) );
434  $key = array_pop( $keys );
435  $temp = $value;
436  foreach ( $keys as $k ) {
437  $k = substr( $k, 0, -1 );
438  $temp = [ $k => $temp ];
439  }
440  if ( isset( $ret[$key] ) ) {
441  $ret[$key] = array_merge( $ret[$key], $temp );
442  } else {
443  $ret[$key] = $temp;
444  }
445  } else {
446  $ret[$key] = $value;
447  }
448  }
449  return $ret;
450 }
451 
460 function wfAppendQuery( $url, $query ) {
461  if ( is_array( $query ) ) {
463  }
464  if ( $query != '' ) {
465  // Remove the fragment, if there is one
466  $fragment = false;
467  $hashPos = strpos( $url, '#' );
468  if ( $hashPos !== false ) {
469  $fragment = substr( $url, $hashPos );
470  $url = substr( $url, 0, $hashPos );
471  }
472 
473  // Add parameter
474  if ( false === strpos( $url, '?' ) ) {
475  $url .= '?';
476  } else {
477  $url .= '&';
478  }
479  $url .= $query;
480 
481  // Put the fragment back
482  if ( $fragment !== false ) {
483  $url .= $fragment;
484  }
485  }
486  return $url;
487 }
488 
512 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
514  $wgHttpsPort;
515  if ( $defaultProto === PROTO_CANONICAL ) {
516  $serverUrl = $wgCanonicalServer;
517  } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
518  // Make $wgInternalServer fall back to $wgServer if not set
519  $serverUrl = $wgInternalServer;
520  } else {
521  $serverUrl = $wgServer;
522  if ( $defaultProto === PROTO_CURRENT ) {
523  $defaultProto = $wgRequest->getProtocol() . '://';
524  }
525  }
526 
527  // Analyze $serverUrl to obtain its protocol
528  $bits = wfParseUrl( $serverUrl );
529  $serverHasProto = $bits && $bits['scheme'] != '';
530 
531  if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
532  if ( $serverHasProto ) {
533  $defaultProto = $bits['scheme'] . '://';
534  } else {
535  // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
536  // This really isn't supposed to happen. Fall back to HTTP in this
537  // ridiculous case.
538  $defaultProto = PROTO_HTTP;
539  }
540  }
541 
542  $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
543 
544  if ( substr( $url, 0, 2 ) == '//' ) {
545  $url = $defaultProtoWithoutSlashes . $url;
546  } elseif ( substr( $url, 0, 1 ) == '/' ) {
547  // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
548  // otherwise leave it alone.
549  if ( $serverHasProto ) {
550  $url = $serverUrl . $url;
551  } else {
552  // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
553  // user to override the port number (T67184)
554  if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
555  if ( isset( $bits['port'] ) ) {
556  throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
557  }
558  $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
559  } else {
560  $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
561  }
562  }
563  }
564 
565  $bits = wfParseUrl( $url );
566 
567  if ( $bits && isset( $bits['path'] ) ) {
568  $bits['path'] = wfRemoveDotSegments( $bits['path'] );
569  return wfAssembleUrl( $bits );
570  } elseif ( $bits ) {
571  # No path to expand
572  return $url;
573  } elseif ( substr( $url, 0, 1 ) != '/' ) {
574  # URL is a relative path
575  return wfRemoveDotSegments( $url );
576  }
577 
578  # Expanded URL is not valid.
579  return false;
580 }
581 
590 function wfGetServerUrl( $proto ) {
591  $url = wfExpandUrl( '/', $proto );
592  return substr( $url, 0, -1 );
593 }
594 
608 function wfAssembleUrl( $urlParts ) {
609  $result = '';
610 
611  if ( isset( $urlParts['delimiter'] ) ) {
612  if ( isset( $urlParts['scheme'] ) ) {
613  $result .= $urlParts['scheme'];
614  }
615 
616  $result .= $urlParts['delimiter'];
617  }
618 
619  if ( isset( $urlParts['host'] ) ) {
620  if ( isset( $urlParts['user'] ) ) {
621  $result .= $urlParts['user'];
622  if ( isset( $urlParts['pass'] ) ) {
623  $result .= ':' . $urlParts['pass'];
624  }
625  $result .= '@';
626  }
627 
628  $result .= $urlParts['host'];
629 
630  if ( isset( $urlParts['port'] ) ) {
631  $result .= ':' . $urlParts['port'];
632  }
633  }
634 
635  if ( isset( $urlParts['path'] ) ) {
636  $result .= $urlParts['path'];
637  }
638 
639  if ( isset( $urlParts['query'] ) ) {
640  $result .= '?' . $urlParts['query'];
641  }
642 
643  if ( isset( $urlParts['fragment'] ) ) {
644  $result .= '#' . $urlParts['fragment'];
645  }
646 
647  return $result;
648 }
649 
662 function wfRemoveDotSegments( $urlPath ) {
663  $output = '';
664  $inputOffset = 0;
665  $inputLength = strlen( $urlPath );
666 
667  while ( $inputOffset < $inputLength ) {
668  $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
669  $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
670  $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
671  $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
672  $trimOutput = false;
673 
674  if ( $prefixLengthTwo == './' ) {
675  # Step A, remove leading "./"
676  $inputOffset += 2;
677  } elseif ( $prefixLengthThree == '../' ) {
678  # Step A, remove leading "../"
679  $inputOffset += 3;
680  } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
681  # Step B, replace leading "/.$" with "/"
682  $inputOffset += 1;
683  $urlPath[$inputOffset] = '/';
684  } elseif ( $prefixLengthThree == '/./' ) {
685  # Step B, replace leading "/./" with "/"
686  $inputOffset += 2;
687  } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
688  # Step C, replace leading "/..$" with "/" and
689  # remove last path component in output
690  $inputOffset += 2;
691  $urlPath[$inputOffset] = '/';
692  $trimOutput = true;
693  } elseif ( $prefixLengthFour == '/../' ) {
694  # Step C, replace leading "/../" with "/" and
695  # remove last path component in output
696  $inputOffset += 3;
697  $trimOutput = true;
698  } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
699  # Step D, remove "^.$"
700  $inputOffset += 1;
701  } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
702  # Step D, remove "^..$"
703  $inputOffset += 2;
704  } else {
705  # Step E, move leading path segment to output
706  if ( $prefixLengthOne == '/' ) {
707  $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
708  } else {
709  $slashPos = strpos( $urlPath, '/', $inputOffset );
710  }
711  if ( $slashPos === false ) {
712  $output .= substr( $urlPath, $inputOffset );
713  $inputOffset = $inputLength;
714  } else {
715  $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
716  $inputOffset += $slashPos - $inputOffset;
717  }
718  }
719 
720  if ( $trimOutput ) {
721  $slashPos = strrpos( $output, '/' );
722  if ( $slashPos === false ) {
723  $output = '';
724  } else {
725  $output = substr( $output, 0, $slashPos );
726  }
727  }
728  }
729 
730  return $output;
731 }
732 
740 function wfUrlProtocols( $includeProtocolRelative = true ) {
741  global $wgUrlProtocols;
742 
743  // Cache return values separately based on $includeProtocolRelative
744  static $withProtRel = null, $withoutProtRel = null;
745  $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
746  if ( !is_null( $cachedValue ) ) {
747  return $cachedValue;
748  }
749 
750  // Support old-style $wgUrlProtocols strings, for backwards compatibility
751  // with LocalSettings files from 1.5
752  if ( is_array( $wgUrlProtocols ) ) {
753  $protocols = [];
754  foreach ( $wgUrlProtocols as $protocol ) {
755  // Filter out '//' if !$includeProtocolRelative
756  if ( $includeProtocolRelative || $protocol !== '//' ) {
757  $protocols[] = preg_quote( $protocol, '/' );
758  }
759  }
760 
761  $retval = implode( '|', $protocols );
762  } else {
763  // Ignore $includeProtocolRelative in this case
764  // This case exists for pre-1.6 compatibility, and we can safely assume
765  // that '//' won't appear in a pre-1.6 config because protocol-relative
766  // URLs weren't supported until 1.18
768  }
769 
770  // Cache return value
771  if ( $includeProtocolRelative ) {
772  $withProtRel = $retval;
773  } else {
774  $withoutProtRel = $retval;
775  }
776  return $retval;
777 }
778 
786  return wfUrlProtocols( false );
787 }
788 
814 function wfParseUrl( $url ) {
815  global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
816 
817  // Protocol-relative URLs are handled really badly by parse_url(). It's so
818  // bad that the easiest way to handle them is to just prepend 'http:' and
819  // strip the protocol out later.
820  $wasRelative = substr( $url, 0, 2 ) == '//';
821  if ( $wasRelative ) {
822  $url = "http:$url";
823  }
824  Wikimedia\suppressWarnings();
825  $bits = parse_url( $url );
826  Wikimedia\restoreWarnings();
827  // parse_url() returns an array without scheme for some invalid URLs, e.g.
828  // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
829  if ( !$bits || !isset( $bits['scheme'] ) ) {
830  return false;
831  }
832 
833  // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
834  $bits['scheme'] = strtolower( $bits['scheme'] );
835 
836  // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
837  if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
838  $bits['delimiter'] = '://';
839  } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
840  $bits['delimiter'] = ':';
841  // parse_url detects for news: and mailto: the host part of an url as path
842  // We have to correct this wrong detection
843  if ( isset( $bits['path'] ) ) {
844  $bits['host'] = $bits['path'];
845  $bits['path'] = '';
846  }
847  } else {
848  return false;
849  }
850 
851  /* Provide an empty host for eg. file:/// urls (see T30627) */
852  if ( !isset( $bits['host'] ) ) {
853  $bits['host'] = '';
854 
855  // See T47069
856  if ( isset( $bits['path'] ) ) {
857  /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
858  if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
859  $bits['path'] = '/' . $bits['path'];
860  }
861  } else {
862  $bits['path'] = '';
863  }
864  }
865 
866  // If the URL was protocol-relative, fix scheme and delimiter
867  if ( $wasRelative ) {
868  $bits['scheme'] = '';
869  $bits['delimiter'] = '//';
870  }
871  return $bits;
872 }
873 
884 function wfExpandIRI( $url ) {
885  return preg_replace_callback(
886  '/((?:%[89A-F][0-9A-F])+)/i',
887  function ( array $matches ) {
888  return urldecode( $matches[1] );
889  },
890  wfExpandUrl( $url )
891  );
892 }
893 
900 function wfMakeUrlIndexes( $url ) {
901  $bits = wfParseUrl( $url );
902 
903  // Reverse the labels in the hostname, convert to lower case
904  // For emails reverse domainpart only
905  if ( $bits['scheme'] == 'mailto' ) {
906  $mailparts = explode( '@', $bits['host'], 2 );
907  if ( count( $mailparts ) === 2 ) {
908  $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
909  } else {
910  // No domain specified, don't mangle it
911  $domainpart = '';
912  }
913  $reversedHost = $domainpart . '@' . $mailparts[0];
914  } else {
915  $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
916  }
917  // Add an extra dot to the end
918  // Why? Is it in wrong place in mailto links?
919  if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
920  $reversedHost .= '.';
921  }
922  // Reconstruct the pseudo-URL
923  $prot = $bits['scheme'];
924  $index = $prot . $bits['delimiter'] . $reversedHost;
925  // Leave out user and password. Add the port, path, query and fragment
926  if ( isset( $bits['port'] ) ) {
927  $index .= ':' . $bits['port'];
928  }
929  if ( isset( $bits['path'] ) ) {
930  $index .= $bits['path'];
931  } else {
932  $index .= '/';
933  }
934  if ( isset( $bits['query'] ) ) {
935  $index .= '?' . $bits['query'];
936  }
937  if ( isset( $bits['fragment'] ) ) {
938  $index .= '#' . $bits['fragment'];
939  }
940 
941  if ( $prot == '' ) {
942  return [ "http:$index", "https:$index" ];
943  } else {
944  return [ $index ];
945  }
946 }
947 
954 function wfMatchesDomainList( $url, $domains ) {
955  $bits = wfParseUrl( $url );
956  if ( is_array( $bits ) && isset( $bits['host'] ) ) {
957  $host = '.' . $bits['host'];
958  foreach ( (array)$domains as $domain ) {
959  $domain = '.' . $domain;
960  if ( substr( $host, -strlen( $domain ) ) === $domain ) {
961  return true;
962  }
963  }
964  }
965  return false;
966 }
967 
988 function wfDebug( $text, $dest = 'all', array $context = [] ) {
990  global $wgDebugTimestamps;
991 
992  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
993  return;
994  }
995 
996  $text = trim( $text );
997 
998  if ( $wgDebugTimestamps ) {
999  $context['seconds_elapsed'] = sprintf(
1000  '%6.4f',
1001  microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
1002  );
1003  $context['memory_used'] = sprintf(
1004  '%5.1fM',
1005  ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1006  );
1007  }
1008 
1009  if ( $wgDebugLogPrefix !== '' ) {
1010  $context['prefix'] = $wgDebugLogPrefix;
1011  }
1012  $context['private'] = ( $dest === false || $dest === 'private' );
1013 
1014  $logger = LoggerFactory::getInstance( 'wfDebug' );
1015  $logger->debug( $text, $context );
1016 }
1017 
1022 function wfIsDebugRawPage() {
1023  static $cache;
1024  if ( $cache !== null ) {
1025  return $cache;
1026  }
1027  // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1028  // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
1029  if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1030  || (
1031  isset( $_SERVER['SCRIPT_NAME'] )
1032  && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1033  )
1034  ) {
1035  $cache = true;
1036  } else {
1037  $cache = false;
1038  }
1039  return $cache;
1040 }
1041 
1047 function wfDebugMem( $exact = false ) {
1048  $mem = memory_get_usage();
1049  if ( !$exact ) {
1050  $mem = floor( $mem / 1024 ) . ' KiB';
1051  } else {
1052  $mem .= ' B';
1053  }
1054  wfDebug( "Memory usage: $mem\n" );
1055 }
1056 
1082 function wfDebugLog(
1083  $logGroup, $text, $dest = 'all', array $context = []
1084 ) {
1085  $text = trim( $text );
1086 
1087  $logger = LoggerFactory::getInstance( $logGroup );
1088  $context['private'] = ( $dest === false || $dest === 'private' );
1089  $logger->info( $text, $context );
1090 }
1091 
1100 function wfLogDBError( $text, array $context = [] ) {
1101  $logger = LoggerFactory::getInstance( 'wfLogDBError' );
1102  $logger->error( trim( $text ), $context );
1103 }
1104 
1118 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1119  MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1120 }
1121 
1132 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1133  MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1134 }
1135 
1145 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1146  MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1147 }
1148 
1155 
1157  $request = $context->getRequest();
1158 
1159  $profiler = Profiler::instance();
1160  $profiler->setContext( $context );
1161  $profiler->logData();
1162 
1163  // Send out any buffered statsd metrics as needed
1165  MediaWikiServices::getInstance()->getStatsdDataFactory(),
1166  $context->getConfig()
1167  );
1168 
1169  // Profiling must actually be enabled...
1170  if ( $profiler instanceof ProfilerStub ) {
1171  return;
1172  }
1173 
1174  if ( isset( $wgDebugLogGroups['profileoutput'] )
1175  && $wgDebugLogGroups['profileoutput'] === false
1176  ) {
1177  // Explicitly disabled
1178  return;
1179  }
1180  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1181  return;
1182  }
1183 
1184  $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1185  if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1186  $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1187  }
1188  if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1189  $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1190  }
1191  if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1192  $ctx['from'] = $_SERVER['HTTP_FROM'];
1193  }
1194  if ( isset( $ctx['forwarded_for'] ) ||
1195  isset( $ctx['client_ip'] ) ||
1196  isset( $ctx['from'] ) ) {
1197  $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1198  }
1199 
1200  // Don't load $wgUser at this late stage just for statistics purposes
1201  // @todo FIXME: We can detect some anons even if it is not loaded.
1202  // See User::getId()
1203  $user = $context->getUser();
1204  $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1205 
1206  // Command line script uses a FauxRequest object which does not have
1207  // any knowledge about an URL and throw an exception instead.
1208  try {
1209  $ctx['url'] = urldecode( $request->getRequestURL() );
1210  } catch ( Exception $ignored ) {
1211  // no-op
1212  }
1213 
1214  $ctx['output'] = $profiler->getOutput();
1215 
1216  $log = LoggerFactory::getInstance( 'profileoutput' );
1217  $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1218 }
1219 
1227 function wfIncrStats( $key, $count = 1 ) {
1228  $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1229  $stats->updateCount( $key, $count );
1230 }
1231 
1237 function wfReadOnly() {
1238  return MediaWikiServices::getInstance()->getReadOnlyMode()
1239  ->isReadOnly();
1240 }
1241 
1250 function wfReadOnlyReason() {
1251  return MediaWikiServices::getInstance()->getReadOnlyMode()
1252  ->getReason();
1253 }
1254 
1262  return MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1263  ->getReason();
1264 }
1265 
1281 function wfGetLangObj( $langcode = false ) {
1282  # Identify which language to get or create a language object for.
1283  # Using is_object here due to Stub objects.
1284  if ( is_object( $langcode ) ) {
1285  # Great, we already have the object (hopefully)!
1286  return $langcode;
1287  }
1288 
1289  global $wgLanguageCode;
1290  if ( $langcode === true || $langcode === $wgLanguageCode ) {
1291  # $langcode is the language code of the wikis content language object.
1292  # or it is a boolean and value is true
1293  return MediaWikiServices::getInstance()->getContentLanguage();
1294  }
1295 
1296  global $wgLang;
1297  if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1298  # $langcode is the language code of user language object.
1299  # or it was a boolean and value is false
1300  return $wgLang;
1301  }
1302 
1303  $validCodes = array_keys( Language::fetchLanguageNames() );
1304  if ( in_array( $langcode, $validCodes ) ) {
1305  # $langcode corresponds to a valid language.
1306  return Language::factory( $langcode );
1307  }
1308 
1309  # $langcode is a string, but not a valid language code; use content language.
1310  wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1311  return MediaWikiServices::getInstance()->getContentLanguage();
1312 }
1313 
1330 function wfMessage( $key, ...$params ) {
1331  $message = new Message( $key );
1332 
1333  // We call Message::params() to reduce code duplication
1334  if ( $params ) {
1335  $message->params( ...$params );
1336  }
1337 
1338  return $message;
1339 }
1340 
1353 function wfMessageFallback( ...$keys ) {
1354  return Message::newFallbackSequence( ...$keys );
1355 }
1356 
1365 function wfMsgReplaceArgs( $message, $args ) {
1366  # Fix windows line-endings
1367  # Some messages are split with explode("\n", $msg)
1368  $message = str_replace( "\r", '', $message );
1369 
1370  // Replace arguments
1371  if ( is_array( $args ) && $args ) {
1372  if ( is_array( $args[0] ) ) {
1373  $args = array_values( $args[0] );
1374  }
1375  $replacementKeys = [];
1376  foreach ( $args as $n => $param ) {
1377  $replacementKeys['$' . ( $n + 1 )] = $param;
1378  }
1379  $message = strtr( $message, $replacementKeys );
1380  }
1381 
1382  return $message;
1383 }
1384 
1392 function wfHostname() {
1393  static $host;
1394  if ( is_null( $host ) ) {
1395  # Hostname overriding
1396  global $wgOverrideHostname;
1397  if ( $wgOverrideHostname !== false ) {
1398  # Set static and skip any detection
1399  $host = $wgOverrideHostname;
1400  return $host;
1401  }
1402 
1403  if ( function_exists( 'posix_uname' ) ) {
1404  // This function not present on Windows
1405  $uname = posix_uname();
1406  } else {
1407  $uname = false;
1408  }
1409  if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1410  $host = $uname['nodename'];
1411  } elseif ( getenv( 'COMPUTERNAME' ) ) {
1412  # Windows computer name
1413  $host = getenv( 'COMPUTERNAME' );
1414  } else {
1415  # This may be a virtual server.
1416  $host = $_SERVER['SERVER_NAME'];
1417  }
1418  }
1419  return $host;
1420 }
1421 
1432 function wfReportTime( $nonce = null ) {
1433  global $wgShowHostnames;
1434 
1435  $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1436  // seconds to milliseconds
1437  $responseTime = round( $elapsed * 1000 );
1438  $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1439  if ( $wgShowHostnames ) {
1440  $reportVars['wgHostname'] = wfHostname();
1441  }
1442  return Skin::makeVariablesScript( $reportVars, $nonce );
1443 }
1444 
1455 function wfDebugBacktrace( $limit = 0 ) {
1456  static $disabled = null;
1457 
1458  if ( is_null( $disabled ) ) {
1459  $disabled = !function_exists( 'debug_backtrace' );
1460  if ( $disabled ) {
1461  wfDebug( "debug_backtrace() is disabled\n" );
1462  }
1463  }
1464  if ( $disabled ) {
1465  return [];
1466  }
1467 
1468  if ( $limit ) {
1469  return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1470  } else {
1471  return array_slice( debug_backtrace(), 1 );
1472  }
1473 }
1474 
1483 function wfBacktrace( $raw = null ) {
1484  global $wgCommandLineMode;
1485 
1486  if ( $raw === null ) {
1487  $raw = $wgCommandLineMode;
1488  }
1489 
1490  if ( $raw ) {
1491  $frameFormat = "%s line %s calls %s()\n";
1492  $traceFormat = "%s";
1493  } else {
1494  $frameFormat = "<li>%s line %s calls %s()</li>\n";
1495  $traceFormat = "<ul>\n%s</ul>\n";
1496  }
1497 
1498  $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1499  $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1500  $line = $frame['line'] ?? '-';
1501  $call = $frame['function'];
1502  if ( !empty( $frame['class'] ) ) {
1503  $call = $frame['class'] . $frame['type'] . $call;
1504  }
1505  return sprintf( $frameFormat, $file, $line, $call );
1506  }, wfDebugBacktrace() );
1507 
1508  return sprintf( $traceFormat, implode( '', $frames ) );
1509 }
1510 
1520 function wfGetCaller( $level = 2 ) {
1521  $backtrace = wfDebugBacktrace( $level + 1 );
1522  if ( isset( $backtrace[$level] ) ) {
1523  return wfFormatStackFrame( $backtrace[$level] );
1524  } else {
1525  return 'unknown';
1526  }
1527 }
1528 
1536 function wfGetAllCallers( $limit = 3 ) {
1537  $trace = array_reverse( wfDebugBacktrace() );
1538  if ( !$limit || $limit > count( $trace ) - 1 ) {
1539  $limit = count( $trace ) - 1;
1540  }
1541  $trace = array_slice( $trace, -$limit - 1, $limit );
1542  return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1543 }
1544 
1551 function wfFormatStackFrame( $frame ) {
1552  if ( !isset( $frame['function'] ) ) {
1553  return 'NO_FUNCTION_GIVEN';
1554  }
1555  return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1556  $frame['class'] . $frame['type'] . $frame['function'] :
1557  $frame['function'];
1558 }
1559 
1560 /* Some generic result counters, pulled out of SearchEngine */
1561 
1569 function wfShowingResults( $offset, $limit ) {
1570  return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1571 }
1572 
1582 function wfClientAcceptsGzip( $force = false ) {
1583  static $result = null;
1584  if ( $result === null || $force ) {
1585  $result = false;
1586  if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1587  # @todo FIXME: We may want to blacklist some broken browsers
1588  $m = [];
1589  if ( preg_match(
1590  '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1591  $_SERVER['HTTP_ACCEPT_ENCODING'],
1592  $m
1593  )
1594  ) {
1595  if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1596  $result = false;
1597  return $result;
1598  }
1599  wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1600  $result = true;
1601  }
1602  }
1603  }
1604  return $result;
1605 }
1606 
1617 function wfEscapeWikiText( $text ) {
1618  global $wgEnableMagicLinks;
1619  static $repl = null, $repl2 = null;
1620  if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1621  // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1622  // in those situations
1623  $repl = [
1624  '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1625  '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1626  '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1627  "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1628  "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1629  "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1630  "\n " => "\n&#32;", "\r " => "\r&#32;",
1631  "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1632  "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1633  "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1634  "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1635  '__' => '_&#95;', '://' => '&#58;//',
1636  ];
1637 
1638  $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1639  // We have to catch everything "\s" matches in PCRE
1640  foreach ( $magicLinks as $magic ) {
1641  $repl["$magic "] = "$magic&#32;";
1642  $repl["$magic\t"] = "$magic&#9;";
1643  $repl["$magic\r"] = "$magic&#13;";
1644  $repl["$magic\n"] = "$magic&#10;";
1645  $repl["$magic\f"] = "$magic&#12;";
1646  }
1647 
1648  // And handle protocols that don't use "://"
1649  global $wgUrlProtocols;
1650  $repl2 = [];
1651  foreach ( $wgUrlProtocols as $prot ) {
1652  if ( substr( $prot, -1 ) === ':' ) {
1653  $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1654  }
1655  }
1656  $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1657  }
1658  $text = substr( strtr( "\n$text", $repl ), 1 );
1659  $text = preg_replace( $repl2, '$1&#58;', $text );
1660  return $text;
1661 }
1662 
1673 function wfSetVar( &$dest, $source, $force = false ) {
1674  $temp = $dest;
1675  if ( !is_null( $source ) || $force ) {
1676  $dest = $source;
1677  }
1678  return $temp;
1679 }
1680 
1690 function wfSetBit( &$dest, $bit, $state = true ) {
1691  $temp = (bool)( $dest & $bit );
1692  if ( !is_null( $state ) ) {
1693  if ( $state ) {
1694  $dest |= $bit;
1695  } else {
1696  $dest &= ~$bit;
1697  }
1698  }
1699  return $temp;
1700 }
1701 
1708 function wfVarDump( $var ) {
1709  global $wgOut;
1710  $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1711  if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1712  print $s;
1713  } else {
1714  $wgOut->addHTML( $s );
1715  }
1716 }
1717 
1725 function wfHttpError( $code, $label, $desc ) {
1726  global $wgOut;
1728  if ( $wgOut ) {
1729  $wgOut->disable();
1730  $wgOut->sendCacheControl();
1731  }
1732 
1734  header( 'Content-type: text/html; charset=utf-8' );
1735  print '<!DOCTYPE html>' .
1736  '<html><head><title>' .
1737  htmlspecialchars( $label ) .
1738  '</title></head><body><h1>' .
1739  htmlspecialchars( $label ) .
1740  '</h1><p>' .
1741  nl2br( htmlspecialchars( $desc ) ) .
1742  "</p></body></html>\n";
1743 }
1744 
1762 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1763  if ( $resetGzipEncoding ) {
1764  // Suppress Content-Encoding and Content-Length
1765  // headers from OutputHandler::handle.
1767  $wgDisableOutputCompression = true;
1768  }
1769  while ( $status = ob_get_status() ) {
1770  if ( isset( $status['flags'] ) ) {
1771  $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1772  $deleteable = ( $status['flags'] & $flags ) === $flags;
1773  } elseif ( isset( $status['del'] ) ) {
1774  $deleteable = $status['del'];
1775  } else {
1776  // Guess that any PHP-internal setting can't be removed.
1777  $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1778  }
1779  if ( !$deleteable ) {
1780  // Give up, and hope the result doesn't break
1781  // output behavior.
1782  break;
1783  }
1784  if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1785  // Unit testing barrier to prevent this function from breaking PHPUnit.
1786  break;
1787  }
1788  if ( !ob_end_clean() ) {
1789  // Could not remove output buffer handler; abort now
1790  // to avoid getting in some kind of infinite loop.
1791  break;
1792  }
1793  if ( $resetGzipEncoding ) {
1794  if ( $status['name'] == 'ob_gzhandler' ) {
1795  // Reset the 'Content-Encoding' field set by this handler
1796  // so we can start fresh.
1797  header_remove( 'Content-Encoding' );
1798  break;
1799  }
1800  }
1801  }
1802 }
1803 
1817  wfResetOutputBuffers( false );
1818 }
1819 
1828 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1829  # No arg means accept anything (per HTTP spec)
1830  if ( !$accept ) {
1831  return [ $def => 1.0 ];
1832  }
1833 
1834  $prefs = [];
1835 
1836  $parts = explode( ',', $accept );
1837 
1838  foreach ( $parts as $part ) {
1839  # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1840  $values = explode( ';', trim( $part ) );
1841  $match = [];
1842  if ( count( $values ) == 1 ) {
1843  $prefs[$values[0]] = 1.0;
1844  } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1845  $prefs[$values[0]] = floatval( $match[1] );
1846  }
1847  }
1848 
1849  return $prefs;
1850 }
1851 
1864 function mimeTypeMatch( $type, $avail ) {
1865  if ( array_key_exists( $type, $avail ) ) {
1866  return $type;
1867  } else {
1868  $mainType = explode( '/', $type )[0];
1869  if ( array_key_exists( "$mainType/*", $avail ) ) {
1870  return "$mainType/*";
1871  } elseif ( array_key_exists( '*/*', $avail ) ) {
1872  return '*/*';
1873  } else {
1874  return null;
1875  }
1876  }
1877 }
1878 
1892 function wfNegotiateType( $cprefs, $sprefs ) {
1893  $combine = [];
1894 
1895  foreach ( array_keys( $sprefs ) as $type ) {
1896  $subType = explode( '/', $type )[1];
1897  if ( $subType != '*' ) {
1898  $ckey = mimeTypeMatch( $type, $cprefs );
1899  if ( $ckey ) {
1900  $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1901  }
1902  }
1903  }
1904 
1905  foreach ( array_keys( $cprefs ) as $type ) {
1906  $subType = explode( '/', $type )[1];
1907  if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1908  $skey = mimeTypeMatch( $type, $sprefs );
1909  if ( $skey ) {
1910  $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1911  }
1912  }
1913  }
1914 
1915  $bestq = 0;
1916  $besttype = null;
1917 
1918  foreach ( array_keys( $combine ) as $type ) {
1919  if ( $combine[$type] > $bestq ) {
1920  $besttype = $type;
1921  $bestq = $combine[$type];
1922  }
1923  }
1924 
1925  return $besttype;
1926 }
1927 
1934 function wfSuppressWarnings( $end = false ) {
1935  Wikimedia\suppressWarnings( $end );
1936 }
1937 
1942 function wfRestoreWarnings() {
1943  Wikimedia\restoreWarnings();
1944 }
1945 
1954 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1955  $ret = MWTimestamp::convert( $outputtype, $ts );
1956  if ( $ret === false ) {
1957  wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1958  }
1959  return $ret;
1960 }
1961 
1970 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1971  if ( is_null( $ts ) ) {
1972  return null;
1973  } else {
1974  return wfTimestamp( $outputtype, $ts );
1975  }
1976 }
1977 
1983 function wfTimestampNow() {
1984  # return NOW
1985  return MWTimestamp::now( TS_MW );
1986 }
1987 
1993 function wfIsWindows() {
1994  static $isWindows = null;
1995  if ( $isWindows === null ) {
1996  $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
1997  }
1998  return $isWindows;
1999 }
2000 
2006 function wfIsHHVM() {
2007  return defined( 'HHVM_VERSION' );
2008 }
2009 
2016 function wfIsCLI() {
2017  return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
2018 }
2019 
2031 function wfTempDir() {
2032  global $wgTmpDirectory;
2033 
2034  if ( $wgTmpDirectory !== false ) {
2035  return $wgTmpDirectory;
2036  }
2037 
2039 }
2040 
2050 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2051  global $wgDirectoryMode;
2052 
2053  if ( FileBackend::isStoragePath( $dir ) ) { // sanity
2054  throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
2055  }
2056 
2057  if ( !is_null( $caller ) ) {
2058  wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2059  }
2060 
2061  if ( strval( $dir ) === '' || is_dir( $dir ) ) {
2062  return true;
2063  }
2064 
2065  $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
2066 
2067  if ( is_null( $mode ) ) {
2068  $mode = $wgDirectoryMode;
2069  }
2070 
2071  // Turn off the normal warning, we're doing our own below
2072  Wikimedia\suppressWarnings();
2073  $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2074  Wikimedia\restoreWarnings();
2075 
2076  if ( !$ok ) {
2077  // directory may have been created on another request since we last checked
2078  if ( is_dir( $dir ) ) {
2079  return true;
2080  }
2081 
2082  // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2083  wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2084  }
2085  return $ok;
2086 }
2087 
2093 function wfRecursiveRemoveDir( $dir ) {
2094  wfDebug( __FUNCTION__ . "( $dir )\n" );
2095  // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2096  if ( is_dir( $dir ) ) {
2097  $objects = scandir( $dir );
2098  foreach ( $objects as $object ) {
2099  if ( $object != "." && $object != ".." ) {
2100  if ( filetype( $dir . '/' . $object ) == "dir" ) {
2101  wfRecursiveRemoveDir( $dir . '/' . $object );
2102  } else {
2103  unlink( $dir . '/' . $object );
2104  }
2105  }
2106  }
2107  reset( $objects );
2108  rmdir( $dir );
2109  }
2110 }
2111 
2118 function wfPercent( $nr, $acc = 2, $round = true ) {
2119  $ret = sprintf( "%.${acc}f", $nr );
2120  return $round ? round( $ret, $acc ) . '%' : "$ret%";
2121 }
2122 
2146 function wfIniGetBool( $setting ) {
2147  return wfStringToBool( ini_get( $setting ) );
2148 }
2149 
2162 function wfStringToBool( $val ) {
2163  $val = strtolower( $val );
2164  // 'on' and 'true' can't have whitespace around them, but '1' can.
2165  return $val == 'on'
2166  || $val == 'true'
2167  || $val == 'yes'
2168  || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2169 }
2170 
2183 function wfEscapeShellArg( ...$args ) {
2184  return Shell::escape( ...$args );
2185 }
2186 
2210 function wfShellExec( $cmd, &$retval = null, $environ = [],
2211  $limits = [], $options = []
2212 ) {
2213  if ( Shell::isDisabled() ) {
2214  $retval = 1;
2215  // Backwards compatibility be upon us...
2216  return 'Unable to run external programs, proc_open() is disabled.';
2217  }
2218 
2219  if ( is_array( $cmd ) ) {
2220  $cmd = Shell::escape( $cmd );
2221  }
2222 
2223  $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2224  $profileMethod = $options['profileMethod'] ?? wfGetCaller();
2225 
2226  try {
2227  $result = Shell::command( [] )
2228  ->unsafeParams( (array)$cmd )
2229  ->environment( $environ )
2230  ->limits( $limits )
2231  ->includeStderr( $includeStderr )
2232  ->profileMethod( $profileMethod )
2233  // For b/c
2234  ->restrict( Shell::RESTRICT_NONE )
2235  ->execute();
2236  } catch ( ProcOpenError $ex ) {
2237  $retval = -1;
2238  return '';
2239  }
2240 
2241  $retval = $result->getExitCode();
2242 
2243  return $result->getStdout();
2244 }
2245 
2263 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2264  return wfShellExec( $cmd, $retval, $environ, $limits,
2265  [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2266 }
2267 
2282 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2283  global $wgPhpCli;
2284  // Give site config file a chance to run the script in a wrapper.
2285  // The caller may likely want to call wfBasename() on $script.
2286  Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2287  $cmd = [ $options['php'] ?? $wgPhpCli ];
2288  if ( isset( $options['wrapper'] ) ) {
2289  $cmd[] = $options['wrapper'];
2290  }
2291  $cmd[] = $script;
2292  // Escape each parameter for shell
2293  return Shell::escape( array_merge( $cmd, $parameters ) );
2294 }
2295 
2307 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2308  global $wgDiff3;
2309 
2310  # This check may also protect against code injection in
2311  # case of broken installations.
2312  Wikimedia\suppressWarnings();
2313  $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2314  Wikimedia\restoreWarnings();
2315 
2316  if ( !$haveDiff3 ) {
2317  wfDebug( "diff3 not found\n" );
2318  return false;
2319  }
2320 
2321  # Make temporary files
2322  $td = wfTempDir();
2323  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2324  $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2325  $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2326 
2327  # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2328  # a newline character. To avoid this, we normalize the trailing whitespace before
2329  # creating the diff.
2330 
2331  fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2332  fclose( $oldtextFile );
2333  fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2334  fclose( $mytextFile );
2335  fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2336  fclose( $yourtextFile );
2337 
2338  # Check for a conflict
2339  $cmd = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2340  $oldtextName, $yourtextName );
2341  $handle = popen( $cmd, 'r' );
2342 
2343  $mergeAttemptResult = '';
2344  do {
2345  $data = fread( $handle, 8192 );
2346  if ( strlen( $data ) == 0 ) {
2347  break;
2348  }
2349  $mergeAttemptResult .= $data;
2350  } while ( true );
2351  pclose( $handle );
2352 
2353  $conflict = $mergeAttemptResult !== '';
2354 
2355  # Merge differences
2356  $cmd = Shell::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2357  $oldtextName, $yourtextName );
2358  $handle = popen( $cmd, 'r' );
2359  $result = '';
2360  do {
2361  $data = fread( $handle, 8192 );
2362  if ( strlen( $data ) == 0 ) {
2363  break;
2364  }
2365  $result .= $data;
2366  } while ( true );
2367  pclose( $handle );
2368  unlink( $mytextName );
2369  unlink( $oldtextName );
2370  unlink( $yourtextName );
2371 
2372  if ( $result === '' && $old !== '' && !$conflict ) {
2373  wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2374  $conflict = true;
2375  }
2376  return !$conflict;
2377 }
2378 
2390 function wfDiff( $before, $after, $params = '-u' ) {
2391  if ( $before == $after ) {
2392  return '';
2393  }
2394 
2395  global $wgDiff;
2396  Wikimedia\suppressWarnings();
2397  $haveDiff = $wgDiff && file_exists( $wgDiff );
2398  Wikimedia\restoreWarnings();
2399 
2400  # This check may also protect against code injection in
2401  # case of broken installations.
2402  if ( !$haveDiff ) {
2403  wfDebug( "diff executable not found\n" );
2404  $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2405  $format = new UnifiedDiffFormatter();
2406  return $format->format( $diffs );
2407  }
2408 
2409  # Make temporary files
2410  $td = wfTempDir();
2411  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2412  $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2413 
2414  fwrite( $oldtextFile, $before );
2415  fclose( $oldtextFile );
2416  fwrite( $newtextFile, $after );
2417  fclose( $newtextFile );
2418 
2419  // Get the diff of the two files
2420  $cmd = "$wgDiff " . $params . ' ' . Shell::escape( $oldtextName, $newtextName );
2421 
2422  $h = popen( $cmd, 'r' );
2423  if ( !$h ) {
2424  unlink( $oldtextName );
2425  unlink( $newtextName );
2426  throw new Exception( __METHOD__ . '(): popen() failed' );
2427  }
2428 
2429  $diff = '';
2430 
2431  do {
2432  $data = fread( $h, 8192 );
2433  if ( strlen( $data ) == 0 ) {
2434  break;
2435  }
2436  $diff .= $data;
2437  } while ( true );
2438 
2439  // Clean up
2440  pclose( $h );
2441  unlink( $oldtextName );
2442  unlink( $newtextName );
2443 
2444  // Kill the --- and +++ lines. They're not useful.
2445  $diff_lines = explode( "\n", $diff );
2446  if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2447  unset( $diff_lines[0] );
2448  }
2449  if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2450  unset( $diff_lines[1] );
2451  }
2452 
2453  $diff = implode( "\n", $diff_lines );
2454 
2455  return $diff;
2456 }
2457 
2470 function wfBaseName( $path, $suffix = '' ) {
2471  if ( $suffix == '' ) {
2472  $encSuffix = '';
2473  } else {
2474  $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2475  }
2476 
2477  $matches = [];
2478  if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2479  return $matches[1];
2480  } else {
2481  return '';
2482  }
2483 }
2484 
2494 function wfRelativePath( $path, $from ) {
2495  // Normalize mixed input on Windows...
2496  $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2497  $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2498 
2499  // Trim trailing slashes -- fix for drive root
2500  $path = rtrim( $path, DIRECTORY_SEPARATOR );
2501  $from = rtrim( $from, DIRECTORY_SEPARATOR );
2502 
2503  $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2504  $against = explode( DIRECTORY_SEPARATOR, $from );
2505 
2506  if ( $pieces[0] !== $against[0] ) {
2507  // Non-matching Windows drive letters?
2508  // Return a full path.
2509  return $path;
2510  }
2511 
2512  // Trim off common prefix
2513  while ( count( $pieces ) && count( $against )
2514  && $pieces[0] == $against[0] ) {
2515  array_shift( $pieces );
2516  array_shift( $against );
2517  }
2518 
2519  // relative dots to bump us to the parent
2520  while ( count( $against ) ) {
2521  array_unshift( $pieces, '..' );
2522  array_shift( $against );
2523  }
2524 
2525  array_push( $pieces, wfBaseName( $path ) );
2526 
2527  return implode( DIRECTORY_SEPARATOR, $pieces );
2528 }
2529 
2536 function wfResetSessionID() {
2537  wfDeprecated( __FUNCTION__, '1.27' );
2538  $session = SessionManager::getGlobalSession();
2539  $delay = $session->delaySave();
2540 
2541  $session->resetId();
2542 
2543  // Make sure a session is started, since that's what the old
2544  // wfResetSessionID() did.
2545  if ( session_id() !== $session->getId() ) {
2546  wfSetupSession( $session->getId() );
2547  }
2548 
2549  ScopedCallback::consume( $delay );
2550 }
2551 
2561 function wfSetupSession( $sessionId = false ) {
2562  wfDeprecated( __FUNCTION__, '1.27' );
2563 
2564  if ( $sessionId ) {
2565  session_id( $sessionId );
2566  }
2567 
2568  $session = SessionManager::getGlobalSession();
2569  $session->persist();
2570 
2571  if ( session_id() !== $session->getId() ) {
2572  session_id( $session->getId() );
2573  }
2574  Wikimedia\quietCall( 'session_start' );
2575 }
2576 
2584  global $IP;
2585 
2586  $file = "$IP/serialized/$name";
2587  if ( file_exists( $file ) ) {
2588  $blob = file_get_contents( $file );
2589  if ( $blob ) {
2590  return unserialize( $blob );
2591  }
2592  }
2593  return false;
2594 }
2595 
2603 function wfMemcKey( ...$args ) {
2604  return ObjectCache::getLocalClusterInstance()->makeKey( ...$args );
2605 }
2606 
2617 function wfForeignMemcKey( $db, $prefix, ...$args ) {
2618  $keyspace = $prefix ? "$db-$prefix" : $db;
2619  return ObjectCache::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2620 }
2621 
2634 function wfGlobalCacheKey( ...$args ) {
2635  return ObjectCache::getLocalClusterInstance()->makeGlobalKey( ...$args );
2636 }
2637 
2644 function wfWikiID() {
2645  global $wgDBprefix, $wgDBname;
2646  if ( $wgDBprefix ) {
2647  return "$wgDBname-$wgDBprefix";
2648  } else {
2649  return $wgDBname;
2650  }
2651 }
2652 
2660 function wfSplitWikiID( $wiki ) {
2661  $bits = explode( '-', $wiki, 2 );
2662  if ( count( $bits ) < 2 ) {
2663  $bits[] = '';
2664  }
2665  return $bits;
2666 }
2667 
2693 function wfGetDB( $db, $groups = [], $wiki = false ) {
2694  return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2695 }
2696 
2706 function wfGetLB( $wiki = false ) {
2707  if ( $wiki === false ) {
2708  return MediaWikiServices::getInstance()->getDBLoadBalancer();
2709  } else {
2710  $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2711  return $factory->getMainLB( $wiki );
2712  }
2713 }
2714 
2722 function wfGetLBFactory() {
2723  return MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2724 }
2725 
2734 function wfFindFile( $title, $options = [] ) {
2735  return RepoGroup::singleton()->findFile( $title, $options );
2736 }
2737 
2745 function wfLocalFile( $title ) {
2746  return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
2747 }
2748 
2756  global $wgMiserMode;
2757  return $wgMiserMode
2758  || ( SiteStats::pages() > 100000
2759  && SiteStats::edits() > 1000000
2760  && SiteStats::users() > 10000 );
2761 }
2762 
2771 function wfScript( $script = 'index' ) {
2773  if ( $script === 'index' ) {
2774  return $wgScript;
2775  } elseif ( $script === 'load' ) {
2776  return $wgLoadScript;
2777  } else {
2778  return "{$wgScriptPath}/{$script}.php";
2779  }
2780 }
2781 
2787 function wfGetScriptUrl() {
2788  if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2789  /* as it was called, minus the query string.
2790  *
2791  * Some sites use Apache rewrite rules to handle subdomains,
2792  * and have PHP set up in a weird way that causes PHP_SELF
2793  * to contain the rewritten URL instead of the one that the
2794  * outside world sees.
2795  *
2796  * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2797  * provides containing the "before" URL.
2798  */
2799  return $_SERVER['SCRIPT_NAME'];
2800  } else {
2801  return $_SERVER['URL'];
2802  }
2803 }
2804 
2812 function wfBoolToStr( $value ) {
2813  return $value ? 'true' : 'false';
2814 }
2815 
2821 function wfGetNull() {
2822  return wfIsWindows() ? 'NUL' : '/dev/null';
2823 }
2824 
2848  $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2849 ) {
2850  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2851 
2852  if ( $cluster === '*' ) {
2853  $cluster = false;
2854  $domain = false;
2855  } elseif ( $wiki === false ) {
2856  $domain = $lbFactory->getLocalDomainID();
2857  } else {
2858  $domain = $wiki;
2859  }
2860 
2861  $opts = [
2862  'domain' => $domain,
2863  'cluster' => $cluster,
2864  // B/C: first argument used to be "max seconds of lag"; ignore such values
2865  'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
2866  ];
2867  if ( $timeout !== null ) {
2868  $opts['timeout'] = $timeout;
2869  }
2870 
2871  return $lbFactory->waitForReplication( $opts );
2872 }
2873 
2883 function wfCountDown( $seconds ) {
2884  wfDeprecated( __FUNCTION__, '1.31' );
2885  for ( $i = $seconds; $i >= 0; $i-- ) {
2886  if ( $i != $seconds ) {
2887  echo str_repeat( "\x08", strlen( $i + 1 ) );
2888  }
2889  echo $i;
2890  flush();
2891  if ( $i ) {
2892  sleep( 1 );
2893  }
2894  }
2895  echo "\n";
2896 }
2897 
2907  global $wgIllegalFileChars;
2908  $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
2909  $name = preg_replace(
2910  "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
2911  '-',
2912  $name
2913  );
2914  // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2915  $name = wfBaseName( $name );
2916  return $name;
2917 }
2918 
2924 function wfMemoryLimit() {
2925  global $wgMemoryLimit;
2926  $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2927  if ( $memlimit != -1 ) {
2928  $conflimit = wfShorthandToInteger( $wgMemoryLimit );
2929  if ( $conflimit == -1 ) {
2930  wfDebug( "Removing PHP's memory limit\n" );
2931  Wikimedia\suppressWarnings();
2932  ini_set( 'memory_limit', $conflimit );
2933  Wikimedia\restoreWarnings();
2934  return $conflimit;
2935  } elseif ( $conflimit > $memlimit ) {
2936  wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
2937  Wikimedia\suppressWarnings();
2938  ini_set( 'memory_limit', $conflimit );
2939  Wikimedia\restoreWarnings();
2940  return $conflimit;
2941  }
2942  }
2943  return $memlimit;
2944 }
2945 
2954 
2955  $timeLimit = ini_get( 'max_execution_time' );
2956  // Note that CLI scripts use 0
2957  if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2958  set_time_limit( $wgTransactionalTimeLimit );
2959  }
2960 
2961  ignore_user_abort( true ); // ignore client disconnects
2962 
2963  return $timeLimit;
2964 }
2965 
2973 function wfShorthandToInteger( $string = '', $default = -1 ) {
2974  $string = trim( $string );
2975  if ( $string === '' ) {
2976  return $default;
2977  }
2978  $last = $string[strlen( $string ) - 1];
2979  $val = intval( $string );
2980  switch ( $last ) {
2981  case 'g':
2982  case 'G':
2983  $val *= 1024;
2984  // break intentionally missing
2985  case 'm':
2986  case 'M':
2987  $val *= 1024;
2988  // break intentionally missing
2989  case 'k':
2990  case 'K':
2991  $val *= 1024;
2992  }
2993 
2994  return $val;
2995 }
2996 
3007 function wfBCP47( $code ) {
3008  wfDeprecated( __METHOD__, '1.31' );
3009  return LanguageCode::bcp47( $code );
3010 }
3011 
3019 function wfGetCache( $cacheType ) {
3020  return ObjectCache::getInstance( $cacheType );
3021 }
3022 
3029 function wfGetMainCache() {
3031 }
3032 
3039  global $wgMessageCacheType;
3040  return ObjectCache::getInstance( $wgMessageCacheType );
3041 }
3042 
3057 function wfUnpack( $format, $data, $length = false ) {
3058  if ( $length !== false ) {
3059  $realLen = strlen( $data );
3060  if ( $realLen < $length ) {
3061  throw new MWException( "Tried to use wfUnpack on a "
3062  . "string of length $realLen, but needed one "
3063  . "of at least length $length."
3064  );
3065  }
3066  }
3067 
3068  Wikimedia\suppressWarnings();
3069  $result = unpack( $format, $data );
3070  Wikimedia\restoreWarnings();
3071 
3072  if ( $result === false ) {
3073  // If it cannot extract the packed data.
3074  throw new MWException( "unpack could not unpack binary data" );
3075  }
3076  return $result;
3077 }
3078 
3093 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3094  # Handle redirects; callers almost always hit wfFindFile() anyway,
3095  # so just use that method because it has a fast process cache.
3096  $file = wfFindFile( $name ); // get the final name
3097  $name = $file ? $file->getTitle()->getDBkey() : $name;
3098 
3099  # Run the extension hook
3100  $bad = false;
3101  if ( !Hooks::run( 'BadImage', [ $name, &$bad ] ) ) {
3102  return (bool)$bad;
3103  }
3104 
3106  $key = $cache->makeKey(
3107  'bad-image-list', ( $blacklist === null ) ? 'default' : md5( $blacklist )
3108  );
3109  $badImages = $cache->get( $key );
3110 
3111  if ( $badImages === false ) { // cache miss
3112  if ( $blacklist === null ) {
3113  $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3114  }
3115  # Build the list now
3116  $badImages = [];
3117  $lines = explode( "\n", $blacklist );
3118  foreach ( $lines as $line ) {
3119  # List items only
3120  if ( substr( $line, 0, 1 ) !== '*' ) {
3121  continue;
3122  }
3123 
3124  # Find all links
3125  $m = [];
3126  if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3127  continue;
3128  }
3129 
3130  $exceptions = [];
3131  $imageDBkey = false;
3132  foreach ( $m[1] as $i => $titleText ) {
3133  $title = Title::newFromText( $titleText );
3134  if ( !is_null( $title ) ) {
3135  if ( $i == 0 ) {
3136  $imageDBkey = $title->getDBkey();
3137  } else {
3138  $exceptions[$title->getPrefixedDBkey()] = true;
3139  }
3140  }
3141  }
3142 
3143  if ( $imageDBkey !== false ) {
3144  $badImages[$imageDBkey] = $exceptions;
3145  }
3146  }
3147  $cache->set( $key, $badImages, 60 );
3148  }
3149 
3150  $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
3151  $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3152 
3153  return $bad;
3154 }
3155 
3163 function wfCanIPUseHTTPS( $ip ) {
3164  $canDo = true;
3165  Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3166  return !!$canDo;
3167 }
3168 
3176 function wfIsInfinity( $str ) {
3177  // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3178  $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3179  return in_array( $str, $infinityValues );
3180 }
3181 
3196 function wfThumbIsStandard( File $file, array $params ) {
3198 
3199  $multipliers = [ 1 ];
3200  if ( $wgResponsiveImages ) {
3201  // These available sizes are hardcoded currently elsewhere in MediaWiki.
3202  // @see Linker::processResponsiveImages
3203  $multipliers[] = 1.5;
3204  $multipliers[] = 2;
3205  }
3206 
3207  $handler = $file->getHandler();
3208  if ( !$handler || !isset( $params['width'] ) ) {
3209  return false;
3210  }
3211 
3212  $basicParams = [];
3213  if ( isset( $params['page'] ) ) {
3214  $basicParams['page'] = $params['page'];
3215  }
3216 
3217  $thumbLimits = [];
3218  $imageLimits = [];
3219  // Expand limits to account for multipliers
3220  foreach ( $multipliers as $multiplier ) {
3221  $thumbLimits = array_merge( $thumbLimits, array_map(
3222  function ( $width ) use ( $multiplier ) {
3223  return round( $width * $multiplier );
3224  }, $wgThumbLimits )
3225  );
3226  $imageLimits = array_merge( $imageLimits, array_map(
3227  function ( $pair ) use ( $multiplier ) {
3228  return [
3229  round( $pair[0] * $multiplier ),
3230  round( $pair[1] * $multiplier ),
3231  ];
3232  }, $wgImageLimits )
3233  );
3234  }
3235 
3236  // Check if the width matches one of $wgThumbLimits
3237  if ( in_array( $params['width'], $thumbLimits ) ) {
3238  $normalParams = $basicParams + [ 'width' => $params['width'] ];
3239  // Append any default values to the map (e.g. "lossy", "lossless", ...)
3240  $handler->normaliseParams( $file, $normalParams );
3241  } else {
3242  // If not, then check if the width matchs one of $wgImageLimits
3243  $match = false;
3244  foreach ( $imageLimits as $pair ) {
3245  $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3246  // Decide whether the thumbnail should be scaled on width or height.
3247  // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3248  $handler->normaliseParams( $file, $normalParams );
3249  // Check if this standard thumbnail size maps to the given width
3250  if ( $normalParams['width'] == $params['width'] ) {
3251  $match = true;
3252  break;
3253  }
3254  }
3255  if ( !$match ) {
3256  return false; // not standard for description pages
3257  }
3258  }
3259 
3260  // Check that the given values for non-page, non-width, params are just defaults
3261  foreach ( $params as $key => $value ) {
3262  if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3263  return false;
3264  }
3265  }
3266 
3267  return true;
3268 }
3269 
3282 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3283  // First merge items that are in both arrays
3284  foreach ( $baseArray as $name => &$groupVal ) {
3285  if ( isset( $newValues[$name] ) ) {
3286  $groupVal += $newValues[$name];
3287  }
3288  }
3289  // Now add items that didn't exist yet
3290  $baseArray += $newValues;
3291 
3292  return $baseArray;
3293 }
3294 
3303 function wfGetRusage() {
3304  if ( !function_exists( 'getrusage' ) ) {
3305  return false;
3306  } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS === 'Linux' ) {
3307  return getrusage( 2 /* RUSAGE_THREAD */ );
3308  } else {
3309  return getrusage( 0 /* RUSAGE_SELF */ );
3310  }
3311 }
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.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that 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:822
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:859
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:1637
$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:2046
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:1314
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:2215
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:2280
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. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:2044
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.
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:889
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:59
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:448
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:404
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:2046
$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.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:973
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:2046
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 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:822
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
wfRandom()
Get a random decimal value between 0 and 1, in a way not likely to give duplicate values for any real...
$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:932
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.
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
wfRestoreWarnings()
$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:2685
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:302
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:734
$wgServer
URL of the server.
wfRelativePath( $path, $from)
Generate a relative path name to the given file.
$wgOut
Definition: Setup.php:894
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.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that 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:822
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.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account incomplete not yet checked for validity & $retval
Definition: hooks.txt:244
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:2685
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.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:244
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