voku\cache\AdapterFileAbstract

Complexity

Total Complexity

34

Size/Duplication

Total Lines	232
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	3
C	createCacheDirectory()	0	46	13
A	deleteFile()	0	8	2
A	exists()	0	6	1
	get()	0	1	?
A	installed()	0	4	1
A	remove()	0	6	1
A	removeAll()	0	15	4
A	set()	0	4	1
	setExpired()	0	1	?
A	getFileName()	0	4	1
A	setFileMode()	0	4	1
A	ttlHasExpired()	0	8	2
A	validateDataFromCache()	0	14	4

<?php

declare(strict_types=1);

namespace voku\cache;

/**
 * AdapterFileSimple: File-adapter (simple)
 */
abstract class AdapterFileAbstract implements iAdapter
{
  const CACHE_FILE_PREFIX = '__';
  const CACHE_FILE_SUBFIX = '.php.cache';

  /**
   * @var bool
   */
  public $installed = false;

  /**
   * @var string
   */
  protected $cacheDir;

  /**
   * @var iSerializer
   */
  protected $serializer;

  /**
   * @var string
   */
  protected $fileMode = '0755';

  /**
   * @param string|null $cacheDir
   */
  public function __construct($cacheDir = null)
  {
    $this->serializer = new SerializerIgbinary();

    if (!$cacheDir) {

The expression $cacheDir of type string|null is loosely compared to false; this is ambiguous if the string can be empty. You might want to explicitly use === null instead.

      $cacheDir = \realpath(\sys_get_temp_dir()) . '/simple_php_cache';
    }

    $this->cacheDir = (string)$cacheDir;

    if ($this->createCacheDirectory($cacheDir) === true) {
      $this->installed = true;
    }
  }

  /**
   * Recursively creates & chmod directories.
   *
   * @param string $path
   *
   * @return bool
   */
  protected function createCacheDirectory($path): bool
  {
    if (
        !$path
        ||
        $path === '/'
        ||
        $path === '.'
        ||
        $path === '\\'
    ) {
      return false;
    }

    // if the directory already exists, just return true
    if (\is_dir($path) && \is_writable($path)) {
      return true;
    }

    // if more than one level, try parent first
    if (\dirname($path) !== '.') {
      $return = $this->createCacheDirectory(\dirname($path));
      // if creating parent fails, we can abort immediately
      if (!$return) {
        return false;
      }
    }

    $mode_dec = \intval($this->fileMode, 8);
    $old_umask = \umask(0);

    /** @noinspection PhpUsageOfSilenceOperatorInspection */
    if (!@\mkdir($path, $mode_dec) && !\is_dir($path)) {
      $return = false;
    } else {
      $return = true;
    }

    if (\is_dir($path) && !\is_writable($path)) {
      $return = \chmod($path, $mode_dec);
    }

    \umask($old_umask);

    return $return;
  }

  /**
   * @param $cacheFile
   *
   * @return bool
   */
  protected function deleteFile($cacheFile): bool
  {
    if (\is_file($cacheFile)) {
      return \unlink($cacheFile);
    }

    return false;
  }

  /**
   * @inheritdoc
   */
  public function exists(string $key): bool
  {
    $value = $this->get($key);

    return null !== $value;
  }

  /**
   * @inheritdoc
   */
  abstract public function get(string $key);

  /**
   * @inheritdoc
   */
  public function installed(): bool
  {
    return $this->installed;
  }

  /**
   * @inheritdoc
   */
  public function remove(string $key): bool
  {
    $cacheFile = $this->getFileName($key);

    return $this->deleteFile($cacheFile);
  }

  /**
   * @inheritdoc
   */
  public function removeAll(): bool
  {
    if (!$this->cacheDir) {
      return false;
    }

    $return = [];
    foreach (new \DirectoryIterator($this->cacheDir) as $fileInfo) {
      if (!$fileInfo->isDot()) {
        $return[] = \unlink($fileInfo->getPathname());
      }
    }

    return \in_array(false, $return, true) === false;
  }

  /**
   * @inheritdoc
   */
  public function set(string $key, $value): bool
  {
    return $this->setExpired($key, $value);
  }

  /**
   * @inheritdoc
   */
  abstract public function setExpired(string $key, $value, int $ttl = 0): bool;

  /**
   * @param string $key
   *
   * @return string
   */
  protected function getFileName(string $key): string
  {
    return $this->cacheDir . DIRECTORY_SEPARATOR . self::CACHE_FILE_PREFIX . $key . self::CACHE_FILE_SUBFIX;
  }

  /**
   * Set the file-mode for new cache-files.
   *
   * e.g. '0777', or '0755' ...
   *
   * @param $fileMode
   */
  public function setFileMode($fileMode)
  {
    $this->fileMode = $fileMode;
  }

  /**
   * @param $ttl
   *
   * @return bool
   */
  protected function ttlHasExpired(int $ttl): bool
  {
    if ($ttl === 0) {
      return false;
    }

    return (\time() > $ttl);
  }

  /**
   * @param mixed $data
   *
   * @return bool
   */
  protected function validateDataFromCache($data): bool
  {
    if (!\is_array($data)) {
      return false;
    }

    foreach (['value', 'ttl'] as $missing) {
      if (!\array_key_exists($missing, $data)) {
        return false;
      }
    }

    return true;
  }
}