3 * Job queue task base code.
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.
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.
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
21 * @defgroup JobQueue JobQueue
25 * Class to both describe a background job and handle jobs.
26 * To push jobs onto queues, use JobQueueGroup::singleton()->push();
30 abstract class Job
implements RunnableJob
{
34 /** @var array Array of job parameters */
37 /** @var array Additional queue metadata */
38 public $metadata = [];
43 /** @var bool Expensive jobs may set this to true */
44 protected $removeDuplicates = false;
46 /** @var string Text for error that occurred last */
49 /** @var callable[] */
50 protected $teardownCallbacks = [];
52 /** @var int Bitfield of JOB_* class constants */
53 protected $executionFlags = 0;
56 * Create the appropriate object to handle a specific job
58 * @param string $command Job command
59 * @param array|Title $params Job parameters
60 * @throws InvalidArgumentException
63 public static function factory( $command, $params = [] ) {
66 if ( $params instanceof Title
) {
67 // Backwards compatibility for old signature ($command, $title, $params)
69 $params = func_num_args() >= 3 ?
func_get_arg( 2 ) : [];
70 } elseif ( isset( $params['namespace'] ) && isset( $params['title'] ) ) {
71 // Handle job classes that take title as constructor parameter.
72 // If a newer classes like GenericParameterJob uses these parameters,
73 // then this happens in Job::__construct instead.
74 $title = Title
::makeTitle( $params['namespace'], $params['title'] );
76 // Default title for job classes not implementing GenericParameterJob.
77 // This must be a valid title because it not directly passed to
78 // our Job constructor, but rather it's subclasses which may expect
79 // to be able to use it.
80 $title = Title
::makeTitle( NS_SPECIAL
, 'Blankpage' );
83 if ( isset( $wgJobClasses[$command] ) ) {
84 $handler = $wgJobClasses[$command];
86 if ( is_callable( $handler ) ) {
87 $job = call_user_func( $handler, $title, $params );
88 } elseif ( class_exists( $handler ) ) {
89 if ( is_subclass_of( $handler, GenericParameterJob
::class ) ) {
90 $job = new $handler( $params );
92 $job = new $handler( $title, $params );
98 if ( $job instanceof Job
) {
99 $job->command
= $command;
103 throw new InvalidArgumentException(
104 "Could not instantiate job '$command': bad spec!"
109 throw new InvalidArgumentException( "Invalid job command '{$command}'" );
113 * @param string $command
114 * @param array|Title|null $params
116 public function __construct( $command, $params = null ) {
117 if ( $params instanceof Title
) {
118 // Backwards compatibility for old signature ($command, $title, $params)
120 $params = func_num_args() >= 3 ?
func_get_arg( 2 ) : [];
122 // Newer jobs may choose to not have a top-level title (e.g. GenericParameterJob)
126 if ( !is_array( $params ) ) {
127 throw new InvalidArgumentException( '$params must be an array' );
132 !isset( $params['namespace'] ) &&
133 !isset( $params['title'] )
135 // When constructing this class for submitting to the queue,
136 // normalise the $title arg of old job classes as part of $params.
137 $params['namespace'] = $title->getNamespace();
138 $params['title'] = $title->getDBkey();
141 $this->command
= $command;
142 $this->params
= $params +
[ 'requestId' => WebRequest
::getRequestId() ];
144 if ( $this->title
=== null ) {
145 // Set this field for access via getTitle().
146 $this->title
= ( isset( $params['namespace'] ) && isset( $params['title'] ) )
147 ? Title
::makeTitle( $params['namespace'], $params['title'] )
148 // GenericParameterJob classes without namespace/title params
149 // should not use getTitle(). Set an invalid title as placeholder.
150 : Title
::makeTitle( NS_SPECIAL
, '' );
154 public function hasExecutionFlag( $flag ) {
155 return ( $this->executionFlags
& $flag ) === $flag;
161 public function getType() {
162 return $this->command
;
168 final public function getTitle() {
175 public function getParams() {
176 return $this->params
;
180 * @param string|null $field Metadata field or null to get all the metadata
181 * @return mixed|null Value; null if missing
184 public function getMetadata( $field = null ) {
185 if ( $field === null ) {
186 return $this->metadata
;
189 return $this->metadata
[$field] ??
null;
193 * @param string $field Key name to set the value for
194 * @param mixed $value The value to set the field for
195 * @return mixed|null The prior field value; null if missing
198 public function setMetadata( $field, $value ) {
199 $old = $this->getMetadata( $field );
200 if ( $value === null ) {
201 unset( $this->metadata
[$field] );
203 $this->metadata
[$field] = $value;
210 * @return int|null UNIX timestamp to delay running this job until, otherwise null
213 public function getReleaseTimestamp() {
214 return isset( $this->params
['jobReleaseTimestamp'] )
215 ?
wfTimestampOrNull( TS_UNIX
, $this->params
['jobReleaseTimestamp'] )
220 * @return int|null UNIX timestamp of when the job was queued, or null
223 public function getQueuedTimestamp() {
224 return isset( $this->metadata
['timestamp'] )
225 ?
wfTimestampOrNull( TS_UNIX
, $this->metadata
['timestamp'] )
229 public function getRequestId() {
230 return $this->params
['requestId'] ??
null;
233 public function getReadyTimestamp() {
234 return $this->getReleaseTimestamp() ?
: $this->getQueuedTimestamp();
238 * Whether the queue should reject insertion of this job if a duplicate exists
240 * This can be used to avoid duplicated effort or combined with delayed jobs to
241 * coalesce updates into larger batches. Claimed jobs are never treated as
242 * duplicates of new jobs, and some queues may allow a few duplicates due to
243 * network partitions and fail-over. Thus, additional locking is needed to
244 * enforce mutual exclusion if this is really needed.
248 public function ignoreDuplicates() {
249 return $this->removeDuplicates
;
252 public function allowRetries() {
256 public function workItemCount() {
261 * Subclasses may need to override this to make duplication detection work.
262 * The resulting map conveys everything that makes the job unique. This is
263 * only checked if ignoreDuplicates() returns true, meaning that duplicate
264 * jobs are supposed to be ignored.
266 * @return array Map of key/values
269 public function getDeduplicationInfo() {
271 'type' => $this->getType(),
272 'params' => $this->getParams()
274 if ( is_array( $info['params'] ) ) {
275 // Identical jobs with different "root" jobs should count as duplicates
276 unset( $info['params']['rootJobSignature'] );
277 unset( $info['params']['rootJobTimestamp'] );
278 // Likewise for jobs with different delay times
279 unset( $info['params']['jobReleaseTimestamp'] );
280 // Identical jobs from different requests should count as duplicates
281 unset( $info['params']['requestId'] );
282 // Queues pack and hash this array, so normalize the order
283 ksort( $info['params'] );
290 * Get "root job" parameters for a task
292 * This is used to no-op redundant jobs, including child jobs of jobs,
293 * as long as the children inherit the root job parameters. When a job
294 * with root job parameters and "rootJobIsSelf" set is pushed, the
295 * deduplicateRootJob() method is automatically called on it. If the
296 * root job is only virtual and not actually pushed (e.g. the sub-jobs
297 * are inserted directly), then call deduplicateRootJob() directly.
299 * @see JobQueue::deduplicateRootJob()
301 * @param string $key A key that identifies the task
302 * @return array Map of:
303 * - rootJobIsSelf : true
304 * - rootJobSignature : hash (e.g. SHA1) that identifies the task
305 * - rootJobTimestamp : TS_MW timestamp of this instance of the task
308 public static function newRootJobParams( $key ) {
310 'rootJobIsSelf' => true,
311 'rootJobSignature' => sha1( $key ),
312 'rootJobTimestamp' => wfTimestampNow()
317 * @see JobQueue::deduplicateRootJob()
321 public function getRootJobParams() {
323 'rootJobSignature' => $this->params
['rootJobSignature'] ??
null,
324 'rootJobTimestamp' => $this->params
['rootJobTimestamp'] ??
null
329 * @see JobQueue::deduplicateRootJob()
333 public function hasRootJobParams() {
334 return isset( $this->params
['rootJobSignature'] )
335 && isset( $this->params
['rootJobTimestamp'] );
339 * @see JobQueue::deduplicateRootJob()
340 * @return bool Whether this is job is a root job
342 public function isRootJob() {
343 return $this->hasRootJobParams() && !empty( $this->params
['rootJobIsSelf'] );
347 * @param callable $callback A function with one parameter, the success status, which will be
348 * false if the job failed or it succeeded but the DB changes could not be committed or
349 * any deferred updates threw an exception. (This parameter was added in 1.28.)
352 protected function addTeardownCallback( $callback ) {
353 $this->teardownCallbacks
[] = $callback;
356 public function teardown( $status ) {
357 foreach ( $this->teardownCallbacks
as $callback ) {
358 call_user_func( $callback, $status );
362 public function toString() {
364 if ( $this->params
) {
365 foreach ( $this->params
as $key => $value ) {
366 if ( $paramString != '' ) {
369 if ( is_array( $value ) ) {
371 foreach ( $value as $k => $v ) {
372 $json = FormatJson
::encode( $v );
373 if ( $json === false ||
mb_strlen( $json ) > 512 ) {
374 $filteredValue[$k] = gettype( $v ) . '(...)';
376 $filteredValue[$k] = $v;
379 if ( count( $filteredValue ) <= 10 ) {
380 $value = FormatJson
::encode( $filteredValue );
382 $value = "array(" . count( $value ) . ")";
384 } elseif ( is_object( $value ) && !method_exists( $value, '__toString' ) ) {
385 $value = "object(" . get_class( $value ) . ")";
388 $flatValue = (string)$value;
389 if ( mb_strlen( $value ) > 1024 ) {
390 $flatValue = "string(" . mb_strlen( $value ) . ")";
393 $paramString .= "$key={$flatValue}";
398 foreach ( $this->metadata
as $key => $value ) {
399 if ( is_scalar( $value ) && mb_strlen( $value ) < 1024 ) {
400 $metaString .= ( $metaString ?
",$key=$value" : "$key=$value" );
405 if ( is_object( $this->title
) ) {
406 $s .= " {$this->title->getPrefixedDBkey()}";
408 if ( $paramString != '' ) {
409 $s .= " $paramString";
411 if ( $metaString != '' ) {
412 $s .= " ($metaString)";
418 protected function setLastError( $error ) {
419 $this->error
= $error;
422 public function getLastError() {