includes/job/Job.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  */
  23
  24 /**
  25  * Class to both describe a background job and handle jobs.
  26  * The queue aspects of this class are now deprecated.
  27  *
  28  * @ingroup JobQueue
  29  */
  30 abstract class Job {
  31         /**
  32          * @var Title
  33          */
  34         var $title;
  35
  36         var $command,
  37                 $params,
  38                 $id,
  39                 $removeDuplicates,
  40                 $error;
  41
  42         /** @var Array Additional queue metadata */
  43         public $metadata = array();
  44
  45         /*-------------------------------------------------------------------------
  46          * Abstract functions
  47          *------------------------------------------------------------------------*/
  48
  49         /**
  50          * Run the job
  51          * @return boolean success
  52          */
  53         abstract public function run();
  54
  55         /*-------------------------------------------------------------------------
  56          * Static functions
  57          *------------------------------------------------------------------------*/
  58
  59         /**
  60          * Create the appropriate object to handle a specific job
  61          *
  62          * @param string $command Job command
  63          * @param $title Title: Associated title
  64          * @param array|bool $params Job parameters
  65          * @param int $id Job identifier
  66          * @throws MWException
  67          * @return Job
  68          */
  69         public static function factory( $command, Title $title, $params = false, $id = 0 ) {
  70                 global $wgJobClasses;
  71                 if ( isset( $wgJobClasses[$command] ) ) {
  72                         $class = $wgJobClasses[$command];
  73                         return new $class( $title, $params, $id );
  74                 }
  75                 throw new MWException( "Invalid job command `{$command}`" );
  76         }
  77
  78         /**
  79          * Batch-insert a group of jobs into the queue.
  80          * This will be wrapped in a transaction with a forced commit.
  81          *
  82          * This may add duplicate at insert time, but they will be
  83          * removed later on, when the first one is popped.
  84          *
  85          * @param array $jobs of Job objects
  86          * @return bool
  87          * @deprecated since 1.21
  88          */
  89         public static function batchInsert( $jobs ) {
  90                 return JobQueueGroup::singleton()->push( $jobs );
  91         }
  92
  93         /**
  94          * Insert a group of jobs into the queue.
  95          *
  96          * Same as batchInsert() but does not commit and can thus
  97          * be rolled-back as part of a larger transaction. However,
  98          * large batches of jobs can cause slave lag.
  99          *
 100          * @param array $jobs of Job objects
 101          * @return bool
 102          * @deprecated since 1.21
 103          */
 104         public static function safeBatchInsert( $jobs ) {
 105                 return JobQueueGroup::singleton()->push( $jobs, JobQueue::QOS_ATOMIC );
 106         }
 107
 108         /**
 109          * Pop a job of a certain type.  This tries less hard than pop() to
 110          * actually find a job; it may be adversely affected by concurrent job
 111          * runners.
 112          *
 113          * @param $type string
 114          * @return Job|bool Returns false if there are no jobs
 115          * @deprecated since 1.21
 116          */
 117         public static function pop_type( $type ) {
 118                 return JobQueueGroup::singleton()->get( $type )->pop();
 119         }
 120
 121         /**
 122          * Pop a job off the front of the queue.
 123          * This is subject to $wgJobTypesExcludedFromDefaultQueue.
 124          *
 125          * @return Job or false if there's no jobs
 126          * @deprecated since 1.21
 127          */
 128         public static function pop() {
 129                 return JobQueueGroup::singleton()->pop();
 130         }
 131
 132         /*-------------------------------------------------------------------------
 133          * Non-static functions
 134          *------------------------------------------------------------------------*/
 135
 136         /**
 137          * @param $command
 138          * @param $title
 139          * @param $params array|bool
 140          * @param $id int
 141          */
 142         public function __construct( $command, $title, $params = false, $id = 0 ) {
 143                 $this->command = $command;
 144                 $this->title = $title;
 145                 $this->params = $params;
 146                 $this->id = $id;
 147
 148                 $this->removeDuplicates = false; // expensive jobs may set this to true
 149         }
 150
 151         /**
 152          * @return integer May be 0 for jobs stored outside the DB
 153          * @deprecated since 1.22
 154          */
 155         public function getId() {
 156                 return $this->id;
 157         }
 158
 159         /**
 160          * @return string
 161          */
 162         public function getType() {
 163                 return $this->command;
 164         }
 165
 166         /**
 167          * @return Title
 168          */
 169         public function getTitle() {
 170                 return $this->title;
 171         }
 172
 173         /**
 174          * @return array
 175          */
 176         public function getParams() {
 177                 return $this->params;
 178         }
 179
 180         /**
 181          * @return integer|null UNIX timestamp to delay running this job until, otherwise null
 182          * @since 1.22
 183          */
 184         public function getReleaseTimestamp() {
 185                 return isset( $this->params['jobReleaseTimestamp'] )
 186                         ? wfTimestampOrNull( TS_UNIX, $this->params['jobReleaseTimestamp'] )
 187                         : null;
 188         }
 189
 190         /**
 191          * @return bool Whether only one of each identical set of jobs should be run
 192          */
 193         public function ignoreDuplicates() {
 194                 return $this->removeDuplicates;
 195         }
 196
 197         /**
 198          * @return bool Whether this job can be retried on failure by job runners
 199          * @since 1.21
 200          */
 201         public function allowRetries() {
 202                 return true;
 203         }
 204
 205         /**
 206          * Subclasses may need to override this to make duplication detection work.
 207          * The resulting map conveys everything that makes the job unique. This is
 208          * only checked if ignoreDuplicates() returns true, meaning that duplicate
 209          * jobs are supposed to be ignored.
 210          *
 211          * @return Array Map of key/values
 212          * @since 1.21
 213          */
 214         public function getDeduplicationInfo() {
 215                 $info = array(
 216                         'type' => $this->getType(),
 217                         'namespace' => $this->getTitle()->getNamespace(),
 218                         'title' => $this->getTitle()->getDBkey(),
 219                         'params' => $this->getParams()
 220                 );
 221                 if ( is_array( $info['params'] ) ) {
 222                         // Identical jobs with different "root" jobs should count as duplicates
 223                         unset( $info['params']['rootJobSignature'] );
 224                         unset( $info['params']['rootJobTimestamp'] );
 225                         // Likewise for jobs with different delay times
 226                         unset( $info['params']['jobReleaseTimestamp'] );
 227                 }
 228                 return $info;
 229         }
 230
 231         /**
 232          * @see JobQueue::deduplicateRootJob()
 233          * @param string $key A key that identifies the task
 234          * @return Array
 235          * @since 1.21
 236          */
 237         public static function newRootJobParams( $key ) {
 238                 return array(
 239                         'rootJobSignature' => sha1( $key ),
 240                         'rootJobTimestamp' => wfTimestampNow()
 241                 );
 242         }
 243
 244         /**
 245          * @see JobQueue::deduplicateRootJob()
 246          * @return Array
 247          * @since 1.21
 248          */
 249         public function getRootJobParams() {
 250                 return array(
 251                         'rootJobSignature' => isset( $this->params['rootJobSignature'] )
 252                                 ? $this->params['rootJobSignature']
 253                                 : null,
 254                         'rootJobTimestamp' => isset( $this->params['rootJobTimestamp'] )
 255                                 ? $this->params['rootJobTimestamp']
 256                                 : null
 257                 );
 258         }
 259
 260         /**
 261          * @see JobQueue::deduplicateRootJob()
 262          * @return bool
 263          * @since 1.22
 264          */
 265         public function hasRootJobParams() {
 266                 return isset( $this->params['rootJobSignature'] )
 267                         && isset( $this->params['rootJobTimestamp'] );
 268         }
 269
 270         /**
 271          * Insert a single job into the queue.
 272          * @return bool true on success
 273          * @deprecated since 1.21
 274          */
 275         public function insert() {
 276                 return JobQueueGroup::singleton()->push( $this );
 277         }
 278
 279         /**
 280          * @return string
 281          */
 282         public function toString() {
 283                 $paramString = '';
 284                 if ( $this->params ) {
 285                         foreach ( $this->params as $key => $value ) {
 286                                 if ( $paramString != '' ) {
 287                                         $paramString .= ' ';
 288                                 }
 289                                 if ( is_array( $value ) ) {
 290                                         $value = "array(" . count( $value ) . ")";
 291                                 } elseif ( is_object( $value ) && !method_exists( $value, '__toString' ) ) {
 292                                         $value = "object(" . get_class( $value ) . ")";
 293                                 }
 294                                 $value = (string)$value;
 295                                 if ( mb_strlen( $value ) > 1024 ) {
 296                                         $value = "string(" . mb_strlen( $value ) . ")";
 297                                 }
 298
 299                                 $paramString .= "$key=$value";
 300                         }
 301                 }
 302
 303                 if ( is_object( $this->title ) ) {
 304                         $s = "{$this->command} " . $this->title->getPrefixedDBkey();
 305                         if ( $paramString !== '' ) {
 306                                 $s .= ' ' . $paramString;
 307                         }
 308                         return $s;
 309                 } else {
 310                         return "{$this->command} $paramString";
 311                 }
 312         }
 313
 314         protected function setLastError( $error ) {
 315                 $this->error = $error;
 316         }
 317
 318         public function getLastError() {
 319                 return $this->error;
 320         }
 321 }