PhPsst\Storage\FileStorage

Complexity

Total Complexity

26

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

96.43%

Importance

Changes	6
Bugs	1	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	4
A	store()	0	8	3
C	get()	0	23	8
A	delete()	0	4	1
B	garbageCollection()	0	15	5
A	writeFile()	0	17	3
A	getFileName()	0	4	1
A	getFileNameFromKey()	0	4	1

<?php
/**
 * PhPsst.
 *
 * @copyright Copyright (c) 2016 Felix Sandström
 * @license   MIT
 */

namespace PhPsst\Storage;

use PhPsst\Password;
use PhPsst\PhPsstException;

/**
 */
class FileStorage implements StorageInterface
{
    /**
     * @var string
     */
    protected $dir;

    /**
     * @var int
     */
    protected $gcProbability;

    /**
     * @const string
     */
    const FILE_SUFFIX = '.phpsst';

    /**
     * FileStorage constructor.
     * @param string $dir
     * @param int $gcProbability
     */
    public function __construct($dir, $gcProbability)
    {
        $dir = rtrim($dir, '/') . '/';
        if (empty($dir) || !is_dir($dir)) {
            throw new \RuntimeException('Invalid directory path');
        }

        if ($gcProbability < 0) {
            throw new \LogicException('Invalid value for gcProbability');
        }

        $this->dir = $dir;
        $this->gcProbability = $gcProbability;
    }

    /**
     * @param Password $password
     * @param bool $allowOverwrite
     */
    public function store(Password $password, $allowOverwrite = false)
    {
        if (!$allowOverwrite && file_exists($this->getFileName($password))) {
            throw new PhPsstException('The ID already exists', PhPsstException::ID_IS_ALREADY_TAKEN);
        }

        $this->writeFile($password);
    }

    /**
     * @param $key
     * @return Password|null
     */
    public function get($key)
    {
        $password = null;
        if (!file_exists($this->getFileNameFromKey($key))) {
            throw new PhPsstException('No such ID exists', PhPsstException::NO_PASSWORD_WITH_ID_FOUND);
        }

        if (($jsonData = json_decode(file_get_contents($this->getFileNameFromKey($key))))) {
            if (!empty($jsonData->id)
                && !empty($jsonData->password)
                && !empty($jsonData->ttl)
                && !empty($jsonData->views)
            ) {
                $password = new Password($jsonData->id, $jsonData->password, $jsonData->ttl, $jsonData->views);
                if ($jsonData->ttlTime < time()) {
                    $this->delete($password);
                    throw new PhPsstException('No such ID exists', PhPsstException::NO_PASSWORD_WITH_ID_FOUND);
                }
            }
        }

        return $password;
    }

    /**
     * @param Password $password
     */
    public function delete(Password $password)
    {
        unlink($this->getFileName($password));
    }

    /**
     */
    protected function garbageCollection()
    {
        if (rand(1, $this->gcProbability) !== 1) {
            return;
        }

        $files = array_diff(scandir($this->dir), array('.', '..'));
        foreach ($files as $file) {
            if (($jsonData = json_decode(file_get_contents($this->dir . $file)))) {
                if ($jsonData->ttlTime < time()) {
                    unlink($this->dir . $file);
                }
            }
        }
    }

    /**
     * @param Password $password
     */
    protected function writeFile(Password $password)
    {
        $jsonData = json_encode([
            'id' => $password->getId(),
            'password' => $password->getPassword(),
            'ttl' => $password->getTtl(),
            'ttlTime' => time() + $password->getTtl(),
            'views' => $password->getViews(),
        ]);

        $fileName = $this->getFileName($password);
        if (!is_writable(dirname($fileName)) || !file_put_contents($fileName, $jsonData)) {
            throw new \RuntimeException('Can not write file');
        }

        $this->garbageCollection();
    }

    /**
     * @param Password $password
     * @return string
     */
    protected function getFileName(Password $password)
    {
        return $this->getFileNameFromKey($password->getId());
    }

    /**
     * @param string $key
     * @return string
     */
    protected function getFileNameFromKey($key)
    {
        return $this->dir . $key . self::FILE_SUFFIX;
    }
}