From 8831c8e13d0fb46f5ce0acc7014a064bbbe4e4a7 Mon Sep 17 00:00:00 2001
From: Tim Starling <tstarling@users.mediawiki.org>
Date: Fri, 14 Jul 2006 16:36:35 +0000
Subject: [PATCH] MagicWord initialisation deferred.

---
 includes/MagicWord.php | 200 ++++++++++++++++++++---------------------
 includes/Parser.php    |   4 +-
 includes/Setup.php     |   3 -
 3 files changed, 100 insertions(+), 107 deletions(-)

diff --git a/includes/MagicWord.php b/includes/MagicWord.php
index 1e357159b9..92bd4dc45f 100644
--- a/includes/MagicWord.php
+++ b/includes/MagicWord.php
@@ -5,80 +5,6 @@
  * @subpackage Parser
  */
 
-/**
- * private
- */
-$wgMagicFound = false;
-
-/**
- * To add magic words in an extension, use the LanguageGetMagic hook. For 
- * magic words which are also Parser variables, add a MagicWordwgVariableIDs
- * hook. Use string keys. Do use the interface immediately below, 
- * MagicWordMagicWords. It is deprecated.
- */
-
-$magicWords = array();
-if ( ! defined( 'MEDIAWIKI_INSTALL' ) )
-	wfRunHooks( 'MagicWordMagicWords', array( &$magicWords ) );
-
-for ( $i = 0; $i < count( $magicWords ); ++$i )
-	define( $magicWords[$i], $magicWords[$i] );
-
-
-$wgVariableIDs = array(
-	'currentmonth',
-	'currentmonthname',
-	'currentmonthnamegen',
-	'currentmonthabbrev',
-	'currentday',
-	'currentday2',
-	'currentdayname',
-	'currentyear',
-	'currenttime',
-	'numberofarticles',
-	'numberoffiles',
-	'sitename',
-	'server',
-	'servername',
-	'scriptpath',
-	'pagename',
-	'pagenamee',
-	'fullpagename',
-	'fullpagenamee',
-	'namespace',
-	'namespacee',
-	'currentweek',
-	'currentdow',
-	'revisionid',
-	'subpagename',
-	'subpagenamee',
-	'displaytitle',
-	'talkspace',
-	'talkspacee',
-	'subjectspace',
-	'subjectspacee',
-	'talkpagename',
-	'talkpagenamee',
-	'subjectpagename',
-	'subjectpagenamee',
-	'numberofusers',
-	'rawsuffix',
-	'newsectionlink',
-	'numberofpages',
-	'currentversion',
-	'basepagename',
-	'basepagenamee',
-	'urlencode',
-	'currenttimestamp',
-	'directionmark',
-	'language',
-	'contentlanguage',
-	'pagesinnamespace',
-	'numberofadmins',
-);
-if ( ! defined( 'MEDIAWIKI_INSTALL' ) )
-	wfRunHooks( 'MagicWordwgVariableIDs', array( &$wgVariableIDs ) );
-
 /**
  * This class encapsulates "magic words" such as #redirect, __NOTOC__, etc.
  * Usage:
@@ -86,11 +12,15 @@ if ( ! defined( 'MEDIAWIKI_INSTALL' ) )
  *
  * Possible future improvements:
  *   * Simultaneous searching for a number of magic words
- *   * $wgMagicWords in shared memory
+ *   * MagicWord::$mObjects in shared memory
  *
  * Please avoid reading the data out of one of these objects and then writing
  * special case code. If possible, add another match()-like function here.
  *
+ * To add magic words in an extension, use the LanguageGetMagic hook. For 
+ * magic words which are also Parser variables, add a MagicWordwgVariableIDs
+ * hook. Use string keys.
+ *
  * @package MediaWiki
  */
 class MagicWord {
@@ -99,7 +29,63 @@ class MagicWord {
 	 */
 	var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
 	var $mRegexStart, $mBaseRegex, $mVariableRegex;
-	var $mModified;
+	var $mModified, $mFound;
+
+	static public $mVariableIDsInitialised = false;
+	static public $mVariableIDs = array(
+		'currentmonth',
+		'currentmonthname',
+		'currentmonthnamegen',
+		'currentmonthabbrev',
+		'currentday',
+		'currentday2',
+		'currentdayname',
+		'currentyear',
+		'currenttime',
+		'numberofarticles',
+		'numberoffiles',
+		'sitename',
+		'server',
+		'servername',
+		'scriptpath',
+		'pagename',
+		'pagenamee',
+		'fullpagename',
+		'fullpagenamee',
+		'namespace',
+		'namespacee',
+		'currentweek',
+		'currentdow',
+		'revisionid',
+		'subpagename',
+		'subpagenamee',
+		'displaytitle',
+		'talkspace',
+		'talkspacee',
+		'subjectspace',
+		'subjectspacee',
+		'talkpagename',
+		'talkpagenamee',
+		'subjectpagename',
+		'subjectpagenamee',
+		'numberofusers',
+		'rawsuffix',
+		'newsectionlink',
+		'numberofpages',
+		'currentversion',
+		'basepagename',
+		'basepagenamee',
+		'urlencode',
+		'currenttimestamp',
+		'directionmark',
+		'language',
+		'contentlanguage',
+		'pagesinnamespace',
+		'numberofadmins',
+	);
+
+	static public $mObjects = array();
+
 	/**#@-*/
 
 	function MagicWord($id = 0, $syn = '', $cs = false) {
@@ -118,17 +104,31 @@ class MagicWord {
 	 * @static
 	 */
 	static function &get( $id ) {
-		global $wgMagicWords;
-
-		if ( !is_array( $wgMagicWords ) ) {
-			throw new MWException( "Incorrect initialisation order, \$wgMagicWords does not exist\n" );
-		}
-		if (!array_key_exists( $id, $wgMagicWords ) ) {
+		if (!array_key_exists( $id, self::$mObjects ) ) {
 			$mw = new MagicWord();
 			$mw->load( $id );
-			$wgMagicWords[$id] = $mw;
+			self::$mObjects[$id] = $mw;
 		}
-		return $wgMagicWords[$id];
+		return self::$mObjects[$id];
+	}
+
+	/**
+	 * Get an array of parser variable IDs
+	 */
+	static function getVariableIDs() {
+		if ( !self::$mVariableIDsInitialised ) {
+			# Deprecated constant definition hook, available for extensions that need it
+			$magicWords = array();
+			wfRunHooks( 'MagicWordMagicWords', array( &$magicWords ) );
+			foreach ( $magicWords as $word ) {
+				define( $word, $word );
+			}
+
+			# Get variable IDs
+			wfRunHooks( 'MagicWordwgVariableIDs', array( &self::$mVariableIDs ) );
+			self::$mVariableIDsInitialised = true;
+		}
+		return self::$mVariableIDs;
 	}
 
 	# Initialises this object with an ID
@@ -250,19 +250,25 @@ class MagicWord {
 	 * input string, removing all instances of the word
 	 */
 	function matchAndRemove( &$text ) {
-		global $wgMagicFound;
-		$wgMagicFound = false;
-		$text = preg_replace_callback( $this->getRegex(), 'pregRemoveAndRecord', $text );
-		return $wgMagicFound;
+		$this->mFound = false;
+		$text = preg_replace_callback( $this->getRegex(), array( &$this, 'pregRemoveAndRecord' ), $text );
+		return $this->mFound;
 	}
 
 	function matchStartAndRemove( &$text ) {
-		global $wgMagicFound;
-		$wgMagicFound = false;
-		$text = preg_replace_callback( $this->getRegexStart(), 'pregRemoveAndRecord', $text );
-		return $wgMagicFound;
+		$this->mFound = false;
+		$text = preg_replace_callback( $this->getRegexStart(), array( &$this, 'pregRemoveAndRecord' ), $text );
+		return $this->mFound;
 	}
 
+	/**
+	 * Used in matchAndRemove()
+	 * @private
+	 **/
+	function pregRemoveAndRecord( $match ) {
+		$this->mFound = true;
+		return '';
+	}
 
 	/**
 	 * Replaces the word with something else
@@ -358,14 +364,4 @@ class MagicWord {
 	}
 }
 
-/**
- * Used in matchAndRemove()
- * @private
- **/
-function pregRemoveAndRecord( $match ) {
-	global $wgMagicFound;
-	$wgMagicFound = true;
-	return '';
-}
-
 ?>
diff --git a/includes/Parser.php b/includes/Parser.php
index 2305da1821..1079f5b822 100644
--- a/includes/Parser.php
+++ b/includes/Parser.php
@@ -2336,10 +2336,10 @@ class Parser
 	function initialiseVariables() {
 		$fname = 'Parser::initialiseVariables';
 		wfProfileIn( $fname );
-		global $wgVariableIDs;
+		$variableIDs = MagicWord::getVariableIDs();
 
 		$this->mVariables = array();
-		foreach ( $wgVariableIDs as $id ) {
+		foreach ( $variableIDs as $id ) {
 			$mw =& MagicWord::get( $id );
 			$mw->addToArray( $this->mVariables, $id );
 		}
diff --git a/includes/Setup.php b/includes/Setup.php
index 6b2f5841c1..aab3331d9b 100644
--- a/includes/Setup.php
+++ b/includes/Setup.php
@@ -42,7 +42,6 @@ require_once( "$IP/includes/Hooks.php" );
 require_once( "$IP/includes/Namespace.php" );
 require_once( "$IP/includes/User.php" );
 require_once( "$IP/includes/OutputPage.php" );
-require_once( "$IP/includes/MagicWord.php" );
 require_once( "$IP/includes/MessageCache.php" );
 require_once( "$IP/includes/Parser.php" );
 require_once( "$IP/includes/LoadBalancer.php" );
@@ -273,8 +272,6 @@ wfProfileIn( $fname.'-misc2' );
 $wgDeferredUpdateList = array();
 $wgPostCommitUpdateList = array();
 
-$wgMagicWords = array();
-
 $wgParser = new Parser();
 
 $wgOut->setParserOptions( ParserOptions::newFromUser( $wgUser ) );
-- 
2.20.1