Fix issue not allowing save of boolean prefs that default to SMPREF_ON
[squirrelmail.git] / functions / options.php
index 443d4c74fa66503cfbd4f370ab93ed8764f9c922..fb0d8aa68f1f12a31672676af15b59b1f749de2d 100644 (file)
@@ -3,13 +3,13 @@
 /**
  * options.php
  *
- * Copyright (c) 1999-2005 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * Functions needed to display the options pages.
  *
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
+ * @subpackage prefs
  */
 
 /**********************************************/
@@ -26,6 +26,12 @@ define('SMOPT_TYPE_BOOLEAN', 5);
 define('SMOPT_TYPE_HIDDEN', 6);
 define('SMOPT_TYPE_COMMENT', 7);
 define('SMOPT_TYPE_FLDRLIST', 8);
+define('SMOPT_TYPE_FLDRLIST_MULTI', 9);
+define('SMOPT_TYPE_EDIT_LIST', 10);
+define('SMOPT_TYPE_STRLIST_MULTI', 11);
+define('SMOPT_TYPE_BOOLEAN_CHECKBOX', 12);
+define('SMOPT_TYPE_BOOLEAN_RADIO', 13);
+define('SMOPT_TYPE_STRLIST_RADIO', 14);
 
 /* Define constants for the options refresh levels. */
 define('SMOPT_REFRESH_NONE', 0);
@@ -44,7 +50,7 @@ define('SMOPT_SAVE_DEFAULT', 'save_option');
 define('SMOPT_SAVE_NOOP', 'save_option_noop');
 
 /**
- * SquirrelOption: An option for Squirrelmail.
+ * SquirrelOption: An option for SquirrelMail.
  *
  * @package squirrelmail
  * @subpackage prefs
@@ -68,7 +74,7 @@ class SquirrelOption {
      */
     var $type;
     /**
-     * Indicates if a link should be shown to refresh part 
+     * Indicates if a link should be shown to refresh part
      * or all of the window
      *
      * See SMOPT_REFRESH_* defines
@@ -83,13 +89,27 @@ class SquirrelOption {
      */
     var $size;
     /**
-     * Text that follows a text input or 
+     * Text that follows a text input or
      * select list input on the preferences page
-     * 
+     *
      * useful for indicating units, meanings of special values, etc.
      * @var string
      */
     var $trailing_text;
+    /**
+     * Text that overrides the "Yes" label for boolean 
+     * radio option widgets
+     *
+     * @var string
+     */
+    var $yes_text;
+    /**
+     * Text that overrides the "No" label for boolean 
+     * radio option widgets
+     *
+     * @var string
+     */
+    var $no_text;
     /**
      * text displayed to the user
      *
@@ -98,12 +118,14 @@ class SquirrelOption {
      */
     var $comment;
     /**
-     * additional javascript or other code added to the user input
-     * @var string
+     * additional javascript or other widget attributes added to the 
+     * user input; must be an array where keys are attribute names
+     * ("onclick", etc) and values are the attribute values.
+     * @var array
      */
-    var $script;
+    var $aExtraAttribs;
     /**
-     * script (usually Javascript) that will be placed after (outside of) 
+     * script (usually Javascript) that will be placed after (outside of)
      * the INPUT tag
      * @var string
      */
@@ -127,7 +149,7 @@ class SquirrelOption {
      */
     var $new_value;
     /**
-     * associative array, where each key is an actual input value 
+     * associative array, where each key is an actual input value
      * and the corresponding value is what is displayed to the user
      * for that list item in the drop-down list
      * @var array
@@ -135,13 +157,20 @@ class SquirrelOption {
     var $possible_values;
     /**
      * disables html sanitizing.
-     * 
-     * WARNING - don't use it, if user input is possible in option 
-     * or use own sanitizing functions. Currently works only with 
-     * SMOPT_TYPE_STRLIST.
+     *
+     * WARNING - don't use it, if user input is possible in option
+     * or use own sanitizing functions. Currently only works for SMOPT_TYPE_STRLIST.
      * @var bool
      */
     var $htmlencoded=false;
+    /**
+     * Controls folder list limits in SMOPT_TYPE_FLDRLIST and
+     * SMOPT_TYPE_FLDRLIST_MULTI widgets.
+     * See $flag argument in sqimap_mailbox_option_list() function.
+     * @var string
+     * @since 1.5.1
+     */
+    var $folder_filter='noselect';
 
     /**
      * Constructor function
@@ -164,15 +193,17 @@ class SquirrelOption {
         $this->htmlencoded = $htmlencoded;
         $this->size = SMOPT_SIZE_MEDIUM;
         $this->trailing_text = '';
+        $this->yes_text = '';
+        $this->no_text = '';
         $this->comment = '';
-        $this->script = '';
+        $this->aExtraAttribs = array();
         $this->post_script = '';
 
-        /* Check for a current value. */
-        if (!empty($initial_value)) {
-            $this->value = $initial_value;
-        } else if (isset($GLOBALS[$name])) {
+        //Check for a current value.  
+        if (isset($GLOBALS[$name])) {
             $this->value = $GLOBALS[$name];
+        } else if (!empty($initial_value)) {
+            $this->value = $initial_value;
         } else {
             $this->value = '';
         }
@@ -190,6 +221,14 @@ class SquirrelOption {
         }
     }
 
+    /** Convenience function that identifies which types of
+        widgets are stored as (serialized) array values. */
+    function is_multiple_valued() {
+        return ($this->type == SMOPT_TYPE_FLDRLIST_MULTI
+             || $this->type == SMOPT_TYPE_STRLIST_MULTI
+             || $this->type == SMOPT_TYPE_EDIT_LIST);
+    }
+
     /**
      * Set the value for this option.
      * @param mixed $value
@@ -222,6 +261,22 @@ class SquirrelOption {
         $this->trailing_text = $trailing_text;
     }
 
+    /**
+     * Set the yes_text for this option.
+     * @param string $yes_text
+     */
+    function setYesText($yes_text) {
+        $this->yes_text = $yes_text;
+    }
+
+    /**
+     * Set the no_text for this option.
+     * @param string $no_text
+     */
+    function setNoText($no_text) {
+        $this->no_text = $no_text;
+    }
+
     /**
      * Set the comment for this option.
      * @param string $comment
@@ -231,11 +286,11 @@ class SquirrelOption {
     }
 
     /**
-     * Set the script for this option.
-     * @param string $script 
+     * Set the extra attributes for this option.
+     * @param array $aExtraAttribs
      */
-    function setScript($script) {
-        $this->script = $script;
+    function setExtraAttributes($aExtraAttribs) {
+        $this->aExtraAttribs = $aExtraAttribs;
     }
 
     /**
@@ -254,13 +309,24 @@ class SquirrelOption {
         $this->save_function = $save_function;
     }
 
+    /**
+     * Set the folder_filter for this option.
+     * @param string $folder_filter
+     * @since 1.5.1
+     */
+    function setFolderFilter($folder_filter) {
+        $this->folder_filter = $folder_filter;
+    }
+
     /**
      * Creates fields on option pages according to option type
      *
-     * Function that calls other createWidget* functions.
-     * @return string html formated option field 
+     * This is the function that calls all other createWidget* functions.
+     *
+     * @return string The formated option field
+     *
      */
-    function createHTMLWidget() {
+    function createWidget() {
         global $color;
 
         // Use new value if available
@@ -289,6 +355,12 @@ class SquirrelOption {
             case SMOPT_TYPE_BOOLEAN:
                 $result = $this->createWidget_Boolean();
                 break;
+            case SMOPT_TYPE_BOOLEAN_CHECKBOX:
+                $result = $this->createWidget_Boolean(TRUE);
+                break;
+            case SMOPT_TYPE_BOOLEAN_RADIO:
+                $result = $this->createWidget_Boolean(FALSE);
+                break;
             case SMOPT_TYPE_HIDDEN:
                 $result = $this->createWidget_Hidden();
                 break;
@@ -298,10 +370,22 @@ class SquirrelOption {
             case SMOPT_TYPE_FLDRLIST:
                 $result = $this->createWidget_FolderList();
                 break;
+            case SMOPT_TYPE_FLDRLIST_MULTI:
+                $result = $this->createWidget_FolderList(TRUE);
+                break;
+            case SMOPT_TYPE_EDIT_LIST:
+                $result = $this->createWidget_EditList();
+                break;
+            case SMOPT_TYPE_STRLIST_MULTI:
+                $result = $this->createWidget_StrList(TRUE);
+                break;
+            case SMOPT_TYPE_STRLIST_RADIO:
+                $result = $this->createWidget_StrList(FALSE, TRUE);
+                break;
             default:
-               $result = '<font color="' . $color[2] . '">'
-                       . sprintf(_("Option Type '%s' Not Found"), $this->type)
-                       . '</font>';
+                error_box ( 
+                    sprintf(_("Option Type '%s' Not Found"), $this->type)
+                    );
         }
 
         /* Add the "post script" for this option. */
@@ -313,7 +397,7 @@ class SquirrelOption {
         }
 
         /* Now, return the created widget. */
-        return ($result);
+        return $result;
     }
 
     /**
@@ -339,76 +423,136 @@ class SquirrelOption {
                 $width = 25;
         }
 
-        $result = "<input type=\"text\" name=\"new_$this->name\" value=\"" .
-            htmlspecialchars($this->value) .
-            "\" size=\"$width\" $this->script />$this->trailing_text\n";
-        return ($result);
+        return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text); 
     }
 
     /**
-     * Create selection box
-     * @return string html formated selection box
+     * Create selection box or radio button group
+     *
+     * When $this->htmlencoded is TRUE, the keys and values in 
+     * $this->possible_values are assumed to be display-safe.  
+     * Use with care!
+     *
+     * Note that when building radio buttons instead of a select
+     * widget, if the "size" attribute is SMOPT_SIZE_TINY, the
+     * radio buttons will be output one after another without
+     * linebreaks between them.  Otherwise, each radio button
+     * goes on a line of its own.
+     *
+     * @param boolean $multiple_select When TRUE, the select widget
+     *                                 will allow multiple selections
+     *                                 (OPTIONAL; default is FALSE
+     *                                 (single select list))
+     * @param boolean $radio_buttons   When TRUE, the widget will
+     *                                 instead be built as a group
+     *                                 of radio buttons (and
+     *                                 $multiple_select will be
+     *                                 forced to FALSE) (OPTIONAL;
+     *                                 default is FALSE (select widget))
+     *
+     * @return string html formated selection box or radio buttons
+     *
      */
-    function createWidget_StrList() {
-        /* Begin the select tag. */
-        $result = "<select name=\"new_$this->name\" $this->script>\n";
+    function createWidget_StrList($multiple_select=FALSE, $radio_buttons=FALSE) {
+//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
 
-        /* Add each possible value to the select list. */
-        foreach ($this->possible_values as $real_value => $disp_value) {
-            /* Start the next new option string. */
-            $new_option = '<option value="' .
-                ($this->htmlencoded ? $real_value : htmlspecialchars($real_value)) . '"';
+        // radio buttons instead of select widget?
+        //
+        if ($radio_buttons) {
 
-            /* If this value is the current value, select it. */
-            if ($real_value == $this->value) {
-               $new_option .= ' selected="selected"';
+            global $br, $nbsp;
+            $result = '';
+            foreach ($this->possible_values as $real_value => $disp_value) {
+                $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);
+                if ($this->size != SMOPT_SIZE_TINY)
+                    $result .= $br;
             }
 
-            /* Add the display value to our option string. */
-            $new_option .= '>' . ($this->htmlencoded ? $disp_value : htmlspecialchars($disp_value)) . "</option>\n";
+            return $result;
+        }
+
 
-            /* And add the new option string to our select tag. */
-            $result .= $new_option;
+        // everything below applies to select widgets
+        //
+        switch ($this->size) {
+//FIXME: not sure about these sizes... seems like we could add another on the "large" side...
+            case SMOPT_SIZE_TINY:
+                $height = 3;
+                break;
+            case SMOPT_SIZE_SMALL:
+                $height = 8;
+                break;
+            case SMOPT_SIZE_LARGE:
+                $height = 15;
+                break;
+            case SMOPT_SIZE_HUGE:
+                $height = 25;
+                break;
+            case SMOPT_SIZE_NORMAL:
+            default:
+                $height = 5;
         }
 
-        /* Close the select tag and return our happy result. */
-        $result .= "</select>$this->trailing_text\n";
-        return ($result);
+        return addSelect('new_' . $this->name, $this->possible_values, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height, !$this->htmlencoded) . htmlspecialchars($this->trailing_text);
+
     }
 
     /**
      * Create folder selection box
+     *
+     * @param boolean $multiple_select When TRUE, the select widget 
+     *                                 will allow multiple selections
+     *                                 (OPTIONAL; default is FALSE 
+     *                                 (single select list))
+     *
      * @return string html formated selection box
+     *
      */
-    function createWidget_FolderList() {
-        $selected = array(strtolower($this->value));
+    function createWidget_FolderList($multiple_select=FALSE) {
 
-        /* Begin the select tag. */
-        $result = "<select name=\"new_$this->name\" $this->script>\n";
+        switch ($this->size) {
+//FIXME: not sure about these sizes... seems like we could add another on the "large" side...
+            case SMOPT_SIZE_TINY:
+                $height = 3;
+                break;
+            case SMOPT_SIZE_SMALL:
+                $height = 8;
+                break;
+            case SMOPT_SIZE_LARGE:
+                $height = 15;
+                break;
+            case SMOPT_SIZE_HUGE:
+                $height = 25;
+                break;
+            case SMOPT_SIZE_NORMAL:
+            default:
+                $height = 5;
+        }
 
-        /* Add each possible value to the select list. */
-        foreach ($this->possible_values as $real_value => $disp_value) {
-            if ( is_array($disp_value) ) {
-              /* For folder list, we passed in the array of boxes.. */
-              $new_option = sqimap_mailbox_option_list(0, $selected, 0, $disp_value);
-            } else {
-              /* Start the next new option string. */
-              $new_option = '<option value="' . htmlspecialchars($real_value) . '"';
+        // possible values might include a nested array of 
+        // possible values (list of folders)
+        //
+        $option_list = array();
+        foreach ($this->possible_values as $value => $text) {
 
-              /* If this value is the current value, select it. */
-              if ($real_value == $this->value) {
-                 $new_option .= ' selected="selected"';
-              }
+            // list of folders (boxes array)
+            //
+            if (is_array($text)) {
+              $option_list = array_merge($option_list, sqimap_mailbox_option_array(0, 0, $text, $this->folder_filter));
 
-              /* Add the display value to our option string. */
-              $new_option .= '>' . htmlspecialchars($disp_value) . "</option>\n";
+            // just one option here
+            //
+            } else {
+              $option_list = array_merge($option_list, array($value => $text));
             }
-            /* And add the new option string to our select tag. */
-            $result .= $new_option;
+
         }
-        /* Close the select tag and return our happy result. */
-        $result .= "</select>\n";
-        return ($result);
+        if (empty($option_list))
+            $option_list = array('ignore' => _("unavailable"));
+
+
+        return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height) . htmlspecialchars($this->trailing_text);
+
     }
 
     /**
@@ -424,10 +568,7 @@ class SquirrelOption {
             case SMOPT_SIZE_NORMAL:
             default: $rows = 5; $cols =  50;
         }
-        $result = "<textarea name=\"new_$this->name\" rows=\"$rows\" "
-                . "cols=\"$cols\" $this->script>"
-                . htmlspecialchars($this->value) . "</textarea>\n";
-        return ($result);
+        return addTextArea('new_' . $this->name, $this->value, $cols, $rows, $this->aExtraAttribs);
     }
 
     /**
@@ -437,17 +578,16 @@ class SquirrelOption {
      * @return string html formated option field
      */
     function createWidget_Integer() {
-        global $javascript_on;
 
         // add onChange javascript handler to a regular string widget
         // which will strip out all non-numeric chars
-        if ($javascript_on)
-           return preg_replace('/\/>/', ' onChange="origVal=this.value; newVal=\'\'; '
+        if (checkForJavascript())
+           $this->aExtraAttribs['onchange'] = 'origVal=this.value; newVal=\'\'; '
                     . 'for (i=0;i<origVal.length;i++) { if (origVal.charAt(i)>=\'0\' '
                     . '&& origVal.charAt(i)<=\'9\') newVal += origVal.charAt(i); } '
-                    . 'this.value=newVal;" />', $this->createWidget_String());
-        else
-           return $this->createWidget_String();
+                    . 'this.value=newVal;';
+
+        return $this->createWidget_String();
     }
 
     /**
@@ -456,48 +596,60 @@ class SquirrelOption {
      * @return string html formated option field
      */
     function createWidget_Float() {
-        global $javascript_on;
 
         // add onChange javascript handler to a regular string widget
         // which will strip out all non-numeric (period also OK) chars
-        if ($javascript_on)
-           return preg_replace('/\/>/', ' onChange="origVal=this.value; newVal=\'\'; '
+        if (checkForJavascript())
+           $this->aExtraAttribs['onchange'] = 'origVal=this.value; newVal=\'\'; '
                     . 'for (i=0;i<origVal.length;i++) { if ((origVal.charAt(i)>=\'0\' '
                     . '&& origVal.charAt(i)<=\'9\') || origVal.charAt(i)==\'.\') '
-                    . 'newVal += origVal.charAt(i); } this.value=newVal;" />'
-                , $this->createWidget_String());
-        else
-           return $this->createWidget_String();
+                    . 'newVal += origVal.charAt(i); } this.value=newVal;';
+
+        return $this->createWidget_String();
     }
 
     /**
-     * Creates radio field (yes/no)
-     * @return string html formated radio field
+     * Create boolean widget
+     *
+     * When creating Yes/No radio buttons, the "yes_text"
+     * and "no_text" option attributes are used to override
+     * the typical "Yes" and "No" text.
+     *
+     * @param boolean $checkbox When TRUE, the widget will be
+     *                          constructed as a checkbox,
+     *                          otherwise it will be a set of
+     *                          Yes/No radio buttons (OPTIONAL;
+     *                          default is TRUE (checkbox)).
+     *
+     * @return string html formated boolean widget
+     *
      */
-    function createWidget_Boolean() {
-        /* Do the whole current value thing. */
-        if ($this->value != SMPREF_NO) {
-            $yes_chk = ' checked="checked"';
-            $no_chk = '';
-        } else {
-            $yes_chk = '';
-            $no_chk = ' checked="checked"';
+    function createWidget_Boolean($checkbox=TRUE) {
+
+        global $oTemplate, $nbsp;
+
+
+        // checkbox...
+        //
+        if ($checkbox) {
+            $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);
         }
 
-        /* Build the yes choice. */
-        $yes_option = '<input type="radio" id="new_' . $this->name . '_yes" '
-                    . 'name="new_' . $this->name . '" value="' . SMPREF_YES . '"'
-                    . $yes_chk . ' ' . $this->script . ' />&nbsp;'
-                    . '<label for="new_'.$this->name.'_yes">' . _("Yes") . '</label>';
+        // radio buttons...
+        //
+        else {
+
+            /* Build the yes choice. */
+            $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');
+
+            /* Build the no choice. */
+            $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');
 
-        /* Build the no choice. */
-        $no_option = '<input type="radio" id="new_' . $this->name . '_no" '
-                   . 'name="new_' . $this->name . '" value="' . SMPREF_NO . '"'
-                   . $no_chk . ' ' . $this->script . ' />&nbsp;'
-                    . '<label for="new_'.$this->name.'_no">' . _("No") . '</label>';
+            /* Build the combined "boolean widget". */
+            $result = "$yes_option$nbsp$nbsp$nbsp$nbsp$no_option";
+
+        }
 
-        /* Build and return the combined "boolean widget". */
-        $result = "$yes_option&nbsp;&nbsp;&nbsp;&nbsp;$no_option";
         return ($result);
     }
 
@@ -506,10 +658,7 @@ class SquirrelOption {
      * @return string html formated hidden input field
      */
     function createWidget_Hidden() {
-        $result = '<input type="hidden" name="new_' . $this->name
-                . '" value="' . htmlspecialchars($this->value)
-                . '" ' . $this->script . ' />';
-        return ($result);
+        return addHidden('new_' . $this->name, $this->value, $this->aExtraAttribs);
     }
 
     /**
@@ -521,6 +670,47 @@ class SquirrelOption {
         return ($result);
     }
 
+    /**
+     * Creates an edit list
+     * @return string html formated list of edit fields and
+     *                their associated controls
+     */
+    function createWidget_EditList() {
+
+        global $oTemplate;
+
+        switch ($this->size) {
+//FIXME: not sure about these sizes... seems like we could add another on the "large" side...
+            case SMOPT_SIZE_TINY:
+                $height = 3;
+                break;
+            case SMOPT_SIZE_SMALL:
+                $height = 8;
+                break;
+            case SMOPT_SIZE_LARGE:
+                $height = 15;
+                break;
+            case SMOPT_SIZE_HUGE:
+                $height = 25;
+                break;
+            case SMOPT_SIZE_NORMAL:
+            default:
+                $height = 5;
+        }
+
+        if (empty($this->possible_values)) $this->possible_values = array();
+        if (!is_array($this->possible_values)) $this->possible_values = array($this->possible_values);
+
+//FIXME: $this->aExtraAttribs probably should only be used in one place
+        $oTemplate->assign('input_widget', addInput('add_' . $this->name, '', 38, 0, $this->aExtraAttribs));
+        $oTemplate->assign('trailing_text', $this->trailing_text);
+        $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) == \'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 = document.forms[i-1].elements[pos]; } } for (x = 0; x < this.length; x++) { if (this.options[x].selected) { window.addinput.value = this.options[x].value; break; } }'), $this->aExtraAttribs), TRUE, $height));
+        $oTemplate->assign('checkbox_widget', addCheckBox('delete_' . $this->name, FALSE, SMPREF_YES, array_merge(array('id' => 'delete_' . $this->name), $this->aExtraAttribs)));
+        $oTemplate->assign('name', $this->name);
+        return $oTemplate->fetch('edit_list_widget.tpl');
+
+    }
+
     /**
      *
      */
@@ -533,21 +723,78 @@ class SquirrelOption {
      *
      */
     function changed() {
+
+        // edit lists have a lot going on, so we'll always process them
+        //
+        if ($this->type == SMOPT_TYPE_EDIT_LIST) return TRUE;
+
         return ($this->value != $this->new_value);
     }
 } /* End of SquirrelOption class*/
 
 /**
- * Saves option
+ * Saves the option value (this is the default save function
+ * unless overridden by the user)
+ *
  * @param object $option object that holds option name and new_value
  */
 function save_option($option) {
+
+    // Can't save the pref if we don't have the username
+    //
     if ( !sqgetGlobalVar('username', $username, SQ_SESSION ) ) {
-        /* Can't save the pref if we don't have the username */
         return;
     }
+
     global $data_dir;
-    setPref($data_dir, $username, $option->name, $option->new_value);
+
+    // edit lists: first add new elements to list, then
+    // remove any selected ones (note that we must add
+    // before deleting because the javascript that populates
+    // the "add" textbox when selecting items in the list
+    // (for deletion))
+    //
+    if ($option->type == SMOPT_TYPE_EDIT_LIST) {
+
+        if (empty($option->possible_values)) $option->possible_values = array();
+        if (!is_array($option->possible_values)) $option->possible_values = array($option->possible_values);
+
+        // add element if given
+        //
+        if (sqGetGlobalVar('add_' . $option->name, $new_element, SQ_POST)) {
+            $new_element = trim($new_element);
+            if (!empty($new_element)
+             && !in_array($new_element, $option->possible_values))
+                $option->possible_values[] = $new_element;
+        }
+        
+        // delete selected elements if needed
+        //
+        if (is_array($option->new_value)
+         && sqGetGlobalVar('delete_' . $option->name, $ignore, SQ_POST))
+            $option->possible_values = array_diff($option->possible_values, $option->new_value);
+
+        // save full list (stored in "possible_values")
+        //
+        setPref($data_dir, $username, $option->name, serialize($option->possible_values));
+
+    // Certain option types need to be serialized because
+    // they are not scalar
+    //
+    } else if ($option->is_multiple_valued())
+        setPref($data_dir, $username, $option->name, serialize($option->new_value));
+
+    // Checkboxes, when unchecked, don't submit anything in
+    // the POST, so set to SMPREF_OFF if not found
+    //
+    else if (($option->type == SMOPT_TYPE_BOOLEAN
+           || $option->type == SMOPT_TYPE_BOOLEAN_CHECKBOX)
+          && empty($option->new_value)) 
+        setPref($data_dir, $username, $option->name, SMPREF_OFF);
+
+    else
+        setPref($data_dir, $username, $option->name, $option->new_value);
+
 }
 
 /**
@@ -564,7 +811,7 @@ function save_option_noop($option) {
  * @return string html formated hidden input field
  */
 function create_optpage_element($optpage) {
-    return create_hidden_element('optpage', $optpage);
+    return addHidden('optpage', $optpage);
 }
 
 /**
@@ -573,20 +820,7 @@ function create_optpage_element($optpage) {
  * @return string html formated hidden input field
  */
 function create_optmode_element($optmode) {
-    return create_hidden_element('optmode', $optmode);
-}
-
-/**
- * Create hidden field.
- * @param string $name field name
- * @param string $value field value
- * @return string html formated hidden input field
- */
-function create_hidden_element($name, $value) {
-    $result = '<input type="hidden" '
-            . 'name="' . $name . '" '
-            . 'value="' . htmlspecialchars($value) . '" />';
-    return ($result);
+    return addHidden('optmode', $optmode);
 }
 
 /**
@@ -610,14 +844,14 @@ function create_option_groups($optgrps, $optvals) {
         foreach ($grpopts as $optset) {
             /* Create a new option with all values given. */
             $next_option = new SquirrelOption(
-                 $optset['name'],
-                 $optset['caption'],
-                 $optset['type'],
-                 (isset($optset['refresh']) ? $optset['refresh'] : SMOPT_REFRESH_NONE),
-                 (isset($optset['initial_value']) ? $optset['initial_value'] : ''),
-                 (isset($optset['posvals']) ? $optset['posvals'] : ''),
-                 (isset($optset['htmlencoded']) ? $optset['htmlencoded'] : false)
-            );
+                    $optset['name'],
+                    $optset['caption'],
+                    $optset['type'],
+                    (isset($optset['refresh']) ? $optset['refresh'] : SMOPT_REFRESH_NONE),
+                    (isset($optset['initial_value']) ? $optset['initial_value'] : ''),
+                    (isset($optset['posvals']) ? $optset['posvals'] : ''),
+                    (isset($optset['htmlencoded']) ? $optset['htmlencoded'] : false)
+                    );
 
             /* If provided, set the size for this option. */
             if (isset($optset['size'])) {
@@ -629,6 +863,16 @@ function create_option_groups($optgrps, $optvals) {
                 $next_option->setTrailingText($optset['trailing_text']);
             }
 
+            /* If provided, set the yes_text for this option. */
+            if (isset($optset['yes_text'])) {
+                $next_option->setYesText($optset['yes_text']);
+            }
+
+            /* If provided, set the no_text for this option. */
+            if (isset($optset['no_text'])) {
+                $next_option->setNoText($optset['no_text']);
+            }
+
             /* If provided, set the comment for this option. */
             if (isset($optset['comment'])) {
                 $next_option->setComment($optset['comment']);
@@ -639,9 +883,9 @@ function create_option_groups($optgrps, $optvals) {
                 $next_option->setSaveFunction($optset['save']);
             }
 
-            /* If provided, set the script for this option. */
-            if (isset($optset['script'])) {
-                $next_option->setScript($optset['script']);
+            /* If provided, set the extra attributes for this option. */
+            if (isset($optset['extra_attributes'])) {
+                $next_option->setExtraAttributes($optset['extra_attributes']);
             }
 
             /* If provided, set the "post script" for this option. */
@@ -649,6 +893,11 @@ function create_option_groups($optgrps, $optvals) {
                 $next_option->setPostScript($optset['post_script']);
             }
 
+            /* If provided, set the folder_filter for this option. */
+            if (isset($optset['folder_filter'])) {
+                $next_option->setFolderFilter($optset['folder_filter']);
+            }
+
             /* Add this option to the option array. */
             $result[$grpkey]['options'][] = $next_option;
         }
@@ -658,49 +907,3 @@ function create_option_groups($optgrps, $optvals) {
     return ($result);
 }
 
-/**
- * @param array $option_groups
- */
-function print_option_groups($option_groups) {
-    /* Print each option group. */
-    foreach ($option_groups as $next_optgrp) {
-        /* If it is not blank, print the name for this option group. */
-        if ($next_optgrp['name'] != '') {
-            echo html_tag( 'tr', "\n".
-                        html_tag( 'td',
-                            '<b>' . $next_optgrp['name'] . '</b>' ,
-                        'center' ,'', 'valign="middle" colspan="2" style="white-space: nowrap;"' )
-                    ) ."\n";
-        }
-
-        /* Print each option in this option group. */
-        foreach ($next_optgrp['options'] as $option) {
-            if ($option->type != SMOPT_TYPE_HIDDEN) {
-                echo html_tag( 'tr', "\n".
-                           html_tag( 'td', $option->caption . ':', 'right' ,'', 'valign="middle"' ) .
-                           html_tag( 'td', $option->createHTMLWidget(), 'left' )
-                       ) ."\n";
-            } else {
-                echo $option->createHTMLWidget();
-            }
-        }
-
-        /* Print an empty row after this option group. */
-        echo html_tag( 'tr',
-                   html_tag( 'td', '&nbsp;', 'left', '', 'colspan="2"' )
-                ) . "\n";
-    }
-}
-
-/**
- * Create submit button inside table row.
- * @param string $name
- */
-function OptionSubmit( $name ) {
-        echo html_tag( 'tr',
-                   html_tag( 'td', '<input type="submit" value="' . _("Submit") . '" name="' . $name . '" />&nbsp;&nbsp;&nbsp;&nbsp;', 'right', '', 'colspan="2"' )
-                ) . "\n";
-}
-
-// vim: et ts=4
-?>
\ No newline at end of file