1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
<?php
/**
* 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
*/
namespace MediaWiki\Specials;
use HttpStatus;
use JobRunner;
use MediaWiki\Deferred\DeferredUpdates;
use MediaWiki\Deferred\TransactionRoundDefiningUpdate;
use MediaWiki\Json\FormatJson;
use MediaWiki\MainConfigNames;
use MediaWiki\SpecialPage\UnlistedSpecialPage;
use Wikimedia\Rdbms\ReadOnlyMode;
/**
* Special page designed for running background tasks (internal use only)
*
* @internal
* @ingroup SpecialPage
* @ingroup JobQueue
*/
class SpecialRunJobs extends UnlistedSpecialPage {
private JobRunner $jobRunner;
private 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( MainConfigNames::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 );
}
}
/**
* Retain the old class name for backwards compatibility.
* @deprecated since 1.41
*/
class_alias( SpecialRunJobs::class, 'SpecialRunJobs' );
|
