<?php
/**
- * Based on runJobs.php
- *
* Report number of jobs currently waiting in master database.
*
+ * Based on runJobs.php
+ *
* 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
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
+ * @file
* @ingroup Maintenance
* @author Tim Starling
- * @author Ashar Voultoiz
+ * @author Antoine Musso
*/
-require_once( dirname( __FILE__ ) . '/Maintenance.php' );
+require_once __DIR__ . '/Maintenance.php';
+/**
+ * Maintenance script that reports the number of jobs currently waiting
+ * in master database.
+ *
+ * @ingroup Maintenance
+ */
class ShowJobs extends Maintenance {
+ protected static $stateMethods = [
+ 'unclaimed' => 'getAllQueuedJobs',
+ 'delayed' => 'getAllDelayedJobs',
+ 'claimed' => 'getAllAcquiredJobs',
+ 'abandoned' => 'getAllAbandonedJobs',
+ ];
+
public function __construct() {
parent::__construct();
- $this->mDescription = "Show number of jobs waiting in master database";
+ $this->addDescription( 'Show number of jobs waiting in master database' );
$this->addOption( 'group', 'Show number of jobs per job type' );
+ $this->addOption( 'list', 'Show a list of all jobs instead of counts' );
+ $this->addOption( 'type', 'Only show/count jobs of a given type', false, true );
+ $this->addOption( 'status', 'Filter list by state (unclaimed,delayed,claimed,abandoned)' );
+ $this->addOption( 'limit', 'Limit of jobs listed' );
}
+
public function execute() {
- $dbw = wfGetDB( DB_MASTER );
- if ( $this->hasOption( 'group' ) ) {
- $res = $dbw->select(
- 'job',
- array( 'job_cmd', 'count(*) as count' ),
- array(),
- __METHOD__,
- array( 'GROUP BY' => 'job_cmd' )
- );
- foreach ( $res as $row ) {
- $this->output( $row->job_cmd . ': ' . $row->count . "\n" );
+ $typeFilter = $this->getOption( 'type', '' );
+ $stateFilter = $this->getOption( 'status', '' );
+ $stateLimit = (float)$this->getOption( 'limit', INF );
+
+ $group = JobQueueGroup::singleton();
+
+ $filteredTypes = $typeFilter
+ ? [ $typeFilter ]
+ : $group->getQueueTypes();
+ $filteredStates = $stateFilter
+ ? array_intersect_key( self::$stateMethods, [ $stateFilter => 1 ] )
+ : self::$stateMethods;
+
+ if ( $this->hasOption( 'list' ) ) {
+ $count = 0;
+ foreach ( $filteredTypes as $type ) {
+ $queue = $group->get( $type );
+ foreach ( $filteredStates as $state => $method ) {
+ foreach ( $queue->$method() as $job ) {
+ /** @var Job $job */
+ $this->output( $job->toString() . " status=$state\n" );
+ if ( ++$count >= $stateLimit ) {
+ return;
+ }
+ }
+ }
+ }
+ } elseif ( $this->hasOption( 'group' ) ) {
+ foreach ( $filteredTypes as $type ) {
+ $queue = $group->get( $type );
+ $delayed = $queue->getDelayedCount();
+ $pending = $queue->getSize();
+ $claimed = $queue->getAcquiredCount();
+ $abandoned = $queue->getAbandonedCount();
+ $active = max( 0, $claimed - $abandoned );
+ if ( ( $pending + $claimed + $delayed + $abandoned ) > 0 ) {
+ $this->output(
+ "{$type}: $pending queued; " .
+ "$claimed claimed ($active active, $abandoned abandoned); " .
+ "$delayed delayed\n"
+ );
+ }
}
} else {
- $this->output( $dbw->selectField( 'job', 'count(*)', '', __METHOD__ ) . "\n" );
+ $count = 0;
+ foreach ( $filteredTypes as $type ) {
+ $count += $group->get( $type )->getSize();
+ }
+ $this->output( "$count\n" );
}
}
}
$maintClass = "ShowJobs";
-require_once( RUN_MAINTENANCE_IF_MAIN );
+require_once RUN_MAINTENANCE_IF_MAIN;