Add multiple select folder list option widget (SMOPT_TYPE_FLDRLIST_MULTI)
[squirrelmail.git] / functions / options.php
CommitLineData
44ef0f47 1<?php
2ba13803 2
35586184 3/**
4 * options.php
5 *
35586184 6 * Functions needed to display the options pages.
7 *
4b5049de 8 * @copyright &copy; 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
15/**********************************************/
16/* Define constants used in the options code. */
17/**********************************************/
18
19/* Define constants for the various option types. */
20define('SMOPT_TYPE_STRING', 0);
21define('SMOPT_TYPE_STRLIST', 1);
7e6d5ea3 22define('SMOPT_TYPE_TEXTAREA', 2);
a3ec3c91 23define('SMOPT_TYPE_INTEGER', 3);
24define('SMOPT_TYPE_FLOAT', 4);
25define('SMOPT_TYPE_BOOLEAN', 5);
2a50fbd7 26define('SMOPT_TYPE_HIDDEN', 6);
bbcafebd 27define('SMOPT_TYPE_COMMENT', 7);
be2d5495 28define('SMOPT_TYPE_FLDRLIST', 8);
42b7c9d4 29define('SMOPT_TYPE_FLDRLIST_MULTI', 9);
a3ec3c91 30
31/* Define constants for the options refresh levels. */
32define('SMOPT_REFRESH_NONE', 0);
33define('SMOPT_REFRESH_FOLDERLIST', 1);
34define('SMOPT_REFRESH_ALL', 2);
35
bbcafebd 36/* Define constants for the options size. */
37define('SMOPT_SIZE_TINY', 0);
38define('SMOPT_SIZE_SMALL', 1);
39define('SMOPT_SIZE_MEDIUM', 2);
40define('SMOPT_SIZE_LARGE', 3);
41define('SMOPT_SIZE_HUGE', 4);
88cb1b4d 42define('SMOPT_SIZE_NORMAL', 5);
bbcafebd 43
cbe5423b 44define('SMOPT_SAVE_DEFAULT', 'save_option');
45define('SMOPT_SAVE_NOOP', 'save_option_noop');
46
9962527a 47/**
598294a7 48 * SquirrelOption: An option for SquirrelMail.
9962527a 49 *
8f6f9ba5 50 * @package squirrelmail
b4856b14 51 * @subpackage prefs
9962527a 52 */
53class SquirrelOption {
b4856b14 54 /**
55 * The name of this setting
56 * @var string
57 */
9962527a 58 var $name;
b4856b14 59 /**
60 * The text that prefaces setting on the preferences page
61 * @var string
62 */
9962527a 63 var $caption;
b4856b14 64 /**
65 * The type of INPUT element
66 *
67 * See SMOPT_TYPE_* defines
68 * @var integer
69 */
9962527a 70 var $type;
b4856b14 71 /**
598294a7 72 * Indicates if a link should be shown to refresh part
b4856b14 73 * or all of the window
74 *
75 * See SMOPT_REFRESH_* defines
76 * @var integer
77 */
a3ec3c91 78 var $refresh_level;
b4856b14 79 /**
80 * Specifies the size of certain input items
81 *
82 * See SMOPT_SIZE_* defines
83 * @var integer
84 */
bbcafebd 85 var $size;
b4856b14 86 /**
598294a7 87 * Text that follows a text input or
b4856b14 88 * select list input on the preferences page
598294a7 89 *
b4856b14 90 * useful for indicating units, meanings of special values, etc.
91 * @var string
92 */
361d6e1b 93 var $trailing_text;
b4856b14 94 /**
95 * text displayed to the user
96 *
97 * Used with SMOPT_TYPE_COMMENT options
98 * @var string
99 */
bbcafebd 100 var $comment;
b4856b14 101 /**
0177059f 102 * additional javascript or other widget attributes added to the
103 * user input; must be an array where keys are attribute names
104 * ("onclick", etc) and values are the attribute values.
105 * @var array
b4856b14 106 */
0177059f 107 var $aExtraAttribs;
b4856b14 108 /**
598294a7 109 * script (usually Javascript) that will be placed after (outside of)
b4856b14 110 * the INPUT tag
111 * @var string
112 */
6ae9e729 113 var $post_script;
cbe5423b 114
b4856b14 115 /**
116 * The name of the Save Function for this option.
117 * @var string
118 */
cbe5423b 119 var $save_function;
9962527a 120
121 /* The various 'values' for this options. */
b4856b14 122 /**
123 * default/preselected value for this option
124 * @var mixed
125 */
9962527a 126 var $value;
b4856b14 127 /**
128 * new option value
129 * @var mixed
130 */
9962527a 131 var $new_value;
b4856b14 132 /**
598294a7 133 * associative array, where each key is an actual input value
b4856b14 134 * and the corresponding value is what is displayed to the user
135 * for that list item in the drop-down list
136 * @var array
137 */
a3ec3c91 138 var $possible_values;
b4856b14 139 /**
140 * disables html sanitizing.
598294a7 141 *
142 * WARNING - don't use it, if user input is possible in option
0177059f 143 * or use own sanitizing functions. Currently only works for SMOPT_TYPE_STRLIST.
b4856b14 144 * @var bool
145 */
28520c87 146 var $htmlencoded=false;
99ecf044 147 /**
42b7c9d4 148 * Controls folder list limits in SMOPT_TYPE_FLDRLIST and
149 * SMOPT_TYPE_FLDRLIST_MULTI widgets.
99ecf044 150 * See $flag argument in sqimap_mailbox_option_list() function.
151 * @var string
152 * @since 1.5.1
153 */
154 var $folder_filter='noselect';
9962527a 155
b4856b14 156 /**
157 * Constructor function
158 * @param string $name
159 * @param string $caption
160 * @param integer $type
161 * @param integer $refresh_level
162 * @param mixed $initial_value
163 * @param array $possible_values
164 * @param bool $htmlencoded
165 */
9962527a 166 function SquirrelOption
28520c87 167 ($name, $caption, $type, $refresh_level, $initial_value = '', $possible_values = '', $htmlencoded = false) {
9962527a 168 /* Set the basic stuff. */
169 $this->name = $name;
170 $this->caption = $caption;
9962527a 171 $this->type = $type;
a3ec3c91 172 $this->refresh_level = $refresh_level;
173 $this->possible_values = $possible_values;
28520c87 174 $this->htmlencoded = $htmlencoded;
bbcafebd 175 $this->size = SMOPT_SIZE_MEDIUM;
361d6e1b 176 $this->trailing_text = '';
bbcafebd 177 $this->comment = '';
0177059f 178 $this->aExtraAttribs = array();
6ae9e729 179 $this->post_script = '';
a3ec3c91 180
991c88e7 181 //Check for a current value.
182 if (isset($GLOBALS[$name])) {
a3ec3c91 183 $this->value = $GLOBALS[$name];
17f3d242 184 } else if (!empty($initial_value)) {
185 $this->value = $initial_value;
a3ec3c91 186 } else {
187 $this->value = '';
188 }
9962527a 189
a3ec3c91 190 /* Check for a new value. */
b4856b14 191 if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) {
a3ec3c91 192 $this->new_value = '';
44ef0f47 193 }
cbe5423b 194
195 /* Set the default save function. */
2a50fbd7 196 if (($type != SMOPT_TYPE_HIDDEN) && ($type != SMOPT_TYPE_COMMENT)) {
cbe5423b 197 $this->save_function = SMOPT_SAVE_DEFAULT;
198 } else {
199 $this->save_function = SMOPT_SAVE_NOOP;
200 }
201 }
202
b4856b14 203 /**
204 * Set the value for this option.
205 * @param mixed $value
206 */
cbe5423b 207 function setValue($value) {
208 $this->value = $value;
209 }
210
b4856b14 211 /**
212 * Set the new value for this option.
213 * @param mixed $new_value
214 */
cbe5423b 215 function setNewValue($new_value) {
216 $this->new_value = $new_value;
9962527a 217 }
44ef0f47 218
b4856b14 219 /**
220 * Set the size for this option.
221 * @param integer $size
222 */
bbcafebd 223 function setSize($size) {
224 $this->size = $size;
225 }
226
b4856b14 227 /**
228 * Set the trailing_text for this option.
229 * @param string $trailing_text
230 */
361d6e1b 231 function setTrailingText($trailing_text) {
232 $this->trailing_text = $trailing_text;
233 }
234
b4856b14 235 /**
236 * Set the comment for this option.
237 * @param string $comment
238 */
bbcafebd 239 function setComment($comment) {
240 $this->comment = $comment;
241 }
242
b4856b14 243 /**
0177059f 244 * Set the extra attributes for this option.
245 * @param array $aExtraAttribs
b4856b14 246 */
0177059f 247 function setExtraAttributes($aExtraAttribs) {
248 $this->aExtraAttribs = $aExtraAttribs;
cbe5423b 249 }
250
b4856b14 251 /**
252 * Set the "post script" for this option.
253 * @param string $post_script
254 */
6ae9e729 255 function setPostScript($post_script) {
256 $this->post_script = $post_script;
257 }
258
b4856b14 259 /**
260 * Set the save function for this option.
261 * @param string $save_function
262 */
cbe5423b 263 function setSaveFunction($save_function) {
264 $this->save_function = $save_function;
265 }
266
b4856b14 267 /**
99ecf044 268 * Set the trailing_text for this option.
269 * @param string $folder_filter
270 * @since 1.5.1
271 */
272 function setFolderFilter($folder_filter) {
273 $this->folder_filter = $folder_filter;
274 }
275
276 /**
b4856b14 277 * Creates fields on option pages according to option type
278 *
279 * Function that calls other createWidget* functions.
598294a7 280 * @return string html formated option field
b4856b14 281 */
a3ec3c91 282 function createHTMLWidget() {
ce68b76b 283 global $color;
cbe5423b 284
62f7daa5 285 // Use new value if available
74e44765 286 if (!empty($this->new_value)) {
287 $tempValue = $this->value;
288 $this->value = $this->new_value;
289 }
290
cbe5423b 291 /* Get the widget for this option type. */
a3ec3c91 292 switch ($this->type) {
293 case SMOPT_TYPE_STRING:
37a3ed17 294 $result = $this->createWidget_String();
a3ec3c91 295 break;
296 case SMOPT_TYPE_STRLIST:
37a3ed17 297 $result = $this->createWidget_StrList();
a3ec3c91 298 break;
7e6d5ea3 299 case SMOPT_TYPE_TEXTAREA:
37a3ed17 300 $result = $this->createWidget_TextArea();
a3ec3c91 301 break;
302 case SMOPT_TYPE_INTEGER:
37a3ed17 303 $result = $this->createWidget_Integer();
a3ec3c91 304 break;
305 case SMOPT_TYPE_FLOAT:
37a3ed17 306 $result = $this->createWidget_Float();
a3ec3c91 307 break;
308 case SMOPT_TYPE_BOOLEAN:
37a3ed17 309 $result = $this->createWidget_Boolean();
a3ec3c91 310 break;
2a50fbd7 311 case SMOPT_TYPE_HIDDEN:
37a3ed17 312 $result = $this->createWidget_Hidden();
a3ec3c91 313 break;
bbcafebd 314 case SMOPT_TYPE_COMMENT:
37a3ed17 315 $result = $this->createWidget_Comment();
bbcafebd 316 break;
be2d5495 317 case SMOPT_TYPE_FLDRLIST:
37a3ed17 318 $result = $this->createWidget_FolderList();
be2d5495 319 break;
42b7c9d4 320 case SMOPT_TYPE_FLDRLIST_MULTI:
321 $result = $this->createWidget_FolderList(TRUE);
322 break;
a3ec3c91 323 default:
fb8c4296 324 error_box (
325 sprintf(_("Option Type '%s' Not Found"), $this->type)
326 );
a3ec3c91 327 }
328
6ae9e729 329 /* Add the "post script" for this option. */
330 $result .= $this->post_script;
62f7daa5 331
74e44765 332 // put correct value back if need be
333 if (!empty($this->new_value)) {
334 $this->value = $tempValue;
335 }
336
a3ec3c91 337 /* Now, return the created widget. */
338 return ($result);
339 }
340
b4856b14 341 /**
342 * Create string field
343 * @return string html formated option field
344 */
37a3ed17 345 function createWidget_String() {
bbcafebd 346 switch ($this->size) {
88cb1b4d 347 case SMOPT_SIZE_TINY:
348 $width = 5;
349 break;
350 case SMOPT_SIZE_SMALL:
351 $width = 12;
352 break;
353 case SMOPT_SIZE_LARGE:
354 $width = 38;
355 break;
356 case SMOPT_SIZE_HUGE:
357 $width = 50;
358 break;
bbcafebd 359 case SMOPT_SIZE_NORMAL:
88cb1b4d 360 default:
361 $width = 25;
bbcafebd 362 }
363
0177059f 364 return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text);
a3ec3c91 365 }
366
b4856b14 367 /**
368 * Create selection box
0177059f 369 *
370 * When $this->htmlencoded is TRUE, the keys and values in
371 * $this->possible_values are assumed to be display-safe.
372 * Use with care!
373 *
b4856b14 374 * @return string html formated selection box
375 */
37a3ed17 376 function createWidget_StrList() {
98e88751 377//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
378 return addSelect('new_' . $this->name, $this->possible_values, $this->value, TRUE, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text);
a3ec3c91 379
a3ec3c91 380 }
381
b4856b14 382 /**
383 * Create folder selection box
42b7c9d4 384 *
385 * @param boolean $multiple_select When TRUE, the select widget
386 * will allow multiple selections
387 * (OPTIONAL; default is FALSE
388 * (single select list))
389 *
b4856b14 390 * @return string html formated selection box
42b7c9d4 391 *
b4856b14 392 */
42b7c9d4 393 function createWidget_FolderList($multiple_select=FALSE) {
be2d5495 394
0177059f 395 // possible values might include a nested array of
396 // possible values (list of folders)
397 //
398 $option_list = array();
399 foreach ($this->possible_values as $value => $text) {
62f7daa5 400
0177059f 401 // list of folders (boxes array)
402 //
403 if (is_array($text)) {
42b7c9d4 404 $option_list = array_merge($option_list, sqimap_mailbox_option_array(0, 0, $text, $this->folder_filter));
62f7daa5 405
0177059f 406 // just one option here
407 //
408 } else {
409 $option_list = array_merge($option_list, array($value => $text));
be2d5495 410 }
0177059f 411
62f7daa5 412 }
0177059f 413 if (empty($option_list))
414 $option_list = array('ignore' => _("unavailable"));
99ecf044 415
416
42b7c9d4 417 // OK to use sq_htmlspecialchars() below because addSelect() already does
418 return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select) . sq_htmlspecialchars($this->trailing_text);
0177059f 419
be2d5495 420 }
421
b4856b14 422 /**
423 * Creates textarea
424 * @return string html formated textarea field
425 */
37a3ed17 426 function createWidget_TextArea() {
bbcafebd 427 switch ($this->size) {
428 case SMOPT_SIZE_TINY: $rows = 3; $cols = 10; break;
429 case SMOPT_SIZE_SMALL: $rows = 4; $cols = 30; break;
430 case SMOPT_SIZE_LARGE: $rows = 10; $cols = 60; break;
431 case SMOPT_SIZE_HUGE: $rows = 20; $cols = 80; break;
432 case SMOPT_SIZE_NORMAL:
433 default: $rows = 5; $cols = 50;
434 }
ba556ce5 435 return addTextArea('new_' . $this->name, $this->value, $cols, $rows, $this->aExtraAttribs);
a3ec3c91 436 }
437
b4856b14 438 /**
439 * Creates field for integer
440 *
441 * Difference from createWidget_String is visible only when javascript is enabled
442 * @return string html formated option field
443 */
37a3ed17 444 function createWidget_Integer() {
0d08ea5a 445
b65d1a08 446 // add onChange javascript handler to a regular string widget
447 // which will strip out all non-numeric chars
83aff890 448 if (checkForJavascript())
0177059f 449 $this->aExtraAttribs['onchange'] = 'origVal=this.value; newVal=\'\'; '
b65d1a08 450 . 'for (i=0;i<origVal.length;i++) { if (origVal.charAt(i)>=\'0\' '
451 . '&& origVal.charAt(i)<=\'9\') newVal += origVal.charAt(i); } '
0177059f 452 . 'this.value=newVal;';
453
454 return $this->createWidget_String();
a3ec3c91 455 }
456
b4856b14 457 /**
458 * Creates field for floating number
459 * Difference from createWidget_String is visible only when javascript is enabled
460 * @return string html formated option field
461 */
37a3ed17 462 function createWidget_Float() {
37a3ed17 463
b65d1a08 464 // add onChange javascript handler to a regular string widget
62f7daa5 465 // which will strip out all non-numeric (period also OK) chars
83aff890 466 if (checkForJavascript())
0177059f 467 $this->aExtraAttribs['onchange'] = 'origVal=this.value; newVal=\'\'; '
b65d1a08 468 . 'for (i=0;i<origVal.length;i++) { if ((origVal.charAt(i)>=\'0\' '
469 . '&& origVal.charAt(i)<=\'9\') || origVal.charAt(i)==\'.\') '
0177059f 470 . 'newVal += origVal.charAt(i); } this.value=newVal;';
471
472 return $this->createWidget_String();
a3ec3c91 473 }
474
b4856b14 475 /**
476 * Creates radio field (yes/no)
477 * @return string html formated radio field
478 */
37a3ed17 479 function createWidget_Boolean() {
0177059f 480
481 global $oTemplate;
482 $nbsp = $oTemplate->fetch('non_breaking_space.tpl');
fd87494d 483
484 /* Build the yes choice. */
0177059f 485 $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(_("Yes"), 'new_' . $this->name . '_yes');
fd87494d 486
487 /* Build the no choice. */
0177059f 488 $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(_("No"), 'new_' . $this->name . '_no');
fd87494d 489
490 /* Build and return the combined "boolean widget". */
0177059f 491 $result = "$yes_option$nbsp$nbsp$nbsp$nbsp$no_option";
fd87494d 492 return ($result);
a3ec3c91 493 }
494
b4856b14 495 /**
496 * Creates hidden field
497 * @return string html formated hidden input field
498 */
37a3ed17 499 function createWidget_Hidden() {
0177059f 500 return addHidden('new_' . $this->name, $this->value, $this->aExtraAttribs);
a3ec3c91 501 }
502
b4856b14 503 /**
504 * Creates comment
505 * @return string comment
506 */
37a3ed17 507 function createWidget_Comment() {
bbcafebd 508 $result = $this->comment;
509 return ($result);
510 }
511
b4856b14 512 /**
513 *
514 */
cbe5423b 515 function save() {
516 $function = $this->save_function;
517 $function($this);
44ef0f47 518 }
cbe5423b 519
b4856b14 520 /**
521 *
522 */
cbe5423b 523 function changed() {
6206f6c4 524 return ($this->value != $this->new_value);
cbe5423b 525 }
b4856b14 526} /* End of SquirrelOption class*/
cbe5423b 527
b4856b14 528/**
529 * Saves option
530 * @param object $option object that holds option name and new_value
531 */
cbe5423b 532function save_option($option) {
dac16606 533 if ( !sqgetGlobalVar('username', $username, SQ_SESSION ) ) {
534 /* Can't save the pref if we don't have the username */
535 return;
0b97a708 536 }
537 global $data_dir;
0b97a708 538 setPref($data_dir, $username, $option->name, $option->new_value);
cbe5423b 539}
540
b4856b14 541/**
542 * save function that does not save
543 * @param object $option
544 */
cbe5423b 545function save_option_noop($option) {
546 /* Do nothing here... */
9962527a 547}
44ef0f47 548
b4856b14 549/**
550 * Create hidden 'optpage' input field with value set by argument
551 * @param string $optpage identification of option page
552 * @return string html formated hidden input field
553 */
cbe5423b 554function create_optpage_element($optpage) {
0177059f 555 return addHidden('optpage', $optpage);
cbe5423b 556}
557
b4856b14 558/**
559 * Create hidden 'optmode' input field with value set by argument
560 * @param string $optmode
561 * @return string html formated hidden input field
562 */
cbe5423b 563function create_optmode_element($optmode) {
0177059f 564 return addHidden('optmode', $optmode);
cbe5423b 565}
566
b4856b14 567/**
568 * @param array $optgrps
569 * @param array $optvals
570 * @return array
571 */
cbe5423b 572function create_option_groups($optgrps, $optvals) {
a3ec3c91 573 /* Build a simple array with which to start. */
574 $result = array();
575
bbcafebd 576 /* Create option group for each option group name. */
577 foreach ($optgrps as $grpkey => $grpname) {
578 $result[$grpkey] = array();
579 $result[$grpkey]['name'] = $grpname;
580 $result[$grpkey]['options'] = array();
581 }
582
a3ec3c91 583 /* Create a new SquirrelOption for each set of option values. */
bbcafebd 584 foreach ($optvals as $grpkey => $grpopts) {
585 foreach ($grpopts as $optset) {
28520c87 586 /* Create a new option with all values given. */
587 $next_option = new SquirrelOption(
7390e240 588 $optset['name'],
589 $optset['caption'],
590 $optset['type'],
591 (isset($optset['refresh']) ? $optset['refresh'] : SMOPT_REFRESH_NONE),
592 (isset($optset['initial_value']) ? $optset['initial_value'] : ''),
593 (isset($optset['posvals']) ? $optset['posvals'] : ''),
594 (isset($optset['htmlencoded']) ? $optset['htmlencoded'] : false)
595 );
bbcafebd 596
597 /* If provided, set the size for this option. */
598 if (isset($optset['size'])) {
599 $next_option->setSize($optset['size']);
600 }
601
361d6e1b 602 /* If provided, set the trailing_text for this option. */
603 if (isset($optset['trailing_text'])) {
604 $next_option->setTrailingText($optset['trailing_text']);
605 }
606
bbcafebd 607 /* If provided, set the comment for this option. */
608 if (isset($optset['comment'])) {
609 $next_option->setComment($optset['comment']);
610 }
611
cbe5423b 612 /* If provided, set the save function for this option. */
613 if (isset($optset['save'])) {
614 $next_option->setSaveFunction($optset['save']);
615 }
616
0177059f 617 /* If provided, set the extra attributes for this option. */
618 if (isset($optset['extra_attributes'])) {
619 $next_option->setExtraAttributes($optset['extra_attributes']);
cbe5423b 620 }
621
6ae9e729 622 /* If provided, set the "post script" for this option. */
623 if (isset($optset['post_script'])) {
624 $next_option->setPostScript($optset['post_script']);
625 }
626
99ecf044 627 /* If provided, set the folder_filter for this option. */
628 if (isset($optset['folder_filter'])) {
629 $next_option->setFolderFilter($optset['folder_filter']);
630 }
631
bbcafebd 632 /* Add this option to the option array. */
633 $result[$grpkey]['options'][] = $next_option;
a3ec3c91 634 }
635 }
636
637 /* Return our resulting array. */
638 return ($result);
639}
640