Update to MediaWiki 1.25.1

1 files changed, 8 insertions, 451 deletions

diff --git a/includes/site/SiteSQLStore.php b/includes/site/SiteSQLStore.php
index d1334680..d77f07be 100644
--- a/includes/site/SiteSQLStore.php
+++ b/includes/site/SiteSQLStore.php
@@ -28,468 +28,25 @@
  * @license GNU GPL v2+
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */
-class SiteSQLStore implements SiteStore {
-	/**
-	 * @since 1.21
-	 *
-	 * @var SiteList|null
-	 */
-	protected $sites = null;
-
-	/**
-	 * @var ORMTable
-	 */
-	protected $sitesTable;
-
-	/**
-	 * @var string|null
-	 */
-	private $cacheKey = null;
-
-	/**
-	 * @var int
-	 */
-	private $cacheTimeout = 3600;
+class SiteSQLStore extends CachingSiteStore {
 
 	/**
 	 * @since 1.21
+	 * @deprecated 1.25 Construct a SiteStore instance directly instead.
 	 *
 	 * @param ORMTable|null $sitesTable
+	 * @param BagOStuff|null $cache
 	 *
 	 * @return SiteStore
 	 */
-	public static function newInstance( ORMTable $sitesTable = null ) {
-		return new static( $sitesTable );
-	}
-
-	/**
-	 * Constructor.
-	 *
-	 * @since 1.21
-	 *
-	 * @param ORMTable|null $sitesTable
-	 */
-	protected function __construct( ORMTable $sitesTable = null ) {
-		if ( $sitesTable === null ) {
-			$sitesTable = $this->newSitesTable();
-		}
-
-		$this->sitesTable = $sitesTable;
-	}
-
-	/**
-	 * Constructs a cache key to use for caching the list of sites.
-	 *
-	 * This includes the concrete class name of the site list as well as a version identifier
-	 * for the list's serialization, to avoid problems when unserializing site lists serialized
-	 * by an older version, e.g. when reading from a cache.
-	 *
-	 * The cache key also includes information about where the sites were loaded from, e.g.
-	 * the name of a database table.
-	 *
-	 * @see SiteList::getSerialVersionId
-	 *
-	 * @return string The cache key.
-	 */
-	protected function getCacheKey() {
-		wfProfileIn( __METHOD__ );
-
-		if ( $this->cacheKey === null ) {
-			$type = 'SiteList#' . SiteList::getSerialVersionId();
-			$source = $this->sitesTable->getName();
-
-			if ( $this->sitesTable->getTargetWiki() !== false ) {
-				$source = $this->sitesTable->getTargetWiki() . '.' . $source;
-			}
-
-			$this->cacheKey = wfMemcKey( "$source/$type" );
-		}
-
-		wfProfileOut( __METHOD__ );
-		return $this->cacheKey;
-	}
-
-	/**
-	 * @see SiteStore::getSites
-	 *
-	 * @since 1.21
-	 *
-	 * @param string $source Either 'cache' or 'recache'
-	 *
-	 * @return SiteList
-	 */
-	public function getSites( $source = 'cache' ) {
-		wfProfileIn( __METHOD__ );
-
-		if ( $source === 'cache' ) {
-			if ( $this->sites === null ) {
-				$cache = wfGetMainCache();
-				$sites = $cache->get( $this->getCacheKey() );
-
-				if ( is_object( $sites ) ) {
-					$this->sites = $sites;
-				} else {
-					$this->loadSites();
-				}
-			}
-		}
-		else {
-			$this->loadSites();
-		}
-
-		wfProfileOut( __METHOD__ );
-		return $this->sites;
-	}
-
-	/**
-	 * Returns a new Site object constructed from the provided ORMRow.
-	 *
-	 * @since 1.21
-	 *
-	 * @param ORMRow $siteRow
-	 *
-	 * @return Site
-	 */
-	protected function siteFromRow( ORMRow $siteRow ) {
-		wfProfileIn( __METHOD__ );
-
-		$site = Site::newForType( $siteRow->getField( 'type', Site::TYPE_UNKNOWN ) );
-
-		$site->setGlobalId( $siteRow->getField( 'global_key' ) );
-
-		$site->setInternalId( $siteRow->getField( 'id' ) );
-
-		if ( $siteRow->hasField( 'forward' ) ) {
-			$site->setForward( $siteRow->getField( 'forward' ) );
-		}
-
-		if ( $siteRow->hasField( 'group' ) ) {
-			$site->setGroup( $siteRow->getField( 'group' ) );
-		}
-
-		if ( $siteRow->hasField( 'language' ) ) {
-			$site->setLanguageCode( $siteRow->getField( 'language' ) === ''
-				? null
-				: $siteRow->getField( 'language' )
-			);
-		}
-
-		if ( $siteRow->hasField( 'source' ) ) {
-			$site->setSource( $siteRow->getField( 'source' ) );
-		}
-
-		if ( $siteRow->hasField( 'data' ) ) {
-			$site->setExtraData( $siteRow->getField( 'data' ) );
-		}
-
-		if ( $siteRow->hasField( 'config' ) ) {
-			$site->setExtraConfig( $siteRow->getField( 'config' ) );
-		}
-
-		wfProfileOut( __METHOD__ );
-		return $site;
-	}
-
-	/**
-	 * Get a new ORMRow from a Site object
-	 *
-	 * @since 1.22
-	 *
-	 * @param Site $site
-	 *
-	 * @return ORMRow
-	 */
-	protected function getRowFromSite( Site $site ) {
-		$fields = array(
-			// Site data
-			'global_key' => $site->getGlobalId(), // TODO: check not null
-			'type' => $site->getType(),
-			'group' => $site->getGroup(),
-			'source' => $site->getSource(),
-			'language' => $site->getLanguageCode() === null ? '' : $site->getLanguageCode(),
-			'protocol' => $site->getProtocol(),
-			'domain' => strrev( $site->getDomain() ) . '.',
-			'data' => $site->getExtraData(),
-
-			// Site config
-			'forward' => $site->shouldForward(),
-			'config' => $site->getExtraConfig(),
-		);
-
-		if ( $site->getInternalId() !== null ) {
-			$fields['id'] = $site->getInternalId();
-		}
-
-		return new ORMRow( $this->sitesTable, $fields );
-	}
-
-	/**
-	 * Fetches the site from the database and loads them into the sites field.
-	 *
-	 * @since 1.21
-	 */
-	protected function loadSites() {
-		wfProfileIn( __METHOD__ );
-
-		$this->sites = new SiteList();
-
-		foreach ( $this->sitesTable->select() as $siteRow ) {
-			$this->sites[] = $this->siteFromRow( $siteRow );
-		}
-
-		// Batch load the local site identifiers.
-		$ids = wfGetDB( $this->sitesTable->getReadDb() )->select(
-			'site_identifiers',
-			array(
-				'si_site',
-				'si_type',
-				'si_key',
-			),
-			array(),
-			__METHOD__
-		);
-
-		foreach ( $ids as $id ) {
-			if ( $this->sites->hasInternalId( $id->si_site ) ) {
-				$site = $this->sites->getSiteByInternalId( $id->si_site );
-				$site->addLocalId( $id->si_type, $id->si_key );
-				$this->sites->setSite( $site );
-			}
-		}
-
-		$cache = wfGetMainCache();
-		$cache->set( $this->getCacheKey(), $this->sites, $this->cacheTimeout );
-
-		wfProfileOut( __METHOD__ );
-	}
-
-	/**
-	 * @see SiteStore::getSite
-	 *
-	 * @since 1.21
-	 *
-	 * @param string $globalId
-	 * @param string $source
-	 *
-	 * @return Site|null
-	 */
-	public function getSite( $globalId, $source = 'cache' ) {
-		wfProfileIn( __METHOD__ );
-
-		$sites = $this->getSites( $source );
-
-		wfProfileOut( __METHOD__ );
-		return $sites->hasSite( $globalId ) ? $sites->getSite( $globalId ) : null;
-	}
-
-	/**
-	 * @see SiteStore::saveSite
-	 *
-	 * @since 1.21
-	 *
-	 * @param Site $site
-	 *
-	 * @return bool Success indicator
-	 */
-	public function saveSite( Site $site ) {
-		return $this->saveSites( array( $site ) );
-	}
-
-	/**
-	 * @see SiteStore::saveSites
-	 *
-	 * @since 1.21
-	 *
-	 * @param Site[] $sites
-	 *
-	 * @return bool Success indicator
-	 */
-	public function saveSites( array $sites ) {
-		wfProfileIn( __METHOD__ );
-
-		if ( empty( $sites ) ) {
-			wfProfileOut( __METHOD__ );
-			return true;
-		}
-
-		$dbw = $this->sitesTable->getWriteDbConnection();
-
-		$dbw->startAtomic( __METHOD__ );
-
-		$success = true;
-
-		$internalIds = array();
-		$localIds = array();
-
-		foreach ( $sites as $site ) {
-			if ( $site->getInternalId() !== null ) {
-				$internalIds[] = $site->getInternalId();
-			}
-
-			$siteRow = $this->getRowFromSite( $site );
-			$success = $siteRow->save( __METHOD__ ) && $success;
-
-			foreach ( $site->getLocalIds() as $idType => $ids ) {
-				foreach ( $ids as $id ) {
-					$localIds[] = array( $siteRow->getId(), $idType, $id );
-				}
-			}
-		}
-
-		if ( $internalIds !== array() ) {
-			$dbw->delete(
-				'site_identifiers',
-				array( 'si_site' => $internalIds ),
-				__METHOD__
-			);
-		}
-
-		foreach ( $localIds as $localId ) {
-			$dbw->insert(
-				'site_identifiers',
-				array(
-					'si_site' => $localId[0],
-					'si_type' => $localId[1],
-					'si_key' => $localId[2],
-				),
-				__METHOD__
-			);
+	public static function newInstance( ORMTable $sitesTable = null, BagOStuff $cache = null ) {
+		if ( $cache === null ) {
+			$cache = wfGetMainCache();
 		}
 
-		$dbw->endAtomic( __METHOD__ );
+		$siteStore = new DBSiteStore();
 
-		// purge cache
-		$this->reset();
-
-		wfProfileOut( __METHOD__ );
-		return $success;
+		return new static( $siteStore, $cache );
 	}
 
-	/**
-	 * Purges the internal and external cache of the site list, forcing the list
-	 * of sites to be re-read from the database.
-	 *
-	 * @since 1.21
-	 */
-	public function reset() {
-		wfProfileIn( __METHOD__ );
-		// purge cache
-		$cache = wfGetMainCache();
-		$cache->delete( $this->getCacheKey() );
-		$this->sites = null;
-
-		wfProfileOut( __METHOD__ );
-	}
-
-	/**
-	 * Clears the list of sites stored in the database.
-	 *
-	 * @see SiteStore::clear()
-	 *
-	 * @return bool Success
-	 */
-	public function clear() {
-		wfProfileIn( __METHOD__ );
-		$dbw = $this->sitesTable->getWriteDbConnection();
-
-		$dbw->startAtomic( __METHOD__ );
-		$ok = $dbw->delete( 'sites', '*', __METHOD__ );
-		$ok = $dbw->delete( 'site_identifiers', '*', __METHOD__ ) && $ok;
-		$dbw->endAtomic( __METHOD__);
-
-		$this->reset();
-
-		wfProfileOut( __METHOD__ );
-		return $ok;
-	}
-
-	/**
-	 * @since 1.21
-	 *
-	 * @return ORMTable
-	 */
-	protected function newSitesTable() {
-		return new ORMTable(
-			'sites',
-			array(
-				'id' => 'id',
-
-				// Site data
-				'global_key' => 'str',
-				'type' => 'str',
-				'group' => 'str',
-				'source' => 'str',
-				'language' => 'str',
-				'protocol' => 'str',
-				'domain' => 'str',
-				'data' => 'array',
-
-				// Site config
-				'forward' => 'bool',
-				'config' => 'array',
-			),
-			array(
-				'type' => Site::TYPE_UNKNOWN,
-				'group' => Site::GROUP_NONE,
-				'source' => Site::SOURCE_LOCAL,
-				'data' => array(),
-
-				'forward' => false,
-				'config' => array(),
-				'language' => '',
-			),
-			'ORMRow',
-			'site_'
-		);
-	}
-
-}
-
-/**
- * @deprecated since 1.21
- */
-class Sites extends SiteSQLStore {
-
-	/**
-	 * Factory for creating new site objects.
-	 *
-	 * @since 1.21
-	 * @deprecated since 1.21
-	 *
-	 * @param string|bool $globalId
-	 *
-	 * @return Site
-	 */
-	public static function newSite( $globalId = false ) {
-		$site = new Site();
-
-		if ( $globalId !== false ) {
-			$site->setGlobalId( $globalId );
-		}
-
-		return $site;
-	}
-
-	/**
-	 * @deprecated since 1.21
-	 * @return SiteStore
-	 */
-	public static function singleton() {
-		static $singleton;
-
-		if ( $singleton === null ) {
-			$singleton = new static();
-		}
-
-		return $singleton;
-	}
-
-	/**
-	 * @deprecated since 1.21
-	 * @param string $group
-	 * @return SiteList
-	 */
-	public function getSiteGroup( $group ) {
-		return $this->getSites()->getGroup( $group );
-	}
 }