Comodojo\Cache\Drivers\FilesystemXattr

Complexity

Total Complexity

30

Size/Duplication

Total Lines	204
Duplicated Lines	18.63 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

45.45%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	test()	0	5	2
A	get()	0	17	3
B	set()	5	21	5
A	delete()	0	15	2
A	getMultiple()	11	11	2
A	setMultiple()	11	11	2
A	deleteMultiple()	11	11	2
B	has()	0	24	5
A	stats()	0	5	1
A	clear()	0	21	4

<?php namespace Comodojo\Cache\Drivers;

use \Exception;

/**
 * @package     Comodojo Cache
 * @author      Marco Giovinazzi <marco.giovinazzi@comodojo.org>
 * @license     MIT
 *
 * LICENSE:
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

class FilesystemXattr extends AbstractDriver {

    const DRIVER_NAME = "filesystem-xattr";

    /**
     * Cache (files) repository
     *
     * @param string
     */
    protected $cache_folder;

    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration) {

        $this->cache_folder = $configuration['cache-folder'];

        if ( $this->test() === false ) throw new Exception("Folder ".$this->cache_folder." not writable");

    }

    /**
     * {@inheritdoc}
     */
    public function test() {

        return file_exists($this->cache_folder) && is_writable($this->cache_folder);

    }

    /**
     * {@inheritdoc}
     */
    public function get($key, $namespace) {

        if ( $this->has($key, $namespace) ) {

$key is of type string, but the function expects a array.

            $cacheFile = $this->cache_folder."$key-$namespace.cache";

            $data = @file_get_contents($cacheFile);

            if ( $data === false ) throw new Exception("Error reading cache content $cacheFile");

            return $data;

        }

        return null;

    }

    /**
     * {@inheritdoc}
     */
    public function set($key, $namespace, $value, $ttl = null) {

        $cacheFile = $this->cache_folder."$key-$namespace.cache";

        if ( $ttl == null || $ttl == 0 ) {

It seems like you are loosely comparing $ttl of type integer|null against null; this is ambiguous if the integer can be zero. Consider using a strict comparison === instead.

This code seems to be duplicated across your project.

            $ttl = 0;
        } else {
            $ttl = time() + intval($ttl);
        }

        $cached = @file_put_contents($cacheFile, $value, LOCK_EX);

        if ( $cached === false ) throw new Exception("Error writing cache object $cacheFile");

        $tagged = @xattr_set($cacheFile, "EXPIRE", $ttl, XATTR_DONTFOLLOW);

        if ( $tagged === false ) throw new Exception("Error writing cache ttl $cacheFile");

        return true;

    }

    /**
     * {@inheritdoc}
     */
    public function delete($key, $namespace) {

        $cacheFile = $this->cache_folder."$key-$namespace.cache";

        if ( file_exists($cacheFile) ) {

            $u = unlink($cacheFile);

            return $u;

        }

        return false;

    }

    /**
     * {@inheritdoc}
     */
    public function clear($namespace = null) {

        $result = [];

        if ( $namespace === null ) {

            $file_list = glob($this->cache_folder."*.cache");

        } else {

            $file_list = glob($this->cache_folder."*-$namespace.cache");

        }

        if ( empty($file_list) ) return true;

        foreach ( $file_list as $file ) $result[] = unlink($file);

        return !in_array(false, $result);

    }

    /**
     * {@inheritdoc}
     */
    public function getMultiple(array $keys, $namespace) {

This method seems to be duplicated in your project.

        $result = [];

        foreach ( $keys as $key ) {
            $result[$key] = $this->get($key, $namespace);
        }

        return $result;

    }

    /**
     * {@inheritdoc}
     */
    public function setMultiple(array $key_values, $namespace, $ttl = null) {

This method seems to be duplicated in your project.

        $result = [];

        foreach ( $key_values as $key => $value ) {
            $result[] = $this->set($key, $namespace, $value, $ttl);
        }

        return !in_array(false, $result);

    }

    /**
     * {@inheritdoc}
     */
    public function deleteMultiple(array $keys, $namespace) {

This method seems to be duplicated in your project.

        $result = [];

        foreach ( $keys as $key ) {
            $result[] = $this->delete($key, $namespace);
        }

        return !in_array(false, $result);

    }

    /**
     * {@inheritdoc}
     */
    public function has($key, $namespace) {

        $time = time();

        $cacheFile = $this->cache_folder."$key-$namespace.cache";

        if ( file_exists($cacheFile) ) {

            $expire = xattr_get($cacheFile, "EXPIRE", XATTR_DONTFOLLOW);

            if ( $expire === false ) {
                throw new Exception("Error reading cache ttl for $cacheFile");
            } else if ( $expire < $time && $expire != 0 ) {
                $this->delete($key, $namespace);

$key is of type array, but the function expects a string.

                return false;
            } else {
                return true;
            }

        }

        return false;

    }

    /**
     * {@inheritdoc}
     */
    public function stats() {

        return ['objects' => count(glob($this->cache_folder."*.cache"))];

    }

}