/**
* db_prefs.php
*
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* This contains functions for manipulating user preferences
* Configuration of databasename, username and password is done
* by using conf.pl or the administrator plugin
*
- * $Id$
+ * @version $Id$
* @package squirrelmail
+ * @subpackage prefs
+ * @since 1.1.3
*/
+/** @ignore */
+if (!defined('SM_PATH')) define('SM_PATH','../');
+
/** Unknown database */
define('SMDB_UNKNOWN', 0);
/** MySQL */
/** PostgreSQL */
define('SMDB_PGSQL', 2);
-require_once('DB.php');
require_once(SM_PATH . 'config/config.php');
+if (!include_once('DB.php')) {
+ // same error also in abook_database.php
+ require_once(SM_PATH . 'functions/display_messages.php');
+ $error = _("Could not include PEAR database functions required for the database backend.") . "<br />\n";
+ $error .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
+ '<tt>DB.php</tt>') . "<br />\n";
+ $error .= _("Please contact your system administrator and report this error.");
+ error_box($error, $color);
+ exit;
+}
global $prefs_are_cached, $prefs_cache;
function cachePrefValues($username) {
global $prefs_are_cached, $prefs_cache;
+ sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION );
if ($prefs_are_cached) {
+ sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION );
return;
}
}
/**
- * Completely undocumented class - someone document it!
+ * Class used to handle connections to prefs database and operations with preferences
* @package squirrelmail
+ * @subpackage prefs
+ * @since 1.1.3
*/
class dbPrefs {
+ /**
+ * Table used to store preferences
+ * @var string
+ */
var $table = 'userprefs';
+ /**
+ * Field used to store owner of preference
+ * @var string
+ */
var $user_field = 'user';
+ /**
+ * Field used to store preference name
+ * @var string
+ */
var $key_field = 'prefkey';
+ /**
+ * Field used to store preference value
+ * @var string
+ */
var $val_field = 'prefval';
+ /**
+ * Database connection object
+ * @var object
+ */
var $dbh = NULL;
+ /**
+ * Error messages
+ * @var string
+ */
var $error = NULL;
+ /**
+ * Database type (SMDB_* constants)
+ * Is used in setKey().
+ * @var integer
+ */
var $db_type = SMDB_UNKNOWN;
+ /**
+ * Default preferences
+ * @var array
+ */
var $default = Array('theme_default' => 0,
'show_html_default' => '0');
+ /**
+ * initialize DB connection object
+ * @return boolean true, if object is initialized
+ */
function open() {
global $prefs_dsn, $prefs_table;
global $prefs_user_field, $prefs_key_field, $prefs_val_field;
return true;
}
+ /**
+ * Function used to handle database connection errors
+ * @param object PEAR Error object
+ */
function failQuery($res = NULL) {
if($res == NULL) {
printf(_("Preference database error (%s). Exiting abnormally"),
exit;
}
-
+ /**
+ * Get user's prefs setting
+ * @param string $user user name
+ * @param string $key preference name
+ * @param mixed $default (since 1.2.5) default value
+ * @return mixed preference value
+ */
function getKey($user, $key, $default = '') {
global $prefs_cache;
}
}
+ /**
+ * Delete user's prefs setting
+ * @param string $user user name
+ * @param string $key preference name
+ * @return boolean
+ */
function deleteKey($user, $key) {
global $prefs_cache;
return true;
}
+ /**
+ * Set user's preference
+ * @param string $user user name
+ * @param string $key preference name
+ * @param mixed $value preference value
+ * @return boolean
+ */
function setKey($user, $key, $value) {
if (!$this->open()) {
return false;
return true;
}
+ /**
+ * Fill preference cache array
+ * @param string $user user name
+ * @since 1.2.3
+ */
function fillPrefsCache($user) {
global $prefs_cache;
return getPref($data_dir, $username, $key);
}
+// vim: et ts=4
?>
\ No newline at end of file