Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
66.67% covered (warning)
66.67%
36 / 54
20.00% covered (danger)
20.00%
1 / 5
CRAP
0.00% covered (danger)
0.00%
0 / 1
RunJobs
66.67% covered (warning)
66.67%
36 / 54
20.00% covered (danger)
20.00%
1 / 5
42.59
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
9 / 9
100.00% covered (success)
100.00%
1 / 1
1
 finalSetup
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 memoryLimit
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 execute
69.23% covered (warning)
69.23%
27 / 39
0.00% covered (danger)
0.00%
0 / 1
27.44
 debugInternal
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2/**
3 * Run pending jobs.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Maintenance
22 */
23
24// @codeCoverageIgnoreStart
25require_once __DIR__ . '/Maintenance.php';
26// @codeCoverageIgnoreEnd
27
28use MediaWiki\Json\FormatJson;
29use MediaWiki\Maintenance\ForkController;
30use MediaWiki\Maintenance\Maintenance;
31use MediaWiki\Settings\SettingsBuilder;
32
33/**
34 * Maintenance script that runs pending jobs.
35 *
36 * @ingroup Maintenance
37 */
38class RunJobs extends Maintenance {
39    public function __construct() {
40        parent::__construct();
41        $this->addDescription( 'Run pending jobs' );
42        $this->addOption( 'maxjobs', 'Maximum number of jobs to run', false, true );
43        $this->addOption( 'maxtime', 'Maximum amount of wall-clock time', false, true );
44        $this->addOption( 'type', 'Type of job to run', false, true );
45        $this->addOption( 'procs', 'Number of processes to use', false, true );
46        $this->addOption( 'nothrottle', 'Ignore job throttling configuration', false, false );
47        $this->addOption( 'result', 'Set to "json" to print only a JSON response', false, true );
48        $this->addOption( 'wait', 'Wait for new jobs instead of exiting', false, false );
49    }
50
51    public function finalSetup( SettingsBuilder $settingsBuilder ) {
52        // So extensions (and other code) can check whether they're running in job mode.
53        // This is not defined if this script is included from installer/updater or phpunit.
54        define( 'MEDIAWIKI_JOB_RUNNER', true );
55        parent::finalSetup( $settingsBuilder );
56    }
57
58    public function memoryLimit() {
59        if ( $this->hasOption( 'memory-limit' ) ) {
60            return parent::memoryLimit();
61        }
62
63        // Don't eat all memory on the machine if we get a bad job.
64        return "150M";
65    }
66
67    public function execute() {
68        if ( $this->hasOption( 'procs' ) ) {
69            $procs = intval( $this->getOption( 'procs' ) );
70            if ( $procs < 1 || $procs > 1000 ) {
71                $this->fatalError( "Invalid argument to --procs" );
72            } elseif ( $procs != 1 ) {
73                try {
74                    $fc = new ForkController( $procs );
75                } catch ( Throwable $e ) {
76                    $this->fatalError( $e->getMessage() );
77                }
78                if ( $fc->start() != 'child' ) {
79                    return;
80                }
81            }
82        }
83
84        $outputJSON = ( $this->getOption( 'result' ) === 'json' );
85        $wait = $this->hasOption( 'wait' );
86
87        $runner = $this->getServiceContainer()->getJobRunner();
88        if ( !$outputJSON ) {
89            $runner->setDebugHandler( [ $this, 'debugInternal' ] );
90        }
91
92        $type = $this->getOption( 'type', false );
93        $maxJobs = $this->getOption( 'maxjobs', false );
94        $maxTime = $this->getOption( 'maxtime', false );
95        $throttle = !$this->hasOption( 'nothrottle' );
96
97        while ( true ) {
98            $response = $runner->run( [
99                'type'     => $type,
100                'maxJobs'  => $maxJobs,
101                'maxTime'  => $maxTime,
102                'throttle' => $throttle,
103            ] );
104
105            if ( $outputJSON ) {
106                $this->output( FormatJson::encode( $response, true ) );
107            }
108
109            if (
110                !$wait ||
111                $response['reached'] === 'time-limit' ||
112                $response['reached'] === 'job-limit' ||
113                $response['reached'] === 'memory-limit' ||
114                $response['reached'] === 'exception'
115            ) {
116                // If job queue is empty, output it
117                if ( !$outputJSON && $response['jobs'] === [] ) {
118                    $this->output( "Job queue is empty.\n" );
119                }
120                break;
121            }
122
123            if ( $maxJobs !== false ) {
124                $maxJobs -= count( $response['jobs'] );
125            }
126
127            sleep( 1 );
128        }
129    }
130
131    /**
132     * @param string $s
133     */
134    public function debugInternal( $s ) {
135        $this->output( $s );
136    }
137}
138
139// @codeCoverageIgnoreStart
140$maintClass = RunJobs::class;
141require_once RUN_MAINTENANCE_IF_MAIN;
142// @codeCoverageIgnoreEnd