Current File : /www/varak.net/wiki.varak.net/includes/jobqueue/aggregator/JobQueueAggregator.php
<?php
/**
* Job queue aggregator code.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* Class to handle tracking information about all queues
*
* @ingroup JobQueue
* @since 1.21
*/
abstract class JobQueueAggregator {
/** @var JobQueueAggregator */
protected static $instance = null;
/**
* @param array $params
*/
public function __construct( array $params ) {
}
/**
* @throws MWException
* @return JobQueueAggregator
*/
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;
}
/**
* Destroy the singleton instance
*
* @return void
*/
final public static function destroySingleton() {
self::$instance = null;
}
/**
* Mark a queue as being empty
*
* @param string $wiki
* @param string $type
* @return bool Success
*/
final public function notifyQueueEmpty( $wiki, $type ) {
$ok = $this->doNotifyQueueEmpty( $wiki, $type );
return $ok;
}
/**
* @see JobQueueAggregator::notifyQueueEmpty()
* @param string $wiki
* @param string $type
* @return bool
*/
abstract protected function doNotifyQueueEmpty( $wiki, $type );
/**
* Mark a queue as being non-empty
*
* @param string $wiki
* @param string $type
* @return bool Success
*/
final public function notifyQueueNonEmpty( $wiki, $type ) {
$ok = $this->doNotifyQueueNonEmpty( $wiki, $type );
return $ok;
}
/**
* @see JobQueueAggregator::notifyQueueNonEmpty()
* @param string $wiki
* @param string $type
* @return bool
*/
abstract protected function doNotifyQueueNonEmpty( $wiki, $type );
/**
* Get the list of all of the queues with jobs
*
* @return array (job type => (list of wiki IDs))
*/
final public function getAllReadyWikiQueues() {
$res = $this->doGetAllReadyWikiQueues();
return $res;
}
/**
* @see JobQueueAggregator::getAllReadyWikiQueues()
*/
abstract protected function doGetAllReadyWikiQueues();
/**
* Purge all of the aggregator information
*
* @return bool Success
*/
final public function purge() {
$res = $this->doPurge();
return $res;
}
/**
* @see JobQueueAggregator::purge()
*/
abstract protected function doPurge();
/**
* Get all databases that have a pending job.
* This poll all the queues and is this expensive.
*
* @return array (job type => (list of wiki IDs))
*/
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;
}
}
/**
* @ingroup JobQueue
*/
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;
}
}
Mini Shell