3 * Global functions used everywhere.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
27 // Hide compatibility functions from Doxygen
31 * Compatibility functions
33 * We support PHP 5.3.2 and up.
34 * Re-implementations of newer functions or functions in non-standard
35 * PHP extensions may be included here.
38 if( !function_exists( 'iconv' ) ) {
43 function iconv( $from, $to, $string ) {
44 return Fallback
::iconv( $from, $to, $string );
48 if ( !function_exists( 'mb_substr' ) ) {
53 function mb_substr( $str, $start, $count='end' ) {
54 return Fallback
::mb_substr( $str, $start, $count );
61 function mb_substr_split_unicode( $str, $splitPos ) {
62 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
66 if ( !function_exists( 'mb_strlen' ) ) {
71 function mb_strlen( $str, $enc = '' ) {
72 return Fallback
::mb_strlen( $str, $enc );
76 if( !function_exists( 'mb_strpos' ) ) {
81 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
82 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
87 if( !function_exists( 'mb_strrpos' ) ) {
92 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
93 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
98 // Support for Wietse Venema's taint feature
99 if ( !function_exists( 'istainted' ) ) {
101 * @codeCoverageIgnore
104 function istainted( $var ) {
107 /** @codeCoverageIgnore */
108 function taint( $var, $level = 0 ) {}
109 /** @codeCoverageIgnore */
110 function untaint( $var, $level = 0 ) {}
111 define( 'TC_HTML', 1 );
112 define( 'TC_SHELL', 1 );
113 define( 'TC_MYSQL', 1 );
114 define( 'TC_PCRE', 1 );
115 define( 'TC_SELF', 1 );
120 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
125 function wfArrayDiff2( $a, $b ) {
126 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
134 function wfArrayDiff2_cmp( $a, $b ) {
135 if ( !is_array( $a ) ) {
136 return strcmp( $a, $b );
137 } elseif ( count( $a ) !== count( $b ) ) {
138 return count( $a ) < count( $b ) ?
-1 : 1;
142 while( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
143 $cmp = strcmp( $valueA, $valueB );
154 * Returns an array where the values in the first array are replaced by the
155 * values in the second array with the corresponding keys
161 function wfArrayLookup( $a, $b ) {
162 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
166 * Appends to second array if $value differs from that in $default
168 * @param $key String|Int
169 * @param $value Mixed
170 * @param $default Mixed
171 * @param $changed Array to alter
173 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
174 if ( is_null( $changed ) ) {
175 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
177 if ( $default[$key] !== $value ) {
178 $changed[$key] = $value;
183 * Backwards array plus for people who haven't bothered to read the PHP manual
184 * XXX: will not darn your socks for you.
186 * @param $array1 Array
187 * @param [$array2, [...]] Arrays
190 function wfArrayMerge( $array1/* ... */ ) {
191 $args = func_get_args();
192 $args = array_reverse( $args, true );
194 foreach ( $args as $arg ) {
201 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
203 * wfMergeErrorArrays(
204 * array( array( 'x' ) ),
205 * array( array( 'x', '2' ) ),
206 * array( array( 'x' ) ),
207 * array( array( 'y' ) )
218 function wfMergeErrorArrays( /*...*/ ) {
219 $args = func_get_args();
221 foreach ( $args as $errors ) {
222 foreach ( $errors as $params ) {
223 # @todo FIXME: Sometimes get nested arrays for $params,
224 # which leads to E_NOTICEs
225 $spec = implode( "\t", $params );
226 $out[$spec] = $params;
229 return array_values( $out );
233 * Insert array into another array after the specified *KEY*
235 * @param $array Array: The array.
236 * @param $insert Array: The array to insert.
237 * @param $after Mixed: The key to insert after
240 function wfArrayInsertAfter( array $array, array $insert, $after ) {
241 // Find the offset of the element to insert after.
242 $keys = array_keys( $array );
243 $offsetByKey = array_flip( $keys );
245 $offset = $offsetByKey[$after];
247 // Insert at the specified offset
248 $before = array_slice( $array, 0, $offset +
1, true );
249 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
251 $output = $before +
$insert +
$after;
257 * Recursively converts the parameter (an object) to an array with the same data
259 * @param $objOrArray Object|Array
260 * @param $recursive Bool
263 function wfObjectToArray( $objOrArray, $recursive = true ) {
265 if( is_object( $objOrArray ) ) {
266 $objOrArray = get_object_vars( $objOrArray );
268 foreach ( $objOrArray as $key => $value ) {
269 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
270 $value = wfObjectToArray( $value );
273 $array[$key] = $value;
280 * Wrapper around array_map() which also taints variables
282 * @param $function Callback
283 * @param $input Array
286 function wfArrayMap( $function, $input ) {
287 $ret = array_map( $function, $input );
288 foreach ( $ret as $key => $value ) {
289 $taint = istainted( $input[$key] );
291 taint( $ret[$key], $taint );
298 * Get a random decimal value between 0 and 1, in a way
299 * not likely to give duplicate values for any realistic
300 * number of articles.
304 function wfRandom() {
305 # The maximum random value is "only" 2^31-1, so get two random
306 # values to reduce the chance of dupes
307 $max = mt_getrandmax() +
1;
308 $rand = number_format( ( mt_rand() * $max +
mt_rand() )
309 / $max / $max, 12, '.', '' );
314 * Get a random string containing a number of pesudo-random hex
316 * @note This is not secure, if you are trying to generate some sort
317 * of token please use MWCryptRand instead.
319 * @param $length int The length of the string to generate
323 function wfRandomString( $length = 32 ) {
325 while ( strlen( $str ) < $length ) {
326 $str .= dechex( mt_rand() );
328 return substr( $str, 0, $length );
332 * We want some things to be included as literal characters in our title URLs
333 * for prettiness, which urlencode encodes by default. According to RFC 1738,
334 * all of the following should be safe:
338 * But + is not safe because it's used to indicate a space; &= are only safe in
339 * paths and not in queries (and we don't distinguish here); ' seems kind of
340 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
341 * is reserved, we don't care. So the list we unescape is:
345 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
346 * so no fancy : for IIS7.
348 * %2F in the page titles seems to fatally break for some reason.
353 function wfUrlencode( $s ) {
355 if ( is_null( $s ) ) {
360 if ( is_null( $needle ) ) {
361 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
362 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
367 $s = urlencode( $s );
370 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
378 * This function takes two arrays as input, and returns a CGI-style string, e.g.
379 * "days=7&limit=100". Options in the first array override options in the second.
380 * Options set to null or false will not be output.
382 * @param $array1 Array ( String|Array )
383 * @param $array2 Array ( String|Array )
384 * @param $prefix String
387 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
388 if ( !is_null( $array2 ) ) {
389 $array1 = $array1 +
$array2;
393 foreach ( $array1 as $key => $value ) {
394 if ( !is_null($value) && $value !== false ) {
398 if ( $prefix !== '' ) {
399 $key = $prefix . "[$key]";
401 if ( is_array( $value ) ) {
403 foreach ( $value as $k => $v ) {
404 $cgi .= $firstTime ?
'' : '&';
405 if ( is_array( $v ) ) {
406 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
408 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
413 if ( is_object( $value ) ) {
414 $value = $value->__toString();
416 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
424 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
425 * its argument and returns the same string in array form. This allows compa-
426 * tibility with legacy functions that accept raw query strings instead of nice
427 * arrays. Of course, keys and values are urldecode()d.
429 * @param $query String: query string
430 * @return array Array version of input
432 function wfCgiToArray( $query ) {
433 if ( isset( $query[0] ) && $query[0] == '?' ) {
434 $query = substr( $query, 1 );
436 $bits = explode( '&', $query );
438 foreach ( $bits as $bit ) {
442 if ( strpos( $bit, '=' ) === false ) {
443 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
447 list( $key, $value ) = explode( '=', $bit );
449 $key = urldecode( $key );
450 $value = urldecode( $value );
451 if ( strpos( $key, '[' ) !== false ) {
452 $keys = array_reverse( explode( '[', $key ) );
453 $key = array_pop( $keys );
455 foreach ( $keys as $k ) {
456 $k = substr( $k, 0, -1 );
457 $temp = array( $k => $temp );
459 if ( isset( $ret[$key] ) ) {
460 $ret[$key] = array_merge( $ret[$key], $temp );
472 * Append a query string to an existing URL, which may or may not already
473 * have query string parameters already. If so, they will be combined.
476 * @param $query Mixed: string or associative array
479 function wfAppendQuery( $url, $query ) {
480 if ( is_array( $query ) ) {
481 $query = wfArrayToCgi( $query );
484 if( false === strpos( $url, '?' ) ) {
495 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
498 * The meaning of the PROTO_* constants is as follows:
499 * PROTO_HTTP: Output a URL starting with http://
500 * PROTO_HTTPS: Output a URL starting with https://
501 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
502 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
503 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
504 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
506 * @todo this won't work with current-path-relative URLs
507 * like "subdir/foo.html", etc.
509 * @param $url String: either fully-qualified or a local path + query
510 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
511 * protocol to use if $url or $wgServer is
513 * @return string Fully-qualified URL, current-path-relative URL or false if
514 * no valid URL can be constructed
516 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
517 global $wgServer, $wgCanonicalServer, $wgInternalServer;
518 $serverUrl = $wgServer;
519 if ( $defaultProto === PROTO_CANONICAL
) {
520 $serverUrl = $wgCanonicalServer;
522 // Make $wgInternalServer fall back to $wgServer if not set
523 if ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
524 $serverUrl = $wgInternalServer;
526 if ( $defaultProto === PROTO_CURRENT
) {
527 $defaultProto = WebRequest
::detectProtocol() . '://';
530 // Analyze $serverUrl to obtain its protocol
531 $bits = wfParseUrl( $serverUrl );
532 $serverHasProto = $bits && $bits['scheme'] != '';
534 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
535 if ( $serverHasProto ) {
536 $defaultProto = $bits['scheme'] . '://';
538 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
539 // Fall back to HTTP in this ridiculous case
540 $defaultProto = PROTO_HTTP
;
544 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
546 if ( substr( $url, 0, 2 ) == '//' ) {
547 $url = $defaultProtoWithoutSlashes . $url;
548 } elseif ( substr( $url, 0, 1 ) == '/' ) {
549 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
550 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
553 $bits = wfParseUrl( $url );
554 if ( $bits && isset( $bits['path'] ) ) {
555 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
556 return wfAssembleUrl( $bits );
560 } elseif ( substr( $url, 0, 1 ) != '/' ) {
561 # URL is a relative path
562 return wfRemoveDotSegments( $url );
565 # Expanded URL is not valid.
570 * This function will reassemble a URL parsed with wfParseURL. This is useful
571 * if you need to edit part of a URL and put it back together.
573 * This is the basic structure used (brackets contain keys for $urlParts):
574 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
576 * @todo Need to integrate this into wfExpandUrl (bug 32168)
579 * @param $urlParts Array URL parts, as output from wfParseUrl
580 * @return string URL assembled from its component parts
582 function wfAssembleUrl( $urlParts ) {
585 if ( isset( $urlParts['delimiter'] ) ) {
586 if ( isset( $urlParts['scheme'] ) ) {
587 $result .= $urlParts['scheme'];
590 $result .= $urlParts['delimiter'];
593 if ( isset( $urlParts['host'] ) ) {
594 if ( isset( $urlParts['user'] ) ) {
595 $result .= $urlParts['user'];
596 if ( isset( $urlParts['pass'] ) ) {
597 $result .= ':' . $urlParts['pass'];
602 $result .= $urlParts['host'];
604 if ( isset( $urlParts['port'] ) ) {
605 $result .= ':' . $urlParts['port'];
609 if ( isset( $urlParts['path'] ) ) {
610 $result .= $urlParts['path'];
613 if ( isset( $urlParts['query'] ) ) {
614 $result .= '?' . $urlParts['query'];
617 if ( isset( $urlParts['fragment'] ) ) {
618 $result .= '#' . $urlParts['fragment'];
625 * Remove all dot-segments in the provided URL path. For example,
626 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
627 * RFC3986 section 5.2.4.
629 * @todo Need to integrate this into wfExpandUrl (bug 32168)
631 * @param $urlPath String URL path, potentially containing dot-segments
632 * @return string URL path with all dot-segments removed
634 function wfRemoveDotSegments( $urlPath ) {
637 $inputLength = strlen( $urlPath );
639 while ( $inputOffset < $inputLength ) {
640 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
641 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
642 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
643 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
646 if ( $prefixLengthTwo == './' ) {
647 # Step A, remove leading "./"
649 } elseif ( $prefixLengthThree == '../' ) {
650 # Step A, remove leading "../"
652 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
653 # Step B, replace leading "/.$" with "/"
655 $urlPath[$inputOffset] = '/';
656 } elseif ( $prefixLengthThree == '/./' ) {
657 # Step B, replace leading "/./" with "/"
659 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
660 # Step C, replace leading "/..$" with "/" and
661 # remove last path component in output
663 $urlPath[$inputOffset] = '/';
665 } elseif ( $prefixLengthFour == '/../' ) {
666 # Step C, replace leading "/../" with "/" and
667 # remove last path component in output
670 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
671 # Step D, remove "^.$"
673 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
674 # Step D, remove "^..$"
677 # Step E, move leading path segment to output
678 if ( $prefixLengthOne == '/' ) {
679 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
681 $slashPos = strpos( $urlPath, '/', $inputOffset );
683 if ( $slashPos === false ) {
684 $output .= substr( $urlPath, $inputOffset );
685 $inputOffset = $inputLength;
687 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
688 $inputOffset +
= $slashPos - $inputOffset;
693 $slashPos = strrpos( $output, '/' );
694 if ( $slashPos === false ) {
697 $output = substr( $output, 0, $slashPos );
706 * Returns a regular expression of url protocols
708 * @param $includeProtocolRelative bool If false, remove '//' from the returned protocol list.
709 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
712 function wfUrlProtocols( $includeProtocolRelative = true ) {
713 global $wgUrlProtocols;
715 // Cache return values separately based on $includeProtocolRelative
716 static $withProtRel = null, $withoutProtRel = null;
717 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
718 if ( !is_null( $cachedValue ) ) {
722 // Support old-style $wgUrlProtocols strings, for backwards compatibility
723 // with LocalSettings files from 1.5
724 if ( is_array( $wgUrlProtocols ) ) {
725 $protocols = array();
726 foreach ( $wgUrlProtocols as $protocol ) {
727 // Filter out '//' if !$includeProtocolRelative
728 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
729 $protocols[] = preg_quote( $protocol, '/' );
733 $retval = implode( '|', $protocols );
735 // Ignore $includeProtocolRelative in this case
736 // This case exists for pre-1.6 compatibility, and we can safely assume
737 // that '//' won't appear in a pre-1.6 config because protocol-relative
738 // URLs weren't supported until 1.18
739 $retval = $wgUrlProtocols;
742 // Cache return value
743 if ( $includeProtocolRelative ) {
744 $withProtRel = $retval;
746 $withoutProtRel = $retval;
752 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
753 * you need a regex that matches all URL protocols but does not match protocol-
757 function wfUrlProtocolsWithoutProtRel() {
758 return wfUrlProtocols( false );
762 * parse_url() work-alike, but non-broken. Differences:
764 * 1) Does not raise warnings on bad URLs (just returns false)
765 * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
766 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
768 * @param $url String: a URL to parse
769 * @return Array: bits of the URL in an associative array, per PHP docs
771 function wfParseUrl( $url ) {
772 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
774 // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
775 // way to handle them is to just prepend 'http:' and strip the protocol out later
776 $wasRelative = substr( $url, 0, 2 ) == '//';
777 if ( $wasRelative ) {
780 wfSuppressWarnings();
781 $bits = parse_url( $url );
783 // parse_url() returns an array without scheme for some invalid URLs, e.g.
784 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
785 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
789 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
790 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
791 $bits['delimiter'] = '://';
792 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
793 $bits['delimiter'] = ':';
794 // parse_url detects for news: and mailto: the host part of an url as path
795 // We have to correct this wrong detection
796 if ( isset( $bits['path'] ) ) {
797 $bits['host'] = $bits['path'];
804 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
805 if ( !isset( $bits['host'] ) ) {
808 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
809 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
810 $bits['path'] = '/' . $bits['path'];
814 // If the URL was protocol-relative, fix scheme and delimiter
815 if ( $wasRelative ) {
816 $bits['scheme'] = '';
817 $bits['delimiter'] = '//';
823 * Take a URL, make sure it's expanded to fully qualified, and replace any
824 * encoded non-ASCII Unicode characters with their UTF-8 original forms
825 * for more compact display and legibility for local audiences.
827 * @todo handle punycode domains too
832 function wfExpandIRI( $url ) {
833 return preg_replace_callback( '/((?:%[89A-F][0-9A-F])+)/i', 'wfExpandIRI_callback', wfExpandUrl( $url ) );
837 * Private callback for wfExpandIRI
838 * @param array $matches
841 function wfExpandIRI_callback( $matches ) {
842 return urldecode( $matches[1] );
848 * Make URL indexes, appropriate for the el_index field of externallinks.
853 function wfMakeUrlIndexes( $url ) {
854 $bits = wfParseUrl( $url );
856 // Reverse the labels in the hostname, convert to lower case
857 // For emails reverse domainpart only
858 if ( $bits['scheme'] == 'mailto' ) {
859 $mailparts = explode( '@', $bits['host'], 2 );
860 if ( count( $mailparts ) === 2 ) {
861 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
863 // No domain specified, don't mangle it
866 $reversedHost = $domainpart . '@' . $mailparts[0];
868 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
870 // Add an extra dot to the end
871 // Why? Is it in wrong place in mailto links?
872 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
873 $reversedHost .= '.';
875 // Reconstruct the pseudo-URL
876 $prot = $bits['scheme'];
877 $index = $prot . $bits['delimiter'] . $reversedHost;
878 // Leave out user and password. Add the port, path, query and fragment
879 if ( isset( $bits['port'] ) ) {
880 $index .= ':' . $bits['port'];
882 if ( isset( $bits['path'] ) ) {
883 $index .= $bits['path'];
887 if ( isset( $bits['query'] ) ) {
888 $index .= '?' . $bits['query'];
890 if ( isset( $bits['fragment'] ) ) {
891 $index .= '#' . $bits['fragment'];
895 return array( "http:$index", "https:$index" );
897 return array( $index );
902 * Check whether a given URL has a domain that occurs in a given set of domains
903 * @param $url string URL
904 * @param $domains array Array of domains (strings)
905 * @return bool True if the host part of $url ends in one of the strings in $domains
907 function wfMatchesDomainList( $url, $domains ) {
908 $bits = wfParseUrl( $url );
909 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
910 foreach ( (array)$domains as $domain ) {
911 // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org
912 // We should use something that interprets dots instead
913 if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) {
922 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
923 * In normal operation this is a NOP.
925 * Controlling globals:
926 * $wgDebugLogFile - points to the log file
927 * $wgProfileOnly - if set, normal debug messages will not be recorded.
928 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
929 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
931 * @param $text String
932 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
934 function wfDebug( $text, $logonly = false ) {
935 global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
937 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
941 $timer = wfDebugTimer();
942 if ( $timer !== '' ) {
943 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
947 MWDebug
::debugMsg( $text );
950 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
951 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
952 # Strip unprintables; they can switch terminal modes when binary data
953 # gets dumped, which is pretty annoying.
954 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
955 $text = $wgDebugLogPrefix . $text;
956 wfErrorLog( $text, $wgDebugLogFile );
962 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
965 function wfIsDebugRawPage() {
967 if ( $cache !== null ) {
970 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
971 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
973 isset( $_SERVER['SCRIPT_NAME'] )
974 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
985 * Get microsecond timestamps for debug logs
989 function wfDebugTimer() {
990 global $wgDebugTimestamps, $wgRequestTime;
992 if ( !$wgDebugTimestamps ) {
996 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
997 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
998 return "$prefix $mem ";
1002 * Send a line giving PHP memory usage.
1004 * @param $exact Bool: print exact values instead of kilobytes (default: false)
1006 function wfDebugMem( $exact = false ) {
1007 $mem = memory_get_usage();
1009 $mem = floor( $mem / 1024 ) . ' kilobytes';
1013 wfDebug( "Memory usage: $mem\n" );
1017 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1018 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
1020 * @param $logGroup String
1021 * @param $text String
1022 * @param $public Bool: whether to log the event in the public log if no private
1023 * log file is specified, (default true)
1025 function wfDebugLog( $logGroup, $text, $public = true ) {
1026 global $wgDebugLogGroups;
1027 $text = trim( $text ) . "\n";
1028 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
1029 $time = wfTimestamp( TS_DB
);
1031 $host = wfHostname();
1032 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
1033 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
1035 } elseif ( $public === true ) {
1036 wfDebug( $text, true );
1041 * Log for database errors
1043 * @param $text String: database error message.
1045 function wfLogDBError( $text ) {
1046 global $wgDBerrorLog, $wgDBerrorLogTZ;
1047 static $logDBErrorTimeZoneObject = null;
1049 if ( $wgDBerrorLog ) {
1050 $host = wfHostname();
1053 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1054 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1057 // Workaround for https://bugs.php.net/bug.php?id=52063
1058 // Can be removed when min PHP > 5.3.2
1059 if ( $logDBErrorTimeZoneObject === null ) {
1060 $d = date_create( "now" );
1062 $d = date_create( "now", $logDBErrorTimeZoneObject );
1065 $date = $d->format( 'D M j G:i:s T Y' );
1067 $text = "$date\t$host\t$wiki\t$text";
1068 wfErrorLog( $text, $wgDBerrorLog );
1073 * Throws a warning that $function is deprecated
1075 * @param $function String
1076 * @param $version String|bool: Version of MediaWiki that the function was deprecated in (Added in 1.19).
1077 * @param $component String|bool: Added in 1.19.
1078 * @param $callerOffset integer: How far up the callstack is the original
1079 * caller. 2 = function that called the function that called
1080 * wfDeprecated (Added in 1.20)
1084 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1085 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1089 * Send a warning either to the debug log or in a PHP error depending on
1090 * $wgDevelopmentWarnings
1092 * @param $msg String: message to send
1093 * @param $callerOffset Integer: number of items to go back in the backtrace to
1094 * find the correct caller (1 = function calling wfWarn, ...)
1095 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
1098 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1099 MWDebug
::warning( $msg, $callerOffset +
1, $level );
1103 * Log to a file without getting "file size exceeded" signals.
1105 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1106 * send lines to the specified port, prefixed by the specified prefix and a space.
1108 * @param $text String
1109 * @param $file String filename
1111 function wfErrorLog( $text, $file ) {
1112 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1113 # Needs the sockets extension
1114 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1115 // IPv6 bracketed host
1117 $port = intval( $m[3] );
1118 $prefix = isset( $m[4] ) ?
$m[4] : false;
1120 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1122 if ( !IP
::isIPv4( $host ) ) {
1123 $host = gethostbyname( $host );
1125 $port = intval( $m[3] );
1126 $prefix = isset( $m[4] ) ?
$m[4] : false;
1129 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1132 // Clean it up for the multiplexer
1133 if ( strval( $prefix ) !== '' ) {
1134 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1137 if ( strlen( $text ) > 65506 ) {
1138 $text = substr( $text, 0, 65506 );
1141 if ( substr( $text, -1 ) != "\n" ) {
1144 } elseif ( strlen( $text ) > 65507 ) {
1145 $text = substr( $text, 0, 65507 );
1148 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1153 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1154 socket_close( $sock );
1156 wfSuppressWarnings();
1157 $exists = file_exists( $file );
1158 $size = $exists ?
filesize( $file ) : false;
1159 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1160 file_put_contents( $file, $text, FILE_APPEND
);
1162 wfRestoreWarnings();
1169 function wfLogProfilingData() {
1170 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1171 global $wgProfileLimit, $wgUser;
1173 $profiler = Profiler
::instance();
1175 # Profiling must actually be enabled...
1176 if ( $profiler->isStub() ) {
1180 // Get total page request time and only show pages that longer than
1181 // $wgProfileLimit time (default is 0)
1182 $elapsed = microtime( true ) - $wgRequestTime;
1183 if ( $elapsed <= $wgProfileLimit ) {
1187 $profiler->logData();
1189 // Check whether this should be logged in the debug file.
1190 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1195 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1196 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1198 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1199 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1201 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1202 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1205 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1207 // Don't load $wgUser at this late stage just for statistics purposes
1208 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1209 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1210 $forward .= ' anon';
1212 $log = sprintf( "%s\t%04.3f\t%s\n",
1213 gmdate( 'YmdHis' ), $elapsed,
1214 urldecode( $wgRequest->getRequestURL() . $forward ) );
1216 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1220 * Increment a statistics counter
1222 * @param $key String
1225 function wfIncrStats( $key, $count = 1 ) {
1226 global $wgStatsMethod;
1228 $count = intval( $count );
1230 if( $wgStatsMethod == 'udp' ) {
1231 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
1234 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : $wgDBname;
1237 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
1238 $statline = "stats/{$id} - 1 1 1 1 1 -total\n";
1242 strlen( $statline ),
1248 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
1249 wfSuppressWarnings();
1253 strlen( $statline ),
1258 wfRestoreWarnings();
1259 } elseif( $wgStatsMethod == 'cache' ) {
1261 $key = wfMemcKey( 'stats', $key );
1262 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
1263 $wgMemc->add( $key, $count );
1271 * Check if the wiki read-only lock file is present. This can be used to lock
1272 * off editing functions, but doesn't guarantee that the database will not be
1277 function wfReadOnly() {
1278 global $wgReadOnlyFile, $wgReadOnly;
1280 if ( !is_null( $wgReadOnly ) ) {
1281 return (bool)$wgReadOnly;
1283 if ( $wgReadOnlyFile == '' ) {
1286 // Set $wgReadOnly for faster access next time
1287 if ( is_file( $wgReadOnlyFile ) ) {
1288 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1290 $wgReadOnly = false;
1292 return (bool)$wgReadOnly;
1298 function wfReadOnlyReason() {
1305 * Return a Language object from $langcode
1307 * @param $langcode Mixed: either:
1308 * - a Language object
1309 * - code of the language to get the message for, if it is
1310 * a valid code create a language for that language, if
1311 * it is a string but not a valid code then make a basic
1313 * - a boolean: if it's false then use the global object for
1314 * the current user's language (as a fallback for the old parameter
1315 * functionality), or if it is true then use global object
1316 * for the wiki's content language.
1317 * @return Language object
1319 function wfGetLangObj( $langcode = false ) {
1320 # Identify which language to get or create a language object for.
1321 # Using is_object here due to Stub objects.
1322 if( is_object( $langcode ) ) {
1323 # Great, we already have the object (hopefully)!
1327 global $wgContLang, $wgLanguageCode;
1328 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
1329 # $langcode is the language code of the wikis content language object.
1330 # or it is a boolean and value is true
1335 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1336 # $langcode is the language code of user language object.
1337 # or it was a boolean and value is false
1341 $validCodes = array_keys( Language
::fetchLanguageNames() );
1342 if( in_array( $langcode, $validCodes ) ) {
1343 # $langcode corresponds to a valid language.
1344 return Language
::factory( $langcode );
1347 # $langcode is a string, but not a valid language code; use content language.
1348 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1353 * Old function when $wgBetterDirectionality existed
1354 * All usage removed, wfUILang can be removed in near future
1356 * @deprecated since 1.18
1359 function wfUILang() {
1360 wfDeprecated( __METHOD__
, '1.18' );
1366 * This is the new function for getting translated interface messages.
1367 * See the Message class for documentation how to use them.
1368 * The intention is that this function replaces all old wfMsg* functions.
1369 * @param $key \string Message key.
1370 * Varargs: normal message parameters.
1374 function wfMessage( $key /*...*/) {
1375 $params = func_get_args();
1376 array_shift( $params );
1377 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1378 $params = $params[0];
1380 return new Message( $key, $params );
1384 * This function accepts multiple message keys and returns a message instance
1385 * for the first message which is non-empty. If all messages are empty then an
1386 * instance of the first message key is returned.
1387 * @param varargs: message keys
1391 function wfMessageFallback( /*...*/ ) {
1392 $args = func_get_args();
1393 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
1397 * Get a message from anywhere, for the current user language.
1399 * Use wfMsgForContent() instead if the message should NOT
1400 * change depending on the user preferences.
1402 * @deprecated since 1.18
1404 * @param $key String: lookup key for the message, usually
1405 * defined in languages/Language.php
1407 * Parameters to the message, which can be used to insert variable text into
1408 * it, can be passed to this function in the following formats:
1409 * - One per argument, starting at the second parameter
1410 * - As an array in the second parameter
1411 * These are not shown in the function definition.
1415 function wfMsg( $key ) {
1416 $args = func_get_args();
1417 array_shift( $args );
1418 return wfMsgReal( $key, $args );
1422 * Same as above except doesn't transform the message
1424 * @deprecated since 1.18
1426 * @param $key String
1429 function wfMsgNoTrans( $key ) {
1430 $args = func_get_args();
1431 array_shift( $args );
1432 return wfMsgReal( $key, $args, true, false, false );
1436 * Get a message from anywhere, for the current global language
1437 * set with $wgLanguageCode.
1439 * Use this if the message should NOT change dependent on the
1440 * language set in the user's preferences. This is the case for
1441 * most text written into logs, as well as link targets (such as
1442 * the name of the copyright policy page). Link titles, on the
1443 * other hand, should be shown in the UI language.
1445 * Note that MediaWiki allows users to change the user interface
1446 * language in their preferences, but a single installation
1447 * typically only contains content in one language.
1449 * Be wary of this distinction: If you use wfMsg() where you should
1450 * use wfMsgForContent(), a user of the software may have to
1451 * customize potentially hundreds of messages in
1452 * order to, e.g., fix a link in every possible language.
1454 * @deprecated since 1.18
1456 * @param $key String: lookup key for the message, usually
1457 * defined in languages/Language.php
1460 function wfMsgForContent( $key ) {
1461 global $wgForceUIMsgAsContentMsg;
1462 $args = func_get_args();
1463 array_shift( $args );
1465 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1466 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1468 $forcontent = false;
1470 return wfMsgReal( $key, $args, true, $forcontent );
1474 * Same as above except doesn't transform the message
1476 * @deprecated since 1.18
1478 * @param $key String
1481 function wfMsgForContentNoTrans( $key ) {
1482 global $wgForceUIMsgAsContentMsg;
1483 $args = func_get_args();
1484 array_shift( $args );
1486 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1487 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1489 $forcontent = false;
1491 return wfMsgReal( $key, $args, true, $forcontent, false );
1495 * Really get a message
1497 * @deprecated since 1.18
1499 * @param $key String: key to get.
1501 * @param $useDB Boolean
1502 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1503 * @param $transform Boolean: Whether or not to transform the message.
1504 * @return String: the requested message.
1506 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1507 wfProfileIn( __METHOD__
);
1508 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1509 $message = wfMsgReplaceArgs( $message, $args );
1510 wfProfileOut( __METHOD__
);
1515 * Fetch a message string value, but don't replace any keys yet.
1517 * @deprecated since 1.18
1519 * @param $key String
1520 * @param $useDB Bool
1521 * @param $langCode String: Code of the language to get the message for, or
1522 * behaves as a content language switch if it is a boolean.
1523 * @param $transform Boolean: whether to parse magic words, etc.
1526 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1527 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1529 $cache = MessageCache
::singleton();
1530 $message = $cache->get( $key, $useDB, $langCode );
1531 if( $message === false ) {
1532 $message = '<' . htmlspecialchars( $key ) . '>';
1533 } elseif ( $transform ) {
1534 $message = $cache->transform( $message );
1540 * Replace message parameter keys on the given formatted output.
1542 * @deprecated since 1.18
1544 * @param $message String
1545 * @param $args Array
1549 function wfMsgReplaceArgs( $message, $args ) {
1550 # Fix windows line-endings
1551 # Some messages are split with explode("\n", $msg)
1552 $message = str_replace( "\r", '', $message );
1554 // Replace arguments
1555 if ( count( $args ) ) {
1556 if ( is_array( $args[0] ) ) {
1557 $args = array_values( $args[0] );
1559 $replacementKeys = array();
1560 foreach( $args as $n => $param ) {
1561 $replacementKeys['$' . ( $n +
1 )] = $param;
1563 $message = strtr( $message, $replacementKeys );
1570 * Return an HTML-escaped version of a message.
1571 * Parameter replacements, if any, are done *after* the HTML-escaping,
1572 * so parameters may contain HTML (eg links or form controls). Be sure
1573 * to pre-escape them if you really do want plaintext, or just wrap
1574 * the whole thing in htmlspecialchars().
1576 * @deprecated since 1.18
1578 * @param $key String
1579 * @param string ... parameters
1582 function wfMsgHtml( $key ) {
1583 $args = func_get_args();
1584 array_shift( $args );
1585 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1589 * Return an HTML version of message
1590 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1591 * so parameters may contain HTML (eg links or form controls). Be sure
1592 * to pre-escape them if you really do want plaintext, or just wrap
1593 * the whole thing in htmlspecialchars().
1595 * @deprecated since 1.18
1597 * @param $key String
1598 * @param string ... parameters
1601 function wfMsgWikiHtml( $key ) {
1602 $args = func_get_args();
1603 array_shift( $args );
1604 return wfMsgReplaceArgs(
1605 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1606 /* can't be set to false */ true, /* interface */ true )->getText(),
1611 * Returns message in the requested format
1613 * @deprecated since 1.18
1615 * @param $key String: key of the message
1616 * @param $options Array: processing rules. Can take the following options:
1617 * <i>parse</i>: parses wikitext to HTML
1618 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1619 * p's added by parser or tidy
1620 * <i>escape</i>: filters message through htmlspecialchars
1621 * <i>escapenoentities</i>: same, but allows entity references like   through
1622 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1623 * <i>parsemag</i>: transform the message using magic phrases
1624 * <i>content</i>: fetch message for content language instead of interface
1625 * Also can accept a single associative argument, of the form 'language' => 'xx':
1626 * <i>language</i>: Language object or language code to fetch message for
1627 * (overriden by <i>content</i>).
1628 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1632 function wfMsgExt( $key, $options ) {
1633 $args = func_get_args();
1634 array_shift( $args );
1635 array_shift( $args );
1636 $options = (array)$options;
1638 foreach( $options as $arrayKey => $option ) {
1639 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1640 # An unknown index, neither numeric nor "language"
1641 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1642 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1643 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1644 'replaceafter', 'parsemag', 'content' ) ) ) {
1645 # A numeric index with unknown value
1646 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1650 if( in_array( 'content', $options, true ) ) {
1653 $langCodeObj = null;
1654 } elseif( array_key_exists( 'language', $options ) ) {
1655 $forContent = false;
1656 $langCode = wfGetLangObj( $options['language'] );
1657 $langCodeObj = $langCode;
1659 $forContent = false;
1661 $langCodeObj = null;
1664 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1666 if( !in_array( 'replaceafter', $options, true ) ) {
1667 $string = wfMsgReplaceArgs( $string, $args );
1670 $messageCache = MessageCache
::singleton();
1671 $parseInline = in_array( 'parseinline', $options, true );
1672 if( in_array( 'parse', $options, true ) ||
$parseInline ) {
1673 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1674 if ( $string instanceof ParserOutput
) {
1675 $string = $string->getText();
1678 if ( $parseInline ) {
1680 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1684 } elseif ( in_array( 'parsemag', $options, true ) ) {
1685 $string = $messageCache->transform( $string,
1686 !$forContent, $langCodeObj );
1689 if ( in_array( 'escape', $options, true ) ) {
1690 $string = htmlspecialchars ( $string );
1691 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1692 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1695 if( in_array( 'replaceafter', $options, true ) ) {
1696 $string = wfMsgReplaceArgs( $string, $args );
1703 * Since wfMsg() and co suck, they don't return false if the message key they
1704 * looked up didn't exist but a XHTML string, this function checks for the
1705 * nonexistance of messages by checking the MessageCache::get() result directly.
1707 * @deprecated since 1.18. Use Message::isDisabled().
1709 * @param $key String: the message key looked up
1710 * @return Boolean True if the message *doesn't* exist.
1712 function wfEmptyMsg( $key ) {
1713 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1717 * Throw a debugging exception. This function previously once exited the process,
1718 * but now throws an exception instead, with similar results.
1720 * @param $msg String: message shown when dying.
1722 function wfDebugDieBacktrace( $msg = '' ) {
1723 throw new MWException( $msg );
1727 * Fetch server name for use in error reporting etc.
1728 * Use real server name if available, so we know which machine
1729 * in a server farm generated the current page.
1733 function wfHostname() {
1735 if ( is_null( $host ) ) {
1737 # Hostname overriding
1738 global $wgOverrideHostname;
1739 if( $wgOverrideHostname !== false ) {
1740 # Set static and skip any detection
1741 $host = $wgOverrideHostname;
1745 if ( function_exists( 'posix_uname' ) ) {
1746 // This function not present on Windows
1747 $uname = posix_uname();
1751 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1752 $host = $uname['nodename'];
1753 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1754 # Windows computer name
1755 $host = getenv( 'COMPUTERNAME' );
1757 # This may be a virtual server.
1758 $host = $_SERVER['SERVER_NAME'];
1765 * Returns a HTML comment with the elapsed time since request.
1766 * This method has no side effects.
1770 function wfReportTime() {
1771 global $wgRequestTime, $wgShowHostnames;
1773 $elapsed = microtime( true ) - $wgRequestTime;
1775 return $wgShowHostnames
1776 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1777 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1781 * Safety wrapper for debug_backtrace().
1783 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1784 * murky circumstances, which may be triggered in part by stub objects
1785 * or other fancy talkin'.
1787 * Will return an empty array if Zend Optimizer is detected or if
1788 * debug_backtrace is disabled, otherwise the output from
1789 * debug_backtrace() (trimmed).
1791 * @param $limit int This parameter can be used to limit the number of stack frames returned
1793 * @return array of backtrace information
1795 function wfDebugBacktrace( $limit = 0 ) {
1796 static $disabled = null;
1798 if( extension_loaded( 'Zend Optimizer' ) ) {
1799 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1803 if ( is_null( $disabled ) ) {
1805 $functions = explode( ',', ini_get( 'disable_functions' ) );
1806 $functions = array_map( 'trim', $functions );
1807 $functions = array_map( 'strtolower', $functions );
1808 if ( in_array( 'debug_backtrace', $functions ) ) {
1809 wfDebug( "debug_backtrace is in disabled_functions\n" );
1817 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1818 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1820 return array_slice( debug_backtrace(), 1 );
1825 * Get a debug backtrace as a string
1829 function wfBacktrace() {
1830 global $wgCommandLineMode;
1832 if ( $wgCommandLineMode ) {
1837 $backtrace = wfDebugBacktrace();
1838 foreach( $backtrace as $call ) {
1839 if( isset( $call['file'] ) ) {
1840 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1841 $file = $f[count( $f ) - 1];
1845 if( isset( $call['line'] ) ) {
1846 $line = $call['line'];
1850 if ( $wgCommandLineMode ) {
1851 $msg .= "$file line $line calls ";
1853 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1855 if( !empty( $call['class'] ) ) {
1856 $msg .= $call['class'] . $call['type'];
1858 $msg .= $call['function'] . '()';
1860 if ( $wgCommandLineMode ) {
1866 if ( $wgCommandLineMode ) {
1876 * Get the name of the function which called this function
1877 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1878 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1879 * wfGetCaller( 3 ) is the parent of that.
1884 function wfGetCaller( $level = 2 ) {
1885 $backtrace = wfDebugBacktrace( $level +
1 );
1886 if ( isset( $backtrace[$level] ) ) {
1887 return wfFormatStackFrame( $backtrace[$level] );
1894 * Return a string consisting of callers in the stack. Useful sometimes
1895 * for profiling specific points.
1897 * @param $limit int The maximum depth of the stack frame to return, or false for
1901 function wfGetAllCallers( $limit = 3 ) {
1902 $trace = array_reverse( wfDebugBacktrace() );
1903 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1904 $limit = count( $trace ) - 1;
1906 $trace = array_slice( $trace, -$limit - 1, $limit );
1907 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1911 * Return a string representation of frame
1913 * @param $frame Array
1916 function wfFormatStackFrame( $frame ) {
1917 return isset( $frame['class'] ) ?
1918 $frame['class'] . '::' . $frame['function'] :
1923 /* Some generic result counters, pulled out of SearchEngine */
1929 * @param $offset Int
1933 function wfShowingResults( $offset, $limit ) {
1934 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1938 * Generate (prev x| next x) (20|50|100...) type links for paging
1940 * @param $offset String
1941 * @param $limit Integer
1942 * @param $link String
1943 * @param $query String: optional URL query parameter string
1944 * @param $atend Bool: optional param for specified if this is the last page
1946 * @deprecated in 1.19; use Language::viewPrevNext() instead
1948 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1949 wfDeprecated( __METHOD__
, '1.19' );
1953 $query = wfCgiToArray( $query );
1955 if( is_object( $link ) ) {
1958 $title = Title
::newFromText( $link );
1959 if( is_null( $title ) ) {
1964 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
1968 * Make a list item, used by various special pages
1970 * @param $page String Page link
1971 * @param $details String Text between brackets
1972 * @param $oppositedm Boolean Add the direction mark opposite to your
1973 * language, to display text properly
1975 * @deprecated since 1.19; use Language::specialList() instead
1977 function wfSpecialList( $page, $details, $oppositedm = true ) {
1978 wfDeprecated( __METHOD__
, '1.19' );
1981 return $wgLang->specialList( $page, $details, $oppositedm );
1986 * @todo FIXME: We may want to blacklist some broken browsers
1988 * @param $force Bool
1989 * @return bool Whereas client accept gzip compression
1991 function wfClientAcceptsGzip( $force = false ) {
1992 static $result = null;
1993 if ( $result === null ||
$force ) {
1995 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1996 # @todo FIXME: We may want to blacklist some broken browsers
1999 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2000 $_SERVER['HTTP_ACCEPT_ENCODING'],
2004 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2008 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2017 * Obtain the offset and limit values from the request string;
2018 * used in special pages
2020 * @param $deflimit Int default limit if none supplied
2021 * @param $optionname String Name of a user preference to check against
2025 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2027 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2031 * Escapes the given text so that it may be output using addWikiText()
2032 * without any linking, formatting, etc. making its way through. This
2033 * is achieved by substituting certain characters with HTML entities.
2034 * As required by the callers, "<nowiki>" is not used.
2036 * @param $text String: text to be escaped
2039 function wfEscapeWikiText( $text ) {
2040 $text = strtr( "\n$text", array(
2041 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2042 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2043 '{' => '{', '|' => '|', '}' => '}',
2044 "\n#" => "\n#", "\n*" => "\n*",
2045 "\n:" => "\n:", "\n;" => "\n;",
2046 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
2048 return substr( $text, 1 );
2052 * Get the current unix timetstamp with microseconds. Useful for profiling
2056 return microtime( true );
2060 * Sets dest to source and returns the original value of dest
2061 * If source is NULL, it just returns the value, it doesn't set the variable
2062 * If force is true, it will set the value even if source is NULL
2064 * @param $dest Mixed
2065 * @param $source Mixed
2066 * @param $force Bool
2069 function wfSetVar( &$dest, $source, $force = false ) {
2071 if ( !is_null( $source ) ||
$force ) {
2078 * As for wfSetVar except setting a bit
2082 * @param $state Bool
2086 function wfSetBit( &$dest, $bit, $state = true ) {
2087 $temp = (bool)( $dest & $bit );
2088 if ( !is_null( $state ) ) {
2099 * A wrapper around the PHP function var_export().
2100 * Either print it or add it to the regular output ($wgOut).
2102 * @param $var mixed A PHP variable to dump.
2104 function wfVarDump( $var ) {
2106 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2107 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2110 $wgOut->addHTML( $s );
2115 * Provide a simple HTTP error.
2117 * @param $code Int|String
2118 * @param $label String
2119 * @param $desc String
2121 function wfHttpError( $code, $label, $desc ) {
2124 header( "HTTP/1.0 $code $label" );
2125 header( "Status: $code $label" );
2126 $wgOut->sendCacheControl();
2128 header( 'Content-type: text/html; charset=utf-8' );
2129 print "<!doctype html>" .
2130 '<html><head><title>' .
2131 htmlspecialchars( $label ) .
2132 '</title></head><body><h1>' .
2133 htmlspecialchars( $label ) .
2135 nl2br( htmlspecialchars( $desc ) ) .
2136 "</p></body></html>\n";
2140 * Clear away any user-level output buffers, discarding contents.
2142 * Suitable for 'starting afresh', for instance when streaming
2143 * relatively large amounts of data without buffering, or wanting to
2144 * output image files without ob_gzhandler's compression.
2146 * The optional $resetGzipEncoding parameter controls suppression of
2147 * the Content-Encoding header sent by ob_gzhandler; by default it
2148 * is left. See comments for wfClearOutputBuffers() for why it would
2151 * Note that some PHP configuration options may add output buffer
2152 * layers which cannot be removed; these are left in place.
2154 * @param $resetGzipEncoding Bool
2156 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2157 if( $resetGzipEncoding ) {
2158 // Suppress Content-Encoding and Content-Length
2159 // headers from 1.10+s wfOutputHandler
2160 global $wgDisableOutputCompression;
2161 $wgDisableOutputCompression = true;
2163 while( $status = ob_get_status() ) {
2164 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2165 // Probably from zlib.output_compression or other
2166 // PHP-internal setting which can't be removed.
2168 // Give up, and hope the result doesn't break
2172 if( !ob_end_clean() ) {
2173 // Could not remove output buffer handler; abort now
2174 // to avoid getting in some kind of infinite loop.
2177 if( $resetGzipEncoding ) {
2178 if( $status['name'] == 'ob_gzhandler' ) {
2179 // Reset the 'Content-Encoding' field set by this handler
2180 // so we can start fresh.
2181 header_remove( 'Content-Encoding' );
2189 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2191 * Clear away output buffers, but keep the Content-Encoding header
2192 * produced by ob_gzhandler, if any.
2194 * This should be used for HTTP 304 responses, where you need to
2195 * preserve the Content-Encoding header of the real result, but
2196 * also need to suppress the output of ob_gzhandler to keep to spec
2197 * and avoid breaking Firefox in rare cases where the headers and
2198 * body are broken over two packets.
2200 function wfClearOutputBuffers() {
2201 wfResetOutputBuffers( false );
2205 * Converts an Accept-* header into an array mapping string values to quality
2208 * @param $accept String
2209 * @param $def String default
2212 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2213 # No arg means accept anything (per HTTP spec)
2215 return array( $def => 1.0 );
2220 $parts = explode( ',', $accept );
2222 foreach( $parts as $part ) {
2223 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2224 $values = explode( ';', trim( $part ) );
2226 if ( count( $values ) == 1 ) {
2227 $prefs[$values[0]] = 1.0;
2228 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2229 $prefs[$values[0]] = floatval( $match[1] );
2237 * Checks if a given MIME type matches any of the keys in the given
2238 * array. Basic wildcards are accepted in the array keys.
2240 * Returns the matching MIME type (or wildcard) if a match, otherwise
2243 * @param $type String
2244 * @param $avail Array
2248 function mimeTypeMatch( $type, $avail ) {
2249 if( array_key_exists( $type, $avail ) ) {
2252 $parts = explode( '/', $type );
2253 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2254 return $parts[0] . '/*';
2255 } elseif( array_key_exists( '*/*', $avail ) ) {
2264 * Returns the 'best' match between a client's requested internet media types
2265 * and the server's list of available types. Each list should be an associative
2266 * array of type to preference (preference is a float between 0.0 and 1.0).
2267 * Wildcards in the types are acceptable.
2269 * @param $cprefs Array: client's acceptable type list
2270 * @param $sprefs Array: server's offered types
2273 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2274 * XXX: generalize to negotiate other stuff
2276 function wfNegotiateType( $cprefs, $sprefs ) {
2279 foreach( array_keys( $sprefs ) as $type ) {
2280 $parts = explode( '/', $type );
2281 if( $parts[1] != '*' ) {
2282 $ckey = mimeTypeMatch( $type, $cprefs );
2284 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2289 foreach( array_keys( $cprefs ) as $type ) {
2290 $parts = explode( '/', $type );
2291 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2292 $skey = mimeTypeMatch( $type, $sprefs );
2294 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2302 foreach( array_keys( $combine ) as $type ) {
2303 if( $combine[$type] > $bestq ) {
2305 $bestq = $combine[$type];
2313 * Reference-counted warning suppression
2317 function wfSuppressWarnings( $end = false ) {
2318 static $suppressCount = 0;
2319 static $originalLevel = false;
2322 if ( $suppressCount ) {
2324 if ( !$suppressCount ) {
2325 error_reporting( $originalLevel );
2329 if ( !$suppressCount ) {
2330 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED | E_USER_DEPRECATED
) );
2337 * Restore error level to previous value
2339 function wfRestoreWarnings() {
2340 wfSuppressWarnings( true );
2343 # Autodetect, convert and provide timestamps of various types
2346 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2348 define( 'TS_UNIX', 0 );
2351 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2353 define( 'TS_MW', 1 );
2356 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2358 define( 'TS_DB', 2 );
2361 * RFC 2822 format, for E-mail and HTTP headers
2363 define( 'TS_RFC2822', 3 );
2366 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2368 * This is used by Special:Export
2370 define( 'TS_ISO_8601', 4 );
2373 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2375 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2376 * DateTime tag and page 36 for the DateTimeOriginal and
2377 * DateTimeDigitized tags.
2379 define( 'TS_EXIF', 5 );
2382 * Oracle format time.
2384 define( 'TS_ORACLE', 6 );
2387 * Postgres format time.
2389 define( 'TS_POSTGRES', 7 );
2394 define( 'TS_DB2', 8 );
2397 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2399 define( 'TS_ISO_8601_BASIC', 9 );
2402 * Get a timestamp string in one of various formats
2405 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2406 * function will autodetect which format is supplied and act
2408 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
2409 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2411 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2412 $timestamp = new MWTimestamp( $ts );
2413 return $timestamp->getTimestamp( $outputtype );
2417 * Return a formatted timestamp, or null if input is null.
2418 * For dealing with nullable timestamp columns in the database.
2420 * @param $outputtype Integer
2424 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2425 if( is_null( $ts ) ) {
2428 return wfTimestamp( $outputtype, $ts );
2433 * Convenience function; returns MediaWiki timestamp for the present time.
2437 function wfTimestampNow() {
2439 return wfTimestamp( TS_MW
, time() );
2443 * Check if the operating system is Windows
2445 * @return Bool: true if it's Windows, False otherwise.
2447 function wfIsWindows() {
2448 static $isWindows = null;
2449 if ( $isWindows === null ) {
2450 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2456 * Check if we are running under HipHop
2460 function wfIsHipHop() {
2461 return function_exists( 'hphp_thread_set_warmup_enabled' );
2465 * Swap two variables
2470 function swap( &$x, &$y ) {
2477 * Tries to get the system directory for temporary files. First
2478 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2479 * environment variables are then checked in sequence, and if none are
2480 * set try sys_get_temp_dir().
2482 * NOTE: When possible, use instead the tmpfile() function to create
2483 * temporary files to avoid race conditions on file creation, etc.
2487 function wfTempDir() {
2488 global $wgTmpDirectory;
2490 if ( $wgTmpDirectory !== false ) {
2491 return $wgTmpDirectory;
2494 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2496 foreach( $tmpDir as $tmp ) {
2497 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2501 return sys_get_temp_dir();
2505 * Make directory, and make all parent directories if they don't exist
2507 * @param $dir String: full path to directory to create
2508 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2509 * @param $caller String: optional caller param for debugging.
2512 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2513 global $wgDirectoryMode;
2515 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2516 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2519 if ( !is_null( $caller ) ) {
2520 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2523 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2527 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2529 if ( is_null( $mode ) ) {
2530 $mode = $wgDirectoryMode;
2533 // Turn off the normal warning, we're doing our own below
2534 wfSuppressWarnings();
2535 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2536 wfRestoreWarnings();
2539 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2540 trigger_error( sprintf( "%s: failed to mkdir \"%s\" mode 0%o", __FUNCTION__
, $dir, $mode ),
2547 * Remove a directory and all its content.
2548 * Does not hide error.
2550 function wfRecursiveRemoveDir( $dir ) {
2551 wfDebug( __FUNCTION__
. "( $dir )\n" );
2552 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2553 if ( is_dir( $dir ) ) {
2554 $objects = scandir( $dir );
2555 foreach ( $objects as $object ) {
2556 if ( $object != "." && $object != ".." ) {
2557 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2558 wfRecursiveRemoveDir( $dir . '/' . $object );
2560 unlink( $dir . '/' . $object );
2570 * @param $nr Mixed: the number to format
2571 * @param $acc Integer: the number of digits after the decimal point, default 2
2572 * @param $round Boolean: whether or not to round the value, default true
2575 function wfPercent( $nr, $acc = 2, $round = true ) {
2576 $ret = sprintf( "%.${acc}f", $nr );
2577 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2581 * Find out whether or not a mixed variable exists in a string
2583 * @param $needle String
2584 * @param $str String
2585 * @param $insensitive Boolean
2588 function in_string( $needle, $str, $insensitive = false ) {
2590 if( $insensitive ) $func = 'stripos';
2592 return $func( $str, $needle ) !== false;
2596 * Safety wrapper around ini_get() for boolean settings.
2597 * The values returned from ini_get() are pre-normalized for settings
2598 * set via php.ini or php_flag/php_admin_flag... but *not*
2599 * for those set via php_value/php_admin_value.
2601 * It's fairly common for people to use php_value instead of php_flag,
2602 * which can leave you with an 'off' setting giving a false positive
2603 * for code that just takes the ini_get() return value as a boolean.
2605 * To make things extra interesting, setting via php_value accepts
2606 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2607 * Unrecognized values go false... again opposite PHP's own coercion
2608 * from string to bool.
2610 * Luckily, 'properly' set settings will always come back as '0' or '1',
2611 * so we only have to worry about them and the 'improper' settings.
2613 * I frickin' hate PHP... :P
2615 * @param $setting String
2618 function wfIniGetBool( $setting ) {
2619 $val = ini_get( $setting );
2620 // 'on' and 'true' can't have whitespace around them, but '1' can.
2621 return strtolower( $val ) == 'on'
2622 ||
strtolower( $val ) == 'true'
2623 ||
strtolower( $val ) == 'yes'
2624 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2628 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2629 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2631 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2633 * @param $fileName String Name of the library, if not $extension.suffix
2634 * @return Bool - Whether or not the extension is loaded
2636 function wfDl( $extension, $fileName = null ) {
2637 if( extension_loaded( $extension ) ) {
2642 $sapi = php_sapi_name();
2643 if( $sapi == 'cli' ||
$sapi == 'cgi' ||
$sapi == 'embed' ) {
2644 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2645 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2649 $fileName = $fileName ?
$fileName : $extension;
2650 if( wfIsWindows() ) {
2651 $fileName = 'php_' . $fileName;
2653 wfSuppressWarnings();
2654 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2655 wfRestoreWarnings();
2657 return extension_loaded( $extension );
2661 * Windows-compatible version of escapeshellarg()
2662 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2663 * function puts single quotes in regardless of OS.
2665 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2666 * earlier distro releases of PHP)
2671 function wfEscapeShellArg( ) {
2672 wfInitShellLocale();
2674 $args = func_get_args();
2677 foreach ( $args as $arg ) {
2684 if ( wfIsWindows() ) {
2685 // Escaping for an MSVC-style command line parser and CMD.EXE
2687 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2688 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2691 // Double the backslashes before any double quotes. Escape the double quotes.
2692 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2695 foreach ( $tokens as $token ) {
2696 if ( $iteration %
2 == 1 ) {
2697 // Delimiter, a double quote preceded by zero or more slashes
2698 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2699 } elseif ( $iteration %
4 == 2 ) {
2700 // ^ in $token will be outside quotes, need to be escaped
2701 $arg .= str_replace( '^', '^^', $token );
2702 } else { // $iteration % 4 == 0
2703 // ^ in $token will appear inside double quotes, so leave as is
2708 // Double the backslashes before the end of the string, because
2709 // we will soon add a quote
2711 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2712 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2715 // Add surrounding quotes
2716 $retVal .= '"' . $arg . '"';
2718 $retVal .= escapeshellarg( $arg );
2725 * Execute a shell command, with time and memory limits mirrored from the PHP
2726 * configuration if supported.
2727 * @param $cmd String Command line, properly escaped for shell.
2728 * @param &$retval null|Mixed optional, will receive the program's exit code.
2729 * (non-zero is usually failure)
2730 * @param $environ Array optional environment variables which should be
2731 * added to the executed command environment.
2732 * @param $limits Array optional array with limits(filesize, memory, time)
2733 * this overwrites the global wgShellMax* limits.
2734 * @return string collected stdout as a string (trailing newlines stripped)
2736 function wfShellExec( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2737 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2740 if ( is_null( $disabled ) ) {
2742 if( wfIniGetBool( 'safe_mode' ) ) {
2743 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2744 $disabled = 'safemode';
2746 $functions = explode( ',', ini_get( 'disable_functions' ) );
2747 $functions = array_map( 'trim', $functions );
2748 $functions = array_map( 'strtolower', $functions );
2749 if ( in_array( 'passthru', $functions ) ) {
2750 wfDebug( "passthru is in disabled_functions\n" );
2751 $disabled = 'passthru';
2757 return $disabled == 'safemode' ?
2758 'Unable to run external programs in safe mode.' :
2759 'Unable to run external programs, passthru() is disabled.';
2762 wfInitShellLocale();
2765 foreach( $environ as $k => $v ) {
2766 if ( wfIsWindows() ) {
2767 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2768 * appear in the environment variable, so we must use carat escaping as documented in
2769 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2770 * Note however that the quote isn't listed there, but is needed, and the parentheses
2771 * are listed there but doesn't appear to need it.
2773 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2775 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2776 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2778 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2781 $cmd = $envcmd . $cmd;
2783 if ( php_uname( 's' ) == 'Linux' ) {
2784 $time = intval ( isset($limits['time']) ?
$limits['time'] : $wgMaxShellTime );
2785 $mem = intval ( isset($limits['memory']) ?
$limits['memory'] : $wgMaxShellMemory );
2786 $filesize = intval ( isset($limits['filesize']) ?
$limits['filesize'] : $wgMaxShellFileSize );
2788 if ( $time > 0 && $mem > 0 ) {
2789 $script = "$IP/bin/ulimit4.sh";
2790 if ( is_executable( $script ) ) {
2791 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2795 wfDebug( "wfShellExec: $cmd\n" );
2797 $retval = 1; // error by default?
2799 passthru( $cmd, $retval );
2800 $output = ob_get_contents();
2803 if ( $retval == 127 ) {
2804 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2810 * Workaround for http://bugs.php.net/bug.php?id=45132
2811 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2813 function wfInitShellLocale() {
2814 static $done = false;
2819 global $wgShellLocale;
2820 if ( !wfIniGetBool( 'safe_mode' ) ) {
2821 putenv( "LC_CTYPE=$wgShellLocale" );
2822 setlocale( LC_CTYPE
, $wgShellLocale );
2827 * Alias to wfShellWikiCmd()
2828 * @see wfShellWikiCmd()
2830 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2831 return wfShellWikiCmd( $script, $parameters, $options );
2835 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2836 * Note that $parameters should be a flat array and an option with an argument
2837 * should consist of two consecutive items in the array (do not use "--option value").
2838 * @param $script string MediaWiki cli script path
2839 * @param $parameters Array Arguments and options to the script
2840 * @param $options Array Associative array of options:
2841 * 'php': The path to the php executable
2842 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2845 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2847 // Give site config file a chance to run the script in a wrapper.
2848 // The caller may likely want to call wfBasename() on $script.
2849 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2850 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2851 if ( isset( $options['wrapper'] ) ) {
2852 $cmd[] = $options['wrapper'];
2855 // Escape each parameter for shell
2856 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2860 * wfMerge attempts to merge differences between three texts.
2861 * Returns true for a clean merge and false for failure or a conflict.
2863 * @param $old String
2864 * @param $mine String
2865 * @param $yours String
2866 * @param $result String
2869 function wfMerge( $old, $mine, $yours, &$result ) {
2872 # This check may also protect against code injection in
2873 # case of broken installations.
2874 wfSuppressWarnings();
2875 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2876 wfRestoreWarnings();
2879 wfDebug( "diff3 not found\n" );
2883 # Make temporary files
2885 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2886 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2887 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2889 fwrite( $oldtextFile, $old );
2890 fclose( $oldtextFile );
2891 fwrite( $mytextFile, $mine );
2892 fclose( $mytextFile );
2893 fwrite( $yourtextFile, $yours );
2894 fclose( $yourtextFile );
2896 # Check for a conflict
2897 $cmd = $wgDiff3 . ' -a --overlap-only ' .
2898 wfEscapeShellArg( $mytextName ) . ' ' .
2899 wfEscapeShellArg( $oldtextName ) . ' ' .
2900 wfEscapeShellArg( $yourtextName );
2901 $handle = popen( $cmd, 'r' );
2903 if( fgets( $handle, 1024 ) ) {
2911 $cmd = $wgDiff3 . ' -a -e --merge ' .
2912 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
2913 $handle = popen( $cmd, 'r' );
2916 $data = fread( $handle, 8192 );
2917 if ( strlen( $data ) == 0 ) {
2923 unlink( $mytextName );
2924 unlink( $oldtextName );
2925 unlink( $yourtextName );
2927 if ( $result === '' && $old !== '' && !$conflict ) {
2928 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2935 * Returns unified plain-text diff of two texts.
2936 * Useful for machine processing of diffs.
2938 * @param $before String: the text before the changes.
2939 * @param $after String: the text after the changes.
2940 * @param $params String: command-line options for the diff command.
2941 * @return String: unified diff of $before and $after
2943 function wfDiff( $before, $after, $params = '-u' ) {
2944 if ( $before == $after ) {
2949 wfSuppressWarnings();
2950 $haveDiff = $wgDiff && file_exists( $wgDiff );
2951 wfRestoreWarnings();
2953 # This check may also protect against code injection in
2954 # case of broken installations.
2956 wfDebug( "diff executable not found\n" );
2957 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2958 $format = new UnifiedDiffFormatter();
2959 return $format->format( $diffs );
2962 # Make temporary files
2964 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2965 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2967 fwrite( $oldtextFile, $before );
2968 fclose( $oldtextFile );
2969 fwrite( $newtextFile, $after );
2970 fclose( $newtextFile );
2972 // Get the diff of the two files
2973 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
2975 $h = popen( $cmd, 'r' );
2980 $data = fread( $h, 8192 );
2981 if ( strlen( $data ) == 0 ) {
2989 unlink( $oldtextName );
2990 unlink( $newtextName );
2992 // Kill the --- and +++ lines. They're not useful.
2993 $diff_lines = explode( "\n", $diff );
2994 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
2995 unset( $diff_lines[0] );
2997 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
2998 unset( $diff_lines[1] );
3001 $diff = implode( "\n", $diff_lines );
3007 * This function works like "use VERSION" in Perl, the program will die with a
3008 * backtrace if the current version of PHP is less than the version provided
3010 * This is useful for extensions which due to their nature are not kept in sync
3011 * with releases, and might depend on other versions of PHP than the main code
3013 * Note: PHP might die due to parsing errors in some cases before it ever
3014 * manages to call this function, such is life
3016 * @see perldoc -f use
3018 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3021 function wfUsePHP( $req_ver ) {
3022 $php_ver = PHP_VERSION
;
3024 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3025 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3030 * This function works like "use VERSION" in Perl except it checks the version
3031 * of MediaWiki, the program will die with a backtrace if the current version
3032 * of MediaWiki is less than the version provided.
3034 * This is useful for extensions which due to their nature are not kept in sync
3037 * @see perldoc -f use
3039 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3042 function wfUseMW( $req_ver ) {
3045 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3046 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3051 * Return the final portion of a pathname.
3052 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3053 * http://bugs.php.net/bug.php?id=33898
3055 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3056 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3058 * @param $path String
3059 * @param $suffix String: to remove if present
3062 function wfBaseName( $path, $suffix = '' ) {
3063 $encSuffix = ( $suffix == '' )
3065 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
3067 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3075 * Generate a relative path name to the given file.
3076 * May explode on non-matching case-insensitive paths,
3077 * funky symlinks, etc.
3079 * @param $path String: absolute destination path including target filename
3080 * @param $from String: Absolute source path, directory only
3083 function wfRelativePath( $path, $from ) {
3084 // Normalize mixed input on Windows...
3085 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3086 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3088 // Trim trailing slashes -- fix for drive root
3089 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3090 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3092 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3093 $against = explode( DIRECTORY_SEPARATOR
, $from );
3095 if( $pieces[0] !== $against[0] ) {
3096 // Non-matching Windows drive letters?
3097 // Return a full path.
3101 // Trim off common prefix
3102 while( count( $pieces ) && count( $against )
3103 && $pieces[0] == $against[0] ) {
3104 array_shift( $pieces );
3105 array_shift( $against );
3108 // relative dots to bump us to the parent
3109 while( count( $against ) ) {
3110 array_unshift( $pieces, '..' );
3111 array_shift( $against );
3114 array_push( $pieces, wfBaseName( $path ) );
3116 return implode( DIRECTORY_SEPARATOR
, $pieces );
3120 * Do any deferred updates and clear the list
3122 * @deprecated since 1.19
3123 * @see DeferredUpdates::doUpdate()
3124 * @param $commit string
3126 function wfDoUpdates( $commit = '' ) {
3127 wfDeprecated( __METHOD__
, '1.19' );
3128 DeferredUpdates
::doUpdates( $commit );
3132 * Convert an arbitrarily-long digit string from one numeric base
3133 * to another, optionally zero-padding to a minimum column width.
3135 * Supports base 2 through 36; digit values 10-36 are represented
3136 * as lowercase letters a-z. Input is case-insensitive.
3138 * @param $input String: of digits
3139 * @param $sourceBase Integer: 2-36
3140 * @param $destBase Integer: 2-36
3141 * @param $pad Integer: 1 or greater
3142 * @param $lowercase Boolean
3143 * @return String or false on invalid input
3145 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
3146 $input = strval( $input );
3147 if( $sourceBase < 2 ||
3152 $sourceBase != intval( $sourceBase ) ||
3153 $destBase != intval( $destBase ) ||
3154 $pad != intval( $pad ) ||
3155 !is_string( $input ) ||
3159 $digitChars = ( $lowercase ) ?
'0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3160 $inDigits = array();
3163 // Decode and validate input string
3164 $input = strtolower( $input );
3165 for( $i = 0; $i < strlen( $input ); $i++
) {
3166 $n = strpos( $digitChars, $input[$i] );
3167 if( $n === false ||
$n > $sourceBase ) {
3173 // Iterate over the input, modulo-ing out an output digit
3174 // at a time until input is gone.
3175 while( count( $inDigits ) ) {
3177 $workDigits = array();
3180 foreach( $inDigits as $digit ) {
3181 $work *= $sourceBase;
3184 if( $work < $destBase ) {
3185 // Gonna need to pull another digit.
3186 if( count( $workDigits ) ) {
3187 // Avoid zero-padding; this lets us find
3188 // the end of the input very easily when
3189 // length drops to zero.
3193 // Finally! Actual division!
3194 $workDigits[] = intval( $work / $destBase );
3196 // Isn't it annoying that most programming languages
3197 // don't have a single divide-and-remainder operator,
3198 // even though the CPU implements it that way?
3199 $work = $work %
$destBase;
3203 // All that division leaves us with a remainder,
3204 // which is conveniently our next output digit.
3205 $outChars .= $digitChars[$work];
3208 $inDigits = $workDigits;
3211 while( strlen( $outChars ) < $pad ) {
3215 return strrev( $outChars );
3219 * Create an object with a given name and an array of construct parameters
3221 * @param $name String
3222 * @param $p Array: parameters
3224 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3226 function wfCreateObject( $name, $p ) {
3227 wfDeprecated( __FUNCTION__
, '1.18' );
3228 return MWFunction
::newObj( $name, $p );
3234 function wfHttpOnlySafe() {
3235 global $wgHttpOnlyBlacklist;
3237 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3238 foreach( $wgHttpOnlyBlacklist as $regex ) {
3239 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3249 * Override session_id before session startup if php's built-in
3250 * session generation code is not secure.
3252 function wfFixSessionID() {
3253 // If the cookie or session id is already set we already have a session and should abort
3254 if ( isset( $_COOKIE[ session_name() ] ) ||
session_id() ) {
3258 // PHP's built-in session entropy is enabled if:
3259 // - entropy_file is set or you're on Windows with php 5.3.3+
3260 // - AND entropy_length is > 0
3261 // We treat it as disabled if it doesn't have an entropy length of at least 32
3263 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3264 ||
ini_get( 'session.entropy_file' )
3266 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3268 // If built-in entropy is not enabled or not sufficient override php's built in session id generation code
3269 if ( !$entropyEnabled ) {
3270 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, overriding session id generation using our cryptrand source.\n" );
3271 session_id( MWCryptRand
::generateHex( 32 ) );
3276 * Initialise php session
3278 * @param $sessionId Bool
3280 function wfSetupSession( $sessionId = false ) {
3281 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3282 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3283 if( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3284 ObjectCacheSessionHandler
::install();
3285 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3286 # Only set this if $wgSessionHandler isn't null and session.save_handler
3287 # hasn't already been set to the desired value (that causes errors)
3288 ini_set( 'session.save_handler', $wgSessionHandler );
3290 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3291 wfDebugLog( 'cookie',
3292 'session_set_cookie_params: "' . implode( '", "',
3298 $httpOnlySafe ) ) . '"' );
3299 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3300 session_cache_limiter( 'private, must-revalidate' );
3302 session_id( $sessionId );
3306 wfSuppressWarnings();
3308 wfRestoreWarnings();
3312 * Get an object from the precompiled serialized directory
3314 * @param $name String
3315 * @return Mixed: the variable on success, false on failure
3317 function wfGetPrecompiledData( $name ) {
3320 $file = "$IP/serialized/$name";
3321 if ( file_exists( $file ) ) {
3322 $blob = file_get_contents( $file );
3324 return unserialize( $blob );
3336 function wfMemcKey( /*... */ ) {
3337 global $wgCachePrefix;
3338 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3339 $args = func_get_args();
3340 $key = $prefix . ':' . implode( ':', $args );
3341 $key = str_replace( ' ', '_', $key );
3346 * Get a cache key for a foreign DB
3349 * @param $prefix String
3350 * @param varargs String
3353 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3354 $args = array_slice( func_get_args(), 2 );
3356 $key = "$db-$prefix:" . implode( ':', $args );
3358 $key = $db . ':' . implode( ':', $args );
3364 * Get an ASCII string identifying this wiki
3365 * This is used as a prefix in memcached keys
3369 function wfWikiID() {
3370 global $wgDBprefix, $wgDBname;
3371 if ( $wgDBprefix ) {
3372 return "$wgDBname-$wgDBprefix";
3379 * Split a wiki ID into DB name and table prefix
3381 * @param $wiki String
3385 function wfSplitWikiID( $wiki ) {
3386 $bits = explode( '-', $wiki, 2 );
3387 if ( count( $bits ) < 2 ) {
3394 * Get a Database object.
3396 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3397 * master (for write queries), DB_SLAVE for potentially lagged read
3398 * queries, or an integer >= 0 for a particular server.
3400 * @param $groups Mixed: query groups. An array of group names that this query
3401 * belongs to. May contain a single string if the query is only
3404 * @param $wiki String: the wiki ID, or false for the current wiki
3406 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3407 * will always return the same object, unless the underlying connection or load
3408 * balancer is manually destroyed.
3410 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3411 * updater to ensure that a proper database is being updated.
3413 * @return DatabaseBase
3415 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3416 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3420 * Get a load balancer object.
3422 * @param $wiki String: wiki ID, or false for the current wiki
3423 * @return LoadBalancer
3425 function wfGetLB( $wiki = false ) {
3426 return wfGetLBFactory()->getMainLB( $wiki );
3430 * Get the load balancer factory object
3434 function &wfGetLBFactory() {
3435 return LBFactory
::singleton();
3440 * Shortcut for RepoGroup::singleton()->findFile()
3442 * @param $title String or Title object
3443 * @param $options array Associative array of options:
3444 * time: requested time for an archived image, or false for the
3445 * current version. An image object will be returned which was
3446 * created at the specified time.
3448 * ignoreRedirect: If true, do not follow file redirects
3450 * private: If true, return restricted (deleted) files if the current
3451 * user is allowed to view them. Otherwise, such files will not
3454 * bypassCache: If true, do not use the process-local cache of File objects
3456 * @return File, or false if the file does not exist
3458 function wfFindFile( $title, $options = array() ) {
3459 return RepoGroup
::singleton()->findFile( $title, $options );
3463 * Get an object referring to a locally registered file.
3464 * Returns a valid placeholder object if the file does not exist.
3466 * @param $title Title|String
3467 * @return LocalFile|null A File, or null if passed an invalid Title
3469 function wfLocalFile( $title ) {
3470 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3474 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3475 * @deprecated since 1.19
3477 function wfStreamFile( $fname, $headers = array() ) {
3478 wfDeprecated( __FUNCTION__
, '1.19' );
3479 StreamFile
::stream( $fname, $headers );
3483 * Should low-performance queries be disabled?
3486 * @codeCoverageIgnore
3488 function wfQueriesMustScale() {
3489 global $wgMiserMode;
3491 ||
( SiteStats
::pages() > 100000
3492 && SiteStats
::edits() > 1000000
3493 && SiteStats
::users() > 10000 );
3497 * Get the path to a specified script file, respecting file
3498 * extensions; this is a wrapper around $wgScriptExtension etc.
3499 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3501 * @param $script String: script filename, sans extension
3504 function wfScript( $script = 'index' ) {
3505 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3506 if ( $script === 'index' ) {
3508 } else if ( $script === 'load' ) {
3509 return $wgLoadScript;
3511 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3516 * Get the script URL.
3518 * @return string script URL
3520 function wfGetScriptUrl() {
3521 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3523 # as it was called, minus the query string.
3525 # Some sites use Apache rewrite rules to handle subdomains,
3526 # and have PHP set up in a weird way that causes PHP_SELF
3527 # to contain the rewritten URL instead of the one that the
3528 # outside world sees.
3530 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3531 # provides containing the "before" URL.
3532 return $_SERVER['SCRIPT_NAME'];
3534 return $_SERVER['URL'];
3539 * Convenience function converts boolean values into "true"
3540 * or "false" (string) values
3542 * @param $value Boolean
3545 function wfBoolToStr( $value ) {
3546 return $value ?
'true' : 'false';
3550 * Load an extension messages file
3552 * @deprecated since 1.16, warnings in 1.18, remove in 1.20
3553 * @codeCoverageIgnore
3555 function wfLoadExtensionMessages() {
3556 wfDeprecated( __FUNCTION__
, '1.16' );
3560 * Get a platform-independent path to the null file, e.g. /dev/null
3564 function wfGetNull() {
3565 return wfIsWindows()
3571 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3572 * and waiting for it to go down, this waits for the slaves to catch up to the
3573 * master position. Use this when updating very large numbers of rows, as
3574 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3575 * a no-op if there are no slaves.
3577 * @param $maxLag Integer (deprecated)
3578 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3580 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3581 $lb = wfGetLB( $wiki );
3582 // bug 27975 - Don't try to wait for slaves if there are none
3583 // Prevents permission error when getting master position
3584 if ( $lb->getServerCount() > 1 ) {
3585 $dbw = $lb->getConnection( DB_MASTER
);
3586 $pos = $dbw->getMasterPos();
3587 $lb->waitForAll( $pos );
3592 * Used to be used for outputting text in the installer/updater
3593 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3595 function wfOut( $s ) {
3596 wfDeprecated( __FUNCTION__
, '1.18' );
3597 global $wgCommandLineMode;
3598 if ( $wgCommandLineMode ) {
3601 echo htmlspecialchars( $s );
3607 * Count down from $n to zero on the terminal, with a one-second pause
3608 * between showing each number. For use in command-line scripts.
3609 * @codeCoverageIgnore
3612 function wfCountDown( $n ) {
3613 for ( $i = $n; $i >= 0; $i-- ) {
3615 echo str_repeat( "\x08", strlen( $i +
1 ) );
3627 * Generate a random 32-character hexadecimal token.
3628 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3629 * characters before hashing.
3631 * @codeCoverageIgnore
3632 * @deprecated since 1.20; Please use MWCryptRand for security purposes and wfRandomString for pesudo-random strings
3633 * @warning This method is NOT secure. Additionally it has many callers that use it for pesudo-random purposes.
3635 function wfGenerateToken( $salt = '' ) {
3636 wfDeprecated( __METHOD__
, '1.20' );
3637 $salt = serialize( $salt );
3638 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3642 * Replace all invalid characters with -
3643 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3644 * By default, $wgIllegalFileChars = ':'
3646 * @param $name Mixed: filename to process
3649 function wfStripIllegalFilenameChars( $name ) {
3650 global $wgIllegalFileChars;
3651 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3652 $name = wfBaseName( $name );
3653 $name = preg_replace(
3654 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3662 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3664 * @return Integer value memory was set to.
3666 function wfMemoryLimit() {
3667 global $wgMemoryLimit;
3668 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3669 if( $memlimit != -1 ) {
3670 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3671 if( $conflimit == -1 ) {
3672 wfDebug( "Removing PHP's memory limit\n" );
3673 wfSuppressWarnings();
3674 ini_set( 'memory_limit', $conflimit );
3675 wfRestoreWarnings();
3677 } elseif ( $conflimit > $memlimit ) {
3678 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3679 wfSuppressWarnings();
3680 ini_set( 'memory_limit', $conflimit );
3681 wfRestoreWarnings();
3689 * Converts shorthand byte notation to integer form
3691 * @param $string String
3694 function wfShorthandToInteger( $string = '' ) {
3695 $string = trim( $string );
3696 if( $string === '' ) {
3699 $last = $string[strlen( $string ) - 1];
3700 $val = intval( $string );
3705 // break intentionally missing
3709 // break intentionally missing
3719 * Get the normalised IETF language tag
3720 * See unit test for examples.
3722 * @param $code String: The language code.
3723 * @return String: The language code which complying with BCP 47 standards.
3725 function wfBCP47( $code ) {
3726 $codeSegment = explode( '-', $code );
3728 foreach ( $codeSegment as $segNo => $seg ) {
3729 if ( count( $codeSegment ) > 0 ) {
3730 // when previous segment is x, it is a private segment and should be lc
3731 if( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3732 $codeBCP[$segNo] = strtolower( $seg );
3733 // ISO 3166 country code
3734 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3735 $codeBCP[$segNo] = strtoupper( $seg );
3736 // ISO 15924 script code
3737 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3738 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3739 // Use lowercase for other cases
3741 $codeBCP[$segNo] = strtolower( $seg );
3744 // Use lowercase for single segment
3745 $codeBCP[$segNo] = strtolower( $seg );
3748 $langCode = implode( '-', $codeBCP );
3753 * Get a cache object.
3755 * @param $inputType integer Cache type, one the the CACHE_* constants.
3758 function wfGetCache( $inputType ) {
3759 return ObjectCache
::getInstance( $inputType );
3763 * Get the main cache object
3767 function wfGetMainCache() {
3768 global $wgMainCacheType;
3769 return ObjectCache
::getInstance( $wgMainCacheType );
3773 * Get the cache object used by the message cache
3777 function wfGetMessageCacheStorage() {
3778 global $wgMessageCacheType;
3779 return ObjectCache
::getInstance( $wgMessageCacheType );
3783 * Get the cache object used by the parser cache
3787 function wfGetParserCacheStorage() {
3788 global $wgParserCacheType;
3789 return ObjectCache
::getInstance( $wgParserCacheType );
3793 * Get the cache object used by the language converter
3797 function wfGetLangConverterCacheStorage() {
3798 global $wgLanguageConverterCacheType;
3799 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3803 * Call hook functions defined in $wgHooks
3805 * @param $event String: event name
3806 * @param $args Array: parameters passed to hook functions
3807 * @return Boolean True if no handler aborted the hook
3809 function wfRunHooks( $event, $args = array() ) {
3810 return Hooks
::run( $event, $args );
3814 * Wrapper around php's unpack.
3816 * @param $format String: The format string (See php's docs)
3817 * @param $data: A binary string of binary data
3818 * @param $length integer or false: The minimun length of $data. This is to
3819 * prevent reading beyond the end of $data. false to disable the check.
3821 * Also be careful when using this function to read unsigned 32 bit integer
3822 * because php might make it negative.
3824 * @throws MWException if $data not long enough, or if unpack fails
3825 * @return array Associative array of the extracted data
3827 function wfUnpack( $format, $data, $length=false ) {
3828 if ( $length !== false ) {
3829 $realLen = strlen( $data );
3830 if ( $realLen < $length ) {
3831 throw new MWException( "Tried to use wfUnpack on a "
3832 . "string of length $realLen, but needed one "
3833 . "of at least length $length."
3838 wfSuppressWarnings();
3839 $result = unpack( $format, $data );
3840 wfRestoreWarnings();
3842 if ( $result === false ) {
3843 // If it cannot extract the packed data.
3844 throw new MWException( "unpack could not unpack binary data" );
3850 * Determine if an image exists on the 'bad image list'.
3852 * The format of MediaWiki:Bad_image_list is as follows:
3853 * * Only list items (lines starting with "*") are considered
3854 * * The first link on a line must be a link to a bad image
3855 * * Any subsequent links on the same line are considered to be exceptions,
3856 * i.e. articles where the image may occur inline.
3858 * @param $name string the image name to check
3859 * @param $contextTitle Title|bool the page on which the image occurs, if known
3860 * @param $blacklist string wikitext of a file blacklist
3863 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3864 static $badImageCache = null; // based on bad_image_list msg
3865 wfProfileIn( __METHOD__
);
3868 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
3869 if( $redirectTitle ) {
3870 $name = $redirectTitle->getDbKey();
3873 # Run the extension hook
3875 if( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
3876 wfProfileOut( __METHOD__
);
3880 $cacheable = ( $blacklist === null );
3881 if( $cacheable && $badImageCache !== null ) {
3882 $badImages = $badImageCache;
3883 } else { // cache miss
3884 if ( $blacklist === null ) {
3885 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3887 # Build the list now
3888 $badImages = array();
3889 $lines = explode( "\n", $blacklist );
3890 foreach( $lines as $line ) {
3892 if ( substr( $line, 0, 1 ) !== '*' ) {
3898 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3902 $exceptions = array();
3903 $imageDBkey = false;
3904 foreach ( $m[1] as $i => $titleText ) {
3905 $title = Title
::newFromText( $titleText );
3906 if ( !is_null( $title ) ) {
3908 $imageDBkey = $title->getDBkey();
3910 $exceptions[$title->getPrefixedDBkey()] = true;
3915 if ( $imageDBkey !== false ) {
3916 $badImages[$imageDBkey] = $exceptions;
3920 $badImageCache = $badImages;
3924 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3925 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3926 wfProfileOut( __METHOD__
);