Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
<?php
>
/** * SCSSPHP *
< * @copyright 2012-2019 Leaf Corcoran
> * @copyright 2012-2020 Leaf Corcoran
* * @license http://opensource.org/licenses/MIT MIT * * @link http://scssphp.github.io/scssphp */ namespace ScssPhp\ScssPhp; use Exception;
> use ScssPhp\ScssPhp\Version;
/** * The scss cache manager. * * In short: * * allow to put in cache/get from cache a generic result from a known operation on a generic dataset, * taking in account options that affects the result * * The cache manager is agnostic about data format and only the operation is expected to be described by string
< *
*/ /** * SCSS cache *
< * @author Cedric Morin
> * @author Cedric Morin <cedric@yterium.com>
*/ class Cache { const CACHE_VERSION = 1; // directory used for storing data public static $cacheDir = false; // prefix for the storing data public static $prefix = 'scssphp_'; // force a refresh : 'once' for refreshing the first hit on a cache only, true to never use the cache in this hit public static $forceRefresh = false; // specifies the number of seconds after which data cached will be seen as 'garbage' and potentially cleaned up public static $gcLifetime = 604800; // array of already refreshed cache if $forceRefresh==='once' protected static $refreshed = []; /** * Constructor * * @param array $options */ public function __construct($options) { // check $cacheDir if (isset($options['cacheDir'])) { self::$cacheDir = $options['cacheDir']; } if (empty(self::$cacheDir)) { throw new Exception('cacheDir not set'); } if (isset($options['prefix'])) { self::$prefix = $options['prefix']; } if (empty(self::$prefix)) { throw new Exception('prefix not set'); } if (isset($options['forceRefresh'])) { self::$forceRefresh = $options['forceRefresh']; } self::checkCacheDir(); } /** * Get the cached result of $operation on $what, * which is known as dependant from the content of $options * * @param string $operation parse, compile... * @param mixed $what content key (e.g., filename to be treated) * @param array $options any option that affect the operation result on the content * @param integer $lastModified last modified timestamp * * @return mixed * * @throws \Exception */ public function getCache($operation, $what, $options = [], $lastModified = null) { $fileCache = self::$cacheDir . self::cacheName($operation, $what, $options);
< if (((self::$forceRefresh === false) || (self::$forceRefresh === 'once' &&
> if ( > ((self::$forceRefresh === false) || (self::$forceRefresh === 'once' &&
isset(self::$refreshed[$fileCache]))) && file_exists($fileCache) ) { $cacheTime = filemtime($fileCache);
< if ((is_null($lastModified) || $cacheTime > $lastModified) &&
> if ( > (\is_null($lastModified) || $cacheTime > $lastModified) &&
$cacheTime + self::$gcLifetime > time() ) { $c = file_get_contents($fileCache); $c = unserialize($c);
< if (is_array($c) && isset($c['value'])) {
> if (\is_array($c) && isset($c['value'])) {
return $c['value']; } } } return null; } /** * Put in cache the result of $operation on $what, * which is known as dependant from the content of $options * * @param string $operation * @param mixed $what * @param mixed $value * @param array $options */ public function setCache($operation, $what, $value, $options = []) { $fileCache = self::$cacheDir . self::cacheName($operation, $what, $options); $c = ['value' => $value]; $c = serialize($c);
>
file_put_contents($fileCache, $c); if (self::$forceRefresh === 'once') { self::$refreshed[$fileCache] = true; } } /** * Get the cache name for the caching of $operation on $what, * which is known as dependant from the content of $options * * @param string $operation * @param mixed $what * @param array $options * * @return string */ private static function cacheName($operation, $what, $options = []) { $t = [ 'version' => self::CACHE_VERSION,
> 'scssphpVersion' => Version::VERSION,
'operation' => $operation, 'what' => $what, 'options' => $options ]; $t = self::$prefix . sha1(json_encode($t)) . ".$operation" . ".scsscache"; return $t; } /** * Check that the cache dir exists and is writeable * * @throws \Exception */ public static function checkCacheDir() { self::$cacheDir = str_replace('\\', '/', self::$cacheDir); self::$cacheDir = rtrim(self::$cacheDir, '/') . '/'; if (! is_dir(self::$cacheDir)) {
< if (! mkdir(self::$cacheDir)) { < throw new Exception('Cache directory couldn\'t be created: ' . self::$cacheDir); < }
> throw new Exception('Cache directory doesn\'t exist: ' . self::$cacheDir);
} if (! is_writable(self::$cacheDir)) { throw new Exception('Cache directory isn\'t writable: ' . self::$cacheDir); } } /** * Delete unused cached files */ public static function cleanCache() { static $clean = false; if ($clean || empty(self::$cacheDir)) { return; } $clean = true; // only remove files with extensions created by SCSSPHP Cache // css files removed based on the list files $removeTypes = ['scsscache' => 1]; $files = scandir(self::$cacheDir); if (! $files) { return; } $checkTime = time() - self::$gcLifetime; foreach ($files as $file) { // don't delete if the file wasn't created with SCSSPHP Cache if (strpos($file, self::$prefix) !== 0) { continue; } $parts = explode('.', $file); $type = array_pop($parts); if (! isset($removeTypes[$type])) { continue; } $fullPath = self::$cacheDir . $file; $mtime = filemtime($fullPath); // don't delete if it's a relatively new file if ($mtime > $checkTime) { continue; } unlink($fullPath); } } }