MediaWiki
master
Toggle main menu visibility
JobQueueGroupFactory.php
Go to the documentation of this file.
1
<?php
6
7
namespace
MediaWiki\JobQueue;
8
9
use LogicException;
10
use MediaWiki\Config\ServiceOptions;
11
use MediaWiki\MainConfigNames;
12
use MediaWiki\WikiMap\WikiMap;
13
use Wikimedia\ObjectCache\BagOStuff;
14
use Wikimedia\Rdbms\ReadOnlyMode;
15
use Wikimedia\Stats\StatsFactory;
16
use Wikimedia\UUID\GlobalIdGenerator;
17
24
class
JobQueueGroupFactory
{
28
public
const
CONSTRUCTOR_OPTIONS
= [
29
MainConfigNames::JobClasses
,
30
MainConfigNames::JobTypeConf
,
31
MainConfigNames::JobTypesExcludedFromDefaultQueue
,
32
MainConfigNames::LocalDatabases
,
33
];
34
36
private
$instances;
37
39
private
$options;
40
42
private
$readOnlyMode;
43
45
private
$statsFactory;
46
48
private
$localClusterCache;
49
51
private
$globalIdGenerator;
52
60
public
function
__construct
(
61
ServiceOptions
$options,
62
ReadOnlyMode
$readOnlyMode,
63
StatsFactory
$statsFactory,
64
BagOStuff
$localClusterCache,
65
GlobalIdGenerator
$globalIdGenerator
66
) {
67
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
68
$this->instances = [];
69
$this->options = $options;
70
$this->readOnlyMode = $readOnlyMode;
71
$this->statsFactory = $statsFactory;
72
$this->localClusterCache = $localClusterCache;
73
$this->globalIdGenerator = $globalIdGenerator;
74
}
75
82
public
function
makeJobQueueGroup
( $domain =
false
):
JobQueueGroup
{
83
if
( $domain === false ) {
84
$domain = WikiMap::getCurrentWikiDbDomain()->getId();
85
}
86
87
// Make sure jobs are not getting pushed to bogus wikis. This can confuse
88
// the job runner system into spawning endless RPC requests that fail (T171371).
89
$isCurrentWiki = WikiMap::isCurrentWikiDbDomain( $domain );
90
if
( !$isCurrentWiki ) {
91
$wikiId = WikiMap::getWikiIdFromDbDomain( $domain );
92
if
( !in_array( $wikiId, $this->options->get(
MainConfigNames::LocalDatabases
) ) ) {
93
// Do not enqueue job that cannot be run (T171371)
94
throw
new
LogicException(
"Domain '{$domain}' is not recognized."
);
95
}
96
}
97
98
if
( !isset( $this->instances[$domain] ) ) {
99
$localJobClasses = $isCurrentWiki
100
? $this->options->get(
MainConfigNames::JobClasses
)
101
:
null
;
102
103
$this->instances[$domain] =
new
JobQueueGroup(
104
$domain,
105
$this->readOnlyMode,
106
$localJobClasses,
107
$this->options->get(
MainConfigNames::JobTypeConf
),
108
$this->options->get(
MainConfigNames::JobTypesExcludedFromDefaultQueue
),
109
$this->statsFactory,
110
$this->localClusterCache,
111
$this->globalIdGenerator
112
);
113
}
114
115
return
$this->instances[$domain];
116
}
117
}
if
if(!defined('MW_SETUP_CALLBACK'))
Definition
WebStart.php:72
MediaWiki\Config\ServiceOptions
A class for passing options to services.
Definition
ServiceOptions.php:27
MediaWiki\JobQueue\JobQueueGroupFactory
Factory for JobQueueGroup objects.
Definition
JobQueueGroupFactory.php:24
MediaWiki\JobQueue\JobQueueGroupFactory\CONSTRUCTOR_OPTIONS
const CONSTRUCTOR_OPTIONS
Definition
JobQueueGroupFactory.php:28
MediaWiki\JobQueue\JobQueueGroupFactory\__construct
__construct(ServiceOptions $options, ReadOnlyMode $readOnlyMode, StatsFactory $statsFactory, BagOStuff $localClusterCache, GlobalIdGenerator $globalIdGenerator)
Definition
JobQueueGroupFactory.php:60
MediaWiki\JobQueue\JobQueueGroupFactory\makeJobQueueGroup
makeJobQueueGroup( $domain=false)
Definition
JobQueueGroupFactory.php:82
MediaWiki\JobQueue\JobQueueGroup
Handle enqueueing of background jobs.
Definition
JobQueueGroup.php:31
MediaWiki\MainConfigNames\JobTypeConf
const JobTypeConf
Name constant for the JobTypeConf setting, for use with Config\get().
Definition
MainConfigNames.php:4107
MediaWiki\MainConfigNames\LocalDatabases
const LocalDatabases
Name constant for the LocalDatabases setting, for use with Config\get().
Definition
MainConfigNames.php:1242
MediaWiki\MainConfigNames\JobClasses
const JobClasses
Name constant for the JobClasses setting, for use with Config\get().
Definition
MainConfigNames.php:4089
MediaWiki\MainConfigNames\JobTypesExcludedFromDefaultQueue
const JobTypesExcludedFromDefaultQueue
Name constant for the JobTypesExcludedFromDefaultQueue setting, for use with Config\get().
Definition
MainConfigNames.php:4095
Wikimedia\ObjectCache\BagOStuff
Abstract class for any ephemeral data store.
Definition
BagOStuff.php:73
Wikimedia\Rdbms\ReadOnlyMode
Determine whether a site is currently in read-only mode.
Definition
ReadOnlyMode.php:12
Wikimedia\Stats\StatsFactory
This is the primary interface for validating metrics definitions, caching defined metrics,...
Definition
StatsFactory.php:33
Wikimedia\UUID\GlobalIdGenerator
Class for getting statistically unique IDs without a central coordinator.
Definition
GlobalIdGenerator.php:20
includes
JobQueue
JobQueueGroupFactory.php
Generated on
for MediaWiki by
1.18.0