aa00a3e838
ResourceLoaderImageModule needs a set of SVG files and some data in the module definition, and produces styles for a set of CSS classes, one for each image, optionally with differently colored variants, generated in SVG and PNG, data-URI-embedded if possible, compatible with all browsers, and generally slick. The intended usage is to ship icon libraries with MediaWiki that can be used throughout the pages with no additional code. * ResourceLoaderImageModule implements all of the logic for data parsing and CSS generation. * ResourceLoaderImage implements the logic for SVG image colorization (for variants) and rasterization. * ResourceLoader and ResourceLoaderContext were extended to serve a new kind of load.php request that delivers a single image file. This is used for fallback PNG images served to browsers that don't understand SVG. See change Ic6a76bfb for a demo. Bug: T76473 Co-Authored-By: Trevor Parscal <trevorparscal@gmail.com> Co-Authored-By: Bartosz Dziewoński <matma.rex@gmail.com> Change-Id: Idf6ff4eb8e94f45946f15d283d34108b881fae6e
117 lines
3.4 KiB
PHP
117 lines
3.4 KiB
PHP
<?php
|
|
/**
|
|
* Resource loader 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
|
|
*/
|
|
|
|
/**
|
|
* Resource loader request result caching in the file system.
|
|
*
|
|
* @ingroup Cache
|
|
*/
|
|
class ResourceFileCache extends FileCacheBase {
|
|
protected $mCacheWorthy;
|
|
|
|
/* @todo configurable? */
|
|
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 ) {
|
|
global $wgUseFileCache, $wgDefaultSkin, $wgLanguageCode;
|
|
if ( !$wgUseFileCache ) {
|
|
return false;
|
|
}
|
|
// Get all query values
|
|
$queryVals = $context->getRequest()->getValues();
|
|
foreach ( $queryVals as $query => $val ) {
|
|
if ( in_array( $query, array( 'modules', 'image', 'variant', 'version', '*' ) ) ) {
|
|
// Use file cache regardless of the value of this parameter
|
|
continue; // note: &* added as IE fix
|
|
} elseif ( $query === 'skin' && $val === $wgDefaultSkin ) {
|
|
continue;
|
|
} elseif ( $query === 'lang' && $val === $wgLanguageCode ) {
|
|
continue;
|
|
} elseif ( $query === 'only' && in_array( $val, array( '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;
|
|
}
|
|
}
|