1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\AppFramework\Services;
use InvalidArgumentException;
use JsonException;
use OCP\AppFramework\Services\IAppConfig;
use OCP\Exceptions\AppConfigTypeConflictException;
use OCP\Exceptions\AppConfigUnknownKeyException;
use OCP\IConfig;
class AppConfig implements IAppConfig {
public function __construct(
private IConfig $config,
/** @var \OC\AppConfig */
private \OCP\IAppConfig $appConfig,
private string $appName,
) {
}
/**
* @inheritDoc
*
* @return string[] list of stored config keys
* @since 20.0.0
*/
public function getAppKeys(): array {
return $this->appConfig->getKeys($this->appName);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param bool|null $lazy TRUE to search within lazy loaded config, NULL to search within all config
*
* @return bool TRUE if key exists
* @since 29.0.0
*/
public function hasAppKey(string $key, ?bool $lazy = false): bool {
return $this->appConfig->hasKey($this->appName, $key, $lazy);
}
/**
* @param string $key config key
* @param bool|null $lazy TRUE to search within lazy loaded config, NULL to search within all config
*
* @return bool
* @throws AppConfigUnknownKeyException if config key is not known
* @since 29.0.0
*/
public function isSensitive(string $key, ?bool $lazy = false): bool {
return $this->appConfig->isSensitive($this->appName, $key, $lazy);
}
/**
* @inheritDoc
*
* @param string $key config key
*
* @return bool TRUE if config is lazy loaded
* @throws AppConfigUnknownKeyException if config key is not known
* @see \OCP\IAppConfig for details about lazy loading
* @since 29.0.0
*/
public function isLazy(string $key): bool {
return $this->appConfig->isLazy($this->appName, $key);
}
/**
* @inheritDoc
*
* @param string $key config keys prefix to search
* @param bool $filtered TRUE to hide sensitive config values. Value are replaced by {@see IConfig::SENSITIVE_VALUE}
*
* @return array<string, string|int|float|bool|array> [configKey => configValue]
* @since 29.0.0
*/
public function getAllAppValues(string $key = '', bool $filtered = false): array {
return $this->appConfig->getAllValues($this->appName, $key, $filtered);
}
/**
* @inheritDoc
*
* @param string $key the key of the value, under which will be saved
* @param string $value the value that should be stored
* @since 20.0.0
* @deprecated 29.0.0 use {@see setAppValueString()}
*/
public function setAppValue(string $key, string $value): void {
/** @psalm-suppress InternalMethod */
$this->appConfig->setValueMixed($this->appName, $key, $value);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param string $value config value
* @param bool $lazy set config as lazy loaded
* @param bool $sensitive if TRUE value will be hidden when listing config values.
*
* @return bool TRUE if value was different, therefor updated in database
* @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
* @since 29.0.0
* @see \OCP\IAppConfig for explanation about lazy loading
*/
public function setAppValueString(
string $key,
string $value,
bool $lazy = false,
bool $sensitive = false
): bool {
return $this->appConfig->setValueString($this->appName, $key, $value, $lazy, $sensitive);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param int $value config value
* @param bool $lazy set config as lazy loaded
* @param bool $sensitive if TRUE value will be hidden when listing config values.
*
* @return bool TRUE if value was different, therefor updated in database
* @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
* @since 29.0.0
* @see \OCP\IAppConfig for explanation about lazy loading
*/
public function setAppValueInt(
string $key,
int $value,
bool $lazy = false,
bool $sensitive = false
): bool {
return $this->appConfig->setValueInt($this->appName, $key, $value, $lazy, $sensitive);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param float $value config value
* @param bool $lazy set config as lazy loaded
* @param bool $sensitive if TRUE value will be hidden when listing config values.
*
* @return bool TRUE if value was different, therefor updated in database
* @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
* @since 29.0.0
* @see \OCP\IAppConfig for explanation about lazy loading
*/
public function setAppValueFloat(
string $key,
float $value,
bool $lazy = false,
bool $sensitive = false
): bool {
return $this->appConfig->setValueFloat($this->appName, $key, $value, $lazy, $sensitive);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param bool $value config value
* @param bool $lazy set config as lazy loaded
*
* @return bool TRUE if value was different, therefor updated in database
* @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
* @since 29.0.0
* @see \OCP\IAppConfig for explanation about lazy loading
*/
public function setAppValueBool(
string $key,
bool $value,
bool $lazy = false
): bool {
return $this->appConfig->setValueBool($this->appName, $key, $value, $lazy);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param array $value config value
* @param bool $lazy set config as lazy loaded
* @param bool $sensitive if TRUE value will be hidden when listing config values.
*
* @return bool TRUE if value was different, therefor updated in database
* @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
* @throws JsonException
* @since 29.0.0
* @see \OCP\IAppConfig for explanation about lazy loading
*/
public function setAppValueArray(
string $key,
array $value,
bool $lazy = false,
bool $sensitive = false
): bool {
return $this->appConfig->setValueArray($this->appName, $key, $value, $lazy, $sensitive);
}
/**
* @param string $key
* @param string $default
*
* @since 20.0.0
* @deprecated 29.0.0 use {@see getAppValueString()}
* @return string
*/
public function getAppValue(string $key, string $default = ''): string {
/** @psalm-suppress InternalMethod */
/** @psalm-suppress UndefinedInterfaceMethod */
return $this->appConfig->getValueMixed($this->appName, $key, $default);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param string $default default value
* @param bool $lazy search within lazy loaded config
*
* @return string stored config value or $default if not set in database
* @throws InvalidArgumentException if one of the argument format is invalid
* @throws AppConfigTypeConflictException in case of conflict with the value type set in database
* @since 29.0.0
* @see \OCP\IAppConfig for explanation about lazy loading
*/
public function getAppValueString(string $key, string $default = '', bool $lazy = false): string {
return $this->appConfig->getValueString($this->appName, $key, $default, $lazy);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param int $default default value
* @param bool $lazy search within lazy loaded config
*
* @return int stored config value or $default if not set in database
* @throws InvalidArgumentException if one of the argument format is invalid
* @throws AppConfigTypeConflictException in case of conflict with the value type set in database
* @since 29.0.0
* @see \OCP\IAppConfig for explanation about lazy loading
*/
public function getAppValueInt(string $key, int $default = 0, bool $lazy = false): int {
return $this->appConfig->getValueInt($this->appName, $key, $default, $lazy);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param float $default default value
* @param bool $lazy search within lazy loaded config
*
* @return float stored config value or $default if not set in database
* @throws InvalidArgumentException if one of the argument format is invalid
* @throws AppConfigTypeConflictException in case of conflict with the value type set in database
* @since 29.0.0
* @see \OCP\IAppConfig for explanation about lazy loading
*/
public function getAppValueFloat(string $key, float $default = 0, bool $lazy = false): float {
return $this->appConfig->getValueFloat($this->appName, $key, $default, $lazy);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param bool $default default value
* @param bool $lazy search within lazy loaded config
*
* @return bool stored config value or $default if not set in database
* @throws InvalidArgumentException if one of the argument format is invalid
* @throws AppConfigTypeConflictException in case of conflict with the value type set in database
* @since 29.0.0
* @see \OCP\IAppConfig for explanation about lazy loading
*/
public function getAppValueBool(string $key, bool $default = false, bool $lazy = false): bool {
return $this->appConfig->getValueBool($this->appName, $key, $default, $lazy);
}
/**
* @inheritDoc
*
* @param string $key config key
* @param array $default default value
* @param bool $lazy search within lazy loaded config
*
* @return array stored config value or $default if not set in database
* @throws InvalidArgumentException if one of the argument format is invalid
* @throws AppConfigTypeConflictException in case of conflict with the value type set in database
* @since 29.0.0
* @see \OCP\IAppConfig for explanation about lazy loading
*/
public function getAppValueArray(string $key, array $default = [], bool $lazy = false): array {
return $this->appConfig->getValueArray($this->appName, $key, $default, $lazy);
}
/**
* @inheritDoc
*
* @param string $key the key of the value, under which it was saved
* @since 20.0.0
*/
public function deleteAppValue(string $key): void {
$this->appConfig->deleteKey($this->appName, $key);
}
/**
* @inheritDoc
*
* @since 20.0.0
*/
public function deleteAppValues(): void {
$this->appConfig->deleteApp($this->appName);
}
public function setUserValue(string $userId, string $key, string $value, ?string $preCondition = null): void {
$this->config->setUserValue($userId, $this->appName, $key, $value, $preCondition);
}
public function getUserValue(string $userId, string $key, string $default = ''): string {
return $this->config->getUserValue($userId, $this->appName, $key, $default);
}
public function deleteUserValue(string $userId, string $key): void {
$this->config->deleteUserValue($userId, $this->appName, $key);
}
}
|
