nextcloud/lib/appconfig.php

204 lines
5.3 KiB
PHP
Raw Normal View History

<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @author Jakob Sack
2012-05-26 21:14:24 +04:00
* @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/>.
*
*/
/*
*
* 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
* )
*
*/
/**
* This class provides an easy way for apps to store config values in the
* database.
*/
2011-07-29 23:36:03 +04:00
class OC_Appconfig{
/**
* @brief Get all apps using the config
2012-09-23 04:39:11 +04:00
* @return array with app ids
*
* This function returns a list of all apps that have at least one
* entry in the appconfig table.
*/
2012-09-07 17:22:01 +04:00
public static function getApps() {
// No magic in here!
2012-07-30 22:46:14 +04:00
$query = OC_DB::prepare( 'SELECT DISTINCT `appid` FROM `*PREFIX*appconfig`' );
$result = $query->execute();
$apps = array();
2012-09-07 17:22:01 +04:00
while( $row = $result->fetchRow()) {
$apps[] = $row["appid"];
}
return $apps;
}
/**
* @brief Get the available keys for an app
2012-09-23 04:39:11 +04:00
* @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.
*/
2012-09-07 17:22:01 +04:00
public static function getKeys( $app ) {
// No magic in here as well
2012-07-30 22:46:14 +04:00
$query = OC_DB::prepare( 'SELECT `configkey` FROM `*PREFIX*appconfig` WHERE `appid` = ?' );
2011-04-15 21:24:23 +04:00
$result = $query->execute( array( $app ));
$keys = array();
2012-09-07 17:22:01 +04:00
while( $row = $result->fetchRow()) {
$keys[] = $row["configkey"];
}
return $keys;
}
/**
* @brief Gets the config value
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
*/
2012-09-07 17:22:01 +04:00
public static function getValue( $app, $key, $default = null ) {
// At least some magic in here :-)
2013-02-11 20:44:02 +04:00
$query = OC_DB::prepare( 'SELECT `configvalue` FROM `*PREFIX*appconfig`'
.' WHERE `appid` = ? AND `configkey` = ?' );
2011-04-15 21:24:23 +04:00
$result = $query->execute( array( $app, $key ));
$row = $result->fetchRow();
2012-09-07 17:22:01 +04:00
if($row) {
return $row["configvalue"];
}else{
return $default;
}
}
2012-08-29 10:38:33 +04:00
2011-10-02 16:30:51 +04:00
/**
* @brief check if a key is set in the appconfig
* @param string $app
* @param string $key
* @return bool
*/
2012-11-02 22:53:02 +04:00
public static function hasKey($app, $key) {
2011-10-02 16:30:51 +04:00
$exists = self::getKeys( $app );
return in_array( $key, $exists );
}
2012-08-29 10:38:33 +04:00
/**
* @brief sets a value in the appconfig
2012-09-23 04:39:11 +04:00
* @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.
*/
2012-09-07 17:22:01 +04:00
public static function setValue( $app, $key, $value ) {
// Does the key exist? yes: update. No: insert
if(! self::hasKey($app, $key)) {
2013-02-11 20:44:02 +04:00
$query = OC_DB::prepare( 'INSERT INTO `*PREFIX*appconfig` ( `appid`, `configkey`, `configvalue` )'
.' VALUES( ?, ?, ? )' );
2011-04-15 21:24:23 +04:00
$query->execute( array( $app, $key, $value ));
}
else{
2013-02-11 20:44:02 +04:00
$query = OC_DB::prepare( 'UPDATE `*PREFIX*appconfig` SET `configvalue` = ?'
.' WHERE `appid` = ? AND `configkey` = ?' );
2011-04-15 21:24:23 +04:00
$query->execute( array( $value, $app, $key ));
}
}
/**
* @brief Deletes a key
2012-09-23 04:39:11 +04:00
* @param string $app app
* @param string $key key
* @return bool
*
* Deletes a key.
*/
2012-09-07 17:22:01 +04:00
public static function deleteKey( $app, $key ) {
// Boring!
2012-07-30 22:46:14 +04:00
$query = OC_DB::prepare( 'DELETE FROM `*PREFIX*appconfig` WHERE `appid` = ? AND `configkey` = ?' );
2011-04-15 21:24:23 +04:00
$query->execute( array( $app, $key ));
return true;
}
/**
* @brief Remove app from appconfig
2012-09-23 04:39:11 +04:00
* @param string $app app
* @return bool
*
* Removes all keys in appconfig belonging to the app.
*/
2012-09-07 17:22:01 +04:00
public static function deleteApp( $app ) {
// Nothing special
2012-07-30 22:46:14 +04:00
$query = OC_DB::prepare( 'DELETE FROM `*PREFIX*appconfig` WHERE `appid` = ?' );
2011-04-15 21:24:23 +04:00
$query->execute( array( $app ));
return true;
}
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 app
* @param key
* @return array
*/
2012-11-02 22:53:02 +04:00
public static function getValues($app, $key) {
2012-09-07 17:22:01 +04:00
if($app!==false and $key!==false) {
2012-04-14 19:53:02 +04:00
return false;
}
2012-07-30 22:46:14 +04:00
$fields='`configvalue`';
2012-08-02 00:38:27 +04:00
$where='WHERE';
2012-04-14 19:53:02 +04:00
$params=array();
2012-09-07 17:22:01 +04:00
if($app!==false) {
2012-07-30 22:46:14 +04:00
$fields.=', `configkey`';
2012-08-02 00:38:27 +04:00
$where.=' `appid` = ?';
2012-04-14 19:53:02 +04:00
$params[]=$app;
$key='configkey';
}else{
2012-07-30 22:46:14 +04:00
$fields.=', `appid`';
$where.=' `configkey` = ?';
2012-04-14 19:53:02 +04:00
$params[]=$key;
$key='appid';
}
2012-07-30 22:46:14 +04:00
$queryString='SELECT '.$fields.' FROM `*PREFIX*appconfig` '.$where;
2012-04-14 19:53:02 +04:00
$query=OC_DB::prepare($queryString);
$result=$query->execute($params);
$values=array();
2012-09-07 17:22:01 +04:00
while($row=$result->fetchRow()) {
2012-04-14 19:53:02 +04:00
$values[$row[$key]]=$row['configvalue'];
}
return $values;
}
}