blob: cb289e8625ca77824e3614f22525a786ed7676e9 (
plain)
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
<?php
namespace SMW\MediaWiki;
use Job as MediaWikiJob;
use JobQueueGroup;
use SMW\ApplicationFactory;
use SMW\Site;
use SMW\Store;
use Title;
/**
* @ingroup SMW
*
* @license GNU GPL v2+
* @since 1.9
*
* @author mwjames
*/
abstract class Job extends MediaWikiJob {
/**
* @var boolean
*/
protected $isEnabledJobQueue = true;
/**
* @var JobQueue
*/
protected $jobQueue;
/**
* @var Job
*/
protected $jobs = [];
/**
* @var Store
*/
protected $store = null;
/**
* @since 2.1
*
* @param Store $store
*/
public function setStore( Store $store ) {
$this->store = $store;
}
/**
* Whether to insert jobs into the JobQueue is enabled or not
*
* @since 1.9
*
* @param boolean|true $enableJobQueue
*
* @return AbstractJob
*/
public function isEnabledJobQueue( $enableJobQueue = true ) {
$this->isEnabledJobQueue = (bool)$enableJobQueue;
return $this;
}
/**
* @note Job::batchInsert was deprecated in MW 1.21
* JobQueueGroup::singleton()->push( $job );
*
* @since 1.9
*/
public function pushToJobQueue() {
$this->isEnabledJobQueue ? self::batchInsert( $this->jobs ) : null;
}
/**
* @note Job::getType was introduced with MW 1.21
*
* @return string
*/
public function getType() {
return $this->command;
}
/**
* @since 2.0
*
* @return integer
*/
public function getJobCount() {
return count( $this->jobs );
}
/**
* @note Job::getTitle() in MW 1.19 does not exist
*
* @since 1.9
*
* @return Title
*/
public function getTitle() {
return $this->title;
}
/**
* @since 1.9
*
* @param mixed $key
*
* @return boolean
*/
public function hasParameter( $key ) {
if ( !is_array( $this->params ) ) {
return false;
}
return isset( $this->params[$key] ) || array_key_exists( $key, $this->params );
}
/**
* @since 1.9
*
* @param mixed $key
*
* @return boolean
*/
public function getParameter( $key, $default = false ) {
return $this->hasParameter( $key ) ? $this->params[$key] : $default;
}
/**
* @since 3.0
*
* @param mixed $key
* @param mixed $value
*/
public function setParameter( $key, $value ) {
$this->params[$key] = $value;
}
/**
* @see https://gerrit.wikimedia.org/r/#/c/162009
*
* @param self[] $jobs
*
* @return boolean
*/
public static function batchInsert( $jobs ) {
return ApplicationFactory::getInstance()->getJobQueue()->push( $jobs );
}
/**
* @see Job::insert
*/
public function insert() {
if ( $this->isEnabledJobQueue ) {
return self::batchInsert( [ $this ] );
}
}
/**
* @see JobQueueGroup::lazyPush
*
* @note Registered jobs are pushed using JobQueueGroup::pushLazyJobs at the
* end of MediaWiki::restInPeace
*
* @since 3.0
*/
public function lazyPush() {
if ( $this->isEnabledJobQueue ) {
return $this->getJobQueue()->lazyPush( $this );
}
}
/**
* @see Translate::TTMServerMessageUpdateJob
* @since 3.0
*
* @param integer $delay
*/
public function setDelay( $delay ) {
$isDelayedJobsEnabled = $this->getJobQueue()->isDelayedJobsEnabled(
$this->getType()
);
if ( !$delay || !$isDelayedJobsEnabled ) {
return;
}
$oldTime = $this->getReleaseTimestamp();
$newTime = time() + $delay;
if ( $oldTime !== null && $oldTime >= $newTime ) {
return;
}
$this->params[ 'jobReleaseTimestamp' ] = $newTime;
}
/**
* @see Job::newRootJobParams
* @since 3.0
*/
public static function newRootJobParams( $key = '', $title = '' ) {
if ( $title instanceof Title ) {
$title = $title->getPrefixedDBkey();
}
return parent::newRootJobParams( "job:{$key}:root:{$title}" );
}
/**
* @see Job::ignoreDuplicates
* @since 3.0
*/
public function ignoreDuplicates() {
if ( isset( $this->params['waitOnCommandLine'] ) ) {
return $this->params['waitOnCommandLine'] > 1;
}
return $this->removeDuplicates;
}
/**
* Only run the job via commandLine or the cronJob and avoid execution via
* Special:RunJobs as it can cause the script to timeout.
*/
public function waitOnCommandLineMode() {
if ( !$this->hasParameter( 'waitOnCommandLine' ) || Site::isCommandLineMode() ) {
return false;
}
if ( $this->hasParameter( 'waitOnCommandLine' ) ) {
$this->params['waitOnCommandLine'] = $this->getParameter( 'waitOnCommandLine' ) + 1;
} else {
$this->params['waitOnCommandLine'] = 1;
}
$job = new static( $this->title, $this->params );
$job->insert();
return true;
}
protected function getJobQueue() {
if ( $this->jobQueue === null ) {
$this->jobQueue = ApplicationFactory::getInstance()->getJobQueue();
}
return $this->jobQueue;
}
}
|
