diff options
Diffstat (limited to 'includes/GlobalFunctions.php')
| -rw-r--r-- | includes/GlobalFunctions.php | 2092 |
1 files changed, 1070 insertions, 1022 deletions
diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index 2c35568b..3424211f 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -8,188 +8,68 @@ if ( !defined( 'MEDIAWIKI' ) ) { die( "This file is part of MediaWiki, it is not a valid entry point" ); } -require_once dirname( __FILE__ ) . '/normal/UtfNormalUtil.php'; - // Hide compatibility functions from Doxygen /// @cond /** * Compatibility functions * - * We support PHP 5.1.x and up. + * We support PHP 5.2.3 and up. * Re-implementations of newer functions or functions in non-standard * PHP extensions may be included here. */ + if( !function_exists( 'iconv' ) ) { - # iconv support is not in the default configuration and so may not be present. - # Assume will only ever use utf-8 and iso-8859-1. - # This will *not* work in all circumstances. + /** @codeCoverageIgnore */ function iconv( $from, $to, $string ) { - if ( substr( $to, -8 ) == '//IGNORE' ) { - $to = substr( $to, 0, strlen( $to ) - 8 ); - } - if( strcasecmp( $from, $to ) == 0 ) { - return $string; - } - if( strcasecmp( $from, 'utf-8' ) == 0 ) { - return utf8_decode( $string ); - } - if( strcasecmp( $to, 'utf-8' ) == 0 ) { - return utf8_encode( $string ); - } - return $string; + return Fallback::iconv( $from, $to, $string ); } } if ( !function_exists( 'mb_substr' ) ) { - /** - * Fallback implementation for mb_substr, hardcoded to UTF-8. - * Attempts to be at least _moderately_ efficient; best optimized - * for relatively small offset and count values -- about 5x slower - * than native mb_string in my testing. - * - * Larger offsets are still fairly efficient for Latin text, but - * can be up to 100x slower than native if the text is heavily - * multibyte and we have to slog through a few hundred kb. - */ + /** @codeCoverageIgnore */ function mb_substr( $str, $start, $count='end' ) { - if( $start != 0 ) { - $split = mb_substr_split_unicode( $str, intval( $start ) ); - $str = substr( $str, $split ); - } - - if( $count !== 'end' ) { - $split = mb_substr_split_unicode( $str, intval( $count ) ); - $str = substr( $str, 0, $split ); - } - - return $str; + return Fallback::mb_substr( $str, $start, $count ); } + /** @codeCoverageIgnore */ function mb_substr_split_unicode( $str, $splitPos ) { - if( $splitPos == 0 ) { - return 0; - } - - $byteLen = strlen( $str ); - - if( $splitPos > 0 ) { - if( $splitPos > 256 ) { - // Optimize large string offsets by skipping ahead N bytes. - // This will cut out most of our slow time on Latin-based text, - // and 1/2 to 1/3 on East European and Asian scripts. - $bytePos = $splitPos; - while ( $bytePos < $byteLen && $str{$bytePos} >= "\x80" && $str{$bytePos} < "\xc0" ) { - ++$bytePos; - } - $charPos = mb_strlen( substr( $str, 0, $bytePos ) ); - } else { - $charPos = 0; - $bytePos = 0; - } - - while( $charPos++ < $splitPos ) { - ++$bytePos; - // Move past any tail bytes - while ( $bytePos < $byteLen && $str{$bytePos} >= "\x80" && $str{$bytePos} < "\xc0" ) { - ++$bytePos; - } - } - } else { - $splitPosX = $splitPos + 1; - $charPos = 0; // relative to end of string; we don't care about the actual char position here - $bytePos = $byteLen; - while( $bytePos > 0 && $charPos-- >= $splitPosX ) { - --$bytePos; - // Move past any tail bytes - while ( $bytePos > 0 && $str{$bytePos} >= "\x80" && $str{$bytePos} < "\xc0" ) { - --$bytePos; - } - } - } - - return $bytePos; + return Fallback::mb_substr_split_unicode( $str, $splitPos ); } } if ( !function_exists( 'mb_strlen' ) ) { - /** - * Fallback implementation of mb_strlen, hardcoded to UTF-8. - * @param string $str - * @param string $enc optional encoding; ignored - * @return int - */ + /** @codeCoverageIgnore */ function mb_strlen( $str, $enc = '' ) { - $counts = count_chars( $str ); - $total = 0; - - // Count ASCII bytes - for( $i = 0; $i < 0x80; $i++ ) { - $total += $counts[$i]; - } - - // Count multibyte sequence heads - for( $i = 0xc0; $i < 0xff; $i++ ) { - $total += $counts[$i]; - } - return $total; + return Fallback::mb_strlen( $str, $enc ); } } - if( !function_exists( 'mb_strpos' ) ) { - /** - * Fallback implementation of mb_strpos, hardcoded to UTF-8. - * @param $haystack String - * @param $needle String - * @param $offset String: optional start position - * @param $encoding String: optional encoding; ignored - * @return int - */ + /** @codeCoverageIgnore */ function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) { - $needle = preg_quote( $needle, '/' ); - - $ar = array(); - preg_match( '/' . $needle . '/u', $haystack, $ar, PREG_OFFSET_CAPTURE, $offset ); - - if( isset( $ar[0][1] ) ) { - return $ar[0][1]; - } else { - return false; - } + return Fallback::mb_strpos( $haystack, $needle, $offset, $encoding ); } + } if( !function_exists( 'mb_strrpos' ) ) { - /** - * Fallback implementation of mb_strrpos, hardcoded to UTF-8. - * @param $haystack String - * @param $needle String - * @param $offset String: optional start position - * @param $encoding String: optional encoding; ignored - * @return int - */ + /** @codeCoverageIgnore */ function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) { - $needle = preg_quote( $needle, '/' ); - - $ar = array(); - preg_match_all( '/' . $needle . '/u', $haystack, $ar, PREG_OFFSET_CAPTURE, $offset ); - - if( isset( $ar[0] ) && count( $ar[0] ) > 0 && - isset( $ar[0][count( $ar[0] ) - 1][1] ) ) { - return $ar[0][count( $ar[0] ) - 1][1]; - } else { - return false; - } + return Fallback::mb_strrpos( $haystack, $needle, $offset, $encoding ); } } + // Support for Wietse Venema's taint feature if ( !function_exists( 'istainted' ) ) { + /** @codeCoverageIgnore */ function istainted( $var ) { return 0; } + /** @codeCoverageIgnore */ function taint( $var, $level = 0 ) {} + /** @codeCoverageIgnore */ function untaint( $var, $level = 0 ) {} define( 'TC_HTML', 1 ); define( 'TC_SHELL', 1 ); @@ -197,25 +77,20 @@ if ( !function_exists( 'istainted' ) ) { define( 'TC_PCRE', 1 ); define( 'TC_SELF', 1 ); } - -// array_fill_keys() was only added in 5.2, but people use it anyway -// add a back-compat layer for 5.1. See bug 27781 -if( !function_exists( 'array_fill_keys' ) ) { - function array_fill_keys( $keys, $value ) { - return array_combine( $keys, array_fill( 0, count( $keys ), $value ) ); - } -} - - /// @endcond - /** * Like array_diff( $a, $b ) except that it works with two-dimensional arrays. */ function wfArrayDiff2( $a, $b ) { return array_udiff( $a, $b, 'wfArrayDiff2_cmp' ); } + +/** + * @param $a + * @param $b + * @return int + */ function wfArrayDiff2_cmp( $a, $b ) { if ( !is_array( $a ) ) { return strcmp( $a, $b ); @@ -235,12 +110,148 @@ function wfArrayDiff2_cmp( $a, $b ) { } /** - * Seed Mersenne Twister - * No-op for compatibility; only necessary in PHP < 4.2.0 - * @deprecated. Remove in 1.18 + * Array lookup + * Returns an array where the values in the first array are replaced by the + * values in the second array with the corresponding keys + * + * @param $a Array + * @param $b Array + * @return array + */ +function wfArrayLookup( $a, $b ) { + return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) ); +} + +/** + * Appends to second array if $value differs from that in $default + * + * @param $key String|Int + * @param $value Mixed + * @param $default Mixed + * @param $changed Array to alter + */ +function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) { + if ( is_null( $changed ) ) { + throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' ); + } + if ( $default[$key] !== $value ) { + $changed[$key] = $value; + } +} + +/** + * Backwards array plus for people who haven't bothered to read the PHP manual + * XXX: will not darn your socks for you. + * + * @param $array1 Array + * @param [$array2, [...]] Arrays + * @return Array + */ +function wfArrayMerge( $array1/* ... */ ) { + $args = func_get_args(); + $args = array_reverse( $args, true ); + $out = array(); + foreach ( $args as $arg ) { + $out += $arg; + } + return $out; +} + +/** + * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal + * e.g. + * wfMergeErrorArrays( + * array( array( 'x' ) ), + * array( array( 'x', '2' ) ), + * array( array( 'x' ) ), + * array( array( 'y') ) + * ); + * returns: + * array( + * array( 'x', '2' ), + * array( 'x' ), + * array( 'y' ) + * ) + * @param varargs + * @return Array + */ +function wfMergeErrorArrays( /*...*/ ) { + $args = func_get_args(); + $out = array(); + foreach ( $args as $errors ) { + foreach ( $errors as $params ) { + # @todo FIXME: Sometimes get nested arrays for $params, + # which leads to E_NOTICEs + $spec = implode( "\t", $params ); + $out[$spec] = $params; + } + } + return array_values( $out ); +} + +/** + * Insert array into another array after the specified *KEY* + * + * @param $array Array: The array. + * @param $insert Array: The array to insert. + * @param $after Mixed: The key to insert after + * @return Array + */ +function wfArrayInsertAfter( $array, $insert, $after ) { + // Find the offset of the element to insert after. + $keys = array_keys( $array ); + $offsetByKey = array_flip( $keys ); + + $offset = $offsetByKey[$after]; + + // Insert at the specified offset + $before = array_slice( $array, 0, $offset + 1, true ); + $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true ); + + $output = $before + $insert + $after; + + return $output; +} + +/** + * Recursively converts the parameter (an object) to an array with the same data + * + * @param $objOrArray Object|Array + * @param $recursive Bool + * @return Array + */ +function wfObjectToArray( $objOrArray, $recursive = true ) { + $array = array(); + if( is_object( $objOrArray ) ) { + $objOrArray = get_object_vars( $objOrArray ); + } + foreach ( $objOrArray as $key => $value ) { + if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) { + $value = wfObjectToArray( $value ); + } + + $array[$key] = $value; + } + + return $array; +} + +/** + * Wrapper around array_map() which also taints variables + * + * @param $function Callback + * @param $input Array + * @return Array */ -function wfSeedRandom() { - wfDeprecated(__FUNCTION__); +function wfArrayMap( $function, $input ) { + $ret = array_map( $function, $input ); + foreach ( $ret as $key => $value ) { + $taint = istainted( $input[$key] ); + if ( $taint ) { + taint( $ret[$key], $taint ); + } + } + return $ret; } /** @@ -283,6 +294,11 @@ function wfRandom() { */ function wfUrlencode( $s ) { static $needle; + if ( is_null( $s ) ) { + $needle = null; + return; + } + if ( is_null( $needle ) ) { $needle = array( '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F' ); if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) || ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false ) ) { @@ -301,6 +317,365 @@ function wfUrlencode( $s ) { } /** + * This function takes two arrays as input, and returns a CGI-style string, e.g. + * "days=7&limit=100". Options in the first array override options in the second. + * Options set to "" will not be output. + * + * @param $array1 Array ( String|Array ) + * @param $array2 Array ( String|Array ) + * @param $prefix String + * @return String + */ +function wfArrayToCGI( $array1, $array2 = null, $prefix = '' ) { + if ( !is_null( $array2 ) ) { + $array1 = $array1 + $array2; + } + + $cgi = ''; + foreach ( $array1 as $key => $value ) { + if ( $value !== '' ) { + if ( $cgi != '' ) { + $cgi .= '&'; + } + if ( $prefix !== '' ) { + $key = $prefix . "[$key]"; + } + if ( is_array( $value ) ) { + $firstTime = true; + foreach ( $value as $k => $v ) { + $cgi .= $firstTime ? '' : '&'; + if ( is_array( $v ) ) { + $cgi .= wfArrayToCGI( $v, null, $key . "[$k]" ); + } else { + $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v ); + } + $firstTime = false; + } + } else { + if ( is_object( $value ) ) { + $value = $value->__toString(); + } + $cgi .= urlencode( $key ) . '=' . urlencode( $value ); + } + } + } + return $cgi; +} + +/** + * This is the logical opposite of wfArrayToCGI(): it accepts a query string as + * its argument and returns the same string in array form. This allows compa- + * tibility with legacy functions that accept raw query strings instead of nice + * arrays. Of course, keys and values are urldecode()d. Don't try passing in- + * valid query strings, or it will explode. + * + * @param $query String: query string + * @return array Array version of input + */ +function wfCgiToArray( $query ) { + if ( isset( $query[0] ) && $query[0] == '?' ) { + $query = substr( $query, 1 ); + } + $bits = explode( '&', $query ); + $ret = array(); + foreach ( $bits as $bit ) { + if ( $bit === '' ) { + continue; + } + list( $key, $value ) = explode( '=', $bit ); + $key = urldecode( $key ); + $value = urldecode( $value ); + if ( strpos( $key, '[' ) !== false ) { + $keys = array_reverse( explode( '[', $key ) ); + $key = array_pop( $keys ); + $temp = $value; + foreach ( $keys as $k ) { + $k = substr( $k, 0, -1 ); + $temp = array( $k => $temp ); + } + if ( isset( $ret[$key] ) ) { + $ret[$key] = array_merge( $ret[$key], $temp ); + } else { + $ret[$key] = $temp; + } + } else { + $ret[$key] = $value; + } + } + return $ret; +} + +/** + * Append a query string to an existing URL, which may or may not already + * have query string parameters already. If so, they will be combined. + * + * @param $url String + * @param $query Mixed: string or associative array + * @return string + */ +function wfAppendQuery( $url, $query ) { + if ( is_array( $query ) ) { + $query = wfArrayToCGI( $query ); + } + if( $query != '' ) { + if( false === strpos( $url, '?' ) ) { + $url .= '?'; + } else { + $url .= '&'; + } + $url .= $query; + } + return $url; +} + +/** + * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer + * is correct. + * + * The meaning of the PROTO_* constants is as follows: + * PROTO_HTTP: Output a URL starting with http:// + * PROTO_HTTPS: Output a URL starting with https:// + * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL) + * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending on which protocol was used for the current incoming request + * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer. For protocol-relative URLs, use the protocol of $wgCanonicalServer + * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer + * + * @todo this won't work with current-path-relative URLs + * like "subdir/foo.html", etc. + * + * @param $url String: either fully-qualified or a local path + query + * @param $defaultProto Mixed: one of the PROTO_* constants. Determines the protocol to use if $url or $wgServer is protocol-relative + * @return string Fully-qualified URL + */ +function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) { + global $wgServer, $wgCanonicalServer, $wgInternalServer; + $serverUrl = $wgServer; + if ( $defaultProto === PROTO_CANONICAL ) { + $serverUrl = $wgCanonicalServer; + } + // Make $wgInternalServer fall back to $wgServer if not set + if ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) { + $serverUrl = $wgInternalServer; + } + if ( $defaultProto === PROTO_CURRENT ) { + $defaultProto = WebRequest::detectProtocol() . '://'; + } + + // Analyze $serverUrl to obtain its protocol + $bits = wfParseUrl( $serverUrl ); + $serverHasProto = $bits && $bits['scheme'] != ''; + + if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) { + if ( $serverHasProto ) { + $defaultProto = $bits['scheme'] . '://'; + } else { + // $wgCanonicalServer or $wgInternalServer doesn't have a protocol. This really isn't supposed to happen + // Fall back to HTTP in this ridiculous case + $defaultProto = PROTO_HTTP; + } + } + + $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 ); + + if( substr( $url, 0, 2 ) == '//' ) { + return $defaultProtoWithoutSlashes . $url; + } elseif( substr( $url, 0, 1 ) == '/' ) { + // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes, otherwise leave it alone + return ( $serverHasProto ? '' : $defaultProtoWithoutSlashes ) . $serverUrl . $url; + } else { + return $url; + } +} + +/** + * Returns a regular expression of url protocols + * + * @param $includeProtocolRelative bool If false, remove '//' from the returned protocol list. + * DO NOT USE this directy, use wfUrlProtocolsWithoutProtRel() instead + * @return String + */ +function wfUrlProtocols( $includeProtocolRelative = true ) { + global $wgUrlProtocols; + + // Cache return values separately based on $includeProtocolRelative + static $withProtRel = null, $withoutProtRel = null; + $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel; + if ( !is_null( $cachedValue ) ) { + return $cachedValue; + } + + // Support old-style $wgUrlProtocols strings, for backwards compatibility + // with LocalSettings files from 1.5 + if ( is_array( $wgUrlProtocols ) ) { + $protocols = array(); + foreach ( $wgUrlProtocols as $protocol ) { + // Filter out '//' if !$includeProtocolRelative + if ( $includeProtocolRelative || $protocol !== '//' ) { + $protocols[] = preg_quote( $protocol, '/' ); + } + } + + $retval = implode( '|', $protocols ); + } else { + // Ignore $includeProtocolRelative in this case + // This case exists for pre-1.6 compatibility, and we can safely assume + // that '//' won't appear in a pre-1.6 config because protocol-relative + // URLs weren't supported until 1.18 + $retval = $wgUrlProtocols; + } + + // Cache return value + if ( $includeProtocolRelative ) { + $withProtRel = $retval; + } else { + $withoutProtRel = $retval; + } + return $retval; +} + +/** + * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if + * you need a regex that matches all URL protocols but does not match protocol- + * relative URLs + */ +function wfUrlProtocolsWithoutProtRel() { + return wfUrlProtocols( false ); +} + +/** + * parse_url() work-alike, but non-broken. Differences: + * + * 1) Does not raise warnings on bad URLs (just returns false) + * 2) Handles protocols that don't use :// (e.g., mailto: and news: , as well as protocol-relative URLs) correctly + * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)) + * + * @param $url String: a URL to parse + * @return Array: bits of the URL in an associative array, per PHP docs + */ +function wfParseUrl( $url ) { + global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php + + // Protocol-relative URLs are handled really badly by parse_url(). It's so bad that the easiest + // way to handle them is to just prepend 'http:' and strip the protocol out later + $wasRelative = substr( $url, 0, 2 ) == '//'; + if ( $wasRelative ) { + $url = "http:$url"; + } + wfSuppressWarnings(); + $bits = parse_url( $url ); + wfRestoreWarnings(); + if ( !$bits ) { + return false; + } + + // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it + if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) { + $bits['delimiter'] = '://'; + } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) { + $bits['delimiter'] = ':'; + // parse_url detects for news: and mailto: the host part of an url as path + // We have to correct this wrong detection + if ( isset( $bits['path'] ) ) { + $bits['host'] = $bits['path']; + $bits['path'] = ''; + } + } else { + return false; + } + + /* Provide an empty host for eg. file:/// urls (see bug 28627) */ + if ( !isset( $bits['host'] ) ) { + $bits['host'] = ''; + + /* parse_url loses the third / for file:///c:/ urls (but not on variants) */ + if ( substr( $bits['path'], 0, 1 ) !== '/' ) { + $bits['path'] = '/' . $bits['path']; + } + } + + // If the URL was protocol-relative, fix scheme and delimiter + if ( $wasRelative ) { + $bits['scheme'] = ''; + $bits['delimiter'] = '//'; + } + return $bits; +} + +/** + * Make URL indexes, appropriate for the el_index field of externallinks. + * + * @param $url String + * @return array + */ +function wfMakeUrlIndexes( $url ) { + $bits = wfParseUrl( $url ); + + // Reverse the labels in the hostname, convert to lower case + // For emails reverse domainpart only + if ( $bits['scheme'] == 'mailto' ) { + $mailparts = explode( '@', $bits['host'], 2 ); + if ( count( $mailparts ) === 2 ) { + $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) ); + } else { + // No domain specified, don't mangle it + $domainpart = ''; + } + $reversedHost = $domainpart . '@' . $mailparts[0]; + } else { + $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) ); + } + // Add an extra dot to the end + // Why? Is it in wrong place in mailto links? + if ( substr( $reversedHost, -1, 1 ) !== '.' ) { + $reversedHost .= '.'; + } + // Reconstruct the pseudo-URL + $prot = $bits['scheme']; + $index = $prot . $bits['delimiter'] . $reversedHost; + // Leave out user and password. Add the port, path, query and fragment + if ( isset( $bits['port'] ) ) { + $index .= ':' . $bits['port']; + } + if ( isset( $bits['path'] ) ) { + $index .= $bits['path']; + } else { + $index .= '/'; + } + if ( isset( $bits['query'] ) ) { + $index .= '?' . $bits['query']; + } + if ( isset( $bits['fragment'] ) ) { + $index .= '#' . $bits['fragment']; + } + + if ( $prot == '' ) { + return array( "http:$index", "https:$index" ); + } else { + return array( $index ); + } +} + +/** + * Check whether a given URL has a domain that occurs in a given set of domains + * @param $url string URL + * @param $domains array Array of domains (strings) + * @return bool True if the host part of $url ends in one of the strings in $domains + */ +function wfMatchesDomainList( $url, $domains ) { + $bits = wfParseUrl( $url ); + if ( is_array( $bits ) && isset( $bits['host'] ) ) { + foreach ( (array)$domains as $domain ) { + // FIXME: This gives false positives. http://nds-nl.wikipedia.org will match nl.wikipedia.org + // We should use something that interprets dots instead + if ( substr( $bits['host'], -strlen( $domain ) ) === $domain ) { + return true; + } + } + } + return false; +} + +/** * Sends a line to the debug log if enabled or, optionally, to a comment in output. * In normal operation this is a NOP. * @@ -316,44 +691,61 @@ function wfUrlencode( $s ) { function wfDebug( $text, $logonly = false ) { global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage; global $wgDebugLogPrefix, $wgShowDebug; - static $recursion = 0; static $cache = array(); // Cache of unoutputted messages $text = wfDebugTimer() . $text; - # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet - if ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' && !$wgDebugRawPage ) { + if ( !$wgDebugRawPage && wfIsDebugRawPage() ) { return; } if ( ( $wgDebugComments || $wgShowDebug ) && !$logonly ) { $cache[] = $text; - if ( !isset( $wgOut ) ) { - return; + if ( isset( $wgOut ) && is_object( $wgOut ) ) { + // add the message and any cached messages to the output + array_map( array( $wgOut, 'debug' ), $cache ); + $cache = array(); } - if ( !StubObject::isRealObject( $wgOut ) ) { - if ( $recursion ) { - return; - } - $recursion++; - $wgOut->_unstub(); - $recursion--; + } + if ( wfRunHooks( 'Debug', array( $text, null /* no log group */ ) ) ) { + if ( $wgDebugLogFile != '' && !$wgProfileOnly ) { + # Strip unprintables; they can switch terminal modes when binary data + # gets dumped, which is pretty annoying. + $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text ); + $text = $wgDebugLogPrefix . $text; + wfErrorLog( $text, $wgDebugLogFile ); } + } +} - // add the message and possible cached ones to the output - array_map( array( $wgOut, 'debug' ), $cache ); - $cache = array(); +/** + * Returns true if debug logging should be suppressed if $wgDebugRawPage = false + */ +function wfIsDebugRawPage() { + static $cache; + if ( $cache !== null ) { + return $cache; } - if ( $wgDebugLogFile != '' && !$wgProfileOnly ) { - # Strip unprintables; they can switch terminal modes when binary data - # gets dumped, which is pretty annoying. - $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $text ); - $text = $wgDebugLogPrefix . $text; - wfErrorLog( $text, $wgDebugLogFile ); + # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet + if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' ) + || ( + isset( $_SERVER['SCRIPT_NAME'] ) + && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php' + ) ) + { + $cache = true; + } else { + $cache = false; } + return $cache; } +/** + * Get microsecond timestamps for debug logs + * + * @return string + */ function wfDebugTimer() { global $wgDebugTimestamps; if ( !$wgDebugTimestamps ) { @@ -373,6 +765,7 @@ function wfDebugTimer() { /** * Send a line giving PHP memory usage. + * * @param $exact Bool: print exact values instead of kilobytes (default: false) */ function wfDebugMem( $exact = false ) { @@ -405,7 +798,9 @@ function wfDebugLog( $logGroup, $text, $public = true ) { } else { $host = ''; } - wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] ); + if ( wfRunHooks( 'Debug', array( $text, $logGroup ) ) ) { + wfErrorLog( "$time $host $wiki: $text", $wgDebugLogGroups[$logGroup] ); + } } elseif ( $public === true ) { wfDebug( $text, true ); } @@ -413,6 +808,7 @@ function wfDebugLog( $logGroup, $text, $public = true ) { /** * Log for database errors + * * @param $text String: database error message. */ function wfLogDBError( $text ) { @@ -429,6 +825,9 @@ function wfLogDBError( $text ) { * * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will * send lines to the specified port, prefixed by the specified prefix and a space. + * + * @param $text String + * @param $file String filename */ function wfErrorLog( $text, $file ) { if ( substr( $file, 0, 4 ) == 'udp:' ) { @@ -450,12 +849,21 @@ function wfErrorLog( $text, $file ) { } else { throw new MWException( __METHOD__ . ': Invalid UDP specification' ); } + // Clean it up for the multiplexer if ( strval( $prefix ) !== '' ) { $text = preg_replace( '/^/m', $prefix . ' ', $text ); + + // Limit to 64KB + if ( strlen( $text ) > 65534 ) { + $text = substr( $text, 0, 65534 ); + } + if ( substr( $text, -1 ) != "\n" ) { $text .= "\n"; } + } elseif ( strlen( $text ) > 65535 ) { + $text = substr( $text, 0, 65535 ); } $sock = socket_create( $domain, SOCK_DGRAM, SOL_UDP ); @@ -469,7 +877,7 @@ function wfErrorLog( $text, $file ) { $exists = file_exists( $file ); $size = $exists ? filesize( $file ) : false; if ( !$exists || ( $size !== false && $size + strlen( $text ) < 0x7fffffff ) ) { - error_log( $text, 3, $file ); + file_put_contents( $file, $text, FILE_APPEND ); } wfRestoreWarnings(); } @@ -480,49 +888,60 @@ function wfErrorLog( $text, $file ) { */ function wfLogProfilingData() { global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest; - global $wgProfiler, $wgProfileLimit, $wgUser; + global $wgProfileLimit, $wgUser; + + $profiler = Profiler::instance(); + # Profiling must actually be enabled... - if( is_null( $wgProfiler ) ) { + if ( $profiler->isStub() ) { return; } - # Get total page request time + + // Get total page request time and only show pages that longer than + // $wgProfileLimit time (default is 0) $now = wfTime(); $elapsed = $now - $wgRequestTime; - # Only show pages that longer than $wgProfileLimit time (default is 0) - if( $elapsed <= $wgProfileLimit ) { + if ( $elapsed <= $wgProfileLimit ) { + return; + } + + $profiler->logData(); + + // Check whether this should be logged in the debug file. + if ( $wgDebugLogFile == '' || ( !$wgDebugRawPage && wfIsDebugRawPage() ) ) { return; } - $prof = wfGetProfilingOutput( $wgRequestTime, $elapsed ); + $forward = ''; - if( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) { + if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) { $forward = ' forwarded for ' . $_SERVER['HTTP_X_FORWARDED_FOR']; } - if( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) { + if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) { $forward .= ' client IP ' . $_SERVER['HTTP_CLIENT_IP']; } - if( !empty( $_SERVER['HTTP_FROM'] ) ) { + if ( !empty( $_SERVER['HTTP_FROM'] ) ) { $forward .= ' from ' . $_SERVER['HTTP_FROM']; } - if( $forward ) { + if ( $forward ) { $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})"; } - // Don't unstub $wgUser at this late stage just for statistics purposes - // FIXME: We can detect some anons even if it is not loaded. See User::getId() - if( $wgUser->mDataLoaded && $wgUser->isAnon() ) { + // Don't load $wgUser at this late stage just for statistics purposes + // @todo FIXME: We can detect some anons even if it is not loaded. See User::getId() + if ( $wgUser->isItemLoaded( 'id' ) && $wgUser->isAnon() ) { $forward .= ' anon'; } $log = sprintf( "%s\t%04.3f\t%s\n", gmdate( 'YmdHis' ), $elapsed, urldecode( $wgRequest->getRequestURL() . $forward ) ); - if ( $wgDebugLogFile != '' && ( $wgRequest->getVal( 'action' ) != 'raw' || $wgDebugRawPage ) ) { - wfErrorLog( $log . $prof, $wgDebugLogFile ); - } + + wfErrorLog( $log . $profiler->getOutput(), $wgDebugLogFile ); } /** * Check if the wiki read-only lock file is present. This can be used to lock * off editing functions, but doesn't guarantee that the database will not be * modified. + * * @return bool */ function wfReadOnly() { @@ -551,6 +970,7 @@ function wfReadOnlyReason() { /** * Return a Language object from $langcode + * * @param $langcode Mixed: either: * - a Language object * - code of the language to get the message for, if it is @@ -596,15 +1016,15 @@ function wfGetLangObj( $langcode = false ) { } /** - * Use this instead of $wgContLang, when working with user interface. - * User interface is currently hard coded according to wiki content language - * in many ways, especially regarding to text direction. There is lots stuff - * to fix, hence this function to keep the old behaviour unless the global - * $wgBetterDirectionality is enabled (or removed when everything works). + * Old function when $wgBetterDirectionality existed + * Removed in core, kept in extensions for backwards compat. + * + * @deprecated since 1.18 + * @return Language */ function wfUILang() { - global $wgBetterDirectionality; - return wfGetLangObj( !$wgBetterDirectionality ); + global $wgLang; + return $wgLang; } /** @@ -613,7 +1033,7 @@ function wfUILang() { * The intention is that this function replaces all old wfMsg* functions. * @param $key \string Message key. * Varargs: normal message parameters. - * @return \type{Message} + * @return Message * @since 1.17 */ function wfMessage( $key /*...*/) { @@ -626,6 +1046,19 @@ function wfMessage( $key /*...*/) { } /** + * This function accepts multiple message keys and returns a message instance + * for the first message which is non-empty. If all messages are empty then an + * instance of the first message key is returned. + * @param varargs: message keys + * @return Message + * @since 1.18 + */ +function wfMessageFallback( /*...*/ ) { + $args = func_get_args(); + return MWFunction::callArray( 'Message::newFallbackSequence', $args ); +} + +/** * Get a message from anywhere, for the current user language. * * Use wfMsgForContent() instead if the message should NOT @@ -634,18 +1067,25 @@ function wfMessage( $key /*...*/) { * @param $key String: lookup key for the message, usually * defined in languages/Language.php * - * This function also takes extra optional parameters (not - * shown in the function definition), which can be used to - * insert variable text into the predefined message. + * Parameters to the message, which can be used to insert variable text into + * it, can be passed to this function in the following formats: + * - One per argument, starting at the second parameter + * - As an array in the second parameter + * These are not shown in the function definition. + * + * @return String */ function wfMsg( $key ) { $args = func_get_args(); array_shift( $args ); - return wfMsgReal( $key, $args, true ); + return wfMsgReal( $key, $args ); } /** * Same as above except doesn't transform the message + * + * @param $key String + * @return String */ function wfMsgNoTrans( $key ) { $args = func_get_args(); @@ -673,7 +1113,8 @@ function wfMsgNoTrans( $key ) { * order to, e.g., fix a link in every possible language. * * @param $key String: lookup key for the message, usually - * defined in languages/Language.php + * defined in languages/Language.php + * @return String */ function wfMsgForContent( $key ) { global $wgForceUIMsgAsContentMsg; @@ -690,6 +1131,9 @@ function wfMsgForContent( $key ) { /** * Same as above except doesn't transform the message + * + * @param $key String + * @return String */ function wfMsgForContentNoTrans( $key ) { global $wgForceUIMsgAsContentMsg; @@ -705,33 +1149,8 @@ function wfMsgForContentNoTrans( $key ) { } /** - * Get a message from the language file, for the UI elements - */ -function wfMsgNoDB( $key ) { - $args = func_get_args(); - array_shift( $args ); - return wfMsgReal( $key, $args, false ); -} - -/** - * Get a message from the language file, for the content - */ -function wfMsgNoDBForContent( $key ) { - global $wgForceUIMsgAsContentMsg; - $args = func_get_args(); - array_shift( $args ); - $forcontent = true; - if( is_array( $wgForceUIMsgAsContentMsg ) && - in_array( $key, $wgForceUIMsgAsContentMsg ) ) - { - $forcontent = false; - } - return wfMsgReal( $key, $args, false, $forcontent ); -} - - -/** * Really get a message + * * @param $key String: key to get. * @param $args * @param $useDB Boolean @@ -748,20 +1167,8 @@ function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform } /** - * This function provides the message source for messages to be edited which are *not* stored in the database. - * @param $key String: - */ -function wfMsgWeirdKey( $key ) { - $source = wfMsgGetKey( $key, false, true, false ); - if ( wfEmptyMsg( $key, $source ) ) { - return ''; - } else { - return $source; - } -} - -/** * Fetch a message string value, but don't replace any keys yet. + * * @param $key String * @param $useDB Bool * @param $langCode String: Code of the language to get the message for, or @@ -769,20 +1176,15 @@ function wfMsgWeirdKey( $key ) { * @param $transform Boolean: whether to parse magic words, etc. * @return string */ -function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) { - global $wgMessageCache; - +function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) { wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) ); - if ( !is_object( $wgMessageCache ) ) { - throw new MWException( 'Trying to get message before message cache is initialised' ); - } - - $message = $wgMessageCache->get( $key, $useDB, $langCode ); + $cache = MessageCache::singleton(); + $message = $cache->get( $key, $useDB, $langCode ); if( $message === false ) { $message = '<' . htmlspecialchars( $key ) . '>'; } elseif ( $transform ) { - $message = $wgMessageCache->transform( $message ); + $message = $cache->transform( $message ); } return $message; } @@ -829,7 +1231,7 @@ function wfMsgReplaceArgs( $message, $args ) { function wfMsgHtml( $key ) { $args = func_get_args(); array_shift( $args ); - return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args ); + return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key ) ), $args ); } /** @@ -844,10 +1246,11 @@ function wfMsgHtml( $key ) { * @return string */ function wfMsgWikiHtml( $key ) { - global $wgOut; $args = func_get_args(); array_shift( $args ); - return wfMsgReplaceArgs( $wgOut->parse( wfMsgGetKey( $key, true ), /* can't be set to false */ true ), $args ); + return wfMsgReplaceArgs( + MessageCache::singleton()->parse( wfMsgGetKey( $key ), null, /* can't be set to false */ true )->getText(), + $args ); } /** @@ -864,13 +1267,12 @@ function wfMsgWikiHtml( $key ) { * <i>content</i>: fetch message for content language instead of interface * Also can accept a single associative argument, of the form 'language' => 'xx': * <i>language</i>: Language object or language code to fetch message for - * (overriden by <i>content</i>), its behaviour with parse, parseinline - * and parsemag is undefined. + * (overriden by <i>content</i>). * Behavior for conflicting options (e.g., parse+parseinline) is undefined. + * + * @return String */ function wfMsgExt( $key, $options ) { - global $wgOut; - $args = func_get_args(); array_shift( $args ); array_shift( $args ); @@ -891,12 +1293,15 @@ function wfMsgExt( $key, $options ) { if( in_array( 'content', $options, true ) ) { $forContent = true; $langCode = true; + $langCodeObj = null; } elseif( array_key_exists( 'language', $options ) ) { $forContent = false; $langCode = wfGetLangObj( $options['language'] ); + $langCodeObj = $langCode; } else { $forContent = false; $langCode = false; + $langCodeObj = null; } $string = wfMsgGetKey( $key, /*DB*/true, $langCode, /*Transform*/false ); @@ -905,21 +1310,18 @@ function wfMsgExt( $key, $options ) { $string = wfMsgReplaceArgs( $string, $args ); } + $messageCache = MessageCache::singleton(); if( in_array( 'parse', $options, true ) ) { - $string = $wgOut->parse( $string, true, !$forContent ); + $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText(); } elseif ( in_array( 'parseinline', $options, true ) ) { - $string = $wgOut->parse( $string, true, !$forContent ); + $string = $messageCache->parse( $string, null, true, !$forContent, $langCodeObj )->getText(); $m = array(); if( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $string, $m ) ) { $string = $m[1]; } } elseif ( in_array( 'parsemag', $options, true ) ) { - global $wgMessageCache; - if ( isset( $wgMessageCache ) ) { - $string = $wgMessageCache->transform( $string, - !$forContent, - is_object( $langCode ) ? $langCode : null ); - } + $string = $messageCache->transform( $string, + !$forContent, $langCodeObj ); } if ( in_array( 'escape', $options, true ) ) { @@ -935,58 +1337,16 @@ function wfMsgExt( $key, $options ) { return $string; } - /** - * Just like exit() but makes a note of it. - * Commits open transactions except if the error parameter is set + * Since wfMsg() and co suck, they don't return false if the message key they + * looked up didn't exist but a XHTML string, this function checks for the + * nonexistance of messages by checking the MessageCache::get() result directly. * - * @deprecated Please return control to the caller or throw an exception. Will - * be removed in 1.19. - */ -function wfAbruptExit( $error = false ) { - static $called = false; - if ( $called ) { - exit( -1 ); - } - $called = true; - - wfDeprecated( __FUNCTION__ ); - $bt = wfDebugBacktrace(); - if( $bt ) { - for( $i = 0; $i < count( $bt ); $i++ ) { - $file = isset( $bt[$i]['file'] ) ? $bt[$i]['file'] : 'unknown'; - $line = isset( $bt[$i]['line'] ) ? $bt[$i]['line'] : 'unknown'; - wfDebug( "WARNING: Abrupt exit in $file at line $line\n"); - } - } else { - wfDebug( "WARNING: Abrupt exit\n" ); - } - - wfLogProfilingData(); - - if ( !$error ) { - wfGetLB()->closeAll(); - } - exit( -1 ); -} - -/** - * @deprecated Please return control the caller or throw an exception. Will - * be removed in 1.19. - */ -function wfErrorExit() { - wfDeprecated( __FUNCTION__ ); - wfAbruptExit( true ); -} - -/** - * Print a simple message and die, returning nonzero to the shell if any. - * Plain die() fails to return nonzero to the shell if you pass a string. - * @param $msg String + * @param $key String: the message key looked up + * @return Boolean True if the message *doesn't* exist. */ -function wfDie( $msg = '' ) { - echo $msg; - die( 1 ); +function wfEmptyMsg( $key ) { + return MessageCache::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false; } /** @@ -1003,6 +1363,7 @@ function wfDebugDieBacktrace( $msg = '' ) { * Fetch server name for use in error reporting etc. * Use real server name if available, so we know which machine * in a server farm generated the current page. + * * @return string */ function wfHostname() { @@ -1010,7 +1371,7 @@ function wfHostname() { if ( is_null( $host ) ) { if ( function_exists( 'posix_uname' ) ) { // This function not present on Windows - $uname = @posix_uname(); + $uname = posix_uname(); } else { $uname = false; } @@ -1030,6 +1391,7 @@ function wfHostname() { /** * Returns a HTML comment with the elapsed time since request. * This method has no side effects. + * * @return string */ function wfReportTime() { @@ -1054,9 +1416,11 @@ function wfReportTime() { * debug_backtrace is disabled, otherwise the output from * debug_backtrace() (trimmed). * + * @param $limit int This parameter can be used to limit the number of stack frames returned + * * @return array of backtrace information */ -function wfDebugBacktrace() { +function wfDebugBacktrace( $limit = 0 ) { static $disabled = null; if( extension_loaded( 'Zend Optimizer' ) ) { @@ -1078,9 +1442,18 @@ function wfDebugBacktrace() { return array(); } - return array_slice( debug_backtrace(), 1 ); + if ( $limit && version_compare( PHP_VERSION, '5.4.0', '>=' ) ) { + return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit ), 1 ); + } else { + return array_slice( debug_backtrace(), 1 ); + } } +/** + * Get a debug backtrace as a string + * + * @return string + */ function wfBacktrace() { global $wgCommandLineMode; @@ -1108,7 +1481,7 @@ function wfBacktrace() { $msg .= '<li>' . $file . ' line ' . $line . ' calls '; } if( !empty( $call['class'] ) ) { - $msg .= $call['class'] . '::'; + $msg .= $call['class'] . $call['type']; } $msg .= $call['function'] . '()'; @@ -1127,12 +1500,61 @@ function wfBacktrace() { return $msg; } +/** + * Get the name of the function which called this function + * + * @param $level Int + * @return Bool|string + */ +function wfGetCaller( $level = 2 ) { + $backtrace = wfDebugBacktrace( $level ); + if ( isset( $backtrace[$level] ) ) { + return wfFormatStackFrame( $backtrace[$level] ); + } else { + $caller = 'unknown'; + } + return $caller; +} + +/** + * Return a string consisting of callers in the stack. Useful sometimes + * for profiling specific points. + * + * @param $limit The maximum depth of the stack frame to return, or false for + * the entire stack. + * @return String + */ +function wfGetAllCallers( $limit = 3 ) { + $trace = array_reverse( wfDebugBacktrace() ); + if ( !$limit || $limit > count( $trace ) - 1 ) { + $limit = count( $trace ) - 1; + } + $trace = array_slice( $trace, -$limit - 1, $limit ); + return implode( '/', array_map( 'wfFormatStackFrame', $trace ) ); +} + +/** + * Return a string representation of frame + * + * @param $frame Array + * @return Bool + */ +function wfFormatStackFrame( $frame ) { + return isset( $frame['class'] ) ? + $frame['class'] . '::' . $frame['function'] : + $frame['function']; +} + /* Some generic result counters, pulled out of SearchEngine */ /** * @todo document + * + * @param $offset Int + * @param $limit Int + * @return String */ function wfShowingResults( $offset, $limit ) { global $wgLang; @@ -1145,31 +1567,19 @@ function wfShowingResults( $offset, $limit ) { } /** - * @todo document - */ -function wfShowingResultsNum( $offset, $limit, $num ) { - global $wgLang; - return wfMsgExt( - 'showingresultsnum', - array( 'parseinline' ), - $wgLang->formatNum( $limit ), - $wgLang->formatNum( $offset + 1 ), - $wgLang->formatNum( $num ) - ); -} - -/** * Generate (prev x| next x) (20|50|100...) type links for paging + * * @param $offset String * @param $limit Integer * @param $link String * @param $query String: optional URL query parameter string * @param $atend Bool: optional param for specified if this is the last page + * @return String */ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) { global $wgLang; $fmtLimit = $wgLang->formatNum( $limit ); - // FIXME: Why on earth this needs one message for the text and another one for tooltip?? + // @todo FIXME: Why on earth this needs one message for the text and another one for tooltip? # Get prev/next link display text $prev = wfMsgExt( 'prevn', array( 'parsemag', 'escape' ), $fmtLimit ); $next = wfMsgExt( 'nextn', array( 'parsemag', 'escape' ), $fmtLimit ); @@ -1221,6 +1631,7 @@ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) { /** * Generate links for (20|50|100...) items-per-page links + * * @param $offset String * @param $limit Integer * @param $title Title @@ -1242,16 +1653,17 @@ function wfNumLink( $offset, $limit, $title, $query = '' ) { /** * @todo document - * @todo FIXME: we may want to blacklist some broken browsers + * @todo FIXME: We may want to blacklist some broken browsers * + * @param $force Bool * @return bool Whereas client accept gzip compression */ -function wfClientAcceptsGzip() { +function wfClientAcceptsGzip( $force = false ) { static $result = null; - if ( $result === null ) { + if ( $result === null || $force ) { $result = false; if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) { - # FIXME: we may want to blacklist some broken browsers + # @todo FIXME: We may want to blacklist some broken browsers $m = array(); if( preg_match( '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/', @@ -1275,8 +1687,8 @@ function wfClientAcceptsGzip() { * Obtain the offset and limit values from the request string; * used in special pages * - * @param $deflimit Default limit if none supplied - * @param $optionname Name of a user preference to check against + * @param $deflimit Int default limit if none supplied + * @param $optionname String Name of a user preference to check against * @return array * */ @@ -1289,50 +1701,26 @@ function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) { * Escapes the given text so that it may be output using addWikiText() * without any linking, formatting, etc. making its way through. This * is achieved by substituting certain characters with HTML entities. - * As required by the callers, <nowiki> is not used. It currently does - * not filter out characters which have special meaning only at the - * start of a line, such as "*". + * As required by the callers, <nowiki> is not used. * * @param $text String: text to be escaped + * @return String */ function wfEscapeWikiText( $text ) { - $text = str_replace( - array( '[', '|', ']', '\'', 'ISBN ', - 'RFC ', '://', "\n=", '{{', '}}' ), - array( '[', '|', ']', ''', 'ISBN ', - 'RFC ', '://', "\n=", '{{', '}}' ), - htmlspecialchars( $text ) - ); - return $text; -} - -/** - * @todo document - */ -function wfQuotedPrintable( $string, $charset = '' ) { - # Probably incomplete; see RFC 2045 - if( empty( $charset ) ) { - global $wgInputEncoding; - $charset = $wgInputEncoding; - } - $charset = strtoupper( $charset ); - $charset = str_replace( 'ISO-8859', 'ISO8859', $charset ); // ? - - $illegal = '\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\xff='; - $replace = $illegal . '\t ?_'; - if( !preg_match( "/[$illegal]/", $string ) ) { - return $string; - } - $out = "=?$charset?Q?"; - $out .= preg_replace( "/([$replace])/e", 'sprintf("=%02X",ord("$1"))', $string ); - $out .= '?='; - return $out; + $text = strtr( "\n$text", array( + '"' => '"', '&' => '&', "'" => ''', '<' => '<', + '=' => '=', '>' => '>', '[' => '[', ']' => ']', + '{' => '{', '|' => '|', '}' => '}', + "\n#" => "\n#", "\n*" => "\n*", + "\n:" => "\n:", "\n;" => "\n;", + '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ', + ) ); + return substr( $text, 1 ); } - /** - * @todo document - * @return float + * Get the current unix timetstamp with microseconds. Useful for profiling + * @return Float */ function wfTime() { return microtime( true ); @@ -1342,6 +1730,11 @@ function wfTime() { * Sets dest to source and returns the original value of dest * If source is NULL, it just returns the value, it doesn't set the variable * If force is true, it will set the value even if source is NULL + * + * @param $dest Mixed + * @param $source Mixed + * @param $force Bool + * @return Mixed */ function wfSetVar( &$dest, $source, $force = false ) { $temp = $dest; @@ -1353,6 +1746,10 @@ function wfSetVar( &$dest, $source, $force = false ) { /** * As for wfSetVar except setting a bit + * + * @param $dest Int + * @param $bit Int + * @param $state Bool */ function wfSetBit( &$dest, $bit, $state = true ) { $temp = (bool)( $dest & $bit ); @@ -1367,121 +1764,15 @@ function wfSetBit( &$dest, $bit, $state = true ) { } /** - * This function takes two arrays as input, and returns a CGI-style string, e.g. - * "days=7&limit=100". Options in the first array override options in the second. - * Options set to "" will not be output. - */ -function wfArrayToCGI( $array1, $array2 = null ) { - if ( !is_null( $array2 ) ) { - $array1 = $array1 + $array2; - } - - $cgi = ''; - foreach ( $array1 as $key => $value ) { - if ( $value !== '' ) { - if ( $cgi != '' ) { - $cgi .= '&'; - } - if ( is_array( $value ) ) { - $firstTime = true; - foreach ( $value as $v ) { - $cgi .= ( $firstTime ? '' : '&') . - urlencode( $key . '[]' ) . '=' . - urlencode( $v ); - $firstTime = false; - } - } else { - if ( is_object( $value ) ) { - $value = $value->__toString(); - } - $cgi .= urlencode( $key ) . '=' . - urlencode( $value ); - } - } - } - return $cgi; -} - -/** - * This is the logical opposite of wfArrayToCGI(): it accepts a query string as - * its argument and returns the same string in array form. This allows compa- - * tibility with legacy functions that accept raw query strings instead of nice - * arrays. Of course, keys and values are urldecode()d. Don't try passing in- - * valid query strings, or it will explode. - * - * @param $query String: query string - * @return array Array version of input - */ -function wfCgiToArray( $query ) { - if( isset( $query[0] ) && $query[0] == '?' ) { - $query = substr( $query, 1 ); - } - $bits = explode( '&', $query ); - $ret = array(); - foreach( $bits as $bit ) { - if( $bit === '' ) { - continue; - } - list( $key, $value ) = explode( '=', $bit ); - $key = urldecode( $key ); - $value = urldecode( $value ); - $ret[$key] = $value; - } - return $ret; -} - -/** - * Append a query string to an existing URL, which may or may not already - * have query string parameters already. If so, they will be combined. - * - * @param $url String - * @param $query Mixed: string or associative array - * @return string - */ -function wfAppendQuery( $url, $query ) { - if ( is_array( $query ) ) { - $query = wfArrayToCGI( $query ); - } - if( $query != '' ) { - if( false === strpos( $url, '?' ) ) { - $url .= '?'; - } else { - $url .= '&'; - } - $url .= $query; - } - return $url; -} - -/** - * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer - * and $wgProto are correct. - * - * @todo this won't work with current-path-relative URLs - * like "subdir/foo.html", etc. - * - * @param $url String: either fully-qualified or a local path + query - * @return string Fully-qualified URL - */ -function wfExpandUrl( $url ) { - if( substr( $url, 0, 2 ) == '//' ) { - global $wgProto; - return $wgProto . ':' . $url; - } elseif( substr( $url, 0, 1 ) == '/' ) { - global $wgServer; - return $wgServer . $url; - } else { - return $url; - } -} - -/** * Windows-compatible version of escapeshellarg() * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg() * function puts single quotes in regardless of OS. * * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to * earlier distro releases of PHP) + * + * @param varargs + * @return String */ function wfEscapeShellArg( ) { wfInitShellLocale(); @@ -1497,8 +1788,12 @@ function wfEscapeShellArg( ) { } if ( wfIsWindows() ) { - // Escaping for an MSVC-style command line parser - // Ref: http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html + // Escaping for an MSVC-style command line parser and CMD.EXE + // Refs: + // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html + // * http://technet.microsoft.com/en-us/library/cc723564.aspx + // * Bug #13518 + // * CR r63214 // Double the backslashes before any double quotes. Escape the double quotes. $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE ); $arg = ''; @@ -1535,6 +1830,12 @@ function wfEscapeShellArg( ) { /** * wfMerge attempts to merge differences between three texts. * Returns true for a clean merge and false for failure or a conflict. + * + * @param $old String + * @param $mine String + * @param $yours String + * @param $result String + * @return Bool */ function wfMerge( $old, $mine, $yours, &$result ) { global $wgDiff3; @@ -1604,6 +1905,7 @@ function wfMerge( $old, $mine, $yours, &$result ) { /** * Returns unified plain-text diff of two texts. * Useful for machine processing of diffs. + * * @param $before String: the text before the changes. * @param $after String: the text after the changes. * @param $params String: command-line options for the diff command. @@ -1681,7 +1983,7 @@ function wfDiff( $before, $after, $params = '-u' ) { function wfVarDump( $var ) { global $wgOut; $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" ); - if ( headers_sent() || !@is_object( $wgOut ) ) { + if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) { print $s; } else { $wgOut->addHTML( $s ); @@ -1690,6 +1992,10 @@ function wfVarDump( $var ) { /** * Provide a simple HTTP error. + * + * @param $code Int|String + * @param $label String + * @param $desc String */ function wfHttpError( $code, $label, $desc ) { global $wgOut; @@ -1783,6 +2089,10 @@ function wfClearOutputBuffers() { /** * Converts an Accept-* header into an array mapping string values to quality * factors + * + * @param $accept String + * @param $def String default + * @return Array */ function wfAcceptToPrefs( $accept, $def = '*/*' ) { # No arg means accept anything (per HTTP spec) @@ -1795,13 +2105,13 @@ function wfAcceptToPrefs( $accept, $def = '*/*' ) { $parts = explode( ',', $accept ); foreach( $parts as $part ) { - # FIXME: doesn't deal with params like 'text/html; level=1' - @list( $value, $qpart ) = explode( ';', trim( $part ) ); + # @todo FIXME: Doesn't deal with params like 'text/html; level=1' + $values = explode( ';', trim( $part ) ); $match = array(); - if( !isset( $qpart ) ) { - $prefs[$value] = 1.0; - } elseif( preg_match( '/q\s*=\s*(\d*\.\d+)/', $qpart, $match ) ) { - $prefs[$value] = floatval( $match[1] ); + if ( count( $values ) == 1 ) { + $prefs[$values[0]] = 1.0; + } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) { + $prefs[$values[0]] = floatval( $match[1] ); } } @@ -1845,7 +2155,7 @@ function mimeTypeMatch( $type, $avail ) { * @param $sprefs Array: server's offered types * @return string * - * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8' + * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8' * XXX: generalize to negotiate other stuff */ function wfNegotiateType( $cprefs, $sprefs ) { @@ -1885,27 +2195,9 @@ function wfNegotiateType( $cprefs, $sprefs ) { } /** - * Array lookup - * Returns an array where the values in the first array are replaced by the - * values in the second array with the corresponding keys - * - * @return array - */ -function wfArrayLookup( $a, $b ) { - return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) ); -} - -/** - * Convenience function; returns MediaWiki timestamp for the present time. - * @return string - */ -function wfTimestampNow() { - # return NOW - return wfTimestamp( TS_MW, time() ); -} - -/** * Reference-counted warning suppression + * + * @param $end Bool */ function wfSuppressWarnings( $end = false ) { static $suppressCount = 0; @@ -1920,7 +2212,11 @@ function wfSuppressWarnings( $end = false ) { } } else { if ( !$suppressCount ) { - $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE ) ); + // E_DEPRECATED is undefined in PHP 5.2 + if( !defined( 'E_DEPRECATED' ) ){ + define( 'E_DEPRECATED', 8192 ); + } + $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE | E_DEPRECATED ) ); } ++$suppressCount; } @@ -1987,13 +2283,13 @@ define( 'TS_POSTGRES', 7 ); define( 'TS_DB2', 8 ); /** - * ISO 8601 basic format with no timezone: 19860209T200000Z - * - * This is used by ResourceLoader + * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader */ define( 'TS_ISO_8601_BASIC', 9 ); /** + * Get a timestamp string in one of various formats + * * @param $outputtype Mixed: A timestamp in one of the supported formats, the * function will autodetect which format is supplied and act * accordingly. @@ -2036,7 +2332,7 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) { '\d\d?[ \t\r\n]*[A-Z][a-z]{2}[ \t\r\n]*\d{2}(?:\d{2})?' . # dd Mon yyyy '[ \t\r\n]*\d\d[ \t\r\n]*:[ \t\r\n]*\d\d[ \t\r\n]*:[ \t\r\n]*\d\d/S', $ts ) ) { # hh:mm:ss # TS_RFC2822, accepting a trailing comment. See http://www.squid-cache.org/mail-archive/squid-users/200307/0122.html / r77171 - # The regex is a superset of rfc2822 for readability + # The regex is a superset of rfc2822 for readability $strtime = strtok( $ts, ';' ); } elseif ( preg_match( '/^[A-Z][a-z]{5,8}, \d\d-[A-Z][a-z]{2}-\d{2} \d\d:\d\d:\d\d/', $ts ) ) { # TS_RFC850 @@ -2046,13 +2342,11 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) { $strtime = $ts; } else { # Bogus value... - wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n"); - + wfDebug("wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n"); + return false; } - - static $formats = array( TS_UNIX => 'U', TS_MW => 'YmdHis', @@ -2082,12 +2376,12 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) { } else { return false; } - + if ( !$d ) { wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n"); return false; } - + $output = $d->format( $formats[$outputtype] ); } else { if ( count( $da ) ) { @@ -2120,6 +2414,7 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) { /** * Return a formatted timestamp, or null if input is null. * For dealing with nullable timestamp columns in the database. + * * @param $outputtype Integer * @param $ts String * @return String @@ -2133,6 +2428,16 @@ function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) { } /** + * Convenience function; returns MediaWiki timestamp for the present time. + * + * @return string + */ +function wfTimestampNow() { + # return NOW + return wfTimestamp( TS_MW, time() ); +} + +/** * Check if the operating system is Windows * * @return Bool: true if it's Windows, False otherwise. @@ -2146,7 +2451,19 @@ function wfIsWindows() { } /** + * Check if we are running under HipHop + * + * @return Bool + */ +function wfIsHipHop() { + return function_exists( 'hphp_thread_set_warmup_enabled' ); +} + +/** * Swap two variables + * + * @param $x Mixed + * @param $y Mixed */ function swap( &$x, &$y ) { $z = $x; @@ -2154,116 +2471,6 @@ function swap( &$x, &$y ) { $y = $z; } -function wfGetCachedNotice( $name ) { - global $wgOut, $wgRenderHashAppend, $parserMemc; - $fname = 'wfGetCachedNotice'; - wfProfileIn( $fname ); - - $needParse = false; - - if( $name === 'default' ) { - // special case - global $wgSiteNotice; - $notice = $wgSiteNotice; - if( empty( $notice ) ) { - wfProfileOut( $fname ); - return false; - } - } else { - $notice = wfMsgForContentNoTrans( $name ); - if( wfEmptyMsg( $name, $notice ) || $notice == '-' ) { - wfProfileOut( $fname ); - return( false ); - } - } - - // Use the extra hash appender to let eg SSL variants separately cache. - $key = wfMemcKey( $name . $wgRenderHashAppend ); - $cachedNotice = $parserMemc->get( $key ); - if( is_array( $cachedNotice ) ) { - if( md5( $notice ) == $cachedNotice['hash'] ) { - $notice = $cachedNotice['html']; - } else { - $needParse = true; - } - } else { - $needParse = true; - } - - if( $needParse ) { - if( is_object( $wgOut ) ) { - $parsed = $wgOut->parse( $notice ); - $parserMemc->set( $key, array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 ); - $notice = $parsed; - } else { - wfDebug( 'wfGetCachedNotice called for ' . $name . ' with no $wgOut available' . "\n" ); - $notice = ''; - } - } - $notice = '<div id="localNotice">' .$notice . '</div>'; - wfProfileOut( $fname ); - return $notice; -} - -function wfGetNamespaceNotice() { - global $wgTitle; - - # Paranoia - if ( !isset( $wgTitle ) || !is_object( $wgTitle ) ) { - return ''; - } - - $fname = 'wfGetNamespaceNotice'; - wfProfileIn( $fname ); - - $key = 'namespacenotice-' . $wgTitle->getNsText(); - $namespaceNotice = wfGetCachedNotice( $key ); - if ( $namespaceNotice && substr( $namespaceNotice, 0, 7 ) != '<p><' ) { - $namespaceNotice = '<div id="namespacebanner">' . $namespaceNotice . '</div>'; - } else { - $namespaceNotice = ''; - } - - wfProfileOut( $fname ); - return $namespaceNotice; -} - -function wfGetSiteNotice() { - global $wgUser; - $fname = 'wfGetSiteNotice'; - wfProfileIn( $fname ); - $siteNotice = ''; - - if( wfRunHooks( 'SiteNoticeBefore', array( &$siteNotice ) ) ) { - if( is_object( $wgUser ) && $wgUser->isLoggedIn() ) { - $siteNotice = wfGetCachedNotice( 'sitenotice' ); - } else { - $anonNotice = wfGetCachedNotice( 'anonnotice' ); - if( !$anonNotice ) { - $siteNotice = wfGetCachedNotice( 'sitenotice' ); - } else { - $siteNotice = $anonNotice; - } - } - if( !$siteNotice ) { - $siteNotice = wfGetCachedNotice( 'default' ); - } - } - - wfRunHooks( 'SiteNoticeAfter', array( &$siteNotice ) ); - wfProfileOut( $fname ); - return $siteNotice; -} - -/** - * BC wrapper for MimeMagic::singleton() - * @deprecated No longer needed as of 1.17 (r68836). - */ -function &wfGetMimeMagic() { - wfDeprecated( __FUNCTION__ ); - return MimeMagic::singleton(); -} - /** * Tries to get the system directory for temporary files. The TMPDIR, TMP, and * TEMP environment variables are then checked in sequence, and if none are set @@ -2329,16 +2536,24 @@ function wfMkdirParents( $dir, $mode = null, $caller = null ) { /** * Increment a statistics counter + * + * @param $key String + * @param $count Int */ -function wfIncrStats( $key ) { +function wfIncrStats( $key, $count = 1 ) { global $wgStatsMethod; + $count = intval( $count ); + if( $wgStatsMethod == 'udp' ) { - global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname; + global $wgUDPProfilerHost, $wgUDPProfilerPort, $wgDBname, $wgAggregateStatsID; static $socket; + + $id = $wgAggregateStatsID !== false ? $wgAggregateStatsID : $wgDBname; + if ( !$socket ) { $socket = socket_create( AF_INET, SOCK_DGRAM, SOL_UDP ); - $statline = "stats/{$wgDBname} - 1 1 1 1 1 -total\n"; + $statline = "stats/{$id} - {$count} 1 1 1 1 -total\n"; socket_sendto( $socket, $statline, @@ -2348,7 +2563,7 @@ function wfIncrStats( $key ) { $wgUDPProfilerPort ); } - $statline = "stats/{$wgDBname} - 1 1 1 1 1 {$key}\n"; + $statline = "stats/{$id} - {$count} 1 1 1 1 {$key}\n"; wfSuppressWarnings(); socket_sendto( $socket, @@ -2362,8 +2577,8 @@ function wfIncrStats( $key ) { } elseif( $wgStatsMethod == 'cache' ) { global $wgMemc; $key = wfMemcKey( 'stats', $key ); - if ( is_null( $wgMemc->incr( $key ) ) ) { - $wgMemc->add( $key, 1 ); + if ( is_null( $wgMemc->incr( $key, $count ) ) ) { + $wgMemc->add( $key, $count ); } } else { // Disabled @@ -2382,87 +2597,35 @@ function wfPercent( $nr, $acc = 2, $round = true ) { } /** - * Encrypt a username/password. - * - * @param $userid Integer: ID of the user - * @param $password String: password of the user - * @return String: hashed password - * @deprecated Use User::crypt() or User::oldCrypt() instead - */ -function wfEncryptPassword( $userid, $password ) { - wfDeprecated(__FUNCTION__); - # Just wrap around User::oldCrypt() - return User::oldCrypt( $password, $userid ); -} - -/** - * Appends to second array if $value differs from that in $default - */ -function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) { - if ( is_null( $changed ) ) { - throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' ); - } - if ( $default[$key] !== $value ) { - $changed[$key] = $value; - } -} - -/** - * Since wfMsg() and co suck, they don't return false if the message key they - * looked up didn't exist but a XHTML string, this function checks for the - * nonexistance of messages by looking at wfMsg() output - * - * @param $key String: the message key looked up - * @return Boolean True if the message *doesn't* exist. - */ -function wfEmptyMsg( $key ) { - global $wgMessageCache; - return $wgMessageCache->get( $key, /*useDB*/true, /*content*/false ) === false; -} - -/** * Find out whether or not a mixed variable exists in a string * * @param $needle String * @param $str String + * @param $insensitive Boolean * @return Boolean */ -function in_string( $needle, $str ) { - return strpos( $str, $needle ) !== false; -} +function in_string( $needle, $str, $insensitive = false ) { + $func = 'strpos'; + if( $insensitive ) $func = 'stripos'; -function wfSpecialList( $page, $details ) { - global $wgContLang; - $details = $details ? ' ' . $wgContLang->getDirMark() . "($details)" : ''; - return $page . $details; + return $func( $str, $needle ) !== false; } /** - * Returns a regular expression of url protocols + * Make a list item, used by various special pages * + * @param $page String Page link + * @param $details String Text between brackets + * @param $oppositedm Boolean Add the direction mark opposite to your + * language, to display text properly * @return String */ -function wfUrlProtocols() { - global $wgUrlProtocols; - - static $retval = null; - if ( !is_null( $retval ) ) { - return $retval; - } - - // Support old-style $wgUrlProtocols strings, for backwards compatibility - // with LocalSettings files from 1.5 - if ( is_array( $wgUrlProtocols ) ) { - $protocols = array(); - foreach ( $wgUrlProtocols as $protocol ) { - $protocols[] = preg_quote( $protocol, '/' ); - } - - $retval = implode( '|', $protocols ); - } else { - $retval = $wgUrlProtocols; - } - return $retval; +function wfSpecialList( $page, $details, $oppositedm = true ) { + global $wgLang; + $dirmark = ( $oppositedm ? $wgLang->getDirMark( true ) : '' ) . + $wgLang->getDirMark(); + $details = $details ? $dirmark . " ($details)" : ''; + return $page . $details; } /** @@ -2503,19 +2666,30 @@ function wfIniGetBool( $setting ) { * * @param $extension String A PHP extension. The file suffix (.so or .dll) * should be omitted + * @param $fileName String Name of the library, if not $extension.suffix * @return Bool - Whether or not the extension is loaded */ -function wfDl( $extension ) { +function wfDl( $extension, $fileName = null ) { if( extension_loaded( $extension ) ) { return true; } - $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' ) + $canDl = false; + $sapi = php_sapi_name(); + if( version_compare( PHP_VERSION, '5.3.0', '<' ) || + $sapi == 'cli' || $sapi == 'cgi' || $sapi == 'embed' ) + { + $canDl = ( function_exists( 'dl' ) && is_callable( 'dl' ) && wfIniGetBool( 'enable_dl' ) && !wfIniGetBool( 'safe_mode' ) ); + } if( $canDl ) { + $fileName = $fileName ? $fileName : $extension; + if( wfIsWindows() ) { + $fileName = 'php_' . $fileName; + } wfSuppressWarnings(); - dl( $extension . '.' . PHP_SHLIB_SUFFIX ); + dl( $fileName . '.' . PHP_SHLIB_SUFFIX ); wfRestoreWarnings(); } return extension_loaded( $extension ); @@ -2744,142 +2918,12 @@ function wfRelativePath( $path, $from ) { } /** - * Backwards array plus for people who haven't bothered to read the PHP manual - * XXX: will not darn your socks for you. - * - * @param $array1 Array - * @param [$array2, [...]] Arrays - * @return Array - */ -function wfArrayMerge( $array1/* ... */ ) { - $args = func_get_args(); - $args = array_reverse( $args, true ); - $out = array(); - foreach ( $args as $arg ) { - $out += $arg; - } - return $out; -} - -/** - * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal - * e.g. - * wfMergeErrorArrays( - * array( array( 'x' ) ), - * array( array( 'x', '2' ) ), - * array( array( 'x' ) ), - * array( array( 'y') ) - * ); - * returns: - * array( - * array( 'x', '2' ), - * array( 'x' ), - * array( 'y' ) - * ) - */ -function wfMergeErrorArrays( /*...*/ ) { - $args = func_get_args(); - $out = array(); - foreach ( $args as $errors ) { - foreach ( $errors as $params ) { - # FIXME: sometimes get nested arrays for $params, - # which leads to E_NOTICEs - $spec = implode( "\t", $params ); - $out[$spec] = $params; - } - } - return array_values( $out ); -} - -/** - * parse_url() work-alike, but non-broken. Differences: - * - * 1) Does not raise warnings on bad URLs (just returns false) - * 2) Handles protocols that don't use :// (e.g., mailto: and news:) correctly - * 3) Adds a "delimiter" element to the array, either '://' or ':' (see (2)) - * - * @param $url String: a URL to parse - * @return Array: bits of the URL in an associative array, per PHP docs - */ -function wfParseUrl( $url ) { - global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php - wfSuppressWarnings(); - $bits = parse_url( $url ); - wfRestoreWarnings(); - if ( !$bits ) { - return false; - } - - // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it - if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) { - $bits['delimiter'] = '://'; - } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) { - $bits['delimiter'] = ':'; - // parse_url detects for news: and mailto: the host part of an url as path - // We have to correct this wrong detection - if ( isset( $bits['path'] ) ) { - $bits['host'] = $bits['path']; - $bits['path'] = ''; - } - } else { - return false; - } - - return $bits; -} - -/** - * Make a URL index, appropriate for the el_index field of externallinks. - */ -function wfMakeUrlIndex( $url ) { - $bits = wfParseUrl( $url ); - - // Reverse the labels in the hostname, convert to lower case - // For emails reverse domainpart only - if ( $bits['scheme'] == 'mailto' ) { - $mailparts = explode( '@', $bits['host'], 2 ); - if ( count( $mailparts ) === 2 ) { - $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) ); - } else { - // No domain specified, don't mangle it - $domainpart = ''; - } - $reversedHost = $domainpart . '@' . $mailparts[0]; - } else { - $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) ); - } - // Add an extra dot to the end - // Why? Is it in wrong place in mailto links? - if ( substr( $reversedHost, -1, 1 ) !== '.' ) { - $reversedHost .= '.'; - } - // Reconstruct the pseudo-URL - $prot = $bits['scheme']; - $index = $prot . $bits['delimiter'] . $reversedHost; - // Leave out user and password. Add the port, path, query and fragment - if ( isset( $bits['port'] ) ) { - $index .= ':' . $bits['port']; - } - if ( isset( $bits['path'] ) ) { - $index .= $bits['path']; - } else { - $index .= '/'; - } - if ( isset( $bits['query'] ) ) { - $index .= '?' . $bits['query']; - } - if ( isset( $bits['fragment'] ) ) { - $index .= '#' . $bits['fragment']; - } - return $index; -} - -/** * Do any deferred updates and clear the list * - * @param $commit Boolean: commit after every update to prevent lock contention + * @param $commit String: set to 'commit' to commit after every update to + * prevent lock contention */ -function wfDoUpdates( $commit = false ) { +function wfDoUpdates( $commit = '' ) { global $wgDeferredUpdateList; wfProfileIn( __METHOD__ ); @@ -2890,14 +2934,15 @@ function wfDoUpdates( $commit = false ) { return; } - if ( $commit ) { + $doCommit = $commit == 'commit'; + if ( $doCommit ) { $dbw = wfGetDB( DB_MASTER ); } foreach ( $wgDeferredUpdateList as $update ) { $update->doUpdate(); - if ( $commit && $dbw->trxLevel() ) { + if ( $doCommit && $dbw->trxLevel() ) { $dbw->commit(); } } @@ -2941,7 +2986,7 @@ function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = t // Decode and validate input string $input = strtolower( $input ); for( $i = 0; $i < strlen( $input ); $i++ ) { - $n = strpos( $digitChars, $input{$i} ); + $n = strpos( $digitChars, $input[$i] ); if( $n === false || $n > $sourceBase ) { return false; } @@ -2995,36 +3040,18 @@ function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = t /** * Create an object with a given name and an array of construct parameters + * * @param $name String * @param $p Array: parameters + * @deprecated since 1.18, warnings in 1.18, removal in 1.20 */ function wfCreateObject( $name, $p ) { - $p = array_values( $p ); - switch ( count( $p ) ) { - case 0: - return new $name; - case 1: - return new $name( $p[0] ); - case 2: - return new $name( $p[0], $p[1] ); - case 3: - return new $name( $p[0], $p[1], $p[2] ); - case 4: - return new $name( $p[0], $p[1], $p[2], $p[3] ); - case 5: - return new $name( $p[0], $p[1], $p[2], $p[3], $p[4] ); - case 6: - return new $name( $p[0], $p[1], $p[2], $p[3], $p[4], $p[5] ); - default: - throw new MWException( 'Too many arguments to construtor in wfCreateObject' ); - } + wfDeprecated( __FUNCTION__ ); + return MWFunction::newObj( $name, $p ); } function wfHttpOnlySafe() { global $wgHttpOnlyBlacklist; - if( !version_compare( '5.2', PHP_VERSION, '<' ) ) { - return false; - } if( isset( $_SERVER['HTTP_USER_AGENT'] ) ) { foreach( $wgHttpOnlyBlacklist as $regex ) { @@ -3039,18 +3066,31 @@ function wfHttpOnlySafe() { /** * Initialise php session + * + * @param $sessionId Bool */ function wfSetupSession( $sessionId = false ) { global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly, $wgSessionHandler; if( $wgSessionsInMemcached ) { - require_once( 'MemcachedSessions.php' ); + if ( !defined( 'MW_COMPILED' ) ) { + global $IP; + require_once( "$IP/includes/cache/MemcachedSessions.php" ); + } + session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read', + 'memsess_write', 'memsess_destroy', 'memsess_gc' ); + + // It's necessary to register a shutdown function to call session_write_close(), + // because by the time the request shutdown function for the session module is + // called, $wgMemc has already been destroyed. Shutdown functions registered + // this way are called before object destruction. + register_shutdown_function( 'memsess_write_close' ); } elseif( $wgSessionHandler && $wgSessionHandler != ini_get( 'session.save_handler' ) ) { # Only set this if $wgSessionHandler isn't null and session.save_handler # hasn't already been set to the desired value (that causes errors) ini_set( 'session.save_handler', $wgSessionHandler ); } - $httpOnlySafe = wfHttpOnlySafe(); + $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly; wfDebugLog( 'cookie', 'session_set_cookie_params: "' . implode( '", "', array( @@ -3058,13 +3098,8 @@ function wfSetupSession( $sessionId = false ) { $wgCookiePath, $wgCookieDomain, $wgCookieSecure, - $httpOnlySafe && $wgCookieHttpOnly ) ) . '"' ); - if( $httpOnlySafe && $wgCookieHttpOnly ) { - session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookieHttpOnly ); - } else { - // PHP 5.1 throws warnings if you pass the HttpOnly parameter for 5.2. - session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure ); - } + $httpOnlySafe ) ) . '"' ); + session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $httpOnlySafe ); session_cache_limiter( 'private, must-revalidate' ); if ( $sessionId ) { session_id( $sessionId ); @@ -3077,6 +3112,7 @@ function wfSetupSession( $sessionId = false ) { /** * Get an object from the precompiled serialized directory * + * @param $name String * @return Mixed: the variable on success, false on failure */ function wfGetPrecompiledData( $name ) { @@ -3092,43 +3128,11 @@ function wfGetPrecompiledData( $name ) { return false; } -function wfGetCaller( $level = 2 ) { - $backtrace = wfDebugBacktrace(); - if ( isset( $backtrace[$level] ) ) { - return wfFormatStackFrame( $backtrace[$level] ); - } else { - $caller = 'unknown'; - } - return $caller; -} - -/** - * Return a string consisting of callers in the stack. Useful sometimes - * for profiling specific points. - * - * @param $limit The maximum depth of the stack frame to return, or false for - * the entire stack. - */ -function wfGetAllCallers( $limit = 3 ) { - $trace = array_reverse( wfDebugBacktrace() ); - if ( !$limit || $limit > count( $trace ) - 1 ) { - $limit = count( $trace ) - 1; - } - $trace = array_slice( $trace, -$limit - 1, $limit ); - return implode( '/', array_map( 'wfFormatStackFrame', $trace ) ); -} - -/** - * Return a string representation of frame - */ -function wfFormatStackFrame( $frame ) { - return isset( $frame['class'] ) ? - $frame['class'] . '::' . $frame['function'] : - $frame['function']; -} - /** * Get a cache key + * + * @param varargs + * @return String */ function wfMemcKey( /*... */ ) { $args = func_get_args(); @@ -3139,6 +3143,11 @@ function wfMemcKey( /*... */ ) { /** * Get a cache key for a foreign DB + * + * @param $db String + * @param $prefix String + * @param varargs String + * @return String */ function wfForeignMemcKey( $db, $prefix /*, ... */ ) { $args = array_slice( func_get_args(), 2 ); @@ -3153,6 +3162,8 @@ function wfForeignMemcKey( $db, $prefix /*, ... */ ) { /** * Get an ASCII string identifying this wiki * This is used as a prefix in memcached keys + * + * @return String */ function wfWikiID() { global $wgDBprefix, $wgDBname; @@ -3165,6 +3176,9 @@ function wfWikiID() { /** * Split a wiki ID into DB name and table prefix + * + * @param $wiki String + * @param $bits String */ function wfSplitWikiID( $wiki ) { $bits = explode( '-', $wiki, 2 ); @@ -3176,6 +3190,7 @@ function wfSplitWikiID( $wiki ) { /** * Get a Database object. + * * @param $db Integer: index of the connection to get. May be DB_MASTER for the * master (for write queries), DB_SLAVE for potentially lagged read * queries, or an integer >= 0 for a particular server. @@ -3190,6 +3205,9 @@ function wfSplitWikiID( $wiki ) { * will always return the same object, unless the underlying connection or load * balancer is manually destroyed. * + * Note 2: use $this->getDB() in maintenance scripts that may be invoked by + * updater to ensure that a proper database is being updated. + * * @return DatabaseBase */ function &wfGetDB( $db, $groups = array(), $wiki = false ) { @@ -3208,6 +3226,8 @@ function wfGetLB( $wiki = false ) { /** * Get the load balancer factory object + * + * @return LBFactory */ function &wfGetLBFactory() { return LBFactory::singleton(); @@ -3216,6 +3236,7 @@ function &wfGetLBFactory() { /** * Find a file. * Shortcut for RepoGroup::singleton()->findFile() + * * @param $title String or Title object * @param $options Associative array of options: * time: requested time for an archived image, or false for the @@ -3239,6 +3260,7 @@ function wfFindFile( $title, $options = array() ) { /** * Get an object referring to a locally registered file. * Returns a valid placeholder object if the file does not exist. + * * @param $title Title or String * @return File, or null if passed an invalid Title */ @@ -3250,6 +3272,7 @@ function wfLocalFile( $title ) { * Should low-performance queries be disabled? * * @return Boolean + * @codeCoverageIgnore */ function wfQueriesMustScale() { global $wgMiserMode; @@ -3307,14 +3330,16 @@ function wfBoolToStr( $value ) { /** * Load an extension messages file - * @deprecated in 1.16 (warnings in 1.18, removed in ?) + * + * @deprecated since 1.16, warnings in 1.18, remove in 1.20 + * @codeCoverageIgnore */ -function wfLoadExtensionMessages( $extensionName, $langcode = false ) { +function wfLoadExtensionMessages() { + wfDeprecated( __FUNCTION__ ); } /** - * Get a platform-independent path to the null file, e.g. - * /dev/null + * Get a platform-independent path to the null file, e.g. /dev/null * * @return string */ @@ -3325,27 +3350,8 @@ function wfGetNull() { } /** - * Displays a maxlag error - * - * @param $host String: server that lags the most - * @param $lag Integer: maxlag (actual) - * @param $maxLag Integer: maxlag (requested) - */ -function wfMaxlagError( $host, $lag, $maxLag ) { - global $wgShowHostnames; - header( 'HTTP/1.1 503 Service Unavailable' ); - header( 'Retry-After: ' . max( intval( $maxLag ), 5 ) ); - header( 'X-Database-Lag: ' . intval( $lag ) ); - header( 'Content-Type: text/plain' ); - if( $wgShowHostnames ) { - echo "Waiting for $host: $lag seconds lagged\n"; - } else { - echo "Waiting for a database server: $lag seconds lagged\n"; - } -} - -/** * Throws a warning that $function is deprecated + * * @param $function String * @return null */ @@ -3362,32 +3368,33 @@ function wfDeprecated( $function ) { * $wgDevelopmentWarnings * * @param $msg String: message to send - * @param $callerOffset Integer: number of itmes to go back in the backtrace to + * @param $callerOffset Integer: number of items to go back in the backtrace to * find the correct caller (1 = function calling wfWarn, ...) * @param $level Integer: PHP error level; only used when $wgDevelopmentWarnings * is true */ function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) { + global $wgDevelopmentWarnings; + $callers = wfDebugBacktrace(); - if( isset( $callers[$callerOffset + 1] ) ){ + if ( isset( $callers[$callerOffset + 1] ) ) { $callerfunc = $callers[$callerOffset + 1]; $callerfile = $callers[$callerOffset]; - if( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) { + if ( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) { $file = $callerfile['file'] . ' at line ' . $callerfile['line']; } else { $file = '(internal function)'; } $func = ''; - if( isset( $callerfunc['class'] ) ) { + if ( isset( $callerfunc['class'] ) ) { $func .= $callerfunc['class'] . '::'; } - if( isset( $callerfunc['function'] ) ) { + if ( isset( $callerfunc['function'] ) ) { $func .= $callerfunc['function']; } $msg .= " [Called from $func in $file]"; } - global $wgDevelopmentWarnings; if ( $wgDevelopmentWarnings ) { trigger_error( $msg, $level ); } else { @@ -3396,44 +3403,35 @@ function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) { } /** - * Sleep until the worst slave's replication lag is less than or equal to - * $maxLag, in seconds. Use this when updating very large numbers of rows, as + * Modern version of wfWaitForSlaves(). Instead of looking at replication lag + * and waiting for it to go down, this waits for the slaves to catch up to the + * master position. Use this when updating very large numbers of rows, as * in maintenance scripts, to avoid causing too much lag. Of course, this is * a no-op if there are no slaves. * - * Every time the function has to wait for a slave, it will print a message to - * that effect (and then sleep for a little while), so it's probably not best - * to use this outside maintenance scripts in its present form. - * - * @param $maxLag Integer + * @param $maxLag Integer (deprecated) * @param $wiki mixed Wiki identifier accepted by wfGetLB * @return null */ -function wfWaitForSlaves( $maxLag, $wiki = false ) { - if( $maxLag ) { - $lb = wfGetLB( $wiki ); - list( $host, $lag ) = $lb->getMaxLag( $wiki ); - while( $lag > $maxLag ) { - wfSuppressWarnings(); - $name = gethostbyaddr( $host ); - wfRestoreWarnings(); - if( $name !== false ) { - $host = $name; - } - print "Waiting for $host (lagged $lag seconds)...\n"; - sleep( $maxLag ); - list( $host, $lag ) = $lb->getMaxLag(); - } +function wfWaitForSlaves( $maxLag = false, $wiki = false ) { + $lb = wfGetLB( $wiki ); + // bug 27975 - Don't try to wait for slaves if there are none + // Prevents permission error when getting master position + if ( $lb->getServerCount() > 1 ) { + $dbw = $lb->getConnection( DB_MASTER ); + $pos = $dbw->getMasterPos(); + $lb->waitForAll( $pos ); } } /** * Used to be used for outputting text in the installer/updater - * @deprecated Warnings in 1.19, removal in 1.20 + * @deprecated since 1.18, warnings in 1.18, remove in 1.20 */ function wfOut( $s ) { + wfDeprecated( __METHOD__ ); global $wgCommandLineMode; - if ( $wgCommandLineMode && !defined( 'MEDIAWIKI_INSTALL' ) ) { + if ( $wgCommandLineMode ) { echo $s; } else { echo htmlspecialchars( $s ); @@ -3444,6 +3442,7 @@ function wfOut( $s ) { /** * Count down from $n to zero on the terminal, with a one-second pause * between showing each number. For use in command-line scripts. + * @codeCoverageIgnore */ function wfCountDown( $n ) { for ( $i = $n; $i >= 0; $i-- ) { @@ -3463,6 +3462,8 @@ function wfCountDown( $n ) { * Generate a random 32-character hexadecimal token. * @param $salt Mixed: some sort of salt, if necessary, to add to random * characters before hashing. + * @return string + * @codeCoverageIgnore */ function wfGenerateToken( $salt = '' ) { $salt = serialize( $salt ); @@ -3471,7 +3472,9 @@ function wfGenerateToken( $salt = '' ) { /** * Replace all invalid characters with - + * * @param $name Mixed: filename to process + * @return String */ function wfStripIllegalFilenameChars( $name ) { global $wgIllegalFileChars; @@ -3487,46 +3490,8 @@ function wfStripIllegalFilenameChars( $name ) { } /** - * Insert array into another array after the specified *KEY* - * @param $array Array: The array. - * @param $insert Array: The array to insert. - * @param $after Mixed: The key to insert after - */ -function wfArrayInsertAfter( $array, $insert, $after ) { - // Find the offset of the element to insert after. - $keys = array_keys( $array ); - $offsetByKey = array_flip( $keys ); - - $offset = $offsetByKey[$after]; - - // Insert at the specified offset - $before = array_slice( $array, 0, $offset + 1, true ); - $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true ); - - $output = $before + $insert + $after; - - return $output; -} - -/* Recursively converts the parameter (an object) to an array with the same data */ -function wfObjectToArray( $objOrArray, $recursive = true ) { - $array = array(); - if( is_object( $objOrArray ) ) { - $objOrArray = get_object_vars( $objOrArray ); - } - foreach ( $objOrArray as $key => $value ) { - if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) { - $value = wfObjectToArray( $value ); - } - - $array[$key] = $value; - } - - return $array; -} - -/** * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit; + * * @return Integer value memory was set to. */ function wfMemoryLimit() { @@ -3553,6 +3518,7 @@ function wfMemoryLimit() { /** * Converts shorthand byte notation to integer form + * * @param $string String * @return Integer */ @@ -3582,19 +3548,25 @@ function wfShorthandToInteger( $string = '' ) { /** * Get the normalised IETF language tag + * See unit test for examples. + * * @param $code String: The language code. * @return $langCode String: The language code which complying with BCP 47 standards. */ function wfBCP47( $code ) { $codeSegment = explode( '-', $code ); + $codeBCP = array(); foreach ( $codeSegment as $segNo => $seg ) { if ( count( $codeSegment ) > 0 ) { + // when previous segment is x, it is a private segment and should be lc + if( $segNo > 0 && strtolower( $codeSegment[($segNo - 1)] ) == 'x') { + $codeBCP[$segNo] = strtolower( $seg ); // ISO 3166 country code - if ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) { + } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) { $codeBCP[$segNo] = strtoupper( $seg ); // ISO 15924 script code } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) { - $codeBCP[$segNo] = ucfirst( $seg ); + $codeBCP[$segNo] = ucfirst( strtolower( $seg ) ); // Use lowercase for other cases } else { $codeBCP[$segNo] = strtolower( $seg ); @@ -3608,13 +3580,89 @@ function wfBCP47( $code ) { return $langCode; } -function wfArrayMap( $function, $input ) { - $ret = array_map( $function, $input ); - foreach ( $ret as $key => $value ) { - $taint = istainted( $input[$key] ); - if ( $taint ) { - taint( $ret[$key], $taint ); +/** + * Get a cache object. + * + * @param $inputType integer Cache type, one the the CACHE_* constants. + * @return BagOStuff + */ +function wfGetCache( $inputType ) { + return ObjectCache::getInstance( $inputType ); +} + +/** + * Get the main cache object + * + * @return BagOStuff + */ +function wfGetMainCache() { + global $wgMainCacheType; + return ObjectCache::getInstance( $wgMainCacheType ); +} + +/** + * Get the cache object used by the message cache + * + * @return BagOStuff + */ +function wfGetMessageCacheStorage() { + global $wgMessageCacheType; + return ObjectCache::getInstance( $wgMessageCacheType ); +} + +/** + * Get the cache object used by the parser cache + * + * @return BagOStuff + */ +function wfGetParserCacheStorage() { + global $wgParserCacheType; + return ObjectCache::getInstance( $wgParserCacheType ); +} + +/** + * Call hook functions defined in $wgHooks + * + * @param $event String: event name + * @param $args Array: parameters passed to hook functions + * @return Boolean + */ +function wfRunHooks( $event, $args = array() ) { + return Hooks::run( $event, $args ); +} + +/** + * Wrapper around php's unpack. + * + * @param $format String: The format string (See php's docs) + * @param $data: A binary string of binary data + * @param $length integer or false: The minimun length of $data. This is to + * prevent reading beyond the end of $data. false to disable the check. + * + * Also be careful when using this function to read unsigned 32 bit integer + * because php might make it negative. + * + * @throws MWException if $data not long enough, or if unpack fails + * @return Associative array of the extracted data + */ +function wfUnpack( $format, $data, $length=false ) { + if ( $length !== false ) { + $realLen = strlen( $data ); + if ( $realLen < $length ) { + throw new MWException( "Tried to use wfUnpack on a " + . "string of length $realLen, but needed one " + . "of at least length $length." + ); } } - return $ret; + + wfSuppressWarnings(); + $result = unpack( $format, $data ); + wfRestoreWarnings(); + + if ( $result === false ) { + // If it cannot extract the packed data. + throw new MWException( "unpack could not unpack binary data" ); + } + return $result; } |