82474746 |
1 | <?php |
15e6162e |
2 | |
370059dd |
3 | /* |
35586184 |
4 | * db_prefs.php |
5 | * |
15e6162e |
6 | * Copyright (c) 1999-2002 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 | * |
12 | * To use this instead of the regular prefs.php, create a |
13 | * database as described below, and replace prefs.php |
14 | * with this file. |
15 | * |
16 | * Database: |
17 | * --------- |
18 | * |
99a6c222 |
19 | * The preferences table should have three columns: |
20 | * user char \ primary |
35586184 |
21 | * prefkey char / key |
22 | * prefval blob |
23 | * |
4b7dd3d9 |
24 | * CREATE TABLE userprefs (user CHAR(128) NOT NULL DEFAULT '', |
35586184 |
25 | * prefkey CHAR(64) NOT NULL DEFAULT '', |
26 | * prefval BLOB NOT NULL DEFAULT '', |
27 | * primary key (user,prefkey)); |
28 | * |
29 | * Configuration of databasename, username and password is done |
3499f99f |
30 | * by using conf.pl or the administrator plugin |
35586184 |
31 | * |
32 | * $Id$ |
33 | */ |
34 | |
35586184 |
35 | require_once('DB.php'); |
3499f99f |
36 | require_once('../config/config.php'); |
35586184 |
37 | |
370059dd |
38 | global $prefs_are_cached, $prefs_cache; |
2d367c68 |
39 | |
370059dd |
40 | function cachePrefValues($username) { |
41 | global $prefs_are_cached, $prefs_cache; |
42 | |
43 | if ($prefs_are_cached) { |
44 | return; |
45 | } |
2d367c68 |
46 | |
370059dd |
47 | session_unregister('prefs_cache'); |
48 | session_unregister('prefs_are_cached'); |
49 | |
50 | $db = new dbPrefs; |
51 | if(isset($db->error)) { |
52 | printf( _("Preference database error (%s). Exiting abnormally"), |
53 | $db->error); |
54 | exit; |
55 | } |
2d367c68 |
56 | |
370059dd |
57 | $db->fillPrefsCache($username); |
58 | if (isset($db->error)) { |
59 | printf( _("Preference database error (%s). Exiting abnormally"), |
60 | $db->error); |
61 | exit; |
62 | } |
63 | |
64 | $prefs_are_cached = true; |
65 | |
66 | session_register('prefs_cache'); |
67 | session_register('prefs_are_cached'); |
68 | } |
69 | |
70 | class dbPrefs { |
370059dd |
71 | var $table = 'userprefs'; |
99a6c222 |
72 | var $user_field = 'user'; |
73 | var $key_field = 'prefkey'; |
74 | var $val_field = 'prefval'; |
370059dd |
75 | |
76 | var $dbh = NULL; |
77 | var $error = NULL; |
78 | |
79 | var $default = Array('chosen_theme' => '../themes/default_theme.php', |
80 | 'show_html_default' => '0'); |
81 | |
82 | function open() { |
3499f99f |
83 | global $prefs_dsn, $prefs_table; |
84 | |
370059dd |
85 | if(isset($this->dbh)) { |
86 | return true; |
87 | } |
3499f99f |
88 | |
89 | if (!empty($prefs_table)) { |
90 | $this->table = $prefs_table; |
91 | } |
99a6c222 |
92 | if (!empty($prefs_user_field)) { |
93 | $this->user_field = $prefs_user_field; |
94 | } |
95 | if (!empty($prefs_key_field)) { |
96 | $this->key_field = $prefs_key_field; |
97 | } |
98 | if (!empty($prefs_val_field)) { |
99 | $this->val_field = $prefs_val_field; |
100 | } |
70561170 |
101 | $dbh = DB::connect($prefs_dsn, true); |
2d367c68 |
102 | |
103 | if(DB::isError($dbh) || DB::isWarning($dbh)) { |
104 | $this->error = DB::errorMessage($dbh); |
105 | return false; |
106 | } |
107 | |
108 | $this->dbh = $dbh; |
109 | return true; |
370059dd |
110 | } |
82474746 |
111 | |
370059dd |
112 | function failQuery($res = NULL) { |
2d367c68 |
113 | if($res == NULL) { |
114 | printf(_("Preference database error (%s). Exiting abnormally"), |
370059dd |
115 | $this->error); |
2d367c68 |
116 | } else { |
117 | printf(_("Preference database error (%s). Exiting abnormally"), |
370059dd |
118 | DB::errorMessage($res)); |
2d367c68 |
119 | } |
120 | exit; |
370059dd |
121 | } |
82474746 |
122 | |
123 | |
370059dd |
124 | function getKey($user, $key, $default = '') { |
125 | global $prefs_cache; |
2d367c68 |
126 | |
370059dd |
127 | cachePrefValues($user); |
2d367c68 |
128 | |
370059dd |
129 | if (isset($prefs_cache[$key])) { |
130 | return $prefs_cache[$key]; |
2d367c68 |
131 | } else { |
62337234 |
132 | if (isset($this->default[$key])) { |
133 | return $this->default[$key]; |
134 | } else { |
135 | return $default; |
136 | } |
2d367c68 |
137 | } |
370059dd |
138 | } |
2d367c68 |
139 | |
370059dd |
140 | function deleteKey($user, $key) { |
141 | global $prefs_cache; |
82474746 |
142 | |
b279d7f4 |
143 | if (!$this->open()) { |
144 | return false; |
145 | } |
99a6c222 |
146 | $query = sprintf("DELETE FROM %s WHERE %s='%s' AND %s='%s'", |
370059dd |
147 | $this->table, |
99a6c222 |
148 | $this->user_field, |
370059dd |
149 | $this->dbh->quoteString($user), |
99a6c222 |
150 | $this->key_field, |
370059dd |
151 | $this->dbh->quoteString($key)); |
82474746 |
152 | |
2d367c68 |
153 | $res = $this->dbh->simpleQuery($query); |
370059dd |
154 | if(DB::isError($res)) { |
2d367c68 |
155 | $this->failQuery($res); |
370059dd |
156 | } |
157 | |
158 | unset($prefs_cache[$key]); |
82474746 |
159 | |
2d367c68 |
160 | if(substr($key, 0, 9) == 'highlight') { |
161 | $this->renumberHighlightList($user); |
162 | } |
82474746 |
163 | |
2d367c68 |
164 | return true; |
370059dd |
165 | } |
82474746 |
166 | |
370059dd |
167 | function setKey($user, $key, $value) { |
b279d7f4 |
168 | if (!$this->open()) { |
169 | return false; |
170 | } |
99a6c222 |
171 | $query = sprintf("REPLACE INTO %s (%s, %s, %s) ". |
370059dd |
172 | "VALUES('%s','%s','%s')", |
173 | $this->table, |
99a6c222 |
174 | $this->user_field, |
175 | $this->key_field, |
176 | $this->val_field, |
370059dd |
177 | $this->dbh->quoteString($user), |
178 | $this->dbh->quoteString($key), |
179 | $this->dbh->quoteString($value)); |
180 | |
181 | $res = $this->dbh->simpleQuery($query); |
182 | if(DB::isError($res)) { |
2d367c68 |
183 | $this->failQuery($res); |
370059dd |
184 | } |
2d367c68 |
185 | |
186 | return true; |
370059dd |
187 | } |
82474746 |
188 | |
370059dd |
189 | function fillPrefsCache($user) { |
190 | global $prefs_cache; |
2d367c68 |
191 | |
b279d7f4 |
192 | if (!$this->open()) { |
193 | return; |
194 | } |
370059dd |
195 | |
196 | $prefs_cache = array(); |
99a6c222 |
197 | $query = sprintf("SELECT %s as prefkey, %s as prefval FROM %s ". |
198 | "WHERE %s = '%s'", |
199 | $this->key_field, |
200 | $this->val_field, |
370059dd |
201 | $this->table, |
99a6c222 |
202 | $this->user_field, |
370059dd |
203 | $this->dbh->quoteString($user)); |
204 | $res = $this->dbh->query($query); |
205 | if (DB::isError($res)) { |
206 | $this->failQuery($res); |
207 | } |
208 | |
209 | while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) { |
210 | $prefs_cache[$row['prefkey']] = $row['prefval']; |
211 | } |
212 | } |
213 | |
214 | /* |
215 | * When a highlight option is deleted the preferences module |
216 | * must renumber the list. This should be done somewhere else, |
217 | * but it is not, so.... |
218 | */ |
219 | function renumberHighlightList($user) { |
b279d7f4 |
220 | if (!$this->open()) { |
221 | return; |
222 | } |
99a6c222 |
223 | $query = sprintf("SELECT %s, %s as prefkey, %s as prefval FROM %s WHERE %s='%s' ". |
224 | "AND %s LIKE 'highlight%%' ORDER BY %s", |
225 | $this->user_field, |
226 | $this->key_field, |
227 | $this->val_field, |
370059dd |
228 | $this->table, |
99a6c222 |
229 | $this->user_field, |
230 | $this->dbh->quoteString($user), |
231 | $this->key_field, |
232 | $this->key_field); |
2d367c68 |
233 | |
234 | $res = $this->dbh->query($query); |
370059dd |
235 | if(DB::isError($res)) { |
2d367c68 |
236 | $this->failQuery($res); |
370059dd |
237 | } |
2d367c68 |
238 | |
370059dd |
239 | /* Store old data in array */ |
2d367c68 |
240 | $rows = Array(); |
370059dd |
241 | while($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) { |
2d367c68 |
242 | $rows[] = $row; |
370059dd |
243 | } |
2d367c68 |
244 | |
370059dd |
245 | /* Renumber keys of old data */ |
2d367c68 |
246 | $hilinum = 0; |
247 | for($i = 0; $i < count($rows) ; $i++) { |
248 | $oldkey = $rows[$i]['prefkey']; |
249 | $newkey = substr($oldkey, 0, 9) . $hilinum; |
250 | $hilinum++; |
251 | |
252 | if($oldkey != $newkey) { |
99a6c222 |
253 | $query = sprintf("UPDATE %s SET %s='%s' ". |
254 | "WHERE %s ='%s' AND %s='%s'", |
370059dd |
255 | $this->table, |
99a6c222 |
256 | $this->key_field, |
370059dd |
257 | $this->dbh->quoteString($newkey), |
99a6c222 |
258 | $this->user_field, |
370059dd |
259 | $this->dbh->quoteString($user), |
99a6c222 |
260 | $this->key_field, |
370059dd |
261 | $this->dbh->quoteString($oldkey)); |
262 | |
263 | $res = $this->dbh->simpleQuery($query); |
264 | if(DB::isError($res)) { |
265 | $this->failQuery($res); |
266 | } |
2d367c68 |
267 | } |
268 | } |
269 | |
270 | return; |
370059dd |
271 | } |
82474746 |
272 | |
370059dd |
273 | } /* end class dbPrefs */ |
82474746 |
274 | |
275 | |
370059dd |
276 | /* returns the value for the pref $string */ |
277 | function getPref($data_dir, $username, $string, $default = '') { |
278 | $db = new dbPrefs; |
279 | if(isset($db->error)) { |
2d367c68 |
280 | printf( _("Preference database error (%s). Exiting abnormally"), |
370059dd |
281 | $db->error); |
2d367c68 |
282 | exit; |
370059dd |
283 | } |
284 | |
285 | return $db->getKey($username, $string, $default); |
286 | } |
287 | |
288 | /* Remove the pref $string */ |
289 | function removePref($data_dir, $username, $string) { |
290 | $db = new dbPrefs; |
291 | if(isset($db->error)) { |
292 | $db->failQuery(); |
293 | } |
294 | |
295 | $db->deleteKey($username, $string); |
296 | return; |
297 | } |
298 | |
299 | /* sets the pref, $string, to $set_to */ |
300 | function setPref($data_dir, $username, $string, $set_to) { |
301 | global $prefs_cache; |
302 | |
4b7dd3d9 |
303 | if (isset($prefs_cache[$string]) && ($prefs_cache[$string] == $set_to)) { |
370059dd |
304 | return; |
305 | } |
306 | |
307 | if ($set_to == '') { |
308 | removePref($data_dir, $username, $string); |
309 | return; |
310 | } |
311 | |
312 | $db = new dbPrefs; |
313 | if(isset($db->error)) { |
314 | $db->failQuery(); |
315 | } |
316 | |
317 | $db->setKey($username, $string, $set_to); |
318 | $prefs_cache[$string] = $set_to; |
319 | assert_options(ASSERT_ACTIVE, 1); |
320 | assert_options(ASSERT_BAIL, 1); |
321 | assert ('$set_to == $prefs_cache[$string]'); |
322 | |
323 | return; |
324 | } |
325 | |
326 | /* This checks if the prefs are available */ |
327 | function checkForPrefs($data_dir, $username) { |
328 | $db = new dbPrefs; |
329 | if(isset($db->error)) { |
330 | $db->failQuery(); |
331 | } |
332 | } |
333 | |
334 | /* Writes the Signature */ |
16e5635d |
335 | function setSig($data_dir, $username, $number, $string) { |
370059dd |
336 | $db = new dbPrefs; |
337 | if(isset($db->error)) { |
338 | $db->failQuery(); |
339 | } |
340 | |
16e5635d |
341 | if ($number == "g") { |
342 | $key = '___signature___'; |
343 | } else { |
344 | $key = sprintf('___sig%s___', $number); |
345 | } |
346 | $db->setKey($username, $key, $string); |
370059dd |
347 | return; |
348 | } |
349 | |
350 | /* Gets the signature */ |
16e5635d |
351 | function getSig($data_dir, $username, $number) { |
370059dd |
352 | $db = new dbPrefs; |
353 | if(isset($db->error)) { |
354 | $db->failQuery(); |
355 | } |
356 | |
16e5635d |
357 | if ($number == "g") { |
358 | $key = '___signature___'; |
359 | } else { |
360 | $key = sprintf('___sig%d___', $number); |
361 | } |
362 | return $db->getKey($username, $key); |
370059dd |
363 | } |
364 | |
82474746 |
365 | ?> |