Don't use deprecated User::checkPassword() in TestUser
[mediawiki.git] / maintenance / runJobs.php
blobc3c239154563fc4946b77967c1dacefcde7fab52
1 <?php
2 /**
3 * Run pending jobs.
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.
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.
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
20 * @file
21 * @ingroup Maintenance
24 require_once __DIR__ . '/Maintenance.php';
26 use MediaWiki\Logger\LoggerFactory;
28 /**
29 * Maintenance script that runs pending jobs.
31 * @ingroup Maintenance
33 class RunJobs extends Maintenance {
34 public function __construct() {
35 parent::__construct();
36 $this->addDescription( 'Run pending jobs' );
37 $this->addOption( 'maxjobs', 'Maximum number of jobs to run', false, true );
38 $this->addOption( 'maxtime', 'Maximum amount of wall-clock time', false, true );
39 $this->addOption( 'type', 'Type of job to run', false, true );
40 $this->addOption( 'procs', 'Number of processes to use', false, true );
41 $this->addOption( 'nothrottle', 'Ignore job throttling configuration', false, false );
42 $this->addOption( 'result', 'Set to JSON to print only a JSON response', false, true );
43 $this->addOption( 'wait', 'Wait for new jobs instead of exiting', false, false );
46 public function memoryLimit() {
47 if ( $this->hasOption( 'memory-limit' ) ) {
48 return parent::memoryLimit();
51 // Don't eat all memory on the machine if we get a bad job.
52 return "150M";
55 public function execute() {
56 global $wgCommandLineMode;
58 if ( $this->hasOption( 'procs' ) ) {
59 $procs = intval( $this->getOption( 'procs' ) );
60 if ( $procs < 1 || $procs > 1000 ) {
61 $this->error( "Invalid argument to --procs", true );
62 } elseif ( $procs != 1 ) {
63 $fc = new ForkController( $procs );
64 if ( $fc->start() != 'child' ) {
65 exit( 0 );
70 $outputJSON = ( $this->getOption( 'result' ) === 'json' );
71 $wait = $this->hasOption( 'wait' );
73 // Enable DBO_TRX for atomicity; JobRunner manages transactions
74 // and works well in web server mode already (@TODO: this is a hack)
75 $wgCommandLineMode = false;
77 $runner = new JobRunner( LoggerFactory::getInstance( 'runJobs' ) );
78 if ( !$outputJSON ) {
79 $runner->setDebugHandler( [ $this, 'debugInternal' ] );
82 $type = $this->getOption( 'type', false );
83 $maxJobs = $this->getOption( 'maxjobs', false );
84 $maxTime = $this->getOption( 'maxtime', false );
85 $throttle = !$this->hasOption( 'nothrottle' );
87 while ( true ) {
88 $response = $runner->run( [
89 'type' => $type,
90 'maxJobs' => $maxJobs,
91 'maxTime' => $maxTime,
92 'throttle' => $throttle,
93 ] );
95 if ( $outputJSON ) {
96 $this->output( FormatJson::encode( $response, true ) );
99 if (
100 !$wait ||
101 $response['reached'] === 'time-limit' ||
102 $response['reached'] === 'job-limit' ||
103 $response['reached'] === 'memory-limit'
105 break;
108 if ( $maxJobs !== false ) {
109 $maxJobs -= count( $response['jobs'] );
112 sleep( 1 );
115 $wgCommandLineMode = true;
119 * @param string $s
121 public function debugInternal( $s ) {
122 $this->output( $s );
126 $maintClass = "RunJobs";
127 require_once RUN_MAINTENANCE_IF_MAIN;