summaryrefslogtreecommitdiffstats
path: root/lib/private/AppConfig.php
diff options
context:
space:
mode:
authorRoeland Jago Douma <rullzer@owncloud.com>2016-04-29 08:00:31 +0200
committerRoeland Jago Douma <rullzer@owncloud.com>2016-04-29 08:00:31 +0200
commitd312051b3d9554519155c6c4f98b51f404a468e1 (patch)
treed2de005558e004aaf86496c8bae82c041a78f0b1 /lib/private/AppConfig.php
parent1f63e8df61dbee0ee4acbdf485b1132312b88ce5 (diff)
downloadnextcloud-server-d312051b3d9554519155c6c4f98b51f404a468e1.tar.gz
nextcloud-server-d312051b3d9554519155c6c4f98b51f404a468e1.zip
Moved some files in \OC to PSR-4
* \OC\ActivityManager * \OC\AllConfig * \OC\AppConfig * \OC\AppHelper * \OC\Avatar * \OC\AvatarManager * \OC\CapabilitiesManager * \OC\Config * \OC\ContactsManager * \OC\DatabaseException * \OC\DatabaseSetupException
Diffstat (limited to 'lib/private/AppConfig.php')
-rw-r--r--lib/private/AppConfig.php287
1 files changed, 287 insertions, 0 deletions
diff --git a/lib/private/AppConfig.php b/lib/private/AppConfig.php
new file mode 100644
index 00000000000..14c48299a8a
--- /dev/null
+++ b/lib/private/AppConfig.php
@@ -0,0 +1,287 @@
+<?php
+/**
+ * @author Arthur Schiwon <blizzz@owncloud.com>
+ * @author Bart Visscher <bartv@thisnet.nl>
+ * @author Jakob Sack <mail@jakobsack.de>
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Robin McCorkell <robin@mccorkell.me.uk>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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 <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC;
+
+use OCP\IAppConfig;
+use OCP\IDBConnection;
+
+/**
+ * This class provides an easy way for apps to store config values in the
+ * database.
+ */
+class AppConfig implements IAppConfig {
+ /**
+ * @var \OCP\IDBConnection $conn
+ */
+ protected $conn;
+
+ private $cache = array();
+
+ /**
+ * @param IDBConnection $conn
+ */
+ public function __construct(IDBConnection $conn) {
+ $this->conn = $conn;
+ $this->configLoaded = false;
+ }
+
+ /**
+ * @param string $app
+ * @return array
+ */
+ private function getAppValues($app) {
+ $this->loadConfigValues();
+
+ if (isset($this->cache[$app])) {
+ return $this->cache[$app];
+ }
+
+ return [];
+ }
+
+ /**
+ * Get all apps using the config
+ *
+ * @return array an array of app ids
+ *
+ * This function returns a list of all apps that have at least one
+ * entry in the appconfig table.
+ */
+ public function getApps() {
+ $this->loadConfigValues();
+
+ return $this->getSortedKeys($this->cache);
+ }
+
+ /**
+ * Get the available keys for an app
+ *
+ * @param string $app the app we are looking for
+ * @return array an array of key names
+ *
+ * This function gets all keys of an app. Please note that the values are
+ * not returned.
+ */
+ public function getKeys($app) {
+ $this->loadConfigValues();
+
+ if (isset($this->cache[$app])) {
+ return $this->getSortedKeys($this->cache[$app]);
+ }
+
+ return [];
+ }
+
+ public function getSortedKeys($data) {
+ $keys = array_keys($data);
+ sort($keys);
+ return $keys;
+ }
+
+ /**
+ * Gets the config value
+ *
+ * @param string $app app
+ * @param string $key key
+ * @param string $default = null, default value if the key does not exist
+ * @return string the value or $default
+ *
+ * This function gets a value from the appconfig table. If the key does
+ * not exist the default value will be returned
+ */
+ public function getValue($app, $key, $default = null) {
+ $this->loadConfigValues();
+
+ if ($this->hasKey($app, $key)) {
+ return $this->cache[$app][$key];
+ }
+
+ return $default;
+ }
+
+ /**
+ * check if a key is set in the appconfig
+ *
+ * @param string $app
+ * @param string $key
+ * @return bool
+ */
+ public function hasKey($app, $key) {
+ $this->loadConfigValues();
+
+ return isset($this->cache[$app][$key]);
+ }
+
+ /**
+ * Sets a value. If the key did not exist before it will be created.
+ *
+ * @param string $app app
+ * @param string $key key
+ * @param string $value value
+ * @return bool True if the value was inserted or updated, false if the value was the same
+ */
+ public function setValue($app, $key, $value) {
+ if (!$this->hasKey($app, $key)) {
+ $inserted = (bool) $this->conn->insertIfNotExist('*PREFIX*appconfig', [
+ 'appid' => $app,
+ 'configkey' => $key,
+ 'configvalue' => $value,
+ ], [
+ 'appid',
+ 'configkey',
+ ]);
+
+ if ($inserted) {
+ if (!isset($this->cache[$app])) {
+ $this->cache[$app] = [];
+ }
+
+ $this->cache[$app][$key] = $value;
+ return true;
+ }
+ }
+
+ $sql = $this->conn->getQueryBuilder();
+ $sql->update('appconfig')
+ ->set('configvalue', $sql->createParameter('configvalue'))
+ ->where($sql->expr()->eq('appid', $sql->createParameter('app')))
+ ->andWhere($sql->expr()->eq('configkey', $sql->createParameter('configkey')))
+ ->setParameter('configvalue', $value)
+ ->setParameter('app', $app)
+ ->setParameter('configkey', $key);
+
+ /*
+ * Only limit to the existing value for non-Oracle DBs:
+ * http://docs.oracle.com/cd/E11882_01/server.112/e26088/conditions002.htm#i1033286
+ * > Large objects (LOBs) are not supported in comparison conditions.
+ */
+ if (!($this->conn instanceof \OC\DB\OracleConnection)) {
+ // Only update the value when it is not the same
+ $sql->andWhere($sql->expr()->neq('configvalue', $sql->createParameter('configvalue')))
+ ->setParameter('configvalue', $value);
+ }
+
+ $changedRow = (bool) $sql->execute();
+
+ $this->cache[$app][$key] = $value;
+
+ return $changedRow;
+ }
+
+ /**
+ * Deletes a key
+ *
+ * @param string $app app
+ * @param string $key key
+ * @return boolean|null
+ */
+ public function deleteKey($app, $key) {
+ $this->loadConfigValues();
+
+ $sql = $this->conn->getQueryBuilder();
+ $sql->delete('appconfig')
+ ->where($sql->expr()->eq('appid', $sql->createParameter('app')))
+ ->andWhere($sql->expr()->eq('configkey', $sql->createParameter('configkey')))
+ ->setParameter('app', $app)
+ ->setParameter('configkey', $key);
+ $sql->execute();
+
+ unset($this->cache[$app][$key]);
+ }
+
+ /**
+ * Remove app from appconfig
+ *
+ * @param string $app app
+ * @return boolean|null
+ *
+ * Removes all keys in appconfig belonging to the app.
+ */
+ public function deleteApp($app) {
+ $this->loadConfigValues();
+
+ $sql = $this->conn->getQueryBuilder();
+ $sql->delete('appconfig')
+ ->where($sql->expr()->eq('appid', $sql->createParameter('app')))
+ ->setParameter('app', $app);
+ $sql->execute();
+
+ unset($this->cache[$app]);
+ }
+
+ /**
+ * get multiple values, either the app or key can be used as wildcard by setting it to false
+ *
+ * @param string|false $app
+ * @param string|false $key
+ * @return array|false
+ */
+ public function getValues($app, $key) {
+ if (($app !== false) === ($key !== false)) {
+ return false;
+ }
+
+ if ($key === false) {
+ return $this->getAppValues($app);
+ } else {
+ $appIds = $this->getApps();
+ $values = array_map(function($appId) use ($key) {
+ return isset($this->cache[$appId][$key]) ? $this->cache[$appId][$key] : null;
+ }, $appIds);
+ $result = array_combine($appIds, $values);
+
+ return array_filter($result);
+ }
+ }
+
+ /**
+ * Load all the app config values
+ */
+ protected function loadConfigValues() {
+ if ($this->configLoaded) return;
+
+ $this->cache = [];
+
+ $sql = $this->conn->getQueryBuilder();
+ $sql->select('*')
+ ->from('appconfig');
+ $result = $sql->execute();
+
+ while ($row = $result->fetch()) {
+ if (!isset($this->cache[$row['appid']])) {
+ $this->cache[$row['appid']] = [];
+ }
+
+ $this->cache[$row['appid']][$row['configkey']] = $row['configvalue'];
+ }
+ $result->closeCursor();
+
+ $this->configLoaded = true;
+ }
+}