documentation
[lhc/web/wiklou.git] / includes / Setup.php
index c48aa8e..ecbd474 100644 (file)
@@ -16,41 +16,40 @@ if( defined( 'MEDIAWIKI' ) ) {
 # setting up a few globals.
 #
 
-global $wgProfiling, $wgProfileSampleRate, $wgIP, $wgUseSquid;
+// Check to see if we are at the file scope
+if ( !isset( $wgVersion ) ) {
+       die( "Error, Setup.php must be included from the file scope, after DefaultSettings.php\n" );
+}
 
 if( !isset( $wgProfiling ) )
        $wgProfiling = false;
 
-if ( $wgProfiling and (0 == rand() % $wgProfileSampleRate ) ) {        
-       require_once( 'Profiling.php' );
-} else {
-       function wfProfileIn( $fn = '' ) {}
-       function wfProfileOut( $fn = '' ) {}
-       function wfGetProfilingOutput( $s, $e ) {}
-       function wfProfileClose() {}
-}
-
-/* collect the originating ips */
-if( $wgUseSquid && isset( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
-       # If the web server is behind a reverse proxy, we need to find
-       # out where our requests are really coming from.
-       $hopips = array_map( 'trim', explode( ',', $_SERVER['HTTP_X_FORWARDED_FOR'] ) );
-
-       while(in_array(trim(end($hopips)), $wgSquidServers)){
-               array_pop($hopips);
-       }
-       $wgIP = trim(end($hopips));
+if ( $wgProfiling and (0 == rand() % $wgProfileSampleRate ) ) {
+        require_once( 'Profiling.php' );
 } else {
-       $wgIP = getenv('REMOTE_ADDR');
+        function wfProfileIn( $fn = '' ) {
+                global $hackwhere, $wgDBname;
+                $hackwhere[] = $fn;
+                if (function_exists("setproctitle"))
+                        setproctitle($fn . " [$wgDBname]");
+        }
+        function wfProfileOut( $fn = '' ) {
+                global $hackwhere, $wgDBname;
+                if (count($hackwhere))
+                        array_pop($hackwhere);
+                if (function_exists("setproctitle") && count($hackwhere))
+                        setproctitle($hackwhere[count($hackwhere)-1] . " [$wgDBname]");
+        }
+        function wfGetProfilingOutput( $s, $e ) {}
+        function wfProfileClose() {}
 }
 
-
 $fname = 'Setup.php';
 wfProfileIn( $fname );
-global $wgUseDynamicDates;
 wfProfileIn( $fname.'-includes' );
 
 require_once( 'GlobalFunctions.php' );
+require_once( 'Hooks.php' );
 require_once( 'Namespace.php' );
 require_once( 'RecentChange.php' ); 
 require_once( 'User.php' );
@@ -67,113 +66,64 @@ require_once( 'Parser.php' );
 require_once( 'ParserCache.php' );
 require_once( 'WebRequest.php' );
 require_once( 'LoadBalancer.php' );
+require_once( 'HistoryBlob.php' );
+require_once( 'ProxyTools.php' );
+require_once( 'ObjectCache.php' );
+require_once( 'WikiError.php' );
+require_once( 'SpecialPage.php' );
 
-$wgRequest = new WebRequest();
-
-
+if ( $wgUseDynamicDates ) {
+       require_once( 'DateFormatter.php' );
+}
 
 wfProfileOut( $fname.'-includes' );
 wfProfileIn( $fname.'-misc1' );
-global $wgUser, $wgLang, $wgOut, $wgTitle;
-global $wgArticle, $wgDeferredUpdateList, $wgLinkCache;
-global $wgMemc, $wgMagicWords, $wgMwRedir, $wgDebugLogFile;
-global $wgMessageCache, $wgUseMemCached, $wgUseDatabaseMessages;
-global $wgMsgCacheExpiry, $wgCommandLineMode;
-global $wgBlockCache, $wgParserCache, $wgParser, $wgDBConnections;
-global $wgLoadBalancer, $wgDBservers, $wgDebugDumpSql;
-global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBtype;
-global $wgUseOldExistenceCheck, $wgEnablePersistentLC;
-
-global $wgFullyInitialised;
+
+$wgIP = wfGetIP();
+$wgRequest = new WebRequest();
 
 # Useful debug output
 if ( $wgCommandLineMode ) {
        # wfDebug( '"' . implode( '"  "', $argv ) . '"' );
 } elseif ( function_exists( 'getallheaders' ) ) {
-       wfDebug( "\nStart request\n" );
+       wfDebug( "\n\nStart request\n" );
        wfDebug( $_SERVER['REQUEST_METHOD'] . ' ' . $_SERVER['REQUEST_URI'] . "\n" );
        $headers = getallheaders();
        foreach ($headers as $name => $value) {
                wfDebug( "$name: $value\n" );
        }
        wfDebug( "\n" );
-} else {
+} elseif( isset( $_SERVER['REQUEST_URI'] ) ) {
        wfDebug( $_SERVER['REQUEST_METHOD'] . ' ' . $_SERVER['REQUEST_URI'] . "\n" );
 }
 
-# Disable linkscc except if the old existence check method is enabled
-if (!$wgUseOldExistenceCheck) {
-       $wgEnablePersistentLC = false;
+if ( $wgSkipSkin ) {
+       $wgSkipSkins[] = $wgSkipSkin;
 }
 
+$wgUseEnotif = $wgEnotifUserTalk || $wgEnotifWatchlist;
+
 wfProfileOut( $fname.'-misc1' );
 wfProfileIn( $fname.'-memcached' );
 
-# FakeMemCachedClient imitates the API of memcached-client v. 0.1.2.
-# It acts as a memcached server with no RAM, that is, all objects are
-# cleared the moment they are set. All set operations succeed and all
-# get operations return null.
-
-if( $wgUseMemCached ) {
-       # Set up Memcached
-       #
-       require_once( 'memcached-client.php' );
-       
-       /**
-        *
-        * @package MediaWiki
-        */
-       class MemCachedClientforWiki extends memcached {
-               function _debugprint( $text ) {
-                       wfDebug( "memcached: $text\n" );
-               }
-       }
+$wgMemc =& wfGetMainCache();
+$messageMemc =& wfGetMessageCacheStorage();
+$parserMemc =& wfGetParserCacheStorage();
 
-       $wgMemc = new MemCachedClientforWiki( array('persistant' => true) );
-       $wgMemc->set_servers( $wgMemCachedServers );
-       $wgMemc->set_debug( $wgMemCachedDebug );
-
-       $messageMemc = &$wgMemc;
-} elseif ( $wgUseTurckShm ) {
-       # Turck shared memory
-       #
-       require_once( 'ObjectCache.php' );
-       $wgMemc = new TurckBagOStuff;
-       $messageMemc = &$wgMemc;
-} else {
-       /**
-        * No shared memory
-        * @package MediaWiki
-        */
-       class FakeMemCachedClient {
-               function add ($key, $val, $exp = 0) { return true; }
-               function decr ($key, $amt=1) { return null; }
-               function delete ($key, $time = 0) { return false; }
-               function disconnect_all () { }
-               function enable_compress ($enable) { }
-               function forget_dead_hosts () { }
-               function get ($key) { return null; }
-               function get_multi ($keys) { return array_pad(array(), count($keys), null); }
-               function incr ($key, $amt=1) { return null; }
-               function replace ($key, $value, $exp=0) { return false; }
-               function run_command ($sock, $cmd) { return null; }
-               function set ($key, $value, $exp=0){ return true; }
-               function set_compress_threshold ($thresh){ }
-               function set_debug ($dbg) { }
-               function set_servers ($list) { }
-       }
-       $wgMemc = new FakeMemCachedClient();
-       
-       # Give the message cache a separate cache in the DB.
-       # This is a speedup over separately querying every message used
-       require_once( 'ObjectCache.php' );
-       $messageMemc = new MediaWikiBagOStuff('objectcache');
-}
+wfDebug( 'Main cache: ' . get_class( $wgMemc ) . 
+       "\nMessage cache: " . get_class( $messageMemc ) . 
+          "\nParser cache: " . get_class( $parserMemc ) . "\n" );
 
 wfProfileOut( $fname.'-memcached' );
 wfProfileIn( $fname.'-SetupSession' );
 
-if( !$wgCommandLineMode && ( isset( $_COOKIE[ini_get('session.name')] ) || isset( $_COOKIE[$wgDBname.'Password'] ) ) ) {
+if ( $wgDBprefix ) {
+       session_name( $wgDBname . '_' . $wgDBprefix . '_session' );
+} else {
+       session_name( $wgDBname . '_session' );
+}
+
+if( !$wgCommandLineMode && ( isset( $_COOKIE[session_name()] ) || isset( $_COOKIE[$wgDBname.'Token'] ) ) ) {
        User::SetupSession();
        $wgSessionStarted = true;
 } else {
@@ -194,87 +144,128 @@ if ( !$wgDBservers ) {
                'flags' => ($wgDebugDumpSql ? DBO_DEBUG : 0) | DBO_DEFAULT
        ));
 }
-$wgLoadBalancer = LoadBalancer::newFromParams( $wgDBservers );
+$wgLoadBalancer = LoadBalancer::newFromParams( $wgDBservers, false, $wgMasterWaitTimeout );
 $wgLoadBalancer->loadMasterPos();
 
 wfProfileOut( $fname.'-database' );
+wfProfileIn( $fname.'-language1' );
+
+require_once( "$IP/languages/Language.php" );
+
+function setupLangObj(&$langclass) {
+       global $IP;
+
+       if( ! class_exists( $langclass ) ) {
+               # Default to English/UTF-8
+               $baseclass = 'LanguageUtf8';
+               require_once( "$IP/languages/$baseclass.php" );
+               $lc = strtolower(substr($langclass, 8));
+               $snip = "
+                       class $langclass extends $baseclass {
+                               function getVariants() {
+                                       return array(\"$lc\");
+                               }
+
+                       }";
+               eval($snip);
+       }
+
+       $lang = new $langclass();
+
+       return $lang;
+}
+
+# $wgLanguageCode may be changed later to fit with user preference.
+# The content language will remain fixed as per the configuration,
+# so let's keep it.
+$wgContLanguageCode = $wgLanguageCode;
+$wgContLangClass = 'Language' . str_replace( '-', '_', ucfirst( $wgContLanguageCode ) );
+
+$wgContLang = setupLangObj( $wgContLangClass );
+$wgContLang->initEncoding();
+
+wfProfileOut( $fname.'-language1' );
 wfProfileIn( $fname.'-User' );
 
-# Extension setup functions
-# Entries should be added to this variable during the inclusion 
-# of the extension file. This allows the extension to perform 
-# any necessary initialisation in the fully initialised environment
+# Skin setup functions
+# Entries can be added to this variable during the inclusion 
+# of the extension file. Skins can then perform any necessary initialisation.
 foreach ( $wgSkinExtensionFunctions as $func ) {
        $func();
 }
 
+if( !is_object( $wgAuth ) ) {
+       require_once( 'AuthPlugin.php' );
+       $wgAuth = new AuthPlugin();
+}
+
 if( $wgCommandLineMode ) {
        # Used for some maintenance scripts; user session cookies can screw things up
        # when the database is in an in-between state.
        $wgUser = new User();
+       # Prevent loading User settings from the DB.
+       $wgUser->setLoaded( true );
 } else {
        $wgUser = User::loadFromSession();
 }
 
-// FIXME : we don't know what the user entered (see SpecialPreferences.php [AV])
-if(isset($wgUser->mOptions['language'])) {
-       // Change language of the site
-       $wgLanguageCode = $wgUser->mOptions['language'];
-       // we will load messages from file instead of from database
-       $wgUseDatabaseMessages = false;
-       }
-
 wfProfileOut( $fname.'-User' );
-wfProfileIn( $fname.'-language' );
-require_once( 'languages/Language.php' );
-
-$wgMessageCache = new MessageCache;
+wfProfileIn( $fname.'-language2' );
 
-$wgLangClass = 'Language' . str_replace( '-', '_', ucfirst( $wgLanguageCode ) );
-if( ! class_exists( $wgLangClass ) || ($wgLanguageCode == 'en' && !$wgUseLatin1) ) {
-       # Default to English/UTF-8
-       require_once( 'languages/LanguageUtf8.php' );
-       $wgLangClass = 'LanguageUtf8';
+// wgLanguageCode now specifically means the UI language
+$wgLanguageCode = $wgUser->getOption('language');
+# Validate $wgLanguageCode, which will soon be sent to an eval()
+if( empty( $wgLanguageCode ) || preg_match( '/^[^a-z-]*$/', $wgLanguageCode ) ) {
+       $wgLanguageCode = $wgContLanguageCode;
 }
 
-$wgLang = new $wgLangClass();
-if ( !is_object($wgLang) ) {
-       print "No language class ($wgLang)\N";
-}
+$wgLangClass = 'Language'. str_replace( '-', '_', ucfirst( $wgLanguageCode ) );
 
-if( $wgUseLatin1 && $wgLanguageCode != 'en' ) {
-       # For non-UTF-8 non-English.
-       require_once( 'languages/LanguageLatin1.php' );
-       $xxx = new LanguageLatin1( $wgLang );
-       unset( $wgLang );
-       $wgLang = $xxx;
-}
+if( $wgLangClass == $wgContLangClass ) {
+       $wgLang = &$wgContLang;
+} else {
+       wfSuppressWarnings();
+       include_once("$IP/languages/$wgLangClass.php");
+       wfRestoreWarnings();
 
-// now that we have a language object, set per language user defaults options
-// if we didn't grabbed them from database.
-if(!$wgUser->mDataLoaded) { $wgUser->loadDefaultFromLanguage(); }
+       $wgLang = setupLangObj( $wgLangClass );
+}
 
 wfProfileOut( $fname.'-language' );
 wfProfileIn( $fname.'-MessageCache' );
 
-$wgMessageCache->initialise( $messageMemc, $wgUseDatabaseMessages, $wgMsgCacheExpiry, $wgDBname );
+$wgMessageCache = new MessageCache;
+$wgMessageCache->initialise( $parserMemc, $wgUseDatabaseMessages, $wgMsgCacheExpiry, $wgDBname);
 
 wfProfileOut( $fname.'-MessageCache' );
+
+#
+# I guess the warning about UI switching might still apply...
+#
+# FIXME: THE ABOVE MIGHT BREAK NAMESPACES, VARIABLES,
+# SEARCH INDEX UPDATES, AND MANY MANY THINGS.
+# DO NOT USE THIS MODE EXCEPT FOR TESTING RIGHT NOW.
+#
+# To disable it, the easiest thing could be to uncomment the 
+# following; they should effectively disable the UI switch functionality
+#
+# $wgLangClass = $wgContLangClass;
+# $wgLanguageCode = $wgContLanguageCode;
+# $wgLang = $wgContLang;
+#
+# TODO: Need to change reference to $wgLang to $wgContLang at proper 
+#       places, including namespaces, dates in signatures, magic words,
+#       and links
+#
+# TODO: Need to look at the issue of input/output encoding
+#
+
+
 wfProfileIn( $fname.'-OutputPage' );
 
 $wgOut = new OutputPage();
-wfDebug( "\n\n" );
 
 wfProfileOut( $fname.'-OutputPage' );
-wfProfileIn( $fname.'-DateFormatter' );
-
-if ( $wgUseDynamicDates ) {
-       require_once( 'DateFormatter.php' );
-       global $wgDateFormatter;
-       $wgDateFormatter = new DateFormatter;
-}
-
-wfProfileOut( $fname.'-DateFormatter' );
 wfProfileIn( $fname.'-BlockCache' );
 
 $wgBlockCache = new BlockCache( true );
@@ -283,23 +274,31 @@ wfProfileOut( $fname.'-BlockCache' );
 wfProfileIn( $fname.'-misc2' );
 
 $wgDeferredUpdateList = array();
+$wgPostCommitUpdateList = array();
+
 $wgLinkCache = new LinkCache();
 $wgMagicWords = array();
 $wgMwRedir =& MagicWord::get( MAG_REDIRECT );
-$wgParserCache = new ParserCache();
-$wgParser = new Parser();
+$wgParserCache = new ParserCache( $messageMemc );
+
+if ( $wgUseXMLparser ) {
+       require_once( 'ParserXML.php' );
+       $wgParser = new ParserXML();
+} else {
+       $wgParser = new Parser();
+}
 $wgOut->setParserOptions( ParserOptions::newFromUser( $wgUser ) );
-$wgDBConnections = array();
+$wgMsgParserOptions = ParserOptions::newFromUser($wgUser);
 wfSeedRandom();
 
 # Placeholders in case of DB error
-$wgTitle = Title::newFromText( wfMsg( 'badtitle' ) );
+$wgTitle = Title::makeTitle( NS_SPECIAL, 'Error' );
 $wgArticle = new Article($wgTitle);
 
 wfProfileOut( $fname.'-misc2' );
 wfProfileIn( $fname.'-extensions' );
 
-# Extension setup functions
+# Extension setup functions for extensions other than skins
 # Entries should be added to this variable during the inclusion 
 # of the extension file. This allows the extension to perform 
 # any necessary initialisation in the fully initialised environment
@@ -307,6 +306,7 @@ foreach ( $wgExtensionFunctions as $func ) {
        $func();
 }
 
+wfDebug( "\n" );
 $wgFullyInitialised = true;
 wfProfileOut( $fname.'-extensions' );
 wfProfileOut( $fname );