maintenance/showJobs.php

   1 <?php
   2 /**
   3  * Report number of jobs currently waiting in master database.
   4  *
   5  * Based on runJobs.php
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  * @ingroup Maintenance
  24  * @author Tim Starling
  25  * @author Antoine Musso
  26  */
  27
  28 require_once __DIR__ . '/Maintenance.php';
  29
  30 /**
  31  * Maintenance script that reports the number of jobs currently waiting
  32  * in master database.
  33  *
  34  * @ingroup Maintenance
  35  */
  36 class ShowJobs extends Maintenance {
  37         public function __construct() {
  38                 parent::__construct();
  39                 $this->mDescription = "Show number of jobs waiting in master database";
  40                 $this->addOption( 'group', 'Show number of jobs per job type' );
  41                 $this->addOption( 'list',
  42                         'Show a list of all jobs in a machine-readable format, instead of statistics' );
  43                 $this->addOption( 'type', 'Only show/count jobs of a given type', false, true );
  44         }
  45
  46         public function execute() {
  47                 $filterType = $this->getOption( 'type', '' );
  48                 $group = JobQueueGroup::singleton();
  49                 if ( $this->hasOption( 'list' ) ) {
  50                         foreach ( $group->getQueueTypes() as $type ) {
  51                                 if ( $filterType != '' && $type != $filterType ) {
  52                                         continue;
  53                                 }
  54                                 $queue = $group->get( $type );
  55                                 foreach ( $queue->getAllQueuedJobs() as $job ) {
  56                                         $this->output( $job->toString() . " status=unclaimed\n" );
  57                                 }
  58                                 foreach ( $queue->getAllDelayedJobs() as $job ) {
  59                                         $this->output( $job->toString() . " status=delayed\n" );
  60                                 }
  61                                 foreach ( $queue->getAllAcquiredJobs() as $job ) {
  62                                         $this->output( $job->toString() . " status=claimed\n" );
  63                                 }
  64                                 foreach ( $queue->getAllAbandonedJobs() as $job ) {
  65                                         $this->output( $job->toString() . " status=abandoned\n" );
  66                                 }
  67                         }
  68                 } elseif ( $this->hasOption( 'group' ) ) {
  69                         foreach ( $group->getQueueTypes() as $type ) {
  70                                 if ( $filterType != '' && $type != $filterType ) {
  71                                         continue;
  72                                 }
  73                                 $queue = $group->get( $type );
  74                                 $delayed = $queue->getDelayedCount();
  75                                 $pending = $queue->getSize();
  76                                 $claimed = $queue->getAcquiredCount();
  77                                 $abandoned = $queue->getAbandonedCount();
  78                                 $active = max( 0, $claimed - $abandoned );
  79                                 if ( ( $pending + $claimed + $delayed + $abandoned ) > 0 ) {
  80                                         $this->output(
  81                                                 "{$type}: $pending queued; " .
  82                                                 "$claimed claimed ($active active, $abandoned abandoned); " .
  83                                                 "$delayed delayed\n"
  84                                         );
  85                                 }
  86                         }
  87                 } else {
  88                         $count = 0;
  89                         foreach ( $group->getQueueTypes() as $type ) {
  90                                 if ( $filterType != '' && $type != $filterType ) {
  91                                         continue;
  92                                 }
  93                                 $count += $group->get( $type )->getSize();
  94                         }
  95                         $this->output( "$count\n" );
  96                 }
  97         }
  98 }
  99
 100 $maintClass = "ShowJobs";
 101 require_once RUN_MAINTENANCE_IF_MAIN;