X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Foptions.php;h=4608d798433f1c5ec0cfef53655e98bb221e6719;hb=f99c446918b4b7452891d487df62e871ea03f19b;hp=72674ca4faf602eba82f0b80db5ec5c09575b2dc;hpb=fd87494d30afbfc69dafcaaaec43e287be4bc22c;p=squirrelmail.git

diff --git a/functions/options.php b/functions/options.php
index 72674ca4..4608d798 100644
--- a/functions/options.php
+++ b/functions/options.php
@@ -1,89 +1,372 @@
 <?php
-    /**
-     * options.php
-     *
-     * Copyright (c) 1999-2001 The Squirrelmail Development Team
-     * Licensed under the GNU GPL. For full terms see the file COPYING.
-     *
-     * Functions needed to display the options pages.
-     *
-     * $Id$
-     */
-
-/**********************************************/
-/* Define constants used in the options code. */
-/**********************************************/
-
-/* Define constants for the various option types. */
-define('SMOPT_TYPE_STRING', 0);
-define('SMOPT_TYPE_STRLIST', 1);
-define('SMOPT_TYPE_TEXTAREA', 2);
-define('SMOPT_TYPE_INTEGER', 3);
-define('SMOPT_TYPE_FLOAT', 4);
-define('SMOPT_TYPE_BOOLEAN', 5);
-define('SMOPT_TYPE_HIDDEN', 6);
-
-/* Define constants for the options refresh levels. */
-define('SMOPT_REFRESH_NONE', 0);
-define('SMOPT_REFRESH_FOLDERLIST', 1);
-define('SMOPT_REFRESH_ALL', 2);
 
 /**
- * SquirrelOption: An option for Squirrelmail.
+ * options.php
+ *
+ * Functions needed to display the options pages.
  *
- * This class is a work in progress. When complete, it will handle
- * presentation and saving of Squirrelmail user options in a simple,
- * streamline manner. Stay tuned for more stuff.
+ * @copyright &copy; 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage prefs
+ */
+
+/**
+ * SquirrelOption: An option for SquirrelMail.
  *
- * Also, I'd like to ask that people leave this alone (mostly :) until
- * I get it a little further along. That should only be a day or two or
- * three. I will remove this message when it is ready for primetime usage.
+ * @package squirrelmail
+ * @subpackage prefs
  */
 class SquirrelOption {
-    /* The basic stuff. */
+    /**
+     * The original option configuration array
+     * @var array
+     */
+    var $raw_option_array;
+    /**
+     * The name of this setting
+     * @var string
+     */
     var $name;
+    /**
+     * The text that prefaces setting on the preferences page
+     * @var string
+     */
     var $caption;
+    /**
+     * Whether or not the caption text is allowed to wrap
+     * @var boolean
+     */
+    var $caption_wrap;
+    /**
+     * The type of INPUT element
+     *
+     * See SMOPT_TYPE_* defines
+     * @var integer
+     */
     var $type;
+    /**
+     * Indicates if a link should be shown to refresh part
+     * or all of the window
+     *
+     * See SMOPT_REFRESH_* defines
+     * @var integer
+     */
     var $refresh_level;
+    /**
+     * Specifies the size of certain input items
+     *
+     * See SMOPT_SIZE_* defines
+     * @var integer
+     */
+    var $size;
+    /**
+     * 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;
+    /**
+     * Some widgets support more than one layout type
+     *
+     * @var int
+     */
+    var $layout_type;
+    /**
+     * Indicates if the Add widget should be included
+     * with edit lists.
+     *
+     * @var boolean
+     */
+    var $use_add_widget;
+    /**
+     * Indicates if the Delete widget should be included
+     * with edit lists.
+     *
+     * @var boolean
+     */
+    var $use_delete_widget;
+    /**
+     * text displayed to the user
+     *
+     * Used with SMOPT_TYPE_COMMENT options
+     * @var string
+     */
+    var $comment;
+    /**
+     * 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 $aExtraAttribs;
+    /**
+     * script (usually Javascript) that will be placed after (outside of)
+     * the INPUT tag
+     * @var string
+     */
+    var $post_script;
+
+    /**
+     * The name of the Save Function for this option.
+     * @var string
+     */
+    var $save_function;
 
     /* The various 'values' for this options. */
+    /**
+     * default/preselected value for this option
+     * @var mixed
+     */
     var $value;
+    /**
+     * new option value
+     * @var mixed
+     */
     var $new_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
+     */
     var $possible_values;
+    /**
+     * disables html sanitizing.
+     *
+     * 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';
 
-    /* This variable needs to be made private so it can not be messed with. */
-    /* I just don't remember how to do it right now and think it would be   */
-    /* better to keep coding. Someone can fix it, if they want. Or I will.  */
-    var $changed;
-
+    /**
+     * Constructor function
+     * @param array $raw_option_array
+     * @param string $name
+     * @param string $caption
+     * @param integer $type
+     * @param integer $refresh_level
+     * @param mixed $initial_value
+     * @param array $possible_values
+     * @param bool $htmlencoded
+     */
     function SquirrelOption
-    ($name, $caption, $type, $refresh_level, $possible_values = '') {
+    ($raw_option_array, $name, $caption, $type, $refresh_level, $initial_value = '', $possible_values = '', $htmlencoded = false) {
         /* Set the basic stuff. */
+        $this->raw_option_array = $raw_option_array;
         $this->name = $name;
         $this->caption = $caption;
+        $this->caption_wrap = TRUE;
         $this->type = $type;
         $this->refresh_level = $refresh_level;
         $this->possible_values = $possible_values;
+        $this->htmlencoded = $htmlencoded;
+        $this->size = SMOPT_SIZE_NORMAL;
+        $this->trailing_text = '';
+        $this->yes_text = '';
+        $this->no_text = '';
+        $this->comment = '';
+        $this->layout_type = 0;
+        $this->use_add_widget = TRUE;
+        $this->use_delete_widget = TRUE;
+        $this->aExtraAttribs = array();
+        $this->post_script = '';
 
-        /* Check for a current value. */
+        //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 = '';
         }
 
         /* Check for a new value. */
-        if (isset($GLOBALS["new_$name"])) {
-            $this->new_value = $GLOBALS["new_$name"];
-            $this->changed = ($this->value !== $this->new_value);
+        if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) {
+            $this->new_value = NULL;
+        }
+
+        /* Set the default save function. */
+        if ($type != SMOPT_TYPE_HIDDEN
+         && $type != SMOPT_TYPE_INFO
+         && $type != SMOPT_TYPE_COMMENT) {
+            $this->save_function = SMOPT_SAVE_DEFAULT;
         } else {
-            $this->new_value = '';
-            $this->changed = false;
+            $this->save_function = SMOPT_SAVE_NOOP;
         }
     }
 
-    function createHTMLWidget() {
+    /** 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
+     */
+    function setValue($value) {
+        $this->value = $value;
+    }
+
+    /**
+     * Set the new value for this option.
+     * @param mixed $new_value
+     */
+    function setNewValue($new_value) {
+        $this->new_value = $new_value;
+    }
+
+    /**
+     * Set whether the caption is allowed to wrap for this option.
+     * @param boolean $caption_wrap
+     */
+    function setCaptionWrap($caption_wrap) {
+        $this->caption_wrap = $caption_wrap;
+    }
+
+    /**
+     * Set the size for this option.
+     * @param integer $size
+     */
+    function setSize($size) {
+        $this->size = $size;
+    }
+
+    /**
+     * Set the trailing_text for this option.
+     * @param string $trailing_text
+     */
+    function setTrailingText($trailing_text) {
+        $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 "use add widget" value for this option. */
+    function setUseAddWidget($use_add_widget) {
+        $this->use_add_widget = $use_add_widget;
+    }
+
+    /* Set the "use delete widget" value for this option. */
+    function setUseDeleteWidget($use_delete_widget) {
+        $this->use_delete_widget = $use_delete_widget;
+    }
+
+    /**
+     * Set the layout type for this option.
+     * @param int $layout_type
+     */
+    function setLayoutType($layout_type) {
+        $this->layout_type = $layout_type;
+    }
+
+    /**
+     * Set the comment for this option.
+     * @param string $comment
+     */
+    function setComment($comment) {
+        $this->comment = $comment;
+    }
+
+    /**
+     * Set the extra attributes for this option.
+     * @param array $aExtraAttribs
+     */
+    function setExtraAttributes($aExtraAttribs) {
+        $this->aExtraAttribs = $aExtraAttribs;
+    }
+
+    /**
+     * Set the "post script" for this option.
+     * @param string $post_script
+     */
+    function setPostScript($post_script) {
+        $this->post_script = $post_script;
+    }
+
+    /**
+     * Set the save function for this option.
+     * @param string $save_function
+     */
+    function setSaveFunction($save_function) {
+        $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
+     *
+     * This is the function that calls all other createWidget* functions.
+     *
+     * @return string The formated option field
+     *
+     */
+    function createWidget() {
+        global $color;
+
+        // Use new value if available
+        if (!is_null($this->new_value)) {
+            $tempValue = $this->value;
+            $this->value = $this->new_value;
+        }
+
+        /* Get the widget for this option type. */
         switch ($this->type) {
+            case SMOPT_TYPE_PASSWORD:
+                $result = $this->createWidget_String(TRUE);
+                break;
             case SMOPT_TYPE_STRING:
                 $result = $this->createWidget_String();
                 break;
@@ -102,202 +385,642 @@ 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;
+            case SMOPT_TYPE_COMMENT:
+                $result = $this->createWidget_Comment();
+                break;
+            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;
+            case SMOPT_TYPE_SUBMIT:
+                $result = $this->createWidget_Submit();
+                break;
+            case SMOPT_TYPE_INFO:
+                $result = $this->createWidget_Info();
+                break;
             default:
-               $result = '<FONT COLOR=RED>'
-                       . 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. */
+        $result .= $this->post_script;
+
+        // put correct value back if need be
+        if (!is_null($this->new_value)) {
+            $this->value = $tempValue;
         }
 
         /* Now, return the created widget. */
-        return ($result);
+        return $result;
     }
 
-    function createWidget_String() {
-        $result = "<INPUT NAME=\"new_$this->name\" value=\"$this->value\" size=\"5\">";
-        return ($result);
+    /**
+     * Creates info block
+     * @return string html formated output
+     */
+    function createWidget_Info() {
+        return sq_htmlspecialchars($this->value);
     }
 
-    function createWidget_StrList() {
-        /* Begin the select tag. */
-        $result = "<SELECT NAME=\"new_$this->name\">";
+    /**
+     * Create string field
+     *
+     * @param boolean $password When TRUE, the text in the input
+     *                          widget will be obscured (OPTIONAL;
+     *                          default = FALSE).
+     *
+     * @return string html formated option field
+     *
+     */
+    function createWidget_String($password=FALSE) {
+        switch ($this->size) {
+            case SMOPT_SIZE_TINY:
+                $width = 5;
+                break;
+            case SMOPT_SIZE_SMALL:
+                $width = 12;
+                break;
+            case SMOPT_SIZE_LARGE:
+                $width = 38;
+                break;
+            case SMOPT_SIZE_HUGE:
+                $width = 50;
+                break;
+            case SMOPT_SIZE_NORMAL:
+            default:
+                $width = 25;
+        }
 
-        /* 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=\"$real_value\"";
+//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
+        if ($password)
+            return addPwField('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . htmlspecialchars($this->trailing_text);
+        else
+            return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . htmlspecialchars($this->trailing_text);
+    }
 
-            /* If this value is the current value, select it. */
-            if ($real_value == $this->value) {
-               $new_option .= ' SELECTED';
+    /**
+     * 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($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
+
+        // radio buttons instead of select widget?
+        //
+        if ($radio_buttons) {
+
+            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 .= ">$disp_value</OPTION>";
+            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>';
-        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($multiple_select=FALSE) {
+
+        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;
+        }
+
+        // possible values might include a nested array of 
+        // possible values (list of folders)
+        //
+        $option_list = array();
+        foreach ($this->possible_values as $value => $text) {
+
+            // 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));
+
+            // just one option here
+            //
+            } else {
+              $option_list = array_merge($option_list, array($value => $text));
+            }
+
+        }
+        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);
+
+    }
+
+    /**
+     * Creates textarea
+     * @return string html formated textarea field
+     */
     function createWidget_TextArea() {
+        switch ($this->size) {
+            case SMOPT_SIZE_TINY:  $rows = 3; $cols =  10; break;
+            case SMOPT_SIZE_SMALL: $rows = 4; $cols =  30; break;
+            case SMOPT_SIZE_LARGE: $rows = 10; $cols =  60; break;
+            case SMOPT_SIZE_HUGE:  $rows = 20; $cols =  80; break;
+            case SMOPT_SIZE_NORMAL:
+            default: $rows = 5; $cols =  50;
+        }
+        return addTextArea('new_' . $this->name, $this->value, $cols, $rows, $this->aExtraAttribs);
     }
 
+    /**
+     * Creates field for integer
+     *
+     * Difference from createWidget_String is visible only when javascript is enabled
+     * @return string html formated option field
+     */
     function createWidget_Integer() {
-        return ($this->createWidget_String());
+
+        // add onChange javascript handler to a regular string widget
+        // which will strip out all non-numeric chars
+        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;';
+
+        return $this->createWidget_String();
     }
 
+    /**
+     * Creates field for floating number
+     * Difference from createWidget_String is visible only when javascript is enabled
+     * @return string html formated option field
+     */
     function createWidget_Float() {
-        return ($this->createWidget_String());
+
+        // add onChange javascript handler to a regular string widget
+        // which will strip out all non-numeric (period also OK) chars
+        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;';
+
+        return $this->createWidget_String();
     }
 
-    function createWidget_Boolean() {
-        /* Do the whole current value thing. */
-        if ($this->value != SMPREF_NO) {
-            $yes_chk = ' CHECKED';
-            $no_chk = '';
-        } else {
-            $yes_chk = '';
-            $no_chk = ' CHECKED';
+    /**
+     * 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($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" NAME="new_' . $this->name
-                    . '" VALUE="' . SMPREF_YES . "\"$yes_chk>&nbsp;"
-                    . _("Yes");
+        // 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 combined "boolean widget". */
+            $result = "$yes_option$nbsp$nbsp$nbsp$nbsp$no_option";
 
-        /* Build the no choice. */
-        $no_option = '<INPUT TYPE="RADIO" NAME="new_' . $this->name
-                   . '" VALUE="' . SMPREF_NO . "\"$no_chk>&nbsp;"
-                   . _("No");
+        }
 
-        /* Build and return the combined "boolean widget". */
-        $result = "$yes_option&nbsp;&nbsp;&nbsp;&nbsp;$no_option";
         return ($result);
     }
 
+    /**
+     * Creates hidden field
+     * @return string html formated hidden input field
+     */
     function createWidget_Hidden() {
-        $result = '<INPUT TYPE="HIDDEN" NAME="new_' . $this->name
-                . '" VALUE="' . $this->value . '">';
-        return ($result);
+        return addHidden('new_' . $this->name, $this->value, $this->aExtraAttribs);
     }
 
-    function hasChanged() {
-        return ($this->changed);
+    /**
+     * Creates comment
+     * @return string comment
+     */
+    function createWidget_Comment() {
+        $result = $this->comment;
+        return ($result);
     }
-}
 
-function createOptionArray($optvals) {
-    /* Build a simple array with which to start. */
-    $result = array();
+    /**
+     * Creates an edit list
+     *
+     * Note that multiple layout types are supported for this widget.
+     * $this->layout_type must be one of the SMOPT_EDIT_LIST_LAYOUT_*
+     * constants.
+     *
+     * @return string html formated list of edit fields and
+     *                their associated controls
+     */
+    function createWidget_EditList() {
 
-     /* Create a new SquirrelOption for each set of option values. */
-    foreach ($optvals as $optset) {
-        if (isset($optset['posvals'])) {
-            /* Create a new option with all values given. */
-            $result[] = new SquirrelOption(
-                $optset['name'],
-                $optset['caption'],
-                $optset['type'],
-                $optset['refresh'],
-                $optset['posvals']
-            );
-        } else {
-            /* Create a new option with all but possible values given. */
-            $result[] = new SquirrelOption(
-                $optset['name'],
-                $optset['caption'],
-                $optset['type'],
-                $optset['refresh']
-            );
+        global $oTemplate;
+
+        switch ($this->size) {
+            case SMOPT_SIZE_TINY:
+                $height = 3;
+                break;
+            case SMOPT_SIZE_SMALL:
+                $height = 8;
+                break;
+            case SMOPT_SIZE_MEDIUM:
+                $height = 15;
+                break;
+            case SMOPT_SIZE_LARGE:
+                $height = 25;
+                break;
+            case SMOPT_SIZE_HUGE:
+                $height = 40;
+                break;
+            case SMOPT_SIZE_NORMAL:
+            default:
+                $height = 5;
         }
-    }
 
-    /* Return our resulting array. */
-    return ($result);
-}
+        if (empty($this->possible_values)) $this->possible_values = array();
+        if (!is_array($this->possible_values)) $this->possible_values = array($this->possible_values);
 
-function OptionSelect( $title, $name, $data, $default, $show = '', $store = '' ) {
+//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('use_input_widget', $this->use_add_widget);
+        $oTemplate->assign('use_delete_widget', $this->use_delete_widget);
 
-    echo "<tr><td align=right valign=middle nowrap>$title: </td><td>" .
-         "<select name=\"$name\">";
-    foreach( $data as $key => $opt ) {
-        if ( $store == '' ) {
-            $vl = $key;
-        } else{
-            $vl = $opt[$store];
-        }
-        if ( $show == '' ) {
-            $nm = $opt;
-        } else{
-            $nm = $opt[$show];
-        }
-        if ( $nm <> '') {
-            echo "<option value=\"$vl\"";
-            if( $vl == $default ) {
-                echo ' selected';
-            }
-            echo ">$nm</option>\n";
+        $oTemplate->assign('trailing_text', $this->trailing_text);
+        $oTemplate->assign('possible_values', $this->possible_values);
+        $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));
+        $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);
+
+        switch ($this->layout_type) {
+            case SMOPT_EDIT_LIST_LAYOUT_SELECT:
+                return $oTemplate->fetch('edit_list_widget.tpl');
+            case SMOPT_EDIT_LIST_LAYOUT_LIST:
+                return $oTemplate->fetch('edit_list_widget_list_style.tpl');
+            default:
+                error_box(sprintf(_("Edit List Layout Type '%s' Not Found"), $layout_type));
         }
+
     }
-    echo "</select></td></tr>\n";
-}
 
-function OptionRadio( $title, $name, $data, $default, $show = '', $store = '', $sep = '&nbsp; &nbsp;'  ) {
-    echo "<tr><td align=right valign=middle nowrap>$title: </td><td>";
-    foreach( $data as $key => $opt ) {
-        if ( $store == '' ) {
-            $vl = $key;
-        } else{
-            $vl = $opt[$store];
-        }
-        if ( $show == '' ) {
-            $nm = $opt;
-        } else{
-            $nm = $opt[$show];
-        }
-        if ( $nm <> '') {
-            echo "<input type=\"radio\" name=\"$name\" value=\"$vl\"";
-            if( $vl == $default ) {
-                echo ' checked';
-            }
-            echo ">$nm $sep\n";
-        }
+    /**
+     * Creates a submit button
+     *
+     * @return string html formated submit button widget
+     *
+     */
+    function createWidget_Submit() {
+
+        return addSubmit($this->comment, $this->name, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text);
+
     }
-    echo "</td></tr>\n";
-}
 
-function OptionText( $title, $name, $value, $size ) {
-    echo "<tr><td align=right valign=middle nowrap>$title: </td><td>" .
-         "<input name=\"$name\" value=\"$value\" size=\"$size\">" .
-         "</td></tr>\n";
+    /**
+     *
+     */
+    function save() {
+        $function = $this->save_function;
+        $function($this);
+    }
+
+    /**
+     *
+     */
+    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 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 ) ) {
+        return;
+    }
+
+    global $data_dir;
+
+    // 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 ((isset($option->use_add_widget) && $option->use_add_widget)
+         && 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 ((isset($option->use_delete_widget) && $option->use_delete_widget)
+         && 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);
+
+
+    // if a checkbox or multi select is zeroed/cleared out, it
+    // needs to have an empty value pushed into its "new_value" slot
+    //
+    if (($option->type == SMOPT_TYPE_STRLIST_MULTI
+      || $option->type == SMOPT_TYPE_BOOLEAN_CHECKBOX)
+     && is_null($option->new_value))
+        $option->new_value = '';
+
 }
 
-function OptionHidden( $name, $value ) {
-    echo "<INPUT TYPE=HIDDEN NAME=\"$name\" VALUE=\"$value\">\n";
+/**
+ * save function that does not save
+ * @param object $option
+ */
+function save_option_noop($option) {
+    /* Do nothing here... */
 }
 
-function OptionCheck( $title, $name, $value, $comment ) {
-    if ( $value )
-        $chk = 'checked';
-    echo "<tr><td align=right valign=middle nowrap>$title: </td><td>" .
-         "<input type=\"checkbox\" name=\"$name\" $chk> $comment" .
-         "</td></tr>\n";
+/**
+ * Create hidden 'optpage' input field with value set by argument
+ * @param string $optpage identification of option page
+ * @return string html formated hidden input field
+ */
+function create_optpage_element($optpage) {
+    return addHidden('optpage', $optpage);
 }
 
-function OptionTitle( $title ) {
-    echo "<tr><td colspan=2 align=left valign=middle nowrap><b>$title</b></td></tr>\n";
+/**
+ * Create hidden 'optmode' input field with value set by argument
+ * @param string $optmode
+ * @return string html formated hidden input field
+ */
+function create_optmode_element($optmode) {
+    return addHidden('optmode', $optmode);
 }
 
-function OptionSubmit( $name ) {
-    echo '<tr><td>&nbsp;</td><td><input type="submit" value="' . _("Submit") . '" name="' . $name . '">' .
-         '</td></tr>';
+/**
+ * @param array $optgrps
+ * @param array $optvals
+ * @return array
+ */
+function create_option_groups($optgrps, $optvals) {
+    /* Build a simple array with which to start. */
+    $result = array();
+
+    /* Create option group for each option group name. */
+    foreach ($optgrps as $grpkey => $grpname) {
+        $result[$grpkey] = array();
+        $result[$grpkey]['name'] = $grpname;
+        $result[$grpkey]['options'] = array();
+    }
+
+     /* Create a new SquirrelOption for each set of option values. */
+    foreach ($optvals as $grpkey => $grpopts) {
+        foreach ($grpopts as $optset) {
+            /* Create a new option with all values given. */
+            $next_option = new SquirrelOption(
+                    $optset,
+                    $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 if the caption is allowed to wrap for this option. */
+            if (isset($optset['caption_wrap'])) {
+                $next_option->setCaptionWrap($optset['caption_wrap']);
+            }
+
+            /* If provided, set the size for this option. */
+            if (isset($optset['size'])) {
+                $next_option->setSize($optset['size']);
+            }
+
+            /* If provided, set the trailing_text for this option. */
+            if (isset($optset['trailing_text'])) {
+                $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 layout type for this option. */
+            if (isset($optset['layout_type'])) {
+                $next_option->setLayoutType($optset['layout_type']);
+            }
+
+            /* If provided, set the use_add_widget value for this option. */
+            if (isset($optset['use_add_widget'])) {
+                $next_option->setUseAddWidget($optset['use_add_widget']);
+            }
+
+            /* If provided, set the use_delete_widget value for this option. */
+            if (isset($optset['use_delete_widget'])) {
+                $next_option->setUseDeleteWidget($optset['use_delete_widget']);
+            }
+
+            /* If provided, set the comment for this option. */
+            if (isset($optset['comment'])) {
+                $next_option->setComment($optset['comment']);
+            }
+
+            /* If provided, set the save function for this option. */
+            if (isset($optset['save'])) {
+                $next_option->setSaveFunction($optset['save']);
+            }
+
+            /* 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. */
+            if (isset($optset['post_script'])) {
+                $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;
+        }
+    }
+
+    /* Return our resulting array. */
+    return ($result);
 }
 
-?>