X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fdb_prefs.php;h=c5f9e474243d2e4df40686fb81244f1227f0395d;hp=d7279a31dcdfbb31347703c74c88cff41e3e7396;hb=3673a2deb33a13b35bd05b8693da08f1b64fbc42;hpb=4d30c1b7147f2df7abdd687e48abea2c7ceb94f5 diff --git a/functions/db_prefs.php b/functions/db_prefs.php index d7279a31..c5f9e474 100644 --- a/functions/db_prefs.php +++ b/functions/db_prefs.php @@ -3,14 +3,10 @@ /** * db_prefs.php * - * Copyright (c) 1999-2004 The SquirrelMail Project Team - * Licensed under the GNU GPL. For full terms see the file COPYING. - * * This contains functions for manipulating user preferences * stored in a database, accessed though the Pear DB layer. * * Database: - * --------- * * The preferences table should have three columns: * user char \ primary @@ -25,10 +21,17 @@ * Configuration of databasename, username and password is done * by using conf.pl or the administrator plugin * - * $Id$ + * @copyright 1999-2010 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @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 */ @@ -36,8 +39,11 @@ define('SMDB_MYSQL', 1); /** PostgreSQL */ define('SMDB_PGSQL', 2); -require_once('DB.php'); -require_once(SM_PATH . 'config/config.php'); +/** + * don't display errors (no code execution in functions/*.php). + * will handle error in dbPrefs class. + */ +@include_once('DB.php'); global $prefs_are_cached, $prefs_cache; @@ -47,7 +53,9 @@ 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; } @@ -75,25 +83,128 @@ function cachePrefValues($username) { } /** - * 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'); + /** + * 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 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; 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; @@ -117,6 +228,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)) { @@ -128,6 +248,12 @@ 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"), @@ -139,23 +265,51 @@ 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; - 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 + * + * @return boolean + * + */ function deleteKey($user, $key) { global $prefs_cache; @@ -179,10 +333,63 @@ 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 the administrator's manual 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 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; + } + /** + * 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 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 ($this->db_type == SMDB_MYSQL) { $query = sprintf("REPLACE INTO %s (%s, %s, %s) ". "VALUES('%s','%s','%s')", @@ -253,6 +460,14 @@ class dbPrefs { return true; } + /** + * Fill preference cache array + * + * @param string $user user name + * + * @since 1.2.3 + * + */ function fillPrefsCache($user) { global $prefs_cache; @@ -282,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"), @@ -293,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'); @@ -318,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; } @@ -338,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; } @@ -362,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; } @@ -384,5 +599,3 @@ function getSig($data_dir, $username, $number) { } return getPref($data_dir, $username, $key); } - -?> \ No newline at end of file