MediaWiki  master
Job.php
Go to the documentation of this file.
1 <?php
30 abstract class Job implements RunnableJob {
32  public $command;
33 
35  public $params;
36 
38  public $metadata = [];
39 
41  protected $title;
42 
44  protected $removeDuplicates = false;
45 
47  protected $error;
48 
50  protected $teardownCallbacks = [];
51 
53  protected $executionFlags = 0;
54 
56  const JOB_NO_EXPLICIT_TRX_ROUND = 1;
57 
66  public static function factory( $command, $params = [] ) {
67  global $wgJobClasses;
68 
69  if ( $params instanceof Title ) {
70  // Backwards compatibility for old signature ($command, $title, $params)
71  $title = $params;
72  $params = func_num_args() >= 3 ? func_get_arg( 2 ) : [];
73  } elseif ( isset( $params['namespace'] ) && isset( $params['title'] ) ) {
74  // Handle job classes that take title as constructor parameter.
75  // If a newer classes like GenericParameterJob uses these parameters,
76  // then this happens in Job::__construct instead.
77  $title = Title::makeTitle( $params['namespace'], $params['title'] );
78  } else {
79  // Default title for job classes not implementing GenericParameterJob.
80  // This must be a valid title because it not directly passed to
81  // our Job constructor, but rather it's subclasses which may expect
82  // to be able to use it.
83  $title = Title::makeTitle( NS_SPECIAL, 'Blankpage' );
84  }
85 
86  if ( isset( $wgJobClasses[$command] ) ) {
87  $handler = $wgJobClasses[$command];
88 
89  if ( is_callable( $handler ) ) {
90  $job = call_user_func( $handler, $title, $params );
91  } elseif ( class_exists( $handler ) ) {
92  if ( is_subclass_of( $handler, GenericParameterJob::class ) ) {
93  $job = new $handler( $params );
94  } else {
95  $job = new $handler( $title, $params );
96  }
97  } else {
98  $job = null;
99  }
100 
101  if ( $job instanceof Job ) {
102  $job->command = $command;
103 
104  return $job;
105  } else {
106  throw new InvalidArgumentException(
107  "Could not instantiate job '$command': bad spec!"
108  );
109  }
110  }
111 
112  throw new InvalidArgumentException( "Invalid job command '{$command}'" );
113  }
114 
119  public function __construct( $command, $params = null ) {
120  if ( $params instanceof Title ) {
121  // Backwards compatibility for old signature ($command, $title, $params)
122  $title = $params;
123  $params = func_num_args() >= 3 ? func_get_arg( 2 ) : [];
124  } else {
125  // Newer jobs may choose to not have a top-level title (e.g. GenericParameterJob)
126  $title = null;
127  }
128 
129  if ( !is_array( $params ) ) {
130  throw new InvalidArgumentException( '$params must be an array' );
131  }
132 
133  if (
134  $title &&
135  !isset( $params['namespace'] ) &&
136  !isset( $params['title'] )
137  ) {
138  // When constructing this class for submitting to the queue,
139  // normalise the $title arg of old job classes as part of $params.
140  $params['namespace'] = $title->getNamespace();
141  $params['title'] = $title->getDBKey();
142  }
143 
144  $this->command = $command;
145  $this->params = $params + [ 'requestId' => WebRequest::getRequestId() ];
146 
147  if ( $this->title === null ) {
148  // Set this field for access via getTitle().
149  $this->title = ( isset( $params['namespace'] ) && isset( $params['title'] ) )
150  ? Title::makeTitle( $params['namespace'], $params['title'] )
151  // GenericParameterJob classes without namespace/title params
152  // should not use getTitle(). Set an invalid title as placeholder.
153  : Title::makeTitle( NS_SPECIAL, '' );
154  }
155  }
156 
162  public function hasExecutionFlag( $flag ) {
163  return ( $this->executionFlags & $flag ) === $flag;
164  }
165 
169  public function getType() {
170  return $this->command;
171  }
172 
176  final public function getTitle() {
177  return $this->title;
178  }
179 
183  public function getParams() {
184  return $this->params;
185  }
186 
192  public function getMetadata( $field = null ) {
193  if ( $field === null ) {
194  return $this->metadata;
195  }
196 
197  return $this->metadata[$field] ?? null;
198  }
199 
206  public function setMetadata( $field, $value ) {
207  $old = $this->getMetadata( $field );
208  if ( $value === null ) {
209  unset( $this->metadata[$field] );
210  } else {
211  $this->metadata[$field] = $value;
212  }
213 
214  return $old;
215  }
216 
221  public function getReleaseTimestamp() {
222  return isset( $this->params['jobReleaseTimestamp'] )
223  ? wfTimestampOrNull( TS_UNIX, $this->params['jobReleaseTimestamp'] )
224  : null;
225  }
226 
231  public function getQueuedTimestamp() {
232  return isset( $this->metadata['timestamp'] )
233  ? wfTimestampOrNull( TS_UNIX, $this->metadata['timestamp'] )
234  : null;
235  }
236 
243  public function getRequestId() {
244  return $this->params['requestId'] ?? null;
245  }
246 
251  public function getReadyTimestamp() {
252  return $this->getReleaseTimestamp() ?: $this->getQueuedTimestamp();
253  }
254 
266  public function ignoreDuplicates() {
268  }
269 
274  public function allowRetries() {
275  return true;
276  }
277 
283  public function workItemCount() {
284  return 1;
285  }
286 
296  public function getDeduplicationInfo() {
297  $info = [
298  'type' => $this->getType(),
299  'params' => $this->getParams()
300  ];
301  if ( is_array( $info['params'] ) ) {
302  // Identical jobs with different "root" jobs should count as duplicates
303  unset( $info['params']['rootJobSignature'] );
304  unset( $info['params']['rootJobTimestamp'] );
305  // Likewise for jobs with different delay times
306  unset( $info['params']['jobReleaseTimestamp'] );
307  // Identical jobs from different requests should count as duplicates
308  unset( $info['params']['requestId'] );
309  // Queues pack and hash this array, so normalize the order
310  ksort( $info['params'] );
311  }
312 
313  return $info;
314  }
315 
335  public static function newRootJobParams( $key ) {
336  return [
337  'rootJobIsSelf' => true,
338  'rootJobSignature' => sha1( $key ),
339  'rootJobTimestamp' => wfTimestampNow()
340  ];
341  }
342 
348  public function getRootJobParams() {
349  return [
350  'rootJobSignature' => $this->params['rootJobSignature'] ?? null,
351  'rootJobTimestamp' => $this->params['rootJobTimestamp'] ?? null
352  ];
353  }
354 
360  public function hasRootJobParams() {
361  return isset( $this->params['rootJobSignature'] )
362  && isset( $this->params['rootJobTimestamp'] );
363  }
364 
369  public function isRootJob() {
370  return $this->hasRootJobParams() && !empty( $this->params['rootJobIsSelf'] );
371  }
372 
379  protected function addTeardownCallback( $callback ) {
380  $this->teardownCallbacks[] = $callback;
381  }
382 
388  public function teardown( $status ) {
389  foreach ( $this->teardownCallbacks as $callback ) {
390  call_user_func( $callback, $status );
391  }
392  }
393 
397  public function toString() {
398  $paramString = '';
399  if ( $this->params ) {
400  foreach ( $this->params as $key => $value ) {
401  if ( $paramString != '' ) {
402  $paramString .= ' ';
403  }
404  if ( is_array( $value ) ) {
405  $filteredValue = [];
406  foreach ( $value as $k => $v ) {
407  $json = FormatJson::encode( $v );
408  if ( $json === false || mb_strlen( $json ) > 512 ) {
409  $filteredValue[$k] = gettype( $v ) . '(...)';
410  } else {
411  $filteredValue[$k] = $v;
412  }
413  }
414  if ( count( $filteredValue ) <= 10 ) {
415  $value = FormatJson::encode( $filteredValue );
416  } else {
417  $value = "array(" . count( $value ) . ")";
418  }
419  } elseif ( is_object( $value ) && !method_exists( $value, '__toString' ) ) {
420  $value = "object(" . get_class( $value ) . ")";
421  }
422 
423  $flatValue = (string)$value;
424  if ( mb_strlen( $value ) > 1024 ) {
425  $flatValue = "string(" . mb_strlen( $value ) . ")";
426  }
427 
428  $paramString .= "$key={$flatValue}";
429  }
430  }
431 
432  $metaString = '';
433  foreach ( $this->metadata as $key => $value ) {
434  if ( is_scalar( $value ) && mb_strlen( $value ) < 1024 ) {
435  $metaString .= ( $metaString ? ",$key=$value" : "$key=$value" );
436  }
437  }
438 
439  $s = $this->command;
440  if ( is_object( $this->title ) ) {
441  $s .= " {$this->title->getPrefixedDBkey()}";
442  }
443  if ( $paramString != '' ) {
444  $s .= " $paramString";
445  }
446  if ( $metaString != '' ) {
447  $s .= " ($metaString)";
448  }
449 
450  return $s;
451  }
452 
453  protected function setLastError( $error ) {
454  $this->error = $error;
455  }
456 
457  public function getLastError() {
458  return $this->error;
459  }
460 }
getType()
Definition: Job.php:169
callable [] $teardownCallbacks
Definition: Job.php:50
getParams()
Definition: Job.php:183
hasRootJobParams()
Definition: Job.php:360
static getRequestId()
Get the unique request ID.
Definition: WebRequest.php:275
getTitle()
Definition: Job.php:176
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:2633
hasExecutionFlag( $flag)
Definition: Job.php:162
string $error
Text for error that occurred last.
Definition: Job.php:47
__construct( $command, $params=null)
Definition: Job.php:119
getQueuedTimestamp()
Definition: Job.php:231
allowRetries()
Definition: Job.php:274
Class to both describe a background job and handle jobs.
Definition: Job.php:30
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
$value
getReadyTimestamp()
Definition: Job.php:251
string $command
Definition: Job.php:32
const NS_SPECIAL
Definition: Defines.php:49
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
getReleaseTimestamp()
Definition: Job.php:221
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
$wgJobClasses
Maps jobs to their handlers; extensions can add to this to provide custom jobs.
title
ignoreDuplicates()
Whether the queue should reject insertion of this job if a duplicate exists.
Definition: Job.php:266
static newRootJobParams( $key)
Get "root job" parameters for a task.
Definition: Job.php:335
setLastError( $error)
Definition: Job.php:453
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
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. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header '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 '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). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. '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:1263
addTeardownCallback( $callback)
Definition: Job.php:379
getRootJobParams()
Definition: Job.php:348
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
getRequestId()
Definition: Job.php:243
setMetadata( $field, $value)
Definition: Job.php:206
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
Job that has a run() method and metadata accessors for JobQueue::pop() and JobQueue::ack() ...
Definition: RunnableJob.php:35
toString()
Definition: Job.php:397
getNamespace()
Get the namespace index, i.e.
Definition: Title.php:1026
static factory( $command, $params=[])
Create the appropriate object to handle a specific job.
Definition: Job.php:66
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
bool $removeDuplicates
Expensive jobs may set this to true.
Definition: Job.php:44
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:589
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
teardown( $status)
Do any final cleanup after run(), deferred updates, and all DB commits happen.
Definition: Job.php:388
int $executionFlags
Bitfield of JOB_* class constants.
Definition: Job.php:53
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
array $metadata
Additional queue metadata.
Definition: Job.php:38
if(count( $args)< 1) $job
getMetadata( $field=null)
Definition: Job.php:192
array $params
Array of job parameters.
Definition: Job.php:35
isRootJob()
Definition: Job.php:369
getLastError()
Definition: Job.php:457
getDeduplicationInfo()
Subclasses may need to override this to make duplication detection work.
Definition: Job.php:296
workItemCount()
Definition: Job.php:283
Title $title
Definition: Job.php:41