82474746 |
1 | <?php |
15e6162e |
2 | |
d6c32258 |
3 | /** |
35586184 |
4 | * db_prefs.php |
5 | * |
35586184 |
6 | * This contains functions for manipulating user preferences |
7 | * stored in a database, accessed though the Pear DB layer. |
8 | * |
35586184 |
9 | * Database: |
35586184 |
10 | * |
99a6c222 |
11 | * The preferences table should have three columns: |
12 | * user char \ primary |
35586184 |
13 | * prefkey char / key |
14 | * prefval blob |
15 | * |
4b7dd3d9 |
16 | * CREATE TABLE userprefs (user CHAR(128) NOT NULL DEFAULT '', |
35586184 |
17 | * prefkey CHAR(64) NOT NULL DEFAULT '', |
18 | * prefval BLOB NOT NULL DEFAULT '', |
19 | * primary key (user,prefkey)); |
20 | * |
21 | * Configuration of databasename, username and password is done |
3499f99f |
22 | * by using conf.pl or the administrator plugin |
35586184 |
23 | * |
4b4abf93 |
24 | * @copyright © 1999-2005 The SquirrelMail Project Team |
25 | * @license http://opensource.org/licenses/gpl-license.php GNU Public License |
31841a9e |
26 | * @version $Id$ |
d6c32258 |
27 | * @package squirrelmail |
ace4c62c |
28 | * @subpackage prefs |
29 | * @since 1.1.3 |
35586184 |
30 | */ |
31 | |
ace4c62c |
32 | /** @ignore */ |
33 | if (!defined('SM_PATH')) define('SM_PATH','../'); |
34 | |
d6c32258 |
35 | /** Unknown database */ |
98749983 |
36 | define('SMDB_UNKNOWN', 0); |
d6c32258 |
37 | /** MySQL */ |
98749983 |
38 | define('SMDB_MYSQL', 1); |
d6c32258 |
39 | /** PostgreSQL */ |
98749983 |
40 | define('SMDB_PGSQL', 2); |
41 | |
b68edc75 |
42 | require_once(SM_PATH . 'config/config.php'); |
c9fcea56 |
43 | if (!include_once('DB.php')) { |
44 | // same error also in abook_database.php |
45 | require_once(SM_PATH . 'functions/display_messages.php'); |
46 | $error = _("Could not include PEAR database functions required for the database backend.") . "<br />\n"; |
2ad4cea9 |
47 | $error .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"), |
48 | '<tt>DB.php</tt>') . "<br />\n"; |
c9fcea56 |
49 | $error .= _("Please contact your system administrator and report this error."); |
50 | error_box($error, $color); |
17fca61d |
51 | exit; |
c9fcea56 |
52 | } |
35586184 |
53 | |
370059dd |
54 | global $prefs_are_cached, $prefs_cache; |
2d367c68 |
55 | |
4d30c1b7 |
56 | /** |
57 | * @ignore |
58 | */ |
370059dd |
59 | function cachePrefValues($username) { |
60 | global $prefs_are_cached, $prefs_cache; |
61 | |
37d5278d |
62 | sqgetGlobalVar('prefs_are_cached', $prefs_are_cached, SQ_SESSION ); |
370059dd |
63 | if ($prefs_are_cached) { |
37d5278d |
64 | sqgetGlobalVar('prefs_cache', $prefs_cache, SQ_SESSION ); |
370059dd |
65 | return; |
66 | } |
2d367c68 |
67 | |
9eb0fbd4 |
68 | sqsession_unregister('prefs_cache'); |
69 | sqsession_unregister('prefs_are_cached'); |
370059dd |
70 | |
71 | $db = new dbPrefs; |
72 | if(isset($db->error)) { |
73 | printf( _("Preference database error (%s). Exiting abnormally"), |
74 | $db->error); |
75 | exit; |
76 | } |
2d367c68 |
77 | |
370059dd |
78 | $db->fillPrefsCache($username); |
79 | if (isset($db->error)) { |
80 | printf( _("Preference database error (%s). Exiting abnormally"), |
81 | $db->error); |
82 | exit; |
83 | } |
84 | |
85 | $prefs_are_cached = true; |
86 | |
9eb0fbd4 |
87 | sqsession_register($prefs_cache, 'prefs_cache'); |
88 | sqsession_register($prefs_are_cached, 'prefs_are_cached'); |
370059dd |
89 | } |
90 | |
d6c32258 |
91 | /** |
ace4c62c |
92 | * Class used to handle connections to prefs database and operations with preferences |
d6c32258 |
93 | * @package squirrelmail |
ace4c62c |
94 | * @subpackage prefs |
95 | * @since 1.1.3 |
d6c32258 |
96 | */ |
370059dd |
97 | class dbPrefs { |
ace4c62c |
98 | /** |
99 | * Table used to store preferences |
100 | * @var string |
101 | */ |
370059dd |
102 | var $table = 'userprefs'; |
ace4c62c |
103 | /** |
104 | * Field used to store owner of preference |
105 | * @var string |
106 | */ |
99a6c222 |
107 | var $user_field = 'user'; |
ace4c62c |
108 | /** |
109 | * Field used to store preference name |
110 | * @var string |
111 | */ |
99a6c222 |
112 | var $key_field = 'prefkey'; |
ace4c62c |
113 | /** |
114 | * Field used to store preference value |
115 | * @var string |
116 | */ |
99a6c222 |
117 | var $val_field = 'prefval'; |
370059dd |
118 | |
ace4c62c |
119 | /** |
120 | * Database connection object |
121 | * @var object |
122 | */ |
370059dd |
123 | var $dbh = NULL; |
ace4c62c |
124 | /** |
125 | * Error messages |
126 | * @var string |
127 | */ |
370059dd |
128 | var $error = NULL; |
ace4c62c |
129 | /** |
130 | * Database type (SMDB_* constants) |
131 | * Is used in setKey(). |
132 | * @var integer |
133 | */ |
98749983 |
134 | var $db_type = SMDB_UNKNOWN; |
370059dd |
135 | |
ace4c62c |
136 | /** |
137 | * Default preferences |
138 | * @var array |
139 | */ |
2ea6df85 |
140 | var $default = Array('theme_default' => 0, |
370059dd |
141 | 'show_html_default' => '0'); |
142 | |
06316c07 |
143 | /** |
144 | * Preference owner field size |
145 | * @var integer |
146 | * @since 1.5.1 |
147 | */ |
148 | var $user_size = 128; |
149 | /** |
150 | * Preference key field size |
151 | * @var integer |
152 | * @since 1.5.1 |
153 | */ |
154 | var $key_size = 64; |
155 | /** |
156 | * Preference value field size |
157 | * @var integer |
158 | * @since 1.5.1 |
159 | */ |
160 | var $val_size = 65536; |
161 | |
ace4c62c |
162 | /** |
163 | * initialize DB connection object |
164 | * @return boolean true, if object is initialized |
165 | */ |
370059dd |
166 | function open() { |
3499f99f |
167 | global $prefs_dsn, $prefs_table; |
98749983 |
168 | global $prefs_user_field, $prefs_key_field, $prefs_val_field; |
06316c07 |
169 | global $prefs_user_size, $prefs_key_size, $prefs_val_size; |
3499f99f |
170 | |
370059dd |
171 | if(isset($this->dbh)) { |
172 | return true; |
173 | } |
3499f99f |
174 | |
98749983 |
175 | if (preg_match('/^mysql/', $prefs_dsn)) { |
176 | $this->db_type = SMDB_MYSQL; |
177 | } elseif (preg_match('/^pgsql/', $prefs_dsn)) { |
178 | $this->db_type = SMDB_PGSQL; |
179 | } |
180 | |
3499f99f |
181 | if (!empty($prefs_table)) { |
182 | $this->table = $prefs_table; |
183 | } |
99a6c222 |
184 | if (!empty($prefs_user_field)) { |
185 | $this->user_field = $prefs_user_field; |
186 | } |
187 | if (!empty($prefs_key_field)) { |
188 | $this->key_field = $prefs_key_field; |
189 | } |
190 | if (!empty($prefs_val_field)) { |
191 | $this->val_field = $prefs_val_field; |
192 | } |
06316c07 |
193 | if (!empty($prefs_user_size)) { |
194 | $this->user_size = (int) $prefs_user_size; |
195 | } |
196 | if (!empty($prefs_key_size)) { |
197 | $this->key_size = (int) $prefs_key_size; |
198 | } |
199 | if (!empty($prefs_val_size)) { |
200 | $this->val_size = (int) $prefs_val_size; |
201 | } |
70561170 |
202 | $dbh = DB::connect($prefs_dsn, true); |
2d367c68 |
203 | |
286fe80b |
204 | if(DB::isError($dbh)) { |
2d367c68 |
205 | $this->error = DB::errorMessage($dbh); |
206 | return false; |
207 | } |
208 | |
209 | $this->dbh = $dbh; |
210 | return true; |
370059dd |
211 | } |
82474746 |
212 | |
ace4c62c |
213 | /** |
214 | * Function used to handle database connection errors |
215 | * @param object PEAR Error object |
216 | */ |
370059dd |
217 | function failQuery($res = NULL) { |
2d367c68 |
218 | if($res == NULL) { |
219 | printf(_("Preference database error (%s). Exiting abnormally"), |
370059dd |
220 | $this->error); |
2d367c68 |
221 | } else { |
222 | printf(_("Preference database error (%s). Exiting abnormally"), |
370059dd |
223 | DB::errorMessage($res)); |
2d367c68 |
224 | } |
225 | exit; |
370059dd |
226 | } |
82474746 |
227 | |
ace4c62c |
228 | /** |
229 | * Get user's prefs setting |
230 | * @param string $user user name |
231 | * @param string $key preference name |
232 | * @param mixed $default (since 1.2.5) default value |
233 | * @return mixed preference value |
234 | */ |
370059dd |
235 | function getKey($user, $key, $default = '') { |
236 | global $prefs_cache; |
2d367c68 |
237 | |
370059dd |
238 | cachePrefValues($user); |
2d367c68 |
239 | |
370059dd |
240 | if (isset($prefs_cache[$key])) { |
241 | return $prefs_cache[$key]; |
2d367c68 |
242 | } else { |
62337234 |
243 | if (isset($this->default[$key])) { |
244 | return $this->default[$key]; |
245 | } else { |
246 | return $default; |
247 | } |
2d367c68 |
248 | } |
370059dd |
249 | } |
2d367c68 |
250 | |
ace4c62c |
251 | /** |
252 | * Delete user's prefs setting |
253 | * @param string $user user name |
254 | * @param string $key preference name |
255 | * @return boolean |
256 | */ |
370059dd |
257 | function deleteKey($user, $key) { |
258 | global $prefs_cache; |
82474746 |
259 | |
b279d7f4 |
260 | if (!$this->open()) { |
261 | return false; |
262 | } |
99a6c222 |
263 | $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'", |
370059dd |
264 | $this->table, |
99a6c222 |
265 | $this->user_field, |
370059dd |
266 | $this->dbh->quoteString($user), |
99a6c222 |
267 | $this->key_field, |
370059dd |
268 | $this->dbh->quoteString($key)); |
82474746 |
269 | |
2d367c68 |
270 | $res = $this->dbh->simpleQuery($query); |
370059dd |
271 | if(DB::isError($res)) { |
2d367c68 |
272 | $this->failQuery($res); |
370059dd |
273 | } |
274 | |
275 | unset($prefs_cache[$key]); |
82474746 |
276 | |
2d367c68 |
277 | return true; |
370059dd |
278 | } |
82474746 |
279 | |
ace4c62c |
280 | /** |
281 | * Set user's preference |
282 | * @param string $user user name |
283 | * @param string $key preference name |
284 | * @param mixed $value preference value |
285 | * @return boolean |
286 | */ |
370059dd |
287 | function setKey($user, $key, $value) { |
b279d7f4 |
288 | if (!$this->open()) { |
289 | return false; |
290 | } |
06316c07 |
291 | |
292 | /** |
293 | * Check if username fits into db field |
294 | */ |
295 | if (strlen($user) > $this->user_size) { |
296 | $this->error = "Oversized username value." |
5e07597f |
297 | ." Your preferences can't be saved." |
298 | ." See doc/db-backend.txt or contact your system administrator."; |
06316c07 |
299 | |
300 | /** |
301 | * Debugging function. Can be used to log all issues that trigger |
302 | * oversized field errors. Function should be enabled in all three |
303 | * strlen checks. See http://www.php.net/error-log |
304 | */ |
305 | // error_log($user.'|'.$key.'|'.$value."\n",3,'/tmp/oversized_log'); |
306 | |
307 | // error is fatal |
308 | $this->failQuery(null); |
309 | } |
310 | /** |
311 | * Check if preference key fits into db field |
312 | */ |
313 | if (strlen($key) > $this->key_size) { |
314 | $err_msg = "Oversized user's preference key." |
5e07597f |
315 | ." Some preferences were not saved." |
316 | ." See doc/db-backend.txt or contact your system administrator."; |
06316c07 |
317 | // error is not fatal. Only some preference is not saved. |
318 | trigger_error($err_msg,E_USER_WARNING); |
319 | return false; |
320 | } |
321 | /** |
322 | * Check if preference value fits into db field |
323 | */ |
324 | if (strlen($value) > $this->val_size) { |
325 | $err_msg = "Oversized user's preference value." |
5e07597f |
326 | ." Some preferences were not saved." |
327 | ." See doc/db-backend.txt or contact your system administrator."; |
06316c07 |
328 | // error is not fatal. Only some preference is not saved. |
329 | trigger_error($err_msg,E_USER_WARNING); |
330 | return false; |
331 | } |
332 | |
333 | |
98749983 |
334 | if ($this->db_type == SMDB_MYSQL) { |
335 | $query = sprintf("REPLACE INTO %s (%s, %s, %s) ". |
336 | "VALUES('%s','%s','%s')", |
337 | $this->table, |
338 | $this->user_field, |
339 | $this->key_field, |
340 | $this->val_field, |
341 | $this->dbh->quoteString($user), |
342 | $this->dbh->quoteString($key), |
343 | $this->dbh->quoteString($value)); |
344 | |
345 | $res = $this->dbh->simpleQuery($query); |
346 | if(DB::isError($res)) { |
347 | $this->failQuery($res); |
348 | } |
349 | } elseif ($this->db_type == SMDB_PGSQL) { |
350 | $this->dbh->simpleQuery("BEGIN TRANSACTION"); |
351 | $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'", |
352 | $this->table, |
353 | $this->user_field, |
354 | $this->dbh->quoteString($user), |
355 | $this->key_field, |
356 | $this->dbh->quoteString($key)); |
357 | $res = $this->dbh->simpleQuery($query); |
358 | if (DB::isError($res)) { |
359 | $this->dbh->simpleQuery("ROLLBACK TRANSACTION"); |
360 | $this->failQuery($res); |
361 | } |
362 | $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')", |
363 | $this->table, |
364 | $this->user_field, |
365 | $this->key_field, |
366 | $this->val_field, |
367 | $this->dbh->quoteString($user), |
368 | $this->dbh->quoteString($key), |
369 | $this->dbh->quoteString($value)); |
370 | $res = $this->dbh->simpleQuery($query); |
371 | if (DB::isError($res)) { |
372 | $this->dbh->simpleQuery("ROLLBACK TRANSACTION"); |
373 | $this->failQuery($res); |
374 | } |
375 | $this->dbh->simpleQuery("COMMIT TRANSACTION"); |
376 | } else { |
377 | $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'", |
378 | $this->table, |
379 | $this->user_field, |
380 | $this->dbh->quoteString($user), |
381 | $this->key_field, |
382 | $this->dbh->quoteString($key)); |
383 | $res = $this->dbh->simpleQuery($query); |
384 | if (DB::isError($res)) { |
385 | $this->failQuery($res); |
386 | } |
387 | $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')", |
388 | $this->table, |
389 | $this->user_field, |
390 | $this->key_field, |
391 | $this->val_field, |
392 | $this->dbh->quoteString($user), |
393 | $this->dbh->quoteString($key), |
394 | $this->dbh->quoteString($value)); |
395 | $res = $this->dbh->simpleQuery($query); |
396 | if (DB::isError($res)) { |
397 | $this->failQuery($res); |
398 | } |
370059dd |
399 | } |
2d367c68 |
400 | |
401 | return true; |
370059dd |
402 | } |
82474746 |
403 | |
ace4c62c |
404 | /** |
405 | * Fill preference cache array |
406 | * @param string $user user name |
407 | * @since 1.2.3 |
408 | */ |
370059dd |
409 | function fillPrefsCache($user) { |
410 | global $prefs_cache; |
2d367c68 |
411 | |
b279d7f4 |
412 | if (!$this->open()) { |
413 | return; |
414 | } |
370059dd |
415 | |
416 | $prefs_cache = array(); |
99a6c222 |
417 | $query = sprintf("SELECT %s as prefkey, %s as prefval FROM %s ". |
418 | "WHERE %s = '%s'", |
419 | $this->key_field, |
420 | $this->val_field, |
370059dd |
421 | $this->table, |
99a6c222 |
422 | $this->user_field, |
370059dd |
423 | $this->dbh->quoteString($user)); |
424 | $res = $this->dbh->query($query); |
425 | if (DB::isError($res)) { |
426 | $this->failQuery($res); |
427 | } |
428 | |
429 | while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) { |
430 | $prefs_cache[$row['prefkey']] = $row['prefval']; |
431 | } |
432 | } |
433 | |
370059dd |
434 | } /* end class dbPrefs */ |
82474746 |
435 | |
436 | |
4d30c1b7 |
437 | /** |
438 | * returns the value for the pref $string |
439 | * @ignore |
440 | */ |
370059dd |
441 | function getPref($data_dir, $username, $string, $default = '') { |
442 | $db = new dbPrefs; |
443 | if(isset($db->error)) { |
2d367c68 |
444 | printf( _("Preference database error (%s). Exiting abnormally"), |
370059dd |
445 | $db->error); |
2d367c68 |
446 | exit; |
370059dd |
447 | } |
448 | |
449 | return $db->getKey($username, $string, $default); |
450 | } |
451 | |
4d30c1b7 |
452 | /** |
453 | * Remove the pref $string |
454 | * @ignore |
455 | */ |
370059dd |
456 | function removePref($data_dir, $username, $string) { |
1fa62ab9 |
457 | global $prefs_cache; |
370059dd |
458 | $db = new dbPrefs; |
459 | if(isset($db->error)) { |
460 | $db->failQuery(); |
461 | } |
462 | |
463 | $db->deleteKey($username, $string); |
88a99543 |
464 | |
465 | if (isset($prefs_cache[$string])) { |
466 | unset($prefs_cache[$string]); |
467 | } |
468 | |
469 | sqsession_register($prefs_cache , 'prefs_cache'); |
370059dd |
470 | return; |
471 | } |
472 | |
4d30c1b7 |
473 | /** |
474 | * sets the pref, $string, to $set_to |
475 | * @ignore |
476 | */ |
370059dd |
477 | function setPref($data_dir, $username, $string, $set_to) { |
478 | global $prefs_cache; |
479 | |
4b7dd3d9 |
480 | if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $set_to)) { |
1fa62ab9 |
481 | return; |
370059dd |
482 | } |
483 | |
bce23c86 |
484 | if ($set_to === '') { |
370059dd |
485 | removePref($data_dir, $username, $string); |
486 | return; |
487 | } |
488 | |
489 | $db = new dbPrefs; |
490 | if(isset($db->error)) { |
491 | $db->failQuery(); |
492 | } |
493 | |
494 | $db->setKey($username, $string, $set_to); |
495 | $prefs_cache[$string] = $set_to; |
496 | assert_options(ASSERT_ACTIVE, 1); |
497 | assert_options(ASSERT_BAIL, 1); |
498 | assert ('$set_to == $prefs_cache[$string]'); |
88a99543 |
499 | sqsession_register($prefs_cache , 'prefs_cache'); |
370059dd |
500 | return; |
501 | } |
502 | |
4d30c1b7 |
503 | /** |
504 | * This checks if the prefs are available |
505 | * @ignore |
506 | */ |
370059dd |
507 | function checkForPrefs($data_dir, $username) { |
508 | $db = new dbPrefs; |
509 | if(isset($db->error)) { |
510 | $db->failQuery(); |
511 | } |
512 | } |
513 | |
4d30c1b7 |
514 | /** |
515 | * Writes the Signature |
516 | * @ignore |
517 | */ |
16e5635d |
518 | function setSig($data_dir, $username, $number, $string) { |
16e5635d |
519 | if ($number == "g") { |
520 | $key = '___signature___'; |
521 | } else { |
522 | $key = sprintf('___sig%s___', $number); |
523 | } |
57f1d1c1 |
524 | setPref($data_dir, $username, $key, $string); |
370059dd |
525 | return; |
526 | } |
527 | |
4d30c1b7 |
528 | /** |
529 | * Gets the signature |
530 | * @ignore |
531 | */ |
16e5635d |
532 | function getSig($data_dir, $username, $number) { |
16e5635d |
533 | if ($number == "g") { |
534 | $key = '___signature___'; |
535 | } else { |
536 | $key = sprintf('___sig%d___', $number); |
537 | } |
57f1d1c1 |
538 | return getPref($data_dir, $username, $key); |
370059dd |
539 | } |
540 | |
c9fcea56 |
541 | // vim: et ts=4 |
62f7daa5 |
542 | ?> |