MediaWiki REL1_33
GlobalFunctions.php
Go to the documentation of this file.
1<?php
23if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
25}
26
32use Wikimedia\ScopedCallback;
33use Wikimedia\WrappedString;
34
45function wfLoadExtension( $ext, $path = null ) {
46 if ( !$path ) {
48 $path = "$wgExtensionDirectory/$ext/extension.json";
49 }
51}
52
66function wfLoadExtensions( array $exts ) {
69 foreach ( $exts as $ext ) {
70 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
71 }
72}
73
82function wfLoadSkin( $skin, $path = null ) {
83 if ( !$path ) {
84 global $wgStyleDirectory;
85 $path = "$wgStyleDirectory/$skin/skin.json";
86 }
88}
89
97function wfLoadSkins( array $skins ) {
98 global $wgStyleDirectory;
100 foreach ( $skins as $skin ) {
101 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
102 }
103}
104
111function wfArrayDiff2( $a, $b ) {
112 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
113}
114
120function wfArrayDiff2_cmp( $a, $b ) {
121 if ( is_string( $a ) && is_string( $b ) ) {
122 return strcmp( $a, $b );
123 } elseif ( count( $a ) !== count( $b ) ) {
124 return count( $a ) <=> count( $b );
125 } else {
126 reset( $a );
127 reset( $b );
128 while ( key( $a ) !== null && key( $b ) !== null ) {
129 $valueA = current( $a );
130 $valueB = current( $b );
131 $cmp = strcmp( $valueA, $valueB );
132 if ( $cmp !== 0 ) {
133 return $cmp;
134 }
135 next( $a );
136 next( $b );
137 }
138 return 0;
139 }
140}
141
150function wfArrayFilter( array $arr, callable $callback ) {
151 wfDeprecated( __FUNCTION__, '1.32' );
152 return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH );
153}
154
163function wfArrayFilterByKey( array $arr, callable $callback ) {
164 wfDeprecated( __FUNCTION__, '1.32' );
165 return array_filter( $arr, $callback, ARRAY_FILTER_USE_KEY );
166}
167
177function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
178 if ( is_null( $changed ) ) {
179 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
180 }
181 if ( $default[$key] !== $value ) {
182 $changed[$key] = $value;
183 }
184}
185
205function wfMergeErrorArrays( ...$args ) {
206 $out = [];
207 foreach ( $args as $errors ) {
208 foreach ( $errors as $params ) {
209 $originalParams = $params;
210 if ( $params[0] instanceof MessageSpecifier ) {
211 $msg = $params[0];
212 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
213 }
214 # @todo FIXME: Sometimes get nested arrays for $params,
215 # which leads to E_NOTICEs
216 $spec = implode( "\t", $params );
217 $out[$spec] = $originalParams;
218 }
219 }
220 return array_values( $out );
221}
222
231function wfArrayInsertAfter( array $array, array $insert, $after ) {
232 // Find the offset of the element to insert after.
233 $keys = array_keys( $array );
234 $offsetByKey = array_flip( $keys );
235
236 $offset = $offsetByKey[$after];
237
238 // Insert at the specified offset
239 $before = array_slice( $array, 0, $offset + 1, true );
240 $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
241
242 $output = $before + $insert + $after;
243
244 return $output;
245}
246
254function wfObjectToArray( $objOrArray, $recursive = true ) {
255 $array = [];
256 if ( is_object( $objOrArray ) ) {
257 $objOrArray = get_object_vars( $objOrArray );
258 }
259 foreach ( $objOrArray as $key => $value ) {
260 if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
262 }
263
264 $array[$key] = $value;
265 }
266
267 return $array;
268}
269
280function wfRandom() {
281 // The maximum random value is "only" 2^31-1, so get two random
282 // values to reduce the chance of dupes
283 $max = mt_getrandmax() + 1;
284 $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
285 return $rand;
286}
287
298function wfRandomString( $length = 32 ) {
299 $str = '';
300 for ( $n = 0; $n < $length; $n += 7 ) {
301 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
302 }
303 return substr( $str, 0, $length );
304}
305
333function wfUrlencode( $s ) {
334 static $needle;
335
336 if ( is_null( $s ) ) {
337 // Reset $needle for testing.
338 $needle = null;
339 return '';
340 }
341
342 if ( is_null( $needle ) ) {
343 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
344 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
345 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
346 ) {
347 $needle[] = '%3A';
348 }
349 }
350
351 $s = urlencode( $s );
352 $s = str_ireplace(
353 $needle,
354 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
355 $s
356 );
357
358 return $s;
359}
360
371function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
372 if ( !is_null( $array2 ) ) {
373 $array1 = $array1 + $array2;
374 }
375
376 $cgi = '';
377 foreach ( $array1 as $key => $value ) {
378 if ( !is_null( $value ) && $value !== false ) {
379 if ( $cgi != '' ) {
380 $cgi .= '&';
381 }
382 if ( $prefix !== '' ) {
383 $key = $prefix . "[$key]";
384 }
385 if ( is_array( $value ) ) {
386 $firstTime = true;
387 foreach ( $value as $k => $v ) {
388 $cgi .= $firstTime ? '' : '&';
389 if ( is_array( $v ) ) {
390 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
391 } else {
392 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
393 }
394 $firstTime = false;
395 }
396 } else {
397 if ( is_object( $value ) ) {
398 $value = $value->__toString();
399 }
400 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
401 }
402 }
403 }
404 return $cgi;
405}
406
416function wfCgiToArray( $query ) {
417 if ( isset( $query[0] ) && $query[0] == '?' ) {
418 $query = substr( $query, 1 );
419 }
420 $bits = explode( '&', $query );
421 $ret = [];
422 foreach ( $bits as $bit ) {
423 if ( $bit === '' ) {
424 continue;
425 }
426 if ( strpos( $bit, '=' ) === false ) {
427 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
428 $key = $bit;
429 $value = '';
430 } else {
431 list( $key, $value ) = explode( '=', $bit );
432 }
433 $key = urldecode( $key );
434 $value = urldecode( $value );
435 if ( strpos( $key, '[' ) !== false ) {
436 $keys = array_reverse( explode( '[', $key ) );
437 $key = array_pop( $keys );
438 $temp = $value;
439 foreach ( $keys as $k ) {
440 $k = substr( $k, 0, -1 );
441 $temp = [ $k => $temp ];
442 }
443 if ( isset( $ret[$key] ) ) {
444 $ret[$key] = array_merge( $ret[$key], $temp );
445 } else {
446 $ret[$key] = $temp;
447 }
448 } else {
449 $ret[$key] = $value;
450 }
451 }
452 return $ret;
453}
454
463function wfAppendQuery( $url, $query ) {
464 if ( is_array( $query ) ) {
466 }
467 if ( $query != '' ) {
468 // Remove the fragment, if there is one
469 $fragment = false;
470 $hashPos = strpos( $url, '#' );
471 if ( $hashPos !== false ) {
472 $fragment = substr( $url, $hashPos );
473 $url = substr( $url, 0, $hashPos );
474 }
475
476 // Add parameter
477 if ( strpos( $url, '?' ) === false ) {
478 $url .= '?';
479 } else {
480 $url .= '&';
481 }
482 $url .= $query;
483
484 // Put the fragment back
485 if ( $fragment !== false ) {
486 $url .= $fragment;
487 }
488 }
489 return $url;
490}
491
515function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
518 if ( $defaultProto === PROTO_CANONICAL ) {
519 $serverUrl = $wgCanonicalServer;
520 } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
521 // Make $wgInternalServer fall back to $wgServer if not set
522 $serverUrl = $wgInternalServer;
523 } else {
524 $serverUrl = $wgServer;
525 if ( $defaultProto === PROTO_CURRENT ) {
526 $defaultProto = $wgRequest->getProtocol() . '://';
527 }
528 }
529
530 // Analyze $serverUrl to obtain its protocol
531 $bits = wfParseUrl( $serverUrl );
532 $serverHasProto = $bits && $bits['scheme'] != '';
533
534 if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
535 if ( $serverHasProto ) {
536 $defaultProto = $bits['scheme'] . '://';
537 } else {
538 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
539 // This really isn't supposed to happen. Fall back to HTTP in this
540 // ridiculous case.
541 $defaultProto = PROTO_HTTP;
542 }
543 }
544
545 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
546
547 if ( substr( $url, 0, 2 ) == '//' ) {
548 $url = $defaultProtoWithoutSlashes . $url;
549 } elseif ( substr( $url, 0, 1 ) == '/' ) {
550 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
551 // otherwise leave it alone.
552 if ( $serverHasProto ) {
553 $url = $serverUrl . $url;
554 } else {
555 // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
556 // user to override the port number (T67184)
557 if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
558 if ( isset( $bits['port'] ) ) {
559 throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
560 }
561 $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
562 } else {
563 $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
564 }
565 }
566 }
567
568 $bits = wfParseUrl( $url );
569
570 if ( $bits && isset( $bits['path'] ) ) {
571 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
572 return wfAssembleUrl( $bits );
573 } elseif ( $bits ) {
574 # No path to expand
575 return $url;
576 } elseif ( substr( $url, 0, 1 ) != '/' ) {
577 # URL is a relative path
578 return wfRemoveDotSegments( $url );
579 }
580
581 # Expanded URL is not valid.
582 return false;
583}
584
593function wfGetServerUrl( $proto ) {
594 $url = wfExpandUrl( '/', $proto );
595 return substr( $url, 0, -1 );
596}
597
611function wfAssembleUrl( $urlParts ) {
612 $result = '';
613
614 if ( isset( $urlParts['delimiter'] ) ) {
615 if ( isset( $urlParts['scheme'] ) ) {
616 $result .= $urlParts['scheme'];
617 }
618
619 $result .= $urlParts['delimiter'];
620 }
621
622 if ( isset( $urlParts['host'] ) ) {
623 if ( isset( $urlParts['user'] ) ) {
624 $result .= $urlParts['user'];
625 if ( isset( $urlParts['pass'] ) ) {
626 $result .= ':' . $urlParts['pass'];
627 }
628 $result .= '@';
629 }
630
631 $result .= $urlParts['host'];
632
633 if ( isset( $urlParts['port'] ) ) {
634 $result .= ':' . $urlParts['port'];
635 }
636 }
637
638 if ( isset( $urlParts['path'] ) ) {
639 $result .= $urlParts['path'];
640 }
641
642 if ( isset( $urlParts['query'] ) ) {
643 $result .= '?' . $urlParts['query'];
644 }
645
646 if ( isset( $urlParts['fragment'] ) ) {
647 $result .= '#' . $urlParts['fragment'];
648 }
649
650 return $result;
651}
652
665function wfRemoveDotSegments( $urlPath ) {
666 $output = '';
667 $inputOffset = 0;
668 $inputLength = strlen( $urlPath );
669
670 while ( $inputOffset < $inputLength ) {
671 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
672 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
673 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
674 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
675 $trimOutput = false;
676
677 if ( $prefixLengthTwo == './' ) {
678 # Step A, remove leading "./"
679 $inputOffset += 2;
680 } elseif ( $prefixLengthThree == '../' ) {
681 # Step A, remove leading "../"
682 $inputOffset += 3;
683 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
684 # Step B, replace leading "/.$" with "/"
685 $inputOffset += 1;
686 $urlPath[$inputOffset] = '/';
687 } elseif ( $prefixLengthThree == '/./' ) {
688 # Step B, replace leading "/./" with "/"
689 $inputOffset += 2;
690 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
691 # Step C, replace leading "/..$" with "/" and
692 # remove last path component in output
693 $inputOffset += 2;
694 $urlPath[$inputOffset] = '/';
695 $trimOutput = true;
696 } elseif ( $prefixLengthFour == '/../' ) {
697 # Step C, replace leading "/../" with "/" and
698 # remove last path component in output
699 $inputOffset += 3;
700 $trimOutput = true;
701 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
702 # Step D, remove "^.$"
703 $inputOffset += 1;
704 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
705 # Step D, remove "^..$"
706 $inputOffset += 2;
707 } else {
708 # Step E, move leading path segment to output
709 if ( $prefixLengthOne == '/' ) {
710 $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
711 } else {
712 $slashPos = strpos( $urlPath, '/', $inputOffset );
713 }
714 if ( $slashPos === false ) {
715 $output .= substr( $urlPath, $inputOffset );
716 $inputOffset = $inputLength;
717 } else {
718 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
719 $inputOffset += $slashPos - $inputOffset;
720 }
721 }
722
723 if ( $trimOutput ) {
724 $slashPos = strrpos( $output, '/' );
725 if ( $slashPos === false ) {
726 $output = '';
727 } else {
728 $output = substr( $output, 0, $slashPos );
729 }
730 }
731 }
732
733 return $output;
734}
735
743function wfUrlProtocols( $includeProtocolRelative = true ) {
744 global $wgUrlProtocols;
745
746 // Cache return values separately based on $includeProtocolRelative
747 static $withProtRel = null, $withoutProtRel = null;
748 $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
749 if ( !is_null( $cachedValue ) ) {
750 return $cachedValue;
751 }
752
753 // Support old-style $wgUrlProtocols strings, for backwards compatibility
754 // with LocalSettings files from 1.5
755 if ( is_array( $wgUrlProtocols ) ) {
756 $protocols = [];
757 foreach ( $wgUrlProtocols as $protocol ) {
758 // Filter out '//' if !$includeProtocolRelative
759 if ( $includeProtocolRelative || $protocol !== '//' ) {
760 $protocols[] = preg_quote( $protocol, '/' );
761 }
762 }
763
764 $retval = implode( '|', $protocols );
765 } else {
766 // Ignore $includeProtocolRelative in this case
767 // This case exists for pre-1.6 compatibility, and we can safely assume
768 // that '//' won't appear in a pre-1.6 config because protocol-relative
769 // URLs weren't supported until 1.18
770 $retval = $wgUrlProtocols;
771 }
772
773 // Cache return value
774 if ( $includeProtocolRelative ) {
775 $withProtRel = $retval;
776 } else {
777 $withoutProtRel = $retval;
778 }
779 return $retval;
780}
781
789 return wfUrlProtocols( false );
790}
791
817function wfParseUrl( $url ) {
818 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
819
820 // Protocol-relative URLs are handled really badly by parse_url(). It's so
821 // bad that the easiest way to handle them is to just prepend 'http:' and
822 // strip the protocol out later.
823 $wasRelative = substr( $url, 0, 2 ) == '//';
824 if ( $wasRelative ) {
825 $url = "http:$url";
826 }
827 Wikimedia\suppressWarnings();
828 $bits = parse_url( $url );
829 Wikimedia\restoreWarnings();
830
831 // T212067: PHP < 5.6.28, 7.0.0–7.0.12, and HHVM (all relevant versions) screw up parsing
832 // the query part of pathless URLs
833 if ( isset( $bits['host'] ) && strpos( $bits['host'], '?' ) !== false ) {
834 list( $host, $query ) = explode( '?', $bits['host'], 2 );
835 $bits['host'] = $host;
836 $bits['query'] = $query
837 . ( $bits['path'] ?? '' )
838 . ( isset( $bits['query'] ) ? '?' . $bits['query'] : '' );
839 unset( $bits['path'] );
840 }
841
842 // parse_url() returns an array without scheme for some invalid URLs, e.g.
843 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
844 if ( !$bits || !isset( $bits['scheme'] ) ) {
845 return false;
846 }
847
848 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
849 $bits['scheme'] = strtolower( $bits['scheme'] );
850
851 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
852 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
853 $bits['delimiter'] = '://';
854 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
855 $bits['delimiter'] = ':';
856 // parse_url detects for news: and mailto: the host part of an url as path
857 // We have to correct this wrong detection
858 if ( isset( $bits['path'] ) ) {
859 $bits['host'] = $bits['path'];
860 $bits['path'] = '';
861 }
862 } else {
863 return false;
864 }
865
866 /* Provide an empty host for eg. file:/// urls (see T30627) */
867 if ( !isset( $bits['host'] ) ) {
868 $bits['host'] = '';
869
870 // See T47069
871 if ( isset( $bits['path'] ) ) {
872 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
873 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
874 $bits['path'] = '/' . $bits['path'];
875 }
876 } else {
877 $bits['path'] = '';
878 }
879 }
880
881 // If the URL was protocol-relative, fix scheme and delimiter
882 if ( $wasRelative ) {
883 $bits['scheme'] = '';
884 $bits['delimiter'] = '//';
885 }
886 return $bits;
887}
888
899function wfExpandIRI( $url ) {
900 return preg_replace_callback(
901 '/((?:%[89A-F][0-9A-F])+)/i',
902 function ( array $matches ) {
903 return urldecode( $matches[1] );
904 },
905 wfExpandUrl( $url )
906 );
907}
908
916function wfMakeUrlIndexes( $url ) {
917 wfDeprecated( __FUNCTION__, '1.33' );
918 return LinkFilter::makeIndexes( $url );
919}
920
927function wfMatchesDomainList( $url, $domains ) {
928 $bits = wfParseUrl( $url );
929 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
930 $host = '.' . $bits['host'];
931 foreach ( (array)$domains as $domain ) {
932 $domain = '.' . $domain;
933 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
934 return true;
935 }
936 }
937 }
938 return false;
939}
940
961function wfDebug( $text, $dest = 'all', array $context = [] ) {
963 global $wgDebugTimestamps;
964
965 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
966 return;
967 }
968
969 $text = trim( $text );
970
971 if ( $wgDebugTimestamps ) {
972 $context['seconds_elapsed'] = sprintf(
973 '%6.4f',
974 microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
975 );
976 $context['memory_used'] = sprintf(
977 '%5.1fM',
978 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
979 );
980 }
981
982 if ( $wgDebugLogPrefix !== '' ) {
983 $context['prefix'] = $wgDebugLogPrefix;
984 }
985 $context['private'] = ( $dest === false || $dest === 'private' );
986
987 $logger = LoggerFactory::getInstance( 'wfDebug' );
988 $logger->debug( $text, $context );
989}
990
996 static $cache;
997 if ( $cache !== null ) {
998 return $cache;
999 }
1000 // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1001 // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
1002 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1003 || (
1004 isset( $_SERVER['SCRIPT_NAME'] )
1005 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1006 )
1007 ) {
1008 $cache = true;
1009 } else {
1010 $cache = false;
1011 }
1012 return $cache;
1013}
1014
1020function wfDebugMem( $exact = false ) {
1021 $mem = memory_get_usage();
1022 if ( !$exact ) {
1023 $mem = floor( $mem / 1024 ) . ' KiB';
1024 } else {
1025 $mem .= ' B';
1026 }
1027 wfDebug( "Memory usage: $mem\n" );
1028}
1029
1055function wfDebugLog(
1056 $logGroup, $text, $dest = 'all', array $context = []
1057) {
1058 $text = trim( $text );
1059
1060 $logger = LoggerFactory::getInstance( $logGroup );
1061 $context['private'] = ( $dest === false || $dest === 'private' );
1062 $logger->info( $text, $context );
1063}
1064
1073function wfLogDBError( $text, array $context = [] ) {
1074 $logger = LoggerFactory::getInstance( 'wfLogDBError' );
1075 $logger->error( trim( $text ), $context );
1076}
1077
1090function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1091 MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1092}
1093
1104function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1105 MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1106}
1107
1117function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1118 MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1119}
1120
1127
1128 $context = RequestContext::getMain();
1129 $request = $context->getRequest();
1130
1131 $profiler = Profiler::instance();
1132 $profiler->setContext( $context );
1133 $profiler->logData();
1134
1135 // Send out any buffered statsd metrics as needed
1136 MediaWiki::emitBufferedStatsdData(
1137 MediaWikiServices::getInstance()->getStatsdDataFactory(),
1138 $context->getConfig()
1139 );
1140
1141 // Profiling must actually be enabled...
1142 if ( $profiler instanceof ProfilerStub ) {
1143 return;
1144 }
1145
1146 if ( isset( $wgDebugLogGroups['profileoutput'] )
1147 && $wgDebugLogGroups['profileoutput'] === false
1148 ) {
1149 // Explicitly disabled
1150 return;
1151 }
1152 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1153 return;
1154 }
1155
1156 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1157 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1158 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1159 }
1160 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1161 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1162 }
1163 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1164 $ctx['from'] = $_SERVER['HTTP_FROM'];
1165 }
1166 if ( isset( $ctx['forwarded_for'] ) ||
1167 isset( $ctx['client_ip'] ) ||
1168 isset( $ctx['from'] ) ) {
1169 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1170 }
1171
1172 // Don't load $wgUser at this late stage just for statistics purposes
1173 // @todo FIXME: We can detect some anons even if it is not loaded.
1174 // See User::getId()
1175 $user = $context->getUser();
1176 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1177
1178 // Command line script uses a FauxRequest object which does not have
1179 // any knowledge about an URL and throw an exception instead.
1180 try {
1181 $ctx['url'] = urldecode( $request->getRequestURL() );
1182 } catch ( Exception $ignored ) {
1183 // no-op
1184 }
1185
1186 $ctx['output'] = $profiler->getOutput();
1187
1188 $log = LoggerFactory::getInstance( 'profileoutput' );
1189 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1190}
1191
1199function wfIncrStats( $key, $count = 1 ) {
1200 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1201 $stats->updateCount( $key, $count );
1202}
1203
1209function wfReadOnly() {
1210 return MediaWikiServices::getInstance()->getReadOnlyMode()
1211 ->isReadOnly();
1212}
1213
1223 return MediaWikiServices::getInstance()->getReadOnlyMode()
1224 ->getReason();
1225}
1226
1234 return MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1235 ->getReason();
1236}
1237
1253function wfGetLangObj( $langcode = false ) {
1254 # Identify which language to get or create a language object for.
1255 # Using is_object here due to Stub objects.
1256 if ( is_object( $langcode ) ) {
1257 # Great, we already have the object (hopefully)!
1258 return $langcode;
1259 }
1260
1261 global $wgLanguageCode;
1262 if ( $langcode === true || $langcode === $wgLanguageCode ) {
1263 # $langcode is the language code of the wikis content language object.
1264 # or it is a boolean and value is true
1265 return MediaWikiServices::getInstance()->getContentLanguage();
1266 }
1267
1268 global $wgLang;
1269 if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1270 # $langcode is the language code of user language object.
1271 # or it was a boolean and value is false
1272 return $wgLang;
1273 }
1274
1275 $validCodes = array_keys( Language::fetchLanguageNames() );
1276 if ( in_array( $langcode, $validCodes ) ) {
1277 # $langcode corresponds to a valid language.
1278 return Language::factory( $langcode );
1279 }
1280
1281 # $langcode is a string, but not a valid language code; use content language.
1282 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1283 return MediaWikiServices::getInstance()->getContentLanguage();
1284}
1285
1302function wfMessage( $key, ...$params ) {
1303 $message = new Message( $key );
1304
1305 // We call Message::params() to reduce code duplication
1306 if ( $params ) {
1307 $message->params( ...$params );
1308 }
1309
1310 return $message;
1311}
1312
1325function wfMessageFallback( ...$keys ) {
1326 return Message::newFallbackSequence( ...$keys );
1327}
1328
1337function wfMsgReplaceArgs( $message, $args ) {
1338 # Fix windows line-endings
1339 # Some messages are split with explode("\n", $msg)
1340 $message = str_replace( "\r", '', $message );
1341
1342 // Replace arguments
1343 if ( is_array( $args ) && $args ) {
1344 if ( is_array( $args[0] ) ) {
1345 $args = array_values( $args[0] );
1346 }
1347 $replacementKeys = [];
1348 foreach ( $args as $n => $param ) {
1349 $replacementKeys['$' . ( $n + 1 )] = $param;
1350 }
1351 $message = strtr( $message, $replacementKeys );
1352 }
1353
1354 return $message;
1355}
1356
1364function wfHostname() {
1365 static $host;
1366 if ( is_null( $host ) ) {
1367 # Hostname overriding
1368 global $wgOverrideHostname;
1369 if ( $wgOverrideHostname !== false ) {
1370 # Set static and skip any detection
1371 $host = $wgOverrideHostname;
1372 return $host;
1373 }
1374
1375 if ( function_exists( 'posix_uname' ) ) {
1376 // This function not present on Windows
1377 $uname = posix_uname();
1378 } else {
1379 $uname = false;
1380 }
1381 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1382 $host = $uname['nodename'];
1383 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1384 # Windows computer name
1385 $host = getenv( 'COMPUTERNAME' );
1386 } else {
1387 # This may be a virtual server.
1388 $host = $_SERVER['SERVER_NAME'];
1389 }
1390 }
1391 return $host;
1392}
1393
1404function wfReportTime( $nonce = null ) {
1405 global $wgShowHostnames;
1406
1407 $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1408 // seconds to milliseconds
1409 $responseTime = round( $elapsed * 1000 );
1410 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1411 if ( $wgShowHostnames ) {
1412 $reportVars['wgHostname'] = wfHostname();
1413 }
1414 return Skin::makeVariablesScript( $reportVars, $nonce );
1415}
1416
1427function wfDebugBacktrace( $limit = 0 ) {
1428 static $disabled = null;
1429
1430 if ( is_null( $disabled ) ) {
1431 $disabled = !function_exists( 'debug_backtrace' );
1432 if ( $disabled ) {
1433 wfDebug( "debug_backtrace() is disabled\n" );
1434 }
1435 }
1436 if ( $disabled ) {
1437 return [];
1438 }
1439
1440 if ( $limit ) {
1441 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1442 } else {
1443 return array_slice( debug_backtrace(), 1 );
1444 }
1445}
1446
1455function wfBacktrace( $raw = null ) {
1456 global $wgCommandLineMode;
1457
1458 if ( $raw === null ) {
1459 $raw = $wgCommandLineMode;
1460 }
1461
1462 if ( $raw ) {
1463 $frameFormat = "%s line %s calls %s()\n";
1464 $traceFormat = "%s";
1465 } else {
1466 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1467 $traceFormat = "<ul>\n%s</ul>\n";
1468 }
1469
1470 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1471 $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1472 $line = $frame['line'] ?? '-';
1473 $call = $frame['function'];
1474 if ( !empty( $frame['class'] ) ) {
1475 $call = $frame['class'] . $frame['type'] . $call;
1476 }
1477 return sprintf( $frameFormat, $file, $line, $call );
1478 }, wfDebugBacktrace() );
1479
1480 return sprintf( $traceFormat, implode( '', $frames ) );
1481}
1482
1492function wfGetCaller( $level = 2 ) {
1493 $backtrace = wfDebugBacktrace( $level + 1 );
1494 if ( isset( $backtrace[$level] ) ) {
1495 return wfFormatStackFrame( $backtrace[$level] );
1496 } else {
1497 return 'unknown';
1498 }
1499}
1500
1508function wfGetAllCallers( $limit = 3 ) {
1509 $trace = array_reverse( wfDebugBacktrace() );
1510 if ( !$limit || $limit > count( $trace ) - 1 ) {
1511 $limit = count( $trace ) - 1;
1512 }
1513 $trace = array_slice( $trace, -$limit - 1, $limit );
1514 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1515}
1516
1523function wfFormatStackFrame( $frame ) {
1524 if ( !isset( $frame['function'] ) ) {
1525 return 'NO_FUNCTION_GIVEN';
1526 }
1527 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1528 $frame['class'] . $frame['type'] . $frame['function'] :
1529 $frame['function'];
1530}
1531
1532/* Some generic result counters, pulled out of SearchEngine */
1533
1541function wfShowingResults( $offset, $limit ) {
1542 return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1543}
1544
1554function wfClientAcceptsGzip( $force = false ) {
1555 static $result = null;
1556 if ( $result === null || $force ) {
1557 $result = false;
1558 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1559 # @todo FIXME: We may want to blacklist some broken browsers
1560 $m = [];
1561 if ( preg_match(
1562 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1563 $_SERVER['HTTP_ACCEPT_ENCODING'],
1564 $m
1565 )
1566 ) {
1567 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1568 $result = false;
1569 return $result;
1570 }
1571 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1572 $result = true;
1573 }
1574 }
1575 }
1576 return $result;
1577}
1578
1589function wfEscapeWikiText( $text ) {
1590 global $wgEnableMagicLinks;
1591 static $repl = null, $repl2 = null;
1592 if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1593 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1594 // in those situations
1595 $repl = [
1596 '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1597 '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1598 '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1599 "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1600 "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1601 "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1602 "\n " => "\n&#32;", "\r " => "\r&#32;",
1603 "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1604 "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1605 "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1606 "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1607 '__' => '_&#95;', '://' => '&#58;//',
1608 ];
1609
1610 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1611 // We have to catch everything "\s" matches in PCRE
1612 foreach ( $magicLinks as $magic ) {
1613 $repl["$magic "] = "$magic&#32;";
1614 $repl["$magic\t"] = "$magic&#9;";
1615 $repl["$magic\r"] = "$magic&#13;";
1616 $repl["$magic\n"] = "$magic&#10;";
1617 $repl["$magic\f"] = "$magic&#12;";
1618 }
1619
1620 // And handle protocols that don't use "://"
1621 global $wgUrlProtocols;
1622 $repl2 = [];
1623 foreach ( $wgUrlProtocols as $prot ) {
1624 if ( substr( $prot, -1 ) === ':' ) {
1625 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1626 }
1627 }
1628 $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1629 }
1630 $text = substr( strtr( "\n$text", $repl ), 1 );
1631 $text = preg_replace( $repl2, '$1&#58;', $text );
1632 return $text;
1633}
1634
1645function wfSetVar( &$dest, $source, $force = false ) {
1646 $temp = $dest;
1647 if ( !is_null( $source ) || $force ) {
1648 $dest = $source;
1649 }
1650 return $temp;
1651}
1652
1662function wfSetBit( &$dest, $bit, $state = true ) {
1663 $temp = (bool)( $dest & $bit );
1664 if ( !is_null( $state ) ) {
1665 if ( $state ) {
1666 $dest |= $bit;
1667 } else {
1668 $dest &= ~$bit;
1669 }
1670 }
1671 return $temp;
1672}
1673
1680function wfVarDump( $var ) {
1681 global $wgOut;
1682 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1683 if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1684 print $s;
1685 } else {
1686 $wgOut->addHTML( $s );
1687 }
1688}
1689
1697function wfHttpError( $code, $label, $desc ) {
1698 global $wgOut;
1700 if ( $wgOut ) {
1701 $wgOut->disable();
1702 $wgOut->sendCacheControl();
1703 }
1704
1705 MediaWiki\HeaderCallback::warnIfHeadersSent();
1706 header( 'Content-type: text/html; charset=utf-8' );
1707 print '<!DOCTYPE html>' .
1708 '<html><head><title>' .
1709 htmlspecialchars( $label ) .
1710 '</title></head><body><h1>' .
1711 htmlspecialchars( $label ) .
1712 '</h1><p>' .
1713 nl2br( htmlspecialchars( $desc ) ) .
1714 "</p></body></html>\n";
1715}
1716
1734function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1735 if ( $resetGzipEncoding ) {
1736 // Suppress Content-Encoding and Content-Length
1737 // headers from OutputHandler::handle.
1740 }
1741 while ( $status = ob_get_status() ) {
1742 if ( isset( $status['flags'] ) ) {
1743 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1744 $deleteable = ( $status['flags'] & $flags ) === $flags;
1745 } elseif ( isset( $status['del'] ) ) {
1746 $deleteable = $status['del'];
1747 } else {
1748 // Guess that any PHP-internal setting can't be removed.
1749 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1750 }
1751 if ( !$deleteable ) {
1752 // Give up, and hope the result doesn't break
1753 // output behavior.
1754 break;
1755 }
1756 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1757 // Unit testing barrier to prevent this function from breaking PHPUnit.
1758 break;
1759 }
1760 if ( !ob_end_clean() ) {
1761 // Could not remove output buffer handler; abort now
1762 // to avoid getting in some kind of infinite loop.
1763 break;
1764 }
1765 if ( $resetGzipEncoding && $status['name'] == 'ob_gzhandler' ) {
1766 // Reset the 'Content-Encoding' field set by this handler
1767 // so we can start fresh.
1768 header_remove( 'Content-Encoding' );
1769 break;
1770 }
1771 }
1772}
1773
1787 wfResetOutputBuffers( false );
1788}
1789
1798function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1799 # No arg means accept anything (per HTTP spec)
1800 if ( !$accept ) {
1801 return [ $def => 1.0 ];
1802 }
1803
1804 $prefs = [];
1805
1806 $parts = explode( ',', $accept );
1807
1808 foreach ( $parts as $part ) {
1809 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1810 $values = explode( ';', trim( $part ) );
1811 $match = [];
1812 if ( count( $values ) == 1 ) {
1813 $prefs[$values[0]] = 1.0;
1814 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1815 $prefs[$values[0]] = floatval( $match[1] );
1816 }
1817 }
1818
1819 return $prefs;
1820}
1821
1834function mimeTypeMatch( $type, $avail ) {
1835 if ( array_key_exists( $type, $avail ) ) {
1836 return $type;
1837 } else {
1838 $mainType = explode( '/', $type )[0];
1839 if ( array_key_exists( "$mainType/*", $avail ) ) {
1840 return "$mainType/*";
1841 } elseif ( array_key_exists( '*/*', $avail ) ) {
1842 return '*/*';
1843 } else {
1844 return null;
1845 }
1846 }
1847}
1848
1862function wfNegotiateType( $cprefs, $sprefs ) {
1863 $combine = [];
1864
1865 foreach ( array_keys( $sprefs ) as $type ) {
1866 $subType = explode( '/', $type )[1];
1867 if ( $subType != '*' ) {
1868 $ckey = mimeTypeMatch( $type, $cprefs );
1869 if ( $ckey ) {
1870 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1871 }
1872 }
1873 }
1874
1875 foreach ( array_keys( $cprefs ) as $type ) {
1876 $subType = explode( '/', $type )[1];
1877 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1878 $skey = mimeTypeMatch( $type, $sprefs );
1879 if ( $skey ) {
1880 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1881 }
1882 }
1883 }
1884
1885 $bestq = 0;
1886 $besttype = null;
1887
1888 foreach ( array_keys( $combine ) as $type ) {
1889 if ( $combine[$type] > $bestq ) {
1890 $besttype = $type;
1891 $bestq = $combine[$type];
1892 }
1893 }
1894
1895 return $besttype;
1896}
1897
1904function wfSuppressWarnings( $end = false ) {
1905 Wikimedia\suppressWarnings( $end );
1906}
1907
1913 Wikimedia\restoreWarnings();
1914}
1915
1924function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1925 $ret = MWTimestamp::convert( $outputtype, $ts );
1926 if ( $ret === false ) {
1927 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1928 }
1929 return $ret;
1930}
1931
1940function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1941 if ( is_null( $ts ) ) {
1942 return null;
1943 } else {
1944 return wfTimestamp( $outputtype, $ts );
1945 }
1946}
1947
1953function wfTimestampNow() {
1954 # return NOW
1955 return MWTimestamp::now( TS_MW );
1956}
1957
1963function wfIsWindows() {
1964 static $isWindows = null;
1965 if ( $isWindows === null ) {
1966 $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
1967 }
1968 return $isWindows;
1969}
1970
1976function wfIsHHVM() {
1977 return defined( 'HHVM_VERSION' );
1978}
1979
1986function wfIsCLI() {
1987 return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
1988}
1989
2001function wfTempDir() {
2002 global $wgTmpDirectory;
2003
2004 if ( $wgTmpDirectory !== false ) {
2005 return $wgTmpDirectory;
2006 }
2007
2009}
2010
2020function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2021 global $wgDirectoryMode;
2022
2023 if ( FileBackend::isStoragePath( $dir ) ) { // sanity
2024 throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
2025 }
2026
2027 if ( !is_null( $caller ) ) {
2028 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2029 }
2030
2031 if ( strval( $dir ) === '' || is_dir( $dir ) ) {
2032 return true;
2033 }
2034
2035 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
2036
2037 if ( is_null( $mode ) ) {
2038 $mode = $wgDirectoryMode;
2039 }
2040
2041 // Turn off the normal warning, we're doing our own below
2042 Wikimedia\suppressWarnings();
2043 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2044 Wikimedia\restoreWarnings();
2045
2046 if ( !$ok ) {
2047 // directory may have been created on another request since we last checked
2048 if ( is_dir( $dir ) ) {
2049 return true;
2050 }
2051
2052 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2053 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2054 }
2055 return $ok;
2056}
2057
2063function wfRecursiveRemoveDir( $dir ) {
2064 wfDebug( __FUNCTION__ . "( $dir )\n" );
2065 // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2066 if ( is_dir( $dir ) ) {
2067 $objects = scandir( $dir );
2068 foreach ( $objects as $object ) {
2069 if ( $object != "." && $object != ".." ) {
2070 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2071 wfRecursiveRemoveDir( $dir . '/' . $object );
2072 } else {
2073 unlink( $dir . '/' . $object );
2074 }
2075 }
2076 }
2077 reset( $objects );
2078 rmdir( $dir );
2079 }
2080}
2081
2088function wfPercent( $nr, $acc = 2, $round = true ) {
2089 $ret = sprintf( "%.${acc}f", $nr );
2090 return $round ? round( $ret, $acc ) . '%' : "$ret%";
2091}
2092
2116function wfIniGetBool( $setting ) {
2117 return wfStringToBool( ini_get( $setting ) );
2118}
2119
2132function wfStringToBool( $val ) {
2133 $val = strtolower( $val );
2134 // 'on' and 'true' can't have whitespace around them, but '1' can.
2135 return $val == 'on'
2136 || $val == 'true'
2137 || $val == 'yes'
2138 || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2139}
2140
2153function wfEscapeShellArg( ...$args ) {
2154 return Shell::escape( ...$args );
2155}
2156
2180function wfShellExec( $cmd, &$retval = null, $environ = [],
2181 $limits = [], $options = []
2182) {
2183 if ( Shell::isDisabled() ) {
2184 $retval = 1;
2185 // Backwards compatibility be upon us...
2186 return 'Unable to run external programs, proc_open() is disabled.';
2187 }
2188
2189 if ( is_array( $cmd ) ) {
2190 $cmd = Shell::escape( $cmd );
2191 }
2192
2193 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2194 $profileMethod = $options['profileMethod'] ?? wfGetCaller();
2195
2196 try {
2197 $result = Shell::command( [] )
2198 ->unsafeParams( (array)$cmd )
2199 ->environment( $environ )
2200 ->limits( $limits )
2201 ->includeStderr( $includeStderr )
2202 ->profileMethod( $profileMethod )
2203 // For b/c
2204 ->restrict( Shell::RESTRICT_NONE )
2205 ->execute();
2206 } catch ( ProcOpenError $ex ) {
2207 $retval = -1;
2208 return '';
2209 }
2210
2211 $retval = $result->getExitCode();
2212
2213 return $result->getStdout();
2214}
2215
2233function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2234 return wfShellExec( $cmd, $retval, $environ, $limits,
2235 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2236}
2237
2252function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2253 global $wgPhpCli;
2254 // Give site config file a chance to run the script in a wrapper.
2255 // The caller may likely want to call wfBasename() on $script.
2256 Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2257 $cmd = [ $options['php'] ?? $wgPhpCli ];
2258 if ( isset( $options['wrapper'] ) ) {
2259 $cmd[] = $options['wrapper'];
2260 }
2261 $cmd[] = $script;
2262 // Escape each parameter for shell
2263 return Shell::escape( array_merge( $cmd, $parameters ) );
2264}
2265
2277function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2278 global $wgDiff3;
2279
2280 # This check may also protect against code injection in
2281 # case of broken installations.
2282 Wikimedia\suppressWarnings();
2283 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2284 Wikimedia\restoreWarnings();
2285
2286 if ( !$haveDiff3 ) {
2287 wfDebug( "diff3 not found\n" );
2288 return false;
2289 }
2290
2291 # Make temporary files
2292 $td = wfTempDir();
2293 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2294 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2295 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2296
2297 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2298 # a newline character. To avoid this, we normalize the trailing whitespace before
2299 # creating the diff.
2300
2301 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2302 fclose( $oldtextFile );
2303 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2304 fclose( $mytextFile );
2305 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2306 fclose( $yourtextFile );
2307
2308 # Check for a conflict
2309 $cmd = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2310 $oldtextName, $yourtextName );
2311 $handle = popen( $cmd, 'r' );
2312
2313 $mergeAttemptResult = '';
2314 do {
2315 $data = fread( $handle, 8192 );
2316 if ( strlen( $data ) == 0 ) {
2317 break;
2318 }
2319 $mergeAttemptResult .= $data;
2320 } while ( true );
2321 pclose( $handle );
2322
2323 $conflict = $mergeAttemptResult !== '';
2324
2325 # Merge differences
2326 $cmd = Shell::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2327 $oldtextName, $yourtextName );
2328 $handle = popen( $cmd, 'r' );
2329 $result = '';
2330 do {
2331 $data = fread( $handle, 8192 );
2332 if ( strlen( $data ) == 0 ) {
2333 break;
2334 }
2335 $result .= $data;
2336 } while ( true );
2337 pclose( $handle );
2338 unlink( $mytextName );
2339 unlink( $oldtextName );
2340 unlink( $yourtextName );
2341
2342 if ( $result === '' && $old !== '' && !$conflict ) {
2343 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2344 $conflict = true;
2345 }
2346 return !$conflict;
2347}
2348
2360function wfDiff( $before, $after, $params = '-u' ) {
2361 if ( $before == $after ) {
2362 return '';
2363 }
2364
2365 global $wgDiff;
2366 Wikimedia\suppressWarnings();
2367 $haveDiff = $wgDiff && file_exists( $wgDiff );
2368 Wikimedia\restoreWarnings();
2369
2370 # This check may also protect against code injection in
2371 # case of broken installations.
2372 if ( !$haveDiff ) {
2373 wfDebug( "diff executable not found\n" );
2374 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2375 $format = new UnifiedDiffFormatter();
2376 return $format->format( $diffs );
2377 }
2378
2379 # Make temporary files
2380 $td = wfTempDir();
2381 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2382 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2383
2384 fwrite( $oldtextFile, $before );
2385 fclose( $oldtextFile );
2386 fwrite( $newtextFile, $after );
2387 fclose( $newtextFile );
2388
2389 // Get the diff of the two files
2390 $cmd = "$wgDiff " . $params . ' ' . Shell::escape( $oldtextName, $newtextName );
2391
2392 $h = popen( $cmd, 'r' );
2393 if ( !$h ) {
2394 unlink( $oldtextName );
2395 unlink( $newtextName );
2396 throw new Exception( __METHOD__ . '(): popen() failed' );
2397 }
2398
2399 $diff = '';
2400
2401 do {
2402 $data = fread( $h, 8192 );
2403 if ( strlen( $data ) == 0 ) {
2404 break;
2405 }
2406 $diff .= $data;
2407 } while ( true );
2408
2409 // Clean up
2410 pclose( $h );
2411 unlink( $oldtextName );
2412 unlink( $newtextName );
2413
2414 // Kill the --- and +++ lines. They're not useful.
2415 $diff_lines = explode( "\n", $diff );
2416 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2417 unset( $diff_lines[0] );
2418 }
2419 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2420 unset( $diff_lines[1] );
2421 }
2422
2423 $diff = implode( "\n", $diff_lines );
2424
2425 return $diff;
2426}
2427
2440function wfBaseName( $path, $suffix = '' ) {
2441 if ( $suffix == '' ) {
2442 $encSuffix = '';
2443 } else {
2444 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2445 }
2446
2447 $matches = [];
2448 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2449 return $matches[1];
2450 } else {
2451 return '';
2452 }
2453}
2454
2464function wfRelativePath( $path, $from ) {
2465 // Normalize mixed input on Windows...
2466 $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2467 $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2468
2469 // Trim trailing slashes -- fix for drive root
2470 $path = rtrim( $path, DIRECTORY_SEPARATOR );
2471 $from = rtrim( $from, DIRECTORY_SEPARATOR );
2472
2473 $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2474 $against = explode( DIRECTORY_SEPARATOR, $from );
2475
2476 if ( $pieces[0] !== $against[0] ) {
2477 // Non-matching Windows drive letters?
2478 // Return a full path.
2479 return $path;
2480 }
2481
2482 // Trim off common prefix
2483 while ( count( $pieces ) && count( $against )
2484 && $pieces[0] == $against[0] ) {
2485 array_shift( $pieces );
2486 array_shift( $against );
2487 }
2488
2489 // relative dots to bump us to the parent
2490 while ( count( $against ) ) {
2491 array_unshift( $pieces, '..' );
2492 array_shift( $against );
2493 }
2494
2495 array_push( $pieces, wfBaseName( $path ) );
2496
2497 return implode( DIRECTORY_SEPARATOR, $pieces );
2498}
2499
2507 wfDeprecated( __FUNCTION__, '1.27' );
2508 $session = SessionManager::getGlobalSession();
2509 $delay = $session->delaySave();
2510
2511 $session->resetId();
2512
2513 // Make sure a session is started, since that's what the old
2514 // wfResetSessionID() did.
2515 if ( session_id() !== $session->getId() ) {
2516 wfSetupSession( $session->getId() );
2517 }
2518
2519 ScopedCallback::consume( $delay );
2520}
2521
2531function wfSetupSession( $sessionId = false ) {
2532 wfDeprecated( __FUNCTION__, '1.27' );
2533
2534 if ( $sessionId ) {
2535 session_id( $sessionId );
2536 }
2537
2538 $session = SessionManager::getGlobalSession();
2539 $session->persist();
2540
2541 if ( session_id() !== $session->getId() ) {
2542 session_id( $session->getId() );
2543 }
2544 Wikimedia\quietCall( 'session_start' );
2545}
2546
2553function wfGetPrecompiledData( $name ) {
2554 global $IP;
2555
2556 $file = "$IP/serialized/$name";
2557 if ( file_exists( $file ) ) {
2558 $blob = file_get_contents( $file );
2559 if ( $blob ) {
2560 return unserialize( $blob );
2561 }
2562 }
2563 return false;
2564}
2565
2573function wfMemcKey( ...$args ) {
2574 return ObjectCache::getLocalClusterInstance()->makeKey( ...$args );
2575}
2576
2587function wfForeignMemcKey( $db, $prefix, ...$args ) {
2588 $keyspace = $prefix ? "$db-$prefix" : $db;
2589 return ObjectCache::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2590}
2591
2604function wfGlobalCacheKey( ...$args ) {
2605 return ObjectCache::getLocalClusterInstance()->makeGlobalKey( ...$args );
2606}
2607
2614function wfWikiID() {
2615 global $wgDBprefix, $wgDBname;
2616 if ( $wgDBprefix ) {
2617 return "$wgDBname-$wgDBprefix";
2618 } else {
2619 return $wgDBname;
2620 }
2621}
2622
2648function wfGetDB( $db, $groups = [], $wiki = false ) {
2649 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2650}
2651
2661function wfGetLB( $wiki = false ) {
2662 if ( $wiki === false ) {
2663 return MediaWikiServices::getInstance()->getDBLoadBalancer();
2664 } else {
2665 $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2666 return $factory->getMainLB( $wiki );
2667 }
2668}
2669
2677function wfGetLBFactory() {
2678 return MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2679}
2680
2689function wfFindFile( $title, $options = [] ) {
2690 return RepoGroup::singleton()->findFile( $title, $options );
2691}
2692
2700function wfLocalFile( $title ) {
2701 return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
2702}
2703
2711 global $wgMiserMode;
2712 return $wgMiserMode
2713 || ( SiteStats::pages() > 100000
2714 && SiteStats::edits() > 1000000
2715 && SiteStats::users() > 10000 );
2716}
2717
2726function wfScript( $script = 'index' ) {
2728 if ( $script === 'index' ) {
2729 return $wgScript;
2730 } elseif ( $script === 'load' ) {
2731 return $wgLoadScript;
2732 } else {
2733 return "{$wgScriptPath}/{$script}.php";
2734 }
2735}
2736
2742function wfGetScriptUrl() {
2743 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2744 /* as it was called, minus the query string.
2745 *
2746 * Some sites use Apache rewrite rules to handle subdomains,
2747 * and have PHP set up in a weird way that causes PHP_SELF
2748 * to contain the rewritten URL instead of the one that the
2749 * outside world sees.
2750 *
2751 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2752 * provides containing the "before" URL.
2753 */
2754 return $_SERVER['SCRIPT_NAME'];
2755 } else {
2756 return $_SERVER['URL'];
2757 }
2758}
2759
2767function wfBoolToStr( $value ) {
2768 return $value ? 'true' : 'false';
2769}
2770
2776function wfGetNull() {
2777 return wfIsWindows() ? 'NUL' : '/dev/null';
2778}
2779
2803 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2804) {
2805 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2806
2807 if ( $cluster === '*' ) {
2808 $cluster = false;
2809 $domain = false;
2810 } elseif ( $wiki === false ) {
2811 $domain = $lbFactory->getLocalDomainID();
2812 } else {
2813 $domain = $wiki;
2814 }
2815
2816 $opts = [
2817 'domain' => $domain,
2818 'cluster' => $cluster,
2819 // B/C: first argument used to be "max seconds of lag"; ignore such values
2820 'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
2821 ];
2822 if ( $timeout !== null ) {
2823 $opts['timeout'] = $timeout;
2824 }
2825
2826 return $lbFactory->waitForReplication( $opts );
2827}
2828
2838function wfCountDown( $seconds ) {
2839 wfDeprecated( __FUNCTION__, '1.31' );
2840 for ( $i = $seconds; $i >= 0; $i-- ) {
2841 if ( $i != $seconds ) {
2842 echo str_repeat( "\x08", strlen( $i + 1 ) );
2843 }
2844 echo $i;
2845 flush();
2846 if ( $i ) {
2847 sleep( 1 );
2848 }
2849 }
2850 echo "\n";
2851}
2852
2862 global $wgIllegalFileChars;
2863 $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
2864 $name = preg_replace(
2865 "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
2866 '-',
2867 $name
2868 );
2869 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2870 $name = wfBaseName( $name );
2871 return $name;
2872}
2873
2879function wfMemoryLimit() {
2880 global $wgMemoryLimit;
2881 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2882 if ( $memlimit != -1 ) {
2883 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
2884 if ( $conflimit == -1 ) {
2885 wfDebug( "Removing PHP's memory limit\n" );
2886 Wikimedia\suppressWarnings();
2887 ini_set( 'memory_limit', $conflimit );
2888 Wikimedia\restoreWarnings();
2889 return $conflimit;
2890 } elseif ( $conflimit > $memlimit ) {
2891 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
2892 Wikimedia\suppressWarnings();
2893 ini_set( 'memory_limit', $conflimit );
2894 Wikimedia\restoreWarnings();
2895 return $conflimit;
2896 }
2897 }
2898 return $memlimit;
2899}
2900
2909
2910 $timeLimit = ini_get( 'max_execution_time' );
2911 // Note that CLI scripts use 0
2912 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2913 set_time_limit( $wgTransactionalTimeLimit );
2914 }
2915
2916 ignore_user_abort( true ); // ignore client disconnects
2917
2918 return $timeLimit;
2919}
2920
2928function wfShorthandToInteger( $string = '', $default = -1 ) {
2929 $string = trim( $string );
2930 if ( $string === '' ) {
2931 return $default;
2932 }
2933 $last = $string[strlen( $string ) - 1];
2934 $val = intval( $string );
2935 switch ( $last ) {
2936 case 'g':
2937 case 'G':
2938 $val *= 1024;
2939 // break intentionally missing
2940 case 'm':
2941 case 'M':
2942 $val *= 1024;
2943 // break intentionally missing
2944 case 'k':
2945 case 'K':
2946 $val *= 1024;
2947 }
2948
2949 return $val;
2950}
2951
2962function wfBCP47( $code ) {
2963 wfDeprecated( __METHOD__, '1.31' );
2964 return LanguageCode::bcp47( $code );
2965}
2966
2974function wfGetCache( $cacheType ) {
2975 return ObjectCache::getInstance( $cacheType );
2976}
2977
2984function wfGetMainCache() {
2985 return ObjectCache::getLocalClusterInstance();
2986}
2987
2994 global $wgMessageCacheType;
2995 return ObjectCache::getInstance( $wgMessageCacheType );
2996}
2997
3012function wfUnpack( $format, $data, $length = false ) {
3013 if ( $length !== false ) {
3014 $realLen = strlen( $data );
3015 if ( $realLen < $length ) {
3016 throw new MWException( "Tried to use wfUnpack on a "
3017 . "string of length $realLen, but needed one "
3018 . "of at least length $length."
3019 );
3020 }
3021 }
3022
3023 Wikimedia\suppressWarnings();
3024 $result = unpack( $format, $data );
3025 Wikimedia\restoreWarnings();
3026
3027 if ( $result === false ) {
3028 // If it cannot extract the packed data.
3029 throw new MWException( "unpack could not unpack binary data" );
3030 }
3031 return $result;
3032}
3033
3048function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3049 # Handle redirects; callers almost always hit wfFindFile() anyway,
3050 # so just use that method because it has a fast process cache.
3051 $file = wfFindFile( $name ); // get the final name
3052 $name = $file ? $file->getTitle()->getDBkey() : $name;
3053
3054 # Run the extension hook
3055 $bad = false;
3056 if ( !Hooks::run( 'BadImage', [ $name, &$bad ] ) ) {
3057 return (bool)$bad;
3058 }
3059
3060 $cache = ObjectCache::getLocalServerInstance( 'hash' );
3061 $key = $cache->makeKey(
3062 'bad-image-list', ( $blacklist === null ) ? 'default' : md5( $blacklist )
3063 );
3064 $badImages = $cache->get( $key );
3065
3066 if ( $badImages === false ) { // cache miss
3067 if ( $blacklist === null ) {
3068 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3069 }
3070 # Build the list now
3071 $badImages = [];
3072 $lines = explode( "\n", $blacklist );
3073 foreach ( $lines as $line ) {
3074 # List items only
3075 if ( substr( $line, 0, 1 ) !== '*' ) {
3076 continue;
3077 }
3078
3079 # Find all links
3080 $m = [];
3081 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3082 continue;
3083 }
3084
3085 $exceptions = [];
3086 $imageDBkey = false;
3087 foreach ( $m[1] as $i => $titleText ) {
3088 $title = Title::newFromText( $titleText );
3089 if ( !is_null( $title ) ) {
3090 if ( $i == 0 ) {
3091 $imageDBkey = $title->getDBkey();
3092 } else {
3093 $exceptions[$title->getPrefixedDBkey()] = true;
3094 }
3095 }
3096 }
3097
3098 if ( $imageDBkey !== false ) {
3099 $badImages[$imageDBkey] = $exceptions;
3100 }
3101 }
3102 $cache->set( $key, $badImages, 60 );
3103 }
3104
3105 $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
3106 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3107
3108 return $bad;
3109}
3110
3118function wfCanIPUseHTTPS( $ip ) {
3119 $canDo = true;
3120 Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3121 return (bool)$canDo;
3122}
3123
3131function wfIsInfinity( $str ) {
3132 // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3133 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3134 return in_array( $str, $infinityValues );
3135}
3136
3153
3154 $multipliers = [ 1 ];
3155 if ( $wgResponsiveImages ) {
3156 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3157 // @see Linker::processResponsiveImages
3158 $multipliers[] = 1.5;
3159 $multipliers[] = 2;
3160 }
3161
3162 $handler = $file->getHandler();
3163 if ( !$handler || !isset( $params['width'] ) ) {
3164 return false;
3165 }
3166
3167 $basicParams = [];
3168 if ( isset( $params['page'] ) ) {
3169 $basicParams['page'] = $params['page'];
3170 }
3171
3172 $thumbLimits = [];
3173 $imageLimits = [];
3174 // Expand limits to account for multipliers
3175 foreach ( $multipliers as $multiplier ) {
3176 $thumbLimits = array_merge( $thumbLimits, array_map(
3177 function ( $width ) use ( $multiplier ) {
3178 return round( $width * $multiplier );
3179 }, $wgThumbLimits )
3180 );
3181 $imageLimits = array_merge( $imageLimits, array_map(
3182 function ( $pair ) use ( $multiplier ) {
3183 return [
3184 round( $pair[0] * $multiplier ),
3185 round( $pair[1] * $multiplier ),
3186 ];
3187 }, $wgImageLimits )
3188 );
3189 }
3190
3191 // Check if the width matches one of $wgThumbLimits
3192 if ( in_array( $params['width'], $thumbLimits ) ) {
3193 $normalParams = $basicParams + [ 'width' => $params['width'] ];
3194 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3195 $handler->normaliseParams( $file, $normalParams );
3196 } else {
3197 // If not, then check if the width matchs one of $wgImageLimits
3198 $match = false;
3199 foreach ( $imageLimits as $pair ) {
3200 $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3201 // Decide whether the thumbnail should be scaled on width or height.
3202 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3203 $handler->normaliseParams( $file, $normalParams );
3204 // Check if this standard thumbnail size maps to the given width
3205 if ( $normalParams['width'] == $params['width'] ) {
3206 $match = true;
3207 break;
3208 }
3209 }
3210 if ( !$match ) {
3211 return false; // not standard for description pages
3212 }
3213 }
3214
3215 // Check that the given values for non-page, non-width, params are just defaults
3216 foreach ( $params as $key => $value ) {
3217 if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3218 return false;
3219 }
3220 }
3221
3222 return true;
3223}
3224
3237function wfArrayPlus2d( array $baseArray, array $newValues ) {
3238 // First merge items that are in both arrays
3239 foreach ( $baseArray as $name => &$groupVal ) {
3240 if ( isset( $newValues[$name] ) ) {
3241 $groupVal += $newValues[$name];
3242 }
3243 }
3244 // Now add items that didn't exist yet
3245 $baseArray += $newValues;
3246
3247 return $baseArray;
3248}
3249
3258function wfGetRusage() {
3259 if ( !function_exists( 'getrusage' ) ) {
3260 return false;
3261 } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS === 'Linux' ) {
3262 return getrusage( 2 /* RUSAGE_THREAD */ );
3263 } else {
3264 return getrusage( 0 /* RUSAGE_SELF */ );
3265 }
3266}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
unserialize( $serialized)
$wgLanguageCode
Site language code.
$wgMemoryLimit
The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit i...
$wgDBprefix
Table name prefix.
$wgScript
The URL path to index.php.
$wgInternalServer
Internal server name as known to CDN, if different.
$wgThumbLimits
Adjust thumbnails on image pages according to a user setting.
$wgDisableOutputCompression
Disable output compression (enabled by default if zlib is available)
$wgDebugLogPrefix
Prefix for debug log lines.
$wgPhpCli
Executable path of the PHP cli binary.
$wgOverrideHostname
Override server hostname detection with a hardcoded value.
$wgImageLimits
Limit images on image description pages to a user-selectable limit.
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
$wgTmpDirectory
The local filesystem path to a temporary directory.
$wgStyleDirectory
Filesystem stylesheets directory.
$wgTransactionalTimeLimit
The minimum amount of time that MediaWiki needs for "slow" write request, particularly ones with mult...
$wgIllegalFileChars
Additional characters that are not allowed in filenames.
$wgDirectoryMode
Default value for chmoding of new directories.
$wgMessageCacheType
The cache type for storing the contents of the MediaWiki namespace.
$wgDiff3
Path to the GNU diff3 utility.
$wgUrlProtocols
URL schemes that should be recognized as valid by wfParseUrl().
$wgResponsiveImages
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
$wgDebugRawPage
If true, log debugging data from action=raw and load.php.
$wgEnableMagicLinks
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links.
$wgScriptPath
The path we should point to.
$wgDebugTimestamps
Prefix debug messages with relative timestamp.
$wgDebugLogGroups
Map of string log group names to log destinations.
$wgExtensionDirectory
Filesystem extensions directory.
$wgLoadScript
The URL path to load.php.
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
$wgMiserMode
Disable database-intensive features.
$wgServer
URL of the server.
$wgHttpsPort
For installations where the canonical server is HTTP but HTTPS is optionally supported,...
$wgDiff
Path to the GNU diff utility.
global $wgCommandLineMode
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
wfThumbIsStandard(File $file, array $params)
Returns true if these thumbnail parameters match one that MediaWiki requests from file description pa...
wfConfiguredReadOnlyReason()
Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
wfVarDump( $var)
A wrapper around the PHP function var_export().
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfNegotiateType( $cprefs, $sprefs)
Returns the 'best' match between a client's requested internet media types and the server's list of a...
wfRandom()
Get a random decimal value in the domain of [0, 1), in a way not likely to give duplicate values for ...
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness,...
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
wfTempDir()
Tries to get the system directory for temporary files.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
wfBaseName( $path, $suffix='')
Return the final portion of a pathname.
wfBCP47( $code)
Get the normalised IETF language tag See unit test for examples.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfClientAcceptsGzip( $force=false)
Whether the client accept gzip encoding.
wfEscapeShellArg(... $args)
Version of escapeshellarg() that works better on Windows.
wfIncrStats( $key, $count=1)
Increment a statistics counter.
wfLogDBError( $text, array $context=[])
Log for database errors.
wfLoadSkins(array $skins)
Load multiple skins at once.
wfGetRusage()
Get system resource usage of current request context.
wfGetLB( $wiki=false)
Get a load balancer object.
wfUrlProtocolsWithoutProtRel()
Like wfUrlProtocols(), but excludes '//' from the protocol list.
wfRecursiveRemoveDir( $dir)
Remove a directory and all its content.
wfLoadExtension( $ext, $path=null)
Load an extension.
wfReadOnly()
Check whether the wiki is in read-only mode.
wfSetBit(&$dest, $bit, $state=true)
As for wfSetVar except setting a bit.
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfBacktrace( $raw=null)
Get a debug backtrace as a string.
wfGetCaller( $level=2)
Get the name of the function which called this function wfGetCaller( 1 ) is the function with the wfG...
wfLocalFile( $title)
Get an object referring to a locally registered file.
wfExpandIRI( $url)
Take a URL, make sure it's expanded to fully qualified, and replace any encoded non-ASCII Unicode cha...
wfMergeErrorArrays(... $args)
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
wfPercent( $nr, $acc=2, $round=true)
wfCountDown( $seconds)
Count down from $seconds to zero on the terminal, with a one-second pause between showing each number...
wfShellExec( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
wfGetMessageCacheStorage()
Get the cache object used by the message cache.
wfRestoreWarnings()
wfIsDebugRawPage()
Returns true if debug logging should be suppressed if $wgDebugRawPage = false.
wfHostname()
Fetch server name for use in error reporting etc.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfGetMainCache()
Get the main cache object.
wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult=null)
wfMerge attempts to merge differences between three texts.
wfShellWikiCmd( $script, array $parameters=[], array $options=[])
Generate a shell-escaped command line string to run a MediaWiki cli script.
wfGetPrecompiledData( $name)
Get an object from the precompiled serialized directory.
wfFindFile( $title, $options=[])
Find a file.
wfReportTime( $nonce=null)
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
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...
wfArrayDiff2( $a, $b)
Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
wfShellExecWithStderr( $cmd, &$retval=null, $environ=[], $limits=[])
Execute a shell command, returning both stdout and stderr.
wfSuppressWarnings( $end=false)
Reference-counted warning suppression.
wfCanIPUseHTTPS( $ip)
Determine whether the client at a given source IP is likely to be able to access the wiki via HTTPS.
wfGetNull()
Get a platform-independent path to the null file, e.g.
wfAcceptToPrefs( $accept, $def=' */*')
Converts an Accept-* header into an array mapping string values to quality factors.
wfSetupSession( $sessionId=false)
Initialise php session.
wfDiff( $before, $after, $params='-u')
Returns unified plain-text diff of two texts.
wfRelativePath( $path, $from)
Generate a relative path name to the given file.
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
wfMakeUrlIndexes( $url)
Make URL indexes, appropriate for the el_index field of externallinks.
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
wfUnpack( $format, $data, $length=false)
Wrapper around php's unpack.
wfMessageFallback(... $keys)
This function accepts multiple message keys and returns a message instance for the first message whic...
wfReadOnlyReason()
Check if the site is in read-only mode and return the message if so.
wfShowingResults( $offset, $limit)
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
wfRemoveDotSegments( $urlPath)
Remove all dot-segments in the provided URL path.
wfArrayPlus2d(array $baseArray, array $newValues)
Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
wfLogWarning( $msg, $callerOffset=1, $level=E_USER_WARNING)
Send a warning as a PHP error and the debug log.
wfTransactionalTimeLimit()
Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
wfObjectToArray( $objOrArray, $recursive=true)
Recursively converts the parameter (an object) to an array with the same data.
wfGetLBFactory()
Get the load balancer factory object.
wfGetScriptUrl()
Get the script URL.
wfGlobalCacheKey(... $args)
Make a cache key with database-agnostic prefix.
wfClearOutputBuffers()
More legible than passing a 'false' parameter to wfResetOutputBuffers():
wfDebugMem( $exact=false)
Send a line giving PHP memory usage.
wfLoadSkin( $skin, $path=null)
Load a skin.
wfMsgReplaceArgs( $message, $args)
Replace message parameter keys on the given formatted output.
wfGetServerUrl( $proto)
Get the wiki's "server", i.e.
wfStringToBool( $val)
Convert string value to boolean, when the following are interpreted as true:
wfGetCache( $cacheType)
Get a specific cache object.
wfArrayFilterByKey(array $arr, callable $callback)
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the 'bad image list'.
wfMemcKey(... $args)
Make a cache key for the local wiki.
wfDebugBacktrace( $limit=0)
Safety wrapper for debug_backtrace().
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
wfStripIllegalFilenameChars( $name)
Replace all invalid characters with '-'.
wfFormatStackFrame( $frame)
Return a string representation of frame.
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
wfArrayDiff2_cmp( $a, $b)
wfIsWindows()
Check if the operating system is Windows.
wfShorthandToInteger( $string='', $default=-1)
Converts shorthand byte notation to integer form.
wfMatchesDomainList( $url, $domains)
Check whether a given URL has a domain that occurs in a given set of domains.
wfForeignMemcKey( $db, $prefix,... $args)
Make a cache key for a foreign DB.
wfIsInfinity( $str)
Determine input string is represents as infinity.
wfQueriesMustScale()
Should low-performance queries be disabled?
mimeTypeMatch( $type, $avail)
Checks if a given MIME type matches any of the keys in the given array.
wfMemoryLimit()
Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit.
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfResetSessionID()
Reset the session id.
wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed)
Appends to second array if $value differs from that in $default.
wfLoadExtensions(array $exts)
Load multiple extensions at once.
wfBoolToStr( $value)
Convenience function converts boolean values into "true" or "false" (string) values.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
wfLogProfilingData()
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
wfArrayInsertAfter(array $array, array $insert, $after)
Insert array into another array after the specified KEY
wfAssembleUrl( $urlParts)
This function will reassemble a URL parsed with wfParseURL.
wfIsHHVM()
Check if we are running under HHVM.
wfArrayFilter(array $arr, callable $callback)
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
wfIsCLI()
Check if we are running from the commandline.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
$wgOut
Definition Setup.php:880
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:728
$wgLang
Definition Setup.php:875
$IP
Definition WebStart.php:41
$line
Definition cdb.php:59
if( $line===false) $args
Definition cdb.php:64
Class representing a 'diff' between two sequences of strings.
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition File.php:52
static header( $code)
Output an HTTP status code header.
static makeIndexes( $url)
Converts a URL into a format for el_index.
MediaWiki exception.
PSR-3 logger instance factory.
MediaWikiServices is the service locator for the application scope of MediaWiki.
This serves as the entry point to the MediaWiki session handling system.
Executes shell commands.
Definition Shell.php:44
The Message class provides methods which fulfil two basic services:
Definition Message.php:160
Stub profiler that does nothing.
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:61
static edits()
Definition SiteStats.php:94
static users()
static pages()
static getUsableTempDirectory()
A formatter that outputs unified diffs.
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
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
while(( $__line=Maintenance::readconsole()) !==false) print
Definition eval.php:64
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
const PROTO_CANONICAL
Definition Defines.php:232
const PROTO_HTTPS
Definition Defines.php:229
const PROTO_CURRENT
Definition Defines.php:231
const PROTO_INTERNAL
Definition Defines.php:233
const PROTO_HTTP
Definition Defines.php:228
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:2843
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. '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:1991
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:855
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:894
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1266
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:1999
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:2163
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:2848
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:955
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:783
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:856
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:2003
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 additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:271
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:2009
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:1617
return true to allow those checks to and false if checking is done & $user
Definition hooks.txt:1510
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:2272
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
$cache
Definition mcc.php:33
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
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))
$source
$last
$lines
Definition router.php:61
if(!is_readable( $file)) $ext
Definition router.php:48
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition router.php:42
$params