6 * This contains functions for manipulating user preferences
7 * stored in a database, accessed though the Pear DB layer.
11 * The preferences table should have three columns:
16 * CREATE TABLE userprefs (user CHAR(128) NOT NULL DEFAULT '',
17 * prefkey CHAR(64) NOT NULL DEFAULT '',
18 * prefval BLOB NOT NULL DEFAULT '',
19 * primary key (user,prefkey));
21 * Configuration of databasename, username and password is done
22 * by using conf.pl or the administrator plugin
24 * @copyright © 1999-2007 The SquirrelMail Project Team
25 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
27 * @package squirrelmail
33 if (!defined('SM_PATH')) define('SM_PATH','../');
35 /** Unknown database */
36 define('SMDB_UNKNOWN', 0);
38 define('SMDB_MYSQL', 1);
40 define('SMDB_PGSQL', 2);
43 * don't display errors (no code execution in functions/*.php).
44 * will handle error in dbPrefs class.
46 @include_once
('DB.php');
48 global $prefs_are_cached, $prefs_cache;
53 function cachePrefValues($username) {
54 global $prefs_are_cached, $prefs_cache;
56 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION
);
57 if ($prefs_are_cached) {
58 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION
);
62 sqsession_unregister('prefs_cache');
63 sqsession_unregister('prefs_are_cached');
66 if(isset($db->error
)) {
67 printf( _("Preference database error (%s). Exiting abnormally"),
72 $db->fillPrefsCache($username);
73 if (isset($db->error
)) {
74 printf( _("Preference database error (%s). Exiting abnormally"),
79 $prefs_are_cached = true;
81 sqsession_register($prefs_cache, 'prefs_cache');
82 sqsession_register($prefs_are_cached, 'prefs_are_cached');
86 * Class used to handle connections to prefs database and operations with preferences
88 * @package squirrelmail
95 * Table used to store preferences
98 var $table = 'userprefs';
101 * Field used to store owner of preference
104 var $user_field = 'user';
107 * Field used to store preference name
110 var $key_field = 'prefkey';
113 * Field used to store preference value
116 var $val_field = 'prefval';
119 * Database connection object
131 * Database type (SMDB_* constants)
132 * Is used in setKey().
135 var $db_type = SMDB_UNKNOWN
;
138 * Default preferences
141 var $default = Array('theme_default' => 0,
142 'show_html_default' => '0');
145 * Preference owner field size
149 var $user_size = 128;
152 * Preference key field size
159 * Preference value field size
163 var $val_size = 65536;
168 * initialize DB connection object
170 * @return boolean true, if object is initialized
174 global $prefs_dsn, $prefs_table;
175 global $prefs_user_field, $prefs_key_field, $prefs_val_field;
176 global $prefs_user_size, $prefs_key_size, $prefs_val_size;
178 /* test if Pear DB class is available and freak out if it is not */
179 if (! class_exists('DB')) {
180 // same error also in abook_database.php
181 $this->error
= _("Could not include PEAR database functions required for the database backend.") . "\n";
182 $this->error
.= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
184 $this->error
.= _("Please contact your system administrator and report this error.");
188 if(isset($this->dbh
)) {
192 if (preg_match('/^mysql/', $prefs_dsn)) {
193 $this->db_type
= SMDB_MYSQL
;
194 } elseif (preg_match('/^pgsql/', $prefs_dsn)) {
195 $this->db_type
= SMDB_PGSQL
;
198 if (!empty($prefs_table)) {
199 $this->table
= $prefs_table;
201 if (!empty($prefs_user_field)) {
202 $this->user_field
= $prefs_user_field;
204 if (!empty($prefs_key_field)) {
205 $this->key_field
= $prefs_key_field;
207 if (!empty($prefs_val_field)) {
208 $this->val_field
= $prefs_val_field;
210 if (!empty($prefs_user_size)) {
211 $this->user_size
= (int) $prefs_user_size;
213 if (!empty($prefs_key_size)) {
214 $this->key_size
= (int) $prefs_key_size;
216 if (!empty($prefs_val_size)) {
217 $this->val_size
= (int) $prefs_val_size;
219 $dbh = DB
::connect($prefs_dsn, true);
221 if(DB
::isError($dbh)) {
222 $this->error
= DB
::errorMessage($dbh);
231 * Function used to handle database connection errors
233 * @param object PEAR Error object
236 function failQuery($res = NULL) {
238 printf(_("Preference database error (%s). Exiting abnormally"),
241 printf(_("Preference database error (%s). Exiting abnormally"),
242 DB
::errorMessage($res));
248 * Get user's prefs setting
250 * @param string $user user name
251 * @param string $key preference name
252 * @param mixed $default (since 1.2.5) default value
254 * @return mixed preference value
257 function getKey($user, $key, $default = '') {
260 cachePrefValues($user);
262 if (isset($prefs_cache[$key])) {
263 return $prefs_cache[$key];
265 if (isset($this->default[$key])) {
266 return $this->default[$key];
274 * Delete user's prefs setting
276 * @param string $user user name
277 * @param string $key preference name
282 function deleteKey($user, $key) {
285 if (!$this->open()) {
288 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
291 $this->dbh
->quoteString($user),
293 $this->dbh
->quoteString($key));
295 $res = $this->dbh
->simpleQuery($query);
296 if(DB
::isError($res)) {
297 $this->failQuery($res);
300 unset($prefs_cache[$key]);
306 * Set user's preference
308 * @param string $user user name
309 * @param string $key preference name
310 * @param mixed $value preference value
315 function setKey($user, $key, $value) {
316 if (!$this->open()) {
321 * Check if username fits into db field
323 if (strlen($user) > $this->user_size
) {
324 $this->error
= "Oversized username value."
325 ." Your preferences can't be saved."
326 ." See the administrator's manual or contact your system administrator.";
329 * Debugging function. Can be used to log all issues that trigger
330 * oversized field errors. Function should be enabled in all three
331 * strlen checks. See http://www.php.net/error-log
333 // error_log($user.'|'.$key.'|'.$value."\n",3,'/tmp/oversized_log');
336 $this->failQuery(null);
339 * Check if preference key fits into db field
341 if (strlen($key) > $this->key_size
) {
342 $err_msg = "Oversized user's preference key."
343 ." Some preferences were not saved."
344 ." See the administrator's manual or contact your system administrator.";
345 // error is not fatal. Only some preference is not saved.
346 trigger_error($err_msg,E_USER_WARNING
);
350 * Check if preference value fits into db field
352 if (strlen($value) > $this->val_size
) {
353 $err_msg = "Oversized user's preference value."
354 ." Some preferences were not saved."
355 ." See the administrator's manual or contact your system administrator.";
356 // error is not fatal. Only some preference is not saved.
357 trigger_error($err_msg,E_USER_WARNING
);
362 if ($this->db_type
== SMDB_MYSQL
) {
363 $query = sprintf("REPLACE INTO %s (%s, %s, %s) ".
364 "VALUES('%s','%s','%s')",
369 $this->dbh
->quoteString($user),
370 $this->dbh
->quoteString($key),
371 $this->dbh
->quoteString($value));
373 $res = $this->dbh
->simpleQuery($query);
374 if(DB
::isError($res)) {
375 $this->failQuery($res);
377 } elseif ($this->db_type
== SMDB_PGSQL
) {
378 $this->dbh
->simpleQuery("BEGIN TRANSACTION");
379 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
382 $this->dbh
->quoteString($user),
384 $this->dbh
->quoteString($key));
385 $res = $this->dbh
->simpleQuery($query);
386 if (DB
::isError($res)) {
387 $this->dbh
->simpleQuery("ROLLBACK TRANSACTION");
388 $this->failQuery($res);
390 $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
395 $this->dbh
->quoteString($user),
396 $this->dbh
->quoteString($key),
397 $this->dbh
->quoteString($value));
398 $res = $this->dbh
->simpleQuery($query);
399 if (DB
::isError($res)) {
400 $this->dbh
->simpleQuery("ROLLBACK TRANSACTION");
401 $this->failQuery($res);
403 $this->dbh
->simpleQuery("COMMIT TRANSACTION");
405 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
408 $this->dbh
->quoteString($user),
410 $this->dbh
->quoteString($key));
411 $res = $this->dbh
->simpleQuery($query);
412 if (DB
::isError($res)) {
413 $this->failQuery($res);
415 $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
420 $this->dbh
->quoteString($user),
421 $this->dbh
->quoteString($key),
422 $this->dbh
->quoteString($value));
423 $res = $this->dbh
->simpleQuery($query);
424 if (DB
::isError($res)) {
425 $this->failQuery($res);
433 * Fill preference cache array
435 * @param string $user user name
440 function fillPrefsCache($user) {
443 if (!$this->open()) {
447 $prefs_cache = array();
448 $query = sprintf("SELECT %s as prefkey, %s as prefval FROM %s ".
454 $this->dbh
->quoteString($user));
455 $res = $this->dbh
->query($query);
456 if (DB
::isError($res)) {
457 $this->failQuery($res);
460 while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC
)) {
461 $prefs_cache[$row['prefkey']] = $row['prefval'];
465 } /* end class dbPrefs */
469 * Returns the value for the requested preference
472 function getPref($data_dir, $username, $pref_name, $default = '') {
474 if(isset($db->error
)) {
475 printf( _("Preference database error (%s). Exiting abnormally"),
480 return $db->getKey($username, $pref_name, $default);
484 * Remove the desired preference setting ($pref_name)
487 function removePref($data_dir, $username, $pref_name) {
490 if(isset($db->error
)) {
494 $db->deleteKey($username, $pref_name);
496 if (isset($prefs_cache[$pref_name])) {
497 unset($prefs_cache[$pref_name]);
500 sqsession_register($prefs_cache , 'prefs_cache');
505 * Sets the desired preference setting ($pref_name) to whatever is in $value
508 function setPref($data_dir, $username, $pref_name, $value) {
511 if (isset($prefs_cache[$pref_name]) && ($prefs_cache[$pref_name] == $value)) {
516 removePref($data_dir, $username, $pref_name);
521 if(isset($db->error
)) {
525 $db->setKey($username, $pref_name, $value);
526 $prefs_cache[$pref_name] = $value;
527 assert_options(ASSERT_ACTIVE
, 1);
528 assert_options(ASSERT_BAIL
, 1);
529 assert ('$value == $prefs_cache[$pref_name]');
530 sqsession_register($prefs_cache , 'prefs_cache');
535 * This checks if the prefs are available
538 function checkForPrefs($data_dir, $username) {
540 if(isset($db->error
)) {
546 * Writes the Signature
549 function setSig($data_dir, $username, $number, $value) {
550 if ($number == "g") {
551 $key = '___signature___';
553 $key = sprintf('___sig%s___', $number);
555 setPref($data_dir, $username, $key, $value);
563 function getSig($data_dir, $username, $number) {
564 if ($number == "g") {
565 $key = '___signature___';
567 $key = sprintf('___sig%d___', $number);
569 return getPref($data_dir, $username, $key);