ResourceFileCache.php

Go to the documentation of this file.

<?php
class ResourceFileCache extends FileCacheBase {
        protected $mCacheWorthy;

        /* @TODO: configurable? */
        const MISS_THRESHOLD = 360; // 6/min * 60 min

        public static function newFromContext( ResourceLoaderContext $context ) {
                $cache = new self();

                if ( $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( ResourceLoaderContext $context ) {
                global $wgUseFileCache, $wgDefaultSkin, $wgLanguageCode;
                if ( !$wgUseFileCache ) {
                        return false;
                }
                // Get all query values
                $queryVals = $context->getRequest()->getValues();
                foreach ( $queryVals as $query => $val ) {
                        if ( $query === 'modules' || $query === 'version' || $query === '*' ) {
                                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;
                        }
                        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;
        }
}