3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Core\Config\Repository;
24 use Friendica\Core\Config\Exception\ConfigPersistenceException;
25 use Friendica\Core\Config\Util\ValueConversion;
26 use Friendica\Database\Database;
29 * The Config Repository, which is using the general DB-model backend for configs
36 public function __construct(Database $db)
41 protected static $table_name = 'config';
44 * Checks if the model is currently connected
48 public function isConnected(): bool
50 return $this->db->isConnected();
54 * Loads all configuration values and returns the loaded category as an array.
56 * @param string|null $cat The category of the configuration values to load
58 * @return array The config array
60 * @throws ConfigPersistenceException In case the persistence layer throws errors
62 public function load(?string $cat = null): array
68 $configs = $this->db->select(static::$table_name, ['cat', 'v', 'k']);
70 $configs = $this->db->select(static::$table_name, ['cat', 'v', 'k'], ['cat' => $cat]);
73 while ($config = $this->db->fetch($configs)) {
75 $value = ValueConversion::toConfigValue($config['v']);
77 // just save it in case it is set
79 $return[$config['cat']][$key] = $value;
82 } catch (\Exception $exception) {
83 throw new ConfigPersistenceException(sprintf('Cannot load config category %s', $cat), $exception);
85 $this->db->close($configs);
92 * Get a particular, system-wide config variable out of the DB with the
93 * given category name ($cat) and a key ($key).
95 * Note: Boolean variables are defined as 0/1 in the database
97 * @param string $cat The category of the configuration value
98 * @param string $key The configuration key to query
100 * @return array|string|null Stored value or null if it does not exist
102 * @throws ConfigPersistenceException In case the persistence layer throws errors
104 public function get(string $cat, string $key)
106 if (!$this->isConnected()) {
111 $config = $this->db->selectFirst(static::$table_name, ['v'], ['cat' => $cat, 'k' => $key]);
112 if ($this->db->isResult($config)) {
113 $value = ValueConversion::toConfigValue($config['v']);
115 // just return it in case it is set
120 } catch (\Exception $exception) {
121 throw new ConfigPersistenceException(sprintf('Cannot get config with category %s and key %s', $cat, $key), $exception);
128 * Stores a config value ($value) in the category ($cat) under the key ($key).
130 * Note: Please do not store booleans - convert to 0/1 integer values!
132 * @param string $cat The category of the configuration value
133 * @param string $key The configuration key to set
134 * @param mixed $value The value to store
136 * @return bool Operation success
138 * @throws ConfigPersistenceException In case the persistence layer throws errors
140 public function set(string $cat, string $key, $value): bool
142 if (!$this->isConnected()) {
146 // We store our setting values in a string variable.
147 // So we have to do the conversion here so that the compare below works.
148 // The exception are array values.
149 $compare_value = (!is_array($value) ? (string)$value : $value);
150 $stored_value = $this->get($cat, $key);
152 if (isset($stored_value) && ($stored_value === $compare_value)) {
156 $dbValue = ValueConversion::toDbValue($value);
159 return $this->db->update(static::$table_name, ['v' => $dbValue], ['cat' => $cat, 'k' => $key], true);
160 } catch (\Exception $exception) {
161 throw new ConfigPersistenceException(sprintf('Cannot set config with category %s and key %s', $cat, $key), $exception);
166 * Removes the configured value from the database.
168 * @param string $cat The category of the configuration value
169 * @param string $key The configuration key to delete
171 * @return bool Operation success
173 * @throws ConfigPersistenceException In case the persistence layer throws errors
175 public function delete(string $cat, string $key): bool
177 if (!$this->isConnected()) {
182 return $this->db->delete(static::$table_name, ['cat' => $cat, 'k' => $key]);
183 } catch (\Exception $exception) {
184 throw new ConfigPersistenceException(sprintf('Cannot delete config with category %s and key %s', $cat, $key), $exception);