includes/specials/SpecialRunJobs.php

   1 <?php
   2 /**
   3  * Implements Special:RunJobs
   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 SpecialPage
  22  * @author Aaron Schulz
  23  */
  24
  25 use MediaWiki\Logger\LoggerFactory;
  26
  27 /**
  28  * Special page designed for running background tasks (internal use only)
  29  *
  30  * @ingroup SpecialPage
  31  */
  32 class SpecialRunJobs extends UnlistedSpecialPage {
  33         public function __construct() {
  34                 parent::__construct( 'RunJobs' );
  35         }
  36
  37         public function execute( $par = '' ) {
  38                 $this->getOutput()->disable();
  39
  40                 if ( wfReadOnly() ) {
  41                         // HTTP 423 Locked
  42                         HttpStatus::header( 423 );
  43                         print 'Wiki is in read-only mode';
  44
  45                         return;
  46                 } elseif ( !$this->getRequest()->wasPosted() ) {
  47                         HttpStatus::header( 400 );
  48                         print 'Request must be POSTed';
  49                         return;
  50                 }
  51
  52                 $optional = array( 'maxjobs' => 0, 'maxtime' => 30, 'type' => false, 'async' => true );
  53                 $required = array_flip( array( 'title', 'tasks', 'signature', 'sigexpiry' ) );
  54
  55                 $params = array_intersect_key( $this->getRequest()->getValues(), $required + $optional );
  56                 $missing = array_diff_key( $required, $params );
  57                 if ( count( $missing ) ) {
  58                         HttpStatus::header( 400 );
  59                         print 'Missing parameters: ' . implode( ', ', array_keys( $missing ) );
  60                         return;
  61                 }
  62
  63                 $squery = $params;
  64                 unset( $squery['signature'] );
  65                 $correctSignature = self::getQuerySignature( $squery, $this->getConfig()->get( 'SecretKey' ) );
  66                 $providedSignature = $params['signature'];
  67
  68                 $verified = is_string( $providedSignature )
  69                         && hash_equals( $correctSignature, $providedSignature );
  70                 if ( !$verified || $params['sigexpiry'] < time() ) {
  71                         HttpStatus::header( 400 );
  72                         print 'Invalid or stale signature provided';
  73                         return;
  74                 }
  75
  76                 // Apply any default parameter values
  77                 $params += $optional;
  78
  79                 if ( $params['async'] ) {
  80                         // Client will usually disconnect before checking the response,
  81                         // but it needs to know when it is safe to disconnect. Until this
  82                         // reaches ignore_user_abort(), it is not safe as the jobs won't run.
  83                         ignore_user_abort( true ); // jobs may take a bit of time
  84                         // HTTP 202 Accepted
  85                         HttpStatus::header( 202 );
  86                         ob_flush();
  87                         flush();
  88                         // Once the client receives this response, it can disconnect
  89                 }
  90
  91                 // Do all of the specified tasks...
  92                 if ( in_array( 'jobs', explode( '|', $params['tasks'] ) ) ) {
  93                         $runner = new JobRunner( LoggerFactory::getInstance( 'runJobs' ) );
  94                         $response = $runner->run( array(
  95                                 'type'     => $params['type'],
  96                                 'maxJobs'  => $params['maxjobs'] ? $params['maxjobs'] : 1,
  97                                 'maxTime'  => $params['maxtime'] ? $params['maxjobs'] : 30
  98                         ) );
  99                         if ( !$params['async'] ) {
 100                                 print FormatJson::encode( $response, true );
 101                         }
 102                 }
 103         }
 104
 105         /**
 106          * @param array $query
 107          * @param string $secretKey
 108          * @return string
 109          */
 110         public static function getQuerySignature( array $query, $secretKey ) {
 111                 ksort( $query ); // stable order
 112                 return hash_hmac( 'sha1', wfArrayToCgi( $query ), $secretKey );
 113         }
 114 }