src/Core/Config/Model/Config.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core\Config\Model;
  23
  24 use Friendica\Core\Config\Capability\IManageConfigValues;
  25 use Friendica\Core\Config\Capability\ISetConfigValuesTransactionally;
  26 use Friendica\Core\Config\Exception\ConfigFileException;
  27 use Friendica\Core\Config\Exception\ConfigPersistenceException;
  28 use Friendica\Core\Config\Util\ConfigFileManager;
  29 use Friendica\Core\Config\ValueObject\Cache;
  30
  31 /**
  32  * Configuration model, which manages the whole system configuration
  33  */
  34 class Config implements IManageConfigValues
  35 {
  36         /** @var Cache */
  37         protected $configCache;
  38
  39         /** @var ConfigFileManager */
  40         protected $configFileManager;
  41
  42         /**
  43          * @param ConfigFileManager $configFileManager The configuration file manager to save back configs
  44          * @param Cache             $configCache       The configuration cache (based on the config-files)
  45          */
  46         public function __construct(ConfigFileManager $configFileManager, Cache $configCache)
  47         {
  48                 $this->configFileManager = $configFileManager;
  49                 $this->configCache       = $configCache;
  50         }
  51
  52         /**
  53          * {@inheritDoc}
  54          */
  55         public function getCache(): Cache
  56         {
  57                 return $this->configCache;
  58         }
  59
  60         /**     {@inheritDoc} */
  61         public function beginTransaction(): ISetConfigValuesTransactionally
  62         {
  63                 return new ConfigTransaction($this);
  64         }
  65
  66         /**
  67          * Saves the current Configuration back into the data config.
  68          * @see ConfigFileManager::CONFIG_DATA_FILE
  69          */
  70         protected function save()
  71         {
  72                 try {
  73                         $this->configFileManager->saveData($this->configCache);
  74                 } catch (ConfigFileException $e) {
  75                         throw new ConfigPersistenceException('Cannot save config', $e);
  76                 }
  77         }
  78
  79         /** {@inheritDoc} */
  80         public function reload()
  81         {
  82                 $configCache = new Cache();
  83
  84                 try {
  85                         $this->configFileManager->setupCache($configCache);
  86                 } catch (ConfigFileException $e) {
  87                         throw new ConfigPersistenceException('Cannot reload config', $e);
  88                 }
  89                 $this->configCache = $configCache;
  90         }
  91
  92         /** {@inheritDoc} */
  93         public function load(Cache $cache)
  94         {
  95                 $this->configCache = $cache;
  96                 $this->save();
  97         }
  98
  99         /** {@inheritDoc} */
 100         public function get(string $cat, string $key = null, $default_value = null)
 101         {
 102                 return $this->configCache->get($cat, $key) ?? $default_value;
 103         }
 104
 105         /** {@inheritDoc} */
 106         public function set(string $cat, string $key, $value): bool
 107         {
 108                 if ($this->configCache->set($cat, $key, $value, Cache::SOURCE_DATA)) {
 109                         $this->save();
 110                         return true;
 111                 } else {
 112                         return false;
 113                 }
 114         }
 115
 116         /** {@inheritDoc} */
 117         public function delete(string $cat, string $key): bool
 118         {
 119                 if ($this->configCache->delete($cat, $key, Cache::SOURCE_DATA)) {
 120                         $this->save();
 121                         return true;
 122                 } else {
 123                         return false;
 124                 }
 125         }
 126 }