MediaWiki  master
SpecialRunJobs.php
Go to the documentation of this file.
1 <?php
25 
32  public function __construct() {
33  parent::__construct( 'RunJobs' );
34  }
35 
36  public function doesWrites() {
37  return true;
38  }
39 
40  public function execute( $par = '' ) {
41  $this->getOutput()->disable();
42 
43  if ( wfReadOnly() ) {
44  wfHttpError( 423, 'Locked', 'Wiki is in read-only mode.' );
45  return;
46  }
47 
48  // Validate request method
49  if ( !$this->getRequest()->wasPosted() ) {
50  wfHttpError( 400, 'Bad Request', 'Request must be POSTed.' );
51  return;
52  }
53 
54  // Validate request parameters
55  $optional = [ 'maxjobs' => 0, 'maxtime' => 30, 'type' => false, 'async' => true ];
56  $required = array_flip( [ 'title', 'tasks', 'signature', 'sigexpiry' ] );
57  $params = array_intersect_key( $this->getRequest()->getValues(), $required + $optional );
58  $missing = array_diff_key( $required, $params );
59  if ( count( $missing ) ) {
60  wfHttpError( 400, 'Bad Request',
61  'Missing parameters: ' . implode( ', ', array_keys( $missing ) )
62  );
63  return;
64  }
65 
66  // Validate request signature
67  $squery = $params;
68  unset( $squery['signature'] );
69  $correctSignature = self::getQuerySignature( $squery, $this->getConfig()->get( 'SecretKey' ) );
70  $providedSignature = $params['signature'];
71  $verified = is_string( $providedSignature )
72  && hash_equals( $correctSignature, $providedSignature );
73  if ( !$verified || $params['sigexpiry'] < time() ) {
74  wfHttpError( 400, 'Bad Request', 'Invalid or stale signature provided.' );
75  return;
76  }
77 
78  // Apply any default parameter values
79  $params += $optional;
80 
81  if ( $params['async'] ) {
82  // HTTP 202 Accepted
83  HttpStatus::header( 202 );
84  // Clients are meant to disconnect without waiting for the full response.
85  // Let the page output happen before the jobs start, so that clients know it's
86  // safe to disconnect. MediaWiki::preOutputCommit() calls ignore_user_abort()
87  // or similar to make sure we stay alive to run the deferred update.
90  function () use ( $params ) {
91  $this->doRun( $params );
92  },
93  __METHOD__
94  ),
96  );
97  } else {
98  $this->doRun( $params );
99  print "Done\n";
100  }
101  }
102 
103  protected function doRun( array $params ) {
104  $runner = new JobRunner( LoggerFactory::getInstance( 'runJobs' ) );
105  $runner->run( [
106  'type' => $params['type'],
107  'maxJobs' => $params['maxjobs'] ?: 1,
108  'maxTime' => $params['maxtime'] ?: 30
109  ] );
110  }
111 
117  public static function getQuerySignature( array $query, $secretKey ) {
118  ksort( $query ); // stable order
119  return hash_hmac( 'sha1', wfArrayToCgi( $query ), $secretKey );
120  }
121 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
null for the local 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:1637
Shortcut to construct a special page which is unlisted by default.
doRun(array $params)
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getOutput()
Get the OutputPage being used for this instance.
Special page designed for running background tasks (internal use only)
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
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:2046
wfReadOnly()
Check whether the wiki is in read-only mode.
Deferrable update that must run outside of any explicit LBFactory transaction round.
static header( $code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
$params
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
static addUpdate(DeferrableUpdate $update, $stage=self::POSTSEND)
Add an update to the deferred list to be run later by execute()
Job queue runner utility methods.
Definition: JobRunner.php:39
getConfig()
Shortcut to get main config object.
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
static getQuerySignature(array $query, $secretKey)
getRequest()
Get the WebRequest being used for this instance.
execute( $par='')