MediaWiki  master
PoolWorkArticleView.php
Go to the documentation of this file.
1 <?php
27 
30  private $page;
31 
33  private $cacheKey;
34 
36  private $revid;
37 
39  private $parserCache;
40 
42  private $parserOptions;
43 
45  private $revision = null;
46 
48  private $audience;
49 
51  private $revisionStore = null;
52 
54  private $renderer = null;
55 
57  private $parserOutput = false;
58 
60  private $isDirty = false;
61 
63  private $error = false;
64 
76  $revid, $useParserCache, $revision = null, $audience = RevisionRecord::FOR_PUBLIC
77  ) {
78  if ( is_string( $revision ) ) { // BC: very old style call
79  $modelId = $page->getRevision()->getContentModel();
80  $format = $page->getRevision()->getContentFormat();
81  $revision = ContentHandler::makeContent( $revision, $page->getTitle(), $modelId, $format );
82  }
83 
84  if ( $revision instanceof Content ) { // BC: old style call
86  $revision = new MutableRevisionRecord( $page->getTitle() );
87  $revision->setId( $revid );
88  $revision->setPageId( $page->getId() );
89  $revision->setContent( SlotRecord::MAIN, $content );
90  }
91 
92  if ( $revision ) {
93  // Check that the RevisionRecord matches $revid and $page, but still allow
94  // fake RevisionRecords coming from errors or hooks in Article to be rendered.
95  if ( $revision->getId() && $revision->getId() !== $revid ) {
96  throw new InvalidArgumentException( '$revid parameter mismatches $revision parameter' );
97  }
98  if ( $revision->getPageId()
99  && $revision->getPageId() !== $page->getTitle()->getArticleID()
100  ) {
101  throw new InvalidArgumentException( '$page parameter mismatches $revision parameter' );
102  }
103  }
104 
105  // TODO: DI: inject services
106  $this->renderer = MediaWikiServices::getInstance()->getRevisionRenderer();
107  $this->revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
108  $this->parserCache = MediaWikiServices::getInstance()->getParserCache();
109 
110  $this->page = $page;
111  $this->revid = $revid;
112  $this->cacheable = $useParserCache;
113  $this->parserOptions = $parserOptions;
114  $this->revision = $revision;
115  $this->audience = $audience;
116  $this->cacheKey = $this->parserCache->getKey( $page, $parserOptions );
117  $keyPrefix = $this->cacheKey ?: ObjectCache::getLocalClusterInstance()->makeKey(
118  'articleview', 'missingcachekey'
119  );
120 
121  parent::__construct( 'ArticleView', $keyPrefix . ':revid:' . $revid );
122  }
123 
129  public function getParserOutput() {
130  return $this->parserOutput;
131  }
132 
138  public function getIsDirty() {
139  return $this->isDirty;
140  }
141 
147  public function getError() {
148  return $this->error;
149  }
150 
154  public function doWork() {
155  global $wgUseFileCache;
156 
157  // @todo several of the methods called on $this->page are not declared in Page, but present
158  // in WikiPage and delegated by Article.
159 
160  $isCurrent = $this->revid === $this->page->getLatest();
161 
162  // The current revision cannot be hidden so we can skip some checks.
163  $audience = $isCurrent ? RevisionRecord::RAW : $this->audience;
164 
165  if ( $this->revision !== null ) {
167  } elseif ( $isCurrent ) {
168  $rev = $this->page->getRevision()
169  ? $this->page->getRevision()->getRevisionRecord()
170  : null;
171  } else {
172  $rev = $this->revisionStore->getRevisionByTitle( $this->page->getTitle(), $this->revid );
173  }
174 
175  if ( !$rev ) {
176  // couldn't load
177  return false;
178  }
179 
180  $renderedRevision = $this->renderer->getRenderedRevision(
181  $rev,
182  $this->parserOptions,
183  null,
184  [ 'audience' => $audience ]
185  );
186 
187  if ( !$renderedRevision ) {
188  // audience check failed
189  return false;
190  }
191 
192  // Reduce effects of race conditions for slow parses (T48014)
193  $cacheTime = wfTimestampNow();
194 
195  $time = - microtime( true );
196  $this->parserOutput = $renderedRevision->getRevisionParserOutput();
197  $time += microtime( true );
198 
199  // Timing hack
200  if ( $time > 3 ) {
201  // TODO: Use Parser's logger (once it has one)
202  $logger = MediaWiki\Logger\LoggerFactory::getInstance( 'slow-parse' );
203  $logger->info( '{time} {title}', [
204  'time' => number_format( $time, 2 ),
205  'title' => $this->page->getTitle()->getPrefixedDBkey(),
206  'ns' => $this->page->getTitle()->getNamespace(),
207  'trigger' => 'view',
208  ] );
209  }
210 
211  if ( $this->cacheable && $this->parserOutput->isCacheable() && $isCurrent ) {
212  $this->parserCache->save(
213  $this->parserOutput, $this->page, $this->parserOptions, $cacheTime, $this->revid );
214  }
215 
216  // Make sure file cache is not used on uncacheable content.
217  // Output that has magic words in it can still use the parser cache
218  // (if enabled), though it will generally expire sooner.
219  if ( !$this->parserOutput->isCacheable() ) {
220  $wgUseFileCache = false;
221  }
222 
223  if ( $isCurrent ) {
224  $this->page->triggerOpportunisticLinksUpdate( $this->parserOutput );
225  }
226 
227  return true;
228  }
229 
233  public function getCachedWork() {
234  $this->parserOutput = $this->parserCache->get( $this->page, $this->parserOptions );
235 
236  if ( $this->parserOutput === false ) {
237  wfDebug( __METHOD__ . ": parser cache miss\n" );
238  return false;
239  } else {
240  wfDebug( __METHOD__ . ": parser cache hit\n" );
241  return true;
242  }
243  }
244 
248  public function fallback() {
249  $this->parserOutput = $this->parserCache->getDirty( $this->page, $this->parserOptions );
250 
251  if ( $this->parserOutput === false ) {
252  wfDebugLog( 'dirty', 'dirty missing' );
253  wfDebug( __METHOD__ . ": no dirty cache\n" );
254  return false;
255  } else {
256  wfDebug( __METHOD__ . ": sending dirty output\n" );
257  wfDebugLog( 'dirty', "dirty output {$this->cacheKey}" );
258  $this->isDirty = true;
259  return true;
260  }
261  }
262 
267  public function error( $status ) {
268  $this->error = $status;
269  return false;
270  }
271 }
ParserOutput bool $parserOutput
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
RevisionRecord null $revision
static getLocalClusterInstance()
Get the main cluster-local cache object.
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 MediaWikiServices
Definition: injection.txt:23
static getInstance( $channel)
Get a named logger instance from the currently configured logger factory.
RevisionStore $revisionStore
target page
getIsDirty()
Get whether the ParserOutput is a dirty one (i.e.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1799
Mutable RevisionRecord implementation, for building new revision entries programmatically.
getParserOutput()
Get the ParserOutput from this object, or false in case of failure.
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
getRevision()
Get the latest revision.
Definition: WikiPage.php:783
$wgUseFileCache
This will cache static pages for non-logged-in users to reduce database traffic on public sites...
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
getTitle()
Get the title object of the article.
Definition: WikiPage.php:294
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
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1766
getId()
Get revision ID.
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
RevisionRenderer $renderer
getError()
Get a Status object in case of error or false otherwise.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
ParserOptions $parserOptions
In both all secondary updates will be triggered handle like object that caches derived data representing a revision
Definition: pageupdater.txt:78
__construct(WikiPage $page, ParserOptions $parserOptions, $revid, $useParserCache, $revision=null, $audience=RevisionRecord::FOR_PUBLIC)
Class for dealing with PoolCounters using class members.
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
$content
Definition: pageupdater.txt:72
getPageId()
Get the page ID.