JobSpecification.php

Go to the documentation of this file.

<?php
namespace MediaWiki\JobQueue;
 
use MediaWiki\Http\Telemetry;
use MediaWiki\Page\PageReference;
use MediaWiki\Page\PageReferenceValue;
use UnexpectedValueException;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class JobSpecification implements IJobSpecification {
    protected $type;
 
    protected $params;
 
    protected $page;
 
    protected $opts;
 
    public function __construct(
        $type, array $params, array $opts = [], ?PageReference $page = null
    ) {
        $params += [
            'requestId' => Telemetry::getInstance()->getRequestId(),
        ];
        $this->validateParams( $params );
        $this->validateParams( $opts );
 
        $this->type = $type;
        if ( $page ) {
            // Make sure JobQueue classes can pull the title from parameters alone
            if ( $page->getDBkey() !== '' ) {
                $params += [
                    'namespace' => $page->getNamespace(),
                    'title' => $page->getDBkey()
                ];
            }
        } else {
            // We aim to remove the page from job specification and all we need
            // is namespace/dbkey, so use LOCAL no matter what.
            $page = PageReferenceValue::localReference( NS_SPECIAL, 'Badtitle/' . __CLASS__ );
        }
        $this->params = $params;
        $this->page = $page;
        $this->opts = $opts;
    }
 
    protected function validateParams( array $params ) {
        foreach ( $params as $p => $v ) {
            if ( is_array( $v ) ) {
                $this->validateParams( $v );
            } elseif ( !is_scalar( $v ) && $v !== null ) {
                throw new UnexpectedValueException( "Job parameter $p is not JSON serializable." );
            }
        }
    }
 
    public function getType() {
        return $this->type;
    }
 
    public function getParams() {
        return $this->params;
    }
 
    public function getReleaseTimestamp() {
        return isset( $this->params['jobReleaseTimestamp'] )
            ? wfTimestampOrNull( TS::UNIX, $this->params['jobReleaseTimestamp'] )
            : null;
    }
 
    public function ignoreDuplicates() {
        return !empty( $this->opts['removeDuplicates'] );
    }
 
    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'] );
            if ( isset( $this->opts['removeDuplicatesIgnoreParams'] ) ) {
                foreach ( $this->opts['removeDuplicatesIgnoreParams'] as $field ) {
                    unset( $info['params'][$field] );
                }
            }
        }
 
        return $info;
    }
 
    public function getRootJobParams() {
        return [
            'rootJobSignature' => $this->params['rootJobSignature'] ?? null,
            'rootJobTimestamp' => $this->params['rootJobTimestamp'] ?? null
        ];
    }
 
    public function hasRootJobParams() {
        return isset( $this->params['rootJobSignature'] )
            && isset( $this->params['rootJobTimestamp'] );
    }
 
    public function isRootJob() {
        return $this->hasRootJobParams() && !empty( $this->params['rootJobIsSelf'] );
    }
 
    public static function newFromArray( array $map ) {
        return new self(
            $map['type'],
            $map['params'],
            $map['opts'],
            PageReferenceValue::localReference( $map['title']['ns'], $map['title']['key'] )
        );
    }
}
 
class_alias( JobSpecification::class, 'JobSpecification' );