MediaWiki  master
GlobalFunctions.php
Go to the documentation of this file.
1 <?php
23 if ( !defined( 'MEDIAWIKI' ) ) {
24  die( "This file is part of MediaWiki, it is not a valid entry point" );
25 }
26 
35 
46 function wfLoadExtension( $ext, $path = null ) {
47  if ( !$path ) {
48  global $wgExtensionDirectory;
49  $path = "$wgExtensionDirectory/$ext/extension.json";
50  }
52 }
53 
67 function wfLoadExtensions( array $exts ) {
68  global $wgExtensionDirectory;
69  $registry = ExtensionRegistry::getInstance();
70  foreach ( $exts as $ext ) {
71  $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
72  }
73 }
74 
83 function wfLoadSkin( $skin, $path = null ) {
84  if ( !$path ) {
85  global $wgStyleDirectory;
86  $path = "$wgStyleDirectory/$skin/skin.json";
87  }
89 }
90 
98 function wfLoadSkins( array $skins ) {
99  global $wgStyleDirectory;
100  $registry = ExtensionRegistry::getInstance();
101  foreach ( $skins as $skin ) {
102  $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
103  }
104 }
105 
112 function wfArrayDiff2( $a, $b ) {
113  return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
114 }
115 
121 function wfArrayDiff2_cmp( $a, $b ) {
122  if ( is_string( $a ) && is_string( $b ) ) {
123  return strcmp( $a, $b );
124  } elseif ( count( $a ) !== count( $b ) ) {
125  return count( $a ) <=> count( $b );
126  } else {
127  reset( $a );
128  reset( $b );
129  while ( key( $a ) !== null && key( $b ) !== null ) {
130  $valueA = current( $a );
131  $valueB = current( $b );
132  $cmp = strcmp( $valueA, $valueB );
133  if ( $cmp !== 0 ) {
134  return $cmp;
135  }
136  next( $a );
137  next( $b );
138  }
139  return 0;
140  }
141 }
142 
152 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
153  if ( is_null( $changed ) ) {
154  throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
155  }
156  if ( $default[$key] !== $value ) {
157  $changed[$key] = $value;
158  }
159 }
160 
180 function wfMergeErrorArrays( ...$args ) {
181  $out = [];
182  foreach ( $args as $errors ) {
183  foreach ( $errors as $params ) {
184  $originalParams = $params;
185  if ( $params[0] instanceof MessageSpecifier ) {
186  $msg = $params[0];
187  $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
188  }
189  # @todo FIXME: Sometimes get nested arrays for $params,
190  # which leads to E_NOTICEs
191  $spec = implode( "\t", $params );
192  $out[$spec] = $originalParams;
193  }
194  }
195  return array_values( $out );
196 }
197 
206 function wfArrayInsertAfter( array $array, array $insert, $after ) {
207  // Find the offset of the element to insert after.
208  $keys = array_keys( $array );
209  $offsetByKey = array_flip( $keys );
210 
211  $offset = $offsetByKey[$after];
212 
213  // Insert at the specified offset
214  $before = array_slice( $array, 0, $offset + 1, true );
215  $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
216 
217  $output = $before + $insert + $after;
218 
219  return $output;
220 }
221 
229 function wfObjectToArray( $objOrArray, $recursive = true ) {
230  $array = [];
231  if ( is_object( $objOrArray ) ) {
232  $objOrArray = get_object_vars( $objOrArray );
233  }
234  foreach ( $objOrArray as $key => $value ) {
235  if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
237  }
238 
239  $array[$key] = $value;
240  }
241 
242  return $array;
243 }
244 
255 function wfRandom() {
256  // The maximum random value is "only" 2^31-1, so get two random
257  // values to reduce the chance of dupes
258  $max = mt_getrandmax() + 1;
259  $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
260  return $rand;
261 }
262 
273 function wfRandomString( $length = 32 ) {
274  $str = '';
275  for ( $n = 0; $n < $length; $n += 7 ) {
276  $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
277  }
278  return substr( $str, 0, $length );
279 }
280 
308 function wfUrlencode( $s ) {
309  static $needle;
310 
311  if ( is_null( $s ) ) {
312  // Reset $needle for testing.
313  $needle = null;
314  return '';
315  }
316 
317  if ( is_null( $needle ) ) {
318  $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
319  if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
320  ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
321  ) {
322  $needle[] = '%3A';
323  }
324  }
325 
326  $s = urlencode( $s );
327  $s = str_ireplace(
328  $needle,
329  [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
330  $s
331  );
332 
333  return $s;
334 }
335 
346 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
347  if ( !is_null( $array2 ) ) {
348  $array1 = $array1 + $array2;
349  }
350 
351  $cgi = '';
352  foreach ( $array1 as $key => $value ) {
353  if ( !is_null( $value ) && $value !== false ) {
354  if ( $cgi != '' ) {
355  $cgi .= '&';
356  }
357  if ( $prefix !== '' ) {
358  $key = $prefix . "[$key]";
359  }
360  if ( is_array( $value ) ) {
361  $firstTime = true;
362  foreach ( $value as $k => $v ) {
363  $cgi .= $firstTime ? '' : '&';
364  if ( is_array( $v ) ) {
365  $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
366  } else {
367  $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
368  }
369  $firstTime = false;
370  }
371  } else {
372  if ( is_object( $value ) ) {
373  $value = $value->__toString();
374  }
375  $cgi .= urlencode( $key ) . '=' . urlencode( $value );
376  }
377  }
378  }
379  return $cgi;
380 }
381 
391 function wfCgiToArray( $query ) {
392  if ( isset( $query[0] ) && $query[0] == '?' ) {
393  $query = substr( $query, 1 );
394  }
395  $bits = explode( '&', $query );
396  $ret = [];
397  foreach ( $bits as $bit ) {
398  if ( $bit === '' ) {
399  continue;
400  }
401  if ( strpos( $bit, '=' ) === false ) {
402  // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
403  $key = $bit;
404  $value = '';
405  } else {
406  list( $key, $value ) = explode( '=', $bit );
407  }
408  $key = urldecode( $key );
409  $value = urldecode( $value );
410  if ( strpos( $key, '[' ) !== false ) {
411  $keys = array_reverse( explode( '[', $key ) );
412  $key = array_pop( $keys );
413  $temp = $value;
414  foreach ( $keys as $k ) {
415  $k = substr( $k, 0, -1 );
416  $temp = [ $k => $temp ];
417  }
418  if ( isset( $ret[$key] ) ) {
419  $ret[$key] = array_merge( $ret[$key], $temp );
420  } else {
421  $ret[$key] = $temp;
422  }
423  } else {
424  $ret[$key] = $value;
425  }
426  }
427  return $ret;
428 }
429 
438 function wfAppendQuery( $url, $query ) {
439  if ( is_array( $query ) ) {
441  }
442  if ( $query != '' ) {
443  // Remove the fragment, if there is one
444  $fragment = false;
445  $hashPos = strpos( $url, '#' );
446  if ( $hashPos !== false ) {
447  $fragment = substr( $url, $hashPos );
448  $url = substr( $url, 0, $hashPos );
449  }
450 
451  // Add parameter
452  if ( strpos( $url, '?' ) === false ) {
453  $url .= '?';
454  } else {
455  $url .= '&';
456  }
457  $url .= $query;
458 
459  // Put the fragment back
460  if ( $fragment !== false ) {
461  $url .= $fragment;
462  }
463  }
464  return $url;
465 }
466 
490 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
492  $wgHttpsPort;
493  if ( $defaultProto === PROTO_CANONICAL ) {
494  $serverUrl = $wgCanonicalServer;
495  } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
496  // Make $wgInternalServer fall back to $wgServer if not set
497  $serverUrl = $wgInternalServer;
498  } else {
499  $serverUrl = $wgServer;
500  if ( $defaultProto === PROTO_CURRENT ) {
501  $defaultProto = $wgRequest->getProtocol() . '://';
502  }
503  }
504 
505  // Analyze $serverUrl to obtain its protocol
506  $bits = wfParseUrl( $serverUrl );
507  $serverHasProto = $bits && $bits['scheme'] != '';
508 
509  if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
510  if ( $serverHasProto ) {
511  $defaultProto = $bits['scheme'] . '://';
512  } else {
513  // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
514  // This really isn't supposed to happen. Fall back to HTTP in this
515  // ridiculous case.
516  $defaultProto = PROTO_HTTP;
517  }
518  }
519 
520  $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
521 
522  if ( substr( $url, 0, 2 ) == '//' ) {
523  $url = $defaultProtoWithoutSlashes . $url;
524  } elseif ( substr( $url, 0, 1 ) == '/' ) {
525  // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
526  // otherwise leave it alone.
527  if ( $serverHasProto ) {
528  $url = $serverUrl . $url;
529  } else {
530  // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
531  // user to override the port number (T67184)
532  if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
533  if ( isset( $bits['port'] ) ) {
534  throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
535  }
536  $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
537  } else {
538  $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
539  }
540  }
541  }
542 
543  $bits = wfParseUrl( $url );
544 
545  if ( $bits && isset( $bits['path'] ) ) {
546  $bits['path'] = wfRemoveDotSegments( $bits['path'] );
547  return wfAssembleUrl( $bits );
548  } elseif ( $bits ) {
549  # No path to expand
550  return $url;
551  } elseif ( substr( $url, 0, 1 ) != '/' ) {
552  # URL is a relative path
553  return wfRemoveDotSegments( $url );
554  }
555 
556  # Expanded URL is not valid.
557  return false;
558 }
559 
568 function wfGetServerUrl( $proto ) {
569  $url = wfExpandUrl( '/', $proto );
570  return substr( $url, 0, -1 );
571 }
572 
586 function wfAssembleUrl( $urlParts ) {
587  $result = '';
588 
589  if ( isset( $urlParts['delimiter'] ) ) {
590  if ( isset( $urlParts['scheme'] ) ) {
591  $result .= $urlParts['scheme'];
592  }
593 
594  $result .= $urlParts['delimiter'];
595  }
596 
597  if ( isset( $urlParts['host'] ) ) {
598  if ( isset( $urlParts['user'] ) ) {
599  $result .= $urlParts['user'];
600  if ( isset( $urlParts['pass'] ) ) {
601  $result .= ':' . $urlParts['pass'];
602  }
603  $result .= '@';
604  }
605 
606  $result .= $urlParts['host'];
607 
608  if ( isset( $urlParts['port'] ) ) {
609  $result .= ':' . $urlParts['port'];
610  }
611  }
612 
613  if ( isset( $urlParts['path'] ) ) {
614  $result .= $urlParts['path'];
615  }
616 
617  if ( isset( $urlParts['query'] ) ) {
618  $result .= '?' . $urlParts['query'];
619  }
620 
621  if ( isset( $urlParts['fragment'] ) ) {
622  $result .= '#' . $urlParts['fragment'];
623  }
624 
625  return $result;
626 }
627 
640 function wfRemoveDotSegments( $urlPath ) {
641  $output = '';
642  $inputOffset = 0;
643  $inputLength = strlen( $urlPath );
644 
645  while ( $inputOffset < $inputLength ) {
646  $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
647  $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
648  $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
649  $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
650  $trimOutput = false;
651 
652  if ( $prefixLengthTwo == './' ) {
653  # Step A, remove leading "./"
654  $inputOffset += 2;
655  } elseif ( $prefixLengthThree == '../' ) {
656  # Step A, remove leading "../"
657  $inputOffset += 3;
658  } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
659  # Step B, replace leading "/.$" with "/"
660  $inputOffset += 1;
661  $urlPath[$inputOffset] = '/';
662  } elseif ( $prefixLengthThree == '/./' ) {
663  # Step B, replace leading "/./" with "/"
664  $inputOffset += 2;
665  } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
666  # Step C, replace leading "/..$" with "/" and
667  # remove last path component in output
668  $inputOffset += 2;
669  $urlPath[$inputOffset] = '/';
670  $trimOutput = true;
671  } elseif ( $prefixLengthFour == '/../' ) {
672  # Step C, replace leading "/../" with "/" and
673  # remove last path component in output
674  $inputOffset += 3;
675  $trimOutput = true;
676  } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
677  # Step D, remove "^.$"
678  $inputOffset += 1;
679  } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
680  # Step D, remove "^..$"
681  $inputOffset += 2;
682  } else {
683  # Step E, move leading path segment to output
684  if ( $prefixLengthOne == '/' ) {
685  $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
686  } else {
687  $slashPos = strpos( $urlPath, '/', $inputOffset );
688  }
689  if ( $slashPos === false ) {
690  $output .= substr( $urlPath, $inputOffset );
691  $inputOffset = $inputLength;
692  } else {
693  $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
694  $inputOffset += $slashPos - $inputOffset;
695  }
696  }
697 
698  if ( $trimOutput ) {
699  $slashPos = strrpos( $output, '/' );
700  if ( $slashPos === false ) {
701  $output = '';
702  } else {
703  $output = substr( $output, 0, $slashPos );
704  }
705  }
706  }
707 
708  return $output;
709 }
710 
718 function wfUrlProtocols( $includeProtocolRelative = true ) {
719  global $wgUrlProtocols;
720 
721  // Cache return values separately based on $includeProtocolRelative
722  static $withProtRel = null, $withoutProtRel = null;
723  $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
724  if ( !is_null( $cachedValue ) ) {
725  return $cachedValue;
726  }
727 
728  // Support old-style $wgUrlProtocols strings, for backwards compatibility
729  // with LocalSettings files from 1.5
730  if ( is_array( $wgUrlProtocols ) ) {
731  $protocols = [];
732  foreach ( $wgUrlProtocols as $protocol ) {
733  // Filter out '//' if !$includeProtocolRelative
734  if ( $includeProtocolRelative || $protocol !== '//' ) {
735  $protocols[] = preg_quote( $protocol, '/' );
736  }
737  }
738 
739  $retval = implode( '|', $protocols );
740  } else {
741  // Ignore $includeProtocolRelative in this case
742  // This case exists for pre-1.6 compatibility, and we can safely assume
743  // that '//' won't appear in a pre-1.6 config because protocol-relative
744  // URLs weren't supported until 1.18
745  $retval = $wgUrlProtocols;
746  }
747 
748  // Cache return value
749  if ( $includeProtocolRelative ) {
750  $withProtRel = $retval;
751  } else {
752  $withoutProtRel = $retval;
753  }
754  return $retval;
755 }
756 
764  return wfUrlProtocols( false );
765 }
766 
792 function wfParseUrl( $url ) {
793  global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
794 
795  // Protocol-relative URLs are handled really badly by parse_url(). It's so
796  // bad that the easiest way to handle them is to just prepend 'http:' and
797  // strip the protocol out later.
798  $wasRelative = substr( $url, 0, 2 ) == '//';
799  if ( $wasRelative ) {
800  $url = "http:$url";
801  }
802  AtEase::suppressWarnings();
803  $bits = parse_url( $url );
804  AtEase::restoreWarnings();
805  // parse_url() returns an array without scheme for some invalid URLs, e.g.
806  // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
807  if ( !$bits || !isset( $bits['scheme'] ) ) {
808  return false;
809  }
810 
811  // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
812  $bits['scheme'] = strtolower( $bits['scheme'] );
813 
814  // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
815  if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
816  $bits['delimiter'] = '://';
817  } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
818  $bits['delimiter'] = ':';
819  // parse_url detects for news: and mailto: the host part of an url as path
820  // We have to correct this wrong detection
821  if ( isset( $bits['path'] ) ) {
822  $bits['host'] = $bits['path'];
823  $bits['path'] = '';
824  }
825  } else {
826  return false;
827  }
828 
829  /* Provide an empty host for eg. file:/// urls (see T30627) */
830  if ( !isset( $bits['host'] ) ) {
831  $bits['host'] = '';
832 
833  // See T47069
834  if ( isset( $bits['path'] ) ) {
835  /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
836  if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
837  $bits['path'] = '/' . $bits['path'];
838  }
839  } else {
840  $bits['path'] = '';
841  }
842  }
843 
844  // If the URL was protocol-relative, fix scheme and delimiter
845  if ( $wasRelative ) {
846  $bits['scheme'] = '';
847  $bits['delimiter'] = '//';
848  }
849  return $bits;
850 }
851 
862 function wfExpandIRI( $url ) {
863  return preg_replace_callback(
864  '/((?:%[89A-F][0-9A-F])+)/i',
865  function ( array $matches ) {
866  return urldecode( $matches[1] );
867  },
868  wfExpandUrl( $url )
869  );
870 }
871 
878 function wfMatchesDomainList( $url, $domains ) {
879  $bits = wfParseUrl( $url );
880  if ( is_array( $bits ) && isset( $bits['host'] ) ) {
881  $host = '.' . $bits['host'];
882  foreach ( (array)$domains as $domain ) {
883  $domain = '.' . $domain;
884  if ( substr( $host, -strlen( $domain ) ) === $domain ) {
885  return true;
886  }
887  }
888  }
889  return false;
890 }
891 
912 function wfDebug( $text, $dest = 'all', array $context = [] ) {
914  global $wgDebugTimestamps;
915 
916  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
917  return;
918  }
919 
920  $text = trim( $text );
921 
922  if ( $wgDebugTimestamps ) {
923  $context['seconds_elapsed'] = sprintf(
924  '%6.4f',
925  microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
926  );
927  $context['memory_used'] = sprintf(
928  '%5.1fM',
929  ( memory_get_usage( true ) / ( 1024 * 1024 ) )
930  );
931  }
932 
933  if ( $wgDebugLogPrefix !== '' ) {
934  $context['prefix'] = $wgDebugLogPrefix;
935  }
936  $context['private'] = ( $dest === false || $dest === 'private' );
937 
938  $logger = LoggerFactory::getInstance( 'wfDebug' );
939  $logger->debug( $text, $context );
940 }
941 
946 function wfIsDebugRawPage() {
947  static $cache;
948  if ( $cache !== null ) {
949  return $cache;
950  }
951  // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
952  // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
953  if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
954  || (
955  isset( $_SERVER['SCRIPT_NAME'] )
956  && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
957  )
958  ) {
959  $cache = true;
960  } else {
961  $cache = false;
962  }
963  return $cache;
964 }
965 
971 function wfDebugMem( $exact = false ) {
972  $mem = memory_get_usage();
973  if ( !$exact ) {
974  $mem = floor( $mem / 1024 ) . ' KiB';
975  } else {
976  $mem .= ' B';
977  }
978  wfDebug( "Memory usage: $mem\n" );
979 }
980 
1006 function wfDebugLog(
1007  $logGroup, $text, $dest = 'all', array $context = []
1008 ) {
1009  $text = trim( $text );
1010 
1011  $logger = LoggerFactory::getInstance( $logGroup );
1012  $context['private'] = ( $dest === false || $dest === 'private' );
1013  $logger->info( $text, $context );
1014 }
1015 
1024 function wfLogDBError( $text, array $context = [] ) {
1025  $logger = LoggerFactory::getInstance( 'wfLogDBError' );
1026  $logger->error( trim( $text ), $context );
1027 }
1028 
1043 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1044  if ( is_string( $version ) || is_bool( $version ) ) {
1045  MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1046  } else {
1047  throw new Exception(
1048  "MediaWiki version must either be a string or a boolean. " .
1049  "Example valid version: '1.33'"
1050  );
1051  }
1052 }
1053 
1064 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1065  MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1066 }
1067 
1077 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1078  MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1079 }
1080 
1087 
1089  $request = $context->getRequest();
1090 
1091  $profiler = Profiler::instance();
1092  $profiler->setContext( $context );
1093  $profiler->logData();
1094 
1095  // Send out any buffered statsd metrics as needed
1097  MediaWikiServices::getInstance()->getStatsdDataFactory(),
1098  $context->getConfig()
1099  );
1100 
1101  // Profiling must actually be enabled...
1102  if ( $profiler instanceof ProfilerStub ) {
1103  return;
1104  }
1105 
1106  if ( isset( $wgDebugLogGroups['profileoutput'] )
1107  && $wgDebugLogGroups['profileoutput'] === false
1108  ) {
1109  // Explicitly disabled
1110  return;
1111  }
1112  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1113  return;
1114  }
1115 
1116  $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1117  if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1118  $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1119  }
1120  if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1121  $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1122  }
1123  if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1124  $ctx['from'] = $_SERVER['HTTP_FROM'];
1125  }
1126  if ( isset( $ctx['forwarded_for'] ) ||
1127  isset( $ctx['client_ip'] ) ||
1128  isset( $ctx['from'] ) ) {
1129  $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1130  }
1131 
1132  // Don't load $wgUser at this late stage just for statistics purposes
1133  // @todo FIXME: We can detect some anons even if it is not loaded.
1134  // See User::getId()
1135  $user = $context->getUser();
1136  $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1137 
1138  // Command line script uses a FauxRequest object which does not have
1139  // any knowledge about an URL and throw an exception instead.
1140  try {
1141  $ctx['url'] = urldecode( $request->getRequestURL() );
1142  } catch ( Exception $ignored ) {
1143  // no-op
1144  }
1145 
1146  $ctx['output'] = $profiler->getOutput();
1147 
1148  $log = LoggerFactory::getInstance( 'profileoutput' );
1149  $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1150 }
1151 
1159 function wfIncrStats( $key, $count = 1 ) {
1160  $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1161  $stats->updateCount( $key, $count );
1162 }
1163 
1169 function wfReadOnly() {
1170  return MediaWikiServices::getInstance()->getReadOnlyMode()
1171  ->isReadOnly();
1172 }
1173 
1182 function wfReadOnlyReason() {
1183  return MediaWikiServices::getInstance()->getReadOnlyMode()
1184  ->getReason();
1185 }
1186 
1194  return MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1195  ->getReason();
1196 }
1197 
1213 function wfGetLangObj( $langcode = false ) {
1214  # Identify which language to get or create a language object for.
1215  # Using is_object here due to Stub objects.
1216  if ( is_object( $langcode ) ) {
1217  # Great, we already have the object (hopefully)!
1218  return $langcode;
1219  }
1220 
1221  global $wgLanguageCode;
1222  if ( $langcode === true || $langcode === $wgLanguageCode ) {
1223  # $langcode is the language code of the wikis content language object.
1224  # or it is a boolean and value is true
1225  return MediaWikiServices::getInstance()->getContentLanguage();
1226  }
1227 
1228  global $wgLang;
1229  if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1230  # $langcode is the language code of user language object.
1231  # or it was a boolean and value is false
1232  return $wgLang;
1233  }
1234 
1235  $validCodes = array_keys( Language::fetchLanguageNames() );
1236  if ( in_array( $langcode, $validCodes ) ) {
1237  # $langcode corresponds to a valid language.
1238  return Language::factory( $langcode );
1239  }
1240 
1241  # $langcode is a string, but not a valid language code; use content language.
1242  wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1243  return MediaWikiServices::getInstance()->getContentLanguage();
1244 }
1245 
1262 function wfMessage( $key, ...$params ) {
1263  $message = new Message( $key );
1264 
1265  // We call Message::params() to reduce code duplication
1266  if ( $params ) {
1267  $message->params( ...$params );
1268  }
1269 
1270  return $message;
1271 }
1272 
1285 function wfMessageFallback( ...$keys ) {
1286  return Message::newFallbackSequence( ...$keys );
1287 }
1288 
1297 function wfMsgReplaceArgs( $message, $args ) {
1298  # Fix windows line-endings
1299  # Some messages are split with explode("\n", $msg)
1300  $message = str_replace( "\r", '', $message );
1301 
1302  // Replace arguments
1303  if ( is_array( $args ) && $args ) {
1304  if ( is_array( $args[0] ) ) {
1305  $args = array_values( $args[0] );
1306  }
1307  $replacementKeys = [];
1308  foreach ( $args as $n => $param ) {
1309  $replacementKeys['$' . ( $n + 1 )] = $param;
1310  }
1311  $message = strtr( $message, $replacementKeys );
1312  }
1313 
1314  return $message;
1315 }
1316 
1324 function wfHostname() {
1325  static $host;
1326  if ( is_null( $host ) ) {
1327  # Hostname overriding
1328  global $wgOverrideHostname;
1329  if ( $wgOverrideHostname !== false ) {
1330  # Set static and skip any detection
1331  $host = $wgOverrideHostname;
1332  return $host;
1333  }
1334 
1335  if ( function_exists( 'posix_uname' ) ) {
1336  // This function not present on Windows
1337  $uname = posix_uname();
1338  } else {
1339  $uname = false;
1340  }
1341  if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1342  $host = $uname['nodename'];
1343  } elseif ( getenv( 'COMPUTERNAME' ) ) {
1344  # Windows computer name
1345  $host = getenv( 'COMPUTERNAME' );
1346  } else {
1347  # This may be a virtual server.
1348  $host = $_SERVER['SERVER_NAME'];
1349  }
1350  }
1351  return $host;
1352 }
1353 
1364 function wfReportTime( $nonce = null ) {
1365  global $wgShowHostnames;
1366 
1367  $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1368  // seconds to milliseconds
1369  $responseTime = round( $elapsed * 1000 );
1370  $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1371  if ( $wgShowHostnames ) {
1372  $reportVars['wgHostname'] = wfHostname();
1373  }
1374  return Skin::makeVariablesScript( $reportVars, $nonce );
1375 }
1376 
1387 function wfDebugBacktrace( $limit = 0 ) {
1388  static $disabled = null;
1389 
1390  if ( is_null( $disabled ) ) {
1391  $disabled = !function_exists( 'debug_backtrace' );
1392  if ( $disabled ) {
1393  wfDebug( "debug_backtrace() is disabled\n" );
1394  }
1395  }
1396  if ( $disabled ) {
1397  return [];
1398  }
1399 
1400  if ( $limit ) {
1401  return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1402  } else {
1403  return array_slice( debug_backtrace(), 1 );
1404  }
1405 }
1406 
1415 function wfBacktrace( $raw = null ) {
1416  global $wgCommandLineMode;
1417 
1418  if ( $raw === null ) {
1419  $raw = $wgCommandLineMode;
1420  }
1421 
1422  if ( $raw ) {
1423  $frameFormat = "%s line %s calls %s()\n";
1424  $traceFormat = "%s";
1425  } else {
1426  $frameFormat = "<li>%s line %s calls %s()</li>\n";
1427  $traceFormat = "<ul>\n%s</ul>\n";
1428  }
1429 
1430  $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1431  $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1432  $line = $frame['line'] ?? '-';
1433  $call = $frame['function'];
1434  if ( !empty( $frame['class'] ) ) {
1435  $call = $frame['class'] . $frame['type'] . $call;
1436  }
1437  return sprintf( $frameFormat, $file, $line, $call );
1438  }, wfDebugBacktrace() );
1439 
1440  return sprintf( $traceFormat, implode( '', $frames ) );
1441 }
1442 
1452 function wfGetCaller( $level = 2 ) {
1453  $backtrace = wfDebugBacktrace( $level + 1 );
1454  if ( isset( $backtrace[$level] ) ) {
1455  return wfFormatStackFrame( $backtrace[$level] );
1456  } else {
1457  return 'unknown';
1458  }
1459 }
1460 
1468 function wfGetAllCallers( $limit = 3 ) {
1469  $trace = array_reverse( wfDebugBacktrace() );
1470  if ( !$limit || $limit > count( $trace ) - 1 ) {
1471  $limit = count( $trace ) - 1;
1472  }
1473  $trace = array_slice( $trace, -$limit - 1, $limit );
1474  return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1475 }
1476 
1483 function wfFormatStackFrame( $frame ) {
1484  if ( !isset( $frame['function'] ) ) {
1485  return 'NO_FUNCTION_GIVEN';
1486  }
1487  return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1488  $frame['class'] . $frame['type'] . $frame['function'] :
1489  $frame['function'];
1490 }
1491 
1492 /* Some generic result counters, pulled out of SearchEngine */
1493 
1501 function wfShowingResults( $offset, $limit ) {
1502  return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1503 }
1504 
1514 function wfClientAcceptsGzip( $force = false ) {
1515  static $result = null;
1516  if ( $result === null || $force ) {
1517  $result = false;
1518  if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1519  # @todo FIXME: We may want to blacklist some broken browsers
1520  $m = [];
1521  if ( preg_match(
1522  '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1523  $_SERVER['HTTP_ACCEPT_ENCODING'],
1524  $m
1525  )
1526  ) {
1527  if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1528  $result = false;
1529  return $result;
1530  }
1531  wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1532  $result = true;
1533  }
1534  }
1535  }
1536  return $result;
1537 }
1538 
1549 function wfEscapeWikiText( $text ) {
1550  global $wgEnableMagicLinks;
1551  static $repl = null, $repl2 = null;
1552  if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1553  // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1554  // in those situations
1555  $repl = [
1556  '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1557  '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1558  '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1559  "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1560  "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1561  "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1562  "\n " => "\n&#32;", "\r " => "\r&#32;",
1563  "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1564  "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1565  "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1566  "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1567  '__' => '_&#95;', '://' => '&#58;//',
1568  ];
1569 
1570  $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1571  // We have to catch everything "\s" matches in PCRE
1572  foreach ( $magicLinks as $magic ) {
1573  $repl["$magic "] = "$magic&#32;";
1574  $repl["$magic\t"] = "$magic&#9;";
1575  $repl["$magic\r"] = "$magic&#13;";
1576  $repl["$magic\n"] = "$magic&#10;";
1577  $repl["$magic\f"] = "$magic&#12;";
1578  }
1579 
1580  // And handle protocols that don't use "://"
1581  global $wgUrlProtocols;
1582  $repl2 = [];
1583  foreach ( $wgUrlProtocols as $prot ) {
1584  if ( substr( $prot, -1 ) === ':' ) {
1585  $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1586  }
1587  }
1588  $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1589  }
1590  $text = substr( strtr( "\n$text", $repl ), 1 );
1591  $text = preg_replace( $repl2, '$1&#58;', $text );
1592  return $text;
1593 }
1594 
1605 function wfSetVar( &$dest, $source, $force = false ) {
1606  $temp = $dest;
1607  if ( !is_null( $source ) || $force ) {
1608  $dest = $source;
1609  }
1610  return $temp;
1611 }
1612 
1622 function wfSetBit( &$dest, $bit, $state = true ) {
1623  $temp = (bool)( $dest & $bit );
1624  if ( !is_null( $state ) ) {
1625  if ( $state ) {
1626  $dest |= $bit;
1627  } else {
1628  $dest &= ~$bit;
1629  }
1630  }
1631  return $temp;
1632 }
1633 
1640 function wfVarDump( $var ) {
1641  global $wgOut;
1642  $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1643  if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1644  print $s;
1645  } else {
1646  $wgOut->addHTML( $s );
1647  }
1648 }
1649 
1657 function wfHttpError( $code, $label, $desc ) {
1658  global $wgOut;
1660  if ( $wgOut ) {
1661  $wgOut->disable();
1662  $wgOut->sendCacheControl();
1663  }
1664 
1666  header( 'Content-type: text/html; charset=utf-8' );
1667  print '<!DOCTYPE html>' .
1668  '<html><head><title>' .
1669  htmlspecialchars( $label ) .
1670  '</title></head><body><h1>' .
1671  htmlspecialchars( $label ) .
1672  '</h1><p>' .
1673  nl2br( htmlspecialchars( $desc ) ) .
1674  "</p></body></html>\n";
1675 }
1676 
1694 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1695  if ( $resetGzipEncoding ) {
1696  // Suppress Content-Encoding and Content-Length
1697  // headers from OutputHandler::handle.
1699  $wgDisableOutputCompression = true;
1700  }
1701  while ( $status = ob_get_status() ) {
1702  if ( isset( $status['flags'] ) ) {
1703  $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1704  $deleteable = ( $status['flags'] & $flags ) === $flags;
1705  } elseif ( isset( $status['del'] ) ) {
1706  $deleteable = $status['del'];
1707  } else {
1708  // Guess that any PHP-internal setting can't be removed.
1709  $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1710  }
1711  if ( !$deleteable ) {
1712  // Give up, and hope the result doesn't break
1713  // output behavior.
1714  break;
1715  }
1716  if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1717  // Unit testing barrier to prevent this function from breaking PHPUnit.
1718  break;
1719  }
1720  if ( !ob_end_clean() ) {
1721  // Could not remove output buffer handler; abort now
1722  // to avoid getting in some kind of infinite loop.
1723  break;
1724  }
1725  if ( $resetGzipEncoding && $status['name'] == 'ob_gzhandler' ) {
1726  // Reset the 'Content-Encoding' field set by this handler
1727  // so we can start fresh.
1728  header_remove( 'Content-Encoding' );
1729  break;
1730  }
1731  }
1732 }
1733 
1747  wfResetOutputBuffers( false );
1748 }
1749 
1758 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1759  # No arg means accept anything (per HTTP spec)
1760  if ( !$accept ) {
1761  return [ $def => 1.0 ];
1762  }
1763 
1764  $prefs = [];
1765 
1766  $parts = explode( ',', $accept );
1767 
1768  foreach ( $parts as $part ) {
1769  # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1770  $values = explode( ';', trim( $part ) );
1771  $match = [];
1772  if ( count( $values ) == 1 ) {
1773  $prefs[$values[0]] = 1.0;
1774  } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1775  $prefs[$values[0]] = floatval( $match[1] );
1776  }
1777  }
1778 
1779  return $prefs;
1780 }
1781 
1794 function mimeTypeMatch( $type, $avail ) {
1795  if ( array_key_exists( $type, $avail ) ) {
1796  return $type;
1797  } else {
1798  $mainType = explode( '/', $type )[0];
1799  if ( array_key_exists( "$mainType/*", $avail ) ) {
1800  return "$mainType/*";
1801  } elseif ( array_key_exists( '*/*', $avail ) ) {
1802  return '*/*';
1803  } else {
1804  return null;
1805  }
1806  }
1807 }
1808 
1822 function wfNegotiateType( $cprefs, $sprefs ) {
1823  $combine = [];
1824 
1825  foreach ( array_keys( $sprefs ) as $type ) {
1826  $subType = explode( '/', $type )[1];
1827  if ( $subType != '*' ) {
1828  $ckey = mimeTypeMatch( $type, $cprefs );
1829  if ( $ckey ) {
1830  $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1831  }
1832  }
1833  }
1834 
1835  foreach ( array_keys( $cprefs ) as $type ) {
1836  $subType = explode( '/', $type )[1];
1837  if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1838  $skey = mimeTypeMatch( $type, $sprefs );
1839  if ( $skey ) {
1840  $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1841  }
1842  }
1843  }
1844 
1845  $bestq = 0;
1846  $besttype = null;
1847 
1848  foreach ( array_keys( $combine ) as $type ) {
1849  if ( $combine[$type] > $bestq ) {
1850  $besttype = $type;
1851  $bestq = $combine[$type];
1852  }
1853  }
1854 
1855  return $besttype;
1856 }
1857 
1866 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1867  $ret = MWTimestamp::convert( $outputtype, $ts );
1868  if ( $ret === false ) {
1869  wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1870  }
1871  return $ret;
1872 }
1873 
1882 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1883  if ( is_null( $ts ) ) {
1884  return null;
1885  } else {
1886  return wfTimestamp( $outputtype, $ts );
1887  }
1888 }
1889 
1895 function wfTimestampNow() {
1896  return MWTimestamp::now( TS_MW );
1897 }
1898 
1904 function wfIsWindows() {
1905  static $isWindows = null;
1906  if ( $isWindows === null ) {
1907  $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
1908  }
1909  return $isWindows;
1910 }
1911 
1917 function wfIsHHVM() {
1918  return defined( 'HHVM_VERSION' );
1919 }
1920 
1927 function wfIsCLI() {
1928  return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
1929 }
1930 
1942 function wfTempDir() {
1943  global $wgTmpDirectory;
1944 
1945  if ( $wgTmpDirectory !== false ) {
1946  return $wgTmpDirectory;
1947  }
1948 
1950 }
1951 
1961 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
1962  global $wgDirectoryMode;
1963 
1964  if ( FileBackend::isStoragePath( $dir ) ) { // sanity
1965  throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
1966  }
1967 
1968  if ( !is_null( $caller ) ) {
1969  wfDebug( "$caller: called wfMkdirParents($dir)\n" );
1970  }
1971 
1972  if ( strval( $dir ) === '' || is_dir( $dir ) ) {
1973  return true;
1974  }
1975 
1976  $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
1977 
1978  if ( is_null( $mode ) ) {
1979  $mode = $wgDirectoryMode;
1980  }
1981 
1982  // Turn off the normal warning, we're doing our own below
1983  AtEase::suppressWarnings();
1984  $ok = mkdir( $dir, $mode, true ); // PHP5 <3
1985  AtEase::restoreWarnings();
1986 
1987  if ( !$ok ) {
1988  // directory may have been created on another request since we last checked
1989  if ( is_dir( $dir ) ) {
1990  return true;
1991  }
1992 
1993  // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
1994  wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
1995  }
1996  return $ok;
1997 }
1998 
2004 function wfRecursiveRemoveDir( $dir ) {
2005  wfDebug( __FUNCTION__ . "( $dir )\n" );
2006  // taken from https://www.php.net/manual/en/function.rmdir.php#98622
2007  if ( is_dir( $dir ) ) {
2008  $objects = scandir( $dir );
2009  foreach ( $objects as $object ) {
2010  if ( $object != "." && $object != ".." ) {
2011  if ( filetype( $dir . '/' . $object ) == "dir" ) {
2012  wfRecursiveRemoveDir( $dir . '/' . $object );
2013  } else {
2014  unlink( $dir . '/' . $object );
2015  }
2016  }
2017  }
2018  reset( $objects );
2019  rmdir( $dir );
2020  }
2021 }
2022 
2029 function wfPercent( $nr, $acc = 2, $round = true ) {
2030  $ret = sprintf( "%.${acc}f", $nr );
2031  return $round ? round( $ret, $acc ) . '%' : "$ret%";
2032 }
2033 
2057 function wfIniGetBool( $setting ) {
2058  return wfStringToBool( ini_get( $setting ) );
2059 }
2060 
2073 function wfStringToBool( $val ) {
2074  $val = strtolower( $val );
2075  // 'on' and 'true' can't have whitespace around them, but '1' can.
2076  return $val == 'on'
2077  || $val == 'true'
2078  || $val == 'yes'
2079  || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2080 }
2081 
2094 function wfEscapeShellArg( ...$args ) {
2095  return Shell::escape( ...$args );
2096 }
2097 
2121 function wfShellExec( $cmd, &$retval = null, $environ = [],
2122  $limits = [], $options = []
2123 ) {
2124  if ( Shell::isDisabled() ) {
2125  $retval = 1;
2126  // Backwards compatibility be upon us...
2127  return 'Unable to run external programs, proc_open() is disabled.';
2128  }
2129 
2130  if ( is_array( $cmd ) ) {
2131  $cmd = Shell::escape( $cmd );
2132  }
2133 
2134  $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2135  $profileMethod = $options['profileMethod'] ?? wfGetCaller();
2136 
2137  try {
2138  $result = Shell::command( [] )
2139  ->unsafeParams( (array)$cmd )
2140  ->environment( $environ )
2141  ->limits( $limits )
2142  ->includeStderr( $includeStderr )
2143  ->profileMethod( $profileMethod )
2144  // For b/c
2145  ->restrict( Shell::RESTRICT_NONE )
2146  ->execute();
2147  } catch ( ProcOpenError $ex ) {
2148  $retval = -1;
2149  return '';
2150  }
2151 
2152  $retval = $result->getExitCode();
2153 
2154  return $result->getStdout();
2155 }
2156 
2174 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2175  return wfShellExec( $cmd, $retval, $environ, $limits,
2176  [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2177 }
2178 
2193 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2194  global $wgPhpCli;
2195  // Give site config file a chance to run the script in a wrapper.
2196  // The caller may likely want to call wfBasename() on $script.
2197  Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2198  $cmd = [ $options['php'] ?? $wgPhpCli ];
2199  if ( isset( $options['wrapper'] ) ) {
2200  $cmd[] = $options['wrapper'];
2201  }
2202  $cmd[] = $script;
2203  // Escape each parameter for shell
2204  return Shell::escape( array_merge( $cmd, $parameters ) );
2205 }
2206 
2218 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2219  global $wgDiff3;
2220 
2221  # This check may also protect against code injection in
2222  # case of broken installations.
2223  AtEase::suppressWarnings();
2224  $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2225  AtEase::restoreWarnings();
2226 
2227  if ( !$haveDiff3 ) {
2228  wfDebug( "diff3 not found\n" );
2229  return false;
2230  }
2231 
2232  # Make temporary files
2233  $td = wfTempDir();
2234  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2235  $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2236  $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2237 
2238  # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2239  # a newline character. To avoid this, we normalize the trailing whitespace before
2240  # creating the diff.
2241 
2242  fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2243  fclose( $oldtextFile );
2244  fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2245  fclose( $mytextFile );
2246  fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2247  fclose( $yourtextFile );
2248 
2249  # Check for a conflict
2250  $cmd = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2251  $oldtextName, $yourtextName );
2252  $handle = popen( $cmd, 'r' );
2253 
2254  $mergeAttemptResult = '';
2255  do {
2256  $data = fread( $handle, 8192 );
2257  if ( strlen( $data ) == 0 ) {
2258  break;
2259  }
2260  $mergeAttemptResult .= $data;
2261  } while ( true );
2262  pclose( $handle );
2263 
2264  $conflict = $mergeAttemptResult !== '';
2265 
2266  # Merge differences
2267  $cmd = Shell::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2268  $oldtextName, $yourtextName );
2269  $handle = popen( $cmd, 'r' );
2270  $result = '';
2271  do {
2272  $data = fread( $handle, 8192 );
2273  if ( strlen( $data ) == 0 ) {
2274  break;
2275  }
2276  $result .= $data;
2277  } while ( true );
2278  pclose( $handle );
2279  unlink( $mytextName );
2280  unlink( $oldtextName );
2281  unlink( $yourtextName );
2282 
2283  if ( $result === '' && $old !== '' && !$conflict ) {
2284  wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2285  $conflict = true;
2286  }
2287  return !$conflict;
2288 }
2289 
2301 function wfDiff( $before, $after, $params = '-u' ) {
2302  if ( $before == $after ) {
2303  return '';
2304  }
2305 
2306  global $wgDiff;
2307  AtEase::suppressWarnings();
2308  $haveDiff = $wgDiff && file_exists( $wgDiff );
2309  AtEase::restoreWarnings();
2310 
2311  # This check may also protect against code injection in
2312  # case of broken installations.
2313  if ( !$haveDiff ) {
2314  wfDebug( "diff executable not found\n" );
2315  $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2316  $format = new UnifiedDiffFormatter();
2317  return $format->format( $diffs );
2318  }
2319 
2320  # Make temporary files
2321  $td = wfTempDir();
2322  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2323  $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2324 
2325  fwrite( $oldtextFile, $before );
2326  fclose( $oldtextFile );
2327  fwrite( $newtextFile, $after );
2328  fclose( $newtextFile );
2329 
2330  // Get the diff of the two files
2331  $cmd = "$wgDiff " . $params . ' ' . Shell::escape( $oldtextName, $newtextName );
2332 
2333  $h = popen( $cmd, 'r' );
2334  if ( !$h ) {
2335  unlink( $oldtextName );
2336  unlink( $newtextName );
2337  throw new Exception( __METHOD__ . '(): popen() failed' );
2338  }
2339 
2340  $diff = '';
2341 
2342  do {
2343  $data = fread( $h, 8192 );
2344  if ( strlen( $data ) == 0 ) {
2345  break;
2346  }
2347  $diff .= $data;
2348  } while ( true );
2349 
2350  // Clean up
2351  pclose( $h );
2352  unlink( $oldtextName );
2353  unlink( $newtextName );
2354 
2355  // Kill the --- and +++ lines. They're not useful.
2356  $diff_lines = explode( "\n", $diff );
2357  if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2358  unset( $diff_lines[0] );
2359  }
2360  if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2361  unset( $diff_lines[1] );
2362  }
2363 
2364  $diff = implode( "\n", $diff_lines );
2365 
2366  return $diff;
2367 }
2368 
2381 function wfBaseName( $path, $suffix = '' ) {
2382  if ( $suffix == '' ) {
2383  $encSuffix = '';
2384  } else {
2385  $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2386  }
2387 
2388  $matches = [];
2389  if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2390  return $matches[1];
2391  } else {
2392  return '';
2393  }
2394 }
2395 
2405 function wfRelativePath( $path, $from ) {
2406  // Normalize mixed input on Windows...
2407  $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2408  $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2409 
2410  // Trim trailing slashes -- fix for drive root
2411  $path = rtrim( $path, DIRECTORY_SEPARATOR );
2412  $from = rtrim( $from, DIRECTORY_SEPARATOR );
2413 
2414  $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2415  $against = explode( DIRECTORY_SEPARATOR, $from );
2416 
2417  if ( $pieces[0] !== $against[0] ) {
2418  // Non-matching Windows drive letters?
2419  // Return a full path.
2420  return $path;
2421  }
2422 
2423  // Trim off common prefix
2424  while ( count( $pieces ) && count( $against )
2425  && $pieces[0] == $against[0] ) {
2426  array_shift( $pieces );
2427  array_shift( $against );
2428  }
2429 
2430  // relative dots to bump us to the parent
2431  while ( count( $against ) ) {
2432  array_unshift( $pieces, '..' );
2433  array_shift( $against );
2434  }
2435 
2436  array_push( $pieces, wfBaseName( $path ) );
2437 
2438  return implode( DIRECTORY_SEPARATOR, $pieces );
2439 }
2440 
2450 function wfSetupSession( $sessionId = false ) {
2451  wfDeprecated( __FUNCTION__, '1.27' );
2452 
2453  if ( $sessionId ) {
2454  session_id( $sessionId );
2455  }
2456 
2457  $session = SessionManager::getGlobalSession();
2458  $session->persist();
2459 
2460  if ( session_id() !== $session->getId() ) {
2461  session_id( $session->getId() );
2462  }
2463  AtEase::quietCall( 'session_start' );
2464 }
2465 
2473  global $IP;
2474 
2475  $file = "$IP/serialized/$name";
2476  if ( file_exists( $file ) ) {
2477  $blob = file_get_contents( $file );
2478  if ( $blob ) {
2479  return unserialize( $blob );
2480  }
2481  }
2482  return false;
2483 }
2484 
2492 function wfMemcKey( ...$args ) {
2493  return ObjectCache::getLocalClusterInstance()->makeKey( ...$args );
2494 }
2495 
2506 function wfForeignMemcKey( $db, $prefix, ...$args ) {
2507  $keyspace = $prefix ? "$db-$prefix" : $db;
2508  return ObjectCache::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2509 }
2510 
2523 function wfGlobalCacheKey( ...$args ) {
2524  wfDeprecated( __METHOD__, '1.30' );
2525  return ObjectCache::getLocalClusterInstance()->makeGlobalKey( ...$args );
2526 }
2527 
2534 function wfWikiID() {
2535  global $wgDBprefix, $wgDBname;
2536  if ( $wgDBprefix ) {
2537  return "$wgDBname-$wgDBprefix";
2538  } else {
2539  return $wgDBname;
2540  }
2541 }
2542 
2568 function wfGetDB( $db, $groups = [], $wiki = false ) {
2569  return wfGetLB( $wiki )->getMaintenanceConnectionRef( $db, $groups, $wiki );
2570 }
2571 
2581 function wfGetLB( $wiki = false ) {
2582  if ( $wiki === false ) {
2583  return MediaWikiServices::getInstance()->getDBLoadBalancer();
2584  } else {
2585  $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2586  return $factory->getMainLB( $wiki );
2587  }
2588 }
2589 
2597 function wfFindFile( $title, $options = [] ) {
2598  return MediaWikiServices::getInstance()->getRepoGroup()->findFile( $title, $options );
2599 }
2600 
2609 function wfLocalFile( $title ) {
2610  return MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()->newFile( $title );
2611 }
2612 
2620  global $wgMiserMode;
2621  return $wgMiserMode
2622  || ( SiteStats::pages() > 100000
2623  && SiteStats::edits() > 1000000
2624  && SiteStats::users() > 10000 );
2625 }
2626 
2635 function wfScript( $script = 'index' ) {
2637  if ( $script === 'index' ) {
2638  return $wgScript;
2639  } elseif ( $script === 'load' ) {
2640  return $wgLoadScript;
2641  } else {
2642  return "{$wgScriptPath}/{$script}.php";
2643  }
2644 }
2645 
2651 function wfGetScriptUrl() {
2652  if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2653  /* as it was called, minus the query string.
2654  *
2655  * Some sites use Apache rewrite rules to handle subdomains,
2656  * and have PHP set up in a weird way that causes PHP_SELF
2657  * to contain the rewritten URL instead of the one that the
2658  * outside world sees.
2659  *
2660  * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2661  * provides containing the "before" URL.
2662  */
2663  return $_SERVER['SCRIPT_NAME'];
2664  } else {
2665  return $_SERVER['URL'];
2666  }
2667 }
2668 
2676 function wfBoolToStr( $value ) {
2677  return $value ? 'true' : 'false';
2678 }
2679 
2685 function wfGetNull() {
2686  return wfIsWindows() ? 'NUL' : '/dev/null';
2687 }
2688 
2712  $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2713 ) {
2714  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2715 
2716  if ( $cluster === '*' ) {
2717  $cluster = false;
2718  $domain = false;
2719  } elseif ( $wiki === false ) {
2720  $domain = $lbFactory->getLocalDomainID();
2721  } else {
2722  $domain = $wiki;
2723  }
2724 
2725  $opts = [
2726  'domain' => $domain,
2727  'cluster' => $cluster,
2728  // B/C: first argument used to be "max seconds of lag"; ignore such values
2729  'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
2730  ];
2731  if ( $timeout !== null ) {
2732  $opts['timeout'] = $timeout;
2733  }
2734 
2735  return $lbFactory->waitForReplication( $opts );
2736 }
2737 
2747  global $wgIllegalFileChars;
2748  $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
2749  $name = preg_replace(
2750  "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
2751  '-',
2752  $name
2753  );
2754  // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2755  $name = wfBaseName( $name );
2756  return $name;
2757 }
2758 
2764 function wfMemoryLimit( $newLimit ) {
2765  $oldLimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2766  // If the INI config is already unlimited, there is nothing larger
2767  if ( $oldLimit != -1 ) {
2768  $newLimit = wfShorthandToInteger( $newLimit );
2769  if ( $newLimit == -1 ) {
2770  wfDebug( "Removing PHP's memory limit\n" );
2771  Wikimedia\suppressWarnings();
2772  ini_set( 'memory_limit', $newLimit );
2773  Wikimedia\restoreWarnings();
2774  } elseif ( $newLimit > $oldLimit ) {
2775  wfDebug( "Raising PHP's memory limit to $newLimit bytes\n" );
2776  Wikimedia\suppressWarnings();
2777  ini_set( 'memory_limit', $newLimit );
2778  Wikimedia\restoreWarnings();
2779  }
2780  }
2781 }
2782 
2791 
2792  $timeLimit = ini_get( 'max_execution_time' );
2793  // Note that CLI scripts use 0
2794  if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2795  set_time_limit( $wgTransactionalTimeLimit );
2796  }
2797 
2798  ignore_user_abort( true ); // ignore client disconnects
2799 
2800  return $timeLimit;
2801 }
2802 
2810 function wfShorthandToInteger( $string = '', $default = -1 ) {
2811  $string = trim( $string );
2812  if ( $string === '' ) {
2813  return $default;
2814  }
2815  $last = $string[strlen( $string ) - 1];
2816  $val = intval( $string );
2817  switch ( $last ) {
2818  case 'g':
2819  case 'G':
2820  $val *= 1024;
2821  // break intentionally missing
2822  case 'm':
2823  case 'M':
2824  $val *= 1024;
2825  // break intentionally missing
2826  case 'k':
2827  case 'K':
2828  $val *= 1024;
2829  }
2830 
2831  return $val;
2832 }
2833 
2841 function wfGetCache( $cacheType ) {
2842  return ObjectCache::getInstance( $cacheType );
2843 }
2844 
2851 function wfGetMainCache() {
2853 }
2854 
2861  global $wgMessageCacheType;
2862  return ObjectCache::getInstance( $wgMessageCacheType );
2863 }
2864 
2879 function wfUnpack( $format, $data, $length = false ) {
2880  if ( $length !== false ) {
2881  $realLen = strlen( $data );
2882  if ( $realLen < $length ) {
2883  throw new MWException( "Tried to use wfUnpack on a "
2884  . "string of length $realLen, but needed one "
2885  . "of at least length $length."
2886  );
2887  }
2888  }
2889 
2890  Wikimedia\suppressWarnings();
2891  $result = unpack( $format, $data );
2892  Wikimedia\restoreWarnings();
2893 
2894  if ( $result === false ) {
2895  // If it cannot extract the packed data.
2896  throw new MWException( "unpack could not unpack binary data" );
2897  }
2898  return $result;
2899 }
2900 
2915 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
2916  # Handle redirects; callers almost always hit wfFindFile() anyway,
2917  # so just use that method because it has a fast process cache.
2918  $file = MediaWikiServices::getInstance()->getRepoGroup()->findFile( $name ); // get the final name
2919  $name = $file ? $file->getTitle()->getDBkey() : $name;
2920 
2921  # Run the extension hook
2922  $bad = false;
2923  if ( !Hooks::run( 'BadImage', [ $name, &$bad ] ) ) {
2924  return (bool)$bad;
2925  }
2926 
2928  $key = $cache->makeKey(
2929  'bad-image-list', ( $blacklist === null ) ? 'default' : md5( $blacklist )
2930  );
2931  $badImages = $cache->get( $key );
2932 
2933  if ( $badImages === false ) { // cache miss
2934  if ( $blacklist === null ) {
2935  $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
2936  }
2937  # Build the list now
2938  $badImages = [];
2939  $lines = explode( "\n", $blacklist );
2940  foreach ( $lines as $line ) {
2941  # List items only
2942  if ( substr( $line, 0, 1 ) !== '*' ) {
2943  continue;
2944  }
2945 
2946  # Find all links
2947  $m = [];
2948  if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
2949  continue;
2950  }
2951 
2952  $exceptions = [];
2953  $imageDBkey = false;
2954  foreach ( $m[1] as $i => $titleText ) {
2955  $title = Title::newFromText( $titleText );
2956  if ( !is_null( $title ) ) {
2957  if ( $i == 0 ) {
2958  $imageDBkey = $title->getDBkey();
2959  } else {
2960  $exceptions[$title->getPrefixedDBkey()] = true;
2961  }
2962  }
2963  }
2964 
2965  if ( $imageDBkey !== false ) {
2966  $badImages[$imageDBkey] = $exceptions;
2967  }
2968  }
2969  $cache->set( $key, $badImages, 60 );
2970  }
2971 
2972  $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
2973  $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
2974 
2975  return $bad;
2976 }
2977 
2985 function wfCanIPUseHTTPS( $ip ) {
2986  $canDo = true;
2987  Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
2988  return (bool)$canDo;
2989 }
2990 
2998 function wfIsInfinity( $str ) {
2999  // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3000  $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3001  return in_array( $str, $infinityValues );
3002 }
3003 
3018 function wfThumbIsStandard( File $file, array $params ) {
3020 
3021  $multipliers = [ 1 ];
3022  if ( $wgResponsiveImages ) {
3023  // These available sizes are hardcoded currently elsewhere in MediaWiki.
3024  // @see Linker::processResponsiveImages
3025  $multipliers[] = 1.5;
3026  $multipliers[] = 2;
3027  }
3028 
3029  $handler = $file->getHandler();
3030  if ( !$handler || !isset( $params['width'] ) ) {
3031  return false;
3032  }
3033 
3034  $basicParams = [];
3035  if ( isset( $params['page'] ) ) {
3036  $basicParams['page'] = $params['page'];
3037  }
3038 
3039  $thumbLimits = [];
3040  $imageLimits = [];
3041  // Expand limits to account for multipliers
3042  foreach ( $multipliers as $multiplier ) {
3043  $thumbLimits = array_merge( $thumbLimits, array_map(
3044  function ( $width ) use ( $multiplier ) {
3045  return round( $width * $multiplier );
3046  }, $wgThumbLimits )
3047  );
3048  $imageLimits = array_merge( $imageLimits, array_map(
3049  function ( $pair ) use ( $multiplier ) {
3050  return [
3051  round( $pair[0] * $multiplier ),
3052  round( $pair[1] * $multiplier ),
3053  ];
3054  }, $wgImageLimits )
3055  );
3056  }
3057 
3058  // Check if the width matches one of $wgThumbLimits
3059  if ( in_array( $params['width'], $thumbLimits ) ) {
3060  $normalParams = $basicParams + [ 'width' => $params['width'] ];
3061  // Append any default values to the map (e.g. "lossy", "lossless", ...)
3062  $handler->normaliseParams( $file, $normalParams );
3063  } else {
3064  // If not, then check if the width matchs one of $wgImageLimits
3065  $match = false;
3066  foreach ( $imageLimits as $pair ) {
3067  $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3068  // Decide whether the thumbnail should be scaled on width or height.
3069  // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3070  $handler->normaliseParams( $file, $normalParams );
3071  // Check if this standard thumbnail size maps to the given width
3072  if ( $normalParams['width'] == $params['width'] ) {
3073  $match = true;
3074  break;
3075  }
3076  }
3077  if ( !$match ) {
3078  return false; // not standard for description pages
3079  }
3080  }
3081 
3082  // Check that the given values for non-page, non-width, params are just defaults
3083  foreach ( $params as $key => $value ) {
3084  if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3085  return false;
3086  }
3087  }
3088 
3089  return true;
3090 }
3091 
3104 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3105  // First merge items that are in both arrays
3106  foreach ( $baseArray as $name => &$groupVal ) {
3107  if ( isset( $newValues[$name] ) ) {
3108  $groupVal += $newValues[$name];
3109  }
3110  }
3111  // Now add items that didn't exist yet
3112  $baseArray += $newValues;
3113 
3114  return $baseArray;
3115 }
3116 
3125 function wfGetRusage() {
3126  if ( !function_exists( 'getrusage' ) ) {
3127  return false;
3128  } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS === 'Linux' ) {
3129  return getrusage( 2 /* RUSAGE_THREAD */ );
3130  } else {
3131  return getrusage( 0 /* RUSAGE_SELF */ );
3132  }
3133 }
mimeTypeMatch( $type, $avail)
Checks if a given MIME type matches any of the keys in the given array.
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
wfBaseName( $path, $suffix='')
Return the final portion of a pathname.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
$wgDebugTimestamps
Prefix debug messages with relative timestamp.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:840
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1529
$wgScript
The URL path to index.php.
wfIsHHVM()
Check if we are running under HHVM.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
$IP
Definition: WebStart.php:41
$wgDebugLogGroups
Map of string log group names to log destinations.
wfLoadSkin( $skin, $path=null)
Load a skin.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1972
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
wfShellWikiCmd( $script, array $parameters=[], array $options=[])
Generate a shell-escaped command line string to run a MediaWiki cli script.
wfGetRusage()
Get system resource usage of current request context.
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the &#39;bad image list&#39;.
static instance()
Singleton.
Definition: Profiler.php:62
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfGetCache( $cacheType)
Get a specific cache object.
wfGetPrecompiledData( $name)
Get an object from the precompiled serialized directory.
$wgInternalServer
Internal server name as known to CDN, if different.
wfHostname()
Fetch server name for use in error reporting etc.
wfRecursiveRemoveDir( $dir)
Remove a directory and all its content.
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
$wgHttpsPort
For installations where the canonical server is HTTP but HTTPS is optionally supported, you can specify a non-standard HTTPS port here.
$wgOverrideHostname
Override server hostname detection with a hardcoded value.
wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult=null)
wfMerge attempts to merge differences between three texts.
wfLogProfilingData()
A formatter that outputs unified diffs.
$source
$value
wfForeignMemcKey( $db, $prefix,... $args)
Make a cache key for a foreign DB.
wfIsInfinity( $str)
Determine input string is represents as infinity.
const PROTO_CURRENT
Definition: Defines.php:202
wfStripIllegalFilenameChars( $name)
Replace all invalid characters with &#39;-&#39;.
static getInstance( $id)
Get a cached instance of the specified type of cache object.
Definition: ObjectCache.php:92
Stub profiler that does nothing.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message key
Definition: hooks.txt:2139
static getLocalClusterInstance()
Get the main cluster-local cache object.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
wfUrlProtocolsWithoutProtRel()
Like wfUrlProtocols(), but excludes &#39;//&#39; from the protocol list.
$wgUrlProtocols
URL schemes that should be recognized as valid by wfParseUrl().
$wgDisableOutputCompression
Disable output compression (enabled by default if zlib is available)
wfLogWarning( $msg, $callerOffset=1, $level=E_USER_WARNING)
Send a warning as a PHP error and the debug log.
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
$wgTmpDirectory
The local filesystem path to a temporary directory.
wfGetServerUrl( $proto)
Get the wiki&#39;s "server", i.e.
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
wfIsWindows()
Check if the operating system is Windows.
wfLocalFile( $title)
Get an object referring to a locally registered file.
wfGetMessageCacheStorage()
Get the cache object used by the message cache.
wfPercent( $nr, $acc=2, $round=true)
wfSetupSession( $sessionId=false)
Initialise php session.
wfLogDBError( $text, array $context=[])
Log for database errors.
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2205
wfVarDump( $var)
A wrapper around the PHP function var_export().
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. '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=(\*-\*)") 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. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1970
$wgEnableMagicLinks
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links...
if( $line===false) $args
Definition: cdb.php:64
static getUsableTempDirectory()
Definition: TempFSFile.php:85
$wgDebugRawPage
If true, log debugging data from action=raw and load.php.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:767
wfFormatStackFrame( $frame)
Return a string representation of frame.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:767
wfShellExec( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
$last
$wgPhpCli
Executable path of the PHP cli binary.
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
$wgLanguageCode
Site language code.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
static edits()
Definition: SiteStats.php:94
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit '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:1244
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$wgExtensionDirectory
Filesystem extensions directory.
wfLoadExtensions(array $exts)
Load multiple extensions at once.
wfIsDebugRawPage()
Returns true if debug logging should be suppressed if $wgDebugRawPage = false.
wfConfiguredReadOnlyReason()
Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
const PROTO_HTTPS
Definition: Defines.php:200
wfReportTime( $nonce=null)
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
wfRemoveDotSegments( $urlPath)
Remove all dot-segments in the provided URL path.
wfMergeErrorArrays(... $args)
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
wfReadOnly()
Check whether the wiki is in read-only mode.
wfSetBit(&$dest, $bit, $state=true)
As for wfSetVar except setting a bit.
wfMatchesDomainList( $url, $domains)
Check whether a given URL has a domain that occurs in a given set of domains.
wfIncrStats( $key, $count=1)
Increment a statistics counter.
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default.
$wgLang
Definition: Setup.php:922
wfTempDir()
Tries to get the system directory for temporary files.
wfClientAcceptsGzip( $force=false)
Whether the client accept gzip encoding.
static getMain()
Get the RequestContext object associated with the main request.
wfNegotiateType( $cprefs, $sprefs)
Returns the &#39;best&#39; match between a client&#39;s requested internet media types and the server&#39;s list of a...
static warning( $msg, $callerOffset=1, $level=E_USER_NOTICE, $log='auto')
Adds a warning entry to the log.
Definition: MWDebug.php:151
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
$wgIllegalFileChars
Additional characters that are not allowed in filenames.
const PROTO_INTERNAL
Definition: Defines.php:204
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
getHandler()
Get a MediaHandler instance for this file.
Definition: File.php:1388
wfFindFile( $title, $options=[])
Find a file.
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
$wgMessageCacheType
The cache type for storing the contents of the MediaWiki namespace.
$wgMiserMode
Disable database-intensive features.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static warnIfHeadersSent()
Log a warning message if headers have already been sent.
wfShowingResults( $offset, $limit)
wfMsgReplaceArgs( $message, $args)
Replace message parameter keys on the given formatted output.
static newFallbackSequence()
Factory function accepting multiple message keys and returning a message instance for the first messa...
Definition: Message.php:462
wfMessageFallback(... $keys)
This function accepts multiple message keys and returns a message instance for the first message whic...
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
static header( $code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
$wgImageLimits
Limit images on image description pages to a user-selectable limit.
Class representing a &#39;diff&#39; between two sequences of strings.
Definition: Diff.php:32
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
$cache
Definition: mcc.php:33
$params
static makeVariablesScript( $data, $nonce=null)
Definition: Skin.php:400
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1972
$wgThumbLimits
Adjust thumbnails on image pages according to a user setting.
unserialize( $serialized)
wfDiff( $before, $after, $params='-u')
Returns unified plain-text diff of two texts.
wfMemoryLimit( $newLimit)
Raise PHP&#39;s memory limit (if needed).
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
wfIsCLI()
Check if we are running from the commandline.
wfLoadSkins(array $skins)
Load multiple skins at once.
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:216
wfQueriesMustScale()
Should low-performance queries be disabled?
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition: hooks.txt:1972
wfDebugMem( $exact=false)
Send a line giving PHP memory usage.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:767
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
wfGlobalCacheKey(... $args)
Make a cache key with database-agnostic prefix.
const PROTO_HTTP
Definition: Defines.php:199
$wgDebugLogPrefix
Prefix for debug log lines.
wfArrayInsertAfter(array $array, array $insert, $after)
Insert array into another array after the specified KEY
$wgDiff3
Path to the GNU diff3 utility.
wfAssembleUrl( $urlParts)
This function will reassemble a URL parsed with wfParseURL.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
const PROTO_CANONICAL
Definition: Defines.php:203
wfRandom()
Get a random decimal value in the domain of [0, 1), in a way not likely to give duplicate values for ...
$lines
Definition: router.php:61
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
wfExpandIRI( $url)
Take a URL, make sure it&#39;s expanded to fully qualified, and replace any encoded non-ASCII Unicode cha...
$wgScriptPath
The path we should point to.
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don&#39;t exist.
static emitBufferedStatsdData(IBufferingStatsdDataFactory $stats, Config $config)
Send out any buffered statsd data according to sampling rules.
Definition: MediaWiki.php:960
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
wfGetMainCache()
Get the main cache object.
static pages()
Definition: SiteStats.php:112
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
$line
Definition: cdb.php:59
global $wgCommandLineMode
wfDebugBacktrace( $limit=0)
Safety wrapper for debug_backtrace().
$wgDBprefix
Table name prefix.
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
$wgStyleDirectory
Filesystem stylesheets directory.
wfClearOutputBuffers()
More legible than passing a &#39;false&#39; parameter to wfResetOutputBuffers():
if(!is_readable( $file)) $ext
Definition: router.php:48
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
wfTransactionalTimeLimit()
Set PHP&#39;s time limit to the larger of php.ini or $wgTransactionalTimeLimit.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2621
static deprecated( $function, $version=false, $component=false, $callerOffset=2)
Show a warning that $function is deprecated.
Definition: MWDebug.php:193
wfStringToBool( $val)
Convert string value to boolean, when the following are interpreted as true:
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
wfEscapeShellArg(... $args)
Version of escapeshellarg() that works better on Windows.
wfUnpack( $format, $data, $length=false)
Wrapper around php&#39;s unpack.
static legalChars()
Get a regex character class describing the legal characters in a link.
Definition: Title.php:703
wfMemcKey(... $args)
Make a cache key for the local wiki.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static getLocalServerInstance( $fallback=CACHE_NONE)
Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:776
$wgServer
URL of the server.
wfRelativePath( $path, $from)
Generate a relative path name to the given file.
$wgOut
Definition: Setup.php:927
wfCanIPUseHTTPS( $ip)
Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS...
wfBacktrace( $raw=null)
Get a debug backtrace as a string.
wfArrayDiff2( $a, $b)
Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a controlled by the following MediaWiki still creates a BagOStuff but calls it to it are no ops If the cache daemon can t be it should also disable itself fairly $wgDBname
Definition: memcached.txt:93
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
wfGetNull()
Get a platform-independent path to the null file, e.g.
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed)
Appends to second array if $value differs from that in $default.
wfArrayPlus2d(array $baseArray, array $newValues)
Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:61
wfAcceptToPrefs( $accept, $def=' */*')
Converts an Accept-* header into an array mapping string values to quality factors.
$wgResponsiveImages
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
wfLoadExtension( $ext, $path=null)
Load an extension.
$wgDiff
Path to the GNU diff utility.
$wgLoadScript
The URL path to load.php.
wfThumbIsStandard(File $file, array $params)
Returns true if these thumbnail parameters match one that MediaWiki requests from file description pa...
$wgDirectoryMode
Default value for chmoding of new directories.
wfGetLB( $wiki=false)
Get a load balancer object.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2621
wfArrayDiff2_cmp( $a, $b)
static users()
Definition: SiteStats.php:121
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
wfObjectToArray( $objOrArray, $recursive=true)
Recursively converts the parameter (an object) to an array with the same data.
wfGetScriptUrl()
Get the script URL.
$matches
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
$wgTransactionalTimeLimit
The minimum amount of time that MediaWiki needs for "slow" write request, particularly ones with mult...
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:322