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-2011 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 the default preferences array.
172 // Try and read the default preferences file.
173 $default_pref = SM_PATH
. 'config/default_pref';
174 if (@file_exists
($default_pref)) {
175 if ($file = @fopen
($default_pref, 'r')) {
176 while (!feof($file)) {
177 $pref = fgets($file, 1024);
178 $i = strpos($pref, '=');
180 $this->default[trim(substr($pref, 0, $i))] = trim(substr($pref, $i +
1));
189 * initialize DB connection object
191 * @return boolean true, if object is initialized
195 global $prefs_dsn, $prefs_table;
196 global $prefs_user_field, $prefs_key_field, $prefs_val_field;
197 global $prefs_user_size, $prefs_key_size, $prefs_val_size;
199 /* test if Pear DB class is available and freak out if it is not */
200 if (! class_exists('DB')) {
201 // same error also in abook_database.php
202 $this->error
= _("Could not include PEAR database functions required for the database backend.") . "\n";
203 $this->error
.= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
205 $this->error
.= _("Please contact your system administrator and report this error.");
209 if(isset($this->dbh
)) {
213 if (preg_match('/^mysql/', $prefs_dsn)) {
214 $this->db_type
= SMDB_MYSQL
;
215 } elseif (preg_match('/^pgsql/', $prefs_dsn)) {
216 $this->db_type
= SMDB_PGSQL
;
219 if (!empty($prefs_table)) {
220 $this->table
= $prefs_table;
222 if (!empty($prefs_user_field)) {
223 $this->user_field
= $prefs_user_field;
226 // the default user field is "user", which in PostgreSQL
227 // is an identifier and causes errors if not escaped
229 if ($this->db_type
== SMDB_PGSQL
) {
230 $this->user_field
= '"' . $this->user_field
. '"';
233 if (!empty($prefs_key_field)) {
234 $this->key_field
= $prefs_key_field;
236 if (!empty($prefs_val_field)) {
237 $this->val_field
= $prefs_val_field;
239 if (!empty($prefs_user_size)) {
240 $this->user_size
= (int) $prefs_user_size;
242 if (!empty($prefs_key_size)) {
243 $this->key_size
= (int) $prefs_key_size;
245 if (!empty($prefs_val_size)) {
246 $this->val_size
= (int) $prefs_val_size;
248 $dbh = DB
::connect($prefs_dsn, true);
250 if(DB
::isError($dbh)) {
251 $this->error
= DB
::errorMessage($dbh);
260 * Function used to handle database connection errors
262 * @param object PEAR Error object
265 function failQuery($res = NULL) {
267 printf(_("Preference database error (%s). Exiting abnormally"),
270 printf(_("Preference database error (%s). Exiting abnormally"),
271 DB
::errorMessage($res));
277 * Get user's prefs setting
279 * @param string $user user name
280 * @param string $key preference name
281 * @param mixed $default (since 1.2.5) default value
283 * @return mixed preference value
286 function getKey($user, $key, $default = '') {
289 $temp = array(&$user, &$key);
290 $result = do_hook('get_pref_override', $temp);
291 if (is_null($result)) {
292 cachePrefValues($user);
294 if (isset($prefs_cache[$key])) {
295 $result = $prefs_cache[$key];
297 //FIXME: is there a justification for having two prefs hooks so close? who uses them?
298 $temp = array(&$user, &$key);
299 $result = do_hook('get_pref', $temp);
300 if (is_null($result)) {
301 if (isset($this->default[$key])) {
302 $result = $this->default[$key];
313 * Delete user's prefs setting
315 * @param string $user user name
316 * @param string $key preference name
321 function deleteKey($user, $key) {
324 if (!$this->open()) {
327 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
330 $this->dbh
->quoteString($user),
332 $this->dbh
->quoteString($key));
334 $res = $this->dbh
->simpleQuery($query);
335 if(DB
::isError($res)) {
336 $this->failQuery($res);
339 unset($prefs_cache[$key]);
345 * Set user's preference
347 * @param string $user user name
348 * @param string $key preference name
349 * @param mixed $value preference value
354 function setKey($user, $key, $value) {
355 if (!$this->open()) {
360 * Check if username fits into db field
362 if (strlen($user) > $this->user_size
) {
363 $this->error
= "Oversized username value."
364 ." Your preferences can't be saved."
365 ." See the administrator's manual or contact your system administrator.";
368 * Debugging function. Can be used to log all issues that trigger
369 * oversized field errors. Function should be enabled in all three
370 * strlen checks. See http://www.php.net/error-log
372 // error_log($user.'|'.$key.'|'.$value."\n",3,'/tmp/oversized_log');
375 $this->failQuery(null);
378 * Check if preference key fits into db field
380 if (strlen($key) > $this->key_size
) {
381 $err_msg = "Oversized user's preference key."
382 ." Some preferences were not saved."
383 ." See the administrator's manual or contact your system administrator.";
384 // error is not fatal. Only some preference is not saved.
385 trigger_error($err_msg,E_USER_WARNING
);
389 * Check if preference value fits into db field
391 if (strlen($value) > $this->val_size
) {
392 $err_msg = "Oversized user's preference value."
393 ." Some preferences were not saved."
394 ." See the administrator's manual or contact your system administrator.";
395 // error is not fatal. Only some preference is not saved.
396 trigger_error($err_msg,E_USER_WARNING
);
401 if ($this->db_type
== SMDB_MYSQL
) {
402 $query = sprintf("REPLACE INTO %s (%s, %s, %s) ".
403 "VALUES('%s','%s','%s')",
408 $this->dbh
->quoteString($user),
409 $this->dbh
->quoteString($key),
410 $this->dbh
->quoteString($value));
412 $res = $this->dbh
->simpleQuery($query);
413 if(DB
::isError($res)) {
414 $this->failQuery($res);
416 } elseif ($this->db_type
== SMDB_PGSQL
) {
417 $this->dbh
->simpleQuery("BEGIN TRANSACTION");
418 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
421 $this->dbh
->quoteString($user),
423 $this->dbh
->quoteString($key));
424 $res = $this->dbh
->simpleQuery($query);
425 if (DB
::isError($res)) {
426 $this->dbh
->simpleQuery("ROLLBACK TRANSACTION");
427 $this->failQuery($res);
429 $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
434 $this->dbh
->quoteString($user),
435 $this->dbh
->quoteString($key),
436 $this->dbh
->quoteString($value));
437 $res = $this->dbh
->simpleQuery($query);
438 if (DB
::isError($res)) {
439 $this->dbh
->simpleQuery("ROLLBACK TRANSACTION");
440 $this->failQuery($res);
442 $this->dbh
->simpleQuery("COMMIT TRANSACTION");
444 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
447 $this->dbh
->quoteString($user),
449 $this->dbh
->quoteString($key));
450 $res = $this->dbh
->simpleQuery($query);
451 if (DB
::isError($res)) {
452 $this->failQuery($res);
454 $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
459 $this->dbh
->quoteString($user),
460 $this->dbh
->quoteString($key),
461 $this->dbh
->quoteString($value));
462 $res = $this->dbh
->simpleQuery($query);
463 if (DB
::isError($res)) {
464 $this->failQuery($res);
472 * Fill preference cache array
474 * @param string $user user name
479 function fillPrefsCache($user) {
482 if (!$this->open()) {
486 $prefs_cache = array();
487 $query = sprintf("SELECT %s as prefkey, %s as prefval FROM %s ".
493 $this->dbh
->quoteString($user));
494 $res = $this->dbh
->query($query);
495 if (DB
::isError($res)) {
496 $this->failQuery($res);
499 while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC
)) {
500 $prefs_cache[$row['prefkey']] = $row['prefval'];
504 } /* end class dbPrefs */
508 * Returns the value for the requested preference
511 function getPref($data_dir, $username, $pref_name, $default = '') {
513 if(isset($db->error
)) {
514 printf( _("Preference database error (%s). Exiting abnormally"),
519 return $db->getKey($username, $pref_name, $default);
523 * Remove the desired preference setting ($pref_name)
526 function removePref($data_dir, $username, $pref_name) {
529 if(isset($db->error
)) {
533 $db->deleteKey($username, $pref_name);
535 if (isset($prefs_cache[$pref_name])) {
536 unset($prefs_cache[$pref_name]);
539 sqsession_register($prefs_cache , 'prefs_cache');
544 * Sets the desired preference setting ($pref_name) to whatever is in $value
547 function setPref($data_dir, $username, $pref_name, $value) {
550 if (isset($prefs_cache[$pref_name]) && ($prefs_cache[$pref_name] == $value)) {
555 removePref($data_dir, $username, $pref_name);
560 if(isset($db->error
)) {
564 $db->setKey($username, $pref_name, $value);
565 $prefs_cache[$pref_name] = $value;
566 assert_options(ASSERT_ACTIVE
, 1);
567 assert_options(ASSERT_BAIL
, 1);
568 assert ('$value == $prefs_cache[$pref_name]');
569 sqsession_register($prefs_cache , 'prefs_cache');
574 * This checks if the prefs are available
577 function checkForPrefs($data_dir, $username) {
579 if(isset($db->error
)) {
585 * Writes the Signature
588 function setSig($data_dir, $username, $number, $value) {
589 if ($number == "g") {
590 $key = '___signature___';
592 $key = sprintf('___sig%s___', $number);
594 setPref($data_dir, $username, $key, $value);
602 function getSig($data_dir, $username, $number) {
603 if ($number == "g") {
604 $key = '___signature___';
606 $key = sprintf('___sig%d___', $number);
608 return getPref($data_dir, $username, $key);