includes/jobqueue/Job.php

   1 <?php
   2 /**
   3  * Job queue task 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  * Using the class to push jobs onto queues is deprecated (use JobSpecification).
  28  *
  29  * @ingroup JobQueue
  30  */
  31 abstract class Job implements IJobSpecification {
  32         /** @var string */
  33         public $command;
  34
  35         /** @var array|bool Array of job parameters or false if none */
  36         public $params;
  37
  38         /** @var array Additional queue metadata */
  39         public $metadata = array();
  40
  41         /** @var Title */
  42         protected $title;
  43
  44         /** @var bool Expensive jobs may set this to true */
  45         protected $removeDuplicates;
  46
  47         /** @var string Text for error that occurred last */
  48         protected $error;
  49
  50         /**
  51          * Run the job
  52          * @return bool Success
  53          */
  54         abstract public function run();
  55
  56         /**
  57          * Create the appropriate object to handle a specific job
  58          *
  59          * @param string $command Job command
  60          * @param Title $title Associated title
  61          * @param array|bool $params Job parameters
  62          * @throws MWException
  63          * @return Job
  64          */
  65         public static function factory( $command, Title $title, $params = false ) {
  66                 global $wgJobClasses;
  67                 if ( isset( $wgJobClasses[$command] ) ) {
  68                         $class = $wgJobClasses[$command];
  69
  70                         return new $class( $title, $params );
  71                 }
  72                 throw new MWException( "Invalid job command `{$command}`" );
  73         }
  74
  75         /**
  76          * @param string $command
  77          * @param Title $title
  78          * @param array|bool $params Can not be === true
  79          */
  80         public function __construct( $command, $title, $params = false ) {
  81                 $this->command = $command;
  82                 $this->title = $title;
  83                 $this->params = $params;
  84
  85                 // expensive jobs may set this to true
  86                 $this->removeDuplicates = false;
  87         }
  88
  89         /**
  90          * Batch-insert a group of jobs into the queue.
  91          * This will be wrapped in a transaction with a forced commit.
  92          *
  93          * This may add duplicate at insert time, but they will be
  94          * removed later on, when the first one is popped.
  95          *
  96          * @param Job[] $jobs Array of Job objects
  97          * @return bool
  98          * @deprecated since 1.21
  99          */
 100         public static function batchInsert( $jobs ) {
 101                 wfDeprecated( __METHOD__, '1.21' );
 102                 JobQueueGroup::singleton()->push( $jobs );
 103                 return true;
 104         }
 105
 106         /**
 107          * @return string
 108          */
 109         public function getType() {
 110                 return $this->command;
 111         }
 112
 113         /**
 114          * @return Title
 115          */
 116         public function getTitle() {
 117                 return $this->title;
 118         }
 119
 120         /**
 121          * @return array
 122          */
 123         public function getParams() {
 124                 return $this->params;
 125         }
 126
 127         /**
 128          * @return int|null UNIX timestamp to delay running this job until, otherwise null
 129          * @since 1.22
 130          */
 131         public function getReleaseTimestamp() {
 132                 return isset( $this->params['jobReleaseTimestamp'] )
 133                         ? wfTimestampOrNull( TS_UNIX, $this->params['jobReleaseTimestamp'] )
 134                         : null;
 135         }
 136
 137         /**
 138          * Whether the queue should reject insertion of this job if a duplicate exists
 139          *
 140          * This can be used to avoid duplicated effort or combined with delayed jobs to
 141          * coalesce updates into larger batches. Claimed jobs are never treated as
 142          * duplicates of new jobs, and some queues may allow a few duplicates due to
 143          * network partitions and fail-over. Thus, additional locking is needed to
 144          * enforce mutual exclusion if this is really needed.
 145          *
 146          * @return bool
 147          */
 148         public function ignoreDuplicates() {
 149                 return $this->removeDuplicates;
 150         }
 151
 152         /**
 153          * @return bool Whether this job can be retried on failure by job runners
 154          * @since 1.21
 155          */
 156         public function allowRetries() {
 157                 return true;
 158         }
 159
 160         /**
 161          * @return int Number of actually "work items" handled in this job
 162          * @see $wgJobBackoffThrottling
 163          * @since 1.23
 164          */
 165         public function workItemCount() {
 166                 return 1;
 167         }
 168
 169         /**
 170          * Subclasses may need to override this to make duplication detection work.
 171          * The resulting map conveys everything that makes the job unique. This is
 172          * only checked if ignoreDuplicates() returns true, meaning that duplicate
 173          * jobs are supposed to be ignored.
 174          *
 175          * @return array Map of key/values
 176          * @since 1.21
 177          */
 178         public function getDeduplicationInfo() {
 179                 $info = array(
 180                         'type' => $this->getType(),
 181                         'namespace' => $this->getTitle()->getNamespace(),
 182                         'title' => $this->getTitle()->getDBkey(),
 183                         'params' => $this->getParams()
 184                 );
 185                 if ( is_array( $info['params'] ) ) {
 186                         // Identical jobs with different "root" jobs should count as duplicates
 187                         unset( $info['params']['rootJobSignature'] );
 188                         unset( $info['params']['rootJobTimestamp'] );
 189                         // Likewise for jobs with different delay times
 190                         unset( $info['params']['jobReleaseTimestamp'] );
 191                         // Queues pack and hash this array, so normalize the order
 192                         ksort( $info['params'] );
 193                 }
 194
 195                 return $info;
 196         }
 197
 198         /**
 199          * @see JobQueue::deduplicateRootJob()
 200          * @param string $key A key that identifies the task
 201          * @return array Map of:
 202          *   - rootJobSignature : hash (e.g. SHA1) that identifies the task
 203          *   - rootJobTimestamp : TS_MW timestamp of this instance of the task
 204          * @since 1.21
 205          */
 206         public static function newRootJobParams( $key ) {
 207                 return array(
 208                         'rootJobSignature' => sha1( $key ),
 209                         'rootJobTimestamp' => wfTimestampNow()
 210                 );
 211         }
 212
 213         /**
 214          * @see JobQueue::deduplicateRootJob()
 215          * @return array
 216          * @since 1.21
 217          */
 218         public function getRootJobParams() {
 219                 return array(
 220                         'rootJobSignature' => isset( $this->params['rootJobSignature'] )
 221                                 ? $this->params['rootJobSignature']
 222                                 : null,
 223                         'rootJobTimestamp' => isset( $this->params['rootJobTimestamp'] )
 224                                 ? $this->params['rootJobTimestamp']
 225                                 : null
 226                 );
 227         }
 228
 229         /**
 230          * @see JobQueue::deduplicateRootJob()
 231          * @return bool
 232          * @since 1.22
 233          */
 234         public function hasRootJobParams() {
 235                 return isset( $this->params['rootJobSignature'] )
 236                         && isset( $this->params['rootJobTimestamp'] );
 237         }
 238
 239         /**
 240          * Insert a single job into the queue.
 241          * @return bool True on success
 242          * @deprecated since 1.21
 243          */
 244         public function insert() {
 245                 JobQueueGroup::singleton()->push( $this );
 246                 return true;
 247         }
 248
 249         /**
 250          * @return string
 251          */
 252         public function toString() {
 253                 $truncFunc = function ( $value ) {
 254                         $value = (string)$value;
 255                         if ( mb_strlen( $value ) > 1024 ) {
 256                                 $value = "string(" . mb_strlen( $value ) . ")";
 257                         }
 258                         return $value;
 259                 };
 260
 261                 $paramString = '';
 262                 if ( $this->params ) {
 263                         foreach ( $this->params as $key => $value ) {
 264                                 if ( $paramString != '' ) {
 265                                         $paramString .= ' ';
 266                                 }
 267                                 if ( is_array( $value ) ) {
 268                                         $filteredValue = array();
 269                                         foreach ( $value as $k => $v ) {
 270                                                 if ( is_scalar( $v ) ) {
 271                                                         $filteredValue[$k] = $truncFunc( $v );
 272                                                 } else {
 273                                                         $filteredValue = null;
 274                                                         break;
 275                                                 }
 276                                         }
 277                                         if ( $filteredValue && count( $filteredValue ) < 10 ) {
 278                                                 $value = FormatJson::encode( $filteredValue );
 279                                         } else {
 280                                                 $value = "array(" . count( $value ) . ")";
 281                                         }
 282                                 } elseif ( is_object( $value ) && !method_exists( $value, '__toString' ) ) {
 283                                         $value = "object(" . get_class( $value ) . ")";
 284                                 }
 285
 286                                 $paramString .= "$key={$truncFunc( $value )}";
 287                         }
 288                 }
 289
 290                 $metaString = '';
 291                 foreach ( $this->metadata as $key => $value ) {
 292                         if ( is_scalar( $value ) && mb_strlen( $value ) < 1024 ) {
 293                                 $metaString .= ( $metaString ? ",$key=$value" : "$key=$value" );
 294                         }
 295                 }
 296
 297                 $s = $this->command;
 298                 if ( is_object( $this->title ) ) {
 299                         $s .= " {$this->title->getPrefixedDBkey()}";
 300                 }
 301                 if ( $paramString != '' ) {
 302                         $s .= " $paramString";
 303                 }
 304                 if ( $metaString != '' ) {
 305                         $s .= " ($metaString)";
 306                 }
 307
 308                 return $s;
 309         }
 310
 311         protected function setLastError( $error ) {
 312                 $this->error = $error;
 313         }
 314
 315         public function getLastError() {
 316                 return $this->error;
 317         }
 318 }