ef52ed41bb
The DatabaseBlockStoreFactory is a new service which allows fetching of a wiki-specific DatabaseBlockStore by fetching the correct LoadBalancer via a LBFactory and then injecting it into the DatabaseBlockStore. It also creates a wiki-specific ReadOnlyMode and BlockRestrictionStore, which are also being injected. This is being done as a part of the project of supporting cross-wiki blocking. The future plan is that BlockUser and UnblockUser are being updated to properly support creating, updating and deleting cross-wiki blocks. BlockUser and UnblockUser are then going to use a newly injected DatabaseBlockStoreFactory to fetch the correct DatabaseBlockStore to then insert/update/remove the block into/from the correct database. Bug: T291849 Change-Id: I1051beedfd67c4e2c546b9eec04b6d592d969af3
136 lines
4 KiB
PHP
136 lines
4 KiB
PHP
<?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
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\Block;
|
|
|
|
use ConfiguredReadOnlyMode;
|
|
use MediaWiki\CommentStore\CommentStore;
|
|
use MediaWiki\Config\ServiceOptions;
|
|
use MediaWiki\HookContainer\HookContainer;
|
|
use MediaWiki\User\ActorStoreFactory;
|
|
use MediaWiki\User\UserFactory;
|
|
use Psr\Log\LoggerInterface;
|
|
use ReadOnlyMode;
|
|
use Wikimedia\Rdbms\LBFactory;
|
|
|
|
/**
|
|
* @author Zabe
|
|
*
|
|
* @since 1.40
|
|
*/
|
|
class DatabaseBlockStoreFactory {
|
|
/**
|
|
* @internal For use by ServiceWiring
|
|
*/
|
|
public const CONSTRUCTOR_OPTIONS = DatabaseBlockStore::CONSTRUCTOR_OPTIONS;
|
|
|
|
/** @var ServiceOptions */
|
|
private $options;
|
|
|
|
/** @var LoggerInterface */
|
|
private $logger;
|
|
|
|
/** @var ActorStoreFactory */
|
|
private $actorStoreFactory;
|
|
|
|
/** @var BlockRestrictionStoreFactory */
|
|
private $blockRestrictionStoreFactory;
|
|
|
|
/** @var CommentStore */
|
|
private $commentStore;
|
|
|
|
/** @var HookContainer */
|
|
private $hookContainer;
|
|
|
|
/** @var LBFactory */
|
|
private $loadBalancerFactory;
|
|
|
|
/** @var ConfiguredReadOnlyMode */
|
|
private $configuredReadOnlyMode;
|
|
|
|
/** @var UserFactory */
|
|
private $userFactory;
|
|
|
|
/** @var DatabaseBlockStore[] */
|
|
private $storeCache = [];
|
|
|
|
/**
|
|
* @param ServiceOptions $options
|
|
* @param LoggerInterface $logger
|
|
* @param ActorStoreFactory $actorStoreFactory
|
|
* @param BlockRestrictionStoreFactory $blockRestrictionStoreFactory
|
|
* @param CommentStore $commentStore
|
|
* @param HookContainer $hookContainer
|
|
* @param LBFactory $loadBalancerFactory
|
|
* @param ConfiguredReadOnlyMode $configuredReadOnlyMode
|
|
* @param UserFactory $userFactory
|
|
*/
|
|
public function __construct(
|
|
ServiceOptions $options,
|
|
LoggerInterface $logger,
|
|
ActorStoreFactory $actorStoreFactory,
|
|
BlockRestrictionStoreFactory $blockRestrictionStoreFactory,
|
|
CommentStore $commentStore,
|
|
HookContainer $hookContainer,
|
|
LBFactory $loadBalancerFactory,
|
|
ConfiguredReadOnlyMode $configuredReadOnlyMode,
|
|
UserFactory $userFactory
|
|
) {
|
|
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
|
|
|
|
$this->options = $options;
|
|
$this->logger = $logger;
|
|
$this->actorStoreFactory = $actorStoreFactory;
|
|
$this->blockRestrictionStoreFactory = $blockRestrictionStoreFactory;
|
|
$this->commentStore = $commentStore;
|
|
$this->hookContainer = $hookContainer;
|
|
$this->loadBalancerFactory = $loadBalancerFactory;
|
|
$this->configuredReadOnlyMode = $configuredReadOnlyMode;
|
|
$this->userFactory = $userFactory;
|
|
}
|
|
|
|
/**
|
|
* @param string|false $wikiId
|
|
* @return DatabaseBlockStore
|
|
*/
|
|
public function getDatabaseBlockStore( $wikiId = DatabaseBlock::LOCAL ): DatabaseBlockStore {
|
|
if ( is_string( $wikiId ) && $this->loadBalancerFactory->getLocalDomainID() === $wikiId ) {
|
|
$wikiId = DatabaseBlock::LOCAL;
|
|
}
|
|
|
|
$storeCacheKey = $wikiId === DatabaseBlock::LOCAL ? 'LOCAL' : 'crosswikistore-' . $wikiId;
|
|
if ( !isset( $this->storeCache[$storeCacheKey] ) ) {
|
|
$loadBalancer = $this->loadBalancerFactory->getMainLB( $wikiId );
|
|
$this->storeCache[$storeCacheKey] = new DatabaseBlockStore(
|
|
$this->options,
|
|
$this->logger,
|
|
$this->actorStoreFactory,
|
|
$this->blockRestrictionStoreFactory->getBlockRestrictionStore( $wikiId ),
|
|
$this->commentStore,
|
|
$this->hookContainer,
|
|
$loadBalancer,
|
|
new ReadOnlyMode( $this->configuredReadOnlyMode, $loadBalancer ),
|
|
$this->userFactory,
|
|
$wikiId
|
|
);
|
|
}
|
|
return $this->storeCache[$storeCacheKey];
|
|
}
|
|
}
|