3 if ( !defined( 'MEDIAWIKI' ) ) {
4 die( "This file is part of MediaWiki, it is not a valid entry point\n" );
7 require_once('UserMailer.php');
10 * Class to both describe a background job and handle jobs.
20 /*-------------------------------------------------------------------------
22 *------------------------------------------------------------------------*/
26 * @return boolean success
28 abstract function run();
30 /*-------------------------------------------------------------------------
32 *------------------------------------------------------------------------*/
35 * @deprecated use LinksUpdate::queueRecursiveJobs()
38 * static function queueLinksJobs( $titles ) {}
42 * Pop a job of a certain type. This tries less hard than pop() to
43 * actually find a job; it may be adversely affected by concurrent job
46 static function pop_type($type) {
47 wfProfilein( __METHOD__
);
49 $dbw = wfGetDB( DB_MASTER
);
52 $row = $dbw->selectRow( 'job', '*', array( 'job_cmd' => $type ), __METHOD__
,
53 array( 'LIMIT' => 1 ));
56 wfProfileOut( __METHOD__
);
60 /* Ensure we "own" this row */
61 $dbw->delete( 'job', array( 'job_id' => $row->job_id
), __METHOD__
);
62 $affected = $dbw->affectedRows();
65 wfProfileOut( __METHOD__
);
69 $namespace = $row->job_namespace
;
70 $dbkey = $row->job_title
;
71 $title = Title
::makeTitleSafe( $namespace, $dbkey );
72 $job = Job
::factory( $row->job_cmd
, $title, Job
::extractBlob( $row->job_params
), $row->job_id
);
74 $dbw->delete( 'job', $job->insertFields(), __METHOD__
);
75 $dbw->immediateCommit();
77 wfProfileOut( __METHOD__
);
82 * Pop a job off the front of the queue
84 * @param $offset Number of jobs to skip
85 * @return Job or false if there's no jobs
87 static function pop($offset=0) {
88 wfProfileIn( __METHOD__
);
90 $dbr = wfGetDB( DB_SLAVE
);
92 /* Get a job from the slave, start with an offset,
93 scan full set afterwards, avoid hitting purged rows
95 NB: If random fetch previously was used, offset
96 will always be ahead of few entries
99 $row = $dbr->selectRow( 'job', '*', "job_id >= ${offset}", __METHOD__
,
100 array( 'ORDER BY' => 'job_id', 'LIMIT' => 1 ));
102 // Refetching without offset is needed as some of job IDs could have had delayed commits
103 // and have lower IDs than jobs already executed, blame concurrency :)
105 if ( $row === false) {
107 $row = $dbr->selectRow( 'job', '*', '', __METHOD__
,
108 array( 'ORDER BY' => 'job_id', 'LIMIT' => 1 ));
110 if ($row === false ) {
111 wfProfileOut( __METHOD__
);
115 $offset = $row->job_id
;
117 // Try to delete it from the master
118 $dbw = wfGetDB( DB_MASTER
);
119 $dbw->delete( 'job', array( 'job_id' => $row->job_id
), __METHOD__
);
120 $affected = $dbw->affectedRows();
121 $dbw->immediateCommit();
124 // Failed, someone else beat us to it
125 // Try getting a random row
126 $row = $dbw->selectRow( 'job', array( 'MIN(job_id) as minjob',
127 'MAX(job_id) as maxjob' ), "job_id >= $offset", __METHOD__
);
128 if ( $row === false ||
is_null( $row->minjob
) ||
is_null( $row->maxjob
) ) {
130 wfProfileOut( __METHOD__
);
133 // Get the random row
134 $row = $dbw->selectRow( 'job', '*',
135 'job_id >= ' . mt_rand( $row->minjob
, $row->maxjob
), __METHOD__
);
136 if ( $row === false ) {
137 // Random job gone before we got the chance to select it
139 wfProfileOut( __METHOD__
);
142 // Delete the random row
143 $dbw->delete( 'job', array( 'job_id' => $row->job_id
), __METHOD__
);
144 $affected = $dbw->affectedRows();
145 $dbw->immediateCommit();
148 // Random job gone before we exclusively deleted it
150 wfProfileOut( __METHOD__
);
155 // If execution got to here, there's a row in $row that has been deleted from the database
156 // by this thread. Hence the concurrent pop was successful.
157 $namespace = $row->job_namespace
;
158 $dbkey = $row->job_title
;
159 $title = Title
::makeTitleSafe( $namespace, $dbkey );
160 $job = Job
::factory( $row->job_cmd
, $title, Job
::extractBlob( $row->job_params
), $row->job_id
);
162 // Remove any duplicates it may have later in the queue
163 $dbw->delete( 'job', $job->insertFields(), __METHOD__
);
165 wfProfileOut( __METHOD__
);
170 * Create an object of a subclass
172 static function factory( $command, $title, $params = false, $id = 0 ) {
173 switch ( $command ) {
175 return new RefreshLinksJob( $title, $params, $id );
176 case 'htmlCacheUpdate':
177 case 'html_cache_update': # BC
178 return new HTMLCacheUpdateJob( $title, $params['table'], $params['start'], $params['end'], $id );
180 return new EmaillingJob( $params );
182 return new EnotifNotifyJob( $title, $params );
184 // OK, check if this is a custom job
185 global $wgCustomJobs;
186 wfLoadAllExtensions(); // This may be for an extension
188 if( isset($wgCustomJobs[$command]) ) {
189 $class = $wgCustomJobs[$command];
190 return new $class($title, $params, $id);
192 throw new MWException( "Invalid job command \"$command\"" );
196 static function makeBlob( $params ) {
197 if ( $params !== false ) {
198 return serialize( $params );
204 static function extractBlob( $blob ) {
205 if ( (string)$blob !== '' ) {
206 return unserialize( $blob );
213 * Batch-insert a group of jobs into the queue.
214 * This will be wrapped in a transaction with a forced commit.
216 * This may add duplicate at insert time, but they will be
217 * removed later on, when the first one is popped.
219 * @param $jobs array of Job objects
221 static function batchInsert( $jobs ) {
222 if( count( $jobs ) ) {
223 $dbw = wfGetDB( DB_MASTER
);
225 foreach( $jobs as $job ) {
226 $rows[] = $job->insertFields();
228 $dbw->insert( 'job', $rows, __METHOD__
, 'IGNORE' );
233 /*-------------------------------------------------------------------------
234 * Non-static functions
235 *------------------------------------------------------------------------*/
237 function __construct( $command, $title, $params = false, $id = 0 ) {
238 $this->command
= $command;
239 $this->title
= $title;
240 $this->params
= $params;
243 // A bit of premature generalisation
244 // Oh well, the whole class is premature generalisation really
245 $this->removeDuplicates
= true;
249 * Insert a single job into the queue.
252 $fields = $this->insertFields();
254 $dbw = wfGetDB( DB_MASTER
);
256 if ( $this->removeDuplicates
) {
257 $res = $dbw->select( 'job', array( '1' ), $fields, __METHOD__
);
258 if ( $dbw->numRows( $res ) ) {
262 $fields['job_id'] = $dbw->nextSequenceValue( 'job_job_id_seq' );
263 $dbw->insert( 'job', $fields, __METHOD__
);
266 protected function insertFields() {
268 'job_cmd' => $this->command
,
269 'job_namespace' => $this->title
->getNamespace(),
270 'job_title' => $this->title
->getDBkey(),
271 'job_params' => Job
::makeBlob( $this->params
)
275 function toString() {
277 if ( $this->params
) {
278 foreach ( $this->params
as $key => $value ) {
279 if ( $paramString != '' ) {
282 $paramString .= "$key=$value";
286 if ( is_object( $this->title
) ) {
287 $s = "{$this->command} " . $this->title
->getPrefixedDBkey();
288 if ( $paramString !== '' ) {
289 $s .= ' ' . $paramString;
293 return "{$this->command} $paramString";
297 function getLastError() {
304 * Background job to update links for a given title.
306 class RefreshLinksJob
extends Job
{
307 function __construct( $title, $params = '', $id = 0 ) {
308 parent
::__construct( 'refreshLinks', $title, $params, $id );
312 * Run a refreshLinks job
313 * @return boolean success
317 wfProfileIn( __METHOD__
);
319 $linkCache =& LinkCache
::singleton();
322 if ( is_null( $this->title
) ) {
323 $this->error
= "refreshLinks: Invalid title";
324 wfProfileOut( __METHOD__
);
328 $revision = Revision
::newFromTitle( $this->title
);
330 $this->error
= 'refreshLinks: Article not found "' . $this->title
->getPrefixedDBkey() . '"';
331 wfProfileOut( __METHOD__
);
335 wfProfileIn( __METHOD__
.'-parse' );
336 $options = new ParserOptions
;
337 $parserOutput = $wgParser->parse( $revision->getText(), $this->title
, $options, true, true, $revision->getId() );
338 wfProfileOut( __METHOD__
.'-parse' );
339 wfProfileIn( __METHOD__
.'-update' );
340 $update = new LinksUpdate( $this->title
, $parserOutput, false );
342 wfProfileOut( __METHOD__
.'-update' );
343 wfProfileOut( __METHOD__
);
348 class EmaillingJob
extends Job
{
349 function __construct($params) {
350 parent
::__construct('sendMail', Title
::newMainPage(), $params);
354 userMailer($this->params
['to'], $this->params
['from'], $this->params
['subj'],
355 $this->params
['body'], $this->params
['replyto']);
359 class EnotifNotifyJob
extends Job
{
360 function __construct($title, $params) {
361 parent
::__construct('enotifNotify', $title, $params);
365 $enotif = new EmailNotification();
366 $enotif->actuallyNotifyOnPageChange( User
::newFromName($this->params
['editor'], false),
367 $this->title
, $this->params
['timestamp'],
368 $this->params
['summary'], $this->params
['minorEdit'],
369 $this->params
['oldid']);