Job.php

Go to the documentation of this file.

<?php
abstract class Job implements IJobSpecification {
    public $command;

    public $params;

    public $metadata = [];

    protected $title;

    protected $removeDuplicates;

    protected $error;

    protected $teardownCallbacks = [];

    abstract public function run();

    public static function factory( $command, Title $title, $params = [] ) {
        global $wgJobClasses;

        if ( isset( $wgJobClasses[$command] ) ) {
            $class = $wgJobClasses[$command];

            $job = new $class( $title, $params );
            $job->command = $command;

            return $job;
        }

        throw new InvalidArgumentException( "Invalid job command '{$command}'" );
    }

    public function __construct( $command, $title, $params = false ) {
        $this->command = $command;
        $this->title = $title;
        $this->params = is_array( $params ) ? $params : []; // sanity

        // expensive jobs may set this to true
        $this->removeDuplicates = false;

        if ( !isset( $this->params['requestId'] ) ) {
            $this->params['requestId'] = WebRequest::getRequestId();
        }
    }

    public static function batchInsert( $jobs ) {
        wfDeprecated( __METHOD__, '1.21' );
        JobQueueGroup::singleton()->push( $jobs );
        return true;
    }

    public function getType() {
        return $this->command;
    }

    public function getTitle() {
        return $this->title;
    }

    public function getParams() {
        return $this->params;
    }

    public function getReleaseTimestamp() {
        return isset( $this->params['jobReleaseTimestamp'] )
            ? wfTimestampOrNull( TS_UNIX, $this->params['jobReleaseTimestamp'] )
            : null;
    }

    public function getQueuedTimestamp() {
        return isset( $this->metadata['timestamp'] )
            ? wfTimestampOrNull( TS_UNIX, $this->metadata['timestamp'] )
            : null;
    }

    public function getRequestId() {
        return isset( $this->params['requestId'] )
            ? $this->params['requestId']
            : null;
    }

    public function getReadyTimestamp() {
        return $this->getReleaseTimestamp() ?: $this->getQueuedTimestamp();
    }

    public function ignoreDuplicates() {
        return $this->removeDuplicates;
    }

    public function allowRetries() {
        return true;
    }

    public function workItemCount() {
        return 1;
    }

    public function getDeduplicationInfo() {
        $info = [
            'type' => $this->getType(),
            'namespace' => $this->getTitle()->getNamespace(),
            'title' => $this->getTitle()->getDBkey(),
            '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;
    }

    public static function newRootJobParams( $key ) {
        return [
            'rootJobIsSelf'    => true,
            'rootJobSignature' => sha1( $key ),
            'rootJobTimestamp' => wfTimestampNow()
        ];
    }

    public function getRootJobParams() {
        return [
            'rootJobSignature' => isset( $this->params['rootJobSignature'] )
                ? $this->params['rootJobSignature']
                : null,
            'rootJobTimestamp' => isset( $this->params['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'] );
    }

    protected function addTeardownCallback( $callback ) {
        $this->teardownCallbacks[] = $callback;
    }

    public function teardown( $status ) {
        foreach ( $this->teardownCallbacks as $callback ) {
            call_user_func( $callback, $status );
        }
    }

    public function insert() {
        JobQueueGroup::singleton()->push( $this );
        return true;
    }

    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] = gettype( $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 = "object(" . get_class( $value ) . ")";
                }

                $flatValue = (string)$value;
                if ( mb_strlen( $value ) > 1024 ) {
                    $flatValue = "string(" . mb_strlen( $value ) . ")";
                }

                $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;
    }

    public function getLastError() {
        return $this->error;
    }
}