When reading from meta's interwiki map, *.wikimedia.org should be set as local (e...
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
index 1b07a15..5b4d8bc 100644 (file)
@@ -90,6 +90,41 @@ if( !function_exists( 'floatval' ) ) {
        }
 }
 
+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 => $value ) {
+                       if ( isset( $right[$key] ) ) {
+                               unset( $result[$key] );
+                       }
+               }
+               return $result;
+       }
+}
+
+// If it doesn't exist no ctype_* stuff will
+if ( ! function_exists( 'ctype_alnum' ) )
+       require_once 'compatability/ctype.php';
+
+/**
+ * Wrapper for clone() for PHP 4, for the moment.
+ * 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 ) {
+       // WARNING: clone() is not a function in PHP 5, so function_exists fails.
+       if( version_compare( PHP_VERSION, '5.0' ) < 0 ) {
+               return $object;
+       } else {
+               return clone( $object );
+       }
+}
+
 /**
  * Where as we got a random seed
  * @var bool $wgTotalViews
@@ -201,7 +236,8 @@ function wfDebugLog( $logGroup, $text, $public = true ) {
 function wfLogDBError( $text ) {
        global $wgDBerrorLog;
        if ( $wgDBerrorLog ) {
-               $text = date('D M j G:i:s T Y') . "\t".$text;
+               $host = trim(`hostname`);
+               $text = date('D M j G:i:s T Y') . "\t$host\t".$text;
                error_log( $text, 3, $wgDBerrorLog );
        }
 }
@@ -211,7 +247,7 @@ function wfLogDBError( $text ) {
  */
 function logProfilingData() {
        global $wgRequestTime, $wgDebugLogFile, $wgDebugRawPage, $wgRequest;
-       global $wgProfiling, $wgProfileStack, $wgProfileLimit, $wgUser;
+       global $wgProfiling, $wgUser;
        $now = wfTime();
 
        list( $usec, $sec ) = explode( ' ', $wgRequestTime );
@@ -228,7 +264,7 @@ function logProfilingData() {
                        $forward .= ' from ' . $_SERVER['HTTP_FROM'];
                if( $forward )
                        $forward = "\t(proxied via {$_SERVER['REMOTE_ADDR']}{$forward})";
-               if( $wgUser->isAnon() )
+               if( is_object($wgUser) && $wgUser->isAnon() )
                        $forward .= ' anon';
                $log = sprintf( "%s\t%04.3f\t%s\n",
                  gmdate( 'YmdHis' ), $elapsed,
@@ -269,7 +305,7 @@ function wfReadOnly() {
 /**
  * Get a message from anywhere, for the current user language.
  *
- * Use wfMsgForContent() instead if the message should NOT 
+ * Use wfMsgForContent() instead if the message should NOT
  * change depending on the user preferences.
  *
  * Note that the message may contain HTML, and is therefore
@@ -277,7 +313,7 @@ function wfReadOnly() {
  * addWikiText will do the escaping for you. Use wfMsgHtml()
  * if you need an escaped message.
  *
- * @param string lookup key for the message, usually 
+ * @param string lookup key for the message, usually
  *    defined in languages/Language.php
  */
 function wfMsg( $key ) {
@@ -286,26 +322,35 @@ function wfMsg( $key ) {
        return wfMsgReal( $key, $args, true );
 }
 
+/**
+ * Same as above except doesn't transform the message
+ */
+function wfMsgNoTrans( $key ) {
+       $args = func_get_args();
+       array_shift( $args );
+       return wfMsgReal( $key, $args, true, false );
+}
+
 /**
  * Get a message from anywhere, for the current global language
  * set with $wgLanguageCode.
- * 
- * Use this if the message should NOT change  dependent on the 
- * language set in the user's preferences. This is the case for 
- * most text written into logs, as well as link targets (such as 
- * the name of the copyright policy page). Link titles, on the 
+ *
+ * Use this if the message should NOT change  dependent on the
+ * language set in the user's preferences. This is the case for
+ * most text written into logs, as well as link targets (such as
+ * the name of the copyright policy page). Link titles, on the
  * other hand, should be shown in the UI language.
  *
- * Note that MediaWiki allows users to change the user interface 
- * language in their preferences, but a single installation 
+ * Note that MediaWiki allows users to change the user interface
+ * language in their preferences, but a single installation
  * typically only contains content in one language.
- * 
- * Be wary of this distinction: If you use wfMsg() where you should 
- * use wfMsgForContent(), a user of the software may have to 
+ *
+ * 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.
  *
- * @param string lookup key for the message, usually 
+ * @param string lookup key for the message, usually
  *    defined in languages/Language.php
  */
 function wfMsgForContent( $key ) {
@@ -319,6 +364,20 @@ function wfMsgForContent( $key ) {
        return wfMsgReal( $key, $args, true, $forcontent );
 }
 
+/**
+ * Same as above except doesn't transform the message
+ */
+function wfMsgForContentNoTrans( $key ) {
+       global $wgForceUIMsgAsContentMsg;
+       $args = func_get_args();
+       array_shift( $args );
+       $forcontent = true;
+       if( is_array( $wgForceUIMsgAsContentMsg ) &&
+               in_array( $key, $wgForceUIMsgAsContentMsg ) )
+               $forcontent = false;
+       return wfMsgReal( $key, $args, true, $forcontent, false );
+}
+
 /**
  * Get a message from the language file, for the UI elements
  */
@@ -346,16 +405,35 @@ function wfMsgNoDBForContent( $key ) {
 /**
  * Really get a message
  */
-function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
+function wfMsgReal( $key, $args, $useDB, $forContent=false, $transform = true ) {
        $fname = 'wfMsgReal';
        wfProfileIn( $fname );
 
-       $message = wfMsgGetKey( $key, $useDB, $forContent );
+       $message = wfMsgGetKey( $key, $useDB, $forContent, $transform );
        $message = wfMsgReplaceArgs( $message, $args );
        wfProfileOut( $fname );
        return $message;
 }
 
+/**
+ * This function provides the message source for messages to be edited which are *not* stored in the database
+*/
+
+function wfMsgWeirdKey ( $key ) {
+       $subsource = str_replace ( ' ' , '_' , $key ) ;
+       $source = wfMsg ( $subsource ) ;
+       if ( $source == "&lt;{$subsource}&gt;" ) {
+               # Try again with first char lower case
+               $subsource = strtolower ( substr ( $subsource , 0 , 1 ) ) . substr ( $subsource , 1 ) ;
+               $source = wfMsg ( $subsource ) ;
+       }
+       if ( $source == "&lt;{$subsource}&gt;" ) {
+               # Didn't work either, return blank text
+               $source = "" ;
+       }
+       return $source ;
+}
+
 /**
  * Fetch a message string value, but don't replace any keys yet.
  * @param string $key
@@ -364,12 +442,15 @@ function wfMsgReal( $key, $args, $useDB, $forContent=false ) {
  * @return string
  * @access private
  */
-function wfMsgGetKey( $key, $useDB, $forContent = false ) {
-       global $wgParser, $wgMsgParserOptions;
-       global $wgContLang, $wgLanguageCode;
-       global $wgMessageCache, $wgLang;
+function wfMsgGetKey( $key, $useDB, $forContent = false, $transform = true ) {
+       global $wgParser, $wgMsgParserOptions, $wgContLang, $wgMessageCache, $wgLang;
+
+       if ( is_object( $wgMessageCache ) )
+               $transstat = $wgMessageCache->getTransform();
 
        if( is_object( $wgMessageCache ) ) {
+               if ( ! $transform )
+                       $wgMessageCache->disableTransform();
                $message = $wgMessageCache->get( $key, $useDB, $forContent );
        } else {
                if( $forContent ) {
@@ -388,10 +469,14 @@ function wfMsgGetKey( $key, $useDB, $forContent = false ) {
                wfRestoreWarnings();
                if($message === false)
                        $message = Language::getMessage($key);
-               if(strstr($message, '{{' ) !== false) {
+               if ( $transform && strstr( $message, '{{' ) !== false ) {
                        $message = $wgParser->transformMsg($message, $wgMsgParserOptions);
                }
        }
+
+       if ( is_object( $wgMessageCache ) && ! $transform )
+               $wgMessageCache->setTransform( $transstat );
+
        return $message;
 }
 
@@ -408,13 +493,20 @@ function wfMsgReplaceArgs( $message, $args ) {
        # Some messages are split with explode("\n", $msg)
        $message = str_replace( "\r", '', $message );
 
-       # Replace arguments
-       if( count( $args ) ) {
-               foreach( $args as $n => $param ) {
-                       $replacementKeys['$' . ($n + 1)] = $param;
+       // Replace arguments
+       if ( count( $args ) ) {
+               if ( is_array( $args[0] ) ) {
+                       foreach ( $args[0] as $key => $val ) {
+                               $message = str_replace( '$' . $key, $val, $message );
+                       }
+               } else {
+                       foreach( $args as $n => $param ) {
+                               $replacementKeys['$' . ($n + 1)] = $param;
+                       }
+                       $message = strtr( $message, $replacementKeys );
                }
-               $message = strtr( $message, $replacementKeys );
        }
+
        return $message;
 }
 
@@ -461,24 +553,28 @@ function wfAbruptExit( $error = false ){
        global $wgLoadBalancer;
        static $called = false;
        if ( $called ){
-               exit();
+               exit( -1 );
        }
        $called = true;
 
        if( function_exists( 'debug_backtrace' ) ){ // PHP >= 4.3
                $bt = debug_backtrace();
                for($i = 0; $i < count($bt) ; $i++){
-                       $file = $bt[$i]['file'];
-                       $line = $bt[$i]['line'];
+                       $file = isset($bt[$i]['file']) ? $bt[$i]['file'] : "unknown";
+                       $line = isset($bt[$i]['line']) ? $bt[$i]['line'] : "unknown";
                        wfDebug("WARNING: Abrupt exit in $file at line $line\n");
                }
        } else {
                wfDebug('WARNING: Abrupt exit\n');
        }
+
+       wfProfileClose();
+       logProfilingData();
+
        if ( !$error ) {
                $wgLoadBalancer->closeAll();
        }
-       exit();
+       exit( -1 );
 }
 
 /**
@@ -488,6 +584,16 @@ function wfErrorExit() {
        wfAbruptExit( true );
 }
 
+/**
+ * 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
+ */
+function wfDie( $msg='' ) {
+       echo $msg;
+       die( -1 );
+}
+
 /**
  * Die with a backtrace
  * This is meant as a debugging aid to track down where bad data comes from.
@@ -627,7 +733,6 @@ function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false ) {
                }
        }
 
-       $sk = $wgUser->getSkin();
        if ( 0 != $offset ) {
                $po = $offset - $limit;
                if ( $po < 0 ) { $po = 0; }
@@ -916,7 +1021,7 @@ function wfMerge( $old, $mine, $yours, &$result ){
        unlink( $mytextName ); unlink( $oldtextName ); unlink( $yourtextName );
 
        if ( $result === '' && $old !== '' && $conflict == false ) {
-               wfDebug( "Unexpected null result from diff3.\nCommand: $cmd\nOutput: " . `$cmd 2>&1` . "\n" );
+               wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
                $conflict = true;
        }
        return ! $conflict;
@@ -1129,6 +1234,13 @@ define('TS_DB', 2);
  */
 define('TS_RFC2822', 3);
 
+/**
+ * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
+ *
+ * This is used by Special:Export
+ */
+define('TS_ISO_8601', 4);
+
 /**
  * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
  *
@@ -1136,12 +1248,12 @@ define('TS_RFC2822', 3);
  *       DateTime tag and page 36 for the DateTimeOriginal and
  *       DateTimeDigitized tags.
  */
-define('TS_EXIF', 4);
+define('TS_EXIF', 5);
 
 /**
  * Oracle format time.
  */
-define('TS_ORACLE', 5);
+define('TS_ORACLE', 6);
 
 /**
  * @param mixed $outputtype A timestamp in one of the supported formats, the
@@ -1172,6 +1284,10 @@ function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
                # TS_ORACLE
                $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})Z$/', $ts, $da)) {
+               # TS_ISO_8601
+               $uts=gmmktime((int)$da[4],(int)$da[5],(int)$da[6],
+                       (int)$da[2],(int)$da[3],(int)$da[1]);
        } else {
                # Bogus value; fall back to the epoch...
                wfDebug("wfTimestamp() fed bogus time value: $outputtype; $ts\n");
@@ -1186,6 +1302,8 @@ function wfTimestamp($outputtype=TS_UNIX,$ts=0) {
                        return gmdate( 'YmdHis', $uts );
                case TS_DB:
                        return gmdate( 'Y-m-d H:i:s', $uts );
+               case TS_ISO_8601:
+                       return gmdate( 'Y-m-d\TH:i:s\Z', $uts );
                // This shouldn't ever be used, but is included for completeness
                case TS_EXIF:
                        return gmdate(  'Y:m:d H:i:s', $uts );
@@ -1214,9 +1332,9 @@ function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
 }
 
 /**
- * Check where as the operating system is Windows
+ * 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') {
@@ -1235,27 +1353,64 @@ function swap( &$x, &$y ) {
        $y = $z;
 }
 
+function wfGetCachedNotice( $name ) {
+       global $wgOut, $parserMemc, $wgDBname;
+       $fname = 'wfGetCachedNotice';
+       wfProfileIn( $fname );
+       
+       $needParse = false;
+       $notice = wfMsgForContent( $name );
+       if( $notice == '&lt;'. $name . ';&gt' || $notice == '-' ) {
+               wfProfileOut( $fname );
+               return( false );
+       }
+       
+       $cachedNotice = $parserMemc->get( $wgDBname . ':' . $name );
+       if( is_array( $cachedNotice ) ) {
+               if( md5( $notice ) == $cachedNotice['hash'] ) {
+                       $notice = $cachedNotice['html'];
+               } else {
+                       $needParse = true;
+               }
+       } else {
+               $needParse = true;
+       }
+       
+       if( $needParse ) {
+               if( is_object( $wgOut ) ) {
+                       $parsed = $wgOut->parse( $notice );
+                       $parserMemc->set( $wgDBname . ':' . $name, array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 );
+                       $notice = $parsed;
+               } else {
+                       wfDebug( 'wfGetCachedNotice called for ' . $name . ' with no $wgOut available' );
+                       $notice = '';
+               }
+       }
+       
+       wfProfileOut( $fname );
+       return $notice;
+}
+
 function wfGetSiteNotice() {
-       global $wgSiteNotice, $wgTitle, $wgOut;
+       global $wgUser, $wgSiteNotice;
        $fname = 'wfGetSiteNotice';
        wfProfileIn( $fname );
-
-       $notice = wfMsg( 'sitenotice' );
-       if( $notice == '&lt;sitenotice&gt;' || $notice == '-' ) {
-               $notice = '';
-       }
-       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();
+       
+       if( $wgUser->isLoggedIn() ) {
+               $siteNotice = wfGetCachedNotice( 'sitenotice' );
+               $siteNotice = !$siteNotice ? $wgSiteNotice : $siteNotice;
+       } else {
+               $anonNotice = wfGetCachedNotice( 'anonnotice' );
+               if( !$anonNotice ) {
+                       $siteNotice = wfGetCachedNotice( 'sitenotice' );
+                       $siteNotice = !$siteNotice ? $wgSiteNotice : $siteNotice;
+               } else {
+                       $siteNotice = $anonNotice;
+               }
        }
+       
        wfProfileOut( $fname );
-       return $notice;
+       return( $siteNotice );
 }
 
 /**
@@ -1282,9 +1437,7 @@ function wfElement( $element, $attribs = null, $contents = '') {
                if( $contents == '' ) {
                        $out .= ' />';
                } else {
-                       $out .= '>';
-                       $out .= htmlspecialchars( $contents );
-                       $out .= "</$element>";
+                       $out .= '>' . htmlspecialchars( $contents ) . "</$element>";
                }
        }
        return $out;
@@ -1311,7 +1464,7 @@ function wfElementClean( $element, $attribs = array(), $contents = '') {
 }
 
 // Shortcuts
-function wfOpenElement( $element ) { return "<$element>"; }
+function wfOpenElement( $element, $attribs = null ) { return wfElement( $element, $attribs, null ); }
 function wfCloseElement( $element ) { return "</$element>"; }
 
 /**
@@ -1357,7 +1510,7 @@ function &HTMLnamespaceselector($selected = '', $allnamespaces = null) {
 /** Global singleton instance of MimeMagic. This is initialized on demand,
 * please always use the wfGetMimeMagic() function to get the instance.
 *
-* @private
+* @access private
 */
 $wgMimeMagic= NULL;
 
@@ -1412,7 +1565,7 @@ function wfTempDir() {
 function wfMkdirParents( $fullDir, $mode ) {
        $parts = explode( '/', $fullDir );
        $path = '';
-       $success = false;
+
        foreach ( $parts as $dir ) {
                $path .= $dir . '/';
                if ( !is_dir( $path ) ) {
@@ -1498,4 +1651,163 @@ function wfEmptyMsg( $msg, $wfMsgOut ) {
 function in_string( $needle, $str ) {
        return strpos( $str, $needle ) !== false;
 }
+
+/**
+ * Returns a regular expression of url protocols
+ *
+ * @return string
+ */
+function wfUrlProtocols() {
+       global $wgUrlProtocols;
+
+       $protocols = array();
+       foreach ($wgUrlProtocols as $protocol)
+               $protocols[] = preg_quote( $protocol, '/' );
+
+       return implode( '|', $protocols );
+}
+
+/**
+ * Check if a string is well-formed XML.
+ * Must include the surrounding tag.
+ *
+ * @param string $text
+ * @return bool
+ *
+ * @todo Error position reporting return
+ */
+function wfIsWellFormedXml( $text ) {
+       $parser = xml_parser_create( "UTF-8" );
+
+       # case folding violates XML standard, turn it off
+       xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
+
+       if( !xml_parse( $parser, $text, true ) ) {
+               $err = xml_error_string( xml_get_error_code( $parser ) );
+               $position = xml_get_current_byte_index( $parser );
+               //$fragment = $this->extractFragment( $html, $position );
+               //$this->mXmlError = "$err at byte $position:\n$fragment";
+               xml_parser_free( $parser );
+               return false;
+       }
+       xml_parser_free( $parser );
+       return true;
+}
+
+/**
+ * Check if a string is a well-formed XML fragment.
+ * Wraps fragment in an <html> bit and doctype, so it can be a fragment
+ * and can use HTML named entities.
+ *
+ * @param string $text
+ * @return bool
+ */
+function wfIsWellFormedXmlFragment( $text ) {
+       $html =
+               Sanitizer::hackDocType() .
+               '<html>' .
+               $text .
+               '</html>';
+       return wfIsWellFormedXml( $html );
+}
+
+/**
+ * shell_exec() with time and memory limits mirrored from the PHP configuration,
+ * if supported.
+ */
+function wfShellExec( $cmd )
+{
+       global $IP;
+
+       if ( php_uname( 's' ) == 'Linux' ) {
+               $time = ini_get( 'max_execution_time' );
+               $mem = ini_get( 'memory_limit' );
+               if( preg_match( '/^([0-9]+)[Mm]$/', trim( $mem ), $m ) ) {
+                       $mem = intval( $m[1] * (1024*1024) );
+               }
+               if ( $time > 0 && $mem > 0 ) {
+                       $script = "$IP/bin/ulimit.sh";
+                       if ( is_executable( $script ) ) {
+                               $memKB = intval( $mem / 1024 );
+                               $cmd = escapeshellarg( $script ) . " $time $memKB $cmd";
+                       }
+               }
+       }
+       return shell_exec( $cmd );
+}
+
+/**
+ * This function works like "use VERSION" in Perl, the program will die with a
+ * backtrace if the current version of PHP is less than the version provided
+ *
+ * This is useful for extensions which due to their nature are not kept in sync
+ * with releases, and might depend on other versions of PHP than the main code
+ *
+ * Note: PHP might die due to parsing errors in some cases before it ever
+ *       manages to call this function, such is life
+ *
+ * @see perldoc -f use
+ *
+ * @param mixed $version The version to check, can be a string, an integer, or
+ *                       a float
+ */
+function wfUsePHP( $req_ver ) {
+       $php_ver = PHP_VERSION;
+
+       if ( version_compare( $php_ver, (string)$req_ver, '<' ) )
+                wfDebugDieBacktrace( "PHP $req_ver required--this is only $php_ver" );
+}
+
+/**
+ * This function works like "use VERSION" in Perl except it checks the version
+ * of MediaWiki, the program will die with a backtrace if the current version
+ * of MediaWiki is less than the version provided.
+ *
+ * This is useful for extensions which due to their nature are not kept in sync
+ * with releases
+ *
+ * @see perldoc -f use
+ *
+ * @param mixed $version The version to check, can be a string, an integer, or
+ *                       a float
+ */
+function wfUseMW( $req_ver ) {
+       global $wgVersion;
+
+       if ( version_compare( $wgVersion, (string)$req_ver, '<' ) )
+               wfDebugDieBacktrace( "MediaWiki $req_ver required--this is only $wgVersion" );
+}
+
+/**
+ * Escape a string to make it suitable for inclusion in a preg_replace()
+ * replacement parameter.
+ *
+ * @param string $string
+ * @return string
+ */
+function wfRegexReplacement( $string ) {
+       $string = str_replace( '\\', '\\\\', $string );
+       $string = str_replace( '$', '\\$', $string );
+       return $string;
+}
+
+/**
+ * Return the final portion of a pathname.
+ * Reimplemented because PHP5's basename() is buggy with multibyte text.
+ * http://bugs.php.net/bug.php?id=33898
+ *
+ * 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
+ * @return string
+ */
+function wfBaseName( $path ) {
+       if( preg_match( '#([^/\\\\]*)[/\\\\]*$#', $path, $matches ) ) {
+               return $matches[1];
+       } else {
+               return '';
+       }
+}
+
 ?>