9c3c0b704b
array_fill_keys() was introduced in PHP 5.2.0 and works like array_flip() except that it does only one thing (copying keys) instead of two things (copying keys and values). That makes it faster and more obvious. When array_flip() calls were paired, I left them as is, because that pattern is too cute. I couldn't kill something so cute. Sometimes it was hard to figure out whether the values in array_flip() result were used. That's the point of this change. If you use array_fill_keys(), the intention is obvious. Change-Id: If8d340a8bc816a15afec37e64f00106ae45e10ed
141 lines
4.1 KiB
PHP
141 lines
4.1 KiB
PHP
<?php
|
|
/**
|
|
* Implements Special:RunJobs
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup SpecialPage
|
|
*/
|
|
|
|
/**
|
|
* Special page designed for running background tasks (internal use only)
|
|
*
|
|
* @ingroup SpecialPage
|
|
*/
|
|
class SpecialRunJobs extends UnlistedSpecialPage {
|
|
|
|
/** @var JobRunner */
|
|
private $jobRunner;
|
|
|
|
/** @var ReadOnlyMode */
|
|
private $readOnlyMode;
|
|
|
|
/**
|
|
* @param JobRunner $jobRunner
|
|
* @param ReadOnlyMode $readOnlyMode
|
|
*/
|
|
public function __construct(
|
|
JobRunner $jobRunner,
|
|
ReadOnlyMode $readOnlyMode
|
|
) {
|
|
parent::__construct( 'RunJobs' );
|
|
$this->jobRunner = $jobRunner;
|
|
$this->readOnlyMode = $readOnlyMode;
|
|
}
|
|
|
|
public function doesWrites() {
|
|
return true;
|
|
}
|
|
|
|
public function execute( $par ) {
|
|
$this->getOutput()->disable();
|
|
|
|
if ( $this->readOnlyMode->isReadOnly() ) {
|
|
wfHttpError( 423, 'Locked', 'Wiki is in read-only mode.' );
|
|
return;
|
|
}
|
|
|
|
// Validate request method
|
|
if ( !$this->getRequest()->wasPosted() ) {
|
|
wfHttpError( 400, 'Bad Request', 'Request must be POSTed.' );
|
|
return;
|
|
}
|
|
|
|
// Validate request parameters
|
|
$optional = [ 'maxjobs' => 0, 'maxtime' => 30, 'type' => false,
|
|
'async' => true, 'stats' => false ];
|
|
$required = array_fill_keys( [ 'title', 'tasks', 'signature', 'sigexpiry' ], true );
|
|
$params = array_intersect_key( $this->getRequest()->getValues(), $required + $optional );
|
|
$missing = array_diff_key( $required, $params );
|
|
if ( count( $missing ) ) {
|
|
wfHttpError( 400, 'Bad Request',
|
|
'Missing parameters: ' . implode( ', ', array_keys( $missing ) )
|
|
);
|
|
return;
|
|
}
|
|
|
|
// Validate request signature
|
|
$squery = $params;
|
|
unset( $squery['signature'] );
|
|
$correctSignature = self::getQuerySignature( $squery, $this->getConfig()->get( 'SecretKey' ) );
|
|
$providedSignature = $params['signature'];
|
|
$verified = is_string( $providedSignature )
|
|
&& hash_equals( $correctSignature, $providedSignature );
|
|
if ( !$verified || $params['sigexpiry'] < time() ) {
|
|
wfHttpError( 400, 'Bad Request', 'Invalid or stale signature provided.' );
|
|
return;
|
|
}
|
|
|
|
// Apply any default parameter values
|
|
$params += $optional;
|
|
|
|
if ( $params['async'] ) {
|
|
// HTTP 202 Accepted
|
|
HttpStatus::header( 202 );
|
|
// Clients are meant to disconnect without waiting for the full response.
|
|
// Let the page output happen before the jobs start, so that clients know it's
|
|
// safe to disconnect. MediaWiki::preOutputCommit() calls ignore_user_abort()
|
|
// or similar to make sure we stay alive to run the deferred update.
|
|
DeferredUpdates::addUpdate(
|
|
new TransactionRoundDefiningUpdate(
|
|
function () use ( $params ) {
|
|
$this->doRun( $params );
|
|
},
|
|
__METHOD__
|
|
),
|
|
DeferredUpdates::POSTSEND
|
|
);
|
|
} else {
|
|
$stats = $this->doRun( $params );
|
|
|
|
if ( $params['stats'] ) {
|
|
$this->getRequest()->response()->header( 'Content-Type: application/json' );
|
|
print FormatJson::encode( $stats );
|
|
} else {
|
|
print "Done\n";
|
|
}
|
|
}
|
|
}
|
|
|
|
protected function doRun( array $params ) {
|
|
return $this->jobRunner->run( [
|
|
'type' => $params['type'],
|
|
'maxJobs' => $params['maxjobs'] ?: 1,
|
|
'maxTime' => $params['maxtime'] ?: 30
|
|
] );
|
|
}
|
|
|
|
/**
|
|
* @param array $query
|
|
* @param string $secretKey
|
|
* @return string
|
|
*/
|
|
public static function getQuerySignature( array $query, $secretKey ) {
|
|
ksort( $query ); // stable order
|
|
return hash_hmac( 'sha1', wfArrayToCgi( $query ), $secretKey );
|
|
}
|
|
}
|