fa7bb033df
Follows similar commits to the objectcache, rdbms, profiler, filerepo components and other areas [1]. * Remove duplicate descriptions from file blocks in favour of class doc blocks. This reduces needless duplication and was often incorrect or outdated, and helps (ironically) to make the file header more consistently visually ignorable. * Remove `ingroup` from file blocks in class files as otherwise the file is indexed twice (e.g. in Doxygen) which makes navigation more messy. * Remove `throws` tag for an undescribed MWException that isn't meant to be caught by callers. [1] https://gerrit.wikimedia.org/r/q/message:ingroup+owner:Krinkle Change-Id: I6cd0d2a4d3179668779813a97bb55142eadf8851
112 lines
3 KiB
PHP
112 lines
3 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
use MediaWiki\Logger\Spi as LoggerSpi;
|
|
use MediaWiki\Revision\RevisionRecord;
|
|
use MediaWiki\Revision\RevisionRenderer;
|
|
|
|
/**
|
|
* PoolCounter protected work wrapping RenderedRevision->getRevisionParserOutput.
|
|
* Caching behavior may be defined by subclasses.
|
|
*
|
|
* @note No audience checks are applied.
|
|
*
|
|
* @internal
|
|
*/
|
|
class PoolWorkArticleView extends PoolCounterWork {
|
|
/** @var ParserOptions */
|
|
protected $parserOptions;
|
|
/** @var RevisionRecord */
|
|
protected $revision;
|
|
/** @var RevisionRenderer */
|
|
private $renderer;
|
|
/** @var LoggerSpi */
|
|
protected $loggerSpi;
|
|
|
|
/**
|
|
* @param string $workKey
|
|
* @param RevisionRecord $revision Revision to render
|
|
* @param ParserOptions $parserOptions ParserOptions to use for the parse
|
|
* @param RevisionRenderer $revisionRenderer
|
|
* @param LoggerSpi $loggerSpi
|
|
*/
|
|
public function __construct(
|
|
string $workKey,
|
|
RevisionRecord $revision,
|
|
ParserOptions $parserOptions,
|
|
RevisionRenderer $revisionRenderer,
|
|
LoggerSpi $loggerSpi
|
|
) {
|
|
parent::__construct( 'ArticleView', $workKey );
|
|
$this->revision = $revision;
|
|
$this->parserOptions = $parserOptions;
|
|
$this->renderer = $revisionRenderer;
|
|
$this->loggerSpi = $loggerSpi;
|
|
}
|
|
|
|
/**
|
|
* @return Status
|
|
*/
|
|
public function doWork() {
|
|
return $this->renderRevision();
|
|
}
|
|
|
|
/**
|
|
* @return Status with the value being a ParserOutput or null
|
|
*/
|
|
public function renderRevision(): Status {
|
|
$renderedRevision = $this->renderer->getRenderedRevision(
|
|
$this->revision,
|
|
$this->parserOptions,
|
|
null,
|
|
[ 'audience' => RevisionRecord::RAW ]
|
|
);
|
|
if ( !$renderedRevision ) {
|
|
// audience check failed
|
|
return Status::newFatal( 'pool-errorunknown' );
|
|
}
|
|
|
|
$time = -microtime( true );
|
|
$parserOutput = $renderedRevision->getRevisionParserOutput();
|
|
$time += microtime( true );
|
|
|
|
// Timing hack
|
|
if ( $time > 3 ) {
|
|
// TODO: Use Parser's logger (once it has one)
|
|
$logger = $this->loggerSpi->getLogger( 'slow-parse' );
|
|
$logger->info( 'Parsing {title} was slow, took {time} seconds', [
|
|
'time' => number_format( $time, 2 ),
|
|
'title' => (string)$this->revision->getPageAsLinkTarget(),
|
|
'trigger' => 'view',
|
|
] );
|
|
}
|
|
|
|
return Status::newGood( $parserOutput );
|
|
}
|
|
|
|
/**
|
|
* @param Status $status
|
|
* @return Status
|
|
*/
|
|
public function error( $status ) {
|
|
return $status;
|
|
}
|
|
|
|
}
|