JobQueueAggregator.php

Go to the documentation of this file.

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

        protected 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 ) {
                wfProfileIn( __METHOD__ );
                $ok = $this->doNotifyQueueEmpty( $wiki, $type );
                wfProfileOut( __METHOD__ );
                return $ok;
        }

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

        final public function notifyQueueNonEmpty( $wiki, $type ) {
                wfProfileIn( __METHOD__ );
                $ok = $this->doNotifyQueueNonEmpty( $wiki, $type );
                wfProfileOut( __METHOD__ );
                return $ok;
        }

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

        final public function getAllReadyWikiQueues() {
                wfProfileIn( __METHOD__ );
                $res = $this->doGetAllReadyWikiQueues();
                wfProfileOut( __METHOD__ );
                return $res;
        }

        abstract protected function doGetAllReadyWikiQueues();

        protected function findPendingWikiQueues() {
                global $wgLocalDatabases;

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

                return $pendingDBs;
        }
}