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 
35 
46 function wfLoadExtension( $ext, $path = null ) {
47  if ( !$path ) {
49  $path = "$wgExtensionDirectory/$ext/extension.json";
50  }
52 }
53 
67 function wfLoadExtensions( array $exts ) {
69  $registry = ExtensionRegistry::getInstance();
70  foreach ( $exts as $ext ) {
71  $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
72  }
73 }
74 
83 function wfLoadSkin( $skin, $path = null ) {
84  if ( !$path ) {
86  $path = "$wgStyleDirectory/$skin/skin.json";
87  }
89 }
90 
98 function wfLoadSkins( array $skins ) {
100  $registry = ExtensionRegistry::getInstance();
101  foreach ( $skins as $skin ) {
102  $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
103  }
104 }
105 
112 function wfArrayDiff2( $a, $b ) {
113  return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
114 }
115 
121 function wfArrayDiff2_cmp( $a, $b ) {
122  if ( is_string( $a ) && is_string( $b ) ) {
123  return strcmp( $a, $b );
124  } elseif ( count( $a ) !== count( $b ) ) {
125  return count( $a ) <=> count( $b );
126  } else {
127  reset( $a );
128  reset( $b );
129  while ( key( $a ) !== null && key( $b ) !== null ) {
130  $valueA = current( $a );
131  $valueB = current( $b );
132  $cmp = strcmp( $valueA, $valueB );
133  if ( $cmp !== 0 ) {
134  return $cmp;
135  }
136  next( $a );
137  next( $b );
138  }
139  return 0;
140  }
141 }
142 
151 function wfArrayFilter( array $arr, callable $callback ) {
152  return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH );
153 }
154 
163 function wfArrayFilterByKey( array $arr, callable $callback ) {
164  return array_filter( $arr, $callback, ARRAY_FILTER_USE_KEY );
165 }
166 
176 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
177  if ( is_null( $changed ) ) {
178  throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
179  }
180  if ( $default[$key] !== $value ) {
181  $changed[$key] = $value;
182  }
183 }
184 
204 function wfMergeErrorArrays( /*...*/ ) {
205  $args = func_get_args();
206  $out = [];
207  foreach ( $args as $errors ) {
208  foreach ( $errors as $params ) {
209  $originalParams = $params;
210  if ( $params[0] instanceof MessageSpecifier ) {
211  $msg = $params[0];
212  $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
213  }
214  # @todo FIXME: Sometimes get nested arrays for $params,
215  # which leads to E_NOTICEs
216  $spec = implode( "\t", $params );
217  $out[$spec] = $originalParams;
218  }
219  }
220  return array_values( $out );
221 }
222 
231 function wfArrayInsertAfter( array $array, array $insert, $after ) {
232  // Find the offset of the element to insert after.
233  $keys = array_keys( $array );
234  $offsetByKey = array_flip( $keys );
235 
236  $offset = $offsetByKey[$after];
237 
238  // Insert at the specified offset
239  $before = array_slice( $array, 0, $offset + 1, true );
240  $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
241 
242  $output = $before + $insert + $after;
243 
244  return $output;
245 }
246 
254 function wfObjectToArray( $objOrArray, $recursive = true ) {
255  $array = [];
256  if ( is_object( $objOrArray ) ) {
257  $objOrArray = get_object_vars( $objOrArray );
258  }
259  foreach ( $objOrArray as $key => $value ) {
260  if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
262  }
263 
264  $array[$key] = $value;
265  }
266 
267  return $array;
268 }
269 
280 function wfRandom() {
281  // The maximum random value is "only" 2^31-1, so get two random
282  // values to reduce the chance of dupes
283  $max = mt_getrandmax() + 1;
284  $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
285  return $rand;
286 }
287 
298 function wfRandomString( $length = 32 ) {
299  $str = '';
300  for ( $n = 0; $n < $length; $n += 7 ) {
301  $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
302  }
303  return substr( $str, 0, $length );
304 }
305 
333 function wfUrlencode( $s ) {
334  static $needle;
335 
336  if ( is_null( $s ) ) {
337  $needle = null;
338  return '';
339  }
340 
341  if ( is_null( $needle ) ) {
342  $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
343  if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
344  ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
345  ) {
346  $needle[] = '%3A';
347  }
348  }
349 
350  $s = urlencode( $s );
351  $s = str_ireplace(
352  $needle,
353  [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
354  $s
355  );
356 
357  return $s;
358 }
359 
370 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
371  if ( !is_null( $array2 ) ) {
372  $array1 = $array1 + $array2;
373  }
374 
375  $cgi = '';
376  foreach ( $array1 as $key => $value ) {
377  if ( !is_null( $value ) && $value !== false ) {
378  if ( $cgi != '' ) {
379  $cgi .= '&';
380  }
381  if ( $prefix !== '' ) {
382  $key = $prefix . "[$key]";
383  }
384  if ( is_array( $value ) ) {
385  $firstTime = true;
386  foreach ( $value as $k => $v ) {
387  $cgi .= $firstTime ? '' : '&';
388  if ( is_array( $v ) ) {
389  $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
390  } else {
391  $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
392  }
393  $firstTime = false;
394  }
395  } else {
396  if ( is_object( $value ) ) {
397  $value = $value->__toString();
398  }
399  $cgi .= urlencode( $key ) . '=' . urlencode( $value );
400  }
401  }
402  }
403  return $cgi;
404 }
405 
415 function wfCgiToArray( $query ) {
416  if ( isset( $query[0] ) && $query[0] == '?' ) {
417  $query = substr( $query, 1 );
418  }
419  $bits = explode( '&', $query );
420  $ret = [];
421  foreach ( $bits as $bit ) {
422  if ( $bit === '' ) {
423  continue;
424  }
425  if ( strpos( $bit, '=' ) === false ) {
426  // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
427  $key = $bit;
428  $value = '';
429  } else {
430  list( $key, $value ) = explode( '=', $bit );
431  }
432  $key = urldecode( $key );
433  $value = urldecode( $value );
434  if ( strpos( $key, '[' ) !== false ) {
435  $keys = array_reverse( explode( '[', $key ) );
436  $key = array_pop( $keys );
437  $temp = $value;
438  foreach ( $keys as $k ) {
439  $k = substr( $k, 0, -1 );
440  $temp = [ $k => $temp ];
441  }
442  if ( isset( $ret[$key] ) ) {
443  $ret[$key] = array_merge( $ret[$key], $temp );
444  } else {
445  $ret[$key] = $temp;
446  }
447  } else {
448  $ret[$key] = $value;
449  }
450  }
451  return $ret;
452 }
453 
462 function wfAppendQuery( $url, $query ) {
463  if ( is_array( $query ) ) {
465  }
466  if ( $query != '' ) {
467  // Remove the fragment, if there is one
468  $fragment = false;
469  $hashPos = strpos( $url, '#' );
470  if ( $hashPos !== false ) {
471  $fragment = substr( $url, $hashPos );
472  $url = substr( $url, 0, $hashPos );
473  }
474 
475  // Add parameter
476  if ( false === strpos( $url, '?' ) ) {
477  $url .= '?';
478  } else {
479  $url .= '&';
480  }
481  $url .= $query;
482 
483  // Put the fragment back
484  if ( $fragment !== false ) {
485  $url .= $fragment;
486  }
487  }
488  return $url;
489 }
490 
514 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
516  $wgHttpsPort;
517  if ( $defaultProto === PROTO_CANONICAL ) {
518  $serverUrl = $wgCanonicalServer;
519  } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
520  // Make $wgInternalServer fall back to $wgServer if not set
521  $serverUrl = $wgInternalServer;
522  } else {
523  $serverUrl = $wgServer;
524  if ( $defaultProto === PROTO_CURRENT ) {
525  $defaultProto = $wgRequest->getProtocol() . '://';
526  }
527  }
528 
529  // Analyze $serverUrl to obtain its protocol
530  $bits = wfParseUrl( $serverUrl );
531  $serverHasProto = $bits && $bits['scheme'] != '';
532 
533  if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
534  if ( $serverHasProto ) {
535  $defaultProto = $bits['scheme'] . '://';
536  } else {
537  // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
538  // This really isn't supposed to happen. Fall back to HTTP in this
539  // ridiculous case.
540  $defaultProto = PROTO_HTTP;
541  }
542  }
543 
544  $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
545 
546  if ( substr( $url, 0, 2 ) == '//' ) {
547  $url = $defaultProtoWithoutSlashes . $url;
548  } elseif ( substr( $url, 0, 1 ) == '/' ) {
549  // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
550  // otherwise leave it alone.
551  if ( $serverHasProto ) {
552  $url = $serverUrl . $url;
553  } else {
554  // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
555  // user to override the port number (T67184)
556  if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
557  if ( isset( $bits['port'] ) ) {
558  throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
559  }
560  $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
561  } else {
562  $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
563  }
564  }
565  }
566 
567  $bits = wfParseUrl( $url );
568 
569  if ( $bits && isset( $bits['path'] ) ) {
570  $bits['path'] = wfRemoveDotSegments( $bits['path'] );
571  return wfAssembleUrl( $bits );
572  } elseif ( $bits ) {
573  # No path to expand
574  return $url;
575  } elseif ( substr( $url, 0, 1 ) != '/' ) {
576  # URL is a relative path
577  return wfRemoveDotSegments( $url );
578  }
579 
580  # Expanded URL is not valid.
581  return false;
582 }
583 
592 function wfGetServerUrl( $proto ) {
593  $url = wfExpandUrl( '/', $proto );
594  return substr( $url, 0, -1 );
595 }
596 
610 function wfAssembleUrl( $urlParts ) {
611  $result = '';
612 
613  if ( isset( $urlParts['delimiter'] ) ) {
614  if ( isset( $urlParts['scheme'] ) ) {
615  $result .= $urlParts['scheme'];
616  }
617 
618  $result .= $urlParts['delimiter'];
619  }
620 
621  if ( isset( $urlParts['host'] ) ) {
622  if ( isset( $urlParts['user'] ) ) {
623  $result .= $urlParts['user'];
624  if ( isset( $urlParts['pass'] ) ) {
625  $result .= ':' . $urlParts['pass'];
626  }
627  $result .= '@';
628  }
629 
630  $result .= $urlParts['host'];
631 
632  if ( isset( $urlParts['port'] ) ) {
633  $result .= ':' . $urlParts['port'];
634  }
635  }
636 
637  if ( isset( $urlParts['path'] ) ) {
638  $result .= $urlParts['path'];
639  }
640 
641  if ( isset( $urlParts['query'] ) ) {
642  $result .= '?' . $urlParts['query'];
643  }
644 
645  if ( isset( $urlParts['fragment'] ) ) {
646  $result .= '#' . $urlParts['fragment'];
647  }
648 
649  return $result;
650 }
651 
664 function wfRemoveDotSegments( $urlPath ) {
665  $output = '';
666  $inputOffset = 0;
667  $inputLength = strlen( $urlPath );
668 
669  while ( $inputOffset < $inputLength ) {
670  $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
671  $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
672  $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
673  $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
674  $trimOutput = false;
675 
676  if ( $prefixLengthTwo == './' ) {
677  # Step A, remove leading "./"
678  $inputOffset += 2;
679  } elseif ( $prefixLengthThree == '../' ) {
680  # Step A, remove leading "../"
681  $inputOffset += 3;
682  } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
683  # Step B, replace leading "/.$" with "/"
684  $inputOffset += 1;
685  $urlPath[$inputOffset] = '/';
686  } elseif ( $prefixLengthThree == '/./' ) {
687  # Step B, replace leading "/./" with "/"
688  $inputOffset += 2;
689  } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
690  # Step C, replace leading "/..$" with "/" and
691  # remove last path component in output
692  $inputOffset += 2;
693  $urlPath[$inputOffset] = '/';
694  $trimOutput = true;
695  } elseif ( $prefixLengthFour == '/../' ) {
696  # Step C, replace leading "/../" with "/" and
697  # remove last path component in output
698  $inputOffset += 3;
699  $trimOutput = true;
700  } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
701  # Step D, remove "^.$"
702  $inputOffset += 1;
703  } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
704  # Step D, remove "^..$"
705  $inputOffset += 2;
706  } else {
707  # Step E, move leading path segment to output
708  if ( $prefixLengthOne == '/' ) {
709  $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
710  } else {
711  $slashPos = strpos( $urlPath, '/', $inputOffset );
712  }
713  if ( $slashPos === false ) {
714  $output .= substr( $urlPath, $inputOffset );
715  $inputOffset = $inputLength;
716  } else {
717  $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
718  $inputOffset += $slashPos - $inputOffset;
719  }
720  }
721 
722  if ( $trimOutput ) {
723  $slashPos = strrpos( $output, '/' );
724  if ( $slashPos === false ) {
725  $output = '';
726  } else {
727  $output = substr( $output, 0, $slashPos );
728  }
729  }
730  }
731 
732  return $output;
733 }
734 
742 function wfUrlProtocols( $includeProtocolRelative = true ) {
744 
745  // Cache return values separately based on $includeProtocolRelative
746  static $withProtRel = null, $withoutProtRel = null;
747  $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
748  if ( !is_null( $cachedValue ) ) {
749  return $cachedValue;
750  }
751 
752  // Support old-style $wgUrlProtocols strings, for backwards compatibility
753  // with LocalSettings files from 1.5
754  if ( is_array( $wgUrlProtocols ) ) {
755  $protocols = [];
756  foreach ( $wgUrlProtocols as $protocol ) {
757  // Filter out '//' if !$includeProtocolRelative
758  if ( $includeProtocolRelative || $protocol !== '//' ) {
759  $protocols[] = preg_quote( $protocol, '/' );
760  }
761  }
762 
763  $retval = implode( '|', $protocols );
764  } else {
765  // Ignore $includeProtocolRelative in this case
766  // This case exists for pre-1.6 compatibility, and we can safely assume
767  // that '//' won't appear in a pre-1.6 config because protocol-relative
768  // URLs weren't supported until 1.18
770  }
771 
772  // Cache return value
773  if ( $includeProtocolRelative ) {
774  $withProtRel = $retval;
775  } else {
776  $withoutProtRel = $retval;
777  }
778  return $retval;
779 }
780 
788  return wfUrlProtocols( false );
789 }
790 
816 function wfParseUrl( $url ) {
817  global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
818 
819  // Protocol-relative URLs are handled really badly by parse_url(). It's so
820  // bad that the easiest way to handle them is to just prepend 'http:' and
821  // strip the protocol out later.
822  $wasRelative = substr( $url, 0, 2 ) == '//';
823  if ( $wasRelative ) {
824  $url = "http:$url";
825  }
826  Wikimedia\suppressWarnings();
827  $bits = parse_url( $url );
828  Wikimedia\restoreWarnings();
829  // parse_url() returns an array without scheme for some invalid URLs, e.g.
830  // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
831  if ( !$bits || !isset( $bits['scheme'] ) ) {
832  return false;
833  }
834 
835  // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
836  $bits['scheme'] = strtolower( $bits['scheme'] );
837 
838  // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
839  if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
840  $bits['delimiter'] = '://';
841  } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
842  $bits['delimiter'] = ':';
843  // parse_url detects for news: and mailto: the host part of an url as path
844  // We have to correct this wrong detection
845  if ( isset( $bits['path'] ) ) {
846  $bits['host'] = $bits['path'];
847  $bits['path'] = '';
848  }
849  } else {
850  return false;
851  }
852 
853  /* Provide an empty host for eg. file:/// urls (see T30627) */
854  if ( !isset( $bits['host'] ) ) {
855  $bits['host'] = '';
856 
857  // See T47069
858  if ( isset( $bits['path'] ) ) {
859  /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
860  if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
861  $bits['path'] = '/' . $bits['path'];
862  }
863  } else {
864  $bits['path'] = '';
865  }
866  }
867 
868  // If the URL was protocol-relative, fix scheme and delimiter
869  if ( $wasRelative ) {
870  $bits['scheme'] = '';
871  $bits['delimiter'] = '//';
872  }
873  return $bits;
874 }
875 
886 function wfExpandIRI( $url ) {
887  return preg_replace_callback(
888  '/((?:%[89A-F][0-9A-F])+)/i',
889  function ( array $matches ) {
890  return urldecode( $matches[1] );
891  },
892  wfExpandUrl( $url )
893  );
894 }
895 
902 function wfMakeUrlIndexes( $url ) {
903  $bits = wfParseUrl( $url );
904 
905  // Reverse the labels in the hostname, convert to lower case
906  // For emails reverse domainpart only
907  if ( $bits['scheme'] == 'mailto' ) {
908  $mailparts = explode( '@', $bits['host'], 2 );
909  if ( count( $mailparts ) === 2 ) {
910  $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
911  } else {
912  // No domain specified, don't mangle it
913  $domainpart = '';
914  }
915  $reversedHost = $domainpart . '@' . $mailparts[0];
916  } else {
917  $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
918  }
919  // Add an extra dot to the end
920  // Why? Is it in wrong place in mailto links?
921  if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
922  $reversedHost .= '.';
923  }
924  // Reconstruct the pseudo-URL
925  $prot = $bits['scheme'];
926  $index = $prot . $bits['delimiter'] . $reversedHost;
927  // Leave out user and password. Add the port, path, query and fragment
928  if ( isset( $bits['port'] ) ) {
929  $index .= ':' . $bits['port'];
930  }
931  if ( isset( $bits['path'] ) ) {
932  $index .= $bits['path'];
933  } else {
934  $index .= '/';
935  }
936  if ( isset( $bits['query'] ) ) {
937  $index .= '?' . $bits['query'];
938  }
939  if ( isset( $bits['fragment'] ) ) {
940  $index .= '#' . $bits['fragment'];
941  }
942 
943  if ( $prot == '' ) {
944  return [ "http:$index", "https:$index" ];
945  } else {
946  return [ $index ];
947  }
948 }
949 
956 function wfMatchesDomainList( $url, $domains ) {
957  $bits = wfParseUrl( $url );
958  if ( is_array( $bits ) && isset( $bits['host'] ) ) {
959  $host = '.' . $bits['host'];
960  foreach ( (array)$domains as $domain ) {
961  $domain = '.' . $domain;
962  if ( substr( $host, -strlen( $domain ) ) === $domain ) {
963  return true;
964  }
965  }
966  }
967  return false;
968 }
969 
990 function wfDebug( $text, $dest = 'all', array $context = [] ) {
993 
994  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
995  return;
996  }
997 
998  $text = trim( $text );
999 
1000  if ( $wgDebugTimestamps ) {
1001  $context['seconds_elapsed'] = sprintf(
1002  '%6.4f',
1003  microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
1004  );
1005  $context['memory_used'] = sprintf(
1006  '%5.1fM',
1007  ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1008  );
1009  }
1010 
1011  if ( $wgDebugLogPrefix !== '' ) {
1012  $context['prefix'] = $wgDebugLogPrefix;
1013  }
1014  $context['private'] = ( $dest === false || $dest === 'private' );
1015 
1016  $logger = LoggerFactory::getInstance( 'wfDebug' );
1017  $logger->debug( $text, $context );
1018 }
1019 
1024 function wfIsDebugRawPage() {
1025  static $cache;
1026  if ( $cache !== null ) {
1027  return $cache;
1028  }
1029  // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1030  // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
1031  if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1032  || (
1033  isset( $_SERVER['SCRIPT_NAME'] )
1034  && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1035  )
1036  ) {
1037  $cache = true;
1038  } else {
1039  $cache = false;
1040  }
1041  return $cache;
1042 }
1043 
1049 function wfDebugMem( $exact = false ) {
1050  $mem = memory_get_usage();
1051  if ( !$exact ) {
1052  $mem = floor( $mem / 1024 ) . ' KiB';
1053  } else {
1054  $mem .= ' B';
1055  }
1056  wfDebug( "Memory usage: $mem\n" );
1057 }
1058 
1084 function wfDebugLog(
1085  $logGroup, $text, $dest = 'all', array $context = []
1086 ) {
1087  $text = trim( $text );
1088 
1089  $logger = LoggerFactory::getInstance( $logGroup );
1090  $context['private'] = ( $dest === false || $dest === 'private' );
1091  $logger->info( $text, $context );
1092 }
1093 
1102 function wfLogDBError( $text, array $context = [] ) {
1103  $logger = LoggerFactory::getInstance( 'wfLogDBError' );
1104  $logger->error( trim( $text ), $context );
1105 }
1106 
1120 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1121  MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1122 }
1123 
1134 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1135  MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1136 }
1137 
1147 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1148  MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1149 }
1150 
1164 function wfErrorLog( $text, $file, array $context = [] ) {
1165  wfDeprecated( __METHOD__, '1.25' );
1166  $logger = LoggerFactory::getInstance( 'wfErrorLog' );
1167  $context['destination'] = $file;
1168  $logger->info( trim( $text ), $context );
1169 }
1170 
1177 
1179  $request = $context->getRequest();
1180 
1181  $profiler = Profiler::instance();
1182  $profiler->setContext( $context );
1183  $profiler->logData();
1184 
1185  // Send out any buffered statsd metrics as needed
1187  MediaWikiServices::getInstance()->getStatsdDataFactory(),
1188  $context->getConfig()
1189  );
1190 
1191  // Profiling must actually be enabled...
1192  if ( $profiler instanceof ProfilerStub ) {
1193  return;
1194  }
1195 
1196  if ( isset( $wgDebugLogGroups['profileoutput'] )
1197  && $wgDebugLogGroups['profileoutput'] === false
1198  ) {
1199  // Explicitly disabled
1200  return;
1201  }
1202  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1203  return;
1204  }
1205 
1206  $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1207  if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1208  $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1209  }
1210  if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1211  $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1212  }
1213  if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1214  $ctx['from'] = $_SERVER['HTTP_FROM'];
1215  }
1216  if ( isset( $ctx['forwarded_for'] ) ||
1217  isset( $ctx['client_ip'] ) ||
1218  isset( $ctx['from'] ) ) {
1219  $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1220  }
1221 
1222  // Don't load $wgUser at this late stage just for statistics purposes
1223  // @todo FIXME: We can detect some anons even if it is not loaded.
1224  // See User::getId()
1225  $user = $context->getUser();
1226  $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1227 
1228  // Command line script uses a FauxRequest object which does not have
1229  // any knowledge about an URL and throw an exception instead.
1230  try {
1231  $ctx['url'] = urldecode( $request->getRequestURL() );
1232  } catch ( Exception $ignored ) {
1233  // no-op
1234  }
1235 
1236  $ctx['output'] = $profiler->getOutput();
1237 
1238  $log = LoggerFactory::getInstance( 'profileoutput' );
1239  $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1240 }
1241 
1249 function wfIncrStats( $key, $count = 1 ) {
1250  $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1251  $stats->updateCount( $key, $count );
1252 }
1253 
1259 function wfReadOnly() {
1260  return MediaWikiServices::getInstance()->getReadOnlyMode()
1261  ->isReadOnly();
1262 }
1263 
1272 function wfReadOnlyReason() {
1273  return MediaWikiServices::getInstance()->getReadOnlyMode()
1274  ->getReason();
1275 }
1276 
1284  return MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1285  ->getReason();
1286 }
1287 
1303 function wfGetLangObj( $langcode = false ) {
1304  # Identify which language to get or create a language object for.
1305  # Using is_object here due to Stub objects.
1306  if ( is_object( $langcode ) ) {
1307  # Great, we already have the object (hopefully)!
1308  return $langcode;
1309  }
1310 
1312  if ( $langcode === true || $langcode === $wgLanguageCode ) {
1313  # $langcode is the language code of the wikis content language object.
1314  # or it is a boolean and value is true
1315  return MediaWikiServices::getInstance()->getContentLanguage();
1316  }
1317 
1318  global $wgLang;
1319  if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1320  # $langcode is the language code of user language object.
1321  # or it was a boolean and value is false
1322  return $wgLang;
1323  }
1324 
1325  $validCodes = array_keys( Language::fetchLanguageNames() );
1326  if ( in_array( $langcode, $validCodes ) ) {
1327  # $langcode corresponds to a valid language.
1328  return Language::factory( $langcode );
1329  }
1330 
1331  # $langcode is a string, but not a valid language code; use content language.
1332  wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1333  return MediaWikiServices::getInstance()->getContentLanguage();
1334 }
1335 
1352 function wfMessage( $key, ...$params ) {
1353  $message = new Message( $key );
1354 
1355  // We call Message::params() to reduce code duplication
1356  if ( $params ) {
1357  $message->params( ...$params );
1358  }
1359 
1360  return $message;
1361 }
1362 
1375 function wfMessageFallback( ...$keys ) {
1376  return Message::newFallbackSequence( ...$keys );
1377 }
1378 
1387 function wfMsgReplaceArgs( $message, $args ) {
1388  # Fix windows line-endings
1389  # Some messages are split with explode("\n", $msg)
1390  $message = str_replace( "\r", '', $message );
1391 
1392  // Replace arguments
1393  if ( is_array( $args ) && $args ) {
1394  if ( is_array( $args[0] ) ) {
1395  $args = array_values( $args[0] );
1396  }
1397  $replacementKeys = [];
1398  foreach ( $args as $n => $param ) {
1399  $replacementKeys['$' . ( $n + 1 )] = $param;
1400  }
1401  $message = strtr( $message, $replacementKeys );
1402  }
1403 
1404  return $message;
1405 }
1406 
1414 function wfHostname() {
1415  static $host;
1416  if ( is_null( $host ) ) {
1417  # Hostname overriding
1419  if ( $wgOverrideHostname !== false ) {
1420  # Set static and skip any detection
1421  $host = $wgOverrideHostname;
1422  return $host;
1423  }
1424 
1425  if ( function_exists( 'posix_uname' ) ) {
1426  // This function not present on Windows
1427  $uname = posix_uname();
1428  } else {
1429  $uname = false;
1430  }
1431  if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1432  $host = $uname['nodename'];
1433  } elseif ( getenv( 'COMPUTERNAME' ) ) {
1434  # Windows computer name
1435  $host = getenv( 'COMPUTERNAME' );
1436  } else {
1437  # This may be a virtual server.
1438  $host = $_SERVER['SERVER_NAME'];
1439  }
1440  }
1441  return $host;
1442 }
1443 
1454 function wfReportTime( $nonce = null ) {
1456 
1457  $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1458  // seconds to milliseconds
1459  $responseTime = round( $elapsed * 1000 );
1460  $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1461  if ( $wgShowHostnames ) {
1462  $reportVars['wgHostname'] = wfHostname();
1463  }
1464  return Skin::makeVariablesScript( $reportVars, $nonce );
1465 }
1466 
1477 function wfDebugBacktrace( $limit = 0 ) {
1478  static $disabled = null;
1479 
1480  if ( is_null( $disabled ) ) {
1481  $disabled = !function_exists( 'debug_backtrace' );
1482  if ( $disabled ) {
1483  wfDebug( "debug_backtrace() is disabled\n" );
1484  }
1485  }
1486  if ( $disabled ) {
1487  return [];
1488  }
1489 
1490  if ( $limit ) {
1491  return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1492  } else {
1493  return array_slice( debug_backtrace(), 1 );
1494  }
1495 }
1496 
1505 function wfBacktrace( $raw = null ) {
1507 
1508  if ( $raw === null ) {
1509  $raw = $wgCommandLineMode;
1510  }
1511 
1512  if ( $raw ) {
1513  $frameFormat = "%s line %s calls %s()\n";
1514  $traceFormat = "%s";
1515  } else {
1516  $frameFormat = "<li>%s line %s calls %s()</li>\n";
1517  $traceFormat = "<ul>\n%s</ul>\n";
1518  }
1519 
1520  $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1521  $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1522  $line = $frame['line'] ?? '-';
1523  $call = $frame['function'];
1524  if ( !empty( $frame['class'] ) ) {
1525  $call = $frame['class'] . $frame['type'] . $call;
1526  }
1527  return sprintf( $frameFormat, $file, $line, $call );
1528  }, wfDebugBacktrace() );
1529 
1530  return sprintf( $traceFormat, implode( '', $frames ) );
1531 }
1532 
1542 function wfGetCaller( $level = 2 ) {
1543  $backtrace = wfDebugBacktrace( $level + 1 );
1544  if ( isset( $backtrace[$level] ) ) {
1545  return wfFormatStackFrame( $backtrace[$level] );
1546  } else {
1547  return 'unknown';
1548  }
1549 }
1550 
1558 function wfGetAllCallers( $limit = 3 ) {
1559  $trace = array_reverse( wfDebugBacktrace() );
1560  if ( !$limit || $limit > count( $trace ) - 1 ) {
1561  $limit = count( $trace ) - 1;
1562  }
1563  $trace = array_slice( $trace, -$limit - 1, $limit );
1564  return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1565 }
1566 
1573 function wfFormatStackFrame( $frame ) {
1574  if ( !isset( $frame['function'] ) ) {
1575  return 'NO_FUNCTION_GIVEN';
1576  }
1577  return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1578  $frame['class'] . $frame['type'] . $frame['function'] :
1579  $frame['function'];
1580 }
1581 
1582 /* Some generic result counters, pulled out of SearchEngine */
1583 
1591 function wfShowingResults( $offset, $limit ) {
1592  return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1593 }
1594 
1604 function wfClientAcceptsGzip( $force = false ) {
1605  static $result = null;
1606  if ( $result === null || $force ) {
1607  $result = false;
1608  if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1609  # @todo FIXME: We may want to blacklist some broken browsers
1610  $m = [];
1611  if ( preg_match(
1612  '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1613  $_SERVER['HTTP_ACCEPT_ENCODING'],
1614  $m
1615  )
1616  ) {
1617  if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1618  $result = false;
1619  return $result;
1620  }
1621  wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1622  $result = true;
1623  }
1624  }
1625  }
1626  return $result;
1627 }
1628 
1639 function wfEscapeWikiText( $text ) {
1641  static $repl = null, $repl2 = null;
1642  if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1643  // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1644  // in those situations
1645  $repl = [
1646  '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1647  '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1648  '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1649  "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1650  "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1651  "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1652  "\n " => "\n&#32;", "\r " => "\r&#32;",
1653  "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1654  "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1655  "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1656  "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1657  '__' => '_&#95;', '://' => '&#58;//',
1658  ];
1659 
1660  $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1661  // We have to catch everything "\s" matches in PCRE
1662  foreach ( $magicLinks as $magic ) {
1663  $repl["$magic "] = "$magic&#32;";
1664  $repl["$magic\t"] = "$magic&#9;";
1665  $repl["$magic\r"] = "$magic&#13;";
1666  $repl["$magic\n"] = "$magic&#10;";
1667  $repl["$magic\f"] = "$magic&#12;";
1668  }
1669 
1670  // And handle protocols that don't use "://"
1672  $repl2 = [];
1673  foreach ( $wgUrlProtocols as $prot ) {
1674  if ( substr( $prot, -1 ) === ':' ) {
1675  $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1676  }
1677  }
1678  $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1679  }
1680  $text = substr( strtr( "\n$text", $repl ), 1 );
1681  $text = preg_replace( $repl2, '$1&#58;', $text );
1682  return $text;
1683 }
1684 
1695 function wfSetVar( &$dest, $source, $force = false ) {
1696  $temp = $dest;
1697  if ( !is_null( $source ) || $force ) {
1698  $dest = $source;
1699  }
1700  return $temp;
1701 }
1702 
1712 function wfSetBit( &$dest, $bit, $state = true ) {
1713  $temp = (bool)( $dest & $bit );
1714  if ( !is_null( $state ) ) {
1715  if ( $state ) {
1716  $dest |= $bit;
1717  } else {
1718  $dest &= ~$bit;
1719  }
1720  }
1721  return $temp;
1722 }
1723 
1730 function wfVarDump( $var ) {
1731  global $wgOut;
1732  $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1733  if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1734  print $s;
1735  } else {
1736  $wgOut->addHTML( $s );
1737  }
1738 }
1739 
1747 function wfHttpError( $code, $label, $desc ) {
1748  global $wgOut;
1750  if ( $wgOut ) {
1751  $wgOut->disable();
1752  $wgOut->sendCacheControl();
1753  }
1754 
1756  header( 'Content-type: text/html; charset=utf-8' );
1757  print '<!DOCTYPE html>' .
1758  '<html><head><title>' .
1759  htmlspecialchars( $label ) .
1760  '</title></head><body><h1>' .
1761  htmlspecialchars( $label ) .
1762  '</h1><p>' .
1763  nl2br( htmlspecialchars( $desc ) ) .
1764  "</p></body></html>\n";
1765 }
1766 
1784 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1785  if ( $resetGzipEncoding ) {
1786  // Suppress Content-Encoding and Content-Length
1787  // headers from OutputHandler::handle.
1789  $wgDisableOutputCompression = true;
1790  }
1791  while ( $status = ob_get_status() ) {
1792  if ( isset( $status['flags'] ) ) {
1793  $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1794  $deleteable = ( $status['flags'] & $flags ) === $flags;
1795  } elseif ( isset( $status['del'] ) ) {
1796  $deleteable = $status['del'];
1797  } else {
1798  // Guess that any PHP-internal setting can't be removed.
1799  $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1800  }
1801  if ( !$deleteable ) {
1802  // Give up, and hope the result doesn't break
1803  // output behavior.
1804  break;
1805  }
1806  if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1807  // Unit testing barrier to prevent this function from breaking PHPUnit.
1808  break;
1809  }
1810  if ( !ob_end_clean() ) {
1811  // Could not remove output buffer handler; abort now
1812  // to avoid getting in some kind of infinite loop.
1813  break;
1814  }
1815  if ( $resetGzipEncoding ) {
1816  if ( $status['name'] == 'ob_gzhandler' ) {
1817  // Reset the 'Content-Encoding' field set by this handler
1818  // so we can start fresh.
1819  header_remove( 'Content-Encoding' );
1820  break;
1821  }
1822  }
1823  }
1824 }
1825 
1839  wfResetOutputBuffers( false );
1840 }
1841 
1850 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1851  # No arg means accept anything (per HTTP spec)
1852  if ( !$accept ) {
1853  return [ $def => 1.0 ];
1854  }
1855 
1856  $prefs = [];
1857 
1858  $parts = explode( ',', $accept );
1859 
1860  foreach ( $parts as $part ) {
1861  # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1862  $values = explode( ';', trim( $part ) );
1863  $match = [];
1864  if ( count( $values ) == 1 ) {
1865  $prefs[$values[0]] = 1.0;
1866  } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1867  $prefs[$values[0]] = floatval( $match[1] );
1868  }
1869  }
1870 
1871  return $prefs;
1872 }
1873 
1886 function mimeTypeMatch( $type, $avail ) {
1887  if ( array_key_exists( $type, $avail ) ) {
1888  return $type;
1889  } else {
1890  $mainType = explode( '/', $type )[0];
1891  if ( array_key_exists( "$mainType/*", $avail ) ) {
1892  return "$mainType/*";
1893  } elseif ( array_key_exists( '*/*', $avail ) ) {
1894  return '*/*';
1895  } else {
1896  return null;
1897  }
1898  }
1899 }
1900 
1914 function wfNegotiateType( $cprefs, $sprefs ) {
1915  $combine = [];
1916 
1917  foreach ( array_keys( $sprefs ) as $type ) {
1918  $subType = explode( '/', $type )[1];
1919  if ( $subType != '*' ) {
1920  $ckey = mimeTypeMatch( $type, $cprefs );
1921  if ( $ckey ) {
1922  $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1923  }
1924  }
1925  }
1926 
1927  foreach ( array_keys( $cprefs ) as $type ) {
1928  $subType = explode( '/', $type )[1];
1929  if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1930  $skey = mimeTypeMatch( $type, $sprefs );
1931  if ( $skey ) {
1932  $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1933  }
1934  }
1935  }
1936 
1937  $bestq = 0;
1938  $besttype = null;
1939 
1940  foreach ( array_keys( $combine ) as $type ) {
1941  if ( $combine[$type] > $bestq ) {
1942  $besttype = $type;
1943  $bestq = $combine[$type];
1944  }
1945  }
1946 
1947  return $besttype;
1948 }
1949 
1956 function wfSuppressWarnings( $end = false ) {
1957  Wikimedia\suppressWarnings( $end );
1958 }
1959 
1964 function wfRestoreWarnings() {
1965  Wikimedia\restoreWarnings();
1966 }
1967 
1976 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1977  $ret = MWTimestamp::convert( $outputtype, $ts );
1978  if ( $ret === false ) {
1979  wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1980  }
1981  return $ret;
1982 }
1983 
1992 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1993  if ( is_null( $ts ) ) {
1994  return null;
1995  } else {
1996  return wfTimestamp( $outputtype, $ts );
1997  }
1998 }
1999 
2005 function wfTimestampNow() {
2006  # return NOW
2007  return MWTimestamp::now( TS_MW );
2008 }
2009 
2015 function wfIsWindows() {
2016  static $isWindows = null;
2017  if ( $isWindows === null ) {
2018  $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
2019  }
2020  return $isWindows;
2021 }
2022 
2028 function wfIsHHVM() {
2029  return defined( 'HHVM_VERSION' );
2030 }
2031 
2038 function wfIsCLI() {
2039  return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
2040 }
2041 
2053 function wfTempDir() {
2055 
2056  if ( $wgTmpDirectory !== false ) {
2057  return $wgTmpDirectory;
2058  }
2059 
2061 }
2062 
2072 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2074 
2075  if ( FileBackend::isStoragePath( $dir ) ) { // sanity
2076  throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
2077  }
2078 
2079  if ( !is_null( $caller ) ) {
2080  wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2081  }
2082 
2083  if ( strval( $dir ) === '' || is_dir( $dir ) ) {
2084  return true;
2085  }
2086 
2087  $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
2088 
2089  if ( is_null( $mode ) ) {
2090  $mode = $wgDirectoryMode;
2091  }
2092 
2093  // Turn off the normal warning, we're doing our own below
2094  Wikimedia\suppressWarnings();
2095  $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2096  Wikimedia\restoreWarnings();
2097 
2098  if ( !$ok ) {
2099  // directory may have been created on another request since we last checked
2100  if ( is_dir( $dir ) ) {
2101  return true;
2102  }
2103 
2104  // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2105  wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2106  }
2107  return $ok;
2108 }
2109 
2115 function wfRecursiveRemoveDir( $dir ) {
2116  wfDebug( __FUNCTION__ . "( $dir )\n" );
2117  // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2118  if ( is_dir( $dir ) ) {
2119  $objects = scandir( $dir );
2120  foreach ( $objects as $object ) {
2121  if ( $object != "." && $object != ".." ) {
2122  if ( filetype( $dir . '/' . $object ) == "dir" ) {
2123  wfRecursiveRemoveDir( $dir . '/' . $object );
2124  } else {
2125  unlink( $dir . '/' . $object );
2126  }
2127  }
2128  }
2129  reset( $objects );
2130  rmdir( $dir );
2131  }
2132 }
2133 
2140 function wfPercent( $nr, $acc = 2, $round = true ) {
2141  $ret = sprintf( "%.${acc}f", $nr );
2142  return $round ? round( $ret, $acc ) . '%' : "$ret%";
2143 }
2144 
2168 function wfIniGetBool( $setting ) {
2169  return wfStringToBool( ini_get( $setting ) );
2170 }
2171 
2184 function wfStringToBool( $val ) {
2185  $val = strtolower( $val );
2186  // 'on' and 'true' can't have whitespace around them, but '1' can.
2187  return $val == 'on'
2188  || $val == 'true'
2189  || $val == 'yes'
2190  || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2191 }
2192 
2205 function wfEscapeShellArg( /*...*/ ) {
2206  return Shell::escape( ...func_get_args() );
2207 }
2208 
2232 function wfShellExec( $cmd, &$retval = null, $environ = [],
2233  $limits = [], $options = []
2234 ) {
2235  if ( Shell::isDisabled() ) {
2236  $retval = 1;
2237  // Backwards compatibility be upon us...
2238  return 'Unable to run external programs, proc_open() is disabled.';
2239  }
2240 
2241  if ( is_array( $cmd ) ) {
2242  $cmd = Shell::escape( $cmd );
2243  }
2244 
2245  $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2246  $profileMethod = $options['profileMethod'] ?? wfGetCaller();
2247 
2248  try {
2249  $result = Shell::command( [] )
2250  ->unsafeParams( (array)$cmd )
2251  ->environment( $environ )
2252  ->limits( $limits )
2253  ->includeStderr( $includeStderr )
2254  ->profileMethod( $profileMethod )
2255  // For b/c
2256  ->restrict( Shell::RESTRICT_NONE )
2257  ->execute();
2258  } catch ( ProcOpenError $ex ) {
2259  $retval = -1;
2260  return '';
2261  }
2262 
2263  $retval = $result->getExitCode();
2264 
2265  return $result->getStdout();
2266 }
2267 
2285 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2286  return wfShellExec( $cmd, $retval, $environ, $limits,
2287  [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2288 }
2289 
2304 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2305  global $wgPhpCli;
2306  // Give site config file a chance to run the script in a wrapper.
2307  // The caller may likely want to call wfBasename() on $script.
2308  Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2309  $cmd = [ $options['php'] ?? $wgPhpCli ];
2310  if ( isset( $options['wrapper'] ) ) {
2311  $cmd[] = $options['wrapper'];
2312  }
2313  $cmd[] = $script;
2314  // Escape each parameter for shell
2315  return Shell::escape( array_merge( $cmd, $parameters ) );
2316 }
2317 
2329 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2330  global $wgDiff3;
2331 
2332  # This check may also protect against code injection in
2333  # case of broken installations.
2334  Wikimedia\suppressWarnings();
2335  $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2336  Wikimedia\restoreWarnings();
2337 
2338  if ( !$haveDiff3 ) {
2339  wfDebug( "diff3 not found\n" );
2340  return false;
2341  }
2342 
2343  # Make temporary files
2344  $td = wfTempDir();
2345  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2346  $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2347  $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2348 
2349  # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2350  # a newline character. To avoid this, we normalize the trailing whitespace before
2351  # creating the diff.
2352 
2353  fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2354  fclose( $oldtextFile );
2355  fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2356  fclose( $mytextFile );
2357  fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2358  fclose( $yourtextFile );
2359 
2360  # Check for a conflict
2361  $cmd = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2362  $oldtextName, $yourtextName );
2363  $handle = popen( $cmd, 'r' );
2364 
2365  $mergeAttemptResult = '';
2366  do {
2367  $data = fread( $handle, 8192 );
2368  if ( strlen( $data ) == 0 ) {
2369  break;
2370  }
2371  $mergeAttemptResult .= $data;
2372  } while ( true );
2373  pclose( $handle );
2374 
2375  $conflict = $mergeAttemptResult !== '';
2376 
2377  # Merge differences
2378  $cmd = Shell::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2379  $oldtextName, $yourtextName );
2380  $handle = popen( $cmd, 'r' );
2381  $result = '';
2382  do {
2383  $data = fread( $handle, 8192 );
2384  if ( strlen( $data ) == 0 ) {
2385  break;
2386  }
2387  $result .= $data;
2388  } while ( true );
2389  pclose( $handle );
2390  unlink( $mytextName );
2391  unlink( $oldtextName );
2392  unlink( $yourtextName );
2393 
2394  if ( $result === '' && $old !== '' && !$conflict ) {
2395  wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2396  $conflict = true;
2397  }
2398  return !$conflict;
2399 }
2400 
2412 function wfDiff( $before, $after, $params = '-u' ) {
2413  if ( $before == $after ) {
2414  return '';
2415  }
2416 
2417  global $wgDiff;
2418  Wikimedia\suppressWarnings();
2419  $haveDiff = $wgDiff && file_exists( $wgDiff );
2420  Wikimedia\restoreWarnings();
2421 
2422  # This check may also protect against code injection in
2423  # case of broken installations.
2424  if ( !$haveDiff ) {
2425  wfDebug( "diff executable not found\n" );
2426  $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2427  $format = new UnifiedDiffFormatter();
2428  return $format->format( $diffs );
2429  }
2430 
2431  # Make temporary files
2432  $td = wfTempDir();
2433  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2434  $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2435 
2436  fwrite( $oldtextFile, $before );
2437  fclose( $oldtextFile );
2438  fwrite( $newtextFile, $after );
2439  fclose( $newtextFile );
2440 
2441  // Get the diff of the two files
2442  $cmd = "$wgDiff " . $params . ' ' . Shell::escape( $oldtextName, $newtextName );
2443 
2444  $h = popen( $cmd, 'r' );
2445  if ( !$h ) {
2446  unlink( $oldtextName );
2447  unlink( $newtextName );
2448  throw new Exception( __METHOD__ . '(): popen() failed' );
2449  }
2450 
2451  $diff = '';
2452 
2453  do {
2454  $data = fread( $h, 8192 );
2455  if ( strlen( $data ) == 0 ) {
2456  break;
2457  }
2458  $diff .= $data;
2459  } while ( true );
2460 
2461  // Clean up
2462  pclose( $h );
2463  unlink( $oldtextName );
2464  unlink( $newtextName );
2465 
2466  // Kill the --- and +++ lines. They're not useful.
2467  $diff_lines = explode( "\n", $diff );
2468  if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2469  unset( $diff_lines[0] );
2470  }
2471  if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2472  unset( $diff_lines[1] );
2473  }
2474 
2475  $diff = implode( "\n", $diff_lines );
2476 
2477  return $diff;
2478 }
2479 
2498 function wfUsePHP( $req_ver ) {
2499  wfDeprecated( __FUNCTION__, '1.30' );
2500  $php_ver = PHP_VERSION;
2501 
2502  if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2503  throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2504  }
2505 }
2506 
2529 function wfUseMW( $req_ver ) {
2531 
2532  wfDeprecated( __FUNCTION__, '1.26' );
2533 
2534  if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2535  throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2536  }
2537 }
2538 
2551 function wfBaseName( $path, $suffix = '' ) {
2552  if ( $suffix == '' ) {
2553  $encSuffix = '';
2554  } else {
2555  $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2556  }
2557 
2558  $matches = [];
2559  if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2560  return $matches[1];
2561  } else {
2562  return '';
2563  }
2564 }
2565 
2575 function wfRelativePath( $path, $from ) {
2576  // Normalize mixed input on Windows...
2577  $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2578  $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2579 
2580  // Trim trailing slashes -- fix for drive root
2581  $path = rtrim( $path, DIRECTORY_SEPARATOR );
2582  $from = rtrim( $from, DIRECTORY_SEPARATOR );
2583 
2584  $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2585  $against = explode( DIRECTORY_SEPARATOR, $from );
2586 
2587  if ( $pieces[0] !== $against[0] ) {
2588  // Non-matching Windows drive letters?
2589  // Return a full path.
2590  return $path;
2591  }
2592 
2593  // Trim off common prefix
2594  while ( count( $pieces ) && count( $against )
2595  && $pieces[0] == $against[0] ) {
2596  array_shift( $pieces );
2597  array_shift( $against );
2598  }
2599 
2600  // relative dots to bump us to the parent
2601  while ( count( $against ) ) {
2602  array_unshift( $pieces, '..' );
2603  array_shift( $against );
2604  }
2605 
2606  array_push( $pieces, wfBaseName( $path ) );
2607 
2608  return implode( DIRECTORY_SEPARATOR, $pieces );
2609 }
2610 
2617 function wfResetSessionID() {
2618  wfDeprecated( __FUNCTION__, '1.27' );
2619  $session = SessionManager::getGlobalSession();
2620  $delay = $session->delaySave();
2621 
2622  $session->resetId();
2623 
2624  // Make sure a session is started, since that's what the old
2625  // wfResetSessionID() did.
2626  if ( session_id() !== $session->getId() ) {
2627  wfSetupSession( $session->getId() );
2628  }
2629 
2630  ScopedCallback::consume( $delay );
2631 }
2632 
2642 function wfSetupSession( $sessionId = false ) {
2643  wfDeprecated( __FUNCTION__, '1.27' );
2644 
2645  if ( $sessionId ) {
2646  session_id( $sessionId );
2647  }
2648 
2649  $session = SessionManager::getGlobalSession();
2650  $session->persist();
2651 
2652  if ( session_id() !== $session->getId() ) {
2653  session_id( $session->getId() );
2654  }
2655  Wikimedia\quietCall( 'session_start' );
2656 }
2657 
2665  global $IP;
2666 
2667  $file = "$IP/serialized/$name";
2668  if ( file_exists( $file ) ) {
2669  $blob = file_get_contents( $file );
2670  if ( $blob ) {
2671  return unserialize( $blob );
2672  }
2673  }
2674  return false;
2675 }
2676 
2684 function wfMemcKey( /*...*/ ) {
2685  return ObjectCache::getLocalClusterInstance()->makeKey( ...func_get_args() );
2686 }
2687 
2698 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
2699  $args = array_slice( func_get_args(), 2 );
2700  $keyspace = $prefix ? "$db-$prefix" : $db;
2701  return ObjectCache::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2702 }
2703 
2716 function wfGlobalCacheKey( /*...*/ ) {
2717  return ObjectCache::getLocalClusterInstance()->makeGlobalKey( ...func_get_args() );
2718 }
2719 
2726 function wfWikiID() {
2728  if ( $wgDBprefix ) {
2729  return "$wgDBname-$wgDBprefix";
2730  } else {
2731  return $wgDBname;
2732  }
2733 }
2734 
2742 function wfSplitWikiID( $wiki ) {
2743  $bits = explode( '-', $wiki, 2 );
2744  if ( count( $bits ) < 2 ) {
2745  $bits[] = '';
2746  }
2747  return $bits;
2748 }
2749 
2775 function wfGetDB( $db, $groups = [], $wiki = false ) {
2776  return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2777 }
2778 
2788 function wfGetLB( $wiki = false ) {
2789  if ( $wiki === false ) {
2790  return MediaWikiServices::getInstance()->getDBLoadBalancer();
2791  } else {
2792  $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2793  return $factory->getMainLB( $wiki );
2794  }
2795 }
2796 
2804 function wfGetLBFactory() {
2805  return MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2806 }
2807 
2816 function wfFindFile( $title, $options = [] ) {
2817  return RepoGroup::singleton()->findFile( $title, $options );
2818 }
2819 
2827 function wfLocalFile( $title ) {
2828  return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
2829 }
2830 
2839  return $wgMiserMode
2840  || ( SiteStats::pages() > 100000
2841  && SiteStats::edits() > 1000000
2842  && SiteStats::users() > 10000 );
2843 }
2844 
2853 function wfScript( $script = 'index' ) {
2855  if ( $script === 'index' ) {
2856  return $wgScript;
2857  } elseif ( $script === 'load' ) {
2858  return $wgLoadScript;
2859  } else {
2860  return "{$wgScriptPath}/{$script}.php";
2861  }
2862 }
2863 
2869 function wfGetScriptUrl() {
2870  if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2871  /* as it was called, minus the query string.
2872  *
2873  * Some sites use Apache rewrite rules to handle subdomains,
2874  * and have PHP set up in a weird way that causes PHP_SELF
2875  * to contain the rewritten URL instead of the one that the
2876  * outside world sees.
2877  *
2878  * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2879  * provides containing the "before" URL.
2880  */
2881  return $_SERVER['SCRIPT_NAME'];
2882  } else {
2883  return $_SERVER['URL'];
2884  }
2885 }
2886 
2894 function wfBoolToStr( $value ) {
2895  return $value ? 'true' : 'false';
2896 }
2897 
2903 function wfGetNull() {
2904  return wfIsWindows() ? 'NUL' : '/dev/null';
2905 }
2906 
2930  $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2931 ) {
2932  if ( $timeout === null ) {
2933  $timeout = wfIsCLI() ? 60 : 10;
2934  }
2935 
2936  if ( $cluster === '*' ) {
2937  $cluster = false;
2938  $wiki = false;
2939  } elseif ( $wiki === false ) {
2940  $wiki = wfWikiID();
2941  }
2942 
2943  try {
2944  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2945  $lbFactory->waitForReplication( [
2946  'wiki' => $wiki,
2947  'cluster' => $cluster,
2948  'timeout' => $timeout,
2949  // B/C: first argument used to be "max seconds of lag"; ignore such values
2950  'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
2951  ] );
2952  } catch ( DBReplicationWaitError $e ) {
2953  return false;
2954  }
2955 
2956  return true;
2957 }
2958 
2968 function wfCountDown( $seconds ) {
2969  wfDeprecated( __FUNCTION__, '1.31' );
2970  for ( $i = $seconds; $i >= 0; $i-- ) {
2971  if ( $i != $seconds ) {
2972  echo str_repeat( "\x08", strlen( $i + 1 ) );
2973  }
2974  echo $i;
2975  flush();
2976  if ( $i ) {
2977  sleep( 1 );
2978  }
2979  }
2980  echo "\n";
2981 }
2982 
2993  $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
2994  $name = preg_replace(
2995  "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
2996  '-',
2997  $name
2998  );
2999  // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
3000  $name = wfBaseName( $name );
3001  return $name;
3002 }
3003 
3009 function wfMemoryLimit() {
3011  $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3012  if ( $memlimit != -1 ) {
3013  $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3014  if ( $conflimit == -1 ) {
3015  wfDebug( "Removing PHP's memory limit\n" );
3016  Wikimedia\suppressWarnings();
3017  ini_set( 'memory_limit', $conflimit );
3018  Wikimedia\restoreWarnings();
3019  return $conflimit;
3020  } elseif ( $conflimit > $memlimit ) {
3021  wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3022  Wikimedia\suppressWarnings();
3023  ini_set( 'memory_limit', $conflimit );
3024  Wikimedia\restoreWarnings();
3025  return $conflimit;
3026  }
3027  }
3028  return $memlimit;
3029 }
3030 
3039 
3040  $timeLimit = ini_get( 'max_execution_time' );
3041  // Note that CLI scripts use 0
3042  if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3043  set_time_limit( $wgTransactionalTimeLimit );
3044  }
3045 
3046  ignore_user_abort( true ); // ignore client disconnects
3047 
3048  return $timeLimit;
3049 }
3050 
3058 function wfShorthandToInteger( $string = '', $default = -1 ) {
3059  $string = trim( $string );
3060  if ( $string === '' ) {
3061  return $default;
3062  }
3063  $last = $string[strlen( $string ) - 1];
3064  $val = intval( $string );
3065  switch ( $last ) {
3066  case 'g':
3067  case 'G':
3068  $val *= 1024;
3069  // break intentionally missing
3070  case 'm':
3071  case 'M':
3072  $val *= 1024;
3073  // break intentionally missing
3074  case 'k':
3075  case 'K':
3076  $val *= 1024;
3077  }
3078 
3079  return $val;
3080 }
3081 
3092 function wfBCP47( $code ) {
3093  wfDeprecated( __METHOD__, '1.31' );
3094  return LanguageCode::bcp47( $code );
3095 }
3096 
3104 function wfGetCache( $cacheType ) {
3105  return ObjectCache::getInstance( $cacheType );
3106 }
3107 
3114 function wfGetMainCache() {
3116 }
3117 
3125  return ObjectCache::getInstance( $wgMessageCacheType );
3126 }
3127 
3138 function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3139  wfDeprecated( __METHOD__, '1.25' );
3140  return Hooks::run( $event, $args, $deprecatedVersion );
3141 }
3142 
3157 function wfUnpack( $format, $data, $length = false ) {
3158  if ( $length !== false ) {
3159  $realLen = strlen( $data );
3160  if ( $realLen < $length ) {
3161  throw new MWException( "Tried to use wfUnpack on a "
3162  . "string of length $realLen, but needed one "
3163  . "of at least length $length."
3164  );
3165  }
3166  }
3167 
3168  Wikimedia\suppressWarnings();
3169  $result = unpack( $format, $data );
3170  Wikimedia\restoreWarnings();
3171 
3172  if ( $result === false ) {
3173  // If it cannot extract the packed data.
3174  throw new MWException( "unpack could not unpack binary data" );
3175  }
3176  return $result;
3177 }
3178 
3193 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3194  # Handle redirects; callers almost always hit wfFindFile() anyway,
3195  # so just use that method because it has a fast process cache.
3196  $file = wfFindFile( $name ); // get the final name
3197  $name = $file ? $file->getTitle()->getDBkey() : $name;
3198 
3199  # Run the extension hook
3200  $bad = false;
3201  if ( !Hooks::run( 'BadImage', [ $name, &$bad ] ) ) {
3202  return (bool)$bad;
3203  }
3204 
3206  $key = $cache->makeKey(
3207  'bad-image-list', ( $blacklist === null ) ? 'default' : md5( $blacklist )
3208  );
3209  $badImages = $cache->get( $key );
3210 
3211  if ( $badImages === false ) { // cache miss
3212  if ( $blacklist === null ) {
3213  $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3214  }
3215  # Build the list now
3216  $badImages = [];
3217  $lines = explode( "\n", $blacklist );
3218  foreach ( $lines as $line ) {
3219  # List items only
3220  if ( substr( $line, 0, 1 ) !== '*' ) {
3221  continue;
3222  }
3223 
3224  # Find all links
3225  $m = [];
3226  if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3227  continue;
3228  }
3229 
3230  $exceptions = [];
3231  $imageDBkey = false;
3232  foreach ( $m[1] as $i => $titleText ) {
3233  $title = Title::newFromText( $titleText );
3234  if ( !is_null( $title ) ) {
3235  if ( $i == 0 ) {
3236  $imageDBkey = $title->getDBkey();
3237  } else {
3238  $exceptions[$title->getPrefixedDBkey()] = true;
3239  }
3240  }
3241  }
3242 
3243  if ( $imageDBkey !== false ) {
3244  $badImages[$imageDBkey] = $exceptions;
3245  }
3246  }
3247  $cache->set( $key, $badImages, 60 );
3248  }
3249 
3250  $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
3251  $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3252 
3253  return $bad;
3254 }
3255 
3263 function wfCanIPUseHTTPS( $ip ) {
3264  $canDo = true;
3265  Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3266  return !!$canDo;
3267 }
3268 
3276 function wfIsInfinity( $str ) {
3277  // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3278  $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3279  return in_array( $str, $infinityValues );
3280 }
3281 
3296 function wfThumbIsStandard( File $file, array $params ) {
3298 
3299  $multipliers = [ 1 ];
3300  if ( $wgResponsiveImages ) {
3301  // These available sizes are hardcoded currently elsewhere in MediaWiki.
3302  // @see Linker::processResponsiveImages
3303  $multipliers[] = 1.5;
3304  $multipliers[] = 2;
3305  }
3306 
3307  $handler = $file->getHandler();
3308  if ( !$handler || !isset( $params['width'] ) ) {
3309  return false;
3310  }
3311 
3312  $basicParams = [];
3313  if ( isset( $params['page'] ) ) {
3314  $basicParams['page'] = $params['page'];
3315  }
3316 
3317  $thumbLimits = [];
3318  $imageLimits = [];
3319  // Expand limits to account for multipliers
3320  foreach ( $multipliers as $multiplier ) {
3321  $thumbLimits = array_merge( $thumbLimits, array_map(
3322  function ( $width ) use ( $multiplier ) {
3323  return round( $width * $multiplier );
3324  }, $wgThumbLimits )
3325  );
3326  $imageLimits = array_merge( $imageLimits, array_map(
3327  function ( $pair ) use ( $multiplier ) {
3328  return [
3329  round( $pair[0] * $multiplier ),
3330  round( $pair[1] * $multiplier ),
3331  ];
3332  }, $wgImageLimits )
3333  );
3334  }
3335 
3336  // Check if the width matches one of $wgThumbLimits
3337  if ( in_array( $params['width'], $thumbLimits ) ) {
3338  $normalParams = $basicParams + [ 'width' => $params['width'] ];
3339  // Append any default values to the map (e.g. "lossy", "lossless", ...)
3340  $handler->normaliseParams( $file, $normalParams );
3341  } else {
3342  // If not, then check if the width matchs one of $wgImageLimits
3343  $match = false;
3344  foreach ( $imageLimits as $pair ) {
3345  $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3346  // Decide whether the thumbnail should be scaled on width or height.
3347  // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3348  $handler->normaliseParams( $file, $normalParams );
3349  // Check if this standard thumbnail size maps to the given width
3350  if ( $normalParams['width'] == $params['width'] ) {
3351  $match = true;
3352  break;
3353  }
3354  }
3355  if ( !$match ) {
3356  return false; // not standard for description pages
3357  }
3358  }
3359 
3360  // Check that the given values for non-page, non-width, params are just defaults
3361  foreach ( $params as $key => $value ) {
3362  if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3363  return false;
3364  }
3365  }
3366 
3367  return true;
3368 }
3369 
3382 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3383  // First merge items that are in both arrays
3384  foreach ( $baseArray as $name => &$groupVal ) {
3385  if ( isset( $newValues[$name] ) ) {
3386  $groupVal += $newValues[$name];
3387  }
3388  }
3389  // Now add items that didn't exist yet
3390  $baseArray += $newValues;
3391 
3392  return $baseArray;
3393 }
3394 
3403 function wfGetRusage() {
3404  if ( !function_exists( 'getrusage' ) ) {
3405  return false;
3406  } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS === 'Linux' ) {
3407  return getrusage( 2 /* RUSAGE_THREAD */ );
3408  } else {
3409  return getrusage( 0 /* RUSAGE_SELF */ );
3410  }
3411 }
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:798
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:1636
$wgScript
The URL path to index.php.
$wgVersion
MediaWiki version number.
wfIsHHVM()
Check if we are running under HHVM.
wfForeignMemcKey( $db, $prefix)
Make a cache key for a foreign DB.
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:2041
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2218
wfErrorLog( $text, $file, array $context=[])
Log to a file without getting "file size exceeded" signals.
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:1300
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.
wfUseMW( $req_ver)
This function works like "use VERSION" in Perl except it checks the version of MediaWiki, the program will die with a backtrace if the current version of MediaWiki is less than the version provided.
$source
$value
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.
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.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
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:2275
wfVarDump( $var)
A wrapper around the PHP function var_export().
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition: design.txt:56
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:2039
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...
wfGlobalCacheKey()
Make a cache key with database-agnostic prefix.
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.
wfRunHooks( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in $wgHooks.
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.
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.
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
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
Definition: design.txt:25
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
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 fetchLanguageNames( $inLanguage=null, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:820
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:2041
$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:949
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:183
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:2041
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:798
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
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:940
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:2681
static deprecated( $function, $version=false, $component=false, $callerOffset=2)
Show a warning that $function is deprecated.
Definition: MWDebug.php:193
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
wfStringToBool( $val)
Convert string value to boolean, when the following are interpreted as true:
Exception class for replica DB wait timeouts.
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()
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:627
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:737
$wgServer
URL of the server.
wfMemcKey()
Make a cache key for the local wiki.
wfRelativePath( $path, $from)
Generate a relative path name to the given file.
$wgOut
Definition: Setup.php:897
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.
wfUsePHP( $req_ver)
This function works like "use VERSION" in Perl, the program will die with a backtrace if the current ...
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:798
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:2681
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:273