MediaWiki  REL1_31
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 
32 use Wikimedia\ScopedCallback;
34 
45 function wfLoadExtension( $ext, $path = null ) {
46  if ( !$path ) {
48  $path = "$wgExtensionDirectory/$ext/extension.json";
49  }
51 }
52 
66 function wfLoadExtensions( array $exts ) {
68  $registry = ExtensionRegistry::getInstance();
69  foreach ( $exts as $ext ) {
70  $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
71  }
72 }
73 
82 function wfLoadSkin( $skin, $path = null ) {
83  if ( !$path ) {
85  $path = "$wgStyleDirectory/$skin/skin.json";
86  }
88 }
89 
97 function wfLoadSkins( array $skins ) {
99  $registry = ExtensionRegistry::getInstance();
100  foreach ( $skins as $skin ) {
101  $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
102  }
103 }
104 
111 function wfArrayDiff2( $a, $b ) {
112  return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
113 }
114 
120 function wfArrayDiff2_cmp( $a, $b ) {
121  if ( is_string( $a ) && is_string( $b ) ) {
122  return strcmp( $a, $b );
123  } elseif ( count( $a ) !== count( $b ) ) {
124  return count( $a ) < count( $b ) ? -1 : 1;
125  } else {
126  reset( $a );
127  reset( $b );
128  while ( key( $a ) !== null && key( $b ) !== null ) {
129  $valueA = current( $a );
130  $valueB = current( $b );
131  $cmp = strcmp( $valueA, $valueB );
132  if ( $cmp !== 0 ) {
133  return $cmp;
134  }
135  next( $a );
136  next( $b );
137  }
138  return 0;
139  }
140 }
141 
150 function wfArrayFilter( array $arr, callable $callback ) {
151  if ( defined( 'ARRAY_FILTER_USE_BOTH' ) ) {
152  return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH );
153  }
154  $filteredKeys = array_filter( array_keys( $arr ), function ( $key ) use ( $arr, $callback ) {
155  return call_user_func( $callback, $arr[$key], $key );
156  } );
157  return array_intersect_key( $arr, array_fill_keys( $filteredKeys, true ) );
158 }
159 
168 function wfArrayFilterByKey( array $arr, callable $callback ) {
169  return wfArrayFilter( $arr, function ( $val, $key ) use ( $callback ) {
170  return call_user_func( $callback, $key );
171  } );
172 }
173 
183 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
184  if ( is_null( $changed ) ) {
185  throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
186  }
187  if ( $default[$key] !== $value ) {
188  $changed[$key] = $value;
189  }
190 }
191 
211 function wfMergeErrorArrays( /*...*/ ) {
212  $args = func_get_args();
213  $out = [];
214  foreach ( $args as $errors ) {
215  foreach ( $errors as $params ) {
216  $originalParams = $params;
217  if ( $params[0] instanceof MessageSpecifier ) {
218  $msg = $params[0];
219  $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
220  }
221  # @todo FIXME: Sometimes get nested arrays for $params,
222  # which leads to E_NOTICEs
223  $spec = implode( "\t", $params );
224  $out[$spec] = $originalParams;
225  }
226  }
227  return array_values( $out );
228 }
229 
238 function wfArrayInsertAfter( array $array, array $insert, $after ) {
239  // Find the offset of the element to insert after.
240  $keys = array_keys( $array );
241  $offsetByKey = array_flip( $keys );
242 
243  $offset = $offsetByKey[$after];
244 
245  // Insert at the specified offset
246  $before = array_slice( $array, 0, $offset + 1, true );
247  $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
248 
249  $output = $before + $insert + $after;
250 
251  return $output;
252 }
253 
261 function wfObjectToArray( $objOrArray, $recursive = true ) {
262  $array = [];
263  if ( is_object( $objOrArray ) ) {
264  $objOrArray = get_object_vars( $objOrArray );
265  }
266  foreach ( $objOrArray as $key => $value ) {
267  if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
269  }
270 
271  $array[$key] = $value;
272  }
273 
274  return $array;
275 }
276 
287 function wfRandom() {
288  // The maximum random value is "only" 2^31-1, so get two random
289  // values to reduce the chance of dupes
290  $max = mt_getrandmax() + 1;
291  $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
292  return $rand;
293 }
294 
305 function wfRandomString( $length = 32 ) {
306  $str = '';
307  for ( $n = 0; $n < $length; $n += 7 ) {
308  $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
309  }
310  return substr( $str, 0, $length );
311 }
312 
340 function wfUrlencode( $s ) {
341  static $needle;
342 
343  if ( is_null( $s ) ) {
344  $needle = null;
345  return '';
346  }
347 
348  if ( is_null( $needle ) ) {
349  $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
350  if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
351  ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
352  ) {
353  $needle[] = '%3A';
354  }
355  }
356 
357  $s = urlencode( $s );
358  $s = str_ireplace(
359  $needle,
360  [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
361  $s
362  );
363 
364  return $s;
365 }
366 
377 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
378  if ( !is_null( $array2 ) ) {
379  $array1 = $array1 + $array2;
380  }
381 
382  $cgi = '';
383  foreach ( $array1 as $key => $value ) {
384  if ( !is_null( $value ) && $value !== false ) {
385  if ( $cgi != '' ) {
386  $cgi .= '&';
387  }
388  if ( $prefix !== '' ) {
389  $key = $prefix . "[$key]";
390  }
391  if ( is_array( $value ) ) {
392  $firstTime = true;
393  foreach ( $value as $k => $v ) {
394  $cgi .= $firstTime ? '' : '&';
395  if ( is_array( $v ) ) {
396  $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
397  } else {
398  $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
399  }
400  $firstTime = false;
401  }
402  } else {
403  if ( is_object( $value ) ) {
404  $value = $value->__toString();
405  }
406  $cgi .= urlencode( $key ) . '=' . urlencode( $value );
407  }
408  }
409  }
410  return $cgi;
411 }
412 
422 function wfCgiToArray( $query ) {
423  if ( isset( $query[0] ) && $query[0] == '?' ) {
424  $query = substr( $query, 1 );
425  }
426  $bits = explode( '&', $query );
427  $ret = [];
428  foreach ( $bits as $bit ) {
429  if ( $bit === '' ) {
430  continue;
431  }
432  if ( strpos( $bit, '=' ) === false ) {
433  // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
434  $key = $bit;
435  $value = '';
436  } else {
437  list( $key, $value ) = explode( '=', $bit );
438  }
439  $key = urldecode( $key );
440  $value = urldecode( $value );
441  if ( strpos( $key, '[' ) !== false ) {
442  $keys = array_reverse( explode( '[', $key ) );
443  $key = array_pop( $keys );
444  $temp = $value;
445  foreach ( $keys as $k ) {
446  $k = substr( $k, 0, -1 );
447  $temp = [ $k => $temp ];
448  }
449  if ( isset( $ret[$key] ) ) {
450  $ret[$key] = array_merge( $ret[$key], $temp );
451  } else {
452  $ret[$key] = $temp;
453  }
454  } else {
455  $ret[$key] = $value;
456  }
457  }
458  return $ret;
459 }
460 
469 function wfAppendQuery( $url, $query ) {
470  if ( is_array( $query ) ) {
472  }
473  if ( $query != '' ) {
474  // Remove the fragment, if there is one
475  $fragment = false;
476  $hashPos = strpos( $url, '#' );
477  if ( $hashPos !== false ) {
478  $fragment = substr( $url, $hashPos );
479  $url = substr( $url, 0, $hashPos );
480  }
481 
482  // Add parameter
483  if ( false === strpos( $url, '?' ) ) {
484  $url .= '?';
485  } else {
486  $url .= '&';
487  }
488  $url .= $query;
489 
490  // Put the fragment back
491  if ( $fragment !== false ) {
492  $url .= $fragment;
493  }
494  }
495  return $url;
496 }
497 
521 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
523  $wgHttpsPort;
524  if ( $defaultProto === PROTO_CANONICAL ) {
525  $serverUrl = $wgCanonicalServer;
526  } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
527  // Make $wgInternalServer fall back to $wgServer if not set
528  $serverUrl = $wgInternalServer;
529  } else {
530  $serverUrl = $wgServer;
531  if ( $defaultProto === PROTO_CURRENT ) {
532  $defaultProto = $wgRequest->getProtocol() . '://';
533  }
534  }
535 
536  // Analyze $serverUrl to obtain its protocol
537  $bits = wfParseUrl( $serverUrl );
538  $serverHasProto = $bits && $bits['scheme'] != '';
539 
540  if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
541  if ( $serverHasProto ) {
542  $defaultProto = $bits['scheme'] . '://';
543  } else {
544  // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
545  // This really isn't supposed to happen. Fall back to HTTP in this
546  // ridiculous case.
547  $defaultProto = PROTO_HTTP;
548  }
549  }
550 
551  $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
552 
553  if ( substr( $url, 0, 2 ) == '//' ) {
554  $url = $defaultProtoWithoutSlashes . $url;
555  } elseif ( substr( $url, 0, 1 ) == '/' ) {
556  // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
557  // otherwise leave it alone.
558  $url = ( $serverHasProto ? '' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
559  }
560 
561  $bits = wfParseUrl( $url );
562 
563  // ensure proper port for HTTPS arrives in URL
564  // https://phabricator.wikimedia.org/T67184
565  if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
566  $bits['port'] = $wgHttpsPort;
567  }
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 
597 function wfAssembleUrl( $urlParts ) {
598  $result = '';
599 
600  if ( isset( $urlParts['delimiter'] ) ) {
601  if ( isset( $urlParts['scheme'] ) ) {
602  $result .= $urlParts['scheme'];
603  }
604 
605  $result .= $urlParts['delimiter'];
606  }
607 
608  if ( isset( $urlParts['host'] ) ) {
609  if ( isset( $urlParts['user'] ) ) {
610  $result .= $urlParts['user'];
611  if ( isset( $urlParts['pass'] ) ) {
612  $result .= ':' . $urlParts['pass'];
613  }
614  $result .= '@';
615  }
616 
617  $result .= $urlParts['host'];
618 
619  if ( isset( $urlParts['port'] ) ) {
620  $result .= ':' . $urlParts['port'];
621  }
622  }
623 
624  if ( isset( $urlParts['path'] ) ) {
625  $result .= $urlParts['path'];
626  }
627 
628  if ( isset( $urlParts['query'] ) ) {
629  $result .= '?' . $urlParts['query'];
630  }
631 
632  if ( isset( $urlParts['fragment'] ) ) {
633  $result .= '#' . $urlParts['fragment'];
634  }
635 
636  return $result;
637 }
638 
649 function wfRemoveDotSegments( $urlPath ) {
650  $output = '';
651  $inputOffset = 0;
652  $inputLength = strlen( $urlPath );
653 
654  while ( $inputOffset < $inputLength ) {
655  $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
656  $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
657  $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
658  $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
659  $trimOutput = false;
660 
661  if ( $prefixLengthTwo == './' ) {
662  # Step A, remove leading "./"
663  $inputOffset += 2;
664  } elseif ( $prefixLengthThree == '../' ) {
665  # Step A, remove leading "../"
666  $inputOffset += 3;
667  } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
668  # Step B, replace leading "/.$" with "/"
669  $inputOffset += 1;
670  $urlPath[$inputOffset] = '/';
671  } elseif ( $prefixLengthThree == '/./' ) {
672  # Step B, replace leading "/./" with "/"
673  $inputOffset += 2;
674  } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
675  # Step C, replace leading "/..$" with "/" and
676  # remove last path component in output
677  $inputOffset += 2;
678  $urlPath[$inputOffset] = '/';
679  $trimOutput = true;
680  } elseif ( $prefixLengthFour == '/../' ) {
681  # Step C, replace leading "/../" with "/" and
682  # remove last path component in output
683  $inputOffset += 3;
684  $trimOutput = true;
685  } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
686  # Step D, remove "^.$"
687  $inputOffset += 1;
688  } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
689  # Step D, remove "^..$"
690  $inputOffset += 2;
691  } else {
692  # Step E, move leading path segment to output
693  if ( $prefixLengthOne == '/' ) {
694  $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
695  } else {
696  $slashPos = strpos( $urlPath, '/', $inputOffset );
697  }
698  if ( $slashPos === false ) {
699  $output .= substr( $urlPath, $inputOffset );
700  $inputOffset = $inputLength;
701  } else {
702  $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
703  $inputOffset += $slashPos - $inputOffset;
704  }
705  }
706 
707  if ( $trimOutput ) {
708  $slashPos = strrpos( $output, '/' );
709  if ( $slashPos === false ) {
710  $output = '';
711  } else {
712  $output = substr( $output, 0, $slashPos );
713  }
714  }
715  }
716 
717  return $output;
718 }
719 
727 function wfUrlProtocols( $includeProtocolRelative = true ) {
729 
730  // Cache return values separately based on $includeProtocolRelative
731  static $withProtRel = null, $withoutProtRel = null;
732  $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
733  if ( !is_null( $cachedValue ) ) {
734  return $cachedValue;
735  }
736 
737  // Support old-style $wgUrlProtocols strings, for backwards compatibility
738  // with LocalSettings files from 1.5
739  if ( is_array( $wgUrlProtocols ) ) {
740  $protocols = [];
741  foreach ( $wgUrlProtocols as $protocol ) {
742  // Filter out '//' if !$includeProtocolRelative
743  if ( $includeProtocolRelative || $protocol !== '//' ) {
744  $protocols[] = preg_quote( $protocol, '/' );
745  }
746  }
747 
748  $retval = implode( '|', $protocols );
749  } else {
750  // Ignore $includeProtocolRelative in this case
751  // This case exists for pre-1.6 compatibility, and we can safely assume
752  // that '//' won't appear in a pre-1.6 config because protocol-relative
753  // URLs weren't supported until 1.18
755  }
756 
757  // Cache return value
758  if ( $includeProtocolRelative ) {
759  $withProtRel = $retval;
760  } else {
761  $withoutProtRel = $retval;
762  }
763  return $retval;
764 }
765 
773  return wfUrlProtocols( false );
774 }
775 
801 function wfParseUrl( $url ) {
802  global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
803 
804  // Protocol-relative URLs are handled really badly by parse_url(). It's so
805  // bad that the easiest way to handle them is to just prepend 'http:' and
806  // strip the protocol out later.
807  $wasRelative = substr( $url, 0, 2 ) == '//';
808  if ( $wasRelative ) {
809  $url = "http:$url";
810  }
811  Wikimedia\suppressWarnings();
812  $bits = parse_url( $url );
813  Wikimedia\restoreWarnings();
814 
815  // T212067: PHP < 5.6.28, 7.0.0–7.0.12, and HHVM (all relevant versions) screw up parsing
816  // the query part of pathless URLs
817  if ( isset( $bits['host'] ) && strpos( $bits['host'], '?' ) !== false ) {
818  list( $host, $query ) = explode( '?', $bits['host'], 2 );
819  $bits['host'] = $host;
820  $bits['query'] = $query
821  . ( $bits['path'] ?? '' )
822  . ( isset( $bits['query'] ) ? '?' . $bits['query'] : '' );
823  unset( $bits['path'] );
824  }
825 
826  // parse_url() returns an array without scheme for some invalid URLs, e.g.
827  // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
828  if ( !$bits || !isset( $bits['scheme'] ) ) {
829  return false;
830  }
831 
832  // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
833  $bits['scheme'] = strtolower( $bits['scheme'] );
834 
835  // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
836  if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
837  $bits['delimiter'] = '://';
838  } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
839  $bits['delimiter'] = ':';
840  // parse_url detects for news: and mailto: the host part of an url as path
841  // We have to correct this wrong detection
842  if ( isset( $bits['path'] ) ) {
843  $bits['host'] = $bits['path'];
844  $bits['path'] = '';
845  }
846  } else {
847  return false;
848  }
849 
850  /* Provide an empty host for eg. file:/// urls (see T30627) */
851  if ( !isset( $bits['host'] ) ) {
852  $bits['host'] = '';
853 
854  // See T47069
855  if ( isset( $bits['path'] ) ) {
856  /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
857  if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
858  $bits['path'] = '/' . $bits['path'];
859  }
860  } else {
861  $bits['path'] = '';
862  }
863  }
864 
865  // If the URL was protocol-relative, fix scheme and delimiter
866  if ( $wasRelative ) {
867  $bits['scheme'] = '';
868  $bits['delimiter'] = '//';
869  }
870  return $bits;
871 }
872 
883 function wfExpandIRI( $url ) {
884  return preg_replace_callback(
885  '/((?:%[89A-F][0-9A-F])+)/i',
886  'wfExpandIRI_callback',
887  wfExpandUrl( $url )
888  );
889 }
890 
897  return urldecode( $matches[1] );
898 }
899 
906 function wfMakeUrlIndexes( $url ) {
907  $bits = wfParseUrl( $url );
908 
909  // Reverse the labels in the hostname, convert to lower case
910  // For emails reverse domainpart only
911  if ( $bits['scheme'] == 'mailto' ) {
912  $mailparts = explode( '@', $bits['host'], 2 );
913  if ( count( $mailparts ) === 2 ) {
914  $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
915  } else {
916  // No domain specified, don't mangle it
917  $domainpart = '';
918  }
919  $reversedHost = $domainpart . '@' . $mailparts[0];
920  } else {
921  $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
922  }
923  // Add an extra dot to the end
924  // Why? Is it in wrong place in mailto links?
925  if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
926  $reversedHost .= '.';
927  }
928  // Reconstruct the pseudo-URL
929  $prot = $bits['scheme'];
930  $index = $prot . $bits['delimiter'] . $reversedHost;
931  // Leave out user and password. Add the port, path, query and fragment
932  if ( isset( $bits['port'] ) ) {
933  $index .= ':' . $bits['port'];
934  }
935  if ( isset( $bits['path'] ) ) {
936  $index .= $bits['path'];
937  } else {
938  $index .= '/';
939  }
940  if ( isset( $bits['query'] ) ) {
941  $index .= '?' . $bits['query'];
942  }
943  if ( isset( $bits['fragment'] ) ) {
944  $index .= '#' . $bits['fragment'];
945  }
946 
947  if ( $prot == '' ) {
948  return [ "http:$index", "https:$index" ];
949  } else {
950  return [ $index ];
951  }
952 }
953 
960 function wfMatchesDomainList( $url, $domains ) {
961  $bits = wfParseUrl( $url );
962  if ( is_array( $bits ) && isset( $bits['host'] ) ) {
963  $host = '.' . $bits['host'];
964  foreach ( (array)$domains as $domain ) {
965  $domain = '.' . $domain;
966  if ( substr( $host, -strlen( $domain ) ) === $domain ) {
967  return true;
968  }
969  }
970  }
971  return false;
972 }
973 
994 function wfDebug( $text, $dest = 'all', array $context = [] ) {
997 
998  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
999  return;
1000  }
1001 
1002  $text = trim( $text );
1003 
1004  if ( $wgDebugTimestamps ) {
1005  $context['seconds_elapsed'] = sprintf(
1006  '%6.4f',
1007  microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
1008  );
1009  $context['memory_used'] = sprintf(
1010  '%5.1fM',
1011  ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1012  );
1013  }
1014 
1015  if ( $wgDebugLogPrefix !== '' ) {
1016  $context['prefix'] = $wgDebugLogPrefix;
1017  }
1018  $context['private'] = ( $dest === false || $dest === 'private' );
1019 
1020  $logger = LoggerFactory::getInstance( 'wfDebug' );
1021  $logger->debug( $text, $context );
1022 }
1023 
1028 function wfIsDebugRawPage() {
1029  static $cache;
1030  if ( $cache !== null ) {
1031  return $cache;
1032  }
1033  # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1034  if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1035  || (
1036  isset( $_SERVER['SCRIPT_NAME'] )
1037  && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1038  )
1039  ) {
1040  $cache = true;
1041  } else {
1042  $cache = false;
1043  }
1044  return $cache;
1045 }
1046 
1052 function wfDebugMem( $exact = false ) {
1053  $mem = memory_get_usage();
1054  if ( !$exact ) {
1055  $mem = floor( $mem / 1024 ) . ' KiB';
1056  } else {
1057  $mem .= ' B';
1058  }
1059  wfDebug( "Memory usage: $mem\n" );
1060 }
1061 
1087 function wfDebugLog(
1088  $logGroup, $text, $dest = 'all', array $context = []
1089 ) {
1090  $text = trim( $text );
1091 
1092  $logger = LoggerFactory::getInstance( $logGroup );
1093  $context['private'] = ( $dest === false || $dest === 'private' );
1094  $logger->info( $text, $context );
1095 }
1096 
1105 function wfLogDBError( $text, array $context = [] ) {
1106  $logger = LoggerFactory::getInstance( 'wfLogDBError' );
1107  $logger->error( trim( $text ), $context );
1108 }
1109 
1123 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1124  MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1125 }
1126 
1137 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1138  MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1139 }
1140 
1150 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1151  MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1152 }
1153 
1167 function wfErrorLog( $text, $file, array $context = [] ) {
1168  wfDeprecated( __METHOD__, '1.25' );
1169  $logger = LoggerFactory::getInstance( 'wfErrorLog' );
1170  $context['destination'] = $file;
1171  $logger->info( trim( $text ), $context );
1172 }
1173 
1180 
1182  $request = $context->getRequest();
1183 
1184  $profiler = Profiler::instance();
1185  $profiler->setContext( $context );
1186  $profiler->logData();
1187 
1188  // Send out any buffered statsd metrics as needed
1190  MediaWikiServices::getInstance()->getStatsdDataFactory(),
1191  $context->getConfig()
1192  );
1193 
1194  // Profiling must actually be enabled...
1195  if ( $profiler instanceof ProfilerStub ) {
1196  return;
1197  }
1198 
1199  if ( isset( $wgDebugLogGroups['profileoutput'] )
1200  && $wgDebugLogGroups['profileoutput'] === false
1201  ) {
1202  // Explicitly disabled
1203  return;
1204  }
1205  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1206  return;
1207  }
1208 
1209  $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1210  if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1211  $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1212  }
1213  if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1214  $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1215  }
1216  if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1217  $ctx['from'] = $_SERVER['HTTP_FROM'];
1218  }
1219  if ( isset( $ctx['forwarded_for'] ) ||
1220  isset( $ctx['client_ip'] ) ||
1221  isset( $ctx['from'] ) ) {
1222  $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1223  }
1224 
1225  // Don't load $wgUser at this late stage just for statistics purposes
1226  // @todo FIXME: We can detect some anons even if it is not loaded.
1227  // See User::getId()
1228  $user = $context->getUser();
1229  $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1230 
1231  // Command line script uses a FauxRequest object which does not have
1232  // any knowledge about an URL and throw an exception instead.
1233  try {
1234  $ctx['url'] = urldecode( $request->getRequestURL() );
1235  } catch ( Exception $ignored ) {
1236  // no-op
1237  }
1238 
1239  $ctx['output'] = $profiler->getOutput();
1240 
1241  $log = LoggerFactory::getInstance( 'profileoutput' );
1242  $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1243 }
1244 
1252 function wfIncrStats( $key, $count = 1 ) {
1253  $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1254  $stats->updateCount( $key, $count );
1255 }
1256 
1262 function wfReadOnly() {
1263  return MediaWikiServices::getInstance()->getReadOnlyMode()
1264  ->isReadOnly();
1265 }
1266 
1275 function wfReadOnlyReason() {
1276  return MediaWikiServices::getInstance()->getReadOnlyMode()
1277  ->getReason();
1278 }
1279 
1287  return MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1288  ->getReason();
1289 }
1290 
1306 function wfGetLangObj( $langcode = false ) {
1307  # Identify which language to get or create a language object for.
1308  # Using is_object here due to Stub objects.
1309  if ( is_object( $langcode ) ) {
1310  # Great, we already have the object (hopefully)!
1311  return $langcode;
1312  }
1313 
1315  if ( $langcode === true || $langcode === $wgLanguageCode ) {
1316  # $langcode is the language code of the wikis content language object.
1317  # or it is a boolean and value is true
1318  return $wgContLang;
1319  }
1320 
1321  global $wgLang;
1322  if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1323  # $langcode is the language code of user language object.
1324  # or it was a boolean and value is false
1325  return $wgLang;
1326  }
1327 
1328  $validCodes = array_keys( Language::fetchLanguageNames() );
1329  if ( in_array( $langcode, $validCodes ) ) {
1330  # $langcode corresponds to a valid language.
1331  return Language::factory( $langcode );
1332  }
1333 
1334  # $langcode is a string, but not a valid language code; use content language.
1335  wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1336  return $wgContLang;
1337 }
1338 
1355 function wfMessage( $key /*...*/ ) {
1356  $message = new Message( $key );
1357 
1358  // We call Message::params() to reduce code duplication
1359  $params = func_get_args();
1360  array_shift( $params );
1361  if ( $params ) {
1362  call_user_func_array( [ $message, 'params' ], $params );
1363  }
1364 
1365  return $message;
1366 }
1367 
1380 function wfMessageFallback( /*...*/ ) {
1381  $args = func_get_args();
1382  return call_user_func_array( 'Message::newFallbackSequence', $args );
1383 }
1384 
1393 function wfMsgReplaceArgs( $message, $args ) {
1394  # Fix windows line-endings
1395  # Some messages are split with explode("\n", $msg)
1396  $message = str_replace( "\r", '', $message );
1397 
1398  // Replace arguments
1399  if ( is_array( $args ) && $args ) {
1400  if ( is_array( $args[0] ) ) {
1401  $args = array_values( $args[0] );
1402  }
1403  $replacementKeys = [];
1404  foreach ( $args as $n => $param ) {
1405  $replacementKeys['$' . ( $n + 1 )] = $param;
1406  }
1407  $message = strtr( $message, $replacementKeys );
1408  }
1409 
1410  return $message;
1411 }
1412 
1420 function wfHostname() {
1421  static $host;
1422  if ( is_null( $host ) ) {
1423  # Hostname overriding
1425  if ( $wgOverrideHostname !== false ) {
1426  # Set static and skip any detection
1427  $host = $wgOverrideHostname;
1428  return $host;
1429  }
1430 
1431  if ( function_exists( 'posix_uname' ) ) {
1432  // This function not present on Windows
1433  $uname = posix_uname();
1434  } else {
1435  $uname = false;
1436  }
1437  if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1438  $host = $uname['nodename'];
1439  } elseif ( getenv( 'COMPUTERNAME' ) ) {
1440  # Windows computer name
1441  $host = getenv( 'COMPUTERNAME' );
1442  } else {
1443  # This may be a virtual server.
1444  $host = $_SERVER['SERVER_NAME'];
1445  }
1446  }
1447  return $host;
1448 }
1449 
1459 function wfReportTime() {
1461 
1462  $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1463  // seconds to milliseconds
1464  $responseTime = round( $elapsed * 1000 );
1465  $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1466  if ( $wgShowHostnames ) {
1467  $reportVars['wgHostname'] = wfHostname();
1468  }
1469  return Skin::makeVariablesScript( $reportVars );
1470 }
1471 
1482 function wfDebugBacktrace( $limit = 0 ) {
1483  static $disabled = null;
1484 
1485  if ( is_null( $disabled ) ) {
1486  $disabled = !function_exists( 'debug_backtrace' );
1487  if ( $disabled ) {
1488  wfDebug( "debug_backtrace() is disabled\n" );
1489  }
1490  }
1491  if ( $disabled ) {
1492  return [];
1493  }
1494 
1495  if ( $limit ) {
1496  return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1497  } else {
1498  return array_slice( debug_backtrace(), 1 );
1499  }
1500 }
1501 
1510 function wfBacktrace( $raw = null ) {
1512 
1513  if ( $raw === null ) {
1514  $raw = $wgCommandLineMode;
1515  }
1516 
1517  if ( $raw ) {
1518  $frameFormat = "%s line %s calls %s()\n";
1519  $traceFormat = "%s";
1520  } else {
1521  $frameFormat = "<li>%s line %s calls %s()</li>\n";
1522  $traceFormat = "<ul>\n%s</ul>\n";
1523  }
1524 
1525  $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1526  $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1527  $line = isset( $frame['line'] ) ? $frame['line'] : '-';
1528  $call = $frame['function'];
1529  if ( !empty( $frame['class'] ) ) {
1530  $call = $frame['class'] . $frame['type'] . $call;
1531  }
1532  return sprintf( $frameFormat, $file, $line, $call );
1533  }, wfDebugBacktrace() );
1534 
1535  return sprintf( $traceFormat, implode( '', $frames ) );
1536 }
1537 
1547 function wfGetCaller( $level = 2 ) {
1548  $backtrace = wfDebugBacktrace( $level + 1 );
1549  if ( isset( $backtrace[$level] ) ) {
1550  return wfFormatStackFrame( $backtrace[$level] );
1551  } else {
1552  return 'unknown';
1553  }
1554 }
1555 
1563 function wfGetAllCallers( $limit = 3 ) {
1564  $trace = array_reverse( wfDebugBacktrace() );
1565  if ( !$limit || $limit > count( $trace ) - 1 ) {
1566  $limit = count( $trace ) - 1;
1567  }
1568  $trace = array_slice( $trace, -$limit - 1, $limit );
1569  return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1570 }
1571 
1578 function wfFormatStackFrame( $frame ) {
1579  if ( !isset( $frame['function'] ) ) {
1580  return 'NO_FUNCTION_GIVEN';
1581  }
1582  return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1583  $frame['class'] . $frame['type'] . $frame['function'] :
1584  $frame['function'];
1585 }
1586 
1587 /* Some generic result counters, pulled out of SearchEngine */
1588 
1596 function wfShowingResults( $offset, $limit ) {
1597  return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1598 }
1599 
1609 function wfClientAcceptsGzip( $force = false ) {
1610  static $result = null;
1611  if ( $result === null || $force ) {
1612  $result = false;
1613  if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1614  # @todo FIXME: We may want to blacklist some broken browsers
1615  $m = [];
1616  if ( preg_match(
1617  '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1618  $_SERVER['HTTP_ACCEPT_ENCODING'],
1619  $m
1620  )
1621  ) {
1622  if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1623  $result = false;
1624  return $result;
1625  }
1626  wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1627  $result = true;
1628  }
1629  }
1630  }
1631  return $result;
1632 }
1633 
1643 function wfEscapeWikiText( $text ) {
1645  static $repl = null, $repl2 = null;
1646  if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1647  // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1648  // in those situations
1649  $repl = [
1650  '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1651  '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1652  '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1653  "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1654  "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1655  "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1656  "\n " => "\n&#32;", "\r " => "\r&#32;",
1657  "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1658  "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1659  "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1660  "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1661  '__' => '_&#95;', '://' => '&#58;//',
1662  ];
1663 
1664  $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1665  // We have to catch everything "\s" matches in PCRE
1666  foreach ( $magicLinks as $magic ) {
1667  $repl["$magic "] = "$magic&#32;";
1668  $repl["$magic\t"] = "$magic&#9;";
1669  $repl["$magic\r"] = "$magic&#13;";
1670  $repl["$magic\n"] = "$magic&#10;";
1671  $repl["$magic\f"] = "$magic&#12;";
1672  }
1673 
1674  // And handle protocols that don't use "://"
1676  $repl2 = [];
1677  foreach ( $wgUrlProtocols as $prot ) {
1678  if ( substr( $prot, -1 ) === ':' ) {
1679  $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1680  }
1681  }
1682  $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1683  }
1684  $text = substr( strtr( "\n$text", $repl ), 1 );
1685  $text = preg_replace( $repl2, '$1&#58;', $text );
1686  return $text;
1687 }
1688 
1699 function wfSetVar( &$dest, $source, $force = false ) {
1700  $temp = $dest;
1701  if ( !is_null( $source ) || $force ) {
1702  $dest = $source;
1703  }
1704  return $temp;
1705 }
1706 
1716 function wfSetBit( &$dest, $bit, $state = true ) {
1717  $temp = (bool)( $dest & $bit );
1718  if ( !is_null( $state ) ) {
1719  if ( $state ) {
1720  $dest |= $bit;
1721  } else {
1722  $dest &= ~$bit;
1723  }
1724  }
1725  return $temp;
1726 }
1727 
1734 function wfVarDump( $var ) {
1735  global $wgOut;
1736  $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1737  if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1738  print $s;
1739  } else {
1740  $wgOut->addHTML( $s );
1741  }
1742 }
1743 
1751 function wfHttpError( $code, $label, $desc ) {
1752  global $wgOut;
1754  if ( $wgOut ) {
1755  $wgOut->disable();
1756  $wgOut->sendCacheControl();
1757  }
1758 
1760  header( 'Content-type: text/html; charset=utf-8' );
1761  print '<!DOCTYPE html>' .
1762  '<html><head><title>' .
1763  htmlspecialchars( $label ) .
1764  '</title></head><body><h1>' .
1765  htmlspecialchars( $label ) .
1766  '</h1><p>' .
1767  nl2br( htmlspecialchars( $desc ) ) .
1768  "</p></body></html>\n";
1769 }
1770 
1788 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1789  if ( $resetGzipEncoding ) {
1790  // Suppress Content-Encoding and Content-Length
1791  // headers from OutputHandler::handle.
1794  }
1795  while ( $status = ob_get_status() ) {
1796  if ( isset( $status['flags'] ) ) {
1797  $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1798  $deleteable = ( $status['flags'] & $flags ) === $flags;
1799  } elseif ( isset( $status['del'] ) ) {
1800  $deleteable = $status['del'];
1801  } else {
1802  // Guess that any PHP-internal setting can't be removed.
1803  $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1804  }
1805  if ( !$deleteable ) {
1806  // Give up, and hope the result doesn't break
1807  // output behavior.
1808  break;
1809  }
1810  if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1811  // Unit testing barrier to prevent this function from breaking PHPUnit.
1812  break;
1813  }
1814  if ( !ob_end_clean() ) {
1815  // Could not remove output buffer handler; abort now
1816  // to avoid getting in some kind of infinite loop.
1817  break;
1818  }
1819  if ( $resetGzipEncoding ) {
1820  if ( $status['name'] == 'ob_gzhandler' ) {
1821  // Reset the 'Content-Encoding' field set by this handler
1822  // so we can start fresh.
1823  header_remove( 'Content-Encoding' );
1824  break;
1825  }
1826  }
1827  }
1828 }
1829 
1843  wfResetOutputBuffers( false );
1844 }
1845 
1854 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1855  # No arg means accept anything (per HTTP spec)
1856  if ( !$accept ) {
1857  return [ $def => 1.0 ];
1858  }
1859 
1860  $prefs = [];
1861 
1862  $parts = explode( ',', $accept );
1863 
1864  foreach ( $parts as $part ) {
1865  # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1866  $values = explode( ';', trim( $part ) );
1867  $match = [];
1868  if ( count( $values ) == 1 ) {
1869  $prefs[$values[0]] = 1.0;
1870  } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1871  $prefs[$values[0]] = floatval( $match[1] );
1872  }
1873  }
1874 
1875  return $prefs;
1876 }
1877 
1890 function mimeTypeMatch( $type, $avail ) {
1891  if ( array_key_exists( $type, $avail ) ) {
1892  return $type;
1893  } else {
1894  $mainType = explode( '/', $type )[0];
1895  if ( array_key_exists( "$mainType/*", $avail ) ) {
1896  return "$mainType/*";
1897  } elseif ( array_key_exists( '*/*', $avail ) ) {
1898  return '*/*';
1899  } else {
1900  return null;
1901  }
1902  }
1903 }
1904 
1918 function wfNegotiateType( $cprefs, $sprefs ) {
1919  $combine = [];
1920 
1921  foreach ( array_keys( $sprefs ) as $type ) {
1922  $subType = explode( '/', $type )[1];
1923  if ( $subType != '*' ) {
1924  $ckey = mimeTypeMatch( $type, $cprefs );
1925  if ( $ckey ) {
1926  $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1927  }
1928  }
1929  }
1930 
1931  foreach ( array_keys( $cprefs ) as $type ) {
1932  $subType = explode( '/', $type )[1];
1933  if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1934  $skey = mimeTypeMatch( $type, $sprefs );
1935  if ( $skey ) {
1936  $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1937  }
1938  }
1939  }
1940 
1941  $bestq = 0;
1942  $besttype = null;
1943 
1944  foreach ( array_keys( $combine ) as $type ) {
1945  if ( $combine[$type] > $bestq ) {
1946  $besttype = $type;
1947  $bestq = $combine[$type];
1948  }
1949  }
1950 
1951  return $besttype;
1952 }
1953 
1960 function wfSuppressWarnings( $end = false ) {
1961  Wikimedia\suppressWarnings( $end );
1962 }
1963 
1968 function wfRestoreWarnings() {
1969  Wikimedia\restoreWarnings();
1970 }
1971 
1980 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1981  $ret = MWTimestamp::convert( $outputtype, $ts );
1982  if ( $ret === false ) {
1983  wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1984  }
1985  return $ret;
1986 }
1987 
1996 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1997  if ( is_null( $ts ) ) {
1998  return null;
1999  } else {
2000  return wfTimestamp( $outputtype, $ts );
2001  }
2002 }
2003 
2009 function wfTimestampNow() {
2010  # return NOW
2011  return MWTimestamp::now( TS_MW );
2012 }
2013 
2019 function wfIsWindows() {
2020  static $isWindows = null;
2021  if ( $isWindows === null ) {
2022  $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
2023  }
2024  return $isWindows;
2025 }
2026 
2032 function wfIsHHVM() {
2033  return defined( 'HHVM_VERSION' );
2034 }
2035 
2042 function wfIsCLI() {
2043  return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
2044 }
2045 
2057 function wfTempDir() {
2059 
2060  if ( $wgTmpDirectory !== false ) {
2061  return $wgTmpDirectory;
2062  }
2063 
2065 }
2066 
2076 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2078 
2079  if ( FileBackend::isStoragePath( $dir ) ) { // sanity
2080  throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
2081  }
2082 
2083  if ( !is_null( $caller ) ) {
2084  wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2085  }
2086 
2087  if ( strval( $dir ) === '' || is_dir( $dir ) ) {
2088  return true;
2089  }
2090 
2091  $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
2092 
2093  if ( is_null( $mode ) ) {
2094  $mode = $wgDirectoryMode;
2095  }
2096 
2097  // Turn off the normal warning, we're doing our own below
2098  Wikimedia\suppressWarnings();
2099  $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2100  Wikimedia\restoreWarnings();
2101 
2102  if ( !$ok ) {
2103  // directory may have been created on another request since we last checked
2104  if ( is_dir( $dir ) ) {
2105  return true;
2106  }
2107 
2108  // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2109  wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2110  }
2111  return $ok;
2112 }
2113 
2119 function wfRecursiveRemoveDir( $dir ) {
2120  wfDebug( __FUNCTION__ . "( $dir )\n" );
2121  // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2122  if ( is_dir( $dir ) ) {
2123  $objects = scandir( $dir );
2124  foreach ( $objects as $object ) {
2125  if ( $object != "." && $object != ".." ) {
2126  if ( filetype( $dir . '/' . $object ) == "dir" ) {
2127  wfRecursiveRemoveDir( $dir . '/' . $object );
2128  } else {
2129  unlink( $dir . '/' . $object );
2130  }
2131  }
2132  }
2133  reset( $objects );
2134  rmdir( $dir );
2135  }
2136 }
2137 
2144 function wfPercent( $nr, $acc = 2, $round = true ) {
2145  $ret = sprintf( "%.${acc}f", $nr );
2146  return $round ? round( $ret, $acc ) . '%' : "$ret%";
2147 }
2148 
2172 function wfIniGetBool( $setting ) {
2173  return wfStringToBool( ini_get( $setting ) );
2174 }
2175 
2188 function wfStringToBool( $val ) {
2189  $val = strtolower( $val );
2190  // 'on' and 'true' can't have whitespace around them, but '1' can.
2191  return $val == 'on'
2192  || $val == 'true'
2193  || $val == 'yes'
2194  || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2195 }
2196 
2209 function wfEscapeShellArg( /*...*/ ) {
2210  $args = func_get_args();
2211 
2212  return call_user_func_array( Shell::class . '::escape', $args );
2213 }
2214 
2223  wfDeprecated( __FUNCTION__, '1.30' );
2224  return Shell::isDisabled() ? 'disabled' : false;
2225 }
2226 
2250 function wfShellExec( $cmd, &$retval = null, $environ = [],
2251  $limits = [], $options = []
2252 ) {
2253  if ( Shell::isDisabled() ) {
2254  $retval = 1;
2255  // Backwards compatibility be upon us...
2256  return 'Unable to run external programs, proc_open() is disabled.';
2257  }
2258 
2259  if ( is_array( $cmd ) ) {
2260  $cmd = Shell::escape( $cmd );
2261  }
2262 
2263  $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2264  $profileMethod = isset( $options['profileMethod'] ) ? $options['profileMethod'] : wfGetCaller();
2265 
2266  try {
2267  $result = Shell::command( [] )
2268  ->unsafeParams( (array)$cmd )
2269  ->environment( $environ )
2270  ->limits( $limits )
2271  ->includeStderr( $includeStderr )
2272  ->profileMethod( $profileMethod )
2273  // For b/c
2274  ->restrict( Shell::RESTRICT_NONE )
2275  ->execute();
2276  } catch ( ProcOpenError $ex ) {
2277  $retval = -1;
2278  return '';
2279  }
2280 
2281  $retval = $result->getExitCode();
2282 
2283  return $result->getStdout();
2284 }
2285 
2303 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2304  return wfShellExec( $cmd, $retval, $environ, $limits,
2305  [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2306 }
2307 
2316 function wfInitShellLocale() {
2317  wfDeprecated( __FUNCTION__, '1.30' );
2318 }
2319 
2334 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2335  global $wgPhpCli;
2336  // Give site config file a chance to run the script in a wrapper.
2337  // The caller may likely want to call wfBasename() on $script.
2338  Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2339  $cmd = isset( $options['php'] ) ? [ $options['php'] ] : [ $wgPhpCli ];
2340  if ( isset( $options['wrapper'] ) ) {
2341  $cmd[] = $options['wrapper'];
2342  }
2343  $cmd[] = $script;
2344  // Escape each parameter for shell
2345  return Shell::escape( array_merge( $cmd, $parameters ) );
2346 }
2347 
2359 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2360  global $wgDiff3;
2361 
2362  # This check may also protect against code injection in
2363  # case of broken installations.
2364  Wikimedia\suppressWarnings();
2365  $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2366  Wikimedia\restoreWarnings();
2367 
2368  if ( !$haveDiff3 ) {
2369  wfDebug( "diff3 not found\n" );
2370  return false;
2371  }
2372 
2373  # Make temporary files
2374  $td = wfTempDir();
2375  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2376  $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2377  $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2378 
2379  # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2380  # a newline character. To avoid this, we normalize the trailing whitespace before
2381  # creating the diff.
2382 
2383  fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2384  fclose( $oldtextFile );
2385  fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2386  fclose( $mytextFile );
2387  fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2388  fclose( $yourtextFile );
2389 
2390  # Check for a conflict
2391  $cmd = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2392  $oldtextName, $yourtextName );
2393  $handle = popen( $cmd, 'r' );
2394 
2395  $mergeAttemptResult = '';
2396  do {
2397  $data = fread( $handle, 8192 );
2398  if ( strlen( $data ) == 0 ) {
2399  break;
2400  }
2401  $mergeAttemptResult .= $data;
2402  } while ( true );
2403  pclose( $handle );
2404 
2405  $conflict = $mergeAttemptResult !== '';
2406 
2407  # Merge differences
2408  $cmd = Shell::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2409  $oldtextName, $yourtextName );
2410  $handle = popen( $cmd, 'r' );
2411  $result = '';
2412  do {
2413  $data = fread( $handle, 8192 );
2414  if ( strlen( $data ) == 0 ) {
2415  break;
2416  }
2417  $result .= $data;
2418  } while ( true );
2419  pclose( $handle );
2420  unlink( $mytextName );
2421  unlink( $oldtextName );
2422  unlink( $yourtextName );
2423 
2424  if ( $result === '' && $old !== '' && !$conflict ) {
2425  wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2426  $conflict = true;
2427  }
2428  return !$conflict;
2429 }
2430 
2442 function wfDiff( $before, $after, $params = '-u' ) {
2443  if ( $before == $after ) {
2444  return '';
2445  }
2446 
2447  global $wgDiff;
2448  Wikimedia\suppressWarnings();
2449  $haveDiff = $wgDiff && file_exists( $wgDiff );
2450  Wikimedia\restoreWarnings();
2451 
2452  # This check may also protect against code injection in
2453  # case of broken installations.
2454  if ( !$haveDiff ) {
2455  wfDebug( "diff executable not found\n" );
2456  $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2457  $format = new UnifiedDiffFormatter();
2458  return $format->format( $diffs );
2459  }
2460 
2461  # Make temporary files
2462  $td = wfTempDir();
2463  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2464  $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2465 
2466  fwrite( $oldtextFile, $before );
2467  fclose( $oldtextFile );
2468  fwrite( $newtextFile, $after );
2469  fclose( $newtextFile );
2470 
2471  // Get the diff of the two files
2472  $cmd = "$wgDiff " . $params . ' ' . Shell::escape( $oldtextName, $newtextName );
2473 
2474  $h = popen( $cmd, 'r' );
2475  if ( !$h ) {
2476  unlink( $oldtextName );
2477  unlink( $newtextName );
2478  throw new Exception( __METHOD__ . '(): popen() failed' );
2479  }
2480 
2481  $diff = '';
2482 
2483  do {
2484  $data = fread( $h, 8192 );
2485  if ( strlen( $data ) == 0 ) {
2486  break;
2487  }
2488  $diff .= $data;
2489  } while ( true );
2490 
2491  // Clean up
2492  pclose( $h );
2493  unlink( $oldtextName );
2494  unlink( $newtextName );
2495 
2496  // Kill the --- and +++ lines. They're not useful.
2497  $diff_lines = explode( "\n", $diff );
2498  if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2499  unset( $diff_lines[0] );
2500  }
2501  if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2502  unset( $diff_lines[1] );
2503  }
2504 
2505  $diff = implode( "\n", $diff_lines );
2506 
2507  return $diff;
2508 }
2509 
2528 function wfUsePHP( $req_ver ) {
2529  wfDeprecated( __FUNCTION__, '1.30' );
2530  $php_ver = PHP_VERSION;
2531 
2532  if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2533  throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2534  }
2535 }
2536 
2559 function wfUseMW( $req_ver ) {
2561 
2562  if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2563  throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2564  }
2565 }
2566 
2579 function wfBaseName( $path, $suffix = '' ) {
2580  if ( $suffix == '' ) {
2581  $encSuffix = '';
2582  } else {
2583  $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2584  }
2585 
2586  $matches = [];
2587  if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2588  return $matches[1];
2589  } else {
2590  return '';
2591  }
2592 }
2593 
2603 function wfRelativePath( $path, $from ) {
2604  // Normalize mixed input on Windows...
2605  $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2606  $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2607 
2608  // Trim trailing slashes -- fix for drive root
2609  $path = rtrim( $path, DIRECTORY_SEPARATOR );
2610  $from = rtrim( $from, DIRECTORY_SEPARATOR );
2611 
2612  $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2613  $against = explode( DIRECTORY_SEPARATOR, $from );
2614 
2615  if ( $pieces[0] !== $against[0] ) {
2616  // Non-matching Windows drive letters?
2617  // Return a full path.
2618  return $path;
2619  }
2620 
2621  // Trim off common prefix
2622  while ( count( $pieces ) && count( $against )
2623  && $pieces[0] == $against[0] ) {
2624  array_shift( $pieces );
2625  array_shift( $against );
2626  }
2627 
2628  // relative dots to bump us to the parent
2629  while ( count( $against ) ) {
2630  array_unshift( $pieces, '..' );
2631  array_shift( $against );
2632  }
2633 
2634  array_push( $pieces, wfBaseName( $path ) );
2635 
2636  return implode( DIRECTORY_SEPARATOR, $pieces );
2637 }
2638 
2645 function wfResetSessionID() {
2646  wfDeprecated( __FUNCTION__, '1.27' );
2647  $session = SessionManager::getGlobalSession();
2648  $delay = $session->delaySave();
2649 
2650  $session->resetId();
2651 
2652  // Make sure a session is started, since that's what the old
2653  // wfResetSessionID() did.
2654  if ( session_id() !== $session->getId() ) {
2655  wfSetupSession( $session->getId() );
2656  }
2657 
2658  ScopedCallback::consume( $delay );
2659 }
2660 
2670 function wfSetupSession( $sessionId = false ) {
2671  wfDeprecated( __FUNCTION__, '1.27' );
2672 
2673  if ( $sessionId ) {
2674  session_id( $sessionId );
2675  }
2676 
2677  $session = SessionManager::getGlobalSession();
2678  $session->persist();
2679 
2680  if ( session_id() !== $session->getId() ) {
2681  session_id( $session->getId() );
2682  }
2683  Wikimedia\quietCall( 'session_start' );
2684 }
2685 
2693  global $IP;
2694 
2695  $file = "$IP/serialized/$name";
2696  if ( file_exists( $file ) ) {
2697  $blob = file_get_contents( $file );
2698  if ( $blob ) {
2699  return unserialize( $blob );
2700  }
2701  }
2702  return false;
2703 }
2704 
2712 function wfMemcKey( /*...*/ ) {
2713  return call_user_func_array(
2714  [ ObjectCache::getLocalClusterInstance(), 'makeKey' ],
2715  func_get_args()
2716  );
2717 }
2718 
2729 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
2730  $args = array_slice( func_get_args(), 2 );
2731  $keyspace = $prefix ? "$db-$prefix" : $db;
2732  return call_user_func_array(
2733  [ ObjectCache::getLocalClusterInstance(), 'makeKeyInternal' ],
2734  [ $keyspace, $args ]
2735  );
2736 }
2737 
2750 function wfGlobalCacheKey( /*...*/ ) {
2751  return call_user_func_array(
2752  [ ObjectCache::getLocalClusterInstance(), 'makeGlobalKey' ],
2753  func_get_args()
2754  );
2755 }
2756 
2763 function wfWikiID() {
2765  if ( $wgDBprefix ) {
2766  return "$wgDBname-$wgDBprefix";
2767  } else {
2768  return $wgDBname;
2769  }
2770 }
2771 
2779 function wfSplitWikiID( $wiki ) {
2780  $bits = explode( '-', $wiki, 2 );
2781  if ( count( $bits ) < 2 ) {
2782  $bits[] = '';
2783  }
2784  return $bits;
2785 }
2786 
2812 function wfGetDB( $db, $groups = [], $wiki = false ) {
2813  return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2814 }
2815 
2825 function wfGetLB( $wiki = false ) {
2826  if ( $wiki === false ) {
2827  return MediaWikiServices::getInstance()->getDBLoadBalancer();
2828  } else {
2829  $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2830  return $factory->getMainLB( $wiki );
2831  }
2832 }
2833 
2841 function wfGetLBFactory() {
2842  return MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2843 }
2844 
2853 function wfFindFile( $title, $options = [] ) {
2854  return RepoGroup::singleton()->findFile( $title, $options );
2855 }
2856 
2864 function wfLocalFile( $title ) {
2865  return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
2866 }
2867 
2876  return $wgMiserMode
2877  || ( SiteStats::pages() > 100000
2878  && SiteStats::edits() > 1000000
2879  && SiteStats::users() > 10000 );
2880 }
2881 
2890 function wfScript( $script = 'index' ) {
2892  if ( $script === 'index' ) {
2893  return $wgScript;
2894  } elseif ( $script === 'load' ) {
2895  return $wgLoadScript;
2896  } else {
2897  return "{$wgScriptPath}/{$script}.php";
2898  }
2899 }
2900 
2906 function wfGetScriptUrl() {
2907  if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2908  /* as it was called, minus the query string.
2909  *
2910  * Some sites use Apache rewrite rules to handle subdomains,
2911  * and have PHP set up in a weird way that causes PHP_SELF
2912  * to contain the rewritten URL instead of the one that the
2913  * outside world sees.
2914  *
2915  * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2916  * provides containing the "before" URL.
2917  */
2918  return $_SERVER['SCRIPT_NAME'];
2919  } else {
2920  return $_SERVER['URL'];
2921  }
2922 }
2923 
2931 function wfBoolToStr( $value ) {
2932  return $value ? 'true' : 'false';
2933 }
2934 
2940 function wfGetNull() {
2941  return wfIsWindows() ? 'NUL' : '/dev/null';
2942 }
2943 
2967  $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2968 ) {
2969  if ( $timeout === null ) {
2970  $timeout = wfIsCLI() ? 60 : 10;
2971  }
2972 
2973  if ( $cluster === '*' ) {
2974  $cluster = false;
2975  $wiki = false;
2976  } elseif ( $wiki === false ) {
2977  $wiki = wfWikiID();
2978  }
2979 
2980  try {
2981  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2982  $lbFactory->waitForReplication( [
2983  'wiki' => $wiki,
2984  'cluster' => $cluster,
2985  'timeout' => $timeout,
2986  // B/C: first argument used to be "max seconds of lag"; ignore such values
2987  'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
2988  ] );
2989  } catch ( DBReplicationWaitError $e ) {
2990  return false;
2991  }
2992 
2993  return true;
2994 }
2995 
3005 function wfCountDown( $seconds ) {
3006  for ( $i = $seconds; $i >= 0; $i-- ) {
3007  if ( $i != $seconds ) {
3008  echo str_repeat( "\x08", strlen( $i + 1 ) );
3009  }
3010  echo $i;
3011  flush();
3012  if ( $i ) {
3013  sleep( 1 );
3014  }
3015  }
3016  echo "\n";
3017 }
3018 
3029  $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
3030  $name = preg_replace(
3031  "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
3032  '-',
3033  $name
3034  );
3035  // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
3036  $name = wfBaseName( $name );
3037  return $name;
3038 }
3039 
3045 function wfMemoryLimit() {
3047  $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3048  if ( $memlimit != -1 ) {
3049  $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3050  if ( $conflimit == -1 ) {
3051  wfDebug( "Removing PHP's memory limit\n" );
3052  Wikimedia\suppressWarnings();
3053  ini_set( 'memory_limit', $conflimit );
3054  Wikimedia\restoreWarnings();
3055  return $conflimit;
3056  } elseif ( $conflimit > $memlimit ) {
3057  wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3058  Wikimedia\suppressWarnings();
3059  ini_set( 'memory_limit', $conflimit );
3060  Wikimedia\restoreWarnings();
3061  return $conflimit;
3062  }
3063  }
3064  return $memlimit;
3065 }
3066 
3075 
3076  $timeLimit = ini_get( 'max_execution_time' );
3077  // Note that CLI scripts use 0
3078  if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3079  set_time_limit( $wgTransactionalTimeLimit );
3080  }
3081 
3082  ignore_user_abort( true ); // ignore client disconnects
3083 
3084  return $timeLimit;
3085 }
3086 
3094 function wfShorthandToInteger( $string = '', $default = -1 ) {
3095  $string = trim( $string );
3096  if ( $string === '' ) {
3097  return $default;
3098  }
3099  $last = $string[strlen( $string ) - 1];
3100  $val = intval( $string );
3101  switch ( $last ) {
3102  case 'g':
3103  case 'G':
3104  $val *= 1024;
3105  // break intentionally missing
3106  case 'm':
3107  case 'M':
3108  $val *= 1024;
3109  // break intentionally missing
3110  case 'k':
3111  case 'K':
3112  $val *= 1024;
3113  }
3114 
3115  return $val;
3116 }
3117 
3128 function wfBCP47( $code ) {
3129  return LanguageCode::bcp47( $code );
3130 }
3131 
3138 function wfGetCache( $cacheType ) {
3139  return ObjectCache::getInstance( $cacheType );
3140 }
3141 
3147 function wfGetMainCache() {
3150 }
3151 
3160 }
3161 
3171 }
3172 
3183 function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3184  wfDeprecated( __METHOD__, '1.25' );
3185  return Hooks::run( $event, $args, $deprecatedVersion );
3186 }
3187 
3202 function wfUnpack( $format, $data, $length = false ) {
3203  if ( $length !== false ) {
3204  $realLen = strlen( $data );
3205  if ( $realLen < $length ) {
3206  throw new MWException( "Tried to use wfUnpack on a "
3207  . "string of length $realLen, but needed one "
3208  . "of at least length $length."
3209  );
3210  }
3211  }
3212 
3213  Wikimedia\suppressWarnings();
3214  $result = unpack( $format, $data );
3215  Wikimedia\restoreWarnings();
3216 
3217  if ( $result === false ) {
3218  // If it cannot extract the packed data.
3219  throw new MWException( "unpack could not unpack binary data" );
3220  }
3221  return $result;
3222 }
3223 
3238 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3239  # Handle redirects; callers almost always hit wfFindFile() anyway,
3240  # so just use that method because it has a fast process cache.
3241  $file = wfFindFile( $name ); // get the final name
3242  $name = $file ? $file->getTitle()->getDBkey() : $name;
3243 
3244  # Run the extension hook
3245  $bad = false;
3246  if ( !Hooks::run( 'BadImage', [ $name, &$bad ] ) ) {
3247  return (bool)$bad;
3248  }
3249 
3251  $key = $cache->makeKey(
3252  'bad-image-list', ( $blacklist === null ) ? 'default' : md5( $blacklist )
3253  );
3254  $badImages = $cache->get( $key );
3255 
3256  if ( $badImages === false ) { // cache miss
3257  if ( $blacklist === null ) {
3258  $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3259  }
3260  # Build the list now
3261  $badImages = [];
3262  $lines = explode( "\n", $blacklist );
3263  foreach ( $lines as $line ) {
3264  # List items only
3265  if ( substr( $line, 0, 1 ) !== '*' ) {
3266  continue;
3267  }
3268 
3269  # Find all links
3270  $m = [];
3271  if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3272  continue;
3273  }
3274 
3275  $exceptions = [];
3276  $imageDBkey = false;
3277  foreach ( $m[1] as $i => $titleText ) {
3278  $title = Title::newFromText( $titleText );
3279  if ( !is_null( $title ) ) {
3280  if ( $i == 0 ) {
3281  $imageDBkey = $title->getDBkey();
3282  } else {
3283  $exceptions[$title->getPrefixedDBkey()] = true;
3284  }
3285  }
3286  }
3287 
3288  if ( $imageDBkey !== false ) {
3289  $badImages[$imageDBkey] = $exceptions;
3290  }
3291  }
3292  $cache->set( $key, $badImages, 60 );
3293  }
3294 
3295  $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
3296  $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3297 
3298  return $bad;
3299 }
3300 
3308 function wfCanIPUseHTTPS( $ip ) {
3309  $canDo = true;
3310  Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3311  return !!$canDo;
3312 }
3313 
3321 function wfIsInfinity( $str ) {
3322  // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3323  $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3324  return in_array( $str, $infinityValues );
3325 }
3326 
3341 function wfThumbIsStandard( File $file, array $params ) {
3343 
3344  $multipliers = [ 1 ];
3345  if ( $wgResponsiveImages ) {
3346  // These available sizes are hardcoded currently elsewhere in MediaWiki.
3347  // @see Linker::processResponsiveImages
3348  $multipliers[] = 1.5;
3349  $multipliers[] = 2;
3350  }
3351 
3352  $handler = $file->getHandler();
3353  if ( !$handler || !isset( $params['width'] ) ) {
3354  return false;
3355  }
3356 
3357  $basicParams = [];
3358  if ( isset( $params['page'] ) ) {
3359  $basicParams['page'] = $params['page'];
3360  }
3361 
3362  $thumbLimits = [];
3363  $imageLimits = [];
3364  // Expand limits to account for multipliers
3365  foreach ( $multipliers as $multiplier ) {
3366  $thumbLimits = array_merge( $thumbLimits, array_map(
3367  function ( $width ) use ( $multiplier ) {
3368  return round( $width * $multiplier );
3369  }, $wgThumbLimits )
3370  );
3371  $imageLimits = array_merge( $imageLimits, array_map(
3372  function ( $pair ) use ( $multiplier ) {
3373  return [
3374  round( $pair[0] * $multiplier ),
3375  round( $pair[1] * $multiplier ),
3376  ];
3377  }, $wgImageLimits )
3378  );
3379  }
3380 
3381  // Check if the width matches one of $wgThumbLimits
3382  if ( in_array( $params['width'], $thumbLimits ) ) {
3383  $normalParams = $basicParams + [ 'width' => $params['width'] ];
3384  // Append any default values to the map (e.g. "lossy", "lossless", ...)
3385  $handler->normaliseParams( $file, $normalParams );
3386  } else {
3387  // If not, then check if the width matchs one of $wgImageLimits
3388  $match = false;
3389  foreach ( $imageLimits as $pair ) {
3390  $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3391  // Decide whether the thumbnail should be scaled on width or height.
3392  // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3393  $handler->normaliseParams( $file, $normalParams );
3394  // Check if this standard thumbnail size maps to the given width
3395  if ( $normalParams['width'] == $params['width'] ) {
3396  $match = true;
3397  break;
3398  }
3399  }
3400  if ( !$match ) {
3401  return false; // not standard for description pages
3402  }
3403  }
3404 
3405  // Check that the given values for non-page, non-width, params are just defaults
3406  foreach ( $params as $key => $value ) {
3407  if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3408  return false;
3409  }
3410  }
3411 
3412  return true;
3413 }
3414 
3427 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3428  // First merge items that are in both arrays
3429  foreach ( $baseArray as $name => &$groupVal ) {
3430  if ( isset( $newValues[$name] ) ) {
3431  $groupVal += $newValues[$name];
3432  }
3433  }
3434  // Now add items that didn't exist yet
3435  $baseArray += $newValues;
3436 
3437  return $baseArray;
3438 }
3439 
3448 function wfGetRusage() {
3449  if ( !function_exists( 'getrusage' ) ) {
3450  return false;
3451  } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS === 'Linux' ) {
3452  return getrusage( 2 /* RUSAGE_THREAD */ );
3453  } else {
3454  return getrusage( 0 /* RUSAGE_SELF */ );
3455  }
3456 }
wfMessage
wfMessage( $key)
This is the function for getting translated interface messages.
Definition: GlobalFunctions.php:1355
$user
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 account $user
Definition: hooks.txt:247
$wgPhpCli
$wgPhpCli
Executable path of the PHP cli binary.
Definition: DefaultSettings.php:8301
wfUseMW
wfUseMW( $req_ver)
This function works like "use VERSION" in Perl except it checks the version of MediaWiki,...
Definition: GlobalFunctions.php:2559
wfArrayInsertAfter
wfArrayInsertAfter(array $array, array $insert, $after)
Insert array into another array after the specified KEY
Definition: GlobalFunctions.php:238
MediaWiki\Shell\Shell
Executes shell commands.
Definition: Shell.php:44
$handler
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:903
Title\newFromText
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
wfPercent
wfPercent( $nr, $acc=2, $round=true)
Definition: GlobalFunctions.php:2144
wfResetOutputBuffers
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
Definition: GlobalFunctions.php:1788
$wgThumbLimits
$wgThumbLimits
Adjust thumbnails on image pages according to a user setting.
Definition: DefaultSettings.php:1397
PROTO_CANONICAL
const PROTO_CANONICAL
Definition: Defines.php:233
wfBCP47
wfBCP47( $code)
Get the normalised IETF language tag See unit test for examples.
Definition: GlobalFunctions.php:3128
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
wfCanIPUseHTTPS
wfCanIPUseHTTPS( $ip)
Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS.
Definition: GlobalFunctions.php:3308
wfMergeErrorArrays
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
Definition: GlobalFunctions.php:211
ObjectCache\getLocalClusterInstance
static getLocalClusterInstance()
Get the main cluster-local cache object.
Definition: ObjectCache.php:367
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
SiteStats\users
static users()
Definition: SiteStats.php:121
MediaWiki\emitBufferedStatsdData
static emitBufferedStatsdData(IBufferingStatsdDataFactory $stats, Config $config)
Send out any buffered statsd data according to sampling rules.
Definition: MediaWiki.php:977
PROTO_INTERNAL
const PROTO_INTERNAL
Definition: Defines.php:234
MediaWiki\ProcOpenError
Definition: ProcOpenError.php:25
wfDiff
wfDiff( $before, $after, $params='-u')
Returns unified plain-text diff of two texts.
Definition: GlobalFunctions.php:2442
$wgResponsiveImages
$wgResponsiveImages
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
Definition: DefaultSettings.php:1520
wfSetupSession
wfSetupSession( $sessionId=false)
Initialise php session.
Definition: GlobalFunctions.php:2670
$wgDebugRawPage
$wgDebugRawPage
If true, log debugging data from action=raw and load.php.
Definition: DefaultSettings.php:6136
wfThumbIsStandard
wfThumbIsStandard(File $file, array $params)
Returns true if these thumbnail parameters match one that MediaWiki requests from file description pa...
Definition: GlobalFunctions.php:3341
$wgTmpDirectory
$wgTmpDirectory
The local filesystem path to a temporary directory.
Definition: DefaultSettings.php:359
wfArrayPlus2d
wfArrayPlus2d(array $baseArray, array $newValues)
Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
Definition: GlobalFunctions.php:3427
Profiler\instance
static instance()
Singleton.
Definition: Profiler.php:62
array
the array() calling protocol came about after MediaWiki 1.4rc1.
wfMkdirParents
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
Definition: GlobalFunctions.php:2076
wfArrayFilter
wfArrayFilter(array $arr, callable $callback)
Like array_filter with ARRAY_FILTER_USE_BOTH, but works pre-5.6.
Definition: GlobalFunctions.php:150
$output
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2255
$wgDiff3
$wgDiff3
Path to the GNU diff3 utility.
Definition: DefaultSettings.php:6610
wfMerge
wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult=null)
wfMerge attempts to merge differences between three texts.
Definition: GlobalFunctions.php:2359
wfDebugBacktrace
wfDebugBacktrace( $limit=0)
Safety wrapper for debug_backtrace().
Definition: GlobalFunctions.php:1482
wfSetVar
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
Definition: GlobalFunctions.php:1699
wfGetLB
wfGetLB( $wiki=false)
Get a load balancer object.
Definition: GlobalFunctions.php:2825
wfFormatStackFrame
wfFormatStackFrame( $frame)
Return a string representation of frame.
Definition: GlobalFunctions.php:1578
$last
$last
Definition: profileinfo.php:408
wfRemoveDotSegments
wfRemoveDotSegments( $urlPath)
Remove all dot-segments in the provided URL path.
Definition: GlobalFunctions.php:649
$wgScript
$wgScript
The URL path to index.php.
Definition: DefaultSettings.php:206
wfSetBit
wfSetBit(&$dest, $bit, $state=true)
As for wfSetVar except setting a bit.
Definition: GlobalFunctions.php:1716
wfNegotiateType
wfNegotiateType( $cprefs, $sprefs)
Returns the 'best' match between a client's requested internet media types and the server's list of a...
Definition: GlobalFunctions.php:1918
wfMakeUrlIndexes
wfMakeUrlIndexes( $url)
Make URL indexes, appropriate for the el_index field of externallinks.
Definition: GlobalFunctions.php:906
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
$wgVersion
$wgVersion
MediaWiki version number.
Definition: DefaultSettings.php:75
Wikimedia\Rdbms\DBReplicationWaitError
Exception class for replica DB wait timeouts.
Definition: DBReplicationWaitError.php:28
$ret
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:2005
SiteStats\pages
static pages()
Definition: SiteStats.php:112
wfUnpack
wfUnpack( $format, $data, $length=false)
Wrapper around php's unpack.
Definition: GlobalFunctions.php:3202
wfConfiguredReadOnlyReason
wfConfiguredReadOnlyReason()
Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
Definition: GlobalFunctions.php:1286
MessageSpecifier
Definition: MessageSpecifier.php:21
$wgShowHostnames
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
Definition: DefaultSettings.php:6330
wfObjectToArray
wfObjectToArray( $objOrArray, $recursive=true)
Recursively converts the parameter (an object) to an array with the same data.
Definition: GlobalFunctions.php:261
wfSuppressWarnings
wfSuppressWarnings( $end=false)
Reference-counted warning suppression.
Definition: GlobalFunctions.php:1960
wfUrlencode
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness,...
Definition: GlobalFunctions.php:340
wfArrayDiff2_cmp
wfArrayDiff2_cmp( $a, $b)
Definition: GlobalFunctions.php:120
wfGetScriptUrl
wfGetScriptUrl()
Get the script URL.
Definition: GlobalFunctions.php:2906
$wgMessageCacheType
$wgMessageCacheType
The cache type for storing the contents of the MediaWiki namespace.
Definition: DefaultSettings.php:2279
$out
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:864
ProfilerStub
Stub profiler that does nothing.
Definition: ProfilerStub.php:29
$wgDiff
$wgDiff
Path to the GNU diff utility.
Definition: DefaultSettings.php:6615
wfBaseName
wfBaseName( $path, $suffix='')
Return the final portion of a pathname.
Definition: GlobalFunctions.php:2579
wfQueriesMustScale
wfQueriesMustScale()
Should low-performance queries be disabled?
Definition: GlobalFunctions.php:2874
unserialize
unserialize( $serialized)
Definition: ApiMessage.php:192
$params
$params
Definition: styleTest.css.php:40
wfHostname
wfHostname()
Fetch server name for use in error reporting etc.
Definition: GlobalFunctions.php:1420
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1262
wfMsgReplaceArgs
wfMsgReplaceArgs( $message, $args)
Replace message parameter keys on the given formatted output.
Definition: GlobalFunctions.php:1393
wfUsePHP
wfUsePHP( $req_ver)
This function works like "use VERSION" in Perl, the program will die with a backtrace if the current ...
Definition: GlobalFunctions.php:2528
wfSplitWikiID
wfSplitWikiID( $wiki)
Split a wiki ID into DB name and table prefix.
Definition: GlobalFunctions.php:2779
$s
$s
Definition: mergeMessageFileList.php:187
wfLogWarning
wfLogWarning( $msg, $callerOffset=1, $level=E_USER_WARNING)
Send a warning as a PHP error and the debug log.
Definition: GlobalFunctions.php:1150
wfStringToBool
wfStringToBool( $val)
Convert string value to boolean, when the following are interpreted as true:
Definition: GlobalFunctions.php:2188
wfArrayFilterByKey
wfArrayFilterByKey(array $arr, callable $callback)
Like array_filter with ARRAY_FILTER_USE_KEY, but works pre-5.6.
Definition: GlobalFunctions.php:168
$wgTransactionalTimeLimit
$wgTransactionalTimeLimit
The minimum amount of time that MediaWiki needs for "slow" write request, particularly ones with mult...
Definition: DefaultSettings.php:2235
$wgDebugLogPrefix
$wgDebugLogPrefix
Prefix for debug log lines.
Definition: DefaultSettings.php:6122
$result
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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! 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! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
wfExpandIRI
wfExpandIRI( $url)
Take a URL, make sure it's expanded to fully qualified, and replace any encoded non-ASCII Unicode cha...
Definition: GlobalFunctions.php:883
wfMessageFallback
wfMessageFallback()
This function accepts multiple message keys and returns a message instance for the first message whic...
Definition: GlobalFunctions.php:1380
wfWaitForSlaves
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Definition: GlobalFunctions.php:2966
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1087
$wgDBprefix
$wgDBprefix
Table name prefix.
Definition: DefaultSettings.php:1871
wfShellWikiCmd
wfShellWikiCmd( $script, array $parameters=[], array $options=[])
Generate a shell-escaped command line string to run a MediaWiki cli script.
Definition: GlobalFunctions.php:2334
php
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:37
wfBoolToStr
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
Definition: GlobalFunctions.php:2931
wfAppendQuery
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Definition: GlobalFunctions.php:469
key
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:26
ExtensionRegistry\getInstance
static getInstance()
Definition: ExtensionRegistry.php:88
wfParseUrl
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Definition: GlobalFunctions.php:801
File
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:51
wfGetMainCache
wfGetMainCache()
Get the main cache object.
Definition: GlobalFunctions.php:3147
MWException
MediaWiki exception.
Definition: MWException.php:26
wfStripIllegalFilenameChars
wfStripIllegalFilenameChars( $name)
Replace all invalid characters with '-'.
Definition: GlobalFunctions.php:3027
wfMemcKey
wfMemcKey()
Make a cache key for the local wiki.
Definition: GlobalFunctions.php:2712
wfGetRusage
wfGetRusage()
Get system resource usage of current request context.
Definition: GlobalFunctions.php:3448
mimeTypeMatch
mimeTypeMatch( $type, $avail)
Checks if a given MIME type matches any of the keys in the given array.
Definition: GlobalFunctions.php:1890
wfGlobalCacheKey
wfGlobalCacheKey()
Make a cache key with database-agnostic prefix.
Definition: GlobalFunctions.php:2750
$wgDBname
controlled by $wgMainCacheType controlled by $wgParserCacheType controlled by $wgMessageCacheType If you set CACHE_NONE to one of the three control default value for MediaWiki still create a but requests to it are no ops and we always fall through to the database If the cache daemon can t be it should also disable itself fairly smoothly By $wgMemc is used but when it is $parserMemc or $messageMemc this is mentioned $wgDBname
Definition: memcached.txt:138
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1123
wfRestoreWarnings
wfRestoreWarnings()
Definition: GlobalFunctions.php:1968
Language\fetchLanguageNames
static fetchLanguageNames( $inLanguage=null, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:803
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2890
wfArrayDiff2
wfArrayDiff2( $a, $b)
Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
Definition: GlobalFunctions.php:111
wfIncrStats
wfIncrStats( $key, $count=1)
Increment a statistics counter.
Definition: GlobalFunctions.php:1252
FileBackend\isStoragePath
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
Definition: FileBackend.php:1435
$blob
$blob
Definition: testCompression.php:65
wfTransactionalTimeLimit
wfTransactionalTimeLimit()
Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit.
Definition: GlobalFunctions.php:3073
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
wfShellExecDisabled
wfShellExecDisabled()
Check if wfShellExec() is effectively disabled via php.ini config.
Definition: GlobalFunctions.php:2222
wfUrlProtocolsWithoutProtRel
wfUrlProtocolsWithoutProtRel()
Like wfUrlProtocols(), but excludes '//' from the protocol list.
Definition: GlobalFunctions.php:772
$wgCommandLineMode
global $wgCommandLineMode
Definition: DevelopmentSettings.php:28
$matches
$matches
Definition: NoLocalSettings.php:24
$wgDebugLogGroups
$wgDebugLogGroups
Map of string log group names to log destinations.
Definition: DefaultSettings.php:6241
$wgLoadScript
$wgLoadScript
The URL path to load.php.
Definition: DefaultSettings.php:214
wfTimestampOrNull
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
Definition: GlobalFunctions.php:1996
PROTO_CURRENT
const PROTO_CURRENT
Definition: Defines.php:232
ObjectCache\getInstance
static getInstance( $id)
Get a cached instance of the specified type of cache object.
Definition: ObjectCache.php:92
wfGetLangObj
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
Definition: GlobalFunctions.php:1306
wfCgiToArray
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
Definition: GlobalFunctions.php:422
$lines
$lines
Definition: router.php:61
wfLoadSkins
wfLoadSkins(array $skins)
Load multiple skins at once.
Definition: GlobalFunctions.php:97
$wgLang
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
$wgParserCacheType
$wgParserCacheType
The cache type for storing article HTML.
Definition: DefaultSettings.php:2287
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
MWDebug\deprecated
static deprecated( $function, $version=false, $component=false, $callerOffset=2)
Show a warning that $function is deprecated.
Definition: MWDebug.php:193
wfGetCache
wfGetCache( $cacheType)
Get a specific cache object.
Definition: GlobalFunctions.php:3138
$wgEnableMagicLinks
$wgEnableMagicLinks
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links.
Definition: DefaultSettings.php:4423
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
wfTimestampNow
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
Definition: GlobalFunctions.php:2009
wfMemoryLimit
wfMemoryLimit()
Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit.
Definition: GlobalFunctions.php:3045
wfForeignMemcKey
wfForeignMemcKey( $db, $prefix)
Make a cache key for a foreign DB.
Definition: GlobalFunctions.php:2729
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
wfAcceptToPrefs
wfAcceptToPrefs( $accept, $def=' */*')
Converts an Accept-* header into an array mapping string values to quality factors.
Definition: GlobalFunctions.php:1854
list
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
wfExpandIRI_callback
wfExpandIRI_callback( $matches)
Private callback for wfExpandIRI.
Definition: GlobalFunctions.php:896
PROTO_HTTPS
const PROTO_HTTPS
Definition: Defines.php:230
$wgCanonicalServer
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
Definition: DefaultSettings.php:115
$wgMemoryLimit
$wgMemoryLimit
The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit i...
Definition: DefaultSettings.php:2227
wfIsDebugRawPage
wfIsDebugRawPage()
Returns true if debug logging should be suppressed if $wgDebugRawPage = false.
Definition: GlobalFunctions.php:1028
UnifiedDiffFormatter
A formatter that outputs unified diffs.
Definition: UnifiedDiffFormatter.php:31
$options
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:2001
$wgDebugTimestamps
$wgDebugTimestamps
Prefix debug messages with relative timestamp.
Definition: DefaultSettings.php:6279
wfErrorLog
wfErrorLog( $text, $file, array $context=[])
Log to a file without getting "file size exceeded" signals.
Definition: GlobalFunctions.php:1167
wfUrlProtocols
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
Definition: GlobalFunctions.php:727
$line
$line
Definition: cdb.php:59
wfIsBadImage
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the 'bad image list'.
Definition: GlobalFunctions.php:3238
wfLoadExtensions
wfLoadExtensions(array $exts)
Load multiple extensions at once.
Definition: GlobalFunctions.php:66
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2763
wfClearOutputBuffers
wfClearOutputBuffers()
More legible than passing a 'false' parameter to wfResetOutputBuffers():
Definition: GlobalFunctions.php:1842
$value
$value
Definition: styleTest.css.php:45
wfClientAcceptsGzip
wfClientAcceptsGzip( $force=false)
Whether the client accept gzip encoding.
Definition: GlobalFunctions.php:1609
$wgUrlProtocols
$wgUrlProtocols
URL schemes that should be recognized as valid by wfParseUrl().
Definition: DefaultSettings.php:4220
$wgExtensionDirectory
$wgExtensionDirectory
Filesystem extensions directory.
Definition: DefaultSettings.php:243
wfIsCLI
wfIsCLI()
Check if we are running from the commandline.
Definition: GlobalFunctions.php:2042
wfIsWindows
wfIsWindows()
Check if the operating system is Windows.
Definition: GlobalFunctions.php:2019
$wgServer
$wgServer
URL of the server.
Definition: DefaultSettings.php:106
wfEscapeShellArg
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
Definition: GlobalFunctions.php:2209
MediaWiki\Session\SessionManager
This serves as the entry point to the MediaWiki session handling system.
Definition: SessionManager.php:50
$wgLanguageCode
$wgLanguageCode
Site language code.
Definition: DefaultSettings.php:2887
wfIsInfinity
wfIsInfinity( $str)
Determine input string is represents as infinity.
Definition: GlobalFunctions.php:3321
wfDebugMem
wfDebugMem( $exact=false)
Send a line giving PHP memory usage.
Definition: GlobalFunctions.php:1052
wfInitShellLocale
wfInitShellLocale()
Formerly set the locale for locale-sensitive operations.
Definition: GlobalFunctions.php:2316
PROTO_HTTP
const PROTO_HTTP
Definition: Defines.php:229
$wgDirectoryMode
$wgDirectoryMode
Default value for chmoding of new directories.
Definition: DefaultSettings.php:1508
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
Skin\makeVariablesScript
static makeVariablesScript( $data)
Definition: Skin.php:382
wfAppendToArrayIfNotDefault
wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed)
Appends to second array if $value differs from that in $default.
Definition: GlobalFunctions.php:183
$wgDisableOutputCompression
$wgDisableOutputCompression
Disable output compression (enabled by default if zlib is available)
Definition: DefaultSettings.php:3374
wfVarDump
wfVarDump( $var)
A wrapper around the PHP function var_export().
Definition: GlobalFunctions.php:1734
$wgIllegalFileChars
$wgIllegalFileChars
Additional characters that are not allowed in filenames.
Definition: DefaultSettings.php:432
wfGetParserCacheStorage
wfGetParserCacheStorage()
Get the cache object used by the parser cache.
Definition: GlobalFunctions.php:3168
$status
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. '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:1255
wfGetNull
wfGetNull()
Get a platform-independent path to the null file, e.g.
Definition: GlobalFunctions.php:2940
TempFSFile\getUsableTempDirectory
static getUsableTempDirectory()
Definition: TempFSFile.php:85
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:434
wfGetLBFactory
wfGetLBFactory()
Get the load balancer factory object.
Definition: GlobalFunctions.php:2841
wfIniGetBool
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
Definition: GlobalFunctions.php:2172
$wgOverrideHostname
$wgOverrideHostname
Override server hostname detection with a hardcoded value.
Definition: DefaultSettings.php:6337
wfFindFile
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:2853
wfReportTime
wfReportTime()
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
Definition: GlobalFunctions.php:1459
wfGetAllCallers
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
Definition: GlobalFunctions.php:1563
wfLoadExtension
wfLoadExtension( $ext, $path=null)
Load an extension.
Definition: GlobalFunctions.php:45
$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 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:2011
wfRunHooks
wfRunHooks( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in $wgHooks.
Definition: GlobalFunctions.php:3183
wfGetMessageCacheStorage
wfGetMessageCacheStorage()
Get the cache object used by the message cache.
Definition: GlobalFunctions.php:3157
$args
if( $line===false) $args
Definition: cdb.php:64
wfLoadSkin
wfLoadSkin( $skin, $path=null)
Load a skin.
Definition: GlobalFunctions.php:82
wfShorthandToInteger
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
Definition: GlobalFunctions.php:3094
$wgImageLimits
$wgImageLimits
Limit images on image description pages to a user-selectable limit.
Definition: DefaultSettings.php:1384
print
print
Definition: opensearch_desc.php:46
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
wfRandom
wfRandom()
Get a random decimal value between 0 and 1, in a way not likely to give duplicate values for any real...
Definition: GlobalFunctions.php:287
wfTempDir
wfTempDir()
Tries to get the system directory for temporary files.
Definition: GlobalFunctions.php:2057
$wgMiserMode
$wgMiserMode
Disable database-intensive features.
Definition: DefaultSettings.php:2191
wfHttpError
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
Definition: GlobalFunctions.php:1751
wfReadOnlyReason
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
Definition: GlobalFunctions.php:1275
wfMatchesDomainList
wfMatchesDomainList( $url, $domains)
Check whether a given URL has a domain that occurs in a given set of domains.
Definition: GlobalFunctions.php:960
$cache
$cache
Definition: mcc.php:33
HttpStatus\header
static header( $code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
$code
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:865
wfGetPrecompiledData
wfGetPrecompiledData( $name)
Get an object from the precompiled serialized directory.
Definition: GlobalFunctions.php:2692
wfRecursiveRemoveDir
wfRecursiveRemoveDir( $dir)
Remove a directory and all its content.
Definition: GlobalFunctions.php:2119
$wgHttpsPort
$wgHttpsPort
Port where you have HTTPS running Supports HTTPS on non-standard ports.
Definition: DefaultSettings.php:8621
$path
$path
Definition: NoLocalSettings.php:25
$wgMainCacheType
CACHE_MEMCACHED $wgMainCacheType
Definition: memcached.txt:63
as
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:22
LanguageCode\bcp47
static bcp47( $code)
Get the normalised IETF language tag See unit test for examples.
Definition: LanguageCode.php:94
Message
The Message class provides methods which fulfil two basic services:
Definition: Message.php:159
$keys
$keys
Definition: testCompression.php:67
wfBacktrace
wfBacktrace( $raw=null)
Get a debug backtrace as a string.
Definition: GlobalFunctions.php:1510
LoggerFactory
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
$source
$source
Definition: mwdoc-filter.php:46
wfAssembleUrl
wfAssembleUrl( $urlParts)
This function will reassemble a URL parsed with wfParseURL.
Definition: GlobalFunctions.php:597
wfRelativePath
wfRelativePath( $path, $from)
Generate a relative path name to the given file.
Definition: GlobalFunctions.php:2603
Language\factory
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:183
wfWarn
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Definition: GlobalFunctions.php:1137
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
Title\legalChars
static legalChars()
Get a regex character class describing the legal characters in a link.
Definition: Title.php:623
$request
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:2806
$wgRequest
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:737
MediaWikiServices
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:25
MWDebug\warning
static warning( $msg, $callerOffset=1, $level=E_USER_NOTICE, $log='auto')
Adds a warning entry to the log.
Definition: MWDebug.php:151
File\getHandler
getHandler()
Get a MediaHandler instance for this file.
Definition: File.php:1383
$wgOut
$wgOut
Definition: Setup.php:912
$query
null for the 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:1620
wfIsHHVM
wfIsHHVM()
Check if we are running under HHVM.
Definition: GlobalFunctions.php:2032
$wgScriptPath
$wgScriptPath
The path we should point to.
Definition: DefaultSettings.php:158
$IP
$IP
Definition: WebStart.php:52
wfLocalFile
wfLocalFile( $title)
Get an object referring to a locally registered file.
Definition: GlobalFunctions.php:2864
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
$ext
$ext
Definition: router.php:55
wfShowingResults
wfShowingResults( $offset, $limit)
Definition: GlobalFunctions.php:1596
wfResetSessionID
wfResetSessionID()
Reset the session id.
Definition: GlobalFunctions.php:2645
$retval
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 account incomplete not yet checked for validity & $retval
Definition: hooks.txt:266
wfGetCaller
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
Definition: GlobalFunctions.php:1547
$wgStyleDirectory
$wgStyleDirectory
Filesystem stylesheets directory.
Definition: DefaultSettings.php:250
$context
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:2811
wfLogDBError
wfLogDBError( $text, array $context=[])
Log for database errors.
Definition: GlobalFunctions.php:1105
SiteStats\edits
static edits()
Definition: SiteStats.php:94
$wgInternalServer
$wgInternalServer
Internal server name as known to CDN, if different.
Definition: DefaultSettings.php:2713
wfCountDown
wfCountDown( $seconds)
Count down from $seconds to zero on the terminal, with a one-second pause between showing each number...
Definition: GlobalFunctions.php:3005
wfExpandUrl
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:521
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
wfShellExecWithStderr
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
Definition: GlobalFunctions.php:2303
MediaWiki\HeaderCallback\warnIfHeadersSent
static warnIfHeadersSent()
Log a warning message if headers have already been sent.
Definition: HeaderCallback.php:57
wfLogProfilingData
wfLogProfilingData()
Definition: GlobalFunctions.php:1178
ObjectCache\getLocalServerInstance
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
Definition: ObjectCache.php:288
$wgContLang
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 and the content language as $wgContLang
Definition: design.txt:57
Diff
Class representing a 'diff' between two sequences of strings.
Definition: DairikiDiff.php:200
wfShellExec
wfShellExec( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
Definition: GlobalFunctions.php:2250
wfArrayToCgi
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
Definition: GlobalFunctions.php:377
wfRandomString
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
Definition: GlobalFunctions.php:305
$type
$type
Definition: testCompression.php:48