3 * Implements Special:RunJobs
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
21 * @ingroup SpecialPage
22 * @author Aaron Schulz
26 * Special page designed for running background tasks (internal use only)
28 * @ingroup SpecialPage
30 class SpecialRunJobs
extends UnlistedSpecialPage
{
31 public function __construct() {
32 parent
::__construct( 'RunJobs' );
35 public function execute( $par = '' ) {
36 $this->getOutput()->disable();
39 header( "HTTP/1.0 423 Locked" );
40 print 'Wiki is in read-only mode';
42 } elseif ( !$this->getRequest()->wasPosted() ) {
43 header( "HTTP/1.0 400 Bad Request" );
44 print 'Request must be POSTed';
48 $optional = array( 'maxjobs' => 0 );
49 $required = array_flip( array( 'title', 'tasks', 'signature', 'sigexpiry' ) );
51 $params = array_intersect_key( $this->getRequest()->getValues(), $required +
$optional );
52 $missing = array_diff_key( $required, $params );
53 if ( count( $missing ) ) {
54 header( "HTTP/1.0 400 Bad Request" );
55 print 'Missing parameters: ' . implode( ', ', array_keys( $missing ) );
60 unset( $squery['signature'] );
61 $cSig = self
::getQuerySignature( $squery ); // correct signature
62 $rSig = $params['signature']; // provided signature
64 // Constant-time signature verification
65 // http://www.emerose.com/timing-attacks-explained
66 // @todo: make a common method for this
67 if ( !is_string( $rSig ) ||
strlen( $rSig ) !== strlen( $cSig ) ) {
71 for ( $i = 0; $i < strlen( $cSig ); $i++
) {
72 $result |
= ord( $cSig[$i] ) ^
ord( $rSig[$i] );
74 $verified = ( $result == 0 );
76 if ( !$verified ||
$params['sigexpiry'] < time() ) {
77 header( "HTTP/1.0 400 Bad Request" );
78 print 'Invalid or stale signature provided';
82 // Apply any default parameter values
85 // Client will usually disconnect before checking the response,
86 // but it needs to know when it is safe to disconnect. Until this
87 // reaches ignore_user_abort(), it is not safe as the jobs won't run.
88 ignore_user_abort( true ); // jobs may take a bit of time
89 header( "HTTP/1.0 202 Accepted" );
92 // Once the client receives this response, it can disconnect
94 // Do all of the specified tasks...
95 if ( in_array( 'jobs', explode( '|', $params['tasks'] ) ) ) {
96 self
::executeJobs( (int)$params['maxjobs'] );
101 * @param array $query
104 public static function getQuerySignature( array $query ) {
107 ksort( $query ); // stable order
108 return hash_hmac( 'sha1', wfArrayToCgi( $query ), $wgSecretKey );
112 * Run jobs from the job queue
114 * @note: also called from Wiki.php
116 * @param integer $maxJobs Maximum number of jobs to run
119 public static function executeJobs( $maxJobs ) {
120 $n = $maxJobs; // number of jobs to run
125 $group = JobQueueGroup
::singleton();
126 $count = $group->executeReadyPeriodicTasks();
128 wfDebugLog( 'jobqueue', "Executed $count periodic queue task(s)." );
132 $job = $group->pop( JobQueueGroup
::TYPE_DEFAULT
, JobQueueGroup
::USE_CACHE
);
134 $output = $job->toString() . "\n";
135 $t = - microtime( true );
136 wfProfileIn( __METHOD__
. '-' . get_class( $job ) );
137 $success = $job->run();
138 wfProfileOut( __METHOD__
. '-' . get_class( $job ) );
139 $group->ack( $job ); // done
140 $t +
= microtime( true );
141 $t = round( $t * 1000 );
142 if ( $success === false ) {
143 $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
145 $output .= "Success, Time: $t ms\n";
147 wfDebugLog( 'jobqueue', $output );
149 } while ( --$n && $job );
150 } catch ( MWException
$e ) {
151 // We don't want exceptions thrown during job execution to
152 // be reported to the user since the output is already sent.
153 // Instead we just log them.
154 MWExceptionHandler
::logException( $e );