MediaWiki REL1_30
showJobs.php
Go to the documentation of this file.
1<?php
28require_once __DIR__ . '/Maintenance.php';
29
36class ShowJobs extends Maintenance {
37 protected static $stateMethods = [
38 'unclaimed' => 'getAllQueuedJobs',
39 'delayed' => 'getAllDelayedJobs',
40 'claimed' => 'getAllAcquiredJobs',
41 'abandoned' => 'getAllAbandonedJobs',
42 ];
43
44 public function __construct() {
45 parent::__construct();
46 $this->addDescription( 'Show number of jobs waiting in master database' );
47 $this->addOption( 'group', 'Show number of jobs per job type' );
48 $this->addOption( 'list', 'Show a list of all jobs instead of counts' );
49 $this->addOption( 'type', 'Only show/count jobs of a given type', false, true );
50 $this->addOption( 'status', 'Filter list by state (unclaimed,delayed,claimed,abandoned)' );
51 $this->addOption( 'limit', 'Limit of jobs listed' );
52 }
53
54 public function execute() {
55 $typeFilter = $this->getOption( 'type', '' );
56 $stateFilter = $this->getOption( 'status', '' );
57 $stateLimit = (float)$this->getOption( 'limit', INF );
58
59 $group = JobQueueGroup::singleton();
60
61 $filteredTypes = $typeFilter
62 ? [ $typeFilter ]
63 : $group->getQueueTypes();
64 $filteredStates = $stateFilter
65 ? array_intersect_key( self::$stateMethods, [ $stateFilter => 1 ] )
67
68 if ( $this->hasOption( 'list' ) ) {
69 $count = 0;
70 foreach ( $filteredTypes as $type ) {
71 $queue = $group->get( $type );
72 foreach ( $filteredStates as $state => $method ) {
73 foreach ( $queue->$method() as $job ) {
75 $this->output( $job->toString() . " status=$state\n" );
76 if ( ++$count >= $stateLimit ) {
77 return;
78 }
79 }
80 }
81 }
82 } elseif ( $this->hasOption( 'group' ) ) {
83 foreach ( $filteredTypes as $type ) {
84 $queue = $group->get( $type );
85 $delayed = $queue->getDelayedCount();
86 $pending = $queue->getSize();
87 $claimed = $queue->getAcquiredCount();
88 $abandoned = $queue->getAbandonedCount();
89 $active = max( 0, $claimed - $abandoned );
90 if ( ( $pending + $claimed + $delayed + $abandoned ) > 0 ) {
91 $this->output(
92 "{$type}: $pending queued; " .
93 "$claimed claimed ($active active, $abandoned abandoned); " .
94 "$delayed delayed\n"
95 );
96 }
97 }
98 } else {
99 $count = 0;
100 foreach ( $filteredTypes as $type ) {
101 $count += $group->get( $type )->getSize();
102 }
103 $this->output( "$count\n" );
104 }
105 }
106}
107
108$maintClass = "ShowJobs";
109require_once RUN_MAINTENANCE_IF_MAIN;
static singleton( $wiki=false)
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
hasOption( $name)
Checks to see if a particular param exists.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
Maintenance script that reports the number of jobs currently waiting in master database.
Definition showJobs.php:36
execute()
Do the actual work.
Definition showJobs.php:54
__construct()
Default constructor.
Definition showJobs.php:44
static $stateMethods
Definition showJobs.php:37
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
require_once RUN_MAINTENANCE_IF_MAIN
if(count( $args)< 1) $job
$maintClass
Definition showJobs.php:108