mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #4624 from owncloud/convert-oc_appconfig 

Convert OC_Appconfig to object interface
This commit is contained in:
Thomas Müller 2014-02-13 15:51:40 +01:00
parent 30662fa7ac 3b1df29318
commit 4b84e3a7e8
7 changed files with 342 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

191
lib/private/appconfig.php
View File

@ -33,15 +33,56 @@
*
*/
namespace OC;
use \OC\DB\Connection;
/**
* This class provides an easy way for apps to store config values in the
* database.
*/
class OC_Appconfig {
class AppConfig implements \OCP\IAppConfig {
/**
* @var \OC\DB\Connection $conn
*/
protected $conn;
private static $cache = array();
private $cache = array();
private static $appsLoaded = array();
private $appsLoaded = array();
/**
* @param \OC\DB\Connection $conn
*/
public function __construct(Connection $conn) {
$this->conn = $conn;
}
/**
* @param string $app
* @return string[]
*/
private function getAppCache($app) {
if (!isset($this->cache[$app])) {
$this->cache[$app] = array();
}
return $this->cache[$app];
}
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;
}
/**
* @brief Get all apps using the config
@ -50,16 +91,14 @@ class OC_Appconfig {
* This function returns a list of all apps that have at least one
* entry in the appconfig table.
*/
public static function getApps() {
// No magic in here!
$query = OC_DB::prepare('SELECT DISTINCT `appid` FROM `*PREFIX*appconfig` ORDER BY `appid`');
$result = $query->execute();
public function getApps() {
$query = 'SELECT DISTINCT `appid` FROM `*PREFIX*appconfig` ORDER BY `appid`';
$result = $this->conn->executeQuery($query);
$apps = array();
while ($row = $result->fetchRow()) {
$apps[] = $row["appid"];
while ($appid = $result->fetchColumn()) {
$apps[] = $appid;
}
return $apps;
}
@ -71,35 +110,13 @@ class OC_Appconfig {
* This function gets all keys of an app. Please note that the values are
* not returned.
*/
public static function getKeys($app) {
// No magic in here as well
$query = OC_DB::prepare('SELECT `configkey` FROM `*PREFIX*appconfig` WHERE `appid` = ?');
$result = $query->execute(array($app));
$keys = array();
while ($row = $result->fetchRow()) {
$keys[] = $row["configkey"];
}
public function getKeys($app) {
$values = $this->getAppValues($app);
$keys = array_keys($values);
sort($keys);
return $keys;
}
private static function getAppValues($app) {
if (!isset(self::$cache[$app])) {
self::$cache[$app] = array();
}
if (array_search($app, self::$appsLoaded) === false) {
$query = OC_DB::prepare('SELECT `configvalue`, `configkey` FROM `*PREFIX*appconfig`'
. ' WHERE `appid` = ?');
$result = $query->execute(array($app));
while ($row = $result->fetchRow()) {
self::$cache[$app][$row['configkey']] = $row['configvalue'];
}
self::$appsLoaded[] = $app;
}
return self::$cache[$app];
}
/**
* @brief Gets the config value
* @param string $app app
@ -110,18 +127,11 @@ class OC_Appconfig {
* This function gets a value from the appconfig table. If the key does
* not exist the default value will be returned
*/
public static function getValue($app, $key, $default = null) {
if (!isset(self::$cache[$app])) {
self::$cache[$app] = array();
}
if (isset(self::$cache[$app][$key])) {
return self::$cache[$app][$key];
}
$values = self::getAppValues($app);
public function getValue($app, $key, $default = null) {
$values = $this->getAppValues($app);
if (isset($values[$key])) {
return $values[$key];
} else {
self::$cache[$app][$key] = $default;
return $default;
}
}
@ -132,12 +142,9 @@ class OC_Appconfig {
* @param string $key
* @return bool
*/
public static function hasKey($app, $key) {
if (isset(self::$cache[$app]) and isset(self::$cache[$app][$key])) {
return true;
}
$exists = self::getKeys($app);
return in_array($key, $exists);
public function hasKey($app, $key) {
$values = $this->getAppValues($app);
return isset($values[$key]);
}
/**
@ -145,31 +152,32 @@ class OC_Appconfig {
* @param string $app app
* @param string $key key
* @param string $value value
* @return bool
*
* Sets a value. If the key did not exist before it will be created.
*/
public static function setValue($app, $key, $value) {
// Does the key exist? yes: update. No: insert
if (!self::hasKey($app, $key)) {
$query = OC_DB::prepare('INSERT INTO `*PREFIX*appconfig` ( `appid`, `configkey`, `configvalue` )'
. ' VALUES( ?, ?, ? )');
$query->execute(array($app, $key, $value));
public function setValue($app, $key, $value) {
// Does the key exist? no: insert, yes: update.
if (!$this->hasKey($app, $key)) {
$data = array(
'appid' => $app,
'configkey' => $key,
'configvalue' => $value,
);
$this->conn->insert('*PREFIX*appconfig', $data);
} else {
$query = OC_DB::prepare('UPDATE `*PREFIX*appconfig` SET `configvalue` = ?'
. ' WHERE `appid` = ? AND `configkey` = ?');
$query->execute(array($value, $app, $key));
$data = array(
'configvalue' => $value,
);
$where = array(
'appid' => $app,
'configkey' => $key,
);
$this->conn->update('*PREFIX*appconfig', $data, $where);
}
// TODO where should this be documented?
\OC_Hook::emit('OC_Appconfig', 'post_set_value', array(
'app' => $app,
'key' => $key,
'value' => $value
));
if (!isset(self::$cache[$app])) {
self::$cache[$app] = array();
if (!isset($this->cache[$app])) {
$this->cache[$app] = array();
}
self::$cache[$app][$key] = $value;
$this->cache[$app][$key] = $value;
}
/**
@ -180,15 +188,15 @@ class OC_Appconfig {
*
* Deletes a key.
*/
public static function deleteKey($app, $key) {
// Boring!
$query = OC_DB::prepare('DELETE FROM `*PREFIX*appconfig` WHERE `appid` = ? AND `configkey` = ?');
$query->execute(array($app, $key));
if (isset(self::$cache[$app]) and isset(self::$cache[$app][$key])) {
unset(self::$cache[$app][$key]);
public function deleteKey($app, $key) {
$where = array(
'appid' => $app,
'configkey' => $key,
);
$this->conn->delete('*PREFIX*appconfig', $where);
if (isset($this->cache[$app]) and isset($this->cache[$app][$key])) {
unset($this->cache[$app][$key]);
}
return true;
}
/**
@ -198,13 +206,12 @@ class OC_Appconfig {
*
* Removes all keys in appconfig belonging to the app.
*/
public static function deleteApp($app) {
// Nothing special
$query = OC_DB::prepare('DELETE FROM `*PREFIX*appconfig` WHERE `appid` = ?');
$query->execute(array($app));
self::$cache[$app] = array();
return true;
public function deleteApp($app) {
$where = array(
'appid' => $app,
);
$this->conn->delete('*PREFIX*appconfig', $where);
unset($this->cache[$app]);
}
/**
@ -214,10 +221,11 @@ class OC_Appconfig {
* @param key
* @return array
*/
public static function getValues($app, $key) {
if ($app !== false and $key !== false) {
public function getValues($app, $key) {
if (($app !== false) == ($key !== false)) {
return false;
}
$fields = '`configvalue`';
$where = 'WHERE';
$params = array();
@ -232,13 +240,14 @@ class OC_Appconfig {
$params[] = $key;
$key = 'appid';
}
$queryString = 'SELECT ' . $fields . ' FROM `*PREFIX*appconfig` ' . $where;
$query = OC_DB::prepare($queryString);
$result = $query->execute($params);
$query = 'SELECT ' . $fields . ' FROM `*PREFIX*appconfig` ' . $where;
$result = $this->conn->executeQuery($query, $params);
$values = array();
while ($row = $result->fetchRow()) {
while ($row = $result->fetch((\PDO::FETCH_ASSOC))) {
$values[$row[$key]] = $row['configvalue'];
}
return $values;
}
}

3
lib/private/db/statementwrapper.php
View File

@ -31,6 +31,9 @@ class OC_DB_StatementWrapper {
/**
* make execute return the result instead of a bool
*
* @param array $input
* @return \OC_DB_StatementWrapper | int
*/
public function execute($input=array()) {
if(OC_Config::getValue( "log_query", false)) {

126
lib/private/legacy/appconfig.php Normal file
View File

@ -0,0 +1,126 @@
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @author Jakob Sack
* @copyright 2012 Frank Karlitschek frank@owncloud.org
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* This class provides an easy way for apps to store config values in the
* database.
*/
class OC_Appconfig {
/**
* @return \OCP\IAppConfig
*/
private static function getAppConfig() {
return \OC::$server->getAppConfig();
}
/**
* @brief Get all apps using the config
* @return array with app ids
*
* This function returns a list of all apps that have at least one
* entry in the appconfig table.
*/
public static function getApps() {
return self::getAppConfig()->getApps();
}
/**
* @brief Get the available keys for an app
* @param string $app the app we are looking for
* @return array with key names
*
* This function gets all keys of an app. Please note that the values are
* not returned.
*/
public static function getKeys($app) {
return self::getAppConfig()->getKeys($app);
}
/**
* @brief 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 static function getValue($app, $key, $default = null) {
return self::getAppConfig()->getValue($app, $key, $default);
}
/**
* @brief check if a key is set in the appconfig
* @param string $app
* @param string $key
* @return bool
*/
public static function hasKey($app, $key) {
return self::getAppConfig()->hasKey($app, $key);
}
/**
* @brief sets a value in the appconfig
* @param string $app app
* @param string $key key
* @param string $value value
*
* Sets a value. If the key did not exist before it will be created.
*/
public static function setValue($app, $key, $value) {
self::getAppConfig()->setValue($app, $key, $value);
}
/**
* @brief Deletes a key
* @param string $app app
* @param string $key key
*
* Deletes a key.
*/
public static function deleteKey($app, $key) {
self::getAppConfig()->deleteKey($app, $key);
}
/**
* @brief Remove app from appconfig
* @param string $app app
*
* Removes all keys in appconfig belonging to the app.
*/
public static function deleteApp($app) {
self::getAppConfig()->deleteApp($app);
}
/**
* get multiply values, either the app or key can be used as wildcard by setting it to false
*
* @param app
* @param key
* @return array
*/
public static function getValues($app, $key) {
return self::getAppConfig()->getValues($app, $key);
}
}

12
lib/private/server.php
View File

@ -124,6 +124,9 @@ class Server extends SimpleContainer implements IServerContainer {
$this->registerService('AllConfig', function($c) {
return new \OC\AllConfig();
});
$this->registerService('AppConfig', function ($c) {
return new \OC\AppConfig(\OC_DB::getConnection());
});
$this->registerService('L10NFactory', function($c) {
return new \OC\L10N\Factory();
});
@ -269,6 +272,15 @@ class Server extends SimpleContainer implements IServerContainer {
return $this->query('AllConfig');
}
/**
* Returns the app config manager
*
* @return \OCP\IAppConfig
*/
function getAppConfig(){
return $this->query('AppConfig');
}
/**
* get an L10N instance
* @param $app string appid

91
lib/public/iappconfig.php Normal file
View File

@ -0,0 +1,91 @@
<?php
/**
* Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OCP;
/**
* This class provides an easy way for apps to store config values in the
* database.
*/
interface IAppConfig {
/**
* @brief check if a key is set in the appconfig
* @param string $app
* @param string $key
* @return bool
*/
public function hasKey($app, $key);
/**
* @brief 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);
/**
* @brief Deletes a key
* @param string $app app
* @param string $key key
* @return bool
*
* Deletes a key.
*/
public function deleteKey($app, $key);
/**
* @brief Get the available keys for an app
* @param string $app the app we are looking for
* @return array with key names
*
* This function gets all keys of an app. Please note that the values are
* not returned.
*/
public function getKeys($app);
/**
* get multiply values, either the app or key can be used as wildcard by setting it to false
*
* @param app
* @param key
* @return array
*/
public function getValues($app, $key);
/**
* @brief sets a value in the appconfig
* @param string $app app
* @param string $key key
* @param string $value value
*
* Sets a value. If the key did not exist before it will be created.
*/
public function setValue($app, $key, $value);
/**
* @brief Get all apps using the config
* @return array with app ids
*
* This function returns a list of all apps that have at least one
* entry in the appconfig table.
*/
public function getApps();
/**
* @brief Remove app from appconfig
* @param string $app app
* @return bool
*
* Removes all keys in appconfig belonging to the app.
*/
public function deleteApp($app);
}

7
lib/public/iservercontainer.php
View File

@ -113,6 +113,13 @@ interface IServerContainer {
*/
function getConfig();
/**
* Returns the app config manager
*
* @return \OCP\IAppConfig
*/
function getAppConfig();
/**
* get an L10N instance
* @param $app string appid

3
tests/lib/appconfig.php
View File

@ -1,6 +1,7 @@
<?php
/**
* Copyright (c) 2013 Christopher Schäpers <christopher@schaepers.it>
* Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
@ -41,6 +42,7 @@ class Test_Appconfig extends PHPUnit_Framework_TestCase {
while ($row = $result->fetchRow()) {
$expected[] = $row['appid'];
}
sort($expected);
$apps = \OC_Appconfig::getApps();
$this->assertEquals($expected, $apps);
}
@ -52,6 +54,7 @@ class Test_Appconfig extends PHPUnit_Framework_TestCase {
while($row = $result->fetchRow()) {
$expected[] = $row["configkey"];
}
sort($expected);
$keys = \OC_Appconfig::getKeys('testapp');
$this->assertEquals($expected, $keys);
}