X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/mediawiki.git/blobdiff_plain/18a6620945d02687fbcfc4c27355d952fd748b41..HEAD:/includes/StubObject.php

diff --git a/includes/StubObject.php b/includes/StubObject.php
index 678b2744..baf51099 100644
--- a/includes/StubObject.php
+++ b/includes/StubObject.php
@@ -1,10 +1,36 @@
 <?php
+/**
+ * Delayed loading of global objects.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 /**
  * Class to implement stub globals, which are globals that delay loading the
  * their associated module code by deferring initialisation until the first
  * method call.
  *
+ * Note on reference parameters:
+ *
+ * If the called method takes any parameters by reference, the __call magic
+ * here won't work correctly. The solution is to unstub the object before
+ * calling the method.
+ *
  * Note on unstub loops:
  *
  * Unstub loops (infinite recursion) sometimes occur when a constructor calls
@@ -16,31 +42,57 @@
  * which refers to it should be kept to a minimum.
  */
 class StubObject {
-	var $mGlobal, $mClass, $mParams;
+	/** @var null|string */
+	protected $global;
+
+	/** @var null|string */
+	protected $class;
+
+	/** @var null|callable */
+	protected $factory;
+
+	/** @var array */
+	protected $params;
 
 	/**
-	 * Constructor.
-	 *
-	 * @param $global String: name of the global variable.
-	 * @param $class String: name of the class of the real object.
-	 * @param $params Array: parameters to pass to contructor of the real
-	 *               object.
+	 * @param string $global Name of the global variable.
+	 * @param string|callable $class Name of the class of the real object
+	 *                               or a factory function to call
+	 * @param array $params Parameters to pass to constructor of the real object.
 	 */
-	function __construct( $global = null, $class = null, $params = array() ) {
-		$this->mGlobal = $global;
-		$this->mClass = $class;
-		$this->mParams = $params;
+	public function __construct( $global = null, $class = null, $params = [] ) {
+		$this->global = $global;
+		if ( is_callable( $class ) ) {
+			$this->factory = $class;
+		} else {
+			$this->class = $class;
+		}
+		$this->params = $params;
 	}
 
 	/**
-	 * Returns a bool value whetever $obj is a stub object. Can be used to break
+	 * Returns a bool value whenever $obj is a stub object. Can be used to break
 	 * a infinite loop when unstubbing an object.
 	 *
-	 * @param $obj Object to check.
-	 * @return Boolean: true if $obj is not an instance of StubObject class.
+	 * @param object $obj Object to check.
+	 * @return bool True if $obj is not an instance of StubObject class.
 	 */
-	static function isRealObject( $obj ) {
-		return is_object( $obj ) && !($obj instanceof StubObject);
+	public static function isRealObject( $obj ) {
+		return is_object( $obj ) && !$obj instanceof StubObject;
+	}
+
+	/**
+	 * Unstubs an object, if it is a stub object. Can be used to break a
+	 * infinite loop when unstubbing an object or to avoid reference parameter
+	 * breakage.
+	 *
+	 * @param object &$obj Object to check.
+	 * @return void
+	 */
+	public static function unstub( &$obj ) {
+		if ( $obj instanceof StubObject ) {
+			$obj = $obj->_unstub( 'unstub', 3 );
+		}
 	}
 
 	/**
@@ -50,29 +102,38 @@ class StubObject {
 	 * This function will also call the function with the same name in the real
 	 * object.
 	 *
-	 * @param $name String: name of the function called
-	 * @param $args Array: arguments
+	 * @param string $name Name of the function called
+	 * @param array $args Arguments
+	 * @return mixed
 	 */
-	function _call( $name, $args ) {
+	public function _call( $name, $args ) {
 		$this->_unstub( $name, 5 );
-		return call_user_func_array( array( $GLOBALS[$this->mGlobal], $name ), $args );
+		return call_user_func_array( [ $GLOBALS[$this->global], $name ], $args );
 	}
 
 	/**
 	 * Create a new object to replace this stub object.
+	 * @return object
 	 */
-	function _newObject() {
-		return wfCreateObject( $this->mClass, $this->mParams );
+	public function _newObject() {
+		$params = $this->factory
+			? [ 'factory' => $this->factory ]
+			: [ 'class' => $this->class ];
+		return ObjectFactory::getObjectFromSpec( $params + [
+			'args' => $this->params,
+			'closure_expansion' => false,
+		] );
 	}
 
 	/**
 	 * Function called by PHP if no function with that name exists in this
 	 * object.
 	 *
-	 * @param $name String: name of the function called
-	 * @param $args Array: arguments
+	 * @param string $name Name of the function called
+	 * @param array $args Arguments
+	 * @return mixed
 	 */
-	function __call( $name, $args ) {
+	public function __call( $name, $args ) {
 		return $this->_call( $name, $args );
 	}
 
@@ -82,86 +143,65 @@ class StubObject {
 	 * This is public, for the convenience of external callers wishing to access
 	 * properties, e.g. eval.php
 	 *
-	 * @param $name String: name of the method called in this object.
-	 * @param $level Integer: level to go in the stact trace to get the function
-	 *               who called this function.
+	 * @param string $name Name of the method called in this object.
+	 * @param int $level Level to go in the stack trace to get the function
+	 *   who called this function.
+	 * @return object The unstubbed version of itself
+	 * @throws MWException
 	 */
-	function _unstub( $name = '_unstub', $level = 2 ) {
+	public function _unstub( $name = '_unstub', $level = 2 ) {
 		static $recursionLevel = 0;
 
-		if ( !($GLOBALS[$this->mGlobal] instanceof StubObject) )
-			return $GLOBALS[$this->mGlobal]; // already unstubbed.
-		
-		if ( get_class( $GLOBALS[$this->mGlobal] ) != $this->mClass ) {
-			$fname = __METHOD__.'-'.$this->mGlobal;
-			wfProfileIn( $fname );
+		if ( !$GLOBALS[$this->global] instanceof StubObject ) {
+			return $GLOBALS[$this->global]; // already unstubbed.
+		}
+
+		if ( get_class( $GLOBALS[$this->global] ) != $this->class ) {
 			$caller = wfGetCaller( $level );
 			if ( ++$recursionLevel > 2 ) {
-				throw new MWException( "Unstub loop detected on call of \${$this->mGlobal}->$name from $caller\n" );
+				throw new MWException( "Unstub loop detected on call of "
+					. "\${$this->global}->$name from $caller\n" );
 			}
-			wfDebug( "Unstubbing \${$this->mGlobal} on call of \${$this->mGlobal}::$name from $caller\n" );
-			$GLOBALS[$this->mGlobal] = $this->_newObject();
+			wfDebug( "Unstubbing \${$this->global} on call of "
+				. "\${$this->global}::$name from $caller\n" );
+			$GLOBALS[$this->global] = $this->_newObject();
 			--$recursionLevel;
-			wfProfileOut( $fname );
+			return $GLOBALS[$this->global];
 		}
 	}
 }
 
 /**
- * Stub object for the content language of this wiki. This object have to be in
- * $wgContLang global.
- */
-class StubContLang extends StubObject {
-
-	function __construct() {
-		parent::__construct( 'wgContLang' );
-	}
-
-	function __call( $name, $args ) {
-		return $this->_call( $name, $args );
-	}
-
-	function _newObject() {
-		global $wgLanguageCode;
-		$obj = Language::factory( $wgLanguageCode );
-		$obj->initEncoding();
-		$obj->initContLang();
-		return $obj;
-	}
-}
-
-/**
- * Stub object for the user language. It depends of the user preferences and
- * "uselang" parameter that can be passed to index.php. This object have to be
- * in $wgLang global.
+ * Stub object for the user language. Assigned to the $wgLang global.
  */
 class StubUserLang extends StubObject {
 
-	function __construct() {
+	public function __construct() {
 		parent::__construct( 'wgLang' );
 	}
 
-	function __call( $name, $args ) {
-		return $this->_call( $name, $args );
+	/**
+	 * Call Language::findVariantLink after unstubbing $wgLang.
+	 *
+	 * This method is implemented with a full signature rather than relying on
+	 * __call so that the pass-by-reference signature of the proxied method is
+	 * honored.
+	 *
+	 * @param string &$link The name of the link
+	 * @param Title &$nt The title object of the link
+	 * @param bool $ignoreOtherCond To disable other conditions when
+	 *   we need to transclude a template or update a category's link
+	 */
+	public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
+		global $wgLang;
+		$this->_unstub( 'findVariantLink', 3 );
+		$wgLang->findVariantLink( $link, $nt, $ignoreOtherCond );
 	}
 
-	function _newObject() {
-		global $wgLanguageCode, $wgRequest, $wgUser, $wgContLang;
-		$code = $wgRequest->getVal( 'uselang', $wgUser->getOption( 'language' ) );
-		// BCP 47 - letter case MUST NOT carry meaning
-		$code = strtolower( $code );
-
-		# Validate $code
-		if( empty( $code ) || !Language::isValidCode( $code ) || ( $code === 'qqq' ) ) {
-			wfDebug( "Invalid user language code\n" );
-			$code = $wgLanguageCode;
-		}
-
-		if( $code === $wgLanguageCode ) {
-			return $wgContLang;
-		} else {
-			$obj = Language::factory( $code );
-			return $obj;
-		}
+	/**
+	 * @return Language
+	 */
+	public function _newObject() {
+		return RequestContext::getMain()->getLanguage();
 	}
 }