mirror of
https://github.com/friendica/friendica
synced 2024-05-12 08:29:39 +02:00
119 lines
4 KiB
PHP
119 lines
4 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (C) 2010-2023, the Friendica project
|
|
*
|
|
* @license GNU AGPL version 3 or any later version
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
namespace Friendica\Core\Cache\Factory;
|
|
|
|
use Friendica\Core\Cache\Enum;
|
|
use Friendica\Core\Cache\Capability\ICanCache;
|
|
use Friendica\Core\Cache\Exception\CachePersistenceException;
|
|
use Friendica\Core\Cache\Exception\InvalidCacheDriverException;
|
|
use Friendica\Core\Cache\Type;
|
|
use Friendica\Core\Config\Capability\IManageConfigValues;
|
|
use Friendica\Core\Hooks\Capabilities\ICanCreateInstances;
|
|
use Friendica\Util\Profiler;
|
|
|
|
/**
|
|
* Class CacheFactory
|
|
*
|
|
* @package Friendica\Core\Cache
|
|
*
|
|
* A basic class to generate a CacheDriver
|
|
*/
|
|
class Cache
|
|
{
|
|
/**
|
|
* @var string The default cache if nothing set
|
|
*/
|
|
const DEFAULT_TYPE = Enum\Type::DATABASE;
|
|
/** @var ICanCreateInstances */
|
|
protected $instanceCreator;
|
|
/** @var IManageConfigValues */
|
|
protected $config;
|
|
/** @var Profiler */
|
|
protected $profiler;
|
|
|
|
public function __construct(ICanCreateInstances $instanceCreator, IManageConfigValues $config, Profiler $profiler)
|
|
{
|
|
$this->config = $config;
|
|
$this->instanceCreator = $instanceCreator;
|
|
$this->profiler = $profiler;
|
|
}
|
|
|
|
/**
|
|
* This method creates a CacheDriver for distributed caching with the given cache driver name
|
|
*
|
|
* @param string|null $type The cache type to create (default is per config)
|
|
*
|
|
* @return ICanCache The instance of the CacheDriver
|
|
*
|
|
* @throws InvalidCacheDriverException In case the underlying cache driver isn't valid or not configured properly
|
|
* @throws CachePersistenceException In case the underlying cache has errors during persistence
|
|
*/
|
|
public function createDistributed(string $type = null): ICanCache
|
|
{
|
|
if ($type === Type\APCuCache::$NAME) {
|
|
throw new InvalidCacheDriverException('apcu doesn\'t support distributed caching.');
|
|
}
|
|
|
|
return $this->create($type ?? $this->config->get('system', 'distributed_cache_driver', self::DEFAULT_TYPE));
|
|
}
|
|
|
|
/**
|
|
* This method creates a CacheDriver for local caching with the given cache driver name
|
|
*
|
|
* @param string|null $type The cache type to create (default is per config)
|
|
*
|
|
* @return ICanCache The instance of the CacheDriver
|
|
*
|
|
* @throws InvalidCacheDriverException In case the underlying cache driver isn't valid or not configured properly
|
|
* @throws CachePersistenceException In case the underlying cache has errors during persistence
|
|
*/
|
|
public function createLocal(string $type = null): ICanCache
|
|
{
|
|
return $this->create($type ?? $this->config->get('system', 'cache_driver', self::DEFAULT_TYPE));
|
|
}
|
|
|
|
/**
|
|
* Creates a new Cache instance
|
|
*
|
|
* @param string $strategy The strategy, which cache instance should be used
|
|
*
|
|
* @return ICanCache
|
|
*
|
|
* @throws InvalidCacheDriverException In case the underlying cache driver isn't valid or not configured properly
|
|
* @throws CachePersistenceException In case the underlying cache has errors during persistence
|
|
*/
|
|
protected function create(string $strategy): ICanCache
|
|
{
|
|
/** @var ICanCache $cache */
|
|
$cache = $this->instanceCreator->create(ICanCache::class, $strategy);
|
|
|
|
$profiling = $this->config->get('system', 'profiling', false);
|
|
|
|
// In case profiling is enabled, wrap the ProfilerCache around the current cache
|
|
if (isset($profiling) && $profiling !== false) {
|
|
return new Type\ProfilerCacheDecorator($cache, $this->profiler);
|
|
} else {
|
|
return $cache;
|
|
}
|
|
}
|
|
}
|