Go to the documentation of this file.
28 use Wikimedia\ScopedCallback;
59 $this->cluster = isset(
$params[
'cluster'] ) ?
$params[
'cluster'] :
false;
64 return [
'random',
'timestamp',
'fifo' ];
78 $found =
$dbr->selectField(
79 'job',
'1', [
'job_cmd' => $this->
type,
'job_token' =>
'' ], __METHOD__
95 $size = $this->
cache->get( $key );
96 if ( is_int( $size ) ) {
102 $size = (int)
$dbr->selectField(
'job',
'COUNT(*)',
103 [
'job_cmd' => $this->type,
'job_token' =>
'' ],
109 $this->
cache->set( $key, $size, self::CACHE_TTL_SHORT );
119 if ( $this->claimTTL <= 0 ) {
125 $count = $this->
cache->get( $key );
126 if ( is_int( $count ) ) {
132 $count = (int)
$dbr->selectField(
'job',
'COUNT(*)',
133 [
'job_cmd' => $this->type,
"job_token != {$dbr->addQuotes( '' )}" ],
139 $this->
cache->set( $key, $count, self::CACHE_TTL_SHORT );
150 if ( $this->claimTTL <= 0 ) {
156 $count = $this->
cache->get( $key );
157 if ( is_int( $count ) ) {
163 $count = (int)
$dbr->selectField(
'job',
'COUNT(*)',
165 'job_cmd' => $this->type,
166 "job_token != {$dbr->addQuotes( '' )}",
167 "job_attempts >= " .
$dbr->addQuotes( $this->maxTries )
175 $this->
cache->set( $key, $count, self::CACHE_TTL_SHORT );
211 if ( !
count( $jobs ) ) {
217 foreach ( $jobs
as $job ) {
219 if (
$job->ignoreDuplicates() ) {
220 $rowSet[$row[
'job_sha1']] = $row;
226 if (
$flags & self::QOS_ATOMIC ) {
231 if (
count( $rowSet ) ) {
235 'job_sha1' => array_keys( $rowSet ),
240 foreach (
$res as $row ) {
241 wfDebug(
"Job with hash '{$row->job_sha1}' is a duplicate.\n" );
242 unset( $rowSet[$row->job_sha1] );
246 $rows = array_merge( $rowList, array_values( $rowSet ) );
248 foreach ( array_chunk( $rows, 50 )
as $rowBatch ) {
249 $dbw->
insert(
'job', $rowBatch, $method );
258 if (
$flags & self::QOS_ATOMIC ) {
272 $autoTrx = $dbw->getFlag(
DBO_TRX );
274 $scopedReset =
new ScopedCallback(
function ()
use ( $dbw, $autoTrx ) {
275 $dbw->setFlag( $autoTrx ?
DBO_TRX : 0 );
282 if ( in_array( $this->
order, [
'fifo',
'timestamp' ] ) ) {
285 $rand = mt_rand( 0, self::MAX_JOB_RANDOM );
286 $gte = (bool)mt_rand( 0, 1 );
297 self::extractBlob( $row->job_params ), $row->job_id );
298 $job->metadata[
'id'] = $row->job_id;
299 $job->metadata[
'timestamp'] = $row->job_timestamp;
303 if ( !
$job || mt_rand( 0, 9 ) == 0 ) {
329 $invertedDirection =
false;
338 $ineq = $gte ?
'>=' :
'<=';
339 $dir = $gte ?
'ASC' :
'DESC';
340 $row = $dbw->selectRow(
'job', self::selectFields(),
342 'job_cmd' => $this->
type,
344 "job_random {$ineq} {$dbw->addQuotes( $rand )}" ],
346 [
'ORDER BY' =>
"job_random {$dir}" ]
348 if ( !$row && !$invertedDirection ) {
350 $invertedDirection =
true;
357 $row = $dbw->selectRow(
'job', self::selectFields(),
359 'job_cmd' => $this->
type,
363 [
'OFFSET' => mt_rand( 0, self::MAX_OFFSET ) ]
375 'job_token' => $uuid,
376 'job_token_timestamp' => $dbw->timestamp(),
377 'job_attempts = job_attempts+1' ],
378 [
'job_cmd' =>
$this->type,
'job_id' => $row->job_id,
'job_token' =>
'' ],
383 if ( !$dbw->affectedRows() ) {
405 if ( $dbw->getType() ===
'mysql' ) {
410 $dbw->query(
"UPDATE {$dbw->tableName( 'job' )} " .
412 "job_token = {$dbw->addQuotes( $uuid ) }, " .
413 "job_token_timestamp = {$dbw->addQuotes( $dbw->timestamp() )}, " .
414 "job_attempts = job_attempts+1 " .
416 "job_cmd = {$dbw->addQuotes( $this->type )} " .
417 "AND job_token = {$dbw->addQuotes( '' )} " .
418 ") ORDER BY job_id ASC LIMIT 1",
426 'job_token' => $uuid,
427 'job_token_timestamp' => $dbw->timestamp(),
428 'job_attempts = job_attempts+1' ],
430 $dbw->selectSQLText(
'job',
'job_id',
431 [
'job_cmd' => $this->
type,
'job_token' =>
'' ],
433 [
'ORDER BY' =>
'job_id ASC',
'LIMIT' => 1 ] ) .
440 if ( $dbw->affectedRows() ) {
441 $row = $dbw->selectRow(
'job', self::selectFields(),
442 [
'job_cmd' => $this->
type,
'job_token' => $uuid ], __METHOD__
445 wfDebug(
"Row deleted as duplicate by another process.\n" );
461 if ( !isset(
$job->metadata[
'id'] ) ) {
462 throw new MWException(
"Job of type '{$job->getType()}' has no ID." );
467 $autoTrx = $dbw->getFlag(
DBO_TRX );
469 $scopedReset =
new ScopedCallback(
function ()
use ( $dbw, $autoTrx ) {
470 $dbw->setFlag( $autoTrx ?
DBO_TRX : 0 );
475 [
'job_cmd' => $this->
type,
'job_id' => $job->metadata[
'id'] ], __METHOD__ );
491 if ( !isset(
$params[
'rootJobSignature'] ) ) {
492 throw new MWException(
"Cannot register root job; missing 'rootJobSignature'." );
493 } elseif ( !isset(
$params[
'rootJobTimestamp'] ) ) {
494 throw new MWException(
"Cannot register root job; missing 'rootJobTimestamp'." );
504 $dbw->onTransactionIdle(
507 if ( $timestamp && $timestamp >=
$params[
'rootJobTimestamp'] ) {
527 $dbw->delete(
'job', [
'job_cmd' => $this->
type ] );
540 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
541 $lbFactory->waitForReplication( [
'wiki' => $this->
wiki,
'cluster' => $this->cluster ] );
548 foreach ( [
'size',
'acquiredcount' ]
as $type ) {
577 $dbr->select(
'job', self::selectFields(), $conds ),
582 strlen( $row->job_params ) ?
unserialize( $row->job_params ) : []
584 $job->metadata[
'id'] = $row->job_id;
585 $job->metadata[
'timestamp'] = $row->job_timestamp;
596 return $this->cluster
597 ?
"DBCluster:{$this->cluster}:{$this->wiki}"
598 :
"LBFactory:{$this->wiki}";
607 $res =
$dbr->select(
'job',
'DISTINCT job_cmd',
608 [
'job_cmd' => $types ], __METHOD__ );
611 foreach (
$res as $row ) {
612 $types[] = $row->job_cmd;
620 $res =
$dbr->select(
'job', [
'job_cmd',
'COUNT(*) AS count' ],
621 [
'job_cmd' => $types ], __METHOD__, [
'GROUP BY' =>
'job_cmd' ] );
624 foreach (
$res as $row ) {
625 $sizes[$row->job_cmd] = (int)$row->count;
642 if ( !$dbw->lock(
"jobqueue-recycle-{$this->type}", __METHOD__, 1 ) ) {
647 if ( $this->claimTTL > 0 ) {
648 $claimCutoff = $dbw->timestamp( $now - $this->claimTTL );
652 $res = $dbw->select(
'job',
'job_id',
654 'job_cmd' => $this->
type,
655 "job_token != {$dbw->addQuotes( '' )}",
656 "job_token_timestamp < {$dbw->addQuotes( $claimCutoff )}",
657 "job_attempts < {$dbw->addQuotes( $this->maxTries )}" ],
663 }, iterator_to_array(
$res )
665 if (
count( $ids ) ) {
672 'job_token_timestamp' => $dbw->timestamp( $now ) ],
677 $affected = $dbw->affectedRows();
680 $this->aggr->notifyQueueNonEmpty( $this->
wiki, $this->
type );
685 $pruneCutoff = $dbw->timestamp( $now - self::MAX_AGE_PRUNE );
688 "job_token != {$dbw->addQuotes( '' )}",
689 "job_token_timestamp < {$dbw->addQuotes( $pruneCutoff )}"
691 if ( $this->claimTTL > 0 ) {
692 $conds[] =
"job_attempts >= {$dbw->addQuotes( $this->maxTries )}";
696 $res = $dbw->select(
'job',
'job_id', $conds, __METHOD__ );
700 }, iterator_to_array(
$res )
702 if (
count( $ids ) ) {
703 $dbw->delete(
'job', [
'job_id' => $ids ], __METHOD__ );
704 $affected = $dbw->affectedRows();
709 $dbw->unlock(
"jobqueue-recycle-{$this->type}", __METHOD__ );
727 'job_namespace' =>
$job->getTitle()->getNamespace(),
728 'job_title' =>
$job->getTitle()->getDBkey(),
731 'job_id' => $dbw->nextSequenceValue(
'job_job_id_seq' ),
732 'job_timestamp' => $dbw->timestamp(),
733 'job_sha1' => Wikimedia\base_convert(
737 'job_random' => mt_rand( 0, self::MAX_JOB_RANDOM )
769 protected function getDB( $index ) {
770 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
771 $lb = ( $this->cluster !==
false )
772 ?
$lbFactory->getExternalLB( $this->cluster, $this->wiki )
775 return $lb->getConnectionRef( $index, [], $this->
wiki );
784 $cluster = is_string( $this->cluster ) ? $this->cluster :
'main';
806 if ( (
string)
$blob !==
'' ) {
837 'job_token_timestamp',
doBatchPushInternal(IDatabase $dbw, array $jobs, $flags, $method)
This function should not be called outside of JobQueueDB.
Convenience class for generating iterators from iterators.
doGetSiblingQueuesWithJobs(array $types)
getCoalesceLocationInternal()
Do not use this function outside of JobQueue/JobQueueGroup.
processing should stop and the error should be shown to the user * false
static incrStats( $key, $type, $delta=1)
Call wfIncrStats() for the queue overall and for the queue type.
doGetSiblingQueueSizes(array $types)
throwDBException(DBError $e)
Deferrable Update for closure/callback updates that should use auto-commit mode.
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
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
static addUpdate(DeferrableUpdate $update, $stage=self::POSTSEND)
Add an update to the deferred list to be run later by execute()
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
unserialize( $serialized)
optimalOrder()
Get the default queue order to use if configuration does not specify one.
__construct(array $params)
Additional parameters include:
set( $key, $value, $ttl=0, array $opts=[])
Set the value of a key in cache.
wfSplitWikiID( $wiki)
Split a wiki ID into DB name and table prefix.
insertFields(IJobSpecification $job)
Class to handle job queues stored in the DB.
you have access to all of the normal MediaWiki so you can get a DB use the cache
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
getJobIterator(array $conds)
static makeBlob( $params)
supportedOrders()
Get the allowed queue orders for configuration validation.
Class to both describe a background job and handle jobs.
static factory( $command, Title $title, $params=[])
Create the appropriate object to handle a specific job.
namespace and then decline to actually register it file or subcat img or subcat $title
doDeduplicateRootJob(IJobSpecification $job)
recycleAndDeleteStaleJobs()
Recycle or destroy any jobs that have been claimed for too long.
doBatchPush(array $jobs, $flags)
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
wfForeignMemcKey( $db, $prefix)
Make a cache key for a foreign DB.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
static extractBlob( $blob)
get( $key, &$curTTL=null, array $checkKeys=[], &$asOf=null)
Fetch the value of a key from cache.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Multi-datacenter aware caching interface.
static selectFields()
Return the list of job fields that should be selected.
claimOldest( $uuid)
Reserve a row with a single UPDATE without holding row locks over RTTs...
getRootJobCacheKey( $signature)
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
static getMainWANInstance()
Get the main WAN cache object.
if(count( $args)< 1) $job
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
Class to handle enqueueing and running of background jobs.
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 MediaWikiServices
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any order
Job queue task description interface.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
bool string $cluster
Name of an external DB cluster.
the array() calling protocol came about after MediaWiki 1.4rc1.
wfRandomString( $length=32)
Get a random string containing a number of pseudo-random hex characters.
claimRandom( $uuid, $rand, $gte)
Reserve a row with a single UPDATE without holding row locks over RTTs...