MediaWiki  1.30.0
Job.php
Go to the documentation of this file.
1 <?php
31 abstract class Job implements IJobSpecification {
33  public $command;
34 
36  public $params;
37 
39  public $metadata = [];
40 
42  protected $title;
43 
45  protected $removeDuplicates;
46 
48  protected $error;
49 
51  protected $teardownCallbacks = [];
52 
57  abstract public function run();
58 
68  public static function factory( $command, Title $title, $params = [] ) {
70 
71  if ( isset( $wgJobClasses[$command] ) ) {
73 
74  if ( is_callable( $handler ) ) {
75  $job = call_user_func( $handler, $title, $params );
76  } elseif ( class_exists( $handler ) ) {
77  $job = new $handler( $title, $params );
78  } else {
79  $job = null;
80  }
81 
82  if ( $job instanceof Job ) {
83  $job->command = $command;
84  return $job;
85  } else {
86  throw new InvalidArgumentException( "Cannot instantiate job '$command': bad spec!" );
87  }
88  }
89 
90  throw new InvalidArgumentException( "Invalid job command '{$command}'" );
91  }
92 
98  public function __construct( $command, $title, $params = false ) {
99  $this->command = $command;
100  $this->title = $title;
101  $this->params = is_array( $params ) ? $params : []; // sanity
102 
103  // expensive jobs may set this to true
104  $this->removeDuplicates = false;
105 
106  if ( !isset( $this->params['requestId'] ) ) {
107  $this->params['requestId'] = WebRequest::getRequestId();
108  }
109  }
110 
122  public static function batchInsert( $jobs ) {
123  wfDeprecated( __METHOD__, '1.21' );
124  JobQueueGroup::singleton()->push( $jobs );
125  return true;
126  }
127 
131  public function getType() {
132  return $this->command;
133  }
134 
138  public function getTitle() {
139  return $this->title;
140  }
141 
145  public function getParams() {
146  return $this->params;
147  }
148 
153  public function getReleaseTimestamp() {
154  return isset( $this->params['jobReleaseTimestamp'] )
155  ? wfTimestampOrNull( TS_UNIX, $this->params['jobReleaseTimestamp'] )
156  : null;
157  }
158 
163  public function getQueuedTimestamp() {
164  return isset( $this->metadata['timestamp'] )
165  ? wfTimestampOrNull( TS_UNIX, $this->metadata['timestamp'] )
166  : null;
167  }
168 
175  public function getRequestId() {
176  return isset( $this->params['requestId'] )
177  ? $this->params['requestId']
178  : null;
179  }
180 
185  public function getReadyTimestamp() {
186  return $this->getReleaseTimestamp() ?: $this->getQueuedTimestamp();
187  }
188 
200  public function ignoreDuplicates() {
202  }
203 
208  public function allowRetries() {
209  return true;
210  }
211 
217  public function workItemCount() {
218  return 1;
219  }
220 
230  public function getDeduplicationInfo() {
231  $info = [
232  'type' => $this->getType(),
233  'namespace' => $this->getTitle()->getNamespace(),
234  'title' => $this->getTitle()->getDBkey(),
235  'params' => $this->getParams()
236  ];
237  if ( is_array( $info['params'] ) ) {
238  // Identical jobs with different "root" jobs should count as duplicates
239  unset( $info['params']['rootJobSignature'] );
240  unset( $info['params']['rootJobTimestamp'] );
241  // Likewise for jobs with different delay times
242  unset( $info['params']['jobReleaseTimestamp'] );
243  // Identical jobs from different requests should count as duplicates
244  unset( $info['params']['requestId'] );
245  // Queues pack and hash this array, so normalize the order
246  ksort( $info['params'] );
247  }
248 
249  return $info;
250  }
251 
271  public static function newRootJobParams( $key ) {
272  return [
273  'rootJobIsSelf' => true,
274  'rootJobSignature' => sha1( $key ),
275  'rootJobTimestamp' => wfTimestampNow()
276  ];
277  }
278 
284  public function getRootJobParams() {
285  return [
286  'rootJobSignature' => isset( $this->params['rootJobSignature'] )
287  ? $this->params['rootJobSignature']
288  : null,
289  'rootJobTimestamp' => isset( $this->params['rootJobTimestamp'] )
290  ? $this->params['rootJobTimestamp']
291  : null
292  ];
293  }
294 
300  public function hasRootJobParams() {
301  return isset( $this->params['rootJobSignature'] )
302  && isset( $this->params['rootJobTimestamp'] );
303  }
304 
309  public function isRootJob() {
310  return $this->hasRootJobParams() && !empty( $this->params['rootJobIsSelf'] );
311  }
312 
319  protected function addTeardownCallback( $callback ) {
320  $this->teardownCallbacks[] = $callback;
321  }
322 
328  public function teardown( $status ) {
329  foreach ( $this->teardownCallbacks as $callback ) {
330  call_user_func( $callback, $status );
331  }
332  }
333 
339  public function insert() {
340  JobQueueGroup::singleton()->push( $this );
341  return true;
342  }
343 
347  public function toString() {
348  $paramString = '';
349  if ( $this->params ) {
350  foreach ( $this->params as $key => $value ) {
351  if ( $paramString != '' ) {
352  $paramString .= ' ';
353  }
354  if ( is_array( $value ) ) {
355  $filteredValue = [];
356  foreach ( $value as $k => $v ) {
357  $json = FormatJson::encode( $v );
358  if ( $json === false || mb_strlen( $json ) > 512 ) {
359  $filteredValue[$k] = gettype( $v ) . '(...)';
360  } else {
361  $filteredValue[$k] = $v;
362  }
363  }
364  if ( count( $filteredValue ) <= 10 ) {
365  $value = FormatJson::encode( $filteredValue );
366  } else {
367  $value = "array(" . count( $value ) . ")";
368  }
369  } elseif ( is_object( $value ) && !method_exists( $value, '__toString' ) ) {
370  $value = "object(" . get_class( $value ) . ")";
371  }
372 
373  $flatValue = (string)$value;
374  if ( mb_strlen( $value ) > 1024 ) {
375  $flatValue = "string(" . mb_strlen( $value ) . ")";
376  }
377 
378  $paramString .= "$key={$flatValue}";
379  }
380  }
381 
382  $metaString = '';
383  foreach ( $this->metadata as $key => $value ) {
384  if ( is_scalar( $value ) && mb_strlen( $value ) < 1024 ) {
385  $metaString .= ( $metaString ? ",$key=$value" : "$key=$value" );
386  }
387  }
388 
389  $s = $this->command;
390  if ( is_object( $this->title ) ) {
391  $s .= " {$this->title->getPrefixedDBkey()}";
392  }
393  if ( $paramString != '' ) {
394  $s .= " $paramString";
395  }
396  if ( $metaString != '' ) {
397  $s .= " ($metaString)";
398  }
399 
400  return $s;
401  }
402 
403  protected function setLastError( $error ) {
404  $this->error = $error;
405  }
406 
407  public function getLastError() {
408  return $this->error;
409  }
410 }
Job\getRootJobParams
getRootJobParams()
Definition: Job.php:284
Job\getReleaseTimestamp
getReleaseTimestamp()
Definition: Job.php:153
Job\teardown
teardown( $status)
Do any final cleanup after run(), deferred updates, and all DB commits happen.
Definition: Job.php:328
Job\getType
getType()
Definition: Job.php:131
Job\getParams
getParams()
Definition: Job.php:145
Job\toString
toString()
Definition: Job.php:347
captcha-old.count
count
Definition: captcha-old.py:249
Job\workItemCount
workItemCount()
Definition: Job.php:217
Job\getRequestId
getRequestId()
Definition: Job.php:175
Job\$title
Title $title
Definition: Job.php:42
Job\getQueuedTimestamp
getQueuedTimestamp()
Definition: Job.php:163
Job\getReadyTimestamp
getReadyTimestamp()
Definition: Job.php:185
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1245
$s
$s
Definition: mergeMessageFileList.php:188
Job\addTeardownCallback
addTeardownCallback( $callback)
Definition: Job.php:319
Job\$teardownCallbacks
callable[] $teardownCallbacks
Definition: Job.php:51
Job\$params
array $params
Array of job parameters.
Definition: Job.php:36
Job\setLastError
setLastError( $error)
Definition: Job.php:403
php
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
Job\ignoreDuplicates
ignoreDuplicates()
Whether the queue should reject insertion of this job if a duplicate exists.
Definition: Job.php:200
Job\getTitle
getTitle()
Definition: Job.php:138
title
to move a page</td >< td > &*You are moving the page across *A non empty talk page already exists under the new or *You uncheck the box below In those you will have to move or merge the page manually if desired</td >< td > be sure to &You are responsible for making sure that links continue to point where they are supposed to go Note that the page will &a page at the new title
Definition: All_system_messages.txt:2696
Job
Class to both describe a background job and handle jobs.
Definition: Job.php:31
Job\factory
static factory( $command, Title $title, $params=[])
Create the appropriate object to handle a specific job.
Definition: Job.php:68
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
Job\run
run()
Run the job.
Job\$error
string $error
Text for error that occurred last.
Definition: Job.php:48
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1176
Job\$command
string $command
Definition: Job.php:33
wfTimestampOrNull
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
Definition: GlobalFunctions.php:2056
Job\$metadata
array $metadata
Additional queue metadata.
Definition: Job.php:39
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
wfTimestampNow
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
Definition: GlobalFunctions.php:2069
Job\newRootJobParams
static newRootJobParams( $key)
Get "root job" parameters for a task.
Definition: Job.php:271
string
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:175
Job\allowRetries
allowRetries()
Definition: Job.php:208
$value
$value
Definition: styleTest.css.php:45
Job\batchInsert
static batchInsert( $jobs)
Batch-insert a group of jobs into the queue.
Definition: Job.php:122
Job\$removeDuplicates
bool $removeDuplicates
Expensive jobs may set this to true.
Definition: Job.php:45
Job\getLastError
getLastError()
Definition: Job.php:407
Job\getDeduplicationInfo
getDeduplicationInfo()
Subclasses may need to override this to make duplication detection work.
Definition: Job.php:230
$handler
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:781
$wgJobClasses
$wgJobClasses
Maps jobs to their handlers; extensions can add to this to provide custom jobs.
Definition: DefaultSettings.php:7396
Title
Represents a title within MediaWiki.
Definition: Title.php:39
$job
if(count( $args)< 1) $job
Definition: recompressTracked.php:47
WebRequest\getRequestId
static getRequestId()
Get the unique request ID.
Definition: WebRequest.php:272
JobQueueGroup\singleton
static singleton( $wiki=false)
Definition: JobQueueGroup.php:72
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Job\isRootJob
isRootJob()
Definition: Job.php:309
Job\hasRootJobParams
hasRootJobParams()
Definition: Job.php:300
error
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition: hooks.txt:2581
Job\__construct
__construct( $command, $title, $params=false)
Definition: Job.php:98
Job\insert
insert()
Insert a single job into the queue.
Definition: Job.php:339
IJobSpecification
Job queue task description interface.
Definition: JobSpecification.php:30
array
the array() calling protocol came about after MediaWiki 1.4rc1.