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 
36 
47 function wfLoadExtension( $ext, $path = null ) {
48  if ( !$path ) {
49  global $wgExtensionDirectory;
50  $path = "$wgExtensionDirectory/$ext/extension.json";
51  }
53 }
54 
68 function wfLoadExtensions( array $exts ) {
69  global $wgExtensionDirectory;
70  $registry = ExtensionRegistry::getInstance();
71  foreach ( $exts as $ext ) {
72  $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
73  }
74 }
75 
84 function wfLoadSkin( $skin, $path = null ) {
85  if ( !$path ) {
86  global $wgStyleDirectory;
87  $path = "$wgStyleDirectory/$skin/skin.json";
88  }
90 }
91 
99 function wfLoadSkins( array $skins ) {
100  global $wgStyleDirectory;
101  $registry = ExtensionRegistry::getInstance();
102  foreach ( $skins as $skin ) {
103  $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
104  }
105 }
106 
113 function wfArrayDiff2( $a, $b ) {
114  return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
115 }
116 
122 function wfArrayDiff2_cmp( $a, $b ) {
123  if ( is_string( $a ) && is_string( $b ) ) {
124  return strcmp( $a, $b );
125  } elseif ( count( $a ) !== count( $b ) ) {
126  return count( $a ) <=> count( $b );
127  } else {
128  reset( $a );
129  reset( $b );
130  while ( key( $a ) !== null && key( $b ) !== null ) {
131  $valueA = current( $a );
132  $valueB = current( $b );
133  $cmp = strcmp( $valueA, $valueB );
134  if ( $cmp !== 0 ) {
135  return $cmp;
136  }
137  next( $a );
138  next( $b );
139  }
140  return 0;
141  }
142 }
143 
153 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
154  if ( is_null( $changed ) ) {
155  throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
156  }
157  if ( $default[$key] !== $value ) {
158  $changed[$key] = $value;
159  }
160 }
161 
181 function wfMergeErrorArrays( ...$args ) {
182  $out = [];
183  foreach ( $args as $errors ) {
184  foreach ( $errors as $params ) {
185  $originalParams = $params;
186  if ( $params[0] instanceof MessageSpecifier ) {
187  $msg = $params[0];
188  $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
189  }
190  # @todo FIXME: Sometimes get nested arrays for $params,
191  # which leads to E_NOTICEs
192  $spec = implode( "\t", $params );
193  $out[$spec] = $originalParams;
194  }
195  }
196  return array_values( $out );
197 }
198 
207 function wfArrayInsertAfter( array $array, array $insert, $after ) {
208  // Find the offset of the element to insert after.
209  $keys = array_keys( $array );
210  $offsetByKey = array_flip( $keys );
211 
212  $offset = $offsetByKey[$after];
213 
214  // Insert at the specified offset
215  $before = array_slice( $array, 0, $offset + 1, true );
216  $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
217 
218  $output = $before + $insert + $after;
219 
220  return $output;
221 }
222 
230 function wfObjectToArray( $objOrArray, $recursive = true ) {
231  $array = [];
232  if ( is_object( $objOrArray ) ) {
233  $objOrArray = get_object_vars( $objOrArray );
234  }
235  foreach ( $objOrArray as $key => $value ) {
236  if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
238  }
239 
240  $array[$key] = $value;
241  }
242 
243  return $array;
244 }
245 
256 function wfRandom() {
257  // The maximum random value is "only" 2^31-1, so get two random
258  // values to reduce the chance of dupes
259  $max = mt_getrandmax() + 1;
260  $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
261  return $rand;
262 }
263 
274 function wfRandomString( $length = 32 ) {
275  $str = '';
276  for ( $n = 0; $n < $length; $n += 7 ) {
277  $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
278  }
279  return substr( $str, 0, $length );
280 }
281 
309 function wfUrlencode( $s ) {
310  static $needle;
311 
312  if ( is_null( $s ) ) {
313  // Reset $needle for testing.
314  $needle = null;
315  return '';
316  }
317 
318  if ( is_null( $needle ) ) {
319  $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
320  if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
321  ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
322  ) {
323  $needle[] = '%3A';
324  }
325  }
326 
327  $s = urlencode( $s );
328  $s = str_ireplace(
329  $needle,
330  [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
331  $s
332  );
333 
334  return $s;
335 }
336 
347 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
348  if ( !is_null( $array2 ) ) {
349  $array1 = $array1 + $array2;
350  }
351 
352  $cgi = '';
353  foreach ( $array1 as $key => $value ) {
354  if ( !is_null( $value ) && $value !== false ) {
355  if ( $cgi != '' ) {
356  $cgi .= '&';
357  }
358  if ( $prefix !== '' ) {
359  $key = $prefix . "[$key]";
360  }
361  if ( is_array( $value ) ) {
362  $firstTime = true;
363  foreach ( $value as $k => $v ) {
364  $cgi .= $firstTime ? '' : '&';
365  if ( is_array( $v ) ) {
366  $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
367  } else {
368  $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
369  }
370  $firstTime = false;
371  }
372  } else {
373  if ( is_object( $value ) ) {
374  $value = $value->__toString();
375  }
376  $cgi .= urlencode( $key ) . '=' . urlencode( $value );
377  }
378  }
379  }
380  return $cgi;
381 }
382 
392 function wfCgiToArray( $query ) {
393  if ( isset( $query[0] ) && $query[0] == '?' ) {
394  $query = substr( $query, 1 );
395  }
396  $bits = explode( '&', $query );
397  $ret = [];
398  foreach ( $bits as $bit ) {
399  if ( $bit === '' ) {
400  continue;
401  }
402  if ( strpos( $bit, '=' ) === false ) {
403  // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
404  $key = $bit;
405  $value = '';
406  } else {
407  list( $key, $value ) = explode( '=', $bit );
408  }
409  $key = urldecode( $key );
410  $value = urldecode( $value );
411  if ( strpos( $key, '[' ) !== false ) {
412  $keys = array_reverse( explode( '[', $key ) );
413  $key = array_pop( $keys );
414  $temp = $value;
415  foreach ( $keys as $k ) {
416  $k = substr( $k, 0, -1 );
417  $temp = [ $k => $temp ];
418  }
419  if ( isset( $ret[$key] ) ) {
420  $ret[$key] = array_merge( $ret[$key], $temp );
421  } else {
422  $ret[$key] = $temp;
423  }
424  } else {
425  $ret[$key] = $value;
426  }
427  }
428  return $ret;
429 }
430 
439 function wfAppendQuery( $url, $query ) {
440  if ( is_array( $query ) ) {
442  }
443  if ( $query != '' ) {
444  // Remove the fragment, if there is one
445  $fragment = false;
446  $hashPos = strpos( $url, '#' );
447  if ( $hashPos !== false ) {
448  $fragment = substr( $url, $hashPos );
449  $url = substr( $url, 0, $hashPos );
450  }
451 
452  // Add parameter
453  if ( strpos( $url, '?' ) === false ) {
454  $url .= '?';
455  } else {
456  $url .= '&';
457  }
458  $url .= $query;
459 
460  // Put the fragment back
461  if ( $fragment !== false ) {
462  $url .= $fragment;
463  }
464  }
465  return $url;
466 }
467 
491 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
493  $wgHttpsPort;
494  if ( $defaultProto === PROTO_CANONICAL ) {
495  $serverUrl = $wgCanonicalServer;
496  } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
497  // Make $wgInternalServer fall back to $wgServer if not set
498  $serverUrl = $wgInternalServer;
499  } else {
500  $serverUrl = $wgServer;
501  if ( $defaultProto === PROTO_CURRENT ) {
502  $defaultProto = $wgRequest->getProtocol() . '://';
503  }
504  }
505 
506  // Analyze $serverUrl to obtain its protocol
507  $bits = wfParseUrl( $serverUrl );
508  $serverHasProto = $bits && $bits['scheme'] != '';
509 
510  if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
511  if ( $serverHasProto ) {
512  $defaultProto = $bits['scheme'] . '://';
513  } else {
514  // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
515  // This really isn't supposed to happen. Fall back to HTTP in this
516  // ridiculous case.
517  $defaultProto = PROTO_HTTP;
518  }
519  }
520 
521  $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
522 
523  if ( substr( $url, 0, 2 ) == '//' ) {
524  $url = $defaultProtoWithoutSlashes . $url;
525  } elseif ( substr( $url, 0, 1 ) == '/' ) {
526  // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
527  // otherwise leave it alone.
528  if ( $serverHasProto ) {
529  $url = $serverUrl . $url;
530  } else {
531  // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
532  // user to override the port number (T67184)
533  if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
534  if ( isset( $bits['port'] ) ) {
535  throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
536  }
537  $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
538  } else {
539  $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
540  }
541  }
542  }
543 
544  $bits = wfParseUrl( $url );
545 
546  if ( $bits && isset( $bits['path'] ) ) {
547  $bits['path'] = wfRemoveDotSegments( $bits['path'] );
548  return wfAssembleUrl( $bits );
549  } elseif ( $bits ) {
550  # No path to expand
551  return $url;
552  } elseif ( substr( $url, 0, 1 ) != '/' ) {
553  # URL is a relative path
554  return wfRemoveDotSegments( $url );
555  }
556 
557  # Expanded URL is not valid.
558  return false;
559 }
560 
569 function wfGetServerUrl( $proto ) {
570  $url = wfExpandUrl( '/', $proto );
571  return substr( $url, 0, -1 );
572 }
573 
587 function wfAssembleUrl( $urlParts ) {
588  $result = '';
589 
590  if ( isset( $urlParts['delimiter'] ) ) {
591  if ( isset( $urlParts['scheme'] ) ) {
592  $result .= $urlParts['scheme'];
593  }
594 
595  $result .= $urlParts['delimiter'];
596  }
597 
598  if ( isset( $urlParts['host'] ) ) {
599  if ( isset( $urlParts['user'] ) ) {
600  $result .= $urlParts['user'];
601  if ( isset( $urlParts['pass'] ) ) {
602  $result .= ':' . $urlParts['pass'];
603  }
604  $result .= '@';
605  }
606 
607  $result .= $urlParts['host'];
608 
609  if ( isset( $urlParts['port'] ) ) {
610  $result .= ':' . $urlParts['port'];
611  }
612  }
613 
614  if ( isset( $urlParts['path'] ) ) {
615  $result .= $urlParts['path'];
616  }
617 
618  if ( isset( $urlParts['query'] ) ) {
619  $result .= '?' . $urlParts['query'];
620  }
621 
622  if ( isset( $urlParts['fragment'] ) ) {
623  $result .= '#' . $urlParts['fragment'];
624  }
625 
626  return $result;
627 }
628 
641 function wfRemoveDotSegments( $urlPath ) {
642  $output = '';
643  $inputOffset = 0;
644  $inputLength = strlen( $urlPath );
645 
646  while ( $inputOffset < $inputLength ) {
647  $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
648  $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
649  $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
650  $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
651  $trimOutput = false;
652 
653  if ( $prefixLengthTwo == './' ) {
654  # Step A, remove leading "./"
655  $inputOffset += 2;
656  } elseif ( $prefixLengthThree == '../' ) {
657  # Step A, remove leading "../"
658  $inputOffset += 3;
659  } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
660  # Step B, replace leading "/.$" with "/"
661  $inputOffset += 1;
662  $urlPath[$inputOffset] = '/';
663  } elseif ( $prefixLengthThree == '/./' ) {
664  # Step B, replace leading "/./" with "/"
665  $inputOffset += 2;
666  } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
667  # Step C, replace leading "/..$" with "/" and
668  # remove last path component in output
669  $inputOffset += 2;
670  $urlPath[$inputOffset] = '/';
671  $trimOutput = true;
672  } elseif ( $prefixLengthFour == '/../' ) {
673  # Step C, replace leading "/../" with "/" and
674  # remove last path component in output
675  $inputOffset += 3;
676  $trimOutput = true;
677  } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
678  # Step D, remove "^.$"
679  $inputOffset += 1;
680  } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
681  # Step D, remove "^..$"
682  $inputOffset += 2;
683  } else {
684  # Step E, move leading path segment to output
685  if ( $prefixLengthOne == '/' ) {
686  $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
687  } else {
688  $slashPos = strpos( $urlPath, '/', $inputOffset );
689  }
690  if ( $slashPos === false ) {
691  $output .= substr( $urlPath, $inputOffset );
692  $inputOffset = $inputLength;
693  } else {
694  $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
695  $inputOffset += $slashPos - $inputOffset;
696  }
697  }
698 
699  if ( $trimOutput ) {
700  $slashPos = strrpos( $output, '/' );
701  if ( $slashPos === false ) {
702  $output = '';
703  } else {
704  $output = substr( $output, 0, $slashPos );
705  }
706  }
707  }
708 
709  return $output;
710 }
711 
719 function wfUrlProtocols( $includeProtocolRelative = true ) {
720  global $wgUrlProtocols;
721 
722  // Cache return values separately based on $includeProtocolRelative
723  static $withProtRel = null, $withoutProtRel = null;
724  $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
725  if ( !is_null( $cachedValue ) ) {
726  return $cachedValue;
727  }
728 
729  // Support old-style $wgUrlProtocols strings, for backwards compatibility
730  // with LocalSettings files from 1.5
731  if ( is_array( $wgUrlProtocols ) ) {
732  $protocols = [];
733  foreach ( $wgUrlProtocols as $protocol ) {
734  // Filter out '//' if !$includeProtocolRelative
735  if ( $includeProtocolRelative || $protocol !== '//' ) {
736  $protocols[] = preg_quote( $protocol, '/' );
737  }
738  }
739 
740  $retval = implode( '|', $protocols );
741  } else {
742  // Ignore $includeProtocolRelative in this case
743  // This case exists for pre-1.6 compatibility, and we can safely assume
744  // that '//' won't appear in a pre-1.6 config because protocol-relative
745  // URLs weren't supported until 1.18
746  $retval = $wgUrlProtocols;
747  }
748 
749  // Cache return value
750  if ( $includeProtocolRelative ) {
751  $withProtRel = $retval;
752  } else {
753  $withoutProtRel = $retval;
754  }
755  return $retval;
756 }
757 
765  return wfUrlProtocols( false );
766 }
767 
793 function wfParseUrl( $url ) {
794  global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
795 
796  // Protocol-relative URLs are handled really badly by parse_url(). It's so
797  // bad that the easiest way to handle them is to just prepend 'http:' and
798  // strip the protocol out later.
799  $wasRelative = substr( $url, 0, 2 ) == '//';
800  if ( $wasRelative ) {
801  $url = "http:$url";
802  }
803  AtEase::suppressWarnings();
804  $bits = parse_url( $url );
805  AtEase::restoreWarnings();
806  // parse_url() returns an array without scheme for some invalid URLs, e.g.
807  // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
808  if ( !$bits || !isset( $bits['scheme'] ) ) {
809  return false;
810  }
811 
812  // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
813  $bits['scheme'] = strtolower( $bits['scheme'] );
814 
815  // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
816  if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
817  $bits['delimiter'] = '://';
818  } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
819  $bits['delimiter'] = ':';
820  // parse_url detects for news: and mailto: the host part of an url as path
821  // We have to correct this wrong detection
822  if ( isset( $bits['path'] ) ) {
823  $bits['host'] = $bits['path'];
824  $bits['path'] = '';
825  }
826  } else {
827  return false;
828  }
829 
830  /* Provide an empty host for eg. file:/// urls (see T30627) */
831  if ( !isset( $bits['host'] ) ) {
832  $bits['host'] = '';
833 
834  // See T47069
835  if ( isset( $bits['path'] ) ) {
836  /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
837  if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
838  $bits['path'] = '/' . $bits['path'];
839  }
840  } else {
841  $bits['path'] = '';
842  }
843  }
844 
845  // If the URL was protocol-relative, fix scheme and delimiter
846  if ( $wasRelative ) {
847  $bits['scheme'] = '';
848  $bits['delimiter'] = '//';
849  }
850  return $bits;
851 }
852 
863 function wfExpandIRI( $url ) {
864  return preg_replace_callback(
865  '/((?:%[89A-F][0-9A-F])+)/i',
866  function ( array $matches ) {
867  return urldecode( $matches[1] );
868  },
869  wfExpandUrl( $url )
870  );
871 }
872 
879 function wfMatchesDomainList( $url, $domains ) {
880  $bits = wfParseUrl( $url );
881  if ( is_array( $bits ) && isset( $bits['host'] ) ) {
882  $host = '.' . $bits['host'];
883  foreach ( (array)$domains as $domain ) {
884  $domain = '.' . $domain;
885  if ( substr( $host, -strlen( $domain ) ) === $domain ) {
886  return true;
887  }
888  }
889  }
890  return false;
891 }
892 
913 function wfDebug( $text, $dest = 'all', array $context = [] ) {
915  global $wgDebugTimestamps;
916 
917  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
918  return;
919  }
920 
921  $text = trim( $text );
922 
923  if ( $wgDebugTimestamps ) {
924  $context['seconds_elapsed'] = sprintf(
925  '%6.4f',
926  microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
927  );
928  $context['memory_used'] = sprintf(
929  '%5.1fM',
930  ( memory_get_usage( true ) / ( 1024 * 1024 ) )
931  );
932  }
933 
934  if ( $wgDebugLogPrefix !== '' ) {
935  $context['prefix'] = $wgDebugLogPrefix;
936  }
937  $context['private'] = ( $dest === false || $dest === 'private' );
938 
939  $logger = LoggerFactory::getInstance( 'wfDebug' );
940  $logger->debug( $text, $context );
941 }
942 
947 function wfIsDebugRawPage() {
948  static $cache;
949  if ( $cache !== null ) {
950  return $cache;
951  }
952  // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
953  // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
954  if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
955  || (
956  isset( $_SERVER['SCRIPT_NAME'] )
957  && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
958  )
959  ) {
960  $cache = true;
961  } else {
962  $cache = false;
963  }
964  return $cache;
965 }
966 
972 function wfDebugMem( $exact = false ) {
973  $mem = memory_get_usage();
974  if ( !$exact ) {
975  $mem = floor( $mem / 1024 ) . ' KiB';
976  } else {
977  $mem .= ' B';
978  }
979  wfDebug( "Memory usage: $mem\n" );
980 }
981 
1007 function wfDebugLog(
1008  $logGroup, $text, $dest = 'all', array $context = []
1009 ) {
1010  $text = trim( $text );
1011 
1012  $logger = LoggerFactory::getInstance( $logGroup );
1013  $context['private'] = ( $dest === false || $dest === 'private' );
1014  $logger->info( $text, $context );
1015 }
1016 
1025 function wfLogDBError( $text, array $context = [] ) {
1026  $logger = LoggerFactory::getInstance( 'wfLogDBError' );
1027  $logger->error( trim( $text ), $context );
1028 }
1029 
1042 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1043  MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1044 }
1045 
1056 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1057  MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1058 }
1059 
1069 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1070  MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1071 }
1072 
1079 
1081  $request = $context->getRequest();
1082 
1083  $profiler = Profiler::instance();
1084  $profiler->setContext( $context );
1085  $profiler->logData();
1086 
1087  // Send out any buffered statsd metrics as needed
1089  MediaWikiServices::getInstance()->getStatsdDataFactory(),
1090  $context->getConfig()
1091  );
1092 
1093  // Profiling must actually be enabled...
1094  if ( $profiler instanceof ProfilerStub ) {
1095  return;
1096  }
1097 
1098  if ( isset( $wgDebugLogGroups['profileoutput'] )
1099  && $wgDebugLogGroups['profileoutput'] === false
1100  ) {
1101  // Explicitly disabled
1102  return;
1103  }
1104  if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1105  return;
1106  }
1107 
1108  $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1109  if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1110  $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1111  }
1112  if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1113  $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1114  }
1115  if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1116  $ctx['from'] = $_SERVER['HTTP_FROM'];
1117  }
1118  if ( isset( $ctx['forwarded_for'] ) ||
1119  isset( $ctx['client_ip'] ) ||
1120  isset( $ctx['from'] ) ) {
1121  $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1122  }
1123 
1124  // Don't load $wgUser at this late stage just for statistics purposes
1125  // @todo FIXME: We can detect some anons even if it is not loaded.
1126  // See User::getId()
1127  $user = $context->getUser();
1128  $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1129 
1130  // Command line script uses a FauxRequest object which does not have
1131  // any knowledge about an URL and throw an exception instead.
1132  try {
1133  $ctx['url'] = urldecode( $request->getRequestURL() );
1134  } catch ( Exception $ignored ) {
1135  // no-op
1136  }
1137 
1138  $ctx['output'] = $profiler->getOutput();
1139 
1140  $log = LoggerFactory::getInstance( 'profileoutput' );
1141  $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1142 }
1143 
1151 function wfIncrStats( $key, $count = 1 ) {
1152  $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1153  $stats->updateCount( $key, $count );
1154 }
1155 
1161 function wfReadOnly() {
1162  return MediaWikiServices::getInstance()->getReadOnlyMode()
1163  ->isReadOnly();
1164 }
1165 
1174 function wfReadOnlyReason() {
1175  return MediaWikiServices::getInstance()->getReadOnlyMode()
1176  ->getReason();
1177 }
1178 
1186  return MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1187  ->getReason();
1188 }
1189 
1205 function wfGetLangObj( $langcode = false ) {
1206  # Identify which language to get or create a language object for.
1207  # Using is_object here due to Stub objects.
1208  if ( is_object( $langcode ) ) {
1209  # Great, we already have the object (hopefully)!
1210  return $langcode;
1211  }
1212 
1213  global $wgLanguageCode;
1214  if ( $langcode === true || $langcode === $wgLanguageCode ) {
1215  # $langcode is the language code of the wikis content language object.
1216  # or it is a boolean and value is true
1217  return MediaWikiServices::getInstance()->getContentLanguage();
1218  }
1219 
1220  global $wgLang;
1221  if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1222  # $langcode is the language code of user language object.
1223  # or it was a boolean and value is false
1224  return $wgLang;
1225  }
1226 
1227  $validCodes = array_keys( Language::fetchLanguageNames() );
1228  if ( in_array( $langcode, $validCodes ) ) {
1229  # $langcode corresponds to a valid language.
1230  return Language::factory( $langcode );
1231  }
1232 
1233  # $langcode is a string, but not a valid language code; use content language.
1234  wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1235  return MediaWikiServices::getInstance()->getContentLanguage();
1236 }
1237 
1254 function wfMessage( $key, ...$params ) {
1255  $message = new Message( $key );
1256 
1257  // We call Message::params() to reduce code duplication
1258  if ( $params ) {
1259  $message->params( ...$params );
1260  }
1261 
1262  return $message;
1263 }
1264 
1277 function wfMessageFallback( ...$keys ) {
1278  return Message::newFallbackSequence( ...$keys );
1279 }
1280 
1289 function wfMsgReplaceArgs( $message, $args ) {
1290  # Fix windows line-endings
1291  # Some messages are split with explode("\n", $msg)
1292  $message = str_replace( "\r", '', $message );
1293 
1294  // Replace arguments
1295  if ( is_array( $args ) && $args ) {
1296  if ( is_array( $args[0] ) ) {
1297  $args = array_values( $args[0] );
1298  }
1299  $replacementKeys = [];
1300  foreach ( $args as $n => $param ) {
1301  $replacementKeys['$' . ( $n + 1 )] = $param;
1302  }
1303  $message = strtr( $message, $replacementKeys );
1304  }
1305 
1306  return $message;
1307 }
1308 
1316 function wfHostname() {
1317  static $host;
1318  if ( is_null( $host ) ) {
1319  # Hostname overriding
1320  global $wgOverrideHostname;
1321  if ( $wgOverrideHostname !== false ) {
1322  # Set static and skip any detection
1323  $host = $wgOverrideHostname;
1324  return $host;
1325  }
1326 
1327  if ( function_exists( 'posix_uname' ) ) {
1328  // This function not present on Windows
1329  $uname = posix_uname();
1330  } else {
1331  $uname = false;
1332  }
1333  if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1334  $host = $uname['nodename'];
1335  } elseif ( getenv( 'COMPUTERNAME' ) ) {
1336  # Windows computer name
1337  $host = getenv( 'COMPUTERNAME' );
1338  } else {
1339  # This may be a virtual server.
1340  $host = $_SERVER['SERVER_NAME'];
1341  }
1342  }
1343  return $host;
1344 }
1345 
1356 function wfReportTime( $nonce = null ) {
1357  global $wgShowHostnames;
1358 
1359  $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1360  // seconds to milliseconds
1361  $responseTime = round( $elapsed * 1000 );
1362  $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1363  if ( $wgShowHostnames ) {
1364  $reportVars['wgHostname'] = wfHostname();
1365  }
1366  return Skin::makeVariablesScript( $reportVars, $nonce );
1367 }
1368 
1379 function wfDebugBacktrace( $limit = 0 ) {
1380  static $disabled = null;
1381 
1382  if ( is_null( $disabled ) ) {
1383  $disabled = !function_exists( 'debug_backtrace' );
1384  if ( $disabled ) {
1385  wfDebug( "debug_backtrace() is disabled\n" );
1386  }
1387  }
1388  if ( $disabled ) {
1389  return [];
1390  }
1391 
1392  if ( $limit ) {
1393  return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1394  } else {
1395  return array_slice( debug_backtrace(), 1 );
1396  }
1397 }
1398 
1407 function wfBacktrace( $raw = null ) {
1408  global $wgCommandLineMode;
1409 
1410  if ( $raw === null ) {
1411  $raw = $wgCommandLineMode;
1412  }
1413 
1414  if ( $raw ) {
1415  $frameFormat = "%s line %s calls %s()\n";
1416  $traceFormat = "%s";
1417  } else {
1418  $frameFormat = "<li>%s line %s calls %s()</li>\n";
1419  $traceFormat = "<ul>\n%s</ul>\n";
1420  }
1421 
1422  $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1423  $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1424  $line = $frame['line'] ?? '-';
1425  $call = $frame['function'];
1426  if ( !empty( $frame['class'] ) ) {
1427  $call = $frame['class'] . $frame['type'] . $call;
1428  }
1429  return sprintf( $frameFormat, $file, $line, $call );
1430  }, wfDebugBacktrace() );
1431 
1432  return sprintf( $traceFormat, implode( '', $frames ) );
1433 }
1434 
1444 function wfGetCaller( $level = 2 ) {
1445  $backtrace = wfDebugBacktrace( $level + 1 );
1446  if ( isset( $backtrace[$level] ) ) {
1447  return wfFormatStackFrame( $backtrace[$level] );
1448  } else {
1449  return 'unknown';
1450  }
1451 }
1452 
1460 function wfGetAllCallers( $limit = 3 ) {
1461  $trace = array_reverse( wfDebugBacktrace() );
1462  if ( !$limit || $limit > count( $trace ) - 1 ) {
1463  $limit = count( $trace ) - 1;
1464  }
1465  $trace = array_slice( $trace, -$limit - 1, $limit );
1466  return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1467 }
1468 
1475 function wfFormatStackFrame( $frame ) {
1476  if ( !isset( $frame['function'] ) ) {
1477  return 'NO_FUNCTION_GIVEN';
1478  }
1479  return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1480  $frame['class'] . $frame['type'] . $frame['function'] :
1481  $frame['function'];
1482 }
1483 
1484 /* Some generic result counters, pulled out of SearchEngine */
1485 
1493 function wfShowingResults( $offset, $limit ) {
1494  return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1495 }
1496 
1506 function wfClientAcceptsGzip( $force = false ) {
1507  static $result = null;
1508  if ( $result === null || $force ) {
1509  $result = false;
1510  if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1511  # @todo FIXME: We may want to blacklist some broken browsers
1512  $m = [];
1513  if ( preg_match(
1514  '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1515  $_SERVER['HTTP_ACCEPT_ENCODING'],
1516  $m
1517  )
1518  ) {
1519  if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1520  $result = false;
1521  return $result;
1522  }
1523  wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1524  $result = true;
1525  }
1526  }
1527  }
1528  return $result;
1529 }
1530 
1541 function wfEscapeWikiText( $text ) {
1542  global $wgEnableMagicLinks;
1543  static $repl = null, $repl2 = null;
1544  if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1545  // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1546  // in those situations
1547  $repl = [
1548  '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1549  '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1550  '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1551  "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1552  "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1553  "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1554  "\n " => "\n&#32;", "\r " => "\r&#32;",
1555  "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1556  "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1557  "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1558  "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1559  '__' => '_&#95;', '://' => '&#58;//',
1560  ];
1561 
1562  $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1563  // We have to catch everything "\s" matches in PCRE
1564  foreach ( $magicLinks as $magic ) {
1565  $repl["$magic "] = "$magic&#32;";
1566  $repl["$magic\t"] = "$magic&#9;";
1567  $repl["$magic\r"] = "$magic&#13;";
1568  $repl["$magic\n"] = "$magic&#10;";
1569  $repl["$magic\f"] = "$magic&#12;";
1570  }
1571 
1572  // And handle protocols that don't use "://"
1573  global $wgUrlProtocols;
1574  $repl2 = [];
1575  foreach ( $wgUrlProtocols as $prot ) {
1576  if ( substr( $prot, -1 ) === ':' ) {
1577  $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1578  }
1579  }
1580  $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1581  }
1582  $text = substr( strtr( "\n$text", $repl ), 1 );
1583  $text = preg_replace( $repl2, '$1&#58;', $text );
1584  return $text;
1585 }
1586 
1597 function wfSetVar( &$dest, $source, $force = false ) {
1598  $temp = $dest;
1599  if ( !is_null( $source ) || $force ) {
1600  $dest = $source;
1601  }
1602  return $temp;
1603 }
1604 
1614 function wfSetBit( &$dest, $bit, $state = true ) {
1615  $temp = (bool)( $dest & $bit );
1616  if ( !is_null( $state ) ) {
1617  if ( $state ) {
1618  $dest |= $bit;
1619  } else {
1620  $dest &= ~$bit;
1621  }
1622  }
1623  return $temp;
1624 }
1625 
1632 function wfVarDump( $var ) {
1633  global $wgOut;
1634  $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1635  if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1636  print $s;
1637  } else {
1638  $wgOut->addHTML( $s );
1639  }
1640 }
1641 
1649 function wfHttpError( $code, $label, $desc ) {
1650  global $wgOut;
1652  if ( $wgOut ) {
1653  $wgOut->disable();
1654  $wgOut->sendCacheControl();
1655  }
1656 
1658  header( 'Content-type: text/html; charset=utf-8' );
1659  print '<!DOCTYPE html>' .
1660  '<html><head><title>' .
1661  htmlspecialchars( $label ) .
1662  '</title></head><body><h1>' .
1663  htmlspecialchars( $label ) .
1664  '</h1><p>' .
1665  nl2br( htmlspecialchars( $desc ) ) .
1666  "</p></body></html>\n";
1667 }
1668 
1686 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1687  if ( $resetGzipEncoding ) {
1688  // Suppress Content-Encoding and Content-Length
1689  // headers from OutputHandler::handle.
1691  $wgDisableOutputCompression = true;
1692  }
1693  while ( $status = ob_get_status() ) {
1694  if ( isset( $status['flags'] ) ) {
1695  $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1696  $deleteable = ( $status['flags'] & $flags ) === $flags;
1697  } elseif ( isset( $status['del'] ) ) {
1698  $deleteable = $status['del'];
1699  } else {
1700  // Guess that any PHP-internal setting can't be removed.
1701  $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1702  }
1703  if ( !$deleteable ) {
1704  // Give up, and hope the result doesn't break
1705  // output behavior.
1706  break;
1707  }
1708  if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1709  // Unit testing barrier to prevent this function from breaking PHPUnit.
1710  break;
1711  }
1712  if ( !ob_end_clean() ) {
1713  // Could not remove output buffer handler; abort now
1714  // to avoid getting in some kind of infinite loop.
1715  break;
1716  }
1717  if ( $resetGzipEncoding && $status['name'] == 'ob_gzhandler' ) {
1718  // Reset the 'Content-Encoding' field set by this handler
1719  // so we can start fresh.
1720  header_remove( 'Content-Encoding' );
1721  break;
1722  }
1723  }
1724 }
1725 
1739  wfResetOutputBuffers( false );
1740 }
1741 
1750 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1751  # No arg means accept anything (per HTTP spec)
1752  if ( !$accept ) {
1753  return [ $def => 1.0 ];
1754  }
1755 
1756  $prefs = [];
1757 
1758  $parts = explode( ',', $accept );
1759 
1760  foreach ( $parts as $part ) {
1761  # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1762  $values = explode( ';', trim( $part ) );
1763  $match = [];
1764  if ( count( $values ) == 1 ) {
1765  $prefs[$values[0]] = 1.0;
1766  } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1767  $prefs[$values[0]] = floatval( $match[1] );
1768  }
1769  }
1770 
1771  return $prefs;
1772 }
1773 
1786 function mimeTypeMatch( $type, $avail ) {
1787  if ( array_key_exists( $type, $avail ) ) {
1788  return $type;
1789  } else {
1790  $mainType = explode( '/', $type )[0];
1791  if ( array_key_exists( "$mainType/*", $avail ) ) {
1792  return "$mainType/*";
1793  } elseif ( array_key_exists( '*/*', $avail ) ) {
1794  return '*/*';
1795  } else {
1796  return null;
1797  }
1798  }
1799 }
1800 
1814 function wfNegotiateType( $cprefs, $sprefs ) {
1815  $combine = [];
1816 
1817  foreach ( array_keys( $sprefs ) as $type ) {
1818  $subType = explode( '/', $type )[1];
1819  if ( $subType != '*' ) {
1820  $ckey = mimeTypeMatch( $type, $cprefs );
1821  if ( $ckey ) {
1822  $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1823  }
1824  }
1825  }
1826 
1827  foreach ( array_keys( $cprefs ) as $type ) {
1828  $subType = explode( '/', $type )[1];
1829  if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1830  $skey = mimeTypeMatch( $type, $sprefs );
1831  if ( $skey ) {
1832  $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1833  }
1834  }
1835  }
1836 
1837  $bestq = 0;
1838  $besttype = null;
1839 
1840  foreach ( array_keys( $combine ) as $type ) {
1841  if ( $combine[$type] > $bestq ) {
1842  $besttype = $type;
1843  $bestq = $combine[$type];
1844  }
1845  }
1846 
1847  return $besttype;
1848 }
1849 
1858 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1859  $ret = MWTimestamp::convert( $outputtype, $ts );
1860  if ( $ret === false ) {
1861  wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1862  }
1863  return $ret;
1864 }
1865 
1874 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1875  if ( is_null( $ts ) ) {
1876  return null;
1877  } else {
1878  return wfTimestamp( $outputtype, $ts );
1879  }
1880 }
1881 
1887 function wfTimestampNow() {
1888  # return NOW
1889  return MWTimestamp::now( TS_MW );
1890 }
1891 
1897 function wfIsWindows() {
1898  static $isWindows = null;
1899  if ( $isWindows === null ) {
1900  $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
1901  }
1902  return $isWindows;
1903 }
1904 
1910 function wfIsHHVM() {
1911  return defined( 'HHVM_VERSION' );
1912 }
1913 
1920 function wfIsCLI() {
1921  return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
1922 }
1923 
1935 function wfTempDir() {
1936  global $wgTmpDirectory;
1937 
1938  if ( $wgTmpDirectory !== false ) {
1939  return $wgTmpDirectory;
1940  }
1941 
1943 }
1944 
1954 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
1955  global $wgDirectoryMode;
1956 
1957  if ( FileBackend::isStoragePath( $dir ) ) { // sanity
1958  throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
1959  }
1960 
1961  if ( !is_null( $caller ) ) {
1962  wfDebug( "$caller: called wfMkdirParents($dir)\n" );
1963  }
1964 
1965  if ( strval( $dir ) === '' || is_dir( $dir ) ) {
1966  return true;
1967  }
1968 
1969  $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
1970 
1971  if ( is_null( $mode ) ) {
1972  $mode = $wgDirectoryMode;
1973  }
1974 
1975  // Turn off the normal warning, we're doing our own below
1976  AtEase::suppressWarnings();
1977  $ok = mkdir( $dir, $mode, true ); // PHP5 <3
1978  AtEase::restoreWarnings();
1979 
1980  if ( !$ok ) {
1981  // directory may have been created on another request since we last checked
1982  if ( is_dir( $dir ) ) {
1983  return true;
1984  }
1985 
1986  // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
1987  wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
1988  }
1989  return $ok;
1990 }
1991 
1997 function wfRecursiveRemoveDir( $dir ) {
1998  wfDebug( __FUNCTION__ . "( $dir )\n" );
1999  // taken from https://www.php.net/manual/en/function.rmdir.php#98622
2000  if ( is_dir( $dir ) ) {
2001  $objects = scandir( $dir );
2002  foreach ( $objects as $object ) {
2003  if ( $object != "." && $object != ".." ) {
2004  if ( filetype( $dir . '/' . $object ) == "dir" ) {
2005  wfRecursiveRemoveDir( $dir . '/' . $object );
2006  } else {
2007  unlink( $dir . '/' . $object );
2008  }
2009  }
2010  }
2011  reset( $objects );
2012  rmdir( $dir );
2013  }
2014 }
2015 
2022 function wfPercent( $nr, $acc = 2, $round = true ) {
2023  $ret = sprintf( "%.${acc}f", $nr );
2024  return $round ? round( $ret, $acc ) . '%' : "$ret%";
2025 }
2026 
2050 function wfIniGetBool( $setting ) {
2051  return wfStringToBool( ini_get( $setting ) );
2052 }
2053 
2066 function wfStringToBool( $val ) {
2067  $val = strtolower( $val );
2068  // 'on' and 'true' can't have whitespace around them, but '1' can.
2069  return $val == 'on'
2070  || $val == 'true'
2071  || $val == 'yes'
2072  || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2073 }
2074 
2087 function wfEscapeShellArg( ...$args ) {
2088  return Shell::escape( ...$args );
2089 }
2090 
2114 function wfShellExec( $cmd, &$retval = null, $environ = [],
2115  $limits = [], $options = []
2116 ) {
2117  if ( Shell::isDisabled() ) {
2118  $retval = 1;
2119  // Backwards compatibility be upon us...
2120  return 'Unable to run external programs, proc_open() is disabled.';
2121  }
2122 
2123  if ( is_array( $cmd ) ) {
2124  $cmd = Shell::escape( $cmd );
2125  }
2126 
2127  $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2128  $profileMethod = $options['profileMethod'] ?? wfGetCaller();
2129 
2130  try {
2131  $result = Shell::command( [] )
2132  ->unsafeParams( (array)$cmd )
2133  ->environment( $environ )
2134  ->limits( $limits )
2135  ->includeStderr( $includeStderr )
2136  ->profileMethod( $profileMethod )
2137  // For b/c
2138  ->restrict( Shell::RESTRICT_NONE )
2139  ->execute();
2140  } catch ( ProcOpenError $ex ) {
2141  $retval = -1;
2142  return '';
2143  }
2144 
2145  $retval = $result->getExitCode();
2146 
2147  return $result->getStdout();
2148 }
2149 
2167 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2168  return wfShellExec( $cmd, $retval, $environ, $limits,
2169  [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2170 }
2171 
2186 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2187  global $wgPhpCli;
2188  // Give site config file a chance to run the script in a wrapper.
2189  // The caller may likely want to call wfBasename() on $script.
2190  Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2191  $cmd = [ $options['php'] ?? $wgPhpCli ];
2192  if ( isset( $options['wrapper'] ) ) {
2193  $cmd[] = $options['wrapper'];
2194  }
2195  $cmd[] = $script;
2196  // Escape each parameter for shell
2197  return Shell::escape( array_merge( $cmd, $parameters ) );
2198 }
2199 
2211 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2212  global $wgDiff3;
2213 
2214  # This check may also protect against code injection in
2215  # case of broken installations.
2216  AtEase::suppressWarnings();
2217  $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2218  AtEase::restoreWarnings();
2219 
2220  if ( !$haveDiff3 ) {
2221  wfDebug( "diff3 not found\n" );
2222  return false;
2223  }
2224 
2225  # Make temporary files
2226  $td = wfTempDir();
2227  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2228  $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2229  $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2230 
2231  # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2232  # a newline character. To avoid this, we normalize the trailing whitespace before
2233  # creating the diff.
2234 
2235  fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2236  fclose( $oldtextFile );
2237  fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2238  fclose( $mytextFile );
2239  fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2240  fclose( $yourtextFile );
2241 
2242  # Check for a conflict
2243  $cmd = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2244  $oldtextName, $yourtextName );
2245  $handle = popen( $cmd, 'r' );
2246 
2247  $mergeAttemptResult = '';
2248  do {
2249  $data = fread( $handle, 8192 );
2250  if ( strlen( $data ) == 0 ) {
2251  break;
2252  }
2253  $mergeAttemptResult .= $data;
2254  } while ( true );
2255  pclose( $handle );
2256 
2257  $conflict = $mergeAttemptResult !== '';
2258 
2259  # Merge differences
2260  $cmd = Shell::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2261  $oldtextName, $yourtextName );
2262  $handle = popen( $cmd, 'r' );
2263  $result = '';
2264  do {
2265  $data = fread( $handle, 8192 );
2266  if ( strlen( $data ) == 0 ) {
2267  break;
2268  }
2269  $result .= $data;
2270  } while ( true );
2271  pclose( $handle );
2272  unlink( $mytextName );
2273  unlink( $oldtextName );
2274  unlink( $yourtextName );
2275 
2276  if ( $result === '' && $old !== '' && !$conflict ) {
2277  wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2278  $conflict = true;
2279  }
2280  return !$conflict;
2281 }
2282 
2294 function wfDiff( $before, $after, $params = '-u' ) {
2295  if ( $before == $after ) {
2296  return '';
2297  }
2298 
2299  global $wgDiff;
2300  AtEase::suppressWarnings();
2301  $haveDiff = $wgDiff && file_exists( $wgDiff );
2302  AtEase::restoreWarnings();
2303 
2304  # This check may also protect against code injection in
2305  # case of broken installations.
2306  if ( !$haveDiff ) {
2307  wfDebug( "diff executable not found\n" );
2308  $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2309  $format = new UnifiedDiffFormatter();
2310  return $format->format( $diffs );
2311  }
2312 
2313  # Make temporary files
2314  $td = wfTempDir();
2315  $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2316  $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2317 
2318  fwrite( $oldtextFile, $before );
2319  fclose( $oldtextFile );
2320  fwrite( $newtextFile, $after );
2321  fclose( $newtextFile );
2322 
2323  // Get the diff of the two files
2324  $cmd = "$wgDiff " . $params . ' ' . Shell::escape( $oldtextName, $newtextName );
2325 
2326  $h = popen( $cmd, 'r' );
2327  if ( !$h ) {
2328  unlink( $oldtextName );
2329  unlink( $newtextName );
2330  throw new Exception( __METHOD__ . '(): popen() failed' );
2331  }
2332 
2333  $diff = '';
2334 
2335  do {
2336  $data = fread( $h, 8192 );
2337  if ( strlen( $data ) == 0 ) {
2338  break;
2339  }
2340  $diff .= $data;
2341  } while ( true );
2342 
2343  // Clean up
2344  pclose( $h );
2345  unlink( $oldtextName );
2346  unlink( $newtextName );
2347 
2348  // Kill the --- and +++ lines. They're not useful.
2349  $diff_lines = explode( "\n", $diff );
2350  if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2351  unset( $diff_lines[0] );
2352  }
2353  if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2354  unset( $diff_lines[1] );
2355  }
2356 
2357  $diff = implode( "\n", $diff_lines );
2358 
2359  return $diff;
2360 }
2361 
2374 function wfBaseName( $path, $suffix = '' ) {
2375  if ( $suffix == '' ) {
2376  $encSuffix = '';
2377  } else {
2378  $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2379  }
2380 
2381  $matches = [];
2382  if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2383  return $matches[1];
2384  } else {
2385  return '';
2386  }
2387 }
2388 
2398 function wfRelativePath( $path, $from ) {
2399  // Normalize mixed input on Windows...
2400  $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2401  $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2402 
2403  // Trim trailing slashes -- fix for drive root
2404  $path = rtrim( $path, DIRECTORY_SEPARATOR );
2405  $from = rtrim( $from, DIRECTORY_SEPARATOR );
2406 
2407  $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2408  $against = explode( DIRECTORY_SEPARATOR, $from );
2409 
2410  if ( $pieces[0] !== $against[0] ) {
2411  // Non-matching Windows drive letters?
2412  // Return a full path.
2413  return $path;
2414  }
2415 
2416  // Trim off common prefix
2417  while ( count( $pieces ) && count( $against )
2418  && $pieces[0] == $against[0] ) {
2419  array_shift( $pieces );
2420  array_shift( $against );
2421  }
2422 
2423  // relative dots to bump us to the parent
2424  while ( count( $against ) ) {
2425  array_unshift( $pieces, '..' );
2426  array_shift( $against );
2427  }
2428 
2429  array_push( $pieces, wfBaseName( $path ) );
2430 
2431  return implode( DIRECTORY_SEPARATOR, $pieces );
2432 }
2433 
2440 function wfResetSessionID() {
2441  wfDeprecated( __FUNCTION__, '1.27' );
2442  $session = SessionManager::getGlobalSession();
2443  $delay = $session->delaySave();
2444 
2445  $session->resetId();
2446 
2447  // Make sure a session is started, since that's what the old
2448  // wfResetSessionID() did.
2449  if ( session_id() !== $session->getId() ) {
2450  wfSetupSession( $session->getId() );
2451  }
2452 
2453  ScopedCallback::consume( $delay );
2454 }
2455 
2465 function wfSetupSession( $sessionId = false ) {
2466  wfDeprecated( __FUNCTION__, '1.27' );
2467 
2468  if ( $sessionId ) {
2469  session_id( $sessionId );
2470  }
2471 
2472  $session = SessionManager::getGlobalSession();
2473  $session->persist();
2474 
2475  if ( session_id() !== $session->getId() ) {
2476  session_id( $session->getId() );
2477  }
2478  AtEase::quietCall( 'session_start' );
2479 }
2480 
2488  global $IP;
2489 
2490  $file = "$IP/serialized/$name";
2491  if ( file_exists( $file ) ) {
2492  $blob = file_get_contents( $file );
2493  if ( $blob ) {
2494  return unserialize( $blob );
2495  }
2496  }
2497  return false;
2498 }
2499 
2507 function wfMemcKey( ...$args ) {
2508  return ObjectCache::getLocalClusterInstance()->makeKey( ...$args );
2509 }
2510 
2521 function wfForeignMemcKey( $db, $prefix, ...$args ) {
2522  $keyspace = $prefix ? "$db-$prefix" : $db;
2523  return ObjectCache::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2524 }
2525 
2538 function wfGlobalCacheKey( ...$args ) {
2539  return ObjectCache::getLocalClusterInstance()->makeGlobalKey( ...$args );
2540 }
2541 
2548 function wfWikiID() {
2549  global $wgDBprefix, $wgDBname;
2550  if ( $wgDBprefix ) {
2551  return "$wgDBname-$wgDBprefix";
2552  } else {
2553  return $wgDBname;
2554  }
2555 }
2556 
2582 function wfGetDB( $db, $groups = [], $wiki = false ) {
2583  return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2584 }
2585 
2595 function wfGetLB( $wiki = false ) {
2596  if ( $wiki === false ) {
2597  return MediaWikiServices::getInstance()->getDBLoadBalancer();
2598  } else {
2599  $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2600  return $factory->getMainLB( $wiki );
2601  }
2602 }
2603 
2612 function wfGetLBFactory() {
2613  wfDeprecated( __METHOD__, '1.27' );
2614  return MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2615 }
2616 
2624 function wfFindFile( $title, $options = [] ) {
2625  return MediaWikiServices::getInstance()->getRepoGroup()->findFile( $title, $options );
2626 }
2627 
2636 function wfLocalFile( $title ) {
2637  return MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()->newFile( $title );
2638 }
2639 
2647  global $wgMiserMode;
2648  return $wgMiserMode
2649  || ( SiteStats::pages() > 100000
2650  && SiteStats::edits() > 1000000
2651  && SiteStats::users() > 10000 );
2652 }
2653 
2662 function wfScript( $script = 'index' ) {
2664  if ( $script === 'index' ) {
2665  return $wgScript;
2666  } elseif ( $script === 'load' ) {
2667  return $wgLoadScript;
2668  } else {
2669  return "{$wgScriptPath}/{$script}.php";
2670  }
2671 }
2672 
2678 function wfGetScriptUrl() {
2679  if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2680  /* as it was called, minus the query string.
2681  *
2682  * Some sites use Apache rewrite rules to handle subdomains,
2683  * and have PHP set up in a weird way that causes PHP_SELF
2684  * to contain the rewritten URL instead of the one that the
2685  * outside world sees.
2686  *
2687  * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2688  * provides containing the "before" URL.
2689  */
2690  return $_SERVER['SCRIPT_NAME'];
2691  } else {
2692  return $_SERVER['URL'];
2693  }
2694 }
2695 
2703 function wfBoolToStr( $value ) {
2704  return $value ? 'true' : 'false';
2705 }
2706 
2712 function wfGetNull() {
2713  return wfIsWindows() ? 'NUL' : '/dev/null';
2714 }
2715 
2739  $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2740 ) {
2741  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2742 
2743  if ( $cluster === '*' ) {
2744  $cluster = false;
2745  $domain = false;
2746  } elseif ( $wiki === false ) {
2747  $domain = $lbFactory->getLocalDomainID();
2748  } else {
2749  $domain = $wiki;
2750  }
2751 
2752  $opts = [
2753  'domain' => $domain,
2754  'cluster' => $cluster,
2755  // B/C: first argument used to be "max seconds of lag"; ignore such values
2756  'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
2757  ];
2758  if ( $timeout !== null ) {
2759  $opts['timeout'] = $timeout;
2760  }
2761 
2762  return $lbFactory->waitForReplication( $opts );
2763 }
2764 
2774 function wfCountDown( $seconds ) {
2775  wfDeprecated( __FUNCTION__, '1.31' );
2776  for ( $i = $seconds; $i >= 0; $i-- ) {
2777  if ( $i != $seconds ) {
2778  echo str_repeat( "\x08", strlen( $i + 1 ) );
2779  }
2780  echo $i;
2781  flush();
2782  if ( $i ) {
2783  sleep( 1 );
2784  }
2785  }
2786  echo "\n";
2787 }
2788 
2798  global $wgIllegalFileChars;
2799  $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
2800  $name = preg_replace(
2801  "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
2802  '-',
2803  $name
2804  );
2805  // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2806  $name = wfBaseName( $name );
2807  return $name;
2808 }
2809 
2815 function wfMemoryLimit() {
2816  global $wgMemoryLimit;
2817  $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2818  if ( $memlimit != -1 ) {
2819  $conflimit = wfShorthandToInteger( $wgMemoryLimit );
2820  if ( $conflimit == -1 ) {
2821  wfDebug( "Removing PHP's memory limit\n" );
2822  Wikimedia\suppressWarnings();
2823  ini_set( 'memory_limit', $conflimit );
2824  Wikimedia\restoreWarnings();
2825  return $conflimit;
2826  } elseif ( $conflimit > $memlimit ) {
2827  wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
2828  Wikimedia\suppressWarnings();
2829  ini_set( 'memory_limit', $conflimit );
2830  Wikimedia\restoreWarnings();
2831  return $conflimit;
2832  }
2833  }
2834  return $memlimit;
2835 }
2836 
2845 
2846  $timeLimit = ini_get( 'max_execution_time' );
2847  // Note that CLI scripts use 0
2848  if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2849  set_time_limit( $wgTransactionalTimeLimit );
2850  }
2851 
2852  ignore_user_abort( true ); // ignore client disconnects
2853 
2854  return $timeLimit;
2855 }
2856 
2864 function wfShorthandToInteger( $string = '', $default = -1 ) {
2865  $string = trim( $string );
2866  if ( $string === '' ) {
2867  return $default;
2868  }
2869  $last = $string[strlen( $string ) - 1];
2870  $val = intval( $string );
2871  switch ( $last ) {
2872  case 'g':
2873  case 'G':
2874  $val *= 1024;
2875  // break intentionally missing
2876  case 'm':
2877  case 'M':
2878  $val *= 1024;
2879  // break intentionally missing
2880  case 'k':
2881  case 'K':
2882  $val *= 1024;
2883  }
2884 
2885  return $val;
2886 }
2887 
2898 function wfBCP47( $code ) {
2899  wfDeprecated( __METHOD__, '1.31' );
2900  return LanguageCode::bcp47( $code );
2901 }
2902 
2910 function wfGetCache( $cacheType ) {
2911  return ObjectCache::getInstance( $cacheType );
2912 }
2913 
2920 function wfGetMainCache() {
2922 }
2923 
2930  global $wgMessageCacheType;
2931  return ObjectCache::getInstance( $wgMessageCacheType );
2932 }
2933 
2948 function wfUnpack( $format, $data, $length = false ) {
2949  if ( $length !== false ) {
2950  $realLen = strlen( $data );
2951  if ( $realLen < $length ) {
2952  throw new MWException( "Tried to use wfUnpack on a "
2953  . "string of length $realLen, but needed one "
2954  . "of at least length $length."
2955  );
2956  }
2957  }
2958 
2959  Wikimedia\suppressWarnings();
2960  $result = unpack( $format, $data );
2961  Wikimedia\restoreWarnings();
2962 
2963  if ( $result === false ) {
2964  // If it cannot extract the packed data.
2965  throw new MWException( "unpack could not unpack binary data" );
2966  }
2967  return $result;
2968 }
2969 
2984 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
2985  # Handle redirects; callers almost always hit wfFindFile() anyway,
2986  # so just use that method because it has a fast process cache.
2987  $file = MediaWikiServices::getInstance()->getRepoGroup()->findFile( $name ); // get the final name
2988  $name = $file ? $file->getTitle()->getDBkey() : $name;
2989 
2990  # Run the extension hook
2991  $bad = false;
2992  if ( !Hooks::run( 'BadImage', [ $name, &$bad ] ) ) {
2993  return (bool)$bad;
2994  }
2995 
2997  $key = $cache->makeKey(
2998  'bad-image-list', ( $blacklist === null ) ? 'default' : md5( $blacklist )
2999  );
3000  $badImages = $cache->get( $key );
3001 
3002  if ( $badImages === false ) { // cache miss
3003  if ( $blacklist === null ) {
3004  $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3005  }
3006  # Build the list now
3007  $badImages = [];
3008  $lines = explode( "\n", $blacklist );
3009  foreach ( $lines as $line ) {
3010  # List items only
3011  if ( substr( $line, 0, 1 ) !== '*' ) {
3012  continue;
3013  }
3014 
3015  # Find all links
3016  $m = [];
3017  if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3018  continue;
3019  }
3020 
3021  $exceptions = [];
3022  $imageDBkey = false;
3023  foreach ( $m[1] as $i => $titleText ) {
3024  $title = Title::newFromText( $titleText );
3025  if ( !is_null( $title ) ) {
3026  if ( $i == 0 ) {
3027  $imageDBkey = $title->getDBkey();
3028  } else {
3029  $exceptions[$title->getPrefixedDBkey()] = true;
3030  }
3031  }
3032  }
3033 
3034  if ( $imageDBkey !== false ) {
3035  $badImages[$imageDBkey] = $exceptions;
3036  }
3037  }
3038  $cache->set( $key, $badImages, 60 );
3039  }
3040 
3041  $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
3042  $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3043 
3044  return $bad;
3045 }
3046 
3054 function wfCanIPUseHTTPS( $ip ) {
3055  $canDo = true;
3056  Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3057  return (bool)$canDo;
3058 }
3059 
3067 function wfIsInfinity( $str ) {
3068  // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3069  $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3070  return in_array( $str, $infinityValues );
3071 }
3072 
3089 
3090  $multipliers = [ 1 ];
3091  if ( $wgResponsiveImages ) {
3092  // These available sizes are hardcoded currently elsewhere in MediaWiki.
3093  // @see Linker::processResponsiveImages
3094  $multipliers[] = 1.5;
3095  $multipliers[] = 2;
3096  }
3097 
3098  $handler = $file->getHandler();
3099  if ( !$handler || !isset( $params['width'] ) ) {
3100  return false;
3101  }
3102 
3103  $basicParams = [];
3104  if ( isset( $params['page'] ) ) {
3105  $basicParams['page'] = $params['page'];
3106  }
3107 
3108  $thumbLimits = [];
3109  $imageLimits = [];
3110  // Expand limits to account for multipliers
3111  foreach ( $multipliers as $multiplier ) {
3112  $thumbLimits = array_merge( $thumbLimits, array_map(
3113  function ( $width ) use ( $multiplier ) {
3114  return round( $width * $multiplier );
3115  }, $wgThumbLimits )
3116  );
3117  $imageLimits = array_merge( $imageLimits, array_map(
3118  function ( $pair ) use ( $multiplier ) {
3119  return [
3120  round( $pair[0] * $multiplier ),
3121  round( $pair[1] * $multiplier ),
3122  ];
3123  }, $wgImageLimits )
3124  );
3125  }
3126 
3127  // Check if the width matches one of $wgThumbLimits
3128  if ( in_array( $params['width'], $thumbLimits ) ) {
3129  $normalParams = $basicParams + [ 'width' => $params['width'] ];
3130  // Append any default values to the map (e.g. "lossy", "lossless", ...)
3131  $handler->normaliseParams( $file, $normalParams );
3132  } else {
3133  // If not, then check if the width matchs one of $wgImageLimits
3134  $match = false;
3135  foreach ( $imageLimits as $pair ) {
3136  $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3137  // Decide whether the thumbnail should be scaled on width or height.
3138  // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3139  $handler->normaliseParams( $file, $normalParams );
3140  // Check if this standard thumbnail size maps to the given width
3141  if ( $normalParams['width'] == $params['width'] ) {
3142  $match = true;
3143  break;
3144  }
3145  }
3146  if ( !$match ) {
3147  return false; // not standard for description pages
3148  }
3149  }
3150 
3151  // Check that the given values for non-page, non-width, params are just defaults
3152  foreach ( $params as $key => $value ) {
3153  if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3154  return false;
3155  }
3156  }
3157 
3158  return true;
3159 }
3160 
3173 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3174  // First merge items that are in both arrays
3175  foreach ( $baseArray as $name => &$groupVal ) {
3176  if ( isset( $newValues[$name] ) ) {
3177  $groupVal += $newValues[$name];
3178  }
3179  }
3180  // Now add items that didn't exist yet
3181  $baseArray += $newValues;
3182 
3183  return $baseArray;
3184 }
3185 
3194 function wfGetRusage() {
3195  if ( !function_exists( 'getrusage' ) ) {
3196  return false;
3197  } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS === 'Linux' ) {
3198  return getrusage( 2 /* RUSAGE_THREAD */ );
3199  } else {
3200  return getrusage( 0 /* RUSAGE_SELF */ );
3201  }
3202 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
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
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:1585
$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:1982
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:218
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:2151
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:2217
wfVarDump( $var)
A wrapper around the PHP function var_export().
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
wfCountDown( $seconds)
Count down from $seconds to zero on the terminal, with a one-second pause between showing each number...
$wgEnableMagicLinks
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links...
if( $line===false) $args
Definition: cdb.php:64
static getUsableTempDirectory()
Definition: TempFSFile.php:85
$wgDebugRawPage
If true, log debugging data from action=raw and load.php.
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
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:780
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:780
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:1263
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:216
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:931
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:220
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:460
wfMessageFallback(... $keys)
This function accepts multiple message keys and returns a message instance for the first message whic...
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
static header( $code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
$wgImageLimits
Limit images on image description pages to a user-selectable limit.
Class representing a &#39;diff&#39; between two sequences of strings.
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:401
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:1982
$wgThumbLimits
Adjust thumbnails on image pages according to a user setting.
unserialize( $serialized)
wfDiff( $before, $after, $params='-u')
Returns unified plain-text diff of two texts.
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
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:1982
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:780
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
wfGlobalCacheKey(... $args)
Make a cache key with database-agnostic prefix.
const PROTO_HTTP
Definition: Defines.php:215
$wgDebugLogPrefix
Prefix for debug log lines.
wfArrayInsertAfter(array $array, array $insert, $after)
Insert array into another array after the specified KEY
$wgMemoryLimit
The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP&#39;s memory limit i...
$wgDiff3
Path to the GNU diff3 utility.
wfAssembleUrl( $urlParts)
This function will reassemble a URL parsed with wfParseURL.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
wfGetLBFactory()
Get the load balancer factory object.
const PROTO_CANONICAL
Definition: Defines.php:219
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:933
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.
wfMemoryLimit()
Set PHP&#39;s memory limit to the larger of php.ini or $wgMemoryLimit.
wfClearOutputBuffers()
More legible than passing a &#39;false&#39; parameter to wfResetOutputBuffers():
if(!is_readable( $file)) $ext
Definition: router.php:48
controlled by the following MediaWiki still creates a BagOStuff but calls it to it are no ops If the cache daemon can t be it should also disable itself fairly $wgDBname
Definition: memcached.txt:93
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
wfTransactionalTimeLimit()
Set PHP&#39;s time limit to the larger of php.ini or $wgTransactionalTimeLimit.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2633
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:700
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:783
$wgServer
URL of the server.
wfRelativePath( $path, $from)
Generate a relative path name to the given file.
$wgOut
Definition: Setup.php:936
wfCanIPUseHTTPS( $ip)
Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS...
wfBacktrace( $raw=null)
Get a debug backtrace as a string.
wfArrayDiff2( $a, $b)
Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
wfResetSessionID()
Reset the session id.
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
wfGetNull()
Get a platform-independent path to the null file, e.g.
wfBCP47( $code)
Get the normalised IETF language tag See unit test for examples.
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed)
Appends to second array if $value differs from that in $default.
wfArrayPlus2d(array $baseArray, array $newValues)
Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php: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:2633
wfArrayDiff2_cmp( $a, $b)
static users()
Definition: SiteStats.php:121
static bcp47( $code)
Get the normalised IETF language tag See unit test for examples.
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
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:319