Fix XmlTypeCheck docs
[mediawiki.git] / maintenance / runJobs.php
blob6a6f9d2723d9971142e1dcf3920c175ffac2dd25
1 <?php
2 /**
3 * Run pending jobs.
5 * Options:
6 * --maxjobs <num> (default 10000)
7 * --type <job_cmd>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
24 * @file
25 * @ingroup Maintenance
28 require_once __DIR__ . '/Maintenance.php';
30 /**
31 * Maintenance script that runs pending jobs.
33 * @ingroup Maintenance
35 class RunJobs extends Maintenance {
36 public function __construct() {
37 parent::__construct();
38 $this->mDescription = "Run pending jobs";
39 $this->addOption( 'maxjobs', 'Maximum number of jobs to run', false, true );
40 $this->addOption( 'maxtime', 'Maximum amount of wall-clock time', false, true );
41 $this->addOption( 'type', 'Type of job to run', false, true );
42 $this->addOption( 'procs', 'Number of processes to use', false, true );
45 public function memoryLimit() {
46 if ( $this->hasOption( 'memory-limit' ) ) {
47 return parent::memoryLimit();
49 // Don't eat all memory on the machine if we get a bad job.
50 return "150M";
53 public function execute() {
54 global $wgTitle;
56 if ( wfReadOnly() ) {
57 $this->error( "Unable to run jobs; the wiki is in read-only mode.", 1 ); // die
60 if ( $this->hasOption( 'procs' ) ) {
61 $procs = intval( $this->getOption( 'procs' ) );
62 if ( $procs < 1 || $procs > 1000 ) {
63 $this->error( "Invalid argument to --procs", true );
64 } elseif ( $procs != 1 ) {
65 $fc = new ForkController( $procs );
66 if ( $fc->start() != 'child' ) {
67 exit( 0 );
71 $maxJobs = $this->getOption( 'maxjobs', false );
72 $maxTime = $this->getOption( 'maxtime', false );
73 $startTime = time();
74 $type = $this->getOption( 'type', false );
75 $wgTitle = Title::newFromText( 'RunJobs.php' );
76 $dbw = wfGetDB( DB_MASTER );
77 $jobsRun = 0; // counter
79 $group = JobQueueGroup::singleton();
80 // Handle any required periodic queue maintenance
81 $count = $group->executeReadyPeriodicTasks();
82 if ( $count > 0 ) {
83 $this->runJobsLog( "Executed $count periodic queue task(s)." );
86 $flags = JobQueueGroup::USE_CACHE | JobQueueGroup::USE_PRIORITY;
87 $lastTime = time(); // time since last slave check
88 do {
89 $job = ( $type === false )
90 ? $group->pop( JobQueueGroup::TYPE_DEFAULT, $flags )
91 : $group->pop( $type ); // job from a single queue
92 if ( $job ) { // found a job
93 ++$jobsRun;
94 $this->runJobsLog( $job->toString() . " STARTING" );
96 // Run the job...
97 $t = microtime( true );
98 wfProfileIn( __METHOD__ . '-' . get_class( $job ) );
99 try {
100 $status = $job->run();
101 $error = $job->getLastError();
102 } catch ( MWException $e ) {
103 $status = false;
104 $error = get_class( $e ) . ': ' . $e->getMessage();
105 wfDebugLog( 'exception', $e->getLogMessage() );
107 wfProfileOut( __METHOD__ . '-' . get_class( $job ) );
108 $timeMs = intval( ( microtime( true ) - $t ) * 1000 );
110 // Mark the job as done on success or when the job cannot be retried
111 if ( $status !== false || !$job->allowRetries() ) {
112 $group->ack( $job ); // done
115 if ( $status === false ) {
116 $this->runJobsLog( $job->toString() . " t=$timeMs error={$error}" );
117 } else {
118 $this->runJobsLog( $job->toString() . " t=$timeMs good" );
121 // Break out if we hit the job count or wall time limits...
122 if ( $maxJobs && $jobsRun >= $maxJobs ) {
123 break;
124 } elseif ( $maxTime && ( time() - $startTime ) > $maxTime ) {
125 break;
128 // Don't let any of the main DB slaves get backed up
129 $timePassed = time() - $lastTime;
130 if ( $timePassed >= 5 || $timePassed < 0 ) {
131 wfWaitForSlaves();
132 $lastTime = time();
134 // Don't let any queue slaves/backups fall behind
135 if ( $jobsRun > 0 && ( $jobsRun % 100 ) == 0 ) {
136 $group->waitForBackups();
139 } while ( $job ); // stop when there are no jobs
143 * Log the job message
144 * @param $msg String The message to log
146 private function runJobsLog( $msg ) {
147 $this->output( wfTimestamp( TS_DB ) . " $msg\n" );
148 wfDebugLog( 'runJobs', $msg );
152 $maintClass = "RunJobs";
153 require_once RUN_MAINTENANCE_IF_MAIN;