MediaWiki REL1_27
ResourceFileCache.php
Go to the documentation of this file.
1<?php
30 protected $mCacheWorthy;
31
32 /* @todo configurable? */
33 const MISS_THRESHOLD = 360; // 6/min * 60 min
34
40 public static function newFromContext( ResourceLoaderContext $context ) {
41 $cache = new self();
42
43 if ( $context->getImage() ) {
44 $cache->mType = 'image';
45 } elseif ( $context->getOnly() === 'styles' ) {
46 $cache->mType = 'css';
47 } else {
48 $cache->mType = 'js';
49 }
50 $modules = array_unique( $context->getModules() ); // remove duplicates
51 sort( $modules ); // normalize the order (permutation => combination)
52 $cache->mKey = sha1( $context->getHash() . implode( '|', $modules ) );
53 if ( count( $modules ) == 1 ) {
54 $cache->mCacheWorthy = true; // won't take up much space
55 }
56
57 return $cache;
58 }
59
66 public static function useFileCache( ResourceLoaderContext $context ) {
68 if ( !$wgUseFileCache ) {
69 return false;
70 }
71 // Get all query values
72 $queryVals = $context->getRequest()->getValues();
73 foreach ( $queryVals as $query => $val ) {
74 if ( in_array( $query, [ 'modules', 'image', 'variant', 'version', '*' ] ) ) {
75 // Use file cache regardless of the value of this parameter
76 continue; // note: &* added as IE fix
77 } elseif ( $query === 'skin' && $val === $wgDefaultSkin ) {
78 continue;
79 } elseif ( $query === 'lang' && $val === $wgLanguageCode ) {
80 continue;
81 } elseif ( $query === 'only' && in_array( $val, [ 'styles', 'scripts' ] ) ) {
82 continue;
83 } elseif ( $query === 'debug' && $val === 'false' ) {
84 continue;
85 } elseif ( $query === 'format' && $val === 'rasterized' ) {
86 continue;
87 }
88
89 return false;
90 }
91
92 return true; // cacheable
93 }
94
99 protected function cacheDirectory() {
100 return $this->baseCacheDirectory() . '/resources';
101 }
102
107 public function isCacheWorthy() {
108 if ( $this->mCacheWorthy === null ) {
109 $this->mCacheWorthy = (
110 $this->isCached() || // even stale cache indicates it was cache worthy
111 $this->getMissesRecent() >= self::MISS_THRESHOLD // many misses
112 );
113 }
114
115 return $this->mCacheWorthy;
116 }
117}
$wgLanguageCode
Site language code.
$wgDefaultSkin
Default skin, for new users and anonymous visitors.
$wgUseFileCache
This will cache static pages for non-logged-in users to reduce database traffic on public sites.
Base class for data storage in the file system.
getMissesRecent()
Roughly gets the cache misses in the last hour by unique visitors.
baseCacheDirectory()
Get the base file cache directory.
isCached()
Check if the cache file exists.
ResourceLoader request result caching in the file system.
cacheDirectory()
Get the base file cache directory.
static useFileCache(ResourceLoaderContext $context)
Check if an RL request can be cached.
isCacheWorthy()
Item has many recent cache misses.
static newFromContext(ResourceLoaderContext $context)
Construct an ResourceFileCache from a context.
Object passed around to modules which contains information about the state of a specific loader reque...
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1458
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
$context
Definition load.php:44
$cache
Definition mcc.php:33