sync from fr.wikipedia.org
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 5873970..ddb39ff 100644 (file)
@@ -8,7 +8,7 @@
 /**
  * Some globals and requires needed
  */
+
 /**
  * Total number of articles
  * @global integer $wgNumberOfArticles
@@ -67,18 +67,29 @@ if( !function_exists('is_a') ) {
 
 # UTF-8 substr function based on a PHP manual comment
 if ( !function_exists( 'mb_substr' ) ) {
-       function mb_substr( $str, $start ) { 
+       function mb_substr( $str, $start ) {
                preg_match_all( '/./us', $str, $ar );
 
                if( func_num_args() >= 3 ) {
-                       $end = func_get_arg( 2 ); 
-                       return join( '', array_slice( $ar[0], $start, $end ) ); 
-               } else { 
-                       return join( '', array_slice( $ar[0], $start ) ); 
+                       $end = func_get_arg( 2 );
+                       return join( '', array_slice( $ar[0], $start, $end ) );
+               } else {
+                       return join( '', array_slice( $ar[0], $start ) );
                }
        }
 }
 
+if( !function_exists( 'floatval' ) ) {
+       /**
+        * First defined in PHP 4.2.0
+        * @param mixed $var;
+        * @return float
+        */
+       function floatval( $var ) {
+               return (float)$var;
+       }
+}
+
 /**
  * Where as we got a random seed
  * @var bool $wgTotalViews
@@ -164,6 +175,22 @@ function wfDebug( $text, $logonly = false ) {
        }
 }
 
+/**
+ * Send a line to a supplementary debug log file, if configured, or main debug log if not.
+ * $wgDebugLogGroups[$logGroup] should be set to a filename to send to a separate log.
+ * @param string $logGroup
+ * @param string $text
+ */
+function wfDebugLog( $logGroup, $text ) {
+       global $wgDebugLogGroups, $wgDBname;
+       if( $text{strlen( $text ) - 1} != "\n" ) $text .= "\n";
+       if( isset( $wgDebugLogGroups[$logGroup] ) ) {
+               @error_log( "$wgDBname: $text", 3, $wgDebugLogGroups[$logGroup] );
+       } else {
+               wfDebug( $text, true );
+       }
+}
+
 /**
  * Log for database errors
  * @param string $text Database error message.
@@ -224,14 +251,22 @@ function wfReadOnly() {
        if ( '' == $wgReadOnlyFile ) {
                return false;
        }
-       return is_file( $wgReadOnlyFile );
+
+       // Set $wgReadOnly and unset $wgReadOnlyFile, for faster access next time
+       if ( is_file( $wgReadOnlyFile ) ) {
+               $wgReadOnly = file_get_contents( $wgReadOnlyFile );
+       } else {
+               $wgReadOnly = false;
+       }
+       $wgReadOnlyFile = '';
+       return $wgReadOnly;
 }
 
 
 /**
  * Get a message from anywhere, for the current user language
  *
- * @param string 
+ * @param string
  */
 function wfMsg( $key ) {
        $args = func_get_args();
@@ -283,7 +318,7 @@ function wfMsgNoDBForContent( $key ) {
 function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
        $fname = 'wfMsgReal';
        wfProfileIn( $fname );
-       
+
        $message = wfMsgGetKey( $key, $useDB, $forContent );
        $message = wfMsgReplaceArgs( $message, $args );
        wfProfileOut( $fname );
@@ -302,7 +337,7 @@ function wfMsgGetKey( $key, $useDB, $forContent = false ) {
        global $wgParser, $wgMsgParserOptions;
        global $wgContLang, $wgLanguageCode;
        global $wgMessageCache, $wgLang;
-       
+
        if( is_object( $wgMessageCache ) ) {
                $message = $wgMessageCache->get( $key, $useDB, $forContent );
        } else {
@@ -313,7 +348,7 @@ function wfMsgGetKey( $key, $useDB, $forContent = false ) {
                }
 
                wfSuppressWarnings();
-               
+
                if( is_object( $lang ) ) {
                        $message = $lang->getMessage( $key );
                } else {
@@ -339,7 +374,7 @@ function wfMsgGetKey( $key, $useDB, $forContent = false ) {
  */
 function wfMsgReplaceArgs( $message, $args ) {
        static $replacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' );
-       
+
        # Fix windows line-endings
        # Some messages are split with explode("\n", $msg)
        $message = str_replace( "\r", '', $message );
@@ -365,9 +400,25 @@ function wfMsgReplaceArgs( $message, $args ) {
 function wfMsgHtml( $key ) {
        $args = func_get_args();
        array_shift( $args );
-       return wfMsgReplaceArgs(
-               htmlspecialchars( wfMsgGetKey( $key, $args, true ) ),
-               $args );
+       return wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $key, true ) ), $args );
+}
+
+/**
+ * Return an HTML version of message
+ * Parameter replacements, if any, are done *after* parsing the wiki-text message,
+ * so parameters may contain HTML (eg links or form controls). Be sure
+ * to pre-escape them if you really do want plaintext, or just wrap
+ * the whole thing in htmlspecialchars().
+ *
+ * @param string $key
+ * @param string ... parameters
+ * @return string
+ */
+function wfMsgWikiHtml( $key ) {
+       global $wgOut;
+       $args = func_get_args();
+       array_shift( $args );
+       return wfMsgReplaceArgs( $wgOut->parse( wfMsgGetKey( $key, true ), /* can't be set to false */ true ), $args );
 }
 
 /**
@@ -423,7 +474,8 @@ function wfDebugDieBacktrace( $msg = '' ) {
                        $msg .= "\n<p>Backtrace:</p>\n$backtrace";
                }
         }
-        die( $msg );
+        echo $msg;
+        die( -1 );
 }
 
 function wfBacktrace() {
@@ -431,7 +483,7 @@ function wfBacktrace() {
        if ( !function_exists( 'debug_backtrace' ) ) {
                return false;
        }
-       
+
        if ( $wgCommandLineMode ) {
                $msg = '';
        } else {
@@ -501,16 +553,16 @@ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
        $fmtLimit = $wgLang->formatNum( $limit );
        $prev = wfMsg( 'prevn', $fmtLimit );
        $next = wfMsg( 'nextn', $fmtLimit );
-       
+
        if( is_object( $link ) ) {
                $title =& $link;
        } else {
-               $title =& Title::newFromText( $link );
+               $title = Title::newFromText( $link );
                if( is_null( $title ) ) {
                        return false;
                }
        }
-       
+
        $sk = $wgUser->getSkin();
        if ( 0 != $offset ) {
                $po = $offset - $limit;
@@ -593,7 +645,7 @@ function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
  * @param string $text Text to be escaped
  */
 function wfEscapeWikiText( $text ) {
-       $text = str_replace( 
+       $text = str_replace(
                array( '[',             '|',      '\'',    'ISBN '        , '://'         , "\n=", '{{' ),
                array( '&#91;', '&#124;', '&#39;', 'ISBN&#32;', '&#58;//' , "\n&#61;", '&#123;&#123;' ),
                htmlspecialchars($text) );
@@ -634,10 +686,10 @@ function wfEscapeJsString( $string ) {
        $pairs = array(
                "\\" => "\\\\",
                "\"" => "\\\"",
-               "\'" => "\\\'",
+               '\'' => '\\\'',
                "\n" => "\\n",
                "\r" => "\\r",
-               
+
                # To avoid closing the element or CDATA section
                "<" => "\\x3c",
                ">" => "\\x3e",
@@ -723,7 +775,7 @@ function wfPurgeSquidServers ($urlArr) {
 
 /**
  * Windows-compatible version of escapeshellarg()
- * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg() 
+ * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
  * function puts single quotes in regardless of OS
  */
 function wfEscapeShellArg( ) {
@@ -736,7 +788,7 @@ function wfEscapeShellArg( ) {
                } else {
                        $first = false;
                }
-       
+
                if ( wfIsWindows() ) {
                        $retVal .= '"' . str_replace( '"','\"', $arg ) . '"';
                } else {
@@ -756,6 +808,7 @@ function wfMerge( $old, $mine, $yours, &$result ){
        # This check may also protect against code injection in
        # case of broken installations.
        if(! file_exists( $wgDiff3 ) ){
+               wfDebug( "diff3 not found\n" );
                return false;
        }
 
@@ -770,7 +823,7 @@ function wfMerge( $old, $mine, $yours, &$result ){
        fwrite( $yourtextFile, $yours ); fclose( $yourtextFile );
 
        # Check for a conflict
-       $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a --overlap-only ' .
+       $cmd = $wgDiff3 . ' -a --overlap-only ' .
          wfEscapeShellArg( $mytextName ) . ' ' .
          wfEscapeShellArg( $oldtextName ) . ' ' .
          wfEscapeShellArg( $yourtextName );
@@ -784,7 +837,7 @@ function wfMerge( $old, $mine, $yours, &$result ){
        pclose( $handle );
 
        # Merge differences
-       $cmd = wfEscapeShellArg( $wgDiff3 ) . ' -a -e --merge ' .
+       $cmd = $wgDiff3 . ' -a -e --merge ' .
          wfEscapeShellArg( $mytextName, $oldtextName, $yourtextName );
        $handle = popen( $cmd, 'r' );
        $result = '';
@@ -797,6 +850,11 @@ function wfMerge( $old, $mine, $yours, &$result ){
        } while ( true );
        pclose( $handle );
        unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
+
+       if ( $result === '' && $old !== '' && $conflict == false ) {
+               wfDebug( "Unexpected null result from diff3.\nCommand: $cmd\nOutput: " . `$cmd 2>&1` . "\n" );
+               $conflict = true;
+       }
        return ! $conflict;
 }
 
@@ -825,8 +883,8 @@ function wfHttpError( $code, $label, $desc ) {
 
        header( 'Content-type: text/html' );
        print "<html><head><title>" .
-               htmlspecialchars( $label ) . 
-               "</title></head><body><h1>" . 
+               htmlspecialchars( $label ) .
+               "</title></head><body><h1>" .
                htmlspecialchars( $label ) .
                "</h1><p>" .
                htmlspecialchars( $desc ) .
@@ -940,7 +998,7 @@ function wfNegotiateType( $cprefs, $sprefs ) {
  * Array lookup
  * Returns an array where the values in the first array are replaced by the
  * values in the second array with the corresponding keys
- * 
+ *
  * @return array
  */
 function wfArrayLookup( $a, $b ) {
@@ -987,7 +1045,7 @@ function wfRestoreWarnings() {
 
 # Autodetect, convert and provide timestamps of various types
 
-/** 
+/**
  * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
  */
 define('TS_UNIX', 0);
@@ -1016,6 +1074,10 @@ define('TS_RFC2822', 3);
  */
 define('TS_EXIF', 4);
 
+/**
+ * Oracle format time.
+ */
+define('TS_ORACLE', 5);
 
 /**
  * @param mixed $outputtype A timestamp in one of the supported formats, the
@@ -1024,8 +1086,8 @@ define('TS_EXIF', 4);
  * @return string Time in the format specified in $outputtype
  */
 function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
-       if ($ts==0) { 
-               $uts=time(); 
+       if ($ts==0) {
+               $uts=time();
        } elseif (preg_match("/^(\d{4})\-(\d\d)\-(\d\d) (\d\d):(\d\d):(\d\d)$/",$ts,$da)) {
                # TS_DB
                $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
@@ -1041,13 +1103,17 @@ function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
        } elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) {
                # TS_UNIX
                $uts=$ts;
+       } elseif (preg_match('/^(\d{1,2})-(...)-(\d\d(\d\d)?) (\d\d)\.(\d\d)\.(\d\d)/', $ts, $da)) {
+               # TS_ORACLE
+               $uts = strtotime(preg_replace('/(\d\d)\.(\d\d)\.(\d\d)(\.(\d+))?/', "$1:$2:$3",
+                               str_replace("+00:00", "UTC", $ts)));
        } else {
                # Bogus value; fall back to the epoch...
                wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
                $uts = 0;
        }
 
-               
+
        switch($outputtype) {
                case TS_UNIX:
                        return $uts;
@@ -1060,6 +1126,8 @@ function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
                        return gmdate(  'Y:m:d H:i:s', $uts );
                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';
                default:
                        wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.');
        }
@@ -1085,13 +1153,13 @@ function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
  *
  * @return bool True if it's windows, False otherwise.
  */
-function wfIsWindows() {   
-       if (substr(php_uname(), 0, 7) == 'Windows') {   
-               return true;   
-       } else {   
-               return false;   
-       }   
-} 
+function wfIsWindows() {
+       if (substr(php_uname(), 0, 7) == 'Windows') {
+               return true;
+       } else {
+               return false;
+       }
+}
 
 /**
  * Swap two variables
@@ -1108,19 +1176,18 @@ function wfGetSiteNotice() {
        wfProfileIn( $fname );
 
        $notice = wfMsg( 'sitenotice' );
-       if($notice == '&lt;sitenotice&gt;') $notice = '';
-       # Allow individual wikis to turn it off
-       if ( $notice == '-' ) {
+       if( $notice == '&lt;sitenotice&gt;' || $notice == '-' ) {
                $notice = '';
-       } else {
-               if ($notice == '') {
-                       $notice = $wgSiteNotice;
-               }
-               if($notice != '-' && $notice != '') {
-                       $specialparser = new Parser();
-                       $parserOutput = $specialparser->parse( $notice, $wgTitle, $wgOut->mParserOptions, false );
-                       $notice = $parserOutput->getText();
-               }
+       }
+       if( $notice == '' ) {
+               # We may also need to override a message with eg downtime info
+               # FIXME: make this work!
+               $notice = $wgSiteNotice;
+       }
+       if($notice != '-' && $notice != '') {
+               $specialparser = new Parser();
+               $parserOutput = $specialparser->parse( $notice, $wgTitle, $wgOut->mParserOptions, false );
+               $notice = $parserOutput->getText();
        }
        wfProfileOut( $fname );
        return $notice;
@@ -1134,7 +1201,7 @@ function wfGetSiteNotice() {
  *
  * @param string $element
  * @param array $attribs Name=>value pairs. Values will be escaped.
- * @param bool $contents NULL to make an open tag only; '' for a contentless closed tag (default)
+ * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
  * @return string
  */
 function wfElement( $element, $attribs = null, $contents = '') {
@@ -1165,7 +1232,7 @@ function wfElement( $element, $attribs = null, $contents = '') {
  *
  * @param string $element
  * @param array $attribs Name=>value pairs. Values will be escaped.
- * @param bool $contents NULL to make an open tag only; '' for a contentless closed tag (default)
+ * @param string $contents NULL to make an open tag only; '' for a contentless closed tag (default)
  * @return string
  */
 function wfElementClean( $element, $attribs = array(), $contents = '') {
@@ -1178,9 +1245,40 @@ function wfElementClean( $element, $attribs = array(), $contents = '') {
        return wfElement( $element, $attribs, $contents );
 }
 
+/**
+ * Create a namespace selector
+ *
+ * @param mixed $selected The namespace which should be selected, default ''
+ * @param string $allnamespaces Value of a special item denoting all namespaces. Null to not include (default)
+ * @return Html string containing the namespace selector
+ */
+function &HTMLnamespaceselector($selected = '', $allnamespaces = null) {
+       global $wgContLang;
+       $s = "<select name='namespace' class='namespaceselector'>\n";
+       $arr = $wgContLang->getFormattedNamespaces();
+       if( !is_null($allnamespaces) ) {
+               $arr = array($allnamespaces => wfMsgHtml('namespacesall')) + $arr;
+       }
+       foreach ($arr as $index => $name) {
+               if ($index < NS_MAIN) continue;
+
+               $name = $index !== 0 ? $name : wfMsgHtml('blanknamespace');
+
+               if ($index === $selected) {
+                       $s .= wfElement("option",
+                                       array("value" => $index, "selected" => "selected"),
+                                       $name);
+               } else {
+                       $s .= wfElement("option", array("value" => $index), $name);
+               }
+       }
+       $s .= "</select>\n";
+       return $s;
+}
+
 /** Global singleton instance of MimeMagic. This is initialized on demand,
 * please always use the wfGetMimeMagic() function to get the instance.
-* 
+*
 * @private
 */
 $wgMimeMagic= NULL;
@@ -1193,7 +1291,7 @@ $wgMimeMagic= NULL;
 */
 function &wfGetMimeMagic() {
        global $wgMimeMagic;
-       
+
        if (!is_null($wgMimeMagic)) {
                return $wgMimeMagic;
        }
@@ -1202,9 +1300,9 @@ function &wfGetMimeMagic() {
                #include on demand
                require_once("MimeMagic.php");
        }
-       
+
        $wgMimeMagic= new MimeMagic();
-       
+
        return $wgMimeMagic;
 }
 
@@ -1221,7 +1319,7 @@ function &wfGetMimeMagic() {
  */
 function wfTempDir() {
        foreach( array( 'TMPDIR', 'TMP', 'TEMP' ) as $var ) {
-               $tmp = getenv( 'TMPDIR' );
+               $tmp = getenv( $var );
                if( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
                        return $tmp;
                }
@@ -1248,4 +1346,67 @@ function wfMkdirParents( $fullDir, $mode ) {
        return true;
 }
 
+/**
+ * Increment a statistics counter
+ */
+function wfIncrStats( $key ) {
+       global $wgDBname, $wgMemc;
+       $key = "$wgDBname:stats:$key";
+       if ( is_null( $wgMemc->incr( $key ) ) ) {
+               $wgMemc->add( $key, 1 );
+       }
+}
+
+/**
+ * @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
+ * @return float
+ */
+function wfPercent( $nr, $acc = 2, $round = true ) {
+       $ret = sprintf( "%.${acc}f", $nr );
+       return $round ? round( $ret, $acc ) . '%' : "$ret%";
+}
+
+/**
+ * Encrypt a username/password.
+ *
+ * @param string $userid ID of the user
+ * @param string $password Password of the user
+ * @return string Hashed password
+ */
+function wfEncryptPassword( $userid, $password ) {
+       global $wgPasswordSalt;
+       $p = md5( $password);
+
+       if($wgPasswordSalt)
+               return md5( "{$userid}-{$p}" );
+       else
+               return $p;
+}
+
+/**
+ * Appends to second array if $value differs from that in $default
+ */
+function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
+       if ( is_null( $changed ) ) {
+               wfDebugDieBacktrace('GlobalFunctions::wfAppendToArrayIfNotDefault got null');
+       }
+       if ( $default[$key] !== $value ) {
+               $changed[$key] = $value;
+       }
+}
+
+/**
+ * Since wfMsg() and co suck, they don't return false if the message key they
+ * looked up didn't exist but a XHTML string, this function checks for the
+ * nonexistance of messages by looking at wfMsg() output
+ *
+ * @param $msg      The message key looked up
+ * @param $wfMsgOut The output of wfMsg*()
+ * @return bool
+ */
+function wfNoMsg( $msg, $wfMsgOut ) {
+       return $wfMsgOut === "&lt;$msg&gt;";
+}
 ?>