| Server IP : 167.235.224.122 / Your IP : 216.73.216.110 Web Server : Apache/2.4.58 (Ubuntu) System : Linux newplayground 6.8.0-136-generic #136-Ubuntu SMP PREEMPT_DYNAMIC Wed Jul 1 21:33:11 UTC 2026 aarch64 User : deploy ( 1000) PHP Version : 8.4.23 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /var/www/html/wiki/includes/jobqueue/ |
Upload File : |
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\JobQueue;
use InvalidArgumentException;
use MediaWiki\Http\Telemetry;
use MediaWiki\Json\FormatJson;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageReference;
use MediaWiki\Title\Title;
/**
* Describe and execute a background job.
*
* Callers should use JobQueueGroup to enqueue jobs for deferred execution.
*
* See [the architecture doc](@ref jobqueuearch) for more information.
*
* @stable to extend
* @since 1.6
* @ingroup JobQueue
*/
abstract class Job implements RunnableJob {
/** @var string */
public $command;
/** @var array Array of job parameters */
public $params;
/** @var array Additional queue metadata */
public $metadata = [];
/** @var Title */
protected $title;
/** @var bool Expensive jobs may set this to true */
protected $removeDuplicates = false;
/** @var string Text for error that occurred last */
protected $error;
/** @var callable[] */
protected $teardownCallbacks = [];
/** @var int Bitfield of JOB_* class constants */
protected $executionFlags = 0;
/**
* Create the appropriate object to handle a specific job
*
* @deprecated since 1.40, use JobFactory instead.
*
* @param string $command Job command
* @param array|PageReference $params Job parameters
* @return Job
*/
public static function factory( $command, $params = [] ) {
$factory = MediaWikiServices::getInstance()->getJobFactory();
// FIXME: fix handling for legacy signature!
// @phan-suppress-next-line PhanParamTooFewUnpack one argument is known to be present.
return $factory->newJob( ...func_get_args() );
}
/**
* @stable to call
*
* @param string $command
* @param array|PageReference|null $params The parameters for the job. Note that if providing,
* a 'requestId' key it should be a value from {@link Telemetry::getRequestId}.
*/
public function __construct( $command, $params = null ) {
if ( $params instanceof PageReference ) {
// Backwards compatibility for old signature ($command, $title, $params)
$page = $params;
$params = func_num_args() >= 3 ? func_get_arg( 2 ) : [];
} else {
// Newer jobs may choose to not have a top-level title (e.g. GenericParameterJob)
$page = null;
}
if ( !is_array( $params ) ) {
throw new InvalidArgumentException( '$params must be an array' );
}
if (
$page &&
!isset( $params['namespace'] ) &&
!isset( $params['title'] )
) {
// When constructing this class for submitting to the queue,
// normalise the $page arg of old job classes as part of $params.
$params['namespace'] = $page->getNamespace();
$params['title'] = $page->getDBkey();
}
$this->command = $command;
$this->params = $params + [
'requestId' => Telemetry::getInstance()->getRequestId(),
];
if ( $this->title === null ) {
// Set this field for access via getTitle().
$this->title = ( isset( $params['namespace'] ) && isset( $params['title'] ) )
? Title::makeTitle( $params['namespace'], $params['title'] )
// GenericParameterJob classes without namespace/title params
// should not use getTitle(). Set an invalid title as placeholder.
: Title::makeTitle( NS_SPECIAL, '' );
}
}
/**
* @inheritDoc
* @stable to override
*/
public function hasExecutionFlag( $flag ) {
return ( $this->executionFlags & $flag ) === $flag;
}
/**
* @inheritDoc
* @stable to override
*/
public function getType() {
return $this->command;
}
/**
* @return Title
*/
final public function getTitle() {
return $this->title;
}
/**
* @inheritDoc
* @stable to override
*/
public function getParams() {
return $this->params;
}
/**
* @stable to override
* @param string|null $field Metadata field or null to get all the metadata
* @return mixed|null Value; null if missing
* @since 1.33
*/
public function getMetadata( $field = null ) {
if ( $field === null ) {
return $this->metadata;
}
return $this->metadata[$field] ?? null;
}
/**
* @stable to override
* @param string $field Key name to set the value for
* @param mixed $value The value to set the field for
* @return mixed|null The prior field value; null if missing
* @since 1.33
*/
public function setMetadata( $field, $value ) {
$old = $this->getMetadata( $field );
if ( $value === null ) {
unset( $this->metadata[$field] );
} else {
$this->metadata[$field] = $value;
}
return $old;
}
/**
* @stable to override
* @return int|null UNIX timestamp to delay running this job until, otherwise null
* @since 1.22
*/
public function getReleaseTimestamp() {
$time = wfTimestampOrNull( TS_UNIX, $this->params['jobReleaseTimestamp'] ?? null );
return $time ? (int)$time : null;
}
/**
* @return int|null UNIX timestamp of when the job was queued, or null
* @since 1.26
*/
public function getQueuedTimestamp() {
$time = wfTimestampOrNull( TS_UNIX, $this->metadata['timestamp'] ?? null );
return $time ? (int)$time : null;
}
/**
* @inheritDoc
* @stable to override
*/
public function getRequestId() {
return $this->params['requestId'] ?? null;
}
/**
* @inheritDoc
* @stable to override
*/
public function getReadyTimestamp() {
return $this->getReleaseTimestamp() ?: $this->getQueuedTimestamp();
}
/**
* Whether the queue should reject insertion of this job if a duplicate exists
*
* This can be used to avoid duplicated effort or combined with delayed jobs to
* coalesce updates into larger batches. Claimed jobs are never treated as
* duplicates of new jobs, and some queues may allow a few duplicates due to
* network partitions and fail-over. Thus, additional locking is needed to
* enforce mutual exclusion if this is really needed.
*
* @stable to override
*
* @return bool
*/
public function ignoreDuplicates() {
return $this->removeDuplicates;
}
/**
* @inheritDoc
* @stable to override
*/
public function allowRetries() {
return true;
}
/**
* @stable to override
* @return int
*/
public function workItemCount() {
return 1;
}
/**
* Subclasses may need to override this to make duplication detection work.
* The resulting map conveys everything that makes the job unique. This is
* only checked if ignoreDuplicates() returns true, meaning that duplicate
* jobs are supposed to be ignored.
*
* @stable to override
* @return array Map of key/values
* @since 1.21
*/
public function getDeduplicationInfo() {
$info = [
'type' => $this->getType(),
'params' => $this->getParams()
];
if ( is_array( $info['params'] ) ) {
// Identical jobs with different "root" jobs should count as duplicates
unset( $info['params']['rootJobSignature'] );
unset( $info['params']['rootJobTimestamp'] );
// Likewise for jobs with different delay times
unset( $info['params']['jobReleaseTimestamp'] );
// Identical jobs from different requests should count as duplicates
unset( $info['params']['requestId'] );
// Queues pack and hash this array, so normalize the order
ksort( $info['params'] );
}
return $info;
}
/**
* Get "root job" parameters for a task
*
* This is used to no-op redundant jobs, including child jobs of jobs,
* as long as the children inherit the root job parameters. When a job
* with root job parameters and "rootJobIsSelf" set is pushed, the
* deduplicateRootJob() method is automatically called on it. If the
* root job is only virtual and not actually pushed (e.g. the sub-jobs
* are inserted directly), then call deduplicateRootJob() directly.
*
* @see JobQueue::deduplicateRootJob()
*
* @param string $key A key that identifies the task
* @return array Map of:
* - rootJobIsSelf : true
* - rootJobSignature : hash (e.g. SHA1) that identifies the task
* - rootJobTimestamp : TS_MW timestamp of this instance of the task
* @since 1.21
*/
public static function newRootJobParams( $key ) {
return [
'rootJobIsSelf' => true,
'rootJobSignature' => sha1( $key ),
'rootJobTimestamp' => wfTimestampNow()
];
}
/**
* @stable to override
* @see JobQueue::deduplicateRootJob()
* @return array
* @since 1.21
*/
public function getRootJobParams() {
return [
'rootJobSignature' => $this->params['rootJobSignature'] ?? null,
'rootJobTimestamp' => $this->params['rootJobTimestamp'] ?? null
];
}
/**
* @stable to override
* @see JobQueue::deduplicateRootJob()
* @return bool
* @since 1.22
*/
public function hasRootJobParams() {
return isset( $this->params['rootJobSignature'] )
&& isset( $this->params['rootJobTimestamp'] );
}
/**
* @stable to override
* @see JobQueue::deduplicateRootJob()
* @return bool Whether this is job is a root job
*/
public function isRootJob() {
return $this->hasRootJobParams() && !empty( $this->params['rootJobIsSelf'] );
}
/**
* @param callable $callback A function with one parameter, the success status, which will be
* false if the job failed or it succeeded but the DB changes could not be committed or
* any deferred updates threw an exception. (This parameter was added in 1.28.)
* @since 1.27
*/
protected function addTeardownCallback( $callback ) {
$this->teardownCallbacks[] = $callback;
}
/**
* @inheritDoc
* @stable to override
*/
public function teardown( $status ) {
foreach ( $this->teardownCallbacks as $callback ) {
$callback( $status );
}
}
/**
* @inheritDoc
* @stable to override
*/
public function toString() {
$paramString = '';
if ( $this->params ) {
foreach ( $this->params as $key => $value ) {
if ( $paramString != '' ) {
$paramString .= ' ';
}
if ( is_array( $value ) ) {
$filteredValue = [];
foreach ( $value as $k => $v ) {
$json = FormatJson::encode( $v );
if ( $json === false || mb_strlen( $json ) > 512 ) {
$filteredValue[$k] = get_debug_type( $v ) . '(...)';
} else {
$filteredValue[$k] = $v;
}
}
if ( count( $filteredValue ) <= 10 ) {
$value = FormatJson::encode( $filteredValue );
} else {
$value = "array(" . count( $value ) . ")";
}
} elseif ( is_object( $value ) && !method_exists( $value, '__toString' ) ) {
$value = get_debug_type( $value );
}
$flatValue = (string)$value;
if ( mb_strlen( $flatValue ) > 1024 ) {
$flatValue = "string(" . mb_strlen( $value ) . ")";
}
// Remove newline characters from the value, since
// newlines indicate new job lines in log files
$flatValue = preg_replace( '/\s+/', ' ', $flatValue );
$paramString .= "$key={$flatValue}";
}
}
$metaString = '';
foreach ( $this->metadata as $key => $value ) {
if ( is_scalar( $value ) && mb_strlen( $value ) < 1024 ) {
$metaString .= ( $metaString ? ",$key=$value" : "$key=$value" );
}
}
$s = $this->command;
if ( is_object( $this->title ) ) {
$s .= ' ' . $this->title->getPrefixedDBkey();
}
if ( $paramString != '' ) {
$s .= " $paramString";
}
if ( $metaString != '' ) {
$s .= " ($metaString)";
}
return $s;
}
protected function setLastError( $error ) {
$this->error = $error;
}
/**
* @inheritDoc
* @stable to override
*/
public function getLastError() {
return $this->error;
}
}
/** @deprecated class alias since 1.44 */
class_alias( Job::class, 'Job' );