2011-03-01 23:20:16 +01:00
|
|
|
<?php
|
2011-03-12 10:28:10 +01:00
|
|
|
/**
|
|
|
|
* ownCloud
|
|
|
|
*
|
|
|
|
* @author Frank Karlitschek
|
|
|
|
* @author Jakob Sack
|
2012-05-26 19:14:24 +02:00
|
|
|
* @copyright 2012 Frank Karlitschek frank@owncloud.org
|
2011-03-12 10:28:10 +01:00
|
|
|
*
|
|
|
|
* 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/>.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
/*
|
|
|
|
*
|
|
|
|
* The following SQL statement is just a help for developers and will not be
|
|
|
|
* executed!
|
|
|
|
*
|
|
|
|
* CREATE TABLE `appconfig` (
|
|
|
|
* `appid` VARCHAR( 255 ) NOT NULL ,
|
2011-05-15 15:03:12 +02:00
|
|
|
* `configkey` VARCHAR( 255 ) NOT NULL ,
|
|
|
|
* `configvalue` VARCHAR( 255 ) NOT NULL
|
2011-03-12 10:28:10 +01:00
|
|
|
* )
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This class provides an easy way for apps to store config values in the
|
|
|
|
* database.
|
|
|
|
*/
|
2011-07-29 21:36:03 +02:00
|
|
|
class OC_Appconfig{
|
2011-03-01 23:20:16 +01:00
|
|
|
/**
|
2011-03-12 10:28:10 +01:00
|
|
|
* @brief Get all apps using the config
|
2012-09-23 02:39:11 +02:00
|
|
|
* @return array with app ids
|
2011-03-12 10:28:10 +01:00
|
|
|
*
|
|
|
|
* This function returns a list of all apps that have at least one
|
|
|
|
* entry in the appconfig table.
|
2011-03-01 23:20:16 +01:00
|
|
|
*/
|
2012-09-07 15:22:01 +02:00
|
|
|
public static function getApps() {
|
2011-04-08 16:54:12 +02:00
|
|
|
// No magic in here!
|
2012-07-30 20:46:14 +02:00
|
|
|
$query = OC_DB::prepare( 'SELECT DISTINCT `appid` FROM `*PREFIX*appconfig`' );
|
2011-04-08 16:54:12 +02:00
|
|
|
$result = $query->execute();
|
|
|
|
|
|
|
|
$apps = array();
|
2012-09-07 15:22:01 +02:00
|
|
|
while( $row = $result->fetchRow()) {
|
2011-04-08 16:54:12 +02:00
|
|
|
$apps[] = $row["appid"];
|
|
|
|
}
|
|
|
|
|
|
|
|
return $apps;
|
2011-03-01 23:20:16 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2011-03-12 10:28:10 +01:00
|
|
|
* @brief Get the available keys for an app
|
2012-09-23 02:39:11 +02:00
|
|
|
* @param string $app the app we are looking for
|
|
|
|
* @return array with key names
|
2011-03-12 10:28:10 +01:00
|
|
|
*
|
|
|
|
* This function gets all keys of an app. Please note that the values are
|
|
|
|
* not returned.
|
2011-03-01 23:20:16 +01:00
|
|
|
*/
|
2012-09-07 15:22:01 +02:00
|
|
|
public static function getKeys( $app ) {
|
2011-04-08 16:54:12 +02:00
|
|
|
// No magic in here as well
|
2012-07-30 20:46:14 +02:00
|
|
|
$query = OC_DB::prepare( 'SELECT `configkey` FROM `*PREFIX*appconfig` WHERE `appid` = ?' );
|
2011-04-15 19:24:23 +02:00
|
|
|
$result = $query->execute( array( $app ));
|
2011-04-08 16:54:12 +02:00
|
|
|
|
|
|
|
$keys = array();
|
2012-09-07 15:22:01 +02:00
|
|
|
while( $row = $result->fetchRow()) {
|
2011-05-15 15:03:12 +02:00
|
|
|
$keys[] = $row["configkey"];
|
2011-04-08 16:54:12 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return $keys;
|
2011-03-12 10:28:10 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Gets the config value
|
2012-09-23 02:39:11 +02: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
|
2011-03-12 10:28:10 +01:00
|
|
|
*
|
|
|
|
* This function gets a value from the appconfig table. If the key does
|
2012-09-23 02:39:11 +02:00
|
|
|
* not exist the default value will be returned
|
2011-03-12 10:28:10 +01:00
|
|
|
*/
|
2012-09-07 15:22:01 +02:00
|
|
|
public static function getValue( $app, $key, $default = null ) {
|
2011-04-08 16:54:12 +02:00
|
|
|
// At least some magic in here :-)
|
2013-02-11 17:44:02 +01:00
|
|
|
$query = OC_DB::prepare( 'SELECT `configvalue` FROM `*PREFIX*appconfig`'
|
|
|
|
.' WHERE `appid` = ? AND `configkey` = ?' );
|
2011-04-15 19:24:23 +02:00
|
|
|
$result = $query->execute( array( $app, $key ));
|
2011-09-17 02:36:04 +02:00
|
|
|
$row = $result->fetchRow();
|
2012-09-07 15:22:01 +02:00
|
|
|
if($row) {
|
2011-09-17 02:36:04 +02:00
|
|
|
return $row["configvalue"];
|
|
|
|
}else{
|
2011-04-08 16:54:12 +02:00
|
|
|
return $default;
|
|
|
|
}
|
2011-03-01 23:20:16 +01:00
|
|
|
}
|
2012-08-29 08:38:33 +02:00
|
|
|
|
2011-10-02 14:30:51 +02:00
|
|
|
/**
|
|
|
|
* @brief check if a key is set in the appconfig
|
|
|
|
* @param string $app
|
|
|
|
* @param string $key
|
|
|
|
* @return bool
|
|
|
|
*/
|
2012-11-02 19:53:02 +01:00
|
|
|
public static function hasKey($app, $key) {
|
2011-10-02 14:30:51 +02:00
|
|
|
$exists = self::getKeys( $app );
|
|
|
|
return in_array( $key, $exists );
|
|
|
|
}
|
2012-08-29 08:38:33 +02:00
|
|
|
|
2011-03-01 23:20:16 +01:00
|
|
|
/**
|
2011-03-12 10:28:10 +01:00
|
|
|
* @brief sets a value in the appconfig
|
2012-09-23 02:39:11 +02:00
|
|
|
* @param string $app app
|
|
|
|
* @param string $key key
|
|
|
|
* @param string $value value
|
|
|
|
* @return bool
|
2011-03-12 10:28:10 +01:00
|
|
|
*
|
|
|
|
* Sets a value. If the key did not exist before it will be created.
|
2011-03-01 23:20:16 +01:00
|
|
|
*/
|
2012-09-07 15:22:01 +02:00
|
|
|
public static function setValue( $app, $key, $value ) {
|
2011-04-08 16:54:12 +02:00
|
|
|
// Does the key exist? yes: update. No: insert
|
2012-10-23 00:28:12 +02:00
|
|
|
if(! self::hasKey($app, $key)) {
|
2013-02-11 17:44:02 +01:00
|
|
|
$query = OC_DB::prepare( 'INSERT INTO `*PREFIX*appconfig` ( `appid`, `configkey`, `configvalue` )'
|
|
|
|
.' VALUES( ?, ?, ? )' );
|
2011-04-15 19:24:23 +02:00
|
|
|
$query->execute( array( $app, $key, $value ));
|
2011-04-08 16:54:12 +02:00
|
|
|
}
|
|
|
|
else{
|
2013-02-11 17:44:02 +01:00
|
|
|
$query = OC_DB::prepare( 'UPDATE `*PREFIX*appconfig` SET `configvalue` = ?'
|
|
|
|
.' WHERE `appid` = ? AND `configkey` = ?' );
|
2011-04-15 19:24:23 +02:00
|
|
|
$query->execute( array( $value, $app, $key ));
|
2011-04-08 16:54:12 +02:00
|
|
|
}
|
2011-03-12 10:28:10 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Deletes a key
|
2012-09-23 02:39:11 +02:00
|
|
|
* @param string $app app
|
|
|
|
* @param string $key key
|
|
|
|
* @return bool
|
2011-03-12 10:28:10 +01:00
|
|
|
*
|
|
|
|
* Deletes a key.
|
|
|
|
*/
|
2012-09-07 15:22:01 +02:00
|
|
|
public static function deleteKey( $app, $key ) {
|
2011-04-08 16:54:12 +02:00
|
|
|
// Boring!
|
2012-07-30 20:46:14 +02:00
|
|
|
$query = OC_DB::prepare( 'DELETE FROM `*PREFIX*appconfig` WHERE `appid` = ? AND `configkey` = ?' );
|
2011-04-15 19:24:23 +02:00
|
|
|
$query->execute( array( $app, $key ));
|
2011-04-08 16:54:12 +02:00
|
|
|
|
2011-03-12 10:28:10 +01:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Remove app from appconfig
|
2012-09-23 02:39:11 +02:00
|
|
|
* @param string $app app
|
|
|
|
* @return bool
|
2011-03-12 10:28:10 +01:00
|
|
|
*
|
|
|
|
* Removes all keys in appconfig belonging to the app.
|
|
|
|
*/
|
2012-09-07 15:22:01 +02:00
|
|
|
public static function deleteApp( $app ) {
|
2011-04-08 16:54:12 +02:00
|
|
|
// Nothing special
|
2012-07-30 20:46:14 +02:00
|
|
|
$query = OC_DB::prepare( 'DELETE FROM `*PREFIX*appconfig` WHERE `appid` = ?' );
|
2011-04-15 19:24:23 +02:00
|
|
|
$query->execute( array( $app ));
|
2011-04-08 16:54:12 +02:00
|
|
|
|
2011-03-01 23:20:16 +01:00
|
|
|
return true;
|
|
|
|
}
|
2012-08-29 08:38:33 +02:00
|
|
|
|
2012-04-14 17:53:02 +02:00
|
|
|
/**
|
|
|
|
* get multiply values, either the app or key can be used as wildcard by setting it to false
|
|
|
|
* @param app
|
|
|
|
* @param key
|
|
|
|
* @return array
|
|
|
|
*/
|
2012-11-02 19:53:02 +01:00
|
|
|
public static function getValues($app, $key) {
|
2012-09-07 15:22:01 +02:00
|
|
|
if($app!==false and $key!==false) {
|
2012-04-14 17:53:02 +02:00
|
|
|
return false;
|
|
|
|
}
|
2012-07-30 20:46:14 +02:00
|
|
|
$fields='`configvalue`';
|
2012-08-01 22:38:27 +02:00
|
|
|
$where='WHERE';
|
2012-04-14 17:53:02 +02:00
|
|
|
$params=array();
|
2012-09-07 15:22:01 +02:00
|
|
|
if($app!==false) {
|
2012-07-30 20:46:14 +02:00
|
|
|
$fields.=', `configkey`';
|
2012-08-01 22:38:27 +02:00
|
|
|
$where.=' `appid` = ?';
|
2012-04-14 17:53:02 +02:00
|
|
|
$params[]=$app;
|
|
|
|
$key='configkey';
|
|
|
|
}else{
|
2012-07-30 20:46:14 +02:00
|
|
|
$fields.=', `appid`';
|
|
|
|
$where.=' `configkey` = ?';
|
2012-04-14 17:53:02 +02:00
|
|
|
$params[]=$key;
|
|
|
|
$key='appid';
|
|
|
|
}
|
2012-07-30 20:46:14 +02:00
|
|
|
$queryString='SELECT '.$fields.' FROM `*PREFIX*appconfig` '.$where;
|
2012-04-14 17:53:02 +02:00
|
|
|
$query=OC_DB::prepare($queryString);
|
|
|
|
$result=$query->execute($params);
|
|
|
|
$values=array();
|
2012-09-07 15:22:01 +02:00
|
|
|
while($row=$result->fetchRow()) {
|
2012-04-14 17:53:02 +02:00
|
|
|
$values[$row[$key]]=$row['configvalue'];
|
|
|
|
}
|
|
|
|
return $values;
|
|
|
|
}
|
2011-03-01 23:20:16 +01:00
|
|
|
}
|