X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fdb_prefs.php;h=fe1d4253e764f6cfa7b1a0723747bae7e3e5a876;hb=ace4c62c1999df7206731e637594f2da98bd52a8;hp=3708441dac832583a3940c7b3b4e595e663ece04;hpb=1c159927990ad2cfc7b44abb7102437383263e74;p=squirrelmail.git
diff --git a/functions/db_prefs.php b/functions/db_prefs.php
index 3708441d..fe1d4253 100644
--- a/functions/db_prefs.php
+++ b/functions/db_prefs.php
@@ -1,9 +1,9 @@
\n";
+ $error .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
+ 'DB.php') . "
\n";
+ $error .= _("Please contact your system administrator and report this error.");
+ error_box($error, $color);
+ exit;
+}
global $prefs_are_cached, $prefs_cache;
+/**
+ * @ignore
+ */
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;
}
@@ -67,19 +90,62 @@ function cachePrefValues($username) {
sqsession_register($prefs_are_cached, 'prefs_are_cached');
}
+/**
+ * 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;
@@ -117,6 +183,10 @@ class dbPrefs {
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"),
@@ -128,7 +198,13 @@ class dbPrefs {
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;
@@ -145,6 +221,12 @@ class dbPrefs {
}
}
+ /**
+ * Delete user's prefs setting
+ * @param string $user user name
+ * @param string $key preference name
+ * @return boolean
+ */
function deleteKey($user, $key) {
global $prefs_cache;
@@ -168,6 +250,13 @@ class dbPrefs {
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;
@@ -242,6 +331,11 @@ class dbPrefs {
return true;
}
+ /**
+ * Fill preference cache array
+ * @param string $user user name
+ * @since 1.2.3
+ */
function fillPrefsCache($user) {
global $prefs_cache;
@@ -270,7 +364,10 @@ class dbPrefs {
} /* end class dbPrefs */
-/* returns the value for the pref $string */
+/**
+ * returns the value for the pref $string
+ * @ignore
+ */
function getPref($data_dir, $username, $string, $default = '') {
$db = new dbPrefs;
if(isset($db->error)) {
@@ -282,18 +379,31 @@ function getPref($data_dir, $username, $string, $default = '') {
return $db->getKey($username, $string, $default);
}
-/* Remove the pref $string */
+/**
+ * Remove the pref $string
+ * @ignore
+ */
function removePref($data_dir, $username, $string) {
+ global $prefs_cache;
$db = new dbPrefs;
if(isset($db->error)) {
$db->failQuery();
}
$db->deleteKey($username, $string);
+
+ if (isset($prefs_cache[$string])) {
+ unset($prefs_cache[$string]);
+ }
+
+ sqsession_register($prefs_cache , 'prefs_cache');
return;
}
-/* sets the pref, $string, to $set_to */
+/**
+ * sets the pref, $string, to $set_to
+ * @ignore
+ */
function setPref($data_dir, $username, $string, $set_to) {
global $prefs_cache;
@@ -301,7 +411,7 @@ function setPref($data_dir, $username, $string, $set_to) {
return;
}
- if ($set_to == '') {
+ if ($set_to === '') {
removePref($data_dir, $username, $string);
return;
}
@@ -316,11 +426,14 @@ function setPref($data_dir, $username, $string, $set_to) {
assert_options(ASSERT_ACTIVE, 1);
assert_options(ASSERT_BAIL, 1);
assert ('$set_to == $prefs_cache[$string]');
-
+ sqsession_register($prefs_cache , 'prefs_cache');
return;
}
-/* This checks if the prefs are available */
+/**
+ * This checks if the prefs are available
+ * @ignore
+ */
function checkForPrefs($data_dir, $username) {
$db = new dbPrefs;
if(isset($db->error)) {
@@ -328,7 +441,10 @@ function checkForPrefs($data_dir, $username) {
}
}
-/* Writes the Signature */
+/**
+ * Writes the Signature
+ * @ignore
+ */
function setSig($data_dir, $username, $number, $string) {
if ($number == "g") {
$key = '___signature___';
@@ -339,7 +455,10 @@ function setSig($data_dir, $username, $number, $string) {
return;
}
-/* Gets the signature */
+/**
+ * Gets the signature
+ * @ignore
+ */
function getSig($data_dir, $username, $number) {
if ($number == "g") {
$key = '___signature___';
@@ -349,4 +468,5 @@ function getSig($data_dir, $username, $number) {
return getPref($data_dir, $username, $key);
}
-?>
+// vim: et ts=4
+?>
\ No newline at end of file