X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=includes%2FGlobalFunctions.php;h=017b842d414b8def8a18a0d84c609458612b97c5;hb=41ac01dfc839b4f1c32a354fe37ed064b8a31585;hp=a6c4f9f7fd1a93126945621be7707af239386805;hpb=c79a16167adc5a6f29aebd44628fdf37c0dede1a;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index a6c4f9f7fd..017b842d41 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -50,7 +50,7 @@ if( !function_exists( 'mb_strpos' ) ) { function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) { return Fallback::mb_strpos( $haystack, $needle, $offset, $encoding ); } - + } if( !function_exists( 'mb_strrpos' ) ) { @@ -85,6 +85,12 @@ if ( !function_exists( 'istainted' ) ) { 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 ); @@ -288,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 ) ) { @@ -305,6 +316,355 @@ function wfUrlencode( $s ) { return $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 + * + * @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; + $serverUrl = $defaultProto === PROTO_CANONICAL ? $wgCanonicalServer : $wgServer; + + if ( $defaultProto === PROTO_CURRENT ) { + $defaultProto = WebRequest::detectProtocol() . '://'; + } + + // Analyze $serverUrl to obtain its protocol + $bits = wfParseUrl( $serverUrl ); + $serverHasProto = $bits && $bits['scheme'] != ''; + + if ( $defaultProto === PROTO_CANONICAL ) { + if ( $serverHasProto ) { + $defaultProto = $bits['scheme'] . '://'; + } else { + // $wgCanonicalServer 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(); + // parse_url() returns an array without scheme for some invalid URLs, e.g. + // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' ) + if ( !$bits || !isset( $bits['scheme'] ) ) { + 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 a URL index, appropriate for the el_index field of externallinks. + * + * @param $url String + * @return String + */ +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; +} + +/** + * 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. @@ -325,8 +685,7 @@ function wfDebug( $text, $logonly = false ) { 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; } @@ -339,18 +698,42 @@ function wfDebug( $text, $logonly = false ) { $cache = array(); } } - 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 ); + 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 ); + } } } +/** + * Returns true if debug logging should be suppressed if $wgDebugRawPage = false + */ +function wfIsDebugRawPage() { + static $cache; + if ( $cache !== null ) { + return $cache; + } + # 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() { @@ -405,7 +788,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 ); } @@ -513,7 +898,7 @@ function wfLogProfilingData() { $profiler->logData(); // Check whether this should be logged in the debug file. - if ( $wgDebugLogFile == '' || ( $wgRequest->getVal( 'action' ) == 'raw' && !$wgDebugRawPage ) ) { + if ( $wgDebugLogFile == '' || ( !$wgDebugRawPage && wfIsDebugRawPage() ) ) { return; } @@ -621,17 +1006,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; } /** @@ -674,15 +1057,18 @@ function wfMessageFallback( /*...*/ ) { * @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 ); } /** @@ -752,38 +1138,6 @@ function wfMsgForContentNoTrans( $key ) { return wfMsgReal( $key, $args, true, $forcontent, false ); } -/** - * Get a message from the language file, for the UI elements - * - * @deprecated since 1.18; use wfMessage() - */ -function wfMsgNoDB( $key ) { - wfDeprecated( __FUNCTION__ ); - $args = func_get_args(); - array_shift( $args ); - return wfMsgReal( $key, $args, false ); -} - -/** - * Get a message from the language file, for the content - * - * @deprecated since 1.18; use wfMessage() - */ -function wfMsgNoDBForContent( $key ) { - wfDeprecated( __FUNCTION__ ); - 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 * @@ -802,22 +1156,6 @@ function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform return $message; } -/** - * This function provides the message source for messages to be edited which are *not* stored in the database. - * - * @deprecated since 1.18; use wfMessage() - * @param $key String - */ -function wfMsgWeirdKey( $key ) { - wfDeprecated( __FUNCTION__ ); - $source = wfMsgGetKey( $key, false, true, false ); - if ( wfEmptyMsg( $key ) ) { - return ''; - } else { - return $source; - } -} - /** * Fetch a message string value, but don't replace any keys yet. * @@ -828,7 +1166,7 @@ function wfMsgWeirdKey( $key ) { * @param $transform Boolean: whether to parse magic words, etc. * @return string */ -function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) { +function wfMsgGetKey( $key, $useDB = true, $langCode = false, $transform = true ) { wfRunHooks( 'NormalizeMessageKey', array( &$key, &$useDB, &$langCode, &$transform ) ); $cache = MessageCache::singleton(); @@ -883,7 +1221,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 ); } /** @@ -901,7 +1239,8 @@ function wfMsgWikiHtml( $key ) { $args = func_get_args(); array_shift( $args ); return wfMsgReplaceArgs( - MessageCache::singleton()->parse( wfMsgGetKey( $key, true ), null, /* can't be set to false */ true )->getText(), + MessageCache::singleton()->parse( wfMsgGetKey( $key ), null, + /* can't be set to false */ true, /* interface */ true )->getText(), $args ); } @@ -1001,24 +1340,6 @@ function wfEmptyMsg( $key ) { return MessageCache::singleton()->get( $key, /*useDB*/true, /*content*/false ) === false; } -/** - * Print an error message and die, returning nonzero to the shell if any. Plain die() - * fails to return nonzero to the shell if you pass a string. Entry points may customise - * this function to return a prettier error message, but implementations must not assume - * access to any of the usual MediaWiki infrastructure (AutoLoader, localisation, database, - * etc). This should not be called directly once $wgFullyInitialised is set; instead, - * throw an exception and let Exception.php handle whether or not it's possible to show - * a prettier error. - * - * @param $msg String - */ -if( !function_exists( 'wfDie' ) ){ - function wfDie( $msg = '' ) { - echo $msg; - die( 1 ); - } -} - /** * Throw a debugging exception. This function previously once exited the process, * but now throws an exception instead, with similar results. @@ -1033,7 +1354,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() { @@ -1041,7 +1362,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; } @@ -1086,9 +1407,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' ) ) { @@ -1110,7 +1433,11 @@ 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 ); + } } /** @@ -1145,7 +1472,7 @@ function wfBacktrace() { $msg .= '
  • ' . $file . ' line ' . $line . ' calls '; } if( !empty( $call['class'] ) ) { - $msg .= $call['class'] . '::'; + $msg .= $call['class'] . $call['type']; } $msg .= $call['function'] . '()'; @@ -1164,43 +1491,69 @@ function wfBacktrace() { return $msg; } - -/* Some generic result counters, pulled out of SearchEngine */ - +/** + * 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; +} /** - * @todo document + * Return a string consisting of callers in the stack. Useful sometimes + * for profiling specific points. * - * @param $offset Int - * @param $limit Int + * @param $limit The maximum depth of the stack frame to return, or false for + * the entire stack. * @return String */ -function wfShowingResults( $offset, $limit ) { - global $wgLang; - return wfMsgExt( - 'showingresults', - array( 'parseinline' ), - $wgLang->formatNum( $limit ), - $wgLang->formatNum( $offset + 1 ) - ); +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 - * @param $num Int * @return String */ -function wfShowingResultsNum( $offset, $limit, $num ) { +function wfShowingResults( $offset, $limit ) { global $wgLang; return wfMsgExt( - 'showingresultsnum', + 'showingresults', array( 'parseinline' ), $wgLang->formatNum( $limit ), - $wgLang->formatNum( $offset + 1 ), - $wgLang->formatNum( $num ) + $wgLang->formatNum( $offset + 1 ) ); } @@ -1339,179 +1692,66 @@ 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, is not used. - * - * @param $text String: text to be escaped - * @return String - */ -function wfEscapeWikiText( $text ) { - $text = strtr( "\n$text", array( - '"' => '"', '&' => '&', "'" => ''', '<' => '<', - '=' => '=', '>' => '>', '[' => '[', ']' => ']', - '{' => '{', '|' => '|', '}' => '}', - "\n#" => "\n#", "\n*" => "\n*", - "\n:" => "\n:", "\n;" => "\n;", - '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ', - ) ); - return substr( $text, 1 ); -} - -/** - * Get the current unix timetstamp with microseconds. Useful for profiling - * @return Float - */ -function wfTime() { - return microtime( true ); -} - -/** - * 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; - if ( !is_null( $source ) || $force ) { - $dest = $source; - } - return $temp; -} - -/** - * 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 ); - if ( !is_null( $state ) ) { - if ( $state ) { - $dest |= $bit; - } else { - $dest &= ~$bit; - } - } - return $temp; -} - -/** - * 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 ) - * @return String - */ -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; + * As required by the callers, is not used. + * + * @param $text String: text to be escaped + * @return String + */ +function wfEscapeWikiText( $text ) { + $text = strtr( "\n$text", array( + '"' => '"', '&' => '&', "'" => ''', '<' => '<', + '=' => '=', '>' => '>', '[' => '[', ']' => ']', + '{' => '{', '|' => '|', '}' => '}', + "\n#" => "\n#", "\n*" => "\n*", + "\n:" => "\n:", "\n;" => "\n;", + '://' => '://', 'ISBN ' => 'ISBN ', 'RFC ' => 'RFC ', + ) ); + return substr( $text, 1 ); } /** - * 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 + * Get the current unix timetstamp with microseconds. Useful for profiling + * @return Float */ -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; +function wfTime() { + return microtime( true ); } /** - * 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. + * 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 $url String - * @param $query Mixed: string or associative array - * @return string + * @param $dest Mixed + * @param $source Mixed + * @param $force Bool + * @return Mixed */ -function wfAppendQuery( $url, $query ) { - if ( is_array( $query ) ) { - $query = wfArrayToCGI( $query ); - } - if( $query != '' ) { - if( false === strpos( $url, '?' ) ) { - $url .= '?'; - } else { - $url .= '&'; - } - $url .= $query; +function wfSetVar( &$dest, $source, $force = false ) { + $temp = $dest; + if ( !is_null( $source ) || $force ) { + $dest = $source; } - return $url; + return $temp; } /** - * 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. + * As for wfSetVar except setting a bit * - * @param $url String: either fully-qualified or a local path + query - * @return string Fully-qualified URL + * @param $dest Int + * @param $bit Int + * @param $state Bool */ -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; +function wfSetBit( &$dest, $bit, $state = true ) { + $temp = (bool)( $dest & $bit ); + if ( !is_null( $state ) ) { + if ( $state ) { + $dest |= $bit; + } else { + $dest &= ~$bit; + } } + return $temp; } /** @@ -1734,7 +1974,7 @@ function wfDiff( $before, $after, $params = '-u' ) { function wfVarDump( $var ) { global $wgOut; $s = str_replace( "\n", "
    \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 ); @@ -1857,12 +2097,12 @@ function wfAcceptToPrefs( $accept, $def = '*/*' ) { foreach( $parts as $part ) { # @todo FIXME: Doesn't deal with params like 'text/html; level=1' - @list( $value, $qpart ) = explode( ';', trim( $part ) ); + $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] ); } } @@ -2098,8 +2338,6 @@ function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) { return false; } - - static $formats = array( TS_UNIX => 'U', TS_MW => 'YmdHis', @@ -2360,42 +2598,25 @@ function wfPercent( $nr, $acc = 2, $round = true ) { function in_string( $needle, $str, $insensitive = false ) { $func = 'strpos'; if( $insensitive ) $func = 'stripos'; - - return $func( $str, $needle ) !== false; -} -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; } /** @@ -2687,103 +2908,6 @@ function wfRelativePath( $path, $from ) { return implode( DIRECTORY_SEPARATOR, $pieces ); } -/** - * 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. - * - * @param $url String - * @return String - */ -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 if ( isset( $bits['host'] ) ) { - $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) ); - } else { - // In file: URIs for instance it's common to have an empty host, - // which turns up as not getting a 'host' member from parse_url. - $reversedHost = '.'; - } - // 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'] ) ) { - // parse_url() removes the initial '/' from the path - // for file: URLs with Windows-style paths, such as - // file:///c:/windows/stuff. We need to add it back - // to keep our division between host and path properly. - if ( strlen( $bits['path'] ) > 0 && substr( $bits['path'], 0, 1 ) !== '/' ) { - $index .= '/'; - } - $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 * @@ -2910,7 +3034,7 @@ function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1, $lowercase = t * * @param $name String * @param $p Array: parameters - * @deprecated since 1.18, warnings in 1.19, removal in 1.20 + * @deprecated since 1.18, warnings in 1.18, removal in 1.20 */ function wfCreateObject( $name, $p ) { wfDeprecated( __FUNCTION__ ); @@ -2944,11 +3068,11 @@ function wfSetupSession( $sessionId = false ) { global $IP; require_once( "$IP/includes/cache/MemcachedSessions.php" ); } - session_set_save_handler( 'memsess_open', 'memsess_close', 'memsess_read', + 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 + // 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' ); @@ -2995,51 +3119,6 @@ function wfGetPrecompiledData( $name ) { return false; } -/** - * Get the name of the function which called this function - * - * @param $level Int - * @return Bool|string - */ -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. - * @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']; -} - /** * Get a cache key * @@ -3180,6 +3259,14 @@ function wfLocalFile( $title ) { return RepoGroup::singleton()->getLocalRepo()->newFile( $title ); } +/** + * Stream a file to the browser. Back-compat alias for StreamFile::stream() + * @deprecated since 1.19 + */ +function wfStreamFile( $fname, $headers = array() ) { + StreamFile::stream( $fname, $headers ); +} + /** * Should low-performance queries be disabled? * @@ -3320,7 +3407,7 @@ function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) { * 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. - * + * * @param $maxLag Integer (deprecated) * @param $wiki mixed Wiki identifier accepted by wfGetLB * @return null @@ -3338,12 +3425,12 @@ function wfWaitForSlaves( $maxLag = false, $wiki = false ) { /** * Used to be used for outputting text in the installer/updater - * @deprecated since 1.18, warnings in 1.19, remove 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 ); @@ -3470,7 +3557,7 @@ function wfBCP47( $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 + // 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 @@ -3495,7 +3582,7 @@ function wfBCP47( $code ) { /** * Get a cache object. * - * @param integer $inputType Cache type, one the the CACHE_* constants. + * @param $inputType integer Cache type, one the the CACHE_* constants. * @return BagOStuff */ function wfGetCache( $inputType ) { @@ -3532,3 +3619,13 @@ function wfGetParserCacheStorage() { 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 ); +}