includes/JobQueue.php

   1 <?php
   2 /**
   3  * @defgroup JobQueue JobQueue
   4  */
   5
   6 if ( !defined( 'MEDIAWIKI' ) ) {
   7         die( "This file is part of MediaWiki, it is not a valid entry point\n" );
   8 }
   9
  10 /**
  11  * Class to both describe a background job and handle jobs.
  12  *
  13  * @ingroup JobQueue
  14  */
  15 abstract class Job {
  16         var $command,
  17                 $title,
  18                 $params,
  19                 $id,
  20                 $removeDuplicates,
  21                 $error;
  22
  23         /*-------------------------------------------------------------------------
  24          * Abstract functions
  25          *------------------------------------------------------------------------*/
  26
  27         /**
  28          * Run the job
  29          * @return boolean success
  30          */
  31         abstract function run();
  32
  33         /*-------------------------------------------------------------------------
  34          * Static functions
  35          *------------------------------------------------------------------------*/
  36
  37         /**
  38          * @deprecated use LinksUpdate::queueRecursiveJobs()
  39          */
  40         /**
  41          * static function queueLinksJobs( $titles ) {}
  42          */
  43
  44         /**
  45          * Pop a job of a certain type.  This tries less hard than pop() to
  46          * actually find a job; it may be adversely affected by concurrent job
  47          * runners.
  48          */
  49         static function pop_type($type) {
  50                 wfProfilein( __METHOD__ );
  51
  52                 $dbw = wfGetDB( DB_MASTER );
  53
  54
  55                 $row = $dbw->selectRow( 'job', '*', array( 'job_cmd' => $type ), __METHOD__,
  56                                 array( 'LIMIT' => 1 ));
  57
  58                 if ($row === false) {
  59                         wfProfileOut( __METHOD__ );
  60                         return false;
  61                 }
  62
  63                 /* Ensure we "own" this row */
  64                 $dbw->delete( 'job', array( 'job_id' => $row->job_id ), __METHOD__ );
  65                 $affected = $dbw->affectedRows();
  66
  67                 if ($affected == 0) {
  68                         wfProfileOut( __METHOD__ );
  69                         return false;
  70                 }
  71
  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 ), $row->job_id );
  76
  77                 $dbw->delete( 'job', $job->insertFields(), __METHOD__ );
  78                 $dbw->immediateCommit();
  79
  80                 wfProfileOut( __METHOD__ );
  81                 return $job;
  82         }
  83
  84         /**
  85          * Pop a job off the front of the queue
  86          *
  87          * @param $offset Number of jobs to skip
  88          * @return Job or false if there's no jobs
  89          */
  90         static function pop($offset=0) {
  91                 wfProfileIn( __METHOD__ );
  92
  93                 $dbr = wfGetDB( DB_SLAVE );
  94
  95                 /* Get a job from the slave, start with an offset,
  96                         scan full set afterwards, avoid hitting purged rows
  97
  98                         NB: If random fetch previously was used, offset
  99                                 will always be ahead of few entries
 100                 */
 101
 102                 $row = $dbr->selectRow( 'job', '*', "job_id >= ${offset}", __METHOD__,
 103                         array( 'ORDER BY' => 'job_id', 'LIMIT' => 1 ));
 104
 105                 // Refetching without offset is needed as some of job IDs could have had delayed commits
 106                 // and have lower IDs than jobs already executed, blame concurrency :)
 107                 //
 108                 if ( $row === false) {
 109                         if ($offset!=0)
 110                                 $row = $dbr->selectRow( 'job', '*', '', __METHOD__,
 111                                         array( 'ORDER BY' => 'job_id', 'LIMIT' => 1 ));
 112
 113                         if ($row === false ) {
 114                                 wfProfileOut( __METHOD__ );
 115                                 return false;
 116                         }
 117                 }
 118                 $offset = $row->job_id;
 119
 120                 // Try to delete it from the master
 121                 $dbw = wfGetDB( DB_MASTER );
 122                 $dbw->delete( 'job', array( 'job_id' => $row->job_id ), __METHOD__ );
 123                 $affected = $dbw->affectedRows();
 124                 $dbw->immediateCommit();
 125
 126                 if ( !$affected ) {
 127                         // Failed, someone else beat us to it
 128                         // Try getting a random row
 129                         // FIXME: FIFO???
 130                         $row = $dbw->selectRow( 'job', array( 'MIN(job_id) as minjob',
 131                                 'MAX(job_id) as maxjob' ), '1=1', __METHOD__ );
 132                         if ( $row === false || is_null( $row->minjob ) || is_null( $row->maxjob ) ) {
 133                                 // No jobs to get
 134                                 wfProfileOut( __METHOD__ );
 135                                 return false;
 136                         }
 137                         // Get the random row
 138                         $row = $dbw->selectRow( 'job', '*',
 139                                 'job_id >= ' . mt_rand( $row->minjob, $row->maxjob ),   __METHOD__ );
 140                         if ( $row === false ) {
 141                                 // Random job gone before we got the chance to select it
 142                                 // Give up
 143                                 wfProfileOut( __METHOD__ );
 144                                 return false;
 145                         }
 146                         // Delete the random row
 147                         $dbw->delete( 'job', array( 'job_id' => $row->job_id ), __METHOD__ );
 148                         $affected = $dbw->affectedRows();
 149                         $dbw->immediateCommit();
 150
 151                         if ( !$affected ) {
 152                                 // Random job gone before we exclusively deleted it
 153                                 // Give up
 154                                 wfProfileOut( __METHOD__ );
 155                                 return false;
 156                         }
 157                 }
 158
 159                 // If execution got to here, there's a row in $row that has been deleted from the database
 160                 // by this thread. Hence the concurrent pop was successful.
 161                 $namespace = $row->job_namespace;
 162                 $dbkey = $row->job_title;
 163                 $title = Title::makeTitleSafe( $namespace, $dbkey );
 164                 $job = Job::factory( $row->job_cmd, $title, Job::extractBlob( $row->job_params ), $row->job_id );
 165
 166                 // Remove any duplicates it may have later in the queue
 167                 // Deadlock prone section
 168                 $dbw->begin();
 169                 $dbw->delete( 'job', $job->insertFields(), __METHOD__ );
 170                 $dbw->commit();
 171
 172                 wfProfileOut( __METHOD__ );
 173                 return $job;
 174         }
 175
 176         /**
 177          * Create the appropriate object to handle a specific job
 178          *
 179          * @param $command String: Job command
 180          * @param $title Title: Associated title
 181          * @param $params Array: Job parameters
 182          * @param $id Int: Job identifier
 183          * @return Job
 184          */
 185         static function factory( $command, $title, $params = false, $id = 0 ) {
 186                 global $wgJobClasses;
 187                 if( isset( $wgJobClasses[$command] ) ) {
 188                         $class = $wgJobClasses[$command];
 189                         return new $class( $title, $params, $id );
 190                 }
 191                 throw new MWException( "Invalid job command `{$command}`" );
 192         }
 193
 194         static function makeBlob( $params ) {
 195                 if ( $params !== false ) {
 196                         return serialize( $params );
 197                 } else {
 198                         return '';
 199                 }
 200         }
 201
 202         static function extractBlob( $blob ) {
 203                 if ( (string)$blob !== '' ) {
 204                         return unserialize( $blob );
 205                 } else {
 206                         return false;
 207                 }
 208         }
 209
 210         /**
 211          * Batch-insert a group of jobs into the queue.
 212          * This will be wrapped in a transaction with a forced commit.
 213          *
 214          * This may add duplicate at insert time, but they will be
 215          * removed later on, when the first one is popped.
 216          *
 217          * @param $jobs array of Job objects
 218          */
 219         static function batchInsert( $jobs ) {
 220                 if( !count( $jobs ) ) {
 221                         return;
 222                 }
 223                 $dbw = wfGetDB( DB_MASTER );
 224                 $rows = array();
 225                 foreach( $jobs as $job ) {
 226                         $rows[] = $job->insertFields();
 227                         if ( count( $rows ) >= 50 ) {
 228                                 # Do a small transaction to avoid slave lag
 229                                 $dbw->begin();
 230                                 $dbw->insert( 'job', $rows, __METHOD__, 'IGNORE' );
 231                                 $dbw->commit();
 232                                 $rows = array();
 233                         }
 234                 }
 235                 if ( $rows ) {
 236                         $dbw->begin();
 237                         $dbw->insert( 'job', $rows, __METHOD__, 'IGNORE' );
 238                         $dbw->commit();
 239                 }
 240         }
 241
 242         /*-------------------------------------------------------------------------
 243          * Non-static functions
 244          *------------------------------------------------------------------------*/
 245
 246         function __construct( $command, $title, $params = false, $id = 0 ) {
 247                 $this->command = $command;
 248                 $this->title = $title;
 249                 $this->params = $params;
 250                 $this->id = $id;
 251
 252                 // A bit of premature generalisation
 253                 // Oh well, the whole class is premature generalisation really
 254                 $this->removeDuplicates = true;
 255         }
 256
 257         /**
 258          * Insert a single job into the queue.
 259          */
 260         function insert() {
 261                 $fields = $this->insertFields();
 262
 263                 $dbw = wfGetDB( DB_MASTER );
 264
 265                 if ( $this->removeDuplicates ) {
 266                         $res = $dbw->select( 'job', array( '1' ), $fields, __METHOD__ );
 267                         if ( $dbw->numRows( $res ) ) {
 268                                 return;
 269                         }
 270                 }
 271                 $fields['job_id'] = $dbw->nextSequenceValue( 'job_job_id_seq' );
 272                 $dbw->insert( 'job', $fields, __METHOD__ );
 273         }
 274
 275         protected function insertFields() {
 276                 return array(
 277                         'job_cmd' => $this->command,
 278                         'job_namespace' => $this->title->getNamespace(),
 279                         'job_title' => $this->title->getDBkey(),
 280                         'job_params' => Job::makeBlob( $this->params )
 281                 );
 282         }
 283
 284         function toString() {
 285                 $paramString = '';
 286                 if ( $this->params ) {
 287                         foreach ( $this->params as $key => $value ) {
 288                                 if ( $paramString != '' ) {
 289                                         $paramString .= ' ';
 290                                 }
 291                                 $paramString .= "$key=$value";
 292                         }
 293                 }
 294
 295                 if ( is_object( $this->title ) ) {
 296                         $s = "{$this->command} " . $this->title->getPrefixedDBkey();
 297                         if ( $paramString !== '' ) {
 298                                 $s .= ' ' . $paramString;
 299                         }
 300                         return $s;
 301                 } else {
 302                         return "{$this->command} $paramString";
 303                 }
 304         }
 305
 306         protected function setLastError( $error ) {
 307                 $this->error = $error;
 308         }
 309
 310         function getLastError() {
 311                 return $this->error;
 312         }
 313 }