44ef0f47 |
1 | <?php |
2ba13803 |
2 | |
35586184 |
3 | /** |
4 | * options.php |
5 | * |
76911253 |
6 | * Copyright (c) 1999-2003 The SquirrelMail Project Team |
35586184 |
7 | * Licensed under the GNU GPL. For full terms see the file COPYING. |
8 | * |
9 | * Functions needed to display the options pages. |
10 | * |
11 | * $Id$ |
12 | */ |
a3ec3c91 |
13 | |
14 | /**********************************************/ |
15 | /* Define constants used in the options code. */ |
16 | /**********************************************/ |
17 | |
18 | /* Define constants for the various option types. */ |
19 | define('SMOPT_TYPE_STRING', 0); |
20 | define('SMOPT_TYPE_STRLIST', 1); |
7e6d5ea3 |
21 | define('SMOPT_TYPE_TEXTAREA', 2); |
a3ec3c91 |
22 | define('SMOPT_TYPE_INTEGER', 3); |
23 | define('SMOPT_TYPE_FLOAT', 4); |
24 | define('SMOPT_TYPE_BOOLEAN', 5); |
2a50fbd7 |
25 | define('SMOPT_TYPE_HIDDEN', 6); |
bbcafebd |
26 | define('SMOPT_TYPE_COMMENT', 7); |
be2d5495 |
27 | define('SMOPT_TYPE_FLDRLIST', 8); |
a3ec3c91 |
28 | |
29 | /* Define constants for the options refresh levels. */ |
30 | define('SMOPT_REFRESH_NONE', 0); |
31 | define('SMOPT_REFRESH_FOLDERLIST', 1); |
32 | define('SMOPT_REFRESH_ALL', 2); |
33 | |
bbcafebd |
34 | /* Define constants for the options size. */ |
35 | define('SMOPT_SIZE_TINY', 0); |
36 | define('SMOPT_SIZE_SMALL', 1); |
37 | define('SMOPT_SIZE_MEDIUM', 2); |
38 | define('SMOPT_SIZE_LARGE', 3); |
39 | define('SMOPT_SIZE_HUGE', 4); |
88cb1b4d |
40 | define('SMOPT_SIZE_NORMAL', 5); |
bbcafebd |
41 | |
cbe5423b |
42 | define('SMOPT_SAVE_DEFAULT', 'save_option'); |
43 | define('SMOPT_SAVE_NOOP', 'save_option_noop'); |
44 | |
9962527a |
45 | /** |
46 | * SquirrelOption: An option for Squirrelmail. |
47 | * |
48 | * This class is a work in progress. When complete, it will handle |
49 | * presentation and saving of Squirrelmail user options in a simple, |
50 | * streamline manner. Stay tuned for more stuff. |
51 | * |
52 | * Also, I'd like to ask that people leave this alone (mostly :) until |
53 | * I get it a little further along. That should only be a day or two or |
54 | * three. I will remove this message when it is ready for primetime usage. |
55 | */ |
56 | class SquirrelOption { |
57 | /* The basic stuff. */ |
58 | var $name; |
59 | var $caption; |
9962527a |
60 | var $type; |
a3ec3c91 |
61 | var $refresh_level; |
bbcafebd |
62 | var $size; |
63 | var $comment; |
cbe5423b |
64 | var $script; |
65 | |
66 | /* The name of the Save Function for this option. */ |
67 | var $save_function; |
9962527a |
68 | |
69 | /* The various 'values' for this options. */ |
70 | var $value; |
71 | var $new_value; |
a3ec3c91 |
72 | var $possible_values; |
9962527a |
73 | |
9962527a |
74 | function SquirrelOption |
a3ec3c91 |
75 | ($name, $caption, $type, $refresh_level, $possible_values = '') { |
9962527a |
76 | /* Set the basic stuff. */ |
77 | $this->name = $name; |
78 | $this->caption = $caption; |
9962527a |
79 | $this->type = $type; |
a3ec3c91 |
80 | $this->refresh_level = $refresh_level; |
81 | $this->possible_values = $possible_values; |
bbcafebd |
82 | $this->size = SMOPT_SIZE_MEDIUM; |
83 | $this->comment = ''; |
cbe5423b |
84 | $this->script = ''; |
a3ec3c91 |
85 | |
86 | /* Check for a current value. */ |
87 | if (isset($GLOBALS[$name])) { |
88 | $this->value = $GLOBALS[$name]; |
89 | } else { |
90 | $this->value = ''; |
91 | } |
9962527a |
92 | |
a3ec3c91 |
93 | /* Check for a new value. */ |
dac16606 |
94 | if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) { |
a3ec3c91 |
95 | $this->new_value = ''; |
44ef0f47 |
96 | } |
cbe5423b |
97 | |
98 | /* Set the default save function. */ |
2a50fbd7 |
99 | if (($type != SMOPT_TYPE_HIDDEN) && ($type != SMOPT_TYPE_COMMENT)) { |
cbe5423b |
100 | $this->save_function = SMOPT_SAVE_DEFAULT; |
101 | } else { |
102 | $this->save_function = SMOPT_SAVE_NOOP; |
103 | } |
104 | } |
105 | |
106 | /* Set the value for this option. */ |
107 | function setValue($value) { |
108 | $this->value = $value; |
109 | } |
110 | |
111 | /* Set the new value for this option. */ |
112 | function setNewValue($new_value) { |
113 | $this->new_value = $new_value; |
9962527a |
114 | } |
44ef0f47 |
115 | |
bbcafebd |
116 | /* Set the size for this option. */ |
117 | function setSize($size) { |
118 | $this->size = $size; |
119 | } |
120 | |
121 | /* Set the comment for this option. */ |
122 | function setComment($comment) { |
123 | $this->comment = $comment; |
124 | } |
125 | |
cbe5423b |
126 | /* Set the script for this option. */ |
127 | function setScript($script) { |
128 | $this->script = $script; |
129 | } |
130 | |
131 | /* Set the save function for this option. */ |
132 | function setSaveFunction($save_function) { |
133 | $this->save_function = $save_function; |
134 | } |
135 | |
a3ec3c91 |
136 | function createHTMLWidget() { |
cbe5423b |
137 | global $javascript_on; |
138 | |
139 | /* Get the widget for this option type. */ |
a3ec3c91 |
140 | switch ($this->type) { |
141 | case SMOPT_TYPE_STRING: |
b65d1a08 |
142 | $result = $this->createWidget_String($this->script); |
a3ec3c91 |
143 | break; |
144 | case SMOPT_TYPE_STRLIST: |
b65d1a08 |
145 | $result = $this->createWidget_StrList($this->script); |
a3ec3c91 |
146 | break; |
7e6d5ea3 |
147 | case SMOPT_TYPE_TEXTAREA: |
b65d1a08 |
148 | $result = $this->createWidget_TextArea($this->script); |
a3ec3c91 |
149 | break; |
150 | case SMOPT_TYPE_INTEGER: |
b65d1a08 |
151 | $result = $this->createWidget_Integer($this->script); |
a3ec3c91 |
152 | break; |
153 | case SMOPT_TYPE_FLOAT: |
b65d1a08 |
154 | $result = $this->createWidget_Float($this->script); |
a3ec3c91 |
155 | break; |
156 | case SMOPT_TYPE_BOOLEAN: |
b65d1a08 |
157 | $result = $this->createWidget_Boolean($this->script); |
a3ec3c91 |
158 | break; |
2a50fbd7 |
159 | case SMOPT_TYPE_HIDDEN: |
b65d1a08 |
160 | $result = $this->createWidget_Hidden($this->script); |
a3ec3c91 |
161 | break; |
bbcafebd |
162 | case SMOPT_TYPE_COMMENT: |
b65d1a08 |
163 | $result = $this->createWidget_Comment($this->script); |
bbcafebd |
164 | break; |
be2d5495 |
165 | case SMOPT_TYPE_FLDRLIST: |
b65d1a08 |
166 | $result = $this->createWidget_FolderList($this->script); |
be2d5495 |
167 | break; |
a3ec3c91 |
168 | default: |
6b4bd11f |
169 | $result = '<font color="' . $color[2] . '">' |
a3ec3c91 |
170 | . sprintf(_("Option Type '%s' Not Found"), $this->type) |
6b4bd11f |
171 | . '</font>'; |
a3ec3c91 |
172 | } |
173 | |
174 | /* Now, return the created widget. */ |
175 | return ($result); |
176 | } |
177 | |
b65d1a08 |
178 | function createWidget_String($script) { |
bbcafebd |
179 | switch ($this->size) { |
88cb1b4d |
180 | case SMOPT_SIZE_TINY: |
181 | $width = 5; |
182 | break; |
183 | case SMOPT_SIZE_SMALL: |
184 | $width = 12; |
185 | break; |
186 | case SMOPT_SIZE_LARGE: |
187 | $width = 38; |
188 | break; |
189 | case SMOPT_SIZE_HUGE: |
190 | $width = 50; |
191 | break; |
bbcafebd |
192 | case SMOPT_SIZE_NORMAL: |
88cb1b4d |
193 | default: |
194 | $width = 25; |
bbcafebd |
195 | } |
196 | |
b65d1a08 |
197 | $result = "<input name=\"new_$this->name\" value=\"$this->value\" size=\"$width\" $script>"; |
a3ec3c91 |
198 | return ($result); |
199 | } |
200 | |
b65d1a08 |
201 | function createWidget_StrList($script) { |
a3ec3c91 |
202 | /* Begin the select tag. */ |
b65d1a08 |
203 | $result = "<select name=\"new_$this->name\" $script>"; |
a3ec3c91 |
204 | |
205 | /* Add each possible value to the select list. */ |
206 | foreach ($this->possible_values as $real_value => $disp_value) { |
207 | /* Start the next new option string. */ |
6b4bd11f |
208 | $new_option = "<option value=\"$real_value\""; |
a3ec3c91 |
209 | |
210 | /* If this value is the current value, select it. */ |
211 | if ($real_value == $this->value) { |
6b4bd11f |
212 | $new_option .= ' selected'; |
a3ec3c91 |
213 | } |
214 | |
215 | /* Add the display value to our option string. */ |
6b4bd11f |
216 | $new_option .= ">$disp_value</option>"; |
a3ec3c91 |
217 | |
218 | /* And add the new option string to our select tag. */ |
219 | $result .= $new_option; |
220 | } |
221 | |
222 | /* Close the select tag and return our happy result. */ |
6b4bd11f |
223 | $result .= '</select>'; |
a3ec3c91 |
224 | return ($result); |
225 | } |
226 | |
b65d1a08 |
227 | function createWidget_FolderList($script) { |
be2d5495 |
228 | $selected = array(strtolower($this->value)); |
229 | |
230 | /* Begin the select tag. */ |
b65d1a08 |
231 | $result = "<select name=\"new_$this->name\" $script>"; |
be2d5495 |
232 | |
233 | /* Add each possible value to the select list. */ |
234 | foreach ($this->possible_values as $real_value => $disp_value) { |
235 | if ( is_array($disp_value) ) { |
236 | /* For folder list, we passed in the array of boxes.. */ |
237 | $new_option = sqimap_mailbox_option_list(0, $selected, 0, $disp_value); |
238 | } else { |
239 | /* Start the next new option string. */ |
240 | $new_option = "<option value=\"$real_value\""; |
241 | |
242 | /* If this value is the current value, select it. */ |
243 | if ($real_value == $this->value) { |
244 | $new_option .= ' selected'; |
245 | } |
246 | |
247 | /* Add the display value to our option string. */ |
248 | $new_option .= ">$disp_value</option>"; |
249 | } |
250 | /* And add the new option string to our select tag. */ |
251 | $result .= $new_option; |
252 | } |
253 | /* Close the select tag and return our happy result. */ |
254 | $result .= '</select>'; |
255 | return ($result); |
256 | } |
257 | |
258 | |
b65d1a08 |
259 | function createWidget_TextArea($script) { |
bbcafebd |
260 | switch ($this->size) { |
261 | case SMOPT_SIZE_TINY: $rows = 3; $cols = 10; break; |
262 | case SMOPT_SIZE_SMALL: $rows = 4; $cols = 30; break; |
263 | case SMOPT_SIZE_LARGE: $rows = 10; $cols = 60; break; |
264 | case SMOPT_SIZE_HUGE: $rows = 20; $cols = 80; break; |
265 | case SMOPT_SIZE_NORMAL: |
266 | default: $rows = 5; $cols = 50; |
267 | } |
6b4bd11f |
268 | $result = "<textarea name=\"new_$this->name\" rows=\"$rows\" " |
b65d1a08 |
269 | . "cols=\"$cols\" $script>$this->value</textarea>"; |
bbcafebd |
270 | return ($result); |
a3ec3c91 |
271 | } |
272 | |
b65d1a08 |
273 | function createWidget_Integer($script) { |
8bde22ae |
274 | |
b65d1a08 |
275 | global $javascript_on; |
0d08ea5a |
276 | |
b65d1a08 |
277 | // add onChange javascript handler to a regular string widget |
278 | // which will strip out all non-numeric chars |
279 | if ($javascript_on) |
280 | return preg_replace('/>/', ' onChange="origVal=this.value; newVal=\'\'; ' |
281 | . 'for (i=0;i<origVal.length;i++) { if (origVal.charAt(i)>=\'0\' ' |
282 | . '&& origVal.charAt(i)<=\'9\') newVal += origVal.charAt(i); } ' |
283 | . 'this.value=newVal;">', $this->createWidget_String($script)); |
284 | else |
285 | return $this->createWidget_String($script); |
a3ec3c91 |
286 | } |
287 | |
b65d1a08 |
288 | function createWidget_Float($script) { |
0d08ea5a |
289 | |
b65d1a08 |
290 | // add onChange javascript handler to a regular string widget |
291 | // which will strip out all non-numeric (period also OK) chars |
292 | if ($javascript_on) |
293 | return preg_replace('/>/', ' onChange="origVal=this.value; newVal=\'\'; ' |
294 | . 'for (i=0;i<origVal.length;i++) { if ((origVal.charAt(i)>=\'0\' ' |
295 | . '&& origVal.charAt(i)<=\'9\') || origVal.charAt(i)==\'.\') ' |
296 | . 'newVal += origVal.charAt(i); } this.value=newVal;">' |
297 | , $this->createWidget_String($script)); |
298 | else |
299 | return $this->createWidget_String($script); |
a3ec3c91 |
300 | } |
301 | |
b65d1a08 |
302 | function createWidget_Boolean($script) { |
fd87494d |
303 | /* Do the whole current value thing. */ |
304 | if ($this->value != SMPREF_NO) { |
6b4bd11f |
305 | $yes_chk = ' checked'; |
fd87494d |
306 | $no_chk = ''; |
307 | } else { |
308 | $yes_chk = ''; |
6b4bd11f |
309 | $no_chk = ' checked'; |
fd87494d |
310 | } |
311 | |
312 | /* Build the yes choice. */ |
6b4bd11f |
313 | $yes_option = '<input type="radio" name="new_' . $this->name |
314 | . '" value="' . SMPREF_YES . "\"$yes_chk> " |
fd87494d |
315 | . _("Yes"); |
316 | |
317 | /* Build the no choice. */ |
6b4bd11f |
318 | $no_option = '<input type="radio" name="new_' . $this->name |
319 | . '" value="' . SMPREF_NO . "\"$no_chk> " |
fd87494d |
320 | . _("No"); |
321 | |
322 | /* Build and return the combined "boolean widget". */ |
323 | $result = "$yes_option $no_option"; |
324 | return ($result); |
a3ec3c91 |
325 | } |
326 | |
b65d1a08 |
327 | function createWidget_Hidden($script) { |
6b4bd11f |
328 | $result = '<input type="hidden" name="new_' . $this->name |
329 | . '" value="' . $this->value . '">'; |
a3ec3c91 |
330 | return ($result); |
331 | } |
332 | |
b65d1a08 |
333 | function createWidget_Comment($script) { |
bbcafebd |
334 | $result = $this->comment; |
335 | return ($result); |
336 | } |
337 | |
cbe5423b |
338 | function save() { |
339 | $function = $this->save_function; |
340 | $function($this); |
44ef0f47 |
341 | } |
cbe5423b |
342 | |
343 | function changed() { |
6206f6c4 |
344 | return ($this->value != $this->new_value); |
cbe5423b |
345 | } |
346 | } |
347 | |
348 | function save_option($option) { |
dac16606 |
349 | if ( !sqgetGlobalVar('username', $username, SQ_SESSION ) ) { |
350 | /* Can't save the pref if we don't have the username */ |
351 | return; |
0b97a708 |
352 | } |
353 | global $data_dir; |
0b97a708 |
354 | setPref($data_dir, $username, $option->name, $option->new_value); |
cbe5423b |
355 | } |
356 | |
357 | function save_option_noop($option) { |
358 | /* Do nothing here... */ |
9962527a |
359 | } |
44ef0f47 |
360 | |
cbe5423b |
361 | function create_optpage_element($optpage) { |
362 | return create_hidden_element('optpage', $optpage); |
363 | } |
364 | |
365 | function create_optmode_element($optmode) { |
366 | return create_hidden_element('optmode', $optmode); |
367 | } |
368 | |
369 | function create_hidden_element($name, $value) { |
6b4bd11f |
370 | $result = '<input type="hidden" ' |
371 | . 'name="' . $name . '" ' |
372 | . 'value="' . $value . '">'; |
cbe5423b |
373 | return ($result); |
374 | } |
375 | |
cbe5423b |
376 | function create_option_groups($optgrps, $optvals) { |
a3ec3c91 |
377 | /* Build a simple array with which to start. */ |
378 | $result = array(); |
379 | |
bbcafebd |
380 | /* Create option group for each option group name. */ |
381 | foreach ($optgrps as $grpkey => $grpname) { |
382 | $result[$grpkey] = array(); |
383 | $result[$grpkey]['name'] = $grpname; |
384 | $result[$grpkey]['options'] = array(); |
385 | } |
386 | |
a3ec3c91 |
387 | /* Create a new SquirrelOption for each set of option values. */ |
bbcafebd |
388 | foreach ($optvals as $grpkey => $grpopts) { |
389 | foreach ($grpopts as $optset) { |
390 | if (isset($optset['posvals'])) { |
391 | /* Create a new option with all values given. */ |
392 | $next_option = new SquirrelOption( |
393 | $optset['name'], |
394 | $optset['caption'], |
395 | $optset['type'], |
396 | $optset['refresh'], |
397 | $optset['posvals'] |
398 | ); |
399 | } else { |
400 | /* Create a new option with all but possible values given. */ |
401 | $next_option = new SquirrelOption( |
402 | $optset['name'], |
403 | $optset['caption'], |
404 | $optset['type'], |
405 | $optset['refresh'] |
406 | ); |
407 | } |
408 | |
409 | /* If provided, set the size for this option. */ |
410 | if (isset($optset['size'])) { |
411 | $next_option->setSize($optset['size']); |
412 | } |
413 | |
414 | /* If provided, set the comment for this option. */ |
415 | if (isset($optset['comment'])) { |
416 | $next_option->setComment($optset['comment']); |
417 | } |
418 | |
cbe5423b |
419 | /* If provided, set the save function for this option. */ |
420 | if (isset($optset['save'])) { |
421 | $next_option->setSaveFunction($optset['save']); |
422 | } |
423 | |
424 | /* If provided, set the script for this option. */ |
425 | if (isset($optset['script'])) { |
426 | $next_option->setScript($optset['script']); |
427 | } |
428 | |
bbcafebd |
429 | /* Add this option to the option array. */ |
430 | $result[$grpkey]['options'][] = $next_option; |
a3ec3c91 |
431 | } |
432 | } |
433 | |
434 | /* Return our resulting array. */ |
435 | return ($result); |
436 | } |
437 | |
cbe5423b |
438 | function print_option_groups($option_groups) { |
2fad95fa |
439 | /* Print each option group. */ |
bbcafebd |
440 | foreach ($option_groups as $next_optgrp) { |
2fad95fa |
441 | /* If it is not blank, print the name for this option group. */ |
442 | if ($next_optgrp['name'] != '') { |
6b4bd11f |
443 | echo html_tag( 'tr', "\n". |
444 | html_tag( 'td', |
445 | '<b>' . $next_optgrp['name'] . '</b>' , |
446 | 'center' ,'', 'valign="middle" colspan="2" nowrap' ) |
447 | ) ."\n"; |
7e235a1a |
448 | } |
449 | |
450 | /* Print each option in this option group. */ |
bbcafebd |
451 | foreach ($next_optgrp['options'] as $option) { |
2a50fbd7 |
452 | if ($option->type != SMOPT_TYPE_HIDDEN) { |
6b4bd11f |
453 | echo html_tag( 'tr', "\n". |
454 | html_tag( 'td', $option->caption . ':', 'right' ,'', 'valign="middle"' ) . |
455 | html_tag( 'td', $option->createHTMLWidget(), 'left' ) |
456 | ) ."\n"; |
bbcafebd |
457 | } else { |
458 | echo $option->createHTMLWidget(); |
459 | } |
460 | } |
7e235a1a |
461 | |
462 | /* Print an empty row after this option group. */ |
6b4bd11f |
463 | echo html_tag( 'tr', |
464 | html_tag( 'td', ' ', 'left', '', 'colspan="2"' ) |
465 | ) . "\n"; |
bbcafebd |
466 | } |
467 | } |
468 | |
9962527a |
469 | function OptionSubmit( $name ) { |
6b4bd11f |
470 | echo html_tag( 'tr', |
471 | html_tag( 'td', ' ', 'left', '', 'colspan="2"' ) . |
472 | html_tag( 'td', '<input type="submit" value="' . _("Submit") . '" name="' . $name . '">', 'left', '', 'colspan="2"' ) |
473 | ) . "\n"; |
9962527a |
474 | } |
02ddcd00 |
475 | |
23d6bd09 |
476 | ?> |