MediaWiki REL1_29
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
27use Liuggio\StatsdClient\Sender\SocketSender;
31use Wikimedia\ScopedCallback;
33
34// Hide compatibility functions from Doxygen
36
44// hash_equals function only exists in PHP >= 5.6.0
45// https://secure.php.net/hash_equals
46if ( !function_exists( 'hash_equals' ) ) {
72 function hash_equals( $known_string, $user_string ) {
73 // Strict type checking as in PHP's native implementation
74 if ( !is_string( $known_string ) ) {
75 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
76 gettype( $known_string ) . ' given', E_USER_WARNING );
77
78 return false;
79 }
80
81 if ( !is_string( $user_string ) ) {
82 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
83 gettype( $user_string ) . ' given', E_USER_WARNING );
84
85 return false;
86 }
87
88 $known_string_len = strlen( $known_string );
89 if ( $known_string_len !== strlen( $user_string ) ) {
90 return false;
91 }
92
93 $result = 0;
94 for ( $i = 0; $i < $known_string_len; $i++ ) {
95 $result |= ord( $known_string[$i] ) ^ ord( $user_string[$i] );
96 }
97
98 return ( $result === 0 );
99 }
100}
102
113function wfLoadExtension( $ext, $path = null ) {
114 if ( !$path ) {
116 $path = "$wgExtensionDirectory/$ext/extension.json";
117 }
119}
120
134function wfLoadExtensions( array $exts ) {
136 $registry = ExtensionRegistry::getInstance();
137 foreach ( $exts as $ext ) {
138 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
139 }
140}
141
150function wfLoadSkin( $skin, $path = null ) {
151 if ( !$path ) {
153 $path = "$wgStyleDirectory/$skin/skin.json";
154 }
156}
157
165function wfLoadSkins( array $skins ) {
167 $registry = ExtensionRegistry::getInstance();
168 foreach ( $skins as $skin ) {
169 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
170 }
171}
172
179function wfArrayDiff2( $a, $b ) {
180 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
181}
182
188function wfArrayDiff2_cmp( $a, $b ) {
189 if ( is_string( $a ) && is_string( $b ) ) {
190 return strcmp( $a, $b );
191 } elseif ( count( $a ) !== count( $b ) ) {
192 return count( $a ) < count( $b ) ? -1 : 1;
193 } else {
194 reset( $a );
195 reset( $b );
196 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
197 $cmp = strcmp( $valueA, $valueB );
198 if ( $cmp !== 0 ) {
199 return $cmp;
200 }
201 }
202 return 0;
203 }
204}
205
215function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
216 if ( is_null( $changed ) ) {
217 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
218 }
219 if ( $default[$key] !== $value ) {
220 $changed[$key] = $value;
221 }
222}
223
243function wfMergeErrorArrays( /*...*/ ) {
244 $args = func_get_args();
245 $out = [];
246 foreach ( $args as $errors ) {
247 foreach ( $errors as $params ) {
248 $originalParams = $params;
249 if ( $params[0] instanceof MessageSpecifier ) {
250 $msg = $params[0];
251 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
252 }
253 # @todo FIXME: Sometimes get nested arrays for $params,
254 # which leads to E_NOTICEs
255 $spec = implode( "\t", $params );
256 $out[$spec] = $originalParams;
257 }
258 }
259 return array_values( $out );
260}
261
270function wfArrayInsertAfter( array $array, array $insert, $after ) {
271 // Find the offset of the element to insert after.
272 $keys = array_keys( $array );
273 $offsetByKey = array_flip( $keys );
274
275 $offset = $offsetByKey[$after];
276
277 // Insert at the specified offset
278 $before = array_slice( $array, 0, $offset + 1, true );
279 $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
280
281 $output = $before + $insert + $after;
282
283 return $output;
284}
285
293function wfObjectToArray( $objOrArray, $recursive = true ) {
294 $array = [];
295 if ( is_object( $objOrArray ) ) {
296 $objOrArray = get_object_vars( $objOrArray );
297 }
298 foreach ( $objOrArray as $key => $value ) {
299 if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
301 }
302
303 $array[$key] = $value;
304 }
305
306 return $array;
307}
308
319function wfRandom() {
320 // The maximum random value is "only" 2^31-1, so get two random
321 // values to reduce the chance of dupes
322 $max = mt_getrandmax() + 1;
323 $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
324 return $rand;
325}
326
337function wfRandomString( $length = 32 ) {
338 $str = '';
339 for ( $n = 0; $n < $length; $n += 7 ) {
340 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
341 }
342 return substr( $str, 0, $length );
343}
344
372function wfUrlencode( $s ) {
373 static $needle;
374
375 if ( is_null( $s ) ) {
376 $needle = null;
377 return '';
378 }
379
380 if ( is_null( $needle ) ) {
381 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
382 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
383 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
384 ) {
385 $needle[] = '%3A';
386 }
387 }
388
389 $s = urlencode( $s );
390 $s = str_ireplace(
391 $needle,
392 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
393 $s
394 );
395
396 return $s;
397}
398
409function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
410 if ( !is_null( $array2 ) ) {
411 $array1 = $array1 + $array2;
412 }
413
414 $cgi = '';
415 foreach ( $array1 as $key => $value ) {
416 if ( !is_null( $value ) && $value !== false ) {
417 if ( $cgi != '' ) {
418 $cgi .= '&';
419 }
420 if ( $prefix !== '' ) {
421 $key = $prefix . "[$key]";
422 }
423 if ( is_array( $value ) ) {
424 $firstTime = true;
425 foreach ( $value as $k => $v ) {
426 $cgi .= $firstTime ? '' : '&';
427 if ( is_array( $v ) ) {
428 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
429 } else {
430 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
431 }
432 $firstTime = false;
433 }
434 } else {
435 if ( is_object( $value ) ) {
436 $value = $value->__toString();
437 }
438 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
439 }
440 }
441 }
442 return $cgi;
443}
444
454function wfCgiToArray( $query ) {
455 if ( isset( $query[0] ) && $query[0] == '?' ) {
456 $query = substr( $query, 1 );
457 }
458 $bits = explode( '&', $query );
459 $ret = [];
460 foreach ( $bits as $bit ) {
461 if ( $bit === '' ) {
462 continue;
463 }
464 if ( strpos( $bit, '=' ) === false ) {
465 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
466 $key = $bit;
467 $value = '';
468 } else {
469 list( $key, $value ) = explode( '=', $bit );
470 }
471 $key = urldecode( $key );
472 $value = urldecode( $value );
473 if ( strpos( $key, '[' ) !== false ) {
474 $keys = array_reverse( explode( '[', $key ) );
475 $key = array_pop( $keys );
476 $temp = $value;
477 foreach ( $keys as $k ) {
478 $k = substr( $k, 0, -1 );
479 $temp = [ $k => $temp ];
480 }
481 if ( isset( $ret[$key] ) ) {
482 $ret[$key] = array_merge( $ret[$key], $temp );
483 } else {
484 $ret[$key] = $temp;
485 }
486 } else {
487 $ret[$key] = $value;
488 }
489 }
490 return $ret;
491}
492
501function wfAppendQuery( $url, $query ) {
502 if ( is_array( $query ) ) {
504 }
505 if ( $query != '' ) {
506 // Remove the fragment, if there is one
507 $fragment = false;
508 $hashPos = strpos( $url, '#' );
509 if ( $hashPos !== false ) {
510 $fragment = substr( $url, $hashPos );
511 $url = substr( $url, 0, $hashPos );
512 }
513
514 // Add parameter
515 if ( false === strpos( $url, '?' ) ) {
516 $url .= '?';
517 } else {
518 $url .= '&';
519 }
520 $url .= $query;
521
522 // Put the fragment back
523 if ( $fragment !== false ) {
524 $url .= $fragment;
525 }
526 }
527 return $url;
528}
529
553function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
556 if ( $defaultProto === PROTO_CANONICAL ) {
557 $serverUrl = $wgCanonicalServer;
558 } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
559 // Make $wgInternalServer fall back to $wgServer if not set
560 $serverUrl = $wgInternalServer;
561 } else {
562 $serverUrl = $wgServer;
563 if ( $defaultProto === PROTO_CURRENT ) {
564 $defaultProto = $wgRequest->getProtocol() . '://';
565 }
566 }
567
568 // Analyze $serverUrl to obtain its protocol
569 $bits = wfParseUrl( $serverUrl );
570 $serverHasProto = $bits && $bits['scheme'] != '';
571
572 if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
573 if ( $serverHasProto ) {
574 $defaultProto = $bits['scheme'] . '://';
575 } else {
576 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
577 // This really isn't supposed to happen. Fall back to HTTP in this
578 // ridiculous case.
579 $defaultProto = PROTO_HTTP;
580 }
581 }
582
583 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
584
585 if ( substr( $url, 0, 2 ) == '//' ) {
586 $url = $defaultProtoWithoutSlashes . $url;
587 } elseif ( substr( $url, 0, 1 ) == '/' ) {
588 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
589 // otherwise leave it alone.
590 $url = ( $serverHasProto ? '' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
591 }
592
593 $bits = wfParseUrl( $url );
594
595 // ensure proper port for HTTPS arrives in URL
596 // https://phabricator.wikimedia.org/T67184
597 if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
598 $bits['port'] = $wgHttpsPort;
599 }
600
601 if ( $bits && isset( $bits['path'] ) ) {
602 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
603 return wfAssembleUrl( $bits );
604 } elseif ( $bits ) {
605 # No path to expand
606 return $url;
607 } elseif ( substr( $url, 0, 1 ) != '/' ) {
608 # URL is a relative path
609 return wfRemoveDotSegments( $url );
610 }
611
612 # Expanded URL is not valid.
613 return false;
614}
615
629function wfAssembleUrl( $urlParts ) {
630 $result = '';
631
632 if ( isset( $urlParts['delimiter'] ) ) {
633 if ( isset( $urlParts['scheme'] ) ) {
634 $result .= $urlParts['scheme'];
635 }
636
637 $result .= $urlParts['delimiter'];
638 }
639
640 if ( isset( $urlParts['host'] ) ) {
641 if ( isset( $urlParts['user'] ) ) {
642 $result .= $urlParts['user'];
643 if ( isset( $urlParts['pass'] ) ) {
644 $result .= ':' . $urlParts['pass'];
645 }
646 $result .= '@';
647 }
648
649 $result .= $urlParts['host'];
650
651 if ( isset( $urlParts['port'] ) ) {
652 $result .= ':' . $urlParts['port'];
653 }
654 }
655
656 if ( isset( $urlParts['path'] ) ) {
657 $result .= $urlParts['path'];
658 }
659
660 if ( isset( $urlParts['query'] ) ) {
661 $result .= '?' . $urlParts['query'];
662 }
663
664 if ( isset( $urlParts['fragment'] ) ) {
665 $result .= '#' . $urlParts['fragment'];
666 }
667
668 return $result;
669}
670
681function wfRemoveDotSegments( $urlPath ) {
682 $output = '';
683 $inputOffset = 0;
684 $inputLength = strlen( $urlPath );
685
686 while ( $inputOffset < $inputLength ) {
687 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
688 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
689 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
690 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
691 $trimOutput = false;
692
693 if ( $prefixLengthTwo == './' ) {
694 # Step A, remove leading "./"
695 $inputOffset += 2;
696 } elseif ( $prefixLengthThree == '../' ) {
697 # Step A, remove leading "../"
698 $inputOffset += 3;
699 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
700 # Step B, replace leading "/.$" with "/"
701 $inputOffset += 1;
702 $urlPath[$inputOffset] = '/';
703 } elseif ( $prefixLengthThree == '/./' ) {
704 # Step B, replace leading "/./" with "/"
705 $inputOffset += 2;
706 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
707 # Step C, replace leading "/..$" with "/" and
708 # remove last path component in output
709 $inputOffset += 2;
710 $urlPath[$inputOffset] = '/';
711 $trimOutput = true;
712 } elseif ( $prefixLengthFour == '/../' ) {
713 # Step C, replace leading "/../" with "/" and
714 # remove last path component in output
715 $inputOffset += 3;
716 $trimOutput = true;
717 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
718 # Step D, remove "^.$"
719 $inputOffset += 1;
720 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
721 # Step D, remove "^..$"
722 $inputOffset += 2;
723 } else {
724 # Step E, move leading path segment to output
725 if ( $prefixLengthOne == '/' ) {
726 $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
727 } else {
728 $slashPos = strpos( $urlPath, '/', $inputOffset );
729 }
730 if ( $slashPos === false ) {
731 $output .= substr( $urlPath, $inputOffset );
732 $inputOffset = $inputLength;
733 } else {
734 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
735 $inputOffset += $slashPos - $inputOffset;
736 }
737 }
738
739 if ( $trimOutput ) {
740 $slashPos = strrpos( $output, '/' );
741 if ( $slashPos === false ) {
742 $output = '';
743 } else {
744 $output = substr( $output, 0, $slashPos );
745 }
746 }
747 }
748
749 return $output;
750}
751
759function wfUrlProtocols( $includeProtocolRelative = true ) {
761
762 // Cache return values separately based on $includeProtocolRelative
763 static $withProtRel = null, $withoutProtRel = null;
764 $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
765 if ( !is_null( $cachedValue ) ) {
766 return $cachedValue;
767 }
768
769 // Support old-style $wgUrlProtocols strings, for backwards compatibility
770 // with LocalSettings files from 1.5
771 if ( is_array( $wgUrlProtocols ) ) {
772 $protocols = [];
773 foreach ( $wgUrlProtocols as $protocol ) {
774 // Filter out '//' if !$includeProtocolRelative
775 if ( $includeProtocolRelative || $protocol !== '//' ) {
776 $protocols[] = preg_quote( $protocol, '/' );
777 }
778 }
779
780 $retval = implode( '|', $protocols );
781 } else {
782 // Ignore $includeProtocolRelative in this case
783 // This case exists for pre-1.6 compatibility, and we can safely assume
784 // that '//' won't appear in a pre-1.6 config because protocol-relative
785 // URLs weren't supported until 1.18
787 }
788
789 // Cache return value
790 if ( $includeProtocolRelative ) {
791 $withProtRel = $retval;
792 } else {
793 $withoutProtRel = $retval;
794 }
795 return $retval;
796}
797
805 return wfUrlProtocols( false );
806}
807
819function wfParseUrl( $url ) {
820 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
821
822 // Protocol-relative URLs are handled really badly by parse_url(). It's so
823 // bad that the easiest way to handle them is to just prepend 'http:' and
824 // strip the protocol out later.
825 $wasRelative = substr( $url, 0, 2 ) == '//';
826 if ( $wasRelative ) {
827 $url = "http:$url";
828 }
829 MediaWiki\suppressWarnings();
830 $bits = parse_url( $url );
831 MediaWiki\restoreWarnings();
832 // parse_url() returns an array without scheme for some invalid URLs, e.g.
833 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
834 if ( !$bits || !isset( $bits['scheme'] ) ) {
835 return false;
836 }
837
838 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
839 $bits['scheme'] = strtolower( $bits['scheme'] );
840
841 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
842 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
843 $bits['delimiter'] = '://';
844 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
845 $bits['delimiter'] = ':';
846 // parse_url detects for news: and mailto: the host part of an url as path
847 // We have to correct this wrong detection
848 if ( isset( $bits['path'] ) ) {
849 $bits['host'] = $bits['path'];
850 $bits['path'] = '';
851 }
852 } else {
853 return false;
854 }
855
856 /* Provide an empty host for eg. file:/// urls (see T30627) */
857 if ( !isset( $bits['host'] ) ) {
858 $bits['host'] = '';
859
860 // See T47069
861 if ( isset( $bits['path'] ) ) {
862 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
863 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
864 $bits['path'] = '/' . $bits['path'];
865 }
866 } else {
867 $bits['path'] = '';
868 }
869 }
870
871 // If the URL was protocol-relative, fix scheme and delimiter
872 if ( $wasRelative ) {
873 $bits['scheme'] = '';
874 $bits['delimiter'] = '//';
875 }
876 return $bits;
877}
878
889function wfExpandIRI( $url ) {
890 return preg_replace_callback(
891 '/((?:%[89A-F][0-9A-F])+)/i',
892 'wfExpandIRI_callback',
893 wfExpandUrl( $url )
894 );
895}
896
903 return urldecode( $matches[1] );
904}
905
912function wfMakeUrlIndexes( $url ) {
913 $bits = wfParseUrl( $url );
914
915 // Reverse the labels in the hostname, convert to lower case
916 // For emails reverse domainpart only
917 if ( $bits['scheme'] == 'mailto' ) {
918 $mailparts = explode( '@', $bits['host'], 2 );
919 if ( count( $mailparts ) === 2 ) {
920 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
921 } else {
922 // No domain specified, don't mangle it
923 $domainpart = '';
924 }
925 $reversedHost = $domainpart . '@' . $mailparts[0];
926 } else {
927 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
928 }
929 // Add an extra dot to the end
930 // Why? Is it in wrong place in mailto links?
931 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
932 $reversedHost .= '.';
933 }
934 // Reconstruct the pseudo-URL
935 $prot = $bits['scheme'];
936 $index = $prot . $bits['delimiter'] . $reversedHost;
937 // Leave out user and password. Add the port, path, query and fragment
938 if ( isset( $bits['port'] ) ) {
939 $index .= ':' . $bits['port'];
940 }
941 if ( isset( $bits['path'] ) ) {
942 $index .= $bits['path'];
943 } else {
944 $index .= '/';
945 }
946 if ( isset( $bits['query'] ) ) {
947 $index .= '?' . $bits['query'];
948 }
949 if ( isset( $bits['fragment'] ) ) {
950 $index .= '#' . $bits['fragment'];
951 }
952
953 if ( $prot == '' ) {
954 return [ "http:$index", "https:$index" ];
955 } else {
956 return [ $index ];
957 }
958}
959
966function wfMatchesDomainList( $url, $domains ) {
967 $bits = wfParseUrl( $url );
968 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
969 $host = '.' . $bits['host'];
970 foreach ( (array)$domains as $domain ) {
971 $domain = '.' . $domain;
972 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
973 return true;
974 }
975 }
976 }
977 return false;
978}
979
1000function wfDebug( $text, $dest = 'all', array $context = [] ) {
1003
1004 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1005 return;
1006 }
1007
1008 $text = trim( $text );
1009
1010 if ( $wgDebugTimestamps ) {
1011 $context['seconds_elapsed'] = sprintf(
1012 '%6.4f',
1013 microtime( true ) - $wgRequestTime
1014 );
1015 $context['memory_used'] = sprintf(
1016 '%5.1fM',
1017 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1018 );
1019 }
1020
1021 if ( $wgDebugLogPrefix !== '' ) {
1022 $context['prefix'] = $wgDebugLogPrefix;
1023 }
1024 $context['private'] = ( $dest === false || $dest === 'private' );
1025
1026 $logger = LoggerFactory::getInstance( 'wfDebug' );
1027 $logger->debug( $text, $context );
1028}
1029
1035 static $cache;
1036 if ( $cache !== null ) {
1037 return $cache;
1038 }
1039 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1040 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1041 || (
1042 isset( $_SERVER['SCRIPT_NAME'] )
1043 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1044 )
1045 ) {
1046 $cache = true;
1047 } else {
1048 $cache = false;
1049 }
1050 return $cache;
1051}
1052
1058function wfDebugMem( $exact = false ) {
1059 $mem = memory_get_usage();
1060 if ( !$exact ) {
1061 $mem = floor( $mem / 1024 ) . ' KiB';
1062 } else {
1063 $mem .= ' B';
1064 }
1065 wfDebug( "Memory usage: $mem\n" );
1066}
1067
1093function wfDebugLog(
1094 $logGroup, $text, $dest = 'all', array $context = []
1095) {
1096 $text = trim( $text );
1097
1098 $logger = LoggerFactory::getInstance( $logGroup );
1099 $context['private'] = ( $dest === false || $dest === 'private' );
1100 $logger->info( $text, $context );
1101}
1102
1111function wfLogDBError( $text, array $context = [] ) {
1112 $logger = LoggerFactory::getInstance( 'wfLogDBError' );
1113 $logger->error( trim( $text ), $context );
1114}
1115
1129function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1130 MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1131}
1132
1143function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1144 MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1145}
1146
1156function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1157 MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1158}
1159
1173function wfErrorLog( $text, $file, array $context = [] ) {
1174 wfDeprecated( __METHOD__, '1.25' );
1175 $logger = LoggerFactory::getInstance( 'wfErrorLog' );
1176 $context['destination'] = $file;
1177 $logger->info( trim( $text ), $context );
1178}
1179
1185
1188
1189 $profiler = Profiler::instance();
1190 $profiler->setContext( $context );
1191 $profiler->logData();
1192
1193 $config = $context->getConfig();
1194 if ( $config->get( 'StatsdServer' ) ) {
1195 try {
1196 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1197 $statsdHost = $statsdServer[0];
1198 $statsdPort = isset( $statsdServer[1] ) ? $statsdServer[1] : 8125;
1199 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1200 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
1201 $statsdClient->setSamplingRates( $config->get( 'StatsdSamplingRates' ) );
1202 $statsdClient->send(
1203 MediaWikiServices::getInstance()->getStatsdDataFactory()->getBuffer()
1204 );
1205 } catch ( Exception $ex ) {
1206 MWExceptionHandler::logException( $ex );
1207 }
1208 }
1209
1210 # Profiling must actually be enabled...
1211 if ( $profiler instanceof ProfilerStub ) {
1212 return;
1213 }
1214
1215 if ( isset( $wgDebugLogGroups['profileoutput'] )
1216 && $wgDebugLogGroups['profileoutput'] === false
1217 ) {
1218 // Explicitly disabled
1219 return;
1220 }
1221 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1222 return;
1223 }
1224
1225 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1226 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1227 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1228 }
1229 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1230 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1231 }
1232 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1233 $ctx['from'] = $_SERVER['HTTP_FROM'];
1234 }
1235 if ( isset( $ctx['forwarded_for'] ) ||
1236 isset( $ctx['client_ip'] ) ||
1237 isset( $ctx['from'] ) ) {
1238 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1239 }
1240
1241 // Don't load $wgUser at this late stage just for statistics purposes
1242 // @todo FIXME: We can detect some anons even if it is not loaded.
1243 // See User::getId()
1244 $user = $context->getUser();
1245 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1246
1247 // Command line script uses a FauxRequest object which does not have
1248 // any knowledge about an URL and throw an exception instead.
1249 try {
1250 $ctx['url'] = urldecode( $request->getRequestURL() );
1251 } catch ( Exception $ignored ) {
1252 // no-op
1253 }
1254
1255 $ctx['output'] = $profiler->getOutput();
1256
1257 $log = LoggerFactory::getInstance( 'profileoutput' );
1258 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1259}
1260
1268function wfIncrStats( $key, $count = 1 ) {
1269 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1270 $stats->updateCount( $key, $count );
1271}
1272
1278function wfReadOnly() {
1279 return \MediaWiki\MediaWikiServices::getInstance()->getReadOnlyMode()
1280 ->isReadOnly();
1281}
1282
1292 return \MediaWiki\MediaWikiServices::getInstance()->getReadOnlyMode()
1293 ->getReason();
1294}
1295
1303 return \MediaWiki\MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1304 ->getReason();
1305}
1306
1322function wfGetLangObj( $langcode = false ) {
1323 # Identify which language to get or create a language object for.
1324 # Using is_object here due to Stub objects.
1325 if ( is_object( $langcode ) ) {
1326 # Great, we already have the object (hopefully)!
1327 return $langcode;
1328 }
1329
1331 if ( $langcode === true || $langcode === $wgLanguageCode ) {
1332 # $langcode is the language code of the wikis content language object.
1333 # or it is a boolean and value is true
1334 return $wgContLang;
1335 }
1336
1338 if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1339 # $langcode is the language code of user language object.
1340 # or it was a boolean and value is false
1341 return $wgLang;
1342 }
1343
1344 $validCodes = array_keys( Language::fetchLanguageNames() );
1345 if ( in_array( $langcode, $validCodes ) ) {
1346 # $langcode corresponds to a valid language.
1347 return Language::factory( $langcode );
1348 }
1349
1350 # $langcode is a string, but not a valid language code; use content language.
1351 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1352 return $wgContLang;
1353}
1354
1371function wfMessage( $key /*...*/ ) {
1372 $message = new Message( $key );
1373
1374 // We call Message::params() to reduce code duplication
1375 $params = func_get_args();
1376 array_shift( $params );
1377 if ( $params ) {
1378 call_user_func_array( [ $message, 'params' ], $params );
1379 }
1380
1381 return $message;
1382}
1383
1396function wfMessageFallback( /*...*/ ) {
1397 $args = func_get_args();
1398 return call_user_func_array( 'Message::newFallbackSequence', $args );
1399}
1400
1409function wfMsgReplaceArgs( $message, $args ) {
1410 # Fix windows line-endings
1411 # Some messages are split with explode("\n", $msg)
1412 $message = str_replace( "\r", '', $message );
1413
1414 // Replace arguments
1415 if ( is_array( $args ) && $args ) {
1416 if ( is_array( $args[0] ) ) {
1417 $args = array_values( $args[0] );
1418 }
1419 $replacementKeys = [];
1420 foreach ( $args as $n => $param ) {
1421 $replacementKeys['$' . ( $n + 1 )] = $param;
1422 }
1423 $message = strtr( $message, $replacementKeys );
1424 }
1425
1426 return $message;
1427}
1428
1436function wfHostname() {
1437 static $host;
1438 if ( is_null( $host ) ) {
1439
1440 # Hostname overriding
1442 if ( $wgOverrideHostname !== false ) {
1443 # Set static and skip any detection
1444 $host = $wgOverrideHostname;
1445 return $host;
1446 }
1447
1448 if ( function_exists( 'posix_uname' ) ) {
1449 // This function not present on Windows
1450 $uname = posix_uname();
1451 } else {
1452 $uname = false;
1453 }
1454 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1455 $host = $uname['nodename'];
1456 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1457 # Windows computer name
1458 $host = getenv( 'COMPUTERNAME' );
1459 } else {
1460 # This may be a virtual server.
1461 $host = $_SERVER['SERVER_NAME'];
1462 }
1463 }
1464 return $host;
1465}
1466
1476function wfReportTime() {
1478
1479 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1480 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1481 if ( $wgShowHostnames ) {
1482 $reportVars['wgHostname'] = wfHostname();
1483 }
1484 return Skin::makeVariablesScript( $reportVars );
1485}
1486
1497function wfDebugBacktrace( $limit = 0 ) {
1498 static $disabled = null;
1499
1500 if ( is_null( $disabled ) ) {
1501 $disabled = !function_exists( 'debug_backtrace' );
1502 if ( $disabled ) {
1503 wfDebug( "debug_backtrace() is disabled\n" );
1504 }
1505 }
1506 if ( $disabled ) {
1507 return [];
1508 }
1509
1510 if ( $limit ) {
1511 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1512 } else {
1513 return array_slice( debug_backtrace(), 1 );
1514 }
1515}
1516
1525function wfBacktrace( $raw = null ) {
1527
1528 if ( $raw === null ) {
1529 $raw = $wgCommandLineMode;
1530 }
1531
1532 if ( $raw ) {
1533 $frameFormat = "%s line %s calls %s()\n";
1534 $traceFormat = "%s";
1535 } else {
1536 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1537 $traceFormat = "<ul>\n%s</ul>\n";
1538 }
1539
1540 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1541 $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1542 $line = isset( $frame['line'] ) ? $frame['line'] : '-';
1543 $call = $frame['function'];
1544 if ( !empty( $frame['class'] ) ) {
1545 $call = $frame['class'] . $frame['type'] . $call;
1546 }
1547 return sprintf( $frameFormat, $file, $line, $call );
1548 }, wfDebugBacktrace() );
1549
1550 return sprintf( $traceFormat, implode( '', $frames ) );
1551}
1552
1562function wfGetCaller( $level = 2 ) {
1563 $backtrace = wfDebugBacktrace( $level + 1 );
1564 if ( isset( $backtrace[$level] ) ) {
1565 return wfFormatStackFrame( $backtrace[$level] );
1566 } else {
1567 return 'unknown';
1568 }
1569}
1570
1578function wfGetAllCallers( $limit = 3 ) {
1579 $trace = array_reverse( wfDebugBacktrace() );
1580 if ( !$limit || $limit > count( $trace ) - 1 ) {
1581 $limit = count( $trace ) - 1;
1582 }
1583 $trace = array_slice( $trace, -$limit - 1, $limit );
1584 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1585}
1586
1593function wfFormatStackFrame( $frame ) {
1594 if ( !isset( $frame['function'] ) ) {
1595 return 'NO_FUNCTION_GIVEN';
1596 }
1597 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1598 $frame['class'] . $frame['type'] . $frame['function'] :
1599 $frame['function'];
1600}
1601
1602/* Some generic result counters, pulled out of SearchEngine */
1603
1611function wfShowingResults( $offset, $limit ) {
1612 return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1613}
1614
1624function wfClientAcceptsGzip( $force = false ) {
1625 static $result = null;
1626 if ( $result === null || $force ) {
1627 $result = false;
1628 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1629 # @todo FIXME: We may want to blacklist some broken browsers
1630 $m = [];
1631 if ( preg_match(
1632 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1633 $_SERVER['HTTP_ACCEPT_ENCODING'],
1634 $m
1635 )
1636 ) {
1637 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1638 $result = false;
1639 return $result;
1640 }
1641 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1642 $result = true;
1643 }
1644 }
1645 }
1646 return $result;
1647}
1648
1658function wfEscapeWikiText( $text ) {
1660 static $repl = null, $repl2 = null;
1661 if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1662 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1663 // in those situations
1664 $repl = [
1665 '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1666 '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1667 '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1668 "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1669 "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1670 "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1671 "\n " => "\n&#32;", "\r " => "\r&#32;",
1672 "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1673 "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1674 "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1675 "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1676 '__' => '_&#95;', '://' => '&#58;//',
1677 ];
1678
1679 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1680 // We have to catch everything "\s" matches in PCRE
1681 foreach ( $magicLinks as $magic ) {
1682 $repl["$magic "] = "$magic&#32;";
1683 $repl["$magic\t"] = "$magic&#9;";
1684 $repl["$magic\r"] = "$magic&#13;";
1685 $repl["$magic\n"] = "$magic&#10;";
1686 $repl["$magic\f"] = "$magic&#12;";
1687 }
1688
1689 // And handle protocols that don't use "://"
1691 $repl2 = [];
1692 foreach ( $wgUrlProtocols as $prot ) {
1693 if ( substr( $prot, -1 ) === ':' ) {
1694 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1695 }
1696 }
1697 $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1698 }
1699 $text = substr( strtr( "\n$text", $repl ), 1 );
1700 $text = preg_replace( $repl2, '$1&#58;', $text );
1701 return $text;
1702}
1703
1714function wfSetVar( &$dest, $source, $force = false ) {
1715 $temp = $dest;
1716 if ( !is_null( $source ) || $force ) {
1717 $dest = $source;
1718 }
1719 return $temp;
1720}
1721
1731function wfSetBit( &$dest, $bit, $state = true ) {
1732 $temp = (bool)( $dest & $bit );
1733 if ( !is_null( $state ) ) {
1734 if ( $state ) {
1735 $dest |= $bit;
1736 } else {
1737 $dest &= ~$bit;
1738 }
1739 }
1740 return $temp;
1741}
1742
1749function wfVarDump( $var ) {
1750 global $wgOut;
1751 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1752 if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1753 print $s;
1754 } else {
1755 $wgOut->addHTML( $s );
1756 }
1757}
1758
1766function wfHttpError( $code, $label, $desc ) {
1767 global $wgOut;
1769 if ( $wgOut ) {
1770 $wgOut->disable();
1771 $wgOut->sendCacheControl();
1772 }
1773
1774 MediaWiki\HeaderCallback::warnIfHeadersSent();
1775 header( 'Content-type: text/html; charset=utf-8' );
1776 print '<!DOCTYPE html>' .
1777 '<html><head><title>' .
1778 htmlspecialchars( $label ) .
1779 '</title></head><body><h1>' .
1780 htmlspecialchars( $label ) .
1781 '</h1><p>' .
1782 nl2br( htmlspecialchars( $desc ) ) .
1783 "</p></body></html>\n";
1784}
1785
1803function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1804 if ( $resetGzipEncoding ) {
1805 // Suppress Content-Encoding and Content-Length
1806 // headers from 1.10+s wfOutputHandler
1809 }
1810 while ( $status = ob_get_status() ) {
1811 if ( isset( $status['flags'] ) ) {
1812 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1813 $deleteable = ( $status['flags'] & $flags ) === $flags;
1814 } elseif ( isset( $status['del'] ) ) {
1815 $deleteable = $status['del'];
1816 } else {
1817 // Guess that any PHP-internal setting can't be removed.
1818 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1819 }
1820 if ( !$deleteable ) {
1821 // Give up, and hope the result doesn't break
1822 // output behavior.
1823 break;
1824 }
1825 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1826 // Unit testing barrier to prevent this function from breaking PHPUnit.
1827 break;
1828 }
1829 if ( !ob_end_clean() ) {
1830 // Could not remove output buffer handler; abort now
1831 // to avoid getting in some kind of infinite loop.
1832 break;
1833 }
1834 if ( $resetGzipEncoding ) {
1835 if ( $status['name'] == 'ob_gzhandler' ) {
1836 // Reset the 'Content-Encoding' field set by this handler
1837 // so we can start fresh.
1838 header_remove( 'Content-Encoding' );
1839 break;
1840 }
1841 }
1842 }
1843}
1844
1858 wfResetOutputBuffers( false );
1859}
1860
1869function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1870 # No arg means accept anything (per HTTP spec)
1871 if ( !$accept ) {
1872 return [ $def => 1.0 ];
1873 }
1874
1875 $prefs = [];
1876
1877 $parts = explode( ',', $accept );
1878
1879 foreach ( $parts as $part ) {
1880 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1881 $values = explode( ';', trim( $part ) );
1882 $match = [];
1883 if ( count( $values ) == 1 ) {
1884 $prefs[$values[0]] = 1.0;
1885 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1886 $prefs[$values[0]] = floatval( $match[1] );
1887 }
1888 }
1889
1890 return $prefs;
1891}
1892
1905function mimeTypeMatch( $type, $avail ) {
1906 if ( array_key_exists( $type, $avail ) ) {
1907 return $type;
1908 } else {
1909 $mainType = explode( '/', $type )[0];
1910 if ( array_key_exists( "$mainType/*", $avail ) ) {
1911 return "$mainType/*";
1912 } elseif ( array_key_exists( '*/*', $avail ) ) {
1913 return '*/*';
1914 } else {
1915 return null;
1916 }
1917 }
1918}
1919
1933function wfNegotiateType( $cprefs, $sprefs ) {
1934 $combine = [];
1935
1936 foreach ( array_keys( $sprefs ) as $type ) {
1937 $subType = explode( '/', $type )[1];
1938 if ( $subType != '*' ) {
1939 $ckey = mimeTypeMatch( $type, $cprefs );
1940 if ( $ckey ) {
1941 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1942 }
1943 }
1944 }
1945
1946 foreach ( array_keys( $cprefs ) as $type ) {
1947 $subType = explode( '/', $type )[1];
1948 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1949 $skey = mimeTypeMatch( $type, $sprefs );
1950 if ( $skey ) {
1951 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1952 }
1953 }
1954 }
1955
1956 $bestq = 0;
1957 $besttype = null;
1958
1959 foreach ( array_keys( $combine ) as $type ) {
1960 if ( $combine[$type] > $bestq ) {
1961 $besttype = $type;
1962 $bestq = $combine[$type];
1963 }
1964 }
1965
1966 return $besttype;
1967}
1968
1975function wfSuppressWarnings( $end = false ) {
1976 MediaWiki\suppressWarnings( $end );
1977}
1978
1984 MediaWiki\suppressWarnings( true );
1985}
1986
1995function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1996 $ret = MWTimestamp::convert( $outputtype, $ts );
1997 if ( $ret === false ) {
1998 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1999 }
2000 return $ret;
2001}
2002
2011function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
2012 if ( is_null( $ts ) ) {
2013 return null;
2014 } else {
2015 return wfTimestamp( $outputtype, $ts );
2016 }
2017}
2018
2024function wfTimestampNow() {
2025 # return NOW
2026 return MWTimestamp::now( TS_MW );
2027}
2028
2034function wfIsWindows() {
2035 static $isWindows = null;
2036 if ( $isWindows === null ) {
2037 $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
2038 }
2039 return $isWindows;
2040}
2041
2047function wfIsHHVM() {
2048 return defined( 'HHVM_VERSION' );
2049}
2050
2062function wfTempDir() {
2064
2065 if ( $wgTmpDirectory !== false ) {
2066 return $wgTmpDirectory;
2067 }
2068
2070}
2071
2081function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2083
2084 if ( FileBackend::isStoragePath( $dir ) ) { // sanity
2085 throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
2086 }
2087
2088 if ( !is_null( $caller ) ) {
2089 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2090 }
2091
2092 if ( strval( $dir ) === '' || is_dir( $dir ) ) {
2093 return true;
2094 }
2095
2096 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
2097
2098 if ( is_null( $mode ) ) {
2099 $mode = $wgDirectoryMode;
2100 }
2101
2102 // Turn off the normal warning, we're doing our own below
2103 MediaWiki\suppressWarnings();
2104 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2105 MediaWiki\restoreWarnings();
2106
2107 if ( !$ok ) {
2108 // directory may have been created on another request since we last checked
2109 if ( is_dir( $dir ) ) {
2110 return true;
2111 }
2112
2113 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2114 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2115 }
2116 return $ok;
2117}
2118
2124function wfRecursiveRemoveDir( $dir ) {
2125 wfDebug( __FUNCTION__ . "( $dir )\n" );
2126 // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2127 if ( is_dir( $dir ) ) {
2128 $objects = scandir( $dir );
2129 foreach ( $objects as $object ) {
2130 if ( $object != "." && $object != ".." ) {
2131 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2132 wfRecursiveRemoveDir( $dir . '/' . $object );
2133 } else {
2134 unlink( $dir . '/' . $object );
2135 }
2136 }
2137 }
2138 reset( $objects );
2139 rmdir( $dir );
2140 }
2141}
2142
2149function wfPercent( $nr, $acc = 2, $round = true ) {
2150 $ret = sprintf( "%.${acc}f", $nr );
2151 return $round ? round( $ret, $acc ) . '%' : "$ret%";
2152}
2153
2177function wfIniGetBool( $setting ) {
2178 $val = strtolower( ini_get( $setting ) );
2179 // 'on' and 'true' can't have whitespace around them, but '1' can.
2180 return $val == 'on'
2181 || $val == 'true'
2182 || $val == 'yes'
2183 || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2184}
2185
2196function wfEscapeShellArg( /*...*/ ) {
2198
2199 $args = func_get_args();
2200 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
2201 // If only one argument has been passed, and that argument is an array,
2202 // treat it as a list of arguments
2203 $args = reset( $args );
2204 }
2205
2206 $first = true;
2207 $retVal = '';
2208 foreach ( $args as $arg ) {
2209 if ( !$first ) {
2210 $retVal .= ' ';
2211 } else {
2212 $first = false;
2213 }
2214
2215 if ( wfIsWindows() ) {
2216 // Escaping for an MSVC-style command line parser and CMD.EXE
2217 // @codingStandardsIgnoreStart For long URLs
2218 // Refs:
2219 // * https://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2220 // * https://technet.microsoft.com/en-us/library/cc723564.aspx
2221 // * T15518
2222 // * CR r63214
2223 // Double the backslashes before any double quotes. Escape the double quotes.
2224 // @codingStandardsIgnoreEnd
2225 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE );
2226 $arg = '';
2227 $iteration = 0;
2228 foreach ( $tokens as $token ) {
2229 if ( $iteration % 2 == 1 ) {
2230 // Delimiter, a double quote preceded by zero or more slashes
2231 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2232 } elseif ( $iteration % 4 == 2 ) {
2233 // ^ in $token will be outside quotes, need to be escaped
2234 $arg .= str_replace( '^', '^^', $token );
2235 } else { // $iteration % 4 == 0
2236 // ^ in $token will appear inside double quotes, so leave as is
2237 $arg .= $token;
2238 }
2239 $iteration++;
2240 }
2241 // Double the backslashes before the end of the string, because
2242 // we will soon add a quote
2243 $m = [];
2244 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2245 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2246 }
2247
2248 // Add surrounding quotes
2249 $retVal .= '"' . $arg . '"';
2250 } else {
2251 $retVal .= escapeshellarg( $arg );
2252 }
2253 }
2254 return $retVal;
2255}
2256
2264 static $disabled = null;
2265 if ( is_null( $disabled ) ) {
2266 if ( !function_exists( 'proc_open' ) ) {
2267 wfDebug( "proc_open() is disabled\n" );
2268 $disabled = 'disabled';
2269 } else {
2270 $disabled = false;
2271 }
2272 }
2273 return $disabled;
2274}
2275
2298function wfShellExec( $cmd, &$retval = null, $environ = [],
2299 $limits = [], $options = []
2300) {
2303
2304 $disabled = wfShellExecDisabled();
2305 if ( $disabled ) {
2306 $retval = 1;
2307 return 'Unable to run external programs, proc_open() is disabled.';
2308 }
2309
2310 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2311 $profileMethod = isset( $options['profileMethod'] ) ? $options['profileMethod'] : wfGetCaller();
2312
2314
2315 $envcmd = '';
2316 foreach ( $environ as $k => $v ) {
2317 if ( wfIsWindows() ) {
2318 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2319 * appear in the environment variable, so we must use carat escaping as documented in
2320 * https://technet.microsoft.com/en-us/library/cc723564.aspx
2321 * Note however that the quote isn't listed there, but is needed, and the parentheses
2322 * are listed there but doesn't appear to need it.
2323 */
2324 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2325 } else {
2326 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2327 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2328 */
2329 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2330 }
2331 }
2332 if ( is_array( $cmd ) ) {
2333 $cmd = wfEscapeShellArg( $cmd );
2334 }
2335
2336 $cmd = $envcmd . $cmd;
2337
2338 $useLogPipe = false;
2339 if ( is_executable( '/bin/bash' ) ) {
2340 $time = intval( isset( $limits['time'] ) ? $limits['time'] : $wgMaxShellTime );
2341 if ( isset( $limits['walltime'] ) ) {
2342 $wallTime = intval( $limits['walltime'] );
2343 } elseif ( isset( $limits['time'] ) ) {
2344 $wallTime = $time;
2345 } else {
2346 $wallTime = intval( $wgMaxShellWallClockTime );
2347 }
2348 $mem = intval( isset( $limits['memory'] ) ? $limits['memory'] : $wgMaxShellMemory );
2349 $filesize = intval( isset( $limits['filesize'] ) ? $limits['filesize'] : $wgMaxShellFileSize );
2350
2351 if ( $time > 0 || $mem > 0 || $filesize > 0 || $wallTime > 0 ) {
2352 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2353 escapeshellarg( $cmd ) . ' ' .
2354 escapeshellarg(
2355 "MW_INCLUDE_STDERR=" . ( $includeStderr ? '1' : '' ) . ';' .
2356 "MW_CPU_LIMIT=$time; " .
2357 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2358 "MW_MEM_LIMIT=$mem; " .
2359 "MW_FILE_SIZE_LIMIT=$filesize; " .
2360 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2361 "MW_USE_LOG_PIPE=yes"
2362 );
2363 $useLogPipe = true;
2364 } elseif ( $includeStderr ) {
2365 $cmd .= ' 2>&1';
2366 }
2367 } elseif ( $includeStderr ) {
2368 $cmd .= ' 2>&1';
2369 }
2370 wfDebug( "wfShellExec: $cmd\n" );
2371
2372 // Don't try to execute commands that exceed Linux's MAX_ARG_STRLEN.
2373 // Other platforms may be more accomodating, but we don't want to be
2374 // accomodating, because very long commands probably include user
2375 // input. See T129506.
2376 if ( strlen( $cmd ) > SHELL_MAX_ARG_STRLEN ) {
2377 throw new Exception( __METHOD__ .
2378 '(): total length of $cmd must not exceed SHELL_MAX_ARG_STRLEN' );
2379 }
2380
2381 $desc = [
2382 0 => [ 'file', 'php://stdin', 'r' ],
2383 1 => [ 'pipe', 'w' ],
2384 2 => [ 'file', 'php://stderr', 'w' ] ];
2385 if ( $useLogPipe ) {
2386 $desc[3] = [ 'pipe', 'w' ];
2387 }
2388 $pipes = null;
2389 $scoped = Profiler::instance()->scopedProfileIn( __FUNCTION__ . '-' . $profileMethod );
2390 $proc = proc_open( $cmd, $desc, $pipes );
2391 if ( !$proc ) {
2392 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2393 $retval = -1;
2394 return '';
2395 }
2396 $outBuffer = $logBuffer = '';
2397 $emptyArray = [];
2398 $status = false;
2399 $logMsg = false;
2400
2401 /* According to the documentation, it is possible for stream_select()
2402 * to fail due to EINTR. I haven't managed to induce this in testing
2403 * despite sending various signals. If it did happen, the error
2404 * message would take the form:
2405 *
2406 * stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2407 *
2408 * where [4] is the value of the macro EINTR and "Interrupted system
2409 * call" is string which according to the Linux manual is "possibly"
2410 * localised according to LC_MESSAGES.
2411 */
2412 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR : 4;
2413 $eintrMessage = "stream_select(): unable to select [$eintr]";
2414
2415 $running = true;
2416 $timeout = null;
2417 $numReadyPipes = 0;
2418
2419 while ( $running === true || $numReadyPipes !== 0 ) {
2420 if ( $running ) {
2421 $status = proc_get_status( $proc );
2422 // If the process has terminated, switch to nonblocking selects
2423 // for getting any data still waiting to be read.
2424 if ( !$status['running'] ) {
2425 $running = false;
2426 $timeout = 0;
2427 }
2428 }
2429
2430 $readyPipes = $pipes;
2431
2432 // Clear last error
2433 \MediaWiki\suppressWarnings();
2434 trigger_error( '' );
2435 $numReadyPipes = stream_select( $readyPipes, $emptyArray, $emptyArray, $timeout );
2436 \MediaWiki\restoreWarnings();
2437
2438 if ( $numReadyPipes === false ) {
2439 // @codingStandardsIgnoreEnd
2440 $error = error_get_last();
2441 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2442 continue;
2443 } else {
2444 trigger_error( $error['message'], E_USER_WARNING );
2445 $logMsg = $error['message'];
2446 break;
2447 }
2448 }
2449 foreach ( $readyPipes as $fd => $pipe ) {
2450 $block = fread( $pipe, 65536 );
2451 if ( $block === '' ) {
2452 // End of file
2453 fclose( $pipes[$fd] );
2454 unset( $pipes[$fd] );
2455 if ( !$pipes ) {
2456 break 2;
2457 }
2458 } elseif ( $block === false ) {
2459 // Read error
2460 $logMsg = "Error reading from pipe";
2461 break 2;
2462 } elseif ( $fd == 1 ) {
2463 // From stdout
2464 $outBuffer .= $block;
2465 } elseif ( $fd == 3 ) {
2466 // From log FD
2467 $logBuffer .= $block;
2468 if ( strpos( $block, "\n" ) !== false ) {
2469 $lines = explode( "\n", $logBuffer );
2470 $logBuffer = array_pop( $lines );
2471 foreach ( $lines as $line ) {
2472 wfDebugLog( 'exec', $line );
2473 }
2474 }
2475 }
2476 }
2477 }
2478
2479 foreach ( $pipes as $pipe ) {
2480 fclose( $pipe );
2481 }
2482
2483 // Use the status previously collected if possible, since proc_get_status()
2484 // just calls waitpid() which will not return anything useful the second time.
2485 if ( $running ) {
2486 $status = proc_get_status( $proc );
2487 }
2488
2489 if ( $logMsg !== false ) {
2490 // Read/select error
2491 $retval = -1;
2492 proc_close( $proc );
2493 } elseif ( $status['signaled'] ) {
2494 $logMsg = "Exited with signal {$status['termsig']}";
2495 $retval = 128 + $status['termsig'];
2496 proc_close( $proc );
2497 } else {
2498 if ( $status['running'] ) {
2499 $retval = proc_close( $proc );
2500 } else {
2501 $retval = $status['exitcode'];
2502 proc_close( $proc );
2503 }
2504 if ( $retval == 127 ) {
2505 $logMsg = "Possibly missing executable file";
2506 } elseif ( $retval >= 129 && $retval <= 192 ) {
2507 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2508 }
2509 }
2510
2511 if ( $logMsg !== false ) {
2512 wfDebugLog( 'exec', "$logMsg: $cmd" );
2513 }
2514
2515 return $outBuffer;
2516}
2517
2534function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2535 return wfShellExec( $cmd, $retval, $environ, $limits,
2536 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2537}
2538
2544 static $done = false;
2545 if ( $done ) {
2546 return;
2547 }
2548 $done = true;
2550 putenv( "LC_CTYPE=$wgShellLocale" );
2551 setlocale( LC_CTYPE, $wgShellLocale );
2552}
2553
2566function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2568 // Give site config file a chance to run the script in a wrapper.
2569 // The caller may likely want to call wfBasename() on $script.
2570 Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2571 $cmd = isset( $options['php'] ) ? [ $options['php'] ] : [ $wgPhpCli ];
2572 if ( isset( $options['wrapper'] ) ) {
2573 $cmd[] = $options['wrapper'];
2574 }
2575 $cmd[] = $script;
2576 // Escape each parameter for shell
2577 return wfEscapeShellArg( array_merge( $cmd, $parameters ) );
2578}
2579
2590function wfMerge( $old, $mine, $yours, &$result ) {
2592
2593 # This check may also protect against code injection in
2594 # case of broken installations.
2595 MediaWiki\suppressWarnings();
2596 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2597 MediaWiki\restoreWarnings();
2598
2599 if ( !$haveDiff3 ) {
2600 wfDebug( "diff3 not found\n" );
2601 return false;
2602 }
2603
2604 # Make temporary files
2605 $td = wfTempDir();
2606 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2607 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2608 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2609
2610 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2611 # a newline character. To avoid this, we normalize the trailing whitespace before
2612 # creating the diff.
2613
2614 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2615 fclose( $oldtextFile );
2616 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2617 fclose( $mytextFile );
2618 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2619 fclose( $yourtextFile );
2620
2621 # Check for a conflict
2622 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName,
2623 $oldtextName, $yourtextName );
2624 $handle = popen( $cmd, 'r' );
2625
2626 if ( fgets( $handle, 1024 ) ) {
2627 $conflict = true;
2628 } else {
2629 $conflict = false;
2630 }
2631 pclose( $handle );
2632
2633 # Merge differences
2634 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2635 $oldtextName, $yourtextName );
2636 $handle = popen( $cmd, 'r' );
2637 $result = '';
2638 do {
2639 $data = fread( $handle, 8192 );
2640 if ( strlen( $data ) == 0 ) {
2641 break;
2642 }
2643 $result .= $data;
2644 } while ( true );
2645 pclose( $handle );
2646 unlink( $mytextName );
2647 unlink( $oldtextName );
2648 unlink( $yourtextName );
2649
2650 if ( $result === '' && $old !== '' && !$conflict ) {
2651 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2652 $conflict = true;
2653 }
2654 return !$conflict;
2655}
2656
2668function wfDiff( $before, $after, $params = '-u' ) {
2669 if ( $before == $after ) {
2670 return '';
2671 }
2672
2674 MediaWiki\suppressWarnings();
2675 $haveDiff = $wgDiff && file_exists( $wgDiff );
2676 MediaWiki\restoreWarnings();
2677
2678 # This check may also protect against code injection in
2679 # case of broken installations.
2680 if ( !$haveDiff ) {
2681 wfDebug( "diff executable not found\n" );
2682 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2683 $format = new UnifiedDiffFormatter();
2684 return $format->format( $diffs );
2685 }
2686
2687 # Make temporary files
2688 $td = wfTempDir();
2689 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2690 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2691
2692 fwrite( $oldtextFile, $before );
2693 fclose( $oldtextFile );
2694 fwrite( $newtextFile, $after );
2695 fclose( $newtextFile );
2696
2697 // Get the diff of the two files
2698 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
2699
2700 $h = popen( $cmd, 'r' );
2701 if ( !$h ) {
2702 unlink( $oldtextName );
2703 unlink( $newtextName );
2704 throw new Exception( __METHOD__ . '(): popen() failed' );
2705 }
2706
2707 $diff = '';
2708
2709 do {
2710 $data = fread( $h, 8192 );
2711 if ( strlen( $data ) == 0 ) {
2712 break;
2713 }
2714 $diff .= $data;
2715 } while ( true );
2716
2717 // Clean up
2718 pclose( $h );
2719 unlink( $oldtextName );
2720 unlink( $newtextName );
2721
2722 // Kill the --- and +++ lines. They're not useful.
2723 $diff_lines = explode( "\n", $diff );
2724 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2725 unset( $diff_lines[0] );
2726 }
2727 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2728 unset( $diff_lines[1] );
2729 }
2730
2731 $diff = implode( "\n", $diff_lines );
2732
2733 return $diff;
2734}
2735
2751function wfUsePHP( $req_ver ) {
2752 $php_ver = PHP_VERSION;
2753
2754 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2755 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2756 }
2757}
2758
2781function wfUseMW( $req_ver ) {
2783
2784 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2785 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2786 }
2787}
2788
2801function wfBaseName( $path, $suffix = '' ) {
2802 if ( $suffix == '' ) {
2803 $encSuffix = '';
2804 } else {
2805 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2806 }
2807
2808 $matches = [];
2809 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2810 return $matches[1];
2811 } else {
2812 return '';
2813 }
2814}
2815
2825function wfRelativePath( $path, $from ) {
2826 // Normalize mixed input on Windows...
2827 $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2828 $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2829
2830 // Trim trailing slashes -- fix for drive root
2831 $path = rtrim( $path, DIRECTORY_SEPARATOR );
2832 $from = rtrim( $from, DIRECTORY_SEPARATOR );
2833
2834 $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2835 $against = explode( DIRECTORY_SEPARATOR, $from );
2836
2837 if ( $pieces[0] !== $against[0] ) {
2838 // Non-matching Windows drive letters?
2839 // Return a full path.
2840 return $path;
2841 }
2842
2843 // Trim off common prefix
2844 while ( count( $pieces ) && count( $against )
2845 && $pieces[0] == $against[0] ) {
2846 array_shift( $pieces );
2847 array_shift( $against );
2848 }
2849
2850 // relative dots to bump us to the parent
2851 while ( count( $against ) ) {
2852 array_unshift( $pieces, '..' );
2853 array_shift( $against );
2854 }
2855
2856 array_push( $pieces, wfBaseName( $path ) );
2857
2858 return implode( DIRECTORY_SEPARATOR, $pieces );
2859}
2860
2878function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
2879 $lowercase = true, $engine = 'auto'
2880) {
2881 return Wikimedia\base_convert( $input, $sourceBase, $destBase, $pad, $lowercase, $engine );
2882}
2883
2888function wfFixSessionID() {
2889 wfDeprecated( __FUNCTION__, '1.27' );
2890}
2891
2899 wfDeprecated( __FUNCTION__, '1.27' );
2900 $session = SessionManager::getGlobalSession();
2901 $delay = $session->delaySave();
2902
2903 $session->resetId();
2904
2905 // Make sure a session is started, since that's what the old
2906 // wfResetSessionID() did.
2907 if ( session_id() !== $session->getId() ) {
2908 wfSetupSession( $session->getId() );
2909 }
2910
2911 ScopedCallback::consume( $delay );
2912}
2913
2923function wfSetupSession( $sessionId = false ) {
2924 wfDeprecated( __FUNCTION__, '1.27' );
2925
2926 if ( $sessionId ) {
2927 session_id( $sessionId );
2928 }
2929
2930 $session = SessionManager::getGlobalSession();
2931 $session->persist();
2932
2933 if ( session_id() !== $session->getId() ) {
2934 session_id( $session->getId() );
2935 }
2936 MediaWiki\quietCall( 'session_start' );
2937}
2938
2945function wfGetPrecompiledData( $name ) {
2946 global $IP;
2947
2948 $file = "$IP/serialized/$name";
2949 if ( file_exists( $file ) ) {
2950 $blob = file_get_contents( $file );
2951 if ( $blob ) {
2952 return unserialize( $blob );
2953 }
2954 }
2955 return false;
2956}
2957
2964function wfMemcKey( /*...*/ ) {
2965 return call_user_func_array(
2966 [ ObjectCache::getLocalClusterInstance(), 'makeKey' ],
2967 func_get_args()
2968 );
2969}
2970
2981function wfForeignMemcKey( $db, $prefix /*...*/ ) {
2982 $args = array_slice( func_get_args(), 2 );
2983 $keyspace = $prefix ? "$db-$prefix" : $db;
2984 return call_user_func_array(
2985 [ ObjectCache::getLocalClusterInstance(), 'makeKeyInternal' ],
2986 [ $keyspace, $args ]
2987 );
2988}
2989
3001function wfGlobalCacheKey( /*...*/ ) {
3002 return call_user_func_array(
3003 [ ObjectCache::getLocalClusterInstance(), 'makeGlobalKey' ],
3004 func_get_args()
3005 );
3006}
3007
3014function wfWikiID() {
3016 if ( $wgDBprefix ) {
3017 return "$wgDBname-$wgDBprefix";
3018 } else {
3019 return $wgDBname;
3020 }
3021}
3022
3030function wfSplitWikiID( $wiki ) {
3031 $bits = explode( '-', $wiki, 2 );
3032 if ( count( $bits ) < 2 ) {
3033 $bits[] = '';
3034 }
3035 return $bits;
3036}
3037
3063function wfGetDB( $db, $groups = [], $wiki = false ) {
3064 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3065}
3066
3076function wfGetLB( $wiki = false ) {
3077 if ( $wiki === false ) {
3078 return \MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancer();
3079 } else {
3080 $factory = \MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
3081 return $factory->getMainLB( $wiki );
3082 }
3083}
3084
3092function wfGetLBFactory() {
3093 return \MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
3094}
3095
3104function wfFindFile( $title, $options = [] ) {
3105 return RepoGroup::singleton()->findFile( $title, $options );
3106}
3107
3115function wfLocalFile( $title ) {
3116 return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
3117}
3118
3127 return $wgMiserMode
3128 || ( SiteStats::pages() > 100000
3129 && SiteStats::edits() > 1000000
3130 && SiteStats::users() > 10000 );
3131}
3132
3141function wfScript( $script = 'index' ) {
3143 if ( $script === 'index' ) {
3144 return $wgScript;
3145 } elseif ( $script === 'load' ) {
3146 return $wgLoadScript;
3147 } else {
3148 return "{$wgScriptPath}/{$script}.php";
3149 }
3150}
3151
3157function wfGetScriptUrl() {
3158 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3159 /* as it was called, minus the query string.
3160 *
3161 * Some sites use Apache rewrite rules to handle subdomains,
3162 * and have PHP set up in a weird way that causes PHP_SELF
3163 * to contain the rewritten URL instead of the one that the
3164 * outside world sees.
3165 *
3166 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
3167 * provides containing the "before" URL.
3168 */
3169 return $_SERVER['SCRIPT_NAME'];
3170 } else {
3171 return $_SERVER['URL'];
3172 }
3173}
3174
3182function wfBoolToStr( $value ) {
3183 return $value ? 'true' : 'false';
3184}
3185
3191function wfGetNull() {
3192 return wfIsWindows() ? 'NUL' : '/dev/null';
3193}
3194
3218 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3219) {
3220 if ( $timeout === null ) {
3221 $timeout = ( PHP_SAPI === 'cli' ) ? 86400 : 10;
3222 }
3223
3224 if ( $cluster === '*' ) {
3225 $cluster = false;
3226 $wiki = false;
3227 } elseif ( $wiki === false ) {
3228 $wiki = wfWikiID();
3229 }
3230
3231 try {
3232 wfGetLBFactory()->waitForReplication( [
3233 'wiki' => $wiki,
3234 'cluster' => $cluster,
3235 'timeout' => $timeout,
3236 // B/C: first argument used to be "max seconds of lag"; ignore such values
3237 'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
3238 ] );
3239 } catch ( DBReplicationWaitError $e ) {
3240 return false;
3241 }
3242
3243 return true;
3244}
3245
3253function wfCountDown( $seconds ) {
3254 for ( $i = $seconds; $i >= 0; $i-- ) {
3255 if ( $i != $seconds ) {
3256 echo str_repeat( "\x08", strlen( $i + 1 ) );
3257 }
3258 echo $i;
3259 flush();
3260 if ( $i ) {
3261 sleep( 1 );
3262 }
3263 }
3264 echo "\n";
3265}
3266
3277 $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
3278 $name = preg_replace(
3279 "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
3280 '-',
3281 $name
3282 );
3283 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
3284 $name = wfBaseName( $name );
3285 return $name;
3286}
3287
3293function wfMemoryLimit() {
3295 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3296 if ( $memlimit != -1 ) {
3297 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3298 if ( $conflimit == -1 ) {
3299 wfDebug( "Removing PHP's memory limit\n" );
3300 MediaWiki\suppressWarnings();
3301 ini_set( 'memory_limit', $conflimit );
3302 MediaWiki\restoreWarnings();
3303 return $conflimit;
3304 } elseif ( $conflimit > $memlimit ) {
3305 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3306 MediaWiki\suppressWarnings();
3307 ini_set( 'memory_limit', $conflimit );
3308 MediaWiki\restoreWarnings();
3309 return $conflimit;
3310 }
3311 }
3312 return $memlimit;
3313}
3314
3323
3324 $timeLimit = ini_get( 'max_execution_time' );
3325 // Note that CLI scripts use 0
3326 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3327 set_time_limit( $wgTransactionalTimeLimit );
3328 }
3329
3330 ignore_user_abort( true ); // ignore client disconnects
3331
3332 return $timeLimit;
3333}
3334
3342function wfShorthandToInteger( $string = '', $default = -1 ) {
3343 $string = trim( $string );
3344 if ( $string === '' ) {
3345 return $default;
3346 }
3347 $last = $string[strlen( $string ) - 1];
3348 $val = intval( $string );
3349 switch ( $last ) {
3350 case 'g':
3351 case 'G':
3352 $val *= 1024;
3353 // break intentionally missing
3354 case 'm':
3355 case 'M':
3356 $val *= 1024;
3357 // break intentionally missing
3358 case 'k':
3359 case 'K':
3360 $val *= 1024;
3361 }
3362
3363 return $val;
3364}
3365
3373function wfBCP47( $code ) {
3374 $codeSegment = explode( '-', $code );
3375 $codeBCP = [];
3376 foreach ( $codeSegment as $segNo => $seg ) {
3377 // when previous segment is x, it is a private segment and should be lc
3378 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3379 $codeBCP[$segNo] = strtolower( $seg );
3380 // ISO 3166 country code
3381 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3382 $codeBCP[$segNo] = strtoupper( $seg );
3383 // ISO 15924 script code
3384 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3385 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3386 // Use lowercase for other cases
3387 } else {
3388 $codeBCP[$segNo] = strtolower( $seg );
3389 }
3390 }
3391 $langCode = implode( '-', $codeBCP );
3392 return $langCode;
3393}
3394
3401function wfGetCache( $cacheType ) {
3402 return ObjectCache::getInstance( $cacheType );
3403}
3404
3410function wfGetMainCache() {
3412 return ObjectCache::getInstance( $wgMainCacheType );
3413}
3414
3422 return ObjectCache::getInstance( $wgMessageCacheType );
3423}
3424
3432 return ObjectCache::getInstance( $wgParserCacheType );
3433}
3434
3445function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3446 return Hooks::run( $event, $args, $deprecatedVersion );
3447}
3448
3463function wfUnpack( $format, $data, $length = false ) {
3464 if ( $length !== false ) {
3465 $realLen = strlen( $data );
3466 if ( $realLen < $length ) {
3467 throw new MWException( "Tried to use wfUnpack on a "
3468 . "string of length $realLen, but needed one "
3469 . "of at least length $length."
3470 );
3471 }
3472 }
3473
3474 MediaWiki\suppressWarnings();
3475 $result = unpack( $format, $data );
3476 MediaWiki\restoreWarnings();
3477
3478 if ( $result === false ) {
3479 // If it cannot extract the packed data.
3480 throw new MWException( "unpack could not unpack binary data" );
3481 }
3482 return $result;
3483}
3484
3499function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3500 # Handle redirects; callers almost always hit wfFindFile() anyway,
3501 # so just use that method because it has a fast process cache.
3502 $file = wfFindFile( $name ); // get the final name
3503 $name = $file ? $file->getTitle()->getDBkey() : $name;
3504
3505 # Run the extension hook
3506 $bad = false;
3507 if ( !Hooks::run( 'BadImage', [ $name, &$bad ] ) ) {
3508 return (bool)$bad;
3509 }
3510
3511 $cache = ObjectCache::getLocalServerInstance( 'hash' );
3512 $key = wfMemcKey( 'bad-image-list', ( $blacklist === null ) ? 'default' : md5( $blacklist ) );
3513 $badImages = $cache->get( $key );
3514
3515 if ( $badImages === false ) { // cache miss
3516 if ( $blacklist === null ) {
3517 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3518 }
3519 # Build the list now
3520 $badImages = [];
3521 $lines = explode( "\n", $blacklist );
3522 foreach ( $lines as $line ) {
3523 # List items only
3524 if ( substr( $line, 0, 1 ) !== '*' ) {
3525 continue;
3526 }
3527
3528 # Find all links
3529 $m = [];
3530 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3531 continue;
3532 }
3533
3534 $exceptions = [];
3535 $imageDBkey = false;
3536 foreach ( $m[1] as $i => $titleText ) {
3537 $title = Title::newFromText( $titleText );
3538 if ( !is_null( $title ) ) {
3539 if ( $i == 0 ) {
3540 $imageDBkey = $title->getDBkey();
3541 } else {
3542 $exceptions[$title->getPrefixedDBkey()] = true;
3543 }
3544 }
3545 }
3546
3547 if ( $imageDBkey !== false ) {
3548 $badImages[$imageDBkey] = $exceptions;
3549 }
3550 }
3551 $cache->set( $key, $badImages, 60 );
3552 }
3553
3554 $contextKey = $contextTitle ? $contextTitle->getPrefixedDBkey() : false;
3555 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3556
3557 return $bad;
3558}
3559
3567function wfCanIPUseHTTPS( $ip ) {
3568 $canDo = true;
3569 Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3570 return !!$canDo;
3571}
3572
3580function wfIsInfinity( $str ) {
3581 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3582 return in_array( $str, $infinityValues );
3583}
3584
3601
3602 $multipliers = [ 1 ];
3603 if ( $wgResponsiveImages ) {
3604 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3605 // @see Linker::processResponsiveImages
3606 $multipliers[] = 1.5;
3607 $multipliers[] = 2;
3608 }
3609
3610 $handler = $file->getHandler();
3611 if ( !$handler || !isset( $params['width'] ) ) {
3612 return false;
3613 }
3614
3615 $basicParams = [];
3616 if ( isset( $params['page'] ) ) {
3617 $basicParams['page'] = $params['page'];
3618 }
3619
3620 $thumbLimits = [];
3621 $imageLimits = [];
3622 // Expand limits to account for multipliers
3623 foreach ( $multipliers as $multiplier ) {
3624 $thumbLimits = array_merge( $thumbLimits, array_map(
3625 function ( $width ) use ( $multiplier ) {
3626 return round( $width * $multiplier );
3627 }, $wgThumbLimits )
3628 );
3629 $imageLimits = array_merge( $imageLimits, array_map(
3630 function ( $pair ) use ( $multiplier ) {
3631 return [
3632 round( $pair[0] * $multiplier ),
3633 round( $pair[1] * $multiplier ),
3634 ];
3635 }, $wgImageLimits )
3636 );
3637 }
3638
3639 // Check if the width matches one of $wgThumbLimits
3640 if ( in_array( $params['width'], $thumbLimits ) ) {
3641 $normalParams = $basicParams + [ 'width' => $params['width'] ];
3642 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3643 $handler->normaliseParams( $file, $normalParams );
3644 } else {
3645 // If not, then check if the width matchs one of $wgImageLimits
3646 $match = false;
3647 foreach ( $imageLimits as $pair ) {
3648 $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3649 // Decide whether the thumbnail should be scaled on width or height.
3650 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3651 $handler->normaliseParams( $file, $normalParams );
3652 // Check if this standard thumbnail size maps to the given width
3653 if ( $normalParams['width'] == $params['width'] ) {
3654 $match = true;
3655 break;
3656 }
3657 }
3658 if ( !$match ) {
3659 return false; // not standard for description pages
3660 }
3661 }
3662
3663 // Check that the given values for non-page, non-width, params are just defaults
3664 foreach ( $params as $key => $value ) {
3665 if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3666 return false;
3667 }
3668 }
3669
3670 return true;
3671}
3672
3685function wfArrayPlus2d( array $baseArray, array $newValues ) {
3686 // First merge items that are in both arrays
3687 foreach ( $baseArray as $name => &$groupVal ) {
3688 if ( isset( $newValues[$name] ) ) {
3689 $groupVal += $newValues[$name];
3690 }
3691 }
3692 // Now add items that didn't exist yet
3693 $baseArray += $newValues;
3694
3695 return $baseArray;
3696}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
unserialize( $serialized)
$wgMaxShellWallClockTime
Maximum wall clock time (i.e.
$wgLanguageCode
Site language code.
$wgParserCacheType
The cache type for storing article HTML.
$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.
$wgMaxShellMemory
Maximum amount of virtual memory available to shell processes under linux, in KB.
$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 (php/php5).
$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.
$wgMaxShellFileSize
Maximum file size created by shell processes under linux, in KB ImageMagick convert for example can b...
$wgTmpDirectory
The local filesystem path to a temporary directory.
$wgStyleDirectory
Filesystem stylesheets directory.
$wgShellCgroup
Under Linux: a cgroup directory used to constrain memory usage of shell commands.
$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.
$wgShellLocale
Locale for LC_CTYPE, to work around https://bugs.php.net/bug.php?id=45132 For Unix-like operating sys...
$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.
$wgVersion
MediaWiki version number.
$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.
$wgMaxShellTime
Maximum CPU time in seconds for shell processes under Linux.
$wgHttpsPort
Port where you have HTTPS running Supports HTTPS on non-standard ports.
$wgDiff
Path to the GNU diff utility.
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 between 0 and 1, in a way not likely to give duplicate values for any real...
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.
wfShellExecDisabled()
Check if wfShellExec() is effectively disabled via php.ini config.
wfIncrStats( $key, $count=1)
Increment a statistics counter.
wfLogDBError( $text, array $context=[])
Log for database errors.
wfLoadSkins(array $skins)
Load multiple skins at once.
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.
wfGlobalCacheKey()
Make a cache key with database-agnostic prefix.
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.
wfUseMW( $req_ver)
This function works like "use VERSION" in Perl except it checks the version of MediaWiki,...
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
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...
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.
wfUsePHP( $req_ver)
This function works like "use VERSION" in Perl, the program will die with a backtrace if the current ...
wfRestoreWarnings()
wfIsDebugRawPage()
Returns true if debug logging should be suppressed if $wgDebugRawPage = false.
wfHostname()
Fetch server name for use in error reporting etc.
wfReportTime()
Returns a script tag that stores the amount of time it took MediaWiki to handle the request in millis...
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfSplitWikiID( $wiki)
Split a wiki ID into DB name and table prefix.
wfGetMainCache()
Get the main cache object.
wfRunHooks( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in $wgHooks.
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.
wfGetParserCacheStorage()
Get the cache object used by the parser cache.
wfMemcKey()
Make a cache key for the local wiki.
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
wfFindFile( $title, $options=[])
Find a file.
wfExpandIRI_callback( $matches)
Private callback for wfExpandIRI.
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.
wfFixSessionID()
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.
wfInitShellLocale()
Workaround for https://bugs.php.net/bug.php?id=45132 escapeshellarg() destroys non-ASCII characters i...
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.
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.
wfMerge( $old, $mine, $yours, &$result)
wfMerge attempts to merge differences between three texts.
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.
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.
wfForeignMemcKey( $db, $prefix)
Make a cache key for a foreign DB.
wfGetCache( $cacheType)
Get a specific cache object.
wfMessageFallback()
This function accepts multiple message keys and returns a message instance for the first message whic...
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the 'bad image list'.
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...
wfErrorLog( $text, $file, array $context=[])
Log to a file without getting "file size exceeded" signals.
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.
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.
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
wfBaseConvert( $input, $sourceBase, $destBase, $pad=1, $lowercase=true, $engine='auto')
Convert an arbitrarily-long digit string from one numeric base to another, optionally zero-padding to...
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
$wgOut
Definition Setup.php:791
global $wgCommandLineMode
Definition Setup.php:503
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:639
$IP
Definition WebStart.php:58
float $wgRequestTime
Request start time as fractional seconds since epoch.
Definition WebStart.php:43
$line
Definition cdb.php:58
if( $line===false) $args
Definition cdb.php:63
getUser()
Get the User object.
getRequest()
Get the WebRequest object.
getConfig()
Get the Config object.
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:51
getHandler()
Get a MediaHandler instance for this file.
Definition File.php:1365
static header( $code)
Output an HTTP status code header.
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.
The Message class provides methods which fulfil two basic services:
Definition Message.php:159
Stub profiler that does nothing.
static instance()
Singleton.
Definition Profiler.php:62
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
static getMain()
Static methods.
A statsd client that applies the sampling rate to the data items before sending them.
static edits()
static users()
static pages()
static makeVariablesScript( $data)
Definition Skin.php:348
static getUsableTempDirectory()
A formatter that outputs unified diffs.
Exception class for replica DB wait timeouts.
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 class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition design.txt:56
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:63
const PROTO_CANONICAL
Definition Defines.php:221
const PROTO_HTTPS
Definition Defines.php:218
const PROTO_CURRENT
Definition Defines.php:220
const PROTO_INTERNAL
Definition Defines.php:222
const PROTO_HTTP
Definition Defines.php:217
const SHELL_MAX_ARG_STRLEN
Definition Defines.php:268
the array() calling protocol came about after MediaWiki 1.4rc1.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
Definition hooks.txt:1108
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:249
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2728
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition hooks.txt:1769
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1954
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account incomplete not yet checked for validity & $retval
Definition hooks.txt:268
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers please use GetContentModels hook to make them known to core if desired 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 inclusive $limit
Definition hooks.txt:1143
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition hooks.txt:1102
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition hooks.txt:865
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:964
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 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
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition hooks.txt:2753
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition hooks.txt:2604
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2723
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:1966
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:864
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:304
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition hooks.txt:1972
the value to return A Title object or null for latest all implement SearchIndexField $engine
Definition hooks.txt:2798
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition hooks.txt:1049
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition hooks.txt:903
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:1601
returning false will NOT prevent logging $e
Definition hooks.txt:2127
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 $wgMainCacheType controlled by $wgParserCacheType controlled by $wgMessageCacheType If you set CACHE_NONE to one of the three control default value for MediaWiki still create a but requests to it are no ops and we always fall through to the database If the cache daemon can t be it should also disable itself fairly smoothly By $wgMemc is used but when it is $parserMemc or $messageMemc this is mentioned $wgDBname
CACHE_MEMCACHED $wgMainCacheType
Definition memcached.txt:63
$tokens
$source
if(is_array($mode)) switch( $mode) $input
$last
$lines
Definition router.php:61
$params