Job.php

Go to the documentation of this file.

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

    public $params;

    public $metadata = array();

    protected $title;

    protected $removeDuplicates;

    protected $error;

    /*-------------------------------------------------------------------------
     * Abstract functions
     *------------------------------------------------------------------------*/

    abstract public function run();

    /*-------------------------------------------------------------------------
     * Static functions
     *------------------------------------------------------------------------*/

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

            return new $class( $title, $params );
        }
        throw new MWException( "Invalid job command `{$command}`" );
    }

    public static function batchInsert( $jobs ) {
        JobQueueGroup::singleton()->push( $jobs );
        return true;
    }

    public static function safeBatchInsert( $jobs ) {
        JobQueueGroup::singleton()->push( $jobs, JobQueue::QOS_ATOMIC );
        return true;
    }

    public static function pop_type( $type ) {
        return JobQueueGroup::singleton()->get( $type )->pop();
    }

    public static function pop() {
        return JobQueueGroup::singleton()->pop();
    }

    /*-------------------------------------------------------------------------
     * Non-static functions
     *------------------------------------------------------------------------*/

    public function __construct( $command, $title, $params = false ) {
        $this->command = $command;
        $this->title = $title;
        $this->params = $params;

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

    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 ignoreDuplicates() {
        return $this->removeDuplicates;
    }

    public function allowRetries() {
        return true;
    }

    public function workItemCount() {
        return 1;
    }

    public function getDeduplicationInfo() {
        $info = array(
            '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'] );
        }

        return $info;
    }

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

    public function getRootJobParams() {
        return array(
            '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 insert() {
        JobQueueGroup::singleton()->push( $this );
        return true;
    }

    public function toString() {
        $truncFunc = function ( $value ) {
            $value = (string)$value;
            if ( mb_strlen( $value ) > 1024 ) {
                $value = "string(" . mb_strlen( $value ) . ")";
            }
            return $value;
        };

        $paramString = '';
        if ( $this->params ) {
            foreach ( $this->params as $key => $value ) {
                if ( $paramString != '' ) {
                    $paramString .= ' ';
                }
                if ( is_array( $value ) ) {
                    $filteredValue = array();
                    foreach ( $value as $k => $v ) {
                        if ( is_scalar( $v ) ) {
                            $filteredValue[$k] = $truncFunc( $v );
                        } else {
                            $filteredValue = null;
                            break;
                        }
                    }
                    if ( $filteredValue ) {
                        $value = FormatJson::encode( $filteredValue );
                    } else {
                        $value = "array(" . count( $value ) . ")";
                    }
                } elseif ( is_object( $value ) && !method_exists( $value, '__toString' ) ) {
                    $value = "object(" . get_class( $value ) . ")";
                }

                $paramString .= "$key={$truncFunc( $value )}";
            }
        }

        if ( is_object( $this->title ) ) {
            $s = "{$this->command} " . $this->title->getPrefixedDBkey();
            if ( $paramString !== '' ) {
                $s .= ' ' . $paramString;
            }

            return $s;
        } else {
            return "{$this->command} $paramString";
        }
    }

    protected function setLastError( $error ) {
        $this->error = $error;
    }

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