diff --git a/build/psalm-baseline.xml b/build/psalm-baseline.xml index 437be7441f8c9..ed96e4391f9cd 100644 --- a/build/psalm-baseline.xml +++ b/build/psalm-baseline.xml @@ -1328,9 +1328,6 @@ - - - diff --git a/core/Migrations/Version31000Date20240814184402.php b/core/Migrations/Version31000Date20240814184402.php new file mode 100644 index 0000000000000..14b32a704beda --- /dev/null +++ b/core/Migrations/Version31000Date20240814184402.php @@ -0,0 +1,54 @@ +getTable('preferences'); + $table->addColumn('lazy', Types::SMALLINT, ['notnull' => true, 'default' => 0, 'length' => 1, 'unsigned' => true]); + $table->addColumn('type', Types::SMALLINT, ['notnull' => true, 'default' => 0, 'unsigned' => true]); + $table->addColumn('flags', Types::INTEGER, ['notnull' => true, 'default' => 0, 'unsigned' => true]); + $table->addColumn('indexed', Types::STRING, ['notnull' => false, 'default' => '', 'length' => 64]); + + // removing this index from Version13000Date20170718121200 + // $table->addIndex(['appid', 'configkey'], 'preferences_app_key'); + if ($table->hasIndex('preferences_app_key')) { + $table->dropIndex('preferences_app_key'); + } + + $table->addIndex(['userid', 'lazy'], 'prefs_uid_lazy_i'); + $table->addIndex(['appid', 'configkey', 'indexed', 'flags'], 'prefs_app_key_ind_fl_i'); + + return $schema; + } +} diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 13fb25ab303f5..cc6b8be326c49 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -7,6 +7,11 @@ return array( 'Composer\\InstalledVersions' => $vendorDir . '/composer/InstalledVersions.php', + 'NCU\\Config\\Exceptions\\IncorrectTypeException' => $baseDir . '/lib/unstable/Config/Exceptions/IncorrectTypeException.php', + 'NCU\\Config\\Exceptions\\TypeConflictException' => $baseDir . '/lib/unstable/Config/Exceptions/TypeConflictException.php', + 'NCU\\Config\\Exceptions\\UnknownKeyException' => $baseDir . '/lib/unstable/Config/Exceptions/UnknownKeyException.php', + 'NCU\\Config\\IUserConfig' => $baseDir . '/lib/unstable/Config/IUserConfig.php', + 'NCU\\Config\\ValueType' => $baseDir . '/lib/unstable/Config/ValueType.php', 'OCP\\Accounts\\IAccount' => $baseDir . '/lib/public/Accounts/IAccount.php', 'OCP\\Accounts\\IAccountManager' => $baseDir . '/lib/public/Accounts/IAccountManager.php', 'OCP\\Accounts\\IAccountProperty' => $baseDir . '/lib/public/Accounts/IAccountProperty.php', @@ -1118,6 +1123,7 @@ 'OC\\Comments\\Manager' => $baseDir . '/lib/private/Comments/Manager.php', 'OC\\Comments\\ManagerFactory' => $baseDir . '/lib/private/Comments/ManagerFactory.php', 'OC\\Config' => $baseDir . '/lib/private/Config.php', + 'OC\\Config\\UserConfig' => $baseDir . '/lib/private/Config/UserConfig.php', 'OC\\Console\\Application' => $baseDir . '/lib/private/Console/Application.php', 'OC\\Console\\TimestampFormatter' => $baseDir . '/lib/private/Console/TimestampFormatter.php', 'OC\\ContactsManager' => $baseDir . '/lib/private/ContactsManager.php', @@ -1386,6 +1392,7 @@ 'OC\\Core\\Migrations\\Version30000Date20240814180800' => $baseDir . '/core/Migrations/Version30000Date20240814180800.php', 'OC\\Core\\Migrations\\Version30000Date20240815080800' => $baseDir . '/core/Migrations/Version30000Date20240815080800.php', 'OC\\Core\\Migrations\\Version30000Date20240906095113' => $baseDir . '/core/Migrations/Version30000Date20240906095113.php', + 'OC\\Core\\Migrations\\Version31000Date20240814184402' => $baseDir . '/core/Migrations/Version31000Date20240814184402.php', 'OC\\Core\\Migrations\\Version31000Date20241018063111' => $baseDir . '/core/Migrations/Version31000Date20241018063111.php', 'OC\\Core\\Notification\\CoreNotifier' => $baseDir . '/core/Notification/CoreNotifier.php', 'OC\\Core\\ResponseDefinitions' => $baseDir . '/core/ResponseDefinitions.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index 526782636fbb5..54959bc6b9164 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -48,6 +48,11 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 public static $classMap = array ( 'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php', + 'NCU\\Config\\Exceptions\\IncorrectTypeException' => __DIR__ . '/../../..' . '/lib/unstable/Config/Exceptions/IncorrectTypeException.php', + 'NCU\\Config\\Exceptions\\TypeConflictException' => __DIR__ . '/../../..' . '/lib/unstable/Config/Exceptions/TypeConflictException.php', + 'NCU\\Config\\Exceptions\\UnknownKeyException' => __DIR__ . '/../../..' . '/lib/unstable/Config/Exceptions/UnknownKeyException.php', + 'NCU\\Config\\IUserConfig' => __DIR__ . '/../../..' . '/lib/unstable/Config/IUserConfig.php', + 'NCU\\Config\\ValueType' => __DIR__ . '/../../..' . '/lib/unstable/Config/ValueType.php', 'OCP\\Accounts\\IAccount' => __DIR__ . '/../../..' . '/lib/public/Accounts/IAccount.php', 'OCP\\Accounts\\IAccountManager' => __DIR__ . '/../../..' . '/lib/public/Accounts/IAccountManager.php', 'OCP\\Accounts\\IAccountProperty' => __DIR__ . '/../../..' . '/lib/public/Accounts/IAccountProperty.php', @@ -1159,6 +1164,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 'OC\\Comments\\Manager' => __DIR__ . '/../../..' . '/lib/private/Comments/Manager.php', 'OC\\Comments\\ManagerFactory' => __DIR__ . '/../../..' . '/lib/private/Comments/ManagerFactory.php', 'OC\\Config' => __DIR__ . '/../../..' . '/lib/private/Config.php', + 'OC\\Config\\UserConfig' => __DIR__ . '/../../..' . '/lib/private/Config/UserConfig.php', 'OC\\Console\\Application' => __DIR__ . '/../../..' . '/lib/private/Console/Application.php', 'OC\\Console\\TimestampFormatter' => __DIR__ . '/../../..' . '/lib/private/Console/TimestampFormatter.php', 'OC\\ContactsManager' => __DIR__ . '/../../..' . '/lib/private/ContactsManager.php', @@ -1427,6 +1433,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2 'OC\\Core\\Migrations\\Version30000Date20240814180800' => __DIR__ . '/../../..' . '/core/Migrations/Version30000Date20240814180800.php', 'OC\\Core\\Migrations\\Version30000Date20240815080800' => __DIR__ . '/../../..' . '/core/Migrations/Version30000Date20240815080800.php', 'OC\\Core\\Migrations\\Version30000Date20240906095113' => __DIR__ . '/../../..' . '/core/Migrations/Version30000Date20240906095113.php', + 'OC\\Core\\Migrations\\Version31000Date20240814184402' => __DIR__ . '/../../..' . '/core/Migrations/Version31000Date20240814184402.php', 'OC\\Core\\Migrations\\Version31000Date20241018063111' => __DIR__ . '/../../..' . '/core/Migrations/Version31000Date20241018063111.php', 'OC\\Core\\Notification\\CoreNotifier' => __DIR__ . '/../../..' . '/core/Notification/CoreNotifier.php', 'OC\\Core\\ResponseDefinitions' => __DIR__ . '/../../..' . '/core/ResponseDefinitions.php', diff --git a/lib/private/AllConfig.php b/lib/private/AllConfig.php index 46b53e3c1b21d..bb15adf31b4f0 100644 --- a/lib/private/AllConfig.php +++ b/lib/private/AllConfig.php @@ -6,8 +6,11 @@ */ namespace OC; +use NCU\Config\Exceptions\TypeConflictException; +use NCU\Config\IUserConfig; +use NCU\Config\ValueType; +use OC\Config\UserConfig; use OCP\Cache\CappedMemoryCache; -use OCP\DB\QueryBuilder\IQueryBuilder; use OCP\IConfig; use OCP\IDBConnection; use OCP\PreConditionNotMetException; @@ -224,64 +227,33 @@ public function deleteAppValues($appName) { * @param string $key the key under which the value is being stored * @param string|float|int $value the value that you want to store * @param string $preCondition only update if the config value was previously the value passed as $preCondition + * * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met * @throws \UnexpectedValueException when trying to store an unexpected value + * @deprecated 31.0.0 - use {@see IUserConfig} directly + * @see IUserConfig::getValueString + * @see IUserConfig::getValueInt + * @see IUserConfig::getValueFloat + * @see IUserConfig::getValueArray + * @see IUserConfig::getValueBool */ public function setUserValue($userId, $appName, $key, $value, $preCondition = null) { if (!is_int($value) && !is_float($value) && !is_string($value)) { throw new \UnexpectedValueException('Only integers, floats and strings are allowed as value'); } - // TODO - FIXME - $this->fixDIInit(); - - if ($appName === 'settings' && $key === 'email') { - $value = strtolower((string)$value); - } - - $prevValue = $this->getUserValue($userId, $appName, $key, null); - - if ($prevValue !== null) { - if ($preCondition !== null && $prevValue !== (string)$preCondition) { - throw new PreConditionNotMetException(); - } elseif ($prevValue === (string)$value) { - return; - } else { - $qb = $this->connection->getQueryBuilder(); - $qb->update('preferences') - ->set('configvalue', $qb->createNamedParameter($value)) - ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId))) - ->andWhere($qb->expr()->eq('appid', $qb->createNamedParameter($appName))) - ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key))); - $qb->executeStatement(); - - $this->userCache[$userId][$appName][$key] = (string)$value; - return; + /** @var UserConfig $userPreferences */ + $userPreferences = \OCP\Server::get(IUserConfig::class); + if ($preCondition !== null) { + try { + if ($userPreferences->getValueMixed($userId, $appName, $key) !== (string)$preCondition) { + throw new PreConditionNotMetException(); + } + } catch (TypeConflictException) { } } - $preconditionArray = []; - if (isset($preCondition)) { - $preconditionArray = [ - 'configvalue' => $preCondition, - ]; - } - - $this->connection->setValues('preferences', [ - 'userid' => $userId, - 'appid' => $appName, - 'configkey' => $key, - ], [ - 'configvalue' => $value, - ], $preconditionArray); - - // only add to the cache if we already loaded data for the user - if (isset($this->userCache[$userId])) { - if (!isset($this->userCache[$userId][$appName])) { - $this->userCache[$userId][$appName] = []; - } - $this->userCache[$userId][$appName][$key] = (string)$value; - } + $userPreferences->setValueMixed($userId, $appName, $key, (string)$value); } /** @@ -291,15 +263,26 @@ public function setUserValue($userId, $appName, $key, $value, $preCondition = nu * @param string $appName the appName that we stored the value under * @param string $key the key under which the value is being stored * @param mixed $default the default value to be returned if the value isn't set + * * @return string + * @deprecated 31.0.0 - use {@see IUserConfig} directly + * @see IUserConfig::getValueString + * @see IUserConfig::getValueInt + * @see IUserConfig::getValueFloat + * @see IUserConfig::getValueArray + * @see IUserConfig::getValueBool */ public function getUserValue($userId, $appName, $key, $default = '') { - $data = $this->getAllUserValues($userId); - if (isset($data[$appName][$key])) { - return $data[$appName][$key]; - } else { + if ($userId === null || $userId === '') { + return $default; + } + /** @var UserConfig $userPreferences */ + $userPreferences = \OCP\Server::get(IUserConfig::class); + // because $default can be null ... + if (!$userPreferences->hasKey($userId, $appName, $key)) { return $default; } + return $userPreferences->getValueMixed($userId, $appName, $key, $default ?? ''); } /** @@ -307,15 +290,12 @@ public function getUserValue($userId, $appName, $key, $default = '') { * * @param string $userId the userId of the user that we want to store the value under * @param string $appName the appName that we stored the value under + * * @return string[] + * @deprecated 31.0.0 - use {@see IUserConfig::getKeys} directly */ public function getUserKeys($userId, $appName) { - $data = $this->getAllUserValues($userId); - if (isset($data[$appName])) { - return array_map('strval', array_keys($data[$appName])); - } else { - return []; - } + return \OCP\Server::get(IUserConfig::class)->getKeys($userId, $appName); } /** @@ -324,96 +304,63 @@ public function getUserKeys($userId, $appName) { * @param string $userId the userId of the user that we want to store the value under * @param string $appName the appName that we stored the value under * @param string $key the key under which the value is being stored + * + * @deprecated 31.0.0 - use {@see IUserConfig::deleteUserConfig} directly */ public function deleteUserValue($userId, $appName, $key) { - // TODO - FIXME - $this->fixDIInit(); - - $qb = $this->connection->getQueryBuilder(); - $qb->delete('preferences') - ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId, IQueryBuilder::PARAM_STR))) - ->andWhere($qb->expr()->eq('appid', $qb->createNamedParameter($appName, IQueryBuilder::PARAM_STR))) - ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key, IQueryBuilder::PARAM_STR))) - ->executeStatement(); - - if (isset($this->userCache[$userId][$appName])) { - unset($this->userCache[$userId][$appName][$key]); - } + \OCP\Server::get(IUserConfig::class)->deleteUserConfig($userId, $appName, $key); } /** * Delete all user values * * @param string $userId the userId of the user that we want to remove all values from + * + * @deprecated 31.0.0 - use {@see IUserConfig::deleteAllUserConfig} directly */ public function deleteAllUserValues($userId) { - // TODO - FIXME - $this->fixDIInit(); - $qb = $this->connection->getQueryBuilder(); - $qb->delete('preferences') - ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId, IQueryBuilder::PARAM_STR))) - ->executeStatement(); - - unset($this->userCache[$userId]); + if ($userId === null) { + return; + } + \OCP\Server::get(IUserConfig::class)->deleteAllUserConfig($userId); } /** * Delete all user related values of one app * * @param string $appName the appName of the app that we want to remove all values from + * + * @deprecated 31.0.0 - use {@see IUserConfig::deleteApp} directly */ public function deleteAppFromAllUsers($appName) { - // TODO - FIXME - $this->fixDIInit(); - - $qb = $this->connection->getQueryBuilder(); - $qb->delete('preferences') - ->where($qb->expr()->eq('appid', $qb->createNamedParameter($appName, IQueryBuilder::PARAM_STR))) - ->executeStatement(); - - foreach ($this->userCache as &$userCache) { - unset($userCache[$appName]); - } + \OCP\Server::get(IUserConfig::class)->deleteApp($appName); } /** * Returns all user configs sorted by app of one user * * @param ?string $userId the user ID to get the app configs from + * * @psalm-return array> * @return array[] - 2 dimensional array with the following structure: * [ $appId => * [ $key => $value ] * ] + * @deprecated 31.0.0 - use {@see IUserConfig::getAllValues} directly */ public function getAllUserValues(?string $userId): array { - if (isset($this->userCache[$userId])) { - return $this->userCache[$userId]; - } if ($userId === null || $userId === '') { - $this->userCache[''] = []; - return $this->userCache['']; + return []; } - // TODO - FIXME - $this->fixDIInit(); - - $data = []; - - $qb = $this->connection->getQueryBuilder(); - $result = $qb->select('appid', 'configkey', 'configvalue') - ->from('preferences') - ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId, IQueryBuilder::PARAM_STR))) - ->executeQuery(); - while ($row = $result->fetch()) { - $appId = $row['appid']; - if (!isset($data[$appId])) { - $data[$appId] = []; + $values = \OCP\Server::get(IUserConfig::class)->getAllValues($userId); + $result = []; + foreach ($values as $app => $list) { + foreach ($list as $key => $value) { + $result[$app][$key] = (string)$value; } - $data[$appId][$row['configkey']] = $row['configvalue']; } - $this->userCache[$userId] = $data; - return $data; + return $result; } /** @@ -422,38 +369,12 @@ public function getAllUserValues(?string $userId): array { * @param string $appName app to get the value for * @param string $key the key to get the value for * @param array $userIds the user IDs to fetch the values for + * * @return array Mapped values: userId => value + * @deprecated 31.0.0 - use {@see IUserConfig::getValuesByUsers} directly */ public function getUserValueForUsers($appName, $key, $userIds) { - // TODO - FIXME - $this->fixDIInit(); - - if (empty($userIds) || !is_array($userIds)) { - return []; - } - - $chunkedUsers = array_chunk($userIds, 50, true); - - $qb = $this->connection->getQueryBuilder(); - $qb->select('userid', 'configvalue') - ->from('preferences') - ->where($qb->expr()->eq('appid', $qb->createParameter('appName'))) - ->andWhere($qb->expr()->eq('configkey', $qb->createParameter('configKey'))) - ->andWhere($qb->expr()->in('userid', $qb->createParameter('userIds'))); - - $userValues = []; - foreach ($chunkedUsers as $chunk) { - $qb->setParameter('appName', $appName, IQueryBuilder::PARAM_STR); - $qb->setParameter('configKey', $key, IQueryBuilder::PARAM_STR); - $qb->setParameter('userIds', $chunk, IQueryBuilder::PARAM_STR_ARRAY); - $result = $qb->executeQuery(); - - while ($row = $result->fetch()) { - $userValues[$row['userid']] = $row['configvalue']; - } - } - - return $userValues; + return \OCP\Server::get(IUserConfig::class)->getValuesByUsers($appName, $key, ValueType::MIXED, $userIds); } /** @@ -462,32 +383,14 @@ public function getUserValueForUsers($appName, $key, $userIds) { * @param string $appName the app to get the user for * @param string $key the key to get the user for * @param string $value the value to get the user for + * * @return list of user IDs + * @deprecated 31.0.0 - use {@see IUserConfig::searchUsersByValueString} directly */ public function getUsersForUserValue($appName, $key, $value) { - // TODO - FIXME - $this->fixDIInit(); - - $qb = $this->connection->getQueryBuilder(); - $configValueColumn = ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE) - ? $qb->expr()->castColumn('configvalue', IQueryBuilder::PARAM_STR) - : 'configvalue'; - $result = $qb->select('userid') - ->from('preferences') - ->where($qb->expr()->eq('appid', $qb->createNamedParameter($appName, IQueryBuilder::PARAM_STR))) - ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key, IQueryBuilder::PARAM_STR))) - ->andWhere($qb->expr()->eq( - $configValueColumn, - $qb->createNamedParameter($value, IQueryBuilder::PARAM_STR)) - )->orderBy('userid') - ->executeQuery(); - - $userIDs = []; - while ($row = $result->fetch()) { - $userIDs[] = $row['userid']; - } - - return $userIDs; + /** @var list $result */ + $result = iterator_to_array(\OCP\Server::get(IUserConfig::class)->searchUsersByValueString($appName, $key, $value)); + return $result; } /** @@ -496,38 +399,18 @@ public function getUsersForUserValue($appName, $key, $value) { * @param string $appName the app to get the user for * @param string $key the key to get the user for * @param string $value the value to get the user for + * * @return list of user IDs + * @deprecated 31.0.0 - use {@see IUserConfig::searchUsersByValueString} directly */ public function getUsersForUserValueCaseInsensitive($appName, $key, $value) { - // TODO - FIXME - $this->fixDIInit(); - if ($appName === 'settings' && $key === 'email') { - // Email address is always stored lowercase in the database return $this->getUsersForUserValue($appName, $key, strtolower($value)); } - $qb = $this->connection->getQueryBuilder(); - $configValueColumn = ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE) - ? $qb->expr()->castColumn('configvalue', IQueryBuilder::PARAM_STR) - : 'configvalue'; - - $result = $qb->select('userid') - ->from('preferences') - ->where($qb->expr()->eq('appid', $qb->createNamedParameter($appName, IQueryBuilder::PARAM_STR))) - ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key, IQueryBuilder::PARAM_STR))) - ->andWhere($qb->expr()->eq( - $qb->func()->lower($configValueColumn), - $qb->createNamedParameter(strtolower($value), IQueryBuilder::PARAM_STR)) - )->orderBy('userid') - ->executeQuery(); - - $userIDs = []; - while ($row = $result->fetch()) { - $userIDs[] = $row['userid']; - } - - return $userIDs; + /** @var list $result */ + $result = iterator_to_array(\OCP\Server::get(IUserConfig::class)->searchUsersByValueString($appName, $key, $value, true)); + return $result; } public function getSystemConfig() { diff --git a/lib/private/Config/UserConfig.php b/lib/private/Config/UserConfig.php new file mode 100644 index 0000000000000..37e109b2121a5 --- /dev/null +++ b/lib/private/Config/UserConfig.php @@ -0,0 +1,1806 @@ +>> [ass'user_id' => ['app_id' => ['key' => 'value']]] */ + private array $fastCache = []; // cache for normal config keys + /** @var array>> ['user_id' => ['app_id' => ['key' => 'value']]] */ + private array $lazyCache = []; // cache for lazy config keys + /** @var array>>> ['user_id' => ['app_id' => ['key' => ['type' => ValueType, 'flags' => bitflag]]]] */ + private array $valueDetails = []; // type for all config values + /** @var array>> ['user_id' => ['app_id' => ['key' => bitflag]]] */ + private array $valueTypes = []; // type for all config values + /** @var array>> ['user_id' => ['app_id' => ['key' => bitflag]]] */ + private array $valueFlags = []; // type for all config values + /** @var array ['user_id' => bool] */ + private array $fastLoaded = []; + /** @var array ['user_id' => bool] */ + private array $lazyLoaded = []; + + public function __construct( + protected IDBConnection $connection, + protected LoggerInterface $logger, + protected ICrypto $crypto, + ) { + } + + /** + * @inheritDoc + * + * @param string $appId optional id of app + * + * @return list list of userIds + * @since 31.0.0 + */ + public function getUserIds(string $appId = ''): array { + $this->assertParams(app: $appId, allowEmptyUser: true, allowEmptyApp: true); + + $qb = $this->connection->getQueryBuilder(); + $qb->from('preferences'); + $qb->select('userid'); + $qb->groupBy('userid'); + if ($appId !== '') { + $qb->where($qb->expr()->eq('appid', $qb->createNamedParameter($appId))); + } + + $result = $qb->executeQuery(); + $rows = $result->fetchAll(); + $userIds = []; + foreach ($rows as $row) { + $userIds[] = $row['userid']; + } + + return $userIds; + } + + /** + * @inheritDoc + * + * @return list list of app ids + * @since 31.0.0 + */ + public function getApps(string $userId): array { + $this->assertParams($userId, allowEmptyApp: true); + $this->loadConfigAll($userId); + $apps = array_merge(array_keys($this->fastCache[$userId] ?? []), array_keys($this->lazyCache[$userId] ?? [])); + sort($apps); + + return array_values(array_unique($apps)); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @param string $app id of the app + * + * @return list list of stored config keys + * @since 31.0.0 + */ + public function getKeys(string $userId, string $app): array { + $this->assertParams($userId, $app); + $this->loadConfigAll($userId); + // array_merge() will remove numeric keys (here config keys), so addition arrays instead + $keys = array_map('strval', array_keys(($this->fastCache[$userId][$app] ?? []) + ($this->lazyCache[$userId][$app] ?? []))); + sort($keys); + + return array_values(array_unique($keys)); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 31.0.0 + */ + public function hasKey(string $userId, string $app, string $key, ?bool $lazy = false): bool { + $this->assertParams($userId, $app, $key); + $this->loadConfig($userId, $lazy); + + if ($lazy === null) { + $appCache = $this->getValues($userId, $app); + return isset($appCache[$key]); + } + + if ($lazy) { + return isset($this->lazyCache[$userId][$app][$key]); + } + + return isset($this->fastCache[$userId][$app][$key]); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 UnknownKeyException if config key is not known + * @since 31.0.0 + */ + public function isSensitive(string $userId, string $app, string $key, ?bool $lazy = false): bool { + $this->assertParams($userId, $app, $key); + $this->loadConfig($userId, $lazy); + + if (!isset($this->valueDetails[$userId][$app][$key])) { + throw new UnknownKeyException('unknown config key'); + } + + return $this->isFlagged(self::FLAG_SENSITIVE, $this->valueDetails[$userId][$app][$key]['flags']); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 UnknownKeyException if config key is not known + * @since 31.0.0 + */ + public function isIndexed(string $userId, string $app, string $key, ?bool $lazy = false): bool { + $this->assertParams($userId, $app, $key); + $this->loadConfig($userId, $lazy); + + if (!isset($this->valueDetails[$userId][$app][$key])) { + throw new UnknownKeyException('unknown config key'); + } + + return $this->isFlagged(self::FLAG_INDEXED, $this->valueDetails[$userId][$app][$key]['flags']); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @param string $app if of the app + * @param string $key config key + * + * @return bool TRUE if config is lazy loaded + * @throws UnknownKeyException if config key is not known + * @see IUserConfig for details about lazy loading + * @since 31.0.0 + */ + public function isLazy(string $userId, string $app, string $key): bool { + // there is a huge probability the non-lazy config are already loaded + // meaning that we can start by only checking if a current non-lazy key exists + if ($this->hasKey($userId, $app, $key, false)) { + return false; // meaning key is not lazy. + } + + // as key is not found as non-lazy, we load and search in the lazy config + if ($this->hasKey($userId, $app, $key, true)) { + return true; + } + + throw new UnknownKeyException('unknown config key'); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 [key => value] + * @since 31.0.0 + */ + public function getValues( + string $userId, + string $app, + string $prefix = '', + bool $filtered = false, + ): array { + $this->assertParams($userId, $app, $prefix); + // if we want to filter values, we need to get sensitivity + $this->loadConfigAll($userId); + // array_merge() will remove numeric keys (here config keys), so addition arrays instead + $values = array_filter( + $this->formatAppValues($userId, $app, ($this->fastCache[$userId][$app] ?? []) + ($this->lazyCache[$userId][$app] ?? []), $filtered), + function (string $key) use ($prefix): bool { + return str_starts_with($key, $prefix); // filter values based on $prefix + }, ARRAY_FILTER_USE_KEY + ); + + return $values; + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @param bool $filtered TRUE to hide sensitive config values. Value are replaced by {@see IConfig::SENSITIVE_VALUE} + * + * @return array> [appId => [key => value]] + * @since 31.0.0 + */ + public function getAllValues(string $userId, bool $filtered = false): array { + $this->assertParams($userId, allowEmptyApp: true); + $this->loadConfigAll($userId); + + $result = []; + foreach ($this->getApps($userId) as $app) { + // array_merge() will remove numeric keys (here config keys), so addition arrays instead + $cached = ($this->fastCache[$userId][$app] ?? []) + ($this->lazyCache[$userId][$app] ?? []); + $result[$app] = $this->formatAppValues($userId, $app, $cached, $filtered); + } + + return $result; + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @param string $key config key + * @param bool $lazy search within lazy loaded config + * @param ValueType|null $typedAs enforce type for the returned values + * + * @return array [appId => value] + * @since 31.0.0 + */ + public function getValuesByApps(string $userId, string $key, bool $lazy = false, ?ValueType $typedAs = null): array { + $this->assertParams($userId, '', $key, allowEmptyApp: true); + $this->loadConfig($userId, $lazy); + + /** @var array> $cache */ + if ($lazy) { + $cache = $this->lazyCache[$userId]; + } else { + $cache = $this->fastCache[$userId]; + } + + $values = []; + foreach (array_keys($cache) as $app) { + if (isset($cache[$app][$key])) { + $value = $cache[$app][$key]; + try { + $this->decryptSensitiveValue($userId, $app, $key, $value); + $value = $this->convertTypedValue($value, $typedAs ?? $this->getValueType($userId, $app, $key, $lazy)); + } catch (IncorrectTypeException|UnknownKeyException) { + } + $values[$app] = $value; + } + } + + return $values; + } + + + /** + * @inheritDoc + * + * @param string $app id of the app + * @param string $key config key + * @param ValueType|null $typedAs enforce type for the returned values + * @param array|null $userIds limit to a list of user ids + * + * @return array [userId => value] + * @since 31.0.0 + */ + public function getValuesByUsers( + string $app, + string $key, + ?ValueType $typedAs = null, + ?array $userIds = null, + ): array { + $this->assertParams('', $app, $key, allowEmptyUser: true); + + $qb = $this->connection->getQueryBuilder(); + $qb->select('userid', 'configvalue', 'type') + ->from('preferences') + ->where($qb->expr()->eq('appid', $qb->createNamedParameter($app))) + ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key))); + + $values = []; + // this nested function will execute current Query and store result within $values. + $executeAndStoreValue = function (IQueryBuilder $qb) use (&$values, $typedAs): IResult { + $result = $qb->executeQuery(); + while ($row = $result->fetch()) { + $value = $row['configvalue']; + try { + $value = $this->convertTypedValue($value, $typedAs ?? ValueType::from((int)$row['type'])); + } catch (IncorrectTypeException) { + } + $values[$row['userid']] = $value; + } + return $result; + }; + + // if no userIds to filter, we execute query as it is and returns all values ... + if ($userIds === null) { + $result = $executeAndStoreValue($qb); + $result->closeCursor(); + return $values; + } + + // if userIds to filter, we chunk the list and execute the same query multiple times until we get all values + $result = null; + $qb->andWhere($qb->expr()->in('userid', $qb->createParameter('userIds'))); + foreach (array_chunk($userIds, 50, true) as $chunk) { + $qb->setParameter('userIds', $chunk, IQueryBuilder::PARAM_STR_ARRAY); + $result = $executeAndStoreValue($qb); + } + $result?->closeCursor(); + + return $values; + } + + /** + * @inheritDoc + * + * @param string $app id of the app + * @param string $key config key + * @param string $value config value + * @param bool $caseInsensitive non-case-sensitive search, only works if $value is a string + * + * @return Generator + * @since 31.0.0 + */ + public function searchUsersByValueString(string $app, string $key, string $value, bool $caseInsensitive = false): Generator { + return $this->searchUsersByTypedValue($app, $key, $value, $caseInsensitive); + } + + /** + * @inheritDoc + * + * @param string $app id of the app + * @param string $key config key + * @param int $value config value + * + * @return Generator + * @since 31.0.0 + */ + public function searchUsersByValueInt(string $app, string $key, int $value): Generator { + return $this->searchUsersByValueString($app, $key, (string)$value); + } + + /** + * @inheritDoc + * + * @param string $app id of the app + * @param string $key config key + * @param array $values list of config values + * + * @return Generator + * @since 31.0.0 + */ + public function searchUsersByValues(string $app, string $key, array $values): Generator { + return $this->searchUsersByTypedValue($app, $key, $values); + } + + /** + * @inheritDoc + * + * @param string $app id of the app + * @param string $key config key + * @param bool $value config value + * + * @return Generator + * @since 31.0.0 + */ + public function searchUsersByValueBool(string $app, string $key, bool $value): Generator { + $values = ['0', 'off', 'false', 'no']; + if ($value) { + $values = ['1', 'on', 'true', 'yes']; + } + return $this->searchUsersByValues($app, $key, $values); + } + + /** + * returns a list of users with config key set to a specific value, or within the list of + * possible values + * + * @param string $app + * @param string $key + * @param string|array $value + * @param bool $caseInsensitive + * + * @return Generator + */ + private function searchUsersByTypedValue(string $app, string $key, string|array $value, bool $caseInsensitive = false): Generator { + $this->assertParams('', $app, $key, allowEmptyUser: true); + + $qb = $this->connection->getQueryBuilder(); + $qb->from('preferences'); + $qb->select('userid'); + $qb->where($qb->expr()->eq('appid', $qb->createNamedParameter($app))); + $qb->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key))); + + // search within 'indexed' OR 'configvalue' only if 'flags' is set as not indexed + // TODO: when implementing config lexicon remove the searches on 'configvalue' if value is set as indexed + $configValueColumn = ($this->connection->getDatabaseProvider() === IDBConnection::PLATFORM_ORACLE) ? $qb->expr()->castColumn('configvalue', IQueryBuilder::PARAM_STR) : 'configvalue'; + if (is_array($value)) { + $where = $qb->expr()->orX( + $qb->expr()->in('indexed', $qb->createNamedParameter($value, IQueryBuilder::PARAM_STR_ARRAY)), + $qb->expr()->andX( + $qb->expr()->neq($qb->expr()->bitwiseAnd('flags', self::FLAG_INDEXED), $qb->createNamedParameter(self::FLAG_INDEXED, IQueryBuilder::PARAM_INT)), + $qb->expr()->in($configValueColumn, $qb->createNamedParameter($value, IQueryBuilder::PARAM_STR_ARRAY)) + ) + ); + } else { + if ($caseInsensitive) { + $where = $qb->expr()->orX( + $qb->expr()->eq($qb->func()->lower('indexed'), $qb->createNamedParameter(strtolower($value))), + $qb->expr()->andX( + $qb->expr()->neq($qb->expr()->bitwiseAnd('flags', self::FLAG_INDEXED), $qb->createNamedParameter(self::FLAG_INDEXED, IQueryBuilder::PARAM_INT)), + $qb->expr()->eq($qb->func()->lower($configValueColumn), $qb->createNamedParameter(strtolower($value))) + ) + ); + } else { + $where = $qb->expr()->orX( + $qb->expr()->eq('indexed', $qb->createNamedParameter($value)), + $qb->expr()->andX( + $qb->expr()->neq($qb->expr()->bitwiseAnd('flags', self::FLAG_INDEXED), $qb->createNamedParameter(self::FLAG_INDEXED, IQueryBuilder::PARAM_INT)), + $qb->expr()->eq($configValueColumn, $qb->createNamedParameter($value)) + ) + ); + } + } + + $qb->andWhere($where); + $result = $qb->executeQuery(); + while ($row = $result->fetch()) { + yield $row['userid']; + } + } + + /** + * 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 $userId id of the user + * @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 + * @throws TypeConflictException + * @internal + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see getValueString() + * @see getValueInt() + * @see getValueFloat() + * @see getValueBool() + * @see getValueArray() + */ + public function getValueMixed( + string $userId, + string $app, + string $key, + string $default = '', + ?bool $lazy = false, + ): string { + try { + $lazy ??= $this->isLazy($userId, $app, $key); + } catch (UnknownKeyException) { + return $default; + } + + return $this->getTypedValue( + $userId, + $app, + $key, + $default, + $lazy, + ValueType::MIXED + ); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 TypeConflictException in case of conflict with the value type set in database + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + */ + public function getValueString( + string $userId, + string $app, + string $key, + string $default = '', + bool $lazy = false, + ): string { + return $this->getTypedValue($userId, $app, $key, $default, $lazy, ValueType::STRING); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 TypeConflictException in case of conflict with the value type set in database + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + */ + public function getValueInt( + string $userId, + string $app, + string $key, + int $default = 0, + bool $lazy = false, + ): int { + return (int)$this->getTypedValue($userId, $app, $key, (string)$default, $lazy, ValueType::INT); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 TypeConflictException in case of conflict with the value type set in database + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + */ + public function getValueFloat( + string $userId, + string $app, + string $key, + float $default = 0, + bool $lazy = false, + ): float { + return (float)$this->getTypedValue($userId, $app, $key, (string)$default, $lazy, ValueType::FLOAT); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 TypeConflictException in case of conflict with the value type set in database + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + */ + public function getValueBool( + string $userId, + string $app, + string $key, + bool $default = false, + bool $lazy = false, + ): bool { + $b = strtolower($this->getTypedValue($userId, $app, $key, $default ? 'true' : 'false', $lazy, ValueType::BOOL)); + return in_array($b, ['1', 'true', 'yes', 'on']); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 TypeConflictException in case of conflict with the value type set in database + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + */ + public function getValueArray( + string $userId, + string $app, + string $key, + array $default = [], + bool $lazy = false, + ): array { + try { + $defaultJson = json_encode($default, JSON_THROW_ON_ERROR); + $value = json_decode($this->getTypedValue($userId, $app, $key, $defaultJson, $lazy, ValueType::ARRAY), true, flags: JSON_THROW_ON_ERROR); + + return is_array($value) ? $value : []; + } catch (JsonException) { + return []; + } + } + + /** + * @param string $userId + * @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 ValueType $type value type + * + * @return string + * @throws TypeConflictException if type from database is not VALUE_MIXED and different from the requested one + */ + private function getTypedValue( + string $userId, + string $app, + string $key, + string $default, + bool $lazy, + ValueType $type, + ): string { + $this->assertParams($userId, $app, $key); + $this->loadConfig($userId, $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->valueDetails[$userId][$app][$key]['type'] ?? null; + if ($type !== ValueType::MIXED + && $knownType !== null + && $knownType !== ValueType::MIXED + && $type !== $knownType) { + $this->logger->warning('conflict with value type from database', ['app' => $app, 'key' => $key, 'type' => $type, 'knownType' => $knownType]); + throw new TypeConflictException('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[$userId][$app][$key])) { + $value = $this->lazyCache[$userId][$app][$key]; + } elseif (isset($this->fastCache[$userId][$app][$key])) { + $value = $this->fastCache[$userId][$app][$key]; + } else { + return $default; + } + + $this->decryptSensitiveValue($userId, $app, $key, $value); + return $value; + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * + * @return ValueType type of the value + * @throws UnknownKeyException if config key is not known + * @throws IncorrectTypeException if config value type is not known + * @since 31.0.0 + */ + public function getValueType(string $userId, string $app, string $key, ?bool $lazy = null): ValueType { + $this->assertParams($userId, $app, $key); + $this->loadConfig($userId, $lazy); + + if (!isset($this->valueDetails[$userId][$app][$key]['type'])) { + throw new UnknownKeyException('unknown config key'); + } + + return $this->valueDetails[$userId][$app][$key]['type']; + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param bool $lazy lazy loading + * + * @return int flags applied to value + * @throws UnknownKeyException if config key is not known + * @throws IncorrectTypeException if config value type is not known + * @since 31.0.0 + */ + public function getValueFlags(string $userId, string $app, string $key, bool $lazy = false): int { + $this->assertParams($userId, $app, $key); + $this->loadConfig($userId, $lazy); + + if (!isset($this->valueDetails[$userId][$app][$key])) { + throw new UnknownKeyException('unknown config key'); + } + + return $this->valueDetails[$userId][$app][$key]['flags']; + } + + /** + * 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 $userId id of the user + * @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 TypeConflictException if type from database is not VALUE_MIXED + * @internal + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see setValueString() + * @see setValueInt() + * @see setValueFloat() + * @see setValueBool() + * @see setValueArray() + */ + public function setValueMixed( + string $userId, + string $app, + string $key, + string $value, + bool $lazy = false, + int $flags = 0, + ): bool { + return $this->setTypedValue( + $userId, + $app, + $key, + $value, + $lazy, + $flags, + ValueType::MIXED + ); + } + + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 TypeConflictException if type from database is not VALUE_MIXED and different from the requested one + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + */ + public function setValueString( + string $userId, + string $app, + string $key, + string $value, + bool $lazy = false, + int $flags = 0, + ): bool { + return $this->setTypedValue( + $userId, + $app, + $key, + $value, + $lazy, + $flags, + ValueType::STRING + ); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 TypeConflictException if type from database is not VALUE_MIXED and different from the requested one + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + */ + public function setValueInt( + string $userId, + string $app, + string $key, + int $value, + bool $lazy = false, + int $flags = 0, + ): 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( + $userId, + $app, + $key, + (string)$value, + $lazy, + $flags, + ValueType::INT + ); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 TypeConflictException if type from database is not VALUE_MIXED and different from the requested one + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + */ + public function setValueFloat( + string $userId, + string $app, + string $key, + float $value, + bool $lazy = false, + int $flags = 0, + ): bool { + return $this->setTypedValue( + $userId, + $app, + $key, + (string)$value, + $lazy, + $flags, + ValueType::FLOAT + ); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 TypeConflictException if type from database is not VALUE_MIXED and different from the requested one + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + */ + public function setValueBool( + string $userId, + string $app, + string $key, + bool $value, + bool $lazy = false, + int $flags = 0, + ): bool { + return $this->setTypedValue( + $userId, + $app, + $key, + ($value) ? '1' : '0', + $lazy, + $flags, + ValueType::BOOL + ); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 TypeConflictException if type from database is not VALUE_MIXED and different from the requested one + * @throws JsonException + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + */ + public function setValueArray( + string $userId, + string $app, + string $key, + array $value, + bool $lazy = false, + int $flags = 0, + ): bool { + try { + return $this->setTypedValue( + $userId, + $app, + $key, + json_encode($value, JSON_THROW_ON_ERROR), + $lazy, + $flags, + ValueType::ARRAY + ); + } 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 $userId id of the user + * @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 ValueType $type value type + * + * @return bool TRUE if value was updated in database + * @throws TypeConflictException if type from database is not VALUE_MIXED and different from the requested one + * @see IUserConfig for explanation about lazy loading + */ + private function setTypedValue( + string $userId, + string $app, + string $key, + string $value, + bool $lazy, + int $flags, + ValueType $type, + ): bool { + $this->assertParams($userId, $app, $key); + $this->loadConfig($userId, $lazy); + + $inserted = $refreshCache = false; + $origValue = $value; + $sensitive = $this->isFlagged(self::FLAG_SENSITIVE, $flags); + if ($sensitive || ($this->hasKey($userId, $app, $key, $lazy) && $this->isSensitive($userId, $app, $key, $lazy))) { + $value = self::ENCRYPTION_PREFIX . $this->crypto->encrypt($value); + $flags |= UserConfig::FLAG_SENSITIVE; + } + + // if requested, we fill the 'indexed' field with current value + $indexed = ''; + if ($type !== ValueType::ARRAY && $this->isFlagged(self::FLAG_INDEXED, $flags)) { + if ($this->isFlagged(self::FLAG_SENSITIVE, $flags)) { + $this->logger->warning('sensitive value are not to be indexed'); + } elseif (strlen($value) > self::USER_MAX_LENGTH) { + $this->logger->warning('value is too lengthy to be indexed'); + } else { + $indexed = $value; + } + } + + if ($this->hasKey($userId, $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($userId, $app, $key, $value, $lazy, $type) + && (!$sensitive || $this->isSensitive($userId, $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('preferences') + ->setValue('userid', $insert->createNamedParameter($userId)) + ->setValue('appid', $insert->createNamedParameter($app)) + ->setValue('lazy', $insert->createNamedParameter(($lazy) ? 1 : 0, IQueryBuilder::PARAM_INT)) + ->setValue('type', $insert->createNamedParameter($type->value, IQueryBuilder::PARAM_INT)) + ->setValue('flags', $insert->createNamedParameter($flags, IQueryBuilder::PARAM_INT)) + ->setValue('indexed', $insert->createNamedParameter($indexed)) + ->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->valueDetails[$userId][$app][$key]['type'] ?? null; + if ($currType === null) { // this might happen when switching lazy loading status + $this->loadConfigAll($userId); + $currType = $this->valueDetails[$userId][$app][$key]['type']; + } + + /** + * We only log a warning and set it to VALUE_MIXED. + */ + if ($currType === null) { + $this->logger->warning('Value type is set to zero (0) in database. This is not supposed to happens', ['app' => $app, 'key' => $key]); + $currType = ValueType::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 ($currType !== ValueType::MIXED && + $currType !== $type) { + try { + $currTypeDef = $currType->getDefinition(); + $typeDef = $type->getDefinition(); + } catch (IncorrectTypeException) { + $currTypeDef = $currType->value; + $typeDef = $type->value; + } + throw new TypeConflictException('conflict between new type (' . $typeDef . ') and old type (' . $currTypeDef . ')'); + } + + if ($lazy !== $this->isLazy($userId, $app, $key)) { + $refreshCache = true; + } + + $update = $this->connection->getQueryBuilder(); + $update->update('preferences') + ->set('configvalue', $update->createNamedParameter($value)) + ->set('lazy', $update->createNamedParameter(($lazy) ? 1 : 0, IQueryBuilder::PARAM_INT)) + ->set('type', $update->createNamedParameter($type->value, IQueryBuilder::PARAM_INT)) + ->set('flags', $update->createNamedParameter($flags, IQueryBuilder::PARAM_INT)) + ->set('indexed', $update->createNamedParameter($indexed)) + ->where($update->expr()->eq('userid', $update->createNamedParameter($userId))) + ->andWhere($update->expr()->eq('appid', $update->createNamedParameter($app))) + ->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key))); + + $update->executeStatement(); + } + + if ($refreshCache) { + $this->clearCache($userId); + return true; + } + + // update local cache + if ($lazy) { + $this->lazyCache[$userId][$app][$key] = $value; + } else { + $this->fastCache[$userId][$app][$key] = $value; + } + $this->valueDetails[$userId][$app][$key] = [ + 'type' => $type, + 'flags' => $flags + ]; + + return true; + } + + /** + * Change the type of config value. + * + * **WARNING:** Method is internal and **MUST** not be used as it may break things. + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param ValueType $type value type + * + * @return bool TRUE if database update were necessary + * @throws UnknownKeyException if $key is now known in database + * @throws IncorrectTypeException if $type is not valid + * @internal + * @since 31.0.0 + */ + public function updateType(string $userId, string $app, string $key, ValueType $type = ValueType::MIXED): bool { + $this->assertParams($userId, $app, $key); + $this->loadConfigAll($userId); + $this->isLazy($userId, $app, $key); // confirm key exists + + $update = $this->connection->getQueryBuilder(); + $update->update('preferences') + ->set('type', $update->createNamedParameter($type->value, IQueryBuilder::PARAM_INT)) + ->where($update->expr()->eq('userid', $update->createNamedParameter($userId))) + ->andWhere($update->expr()->eq('appid', $update->createNamedParameter($app))) + ->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key))); + $update->executeStatement(); + + $this->valueDetails[$userId][$app][$key]['type'] = $type; + + return true; + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 31.0.0 + */ + public function updateSensitive(string $userId, string $app, string $key, bool $sensitive): bool { + $this->assertParams($userId, $app, $key); + $this->loadConfigAll($userId); + + try { + if ($sensitive === $this->isSensitive($userId, $app, $key, null)) { + return false; + } + } catch (UnknownKeyException) { + return false; + } + + $lazy = $this->isLazy($userId, $app, $key); + if ($lazy) { + $cache = $this->lazyCache; + } else { + $cache = $this->fastCache; + } + + if (!isset($cache[$userId][$app][$key])) { + throw new UnknownKeyException('unknown config key'); + } + + $value = $cache[$userId][$app][$key]; + $flags = $this->getValueFlags($userId, $app, $key); + if ($sensitive) { + $flags |= self::FLAG_SENSITIVE; + $value = self::ENCRYPTION_PREFIX . $this->crypto->encrypt($value); + } else { + $flags &= ~self::FLAG_SENSITIVE; + $this->decryptSensitiveValue($userId, $app, $key, $value); + } + + $update = $this->connection->getQueryBuilder(); + $update->update('preferences') + ->set('flags', $update->createNamedParameter($flags, IQueryBuilder::PARAM_INT)) + ->set('configvalue', $update->createNamedParameter($value)) + ->where($update->expr()->eq('userid', $update->createNamedParameter($userId))) + ->andWhere($update->expr()->eq('appid', $update->createNamedParameter($app))) + ->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key))); + $update->executeStatement(); + + $this->valueDetails[$userId][$app][$key]['flags'] = $flags; + + return true; + } + + /** + * @inheritDoc + * + * @param string $app + * @param string $key + * @param bool $sensitive + * + * @since 31.0.0 + */ + public function updateGlobalSensitive(string $app, string $key, bool $sensitive): void { + $this->assertParams('', $app, $key, allowEmptyUser: true); + foreach (array_keys($this->getValuesByUsers($app, $key)) as $userId) { + try { + $this->updateSensitive($userId, $app, $key, $sensitive); + } catch (UnknownKeyException) { + // should not happen and can be ignored + } + } + + $this->clearCacheAll(); // we clear all cache + } + + /** + * @inheritDoc + * + * @param string $userId + * @param string $app + * @param string $key + * @param bool $indexed + * + * @return bool + * @throws DBException + * @throws IncorrectTypeException + * @throws UnknownKeyException + * @since 31.0.0 + */ + public function updateIndexed(string $userId, string $app, string $key, bool $indexed): bool { + $this->assertParams($userId, $app, $key); + $this->loadConfigAll($userId); + + try { + if ($indexed === $this->isIndexed($userId, $app, $key, null)) { + return false; + } + } catch (UnknownKeyException) { + return false; + } + + $lazy = $this->isLazy($userId, $app, $key); + if ($lazy) { + $cache = $this->lazyCache; + } else { + $cache = $this->fastCache; + } + + if (!isset($cache[$userId][$app][$key])) { + throw new UnknownKeyException('unknown config key'); + } + + $value = $cache[$userId][$app][$key]; + $flags = $this->getValueFlags($userId, $app, $key); + if ($indexed) { + $indexed = $value; + } else { + $flags &= ~self::FLAG_INDEXED; + $indexed = ''; + } + + $update = $this->connection->getQueryBuilder(); + $update->update('preferences') + ->set('flags', $update->createNamedParameter($flags, IQueryBuilder::PARAM_INT)) + ->set('indexed', $update->createNamedParameter($indexed)) + ->where($update->expr()->eq('userid', $update->createNamedParameter($userId))) + ->andWhere($update->expr()->eq('appid', $update->createNamedParameter($app))) + ->andWhere($update->expr()->eq('configkey', $update->createNamedParameter($key))); + $update->executeStatement(); + + $this->valueDetails[$userId][$app][$key]['flags'] = $flags; + + return true; + } + + + /** + * @inheritDoc + * + * @param string $app + * @param string $key + * @param bool $indexed + * + * @since 31.0.0 + */ + public function updateGlobalIndexed(string $app, string $key, bool $indexed): void { + $this->assertParams('', $app, $key, allowEmptyUser: true); + foreach (array_keys($this->getValuesByUsers($app, $key)) as $userId) { + try { + $this->updateIndexed($userId, $app, $key, $indexed); + } catch (UnknownKeyException) { + // should not happen and can be ignored + } + } + + $this->clearCacheAll(); // we clear all cache + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @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 31.0.0 + */ + public function updateLazy(string $userId, string $app, string $key, bool $lazy): bool { + $this->assertParams($userId, $app, $key); + $this->loadConfigAll($userId); + + try { + if ($lazy === $this->isLazy($userId, $app, $key)) { + return false; + } + } catch (UnknownKeyException) { + return false; + } + + $update = $this->connection->getQueryBuilder(); + $update->update('preferences') + ->set('lazy', $update->createNamedParameter($lazy ? 1 : 0, IQueryBuilder::PARAM_INT)) + ->where($update->expr()->eq('userid', $update->createNamedParameter($userId))) + ->andWhere($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($userId); + + 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 + * + * @since 31.0.0 + */ + public function updateGlobalLazy(string $app, string $key, bool $lazy): void { + $this->assertParams('', $app, $key, allowEmptyUser: true); + + $update = $this->connection->getQueryBuilder(); + $update->update('preferences') + ->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(); + + $this->clearCacheAll(); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * + * @return array + * @throws UnknownKeyException if config key is not known in database + * @since 31.0.0 + */ + public function getDetails(string $userId, string $app, string $key): array { + $this->assertParams($userId, $app, $key); + $this->loadConfigAll($userId); + $lazy = $this->isLazy($userId, $app, $key); + + if ($lazy) { + $cache = $this->lazyCache[$userId]; + } else { + $cache = $this->fastCache[$userId]; + } + + $type = $this->getValueType($userId, $app, $key); + try { + $typeString = $type->getDefinition(); + } catch (IncorrectTypeException $e) { + $this->logger->warning('type stored in database is not correct', ['exception' => $e, 'type' => $type]); + $typeString = (string)$type->value; + } + + if (!isset($cache[$app][$key])) { + throw new UnknownKeyException('unknown config key'); + } + + $value = $cache[$app][$key]; + $sensitive = $this->isSensitive($userId, $app, $key, null); + $this->decryptSensitiveValue($userId, $app, $key, $value); + + return [ + 'userId' => $userId, + 'app' => $app, + 'key' => $key, + 'value' => $value, + 'type' => $type->value, + 'lazy' => $lazy, + 'typeString' => $typeString, + 'sensitive' => $sensitive + ]; + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * + * @since 31.0.0 + */ + public function deleteUserConfig(string $userId, string $app, string $key): void { + $this->assertParams($userId, $app, $key); + $qb = $this->connection->getQueryBuilder(); + $qb->delete('preferences') + ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId))) + ->andWhere($qb->expr()->eq('appid', $qb->createNamedParameter($app))) + ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key))); + $qb->executeStatement(); + + unset($this->lazyCache[$userId][$app][$key]); + unset($this->fastCache[$userId][$app][$key]); + } + + /** + * @inheritDoc + * + * @param string $app id of the app + * @param string $key config key + * + * @since 31.0.0 + */ + public function deleteKey(string $app, string $key): void { + $this->assertParams('', $app, $key, allowEmptyUser: true); + $qb = $this->connection->getQueryBuilder(); + $qb->delete('preferences') + ->where($qb->expr()->eq('appid', $qb->createNamedParameter($app))) + ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key))); + $qb->executeStatement(); + + $this->clearCacheAll(); + } + + /** + * @inheritDoc + * + * @param string $app id of the app + * + * @since 31.0.0 + */ + public function deleteApp(string $app): void { + $this->assertParams('', $app, allowEmptyUser: true); + $qb = $this->connection->getQueryBuilder(); + $qb->delete('preferences') + ->where($qb->expr()->eq('appid', $qb->createNamedParameter($app))); + $qb->executeStatement(); + + $this->clearCacheAll(); + } + + public function deleteAllUserConfig(string $userId): void { + $this->assertParams($userId, '', allowEmptyApp: true); + $qb = $this->connection->getQueryBuilder(); + $qb->delete('preferences') + ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId))); + $qb->executeStatement(); + + $this->clearCache($userId); + } + + /** + * @inheritDoc + * + * @param string $userId id of the user + * @param bool $reload set to TRUE to refill cache instantly after clearing it. + * + * @since 31.0.0 + */ + public function clearCache(string $userId, bool $reload = false): void { + $this->assertParams($userId, allowEmptyApp: true); + $this->lazyLoaded[$userId] = $this->fastLoaded[$userId] = false; + $this->lazyCache[$userId] = $this->fastCache[$userId] = $this->valueDetails[$userId] = []; + + if (!$reload) { + return; + } + + $this->loadConfigAll($userId); + } + + /** + * @inheritDoc + * + * @since 31.0.0 + */ + public function clearCacheAll(): void { + $this->lazyLoaded = $this->fastLoaded = []; + $this->lazyCache = $this->fastCache = $this->valueDetails = []; + } + + /** + * For debug purpose. + * Returns the cached data. + * + * @return array + * @since 31.0.0 + * @internal + */ + public function statusCache(): array { + return [ + 'fastLoaded' => $this->fastLoaded, + 'fastCache' => $this->fastCache, + 'lazyLoaded' => $this->lazyLoaded, + 'lazyCache' => $this->lazyCache, + 'valueDetails' => $this->valueDetails, + ]; + } + + /** + * @param int $needle bitflag to search + * @param int $flags all flags + * + * @return bool TRUE if bitflag $needle is set in $flags + */ + private function isFlagged(int $needle, int $flags): bool { + return (($needle & $flags) !== 0); + } + + /** + * Confirm the string set for app and key fit the database description + * + * @param string $userId + * @param string $app assert $app fit in database + * @param string $prefKey assert config key fit in database + * @param bool $allowEmptyUser + * @param bool $allowEmptyApp $app can be empty string + * @param ValueType|null $valueType assert value type is only one type + */ + private function assertParams( + string $userId = '', + string $app = '', + string $prefKey = '', + bool $allowEmptyUser = false, + bool $allowEmptyApp = false, + ): void { + if (!$allowEmptyUser && $userId === '') { + throw new InvalidArgumentException('userId cannot be an empty string'); + } + if (!$allowEmptyApp && $app === '') { + throw new InvalidArgumentException('app cannot be an empty string'); + } + if (strlen($userId) > self::USER_MAX_LENGTH) { + throw new InvalidArgumentException('Value (' . $userId . ') for userId is too long (' . self::USER_MAX_LENGTH . ')'); + } + if (strlen($app) > self::APP_MAX_LENGTH) { + throw new InvalidArgumentException('Value (' . $app . ') for app is too long (' . self::APP_MAX_LENGTH . ')'); + } + if (strlen($prefKey) > self::KEY_MAX_LENGTH) { + throw new InvalidArgumentException('Value (' . $prefKey . ') for key is too long (' . self::KEY_MAX_LENGTH . ')'); + } + } + + private function loadConfigAll(string $userId): void { + $this->loadConfig($userId, 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(string $userId, ?bool $lazy = false): void { + if ($this->isLoaded($userId, $lazy)) { + return; + } + + if (($lazy ?? true) !== false) { // if lazy is null or true, we debug log + $this->logger->debug('The loading of lazy UserConfig values have been requested', ['exception' => new \RuntimeException('ignorable exception')]); + } + + $qb = $this->connection->getQueryBuilder(); + $qb->from('preferences'); + $qb->select('appid', 'configkey', 'configvalue', 'type', 'flags'); + $qb->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId))); + + // we only need value from lazy when loadConfig does not specify it + if ($lazy !== null) { + $qb->andWhere($qb->expr()->eq('lazy', $qb->createNamedParameter($lazy ? 1 : 0, IQueryBuilder::PARAM_INT))); + } else { + $qb->addSelect('lazy'); + } + + $result = $qb->executeQuery(); + $rows = $result->fetchAll(); + foreach ($rows as $row) { + if (($row['lazy'] ?? ($lazy ?? 0) ? 1 : 0) === 1) { + $this->lazyCache[$userId][$row['appid']][$row['configkey']] = $row['configvalue'] ?? ''; + } else { + $this->fastCache[$userId][$row['appid']][$row['configkey']] = $row['configvalue'] ?? ''; + } + $this->valueDetails[$userId][$row['appid']][$row['configkey']] = ['type' => ValueType::from((int)($row['type'] ?? 0)), 'flags' => (int)$row['flags']]; + } + $result->closeCursor(); + $this->setAsLoaded($userId, $lazy); + } + + /** + * if $lazy is: + * - false: will returns true if fast config are loaded + * - true : will returns true if lazy config are loaded + * - null : will returns true if both config are loaded + * + * @param string $userId + * @param bool $lazy + * + * @return bool + */ + private function isLoaded(string $userId, ?bool $lazy): bool { + if ($lazy === null) { + return ($this->lazyLoaded[$userId] ?? false) && ($this->fastLoaded[$userId] ?? false); + } + + return $lazy ? $this->lazyLoaded[$userId] ?? false : $this->fastLoaded[$userId] ?? false; + } + + /** + * if $lazy is: + * - false: set fast config as loaded + * - true : set lazy config as loaded + * - null : set both config as loaded + * + * @param string $userId + * @param bool $lazy + */ + private function setAsLoaded(string $userId, ?bool $lazy): void { + if ($lazy === null) { + $this->fastLoaded[$userId] = $this->lazyLoaded[$userId] = true; + return; + } + + // We also create empty entry to keep both fastLoaded/lazyLoaded synced + if ($lazy) { + $this->lazyLoaded[$userId] = true; + $this->fastLoaded[$userId] = $this->fastLoaded[$userId] ?? false; + $this->fastCache[$userId] = $this->fastCache[$userId] ?? []; + } else { + $this->fastLoaded[$userId] = true; + $this->lazyLoaded[$userId] = $this->lazyLoaded[$userId] ?? false; + $this->lazyCache[$userId] = $this->lazyCache[$userId] ?? []; + } + } + + /** + * **Warning:** this will load all lazy values from the database + * + * @param string $userId id of the user + * @param string $app id of the app + * @param bool $filtered TRUE to hide sensitive config values. Value are replaced by {@see IConfig::SENSITIVE_VALUE} + * + * @return array + */ + private function formatAppValues(string $userId, string $app, array $values, bool $filtered = false): array { + foreach ($values as $key => $value) { + //$key = (string)$key; + try { + $type = $this->getValueType($userId, $app, (string)$key); + } catch (UnknownKeyException) { + continue; + } + + if ($this->isFlagged(self::FLAG_SENSITIVE, $this->valueDetails[$userId][$app][$key]['flags'] ?? 0)) { + if ($filtered) { + $value = IConfig::SENSITIVE_VALUE; + $type = ValueType::STRING; + } else { + $this->decryptSensitiveValue($userId, $app, (string)$key, $value); + } + } + + $values[$key] = $this->convertTypedValue($value, $type); + } + + return $values; + } + + /** + * convert string value to the expected type + * + * @param string $value + * @param ValueType $type + * + * @return string|int|float|bool|array + */ + private function convertTypedValue(string $value, ValueType $type): string|int|float|bool|array { + switch ($type) { + case ValueType::INT: + return (int)$value; + case ValueType::FLOAT: + return (float)$value; + case ValueType::BOOL: + return in_array(strtolower($value), ['1', 'true', 'yes', 'on']); + case ValueType::ARRAY: + try { + return json_decode($value, true, flags: JSON_THROW_ON_ERROR); + } catch (JsonException) { + // ignoreable + } + break; + } + return $value; + } + + + private function decryptSensitiveValue(string $userId, string $app, string $key, string &$value): void { + if (!$this->isFlagged(self::FLAG_SENSITIVE, $this->valueDetails[$userId][$app][$key]['flags'] ?? 0)) { + return; + } + + if (!str_starts_with($value, self::ENCRYPTION_PREFIX)) { + return; + } + + try { + $value = $this->crypto->decrypt(substr($value, self::ENCRYPTION_PREFIX_LENGTH)); + } catch (\Exception $e) { + $this->logger->warning('could not decrypt sensitive value', [ + 'userId' => $userId, + 'app' => $app, + 'key' => $key, + 'value' => $value, + 'exception' => $e + ]); + } + } +} diff --git a/lib/private/Server.php b/lib/private/Server.php index 27a5f2662f822..d57ddf61c0378 100644 --- a/lib/private/Server.php +++ b/lib/private/Server.php @@ -7,6 +7,7 @@ namespace OC; use bantu\IniGetWrapper\IniGetWrapper; +use NCU\Config\IUserConfig; use OC\Accounts\AccountManager; use OC\App\AppManager; use OC\App\AppStore\Bundles\BundleFetcher; @@ -567,6 +568,7 @@ public function __construct($webRoot, \OC\Config $config) { }); $this->registerAlias(IAppConfig::class, \OC\AppConfig::class); + $this->registerAlias(IUserConfig::class, \OC\Config\UserConfig::class); $this->registerService(IFactory::class, function (Server $c) { return new \OC\L10N\Factory( diff --git a/lib/unstable/Config/Exceptions/IncorrectTypeException.php b/lib/unstable/Config/Exceptions/IncorrectTypeException.php new file mode 100644 index 0000000000000..a5e4954cdb21c --- /dev/null +++ b/lib/unstable/Config/Exceptions/IncorrectTypeException.php @@ -0,0 +1,18 @@ + list of userIds + * @since 31.0.0 + */ + public function getUserIds(string $appId = ''): array; + + /** + * Get list of all apps that have at least one config + * value related to $userId stored in database + * + * **WARNING:** ignore lazy filtering, all user config are loaded from database + * + * @param string $userId id of the user + * + * @return list list of app ids + * @since 31.0.0 + */ + public function getApps(string $userId): array; + + /** + * Returns all keys stored in database, related to user+app. + * Please note that the values are not returned. + * + * **WARNING:** ignore lazy filtering, all user config are loaded from database + * + * @param string $userId id of the user + * @param string $app id of the app + * + * @return list list of stored config keys + * @since 31.0.0 + */ + public function getKeys(string $userId, string $app): array; + + /** + * Check if a key exists in the list of stored config values. + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param bool $lazy search within lazy loaded config + * + * @return bool TRUE if key exists + * @since 31.0.0 + */ + public function hasKey(string $userId, string $app, string $key, ?bool $lazy = false): bool; + + /** + * best way to see if a value is set as sensitive (not displayed in report) + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param bool|null $lazy search within lazy loaded config + * + * @return bool TRUE if value is sensitive + * @throws UnknownKeyException if config key is not known + * @since 31.0.0 + */ + public function isSensitive(string $userId, string $app, string $key, ?bool $lazy = false): bool; + + /** + * best way to see if a value is set as indexed (so it can be search) + * + * @see self::searchUsersByValueString() + * @see self::searchUsersByValueInt() + * @see self::searchUsersByValueBool() + * @see self::searchUsersByValues() + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param bool|null $lazy search within lazy loaded config + * + * @return bool TRUE if value is sensitive + * @throws UnknownKeyException if config key is not known + * @since 31.0.0 + */ + public function isIndexed(string $userId, string $app, string $key, ?bool $lazy = false): bool; + + /** + * Returns if the config key stored in database is lazy loaded + * + * **WARNING:** ignore lazy filtering, all config values are loaded from database + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * + * @return bool TRUE if config is lazy loaded + * @throws UnknownKeyException if config key is not known + * @see IUserConfig for details about lazy loading + * @since 31.0.0 + */ + public function isLazy(string $userId, string $app, string $key): bool; + + /** + * List all config values from an app with config key starting with $key. + * Returns an array with config key as key, stored value as value. + * + * **WARNING:** ignore lazy filtering, all config values are loaded from database + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $prefix config keys prefix to search, can be empty. + * @param bool $filtered filter sensitive config values + * + * @return array [key => value] + * @since 31.0.0 + */ + public function getValues(string $userId, string $app, string $prefix = '', bool $filtered = false): array; + + /** + * List all config values of a user. + * Returns an array with config key as key, stored value as value. + * + * **WARNING:** ignore lazy filtering, all config values are loaded from database + * + * @param string $userId id of the user + * @param bool $filtered filter sensitive config values + * + * @return array [key => value] + * @since 31.0.0 + */ + public function getAllValues(string $userId, bool $filtered = false): array; + + /** + * List all apps storing a specific config key and its stored value. + * Returns an array with appId as key, stored value as value. + * + * @param string $userId id of the user + * @param string $key config key + * @param bool $lazy search within lazy loaded config + * @param ValueType|null $typedAs enforce type for the returned values + * + * @return array [appId => value] + * @since 31.0.0 + */ + public function getValuesByApps(string $userId, string $key, bool $lazy = false, ?ValueType $typedAs = null): array; + + /** + * List all users storing a specific config key and its stored value. + * Returns an array with userId as key, stored value as value. + * + * **WARNING:** no caching, generate a fresh request + * + * @param string $app id of the app + * @param string $key config key + * @param ValueType|null $typedAs enforce type for the returned values + * @param array|null $userIds limit the search to a list of user ids + * + * @return array [userId => value] + * @since 31.0.0 + */ + public function getValuesByUsers(string $app, string $key, ?ValueType $typedAs = null, ?array $userIds = null): array; + + /** + * List all users storing a specific config key/value pair. + * Returns a list of user ids. + * + * **WARNING:** no caching, generate a fresh request + * + * @param string $app id of the app + * @param string $key config key + * @param string $value config value + * @param bool $caseInsensitive non-case-sensitive search, only works if $value is a string + * + * @return Generator + * @since 31.0.0 + */ + public function searchUsersByValueString(string $app, string $key, string $value, bool $caseInsensitive = false): Generator; + + /** + * List all users storing a specific config key/value pair. + * Returns a list of user ids. + * + * **WARNING:** no caching, generate a fresh request + * + * @param string $app id of the app + * @param string $key config key + * @param int $value config value + * + * @return Generator + * @since 31.0.0 + */ + public function searchUsersByValueInt(string $app, string $key, int $value): Generator; + + /** + * List all users storing a specific config key/value pair. + * Returns a list of user ids. + * + * **WARNING:** no caching, generate a fresh request + * + * @param string $app id of the app + * @param string $key config key + * @param array $values list of possible config values + * + * @return Generator + * @since 31.0.0 + */ + public function searchUsersByValues(string $app, string $key, array $values): Generator; + + /** + * List all users storing a specific config key/value pair. + * Returns a list of user ids. + * + * **WARNING:** no caching, generate a fresh request + * + * @param string $app id of the app + * @param string $key config key + * @param bool $value config value + * + * @return Generator + * @since 31.0.0 + */ + public function searchUsersByValueBool(string $app, string $key, bool $value): Generator; + + /** + * Get user config assigned to a config key. + * If config key is not found in database, default value is returned. + * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE. + * + * @param string $userId id of the user + * @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 + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see getValueInt() + * @see getValueFloat() + * @see getValueBool() + * @see getValueArray() + */ + public function getValueString(string $userId, string $app, string $key, string $default = '', bool $lazy = false): string; + + /** + * Get config value assigned to a config key. + * If config key is not found in database, default value is returned. + * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE. + * + * @param string $userId id of the user + * @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 + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see getValueString() + * @see getValueFloat() + * @see getValueBool() + * @see getValueArray() + */ + public function getValueInt(string $userId, string $app, string $key, int $default = 0, bool $lazy = false): int; + + /** + * Get config value assigned to a config key. + * If config key is not found in database, default value is returned. + * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE. + * + * @param string $userId id of the user + * @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 + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see getValueString() + * @see getValueInt() + * @see getValueBool() + * @see getValueArray() + */ + public function getValueFloat(string $userId, string $app, string $key, float $default = 0, bool $lazy = false): float; + + /** + * Get config value assigned to a config key. + * If config key is not found in database, default value is returned. + * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE. + * + * @param string $userId id of the user + * @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 + * @since 31.0.0 + * @see IUserPrefences for explanation about lazy loading + * @see getValueString() + * @see getValueInt() + * @see getValueFloat() + * @see getValueArray() + */ + public function getValueBool(string $userId, string $app, string $key, bool $default = false, bool $lazy = false): bool; + + /** + * Get config value assigned to a config key. + * If config key is not found in database, default value is returned. + * If config key is set as lazy loaded, the $lazy argument needs to be set to TRUE. + * + * @param string $userId id of the user + * @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 + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see getValueString() + * @see getValueInt() + * @see getValueFloat() + * @see getValueBool() + */ + public function getValueArray(string $userId, string $app, string $key, array $default = [], bool $lazy = false): array; + + /** + * returns the type of config value + * + * **WARNING:** ignore lazy filtering, all config values are loaded from database + * unless lazy is set to false + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param bool|null $lazy + * + * @return ValueType type of the value + * @throws UnknownKeyException if config key is not known + * @throws IncorrectTypeException if config value type is not known + * @since 31.0.0 + */ + public function getValueType(string $userId, string $app, string $key, ?bool $lazy = null): ValueType; + + /** + * returns a bitflag related to config value + * + * **WARNING:** ignore lazy filtering, all config values are loaded from database + * unless lazy is set to false + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param bool $lazy lazy loading + * + * @return int a bitflag in relation to the config value + * @throws UnknownKeyException if config key is not known + * @throws IncorrectTypeException if config value type is not known + * @since 31.0.0 + */ + public function getValueFlags(string $userId, string $app, string $key, bool $lazy = false): int; + + /** + * Store a config key and its value in database + * + * If config key is already known with the exact same config value, the database is not updated. + * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded. + * + * If config value was previously stored as sensitive or lazy loaded, status cannot be altered without using {@see deleteKey()} first + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param string $value config value + * @param bool $sensitive if TRUE value will be hidden when listing config values. + * @param bool $lazy set config as lazy loaded + * + * @return bool TRUE if value was different, therefor updated in database + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see setValueInt() + * @see setValueFloat() + * @see setValueBool() + * @see setValueArray() + */ + public function setValueString(string $userId, string $app, string $key, string $value, bool $lazy = false, int $flags = 0): bool; + + /** + * Store a config key and its value in database + * + * When handling huge value around and/or above 2,147,483,647, a debug log will be generated + * on 64bits system, as php int type reach its limit (and throw an exception) on 32bits when using huge numbers. + * + * When using huge numbers, it is advised to use {@see \OCP\Util::numericToNumber()} and {@see setValueString()} + * + * If config key is already known with the exact same config value, the database is not updated. + * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded. + * + * If config value was previously stored as sensitive or lazy loaded, status cannot be altered without using {@see deleteKey()} first + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param int $value config value + * @param bool $sensitive if TRUE value will be hidden when listing config values. + * @param bool $lazy set config as lazy loaded + * + * @return bool TRUE if value was different, therefor updated in database + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see setValueString() + * @see setValueFloat() + * @see setValueBool() + * @see setValueArray() + */ + public function setValueInt(string $userId, string $app, string $key, int $value, bool $lazy = false, int $flags = 0): bool; + + /** + * Store a config key and its value in database. + * + * If config key is already known with the exact same config value, the database is not updated. + * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded. + * + * If config value was previously stored as sensitive or lazy loaded, status cannot be altered without using {@see deleteKey()} first + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param float $value config value + * @param bool $sensitive if TRUE value will be hidden when listing config values. + * @param bool $lazy set config as lazy loaded + * + * @return bool TRUE if value was different, therefor updated in database + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see setValueString() + * @see setValueInt() + * @see setValueBool() + * @see setValueArray() + */ + public function setValueFloat(string $userId, string $app, string $key, float $value, bool $lazy = false, int $flags = 0): bool; + + /** + * Store a config key and its value in database + * + * If config key is already known with the exact same config value, the database is not updated. + * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded. + * + * If config value was previously stored as lazy loaded, status cannot be altered without using {@see deleteKey()} first + * + * @param string $userId id of the user + * @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 + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see setValueString() + * @see setValueInt() + * @see setValueFloat() + * @see setValueArray() + */ + public function setValueBool(string $userId, string $app, string $key, bool $value, bool $lazy = false): bool; + + /** + * Store a config key and its value in database + * + * If config key is already known with the exact same config value, the database is not updated. + * If config key is not supposed to be read during the boot of the cloud, it is advised to set it as lazy loaded. + * + * If config value was previously stored as sensitive or lazy loaded, status cannot be altered without using {@see deleteKey()} first + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param array $value config value + * @param bool $sensitive if TRUE value will be hidden when listing config values. + * @param bool $lazy set config as lazy loaded + * + * @return bool TRUE if value was different, therefor updated in database + * @since 31.0.0 + * @see IUserConfig for explanation about lazy loading + * @see setValueString() + * @see setValueInt() + * @see setValueFloat() + * @see setValueBool() + */ + public function setValueArray(string $userId, string $app, string $key, array $value, bool $lazy = false, int $flags = 0): bool; + + /** + * switch sensitive status of a config value + * + * **WARNING:** ignore lazy filtering, all config values are loaded from database + * + * @param string $userId id of the user + * @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 database update were necessary + * @since 31.0.0 + */ + public function updateSensitive(string $userId, string $app, string $key, bool $sensitive): bool; + + /** + * switch sensitive loading status of a config key for all users + * + * **Warning:** heavy on resources, MUST only be used on occ command or migrations + * + * @param string $app id of the app + * @param string $key config key + * @param bool $sensitive TRUE to set as sensitive, FALSE to unset + * + * @since 31.0.0 + */ + public function updateGlobalSensitive(string $app, string $key, bool $sensitive): void; + + + /** + * switch indexed status of a config value + * + * **WARNING:** ignore lazy filtering, all config values are loaded from database + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * @param bool $indexed TRUE to set as indexed, FALSE to unset + * + * @return bool TRUE if database update were necessary + * @since 31.0.0 + */ + public function updateIndexed(string $userId, string $app, string $key, bool $indexed): bool; + + /** + * switch sensitive loading status of a config key for all users + * + * **Warning:** heavy on resources, MUST only be used on occ command or migrations + * + * @param string $app id of the app + * @param string $key config key + * @param bool $indexed TRUE to set as indexed, FALSE to unset + * @since 31.0.0 + */ + public function updateGlobalIndexed(string $app, string $key, bool $indexed): void; + + /** + * switch lazy loading status of a config value + * + * @param string $userId id of the user + * @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 database update was necessary + * @since 31.0.0 + */ + public function updateLazy(string $userId, string $app, string $key, bool $lazy): bool; + + /** + * switch lazy loading status of a config key for all users + * + * **Warning:** heavy on resources, MUST only be used on occ command or migrations + * + * @param string $app id of the app + * @param string $key config key + * @param bool $lazy TRUE to set as lazy loaded, FALSE to unset + * @since 31.0.0 + */ + public function updateGlobalLazy(string $app, string $key, bool $lazy): void; + + /** + * returns an array contains details about a config value + * + * ``` + * [ + * "app" => "myapp", + * "key" => "mykey", + * "value" => "its_value", + * "lazy" => false, + * "type" => 4, + * "typeString" => "string", + * 'sensitive' => true + * ] + * ``` + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * + * @return array + * @throws UnknownKeyException if config key is not known in database + * @since 31.0.0 + */ + public function getDetails(string $userId, string $app, string $key): array; + + /** + * Delete single config key from database. + * + * @param string $userId id of the user + * @param string $app id of the app + * @param string $key config key + * + * @since 31.0.0 + */ + public function deleteUserConfig(string $userId, string $app, string $key): void; + + /** + * Delete config values from all users linked to a specific config keys + * + * @param string $app id of the app + * @param string $key config key + * + * @since 31.0.0 + */ + public function deleteKey(string $app, string $key): void; + + /** + * delete all config keys linked to an app + * + * @param string $app id of the app + * @since 31.0.0 + */ + public function deleteApp(string $app): void; + + /** + * delete all config keys linked to a user + * + * @param string $userId id of the user + * @since 31.0.0 + */ + public function deleteAllUserConfig(string $userId): void; + + /** + * Clear the cache for a single user + * + * The cache will be rebuilt only the next time a user config is requested. + * + * @param string $userId id of the user + * @param bool $reload set to TRUE to refill cache instantly after clearing it + * + * @since 31.0.0 + */ + public function clearCache(string $userId, bool $reload = false): void; + + /** + * Clear the cache for all users. + * The cache will be rebuilt only the next time a user config is requested. + * + * @since 31.0.0 + */ + public function clearCacheAll(): void; +} diff --git a/lib/unstable/Config/ValueType.php b/lib/unstable/Config/ValueType.php new file mode 100644 index 0000000000000..3e1e47e9d7c4f --- /dev/null +++ b/lib/unstable/Config/ValueType.php @@ -0,0 +1,79 @@ + self::MIXED, + 'string' => self::STRING, + 'int' => self::INT, + 'float' => self::FLOAT, + 'bool' => self::BOOL, + 'array' => self::ARRAY + }; + } catch (\UnhandledMatchError) { + throw new IncorrectTypeException('unknown string definition'); + } + } + + /** + * get string definition for current enum value + * + * @return string + * @throws IncorrectTypeException + * @since 31.0.0 + */ + public function getDefinition(): string { + try { + return match ($this) { + self::MIXED => 'mixed', + self::STRING => 'string', + self::INT => 'int', + self::FLOAT => 'float', + self::BOOL => 'bool', + self::ARRAY => 'array', + }; + } catch (UnhandledMatchError) { + throw new IncorrectTypeException('unknown type definition ' . $this->value); + } + } +} diff --git a/tests/lib/AllConfigTest.php b/tests/lib/AllConfigTest.php index 5d2091780a091..e892e441ecf07 100644 --- a/tests/lib/AllConfigTest.php +++ b/tests/lib/AllConfigTest.php @@ -317,8 +317,8 @@ public function testGetUserKeysAllInts(): void { // preparation - add something to the database $data = [ - ['userFetch', 'appFetch1', '123', 'value'], - ['userFetch', 'appFetch1', '456', 'value'], + ['userFetch8', 'appFetch1', '123', 'value'], + ['userFetch8', 'appFetch1', '456', 'value'], ]; foreach ($data as $entry) { $this->connection->executeUpdate( @@ -328,7 +328,7 @@ public function testGetUserKeysAllInts(): void { ); } - $value = $config->getUserKeys('userFetch', 'appFetch1'); + $value = $config->getUserKeys('userFetch8', 'appFetch1'); $this->assertEquals(['123', '456'], $value); $this->assertIsString($value[0]); $this->assertIsString($value[1]); diff --git a/tests/lib/Config/UserConfigTest.php b/tests/lib/Config/UserConfigTest.php new file mode 100644 index 0000000000000..a79e1e59a7920 --- /dev/null +++ b/tests/lib/Config/UserConfigTest.php @@ -0,0 +1,1836 @@ +>> [userId => [appId => prefKey, prefValue, valueType, lazy, sensitive]]] + */ + private array $basePreferences = + [ + 'user1' => + [ + 'app1' => [ + 'key1' => ['key1', 'value1'], + 'key22' => ['key22', '31'], + 'fast_string' => ['fast_string', 'f_value', ValueType::STRING], + 'lazy_string' => ['lazy_string', 'l_value', ValueType::STRING, true], + 'fast_string_sensitive' => [ + 'fast_string_sensitive', 'fs_value', ValueType::STRING, false, UserConfig::FLAG_SENSITIVE + ], + 'lazy_string_sensitive' => [ + 'lazy_string_sensitive', 'ls_value', ValueType::STRING, true, UserConfig::FLAG_SENSITIVE + ], + 'fast_int' => ['fast_int', 11, ValueType::INT], + 'lazy_int' => ['lazy_int', 12, ValueType::INT, true], + 'fast_int_sensitive' => ['fast_int_sensitive', 2024, ValueType::INT, false, UserConfig::FLAG_SENSITIVE], + 'lazy_int_sensitive' => ['lazy_int_sensitive', 2048, ValueType::INT, true, UserConfig::FLAG_SENSITIVE], + 'fast_float' => ['fast_float', 3.14, ValueType::FLOAT], + 'lazy_float' => ['lazy_float', 3.14159, ValueType::FLOAT, true], + 'fast_float_sensitive' => [ + 'fast_float_sensitive', 1.41, ValueType::FLOAT, false, UserConfig::FLAG_SENSITIVE + ], + 'lazy_float_sensitive' => [ + 'lazy_float_sensitive', 1.4142, ValueType::FLOAT, true, UserConfig::FLAG_SENSITIVE + ], + 'fast_array' => ['fast_array', ['year' => 2024], ValueType::ARRAY], + 'lazy_array' => ['lazy_array', ['month' => 'October'], ValueType::ARRAY, true], + 'fast_array_sensitive' => [ + 'fast_array_sensitive', ['password' => 'pwd'], ValueType::ARRAY, false, UserConfig::FLAG_SENSITIVE + ], + 'lazy_array_sensitive' => [ + 'lazy_array_sensitive', ['password' => 'qwerty'], ValueType::ARRAY, true, UserConfig::FLAG_SENSITIVE + ], + 'fast_boolean' => ['fast_boolean', true, ValueType::BOOL], + 'fast_boolean_0' => ['fast_boolean_0', false, ValueType::BOOL], + 'lazy_boolean' => ['lazy_boolean', true, ValueType::BOOL, true], + 'lazy_boolean_0' => ['lazy_boolean_0', false, ValueType::BOOL, true], + ], + 'app2' => [ + 'key2' => ['key2', 'value2a', ValueType::STRING, false, 0, true], + 'key3' => ['key3', 'value3', ValueType::STRING, true], + 'key4' => ['key4', 'value4', ValueType::STRING, false, UserConfig::FLAG_SENSITIVE], + 'key8' => ['key8', 11, ValueType::INT, false, 0, true], + 'key9' => ['key9', 'value9a', ValueType::STRING], + ], + 'app3' => [ + 'key1' => ['key1', 'value123'], + 'key3' => ['key3', 'value3'], + 'key8' => ['key8', 12, ValueType::INT, false, UserConfig::FLAG_SENSITIVE, true], + 'key9' => ['key9', 'value9b', ValueType::STRING, false, UserConfig::FLAG_SENSITIVE], + 'key10' => ['key10', true, ValueType::BOOL, false, 0, true], + ], + 'only-lazy' => [ + 'key1' => ['key1', 'value456', ValueType::STRING, true, 0, true], + 'key2' => ['key2', 'value2c', ValueType::STRING, true, UserConfig::FLAG_SENSITIVE], + 'key3' => ['key3', 42, ValueType::INT, true], + 'key4' => ['key4', 17.42, ValueType::FLOAT, true], + 'key5' => ['key5', true, ValueType::BOOL, true], + ] + ], + 'user2' => + [ + 'app1' => [ + '1' => ['1', 'value1'], + '2' => ['2', 'value2', ValueType::STRING, true, UserConfig::FLAG_SENSITIVE], + '3' => ['3', 17, ValueType::INT, true], + '4' => ['4', 42, ValueType::INT, false, UserConfig::FLAG_SENSITIVE], + '5' => ['5', 17.42, ValueType::FLOAT, false], + '6' => ['6', true, ValueType::BOOL, false], + ], + 'app2' => [ + 'key2' => ['key2', 'value2b', ValueType::STRING, false, 0, true], + 'key3' => ['key3', 'value3', ValueType::STRING, true], + 'key4' => ['key4', 'value4', ValueType::STRING, false, UserConfig::FLAG_SENSITIVE], + 'key8' => ['key8', 12, ValueType::INT, false, 0, true], + ], + 'app3' => [ + 'key10' => ['key10', false, ValueType::BOOL, false, 0, true], + ], + 'only-lazy' => [ + 'key1' => ['key1', 'value1', ValueType::STRING, true, 0, true] + ] + ], + 'user3' => + [ + 'app2' => [ + 'key2' => ['key2', 'value2c', ValueType::MIXED, false, 0, true], + 'key3' => ['key3', 'value3', ValueType::STRING, true, ], + 'key4' => ['key4', 'value4', ValueType::STRING, false, UserConfig::FLAG_SENSITIVE], + 'fast_string_sensitive' => [ + 'fast_string_sensitive', 'fs_value', ValueType::STRING, false, UserConfig::FLAG_SENSITIVE + ], + 'lazy_string_sensitive' => [ + 'lazy_string_sensitive', 'ls_value', ValueType::STRING, true, UserConfig::FLAG_SENSITIVE + ], + ], + 'only-lazy' => [ + 'key3' => ['key3', 'value3', ValueType::STRING, true] + ] + ], + 'user4' => + [ + 'app2' => [ + 'key1' => ['key1', 'value1'], + 'key2' => ['key2', 'value2A', ValueType::MIXED, false, 0, true], + 'key3' => ['key3', 'value3', ValueType::STRING, true,], + 'key4' => ['key4', 'value4', ValueType::STRING, false, UserConfig::FLAG_SENSITIVE], + ], + 'app3' => [ + 'key10' => ['key10', true, ValueType::BOOL, false, 0, true], + ], + 'only-lazy' => [ + 'key1' => ['key1', 123, ValueType::INT, true, 0, true] + ] + ], + 'user5' => + [ + 'app1' => [ + 'key1' => ['key1', 'value1'] + ], + 'app2' => [ + 'key8' => ['key8', 12, ValueType::INT, false, 0, true] + ], + 'only-lazy' => [ + 'key1' => ['key1', 'value1', ValueType::STRING, true, 0, true] + ] + ], + + ]; + + protected function setUp(): void { + parent::setUp(); + + $this->connection = \OCP\Server::get(IDBConnection::class); + $this->logger = \OCP\Server::get(LoggerInterface::class); + $this->crypto = \OCP\Server::get(ICrypto::class); + + // storing current preferences and emptying the data table + $sql = $this->connection->getQueryBuilder(); + $sql->select('*') + ->from('preferences'); + $result = $sql->executeQuery(); + $this->originalPreferences = $result->fetchAll(); + $result->closeCursor(); + + $sql = $this->connection->getQueryBuilder(); + $sql->delete('preferences'); + $sql->executeStatement(); + + $sql = $this->connection->getQueryBuilder(); + $sql->insert('preferences') + ->values( + [ + 'userid' => $sql->createParameter('userid'), + 'appid' => $sql->createParameter('appid'), + 'configkey' => $sql->createParameter('configkey'), + 'configvalue' => $sql->createParameter('configvalue'), + 'type' => $sql->createParameter('type'), + 'lazy' => $sql->createParameter('lazy'), + 'flags' => $sql->createParameter('flags'), + 'indexed' => $sql->createParameter('indexed') + ] + ); + + foreach ($this->basePreferences as $userId => $userData) { + foreach ($userData as $appId => $appData) { + foreach ($appData as $key => $row) { + $value = $row[1]; + $type = ($row[2] ?? ValueType::MIXED)->value; + + if ($type === ValueType::ARRAY->value) { + $value = json_encode($value); + } + + if ($type === ValueType::BOOL->value && $value === false) { + $value = '0'; + } + + $flags = $row[4] ?? 0; + if ((UserConfig::FLAG_SENSITIVE & $flags) !== 0) { + $value = self::invokePrivate(UserConfig::class, 'ENCRYPTION_PREFIX') + . $this->crypto->encrypt((string)$value); + } else { + $indexed = (($row[5] ?? false) === true) ? $value : ''; + } + + $sql->setParameters( + [ + 'userid' => $userId, + 'appid' => $appId, + 'configkey' => $row[0], + 'configvalue' => $value, + 'type' => $type, + 'lazy' => (($row[3] ?? false) === true) ? 1 : 0, + 'flags' => $flags, + 'indexed' => $indexed ?? '' + ] + )->executeStatement(); + } + } + } + } + + protected function tearDown(): void { + $sql = $this->connection->getQueryBuilder(); + $sql->delete('preferences'); + $sql->executeStatement(); + + $sql = $this->connection->getQueryBuilder(); + $sql->insert('preferences') + ->values( + [ + 'userid' => $sql->createParameter('userid'), + 'appid' => $sql->createParameter('appid'), + 'configkey' => $sql->createParameter('configkey'), + 'configvalue' => $sql->createParameter('configvalue'), + 'lazy' => $sql->createParameter('lazy'), + 'type' => $sql->createParameter('type'), + ] + ); + + foreach ($this->originalPreferences as $key => $configs) { + $sql->setParameter('userid', $configs['userid']) + ->setParameter('appid', $configs['appid']) + ->setParameter('configkey', $configs['configkey']) + ->setParameter('configvalue', $configs['configvalue']) + ->setParameter('lazy', ($configs['lazy'] === '1') ? '1' : '0') + ->setParameter('type', $configs['type']); + $sql->executeStatement(); + } + + parent::tearDown(); + } + + /** + * @param array $preLoading preload the 'fast' cache for a list of users) + * + * @return IUserConfig + */ + private function generateUserConfig(array $preLoading = []): IUserConfig { + $userConfig = new \OC\Config\UserConfig( + $this->connection, + $this->logger, + $this->crypto, + ); + $msg = ' generateUserConfig() failed to confirm cache status'; + + // confirm cache status + $status = $userConfig->statusCache(); + $this->assertSame([], $status['fastLoaded'], $msg); + $this->assertSame([], $status['lazyLoaded'], $msg); + $this->assertSame([], $status['fastCache'], $msg); + $this->assertSame([], $status['lazyCache'], $msg); + foreach ($preLoading as $preLoadUser) { + // simple way to initiate the load of non-lazy preferences values in cache + $userConfig->getValueString($preLoadUser, 'core', 'preload'); + + // confirm cache status + $status = $userConfig->statusCache(); + $this->assertSame(true, $status['fastLoaded'][$preLoadUser], $msg); + $this->assertSame(false, $status['lazyLoaded'][$preLoadUser], $msg); + + $apps = array_values(array_diff(array_keys($this->basePreferences[$preLoadUser]), ['only-lazy'])); + $this->assertEqualsCanonicalizing($apps, array_keys($status['fastCache'][$preLoadUser]), $msg); + $this->assertSame([], array_keys($status['lazyCache'][$preLoadUser]), $msg); + } + + return $userConfig; + } + + public function testGetUserIdsEmpty(): void { + $userConfig = $this->generateUserConfig(); + $this->assertEqualsCanonicalizing(array_keys($this->basePreferences), $userConfig->getUserIds()); + } + + public function testGetUserIds(): void { + $userConfig = $this->generateUserConfig(); + $this->assertEqualsCanonicalizing(['user1', 'user2', 'user5'], $userConfig->getUserIds('app1')); + } + + public function testGetApps(): void { + $userConfig = $this->generateUserConfig(); + $this->assertEqualsCanonicalizing( + array_keys($this->basePreferences['user1']), $userConfig->getApps('user1') + ); + } + + public function testGetKeys(): void { + $userConfig = $this->generateUserConfig(['user1']); + $this->assertEqualsCanonicalizing( + array_keys($this->basePreferences['user1']['app1']), $userConfig->getKeys('user1', 'app1') + ); + } + + /** + * @return array[] + */ + public function providerHasKey(): array { + return [ + ['user1', 'app1', 'key1', false, true], + ['user0', 'app1', 'key1', false, false], + ['user1', 'app1', 'key1', true, false], + ['user1', 'app1', 'key0', false, false], + ['user1', 'app1', 'key0', true, false], + ['user1', 'app1', 'fast_string_sensitive', false, true], + ['user1', 'app1', 'lazy_string_sensitive', true, true], + ['user2', 'only-lazy', 'key1', false, false], + ['user2', 'only-lazy', 'key1', true, true], + ]; + } + + /** + * @dataProvider providerHasKey + */ + public function testHasKey(string $userId, string $appId, string $key, ?bool $lazy, bool $result): void { + $userConfig = $this->generateUserConfig(); + $this->assertEquals($result, $userConfig->hasKey($userId, $appId, $key, $lazy)); + } + + /** + * @return array[] + */ + public function providerIsSensitive(): array { + return [ + ['user1', 'app1', 'key1', false, false, false], + ['user0', 'app1', 'key1', false, false, true], + ['user1', 'app1', 'key1', true, false, true], + ['user1', 'app1', 'key1', null, false, false], + ['user1', 'app1', 'key0', false, false, true], + ['user1', 'app1', 'key0', true, false, true], + ['user1', 'app1', 'fast_string_sensitive', false, true, false], + ['user1', 'app1', 'lazy_string_sensitive', true, true, false], + ['user1', 'app1', 'fast_string_sensitive', true, true, true], + ['user1', 'app1', 'lazy_string_sensitive', false, true, true], + ['user1', 'app1', 'lazy_string_sensitive', null, true, false], + ['user2', 'only-lazy', 'key1', false, false, true], + ['user2', 'only-lazy', 'key1', true, false, false], + ['user2', 'only-lazy', 'key1', null, false, false], + ]; + } + + /** + * @dataProvider providerIsSensitive + */ + public function testIsSensitive( + string $userId, + string $appId, + string $key, + ?bool $lazy, + bool $result, + bool $exception, + ): void { + $userConfig = $this->generateUserConfig(); + if ($exception) { + $this->expectException(UnknownKeyException::class); + } + + $this->assertEquals($result, $userConfig->isSensitive($userId, $appId, $key, $lazy)); + } + + /** + * @return array[] + */ + public function providerIsLazy(): array { + return [ + ['user1', 'app1', 'key1', false, false], + ['user0', 'app1', 'key1', false, true], + ['user1', 'app1', 'key0', false, true], + ['user1', 'app1', 'key0', false, true], + ['user1', 'app1', 'fast_string_sensitive', false, false], + ['user1', 'app1', 'lazy_string_sensitive', true, false], + ['user2', 'only-lazy', 'key1', true, false], + ]; + } + + /** + * @dataProvider providerIsLazy + */ + public function testIsLazy( + string $userId, + string $appId, + string $key, + bool $result, + bool $exception, + ): void { + $userConfig = $this->generateUserConfig(); + if ($exception) { + $this->expectException(UnknownKeyException::class); + } + + $this->assertEquals($result, $userConfig->isLazy($userId, $appId, $key)); + } + + public function providerGetValues(): array { + return [ + [ + 'user1', 'app1', '', true, + [ + 'fast_array' => ['year' => 2024], + 'fast_array_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'fast_boolean' => true, + 'fast_boolean_0' => false, + 'fast_float' => 3.14, + 'fast_float_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'fast_int' => 11, + 'fast_int_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'fast_string' => 'f_value', + 'fast_string_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'key1' => 'value1', + 'key22' => '31', + 'lazy_array' => ['month' => 'October'], + 'lazy_array_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'lazy_boolean' => true, + 'lazy_boolean_0' => false, + 'lazy_float' => 3.14159, + 'lazy_float_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'lazy_int' => 12, + 'lazy_int_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'lazy_string' => 'l_value', + 'lazy_string_sensitive' => '***REMOVED SENSITIVE VALUE***', + ] + ], + [ + 'user1', 'app1', '', false, + [ + 'fast_array' => ['year' => 2024], + 'fast_array_sensitive' => ['password' => 'pwd'], + 'fast_boolean' => true, + 'fast_boolean_0' => false, + 'fast_float' => 3.14, + 'fast_float_sensitive' => 1.41, + 'fast_int' => 11, + 'fast_int_sensitive' => 2024, + 'fast_string' => 'f_value', + 'fast_string_sensitive' => 'fs_value', + 'key1' => 'value1', + 'key22' => '31', + 'lazy_array' => ['month' => 'October'], + 'lazy_array_sensitive' => ['password' => 'qwerty'], + 'lazy_boolean' => true, + 'lazy_boolean_0' => false, + 'lazy_float' => 3.14159, + 'lazy_float_sensitive' => 1.4142, + 'lazy_int' => 12, + 'lazy_int_sensitive' => 2048, + 'lazy_string' => 'l_value', + 'lazy_string_sensitive' => 'ls_value' + ] + ], + [ + 'user1', 'app1', 'fast_', true, + [ + 'fast_array' => ['year' => 2024], + 'fast_array_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'fast_boolean' => true, + 'fast_boolean_0' => false, + 'fast_float' => 3.14, + 'fast_float_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'fast_int' => 11, + 'fast_int_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'fast_string' => 'f_value', + 'fast_string_sensitive' => '***REMOVED SENSITIVE VALUE***', + ] + ], + [ + 'user1', 'app1', 'fast_', false, + [ + 'fast_array' => ['year' => 2024], + 'fast_array_sensitive' => ['password' => 'pwd'], + 'fast_boolean' => true, + 'fast_boolean_0' => false, + 'fast_float' => 3.14, + 'fast_float_sensitive' => 1.41, + 'fast_int' => 11, + 'fast_int_sensitive' => 2024, + 'fast_string' => 'f_value', + 'fast_string_sensitive' => 'fs_value', + ] + ], + [ + 'user1', 'app1', 'key1', true, + [ + 'key1' => 'value1', + ] + ], + [ + 'user2', 'app1', '', false, + [ + '1' => 'value1', + '4' => 42, + '5' => 17.42, + '6' => true, + '2' => 'value2', + '3' => 17, + ] + ], + [ + 'user2', 'app1', '', true, + [ + '1' => 'value1', + '4' => '***REMOVED SENSITIVE VALUE***', + '5' => 17.42, + '6' => true, + '2' => '***REMOVED SENSITIVE VALUE***', + '3' => 17, + ] + ], + ]; + } + + /** + * @dataProvider providerGetValues + */ + public function testGetValues( + string $userId, + string $appId, + string $prefix, + bool $filtered, + array $result, + ): void { + $userConfig = $this->generateUserConfig(); + $this->assertJsonStringEqualsJsonString( + json_encode($result), json_encode($userConfig->getValues($userId, $appId, $prefix, $filtered)) + ); + } + + public function providerGetAllValues(): array { + return [ + [ + 'user2', false, + [ + 'app1' => [ + '1' => 'value1', + '4' => 42, + '5' => 17.42, + '6' => true, + '2' => 'value2', + '3' => 17, + ], + 'app2' => [ + 'key2' => 'value2b', + 'key3' => 'value3', + 'key4' => 'value4', + 'key8' => 12, + ], + 'app3' => [ + 'key10' => false, + ], + 'only-lazy' => [ + 'key1' => 'value1', + ] + ], + ], + [ + 'user2', true, + [ + 'app1' => [ + '1' => 'value1', + '4' => '***REMOVED SENSITIVE VALUE***', + '5' => 17.42, + '6' => true, + '2' => '***REMOVED SENSITIVE VALUE***', + '3' => 17, + ], + 'app2' => [ + 'key2' => 'value2b', + 'key3' => 'value3', + 'key4' => '***REMOVED SENSITIVE VALUE***', + 'key8' => 12, + ], + 'app3' => [ + 'key10' => false, + ], + 'only-lazy' => [ + 'key1' => 'value1', + ] + ], + ], + [ + 'user3', true, + [ + 'app2' => [ + 'key2' => 'value2c', + 'key3' => 'value3', + 'key4' => '***REMOVED SENSITIVE VALUE***', + 'fast_string_sensitive' => '***REMOVED SENSITIVE VALUE***', + 'lazy_string_sensitive' => '***REMOVED SENSITIVE VALUE***', + ], + 'only-lazy' => [ + 'key3' => 'value3', + ] + ], + ], + [ + 'user3', false, + [ + 'app2' => [ + 'key2' => 'value2c', + 'key3' => 'value3', + 'key4' => 'value4', + 'fast_string_sensitive' => 'fs_value', + 'lazy_string_sensitive' => 'ls_value', + ], + 'only-lazy' => [ + 'key3' => 'value3', + ] + ], + ], + ]; + } + + /** + * @dataProvider providerGetAllValues + */ + public function testGetAllValues( + string $userId, + bool $filtered, + array $result, + ): void { + $userConfig = $this->generateUserConfig(); + $this->assertEqualsCanonicalizing($result, $userConfig->getAllValues($userId, $filtered)); + } + + public function providerSearchValuesByApps(): array { + return [ + [ + 'user1', 'key1', false, null, + [ + 'app1' => 'value1', + 'app3' => 'value123' + ] + ], + [ + 'user1', 'key1', true, null, + [ + 'only-lazy' => 'value456' + ] + ], + [ + 'user1', 'key8', false, null, + [ + 'app2' => 11, + 'app3' => 12, + ] + ], + [ + 'user1', 'key9', false, ValueType::INT, + [ + 'app2' => 0, + 'app3' => 0, + ] + ] + ]; + } + + /** + * @dataProvider providerSearchValuesByApps + */ + public function testSearchValuesByApps( + string $userId, + string $key, + bool $lazy, + ?ValueType $typedAs, + array $result, + ): void { + $userConfig = $this->generateUserConfig(); + $this->assertEquals($result, $userConfig->getValuesByApps($userId, $key, $lazy, $typedAs)); + } + + public function providerSearchValuesByUsers(): array { + return [ + [ + 'app2', 'key2', null, null, + [ + 'user1' => 'value2a', + 'user2' => 'value2b', + 'user3' => 'value2c', + 'user4' => 'value2A' + ] + ], + [ + 'app2', 'key2', null, ['user1', 'user3'], + [ + 'user1' => 'value2a', + 'user3' => 'value2c', + ] + ], + [ + 'app2', 'key2', ValueType::INT, ['user1', 'user3'], + [ + 'user1' => 0, + 'user3' => 0, + ] + ], + [ + 'app2', 'key8', ValueType::INT, null, + [ + 'user1' => 11, + 'user2' => 12, + 'user5' => 12, + ] + ], + ]; + } + + /** + * @dataProvider providerSearchValuesByUsers + */ + public function testSearchValuesByUsers( + string $app, + string $key, + ?ValueType $typedAs = null, + ?array $userIds = null, + array $result, + ): void { + $userConfig = $this->generateUserConfig(); + $this->assertEqualsCanonicalizing( + $result, $userConfig->getValuesByUsers($app, $key, $typedAs, $userIds) + ); + } + + public function providerSearchValuesByValueString(): array { + return [ + ['app2', 'key2', 'value2a', false, ['user1']], + ['app2', 'key2', 'value2A', false, ['user4']], + ['app2', 'key2', 'value2A', true, ['user1', 'user4']] + ]; + } + + /** + * @dataProvider providerSearchValuesByValueString + */ + public function testSearchUsersByValueString( + string $app, + string $key, + string|array $value, + bool $ci, + array $result, + ): void { + $userConfig = $this->generateUserConfig(); + $this->assertEqualsCanonicalizing($result, iterator_to_array($userConfig->searchUsersByValueString($app, $key, $value, $ci))); + } + + public function providerSearchValuesByValueInt(): array { + return [ + ['app3', 'key8', 12, []], // sensitive value, cannot search + ['app2', 'key8', 12, ['user2', 'user5']], // sensitive value, cannot search + ['only-lazy', 'key1', 123, ['user4']], + ]; + } + + /** + * @dataProvider providerSearchValuesByValueInt + */ + public function testSearchUsersByValueInt( + string $app, + string $key, + int $value, + array $result, + ): void { + $userConfig = $this->generateUserConfig(); + $this->assertEqualsCanonicalizing($result, iterator_to_array($userConfig->searchUsersByValueInt($app, $key, $value))); + } + + public function providerSearchValuesByValues(): array { + return [ + ['app2', 'key2', ['value2a', 'value2b'], ['user1', 'user2']], + ['app2', 'key2', ['value2a', 'value2c'], ['user1', 'user3']], + ]; + } + + /** + * @dataProvider providerSearchValuesByValues + */ + public function testSearchUsersByValues( + string $app, + string $key, + array $values, + array $result, + ): void { + $userConfig = $this->generateUserConfig(); + $this->assertEqualsCanonicalizing($result, iterator_to_array($userConfig->searchUsersByValues($app, $key, $values))); + } + + public function providerSearchValuesByValueBool(): array { + return [ + ['app3', 'key10', true, ['user1', 'user4']], + ['app3', 'key10', false, ['user2']], + ]; + } + + /** + * @dataProvider providerSearchValuesByValueBool + */ + public function testSearchUsersByValueBool( + string $app, + string $key, + bool $value, + array $result, + ): void { + $userConfig = $this->generateUserConfig(); + $this->assertEqualsCanonicalizing($result, iterator_to_array($userConfig->searchUsersByValueBool($app, $key, $value))); + } + + public function providerGetValueMixed(): array { + return [ + [ + ['user1'], 'user1', 'app1', 'key0', 'default_because_unknown_key', true, + 'default_because_unknown_key' + ], + [ + null, 'user1', 'app1', 'key0', 'default_because_unknown_key', true, + 'default_because_unknown_key' + ], + [ + ['user1'], 'user1', 'app1', 'key0', 'default_because_unknown_key', false, + 'default_because_unknown_key' + ], + [ + null, 'user1', 'app1', 'key0', 'default_because_unknown_key', false, + 'default_because_unknown_key' + ], + [['user1'], 'user1', 'app1', 'fast_string', 'default_because_unknown_key', false, 'f_value'], + [null, 'user1', 'app1', 'fast_string', 'default_because_unknown_key', false, 'f_value'], + [['user1'], 'user1', 'app1', 'fast_string', 'default_because_unknown_key', true, 'f_value'], + // because non-lazy are already loaded + [ + null, 'user1', 'app1', 'fast_string', 'default_because_unknown_key', true, + 'default_because_unknown_key' + ], + [ + ['user1'], 'user1', 'app1', 'lazy_string', 'default_because_unknown_key', false, + 'default_because_unknown_key' + ], + [ + null, 'user1', 'app1', 'lazy_string', 'default_because_unknown_key', false, + 'default_because_unknown_key' + ], + [['user1'], 'user1', 'app1', 'lazy_string', 'default_because_unknown_key', true, 'l_value'], + [null, 'user1', 'app1', 'lazy_string', 'default_because_unknown_key', true, 'l_value'], + [ + ['user1'], 'user1', 'app1', 'fast_string_sensitive', 'default_because_unknown_key', false, + 'fs_value' + ], + [ + null, 'user1', 'app1', 'fast_string_sensitive', 'default_because_unknown_key', false, + 'fs_value' + ], + [ + ['user1'], 'user1', 'app1', 'fast_string_sensitive', 'default_because_unknown_key', true, + 'fs_value' + ], + [ + null, 'user1', 'app1', 'fast_string_sensitive', 'default_because_unknown_key', true, + 'default_because_unknown_key' + ], + [ + ['user1'], 'user1', 'app1', 'lazy_string_sensitive', 'default_because_unknown_key', false, + 'default_because_unknown_key' + ], + [ + null, 'user1', 'app1', 'lazy_string_sensitive', 'default_because_unknown_key', false, + 'default_because_unknown_key' + ], + [ + ['user1'], 'user1', 'app1', 'lazy_string_sensitive', 'default_because_unknown_key', true, + 'ls_value' + ], + [null, 'user1', 'app1', 'lazy_string_sensitive', 'default_because_unknown_key', true, 'ls_value'], + ]; + } + + /** + * @dataProvider providerGetValueMixed + */ + public function testGetValueMixed( + ?array $preload, + string $userId, + string $app, + string $key, + string $default, + bool $lazy, + string $result, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals($result, $userConfig->getValueMixed($userId, $app, $key, $default, $lazy)); + } + + /** + * @dataProvider providerGetValueMixed + */ + public function testGetValueString( + ?array $preload, + string $userId, + string $app, + string $key, + string $default, + bool $lazy, + string $result, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals($result, $userConfig->getValueString($userId, $app, $key, $default, $lazy)); + } + + public function providerGetValueInt(): array { + return [ + [['user1'], 'user1', 'app1', 'key0', 54321, true, 54321], + [null, 'user1', 'app1', 'key0', 54321, true, 54321], + [['user1'], 'user1', 'app1', 'key0', 54321, false, 54321], + [null, 'user1', 'app1', 'key0', 54321, false, 54321], + [null, 'user1', 'app1', 'key22', 54321, false, 31], + [['user1'], 'user1', 'app1', 'fast_int', 54321, false, 11], + [null, 'user1', 'app1', 'fast_int', 54321, false, 11], + [['user1'], 'user1', 'app1', 'fast_int', 54321, true, 11], + [null, 'user1', 'app1', 'fast_int', 54321, true, 54321], + [['user1'], 'user1', 'app1', 'fast_int_sensitive', 54321, false, 2024], + [null, 'user1', 'app1', 'fast_int_sensitive', 54321, false, 2024], + [['user1'], 'user1', 'app1', 'fast_int_sensitive', 54321, true, 2024], + [null, 'user1', 'app1', 'fast_int_sensitive', 54321, true, 54321], + [['user1'], 'user1', 'app1', 'lazy_int', 54321, false, 54321], + [null, 'user1', 'app1', 'lazy_int', 54321, false, 54321], + [['user1'], 'user1', 'app1', 'lazy_int', 54321, true, 12], + [null, 'user1', 'app1', 'lazy_int', 54321, true, 12], + [['user1'], 'user1', 'app1', 'lazy_int_sensitive', 54321, false, 54321], + [null, 'user1', 'app1', 'lazy_int_sensitive', 54321, false, 54321], + [['user1'], 'user1', 'app1', 'lazy_int_sensitive', 54321, true, 2048], + [null, 'user1', 'app1', 'lazy_int_sensitive', 54321, true, 2048], + ]; + } + + /** + * @dataProvider providerGetValueInt + */ + public function testGetValueInt( + ?array $preload, + string $userId, + string $app, + string $key, + int $default, + bool $lazy, + int $result, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals($result, $userConfig->getValueInt($userId, $app, $key, $default, $lazy)); + } + + public function providerGetValueFloat(): array { + return [ + [['user1'], 'user1', 'app1', 'key0', 54.321, true, 54.321], + [null, 'user1', 'app1', 'key0', 54.321, true, 54.321], + [['user1'], 'user1', 'app1', 'key0', 54.321, false, 54.321], + [null, 'user1', 'app1', 'key0', 54.321, false, 54.321], + [['user1'], 'user1', 'app1', 'fast_float', 54.321, false, 3.14], + [null, 'user1', 'app1', 'fast_float', 54.321, false, 3.14], + [['user1'], 'user1', 'app1', 'fast_float', 54.321, true, 3.14], + [null, 'user1', 'app1', 'fast_float', 54.321, true, 54.321], + [['user1'], 'user1', 'app1', 'fast_float_sensitive', 54.321, false, 1.41], + [null, 'user1', 'app1', 'fast_float_sensitive', 54.321, false, 1.41], + [['user1'], 'user1', 'app1', 'fast_float_sensitive', 54.321, true, 1.41], + [null, 'user1', 'app1', 'fast_float_sensitive', 54.321, true, 54.321], + [['user1'], 'user1', 'app1', 'lazy_float', 54.321, false, 54.321], + [null, 'user1', 'app1', 'lazy_float', 54.321, false, 54.321], + [['user1'], 'user1', 'app1', 'lazy_float', 54.321, true, 3.14159], + [null, 'user1', 'app1', 'lazy_float', 54.321, true, 3.14159], + [['user1'], 'user1', 'app1', 'lazy_float_sensitive', 54.321, false, 54.321], + [null, 'user1', 'app1', 'lazy_float_sensitive', 54.321, false, 54.321], + [['user1'], 'user1', 'app1', 'lazy_float_sensitive', 54.321, true, 1.4142], + [null, 'user1', 'app1', 'lazy_float_sensitive', 54.321, true, 1.4142], + ]; + } + + /** + * @dataProvider providerGetValueFloat + */ + public function testGetValueFloat( + ?array $preload, + string $userId, + string $app, + string $key, + float $default, + bool $lazy, + float $result, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals($result, $userConfig->getValueFloat($userId, $app, $key, $default, $lazy)); + } + + public function providerGetValueBool(): array { + return [ + [['user1'], 'user1', 'app1', 'key0', false, true, false], + [null, 'user1', 'app1', 'key0', false, true, false], + [['user1'], 'user1', 'app1', 'key0', true, true, true], + [null, 'user1', 'app1', 'key0', true, true, true], + [['user1'], 'user1', 'app1', 'key0', false, false, false], + [null, 'user1', 'app1', 'key0', false, false, false], + [['user1'], 'user1', 'app1', 'key0', true, false, true], + [null, 'user1', 'app1', 'key0', true, false, true], + [['user1'], 'user1', 'app1', 'fast_boolean', false, false, true], + [null, 'user1', 'app1', 'fast_boolean', false, false, true], + [['user1'], 'user1', 'app1', 'fast_boolean_0', false, false, false], + [null, 'user1', 'app1', 'fast_boolean_0', false, false, false], + [['user1'], 'user1', 'app1', 'fast_boolean', true, false, true], + [null, 'user1', 'app1', 'fast_boolean', true, false, true], + [['user1'], 'user1', 'app1', 'fast_boolean_0', true, false, false], + [null, 'user1', 'app1', 'fast_boolean_0', true, false, false], + [['user1'], 'user1', 'app1', 'fast_boolean', false, true, true], + [null, 'user1', 'app1', 'fast_boolean', false, true, false], + [['user1'], 'user1', 'app1', 'fast_boolean_0', false, true, false], + [null, 'user1', 'app1', 'fast_boolean_0', false, true, false], + [['user1'], 'user1', 'app1', 'fast_boolean', true, true, true], + [null, 'user1', 'app1', 'fast_boolean', true, true, true], + [['user1'], 'user1', 'app1', 'fast_boolean_0', true, true, false], + [null, 'user1', 'app1', 'fast_boolean_0', true, true, true], + [['user1'], 'user1', 'app1', 'lazy_boolean', false, false, false], + [null, 'user1', 'app1', 'lazy_boolean', false, false, false], + [['user1'], 'user1', 'app1', 'lazy_boolean_0', false, false, false], + [null, 'user1', 'app1', 'lazy_boolean_0', false, false, false], + [['user1'], 'user1', 'app1', 'lazy_boolean', true, false, true], + [null, 'user1', 'app1', 'lazy_boolean', true, false, true], + [['user1'], 'user1', 'app1', 'lazy_boolean_0', true, false, true], + [null, 'user1', 'app1', 'lazy_boolean_0', true, false, true], + [['user1'], 'user1', 'app1', 'lazy_boolean', false, true, true], + [null, 'user1', 'app1', 'lazy_boolean', false, true, true], + [['user1'], 'user1', 'app1', 'lazy_boolean_0', false, true, false], + [null, 'user1', 'app1', 'lazy_boolean_0', false, true, false], + [['user1'], 'user1', 'app1', 'lazy_boolean', true, true, true], + [null, 'user1', 'app1', 'lazy_boolean', true, true, true], + [['user1'], 'user1', 'app1', 'lazy_boolean_0', true, true, false], + [null, 'user1', 'app1', 'lazy_boolean_0', true, true, false], + ]; + } + + /** + * @dataProvider providerGetValueBool + */ + public function testGetValueBool( + ?array $preload, + string $userId, + string $app, + string $key, + bool $default, + bool $lazy, + bool $result, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals($result, $userConfig->getValueBool($userId, $app, $key, $default, $lazy)); + } + + public function providerGetValueArray(): array { + return [ + [ + ['user1'], 'user1', 'app1', 'key0', ['default_because_unknown_key'], true, + ['default_because_unknown_key'] + ], + [ + null, 'user1', 'app1', 'key0', ['default_because_unknown_key'], true, + ['default_because_unknown_key'] + ], + [ + ['user1'], 'user1', 'app1', 'key0', ['default_because_unknown_key'], false, + ['default_because_unknown_key'] + ], + [ + null, 'user1', 'app1', 'key0', ['default_because_unknown_key'], false, + ['default_because_unknown_key'] + ], + ]; + } + + /** + * @dataProvider providerGetValueArray + */ + public function testGetValueArray( + ?array $preload, + string $userId, + string $app, + string $key, + array $default, + bool $lazy, + array $result, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEqualsCanonicalizing( + $result, $userConfig->getValueArray($userId, $app, $key, $default, $lazy) + ); + } + + public function providerGetValueType(): array { + return [ + [null, 'user1', 'app1', 'key1', false, ValueType::MIXED], + [null, 'user1', 'app1', 'key1', true, null, UnknownKeyException::class], + [null, 'user1', 'app1', 'fast_string', true, ValueType::STRING, UnknownKeyException::class], + [['user1'], 'user1', 'app1', 'fast_string', true, ValueType::STRING], + [null, 'user1', 'app1', 'fast_string', false, ValueType::STRING], + [null, 'user1', 'app1', 'lazy_string', true, ValueType::STRING], + [null, 'user1', 'app1', 'lazy_string', false, ValueType::STRING, UnknownKeyException::class], + [ + null, 'user1', 'app1', 'fast_string_sensitive', true, ValueType::STRING, + UnknownKeyException::class + ], + [['user1'], 'user1', 'app1', 'fast_string_sensitive', true, ValueType::STRING], + [null, 'user1', 'app1', 'fast_string_sensitive', false, ValueType::STRING], + [null, 'user1', 'app1', 'lazy_string_sensitive', true, ValueType::STRING], + [ + null, 'user1', 'app1', 'lazy_string_sensitive', false, ValueType::STRING, + UnknownKeyException::class + ], + [null, 'user1', 'app1', 'fast_int', true, ValueType::INT, UnknownKeyException::class], + [['user1'], 'user1', 'app1', 'fast_int', true, ValueType::INT], + [null, 'user1', 'app1', 'fast_int', false, ValueType::INT], + [null, 'user1', 'app1', 'lazy_int', true, ValueType::INT], + [null, 'user1', 'app1', 'lazy_int', false, ValueType::INT, UnknownKeyException::class], + [null, 'user1', 'app1', 'fast_float', true, ValueType::FLOAT, UnknownKeyException::class], + [['user1'], 'user1', 'app1', 'fast_float', true, ValueType::FLOAT], + [null, 'user1', 'app1', 'fast_float', false, ValueType::FLOAT], + [null, 'user1', 'app1', 'lazy_float', true, ValueType::FLOAT], + [null, 'user1', 'app1', 'lazy_float', false, ValueType::FLOAT, UnknownKeyException::class], + [null, 'user1', 'app1', 'fast_boolean', true, ValueType::BOOL, UnknownKeyException::class], + [['user1'], 'user1', 'app1', 'fast_boolean', true, ValueType::BOOL], + [null, 'user1', 'app1', 'fast_boolean', false, ValueType::BOOL], + [null, 'user1', 'app1', 'lazy_boolean', true, ValueType::BOOL], + [null, 'user1', 'app1', 'lazy_boolean', false, ValueType::BOOL, UnknownKeyException::class], + ]; + } + + /** + * @dataProvider providerGetValueType + */ + public function testGetValueType( + ?array $preload, + string $userId, + string $app, + string $key, + ?bool $lazy, + ?ValueType $result, + ?string $exception = null, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + if ($exception !== null) { + $this->expectException($exception); + } + + $type = $userConfig->getValueType($userId, $app, $key, $lazy); + if ($exception === null) { + $this->assertEquals($result->value, $type->value); + } + } + + public function providerSetValueMixed(): array { + return [ + [null, 'user1', 'app1', 'key1', 'value', false, false, true], + [null, 'user1', 'app1', 'key1', '12345', true, false, true], + [null, 'user1', 'app1', 'key1', '12345', true, true, true], + [null, 'user1', 'app1', 'key1', 'value1', false, false, false], + [null, 'user1', 'app1', 'key1', 'value1', true, false, true], + [null, 'user1', 'app1', 'key1', 'value1', false, true, true], + [ + null, 'user1', 'app1', 'fast_string', 'f_value_2', false, false, true, + TypeConflictException::class + ], + [ + null, 'user1', 'app1', 'fast_string', 'f_value', true, false, true, + TypeConflictException::class + ], + [null, 'user1', 'app1', 'fast_string', 'f_value', true, true, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_int', 'n_value', false, false, true, TypeConflictException::class], + [ + null, 'user1', 'app1', 'fast_float', 'n_value', false, false, true, + TypeConflictException::class + ], + [ + null, 'user1', 'app1', 'lazy_string', 'l_value_2', false, false, true, + TypeConflictException::class + ], + [null, 'user1', 'app1', 'lazy_string', 'l_value', true, false, false], + [null, 'user1', 'app1', 'lazy_string', 'l_value', true, true, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_int', 'l_value', false, false, true, TypeConflictException::class], + [ + null, 'user1', 'app1', 'lazy_float', 'l_value', false, false, true, + TypeConflictException::class + ], + ]; + } + + /** + * @dataProvider providerSetValueMixed + */ + public function testSetValueMixed( + ?array $preload, + string $userId, + string $app, + string $key, + string $value, + bool $lazy, + bool $sensitive, + bool $result, + ?string $exception = null, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + if ($exception !== null) { + $this->expectException($exception); + } + + $edited = $userConfig->setValueMixed($userId, $app, $key, $value, $lazy, ($sensitive) ? 1 : 0); + + if ($exception === null) { + $this->assertEquals($result, $edited); + } + } + + + public function providerSetValueString(): array { + return [ + [null, 'user1', 'app1', 'key1', 'value', false, false, true], + [null, 'user1', 'app1', 'key1', '12345', true, false, true], + [null, 'user1', 'app1', 'key1', '12345', true, true, true], + [null, 'user1', 'app1', 'key1', 'value1', false, false, false], + [null, 'user1', 'app1', 'key1', 'value1', true, false, true], + [null, 'user1', 'app1', 'key1', 'value1', false, true, true], + [null, 'user1', 'app1', 'fast_string', 'f_value_2', false, false, true], + [null, 'user1', 'app1', 'fast_string', 'f_value', false, false, false], + [null, 'user1', 'app1', 'fast_string', 'f_value', true, false, true], + [null, 'user1', 'app1', 'fast_string', 'f_value', true, true, true], + [null, 'user1', 'app1', 'lazy_string', 'l_value_2', false, false, true], + [null, 'user1', 'app1', 'lazy_string', 'l_value', true, false, false], + [null, 'user1', 'app1', 'lazy_string', 'l_value', true, true, true], + [null, 'user1', 'app1', 'fast_string_sensitive', 'fs_value', false, true, false], + [null, 'user1', 'app1', 'fast_string_sensitive', 'fs_value', true, true, true], + [null, 'user1', 'app1', 'fast_string_sensitive', 'fs_value', true, false, true], + [null, 'user1', 'app1', 'lazy_string_sensitive', 'ls_value', false, true, true], + [null, 'user1', 'app1', 'lazy_string_sensitive', 'ls_value', true, true, false], + [null, 'user1', 'app1', 'lazy_string_sensitive', 'ls_value', true, false, false], + [null, 'user1', 'app1', 'lazy_string_sensitive', 'ls_value_2', true, false, true], + [null, 'user1', 'app1', 'fast_int', 'n_value', false, false, true, TypeConflictException::class], + [ + null, 'user1', 'app1', 'fast_float', 'n_value', false, false, true, + TypeConflictException::class + ], + [ + null, 'user1', 'app1', 'fast_float', 'n_value', false, false, true, + TypeConflictException::class + ], + [null, 'user1', 'app1', 'lazy_int', 'n_value', false, false, true, TypeConflictException::class], + [ + null, 'user1', 'app1', 'lazy_boolean', 'n_value', false, false, true, + TypeConflictException::class + ], + [ + null, 'user1', 'app1', 'lazy_float', 'n_value', false, false, true, + TypeConflictException::class + ], + ]; + } + + /** + * @dataProvider providerSetValueString + */ + public function testSetValueString( + ?array $preload, + string $userId, + string $app, + string $key, + string $value, + bool $lazy, + bool $sensitive, + bool $result, + ?string $exception = null, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + if ($exception !== null) { + $this->expectException($exception); + } + + $edited = $userConfig->setValueString($userId, $app, $key, $value, $lazy, ($sensitive) ? 1 : 0); + if ($exception !== null) { + return; + } + + $this->assertEquals($result, $edited); + if ($result) { + $this->assertEquals($value, $userConfig->getValueString($userId, $app, $key, $value, $lazy)); + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals($value, $userConfig->getValueString($userId, $app, $key, $value, $lazy)); + } + } + + public function providerSetValueInt(): array { + return [ + [null, 'user1', 'app1', 'key1', 12345, false, false, true], + [null, 'user1', 'app1', 'key1', 12345, true, false, true], + [null, 'user1', 'app1', 'key1', 12345, true, true, true], + [null, 'user1', 'app1', 'fast_int', 11, false, false, false], + [null, 'user1', 'app1', 'fast_int', 111, false, false, true], + [null, 'user1', 'app1', 'fast_int', 111, true, false, true], + [null, 'user1', 'app1', 'fast_int', 111, false, true, true], + [null, 'user1', 'app1', 'fast_int', 11, true, false, true], + [null, 'user1', 'app1', 'fast_int', 11, false, true, true], + [null, 'user1', 'app1', 'lazy_int', 12, false, false, true], + [null, 'user1', 'app1', 'lazy_int', 121, false, false, true], + [null, 'user1', 'app1', 'lazy_int', 121, true, false, true], + [null, 'user1', 'app1', 'lazy_int', 121, false, true, true], + [null, 'user1', 'app1', 'lazy_int', 12, true, false, false], + [null, 'user1', 'app1', 'lazy_int', 12, false, true, true], + [null, 'user1', 'app1', 'fast_string', 12345, false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_string', 12345, false, false, false, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_string', 12345, true, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_string', 12345, true, true, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_string', 12345, false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_string', 12345, true, false, false, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_string', 12345, true, true, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_float', 12345, false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_float', 12345, false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_boolean', 12345, false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_float', 12345, false, false, true, TypeConflictException::class], + ]; + } + + /** + * @dataProvider providerSetValueInt + */ + public function testSetValueInt( + ?array $preload, + string $userId, + string $app, + string $key, + int $value, + bool $lazy, + bool $sensitive, + bool $result, + ?string $exception = null, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + if ($exception !== null) { + $this->expectException($exception); + } + + $edited = $userConfig->setValueInt($userId, $app, $key, $value, $lazy, ($sensitive) ? 1 : 0); + + if ($exception !== null) { + return; + } + + $this->assertEquals($result, $edited); + if ($result) { + $this->assertEquals($value, $userConfig->getValueInt($userId, $app, $key, $value, $lazy)); + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals($value, $userConfig->getValueInt($userId, $app, $key, $value, $lazy)); + } + } + + public function providerSetValueFloat(): array { + return [ + [null, 'user1', 'app1', 'key1', 12.345, false, false, true], + [null, 'user1', 'app1', 'key1', 12.345, true, false, true], + [null, 'user1', 'app1', 'key1', 12.345, true, true, true], + [null, 'user1', 'app1', 'fast_float', 3.14, false, false, false], + [null, 'user1', 'app1', 'fast_float', 3.15, false, false, true], + [null, 'user1', 'app1', 'fast_float', 3.15, true, false, true], + [null, 'user1', 'app1', 'fast_float', 3.15, false, true, true], + [null, 'user1', 'app1', 'fast_float', 3.14, true, false, true], + [null, 'user1', 'app1', 'fast_float', 3.14, false, true, true], + [null, 'user1', 'app1', 'lazy_float', 3.14159, false, false, true], + [null, 'user1', 'app1', 'lazy_float', 3.14158, false, false, true], + [null, 'user1', 'app1', 'lazy_float', 3.14158, true, false, true], + [null, 'user1', 'app1', 'lazy_float', 3.14158, false, true, true], + [null, 'user1', 'app1', 'lazy_float', 3.14159, true, false, false], + [null, 'user1', 'app1', 'lazy_float', 3.14159, false, true, true], + [null, 'user1', 'app1', 'fast_string', 12.345, false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_string', 12.345, false, false, false, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_string', 12.345, true, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_string', 12.345, true, true, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_string', 12.345, false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_string', 12.345, true, false, false, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_array', 12.345, true, true, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_int', 12.345, false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_int', 12.345, false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_boolean', 12.345, false, false, true, TypeConflictException::class], + ]; + } + + /** + * @dataProvider providerSetValueFloat + */ + public function testSetValueFloat( + ?array $preload, + string $userId, + string $app, + string $key, + float $value, + bool $lazy, + bool $sensitive, + bool $result, + ?string $exception = null, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + if ($exception !== null) { + $this->expectException($exception); + } + + $edited = $userConfig->setValueFloat($userId, $app, $key, $value, $lazy, ($sensitive) ? 1 : 0); + + if ($exception !== null) { + return; + } + + $this->assertEquals($result, $edited); + if ($result) { + $this->assertEquals($value, $userConfig->getValueFloat($userId, $app, $key, $value, $lazy)); + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals($value, $userConfig->getValueFloat($userId, $app, $key, $value, $lazy)); + } + } + + + public function providerSetValueArray(): array { + return [ + [null, 'user1', 'app1', 'key1', [], false, false, true], + [null, 'user1', 'app1', 'key1', [], true, false, true], + [null, 'user1', 'app1', 'key1', [], true, true, true], + [null, 'user1', 'app1', 'fast_array', ['year' => 2024], false, false, false], + [null, 'user1', 'app1', 'fast_array', [], false, false, true], + [null, 'user1', 'app1', 'fast_array', [], true, false, true], + [null, 'user1', 'app1', 'fast_array', [], false, true, true], + [null, 'user1', 'app1', 'fast_array', ['year' => 2024], true, false, true], + [null, 'user1', 'app1', 'fast_array', ['year' => 2024], false, true, true], + [null, 'user1', 'app1', 'lazy_array', ['month' => 'October'], false, false, true], + [null, 'user1', 'app1', 'lazy_array', ['month' => 'September'], false, false, true], + [null, 'user1', 'app1', 'lazy_array', ['month' => 'September'], true, false, true], + [null, 'user1', 'app1', 'lazy_array', ['month' => 'September'], false, true, true], + [null, 'user1', 'app1', 'lazy_array', ['month' => 'October'], true, false, false], + [null, 'user1', 'app1', 'lazy_array', ['month' => 'October'], false, true, true], + [null, 'user1', 'app1', 'fast_string', [], false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_string', [], false, false, false, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_string', [], true, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_string', [], true, true, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_string', [], false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_string', [], true, false, false, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_string', [], true, true, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_int', [], false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'fast_int', [], false, false, true, TypeConflictException::class], + [null, 'user1', 'app1', 'lazy_boolean', [], false, false, true, TypeConflictException::class], + ]; + } + + /** + * @dataProvider providerSetValueArray + */ + public function testSetValueArray( + ?array $preload, + string $userId, + string $app, + string $key, + array $value, + bool $lazy, + bool $sensitive, + bool $result, + ?string $exception = null, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + if ($exception !== null) { + $this->expectException($exception); + } + + $edited = $userConfig->setValueArray($userId, $app, $key, $value, $lazy, ($sensitive) ? 1 : 0); + + if ($exception !== null) { + return; + } + + $this->assertEquals($result, $edited); + if ($result) { + $this->assertEqualsCanonicalizing( + $value, $userConfig->getValueArray($userId, $app, $key, $value, $lazy) + ); + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEqualsCanonicalizing( + $value, $userConfig->getValueArray($userId, $app, $key, $value, $lazy) + ); + } + } + + public function providerUpdateSensitive(): array { + return [ + [null, 'user1', 'app1', 'key1', false, false], + [['user1'], 'user1', 'app1', 'key1', false, false], + [null, 'user1', 'app1', 'key1', true, true], + [['user1'], 'user1', 'app1', 'key1', true, true], + ]; + } + + /** + * @dataProvider providerUpdateSensitive + */ + public function testUpdateSensitive( + ?array $preload, + string $userId, + string $app, + string $key, + bool $sensitive, + bool $result, + ?string $exception = null, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + if ($exception !== null) { + $this->expectException($exception); + } + + $edited = $userConfig->updateSensitive($userId, $app, $key, $sensitive); + if ($exception !== null) { + return; + } + + $this->assertEquals($result, $edited); + if ($result) { + $this->assertEquals($sensitive, $userConfig->isSensitive($userId, $app, $key)); + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals($sensitive, $userConfig->isSensitive($userId, $app, $key)); + if ($sensitive) { + $this->assertEquals(true, str_starts_with( + $userConfig->statusCache()['fastCache'][$userId][$app][$key] ?? + $userConfig->statusCache()['lazyCache'][$userId][$app][$key], + '$UserConfigEncryption$') + ); + } + } + } + + public function providerUpdateGlobalSensitive(): array { + return [[true], [false]]; + } + + /** + * @dataProvider providerUpdateGlobalSensitive + */ + public function testUpdateGlobalSensitive(bool $sensitive): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $app = 'app2'; + if ($sensitive) { + $key = 'key2'; + $value = 'value2a'; + } else { + $key = 'key4'; + $value = 'value4'; + } + + $this->assertEquals($value, $userConfig->getValueString('user1', $app, $key)); + foreach (['user1', 'user2', 'user3', 'user4'] as $userId) { + $userConfig->getValueString($userId, $app, $key); // cache loading for userId + $this->assertEquals( + !$sensitive, str_starts_with( + $userConfig->statusCache()['fastCache'][$userId][$app][$key] ?? + $userConfig->statusCache()['lazyCache'][$userId][$app][$key], + '$UserConfigEncryption$' + ) + ); + } + + $userConfig->updateGlobalSensitive($app, $key, $sensitive); + + $this->assertEquals($value, $userConfig->getValueString('user1', $app, $key)); + foreach (['user1', 'user2', 'user3', 'user4'] as $userId) { + $this->assertEquals($sensitive, $userConfig->isSensitive($userId, $app, $key)); + // should only work if updateGlobalSensitive drop cache + $this->assertEquals($sensitive, str_starts_with( + $userConfig->statusCache()['fastCache'][$userId][$app][$key] ?? + $userConfig->statusCache()['lazyCache'][$userId][$app][$key], + '$UserConfigEncryption$') + ); + } + } + + public function providerUpdateLazy(): array { + return [ + [null, 'user1', 'app1', 'key1', false, false], + [['user1'], 'user1', 'app1', 'key1', false, false], + [null, 'user1', 'app1', 'key1', true, true], + [['user1'], 'user1', 'app1', 'key1', true, true], + ]; + } + + /** + * @dataProvider providerUpdateLazy + */ + public function testUpdateLazy( + ?array $preload, + string $userId, + string $app, + string $key, + bool $lazy, + bool $result, + ?string $exception = null, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + if ($exception !== null) { + $this->expectException($exception); + } + + $edited = $userConfig->updateLazy($userId, $app, $key, $lazy); + if ($exception !== null) { + return; + } + + $this->assertEquals($result, $edited); + if ($result) { + $this->assertEquals($lazy, $userConfig->isLazy($userId, $app, $key)); + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals($lazy, $userConfig->isLazy($userId, $app, $key)); + } + } + + public function providerUpdateGlobalLazy(): array { + return [[true], [false]]; + } + + /** + * @dataProvider providerUpdateGlobalLazy + */ + public function testUpdateGlobalLazy(bool $lazy): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $app = 'app2'; + if ($lazy) { + $key = 'key4'; + $value = 'value4'; + } else { + $key = 'key3'; + $value = 'value3'; + } + + $this->assertEquals($value, $userConfig->getValueString('user1', $app, $key, '', !$lazy)); + foreach (['user1', 'user2', 'user3', 'user4'] as $userId) { + $this->assertEquals(!$lazy, $userConfig->isLazy($userId, $app, $key)); + } + + $userConfig->updateGlobalLazy($app, $key, $lazy); + $this->assertEquals($value, $userConfig->getValueString('user1', $app, $key, '', $lazy)); + foreach (['user1', 'user2', 'user3', 'user4'] as $userId) { + $this->assertEquals($lazy, $userConfig->isLazy($userId, $app, $key)); + } + } + + public function providerGetDetails(): array { + return [ + [ + 'user3', 'app2', 'key2', + [ + 'userId' => 'user3', + 'app' => 'app2', + 'key' => 'key2', + 'value' => 'value2c', + 'type' => 0, + 'lazy' => false, + 'typeString' => 'mixed', + 'sensitive' => false + ] + ], + [ + 'user1', 'app1', 'lazy_int', + [ + 'userId' => 'user1', + 'app' => 'app1', + 'key' => 'lazy_int', + 'value' => 12, + 'type' => 2, + 'lazy' => true, + 'typeString' => 'int', + 'sensitive' => false + ] + ], + [ + 'user1', 'app1', 'fast_float_sensitive', + [ + 'userId' => 'user1', + 'app' => 'app1', + 'key' => 'fast_float_sensitive', + 'value' => 1.41, + 'type' => 3, + 'lazy' => false, + 'typeString' => 'float', + 'sensitive' => true + ] + ], + ]; + } + + /** + * @dataProvider providerGetDetails + */ + public function testGetDetails(string $userId, string $app, string $key, array $result): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEqualsCanonicalizing($result, $userConfig->getDetails($userId, $app, $key)); + } + + + public function providerDeletePreference(): array { + return [ + [null, 'user1', 'app1', 'key22'], + [['user1'], 'user1', 'app1', 'fast_string_sensitive'], + [null, 'user1', 'app1', 'lazy_array_sensitive'], + [['user2'], 'user1', 'app1', 'lazy_array_sensitive'], + [null, 'user2', 'only-lazy', 'key1'], + [['user2'], 'user2', 'only-lazy', 'key1'], + ]; + } + + /** + * @dataProvider providerDeletePreference + */ + public function testDeletePreference( + ?array $preload, + string $userId, + string $app, + string $key, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $lazy = $userConfig->isLazy($userId, $app, $key); + + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals(true, $userConfig->hasKey($userId, $app, $key, $lazy)); + $userConfig->deleteUserConfig($userId, $app, $key); + $this->assertEquals(false, $userConfig->hasKey($userId, $app, $key, $lazy)); + $userConfig = $this->generateUserConfig($preload ?? []); + $this->assertEquals(false, $userConfig->hasKey($userId, $app, $key, $lazy)); + } + + public function providerDeleteKey(): array { + return [ + [null, 'app2', 'key3'], + [['user1'], 'app2', 'key3'], + [null, 'only-lazy', 'key1'], + [['user2'], 'only-lazy', 'key1'], + [null, 'app2', 'lazy_string_sensitive'], + [['user3', 'user1'], 'app2', 'lazy_string_sensitive'], + ]; + } + + /** + * @dataProvider providerDeleteKey + */ + public function testDeleteKey( + ?array $preload, + string $app, + string $key, + ): void { + $userConfig = $this->generateUserConfig($preload ?? []); + $userConfig->deleteKey($app, $key); + + foreach (['user1', 'user2', 'user3', 'user4'] as $userId) { + $this->assertEquals(false, $userConfig->hasKey($userId, $app, $key, null)); + $userConfigTemp = $this->generateUserConfig($preload ?? []); + $this->assertEquals(false, $userConfigTemp->hasKey($userId, $app, $key, null)); + } + } + + public function testDeleteApp(): void { + $userConfig = $this->generateUserConfig(); + $userConfig->deleteApp('only-lazy'); + + foreach (['user1', 'user2', 'user3', 'user4'] as $userId) { + $this->assertEquals(false, in_array('only-lazy', $userConfig->getApps($userId))); + $userConfigTemp = $this->generateUserConfig(); + $this->assertEquals(false, in_array('only-lazy', $userConfigTemp->getApps($userId))); + } + } + + public function testDeleteAllPreferences(): void { + $userConfig = $this->generateUserConfig(); + $userConfig->deleteAllUserConfig('user1'); + + $this->assertEqualsCanonicalizing([], $userConfig->getApps('user1')); + $userConfig = $this->generateUserConfig(); + $this->assertEqualsCanonicalizing([], $userConfig->getApps('user1')); + } + + public function testClearCache(): void { + $userConfig = $this->generateUserConfig(['user1', 'user2']); + $userConfig->clearCache('user1'); + + $this->assertEquals(true, $userConfig->statusCache()['fastLoaded']['user2']); + $this->assertEquals(false, $userConfig->statusCache()['fastLoaded']['user1']); + $this->assertEquals('value2a', $userConfig->getValueString('user1', 'app2', 'key2')); + $this->assertEquals(false, $userConfig->statusCache()['lazyLoaded']['user1']); + $this->assertEquals(true, $userConfig->statusCache()['fastLoaded']['user1']); + } + + public function testClearCacheAll(): void { + $userConfig = $this->generateUserConfig(['user1', 'user2']); + $userConfig->clearCacheAll(); + $this->assertEqualsCanonicalizing( + [ + 'fastLoaded' => [], + 'fastCache' => [], + 'lazyLoaded' => [], + 'lazyCache' => [], + 'valueTypes' => [], + ], + $userConfig->statusCache() + ); + } +}