44ef0f47 |
1 | <?php |
2ba13803 |
2 | |
35586184 |
3 | /** |
4 | * options.php |
5 | * |
35586184 |
6 | * Functions needed to display the options pages. |
7 | * |
4b5049de |
8 | * @copyright © 1999-2007 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 | |
9962527a |
15 | /** |
598294a7 |
16 | * SquirrelOption: An option for SquirrelMail. |
9962527a |
17 | * |
8f6f9ba5 |
18 | * @package squirrelmail |
b4856b14 |
19 | * @subpackage prefs |
9962527a |
20 | */ |
21 | class SquirrelOption { |
d789daf0 |
22 | /** |
23 | * The original option configuration array |
24 | * @var array |
25 | */ |
26 | var $raw_option_array; |
b4856b14 |
27 | /** |
28 | * The name of this setting |
29 | * @var string |
30 | */ |
9962527a |
31 | var $name; |
b4856b14 |
32 | /** |
33 | * The text that prefaces setting on the preferences page |
34 | * @var string |
35 | */ |
9962527a |
36 | var $caption; |
e40b0e8e |
37 | /** |
38 | * Whether or not the caption text is allowed to wrap |
39 | * @var boolean |
40 | */ |
41 | var $caption_wrap; |
b4856b14 |
42 | /** |
43 | * The type of INPUT element |
44 | * |
45 | * See SMOPT_TYPE_* defines |
46 | * @var integer |
47 | */ |
9962527a |
48 | var $type; |
b4856b14 |
49 | /** |
598294a7 |
50 | * Indicates if a link should be shown to refresh part |
b4856b14 |
51 | * or all of the window |
52 | * |
53 | * See SMOPT_REFRESH_* defines |
54 | * @var integer |
55 | */ |
a3ec3c91 |
56 | var $refresh_level; |
b4856b14 |
57 | /** |
58 | * Specifies the size of certain input items |
59 | * |
60 | * See SMOPT_SIZE_* defines |
61 | * @var integer |
62 | */ |
bbcafebd |
63 | var $size; |
b4856b14 |
64 | /** |
598294a7 |
65 | * Text that follows a text input or |
b4856b14 |
66 | * select list input on the preferences page |
598294a7 |
67 | * |
b4856b14 |
68 | * useful for indicating units, meanings of special values, etc. |
69 | * @var string |
70 | */ |
361d6e1b |
71 | var $trailing_text; |
5b277d00 |
72 | /** |
73 | * Text that overrides the "Yes" label for boolean |
74 | * radio option widgets |
75 | * |
76 | * @var string |
77 | */ |
78 | var $yes_text; |
79 | /** |
80 | * Text that overrides the "No" label for boolean |
81 | * radio option widgets |
82 | * |
83 | * @var string |
84 | */ |
85 | var $no_text; |
52639d23 |
86 | /** |
87 | * Some widgets support more than one layout type |
88 | * |
89 | * @var int |
90 | */ |
91 | var $layout_type; |
b6a08d2d |
92 | /** |
93 | * Indicates if the Add widget should be included |
94 | * with edit lists. |
95 | * |
96 | * @var boolean |
97 | */ |
98 | var $use_add_widget; |
de4c101c |
99 | /** |
100 | * Indicates if the Delete widget should be included |
101 | * with edit lists. |
102 | * |
103 | * @var boolean |
104 | */ |
105 | var $use_delete_widget; |
b4856b14 |
106 | /** |
107 | * text displayed to the user |
108 | * |
109 | * Used with SMOPT_TYPE_COMMENT options |
110 | * @var string |
111 | */ |
bbcafebd |
112 | var $comment; |
b4856b14 |
113 | /** |
0177059f |
114 | * additional javascript or other widget attributes added to the |
115 | * user input; must be an array where keys are attribute names |
116 | * ("onclick", etc) and values are the attribute values. |
117 | * @var array |
b4856b14 |
118 | */ |
0177059f |
119 | var $aExtraAttribs; |
b4856b14 |
120 | /** |
598294a7 |
121 | * script (usually Javascript) that will be placed after (outside of) |
b4856b14 |
122 | * the INPUT tag |
123 | * @var string |
124 | */ |
6ae9e729 |
125 | var $post_script; |
cbe5423b |
126 | |
b4856b14 |
127 | /** |
128 | * The name of the Save Function for this option. |
129 | * @var string |
130 | */ |
cbe5423b |
131 | var $save_function; |
9962527a |
132 | |
133 | /* The various 'values' for this options. */ |
b4856b14 |
134 | /** |
135 | * default/preselected value for this option |
136 | * @var mixed |
137 | */ |
9962527a |
138 | var $value; |
b4856b14 |
139 | /** |
140 | * new option value |
141 | * @var mixed |
142 | */ |
9962527a |
143 | var $new_value; |
b4856b14 |
144 | /** |
598294a7 |
145 | * associative array, where each key is an actual input value |
b4856b14 |
146 | * and the corresponding value is what is displayed to the user |
147 | * for that list item in the drop-down list |
148 | * @var array |
149 | */ |
a3ec3c91 |
150 | var $possible_values; |
b4856b14 |
151 | /** |
152 | * disables html sanitizing. |
598294a7 |
153 | * |
154 | * WARNING - don't use it, if user input is possible in option |
0177059f |
155 | * or use own sanitizing functions. Currently only works for SMOPT_TYPE_STRLIST. |
b4856b14 |
156 | * @var bool |
157 | */ |
28520c87 |
158 | var $htmlencoded=false; |
99ecf044 |
159 | /** |
42b7c9d4 |
160 | * Controls folder list limits in SMOPT_TYPE_FLDRLIST and |
161 | * SMOPT_TYPE_FLDRLIST_MULTI widgets. |
99ecf044 |
162 | * See $flag argument in sqimap_mailbox_option_list() function. |
163 | * @var string |
164 | * @since 1.5.1 |
165 | */ |
166 | var $folder_filter='noselect'; |
9962527a |
167 | |
b4856b14 |
168 | /** |
169 | * Constructor function |
d789daf0 |
170 | * @param array $raw_option_array |
b4856b14 |
171 | * @param string $name |
172 | * @param string $caption |
173 | * @param integer $type |
174 | * @param integer $refresh_level |
175 | * @param mixed $initial_value |
176 | * @param array $possible_values |
177 | * @param bool $htmlencoded |
178 | */ |
9962527a |
179 | function SquirrelOption |
d789daf0 |
180 | ($raw_option_array, $name, $caption, $type, $refresh_level, $initial_value = '', $possible_values = '', $htmlencoded = false) { |
9962527a |
181 | /* Set the basic stuff. */ |
d789daf0 |
182 | $this->raw_option_array = $raw_option_array; |
9962527a |
183 | $this->name = $name; |
184 | $this->caption = $caption; |
e40b0e8e |
185 | $this->caption_wrap = TRUE; |
9962527a |
186 | $this->type = $type; |
a3ec3c91 |
187 | $this->refresh_level = $refresh_level; |
188 | $this->possible_values = $possible_values; |
28520c87 |
189 | $this->htmlencoded = $htmlencoded; |
b1dcab7e |
190 | $this->size = SMOPT_SIZE_NORMAL; |
361d6e1b |
191 | $this->trailing_text = ''; |
5b277d00 |
192 | $this->yes_text = ''; |
193 | $this->no_text = ''; |
bbcafebd |
194 | $this->comment = ''; |
52639d23 |
195 | $this->layout_type = 0; |
b6a08d2d |
196 | $this->use_add_widget = TRUE; |
de4c101c |
197 | $this->use_delete_widget = TRUE; |
0177059f |
198 | $this->aExtraAttribs = array(); |
6ae9e729 |
199 | $this->post_script = ''; |
a3ec3c91 |
200 | |
991c88e7 |
201 | //Check for a current value. |
202 | if (isset($GLOBALS[$name])) { |
a3ec3c91 |
203 | $this->value = $GLOBALS[$name]; |
17f3d242 |
204 | } else if (!empty($initial_value)) { |
205 | $this->value = $initial_value; |
a3ec3c91 |
206 | } else { |
207 | $this->value = ''; |
208 | } |
9962527a |
209 | |
a3ec3c91 |
210 | /* Check for a new value. */ |
b4856b14 |
211 | if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) { |
59fc0b63 |
212 | $this->new_value = NULL; |
44ef0f47 |
213 | } |
cbe5423b |
214 | |
215 | /* Set the default save function. */ |
6c06cf54 |
216 | if ($type != SMOPT_TYPE_HIDDEN |
217 | && $type != SMOPT_TYPE_INFO |
218 | && $type != SMOPT_TYPE_COMMENT) { |
cbe5423b |
219 | $this->save_function = SMOPT_SAVE_DEFAULT; |
220 | } else { |
221 | $this->save_function = SMOPT_SAVE_NOOP; |
222 | } |
223 | } |
224 | |
5a42c101 |
225 | /** Convenience function that identifies which types of |
226 | widgets are stored as (serialized) array values. */ |
227 | function is_multiple_valued() { |
228 | return ($this->type == SMOPT_TYPE_FLDRLIST_MULTI |
229 | || $this->type == SMOPT_TYPE_STRLIST_MULTI |
230 | || $this->type == SMOPT_TYPE_EDIT_LIST); |
231 | } |
232 | |
b4856b14 |
233 | /** |
234 | * Set the value for this option. |
235 | * @param mixed $value |
236 | */ |
cbe5423b |
237 | function setValue($value) { |
238 | $this->value = $value; |
239 | } |
240 | |
b4856b14 |
241 | /** |
242 | * Set the new value for this option. |
243 | * @param mixed $new_value |
244 | */ |
cbe5423b |
245 | function setNewValue($new_value) { |
246 | $this->new_value = $new_value; |
9962527a |
247 | } |
44ef0f47 |
248 | |
e40b0e8e |
249 | /** |
250 | * Set whether the caption is allowed to wrap for this option. |
251 | * @param boolean $caption_wrap |
252 | */ |
253 | function setCaptionWrap($caption_wrap) { |
254 | $this->caption_wrap = $caption_wrap; |
255 | } |
256 | |
b4856b14 |
257 | /** |
258 | * Set the size for this option. |
259 | * @param integer $size |
260 | */ |
bbcafebd |
261 | function setSize($size) { |
262 | $this->size = $size; |
263 | } |
264 | |
b4856b14 |
265 | /** |
266 | * Set the trailing_text for this option. |
267 | * @param string $trailing_text |
268 | */ |
361d6e1b |
269 | function setTrailingText($trailing_text) { |
270 | $this->trailing_text = $trailing_text; |
271 | } |
272 | |
5b277d00 |
273 | /** |
274 | * Set the yes_text for this option. |
275 | * @param string $yes_text |
276 | */ |
277 | function setYesText($yes_text) { |
278 | $this->yes_text = $yes_text; |
279 | } |
280 | |
281 | /** |
282 | * Set the no_text for this option. |
283 | * @param string $no_text |
284 | */ |
285 | function setNoText($no_text) { |
286 | $this->no_text = $no_text; |
287 | } |
288 | |
b6a08d2d |
289 | /* Set the "use add widget" value for this option. */ |
290 | function setUseAddWidget($use_add_widget) { |
291 | $this->use_add_widget = $use_add_widget; |
292 | } |
293 | |
de4c101c |
294 | /* Set the "use delete widget" value for this option. */ |
295 | function setUseDeleteWidget($use_delete_widget) { |
296 | $this->use_delete_widget = $use_delete_widget; |
297 | } |
298 | |
52639d23 |
299 | /** |
300 | * Set the layout type for this option. |
301 | * @param int $layout_type |
302 | */ |
303 | function setLayoutType($layout_type) { |
304 | $this->layout_type = $layout_type; |
305 | } |
306 | |
b4856b14 |
307 | /** |
308 | * Set the comment for this option. |
309 | * @param string $comment |
310 | */ |
bbcafebd |
311 | function setComment($comment) { |
312 | $this->comment = $comment; |
313 | } |
314 | |
b4856b14 |
315 | /** |
0177059f |
316 | * Set the extra attributes for this option. |
317 | * @param array $aExtraAttribs |
b4856b14 |
318 | */ |
0177059f |
319 | function setExtraAttributes($aExtraAttribs) { |
320 | $this->aExtraAttribs = $aExtraAttribs; |
cbe5423b |
321 | } |
322 | |
b4856b14 |
323 | /** |
324 | * Set the "post script" for this option. |
325 | * @param string $post_script |
326 | */ |
6ae9e729 |
327 | function setPostScript($post_script) { |
328 | $this->post_script = $post_script; |
329 | } |
330 | |
b4856b14 |
331 | /** |
332 | * Set the save function for this option. |
333 | * @param string $save_function |
334 | */ |
cbe5423b |
335 | function setSaveFunction($save_function) { |
336 | $this->save_function = $save_function; |
337 | } |
338 | |
99ecf044 |
339 | /** |
5b277d00 |
340 | * Set the folder_filter for this option. |
99ecf044 |
341 | * @param string $folder_filter |
342 | * @since 1.5.1 |
343 | */ |
344 | function setFolderFilter($folder_filter) { |
345 | $this->folder_filter = $folder_filter; |
346 | } |
347 | |
b4856b14 |
348 | /** |
349 | * Creates fields on option pages according to option type |
350 | * |
9786ea94 |
351 | * This is the function that calls all other createWidget* functions. |
352 | * |
353 | * @return string The formated option field |
354 | * |
b4856b14 |
355 | */ |
9786ea94 |
356 | function createWidget() { |
ce68b76b |
357 | global $color; |
cbe5423b |
358 | |
62f7daa5 |
359 | // Use new value if available |
59fc0b63 |
360 | if (!is_null($this->new_value)) { |
74e44765 |
361 | $tempValue = $this->value; |
362 | $this->value = $this->new_value; |
363 | } |
364 | |
cbe5423b |
365 | /* Get the widget for this option type. */ |
a3ec3c91 |
366 | switch ($this->type) { |
367 | case SMOPT_TYPE_STRING: |
37a3ed17 |
368 | $result = $this->createWidget_String(); |
a3ec3c91 |
369 | break; |
370 | case SMOPT_TYPE_STRLIST: |
37a3ed17 |
371 | $result = $this->createWidget_StrList(); |
a3ec3c91 |
372 | break; |
7e6d5ea3 |
373 | case SMOPT_TYPE_TEXTAREA: |
37a3ed17 |
374 | $result = $this->createWidget_TextArea(); |
a3ec3c91 |
375 | break; |
376 | case SMOPT_TYPE_INTEGER: |
37a3ed17 |
377 | $result = $this->createWidget_Integer(); |
a3ec3c91 |
378 | break; |
379 | case SMOPT_TYPE_FLOAT: |
37a3ed17 |
380 | $result = $this->createWidget_Float(); |
a3ec3c91 |
381 | break; |
382 | case SMOPT_TYPE_BOOLEAN: |
37a3ed17 |
383 | $result = $this->createWidget_Boolean(); |
a3ec3c91 |
384 | break; |
1b7db98b |
385 | case SMOPT_TYPE_BOOLEAN_CHECKBOX: |
386 | $result = $this->createWidget_Boolean(TRUE); |
387 | break; |
8b2726c5 |
388 | case SMOPT_TYPE_BOOLEAN_RADIO: |
389 | $result = $this->createWidget_Boolean(FALSE); |
390 | break; |
2a50fbd7 |
391 | case SMOPT_TYPE_HIDDEN: |
37a3ed17 |
392 | $result = $this->createWidget_Hidden(); |
a3ec3c91 |
393 | break; |
bbcafebd |
394 | case SMOPT_TYPE_COMMENT: |
37a3ed17 |
395 | $result = $this->createWidget_Comment(); |
bbcafebd |
396 | break; |
be2d5495 |
397 | case SMOPT_TYPE_FLDRLIST: |
37a3ed17 |
398 | $result = $this->createWidget_FolderList(); |
be2d5495 |
399 | break; |
42b7c9d4 |
400 | case SMOPT_TYPE_FLDRLIST_MULTI: |
401 | $result = $this->createWidget_FolderList(TRUE); |
402 | break; |
38d93650 |
403 | case SMOPT_TYPE_EDIT_LIST: |
404 | $result = $this->createWidget_EditList(); |
405 | break; |
40268626 |
406 | case SMOPT_TYPE_STRLIST_MULTI: |
407 | $result = $this->createWidget_StrList(TRUE); |
408 | break; |
daf77710 |
409 | case SMOPT_TYPE_STRLIST_RADIO: |
410 | $result = $this->createWidget_StrList(FALSE, TRUE); |
411 | break; |
b6a08d2d |
412 | case SMOPT_TYPE_SUBMIT: |
413 | $result = $this->createWidget_Submit(); |
414 | break; |
6c06cf54 |
415 | case SMOPT_TYPE_INFO: |
416 | $result = $this->createWidget_Info(); |
417 | break; |
a3ec3c91 |
418 | default: |
fb8c4296 |
419 | error_box ( |
420 | sprintf(_("Option Type '%s' Not Found"), $this->type) |
421 | ); |
a3ec3c91 |
422 | } |
423 | |
6ae9e729 |
424 | /* Add the "post script" for this option. */ |
425 | $result .= $this->post_script; |
62f7daa5 |
426 | |
74e44765 |
427 | // put correct value back if need be |
59fc0b63 |
428 | if (!is_null($this->new_value)) { |
74e44765 |
429 | $this->value = $tempValue; |
430 | } |
431 | |
a3ec3c91 |
432 | /* Now, return the created widget. */ |
9786ea94 |
433 | return $result; |
a3ec3c91 |
434 | } |
435 | |
6c06cf54 |
436 | /** |
437 | * Creates info block |
438 | * @return string html formated output |
439 | */ |
440 | function createWidget_Info() { |
441 | return sq_htmlspecialchars($this->value); |
442 | } |
443 | |
b4856b14 |
444 | /** |
445 | * Create string field |
446 | * @return string html formated option field |
447 | */ |
37a3ed17 |
448 | function createWidget_String() { |
bbcafebd |
449 | switch ($this->size) { |
88cb1b4d |
450 | case SMOPT_SIZE_TINY: |
451 | $width = 5; |
452 | break; |
453 | case SMOPT_SIZE_SMALL: |
454 | $width = 12; |
455 | break; |
456 | case SMOPT_SIZE_LARGE: |
457 | $width = 38; |
458 | break; |
459 | case SMOPT_SIZE_HUGE: |
460 | $width = 50; |
461 | break; |
bbcafebd |
462 | case SMOPT_SIZE_NORMAL: |
88cb1b4d |
463 | default: |
464 | $width = 25; |
bbcafebd |
465 | } |
466 | |
f08c3bcc |
467 | //TODO: might be better to have a separate template file for all widgets, because then the layout of the widget and the "trailing text" can be customized - they are still hard coded here |
468 | return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . htmlspecialchars($this->trailing_text); |
a3ec3c91 |
469 | } |
470 | |
b4856b14 |
471 | /** |
daf77710 |
472 | * Create selection box or radio button group |
0177059f |
473 | * |
474 | * When $this->htmlencoded is TRUE, the keys and values in |
475 | * $this->possible_values are assumed to be display-safe. |
476 | * Use with care! |
477 | * |
daf77710 |
478 | * Note that when building radio buttons instead of a select |
479 | * widget, if the "size" attribute is SMOPT_SIZE_TINY, the |
480 | * radio buttons will be output one after another without |
481 | * linebreaks between them. Otherwise, each radio button |
482 | * goes on a line of its own. |
483 | * |
484 | * @param boolean $multiple_select When TRUE, the select widget |
40268626 |
485 | * will allow multiple selections |
daf77710 |
486 | * (OPTIONAL; default is FALSE |
40268626 |
487 | * (single select list)) |
daf77710 |
488 | * @param boolean $radio_buttons When TRUE, the widget will |
489 | * instead be built as a group |
490 | * of radio buttons (and |
491 | * $multiple_select will be |
492 | * forced to FALSE) (OPTIONAL; |
493 | * default is FALSE (select widget)) |
40268626 |
494 | * |
daf77710 |
495 | * @return string html formated selection box or radio buttons |
40268626 |
496 | * |
b4856b14 |
497 | */ |
daf77710 |
498 | function createWidget_StrList($multiple_select=FALSE, $radio_buttons=FALSE) { |
98e88751 |
499 | //FIXME: Currently, $this->htmlencoded is ignored here -- was removed when changing to template-based output; a fix is available as part of proposed centralized sanitizing patch |
40268626 |
500 | |
daf77710 |
501 | // radio buttons instead of select widget? |
502 | // |
503 | if ($radio_buttons) { |
504 | |
505 | global $br, $nbsp; |
506 | $result = ''; |
507 | foreach ($this->possible_values as $real_value => $disp_value) { |
508 | $result .= addRadioBox('new_' . $this->name, ($this->value == $real_value), $real_value, array_merge(array('id' => 'new_' . $this->name . '_' . $real_value), $this->aExtraAttribs)) . $nbsp . create_label($disp_value, 'new_' . $this->name . '_' . $real_value); |
509 | if ($this->size != SMOPT_SIZE_TINY) |
510 | $result .= $br; |
511 | } |
512 | |
513 | return $result; |
514 | } |
515 | |
516 | |
517 | // everything below applies to select widgets |
518 | // |
40268626 |
519 | switch ($this->size) { |
520 | //FIXME: not sure about these sizes... seems like we could add another on the "large" side... |
521 | case SMOPT_SIZE_TINY: |
522 | $height = 3; |
523 | break; |
524 | case SMOPT_SIZE_SMALL: |
525 | $height = 8; |
526 | break; |
527 | case SMOPT_SIZE_LARGE: |
528 | $height = 15; |
529 | break; |
530 | case SMOPT_SIZE_HUGE: |
531 | $height = 25; |
532 | break; |
533 | case SMOPT_SIZE_NORMAL: |
534 | default: |
535 | $height = 5; |
536 | } |
537 | |
538 | return addSelect('new_' . $this->name, $this->possible_values, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height, !$this->htmlencoded) . htmlspecialchars($this->trailing_text); |
a3ec3c91 |
539 | |
a3ec3c91 |
540 | } |
541 | |
b4856b14 |
542 | /** |
543 | * Create folder selection box |
42b7c9d4 |
544 | * |
545 | * @param boolean $multiple_select When TRUE, the select widget |
546 | * will allow multiple selections |
547 | * (OPTIONAL; default is FALSE |
548 | * (single select list)) |
549 | * |
b4856b14 |
550 | * @return string html formated selection box |
42b7c9d4 |
551 | * |
b4856b14 |
552 | */ |
42b7c9d4 |
553 | function createWidget_FolderList($multiple_select=FALSE) { |
be2d5495 |
554 | |
38d93650 |
555 | switch ($this->size) { |
556 | //FIXME: not sure about these sizes... seems like we could add another on the "large" side... |
557 | case SMOPT_SIZE_TINY: |
558 | $height = 3; |
559 | break; |
560 | case SMOPT_SIZE_SMALL: |
561 | $height = 8; |
562 | break; |
563 | case SMOPT_SIZE_LARGE: |
564 | $height = 15; |
565 | break; |
566 | case SMOPT_SIZE_HUGE: |
567 | $height = 25; |
568 | break; |
569 | case SMOPT_SIZE_NORMAL: |
570 | default: |
571 | $height = 5; |
572 | } |
573 | |
0177059f |
574 | // possible values might include a nested array of |
575 | // possible values (list of folders) |
576 | // |
577 | $option_list = array(); |
578 | foreach ($this->possible_values as $value => $text) { |
62f7daa5 |
579 | |
0177059f |
580 | // list of folders (boxes array) |
581 | // |
582 | if (is_array($text)) { |
42b7c9d4 |
583 | $option_list = array_merge($option_list, sqimap_mailbox_option_array(0, 0, $text, $this->folder_filter)); |
62f7daa5 |
584 | |
0177059f |
585 | // just one option here |
586 | // |
587 | } else { |
588 | $option_list = array_merge($option_list, array($value => $text)); |
be2d5495 |
589 | } |
0177059f |
590 | |
62f7daa5 |
591 | } |
0177059f |
592 | if (empty($option_list)) |
593 | $option_list = array('ignore' => _("unavailable")); |
99ecf044 |
594 | |
595 | |
38d93650 |
596 | return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height) . htmlspecialchars($this->trailing_text); |
0177059f |
597 | |
be2d5495 |
598 | } |
599 | |
b4856b14 |
600 | /** |
601 | * Creates textarea |
602 | * @return string html formated textarea field |
603 | */ |
37a3ed17 |
604 | function createWidget_TextArea() { |
bbcafebd |
605 | switch ($this->size) { |
606 | case SMOPT_SIZE_TINY: $rows = 3; $cols = 10; break; |
607 | case SMOPT_SIZE_SMALL: $rows = 4; $cols = 30; break; |
608 | case SMOPT_SIZE_LARGE: $rows = 10; $cols = 60; break; |
609 | case SMOPT_SIZE_HUGE: $rows = 20; $cols = 80; break; |
610 | case SMOPT_SIZE_NORMAL: |
611 | default: $rows = 5; $cols = 50; |
612 | } |
ba556ce5 |
613 | return addTextArea('new_' . $this->name, $this->value, $cols, $rows, $this->aExtraAttribs); |
a3ec3c91 |
614 | } |
615 | |
b4856b14 |
616 | /** |
617 | * Creates field for integer |
618 | * |
619 | * Difference from createWidget_String is visible only when javascript is enabled |
620 | * @return string html formated option field |
621 | */ |
37a3ed17 |
622 | function createWidget_Integer() { |
0d08ea5a |
623 | |
b65d1a08 |
624 | // add onChange javascript handler to a regular string widget |
625 | // which will strip out all non-numeric chars |
83aff890 |
626 | if (checkForJavascript()) |
0177059f |
627 | $this->aExtraAttribs['onchange'] = 'origVal=this.value; newVal=\'\'; ' |
b65d1a08 |
628 | . 'for (i=0;i<origVal.length;i++) { if (origVal.charAt(i)>=\'0\' ' |
629 | . '&& origVal.charAt(i)<=\'9\') newVal += origVal.charAt(i); } ' |
0177059f |
630 | . 'this.value=newVal;'; |
631 | |
632 | return $this->createWidget_String(); |
a3ec3c91 |
633 | } |
634 | |
b4856b14 |
635 | /** |
636 | * Creates field for floating number |
637 | * Difference from createWidget_String is visible only when javascript is enabled |
638 | * @return string html formated option field |
639 | */ |
37a3ed17 |
640 | function createWidget_Float() { |
37a3ed17 |
641 | |
b65d1a08 |
642 | // add onChange javascript handler to a regular string widget |
62f7daa5 |
643 | // which will strip out all non-numeric (period also OK) chars |
83aff890 |
644 | if (checkForJavascript()) |
0177059f |
645 | $this->aExtraAttribs['onchange'] = 'origVal=this.value; newVal=\'\'; ' |
b65d1a08 |
646 | . 'for (i=0;i<origVal.length;i++) { if ((origVal.charAt(i)>=\'0\' ' |
647 | . '&& origVal.charAt(i)<=\'9\') || origVal.charAt(i)==\'.\') ' |
0177059f |
648 | . 'newVal += origVal.charAt(i); } this.value=newVal;'; |
649 | |
650 | return $this->createWidget_String(); |
a3ec3c91 |
651 | } |
652 | |
b4856b14 |
653 | /** |
1b7db98b |
654 | * Create boolean widget |
655 | * |
5b277d00 |
656 | * When creating Yes/No radio buttons, the "yes_text" |
657 | * and "no_text" option attributes are used to override |
658 | * the typical "Yes" and "No" text. |
659 | * |
1b7db98b |
660 | * @param boolean $checkbox When TRUE, the widget will be |
661 | * constructed as a checkbox, |
662 | * otherwise it will be a set of |
663 | * Yes/No radio buttons (OPTIONAL; |
3b6a455c |
664 | * default is TRUE (checkbox)). |
1b7db98b |
665 | * |
666 | * @return string html formated boolean widget |
667 | * |
b4856b14 |
668 | */ |
3b6a455c |
669 | function createWidget_Boolean($checkbox=TRUE) { |
0177059f |
670 | |
5f88daeb |
671 | global $oTemplate, $nbsp; |
fd87494d |
672 | |
fd87494d |
673 | |
1b7db98b |
674 | // checkbox... |
675 | // |
676 | if ($checkbox) { |
677 | $result = addCheckbox('new_' . $this->name, ($this->value != SMPREF_NO), SMPREF_YES, array_merge(array('id' => 'new_' . $this->name), $this->aExtraAttribs)) . $nbsp . create_label($this->trailing_text, 'new_' . $this->name); |
678 | } |
679 | |
680 | // radio buttons... |
681 | // |
682 | else { |
683 | |
684 | /* Build the yes choice. */ |
5b277d00 |
685 | $yes_option = addRadioBox('new_' . $this->name, ($this->value != SMPREF_NO), SMPREF_YES, array_merge(array('id' => 'new_' . $this->name . '_yes'), $this->aExtraAttribs)) . $nbsp . create_label((!empty($this->yes_text) ? $this->yes_text : _("Yes")), 'new_' . $this->name . '_yes'); |
1b7db98b |
686 | |
687 | /* Build the no choice. */ |
5b277d00 |
688 | $no_option = addRadioBox('new_' . $this->name, ($this->value == SMPREF_NO), SMPREF_NO, array_merge(array('id' => 'new_' . $this->name . '_no'), $this->aExtraAttribs)) . $nbsp . create_label((!empty($this->no_text) ? $this->no_text : _("No")), 'new_' . $this->name . '_no'); |
1b7db98b |
689 | |
690 | /* Build the combined "boolean widget". */ |
691 | $result = "$yes_option$nbsp$nbsp$nbsp$nbsp$no_option"; |
692 | |
693 | } |
fd87494d |
694 | |
fd87494d |
695 | return ($result); |
a3ec3c91 |
696 | } |
697 | |
b4856b14 |
698 | /** |
699 | * Creates hidden field |
700 | * @return string html formated hidden input field |
701 | */ |
37a3ed17 |
702 | function createWidget_Hidden() { |
0177059f |
703 | return addHidden('new_' . $this->name, $this->value, $this->aExtraAttribs); |
a3ec3c91 |
704 | } |
705 | |
b4856b14 |
706 | /** |
707 | * Creates comment |
708 | * @return string comment |
709 | */ |
37a3ed17 |
710 | function createWidget_Comment() { |
bbcafebd |
711 | $result = $this->comment; |
712 | return ($result); |
713 | } |
714 | |
38d93650 |
715 | /** |
716 | * Creates an edit list |
52639d23 |
717 | * |
718 | * Note that multiple layout types are supported for this widget. |
719 | * $this->layout_type must be one of the SMOPT_EDIT_LIST_LAYOUT_* |
720 | * constants. |
721 | * |
38d93650 |
722 | * @return string html formated list of edit fields and |
723 | * their associated controls |
724 | */ |
725 | function createWidget_EditList() { |
726 | |
cb606dfd |
727 | global $oTemplate; |
38d93650 |
728 | |
729 | switch ($this->size) { |
38d93650 |
730 | case SMOPT_SIZE_TINY: |
731 | $height = 3; |
732 | break; |
733 | case SMOPT_SIZE_SMALL: |
734 | $height = 8; |
735 | break; |
b1dcab7e |
736 | case SMOPT_SIZE_MEDIUM: |
38d93650 |
737 | $height = 15; |
738 | break; |
b1dcab7e |
739 | case SMOPT_SIZE_LARGE: |
38d93650 |
740 | $height = 25; |
741 | break; |
b1dcab7e |
742 | case SMOPT_SIZE_HUGE: |
743 | $height = 40; |
744 | break; |
38d93650 |
745 | case SMOPT_SIZE_NORMAL: |
746 | default: |
747 | $height = 5; |
748 | } |
749 | |
dd6f9627 |
750 | if (empty($this->possible_values)) $this->possible_values = array(); |
2ebfc729 |
751 | if (!is_array($this->possible_values)) $this->possible_values = array($this->possible_values); |
dd6f9627 |
752 | |
cb606dfd |
753 | //FIXME: $this->aExtraAttribs probably should only be used in one place |
754 | $oTemplate->assign('input_widget', addInput('add_' . $this->name, '', 38, 0, $this->aExtraAttribs)); |
b6a08d2d |
755 | $oTemplate->assign('use_input_widget', $this->use_add_widget); |
de4c101c |
756 | $oTemplate->assign('use_delete_widget', $this->use_delete_widget); |
b6a08d2d |
757 | |
cb606dfd |
758 | $oTemplate->assign('trailing_text', $this->trailing_text); |
52639d23 |
759 | $oTemplate->assign('possible_values', $this->possible_values); |
f2fdd884 |
760 | $oTemplate->assign('select_widget', addSelect('new_' . $this->name, $this->possible_values, $this->value, FALSE, !checkForJavascript() ? $this->aExtraAttribs : array_merge(array('onchange' => 'if (typeof(window.addinput_' . $this->name . ') == \'undefined\') { var f = document.forms.length; var i = 0; var pos = -1; while( pos == -1 && i < f ) { var e = document.forms[i].elements.length; var j = 0; while( pos == -1 && j < e ) { if ( document.forms[i].elements[j].type == \'text\' && document.forms[i].elements[j].name == \'add_' . $this->name . '\' ) { pos = j; } j++; } i++; } if( pos >= 0 ) { window.addinput_' . $this->name . ' = document.forms[i-1].elements[pos]; } } for (x = 0; x < this.length; x++) { if (this.options[x].selected) { window.addinput_' . $this->name . '.value = this.options[x].value; break; } }'), $this->aExtraAttribs), TRUE, $height)); |
cb606dfd |
761 | $oTemplate->assign('checkbox_widget', addCheckBox('delete_' . $this->name, FALSE, SMPREF_YES, array_merge(array('id' => 'delete_' . $this->name), $this->aExtraAttribs))); |
762 | $oTemplate->assign('name', $this->name); |
52639d23 |
763 | |
764 | switch ($this->layout_type) { |
765 | case SMOPT_EDIT_LIST_LAYOUT_SELECT: |
766 | return $oTemplate->fetch('edit_list_widget.tpl'); |
767 | case SMOPT_EDIT_LIST_LAYOUT_LIST: |
768 | return $oTemplate->fetch('edit_list_widget_list_style.tpl'); |
769 | default: |
770 | error_box(sprintf(_("Edit List Layout Type '%s' Not Found"), $layout_type)); |
771 | } |
38d93650 |
772 | |
773 | } |
774 | |
b6a08d2d |
775 | /** |
776 | * Creates a submit button |
777 | * |
778 | * @return string html formated submit button widget |
779 | * |
780 | */ |
781 | function createWidget_Submit() { |
782 | |
783 | return addSubmit($this->comment, $this->name, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text); |
784 | |
785 | } |
786 | |
b4856b14 |
787 | /** |
788 | * |
789 | */ |
cbe5423b |
790 | function save() { |
791 | $function = $this->save_function; |
792 | $function($this); |
44ef0f47 |
793 | } |
cbe5423b |
794 | |
b4856b14 |
795 | /** |
796 | * |
797 | */ |
cbe5423b |
798 | function changed() { |
38d93650 |
799 | |
800 | // edit lists have a lot going on, so we'll always process them |
801 | // |
802 | if ($this->type == SMOPT_TYPE_EDIT_LIST) return TRUE; |
803 | |
6206f6c4 |
804 | return ($this->value != $this->new_value); |
cbe5423b |
805 | } |
b4856b14 |
806 | } /* End of SquirrelOption class*/ |
cbe5423b |
807 | |
b4856b14 |
808 | /** |
f2aba536 |
809 | * Saves the option value (this is the default save function |
810 | * unless overridden by the user) |
811 | * |
b4856b14 |
812 | * @param object $option object that holds option name and new_value |
813 | */ |
cbe5423b |
814 | function save_option($option) { |
f2aba536 |
815 | |
816 | // Can't save the pref if we don't have the username |
817 | // |
dac16606 |
818 | if ( !sqgetGlobalVar('username', $username, SQ_SESSION ) ) { |
dac16606 |
819 | return; |
0b97a708 |
820 | } |
f2aba536 |
821 | |
0b97a708 |
822 | global $data_dir; |
f2aba536 |
823 | |
38d93650 |
824 | // edit lists: first add new elements to list, then |
825 | // remove any selected ones (note that we must add |
826 | // before deleting because the javascript that populates |
827 | // the "add" textbox when selecting items in the list |
828 | // (for deletion)) |
829 | // |
830 | if ($option->type == SMOPT_TYPE_EDIT_LIST) { |
831 | |
8eb63bb6 |
832 | if (empty($option->possible_values)) $option->possible_values = array(); |
95dbbd91 |
833 | if (!is_array($option->possible_values)) $option->possible_values = array($option->possible_values); |
8eb63bb6 |
834 | |
38d93650 |
835 | // add element if given |
836 | // |
b6a08d2d |
837 | if ((isset($option->use_add_widget) && $option->use_add_widget) |
838 | && sqGetGlobalVar('add_' . $option->name, $new_element, SQ_POST)) { |
38d93650 |
839 | $new_element = trim($new_element); |
840 | if (!empty($new_element) |
841 | && !in_array($new_element, $option->possible_values)) |
842 | $option->possible_values[] = $new_element; |
843 | } |
844 | |
845 | // delete selected elements if needed |
846 | // |
de4c101c |
847 | if ((isset($option->use_delete_widget) && $option->use_delete_widget) |
848 | && is_array($option->new_value) |
38d93650 |
849 | && sqGetGlobalVar('delete_' . $option->name, $ignore, SQ_POST)) |
850 | $option->possible_values = array_diff($option->possible_values, $option->new_value); |
851 | |
852 | // save full list (stored in "possible_values") |
853 | // |
854 | setPref($data_dir, $username, $option->name, serialize($option->possible_values)); |
855 | |
f2aba536 |
856 | // Certain option types need to be serialized because |
857 | // they are not scalar |
858 | // |
5a42c101 |
859 | } else if ($option->is_multiple_valued()) |
f2aba536 |
860 | setPref($data_dir, $username, $option->name, serialize($option->new_value)); |
38d93650 |
861 | |
74b80a51 |
862 | // Checkboxes, when unchecked, don't submit anything in |
863 | // the POST, so set to SMPREF_OFF if not found |
864 | // |
865 | else if (($option->type == SMOPT_TYPE_BOOLEAN |
866 | || $option->type == SMOPT_TYPE_BOOLEAN_CHECKBOX) |
867 | && empty($option->new_value)) |
868 | setPref($data_dir, $username, $option->name, SMPREF_OFF); |
869 | |
f2aba536 |
870 | else |
871 | setPref($data_dir, $username, $option->name, $option->new_value); |
872 | |
b4f1a9ee |
873 | |
874 | // if a checkbox or multi select is zeroed/cleared out, it |
875 | // needs to have an empty value pushed into its "new_value" slot |
876 | // |
877 | if (($option->type == SMOPT_TYPE_STRLIST_MULTI |
878 | || $option->type == SMOPT_TYPE_BOOLEAN_CHECKBOX) |
879 | && is_null($option->new_value)) |
880 | $option->new_value = ''; |
881 | |
cbe5423b |
882 | } |
883 | |
b4856b14 |
884 | /** |
885 | * save function that does not save |
886 | * @param object $option |
887 | */ |
cbe5423b |
888 | function save_option_noop($option) { |
889 | /* Do nothing here... */ |
9962527a |
890 | } |
44ef0f47 |
891 | |
b4856b14 |
892 | /** |
893 | * Create hidden 'optpage' input field with value set by argument |
894 | * @param string $optpage identification of option page |
895 | * @return string html formated hidden input field |
896 | */ |
cbe5423b |
897 | function create_optpage_element($optpage) { |
0177059f |
898 | return addHidden('optpage', $optpage); |
cbe5423b |
899 | } |
900 | |
b4856b14 |
901 | /** |
902 | * Create hidden 'optmode' input field with value set by argument |
903 | * @param string $optmode |
904 | * @return string html formated hidden input field |
905 | */ |
cbe5423b |
906 | function create_optmode_element($optmode) { |
0177059f |
907 | return addHidden('optmode', $optmode); |
cbe5423b |
908 | } |
909 | |
b4856b14 |
910 | /** |
911 | * @param array $optgrps |
912 | * @param array $optvals |
913 | * @return array |
914 | */ |
cbe5423b |
915 | function create_option_groups($optgrps, $optvals) { |
a3ec3c91 |
916 | /* Build a simple array with which to start. */ |
917 | $result = array(); |
918 | |
bbcafebd |
919 | /* Create option group for each option group name. */ |
920 | foreach ($optgrps as $grpkey => $grpname) { |
921 | $result[$grpkey] = array(); |
922 | $result[$grpkey]['name'] = $grpname; |
923 | $result[$grpkey]['options'] = array(); |
924 | } |
925 | |
a3ec3c91 |
926 | /* Create a new SquirrelOption for each set of option values. */ |
bbcafebd |
927 | foreach ($optvals as $grpkey => $grpopts) { |
928 | foreach ($grpopts as $optset) { |
28520c87 |
929 | /* Create a new option with all values given. */ |
930 | $next_option = new SquirrelOption( |
d789daf0 |
931 | $optset, |
7390e240 |
932 | $optset['name'], |
933 | $optset['caption'], |
934 | $optset['type'], |
935 | (isset($optset['refresh']) ? $optset['refresh'] : SMOPT_REFRESH_NONE), |
936 | (isset($optset['initial_value']) ? $optset['initial_value'] : ''), |
937 | (isset($optset['posvals']) ? $optset['posvals'] : ''), |
938 | (isset($optset['htmlencoded']) ? $optset['htmlencoded'] : false) |
939 | ); |
bbcafebd |
940 | |
e40b0e8e |
941 | /* If provided, set if the caption is allowed to wrap for this option. */ |
942 | if (isset($optset['caption_wrap'])) { |
943 | $next_option->setCaptionWrap($optset['caption_wrap']); |
944 | } |
945 | |
bbcafebd |
946 | /* If provided, set the size for this option. */ |
947 | if (isset($optset['size'])) { |
948 | $next_option->setSize($optset['size']); |
949 | } |
950 | |
361d6e1b |
951 | /* If provided, set the trailing_text for this option. */ |
952 | if (isset($optset['trailing_text'])) { |
953 | $next_option->setTrailingText($optset['trailing_text']); |
954 | } |
955 | |
5b277d00 |
956 | /* If provided, set the yes_text for this option. */ |
957 | if (isset($optset['yes_text'])) { |
958 | $next_option->setYesText($optset['yes_text']); |
959 | } |
960 | |
961 | /* If provided, set the no_text for this option. */ |
962 | if (isset($optset['no_text'])) { |
963 | $next_option->setNoText($optset['no_text']); |
964 | } |
965 | |
52639d23 |
966 | /* If provided, set the layout type for this option. */ |
967 | if (isset($optset['layout_type'])) { |
968 | $next_option->setLayoutType($optset['layout_type']); |
969 | } |
970 | |
b6a08d2d |
971 | /* If provided, set the use_add_widget value for this option. */ |
972 | if (isset($optset['use_add_widget'])) { |
973 | $next_option->setUseAddWidget($optset['use_add_widget']); |
974 | } |
975 | |
de4c101c |
976 | /* If provided, set the use_delete_widget value for this option. */ |
977 | if (isset($optset['use_delete_widget'])) { |
978 | $next_option->setUseDeleteWidget($optset['use_delete_widget']); |
979 | } |
980 | |
bbcafebd |
981 | /* If provided, set the comment for this option. */ |
982 | if (isset($optset['comment'])) { |
983 | $next_option->setComment($optset['comment']); |
984 | } |
985 | |
cbe5423b |
986 | /* If provided, set the save function for this option. */ |
987 | if (isset($optset['save'])) { |
988 | $next_option->setSaveFunction($optset['save']); |
989 | } |
990 | |
0177059f |
991 | /* If provided, set the extra attributes for this option. */ |
992 | if (isset($optset['extra_attributes'])) { |
993 | $next_option->setExtraAttributes($optset['extra_attributes']); |
cbe5423b |
994 | } |
995 | |
6ae9e729 |
996 | /* If provided, set the "post script" for this option. */ |
997 | if (isset($optset['post_script'])) { |
998 | $next_option->setPostScript($optset['post_script']); |
999 | } |
1000 | |
99ecf044 |
1001 | /* If provided, set the folder_filter for this option. */ |
1002 | if (isset($optset['folder_filter'])) { |
1003 | $next_option->setFolderFilter($optset['folder_filter']); |
1004 | } |
1005 | |
bbcafebd |
1006 | /* Add this option to the option array. */ |
1007 | $result[$grpkey]['options'][] = $next_option; |
a3ec3c91 |
1008 | } |
1009 | } |
1010 | |
1011 | /* Return our resulting array. */ |
1012 | return ($result); |
1013 | } |
1014 | |