82474746 |
1 | <?php |
15e6162e |
2 | |
d6c32258 |
3 | /** |
35586184 |
4 | * db_prefs.php |
5 | * |
82d304a0 |
6 | * Copyright (c) 1999-2004 The SquirrelMail Project Team |
35586184 |
7 | * Licensed under the GNU GPL. For full terms see the file COPYING. |
8 | * |
9 | * This contains functions for manipulating user preferences |
10 | * stored in a database, accessed though the Pear DB layer. |
11 | * |
35586184 |
12 | * Database: |
13 | * --------- |
14 | * |
99a6c222 |
15 | * The preferences table should have three columns: |
16 | * user char \ primary |
35586184 |
17 | * prefkey char / key |
18 | * prefval blob |
19 | * |
4b7dd3d9 |
20 | * CREATE TABLE userprefs (user CHAR(128) NOT NULL DEFAULT '', |
35586184 |
21 | * prefkey CHAR(64) NOT NULL DEFAULT '', |
22 | * prefval BLOB NOT NULL DEFAULT '', |
23 | * primary key (user,prefkey)); |
24 | * |
25 | * Configuration of databasename, username and password is done |
3499f99f |
26 | * by using conf.pl or the administrator plugin |
35586184 |
27 | * |
31841a9e |
28 | * @version $Id$ |
d6c32258 |
29 | * @package squirrelmail |
35586184 |
30 | */ |
31 | |
d6c32258 |
32 | /** Unknown database */ |
98749983 |
33 | define('SMDB_UNKNOWN', 0); |
d6c32258 |
34 | /** MySQL */ |
98749983 |
35 | define('SMDB_MYSQL', 1); |
d6c32258 |
36 | /** PostgreSQL */ |
98749983 |
37 | define('SMDB_PGSQL', 2); |
38 | |
b68edc75 |
39 | require_once(SM_PATH . 'config/config.php'); |
c9fcea56 |
40 | if (!include_once('DB.php')) { |
41 | // same error also in abook_database.php |
42 | require_once(SM_PATH . 'functions/display_messages.php'); |
43 | $error = _("Could not include PEAR database functions required for the database backend.") . "<br />\n"; |
2ad4cea9 |
44 | $error .= sprintf(_("Is PEAR installed, and is the include path set correctly to find %s?"), |
45 | '<tt>DB.php</tt>') . "<br />\n"; |
c9fcea56 |
46 | $error .= _("Please contact your system administrator and report this error."); |
47 | error_box($error, $color); |
17fca61d |
48 | exit; |
c9fcea56 |
49 | } |
35586184 |
50 | |
370059dd |
51 | global $prefs_are_cached, $prefs_cache; |
2d367c68 |
52 | |
4d30c1b7 |
53 | /** |
54 | * @ignore |
55 | */ |
370059dd |
56 | function cachePrefValues($username) { |
57 | global $prefs_are_cached, $prefs_cache; |
58 | |
59 | if ($prefs_are_cached) { |
60 | return; |
61 | } |
2d367c68 |
62 | |
9eb0fbd4 |
63 | sqsession_unregister('prefs_cache'); |
64 | sqsession_unregister('prefs_are_cached'); |
370059dd |
65 | |
66 | $db = new dbPrefs; |
67 | if(isset($db->error)) { |
68 | printf( _("Preference database error (%s). Exiting abnormally"), |
69 | $db->error); |
70 | exit; |
71 | } |
2d367c68 |
72 | |
370059dd |
73 | $db->fillPrefsCache($username); |
74 | if (isset($db->error)) { |
75 | printf( _("Preference database error (%s). Exiting abnormally"), |
76 | $db->error); |
77 | exit; |
78 | } |
79 | |
80 | $prefs_are_cached = true; |
81 | |
9eb0fbd4 |
82 | sqsession_register($prefs_cache, 'prefs_cache'); |
83 | sqsession_register($prefs_are_cached, 'prefs_are_cached'); |
370059dd |
84 | } |
85 | |
d6c32258 |
86 | /** |
87 | * Completely undocumented class - someone document it! |
88 | * @package squirrelmail |
89 | */ |
370059dd |
90 | class dbPrefs { |
370059dd |
91 | var $table = 'userprefs'; |
99a6c222 |
92 | var $user_field = 'user'; |
93 | var $key_field = 'prefkey'; |
94 | var $val_field = 'prefval'; |
370059dd |
95 | |
96 | var $dbh = NULL; |
97 | var $error = NULL; |
98749983 |
98 | var $db_type = SMDB_UNKNOWN; |
370059dd |
99 | |
2ea6df85 |
100 | var $default = Array('theme_default' => 0, |
370059dd |
101 | 'show_html_default' => '0'); |
102 | |
103 | function open() { |
3499f99f |
104 | global $prefs_dsn, $prefs_table; |
98749983 |
105 | global $prefs_user_field, $prefs_key_field, $prefs_val_field; |
3499f99f |
106 | |
370059dd |
107 | if(isset($this->dbh)) { |
108 | return true; |
109 | } |
3499f99f |
110 | |
98749983 |
111 | if (preg_match('/^mysql/', $prefs_dsn)) { |
112 | $this->db_type = SMDB_MYSQL; |
113 | } elseif (preg_match('/^pgsql/', $prefs_dsn)) { |
114 | $this->db_type = SMDB_PGSQL; |
115 | } |
116 | |
3499f99f |
117 | if (!empty($prefs_table)) { |
118 | $this->table = $prefs_table; |
119 | } |
99a6c222 |
120 | if (!empty($prefs_user_field)) { |
121 | $this->user_field = $prefs_user_field; |
122 | } |
123 | if (!empty($prefs_key_field)) { |
124 | $this->key_field = $prefs_key_field; |
125 | } |
126 | if (!empty($prefs_val_field)) { |
127 | $this->val_field = $prefs_val_field; |
128 | } |
70561170 |
129 | $dbh = DB::connect($prefs_dsn, true); |
2d367c68 |
130 | |
286fe80b |
131 | if(DB::isError($dbh)) { |
2d367c68 |
132 | $this->error = DB::errorMessage($dbh); |
133 | return false; |
134 | } |
135 | |
136 | $this->dbh = $dbh; |
137 | return true; |
370059dd |
138 | } |
82474746 |
139 | |
370059dd |
140 | function failQuery($res = NULL) { |
2d367c68 |
141 | if($res == NULL) { |
142 | printf(_("Preference database error (%s). Exiting abnormally"), |
370059dd |
143 | $this->error); |
2d367c68 |
144 | } else { |
145 | printf(_("Preference database error (%s). Exiting abnormally"), |
370059dd |
146 | DB::errorMessage($res)); |
2d367c68 |
147 | } |
148 | exit; |
370059dd |
149 | } |
82474746 |
150 | |
151 | |
370059dd |
152 | function getKey($user, $key, $default = '') { |
153 | global $prefs_cache; |
2d367c68 |
154 | |
370059dd |
155 | cachePrefValues($user); |
2d367c68 |
156 | |
370059dd |
157 | if (isset($prefs_cache[$key])) { |
158 | return $prefs_cache[$key]; |
2d367c68 |
159 | } else { |
62337234 |
160 | if (isset($this->default[$key])) { |
161 | return $this->default[$key]; |
162 | } else { |
163 | return $default; |
164 | } |
2d367c68 |
165 | } |
370059dd |
166 | } |
2d367c68 |
167 | |
370059dd |
168 | function deleteKey($user, $key) { |
169 | global $prefs_cache; |
82474746 |
170 | |
b279d7f4 |
171 | if (!$this->open()) { |
172 | return false; |
173 | } |
99a6c222 |
174 | $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'", |
370059dd |
175 | $this->table, |
99a6c222 |
176 | $this->user_field, |
370059dd |
177 | $this->dbh->quoteString($user), |
99a6c222 |
178 | $this->key_field, |
370059dd |
179 | $this->dbh->quoteString($key)); |
82474746 |
180 | |
2d367c68 |
181 | $res = $this->dbh->simpleQuery($query); |
370059dd |
182 | if(DB::isError($res)) { |
2d367c68 |
183 | $this->failQuery($res); |
370059dd |
184 | } |
185 | |
186 | unset($prefs_cache[$key]); |
82474746 |
187 | |
2d367c68 |
188 | return true; |
370059dd |
189 | } |
82474746 |
190 | |
370059dd |
191 | function setKey($user, $key, $value) { |
b279d7f4 |
192 | if (!$this->open()) { |
193 | return false; |
194 | } |
98749983 |
195 | if ($this->db_type == SMDB_MYSQL) { |
196 | $query = sprintf("REPLACE INTO %s (%s, %s, %s) ". |
197 | "VALUES('%s','%s','%s')", |
198 | $this->table, |
199 | $this->user_field, |
200 | $this->key_field, |
201 | $this->val_field, |
202 | $this->dbh->quoteString($user), |
203 | $this->dbh->quoteString($key), |
204 | $this->dbh->quoteString($value)); |
205 | |
206 | $res = $this->dbh->simpleQuery($query); |
207 | if(DB::isError($res)) { |
208 | $this->failQuery($res); |
209 | } |
210 | } elseif ($this->db_type == SMDB_PGSQL) { |
211 | $this->dbh->simpleQuery("BEGIN TRANSACTION"); |
212 | $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'", |
213 | $this->table, |
214 | $this->user_field, |
215 | $this->dbh->quoteString($user), |
216 | $this->key_field, |
217 | $this->dbh->quoteString($key)); |
218 | $res = $this->dbh->simpleQuery($query); |
219 | if (DB::isError($res)) { |
220 | $this->dbh->simpleQuery("ROLLBACK TRANSACTION"); |
221 | $this->failQuery($res); |
222 | } |
223 | $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')", |
224 | $this->table, |
225 | $this->user_field, |
226 | $this->key_field, |
227 | $this->val_field, |
228 | $this->dbh->quoteString($user), |
229 | $this->dbh->quoteString($key), |
230 | $this->dbh->quoteString($value)); |
231 | $res = $this->dbh->simpleQuery($query); |
232 | if (DB::isError($res)) { |
233 | $this->dbh->simpleQuery("ROLLBACK TRANSACTION"); |
234 | $this->failQuery($res); |
235 | } |
236 | $this->dbh->simpleQuery("COMMIT TRANSACTION"); |
237 | } else { |
238 | $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'", |
239 | $this->table, |
240 | $this->user_field, |
241 | $this->dbh->quoteString($user), |
242 | $this->key_field, |
243 | $this->dbh->quoteString($key)); |
244 | $res = $this->dbh->simpleQuery($query); |
245 | if (DB::isError($res)) { |
246 | $this->failQuery($res); |
247 | } |
248 | $query = sprintf("INSERT INTO %s (%s, %s, %s) VALUES ('%s', '%s', '%s')", |
249 | $this->table, |
250 | $this->user_field, |
251 | $this->key_field, |
252 | $this->val_field, |
253 | $this->dbh->quoteString($user), |
254 | $this->dbh->quoteString($key), |
255 | $this->dbh->quoteString($value)); |
256 | $res = $this->dbh->simpleQuery($query); |
257 | if (DB::isError($res)) { |
258 | $this->failQuery($res); |
259 | } |
370059dd |
260 | } |
2d367c68 |
261 | |
262 | return true; |
370059dd |
263 | } |
82474746 |
264 | |
370059dd |
265 | function fillPrefsCache($user) { |
266 | global $prefs_cache; |
2d367c68 |
267 | |
b279d7f4 |
268 | if (!$this->open()) { |
269 | return; |
270 | } |
370059dd |
271 | |
272 | $prefs_cache = array(); |
99a6c222 |
273 | $query = sprintf("SELECT %s as prefkey, %s as prefval FROM %s ". |
274 | "WHERE %s = '%s'", |
275 | $this->key_field, |
276 | $this->val_field, |
370059dd |
277 | $this->table, |
99a6c222 |
278 | $this->user_field, |
370059dd |
279 | $this->dbh->quoteString($user)); |
280 | $res = $this->dbh->query($query); |
281 | if (DB::isError($res)) { |
282 | $this->failQuery($res); |
283 | } |
284 | |
285 | while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) { |
286 | $prefs_cache[$row['prefkey']] = $row['prefval']; |
287 | } |
288 | } |
289 | |
370059dd |
290 | } /* end class dbPrefs */ |
82474746 |
291 | |
292 | |
4d30c1b7 |
293 | /** |
294 | * returns the value for the pref $string |
295 | * @ignore |
296 | */ |
370059dd |
297 | function getPref($data_dir, $username, $string, $default = '') { |
298 | $db = new dbPrefs; |
299 | if(isset($db->error)) { |
2d367c68 |
300 | printf( _("Preference database error (%s). Exiting abnormally"), |
370059dd |
301 | $db->error); |
2d367c68 |
302 | exit; |
370059dd |
303 | } |
304 | |
305 | return $db->getKey($username, $string, $default); |
306 | } |
307 | |
4d30c1b7 |
308 | /** |
309 | * Remove the pref $string |
310 | * @ignore |
311 | */ |
370059dd |
312 | function removePref($data_dir, $username, $string) { |
1fa62ab9 |
313 | global $prefs_cache; |
370059dd |
314 | $db = new dbPrefs; |
315 | if(isset($db->error)) { |
316 | $db->failQuery(); |
317 | } |
318 | |
319 | $db->deleteKey($username, $string); |
88a99543 |
320 | |
321 | if (isset($prefs_cache[$string])) { |
322 | unset($prefs_cache[$string]); |
323 | } |
324 | |
325 | sqsession_register($prefs_cache , 'prefs_cache'); |
370059dd |
326 | return; |
327 | } |
328 | |
4d30c1b7 |
329 | /** |
330 | * sets the pref, $string, to $set_to |
331 | * @ignore |
332 | */ |
370059dd |
333 | function setPref($data_dir, $username, $string, $set_to) { |
334 | global $prefs_cache; |
335 | |
4b7dd3d9 |
336 | if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $set_to)) { |
1fa62ab9 |
337 | return; |
370059dd |
338 | } |
339 | |
bce23c86 |
340 | if ($set_to === '') { |
370059dd |
341 | removePref($data_dir, $username, $string); |
342 | return; |
343 | } |
344 | |
345 | $db = new dbPrefs; |
346 | if(isset($db->error)) { |
347 | $db->failQuery(); |
348 | } |
349 | |
350 | $db->setKey($username, $string, $set_to); |
351 | $prefs_cache[$string] = $set_to; |
352 | assert_options(ASSERT_ACTIVE, 1); |
353 | assert_options(ASSERT_BAIL, 1); |
354 | assert ('$set_to == $prefs_cache[$string]'); |
88a99543 |
355 | sqsession_register($prefs_cache , 'prefs_cache'); |
370059dd |
356 | return; |
357 | } |
358 | |
4d30c1b7 |
359 | /** |
360 | * This checks if the prefs are available |
361 | * @ignore |
362 | */ |
370059dd |
363 | function checkForPrefs($data_dir, $username) { |
364 | $db = new dbPrefs; |
365 | if(isset($db->error)) { |
366 | $db->failQuery(); |
367 | } |
368 | } |
369 | |
4d30c1b7 |
370 | /** |
371 | * Writes the Signature |
372 | * @ignore |
373 | */ |
16e5635d |
374 | function setSig($data_dir, $username, $number, $string) { |
16e5635d |
375 | if ($number == "g") { |
376 | $key = '___signature___'; |
377 | } else { |
378 | $key = sprintf('___sig%s___', $number); |
379 | } |
57f1d1c1 |
380 | setPref($data_dir, $username, $key, $string); |
370059dd |
381 | return; |
382 | } |
383 | |
4d30c1b7 |
384 | /** |
385 | * Gets the signature |
386 | * @ignore |
387 | */ |
16e5635d |
388 | function getSig($data_dir, $username, $number) { |
16e5635d |
389 | if ($number == "g") { |
390 | $key = '___signature___'; |
391 | } else { |
392 | $key = sprintf('___sig%d___', $number); |
393 | } |
57f1d1c1 |
394 | return getPref($data_dir, $username, $key); |
370059dd |
395 | } |
396 | |
c9fcea56 |
397 | // vim: et ts=4 |
398 | ?> |