includes/poolcounter/PoolWorkArticleView.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 class PoolWorkArticleView extends PoolCounterWork {
  22         /** @var Page */
  23         private $page;
  24
  25         /** @var string */
  26         private $cacheKey;
  27
  28         /** @var int */
  29         private $revid;
  30
  31         /** @var ParserOptions */
  32         private $parserOptions;
  33
  34         /** @var Content|null */
  35         private $content = null;
  36
  37         /** @var ParserOutput|bool */
  38         private $parserOutput = false;
  39
  40         /** @var bool */
  41         private $isDirty = false;
  42
  43         /** @var Status|bool */
  44         private $error = false;
  45
  46         /**
  47          * @param Page $page
  48          * @param ParserOptions $parserOptions ParserOptions to use for the parse
  49          * @param int $revid ID of the revision being parsed.
  50          * @param bool $useParserCache Whether to use the parser cache.
  51          *   operation.
  52          * @param Content|string $content Content to parse or null to load it; may
  53          *   also be given as a wikitext string, for BC.
  54          */
  55         public function __construct( Page $page, ParserOptions $parserOptions,
  56                 $revid, $useParserCache, $content = null
  57         ) {
  58                 if ( is_string( $content ) ) { // BC: old style call
  59                         $modelId = $page->getRevision()->getContentModel();
  60                         $format = $page->getRevision()->getContentFormat();
  61                         $content = ContentHandler::makeContent( $content, $page->getTitle(), $modelId, $format );
  62                 }
  63
  64                 $this->page = $page;
  65                 $this->revid = $revid;
  66                 $this->cacheable = $useParserCache;
  67                 $this->parserOptions = $parserOptions;
  68                 $this->content = $content;
  69                 $this->cacheKey = ParserCache::singleton()->getKey( $page, $parserOptions );
  70                 $keyPrefix = $this->cacheKey ?: wfMemcKey( 'articleview', 'missingcachekey' );
  71                 parent::__construct( 'ArticleView', $keyPrefix . ':revid:' . $revid );
  72         }
  73
  74         /**
  75          * Get the ParserOutput from this object, or false in case of failure
  76          *
  77          * @return ParserOutput
  78          */
  79         public function getParserOutput() {
  80                 return $this->parserOutput;
  81         }
  82
  83         /**
  84          * Get whether the ParserOutput is a dirty one (i.e. expired)
  85          *
  86          * @return bool
  87          */
  88         public function getIsDirty() {
  89                 return $this->isDirty;
  90         }
  91
  92         /**
  93          * Get a Status object in case of error or false otherwise
  94          *
  95          * @return Status|bool
  96          */
  97         public function getError() {
  98                 return $this->error;
  99         }
 100
 101         /**
 102          * @return bool
 103          */
 104         public function doWork() {
 105                 global $wgUseFileCache;
 106
 107                 // @todo several of the methods called on $this->page are not declared in Page, but present
 108                 //        in WikiPage and delegated by Article.
 109
 110                 $isCurrent = $this->revid === $this->page->getLatest();
 111
 112                 if ( $this->content !== null ) {
 113                         $content = $this->content;
 114                 } elseif ( $isCurrent ) {
 115                         // XXX: why use RAW audience here, and PUBLIC (default) below?
 116                         $content = $this->page->getContent( Revision::RAW );
 117                 } else {
 118                         $rev = Revision::newFromTitle( $this->page->getTitle(), $this->revid );
 119
 120                         if ( $rev === null ) {
 121                                 $content = null;
 122                         } else {
 123                                 // XXX: why use PUBLIC audience here (default), and RAW above?
 124                                 $content = $rev->getContent();
 125                         }
 126                 }
 127
 128                 if ( $content === null ) {
 129                         return false;
 130                 }
 131
 132                 // Reduce effects of race conditions for slow parses (bug 46014)
 133                 $cacheTime = wfTimestampNow();
 134
 135                 $time = - microtime( true );
 136                 $this->parserOutput = $content->getParserOutput(
 137                         $this->page->getTitle(),
 138                         $this->revid,
 139                         $this->parserOptions
 140                 );
 141                 $time += microtime( true );
 142
 143                 // Timing hack
 144                 if ( $time > 3 ) {
 145                         wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
 146                                 $this->page->getTitle()->getPrefixedDBkey() ) );
 147                 }
 148
 149                 if ( $this->cacheable && $this->parserOutput->isCacheable() && $isCurrent ) {
 150                         ParserCache::singleton()->save(
 151                                 $this->parserOutput, $this->page, $this->parserOptions, $cacheTime, $this->revid );
 152                 }
 153
 154                 // Make sure file cache is not used on uncacheable content.
 155                 // Output that has magic words in it can still use the parser cache
 156                 // (if enabled), though it will generally expire sooner.
 157                 if ( !$this->parserOutput->isCacheable() ) {
 158                         $wgUseFileCache = false;
 159                 }
 160
 161                 if ( $isCurrent ) {
 162                         $this->page->triggerOpportunisticLinksUpdate( $this->parserOutput );
 163                 }
 164
 165                 return true;
 166         }
 167
 168         /**
 169          * @return bool
 170          */
 171         public function getCachedWork() {
 172                 $this->parserOutput = ParserCache::singleton()->get( $this->page, $this->parserOptions );
 173
 174                 if ( $this->parserOutput === false ) {
 175                         wfDebug( __METHOD__ . ": parser cache miss\n" );
 176                         return false;
 177                 } else {
 178                         wfDebug( __METHOD__ . ": parser cache hit\n" );
 179                         return true;
 180                 }
 181         }
 182
 183         /**
 184          * @return bool
 185          */
 186         public function fallback() {
 187                 $this->parserOutput = ParserCache::singleton()->getDirty( $this->page, $this->parserOptions );
 188
 189                 if ( $this->parserOutput === false ) {
 190                         wfDebugLog( 'dirty', 'dirty missing' );
 191                         wfDebug( __METHOD__ . ": no dirty cache\n" );
 192                         return false;
 193                 } else {
 194                         wfDebug( __METHOD__ . ": sending dirty output\n" );
 195                         wfDebugLog( 'dirty', "dirty output {$this->cacheKey}" );
 196                         $this->isDirty = true;
 197                         return true;
 198                 }
 199         }
 200
 201         /**
 202          * @param Status $status
 203          * @return bool
 204          */
 205         public function error( $status ) {
 206                 $this->error = $status;
 207                 return false;
 208         }
 209 }