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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC;
use InvalidArgumentException;
use JsonException;
use OCP\DB\Exception as DBException;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\Exceptions\AppConfigIncorrectTypeException;
use OCP\Exceptions\AppConfigTypeConflictException;
use OCP\Exceptions\AppConfigUnknownKeyException;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\Security\ICrypto;
use Psr\Log\LoggerInterface;
/**
* This class provides an easy way for apps to store config values in the
* database.
*
* **Note:** since 29.0.0, it supports **lazy loading**
*
* ### What is lazy loading ?
* In order to avoid loading useless config values into memory for each request,
* only non-lazy values are now loaded.
*
* Once a value that is lazy is requested, all lazy values will be loaded.
*
* Similarly, some methods from this class are marked with a warning about ignoring
* lazy loading. Use them wisely and only on parts of the code that are called
* during specific requests or actions to avoid loading the lazy values all the time.
*
* @since 7.0.0
* @since 29.0.0 - Supporting types and lazy loading
*/
class AppConfig implements IAppConfig {
private const APP_MAX_LENGTH = 32;
private const KEY_MAX_LENGTH = 64;
private const ENCRYPTION_PREFIX = '$AppConfigEncryption$';
private const ENCRYPTION_PREFIX_LENGTH = 21; // strlen(self::ENCRYPTION_PREFIX)
/** @var array<string, array<string, mixed>> ['app_id' => ['config_key' => 'config_value']] */
private array $fastCache = []; // cache for normal config keys
/** @var array<string, array<string, mixed>> ['app_id' => ['config_key' => 'config_value']] */
private array $lazyCache = []; // cache for lazy config keys
/** @var array<string, array<string, int>> ['app_id' => ['config_key' => bitflag]] */
private array $valueTypes = []; // type for all config values
private bool $fastLoaded = false;
private bool $lazyLoaded = false;
/**
* $migrationCompleted is only needed to manage the previous structure
* of the database during the upgrading process to nc29.
*
* only when upgrading from a version prior 28.0.2
*
* @TODO: remove this value in Nextcloud 30+
*/
private bool $migrationCompleted = true;
public function __construct(
protected IDBConnection $connection,
protected LoggerInterface $logger,
protected ICrypto $crypto,
) {
}
/**
* @inheritDoc
*
* @return string[] list of app ids
* @since 7.0.0
*/
public function getApps(): array {
$this->loadConfigAll();
$apps = array_merge(array_keys($this->fastCache), array_keys($this->lazyCache));
sort($apps);
return array_values(array_unique($apps));
}
/**
* @inheritDoc
*
* @param string $app id of the app
*
* @return string[] list of stored config keys
* @since 29.0.0
*/
public function getKeys(string $app): array {
$this->assertParams($app);
$this->loadConfigAll();
$keys = array_merge(array_keys($this->fastCache[$app] ?? []), array_keys($this->lazyCache[$app] ?? []));
sort($keys);
return array_values(array_unique($keys));
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 7.0.0
* @since 29.0.0 Added the $lazy argument
*/
public function hasKey(string $app, string $key, ?bool $lazy = false): bool {
$this->assertParams($app, $key);
$this->loadConfig($lazy);
if ($lazy === null) {
$appCache = $this->getAllValues($app);
return isset($appCache[$key]);
}
if ($lazy) {
return isset($this->lazyCache[$app][$key]);
}
return isset($this->fastCache[$app][$key]);
}
/**
* @param string $app id of the app
* @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 $app, string $key, ?bool $lazy = false): bool {
$this->assertParams($app, $key);
$this->loadConfig($lazy);
if (!isset($this->valueTypes[$app][$key])) {
throw new AppConfigUnknownKeyException('unknown config key');
}
return $this->isTyped(self::VALUE_SENSITIVE, $this->valueTypes[$app][$key]);
}
/**
* @inheritDoc
*
* @param string $app if of the app
* @param string $key config key
*
* @return bool TRUE if config is lazy loaded
* @throws AppConfigUnknownKeyException if config key is not known
* @see IAppConfig for details about lazy loading
* @since 29.0.0
*/
public function isLazy(string $app, string $key): bool {
// there is a huge probability the non-lazy config are already loaded
if ($this->hasKey($app, $key, false)) {
return false;
}
// key not found, we search in the lazy config
if ($this->hasKey($app, $key, true)) {
return true;
}
throw new AppConfigUnknownKeyException('unknown config key');
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @param string $prefix 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 getAllValues(string $app, string $prefix = '', bool $filtered = false): array {
$this->assertParams($app, $prefix);
// if we want to filter values, we need to get sensitivity
$this->loadConfigAll();
// array_merge() will remove numeric keys (here config keys), so addition arrays instead
$values = $this->formatAppValues($app, ($this->fastCache[$app] ?? []) + ($this->lazyCache[$app] ?? []));
$values = array_filter(
$values,
function (string $key) use ($prefix): bool {
return str_starts_with($key, $prefix); // filter values based on $prefix
}, ARRAY_FILTER_USE_KEY
);
if (!$filtered) {
return $values;
}
/**
* Using the old (deprecated) list of sensitive values.
*/
foreach ($this->getSensitiveKeys($app) as $sensitiveKeyExp) {
$sensitiveKeys = preg_grep($sensitiveKeyExp, array_keys($values));
foreach ($sensitiveKeys as $sensitiveKey) {
$this->valueTypes[$app][$sensitiveKey] = ($this->valueTypes[$app][$sensitiveKey] ?? 0) | self::VALUE_SENSITIVE;
}
}
$result = [];
foreach ($values as $key => $value) {
$result[$key] = $this->isTyped(self::VALUE_SENSITIVE, $this->valueTypes[$app][$key] ?? 0) ? IConfig::SENSITIVE_VALUE : $value;
}
return $result;
}
/**
* @inheritDoc
*
* @param string $key config key
* @param bool $lazy search within lazy loaded config
* @param int|null $typedAs enforce type for the returned values ({@see self::VALUE_STRING} and others)
*
* @return array<string, string|int|float|bool|array> [appId => configValue]
* @since 29.0.0
*/
public function searchValues(string $key, bool $lazy = false, ?int $typedAs = null): array {
$this->assertParams('', $key, true);
$this->loadConfig($lazy);
/** @var array<array-key, array<array-key, mixed>> $cache */
if ($lazy) {
$cache = $this->lazyCache;
} else {
$cache = $this->fastCache;
}
$values = [];
foreach (array_keys($cache) as $app) {
if (isset($cache[$app][$key])) {
$values[$app] = $this->convertTypedValue($cache[$app][$key], $typedAs ?? $this->getValueType((string)$app, $key, $lazy));
}
}
return $values;
}
/**
* Get the config value as string.
* If the value does not exist the given default will be returned.
*
* Set lazy to `null` to ignore it and get the value from either source.
*
* **WARNING:** Method is internal and **SHOULD** not be used, as it is better to get the value with a type.
*
* @param string $app id of the app
* @param string $key config key
* @param string $default config value
* @param null|bool $lazy get config as lazy loaded or not. can be NULL
*
* @return string the value or $default
* @internal
* @since 29.0.0
* @see IAppConfig for explanation about lazy loading
* @see getValueString()
* @see getValueInt()
* @see getValueFloat()
* @see getValueBool()
* @see getValueArray()
*/
public function getValueMixed(
string $app,
string $key,
string $default = '',
?bool $lazy = false,
): string {
try {
$lazy = ($lazy === null) ? $this->isLazy($app, $key) : $lazy;
} catch (AppConfigUnknownKeyException $e) {
return $default;
}
return $this->getTypedValue(
$app,
$key,
$default,
$lazy,
self::VALUE_MIXED
);
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 IAppConfig for explanation about lazy loading
*/
public function getValueString(
string $app,
string $key,
string $default = '',
bool $lazy = false,
): string {
return $this->getTypedValue($app, $key, $default, $lazy, self::VALUE_STRING);
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 IAppConfig for explanation about lazy loading
*/
public function getValueInt(
string $app,
string $key,
int $default = 0,
bool $lazy = false,
): int {
return (int)$this->getTypedValue($app, $key, (string)$default, $lazy, self::VALUE_INT);
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 IAppConfig for explanation about lazy loading
*/
public function getValueFloat(string $app, string $key, float $default = 0, bool $lazy = false): float {
return (float)$this->getTypedValue($app, $key, (string)$default, $lazy, self::VALUE_FLOAT);
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 IAppConfig for explanation about lazy loading
*/
public function getValueBool(string $app, string $key, bool $default = false, bool $lazy = false): bool {
$b = strtolower($this->getTypedValue($app, $key, $default ? 'true' : 'false', $lazy, self::VALUE_BOOL));
return in_array($b, ['1', 'true', 'yes', 'on']);
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 IAppConfig for explanation about lazy loading
*/
public function getValueArray(
string $app,
string $key,
array $default = [],
bool $lazy = false,
): array {
try {
$defaultJson = json_encode($default, JSON_THROW_ON_ERROR);
$value = json_decode($this->getTypedValue($app, $key, $defaultJson, $lazy, self::VALUE_ARRAY), true, flags: JSON_THROW_ON_ERROR);
return is_array($value) ? $value : [];
} catch (JsonException) {
return [];
}
}
/**
* @param string $app id of the app
* @param string $key config key
* @param string $default default value
* @param bool $lazy search within lazy loaded config
* @param int $type value type {@see VALUE_STRING} {@see VALUE_INT}{@see VALUE_FLOAT} {@see VALUE_BOOL} {@see VALUE_ARRAY}
*
* @return string
* @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
* @throws InvalidArgumentException
*/
private function getTypedValue(
string $app,
string $key,
string $default,
bool $lazy,
int $type,
): string {
$this->assertParams($app, $key, valueType: $type);
$this->loadConfig($lazy);
/**
* We ignore check if mixed type is requested.
* If type of stored value is set as mixed, we don't filter.
* If type of stored value is defined, we compare with the one requested.
*/
$knownType = $this->valueTypes[$app][$key] ?? 0;
if (!$this->isTyped(self::VALUE_MIXED, $type)
&& $knownType > 0
&& !$this->isTyped(self::VALUE_MIXED, $knownType)
&& !$this->isTyped($type, $knownType)) {
$this->logger->warning('conflict with value type from database', ['app' => $app, 'key' => $key, 'type' => $type, 'knownType' => $knownType]);
throw new AppConfigTypeConflictException('conflict with value type from database');
}
/**
* - the pair $app/$key cannot exist in both array,
* - we should still return an existing non-lazy value even if current method
* is called with $lazy is true
*
* This way, lazyCache will be empty until the load for lazy config value is requested.
*/
if (isset($this->lazyCache[$app][$key])) {
$value = $this->lazyCache[$app][$key];
} elseif (isset($this->fastCache[$app][$key])) {
$value = $this->fastCache[$app][$key];
} else {
return $default;
}
$sensitive = $this->isTyped(self::VALUE_SENSITIVE, $knownType);
if ($sensitive && str_starts_with($value, self::ENCRYPTION_PREFIX)) {
// Only decrypt values that are stored encrypted
$value = $this->crypto->decrypt(substr($value, self::ENCRYPTION_PREFIX_LENGTH));
}
return $value;
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @param string $key config key
*
* @return int type of the value
* @throws AppConfigUnknownKeyException if config key is not known
* @since 29.0.0
* @see VALUE_STRING
* @see VALUE_INT
* @see VALUE_FLOAT
* @see VALUE_BOOL
* @see VALUE_ARRAY
*/
public function getValueType(string $app, string $key, ?bool $lazy = null): int {
$this->assertParams($app, $key);
$this->loadConfig($lazy);
if (!isset($this->valueTypes[$app][$key])) {
throw new AppConfigUnknownKeyException('unknown config key');
}
$type = $this->valueTypes[$app][$key];
$type &= ~self::VALUE_SENSITIVE;
return $type;
}
/**
* Store a config key and its value in database as VALUE_MIXED
*
* **WARNING:** Method is internal and **MUST** not be used as it is best to set a real value type
*
* @param string $app id of the app
* @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
* @internal
* @since 29.0.0
* @see IAppConfig for explanation about lazy loading
* @see setValueString()
* @see setValueInt()
* @see setValueFloat()
* @see setValueBool()
* @see setValueArray()
*/
public function setValueMixed(
string $app,
string $key,
string $value,
bool $lazy = false,
bool $sensitive = false,
): bool {
return $this->setTypedValue(
$app,
$key,
$value,
$lazy,
self::VALUE_MIXED | ($sensitive ? self::VALUE_SENSITIVE : 0)
);
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 IAppConfig for explanation about lazy loading
*/
public function setValueString(
string $app,
string $key,
string $value,
bool $lazy = false,
bool $sensitive = false,
): bool {
return $this->setTypedValue(
$app,
$key,
$value,
$lazy,
self::VALUE_STRING | ($sensitive ? self::VALUE_SENSITIVE : 0)
);
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 IAppConfig for explanation about lazy loading
*/
public function setValueInt(
string $app,
string $key,
int $value,
bool $lazy = false,
bool $sensitive = false,
): bool {
if ($value > 2000000000) {
$this->logger->debug('You are trying to store an integer value around/above 2,147,483,647. This is a reminder that reaching this theoretical limit on 32 bits system will throw an exception.');
}
return $this->setTypedValue(
$app,
$key,
(string)$value,
$lazy,
self::VALUE_INT | ($sensitive ? self::VALUE_SENSITIVE : 0)
);
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 IAppConfig for explanation about lazy loading
*/
public function setValueFloat(
string $app,
string $key,
float $value,
bool $lazy = false,
bool $sensitive = false,
): bool {
return $this->setTypedValue(
$app,
$key,
(string)$value,
$lazy,
self::VALUE_FLOAT | ($sensitive ? self::VALUE_SENSITIVE : 0)
);
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 IAppConfig for explanation about lazy loading
*/
public function setValueBool(
string $app,
string $key,
bool $value,
bool $lazy = false,
): bool {
return $this->setTypedValue(
$app,
$key,
($value) ? '1' : '0',
$lazy,
self::VALUE_BOOL
);
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @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 IAppConfig for explanation about lazy loading
*/
public function setValueArray(
string $app,
string $key,
array $value,
bool $lazy = false,
bool $sensitive = false,
): bool {
try {
return $this->setTypedValue(
$app,
$key,
json_encode($value, JSON_THROW_ON_ERROR),
$lazy,
self::VALUE_ARRAY | ($sensitive ? self::VALUE_SENSITIVE : 0)
);
} catch (JsonException $e) {
$this->logger->warning('could not setValueArray', ['app' => $app, 'key' => $key, 'exception' => $e]);
throw $e;
}
}
/**
* Store a config key and its value in database
*
* If config key is already known with the exact same config value and same sensitive/lazy status, the
* database is not updated. If config value was previously stored as sensitive, status will not be
* altered.
*
* @param string $app id of the app
* @param string $key config key
* @param string $value config value
* @param bool $lazy config set as lazy loaded
* @param int $type value type {@see VALUE_STRING} {@see VALUE_INT} {@see VALUE_FLOAT} {@see VALUE_BOOL} {@see VALUE_ARRAY}
*
* @return bool TRUE if value was updated in database
* @throws AppConfigTypeConflictException if type from database is not VALUE_MIXED and different from the requested one
* @see IAppConfig for explanation about lazy loading
*/
private function setTypedValue(
string $app,
string $key,
string $value,
bool $lazy,
int $type,
): bool {
$this->assertParams($app, $key);
$this->loadConfig($lazy);
$sensitive = $this->isTyped(self::VALUE_SENSITIVE, $type);
$inserted = $refreshCache = false;
$origValue = $value;
if ($sensitive || ($this->hasKey($app, $key, $lazy) && $this->isSensitive($app, $key, $lazy))) {
$value = self::ENCRYPTION_PREFIX . $this->crypto->encrypt($value);
}
if ($this->hasKey($app, $key, $lazy)) {
/**
* no update if key is already known with set lazy status and value is
* not different, unless sensitivity is switched from false to true.
*/
if ($origValue === $this->getTypedValue($app, $key, $value, $lazy, $type)
&& (!$sensitive || $this->isSensitive($app, $key, $lazy))) {
return false;
}
} else {
/**
* if key is not known yet, we try to insert.
* It might fail if the key exists with a different lazy flag.
*/
try {
$insert = $this->connection->getQueryBuilder();
$insert->insert('appconfig')
->setValue('appid', $insert->createNamedParameter($app))
->setValue('lazy', $insert->createNamedParameter(($lazy) ? 1 : 0, IQueryBuilder::PARAM_INT))
->setValue('type', $insert->createNamedParameter($type, IQueryBuilder::PARAM_INT))
->setValue('configkey', $insert->createNamedParameter($key))
->setValue('configvalue', $insert->createNamedParameter($value));
$insert->executeStatement();
$inserted = true;
} catch (DBException $e) {
if ($e->getReason() !== DBException::REASON_UNIQUE_CONSTRAINT_VIOLATION) {
throw $e; // TODO: throw exception or just log and returns false !?
}
}
}
/**
* We cannot insert a new row, meaning we need to update an already existing one
*/
if (!$inserted) {
$currType = $this->valueTypes[$app][$key] ?? 0;
if ($currType === 0) { // this might happen when switching lazy loading status
$this->loadConfigAll();
$currType = $this->valueTypes[$app][$key] ?? 0;
}
/**
* This should only happen during the upgrade process from 28 to 29.
* We only log a warning and set it to VALUE_MIXED.
*/
if ($currType === 0) {
$this->logger->warning('Value type is set to zero (0) in database. This is fine only during the upgrade process from 28 to 29.', ['app' => $app, 'key' => $key]);
$currType = self::VALUE_MIXED;
}
/**
* we only accept a different type from the one stored in database
* if the one stored in database is not-defined (VALUE_MIXED)
*/
if (!$this->isTyped(self::VALUE_MIXED, $currType) &&
($type | self::VALUE_SENSITIVE) !== ($currType | self::VALUE_SENSITIVE)) {
try {
$currType = $this->convertTypeToString($currType);
$type = $this->convertTypeToString($type);
} catch (AppConfigIncorrectTypeException) {
// can be ignored, this was just needed for a better exception message.
}
throw new AppConfigTypeConflictException('conflict between new type (' . $type . ') and old type (' . $currType . ')');
}
// we fix $type if the stored value, or the new value as it might be changed, is set as sensitive
if ($sensitive || $this->isTyped(self::VALUE_SENSITIVE, $currType)) {
$type |= self::VALUE_SENSITIVE;
}
if ($lazy !== $this->isLazy($app, $key)) {
$refreshCache = true;
}
$update = $this->connection->getQueryBuilder();
$update->update('appconfig')
->set('configvalue', $update->createNamedParameter($value))
->set('lazy', $update->createNamedParameter(($lazy) ? 1 : 0, IQueryBuilder::PARAM_INT))
->set('type', $update->createNamedParameter($type, IQueryBuilder::PARAM_INT))
->where($update->expr()->eq('appid', $update->createNamedParameter($app)))
->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key)));
$update->executeStatement();
}
if ($refreshCache) {
$this->clearCache();
return true;
}
// update local cache
if ($lazy) {
$this->lazyCache[$app][$key] = $value;
} else {
$this->fastCache[$app][$key] = $value;
}
$this->valueTypes[$app][$key] = $type;
return true;
}
/**
* Change the type of config value.
*
* **WARNING:** Method is internal and **MUST** not be used as it may break things.
*
* @param string $app id of the app
* @param string $key config key
* @param int $type value type {@see VALUE_STRING} {@see VALUE_INT} {@see VALUE_FLOAT} {@see VALUE_BOOL} {@see VALUE_ARRAY}
*
* @return bool TRUE if database update were necessary
* @throws AppConfigUnknownKeyException if $key is now known in database
* @throws AppConfigIncorrectTypeException if $type is not valid
* @internal
* @since 29.0.0
*/
public function updateType(string $app, string $key, int $type = self::VALUE_MIXED): bool {
$this->assertParams($app, $key);
$this->loadConfigAll();
$lazy = $this->isLazy($app, $key);
// type can only be one type
if (!in_array($type, [self::VALUE_MIXED, self::VALUE_STRING, self::VALUE_INT, self::VALUE_FLOAT, self::VALUE_BOOL, self::VALUE_ARRAY])) {
throw new AppConfigIncorrectTypeException('Unknown value type');
}
$currType = $this->valueTypes[$app][$key];
if (($type | self::VALUE_SENSITIVE) === ($currType | self::VALUE_SENSITIVE)) {
return false;
}
// we complete with sensitive flag if the stored value is set as sensitive
if ($this->isTyped(self::VALUE_SENSITIVE, $currType)) {
$type = $type | self::VALUE_SENSITIVE;
}
$update = $this->connection->getQueryBuilder();
$update->update('appconfig')
->set('type', $update->createNamedParameter($type, IQueryBuilder::PARAM_INT))
->where($update->expr()->eq('appid', $update->createNamedParameter($app)))
->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key)));
$update->executeStatement();
$this->valueTypes[$app][$key] = $type;
return true;
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @param string $key config key
* @param bool $sensitive TRUE to set as sensitive, FALSE to unset
*
* @return bool TRUE if entry was found in database and an update was necessary
* @since 29.0.0
*/
public function updateSensitive(string $app, string $key, bool $sensitive): bool {
$this->assertParams($app, $key);
$this->loadConfigAll();
try {
if ($sensitive === $this->isSensitive($app, $key, null)) {
return false;
}
} catch (AppConfigUnknownKeyException $e) {
return false;
}
$lazy = $this->isLazy($app, $key);
if ($lazy) {
$cache = $this->lazyCache;
} else {
$cache = $this->fastCache;
}
if (!isset($cache[$app][$key])) {
throw new AppConfigUnknownKeyException('unknown config key');
}
/**
* type returned by getValueType() is already cleaned from sensitive flag
* we just need to update it based on $sensitive and store it in database
*/
$type = $this->getValueType($app, $key);
$value = $cache[$app][$key];
if ($sensitive) {
$type |= self::VALUE_SENSITIVE;
$value = self::ENCRYPTION_PREFIX . $this->crypto->encrypt($value);
} else {
$value = $this->crypto->decrypt(substr($value, self::ENCRYPTION_PREFIX_LENGTH));
}
$update = $this->connection->getQueryBuilder();
$update->update('appconfig')
->set('type', $update->createNamedParameter($type, IQueryBuilder::PARAM_INT))
->set('configvalue', $update->createNamedParameter($value))
->where($update->expr()->eq('appid', $update->createNamedParameter($app)))
->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key)));
$update->executeStatement();
$this->valueTypes[$app][$key] = $type;
return true;
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @param string $key config key
* @param bool $lazy TRUE to set as lazy loaded, FALSE to unset
*
* @return bool TRUE if entry was found in database and an update was necessary
* @since 29.0.0
*/
public function updateLazy(string $app, string $key, bool $lazy): bool {
$this->assertParams($app, $key);
$this->loadConfigAll();
try {
if ($lazy === $this->isLazy($app, $key)) {
return false;
}
} catch (AppConfigUnknownKeyException $e) {
return false;
}
$update = $this->connection->getQueryBuilder();
$update->update('appconfig')
->set('lazy', $update->createNamedParameter($lazy ? 1 : 0, IQueryBuilder::PARAM_INT))
->where($update->expr()->eq('appid', $update->createNamedParameter($app)))
->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key)));
$update->executeStatement();
// At this point, it is a lot safer to clean cache
$this->clearCache();
return true;
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @param string $key config key
*
* @return array
* @throws AppConfigUnknownKeyException if config key is not known in database
* @since 29.0.0
*/
public function getDetails(string $app, string $key): array {
$this->assertParams($app, $key);
$this->loadConfigAll();
$lazy = $this->isLazy($app, $key);
if ($lazy) {
$cache = $this->lazyCache;
} else {
$cache = $this->fastCache;
}
$type = $this->getValueType($app, $key);
try {
$typeString = $this->convertTypeToString($type);
} catch (AppConfigIncorrectTypeException $e) {
$this->logger->warning('type stored in database is not correct', ['exception' => $e, 'type' => $type]);
$typeString = (string)$type;
}
if (!isset($cache[$app][$key])) {
throw new AppConfigUnknownKeyException('unknown config key');
}
$value = $cache[$app][$key];
$sensitive = $this->isSensitive($app, $key, null);
if ($sensitive && str_starts_with($value, self::ENCRYPTION_PREFIX)) {
$value = $this->crypto->decrypt(substr($value, self::ENCRYPTION_PREFIX_LENGTH));
}
return [
'app' => $app,
'key' => $key,
'value' => $value,
'type' => $type,
'lazy' => $lazy,
'typeString' => $typeString,
'sensitive' => $sensitive
];
}
/**
* @param string $type
*
* @return int
* @throws AppConfigIncorrectTypeException
* @since 29.0.0
*/
public function convertTypeToInt(string $type): int {
return match (strtolower($type)) {
'mixed' => IAppConfig::VALUE_MIXED,
'string' => IAppConfig::VALUE_STRING,
'integer' => IAppConfig::VALUE_INT,
'float' => IAppConfig::VALUE_FLOAT,
'boolean' => IAppConfig::VALUE_BOOL,
'array' => IAppConfig::VALUE_ARRAY,
default => throw new AppConfigIncorrectTypeException('Unknown type ' . $type)
};
}
/**
* @param int $type
*
* @return string
* @throws AppConfigIncorrectTypeException
* @since 29.0.0
*/
public function convertTypeToString(int $type): string {
$type &= ~self::VALUE_SENSITIVE;
return match ($type) {
IAppConfig::VALUE_MIXED => 'mixed',
IAppConfig::VALUE_STRING => 'string',
IAppConfig::VALUE_INT => 'integer',
IAppConfig::VALUE_FLOAT => 'float',
IAppConfig::VALUE_BOOL => 'boolean',
IAppConfig::VALUE_ARRAY => 'array',
default => throw new AppConfigIncorrectTypeException('Unknown numeric type ' . $type)
};
}
/**
* @inheritDoc
*
* @param string $app id of the app
* @param string $key config key
*
* @since 29.0.0
*/
public function deleteKey(string $app, string $key): void {
$this->assertParams($app, $key);
$qb = $this->connection->getQueryBuilder();
$qb->delete('appconfig')
->where($qb->expr()->eq('appid', $qb->createNamedParameter($app)))
->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key)));
$qb->executeStatement();
unset($this->lazyCache[$app][$key]);
unset($this->fastCache[$app][$key]);
}
/**
* @inheritDoc
*
* @param string $app id of the app
*
* @since 29.0.0
*/
public function deleteApp(string $app): void {
$this->assertParams($app);
$qb = $this->connection->getQueryBuilder();
$qb->delete('appconfig')
->where($qb->expr()->eq('appid', $qb->createNamedParameter($app)));
$qb->executeStatement();
$this->clearCache();
}
/**
* @inheritDoc
*
* @param bool $reload set to TRUE to refill cache instantly after clearing it
*
* @since 29.0.0
*/
public function clearCache(bool $reload = false): void {
$this->lazyLoaded = $this->fastLoaded = false;
$this->lazyCache = $this->fastCache = $this->valueTypes = [];
if (!$reload) {
return;
}
$this->loadConfigAll();
}
/**
* For debug purpose.
* Returns the cached data.
*
* @return array
* @since 29.0.0
* @internal
*/
public function statusCache(): array {
return [
'fastLoaded' => $this->fastLoaded,
'fastCache' => $this->fastCache,
'lazyLoaded' => $this->lazyLoaded,
'lazyCache' => $this->lazyCache,
];
}
/**
* @param int $needle bitflag to search
* @param int $type known value
*
* @return bool TRUE if bitflag $needle is set in $type
*/
private function isTyped(int $needle, int $type): bool {
return (($needle & $type) !== 0);
}
/**
* Confirm the string set for app and key fit the database description
*
* @param string $app assert $app fit in database
* @param string $configKey assert config key fit in database
* @param bool $allowEmptyApp $app can be empty string
* @param int $valueType assert value type is only one type
*
* @throws InvalidArgumentException
*/
private function assertParams(string $app = '', string $configKey = '', bool $allowEmptyApp = false, int $valueType = -1): void {
if (!$allowEmptyApp && $app === '') {
throw new InvalidArgumentException('app cannot be an empty string');
}
if (strlen($app) > self::APP_MAX_LENGTH) {
throw new InvalidArgumentException(
'Value (' . $app . ') for app is too long (' . self::APP_MAX_LENGTH . ')'
);
}
if (strlen($configKey) > self::KEY_MAX_LENGTH) {
throw new InvalidArgumentException('Value (' . $configKey . ') for key is too long (' . self::KEY_MAX_LENGTH . ')');
}
if ($valueType > -1) {
$valueType &= ~self::VALUE_SENSITIVE;
if (!in_array($valueType, [self::VALUE_MIXED, self::VALUE_STRING, self::VALUE_INT, self::VALUE_FLOAT, self::VALUE_BOOL, self::VALUE_ARRAY])) {
throw new InvalidArgumentException('Unknown value type');
}
}
}
private function loadConfigAll(): void {
$this->loadConfig(null);
}
/**
* Load normal config or config set as lazy loaded
*
* @param bool|null $lazy set to TRUE to load config set as lazy loaded, set to NULL to load all config
*/
private function loadConfig(?bool $lazy = false): void {
if ($this->isLoaded($lazy)) {
return;
}
if (($lazy ?? true) !== false) { // if lazy is null or true, we debug log
$this->logger->debug('The loading of lazy AppConfig values have been requested', ['exception' => new \RuntimeException('ignorable exception')]);
}
$qb = $this->connection->getQueryBuilder();
$qb->from('appconfig');
/**
* The use of $this->>migrationCompleted is only needed to manage the
* database during the upgrading process to nc29.
*/
if (!$this->migrationCompleted) {
$qb->select('appid', 'configkey', 'configvalue');
} else {
// we only need value from lazy when loadConfig does not specify it
$qb->select('appid', 'configkey', 'configvalue', 'type');
if ($lazy !== null) {
$qb->where($qb->expr()->eq('lazy', $qb->createNamedParameter($lazy ? 1 : 0, IQueryBuilder::PARAM_INT)));
} else {
$qb->addSelect('lazy');
}
}
try {
$result = $qb->executeQuery();
} catch (DBException $e) {
/**
* in case of issue with field name, it means that migration is not completed.
* Falling back to a request without select on lazy.
* This whole try/catch and the migrationCompleted variable can be removed in NC30.
*/
if ($e->getReason() !== DBException::REASON_INVALID_FIELD_NAME) {
throw $e;
}
$this->migrationCompleted = false;
$this->loadConfig($lazy);
return;
}
$rows = $result->fetchAll();
foreach ($rows as $row) {
// most of the time, 'lazy' is not in the select because its value is already known
if (($row['lazy'] ?? ($lazy ?? 0) ? 1 : 0) === 1) {
$this->lazyCache[$row['appid']][$row['configkey']] = $row['configvalue'] ?? '';
} else {
$this->fastCache[$row['appid']][$row['configkey']] = $row['configvalue'] ?? '';
}
$this->valueTypes[$row['appid']][$row['configkey']] = (int)($row['type'] ?? 0);
}
$result->closeCursor();
$this->setAsLoaded($lazy);
}
/**
* if $lazy is:
* - false: will returns true if fast config is loaded
* - true : will returns true if lazy config is loaded
* - null : will returns true if both config are loaded
*
* @param bool $lazy
*
* @return bool
*/
private function isLoaded(?bool $lazy): bool {
if ($lazy === null) {
return $this->lazyLoaded && $this->fastLoaded;
}
return $lazy ? $this->lazyLoaded : $this->fastLoaded;
}
/**
* if $lazy is:
* - false: set fast config as loaded
* - true : set lazy config as loaded
* - null : set both config as loaded
*
* @param bool $lazy
*/
private function setAsLoaded(?bool $lazy): void {
if ($lazy === null) {
$this->fastLoaded = true;
$this->lazyLoaded = true;
return;
}
if ($lazy) {
$this->lazyLoaded = true;
} else {
$this->fastLoaded = true;
}
}
/**
* Gets the config value
*
* @param string $app app
* @param string $key key
* @param string $default = null, default value if the key does not exist
*
* @return string the value or $default
* @deprecated 29.0.0 use getValue*()
*
* This function gets a value from the appconfig table. If the key does
* not exist the default value will be returned
*/
public function getValue($app, $key, $default = null) {
$this->loadConfig();
return $this->fastCache[$app][$key] ?? $default;
}
/**
* Sets a value. If the key did not exist before it will be created.
*
* @param string $app app
* @param string $key key
* @param string|float|int $value value
*
* @return bool True if the value was inserted or updated, false if the value was the same
* @throws AppConfigTypeConflictException
* @throws AppConfigUnknownKeyException
* @deprecated 29.0.0
*/
public function setValue($app, $key, $value) {
/**
* TODO: would it be overkill, or decently improve performance, to catch
* call to this method with $key='enabled' and 'hide' config value related
* to $app when the app is disabled (by modifying entry in database: lazy=lazy+2)
* or enabled (lazy=lazy-2)
*
* this solution would remove the loading of config values from disabled app
* unless calling the method {@see loadConfigAll()}
*/
return $this->setTypedValue($app, $key, (string)$value, false, self::VALUE_MIXED);
}
/**
* get multiple values, either the app or key can be used as wildcard by setting it to false
*
* @param string|false $app
* @param string|false $key
*
* @return array|false
* @deprecated 29.0.0 use {@see getAllValues()}
*/
public function getValues($app, $key) {
if (($app !== false) === ($key !== false)) {
return false;
}
$key = ($key === false) ? '' : $key;
if (!$app) {
return $this->searchValues($key, false, self::VALUE_MIXED);
} else {
return $this->getAllValues($app, $key);
}
}
/**
* get all values of the app or and filters out sensitive data
*
* @param string $app
*
* @return array
* @deprecated 29.0.0 use {@see getAllValues()}
*/
public function getFilteredValues($app) {
return $this->getAllValues($app, filtered: true);
}
/**
* **Warning:** avoid default NULL value for $lazy as this will
* load all lazy values from the database
*
* @param string $app
* @param array<string, string> $values ['key' => 'value']
* @param bool|null $lazy
*
* @return array<string, string|int|float|bool|array>
*/
private function formatAppValues(string $app, array $values, ?bool $lazy = null): array {
foreach ($values as $key => $value) {
try {
$type = $this->getValueType($app, $key, $lazy);
} catch (AppConfigUnknownKeyException $e) {
continue;
}
$values[$key] = $this->convertTypedValue($value, $type);
}
return $values;
}
/**
* convert string value to the expected type
*
* @param string $value
* @param int $type
*
* @return string|int|float|bool|array
*/
private function convertTypedValue(string $value, int $type): string|int|float|bool|array {
switch ($type) {
case self::VALUE_INT:
return (int)$value;
case self::VALUE_FLOAT:
return (float)$value;
case self::VALUE_BOOL:
return in_array(strtolower($value), ['1', 'true', 'yes', 'on']);
case self::VALUE_ARRAY:
try {
return json_decode($value, true, flags: JSON_THROW_ON_ERROR);
} catch (JsonException $e) {
// ignoreable
}
break;
}
return $value;
}
/**
* @param string $app
*
* @return string[]
* @deprecated 29.0.0 data sensitivity should be set when calling setValue*()
*/
private function getSensitiveKeys(string $app): array {
$sensitiveValues = [
'circles' => [
'/^key_pairs$/',
'/^local_gskey$/',
],
'call_summary_bot' => [
'/^secret_(.*)$/',
],
'external' => [
'/^sites$/',
'/^jwt_token_privkey_(.*)$/',
],
'globalsiteselector' => [
'/^gss\.jwt\.key$/',
],
'integration_discourse' => [
'/^private_key$/',
'/^public_key$/',
],
'integration_dropbox' => [
'/^client_id$/',
'/^client_secret$/',
],
'integration_github' => [
'/^client_id$/',
'/^client_secret$/',
],
'integration_gitlab' => [
'/^client_id$/',
'/^client_secret$/',
'/^oauth_instance_url$/',
],
'integration_google' => [
'/^client_id$/',
'/^client_secret$/',
],
'integration_jira' => [
'/^client_id$/',
'/^client_secret$/',
'/^forced_instance_url$/',
],
'integration_onedrive' => [
'/^client_id$/',
'/^client_secret$/',
],
'integration_openproject' => [
'/^client_id$/',
'/^client_secret$/',
'/^oauth_instance_url$/',
],
'integration_reddit' => [
'/^client_id$/',
'/^client_secret$/',
],
'integration_suitecrm' => [
'/^client_id$/',
'/^client_secret$/',
'/^oauth_instance_url$/',
],
'integration_twitter' => [
'/^consumer_key$/',
'/^consumer_secret$/',
'/^followed_user$/',
],
'integration_zammad' => [
'/^client_id$/',
'/^client_secret$/',
'/^oauth_instance_url$/',
],
'notify_push' => [
'/^cookie$/',
],
'onlyoffice' => [
'/^jwt_secret$/',
],
'passwords' => [
'/^SSEv1ServerKey$/',
],
'serverinfo' => [
'/^token$/',
],
'spreed' => [
'/^bridge_bot_password$/',
'/^hosted-signaling-server-(.*)$/',
'/^recording_servers$/',
'/^signaling_servers$/',
'/^signaling_ticket_secret$/',
'/^signaling_token_privkey_(.*)$/',
'/^signaling_token_pubkey_(.*)$/',
'/^sip_bridge_dialin_info$/',
'/^sip_bridge_shared_secret$/',
'/^stun_servers$/',
'/^turn_servers$/',
'/^turn_server_secret$/',
],
'support' => [
'/^last_response$/',
'/^potential_subscription_key$/',
'/^subscription_key$/',
],
'theming' => [
'/^imprintUrl$/',
'/^privacyUrl$/',
'/^slogan$/',
'/^url$/',
],
'user_ldap' => [
'/^(s..)?ldap_agent_password$/',
],
'twofactor_gateway' => [
'/^.*token$/',
],
'user_saml' => [
'/^idp-x509cert$/',
],
'whiteboard' => [
'/^jwt_secret_key$/',
],
];
return $sensitiveValues[$app] ?? [];
}
/**
* Clear all the cached app config values
* New cache will be generated next time a config value is retrieved
*
* @deprecated 29.0.0 use {@see clearCache()}
*/
public function clearCachedConfig(): void {
$this->clearCache();
}
}
|