Minor JavaScript fix when multiple select-style edit lists appear on the same page
[squirrelmail.git] / functions / options.php
index 6de0efffa0fd9647f73f38b0d0f30e314cf04307..8311d6898c8dcd60bf3bbd5526b01e5ad52c1e38 100644 (file)
@@ -31,6 +31,11 @@ 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 layout scheme for edit lists. */
+define('SMOPT_EDIT_LIST_LAYOUT_LIST', 0);
+define('SMOPT_EDIT_LIST_LAYOUT_SELECT', 1);
 
 /* Define constants for the options refresh levels. */
 define('SMOPT_REFRESH_NONE', 0);
@@ -109,6 +114,12 @@ class SquirrelOption {
      * @var string
      */
     var $no_text;
+    /**
+     * Some widgets support more than one layout type
+     *
+     * @var int
+     */
+    var $layout_type;
     /**
      * text displayed to the user
      *
@@ -195,6 +206,7 @@ class SquirrelOption {
         $this->yes_text = '';
         $this->no_text = '';
         $this->comment = '';
+        $this->layout_type = 0;
         $this->aExtraAttribs = array();
         $this->post_script = '';
 
@@ -209,7 +221,7 @@ class SquirrelOption {
 
         /* Check for a new value. */
         if ( !sqgetGlobalVar("new_$name", $this->new_value, SQ_POST ) ) {
-            $this->new_value = '';
+            $this->new_value = NULL;
         }
 
         /* Set the default save function. */
@@ -276,6 +288,14 @@ class SquirrelOption {
         $this->no_text = $no_text;
     }
 
+    /**
+     * 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
@@ -329,7 +349,7 @@ class SquirrelOption {
         global $color;
 
         // Use new value if available
-        if (!empty($this->new_value)) {
+        if (!is_null($this->new_value)) {
             $tempValue = $this->value;
             $this->value = $this->new_value;
         }
@@ -378,6 +398,9 @@ class SquirrelOption {
             case SMOPT_TYPE_STRLIST_MULTI:
                 $result = $this->createWidget_StrList(TRUE);
                 break;
+            case SMOPT_TYPE_STRLIST_RADIO:
+                $result = $this->createWidget_StrList(FALSE, TRUE);
+                break;
             default:
                 error_box ( 
                     sprintf(_("Option Type '%s' Not Found"), $this->type)
@@ -388,7 +411,7 @@ class SquirrelOption {
         $result .= $this->post_script;
 
         // put correct value back if need be
-        if (!empty($this->new_value)) {
+        if (!is_null($this->new_value)) {
             $this->value = $tempValue;
         }
 
@@ -419,27 +442,57 @@ class SquirrelOption {
                 $width = 25;
         }
 
-        return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text);
+        return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text); 
     }
 
     /**
-     * Create 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!
      *
-     * @param boolean $multiple_select When TRUE, the select widget 
+     * 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 
+     *                                 (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
+     * @return string html formated selection box or radio buttons
      *
      */
-    function createWidget_StrList($multiple_select=FALSE) {
+    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;
+            }
+
+            return $result;
+        }
+
+
+        // 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:
@@ -638,6 +691,11 @@ class SquirrelOption {
 
     /**
      * 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
      */
@@ -670,10 +728,19 @@ class SquirrelOption {
 //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('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);
-        return $oTemplate->fetch('edit_list_widget.tpl');
+
+        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));
+        }
 
     }
 
@@ -750,9 +817,26 @@ function save_option($option) {
     } 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 = '';
+
 }
 
 /**
@@ -831,6 +915,11 @@ function create_option_groups($optgrps, $optvals) {
                 $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 comment for this option. */
             if (isset($optset['comment'])) {
                 $next_option->setComment($optset['comment']);