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\PConfig\Repository;
24 use Friendica\Core\Config\Util\ValueConversion;
25 use Friendica\Core\PConfig\Exception\PConfigPersistenceException;
26 use Friendica\Database\Database;
29 * The Config model backend for users, which is using the general DB-model backend for user-configs
33 protected static $table_name = 'pconfig';
38 public function __construct(Database $db)
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 int $uid The id of the user to load
57 * @param string|null $cat The category of the configuration values to load
59 * @return string[][] The config array
61 * @throws PConfigPersistenceException In case the persistence layer throws errors
63 public function load(int $uid, ?string $cat = null): array
69 $configs = $this->db->select(static::$table_name, ['cat', 'v', 'k'], ['uid' => $uid]);
71 $configs = $this->db->select(static::$table_name, ['cat', 'v', 'k'], ['cat' => $cat, 'uid' => $uid]);
74 while ($config = $this->db->fetch($configs)) {
76 $value = ValueConversion::toConfigValue($config['v']);
78 // just save it in case it is set
80 $return[$config['cat']][$key] = $value;
83 } catch (\Exception $exception) {
84 throw new PConfigPersistenceException(sprintf('Cannot load config category %s for user %d', $cat, $uid), $exception);
86 $this->db->close($configs);
93 * Get a particular user config variable out of the DB with the
94 * given category name ($cat) and a key ($key).
96 * Note: Boolean variables are defined as 0/1 in the database
98 * @param int $uid The id of the user to load
99 * @param string $cat The category of the configuration value
100 * @param string $key The configuration key to query
102 * @return array|string|null Stored value or null if it does not exist
104 * @throws PConfigPersistenceException In case the persistence layer throws errors
106 public function get(int $uid, string $cat, string $key)
108 if (!$this->isConnected()) {
113 $config = $this->db->selectFirst('pconfig', ['v'], ['uid' => $uid, 'cat' => $cat, 'k' => $key]);
114 if ($this->db->isResult($config)) {
115 $value = ValueConversion::toConfigValue($config['v']);
117 // just return it in case it is set
122 } catch (\Exception $exception) {
123 throw new PConfigPersistenceException(sprintf('Cannot get config value for category %s, key %s and user %d', $cat, $key, $uid), $exception);
130 * Stores a config value ($value) in the category ($cat) under the key ($key) for a
133 * Note: Please do not store booleans - convert to 0/1 integer values!
135 * @param int $uid The id of the user to load
136 * @param string $cat The category of the configuration value
137 * @param string $key The configuration key to set
138 * @param mixed $value The value to store
140 * @return bool Operation success
142 * @throws PConfigPersistenceException In case the persistence layer throws errors
144 public function set(int $uid, string $cat, string $key, $value): bool
146 if (!$this->isConnected()) {
150 // We store our setting values in a string variable.
151 // So we have to do the conversion here so that the compare below works.
152 // The exception are array values.
153 $compare_value = (!is_array($value) ? (string)$value : $value);
154 $stored_value = $this->get($uid, $cat, $key);
156 if (isset($stored_value) && ($stored_value === $compare_value)) {
161 $dbValue = ValueConversion::toDbValue($value);
162 return $this->db->update(static::$table_name, ['v' => $dbValue], ['uid' => $uid, 'cat' => $cat, 'k' => $key], true);
163 } catch (\Exception $exception) {
164 throw new PConfigPersistenceException(sprintf('Cannot set config value for category %s, key %s and user %d', $cat, $key, $uid), $exception);
169 * Removes the configured value of the given user.
171 * @param int $uid The id of the user to load
172 * @param string $cat The category of the configuration value
173 * @param string $key The configuration key to delete
175 * @return bool Operation success
177 * @throws PConfigPersistenceException In case the persistence layer throws errors
179 public function delete(int $uid, string $cat, string $key): bool
181 if (!$this->isConnected()) {
186 return $this->db->delete('pconfig', ['uid' => $uid, 'cat' => $cat, 'k' => $key]);
187 } catch (\Exception $exception) {
188 throw new PConfigPersistenceException(sprintf('Cannot delete config value for category %s, key %s and user %d', $cat, $key, $uid), $exception);