24da7ed97efa45fb03098c9e72ff7e22bb27d1a5
6 * Copyright (c) 1999-2005 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This contains functions for manipulating user preferences
10 * stored in a database, accessed though the Pear DB layer.
15 * The preferences table should have three columns:
20 * CREATE TABLE userprefs (user CHAR(128) NOT NULL DEFAULT '',
21 * prefkey CHAR(64) NOT NULL DEFAULT '',
22 * prefval BLOB NOT NULL DEFAULT '',
23 * primary key (user,prefkey));
25 * Configuration of databasename, username and password is done
26 * by using conf.pl or the administrator plugin
29 * @package squirrelmail
35 if (!defined('SM_PATH')) define('SM_PATH','../');
37 /** Unknown database */
38 define('SMDB_UNKNOWN', 0);
40 define('SMDB_MYSQL', 1);
42 define('SMDB_PGSQL', 2);
44 require_once(SM_PATH
. 'config/config.php');
45 if (!include_once('DB.php')) {
46 // same error also in abook_database.php
47 require_once(SM_PATH
. 'functions/display_messages.php');
48 $error = _("Could not include PEAR database functions required for the database backend.") . "<br />\n";
49 $error .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
50 '<tt>DB.php</tt>') . "<br />\n";
51 $error .= _("Please contact your system administrator and report this error.");
52 error_box($error, $color);
56 global $prefs_are_cached, $prefs_cache;
61 function cachePrefValues($username) {
62 global $prefs_are_cached, $prefs_cache;
64 sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION
);
65 if ($prefs_are_cached) {
66 sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION
);
70 sqsession_unregister('prefs_cache');
71 sqsession_unregister('prefs_are_cached');
74 if(isset($db->error
)) {
75 printf( _("Preference database error (%s). Exiting abnormally"),
80 $db->fillPrefsCache($username);
81 if (isset($db->error
)) {
82 printf( _("Preference database error (%s). Exiting abnormally"),
87 $prefs_are_cached = true;
89 sqsession_register($prefs_cache, 'prefs_cache');
90 sqsession_register($prefs_are_cached, 'prefs_are_cached');
94 * Class used to handle connections to prefs database and operations with preferences
95 * @package squirrelmail
101 * Table used to store preferences
104 var $table = 'userprefs';
106 * Field used to store owner of preference
109 var $user_field = 'user';
111 * Field used to store preference name
114 var $key_field = 'prefkey';
116 * Field used to store preference value
119 var $val_field = 'prefval';
122 * Database connection object
132 * Database type (SMDB_* constants)
133 * Is used in setKey().
136 var $db_type = SMDB_UNKNOWN
;
139 * Default preferences
142 var $default = Array('theme_default' => 0,
143 'show_html_default' => '0');
146 * Preference owner field size
150 var $user_size = 128;
152 * Preference key field size
158 * Preference value field size
162 var $val_size = 65536;
165 * initialize DB connection object
166 * @return boolean true, if object is initialized
169 global $prefs_dsn, $prefs_table;
170 global $prefs_user_field, $prefs_key_field, $prefs_val_field;
171 global $prefs_user_size, $prefs_key_size, $prefs_val_size;
173 if(isset($this->dbh
)) {
177 if (preg_match('/^mysql/', $prefs_dsn)) {
178 $this->db_type
= SMDB_MYSQL
;
179 } elseif (preg_match('/^pgsql/', $prefs_dsn)) {
180 $this->db_type
= SMDB_PGSQL
;
183 if (!empty($prefs_table)) {
184 $this->table
= $prefs_table;
186 if (!empty($prefs_user_field)) {
187 $this->user_field
= $prefs_user_field;
189 if (!empty($prefs_key_field)) {
190 $this->key_field
= $prefs_key_field;
192 if (!empty($prefs_val_field)) {
193 $this->val_field
= $prefs_val_field;
195 if (!empty($prefs_user_size)) {
196 $this->user_size
= (int) $prefs_user_size;
198 if (!empty($prefs_key_size)) {
199 $this->key_size
= (int) $prefs_key_size;
201 if (!empty($prefs_val_size)) {
202 $this->val_size
= (int) $prefs_val_size;
204 $dbh = DB
::connect($prefs_dsn, true);
206 if(DB
::isError($dbh)) {
207 $this->error
= DB
::errorMessage($dbh);
216 * Function used to handle database connection errors
217 * @param object PEAR Error object
219 function failQuery($res = NULL) {
221 printf(_("Preference database error (%s). Exiting abnormally"),
224 printf(_("Preference database error (%s). Exiting abnormally"),
225 DB
::errorMessage($res));
231 * Get user's prefs setting
232 * @param string $user user name
233 * @param string $key preference name
234 * @param mixed $default (since 1.2.5) default value
235 * @return mixed preference value
237 function getKey($user, $key, $default = '') {
240 cachePrefValues($user);
242 if (isset($prefs_cache[$key])) {
243 return $prefs_cache[$key];
245 if (isset($this->default[$key])) {
246 return $this->default[$key];
254 * Delete user's prefs setting
255 * @param string $user user name
256 * @param string $key preference name
259 function deleteKey($user, $key) {
262 if (!$this->open()) {
265 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
268 $this->dbh
->quoteString($user),
270 $this->dbh
->quoteString($key));
272 $res = $this->dbh
->simpleQuery($query);
273 if(DB
::isError($res)) {
274 $this->failQuery($res);
277 unset($prefs_cache[$key]);
283 * Set user's preference
284 * @param string $user user name
285 * @param string $key preference name
286 * @param mixed $value preference value
289 function setKey($user, $key, $value) {
290 if (!$this->open()) {
295 * Check if username fits into db field
297 if (strlen($user) > $this->user_size
) {
298 $this->error
= "Oversized username value."
299 ." Your preferences can't be saved."
300 ." See doc/db-backend.txt or contact your system administrator.";
303 * Debugging function. Can be used to log all issues that trigger
304 * oversized field errors. Function should be enabled in all three
305 * strlen checks. See http://www.php.net/error-log
307 // error_log($user.'|'.$key.'|'.$value."\n",3,'/tmp/oversized_log');
310 $this->failQuery(null);
313 * Check if preference key fits into db field
315 if (strlen($key) > $this->key_size
) {
316 $err_msg = "Oversized user's preference key."
317 ." Some preferences were not saved."
318 ." See doc/db-backend.txt or contact your system administrator.";
319 // error is not fatal. Only some preference is not saved.
320 trigger_error($err_msg,E_USER_WARNING
);
324 * Check if preference value fits into db field
326 if (strlen($value) > $this->val_size
) {
327 $err_msg = "Oversized user's preference value."
328 ." Some preferences were not saved."
329 ." See doc/db-backend.txt or contact your system administrator.";
330 // error is not fatal. Only some preference is not saved.
331 trigger_error($err_msg,E_USER_WARNING
);
336 if ($this->db_type
== SMDB_MYSQL
) {
337 $query = sprintf("REPLACE INTO %s (%s, %s, %s) ".
338 "VALUES('%s','%s','%s')",
343 $this->dbh
->quoteString($user),
344 $this->dbh
->quoteString($key),
345 $this->dbh
->quoteString($value));
347 $res = $this->dbh
->simpleQuery($query);
348 if(DB
::isError($res)) {
349 $this->failQuery($res);
351 } elseif ($this->db_type
== SMDB_PGSQL
) {
352 $this->dbh
->simpleQuery("BEGIN TRANSACTION");
353 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
356 $this->dbh
->quoteString($user),
358 $this->dbh
->quoteString($key));
359 $res = $this->dbh
->simpleQuery($query);
360 if (DB
::isError($res)) {
361 $this->dbh
->simpleQuery("ROLLBACK TRANSACTION");
362 $this->failQuery($res);
364 $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
369 $this->dbh
->quoteString($user),
370 $this->dbh
->quoteString($key),
371 $this->dbh
->quoteString($value));
372 $res = $this->dbh
->simpleQuery($query);
373 if (DB
::isError($res)) {
374 $this->dbh
->simpleQuery("ROLLBACK TRANSACTION");
375 $this->failQuery($res);
377 $this->dbh
->simpleQuery("COMMIT 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->failQuery($res);
389 $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
394 $this->dbh
->quoteString($user),
395 $this->dbh
->quoteString($key),
396 $this->dbh
->quoteString($value));
397 $res = $this->dbh
->simpleQuery($query);
398 if (DB
::isError($res)) {
399 $this->failQuery($res);
407 * Fill preference cache array
408 * @param string $user user name
411 function fillPrefsCache($user) {
414 if (!$this->open()) {
418 $prefs_cache = array();
419 $query = sprintf("SELECT %s as prefkey, %s as prefval FROM %s ".
425 $this->dbh
->quoteString($user));
426 $res = $this->dbh
->query($query);
427 if (DB
::isError($res)) {
428 $this->failQuery($res);
431 while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC
)) {
432 $prefs_cache[$row['prefkey']] = $row['prefval'];
436 } /* end class dbPrefs */
440 * returns the value for the pref $string
443 function getPref($data_dir, $username, $string, $default = '') {
445 if(isset($db->error
)) {
446 printf( _("Preference database error (%s). Exiting abnormally"),
451 return $db->getKey($username, $string, $default);
455 * Remove the pref $string
458 function removePref($data_dir, $username, $string) {
461 if(isset($db->error
)) {
465 $db->deleteKey($username, $string);
467 if (isset($prefs_cache[$string])) {
468 unset($prefs_cache[$string]);
471 sqsession_register($prefs_cache , 'prefs_cache');
476 * sets the pref, $string, to $set_to
479 function setPref($data_dir, $username, $string, $set_to) {
482 if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $set_to)) {
486 if ($set_to === '') {
487 removePref($data_dir, $username, $string);
492 if(isset($db->error
)) {
496 $db->setKey($username, $string, $set_to);
497 $prefs_cache[$string] = $set_to;
498 assert_options(ASSERT_ACTIVE
, 1);
499 assert_options(ASSERT_BAIL
, 1);
500 assert ('$set_to == $prefs_cache[$string]');
501 sqsession_register($prefs_cache , 'prefs_cache');
506 * This checks if the prefs are available
509 function checkForPrefs($data_dir, $username) {
511 if(isset($db->error
)) {
517 * Writes the Signature
520 function setSig($data_dir, $username, $number, $string) {
521 if ($number == "g") {
522 $key = '___signature___';
524 $key = sprintf('___sig%s___', $number);
526 setPref($data_dir, $username, $key, $string);
534 function getSig($data_dir, $username, $number) {
535 if ($number == "g") {
536 $key = '___signature___';
538 $key = sprintf('___sig%d___', $number);
540 return getPref($data_dir, $username, $key);