ResourceFileCache.php

Go to the documentation of this file.

<?php
 
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\ResourceLoader as RL;
 
class ResourceFileCache extends FileCacheBase {
    protected $mCacheWorthy;
 
    /* @todo configurable? */
    private const MISS_THRESHOLD = 360; // 6/min * 60 min
 
    public static function newFromContext( RL\Context $context ) {
        $cache = new self();
 
        if ( $context->getImage() ) {
            $cache->mType = 'image';
        } elseif ( $context->getOnly() === 'styles' ) {
            $cache->mType = 'css';
        } else {
            $cache->mType = 'js';
        }
        $modules = array_unique( $context->getModules() ); // remove duplicates
        sort( $modules ); // normalize the order (permutation => combination)
        $cache->mKey = sha1( $context->getHash() . implode( '|', $modules ) );
        if ( count( $modules ) == 1 ) {
            $cache->mCacheWorthy = true; // won't take up much space
        }
 
        return $cache;
    }
 
    public static function useFileCache( RL\Context $context ) {
        $mainConfig = MediaWikiServices::getInstance()->getMainConfig();
        $useFileCache = $mainConfig->get( MainConfigNames::UseFileCache );
        $defaultSkin = $mainConfig->get( MainConfigNames::DefaultSkin );
        $languageCode = $mainConfig->get( MainConfigNames::LanguageCode );
        if ( !$useFileCache ) {
            return false;
        }
        // Get all query values
        $queryVals = $context->getRequest()->getValues();
        foreach ( $queryVals as $query => $val ) {
            if ( in_array( $query, [ 'modules', 'image', 'variant', 'version' ] ) ) {
                // Use file cache regardless of the value of this parameter
                continue;
            } elseif ( $query === 'skin' && $val === $defaultSkin ) {
                continue;
            } elseif ( $query === 'lang' && $val === $languageCode ) {
                continue;
            } elseif ( $query === 'only' && in_array( $val, [ 'styles', 'scripts' ] ) ) {
                continue;
            } elseif ( $query === 'debug' && $val === 'false' ) {
                continue;
            } elseif ( $query === 'format' && $val === 'rasterized' ) {
                continue;
            }
 
            return false;
        }
 
        return true; // cacheable
    }
 
    protected function cacheDirectory() {
        return $this->baseCacheDirectory() . '/resources';
    }
 
    public function isCacheWorthy() {
        if ( $this->mCacheWorthy === null ) {
            $this->mCacheWorthy = (
                $this->isCached() || // even stale cache indicates it was cache worthy
                $this->getMissesRecent() >= self::MISS_THRESHOLD // many misses
            );
        }
 
        return $this->mCacheWorthy;
    }
}