Job.php

Go to the documentation of this file.

<?php
abstract class Job {
        var $title;

        var $command,
                $params,
                $id,
                $removeDuplicates,
                $error;

        public $metadata = array();

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

        abstract public function run();

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

        public static function factory( $command, Title $title, $params = false, $id = 0 ) {
                global $wgJobClasses;
                if( isset( $wgJobClasses[$command] ) ) {
                        $class = $wgJobClasses[$command];
                        return new $class( $title, $params, $id );
                }
                throw new MWException( "Invalid job command `{$command}`" );
        }

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

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

        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, $id = 0 ) {
                $this->command = $command;
                $this->title = $title;
                $this->params = $params;
                $this->id = $id;

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

        public function getId() {
                return $this->id;
        }

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

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

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

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

        public function allowRetries() {
                return true;
        }

        public function getDeduplicationInfo() {
                $info = array(
                        'type'      => $this->getType(),
                        'namespace' => $this->getTitle()->getNamespace(),
                        'title'     => $this->getTitle()->getDBkey(),
                        'params'    => $this->getParams()
                );
                // Identical jobs with different "root" jobs should count as duplicates
                if ( is_array( $info['params'] ) ) {
                        unset( $info['params']['rootJobSignature'] );
                        unset( $info['params']['rootJobTimestamp'] );
                }
                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 insert() {
                return JobQueueGroup::singleton()->push( $this );
        }

        public function toString() {
                $paramString = '';
                if ( $this->params ) {
                        foreach ( $this->params as $key => $value ) {
                                if ( $paramString != '' ) {
                                        $paramString .= ' ';
                                }
                                if ( is_array( $value ) ) {
                                        $value = "array(" . count( $value ) . ")";
                                } elseif ( is_object( $value ) && !method_exists( $value, '__toString' ) ) {
                                        $value = "object(" . get_class( $value ) . ")";
                                }
                                $value = (string)$value;
                                if ( mb_strlen( $value ) > 1024 ) {
                                        $value = "string(" . mb_strlen( $value ) . ")";
                                }

                                $paramString .= "$key=$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;
        }
}