includes/job/JobQueue.php

   1 <?php
   2 /**
   3  * Job queue base code.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @defgroup JobQueue JobQueue
  22  * @author Aaron Schulz
  23  */
  24
  25 /**
  26  * Class to handle enqueueing and running of background jobs
  27  *
  28  * @ingroup JobQueue
  29  * @since 1.21
  30  */
  31 abstract class JobQueue {
  32         protected $wiki; // string; wiki ID
  33         protected $type; // string; job type
  34         protected $order; // string; job priority for pop()
  35         protected $claimTTL; // integer; seconds
  36
  37         const QoS_Atomic = 1; // integer; "all-or-nothing" job insertions
  38
  39         /**
  40          * @param $params array
  41          */
  42         protected function __construct( array $params ) {
  43                 $this->wiki     = $params['wiki'];
  44                 $this->type     = $params['type'];
  45                 $this->order    = isset( $params['order'] ) ? $params['order'] : 'random';
  46                 $this->claimTTL = isset( $params['claimTTL'] ) ? $params['claimTTL'] : 0;
  47         }
  48
  49         /**
  50          * Get a job queue object of the specified type.
  51          * $params includes:
  52          *   class    : What job class to use (determines job type)
  53          *   wiki     : wiki ID of the wiki the jobs are for (defaults to current wiki)
  54          *   type     : The name of the job types this queue handles
  55          *   order    : Order that pop() selects jobs, one of "fifo", "timestamp" or "random".
  56          *              If "fifo" is used, the queue will effectively be FIFO. Note that
  57          *              job completion will not appear to be exactly FIFO if there are multiple
  58          *              job runners since jobs can take different times to finish once popped.
  59          *              If "timestamp" is used, the queue will at least be loosely ordered
  60          *              by timestamp, allowing for some jobs to be popped off out of order.
  61          *              If "random" is used, pop() will pick jobs in random order. This might be
  62          *              useful for improving concurrency depending on the queue storage medium.
  63          *   claimTTL : If supported, the queue will recycle jobs that have been popped
  64          *              but not acknowledged as completed after this many seconds.
  65          *
  66          * Queue classes should throw an exception if they do not support the options given.
  67          *
  68          * @param $params array
  69          * @return JobQueue
  70          * @throws MWException
  71          */
  72         final public static function factory( array $params ) {
  73                 $class = $params['class'];
  74                 if ( !MWInit::classExists( $class ) ) {
  75                         throw new MWException( "Invalid job queue class '$class'." );
  76                 }
  77                 $obj = new $class( $params );
  78                 if ( !( $obj instanceof self ) ) {
  79                         throw new MWException( "Class '$class' is not a " . __CLASS__ . " class." );
  80                 }
  81                 return $obj;
  82         }
  83
  84         /**
  85          * @return string Wiki ID
  86          */
  87         final public function getWiki() {
  88                 return $this->wiki;
  89         }
  90
  91         /**
  92          * @return string Job type that this queue handles
  93          */
  94         final public function getType() {
  95                 return $this->type;
  96         }
  97
  98         /**
  99          * Quickly check if the queue is empty.
 100          * Queue classes should use caching if they are any slower without memcached.
 101          *
 102          * @return bool
 103          */
 104         final public function isEmpty() {
 105                 wfProfileIn( __METHOD__ );
 106                 $res = $this->doIsEmpty();
 107                 wfProfileOut( __METHOD__ );
 108                 return $res;
 109         }
 110
 111         /**
 112          * @see JobQueue::isEmpty()
 113          * @return bool
 114          */
 115         abstract protected function doIsEmpty();
 116
 117         /**
 118          * Push a batch of jobs into the queue
 119          *
 120          * @param $jobs array List of Jobs
 121          * @param $flags integer Bitfield (supports JobQueue::QoS_Atomic)
 122          * @throws MWException
 123          * @return bool
 124          */
 125         final public function batchPush( array $jobs, $flags = 0 ) {
 126                 foreach ( $jobs as $job ) {
 127                         if ( $job->getType() !== $this->type ) {
 128                                 throw new MWException( "Got '{$job->getType()}' job; expected '{$this->type}'." );
 129                         }
 130                 }
 131                 wfProfileIn( __METHOD__ );
 132                 $ok = $this->doBatchPush( $jobs, $flags );
 133                 wfProfileOut( __METHOD__ );
 134                 return $ok;
 135         }
 136
 137         /**
 138          * @see JobQueue::batchPush()
 139          * @return bool
 140          */
 141         abstract protected function doBatchPush( array $jobs, $flags );
 142
 143         /**
 144          * Pop a job off of the queue
 145          *
 146          * @return Job|bool Returns false on failure
 147          */
 148         final public function pop() {
 149                 wfProfileIn( __METHOD__ );
 150                 $job = $this->doPop();
 151                 wfProfileOut( __METHOD__ );
 152                 return $job;
 153         }
 154
 155         /**
 156          * @see JobQueue::pop()
 157          * @return Job
 158          */
 159         abstract protected function doPop();
 160
 161         /**
 162          * Acknowledge that a job was completed.
 163          *
 164          * This does nothing for certain queue classes or if "claimTTL" is not set.
 165          *
 166          * @param $job Job
 167          * @throws MWException
 168          * @return bool
 169          */
 170         final public function ack( Job $job ) {
 171                 if ( $job->getType() !== $this->type ) {
 172                         throw new MWException( "Got '{$job->getType()}' job; expected '{$this->type}'." );
 173                 }
 174                 wfProfileIn( __METHOD__ );
 175                 $ok = $this->doAck( $job );
 176                 wfProfileOut( __METHOD__ );
 177                 return $ok;
 178         }
 179
 180         /**
 181          * @see JobQueue::ack()
 182          * @return bool
 183          */
 184         abstract protected function doAck( Job $job );
 185
 186         /**
 187          * Register the "root job" of a given job into the queue for de-duplication.
 188          * This should only be called right *after* all the new jobs have been inserted.
 189          * This is used to turn older, duplicate, job entries into no-ops. The root job
 190          * information will remain in the registry until it simply falls out of cache.
 191          *
 192          * This requires that $job has two special fields in the "params" array:
 193          *   - rootJobSignature : hash (e.g. SHA1) that identifies the task
 194          *   - rootJobTimestamp : TS_MW timestamp of this instance of the task
 195          *
 196          * A "root job" is a conceptual job that consist of potentially many smaller jobs
 197          * that are actually inserted into the queue. For example, "refreshLinks" jobs are
 198          * spawned when a template is edited. One can think of the task as "update links
 199          * of pages that use template X" and an instance of that task as a "root job".
 200          * However, what actually goes into the queue are potentially many refreshLinks2 jobs.
 201          * Since these jobs include things like page ID ranges and DB master positions, and morph
 202          * into smaller refreshLinks2 jobs recursively, simple duplicate detection (like job_sha1)
 203          * for individual jobs being identical is not useful.
 204          *
 205          * In the case of "refreshLinks", if these jobs are still in the queue when the template
 206          * is edited again, we want all of these old refreshLinks jobs for that template to become
 207          * no-ops. This can greatly reduce server load, since refreshLinks jobs involves parsing.
 208          * Essentially, the new batch of jobs belong to a new "root job" and the older ones to a
 209          * previous "root job" for the same task of "update links of pages that use template X".
 210          *
 211          * This does nothing for certain queue classes.
 212          *
 213          * @param $job Job
 214          * @throws MWException
 215          * @return bool
 216          */
 217         final public function deduplicateRootJob( Job $job ) {
 218                 if ( $job->getType() !== $this->type ) {
 219                         throw new MWException( "Got '{$job->getType()}' job; expected '{$this->type}'." );
 220                 }
 221                 wfProfileIn( __METHOD__ );
 222                 $ok = $this->doDeduplicateRootJob( $job );
 223                 wfProfileOut( __METHOD__ );
 224                 return $ok;
 225         }
 226
 227         /**
 228          * @see JobQueue::deduplicateRootJob()
 229          * @param $job Job
 230          * @return bool
 231          */
 232         protected function doDeduplicateRootJob( Job $job ) {
 233                 return true;
 234         }
 235
 236         /**
 237          * Wait for any slaves or backup servers to catch up.
 238          *
 239          * This does nothing for certain queue classes.
 240          *
 241          * @return void
 242          */
 243         final public function waitForBackups() {
 244                 wfProfileIn( __METHOD__ );
 245                 $this->doWaitForBackups();
 246                 wfProfileOut( __METHOD__ );
 247         }
 248
 249         /**
 250          * @see JobQueue::waitForBackups()
 251          * @return void
 252          */
 253         protected function doWaitForBackups() {}
 254 }