functions/options.php

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