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
 217          && $type != SMOPT_TYPE_INFO
 218          && $type != SMOPT_TYPE_COMMENT) {
 219             $this->save_function = SMOPT_SAVE_DEFAULT;
 220         } else {
 221             $this->save_function = SMOPT_SAVE_NOOP;
 222         }
 223     }
 224
 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
 233     /**
 234      * Set the value for this option.
 235      * @param mixed $value
 236      */
 237     function setValue($value) {
 238         $this->value = $value;
 239     }
 240
 241     /**
 242      * Set the new value for this option.
 243      * @param mixed $new_value
 244      */
 245     function setNewValue($new_value) {
 246         $this->new_value = $new_value;
 247     }
 248
 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
 257     /**
 258      * Set the size for this option.
 259      * @param integer $size
 260      */
 261     function setSize($size) {
 262         $this->size = $size;
 263     }
 264
 265     /**
 266      * Set the trailing_text for this option.
 267      * @param string $trailing_text
 268      */
 269     function setTrailingText($trailing_text) {
 270         $this->trailing_text = $trailing_text;
 271     }
 272
 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
 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
 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
 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
 307     /**
 308      * Set the comment for this option.
 309      * @param string $comment
 310      */
 311     function setComment($comment) {
 312         $this->comment = $comment;
 313     }
 314
 315     /**
 316      * Set the extra attributes for this option.
 317      * @param array $aExtraAttribs
 318      */
 319     function setExtraAttributes($aExtraAttribs) {
 320         $this->aExtraAttribs = $aExtraAttribs;
 321     }
 322
 323     /**
 324      * Set the "post script" for this option.
 325      * @param string $post_script
 326      */
 327     function setPostScript($post_script) {
 328         $this->post_script = $post_script;
 329     }
 330
 331     /**
 332      * Set the save function for this option.
 333      * @param string $save_function
 334      */
 335     function setSaveFunction($save_function) {
 336         $this->save_function = $save_function;
 337     }
 338
 339     /**
 340      * Set the folder_filter for this option.
 341      * @param string $folder_filter
 342      * @since 1.5.1
 343      */
 344     function setFolderFilter($folder_filter) {
 345         $this->folder_filter = $folder_filter;
 346     }
 347
 348     /**
 349      * Creates fields on option pages according to option type
 350      *
 351      * This is the function that calls all other createWidget* functions.
 352      *
 353      * @return string The formated option field
 354      *
 355      */
 356     function createWidget() {
 357         global $color;
 358
 359         // Use new value if available
 360         if (!is_null($this->new_value)) {
 361             $tempValue = $this->value;
 362             $this->value = $this->new_value;
 363         }
 364
 365         /* Get the widget for this option type. */
 366         switch ($this->type) {
 367             case SMOPT_TYPE_STRING:
 368                 $result = $this->createWidget_String();
 369                 break;
 370             case SMOPT_TYPE_STRLIST:
 371                 $result = $this->createWidget_StrList();
 372                 break;
 373             case SMOPT_TYPE_TEXTAREA:
 374                 $result = $this->createWidget_TextArea();
 375                 break;
 376             case SMOPT_TYPE_INTEGER:
 377                 $result = $this->createWidget_Integer();
 378                 break;
 379             case SMOPT_TYPE_FLOAT:
 380                 $result = $this->createWidget_Float();
 381                 break;
 382             case SMOPT_TYPE_BOOLEAN:
 383                 $result = $this->createWidget_Boolean();
 384                 break;
 385             case SMOPT_TYPE_BOOLEAN_CHECKBOX:
 386                 $result = $this->createWidget_Boolean(TRUE);
 387                 break;
 388             case SMOPT_TYPE_BOOLEAN_RADIO:
 389                 $result = $this->createWidget_Boolean(FALSE);
 390                 break;
 391             case SMOPT_TYPE_HIDDEN:
 392                 $result = $this->createWidget_Hidden();
 393                 break;
 394             case SMOPT_TYPE_COMMENT:
 395                 $result = $this->createWidget_Comment();
 396                 break;
 397             case SMOPT_TYPE_FLDRLIST:
 398                 $result = $this->createWidget_FolderList();
 399                 break;
 400             case SMOPT_TYPE_FLDRLIST_MULTI:
 401                 $result = $this->createWidget_FolderList(TRUE);
 402                 break;
 403             case SMOPT_TYPE_EDIT_LIST:
 404                 $result = $this->createWidget_EditList();
 405                 break;
 406             case SMOPT_TYPE_STRLIST_MULTI:
 407                 $result = $this->createWidget_StrList(TRUE);
 408                 break;
 409             case SMOPT_TYPE_STRLIST_RADIO:
 410                 $result = $this->createWidget_StrList(FALSE, TRUE);
 411                 break;
 412             case SMOPT_TYPE_SUBMIT:
 413                 $result = $this->createWidget_Submit();
 414                 break;
 415             case SMOPT_TYPE_INFO:
 416                 $result = $this->createWidget_Info();
 417                 break;
 418             default:
 419                 error_box (
 420                     sprintf(_("Option Type '%s' Not Found"), $this->type)
 421                     );
 422         }
 423
 424         /* Add the "post script" for this option. */
 425         $result .= $this->post_script;
 426
 427         // put correct value back if need be
 428         if (!is_null($this->new_value)) {
 429             $this->value = $tempValue;
 430         }
 431
 432         /* Now, return the created widget. */
 433         return $result;
 434     }
 435
 436     /**
 437      * Creates info block
 438      * @return string html formated output
 439      */
 440     function createWidget_Info() {
 441         return sq_htmlspecialchars($this->value);
 442     }
 443
 444     /**
 445      * Create string field
 446      * @return string html formated option field
 447      */
 448     function createWidget_String() {
 449         switch ($this->size) {
 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;
 462             case SMOPT_SIZE_NORMAL:
 463             default:
 464                 $width = 25;
 465         }
 466
 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);
 469     }
 470
 471     /**
 472      * Create selection box or radio button group
 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      *
 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
 485      *                                 will allow multiple selections
 486      *                                 (OPTIONAL; default is FALSE
 487      *                                 (single select list))
 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))
 494      *
 495      * @return string html formated selection box or radio buttons
 496      *
 497      */
 498     function createWidget_StrList($multiple_select=FALSE, $radio_buttons=FALSE) {
 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
 500
 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         //
 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);
 539
 540     }
 541
 542     /**
 543      * Create folder selection box
 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      *
 550      * @return string html formated selection box
 551      *
 552      */
 553     function createWidget_FolderList($multiple_select=FALSE) {
 554
 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
 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) {
 579
 580             // list of folders (boxes array)
 581             //
 582             if (is_array($text)) {
 583               $option_list = array_merge($option_list, sqimap_mailbox_option_array(0, 0, $text, $this->folder_filter));
 584
 585             // just one option here
 586             //
 587             } else {
 588               $option_list = array_merge($option_list, array($value => $text));
 589             }
 590
 591         }
 592         if (empty($option_list))
 593             $option_list = array('ignore' => _("unavailable"));
 594
 595
 596         return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height) . htmlspecialchars($this->trailing_text);
 597
 598     }
 599
 600     /**
 601      * Creates textarea
 602      * @return string html formated textarea field
 603      */
 604     function createWidget_TextArea() {
 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         }
 613         return addTextArea('new_' . $this->name, $this->value, $cols, $rows, $this->aExtraAttribs);
 614     }
 615
 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      */
 622     function createWidget_Integer() {
 623
 624         // add onChange javascript handler to a regular string widget
 625         // which will strip out all non-numeric chars
 626         if (checkForJavascript())
 627            $this->aExtraAttribs['onchange'] = 'origVal=this.value; newVal=\'\'; '
 628                     . 'for (i=0;i<origVal.length;i++) { if (origVal.charAt(i)>=\'0\' '
 629                     . '&& origVal.charAt(i)<=\'9\') newVal += origVal.charAt(i); } '
 630                     . 'this.value=newVal;';
 631
 632         return $this->createWidget_String();
 633     }
 634
 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      */
 640     function createWidget_Float() {
 641
 642         // add onChange javascript handler to a regular string widget
 643         // which will strip out all non-numeric (period also OK) chars
 644         if (checkForJavascript())
 645            $this->aExtraAttribs['onchange'] = 'origVal=this.value; newVal=\'\'; '
 646                     . 'for (i=0;i<origVal.length;i++) { if ((origVal.charAt(i)>=\'0\' '
 647                     . '&& origVal.charAt(i)<=\'9\') || origVal.charAt(i)==\'.\') '
 648                     . 'newVal += origVal.charAt(i); } this.value=newVal;';
 649
 650         return $this->createWidget_String();
 651     }
 652
 653     /**
 654      * Create boolean widget
 655      *
 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      *
 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;
 664      *                          default is TRUE (checkbox)).
 665      *
 666      * @return string html formated boolean widget
 667      *
 668      */
 669     function createWidget_Boolean($checkbox=TRUE) {
 670
 671         global $oTemplate, $nbsp;
 672
 673
 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. */
 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');
 686
 687             /* Build the no choice. */
 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');
 689
 690             /* Build the combined "boolean widget". */
 691             $result = "$yes_option$nbsp$nbsp$nbsp$nbsp$no_option";
 692
 693         }
 694
 695         return ($result);
 696     }
 697
 698     /**
 699      * Creates hidden field
 700      * @return string html formated hidden input field
 701      */
 702     function createWidget_Hidden() {
 703         return addHidden('new_' . $this->name, $this->value, $this->aExtraAttribs);
 704     }
 705
 706     /**
 707      * Creates comment
 708      * @return string comment
 709      */
 710     function createWidget_Comment() {
 711         $result = $this->comment;
 712         return ($result);
 713     }
 714
 715     /**
 716      * Creates an edit list
 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      *
 722      * @return string html formated list of edit fields and
 723      *                their associated controls
 724      */
 725     function createWidget_EditList() {
 726
 727         global $oTemplate;
 728
 729         switch ($this->size) {
 730             case SMOPT_SIZE_TINY:
 731                 $height = 3;
 732                 break;
 733             case SMOPT_SIZE_SMALL:
 734                 $height = 8;
 735                 break;
 736             case SMOPT_SIZE_MEDIUM:
 737                 $height = 15;
 738                 break;
 739             case SMOPT_SIZE_LARGE:
 740                 $height = 25;
 741                 break;
 742             case SMOPT_SIZE_HUGE:
 743                 $height = 40;
 744                 break;
 745             case SMOPT_SIZE_NORMAL:
 746             default:
 747                 $height = 5;
 748         }
 749
 750         if (empty($this->possible_values)) $this->possible_values = array();
 751         if (!is_array($this->possible_values)) $this->possible_values = array($this->possible_values);
 752
 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));
 755         $oTemplate->assign('use_input_widget', $this->use_add_widget);
 756         $oTemplate->assign('use_delete_widget', $this->use_delete_widget);
 757
 758         $oTemplate->assign('trailing_text', $this->trailing_text);
 759         $oTemplate->assign('possible_values', $this->possible_values);
 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));
 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);
 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         }
 772
 773     }
 774
 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
 787     /**
 788      *
 789      */
 790     function save() {
 791         $function = $this->save_function;
 792         $function($this);
 793     }
 794
 795     /**
 796      *
 797      */
 798     function changed() {
 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
 804         return ($this->value != $this->new_value);
 805     }
 806 } /* End of SquirrelOption class*/
 807
 808 /**
 809  * Saves the option value (this is the default save function
 810  * unless overridden by the user)
 811  *
 812  * @param object $option object that holds option name and new_value
 813  */
 814 function save_option($option) {
 815
 816     // Can't save the pref if we don't have the username
 817     //
 818     if ( !sqgetGlobalVar('username', $username, SQ_SESSION ) ) {
 819         return;
 820     }
 821
 822     global $data_dir;
 823
 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
 832         if (empty($option->possible_values)) $option->possible_values = array();
 833         if (!is_array($option->possible_values)) $option->possible_values = array($option->possible_values);
 834
 835         // add element if given
 836         //
 837         if ((isset($option->use_add_widget) && $option->use_add_widget)
 838          && sqGetGlobalVar('add_' . $option->name, $new_element, SQ_POST)) {
 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         //
 847         if ((isset($option->use_delete_widget) && $option->use_delete_widget)
 848          && is_array($option->new_value)
 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
 856     // Certain option types need to be serialized because
 857     // they are not scalar
 858     //
 859     } else if ($option->is_multiple_valued())
 860         setPref($data_dir, $username, $option->name, serialize($option->new_value));
 861
 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
 870     else
 871         setPref($data_dir, $username, $option->name, $option->new_value);
 872
 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
 882 }
 883
 884 /**
 885  * save function that does not save
 886  * @param object $option
 887  */
 888 function save_option_noop($option) {
 889     /* Do nothing here... */
 890 }
 891
 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  */
 897 function create_optpage_element($optpage) {
 898     return addHidden('optpage', $optpage);
 899 }
 900
 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  */
 906 function create_optmode_element($optmode) {
 907     return addHidden('optmode', $optmode);
 908 }
 909
 910 /**
 911  * @param array $optgrps
 912  * @param array $optvals
 913  * @return array
 914  */
 915 function create_option_groups($optgrps, $optvals) {
 916     /* Build a simple array with which to start. */
 917     $result = array();
 918
 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
 926      /* Create a new SquirrelOption for each set of option values. */
 927     foreach ($optvals as $grpkey => $grpopts) {
 928         foreach ($grpopts as $optset) {
 929             /* Create a new option with all values given. */
 930             $next_option = new SquirrelOption(
 931                     $optset,
 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                     );
 940
 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
 946             /* If provided, set the size for this option. */
 947             if (isset($optset['size'])) {
 948                 $next_option->setSize($optset['size']);
 949             }
 950
 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
 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
 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
 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
 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
 981             /* If provided, set the comment for this option. */
 982             if (isset($optset['comment'])) {
 983                 $next_option->setComment($optset['comment']);
 984             }
 985
 986             /* If provided, set the save function for this option. */
 987             if (isset($optset['save'])) {
 988                 $next_option->setSaveFunction($optset['save']);
 989             }
 990
 991             /* If provided, set the extra attributes for this option. */
 992             if (isset($optset['extra_attributes'])) {
 993                 $next_option->setExtraAttributes($optset['extra_attributes']);
 994             }
 995
 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
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
1006             /* Add this option to the option array. */
1007             $result[$grpkey]['options'][] = $next_option;
1008         }
1009     }
1010
1011     /* Return our resulting array. */
1012     return ($result);
1013 }
1014