ParserCache.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;

class ParserCache {
    const USE_CURRENT_ONLY = 0;

    const USE_EXPIRED = 1;

    const USE_OUTDATED = 2;

    const USE_ANYTHING = 3;

    private $cache;

    private $cacheEpoch;

    public static function singleton() {
        return MediaWikiServices::getInstance()->getParserCache();
    }

    public function __construct( BagOStuff $cache, $cacheEpoch = '20030516000000' ) {
        $this->cache = $cache;
        $this->cacheEpoch = $cacheEpoch;
    }

    protected function getParserOutputKey( $article, $hash ) {
        global $wgRequest;

        // idhash seem to mean 'page id' + 'rendering hash' (r3710)
        $pageid = $article->getId();
        $renderkey = (int)( $wgRequest->getVal( 'action' ) == 'render' );

        $key = $this->cache->makeKey( 'pcache', 'idhash', "{$pageid}-{$renderkey}!{$hash}" );
        return $key;
    }

    protected function getOptionsKey( $page ) {
        return $this->cache->makeKey( 'pcache', 'idoptions', $page->getId() );
    }

    public function deleteOptionsKey( $page ) {
        $this->cache->delete( $this->getOptionsKey( $page ) );
    }

    public function getETag( $article, $popts ) {
        return 'W/"' . $this->getParserOutputKey( $article,
            $popts->optionsHash( ParserOptions::allCacheVaryingOptions(), $article->getTitle() ) ) .
                "--" . $article->getTouched() . '"';
    }

    public function getDirty( $article, $popts ) {
        $value = $this->get( $article, $popts, true );
        return is_object( $value ) ? $value : false;
    }

    private function incrementStats( $article, $metricSuffix ) {
        // old style global metric (can be removed once no longer used)
        wfIncrStats( 'pcache.' . $metricSuffix );
        // new per content model metric
        $contentModel = str_replace( '.', '_', $article->getContentModel() );
        $metricSuffix = str_replace( '.', '_', $metricSuffix );
        wfIncrStats( 'pcache.' . $contentModel . '.' . $metricSuffix );
    }

    public function getKey( $article, $popts, $useOutdated = self::USE_ANYTHING ) {
        if ( is_bool( $useOutdated ) ) {
            $useOutdated = $useOutdated ? self::USE_ANYTHING : self::USE_CURRENT_ONLY;
        }

        if ( $popts instanceof User ) {
            wfWarn( "Use of outdated prototype ParserCache::getKey( &\$article, &\$user )\n" );
            $popts = ParserOptions::newFromUser( $popts );
        }

        // Determine the options which affect this article
        $optionsKey = $this->cache->get(
            $this->getOptionsKey( $article ), BagOStuff::READ_VERIFIED );
        if ( $optionsKey instanceof CacheTime ) {
            if ( $useOutdated < self::USE_EXPIRED && $optionsKey->expired( $article->getTouched() ) ) {
                $this->incrementStats( $article, "miss.expired" );
                $cacheTime = $optionsKey->getCacheTime();
                wfDebugLog( "ParserCache",
                    "Parser options key expired, touched " . $article->getTouched()
                    . ", epoch {$this->cacheEpoch}, cached $cacheTime\n" );
                return false;
            } elseif ( $useOutdated < self::USE_OUTDATED &&
                $optionsKey->isDifferentRevision( $article->getLatest() )
            ) {
                $this->incrementStats( $article, "miss.revid" );
                $revId = $article->getLatest();
                $cachedRevId = $optionsKey->getCacheRevisionId();
                wfDebugLog( "ParserCache",
                    "ParserOutput key is for an old revision, latest $revId, cached $cachedRevId\n"
                );
                return false;
            }

            // $optionsKey->mUsedOptions is set by save() by calling ParserOutput::getUsedOptions()
            $usedOptions = $optionsKey->mUsedOptions;
            wfDebug( "Parser cache options found.\n" );
        } else {
            if ( $useOutdated < self::USE_ANYTHING ) {
                return false;
            }
            $usedOptions = ParserOptions::allCacheVaryingOptions();
        }

        return $this->getParserOutputKey(
            $article,
            $popts->optionsHash( $usedOptions, $article->getTitle() )
        );
    }

    public function get( $article, $popts, $useOutdated = false ) {
        $canCache = $article->checkTouched();
        if ( !$canCache ) {
            // It's a redirect now
            return false;
        }

        $touched = $article->getTouched();

        $parserOutputKey = $this->getKey( $article, $popts,
            $useOutdated ? self::USE_OUTDATED : self::USE_CURRENT_ONLY
        );
        if ( $parserOutputKey === false ) {
            $this->incrementStats( $article, 'miss.absent' );
            return false;
        }

        $casToken = null;
        $value = $this->cache->get( $parserOutputKey, BagOStuff::READ_VERIFIED );
        if ( !$value ) {
            wfDebug( "ParserOutput cache miss.\n" );
            $this->incrementStats( $article, "miss.absent" );
            return false;
        }

        wfDebug( "ParserOutput cache found.\n" );

        $wikiPage = method_exists( $article, 'getPage' )
            ? $article->getPage()
            : $article;

        if ( !$useOutdated && $value->expired( $touched ) ) {
            $this->incrementStats( $article, "miss.expired" );
            $cacheTime = $value->getCacheTime();
            wfDebugLog( "ParserCache",
                "ParserOutput key expired, touched $touched, "
                . "epoch {$this->cacheEpoch}, cached $cacheTime\n" );
            $value = false;
        } elseif ( !$useOutdated && $value->isDifferentRevision( $article->getLatest() ) ) {
            $this->incrementStats( $article, "miss.revid" );
            $revId = $article->getLatest();
            $cachedRevId = $value->getCacheRevisionId();
            wfDebugLog( "ParserCache",
                "ParserOutput key is for an old revision, latest $revId, cached $cachedRevId\n"
            );
            $value = false;
        } elseif (
            Hooks::run( 'RejectParserCacheValue', [ $value, $wikiPage, $popts ] ) === false
        ) {
            $this->incrementStats( $article, 'miss.rejected' );
            wfDebugLog( "ParserCache",
                "ParserOutput key valid, but rejected by RejectParserCacheValue hook handler.\n"
            );
            $value = false;
        } else {
            $this->incrementStats( $article, "hit" );
        }

        return $value;
    }

    public function save(
        ParserOutput $parserOutput,
        $page,
        $popts,
        $cacheTime = null,
        $revId = null
    ) {
        if ( !$parserOutput->hasText() ) {
            throw new InvalidArgumentException( 'Attempt to cache a ParserOutput with no text set!' );
        }

        $expire = $parserOutput->getCacheExpiry();
        if ( $expire > 0 && !$this->cache instanceof EmptyBagOStuff ) {
            $cacheTime = $cacheTime ?: wfTimestampNow();
            if ( !$revId ) {
                $revision = $page->getRevision();
                $revId = $revision ? $revision->getId() : null;
            }

            $optionsKey = new CacheTime;
            $optionsKey->mUsedOptions = $parserOutput->getUsedOptions();
            $optionsKey->updateCacheExpiry( $expire );

            $optionsKey->setCacheTime( $cacheTime );
            $parserOutput->setCacheTime( $cacheTime );
            $optionsKey->setCacheRevisionId( $revId );
            $parserOutput->setCacheRevisionId( $revId );

            $parserOutputKey = $this->getParserOutputKey( $page,
                $popts->optionsHash( $optionsKey->mUsedOptions, $page->getTitle() ) );

            // Save the timestamp so that we don't have to load the revision row on view
            $parserOutput->setTimestamp( $page->getTimestamp() );

            $msg = "Saved in parser cache with key $parserOutputKey" .
                " and timestamp $cacheTime" .
                " and revision id $revId" .
                "\n";

            $parserOutput->mText .= "\n<!-- $msg -->\n";
            wfDebug( $msg );

            // Save the parser output
            $this->cache->set(
                $parserOutputKey,
                $parserOutput,
                $expire,
                BagOStuff::WRITE_ALLOW_SEGMENTS
            );

            // ...and its pointer
            $this->cache->set( $this->getOptionsKey( $page ), $optionsKey, $expire );

            Hooks::run(
                'ParserCacheSaveComplete',
                [ $this, $parserOutput, $page->getTitle(), $popts, $revId ]
            );
        } elseif ( $expire <= 0 ) {
            wfDebug( "Parser output was marked as uncacheable and has not been saved.\n" );
        }
    }

    public function getCacheStorage() {
        return $this->cache;
    }
}