From b21631747714ac2282abfc6d6ac573a3347df11b Mon Sep 17 00:00:00 2001 From: Philipp Date: Tue, 26 Oct 2021 21:44:29 +0200 Subject: [PATCH] Refactoring Core class structures ... --- doc/AddonStorageBackend.md | 8 +- index.php | 2 +- src/App.php | 48 +++---- src/App/BaseURL.php | 10 +- src/App/Mode.php | 2 +- src/App/Module.php | 8 +- src/App/Page.php | 32 ++--- src/App/Router.php | 12 +- src/Console/AutomaticInstallation.php | 14 +- src/Console/Cache.php | 6 +- src/Console/Config.php | 6 +- src/Console/DatabaseStructure.php | 2 +- src/Console/Lock.php | 6 +- src/Console/Maintenance.php | 6 +- src/Console/PostUpdate.php | 6 +- src/Console/ServerBlock.php | 26 ++-- src/Console/Typo.php | 6 +- src/Console/User.php | 6 +- src/Content/Conversation.php | 12 +- .../{ICache.php => Capability/ICanCache.php} | 40 +++--- .../ICanCacheInMemory.php} | 37 +++-- .../Exception/CachePersistenceException.php | 13 ++ .../Exception/InvalidCacheDriverException.php | 13 ++ .../Factory/{CacheFactory.php => Cache.php} | 47 ++++--- src/Core/Cache/Type/APCuCache.php | 61 +++++---- .../Type/{BaseCache.php => AbstractCache.php} | 24 ++-- src/Core/Cache/Type/ArrayCache.php | 30 ++--- ...mpareDelete.php => CompareDeleteTrait.php} | 22 +-- ...raitCompareSet.php => CompareSetTrait.php} | 25 ++-- src/Core/Cache/Type/DatabaseCache.php | 123 ++++++++++------- src/Core/Cache/Type/MemcacheCache.php | 73 +++++----- ...heCommand.php => MemcacheCommandTrait.php} | 25 ++-- src/Core/Cache/Type/MemcachedCache.php | 75 ++++++----- ...erCache.php => ProfilerCacheDecorator.php} | 38 +++--- src/Core/Cache/Type/RedisCache.php | 87 ++++++------ .../IManageConfigValues.php} | 40 +++--- .../Config/Exception/ConfigFileException.php | 13 ++ .../Exception/ConfigPersistenceException.php | 13 ++ .../Factory/{ConfigFactory.php => Config.php} | 40 +++--- .../Config/{Model => Repository}/Config.php | 101 ++++++++------ .../{BaseConfig.php => AbstractConfig.php} | 26 ++-- src/Core/Config/Type/JitConfig.php | 46 +++---- src/Core/Config/Type/PreloadConfig.php | 49 +++---- .../{Cache => Util}/ConfigFileLoader.php | 52 ++++---- .../DbaUtils.php => Util/ValueConversion.php} | 11 +- .../Config/{Cache => ValueObject}/Cache.php | 27 ++-- src/Core/Installer.php | 6 +- src/Core/L10n.php | 10 +- .../{ILock.php => Capability/ICanLock.php} | 35 ++--- .../Exception/InvalidLockDriverException.php | 13 ++ .../Exception/LockPersistenceException.php | 13 ++ .../Factory/{LockFactory.php => Lock.php} | 47 +++---- .../Type/{BaseLock.php => AbstractLock.php} | 12 +- src/Core/Lock/Type/CacheLock.php | 101 ++++++++------ src/Core/Lock/Type/DatabaseLock.php | 126 +++++++++++------- src/Core/Lock/Type/SemaphoreLock.php | 19 +-- .../IManagePersonalConfigValues.php} | 36 +++-- .../Exception/PConfigPersistenceException.php | 13 ++ .../{PConfigFactory.php => PConfig.php} | 23 ++-- .../PConfig/{Model => Repository}/PConfig.php | 104 ++++++++------- ...ePConfig.php => AbstractPConfigValues.php} | 28 ++-- src/Core/PConfig/Type/JitPConfig.php | 34 +++-- src/Core/PConfig/Type/PreloadPConfig.php | 24 ++-- .../PConfig/{Cache => ValueObject}/Cache.php | 31 +++-- src/Core/Process.php | 8 +- .../IHandleSessions.php} | 8 +- .../{SessionFactory.php => Session.php} | 45 ++++--- src/Core/Session/Handler/Cache.php | 67 ++++++---- src/Core/Session/Handler/Database.php | 75 +++++++---- src/Core/Session/Type/AbstractSession.php | 8 +- src/Core/Session/Type/Memory.php | 4 +- src/Core/Session/Type/Native.php | 6 +- src/Core/StorageManager.php | 14 +- src/DI.php | 20 +-- src/Database/Database.php | 4 +- src/Factory/HTTPClientFactory.php | 6 +- src/Factory/LoggerFactory.php | 20 +-- src/Model/Storage/FilesystemConfig.php | 10 +- src/Model/User/Cookie.php | 12 +- src/Module/Admin/Summary.php | 8 +- src/Module/Install.php | 12 +- .../Notifications/Factory/Introduction.php | 10 +- .../Notifications/Repository/Notify.php | 6 +- src/Security/Authentication.php | 30 ++--- src/Security/ExAuth.php | 21 +-- src/Util/EMailer/MailBuilder.php | 6 +- src/Util/EMailer/NotifyMailBuilder.php | 4 +- src/Util/EMailer/SystemMailBuilder.php | 4 +- src/Util/Emailer.php | 10 +- src/Util/Profiler.php | 10 +- static/dependencies.config.php | 34 ++--- tests/FixtureTest.php | 10 +- tests/Util/AppMockTrait.php | 10 +- tests/functional/DependencyCheckTest.php | 40 +++--- tests/legacy/ApiTest.php | 16 +-- tests/src/App/ModeTest.php | 2 +- tests/src/App/ModuleTest.php | 12 +- tests/src/App/RouterTest.php | 12 +- .../AutomaticInstallationConsoleTest.php | 4 +- tests/src/Console/ConfigConsoleTest.php | 6 +- tests/src/Console/LockConsoleTest.php | 6 +- tests/src/Console/ServerBlockConsoleTest.php | 6 +- tests/src/Core/Cache/CacheTest.php | 8 +- tests/src/Core/Cache/DatabaseCacheTest.php | 6 +- tests/src/Core/Cache/MemcacheCacheTest.php | 4 +- tests/src/Core/Cache/MemcachedCacheTest.php | 4 +- tests/src/Core/Cache/MemoryCacheTest.php | 6 +- tests/src/Core/Cache/RedisCacheTest.php | 4 +- tests/src/Core/Config/Cache/CacheTest.php | 52 ++++---- .../Config/Cache/ConfigFileLoaderTest.php | 74 +++++----- tests/src/Core/Config/ConfigTest.php | 46 +++---- tests/src/Core/InstallerTest.php | 2 +- .../src/Core/Lock/DatabaseLockDriverTest.php | 6 +- tests/src/Core/Lock/LockTest.php | 4 +- tests/src/Core/Lock/MemcacheCacheLockTest.php | 4 +- .../src/Core/Lock/MemcachedCacheLockTest.php | 4 +- tests/src/Core/Lock/RedisCacheLockTest.php | 4 +- tests/src/Core/Lock/SemaphoreLockTest.php | 4 +- tests/src/Core/PConfig/Cache/CacheTest.php | 41 ++---- tests/src/Core/PConfig/PConfigTest.php | 32 ++--- tests/src/Core/StorageManagerTest.php | 21 ++- tests/src/Model/ProcessTest.php | 6 +- .../src/Model/Storage/DatabaseStorageTest.php | 6 +- .../Storage/FilesystemStorageConfigTest.php | 4 +- tests/src/Model/User/CookieTest.php | 6 +- tests/src/Util/BaseURLTest.php | 14 +- tests/src/Util/EMailerTest.php | 12 +- tests/src/Util/Emailer/MailBuilderTest.php | 6 +- .../Util/Emailer/SystemMailBuilderTest.php | 6 +- tests/src/Util/ProfilerTest.php | 6 +- 130 files changed, 1625 insertions(+), 1397 deletions(-) rename src/Core/Cache/{ICache.php => Capability/ICanCache.php} (55%) rename src/Core/Cache/{IMemoryCache.php => Capability/ICanCacheInMemory.php} (53%) create mode 100644 src/Core/Cache/Exception/CachePersistenceException.php create mode 100644 src/Core/Cache/Exception/InvalidCacheDriverException.php rename src/Core/Cache/Factory/{CacheFactory.php => Cache.php} (60%) rename src/Core/Cache/Type/{BaseCache.php => AbstractCache.php} (81%) rename src/Core/Cache/Type/{TraitCompareDelete.php => CompareDeleteTrait.php} (70%) rename src/Core/Cache/Type/{TraitCompareSet.php => CompareSetTrait.php} (67%) rename src/Core/Cache/Type/{TraitMemcacheCommand.php => MemcacheCommandTrait.php} (81%) rename src/Core/Cache/Type/{ProfilerCache.php => ProfilerCacheDecorator.php} (70%) rename src/Core/Config/{IConfig.php => Capability/IManageConfigValues.php} (66%) create mode 100644 src/Core/Config/Exception/ConfigFileException.php create mode 100644 src/Core/Config/Exception/ConfigPersistenceException.php rename src/Core/Config/Factory/{ConfigFactory.php => Config.php} (65%) rename src/Core/Config/{Model => Repository}/Config.php (52%) rename src/Core/Config/Type/{BaseConfig.php => AbstractConfig.php} (61%) rename src/Core/Config/{Cache => Util}/ConfigFileLoader.php (86%) rename src/Core/Config/{Model/DbaUtils.php => Util/ValueConversion.php} (82%) rename src/Core/Config/{Cache => ValueObject}/Cache.php (88%) rename src/Core/Lock/{ILock.php => Capability/ICanLock.php} (62%) create mode 100644 src/Core/Lock/Exception/InvalidLockDriverException.php create mode 100644 src/Core/Lock/Exception/LockPersistenceException.php rename src/Core/Lock/Factory/{LockFactory.php => Lock.php} (74%) rename src/Core/Lock/Type/{BaseLock.php => AbstractLock.php} (85%) rename src/Core/PConfig/{IPConfig.php => Capability/IManagePersonalConfigValues.php} (75%) create mode 100644 src/Core/PConfig/Exception/PConfigPersistenceException.php rename src/Core/PConfig/Factory/{PConfigFactory.php => PConfig.php} (62%) rename src/Core/PConfig/{Model => Repository}/PConfig.php (55%) rename src/Core/PConfig/Type/{BasePConfig.php => AbstractPConfigValues.php} (61%) rename src/Core/PConfig/{Cache => ValueObject}/Cache.php (85%) rename src/Core/Session/{ISession.php => Capability/IHandleSessions.php} (92%) rename src/Core/Session/Factory/{SessionFactory.php => Session.php} (64%) diff --git a/doc/AddonStorageBackend.md b/doc/AddonStorageBackend.md index f4773acb8..0b0672376 100644 --- a/doc/AddonStorageBackend.md +++ b/doc/AddonStorageBackend.md @@ -188,7 +188,7 @@ namespace Friendica\Addon\samplestorage; use Friendica\Model\Storage\IWritableStorage; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; class SampleStorageBackend implements IWritableStorage @@ -249,12 +249,12 @@ namespace Friendica\Addon\samplestorage; use Friendica\Model\Storage\IStorageConfiguration; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; class SampleStorageBackendConfig implements IStorageConfiguration { - /** @var IConfig */ + /** @var \Friendica\Core\Config\Capability\IManageConfigValues */ private $config; /** @var L10n */ private $l10n; @@ -265,7 +265,7 @@ class SampleStorageBackendConfig implements IStorageConfiguration * You can add here every dynamic class as dependency you like and add them to a private field * Friendica automatically creates these classes and passes them as argument to the constructor */ - public function __construct(IConfig $config, L10n $l10n) + public function __construct(IManageConfigValues $config, L10n $l10n) { $this->config = $config; $this->l10n = $l10n; diff --git a/index.php b/index.php index 011b9d7f9..4f690ed51 100644 --- a/index.php +++ b/index.php @@ -43,7 +43,7 @@ $a = \Friendica\DI::app(); $a->runFrontend( $dice->create(\Friendica\App\Module::class), $dice->create(\Friendica\App\Router::class), - $dice->create(\Friendica\Core\PConfig\IPConfig::class), + $dice->create(\Friendica\Core\PConfig\Capability\IManagePersonalConfigValues::class), $dice->create(\Friendica\Security\Authentication::class), $dice->create(\Friendica\App\Page::class), $start_time diff --git a/src/App.php b/src/App.php index cd217c34e..9c0699a18 100644 --- a/src/App.php +++ b/src/App.php @@ -25,12 +25,12 @@ use Exception; use Friendica\App\Arguments; use Friendica\App\BaseURL; use Friendica\App\Module; -use Friendica\Core\Config\Factory\ConfigFactory; +use Friendica\Core\Config\Factory\Config; use Friendica\Module\Maintenance; use Friendica\Security\Authentication; -use Friendica\Core\Config\Cache\Cache; -use Friendica\Core\Config\IConfig; -use Friendica\Core\PConfig\IPConfig; +use Friendica\Core\Config\ValueObject\Cache; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Core\L10n; use Friendica\Core\System; use Friendica\Core\Theme; @@ -88,7 +88,7 @@ class App private $currentMobileTheme; /** - * @var IConfig The config + * @var IManageConfigValues The config */ private $config; @@ -123,7 +123,7 @@ class App private $process; /** - * @var IPConfig + * @var IManagePersonalConfigValues */ private $pConfig; @@ -305,18 +305,18 @@ class App } /** - * @param Database $database The Friendica Database - * @param IConfig $config The Configuration - * @param App\Mode $mode The mode of this Friendica app - * @param BaseURL $baseURL The full base URL of this Friendica app - * @param LoggerInterface $logger The current app logger - * @param Profiler $profiler The profiler of this application - * @param L10n $l10n The translator instance - * @param App\Arguments $args The Friendica Arguments of the call - * @param Core\Process $process The process methods - * @param IPConfig $pConfig Personal configuration + * @param Database $database The Friendica Database + * @param IManageConfigValues $config The Configuration + * @param App\Mode $mode The mode of this Friendica app + * @param BaseURL $baseURL The full base URL of this Friendica app + * @param LoggerInterface $logger The current app logger + * @param Profiler $profiler The profiler of this application + * @param L10n $l10n The translator instance + * @param App\Arguments $args The Friendica Arguments of the call + * @param Core\Process $process The process methods + * @param \Friendica\Core\PConfig\Capability\IManagePersonalConfigValues $pConfig Personal configuration */ - public function __construct(Database $database, IConfig $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, Core\Process $process, IPConfig $pConfig) + public function __construct(Database $database, IManageConfigValues $config, App\Mode $mode, BaseURL $baseURL, LoggerInterface $logger, Profiler $profiler, L10n $l10n, Arguments $args, Core\Process $process, IManagePersonalConfigValues $pConfig) { $this->database = $database; $this->config = $config; @@ -357,7 +357,7 @@ class App $this->profiler->update($this->config); Core\Hook::loadHooks(); - $loader = (new ConfigFactory())->createConfigFileLoader($this->getBasePath(), $_SERVER); + $loader = (new Config())->createConfigFileLoader($this->getBasePath(), $_SERVER); Core\Hook::callAll('load_config', $loader); } @@ -552,16 +552,16 @@ class App * * This probably should change to limit the size of this monster method. * - * @param App\Module $module The determined module - * @param App\Router $router - * @param IPConfig $pconfig - * @param Authentication $auth The Authentication backend of the node - * @param App\Page $page The Friendica page printing container + * @param App\Module $module The determined module + * @param App\Router $router + * @param IManagePersonalConfigValues $pconfig + * @param Authentication $auth The Authentication backend of the node + * @param App\Page $page The Friendica page printing container * * @throws HTTPException\InternalServerErrorException * @throws \ImagickException */ - public function runFrontend(App\Module $module, App\Router $router, IPConfig $pconfig, Authentication $auth, App\Page $page, float $start_time) + public function runFrontend(App\Module $module, App\Router $router, IManagePersonalConfigValues $pconfig, Authentication $auth, App\Page $page, float $start_time) { $this->profiler->set($start_time, 'start'); $this->profiler->set(microtime(true), 'classinit'); diff --git a/src/App/BaseURL.php b/src/App/BaseURL.php index a7bfce2b1..40ed79416 100644 --- a/src/App/BaseURL.php +++ b/src/App/BaseURL.php @@ -21,7 +21,7 @@ namespace Friendica\App; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\System; use Friendica\Util\Network; use Friendica\Util\Strings; @@ -56,7 +56,7 @@ class BaseURL /** * The Friendica Config * - * @var IConfig + * @var IManageConfigValues */ private $config; @@ -272,10 +272,10 @@ class BaseURL } /** - * @param IConfig $config The Friendica IConfiguration - * @param array $server The $_SERVER array + * @param \Friendica\Core\Config\Capability\IManageConfigValues $config The Friendica IConfiguration + * @param array $server The $_SERVER array */ - public function __construct(IConfig $config, array $server) + public function __construct(IManageConfigValues $config, array $server) { $this->config = $config; $this->server = $server; diff --git a/src/App/Mode.php b/src/App/Mode.php index 9f7a34a53..1087b08a0 100644 --- a/src/App/Mode.php +++ b/src/App/Mode.php @@ -22,7 +22,7 @@ namespace Friendica\App; use Detection\MobileDetect; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\Database\Database; use Friendica\Util\BasePath; diff --git a/src/App/Module.php b/src/App/Module.php index f15b1236e..ce7cc98f0 100644 --- a/src/App/Module.php +++ b/src/App/Module.php @@ -168,15 +168,15 @@ class Module /** * Determine the class of the current module * - * @param Arguments $args The Friendica execution arguments - * @param Router $router The Friendica routing instance - * @param Core\Config\IConfig $config The Friendica Configuration + * @param Arguments $args The Friendica execution arguments + * @param Router $router The Friendica routing instance + * @param \Friendica\Core\Config\Capability\IManageConfigValues $config The Friendica Configuration * * @return Module The determined module of this call * * @throws \Exception */ - public function determineClass(Arguments $args, Router $router, Core\Config\IConfig $config) + public function determineClass(Arguments $args, Router $router, Core\Config\Capability\IManageConfigValues $config) { $printNotAllowedAddon = false; diff --git a/src/App/Page.php b/src/App/Page.php index 766dd4ebe..abc84b0e9 100644 --- a/src/App/Page.php +++ b/src/App/Page.php @@ -26,8 +26,8 @@ use DOMDocument; use DOMXPath; use Friendica\App; use Friendica\Content\Nav; -use Friendica\Core\Config\IConfig; -use Friendica\Core\PConfig\IPConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Core\Hook; use Friendica\Core\L10n; use Friendica\Core\Renderer; @@ -190,15 +190,15 @@ class Page implements ArrayAccess * - Infinite scroll data * - head.tpl template * - * @param App $app The Friendica App instance - * @param Module $module The loaded Friendica module - * @param L10n $l10n The l10n language instance - * @param IConfig $config The Friendica configuration - * @param IPConfig $pConfig The Friendica personal configuration (for user) + * @param App $app The Friendica App instance + * @param Module $module The loaded Friendica module + * @param L10n $l10n The l10n language instance + * @param \Friendica\Core\Config\Capability\IManageConfigValues $config The Friendica configuration + * @param \Friendica\Core\PConfig\Capability\IManagePersonalConfigValues $pConfig The Friendica personal configuration (for user) * * @throws HTTPException\InternalServerErrorException */ - private function initHead(App $app, Module $module, L10n $l10n, IConfig $config, IPConfig $pConfig) + private function initHead(App $app, Module $module, L10n $l10n, IManageConfigValues $config, IManagePersonalConfigValues $pConfig) { $interval = ((local_user()) ? $pConfig->get(local_user(), 'system', 'update_interval') : 40000); @@ -367,17 +367,17 @@ class Page implements ArrayAccess /** * Executes the creation of the current page and prints it to the screen * - * @param App $app The Friendica App - * @param BaseURL $baseURL The Friendica Base URL - * @param Mode $mode The current node mode - * @param Module $module The loaded Friendica module - * @param L10n $l10n The l10n language class - * @param IConfig $config The Configuration of this node - * @param IPConfig $pconfig The personal/user configuration + * @param App $app The Friendica App + * @param BaseURL $baseURL The Friendica Base URL + * @param Mode $mode The current node mode + * @param Module $module The loaded Friendica module + * @param L10n $l10n The l10n language class + * @param IManageConfigValues $config The Configuration of this node + * @param IManagePersonalConfigValues $pconfig The personal/user configuration * * @throws HTTPException\InternalServerErrorException */ - public function run(App $app, BaseURL $baseURL, Mode $mode, Module $module, L10n $l10n, Profiler $profiler, IConfig $config, IPConfig $pconfig) + public function run(App $app, BaseURL $baseURL, Mode $mode, Module $module, L10n $l10n, Profiler $profiler, IManageConfigValues $config, IManagePersonalConfigValues $pconfig) { $moduleName = $module->getName(); diff --git a/src/App/Router.php b/src/App/Router.php index 507683953..181f5368d 100644 --- a/src/App/Router.php +++ b/src/App/Router.php @@ -27,10 +27,10 @@ use FastRoute\Dispatcher; use FastRoute\RouteCollector; use FastRoute\RouteParser\Std; use Friendica\Core\Cache\Enum\Duration; -use Friendica\Core\Cache\ICache; +use Friendica\Core\Cache\Capability\ICanCache; use Friendica\Core\Hook; use Friendica\Core\L10n; -use Friendica\Core\Lock\ILock; +use Friendica\Core\Lock\Capability\ICanLock; use Friendica\Network\HTTPException; /** @@ -77,10 +77,10 @@ class Router /** @var L10n */ private $l10n; - /** @var ICache */ + /** @var ICanCache */ private $cache; - /** @var ILock */ + /** @var ICanLock */ private $lock; /** @var string */ @@ -90,10 +90,10 @@ class Router * @param array $server The $_SERVER variable * @param string $baseRoutesFilepath The path to a base routes file to leverage cache, can be empty * @param L10n $l10n - * @param ICache $cache + * @param ICanCache $cache * @param RouteCollector|null $routeCollector */ - public function __construct(array $server, string $baseRoutesFilepath, L10n $l10n, ICache $cache, ILock $lock, RouteCollector $routeCollector = null) + public function __construct(array $server, string $baseRoutesFilepath, L10n $l10n, ICanCache $cache, ICanLock $lock, RouteCollector $routeCollector = null) { $this->baseRoutesFilepath = $baseRoutesFilepath; $this->l10n = $l10n; diff --git a/src/Console/AutomaticInstallation.php b/src/Console/AutomaticInstallation.php index 9ef82524a..8be1b34cf 100644 --- a/src/Console/AutomaticInstallation.php +++ b/src/Console/AutomaticInstallation.php @@ -24,8 +24,8 @@ namespace Friendica\Console; use Asika\SimpleConsole\Console; use Friendica\App; use Friendica\App\BaseURL; -use Friendica\Core\Config\IConfig; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\Core\Installer; use Friendica\Core\Theme; use Friendica\Database\Database; @@ -36,9 +36,9 @@ class AutomaticInstallation extends Console { /** @var App\Mode */ private $appMode; - /** @var \Friendica\Core\Config\Cache\Cache */ + /** @var \Friendica\Core\Config\ValueObject\Cache */ private $configCache; - /** @var IConfig */ + /** @var IManageConfigValues */ private $config; /** @var Database */ private $dba; @@ -98,7 +98,7 @@ Examples HELP; } - public function __construct(App\Mode $appMode, Cache $configCache, IConfig $config, Database $dba, array $argv = null) + public function __construct(App\Mode $appMode, Cache $configCache, IManageConfigValues $config, Database $dba, array $argv = null) { parent::__construct($argv); @@ -252,8 +252,8 @@ HELP; } /** - * @param Installer $installer The Installer instance - * @param Cache $configCache The config cache + * @param Installer $installer The Installer instance + * @param \Friendica\Core\Config\ValueObject\Cache $configCache The config cache * * @return bool true if checks were successfully, otherwise false * @throws \Friendica\Network\HTTPException\InternalServerErrorException diff --git a/src/Console/Cache.php b/src/Console/Cache.php index a9452435e..560832c9c 100644 --- a/src/Console/Cache.php +++ b/src/Console/Cache.php @@ -24,7 +24,7 @@ namespace Friendica\Console; use Asika\SimpleConsole\CommandArgsException; use Friendica\App; use Friendica\Core\Cache\Enum\Duration; -use Friendica\Core\Cache\ICache; +use Friendica\Core\Cache\Capability\ICanCache; use RuntimeException; /** @@ -44,7 +44,7 @@ class Cache extends \Asika\SimpleConsole\Console private $appMode; /** - * @var ICache + * @var ICanCache */ private $cache; @@ -82,7 +82,7 @@ HELP; return $help; } - public function __construct(App\Mode $appMode, ICache $cache, array $argv = null) + public function __construct(App\Mode $appMode, ICanCache $cache, array $argv = null) { parent::__construct($argv); diff --git a/src/Console/Config.php b/src/Console/Config.php index 3c775d432..9b2d25197 100644 --- a/src/Console/Config.php +++ b/src/Console/Config.php @@ -23,7 +23,7 @@ namespace Friendica\Console; use Asika\SimpleConsole\CommandArgsException; use Friendica\App; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use RuntimeException; /** @@ -56,7 +56,7 @@ class Config extends \Asika\SimpleConsole\Console */ private $appMode; /** - * @var IConfig + * @var IManageConfigValues */ private $config; @@ -94,7 +94,7 @@ HELP; return $help; } - public function __construct(App\Mode $appMode, IConfig $config, array $argv = null) + public function __construct(App\Mode $appMode, IManageConfigValues $config, array $argv = null) { parent::__construct($argv); diff --git a/src/Console/DatabaseStructure.php b/src/Console/DatabaseStructure.php index 1083a512d..be301746c 100644 --- a/src/Console/DatabaseStructure.php +++ b/src/Console/DatabaseStructure.php @@ -21,7 +21,7 @@ namespace Friendica\Console; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\Core\Update; use Friendica\Database\Database; use Friendica\Database\DBStructure; diff --git a/src/Console/Lock.php b/src/Console/Lock.php index 7ac1cdd24..3b73837b6 100644 --- a/src/Console/Lock.php +++ b/src/Console/Lock.php @@ -23,7 +23,7 @@ namespace Friendica\Console; use Asika\SimpleConsole\CommandArgsException; use Friendica\App; -use Friendica\Core\Lock\ILock; +use Friendica\Core\Lock\Capability\ICanLock; use RuntimeException; /** @@ -42,7 +42,7 @@ class Lock extends \Asika\SimpleConsole\Console private $appMode; /** - * @var ILock + * @var \Friendica\Core\Lock\Capability\ICanLock */ private $lock; @@ -76,7 +76,7 @@ HELP; return $help; } - public function __construct(App\Mode $appMode, ILock $lock, array $argv = null) + public function __construct(App\Mode $appMode, ICanLock $lock, array $argv = null) { parent::__construct($argv); diff --git a/src/Console/Maintenance.php b/src/Console/Maintenance.php index 647d1910f..29ae120f7 100644 --- a/src/Console/Maintenance.php +++ b/src/Console/Maintenance.php @@ -22,7 +22,7 @@ namespace Friendica\Console; use Friendica\App; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; /** * Sets maintenance mode for this node @@ -36,7 +36,7 @@ class Maintenance extends \Asika\SimpleConsole\Console */ private $appMode; /** - * @var IConfig + * @var IManageConfigValues */ private $config; @@ -69,7 +69,7 @@ HELP; return $help; } - public function __construct(App\Mode $appMode, IConfig $config, $argv = null) + public function __construct(App\Mode $appMode, IManageConfigValues $config, $argv = null) { parent::__construct($argv); diff --git a/src/Console/PostUpdate.php b/src/Console/PostUpdate.php index 35b57fb7a..4c047e502 100644 --- a/src/Console/PostUpdate.php +++ b/src/Console/PostUpdate.php @@ -22,7 +22,7 @@ namespace Friendica\Console; use Friendica\App; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; use Friendica\Core\Update; @@ -38,7 +38,7 @@ class PostUpdate extends \Asika\SimpleConsole\Console */ private $appMode; /** - * @var IConfig + * @var \Friendica\Core\Config\Capability\IManageConfigValues */ private $config; /** @@ -60,7 +60,7 @@ HELP; return $help; } - public function __construct(App\Mode $appMode, IConfig $config, L10n $l10n, array $argv = null) + public function __construct(App\Mode $appMode, IManageConfigValues $config, L10n $l10n, array $argv = null) { parent::__construct($argv); diff --git a/src/Console/ServerBlock.php b/src/Console/ServerBlock.php index bba37c617..2bf5fe1ab 100644 --- a/src/Console/ServerBlock.php +++ b/src/Console/ServerBlock.php @@ -24,7 +24,7 @@ namespace Friendica\Console; use Asika\SimpleConsole\CommandArgsException; use Asika\SimpleConsole\Console; use Console_Table; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; /** * Manage blocked servers @@ -39,7 +39,7 @@ class ServerBlock extends Console protected $helpOptions = ['h', 'help', '?']; /** - * @var IConfig + * @var IManageConfigValues */ private $config; @@ -72,7 +72,7 @@ HELP; return $help; } - public function __construct(IConfig $config, $argv = null) + public function __construct(IManageConfigValues $config, $argv = null) { parent::__construct($argv); @@ -105,9 +105,9 @@ HELP; * Exports the list of blocked domains including the reason for the * block to a CSV file. * - * @param IConfig $config + * @param IManageConfigValues $config */ - private function exportBlockedServers(IConfig $config) + private function exportBlockedServers(IManageConfigValues $config) { $filename = $this->getArgument(1); $blocklist = $config->get('system', 'blocklist', []); @@ -123,9 +123,9 @@ HELP; * Imports a list of domains and a reason for the block from a CSV * file, e.g. created with the export function. * - * @param IConfig $config + * @param IManageConfigValues $config */ - private function importBlockedServers(IConfig $config) + private function importBlockedServers(IManageConfigValues $config) { $filename = $this->getArgument(1); $currBlockList = $config->get('system', 'blocklist', []); @@ -167,9 +167,9 @@ HELP; /** * Prints the whole list of blocked domains including the reason * - * @param IConfig $config + * @param IManageConfigValues $config */ - private function printBlockedServers(IConfig $config) + private function printBlockedServers(IManageConfigValues $config) { $table = new Console_Table(); $table->setHeaders(['Domain', 'Reason']); @@ -183,11 +183,11 @@ HELP; /** * Adds a server to the blocked list * - * @param IConfig $config + * @param IManageConfigValues $config * * @return int The return code (0 = success, 1 = failed) */ - private function addBlockedServer(IConfig $config) + private function addBlockedServer(IManageConfigValues $config) { if (count($this->args) < 2 || count($this->args) > 3) { throw new CommandArgsException('Add needs a domain and optional a reason.'); @@ -235,11 +235,11 @@ HELP; /** * Removes a server from the blocked list * - * @param IConfig $config + * @param IManageConfigValues $config * * @return int The return code (0 = success, 1 = failed) */ - private function removeBlockedServer(IConfig $config) + private function removeBlockedServer(IManageConfigValues $config) { if (count($this->args) !== 2) { throw new CommandArgsException('Remove needs a second parameter.'); diff --git a/src/Console/Typo.php b/src/Console/Typo.php index 633ec1ec3..488e362aa 100644 --- a/src/Console/Typo.php +++ b/src/Console/Typo.php @@ -21,7 +21,7 @@ namespace Friendica\Console; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; /** * Tired of chasing typos and finding them after a commit. @@ -32,7 +32,7 @@ class Typo extends \Asika\SimpleConsole\Console protected $helpOptions = ['h', 'help', '?']; /** - * @var IConfig + * @var IManageConfigValues */ private $config; @@ -53,7 +53,7 @@ HELP; return $help; } - public function __construct(IConfig $config, array $argv = null) + public function __construct(IManageConfigValues $config, array $argv = null) { parent::__construct($argv); diff --git a/src/Console/User.php b/src/Console/User.php index bb0748d6f..5cf15747e 100644 --- a/src/Console/User.php +++ b/src/Console/User.php @@ -25,7 +25,7 @@ use Console_Table; use Friendica\App; use Friendica\Content\Pager; use Friendica\Core\L10n; -use Friendica\Core\PConfig\IPConfig; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Model\Register; use Friendica\Model\User as UserModel; use Friendica\Util\Temporal; @@ -48,7 +48,7 @@ class User extends \Asika\SimpleConsole\Console */ private $l10n; /** - * @var IPConfig + * @var IManagePersonalConfigValues */ private $pConfig; @@ -88,7 +88,7 @@ HELP; return $help; } - public function __construct(App\Mode $appMode, L10n $l10n, IPConfig $pConfig, array $argv = null) + public function __construct(App\Mode $appMode, L10n $l10n, IManagePersonalConfigValues $pConfig, array $argv = null) { parent::__construct($argv); diff --git a/src/Content/Conversation.php b/src/Content/Conversation.php index 879e47c24..7bd7ea69f 100644 --- a/src/Content/Conversation.php +++ b/src/Content/Conversation.php @@ -26,10 +26,10 @@ use Friendica\App\Arguments; use Friendica\App\BaseURL; use Friendica\BaseModule; use Friendica\Core\ACL; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Hook; use Friendica\Core\L10n; -use Friendica\Core\PConfig\IPConfig; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Core\Protocol; use Friendica\Core\Renderer; use Friendica\Core\Session; @@ -66,11 +66,11 @@ class Conversation private $item; /** @var App\Arguments */ private $args; - /** @var IPConfig */ + /** @var IManagePersonalConfigValues */ private $pConfig; /** @var BaseURL */ private $baseURL; - /** @var IConfig */ + /** @var IManageConfigValues */ private $config; /** @var App */ private $app; @@ -79,7 +79,7 @@ class Conversation /** @var App\Mode */ private $mode; - public function __construct(LoggerInterface $logger, Profiler $profiler, Activity $activity, L10n $l10n, Item $item, Arguments $args, BaseURL $baseURL, IConfig $config, IPConfig $pConfig, App\Page $page, App\Mode $mode, App $app) + public function __construct(LoggerInterface $logger, Profiler $profiler, Activity $activity, L10n $l10n, Item $item, Arguments $args, BaseURL $baseURL, IManageConfigValues $config, IManagePersonalConfigValues $pConfig, App\Page $page, App\Mode $mode, App $app) { $this->activity = $activity; $this->item = $item; @@ -629,7 +629,7 @@ class Conversation $body_html = ItemModel::prepareBody($item, true, $preview); - list($categories, $folders) = $this->item->determineCategoriesTerms($item, local_user()); + [$categories, $folders] = $this->item->determineCategoriesTerms($item, local_user()); if (!empty($item['content-warning']) && $this->pConfig->get(local_user(), 'system', 'disable_cw', false)) { $title = ucfirst($item['content-warning']); diff --git a/src/Core/Cache/ICache.php b/src/Core/Cache/Capability/ICanCache.php similarity index 55% rename from src/Core/Cache/ICache.php rename to src/Core/Cache/Capability/ICanCache.php index 3918b0089..46d1df468 100644 --- a/src/Core/Cache/ICache.php +++ b/src/Core/Cache/Capability/ICanCache.php @@ -19,23 +19,24 @@ * */ -namespace Friendica\Core\Cache; +namespace Friendica\Core\Cache\Capability; use Friendica\Core\Cache\Enum\Duration; +use Friendica\Core\Cache\Exception\CachePersistenceException; /** - * Cache Interface + * Interface for caches */ -interface ICache +interface ICanCache { /** * Lists all cache keys * - * @param string prefix optional a prefix to search + * @param string|null prefix optional a prefix to search * * @return array Empty if it isn't supported by the cache driver */ - public function getAllKeys($prefix = null); + public function getAllKeys(?string $prefix = null): array; /** * Fetches cached data according to the key @@ -43,41 +44,50 @@ interface ICache * @param string $key The key to the cached data * * @return mixed Cached $value or "null" if not found + * + * @throws CachePersistenceException In case the underlying cache driver has errors during persistence */ - public function get($key); + public function get(string $key); /** * Stores data in the cache identified by the key. The input $value can have multiple formats. * - * @param string $key The cache key - * @param mixed $value The value to store - * @param integer $ttl The cache lifespan, must be one of the Cache constants + * @param string $key The cache key + * @param mixed $value The value to store + * @param integer $ttl The cache lifespan, must be one of the Cache constants * * @return bool + * + * @throws CachePersistenceException In case the underlying cache driver has errors during persistence */ - public function set($key, $value, $ttl = Duration::FIVE_MINUTES); + public function set(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool; /** * Delete a key from the cache * - * @param string $key The cache key + * @param string $key The cache key * * @return bool + * + * @throws CachePersistenceException In case the underlying cache driver has errors during persistence */ - public function delete($key); + public function delete(string $key): bool; /** * Remove outdated data from the cache - * @param boolean $outdated just remove outdated values + * + * @param boolean $outdated just remove outdated values * * @return bool + * + * @throws CachePersistenceException In case the underlying cache driver has errors during persistence */ - public function clear($outdated = true); + public function clear(bool $outdated = true): bool; /** * Returns the name of the current cache * * @return string */ - public function getName(); + public function getName(): string; } diff --git a/src/Core/Cache/IMemoryCache.php b/src/Core/Cache/Capability/ICanCacheInMemory.php similarity index 53% rename from src/Core/Cache/IMemoryCache.php rename to src/Core/Cache/Capability/ICanCacheInMemory.php index a46db0b01..96e47ada1 100644 --- a/src/Core/Cache/IMemoryCache.php +++ b/src/Core/Cache/Capability/ICanCacheInMemory.php @@ -19,43 +19,52 @@ * */ -namespace Friendica\Core\Cache; +namespace Friendica\Core\Cache\Capability; use Friendica\Core\Cache\Enum\Duration; +use Friendica\Core\Cache\Exception\CachePersistenceException; /** * This interface defines methods for Memory-Caches only */ -interface IMemoryCache extends ICache +interface ICanCacheInMemory extends ICanCache { /** * Sets a value if it's not already stored * - * @param string $key The cache key - * @param mixed $value The old value we know from the cache - * @param int $ttl The cache lifespan, must be one of the Cache constants + * @param string $key The cache key + * @param mixed $value The old value we know from the cache + * @param int $ttl The cache lifespan, must be one of the Cache constants + * * @return bool + * + * @throws CachePersistenceException In case the underlying cache driver has errors during persistence */ - public function add($key, $value, $ttl = Duration::FIVE_MINUTES); + public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool; /** * Compares if the old value is set and sets the new value * - * @param string $key The cache key - * @param mixed $oldValue The old value we know from the cache - * @param mixed $newValue The new value we want to set - * @param int $ttl The cache lifespan, must be one of the Cache constants + * @param string $key The cache key + * @param mixed $oldValue The old value we know from the cache + * @param mixed $newValue The new value we want to set + * @param int $ttl The cache lifespan, must be one of the Cache constants * * @return bool + * + * @throws CachePersistenceException In case the underlying cache driver has errors during persistence */ - public function compareSet($key, $oldValue, $newValue, $ttl = Duration::FIVE_MINUTES); + public function compareSet(string $key, $oldValue, $newValue, int $ttl = Duration::FIVE_MINUTES): bool; /** * Compares if the old value is set and removes it * - * @param string $key The cache key - * @param mixed $value The old value we know and want to delete + * @param string $key The cache key + * @param mixed $value The old value we know and want to delete + * * @return bool + * + * @throws CachePersistenceException In case the underlying cache driver has errors during persistence */ - public function compareDelete($key, $value); + public function compareDelete(string $key, $value): bool; } diff --git a/src/Core/Cache/Exception/CachePersistenceException.php b/src/Core/Cache/Exception/CachePersistenceException.php new file mode 100644 index 000000000..d50221ae7 --- /dev/null +++ b/src/Core/Cache/Exception/CachePersistenceException.php @@ -0,0 +1,13 @@ +hostname = $baseURL->getHostname(); $this->config = $config; @@ -80,39 +83,41 @@ class CacheFactory /** * This method creates a CacheDriver for the given cache driver name * - * @param string $type The cache type to create (default is per config) + * @param string|null $type The cache type to create (default is per config) * - * @return ICache The instance of the CacheDriver - * @throws \Exception The exception if something went wrong during the CacheDriver creation + * @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 create(string $type = null) + public function create(string $type = null): ICanCache { if (empty($type)) { $type = $this->config->get('system', 'cache_driver', self::DEFAULT_TYPE); } switch ($type) { - case Cache\Enum\Type::MEMCACHE: - $cache = new Cache\Type\MemcacheCache($this->hostname, $this->config); + case Enum\Type::MEMCACHE: + $cache = new Type\MemcacheCache($this->hostname, $this->config); break; - case Cache\Enum\Type::MEMCACHED: - $cache = new Cache\Type\MemcachedCache($this->hostname, $this->config, $this->logger); + case Enum\Type::MEMCACHED: + $cache = new Type\MemcachedCache($this->hostname, $this->config, $this->logger); break; - case Cache\Enum\Type::REDIS: - $cache = new Cache\Type\RedisCache($this->hostname, $this->config); + case Enum\Type::REDIS: + $cache = new Type\RedisCache($this->hostname, $this->config); break; - case Cache\Enum\Type::APCU: - $cache = new Cache\Type\APCuCache($this->hostname); + case Enum\Type::APCU: + $cache = new Type\APCuCache($this->hostname); break; default: - $cache = new Cache\Type\DatabaseCache($this->hostname, $this->dba); + $cache = new Type\DatabaseCache($this->hostname, $this->dba); } $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 Cache\Type\ProfilerCache($cache, $this->profiler); + return new Type\ProfilerCacheDecorator($cache, $this->profiler); } else { return $cache; } diff --git a/src/Core/Cache/Type/APCuCache.php b/src/Core/Cache/Type/APCuCache.php index b473f6803..b315a5cc0 100644 --- a/src/Core/Cache/Type/APCuCache.php +++ b/src/Core/Cache/Type/APCuCache.php @@ -21,28 +21,28 @@ namespace Friendica\Core\Cache\Type; -use Exception; use Friendica\Core\Cache\Enum\Duration; -use Friendica\Core\Cache\IMemoryCache; -use Friendica\Core\Cache\Type\TraitCompareDelete; -use Friendica\Core\Cache\Type\TraitCompareSet; +use Friendica\Core\Cache\Capability\ICanCacheInMemory; use Friendica\Core\Cache\Enum\Type; +use Friendica\Core\Cache\Exception\InvalidCacheDriverException; /** * APCu Cache. */ -class APCuCache extends BaseCache implements IMemoryCache +class APCuCache extends AbstractCache implements ICanCacheInMemory { - use TraitCompareSet; - use TraitCompareDelete; + use CompareSetTrait; + use CompareDeleteTrait; /** - * @throws Exception + * @param string $hostname + * + * @throws InvalidCacheDriverException */ public function __construct(string $hostname) { if (!self::isAvailable()) { - throw new Exception('APCu is not available.'); + throw new InvalidCacheDriverException('APCu is not available.'); } parent::__construct($hostname); @@ -51,9 +51,9 @@ class APCuCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function getAllKeys($prefix = null) + public function getAllKeys(?string $prefix = null): array { - $ns = $this->getCacheKey($prefix); + $ns = $this->getCacheKey($prefix ?? ''); $ns = preg_quote($ns, '/'); if (class_exists('\APCIterator')) { @@ -73,12 +73,11 @@ class APCuCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function get($key) + public function get(string $key) { - $return = null; - $cachekey = $this->getCacheKey($key); + $cacheKey = $this->getCacheKey($key); - $cached = apcu_fetch($cachekey, $success); + $cached = apcu_fetch($cacheKey, $success); if (!$success) { return null; } @@ -89,30 +88,30 @@ class APCuCache extends BaseCache implements IMemoryCache // We also check if the db entry is a serialized // boolean 'false' value (which we want to return). if ($cached === serialize(false) || $value !== false) { - $return = $value; + return $value; } - return $return; + return null; } /** * (@inheritdoc) */ - public function set($key, $value, $ttl = Duration::FIVE_MINUTES) + public function set(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool { - $cachekey = $this->getCacheKey($key); + $cacheKey = $this->getCacheKey($key); $cached = serialize($value); if ($ttl > 0) { return apcu_store( - $cachekey, + $cacheKey, $cached, $ttl ); } else { return apcu_store( - $cachekey, + $cacheKey, $cached ); } @@ -121,16 +120,16 @@ class APCuCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function delete($key) + public function delete(string $key): bool { - $cachekey = $this->getCacheKey($key); - return apcu_delete($cachekey); + $cacheKey = $this->getCacheKey($key); + return apcu_delete($cacheKey); } /** * (@inheritdoc) */ - public function clear($outdated = true) + public function clear(bool $outdated = true): bool { if ($outdated) { return true; @@ -151,15 +150,15 @@ class APCuCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function add($key, $value, $ttl = Duration::FIVE_MINUTES) + public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool { - $cachekey = $this->getCacheKey($key); - $cached = serialize($value); + $cacheKey = $this->getCacheKey($key); + $cached = serialize($value); - return apcu_add($cachekey, $cached); + return apcu_add($cacheKey, $cached); } - public static function isAvailable() + public static function isAvailable(): bool { if (!extension_loaded('apcu')) { return false; @@ -178,7 +177,7 @@ class APCuCache extends BaseCache implements IMemoryCache /** * {@inheritDoc} */ - public function getName() + public function getName(): string { return Type::APCU; } diff --git a/src/Core/Cache/Type/BaseCache.php b/src/Core/Cache/Type/AbstractCache.php similarity index 81% rename from src/Core/Cache/Type/BaseCache.php rename to src/Core/Cache/Type/AbstractCache.php index a52f1e9ce..f4d2e9232 100644 --- a/src/Core/Cache/Type/BaseCache.php +++ b/src/Core/Cache/Type/AbstractCache.php @@ -21,12 +21,12 @@ namespace Friendica\Core\Cache\Type; -use Friendica\Core\Cache\ICache; +use Friendica\Core\Cache\Capability\ICanCache; /** * Abstract class for common used functions */ -abstract class BaseCache implements ICache +abstract class AbstractCache implements ICanCache { /** * @var string The hostname @@ -42,9 +42,8 @@ abstract class BaseCache implements ICache * Returns the prefix (to avoid namespace conflicts) * * @return string - * @throws \Exception */ - protected function getPrefix() + protected function getPrefix(): string { // We fetch with the hostname as key to avoid problems with other applications return $this->hostName; @@ -52,19 +51,20 @@ abstract class BaseCache implements ICache /** * @param string $key The original key + * * @return string The cache key used for the cache - * @throws \Exception */ - protected function getCacheKey($key) + protected function getCacheKey(string $key): string { return $this->getPrefix() . ":" . $key; } /** - * @param array $keys A list of cached keys - * @return array A list of original keys + * @param string[] $keys A list of cached keys + * + * @return string[] A list of original keys */ - protected function getOriginalKeys($keys) + protected function getOriginalKeys(array $keys): array { if (empty($keys)) { return []; @@ -84,12 +84,12 @@ abstract class BaseCache implements ICache * Filters the keys of an array with a given prefix * Returns the filtered keys as an new array * - * @param array $keys The keys, which should get filtered + * @param string[] $keys The keys, which should get filtered * @param string|null $prefix The prefix (if null, all keys will get returned) * - * @return array The filtered array with just the keys + * @return string[] The filtered array with just the keys */ - protected function filterArrayKeysByPrefix(array $keys, string $prefix = null) + protected function filterArrayKeysByPrefix(array $keys, string $prefix = null): array { if (empty($prefix)) { return $keys; diff --git a/src/Core/Cache/Type/ArrayCache.php b/src/Core/Cache/Type/ArrayCache.php index dd0985a97..879128dee 100644 --- a/src/Core/Cache/Type/ArrayCache.php +++ b/src/Core/Cache/Type/ArrayCache.php @@ -21,25 +21,23 @@ namespace Friendica\Core\Cache\Type; -use Friendica\Core\Cache\Enum\Duration; -use Friendica\Core\Cache\IMemoryCache; -use Friendica\Core\Cache\Type\TraitCompareDelete; -use Friendica\Core\Cache\Enum\Type; +use Friendica\Core\Cache\Capability\ICanCacheInMemory; +use Friendica\Core\Cache\Enum; /** * Implementation of the IMemoryCache mainly for testing purpose */ -class ArrayCache extends BaseCache implements IMemoryCache +class ArrayCache extends AbstractCache implements ICanCacheInMemory { - use TraitCompareDelete; + use CompareDeleteTrait; /** @var array Array with the cached data */ - protected $cachedData = array(); + protected $cachedData = []; /** * (@inheritdoc) */ - public function getAllKeys($prefix = null) + public function getAllKeys(?string $prefix = null): array { return $this->filterArrayKeysByPrefix(array_keys($this->cachedData), $prefix); } @@ -47,7 +45,7 @@ class ArrayCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function get($key) + public function get(string $key) { if (isset($this->cachedData[$key])) { return $this->cachedData[$key]; @@ -58,7 +56,7 @@ class ArrayCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function set($key, $value, $ttl = Duration::FIVE_MINUTES) + public function set(string $key, $value, int $ttl = Enum\Duration::FIVE_MINUTES): bool { $this->cachedData[$key] = $value; return true; @@ -67,7 +65,7 @@ class ArrayCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function delete($key) + public function delete(string $key): bool { unset($this->cachedData[$key]); return true; @@ -76,7 +74,7 @@ class ArrayCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function clear($outdated = true) + public function clear(bool $outdated = true): bool { // Array doesn't support TTL so just don't delete something if ($outdated) { @@ -90,7 +88,7 @@ class ArrayCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function add($key, $value, $ttl = Duration::FIVE_MINUTES) + public function add(string $key, $value, int $ttl = Enum\Duration::FIVE_MINUTES): bool { if (isset($this->cachedData[$key])) { return false; @@ -102,7 +100,7 @@ class ArrayCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function compareSet($key, $oldValue, $newValue, $ttl = Duration::FIVE_MINUTES) + public function compareSet(string $key, $oldValue, $newValue, int $ttl = Enum\Duration::FIVE_MINUTES): bool { if ($this->get($key) === $oldValue) { return $this->set($key, $newValue); @@ -114,8 +112,8 @@ class ArrayCache extends BaseCache implements IMemoryCache /** * {@inheritDoc} */ - public function getName() + public function getName(): string { - return Type::ARRAY; + return Enum\Type::ARRAY; } } diff --git a/src/Core/Cache/Type/TraitCompareDelete.php b/src/Core/Cache/Type/CompareDeleteTrait.php similarity index 70% rename from src/Core/Cache/Type/TraitCompareDelete.php rename to src/Core/Cache/Type/CompareDeleteTrait.php index 487363892..5dffb3080 100644 --- a/src/Core/Cache/Type/TraitCompareDelete.php +++ b/src/Core/Cache/Type/CompareDeleteTrait.php @@ -24,28 +24,28 @@ namespace Friendica\Core\Cache\Type; use Friendica\Core\Cache\Enum\Duration; /** - * Trait TraitCompareSetDelete - * - * This Trait is to compensate non native "exclusive" sets/deletes in caches + * This Trait is to compensate nonnative "exclusive" sets/deletes in caches */ -trait TraitCompareDelete +trait CompareDeleteTrait { - abstract public function get($key); + abstract public function get(string $key); - abstract public function set($key, $value, $ttl = Duration::FIVE_MINUTES); + abstract public function set(string $key, $value, int $ttl = Duration::FIVE_MINUTES); - abstract public function delete($key); + abstract public function delete(string $key); - abstract public function add($key, $value, $ttl = Duration::FIVE_MINUTES); + abstract public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES); /** * NonNative - Compares if the old value is set and removes it * - * @param string $key The cache key - * @param mixed $value The old value we know and want to delete + * @param string $key The cache key + * @param mixed $value The old value we know and want to delete + * * @return bool */ - public function compareDelete($key, $value) { + public function compareDelete(string $key, $value): bool + { if ($this->add($key . "_lock", true)) { if ($this->get($key) === $value) { $this->delete($key); diff --git a/src/Core/Cache/Type/TraitCompareSet.php b/src/Core/Cache/Type/CompareSetTrait.php similarity index 67% rename from src/Core/Cache/Type/TraitCompareSet.php rename to src/Core/Cache/Type/CompareSetTrait.php index 86aef9290..6f0eeb2c1 100644 --- a/src/Core/Cache/Type/TraitCompareSet.php +++ b/src/Core/Cache/Type/CompareSetTrait.php @@ -24,37 +24,36 @@ namespace Friendica\Core\Cache\Type; use Friendica\Core\Cache\Enum\Duration; /** - * Trait TraitCompareSetDelete - * - * This Trait is to compensate non native "exclusive" sets/deletes in caches + * This Trait is to compensate nonnative "exclusive" sets/deletes in caches */ -trait TraitCompareSet +trait CompareSetTrait { - abstract public function get($key); + abstract public function get(string $key); - abstract public function set($key, $value, $ttl = Duration::FIVE_MINUTES); + abstract public function set(string $key, $value, int $ttl = Duration::FIVE_MINUTES); - abstract public function delete($key); + abstract public function delete(string $key); - abstract public function add($key, $value, $ttl = Duration::FIVE_MINUTES); + abstract public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES); /** * NonNative - Compares if the old value is set and sets the new value * - * @param string $key The cache key - * @param mixed $oldValue The old value we know from the cache - * @param mixed $newValue The new value we want to set + * @param string $key The cache key + * @param mixed $oldValue The old value we know from the cache + * @param mixed $newValue The new value we want to set * @param int $ttl The cache lifespan, must be one of the Cache constants * * @return bool */ - public function compareSet($key, $oldValue, $newValue, $ttl = Duration::FIVE_MINUTES) { + public function compareSet(string $key, $oldValue, $newValue, int $ttl = Duration::FIVE_MINUTES): bool + { if ($this->add($key . "_lock", true)) { if ($this->get($key) === $oldValue) { $this->set($key, $newValue, $ttl); $this->delete($key . "_lock"); return true; - } else { + } else { $this->delete($key . "_lock"); return false; } diff --git a/src/Core/Cache/Type/DatabaseCache.php b/src/Core/Cache/Type/DatabaseCache.php index a3c83c8df..ef6a30afe 100644 --- a/src/Core/Cache/Type/DatabaseCache.php +++ b/src/Core/Cache/Type/DatabaseCache.php @@ -21,16 +21,16 @@ namespace Friendica\Core\Cache\Type; -use Friendica\Core\Cache\Enum\Duration; -use Friendica\Core\Cache\ICache; -use Friendica\Core\Cache\Enum\Type; +use Friendica\Core\Cache\Capability\ICanCache; +use Friendica\Core\Cache\Enum; +use Friendica\Core\Cache\Exception\CachePersistenceException; use Friendica\Database\Database; use Friendica\Util\DateTimeFormat; /** * Database Cache */ -class DatabaseCache extends BaseCache implements ICache +class DatabaseCache extends AbstractCache implements ICanCache { /** * @var Database @@ -46,22 +46,29 @@ class DatabaseCache extends BaseCache implements ICache /** * (@inheritdoc) + * + * @throws CachePersistenceException */ - public function getAllKeys($prefix = null) + public function getAllKeys(?string $prefix = null): array { - if (empty($prefix)) { - $where = ['`expires` >= ?', DateTimeFormat::utcNow()]; - } else { - $where = ['`expires` >= ? AND `k` LIKE CONCAT(?, \'%\')', DateTimeFormat::utcNow(), $prefix]; - } + try { + if (empty($prefix)) { + $where = ['`expires` >= ?', DateTimeFormat::utcNow()]; + } else { + $where = ['`expires` >= ? AND `k` LIKE CONCAT(?, \'%\')', DateTimeFormat::utcNow(), $prefix]; + } - $stmt = $this->dba->select('cache', ['k'], $where); + $stmt = $this->dba->select('cache', ['k'], $where); - $keys = []; - while ($key = $this->dba->fetch($stmt)) { - array_push($keys, $key['k']); + $keys = []; + while ($key = $this->dba->fetch($stmt)) { + array_push($keys, $key['k']); + } + } catch (\Exception $exception) { + throw new CachePersistenceException(sprintf('Cannot fetch all keys with prefix %s', $prefix), $exception); + } finally { + $this->dba->close($stmt); } - $this->dba->close($stmt); return $keys; } @@ -69,20 +76,26 @@ class DatabaseCache extends BaseCache implements ICache /** * (@inheritdoc) */ - public function get($key) + public function get(string $key) { - $cache = $this->dba->selectFirst('cache', ['v'], ['`k` = ? AND (`expires` >= ? OR `expires` = -1)', $key, DateTimeFormat::utcNow()]); + try { + $cache = $this->dba->selectFirst('cache', ['v'], [ + '`k` = ? AND (`expires` >= ? OR `expires` = -1)', $key, DateTimeFormat::utcNow() + ]); - if ($this->dba->isResult($cache)) { - $cached = $cache['v']; - $value = @unserialize($cached); + if ($this->dba->isResult($cache)) { + $cached = $cache['v']; + $value = @unserialize($cached); - // Only return a value if the serialized value is valid. - // We also check if the db entry is a serialized - // boolean 'false' value (which we want to return). - if ($cached === serialize(false) || $value !== false) { - return $value; + // Only return a value if the serialized value is valid. + // We also check if the db entry is a serialized + // boolean 'false' value (which we want to return). + if ($cached === serialize(false) || $value !== false) { + return $value; + } } + } catch (\Exception $exception) { + throw new CachePersistenceException(sprintf('Cannot get cache entry with key %s', $key), $exception); } return null; @@ -91,50 +104,62 @@ class DatabaseCache extends BaseCache implements ICache /** * (@inheritdoc) */ - public function set($key, $value, $ttl = Duration::FIVE_MINUTES) + public function set(string $key, $value, int $ttl = Enum\Duration::FIVE_MINUTES): bool { - if ($ttl > 0) { - $fields = [ - 'v' => serialize($value), - 'expires' => DateTimeFormat::utc('now + ' . $ttl . 'seconds'), - 'updated' => DateTimeFormat::utcNow() - ]; - } else { - $fields = [ - 'v' => serialize($value), - 'expires' => -1, - 'updated' => DateTimeFormat::utcNow() - ]; + try { + if ($ttl > 0) { + $fields = [ + 'v' => serialize($value), + 'expires' => DateTimeFormat::utc('now + ' . $ttl . 'seconds'), + 'updated' => DateTimeFormat::utcNow() + ]; + } else { + $fields = [ + 'v' => serialize($value), + 'expires' => -1, + 'updated' => DateTimeFormat::utcNow() + ]; + } + + return $this->dba->update('cache', $fields, ['k' => $key], true); + } catch (\Exception $exception) { + throw new CachePersistenceException(sprintf('Cannot set cache entry with key %s', $key), $exception); } - - return $this->dba->update('cache', $fields, ['k' => $key], true); } /** * (@inheritdoc) */ - public function delete($key) + public function delete(string $key): bool { - return $this->dba->delete('cache', ['k' => $key]); + try { + return $this->dba->delete('cache', ['k' => $key]); + } catch (\Exception $exception) { + throw new CachePersistenceException(sprintf('Cannot delete cache entry with key %s', $key), $exception); + } } /** * (@inheritdoc) */ - public function clear($outdated = true) + public function clear(bool $outdated = true): bool { - if ($outdated) { - return $this->dba->delete('cache', ['`expires` < NOW()']); - } else { - return $this->dba->delete('cache', ['`k` IS NOT NULL ']); + try { + if ($outdated) { + return $this->dba->delete('cache', ['`expires` < NOW()']); + } else { + return $this->dba->delete('cache', ['`k` IS NOT NULL ']); + } + } catch (\Exception $exception) { + throw new CachePersistenceException('Cannot clear cache', $exception); } } /** * {@inheritDoc} */ - public function getName() + public function getName(): string { - return Type::DATABASE; + return Enum\Type::DATABASE; } } diff --git a/src/Core/Cache/Type/MemcacheCache.php b/src/Core/Cache/Type/MemcacheCache.php index f991517fc..a8a183daa 100644 --- a/src/Core/Cache/Type/MemcacheCache.php +++ b/src/Core/Cache/Type/MemcacheCache.php @@ -21,24 +21,22 @@ namespace Friendica\Core\Cache\Type; -use Exception; use Friendica\Core\Cache\Enum\Duration; -use Friendica\Core\Cache\IMemoryCache; -use Friendica\Core\Cache\Type\TraitCompareDelete; -use Friendica\Core\Cache\Type\TraitCompareSet; -use Friendica\Core\Cache\Type\TraitMemcacheCommand; +use Friendica\Core\Cache\Capability\ICanCacheInMemory; use Friendica\Core\Cache\Enum\Type; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Cache\Exception\CachePersistenceException; +use Friendica\Core\Cache\Exception\InvalidCacheDriverException; +use Friendica\Core\Config\Capability\IManageConfigValues; use Memcache; /** * Memcache Cache */ -class MemcacheCache extends BaseCache implements IMemoryCache +class MemcacheCache extends AbstractCache implements ICanCacheInMemory { - use TraitCompareSet; - use TraitCompareDelete; - use TraitMemcacheCommand; + use CompareSetTrait; + use CompareDeleteTrait; + use MemcacheCommandTrait; /** * @var Memcache @@ -46,30 +44,34 @@ class MemcacheCache extends BaseCache implements IMemoryCache private $memcache; /** - * @throws Exception + * @param string $hostname + * @param IManageConfigValues $config + * + * @throws InvalidCacheDriverException + * @throws CachePersistenceException */ - public function __construct(string $hostname, IConfig $config) + public function __construct(string $hostname, IManageConfigValues $config) { if (!class_exists('Memcache', false)) { - throw new Exception('Memcache class isn\'t available'); + throw new InvalidCacheDriverException('Memcache class isn\'t available'); } parent::__construct($hostname); $this->memcache = new Memcache(); - $this->server = $config->get('system', 'memcache_host');; - $this->port = $config->get('system', 'memcache_port'); + $this->server = $config->get('system', 'memcache_host'); + $this->port = $config->get('system', 'memcache_port'); if (!@$this->memcache->connect($this->server, $this->port)) { - throw new Exception('Expected Memcache server at ' . $this->server . ':' . $this->port . ' isn\'t available'); + throw new CachePersistenceException('Expected Memcache server at ' . $this->server . ':' . $this->port . ' isn\'t available'); } } /** * (@inheritdoc) */ - public function getAllKeys($prefix = null) + public function getAllKeys(?string $prefix = null): array { $keys = $this->getOriginalKeys($this->getMemcacheKeys()); @@ -79,17 +81,16 @@ class MemcacheCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function get($key) + public function get(string $key) { - $return = null; - $cachekey = $this->getCacheKey($key); + $cacheKey = $this->getCacheKey($key); // We fetch with the hostname as key to avoid problems with other applications - $cached = $this->memcache->get($cachekey); + $cached = $this->memcache->get($cacheKey); // @see http://php.net/manual/en/memcache.get.php#84275 if (is_bool($cached) || is_double($cached) || is_long($cached)) { - return $return; + return null; } $value = @unserialize($cached); @@ -98,30 +99,30 @@ class MemcacheCache extends BaseCache implements IMemoryCache // We also check if the db entry is a serialized // boolean 'false' value (which we want to return). if ($cached === serialize(false) || $value !== false) { - $return = $value; + return $value; } - return $return; + return null; } /** * (@inheritdoc) */ - public function set($key, $value, $ttl = Duration::FIVE_MINUTES) + public function set(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool { - $cachekey = $this->getCacheKey($key); + $cacheKey = $this->getCacheKey($key); // We store with the hostname as key to avoid problems with other applications if ($ttl > 0) { return $this->memcache->set( - $cachekey, + $cacheKey, serialize($value), MEMCACHE_COMPRESSED, time() + $ttl ); } else { return $this->memcache->set( - $cachekey, + $cacheKey, serialize($value), MEMCACHE_COMPRESSED ); @@ -131,16 +132,16 @@ class MemcacheCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function delete($key) + public function delete(string $key): bool { - $cachekey = $this->getCacheKey($key); - return $this->memcache->delete($cachekey); + $cacheKey = $this->getCacheKey($key); + return $this->memcache->delete($cacheKey); } /** * (@inheritdoc) */ - public function clear($outdated = true) + public function clear(bool $outdated = true): bool { if ($outdated) { return true; @@ -152,16 +153,16 @@ class MemcacheCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function add($key, $value, $ttl = Duration::FIVE_MINUTES) + public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool { - $cachekey = $this->getCacheKey($key); - return $this->memcache->add($cachekey, serialize($value), MEMCACHE_COMPRESSED, $ttl); + $cacheKey = $this->getCacheKey($key); + return $this->memcache->add($cacheKey, serialize($value), MEMCACHE_COMPRESSED, $ttl); } /** * {@inheritDoc} */ - public function getName() + public function getName(): string { return Type::MEMCACHE; } diff --git a/src/Core/Cache/Type/TraitMemcacheCommand.php b/src/Core/Cache/Type/MemcacheCommandTrait.php similarity index 81% rename from src/Core/Cache/Type/TraitMemcacheCommand.php rename to src/Core/Cache/Type/MemcacheCommandTrait.php index 73495e2de..10315d67b 100644 --- a/src/Core/Cache/Type/TraitMemcacheCommand.php +++ b/src/Core/Cache/Type/MemcacheCommandTrait.php @@ -21,7 +21,7 @@ namespace Friendica\Core\Cache\Type; -use Friendica\Network\HTTPException\InternalServerErrorException; +use Friendica\Core\Cache\Exception\CachePersistenceException; /** * Trait for Memcache to add a custom version of the @@ -29,7 +29,7 @@ use Friendica\Network\HTTPException\InternalServerErrorException; * * Adds the possibility to directly communicate with the memcache too */ -trait TraitMemcacheCommand +trait MemcacheCommandTrait { /** * @var string server address @@ -52,23 +52,19 @@ trait TraitMemcacheCommand * * @return array All keys of the memcache instance * - * @throws InternalServerErrorException + * @throws CachePersistenceException */ - protected function getMemcacheKeys() + protected function getMemcacheKeys(): array { $string = $this->sendMemcacheCommand("stats items"); $lines = explode("\r\n", $string); - $slabs = []; $keys = []; foreach ($lines as $line) { - if (preg_match("/STAT items:([\d]+):number ([\d]+)/", $line, $matches) && - isset($matches[1]) && - !in_array($matches[1], $keys)) { - - $slabs[] = $matches[1]; - $string = $this->sendMemcacheCommand("stats cachedump " . $matches[1] . " " . $matches[2]); + isset($matches[1]) && + !in_array($matches[1], $keys)) { + $string = $this->sendMemcacheCommand("stats cachedump " . $matches[1] . " " . $matches[2]); preg_match_all("/ITEM (.*?) /", $string, $matches); $keys = array_merge($keys, $matches[1]); } @@ -88,20 +84,19 @@ trait TraitMemcacheCommand * * @return string The returned buffer result * - * @throws InternalServerErrorException In case the memcache server isn't available (anymore) + * @throws CachePersistenceException In case the memcache server isn't available (anymore) */ - protected function sendMemcacheCommand(string $command) + protected function sendMemcacheCommand(string $command): string { $s = @fsockopen($this->server, $this->port); if (!$s) { - throw new InternalServerErrorException("Cant connect to:" . $this->server . ':' . $this->port); + throw new CachePersistenceException("Cant connect to:" . $this->server . ':' . $this->port); } fwrite($s, $command . "\r\n"); $buf = ''; while (!feof($s)) { - $buf .= fgets($s, 256); if (strpos($buf, "END\r\n") !== false) { // stat says end diff --git a/src/Core/Cache/Type/MemcachedCache.php b/src/Core/Cache/Type/MemcachedCache.php index ded53ee97..7aff735ce 100644 --- a/src/Core/Cache/Type/MemcachedCache.php +++ b/src/Core/Cache/Type/MemcachedCache.php @@ -21,25 +21,23 @@ namespace Friendica\Core\Cache\Type; -use Exception; use Friendica\Core\Cache\Enum\Duration; -use Friendica\Core\Cache\IMemoryCache; -use Friendica\Core\Cache\Type\TraitCompareDelete; -use Friendica\Core\Cache\Type\TraitCompareSet; -use Friendica\Core\Cache\Type\TraitMemcacheCommand; +use Friendica\Core\Cache\Capability\ICanCacheInMemory; use Friendica\Core\Cache\Enum\Type; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Cache\Exception\CachePersistenceException; +use Friendica\Core\Cache\Exception\InvalidCacheDriverException; +use Friendica\Core\Config\Capability\IManageConfigValues; use Memcached; use Psr\Log\LoggerInterface; /** * Memcached Cache */ -class MemcachedCache extends BaseCache implements IMemoryCache +class MemcachedCache extends AbstractCache implements ICanCacheInMemory { - use TraitCompareSet; - use TraitCompareDelete; - use TraitMemcacheCommand; + use CompareSetTrait; + use CompareDeleteTrait; + use MemcacheCommandTrait; /** * @var \Memcached @@ -58,14 +56,17 @@ class MemcachedCache extends BaseCache implements IMemoryCache * 1 => ... * } * - * @param array $memcached_hosts + * @param string $hostname + * @param IManageConfigValues $config + * @param LoggerInterface $logger * - * @throws \Exception + * @throws InvalidCacheDriverException + * @throws CachePersistenceException */ - public function __construct(string $hostname, IConfig $config, LoggerInterface $logger) + public function __construct(string $hostname, IManageConfigValues $config, LoggerInterface $logger) { if (!class_exists('Memcached', false)) { - throw new Exception('Memcached class isn\'t available'); + throw new InvalidCacheDriverException('Memcached class isn\'t available'); } parent::__construct($hostname); @@ -83,19 +84,19 @@ class MemcachedCache extends BaseCache implements IMemoryCache }); $this->server = $memcached_hosts[0][0] ?? 'localhost'; - $this->port = $memcached_hosts[0][1] ?? 11211; + $this->port = $memcached_hosts[0][1] ?? 11211; $this->memcached->addServers($memcached_hosts); if (count($this->memcached->getServerList()) == 0) { - throw new Exception('Expected Memcached servers aren\'t available, config:' . var_export($memcached_hosts, true)); + throw new CachePersistenceException('Expected Memcached servers aren\'t available, config:' . var_export($memcached_hosts, true)); } } /** * (@inheritdoc) */ - public function getAllKeys($prefix = null) + public function getAllKeys(?string $prefix = null): array { $keys = $this->getOriginalKeys($this->getMemcacheKeys()); @@ -105,40 +106,40 @@ class MemcachedCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function get($key) + public function get(string $key) { - $return = null; - $cachekey = $this->getCacheKey($key); + $cacheKey = $this->getCacheKey($key); // We fetch with the hostname as key to avoid problems with other applications - $value = $this->memcached->get($cachekey); + $value = $this->memcached->get($cacheKey); if ($this->memcached->getResultCode() === Memcached::RES_SUCCESS) { - $return = $value; + return $value; + } elseif ($this->memcached->getResultCode() === Memcached::RES_NOTFOUND) { + $this->logger->notice('Try to use unknown key.', ['key' => $key]); + return null; } else { - $this->logger->debug('Memcached \'get\' failed', ['result' => $this->memcached->getResultMessage()]); + throw new CachePersistenceException(sprintf('Cannot get cache entry with key %s', $key), new \MemcachedException($this->memcached->getResultMessage(), $this->memcached->getResultCode())); } - - return $return; } /** * (@inheritdoc) */ - public function set($key, $value, $ttl = Duration::FIVE_MINUTES) + public function set(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool { - $cachekey = $this->getCacheKey($key); + $cacheKey = $this->getCacheKey($key); // We store with the hostname as key to avoid problems with other applications if ($ttl > 0) { return $this->memcached->set( - $cachekey, + $cacheKey, $value, $ttl ); } else { return $this->memcached->set( - $cachekey, + $cacheKey, $value ); } @@ -147,16 +148,16 @@ class MemcachedCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function delete($key) + public function delete(string $key): bool { - $cachekey = $this->getCacheKey($key); - return $this->memcached->delete($cachekey); + $cacheKey = $this->getCacheKey($key); + return $this->memcached->delete($cacheKey); } /** * (@inheritdoc) */ - public function clear($outdated = true) + public function clear(bool $outdated = true): bool { if ($outdated) { return true; @@ -168,16 +169,16 @@ class MemcachedCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function add($key, $value, $ttl = Duration::FIVE_MINUTES) + public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool { - $cachekey = $this->getCacheKey($key); - return $this->memcached->add($cachekey, $value, $ttl); + $cacheKey = $this->getCacheKey($key); + return $this->memcached->add($cacheKey, $value, $ttl); } /** * {@inheritDoc} */ - public function getName() + public function getName(): string { return Type::MEMCACHED; } diff --git a/src/Core/Cache/Type/ProfilerCache.php b/src/Core/Cache/Type/ProfilerCacheDecorator.php similarity index 70% rename from src/Core/Cache/Type/ProfilerCache.php rename to src/Core/Cache/Type/ProfilerCacheDecorator.php index fd003857c..11b1755ed 100644 --- a/src/Core/Cache/Type/ProfilerCache.php +++ b/src/Core/Cache/Type/ProfilerCacheDecorator.php @@ -22,19 +22,19 @@ namespace Friendica\Core\Cache\Type; use Friendica\Core\Cache\Enum\Duration; -use Friendica\Core\Cache\ICache; -use Friendica\Core\Cache\IMemoryCache; +use Friendica\Core\Cache\Capability\ICanCache; +use Friendica\Core\Cache\Capability\ICanCacheInMemory; use Friendica\Util\Profiler; /** - * This class wraps cache driver so they can get profiled - in case the profiler is enabled + * This class wraps cache driver, so they can get profiled - in case the profiler is enabled * - * It is using the decorator pattern (@see + * It is using the decorator pattern (@see https://en.wikipedia.org/wiki/Decorator_pattern ) */ -class ProfilerCache implements ICache, IMemoryCache +class ProfilerCacheDecorator implements ICanCache, ICanCacheInMemory { /** - * @var ICache The original cache driver + * @var ICanCache The original cache driver */ private $cache; @@ -43,7 +43,7 @@ class ProfilerCache implements ICache, IMemoryCache */ private $profiler; - public function __construct(ICache $cache, Profiler $profiler) + public function __construct(ICanCache $cache, Profiler $profiler) { $this->cache = $cache; $this->profiler = $profiler; @@ -52,7 +52,7 @@ class ProfilerCache implements ICache, IMemoryCache /** * {@inheritDoc} */ - public function getAllKeys($prefix = null) + public function getAllKeys(?string $prefix = null): array { $this->profiler->startRecording('cache'); @@ -66,7 +66,7 @@ class ProfilerCache implements ICache, IMemoryCache /** * {@inheritDoc} */ - public function get($key) + public function get(string $key) { $this->profiler->startRecording('cache'); @@ -80,7 +80,7 @@ class ProfilerCache implements ICache, IMemoryCache /** * {@inheritDoc} */ - public function set($key, $value, $ttl = Duration::FIVE_MINUTES) + public function set(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool { $this->profiler->startRecording('cache'); @@ -94,7 +94,7 @@ class ProfilerCache implements ICache, IMemoryCache /** * {@inheritDoc} */ - public function delete($key) + public function delete(string $key): bool { $this->profiler->startRecording('cache'); @@ -108,7 +108,7 @@ class ProfilerCache implements ICache, IMemoryCache /** * {@inheritDoc} */ - public function clear($outdated = true) + public function clear(bool $outdated = true): bool { $this->profiler->startRecording('cache'); @@ -122,9 +122,9 @@ class ProfilerCache implements ICache, IMemoryCache /** * {@inheritDoc} */ - public function add($key, $value, $ttl = Duration::FIVE_MINUTES) + public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool { - if ($this->cache instanceof IMemoryCache) { + if ($this->cache instanceof ICanCacheInMemory) { $this->profiler->startRecording('cache'); $return = $this->cache->add($key, $value, $ttl); @@ -140,9 +140,9 @@ class ProfilerCache implements ICache, IMemoryCache /** * {@inheritDoc} */ - public function compareSet($key, $oldValue, $newValue, $ttl = Duration::FIVE_MINUTES) + public function compareSet(string $key, $oldValue, $newValue, int $ttl = Duration::FIVE_MINUTES): bool { - if ($this->cache instanceof IMemoryCache) { + if ($this->cache instanceof ICanCacheInMemory) { $this->profiler->startRecording('cache'); $return = $this->cache->compareSet($key, $oldValue, $newValue, $ttl); @@ -158,9 +158,9 @@ class ProfilerCache implements ICache, IMemoryCache /** * {@inheritDoc} */ - public function compareDelete($key, $value) + public function compareDelete(string $key, $value): bool { - if ($this->cache instanceof IMemoryCache) { + if ($this->cache instanceof ICanCacheInMemory) { $this->profiler->startRecording('cache'); $return = $this->cache->compareDelete($key, $value); @@ -176,7 +176,7 @@ class ProfilerCache implements ICache, IMemoryCache /** * {@inheritDoc} */ - public function GetName() + public function GetName(): string { return $this->cache->getName() . ' (with profiler)'; } diff --git a/src/Core/Cache/Type/RedisCache.php b/src/Core/Cache/Type/RedisCache.php index a4cc41972..494bd83d3 100644 --- a/src/Core/Cache/Type/RedisCache.php +++ b/src/Core/Cache/Type/RedisCache.php @@ -23,15 +23,17 @@ namespace Friendica\Core\Cache\Type; use Exception; use Friendica\Core\Cache\Enum\Duration; -use Friendica\Core\Cache\IMemoryCache; +use Friendica\Core\Cache\Capability\ICanCacheInMemory; use Friendica\Core\Cache\Enum\Type; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Cache\Exception\CachePersistenceException; +use Friendica\Core\Cache\Exception\InvalidCacheDriverException; +use Friendica\Core\Config\Capability\IManageConfigValues; use Redis; /** * Redis Cache. This driver is based on Memcache driver */ -class RedisCache extends BaseCache implements IMemoryCache +class RedisCache extends AbstractCache implements ICanCacheInMemory { /** * @var Redis @@ -39,12 +41,13 @@ class RedisCache extends BaseCache implements IMemoryCache private $redis; /** - * @throws Exception + * @throws InvalidCacheDriverException + * @throws CachePersistenceException */ - public function __construct(string $hostname, IConfig $config) + public function __construct(string $hostname, IManageConfigValues $config) { if (!class_exists('Redis', false)) { - throw new Exception('Redis class isn\'t available'); + throw new InvalidCacheDriverException('Redis class isn\'t available'); } parent::__construct($hostname); @@ -57,24 +60,24 @@ class RedisCache extends BaseCache implements IMemoryCache $redis_db = $config->get('system', 'redis_db', 0); if (isset($redis_port) && !@$this->redis->connect($redis_host, $redis_port)) { - throw new Exception('Expected Redis server at ' . $redis_host . ':' . $redis_port . ' isn\'t available'); + throw new CachePersistenceException('Expected Redis server at ' . $redis_host . ':' . $redis_port . ' isn\'t available'); } elseif (!@$this->redis->connect($redis_host)) { - throw new Exception('Expected Redis server at ' . $redis_host . ' isn\'t available'); + throw new CachePersistenceException('Expected Redis server at ' . $redis_host . ' isn\'t available'); } if (isset($redis_pw) && !$this->redis->auth($redis_pw)) { - throw new Exception('Cannot authenticate redis server at ' . $redis_host . ':' . $redis_port); + throw new CachePersistenceException('Cannot authenticate redis server at ' . $redis_host . ':' . $redis_port); } if ($redis_db !== 0 && !$this->redis->select($redis_db)) { - throw new Exception('Cannot switch to redis db ' . $redis_db . ' at ' . $redis_host . ':' . $redis_port); + throw new CachePersistenceException('Cannot switch to redis db ' . $redis_db . ' at ' . $redis_host . ':' . $redis_port); } } /** * (@inheritdoc) */ - public function getAllKeys($prefix = null) + public function getAllKeys(?string $prefix = null): array { if (empty($prefix)) { $search = '*'; @@ -90,13 +93,13 @@ class RedisCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function get($key) + public function get(string $key) { - $return = null; - $cachekey = $this->getCacheKey($key); + $return = null; + $cacheKey = $this->getCacheKey($key); - $cached = $this->redis->get($cachekey); - if ($cached === false && !$this->redis->exists($cachekey)) { + $cached = $this->redis->get($cacheKey); + if ($cached === false && !$this->redis->exists($cacheKey)) { return null; } @@ -115,21 +118,21 @@ class RedisCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function set($key, $value, $ttl = Duration::FIVE_MINUTES) + public function set(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool { - $cachekey = $this->getCacheKey($key); + $cacheKey = $this->getCacheKey($key); $cached = serialize($value); if ($ttl > 0) { return $this->redis->setex( - $cachekey, + $cacheKey, $ttl, $cached ); } else { return $this->redis->set( - $cachekey, + $cacheKey, $cached ); } @@ -138,10 +141,10 @@ class RedisCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function delete($key) + public function delete(string $key): bool { - $cachekey = $this->getCacheKey($key); - $this->redis->del($cachekey); + $cacheKey = $this->getCacheKey($key); + $this->redis->del($cacheKey); // Redis doesn't have an error state for del() return true; } @@ -149,7 +152,7 @@ class RedisCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function clear($outdated = true) + public function clear(bool $outdated = true): bool { if ($outdated) { return true; @@ -161,34 +164,30 @@ class RedisCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function add($key, $value, $ttl = Duration::FIVE_MINUTES) + public function add(string $key, $value, int $ttl = Duration::FIVE_MINUTES): bool { - $cachekey = $this->getCacheKey($key); - $cached = serialize($value); + $cacheKey = $this->getCacheKey($key); + $cached = serialize($value); - return $this->redis->setnx($cachekey, $cached); + return $this->redis->setnx($cacheKey, $cached); } /** * (@inheritdoc) */ - public function compareSet($key, $oldValue, $newValue, $ttl = Duration::FIVE_MINUTES) + public function compareSet(string $key, $oldValue, $newValue, int $ttl = Duration::FIVE_MINUTES): bool { - $cachekey = $this->getCacheKey($key); + $cacheKey = $this->getCacheKey($key); $newCached = serialize($newValue); - $this->redis->watch($cachekey); + $this->redis->watch($cacheKey); // If the old value isn't what we expected, somebody else changed the key meanwhile if ($this->get($key) === $oldValue) { if ($ttl > 0) { - $result = $this->redis->multi() - ->setex($cachekey, $ttl, $newCached) - ->exec(); + $result = $this->redis->multi()->setex($cacheKey, $ttl, $newCached)->exec(); } else { - $result = $this->redis->multi() - ->set($cachekey, $newCached) - ->exec(); + $result = $this->redis->multi()->set($cacheKey, $newCached)->exec(); } return $result !== false; } @@ -199,17 +198,15 @@ class RedisCache extends BaseCache implements IMemoryCache /** * (@inheritdoc) */ - public function compareDelete($key, $value) + public function compareDelete(string $key, $value): bool { - $cachekey = $this->getCacheKey($key); + $cacheKey = $this->getCacheKey($key); - $this->redis->watch($cachekey); + $this->redis->watch($cacheKey); // If the old value isn't what we expected, somebody else changed the key meanwhile if ($this->get($key) === $value) { - $result = $this->redis->multi() - ->del($cachekey) - ->exec(); - return $result !== false; + $this->redis->multi()->del($cacheKey)->exec(); + return true; } $this->redis->unwatch(); return false; @@ -218,7 +215,7 @@ class RedisCache extends BaseCache implements IMemoryCache /** * {@inheritDoc} */ - public function getName() + public function getName(): string { return Type::REDIS; } diff --git a/src/Core/Config/IConfig.php b/src/Core/Config/Capability/IManageConfigValues.php similarity index 66% rename from src/Core/Config/IConfig.php rename to src/Core/Config/Capability/IManageConfigValues.php index 21cee2e92..09e70ba6d 100644 --- a/src/Core/Config/IConfig.php +++ b/src/Core/Config/Capability/IManageConfigValues.php @@ -19,32 +19,35 @@ * */ -namespace Friendica\Core\Config; +namespace Friendica\Core\Config\Capability; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\Exception\ConfigPersistenceException; +use Friendica\Core\Config\ValueObject\Cache; /** - * Interface for accessing system wide configurations + * Interface for accessing system-wide configurations */ -interface IConfig +interface IManageConfigValues { - /** * Loads all configuration values of family into a cached storage. * - * All configuration values of the system are stored in the cache ( @param string $cat The category of the configuration value + * All configuration values of the system are stored in the cache. + * + * @param string $cat The category of the configuration value * * @return void + * + * @throws ConfigPersistenceException In case the persistence layer throws errors */ - function load(string $cat = 'config'); + public function load(string $cat = 'config'); /** * Get a particular user's config variable given the category name * ($cat) and a $key. * * Get a particular config value from the given category ($cat) - * and the $key from a cached storage either from the $this->configAdapter - * (@see IConfigAdapter) or from the $this->configCache (@see ConfigCache). + * and the $key from a cached storage either from the database or from the cache. * * @param string $cat The category of the configuration value * @param string $key The configuration key to query @@ -52,8 +55,11 @@ interface IConfig * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false) * * @return mixed Stored value or null if it does not exist + * + * @throws ConfigPersistenceException In case the persistence layer throws errors + * */ - function get(string $cat, string $key, $default_value = null, bool $refresh = false); + public function get(string $cat, string $key, $default_value = null, bool $refresh = false); /** * Sets a configuration value for system config @@ -67,26 +73,30 @@ interface IConfig * @param mixed $value The value to store * * @return bool Operation success + * + * @throws ConfigPersistenceException In case the persistence layer throws errors */ - function set(string $cat, string $key, $value); + public function set(string $cat, string $key, $value): bool; /** * Deletes the given key from the system configuration. * - * Removes the configured value from the stored cache in $this->configCache - * (@see ConfigCache) and removes it from the database (@see IConfigAdapter). + * Removes the configured value from the stored cache in the cache and removes it from the database. * * @param string $cat The category of the configuration value * @param string $key The configuration key to delete * * @return bool + * + * @throws ConfigPersistenceException In case the persistence layer throws errors + * */ - function delete(string $cat, string $key); + public function delete(string $cat, string $key): bool; /** * Returns the Config Cache * * @return Cache */ - function getCache(); + public function getCache(): Cache; } diff --git a/src/Core/Config/Exception/ConfigFileException.php b/src/Core/Config/Exception/ConfigFileException.php new file mode 100644 index 000000000..e8d6cd657 --- /dev/null +++ b/src/Core/Config/Exception/ConfigFileException.php @@ -0,0 +1,13 @@ +setupCache($configCache, $server); @@ -84,20 +83,19 @@ class ConfigFactory } /** - * @param \Friendica\Core\Config\Cache\Cache $configCache The config cache of this adapter - * @param ConfigModel $configModel The configuration model + * @param Cache $configCache The config cache of this adapter + * @param Repository\Config $configRepo The configuration repository * - * @return Config\IConfig + * @return Capability\IManageConfigValues */ - public function create(Cache $configCache, ConfigModel $configModel) + public function create(Cache $configCache, Repository\Config $configRepo) { if ($configCache->get('system', 'config_adapter') === 'preload') { - $configuration = new Config\Type\PreloadConfig($configCache, $configModel); + $configuration = new Type\PreloadConfig($configCache, $configRepo); } else { - $configuration = new Config\Type\JitConfig($configCache, $configModel); + $configuration = new Type\JitConfig($configCache, $configRepo); } - return $configuration; } } diff --git a/src/Core/Config/Model/Config.php b/src/Core/Config/Repository/Config.php similarity index 52% rename from src/Core/Config/Model/Config.php rename to src/Core/Config/Repository/Config.php index bca2145fb..db03a86d0 100644 --- a/src/Core/Config/Model/Config.php +++ b/src/Core/Config/Repository/Config.php @@ -19,34 +19,35 @@ * */ -namespace Friendica\Core\Config\Model; +namespace Friendica\Core\Config\Repository; +use Friendica\Core\Config\Exception\ConfigPersistenceException; +use Friendica\Core\Config\Util\ValueConversion; use Friendica\Database\Database; /** - * The Config model backend, which is using the general DB-model backend for configs + * The Config Repository, which is using the general DB-model backend for configs */ class Config { /** @var Database */ - protected $dba; + protected $db; - /** - * @param Database $dba The database connection of this model - */ - public function __construct(Database $dba) + public function __construct(Database $db) { - $this->dba = $dba; + $this->db = $db; } + protected static $table_name = 'config'; + /** * Checks if the model is currently connected * * @return bool */ - public function isConnected() + public function isConnected(): bool { - return $this->dba->isConnected(); + return $this->db->isConnected(); } /** @@ -56,29 +57,33 @@ class Config * * @return array The config array * - * @throws \Exception In case DB calls are invalid + * @throws ConfigPersistenceException In case the persistence layer throws errors */ - public function load(string $cat = null) + public function load(?string $cat = null): array { $return = []; - if (empty($cat)) { - $configs = $this->dba->select('config', ['cat', 'v', 'k']); - } else { - $configs = $this->dba->select('config', ['cat', 'v', 'k'], ['cat' => $cat]); - } - - while ($config = $this->dba->fetch($configs)) { - - $key = $config['k']; - $value = DbaUtils::toConfigValue($config['v']); - - // just save it in case it is set - if (isset($value)) { - $return[$config['cat']][$key] = $value; + try { + if (empty($cat)) { + $configs = $this->db->select(static::$table_name, ['cat', 'v', 'k']); + } else { + $configs = $this->db->select(static::$table_name, ['cat', 'v', 'k'], ['cat' => $cat]); } + + while ($config = $this->db->fetch($configs)) { + $key = $config['k']; + $value = ValueConversion::toConfigValue($config['v']); + + // just save it in case it is set + if (isset($value)) { + $return[$config['cat']][$key] = $value; + } + } + } catch (\Exception $exception) { + throw new ConfigPersistenceException(sprintf('Cannot load config category %s', $cat), $exception); + } finally { + $this->db->close($configs); } - $this->dba->close($configs); return $return; } @@ -94,7 +99,7 @@ class Config * * @return array|string|null Stored value or null if it does not exist * - * @throws \Exception In case DB calls are invalid + * @throws ConfigPersistenceException In case the persistence layer throws errors */ public function get(string $cat, string $key) { @@ -102,14 +107,18 @@ class Config return null; } - $config = $this->dba->selectFirst('config', ['v'], ['cat' => $cat, 'k' => $key]); - if ($this->dba->isResult($config)) { - $value = DbaUtils::toConfigValue($config['v']); + try { + $config = $this->db->selectFirst(static::$table_name, ['v'], ['cat' => $cat, 'k' => $key]); + if ($this->db->isResult($config)) { + $value = ValueConversion::toConfigValue($config['v']); - // just return it in case it is set - if (isset($value)) { - return $value; + // just return it in case it is set + if (isset($value)) { + return $value; + } } + } catch (\Exception $exception) { + throw new ConfigPersistenceException(sprintf('Cannot get config with category %s and key %s', $cat, $key), $exception); } return null; @@ -126,9 +135,9 @@ class Config * * @return bool Operation success * - * @throws \Exception In case DB calls are invalid + * @throws ConfigPersistenceException In case the persistence layer throws errors */ - public function set(string $cat, string $key, $value) + public function set(string $cat, string $key, $value): bool { if (!$this->isConnected()) { return false; @@ -144,11 +153,13 @@ class Config return true; } - $dbvalue = DbaUtils::toDbValue($value); + $dbValue = ValueConversion::toDbValue($value); - $result = $this->dba->update('config', ['v' => $dbvalue], ['cat' => $cat, 'k' => $key], true); - - return $result; + try { + return $this->db->update(static::$table_name, ['v' => $dbValue], ['cat' => $cat, 'k' => $key], true); + } catch (\Exception $exception) { + throw new ConfigPersistenceException(sprintf('Cannot set config with category %s and key %s', $cat, $key), $exception); + } } /** @@ -159,14 +170,18 @@ class Config * * @return bool Operation success * - * @throws \Exception In case DB calls are invalid + * @throws ConfigPersistenceException In case the persistence layer throws errors */ - public function delete(string $cat, string $key) + public function delete(string $cat, string $key): bool { if (!$this->isConnected()) { return false; } - return $this->dba->delete('config', ['cat' => $cat, 'k' => $key]); + try { + return $this->db->delete(static::$table_name, ['cat' => $cat, 'k' => $key]); + } catch (\Exception $exception) { + throw new ConfigPersistenceException(sprintf('Cannot delete config with category %s and key %s', $cat, $key), $exception); + } } } diff --git a/src/Core/Config/Type/BaseConfig.php b/src/Core/Config/Type/AbstractConfig.php similarity index 61% rename from src/Core/Config/Type/BaseConfig.php rename to src/Core/Config/Type/AbstractConfig.php index 86a847a7b..782f0e7c5 100644 --- a/src/Core/Config/Type/BaseConfig.php +++ b/src/Core/Config/Type/AbstractConfig.php @@ -21,17 +21,17 @@ namespace Friendica\Core\Config\Type; -use Friendica\Core\Config\Cache\Cache; -use Friendica\Core\Config\IConfig; -use Friendica\Model; +use Friendica\Core\Config\Repository\Config; +use Friendica\Core\Config\ValueObject\Cache; +use Friendica\Core\Config\Capability\IManageConfigValues; /** * This class is responsible for all system-wide configuration values in Friendica * There are two types of storage - * - The Config-Files (loaded into the FileCache @see ConfigCache) - * - The Config-DB-Table (per Config-DB-model @see Model\Config\Config) + * - The Config-Files (loaded into the FileCache @see Cache) + * - The Config-Repository (per Config-Repository @see Config ) */ -abstract class BaseConfig implements IConfig +abstract class AbstractConfig implements IManageConfigValues { /** * @var Cache @@ -39,24 +39,24 @@ abstract class BaseConfig implements IConfig protected $configCache; /** - * @var \Friendica\Core\Config\Model\Config + * @var Config */ - protected $configModel; + protected $configRepo; /** - * @param Cache $configCache The configuration cache (based on the config-files) - * @param \Friendica\Core\Config\Model\Config $configModel The configuration model + * @param Cache $configCache The configuration cache (based on the config-files) + * @param Config $configRepo The configuration repository */ - public function __construct(Cache $configCache, \Friendica\Core\Config\Model\Config $configModel) + public function __construct(Cache $configCache, Config $configRepo) { $this->configCache = $configCache; - $this->configModel = $configModel; + $this->configRepo = $configRepo; } /** * {@inheritDoc} */ - public function getCache() + public function getCache(): Cache { return $this->configCache; } diff --git a/src/Core/Config/Type/JitConfig.php b/src/Core/Config/Type/JitConfig.php index 5e1fe24c4..b9b897f95 100644 --- a/src/Core/Config/Type/JitConfig.php +++ b/src/Core/Config/Type/JitConfig.php @@ -21,8 +21,8 @@ namespace Friendica\Core\Config\Type; -use Friendica\Core\Config\Cache\Cache; -use Friendica\Core\Config\Model\Config; +use Friendica\Core\Config\ValueObject\Cache; +use Friendica\Core\Config\Repository\Config; /** * This class implements the Just-In-Time configuration, which will cache @@ -31,7 +31,7 @@ use Friendica\Core\Config\Model\Config; * Default Configuration type. * Provides the best performance for pages loading few configuration variables. */ -class JitConfig extends BaseConfig +class JitConfig extends AbstractConfig { /** * @var array Array of already loaded db values (even if there was no value) @@ -39,12 +39,12 @@ class JitConfig extends BaseConfig private $db_loaded; /** - * @param Cache $configCache The configuration cache (based on the config-files) - * @param Config $configModel The configuration model + * @param Cache $configCache The configuration cache (based on the config-files) + * @param Config $configRepo The configuration model */ - public function __construct(Cache $configCache, Config $configModel) + public function __construct(Cache $configCache, Config $configRepo) { - parent::__construct($configCache, $configModel); + parent::__construct($configCache, $configRepo); $this->db_loaded = []; $this->load(); @@ -52,16 +52,15 @@ class JitConfig extends BaseConfig /** * {@inheritDoc} - * */ public function load(string $cat = 'config') { // If not connected, do nothing - if (!$this->configModel->isConnected()) { + if (!$this->configRepo->isConnected()) { return; } - $config = $this->configModel->load($cat); + $config = $this->configRepo->load($cat); if (!empty($config[$cat])) { foreach ($config[$cat] as $key => $value) { @@ -79,15 +78,14 @@ class JitConfig extends BaseConfig public function get(string $cat, string $key, $default_value = null, bool $refresh = false) { // if the value isn't loaded or refresh is needed, load it to the cache - if ($this->configModel->isConnected() && - (empty($this->db_loaded[$cat][$key]) || - $refresh)) { + if ($this->configRepo->isConnected() && + (empty($this->db_loaded[$cat][$key]) || + $refresh)) { + $dbValue = $this->configRepo->get($cat, $key); - $dbvalue = $this->configModel->get($cat, $key); - - if (isset($dbvalue)) { - $this->configCache->set($cat, $key, $dbvalue, Cache::SOURCE_DB); - unset($dbvalue); + if (isset($dbValue)) { + $this->configCache->set($cat, $key, $dbValue, Cache::SOURCE_DB); + unset($dbValue); } $this->db_loaded[$cat][$key] = true; @@ -102,17 +100,17 @@ class JitConfig extends BaseConfig /** * {@inheritDoc} */ - public function set(string $cat, string $key, $value) + public function set(string $cat, string $key, $value): bool { // set the cache first $cached = $this->configCache->set($cat, $key, $value, Cache::SOURCE_DB); // If there is no connected adapter, we're finished - if (!$this->configModel->isConnected()) { + if (!$this->configRepo->isConnected()) { return $cached; } - $stored = $this->configModel->set($cat, $key, $value); + $stored = $this->configRepo->set($cat, $key, $value); $this->db_loaded[$cat][$key] = $stored; @@ -122,7 +120,7 @@ class JitConfig extends BaseConfig /** * {@inheritDoc} */ - public function delete(string $cat, string $key) + public function delete(string $cat, string $key): bool { $cacheRemoved = $this->configCache->delete($cat, $key); @@ -130,11 +128,11 @@ class JitConfig extends BaseConfig unset($this->db_loaded[$cat][$key]); } - if (!$this->configModel->isConnected()) { + if (!$this->configRepo->isConnected()) { return $cacheRemoved; } - $storeRemoved = $this->configModel->delete($cat, $key); + $storeRemoved = $this->configRepo->delete($cat, $key); return $cacheRemoved || $storeRemoved; } diff --git a/src/Core/Config/Type/PreloadConfig.php b/src/Core/Config/Type/PreloadConfig.php index c6abfcd9f..ed1b9a302 100644 --- a/src/Core/Config/Type/PreloadConfig.php +++ b/src/Core/Config/Type/PreloadConfig.php @@ -21,8 +21,8 @@ namespace Friendica\Core\Config\Type; -use Friendica\Core\Config\Cache\Cache; -use Friendica\Core\Config\Model\Config; +use Friendica\Core\Config\ValueObject\Cache; +use Friendica\Core\Config\Repository\Config; /** * This class implements the preload configuration, which will cache @@ -30,18 +30,18 @@ use Friendica\Core\Config\Model\Config; * * Minimizes the number of database queries to retrieve configuration values at the cost of memory. */ -class PreloadConfig extends BaseConfig +class PreloadConfig extends AbstractConfig { /** @var bool */ private $config_loaded; /** - * @param Cache $configCache The configuration cache (based on the config-files) - * @param Config $configModel The configuration model + * @param Cache $configCache The configuration cache (based on the config-files) + * @param Config $configRepo The configuration model */ - public function __construct(Cache $configCache, Config $configModel) + public function __construct(Cache $configCache, Config $configRepo) { - parent::__construct($configCache, $configModel); + parent::__construct($configCache, $configRepo); $this->config_loaded = false; $this->load(); @@ -51,7 +51,6 @@ class PreloadConfig extends BaseConfig * {@inheritDoc} * * This loads all config values everytime load is called - * */ public function load(string $cat = 'config') { @@ -61,11 +60,11 @@ class PreloadConfig extends BaseConfig } // If not connected, do nothing - if (!$this->configModel->isConnected()) { + if (!$this->configRepo->isConnected()) { return; } - $config = $this->configModel->load(); + $config = $this->configRepo->load(); $this->config_loaded = true; // load the whole category out of the DB into the cache @@ -78,8 +77,8 @@ class PreloadConfig extends BaseConfig public function get(string $cat, string $key, $default_value = null, bool $refresh = false) { if ($refresh) { - if ($this->configModel->isConnected()) { - $config = $this->configModel->get($cat, $key); + if ($this->configRepo->isConnected()) { + $config = $this->configRepo->get($cat, $key); if (isset($config)) { $this->configCache->set($cat, $key, $config, Cache::SOURCE_DB); } @@ -95,7 +94,7 @@ class PreloadConfig extends BaseConfig /** * {@inheritDoc} */ - public function set(string $cat, string $key, $value) + public function set(string $cat, string $key, $value): bool { if (!$this->config_loaded) { $this->load(); @@ -105,11 +104,11 @@ class PreloadConfig extends BaseConfig $cached = $this->configCache->set($cat, $key, $value, Cache::SOURCE_DB); // If there is no connected adapter, we're finished - if (!$this->configModel->isConnected()) { + if (!$this->configRepo->isConnected()) { return $cached; } - $stored = $this->configModel->set($cat, $key, $value); + $stored = $this->configRepo->set($cat, $key, $value); return $cached && $stored; } @@ -117,7 +116,7 @@ class PreloadConfig extends BaseConfig /** * {@inheritDoc} */ - public function delete(string $cat, string $key) + public function delete(string $cat, string $key): bool { if ($this->config_loaded) { $this->load(); @@ -125,26 +124,12 @@ class PreloadConfig extends BaseConfig $cacheRemoved = $this->configCache->delete($cat, $key); - if (!$this->configModel->isConnected()) { + if (!$this->configRepo->isConnected()) { return $cacheRemoved; } - $storeRemoved = $this->configModel->delete($cat, $key); + $storeRemoved = $this->configRepo->delete($cat, $key); return $cacheRemoved || $storeRemoved; } - - public function testSetDouble() - { - $this->configModel->shouldReceive('isConnected') - ->andReturn(true); - - // constructor loading - $this->configModel->shouldReceive('load') - ->with('config') - ->andReturn(['config' => ['test' => 'it']]) - ->once(); - - parent::testSetDouble(); - } } diff --git a/src/Core/Config/Cache/ConfigFileLoader.php b/src/Core/Config/Util/ConfigFileLoader.php similarity index 86% rename from src/Core/Config/Cache/ConfigFileLoader.php rename to src/Core/Config/Util/ConfigFileLoader.php index 4b1a09c1d..7740ec326 100644 --- a/src/Core/Config/Cache/ConfigFileLoader.php +++ b/src/Core/Config/Util/ConfigFileLoader.php @@ -19,11 +19,11 @@ * */ -namespace Friendica\Core\Config\Cache; +namespace Friendica\Core\Config\Util; -use Exception; use Friendica\Core\Addon; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\Exception\ConfigFileException; +use Friendica\Core\Config\ValueObject\Cache; /** * The ConfigFileLoader loads config-files and stores them in a ConfigCache ( @see Cache ) @@ -91,7 +91,7 @@ class ConfigFileLoader * @param array $server The $_SERVER array * @param bool $raw Setup the raw config format * - * @throws Exception + * @throws ConfigFileException */ public function setupCache(Cache $config, array $server = [], bool $raw = false) { @@ -122,9 +122,9 @@ class ConfigFileLoader * * @return array The config array (empty if no config found) * - * @throws Exception if the configuration file isn't readable + * @throws ConfigFileException if the configuration file isn't readable */ - private function loadStaticConfig($name) + private function loadStaticConfig(string $name): array { $configName = $this->staticDir . DIRECTORY_SEPARATOR . $name . '.config.php'; $iniName = $this->staticDir . DIRECTORY_SEPARATOR . $name . '.ini.php'; @@ -143,9 +143,7 @@ class ConfigFileLoader * * @param Cache $config The Config cache * - * @return array The config array (empty if no config found) - * - * @throws Exception if the configuration file isn't readable + * @throws ConfigFileException if the configuration file isn't readable */ private function loadCoreConfig(Cache $config) { @@ -158,8 +156,6 @@ class ConfigFileLoader foreach ($this->getConfigFiles() as $configFile) { $config->load($this->loadConfigFile($configFile), Cache::SOURCE_FILE); } - - return []; } /** @@ -169,15 +165,15 @@ class ConfigFileLoader * * @return array The config array (empty if no config found) * - * @throws Exception if the configuration file isn't readable + * @throws ConfigFileException if the configuration file isn't readable */ - public function loadAddonConfig($name) + public function loadAddonConfig(string $name): array { $filepath = $this->baseDir . DIRECTORY_SEPARATOR . // /var/www/html/ - Addon::DIRECTORY . DIRECTORY_SEPARATOR . // addon/ - $name . DIRECTORY_SEPARATOR . // openstreetmap/ - 'config'. DIRECTORY_SEPARATOR . // config/ - $name . ".config.php"; // openstreetmap.config.php + Addon::DIRECTORY . DIRECTORY_SEPARATOR . // addon/ + $name . DIRECTORY_SEPARATOR . // openstreetmap/ + 'config'. DIRECTORY_SEPARATOR . // config/ + $name . ".config.php"; // openstreetmap.config.php if (file_exists($filepath)) { return $this->loadConfigFile($filepath); @@ -193,9 +189,9 @@ class ConfigFileLoader * * @return array The config array (empty if no config was found) * - * @throws Exception if the configuration file isn't readable + * @throws ConfigFileException if the configuration file isn't readable */ - public function loadEnvConfig(array $server) + public function loadEnvConfig(array $server): array { $filepath = $this->staticDir . DIRECTORY_SEPARATOR . // /var/www/html/static/ "env.config.php"; // env.config.php @@ -224,10 +220,10 @@ class ConfigFileLoader * * @return array */ - private function getConfigFiles(bool $ini = false) + private function getConfigFiles(bool $ini = false): array { $files = scandir($this->configDir); - $found = array(); + $found = []; $filePattern = ($ini ? '*.ini.php' : '*.config.php'); @@ -252,7 +248,7 @@ class ConfigFileLoader * * @deprecated since version 2018.09 */ - private function loadLegacyConfig($name = '') + private function loadLegacyConfig(string $name = ''): array { $name = !empty($name) ? $name : self::CONFIG_HTCONFIG; $fullName = $this->baseDir . DIRECTORY_SEPARATOR . '.' . $name . '.php'; @@ -322,17 +318,17 @@ class ConfigFileLoader * @param string $filepath * * @return array The configuration array - * @throws Exception + * @throws ConfigFileException * @deprecated since version 2018.12 */ - private function loadINIConfigFile($filepath) + private function loadINIConfigFile(string $filepath): array { $contents = include($filepath); $config = parse_ini_string($contents, true, INI_SCANNER_TYPED); if ($config === false) { - throw new Exception('Error parsing INI config file ' . $filepath); + throw new ConfigFileException('Error parsing INI config file ' . $filepath); } return $config; @@ -353,14 +349,14 @@ class ConfigFileLoader * * @return array The config array0 * - * @throws Exception if the config cannot get loaded. + * @throws ConfigFileException if the config cannot get loaded. */ - private function loadConfigFile($filepath) + private function loadConfigFile(string $filepath): array { $config = include($filepath); if (!is_array($config)) { - throw new Exception('Error loading config file ' . $filepath); + throw new ConfigFileException('Error loading config file ' . $filepath); } return $config; diff --git a/src/Core/Config/Model/DbaUtils.php b/src/Core/Config/Util/ValueConversion.php similarity index 82% rename from src/Core/Config/Model/DbaUtils.php rename to src/Core/Config/Util/ValueConversion.php index da2b89737..a3cdf7ca2 100644 --- a/src/Core/Config/Model/DbaUtils.php +++ b/src/Core/Config/Util/ValueConversion.php @@ -1,8 +1,11 @@ config[$cat][$key])) { return $this->config[$cat][$key]; - } else if (!isset($key) && isset($this->config[$cat])) { + } elseif (!isset($key) && isset($this->config[$cat])) { return $this->config[$cat]; } else { return null; @@ -122,7 +123,7 @@ class Cache * * @return bool True, if the value is set */ - public function set(string $cat, string $key, $value, $source = self::SOURCE_DEFAULT) + public function set(string $cat, string $key, $value, int $source = self::SOURCE_DEFAULT): bool { if (!isset($this->config[$cat])) { $this->config[$cat] = []; @@ -155,7 +156,7 @@ class Cache * * @return bool true, if deleted */ - public function delete(string $cat, string $key) + public function delete(string $cat, string $key): bool { if (isset($this->config[$cat][$key])) { unset($this->config[$cat][$key]); @@ -173,9 +174,9 @@ class Cache /** * Returns the whole configuration * - * @return array The configuration + * @return string[][] The configuration */ - public function getAll() + public function getAll(): array { return $this->config; } @@ -183,11 +184,11 @@ class Cache /** * Returns an array with missing categories/Keys * - * @param array $config The array to check + * @param string[][] $config The array to check * - * @return array + * @return string[][] */ - public function keyDiff(array $config) + public function keyDiff(array $config): array { $return = []; diff --git a/src/Core/Installer.php b/src/Core/Installer.php index fc0da6cbe..96e73b993 100644 --- a/src/Core/Installer.php +++ b/src/Core/Installer.php @@ -23,7 +23,7 @@ namespace Friendica\Core; use DOMDocument; use Exception; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\Database\Database; use Friendica\Database\DBStructure; use Friendica\DI; @@ -678,8 +678,8 @@ class Installer /** * Setup the default cache for a new installation * - * @param \Friendica\Core\Config\Cache\Cache $configCache The configuration cache - * @param string $basePath The determined basepath + * @param \Friendica\Core\Config\ValueObject\Cache $configCache The configuration cache + * @param string $basePath The determined basepath * * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ diff --git a/src/Core/L10n.php b/src/Core/L10n.php index 2a2988341..aca57793c 100644 --- a/src/Core/L10n.php +++ b/src/Core/L10n.php @@ -21,8 +21,8 @@ namespace Friendica\Core; -use Friendica\Core\Config\IConfig; -use Friendica\Core\Session\ISession; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\Session\Capability\IHandleSessions; use Friendica\Database\Database; use Friendica\Util\Strings; use Psr\Log\LoggerInterface; @@ -62,7 +62,7 @@ class L10n */ private $logger; - public function __construct(IConfig $config, Database $dba, LoggerInterface $logger, ISession $session, array $server, array $get) + public function __construct(IManageConfigValues $config, Database $dba, LoggerInterface $logger, IHandleSessions $session, array $server, array $get) { $this->dba = $dba; $this->logger = $logger; @@ -85,7 +85,7 @@ class L10n /** * Sets the language session variable */ - private function setSessionVariable(ISession $session) + private function setSessionVariable(IHandleSessions $session) { if ($session->get('authenticated') && !$session->get('language')) { $session->set('language', $this->lang); @@ -103,7 +103,7 @@ class L10n } } - private function setLangFromSession(ISession $session) + private function setLangFromSession(IHandleSessions $session) { if ($session->get('language') !== $this->lang) { $this->loadTranslationTable($session->get('language')); diff --git a/src/Core/Lock/ILock.php b/src/Core/Lock/Capability/ICanLock.php similarity index 62% rename from src/Core/Lock/ILock.php rename to src/Core/Lock/Capability/ICanLock.php index 35e21305e..1029e2b96 100644 --- a/src/Core/Lock/ILock.php +++ b/src/Core/Lock/Capability/ICanLock.php @@ -19,23 +19,22 @@ * */ -namespace Friendica\Core\Lock; +namespace Friendica\Core\Lock\Capability; use Friendica\Core\Cache\Enum\Duration; +use Friendica\Core\Lock\Exception\LockPersistenceException; /** * Lock Interface */ -interface ILock +interface ICanLock { /** * Checks, if a key is currently locked to a or my process * * @param string $key The name of the lock - * - * @return bool */ - public function isLocked($key); + public function isLocked(string $key): bool; /** * @@ -45,9 +44,9 @@ interface ILock * @param integer $timeout Seconds until we give up * @param integer $ttl Seconds The lock lifespan, must be one of the Cache constants * - * @return boolean Was the lock successful? + * @throws LockPersistenceException In case the underlying persistence throws errors */ - public function acquire($key, $timeout = 120, $ttl = Duration::FIVE_MINUTES); + public function acquire(string $key, int $timeout = 120, int $ttl = Duration::FIVE_MINUTES): bool; /** * Releases a lock if it was set by us @@ -55,32 +54,36 @@ interface ILock * @param string $key The Name of the lock * @param bool $override Overrides the lock to get released * - * @return boolean Was the unlock successful? + * @return bool Was the unlock successful? + * + * @throws LockPersistenceException In case the underlying persistence throws errors */ - public function release($key, $override = false); + public function release(string $key, bool $override = false): bool; /** * Releases all lock that were set by us * * @param bool $override Override to release all locks * - * @return boolean Was the unlock of all locks successful? + * @return bool Was the unlock of all locks successful? + * + * @throws LockPersistenceException In case the underlying persistence throws errors */ - public function releaseAll($override = false); + public function releaseAll(bool $override = false): bool; /** * Returns the name of the current lock - * - * @return string */ - public function getName(); + public function getName(): string; /** * Lists all locks * * @param string prefix optional a prefix to search * - * @return array Empty if it isn't supported by the cache driver + * @return string[] Empty if it isn't supported by the cache driver + * + * @throws LockPersistenceException In case the underlying persistence throws errors */ - public function getLocks(string $prefix = ''); + public function getLocks(string $prefix = ''): array; } diff --git a/src/Core/Lock/Exception/InvalidLockDriverException.php b/src/Core/Lock/Exception/InvalidLockDriverException.php new file mode 100644 index 000000000..38f2399bf --- /dev/null +++ b/src/Core/Lock/Exception/InvalidLockDriverException.php @@ -0,0 +1,13 @@ +cacheFactory = $cacheFactory; $this->config = $config; @@ -77,24 +78,24 @@ class LockFactory try { switch ($lock_type) { - case Type::MEMCACHE: - case Type::MEMCACHED: - case Type::REDIS: - case Type::APCU: + case Enum\Type::MEMCACHE: + case Enum\Type::MEMCACHED: + case Enum\Type::REDIS: + case Enum\Type::APCU: $cache = $this->cacheFactory->create($lock_type); - if ($cache instanceof IMemoryCache) { - return new Lock\Type\CacheLock($cache); + if ($cache instanceof ICanCacheInMemory) { + return new Type\CacheLock($cache); } else { throw new \Exception(sprintf('Incompatible cache driver \'%s\' for lock used', $lock_type)); } break; case 'database': - return new Lock\Type\DatabaseLock($this->dba); + return new Type\DatabaseLock($this->dba); break; case 'semaphore': - return new Lock\Type\SemaphoreLock(); + return new Type\SemaphoreLock(); break; default: @@ -114,14 +115,14 @@ class LockFactory * 2. Cache Locking * 3. Database Locking * - * @return Lock\ILock + * @return ICanLock */ private function useAutoDriver() { // 1. Try to use Semaphores for - local - locking if (function_exists('sem_get')) { try { - return new Lock\Type\SemaphoreLock(); + return new Type\SemaphoreLock(); } catch (\Exception $exception) { $this->logger->warning('Using Semaphore driver for locking failed.', ['exception' => $exception]); } @@ -129,11 +130,11 @@ class LockFactory // 2. Try to use Cache Locking (don't use the DB-Cache Locking because it works different!) $cache_type = $this->config->get('system', 'cache_driver', 'database'); - if ($cache_type != Type::DATABASE) { + if ($cache_type != Enum\Type::DATABASE) { try { $cache = $this->cacheFactory->create($cache_type); - if ($cache instanceof IMemoryCache) { - return new Lock\Type\CacheLock($cache); + if ($cache instanceof ICanCacheInMemory) { + return new Type\CacheLock($cache); } } catch (\Exception $exception) { $this->logger->warning('Using Cache driver for locking failed.', ['exception' => $exception]); @@ -141,6 +142,6 @@ class LockFactory } // 3. Use Database Locking as a Fallback - return new Lock\Type\DatabaseLock($this->dba); + return new Type\DatabaseLock($this->dba); } } diff --git a/src/Core/Lock/Type/BaseLock.php b/src/Core/Lock/Type/AbstractLock.php similarity index 85% rename from src/Core/Lock/Type/BaseLock.php rename to src/Core/Lock/Type/AbstractLock.php index 518475b44..fc9c57a54 100644 --- a/src/Core/Lock/Type/BaseLock.php +++ b/src/Core/Lock/Type/AbstractLock.php @@ -21,12 +21,12 @@ namespace Friendica\Core\Lock\Type; -use Friendica\Core\Lock\ILock; +use Friendica\Core\Lock\Capability\ICanLock; /** * Basic class for Locking with common functions (local acquired locks, releaseAll, ..) */ -abstract class BaseLock implements ILock +abstract class AbstractLock implements ICanLock { /** * @var array The local acquired locks @@ -40,7 +40,7 @@ abstract class BaseLock implements ILock * * @return bool Returns true if the lock is set */ - protected function hasAcquiredLock($key) + protected function hasAcquiredLock(string $key): bool { return isset($this->acquireLock[$key]) && $this->acquiredLocks[$key] === true; } @@ -50,7 +50,7 @@ abstract class BaseLock implements ILock * * @param string $key The Name of the lock */ - protected function markAcquire($key) + protected function markAcquire(string $key) { $this->acquiredLocks[$key] = true; } @@ -60,7 +60,7 @@ abstract class BaseLock implements ILock * * @param string $key The Name of the lock */ - protected function markRelease($key) + protected function markRelease(string $key) { unset($this->acquiredLocks[$key]); } @@ -68,7 +68,7 @@ abstract class BaseLock implements ILock /** * {@inheritDoc} */ - public function releaseAll($override = false) + public function releaseAll(bool $override = false): bool { $return = true; diff --git a/src/Core/Lock/Type/CacheLock.php b/src/Core/Lock/Type/CacheLock.php index 8a85f0765..d3032c402 100644 --- a/src/Core/Lock/Type/CacheLock.php +++ b/src/Core/Lock/Type/CacheLock.php @@ -21,10 +21,13 @@ namespace Friendica\Core\Lock\Type; +use Friendica\Core\Cache\Capability\ICanCache; +use Friendica\Core\Cache\Capability\ICanCacheInMemory; use Friendica\Core\Cache\Enum\Duration; -use Friendica\Core\Cache\IMemoryCache; +use Friendica\Core\Cache\Exception\CachePersistenceException; +use Friendica\Core\Lock\Exception\LockPersistenceException; -class CacheLock extends BaseLock +class CacheLock extends AbstractLock { /** * @var string The static prefix of all locks inside the cache @@ -32,16 +35,16 @@ class CacheLock extends BaseLock const CACHE_PREFIX = 'lock:'; /** - * @var \Friendica\Core\Cache\ICache; + * @var ICanCache; */ private $cache; /** * CacheLock constructor. * - * @param IMemoryCache $cache The CacheDriver for this type of lock + * @param ICanCacheInMemory $cache The CacheDriver for this type of lock */ - public function __construct(IMemoryCache $cache) + public function __construct(ICanCacheInMemory $cache) { $this->cache = $cache; } @@ -49,35 +52,39 @@ class CacheLock extends BaseLock /** * (@inheritdoc) */ - public function acquire($key, $timeout = 120, $ttl = Duration::FIVE_MINUTES) + public function acquire(string $key, int $timeout = 120, int $ttl = Duration::FIVE_MINUTES): bool { $got_lock = false; $start = time(); - $cachekey = self::getLockKey($key); + $lockKey = self::getLockKey($key); - do { - $lock = $this->cache->get($cachekey); - // When we do want to lock something that was already locked by us. - if ((int)$lock == getmypid()) { - $got_lock = true; - } - - // When we do want to lock something new - if (is_null($lock)) { - // At first initialize it with "0" - $this->cache->add($cachekey, 0); - // Now the value has to be "0" because otherwise the key was used by another process meanwhile - if ($this->cache->compareSet($cachekey, 0, getmypid(), $ttl)) { + try { + do { + $lock = $this->cache->get($lockKey); + // When we do want to lock something that was already locked by us. + if ((int)$lock == getmypid()) { $got_lock = true; - $this->markAcquire($key); } - } - if (!$got_lock && ($timeout > 0)) { - usleep(rand(10000, 200000)); - } - } while (!$got_lock && ((time() - $start) < $timeout)); + // When we do want to lock something new + if (is_null($lock)) { + // At first initialize it with "0" + $this->cache->add($lockKey, 0); + // Now the value has to be "0" because otherwise the key was used by another process meanwhile + if ($this->cache->compareSet($lockKey, 0, getmypid(), $ttl)) { + $got_lock = true; + $this->markAcquire($key); + } + } + + if (!$got_lock && ($timeout > 0)) { + usleep(rand(10000, 200000)); + } + } while (!$got_lock && ((time() - $start) < $timeout)); + } catch (CachePersistenceException $exception) { + throw new LockPersistenceException(sprintf('Cannot acquire lock for key %s', $key), $exception); + } return $got_lock; } @@ -85,14 +92,18 @@ class CacheLock extends BaseLock /** * (@inheritdoc) */ - public function release($key, $override = false) + public function release(string $key, bool $override = false): bool { - $cachekey = self::getLockKey($key); + $lockKey = self::getLockKey($key); - if ($override) { - $return = $this->cache->delete($cachekey); - } else { - $return = $this->cache->compareDelete($cachekey, getmypid()); + try { + if ($override) { + $return = $this->cache->delete($lockKey); + } else { + $return = $this->cache->compareDelete($lockKey, getmypid()); + } + } catch (CachePersistenceException $exception) { + throw new LockPersistenceException(sprintf('Cannot release lock for key %s (override %b)', $key, $override), $exception); } $this->markRelease($key); @@ -102,17 +113,21 @@ class CacheLock extends BaseLock /** * (@inheritdoc) */ - public function isLocked($key) + public function isLocked(string $key): bool { - $cachekey = self::getLockKey($key); - $lock = $this->cache->get($cachekey); + $lockKey = self::getLockKey($key); + try { + $lock = $this->cache->get($lockKey); + } catch (CachePersistenceException $exception) { + throw new LockPersistenceException(sprintf('Cannot check lock state for key %s', $key), $exception); + } return isset($lock) && ($lock !== false); } /** * {@inheritDoc} */ - public function getName() + public function getName(): string { return $this->cache->getName(); } @@ -120,11 +135,15 @@ class CacheLock extends BaseLock /** * {@inheritDoc} */ - public function getLocks(string $prefix = '') + public function getLocks(string $prefix = ''): array { - $locks = $this->cache->getAllKeys(self::CACHE_PREFIX . $prefix); + try { + $locks = $this->cache->getAllKeys(self::CACHE_PREFIX . $prefix); + } catch (CachePersistenceException $exception) { + throw new LockPersistenceException(sprintf('Cannot get locks with prefix %s', $prefix), $exception); + } - array_walk($locks, function (&$lock, $key) { + array_walk($locks, function (&$lock) { $lock = substr($lock, strlen(self::CACHE_PREFIX)); }); @@ -134,7 +153,7 @@ class CacheLock extends BaseLock /** * {@inheritDoc} */ - public function releaseAll($override = false) + public function releaseAll(bool $override = false): bool { $success = parent::releaseAll($override); @@ -154,7 +173,7 @@ class CacheLock extends BaseLock * * @return string The cache key used for the cache */ - private static function getLockKey($key) + private static function getLockKey(string $key): string { return self::CACHE_PREFIX . $key; } diff --git a/src/Core/Lock/Type/DatabaseLock.php b/src/Core/Lock/Type/DatabaseLock.php index de44e2e2b..9c2dd2d4d 100644 --- a/src/Core/Lock/Type/DatabaseLock.php +++ b/src/Core/Lock/Type/DatabaseLock.php @@ -23,13 +23,14 @@ namespace Friendica\Core\Lock\Type; use Friendica\Core\Cache\Enum\Duration; use Friendica\Core\Lock\Enum\Type; +use Friendica\Core\Lock\Exception\LockPersistenceException; use Friendica\Database\Database; use Friendica\Util\DateTimeFormat; /** * Locking driver that stores the locks in the database */ -class DatabaseLock extends BaseLock +class DatabaseLock extends AbstractLock { /** * The current ID of the process @@ -44,49 +45,63 @@ class DatabaseLock extends BaseLock private $dba; /** - * @param null|int $pid The Id of the current process (null means determine automatically) + * @param int|null $pid The id of the current process (null means determine automatically) */ - public function __construct(Database $dba, $pid = null) + public function __construct(Database $dba, ?int $pid = null) { $this->dba = $dba; - $this->pid = isset($pid) ? $pid : getmypid(); + $this->pid = $pid ?? getmypid(); } /** * (@inheritdoc) */ - public function acquire($key, $timeout = 120, $ttl = Duration::FIVE_MINUTES) + public function acquire(string $key, int $timeout = 120, int $ttl = Duration::FIVE_MINUTES): bool { $got_lock = false; $start = time(); - do { - $this->dba->lock('locks'); - $lock = $this->dba->selectFirst('locks', ['locked', 'pid'], ['`name` = ? AND `expires` >= ?', $key, DateTimeFormat::utcNow()]); + try { + do { + $this->dba->lock('locks'); + $lock = $this->dba->selectFirst('locks', ['locked', 'pid'], [ + '`name` = ? AND `expires` >= ?', $key,DateTimeFormat::utcNow() + ]); - if ($this->dba->isResult($lock)) { - if ($lock['locked']) { - // We want to lock something that was already locked by us? So we got the lock. - if ($lock['pid'] == $this->pid) { + if ($this->dba->isResult($lock)) { + if ($lock['locked']) { + // We want to lock something that was already locked by us? So we got the lock. + if ($lock['pid'] == $this->pid) { + $got_lock = true; + } + } + if (!$lock['locked']) { + $this->dba->update('locks', [ + 'locked' => true, + 'pid' => $this->pid, + 'expires' => DateTimeFormat::utc('now + ' . $ttl . 'seconds') + ], ['name' => $key]); $got_lock = true; } - } - if (!$lock['locked']) { - $this->dba->update('locks', ['locked' => true, 'pid' => $this->pid, 'expires' => DateTimeFormat::utc('now + ' . $ttl . 'seconds')], ['name' => $key]); + } else { + $this->dba->insert('locks', [ + 'name' => $key, + 'locked' => true, + 'pid' => $this->pid, + 'expires' => DateTimeFormat::utc('now + ' . $ttl . 'seconds')]); $got_lock = true; + $this->markAcquire($key); } - } else { - $this->dba->insert('locks', ['name' => $key, 'locked' => true, 'pid' => $this->pid, 'expires' => DateTimeFormat::utc('now + ' . $ttl . 'seconds')]); - $got_lock = true; - $this->markAcquire($key); - } - $this->dba->unlock(); + $this->dba->unlock(); - if (!$got_lock && ($timeout > 0)) { - usleep(rand(100000, 2000000)); - } - } while (!$got_lock && ((time() - $start) < $timeout)); + if (!$got_lock && ($timeout > 0)) { + usleep(rand(100000, 2000000)); + } + } while (!$got_lock && ((time() - $start) < $timeout)); + } catch (\Exception $exception) { + throw new LockPersistenceException(sprintf('Cannot acquire lock for key %s', $key), $exception); + } return $got_lock; } @@ -94,7 +109,7 @@ class DatabaseLock extends BaseLock /** * (@inheritdoc) */ - public function release($key, $override = false) + public function release(string $key, bool $override = false): bool { if ($override) { $where = ['name' => $key]; @@ -102,10 +117,14 @@ class DatabaseLock extends BaseLock $where = ['name' => $key, 'pid' => $this->pid]; } - if ($this->dba->exists('locks', $where)) { - $return = $this->dba->delete('locks', $where); - } else { - $return = false; + try { + if ($this->dba->exists('locks', $where)) { + $return = $this->dba->delete('locks', $where); + } else { + $return = false; + } + } catch (\Exception $exception) { + throw new LockPersistenceException(sprintf('Cannot release lock for key %s (override %b)', $key, $override), $exception); } $this->markRelease($key); @@ -116,7 +135,7 @@ class DatabaseLock extends BaseLock /** * (@inheritdoc) */ - public function releaseAll($override = false) + public function releaseAll(bool $override = false): bool { $success = parent::releaseAll($override); @@ -125,7 +144,12 @@ class DatabaseLock extends BaseLock } else { $where = ['pid' => $this->pid]; } - $return = $this->dba->delete('locks', $where); + + try { + $return = $this->dba->delete('locks', $where); + } catch (\Exception $exception) { + throw new LockPersistenceException(sprintf('Cannot release all lock (override %b)', $override), $exception); + } $this->acquiredLocks = []; @@ -135,9 +159,14 @@ class DatabaseLock extends BaseLock /** * (@inheritdoc) */ - public function isLocked($key) + public function isLocked(string $key): bool { - $lock = $this->dba->selectFirst('locks', ['locked'], ['`name` = ? AND `expires` >= ?', $key, DateTimeFormat::utcNow()]); + try { + $lock = $this->dba->selectFirst('locks', ['locked'], [ + '`name` = ? AND `expires` >= ?', $key, DateTimeFormat::utcNow()]); + } catch (\Exception $exception) { + throw new LockPersistenceException(sprintf('Cannot check lock state for key %s', $key), $exception); + } if ($this->dba->isResult($lock)) { return $lock['locked'] !== false; @@ -149,7 +178,7 @@ class DatabaseLock extends BaseLock /** * {@inheritDoc} */ - public function getName() + public function getName(): string { return Type::DATABASE; } @@ -157,21 +186,26 @@ class DatabaseLock extends BaseLock /** * {@inheritDoc} */ - public function getLocks(string $prefix = '') + public function getLocks(string $prefix = ''): array { - if (empty($prefix)) { - $where = ['`expires` >= ?', DateTimeFormat::utcNow()]; - } else { - $where = ['`expires` >= ? AND `name` LIKE CONCAT(?, \'%\')', DateTimeFormat::utcNow(), $prefix]; - } + try { + if (empty($prefix)) { + $where = ['`expires` >= ?', DateTimeFormat::utcNow()]; + } else { + $where = ['`expires` >= ? AND `name` LIKE CONCAT(?, \'%\')', DateTimeFormat::utcNow(), $prefix]; + } - $stmt = $this->dba->select('locks', ['name'], $where); + $stmt = $this->dba->select('locks', ['name'], $where); - $keys = []; - while ($key = $this->dba->fetch($stmt)) { - array_push($keys, $key['name']); + $keys = []; + while ($key = $this->dba->fetch($stmt)) { + array_push($keys, $key['name']); + } + } catch (\Exception $exception) { + throw new LockPersistenceException(sprintf('Cannot get lock with prefix %s', $prefix), $exception); + } finally { + $this->dba->close($stmt); } - $this->dba->close($stmt); return $keys; } diff --git a/src/Core/Lock/Type/SemaphoreLock.php b/src/Core/Lock/Type/SemaphoreLock.php index 4393e4515..f68b5546c 100644 --- a/src/Core/Lock/Type/SemaphoreLock.php +++ b/src/Core/Lock/Type/SemaphoreLock.php @@ -23,16 +23,17 @@ namespace Friendica\Core\Lock\Type; use Friendica\Core\Cache\Enum\Duration; use Friendica\Core\Lock\Enum\Type; +use Friendica\Core\Lock\Exception\InvalidLockDriverException; use function get_temppath; -class SemaphoreLock extends BaseLock +class SemaphoreLock extends AbstractLock { private static $semaphore = []; public function __construct() { if (!function_exists('sem_get')) { - throw new \Exception('Semaphore lock not supported'); + throw new InvalidLockDriverException('Semaphore lock not supported'); } } @@ -57,11 +58,11 @@ class SemaphoreLock extends BaseLock /** * (@inheritdoc) */ - public function acquire($key, $timeout = 120, $ttl = Duration::FIVE_MINUTES) + public function acquire(string $key, int $timeout = 120, int $ttl = Duration::FIVE_MINUTES): bool { self::$semaphore[$key] = sem_get(self::semaphoreKey($key)); if (!empty(self::$semaphore[$key])) { - if ((bool)sem_acquire(self::$semaphore[$key], ($timeout === 0))) { + if (sem_acquire(self::$semaphore[$key], ($timeout === 0))) { $this->markAcquire($key); return true; } @@ -76,7 +77,7 @@ class SemaphoreLock extends BaseLock * @param bool $override not necessary parameter for semaphore locks since the lock lives as long as the execution * of the using function */ - public function release($key, $override = false) + public function release(string $key, bool $override = false): bool { $success = false; @@ -96,7 +97,7 @@ class SemaphoreLock extends BaseLock /** * (@inheritdoc) */ - public function isLocked($key) + public function isLocked(string $key): bool { return isset(self::$semaphore[$key]); } @@ -104,7 +105,7 @@ class SemaphoreLock extends BaseLock /** * {@inheritDoc} */ - public function getName() + public function getName(): string { return Type::SEMAPHORE; } @@ -112,7 +113,7 @@ class SemaphoreLock extends BaseLock /** * {@inheritDoc} */ - public function getLocks(string $prefix = '') + public function getLocks(string $prefix = ''): array { // We can just return our own semaphore keys, since we don't know // the state of other semaphores, even if the .sem files exists @@ -136,7 +137,7 @@ class SemaphoreLock extends BaseLock /** * {@inheritDoc} */ - public function releaseAll($override = false) + public function releaseAll(bool $override = false): bool { // Semaphores are just alive during a run, so there is no need to release // You can just release your own locks diff --git a/src/Core/PConfig/IPConfig.php b/src/Core/PConfig/Capability/IManagePersonalConfigValues.php similarity index 75% rename from src/Core/PConfig/IPConfig.php rename to src/Core/PConfig/Capability/IManagePersonalConfigValues.php index 1795a6039..3af3576c6 100644 --- a/src/Core/PConfig/IPConfig.php +++ b/src/Core/PConfig/Capability/IManagePersonalConfigValues.php @@ -19,37 +19,34 @@ * */ -namespace Friendica\Core\PConfig; +namespace Friendica\Core\PConfig\Capability; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\PConfig\ValueObject; /** * Interface for accessing user specific configurations */ -interface IPConfig +interface IManagePersonalConfigValues { - /** * Loads all configuration values of a user's config family into a cached storage. * * All configuration values of the given user are stored with the $uid in the cache * - * @param int $uid The user_id + * @param int $uid The user_id * @param string $cat The category of the configuration value * * @return array The loaded config array - * @see Cache - * */ - function load(int $uid, string $cat = 'config'); + public function load(int $uid, string $cat = 'config'): array; /** * Get a particular user's config variable given the category name * ($cat) and a key. * * Get a particular user's config value from the given category ($cat) - * and the $key with the $uid from a cached storage either from the $this->configAdapter - * (@see IConfigAdapter) or from the $this->configCache (@see PConfigCache). + * and the $key with the $uid from a cached storage either from the database + * or from the configCache * * @param int $uid The user_id * @param string $cat The category of the configuration value @@ -58,8 +55,9 @@ interface IPConfig * @param boolean $refresh optional, If true the config is loaded from the db and not from the cache (default: false) * * @return mixed Stored value or null if it does not exist + * */ - function get(int $uid, string $cat, string $key, $default_value = null, bool $refresh = false); + public function get(int $uid, string $cat, string $key, $default_value = null, bool $refresh = false); /** * Sets a configuration value for a user @@ -76,28 +74,26 @@ interface IPConfig * * @return bool Operation success */ - function set(int $uid, string $cat, string $key, $value); + public function set(int $uid, string $cat, string $key, $value): bool; /** - * Deletes the given key from the users's configuration. + * Deletes the given key from the users configuration. * - * Removes the configured value from the stored cache in $this->configCache - * (@see ConfigCache) and removes it from the database (@see IConfigAdapter) - * with the given $uid. + * Removes the configured value from the stored cache and removes it from the database with the given $uid. * - * @param int $uid The user_id + * @param int $uid The user_id * @param string $cat The category of the configuration value * @param string $key The configuration key to delete * * @return bool */ - function delete(int $uid, string $cat, string $key); + public function delete(int $uid, string $cat, string $key): bool; /** * Returns the Config Cache * - * @return \Friendica\Core\PConfig\Cache\Cache + * @return ValueObject\Cache */ - function getCache(); + public function getCache(): ValueObject\Cache; } diff --git a/src/Core/PConfig/Exception/PConfigPersistenceException.php b/src/Core/PConfig/Exception/PConfigPersistenceException.php new file mode 100644 index 000000000..4da14c8b4 --- /dev/null +++ b/src/Core/PConfig/Exception/PConfigPersistenceException.php @@ -0,0 +1,13 @@ +get('system', 'config_adapter') === 'preload') { - $configuration = new Type\PreloadPConfig($pConfigCache, $configModel); + $configuration = new Type\PreloadPConfig($pConfigCache, $configRepo); } else { - $configuration = new Type\JitPConfig($pConfigCache, $configModel); + $configuration = new Type\JitPConfig($pConfigCache, $configRepo); } return $configuration; diff --git a/src/Core/PConfig/Model/PConfig.php b/src/Core/PConfig/Repository/PConfig.php similarity index 55% rename from src/Core/PConfig/Model/PConfig.php rename to src/Core/PConfig/Repository/PConfig.php index 35ff34a56..d7f1ca3d3 100644 --- a/src/Core/PConfig/Model/PConfig.php +++ b/src/Core/PConfig/Repository/PConfig.php @@ -19,9 +19,10 @@ * */ -namespace Friendica\Core\PConfig\Model; +namespace Friendica\Core\PConfig\Repository; -use Friendica\Core\Config\Model\DbaUtils; +use Friendica\Core\Config\Util\ValueConversion; +use Friendica\Core\PConfig\Exception\PConfigPersistenceException; use Friendica\Database\Database; /** @@ -29,15 +30,14 @@ use Friendica\Database\Database; */ class PConfig { - /** @var Database */ - protected $dba; + protected static $table_name = 'pconfig'; - /** - * @param Database $dba The database connection of this model - */ - public function __construct(Database $dba) + /** @var Database */ + protected $db; + + public function __construct(Database $db) { - $this->dba = $dba; + $this->db = $db; } /** @@ -45,9 +45,9 @@ class PConfig * * @return bool */ - public function isConnected() + public function isConnected(): bool { - return $this->dba->isConnected(); + return $this->db->isConnected(); } /** @@ -56,30 +56,35 @@ class PConfig * @param int $uid The id of the user to load * @param string|null $cat The category of the configuration values to load * - * @return array The config array + * @return string[][] The config array * - * @throws \Exception In case DB calls are invalid + * @throws PConfigPersistenceException In case the persistence layer throws errors */ - public function load(int $uid, string $cat = null) + public function load(int $uid, ?string $cat = null): array { $return = []; - if (empty($cat)) { - $configs = $this->dba->select('pconfig', ['cat', 'v', 'k'], ['uid' => $uid]); - } else { - $configs = $this->dba->select('pconfig', ['cat', 'v', 'k'], ['cat' => $cat, 'uid' => $uid]); - } - - while ($config = $this->dba->fetch($configs)) { - $key = $config['k']; - $value = DbaUtils::toConfigValue($config['v']); - - // just save it in case it is set - if (isset($value)) { - $return[$config['cat']][$key] = $value; + try { + if (empty($cat)) { + $configs = $this->db->select(static::$table_name, ['cat', 'v', 'k'], ['uid' => $uid]); + } else { + $configs = $this->db->select(static::$table_name, ['cat', 'v', 'k'], ['cat' => $cat, 'uid' => $uid]); } + + while ($config = $this->db->fetch($configs)) { + $key = $config['k']; + $value = ValueConversion::toConfigValue($config['v']); + + // just save it in case it is set + if (isset($value)) { + $return[$config['cat']][$key] = $value; + } + } + } catch (\Exception $exception) { + throw new PConfigPersistenceException(sprintf('Cannot load config category %s for user %d', $cat, $uid), $exception); + } finally { + $this->db->close($configs); } - $this->dba->close($configs); return $return; } @@ -96,7 +101,7 @@ class PConfig * * @return array|string|null Stored value or null if it does not exist * - * @throws \Exception In case DB calls are invalid + * @throws PConfigPersistenceException In case the persistence layer throws errors */ public function get(int $uid, string $cat, string $key) { @@ -104,14 +109,18 @@ class PConfig return null; } - $config = $this->dba->selectFirst('pconfig', ['v'], ['uid' => $uid, 'cat' => $cat, 'k' => $key]); - if ($this->dba->isResult($config)) { - $value = DbaUtils::toConfigValue($config['v']); + try { + $config = $this->db->selectFirst('pconfig', ['v'], ['uid' => $uid, 'cat' => $cat, 'k' => $key]); + if ($this->db->isResult($config)) { + $value = ValueConversion::toConfigValue($config['v']); - // just return it in case it is set - if (isset($value)) { - return $value; + // just return it in case it is set + if (isset($value)) { + return $value; + } } + } catch (\Exception $exception) { + throw new PConfigPersistenceException(sprintf('Cannot get config value for category %s, key %s and user %d', $cat, $key, $uid), $exception); } return null; @@ -130,9 +139,9 @@ class PConfig * * @return bool Operation success * - * @throws \Exception In case DB calls are invalid + * @throws PConfigPersistenceException In case the persistence layer throws errors */ - public function set(int $uid, string $cat, string $key, $value) + public function set(int $uid, string $cat, string $key, $value): bool { if (!$this->isConnected()) { return false; @@ -148,11 +157,12 @@ class PConfig return true; } - $dbvalue = DbaUtils::toDbValue($value); - - $result = $this->dba->update('pconfig', ['v' => $dbvalue], ['uid' => $uid, 'cat' => $cat, 'k' => $key], true); - - return $result; + try { + $dbValue = ValueConversion::toDbValue($value); + return $this->db->update(static::$table_name, ['v' => $dbValue], ['uid' => $uid, 'cat' => $cat, 'k' => $key], true); + } catch (\Exception $exception) { + throw new PConfigPersistenceException(sprintf('Cannot set config value for category %s, key %s and user %d', $cat, $key, $uid), $exception); + } } /** @@ -164,14 +174,18 @@ class PConfig * * @return bool Operation success * - * @throws \Exception In case DB calls are invalid + * @throws PConfigPersistenceException In case the persistence layer throws errors */ - public function delete(int $uid, string $cat, string $key) + public function delete(int $uid, string $cat, string $key): bool { if (!$this->isConnected()) { return false; } - return $this->dba->delete('pconfig', ['uid' => $uid, 'cat' => $cat, 'k' => $key]); + try { + return $this->db->delete('pconfig', ['uid' => $uid, 'cat' => $cat, 'k' => $key]); + } catch (\Exception $exception) { + throw new PConfigPersistenceException(sprintf('Cannot delete config value for category %s, key %s and user %d', $cat, $key, $uid), $exception); + } } } diff --git a/src/Core/PConfig/Type/BasePConfig.php b/src/Core/PConfig/Type/AbstractPConfigValues.php similarity index 61% rename from src/Core/PConfig/Type/BasePConfig.php rename to src/Core/PConfig/Type/AbstractPConfigValues.php index 9ae374f2e..ddf8f6f95 100644 --- a/src/Core/PConfig/Type/BasePConfig.php +++ b/src/Core/PConfig/Type/AbstractPConfigValues.php @@ -21,45 +21,45 @@ namespace Friendica\Core\PConfig\Type; -use Friendica\Core\PConfig\Cache\Cache; -use Friendica\Core\PConfig\IPConfig; -use Friendica\Model; +use Friendica\Core\PConfig\Repository; +use Friendica\Core\PConfig\ValueObject\Cache; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; /** * This class is responsible for the user-specific configuration values in Friendica - * The values are set through the Config-DB-Table (per Config-DB-model @see Model\Config\PConfig) + * The values are set through the Config-DB-Table (per Config-DB-model @see Repository\PConfig) * - * The configuration cache (@see Cache\PConfigCache) is used for temporary caching of database calls. This will + * The configuration cache (@see Cache) is used for temporary caching of database calls. This will * increase the performance. */ -abstract class BasePConfig implements IPConfig +abstract class AbstractPConfigValues implements IManagePersonalConfigValues { /** - * @var \Friendica\Core\PConfig\Cache\Cache + * @var Cache */ protected $configCache; /** - * @var \Friendica\Core\PConfig\Model\PConfig + * @var Repository\PConfig */ protected $configModel; /** - * @param \Friendica\Core\PConfig\Cache\Cache $configCache The configuration cache - * @param \Friendica\Core\PConfig\Model\PConfig $configModel The configuration model + * @param Cache $configCache The configuration cache + * @param Repository\PConfig $configRepo The configuration model */ - public function __construct(Cache $configCache, \Friendica\Core\PConfig\Model\PConfig $configModel) + public function __construct(Cache $configCache, Repository\PConfig $configRepo) { $this->configCache = $configCache; - $this->configModel = $configModel; + $this->configModel = $configRepo; } /** * Returns the Config Cache * - * @return \Friendica\Core\PConfig\Cache\Cache + * @return Cache */ - public function getCache() + public function getCache(): Cache { return $this->configCache; } diff --git a/src/Core/PConfig/Type/JitPConfig.php b/src/Core/PConfig/Type/JitPConfig.php index 99c3b581b..14a8b2744 100644 --- a/src/Core/PConfig/Type/JitPConfig.php +++ b/src/Core/PConfig/Type/JitPConfig.php @@ -21,8 +21,8 @@ namespace Friendica\Core\PConfig\Type; -use Friendica\Core\PConfig\Cache\Cache; -use Friendica\Model; +use Friendica\Core\PConfig\Repository; +use Friendica\Core\PConfig\ValueObject; /** * This class implements the Just-In-Time configuration, which will cache @@ -31,7 +31,7 @@ use Friendica\Model; * Default Configuration type. * Provides the best performance for pages loading few configuration variables. */ -class JitPConfig extends BasePConfig +class JitPConfig extends AbstractPConfigValues { /** * @var array Array of already loaded db values (even if there was no value) @@ -39,12 +39,12 @@ class JitPConfig extends BasePConfig private $db_loaded; /** - * @param Cache $configCache The configuration cache - * @param \Friendica\Core\PConfig\Model\PConfig $configModel The configuration model + * @param ValueObject\Cache $configCache The configuration cache + * @param Repository\PConfig $configRepo The configuration model */ - public function __construct(Cache $configCache, \Friendica\Core\PConfig\Model\PConfig $configModel) + public function __construct(ValueObject\Cache $configCache, Repository\PConfig $configRepo) { - parent::__construct($configCache, $configModel); + parent::__construct($configCache, $configRepo); $this->db_loaded = []; } @@ -52,11 +52,11 @@ class JitPConfig extends BasePConfig * {@inheritDoc} * */ - public function load(int $uid, string $cat = 'config') + public function load(int $uid, string $cat = 'config'): array { // If not connected or no uid, do nothing if (!$uid || !$this->configModel->isConnected()) { - return; + return []; } $config = $this->configModel->load($uid, $cat); @@ -84,14 +84,12 @@ class JitPConfig extends BasePConfig // if the value isn't loaded or refresh is needed, load it to the cache if ($this->configModel->isConnected() && - (empty($this->db_loaded[$uid][$cat][$key]) || - $refresh)) { + (empty($this->db_loaded[$uid][$cat][$key]) || $refresh)) { + $dbValue = $this->configModel->get($uid, $cat, $key); - $dbvalue = $this->configModel->get($uid, $cat, $key); - - if (isset($dbvalue)) { - $this->configCache->set($uid, $cat, $key, $dbvalue); - unset($dbvalue); + if (isset($dbValue)) { + $this->configCache->set($uid, $cat, $key, $dbValue); + unset($dbValue); } $this->db_loaded[$uid][$cat][$key] = true; @@ -106,7 +104,7 @@ class JitPConfig extends BasePConfig /** * {@inheritDoc} */ - public function set(int $uid, string $cat, string $key, $value) + public function set(int $uid, string $cat, string $key, $value): bool { if (!$uid) { return false; @@ -130,7 +128,7 @@ class JitPConfig extends BasePConfig /** * {@inheritDoc} */ - public function delete(int $uid, string $cat, string $key) + public function delete(int $uid, string $cat, string $key): bool { if (!$uid) { return false; diff --git a/src/Core/PConfig/Type/PreloadPConfig.php b/src/Core/PConfig/Type/PreloadPConfig.php index 4498bb409..51f31691b 100644 --- a/src/Core/PConfig/Type/PreloadPConfig.php +++ b/src/Core/PConfig/Type/PreloadPConfig.php @@ -21,8 +21,8 @@ namespace Friendica\Core\PConfig\Type; -use Friendica\Core\PConfig\Cache\Cache; -use Friendica\Model; +use Friendica\Core\PConfig\Repository; +use Friendica\Core\PConfig\ValueObject; /** * This class implements the preload configuration, which will cache @@ -30,18 +30,18 @@ use Friendica\Model; * * Minimizes the number of database queries to retrieve configuration values at the cost of memory. */ -class PreloadPConfig extends BasePConfig +class PreloadPConfig extends AbstractPConfigValues { /** @var array */ private $config_loaded; /** - * @param \Friendica\Core\PConfig\Cache\Cache $configCache The configuration cache - * @param \Friendica\Core\PConfig\Model\PConfig $configModel The configuration model + * @param ValueObject\Cache $configCache The configuration cache + * @param Repository\PConfig $configRepo The configuration model */ - public function __construct(Cache $configCache, \Friendica\Core\PConfig\Model\PConfig $configModel) + public function __construct(ValueObject\Cache $configCache, Repository\PConfig $configRepo) { - parent::__construct($configCache, $configModel); + parent::__construct($configCache, $configRepo); $this->config_loaded = []; } @@ -51,16 +51,16 @@ class PreloadPConfig extends BasePConfig * This loads all config values everytime load is called * */ - public function load(int $uid, string $cat = 'config') + public function load(int $uid, string $cat = 'config'): array { // Don't load the whole configuration twice or with invalid uid if (!$uid || !empty($this->config_loaded[$uid])) { - return; + return []; } // If not connected, do nothing if (!$this->configModel->isConnected()) { - return; + return []; } $config = $this->configModel->load($uid); @@ -101,7 +101,7 @@ class PreloadPConfig extends BasePConfig /** * {@inheritDoc} */ - public function set(int $uid, string $cat, string $key, $value) + public function set(int $uid, string $cat, string $key, $value): bool { if (!$uid) { return false; @@ -127,7 +127,7 @@ class PreloadPConfig extends BasePConfig /** * {@inheritDoc} */ - public function delete(int $uid, string $cat, string $key) + public function delete(int $uid, string $cat, string $key): bool { if (!$uid) { return false; diff --git a/src/Core/PConfig/Cache/Cache.php b/src/Core/PConfig/ValueObject/Cache.php similarity index 85% rename from src/Core/PConfig/Cache/Cache.php rename to src/Core/PConfig/ValueObject/Cache.php index 97554b2fe..d6855199a 100644 --- a/src/Core/PConfig/Cache/Cache.php +++ b/src/Core/PConfig/ValueObject/Cache.php @@ -19,7 +19,7 @@ * */ -namespace Friendica\Core\PConfig\Cache; +namespace Friendica\Core\PConfig\ValueObject; use ParagonIE\HiddenString\HiddenString; @@ -31,7 +31,7 @@ class Cache /** * @var array */ - private $config; + private $config = []; /** * @var bool @@ -53,7 +53,7 @@ class Cache * @param int $uid * @param array $config */ - public function load($uid, array $config) + public function load(int $uid, array $config) { if (!is_int($uid)) { return; @@ -63,7 +63,6 @@ class Cache foreach ($categories as $category) { if (isset($config[$category]) && is_array($config[$category])) { - $keys = array_keys($config[$category]); foreach ($keys as $key) { @@ -81,11 +80,11 @@ class Cache * * @param int $uid User Id * @param string $cat Config category - * @param string $key Config key + * @param string|null $key Config key * - * @return null|string The value of the config entry or null if not set + * @return null|mixed The value of the config entry or null if not set */ - public function get($uid, string $cat, string $key = null) + public function get(int $uid, string $cat, ?string $key = null) { if (!is_int($uid)) { return null; @@ -112,7 +111,7 @@ class Cache * * @return bool Set successful */ - public function set($uid, string $cat, string $key, $value) + public function set(int $uid, string $cat, string $key, $value): bool { if (!is_int($uid)) { return false; @@ -127,8 +126,8 @@ class Cache } if ($this->hidePasswordOutput && - $key == 'password' && - !empty($value) && is_string($value)) { + $key == 'password' && + !empty($value) && is_string($value)) { $this->config[$uid][$cat][$key] = new HiddenString((string)$value); } else { $this->config[$uid][$cat][$key] = $value; @@ -147,7 +146,7 @@ class Cache * * @return bool true, if deleted */ - public function delete($uid, string $cat, string $key) + public function delete(int $uid, string $cat, string $key): bool { if (!is_int($uid)) { return false; @@ -171,9 +170,9 @@ class Cache /** * Returns the whole configuration * - * @return array The configuration + * @return string[][] The configuration */ - public function getAll() + public function getAll(): array { return $this->config; } @@ -181,11 +180,11 @@ class Cache /** * Returns an array with missing categories/Keys * - * @param array $config The array to check + * @param string[][] $config The array to check * - * @return array + * @return string[][] */ - public function keyDiff(array $config) + public function keyDiff(array $config): array { $return = []; diff --git a/src/Core/Process.php b/src/Core/Process.php index 3c1a13929..8bde3cc3d 100644 --- a/src/Core/Process.php +++ b/src/Core/Process.php @@ -22,7 +22,7 @@ namespace Friendica\Core; use Friendica\App; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Model; use Psr\Log\LoggerInterface; @@ -48,7 +48,7 @@ class Process private $mode; /** - * @var IConfig + * @var IManageConfigValues */ private $config; @@ -67,7 +67,7 @@ class Process */ private $pid; - public function __construct(LoggerInterface $logger, App\Mode $mode, IConfig $config, Model\Process $processModel, string $basepath, int $pid) + public function __construct(LoggerInterface $logger, App\Mode $mode, IManageConfigValues $config, Model\Process $processModel, string $basepath, int $pid) { $this->logger = $logger; $this->mode = $mode; @@ -176,7 +176,7 @@ class Process if (count($data) != 2) { continue; } - list($key, $val) = $data; + [$key, $val] = $data; $meminfo[$key] = (int)trim(str_replace('kB', '', $val)); $meminfo[$key] = (int)($meminfo[$key] / 1024); } diff --git a/src/Core/Session/ISession.php b/src/Core/Session/Capability/IHandleSessions.php similarity index 92% rename from src/Core/Session/ISession.php rename to src/Core/Session/Capability/IHandleSessions.php index 2b2bf32e5..7b863b76f 100644 --- a/src/Core/Session/ISession.php +++ b/src/Core/Session/Capability/IHandleSessions.php @@ -19,19 +19,19 @@ * */ -namespace Friendica\Core\Session; +namespace Friendica\Core\Session\Capability; /** * Contains all global supported Session methods */ -interface ISession +interface IHandleSessions { /** * Start the current session * * @return self The own Session instance */ - public function start(); + public function start(): IHandleSessions; /** * Checks if the key exists in this session @@ -40,7 +40,7 @@ interface ISession * * @return boolean True, if it exists */ - public function exists(string $name); + public function exists(string $name): bool; /** * Retrieves a key from the session super global or the defaults if the key is missing or the value is falsy. diff --git a/src/Core/Session/Factory/SessionFactory.php b/src/Core/Session/Factory/Session.php similarity index 64% rename from src/Core/Session/Factory/SessionFactory.php rename to src/Core/Session/Factory/Session.php index 510ff08c7..5062c33c5 100644 --- a/src/Core/Session/Factory/SessionFactory.php +++ b/src/Core/Session/Factory/Session.php @@ -22,10 +22,12 @@ namespace Friendica\Core\Session\Factory; use Friendica\App; -use Friendica\Core\Cache\ICache; -use Friendica\Core\Cache\Enum\Type; -use Friendica\Core\Config\IConfig; -use Friendica\Core\Session; +use Friendica\Core\Cache\Capability\ICanCache; +use Friendica\Core\Cache\Enum; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\Session\Capability\IHandleSessions; +use Friendica\Core\Session\Type; +use Friendica\Core\Session\Handler; use Friendica\Database\Database; use Friendica\Util\Profiler; use Psr\Log\LoggerInterface; @@ -33,7 +35,7 @@ use Psr\Log\LoggerInterface; /** * Factory for creating a valid Session for this run */ -class SessionFactory +class Session { /** @var string The plain, PHP internal session management */ const HANDLER_NATIVE = 'native'; @@ -45,43 +47,44 @@ class SessionFactory const HANDLER_DEFAULT = self::HANDLER_DATABASE; /** - * @param App\Mode $mode - * @param App\BaseURL $baseURL - * @param IConfig $config - * @param Database $dba - * @param ICache $cache - * @param LoggerInterface $logger - * @param array $server + * @param App\Mode $mode + * @param App\BaseURL $baseURL + * @param IManageConfigValues $config + * @param Database $dba + * @param ICanCache $cache + * @param LoggerInterface $logger + * @param Profiler $profiler + * @param array $server * - * @return Session\ISession + * @return IHandleSessions */ - public function createSession(App\Mode $mode, App\BaseURL $baseURL, IConfig $config, Database $dba, ICache $cache, LoggerInterface $logger, Profiler $profiler, array $server = []) + public function createSession(App\Mode $mode, App\BaseURL $baseURL, IManageConfigValues $config, Database $dba, ICanCache $cache, LoggerInterface $logger, Profiler $profiler, array $server = []) { $profiler->startRecording('session'); $session = null; try { if ($mode->isInstall() || $mode->isBackend()) { - $session = new Session\Type\Memory(); + $session = new Type\Memory(); } else { $session_handler = $config->get('system', 'session_handler', self::HANDLER_DEFAULT); - $handler = null; + $handler = null; switch ($session_handler) { case self::HANDLER_DATABASE: - $handler = new Session\Handler\Database($dba, $logger, $server); + $handler = new Handler\Database($dba, $logger, $server); break; case self::HANDLER_CACHE: // In case we're using the db as cache driver, use the native db session, not the cache - if ($config->get('system', 'cache_driver') === Type::DATABASE) { - $handler = new Session\Handler\Database($dba, $logger, $server); + if ($config->get('system', 'cache_driver') === Enum\Type::DATABASE) { + $handler = new Handler\Database($dba, $logger, $server); } else { - $handler = new Session\Handler\Cache($cache); + $handler = new Handler\Cache($cache, $logger); } break; } - $session = new Session\Type\Native($baseURL, $handler); + $session = new Type\Native($baseURL, $handler); } } finally { $profiler->stopRecording(); diff --git a/src/Core/Session/Handler/Cache.php b/src/Core/Session/Handler/Cache.php index dc1bfa6b7..ab888e81d 100644 --- a/src/Core/Session/Handler/Cache.php +++ b/src/Core/Session/Handler/Cache.php @@ -21,8 +21,10 @@ namespace Friendica\Core\Session\Handler; -use Friendica\Core\Cache\ICache; +use Friendica\Core\Cache\Capability\ICanCache; +use Friendica\Core\Cache\Exception\CachePersistenceException; use Friendica\Core\Session; +use Psr\Log\LoggerInterface; use SessionHandlerInterface; /** @@ -30,29 +32,37 @@ use SessionHandlerInterface; */ class Cache implements SessionHandlerInterface { - /** @var ICache */ + /** @var ICanCache */ private $cache; + /** @var LoggerInterface */ + private $logger; - public function __construct(ICache $cache) + public function __construct(ICanCache $cache, LoggerInterface $logger) { - $this->cache = $cache; + $this->cache = $cache; + $this->logger = $logger; } - public function open($save_path, $session_name) + public function open($path, $name): bool { return true; } - public function read($session_id) + public function read($id) { - if (empty($session_id)) { + if (empty($id)) { return ''; } - $data = $this->cache->get('session:' . $session_id); - if (!empty($data)) { - Session::$exists = true; - return $data; + try { + $data = $this->cache->get('session:' . $id); + if (!empty($data)) { + Session::$exists = true; + return $data; + } + } catch (CachePersistenceException $exception) { + $this->logger->warning('Cannot read session.'. ['id' => $id, 'exception' => $exception]); + return ''; } return ''; @@ -65,36 +75,45 @@ class Cache implements SessionHandlerInterface * on the case. Uses the Session::expire for existing session, 5 minutes * for newly created session. * - * @param string $session_id Session ID with format: [a-z0-9]{26} - * @param string $session_data Serialized session data + * @param string $id Session ID with format: [a-z0-9]{26} + * @param string $data Serialized session data * - * @return boolean Returns false if parameters are missing, true otherwise - * @throws \Exception + * @return bool Returns false if parameters are missing, true otherwise */ - public function write($session_id, $session_data) + public function write($id, $data): bool { - if (!$session_id) { + if (!$id) { return false; } - if (!$session_data) { - return $this->destroy($session_id); + if (!$data) { + return $this->destroy($id); } - return $this->cache->set('session:' . $session_id, $session_data, Session::$expire); + try { + return $this->cache->set('session:' . $id, $data, Session::$expire); + } catch (CachePersistenceException $exception) { + $this->logger->warning('Cannot write session', ['id' => $id, 'exception' => $exception]); + return false; + } } - public function close() + public function close(): bool { return true; } - public function destroy($id) + public function destroy($id): bool { - return $this->cache->delete('session:' . $id); + try { + return $this->cache->delete('session:' . $id); + } catch (CachePersistenceException $exception) { + $this->logger->warning('Cannot destroy session', ['id' => $id, 'exception' => $exception]); + return false; + } } - public function gc($maxlifetime) + public function gc($max_lifetime): bool { return true; } diff --git a/src/Core/Session/Handler/Database.php b/src/Core/Session/Handler/Database.php index c0467818c..b18d55db7 100644 --- a/src/Core/Session/Handler/Database.php +++ b/src/Core/Session/Handler/Database.php @@ -52,24 +52,29 @@ class Database implements SessionHandlerInterface $this->server = $server; } - public function open($save_path, $session_name) + public function open($path, $name): bool { return true; } - public function read($session_id) + public function read($id) { - if (empty($session_id)) { + if (empty($id)) { return ''; } - $session = $this->dba->selectFirst('session', ['data'], ['sid' => $session_id]); - if ($this->dba->isResult($session)) { - Session::$exists = true; - return $session['data']; + try { + $session = $this->dba->selectFirst('session', ['data'], ['sid' => $id]); + if ($this->dba->isResult($session)) { + Session::$exists = true; + return $session['data']; + } + } catch (\Exception $exception) { + $this->logger->warning('Cannot read session.'. ['id' => $id, 'exception' => $exception]); + return ''; } - $this->logger->notice('no data for session', ['session_id' => $session_id, 'uri' => $this->server['REQUEST_URI'] ?? '']); + $this->logger->notice('no data for session', ['session_id' => $id, 'uri' => $this->server['REQUEST_URI'] ?? '']); return ''; } @@ -81,49 +86,63 @@ class Database implements SessionHandlerInterface * on the case. Uses the Session::expire global for existing session, 5 minutes * for newly created session. * - * @param string $session_id Session ID with format: [a-z0-9]{26} - * @param string $session_data Serialized session data + * @param string $id Session ID with format: [a-z0-9]{26} + * @param string $data Serialized session data * - * @return boolean Returns false if parameters are missing, true otherwise - * @throws \Exception + * @return bool Returns false if parameters are missing, true otherwise */ - public function write($session_id, $session_data) + public function write($id, $data): bool { - if (!$session_id) { + if (!$id) { return false; } - if (!$session_data) { - return $this->destroy($session_id); + if (!$data) { + return $this->destroy($id); } $expire = time() + Session::$expire; $default_expire = time() + 300; - if (Session::$exists) { - $fields = ['data' => $session_data, 'expire' => $expire]; - $condition = ["`sid` = ? AND (`data` != ? OR `expire` != ?)", $session_id, $session_data, $expire]; - $this->dba->update('session', $fields, $condition); - } else { - $fields = ['sid' => $session_id, 'expire' => $default_expire, 'data' => $session_data]; - $this->dba->insert('session', $fields); + try { + if (Session::$exists) { + $fields = ['data' => $data, 'expire' => $expire]; + $condition = ["`sid` = ? AND (`data` != ? OR `expire` != ?)", $id, $data, $expire]; + $this->dba->update('session', $fields, $condition); + } else { + $fields = ['sid' => $id, 'expire' => $default_expire, 'data' => $data]; + $this->dba->insert('session', $fields); + } + } catch (\Exception $exception) { + $this->logger->warning('Cannot write session.'. ['id' => $id, 'exception' => $exception]); + return false; } return true; } - public function close() + public function close(): bool { return true; } - public function destroy($id) + public function destroy($id): bool { - return $this->dba->delete('session', ['sid' => $id]); + try { + return $this->dba->delete('session', ['sid' => $id]); + } catch (\Exception $exception) { + $this->logger->warning('Cannot destroy session.'. ['id' => $id, 'exception' => $exception]); + return false; + } } - public function gc($maxlifetime) + public function gc($max_lifetime): bool { - return $this->dba->delete('session', ["`expire` < ?", time()]); + try { + return $this->dba->delete('session', ["`expire` < ?", time()]); + } catch (\Exception $exception) { + $this->logger->warning('Cannot use garbage collector.'. ['exception' => $exception]); + return false; + } } } diff --git a/src/Core/Session/Type/AbstractSession.php b/src/Core/Session/Type/AbstractSession.php index 8126804db..832155741 100644 --- a/src/Core/Session/Type/AbstractSession.php +++ b/src/Core/Session/Type/AbstractSession.php @@ -21,15 +21,17 @@ namespace Friendica\Core\Session\Type; +use Friendica\Core\Session\Capability\IHandleSessions; + /** * Contains the base methods for $_SESSION interaction */ -class AbstractSession +class AbstractSession implements IHandleSessions { /** * {@inheritDoc} */ - public function start() + public function start(): IHandleSessions { return $this; } @@ -37,7 +39,7 @@ class AbstractSession /** * {@inheritDoc}} */ - public function exists(string $name) + public function exists(string $name): bool { return isset($_SESSION[$name]); } diff --git a/src/Core/Session/Type/Memory.php b/src/Core/Session/Type/Memory.php index 635d880e7..4d4020144 100644 --- a/src/Core/Session/Type/Memory.php +++ b/src/Core/Session/Type/Memory.php @@ -21,14 +21,14 @@ namespace Friendica\Core\Session\Type; -use Friendica\Core\Session\ISession; +use Friendica\Core\Session\Capability\IHandleSessions; /** * Usable for backend processes (daemon/worker) and testing * * @todo after replacing the last direct $_SESSION call, use a internal array instead of the global variable */ -class Memory extends AbstractSession implements ISession +class Memory extends AbstractSession implements IHandleSessions { public function __construct() { diff --git a/src/Core/Session/Type/Native.php b/src/Core/Session/Type/Native.php index 4edd9a962..8dfbc57c8 100644 --- a/src/Core/Session/Type/Native.php +++ b/src/Core/Session/Type/Native.php @@ -22,14 +22,14 @@ namespace Friendica\Core\Session\Type; use Friendica\App; -use Friendica\Core\Session\ISession; +use Friendica\Core\Session\Capability\IHandleSessions; use Friendica\Model\User\Cookie; use SessionHandlerInterface; /** * The native Session class which uses the PHP internal Session functions */ -class Native extends AbstractSession implements ISession +class Native extends AbstractSession implements IHandleSessions { public function __construct(App\BaseURL $baseURL, SessionHandlerInterface $handler = null) { @@ -49,7 +49,7 @@ class Native extends AbstractSession implements ISession /** * {@inheritDoc} */ - public function start() + public function start(): IHandleSessions { session_start(); return $this; diff --git a/src/Core/StorageManager.php b/src/Core/StorageManager.php index 61dd8d375..ee6b959ff 100644 --- a/src/Core/StorageManager.php +++ b/src/Core/StorageManager.php @@ -22,7 +22,7 @@ namespace Friendica\Core; use Exception; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Database\Database; use Friendica\Model\Storage; use Friendica\Network\HTTPException\InternalServerErrorException; @@ -56,7 +56,7 @@ class StorageManager /** @var Database */ private $dba; - /** @var IConfig */ + /** @var \Friendica\Core\Config\Capability\IManageConfigValues */ private $config; /** @var LoggerInterface */ private $logger; @@ -67,15 +67,15 @@ class StorageManager private $currentBackend; /** - * @param Database $dba - * @param IConfig $config - * @param LoggerInterface $logger - * @param L10n $l10n + * @param Database $dba + * @param IManageConfigValues $config + * @param LoggerInterface $logger + * @param L10n $l10n * * @throws Storage\InvalidClassStorageException in case the active backend class is invalid * @throws Storage\StorageException in case of unexpected errors during the active backend class loading */ - public function __construct(Database $dba, IConfig $config, LoggerInterface $logger, L10n $l10n) + public function __construct(Database $dba, IManageConfigValues $config, LoggerInterface $logger, L10n $l10n) { $this->dba = $dba; $this->config = $config; diff --git a/src/DI.php b/src/DI.php index 7e5f309b3..570d680df 100644 --- a/src/DI.php +++ b/src/DI.php @@ -155,35 +155,35 @@ abstract class DI // /** - * @return Core\Cache\ICache + * @return \Friendica\Core\Cache\Capability\ICanCache */ public static function cache() { - return self::$dice->create(Core\Cache\ICache::class); + return self::$dice->create(Core\Cache\Capability\ICanCache::class); } /** - * @return Core\Config\IConfig + * @return \Friendica\Core\Config\Capability\IManageConfigValues */ public static function config() { - return self::$dice->create(Core\Config\IConfig::class); + return self::$dice->create(Core\Config\Capability\IManageConfigValues::class); } /** - * @return Core\PConfig\IPConfig + * @return \Friendica\Core\PConfig\Capability\IManagePersonalConfigValues */ public static function pConfig() { - return self::$dice->create(Core\PConfig\IPConfig::class); + return self::$dice->create(Core\PConfig\Capability\IManagePersonalConfigValues::class); } /** - * @return Core\Lock\ILock + * @return \Friendica\Core\Lock\Capability\ICanLock */ public static function lock() { - return self::$dice->create(Core\Lock\ILock::class); + return self::$dice->create(Core\Lock\Capability\ICanLock::class); } /** @@ -203,11 +203,11 @@ abstract class DI } /** - * @return Core\Session\ISession + * @return \Friendica\Core\Session\Capability\IHandleSessions */ public static function session() { - return self::$dice->create(Core\Session\ISession::class); + return self::$dice->create(Core\Session\Capability\IHandleSessions::class); } /** diff --git a/src/Database/Database.php b/src/Database/Database.php index 4a8d5d36e..a6cc3f875 100644 --- a/src/Database/Database.php +++ b/src/Database/Database.php @@ -21,7 +21,7 @@ namespace Friendica\Database; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\Core\System; use Friendica\Network\HTTPException\InternalServerErrorException; use Friendica\Util\DateTimeFormat; @@ -49,7 +49,7 @@ class Database protected $connected = false; /** - * @var Cache + * @var \Friendica\Core\Config\ValueObject\Cache */ protected $configCache; /** diff --git a/src/Factory/HTTPClientFactory.php b/src/Factory/HTTPClientFactory.php index 12d9fd45f..18e2b0f55 100644 --- a/src/Factory/HTTPClientFactory.php +++ b/src/Factory/HTTPClientFactory.php @@ -4,7 +4,7 @@ namespace Friendica\Factory; use Friendica\App; use Friendica\BaseFactory; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Network\HTTPClient; use Friendica\Network\IHTTPClient; use Friendica\Util\Profiler; @@ -22,14 +22,14 @@ require_once __DIR__ . '/../../static/dbstructure.config.php'; class HTTPClientFactory extends BaseFactory { - /** @var IConfig */ + /** @var IManageConfigValues */ private $config; /** @var Profiler */ private $profiler; /** @var App\BaseURL */ private $baseUrl; - public function __construct(LoggerInterface $logger, IConfig $config, Profiler $profiler, App\BaseURL $baseUrl) + public function __construct(LoggerInterface $logger, IManageConfigValues $config, Profiler $profiler, App\BaseURL $baseUrl) { parent::__construct($logger); $this->config = $config; diff --git a/src/Factory/LoggerFactory.php b/src/Factory/LoggerFactory.php index ad6658b56..6467bf38d 100644 --- a/src/Factory/LoggerFactory.php +++ b/src/Factory/LoggerFactory.php @@ -21,7 +21,7 @@ namespace Friendica\Factory; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Logger; use Friendica\Database\Database; use Friendica\Network\HTTPException\InternalServerErrorException; @@ -68,14 +68,14 @@ class LoggerFactory /** * Creates a new PSR-3 compliant logger instances * - * @param Database $database The Friendica Database instance - * @param IConfig $config The config - * @param Profiler $profiler The profiler of the app - * @param FileSystem $fileSystem FileSystem utils + * @param Database $database The Friendica Database instance + * @param \Friendica\Core\Config\Capability\IManageConfigValues $config The config + * @param Profiler $profiler The profiler of the app + * @param FileSystem $fileSystem FileSystem utils * * @return LoggerInterface The PSR-3 compliant logger instance */ - public function create(Database $database, IConfig $config, Profiler $profiler, FileSystem $fileSystem) + public function create(Database $database, IManageConfigValues $config, Profiler $profiler, FileSystem $fileSystem) { if (empty($config->get('system', 'debugging', false))) { $logger = new VoidLogger(); @@ -156,16 +156,16 @@ class LoggerFactory * * It should never get filled during normal usage of Friendica * - * @param IConfig $config The config - * @param Profiler $profiler The profiler of the app - * @param FileSystem $fileSystem FileSystem utils + * @param \Friendica\Core\Config\Capability\IManageConfigValues $config The config + * @param Profiler $profiler The profiler of the app + * @param FileSystem $fileSystem FileSystem utils * * @return LoggerInterface The PSR-3 compliant logger instance * * @throws InternalServerErrorException * @throws \Exception */ - public static function createDev(IConfig $config, Profiler $profiler, FileSystem $fileSystem) + public static function createDev(IManageConfigValues $config, Profiler $profiler, FileSystem $fileSystem) { $debugging = $config->get('system', 'debugging'); $stream = $config->get('system', 'dlogfile'); diff --git a/src/Model/Storage/FilesystemConfig.php b/src/Model/Storage/FilesystemConfig.php index 735808e82..4c71d6cfd 100644 --- a/src/Model/Storage/FilesystemConfig.php +++ b/src/Model/Storage/FilesystemConfig.php @@ -21,7 +21,7 @@ namespace Friendica\Model\Storage; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; /** @@ -32,7 +32,7 @@ class FilesystemConfig implements IStorageConfiguration // Default base folder const DEFAULT_BASE_FOLDER = 'storage'; - /** @var IConfig */ + /** @var IManageConfigValues */ private $config; /** @var string */ @@ -54,10 +54,10 @@ class FilesystemConfig implements IStorageConfiguration /** * Filesystem constructor. * - * @param IConfig $config - * @param L10n $l10n + * @param \Friendica\Core\Config\Capability\IManageConfigValues $config + * @param L10n $l10n */ - public function __construct(IConfig $config, L10n $l10n) + public function __construct(IManageConfigValues $config, L10n $l10n) { $this->config = $config; $this->l10n = $l10n; diff --git a/src/Model/User/Cookie.php b/src/Model/User/Cookie.php index ca17ae09d..d0db091cb 100644 --- a/src/Model/User/Cookie.php +++ b/src/Model/User/Cookie.php @@ -22,7 +22,7 @@ namespace Friendica\Model\User; use Friendica\App; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; /** * Interacting with the Friendica Cookie of a user @@ -52,12 +52,12 @@ class Cookie private $data; /** - * @param IConfig $config - * @param App\BaseURL $baseURL - * @param array $SERVER The $_SERVER array - * @param array $COOKIE The $_COOKIE array + * @param \Friendica\Core\Config\Capability\IManageConfigValues $config + * @param App\BaseURL $baseURL + * @param array $SERVER The $_SERVER array + * @param array $COOKIE The $_COOKIE array */ - public function __construct(IConfig $config, App\BaseURL $baseURL, array $SERVER = [], array $COOKIE = []) + public function __construct(IManageConfigValues $config, App\BaseURL $baseURL, array $SERVER = [], array $COOKIE = []) { $this->sslEnabled = $baseURL->getSSLPolicy() === App\BaseURL::SSL_POLICY_FULL; $this->sitePrivateKey = $config->get('system', 'site_prvkey'); diff --git a/src/Module/Admin/Summary.php b/src/Module/Admin/Summary.php index 5077d3b5d..078f08721 100644 --- a/src/Module/Admin/Summary.php +++ b/src/Module/Admin/Summary.php @@ -22,18 +22,18 @@ namespace Friendica\Module\Admin; use Friendica\Core\Addon; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\Core\Logger; use Friendica\Core\Renderer; use Friendica\Core\Update; use Friendica\Database\DBA; use Friendica\Database\DBStructure; use Friendica\DI; -use Friendica\Core\Config\Factory\ConfigFactory; +use Friendica\Core\Config\Factory\Config; use Friendica\Model\Register; use Friendica\Module\BaseAdmin; use Friendica\Network\HTTPException\InternalServerErrorException; -use Friendica\Core\Config\Cache\ConfigFileLoader; +use Friendica\Core\Config\Util\ConfigFileLoader; use Friendica\Util\DateTimeFormat; class Summary extends BaseAdmin @@ -152,7 +152,7 @@ class Summary extends BaseAdmin } // check legacy basepath settings - $configLoader = (new ConfigFactory())->createConfigFileLoader($a->getBasePath(), $_SERVER); + $configLoader = (new Config())->createConfigFileLoader($a->getBasePath(), $_SERVER); $configCache = new Cache(); $configLoader->setupCache($configCache); $confBasepath = $configCache->get('system', 'basepath'); diff --git a/src/Module/Install.php b/src/Module/Install.php index b9ae763b7..bcd029246 100644 --- a/src/Module/Install.php +++ b/src/Module/Install.php @@ -24,7 +24,7 @@ namespace Friendica\Module; use Friendica\App; use Friendica\BaseModule; use Friendica\Core; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\Core\Renderer; use Friendica\Core\Theme; use Friendica\DI; @@ -371,11 +371,11 @@ class Install extends BaseModule /** * Checks the $_POST settings and updates the config Cache for it * - * @param Cache $configCache The current config cache - * @param array $post The $_POST data - * @param string $cat The category of the setting - * @param string $key The key of the setting - * @param null|string $default The default value + * @param \Friendica\Core\Config\ValueObject\Cache $configCache The current config cache + * @param array $post The $_POST data + * @param string $cat The category of the setting + * @param string $key The key of the setting + * @param null|string $default The default value */ private static function checkSetting(Cache $configCache, array $post, $cat, $key, $default = null) { diff --git a/src/Navigation/Notifications/Factory/Introduction.php b/src/Navigation/Notifications/Factory/Introduction.php index 916ddff67..c3a3cd46d 100644 --- a/src/Navigation/Notifications/Factory/Introduction.php +++ b/src/Navigation/Notifications/Factory/Introduction.php @@ -27,9 +27,9 @@ use Friendica\App\BaseURL; use Friendica\BaseFactory; use Friendica\Content\Text\BBCode; use Friendica\Core\L10n; -use Friendica\Core\PConfig\IPConfig; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Core\Protocol; -use Friendica\Core\Session\ISession; +use Friendica\Core\Session\Capability\IHandleSessions; use Friendica\Database\Database; use Friendica\Model\Contact; use Friendica\Module\BaseNotifications; @@ -51,14 +51,14 @@ class Introduction extends BaseFactory private $baseUrl; /** @var L10n */ private $l10n; - /** @var IPConfig */ + /** @var \Friendica\Core\PConfig\Capability\IManagePersonalConfigValues */ private $pConfig; - /** @var ISession */ + /** @var \Friendica\Core\Session\Capability\IHandleSessions */ private $session; /** @var string */ private $nick; - public function __construct(LoggerInterface $logger, Database $dba, BaseURL $baseUrl, L10n $l10n, App $app, IPConfig $pConfig, ISession $session) + public function __construct(LoggerInterface $logger, Database $dba, BaseURL $baseUrl, L10n $l10n, App $app, IManagePersonalConfigValues $pConfig, IHandleSessions $session) { parent::__construct($logger); diff --git a/src/Navigation/Notifications/Repository/Notify.php b/src/Navigation/Notifications/Repository/Notify.php index 3a6a4133c..a259150cf 100644 --- a/src/Navigation/Notifications/Repository/Notify.php +++ b/src/Navigation/Notifications/Repository/Notify.php @@ -5,7 +5,7 @@ namespace Friendica\Navigation\Notifications\Repository; use Friendica\App\BaseURL; use Friendica\BaseRepository; use Friendica\Content\Text\Plaintext; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Hook; use Friendica\Core\L10n; use Friendica\Core\System; @@ -33,7 +33,7 @@ class Notify extends BaseRepository /** @var BaseURL */ protected $baseUrl; - /** @var IConfig */ + /** @var \Friendica\Core\Config\Capability\IManageConfigValues */ protected $config; /** @var Emailer */ @@ -44,7 +44,7 @@ class Notify extends BaseRepository protected static $table_name = 'notify'; - public function __construct(Database $database, LoggerInterface $logger, L10n $l10n, BaseURL $baseUrl, IConfig $config, Emailer $emailer, Factory\Notification $notification, Factory\Notify $factory = null) + public function __construct(Database $database, LoggerInterface $logger, L10n $l10n, BaseURL $baseUrl, IManageConfigValues $config, Emailer $emailer, Factory\Notification $notification, Factory\Notify $factory = null) { $this->l10n = $l10n; $this->baseUrl = $baseUrl; diff --git a/src/Security/Authentication.php b/src/Security/Authentication.php index c0dc1e9aa..ce8bc3e32 100644 --- a/src/Security/Authentication.php +++ b/src/Security/Authentication.php @@ -23,8 +23,8 @@ namespace Friendica\Security; use Exception; use Friendica\App; -use Friendica\Core\Config\IConfig; -use Friendica\Core\PConfig\IPConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Core\Hook; use Friendica\Core\Session; use Friendica\Core\System; @@ -46,7 +46,7 @@ use Psr\Log\LoggerInterface; */ class Authentication { - /** @var IConfig */ + /** @var IManageConfigValues */ private $config; /** @var App\Mode */ private $mode; @@ -60,25 +60,25 @@ class Authentication private $logger; /** @var User\Cookie */ private $cookie; - /** @var Session\ISession */ + /** @var \Friendica\Core\Session\Capability\IHandleSessions */ private $session; - /** @var IPConfig */ + /** @var IManagePersonalConfigValues */ private $pConfig; /** * Authentication constructor. * - * @param IConfig $config - * @param App\Mode $mode - * @param App\BaseURL $baseUrl - * @param L10n $l10n - * @param Database $dba - * @param LoggerInterface $logger - * @param User\Cookie $cookie - * @param Session\ISession $session - * @param IPConfig $pConfig + * @param IManageConfigValues $config + * @param App\Mode $mode + * @param App\BaseURL $baseUrl + * @param L10n $l10n + * @param Database $dba + * @param LoggerInterface $logger + * @param User\Cookie $cookie + * @param \Friendica\Core\Session\Capability\IHandleSessions $session + * @param IManagePersonalConfigValues $pConfig */ - public function __construct(IConfig $config, App\Mode $mode, App\BaseURL $baseUrl, L10n $l10n, Database $dba, LoggerInterface $logger, User\Cookie $cookie, Session\ISession $session, IPConfig $pConfig) + public function __construct(IManageConfigValues $config, App\Mode $mode, App\BaseURL $baseUrl, L10n $l10n, Database $dba, LoggerInterface $logger, User\Cookie $cookie, Session\Capability\IHandleSessions $session, IManagePersonalConfigValues $pConfig) { $this->config = $config; $this->mode = $mode; diff --git a/src/Security/ExAuth.php b/src/Security/ExAuth.php index fd71dea71..0e1f42384 100644 --- a/src/Security/ExAuth.php +++ b/src/Security/ExAuth.php @@ -36,8 +36,8 @@ namespace Friendica\Security; use Exception; use Friendica\App; -use Friendica\Core\Config\IConfig; -use Friendica\Core\PConfig\IPConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Database\Database; use Friendica\DI; use Friendica\Model\User; @@ -54,11 +54,11 @@ class ExAuth */ private $appMode; /** - * @var IConfig + * @var \Friendica\Core\Config\Capability\IManageConfigValues */ private $config; /** - * @var IPConfig + * @var IManagePersonalConfigValues */ private $pConfig; /** @@ -71,14 +71,15 @@ class ExAuth private $baseURL; /** - * @param App\Mode $appMode - * @param IConfig $config - * @param IPConfig $pConfig - * @param Database $dba - * @param App\BaseURL $baseURL + * @param App\Mode $appMode + * @param IManageConfigValues $config + * @param \Friendica\Core\PConfig\Capability\IManagePersonalConfigValues $pConfig + * @param Database $dba + * @param App\BaseURL $baseURL + * * @throws Exception */ - public function __construct(App\Mode $appMode, IConfig $config, IPConfig $pConfig, Database $dba, App\BaseURL $baseURL) + public function __construct(App\Mode $appMode, IManageConfigValues $config, IManagePersonalConfigValues $pConfig, Database $dba, App\BaseURL $baseURL) { $this->appMode = $appMode; $this->config = $config; diff --git a/src/Util/EMailer/MailBuilder.php b/src/Util/EMailer/MailBuilder.php index 56034a696..1e623535d 100644 --- a/src/Util/EMailer/MailBuilder.php +++ b/src/Util/EMailer/MailBuilder.php @@ -23,7 +23,7 @@ namespace Friendica\Util\EMailer; use Exception; use Friendica\App\BaseURL; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; use Friendica\Core\Renderer; use Friendica\Model\User; @@ -42,7 +42,7 @@ abstract class MailBuilder /** @var L10n */ protected $l10n; - /** @var IConfig */ + /** @var IManageConfigValues */ protected $config; /** @var BaseURL */ protected $baseUrl; @@ -64,7 +64,7 @@ abstract class MailBuilder /** @var int */ protected $recipientUid = null; - public function __construct(L10n $l10n, BaseURL $baseUrl, IConfig $config, LoggerInterface $logger) + public function __construct(L10n $l10n, BaseURL $baseUrl, IManageConfigValues $config, LoggerInterface $logger) { $this->l10n = $l10n; $this->baseUrl = $baseUrl; diff --git a/src/Util/EMailer/NotifyMailBuilder.php b/src/Util/EMailer/NotifyMailBuilder.php index c6323436d..0f25704c5 100644 --- a/src/Util/EMailer/NotifyMailBuilder.php +++ b/src/Util/EMailer/NotifyMailBuilder.php @@ -24,7 +24,7 @@ namespace Friendica\Util\EMailer; use Exception; use Friendica\App\BaseURL; use Friendica\Content\Text\BBCode; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; use Friendica\Core\Renderer; use Friendica\Network\HTTPException\InternalServerErrorException; @@ -70,7 +70,7 @@ class NotifyMailBuilder extends MailBuilder /** @var string The item link */ private $itemLink = ''; - public function __construct(L10n $l10n, BaseURL $baseUrl, IConfig $config, LoggerInterface $logger, string $siteEmailAddress, string $siteName) + public function __construct(L10n $l10n, BaseURL $baseUrl, IManageConfigValues $config, LoggerInterface $logger, string $siteEmailAddress, string $siteName) { parent::__construct($l10n, $baseUrl, $config, $logger); diff --git a/src/Util/EMailer/SystemMailBuilder.php b/src/Util/EMailer/SystemMailBuilder.php index b03fa4251..fef051a39 100644 --- a/src/Util/EMailer/SystemMailBuilder.php +++ b/src/Util/EMailer/SystemMailBuilder.php @@ -24,7 +24,7 @@ namespace Friendica\Util\EMailer; use Exception; use Friendica\App\BaseURL; use Friendica\Content\Text\BBCode; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; use Friendica\Core\Renderer; use Friendica\Network\HTTPException\InternalServerErrorException; @@ -45,7 +45,7 @@ class SystemMailBuilder extends MailBuilder /** @var string */ protected $siteAdmin; - public function __construct(L10n $l10n, BaseURL $baseUrl, IConfig $config, LoggerInterface $logger, + public function __construct(L10n $l10n, BaseURL $baseUrl, IManageConfigValues $config, LoggerInterface $logger, string $siteEmailAddress, string $siteName) { parent::__construct($l10n, $baseUrl, $config, $logger); diff --git a/src/Util/Emailer.php b/src/Util/Emailer.php index 8116fbf85..8e63b638f 100644 --- a/src/Util/Emailer.php +++ b/src/Util/Emailer.php @@ -22,10 +22,10 @@ namespace Friendica\Util; use Friendica\App; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Hook; use Friendica\Core\L10n; -use Friendica\Core\PConfig\IPConfig; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Network\HTTPException\InternalServerErrorException; use Friendica\Object\EMail\IEmail; use Friendica\Protocol\Email; @@ -38,9 +38,9 @@ use Psr\Log\LoggerInterface; */ class Emailer { - /** @var IConfig */ + /** @var \Friendica\Core\Config\Capability\IManageConfigValues */ private $config; - /** @var IPConfig */ + /** @var \Friendica\Core\PConfig\Capability\IManagePersonalConfigValues */ private $pConfig; /** @var LoggerInterface */ private $logger; @@ -54,7 +54,7 @@ class Emailer /** @var string */ private $siteEmailName; - public function __construct(IConfig $config, IPConfig $pConfig, App\BaseURL $baseURL, LoggerInterface $logger, + public function __construct(IManageConfigValues $config, IManagePersonalConfigValues $pConfig, App\BaseURL $baseURL, LoggerInterface $logger, L10n $defaultLang) { $this->config = $config; diff --git a/src/Util/Profiler.php b/src/Util/Profiler.php index 0ff338353..7e04ee563 100644 --- a/src/Util/Profiler.php +++ b/src/Util/Profiler.php @@ -21,8 +21,8 @@ namespace Friendica\Util; -use Friendica\Core\Config\Cache\Cache; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\ValueObject\Cache; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\System; use Psr\Container\ContainerExceptionInterface; use Psr\Container\ContainerInterface; @@ -69,16 +69,16 @@ class Profiler implements ContainerInterface /** * Updates the enabling of the current profiler * - * @param IConfig $config + * @param IManageConfigValues $config */ - public function update(IConfig $config) + public function update(IManageConfigValues $config) { $this->enabled = $config->get('system', 'profiler'); $this->rendertime = $config->get('rendertime', 'callstack'); } /** - * @param \Friendica\Core\Config\Cache\Cache $configCache The configuration cache + * @param \Friendica\Core\Config\ValueObject\Cache $configCache The configuration cache */ public function __construct(Cache $configCache) { diff --git a/static/dependencies.config.php b/static/dependencies.config.php index 4591f4761..f4aacb340 100644 --- a/static/dependencies.config.php +++ b/static/dependencies.config.php @@ -41,7 +41,7 @@ use Friendica\Core\PConfig; use Friendica\Core\L10n; use Friendica\Core\Lock; use Friendica\Core\Process; -use Friendica\Core\Session\ISession; +use Friendica\Core\Session\Capability\IHandleSessions; use Friendica\Core\StorageManager; use Friendica\Database\Database; use Friendica\Factory; @@ -74,8 +74,8 @@ return [ $_SERVER ] ], - Config\Cache\ConfigFileLoader::class => [ - 'instanceOf' => Config\Factory\ConfigFactory::class, + Config\Util\ConfigFileLoader::class => [ + 'instanceOf' => Config\Factory\Config::class, 'call' => [ ['createConfigFileLoader', [ [Dice::INSTANCE => '$basepath'], @@ -83,8 +83,8 @@ return [ ], Dice::CHAIN_CALL], ], ], - Config\Cache\Cache::class => [ - 'instanceOf' => Config\Factory\ConfigFactory::class, + Config\ValueObject\Cache::class => [ + 'instanceOf' => Config\Factory\Config::class, 'call' => [ ['createCache', [$_SERVER], Dice::CHAIN_CALL], ], @@ -95,14 +95,14 @@ return [ ['determine', [], Dice::CHAIN_CALL], ], ], - Config\IConfig::class => [ - 'instanceOf' => Config\Factory\ConfigFactory::class, + Config\Capability\IManageConfigValues::class => [ + 'instanceOf' => Config\Factory\Config::class, 'call' => [ ['create', [], Dice::CHAIN_CALL], ], ], - PConfig\IPConfig::class => [ - 'instanceOf' => PConfig\Factory\PConfigFactory::class, + PConfig\Capability\IManagePersonalConfigValues::class => [ + 'instanceOf' => PConfig\Factory\PConfig::class, 'call' => [ ['create', [], Dice::CHAIN_CALL], ] @@ -158,20 +158,20 @@ return [ ['createDev', [], Dice::CHAIN_CALL], ] ], - Cache\ICache::class => [ - 'instanceOf' => Cache\Factory\CacheFactory::class, + Cache\Capability\ICanCache::class => [ + 'instanceOf' => Cache\Factory\Cache::class, 'call' => [ ['create', [], Dice::CHAIN_CALL], ], ], - Cache\IMemoryCache::class => [ - 'instanceOf' => Cache\Factory\CacheFactory::class, + Cache\Capability\ICanCacheInMemory::class => [ + 'instanceOf' => Cache\Factory\Cache::class, 'call' => [ ['create', [], Dice::CHAIN_CALL], ], ], - Lock\ILock::class => [ - 'instanceOf' => Lock\Factory\LockFactory::class, + Lock\Capability\ICanLock::class => [ + 'instanceOf' => Lock\Factory\Lock::class, 'call' => [ ['create', [], Dice::CHAIN_CALL], ], @@ -206,8 +206,8 @@ return [ $_SERVER, $_GET ], ], - ISession::class => [ - 'instanceOf' => \Friendica\Core\Session\Factory\SessionFactory::class, + IHandleSessions::class => [ + 'instanceOf' => \Friendica\Core\Session\Factory\Session::class, 'call' => [ ['createSession', [$_SERVER], Dice::CHAIN_CALL], ['start', [], Dice::CHAIN_CALL], diff --git a/tests/FixtureTest.php b/tests/FixtureTest.php index c09f874fa..17e606a9e 100644 --- a/tests/FixtureTest.php +++ b/tests/FixtureTest.php @@ -6,10 +6,10 @@ namespace Friendica\Test; use Dice\Dice; -use Friendica\Core\Config\Cache\Cache; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\ValueObject\Cache; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Session; -use Friendica\Core\Session\ISession; +use Friendica\Core\Session\Capability\IHandleSessions; use Friendica\Database\Database; use Friendica\Database\DBStructure; use Friendica\DI; @@ -33,10 +33,10 @@ abstract class FixtureTest extends DatabaseTest $this->dice = (new Dice()) ->addRules(include __DIR__ . '/../static/dependencies.config.php') ->addRule(Database::class, ['instanceOf' => StaticDatabase::class, 'shared' => true]) - ->addRule(ISession::class, ['instanceOf' => Session\Type\Memory::class, 'shared' => true, 'call' => null]); + ->addRule(IHandleSessions::class, ['instanceOf' => Session\Type\Memory::class, 'shared' => true, 'call' => null]); DI::init($this->dice); - /** @var IConfig $config */ + /** @var IManageConfigValues $config */ $configCache = $this->dice->create(Cache::class); $configCache->set('database', 'disable_pdo', true); diff --git a/tests/Util/AppMockTrait.php b/tests/Util/AppMockTrait.php index cca9bd37e..4e6e8640d 100644 --- a/tests/Util/AppMockTrait.php +++ b/tests/Util/AppMockTrait.php @@ -42,7 +42,7 @@ trait AppMockTrait protected $app; /** - * @var MockInterface|Config\IConfig The mocked Config Cache + * @var MockInterface|\Friendica\Core\Config\Capability\IManageConfigValues The mocked Config Cache */ protected $configMock; @@ -74,21 +74,21 @@ trait AppMockTrait $this->dice = \Mockery::mock(Dice::class)->makePartial(); $this->dice = $this->dice->addRules(include __DIR__ . '/../../static/dependencies.config.php'); - $this->configMock = \Mockery::mock(Config\Cache\Cache::class); + $this->configMock = \Mockery::mock(Config\ValueObject\Cache::class); $this->dice->shouldReceive('create') - ->with(Config\Cache\Cache::class) + ->with(Config\ValueObject\Cache::class) ->andReturn($this->configMock); $this->mode = \Mockery::mock(App\Mode::class); $this->dice->shouldReceive('create') ->with(App\Mode::class) ->andReturn($this->mode); - $configModel= \Mockery::mock(Config\Model\Config::class); + $configModel= \Mockery::mock(Config\Repository\Config::class); // Disable the adapter $configModel->shouldReceive('isConnected')->andReturn(false); $config = new Config\Type\JitConfig($this->configMock, $configModel); $this->dice->shouldReceive('create') - ->with(Config\IConfig::class) + ->with(Config\Capability\IManageConfigValues::class) ->andReturn($config); // Mocking App and most used functions diff --git a/tests/functional/DependencyCheckTest.php b/tests/functional/DependencyCheckTest.php index 3d207d07d..9065ca168 100644 --- a/tests/functional/DependencyCheckTest.php +++ b/tests/functional/DependencyCheckTest.php @@ -23,15 +23,15 @@ namespace Friendica\Test\functional; use Dice\Dice; use Friendica\App; -use Friendica\Core\Cache\ICache; -use Friendica\Core\Cache\IMemoryCache; -use Friendica\Core\Config\Cache\Cache; -use Friendica\Core\Config\IConfig; -use Friendica\Core\Lock\ILock; +use Friendica\Core\Cache\Capability\ICanCache; +use Friendica\Core\Cache\Capability\ICanCacheInMemory; +use Friendica\Core\Config\ValueObject\Cache; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\Lock\Capability\ICanLock; use Friendica\Database\Database; use Friendica\Test\Util\VFSTrait; use Friendica\Util\BasePath; -use Friendica\Core\Config\Cache\ConfigFileLoader; +use Friendica\Core\Config\Util\ConfigFileLoader; use Friendica\Util\Profiler; use PHPUnit\Framework\TestCase; use Psr\Log\LoggerInterface; @@ -158,10 +158,10 @@ class DependencyCheckTest extends TestCase public function testConfiguration() { - /** @var IConfig $config */ - $config = $this->dice->create(IConfig::class); + /** @var IManageConfigValues $config */ + $config = $this->dice->create(IManageConfigValues::class); - self::assertInstanceOf(IConfig::class, $config); + self::assertInstanceOf(IManageConfigValues::class, $config); self::assertNotEmpty($config->get('database', 'username')); } @@ -176,8 +176,8 @@ class DependencyCheckTest extends TestCase public function testDevLogger() { - /** @var IConfig $config */ - $config = $this->dice->create(IConfig::class); + /** @var IManageConfigValues $config */ + $config = $this->dice->create(IManageConfigValues::class); $config->set('system', 'dlogfile', $this->root->url() . '/friendica.log'); /** @var LoggerInterface $logger */ @@ -188,26 +188,26 @@ class DependencyCheckTest extends TestCase public function testCache() { - /** @var ICache $cache */ - $cache = $this->dice->create(ICache::class); + /** @var ICanCache $cache */ + $cache = $this->dice->create(ICanCache::class); - self::assertInstanceOf(ICache::class, $cache); + self::assertInstanceOf(ICanCache::class, $cache); } public function testMemoryCache() { - /** @var IMemoryCache $cache */ - $cache = $this->dice->create(IMemoryCache::class); + /** @var ICanCacheInMemory $cache */ + $cache = $this->dice->create(ICanCacheInMemory::class); // We need to check "just" ICache, because the default Cache is DB-Cache, which isn't a memorycache - self::assertInstanceOf(ICache::class, $cache); + self::assertInstanceOf(ICanCache::class, $cache); } public function testLock() { - /** @var ILock $cache */ - $lock = $this->dice->create(ILock::class); + /** @var ICanLock $cache */ + $lock = $this->dice->create(ICanLock::class); - self::assertInstanceOf(ILock::class, $lock); + self::assertInstanceOf(ICanLock::class, $lock); } } diff --git a/tests/legacy/ApiTest.php b/tests/legacy/ApiTest.php index 553eef2a0..90de2d647 100644 --- a/tests/legacy/ApiTest.php +++ b/tests/legacy/ApiTest.php @@ -6,8 +6,8 @@ namespace Friendica\Test\legacy; use Friendica\App; -use Friendica\Core\Config\IConfig; -use Friendica\Core\PConfig\IPConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Core\Protocol; use Friendica\DI; use Friendica\Network\HTTPException; @@ -45,7 +45,7 @@ class ApiTest extends FixtureTest /** @var App */ protected $app; - /** @var IConfig */ + /** @var IManageConfigValues */ protected $config; /** @@ -59,8 +59,8 @@ class ApiTest extends FixtureTest parent::setUp(); - /** @var IConfig $config */ - $this->config = $this->dice->create(IConfig::class); + /** @var \Friendica\Core\Config\Capability\IManageConfigValues $config */ + $this->config = $this->dice->create(IManageConfigValues::class); $this->config->set('system', 'url', 'http://localhost'); $this->config->set('system', 'hostname', 'localhost'); @@ -813,7 +813,7 @@ class ApiTest extends FixtureTest */ public function testApiGetUserWithFrioSchema() { - $pConfig = $this->dice->create(IPConfig::class); + $pConfig = $this->dice->create(IManagePersonalConfigValues::class); $pConfig->set($this->selfUser['id'], 'frio', 'schema', 'red'); $user = api_get_user($this->app); self::assertSelfUser($user); @@ -829,7 +829,7 @@ class ApiTest extends FixtureTest */ public function testApiGetUserWithEmptyFrioSchema() { - $pConfig = $this->dice->create(IPConfig::class); + $pConfig = $this->dice->create(IManagePersonalConfigValues::class); $pConfig->set($this->selfUser['id'], 'frio', 'schema', '---'); $user = api_get_user($this->app); self::assertSelfUser($user); @@ -845,7 +845,7 @@ class ApiTest extends FixtureTest */ public function testApiGetUserWithCustomFrioSchema() { - $pConfig = $this->dice->create(IPConfig::class); + $pConfig = $this->dice->create(IManagePersonalConfigValues::class); $pConfig->set($this->selfUser['id'], 'frio', 'schema', '---'); $pConfig->set($this->selfUser['id'], 'frio', 'nav_bg', '#123456'); $pConfig->set($this->selfUser['id'], 'frio', 'link_color', '#123456'); diff --git a/tests/src/App/ModeTest.php b/tests/src/App/ModeTest.php index c3a5c5e72..9f38a2546 100644 --- a/tests/src/App/ModeTest.php +++ b/tests/src/App/ModeTest.php @@ -24,7 +24,7 @@ namespace Friendica\Test\src\App; use Detection\MobileDetect; use Friendica\App\Mode; use Friendica\App\Module; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\Database\Database; use Friendica\Test\MockedTest; use Friendica\Test\Util\VFSTrait; diff --git a/tests/src/App/ModuleTest.php b/tests/src/App/ModuleTest.php index 730d1d886..a928a96bf 100644 --- a/tests/src/App/ModuleTest.php +++ b/tests/src/App/ModuleTest.php @@ -22,10 +22,10 @@ namespace Friendica\Test\src\App; use Friendica\App; -use Friendica\Core\Cache\ICache; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Cache\Capability\ICanCache; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; -use Friendica\Core\Lock\ILock; +use Friendica\Core\Lock\Capability\ICanLock; use Friendica\LegacyModule; use Friendica\Module\HTTPException\PageNotFound; use Friendica\Module\WellKnown\HostMeta; @@ -172,18 +172,18 @@ class ModuleTest extends DatabaseTest */ public function testModuleClass($assert, string $name, string $command, bool $privAdd) { - $config = Mockery::mock(IConfig::class); + $config = Mockery::mock(IManageConfigValues::class); $config->shouldReceive('get')->with('config', 'private_addons', false)->andReturn($privAdd)->atMost()->once(); $l10n = Mockery::mock(L10n::class); $l10n->shouldReceive('t')->andReturnUsing(function ($args) { return $args; }); - $cache = Mockery::mock(ICache::class); + $cache = Mockery::mock(ICanCache::class); $cache->shouldReceive('get')->with('routerDispatchData')->andReturn('')->atMost()->once(); $cache->shouldReceive('get')->with('lastRoutesFileModifiedTime')->andReturn('')->atMost()->once(); $cache->shouldReceive('set')->withAnyArgs()->andReturn(false)->atMost()->twice(); - $lock = Mockery::mock(ILock::class); + $lock = Mockery::mock(ICanLock::class); $lock->shouldReceive('acquire')->andReturn(true); $lock->shouldReceive('isLocked')->andReturn(false); diff --git a/tests/src/App/RouterTest.php b/tests/src/App/RouterTest.php index 3a3c0469b..1e9e5d5ee 100644 --- a/tests/src/App/RouterTest.php +++ b/tests/src/App/RouterTest.php @@ -22,9 +22,9 @@ namespace Friendica\Test\src\App; use Friendica\App\Router; -use Friendica\Core\Cache\ICache; +use Friendica\Core\Cache\Capability\ICanCache; use Friendica\Core\L10n; -use Friendica\Core\Lock\ILock; +use Friendica\Core\Lock\Capability\ICanLock; use Friendica\Module; use Friendica\Network\HTTPException\MethodNotAllowedException; use Friendica\Network\HTTPException\NotFoundException; @@ -37,11 +37,11 @@ class RouterTest extends TestCase /** @var L10n|MockInterface */ private $l10n; /** - * @var ICache + * @var ICanCache */ private $cache; /** - * @var ILock + * @var \Friendica\Core\Lock\Capability\ICanLock */ private $lock; @@ -52,11 +52,11 @@ class RouterTest extends TestCase $this->l10n = Mockery::mock(L10n::class); $this->l10n->shouldReceive('t')->andReturnUsing(function ($args) { return $args; }); - $this->cache = Mockery::mock(ICache::class); + $this->cache = Mockery::mock(ICanCache::class); $this->cache->shouldReceive('get')->andReturn(null); $this->cache->shouldReceive('set')->andReturn(false); - $this->lock = Mockery::mock(ILock::class); + $this->lock = Mockery::mock(ICanLock::class); $this->lock->shouldReceive('acquire')->andReturn(true); $this->lock->shouldReceive('isLocked')->andReturn(false); } diff --git a/tests/src/Console/AutomaticInstallationConsoleTest.php b/tests/src/Console/AutomaticInstallationConsoleTest.php index f11d38365..760a732d6 100644 --- a/tests/src/Console/AutomaticInstallationConsoleTest.php +++ b/tests/src/Console/AutomaticInstallationConsoleTest.php @@ -24,7 +24,7 @@ namespace Friendica\Test\src\Console; use Dice\Dice; use Friendica\App; use Friendica\Console\AutomaticInstallation; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\Core\Installer; use Friendica\Core\L10n; use Friendica\Core\Logger; @@ -53,7 +53,7 @@ class AutomaticInstallationConsoleTest extends ConsoleTest private $assertFileDb; /** - * @var \Friendica\Core\Config\Cache\Cache The configuration cache to check after each test + * @var \Friendica\Core\Config\ValueObject\Cache The configuration cache to check after each test */ private $configCache; diff --git a/tests/src/Console/ConfigConsoleTest.php b/tests/src/Console/ConfigConsoleTest.php index bea4399b3..36d8e8846 100644 --- a/tests/src/Console/ConfigConsoleTest.php +++ b/tests/src/Console/ConfigConsoleTest.php @@ -24,7 +24,7 @@ namespace Friendica\Test\src\Console; use Friendica\App; use Friendica\App\Mode; use Friendica\Console\Config; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Mockery; use Mockery\LegacyMockInterface; use Mockery\MockInterface; @@ -35,7 +35,7 @@ class ConfigConsoleTest extends ConsoleTest * @var App\Mode|MockInterface $appMode */ private $appMode; - /** @var IConfig|LegacyMockInterface|MockInterface */ + /** @var IManageConfigValues|LegacyMockInterface|MockInterface */ private $configMock; protected function setUp() : void @@ -52,7 +52,7 @@ class ConfigConsoleTest extends ConsoleTest $this->appMode->shouldReceive('has') ->andReturn(true); - $this->configMock = Mockery::mock(IConfig::class); + $this->configMock = Mockery::mock(IManageConfigValues::class); } public function testSetGetKeyValue() diff --git a/tests/src/Console/LockConsoleTest.php b/tests/src/Console/LockConsoleTest.php index 1f33be100..b8bbfc0b0 100644 --- a/tests/src/Console/LockConsoleTest.php +++ b/tests/src/Console/LockConsoleTest.php @@ -24,7 +24,7 @@ namespace Friendica\Test\src\Console; use Friendica\App; use Friendica\App\Mode; use Friendica\Console\Lock; -use Friendica\Core\Lock\ILock; +use Friendica\Core\Lock\Capability\ICanLock; use Mockery; use Mockery\MockInterface; @@ -36,7 +36,7 @@ class LockConsoleTest extends ConsoleTest private $appMode; /** - * @var ILock|MockInterface + * @var ICanLock|MockInterface */ private $lockMock; @@ -54,7 +54,7 @@ class LockConsoleTest extends ConsoleTest $this->appMode->shouldReceive('has') ->andReturn(true); - $this->lockMock = Mockery::mock(ILock::class); + $this->lockMock = Mockery::mock(ICanLock::class); } public function testList() diff --git a/tests/src/Console/ServerBlockConsoleTest.php b/tests/src/Console/ServerBlockConsoleTest.php index e19ebf9cb..c060a889e 100644 --- a/tests/src/Console/ServerBlockConsoleTest.php +++ b/tests/src/Console/ServerBlockConsoleTest.php @@ -22,7 +22,7 @@ namespace Friendica\Test\src\Console; use Friendica\Console\ServerBlock; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Mockery; class ServerBlockConsoleTest extends ConsoleTest @@ -38,7 +38,7 @@ class ServerBlockConsoleTest extends ConsoleTest ] ]; /** - * @var IConfig|Mockery\LegacyMockInterface|Mockery\MockInterface + * @var IManageConfigValues|Mockery\LegacyMockInterface|Mockery\MockInterface */ private $configMock; @@ -46,7 +46,7 @@ class ServerBlockConsoleTest extends ConsoleTest { parent::setUp(); - $this->configMock = Mockery::mock(IConfig::class); + $this->configMock = Mockery::mock(IManageConfigValues::class); } /** diff --git a/tests/src/Core/Cache/CacheTest.php b/tests/src/Core/Cache/CacheTest.php index 5e5d1c17d..b57aab391 100644 --- a/tests/src/Core/Cache/CacheTest.php +++ b/tests/src/Core/Cache/CacheTest.php @@ -21,8 +21,8 @@ namespace Friendica\Test\src\Core\Cache; -use Friendica\Core\Cache\ICache; -use Friendica\Core\Cache\IMemoryCache; +use Friendica\Core\Cache\Capability\ICanCache; +use Friendica\Core\Cache\Capability\ICanCacheInMemory; use Friendica\Test\MockedTest; use Friendica\Util\PidFile; @@ -34,12 +34,12 @@ abstract class CacheTest extends MockedTest protected $startTime = 1417011228; /** - * @var ICache + * @var ICanCache */ protected $instance; /** - * @var IMemoryCache + * @var \Friendica\Core\Cache\Capability\ICanCacheInMemory */ protected $cache; diff --git a/tests/src/Core/Cache/DatabaseCacheTest.php b/tests/src/Core/Cache/DatabaseCacheTest.php index 55011f87c..a1cc42840 100644 --- a/tests/src/Core/Cache/DatabaseCacheTest.php +++ b/tests/src/Core/Cache/DatabaseCacheTest.php @@ -22,7 +22,7 @@ namespace Friendica\Test\src\Core\Cache; use Friendica\Core\Cache; -use Friendica\Core\Config\Factory\ConfigFactory; +use Friendica\Core\Config\Factory\Config; use Friendica\Test\DatabaseTestTrait; use Friendica\Test\Util\Database\StaticDatabase; use Friendica\Test\Util\VFSTrait; @@ -53,8 +53,8 @@ class DatabaseCacheTest extends CacheTest $profiler->shouldReceive('saveTimestamp')->withAnyArgs()->andReturn(true); // load real config to avoid mocking every config-entry which is related to the Database class - $configFactory = new ConfigFactory(); - $loader = (new ConfigFactory())->createConfigFileLoader($this->root->url(), []); + $configFactory = new Config(); + $loader = (new Config())->createConfigFileLoader($this->root->url(), []); $configCache = $configFactory->createCache($loader); $dba = new StaticDatabase($configCache, $profiler, $logger); diff --git a/tests/src/Core/Cache/MemcacheCacheTest.php b/tests/src/Core/Cache/MemcacheCacheTest.php index 6916f5169..8b50a999d 100644 --- a/tests/src/Core/Cache/MemcacheCacheTest.php +++ b/tests/src/Core/Cache/MemcacheCacheTest.php @@ -23,7 +23,7 @@ namespace Friendica\Test\src\Core\Cache; use Exception; use Friendica\Core\Cache\Type\MemcacheCache; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Mockery; /** @@ -34,7 +34,7 @@ class MemcacheCacheTest extends MemoryCacheTest { protected function getInstance() { - $configMock = Mockery::mock(IConfig::class); + $configMock = Mockery::mock(IManageConfigValues::class); $host = $_SERVER['MEMCACHE_HOST'] ?? 'localhost'; $port = $_SERVER['MEMCACHE_PORT'] ?? '11211'; diff --git a/tests/src/Core/Cache/MemcachedCacheTest.php b/tests/src/Core/Cache/MemcachedCacheTest.php index cc912e364..831458c33 100644 --- a/tests/src/Core/Cache/MemcachedCacheTest.php +++ b/tests/src/Core/Cache/MemcachedCacheTest.php @@ -23,7 +23,7 @@ namespace Friendica\Test\src\Core\Cache; use Exception; use Friendica\Core\Cache\Type\MemcachedCache; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Mockery; use Psr\Log\NullLogger; @@ -35,7 +35,7 @@ class MemcachedCacheTest extends MemoryCacheTest { protected function getInstance() { - $configMock = Mockery::mock(IConfig::class); + $configMock = Mockery::mock(IManageConfigValues::class); $host = $_SERVER['MEMCACHED_HOST'] ?? 'localhost'; $port = $_SERVER['MEMCACHED_PORT'] ?? '11211'; diff --git a/tests/src/Core/Cache/MemoryCacheTest.php b/tests/src/Core/Cache/MemoryCacheTest.php index eca25fa69..5159cb458 100644 --- a/tests/src/Core/Cache/MemoryCacheTest.php +++ b/tests/src/Core/Cache/MemoryCacheTest.php @@ -22,12 +22,12 @@ namespace Friendica\Test\src\Core\Cache; use Exception; -use Friendica\Core\Cache\IMemoryCache; +use Friendica\Core\Cache\Capability\ICanCacheInMemory; abstract class MemoryCacheTest extends CacheTest { /** - * @var IMemoryCache + * @var \Friendica\Core\Cache\Capability\ICanCacheInMemory */ protected $instance; @@ -35,7 +35,7 @@ abstract class MemoryCacheTest extends CacheTest { parent::setUp(); - if (!($this->instance instanceof IMemoryCache)) { + if (!($this->instance instanceof ICanCacheInMemory)) { throw new Exception('MemoryCacheTest unsupported'); } } diff --git a/tests/src/Core/Cache/RedisCacheTest.php b/tests/src/Core/Cache/RedisCacheTest.php index f5c540d32..9a859cd10 100644 --- a/tests/src/Core/Cache/RedisCacheTest.php +++ b/tests/src/Core/Cache/RedisCacheTest.php @@ -23,7 +23,7 @@ namespace Friendica\Test\src\Core\Cache; use Exception; use Friendica\Core\Cache\Type\RedisCache; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Mockery; /** @@ -34,7 +34,7 @@ class RedisCacheTest extends MemoryCacheTest { protected function getInstance() { - $configMock = Mockery::mock(IConfig::class); + $configMock = Mockery::mock(IManageConfigValues::class); $host = $_SERVER['REDIS_HOST'] ?? 'localhost'; $port = $_SERVER['REDIS_PORT'] ?? 6379; diff --git a/tests/src/Core/Config/Cache/CacheTest.php b/tests/src/Core/Config/Cache/CacheTest.php index 530b5b482..b369127c0 100644 --- a/tests/src/Core/Config/Cache/CacheTest.php +++ b/tests/src/Core/Config/Cache/CacheTest.php @@ -49,7 +49,7 @@ class CacheTest extends MockedTest ]; } - private function assertConfigValues($data, Cache\Cache $configCache) + private function assertConfigValues($data, \Friendica\Core\Config\ValueObject\Cache $configCache) { foreach ($data as $cat => $values) { foreach ($values as $key => $value) { @@ -64,7 +64,7 @@ class CacheTest extends MockedTest */ public function testLoadConfigArray($data) { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configCache->load($data); self::assertConfigValues($data, $configCache); @@ -83,27 +83,27 @@ class CacheTest extends MockedTest ] ]; - $configCache = new Cache\Cache(); - $configCache->load($data, Cache\Cache::SOURCE_DB); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); + $configCache->load($data, \Friendica\Core\Config\ValueObject\Cache::SOURCE_DB); // doesn't override - Low Priority due Config file - $configCache->load($override, Cache\Cache::SOURCE_FILE); + $configCache->load($override, \Friendica\Core\Config\ValueObject\Cache::SOURCE_FILE); self::assertConfigValues($data, $configCache); // override the value - High Prio due Server Env - $configCache->load($override, Cache\Cache::SOURCE_ENV); + $configCache->load($override, \Friendica\Core\Config\ValueObject\Cache::SOURCE_ENV); self::assertEquals($override['system']['test'], $configCache->get('system', 'test')); self::assertEquals($override['system']['boolTrue'], $configCache->get('system', 'boolTrue')); // Don't overwrite server ENV variables - even in load mode - $configCache->load($data, Cache\Cache::SOURCE_DB); + $configCache->load($data, \Friendica\Core\Config\ValueObject\Cache::SOURCE_DB); self::assertEquals($override['system']['test'], $configCache->get('system', 'test')); self::assertEquals($override['system']['boolTrue'], $configCache->get('system', 'boolTrue')); // Overwrite ENV variables with ENV variables - $configCache->load($data, Cache\Cache::SOURCE_ENV); + $configCache->load($data, \Friendica\Core\Config\ValueObject\Cache::SOURCE_ENV); self::assertConfigValues($data, $configCache); self::assertNotEquals($override['system']['test'], $configCache->get('system', 'test')); @@ -115,7 +115,7 @@ class CacheTest extends MockedTest */ public function testLoadConfigArrayWrong() { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); // empty dataset $configCache->load([]); @@ -136,7 +136,7 @@ class CacheTest extends MockedTest */ public function testGetAll($data) { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configCache->load($data); $all = $configCache->getAll(); @@ -151,7 +151,7 @@ class CacheTest extends MockedTest */ public function testSetGet($data) { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); foreach ($data as $cat => $values) { foreach ($values as $key => $value) { @@ -167,7 +167,7 @@ class CacheTest extends MockedTest */ public function testGetEmpty() { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); self::assertNull($configCache->get('something', 'value')); } @@ -177,7 +177,7 @@ class CacheTest extends MockedTest */ public function testGetCat() { - $configCache = new Cache\Cache([ + $configCache = new \Friendica\Core\Config\ValueObject\Cache([ 'system' => [ 'key1' => 'value1', 'key2' => 'value2', @@ -205,7 +205,7 @@ class CacheTest extends MockedTest */ public function testDelete($data) { - $configCache = new Cache\Cache($data); + $configCache = new \Friendica\Core\Config\ValueObject\Cache($data); foreach ($data as $cat => $values) { foreach ($values as $key => $value) { @@ -222,7 +222,7 @@ class CacheTest extends MockedTest */ public function testKeyDiffWithResult($data) { - $configCache = new Cache\Cache($data); + $configCache = new \Friendica\Core\Config\ValueObject\Cache($data); $diffConfig = [ 'fakeCat' => [ @@ -239,7 +239,7 @@ class CacheTest extends MockedTest */ public function testKeyDiffWithoutResult($data) { - $configCache = new Cache\Cache($data); + $configCache = new \Friendica\Core\Config\ValueObject\Cache($data); $diffConfig = $configCache->getAll(); @@ -251,7 +251,7 @@ class CacheTest extends MockedTest */ public function testPasswordHide() { - $configCache = new Cache\Cache([ + $configCache = new \Friendica\Core\Config\ValueObject\Cache([ 'database' => [ 'password' => 'supersecure', 'username' => 'notsecured', @@ -268,7 +268,7 @@ class CacheTest extends MockedTest */ public function testPasswordShow() { - $configCache = new Cache\Cache([ + $configCache = new \Friendica\Core\Config\ValueObject\Cache([ 'database' => [ 'password' => 'supersecure', 'username' => 'notsecured', @@ -285,7 +285,7 @@ class CacheTest extends MockedTest */ public function testEmptyPassword() { - $configCache = new Cache\Cache([ + $configCache = new \Friendica\Core\Config\ValueObject\Cache([ 'database' => [ 'password' => '', 'username' => '', @@ -299,7 +299,7 @@ class CacheTest extends MockedTest public function testWrongTypePassword() { - $configCache = new Cache\Cache([ + $configCache = new \Friendica\Core\Config\ValueObject\Cache([ 'database' => [ 'password' => new stdClass(), 'username' => '', @@ -309,7 +309,7 @@ class CacheTest extends MockedTest self::assertNotEmpty($configCache->get('database', 'password')); self::assertEmpty($configCache->get('database', 'username')); - $configCache = new Cache\Cache([ + $configCache = new \Friendica\Core\Config\ValueObject\Cache([ 'database' => [ 'password' => 23, 'username' => '', @@ -327,19 +327,19 @@ class CacheTest extends MockedTest public function testSetOverrides($data) { - $configCache = new Cache\Cache(); - $configCache->load($data, Cache\Cache::SOURCE_DB); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); + $configCache->load($data, \Friendica\Core\Config\ValueObject\Cache::SOURCE_DB); // test with wrong override - self::assertFalse($configCache->set('system', 'test', '1234567', Cache\Cache::SOURCE_FILE)); + self::assertFalse($configCache->set('system', 'test', '1234567', \Friendica\Core\Config\ValueObject\Cache::SOURCE_FILE)); self::assertEquals($data['system']['test'], $configCache->get('system', 'test')); // test with override (equal) - self::assertTrue($configCache->set('system', 'test', '8910', Cache\Cache::SOURCE_DB)); + self::assertTrue($configCache->set('system', 'test', '8910', \Friendica\Core\Config\ValueObject\Cache::SOURCE_DB)); self::assertEquals('8910', $configCache->get('system', 'test')); // test with override (over) - self::assertTrue($configCache->set('system', 'test', '111213', Cache\Cache::SOURCE_ENV)); + self::assertTrue($configCache->set('system', 'test', '111213', \Friendica\Core\Config\ValueObject\Cache::SOURCE_ENV)); self::assertEquals('111213', $configCache->get('system', 'test')); } } diff --git a/tests/src/Core/Config/Cache/ConfigFileLoaderTest.php b/tests/src/Core/Config/Cache/ConfigFileLoaderTest.php index ed5cfa1ef..dcb5b88de 100644 --- a/tests/src/Core/Config/Cache/ConfigFileLoaderTest.php +++ b/tests/src/Core/Config/Cache/ConfigFileLoaderTest.php @@ -22,10 +22,10 @@ namespace Friendica\Test\src\Core\Config\Cache; use Friendica\Core\Config\Cache; -use Friendica\Core\Config\Factory\ConfigFactory; +use Friendica\Core\Config\Factory\Config; use Friendica\Test\MockedTest; use Friendica\Test\Util\VFSTrait; -use Friendica\Core\Config\Cache\ConfigFileLoader; +use Friendica\Core\Config\Util\ConfigFileLoader; use org\bovigo\vfs\vfsStream; class ConfigFileLoaderTest extends MockedTest @@ -48,10 +48,10 @@ class ConfigFileLoaderTest extends MockedTest $configFileLoader = new ConfigFileLoader( $this->root->url(), - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::CONFIG_DIR, - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::STATIC_DIR + $this->root->url() . DIRECTORY_SEPARATOR . Config::CONFIG_DIR, + $this->root->url() . DIRECTORY_SEPARATOR . Config::STATIC_DIR ); - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configFileLoader->setupCache($configCache); @@ -74,10 +74,10 @@ class ConfigFileLoaderTest extends MockedTest $configFileLoader = new ConfigFileLoader( $this->root->url(), - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::CONFIG_DIR, - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::STATIC_DIR + $this->root->url() . DIRECTORY_SEPARATOR . Config::CONFIG_DIR, + $this->root->url() . DIRECTORY_SEPARATOR . Config::STATIC_DIR ); - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configFileLoader->setupCache($configCache); } @@ -103,10 +103,10 @@ class ConfigFileLoaderTest extends MockedTest $configFileLoader = new ConfigFileLoader( $this->root->url(), - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::CONFIG_DIR, - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::STATIC_DIR + $this->root->url() . DIRECTORY_SEPARATOR . Config::CONFIG_DIR, + $this->root->url() . DIRECTORY_SEPARATOR . Config::STATIC_DIR ); - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configFileLoader->setupCache($configCache); @@ -140,10 +140,10 @@ class ConfigFileLoaderTest extends MockedTest $configFileLoader = new ConfigFileLoader( $this->root->url(), - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::CONFIG_DIR, - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::STATIC_DIR + $this->root->url() . DIRECTORY_SEPARATOR . Config::CONFIG_DIR, + $this->root->url() . DIRECTORY_SEPARATOR . Config::STATIC_DIR ); - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configFileLoader->setupCache($configCache); @@ -174,12 +174,12 @@ class ConfigFileLoaderTest extends MockedTest ->at($this->root) ->setContent(file_get_contents($file)); - $configFileLoader = new ConfigFileLoader( + $configFileLoader = new \Friendica\Core\Config\Util\ConfigFileLoader( $this->root->url(), - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::CONFIG_DIR, - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::STATIC_DIR + $this->root->url() . DIRECTORY_SEPARATOR . Config::CONFIG_DIR, + $this->root->url() . DIRECTORY_SEPARATOR . Config::STATIC_DIR ); - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configFileLoader->setupCache($configCache); @@ -228,10 +228,10 @@ class ConfigFileLoaderTest extends MockedTest ->at($this->root->getChild('addon')->getChild('test')->getChild('config')) ->setContent(file_get_contents($file)); - $configFileLoader = new ConfigFileLoader( + $configFileLoader = new \Friendica\Core\Config\Util\ConfigFileLoader( $this->root->url(), - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::CONFIG_DIR, - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::STATIC_DIR + $this->root->url() . DIRECTORY_SEPARATOR . Config::CONFIG_DIR, + $this->root->url() . DIRECTORY_SEPARATOR . Config::STATIC_DIR ); $conf = $configFileLoader->loadAddonConfig('test'); @@ -265,12 +265,12 @@ class ConfigFileLoaderTest extends MockedTest ->at($this->root->getChild('config')) ->setContent(file_get_contents($fileDir . 'B.config.php')); - $configFileLoader = new ConfigFileLoader( + $configFileLoader = new \Friendica\Core\Config\Util\ConfigFileLoader( $this->root->url(), - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::CONFIG_DIR, - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::STATIC_DIR + $this->root->url() . DIRECTORY_SEPARATOR . Config::CONFIG_DIR, + $this->root->url() . DIRECTORY_SEPARATOR . Config::STATIC_DIR ); - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configFileLoader->setupCache($configCache); @@ -299,12 +299,12 @@ class ConfigFileLoaderTest extends MockedTest ->at($this->root->getChild('config')) ->setContent(file_get_contents($fileDir . 'B.ini.php')); - $configFileLoader = new ConfigFileLoader( + $configFileLoader = new \Friendica\Core\Config\Util\ConfigFileLoader( $this->root->url(), - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::CONFIG_DIR, - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::STATIC_DIR + $this->root->url() . DIRECTORY_SEPARATOR . Config::CONFIG_DIR, + $this->root->url() . DIRECTORY_SEPARATOR . Config::STATIC_DIR ); - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configFileLoader->setupCache($configCache); @@ -333,12 +333,12 @@ class ConfigFileLoaderTest extends MockedTest ->at($this->root->getChild('config')) ->setContent(file_get_contents($fileDir . 'B.ini.php')); - $configFileLoader = new ConfigFileLoader( + $configFileLoader = new \Friendica\Core\Config\Util\ConfigFileLoader( $this->root->url(), - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::CONFIG_DIR, - $this->root->url() . DIRECTORY_SEPARATOR . ConfigFactory::STATIC_DIR + $this->root->url() . DIRECTORY_SEPARATOR . Config::CONFIG_DIR, + $this->root->url() . DIRECTORY_SEPARATOR . Config::STATIC_DIR ); - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configFileLoader->setupCache($configCache); @@ -353,8 +353,8 @@ class ConfigFileLoaderTest extends MockedTest { $this->delConfigFile('local.config.php'); - $configFileLoader = (new ConfigFactory())->createConfigFileLoader($this->root->url(), ['FRIENDICA_CONFIG_DIR' => '/a/wrong/dir/']); - $configCache = new Cache\Cache(); + $configFileLoader = (new Config())->createConfigFileLoader($this->root->url(), ['FRIENDICA_CONFIG_DIR' => '/a/wrong/dir/']); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configFileLoader->setupCache($configCache); @@ -379,8 +379,8 @@ class ConfigFileLoaderTest extends MockedTest ->at($this->root->getChild('config2')) ->setContent(file_get_contents($fileDir . 'B.config.php')); - $configFileLoader = (new ConfigFactory())->createConfigFileLoader($this->root->url(), ['FRIENDICA_CONFIG_DIR' => $this->root->getChild('config2')->url()]); - $configCache = new Cache\Cache(); + $configFileLoader = (new Config())->createConfigFileLoader($this->root->url(), ['FRIENDICA_CONFIG_DIR' => $this->root->getChild('config2')->url()]); + $configCache = new \Friendica\Core\Config\ValueObject\Cache(); $configFileLoader->setupCache($configCache); diff --git a/tests/src/Core/Config/ConfigTest.php b/tests/src/Core/Config/ConfigTest.php index e77085987..0c9788c9c 100644 --- a/tests/src/Core/Config/ConfigTest.php +++ b/tests/src/Core/Config/ConfigTest.php @@ -22,8 +22,8 @@ namespace Friendica\Test\src\Core\Config; use Friendica\Core\Config\Cache; -use Friendica\Core\Config\IConfig; -use Friendica\Core\Config\Model\Config as ConfigModel; +use Friendica\Core\Config\Capability\IManageConfigValues; +use Friendica\Core\Config\Repository\Config as ConfigModel; use Friendica\Test\MockedTest; use Mockery\MockInterface; use Mockery; @@ -33,10 +33,10 @@ abstract class ConfigTest extends MockedTest /** @var ConfigModel|MockInterface */ protected $configModel; - /** @var Cache\Cache */ + /** @var \Friendica\Core\Config\ValueObject\Cache */ protected $configCache; - /** @var IConfig */ + /** @var \Friendica\Core\Config\Capability\IManageConfigValues */ protected $testedConfig; /** @@ -61,11 +61,11 @@ abstract class ConfigTest extends MockedTest // Create the config model $this->configModel = Mockery::mock(ConfigModel::class); - $this->configCache = new Cache\Cache(); + $this->configCache = new \Friendica\Core\Config\ValueObject\Cache(); } /** - * @return IConfig + * @return \Friendica\Core\Config\Capability\IManageConfigValues */ abstract public function getInstance(); @@ -161,7 +161,7 @@ abstract class ConfigTest extends MockedTest ->once(); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); // assert config is loaded everytime self::assertConfig('config', $data['config']); @@ -176,7 +176,7 @@ abstract class ConfigTest extends MockedTest public function testLoad(array $data, array $load) { $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); foreach ($load as $loadedCats) { $this->testedConfig->load($loadedCats); @@ -257,7 +257,7 @@ abstract class ConfigTest extends MockedTest public function testCacheLoadDouble(array $data1, array $data2, array $expect = []) { $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); foreach ($data1 as $cat => $data) { $this->testedConfig->load($cat); @@ -282,7 +282,7 @@ abstract class ConfigTest extends MockedTest $this->configModel->shouldReceive('load')->withAnyArgs()->andReturn([])->once(); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); self::assertEmpty($this->testedConfig->getCache()->getAll()); } @@ -299,7 +299,7 @@ abstract class ConfigTest extends MockedTest ->times(3); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); self::assertTrue($this->testedConfig->set('test', 'it', $data)); @@ -317,7 +317,7 @@ abstract class ConfigTest extends MockedTest $this->configModel->shouldReceive('set')->with('test', 'it', $data)->andReturn(true)->once(); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); self::assertTrue($this->testedConfig->set('test', 'it', $data)); @@ -331,7 +331,7 @@ abstract class ConfigTest extends MockedTest public function testGetWrongWithoutDB() { $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); // without refresh self::assertNull($this->testedConfig->get('test', 'it')); @@ -353,10 +353,10 @@ abstract class ConfigTest extends MockedTest */ public function testGetWithRefresh($data) { - $this->configCache->load(['test' => ['it' => 'now']], Cache\Cache::SOURCE_FILE); + $this->configCache->load(['test' => ['it' => 'now']], \Friendica\Core\Config\ValueObject\Cache::SOURCE_FILE); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); // without refresh self::assertEquals('now', $this->testedConfig->get('test', 'it')); @@ -378,10 +378,10 @@ abstract class ConfigTest extends MockedTest */ public function testDeleteWithoutDB($data) { - $this->configCache->load(['test' => ['it' => $data]], Cache\Cache::SOURCE_FILE); + $this->configCache->load(['test' => ['it' => $data]], \Friendica\Core\Config\ValueObject\Cache::SOURCE_FILE); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); self::assertEquals($data, $this->testedConfig->get('test', 'it')); self::assertEquals($data, $this->testedConfig->getCache()->get('test', 'it')); @@ -398,7 +398,7 @@ abstract class ConfigTest extends MockedTest */ public function testDeleteWithDB() { - $this->configCache->load(['test' => ['it' => 'now', 'quarter' => 'true']], Cache\Cache::SOURCE_FILE); + $this->configCache->load(['test' => ['it' => 'now', 'quarter' => 'true']], \Friendica\Core\Config\ValueObject\Cache::SOURCE_FILE); $this->configModel->shouldReceive('delete') ->with('test', 'it') @@ -418,7 +418,7 @@ abstract class ConfigTest extends MockedTest ->once(); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); // directly set the value to the cache $this->testedConfig->getCache()->set('test', 'it', 'now'); @@ -444,9 +444,9 @@ abstract class ConfigTest extends MockedTest public function testSetGetHighPrio() { $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); - $this->testedConfig->getCache()->set('config', 'test', 'prio', Cache\Cache::SOURCE_FILE); + $this->testedConfig->getCache()->set('config', 'test', 'prio', \Friendica\Core\Config\ValueObject\Cache::SOURCE_FILE); self::assertEquals('prio', $this->testedConfig->get('config', 'test')); // now you have to get the new variable entry because of the new set the get refresh succeed as well @@ -460,10 +460,10 @@ abstract class ConfigTest extends MockedTest public function testSetGetLowPrio() { $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\Config\ValueObject\Cache::class, $this->testedConfig->getCache()); self::assertEquals('it', $this->testedConfig->get('config', 'test')); - $this->testedConfig->getCache()->set('config', 'test', 'prio', Cache\Cache::SOURCE_ENV); + $this->testedConfig->getCache()->set('config', 'test', 'prio', \Friendica\Core\Config\ValueObject\Cache::SOURCE_ENV); // now you have to get the env variable entry as output, even with a new set (which failed) and a get refresh self::assertFalse($this->testedConfig->set('config', 'test', '123')); self::assertEquals('prio', $this->testedConfig->get('config', 'test', '', true)); diff --git a/tests/src/Core/InstallerTest.php b/tests/src/Core/InstallerTest.php index bdb1d53c0..4742d41d8 100644 --- a/tests/src/Core/InstallerTest.php +++ b/tests/src/Core/InstallerTest.php @@ -23,7 +23,7 @@ namespace Friendica\Core; use Dice\Dice; -use Friendica\Core\Config\Cache\Cache; +use Friendica\Core\Config\ValueObject\Cache; use Friendica\DI; use Friendica\Network\IHTTPResult; use Friendica\Network\IHTTPClient; diff --git a/tests/src/Core/Lock/DatabaseLockDriverTest.php b/tests/src/Core/Lock/DatabaseLockDriverTest.php index e08a0d7ca..3bf0a96ef 100644 --- a/tests/src/Core/Lock/DatabaseLockDriverTest.php +++ b/tests/src/Core/Lock/DatabaseLockDriverTest.php @@ -22,7 +22,7 @@ namespace Friendica\Test\src\Core\Lock; use Friendica\Core\Lock\Type\DatabaseLock; -use Friendica\Core\Config\Factory\ConfigFactory; +use Friendica\Core\Config\Factory\Config; use Friendica\Test\DatabaseTestTrait; use Friendica\Test\Util\Database\StaticDatabase; use Friendica\Test\Util\VFSTrait; @@ -55,8 +55,8 @@ class DatabaseLockDriverTest extends LockTest $profiler->shouldReceive('saveTimestamp')->withAnyArgs()->andReturn(true); // load real config to avoid mocking every config-entry which is related to the Database class - $configFactory = new ConfigFactory(); - $loader = (new ConfigFactory())->createConfigFileLoader($this->root->url(), []); + $configFactory = new Config(); + $loader = (new Config())->createConfigFileLoader($this->root->url(), []); $configCache = $configFactory->createCache($loader); $dba = new StaticDatabase($configCache, $profiler, $logger); diff --git a/tests/src/Core/Lock/LockTest.php b/tests/src/Core/Lock/LockTest.php index 8fc4926b0..d1cca4c36 100644 --- a/tests/src/Core/Lock/LockTest.php +++ b/tests/src/Core/Lock/LockTest.php @@ -21,7 +21,7 @@ namespace Friendica\Test\src\Core\Lock; -use Friendica\Core\Lock\ILock; +use Friendica\Core\Lock\Capability\ICanLock; use Friendica\Test\MockedTest; abstract class LockTest extends MockedTest @@ -32,7 +32,7 @@ abstract class LockTest extends MockedTest protected $startTime = 1417011228; /** - * @var ILock + * @var ICanLock */ protected $instance; diff --git a/tests/src/Core/Lock/MemcacheCacheLockTest.php b/tests/src/Core/Lock/MemcacheCacheLockTest.php index a3068b6a5..14d18cfe2 100644 --- a/tests/src/Core/Lock/MemcacheCacheLockTest.php +++ b/tests/src/Core/Lock/MemcacheCacheLockTest.php @@ -23,7 +23,7 @@ namespace Friendica\Test\src\Core\Lock; use Exception; use Friendica\Core\Cache\Type\MemcacheCache; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Lock\Type\CacheLock; use Mockery; @@ -35,7 +35,7 @@ class MemcacheCacheLockTest extends LockTest { protected function getInstance() { - $configMock = Mockery::mock(IConfig::class); + $configMock = Mockery::mock(IManageConfigValues::class); $host = $_SERVER['MEMCACHE_HOST'] ?? 'localhost'; $port = $_SERVER['MEMCACHE_PORT'] ?? '11211'; diff --git a/tests/src/Core/Lock/MemcachedCacheLockTest.php b/tests/src/Core/Lock/MemcachedCacheLockTest.php index 26cc16f22..e623a12fa 100644 --- a/tests/src/Core/Lock/MemcachedCacheLockTest.php +++ b/tests/src/Core/Lock/MemcachedCacheLockTest.php @@ -23,7 +23,7 @@ namespace Friendica\Test\src\Core\Lock; use Exception; use Friendica\Core\Cache\Type\MemcachedCache; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Lock\Type\CacheLock; use Mockery; use Psr\Log\NullLogger; @@ -36,7 +36,7 @@ class MemcachedCacheLockTest extends LockTest { protected function getInstance() { - $configMock = Mockery::mock(IConfig::class); + $configMock = Mockery::mock(IManageConfigValues::class); $host = $_SERVER['MEMCACHED_HOST'] ?? 'localhost'; $port = $_SERVER['MEMCACHED_PORT'] ?? '11211'; diff --git a/tests/src/Core/Lock/RedisCacheLockTest.php b/tests/src/Core/Lock/RedisCacheLockTest.php index fba68b197..179de63a8 100644 --- a/tests/src/Core/Lock/RedisCacheLockTest.php +++ b/tests/src/Core/Lock/RedisCacheLockTest.php @@ -23,7 +23,7 @@ namespace Friendica\Test\src\Core\Lock; use Exception; use Friendica\Core\Cache\Type\RedisCache; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Lock\Type\CacheLock; use Mockery; @@ -35,7 +35,7 @@ class RedisCacheLockTest extends LockTest { protected function getInstance() { - $configMock = Mockery::mock(IConfig::class); + $configMock = Mockery::mock(IManageConfigValues::class); $host = $_SERVER['REDIS_HOST'] ?? 'localhost'; $port = $_SERVER['REDIS_PORT'] ?? 6379; diff --git a/tests/src/Core/Lock/SemaphoreLockTest.php b/tests/src/Core/Lock/SemaphoreLockTest.php index 59b110a33..17e83a37d 100644 --- a/tests/src/Core/Lock/SemaphoreLockTest.php +++ b/tests/src/Core/Lock/SemaphoreLockTest.php @@ -23,7 +23,7 @@ namespace Friendica\Test\src\Core\Lock; use Dice\Dice; use Friendica\App; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Config\Type\JitConfig; use Friendica\Core\Lock\Type\SemaphoreLock; use Friendica\DI; @@ -46,7 +46,7 @@ class SemaphoreLockTest extends LockTest ->shouldReceive('get') ->with('system', 'temppath') ->andReturn('/tmp/'); - $dice->shouldReceive('create')->with(IConfig::class)->andReturn($configMock); + $dice->shouldReceive('create')->with(IManageConfigValues::class)->andReturn($configMock); // @todo Because "get_temppath()" is using static methods, we have to initialize the BaseObject DI::init($dice); diff --git a/tests/src/Core/PConfig/Cache/CacheTest.php b/tests/src/Core/PConfig/Cache/CacheTest.php index 99e0e914d..53a46895d 100644 --- a/tests/src/Core/PConfig/Cache/CacheTest.php +++ b/tests/src/Core/PConfig/Cache/CacheTest.php @@ -47,7 +47,7 @@ class CacheTest extends MockedTest ]; } - private function assertConfigValues($data, Cache\Cache $configCache, $uid) + private function assertConfigValues($data, \Friendica\Core\PConfig\ValueObject\Cache $configCache, $uid) { foreach ($data as $cat => $values) { foreach ($values as $key => $value) { @@ -63,7 +63,7 @@ class CacheTest extends MockedTest */ public function testSetGet($data) { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); $uid = 345; foreach ($data as $cat => $values) { @@ -81,7 +81,7 @@ class CacheTest extends MockedTest */ public function testGetCat() { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); $uid = 345; $configCache->load($uid, [ @@ -113,7 +113,7 @@ class CacheTest extends MockedTest */ public function testDelete($data) { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); $uid = 345; foreach ($data as $cat => $values) { @@ -136,7 +136,7 @@ class CacheTest extends MockedTest */ public function testKeyDiffWithResult() { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); $diffConfig = [ 'fakeCat' => [ @@ -154,7 +154,7 @@ class CacheTest extends MockedTest */ public function testKeyDiffWithoutResult($data) { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); $configCache->load(1, $data); @@ -168,7 +168,7 @@ class CacheTest extends MockedTest */ public function testPasswordHide() { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); $configCache->load(1, [ 'database' => [ @@ -187,7 +187,7 @@ class CacheTest extends MockedTest */ public function testPasswordShow() { - $configCache = new Cache\Cache(false); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(false); $configCache->load(1, [ 'database' => [ @@ -206,7 +206,7 @@ class CacheTest extends MockedTest */ public function testEmptyPassword() { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); $configCache->load(1, [ 'database' => [ @@ -221,7 +221,7 @@ class CacheTest extends MockedTest public function testWrongTypePassword() { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); $configCache->load(1, [ 'database' => [ @@ -233,7 +233,7 @@ class CacheTest extends MockedTest self::assertNotEmpty($configCache->get(1, 'database', 'password')); self::assertEmpty($configCache->get(1, 'database', 'username')); - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); $configCache->load(1, [ 'database' => [ @@ -251,7 +251,7 @@ class CacheTest extends MockedTest */ public function testTwoUid() { - $configCache = new Cache\Cache(); + $configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); $configCache->load(1, [ 'cat1' => [ @@ -272,21 +272,4 @@ class CacheTest extends MockedTest self::assertNull($configCache->get(1, 'cat2', 'key2')); self::assertNull($configCache->get(2, 'cat1', 'key1')); } - - /** - * Test when using an invalid UID - * @todo check it the clean way before using the config class - */ - public function testInvalidUid() - { - // bad UID! - $uid = null; - - $configCache = new Cache\Cache(); - - self::assertNull($configCache->get($uid, 'cat1', 'cat2')); - - self::assertFalse($configCache->set($uid, 'cat1', 'key1', 'doesn\'t matter!')); - self::assertFalse($configCache->delete($uid, 'cat1', 'key1')); - } } diff --git a/tests/src/Core/PConfig/PConfigTest.php b/tests/src/Core/PConfig/PConfigTest.php index 9288b1058..1f0e89364 100644 --- a/tests/src/Core/PConfig/PConfigTest.php +++ b/tests/src/Core/PConfig/PConfigTest.php @@ -22,8 +22,8 @@ namespace Friendica\Test\src\Core\PConfig; use Friendica\Core\PConfig\Cache; -use Friendica\Core\PConfig\Type\BasePConfig; -use Friendica\Core\PConfig\Model\PConfig as PConfigModel; +use Friendica\Core\PConfig\Type\AbstractPConfigValues; +use Friendica\Core\PConfig\Repository\PConfig as PConfigModel; use Friendica\Test\MockedTest; use Mockery; use Mockery\MockInterface; @@ -33,10 +33,10 @@ abstract class PConfigTest extends MockedTest /** @var PConfigModel|MockInterface */ protected $configModel; - /** @var Cache\Cache */ + /** @var \Friendica\Core\PConfig\ValueObject\Cache */ protected $configCache; - /** @var BasePConfig */ + /** @var AbstractPConfigValues */ protected $testedConfig; /** @@ -63,11 +63,11 @@ abstract class PConfigTest extends MockedTest // Create the config model $this->configModel = Mockery::mock(PConfigModel::class); - $this->configCache = new Cache\Cache(); + $this->configCache = new \Friendica\Core\PConfig\ValueObject\Cache(); } /** - * @return \Friendica\Core\PConfig\Type\BasePConfig + * @return \Friendica\Core\PConfig\Type\AbstractPConfigValues */ abstract public function getInstance(); @@ -163,7 +163,7 @@ abstract class PConfigTest extends MockedTest public function testSetUp() { $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\PConfig\ValueObject\Cache::class, $this->testedConfig->getCache()); self::assertEmpty($this->testedConfig->getCache()->getAll()); } @@ -174,7 +174,7 @@ abstract class PConfigTest extends MockedTest public function testLoad(int $uid, array $data, array $possibleCats, array $load) { $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\PConfig\ValueObject\Cache::class, $this->testedConfig->getCache()); foreach ($load as $loadedCats) { $this->testedConfig->load($uid, $loadedCats); @@ -257,7 +257,7 @@ abstract class PConfigTest extends MockedTest public function testCacheLoadDouble(int $uid, array $data1, array $data2, array $expect) { $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\PConfig\ValueObject\Cache::class, $this->testedConfig->getCache()); foreach ($data1 as $cat => $data) { $this->testedConfig->load($uid, $cat); @@ -281,7 +281,7 @@ abstract class PConfigTest extends MockedTest public function testSetGetWithoutDB(int $uid, $data) { $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\PConfig\ValueObject\Cache::class, $this->testedConfig->getCache()); self::assertTrue($this->testedConfig->set($uid, 'test', 'it', $data)); @@ -302,7 +302,7 @@ abstract class PConfigTest extends MockedTest ->once(); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\PConfig\ValueObject\Cache::class, $this->testedConfig->getCache()); self::assertTrue($this->testedConfig->set($uid, 'test', 'it', $data)); @@ -316,7 +316,7 @@ abstract class PConfigTest extends MockedTest public function testGetWrongWithoutDB() { $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\PConfig\ValueObject\Cache::class, $this->testedConfig->getCache()); // without refresh self::assertNull($this->testedConfig->get(0, 'test', 'it')); @@ -341,7 +341,7 @@ abstract class PConfigTest extends MockedTest $this->configCache->load($uid, ['test' => ['it' => 'now']]); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\PConfig\ValueObject\Cache::class, $this->testedConfig->getCache()); // without refresh self::assertEquals('now', $this->testedConfig->get($uid, 'test', 'it')); @@ -366,7 +366,7 @@ abstract class PConfigTest extends MockedTest $this->configCache->load($uid, ['test' => ['it' => $data]]); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\PConfig\ValueObject\Cache::class, $this->testedConfig->getCache()); self::assertEquals($data, $this->testedConfig->get($uid, 'test', 'it')); self::assertEquals($data, $this->testedConfig->getCache()->get($uid, 'test', 'it')); @@ -405,7 +405,7 @@ abstract class PConfigTest extends MockedTest ->once(); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\PConfig\ValueObject\Cache::class, $this->testedConfig->getCache()); // directly set the value to the cache $this->testedConfig->getCache()->set($uid, 'test', 'it', 'now'); @@ -465,7 +465,7 @@ abstract class PConfigTest extends MockedTest $this->configCache->load($data2['uid'], $data2['data']); $this->testedConfig = $this->getInstance(); - self::assertInstanceOf(Cache\Cache::class, $this->testedConfig->getCache()); + self::assertInstanceOf(\Friendica\Core\PConfig\ValueObject\Cache::class, $this->testedConfig->getCache()); self::assertConfig($data1['uid'], 'cat1', $data1['data']['cat1']); self::assertConfig($data1['uid'], 'cat2', $data1['data']['cat2']); diff --git a/tests/src/Core/StorageManagerTest.php b/tests/src/Core/StorageManagerTest.php index b7e5715ed..f9d05e637 100644 --- a/tests/src/Core/StorageManagerTest.php +++ b/tests/src/Core/StorageManagerTest.php @@ -22,23 +22,22 @@ namespace Friendica\Test\src\Core; use Dice\Dice; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\Config\Type\PreloadConfig; use Friendica\Core\Hook; use Friendica\Core\L10n; -use Friendica\Core\Session\ISession; +use Friendica\Core\Session\Capability\IHandleSessions; +use Friendica\Core\Session\Type\Memory; use Friendica\Core\StorageManager; use Friendica\Database\Database; use Friendica\DI; -use Friendica\Core\Config\Factory\ConfigFactory; -use Friendica\Core\Config\Model\Config; +use Friendica\Core\Config\Factory\Config; +use Friendica\Core\Config\Repository; use Friendica\Model\Storage; -use Friendica\Core\Session; use Friendica\Network\HTTPClient; use Friendica\Test\DatabaseTest; use Friendica\Test\Util\Database\StaticDatabase; use Friendica\Test\Util\VFSTrait; -use Friendica\Core\Config\Cache\ConfigFileLoader; use Friendica\Util\Profiler; use org\bovigo\vfs\vfsStream; use Psr\Log\LoggerInterface; @@ -50,7 +49,7 @@ class StorageManagerTest extends DatabaseTest use VFSTrait; /** @var Database */ private $dba; - /** @var IConfig */ + /** @var IManageConfigValues */ private $config; /** @var LoggerInterface */ private $logger; @@ -75,13 +74,13 @@ class StorageManagerTest extends DatabaseTest $profiler->shouldReceive('saveTimestamp')->withAnyArgs()->andReturn(true); // load real config to avoid mocking every config-entry which is related to the Database class - $configFactory = new ConfigFactory(); + $configFactory = new Config(); $loader = $configFactory->createConfigFileLoader($this->root->url(), []); $configCache = $configFactory->createCache($loader); $this->dba = new StaticDatabase($configCache, $profiler, $this->logger); - $configModel = new Config($this->dba); + $configModel = new Repository\Config($this->dba); $this->config = new PreloadConfig($configCache, $configModel); $this->config->set('storage', 'name', 'Database'); $this->config->set('storage', 'filesystem_path', $this->root->getChild(Storage\FilesystemConfig::DEFAULT_BASE_FOLDER)->url()); @@ -253,7 +252,7 @@ class StorageManagerTest extends DatabaseTest $dice = (new Dice()) ->addRules(include __DIR__ . '/../../../static/dependencies.config.php') ->addRule(Database::class, ['instanceOf' => StaticDatabase::class, 'shared' => true]) - ->addRule(ISession::class, ['instanceOf' => Session\Type\Memory::class, 'shared' => true, 'call' => null]); + ->addRule(IHandleSessions::class, ['instanceOf' => Session\Type\Memory::class, 'shared' => true, 'call' => null]); DI::init($dice); $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n); @@ -281,7 +280,7 @@ class StorageManagerTest extends DatabaseTest $dice = (new Dice()) ->addRules(include __DIR__ . '/../../../static/dependencies.config.php') ->addRule(Database::class, ['instanceOf' => StaticDatabase::class, 'shared' => true]) - ->addRule(ISession::class, ['instanceOf' => Session\Type\Memory::class, 'shared' => true, 'call' => null]); + ->addRule(IHandleSessions::class, ['instanceOf' => Memory::class, 'shared' => true, 'call' => null]); DI::init($dice); $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n); diff --git a/tests/src/Model/ProcessTest.php b/tests/src/Model/ProcessTest.php index ecb4d52d4..d3ef38df9 100644 --- a/tests/src/Model/ProcessTest.php +++ b/tests/src/Model/ProcessTest.php @@ -2,7 +2,7 @@ namespace Friendica\Test\src\Model; -use Friendica\Core\Config\Factory\ConfigFactory; +use Friendica\Core\Config\Factory\Config; use Friendica\Model\Process; use Friendica\Test\DatabaseTest; use Friendica\Test\Util\Database\StaticDatabase; @@ -31,8 +31,8 @@ class ProcessTest extends DatabaseTest $profiler->shouldReceive('saveTimestamp')->withAnyArgs()->andReturn(true); // load real config to avoid mocking every config-entry which is related to the Database class - $configFactory = new ConfigFactory(); - $loader = (new ConfigFactory())->createConfigFileLoader($this->root->url(), []); + $configFactory = new Config(); + $loader = (new Config())->createConfigFileLoader($this->root->url(), []); $configCache = $configFactory->createCache($loader); $this->dba = new StaticDatabase($configCache, $profiler, $logger); diff --git a/tests/src/Model/Storage/DatabaseStorageTest.php b/tests/src/Model/Storage/DatabaseStorageTest.php index e92dd2135..796b8937c 100644 --- a/tests/src/Model/Storage/DatabaseStorageTest.php +++ b/tests/src/Model/Storage/DatabaseStorageTest.php @@ -21,7 +21,7 @@ namespace Friendica\Test\src\Model\Storage; -use Friendica\Core\Config\Factory\ConfigFactory; +use Friendica\Core\Config\Factory\Config; use Friendica\Model\Storage\Database; use Friendica\Test\DatabaseTestTrait; use Friendica\Test\Util\Database\StaticDatabase; @@ -52,8 +52,8 @@ class DatabaseStorageTest extends StorageTest $profiler->shouldReceive('saveTimestamp')->withAnyArgs()->andReturn(true); // load real config to avoid mocking every config-entry which is related to the Database class - $configFactory = new ConfigFactory(); - $loader = (new ConfigFactory())->createConfigFileLoader($this->root->url(), []); + $configFactory = new Config(); + $loader = (new Config())->createConfigFileLoader($this->root->url(), []); $configCache = $configFactory->createCache($loader); $dba = new StaticDatabase($configCache, $profiler, $logger); diff --git a/tests/src/Model/Storage/FilesystemStorageConfigTest.php b/tests/src/Model/Storage/FilesystemStorageConfigTest.php index 582130938..a5989b1cd 100644 --- a/tests/src/Model/Storage/FilesystemStorageConfigTest.php +++ b/tests/src/Model/Storage/FilesystemStorageConfigTest.php @@ -21,7 +21,7 @@ namespace Friendica\Test\src\Model\Storage; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; use Friendica\Model\Storage\FilesystemConfig; use Friendica\Model\Storage\IStorageConfiguration; @@ -46,7 +46,7 @@ class FilesystemStorageConfigTest extends StorageConfigTest { /** @var MockInterface|L10n $l10n */ $l10n = \Mockery::mock(L10n::class)->makePartial(); - $config = \Mockery::mock(IConfig::class); + $config = \Mockery::mock(IManageConfigValues::class); $config->shouldReceive('get') ->with('storage', 'filesystem_path', FilesystemConfig::DEFAULT_BASE_FOLDER) ->andReturn($this->root->getChild('storage')->url()); diff --git a/tests/src/Model/User/CookieTest.php b/tests/src/Model/User/CookieTest.php index c9656b84f..b833ef558 100644 --- a/tests/src/Model/User/CookieTest.php +++ b/tests/src/Model/User/CookieTest.php @@ -22,7 +22,7 @@ namespace Friendica\Test\src\Model\User; use Friendica\App\BaseURL; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Model\User\Cookie; use Friendica\Test\MockedTest; use Friendica\Test\Util\StaticCookie; @@ -30,7 +30,7 @@ use Mockery\MockInterface; class CookieTest extends MockedTest { - /** @var MockInterface|IConfig */ + /** @var MockInterface|\Friendica\Core\Config\Capability\IManageConfigValues */ private $config; /** @var MockInterface|BaseURL */ private $baseUrl; @@ -41,7 +41,7 @@ class CookieTest extends MockedTest parent::setUp(); - $this->config = \Mockery::mock(IConfig::class); + $this->config = \Mockery::mock(IManageConfigValues::class); $this->baseUrl = \Mockery::mock(BaseURL::class); } diff --git a/tests/src/Util/BaseURLTest.php b/tests/src/Util/BaseURLTest.php index 79f0637e3..4c15f440d 100644 --- a/tests/src/Util/BaseURLTest.php +++ b/tests/src/Util/BaseURLTest.php @@ -2,7 +2,7 @@ namespace Friendica\Test\src\Util; use Friendica\App\BaseURL; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Test\MockedTest; class BaseURLTest extends MockedTest @@ -173,7 +173,7 @@ class BaseURLTest extends MockedTest */ public function testCheck($server, $input, $assert) { - $configMock = \Mockery::mock(IConfig::class); + $configMock = \Mockery::mock(IManageConfigValues::class); $configMock->shouldReceive('get')->with('config', 'hostname')->andReturn($input['hostname']); $configMock->shouldReceive('get')->with('system', 'urlpath')->andReturn($input['urlPath']); $configMock->shouldReceive('get')->with('system', 'ssl_policy')->andReturn($input['sslPolicy']); @@ -295,7 +295,7 @@ class BaseURLTest extends MockedTest */ public function testSave($input, $save, $url) { - $configMock = \Mockery::mock(IConfig::class); + $configMock = \Mockery::mock(IManageConfigValues::class); $configMock->shouldReceive('get')->with('config', 'hostname')->andReturn($input['hostname']); $configMock->shouldReceive('get')->with('system', 'urlpath')->andReturn($input['urlPath']); $configMock->shouldReceive('get')->with('system', 'ssl_policy')->andReturn($input['sslPolicy']); @@ -333,7 +333,7 @@ class BaseURLTest extends MockedTest */ public function testSaveByUrl($input, $save, $url) { - $configMock = \Mockery::mock(IConfig::class); + $configMock = \Mockery::mock(IManageConfigValues::class); $configMock->shouldReceive('get')->with('config', 'hostname')->andReturn($input['hostname']); $configMock->shouldReceive('get')->with('system', 'urlpath')->andReturn($input['urlPath']); $configMock->shouldReceive('get')->with('system', 'ssl_policy')->andReturn($input['sslPolicy']); @@ -409,7 +409,7 @@ class BaseURLTest extends MockedTest */ public function testGetURL($sslPolicy, $ssl, $url, $assert) { - $configMock = \Mockery::mock(IConfig::class); + $configMock = \Mockery::mock(IManageConfigValues::class); $configMock->shouldReceive('get')->with('config', 'hostname')->andReturn('friendica.local'); $configMock->shouldReceive('get')->with('system', 'urlpath')->andReturn('new/test'); $configMock->shouldReceive('get')->with('system', 'ssl_policy')->andReturn($sslPolicy); @@ -467,7 +467,7 @@ class BaseURLTest extends MockedTest */ public function testCheckRedirectHTTPS($server, $forceSSL, $sslPolicy, $url, $redirect) { - $configMock = \Mockery::mock(IConfig::class); + $configMock = \Mockery::mock(IManageConfigValues::class); $configMock->shouldReceive('get')->with('config', 'hostname')->andReturn('friendica.local'); $configMock->shouldReceive('get')->with('system', 'urlpath')->andReturn('new/test'); $configMock->shouldReceive('get')->with('system', 'ssl_policy')->andReturn($sslPolicy); @@ -503,7 +503,7 @@ class BaseURLTest extends MockedTest */ public function testWrongSave($fail) { - $configMock = \Mockery::mock(IConfig::class); + $configMock = \Mockery::mock(IManageConfigValues::class); $configMock->shouldReceive('get')->with('config', 'hostname')->andReturn('friendica.local'); $configMock->shouldReceive('get')->with('system', 'urlpath')->andReturn('new/test'); $configMock->shouldReceive('get')->with('system', 'ssl_policy')->andReturn(BaseURL::DEFAULT_SSL_SCHEME); diff --git a/tests/src/Util/EMailerTest.php b/tests/src/Util/EMailerTest.php index 7f96e010a..21a0ffa2d 100644 --- a/tests/src/Util/EMailerTest.php +++ b/tests/src/Util/EMailerTest.php @@ -3,9 +3,9 @@ namespace Friendica\Test\src\Util; use Friendica\App\BaseURL; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; -use Friendica\Core\PConfig\IPConfig; +use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues; use Friendica\Object\EMail\IEmail; use Friendica\Test\MockedTest; use Friendica\Test\Util\EmailerSpy; @@ -26,9 +26,9 @@ class EMailerTest extends MockedTest use VFSTrait; use HookMockTrait; - /** @var IConfig|MockInterface */ + /** @var \Friendica\Core\Config\Capability\IManageConfigValues|MockInterface */ private $config; - /** @var IPConfig|MockInterface */ + /** @var \Friendica\Core\PConfig\Capability\IManagePersonalConfigValues|MockInterface */ private $pConfig; /** @var L10n|MockInterface */ private $l10n; @@ -41,12 +41,12 @@ class EMailerTest extends MockedTest $this->setUpVfsDir(); - $this->config = \Mockery::mock(IConfig::class); + $this->config = \Mockery::mock(IManageConfigValues::class); $this->config->shouldReceive('get')->withArgs(['config', 'sender_email'])->andReturn('test@friendica.local')->once(); $this->config->shouldReceive('get')->withArgs(['config', 'sitename', 'Friendica Social Network'])->andReturn('Friendica Social Network')->once(); $this->config->shouldReceive('get')->withArgs(['system', 'sendmail_params', true])->andReturn(true); - $this->pConfig = \Mockery::mock(IPConfig::class); + $this->pConfig = \Mockery::mock(IManagePersonalConfigValues::class); $this->l10n = \Mockery::mock(L10n::class); $this->baseUrl = \Mockery::mock(BaseURL::class); $this->baseUrl->shouldReceive('getHostname')->andReturn('friendica.local'); diff --git a/tests/src/Util/Emailer/MailBuilderTest.php b/tests/src/Util/Emailer/MailBuilderTest.php index 88452a9da..83c22d7ec 100644 --- a/tests/src/Util/Emailer/MailBuilderTest.php +++ b/tests/src/Util/Emailer/MailBuilderTest.php @@ -22,7 +22,7 @@ namespace Friendica\Test\src\Util\Emailer; use Friendica\App\BaseURL; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; use Friendica\Network\HTTPException\InternalServerErrorException; use Friendica\Object\EMail\IEmail; @@ -41,7 +41,7 @@ class MailBuilderTest extends MockedTest { use VFSTrait; - /** @var IConfig|MockInterface */ + /** @var IManageConfigValues|MockInterface */ private $config; /** @var L10n|MockInterface */ private $l10n; @@ -57,7 +57,7 @@ class MailBuilderTest extends MockedTest $this->setUpVfsDir(); - $this->config = \Mockery::mock(IConfig::class); + $this->config = \Mockery::mock(IManageConfigValues::class); $this->l10n = \Mockery::mock(L10n::class); $this->baseUrl = \Mockery::mock(BaseURL::class); $this->baseUrl->shouldReceive('getHostname')->andReturn('friendica.local'); diff --git a/tests/src/Util/Emailer/SystemMailBuilderTest.php b/tests/src/Util/Emailer/SystemMailBuilderTest.php index 87b51030f..6cb0708ed 100644 --- a/tests/src/Util/Emailer/SystemMailBuilderTest.php +++ b/tests/src/Util/Emailer/SystemMailBuilderTest.php @@ -22,7 +22,7 @@ namespace Friendica\Test\src\Util\Emailer; use Friendica\App\BaseURL; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Core\L10n; use Friendica\Test\MockedTest; use Friendica\Test\Util\VFSTrait; @@ -34,7 +34,7 @@ class SystemMailBuilderTest extends MockedTest { use VFSTrait; - /** @var IConfig */ + /** @var \Friendica\Core\Config\Capability\IManageConfigValues */ private $config; /** @var L10n */ private $l10n; @@ -47,7 +47,7 @@ class SystemMailBuilderTest extends MockedTest $this->setUpVfsDir(); - $this->config = \Mockery::mock(IConfig::class); + $this->config = \Mockery::mock(IManageConfigValues::class); $this->config->shouldReceive('get')->with('config', 'admin_name')->andReturn('Admin'); $this->l10n = \Mockery::mock(L10n::class); $this->l10n->shouldReceive('t')->andReturnUsing(function ($msg) { diff --git a/tests/src/Util/ProfilerTest.php b/tests/src/Util/ProfilerTest.php index 4c55c419b..9a9492d17 100644 --- a/tests/src/Util/ProfilerTest.php +++ b/tests/src/Util/ProfilerTest.php @@ -21,8 +21,8 @@ namespace Friendica\Test\src\Util; -use Friendica\Core\Config\Cache\Cache; -use Friendica\Core\Config\IConfig; +use Friendica\Core\Config\ValueObject\Cache; +use Friendica\Core\Config\Capability\IManageConfigValues; use Friendica\Test\MockedTest; use Friendica\Util\Profiler; use Mockery\MockInterface; @@ -256,7 +256,7 @@ class ProfilerTest extends MockedTest $profiler->saveTimestamp(time(), 'network', 'test1'); - $config = \Mockery::mock(IConfig::class); + $config = \Mockery::mock(IManageConfigValues::class); $config->shouldReceive('get') ->with('system', 'profiler') ->andReturn(false)