X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fdb_prefs.php;h=26c2ac2ef94a36bf87e08659f482b4e1fb986ab7;hb=3e6ee6cac3f0661ac3d2ffc516bb5d3be5f8f14f;hp=bb7cb71261018086e464e045fb75dfef3545481b;hpb=76911253eb850bacde3d86c8cb7b4af072e67ebe;p=squirrelmail.git
diff --git a/functions/db_prefs.php b/functions/db_prefs.php
index bb7cb712..26c2ac2e 100644
--- a/functions/db_prefs.php
+++ b/functions/db_prefs.php
@@ -1,16 +1,12 @@
0,
'show_html_default' => '0');
+ /**
+ * Preference owner field size
+ * @var integer
+ * @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
+ * @since 1.5.1
+ */
+ var $val_size = 65536;
+
+ /**
+ * 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;
+ global $prefs_user_size, $prefs_key_size, $prefs_val_size;
+
+ /* 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 .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
+ 'DB.php') . "
\n";
+ $this->error .= _("Please contact your system administrator and report this error.");
+ return false;
+ }
if(isset($this->dbh)) {
return true;
@@ -106,6 +194,15 @@ class dbPrefs {
if (!empty($prefs_val_field)) {
$this->val_field = $prefs_val_field;
}
+ if (!empty($prefs_user_size)) {
+ $this->user_size = (int) $prefs_user_size;
+ }
+ if (!empty($prefs_key_size)) {
+ $this->key_size = (int) $prefs_key_size;
+ }
+ if (!empty($prefs_val_size)) {
+ $this->val_size = (int) $prefs_val_size;
+ }
$dbh = DB::connect($prefs_dsn, true);
if(DB::isError($dbh)) {
@@ -117,6 +214,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 +229,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 +252,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,10 +281,60 @@ 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;
}
+
+ /**
+ * Check if username fits into db field
+ */
+ 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.";
+
+ /**
+ * Debugging function. Can be used to log all issues that trigger
+ * oversized field errors. Function should be enabled in all three
+ * strlen checks. See http://www.php.net/error-log
+ */
+ // error_log($user.'|'.$key.'|'.$value."\n",3,'/tmp/oversized_log');
+
+ // error is fatal
+ $this->failQuery(null);
+ }
+ /**
+ * Check if preference key fits into db field
+ */
+ 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.";
+ // error is not fatal. Only some preference is not saved.
+ trigger_error($err_msg,E_USER_WARNING);
+ return false;
+ }
+ /**
+ * Check if preference value fits into db field
+ */
+ 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.";
+ // error is not fatal. Only some preference is not saved.
+ trigger_error($err_msg,E_USER_WARNING);
+ return false;
+ }
+
+
if ($this->db_type == SMDB_MYSQL) {
$query = sprintf("REPLACE INTO %s (%s, %s, %s) ".
"VALUES('%s','%s','%s')",
@@ -242,6 +405,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 +438,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,23 +453,36 @@ 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;
if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $set_to)) {
- return;
+ return;
}
if ($set_to === '') {
@@ -316,11 +500,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 +515,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 +529,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 +542,4 @@ function getSig($data_dir, $username, $number) {
return getPref($data_dir, $username, $key);
}
-?>
+// vim: et ts=4