* Configuration of databasename, username and password is done
* by using conf.pl or the administrator plugin
*
- * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @copyright © 1999-2007 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
/**
* Class used to handle connections to prefs database and operations with preferences
+ *
* @package squirrelmail
* @subpackage prefs
* @since 1.1.3
+ *
*/
class dbPrefs {
/**
* @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 object
*/
var $dbh = NULL;
+
/**
* Error messages
* @var string
*/
var $error = NULL;
+
/**
* Database type (SMDB_* constants)
* Is used in setKey().
* @since 1.5.1
*/
var $user_size = 128;
+
/**
* Preference key field size
* @var integer
* @since 1.5.1
*/
var $key_size = 64;
+
/**
* Preference value field size
* @var integer
*/
var $val_size = 65536;
+
+
/**
* initialize DB connection object
+ *
* @return boolean true, if object is initialized
+ *
*/
function open() {
global $prefs_dsn, $prefs_table;
/* test if Pear DB class is available and freak out if it is not */
if (! class_exists('DB')) {
// same error also in abook_database.php
- $this->error = _("Could not include PEAR database functions required for the database backend.") . "<br />\n";
+ $this->error = _("Could not include PEAR database functions required for the database backend.") . "\n";
$this->error .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
- '<tt>DB.php</tt>') . "<br />\n";
+ 'DB.php') . "\n";
$this->error .= _("Please contact your system administrator and report this error.");
return false;
}
/**
* Function used to handle database connection errors
+ *
* @param object PEAR Error object
+ *
*/
function failQuery($res = NULL) {
if($res == NULL) {
/**
* 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
+ * @param string $key preference name
+ *
* @return boolean
+ *
*/
function deleteKey($user, $key) {
global $prefs_cache;
/**
* Set user's preference
- * @param string $user user name
- * @param string $key preference name
- * @param mixed $value preference value
+ *
+ * @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()) {
if (strlen($user) > $this->user_size) {
$this->error = "Oversized username value."
." Your preferences can't be saved."
- ." See doc/db-backend.txt or contact your system administrator.";
+ ." See the administrator's manual or contact your system administrator.";
/**
* Debugging function. Can be used to log all issues that trigger
if (strlen($key) > $this->key_size) {
$err_msg = "Oversized user's preference key."
." Some preferences were not saved."
- ." See doc/db-backend.txt or contact your system administrator.";
+ ." See the administrator's manual or contact your system administrator.";
// error is not fatal. Only some preference is not saved.
trigger_error($err_msg,E_USER_WARNING);
return false;
if (strlen($value) > $this->val_size) {
$err_msg = "Oversized user's preference value."
." Some preferences were not saved."
- ." See doc/db-backend.txt or contact your system administrator.";
+ ." See the administrator's manual or contact your system administrator.";
// error is not fatal. Only some preference is not saved.
trigger_error($err_msg,E_USER_WARNING);
return false;
/**
* Fill preference cache array
+ *
* @param string $user user name
+ *
* @since 1.2.3
+ *
*/
function fillPrefsCache($user) {
global $prefs_cache;
/**
- * returns the value for the pref $string
+ * Returns the value for the requested preference
* @ignore
*/
-function getPref($data_dir, $username, $string, $default = '') {
+function getPref($data_dir, $username, $pref_name, $default = '') {
$db = new dbPrefs;
if(isset($db->error)) {
printf( _("Preference database error (%s). Exiting abnormally"),
exit;
}
- return $db->getKey($username, $string, $default);
+ return $db->getKey($username, $pref_name, $default);
}
/**
- * Remove the pref $string
+ * Remove the desired preference setting ($pref_name)
* @ignore
*/
-function removePref($data_dir, $username, $string) {
+function removePref($data_dir, $username, $pref_name) {
global $prefs_cache;
$db = new dbPrefs;
if(isset($db->error)) {
$db->failQuery();
}
- $db->deleteKey($username, $string);
+ $db->deleteKey($username, $pref_name);
- if (isset($prefs_cache[$string])) {
- unset($prefs_cache[$string]);
+ if (isset($prefs_cache[$pref_name])) {
+ unset($prefs_cache[$pref_name]);
}
sqsession_register($prefs_cache , 'prefs_cache');
}
/**
- * sets the pref, $string, to $set_to
+ * Sets the desired preference setting ($pref_name) to whatever is in $value
* @ignore
*/
-function setPref($data_dir, $username, $string, $set_to) {
+function setPref($data_dir, $username, $pref_name, $value) {
global $prefs_cache;
- if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $set_to)) {
+ if (isset($prefs_cache[$pref_name]) && ($prefs_cache[$pref_name] == $value)) {
return;
}
- if ($set_to === '') {
- removePref($data_dir, $username, $string);
+ if ($value === '') {
+ removePref($data_dir, $username, $pref_name);
return;
}
$db->failQuery();
}
- $db->setKey($username, $string, $set_to);
- $prefs_cache[$string] = $set_to;
+ $db->setKey($username, $pref_name, $value);
+ $prefs_cache[$pref_name] = $value;
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_BAIL, 1);
- assert ('$set_to == $prefs_cache[$string]');
+ assert ('$value == $prefs_cache[$pref_name]');
sqsession_register($prefs_cache , 'prefs_cache');
return;
}
* Writes the Signature
* @ignore
*/
-function setSig($data_dir, $username, $number, $string) {
+function setSig($data_dir, $username, $number, $value) {
if ($number == "g") {
$key = '___signature___';
} else {
$key = sprintf('___sig%s___', $number);
}
- setPref($data_dir, $username, $key, $string);
+ setPref($data_dir, $username, $key, $value);
return;
}
}
return getPref($data_dir, $username, $key);
}
-
-// vim: et ts=4
-?>
\ No newline at end of file