nextcloud/lib/private/appconfig.php

282 lines
6.7 KiB
PHP
Raw Normal View History

<?php
/**
2015-03-26 13:44:34 +03:00
* @author Arthur Schiwon <blizzz@owncloud.com>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Jakob Sack <mail@jakobsack.de>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@owncloud.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
* @author Scrutinizer Auto-Fixer <auto-fixer@scrutinizer-ci.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @copyright Copyright (c) 2015, 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
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
2015-03-26 13:44:34 +03:00
* 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/>
*
*/
/*
*
* The following SQL statement is just a help for developers and will not be
* executed!
*
* CREATE TABLE `appconfig` (
* `appid` VARCHAR( 255 ) NOT NULL ,
* `configkey` VARCHAR( 255 ) NOT NULL ,
* `configvalue` VARCHAR( 255 ) NOT NULL
* )
*
*/
namespace OC;
use OC\DB\Connection;
use OCP\IAppConfig;
/**
* This class provides an easy way for apps to store config values in the
* database.
*/
class AppConfig implements IAppConfig {
2013-08-26 00:34:54 +04:00
/**
* @var \OC\DB\Connection $conn
*/
protected $conn;
2014-02-07 17:03:39 +04:00
private $cache = array();
2014-02-07 17:03:39 +04:00
private $appsLoaded = array();
2014-06-01 16:04:17 +04:00
/**
* @var string[]
*/
private $apps = null;
2013-08-26 00:34:54 +04:00
/**
* @param Connection $conn
2013-08-26 00:34:54 +04:00
*/
public function __construct(Connection $conn) {
$this->conn = $conn;
}
2014-02-07 17:03:39 +04:00
/**
* @param string $app
* @return string[]
*/
private function getAppCache($app) {
if (!isset($this->cache[$app])) {
$this->cache[$app] = array();
}
return $this->cache[$app];
}
/**
* @param string $app
2014-04-21 17:44:54 +04:00
* @return \string[]
*/
2014-02-07 17:03:39 +04:00
private function getAppValues($app) {
$appCache = $this->getAppCache($app);
if (array_search($app, $this->appsLoaded) === false) {
$query = 'SELECT `configvalue`, `configkey` FROM `*PREFIX*appconfig`'
. ' WHERE `appid` = ?';
$result = $this->conn->executeQuery($query, array($app));
while ($row = $result->fetch()) {
$appCache[$row['configkey']] = $row['configvalue'];
}
$this->appsLoaded[] = $app;
}
$this->cache[$app] = $appCache;
return $appCache;
}
/**
* Get all apps using the config
2014-06-01 16:04:17 +04:00
*
2014-05-11 21:13:51 +04:00
* @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() {
2014-06-01 16:04:17 +04:00
if (is_array($this->apps)) {
return $this->apps;
}
2014-02-11 17:26:40 +04:00
$query = 'SELECT DISTINCT `appid` FROM `*PREFIX*appconfig` ORDER BY `appid`';
2013-08-26 00:34:54 +04:00
$result = $this->conn->executeQuery($query);
$apps = array();
2013-08-26 00:34:54 +04:00
while ($appid = $result->fetchColumn()) {
$apps[] = $appid;
}
2014-06-01 16:04:17 +04:00
$this->apps = $apps;
return $apps;
}
/**
* Get the available keys for an app
2014-06-01 16:04:17 +04:00
*
2012-09-23 04:39:11 +04:00
* @param string $app the app we are looking for
2014-05-11 21:13:51 +04:00
* @return array an array of key names
*
* This function gets all keys of an app. Please note that the values are
* not returned.
*/
2013-08-26 00:34:54 +04:00
public function getKeys($app) {
2014-02-07 17:03:39 +04:00
$values = $this->getAppValues($app);
2014-02-11 17:26:40 +04:00
$keys = array_keys($values);
sort($keys);
return $keys;
}
/**
* Gets the config value
2014-06-01 16:04:17 +04:00
*
2012-09-23 04:39:11 +04:00
* @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
2012-09-23 04:39:11 +04:00
* not exist the default value will be returned
*/
2013-08-26 00:34:54 +04:00
public function getValue($app, $key, $default = null) {
2014-02-07 17:03:39 +04:00
$values = $this->getAppValues($app);
if (isset($values[$key])) {
return $values[$key];
} else {
return $default;
}
}
2012-08-29 10:38:33 +04:00
2011-10-02 16:30:51 +04:00
/**
* check if a key is set in the appconfig
2014-06-01 16:04:17 +04:00
*
2011-10-02 16:30:51 +04:00
* @param string $app
* @param string $key
* @return bool
*/
public function hasKey($app, $key) {
2014-02-07 17:03:39 +04:00
$values = $this->getAppValues($app);
return array_key_exists($key, $values);
2011-10-02 16:30:51 +04:00
}
2012-08-29 10:38:33 +04:00
/**
* Sets a value. If the key did not exist before it will be created.
2014-06-01 16:04:17 +04:00
*
2012-09-23 04:39:11 +04:00
* @param string $app app
* @param string $key key
* @param string $value value
* @return void
*/
2013-08-26 00:34:54 +04:00
public function setValue($app, $key, $value) {
$inserted = false;
// Does the key exist? no: insert, yes: update.
2013-08-26 00:34:54 +04:00
if (!$this->hasKey($app, $key)) {
$inserted = (bool) $this->conn->insertIfNotExist('*PREFIX*appconfig', [
'appid' => $app,
'configkey' => $key,
'configvalue' => $value,
], [
'appid',
'configkey',
]);
}
if (!$inserted) {
$oldValue = $this->getValue($app, $key);
if($oldValue === strval($value)) {
return;
}
$data = array(
'configvalue' => $value,
);
$where = array(
'appid' => $app,
'configkey' => $key,
);
$this->conn->update('*PREFIX*appconfig', $data, $where);
}
2014-02-07 17:03:39 +04:00
if (!isset($this->cache[$app])) {
$this->cache[$app] = array();
}
2014-06-01 16:04:17 +04:00
if (is_array($this->apps) and array_search($app, $this->apps) === false) {
$this->apps[$app] = $app;
2014-06-01 16:04:17 +04:00
}
2014-02-07 17:03:39 +04:00
$this->cache[$app][$key] = $value;
}
/**
* Deletes a key
2014-06-01 16:04:17 +04:00
*
2012-09-23 04:39:11 +04:00
* @param string $app app
* @param string $key key
* @return boolean|null
*/
2013-08-26 00:34:54 +04:00
public function deleteKey($app, $key) {
$where = array(
'appid' => $app,
'configkey' => $key,
);
$this->conn->delete('*PREFIX*appconfig', $where);
2014-02-07 17:03:39 +04:00
if (isset($this->cache[$app]) and isset($this->cache[$app][$key])) {
unset($this->cache[$app][$key]);
}
}
/**
* Remove app from appconfig
2014-06-01 16:04:17 +04:00
*
2012-09-23 04:39:11 +04:00
* @param string $app app
* @return boolean|null
*
* Removes all keys in appconfig belonging to the app.
*/
2013-08-26 00:34:54 +04:00
public function deleteApp($app) {
$where = array(
'appid' => $app,
);
$this->conn->delete('*PREFIX*appconfig', $where);
2014-02-07 17:03:39 +04:00
unset($this->cache[$app]);
unset($this->apps[$app]);
}
2012-08-29 10:38:33 +04:00
2012-04-14 19:53:02 +04:00
/**
* get multiply values, either the app or key can be used as wildcard by setting it to false
*
* @param string|false $app
* @param string|false $key
2015-01-16 21:31:15 +03:00
* @return array|false
2012-04-14 19:53:02 +04:00
*/
public function getValues($app, $key) {
2013-08-26 00:34:54 +04:00
if (($app !== false) == ($key !== false)) {
2012-04-14 19:53:02 +04:00
return false;
}
if ($app !== false) {
2014-06-01 16:14:30 +04:00
return $this->getAppValues($app);
} else {
2014-06-01 16:14:30 +04:00
$query = 'SELECT `configvalue`, `appid` FROM `*PREFIX*appconfig` WHERE `configkey` = ?';
$result = $this->conn->executeQuery($query, array($key));
2014-06-01 16:14:30 +04:00
$values = array();
while ($row = $result->fetch((\PDO::FETCH_ASSOC))) {
$values[$row['appid']] = $row['configvalue'];
}
2014-06-01 16:14:30 +04:00
return $values;
}
2012-04-14 19:53:02 +04:00
}
}