rss-bridge/lib/CacheFactory.php

<?php

declare(strict_types=1);

class CacheFactory
{
    private Logger $logger;

    public function __construct(
        Logger $logger
    ) {
        $this->logger = $logger;
    }

    public function create(string $name = null): CacheInterface
    {
        $name ??= Configuration::getConfig('cache', 'type');
        if (!$name) {
            throw new \Exception('No cache type configured');
        }
        $cacheNames = [];
        foreach (scandir(PATH_LIB_CACHES) as $file) {
            if (preg_match('/^([^.]+)Cache\.php$/U', $file, $m)) {
                $cacheNames[] = $m[1];
            }
        }
        // Trim trailing '.php' if exists
        if (preg_match('/(.+)(?:\.php)/', $name, $matches)) {
            $name = $matches[1];
        }
        // Trim trailing 'Cache' if exists
        if (preg_match('/(.+)(?:Cache)$/i', $name, $matches)) {
            $name = $matches[1];
        }

        $index = array_search(strtolower($name), array_map('strtolower', $cacheNames));
        if ($index === false) {
            throw new \InvalidArgumentException(sprintf('Invalid cache name: "%s"', $name));
        }
        $className = $cacheNames[$index] . 'Cache';
        if (!preg_match('/^[A-Z][a-zA-Z0-9-]*$/', $className)) {
            throw new \InvalidArgumentException(sprintf('Invalid cache classname: "%s"', $className));
        }

        switch ($className) {
            case NullCache::class:
                return new NullCache();
            case FileCache::class:
                $fileCacheConfig = [
                    // Intentionally checking for truthy value because the historic default value is the empty string
                    'path' => Configuration::getConfig('FileCache', 'path') ?: PATH_CACHE,
                    'enable_purge' => Configuration::getConfig('FileCache', 'enable_purge'),
                ];
                if (!is_dir($fileCacheConfig['path'])) {
                    throw new \Exception(sprintf('The FileCache path does not exists: %s', $fileCacheConfig['path']));
                }
                if (!is_writable($fileCacheConfig['path'])) {
                    throw new \Exception(sprintf('The FileCache path is not writable: %s', $fileCacheConfig['path']));
                }
                return new FileCache($this->logger, $fileCacheConfig);
            case SQLiteCache::class:
                if (!extension_loaded('sqlite3')) {
                    throw new \Exception('"sqlite3" extension not loaded. Please check "php.ini"');
                }
                if (!is_writable(PATH_CACHE)) {
                    throw new \Exception('The cache folder is not writable');
                }
                $file = Configuration::getConfig('SQLiteCache', 'file');
                if (!$file) {
                    throw new \Exception(sprintf('Configuration for %s missing.', 'SQLiteCache'));
                }
                if (dirname($file) == '.') {
                    $file = PATH_CACHE . $file;
                } elseif (!is_dir(dirname($file))) {
                    throw new \Exception(sprintf('Invalid configuration for %s', 'SQLiteCache'));
                }
                return new SQLiteCache($this->logger, [
                    'file'          => $file,
                    'timeout'       => Configuration::getConfig('SQLiteCache', 'timeout'),
                    'enable_purge'  => Configuration::getConfig('SQLiteCache', 'enable_purge'),
                ]);
            case MemcachedCache::class:
                if (!extension_loaded('memcached')) {
                    throw new \Exception('"memcached" extension not loaded. Please check "php.ini"');
                }
                $section = 'MemcachedCache';
                $host = Configuration::getConfig($section, 'host');
                $port = Configuration::getConfig($section, 'port');
                if (empty($host) && empty($port)) {
                    throw new \Exception('Configuration for ' . $section . ' missing.');
                }
                if (empty($host)) {
                    throw new \Exception('"host" param is not set for ' . $section);
                }
                if (empty($port)) {
                    throw new \Exception('"port" param is not set for ' . $section);
                }
                if (!ctype_digit($port)) {
                    throw new \Exception('"port" param is invalid for ' . $section);
                }
                $port = intval($port);
                if ($port < 1 || $port > 65535) {
                    throw new \Exception('"port" param is invalid for ' . $section);
                }
                return new MemcachedCache($this->logger, $host, $port);
            default:
                if (!file_exists(PATH_LIB_CACHES . $className . '.php')) {
                    throw new \Exception('Unable to find the cache file');
                }
                return new $className();
        }
    }
}