MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
33  public function __construct() {
34  parent::__construct( 'RunJobs' );
35  }
37  public function doesWrites() {
38  return true;
39  }
41  public function execute( $par = '' ) {
42  $this->getOutput()->disable();
43  if ( wfReadOnly() ) {
44  wfHttpError( 423, 'Locked', 'Wiki is in read-only mode.' );
45  return;
46  } elseif ( !$this->getRequest()->wasPosted() ) {
47  wfHttpError( 400, 'Bad Request', 'Request must be POSTed.' );
48  return;
49  }
51  $optional = [ 'maxjobs' => 0, 'maxtime' => 30, 'type' => false, 'async' => true ];
52  $required = array_flip( [ 'title', 'tasks', 'signature', 'sigexpiry' ] );
54  $params = array_intersect_key( $this->getRequest()->getValues(), $required + $optional );
55  $missing = array_diff_key( $required, $params );
56  if ( count( $missing ) ) {
57  wfHttpError( 400, 'Bad Request',
58  'Missing parameters: ' . implode( ', ', array_keys( $missing ) )
59  );
60  return;
61  }
63  $squery = $params;
64  unset( $squery['signature'] );
65  $correctSignature = self::getQuerySignature( $squery, $this->getConfig()->get( 'SecretKey' ) );
66  $providedSignature = $params['signature'];
68  $verified = is_string( $providedSignature )
69  && hash_equals( $correctSignature, $providedSignature );
70  if ( !$verified || $params['sigexpiry'] < time() ) {
71  wfHttpError( 400, 'Bad Request', 'Invalid or stale signature provided.' );
72  return;
73  }
75  // Apply any default parameter values
76  $params += $optional;
78  if ( $params['async'] ) {
79  // Client will usually disconnect before checking the response,
80  // but it needs to know when it is safe to disconnect. Until this
81  // reaches ignore_user_abort(), it is not safe as the jobs won't run.
82  ignore_user_abort( true ); // jobs may take a bit of time
83  // HTTP 202 Accepted
84  HttpStatus::header( 202 );
85  ob_flush();
86  flush();
87  // Once the client receives this response, it can disconnect
88  set_error_handler( function ( $errno, $errstr ) {
89  if ( strpos( $errstr, 'Cannot modify header information' ) !== false ) {
90  return true; // bug T115413
91  }
92  // Delegate unhandled errors to the default MediaWiki handler
93  // so that fatal errors get proper logging (T89169)
94  return call_user_func_array(
95  'MWExceptionHandler::handleError', func_get_args()
96  );
97  } );
98  }
100  // Do all of the specified tasks...
101  if ( in_array( 'jobs', explode( '|', $params['tasks'] ) ) ) {
102  $runner = new JobRunner( LoggerFactory::getInstance( 'runJobs' ) );
103  $response = $runner->run( [
104  'type' => $params['type'],
105  'maxJobs' => $params['maxjobs'] ? $params['maxjobs'] : 1,
106  'maxTime' => $params['maxtime'] ? $params['maxjobs'] : 30
107  ] );
108  if ( !$params['async'] ) {
109  print FormatJson::encode( $response, true );
110  }
111  }
112  }
119  public static function getQuerySignature( array $query, $secretKey ) {
120  ksort( $query ); // stable order
121  return hash_hmac( 'sha1', wfArrayToCgi( $query ), $secretKey );
122  }
123 }
Definition: SpecialRunJobs.php:33
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:675
Shortcut to construct a special page which is unlisted by default.
Definition: UnlistedSpecialPage.php:29
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
Definition: styleTest.css.php:40
static getQuerySignature(array $query, $secretKey)
Definition: SpecialRunJobs.php:119
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1277
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1572
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
Shortcut to get main config object.
Definition: SpecialPage.php:714
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:665
this hook is for auditing only $response
Definition: hooks.txt:783
Indicates whether this special page may perform database writes.
Definition: SpecialRunJobs.php:37
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
Definition: GlobalFunctions.php:1765
static header( $code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1956
Special page designed for running background tasks (internal use only)
Definition: SpecialRunJobs.php:32
execute( $par='')
Default execute method Checks user permissions.
Definition: SpecialRunJobs.php:41
Job queue runner utility methods.
Definition: JobRunner.php:40
the array() calling protocol came about after MediaWiki 1.4rc1.
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
Definition: GlobalFunctions.php:408