typo
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 2618325..31b72a7 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-# $Id$
 
 /**
  * Global functions used everywhere
@@ -89,19 +88,43 @@ if ( !function_exists( 'mb_substr' ) ) {
  * @param string $charset Encoding set to use (default 'ISO-8859-1')
  */
 function do_html_entity_decode( $string, $quote_style=ENT_COMPAT, $charset='ISO-8859-1' ) {
+       $fname = 'do_html_entity_decode';
+       wfProfileIn( $fname );
+       
        static $trans;
        static $savedCharset;
+       static $regexp;
        if( !isset( $trans ) || $savedCharset != $charset ) {
                $trans = array_flip( get_html_translation_table( HTML_ENTITIES, $quote_style ) );
                $savedCharset = $charset;
-               # Assumes $charset will always be the same through a run, and only understands
-               # utf-8 or default. Note - mixing latin1 named entities and unicode numbered
+               
+               # Note - mixing latin1 named entities and unicode numbered
                # ones will result in a bad link.
                if( strcasecmp( 'utf-8', $charset ) == 0 ) {
                        $trans = array_map( 'utf8_encode', $trans );
                }
+               
+               /**
+                * Most links will _not_ contain these fun guys,
+                * and on long pages with many links we can get
+                * called a lot.
+                *
+                * A regular expression search is faster than
+                * a strtr or str_replace with a hundred-ish
+                * entries, though it may be slower to actually
+                * replace things.
+                *
+                * They all look like '&xxxx;'...
+                */
+               foreach( $trans as $key => $val ) {
+                       $snip[] = substr( $key, 1, -1 );
+               }
+               $regexp = '/(&(?:' . implode( '|', $snip ) . ');)/e';
        }
-       return strtr( $string, $trans );
+
+       $out = preg_replace( $regexp, '$trans["$1"]', $string );
+       wfProfileOut( $fname );
+       return $out;
 }
 
 
@@ -279,7 +302,7 @@ function logProfilingData() {
                        $forward .= ' from ' . $_SERVER['HTTP_FROM'];
                if( $forward )
                        $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
-               if($wgUser->getId() == 0)
+               if( $wgUser->isAnon() )
                        $forward .= ' anon';
                $log = sprintf( "%s\t%04.3f\t%s\n",
                  gmdate( 'YmdHis' ), $elapsed,
@@ -310,18 +333,8 @@ function wfReadOnly() {
  * Get a message from anywhere, for the UI elements
  */
 function wfMsg( $key ) {
-       global $wgRequest;
-
-       if ( $wgRequest->getVal( 'debugmsg' ) ) {
-               if ( $key == 'linktrail' /* a special case where we want to return something specific */ )
-                       return "/^()(.*)$/sD";
-               else
-                       return $key;
-       }
        $args = func_get_args();
-       if ( count( $args ) ) {
-               array_shift( $args );
-       }
+       array_shift( $args );
        return wfMsgReal( $key, $args, true );
 }
 
@@ -329,20 +342,14 @@ function wfMsg( $key ) {
  * Get a message from anywhere, for the content
  */
 function wfMsgForContent( $key ) {
-       global $wgRequest;
-       if ( $wgRequest->getVal( 'debugmsg' ) ) {
-               if ( $key == 'linktrail' /* a special case where we want to return something specific */ )
-                       return "/^()(.*)$/sD";
-               else
-                       return $key;
-       }
+       global $wgForceUIMsgAsContentMsg;
        $args = func_get_args();
-       if ( count( $args ) ) {
-               array_shift( $args );
-       }
-       return wfMsgReal( $key, $args, true, true );
-    
-
+       array_shift( $args );
+       $forcontent = true;
+       if( is_array( $wgForceUIMsgAsContentMsg ) &&
+               in_array( $key, $wgForceUIMsgAsContentMsg ) )
+               $forcontent = false;
+       return wfMsgReal( $key, $args, true, $forcontent );
 }
 
 /**
@@ -350,9 +357,7 @@ function wfMsgForContent( $key ) {
  */
 function wfMsgNoDB( $key ) {
        $args = func_get_args();
-       if ( count( $args ) ) {
-               array_shift( $args );
-       }
+       array_shift( $args );
        return wfMsgReal( $key, $args, false );
 }
 
@@ -360,12 +365,14 @@ function wfMsgNoDB( $key ) {
  * Get a message from the language file, for the content
  */
 function wfMsgNoDBForContent( $key ) {
-
+       global $wgForceUIMsgAsContentMsg;
        $args = func_get_args();
-       if ( count( $args ) ) {
-               array_shift( $args );
-       }
-       return wfMsgReal( $key, $args, false, true );
+       array_shift( $args );
+       $forcontent = true;
+       if( is_array( $wgForceUIMsgAsContentMsg ) &&
+               in_array( $key, $wgForceUIMsgAsContentMsg ) )
+               $forcontent = false;
+       return wfMsgReal( $key, $args, false, $forcontent );
 }
 
 
@@ -376,38 +383,33 @@ function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
        static $replacementKeys = array( '$1', '$2', '$3', '$4', '$5', '$6', '$7', '$8', '$9' );
        global $wgParser, $wgMsgParserOptions;
        global $wgContLang, $wgLanguageCode;
-    if($forContent) {
-        global $wgMessageCache;
-        $cache = &$wgMessageCache;
-        $lang = &$wgContLang;
+       global $wgMessageCache, $wgLang;
+       
+       $fname = 'wfMsgReal';
+       wfProfileIn( $fname );
+
+       if( is_object( $wgMessageCache ) ) {
+               $message = $wgMessageCache->get( $key, $useDB, $forContent );
     }
-    else {
-               if(in_array($wgLanguageCode, $wgContLang->getVariants())){
-                       global $wgLang, $wgMessageCache;
-                       $cache = &$wgMessageCache;
-                       $lang = $wgLang;
-               }
-        else {
-                       global $wgLang;
-               $cache = false;
-               $lang = &$wgLang;
+       else {
+               if( $forContent ) {
+                       $lang = &$wgContLang;
+               } else {
+                       $lang = &$wgLang;
                }
-    }
 
-       $fname = 'wfMsg';
-       wfProfileIn( $fname );
-       if ( is_object($cache) ) {
-               $message = $cache->get( $key, $useDB, $forContent );
-       } elseif (is_object($lang)) {
-               $message = $lang->getMessage( $key );
+               wfSuppressWarnings();
+               if( is_object( $lang ) ) {
+                       $message = $lang->getMessage( $key );
+               } else {
+                       $message = '';
+               }
+               wfRestoreWarnings();
                if(!$message)
                        $message = Language::getMessage($key);
                if(strstr($message, '{{' ) !== false) {
                        $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
                }
-       } else {
-               wfDebug( "No language object when getting $key\n" );
-               $message = "&lt;$key&gt;";
        }
 
        # Replace arguments
@@ -473,12 +475,21 @@ function wfDebugDieBacktrace( $msg = '' ) {
                }
                $backtrace = debug_backtrace();
                foreach( $backtrace as $call ) {
-                       $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
-                       $file = $f[count($f)-1];
+                       if( isset( $call['file'] ) ) {
+                               $f = explode( DIRECTORY_SEPARATOR, $call['file'] );
+                               $file = $f[count($f)-1];
+                       } else {
+                               $file = '-';
+                       }
+                       if( isset( $call['line'] ) ) {
+                               $line = $call['line'];
+                       } else {
+                               $line = '-';
+                       }
                        if ( $wgCommandLineMode ) {
-                               $msg .= "$file line {$call['line']} calls ";
+                               $msg .= "$file line $line calls ";
                        } else {
-                               $msg .= '<li>' . $file . ' line ' . $call['line'] . ' calls ';
+                               $msg .= '<li>' . $file . ' line ' . $line . ' calls ';
                        }
                        if( !empty( $call['class'] ) ) $msg .= $call['class'] . '::';
                        $msg .= $call['function'] . '()';
@@ -614,7 +625,7 @@ function wfCheckLimits( $deflimit = 50, $optionname = 'rclimit' ) {
  */
 function wfEscapeWikiText( $text ) {
        $text = str_replace( 
-               array( '[',             '|',      "'",     'ISBN '        , '://'         , "\n=", '{{' ),
+               array( '[',             '|',      '\'',    'ISBN '        , '://'         , "\n=", '{{' ),
                array( '&#91;', '&#124;', '&#39;', 'ISBN&#32;', '&#58;//' , "\n&#61;", '&#123;&#123;' ),
                htmlspecialchars($text) );
        return $text;
@@ -772,7 +783,7 @@ function wfMerge( $old, $mine, $yours, &$result ){
          wfEscapeShellArg( $yourtextName );
        $handle = popen( $cmd, 'r' );
 
-       if( fgets( $handle ) ){
+       if( fgets( $handle, 1024 ) ){
                $conflict = true;
        } else {
                $conflict = false;
@@ -801,7 +812,7 @@ function wfMerge( $old, $mine, $yours, &$result ){
  */
 function wfVarDump( $var ) {
        global $wgOut;
-       $s = str_replace("\n","<br>\n", var_export( $var, true ) . "\n");
+       $s = str_replace("\n","<br />\n", var_export( $var, true ) . "\n");
        if ( headers_sent() || !@is_object( $wgOut ) ) {
                print $s;
        } else {
@@ -822,7 +833,7 @@ function wfHttpError( $code, $label, $desc ) {
        # Don't send content if it's a HEAD request.
        if( $_SERVER['REQUEST_METHOD'] == 'HEAD' ) {
                header( 'Content-type: text/plain' );
-               print "$desc\n";
+               print $desc."\n";
        }
 }
 
@@ -854,8 +865,16 @@ function wfAcceptToPrefs( $accept, $def = '*/*' ) {
 }
 
 /**
- * @todo document
- * @private
+ * Checks if a given MIME type matches any of the keys in the given
+ * array. Basic wildcards are accepted in the array keys.
+ *
+ * Returns the matching MIME type (or wildcard) if a match, otherwise
+ * NULL if no match.
+ *
+ * @param string $type
+ * @param array $avail
+ * @return string
+ * @access private
  */
 function mimeTypeMatch( $type, $avail ) {
        if( array_key_exists($type, $avail) ) {
@@ -873,6 +892,15 @@ function mimeTypeMatch( $type, $avail ) {
 }
 
 /**
+ * Returns the 'best' match between a client's requested internet media types
+ * and the server's list of available types. Each list should be an associative
+ * 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
+ * @return string
+ *
  * @todo FIXME: doesn't handle params like 'text/plain; charset=UTF-8'
  * XXX: generalize to negotiate other stuff
  */
@@ -923,42 +951,13 @@ function wfArrayLookup( $a, $b ) {
        return array_flip( array_intersect( array_flip( $a ), array_keys( $b ) ) );
 }
 
-
 /**
- * Ideally we'd be using actual time fields in the db
- * @todo fixme
- */
-function wfTimestamp2Unix( $ts ) {
-       return gmmktime( ( (int)substr( $ts, 8, 2) ),
-                 (int)substr( $ts, 10, 2 ), (int)substr( $ts, 12, 2 ),
-                 (int)substr( $ts, 4, 2 ), (int)substr( $ts, 6, 2 ),
-                 (int)substr( $ts, 0, 4 ) );
-}
-
-/**
- * @todo document
- */
-function wfUnix2Timestamp( $unixtime ) {
-       return gmdate( 'YmdHis', $unixtime );
-}
-
-/**
- * @todo document
+ * Convenience function; returns MediaWiki timestamp for the present time.
+ * @return string
  */
 function wfTimestampNow() {
        # return NOW
-       return gmdate( 'YmdHis' );
-}
-
-/**
- * Sorting hack for MySQL 3, which doesn't use index sorts for DESC
- */
-function wfInvertTimestamp( $ts ) {
-       return strtr(
-               $ts,
-               '0123456789',
-               '9876543210'
-       );
+       return wfTimestamp( TS_MW, time() );
 }
 
 /**
@@ -998,6 +997,8 @@ define('TS_UNIX',0);
 define('TS_MW',1);     
 /** Standard database timestamp (yyyy-mm-dd hh:mm:ss) */
 define('TS_DB',2);
+/** For HTTP and e-mail headers -- output only */
+define('TS_RFC2822', 3 );
 
 /**
  * @todo document
@@ -1014,6 +1015,10 @@ function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
        } elseif (preg_match("/^(\d{1,13})$/",$ts,$datearray)) {
                # TS_UNIX
                $uts=$ts;
+       } else {
+               # Bogus value; fall back to the epoch...
+               wfDebug("wfTimestamp() given bogus time value.\n");
+               $uts = 0;
        }
 
        if ($ts==0)
@@ -1021,15 +1026,14 @@ function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
        switch($outputtype) {
        case TS_UNIX:
                return $uts;
-               break;
        case TS_MW:
                return gmdate( 'YmdHis', $uts );
-               break;
        case TS_DB:
                return gmdate( 'Y-m-d H:i:s', $uts );
-               break;
+       case TS_RFC2822:
+               return gmdate( 'D, d M Y H:i:s', $uts ) . ' GMT';
        default:
-               return;
+               wfDebugDieBacktrace( 'wfTimestamp() called with illegal output type.');
        }
 }
 
@@ -1047,4 +1051,37 @@ function wfIsWindows() {
        }   
 } 
 
+/**
+ * Swap two variables
+ */
+function swap( &$x, &$y ) {
+       $z = $x;
+       $x = $y;
+       $y = $z;
+}
+
+function wfGetSiteNotice() {
+       global $wgSiteNotice, $wgTitle, $wgOut;
+       $fname = 'wfGetSiteNotice';
+       wfProfileIn( $fname );
+
+       $notice = wfMsg( 'sitenotice' );
+       if($notice == '&lt;sitenotice&gt;') $notice = '';
+       # Allow individual wikis to turn it off
+       if ( $notice == '-' ) {
+               $notice = '';
+       } else {
+               if ($notice == '') {
+                       $notice = $wgSiteNotice;
+               }
+               if($notice != '-' && $notice != '') {
+                       $specialparser = new Parser();
+                       $parserOutput = $specialparser->parse( $notice, $wgTitle, $wgOut->mParserOptions, false );
+                       $notice = $parserOutput->getText();
+               }
+       }
+       wfProfileOut( $fname );
+       return $notice;
+}
+
 ?>