SimpleCache.php

Go to the documentation of this file.

<?php

namespace Elgg\Cache;

use Elgg\Config;
use Elgg\Project\Paths;
use Elgg\ViewsService;

class SimpleCache {

    protected $config;

    protected $views;

    public function __construct(
        Config $config,
        ViewsService $views
    ) {
        $this->config = $config;
        $this->views = $views;
    }

    public function getUrl(string $view, string $subview = ''): string {
        // handle `getUrl('js', 'js/blog/save_draft')`
        if (($view === 'js' || $view === 'css') && str_starts_with($subview, $view . '/')) {
            $view = $subview;
            $subview = '';
        }

        // handle `getUrl('js', 'blog/save_draft')`
        if (!empty($subview)) {
            $view = "{$view}/{$subview}";
        }

        $view = ViewsService::canonicalizeViewName($view);

        // should be normalized to canonical form by now: `getUrl('blog/save_draft.js')`
        $this->views->registerCacheableView($view);

        return $this->getRoot() . $view;
    }

    public function getRoot() {
        $viewtype = $this->views->getViewtype();
        if ($this->isEnabled()) {
            $lastcache = (int) $this->config->lastcache;
        } else {
            $lastcache = 0;
        }

        return elgg_normalize_url("/cache/{$lastcache}/{$viewtype}/");
    }

    public function isEnabled() {
        return (bool) $this->config->simplecache_enabled;
    }

    public function enable() {
        $this->config->save('simplecache_enabled', 1);
    }

    public function disable() {
        if (!$this->isEnabled()) {
            return;
        }
        
        $this->config->save('simplecache_enabled', 0);
    }

    protected function getPath() {
        return (string) $this->config->assetroot;
    }
    
    public function clear() {
        elgg_delete_directory($this->getPath(), true);
        
        return true;
    }
    
    public function purge() {
        $lastcache = (int) $this->config->lastcache;
        
        if (!is_dir($this->getPath())) {
            return;
        }
        
        $di = new \DirectoryIterator($this->getPath());
        
        /* @var $file_info \DirectoryIterator */
        foreach ($di as $file_info) {
            if (!$file_info->isDir() || $file_info->isDot()) {
                continue;
            }
            
            if ((int) $file_info->getBasename() === $lastcache) {
                continue;
            }
            
            elgg_delete_directory($file_info->getPathname());
        }
    }
    
    public function cachedAssetExists(int $cache_time, string $viewtype, string $view): bool {
        $filename = $this->getCacheFilename($viewtype, $view, $cache_time);
        
        return file_exists($filename);
    }
    
    public function getCachedAssetLocation(int $cache_time, string $viewtype, string $view): ?string {
        if (!$this->cachedAssetExists($cache_time, $viewtype, $view)) {
            return null;
        }
        
        return $this->getCacheFilename($viewtype, $view, $cache_time);
    }
    
    public function cacheAsset(string $viewtype, string $view, string $contents): int {
        $filename = $this->getCacheFilename($viewtype, $view);
        $dir = dirname($filename);
        
        if (!is_dir($dir)) {
            // PHP and the server accessing the cache symlink may be a different user. And here
            // it's safe to make everything readable anyway.
            mkdir($dir, 0775, true);
        }
        
        $result = file_put_contents($filename, $contents);
        chmod($filename, 0664);
        
        return $result;
    }
    
    protected function getCacheFilename(string $viewtype, string $view, int $cache_time = null): string {
        if (!isset($cache_time)) {
            $cache_time = $this->config->lastcache;
        }
        
        $filename = $this->getPath() . "{$cache_time}/{$viewtype}/{$view}";
        return Paths::sanitize($filename, false);
    }
}