nextcloud/lib/private/preferences.php

282 lines
6.7 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 `preferences` (
* `userid` VARCHAR( 255 ) NOT NULL ,
* `appid` VARCHAR( 255 ) NOT NULL ,
* `configkey` VARCHAR( 255 ) NOT NULL ,
* `configvalue` VARCHAR( 255 ) NOT NULL
* )
*
*/
namespace OC;
use \OC\DB\Connection;
/**
* This class provides an easy way for storing user preferences.
*/
class Preferences {
2014-02-18 14:20:16 +04:00
/**
* @var \OC\DB\Connection
*/
protected $conn;
2014-02-18 14:20:16 +04:00
/**
2014-02-18 17:26:27 +04:00
* 3 dimensional array with the following structure:
* [ $userId =>
* [ $appId =>
* [ $key => $value ]
* ]
* ]
*
2014-02-18 14:20:16 +04:00
* @var array $cache
*/
protected $cache = array();
/**
* @param \OC\DB\Connection $conn
*/
public function __construct(Connection $conn) {
$this->conn = $conn;
}
/**
* @brief Get all users using the preferences
2012-09-23 04:39:11 +04:00
* @return array with user ids
*
* This function returns a list of all users that have at least one entry
* in the preferences table.
*/
public function getUsers() {
$query = 'SELECT DISTINCT `userid` FROM `*PREFIX*preferences`';
2014-02-18 14:20:16 +04:00
$result = $this->conn->executeQuery($query);
$users = array();
2014-02-18 14:20:16 +04:00
while ($userid = $result->fetchColumn()) {
$users[] = $userid;
}
return $users;
}
2014-02-18 17:26:27 +04:00
/**
* @param string $user
2014-02-18 14:20:16 +04:00
* @return array[]
*/
protected function getUserValues($user) {
if (isset($this->cache[$user])) {
return $this->cache[$user];
}
$data = array();
$query = 'SELECT `appid`, `configkey`, `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?';
$result = $this->conn->executeQuery($query, array($user));
while ($row = $result->fetch()) {
$app = $row['appid'];
if (!isset($data[$app])) {
$data[$app] = array();
}
$data[$app][$row['configkey']] = $row['configvalue'];
}
$this->cache[$user] = $data;
return $data;
}
/**
2013-07-16 07:56:52 +04:00
* @brief Get all apps of an user
2012-09-23 04:39:11 +04:00
* @param string $user user
* @return integer[] with app ids
*
2011-09-26 23:18:37 +04:00
* This function returns a list of all apps of the user that have at least
* one entry in the preferences table.
*/
2014-02-18 14:20:16 +04:00
public function getApps($user) {
$data = $this->getUserValues($user);
return array_keys($data);
}
/**
* @brief Get the available keys for an app
2012-09-23 04:39:11 +04:00
* @param string $user user
* @param string $app the app we are looking for
* @return array with key names
*
* This function gets all keys of an app of an user. Please note that the
* values are not returned.
*/
2014-02-18 14:20:16 +04:00
public function getKeys($user, $app) {
$data = $this->getUserValues($user);
if (isset($data[$app])) {
return array_keys($data[$app]);
} else {
return array();
}
}
/**
* @brief Gets the preference
2012-09-23 04:39:11 +04:00
* @param string $user user
* @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
*
2012-09-23 04:39:11 +04:00
* This function gets a value from the preferences table. If the key does
* not exist the default value will be returned
*/
2014-02-18 14:20:16 +04:00
public function getValue($user, $app, $key, $default = null) {
$data = $this->getUserValues($user);
if (isset($data[$app]) and isset($data[$app][$key])) {
return $data[$app][$key];
} else {
return $default;
}
}
/**
* @brief sets a value in the preferences
2012-09-23 04:39:11 +04:00
* @param string $user user
* @param string $app app
* @param string $key key
* @param string $value value
*
* Adds a value to the preferences. If the key did not exist before, it
* will be added automagically.
*/
2014-02-18 14:20:16 +04:00
public function setValue($user, $app, $key, $value) {
// Check if the key does exist
$query = 'SELECT COUNT(*) FROM `*PREFIX*preferences`'
2014-02-18 14:20:16 +04:00
. ' WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?';
$count = $this->conn->fetchColumn($query, array($user, $app, $key));
$exists = $count > 0;
2014-02-18 14:20:16 +04:00
if (!$exists) {
$data = array(
'userid' => $user,
'appid' => $app,
'configkey' => $key,
'configvalue' => $value,
);
$this->conn->insert('*PREFIX*preferences', $data);
} else {
$data = array(
'configvalue' => $value,
);
$where = array(
'userid' => $user,
'appid' => $app,
'configkey' => $key,
);
$this->conn->update('*PREFIX*preferences', $data, $where);
}
2014-02-18 14:20:16 +04:00
// only add to the cache if we already loaded data for the user
if (isset($this->cache[$user])) {
if (!isset($this->cache[$user][$app])) {
$this->cache[$user][$app] = array();
}
$this->cache[$user][$app][$key] = $value;
}
}
/**
* @brief Deletes a key
2012-09-23 04:39:11 +04:00
* @param string $user user
* @param string $app app
* @param string $key key
*
* Deletes a key.
*/
2014-02-18 14:20:16 +04:00
public function deleteKey($user, $app, $key) {
$where = array(
'userid' => $user,
'appid' => $app,
'configkey' => $key,
);
$this->conn->delete('*PREFIX*preferences', $where);
2014-02-18 14:20:16 +04:00
2014-02-18 17:27:55 +04:00
if (isset($this->cache[$user]) and isset($this->cache[$user][$app])) {
2014-02-18 14:20:16 +04:00
unset($this->cache[$user][$app][$key]);
}
}
/**
* @brief Remove app of user from preferences
2012-09-23 04:39:11 +04:00
* @param string $user user
* @param string $app app
*
* Removes all keys in preferences belonging to the app and the user.
*/
2014-02-18 14:20:16 +04:00
public function deleteApp($user, $app) {
$where = array(
'userid' => $user,
'appid' => $app,
);
$this->conn->delete('*PREFIX*preferences', $where);
2014-02-18 14:20:16 +04:00
2014-02-18 17:27:55 +04:00
if (isset($this->cache[$user])) {
2014-02-18 14:20:16 +04:00
unset($this->cache[$user][$app]);
}
}
/**
* @brief Remove user from preferences
2012-09-23 04:39:11 +04:00
* @param string $user user
*
* Removes all keys in preferences belonging to the user.
*/
2014-02-18 14:20:16 +04:00
public function deleteUser($user) {
$where = array(
'userid' => $user,
);
$this->conn->delete('*PREFIX*preferences', $where);
2014-02-18 14:20:16 +04:00
2014-02-18 17:27:55 +04:00
unset($this->cache[$user]);
}
/**
* @brief Remove app from all users
2012-09-23 04:39:11 +04:00
* @param string $app app
*
* Removes all keys in preferences belonging to the app.
*/
2014-02-18 14:20:16 +04:00
public function deleteAppFromAllUsers($app) {
$where = array(
'appid' => $app,
);
$this->conn->delete('*PREFIX*preferences', $where);
2014-02-18 14:20:16 +04:00
foreach ($this->cache as &$userCache) {
unset($userCache[$app]);
}
}
}
2014-02-18 14:20:16 +04:00
require_once __DIR__ . '/legacy/' . basename(__FILE__);