wikimedia/mediawiki-core

<?php

/**
 * 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
 *
 * Attribution notice: when this file was created, much of its content was taken
 * from the Revision.php file as present in release 1.30. Refer to the history
 * of that file for original authorship (that file was removed entirely in 1.37,
 * but its history can still be found in prior versions of MediaWiki).
 *
 * @file
 */

namespace MediaWiki\Revision;

use MediaWiki\CommentStore\CommentStore;
use MediaWiki\Content\IContentHandlerFactory;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Page\PageStoreFactory;
use MediaWiki\Storage\BlobStoreFactory;
use MediaWiki\Storage\NameTableStoreFactory;
use MediaWiki\Title\TitleFactory;
use MediaWiki\User\ActorStore;
use MediaWiki\User\ActorStoreFactory;
use Psr\Log\LoggerInterface;
use WANObjectCache;
use Wikimedia\Assert\Assert;
use Wikimedia\ObjectCache\BagOStuff;
use Wikimedia\Rdbms\ILBFactory;

/**
 * Factory service for RevisionStore instances. This allows RevisionStores to be created for
 * cross-wiki access.
 *
 * @warning Beware compatibility issues with schema migration in the context of cross-wiki access!
 * This class assumes that all wikis are at compatible migration stages for all relevant schemas.
 * Relevant schemas are: revision storage (MCR), the revision comment table, and the actor table.
 * Migration stages are compatible as long as a) there are no wikis in the cluster that only write
 * the old schema or b) there are no wikis that read only the new schema.
 *
 * @since 1.32
 */
class RevisionStoreFactory {

    /** @var BlobStoreFactory */
    private $blobStoreFactory;
    /** @var ILBFactory */
    private $dbLoadBalancerFactory;
    /** @var WANObjectCache */
    private $cache;
    /** @var BagOStuff */
    private $localCache;
    /** @var LoggerInterface */
    private $logger;

    /** @var CommentStore */
    private $commentStore;
    /** @var ActorStoreFactory */
    private $actorStoreFactory;
    /** @var NameTableStoreFactory */
    private $nameTables;

    /** @var SlotRoleRegistry */
    private $slotRoleRegistry;

    /** @var IContentHandlerFactory */
    private $contentHandlerFactory;

    /** @var PageStoreFactory */
    private $pageStoreFactory;

    /** @var TitleFactory */
    private $titleFactory;

    /** @var HookContainer */
    private $hookContainer;

    /**
     * @param ILBFactory $dbLoadBalancerFactory
     * @param BlobStoreFactory $blobStoreFactory
     * @param NameTableStoreFactory $nameTables
     * @param SlotRoleRegistry $slotRoleRegistry
     * @param WANObjectCache $cache
     * @param BagOStuff $localCache
     * @param CommentStore $commentStore
     * @param ActorStoreFactory $actorStoreFactory
     * @param LoggerInterface $logger
     * @param IContentHandlerFactory $contentHandlerFactory
     * @param PageStoreFactory $pageStoreFactory
     * @param TitleFactory $titleFactory
     * @param HookContainer $hookContainer
     */
    public function __construct(
        ILBFactory $dbLoadBalancerFactory,
        BlobStoreFactory $blobStoreFactory,
        NameTableStoreFactory $nameTables,
        SlotRoleRegistry $slotRoleRegistry,
        WANObjectCache $cache,
        BagOStuff $localCache,
        CommentStore $commentStore,
        ActorStoreFactory $actorStoreFactory,
        LoggerInterface $logger,
        IContentHandlerFactory $contentHandlerFactory,
        PageStoreFactory $pageStoreFactory,
        TitleFactory $titleFactory,
        HookContainer $hookContainer
    ) {
        $this->dbLoadBalancerFactory = $dbLoadBalancerFactory;
        $this->blobStoreFactory = $blobStoreFactory;
        $this->slotRoleRegistry = $slotRoleRegistry;
        $this->nameTables = $nameTables;
        $this->cache = $cache;
        $this->localCache = $localCache;
        $this->commentStore = $commentStore;
        $this->actorStoreFactory = $actorStoreFactory;
        $this->logger = $logger;
        $this->contentHandlerFactory = $contentHandlerFactory;
        $this->pageStoreFactory = $pageStoreFactory;
        $this->titleFactory = $titleFactory;
        $this->hookContainer = $hookContainer;
    }

    /**
     * @since 1.32
     *
     * @param false|string $dbDomain DB domain of the relevant wiki or false for the current one
     *
     * @return RevisionStore for the given wikiId with all necessary services
     */
    public function getRevisionStore( $dbDomain = false ): RevisionStore {
        return $this->getStore(
            $dbDomain,
            $this->actorStoreFactory->getActorStore( $dbDomain )
        );
    }

    /**
     * @since 1.42
     *
     * @param false|string $dbDomain DB domain of the relevant wiki or false for the current one
     *
     * @return RevisionStore for the given wikiId with all necessary services
     */
    public function getRevisionStoreForImport( $dbDomain = false ): RevisionStore {
        return $this->getStore(
            $dbDomain,
            $this->actorStoreFactory->getActorStoreForImport( $dbDomain )
        );
    }

    /**
     * @since 1.43
     *
     * @param false|string $dbDomain DB domain of the relevant wiki or false for the current one
     *
     * @return RevisionStore for the given wikiId with all necessary services
     */
    public function getRevisionStoreForUndelete( $dbDomain = false ): RevisionStore {
        return $this->getStore(
            $dbDomain,
            $this->actorStoreFactory->getActorStoreForUndelete( $dbDomain )
        );
    }

    /**
     * @param false|string $dbDomain
     * @param ActorStore $actorStore
     *
     * @return RevisionStore
     */
    private function getStore( $dbDomain, ActorStore $actorStore ) {
        Assert::parameterType( [ 'string', 'false' ], $dbDomain, '$dbDomain' );

        $store = new RevisionStore(
            $this->dbLoadBalancerFactory->getMainLB( $dbDomain ),
            $this->blobStoreFactory->newSqlBlobStore( $dbDomain ),
            $this->cache, // Pass cache local to wiki; Leave cache sharing to RevisionStore.
            $this->localCache,
            $this->commentStore,
            $this->nameTables->getContentModels( $dbDomain ),
            $this->nameTables->getSlotRoles( $dbDomain ),
            $this->slotRoleRegistry,
            $actorStore,
            $this->contentHandlerFactory,
            $this->pageStoreFactory->getPageStore( $dbDomain ),
            $this->titleFactory,
            $this->hookContainer,
            $dbDomain
        );

        $store->setLogger( $this->logger );

        return $store;
    }
}