3 * Global functions used everywhere.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
27 // Hide compatibility functions from Doxygen
31 * Compatibility functions
33 * We support PHP 5.3.2 and up.
34 * Re-implementations of newer functions or functions in non-standard
35 * PHP extensions may be included here.
38 if( !function_exists( 'iconv' ) ) {
43 function iconv( $from, $to, $string ) {
44 return Fallback
::iconv( $from, $to, $string );
48 if ( !function_exists( 'mb_substr' ) ) {
53 function mb_substr( $str, $start, $count='end' ) {
54 return Fallback
::mb_substr( $str, $start, $count );
61 function mb_substr_split_unicode( $str, $splitPos ) {
62 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
66 if ( !function_exists( 'mb_strlen' ) ) {
71 function mb_strlen( $str, $enc = '' ) {
72 return Fallback
::mb_strlen( $str, $enc );
76 if( !function_exists( 'mb_strpos' ) ) {
81 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
82 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
87 if( !function_exists( 'mb_strrpos' ) ) {
92 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
93 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
98 // Support for Wietse Venema's taint feature
99 if ( !function_exists( 'istainted' ) ) {
101 * @codeCoverageIgnore
104 function istainted( $var ) {
107 /** @codeCoverageIgnore */
108 function taint( $var, $level = 0 ) {}
109 /** @codeCoverageIgnore */
110 function untaint( $var, $level = 0 ) {}
111 define( 'TC_HTML', 1 );
112 define( 'TC_SHELL', 1 );
113 define( 'TC_MYSQL', 1 );
114 define( 'TC_PCRE', 1 );
115 define( 'TC_SELF', 1 );
120 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
125 function wfArrayDiff2( $a, $b ) {
126 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
134 function wfArrayDiff2_cmp( $a, $b ) {
135 if ( !is_array( $a ) ) {
136 return strcmp( $a, $b );
137 } elseif ( count( $a ) !== count( $b ) ) {
138 return count( $a ) < count( $b ) ?
-1 : 1;
142 while( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
143 $cmp = strcmp( $valueA, $valueB );
154 * Returns an array where the values in the first array are replaced by the
155 * values in the second array with the corresponding keys
161 function wfArrayLookup( $a, $b ) {
162 return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
166 * Appends to second array if $value differs from that in $default
168 * @param $key String|Int
169 * @param $value Mixed
170 * @param $default Mixed
171 * @param $changed Array to alter
172 * @throws MWException
174 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
175 if ( is_null( $changed ) ) {
176 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
178 if ( $default[$key] !== $value ) {
179 $changed[$key] = $value;
184 * Backwards array plus for people who haven't bothered to read the PHP manual
185 * XXX: will not darn your socks for you.
187 * @param $array1 Array
188 * @param [$array2, [...]] Arrays
191 function wfArrayMerge( $array1/* ... */ ) {
192 $args = func_get_args();
193 $args = array_reverse( $args, true );
195 foreach ( $args as $arg ) {
202 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
204 * wfMergeErrorArrays(
205 * array( array( 'x' ) ),
206 * array( array( 'x', '2' ) ),
207 * array( array( 'x' ) ),
208 * array( array( 'y' ) )
219 function wfMergeErrorArrays( /*...*/ ) {
220 $args = func_get_args();
222 foreach ( $args as $errors ) {
223 foreach ( $errors as $params ) {
224 # @todo FIXME: Sometimes get nested arrays for $params,
225 # which leads to E_NOTICEs
226 $spec = implode( "\t", $params );
227 $out[$spec] = $params;
230 return array_values( $out );
234 * Insert array into another array after the specified *KEY*
236 * @param $array Array: The array.
237 * @param $insert Array: The array to insert.
238 * @param $after Mixed: The key to insert after
241 function wfArrayInsertAfter( array $array, array $insert, $after ) {
242 // Find the offset of the element to insert after.
243 $keys = array_keys( $array );
244 $offsetByKey = array_flip( $keys );
246 $offset = $offsetByKey[$after];
248 // Insert at the specified offset
249 $before = array_slice( $array, 0, $offset +
1, true );
250 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
252 $output = $before +
$insert +
$after;
258 * Recursively converts the parameter (an object) to an array with the same data
260 * @param $objOrArray Object|Array
261 * @param $recursive Bool
264 function wfObjectToArray( $objOrArray, $recursive = true ) {
266 if( is_object( $objOrArray ) ) {
267 $objOrArray = get_object_vars( $objOrArray );
269 foreach ( $objOrArray as $key => $value ) {
270 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
271 $value = wfObjectToArray( $value );
274 $array[$key] = $value;
281 * Wrapper around array_map() which also taints variables
283 * @param $function Callback
284 * @param $input Array
287 function wfArrayMap( $function, $input ) {
288 $ret = array_map( $function, $input );
289 foreach ( $ret as $key => $value ) {
290 $taint = istainted( $input[$key] );
292 taint( $ret[$key], $taint );
299 * Get a random decimal value between 0 and 1, in a way
300 * not likely to give duplicate values for any realistic
301 * number of articles.
305 function wfRandom() {
306 # The maximum random value is "only" 2^31-1, so get two random
307 # values to reduce the chance of dupes
308 $max = mt_getrandmax() +
1;
309 $rand = number_format( ( mt_rand() * $max +
mt_rand() )
310 / $max / $max, 12, '.', '' );
315 * Get a random string containing a number of pesudo-random hex
317 * @note This is not secure, if you are trying to generate some sort
318 * of token please use MWCryptRand instead.
320 * @param $length int The length of the string to generate
324 function wfRandomString( $length = 32 ) {
326 while ( strlen( $str ) < $length ) {
327 $str .= dechex( mt_rand() );
329 return substr( $str, 0, $length );
333 * We want some things to be included as literal characters in our title URLs
334 * for prettiness, which urlencode encodes by default. According to RFC 1738,
335 * all of the following should be safe:
339 * But + is not safe because it's used to indicate a space; &= are only safe in
340 * paths and not in queries (and we don't distinguish here); ' seems kind of
341 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
342 * is reserved, we don't care. So the list we unescape is:
346 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
347 * so no fancy : for IIS7.
349 * %2F in the page titles seems to fatally break for some reason.
354 function wfUrlencode( $s ) {
356 if ( is_null( $s ) ) {
361 if ( is_null( $needle ) ) {
362 $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' );
363 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) {
368 $s = urlencode( $s );
371 array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ),
379 * This function takes two arrays as input, and returns a CGI-style string, e.g.
380 * "days=7&limit=100". Options in the first array override options in the second.
381 * Options set to null or false will not be output.
383 * @param $array1 Array ( String|Array )
384 * @param $array2 Array ( String|Array )
385 * @param $prefix String
388 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
389 if ( !is_null( $array2 ) ) {
390 $array1 = $array1 +
$array2;
394 foreach ( $array1 as $key => $value ) {
395 if ( !is_null($value) && $value !== false ) {
399 if ( $prefix !== '' ) {
400 $key = $prefix . "[$key]";
402 if ( is_array( $value ) ) {
404 foreach ( $value as $k => $v ) {
405 $cgi .= $firstTime ?
'' : '&';
406 if ( is_array( $v ) ) {
407 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
409 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
414 if ( is_object( $value ) ) {
415 $value = $value->__toString();
417 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
425 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
426 * its argument and returns the same string in array form. This allows compa-
427 * tibility with legacy functions that accept raw query strings instead of nice
428 * arrays. Of course, keys and values are urldecode()d.
430 * @param $query String: query string
431 * @return array Array version of input
433 function wfCgiToArray( $query ) {
434 if ( isset( $query[0] ) && $query[0] == '?' ) {
435 $query = substr( $query, 1 );
437 $bits = explode( '&', $query );
439 foreach ( $bits as $bit ) {
443 if ( strpos( $bit, '=' ) === false ) {
444 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
448 list( $key, $value ) = explode( '=', $bit );
450 $key = urldecode( $key );
451 $value = urldecode( $value );
452 if ( strpos( $key, '[' ) !== false ) {
453 $keys = array_reverse( explode( '[', $key ) );
454 $key = array_pop( $keys );
456 foreach ( $keys as $k ) {
457 $k = substr( $k, 0, -1 );
458 $temp = array( $k => $temp );
460 if ( isset( $ret[$key] ) ) {
461 $ret[$key] = array_merge( $ret[$key], $temp );
473 * Append a query string to an existing URL, which may or may not already
474 * have query string parameters already. If so, they will be combined.
477 * @param $query Mixed: string or associative array
480 function wfAppendQuery( $url, $query ) {
481 if ( is_array( $query ) ) {
482 $query = wfArrayToCgi( $query );
485 if( false === strpos( $url, '?' ) ) {
496 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
499 * The meaning of the PROTO_* constants is as follows:
500 * PROTO_HTTP: Output a URL starting with http://
501 * PROTO_HTTPS: Output a URL starting with https://
502 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
503 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request
504 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer
505 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
507 * @todo this won't work with current-path-relative URLs
508 * like "subdir/foo.html", etc.
510 * @param $url String: either fully-qualified or a local path + query
511 * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the
512 * protocol to use if $url or $wgServer is
514 * @return string Fully-qualified URL, current-path-relative URL or false if
515 * no valid URL can be constructed
517 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
518 global $wgServer, $wgCanonicalServer, $wgInternalServer;
519 $serverUrl = $wgServer;
520 if ( $defaultProto === PROTO_CANONICAL
) {
521 $serverUrl = $wgCanonicalServer;
523 // Make $wgInternalServer fall back to $wgServer if not set
524 if ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
525 $serverUrl = $wgInternalServer;
527 if ( $defaultProto === PROTO_CURRENT
) {
528 $defaultProto = WebRequest
::detectProtocol() . '://';
531 // Analyze $serverUrl to obtain its protocol
532 $bits = wfParseUrl( $serverUrl );
533 $serverHasProto = $bits && $bits['scheme'] != '';
535 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
536 if ( $serverHasProto ) {
537 $defaultProto = $bits['scheme'] . '://';
539 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen
540 // Fall back to HTTP in this ridiculous case
541 $defaultProto = PROTO_HTTP
;
545 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
547 if ( substr( $url, 0, 2 ) == '//' ) {
548 $url = $defaultProtoWithoutSlashes . $url;
549 } elseif ( substr( $url, 0, 1 ) == '/' ) {
550 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone
551 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
554 $bits = wfParseUrl( $url );
555 if ( $bits && isset( $bits['path'] ) ) {
556 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
557 return wfAssembleUrl( $bits );
561 } elseif ( substr( $url, 0, 1 ) != '/' ) {
562 # URL is a relative path
563 return wfRemoveDotSegments( $url );
566 # Expanded URL is not valid.
571 * This function will reassemble a URL parsed with wfParseURL. This is useful
572 * if you need to edit part of a URL and put it back together.
574 * This is the basic structure used (brackets contain keys for $urlParts):
575 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
577 * @todo Need to integrate this into wfExpandUrl (bug 32168)
580 * @param $urlParts Array URL parts, as output from wfParseUrl
581 * @return string URL assembled from its component parts
583 function wfAssembleUrl( $urlParts ) {
586 if ( isset( $urlParts['delimiter'] ) ) {
587 if ( isset( $urlParts['scheme'] ) ) {
588 $result .= $urlParts['scheme'];
591 $result .= $urlParts['delimiter'];
594 if ( isset( $urlParts['host'] ) ) {
595 if ( isset( $urlParts['user'] ) ) {
596 $result .= $urlParts['user'];
597 if ( isset( $urlParts['pass'] ) ) {
598 $result .= ':' . $urlParts['pass'];
603 $result .= $urlParts['host'];
605 if ( isset( $urlParts['port'] ) ) {
606 $result .= ':' . $urlParts['port'];
610 if ( isset( $urlParts['path'] ) ) {
611 $result .= $urlParts['path'];
614 if ( isset( $urlParts['query'] ) ) {
615 $result .= '?' . $urlParts['query'];
618 if ( isset( $urlParts['fragment'] ) ) {
619 $result .= '#' . $urlParts['fragment'];
626 * Remove all dot-segments in the provided URL path. For example,
627 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
628 * RFC3986 section 5.2.4.
630 * @todo Need to integrate this into wfExpandUrl (bug 32168)
632 * @param $urlPath String URL path, potentially containing dot-segments
633 * @return string URL path with all dot-segments removed
635 function wfRemoveDotSegments( $urlPath ) {
638 $inputLength = strlen( $urlPath );
640 while ( $inputOffset < $inputLength ) {
641 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
642 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
643 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
644 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
647 if ( $prefixLengthTwo == './' ) {
648 # Step A, remove leading "./"
650 } elseif ( $prefixLengthThree == '../' ) {
651 # Step A, remove leading "../"
653 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
654 # Step B, replace leading "/.$" with "/"
656 $urlPath[$inputOffset] = '/';
657 } elseif ( $prefixLengthThree == '/./' ) {
658 # Step B, replace leading "/./" with "/"
660 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
661 # Step C, replace leading "/..$" with "/" and
662 # remove last path component in output
664 $urlPath[$inputOffset] = '/';
666 } elseif ( $prefixLengthFour == '/../' ) {
667 # Step C, replace leading "/../" with "/" and
668 # remove last path component in output
671 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
672 # Step D, remove "^.$"
674 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
675 # Step D, remove "^..$"
678 # Step E, move leading path segment to output
679 if ( $prefixLengthOne == '/' ) {
680 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
682 $slashPos = strpos( $urlPath, '/', $inputOffset );
684 if ( $slashPos === false ) {
685 $output .= substr( $urlPath, $inputOffset );
686 $inputOffset = $inputLength;
688 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
689 $inputOffset +
= $slashPos - $inputOffset;
694 $slashPos = strrpos( $output, '/' );
695 if ( $slashPos === false ) {
698 $output = substr( $output, 0, $slashPos );
707 * Returns a regular expression of url protocols
709 * @param $includeProtocolRelative bool If false, remove '//' from the returned protocol list.
710 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
713 function wfUrlProtocols( $includeProtocolRelative = true ) {
714 global $wgUrlProtocols;
716 // Cache return values separately based on $includeProtocolRelative
717 static $withProtRel = null, $withoutProtRel = null;
718 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
719 if ( !is_null( $cachedValue ) ) {
723 // Support old-style $wgUrlProtocols strings, for backwards compatibility
724 // with LocalSettings files from 1.5
725 if ( is_array( $wgUrlProtocols ) ) {
726 $protocols = array();
727 foreach ( $wgUrlProtocols as $protocol ) {
728 // Filter out '//' if !$includeProtocolRelative
729 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
730 $protocols[] = preg_quote( $protocol, '/' );
734 $retval = implode( '|', $protocols );
736 // Ignore $includeProtocolRelative in this case
737 // This case exists for pre-1.6 compatibility, and we can safely assume
738 // that '//' won't appear in a pre-1.6 config because protocol-relative
739 // URLs weren't supported until 1.18
740 $retval = $wgUrlProtocols;
743 // Cache return value
744 if ( $includeProtocolRelative ) {
745 $withProtRel = $retval;
747 $withoutProtRel = $retval;
753 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
754 * you need a regex that matches all URL protocols but does not match protocol-
758 function wfUrlProtocolsWithoutProtRel() {
759 return wfUrlProtocols( false );
763 * parse_url() work-alike, but non-broken. Differences:
765 * 1) Does not raise warnings on bad URLs (just returns false)
766 * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly
767 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2))
769 * @param $url String: a URL to parse
770 * @return Array: bits of the URL in an associative array, per PHP docs
772 function wfParseUrl( $url ) {
773 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
775 // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest
776 // way to handle them is to just prepend 'http:' and strip the protocol out later
777 $wasRelative = substr( $url, 0, 2 ) == '//';
778 if ( $wasRelative ) {
781 wfSuppressWarnings();
782 $bits = parse_url( $url );
784 // parse_url() returns an array without scheme for some invalid URLs, e.g.
785 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
786 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
790 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
791 $bits['scheme'] = strtolower( $bits['scheme'] );
793 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
794 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
795 $bits['delimiter'] = '://';
796 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
797 $bits['delimiter'] = ':';
798 // parse_url detects for news: and mailto: the host part of an url as path
799 // We have to correct this wrong detection
800 if ( isset( $bits['path'] ) ) {
801 $bits['host'] = $bits['path'];
808 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
809 if ( !isset( $bits['host'] ) ) {
812 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
813 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
814 $bits['path'] = '/' . $bits['path'];
818 // If the URL was protocol-relative, fix scheme and delimiter
819 if ( $wasRelative ) {
820 $bits['scheme'] = '';
821 $bits['delimiter'] = '//';
827 * Take a URL, make sure it's expanded to fully qualified, and replace any
828 * encoded non-ASCII Unicode characters with their UTF-8 original forms
829 * for more compact display and legibility for local audiences.
831 * @todo handle punycode domains too
836 function wfExpandIRI( $url ) {
837 return preg_replace_callback( '/((?:%[89A-F][0-9A-F])+)/i', 'wfExpandIRI_callback', wfExpandUrl( $url ) );
841 * Private callback for wfExpandIRI
842 * @param array $matches
845 function wfExpandIRI_callback( $matches ) {
846 return urldecode( $matches[1] );
852 * Make URL indexes, appropriate for the el_index field of externallinks.
857 function wfMakeUrlIndexes( $url ) {
858 $bits = wfParseUrl( $url );
860 // Reverse the labels in the hostname, convert to lower case
861 // For emails reverse domainpart only
862 if ( $bits['scheme'] == 'mailto' ) {
863 $mailparts = explode( '@', $bits['host'], 2 );
864 if ( count( $mailparts ) === 2 ) {
865 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
867 // No domain specified, don't mangle it
870 $reversedHost = $domainpart . '@' . $mailparts[0];
872 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
874 // Add an extra dot to the end
875 // Why? Is it in wrong place in mailto links?
876 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
877 $reversedHost .= '.';
879 // Reconstruct the pseudo-URL
880 $prot = $bits['scheme'];
881 $index = $prot . $bits['delimiter'] . $reversedHost;
882 // Leave out user and password. Add the port, path, query and fragment
883 if ( isset( $bits['port'] ) ) {
884 $index .= ':' . $bits['port'];
886 if ( isset( $bits['path'] ) ) {
887 $index .= $bits['path'];
891 if ( isset( $bits['query'] ) ) {
892 $index .= '?' . $bits['query'];
894 if ( isset( $bits['fragment'] ) ) {
895 $index .= '#' . $bits['fragment'];
899 return array( "http:$index", "https:$index" );
901 return array( $index );
906 * Check whether a given URL has a domain that occurs in a given set of domains
907 * @param $url string URL
908 * @param $domains array Array of domains (strings)
909 * @return bool True if the host part of $url ends in one of the strings in $domains
911 function wfMatchesDomainList( $url, $domains ) {
912 $bits = wfParseUrl( $url );
913 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
914 foreach ( (array)$domains as $domain ) {
915 // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org
916 // We should use something that interprets dots instead
917 if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) {
926 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
927 * In normal operation this is a NOP.
929 * Controlling globals:
930 * $wgDebugLogFile - points to the log file
931 * $wgProfileOnly - if set, normal debug messages will not be recorded.
932 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
933 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
935 * @param $text String
936 * @param $logonly Bool: set true to avoid appearing in HTML when $wgDebugComments is set
938 function wfDebug( $text, $logonly = false ) {
939 global $wgDebugLogFile, $wgProfileOnly, $wgDebugRawPage, $wgDebugLogPrefix;
941 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
945 $timer = wfDebugTimer();
946 if ( $timer !== '' ) {
947 $text = preg_replace( '/[^\n]/', $timer . '\0', $text, 1 );
951 MWDebug
::debugMsg( $text );
954 if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) {
955 if ( $wgDebugLogFile != '' && !$wgProfileOnly ) {
956 # Strip unprintables; they can switch terminal modes when binary data
957 # gets dumped, which is pretty annoying.
958 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text );
959 $text = $wgDebugLogPrefix . $text;
960 wfErrorLog( $text, $wgDebugLogFile );
966 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
969 function wfIsDebugRawPage() {
971 if ( $cache !== null ) {
974 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
975 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
977 isset( $_SERVER['SCRIPT_NAME'] )
978 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
989 * Get microsecond timestamps for debug logs
993 function wfDebugTimer() {
994 global $wgDebugTimestamps, $wgRequestTime;
996 if ( !$wgDebugTimestamps ) {
1000 $prefix = sprintf( "%6.4f", microtime( true ) - $wgRequestTime );
1001 $mem = sprintf( "%5.1fM", ( memory_get_usage( true ) / ( 1024 * 1024 ) ) );
1002 return "$prefix $mem ";
1006 * Send a line giving PHP memory usage.
1008 * @param $exact Bool: print exact values instead of kilobytes (default: false)
1010 function wfDebugMem( $exact = false ) {
1011 $mem = memory_get_usage();
1013 $mem = floor( $mem / 1024 ) . ' kilobytes';
1017 wfDebug( "Memory usage: $mem\n" );
1021 * Send a line to a supplementary debug log file, if configured, or main debug log if not.
1022 * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
1024 * @param $logGroup String
1025 * @param $text String
1026 * @param $public Bool: whether to log the event in the public log if no private
1027 * log file is specified, (default true)
1029 function wfDebugLog( $logGroup, $text, $public = true ) {
1030 global $wgDebugLogGroups;
1031 $text = trim( $text ) . "\n";
1032 if( isset( $wgDebugLogGroups[$logGroup] ) ) {
1033 $time = wfTimestamp( TS_DB
);
1035 $host = wfHostname();
1036 if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) {
1037 wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] );
1039 } elseif ( $public === true ) {
1040 wfDebug( $text, true );
1045 * Log for database errors
1047 * @param $text String: database error message.
1049 function wfLogDBError( $text ) {
1050 global $wgDBerrorLog, $wgDBerrorLogTZ;
1051 static $logDBErrorTimeZoneObject = null;
1053 if ( $wgDBerrorLog ) {
1054 $host = wfHostname();
1057 if ( $wgDBerrorLogTZ && !$logDBErrorTimeZoneObject ) {
1058 $logDBErrorTimeZoneObject = new DateTimeZone( $wgDBerrorLogTZ );
1061 // Workaround for https://bugs.php.net/bug.php?id=52063
1062 // Can be removed when min PHP > 5.3.2
1063 if ( $logDBErrorTimeZoneObject === null ) {
1064 $d = date_create( "now" );
1066 $d = date_create( "now", $logDBErrorTimeZoneObject );
1069 $date = $d->format( 'D M j G:i:s T Y' );
1071 $text = "$date\t$host\t$wiki\t$text";
1072 wfErrorLog( $text, $wgDBerrorLog );
1077 * Throws a warning that $function is deprecated
1079 * @param $function String
1080 * @param $version String|bool: Version of MediaWiki that the function was deprecated in (Added in 1.19).
1081 * @param $component String|bool: Added in 1.19.
1082 * @param $callerOffset integer: How far up the callstack is the original
1083 * caller. 2 = function that called the function that called
1084 * wfDeprecated (Added in 1.20)
1088 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1089 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1093 * Send a warning either to the debug log or in a PHP error depending on
1094 * $wgDevelopmentWarnings
1096 * @param $msg String: message to send
1097 * @param $callerOffset Integer: number of items to go back in the backtrace to
1098 * find the correct caller (1 = function calling wfWarn, ...)
1099 * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings
1102 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1103 MWDebug
::warning( $msg, $callerOffset +
1, $level );
1107 * Log to a file without getting "file size exceeded" signals.
1109 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1110 * send lines to the specified port, prefixed by the specified prefix and a space.
1112 * @param $text String
1113 * @param $file String filename
1114 * @throws MWException
1116 function wfErrorLog( $text, $file ) {
1117 if ( substr( $file, 0, 4 ) == 'udp:' ) {
1118 # Needs the sockets extension
1119 if ( preg_match( '!^(tcp|udp):(?://)?\[([0-9a-fA-F:]+)\]:(\d+)(?:/(.*))?$!', $file, $m ) ) {
1120 // IPv6 bracketed host
1122 $port = intval( $m[3] );
1123 $prefix = isset( $m[4] ) ?
$m[4] : false;
1125 } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) {
1127 if ( !IP
::isIPv4( $host ) ) {
1128 $host = gethostbyname( $host );
1130 $port = intval( $m[3] );
1131 $prefix = isset( $m[4] ) ?
$m[4] : false;
1134 throw new MWException( __METHOD__
. ': Invalid UDP specification' );
1137 // Clean it up for the multiplexer
1138 if ( strval( $prefix ) !== '' ) {
1139 $text = preg_replace( '/^/m', $prefix . ' ', $text );
1142 if ( strlen( $text ) > 65506 ) {
1143 $text = substr( $text, 0, 65506 );
1146 if ( substr( $text, -1 ) != "\n" ) {
1149 } elseif ( strlen( $text ) > 65507 ) {
1150 $text = substr( $text, 0, 65507 );
1153 $sock = socket_create( $domain, SOCK_DGRAM
, SOL_UDP
);
1158 socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port );
1159 socket_close( $sock );
1161 wfSuppressWarnings();
1162 $exists = file_exists( $file );
1163 $size = $exists ?
filesize( $file ) : false;
1164 if ( !$exists ||
( $size !== false && $size +
strlen( $text ) < 0x7fffffff ) ) {
1165 file_put_contents( $file, $text, FILE_APPEND
);
1167 wfRestoreWarnings();
1174 function wfLogProfilingData() {
1175 global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
1176 global $wgProfileLimit, $wgUser;
1178 $profiler = Profiler
::instance();
1180 # Profiling must actually be enabled...
1181 if ( $profiler->isStub() ) {
1185 // Get total page request time and only show pages that longer than
1186 // $wgProfileLimit time (default is 0)
1187 $elapsed = microtime( true ) - $wgRequestTime;
1188 if ( $elapsed <= $wgProfileLimit ) {
1192 $profiler->logData();
1194 // Check whether this should be logged in the debug file.
1195 if ( $wgDebugLogFile == '' ||
( !$wgDebugRawPage && wfIsDebugRawPage() ) ) {
1200 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1201 $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
1203 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1204 $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP'];
1206 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1207 $forward .= ' from ' . $_SERVER['HTTP_FROM'];
1210 $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
1212 // Don't load $wgUser at this late stage just for statistics purposes
1213 // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId()
1214 if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) {
1215 $forward .= ' anon';
1217 $log = sprintf( "%s\t%04.3f\t%s\n",
1218 gmdate( 'YmdHis' ), $elapsed,
1219 urldecode( $wgRequest->getRequestURL() . $forward ) );
1221 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1225 * Increment a statistics counter
1227 * @param $key String
1230 function wfIncrStats( $key, $count = 1 ) {
1231 global $wgStatsMethod;
1233 $count = intval( $count );
1235 if( $wgStatsMethod == 'udp' ) {
1236 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID;
1239 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : $wgDBname;
1242 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
1243 $statline = "stats/{$id} - 1 1 1 1 1 -total\n";
1247 strlen( $statline ),
1253 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
1254 wfSuppressWarnings();
1258 strlen( $statline ),
1263 wfRestoreWarnings();
1264 } elseif( $wgStatsMethod == 'cache' ) {
1266 $key = wfMemcKey( 'stats', $key );
1267 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
1268 $wgMemc->add( $key, $count );
1276 * Check if the wiki read-only lock file is present. This can be used to lock
1277 * off editing functions, but doesn't guarantee that the database will not be
1282 function wfReadOnly() {
1283 global $wgReadOnlyFile, $wgReadOnly;
1285 if ( !is_null( $wgReadOnly ) ) {
1286 return (bool)$wgReadOnly;
1288 if ( $wgReadOnlyFile == '' ) {
1291 // Set $wgReadOnly for faster access next time
1292 if ( is_file( $wgReadOnlyFile ) ) {
1293 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1295 $wgReadOnly = false;
1297 return (bool)$wgReadOnly;
1303 function wfReadOnlyReason() {
1310 * Return a Language object from $langcode
1312 * @param $langcode Mixed: either:
1313 * - a Language object
1314 * - code of the language to get the message for, if it is
1315 * a valid code create a language for that language, if
1316 * it is a string but not a valid code then make a basic
1318 * - a boolean: if it's false then use the global object for
1319 * the current user's language (as a fallback for the old parameter
1320 * functionality), or if it is true then use global object
1321 * for the wiki's content language.
1322 * @return Language object
1324 function wfGetLangObj( $langcode = false ) {
1325 # Identify which language to get or create a language object for.
1326 # Using is_object here due to Stub objects.
1327 if( is_object( $langcode ) ) {
1328 # Great, we already have the object (hopefully)!
1332 global $wgContLang, $wgLanguageCode;
1333 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
1334 # $langcode is the language code of the wikis content language object.
1335 # or it is a boolean and value is true
1340 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1341 # $langcode is the language code of user language object.
1342 # or it was a boolean and value is false
1346 $validCodes = array_keys( Language
::fetchLanguageNames() );
1347 if( in_array( $langcode, $validCodes ) ) {
1348 # $langcode corresponds to a valid language.
1349 return Language
::factory( $langcode );
1352 # $langcode is a string, but not a valid language code; use content language.
1353 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1358 * Old function when $wgBetterDirectionality existed
1359 * All usage removed, wfUILang can be removed in near future
1361 * @deprecated since 1.18
1364 function wfUILang() {
1365 wfDeprecated( __METHOD__
, '1.18' );
1371 * This is the new function for getting translated interface messages.
1372 * See the Message class for documentation how to use them.
1373 * The intention is that this function replaces all old wfMsg* functions.
1374 * @param $key \string Message key.
1375 * Varargs: normal message parameters.
1379 function wfMessage( $key /*...*/) {
1380 $params = func_get_args();
1381 array_shift( $params );
1382 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1383 $params = $params[0];
1385 return new Message( $key, $params );
1389 * This function accepts multiple message keys and returns a message instance
1390 * for the first message which is non-empty. If all messages are empty then an
1391 * instance of the first message key is returned.
1392 * @param varargs: message keys
1396 function wfMessageFallback( /*...*/ ) {
1397 $args = func_get_args();
1398 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
1402 * Get a message from anywhere, for the current user language.
1404 * Use wfMsgForContent() instead if the message should NOT
1405 * change depending on the user preferences.
1407 * @deprecated since 1.18
1409 * @param $key String: lookup key for the message, usually
1410 * defined in languages/Language.php
1412 * Parameters to the message, which can be used to insert variable text into
1413 * it, can be passed to this function in the following formats:
1414 * - One per argument, starting at the second parameter
1415 * - As an array in the second parameter
1416 * These are not shown in the function definition.
1420 function wfMsg( $key ) {
1421 $args = func_get_args();
1422 array_shift( $args );
1423 return wfMsgReal( $key, $args );
1427 * Same as above except doesn't transform the message
1429 * @deprecated since 1.18
1431 * @param $key String
1434 function wfMsgNoTrans( $key ) {
1435 $args = func_get_args();
1436 array_shift( $args );
1437 return wfMsgReal( $key, $args, true, false, false );
1441 * Get a message from anywhere, for the current global language
1442 * set with $wgLanguageCode.
1444 * Use this if the message should NOT change dependent on the
1445 * language set in the user's preferences. This is the case for
1446 * most text written into logs, as well as link targets (such as
1447 * the name of the copyright policy page). Link titles, on the
1448 * other hand, should be shown in the UI language.
1450 * Note that MediaWiki allows users to change the user interface
1451 * language in their preferences, but a single installation
1452 * typically only contains content in one language.
1454 * Be wary of this distinction: If you use wfMsg() where you should
1455 * use wfMsgForContent(), a user of the software may have to
1456 * customize potentially hundreds of messages in
1457 * order to, e.g., fix a link in every possible language.
1459 * @deprecated since 1.18
1461 * @param $key String: lookup key for the message, usually
1462 * defined in languages/Language.php
1465 function wfMsgForContent( $key ) {
1466 global $wgForceUIMsgAsContentMsg;
1467 $args = func_get_args();
1468 array_shift( $args );
1470 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1471 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1473 $forcontent = false;
1475 return wfMsgReal( $key, $args, true, $forcontent );
1479 * Same as above except doesn't transform the message
1481 * @deprecated since 1.18
1483 * @param $key String
1486 function wfMsgForContentNoTrans( $key ) {
1487 global $wgForceUIMsgAsContentMsg;
1488 $args = func_get_args();
1489 array_shift( $args );
1491 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1492 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1494 $forcontent = false;
1496 return wfMsgReal( $key, $args, true, $forcontent, false );
1500 * Really get a message
1502 * @deprecated since 1.18
1504 * @param $key String: key to get.
1506 * @param $useDB Boolean
1507 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1508 * @param $transform Boolean: Whether or not to transform the message.
1509 * @return String: the requested message.
1511 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1512 wfProfileIn( __METHOD__
);
1513 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1514 $message = wfMsgReplaceArgs( $message, $args );
1515 wfProfileOut( __METHOD__
);
1520 * Fetch a message string value, but don't replace any keys yet.
1522 * @deprecated since 1.18
1524 * @param $key String
1525 * @param $useDB Bool
1526 * @param $langCode String: Code of the language to get the message for, or
1527 * behaves as a content language switch if it is a boolean.
1528 * @param $transform Boolean: whether to parse magic words, etc.
1531 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1532 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1534 $cache = MessageCache
::singleton();
1535 $message = $cache->get( $key, $useDB, $langCode );
1536 if( $message === false ) {
1537 $message = '<' . htmlspecialchars( $key ) . '>';
1538 } elseif ( $transform ) {
1539 $message = $cache->transform( $message );
1545 * Replace message parameter keys on the given formatted output.
1547 * @param $message String
1548 * @param $args Array
1552 function wfMsgReplaceArgs( $message, $args ) {
1553 # Fix windows line-endings
1554 # Some messages are split with explode("\n", $msg)
1555 $message = str_replace( "\r", '', $message );
1557 // Replace arguments
1558 if ( count( $args ) ) {
1559 if ( is_array( $args[0] ) ) {
1560 $args = array_values( $args[0] );
1562 $replacementKeys = array();
1563 foreach( $args as $n => $param ) {
1564 $replacementKeys['$' . ( $n +
1 )] = $param;
1566 $message = strtr( $message, $replacementKeys );
1573 * Return an HTML-escaped version of a message.
1574 * Parameter replacements, if any, are done *after* the HTML-escaping,
1575 * so parameters may contain HTML (eg links or form controls). Be sure
1576 * to pre-escape them if you really do want plaintext, or just wrap
1577 * the whole thing in htmlspecialchars().
1579 * @deprecated since 1.18
1581 * @param $key String
1582 * @param string ... parameters
1585 function wfMsgHtml( $key ) {
1586 $args = func_get_args();
1587 array_shift( $args );
1588 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1592 * Return an HTML version of message
1593 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1594 * so parameters may contain HTML (eg links or form controls). Be sure
1595 * to pre-escape them if you really do want plaintext, or just wrap
1596 * the whole thing in htmlspecialchars().
1598 * @deprecated since 1.18
1600 * @param $key String
1601 * @param string ... parameters
1604 function wfMsgWikiHtml( $key ) {
1605 $args = func_get_args();
1606 array_shift( $args );
1607 return wfMsgReplaceArgs(
1608 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1609 /* can't be set to false */ true, /* interface */ true )->getText(),
1614 * Returns message in the requested format
1616 * @deprecated since 1.18
1618 * @param $key String: key of the message
1619 * @param $options Array: processing rules. Can take the following options:
1620 * <i>parse</i>: parses wikitext to HTML
1621 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1622 * p's added by parser or tidy
1623 * <i>escape</i>: filters message through htmlspecialchars
1624 * <i>escapenoentities</i>: same, but allows entity references like   through
1625 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1626 * <i>parsemag</i>: transform the message using magic phrases
1627 * <i>content</i>: fetch message for content language instead of interface
1628 * Also can accept a single associative argument, of the form 'language' => 'xx':
1629 * <i>language</i>: Language object or language code to fetch message for
1630 * (overriden by <i>content</i>).
1631 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1635 function wfMsgExt( $key, $options ) {
1636 $args = func_get_args();
1637 array_shift( $args );
1638 array_shift( $args );
1639 $options = (array)$options;
1641 foreach( $options as $arrayKey => $option ) {
1642 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1643 # An unknown index, neither numeric nor "language"
1644 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1645 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1646 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1647 'replaceafter', 'parsemag', 'content' ) ) ) {
1648 # A numeric index with unknown value
1649 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1653 if( in_array( 'content', $options, true ) ) {
1656 $langCodeObj = null;
1657 } elseif( array_key_exists( 'language', $options ) ) {
1658 $forContent = false;
1659 $langCode = wfGetLangObj( $options['language'] );
1660 $langCodeObj = $langCode;
1662 $forContent = false;
1664 $langCodeObj = null;
1667 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1669 if( !in_array( 'replaceafter', $options, true ) ) {
1670 $string = wfMsgReplaceArgs( $string, $args );
1673 $messageCache = MessageCache
::singleton();
1674 $parseInline = in_array( 'parseinline', $options, true );
1675 if( in_array( 'parse', $options, true ) ||
$parseInline ) {
1676 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1677 if ( $string instanceof ParserOutput
) {
1678 $string = $string->getText();
1681 if ( $parseInline ) {
1683 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1687 } elseif ( in_array( 'parsemag', $options, true ) ) {
1688 $string = $messageCache->transform( $string,
1689 !$forContent, $langCodeObj );
1692 if ( in_array( 'escape', $options, true ) ) {
1693 $string = htmlspecialchars ( $string );
1694 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1695 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1698 if( in_array( 'replaceafter', $options, true ) ) {
1699 $string = wfMsgReplaceArgs( $string, $args );
1706 * Since wfMsg() and co suck, they don't return false if the message key they
1707 * looked up didn't exist but a XHTML string, this function checks for the
1708 * nonexistance of messages by checking the MessageCache::get() result directly.
1710 * @deprecated since 1.18. Use Message::isDisabled().
1712 * @param $key String: the message key looked up
1713 * @return Boolean True if the message *doesn't* exist.
1715 function wfEmptyMsg( $key ) {
1716 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1720 * Throw a debugging exception. This function previously once exited the process,
1721 * but now throws an exception instead, with similar results.
1723 * @param $msg String: message shown when dying.
1724 * @throws MWException
1726 function wfDebugDieBacktrace( $msg = '' ) {
1727 throw new MWException( $msg );
1731 * Fetch server name for use in error reporting etc.
1732 * Use real server name if available, so we know which machine
1733 * in a server farm generated the current page.
1737 function wfHostname() {
1739 if ( is_null( $host ) ) {
1741 # Hostname overriding
1742 global $wgOverrideHostname;
1743 if( $wgOverrideHostname !== false ) {
1744 # Set static and skip any detection
1745 $host = $wgOverrideHostname;
1749 if ( function_exists( 'posix_uname' ) ) {
1750 // This function not present on Windows
1751 $uname = posix_uname();
1755 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1756 $host = $uname['nodename'];
1757 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1758 # Windows computer name
1759 $host = getenv( 'COMPUTERNAME' );
1761 # This may be a virtual server.
1762 $host = $_SERVER['SERVER_NAME'];
1769 * Returns a HTML comment with the elapsed time since request.
1770 * This method has no side effects.
1774 function wfReportTime() {
1775 global $wgRequestTime, $wgShowHostnames;
1777 $elapsed = microtime( true ) - $wgRequestTime;
1779 return $wgShowHostnames
1780 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1781 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1785 * Safety wrapper for debug_backtrace().
1787 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1788 * murky circumstances, which may be triggered in part by stub objects
1789 * or other fancy talkin'.
1791 * Will return an empty array if Zend Optimizer is detected or if
1792 * debug_backtrace is disabled, otherwise the output from
1793 * debug_backtrace() (trimmed).
1795 * @param $limit int This parameter can be used to limit the number of stack frames returned
1797 * @return array of backtrace information
1799 function wfDebugBacktrace( $limit = 0 ) {
1800 static $disabled = null;
1802 if( extension_loaded( 'Zend Optimizer' ) ) {
1803 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1807 if ( is_null( $disabled ) ) {
1809 $functions = explode( ',', ini_get( 'disable_functions' ) );
1810 $functions = array_map( 'trim', $functions );
1811 $functions = array_map( 'strtolower', $functions );
1812 if ( in_array( 'debug_backtrace', $functions ) ) {
1813 wfDebug( "debug_backtrace is in disabled_functions\n" );
1821 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1822 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1824 return array_slice( debug_backtrace(), 1 );
1829 * Get a debug backtrace as a string
1833 function wfBacktrace() {
1834 global $wgCommandLineMode;
1836 if ( $wgCommandLineMode ) {
1841 $backtrace = wfDebugBacktrace();
1842 foreach( $backtrace as $call ) {
1843 if( isset( $call['file'] ) ) {
1844 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1845 $file = $f[count( $f ) - 1];
1849 if( isset( $call['line'] ) ) {
1850 $line = $call['line'];
1854 if ( $wgCommandLineMode ) {
1855 $msg .= "$file line $line calls ";
1857 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1859 if( !empty( $call['class'] ) ) {
1860 $msg .= $call['class'] . $call['type'];
1862 $msg .= $call['function'] . '()';
1864 if ( $wgCommandLineMode ) {
1870 if ( $wgCommandLineMode ) {
1880 * Get the name of the function which called this function
1881 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1882 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1883 * wfGetCaller( 3 ) is the parent of that.
1888 function wfGetCaller( $level = 2 ) {
1889 $backtrace = wfDebugBacktrace( $level +
1 );
1890 if ( isset( $backtrace[$level] ) ) {
1891 return wfFormatStackFrame( $backtrace[$level] );
1898 * Return a string consisting of callers in the stack. Useful sometimes
1899 * for profiling specific points.
1901 * @param $limit int The maximum depth of the stack frame to return, or false for
1905 function wfGetAllCallers( $limit = 3 ) {
1906 $trace = array_reverse( wfDebugBacktrace() );
1907 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1908 $limit = count( $trace ) - 1;
1910 $trace = array_slice( $trace, -$limit - 1, $limit );
1911 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1915 * Return a string representation of frame
1917 * @param $frame Array
1920 function wfFormatStackFrame( $frame ) {
1921 return isset( $frame['class'] ) ?
1922 $frame['class'] . '::' . $frame['function'] :
1927 /* Some generic result counters, pulled out of SearchEngine */
1933 * @param $offset Int
1937 function wfShowingResults( $offset, $limit ) {
1938 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1942 * Generate (prev x| next x) (20|50|100...) type links for paging
1944 * @param $offset String
1945 * @param $limit Integer
1946 * @param $link String
1947 * @param $query String: optional URL query parameter string
1948 * @param $atend Bool: optional param for specified if this is the last page
1950 * @deprecated in 1.19; use Language::viewPrevNext() instead
1952 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1953 wfDeprecated( __METHOD__
, '1.19' );
1957 $query = wfCgiToArray( $query );
1959 if( is_object( $link ) ) {
1962 $title = Title
::newFromText( $link );
1963 if( is_null( $title ) ) {
1968 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
1972 * Make a list item, used by various special pages
1974 * @param $page String Page link
1975 * @param $details String Text between brackets
1976 * @param $oppositedm Boolean Add the direction mark opposite to your
1977 * language, to display text properly
1979 * @deprecated since 1.19; use Language::specialList() instead
1981 function wfSpecialList( $page, $details, $oppositedm = true ) {
1982 wfDeprecated( __METHOD__
, '1.19' );
1985 return $wgLang->specialList( $page, $details, $oppositedm );
1990 * @todo FIXME: We may want to blacklist some broken browsers
1992 * @param $force Bool
1993 * @return bool Whereas client accept gzip compression
1995 function wfClientAcceptsGzip( $force = false ) {
1996 static $result = null;
1997 if ( $result === null ||
$force ) {
1999 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
2000 # @todo FIXME: We may want to blacklist some broken browsers
2003 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2004 $_SERVER['HTTP_ACCEPT_ENCODING'],
2008 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2012 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2021 * Obtain the offset and limit values from the request string;
2022 * used in special pages
2024 * @param $deflimit Int default limit if none supplied
2025 * @param $optionname String Name of a user preference to check against
2029 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2031 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2035 * Escapes the given text so that it may be output using addWikiText()
2036 * without any linking, formatting, etc. making its way through. This
2037 * is achieved by substituting certain characters with HTML entities.
2038 * As required by the callers, "<nowiki>" is not used.
2040 * @param $text String: text to be escaped
2043 function wfEscapeWikiText( $text ) {
2044 $text = strtr( "\n$text", array(
2045 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2046 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2047 '{' => '{', '|' => '|', '}' => '}',
2048 "\n#" => "\n#", "\n*" => "\n*",
2049 "\n:" => "\n:", "\n;" => "\n;",
2050 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
2052 return substr( $text, 1 );
2056 * Get the current unix timetstamp with microseconds. Useful for profiling
2060 return microtime( true );
2064 * Sets dest to source and returns the original value of dest
2065 * If source is NULL, it just returns the value, it doesn't set the variable
2066 * If force is true, it will set the value even if source is NULL
2068 * @param $dest Mixed
2069 * @param $source Mixed
2070 * @param $force Bool
2073 function wfSetVar( &$dest, $source, $force = false ) {
2075 if ( !is_null( $source ) ||
$force ) {
2082 * As for wfSetVar except setting a bit
2086 * @param $state Bool
2090 function wfSetBit( &$dest, $bit, $state = true ) {
2091 $temp = (bool)( $dest & $bit );
2092 if ( !is_null( $state ) ) {
2103 * A wrapper around the PHP function var_export().
2104 * Either print it or add it to the regular output ($wgOut).
2106 * @param $var mixed A PHP variable to dump.
2108 function wfVarDump( $var ) {
2110 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2111 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2114 $wgOut->addHTML( $s );
2119 * Provide a simple HTTP error.
2121 * @param $code Int|String
2122 * @param $label String
2123 * @param $desc String
2125 function wfHttpError( $code, $label, $desc ) {
2128 header( "HTTP/1.0 $code $label" );
2129 header( "Status: $code $label" );
2130 $wgOut->sendCacheControl();
2132 header( 'Content-type: text/html; charset=utf-8' );
2133 print "<!doctype html>" .
2134 '<html><head><title>' .
2135 htmlspecialchars( $label ) .
2136 '</title></head><body><h1>' .
2137 htmlspecialchars( $label ) .
2139 nl2br( htmlspecialchars( $desc ) ) .
2140 "</p></body></html>\n";
2144 * Clear away any user-level output buffers, discarding contents.
2146 * Suitable for 'starting afresh', for instance when streaming
2147 * relatively large amounts of data without buffering, or wanting to
2148 * output image files without ob_gzhandler's compression.
2150 * The optional $resetGzipEncoding parameter controls suppression of
2151 * the Content-Encoding header sent by ob_gzhandler; by default it
2152 * is left. See comments for wfClearOutputBuffers() for why it would
2155 * Note that some PHP configuration options may add output buffer
2156 * layers which cannot be removed; these are left in place.
2158 * @param $resetGzipEncoding Bool
2160 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2161 if( $resetGzipEncoding ) {
2162 // Suppress Content-Encoding and Content-Length
2163 // headers from 1.10+s wfOutputHandler
2164 global $wgDisableOutputCompression;
2165 $wgDisableOutputCompression = true;
2167 while( $status = ob_get_status() ) {
2168 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2169 // Probably from zlib.output_compression or other
2170 // PHP-internal setting which can't be removed.
2172 // Give up, and hope the result doesn't break
2176 if( !ob_end_clean() ) {
2177 // Could not remove output buffer handler; abort now
2178 // to avoid getting in some kind of infinite loop.
2181 if( $resetGzipEncoding ) {
2182 if( $status['name'] == 'ob_gzhandler' ) {
2183 // Reset the 'Content-Encoding' field set by this handler
2184 // so we can start fresh.
2185 header_remove( 'Content-Encoding' );
2193 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2195 * Clear away output buffers, but keep the Content-Encoding header
2196 * produced by ob_gzhandler, if any.
2198 * This should be used for HTTP 304 responses, where you need to
2199 * preserve the Content-Encoding header of the real result, but
2200 * also need to suppress the output of ob_gzhandler to keep to spec
2201 * and avoid breaking Firefox in rare cases where the headers and
2202 * body are broken over two packets.
2204 function wfClearOutputBuffers() {
2205 wfResetOutputBuffers( false );
2209 * Converts an Accept-* header into an array mapping string values to quality
2212 * @param $accept String
2213 * @param $def String default
2216 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2217 # No arg means accept anything (per HTTP spec)
2219 return array( $def => 1.0 );
2224 $parts = explode( ',', $accept );
2226 foreach( $parts as $part ) {
2227 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2228 $values = explode( ';', trim( $part ) );
2230 if ( count( $values ) == 1 ) {
2231 $prefs[$values[0]] = 1.0;
2232 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2233 $prefs[$values[0]] = floatval( $match[1] );
2241 * Checks if a given MIME type matches any of the keys in the given
2242 * array. Basic wildcards are accepted in the array keys.
2244 * Returns the matching MIME type (or wildcard) if a match, otherwise
2247 * @param $type String
2248 * @param $avail Array
2252 function mimeTypeMatch( $type, $avail ) {
2253 if( array_key_exists( $type, $avail ) ) {
2256 $parts = explode( '/', $type );
2257 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2258 return $parts[0] . '/*';
2259 } elseif( array_key_exists( '*/*', $avail ) ) {
2268 * Returns the 'best' match between a client's requested internet media types
2269 * and the server's list of available types. Each list should be an associative
2270 * array of type to preference (preference is a float between 0.0 and 1.0).
2271 * Wildcards in the types are acceptable.
2273 * @param $cprefs Array: client's acceptable type list
2274 * @param $sprefs Array: server's offered types
2277 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2278 * XXX: generalize to negotiate other stuff
2280 function wfNegotiateType( $cprefs, $sprefs ) {
2283 foreach( array_keys( $sprefs ) as $type ) {
2284 $parts = explode( '/', $type );
2285 if( $parts[1] != '*' ) {
2286 $ckey = mimeTypeMatch( $type, $cprefs );
2288 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2293 foreach( array_keys( $cprefs ) as $type ) {
2294 $parts = explode( '/', $type );
2295 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2296 $skey = mimeTypeMatch( $type, $sprefs );
2298 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2306 foreach( array_keys( $combine ) as $type ) {
2307 if( $combine[$type] > $bestq ) {
2309 $bestq = $combine[$type];
2317 * Reference-counted warning suppression
2321 function wfSuppressWarnings( $end = false ) {
2322 static $suppressCount = 0;
2323 static $originalLevel = false;
2326 if ( $suppressCount ) {
2328 if ( !$suppressCount ) {
2329 error_reporting( $originalLevel );
2333 if ( !$suppressCount ) {
2334 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED | E_USER_DEPRECATED
) );
2341 * Restore error level to previous value
2343 function wfRestoreWarnings() {
2344 wfSuppressWarnings( true );
2347 # Autodetect, convert and provide timestamps of various types
2350 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2352 define( 'TS_UNIX', 0 );
2355 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2357 define( 'TS_MW', 1 );
2360 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2362 define( 'TS_DB', 2 );
2365 * RFC 2822 format, for E-mail and HTTP headers
2367 define( 'TS_RFC2822', 3 );
2370 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2372 * This is used by Special:Export
2374 define( 'TS_ISO_8601', 4 );
2377 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2379 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2380 * DateTime tag and page 36 for the DateTimeOriginal and
2381 * DateTimeDigitized tags.
2383 define( 'TS_EXIF', 5 );
2386 * Oracle format time.
2388 define( 'TS_ORACLE', 6 );
2391 * Postgres format time.
2393 define( 'TS_POSTGRES', 7 );
2398 define( 'TS_DB2', 8 );
2401 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2403 define( 'TS_ISO_8601_BASIC', 9 );
2406 * Get a timestamp string in one of various formats
2408 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2409 * function will autodetect which format is supplied and act
2411 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
2412 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2414 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2416 $timestamp = new MWTimestamp( $ts );
2417 return $timestamp->getTimestamp( $outputtype );
2418 } catch( TimestampException
$e ) {
2419 wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
2425 * Return a formatted timestamp, or null if input is null.
2426 * For dealing with nullable timestamp columns in the database.
2428 * @param $outputtype Integer
2432 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2433 if( is_null( $ts ) ) {
2436 return wfTimestamp( $outputtype, $ts );
2441 * Convenience function; returns MediaWiki timestamp for the present time.
2445 function wfTimestampNow() {
2447 return wfTimestamp( TS_MW
, time() );
2451 * Check if the operating system is Windows
2453 * @return Bool: true if it's Windows, False otherwise.
2455 function wfIsWindows() {
2456 static $isWindows = null;
2457 if ( $isWindows === null ) {
2458 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2464 * Check if we are running under HipHop
2468 function wfIsHipHop() {
2469 return function_exists( 'hphp_thread_set_warmup_enabled' );
2473 * Swap two variables
2478 function swap( &$x, &$y ) {
2485 * Tries to get the system directory for temporary files. First
2486 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2487 * environment variables are then checked in sequence, and if none are
2488 * set try sys_get_temp_dir().
2490 * NOTE: When possible, use instead the tmpfile() function to create
2491 * temporary files to avoid race conditions on file creation, etc.
2495 function wfTempDir() {
2496 global $wgTmpDirectory;
2498 if ( $wgTmpDirectory !== false ) {
2499 return $wgTmpDirectory;
2502 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2504 foreach( $tmpDir as $tmp ) {
2505 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2509 return sys_get_temp_dir();
2513 * Make directory, and make all parent directories if they don't exist
2515 * @param $dir String: full path to directory to create
2516 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2517 * @param $caller String: optional caller param for debugging.
2518 * @throws MWException
2521 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2522 global $wgDirectoryMode;
2524 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2525 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2528 if ( !is_null( $caller ) ) {
2529 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2532 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2536 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2538 if ( is_null( $mode ) ) {
2539 $mode = $wgDirectoryMode;
2542 // Turn off the normal warning, we're doing our own below
2543 wfSuppressWarnings();
2544 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2545 wfRestoreWarnings();
2548 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2549 trigger_error( sprintf( "%s: failed to mkdir \"%s\" mode 0%o", __FUNCTION__
, $dir, $mode ),
2556 * Remove a directory and all its content.
2557 * Does not hide error.
2559 function wfRecursiveRemoveDir( $dir ) {
2560 wfDebug( __FUNCTION__
. "( $dir )\n" );
2561 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2562 if ( is_dir( $dir ) ) {
2563 $objects = scandir( $dir );
2564 foreach ( $objects as $object ) {
2565 if ( $object != "." && $object != ".." ) {
2566 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2567 wfRecursiveRemoveDir( $dir . '/' . $object );
2569 unlink( $dir . '/' . $object );
2579 * @param $nr Mixed: the number to format
2580 * @param $acc Integer: the number of digits after the decimal point, default 2
2581 * @param $round Boolean: whether or not to round the value, default true
2584 function wfPercent( $nr, $acc = 2, $round = true ) {
2585 $ret = sprintf( "%.${acc}f", $nr );
2586 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2590 * Find out whether or not a mixed variable exists in a string
2592 * @param $needle String
2593 * @param $str String
2594 * @param $insensitive Boolean
2597 function in_string( $needle, $str, $insensitive = false ) {
2599 if( $insensitive ) $func = 'stripos';
2601 return $func( $str, $needle ) !== false;
2605 * Safety wrapper around ini_get() for boolean settings.
2606 * The values returned from ini_get() are pre-normalized for settings
2607 * set via php.ini or php_flag/php_admin_flag... but *not*
2608 * for those set via php_value/php_admin_value.
2610 * It's fairly common for people to use php_value instead of php_flag,
2611 * which can leave you with an 'off' setting giving a false positive
2612 * for code that just takes the ini_get() return value as a boolean.
2614 * To make things extra interesting, setting via php_value accepts
2615 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2616 * Unrecognized values go false... again opposite PHP's own coercion
2617 * from string to bool.
2619 * Luckily, 'properly' set settings will always come back as '0' or '1',
2620 * so we only have to worry about them and the 'improper' settings.
2622 * I frickin' hate PHP... :P
2624 * @param $setting String
2627 function wfIniGetBool( $setting ) {
2628 $val = ini_get( $setting );
2629 // 'on' and 'true' can't have whitespace around them, but '1' can.
2630 return strtolower( $val ) == 'on'
2631 ||
strtolower( $val ) == 'true'
2632 ||
strtolower( $val ) == 'yes'
2633 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2637 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2638 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2640 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2642 * @param $fileName String Name of the library, if not $extension.suffix
2643 * @return Bool - Whether or not the extension is loaded
2645 function wfDl( $extension, $fileName = null ) {
2646 if( extension_loaded( $extension ) ) {
2651 $sapi = php_sapi_name();
2652 if( $sapi == 'cli' ||
$sapi == 'cgi' ||
$sapi == 'embed' ) {
2653 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2654 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2658 $fileName = $fileName ?
$fileName : $extension;
2659 if( wfIsWindows() ) {
2660 $fileName = 'php_' . $fileName;
2662 wfSuppressWarnings();
2663 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2664 wfRestoreWarnings();
2666 return extension_loaded( $extension );
2670 * Windows-compatible version of escapeshellarg()
2671 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2672 * function puts single quotes in regardless of OS.
2674 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2675 * earlier distro releases of PHP)
2680 function wfEscapeShellArg( ) {
2681 wfInitShellLocale();
2683 $args = func_get_args();
2686 foreach ( $args as $arg ) {
2693 if ( wfIsWindows() ) {
2694 // Escaping for an MSVC-style command line parser and CMD.EXE
2696 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2697 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2700 // Double the backslashes before any double quotes. Escape the double quotes.
2701 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2704 foreach ( $tokens as $token ) {
2705 if ( $iteration %
2 == 1 ) {
2706 // Delimiter, a double quote preceded by zero or more slashes
2707 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2708 } elseif ( $iteration %
4 == 2 ) {
2709 // ^ in $token will be outside quotes, need to be escaped
2710 $arg .= str_replace( '^', '^^', $token );
2711 } else { // $iteration % 4 == 0
2712 // ^ in $token will appear inside double quotes, so leave as is
2717 // Double the backslashes before the end of the string, because
2718 // we will soon add a quote
2720 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2721 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2724 // Add surrounding quotes
2725 $retVal .= '"' . $arg . '"';
2727 $retVal .= escapeshellarg( $arg );
2734 * Execute a shell command, with time and memory limits mirrored from the PHP
2735 * configuration if supported.
2736 * @param $cmd String Command line, properly escaped for shell.
2737 * @param &$retval null|Mixed optional, will receive the program's exit code.
2738 * (non-zero is usually failure)
2739 * @param $environ Array optional environment variables which should be
2740 * added to the executed command environment.
2741 * @param $limits Array optional array with limits(filesize, memory, time)
2742 * this overwrites the global wgShellMax* limits.
2743 * @return string collected stdout as a string (trailing newlines stripped)
2745 function wfShellExec( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2746 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime;
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( 'passthru', $functions ) ) {
2759 wfDebug( "passthru is in disabled_functions\n" );
2760 $disabled = 'passthru';
2766 return $disabled == 'safemode' ?
2767 'Unable to run external programs in safe mode.' :
2768 'Unable to run external programs, passthru() is disabled.';
2771 wfInitShellLocale();
2774 foreach( $environ as $k => $v ) {
2775 if ( wfIsWindows() ) {
2776 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2777 * appear in the environment variable, so we must use carat escaping as documented in
2778 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2779 * Note however that the quote isn't listed there, but is needed, and the parentheses
2780 * are listed there but doesn't appear to need it.
2782 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2784 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2785 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2787 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2790 $cmd = $envcmd . $cmd;
2792 if ( php_uname( 's' ) == 'Linux' ) {
2793 $time = intval ( isset($limits['time']) ?
$limits['time'] : $wgMaxShellTime );
2794 $mem = intval ( isset($limits['memory']) ?
$limits['memory'] : $wgMaxShellMemory );
2795 $filesize = intval ( isset($limits['filesize']) ?
$limits['filesize'] : $wgMaxShellFileSize );
2797 if ( $time > 0 && $mem > 0 ) {
2798 $script = "$IP/bin/ulimit4.sh";
2799 if ( is_executable( $script ) ) {
2800 $cmd = '/bin/bash ' . escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd );
2804 wfDebug( "wfShellExec: $cmd\n" );
2806 $retval = 1; // error by default?
2808 passthru( $cmd, $retval );
2809 $output = ob_get_contents();
2812 if ( $retval == 127 ) {
2813 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2819 * Workaround for http://bugs.php.net/bug.php?id=45132
2820 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2822 function wfInitShellLocale() {
2823 static $done = false;
2828 global $wgShellLocale;
2829 if ( !wfIniGetBool( 'safe_mode' ) ) {
2830 putenv( "LC_CTYPE=$wgShellLocale" );
2831 setlocale( LC_CTYPE
, $wgShellLocale );
2836 * Alias to wfShellWikiCmd()
2837 * @see wfShellWikiCmd()
2839 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2840 return wfShellWikiCmd( $script, $parameters, $options );
2844 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2845 * Note that $parameters should be a flat array and an option with an argument
2846 * should consist of two consecutive items in the array (do not use "--option value").
2847 * @param $script string MediaWiki cli script path
2848 * @param $parameters Array Arguments and options to the script
2849 * @param $options Array Associative array of options:
2850 * 'php': The path to the php executable
2851 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2854 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2856 // Give site config file a chance to run the script in a wrapper.
2857 // The caller may likely want to call wfBasename() on $script.
2858 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2859 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2860 if ( isset( $options['wrapper'] ) ) {
2861 $cmd[] = $options['wrapper'];
2864 // Escape each parameter for shell
2865 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2869 * wfMerge attempts to merge differences between three texts.
2870 * Returns true for a clean merge and false for failure or a conflict.
2872 * @param $old String
2873 * @param $mine String
2874 * @param $yours String
2875 * @param $result String
2878 function wfMerge( $old, $mine, $yours, &$result ) {
2881 # This check may also protect against code injection in
2882 # case of broken installations.
2883 wfSuppressWarnings();
2884 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2885 wfRestoreWarnings();
2888 wfDebug( "diff3 not found\n" );
2892 # Make temporary files
2894 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2895 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2896 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2898 fwrite( $oldtextFile, $old );
2899 fclose( $oldtextFile );
2900 fwrite( $mytextFile, $mine );
2901 fclose( $mytextFile );
2902 fwrite( $yourtextFile, $yours );
2903 fclose( $yourtextFile );
2905 # Check for a conflict
2906 $cmd = $wgDiff3 . ' -a --overlap-only ' .
2907 wfEscapeShellArg( $mytextName ) . ' ' .
2908 wfEscapeShellArg( $oldtextName ) . ' ' .
2909 wfEscapeShellArg( $yourtextName );
2910 $handle = popen( $cmd, 'r' );
2912 if( fgets( $handle, 1024 ) ) {
2920 $cmd = $wgDiff3 . ' -a -e --merge ' .
2921 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
2922 $handle = popen( $cmd, 'r' );
2925 $data = fread( $handle, 8192 );
2926 if ( strlen( $data ) == 0 ) {
2932 unlink( $mytextName );
2933 unlink( $oldtextName );
2934 unlink( $yourtextName );
2936 if ( $result === '' && $old !== '' && !$conflict ) {
2937 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2944 * Returns unified plain-text diff of two texts.
2945 * Useful for machine processing of diffs.
2947 * @param $before String: the text before the changes.
2948 * @param $after String: the text after the changes.
2949 * @param $params String: command-line options for the diff command.
2950 * @return String: unified diff of $before and $after
2952 function wfDiff( $before, $after, $params = '-u' ) {
2953 if ( $before == $after ) {
2958 wfSuppressWarnings();
2959 $haveDiff = $wgDiff && file_exists( $wgDiff );
2960 wfRestoreWarnings();
2962 # This check may also protect against code injection in
2963 # case of broken installations.
2965 wfDebug( "diff executable not found\n" );
2966 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2967 $format = new UnifiedDiffFormatter();
2968 return $format->format( $diffs );
2971 # Make temporary files
2973 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2974 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2976 fwrite( $oldtextFile, $before );
2977 fclose( $oldtextFile );
2978 fwrite( $newtextFile, $after );
2979 fclose( $newtextFile );
2981 // Get the diff of the two files
2982 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
2984 $h = popen( $cmd, 'r' );
2989 $data = fread( $h, 8192 );
2990 if ( strlen( $data ) == 0 ) {
2998 unlink( $oldtextName );
2999 unlink( $newtextName );
3001 // Kill the --- and +++ lines. They're not useful.
3002 $diff_lines = explode( "\n", $diff );
3003 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3004 unset( $diff_lines[0] );
3006 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3007 unset( $diff_lines[1] );
3010 $diff = implode( "\n", $diff_lines );
3016 * This function works like "use VERSION" in Perl, the program will die with a
3017 * backtrace if the current version of PHP is less than the version provided
3019 * This is useful for extensions which due to their nature are not kept in sync
3020 * with releases, and might depend on other versions of PHP than the main code
3022 * Note: PHP might die due to parsing errors in some cases before it ever
3023 * manages to call this function, such is life
3025 * @see perldoc -f use
3027 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3029 * @throws MWException
3031 function wfUsePHP( $req_ver ) {
3032 $php_ver = PHP_VERSION
;
3034 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3035 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3040 * This function works like "use VERSION" in Perl except it checks the version
3041 * of MediaWiki, the program will die with a backtrace if the current version
3042 * of MediaWiki is less than the version provided.
3044 * This is useful for extensions which due to their nature are not kept in sync
3047 * @see perldoc -f use
3049 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3051 * @throws MWException
3053 function wfUseMW( $req_ver ) {
3056 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3057 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3062 * Return the final portion of a pathname.
3063 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3064 * http://bugs.php.net/bug.php?id=33898
3066 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3067 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3069 * @param $path String
3070 * @param $suffix String: to remove if present
3073 function wfBaseName( $path, $suffix = '' ) {
3074 $encSuffix = ( $suffix == '' )
3076 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
3078 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3086 * Generate a relative path name to the given file.
3087 * May explode on non-matching case-insensitive paths,
3088 * funky symlinks, etc.
3090 * @param $path String: absolute destination path including target filename
3091 * @param $from String: Absolute source path, directory only
3094 function wfRelativePath( $path, $from ) {
3095 // Normalize mixed input on Windows...
3096 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3097 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3099 // Trim trailing slashes -- fix for drive root
3100 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3101 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3103 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3104 $against = explode( DIRECTORY_SEPARATOR
, $from );
3106 if( $pieces[0] !== $against[0] ) {
3107 // Non-matching Windows drive letters?
3108 // Return a full path.
3112 // Trim off common prefix
3113 while( count( $pieces ) && count( $against )
3114 && $pieces[0] == $against[0] ) {
3115 array_shift( $pieces );
3116 array_shift( $against );
3119 // relative dots to bump us to the parent
3120 while( count( $against ) ) {
3121 array_unshift( $pieces, '..' );
3122 array_shift( $against );
3125 array_push( $pieces, wfBaseName( $path ) );
3127 return implode( DIRECTORY_SEPARATOR
, $pieces );
3131 * Do any deferred updates and clear the list
3133 * @deprecated since 1.19
3134 * @see DeferredUpdates::doUpdate()
3135 * @param $commit string
3137 function wfDoUpdates( $commit = '' ) {
3138 wfDeprecated( __METHOD__
, '1.19' );
3139 DeferredUpdates
::doUpdates( $commit );
3143 * Convert an arbitrarily-long digit string from one numeric base
3144 * to another, optionally zero-padding to a minimum column width.
3146 * Supports base 2 through 36; digit values 10-36 are represented
3147 * as lowercase letters a-z. Input is case-insensitive.
3149 * @param $input String: of digits
3150 * @param $sourceBase Integer: 2-36
3151 * @param $destBase Integer: 2-36
3152 * @param $pad Integer: 1 or greater
3153 * @param $lowercase Boolean
3154 * @return String or false on invalid input
3156 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true ) {
3157 $input = strval( $input );
3158 if( $sourceBase < 2 ||
3163 $sourceBase != intval( $sourceBase ) ||
3164 $destBase != intval( $destBase ) ||
3165 $pad != intval( $pad ) ||
3166 !is_string( $input ) ||
3170 $digitChars = ( $lowercase ) ?
'0123456789abcdefghijklmnopqrstuvwxyz' : '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
3171 $inDigits = array();
3174 // Decode and validate input string
3175 $input = strtolower( $input );
3176 for( $i = 0; $i < strlen( $input ); $i++
) {
3177 $n = strpos( $digitChars, $input[$i] );
3178 if( $n === false ||
$n > $sourceBase ) {
3184 // Iterate over the input, modulo-ing out an output digit
3185 // at a time until input is gone.
3186 while( count( $inDigits ) ) {
3188 $workDigits = array();
3191 foreach( $inDigits as $digit ) {
3192 $work *= $sourceBase;
3195 if( $work < $destBase ) {
3196 // Gonna need to pull another digit.
3197 if( count( $workDigits ) ) {
3198 // Avoid zero-padding; this lets us find
3199 // the end of the input very easily when
3200 // length drops to zero.
3204 // Finally! Actual division!
3205 $workDigits[] = intval( $work / $destBase );
3207 // Isn't it annoying that most programming languages
3208 // don't have a single divide-and-remainder operator,
3209 // even though the CPU implements it that way?
3210 $work = $work %
$destBase;
3214 // All that division leaves us with a remainder,
3215 // which is conveniently our next output digit.
3216 $outChars .= $digitChars[$work];
3219 $inDigits = $workDigits;
3222 while( strlen( $outChars ) < $pad ) {
3226 return strrev( $outChars );
3230 * Create an object with a given name and an array of construct parameters
3232 * @param $name String
3233 * @param $p Array: parameters
3235 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3237 function wfCreateObject( $name, $p ) {
3238 wfDeprecated( __FUNCTION__
, '1.18' );
3239 return MWFunction
::newObj( $name, $p );
3245 function wfHttpOnlySafe() {
3246 global $wgHttpOnlyBlacklist;
3248 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3249 foreach( $wgHttpOnlyBlacklist as $regex ) {
3250 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3260 * Override session_id before session startup if php's built-in
3261 * session generation code is not secure.
3263 function wfFixSessionID() {
3264 // If the cookie or session id is already set we already have a session and should abort
3265 if ( isset( $_COOKIE[ session_name() ] ) ||
session_id() ) {
3269 // PHP's built-in session entropy is enabled if:
3270 // - entropy_file is set or you're on Windows with php 5.3.3+
3271 // - AND entropy_length is > 0
3272 // We treat it as disabled if it doesn't have an entropy length of at least 32
3274 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3275 ||
ini_get( 'session.entropy_file' )
3277 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3279 // If built-in entropy is not enabled or not sufficient override php's built in session id generation code
3280 if ( !$entropyEnabled ) {
3281 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, overriding session id generation using our cryptrand source.\n" );
3282 session_id( MWCryptRand
::generateHex( 32 ) );
3287 * Initialise php session
3289 * @param $sessionId Bool
3291 function wfSetupSession( $sessionId = false ) {
3292 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3293 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3294 if( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3295 ObjectCacheSessionHandler
::install();
3296 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3297 # Only set this if $wgSessionHandler isn't null and session.save_handler
3298 # hasn't already been set to the desired value (that causes errors)
3299 ini_set( 'session.save_handler', $wgSessionHandler );
3301 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3302 wfDebugLog( 'cookie',
3303 'session_set_cookie_params: "' . implode( '", "',
3309 $httpOnlySafe ) ) . '"' );
3310 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3311 session_cache_limiter( 'private, must-revalidate' );
3313 session_id( $sessionId );
3317 wfSuppressWarnings();
3319 wfRestoreWarnings();
3323 * Get an object from the precompiled serialized directory
3325 * @param $name String
3326 * @return Mixed: the variable on success, false on failure
3328 function wfGetPrecompiledData( $name ) {
3331 $file = "$IP/serialized/$name";
3332 if ( file_exists( $file ) ) {
3333 $blob = file_get_contents( $file );
3335 return unserialize( $blob );
3347 function wfMemcKey( /*... */ ) {
3348 global $wgCachePrefix;
3349 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3350 $args = func_get_args();
3351 $key = $prefix . ':' . implode( ':', $args );
3352 $key = str_replace( ' ', '_', $key );
3357 * Get a cache key for a foreign DB
3360 * @param $prefix String
3361 * @param varargs String
3364 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3365 $args = array_slice( func_get_args(), 2 );
3367 $key = "$db-$prefix:" . implode( ':', $args );
3369 $key = $db . ':' . implode( ':', $args );
3375 * Get an ASCII string identifying this wiki
3376 * This is used as a prefix in memcached keys
3380 function wfWikiID() {
3381 global $wgDBprefix, $wgDBname;
3382 if ( $wgDBprefix ) {
3383 return "$wgDBname-$wgDBprefix";
3390 * Split a wiki ID into DB name and table prefix
3392 * @param $wiki String
3396 function wfSplitWikiID( $wiki ) {
3397 $bits = explode( '-', $wiki, 2 );
3398 if ( count( $bits ) < 2 ) {
3405 * Get a Database object.
3407 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3408 * master (for write queries), DB_SLAVE for potentially lagged read
3409 * queries, or an integer >= 0 for a particular server.
3411 * @param $groups Mixed: query groups. An array of group names that this query
3412 * belongs to. May contain a single string if the query is only
3415 * @param $wiki String: the wiki ID, or false for the current wiki
3417 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3418 * will always return the same object, unless the underlying connection or load
3419 * balancer is manually destroyed.
3421 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3422 * updater to ensure that a proper database is being updated.
3424 * @return DatabaseBase
3426 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3427 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3431 * Get a load balancer object.
3433 * @param $wiki String: wiki ID, or false for the current wiki
3434 * @return LoadBalancer
3436 function wfGetLB( $wiki = false ) {
3437 return wfGetLBFactory()->getMainLB( $wiki );
3441 * Get the load balancer factory object
3445 function &wfGetLBFactory() {
3446 return LBFactory
::singleton();
3451 * Shortcut for RepoGroup::singleton()->findFile()
3453 * @param $title String or Title object
3454 * @param $options array Associative array of options:
3455 * time: requested time for an archived image, or false for the
3456 * current version. An image object will be returned which was
3457 * created at the specified time.
3459 * ignoreRedirect: If true, do not follow file redirects
3461 * private: If true, return restricted (deleted) files if the current
3462 * user is allowed to view them. Otherwise, such files will not
3465 * bypassCache: If true, do not use the process-local cache of File objects
3467 * @return File, or false if the file does not exist
3469 function wfFindFile( $title, $options = array() ) {
3470 return RepoGroup
::singleton()->findFile( $title, $options );
3474 * Get an object referring to a locally registered file.
3475 * Returns a valid placeholder object if the file does not exist.
3477 * @param $title Title|String
3478 * @return LocalFile|null A File, or null if passed an invalid Title
3480 function wfLocalFile( $title ) {
3481 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3485 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3486 * @deprecated since 1.19
3488 function wfStreamFile( $fname, $headers = array() ) {
3489 wfDeprecated( __FUNCTION__
, '1.19' );
3490 StreamFile
::stream( $fname, $headers );
3494 * Should low-performance queries be disabled?
3497 * @codeCoverageIgnore
3499 function wfQueriesMustScale() {
3500 global $wgMiserMode;
3502 ||
( SiteStats
::pages() > 100000
3503 && SiteStats
::edits() > 1000000
3504 && SiteStats
::users() > 10000 );
3508 * Get the path to a specified script file, respecting file
3509 * extensions; this is a wrapper around $wgScriptExtension etc.
3510 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3512 * @param $script String: script filename, sans extension
3515 function wfScript( $script = 'index' ) {
3516 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3517 if ( $script === 'index' ) {
3519 } else if ( $script === 'load' ) {
3520 return $wgLoadScript;
3522 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3527 * Get the script URL.
3529 * @return string script URL
3531 function wfGetScriptUrl() {
3532 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3534 # as it was called, minus the query string.
3536 # Some sites use Apache rewrite rules to handle subdomains,
3537 # and have PHP set up in a weird way that causes PHP_SELF
3538 # to contain the rewritten URL instead of the one that the
3539 # outside world sees.
3541 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3542 # provides containing the "before" URL.
3543 return $_SERVER['SCRIPT_NAME'];
3545 return $_SERVER['URL'];
3550 * Convenience function converts boolean values into "true"
3551 * or "false" (string) values
3553 * @param $value Boolean
3556 function wfBoolToStr( $value ) {
3557 return $value ?
'true' : 'false';
3561 * Get a platform-independent path to the null file, e.g. /dev/null
3565 function wfGetNull() {
3566 return wfIsWindows()
3572 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3573 * and waiting for it to go down, this waits for the slaves to catch up to the
3574 * master position. Use this when updating very large numbers of rows, as
3575 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3576 * a no-op if there are no slaves.
3578 * @param $maxLag Integer (deprecated)
3579 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3581 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3582 $lb = wfGetLB( $wiki );
3583 // bug 27975 - Don't try to wait for slaves if there are none
3584 // Prevents permission error when getting master position
3585 if ( $lb->getServerCount() > 1 ) {
3586 $dbw = $lb->getConnection( DB_MASTER
);
3587 $pos = $dbw->getMasterPos();
3588 $lb->waitForAll( $pos );
3593 * Used to be used for outputting text in the installer/updater
3594 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3596 function wfOut( $s ) {
3597 wfDeprecated( __FUNCTION__
, '1.18' );
3598 global $wgCommandLineMode;
3599 if ( $wgCommandLineMode ) {
3602 echo htmlspecialchars( $s );
3608 * Count down from $n to zero on the terminal, with a one-second pause
3609 * between showing each number. For use in command-line scripts.
3610 * @codeCoverageIgnore
3613 function wfCountDown( $n ) {
3614 for ( $i = $n; $i >= 0; $i-- ) {
3616 echo str_repeat( "\x08", strlen( $i +
1 ) );
3628 * Generate a random 32-character hexadecimal token.
3629 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3630 * characters before hashing.
3632 * @codeCoverageIgnore
3633 * @deprecated since 1.20; Please use MWCryptRand for security purposes and wfRandomString for pesudo-random strings
3634 * @warning This method is NOT secure. Additionally it has many callers that use it for pesudo-random purposes.
3636 function wfGenerateToken( $salt = '' ) {
3637 wfDeprecated( __METHOD__
, '1.20' );
3638 $salt = serialize( $salt );
3639 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3643 * Replace all invalid characters with -
3644 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3645 * By default, $wgIllegalFileChars = ':'
3647 * @param $name Mixed: filename to process
3650 function wfStripIllegalFilenameChars( $name ) {
3651 global $wgIllegalFileChars;
3652 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3653 $name = wfBaseName( $name );
3654 $name = preg_replace(
3655 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3663 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3665 * @return Integer value memory was set to.
3667 function wfMemoryLimit() {
3668 global $wgMemoryLimit;
3669 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3670 if( $memlimit != -1 ) {
3671 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3672 if( $conflimit == -1 ) {
3673 wfDebug( "Removing PHP's memory limit\n" );
3674 wfSuppressWarnings();
3675 ini_set( 'memory_limit', $conflimit );
3676 wfRestoreWarnings();
3678 } elseif ( $conflimit > $memlimit ) {
3679 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3680 wfSuppressWarnings();
3681 ini_set( 'memory_limit', $conflimit );
3682 wfRestoreWarnings();
3690 * Converts shorthand byte notation to integer form
3692 * @param $string String
3695 function wfShorthandToInteger( $string = '' ) {
3696 $string = trim( $string );
3697 if( $string === '' ) {
3700 $last = $string[strlen( $string ) - 1];
3701 $val = intval( $string );
3706 // break intentionally missing
3710 // break intentionally missing
3720 * Get the normalised IETF language tag
3721 * See unit test for examples.
3723 * @param $code String: The language code.
3724 * @return String: The language code which complying with BCP 47 standards.
3726 function wfBCP47( $code ) {
3727 $codeSegment = explode( '-', $code );
3729 foreach ( $codeSegment as $segNo => $seg ) {
3730 if ( count( $codeSegment ) > 0 ) {
3731 // when previous segment is x, it is a private segment and should be lc
3732 if( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3733 $codeBCP[$segNo] = strtolower( $seg );
3734 // ISO 3166 country code
3735 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3736 $codeBCP[$segNo] = strtoupper( $seg );
3737 // ISO 15924 script code
3738 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3739 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3740 // Use lowercase for other cases
3742 $codeBCP[$segNo] = strtolower( $seg );
3745 // Use lowercase for single segment
3746 $codeBCP[$segNo] = strtolower( $seg );
3749 $langCode = implode( '-', $codeBCP );
3754 * Get a cache object.
3756 * @param $inputType integer Cache type, one the the CACHE_* constants.
3759 function wfGetCache( $inputType ) {
3760 return ObjectCache
::getInstance( $inputType );
3764 * Get the main cache object
3768 function wfGetMainCache() {
3769 global $wgMainCacheType;
3770 return ObjectCache
::getInstance( $wgMainCacheType );
3774 * Get the cache object used by the message cache
3778 function wfGetMessageCacheStorage() {
3779 global $wgMessageCacheType;
3780 return ObjectCache
::getInstance( $wgMessageCacheType );
3784 * Get the cache object used by the parser cache
3788 function wfGetParserCacheStorage() {
3789 global $wgParserCacheType;
3790 return ObjectCache
::getInstance( $wgParserCacheType );
3794 * Get the cache object used by the language converter
3798 function wfGetLangConverterCacheStorage() {
3799 global $wgLanguageConverterCacheType;
3800 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3804 * Call hook functions defined in $wgHooks
3806 * @param $event String: event name
3807 * @param $args Array: parameters passed to hook functions
3808 * @return Boolean True if no handler aborted the hook
3810 function wfRunHooks( $event, $args = array() ) {
3811 return Hooks
::run( $event, $args );
3815 * Wrapper around php's unpack.
3817 * @param $format String: The format string (See php's docs)
3818 * @param $data: A binary string of binary data
3819 * @param $length integer or false: The minimun length of $data. This is to
3820 * prevent reading beyond the end of $data. false to disable the check.
3822 * Also be careful when using this function to read unsigned 32 bit integer
3823 * because php might make it negative.
3825 * @throws MWException if $data not long enough, or if unpack fails
3826 * @return array Associative array of the extracted data
3828 function wfUnpack( $format, $data, $length=false ) {
3829 if ( $length !== false ) {
3830 $realLen = strlen( $data );
3831 if ( $realLen < $length ) {
3832 throw new MWException( "Tried to use wfUnpack on a "
3833 . "string of length $realLen, but needed one "
3834 . "of at least length $length."
3839 wfSuppressWarnings();
3840 $result = unpack( $format, $data );
3841 wfRestoreWarnings();
3843 if ( $result === false ) {
3844 // If it cannot extract the packed data.
3845 throw new MWException( "unpack could not unpack binary data" );
3851 * Determine if an image exists on the 'bad image list'.
3853 * The format of MediaWiki:Bad_image_list is as follows:
3854 * * Only list items (lines starting with "*") are considered
3855 * * The first link on a line must be a link to a bad image
3856 * * Any subsequent links on the same line are considered to be exceptions,
3857 * i.e. articles where the image may occur inline.
3859 * @param $name string the image name to check
3860 * @param $contextTitle Title|bool the page on which the image occurs, if known
3861 * @param $blacklist string wikitext of a file blacklist
3864 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3865 static $badImageCache = null; // based on bad_image_list msg
3866 wfProfileIn( __METHOD__
);
3869 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
3870 if( $redirectTitle ) {
3871 $name = $redirectTitle->getDbKey();
3874 # Run the extension hook
3876 if( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
3877 wfProfileOut( __METHOD__
);
3881 $cacheable = ( $blacklist === null );
3882 if( $cacheable && $badImageCache !== null ) {
3883 $badImages = $badImageCache;
3884 } else { // cache miss
3885 if ( $blacklist === null ) {
3886 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3888 # Build the list now
3889 $badImages = array();
3890 $lines = explode( "\n", $blacklist );
3891 foreach( $lines as $line ) {
3893 if ( substr( $line, 0, 1 ) !== '*' ) {
3899 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3903 $exceptions = array();
3904 $imageDBkey = false;
3905 foreach ( $m[1] as $i => $titleText ) {
3906 $title = Title
::newFromText( $titleText );
3907 if ( !is_null( $title ) ) {
3909 $imageDBkey = $title->getDBkey();
3911 $exceptions[$title->getPrefixedDBkey()] = true;
3916 if ( $imageDBkey !== false ) {
3917 $badImages[$imageDBkey] = $exceptions;
3921 $badImageCache = $badImages;
3925 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3926 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3927 wfProfileOut( __METHOD__
);