MediaWiki  1.30.0
PoolWorkArticleView.php
Go to the documentation of this file.
1 <?php
21 
24  private $page;
25 
27  private $cacheKey;
28 
30  private $revid;
31 
33  private $parserCache;
34 
36  private $parserOptions;
37 
39  private $content = null;
40 
42  private $parserOutput = false;
43 
45  private $isDirty = false;
46 
48  private $error = false;
49 
60  $revid, $useParserCache, $content = null
61  ) {
62  if ( is_string( $content ) ) { // BC: old style call
63  $modelId = $page->getRevision()->getContentModel();
64  $format = $page->getRevision()->getContentFormat();
65  $content = ContentHandler::makeContent( $content, $page->getTitle(), $modelId, $format );
66  }
67 
68  $this->page = $page;
69  $this->revid = $revid;
70  $this->cacheable = $useParserCache;
71  $this->parserOptions = $parserOptions;
72  $this->content = $content;
73  $this->parserCache = MediaWikiServices::getInstance()->getParserCache();
74  $this->cacheKey = $this->parserCache->getKey( $page, $parserOptions );
75  $keyPrefix = $this->cacheKey ?: wfMemcKey( 'articleview', 'missingcachekey' );
76  parent::__construct( 'ArticleView', $keyPrefix . ':revid:' . $revid );
77  }
78 
84  public function getParserOutput() {
85  return $this->parserOutput;
86  }
87 
93  public function getIsDirty() {
94  return $this->isDirty;
95  }
96 
102  public function getError() {
103  return $this->error;
104  }
105 
109  public function doWork() {
111 
112  // @todo several of the methods called on $this->page are not declared in Page, but present
113  // in WikiPage and delegated by Article.
114 
115  $isCurrent = $this->revid === $this->page->getLatest();
116 
117  if ( $this->content !== null ) {
119  } elseif ( $isCurrent ) {
120  // XXX: why use RAW audience here, and PUBLIC (default) below?
121  $content = $this->page->getContent( Revision::RAW );
122  } else {
123  $rev = Revision::newFromTitle( $this->page->getTitle(), $this->revid );
124 
125  if ( $rev === null ) {
126  $content = null;
127  } else {
128  // XXX: why use PUBLIC audience here (default), and RAW above?
129  $content = $rev->getContent();
130  }
131  }
132 
133  if ( $content === null ) {
134  return false;
135  }
136 
137  // Reduce effects of race conditions for slow parses (T48014)
138  $cacheTime = wfTimestampNow();
139 
140  $time = - microtime( true );
141  $this->parserOutput = $content->getParserOutput(
142  $this->page->getTitle(),
143  $this->revid,
145  );
146  $time += microtime( true );
147 
148  // Timing hack
149  if ( $time > 3 ) {
150  // TODO: Use Parser's logger (once it has one)
151  $logger = MediaWiki\Logger\LoggerFactory::getInstance( 'slow-parse' );
152  $logger->info( '{time} {title}', [
153  'time' => number_format( $time, 2 ),
154  'title' => $this->page->getTitle()->getPrefixedDBkey(),
155  'ns' => $this->page->getTitle()->getNamespace(),
156  'trigger' => 'view',
157  ] );
158  }
159 
160  if ( $this->cacheable && $this->parserOutput->isCacheable() && $isCurrent ) {
161  $this->parserCache->save(
162  $this->parserOutput, $this->page, $this->parserOptions, $cacheTime, $this->revid );
163  }
164 
165  // Make sure file cache is not used on uncacheable content.
166  // Output that has magic words in it can still use the parser cache
167  // (if enabled), though it will generally expire sooner.
168  if ( !$this->parserOutput->isCacheable() ) {
169  $wgUseFileCache = false;
170  }
171 
172  if ( $isCurrent ) {
173  $this->page->triggerOpportunisticLinksUpdate( $this->parserOutput );
174  }
175 
176  return true;
177  }
178 
182  public function getCachedWork() {
183  $this->parserOutput = $this->parserCache->get( $this->page, $this->parserOptions );
184 
185  if ( $this->parserOutput === false ) {
186  wfDebug( __METHOD__ . ": parser cache miss\n" );
187  return false;
188  } else {
189  wfDebug( __METHOD__ . ": parser cache hit\n" );
190  return true;
191  }
192  }
193 
197  public function fallback() {
198  $this->parserOutput = $this->parserCache->getDirty( $this->page, $this->parserOptions );
199 
200  if ( $this->parserOutput === false ) {
201  wfDebugLog( 'dirty', 'dirty missing' );
202  wfDebug( __METHOD__ . ": no dirty cache\n" );
203  return false;
204  } else {
205  wfDebug( __METHOD__ . ": sending dirty output\n" );
206  wfDebugLog( 'dirty', "dirty output {$this->cacheKey}" );
207  $this->isDirty = true;
208  return true;
209  }
210  }
211 
216  public function error( $status ) {
217  $this->error = $status;
218  return false;
219  }
220 }
ParserOptions
Set options of the Parser.
Definition: ParserOptions.php:40
ParserOutput
Definition: ParserOutput.php:24
PoolWorkArticleView\doWork
doWork()
Definition: PoolWorkArticleView.php:109
content
per default it will return the text for text based content
Definition: contenthandler.txt:104
MediaWiki\Logger\LoggerFactory\getInstance
static getInstance( $channel)
Get a named logger instance from the currently configured logger factory.
Definition: LoggerFactory.php:92
$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
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
WikiPage
Class representing a MediaWiki article and history.
Definition: WikiPage.php:37
PoolWorkArticleView
Definition: PoolWorkArticleView.php:22
PoolWorkArticleView\__construct
__construct(WikiPage $page, ParserOptions $parserOptions, $revid, $useParserCache, $content=null)
Definition: PoolWorkArticleView.php:59
WikiPage\getRevision
getRevision()
Get the latest revision.
Definition: WikiPage.php:645
page
target page
Definition: All_system_messages.txt:1267
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1140
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
PoolWorkArticleView\$page
WikiPage $page
Definition: PoolWorkArticleView.php:24
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
PoolWorkArticleView\$parserOptions
ParserOptions $parserOptions
Definition: PoolWorkArticleView.php:36
Revision\newFromTitle
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
Definition: Revision.php:134
PoolWorkArticleView\$parserOutput
ParserOutput bool $parserOutput
Definition: PoolWorkArticleView.php:42
PoolWorkArticleView\$revid
int $revid
Definition: PoolWorkArticleView.php:30
wfMemcKey
wfMemcKey()
Make a cache key for the local wiki.
Definition: GlobalFunctions.php:2756
PoolWorkArticleView\$error
Status bool $error
Definition: PoolWorkArticleView.php:48
$wgUseFileCache
$wgUseFileCache
This will cache static pages for non-logged-in users to reduce database traffic on public sites.
Definition: DefaultSettings.php:2554
WikiPage\getTitle
getTitle()
Get the title object of the article.
Definition: WikiPage.php:239
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1778
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
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:1047
ContentHandler\makeContent
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
Definition: ContentHandler.php:129
PoolWorkArticleView\$cacheKey
string $cacheKey
Definition: PoolWorkArticleView.php:27
PoolWorkArticleView\getError
getError()
Get a Status object in case of error or false otherwise.
Definition: PoolWorkArticleView.php:102
Revision\RAW
const RAW
Definition: Revision.php:100
Content
Base interface for content objects.
Definition: Content.php:34
$rev
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:1750
ParserCache
Definition: ParserCache.php:30
PoolCounterWork
Class for dealing with PoolCounters using class members.
Definition: PoolCounterWork.php:27
PoolWorkArticleView\getParserOutput
getParserOutput()
Get the ParserOutput from this object, or false in case of failure.
Definition: PoolWorkArticleView.php:84
PoolWorkArticleView\error
error( $status)
Definition: PoolWorkArticleView.php:216
PoolWorkArticleView\$isDirty
bool $isDirty
Definition: PoolWorkArticleView.php:45
Content\getParserOutput
getParserOutput(Title $title, $revId=null, ParserOptions $options=null, $generateHtml=true)
Parse the Content object and generate a ParserOutput from the result.
MediaWikiServices
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
PoolWorkArticleView\$parserCache
ParserCache $parserCache
Definition: PoolWorkArticleView.php:33
PoolWorkArticleView\fallback
fallback()
Definition: PoolWorkArticleView.php:197
PoolWorkArticleView\getCachedWork
getCachedWork()
Definition: PoolWorkArticleView.php:182
PoolWorkArticleView\getIsDirty
getIsDirty()
Get whether the ParserOutput is a dirty one (i.e.
Definition: PoolWorkArticleView.php:93
PoolWorkArticleView\$content
Content null $content
Definition: PoolWorkArticleView.php:39