6 * @defgroup JobQueue JobQueue
9 if ( !defined( 'MEDIAWIKI' ) ) {
10 die( "This file is part of MediaWiki, it is not a valid entry point\n" );
14 * Class to both describe a background job and handle jobs.
26 /*-------------------------------------------------------------------------
28 *------------------------------------------------------------------------*/
32 * @return boolean success
34 abstract function run();
36 /*-------------------------------------------------------------------------
38 *------------------------------------------------------------------------*/
41 * Pop a job of a certain type. This tries less hard than pop() to
42 * actually find a job; it may be adversely affected by concurrent job
45 static function pop_type( $type ) {
46 wfProfilein( __METHOD__
);
48 $dbw = wfGetDB( DB_MASTER
);
50 $row = $dbw->selectRow(
53 array( 'job_cmd' => $type ),
58 if ( $row === false ) {
59 wfProfileOut( __METHOD__
);
63 /* Ensure we "own" this row */
64 $dbw->delete( 'job', array( 'job_id' => $row->job_id
), __METHOD__
);
65 $affected = $dbw->affectedRows();
67 if ( $affected == 0 ) {
68 wfProfileOut( __METHOD__
);
72 $namespace = $row->job_namespace
;
73 $dbkey = $row->job_title
;
74 $title = Title
::makeTitleSafe( $namespace, $dbkey );
75 $job = Job
::factory( $row->job_cmd
, $title, Job
::extractBlob( $row->job_params
),
78 $dbw->delete( 'job', $job->insertFields(), __METHOD__
);
81 wfProfileOut( __METHOD__
);
86 * Pop a job off the front of the queue
88 * @param $offset Integer: Number of jobs to skip
89 * @return Job or false if there's no jobs
91 static function pop( $offset = 0 ) {
92 wfProfileIn( __METHOD__
);
94 $dbr = wfGetDB( DB_SLAVE
);
96 /* Get a job from the slave, start with an offset,
97 scan full set afterwards, avoid hitting purged rows
99 NB: If random fetch previously was used, offset
100 will always be ahead of few entries
103 $row = $dbr->selectRow( 'job', '*', "job_id >= ${offset}", __METHOD__
,
104 array( 'ORDER BY' => 'job_id', 'LIMIT' => 1 ) );
106 // Refetching without offset is needed as some of job IDs could have had delayed commits
107 // and have lower IDs than jobs already executed, blame concurrency :)
109 if ( $row === false ) {
110 if ( $offset != 0 ) {
111 $row = $dbr->selectRow( 'job', '*', '', __METHOD__
,
112 array( 'ORDER BY' => 'job_id', 'LIMIT' => 1 ) );
115 if ( $row === false ) {
116 wfProfileOut( __METHOD__
);
120 $offset = $row->job_id
;
122 // Try to delete it from the master
123 $dbw = wfGetDB( DB_MASTER
);
124 $dbw->delete( 'job', array( 'job_id' => $row->job_id
), __METHOD__
);
125 $affected = $dbw->affectedRows();
129 // Failed, someone else beat us to it
130 // Try getting a random row
131 $row = $dbw->selectRow( 'job', array( 'MIN(job_id) as minjob',
132 'MAX(job_id) as maxjob' ), '1=1', __METHOD__
);
133 if ( $row === false ||
is_null( $row->minjob
) ||
is_null( $row->maxjob
) ) {
135 wfProfileOut( __METHOD__
);
138 // Get the random row
139 $row = $dbw->selectRow( 'job', '*',
140 'job_id >= ' . mt_rand( $row->minjob
, $row->maxjob
), __METHOD__
);
141 if ( $row === false ) {
142 // Random job gone before we got the chance to select it
144 wfProfileOut( __METHOD__
);
147 // Delete the random row
148 $dbw->delete( 'job', array( 'job_id' => $row->job_id
), __METHOD__
);
149 $affected = $dbw->affectedRows();
153 // Random job gone before we exclusively deleted it
155 wfProfileOut( __METHOD__
);
160 // If execution got to here, there's a row in $row that has been deleted from the database
161 // by this thread. Hence the concurrent pop was successful.
162 $namespace = $row->job_namespace
;
163 $dbkey = $row->job_title
;
164 $title = Title
::makeTitleSafe( $namespace, $dbkey );
165 $job = Job
::factory( $row->job_cmd
, $title, Job
::extractBlob( $row->job_params
), $row->job_id
);
167 // Remove any duplicates it may have later in the queue
168 // Deadlock prone section
170 $dbw->delete( 'job', $job->insertFields(), __METHOD__
);
173 wfProfileOut( __METHOD__
);
178 * Create the appropriate object to handle a specific job
180 * @param $command String: Job command
181 * @param $title Title: Associated title
182 * @param $params Array: Job parameters
183 * @param $id Int: Job identifier
186 static function factory( $command, $title, $params = false, $id = 0 ) {
187 global $wgJobClasses;
188 if( isset( $wgJobClasses[$command] ) ) {
189 $class = $wgJobClasses[$command];
190 return new $class( $title, $params, $id );
192 throw new MWException( "Invalid job command `{$command}`" );
195 static function makeBlob( $params ) {
196 if ( $params !== false ) {
197 return serialize( $params );
203 static function extractBlob( $blob ) {
204 if ( (string)$blob !== '' ) {
205 return unserialize( $blob );
212 * Batch-insert a group of jobs into the queue.
213 * This will be wrapped in a transaction with a forced commit.
215 * This may add duplicate at insert time, but they will be
216 * removed later on, when the first one is popped.
218 * @param $jobs array of Job objects
220 static function batchInsert( $jobs ) {
221 if( !count( $jobs ) ) {
224 $dbw = wfGetDB( DB_MASTER
);
226 foreach( $jobs as $job ) {
227 $rows[] = $job->insertFields();
228 if ( count( $rows ) >= 50 ) {
229 # Do a small transaction to avoid slave lag
231 $dbw->insert( 'job', $rows, __METHOD__
, 'IGNORE' );
238 $dbw->insert( 'job', $rows, __METHOD__
, 'IGNORE' );
243 /*-------------------------------------------------------------------------
244 * Non-static functions
245 *------------------------------------------------------------------------*/
247 function __construct( $command, $title, $params = false, $id = 0 ) {
248 $this->command
= $command;
249 $this->title
= $title;
250 $this->params
= $params;
253 // A bit of premature generalisation
254 // Oh well, the whole class is premature generalisation really
255 $this->removeDuplicates
= true;
259 * Insert a single job into the queue.
260 * @return bool true on success
263 $fields = $this->insertFields();
265 $dbw = wfGetDB( DB_MASTER
);
267 if ( $this->removeDuplicates
) {
268 $res = $dbw->select( 'job', array( '1' ), $fields, __METHOD__
);
269 if ( $dbw->numRows( $res ) ) {
273 return $dbw->insert( 'job', $fields, __METHOD__
);
276 protected function insertFields() {
277 $dbw = wfGetDB( DB_MASTER
);
279 'job_id' => $dbw->nextSequenceValue( 'job_job_id_seq' ),
280 'job_cmd' => $this->command
,
281 'job_namespace' => $this->title
->getNamespace(),
282 'job_title' => $this->title
->getDBkey(),
283 'job_params' => Job
::makeBlob( $this->params
)
287 function toString() {
289 if ( $this->params
) {
290 foreach ( $this->params
as $key => $value ) {
291 if ( $paramString != '' ) {
294 $paramString .= "$key=$value";
298 if ( is_object( $this->title
) ) {
299 $s = "{$this->command} " . $this->title
->getPrefixedDBkey();
300 if ( $paramString !== '' ) {
301 $s .= ' ' . $paramString;
305 return "{$this->command} $paramString";
309 protected function setLastError( $error ) {
310 $this->error
= $error;
313 function getLastError() {