* @author Christoph Wurst * @author Joas Schilling * @author Jörn Friedrich Dreyer * @author Loki3000 * @author Lukas Reschke * @author MichaIng * @author Morris Jobke * @author Robin Appelman * @author Robin McCorkell * @author Roeland Jago Douma * @author Thomas Müller * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License, version 3, * along with this program. If not, see * */ namespace OC; use Doctrine\DBAL\Platforms\OraclePlatform; use OCP\Cache\CappedMemoryCache; use OCP\DB\QueryBuilder\IQueryBuilder; use OCP\IConfig; use OCP\IDBConnection; use OCP\PreConditionNotMetException; /** * Class to combine all the configuration options ownCloud offers */ class AllConfig implements IConfig { private SystemConfig $systemConfig; private ?IDBConnection $connection = null; /** * 3 dimensional array with the following structure: * [ $userId => * [ $appId => * [ $key => $value ] * ] * ] * * database table: preferences * * methods that use this: * - setUserValue * - getUserValue * - getUserKeys * - deleteUserValue * - deleteAllUserValues * - deleteAppFromAllUsers * * @var CappedMemoryCache $userCache */ private CappedMemoryCache $userCache; public function __construct(SystemConfig $systemConfig) { $this->userCache = new CappedMemoryCache(); $this->systemConfig = $systemConfig; } /** * TODO - FIXME This fixes an issue with base.php that cause cyclic * dependencies, especially with autoconfig setup * * Replace this by properly injected database connection. Currently the * base.php triggers the getDatabaseConnection too early which causes in * autoconfig setup case a too early distributed database connection and * the autoconfig then needs to reinit all already initialized dependencies * that use the database connection. * * otherwise a SQLite database is created in the wrong directory * because the database connection was created with an uninitialized config */ private function fixDIInit() { if ($this->connection === null) { $this->connection = \OC::$server->get(IDBConnection::class); } } /** * Sets and deletes system wide values * * @param array $configs Associative array with `key => value` pairs * If value is null, the config key will be deleted */ public function setSystemValues(array $configs) { $this->systemConfig->setValues($configs); } /** * Sets a new system wide value * * @param string $key the key of the value, under which will be saved * @param mixed $value the value that should be stored */ public function setSystemValue($key, $value) { $this->systemConfig->setValue($key, $value); } /** * Looks up a system wide defined value * * @param string $key the key of the value, under which it was saved * @param mixed $default the default value to be returned if the value isn't set * @return mixed the value or $default */ public function getSystemValue($key, $default = '') { return $this->systemConfig->getValue($key, $default); } /** * Looks up a boolean system wide defined value * * @param string $key the key of the value, under which it was saved * @param bool $default the default value to be returned if the value isn't set * * @return bool * * @since 16.0.0 */ public function getSystemValueBool(string $key, bool $default = false): bool { return (bool) $this->getSystemValue($key, $default); } /** * Looks up an integer system wide defined value * * @param string $key the key of the value, under which it was saved * @param int $default the default value to be returned if the value isn't set * * @return int * * @since 16.0.0 */ public function getSystemValueInt(string $key, int $default = 0): int { return (int) $this->getSystemValue($key, $default); } /** * Looks up a string system wide defined value * * @param string $key the key of the value, under which it was saved * @param string $default the default value to be returned if the value isn't set * * @return string * * @since 16.0.0 */ public function getSystemValueString(string $key, string $default = ''): string { return (string) $this->getSystemValue($key, $default); } /** * Looks up a system wide defined value and filters out sensitive data * * @param string $key the key of the value, under which it was saved * @param mixed $default the default value to be returned if the value isn't set * @return mixed the value or $default */ public function getFilteredSystemValue($key, $default = '') { return $this->systemConfig->getFilteredValue($key, $default); } /** * Delete a system wide defined value * * @param string $key the key of the value, under which it was saved */ public function deleteSystemValue($key) { $this->systemConfig->deleteValue($key); } /** * Get all keys stored for an app * * @param string $appName the appName that we stored the value under * @return string[] the keys stored for the app */ public function getAppKeys($appName) { return \OC::$server->get(AppConfig::class)->getKeys($appName); } /** * Writes a new app wide value * * @param string $appName the appName that we want to store the value under * @param string $key the key of the value, under which will be saved * @param string|float|int $value the value that should be stored */ public function setAppValue($appName, $key, $value) { \OC::$server->get(AppConfig::class)->setValue($appName, $key, $value); } /** * Looks up an app wide defined value * * @param string $appName the appName that we stored the value under * @param string $key the key of the value, under which it was saved * @param string $default the default value to be returned if the value isn't set * @return string the saved value */ public function getAppValue($appName, $key, $default = '') { return \OC::$server->get(AppConfig::class)->getValue($appName, $key, $default); } /** * Delete an app wide defined value * * @param string $appName the appName that we stored the value under * @param string $key the key of the value, under which it was saved */ public function deleteAppValue($appName, $key) { \OC::$server->get(AppConfig::class)->deleteKey($appName, $key); } /** * Removes all keys in appconfig belonging to the app * * @param string $appName the appName the configs are stored under */ public function deleteAppValues($appName) { \OC::$server->get(AppConfig::class)->deleteApp($appName); } /** * Set a user defined value * * @param string $userId the userId of the user that we want to store the value under * @param string $appName the appName that we want to store the value under * @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 */ 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; } } $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; } } /** * Getting a user defined value * * @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 * @param mixed $default the default value to be returned if the value isn't set * @return string */ public function getUserValue($userId, $appName, $key, $default = '') { $data = $this->getAllUserValues($userId); if (isset($data[$appName][$key])) { return $data[$appName][$key]; } else { return $default; } } /** * Get the keys of all stored by an app for the user * * @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[] */ public function getUserKeys($userId, $appName) { $data = $this->getAllUserValues($userId); if (isset($data[$appName])) { return array_map('strval', array_keys($data[$appName])); } else { return []; } } /** * Delete a user value * * @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 */ 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]); } } /** * Delete all user values * * @param string $userId the userId of the user that we want to remove all values from */ 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]); } /** * Delete all user related values of one app * * @param string $appName the appName of the app that we want to remove all values from */ 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]); } } /** * 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 ] * ] */ public function getAllUserValues(?string $userId): array { if (isset($this->userCache[$userId])) { return $this->userCache[$userId]; } if ($userId === null || $userId === '') { $this->userCache[''] = []; return $this->userCache['']; } // 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] = []; } $data[$appId][$row['configkey']] = $row['configvalue']; } $this->userCache[$userId] = $data; return $data; } /** * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. * * @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 */ 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; } /** * Determines the users that have the given value set for a specific app-key-pair * * @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 array of user IDs */ public function getUsersForUserValue($appName, $key, $value) { // TODO - FIXME $this->fixDIInit(); $qb = $this->connection->getQueryBuilder(); $configValueColumn = ($this->connection->getDatabasePlatform() instanceof OraclePlatform) ? $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; } /** * Determines the users that have the given value set for a specific app-key-pair * * @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 array of user IDs */ 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->getDatabasePlatform() instanceof OraclePlatform) ? $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; } public function getSystemConfig() { return $this->systemConfig; } } 01 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607