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 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
790 $bits['scheme'] = strtolower( $bits['scheme'] );
792 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
793 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
794 $bits['delimiter'] = '://';
795 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
796 $bits['delimiter'] = ':';
797 // parse_url detects for news: and mailto: the host part of an url as path
798 // We have to correct this wrong detection
799 if ( isset( $bits['path'] ) ) {
800 $bits['host'] = $bits['path'];
807 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
808 if ( !isset( $bits['host'] ) ) {
811 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
812 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
813 $bits['path'] = '/' . $bits['path'];
817 // If the URL was protocol-relative, fix scheme and delimiter
818 if ( $wasRelative ) {
819 $bits['scheme'] = '';
820 $bits['delimiter'] = '//';
826 * Take a URL, make sure it's expanded to fully qualified, and replace any
827 * encoded non-ASCII Unicode characters with their UTF-8 original forms
828 * for more compact display and legibility for local audiences.
830 * @todo handle punycode domains too
835 function wfExpandIRI( $url ) {
836 return preg_replace_callback( '/((?:%[89A-F][0-9A-F])+)/i', 'wfExpandIRI_callback', wfExpandUrl( $url ) );
840 * Private callback for wfExpandIRI
841 * @param array $matches
844 function wfExpandIRI_callback( $matches ) {
845 return urldecode( $matches[1] );
851 * Make URL indexes, appropriate for the el_index field of externallinks.
856 function wfMakeUrlIndexes( $url ) {
857 $bits = wfParseUrl( $url );
859 // Reverse the labels in the hostname, convert to lower case
860 // For emails reverse domainpart only
861 if ( $bits['scheme'] == 'mailto' ) {
862 $mailparts = explode( '@', $bits['host'], 2 );
863 if ( count( $mailparts ) === 2 ) {
864 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
866 // No domain specified, don't mangle it
869 $reversedHost = $domainpart . '@' . $mailparts[0];
871 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
873 // Add an extra dot to the end
874 // Why? Is it in wrong place in mailto links?
875 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
876 $reversedHost .= '.';
878 // Reconstruct the pseudo-URL
879 $prot = $bits['scheme'];
880 $index = $prot . $bits['delimiter'] . $reversedHost;
881 // Leave out user and password. Add the port, path, query and fragment
882 if ( isset( $bits['port'] ) ) {
883 $index .= ':' . $bits['port'];
885 if ( isset( $bits['path'] ) ) {
886 $index .= $bits['path'];
890 if ( isset( $bits['query'] ) ) {
891 $index .= '?' . $bits['query'];
893 if ( isset( $bits['fragment'] ) ) {
894 $index .= '#' . $bits['fragment'];
898 return array( "http:$index", "https:$index" );
900 return array( $index );
905 * Check whether a given URL has a domain that occurs in a given set of domains
906 * @param $url string URL
907 * @param $domains array Array of domains (strings)
908 * @return bool True if the host part of $url ends in one of the strings in $domains
910 function wfMatchesDomainList( $url, $domains ) {
911 $bits = wfParseUrl( $url );
912 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
913 foreach ( (array)$domains as $domain ) {
914 // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org
915 // We should use something that interprets dots instead
916 if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) {
925 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
926 * In normal operation this is a NOP.
928 * Controlling globals:
929 * $wgDebugLogFile - points to the log file
930 * $wgProfileOnly - if set, normal debug messages will not be recorded.
931 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
932 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
934 * @param $text String
935 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
937 function wfDebug( $text, $logonly = false ) {
938 global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
940 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
944 $timer = wfDebugTimer();
945 if ( $timer !== '' ) {
946 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
950 MWDebug
::debugMsg( $text );
953 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
954 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
955 # Strip unprintables; they can switch terminal modes when binary data
956 # gets dumped, which is pretty annoying.
957 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
958 $text = $wgDebugLogPrefix . $text;
959 wfErrorLog( $text, $wgDebugLogFile );
965 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
968 function wfIsDebugRawPage() {
970 if ( $cache !== null ) {
973 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
974 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
976 isset( $_SERVER['SCRIPT_NAME'] )
977 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
988 * Get microsecond timestamps for debug logs
992 function wfDebugTimer() {
993 global $wgDebugTimestamps, $wgRequestTime;
995 if ( !$wgDebugTimestamps ) {
999 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1000 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1001 return "$prefix $mem ";
1005 * Send a line giving PHP memory usage.
1007 * @param $exact Bool: print exact values instead of kilobytes (default: false)
1009 function wfDebugMem( $exact = false ) {
1010 $mem = memory_get_usage();
1012 $mem = floor( $mem / 1024 ) . ' kilobytes';
1016 wfDebug( "Memory usage: $mem\n" );
1020 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1021 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
1023 * @param $logGroup String
1024 * @param $text String
1025 * @param $public Bool: whether to log the event in the public log if no private
1026 * log file is specified, (default true)
1028 function wfDebugLog( $logGroup, $text, $public = true ) {
1029 global $wgDebugLogGroups;
1030 $text = trim( $text ) . "\n";
1031 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
1032 $time = wfTimestamp( TS_DB
);
1034 $host = wfHostname();
1035 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
1036 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
1038 } elseif ( $public === true ) {
1039 wfDebug( $text, true );
1044 * Log for database errors
1046 * @param $text String: database error message.
1048 function wfLogDBError( $text ) {
1049 global $wgDBerrorLog, $wgDBerrorLogTZ;
1050 static $logDBErrorTimeZoneObject = null;
1052 if ( $wgDBerrorLog ) {
1053 $host = wfHostname();
1056 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1057 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1060 // Workaround for https://bugs.php.net/bug.php?id=52063
1061 // Can be removed when min PHP > 5.3.2
1062 if ( $logDBErrorTimeZoneObject === null ) {
1063 $d = date_create( "now" );
1065 $d = date_create( "now", $logDBErrorTimeZoneObject );
1068 $date = $d->format( 'D M j G:i:s T Y' );
1070 $text = "$date\t$host\t$wiki\t$text";
1071 wfErrorLog( $text, $wgDBerrorLog );
1076 * Throws a warning that $function is deprecated
1078 * @param $function String
1079 * @param $version String|bool: Version of MediaWiki that the function was deprecated in (Added in 1.19).
1080 * @param $component String|bool: Added in 1.19.
1081 * @param $callerOffset integer: How far up the callstack is the original
1082 * caller. 2 = function that called the function that called
1083 * wfDeprecated (Added in 1.20)
1087 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1088 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1092 * Send a warning either to the debug log or in a PHP error depending on
1093 * $wgDevelopmentWarnings
1095 * @param $msg String: message to send
1096 * @param $callerOffset Integer: number of items to go back in the backtrace to
1097 * find the correct caller (1 = function calling wfWarn, ...)
1098 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
1101 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1102 MWDebug
::warning( $msg, $callerOffset +
1, $level );
1106 * Log to a file without getting "file size exceeded" signals.
1108 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1109 * send lines to the specified port, prefixed by the specified prefix and a space.
1111 * @param $text String
1112 * @param $file String filename
1114 function wfErrorLog( $text, $file ) {
1115 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1116 # Needs the sockets extension
1117 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1118 // IPv6 bracketed host
1120 $port = intval( $m[3] );
1121 $prefix = isset( $m[4] ) ?
$m[4] : false;
1123 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1125 if ( !IP
::isIPv4( $host ) ) {
1126 $host = gethostbyname( $host );
1128 $port = intval( $m[3] );
1129 $prefix = isset( $m[4] ) ?
$m[4] : false;
1132 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1135 // Clean it up for the multiplexer
1136 if ( strval( $prefix ) !== '' ) {
1137 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1140 if ( strlen( $text ) > 65506 ) {
1141 $text = substr( $text, 0, 65506 );
1144 if ( substr( $text, -1 ) != "\n" ) {
1147 } elseif ( strlen( $text ) > 65507 ) {
1148 $text = substr( $text, 0, 65507 );
1151 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1156 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1157 socket_close( $sock );
1159 wfSuppressWarnings();
1160 $exists = file_exists( $file );
1161 $size = $exists ?
filesize( $file ) : false;
1162 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1163 file_put_contents( $file, $text, FILE_APPEND
);
1165 wfRestoreWarnings();
1172 function wfLogProfilingData() {
1173 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1174 global $wgProfileLimit, $wgUser;
1176 $profiler = Profiler
::instance();
1178 # Profiling must actually be enabled...
1179 if ( $profiler->isStub() ) {
1183 // Get total page request time and only show pages that longer than
1184 // $wgProfileLimit time (default is 0)
1185 $elapsed = microtime( true ) - $wgRequestTime;
1186 if ( $elapsed <= $wgProfileLimit ) {
1190 $profiler->logData();
1192 // Check whether this should be logged in the debug file.
1193 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1198 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1199 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1201 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1202 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1204 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1205 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1208 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1210 // Don't load $wgUser at this late stage just for statistics purposes
1211 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1212 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1213 $forward .= ' anon';
1215 $log = sprintf( "%s\t%04.3f\t%s\n",
1216 gmdate( 'YmdHis' ), $elapsed,
1217 urldecode( $wgRequest->getRequestURL() . $forward ) );
1219 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1223 * Increment a statistics counter
1225 * @param $key String
1228 function wfIncrStats( $key, $count = 1 ) {
1229 global $wgStatsMethod;
1231 $count = intval( $count );
1233 if( $wgStatsMethod == 'udp' ) {
1234 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
1237 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : $wgDBname;
1240 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
1241 $statline = "stats/{$id} - 1 1 1 1 1 -total\n";
1245 strlen( $statline ),
1251 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
1252 wfSuppressWarnings();
1256 strlen( $statline ),
1261 wfRestoreWarnings();
1262 } elseif( $wgStatsMethod == 'cache' ) {
1264 $key = wfMemcKey( 'stats', $key );
1265 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
1266 $wgMemc->add( $key, $count );
1274 * Check if the wiki read-only lock file is present. This can be used to lock
1275 * off editing functions, but doesn't guarantee that the database will not be
1280 function wfReadOnly() {
1281 global $wgReadOnlyFile, $wgReadOnly;
1283 if ( !is_null( $wgReadOnly ) ) {
1284 return (bool)$wgReadOnly;
1286 if ( $wgReadOnlyFile == '' ) {
1289 // Set $wgReadOnly for faster access next time
1290 if ( is_file( $wgReadOnlyFile ) ) {
1291 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1293 $wgReadOnly = false;
1295 return (bool)$wgReadOnly;
1301 function wfReadOnlyReason() {
1308 * Return a Language object from $langcode
1310 * @param $langcode Mixed: either:
1311 * - a Language object
1312 * - code of the language to get the message for, if it is
1313 * a valid code create a language for that language, if
1314 * it is a string but not a valid code then make a basic
1316 * - a boolean: if it's false then use the global object for
1317 * the current user's language (as a fallback for the old parameter
1318 * functionality), or if it is true then use global object
1319 * for the wiki's content language.
1320 * @return Language object
1322 function wfGetLangObj( $langcode = false ) {
1323 # Identify which language to get or create a language object for.
1324 # Using is_object here due to Stub objects.
1325 if( is_object( $langcode ) ) {
1326 # Great, we already have the object (hopefully)!
1330 global $wgContLang, $wgLanguageCode;
1331 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
1332 # $langcode is the language code of the wikis content language object.
1333 # or it is a boolean and value is true
1338 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1339 # $langcode is the language code of user language object.
1340 # or it was a boolean and value is false
1344 $validCodes = array_keys( Language
::fetchLanguageNames() );
1345 if( in_array( $langcode, $validCodes ) ) {
1346 # $langcode corresponds to a valid language.
1347 return Language
::factory( $langcode );
1350 # $langcode is a string, but not a valid language code; use content language.
1351 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1356 * Old function when $wgBetterDirectionality existed
1357 * All usage removed, wfUILang can be removed in near future
1359 * @deprecated since 1.18
1362 function wfUILang() {
1363 wfDeprecated( __METHOD__
, '1.18' );
1369 * This is the new function for getting translated interface messages.
1370 * See the Message class for documentation how to use them.
1371 * The intention is that this function replaces all old wfMsg* functions.
1372 * @param $key \string Message key.
1373 * Varargs: normal message parameters.
1377 function wfMessage( $key /*...*/) {
1378 $params = func_get_args();
1379 array_shift( $params );
1380 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1381 $params = $params[0];
1383 return new Message( $key, $params );
1387 * This function accepts multiple message keys and returns a message instance
1388 * for the first message which is non-empty. If all messages are empty then an
1389 * instance of the first message key is returned.
1390 * @param varargs: message keys
1394 function wfMessageFallback( /*...*/ ) {
1395 $args = func_get_args();
1396 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
1400 * Get a message from anywhere, for the current user language.
1402 * Use wfMsgForContent() instead if the message should NOT
1403 * change depending on the user preferences.
1405 * @deprecated since 1.18
1407 * @param $key String: lookup key for the message, usually
1408 * defined in languages/Language.php
1410 * Parameters to the message, which can be used to insert variable text into
1411 * it, can be passed to this function in the following formats:
1412 * - One per argument, starting at the second parameter
1413 * - As an array in the second parameter
1414 * These are not shown in the function definition.
1418 function wfMsg( $key ) {
1419 $args = func_get_args();
1420 array_shift( $args );
1421 return wfMsgReal( $key, $args );
1425 * Same as above except doesn't transform the message
1427 * @deprecated since 1.18
1429 * @param $key String
1432 function wfMsgNoTrans( $key ) {
1433 $args = func_get_args();
1434 array_shift( $args );
1435 return wfMsgReal( $key, $args, true, false, false );
1439 * Get a message from anywhere, for the current global language
1440 * set with $wgLanguageCode.
1442 * Use this if the message should NOT change dependent on the
1443 * language set in the user's preferences. This is the case for
1444 * most text written into logs, as well as link targets (such as
1445 * the name of the copyright policy page). Link titles, on the
1446 * other hand, should be shown in the UI language.
1448 * Note that MediaWiki allows users to change the user interface
1449 * language in their preferences, but a single installation
1450 * typically only contains content in one language.
1452 * Be wary of this distinction: If you use wfMsg() where you should
1453 * use wfMsgForContent(), a user of the software may have to
1454 * customize potentially hundreds of messages in
1455 * order to, e.g., fix a link in every possible language.
1457 * @deprecated since 1.18
1459 * @param $key String: lookup key for the message, usually
1460 * defined in languages/Language.php
1463 function wfMsgForContent( $key ) {
1464 global $wgForceUIMsgAsContentMsg;
1465 $args = func_get_args();
1466 array_shift( $args );
1468 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1469 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1471 $forcontent = false;
1473 return wfMsgReal( $key, $args, true, $forcontent );
1477 * Same as above except doesn't transform the message
1479 * @deprecated since 1.18
1481 * @param $key String
1484 function wfMsgForContentNoTrans( $key ) {
1485 global $wgForceUIMsgAsContentMsg;
1486 $args = func_get_args();
1487 array_shift( $args );
1489 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1490 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1492 $forcontent = false;
1494 return wfMsgReal( $key, $args, true, $forcontent, false );
1498 * Really get a message
1500 * @deprecated since 1.18
1502 * @param $key String: key to get.
1504 * @param $useDB Boolean
1505 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1506 * @param $transform Boolean: Whether or not to transform the message.
1507 * @return String: the requested message.
1509 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1510 wfProfileIn( __METHOD__
);
1511 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1512 $message = wfMsgReplaceArgs( $message, $args );
1513 wfProfileOut( __METHOD__
);
1518 * Fetch a message string value, but don't replace any keys yet.
1520 * @deprecated since 1.18
1522 * @param $key String
1523 * @param $useDB Bool
1524 * @param $langCode String: Code of the language to get the message for, or
1525 * behaves as a content language switch if it is a boolean.
1526 * @param $transform Boolean: whether to parse magic words, etc.
1529 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1530 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1532 $cache = MessageCache
::singleton();
1533 $message = $cache->get( $key, $useDB, $langCode );
1534 if( $message === false ) {
1535 $message = '<' . htmlspecialchars( $key ) . '>';
1536 } elseif ( $transform ) {
1537 $message = $cache->transform( $message );
1543 * Replace message parameter keys on the given formatted output.
1545 * @deprecated since 1.18
1547 * @param $message String
1548 * @param $args Array
1552 function wfMsgReplaceArgs( $message, $args ) {
1553 # Fix windows line-endings
1554 # Some messages are split with explode("\n", $msg)
1555 $message = str_replace( "\r", '', $message );
1557 // Replace arguments
1558 if ( count( $args ) ) {
1559 if ( is_array( $args[0] ) ) {
1560 $args = array_values( $args[0] );
1562 $replacementKeys = array();
1563 foreach( $args as $n => $param ) {
1564 $replacementKeys['$' . ( $n +
1 )] = $param;
1566 $message = strtr( $message, $replacementKeys );
1573 * Return an HTML-escaped version of a message.
1574 * Parameter replacements, if any, are done *after* the HTML-escaping,
1575 * so parameters may contain HTML (eg links or form controls). Be sure
1576 * to pre-escape them if you really do want plaintext, or just wrap
1577 * the whole thing in htmlspecialchars().
1579 * @deprecated since 1.18
1581 * @param $key String
1582 * @param string ... parameters
1585 function wfMsgHtml( $key ) {
1586 $args = func_get_args();
1587 array_shift( $args );
1588 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1592 * Return an HTML version of message
1593 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1594 * so parameters may contain HTML (eg links or form controls). Be sure
1595 * to pre-escape them if you really do want plaintext, or just wrap
1596 * the whole thing in htmlspecialchars().
1598 * @deprecated since 1.18
1600 * @param $key String
1601 * @param string ... parameters
1604 function wfMsgWikiHtml( $key ) {
1605 $args = func_get_args();
1606 array_shift( $args );
1607 return wfMsgReplaceArgs(
1608 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1609 /* can't be set to false */ true, /* interface */ true )->getText(),
1614 * Returns message in the requested format
1616 * @deprecated since 1.18
1618 * @param $key String: key of the message
1619 * @param $options Array: processing rules. Can take the following options:
1620 * <i>parse</i>: parses wikitext to HTML
1621 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1622 * p's added by parser or tidy
1623 * <i>escape</i>: filters message through htmlspecialchars
1624 * <i>escapenoentities</i>: same, but allows entity references like   through
1625 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1626 * <i>parsemag</i>: transform the message using magic phrases
1627 * <i>content</i>: fetch message for content language instead of interface
1628 * Also can accept a single associative argument, of the form 'language' => 'xx':
1629 * <i>language</i>: Language object or language code to fetch message for
1630 * (overriden by <i>content</i>).
1631 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1635 function wfMsgExt( $key, $options ) {
1636 $args = func_get_args();
1637 array_shift( $args );
1638 array_shift( $args );
1639 $options = (array)$options;
1641 foreach( $options as $arrayKey => $option ) {
1642 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1643 # An unknown index, neither numeric nor "language"
1644 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1645 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1646 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1647 'replaceafter', 'parsemag', 'content' ) ) ) {
1648 # A numeric index with unknown value
1649 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1653 if( in_array( 'content', $options, true ) ) {
1656 $langCodeObj = null;
1657 } elseif( array_key_exists( 'language', $options ) ) {
1658 $forContent = false;
1659 $langCode = wfGetLangObj( $options['language'] );
1660 $langCodeObj = $langCode;
1662 $forContent = false;
1664 $langCodeObj = null;
1667 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1669 if( !in_array( 'replaceafter', $options, true ) ) {
1670 $string = wfMsgReplaceArgs( $string, $args );
1673 $messageCache = MessageCache
::singleton();
1674 $parseInline = in_array( 'parseinline', $options, true );
1675 if( in_array( 'parse', $options, true ) ||
$parseInline ) {
1676 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1677 if ( $string instanceof ParserOutput
) {
1678 $string = $string->getText();
1681 if ( $parseInline ) {
1683 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1687 } elseif ( in_array( 'parsemag', $options, true ) ) {
1688 $string = $messageCache->transform( $string,
1689 !$forContent, $langCodeObj );
1692 if ( in_array( 'escape', $options, true ) ) {
1693 $string = htmlspecialchars ( $string );
1694 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1695 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1698 if( in_array( 'replaceafter', $options, true ) ) {
1699 $string = wfMsgReplaceArgs( $string, $args );
1706 * Since wfMsg() and co suck, they don't return false if the message key they
1707 * looked up didn't exist but a XHTML string, this function checks for the
1708 * nonexistance of messages by checking the MessageCache::get() result directly.
1710 * @deprecated since 1.18. Use Message::isDisabled().
1712 * @param $key String: the message key looked up
1713 * @return Boolean True if the message *doesn't* exist.
1715 function wfEmptyMsg( $key ) {
1716 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1720 * Throw a debugging exception. This function previously once exited the process,
1721 * but now throws an exception instead, with similar results.
1723 * @param $msg String: message shown when dying.
1725 function wfDebugDieBacktrace( $msg = '' ) {
1726 throw new MWException( $msg );
1730 * Fetch server name for use in error reporting etc.
1731 * Use real server name if available, so we know which machine
1732 * in a server farm generated the current page.
1736 function wfHostname() {
1738 if ( is_null( $host ) ) {
1740 # Hostname overriding
1741 global $wgOverrideHostname;
1742 if( $wgOverrideHostname !== false ) {
1743 # Set static and skip any detection
1744 $host = $wgOverrideHostname;
1748 if ( function_exists( 'posix_uname' ) ) {
1749 // This function not present on Windows
1750 $uname = posix_uname();
1754 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1755 $host = $uname['nodename'];
1756 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1757 # Windows computer name
1758 $host = getenv( 'COMPUTERNAME' );
1760 # This may be a virtual server.
1761 $host = $_SERVER['SERVER_NAME'];
1768 * Returns a HTML comment with the elapsed time since request.
1769 * This method has no side effects.
1773 function wfReportTime() {
1774 global $wgRequestTime, $wgShowHostnames;
1776 $elapsed = microtime( true ) - $wgRequestTime;
1778 return $wgShowHostnames
1779 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1780 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1784 * Safety wrapper for debug_backtrace().
1786 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1787 * murky circumstances, which may be triggered in part by stub objects
1788 * or other fancy talkin'.
1790 * Will return an empty array if Zend Optimizer is detected or if
1791 * debug_backtrace is disabled, otherwise the output from
1792 * debug_backtrace() (trimmed).
1794 * @param $limit int This parameter can be used to limit the number of stack frames returned
1796 * @return array of backtrace information
1798 function wfDebugBacktrace( $limit = 0 ) {
1799 static $disabled = null;
1801 if( extension_loaded( 'Zend Optimizer' ) ) {
1802 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1806 if ( is_null( $disabled ) ) {
1808 $functions = explode( ',', ini_get( 'disable_functions' ) );
1809 $functions = array_map( 'trim', $functions );
1810 $functions = array_map( 'strtolower', $functions );
1811 if ( in_array( 'debug_backtrace', $functions ) ) {
1812 wfDebug( "debug_backtrace is in disabled_functions\n" );
1820 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1821 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1823 return array_slice( debug_backtrace(), 1 );
1828 * Get a debug backtrace as a string
1832 function wfBacktrace() {
1833 global $wgCommandLineMode;
1835 if ( $wgCommandLineMode ) {
1840 $backtrace = wfDebugBacktrace();
1841 foreach( $backtrace as $call ) {
1842 if( isset( $call['file'] ) ) {
1843 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1844 $file = $f[count( $f ) - 1];
1848 if( isset( $call['line'] ) ) {
1849 $line = $call['line'];
1853 if ( $wgCommandLineMode ) {
1854 $msg .= "$file line $line calls ";
1856 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1858 if( !empty( $call['class'] ) ) {
1859 $msg .= $call['class'] . $call['type'];
1861 $msg .= $call['function'] . '()';
1863 if ( $wgCommandLineMode ) {
1869 if ( $wgCommandLineMode ) {
1879 * Get the name of the function which called this function
1880 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1881 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1882 * wfGetCaller( 3 ) is the parent of that.
1887 function wfGetCaller( $level = 2 ) {
1888 $backtrace = wfDebugBacktrace( $level +
1 );
1889 if ( isset( $backtrace[$level] ) ) {
1890 return wfFormatStackFrame( $backtrace[$level] );
1897 * Return a string consisting of callers in the stack. Useful sometimes
1898 * for profiling specific points.
1900 * @param $limit int The maximum depth of the stack frame to return, or false for
1904 function wfGetAllCallers( $limit = 3 ) {
1905 $trace = array_reverse( wfDebugBacktrace() );
1906 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1907 $limit = count( $trace ) - 1;
1909 $trace = array_slice( $trace, -$limit - 1, $limit );
1910 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1914 * Return a string representation of frame
1916 * @param $frame Array
1919 function wfFormatStackFrame( $frame ) {
1920 return isset( $frame['class'] ) ?
1921 $frame['class'] . '::' . $frame['function'] :
1926 /* Some generic result counters, pulled out of SearchEngine */
1932 * @param $offset Int
1936 function wfShowingResults( $offset, $limit ) {
1937 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1941 * Generate (prev x| next x) (20|50|100...) type links for paging
1943 * @param $offset String
1944 * @param $limit Integer
1945 * @param $link String
1946 * @param $query String: optional URL query parameter string
1947 * @param $atend Bool: optional param for specified if this is the last page
1949 * @deprecated in 1.19; use Language::viewPrevNext() instead
1951 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1952 wfDeprecated( __METHOD__
, '1.19' );
1956 $query = wfCgiToArray( $query );
1958 if( is_object( $link ) ) {
1961 $title = Title
::newFromText( $link );
1962 if( is_null( $title ) ) {
1967 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
1971 * Make a list item, used by various special pages
1973 * @param $page String Page link
1974 * @param $details String Text between brackets
1975 * @param $oppositedm Boolean Add the direction mark opposite to your
1976 * language, to display text properly
1978 * @deprecated since 1.19; use Language::specialList() instead
1980 function wfSpecialList( $page, $details, $oppositedm = true ) {
1981 wfDeprecated( __METHOD__
, '1.19' );
1984 return $wgLang->specialList( $page, $details, $oppositedm );
1989 * @todo FIXME: We may want to blacklist some broken browsers
1991 * @param $force Bool
1992 * @return bool Whereas client accept gzip compression
1994 function wfClientAcceptsGzip( $force = false ) {
1995 static $result = null;
1996 if ( $result === null ||
$force ) {
1998 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1999 # @todo FIXME: We may want to blacklist some broken browsers
2002 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2003 $_SERVER['HTTP_ACCEPT_ENCODING'],
2007 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2011 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2020 * Obtain the offset and limit values from the request string;
2021 * used in special pages
2023 * @param $deflimit Int default limit if none supplied
2024 * @param $optionname String Name of a user preference to check against
2028 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2030 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2034 * Escapes the given text so that it may be output using addWikiText()
2035 * without any linking, formatting, etc. making its way through. This
2036 * is achieved by substituting certain characters with HTML entities.
2037 * As required by the callers, "<nowiki>" is not used.
2039 * @param $text String: text to be escaped
2042 function wfEscapeWikiText( $text ) {
2043 $text = strtr( "\n$text", array(
2044 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2045 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2046 '{' => '{', '|' => '|', '}' => '}',
2047 "\n#" => "\n#", "\n*" => "\n*",
2048 "\n:" => "\n:", "\n;" => "\n;",
2049 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
2051 return substr( $text, 1 );
2055 * Get the current unix timetstamp with microseconds. Useful for profiling
2059 return microtime( true );
2063 * Sets dest to source and returns the original value of dest
2064 * If source is NULL, it just returns the value, it doesn't set the variable
2065 * If force is true, it will set the value even if source is NULL
2067 * @param $dest Mixed
2068 * @param $source Mixed
2069 * @param $force Bool
2072 function wfSetVar( &$dest, $source, $force = false ) {
2074 if ( !is_null( $source ) ||
$force ) {
2081 * As for wfSetVar except setting a bit
2085 * @param $state Bool
2089 function wfSetBit( &$dest, $bit, $state = true ) {
2090 $temp = (bool)( $dest & $bit );
2091 if ( !is_null( $state ) ) {
2102 * A wrapper around the PHP function var_export().
2103 * Either print it or add it to the regular output ($wgOut).
2105 * @param $var mixed A PHP variable to dump.
2107 function wfVarDump( $var ) {
2109 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2110 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2113 $wgOut->addHTML( $s );
2118 * Provide a simple HTTP error.
2120 * @param $code Int|String
2121 * @param $label String
2122 * @param $desc String
2124 function wfHttpError( $code, $label, $desc ) {
2127 header( "HTTP/1.0 $code $label" );
2128 header( "Status: $code $label" );
2129 $wgOut->sendCacheControl();
2131 header( 'Content-type: text/html; charset=utf-8' );
2132 print "<!doctype html>" .
2133 '<html><head><title>' .
2134 htmlspecialchars( $label ) .
2135 '</title></head><body><h1>' .
2136 htmlspecialchars( $label ) .
2138 nl2br( htmlspecialchars( $desc ) ) .
2139 "</p></body></html>\n";
2143 * Clear away any user-level output buffers, discarding contents.
2145 * Suitable for 'starting afresh', for instance when streaming
2146 * relatively large amounts of data without buffering, or wanting to
2147 * output image files without ob_gzhandler's compression.
2149 * The optional $resetGzipEncoding parameter controls suppression of
2150 * the Content-Encoding header sent by ob_gzhandler; by default it
2151 * is left. See comments for wfClearOutputBuffers() for why it would
2154 * Note that some PHP configuration options may add output buffer
2155 * layers which cannot be removed; these are left in place.
2157 * @param $resetGzipEncoding Bool
2159 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2160 if( $resetGzipEncoding ) {
2161 // Suppress Content-Encoding and Content-Length
2162 // headers from 1.10+s wfOutputHandler
2163 global $wgDisableOutputCompression;
2164 $wgDisableOutputCompression = true;
2166 while( $status = ob_get_status() ) {
2167 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2168 // Probably from zlib.output_compression or other
2169 // PHP-internal setting which can't be removed.
2171 // Give up, and hope the result doesn't break
2175 if( !ob_end_clean() ) {
2176 // Could not remove output buffer handler; abort now
2177 // to avoid getting in some kind of infinite loop.
2180 if( $resetGzipEncoding ) {
2181 if( $status['name'] == 'ob_gzhandler' ) {
2182 // Reset the 'Content-Encoding' field set by this handler
2183 // so we can start fresh.
2184 header_remove( 'Content-Encoding' );
2192 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2194 * Clear away output buffers, but keep the Content-Encoding header
2195 * produced by ob_gzhandler, if any.
2197 * This should be used for HTTP 304 responses, where you need to
2198 * preserve the Content-Encoding header of the real result, but
2199 * also need to suppress the output of ob_gzhandler to keep to spec
2200 * and avoid breaking Firefox in rare cases where the headers and
2201 * body are broken over two packets.
2203 function wfClearOutputBuffers() {
2204 wfResetOutputBuffers( false );
2208 * Converts an Accept-* header into an array mapping string values to quality
2211 * @param $accept String
2212 * @param $def String default
2215 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2216 # No arg means accept anything (per HTTP spec)
2218 return array( $def => 1.0 );
2223 $parts = explode( ',', $accept );
2225 foreach( $parts as $part ) {
2226 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2227 $values = explode( ';', trim( $part ) );
2229 if ( count( $values ) == 1 ) {
2230 $prefs[$values[0]] = 1.0;
2231 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2232 $prefs[$values[0]] = floatval( $match[1] );
2240 * Checks if a given MIME type matches any of the keys in the given
2241 * array. Basic wildcards are accepted in the array keys.
2243 * Returns the matching MIME type (or wildcard) if a match, otherwise
2246 * @param $type String
2247 * @param $avail Array
2251 function mimeTypeMatch( $type, $avail ) {
2252 if( array_key_exists( $type, $avail ) ) {
2255 $parts = explode( '/', $type );
2256 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2257 return $parts[0] . '/*';
2258 } elseif( array_key_exists( '*/*', $avail ) ) {
2267 * Returns the 'best' match between a client's requested internet media types
2268 * and the server's list of available types. Each list should be an associative
2269 * array of type to preference (preference is a float between 0.0 and 1.0).
2270 * Wildcards in the types are acceptable.
2272 * @param $cprefs Array: client's acceptable type list
2273 * @param $sprefs Array: server's offered types
2276 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2277 * XXX: generalize to negotiate other stuff
2279 function wfNegotiateType( $cprefs, $sprefs ) {
2282 foreach( array_keys( $sprefs ) as $type ) {
2283 $parts = explode( '/', $type );
2284 if( $parts[1] != '*' ) {
2285 $ckey = mimeTypeMatch( $type, $cprefs );
2287 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2292 foreach( array_keys( $cprefs ) as $type ) {
2293 $parts = explode( '/', $type );
2294 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2295 $skey = mimeTypeMatch( $type, $sprefs );
2297 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2305 foreach( array_keys( $combine ) as $type ) {
2306 if( $combine[$type] > $bestq ) {
2308 $bestq = $combine[$type];
2316 * Reference-counted warning suppression
2320 function wfSuppressWarnings( $end = false ) {
2321 static $suppressCount = 0;
2322 static $originalLevel = false;
2325 if ( $suppressCount ) {
2327 if ( !$suppressCount ) {
2328 error_reporting( $originalLevel );
2332 if ( !$suppressCount ) {
2333 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED | E_USER_DEPRECATED
) );
2340 * Restore error level to previous value
2342 function wfRestoreWarnings() {
2343 wfSuppressWarnings( true );
2346 # Autodetect, convert and provide timestamps of various types
2349 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2351 define( 'TS_UNIX', 0 );
2354 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2356 define( 'TS_MW', 1 );
2359 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2361 define( 'TS_DB', 2 );
2364 * RFC 2822 format, for E-mail and HTTP headers
2366 define( 'TS_RFC2822', 3 );
2369 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2371 * This is used by Special:Export
2373 define( 'TS_ISO_8601', 4 );
2376 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2378 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2379 * DateTime tag and page 36 for the DateTimeOriginal and
2380 * DateTimeDigitized tags.
2382 define( 'TS_EXIF', 5 );
2385 * Oracle format time.
2387 define( 'TS_ORACLE', 6 );
2390 * Postgres format time.
2392 define( 'TS_POSTGRES', 7 );
2397 define( 'TS_DB2', 8 );
2400 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2402 define( 'TS_ISO_8601_BASIC', 9 );
2405 * Get a timestamp string in one of various formats
2407 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2408 * function will autodetect which format is supplied and act
2410 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
2411 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2413 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2414 $timestamp = new MWTimestamp( $ts );
2415 return $timestamp->getTimestamp( $outputtype );
2419 * Return a formatted timestamp, or null if input is null.
2420 * For dealing with nullable timestamp columns in the database.
2422 * @param $outputtype Integer
2426 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2427 if( is_null( $ts ) ) {
2430 return wfTimestamp( $outputtype, $ts );
2435 * Convenience function; returns MediaWiki timestamp for the present time.
2439 function wfTimestampNow() {
2441 return wfTimestamp( TS_MW
, time() );
2445 * Check if the operating system is Windows
2447 * @return Bool: true if it's Windows, False otherwise.
2449 function wfIsWindows() {
2450 static $isWindows = null;
2451 if ( $isWindows === null ) {
2452 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2458 * Check if we are running under HipHop
2462 function wfIsHipHop() {
2463 return function_exists( 'hphp_thread_set_warmup_enabled' );
2467 * Swap two variables
2472 function swap( &$x, &$y ) {
2479 * Tries to get the system directory for temporary files. First
2480 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2481 * environment variables are then checked in sequence, and if none are
2482 * set try sys_get_temp_dir().
2484 * NOTE: When possible, use instead the tmpfile() function to create
2485 * temporary files to avoid race conditions on file creation, etc.
2489 function wfTempDir() {
2490 global $wgTmpDirectory;
2492 if ( $wgTmpDirectory !== false ) {
2493 return $wgTmpDirectory;
2496 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2498 foreach( $tmpDir as $tmp ) {
2499 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2503 return sys_get_temp_dir();
2507 * Make directory, and make all parent directories if they don't exist
2509 * @param $dir String: full path to directory to create
2510 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2511 * @param $caller String: optional caller param for debugging.
2514 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2515 global $wgDirectoryMode;
2517 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2518 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2521 if ( !is_null( $caller ) ) {
2522 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2525 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2529 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2531 if ( is_null( $mode ) ) {
2532 $mode = $wgDirectoryMode;
2535 // Turn off the normal warning, we're doing our own below
2536 wfSuppressWarnings();
2537 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2538 wfRestoreWarnings();
2541 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2542 trigger_error( sprintf( "%s: failed to mkdir \"%s\" mode 0%o", __FUNCTION__
, $dir, $mode ),
2549 * Remove a directory and all its content.
2550 * Does not hide error.
2552 function wfRecursiveRemoveDir( $dir ) {
2553 wfDebug( __FUNCTION__
. "( $dir )\n" );
2554 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2555 if ( is_dir( $dir ) ) {
2556 $objects = scandir( $dir );
2557 foreach ( $objects as $object ) {
2558 if ( $object != "." && $object != ".." ) {
2559 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2560 wfRecursiveRemoveDir( $dir . '/' . $object );
2562 unlink( $dir . '/' . $object );
2572 * @param $nr Mixed: the number to format
2573 * @param $acc Integer: the number of digits after the decimal point, default 2
2574 * @param $round Boolean: whether or not to round the value, default true
2577 function wfPercent( $nr, $acc = 2, $round = true ) {
2578 $ret = sprintf( "%.${acc}f", $nr );
2579 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2583 * Find out whether or not a mixed variable exists in a string
2585 * @param $needle String
2586 * @param $str String
2587 * @param $insensitive Boolean
2590 function in_string( $needle, $str, $insensitive = false ) {
2592 if( $insensitive ) $func = 'stripos';
2594 return $func( $str, $needle ) !== false;
2598 * Safety wrapper around ini_get() for boolean settings.
2599 * The values returned from ini_get() are pre-normalized for settings
2600 * set via php.ini or php_flag/php_admin_flag... but *not*
2601 * for those set via php_value/php_admin_value.
2603 * It's fairly common for people to use php_value instead of php_flag,
2604 * which can leave you with an 'off' setting giving a false positive
2605 * for code that just takes the ini_get() return value as a boolean.
2607 * To make things extra interesting, setting via php_value accepts
2608 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2609 * Unrecognized values go false... again opposite PHP's own coercion
2610 * from string to bool.
2612 * Luckily, 'properly' set settings will always come back as '0' or '1',
2613 * so we only have to worry about them and the 'improper' settings.
2615 * I frickin' hate PHP... :P
2617 * @param $setting String
2620 function wfIniGetBool( $setting ) {
2621 $val = ini_get( $setting );
2622 // 'on' and 'true' can't have whitespace around them, but '1' can.
2623 return strtolower( $val ) == 'on'
2624 ||
strtolower( $val ) == 'true'
2625 ||
strtolower( $val ) == 'yes'
2626 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2630 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2631 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2633 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2635 * @param $fileName String Name of the library, if not $extension.suffix
2636 * @return Bool - Whether or not the extension is loaded
2638 function wfDl( $extension, $fileName = null ) {
2639 if( extension_loaded( $extension ) ) {
2644 $sapi = php_sapi_name();
2645 if( $sapi == 'cli' ||
$sapi == 'cgi' ||
$sapi == 'embed' ) {
2646 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2647 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2651 $fileName = $fileName ?
$fileName : $extension;
2652 if( wfIsWindows() ) {
2653 $fileName = 'php_' . $fileName;
2655 wfSuppressWarnings();
2656 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2657 wfRestoreWarnings();
2659 return extension_loaded( $extension );
2663 * Windows-compatible version of escapeshellarg()
2664 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2665 * function puts single quotes in regardless of OS.
2667 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2668 * earlier distro releases of PHP)
2673 function wfEscapeShellArg( ) {
2674 wfInitShellLocale();
2676 $args = func_get_args();
2679 foreach ( $args as $arg ) {
2686 if ( wfIsWindows() ) {
2687 // Escaping for an MSVC-style command line parser and CMD.EXE
2689 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2690 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2693 // Double the backslashes before any double quotes. Escape the double quotes.
2694 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2697 foreach ( $tokens as $token ) {
2698 if ( $iteration %
2 == 1 ) {
2699 // Delimiter, a double quote preceded by zero or more slashes
2700 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2701 } elseif ( $iteration %
4 == 2 ) {
2702 // ^ in $token will be outside quotes, need to be escaped
2703 $arg .= str_replace( '^', '^^', $token );
2704 } else { // $iteration % 4 == 0
2705 // ^ in $token will appear inside double quotes, so leave as is
2710 // Double the backslashes before the end of the string, because
2711 // we will soon add a quote
2713 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2714 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2717 // Add surrounding quotes
2718 $retVal .= '"' . $arg . '"';
2720 $retVal .= escapeshellarg( $arg );
2727 * Execute a shell command, with time and memory limits mirrored from the PHP
2728 * configuration if supported.
2729 * @param $cmd String Command line, properly escaped for shell.
2730 * @param &$retval null|Mixed optional, will receive the program's exit code.
2731 * (non-zero is usually failure)
2732 * @param $environ Array optional environment variables which should be
2733 * added to the executed command environment.
2734 * @param $limits Array optional array with limits(filesize, memory, time)
2735 * this overwrites the global wgShellMax* limits.
2736 * @return string collected stdout as a string (trailing newlines stripped)
2738 function wfShellExec( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2739 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
2742 if ( is_null( $disabled ) ) {
2744 if( wfIniGetBool( 'safe_mode' ) ) {
2745 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2746 $disabled = 'safemode';
2748 $functions = explode( ',', ini_get( 'disable_functions' ) );
2749 $functions = array_map( 'trim', $functions );
2750 $functions = array_map( 'strtolower', $functions );
2751 if ( in_array( 'passthru', $functions ) ) {
2752 wfDebug( "passthru is in disabled_functions\n" );
2753 $disabled = 'passthru';
2759 return $disabled == 'safemode' ?
2760 'Unable to run external programs in safe mode.' :
2761 'Unable to run external programs, passthru() is disabled.';
2764 wfInitShellLocale();
2767 foreach( $environ as $k => $v ) {
2768 if ( wfIsWindows() ) {
2769 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2770 * appear in the environment variable, so we must use carat escaping as documented in
2771 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2772 * Note however that the quote isn't listed there, but is needed, and the parentheses
2773 * are listed there but doesn't appear to need it.
2775 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2777 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2778 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2780 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2783 $cmd = $envcmd . $cmd;
2785 if ( php_uname( 's' ) == 'Linux' ) {
2786 $time = intval ( isset($limits['time']) ?
$limits['time'] : $wgMaxShellTime );
2787 $mem = intval ( isset($limits['memory']) ?
$limits['memory'] : $wgMaxShellMemory );
2788 $filesize = intval ( isset($limits['filesize']) ?
$limits['filesize'] : $wgMaxShellFileSize );
2790 if ( $time > 0 && $mem > 0 ) {
2791 $script = "$IP/bin/ulimit4.sh";
2792 if ( is_executable( $script ) ) {
2793 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2797 wfDebug( "wfShellExec: $cmd\n" );
2799 $retval = 1; // error by default?
2801 passthru( $cmd, $retval );
2802 $output = ob_get_contents();
2805 if ( $retval == 127 ) {
2806 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2812 * Workaround for http://bugs.php.net/bug.php?id=45132
2813 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2815 function wfInitShellLocale() {
2816 static $done = false;
2821 global $wgShellLocale;
2822 if ( !wfIniGetBool( 'safe_mode' ) ) {
2823 putenv( "LC_CTYPE=$wgShellLocale" );
2824 setlocale( LC_CTYPE
, $wgShellLocale );
2829 * Alias to wfShellWikiCmd()
2830 * @see wfShellWikiCmd()
2832 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2833 return wfShellWikiCmd( $script, $parameters, $options );
2837 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2838 * Note that $parameters should be a flat array and an option with an argument
2839 * should consist of two consecutive items in the array (do not use "--option value").
2840 * @param $script string MediaWiki cli script path
2841 * @param $parameters Array Arguments and options to the script
2842 * @param $options Array Associative array of options:
2843 * 'php': The path to the php executable
2844 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2847 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2849 // Give site config file a chance to run the script in a wrapper.
2850 // The caller may likely want to call wfBasename() on $script.
2851 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2852 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2853 if ( isset( $options['wrapper'] ) ) {
2854 $cmd[] = $options['wrapper'];
2857 // Escape each parameter for shell
2858 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2862 * wfMerge attempts to merge differences between three texts.
2863 * Returns true for a clean merge and false for failure or a conflict.
2865 * @param $old String
2866 * @param $mine String
2867 * @param $yours String
2868 * @param $result String
2871 function wfMerge( $old, $mine, $yours, &$result ) {
2874 # This check may also protect against code injection in
2875 # case of broken installations.
2876 wfSuppressWarnings();
2877 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2878 wfRestoreWarnings();
2881 wfDebug( "diff3 not found\n" );
2885 # Make temporary files
2887 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2888 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2889 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2891 fwrite( $oldtextFile, $old );
2892 fclose( $oldtextFile );
2893 fwrite( $mytextFile, $mine );
2894 fclose( $mytextFile );
2895 fwrite( $yourtextFile, $yours );
2896 fclose( $yourtextFile );
2898 # Check for a conflict
2899 $cmd = $wgDiff3 . ' -a --overlap-only ' .
2900 wfEscapeShellArg( $mytextName ) . ' ' .
2901 wfEscapeShellArg( $oldtextName ) . ' ' .
2902 wfEscapeShellArg( $yourtextName );
2903 $handle = popen( $cmd, 'r' );
2905 if( fgets( $handle, 1024 ) ) {
2913 $cmd = $wgDiff3 . ' -a -e --merge ' .
2914 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
2915 $handle = popen( $cmd, 'r' );
2918 $data = fread( $handle, 8192 );
2919 if ( strlen( $data ) == 0 ) {
2925 unlink( $mytextName );
2926 unlink( $oldtextName );
2927 unlink( $yourtextName );
2929 if ( $result === '' && $old !== '' && !$conflict ) {
2930 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2937 * Returns unified plain-text diff of two texts.
2938 * Useful for machine processing of diffs.
2940 * @param $before String: the text before the changes.
2941 * @param $after String: the text after the changes.
2942 * @param $params String: command-line options for the diff command.
2943 * @return String: unified diff of $before and $after
2945 function wfDiff( $before, $after, $params = '-u' ) {
2946 if ( $before == $after ) {
2951 wfSuppressWarnings();
2952 $haveDiff = $wgDiff && file_exists( $wgDiff );
2953 wfRestoreWarnings();
2955 # This check may also protect against code injection in
2956 # case of broken installations.
2958 wfDebug( "diff executable not found\n" );
2959 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2960 $format = new UnifiedDiffFormatter();
2961 return $format->format( $diffs );
2964 # Make temporary files
2966 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2967 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2969 fwrite( $oldtextFile, $before );
2970 fclose( $oldtextFile );
2971 fwrite( $newtextFile, $after );
2972 fclose( $newtextFile );
2974 // Get the diff of the two files
2975 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
2977 $h = popen( $cmd, 'r' );
2982 $data = fread( $h, 8192 );
2983 if ( strlen( $data ) == 0 ) {
2991 unlink( $oldtextName );
2992 unlink( $newtextName );
2994 // Kill the --- and +++ lines. They're not useful.
2995 $diff_lines = explode( "\n", $diff );
2996 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
2997 unset( $diff_lines[0] );
2999 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3000 unset( $diff_lines[1] );
3003 $diff = implode( "\n", $diff_lines );
3009 * This function works like "use VERSION" in Perl, the program will die with a
3010 * backtrace if the current version of PHP is less than the version provided
3012 * This is useful for extensions which due to their nature are not kept in sync
3013 * with releases, and might depend on other versions of PHP than the main code
3015 * Note: PHP might die due to parsing errors in some cases before it ever
3016 * manages to call this function, such is life
3018 * @see perldoc -f use
3020 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3023 function wfUsePHP( $req_ver ) {
3024 $php_ver = PHP_VERSION
;
3026 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3027 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3032 * This function works like "use VERSION" in Perl except it checks the version
3033 * of MediaWiki, the program will die with a backtrace if the current version
3034 * of MediaWiki is less than the version provided.
3036 * This is useful for extensions which due to their nature are not kept in sync
3039 * @see perldoc -f use
3041 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3044 function wfUseMW( $req_ver ) {
3047 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3048 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3053 * Return the final portion of a pathname.
3054 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3055 * http://bugs.php.net/bug.php?id=33898
3057 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3058 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3060 * @param $path String
3061 * @param $suffix String: to remove if present
3064 function wfBaseName( $path, $suffix = '' ) {
3065 $encSuffix = ( $suffix == '' )
3067 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
3069 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3077 * Generate a relative path name to the given file.
3078 * May explode on non-matching case-insensitive paths,
3079 * funky symlinks, etc.
3081 * @param $path String: absolute destination path including target filename
3082 * @param $from String: Absolute source path, directory only
3085 function wfRelativePath( $path, $from ) {
3086 // Normalize mixed input on Windows...
3087 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3088 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3090 // Trim trailing slashes -- fix for drive root
3091 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3092 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3094 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3095 $against = explode( DIRECTORY_SEPARATOR
, $from );
3097 if( $pieces[0] !== $against[0] ) {
3098 // Non-matching Windows drive letters?
3099 // Return a full path.
3103 // Trim off common prefix
3104 while( count( $pieces ) && count( $against )
3105 && $pieces[0] == $against[0] ) {
3106 array_shift( $pieces );
3107 array_shift( $against );
3110 // relative dots to bump us to the parent
3111 while( count( $against ) ) {
3112 array_unshift( $pieces, '..' );
3113 array_shift( $against );
3116 array_push( $pieces, wfBaseName( $path ) );
3118 return implode( DIRECTORY_SEPARATOR
, $pieces );
3122 * Do any deferred updates and clear the list
3124 * @deprecated since 1.19
3125 * @see DeferredUpdates::doUpdate()
3126 * @param $commit string
3128 function wfDoUpdates( $commit = '' ) {
3129 wfDeprecated( __METHOD__
, '1.19' );
3130 DeferredUpdates
::doUpdates( $commit );
3134 * Convert an arbitrarily-long digit string from one numeric base
3135 * to another, optionally zero-padding to a minimum column width.
3137 * Supports base 2 through 36; digit values 10-36 are represented
3138 * as lowercase letters a-z. Input is case-insensitive.
3140 * @param $input String: of digits
3141 * @param $sourceBase Integer: 2-36
3142 * @param $destBase Integer: 2-36
3143 * @param $pad Integer: 1 or greater
3144 * @param $lowercase Boolean
3145 * @return String or false on invalid input
3147 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
3148 $input = strval( $input );
3149 if( $sourceBase < 2 ||
3154 $sourceBase != intval( $sourceBase ) ||
3155 $destBase != intval( $destBase ) ||
3156 $pad != intval( $pad ) ||
3157 !is_string( $input ) ||
3161 $digitChars = ( $lowercase ) ?
'0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3162 $inDigits = array();
3165 // Decode and validate input string
3166 $input = strtolower( $input );
3167 for( $i = 0; $i < strlen( $input ); $i++
) {
3168 $n = strpos( $digitChars, $input[$i] );
3169 if( $n === false ||
$n > $sourceBase ) {
3175 // Iterate over the input, modulo-ing out an output digit
3176 // at a time until input is gone.
3177 while( count( $inDigits ) ) {
3179 $workDigits = array();
3182 foreach( $inDigits as $digit ) {
3183 $work *= $sourceBase;
3186 if( $work < $destBase ) {
3187 // Gonna need to pull another digit.
3188 if( count( $workDigits ) ) {
3189 // Avoid zero-padding; this lets us find
3190 // the end of the input very easily when
3191 // length drops to zero.
3195 // Finally! Actual division!
3196 $workDigits[] = intval( $work / $destBase );
3198 // Isn't it annoying that most programming languages
3199 // don't have a single divide-and-remainder operator,
3200 // even though the CPU implements it that way?
3201 $work = $work %
$destBase;
3205 // All that division leaves us with a remainder,
3206 // which is conveniently our next output digit.
3207 $outChars .= $digitChars[$work];
3210 $inDigits = $workDigits;
3213 while( strlen( $outChars ) < $pad ) {
3217 return strrev( $outChars );
3221 * Create an object with a given name and an array of construct parameters
3223 * @param $name String
3224 * @param $p Array: parameters
3226 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3228 function wfCreateObject( $name, $p ) {
3229 wfDeprecated( __FUNCTION__
, '1.18' );
3230 return MWFunction
::newObj( $name, $p );
3236 function wfHttpOnlySafe() {
3237 global $wgHttpOnlyBlacklist;
3239 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3240 foreach( $wgHttpOnlyBlacklist as $regex ) {
3241 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3251 * Override session_id before session startup if php's built-in
3252 * session generation code is not secure.
3254 function wfFixSessionID() {
3255 // If the cookie or session id is already set we already have a session and should abort
3256 if ( isset( $_COOKIE[ session_name() ] ) ||
session_id() ) {
3260 // PHP's built-in session entropy is enabled if:
3261 // - entropy_file is set or you're on Windows with php 5.3.3+
3262 // - AND entropy_length is > 0
3263 // We treat it as disabled if it doesn't have an entropy length of at least 32
3265 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3266 ||
ini_get( 'session.entropy_file' )
3268 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3270 // If built-in entropy is not enabled or not sufficient override php's built in session id generation code
3271 if ( !$entropyEnabled ) {
3272 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, overriding session id generation using our cryptrand source.\n" );
3273 session_id( MWCryptRand
::generateHex( 32 ) );
3278 * Initialise php session
3280 * @param $sessionId Bool
3282 function wfSetupSession( $sessionId = false ) {
3283 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3284 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3285 if( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3286 ObjectCacheSessionHandler
::install();
3287 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3288 # Only set this if $wgSessionHandler isn't null and session.save_handler
3289 # hasn't already been set to the desired value (that causes errors)
3290 ini_set( 'session.save_handler', $wgSessionHandler );
3292 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3293 wfDebugLog( 'cookie',
3294 'session_set_cookie_params: "' . implode( '", "',
3300 $httpOnlySafe ) ) . '"' );
3301 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3302 session_cache_limiter( 'private, must-revalidate' );
3304 session_id( $sessionId );
3308 wfSuppressWarnings();
3310 wfRestoreWarnings();
3314 * Get an object from the precompiled serialized directory
3316 * @param $name String
3317 * @return Mixed: the variable on success, false on failure
3319 function wfGetPrecompiledData( $name ) {
3322 $file = "$IP/serialized/$name";
3323 if ( file_exists( $file ) ) {
3324 $blob = file_get_contents( $file );
3326 return unserialize( $blob );
3338 function wfMemcKey( /*... */ ) {
3339 global $wgCachePrefix;
3340 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3341 $args = func_get_args();
3342 $key = $prefix . ':' . implode( ':', $args );
3343 $key = str_replace( ' ', '_', $key );
3348 * Get a cache key for a foreign DB
3351 * @param $prefix String
3352 * @param varargs String
3355 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3356 $args = array_slice( func_get_args(), 2 );
3358 $key = "$db-$prefix:" . implode( ':', $args );
3360 $key = $db . ':' . implode( ':', $args );
3366 * Get an ASCII string identifying this wiki
3367 * This is used as a prefix in memcached keys
3371 function wfWikiID() {
3372 global $wgDBprefix, $wgDBname;
3373 if ( $wgDBprefix ) {
3374 return "$wgDBname-$wgDBprefix";
3381 * Split a wiki ID into DB name and table prefix
3383 * @param $wiki String
3387 function wfSplitWikiID( $wiki ) {
3388 $bits = explode( '-', $wiki, 2 );
3389 if ( count( $bits ) < 2 ) {
3396 * Get a Database object.
3398 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3399 * master (for write queries), DB_SLAVE for potentially lagged read
3400 * queries, or an integer >= 0 for a particular server.
3402 * @param $groups Mixed: query groups. An array of group names that this query
3403 * belongs to. May contain a single string if the query is only
3406 * @param $wiki String: the wiki ID, or false for the current wiki
3408 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3409 * will always return the same object, unless the underlying connection or load
3410 * balancer is manually destroyed.
3412 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3413 * updater to ensure that a proper database is being updated.
3415 * @return DatabaseBase
3417 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3418 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3422 * Get a load balancer object.
3424 * @param $wiki String: wiki ID, or false for the current wiki
3425 * @return LoadBalancer
3427 function wfGetLB( $wiki = false ) {
3428 return wfGetLBFactory()->getMainLB( $wiki );
3432 * Get the load balancer factory object
3436 function &wfGetLBFactory() {
3437 return LBFactory
::singleton();
3442 * Shortcut for RepoGroup::singleton()->findFile()
3444 * @param $title String or Title object
3445 * @param $options array Associative array of options:
3446 * time: requested time for an archived image, or false for the
3447 * current version. An image object will be returned which was
3448 * created at the specified time.
3450 * ignoreRedirect: If true, do not follow file redirects
3452 * private: If true, return restricted (deleted) files if the current
3453 * user is allowed to view them. Otherwise, such files will not
3456 * bypassCache: If true, do not use the process-local cache of File objects
3458 * @return File, or false if the file does not exist
3460 function wfFindFile( $title, $options = array() ) {
3461 return RepoGroup
::singleton()->findFile( $title, $options );
3465 * Get an object referring to a locally registered file.
3466 * Returns a valid placeholder object if the file does not exist.
3468 * @param $title Title|String
3469 * @return LocalFile|null A File, or null if passed an invalid Title
3471 function wfLocalFile( $title ) {
3472 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3476 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3477 * @deprecated since 1.19
3479 function wfStreamFile( $fname, $headers = array() ) {
3480 wfDeprecated( __FUNCTION__
, '1.19' );
3481 StreamFile
::stream( $fname, $headers );
3485 * Should low-performance queries be disabled?
3488 * @codeCoverageIgnore
3490 function wfQueriesMustScale() {
3491 global $wgMiserMode;
3493 ||
( SiteStats
::pages() > 100000
3494 && SiteStats
::edits() > 1000000
3495 && SiteStats
::users() > 10000 );
3499 * Get the path to a specified script file, respecting file
3500 * extensions; this is a wrapper around $wgScriptExtension etc.
3501 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3503 * @param $script String: script filename, sans extension
3506 function wfScript( $script = 'index' ) {
3507 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3508 if ( $script === 'index' ) {
3510 } else if ( $script === 'load' ) {
3511 return $wgLoadScript;
3513 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3518 * Get the script URL.
3520 * @return string script URL
3522 function wfGetScriptUrl() {
3523 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3525 # as it was called, minus the query string.
3527 # Some sites use Apache rewrite rules to handle subdomains,
3528 # and have PHP set up in a weird way that causes PHP_SELF
3529 # to contain the rewritten URL instead of the one that the
3530 # outside world sees.
3532 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3533 # provides containing the "before" URL.
3534 return $_SERVER['SCRIPT_NAME'];
3536 return $_SERVER['URL'];
3541 * Convenience function converts boolean values into "true"
3542 * or "false" (string) values
3544 * @param $value Boolean
3547 function wfBoolToStr( $value ) {
3548 return $value ?
'true' : 'false';
3552 * Load an extension messages file
3554 * @deprecated since 1.16, warnings in 1.18, remove in 1.20
3555 * @codeCoverageIgnore
3557 function wfLoadExtensionMessages() {
3558 wfDeprecated( __FUNCTION__
, '1.16' );
3562 * Get a platform-independent path to the null file, e.g. /dev/null
3566 function wfGetNull() {
3567 return wfIsWindows()
3573 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3574 * and waiting for it to go down, this waits for the slaves to catch up to the
3575 * master position. Use this when updating very large numbers of rows, as
3576 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3577 * a no-op if there are no slaves.
3579 * @param $maxLag Integer (deprecated)
3580 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3582 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3583 $lb = wfGetLB( $wiki );
3584 // bug 27975 - Don't try to wait for slaves if there are none
3585 // Prevents permission error when getting master position
3586 if ( $lb->getServerCount() > 1 ) {
3587 $dbw = $lb->getConnection( DB_MASTER
);
3588 $pos = $dbw->getMasterPos();
3589 $lb->waitForAll( $pos );
3594 * Used to be used for outputting text in the installer/updater
3595 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3597 function wfOut( $s ) {
3598 wfDeprecated( __FUNCTION__
, '1.18' );
3599 global $wgCommandLineMode;
3600 if ( $wgCommandLineMode ) {
3603 echo htmlspecialchars( $s );
3609 * Count down from $n to zero on the terminal, with a one-second pause
3610 * between showing each number. For use in command-line scripts.
3611 * @codeCoverageIgnore
3614 function wfCountDown( $n ) {
3615 for ( $i = $n; $i >= 0; $i-- ) {
3617 echo str_repeat( "\x08", strlen( $i +
1 ) );
3629 * Generate a random 32-character hexadecimal token.
3630 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3631 * characters before hashing.
3633 * @codeCoverageIgnore
3634 * @deprecated since 1.20; Please use MWCryptRand for security purposes and wfRandomString for pesudo-random strings
3635 * @warning This method is NOT secure. Additionally it has many callers that use it for pesudo-random purposes.
3637 function wfGenerateToken( $salt = '' ) {
3638 wfDeprecated( __METHOD__
, '1.20' );
3639 $salt = serialize( $salt );
3640 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3644 * Replace all invalid characters with -
3645 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3646 * By default, $wgIllegalFileChars = ':'
3648 * @param $name Mixed: filename to process
3651 function wfStripIllegalFilenameChars( $name ) {
3652 global $wgIllegalFileChars;
3653 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3654 $name = wfBaseName( $name );
3655 $name = preg_replace(
3656 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3664 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3666 * @return Integer value memory was set to.
3668 function wfMemoryLimit() {
3669 global $wgMemoryLimit;
3670 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3671 if( $memlimit != -1 ) {
3672 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3673 if( $conflimit == -1 ) {
3674 wfDebug( "Removing PHP's memory limit\n" );
3675 wfSuppressWarnings();
3676 ini_set( 'memory_limit', $conflimit );
3677 wfRestoreWarnings();
3679 } elseif ( $conflimit > $memlimit ) {
3680 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3681 wfSuppressWarnings();
3682 ini_set( 'memory_limit', $conflimit );
3683 wfRestoreWarnings();
3691 * Converts shorthand byte notation to integer form
3693 * @param $string String
3696 function wfShorthandToInteger( $string = '' ) {
3697 $string = trim( $string );
3698 if( $string === '' ) {
3701 $last = $string[strlen( $string ) - 1];
3702 $val = intval( $string );
3707 // break intentionally missing
3711 // break intentionally missing
3721 * Get the normalised IETF language tag
3722 * See unit test for examples.
3724 * @param $code String: The language code.
3725 * @return String: The language code which complying with BCP 47 standards.
3727 function wfBCP47( $code ) {
3728 $codeSegment = explode( '-', $code );
3730 foreach ( $codeSegment as $segNo => $seg ) {
3731 if ( count( $codeSegment ) > 0 ) {
3732 // when previous segment is x, it is a private segment and should be lc
3733 if( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3734 $codeBCP[$segNo] = strtolower( $seg );
3735 // ISO 3166 country code
3736 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3737 $codeBCP[$segNo] = strtoupper( $seg );
3738 // ISO 15924 script code
3739 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3740 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3741 // Use lowercase for other cases
3743 $codeBCP[$segNo] = strtolower( $seg );
3746 // Use lowercase for single segment
3747 $codeBCP[$segNo] = strtolower( $seg );
3750 $langCode = implode( '-', $codeBCP );
3755 * Get a cache object.
3757 * @param $inputType integer Cache type, one the the CACHE_* constants.
3760 function wfGetCache( $inputType ) {
3761 return ObjectCache
::getInstance( $inputType );
3765 * Get the main cache object
3769 function wfGetMainCache() {
3770 global $wgMainCacheType;
3771 return ObjectCache
::getInstance( $wgMainCacheType );
3775 * Get the cache object used by the message cache
3779 function wfGetMessageCacheStorage() {
3780 global $wgMessageCacheType;
3781 return ObjectCache
::getInstance( $wgMessageCacheType );
3785 * Get the cache object used by the parser cache
3789 function wfGetParserCacheStorage() {
3790 global $wgParserCacheType;
3791 return ObjectCache
::getInstance( $wgParserCacheType );
3795 * Get the cache object used by the language converter
3799 function wfGetLangConverterCacheStorage() {
3800 global $wgLanguageConverterCacheType;
3801 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3805 * Call hook functions defined in $wgHooks
3807 * @param $event String: event name
3808 * @param $args Array: parameters passed to hook functions
3809 * @return Boolean True if no handler aborted the hook
3811 function wfRunHooks( $event, $args = array() ) {
3812 return Hooks
::run( $event, $args );
3816 * Wrapper around php's unpack.
3818 * @param $format String: The format string (See php's docs)
3819 * @param $data: A binary string of binary data
3820 * @param $length integer or false: The minimun length of $data. This is to
3821 * prevent reading beyond the end of $data. false to disable the check.
3823 * Also be careful when using this function to read unsigned 32 bit integer
3824 * because php might make it negative.
3826 * @throws MWException if $data not long enough, or if unpack fails
3827 * @return array Associative array of the extracted data
3829 function wfUnpack( $format, $data, $length=false ) {
3830 if ( $length !== false ) {
3831 $realLen = strlen( $data );
3832 if ( $realLen < $length ) {
3833 throw new MWException( "Tried to use wfUnpack on a "
3834 . "string of length $realLen, but needed one "
3835 . "of at least length $length."
3840 wfSuppressWarnings();
3841 $result = unpack( $format, $data );
3842 wfRestoreWarnings();
3844 if ( $result === false ) {
3845 // If it cannot extract the packed data.
3846 throw new MWException( "unpack could not unpack binary data" );
3852 * Determine if an image exists on the 'bad image list'.
3854 * The format of MediaWiki:Bad_image_list is as follows:
3855 * * Only list items (lines starting with "*") are considered
3856 * * The first link on a line must be a link to a bad image
3857 * * Any subsequent links on the same line are considered to be exceptions,
3858 * i.e. articles where the image may occur inline.
3860 * @param $name string the image name to check
3861 * @param $contextTitle Title|bool the page on which the image occurs, if known
3862 * @param $blacklist string wikitext of a file blacklist
3865 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3866 static $badImageCache = null; // based on bad_image_list msg
3867 wfProfileIn( __METHOD__
);
3870 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
3871 if( $redirectTitle ) {
3872 $name = $redirectTitle->getDbKey();
3875 # Run the extension hook
3877 if( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
3878 wfProfileOut( __METHOD__
);
3882 $cacheable = ( $blacklist === null );
3883 if( $cacheable && $badImageCache !== null ) {
3884 $badImages = $badImageCache;
3885 } else { // cache miss
3886 if ( $blacklist === null ) {
3887 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3889 # Build the list now
3890 $badImages = array();
3891 $lines = explode( "\n", $blacklist );
3892 foreach( $lines as $line ) {
3894 if ( substr( $line, 0, 1 ) !== '*' ) {
3900 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3904 $exceptions = array();
3905 $imageDBkey = false;
3906 foreach ( $m[1] as $i => $titleText ) {
3907 $title = Title
::newFromText( $titleText );
3908 if ( !is_null( $title ) ) {
3910 $imageDBkey = $title->getDBkey();
3912 $exceptions[$title->getPrefixedDBkey()] = true;
3917 if ( $imageDBkey !== false ) {
3918 $badImages[$imageDBkey] = $exceptions;
3922 $badImageCache = $badImages;
3926 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3927 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3928 wfProfileOut( __METHOD__
);