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 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;
225 if (!empty($prefs_key_field)) {
226 $this->key_field
= $prefs_key_field;
228 if (!empty($prefs_val_field)) {
229 $this->val_field
= $prefs_val_field;
231 if (!empty($prefs_user_size)) {
232 $this->user_size
= (int) $prefs_user_size;
234 if (!empty($prefs_key_size)) {
235 $this->key_size
= (int) $prefs_key_size;
237 if (!empty($prefs_val_size)) {
238 $this->val_size
= (int) $prefs_val_size;
240 $dbh = DB
::connect($prefs_dsn, true);
242 if(DB
::isError($dbh)) {
243 $this->error
= DB
::errorMessage($dbh);
252 * Function used to handle database connection errors
254 * @param object PEAR Error object
257 function failQuery($res = NULL) {
259 printf(_("Preference database error (%s). Exiting abnormally"),
262 printf(_("Preference database error (%s). Exiting abnormally"),
263 DB
::errorMessage($res));
269 * Get user's prefs setting
271 * @param string $user user name
272 * @param string $key preference name
273 * @param mixed $default (since 1.2.5) default value
275 * @return mixed preference value
278 function getKey($user, $key, $default = '') {
281 $temp = array(&$user, &$key);
282 $result = do_hook('get_pref_override', $temp);
283 if (is_null($result)) {
284 cachePrefValues($user);
286 if (isset($prefs_cache[$key])) {
287 $result = $prefs_cache[$key];
289 //FIXME: is there a justification for having two prefs hooks so close? who uses them?
290 $temp = array(&$user, &$key);
291 $result = do_hook('get_pref', $temp);
292 if (is_null($result)) {
293 if (isset($this->default[$key])) {
294 $result = $this->default[$key];
305 * Delete user's prefs setting
307 * @param string $user user name
308 * @param string $key preference name
313 function deleteKey($user, $key) {
316 if (!$this->open()) {
319 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
322 $this->dbh
->quoteString($user),
324 $this->dbh
->quoteString($key));
326 $res = $this->dbh
->simpleQuery($query);
327 if(DB
::isError($res)) {
328 $this->failQuery($res);
331 unset($prefs_cache[$key]);
337 * Set user's preference
339 * @param string $user user name
340 * @param string $key preference name
341 * @param mixed $value preference value
346 function setKey($user, $key, $value) {
347 if (!$this->open()) {
352 * Check if username fits into db field
354 if (strlen($user) > $this->user_size
) {
355 $this->error
= "Oversized username value."
356 ." Your preferences can't be saved."
357 ." See the administrator's manual or contact your system administrator.";
360 * Debugging function. Can be used to log all issues that trigger
361 * oversized field errors. Function should be enabled in all three
362 * strlen checks. See http://www.php.net/error-log
364 // error_log($user.'|'.$key.'|'.$value."\n",3,'/tmp/oversized_log');
367 $this->failQuery(null);
370 * Check if preference key fits into db field
372 if (strlen($key) > $this->key_size
) {
373 $err_msg = "Oversized user's preference key."
374 ." Some preferences were not saved."
375 ." See the administrator's manual or contact your system administrator.";
376 // error is not fatal. Only some preference is not saved.
377 trigger_error($err_msg,E_USER_WARNING
);
381 * Check if preference value fits into db field
383 if (strlen($value) > $this->val_size
) {
384 $err_msg = "Oversized user's preference value."
385 ." Some preferences were not saved."
386 ." See the administrator's manual or contact your system administrator.";
387 // error is not fatal. Only some preference is not saved.
388 trigger_error($err_msg,E_USER_WARNING
);
393 if ($this->db_type
== SMDB_MYSQL
) {
394 $query = sprintf("REPLACE INTO %s (%s, %s, %s) ".
395 "VALUES('%s','%s','%s')",
400 $this->dbh
->quoteString($user),
401 $this->dbh
->quoteString($key),
402 $this->dbh
->quoteString($value));
404 $res = $this->dbh
->simpleQuery($query);
405 if(DB
::isError($res)) {
406 $this->failQuery($res);
408 } elseif ($this->db_type
== SMDB_PGSQL
) {
409 $this->dbh
->simpleQuery("BEGIN TRANSACTION");
410 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
413 $this->dbh
->quoteString($user),
415 $this->dbh
->quoteString($key));
416 $res = $this->dbh
->simpleQuery($query);
417 if (DB
::isError($res)) {
418 $this->dbh
->simpleQuery("ROLLBACK TRANSACTION");
419 $this->failQuery($res);
421 $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
426 $this->dbh
->quoteString($user),
427 $this->dbh
->quoteString($key),
428 $this->dbh
->quoteString($value));
429 $res = $this->dbh
->simpleQuery($query);
430 if (DB
::isError($res)) {
431 $this->dbh
->simpleQuery("ROLLBACK TRANSACTION");
432 $this->failQuery($res);
434 $this->dbh
->simpleQuery("COMMIT TRANSACTION");
436 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
439 $this->dbh
->quoteString($user),
441 $this->dbh
->quoteString($key));
442 $res = $this->dbh
->simpleQuery($query);
443 if (DB
::isError($res)) {
444 $this->failQuery($res);
446 $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
451 $this->dbh
->quoteString($user),
452 $this->dbh
->quoteString($key),
453 $this->dbh
->quoteString($value));
454 $res = $this->dbh
->simpleQuery($query);
455 if (DB
::isError($res)) {
456 $this->failQuery($res);
464 * Fill preference cache array
466 * @param string $user user name
471 function fillPrefsCache($user) {
474 if (!$this->open()) {
478 $prefs_cache = array();
479 $query = sprintf("SELECT %s as prefkey, %s as prefval FROM %s ".
485 $this->dbh
->quoteString($user));
486 $res = $this->dbh
->query($query);
487 if (DB
::isError($res)) {
488 $this->failQuery($res);
491 while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC
)) {
492 $prefs_cache[$row['prefkey']] = $row['prefval'];
496 } /* end class dbPrefs */
500 * Returns the value for the requested preference
503 function getPref($data_dir, $username, $pref_name, $default = '') {
505 if(isset($db->error
)) {
506 printf( _("Preference database error (%s). Exiting abnormally"),
511 return $db->getKey($username, $pref_name, $default);
515 * Remove the desired preference setting ($pref_name)
518 function removePref($data_dir, $username, $pref_name) {
521 if(isset($db->error
)) {
525 $db->deleteKey($username, $pref_name);
527 if (isset($prefs_cache[$pref_name])) {
528 unset($prefs_cache[$pref_name]);
531 sqsession_register($prefs_cache , 'prefs_cache');
536 * Sets the desired preference setting ($pref_name) to whatever is in $value
539 function setPref($data_dir, $username, $pref_name, $value) {
542 if (isset($prefs_cache[$pref_name]) && ($prefs_cache[$pref_name] == $value)) {
547 removePref($data_dir, $username, $pref_name);
552 if(isset($db->error
)) {
556 $db->setKey($username, $pref_name, $value);
557 $prefs_cache[$pref_name] = $value;
558 assert_options(ASSERT_ACTIVE
, 1);
559 assert_options(ASSERT_BAIL
, 1);
560 assert ('$value == $prefs_cache[$pref_name]');
561 sqsession_register($prefs_cache , 'prefs_cache');
566 * This checks if the prefs are available
569 function checkForPrefs($data_dir, $username) {
571 if(isset($db->error
)) {
577 * Writes the Signature
580 function setSig($data_dir, $username, $number, $value) {
581 if ($number == "g") {
582 $key = '___signature___';
584 $key = sprintf('___sig%s___', $number);
586 setPref($data_dir, $username, $key, $value);
594 function getSig($data_dir, $username, $number) {
595 if ($number == "g") {
596 $key = '___signature___';
598 $key = sprintf('___sig%d___', $number);
600 return getPref($data_dir, $username, $key);