JobQueueAggregator.php

Go to the documentation of this file.

<?php
abstract class JobQueueAggregator {
    protected static $instance = null;

    public function __construct( array $params ) {
    }

    final public static function singleton() {
        global $wgJobQueueAggregator;

        if ( !isset( self::$instance ) ) {
            $class = $wgJobQueueAggregator['class'];
            $obj = new $class( $wgJobQueueAggregator );
            if ( !( $obj instanceof JobQueueAggregator ) ) {
                throw new MWException( "Class '$class' is not a JobQueueAggregator class." );
            }
            self::$instance = $obj;
        }

        return self::$instance;
    }

    final public static function destroySingleton() {
        self::$instance = null;
    }

    final public function notifyQueueEmpty( $wiki, $type ) {
        $ok = $this->doNotifyQueueEmpty( $wiki, $type );

        return $ok;
    }

    abstract protected function doNotifyQueueEmpty( $wiki, $type );

    final public function notifyQueueNonEmpty( $wiki, $type ) {
        $ok = $this->doNotifyQueueNonEmpty( $wiki, $type );

        return $ok;
    }

    abstract protected function doNotifyQueueNonEmpty( $wiki, $type );

    final public function getAllReadyWikiQueues() {
        $res = $this->doGetAllReadyWikiQueues();

        return $res;
    }

    abstract protected function doGetAllReadyWikiQueues();

    final public function purge() {
        $res = $this->doPurge();

        return $res;
    }

    abstract protected function doPurge();

    protected function findPendingWikiQueues() {
        global $wgLocalDatabases;

        $pendingDBs = []; // (job type => (db list))
        foreach ( $wgLocalDatabases as $db ) {
            foreach ( JobQueueGroup::singleton( $db )->getQueuesWithJobs() as $type ) {
                $pendingDBs[$type][] = $db;
            }
        }

        return $pendingDBs;
    }
}

class JobQueueAggregatorNull extends JobQueueAggregator {
    protected function doNotifyQueueEmpty( $wiki, $type ) {
        return true;
    }

    protected function doNotifyQueueNonEmpty( $wiki, $type ) {
        return true;
    }

    protected function doGetAllReadyWikiQueues() {
        return [];
    }

    protected function doPurge() {
        return true;
    }
}