X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/filerepo/ForeignDBRepo.php

diff --git a/includes/filerepo/ForeignDBRepo.php b/includes/filerepo/ForeignDBRepo.php
index a756703f..bce3005c 100644
--- a/includes/filerepo/ForeignDBRepo.php
+++ b/includes/filerepo/ForeignDBRepo.php
@@ -1,26 +1,70 @@
 <?php
 /**
- * A foreign repository with an accessible MediaWiki database
+ * A foreign repository with an accessible MediaWiki database.
+ *
+ * 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
  * @ingroup FileRepo
  */
 
+use Wikimedia\Rdbms\Database;
+use Wikimedia\Rdbms\IDatabase;
+
 /**
  * A foreign repository with an accessible MediaWiki database
  *
  * @ingroup FileRepo
  */
 class ForeignDBRepo extends LocalRepo {
-	# Settings
-	var $dbType, $dbServer, $dbUser, $dbPassword, $dbName, $dbFlags,
-		$tablePrefix, $hasSharedCache;
+	/** @var string */
+	protected $dbType;
+
+	/** @var string */
+	protected $dbServer;
+
+	/** @var string */
+	protected $dbUser;
+
+	/** @var string */
+	protected $dbPassword;
 
-	# Other stuff
-	var $dbConn;
-	var $fileFactory = array( 'ForeignDBFile', 'newFromTitle' );
-	var $fileFromRowFactory = array( 'ForeignDBFile', 'newFromRow' );
+	/** @var string */
+	protected $dbName;
 
+	/** @var string */
+	protected $dbFlags;
+
+	/** @var string */
+	protected $tablePrefix;
+
+	/** @var bool */
+	protected $hasSharedCache;
+
+	/** @var IDatabase */
+	protected $dbConn;
+
+	/** @var callable */
+	protected $fileFactory = [ 'ForeignDBFile', 'newFromTitle' ];
+	/** @var callable */
+	protected $fileFromRowFactory = [ 'ForeignDBFile', 'newFromRow' ];
+
+	/**
+	 * @param array|null $info
+	 */
 	function __construct( $info ) {
 		parent::__construct( $info );
 		$this->dbType = $info['dbType'];
@@ -33,52 +77,80 @@ class ForeignDBRepo extends LocalRepo {
 		$this->hasSharedCache = $info['hasSharedCache'];
 	}
 
+	/**
+	 * @return IDatabase
+	 */
 	function getMasterDB() {
 		if ( !isset( $this->dbConn ) ) {
-			$this->dbConn = DatabaseBase::newFromType( $this->dbType,
-				array(
-					'host' => $this->dbServer,
-					'user'   => $this->dbUser,
-					'password' => $this->dbPassword,
-					'dbname' => $this->dbName,
-					'flags' => $this->dbFlags,
-					'tableprefix' => $this->tablePrefix
-				)
-			);
+			$func = $this->getDBFactory();
+			$this->dbConn = $func( DB_MASTER );
 		}
+
 		return $this->dbConn;
 	}
 
-	function getSlaveDB() {
+	/**
+	 * @return IDatabase
+	 */
+	function getReplicaDB() {
 		return $this->getMasterDB();
 	}
 
+	/**
+	 * @return Closure
+	 */
+	protected function getDBFactory() {
+		$type = $this->dbType;
+		$params = [
+			'host' => $this->dbServer,
+			'user' => $this->dbUser,
+			'password' => $this->dbPassword,
+			'dbname' => $this->dbName,
+			'flags' => $this->dbFlags,
+			'tablePrefix' => $this->tablePrefix,
+			'foreign' => true,
+		];
+
+		return function ( $index ) use ( $type, $params ) {
+			return Database::factory( $type, $params );
+		};
+	}
+
+	/**
+	 * @return bool
+	 */
 	function hasSharedCache() {
 		return $this->hasSharedCache;
 	}
 
 	/**
 	 * Get a key on the primary cache for this repository.
-	 * Returns false if the repository's cache is not accessible at this site. 
+	 * Returns false if the repository's cache is not accessible at this site.
 	 * The parameters are the parts of the key, as for wfMemcKey().
+	 * @return bool|mixed
 	 */
 	function getSharedCacheKey( /*...*/ ) {
 		if ( $this->hasSharedCache() ) {
 			$args = func_get_args();
 			array_unshift( $args, $this->dbName, $this->tablePrefix );
+
 			return call_user_func_array( 'wfForeignMemcKey', $args );
 		} else {
 			return false;
 		}
 	}
 
-	function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
-		throw new MWException( get_class($this) . ': write operations are not supported' );
+	protected function assertWritableRepo() {
+		throw new MWException( static::class . ': write operations are not supported.' );
 	}
-	function publish( $srcPath, $dstRel, $archiveRel, $flags = 0 ) {
-		throw new MWException( get_class($this) . ': write operations are not supported' );
-	}
-	function deleteBatch( $sourceDestPairs ) {
-		throw new MWException( get_class($this) . ': write operations are not supported' );
+
+	/**
+	 * Return information about the repository.
+	 *
+	 * @return array
+	 * @since 1.22
+	 */
+	function getInfo() {
+		return FileRepo::getInfo();
 	}
 }