44ef0f47 |
1 | <?php |
2ba13803 |
2 | |
35586184 |
3 | /** |
4 | * options.php |
5 | * |
35586184 |
6 | * Functions needed to display the options pages. |
7 | * |
47ccfad4 |
8 | * @copyright © 1999-2006 The SquirrelMail Project Team |
4b4abf93 |
9 | * @license http://opensource.org/licenses/gpl-license.php GNU Public License |
31841a9e |
10 | * @version $Id$ |
d6c32258 |
11 | * @package squirrelmail |
ca479ad1 |
12 | * @subpackage prefs |
35586184 |
13 | */ |
a3ec3c91 |
14 | |
15 | /**********************************************/ |
16 | /* Define constants used in the options code. */ |
17 | /**********************************************/ |
18 | |
19 | /* Define constants for the various option types. */ |
20 | define('SMOPT_TYPE_STRING', 0); |
21 | define('SMOPT_TYPE_STRLIST', 1); |
7e6d5ea3 |
22 | define('SMOPT_TYPE_TEXTAREA', 2); |
a3ec3c91 |
23 | define('SMOPT_TYPE_INTEGER', 3); |
24 | define('SMOPT_TYPE_FLOAT', 4); |
25 | define('SMOPT_TYPE_BOOLEAN', 5); |
2a50fbd7 |
26 | define('SMOPT_TYPE_HIDDEN', 6); |
bbcafebd |
27 | define('SMOPT_TYPE_COMMENT', 7); |
be2d5495 |
28 | define('SMOPT_TYPE_FLDRLIST', 8); |
a3ec3c91 |
29 | |
30 | /* Define constants for the options refresh levels. */ |
31 | define('SMOPT_REFRESH_NONE', 0); |
32 | define('SMOPT_REFRESH_FOLDERLIST', 1); |
33 | define('SMOPT_REFRESH_ALL', 2); |
34 | |
bbcafebd |
35 | /* Define constants for the options size. */ |
36 | define('SMOPT_SIZE_TINY', 0); |
37 | define('SMOPT_SIZE_SMALL', 1); |
38 | define('SMOPT_SIZE_MEDIUM', 2); |
39 | define('SMOPT_SIZE_LARGE', 3); |
40 | define('SMOPT_SIZE_HUGE', 4); |
88cb1b4d |
41 | define('SMOPT_SIZE_NORMAL', 5); |
bbcafebd |
42 | |
cbe5423b |
43 | define('SMOPT_SAVE_DEFAULT', 'save_option'); |
44 | define('SMOPT_SAVE_NOOP', 'save_option_noop'); |
45 | |
9962527a |
46 | /** |
598294a7 |
47 | * SquirrelOption: An option for SquirrelMail. |
9962527a |
48 | * |
8f6f9ba5 |
49 | * @package squirrelmail |
b4856b14 |
50 | * @subpackage prefs |
9962527a |
51 | */ |
52 | class SquirrelOption { |
b4856b14 |
53 | /** |
54 | * The name of this setting |
55 | * @var string |
56 | */ |
9962527a |
57 | var $name; |
b4856b14 |
58 | /** |
59 | * The text that prefaces setting on the preferences page |
60 | * @var string |
61 | */ |
9962527a |
62 | var $caption; |
b4856b14 |
63 | /** |
64 | * The type of INPUT element |
65 | * |
66 | * See SMOPT_TYPE_* defines |
67 | * @var integer |
68 | */ |
9962527a |
69 | var $type; |
b4856b14 |
70 | /** |
598294a7 |
71 | * Indicates if a link should be shown to refresh part |
b4856b14 |
72 | * or all of the window |
73 | * |
74 | * See SMOPT_REFRESH_* defines |
75 | * @var integer |
76 | */ |
a3ec3c91 |
77 | var $refresh_level; |
b4856b14 |
78 | /** |
79 | * Specifies the size of certain input items |
80 | * |
81 | * See SMOPT_SIZE_* defines |
82 | * @var integer |
83 | */ |
bbcafebd |
84 | var $size; |
b4856b14 |
85 | /** |
598294a7 |
86 | * Text that follows a text input or |
b4856b14 |
87 | * select list input on the preferences page |
598294a7 |
88 | * |
b4856b14 |
89 | * useful for indicating units, meanings of special values, etc. |
90 | * @var string |
91 | */ |
361d6e1b |
92 | var $trailing_text; |
b4856b14 |
93 | /** |
94 | * text displayed to the user |
95 | * |
96 | * Used with SMOPT_TYPE_COMMENT options |
97 | * @var string |
98 | */ |
bbcafebd |
99 | var $comment; |
b4856b14 |
100 | /** |
101 | * additional javascript or other code added to the user input |
102 | * @var string |
103 | */ |
cbe5423b |
104 | var $script; |
b4856b14 |
105 | /** |
598294a7 |
106 | * script (usually Javascript) that will be placed after (outside of) |
b4856b14 |
107 | * the INPUT tag |
108 | * @var string |
109 | */ |
6ae9e729 |
110 | var $post_script; |
cbe5423b |
111 | |
b4856b14 |
112 | /** |
113 | * The name of the Save Function for this option. |
114 | * @var string |
115 | */ |
cbe5423b |
116 | var $save_function; |
9962527a |
117 | |
118 | /* The various 'values' for this options. */ |
b4856b14 |
119 | /** |
120 | * default/preselected value for this option |
121 | * @var mixed |
122 | */ |
9962527a |
123 | var $value; |
b4856b14 |
124 | /** |
125 | * new option value |
126 | * @var mixed |
127 | */ |
9962527a |
128 | var $new_value; |
b4856b14 |
129 | /** |
598294a7 |
130 | * associative array, where each key is an actual input value |
b4856b14 |
131 | * and the corresponding value is what is displayed to the user |
132 | * for that list item in the drop-down list |
133 | * @var array |
134 | */ |
a3ec3c91 |
135 | var $possible_values; |
b4856b14 |
136 | /** |
137 | * disables html sanitizing. |
598294a7 |
138 | * |
139 | * WARNING - don't use it, if user input is possible in option |
140 | * or use own sanitizing functions. Currently works only with |
b4856b14 |
141 | * SMOPT_TYPE_STRLIST. |
142 | * @var bool |
143 | */ |
28520c87 |
144 | var $htmlencoded=false; |
99ecf044 |
145 | /** |
146 | * Controls folder list limits in SMOPT_TYPE_FLDRLIST widget. |
147 | * See $flag argument in sqimap_mailbox_option_list() function. |
148 | * @var string |
149 | * @since 1.5.1 |
150 | */ |
151 | var $folder_filter='noselect'; |
9962527a |
152 | |
b4856b14 |
153 | /** |
154 | * Constructor function |
155 | * @param string $name |
156 | * @param string $caption |
157 | * @param integer $type |
158 | * @param integer $refresh_level |
159 | * @param mixed $initial_value |
160 | * @param array $possible_values |
161 | * @param bool $htmlencoded |
162 | */ |
9962527a |
163 | function SquirrelOption |
28520c87 |
164 | ($name, $caption, $type, $refresh_level, $initial_value = '', $possible_values = '', $htmlencoded = false) { |
9962527a |
165 | /* Set the basic stuff. */ |
166 | $this->name = $name; |
167 | $this->caption = $caption; |
9962527a |
168 | $this->type = $type; |
a3ec3c91 |
169 | $this->refresh_level = $refresh_level; |
170 | $this->possible_values = $possible_values; |
28520c87 |
171 | $this->htmlencoded = $htmlencoded; |
bbcafebd |
172 | $this->size = SMOPT_SIZE_MEDIUM; |
361d6e1b |
173 | $this->trailing_text = ''; |
bbcafebd |
174 | $this->comment = ''; |
cbe5423b |
175 | $this->script = ''; |
6ae9e729 |
176 | $this->post_script = ''; |
a3ec3c91 |
177 | |
991c88e7 |
178 | //Check for a current value. |
179 | if (isset($GLOBALS[$name])) { |
a3ec3c91 |
180 | $this->value = $GLOBALS[$name]; |
17f3d242 |
181 | } else if (!empty($initial_value)) { |
182 | $this->value = $initial_value; |
a3ec3c91 |
183 | } else { |
184 | $this->value = ''; |
185 | } |
9962527a |
186 | |
a3ec3c91 |
187 | /* Check for a new value. */ |
b4856b14 |
188 | if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) { |
a3ec3c91 |
189 | $this->new_value = ''; |
44ef0f47 |
190 | } |
cbe5423b |
191 | |
192 | /* Set the default save function. */ |
2a50fbd7 |
193 | if (($type != SMOPT_TYPE_HIDDEN) && ($type != SMOPT_TYPE_COMMENT)) { |
cbe5423b |
194 | $this->save_function = SMOPT_SAVE_DEFAULT; |
195 | } else { |
196 | $this->save_function = SMOPT_SAVE_NOOP; |
197 | } |
198 | } |
199 | |
b4856b14 |
200 | /** |
201 | * Set the value for this option. |
202 | * @param mixed $value |
203 | */ |
cbe5423b |
204 | function setValue($value) { |
205 | $this->value = $value; |
206 | } |
207 | |
b4856b14 |
208 | /** |
209 | * Set the new value for this option. |
210 | * @param mixed $new_value |
211 | */ |
cbe5423b |
212 | function setNewValue($new_value) { |
213 | $this->new_value = $new_value; |
9962527a |
214 | } |
44ef0f47 |
215 | |
b4856b14 |
216 | /** |
217 | * Set the size for this option. |
218 | * @param integer $size |
219 | */ |
bbcafebd |
220 | function setSize($size) { |
221 | $this->size = $size; |
222 | } |
223 | |
b4856b14 |
224 | /** |
225 | * Set the trailing_text for this option. |
226 | * @param string $trailing_text |
227 | */ |
361d6e1b |
228 | function setTrailingText($trailing_text) { |
229 | $this->trailing_text = $trailing_text; |
230 | } |
231 | |
b4856b14 |
232 | /** |
233 | * Set the comment for this option. |
234 | * @param string $comment |
235 | */ |
bbcafebd |
236 | function setComment($comment) { |
237 | $this->comment = $comment; |
238 | } |
239 | |
b4856b14 |
240 | /** |
241 | * Set the script for this option. |
598294a7 |
242 | * @param string $script |
b4856b14 |
243 | */ |
cbe5423b |
244 | function setScript($script) { |
245 | $this->script = $script; |
246 | } |
247 | |
b4856b14 |
248 | /** |
249 | * Set the "post script" for this option. |
250 | * @param string $post_script |
251 | */ |
6ae9e729 |
252 | function setPostScript($post_script) { |
253 | $this->post_script = $post_script; |
254 | } |
255 | |
b4856b14 |
256 | /** |
257 | * Set the save function for this option. |
258 | * @param string $save_function |
259 | */ |
cbe5423b |
260 | function setSaveFunction($save_function) { |
261 | $this->save_function = $save_function; |
262 | } |
263 | |
99ecf044 |
264 | /** |
265 | * Set the trailing_text for this option. |
266 | * @param string $folder_filter |
267 | * @since 1.5.1 |
268 | */ |
269 | function setFolderFilter($folder_filter) { |
270 | $this->folder_filter = $folder_filter; |
271 | } |
272 | |
b4856b14 |
273 | /** |
274 | * Creates fields on option pages according to option type |
275 | * |
276 | * Function that calls other createWidget* functions. |
598294a7 |
277 | * @return string html formated option field |
b4856b14 |
278 | */ |
a3ec3c91 |
279 | function createHTMLWidget() { |
ce68b76b |
280 | global $color; |
cbe5423b |
281 | |
62f7daa5 |
282 | // Use new value if available |
74e44765 |
283 | if (!empty($this->new_value)) { |
284 | $tempValue = $this->value; |
285 | $this->value = $this->new_value; |
286 | } |
287 | |
cbe5423b |
288 | /* Get the widget for this option type. */ |
a3ec3c91 |
289 | switch ($this->type) { |
290 | case SMOPT_TYPE_STRING: |
37a3ed17 |
291 | $result = $this->createWidget_String(); |
a3ec3c91 |
292 | break; |
293 | case SMOPT_TYPE_STRLIST: |
37a3ed17 |
294 | $result = $this->createWidget_StrList(); |
a3ec3c91 |
295 | break; |
7e6d5ea3 |
296 | case SMOPT_TYPE_TEXTAREA: |
37a3ed17 |
297 | $result = $this->createWidget_TextArea(); |
a3ec3c91 |
298 | break; |
299 | case SMOPT_TYPE_INTEGER: |
37a3ed17 |
300 | $result = $this->createWidget_Integer(); |
a3ec3c91 |
301 | break; |
302 | case SMOPT_TYPE_FLOAT: |
37a3ed17 |
303 | $result = $this->createWidget_Float(); |
a3ec3c91 |
304 | break; |
305 | case SMOPT_TYPE_BOOLEAN: |
37a3ed17 |
306 | $result = $this->createWidget_Boolean(); |
a3ec3c91 |
307 | break; |
2a50fbd7 |
308 | case SMOPT_TYPE_HIDDEN: |
37a3ed17 |
309 | $result = $this->createWidget_Hidden(); |
a3ec3c91 |
310 | break; |
bbcafebd |
311 | case SMOPT_TYPE_COMMENT: |
37a3ed17 |
312 | $result = $this->createWidget_Comment(); |
bbcafebd |
313 | break; |
be2d5495 |
314 | case SMOPT_TYPE_FLDRLIST: |
37a3ed17 |
315 | $result = $this->createWidget_FolderList(); |
be2d5495 |
316 | break; |
a3ec3c91 |
317 | default: |
6b4bd11f |
318 | $result = '<font color="' . $color[2] . '">' |
a3ec3c91 |
319 | . sprintf(_("Option Type '%s' Not Found"), $this->type) |
6b4bd11f |
320 | . '</font>'; |
a3ec3c91 |
321 | } |
322 | |
6ae9e729 |
323 | /* Add the "post script" for this option. */ |
324 | $result .= $this->post_script; |
62f7daa5 |
325 | |
74e44765 |
326 | // put correct value back if need be |
327 | if (!empty($this->new_value)) { |
328 | $this->value = $tempValue; |
329 | } |
330 | |
a3ec3c91 |
331 | /* Now, return the created widget. */ |
332 | return ($result); |
333 | } |
334 | |
b4856b14 |
335 | /** |
336 | * Create string field |
337 | * @return string html formated option field |
338 | */ |
37a3ed17 |
339 | function createWidget_String() { |
bbcafebd |
340 | switch ($this->size) { |
88cb1b4d |
341 | case SMOPT_SIZE_TINY: |
342 | $width = 5; |
343 | break; |
344 | case SMOPT_SIZE_SMALL: |
345 | $width = 12; |
346 | break; |
347 | case SMOPT_SIZE_LARGE: |
348 | $width = 38; |
349 | break; |
350 | case SMOPT_SIZE_HUGE: |
351 | $width = 50; |
352 | break; |
bbcafebd |
353 | case SMOPT_SIZE_NORMAL: |
88cb1b4d |
354 | default: |
355 | $width = 25; |
bbcafebd |
356 | } |
357 | |
88440172 |
358 | $result = "<input type=\"text\" name=\"new_$this->name\" value=\"" . |
62f7daa5 |
359 | htmlspecialchars($this->value) . |
361d6e1b |
360 | "\" size=\"$width\" $this->script />$this->trailing_text\n"; |
a3ec3c91 |
361 | return ($result); |
362 | } |
363 | |
b4856b14 |
364 | /** |
365 | * Create selection box |
366 | * @return string html formated selection box |
367 | */ |
37a3ed17 |
368 | function createWidget_StrList() { |
a3ec3c91 |
369 | /* Begin the select tag. */ |
d6150d69 |
370 | $result = "<select name=\"new_$this->name\" $this->script>\n"; |
a3ec3c91 |
371 | |
372 | /* Add each possible value to the select list. */ |
373 | foreach ($this->possible_values as $real_value => $disp_value) { |
374 | /* Start the next new option string. */ |
62f7daa5 |
375 | $new_option = '<option value="' . |
28520c87 |
376 | ($this->htmlencoded ? $real_value : htmlspecialchars($real_value)) . '"'; |
a3ec3c91 |
377 | |
378 | /* If this value is the current value, select it. */ |
379 | if ($real_value == $this->value) { |
d6150d69 |
380 | $new_option .= ' selected="selected"'; |
a3ec3c91 |
381 | } |
382 | |
383 | /* Add the display value to our option string. */ |
28520c87 |
384 | $new_option .= '>' . ($this->htmlencoded ? $disp_value : htmlspecialchars($disp_value)) . "</option>\n"; |
a3ec3c91 |
385 | |
386 | /* And add the new option string to our select tag. */ |
387 | $result .= $new_option; |
388 | } |
389 | |
390 | /* Close the select tag and return our happy result. */ |
361d6e1b |
391 | $result .= "</select>$this->trailing_text\n"; |
a3ec3c91 |
392 | return ($result); |
393 | } |
394 | |
b4856b14 |
395 | /** |
396 | * Create folder selection box |
397 | * @return string html formated selection box |
398 | */ |
37a3ed17 |
399 | function createWidget_FolderList() { |
be2d5495 |
400 | $selected = array(strtolower($this->value)); |
401 | |
99ecf044 |
402 | /* set initial value */ |
403 | $result = ''; |
be2d5495 |
404 | |
405 | /* Add each possible value to the select list. */ |
406 | foreach ($this->possible_values as $real_value => $disp_value) { |
62f7daa5 |
407 | if ( is_array($disp_value) ) { |
be2d5495 |
408 | /* For folder list, we passed in the array of boxes.. */ |
99ecf044 |
409 | $new_option = sqimap_mailbox_option_list(0, $selected, 0, $disp_value, $this->folder_filter); |
be2d5495 |
410 | } else { |
411 | /* Start the next new option string. */ |
d6150d69 |
412 | $new_option = '<option value="' . htmlspecialchars($real_value) . '"'; |
62f7daa5 |
413 | |
be2d5495 |
414 | /* If this value is the current value, select it. */ |
415 | if ($real_value == $this->value) { |
d6150d69 |
416 | $new_option .= ' selected="selected"'; |
be2d5495 |
417 | } |
62f7daa5 |
418 | |
be2d5495 |
419 | /* Add the display value to our option string. */ |
d6150d69 |
420 | $new_option .= '>' . htmlspecialchars($disp_value) . "</option>\n"; |
be2d5495 |
421 | } |
422 | /* And add the new option string to our select tag. */ |
423 | $result .= $new_option; |
62f7daa5 |
424 | } |
99ecf044 |
425 | |
426 | |
427 | if (empty($result)) { |
428 | // string is displayed when interface can't build folder selection box |
429 | return _("unavailable"); |
430 | } else { |
431 | /* Begin the select tag. */ |
432 | $ret = "<select name=\"new_$this->name\" $this->script>\n"; |
433 | $ret.= $result; |
434 | /* Close the select tag and return our happy result. */ |
435 | $ret.= "</select>\n"; |
436 | return ($ret); |
437 | } |
be2d5495 |
438 | } |
439 | |
b4856b14 |
440 | /** |
441 | * Creates textarea |
442 | * @return string html formated textarea field |
443 | */ |
37a3ed17 |
444 | function createWidget_TextArea() { |
bbcafebd |
445 | switch ($this->size) { |
446 | case SMOPT_SIZE_TINY: $rows = 3; $cols = 10; break; |
447 | case SMOPT_SIZE_SMALL: $rows = 4; $cols = 30; break; |
448 | case SMOPT_SIZE_LARGE: $rows = 10; $cols = 60; break; |
449 | case SMOPT_SIZE_HUGE: $rows = 20; $cols = 80; break; |
450 | case SMOPT_SIZE_NORMAL: |
451 | default: $rows = 5; $cols = 50; |
452 | } |
6b4bd11f |
453 | $result = "<textarea name=\"new_$this->name\" rows=\"$rows\" " |
d6150d69 |
454 | . "cols=\"$cols\" $this->script>" |
455 | . htmlspecialchars($this->value) . "</textarea>\n"; |
bbcafebd |
456 | return ($result); |
a3ec3c91 |
457 | } |
458 | |
b4856b14 |
459 | /** |
460 | * Creates field for integer |
461 | * |
462 | * Difference from createWidget_String is visible only when javascript is enabled |
463 | * @return string html formated option field |
464 | */ |
37a3ed17 |
465 | function createWidget_Integer() { |
b65d1a08 |
466 | global $javascript_on; |
0d08ea5a |
467 | |
b65d1a08 |
468 | // add onChange javascript handler to a regular string widget |
469 | // which will strip out all non-numeric chars |
470 | if ($javascript_on) |
d6150d69 |
471 | return preg_replace('/\/>/', ' onChange="origVal=this.value; newVal=\'\'; ' |
b65d1a08 |
472 | . 'for (i=0;i<origVal.length;i++) { if (origVal.charAt(i)>=\'0\' ' |
473 | . '&& origVal.charAt(i)<=\'9\') newVal += origVal.charAt(i); } ' |
d6150d69 |
474 | . 'this.value=newVal;" />', $this->createWidget_String()); |
b65d1a08 |
475 | else |
37a3ed17 |
476 | return $this->createWidget_String(); |
a3ec3c91 |
477 | } |
478 | |
b4856b14 |
479 | /** |
480 | * Creates field for floating number |
481 | * Difference from createWidget_String is visible only when javascript is enabled |
482 | * @return string html formated option field |
483 | */ |
37a3ed17 |
484 | function createWidget_Float() { |
37a3ed17 |
485 | global $javascript_on; |
486 | |
b65d1a08 |
487 | // add onChange javascript handler to a regular string widget |
62f7daa5 |
488 | // which will strip out all non-numeric (period also OK) chars |
b65d1a08 |
489 | if ($javascript_on) |
d6150d69 |
490 | return preg_replace('/\/>/', ' onChange="origVal=this.value; newVal=\'\'; ' |
b65d1a08 |
491 | . 'for (i=0;i<origVal.length;i++) { if ((origVal.charAt(i)>=\'0\' ' |
492 | . '&& origVal.charAt(i)<=\'9\') || origVal.charAt(i)==\'.\') ' |
d6150d69 |
493 | . 'newVal += origVal.charAt(i); } this.value=newVal;" />' |
37a3ed17 |
494 | , $this->createWidget_String()); |
b65d1a08 |
495 | else |
37a3ed17 |
496 | return $this->createWidget_String(); |
a3ec3c91 |
497 | } |
498 | |
b4856b14 |
499 | /** |
500 | * Creates radio field (yes/no) |
501 | * @return string html formated radio field |
502 | */ |
37a3ed17 |
503 | function createWidget_Boolean() { |
fd87494d |
504 | /* Do the whole current value thing. */ |
505 | if ($this->value != SMPREF_NO) { |
62f7daa5 |
506 | $yes_chk = ' checked="checked"'; |
fd87494d |
507 | $no_chk = ''; |
508 | } else { |
509 | $yes_chk = ''; |
62f7daa5 |
510 | $no_chk = ' checked="checked"'; |
fd87494d |
511 | } |
512 | |
513 | /* Build the yes choice. */ |
f4c37e3c |
514 | $yes_option = '<input type="radio" id="new_' . $this->name . '_yes" ' |
515 | . 'name="new_' . $this->name . '" value="' . SMPREF_YES . '"' |
d6150d69 |
516 | . $yes_chk . ' ' . $this->script . ' /> ' |
f4c37e3c |
517 | . '<label for="new_'.$this->name.'_yes">' . _("Yes") . '</label>'; |
fd87494d |
518 | |
519 | /* Build the no choice. */ |
f4c37e3c |
520 | $no_option = '<input type="radio" id="new_' . $this->name . '_no" ' |
521 | . 'name="new_' . $this->name . '" value="' . SMPREF_NO . '"' |
d6150d69 |
522 | . $no_chk . ' ' . $this->script . ' /> ' |
f4c37e3c |
523 | . '<label for="new_'.$this->name.'_no">' . _("No") . '</label>'; |
fd87494d |
524 | |
525 | /* Build and return the combined "boolean widget". */ |
526 | $result = "$yes_option $no_option"; |
527 | return ($result); |
a3ec3c91 |
528 | } |
529 | |
b4856b14 |
530 | /** |
531 | * Creates hidden field |
532 | * @return string html formated hidden input field |
533 | */ |
37a3ed17 |
534 | function createWidget_Hidden() { |
6b4bd11f |
535 | $result = '<input type="hidden" name="new_' . $this->name |
d6150d69 |
536 | . '" value="' . htmlspecialchars($this->value) |
537 | . '" ' . $this->script . ' />'; |
a3ec3c91 |
538 | return ($result); |
539 | } |
540 | |
b4856b14 |
541 | /** |
542 | * Creates comment |
543 | * @return string comment |
544 | */ |
37a3ed17 |
545 | function createWidget_Comment() { |
bbcafebd |
546 | $result = $this->comment; |
547 | return ($result); |
548 | } |
549 | |
b4856b14 |
550 | /** |
551 | * |
552 | */ |
cbe5423b |
553 | function save() { |
554 | $function = $this->save_function; |
555 | $function($this); |
44ef0f47 |
556 | } |
cbe5423b |
557 | |
b4856b14 |
558 | /** |
559 | * |
560 | */ |
cbe5423b |
561 | function changed() { |
6206f6c4 |
562 | return ($this->value != $this->new_value); |
cbe5423b |
563 | } |
b4856b14 |
564 | } /* End of SquirrelOption class*/ |
cbe5423b |
565 | |
b4856b14 |
566 | /** |
567 | * Saves option |
568 | * @param object $option object that holds option name and new_value |
569 | */ |
cbe5423b |
570 | function save_option($option) { |
dac16606 |
571 | if ( !sqgetGlobalVar('username', $username, SQ_SESSION ) ) { |
572 | /* Can't save the pref if we don't have the username */ |
573 | return; |
0b97a708 |
574 | } |
575 | global $data_dir; |
0b97a708 |
576 | setPref($data_dir, $username, $option->name, $option->new_value); |
cbe5423b |
577 | } |
578 | |
b4856b14 |
579 | /** |
580 | * save function that does not save |
581 | * @param object $option |
582 | */ |
cbe5423b |
583 | function save_option_noop($option) { |
584 | /* Do nothing here... */ |
9962527a |
585 | } |
44ef0f47 |
586 | |
b4856b14 |
587 | /** |
588 | * Create hidden 'optpage' input field with value set by argument |
589 | * @param string $optpage identification of option page |
590 | * @return string html formated hidden input field |
591 | */ |
cbe5423b |
592 | function create_optpage_element($optpage) { |
593 | return create_hidden_element('optpage', $optpage); |
594 | } |
595 | |
b4856b14 |
596 | /** |
597 | * Create hidden 'optmode' input field with value set by argument |
598 | * @param string $optmode |
599 | * @return string html formated hidden input field |
600 | */ |
cbe5423b |
601 | function create_optmode_element($optmode) { |
602 | return create_hidden_element('optmode', $optmode); |
603 | } |
604 | |
b4856b14 |
605 | /** |
606 | * Create hidden field. |
607 | * @param string $name field name |
608 | * @param string $value field value |
609 | * @return string html formated hidden input field |
610 | */ |
cbe5423b |
611 | function create_hidden_element($name, $value) { |
6b4bd11f |
612 | $result = '<input type="hidden" ' |
613 | . 'name="' . $name . '" ' |
d6150d69 |
614 | . 'value="' . htmlspecialchars($value) . '" />'; |
cbe5423b |
615 | return ($result); |
616 | } |
617 | |
b4856b14 |
618 | /** |
619 | * @param array $optgrps |
620 | * @param array $optvals |
621 | * @return array |
622 | */ |
cbe5423b |
623 | function create_option_groups($optgrps, $optvals) { |
a3ec3c91 |
624 | /* Build a simple array with which to start. */ |
625 | $result = array(); |
626 | |
bbcafebd |
627 | /* Create option group for each option group name. */ |
628 | foreach ($optgrps as $grpkey => $grpname) { |
629 | $result[$grpkey] = array(); |
630 | $result[$grpkey]['name'] = $grpname; |
631 | $result[$grpkey]['options'] = array(); |
632 | } |
633 | |
a3ec3c91 |
634 | /* Create a new SquirrelOption for each set of option values. */ |
bbcafebd |
635 | foreach ($optvals as $grpkey => $grpopts) { |
636 | foreach ($grpopts as $optset) { |
28520c87 |
637 | /* Create a new option with all values given. */ |
638 | $next_option = new SquirrelOption( |
7390e240 |
639 | $optset['name'], |
640 | $optset['caption'], |
641 | $optset['type'], |
642 | (isset($optset['refresh']) ? $optset['refresh'] : SMOPT_REFRESH_NONE), |
643 | (isset($optset['initial_value']) ? $optset['initial_value'] : ''), |
644 | (isset($optset['posvals']) ? $optset['posvals'] : ''), |
645 | (isset($optset['htmlencoded']) ? $optset['htmlencoded'] : false) |
646 | ); |
bbcafebd |
647 | |
648 | /* If provided, set the size for this option. */ |
649 | if (isset($optset['size'])) { |
650 | $next_option->setSize($optset['size']); |
651 | } |
652 | |
361d6e1b |
653 | /* If provided, set the trailing_text for this option. */ |
654 | if (isset($optset['trailing_text'])) { |
655 | $next_option->setTrailingText($optset['trailing_text']); |
656 | } |
657 | |
bbcafebd |
658 | /* If provided, set the comment for this option. */ |
659 | if (isset($optset['comment'])) { |
660 | $next_option->setComment($optset['comment']); |
661 | } |
662 | |
cbe5423b |
663 | /* If provided, set the save function for this option. */ |
664 | if (isset($optset['save'])) { |
665 | $next_option->setSaveFunction($optset['save']); |
666 | } |
667 | |
668 | /* If provided, set the script for this option. */ |
669 | if (isset($optset['script'])) { |
670 | $next_option->setScript($optset['script']); |
671 | } |
672 | |
6ae9e729 |
673 | /* If provided, set the "post script" for this option. */ |
674 | if (isset($optset['post_script'])) { |
675 | $next_option->setPostScript($optset['post_script']); |
676 | } |
677 | |
99ecf044 |
678 | /* If provided, set the folder_filter for this option. */ |
679 | if (isset($optset['folder_filter'])) { |
680 | $next_option->setFolderFilter($optset['folder_filter']); |
681 | } |
682 | |
bbcafebd |
683 | /* Add this option to the option array. */ |
684 | $result[$grpkey]['options'][] = $next_option; |
a3ec3c91 |
685 | } |
686 | } |
687 | |
688 | /* Return our resulting array. */ |
689 | return ($result); |
690 | } |
691 | |
b4856b14 |
692 | /** |
693 | * @param array $option_groups |
694 | */ |
cbe5423b |
695 | function print_option_groups($option_groups) { |
2fad95fa |
696 | /* Print each option group. */ |
bbcafebd |
697 | foreach ($option_groups as $next_optgrp) { |
2fad95fa |
698 | /* If it is not blank, print the name for this option group. */ |
699 | if ($next_optgrp['name'] != '') { |
6b4bd11f |
700 | echo html_tag( 'tr', "\n". |
701 | html_tag( 'td', |
702 | '<b>' . $next_optgrp['name'] . '</b>' , |
c435f076 |
703 | 'center' ,'', 'valign="middle" colspan="2" style="white-space: nowrap;"' ) |
6b4bd11f |
704 | ) ."\n"; |
7e235a1a |
705 | } |
706 | |
707 | /* Print each option in this option group. */ |
bbcafebd |
708 | foreach ($next_optgrp['options'] as $option) { |
2a50fbd7 |
709 | if ($option->type != SMOPT_TYPE_HIDDEN) { |
6b4bd11f |
710 | echo html_tag( 'tr', "\n". |
711 | html_tag( 'td', $option->caption . ':', 'right' ,'', 'valign="middle"' ) . |
712 | html_tag( 'td', $option->createHTMLWidget(), 'left' ) |
713 | ) ."\n"; |
bbcafebd |
714 | } else { |
715 | echo $option->createHTMLWidget(); |
716 | } |
717 | } |
7e235a1a |
718 | |
719 | /* Print an empty row after this option group. */ |
6b4bd11f |
720 | echo html_tag( 'tr', |
721 | html_tag( 'td', ' ', 'left', '', 'colspan="2"' ) |
722 | ) . "\n"; |
bbcafebd |
723 | } |
724 | } |
725 | |
b4856b14 |
726 | /** |
727 | * Create submit button inside table row. |
728 | * @param string $name |
729 | */ |
9962527a |
730 | function OptionSubmit( $name ) { |
6b4bd11f |
731 | echo html_tag( 'tr', |
6fd95361 |
732 | html_tag( 'td', '<input type="submit" value="' . _("Submit") . '" name="' . $name . '" /> ', 'right', '', 'colspan="2"' ) |
6b4bd11f |
733 | ) . "\n"; |
9962527a |
734 | } |
02ddcd00 |
735 | |
d6150d69 |
736 | // vim: et ts=4 |