a241d83e0a
This reverts commit e08ea8ccb9.
Reason for revert: Breaks Phan in extensions, and as far as I’m aware,
this change isn’t urgently needed for anything, so the simplest fix is
to revert it again for now. After PHP 7.4 it should be safer to try this
again (we hopefully won’t need the two “hack” classes by then).
Bug: T308443
Change-Id: Iff3318cbf97a67f821f78e60da62a583f63e389e
124 lines
3.7 KiB
PHP
124 lines
3.7 KiB
PHP
<?php
|
|
|
|
/**
|
|
* ResourceLoader request result caching in the file system.
|
|
*
|
|
* 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
|
|
* @ingroup Cache
|
|
*/
|
|
|
|
use MediaWiki\MainConfigNames;
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
/**
|
|
* ResourceLoader request result caching in the file system.
|
|
*
|
|
* @ingroup Cache
|
|
*/
|
|
class ResourceFileCache extends FileCacheBase {
|
|
protected $mCacheWorthy;
|
|
|
|
/* @todo configurable? */
|
|
private const MISS_THRESHOLD = 360; // 6/min * 60 min
|
|
|
|
/**
|
|
* Construct an ResourceFileCache from a context
|
|
* @param ResourceLoaderContext $context
|
|
* @return ResourceFileCache
|
|
*/
|
|
public static function newFromContext( ResourceLoaderContext $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;
|
|
}
|
|
|
|
/**
|
|
* Check if an RL request can be cached.
|
|
* Caller is responsible for checking if any modules are private.
|
|
* @param ResourceLoaderContext $context
|
|
* @return bool
|
|
*/
|
|
public static function useFileCache( ResourceLoaderContext $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
|
|
}
|
|
|
|
/**
|
|
* Get the base file cache directory
|
|
* @return string
|
|
*/
|
|
protected function cacheDirectory() {
|
|
return $this->baseCacheDirectory() . '/resources';
|
|
}
|
|
|
|
/**
|
|
* Item has many recent cache misses
|
|
* @return bool
|
|
*/
|
|
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;
|
|
}
|
|
}
|