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 );
86 if ( !function_exists( 'mb_strrpos' ) ) {
91 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
92 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
96 // gzdecode function only exists in PHP >= 5.4.0
97 // http://php.net/gzdecode
98 if ( !function_exists( 'gzdecode' ) ) {
100 * @codeCoverageIgnore
103 function gzdecode( $data ) {
104 return gzinflate( substr( $data, 10, -8 ) );
110 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
115 function wfArrayDiff2( $a, $b ) {
116 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
120 * @param $a array|string
121 * @param $b array|string
124 function wfArrayDiff2_cmp( $a, $b ) {
125 if ( is_string( $a ) && is_string( $b ) ) {
126 return strcmp( $a, $b );
127 } elseif ( count( $a ) !== count( $b ) ) {
128 return count( $a ) < count( $b ) ?
-1 : 1;
132 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
133 $cmp = strcmp( $valueA, $valueB );
144 * Returns an array where the values in array $b are replaced by the
145 * values in array $a with the corresponding keys
147 * @deprecated since 1.22; use array_intersect_key()
152 function wfArrayLookup( $a, $b ) {
153 wfDeprecated( __FUNCTION__
, '1.22' );
154 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
158 * Appends to second array if $value differs from that in $default
160 * @param $key String|Int
161 * @param $value Mixed
162 * @param $default Mixed
163 * @param array $changed to alter
164 * @throws MWException
166 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
167 if ( is_null( $changed ) ) {
168 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
170 if ( $default[$key] !== $value ) {
171 $changed[$key] = $value;
176 * Backwards array plus for people who haven't bothered to read the PHP manual
177 * XXX: will not darn your socks for you.
179 * @deprecated since 1.22; use array_replace()
180 * @param $array1 Array
181 * @param [$array2, [...]] Arrays
184 function wfArrayMerge( $array1/* ... */ ) {
185 wfDeprecated( __FUNCTION__
, '1.22' );
186 $args = func_get_args();
187 $args = array_reverse( $args, true );
189 foreach ( $args as $arg ) {
196 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
198 * wfMergeErrorArrays(
199 * array( array( 'x' ) ),
200 * array( array( 'x', '2' ) ),
201 * array( array( 'x' ) ),
202 * array( array( 'y' ) )
213 function wfMergeErrorArrays( /*...*/ ) {
214 $args = func_get_args();
216 foreach ( $args as $errors ) {
217 foreach ( $errors as $params ) {
218 # @todo FIXME: Sometimes get nested arrays for $params,
219 # which leads to E_NOTICEs
220 $spec = implode( "\t", $params );
221 $out[$spec] = $params;
224 return array_values( $out );
228 * Insert array into another array after the specified *KEY*
230 * @param array $array The array.
231 * @param array $insert The array to insert.
232 * @param $after Mixed: The key to insert after
235 function wfArrayInsertAfter( array $array, array $insert, $after ) {
236 // Find the offset of the element to insert after.
237 $keys = array_keys( $array );
238 $offsetByKey = array_flip( $keys );
240 $offset = $offsetByKey[$after];
242 // Insert at the specified offset
243 $before = array_slice( $array, 0, $offset +
1, true );
244 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
246 $output = $before +
$insert +
$after;
252 * Recursively converts the parameter (an object) to an array with the same data
254 * @param $objOrArray Object|Array
255 * @param $recursive Bool
258 function wfObjectToArray( $objOrArray, $recursive = true ) {
260 if ( is_object( $objOrArray ) ) {
261 $objOrArray = get_object_vars( $objOrArray );
263 foreach ( $objOrArray as $key => $value ) {
264 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
265 $value = wfObjectToArray( $value );
268 $array[$key] = $value;
275 * Get a random decimal value between 0 and 1, in a way
276 * not likely to give duplicate values for any realistic
277 * number of articles.
281 function wfRandom() {
282 # The maximum random value is "only" 2^31-1, so get two random
283 # values to reduce the chance of dupes
284 $max = mt_getrandmax() +
1;
285 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
291 * Get a random string containing a number of pseudo-random hex
293 * @note This is not secure, if you are trying to generate some sort
294 * of token please use MWCryptRand instead.
296 * @param int $length The length of the string to generate
300 function wfRandomString( $length = 32 ) {
302 for ( $n = 0; $n < $length; $n +
= 7 ) {
303 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
305 return substr( $str, 0, $length );
309 * We want some things to be included as literal characters in our title URLs
310 * for prettiness, which urlencode encodes by default. According to RFC 1738,
311 * all of the following should be safe:
315 * But + is not safe because it's used to indicate a space; &= are only safe in
316 * paths and not in queries (and we don't distinguish here); ' seems kind of
317 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
318 * is reserved, we don't care. So the list we unescape is:
322 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
323 * so no fancy : for IIS7.
325 * %2F in the page titles seems to fatally break for some reason.
330 function wfUrlencode( $s ) {
333 if ( is_null( $s ) ) {
338 if ( is_null( $needle ) ) {
339 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
340 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
341 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
347 $s = urlencode( $s );
350 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
358 * This function takes two arrays as input, and returns a CGI-style string, e.g.
359 * "days=7&limit=100". Options in the first array override options in the second.
360 * Options set to null or false will not be output.
362 * @param array $array1 ( String|Array )
363 * @param array $array2 ( String|Array )
364 * @param $prefix String
367 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
368 if ( !is_null( $array2 ) ) {
369 $array1 = $array1 +
$array2;
373 foreach ( $array1 as $key => $value ) {
374 if ( !is_null( $value ) && $value !== false ) {
378 if ( $prefix !== '' ) {
379 $key = $prefix . "[$key]";
381 if ( is_array( $value ) ) {
383 foreach ( $value as $k => $v ) {
384 $cgi .= $firstTime ?
'' : '&';
385 if ( is_array( $v ) ) {
386 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
388 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
393 if ( is_object( $value ) ) {
394 $value = $value->__toString();
396 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
404 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
405 * its argument and returns the same string in array form. This allows compatibility
406 * with legacy functions that accept raw query strings instead of nice
407 * arrays. Of course, keys and values are urldecode()d.
409 * @param string $query query string
410 * @return array Array version of input
412 function wfCgiToArray( $query ) {
413 if ( isset( $query[0] ) && $query[0] == '?' ) {
414 $query = substr( $query, 1 );
416 $bits = explode( '&', $query );
418 foreach ( $bits as $bit ) {
422 if ( strpos( $bit, '=' ) === false ) {
423 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
427 list( $key, $value ) = explode( '=', $bit );
429 $key = urldecode( $key );
430 $value = urldecode( $value );
431 if ( strpos( $key, '[' ) !== false ) {
432 $keys = array_reverse( explode( '[', $key ) );
433 $key = array_pop( $keys );
435 foreach ( $keys as $k ) {
436 $k = substr( $k, 0, -1 );
437 $temp = array( $k => $temp );
439 if ( isset( $ret[$key] ) ) {
440 $ret[$key] = array_merge( $ret[$key], $temp );
452 * Append a query string to an existing URL, which may or may not already
453 * have query string parameters already. If so, they will be combined.
456 * @param $query Mixed: string or associative array
459 function wfAppendQuery( $url, $query ) {
460 if ( is_array( $query ) ) {
461 $query = wfArrayToCgi( $query );
463 if ( $query != '' ) {
464 if ( false === strpos( $url, '?' ) ) {
475 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
478 * The meaning of the PROTO_* constants is as follows:
479 * PROTO_HTTP: Output a URL starting with http://
480 * PROTO_HTTPS: Output a URL starting with https://
481 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
482 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
483 * on which protocol was used for the current incoming request
484 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
485 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
486 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
488 * @todo this won't work with current-path-relative URLs
489 * like "subdir/foo.html", etc.
491 * @param string $url either fully-qualified or a local path + query
492 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
493 * protocol to use if $url or $wgServer is protocol-relative
494 * @return string Fully-qualified URL, current-path-relative URL or false if
495 * no valid URL can be constructed
497 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
498 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest;
499 if ( $defaultProto === PROTO_CANONICAL
) {
500 $serverUrl = $wgCanonicalServer;
501 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
502 // Make $wgInternalServer fall back to $wgServer if not set
503 $serverUrl = $wgInternalServer;
505 $serverUrl = $wgServer;
506 if ( $defaultProto === PROTO_CURRENT
) {
507 $defaultProto = $wgRequest->getProtocol() . '://';
511 // Analyze $serverUrl to obtain its protocol
512 $bits = wfParseUrl( $serverUrl );
513 $serverHasProto = $bits && $bits['scheme'] != '';
515 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
516 if ( $serverHasProto ) {
517 $defaultProto = $bits['scheme'] . '://';
519 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
520 // This really isn't supposed to happen. Fall back to HTTP in this
522 $defaultProto = PROTO_HTTP
;
526 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
528 if ( substr( $url, 0, 2 ) == '//' ) {
529 $url = $defaultProtoWithoutSlashes . $url;
530 } elseif ( substr( $url, 0, 1 ) == '/' ) {
531 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
532 // otherwise leave it alone.
533 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
536 $bits = wfParseUrl( $url );
537 if ( $bits && isset( $bits['path'] ) ) {
538 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
539 return wfAssembleUrl( $bits );
543 } elseif ( substr( $url, 0, 1 ) != '/' ) {
544 # URL is a relative path
545 return wfRemoveDotSegments( $url );
548 # Expanded URL is not valid.
553 * This function will reassemble a URL parsed with wfParseURL. This is useful
554 * if you need to edit part of a URL and put it back together.
556 * This is the basic structure used (brackets contain keys for $urlParts):
557 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
559 * @todo Need to integrate this into wfExpandUrl (bug 32168)
562 * @param array $urlParts URL parts, as output from wfParseUrl
563 * @return string URL assembled from its component parts
565 function wfAssembleUrl( $urlParts ) {
568 if ( isset( $urlParts['delimiter'] ) ) {
569 if ( isset( $urlParts['scheme'] ) ) {
570 $result .= $urlParts['scheme'];
573 $result .= $urlParts['delimiter'];
576 if ( isset( $urlParts['host'] ) ) {
577 if ( isset( $urlParts['user'] ) ) {
578 $result .= $urlParts['user'];
579 if ( isset( $urlParts['pass'] ) ) {
580 $result .= ':' . $urlParts['pass'];
585 $result .= $urlParts['host'];
587 if ( isset( $urlParts['port'] ) ) {
588 $result .= ':' . $urlParts['port'];
592 if ( isset( $urlParts['path'] ) ) {
593 $result .= $urlParts['path'];
596 if ( isset( $urlParts['query'] ) ) {
597 $result .= '?' . $urlParts['query'];
600 if ( isset( $urlParts['fragment'] ) ) {
601 $result .= '#' . $urlParts['fragment'];
608 * Remove all dot-segments in the provided URL path. For example,
609 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
610 * RFC3986 section 5.2.4.
612 * @todo Need to integrate this into wfExpandUrl (bug 32168)
614 * @param string $urlPath URL path, potentially containing dot-segments
615 * @return string URL path with all dot-segments removed
617 function wfRemoveDotSegments( $urlPath ) {
620 $inputLength = strlen( $urlPath );
622 while ( $inputOffset < $inputLength ) {
623 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
624 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
625 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
626 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
629 if ( $prefixLengthTwo == './' ) {
630 # Step A, remove leading "./"
632 } elseif ( $prefixLengthThree == '../' ) {
633 # Step A, remove leading "../"
635 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
636 # Step B, replace leading "/.$" with "/"
638 $urlPath[$inputOffset] = '/';
639 } elseif ( $prefixLengthThree == '/./' ) {
640 # Step B, replace leading "/./" with "/"
642 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
643 # Step C, replace leading "/..$" with "/" and
644 # remove last path component in output
646 $urlPath[$inputOffset] = '/';
648 } elseif ( $prefixLengthFour == '/../' ) {
649 # Step C, replace leading "/../" with "/" and
650 # remove last path component in output
653 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
654 # Step D, remove "^.$"
656 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
657 # Step D, remove "^..$"
660 # Step E, move leading path segment to output
661 if ( $prefixLengthOne == '/' ) {
662 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
664 $slashPos = strpos( $urlPath, '/', $inputOffset );
666 if ( $slashPos === false ) {
667 $output .= substr( $urlPath, $inputOffset );
668 $inputOffset = $inputLength;
670 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
671 $inputOffset +
= $slashPos - $inputOffset;
676 $slashPos = strrpos( $output, '/' );
677 if ( $slashPos === false ) {
680 $output = substr( $output, 0, $slashPos );
689 * Returns a regular expression of url protocols
691 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
692 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
695 function wfUrlProtocols( $includeProtocolRelative = true ) {
696 global $wgUrlProtocols;
698 // Cache return values separately based on $includeProtocolRelative
699 static $withProtRel = null, $withoutProtRel = null;
700 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
701 if ( !is_null( $cachedValue ) ) {
705 // Support old-style $wgUrlProtocols strings, for backwards compatibility
706 // with LocalSettings files from 1.5
707 if ( is_array( $wgUrlProtocols ) ) {
708 $protocols = array();
709 foreach ( $wgUrlProtocols as $protocol ) {
710 // Filter out '//' if !$includeProtocolRelative
711 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
712 $protocols[] = preg_quote( $protocol, '/' );
716 $retval = implode( '|', $protocols );
718 // Ignore $includeProtocolRelative in this case
719 // This case exists for pre-1.6 compatibility, and we can safely assume
720 // that '//' won't appear in a pre-1.6 config because protocol-relative
721 // URLs weren't supported until 1.18
722 $retval = $wgUrlProtocols;
725 // Cache return value
726 if ( $includeProtocolRelative ) {
727 $withProtRel = $retval;
729 $withoutProtRel = $retval;
735 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
736 * you need a regex that matches all URL protocols but does not match protocol-
740 function wfUrlProtocolsWithoutProtRel() {
741 return wfUrlProtocols( false );
745 * parse_url() work-alike, but non-broken. Differences:
747 * 1) Does not raise warnings on bad URLs (just returns false).
748 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
749 * protocol-relative URLs) correctly.
750 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
752 * @param string $url a URL to parse
753 * @return Array: bits of the URL in an associative array, per PHP docs
755 function wfParseUrl( $url ) {
756 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
758 // Protocol-relative URLs are handled really badly by parse_url(). It's so
759 // bad that the easiest way to handle them is to just prepend 'http:' and
760 // strip the protocol out later.
761 $wasRelative = substr( $url, 0, 2 ) == '//';
762 if ( $wasRelative ) {
765 wfSuppressWarnings();
766 $bits = parse_url( $url );
768 // parse_url() returns an array without scheme for some invalid URLs, e.g.
769 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
770 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
774 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
775 $bits['scheme'] = strtolower( $bits['scheme'] );
777 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
778 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
779 $bits['delimiter'] = '://';
780 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
781 $bits['delimiter'] = ':';
782 // parse_url detects for news: and mailto: the host part of an url as path
783 // We have to correct this wrong detection
784 if ( isset( $bits['path'] ) ) {
785 $bits['host'] = $bits['path'];
792 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
793 if ( !isset( $bits['host'] ) ) {
797 if ( isset( $bits['path'] ) ) {
798 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
799 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
800 $bits['path'] = '/' . $bits['path'];
807 // If the URL was protocol-relative, fix scheme and delimiter
808 if ( $wasRelative ) {
809 $bits['scheme'] = '';
810 $bits['delimiter'] = '//';
816 * Take a URL, make sure it's expanded to fully qualified, and replace any
817 * encoded non-ASCII Unicode characters with their UTF-8 original forms
818 * for more compact display and legibility for local audiences.
820 * @todo handle punycode domains too
825 function wfExpandIRI( $url ) {
826 return preg_replace_callback(
827 '/((?:%[89A-F][0-9A-F])+)/i',
828 'wfExpandIRI_callback',
834 * Private callback for wfExpandIRI
835 * @param array $matches
838 function wfExpandIRI_callback( $matches ) {
839 return urldecode( $matches[1] );
843 * Make URL indexes, appropriate for the el_index field of externallinks.
848 function wfMakeUrlIndexes( $url ) {
849 $bits = wfParseUrl( $url );
851 // Reverse the labels in the hostname, convert to lower case
852 // For emails reverse domainpart only
853 if ( $bits['scheme'] == 'mailto' ) {
854 $mailparts = explode( '@', $bits['host'], 2 );
855 if ( count( $mailparts ) === 2 ) {
856 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
858 // No domain specified, don't mangle it
861 $reversedHost = $domainpart . '@' . $mailparts[0];
863 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
865 // Add an extra dot to the end
866 // Why? Is it in wrong place in mailto links?
867 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
868 $reversedHost .= '.';
870 // Reconstruct the pseudo-URL
871 $prot = $bits['scheme'];
872 $index = $prot . $bits['delimiter'] . $reversedHost;
873 // Leave out user and password. Add the port, path, query and fragment
874 if ( isset( $bits['port'] ) ) {
875 $index .= ':' . $bits['port'];
877 if ( isset( $bits['path'] ) ) {
878 $index .= $bits['path'];
882 if ( isset( $bits['query'] ) ) {
883 $index .= '?' . $bits['query'];
885 if ( isset( $bits['fragment'] ) ) {
886 $index .= '#' . $bits['fragment'];
890 return array( "http:$index", "https:$index" );
892 return array( $index );
897 * Check whether a given URL has a domain that occurs in a given set of domains
898 * @param string $url URL
899 * @param array $domains Array of domains (strings)
900 * @return bool True if the host part of $url ends in one of the strings in $domains
902 function wfMatchesDomainList( $url, $domains ) {
903 $bits = wfParseUrl( $url );
904 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
905 $host = '.' . $bits['host'];
906 foreach ( (array)$domains as $domain ) {
907 $domain = '.' . $domain;
908 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
917 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
918 * In normal operation this is a NOP.
920 * Controlling globals:
921 * $wgDebugLogFile - points to the log file
922 * $wgProfileOnly - if set, normal debug messages will not be recorded.
923 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
924 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
926 * @param $text String
927 * @param string|bool $dest Destination of the message:
928 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
929 * - 'log': only to the log and not in HTML
930 * For backward compatibility, it can also take a boolean:
931 * - true: same as 'all'
932 * - false: same as 'log'
934 function wfDebug( $text, $dest = 'all' ) {
935 global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
937 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
941 // Turn $dest into a string if it's a boolean (for b/c)
942 if ( $dest === true ) {
944 } elseif ( $dest === false ) {
948 $timer = wfDebugTimer();
949 if ( $timer !== '' ) {
950 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
953 if ( $dest === 'all' ) {
954 MWDebug
::debugMsg( $text );
957 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
958 # Strip unprintables; they can switch terminal modes when binary data
959 # gets dumped, which is pretty annoying.
960 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
961 $text = $wgDebugLogPrefix . $text;
962 wfErrorLog( $text, $wgDebugLogFile );
967 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
970 function wfIsDebugRawPage() {
972 if ( $cache !== null ) {
975 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
976 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
978 isset( $_SERVER['SCRIPT_NAME'] )
979 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
990 * Get microsecond timestamps for debug logs
994 function wfDebugTimer() {
995 global $wgDebugTimestamps, $wgRequestTime;
997 if ( !$wgDebugTimestamps ) {
1001 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1002 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1003 return "$prefix $mem ";
1007 * Send a line giving PHP memory usage.
1009 * @param bool $exact print exact values instead of kilobytes (default: false)
1011 function wfDebugMem( $exact = false ) {
1012 $mem = memory_get_usage();
1014 $mem = floor( $mem / 1024 ) . ' kilobytes';
1018 wfDebug( "Memory usage: $mem\n" );
1022 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1023 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to a string
1024 * filename or an associative array mapping 'destination' to the desired filename. The
1025 * associative array may also contain a 'sample' key with an integer value, specifying
1026 * a sampling factor.
1028 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1030 * @param $logGroup String
1031 * @param $text String
1032 * @param bool $public whether to log the event in the public log if no private
1033 * log file is specified, (default true)
1034 * @param string|bool $dest Destination of the message:
1035 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1036 * - 'log': only to the log and not in HTML
1037 * - 'private': only to the specifc log if set in $wgDebugLogGroups and
1038 * discarded otherwise
1039 * For backward compatibility, it can also take a boolean:
1040 * - true: same as 'all'
1041 * - false: same as 'private'
1043 function wfDebugLog( $logGroup, $text, $dest = 'all' ) {
1044 global $wgDebugLogGroups;
1046 $text = trim( $text ) . "\n";
1048 // Turn $dest into a string if it's a boolean (for b/c)
1049 if ( $dest === true ) {
1051 } elseif ( $dest === false ) {
1055 if ( !isset( $wgDebugLogGroups[$logGroup] ) ) {
1056 if ( $dest !== 'private' ) {
1057 wfDebug( "[$logGroup] $text", $dest );
1062 if ( $dest === 'all' ) {
1063 MWDebug
::debugMsg( "[$logGroup] $text" );
1066 $logConfig = $wgDebugLogGroups[$logGroup];
1067 if ( $logConfig === false ) {
1070 if ( is_array( $logConfig ) ) {
1071 if ( isset( $logConfig['sample'] ) && mt_rand( 1, $logConfig['sample'] ) !== 1 ) {
1074 $destination = $logConfig['destination'];
1076 $destination = strval( $logConfig );
1079 $time = wfTimestamp( TS_DB
);
1081 $host = wfHostname();
1082 wfErrorLog( "$time $host $wiki: $text", $destination );
1086 * Log for database errors
1088 * @param string $text database error message.
1090 function wfLogDBError( $text ) {
1091 global $wgDBerrorLog, $wgDBerrorLogTZ;
1092 static $logDBErrorTimeZoneObject = null;
1094 if ( $wgDBerrorLog ) {
1095 $host = wfHostname();
1098 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1099 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1102 // Workaround for https://bugs.php.net/bug.php?id=52063
1103 // Can be removed when min PHP > 5.3.2
1104 if ( $logDBErrorTimeZoneObject === null ) {
1105 $d = date_create( "now" );
1107 $d = date_create( "now", $logDBErrorTimeZoneObject );
1110 $date = $d->format( 'D M j G:i:s T Y' );
1112 $text = "$date\t$host\t$wiki\t$text";
1113 wfErrorLog( $text, $wgDBerrorLog );
1118 * Throws a warning that $function is deprecated
1120 * @param $function String
1121 * @param string|bool $version Version of MediaWiki that the function
1122 * was deprecated in (Added in 1.19).
1123 * @param string|bool $component Added in 1.19.
1124 * @param $callerOffset integer: How far up the call stack is the original
1125 * caller. 2 = function that called the function that called
1126 * wfDeprecated (Added in 1.20)
1130 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1131 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1135 * Send a warning either to the debug log or in a PHP error depending on
1136 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1138 * @param string $msg message to send
1139 * @param $callerOffset Integer: number of items to go back in the backtrace to
1140 * find the correct caller (1 = function calling wfWarn, ...)
1141 * @param $level Integer: PHP error level; defaults to E_USER_NOTICE;
1142 * only used when $wgDevelopmentWarnings is true
1144 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1145 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1149 * Send a warning as a PHP error and the debug log. This is intended for logging
1150 * warnings in production. For logging development warnings, use WfWarn instead.
1152 * @param $msg String: message to send
1153 * @param $callerOffset Integer: number of items to go back in the backtrace to
1154 * find the correct caller (1 = function calling wfLogWarning, ...)
1155 * @param $level Integer: PHP error level; defaults to E_USER_WARNING
1157 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1158 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1162 * Log to a file without getting "file size exceeded" signals.
1164 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1165 * send lines to the specified port, prefixed by the specified prefix and a space.
1167 * @param $text String
1168 * @param string $file filename
1169 * @throws MWException
1171 function wfErrorLog( $text, $file ) {
1172 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1173 # Needs the sockets extension
1174 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1175 // IPv6 bracketed host
1177 $port = intval( $m[3] );
1178 $prefix = isset( $m[4] ) ?
$m[4] : false;
1180 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1182 if ( !IP
::isIPv4( $host ) ) {
1183 $host = gethostbyname( $host );
1185 $port = intval( $m[3] );
1186 $prefix = isset( $m[4] ) ?
$m[4] : false;
1189 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1192 // Clean it up for the multiplexer
1193 if ( strval( $prefix ) !== '' ) {
1194 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1197 if ( strlen( $text ) > 65506 ) {
1198 $text = substr( $text, 0, 65506 );
1201 if ( substr( $text, -1 ) != "\n" ) {
1204 } elseif ( strlen( $text ) > 65507 ) {
1205 $text = substr( $text, 0, 65507 );
1208 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1213 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1214 socket_close( $sock );
1216 wfSuppressWarnings();
1217 $exists = file_exists( $file );
1218 $size = $exists ?
filesize( $file ) : false;
1219 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1220 file_put_contents( $file, $text, FILE_APPEND
);
1222 wfRestoreWarnings();
1229 function wfLogProfilingData() {
1230 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1231 global $wgProfileLimit, $wgUser;
1233 StatCounter
::singleton()->flush();
1235 $profiler = Profiler
::instance();
1237 # Profiling must actually be enabled...
1238 if ( $profiler->isStub() ) {
1242 // Get total page request time and only show pages that longer than
1243 // $wgProfileLimit time (default is 0)
1244 $elapsed = microtime( true ) - $wgRequestTime;
1245 if ( $elapsed <= $wgProfileLimit ) {
1249 $profiler->logData();
1251 // Check whether this should be logged in the debug file.
1252 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1257 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1258 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1260 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1261 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1263 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1264 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1267 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1269 // Don't load $wgUser at this late stage just for statistics purposes
1270 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1271 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1272 $forward .= ' anon';
1275 // Command line script uses a FauxRequest object which does not have
1276 // any knowledge about an URL and throw an exception instead.
1278 $requestUrl = $wgRequest->getRequestURL();
1279 } catch ( MWException
$e ) {
1280 $requestUrl = 'n/a';
1283 $log = sprintf( "%s\t%04.3f\t%s\n",
1284 gmdate( 'YmdHis' ), $elapsed,
1285 urldecode( $requestUrl . $forward ) );
1287 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1291 * Increment a statistics counter
1293 * @param $key String
1297 function wfIncrStats( $key, $count = 1 ) {
1298 StatCounter
::singleton()->incr( $key, $count );
1302 * Check whether the wiki is in read-only mode.
1306 function wfReadOnly() {
1307 return wfReadOnlyReason() !== false;
1311 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1313 * @return string|bool: String when in read-only mode; false otherwise
1315 function wfReadOnlyReason() {
1316 global $wgReadOnly, $wgReadOnlyFile;
1318 if ( $wgReadOnly === null ) {
1319 // Set $wgReadOnly for faster access next time
1320 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1321 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1323 $wgReadOnly = false;
1331 * Return a Language object from $langcode
1333 * @param $langcode Mixed: either:
1334 * - a Language object
1335 * - code of the language to get the message for, if it is
1336 * a valid code create a language for that language, if
1337 * it is a string but not a valid code then make a basic
1339 * - a boolean: if it's false then use the global object for
1340 * the current user's language (as a fallback for the old parameter
1341 * functionality), or if it is true then use global object
1342 * for the wiki's content language.
1343 * @return Language object
1345 function wfGetLangObj( $langcode = false ) {
1346 # Identify which language to get or create a language object for.
1347 # Using is_object here due to Stub objects.
1348 if ( is_object( $langcode ) ) {
1349 # Great, we already have the object (hopefully)!
1353 global $wgContLang, $wgLanguageCode;
1354 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1355 # $langcode is the language code of the wikis content language object.
1356 # or it is a boolean and value is true
1361 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1362 # $langcode is the language code of user language object.
1363 # or it was a boolean and value is false
1367 $validCodes = array_keys( Language
::fetchLanguageNames() );
1368 if ( in_array( $langcode, $validCodes ) ) {
1369 # $langcode corresponds to a valid language.
1370 return Language
::factory( $langcode );
1373 # $langcode is a string, but not a valid language code; use content language.
1374 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1379 * This is the function for getting translated interface messages.
1381 * @see Message class for documentation how to use them.
1382 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1384 * This function replaces all old wfMsg* functions.
1386 * @param $key \string Message key.
1387 * Varargs: normal message parameters.
1391 function wfMessage( $key /*...*/) {
1392 $params = func_get_args();
1393 array_shift( $params );
1394 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1395 $params = $params[0];
1397 return new Message( $key, $params );
1401 * This function accepts multiple message keys and returns a message instance
1402 * for the first message which is non-empty. If all messages are empty then an
1403 * instance of the first message key is returned.
1404 * @param varargs: message keys
1408 function wfMessageFallback( /*...*/ ) {
1409 $args = func_get_args();
1410 return call_user_func_array( 'Message::newFallbackSequence', $args );
1414 * Get a message from anywhere, for the current user language.
1416 * Use wfMsgForContent() instead if the message should NOT
1417 * change depending on the user preferences.
1419 * @deprecated since 1.18
1421 * @param string $key lookup key for the message, usually
1422 * defined in languages/Language.php
1424 * Parameters to the message, which can be used to insert variable text into
1425 * it, can be passed to this function in the following formats:
1426 * - One per argument, starting at the second parameter
1427 * - As an array in the second parameter
1428 * These are not shown in the function definition.
1432 function wfMsg( $key ) {
1433 wfDeprecated( __METHOD__
, '1.21' );
1435 $args = func_get_args();
1436 array_shift( $args );
1437 return wfMsgReal( $key, $args );
1441 * Same as above except doesn't transform the message
1443 * @deprecated since 1.18
1445 * @param $key String
1448 function wfMsgNoTrans( $key ) {
1449 wfDeprecated( __METHOD__
, '1.21' );
1451 $args = func_get_args();
1452 array_shift( $args );
1453 return wfMsgReal( $key, $args, true, false, false );
1457 * Get a message from anywhere, for the current global language
1458 * set with $wgLanguageCode.
1460 * Use this if the message should NOT change dependent on the
1461 * language set in the user's preferences. This is the case for
1462 * most text written into logs, as well as link targets (such as
1463 * the name of the copyright policy page). Link titles, on the
1464 * other hand, should be shown in the UI language.
1466 * Note that MediaWiki allows users to change the user interface
1467 * language in their preferences, but a single installation
1468 * typically only contains content in one language.
1470 * Be wary of this distinction: If you use wfMsg() where you should
1471 * use wfMsgForContent(), a user of the software may have to
1472 * customize potentially hundreds of messages in
1473 * order to, e.g., fix a link in every possible language.
1475 * @deprecated since 1.18
1477 * @param string $key lookup key for the message, usually
1478 * defined in languages/Language.php
1481 function wfMsgForContent( $key ) {
1482 wfDeprecated( __METHOD__
, '1.21' );
1484 global $wgForceUIMsgAsContentMsg;
1485 $args = func_get_args();
1486 array_shift( $args );
1488 if ( is_array( $wgForceUIMsgAsContentMsg )
1489 && in_array( $key, $wgForceUIMsgAsContentMsg )
1491 $forcontent = false;
1493 return wfMsgReal( $key, $args, true, $forcontent );
1497 * Same as above except doesn't transform the message
1499 * @deprecated since 1.18
1501 * @param $key String
1504 function wfMsgForContentNoTrans( $key ) {
1505 wfDeprecated( __METHOD__
, '1.21' );
1507 global $wgForceUIMsgAsContentMsg;
1508 $args = func_get_args();
1509 array_shift( $args );
1511 if ( is_array( $wgForceUIMsgAsContentMsg )
1512 && in_array( $key, $wgForceUIMsgAsContentMsg )
1514 $forcontent = false;
1516 return wfMsgReal( $key, $args, true, $forcontent, false );
1520 * Really get a message
1522 * @deprecated since 1.18
1524 * @param string $key key to get.
1526 * @param $useDB Boolean
1527 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1528 * @param $transform Boolean: Whether or not to transform the message.
1529 * @return String: the requested message.
1531 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1532 wfDeprecated( __METHOD__
, '1.21' );
1534 wfProfileIn( __METHOD__
);
1535 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1536 $message = wfMsgReplaceArgs( $message, $args );
1537 wfProfileOut( __METHOD__
);
1542 * Fetch a message string value, but don't replace any keys yet.
1544 * @deprecated since 1.18
1546 * @param $key String
1547 * @param $useDB Bool
1548 * @param string $langCode Code of the language to get the message for, or
1549 * behaves as a content language switch if it is a boolean.
1550 * @param $transform Boolean: whether to parse magic words, etc.
1553 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1554 wfDeprecated( __METHOD__
, '1.21' );
1556 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1558 $cache = MessageCache
::singleton();
1559 $message = $cache->get( $key, $useDB, $langCode );
1560 if ( $message === false ) {
1561 $message = '<' . htmlspecialchars( $key ) . '>';
1562 } elseif ( $transform ) {
1563 $message = $cache->transform( $message );
1569 * Replace message parameter keys on the given formatted output.
1571 * @param $message String
1572 * @param $args Array
1576 function wfMsgReplaceArgs( $message, $args ) {
1577 # Fix windows line-endings
1578 # Some messages are split with explode("\n", $msg)
1579 $message = str_replace( "\r", '', $message );
1581 // Replace arguments
1582 if ( count( $args ) ) {
1583 if ( is_array( $args[0] ) ) {
1584 $args = array_values( $args[0] );
1586 $replacementKeys = array();
1587 foreach ( $args as $n => $param ) {
1588 $replacementKeys['$' . ( $n +
1 )] = $param;
1590 $message = strtr( $message, $replacementKeys );
1597 * Return an HTML-escaped version of a message.
1598 * Parameter replacements, if any, are done *after* the HTML-escaping,
1599 * so parameters may contain HTML (eg links or form controls). Be sure
1600 * to pre-escape them if you really do want plaintext, or just wrap
1601 * the whole thing in htmlspecialchars().
1603 * @deprecated since 1.18
1605 * @param $key String
1606 * @param string ... parameters
1609 function wfMsgHtml( $key ) {
1610 wfDeprecated( __METHOD__
, '1.21' );
1612 $args = func_get_args();
1613 array_shift( $args );
1614 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1618 * Return an HTML version of message
1619 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1620 * so parameters may contain HTML (eg links or form controls). Be sure
1621 * to pre-escape them if you really do want plaintext, or just wrap
1622 * the whole thing in htmlspecialchars().
1624 * @deprecated since 1.18
1626 * @param $key String
1627 * @param string ... parameters
1630 function wfMsgWikiHtml( $key ) {
1631 wfDeprecated( __METHOD__
, '1.21' );
1633 $args = func_get_args();
1634 array_shift( $args );
1635 return wfMsgReplaceArgs(
1636 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1637 /* can't be set to false */ true, /* interface */ true )->getText(),
1642 * Returns message in the requested format
1644 * @deprecated since 1.18
1646 * @param string $key key of the message
1647 * @param array $options processing rules.
1648 * Can take the following options:
1649 * parse: parses wikitext to HTML
1650 * parseinline: parses wikitext to HTML and removes the surrounding
1651 * p's added by parser or tidy
1652 * escape: filters message through htmlspecialchars
1653 * escapenoentities: same, but allows entity references like   through
1654 * replaceafter: parameters are substituted after parsing or escaping
1655 * parsemag: transform the message using magic phrases
1656 * content: fetch message for content language instead of interface
1657 * Also can accept a single associative argument, of the form 'language' => 'xx':
1658 * language: Language object or language code to fetch message for
1659 * (overridden by content).
1660 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1664 function wfMsgExt( $key, $options ) {
1665 wfDeprecated( __METHOD__
, '1.21' );
1667 $args = func_get_args();
1668 array_shift( $args );
1669 array_shift( $args );
1670 $options = (array)$options;
1672 foreach ( $options as $arrayKey => $option ) {
1673 if ( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1674 # An unknown index, neither numeric nor "language"
1675 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1676 } elseif ( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1677 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1678 'replaceafter', 'parsemag', 'content' ) ) ) {
1679 # A numeric index with unknown value
1680 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1684 if ( in_array( 'content', $options, true ) ) {
1687 $langCodeObj = null;
1688 } elseif ( array_key_exists( 'language', $options ) ) {
1689 $forContent = false;
1690 $langCode = wfGetLangObj( $options['language'] );
1691 $langCodeObj = $langCode;
1693 $forContent = false;
1695 $langCodeObj = null;
1698 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1700 if ( !in_array( 'replaceafter', $options, true ) ) {
1701 $string = wfMsgReplaceArgs( $string, $args );
1704 $messageCache = MessageCache
::singleton();
1705 $parseInline = in_array( 'parseinline', $options, true );
1706 if ( in_array( 'parse', $options, true ) ||
$parseInline ) {
1707 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1708 if ( $string instanceof ParserOutput
) {
1709 $string = $string->getText();
1712 if ( $parseInline ) {
1714 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1718 } elseif ( in_array( 'parsemag', $options, true ) ) {
1719 $string = $messageCache->transform( $string,
1720 !$forContent, $langCodeObj );
1723 if ( in_array( 'escape', $options, true ) ) {
1724 $string = htmlspecialchars ( $string );
1725 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1726 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1729 if ( in_array( 'replaceafter', $options, true ) ) {
1730 $string = wfMsgReplaceArgs( $string, $args );
1737 * Since wfMsg() and co suck, they don't return false if the message key they
1738 * looked up didn't exist but instead the key wrapped in <>'s, this function checks for the
1739 * nonexistence of messages by checking the MessageCache::get() result directly.
1741 * @deprecated since 1.18. Use Message::isDisabled().
1743 * @param $key String: the message key looked up
1744 * @return Boolean True if the message *doesn't* exist.
1746 function wfEmptyMsg( $key ) {
1747 wfDeprecated( __METHOD__
, '1.21' );
1749 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1753 * Throw a debugging exception. This function previously once exited the process,
1754 * but now throws an exception instead, with similar results.
1756 * @deprecated since 1.22; just throw an MWException yourself
1757 * @param string $msg message shown when dying.
1758 * @throws MWException
1760 function wfDebugDieBacktrace( $msg = '' ) {
1761 wfDeprecated( __FUNCTION__
, '1.22' );
1762 throw new MWException( $msg );
1766 * Fetch server name for use in error reporting etc.
1767 * Use real server name if available, so we know which machine
1768 * in a server farm generated the current page.
1772 function wfHostname() {
1774 if ( is_null( $host ) ) {
1776 # Hostname overriding
1777 global $wgOverrideHostname;
1778 if ( $wgOverrideHostname !== false ) {
1779 # Set static and skip any detection
1780 $host = $wgOverrideHostname;
1784 if ( function_exists( 'posix_uname' ) ) {
1785 // This function not present on Windows
1786 $uname = posix_uname();
1790 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1791 $host = $uname['nodename'];
1792 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1793 # Windows computer name
1794 $host = getenv( 'COMPUTERNAME' );
1796 # This may be a virtual server.
1797 $host = $_SERVER['SERVER_NAME'];
1804 * Returns a HTML comment with the elapsed time since request.
1805 * This method has no side effects.
1809 function wfReportTime() {
1810 global $wgRequestTime, $wgShowHostnames;
1812 $elapsed = microtime( true ) - $wgRequestTime;
1814 return $wgShowHostnames
1815 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1816 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1820 * Safety wrapper for debug_backtrace().
1822 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1823 * murky circumstances, which may be triggered in part by stub objects
1824 * or other fancy talking'.
1826 * Will return an empty array if Zend Optimizer is detected or if
1827 * debug_backtrace is disabled, otherwise the output from
1828 * debug_backtrace() (trimmed).
1830 * @param int $limit This parameter can be used to limit the number of stack frames returned
1832 * @return array of backtrace information
1834 function wfDebugBacktrace( $limit = 0 ) {
1835 static $disabled = null;
1837 if ( extension_loaded( 'Zend Optimizer' ) ) {
1838 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1842 if ( is_null( $disabled ) ) {
1844 $functions = explode( ',', ini_get( 'disable_functions' ) );
1845 $functions = array_map( 'trim', $functions );
1846 $functions = array_map( 'strtolower', $functions );
1847 if ( in_array( 'debug_backtrace', $functions ) ) {
1848 wfDebug( "debug_backtrace is in disabled_functions\n" );
1856 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1857 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1859 return array_slice( debug_backtrace(), 1 );
1864 * Get a debug backtrace as a string
1868 function wfBacktrace() {
1869 global $wgCommandLineMode;
1871 if ( $wgCommandLineMode ) {
1876 $backtrace = wfDebugBacktrace();
1877 foreach ( $backtrace as $call ) {
1878 if ( isset( $call['file'] ) ) {
1879 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1880 $file = $f[count( $f ) - 1];
1884 if ( isset( $call['line'] ) ) {
1885 $line = $call['line'];
1889 if ( $wgCommandLineMode ) {
1890 $msg .= "$file line $line calls ";
1892 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1894 if ( !empty( $call['class'] ) ) {
1895 $msg .= $call['class'] . $call['type'];
1897 $msg .= $call['function'] . '()';
1899 if ( $wgCommandLineMode ) {
1905 if ( $wgCommandLineMode ) {
1915 * Get the name of the function which called this function
1916 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1917 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1918 * wfGetCaller( 3 ) is the parent of that.
1923 function wfGetCaller( $level = 2 ) {
1924 $backtrace = wfDebugBacktrace( $level +
1 );
1925 if ( isset( $backtrace[$level] ) ) {
1926 return wfFormatStackFrame( $backtrace[$level] );
1933 * Return a string consisting of callers in the stack. Useful sometimes
1934 * for profiling specific points.
1936 * @param int $limit The maximum depth of the stack frame to return, or false for
1940 function wfGetAllCallers( $limit = 3 ) {
1941 $trace = array_reverse( wfDebugBacktrace() );
1942 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1943 $limit = count( $trace ) - 1;
1945 $trace = array_slice( $trace, -$limit - 1, $limit );
1946 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1950 * Return a string representation of frame
1952 * @param $frame Array
1955 function wfFormatStackFrame( $frame ) {
1956 return isset( $frame['class'] ) ?
1957 $frame['class'] . '::' . $frame['function'] :
1961 /* Some generic result counters, pulled out of SearchEngine */
1966 * @param $offset Int
1970 function wfShowingResults( $offset, $limit ) {
1971 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1975 * Generate (prev x| next x) (20|50|100...) type links for paging
1977 * @param $offset String
1978 * @param $limit Integer
1979 * @param $link String
1980 * @param string $query optional URL query parameter string
1981 * @param bool $atend optional param for specified if this is the last page
1983 * @deprecated in 1.19; use Language::viewPrevNext() instead
1985 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1986 wfDeprecated( __METHOD__
, '1.19' );
1990 $query = wfCgiToArray( $query );
1992 if ( is_object( $link ) ) {
1995 $title = Title
::newFromText( $link );
1996 if ( is_null( $title ) ) {
2001 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
2006 * @todo FIXME: We may want to blacklist some broken browsers
2008 * @param $force Bool
2009 * @return bool Whereas client accept gzip compression
2011 function wfClientAcceptsGzip( $force = false ) {
2012 static $result = null;
2013 if ( $result === null ||
$force ) {
2015 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
2016 # @todo FIXME: We may want to blacklist some broken browsers
2019 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2020 $_SERVER['HTTP_ACCEPT_ENCODING'],
2024 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2028 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2037 * Obtain the offset and limit values from the request string;
2038 * used in special pages
2040 * @param int $deflimit default limit if none supplied
2041 * @param string $optionname Name of a user preference to check against
2045 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2047 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2051 * Escapes the given text so that it may be output using addWikiText()
2052 * without any linking, formatting, etc. making its way through. This
2053 * is achieved by substituting certain characters with HTML entities.
2054 * As required by the callers, "<nowiki>" is not used.
2056 * @param string $text text to be escaped
2059 function wfEscapeWikiText( $text ) {
2060 static $repl = null, $repl2 = null;
2061 if ( $repl === null ) {
2063 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2064 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2065 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
2066 "\n#" => "\n#", "\r#" => "\r#",
2067 "\n*" => "\n*", "\r*" => "\r*",
2068 "\n:" => "\n:", "\r:" => "\r:",
2069 "\n " => "\n ", "\r " => "\r ",
2070 "\n\n" => "\n ", "\r\n" => " \n",
2071 "\n\r" => "\n ", "\r\r" => "\r ",
2072 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
2073 "\n----" => "\n----", "\r----" => "\r----",
2074 '__' => '__', '://' => '://',
2077 // We have to catch everything "\s" matches in PCRE
2078 foreach ( array( 'ISBN', 'RFC', 'PMID' ) as $magic ) {
2079 $repl["$magic "] = "$magic ";
2080 $repl["$magic\t"] = "$magic	";
2081 $repl["$magic\r"] = "$magic ";
2082 $repl["$magic\n"] = "$magic ";
2083 $repl["$magic\f"] = "$magic";
2086 // And handle protocols that don't use "://"
2087 global $wgUrlProtocols;
2089 foreach ( $wgUrlProtocols as $prot ) {
2090 if ( substr( $prot, -1 ) === ':' ) {
2091 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
2094 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
2096 $text = substr( strtr( "\n$text", $repl ), 1 );
2097 $text = preg_replace( $repl2, '$1:', $text );
2102 * Get the current unix timestamp with microseconds. Useful for profiling
2103 * @deprecated since 1.22; call microtime() directly
2107 wfDeprecated( __FUNCTION__
, '1.22' );
2108 return microtime( true );
2112 * Sets dest to source and returns the original value of dest
2113 * If source is NULL, it just returns the value, it doesn't set the variable
2114 * If force is true, it will set the value even if source is NULL
2116 * @param $dest Mixed
2117 * @param $source Mixed
2118 * @param $force Bool
2121 function wfSetVar( &$dest, $source, $force = false ) {
2123 if ( !is_null( $source ) ||
$force ) {
2130 * As for wfSetVar except setting a bit
2134 * @param $state Bool
2138 function wfSetBit( &$dest, $bit, $state = true ) {
2139 $temp = (bool)( $dest & $bit );
2140 if ( !is_null( $state ) ) {
2151 * A wrapper around the PHP function var_export().
2152 * Either print it or add it to the regular output ($wgOut).
2154 * @param $var mixed A PHP variable to dump.
2156 function wfVarDump( $var ) {
2158 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2159 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2162 $wgOut->addHTML( $s );
2167 * Provide a simple HTTP error.
2169 * @param $code Int|String
2170 * @param $label String
2171 * @param $desc String
2173 function wfHttpError( $code, $label, $desc ) {
2176 header( "HTTP/1.0 $code $label" );
2177 header( "Status: $code $label" );
2178 $wgOut->sendCacheControl();
2180 header( 'Content-type: text/html; charset=utf-8' );
2181 print "<!doctype html>" .
2182 '<html><head><title>' .
2183 htmlspecialchars( $label ) .
2184 '</title></head><body><h1>' .
2185 htmlspecialchars( $label ) .
2187 nl2br( htmlspecialchars( $desc ) ) .
2188 "</p></body></html>\n";
2192 * Clear away any user-level output buffers, discarding contents.
2194 * Suitable for 'starting afresh', for instance when streaming
2195 * relatively large amounts of data without buffering, or wanting to
2196 * output image files without ob_gzhandler's compression.
2198 * The optional $resetGzipEncoding parameter controls suppression of
2199 * the Content-Encoding header sent by ob_gzhandler; by default it
2200 * is left. See comments for wfClearOutputBuffers() for why it would
2203 * Note that some PHP configuration options may add output buffer
2204 * layers which cannot be removed; these are left in place.
2206 * @param $resetGzipEncoding Bool
2208 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2209 if ( $resetGzipEncoding ) {
2210 // Suppress Content-Encoding and Content-Length
2211 // headers from 1.10+s wfOutputHandler
2212 global $wgDisableOutputCompression;
2213 $wgDisableOutputCompression = true;
2215 while ( $status = ob_get_status() ) {
2216 if ( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2217 // Probably from zlib.output_compression or other
2218 // PHP-internal setting which can't be removed.
2220 // Give up, and hope the result doesn't break
2224 if ( !ob_end_clean() ) {
2225 // Could not remove output buffer handler; abort now
2226 // to avoid getting in some kind of infinite loop.
2229 if ( $resetGzipEncoding ) {
2230 if ( $status['name'] == 'ob_gzhandler' ) {
2231 // Reset the 'Content-Encoding' field set by this handler
2232 // so we can start fresh.
2233 header_remove( 'Content-Encoding' );
2241 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2243 * Clear away output buffers, but keep the Content-Encoding header
2244 * produced by ob_gzhandler, if any.
2246 * This should be used for HTTP 304 responses, where you need to
2247 * preserve the Content-Encoding header of the real result, but
2248 * also need to suppress the output of ob_gzhandler to keep to spec
2249 * and avoid breaking Firefox in rare cases where the headers and
2250 * body are broken over two packets.
2252 function wfClearOutputBuffers() {
2253 wfResetOutputBuffers( false );
2257 * Converts an Accept-* header into an array mapping string values to quality
2260 * @param $accept String
2261 * @param string $def default
2264 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2265 # No arg means accept anything (per HTTP spec)
2267 return array( $def => 1.0 );
2272 $parts = explode( ',', $accept );
2274 foreach ( $parts as $part ) {
2275 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2276 $values = explode( ';', trim( $part ) );
2278 if ( count( $values ) == 1 ) {
2279 $prefs[$values[0]] = 1.0;
2280 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2281 $prefs[$values[0]] = floatval( $match[1] );
2289 * Checks if a given MIME type matches any of the keys in the given
2290 * array. Basic wildcards are accepted in the array keys.
2292 * Returns the matching MIME type (or wildcard) if a match, otherwise
2295 * @param $type String
2296 * @param $avail Array
2300 function mimeTypeMatch( $type, $avail ) {
2301 if ( array_key_exists( $type, $avail ) ) {
2304 $parts = explode( '/', $type );
2305 if ( array_key_exists( $parts[0] . '/*', $avail ) ) {
2306 return $parts[0] . '/*';
2307 } elseif ( array_key_exists( '*/*', $avail ) ) {
2316 * Returns the 'best' match between a client's requested internet media types
2317 * and the server's list of available types. Each list should be an associative
2318 * array of type to preference (preference is a float between 0.0 and 1.0).
2319 * Wildcards in the types are acceptable.
2321 * @param array $cprefs client's acceptable type list
2322 * @param array $sprefs server's offered types
2325 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2326 * XXX: generalize to negotiate other stuff
2328 function wfNegotiateType( $cprefs, $sprefs ) {
2331 foreach ( array_keys( $sprefs ) as $type ) {
2332 $parts = explode( '/', $type );
2333 if ( $parts[1] != '*' ) {
2334 $ckey = mimeTypeMatch( $type, $cprefs );
2336 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2341 foreach ( array_keys( $cprefs ) as $type ) {
2342 $parts = explode( '/', $type );
2343 if ( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2344 $skey = mimeTypeMatch( $type, $sprefs );
2346 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2354 foreach ( array_keys( $combine ) as $type ) {
2355 if ( $combine[$type] > $bestq ) {
2357 $bestq = $combine[$type];
2365 * Reference-counted warning suppression
2369 function wfSuppressWarnings( $end = false ) {
2370 static $suppressCount = 0;
2371 static $originalLevel = false;
2374 if ( $suppressCount ) {
2376 if ( !$suppressCount ) {
2377 error_reporting( $originalLevel );
2381 if ( !$suppressCount ) {
2382 $originalLevel = error_reporting( E_ALL
& ~
(
2397 * Restore error level to previous value
2399 function wfRestoreWarnings() {
2400 wfSuppressWarnings( true );
2403 # Autodetect, convert and provide timestamps of various types
2406 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2408 define( 'TS_UNIX', 0 );
2411 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2413 define( 'TS_MW', 1 );
2416 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2418 define( 'TS_DB', 2 );
2421 * RFC 2822 format, for E-mail and HTTP headers
2423 define( 'TS_RFC2822', 3 );
2426 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2428 * This is used by Special:Export
2430 define( 'TS_ISO_8601', 4 );
2433 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2435 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2436 * DateTime tag and page 36 for the DateTimeOriginal and
2437 * DateTimeDigitized tags.
2439 define( 'TS_EXIF', 5 );
2442 * Oracle format time.
2444 define( 'TS_ORACLE', 6 );
2447 * Postgres format time.
2449 define( 'TS_POSTGRES', 7 );
2452 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2454 define( 'TS_ISO_8601_BASIC', 9 );
2457 * Get a timestamp string in one of various formats
2459 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2460 * function will autodetect which format is supplied and act
2462 * @param $ts Mixed: optional timestamp to convert, default 0 for the current time
2463 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2465 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2467 $timestamp = new MWTimestamp( $ts );
2468 return $timestamp->getTimestamp( $outputtype );
2469 } catch ( TimestampException
$e ) {
2470 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2476 * Return a formatted timestamp, or null if input is null.
2477 * For dealing with nullable timestamp columns in the database.
2479 * @param $outputtype Integer
2483 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2484 if ( is_null( $ts ) ) {
2487 return wfTimestamp( $outputtype, $ts );
2492 * Convenience function; returns MediaWiki timestamp for the present time.
2496 function wfTimestampNow() {
2498 return wfTimestamp( TS_MW
, time() );
2502 * Check if the operating system is Windows
2504 * @return Bool: true if it's Windows, False otherwise.
2506 function wfIsWindows() {
2507 static $isWindows = null;
2508 if ( $isWindows === null ) {
2509 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2515 * Check if we are running under HHVM
2519 function wfIsHHVM() {
2520 return defined( 'HHVM_VERSION' );
2524 * Swap two variables
2529 function swap( &$x, &$y ) {
2536 * Tries to get the system directory for temporary files. First
2537 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2538 * environment variables are then checked in sequence, and if none are
2539 * set try sys_get_temp_dir().
2541 * NOTE: When possible, use instead the tmpfile() function to create
2542 * temporary files to avoid race conditions on file creation, etc.
2546 function wfTempDir() {
2547 global $wgTmpDirectory;
2549 if ( $wgTmpDirectory !== false ) {
2550 return $wgTmpDirectory;
2553 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2555 foreach ( $tmpDir as $tmp ) {
2556 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2560 return sys_get_temp_dir();
2564 * Make directory, and make all parent directories if they don't exist
2566 * @param string $dir full path to directory to create
2567 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2568 * @param string $caller optional caller param for debugging.
2569 * @throws MWException
2572 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2573 global $wgDirectoryMode;
2575 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2576 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2579 if ( !is_null( $caller ) ) {
2580 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2583 if ( strval( $dir ) === '' ||
( file_exists( $dir ) && is_dir( $dir ) ) ) {
2587 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2589 if ( is_null( $mode ) ) {
2590 $mode = $wgDirectoryMode;
2593 // Turn off the normal warning, we're doing our own below
2594 wfSuppressWarnings();
2595 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2596 wfRestoreWarnings();
2599 //directory may have been created on another request since we last checked
2600 if ( is_dir( $dir ) ) {
2604 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2605 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2611 * Remove a directory and all its content.
2612 * Does not hide error.
2614 function wfRecursiveRemoveDir( $dir ) {
2615 wfDebug( __FUNCTION__
. "( $dir )\n" );
2616 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2617 if ( is_dir( $dir ) ) {
2618 $objects = scandir( $dir );
2619 foreach ( $objects as $object ) {
2620 if ( $object != "." && $object != ".." ) {
2621 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2622 wfRecursiveRemoveDir( $dir . '/' . $object );
2624 unlink( $dir . '/' . $object );
2634 * @param $nr Mixed: the number to format
2635 * @param $acc Integer: the number of digits after the decimal point, default 2
2636 * @param $round Boolean: whether or not to round the value, default true
2639 function wfPercent( $nr, $acc = 2, $round = true ) {
2640 $ret = sprintf( "%.${acc}f", $nr );
2641 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2645 * Safety wrapper around ini_get() for boolean settings.
2646 * The values returned from ini_get() are pre-normalized for settings
2647 * set via php.ini or php_flag/php_admin_flag... but *not*
2648 * for those set via php_value/php_admin_value.
2650 * It's fairly common for people to use php_value instead of php_flag,
2651 * which can leave you with an 'off' setting giving a false positive
2652 * for code that just takes the ini_get() return value as a boolean.
2654 * To make things extra interesting, setting via php_value accepts
2655 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2656 * Unrecognized values go false... again opposite PHP's own coercion
2657 * from string to bool.
2659 * Luckily, 'properly' set settings will always come back as '0' or '1',
2660 * so we only have to worry about them and the 'improper' settings.
2662 * I frickin' hate PHP... :P
2664 * @param $setting String
2667 function wfIniGetBool( $setting ) {
2668 $val = strtolower( ini_get( $setting ) );
2669 // 'on' and 'true' can't have whitespace around them, but '1' can.
2673 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2677 * Windows-compatible version of escapeshellarg()
2678 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2679 * function puts single quotes in regardless of OS.
2681 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2682 * earlier distro releases of PHP)
2687 function wfEscapeShellArg() {
2688 wfInitShellLocale();
2690 $args = func_get_args();
2693 foreach ( $args as $arg ) {
2700 if ( wfIsWindows() ) {
2701 // Escaping for an MSVC-style command line parser and CMD.EXE
2702 // @codingStandardsIgnoreStart For long URLs
2704 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2705 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2708 // Double the backslashes before any double quotes. Escape the double quotes.
2709 // @codingStandardsIgnoreEnd
2710 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2713 foreach ( $tokens as $token ) {
2714 if ( $iteration %
2 == 1 ) {
2715 // Delimiter, a double quote preceded by zero or more slashes
2716 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2717 } elseif ( $iteration %
4 == 2 ) {
2718 // ^ in $token will be outside quotes, need to be escaped
2719 $arg .= str_replace( '^', '^^', $token );
2720 } else { // $iteration % 4 == 0
2721 // ^ in $token will appear inside double quotes, so leave as is
2726 // Double the backslashes before the end of the string, because
2727 // we will soon add a quote
2729 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2730 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2733 // Add surrounding quotes
2734 $retVal .= '"' . $arg . '"';
2736 $retVal .= escapeshellarg( $arg );
2743 * Check if wfShellExec() is effectively disabled via php.ini config
2744 * @return bool|string False or one of (safemode,disabled)
2747 function wfShellExecDisabled() {
2748 static $disabled = null;
2749 if ( is_null( $disabled ) ) {
2751 if ( wfIniGetBool( 'safe_mode' ) ) {
2752 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2753 $disabled = 'safemode';
2755 $functions = explode( ',', ini_get( 'disable_functions' ) );
2756 $functions = array_map( 'trim', $functions );
2757 $functions = array_map( 'strtolower', $functions );
2758 if ( in_array( 'proc_open', $functions ) ) {
2759 wfDebug( "proc_open is in disabled_functions\n" );
2760 $disabled = 'disabled';
2768 * Execute a shell command, with time and memory limits mirrored from the PHP
2769 * configuration if supported.
2770 * @param string $cmd Command line, properly escaped for shell.
2771 * @param &$retval null|Mixed optional, will receive the program's exit code.
2772 * (non-zero is usually failure). If there is an error from
2773 * read, select, or proc_open(), this will be set to -1.
2774 * @param array $environ optional environment variables which should be
2775 * added to the executed command environment.
2776 * @param array $limits optional array with limits(filesize, memory, time, walltime)
2777 * this overwrites the global wgMaxShell* limits.
2778 * @param array $options Array of options:
2779 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2780 * including errors from limit.sh
2782 * @return string collected stdout as a string
2784 function wfShellExec( $cmd, &$retval = null, $environ = array(),
2785 $limits = array(), $options = array()
2787 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2788 $wgMaxShellWallClockTime, $wgShellCgroup;
2790 $disabled = wfShellExecDisabled();
2793 return $disabled == 'safemode' ?
2794 'Unable to run external programs in safe mode.' :
2795 'Unable to run external programs, proc_open() is disabled.';
2798 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2800 wfInitShellLocale();
2803 foreach ( $environ as $k => $v ) {
2804 if ( wfIsWindows() ) {
2805 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2806 * appear in the environment variable, so we must use carat escaping as documented in
2807 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2808 * Note however that the quote isn't listed there, but is needed, and the parentheses
2809 * are listed there but doesn't appear to need it.
2811 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2813 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2814 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2816 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2819 $cmd = $envcmd . $cmd;
2821 $useLogPipe = false;
2822 if ( php_uname( 's' ) == 'Linux' ) {
2823 $time = intval ( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2824 if ( isset( $limits['walltime'] ) ) {
2825 $wallTime = intval( $limits['walltime'] );
2826 } elseif ( isset( $limits['time'] ) ) {
2829 $wallTime = intval( $wgMaxShellWallClockTime );
2831 $mem = intval ( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2832 $filesize = intval ( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2834 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2835 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2836 escapeshellarg( $cmd ) . ' ' .
2838 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2839 "MW_CPU_LIMIT=$time; " .
2840 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2841 "MW_MEM_LIMIT=$mem; " .
2842 "MW_FILE_SIZE_LIMIT=$filesize; " .
2843 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2844 "MW_USE_LOG_PIPE=yes"
2847 } elseif ( $includeStderr ) {
2850 } elseif ( $includeStderr ) {
2853 wfDebug( "wfShellExec: $cmd\n" );
2856 0 => array( 'file', 'php://stdin', 'r' ),
2857 1 => array( 'pipe', 'w' ),
2858 2 => array( 'file', 'php://stderr', 'w' ) );
2859 if ( $useLogPipe ) {
2860 $desc[3] = array( 'pipe', 'w' );
2863 # TODO/FIXME: This is a bad hack to workaround an HHVM bug that prevents
2864 # proc_open() from opening stdin/stdout, so use /dev/null *for now*
2865 # See bug 56597 / https://github.com/facebook/hhvm/issues/1247 for more info
2867 $desc[0] = array( 'file', '/dev/null', 'r' );
2868 $desc[2] = array( 'file', '/dev/null', 'w' );
2872 $proc = proc_open( $cmd, $desc, $pipes );
2874 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2878 $outBuffer = $logBuffer = '';
2879 $emptyArray = array();
2883 // According to the documentation, it is possible for stream_select()
2884 // to fail due to EINTR. I haven't managed to induce this in testing
2885 // despite sending various signals. If it did happen, the error
2886 // message would take the form:
2888 // stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2890 // where [4] is the value of the macro EINTR and "Interrupted system
2891 // call" is string which according to the Linux manual is "possibly"
2892 // localised according to LC_MESSAGES.
2893 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2894 $eintrMessage = "stream_select(): unable to select [$eintr]";
2896 // Build a table mapping resource IDs to pipe FDs to work around a
2897 // PHP 5.3 issue in which stream_select() does not preserve array keys
2898 // <https://bugs.php.net/bug.php?id=53427>.
2900 foreach ( $pipes as $fd => $pipe ) {
2901 $fds[(int)$pipe] = $fd;
2905 $status = proc_get_status( $proc );
2906 if ( !$status['running'] ) {
2911 $readyPipes = $pipes;
2914 @trigger_error
( '' );
2915 if ( @stream_select
( $readyPipes, $emptyArray, $emptyArray, null ) === false ) {
2916 $error = error_get_last();
2917 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2920 trigger_error( $error['message'], E_USER_WARNING
);
2921 $logMsg = $error['message'];
2925 foreach ( $readyPipes as $pipe ) {
2926 $block = fread( $pipe, 65536 );
2927 $fd = $fds[(int)$pipe];
2928 if ( $block === '' ) {
2930 fclose( $pipes[$fd] );
2931 unset( $pipes[$fd] );
2935 } elseif ( $block === false ) {
2937 $logMsg = "Error reading from pipe";
2939 } elseif ( $fd == 1 ) {
2941 $outBuffer .= $block;
2942 } elseif ( $fd == 3 ) {
2944 $logBuffer .= $block;
2945 if ( strpos( $block, "\n" ) !== false ) {
2946 $lines = explode( "\n", $logBuffer );
2947 $logBuffer = array_pop( $lines );
2948 foreach ( $lines as $line ) {
2949 wfDebugLog( 'exec', $line );
2956 foreach ( $pipes as $pipe ) {
2960 // Use the status previously collected if possible, since proc_get_status()
2961 // just calls waitpid() which will not return anything useful the second time.
2962 if ( $status === false ) {
2963 $status = proc_get_status( $proc );
2966 if ( $logMsg !== false ) {
2967 // Read/select error
2969 proc_close( $proc );
2970 } elseif ( $status['signaled'] ) {
2971 $logMsg = "Exited with signal {$status['termsig']}";
2972 $retval = 128 +
$status['termsig'];
2973 proc_close( $proc );
2975 if ( $status['running'] ) {
2976 $retval = proc_close( $proc );
2978 $retval = $status['exitcode'];
2979 proc_close( $proc );
2981 if ( $retval == 127 ) {
2982 $logMsg = "Possibly missing executable file";
2983 } elseif ( $retval >= 129 && $retval <= 192 ) {
2984 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2988 if ( $logMsg !== false ) {
2989 wfDebugLog( 'exec', "$logMsg: $cmd" );
2996 * Execute a shell command, returning both stdout and stderr. Convenience
2997 * function, as all the arguments to wfShellExec can become unwieldy.
2999 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
3000 * @param string $cmd Command line, properly escaped for shell.
3001 * @param &$retval null|Mixed optional, will receive the program's exit code.
3002 * (non-zero is usually failure)
3003 * @param array $environ optional environment variables which should be
3004 * added to the executed command environment.
3005 * @param array $limits optional array with limits(filesize, memory, time, walltime)
3006 * this overwrites the global wgShellMax* limits.
3007 * @return string collected stdout and stderr as a string
3009 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
3010 return wfShellExec( $cmd, $retval, $environ, $limits, array( 'duplicateStderr' => true ) );
3014 * Workaround for http://bugs.php.net/bug.php?id=45132
3015 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
3017 function wfInitShellLocale() {
3018 static $done = false;
3023 global $wgShellLocale;
3024 if ( !wfIniGetBool( 'safe_mode' ) ) {
3025 putenv( "LC_CTYPE=$wgShellLocale" );
3026 setlocale( LC_CTYPE
, $wgShellLocale );
3031 * Alias to wfShellWikiCmd()
3032 * @see wfShellWikiCmd()
3034 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
3035 return wfShellWikiCmd( $script, $parameters, $options );
3039 * Generate a shell-escaped command line string to run a MediaWiki cli script.
3040 * Note that $parameters should be a flat array and an option with an argument
3041 * should consist of two consecutive items in the array (do not use "--option value").
3042 * @param string $script MediaWiki cli script path
3043 * @param array $parameters Arguments and options to the script
3044 * @param array $options Associative array of options:
3045 * 'php': The path to the php executable
3046 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
3049 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
3051 // Give site config file a chance to run the script in a wrapper.
3052 // The caller may likely want to call wfBasename() on $script.
3053 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
3054 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
3055 if ( isset( $options['wrapper'] ) ) {
3056 $cmd[] = $options['wrapper'];
3059 // Escape each parameter for shell
3060 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
3064 * wfMerge attempts to merge differences between three texts.
3065 * Returns true for a clean merge and false for failure or a conflict.
3067 * @param $old String
3068 * @param $mine String
3069 * @param $yours String
3070 * @param $result String
3073 function wfMerge( $old, $mine, $yours, &$result ) {
3076 # This check may also protect against code injection in
3077 # case of broken installations.
3078 wfSuppressWarnings();
3079 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
3080 wfRestoreWarnings();
3082 if ( !$haveDiff3 ) {
3083 wfDebug( "diff3 not found\n" );
3087 # Make temporary files
3089 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3090 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
3091 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
3093 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
3094 # a newline character. To avoid this, we normalize the trailing whitespace before
3095 # creating the diff.
3097 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
3098 fclose( $oldtextFile );
3099 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
3100 fclose( $mytextFile );
3101 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
3102 fclose( $yourtextFile );
3104 # Check for a conflict
3105 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
3106 wfEscapeShellArg( $mytextName ) . ' ' .
3107 wfEscapeShellArg( $oldtextName ) . ' ' .
3108 wfEscapeShellArg( $yourtextName );
3109 $handle = popen( $cmd, 'r' );
3111 if ( fgets( $handle, 1024 ) ) {
3119 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
3120 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
3121 $handle = popen( $cmd, 'r' );
3124 $data = fread( $handle, 8192 );
3125 if ( strlen( $data ) == 0 ) {
3131 unlink( $mytextName );
3132 unlink( $oldtextName );
3133 unlink( $yourtextName );
3135 if ( $result === '' && $old !== '' && !$conflict ) {
3136 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
3143 * Returns unified plain-text diff of two texts.
3144 * Useful for machine processing of diffs.
3146 * @param string $before the text before the changes.
3147 * @param string $after the text after the changes.
3148 * @param string $params command-line options for the diff command.
3149 * @return String: unified diff of $before and $after
3151 function wfDiff( $before, $after, $params = '-u' ) {
3152 if ( $before == $after ) {
3157 wfSuppressWarnings();
3158 $haveDiff = $wgDiff && file_exists( $wgDiff );
3159 wfRestoreWarnings();
3161 # This check may also protect against code injection in
3162 # case of broken installations.
3164 wfDebug( "diff executable not found\n" );
3165 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3166 $format = new UnifiedDiffFormatter();
3167 return $format->format( $diffs );
3170 # Make temporary files
3172 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3173 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3175 fwrite( $oldtextFile, $before );
3176 fclose( $oldtextFile );
3177 fwrite( $newtextFile, $after );
3178 fclose( $newtextFile );
3180 // Get the diff of the two files
3181 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3183 $h = popen( $cmd, 'r' );
3188 $data = fread( $h, 8192 );
3189 if ( strlen( $data ) == 0 ) {
3197 unlink( $oldtextName );
3198 unlink( $newtextName );
3200 // Kill the --- and +++ lines. They're not useful.
3201 $diff_lines = explode( "\n", $diff );
3202 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3203 unset( $diff_lines[0] );
3205 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3206 unset( $diff_lines[1] );
3209 $diff = implode( "\n", $diff_lines );
3215 * This function works like "use VERSION" in Perl, the program will die with a
3216 * backtrace if the current version of PHP is less than the version provided
3218 * This is useful for extensions which due to their nature are not kept in sync
3219 * with releases, and might depend on other versions of PHP than the main code
3221 * Note: PHP might die due to parsing errors in some cases before it ever
3222 * manages to call this function, such is life
3224 * @see perldoc -f use
3226 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3228 * @throws MWException
3230 function wfUsePHP( $req_ver ) {
3231 $php_ver = PHP_VERSION
;
3233 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3234 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3239 * This function works like "use VERSION" in Perl except it checks the version
3240 * of MediaWiki, the program will die with a backtrace if the current version
3241 * of MediaWiki is less than the version provided.
3243 * This is useful for extensions which due to their nature are not kept in sync
3246 * Note: Due to the behavior of PHP's version_compare() which is used in this
3247 * function, if you want to allow the 'wmf' development versions add a 'c' (or
3248 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
3249 * targeted version number. For example if you wanted to allow any variation
3250 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
3251 * not result in the same comparison due to the internal logic of
3252 * version_compare().
3254 * @see perldoc -f use
3256 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3258 * @throws MWException
3260 function wfUseMW( $req_ver ) {
3263 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3264 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3269 * Return the final portion of a pathname.
3270 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3271 * http://bugs.php.net/bug.php?id=33898
3273 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3274 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3276 * @param $path String
3277 * @param string $suffix to remove if present
3280 function wfBaseName( $path, $suffix = '' ) {
3281 if ( $suffix == '' ) {
3284 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
3288 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3296 * Generate a relative path name to the given file.
3297 * May explode on non-matching case-insensitive paths,
3298 * funky symlinks, etc.
3300 * @param string $path absolute destination path including target filename
3301 * @param string $from Absolute source path, directory only
3304 function wfRelativePath( $path, $from ) {
3305 // Normalize mixed input on Windows...
3306 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3307 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3309 // Trim trailing slashes -- fix for drive root
3310 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3311 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3313 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3314 $against = explode( DIRECTORY_SEPARATOR
, $from );
3316 if ( $pieces[0] !== $against[0] ) {
3317 // Non-matching Windows drive letters?
3318 // Return a full path.
3322 // Trim off common prefix
3323 while ( count( $pieces ) && count( $against )
3324 && $pieces[0] == $against[0] ) {
3325 array_shift( $pieces );
3326 array_shift( $against );
3329 // relative dots to bump us to the parent
3330 while ( count( $against ) ) {
3331 array_unshift( $pieces, '..' );
3332 array_shift( $against );
3335 array_push( $pieces, wfBaseName( $path ) );
3337 return implode( DIRECTORY_SEPARATOR
, $pieces );
3341 * Convert an arbitrarily-long digit string from one numeric base
3342 * to another, optionally zero-padding to a minimum column width.
3344 * Supports base 2 through 36; digit values 10-36 are represented
3345 * as lowercase letters a-z. Input is case-insensitive.
3347 * @param string $input Input number
3348 * @param int $sourceBase Base of the input number
3349 * @param int $destBase Desired base of the output
3350 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3351 * @param bool $lowercase Whether to output in lowercase or uppercase
3352 * @param string $engine Either "gmp", "bcmath", or "php"
3353 * @return string|bool The output number as a string, or false on error
3355 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
3356 $lowercase = true, $engine = 'auto'
3358 $input = (string)$input;
3364 $sourceBase != (int)$sourceBase ||
3365 $destBase != (int)$destBase ||
3366 $pad != (int)$pad ||
3368 "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i",
3375 static $baseChars = array(
3376 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3377 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3378 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3379 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3380 34 => 'y', 35 => 'z',
3382 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3383 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3384 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3385 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3386 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3387 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3390 if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3391 $result = gmp_strval( gmp_init( $input, $sourceBase ), $destBase );
3392 } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3394 foreach ( str_split( strtolower( $input ) ) as $char ) {
3395 $decimal = bcmul( $decimal, $sourceBase );
3396 $decimal = bcadd( $decimal, $baseChars[$char] );
3399 for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3400 $result .= $baseChars[bcmod( $decimal, $destBase )];
3403 $result = strrev( $result );
3405 $inDigits = array();
3406 foreach ( str_split( strtolower( $input ) ) as $char ) {
3407 $inDigits[] = $baseChars[$char];
3410 // Iterate over the input, modulo-ing out an output digit
3411 // at a time until input is gone.
3413 while ( $inDigits ) {
3415 $workDigits = array();
3418 foreach ( $inDigits as $digit ) {
3419 $work *= $sourceBase;
3422 if ( $workDigits ||
$work >= $destBase ) {
3423 $workDigits[] = (int)( $work / $destBase );
3428 // All that division leaves us with a remainder,
3429 // which is conveniently our next output digit.
3430 $result .= $baseChars[$work];
3433 $inDigits = $workDigits;
3436 $result = strrev( $result );
3439 if ( !$lowercase ) {
3440 $result = strtoupper( $result );
3443 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3449 function wfHttpOnlySafe() {
3450 global $wgHttpOnlyBlacklist;
3452 if ( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3453 foreach ( $wgHttpOnlyBlacklist as $regex ) {
3454 if ( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3464 * Check if there is sufficient entropy in php's built-in session generation
3465 * @return bool true = there is sufficient entropy
3467 function wfCheckEntropy() {
3469 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3470 ||
ini_get( 'session.entropy_file' )
3472 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3476 * Override session_id before session startup if php's built-in
3477 * session generation code is not secure.
3479 function wfFixSessionID() {
3480 // If the cookie or session id is already set we already have a session and should abort
3481 if ( isset( $_COOKIE[session_name()] ) ||
session_id() ) {
3485 // PHP's built-in session entropy is enabled if:
3486 // - entropy_file is set or you're on Windows with php 5.3.3+
3487 // - AND entropy_length is > 0
3488 // We treat it as disabled if it doesn't have an entropy length of at least 32
3489 $entropyEnabled = wfCheckEntropy();
3491 // If built-in entropy is not enabled or not sufficient override PHP's
3492 // built in session id generation code
3493 if ( !$entropyEnabled ) {
3494 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, " .
3495 "overriding session id generation using our cryptrand source.\n" );
3496 session_id( MWCryptRand
::generateHex( 32 ) );
3501 * Reset the session_id
3504 function wfResetSessionID() {
3505 global $wgCookieSecure;
3506 $oldSessionId = session_id();
3507 $cookieParams = session_get_cookie_params();
3508 if ( wfCheckEntropy() && $wgCookieSecure == $cookieParams['secure'] ) {
3509 session_regenerate_id( false );
3513 wfSetupSession( MWCryptRand
::generateHex( 32 ) );
3516 $newSessionId = session_id();
3517 wfRunHooks( 'ResetSessionID', array( $oldSessionId, $newSessionId ) );
3521 * Initialise php session
3523 * @param $sessionId Bool
3525 function wfSetupSession( $sessionId = false ) {
3526 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3527 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3528 if ( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3529 ObjectCacheSessionHandler
::install();
3530 } elseif ( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3531 # Only set this if $wgSessionHandler isn't null and session.save_handler
3532 # hasn't already been set to the desired value (that causes errors)
3533 ini_set( 'session.save_handler', $wgSessionHandler );
3535 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3536 wfDebugLog( 'cookie',
3537 'session_set_cookie_params: "' . implode( '", "',
3543 $httpOnlySafe ) ) . '"' );
3544 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3545 session_cache_limiter( 'private, must-revalidate' );
3547 session_id( $sessionId );
3551 wfSuppressWarnings();
3553 wfRestoreWarnings();
3557 * Get an object from the precompiled serialized directory
3559 * @param $name String
3560 * @return Mixed: the variable on success, false on failure
3562 function wfGetPrecompiledData( $name ) {
3565 $file = "$IP/serialized/$name";
3566 if ( file_exists( $file ) ) {
3567 $blob = file_get_contents( $file );
3569 return unserialize( $blob );
3581 function wfMemcKey( /*... */ ) {
3582 global $wgCachePrefix;
3583 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3584 $args = func_get_args();
3585 $key = $prefix . ':' . implode( ':', $args );
3586 $key = str_replace( ' ', '_', $key );
3591 * Get a cache key for a foreign DB
3594 * @param $prefix String
3595 * @param varargs String
3598 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3599 $args = array_slice( func_get_args(), 2 );
3601 $key = "$db-$prefix:" . implode( ':', $args );
3603 $key = $db . ':' . implode( ':', $args );
3605 return str_replace( ' ', '_', $key );
3609 * Get an ASCII string identifying this wiki
3610 * This is used as a prefix in memcached keys
3614 function wfWikiID() {
3615 global $wgDBprefix, $wgDBname;
3616 if ( $wgDBprefix ) {
3617 return "$wgDBname-$wgDBprefix";
3624 * Split a wiki ID into DB name and table prefix
3626 * @param $wiki String
3630 function wfSplitWikiID( $wiki ) {
3631 $bits = explode( '-', $wiki, 2 );
3632 if ( count( $bits ) < 2 ) {
3639 * Get a Database object.
3641 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3642 * master (for write queries), DB_SLAVE for potentially lagged read
3643 * queries, or an integer >= 0 for a particular server.
3645 * @param $groups Mixed: query groups. An array of group names that this query
3646 * belongs to. May contain a single string if the query is only
3649 * @param string $wiki the wiki ID, or false for the current wiki
3651 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3652 * will always return the same object, unless the underlying connection or load
3653 * balancer is manually destroyed.
3655 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3656 * updater to ensure that a proper database is being updated.
3658 * @return DatabaseBase
3660 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3661 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3665 * Get a load balancer object.
3667 * @param string $wiki wiki ID, or false for the current wiki
3668 * @return LoadBalancer
3670 function wfGetLB( $wiki = false ) {
3671 return wfGetLBFactory()->getMainLB( $wiki );
3675 * Get the load balancer factory object
3679 function &wfGetLBFactory() {
3680 return LBFactory
::singleton();
3685 * Shortcut for RepoGroup::singleton()->findFile()
3687 * @param string $title or Title object
3688 * @param array $options Associative array of options:
3689 * time: requested time for an archived image, or false for the
3690 * current version. An image object will be returned which was
3691 * created at the specified time.
3693 * ignoreRedirect: If true, do not follow file redirects
3695 * private: If true, return restricted (deleted) files if the current
3696 * user is allowed to view them. Otherwise, such files will not
3699 * bypassCache: If true, do not use the process-local cache of File objects
3701 * @return File, or false if the file does not exist
3703 function wfFindFile( $title, $options = array() ) {
3704 return RepoGroup
::singleton()->findFile( $title, $options );
3708 * Get an object referring to a locally registered file.
3709 * Returns a valid placeholder object if the file does not exist.
3711 * @param $title Title|String
3712 * @return LocalFile|null A File, or null if passed an invalid Title
3714 function wfLocalFile( $title ) {
3715 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3719 * Should low-performance queries be disabled?
3722 * @codeCoverageIgnore
3724 function wfQueriesMustScale() {
3725 global $wgMiserMode;
3727 ||
( SiteStats
::pages() > 100000
3728 && SiteStats
::edits() > 1000000
3729 && SiteStats
::users() > 10000 );
3733 * Get the path to a specified script file, respecting file
3734 * extensions; this is a wrapper around $wgScriptExtension etc.
3735 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3737 * @param string $script script filename, sans extension
3740 function wfScript( $script = 'index' ) {
3741 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3742 if ( $script === 'index' ) {
3744 } elseif ( $script === 'load' ) {
3745 return $wgLoadScript;
3747 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3752 * Get the script URL.
3754 * @return string script URL
3756 function wfGetScriptUrl() {
3757 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3759 # as it was called, minus the query string.
3761 # Some sites use Apache rewrite rules to handle subdomains,
3762 # and have PHP set up in a weird way that causes PHP_SELF
3763 # to contain the rewritten URL instead of the one that the
3764 # outside world sees.
3766 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3767 # provides containing the "before" URL.
3768 return $_SERVER['SCRIPT_NAME'];
3770 return $_SERVER['URL'];
3775 * Convenience function converts boolean values into "true"
3776 * or "false" (string) values
3778 * @param $value Boolean
3781 function wfBoolToStr( $value ) {
3782 return $value ?
'true' : 'false';
3786 * Get a platform-independent path to the null file, e.g. /dev/null
3790 function wfGetNull() {
3791 return wfIsWindows() ?
'NUL' : '/dev/null';
3795 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3796 * and waiting for it to go down, this waits for the slaves to catch up to the
3797 * master position. Use this when updating very large numbers of rows, as
3798 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3799 * a no-op if there are no slaves.
3801 * @param int|bool $maxLag (deprecated)
3802 * @param mixed $wiki Wiki identifier accepted by wfGetLB
3803 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3805 function wfWaitForSlaves( $maxLag = false, $wiki = false, $cluster = false ) {
3806 if ( $cluster !== false ) {
3807 $lb = wfGetLBFactory()->getExternalLB( $cluster );
3809 $lb = wfGetLB( $wiki );
3812 // bug 27975 - Don't try to wait for slaves if there are none
3813 // Prevents permission error when getting master position
3814 if ( $lb->getServerCount() > 1 ) {
3815 $dbw = $lb->getConnection( DB_MASTER
, array(), $wiki );
3816 $pos = $dbw->getMasterPos();
3817 // The DBMS may not support getMasterPos() or the whole
3818 // load balancer might be fake (e.g. $wgAllDBsAreLocalhost).
3819 if ( $pos !== false ) {
3820 $lb->waitForAll( $pos );
3826 * Count down from $n to zero on the terminal, with a one-second pause
3827 * between showing each number. For use in command-line scripts.
3828 * @codeCoverageIgnore
3831 function wfCountDown( $n ) {
3832 for ( $i = $n; $i >= 0; $i-- ) {
3834 echo str_repeat( "\x08", strlen( $i +
1 ) );
3846 * Replace all invalid characters with -
3847 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3848 * By default, $wgIllegalFileChars = ':'
3850 * @param $name Mixed: filename to process
3853 function wfStripIllegalFilenameChars( $name ) {
3854 global $wgIllegalFileChars;
3855 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3856 $name = wfBaseName( $name );
3857 $name = preg_replace(
3858 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3866 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3868 * @return Integer value memory was set to.
3870 function wfMemoryLimit() {
3871 global $wgMemoryLimit;
3872 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3873 if ( $memlimit != -1 ) {
3874 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3875 if ( $conflimit == -1 ) {
3876 wfDebug( "Removing PHP's memory limit\n" );
3877 wfSuppressWarnings();
3878 ini_set( 'memory_limit', $conflimit );
3879 wfRestoreWarnings();
3881 } elseif ( $conflimit > $memlimit ) {
3882 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3883 wfSuppressWarnings();
3884 ini_set( 'memory_limit', $conflimit );
3885 wfRestoreWarnings();
3893 * Converts shorthand byte notation to integer form
3895 * @param $string String
3898 function wfShorthandToInteger( $string = '' ) {
3899 $string = trim( $string );
3900 if ( $string === '' ) {
3903 $last = $string[strlen( $string ) - 1];
3904 $val = intval( $string );
3909 // break intentionally missing
3913 // break intentionally missing
3923 * Get the normalised IETF language tag
3924 * See unit test for examples.
3926 * @param string $code The language code.
3927 * @return String: The language code which complying with BCP 47 standards.
3929 function wfBCP47( $code ) {
3930 $codeSegment = explode( '-', $code );
3932 foreach ( $codeSegment as $segNo => $seg ) {
3933 // when previous segment is x, it is a private segment and should be lc
3934 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3935 $codeBCP[$segNo] = strtolower( $seg );
3936 // ISO 3166 country code
3937 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3938 $codeBCP[$segNo] = strtoupper( $seg );
3939 // ISO 15924 script code
3940 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3941 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3942 // Use lowercase for other cases
3944 $codeBCP[$segNo] = strtolower( $seg );
3947 $langCode = implode( '-', $codeBCP );
3952 * Get a cache object.
3954 * @param $inputType integer Cache type, one the the CACHE_* constants.
3957 function wfGetCache( $inputType ) {
3958 return ObjectCache
::getInstance( $inputType );
3962 * Get the main cache object
3966 function wfGetMainCache() {
3967 global $wgMainCacheType;
3968 return ObjectCache
::getInstance( $wgMainCacheType );
3972 * Get the cache object used by the message cache
3976 function wfGetMessageCacheStorage() {
3977 global $wgMessageCacheType;
3978 return ObjectCache
::getInstance( $wgMessageCacheType );
3982 * Get the cache object used by the parser cache
3986 function wfGetParserCacheStorage() {
3987 global $wgParserCacheType;
3988 return ObjectCache
::getInstance( $wgParserCacheType );
3992 * Get the cache object used by the language converter
3996 function wfGetLangConverterCacheStorage() {
3997 global $wgLanguageConverterCacheType;
3998 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
4002 * Call hook functions defined in $wgHooks
4004 * @param string $event event name
4005 * @param array $args parameters passed to hook functions
4006 * @param string|null $deprecatedVersion optionally mark hook as deprecated with version number
4008 * @return Boolean True if no handler aborted the hook
4010 function wfRunHooks( $event, array $args = array(), $deprecatedVersion = null ) {
4011 return Hooks
::run( $event, $args, $deprecatedVersion );
4015 * Wrapper around php's unpack.
4017 * @param string $format The format string (See php's docs)
4018 * @param $data: A binary string of binary data
4019 * @param $length integer or false: The minimum length of $data. This is to
4020 * prevent reading beyond the end of $data. false to disable the check.
4022 * Also be careful when using this function to read unsigned 32 bit integer
4023 * because php might make it negative.
4025 * @throws MWException if $data not long enough, or if unpack fails
4026 * @return array Associative array of the extracted data
4028 function wfUnpack( $format, $data, $length = false ) {
4029 if ( $length !== false ) {
4030 $realLen = strlen( $data );
4031 if ( $realLen < $length ) {
4032 throw new MWException( "Tried to use wfUnpack on a "
4033 . "string of length $realLen, but needed one "
4034 . "of at least length $length."
4039 wfSuppressWarnings();
4040 $result = unpack( $format, $data );
4041 wfRestoreWarnings();
4043 if ( $result === false ) {
4044 // If it cannot extract the packed data.
4045 throw new MWException( "unpack could not unpack binary data" );
4051 * Determine if an image exists on the 'bad image list'.
4053 * The format of MediaWiki:Bad_image_list is as follows:
4054 * * Only list items (lines starting with "*") are considered
4055 * * The first link on a line must be a link to a bad image
4056 * * Any subsequent links on the same line are considered to be exceptions,
4057 * i.e. articles where the image may occur inline.
4059 * @param string $name the image name to check
4060 * @param $contextTitle Title|bool the page on which the image occurs, if known
4061 * @param string $blacklist wikitext of a file blacklist
4064 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
4065 static $badImageCache = null; // based on bad_image_list msg
4066 wfProfileIn( __METHOD__
);
4069 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
4070 if ( $redirectTitle ) {
4071 $name = $redirectTitle->getDBkey();
4074 # Run the extension hook
4076 if ( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
4077 wfProfileOut( __METHOD__
);
4081 $cacheable = ( $blacklist === null );
4082 if ( $cacheable && $badImageCache !== null ) {
4083 $badImages = $badImageCache;
4084 } else { // cache miss
4085 if ( $blacklist === null ) {
4086 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
4088 # Build the list now
4089 $badImages = array();
4090 $lines = explode( "\n", $blacklist );
4091 foreach ( $lines as $line ) {
4093 if ( substr( $line, 0, 1 ) !== '*' ) {
4099 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
4103 $exceptions = array();
4104 $imageDBkey = false;
4105 foreach ( $m[1] as $i => $titleText ) {
4106 $title = Title
::newFromText( $titleText );
4107 if ( !is_null( $title ) ) {
4109 $imageDBkey = $title->getDBkey();
4111 $exceptions[$title->getPrefixedDBkey()] = true;
4116 if ( $imageDBkey !== false ) {
4117 $badImages[$imageDBkey] = $exceptions;
4121 $badImageCache = $badImages;
4125 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
4126 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
4127 wfProfileOut( __METHOD__
);
4132 * Determine whether the client at a given source IP is likely to be able to
4133 * access the wiki via HTTPS.
4135 * @param string $ip The IPv4/6 address in the normal human-readable form
4138 function wfCanIPUseHTTPS( $ip ) {
4140 wfRunHooks( 'CanIPUseHTTPS', array( $ip, &$canDo ) );
4145 * Work out the IP address based on various globals
4146 * For trusted proxies, use the XFF client IP (first of the chain)
4148 * @deprecated in 1.19; call $wgRequest->getIP() directly.
4151 function wfGetIP() {
4152 wfDeprecated( __METHOD__
, '1.19' );
4154 return $wgRequest->getIP();
4158 * Checks if an IP is a trusted proxy provider.
4159 * Useful to tell if X-Forwarded-For data is possibly bogus.
4160 * Squid cache servers for the site are whitelisted.
4165 function wfIsTrustedProxy( $ip ) {
4166 $trusted = wfIsConfiguredProxy( $ip );
4167 wfRunHooks( 'IsTrustedProxy', array( &$ip, &$trusted ) );
4172 * Checks if an IP matches a proxy we've configured.
4175 * @since 1.23 Supports CIDR ranges in $wgSquidServersNoPurge
4177 function wfIsConfiguredProxy( $ip ) {
4178 global $wgSquidServers, $wgSquidServersNoPurge;
4180 // quick check of known proxy servers
4181 $trusted = in_array( $ip, $wgSquidServers )
4182 ||
in_array( $ip, $wgSquidServersNoPurge );
4185 // slightly slower check to see if the ip is listed directly or in a CIDR
4186 // block in $wgSquidServersNoPurge
4187 foreach ( $wgSquidServersNoPurge as $block ) {
4188 if ( strpos( $block, '/' ) !== false && IP
::isInRange( $ip, $block ) ) {