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-2006 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
87 * @package squirrelmail
93 * Table used to store preferences
96 var $table = 'userprefs';
98 * Field used to store owner of preference
101 var $user_field = 'user';
103 * Field used to store preference name
106 var $key_field = 'prefkey';
108 * Field used to store preference value
111 var $val_field = 'prefval';
114 * Database connection object
124 * Database type (SMDB_* constants)
125 * Is used in setKey().
128 var $db_type = SMDB_UNKNOWN
;
131 * Default preferences
134 var $default = Array('theme_default' => 0,
135 'show_html_default' => '0');
138 * Preference owner field size
142 var $user_size = 128;
144 * Preference key field size
150 * Preference value field size
154 var $val_size = 65536;
157 * initialize DB connection object
158 * @return boolean true, if object is initialized
161 global $prefs_dsn, $prefs_table;
162 global $prefs_user_field, $prefs_key_field, $prefs_val_field;
163 global $prefs_user_size, $prefs_key_size, $prefs_val_size;
165 /* test if Pear DB class is available and freak out if it is not */
166 if (! class_exists('DB')) {
167 // same error also in abook_database.php
168 $this->error
= _("Could not include PEAR database functions required for the database backend.") . "<br />\n";
169 $this->error
.= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"),
170 '<tt>DB.php</tt>') . "<br />\n";
171 $this->error
.= _("Please contact your system administrator and report this error.");
175 if(isset($this->dbh
)) {
179 if (preg_match('/^mysql/', $prefs_dsn)) {
180 $this->db_type
= SMDB_MYSQL
;
181 } elseif (preg_match('/^pgsql/', $prefs_dsn)) {
182 $this->db_type
= SMDB_PGSQL
;
185 if (!empty($prefs_table)) {
186 $this->table
= $prefs_table;
188 if (!empty($prefs_user_field)) {
189 $this->user_field
= $prefs_user_field;
191 if (!empty($prefs_key_field)) {
192 $this->key_field
= $prefs_key_field;
194 if (!empty($prefs_val_field)) {
195 $this->val_field
= $prefs_val_field;
197 if (!empty($prefs_user_size)) {
198 $this->user_size
= (int) $prefs_user_size;
200 if (!empty($prefs_key_size)) {
201 $this->key_size
= (int) $prefs_key_size;
203 if (!empty($prefs_val_size)) {
204 $this->val_size
= (int) $prefs_val_size;
206 $dbh = DB
::connect($prefs_dsn, true);
208 if(DB
::isError($dbh)) {
209 $this->error
= DB
::errorMessage($dbh);
218 * Function used to handle database connection errors
219 * @param object PEAR Error object
221 function failQuery($res = NULL) {
223 printf(_("Preference database error (%s). Exiting abnormally"),
226 printf(_("Preference database error (%s). Exiting abnormally"),
227 DB
::errorMessage($res));
233 * Get user's prefs setting
234 * @param string $user user name
235 * @param string $key preference name
236 * @param mixed $default (since 1.2.5) default value
237 * @return mixed preference value
239 function getKey($user, $key, $default = '') {
242 cachePrefValues($user);
244 if (isset($prefs_cache[$key])) {
245 return $prefs_cache[$key];
247 if (isset($this->default[$key])) {
248 return $this->default[$key];
256 * Delete user's prefs setting
257 * @param string $user user name
258 * @param string $key preference name
261 function deleteKey($user, $key) {
264 if (!$this->open()) {
267 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
270 $this->dbh
->quoteString($user),
272 $this->dbh
->quoteString($key));
274 $res = $this->dbh
->simpleQuery($query);
275 if(DB
::isError($res)) {
276 $this->failQuery($res);
279 unset($prefs_cache[$key]);
285 * Set user's preference
286 * @param string $user user name
287 * @param string $key preference name
288 * @param mixed $value preference value
291 function setKey($user, $key, $value) {
292 if (!$this->open()) {
297 * Check if username fits into db field
299 if (strlen($user) > $this->user_size
) {
300 $this->error
= "Oversized username value."
301 ." Your preferences can't be saved."
302 ." See doc/db-backend.txt or contact your system administrator.";
305 * Debugging function. Can be used to log all issues that trigger
306 * oversized field errors. Function should be enabled in all three
307 * strlen checks. See http://www.php.net/error-log
309 // error_log($user.'|'.$key.'|'.$value."\n",3,'/tmp/oversized_log');
312 $this->failQuery(null);
315 * Check if preference key fits into db field
317 if (strlen($key) > $this->key_size
) {
318 $err_msg = "Oversized user's preference key."
319 ." Some preferences were not saved."
320 ." See doc/db-backend.txt or contact your system administrator.";
321 // error is not fatal. Only some preference is not saved.
322 trigger_error($err_msg,E_USER_WARNING
);
326 * Check if preference value fits into db field
328 if (strlen($value) > $this->val_size
) {
329 $err_msg = "Oversized user's preference value."
330 ." Some preferences were not saved."
331 ." See doc/db-backend.txt or contact your system administrator.";
332 // error is not fatal. Only some preference is not saved.
333 trigger_error($err_msg,E_USER_WARNING
);
338 if ($this->db_type
== SMDB_MYSQL
) {
339 $query = sprintf("REPLACE INTO %s (%s, %s, %s) ".
340 "VALUES('%s','%s','%s')",
345 $this->dbh
->quoteString($user),
346 $this->dbh
->quoteString($key),
347 $this->dbh
->quoteString($value));
349 $res = $this->dbh
->simpleQuery($query);
350 if(DB
::isError($res)) {
351 $this->failQuery($res);
353 } elseif ($this->db_type
== SMDB_PGSQL
) {
354 $this->dbh
->simpleQuery("BEGIN TRANSACTION");
355 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
358 $this->dbh
->quoteString($user),
360 $this->dbh
->quoteString($key));
361 $res = $this->dbh
->simpleQuery($query);
362 if (DB
::isError($res)) {
363 $this->dbh
->simpleQuery("ROLLBACK TRANSACTION");
364 $this->failQuery($res);
366 $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
371 $this->dbh
->quoteString($user),
372 $this->dbh
->quoteString($key),
373 $this->dbh
->quoteString($value));
374 $res = $this->dbh
->simpleQuery($query);
375 if (DB
::isError($res)) {
376 $this->dbh
->simpleQuery("ROLLBACK TRANSACTION");
377 $this->failQuery($res);
379 $this->dbh
->simpleQuery("COMMIT TRANSACTION");
381 $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'",
384 $this->dbh
->quoteString($user),
386 $this->dbh
->quoteString($key));
387 $res = $this->dbh
->simpleQuery($query);
388 if (DB
::isError($res)) {
389 $this->failQuery($res);
391 $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')",
396 $this->dbh
->quoteString($user),
397 $this->dbh
->quoteString($key),
398 $this->dbh
->quoteString($value));
399 $res = $this->dbh
->simpleQuery($query);
400 if (DB
::isError($res)) {
401 $this->failQuery($res);
409 * Fill preference cache array
410 * @param string $user user name
413 function fillPrefsCache($user) {
416 if (!$this->open()) {
420 $prefs_cache = array();
421 $query = sprintf("SELECT %s as prefkey, %s as prefval FROM %s ".
427 $this->dbh
->quoteString($user));
428 $res = $this->dbh
->query($query);
429 if (DB
::isError($res)) {
430 $this->failQuery($res);
433 while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC
)) {
434 $prefs_cache[$row['prefkey']] = $row['prefval'];
438 } /* end class dbPrefs */
442 * returns the value for the pref $string
445 function getPref($data_dir, $username, $string, $default = '') {
447 if(isset($db->error
)) {
448 printf( _("Preference database error (%s). Exiting abnormally"),
453 return $db->getKey($username, $string, $default);
457 * Remove the pref $string
460 function removePref($data_dir, $username, $string) {
463 if(isset($db->error
)) {
467 $db->deleteKey($username, $string);
469 if (isset($prefs_cache[$string])) {
470 unset($prefs_cache[$string]);
473 sqsession_register($prefs_cache , 'prefs_cache');
478 * sets the pref, $string, to $set_to
481 function setPref($data_dir, $username, $string, $set_to) {
484 if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $set_to)) {
488 if ($set_to === '') {
489 removePref($data_dir, $username, $string);
494 if(isset($db->error
)) {
498 $db->setKey($username, $string, $set_to);
499 $prefs_cache[$string] = $set_to;
500 assert_options(ASSERT_ACTIVE
, 1);
501 assert_options(ASSERT_BAIL
, 1);
502 assert ('$set_to == $prefs_cache[$string]');
503 sqsession_register($prefs_cache , 'prefs_cache');
508 * This checks if the prefs are available
511 function checkForPrefs($data_dir, $username) {
513 if(isset($db->error
)) {
519 * Writes the Signature
522 function setSig($data_dir, $username, $number, $string) {
523 if ($number == "g") {
524 $key = '___signature___';
526 $key = sprintf('___sig%s___', $number);
528 setPref($data_dir, $username, $key, $string);
536 function getSig($data_dir, $username, $number) {
537 if ($number == "g") {
538 $key = '___signature___';
540 $key = sprintf('___sig%d___', $number);
542 return getPref($data_dir, $username, $key);