X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fdb_prefs.php;h=71422f1345587e04353774889f6efdb096091d7e;hp=26c2ac2ef94a36bf87e08659f482b4e1fb986ab7;hb=cf088f55b6943a4db1d1bf5abe7904670186ce33;hpb=6c99d1de81366bceab6c9d6cf12179eedc81f9bc
diff --git a/functions/db_prefs.php b/functions/db_prefs.php
index 26c2ac2e..71422f13 100644
--- a/functions/db_prefs.php
+++ b/functions/db_prefs.php
@@ -21,7 +21,7 @@
* 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
@@ -84,9 +84,11 @@ function cachePrefValues($username) {
/**
* Class used to handle connections to prefs database and operations with preferences
+ *
* @package squirrelmail
* @subpackage prefs
* @since 1.1.3
+ *
*/
class dbPrefs {
/**
@@ -94,16 +96,19 @@ 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
@@ -115,11 +120,13 @@ class dbPrefs {
* @var object
*/
var $dbh = NULL;
+
/**
* Error messages
* @var string
*/
var $error = NULL;
+
/**
* Database type (SMDB_* constants)
* Is used in setKey().
@@ -140,12 +147,14 @@ class dbPrefs {
* @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
@@ -153,9 +162,34 @@ class dbPrefs {
*/
var $val_size = 65536;
+
+
+ /**
+ * initialize the default preferences array.
+ *
+ */
+ function dbPrefs() {
+ // Try and read the default preferences file.
+ $default_pref = SM_PATH . 'config/default_pref';
+ if (@file_exists($default_pref)) {
+ if ($file = @fopen($default_pref, 'r')) {
+ while (!feof($file)) {
+ $pref = fgets($file, 1024);
+ $i = strpos($pref, '=');
+ if ($i > 0) {
+ $this->default[trim(substr($pref, 0, $i))] = trim(substr($pref, $i + 1));
+ }
+ }
+ fclose($file);
+ }
+ }
+ }
+
/**
* initialize DB connection object
+ *
* @return boolean true, if object is initialized
+ *
*/
function open() {
global $prefs_dsn, $prefs_table;
@@ -165,9 +199,9 @@ class dbPrefs {
/* 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.") . "
\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?"),
- 'DB.php') . "
\n";
+ 'DB.php') . "\n";
$this->error .= _("Please contact your system administrator and report this error.");
return false;
}
@@ -216,7 +250,9 @@ class dbPrefs {
/**
* Function used to handle database connection errors
+ *
* @param object PEAR Error object
+ *
*/
function failQuery($res = NULL) {
if($res == NULL) {
@@ -231,32 +267,48 @@ class dbPrefs {
/**
* 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;
- cachePrefValues($user);
+ $temp = array(&$user, &$key);
+ $result = do_hook('get_pref_override', $temp);
+ if (is_null($result)) {
+ cachePrefValues($user);
- if (isset($prefs_cache[$key])) {
- return $prefs_cache[$key];
- } else {
- if (isset($this->default[$key])) {
- return $this->default[$key];
+ if (isset($prefs_cache[$key])) {
+ $result = $prefs_cache[$key];
} else {
- return $default;
+//FIXME: is there a justification for having two prefs hooks so close? who uses them?
+ $temp = array(&$user, &$key);
+ $result = do_hook('get_pref', $temp);
+ if (is_null($result)) {
+ if (isset($this->default[$key])) {
+ $result = $this->default[$key];
+ } else {
+ $result = $default;
+ }
+ }
}
}
+ return $result;
}
/**
* 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;
@@ -283,10 +335,13 @@ class dbPrefs {
/**
* 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()) {
@@ -299,7 +354,7 @@ class dbPrefs {
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
@@ -317,7 +372,7 @@ class dbPrefs {
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;
@@ -328,7 +383,7 @@ class dbPrefs {
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;
@@ -407,8 +462,11 @@ class dbPrefs {
/**
* Fill preference cache array
+ *
* @param string $user user name
+ *
* @since 1.2.3
+ *
*/
function fillPrefsCache($user) {
global $prefs_cache;
@@ -439,10 +497,10 @@ class dbPrefs {
/**
- * 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"),
@@ -450,24 +508,24 @@ function getPref($data_dir, $username, $string, $default = '') {
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');
@@ -475,18 +533,18 @@ function removePref($data_dir, $username, $string) {
}
/**
- * 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;
}
@@ -495,11 +553,11 @@ function setPref($data_dir, $username, $string, $set_to) {
$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;
}
@@ -519,13 +577,13 @@ function checkForPrefs($data_dir, $username) {
* 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;
}
@@ -541,5 +599,3 @@ function getSig($data_dir, $username, $number) {
}
return getPref($data_dir, $username, $key);
}
-
-// vim: et ts=4