(bug 17947) Use current date/time on Special:Preferences rather than Wikipedia day...
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 77daed3..5ff9629 100644 (file)
@@ -33,18 +33,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;
        }
 }
 
@@ -137,6 +190,37 @@ if ( !function_exists( 'array_diff_key' ) ) {
        }
 }
 
+if ( !function_exists( 'array_intersect_key' ) ) {
+       /**
+       * Exists in 5.1.0+
+       * Define our own array_intersect_key function
+       */
+       function array_intersect_key( $isec, $keys ) {
+               $argc = func_num_args();
+
+               if ( $argc > 2 ) {
+                       for ( $i = 1; $isec && $i < $argc; $i++ ) {
+                               $arr = func_get_arg( $i );
+
+                               foreach ( array_keys( $isec ) as $key ) {
+                                       if ( !isset( $arr[$key] ) )
+                                               unset( $isec[$key] );
+                               }
+                       }
+
+                       return $isec;
+               } else {
+                       $res = array();
+                       foreach ( array_keys( $isec ) as $key ) {
+                               if ( isset( $keys[$key] ) )
+                                       $res[$key] = $isec[$key];
+                       }
+
+                       return $res;
+               }
+       }
+}
+
 // Support for Wietse Venema's taint feature
 if ( !function_exists( 'istainted' ) ) {
        function istainted( $var ) {
@@ -255,17 +339,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 +369,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,6 +378,21 @@ 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)
@@ -358,13 +458,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 +481,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 );
@@ -422,7 +527,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 +544,7 @@ function wfReadOnly() {
        if ( !is_null( $wgReadOnly ) ) {
                return (bool)$wgReadOnly;
        }
-       if ( '' == $wgReadOnlyFile ) {
+       if ( $wgReadOnlyFile == '' ) {
                return false;
        }
        // Set $wgReadOnly for faster access next time
@@ -603,7 +708,7 @@ function wfMsgNoDBForContent( $key ) {
  * @param $args
  * @param $useDB Boolean
  * @param $transform Boolean: Whether or not to transform the message.
- * @param $forContent Boolean
+ * @param $forContent Mixed: Language code, or false for user lang, true for content lang.
  * @return String: the requested message.
  */
 function wfMsgReal( $key, $args, $useDB = true, $forContent = false, $transform = true ) {
@@ -1109,8 +1214,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(
@@ -1219,7 +1323,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;
@@ -1227,8 +1331,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 ) ) {
@@ -1659,7 +1763,7 @@ function mimeTypeMatch( $type, $avail ) {
                } elseif( array_key_exists( '*/*', $avail ) ) {
                        return '*/*';
                } else {
-                       return NULL;
+                       return null;
                }
        }
 }
@@ -1701,7 +1805,7 @@ function wfNegotiateType( $cprefs, $sprefs ) {
        }
 
        $bestq = 0;
-       $besttype = NULL;
+       $besttype = null;
 
        foreach( array_keys( $combine ) as $type ) {
                if( $combine[$type] > $bestq ) {
@@ -2031,9 +2135,10 @@ 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.
@@ -2041,6 +2146,9 @@ function &wfGetMimeMagic() {
  * @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 ) ) {
@@ -2074,7 +2182,12 @@ function wfMkdirParents( $dir, $mode = null, $caller = null ) {
        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;
 }
 
 /**
@@ -2179,6 +2292,10 @@ function wfSpecialList( $page, $details ) {
 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 ) ) {
@@ -2186,10 +2303,11 @@ function wfUrlProtocols() {
                foreach ($wgUrlProtocols as $protocol)
                        $protocols[] = preg_quote( $protocol, '/' );
 
-               return implode( '|', $protocols );
+               $retval = implode( '|', $protocols );
        } else {
-               return $wgUrlProtocols;
+               $retval = $wgUrlProtocols;
        }
+       return $retval;
 }
 
 /**
@@ -2268,10 +2386,13 @@ 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
-               $cmd = '"' . $cmd . '"'; // FIXME: breaking Vista sp2/PHP 5.2.9(2)
+               # Which is fixed in 5.3.0 :)
+               $cmd = '"' . $cmd . '"';
        }
        wfDebug( "wfShellExec: $cmd\n" );
 
@@ -2287,41 +2408,6 @@ function wfShellExec( $cmd, &$retval=null ) {
        return $output;
 }
 
-/**
- * Executes a shell command in the background. Passes back the PID of the operation 
- *
- * @param $cmd String
- */
-function wfShellBackgroundExec( $cmd ){        
-       wfDebug( "wfShellBackgroundExec: $cmd\n" );
-       
-       if ( ! wfShellExecEnabled() ) {
-               return "Unable to run external programs";
-       }
-       
-       $pid = shell_exec( "nohup $cmd > /dev/null & echo $!" );
-       return $pid;
-}
-
-/**
- * Checks if the current instance can execute a shell command
- *
- */
-function wfShellExecEnabled(){                 
-       if( wfIniGetBool( 'safe_mode' ) ) {
-               wfDebug( "wfShellExec can't run in safe_mode, PHP's exec functions are too broken.\n" );
-               return false;
-       }
-       $functions = explode( ',', ini_get( 'disable_functions' ) );
-       $functions = array_map( 'trim', $functions );
-       $functions = array_map( 'strtolower', $functions );
-       if ( in_array( 'passthru', $functions ) ) {
-               wfDebug( "passthru is in disabled_functions\n" );
-               return false;
-       }
-       return true;
-}
-
 /**
  * Workaround for http://bugs.php.net/bug.php?id=45132
  * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
@@ -2746,7 +2832,7 @@ function wfHttpOnlySafe() {
                        }
                }
        }
-       
+
        return true;
 }
 
@@ -2916,25 +3002,31 @@ function &wfGetLBFactory() {
 /**
  * Find a file.
  * Shortcut for RepoGroup::singleton()->findFile()
- * @param $title Title object or string. May be interwiki.
- * @param $time Mixed: 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 $flags Mixed: FileRepo::FIND_ flags
- * @param $bypass Boolean: 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 );
@@ -3050,6 +3142,16 @@ function wfDeprecated( $function ) {
        }
 }
 
+/**
+ * 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[$callerOffset+1] ) ){
@@ -3086,12 +3188,13 @@ function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
  * to use this outside maintenance scripts in its present form.
  *
  * @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 ) {
@@ -3152,8 +3255,9 @@ function wfGenerateToken( $salt = '' ) {
  * @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;
 }
 
@@ -3209,13 +3313,12 @@ function wfMemoryLimit () {
                        ini_set( "memory_limit", $conflimit );
                        wfRestoreWarnings();
                        return $conflimit;
-               } else {
-                       $max = max( $memlimit, $conflimit );
-                       wfDebug( "Raising PHP's memory limit to $max bytes\n" );
+               } elseif ( $conflimit > $memlimit ) {
+                       wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
                        wfSuppressWarnings();
-                       ini_set( "memory_limit", $max );
+                       ini_set( "memory_limit", $conflimit );
                        wfRestoreWarnings();
-                       return $max;
+                       return $conflimit;
                }
        }
        return $memlimit;