Page MenuHomeWickedGov Phorge
Files F2753742

JobQueueGroupFactory.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

JobQueueGroupFactory.php
View Options

<?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\JobQueue;
use JobQueueGroup;
use LogicException;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\WikiMap\WikiMap;
use Wikimedia\ObjectCache\WANObjectCache;
use Wikimedia\Rdbms\ReadOnlyMode;
use Wikimedia\Stats\IBufferingStatsdDataFactory;
use Wikimedia\UUID\GlobalIdGenerator;
/**
* Factory for JobQueueGroup objects.
*
* @since 1.37
* @ingroup JobQueue
*/
class JobQueueGroupFactory {
/**
* @internal For use by ServiceWiring
*/
public const CONSTRUCTOR_OPTIONS = [
MainConfigNames::JobClasses,
MainConfigNames::JobTypeConf,
MainConfigNames::JobTypesExcludedFromDefaultQueue,
MainConfigNames::LocalDatabases,
];
/** @var JobQueueGroup[] */
private $instances;
/** @var ServiceOptions */
private $options;
/** @var ReadOnlyMode */
private $readOnlyMode;
/** @var IBufferingStatsdDataFactory */
private $statsdDataFactory;
/** @var WANObjectCache */
private $wanCache;
/** @var GlobalIdGenerator */
private $globalIdGenerator;
/**
* @param ServiceOptions $options
* @param ReadOnlyMode $readOnlyMode
* @param IBufferingStatsdDataFactory $statsdDataFactory
* @param WANObjectCache $wanCache
* @param GlobalIdGenerator $globalIdGenerator
*/
public function __construct(
ServiceOptions $options,
ReadOnlyMode $readOnlyMode,
IBufferingStatsdDataFactory $statsdDataFactory,
WANObjectCache $wanCache,
GlobalIdGenerator $globalIdGenerator
) {
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
$this->instances = [];
$this->options = $options;
$this->readOnlyMode = $readOnlyMode;
$this->statsdDataFactory = $statsdDataFactory;
$this->wanCache = $wanCache;
$this->globalIdGenerator = $globalIdGenerator;
}
/**
* @since 1.37
*
* @param false|string $domain Wiki domain ID. False uses the current wiki domain ID
* @return JobQueueGroup
*/
public function makeJobQueueGroup( $domain = false ): JobQueueGroup {
if ( $domain === false ) {
$domain = WikiMap::getCurrentWikiDbDomain()->getId();
}
// Make sure jobs are not getting pushed to bogus wikis. This can confuse
// the job runner system into spawning endless RPC requests that fail (T171371).
$wikiId = WikiMap::getWikiIdFromDbDomain( $domain );
if (
!WikiMap::isCurrentWikiDbDomain( $domain ) &&
!in_array( $wikiId, $this->options->get( MainConfigNames::LocalDatabases ) )
) {
// Do not enqueue job that cannot be run (T171371)
throw new LogicException( "Domain '{$domain}' is not recognized." );
}
$localJobClasses = WikiMap::isCurrentWikiDbDomain( $domain )
? $this->options->get( MainConfigNames::JobClasses )
: null;
if ( !isset( $this->instances[$domain] ) ) {
$this->instances[$domain] = new JobQueueGroup(
$domain,
$this->readOnlyMode,
$localJobClasses,
$this->options->get( MainConfigNames::JobTypeConf ),
$this->options->get( MainConfigNames::JobTypesExcludedFromDefaultQueue ),
$this->statsdDataFactory,
$this->wanCache,
$this->globalIdGenerator
);
}
return $this->instances[$domain];
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Jul 3, 21:40 (16 h, 30 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
9d/cd/0e2563e0472683a96b7015204889
Default Alt Text
JobQueueGroupFactory.php (3 KB)

Event Timeline