MediaWiki  REL1_31
JobQueueFederated.php
Go to the documentation of this file.
1 <?php
48 class JobQueueFederated extends JobQueue {
50  protected $partitionRing;
52  protected $partitionQueues = [];
53 
55  protected $maxPartitionsTry;
56 
74  protected function __construct( array $params ) {
75  parent::__construct( $params );
76  $section = isset( $params['sectionsByWiki'][$this->wiki] )
77  ? $params['sectionsByWiki'][$this->wiki]
78  : 'default';
79  if ( !isset( $params['partitionsBySection'][$section] ) ) {
80  throw new MWException( "No configuration for section '$section'." );
81  }
82  $this->maxPartitionsTry = isset( $params['maxPartitionsTry'] )
83  ? $params['maxPartitionsTry']
84  : 2;
85  // Get the full partition map
86  $partitionMap = $params['partitionsBySection'][$section];
87  arsort( $partitionMap, SORT_NUMERIC );
88  // Get the config to pass to merge into each partition queue config
89  $baseConfig = $params;
90  foreach ( [ 'class', 'sectionsByWiki', 'maxPartitionsTry',
91  'partitionsBySection', 'configByPartition', ] as $o
92  ) {
93  unset( $baseConfig[$o] ); // partition queue doesn't care about this
94  }
95  // The class handles all aggregator calls already
96  unset( $baseConfig['aggregator'] );
97  // Get the partition queue objects
98  foreach ( $partitionMap as $partition => $w ) {
99  if ( !isset( $params['configByPartition'][$partition] ) ) {
100  throw new MWException( "No configuration for partition '$partition'." );
101  }
102  $this->partitionQueues[$partition] = JobQueue::factory(
103  $baseConfig + $params['configByPartition'][$partition] );
104  }
105  // Ring of all partitions
106  $this->partitionRing = new HashRing( $partitionMap );
107  }
108 
109  protected function supportedOrders() {
110  // No FIFO due to partitioning, though "rough timestamp order" is supported
111  return [ 'undefined', 'random', 'timestamp' ];
112  }
113 
114  protected function optimalOrder() {
115  return 'undefined'; // defer to the partitions
116  }
117 
118  protected function supportsDelayedJobs() {
119  foreach ( $this->partitionQueues as $queue ) {
120  if ( !$queue->supportsDelayedJobs() ) {
121  return false;
122  }
123  }
124 
125  return true;
126  }
127 
128  protected function doIsEmpty() {
129  $empty = true;
130  $failed = 0;
131  foreach ( $this->partitionQueues as $queue ) {
132  try {
133  $empty = $empty && $queue->doIsEmpty();
134  } catch ( JobQueueError $e ) {
135  ++$failed;
136  $this->logException( $e );
137  }
138  }
139  $this->throwErrorIfAllPartitionsDown( $failed );
140 
141  return $empty;
142  }
143 
144  protected function doGetSize() {
145  return $this->getCrossPartitionSum( 'size', 'doGetSize' );
146  }
147 
148  protected function doGetAcquiredCount() {
149  return $this->getCrossPartitionSum( 'acquiredcount', 'doGetAcquiredCount' );
150  }
151 
152  protected function doGetDelayedCount() {
153  return $this->getCrossPartitionSum( 'delayedcount', 'doGetDelayedCount' );
154  }
155 
156  protected function doGetAbandonedCount() {
157  return $this->getCrossPartitionSum( 'abandonedcount', 'doGetAbandonedCount' );
158  }
159 
165  protected function getCrossPartitionSum( $type, $method ) {
166  $count = 0;
167  $failed = 0;
168  foreach ( $this->partitionQueues as $queue ) {
169  try {
170  $count += $queue->$method();
171  } catch ( JobQueueError $e ) {
172  ++$failed;
173  $this->logException( $e );
174  }
175  }
176  $this->throwErrorIfAllPartitionsDown( $failed );
177 
178  return $count;
179  }
180 
181  protected function doBatchPush( array $jobs, $flags ) {
182  // Local ring variable that may be changed to point to a new ring on failure
184  // Try to insert the jobs and update $partitionsTry on any failures.
185  // Retry to insert any remaning jobs again, ignoring the bad partitions.
186  $jobsLeft = $jobs;
187  // phpcs:ignore Generic.CodeAnalysis.ForLoopWithTestFunctionCall
188  for ( $i = $this->maxPartitionsTry; $i > 0 && count( $jobsLeft ); --$i ) {
189  try {
191  } catch ( UnexpectedValueException $e ) {
192  break; // all servers down; nothing to insert to
193  }
194  $jobsLeft = $this->tryJobInsertions( $jobsLeft, $partitionRing, $flags );
195  }
196  if ( count( $jobsLeft ) ) {
197  throw new JobQueueError(
198  "Could not insert job(s), {$this->maxPartitionsTry} partitions tried." );
199  }
200  }
201 
209  protected function tryJobInsertions( array $jobs, HashRing &$partitionRing, $flags ) {
210  $jobsLeft = [];
211 
212  // Because jobs are spread across partitions, per-job de-duplication needs
213  // to use a consistent hash to avoid allowing duplicate jobs per partition.
214  // When inserting a batch of de-duplicated jobs, QOS_ATOMIC is disregarded.
215  $uJobsByPartition = []; // (partition name => job list)
217  foreach ( $jobs as $key => $job ) {
218  if ( $job->ignoreDuplicates() ) {
219  $sha1 = sha1( serialize( $job->getDeduplicationInfo() ) );
220  $uJobsByPartition[$partitionRing->getLiveLocation( $sha1 )][] = $job;
221  unset( $jobs[$key] );
222  }
223  }
224  // Get the batches of jobs that are not de-duplicated
225  if ( $flags & self::QOS_ATOMIC ) {
226  $nuJobBatches = [ $jobs ]; // all or nothing
227  } else {
228  // Split the jobs into batches and spread them out over servers if there
229  // are many jobs. This helps keep the partitions even. Otherwise, send all
230  // the jobs to a single partition queue to avoids the extra connections.
231  $nuJobBatches = array_chunk( $jobs, 300 );
232  }
233 
234  // Insert the de-duplicated jobs into the queues...
235  foreach ( $uJobsByPartition as $partition => $jobBatch ) {
237  $queue = $this->partitionQueues[$partition];
238  try {
239  $ok = true;
240  $queue->doBatchPush( $jobBatch, $flags | self::QOS_ATOMIC );
241  } catch ( JobQueueError $e ) {
242  $ok = false;
243  $this->logException( $e );
244  }
245  if ( !$ok ) {
246  if ( !$partitionRing->ejectFromLiveRing( $partition, 5 ) ) { // blacklist
247  throw new JobQueueError( "Could not insert job(s), no partitions available." );
248  }
249  $jobsLeft = array_merge( $jobsLeft, $jobBatch ); // not inserted
250  }
251  }
252 
253  // Insert the jobs that are not de-duplicated into the queues...
254  foreach ( $nuJobBatches as $jobBatch ) {
256  $queue = $this->partitionQueues[$partition];
257  try {
258  $ok = true;
259  $queue->doBatchPush( $jobBatch, $flags | self::QOS_ATOMIC );
260  } catch ( JobQueueError $e ) {
261  $ok = false;
262  $this->logException( $e );
263  }
264  if ( !$ok ) {
265  if ( !$partitionRing->ejectFromLiveRing( $partition, 5 ) ) { // blacklist
266  throw new JobQueueError( "Could not insert job(s), no partitions available." );
267  }
268  $jobsLeft = array_merge( $jobsLeft, $jobBatch ); // not inserted
269  }
270  }
271 
272  return $jobsLeft;
273  }
274 
275  protected function doPop() {
276  $partitionsTry = $this->partitionRing->getLiveLocationWeights(); // (partition => weight)
277 
278  $failed = 0;
279  while ( count( $partitionsTry ) ) {
280  $partition = ArrayUtils::pickRandom( $partitionsTry );
281  if ( $partition === false ) {
282  break; // all partitions at 0 weight
283  }
284 
286  $queue = $this->partitionQueues[$partition];
287  try {
288  $job = $queue->pop();
289  } catch ( JobQueueError $e ) {
290  ++$failed;
291  $this->logException( $e );
292  $job = false;
293  }
294  if ( $job ) {
295  $job->metadata['QueuePartition'] = $partition;
296 
297  return $job;
298  } else {
299  unset( $partitionsTry[$partition] ); // blacklist partition
300  }
301  }
302  $this->throwErrorIfAllPartitionsDown( $failed );
303 
304  return false;
305  }
306 
307  protected function doAck( Job $job ) {
308  if ( !isset( $job->metadata['QueuePartition'] ) ) {
309  throw new MWException( "The given job has no defined partition name." );
310  }
311 
312  $this->partitionQueues[$job->metadata['QueuePartition']]->ack( $job );
313  }
314 
315  protected function doIsRootJobOldDuplicate( Job $job ) {
316  $signature = $job->getRootJobParams()['rootJobSignature'];
317  $partition = $this->partitionRing->getLiveLocation( $signature );
318  try {
319  return $this->partitionQueues[$partition]->doIsRootJobOldDuplicate( $job );
320  } catch ( JobQueueError $e ) {
321  if ( $this->partitionRing->ejectFromLiveRing( $partition, 5 ) ) {
322  $partition = $this->partitionRing->getLiveLocation( $signature );
323  return $this->partitionQueues[$partition]->doIsRootJobOldDuplicate( $job );
324  }
325  }
326 
327  return false;
328  }
329 
331  $signature = $job->getRootJobParams()['rootJobSignature'];
332  $partition = $this->partitionRing->getLiveLocation( $signature );
333  try {
334  return $this->partitionQueues[$partition]->doDeduplicateRootJob( $job );
335  } catch ( JobQueueError $e ) {
336  if ( $this->partitionRing->ejectFromLiveRing( $partition, 5 ) ) {
337  $partition = $this->partitionRing->getLiveLocation( $signature );
338  return $this->partitionQueues[$partition]->doDeduplicateRootJob( $job );
339  }
340  }
341 
342  return false;
343  }
344 
345  protected function doDelete() {
346  $failed = 0;
348  foreach ( $this->partitionQueues as $queue ) {
349  try {
350  $queue->doDelete();
351  } catch ( JobQueueError $e ) {
352  ++$failed;
353  $this->logException( $e );
354  }
355  }
356  $this->throwErrorIfAllPartitionsDown( $failed );
357  return true;
358  }
359 
360  protected function doWaitForBackups() {
361  $failed = 0;
363  foreach ( $this->partitionQueues as $queue ) {
364  try {
365  $queue->waitForBackups();
366  } catch ( JobQueueError $e ) {
367  ++$failed;
368  $this->logException( $e );
369  }
370  }
371  $this->throwErrorIfAllPartitionsDown( $failed );
372  }
373 
374  protected function doFlushCaches() {
376  foreach ( $this->partitionQueues as $queue ) {
377  $queue->doFlushCaches();
378  }
379  }
380 
381  public function getAllQueuedJobs() {
382  $iterator = new AppendIterator();
383 
385  foreach ( $this->partitionQueues as $queue ) {
386  $iterator->append( $queue->getAllQueuedJobs() );
387  }
388 
389  return $iterator;
390  }
391 
392  public function getAllDelayedJobs() {
393  $iterator = new AppendIterator();
394 
396  foreach ( $this->partitionQueues as $queue ) {
397  $iterator->append( $queue->getAllDelayedJobs() );
398  }
399 
400  return $iterator;
401  }
402 
403  public function getAllAcquiredJobs() {
404  $iterator = new AppendIterator();
405 
407  foreach ( $this->partitionQueues as $queue ) {
408  $iterator->append( $queue->getAllAcquiredJobs() );
409  }
410 
411  return $iterator;
412  }
413 
414  public function getAllAbandonedJobs() {
415  $iterator = new AppendIterator();
416 
418  foreach ( $this->partitionQueues as $queue ) {
419  $iterator->append( $queue->getAllAbandonedJobs() );
420  }
421 
422  return $iterator;
423  }
424 
425  public function getCoalesceLocationInternal() {
426  return "JobQueueFederated:wiki:{$this->wiki}" .
427  sha1( serialize( array_keys( $this->partitionQueues ) ) );
428  }
429 
430  protected function doGetSiblingQueuesWithJobs( array $types ) {
431  $result = [];
432 
433  $failed = 0;
435  foreach ( $this->partitionQueues as $queue ) {
436  try {
437  $nonEmpty = $queue->doGetSiblingQueuesWithJobs( $types );
438  if ( is_array( $nonEmpty ) ) {
439  $result = array_unique( array_merge( $result, $nonEmpty ) );
440  } else {
441  return null; // not supported on all partitions; bail
442  }
443  if ( count( $result ) == count( $types ) ) {
444  break; // short-circuit
445  }
446  } catch ( JobQueueError $e ) {
447  ++$failed;
448  $this->logException( $e );
449  }
450  }
451  $this->throwErrorIfAllPartitionsDown( $failed );
452 
453  return array_values( $result );
454  }
455 
456  protected function doGetSiblingQueueSizes( array $types ) {
457  $result = [];
458  $failed = 0;
460  foreach ( $this->partitionQueues as $queue ) {
461  try {
462  $sizes = $queue->doGetSiblingQueueSizes( $types );
463  if ( is_array( $sizes ) ) {
464  foreach ( $sizes as $type => $size ) {
465  $result[$type] = isset( $result[$type] ) ? $result[$type] + $size : $size;
466  }
467  } else {
468  return null; // not supported on all partitions; bail
469  }
470  } catch ( JobQueueError $e ) {
471  ++$failed;
472  $this->logException( $e );
473  }
474  }
475  $this->throwErrorIfAllPartitionsDown( $failed );
476 
477  return $result;
478  }
479 
480  protected function logException( Exception $e ) {
481  wfDebugLog( 'JobQueueFederated', $e->getMessage() . "\n" . $e->getTraceAsString() );
482  }
483 
491  protected function throwErrorIfAllPartitionsDown( $down ) {
492  if ( $down >= count( $this->partitionQueues ) ) {
493  throw new JobQueueError( 'No queue partitions available.' );
494  }
495  }
496 }
JobQueueFederated\throwErrorIfAllPartitionsDown
throwErrorIfAllPartitionsDown( $down)
Throw an error if no partitions available.
Definition: JobQueueFederated.php:491
JobQueueFederated\doFlushCaches
doFlushCaches()
Definition: JobQueueFederated.php:374
JobQueueFederated\doPop
doPop()
Definition: JobQueueFederated.php:275
array
the array() calling protocol came about after MediaWiki 1.4rc1.
JobQueueFederated\doIsEmpty
doIsEmpty()
Definition: JobQueueFederated.php:128
JobQueueFederated\getAllAbandonedJobs
getAllAbandonedJobs()
Get an iterator to traverse over all abandoned jobs in this queue.
Definition: JobQueueFederated.php:414
HashRing\getLiveLocationWeights
getLiveLocationWeights()
Get the map of "live" locations to weight (ignores 0-weight items)
Definition: HashRing.php:223
wiki
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default wiki
Definition: maintenance.txt:27
JobQueueFederated\logException
logException(Exception $e)
Definition: JobQueueFederated.php:480
HashRing\ejectFromLiveRing
ejectFromLiveRing( $location, $ttl)
Remove a location from the "live" hash ring.
Definition: HashRing.php:146
$params
$params
Definition: styleTest.css.php:40
JobQueueFederated\doGetDelayedCount
doGetDelayedCount()
Definition: JobQueueFederated.php:152
serialize
serialize()
Definition: ApiMessage.php:184
JobQueueFederated\getCoalesceLocationInternal
getCoalesceLocationInternal()
Do not use this function outside of JobQueue/JobQueueGroup.
Definition: JobQueueFederated.php:425
JobQueueFederated\doIsRootJobOldDuplicate
doIsRootJobOldDuplicate(Job $job)
Definition: JobQueueFederated.php:315
JobQueueFederated\supportedOrders
supportedOrders()
Get the allowed queue orders for configuration validation.
Definition: JobQueueFederated.php:109
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1087
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
JobQueueFederated\getAllQueuedJobs
getAllQueuedJobs()
Get an iterator to traverse over all available jobs in this queue.
Definition: JobQueueFederated.php:381
Job
Class to both describe a background job and handle jobs.
Definition: Job.php:31
JobQueueFederated\doAck
doAck(Job $job)
Definition: JobQueueFederated.php:307
JobQueueFederated\doDelete
doDelete()
Definition: JobQueueFederated.php:345
MWException
MediaWiki exception.
Definition: MWException.php:26
JobQueueFederated\doGetSiblingQueuesWithJobs
doGetSiblingQueuesWithJobs(array $types)
Definition: JobQueueFederated.php:430
JobQueueFederated\tryJobInsertions
tryJobInsertions(array $jobs, HashRing &$partitionRing, $flags)
Definition: JobQueueFederated.php:209
JobQueueFederated\doGetSize
doGetSize()
Definition: JobQueueFederated.php:144
JobQueue\$type
string $type
Job type.
Definition: JobQueue.php:35
JobQueueFederated\getAllDelayedJobs
getAllDelayedJobs()
Get an iterator to traverse over all delayed jobs in this queue.
Definition: JobQueueFederated.php:392
$queue
$queue
Definition: mergeMessageFileList.php:160
JobQueueFederated\doBatchPush
doBatchPush(array $jobs, $flags)
Definition: JobQueueFederated.php:181
JobQueueFederated\$partitionQueues
JobQueue[] $partitionQueues
(partition name => JobQueue) reverse sorted by weight
Definition: JobQueueFederated.php:52
JobQueueError
Definition: JobQueue.php:723
JobQueueFederated\doDeduplicateRootJob
doDeduplicateRootJob(IJobSpecification $job)
Definition: JobQueueFederated.php:330
JobQueueFederated\getCrossPartitionSum
getCrossPartitionSum( $type, $method)
Definition: JobQueueFederated.php:165
JobQueueFederated\doGetSiblingQueueSizes
doGetSiblingQueueSizes(array $types)
Definition: JobQueueFederated.php:456
JobQueue\factory
static factory(array $params)
Get a job queue object of the specified type.
Definition: JobQueue.php:108
JobQueue\$wiki
string $wiki
Wiki ID.
Definition: JobQueue.php:33
$section
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3022
ArrayUtils\pickRandom
static pickRandom( $weights)
Given an array of non-normalised probabilities, this function will select an element and return the a...
Definition: ArrayUtils.php:66
$job
if(count( $args)< 1) $job
Definition: recompressTracked.php:47
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
JobQueueFederated\$maxPartitionsTry
int $maxPartitionsTry
Maximum number of partitions to try.
Definition: JobQueueFederated.php:55
JobQueue
Class to handle enqueueing and running of background jobs.
Definition: JobQueue.php:31
JobQueueFederated\doGetAbandonedCount
doGetAbandonedCount()
Definition: JobQueueFederated.php:156
JobQueueFederated\__construct
__construct(array $params)
Definition: JobQueueFederated.php:74
JobQueueFederated\doWaitForBackups
doWaitForBackups()
Definition: JobQueueFederated.php:360
JobQueueFederated\$partitionRing
HashRing $partitionRing
Definition: JobQueueFederated.php:50
JobQueueFederated\optimalOrder
optimalOrder()
Get the default queue order to use if configuration does not specify one.
Definition: JobQueueFederated.php:114
HashRing
Convenience class for weighted consistent hash rings.
Definition: HashRing.php:28
JobQueueFederated\doGetAcquiredCount
doGetAcquiredCount()
Definition: JobQueueFederated.php:148
HashRing\getLiveLocation
getLiveLocation( $item)
Get the location of an item on the "live" ring.
Definition: HashRing.php:201
IJobSpecification
Job queue task description interface.
Definition: JobSpecification.php:29
JobQueueFederated
Class to handle enqueueing and running of background jobs for federated queues.
Definition: JobQueueFederated.php:48
JobQueueFederated\supportsDelayedJobs
supportsDelayedJobs()
Find out if delayed jobs are supported for configuration validation.
Definition: JobQueueFederated.php:118
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
JobQueueFederated\getAllAcquiredJobs
getAllAcquiredJobs()
Get an iterator to traverse over all claimed jobs in this queue.
Definition: JobQueueFederated.php:403