X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FGlobalFunctions.php;h=005fb8e0fef6410a3b5e584d772b941ca40c5b8e;hb=74a21f3bd1692dac958ddf3e09226a72b7bc65b7;hp=bf93bbbbfb462d9a290e98e9f25d2abaf0919ac4;hpb=450585db889743803632e821024cbc4a0ab98de0;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index bf93bbbbfb..005fb8e0fe 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -9,7 +9,6 @@ if ( !defined( 'MEDIAWIKI' ) ) { */ require_once dirname(__FILE__) . '/normal/UtfNormalUtil.php'; -require_once dirname(__FILE__) . '/XmlFunctions.php'; // Hide compatibility functions from Doxygen /// @cond @@ -33,18 +32,71 @@ if( !function_exists('iconv') ) { } } -# UTF-8 substr function based on a PHP manual comment if ( !function_exists( 'mb_substr' ) ) { - function mb_substr( $str, $start ) { - $ar = array(); - preg_match_all( '/./us', $str, $ar ); - - if( func_num_args() >= 3 ) { - $end = func_get_arg( 2 ); - return join( '', array_slice( $ar[0], $start, $end ) ); + /** + * 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. + */ + 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; + } + + 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 { - return join( '', array_slice( $ar[0], $start ) ); + $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; } } @@ -76,10 +128,10 @@ if ( !function_exists( 'mb_strlen' ) ) { if( !function_exists( 'mb_strpos' ) ) { /** * Fallback implementation of mb_strpos, hardcoded to UTF-8. - * @param string $haystack - * @param string $needle - * @param string $offset optional start position - * @param string $encoding optional encoding; ignored + * @param $haystack String + * @param $needle String + * @param $offset String: optional start position + * @param $encoding String: optional encoding; ignored * @return int */ function mb_strpos( $haystack, $needle, $offset = 0, $encoding="" ) { @@ -99,10 +151,10 @@ if( !function_exists( 'mb_strpos' ) ) { if( !function_exists( 'mb_strrpos' ) ) { /** * Fallback implementation of mb_strrpos, hardcoded to UTF-8. - * @param string $haystack - * @param string $needle - * @param string $offset optional start position - * @param string $encoding optional encoding; ignored + * @param $haystack String + * @param $needle String + * @param $offset String: optional start position + * @param $encoding String: optional encoding; ignored * @return int */ function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = "" ) { @@ -120,23 +172,6 @@ if( !function_exists( 'mb_strrpos' ) ) { } } -if ( !function_exists( 'array_diff_key' ) ) { - /** - * Exists in PHP 5.1.0+ - * Not quite compatible, two-argument version only - * Null values will cause problems due to this use of isset() - */ - function array_diff_key( $left, $right ) { - $result = $left; - foreach ( $left as $key => $unused ) { - if ( isset( $right[$key] ) ) { - unset( $result[$key] ); - } - } - return $result; - } -} - // Support for Wietse Venema's taint feature if ( !function_exists( 'istainted' ) ) { function istainted( $var ) { @@ -177,15 +212,6 @@ function wfArrayDiff2_cmp( $a, $b ) { } } -/** - * Wrapper for clone(), for compatibility with PHP4-friendly extensions. - * PHP 5 won't let you declare a 'clone' function, even conditionally, - * so it has to be a wrapper with a different name. - */ -function wfClone( $object ) { - return clone( $object ); -} - /** * Seed Mersenne Twister * No-op for compatibility; only necessary in PHP < 4.2.0 @@ -224,16 +250,27 @@ function wfRandom() { * * ;:@$!*(),/ * + * However, IIS7 redirects fail when the url contains a colon (Bug 22709), + * so no fancy : for IIS7. + * * %2F in the page titles seems to fatally break for some reason. * * @param $s String: * @return string */ function wfUrlencode( $s ) { + static $needle; + 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)) { + $needle[] = '%3A'; + } + } + $s = urlencode( $s ); $s = str_ireplace( - array( '%3B','%3A','%40','%24','%21','%2A','%28','%29','%2C','%2F' ), - array( ';', ':', '@', '$', '!', '*', '(', ')', ',', '/' ), + $needle, + array( ';', '@', '$', '!', '*', '(', ')', ',', '/', ':' ), $s ); @@ -255,17 +292,18 @@ function wfUrlencode( $s ) { */ function wfDebug( $text, $logonly = false ) { global $wgOut, $wgDebugLogFile, $wgDebugComments, $wgProfileOnly, $wgDebugRawPage; - global $wgDebugLogPrefix; + 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 ) { return; } - if ( $wgDebugComments && !$logonly ) { + if ( ( $wgDebugComments || $wgShowDebug ) && !$logonly ) { $cache[] = $text; if ( !isset( $wgOut ) ) { @@ -284,7 +322,7 @@ function wfDebug( $text, $logonly = false ) { array_map( array( $wgOut, 'debug' ), $cache ); $cache = array(); } - if ( '' != $wgDebugLogFile && !$wgProfileOnly ) { + 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 ); @@ -293,9 +331,24 @@ function wfDebug( $text, $logonly = false ) { } } +function wfDebugTimer() { + global $wgDebugTimestamps; + if ( !$wgDebugTimestamps ) return ''; + static $start = null; + + if ( $start === null ) { + $start = microtime( true ); + $prefix = "\n$start"; + } else { + $prefix = sprintf( "%6.4f", microtime( true ) - $start ); + } + + return $prefix . ' '; +} + /** * Send a line giving PHP memory usage. - * @param $exact Bool : print exact values instead of kilobytes (default: false) + * @param $exact Bool: print exact values instead of kilobytes (default: false) */ function wfDebugMem( $exact = false ) { $mem = memory_get_usage(); @@ -358,13 +411,18 @@ function wfErrorLog( $text, $file ) { // IPv6 bracketed host $protocol = $m[1]; $host = $m[2]; - $port = $m[3]; + $port = intval( $m[3] ); $prefix = isset( $m[4] ) ? $m[4] : false; + $domain = AF_INET6; } elseif ( preg_match( '!^(tcp|udp):(?://)?([a-zA-Z0-9.-]+):(\d+)(?:/(.*))?$!', $file, $m ) ) { $protocol = $m[1]; $host = $m[2]; - $port = $m[3]; + if ( !IP::isIPv4( $host ) ) { + $host = gethostbyname( $host ); + } + $port = intval( $m[3] ); $prefix = isset( $m[4] ) ? $m[4] : false; + $domain = AF_INET; } else { throw new MWException( __METHOD__.": Invalid UDP specification" ); } @@ -376,12 +434,12 @@ function wfErrorLog( $text, $file ) { } } - $sock = fsockopen( "$protocol://$host", $port ); + $sock = socket_create( $domain, SOCK_DGRAM, SOL_UDP ); if ( !$sock ) { return; } - fwrite( $sock, $text ); - fclose( $sock ); + socket_sendto( $sock, $text, strlen( $text ), 0, $host, $port ); + socket_close( $sock ); } else { wfSuppressWarnings(); $exists = file_exists( $file ); @@ -400,7 +458,7 @@ function wfLogProfilingData() { global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest; global $wgProfiler, $wgProfileLimit, $wgUser; # Profiling must actually be enabled... - if( !isset( $wgProfiler ) ) return; + if( is_null( $wgProfiler ) ) return; # Get total page request time $now = wfTime(); $elapsed = $now - $wgRequestTime; @@ -422,7 +480,7 @@ function wfLogProfilingData() { $log = sprintf( "%s\t%04.3f\t%s\n", gmdate( 'YmdHis' ), $elapsed, urldecode( $wgRequest->getRequestURL() . $forward ) ); - if ( '' != $wgDebugLogFile && ( $wgRequest->getVal('action') != 'raw' || $wgDebugRawPage ) ) { + if ( $wgDebugLogFile != '' && ( $wgRequest->getVal('action') != 'raw' || $wgDebugRawPage ) ) { wfErrorLog( $log . $prof, $wgDebugLogFile ); } } @@ -439,7 +497,7 @@ function wfReadOnly() { if ( !is_null( $wgReadOnly ) ) { return (bool)$wgReadOnly; } - if ( '' == $wgReadOnlyFile ) { + if ( $wgReadOnlyFile == '' ) { return false; } // Set $wgReadOnly for faster access next time @@ -542,8 +600,8 @@ function wfMsgNoTrans( $key ) { * * Be wary of this distinction: If you use wfMsg() where you should * use wfMsgForContent(), a user of the software may have to - * customize over 70 messages in order to, e.g., fix a link in every - * possible language. + * customize potentially hundreds of messages in + * 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 @@ -602,8 +660,8 @@ function wfMsgNoDBForContent( $key ) { * @param $key String: key to get. * @param $args * @param $useDB Boolean + * @param $forContent Mixed: Language code, or false for user lang, true for content lang. * @param $transform Boolean: Whether or not to transform the message. - * @param $forContent Boolean * @return String: the requested message. */ function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) { @@ -628,11 +686,11 @@ function wfMsgWeirdKey( $key ) { /** * Fetch a message string value, but don't replace any keys yet. - * @param string $key - * @param bool $useDB - * @param string $langcode Code of the language to get the message for, or - * behaves as a content language switch if it is a - * boolean. + * @param $key String + * @param $useDB Bool + * @param $langCode String: Code of the language to get the message for, or + * behaves as a content language switch if it is a boolean. + * @param $transform Boolean: whether to parse magic words, etc. * @return string * @private */ @@ -644,7 +702,9 @@ function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) { # If $wgMessageCache isn't initialised yet, try to return something sensible. if( is_object( $wgMessageCache ) ) { $message = $wgMessageCache->get( $key, $useDB, $langCode ); - if ( $transform ) { + if( $message === false ){ + $message = '<' . htmlspecialchars( $key ) . '>'; + } elseif ( $transform ) { $message = $wgMessageCache->transform( $message ); } } else { @@ -667,8 +727,8 @@ function wfMsgGetKey( $key, $useDB, $langCode = false, $transform = true ) { /** * Replace message parameter keys on the given formatted output. * - * @param string $message - * @param array $args + * @param $message String + * @param $args Array * @return string * @private */ @@ -699,7 +759,7 @@ function wfMsgReplaceArgs( $message, $args ) { * to pre-escape them if you really do want plaintext, or just wrap * the whole thing in htmlspecialchars(). * - * @param string $key + * @param $key String * @param string ... parameters * @return string */ @@ -716,7 +776,7 @@ function wfMsgHtml( $key ) { * to pre-escape them if you really do want plaintext, or just wrap * the whole thing in htmlspecialchars(). * - * @param string $key + * @param $key String * @param string ... parameters * @return string */ @@ -729,13 +789,13 @@ function wfMsgWikiHtml( $key ) { /** * Returns message in the requested format - * @param string $key Key of the message - * @param array $options Processing rules. Can take the following options: + * @param $key String: key of the message + * @param $options Array: processing rules. Can take the following options: * parse: parses wikitext to html * parseinline: parses wikitext to html and removes the surrounding * p's added by parser or tidy * escape: filters message through htmlspecialchars - * escapenoentities: same, but allows entity references like   through + * escapenoentities: same, but allows entity references like   through * replaceafter: parameters are substituted after parsing or escaping * parsemag: transform the message using magic phrases * content: fetch message for content language instead of interface @@ -756,12 +816,12 @@ function wfMsgExt( $key, $options ) { foreach( $options as $arrayKey => $option ) { if( !preg_match( '/^[0-9]+|language$/', $arrayKey ) ) { # An unknown index, neither numeric nor "language" - trigger_error( "wfMsgExt called with incorrect parameter key $arrayKey", E_USER_WARNING ); + wfWarn( "wfMsgExt called with incorrect parameter key $arrayKey", 1, E_USER_WARNING ); } elseif( preg_match( '/^[0-9]+$/', $arrayKey ) && !in_array( $option, array( 'parse', 'parseinline', 'escape', 'escapenoentities', 'replaceafter', 'parsemag', 'content' ) ) ) { # A numeric index with unknown value - trigger_error( "wfMsgExt called with incorrect parameter $option", E_USER_WARNING ); + wfWarn( "wfMsgExt called with incorrect parameter $option", 1, E_USER_WARNING ); } } @@ -855,7 +915,7 @@ function wfErrorExit() { /** * 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 string $msg + * @param $msg String */ function wfDie( $msg='' ) { echo $msg; @@ -866,7 +926,7 @@ function wfDie( $msg='' ) { * Throw a debugging exception. This function previously once exited the process, * but now throws an exception instead, with similar results. * - * @param string $msg Message shown when dieing. + * @param $msg String: message shown when dieing. */ function wfDebugDieBacktrace( $msg = '' ) { throw new MWException( $msg ); @@ -900,21 +960,21 @@ function wfHostname() { return $host; } - /** - * Returns a HTML comment with the elapsed time since request. - * This method has no side effects. - * @return string - */ - function wfReportTime() { - global $wgRequestTime, $wgShowHostnames; +/** + * Returns a HTML comment with the elapsed time since request. + * This method has no side effects. + * @return string + */ +function wfReportTime() { + global $wgRequestTime, $wgShowHostnames; - $now = wfTime(); - $elapsed = $now - $wgRequestTime; + $now = wfTime(); + $elapsed = $now - $wgRequestTime; - return $wgShowHostnames - ? sprintf( "", wfHostname(), $elapsed ) - : sprintf( "", $elapsed ); - } + return $wgShowHostnames + ? sprintf( "", wfHostname(), $elapsed ) + : sprintf( "", $elapsed ); +} /** * Safety wrapper for debug_backtrace(). @@ -1022,18 +1082,19 @@ function wfShowingResultsNum( $offset, $limit, $num ) { /** * Generate (prev x| next x) (20|50|100...) type links for paging - * @param $offset string - * @param $limit int - * @param $link string - * @param $query string, optional URL query parameter string - * @param $atend bool, optional param for specified if this is the last page + * @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 */ 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?? # Get prev/next link display text - $prev = wfMsgHtml( 'prevn', $fmtLimit ); - $next = wfMsgHtml( 'nextn', $fmtLimit ); + $prev = wfMsgExt( 'prevn', array('parsemag','escape'), $fmtLimit ); + $next = wfMsgExt( 'nextn', array('parsemag','escape'), $fmtLimit ); # Get prev/next link title text $pTitle = wfMsgExt( 'prevn-title', array('parsemag','escape'), $fmtLimit ); $nTitle = wfMsgExt( 'nextn-title', array('parsemag','escape'), $fmtLimit ); @@ -1077,15 +1138,15 @@ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) { wfNumLink( $offset, 250, $title, $query ), wfNumLink( $offset, 500, $title, $query ) ) ); - return wfMsg( 'viewprevnext', $plink, $nlink, $nums ); + return wfMsgHtml( 'viewprevnext', $plink, $nlink, $nums ); } /** * Generate links for (20|50|100...) items-per-page links - * @param $offset string - * @param $limit int + * @param $offset String + * @param $limit Integer * @param $title Title - * @param $query string, optional URL query parameter string + * @param $query String: optional URL query parameter string */ function wfNumLink( $offset, $limit, $title, $query = '' ) { global $wgLang; @@ -1108,8 +1169,7 @@ function wfNumLink( $offset, $limit, $title, $query = '' ) { * @return bool Whereas client accept gzip compression */ function wfClientAcceptsGzip() { - global $wgUseGzip; - if( $wgUseGzip ) { + if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) { # FIXME: we may want to blacklist some broken browsers $m = array(); if( preg_match( @@ -1146,7 +1206,7 @@ function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) { * not filter out characters which have special meaning only at the * start of a line, such as "*". * - * @param string $text Text to be escaped + * @param $text String: text to be escaped */ function wfEscapeWikiText( $text ) { $text = str_replace( @@ -1218,7 +1278,7 @@ function wfSetBit( &$dest, $bit, $state = true ) { * "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 ) +function wfArrayToCGI( $array1, $array2 = null ) { if ( !is_null( $array2 ) ) { $array1 = $array1 + $array2; @@ -1226,8 +1286,8 @@ function wfArrayToCGI( $array1, $array2 = NULL ) $cgi = ''; foreach ( $array1 as $key => $value ) { - if ( '' !== $value ) { - if ( '' != $cgi ) { + if ( $value !== '' ) { + if ( $cgi != '' ) { $cgi .= '&'; } if ( is_array( $value ) ) { @@ -1257,7 +1317,7 @@ function wfArrayToCGI( $array1, $array2 = NULL ) * 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 + * @param $query String: query string * @return array Array version of input */ function wfCgiToArray( $query ) { @@ -1282,8 +1342,8 @@ function wfCgiToArray( $query ) { * 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 string $url - * @param mixed $query String or associative array + * @param $url String + * @param $query Mixed: string or associative array * @return string */ function wfAppendQuery( $url, $query ) { @@ -1302,13 +1362,20 @@ function wfAppendQuery( $url, $query ) { } /** - * Expand a potentially local URL to a fully-qualified URL. - * Assumes $wgServer is correct. :) - * @param string $url, either fully-qualified or a local path + query + * 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, 1 ) == '/' ) { + if( substr( $url, 0, 2 ) == '//' ) { + global $wgProto; + return $wgProto . ':' . $url; + } elseif( substr( $url, 0, 1 ) == '/' ) { global $wgServer; return $wgServer . $url; } else { @@ -1360,13 +1427,17 @@ function wfEscapeShellArg( ) { } $delim = !$delim; } + // Double the backslashes before the end of the string, because // we will soon add a quote $m = array(); if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) { $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] ); } - + + // The caret is also an special character + $arg = str_replace( "^", "^^", $arg ); + // Add surrounding quotes $retVal .= '"' . $arg . '"'; } else { @@ -1439,10 +1510,10 @@ 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. - * @return string Unified diff of $before and $after + * @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. + * @return String: unified diff of $before and $after */ function wfDiff( $before, $after, $params = '-u' ) { if ($before == $after) { @@ -1554,7 +1625,7 @@ function wfHttpError( $code, $label, $desc ) { * Note that some PHP configuration options may add output buffer * layers which cannot be removed; these are left in place. * - * @param bool $resetGzipEncoding + * @param $resetGzipEncoding Bool */ function wfResetOutputBuffers( $resetGzipEncoding=true ) { if( $resetGzipEncoding ) { @@ -1639,8 +1710,8 @@ function wfAcceptToPrefs( $accept, $def = '*/*' ) { * Returns the matching MIME type (or wildcard) if a match, otherwise * NULL if no match. * - * @param string $type - * @param array $avail + * @param $type String + * @param $avail Array * @return string * @private */ @@ -1654,7 +1725,7 @@ function mimeTypeMatch( $type, $avail ) { } elseif( array_key_exists( '*/*', $avail ) ) { return '*/*'; } else { - return NULL; + return null; } } } @@ -1665,8 +1736,8 @@ function mimeTypeMatch( $type, $avail ) { * array of type to preference (preference is a float between 0.0 and 1.0). * Wildcards in the types are acceptable. * - * @param array $cprefs Client's acceptable type list - * @param array $sprefs Server's offered types + * @param $cprefs Array: client's acceptable type list + * @param $sprefs Array: server's offered types * @return string * * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8' @@ -1696,7 +1767,7 @@ function wfNegotiateType( $cprefs, $sprefs ) { } $bestq = 0; - $besttype = NULL; + $besttype = null; foreach( array_keys( $combine ) as $type ) { if( $combine[$type] > $bestq ) { @@ -1744,7 +1815,7 @@ function wfSuppressWarnings( $end = false ) { } } else { if ( !$suppressCount ) { - $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE ) ); + $originalLevel = error_reporting( E_ALL & ~( E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE ) ); } ++$suppressCount; } @@ -1811,12 +1882,13 @@ define('TS_POSTGRES', 7); define('TS_DB2', 8); /** - * @param mixed $outputtype A timestamp in one of the supported formats, the - * function will autodetect which format is supplied - * and act accordingly. - * @return string Time in the format specified in $outputtype + * @param $outputtype Mixed: A timestamp in one of the supported formats, the + * function will autodetect which format is supplied and act + * accordingly. + * @param $ts Mixed: the timestamp to convert or 0 for the current timestamp + * @return String: in the format specified in $outputtype */ -function wfTimestamp($outputtype=TS_UNIX,$ts=0) { +function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) { $uts = 0; $da = array(); if ($ts==0) { @@ -1830,8 +1902,8 @@ function wfTimestamp($outputtype=TS_UNIX,$ts=0) { } elseif (preg_match('/^\d{1,13}$/D',$ts)) { # TS_UNIX $uts = $ts; - } elseif (preg_match('/^\d{1,2}-...-\d\d(?:\d\d)? \d\d\.\d\d\.\d\d/', $ts)) { - # TS_ORACLE + } elseif (preg_match('/^\d{2}-\d{2}-\d{4} \d{2}:\d{2}:\d{2}.\d{6}$/', $ts)) { + # TS_ORACLE // session altered to DD-MM-YYYY HH24:MI:SS.FF6 $uts = strtotime(preg_replace('/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3", str_replace("+00:00", "UTC", $ts))); } elseif (preg_match('/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.*\d*)?Z$/', $ts, $da)) { @@ -1868,7 +1940,8 @@ function wfTimestamp($outputtype=TS_UNIX,$ts=0) { case TS_RFC2822: return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT'; case TS_ORACLE: - return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00'; + return gmdate( 'd-m-Y H:i:s.000000', $uts); + //return gmdate( 'd-M-y h.i.s A', $uts) . ' +00:00'; case TS_POSTGRES: return gmdate( 'Y-m-d H:i:s', $uts) . ' GMT'; case TS_DB2: @@ -1881,9 +1954,9 @@ 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 int $outputtype - * @param string $ts - * @return string + * @param $outputtype Integer + * @param $ts String + * @return String */ function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) { if( is_null( $ts ) ) { @@ -1896,7 +1969,7 @@ function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) { /** * Check if the operating system is Windows * - * @return bool True if it's Windows, False otherwise. + * @return Bool: true if it's Windows, False otherwise. */ function wfIsWindows() { if (substr(php_uname(), 0, 7) == 'Windows') { @@ -1963,8 +2036,7 @@ function wfGetCachedNotice( $name ) { } wfProfileOut( $fname ); - global $wgContLang; - return $wgContLang->convert( $notice ); + return $notice; } function wfGetNamespaceNotice() { @@ -2025,16 +2097,20 @@ function &wfGetMimeMagic() { } /** - * Tries to get the system directory for temporary files. - * The TMPDIR, TMP, and TEMP environment variables are checked in sequence, - * and if none are set /tmp is returned as the generic Unix default. + * Tries to get the system directory for temporary files. For PHP >= 5.2.1, + * we'll use sys_get_temp_dir(). The TMPDIR, TMP, and TEMP environment + * variables are then checked in sequence, and if none are set /tmp is + * returned as the generic Unix default. * * NOTE: When possible, use the tempfile() function to create temporary * files to avoid race conditions on file creation, etc. * - * @return string + * @return String */ function wfTempDir() { + if( function_exists( 'sys_get_temp_dir' ) ) { + return sys_get_temp_dir(); + } foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) { $tmp = getenv( $var ); if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) { @@ -2048,9 +2124,9 @@ function wfTempDir() { /** * Make directory, and make all parent directories if they don't exist * - * @param string $dir Full path to directory to create - * @param int $mode Chmod value to use, default is $wgDirectoryMode - * @param string $caller Optional caller param for debugging. + * @param $dir String: full path to directory to create + * @param $mode Integer: chmod value to use, default is $wgDirectoryMode + * @param $caller String: optional caller param for debugging. * @return bool */ function wfMkdirParents( $dir, $mode = null, $caller = null ) { @@ -2063,10 +2139,17 @@ function wfMkdirParents( $dir, $mode = null, $caller = null ) { if( strval( $dir ) === '' || file_exists( $dir ) ) return true; + $dir = str_replace( array( '\\', '/' ), DIRECTORY_SEPARATOR, $dir ); + if ( is_null( $mode ) ) $mode = $wgDirectoryMode; - return mkdir( $dir, $mode, true ); // PHP5 <3 + $ok = mkdir( $dir, $mode, true ); // PHP5 <3 + if( !$ok ) { + // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis. + trigger_error( __FUNCTION__ . ": failed to mkdir \"$dir\" mode $mode", E_USER_WARNING ); + } + return $ok; } /** @@ -2097,9 +2180,9 @@ function wfIncrStats( $key ) { } /** - * @param mixed $nr The number to format - * @param int $acc The number of digits after the decimal point, default 2 - * @param bool $round Whether or not to round the value, default true + * @param $nr Mixed: the number to format + * @param $acc Integer: the number of digits after the decimal point, default 2 + * @param $round Boolean: whether or not to round the value, default true * @return float */ function wfPercent( $nr, $acc = 2, $round = true ) { @@ -2110,9 +2193,9 @@ function wfPercent( $nr, $acc = 2, $round = true ) { /** * Encrypt a username/password. * - * @param string $userid ID of the user - * @param string $password Password of the user - * @return string Hashed 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 ) { @@ -2138,20 +2221,20 @@ function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) { * looked up didn't exist but a XHTML string, this function checks for the * nonexistance of messages by looking at wfMsg() output * - * @param $msg The message key looked up - * @param $wfMsgOut The output of wfMsg*() - * @return bool + * @param $key String: the message key looked up + * @return Boolean True if the message *doesn't* exist. */ -function wfEmptyMsg( $msg, $wfMsgOut ) { - return $wfMsgOut === htmlspecialchars( "<$msg>" ); +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 mixed needle - * @param string haystack - * @return bool + * @param $needle String + * @param $str String + * @return Boolean */ function in_string( $needle, $str ) { return strpos( $str, $needle ) !== false; @@ -2166,11 +2249,15 @@ function wfSpecialList( $page, $details ) { /** * Returns a regular expression of url protocols * - * @return string + * @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 ) ) { @@ -2178,10 +2265,11 @@ function wfUrlProtocols() { foreach ($wgUrlProtocols as $protocol) $protocols[] = preg_quote( $protocol, '/' ); - return implode( '|', $protocols ); + $retval = implode( '|', $protocols ); } else { - return $wgUrlProtocols; + $retval = $wgUrlProtocols; } + return $retval; } /** @@ -2204,8 +2292,8 @@ function wfUrlProtocols() { * * I frickin' hate PHP... :P * - * @param string $setting - * @return bool + * @param $setting String + * @return Bool */ function wfIniGetBool( $setting ) { $val = ini_get( $setting ); @@ -2260,9 +2348,12 @@ function wfShellExec( $cmd, &$retval=null ) { $cmd = escapeshellarg( $script ) . " $time $mem $filesize " . escapeshellarg( $cmd ); } } - } elseif ( php_uname( 's' ) == 'Windows NT' ) { + } elseif ( php_uname( 's' ) == 'Windows NT' && + version_compare( PHP_VERSION, '5.3.0', '<' ) ) + { # This is a hack to work around PHP's flawed invocation of cmd.exe # http://news.php.net/php.internals/21796 + # Which is fixed in 5.3.0 :) $cmd = '"' . $cmd . '"'; } wfDebug( "wfShellExec: $cmd\n" ); @@ -2306,8 +2397,8 @@ function wfInitShellLocale() { * * @see perldoc -f use * - * @param mixed $version The version to check, can be a string, an integer, or - * a float + * @param $req_ver Mixed: the version to check, can be a string, an integer, or + * a float */ function wfUsePHP( $req_ver ) { $php_ver = PHP_VERSION; @@ -2326,8 +2417,8 @@ function wfUsePHP( $req_ver ) { * * @see perldoc -f use * - * @param mixed $version The version to check, can be a string, an integer, or - * a float + * @param $req_ver Mixed: the version to check, can be a string, an integer, or + * a float */ function wfUseMW( $req_ver ) { global $wgVersion; @@ -2351,9 +2442,9 @@ function wfRegexReplacement( $string ) { * PHP's basename() only considers '\' a pathchar on Windows and Netware. * We'll consider it so always, as we don't want \s in our Unix paths either. * - * @param string $path - * @param string $suffix to remove if present - * @return string + * @param $path String + * @param $suffix String: to remove if present + * @return String */ function wfBaseName( $path, $suffix='' ) { $encSuffix = ($suffix == '') @@ -2372,9 +2463,9 @@ function wfBaseName( $path, $suffix='' ) { * May explode on non-matching case-insensitive paths, * funky symlinks, etc. * - * @param string $path Absolute destination path including target filename - * @param string $from Absolute source path, directory only - * @return string + * @param $path String: absolute destination path including target filename + * @param $from String: Absolute source path, directory only + * @return String */ function wfRelativePath( $path, $from ) { // Normalize mixed input on Windows... @@ -2416,8 +2507,9 @@ 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 array $array1, [$array2, [...]] - * @return array + * @param $array1 Array + * @param [$array2, [...]] Arrays + * @return Array */ function wfArrayMerge( $array1/* ... */ ) { $args = func_get_args(); @@ -2445,11 +2537,13 @@ function wfArrayMerge( $array1/* ... */ ) { * array( 'y' ) * ) */ -function wfMergeErrorArrays(/*...*/) { +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; } @@ -2464,8 +2558,8 @@ function wfMergeErrorArrays(/*...*/) { * 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 string $url A URL to parse - * @return array Bits of the URL in an associative array, per PHP docs + * @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 @@ -2565,12 +2659,12 @@ function wfExplodeMarkup( $separator, $text ) { * Supports base 2 through 36; digit values 10-36 are represented * as lowercase letters a-z. Input is case-insensitive. * - * @param $input string of digits - * @param $sourceBase int 2-36 - * @param $destBase int 2-36 - * @param $pad int 1 or greater - * @param $lowercase bool - * @return string or false on invalid input + * @param $input String: of digits + * @param $sourceBase Integer: 2-36 + * @param $destBase Integer: 2-36 + * @param $pad Integer: 1 or greater + * @param $lowercase Boolean + * @return String or false on invalid input */ function wfBaseConvert( $input, $sourceBase, $destBase, $pad=1, $lowercase=true ) { $input = strval( $input ); @@ -2647,8 +2741,8 @@ function wfBaseConvert( $input, $sourceBase, $destBase, $pad=1, $lowercase=true /** * Create an object with a given name and an array of construct parameters - * @param string $name - * @param array $p parameters + * @param $name String + * @param $p Array: parameters */ function wfCreateObject( $name, $p ){ $p = array_values( $p ); @@ -2672,15 +2766,6 @@ function wfCreateObject( $name, $p ){ } } -/** - * Alias for modularized function - * @deprecated Use Http::get() instead - */ -function wfGetHTTP( $url, $timeout = 'default' ) { - wfDeprecated(__FUNCTION__); - return Http::get( $url, $timeout ); -} - /** * Alias for modularized function * @deprecated Use Http::isLocalURL() instead @@ -2743,7 +2828,7 @@ function wfSetupSession() { /** * Get an object from the precompiled serialized directory * - * @return mixed The variable on success, false on failure + * @return Mixed: the variable on success, false on failure */ function wfGetPrecompiledData( $name ) { global $IP; @@ -2768,12 +2853,17 @@ function wfGetCaller( $level = 2 ) { return $caller; } -/** Return a string consisting all callers in stack, somewhat useful sometimes for profiling specific points */ +/** + * Return a string consisting all callers in stack, somewhat useful sometimes + * for profiling specific points + */ function wfGetAllCallers() { return implode('/', array_map('wfFormatStackFrame',array_reverse(wfDebugBacktrace()))); } -/** Return a string representation of frame */ +/** + * Return a string representation of frame + */ function wfFormatStackFrame($frame) { return isset( $frame["class"] )? $frame["class"]."::".$frame["function"]: @@ -2786,6 +2876,7 @@ function wfFormatStackFrame($frame) { function wfMemcKey( /*... */ ) { $args = func_get_args(); $key = wfWikiID() . ':' . implode( ':', $args ); + $key = str_replace( ' ', '_', $key ); return $key; } @@ -2806,16 +2897,12 @@ function wfForeignMemcKey( $db, $prefix /*, ... */ ) { * Get an ASCII string identifying this wiki * This is used as a prefix in memcached keys */ -function wfWikiID( $db = null ) { - if( $db instanceof Database ) { - return $db->getWikiID(); - } else { +function wfWikiID() { global $wgDBprefix, $wgDBname; - if ( $wgDBprefix ) { - return "$wgDBname-$wgDBprefix"; - } else { - return $wgDBname; - } + if ( $wgDBprefix ) { + return "$wgDBname-$wgDBprefix"; + } else { + return $wgDBname; } } @@ -2832,15 +2919,15 @@ function wfSplitWikiID( $wiki ) { /* * Get a Database object. - * @param integer $db 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. + * @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. * - * @param mixed $groups Query groups. An array of group names that this query - * belongs to. May contain a single string if the query is only - * in one group. + * @param $groups Mixed: query groups. An array of group names that this query + * belongs to. May contain a single string if the query is only + * in one group. * - * @param string $wiki The wiki ID, or false for the current wiki + * @param $wiki String: the wiki ID, or false for the current wiki * * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request * will always return the same object, unless the underlying connection or load @@ -2853,8 +2940,7 @@ function &wfGetDB( $db, $groups = array(), $wiki = false ) { /** * Get a load balancer object. * - * @param array $groups List of query groups - * @param string $wiki Wiki ID, or false for the current wiki + * @param $wiki String: wiki ID, or false for the current wiki * @return LoadBalancer */ function wfGetLB( $wiki = false ) { @@ -2871,25 +2957,31 @@ function &wfGetLBFactory() { /** * Find a file. * Shortcut for RepoGroup::singleton()->findFile() - * @param mixed $title Title object or string. May be interwiki. - * @param mixed $time Requested time for an archived image, or false for the - * current version. An image object will be returned which - * was created at the specified time. - * @param mixed $flags FileRepo::FIND_ flags - * @param boolean $bypass Bypass the file cache even if it could be used + * @param $title Either a string or Title object + * @param $options Associative array of options: + * time: requested time for an archived image, or false for the + * current version. An image object will be returned which was + * created at the specified time. + * + * ignoreRedirect: If true, do not follow file redirects + * + * private: If true, return restricted (deleted) files if the current + * user is allowed to view them. Otherwise, such files will not + * be found. + * + * bypassCache: If true, do not use the process-local cache of File objects + * * @return File, or false if the file does not exist */ -function wfFindFile( $title, $time = false, $flags = 0, $bypass = false ) { - if( !$time && !$flags && !$bypass ) { - return FileCache::singleton()->findFile( $title ); - } else { - return RepoGroup::singleton()->findFile( $title, $time, $flags ); - } +function wfFindFile( $title, $options = array() ) { + return RepoGroup::singleton()->findFile( $title, $options ); } /** * Get an object referring to a locally registered file. * Returns a valid placeholder object if the file does not exist. + * @param $title Either a string or Title object + * @return File, or null if passed an invalid Title */ function wfLocalFile( $title ) { return RepoGroup::singleton()->getLocalRepo()->newFile( $title ); @@ -2898,7 +2990,7 @@ function wfLocalFile( $title ) { /** * Should low-performance queries be disabled? * - * @return bool + * @return Boolean */ function wfQueriesMustScale() { global $wgMiserMode; @@ -2912,20 +3004,42 @@ function wfQueriesMustScale() { * Get the path to a specified script file, respecting file * extensions; this is a wrapper around $wgScriptExtension etc. * - * @param string $script Script filename, sans extension - * @return string + * @param $script String: script filename, sans extension + * @return String */ function wfScript( $script = 'index' ) { global $wgScriptPath, $wgScriptExtension; return "{$wgScriptPath}/{$script}{$wgScriptExtension}"; } +/** + * Get the script url. + * + * @return script url + */ +function wfGetScriptUrl(){ + if( isset( $_SERVER['SCRIPT_NAME'] ) ) { + # + # as it was called, minus the query string. + # + # Some sites use Apache rewrite rules to handle subdomains, + # and have PHP set up in a weird way that causes PHP_SELF + # to contain the rewritten URL instead of the one that the + # outside world sees. + # + # If in this mode, use SCRIPT_URL instead, which mod_rewrite + # provides containing the "before" URL. + return $_SERVER['SCRIPT_NAME']; + } else { + return $_SERVER['URL']; + } +} /** * Convenience function converts boolean values into "true" * or "false" (string) values * - * @param bool $value - * @return string + * @param $value Boolean + * @return String */ function wfBoolToStr( $value ) { return $value ? 'true' : 'false'; @@ -2933,42 +3047,9 @@ function wfBoolToStr( $value ) { /** * Load an extension messages file - * - * @param string $extensionName Name of extension to load messages from\for. - * @param string $langcode Language to load messages for, or false for default - * behvaiour (en, content language and user language). - * @since r24808 (v1.11) Using this method of loading extension messages will not work - * on MediaWiki prior to that + * @deprecated in 1.16 (warnings in 1.18, removed in ?) */ function wfLoadExtensionMessages( $extensionName, $langcode = false ) { - global $wgExtensionMessagesFiles, $wgMessageCache, $wgLang, $wgContLang; - - #For recording whether extension message files have been loaded in a given language. - static $loaded = array(); - - if( !array_key_exists( $extensionName, $loaded ) ) { - $loaded[$extensionName] = array(); - } - - if ( !isset($wgExtensionMessagesFiles[$extensionName]) ) { - throw new MWException( "Messages file for extensions $extensionName is not defined" ); - } - - if( !$langcode && !array_key_exists( '*', $loaded[$extensionName] ) ) { - # Just do en, content language and user language. - $wgMessageCache->loadMessagesFile( $wgExtensionMessagesFiles[$extensionName], false ); - # Mark that they have been loaded. - $loaded[$extensionName]['en'] = true; - $loaded[$extensionName][$wgLang->getCode()] = true; - $loaded[$extensionName][$wgContLang->getCode()] = true; - # Mark that this part has been done to avoid weird if statements. - $loaded[$extensionName]['*'] = true; - } elseif( is_string( $langcode ) && !array_key_exists( $langcode, $loaded[$extensionName] ) ) { - # Load messages for specified language. - $wgMessageCache->loadMessagesFile( $wgExtensionMessagesFiles[$extensionName], $langcode ); - # Mark that they have been loaded. - $loaded[$extensionName][$langcode] = true; - } } /** @@ -2986,9 +3067,9 @@ function wfGetNull() { /** * Displays a maxlag error * - * @param string $host Server that lags the most - * @param int $lag Maxlag (actual) - * @param int $maxLag Maxlag (requested) + * @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; @@ -3004,19 +3085,33 @@ function wfMaxlagError( $host, $lag, $maxLag ) { } /** - * Throws an E_USER_NOTICE saying that $function is deprecated - * @param string $function + * Throws a warning that $function is deprecated + * @param $function String * @return null */ function wfDeprecated( $function ) { - global $wgDebugLogFile; - if ( !$wgDebugLogFile ) { - return; + static $functionsWarned = array(); + if ( !isset( $functionsWarned[$function] ) ) { + $functionsWarned[$function] = true; + wfWarn( "Use of $function is deprecated.", 2 ); } +} + +/** + * Send a warning either to the debug log or in a PHP error depending on + * $wgDevelopmentWarnings + * + * @param $msg String: message to send + * @param $callerOffset Integer: number of itmes 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 ) { $callers = wfDebugBacktrace(); - if( isset( $callers[2] ) ){ - $callerfunc = $callers[2]; - $callerfile = $callers[1]; + if( isset( $callers[$callerOffset+1] ) ){ + $callerfunc = $callers[$callerOffset+1]; + $callerfile = $callers[$callerOffset]; if( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ){ $file = $callerfile['file'] . ' at line ' . $callerfile['line']; } else { @@ -3026,11 +3121,15 @@ function wfDeprecated( $function ) { if( isset( $callerfunc['class'] ) ) $func .= $callerfunc['class'] . '::'; $func .= @$callerfunc['function']; - $msg = "Use of $function is deprecated. Called from $func in $file"; + $msg .= " [Called from $func in $file]"; + } + + global $wgDevelopmentWarnings; + if ( $wgDevelopmentWarnings ) { + trigger_error( $msg, $level ); } else { - $msg = "Use of $function is deprecated."; + wfDebug( "$msg\n" ); } - wfDebug( "$msg\n" ); } /** @@ -3043,13 +3142,14 @@ function wfDeprecated( $function ) { * 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 int $maxLag + * @param $maxLag Integer + * @param $wiki mixed Wiki identifier accepted by wfGetLB * @return null */ -function wfWaitForSlaves( $maxLag ) { +function wfWaitForSlaves( $maxLag, $wiki = false ) { if( $maxLag ) { - $lb = wfGetLB(); - list( $host, $lag ) = $lb->getMaxLag(); + $lb = wfGetLB( $wiki ); + list( $host, $lag ) = $lb->getMaxLag( $wiki ); while( $lag > $maxLag ) { $name = @gethostbyaddr( $host ); if( $name !== false ) { @@ -3077,8 +3177,27 @@ function wfOut( $s ) { flush(); } +/** + * Count down from $n to zero on the terminal, with a one-second pause + * between showing each number. For use in command-line scripts. + */ +function wfCountDown( $n ) { + for ( $i = $n; $i >= 0; $i-- ) { + if ( $i != $n ) { + echo str_repeat( "\x08", strlen( $i + 1 ) ); + } + echo $i; + flush(); + if ( $i ) { + sleep( 1 ); + } + } + echo "\n"; +} + /** Generate a random 32-character hexadecimal token. - * @param mixed $salt Some sort of salt, if necessary, to add to random characters before hashing. + * @param $salt Mixed: some sort of salt, if necessary, to add to random + * characters before hashing. */ function wfGenerateToken( $salt = '' ) { $salt = serialize($salt); @@ -3088,10 +3207,133 @@ function wfGenerateToken( $salt = '' ) { /** * Replace all invalid characters with - - * @param mixed $title Filename to process + * @param $name Mixed: filename to process */ function wfStripIllegalFilenameChars( $name ) { + global $wgIllegalFileChars; $name = wfBaseName( $name ); - $name = preg_replace ( "/[^".Title::legalChars()."]|:/", '-', $name ); + $name = preg_replace("/[^".Title::legalChars()."]".($wgIllegalFileChars ? "|[".$wgIllegalFileChars."]":"")."/",'-',$name); return $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( $object, $recursive = true ) { + $array = array(); + foreach ( get_object_vars($object) as $key => $value ) { + if ( is_object($value) && $recursive ) { + $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 () { + global $wgMemoryLimit; + $memlimit = wfShorthandToInteger( ini_get( "memory_limit" ) ); + $conflimit = wfShorthandToInteger( $wgMemoryLimit ); + if( $memlimit != -1 ) { + if( $conflimit == -1 ) { + wfDebug( "Removing PHP's memory limit\n" ); + wfSuppressWarnings(); + ini_set( "memory_limit", $conflimit ); + wfRestoreWarnings(); + return $conflimit; + } elseif ( $conflimit > $memlimit ) { + wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" ); + wfSuppressWarnings(); + ini_set( "memory_limit", $conflimit ); + wfRestoreWarnings(); + return $conflimit; + } + } + return $memlimit; +} + +/** + * Converts shorthand byte notation to integer form + * @param $string String + * @return Integer + */ +function wfShorthandToInteger ( $string = '' ) { + $string = trim($string); + if( empty($string) ) { return -1; } + $last = strtolower($string[strlen($string)-1]); + $val = intval($string); + switch($last) { + case 'g': + $val *= 1024; + case 'm': + $val *= 1024; + case 'k': + $val *= 1024; + } + + return $val; +} + +/* Get the normalised IETF language tag + * @param $code String: The language code. + * @return $langCode String: The language code which complying with BCP 47 standards. + */ +function wfBCP47( $code ) { + $codeSegment = explode( '-', $code ); + foreach ( $codeSegment as $segNo => $seg ) { + if ( count( $codeSegment ) > 0 ) { + // ISO 3166 country code + if ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) + $codeBCP[$segNo] = strtoupper( $seg ); + // ISO 15924 script code + else if ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) + $codeBCP[$segNo] = ucfirst( $seg ); + // Use lowercase for other cases + else + $codeBCP[$segNo] = strtolower( $seg ); + } else { + // Use lowercase for single segment + $codeBCP[$segNo] = strtolower( $seg ); + } + } + $langCode = implode ( '-' , $codeBCP ); + 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 ); + } + } + return $ret; +}