ElggFileCache.php

Go to the documentation of this file.

<?php
class ElggFileCache extends \ElggCache {
    public function __construct($cache_path, $max_age = 0, $max_size = 0) {
        $this->setVariable("cache_path", $cache_path);
        $this->setVariable("max_age", $max_age);
        $this->setVariable("max_size", $max_size);

        if ($cache_path == "") {
            throw new \ConfigurationException("Cache path set to nothing!");
        }
    }

    // @codingStandardsIgnoreStart
    protected function create_file($filename, $rw = "rb") {
        elgg_deprecated_notice('\ElggFileCache::create_file() is deprecated by ::createFile()', 1.8);

        return $this->createFile($filename, $rw);
    }
    // @codingStandardsIgnoreEnd

    protected function createFile($filename, $rw = "rb") {
        // Create a filename matrix
        $matrix = "";
        $depth = strlen($filename);
        if ($depth > 5) {
            $depth = 5;
        }

        // Create full path
        $path = $this->getVariable("cache_path") . $matrix;
        if (!is_dir($path)) {
            mkdir($path, 0700, true);
        }

        // Open the file
        if ((!file_exists($path . $filename)) && ($rw == "rb")) {
            return false;
        }

        return fopen($path . $filename, $rw);
    }

    // @codingStandardsIgnoreStart
    protected function sanitise_filename($filename) {
        // @todo : Writeme

        return $filename;
    }
    // @codingStandardsIgnoreEnd

    protected function sanitizeFilename($filename) {
        // @todo : Writeme

        return $filename;
    }

    public function save($key, $data) {
        $f = $this->createFile($this->sanitizeFilename($key), "wb");
        if ($f) {
            $result = fwrite($f, $data);
            fclose($f);

            return $result;
        }

        return false;
    }

    public function load($key, $offset = 0, $limit = null) {
        $f = $this->createFile($this->sanitizeFilename($key));
        if ($f) {
            if (!$limit) {
                $limit = -1;
            }

            $data = stream_get_contents($f, $limit, $offset);

            fclose($f);

            return $data;
        }

        return false;
    }

    public function delete($key) {
        $dir = $this->getVariable("cache_path");

        if (file_exists($dir . $key)) {
            return unlink($dir . $key);
        }
        return true;
    }

    public function clear() {
        $dir = $this->getVariable("cache_path");

        $exclude = array(".", "..");

        $files = scandir($dir);
        if (!$files) {
            return;
        }

        foreach ($files as $f) {
            if (!in_array($f, $exclude)) {
                unlink($dir . $f);
            }
        }
    }

    public function __destruct() {
        // @todo Check size and age, clean up accordingly
        $size = 0;
        $dir = $this->getVariable("cache_path");

        // Short circuit if both size and age are unlimited
        if (($this->getVariable("max_age") == 0) && ($this->getVariable("max_size") == 0)) {
            return;
        }

        $exclude = array(".", "..");

        $files = scandir($dir);
        if (!$files) {
            throw new \IOException($dir . " is not a directory.");
        }

        // Perform cleanup
        foreach ($files as $f) {
            if (!in_array($f, $exclude)) {
                $stat = stat($dir . $f);

                // Add size
                $size .= $stat['size'];

                // Is this older than my maximum date?
                if (($this->getVariable("max_age") > 0) && (time() - $stat['mtime'] > $this->getVariable("max_age"))) {
                    unlink($dir . $f);
                }

                // @todo Size
            }
        }
    }
}