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( "[$logGroup] $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';
1218 // Command line script uses a FauxRequest object which does not have
1219 // any knowledge about an URL and throw an exception instead.
1221 $requestUrl = $wgRequest->getRequestURL();
1222 } catch ( MWException
$e ) {
1223 $requestUrl = 'n/a';
1226 $log = sprintf( "%s\t%04.3f\t%s\n",
1227 gmdate( 'YmdHis' ), $elapsed,
1228 urldecode( $requestUrl . $forward ) );
1230 wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile );
1234 * Increment a statistics counter
1236 * @param $key String
1240 function wfIncrStats( $key, $count = 1 ) {
1241 global $wgStatsMethod;
1243 $count = intval( $count );
1244 if ( $count == 0 ) {
1248 if( $wgStatsMethod == 'udp' ) {
1249 global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgAggregateStatsID;
1252 $id = $wgAggregateStatsID !== false ?
$wgAggregateStatsID : wfWikiID();
1255 $socket = socket_create( AF_INET
, SOCK_DGRAM
, SOL_UDP
);
1256 $statline = "stats/{$id} - 1 1 1 1 1 -total\n";
1260 strlen( $statline ),
1266 $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n";
1267 wfSuppressWarnings();
1271 strlen( $statline ),
1276 wfRestoreWarnings();
1277 } elseif( $wgStatsMethod == 'cache' ) {
1279 $key = wfMemcKey( 'stats', $key );
1280 if ( is_null( $wgMemc->incr( $key, $count ) ) ) {
1281 $wgMemc->add( $key, $count );
1289 * Check if the wiki read-only lock file is present. This can be used to lock
1290 * off editing functions, but doesn't guarantee that the database will not be
1295 function wfReadOnly() {
1296 global $wgReadOnlyFile, $wgReadOnly;
1298 if ( !is_null( $wgReadOnly ) ) {
1299 return (bool)$wgReadOnly;
1301 if ( $wgReadOnlyFile == '' ) {
1304 // Set $wgReadOnly for faster access next time
1305 if ( is_file( $wgReadOnlyFile ) ) {
1306 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1308 $wgReadOnly = false;
1310 return (bool)$wgReadOnly;
1316 function wfReadOnlyReason() {
1323 * Return a Language object from $langcode
1325 * @param $langcode Mixed: either:
1326 * - a Language object
1327 * - code of the language to get the message for, if it is
1328 * a valid code create a language for that language, if
1329 * it is a string but not a valid code then make a basic
1331 * - a boolean: if it's false then use the global object for
1332 * the current user's language (as a fallback for the old parameter
1333 * functionality), or if it is true then use global object
1334 * for the wiki's content language.
1335 * @return Language object
1337 function wfGetLangObj( $langcode = false ) {
1338 # Identify which language to get or create a language object for.
1339 # Using is_object here due to Stub objects.
1340 if( is_object( $langcode ) ) {
1341 # Great, we already have the object (hopefully)!
1345 global $wgContLang, $wgLanguageCode;
1346 if( $langcode === true ||
$langcode === $wgLanguageCode ) {
1347 # $langcode is the language code of the wikis content language object.
1348 # or it is a boolean and value is true
1353 if( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1354 # $langcode is the language code of user language object.
1355 # or it was a boolean and value is false
1359 $validCodes = array_keys( Language
::fetchLanguageNames() );
1360 if( in_array( $langcode, $validCodes ) ) {
1361 # $langcode corresponds to a valid language.
1362 return Language
::factory( $langcode );
1365 # $langcode is a string, but not a valid language code; use content language.
1366 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1371 * Old function when $wgBetterDirectionality existed
1372 * All usage removed, wfUILang can be removed in near future
1374 * @deprecated since 1.18
1377 function wfUILang() {
1378 wfDeprecated( __METHOD__
, '1.18' );
1384 * This is the new function for getting translated interface messages.
1385 * See the Message class for documentation how to use them.
1386 * The intention is that this function replaces all old wfMsg* functions.
1387 * @param $key \string Message key.
1388 * Varargs: normal message parameters.
1392 function wfMessage( $key /*...*/) {
1393 $params = func_get_args();
1394 array_shift( $params );
1395 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1396 $params = $params[0];
1398 return new Message( $key, $params );
1402 * This function accepts multiple message keys and returns a message instance
1403 * for the first message which is non-empty. If all messages are empty then an
1404 * instance of the first message key is returned.
1405 * @param varargs: message keys
1409 function wfMessageFallback( /*...*/ ) {
1410 $args = func_get_args();
1411 return MWFunction
::callArray( 'Message::newFallbackSequence', $args );
1415 * Get a message from anywhere, for the current user language.
1417 * Use wfMsgForContent() instead if the message should NOT
1418 * change depending on the user preferences.
1420 * @deprecated since 1.18
1422 * @param $key String: lookup key for the message, usually
1423 * defined in languages/Language.php
1425 * Parameters to the message, which can be used to insert variable text into
1426 * it, can be passed to this function in the following formats:
1427 * - One per argument, starting at the second parameter
1428 * - As an array in the second parameter
1429 * These are not shown in the function definition.
1433 function wfMsg( $key ) {
1434 wfDeprecated( __METHOD__
, '1.21' );
1436 $args = func_get_args();
1437 array_shift( $args );
1438 return wfMsgReal( $key, $args );
1442 * Same as above except doesn't transform the message
1444 * @deprecated since 1.18
1446 * @param $key String
1449 function wfMsgNoTrans( $key ) {
1450 wfDeprecated( __METHOD__
, '1.21' );
1452 $args = func_get_args();
1453 array_shift( $args );
1454 return wfMsgReal( $key, $args, true, false, false );
1458 * Get a message from anywhere, for the current global language
1459 * set with $wgLanguageCode.
1461 * Use this if the message should NOT change dependent on the
1462 * language set in the user's preferences. This is the case for
1463 * most text written into logs, as well as link targets (such as
1464 * the name of the copyright policy page). Link titles, on the
1465 * other hand, should be shown in the UI language.
1467 * Note that MediaWiki allows users to change the user interface
1468 * language in their preferences, but a single installation
1469 * typically only contains content in one language.
1471 * Be wary of this distinction: If you use wfMsg() where you should
1472 * use wfMsgForContent(), a user of the software may have to
1473 * customize potentially hundreds of messages in
1474 * order to, e.g., fix a link in every possible language.
1476 * @deprecated since 1.18
1478 * @param $key String: lookup key for the message, usually
1479 * defined in languages/Language.php
1482 function wfMsgForContent( $key ) {
1483 wfDeprecated( __METHOD__
, '1.21' );
1485 global $wgForceUIMsgAsContentMsg;
1486 $args = func_get_args();
1487 array_shift( $args );
1489 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1490 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1492 $forcontent = false;
1494 return wfMsgReal( $key, $args, true, $forcontent );
1498 * Same as above except doesn't transform the message
1500 * @deprecated since 1.18
1502 * @param $key String
1505 function wfMsgForContentNoTrans( $key ) {
1506 wfDeprecated( __METHOD__
, '1.21' );
1508 global $wgForceUIMsgAsContentMsg;
1509 $args = func_get_args();
1510 array_shift( $args );
1512 if( is_array( $wgForceUIMsgAsContentMsg ) &&
1513 in_array( $key, $wgForceUIMsgAsContentMsg ) )
1515 $forcontent = false;
1517 return wfMsgReal( $key, $args, true, $forcontent, false );
1521 * Really get a message
1523 * @deprecated since 1.18
1525 * @param $key String: key to get.
1527 * @param $useDB Boolean
1528 * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
1529 * @param $transform Boolean: Whether or not to transform the message.
1530 * @return String: the requested message.
1532 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
1533 wfDeprecated( __METHOD__
, '1.21' );
1535 wfProfileIn( __METHOD__
);
1536 $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
1537 $message = wfMsgReplaceArgs( $message, $args );
1538 wfProfileOut( __METHOD__
);
1543 * Fetch a message string value, but don't replace any keys yet.
1545 * @deprecated since 1.18
1547 * @param $key String
1548 * @param $useDB Bool
1549 * @param $langCode String: Code of the language to get the message for, or
1550 * behaves as a content language switch if it is a boolean.
1551 * @param $transform Boolean: whether to parse magic words, etc.
1554 function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) {
1555 wfDeprecated( __METHOD__
, '1.21' );
1557 wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) );
1559 $cache = MessageCache
::singleton();
1560 $message = $cache->get( $key, $useDB, $langCode );
1561 if( $message === false ) {
1562 $message = '<' . htmlspecialchars( $key ) . '>';
1563 } elseif ( $transform ) {
1564 $message = $cache->transform( $message );
1570 * Replace message parameter keys on the given formatted output.
1572 * @param $message String
1573 * @param $args Array
1577 function wfMsgReplaceArgs( $message, $args ) {
1578 # Fix windows line-endings
1579 # Some messages are split with explode("\n", $msg)
1580 $message = str_replace( "\r", '', $message );
1582 // Replace arguments
1583 if ( count( $args ) ) {
1584 if ( is_array( $args[0] ) ) {
1585 $args = array_values( $args[0] );
1587 $replacementKeys = array();
1588 foreach( $args as $n => $param ) {
1589 $replacementKeys['$' . ( $n +
1 )] = $param;
1591 $message = strtr( $message, $replacementKeys );
1598 * Return an HTML-escaped version of a message.
1599 * Parameter replacements, if any, are done *after* the HTML-escaping,
1600 * so parameters may contain HTML (eg links or form controls). Be sure
1601 * to pre-escape them if you really do want plaintext, or just wrap
1602 * the whole thing in htmlspecialchars().
1604 * @deprecated since 1.18
1606 * @param $key String
1607 * @param string ... parameters
1610 function wfMsgHtml( $key ) {
1611 wfDeprecated( __METHOD__
, '1.21' );
1613 $args = func_get_args();
1614 array_shift( $args );
1615 return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args );
1619 * Return an HTML version of message
1620 * Parameter replacements, if any, are done *after* parsing the wiki-text message,
1621 * so parameters may contain HTML (eg links or form controls). Be sure
1622 * to pre-escape them if you really do want plaintext, or just wrap
1623 * the whole thing in htmlspecialchars().
1625 * @deprecated since 1.18
1627 * @param $key String
1628 * @param string ... parameters
1631 function wfMsgWikiHtml( $key ) {
1632 wfDeprecated( __METHOD__
, '1.21' );
1634 $args = func_get_args();
1635 array_shift( $args );
1636 return wfMsgReplaceArgs(
1637 MessageCache
::singleton()->parse( wfMsgGetKey( $key ), null,
1638 /* can't be set to false */ true, /* interface */ true )->getText(),
1643 * Returns message in the requested format
1645 * @deprecated since 1.18
1647 * @param $key String: key of the message
1648 * @param $options Array: processing rules. Can take the following options:
1649 * <i>parse</i>: parses wikitext to HTML
1650 * <i>parseinline</i>: parses wikitext to HTML and removes the surrounding
1651 * p's added by parser or tidy
1652 * <i>escape</i>: filters message through htmlspecialchars
1653 * <i>escapenoentities</i>: same, but allows entity references like   through
1654 * <i>replaceafter</i>: parameters are substituted after parsing or escaping
1655 * <i>parsemag</i>: transform the message using magic phrases
1656 * <i>content</i>: fetch message for content language instead of interface
1657 * Also can accept a single associative argument, of the form 'language' => 'xx':
1658 * <i>language</i>: Language object or language code to fetch message for
1659 * (overriden by <i>content</i>).
1660 * Behavior for conflicting options (e.g., parse+parseinline) is undefined.
1664 function wfMsgExt( $key, $options ) {
1665 wfDeprecated( __METHOD__
, '1.21' );
1667 $args = func_get_args();
1668 array_shift( $args );
1669 array_shift( $args );
1670 $options = (array)$options;
1672 foreach( $options as $arrayKey => $option ) {
1673 if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) {
1674 # An unknown index, neither numeric nor "language"
1675 wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING
);
1676 } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option,
1677 array( 'parse', 'parseinline', 'escape', 'escapenoentities',
1678 'replaceafter', 'parsemag', 'content' ) ) ) {
1679 # A numeric index with unknown value
1680 wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING
);
1684 if( in_array( 'content', $options, true ) ) {
1687 $langCodeObj = null;
1688 } elseif( array_key_exists( 'language', $options ) ) {
1689 $forContent = false;
1690 $langCode = wfGetLangObj( $options['language'] );
1691 $langCodeObj = $langCode;
1693 $forContent = false;
1695 $langCodeObj = null;
1698 $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false );
1700 if( !in_array( 'replaceafter', $options, true ) ) {
1701 $string = wfMsgReplaceArgs( $string, $args );
1704 $messageCache = MessageCache
::singleton();
1705 $parseInline = in_array( 'parseinline', $options, true );
1706 if( in_array( 'parse', $options, true ) ||
$parseInline ) {
1707 $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj );
1708 if ( $string instanceof ParserOutput
) {
1709 $string = $string->getText();
1712 if ( $parseInline ) {
1714 if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) {
1718 } elseif ( in_array( 'parsemag', $options, true ) ) {
1719 $string = $messageCache->transform( $string,
1720 !$forContent, $langCodeObj );
1723 if ( in_array( 'escape', $options, true ) ) {
1724 $string = htmlspecialchars ( $string );
1725 } elseif ( in_array( 'escapenoentities', $options, true ) ) {
1726 $string = Sanitizer
::escapeHtmlAllowEntities( $string );
1729 if( in_array( 'replaceafter', $options, true ) ) {
1730 $string = wfMsgReplaceArgs( $string, $args );
1737 * Since wfMsg() and co suck, they don't return false if the message key they
1738 * looked up didn't exist but a XHTML string, this function checks for the
1739 * nonexistance of messages by checking the MessageCache::get() result directly.
1741 * @deprecated since 1.18. Use Message::isDisabled().
1743 * @param $key String: the message key looked up
1744 * @return Boolean True if the message *doesn't* exist.
1746 function wfEmptyMsg( $key ) {
1747 wfDeprecated( __METHOD__
, '1.21' );
1749 return MessageCache
::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false;
1753 * Throw a debugging exception. This function previously once exited the process,
1754 * but now throws an exception instead, with similar results.
1756 * @param $msg String: message shown when dying.
1757 * @throws MWException
1759 function wfDebugDieBacktrace( $msg = '' ) {
1760 throw new MWException( $msg );
1764 * Fetch server name for use in error reporting etc.
1765 * Use real server name if available, so we know which machine
1766 * in a server farm generated the current page.
1770 function wfHostname() {
1772 if ( is_null( $host ) ) {
1774 # Hostname overriding
1775 global $wgOverrideHostname;
1776 if( $wgOverrideHostname !== false ) {
1777 # Set static and skip any detection
1778 $host = $wgOverrideHostname;
1782 if ( function_exists( 'posix_uname' ) ) {
1783 // This function not present on Windows
1784 $uname = posix_uname();
1788 if( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1789 $host = $uname['nodename'];
1790 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1791 # Windows computer name
1792 $host = getenv( 'COMPUTERNAME' );
1794 # This may be a virtual server.
1795 $host = $_SERVER['SERVER_NAME'];
1802 * Returns a HTML comment with the elapsed time since request.
1803 * This method has no side effects.
1807 function wfReportTime() {
1808 global $wgRequestTime, $wgShowHostnames;
1810 $elapsed = microtime( true ) - $wgRequestTime;
1812 return $wgShowHostnames
1813 ?
sprintf( '<!-- Served by %s in %01.3f secs. -->', wfHostname(), $elapsed )
1814 : sprintf( '<!-- Served in %01.3f secs. -->', $elapsed );
1818 * Safety wrapper for debug_backtrace().
1820 * With Zend Optimizer 3.2.0 loaded, this causes segfaults under somewhat
1821 * murky circumstances, which may be triggered in part by stub objects
1822 * or other fancy talkin'.
1824 * Will return an empty array if Zend Optimizer is detected or if
1825 * debug_backtrace is disabled, otherwise the output from
1826 * debug_backtrace() (trimmed).
1828 * @param $limit int This parameter can be used to limit the number of stack frames returned
1830 * @return array of backtrace information
1832 function wfDebugBacktrace( $limit = 0 ) {
1833 static $disabled = null;
1835 if( extension_loaded( 'Zend Optimizer' ) ) {
1836 wfDebug( "Zend Optimizer detected; skipping debug_backtrace for safety.\n" );
1840 if ( is_null( $disabled ) ) {
1842 $functions = explode( ',', ini_get( 'disable_functions' ) );
1843 $functions = array_map( 'trim', $functions );
1844 $functions = array_map( 'strtolower', $functions );
1845 if ( in_array( 'debug_backtrace', $functions ) ) {
1846 wfDebug( "debug_backtrace is in disabled_functions\n" );
1854 if ( $limit && version_compare( PHP_VERSION
, '5.4.0', '>=' ) ) {
1855 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1857 return array_slice( debug_backtrace(), 1 );
1862 * Get a debug backtrace as a string
1866 function wfBacktrace() {
1867 global $wgCommandLineMode;
1869 if ( $wgCommandLineMode ) {
1874 $backtrace = wfDebugBacktrace();
1875 foreach( $backtrace as $call ) {
1876 if( isset( $call['file'] ) ) {
1877 $f = explode( DIRECTORY_SEPARATOR
, $call['file'] );
1878 $file = $f[count( $f ) - 1];
1882 if( isset( $call['line'] ) ) {
1883 $line = $call['line'];
1887 if ( $wgCommandLineMode ) {
1888 $msg .= "$file line $line calls ";
1890 $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
1892 if( !empty( $call['class'] ) ) {
1893 $msg .= $call['class'] . $call['type'];
1895 $msg .= $call['function'] . '()';
1897 if ( $wgCommandLineMode ) {
1903 if ( $wgCommandLineMode ) {
1913 * Get the name of the function which called this function
1914 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1915 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1916 * wfGetCaller( 3 ) is the parent of that.
1921 function wfGetCaller( $level = 2 ) {
1922 $backtrace = wfDebugBacktrace( $level +
1 );
1923 if ( isset( $backtrace[$level] ) ) {
1924 return wfFormatStackFrame( $backtrace[$level] );
1931 * Return a string consisting of callers in the stack. Useful sometimes
1932 * for profiling specific points.
1934 * @param $limit int The maximum depth of the stack frame to return, or false for
1938 function wfGetAllCallers( $limit = 3 ) {
1939 $trace = array_reverse( wfDebugBacktrace() );
1940 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1941 $limit = count( $trace ) - 1;
1943 $trace = array_slice( $trace, -$limit - 1, $limit );
1944 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1948 * Return a string representation of frame
1950 * @param $frame Array
1953 function wfFormatStackFrame( $frame ) {
1954 return isset( $frame['class'] ) ?
1955 $frame['class'] . '::' . $frame['function'] :
1960 /* Some generic result counters, pulled out of SearchEngine */
1966 * @param $offset Int
1970 function wfShowingResults( $offset, $limit ) {
1971 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1975 * Generate (prev x| next x) (20|50|100...) type links for paging
1977 * @param $offset String
1978 * @param $limit Integer
1979 * @param $link String
1980 * @param $query String: optional URL query parameter string
1981 * @param $atend Bool: optional param for specified if this is the last page
1983 * @deprecated in 1.19; use Language::viewPrevNext() instead
1985 function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
1986 wfDeprecated( __METHOD__
, '1.19' );
1990 $query = wfCgiToArray( $query );
1992 if( is_object( $link ) ) {
1995 $title = Title
::newFromText( $link );
1996 if( is_null( $title ) ) {
2001 return $wgLang->viewPrevNext( $title, $offset, $limit, $query, $atend );
2005 * Make a list item, used by various special pages
2007 * @param $page String Page link
2008 * @param $details String Text between brackets
2009 * @param $oppositedm Boolean Add the direction mark opposite to your
2010 * language, to display text properly
2012 * @deprecated since 1.19; use Language::specialList() instead
2014 function wfSpecialList( $page, $details, $oppositedm = true ) {
2015 wfDeprecated( __METHOD__
, '1.19' );
2018 return $wgLang->specialList( $page, $details, $oppositedm );
2023 * @todo FIXME: We may want to blacklist some broken browsers
2025 * @param $force Bool
2026 * @return bool Whereas client accept gzip compression
2028 function wfClientAcceptsGzip( $force = false ) {
2029 static $result = null;
2030 if ( $result === null ||
$force ) {
2032 if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
2033 # @todo FIXME: We may want to blacklist some broken browsers
2036 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
2037 $_SERVER['HTTP_ACCEPT_ENCODING'],
2041 if( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
2045 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
2054 * Obtain the offset and limit values from the request string;
2055 * used in special pages
2057 * @param $deflimit Int default limit if none supplied
2058 * @param $optionname String Name of a user preference to check against
2062 function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
2064 return $wgRequest->getLimitOffset( $deflimit, $optionname );
2068 * Escapes the given text so that it may be output using addWikiText()
2069 * without any linking, formatting, etc. making its way through. This
2070 * is achieved by substituting certain characters with HTML entities.
2071 * As required by the callers, "<nowiki>" is not used.
2073 * @param $text String: text to be escaped
2076 function wfEscapeWikiText( $text ) {
2077 $text = strtr( "\n$text", array(
2078 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
2079 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
2080 '{' => '{', '|' => '|', '}' => '}',
2081 "\n#" => "\n#", "\n*" => "\n*",
2082 "\n:" => "\n:", "\n;" => "\n;",
2083 '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ',
2085 return substr( $text, 1 );
2089 * Get the current unix timetstamp with microseconds. Useful for profiling
2093 return microtime( true );
2097 * Sets dest to source and returns the original value of dest
2098 * If source is NULL, it just returns the value, it doesn't set the variable
2099 * If force is true, it will set the value even if source is NULL
2101 * @param $dest Mixed
2102 * @param $source Mixed
2103 * @param $force Bool
2106 function wfSetVar( &$dest, $source, $force = false ) {
2108 if ( !is_null( $source ) ||
$force ) {
2115 * As for wfSetVar except setting a bit
2119 * @param $state Bool
2123 function wfSetBit( &$dest, $bit, $state = true ) {
2124 $temp = (bool)( $dest & $bit );
2125 if ( !is_null( $state ) ) {
2136 * A wrapper around the PHP function var_export().
2137 * Either print it or add it to the regular output ($wgOut).
2139 * @param $var mixed A PHP variable to dump.
2141 function wfVarDump( $var ) {
2143 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
2144 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
2147 $wgOut->addHTML( $s );
2152 * Provide a simple HTTP error.
2154 * @param $code Int|String
2155 * @param $label String
2156 * @param $desc String
2158 function wfHttpError( $code, $label, $desc ) {
2161 header( "HTTP/1.0 $code $label" );
2162 header( "Status: $code $label" );
2163 $wgOut->sendCacheControl();
2165 header( 'Content-type: text/html; charset=utf-8' );
2166 print "<!doctype html>" .
2167 '<html><head><title>' .
2168 htmlspecialchars( $label ) .
2169 '</title></head><body><h1>' .
2170 htmlspecialchars( $label ) .
2172 nl2br( htmlspecialchars( $desc ) ) .
2173 "</p></body></html>\n";
2177 * Clear away any user-level output buffers, discarding contents.
2179 * Suitable for 'starting afresh', for instance when streaming
2180 * relatively large amounts of data without buffering, or wanting to
2181 * output image files without ob_gzhandler's compression.
2183 * The optional $resetGzipEncoding parameter controls suppression of
2184 * the Content-Encoding header sent by ob_gzhandler; by default it
2185 * is left. See comments for wfClearOutputBuffers() for why it would
2188 * Note that some PHP configuration options may add output buffer
2189 * layers which cannot be removed; these are left in place.
2191 * @param $resetGzipEncoding Bool
2193 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
2194 if( $resetGzipEncoding ) {
2195 // Suppress Content-Encoding and Content-Length
2196 // headers from 1.10+s wfOutputHandler
2197 global $wgDisableOutputCompression;
2198 $wgDisableOutputCompression = true;
2200 while( $status = ob_get_status() ) {
2201 if( $status['type'] == 0 /* PHP_OUTPUT_HANDLER_INTERNAL */ ) {
2202 // Probably from zlib.output_compression or other
2203 // PHP-internal setting which can't be removed.
2205 // Give up, and hope the result doesn't break
2209 if( !ob_end_clean() ) {
2210 // Could not remove output buffer handler; abort now
2211 // to avoid getting in some kind of infinite loop.
2214 if( $resetGzipEncoding ) {
2215 if( $status['name'] == 'ob_gzhandler' ) {
2216 // Reset the 'Content-Encoding' field set by this handler
2217 // so we can start fresh.
2218 header_remove( 'Content-Encoding' );
2226 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
2228 * Clear away output buffers, but keep the Content-Encoding header
2229 * produced by ob_gzhandler, if any.
2231 * This should be used for HTTP 304 responses, where you need to
2232 * preserve the Content-Encoding header of the real result, but
2233 * also need to suppress the output of ob_gzhandler to keep to spec
2234 * and avoid breaking Firefox in rare cases where the headers and
2235 * body are broken over two packets.
2237 function wfClearOutputBuffers() {
2238 wfResetOutputBuffers( false );
2242 * Converts an Accept-* header into an array mapping string values to quality
2245 * @param $accept String
2246 * @param $def String default
2249 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
2250 # No arg means accept anything (per HTTP spec)
2252 return array( $def => 1.0 );
2257 $parts = explode( ',', $accept );
2259 foreach( $parts as $part ) {
2260 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
2261 $values = explode( ';', trim( $part ) );
2263 if ( count( $values ) == 1 ) {
2264 $prefs[$values[0]] = 1.0;
2265 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
2266 $prefs[$values[0]] = floatval( $match[1] );
2274 * Checks if a given MIME type matches any of the keys in the given
2275 * array. Basic wildcards are accepted in the array keys.
2277 * Returns the matching MIME type (or wildcard) if a match, otherwise
2280 * @param $type String
2281 * @param $avail Array
2285 function mimeTypeMatch( $type, $avail ) {
2286 if( array_key_exists( $type, $avail ) ) {
2289 $parts = explode( '/', $type );
2290 if( array_key_exists( $parts[0] . '/*', $avail ) ) {
2291 return $parts[0] . '/*';
2292 } elseif( array_key_exists( '*/*', $avail ) ) {
2301 * Returns the 'best' match between a client's requested internet media types
2302 * and the server's list of available types. Each list should be an associative
2303 * array of type to preference (preference is a float between 0.0 and 1.0).
2304 * Wildcards in the types are acceptable.
2306 * @param $cprefs Array: client's acceptable type list
2307 * @param $sprefs Array: server's offered types
2310 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
2311 * XXX: generalize to negotiate other stuff
2313 function wfNegotiateType( $cprefs, $sprefs ) {
2316 foreach( array_keys( $sprefs ) as $type ) {
2317 $parts = explode( '/', $type );
2318 if( $parts[1] != '*' ) {
2319 $ckey = mimeTypeMatch( $type, $cprefs );
2321 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2326 foreach( array_keys( $cprefs ) as $type ) {
2327 $parts = explode( '/', $type );
2328 if( $parts[1] != '*' && !array_key_exists( $type, $sprefs ) ) {
2329 $skey = mimeTypeMatch( $type, $sprefs );
2331 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2339 foreach( array_keys( $combine ) as $type ) {
2340 if( $combine[$type] > $bestq ) {
2342 $bestq = $combine[$type];
2350 * Reference-counted warning suppression
2354 function wfSuppressWarnings( $end = false ) {
2355 static $suppressCount = 0;
2356 static $originalLevel = false;
2359 if ( $suppressCount ) {
2361 if ( !$suppressCount ) {
2362 error_reporting( $originalLevel );
2366 if ( !$suppressCount ) {
2367 $originalLevel = error_reporting( E_ALL
& ~
( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED | E_USER_DEPRECATED | E_STRICT
) );
2374 * Restore error level to previous value
2376 function wfRestoreWarnings() {
2377 wfSuppressWarnings( true );
2380 # Autodetect, convert and provide timestamps of various types
2383 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2385 define( 'TS_UNIX', 0 );
2388 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2390 define( 'TS_MW', 1 );
2393 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2395 define( 'TS_DB', 2 );
2398 * RFC 2822 format, for E-mail and HTTP headers
2400 define( 'TS_RFC2822', 3 );
2403 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2405 * This is used by Special:Export
2407 define( 'TS_ISO_8601', 4 );
2410 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2412 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2413 * DateTime tag and page 36 for the DateTimeOriginal and
2414 * DateTimeDigitized tags.
2416 define( 'TS_EXIF', 5 );
2419 * Oracle format time.
2421 define( 'TS_ORACLE', 6 );
2424 * Postgres format time.
2426 define( 'TS_POSTGRES', 7 );
2431 define( 'TS_DB2', 8 );
2434 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2436 define( 'TS_ISO_8601_BASIC', 9 );
2439 * Get a timestamp string in one of various formats
2441 * @param $outputtype Mixed: A timestamp in one of the supported formats, the
2442 * function will autodetect which format is supplied and act
2444 * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp
2445 * @return Mixed: String / false The same date in the format specified in $outputtype or false
2447 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2449 $timestamp = new MWTimestamp( $ts );
2450 return $timestamp->getTimestamp( $outputtype );
2451 } catch( TimestampException
$e ) {
2452 wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n");
2458 * Return a formatted timestamp, or null if input is null.
2459 * For dealing with nullable timestamp columns in the database.
2461 * @param $outputtype Integer
2465 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2466 if( is_null( $ts ) ) {
2469 return wfTimestamp( $outputtype, $ts );
2474 * Convenience function; returns MediaWiki timestamp for the present time.
2478 function wfTimestampNow() {
2480 return wfTimestamp( TS_MW
, time() );
2484 * Check if the operating system is Windows
2486 * @return Bool: true if it's Windows, False otherwise.
2488 function wfIsWindows() {
2489 static $isWindows = null;
2490 if ( $isWindows === null ) {
2491 $isWindows = substr( php_uname(), 0, 7 ) == 'Windows';
2497 * Check if we are running under HipHop
2501 function wfIsHipHop() {
2502 return function_exists( 'hphp_thread_set_warmup_enabled' );
2506 * Swap two variables
2511 function swap( &$x, &$y ) {
2518 * Tries to get the system directory for temporary files. First
2519 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2520 * environment variables are then checked in sequence, and if none are
2521 * set try sys_get_temp_dir().
2523 * NOTE: When possible, use instead the tmpfile() function to create
2524 * temporary files to avoid race conditions on file creation, etc.
2528 function wfTempDir() {
2529 global $wgTmpDirectory;
2531 if ( $wgTmpDirectory !== false ) {
2532 return $wgTmpDirectory;
2535 $tmpDir = array_map( "getenv", array( 'TMPDIR', 'TMP', 'TEMP' ) );
2537 foreach( $tmpDir as $tmp ) {
2538 if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2542 return sys_get_temp_dir();
2546 * Make directory, and make all parent directories if they don't exist
2548 * @param $dir String: full path to directory to create
2549 * @param $mode Integer: chmod value to use, default is $wgDirectoryMode
2550 * @param $caller String: optional caller param for debugging.
2551 * @throws MWException
2554 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2555 global $wgDirectoryMode;
2557 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2558 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2561 if ( !is_null( $caller ) ) {
2562 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2565 if( strval( $dir ) === '' ||
file_exists( $dir ) ) {
2569 $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR
, $dir );
2571 if ( is_null( $mode ) ) {
2572 $mode = $wgDirectoryMode;
2575 // Turn off the normal warning, we're doing our own below
2576 wfSuppressWarnings();
2577 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2578 wfRestoreWarnings();
2581 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2582 trigger_error( sprintf( "%s: failed to mkdir \"%s\" mode 0%o", __FUNCTION__
, $dir, $mode ),
2589 * Remove a directory and all its content.
2590 * Does not hide error.
2592 function wfRecursiveRemoveDir( $dir ) {
2593 wfDebug( __FUNCTION__
. "( $dir )\n" );
2594 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2595 if ( is_dir( $dir ) ) {
2596 $objects = scandir( $dir );
2597 foreach ( $objects as $object ) {
2598 if ( $object != "." && $object != ".." ) {
2599 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2600 wfRecursiveRemoveDir( $dir . '/' . $object );
2602 unlink( $dir . '/' . $object );
2612 * @param $nr Mixed: the number to format
2613 * @param $acc Integer: the number of digits after the decimal point, default 2
2614 * @param $round Boolean: whether or not to round the value, default true
2617 function wfPercent( $nr, $acc = 2, $round = true ) {
2618 $ret = sprintf( "%.${acc}f", $nr );
2619 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2623 * Find out whether or not a mixed variable exists in a string
2625 * @param $needle String
2626 * @param $str String
2627 * @param $insensitive Boolean
2630 function in_string( $needle, $str, $insensitive = false ) {
2632 if( $insensitive ) $func = 'stripos';
2634 return $func( $str, $needle ) !== false;
2638 * Safety wrapper around ini_get() for boolean settings.
2639 * The values returned from ini_get() are pre-normalized for settings
2640 * set via php.ini or php_flag/php_admin_flag... but *not*
2641 * for those set via php_value/php_admin_value.
2643 * It's fairly common for people to use php_value instead of php_flag,
2644 * which can leave you with an 'off' setting giving a false positive
2645 * for code that just takes the ini_get() return value as a boolean.
2647 * To make things extra interesting, setting via php_value accepts
2648 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2649 * Unrecognized values go false... again opposite PHP's own coercion
2650 * from string to bool.
2652 * Luckily, 'properly' set settings will always come back as '0' or '1',
2653 * so we only have to worry about them and the 'improper' settings.
2655 * I frickin' hate PHP... :P
2657 * @param $setting String
2660 function wfIniGetBool( $setting ) {
2661 $val = ini_get( $setting );
2662 // 'on' and 'true' can't have whitespace around them, but '1' can.
2663 return strtolower( $val ) == 'on'
2664 ||
strtolower( $val ) == 'true'
2665 ||
strtolower( $val ) == 'yes'
2666 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2670 * Wrapper function for PHP's dl(). This doesn't work in most situations from
2671 * PHP 5.3 onward, and is usually disabled in shared environments anyway.
2673 * @param $extension String A PHP extension. The file suffix (.so or .dll)
2675 * @param $fileName String Name of the library, if not $extension.suffix
2676 * @return Bool - Whether or not the extension is loaded
2678 function wfDl( $extension, $fileName = null ) {
2679 if( extension_loaded( $extension ) ) {
2684 $sapi = php_sapi_name();
2685 if( $sapi == 'cli' ||
$sapi == 'cgi' ||
$sapi == 'embed' ) {
2686 $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' )
2687 && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) );
2691 $fileName = $fileName ?
$fileName : $extension;
2692 if( wfIsWindows() ) {
2693 $fileName = 'php_' . $fileName;
2695 wfSuppressWarnings();
2696 dl( $fileName . '.' . PHP_SHLIB_SUFFIX
);
2697 wfRestoreWarnings();
2699 return extension_loaded( $extension );
2703 * Windows-compatible version of escapeshellarg()
2704 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2705 * function puts single quotes in regardless of OS.
2707 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2708 * earlier distro releases of PHP)
2713 function wfEscapeShellArg( ) {
2714 wfInitShellLocale();
2716 $args = func_get_args();
2719 foreach ( $args as $arg ) {
2726 if ( wfIsWindows() ) {
2727 // Escaping for an MSVC-style command line parser and CMD.EXE
2729 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2730 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2733 // Double the backslashes before any double quotes. Escape the double quotes.
2734 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2737 foreach ( $tokens as $token ) {
2738 if ( $iteration %
2 == 1 ) {
2739 // Delimiter, a double quote preceded by zero or more slashes
2740 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2741 } elseif ( $iteration %
4 == 2 ) {
2742 // ^ in $token will be outside quotes, need to be escaped
2743 $arg .= str_replace( '^', '^^', $token );
2744 } else { // $iteration % 4 == 0
2745 // ^ in $token will appear inside double quotes, so leave as is
2750 // Double the backslashes before the end of the string, because
2751 // we will soon add a quote
2753 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2754 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2757 // Add surrounding quotes
2758 $retVal .= '"' . $arg . '"';
2760 $retVal .= escapeshellarg( $arg );
2767 * Execute a shell command, with time and memory limits mirrored from the PHP
2768 * configuration if supported.
2769 * @param $cmd String Command line, properly escaped for shell.
2770 * @param &$retval null|Mixed optional, will receive the program's exit code.
2771 * (non-zero is usually failure)
2772 * @param $environ Array optional environment variables which should be
2773 * added to the executed command environment.
2774 * @param $limits Array optional array with limits(filesize, memory, time, walltime)
2775 * this overwrites the global wgShellMax* limits.
2776 * @return string collected stdout as a string (trailing newlines stripped)
2778 function wfShellExec( $cmd, &$retval = null, $environ = array(), $limits = array() ) {
2779 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2780 $wgMaxShellWallClockTime;
2783 if ( is_null( $disabled ) ) {
2785 if( wfIniGetBool( 'safe_mode' ) ) {
2786 wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
2787 $disabled = 'safemode';
2789 $functions = explode( ',', ini_get( 'disable_functions' ) );
2790 $functions = array_map( 'trim', $functions );
2791 $functions = array_map( 'strtolower', $functions );
2792 if ( in_array( 'passthru', $functions ) ) {
2793 wfDebug( "passthru is in disabled_functions\n" );
2794 $disabled = 'passthru';
2800 return $disabled == 'safemode' ?
2801 'Unable to run external programs in safe mode.' :
2802 'Unable to run external programs, passthru() is disabled.';
2805 wfInitShellLocale();
2808 foreach( $environ as $k => $v ) {
2809 if ( wfIsWindows() ) {
2810 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2811 * appear in the environment variable, so we must use carat escaping as documented in
2812 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2813 * Note however that the quote isn't listed there, but is needed, and the parentheses
2814 * are listed there but doesn't appear to need it.
2816 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2818 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2819 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2821 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2824 $cmd = $envcmd . $cmd;
2826 if ( php_uname( 's' ) == 'Linux' ) {
2827 $time = intval ( isset($limits['time']) ?
$limits['time'] : $wgMaxShellTime );
2828 if ( isset( $limits['walltime'] ) ) {
2829 $wallTime = intval( $limits['walltime'] );
2830 } elseif ( isset( $limits['time'] ) ) {
2833 $wallTime = intval( $wgMaxShellWallClockTime );
2835 $mem = intval ( isset($limits['memory']) ?
$limits['memory'] : $wgMaxShellMemory );
2836 $filesize = intval ( isset($limits['filesize']) ?
$limits['filesize'] : $wgMaxShellFileSize );
2838 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2839 $cmd = '/bin/bash ' . escapeshellarg( "$IP/bin/ulimit5.sh" ) .
2840 " $time $mem $filesize $wallTime " . escapeshellarg( $cmd );
2843 wfDebug( "wfShellExec: $cmd\n" );
2845 $retval = 1; // error by default?
2847 passthru( $cmd, $retval );
2848 $output = ob_get_contents();
2851 if ( $retval == 127 ) {
2852 wfDebugLog( 'exec', "Possibly missing executable file: $cmd\n" );
2858 * Workaround for http://bugs.php.net/bug.php?id=45132
2859 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2861 function wfInitShellLocale() {
2862 static $done = false;
2867 global $wgShellLocale;
2868 if ( !wfIniGetBool( 'safe_mode' ) ) {
2869 putenv( "LC_CTYPE=$wgShellLocale" );
2870 setlocale( LC_CTYPE
, $wgShellLocale );
2875 * Alias to wfShellWikiCmd()
2876 * @see wfShellWikiCmd()
2878 function wfShellMaintenanceCmd( $script, array $parameters = array(), array $options = array() ) {
2879 return wfShellWikiCmd( $script, $parameters, $options );
2883 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2884 * Note that $parameters should be a flat array and an option with an argument
2885 * should consist of two consecutive items in the array (do not use "--option value").
2886 * @param $script string MediaWiki cli script path
2887 * @param $parameters Array Arguments and options to the script
2888 * @param $options Array Associative array of options:
2889 * 'php': The path to the php executable
2890 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2893 function wfShellWikiCmd( $script, array $parameters = array(), array $options = array() ) {
2895 // Give site config file a chance to run the script in a wrapper.
2896 // The caller may likely want to call wfBasename() on $script.
2897 wfRunHooks( 'wfShellWikiCmd', array( &$script, &$parameters, &$options ) );
2898 $cmd = isset( $options['php'] ) ?
array( $options['php'] ) : array( $wgPhpCli );
2899 if ( isset( $options['wrapper'] ) ) {
2900 $cmd[] = $options['wrapper'];
2903 // Escape each parameter for shell
2904 return implode( " ", array_map( 'wfEscapeShellArg', array_merge( $cmd, $parameters ) ) );
2908 * wfMerge attempts to merge differences between three texts.
2909 * Returns true for a clean merge and false for failure or a conflict.
2911 * @param $old String
2912 * @param $mine String
2913 * @param $yours String
2914 * @param $result String
2917 function wfMerge( $old, $mine, $yours, &$result ) {
2920 # This check may also protect against code injection in
2921 # case of broken installations.
2922 wfSuppressWarnings();
2923 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2924 wfRestoreWarnings();
2927 wfDebug( "diff3 not found\n" );
2931 # Make temporary files
2933 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2934 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2935 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2937 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2938 # a newline character. To avoid this, we normalize the trailing whitespace before
2939 # creating the diff.
2941 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2942 fclose( $oldtextFile );
2943 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2944 fclose( $mytextFile );
2945 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2946 fclose( $yourtextFile );
2948 # Check for a conflict
2949 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
2950 wfEscapeShellArg( $mytextName ) . ' ' .
2951 wfEscapeShellArg( $oldtextName ) . ' ' .
2952 wfEscapeShellArg( $yourtextName );
2953 $handle = popen( $cmd, 'r' );
2955 if( fgets( $handle, 1024 ) ) {
2963 $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
2964 wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
2965 $handle = popen( $cmd, 'r' );
2968 $data = fread( $handle, 8192 );
2969 if ( strlen( $data ) == 0 ) {
2975 unlink( $mytextName );
2976 unlink( $oldtextName );
2977 unlink( $yourtextName );
2979 if ( $result === '' && $old !== '' && !$conflict ) {
2980 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2987 * Returns unified plain-text diff of two texts.
2988 * Useful for machine processing of diffs.
2990 * @param $before String: the text before the changes.
2991 * @param $after String: the text after the changes.
2992 * @param $params String: command-line options for the diff command.
2993 * @return String: unified diff of $before and $after
2995 function wfDiff( $before, $after, $params = '-u' ) {
2996 if ( $before == $after ) {
3001 wfSuppressWarnings();
3002 $haveDiff = $wgDiff && file_exists( $wgDiff );
3003 wfRestoreWarnings();
3005 # This check may also protect against code injection in
3006 # case of broken installations.
3008 wfDebug( "diff executable not found\n" );
3009 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
3010 $format = new UnifiedDiffFormatter();
3011 return $format->format( $diffs );
3014 # Make temporary files
3016 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
3017 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
3019 fwrite( $oldtextFile, $before );
3020 fclose( $oldtextFile );
3021 fwrite( $newtextFile, $after );
3022 fclose( $newtextFile );
3024 // Get the diff of the two files
3025 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
3027 $h = popen( $cmd, 'r' );
3032 $data = fread( $h, 8192 );
3033 if ( strlen( $data ) == 0 ) {
3041 unlink( $oldtextName );
3042 unlink( $newtextName );
3044 // Kill the --- and +++ lines. They're not useful.
3045 $diff_lines = explode( "\n", $diff );
3046 if ( strpos( $diff_lines[0], '---' ) === 0 ) {
3047 unset( $diff_lines[0] );
3049 if ( strpos( $diff_lines[1], '+++' ) === 0 ) {
3050 unset( $diff_lines[1] );
3053 $diff = implode( "\n", $diff_lines );
3059 * This function works like "use VERSION" in Perl, the program will die with a
3060 * backtrace if the current version of PHP is less than the version provided
3062 * This is useful for extensions which due to their nature are not kept in sync
3063 * with releases, and might depend on other versions of PHP than the main code
3065 * Note: PHP might die due to parsing errors in some cases before it ever
3066 * manages to call this function, such is life
3068 * @see perldoc -f use
3070 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3072 * @throws MWException
3074 function wfUsePHP( $req_ver ) {
3075 $php_ver = PHP_VERSION
;
3077 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
3078 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
3083 * This function works like "use VERSION" in Perl except it checks the version
3084 * of MediaWiki, the program will die with a backtrace if the current version
3085 * of MediaWiki is less than the version provided.
3087 * This is useful for extensions which due to their nature are not kept in sync
3090 * @see perldoc -f use
3092 * @param $req_ver Mixed: the version to check, can be a string, an integer, or
3094 * @throws MWException
3096 function wfUseMW( $req_ver ) {
3099 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
3100 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
3105 * Return the final portion of a pathname.
3106 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
3107 * http://bugs.php.net/bug.php?id=33898
3109 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
3110 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
3112 * @param $path String
3113 * @param $suffix String: to remove if present
3116 function wfBaseName( $path, $suffix = '' ) {
3117 $encSuffix = ( $suffix == '' )
3119 : ( '(?:' . preg_quote( $suffix, '#' ) . ')?' );
3121 if( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
3129 * Generate a relative path name to the given file.
3130 * May explode on non-matching case-insensitive paths,
3131 * funky symlinks, etc.
3133 * @param $path String: absolute destination path including target filename
3134 * @param $from String: Absolute source path, directory only
3137 function wfRelativePath( $path, $from ) {
3138 // Normalize mixed input on Windows...
3139 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
3140 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
3142 // Trim trailing slashes -- fix for drive root
3143 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
3144 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
3146 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
3147 $against = explode( DIRECTORY_SEPARATOR
, $from );
3149 if( $pieces[0] !== $against[0] ) {
3150 // Non-matching Windows drive letters?
3151 // Return a full path.
3155 // Trim off common prefix
3156 while( count( $pieces ) && count( $against )
3157 && $pieces[0] == $against[0] ) {
3158 array_shift( $pieces );
3159 array_shift( $against );
3162 // relative dots to bump us to the parent
3163 while( count( $against ) ) {
3164 array_unshift( $pieces, '..' );
3165 array_shift( $against );
3168 array_push( $pieces, wfBaseName( $path ) );
3170 return implode( DIRECTORY_SEPARATOR
, $pieces );
3174 * Do any deferred updates and clear the list
3176 * @deprecated since 1.19
3177 * @see DeferredUpdates::doUpdate()
3178 * @param $commit string
3180 function wfDoUpdates( $commit = '' ) {
3181 wfDeprecated( __METHOD__
, '1.19' );
3182 DeferredUpdates
::doUpdates( $commit );
3186 * Convert an arbitrarily-long digit string from one numeric base
3187 * to another, optionally zero-padding to a minimum column width.
3189 * Supports base 2 through 36; digit values 10-36 are represented
3190 * as lowercase letters a-z. Input is case-insensitive.
3192 * @param string $input Input number
3193 * @param int $sourceBase Base of the input number
3194 * @param int $destBase Desired base of the output
3195 * @param int $pad Minimum number of digits in the output (pad with zeroes)
3196 * @param bool $lowercase Whether to output in lowercase or uppercase
3197 * @param string $engine Either "gmp", "bcmath", or "php"
3198 * @return string|bool The output number as a string, or false on error
3200 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = true, $engine = 'auto' ) {
3206 $sourceBase != (int) $sourceBase ||
3207 $destBase != (int) $destBase ||
3208 $pad != (int) $pad ||
3209 !preg_match( "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i", $input )
3214 static $baseChars = array (
3215 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f',
3216 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l',
3217 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r',
3218 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x',
3219 34 => 'y', 35 => 'z',
3221 '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5,
3222 '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11,
3223 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17,
3224 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23,
3225 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29,
3226 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35
3229 if( extension_loaded( 'gmp' ) && ( $engine == 'auto' ||
$engine == 'gmp' ) ) {
3230 $result = gmp_strval( gmp_init( $input, $sourceBase ), $destBase );
3231 } elseif( extension_loaded( 'bcmath' ) && ( $engine == 'auto' ||
$engine == 'bcmath' ) ) {
3233 foreach( str_split( strtolower( $input ) ) as $char ) {
3234 $decimal = bcmul( $decimal, $sourceBase );
3235 $decimal = bcadd( $decimal, $baseChars[$char] );
3238 for( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) {
3239 $result .= $baseChars[bcmod( $decimal, $destBase )];
3242 $result = strrev( $result );
3244 $inDigits = array();
3245 foreach( str_split( strtolower( $input ) ) as $char ) {
3246 $inDigits[] = $baseChars[$char];
3249 // Iterate over the input, modulo-ing out an output digit
3250 // at a time until input is gone.
3252 while( $inDigits ) {
3254 $workDigits = array();
3257 foreach( $inDigits as $digit ) {
3258 $work *= $sourceBase;
3261 if( $workDigits ||
$work >= $destBase ) {
3262 $workDigits[] = (int) ( $work / $destBase );
3267 // All that division leaves us with a remainder,
3268 // which is conveniently our next output digit.
3269 $result .= $baseChars[$work];
3272 $inDigits = $workDigits;
3275 $result = strrev( $result );
3279 $result = strtoupper( $result );
3282 return str_pad( $result, $pad, '0', STR_PAD_LEFT
);
3286 * Create an object with a given name and an array of construct parameters
3288 * @param $name String
3289 * @param $p Array: parameters
3291 * @deprecated since 1.18, warnings in 1.18, removal in 1.20
3293 function wfCreateObject( $name, $p ) {
3294 wfDeprecated( __FUNCTION__
, '1.18' );
3295 return MWFunction
::newObj( $name, $p );
3301 function wfHttpOnlySafe() {
3302 global $wgHttpOnlyBlacklist;
3304 if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
3305 foreach( $wgHttpOnlyBlacklist as $regex ) {
3306 if( preg_match( $regex, $_SERVER['HTTP_USER_AGENT'] ) ) {
3316 * Check if there is sufficent entropy in php's built-in session generation
3317 * @return bool true = there is sufficient entropy
3319 function wfCheckEntropy() {
3321 ( wfIsWindows() && version_compare( PHP_VERSION
, '5.3.3', '>=' ) )
3322 ||
ini_get( 'session.entropy_file' )
3324 && intval( ini_get( 'session.entropy_length' ) ) >= 32;
3328 * Override session_id before session startup if php's built-in
3329 * session generation code is not secure.
3331 function wfFixSessionID() {
3332 // If the cookie or session id is already set we already have a session and should abort
3333 if ( isset( $_COOKIE[ session_name() ] ) ||
session_id() ) {
3337 // PHP's built-in session entropy is enabled if:
3338 // - entropy_file is set or you're on Windows with php 5.3.3+
3339 // - AND entropy_length is > 0
3340 // We treat it as disabled if it doesn't have an entropy length of at least 32
3341 $entropyEnabled = wfCheckEntropy();
3343 // If built-in entropy is not enabled or not sufficient override php's built in session id generation code
3344 if ( !$entropyEnabled ) {
3345 wfDebug( __METHOD__
. ": PHP's built in entropy is disabled or not sufficient, overriding session id generation using our cryptrand source.\n" );
3346 session_id( MWCryptRand
::generateHex( 32 ) );
3351 * Initialise php session
3353 * @param $sessionId Bool
3355 function wfSetupSession( $sessionId = false ) {
3356 global $wgSessionsInMemcached, $wgSessionsInObjectCache, $wgCookiePath, $wgCookieDomain,
3357 $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler;
3358 if( $wgSessionsInObjectCache ||
$wgSessionsInMemcached ) {
3359 ObjectCacheSessionHandler
::install();
3360 } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) {
3361 # Only set this if $wgSessionHandler isn't null and session.save_handler
3362 # hasn't already been set to the desired value (that causes errors)
3363 ini_set( 'session.save_handler', $wgSessionHandler );
3365 $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
3366 wfDebugLog( 'cookie',
3367 'session_set_cookie_params: "' . implode( '", "',
3373 $httpOnlySafe ) ) . '"' );
3374 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe );
3375 session_cache_limiter( 'private, must-revalidate' );
3377 session_id( $sessionId );
3381 wfSuppressWarnings();
3383 wfRestoreWarnings();
3387 * Get an object from the precompiled serialized directory
3389 * @param $name String
3390 * @return Mixed: the variable on success, false on failure
3392 function wfGetPrecompiledData( $name ) {
3395 $file = "$IP/serialized/$name";
3396 if ( file_exists( $file ) ) {
3397 $blob = file_get_contents( $file );
3399 return unserialize( $blob );
3411 function wfMemcKey( /*... */ ) {
3412 global $wgCachePrefix;
3413 $prefix = $wgCachePrefix === false ?
wfWikiID() : $wgCachePrefix;
3414 $args = func_get_args();
3415 $key = $prefix . ':' . implode( ':', $args );
3416 $key = str_replace( ' ', '_', $key );
3421 * Get a cache key for a foreign DB
3424 * @param $prefix String
3425 * @param varargs String
3428 function wfForeignMemcKey( $db, $prefix /*, ... */ ) {
3429 $args = array_slice( func_get_args(), 2 );
3431 $key = "$db-$prefix:" . implode( ':', $args );
3433 $key = $db . ':' . implode( ':', $args );
3439 * Get an ASCII string identifying this wiki
3440 * This is used as a prefix in memcached keys
3444 function wfWikiID() {
3445 global $wgDBprefix, $wgDBname;
3446 if ( $wgDBprefix ) {
3447 return "$wgDBname-$wgDBprefix";
3454 * Split a wiki ID into DB name and table prefix
3456 * @param $wiki String
3460 function wfSplitWikiID( $wiki ) {
3461 $bits = explode( '-', $wiki, 2 );
3462 if ( count( $bits ) < 2 ) {
3469 * Get a Database object.
3471 * @param $db Integer: index of the connection to get. May be DB_MASTER for the
3472 * master (for write queries), DB_SLAVE for potentially lagged read
3473 * queries, or an integer >= 0 for a particular server.
3475 * @param $groups Mixed: query groups. An array of group names that this query
3476 * belongs to. May contain a single string if the query is only
3479 * @param $wiki String: the wiki ID, or false for the current wiki
3481 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3482 * will always return the same object, unless the underlying connection or load
3483 * balancer is manually destroyed.
3485 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3486 * updater to ensure that a proper database is being updated.
3488 * @return DatabaseBase
3490 function &wfGetDB( $db, $groups = array(), $wiki = false ) {
3491 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3495 * Get a load balancer object.
3497 * @param $wiki String: wiki ID, or false for the current wiki
3498 * @return LoadBalancer
3500 function wfGetLB( $wiki = false ) {
3501 return wfGetLBFactory()->getMainLB( $wiki );
3505 * Get the load balancer factory object
3509 function &wfGetLBFactory() {
3510 return LBFactory
::singleton();
3515 * Shortcut for RepoGroup::singleton()->findFile()
3517 * @param $title String or Title object
3518 * @param $options array Associative array of options:
3519 * time: requested time for an archived image, or false for the
3520 * current version. An image object will be returned which was
3521 * created at the specified time.
3523 * ignoreRedirect: If true, do not follow file redirects
3525 * private: If true, return restricted (deleted) files if the current
3526 * user is allowed to view them. Otherwise, such files will not
3529 * bypassCache: If true, do not use the process-local cache of File objects
3531 * @return File, or false if the file does not exist
3533 function wfFindFile( $title, $options = array() ) {
3534 return RepoGroup
::singleton()->findFile( $title, $options );
3538 * Get an object referring to a locally registered file.
3539 * Returns a valid placeholder object if the file does not exist.
3541 * @param $title Title|String
3542 * @return LocalFile|null A File, or null if passed an invalid Title
3544 function wfLocalFile( $title ) {
3545 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3549 * Stream a file to the browser. Back-compat alias for StreamFile::stream()
3550 * @deprecated since 1.19
3552 function wfStreamFile( $fname, $headers = array() ) {
3553 wfDeprecated( __FUNCTION__
, '1.19' );
3554 StreamFile
::stream( $fname, $headers );
3558 * Should low-performance queries be disabled?
3561 * @codeCoverageIgnore
3563 function wfQueriesMustScale() {
3564 global $wgMiserMode;
3566 ||
( SiteStats
::pages() > 100000
3567 && SiteStats
::edits() > 1000000
3568 && SiteStats
::users() > 10000 );
3572 * Get the path to a specified script file, respecting file
3573 * extensions; this is a wrapper around $wgScriptExtension etc.
3574 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3576 * @param $script String: script filename, sans extension
3579 function wfScript( $script = 'index' ) {
3580 global $wgScriptPath, $wgScriptExtension, $wgScript, $wgLoadScript;
3581 if ( $script === 'index' ) {
3583 } else if ( $script === 'load' ) {
3584 return $wgLoadScript;
3586 return "{$wgScriptPath}/{$script}{$wgScriptExtension}";
3591 * Get the script URL.
3593 * @return string script URL
3595 function wfGetScriptUrl() {
3596 if( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3598 # as it was called, minus the query string.
3600 # Some sites use Apache rewrite rules to handle subdomains,
3601 # and have PHP set up in a weird way that causes PHP_SELF
3602 # to contain the rewritten URL instead of the one that the
3603 # outside world sees.
3605 # If in this mode, use SCRIPT_URL instead, which mod_rewrite
3606 # provides containing the "before" URL.
3607 return $_SERVER['SCRIPT_NAME'];
3609 return $_SERVER['URL'];
3614 * Convenience function converts boolean values into "true"
3615 * or "false" (string) values
3617 * @param $value Boolean
3620 function wfBoolToStr( $value ) {
3621 return $value ?
'true' : 'false';
3625 * Get a platform-independent path to the null file, e.g. /dev/null
3629 function wfGetNull() {
3630 return wfIsWindows()
3636 * Modern version of wfWaitForSlaves(). Instead of looking at replication lag
3637 * and waiting for it to go down, this waits for the slaves to catch up to the
3638 * master position. Use this when updating very large numbers of rows, as
3639 * in maintenance scripts, to avoid causing too much lag. Of course, this is
3640 * a no-op if there are no slaves.
3642 * @param $maxLag Integer (deprecated)
3643 * @param $wiki mixed Wiki identifier accepted by wfGetLB
3645 function wfWaitForSlaves( $maxLag = false, $wiki = false ) {
3646 $lb = wfGetLB( $wiki );
3647 // bug 27975 - Don't try to wait for slaves if there are none
3648 // Prevents permission error when getting master position
3649 if ( $lb->getServerCount() > 1 ) {
3650 $dbw = $lb->getConnection( DB_MASTER
);
3651 $pos = $dbw->getMasterPos();
3652 $lb->waitForAll( $pos );
3657 * Used to be used for outputting text in the installer/updater
3658 * @deprecated since 1.18, warnings in 1.18, remove in 1.20
3660 function wfOut( $s ) {
3661 wfDeprecated( __FUNCTION__
, '1.18' );
3662 global $wgCommandLineMode;
3663 if ( $wgCommandLineMode ) {
3666 echo htmlspecialchars( $s );
3672 * Count down from $n to zero on the terminal, with a one-second pause
3673 * between showing each number. For use in command-line scripts.
3674 * @codeCoverageIgnore
3677 function wfCountDown( $n ) {
3678 for ( $i = $n; $i >= 0; $i-- ) {
3680 echo str_repeat( "\x08", strlen( $i +
1 ) );
3692 * Generate a random 32-character hexadecimal token.
3693 * @param $salt Mixed: some sort of salt, if necessary, to add to random
3694 * characters before hashing.
3696 * @codeCoverageIgnore
3697 * @deprecated since 1.20; Please use MWCryptRand for security purposes and wfRandomString for pesudo-random strings
3698 * @warning This method is NOT secure. Additionally it has many callers that use it for pesudo-random purposes.
3700 function wfGenerateToken( $salt = '' ) {
3701 wfDeprecated( __METHOD__
, '1.20' );
3702 $salt = serialize( $salt );
3703 return md5( mt_rand( 0, 0x7fffffff ) . $salt );
3707 * Replace all invalid characters with -
3708 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3709 * By default, $wgIllegalFileChars = ':'
3711 * @param $name Mixed: filename to process
3714 function wfStripIllegalFilenameChars( $name ) {
3715 global $wgIllegalFileChars;
3716 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3717 $name = wfBaseName( $name );
3718 $name = preg_replace(
3719 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3727 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit;
3729 * @return Integer value memory was set to.
3731 function wfMemoryLimit() {
3732 global $wgMemoryLimit;
3733 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3734 if( $memlimit != -1 ) {
3735 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3736 if( $conflimit == -1 ) {
3737 wfDebug( "Removing PHP's memory limit\n" );
3738 wfSuppressWarnings();
3739 ini_set( 'memory_limit', $conflimit );
3740 wfRestoreWarnings();
3742 } elseif ( $conflimit > $memlimit ) {
3743 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3744 wfSuppressWarnings();
3745 ini_set( 'memory_limit', $conflimit );
3746 wfRestoreWarnings();
3754 * Converts shorthand byte notation to integer form
3756 * @param $string String
3759 function wfShorthandToInteger( $string = '' ) {
3760 $string = trim( $string );
3761 if( $string === '' ) {
3764 $last = $string[strlen( $string ) - 1];
3765 $val = intval( $string );
3770 // break intentionally missing
3774 // break intentionally missing
3784 * Get the normalised IETF language tag
3785 * See unit test for examples.
3787 * @param $code String: The language code.
3788 * @return String: The language code which complying with BCP 47 standards.
3790 function wfBCP47( $code ) {
3791 $codeSegment = explode( '-', $code );
3793 foreach ( $codeSegment as $segNo => $seg ) {
3794 if ( count( $codeSegment ) > 0 ) {
3795 // when previous segment is x, it is a private segment and should be lc
3796 if( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3797 $codeBCP[$segNo] = strtolower( $seg );
3798 // ISO 3166 country code
3799 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3800 $codeBCP[$segNo] = strtoupper( $seg );
3801 // ISO 15924 script code
3802 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3803 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3804 // Use lowercase for other cases
3806 $codeBCP[$segNo] = strtolower( $seg );
3809 // Use lowercase for single segment
3810 $codeBCP[$segNo] = strtolower( $seg );
3813 $langCode = implode( '-', $codeBCP );
3818 * Get a cache object.
3820 * @param $inputType integer Cache type, one the the CACHE_* constants.
3823 function wfGetCache( $inputType ) {
3824 return ObjectCache
::getInstance( $inputType );
3828 * Get the main cache object
3832 function wfGetMainCache() {
3833 global $wgMainCacheType;
3834 return ObjectCache
::getInstance( $wgMainCacheType );
3838 * Get the cache object used by the message cache
3842 function wfGetMessageCacheStorage() {
3843 global $wgMessageCacheType;
3844 return ObjectCache
::getInstance( $wgMessageCacheType );
3848 * Get the cache object used by the parser cache
3852 function wfGetParserCacheStorage() {
3853 global $wgParserCacheType;
3854 return ObjectCache
::getInstance( $wgParserCacheType );
3858 * Get the cache object used by the language converter
3862 function wfGetLangConverterCacheStorage() {
3863 global $wgLanguageConverterCacheType;
3864 return ObjectCache
::getInstance( $wgLanguageConverterCacheType );
3868 * Call hook functions defined in $wgHooks
3870 * @param $event String: event name
3871 * @param $args Array: parameters passed to hook functions
3872 * @return Boolean True if no handler aborted the hook
3874 function wfRunHooks( $event, $args = array() ) {
3875 return Hooks
::run( $event, $args );
3879 * Wrapper around php's unpack.
3881 * @param $format String: The format string (See php's docs)
3882 * @param $data: A binary string of binary data
3883 * @param $length integer or false: The minimun length of $data. This is to
3884 * prevent reading beyond the end of $data. false to disable the check.
3886 * Also be careful when using this function to read unsigned 32 bit integer
3887 * because php might make it negative.
3889 * @throws MWException if $data not long enough, or if unpack fails
3890 * @return array Associative array of the extracted data
3892 function wfUnpack( $format, $data, $length=false ) {
3893 if ( $length !== false ) {
3894 $realLen = strlen( $data );
3895 if ( $realLen < $length ) {
3896 throw new MWException( "Tried to use wfUnpack on a "
3897 . "string of length $realLen, but needed one "
3898 . "of at least length $length."
3903 wfSuppressWarnings();
3904 $result = unpack( $format, $data );
3905 wfRestoreWarnings();
3907 if ( $result === false ) {
3908 // If it cannot extract the packed data.
3909 throw new MWException( "unpack could not unpack binary data" );
3915 * Determine if an image exists on the 'bad image list'.
3917 * The format of MediaWiki:Bad_image_list is as follows:
3918 * * Only list items (lines starting with "*") are considered
3919 * * The first link on a line must be a link to a bad image
3920 * * Any subsequent links on the same line are considered to be exceptions,
3921 * i.e. articles where the image may occur inline.
3923 * @param $name string the image name to check
3924 * @param $contextTitle Title|bool the page on which the image occurs, if known
3925 * @param $blacklist string wikitext of a file blacklist
3928 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3929 static $badImageCache = null; // based on bad_image_list msg
3930 wfProfileIn( __METHOD__
);
3933 $redirectTitle = RepoGroup
::singleton()->checkRedirect( Title
::makeTitle( NS_FILE
, $name ) );
3934 if( $redirectTitle ) {
3935 $name = $redirectTitle->getDbKey();
3938 # Run the extension hook
3940 if( !wfRunHooks( 'BadImage', array( $name, &$bad ) ) ) {
3941 wfProfileOut( __METHOD__
);
3945 $cacheable = ( $blacklist === null );
3946 if( $cacheable && $badImageCache !== null ) {
3947 $badImages = $badImageCache;
3948 } else { // cache miss
3949 if ( $blacklist === null ) {
3950 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3952 # Build the list now
3953 $badImages = array();
3954 $lines = explode( "\n", $blacklist );
3955 foreach( $lines as $line ) {
3957 if ( substr( $line, 0, 1 ) !== '*' ) {
3963 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3967 $exceptions = array();
3968 $imageDBkey = false;
3969 foreach ( $m[1] as $i => $titleText ) {
3970 $title = Title
::newFromText( $titleText );
3971 if ( !is_null( $title ) ) {
3973 $imageDBkey = $title->getDBkey();
3975 $exceptions[$title->getPrefixedDBkey()] = true;
3980 if ( $imageDBkey !== false ) {
3981 $badImages[$imageDBkey] = $exceptions;
3985 $badImageCache = $badImages;
3989 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3990 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3991 wfProfileOut( __METHOD__
);