151 lines
4.1 KiB
PHP

<?php
/**
*
* This file is part of phpFastCache.
*
* @license MIT License (MIT)
*
* For full copyright and license information, please see the docs/CREDITS.txt file.
*
* @author Khoa Bui (khoaofgod) <khoaofgod@gmail.com> https://www.phpfastcache.com
* @author Georges.L (Geolim4) <contact@geolim4.com>
*
*/
declare(strict_types=1);
namespace Phpfastcache\Drivers\Files;
use Exception;
use FilesystemIterator;
use Phpfastcache\Cluster\AggregatablePoolInterface;
use Phpfastcache\Core\Pool\{DriverBaseTrait, ExtendedCacheItemPoolInterface, IO\IOHelperTrait};
use Phpfastcache\Exceptions\{PhpfastcacheInvalidArgumentException, PhpfastcacheIOException};
use Phpfastcache\Util\Directory;
use Psr\Cache\CacheItemInterface;
/**
* Class Driver
* @package phpFastCache\Drivers
* @property Config $config Config object
* @method Config getConfig() Return the config object
*
* Important NOTE:
* We are using getKey instead of getEncodedKey since this backend create filename that are
* managed by defaultFileNameHashFunction and not defaultKeyHashFunction
*/
class Driver implements ExtendedCacheItemPoolInterface, AggregatablePoolInterface
{
use IOHelperTrait;
use DriverBaseTrait {
DriverBaseTrait::__construct as private __parentConstruct;
}
/**
* Driver constructor.
* @param Config $config
* @param string $instanceId
*/
public function __construct(Config $config, string $instanceId)
{
$this->__parentConstruct($config, $instanceId);
}
/**
* @return bool
*/
public function driverCheck(): bool
{
return is_writable($this->getPath()) || mkdir($concurrentDirectory = $this->getPath(), $this->getDefaultChmod(), true) || is_dir($concurrentDirectory);
}
/**
* @return bool
*/
protected function driverConnect(): bool
{
return true;
}
/**
* @param CacheItemInterface $item
* @return null|array
*/
protected function driverRead(CacheItemInterface $item)
{
$file_path = $this->getFilePath($item->getKey(), true);
try{
$content = $this->readFile($file_path);
}catch (PhpfastcacheIOException $e){
return null;
}
return $this->decode($content);
}
/**
* @param CacheItemInterface $item
* @return bool
* @throws PhpfastcacheInvalidArgumentException
*/
protected function driverWrite(CacheItemInterface $item): bool
{
/**
* Check for Cross-Driver type confusion
*/
if ($item instanceof Item) {
$file_path = $this->getFilePath($item->getKey());
$data = $this->encode($this->driverPreWrap($item));
/**
* Force write
*/
try {
return $this->writefile($file_path, $data, $this->getConfig()->isSecureFileManipulation());
} catch (Exception $e) {
return false;
}
}
throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
}
/**
* @param CacheItemInterface $item
* @return bool
* @throws PhpfastcacheInvalidArgumentException
*/
protected function driverDelete(CacheItemInterface $item): bool
{
/**
* Check for Cross-Driver type confusion
*/
if ($item instanceof Item) {
$file_path = $this->getFilePath($item->getKey(), true);
if (\file_exists($file_path) && @\unlink($file_path)) {
\clearstatcache(true, $file_path);
$dir = \dirname($file_path);
if (!(new FilesystemIterator($dir))->valid()) {
\rmdir($dir);
}
return true;
}
return false;
}
throw new PhpfastcacheInvalidArgumentException('Cross-Driver type confusion detected');
}
/**
* @return bool
* @throws \Phpfastcache\Exceptions\PhpfastcacheIOException
*/
protected function driverClear(): bool
{
return Directory::rrmdir($this->getPath(true));
}
}