Add 'edit list' type option widget

functions/forms.php

@@ -170,16 +170,19 @@ function addInput($sName, $sValue = '', $iSize = 0, $iMaxlength = 0, $aAttribs=a
  * @param array   $aAttribs  (since 1.5.1) Extra attributes
  * @param boolean $bMultiple When TRUE, a multiple select list will be shown
  *                           (OPTIONAL; default is FALSE (single select list))
+ * @param int     $iSize     Desired height of multiple select boxes
+ *                           (OPTIONAL; default is SMOPT_SIZE_NORMAL)
+ *                           (only applicable when $bMultiple is TRUE)
  *
  * @return string html formated selection box
  * @todo add attributes argument for option tags and default css
  */
-function addSelect($sName, $aValues, $default = null, $bUsekeys = false, $aAttribs = array(), $bMultiple = FALSE) {
+function addSelect($sName, $aValues, $default = null, $bUsekeys = false, $aAttribs = array(), $bMultiple = FALSE, $iSize = SMOPT_SIZE_NORMAL) {
     // only one element
-    if(count($aValues) == 1) {
+    if (!$bMultiple && count($aValues) == 1) {
         $k = key($aValues); $v = array_pop($aValues);
-        return addHidden($sName, ($bUsekeys ? $k:$v), $aAttribs).
-            htmlspecialchars($v) . "\n";
+        return addHidden($sName, ($bUsekeys ? $k : $v), $aAttribs)
+             . htmlspecialchars($v);
     }
 
 
@@ -199,6 +202,7 @@ function addSelect($sName, $aValues, $default = null, $bUsekeys = false, $aAttri
     $oTemplate->assign('default', $default);
     $oTemplate->assign('name', $sName);
     $oTemplate->assign('multiple', $bMultiple);
+    $oTemplate->assign('size', $iSize);
 
     return $oTemplate->fetch('select.tpl');
 }

functions/options.php

@@ -27,6 +27,7 @@ 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 constants for the options refresh levels. */
 define('SMOPT_REFRESH_NONE', 0);
@@ -322,6 +323,9 @@ class SquirrelOption {
             case SMOPT_TYPE_FLDRLIST_MULTI:
                 $result = $this->createWidget_FolderList(TRUE);
                 break;
+            case SMOPT_TYPE_EDIT_LIST:
+                $result = $this->createWidget_EditList();
+                break;
             default:
                 error_box ( 
                     sprintf(_("Option Type '%s' Not Found"), $this->type)
@@ -394,6 +398,25 @@ class SquirrelOption {
      */
     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)
         //
@@ -416,8 +439,7 @@ class SquirrelOption {
             $option_list = array('ignore' => _("unavailable"));
 
 
-        // OK to use sq_htmlspecialchars() below because addSelect() already does
-        return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select) . sq_htmlspecialchars($this->trailing_text);
+        return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height) . htmlspecialchars($this->trailing_text);
 
     }
 
@@ -510,6 +532,45 @@ class SquirrelOption {
         return ($result);
     }
 
+    /**
+     * Creates an edit list
+     * @return string html formated list of edit fields and
+     *                their associated controls
+     */
+    function createWidget_EditList() {
+
+        global $br, $nbsp;
+
+        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;
+        }
+
+//FIXME: $this->aExtraAttribs and $this->trailing_text probably should only be used in one place
+//FIXME: might be nice to have this in a template file instead of creating layout here
+        return create_label(_("Add"), '')
+             . $nbsp . addInput('add_' . $this->name, '', 38, 0, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text)
+             . $br . 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) . htmlspecialchars($this->trailing_text)
+             . $br
+             . addCheckBox('delete_' . $this->name, FALSE, SMPREF_YES, array_merge(array('id' => 'delete_' . $this->name), $this->aExtraAttribs))
+             . $nbsp . create_label(_("Delete Selected"), 'delete_' . $this->name);
+
+    }
+
     /**
      *
      */
@@ -522,6 +583,11 @@ 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*/
@@ -542,11 +608,39 @@ function save_option($option) {
 
     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) {
+
+        // 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
     //
-    if ($option->type == SMOPT_TYPE_FLDRLIST_MULTI)
+    } else if ($option->type == SMOPT_TYPE_FLDRLIST_MULTI)
         setPref($data_dir, $username, $option->name, serialize($option->new_value));
+
     else
         setPref($data_dir, $username, $option->name, $option->new_value);
 

templates/default/select.tpl

@@ -25,6 +25,8 @@
   *                   optional and might be null) should be placed
   *                   in double quotes as attribute values (optional;
   *                   may not be present)
+  * int     $size     The desired height of multiple select boxes (not
+  *                   applicable when $multiple is FALSE)
   *
   * @copyright © 1999-2008 The SquirrelMail Project Team
   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
@@ -48,7 +50,7 @@ if (isset($aAttribs['id'])) {
 }
 
 
-echo '<select name="' . $name . ($multiple ? '[]" multiple="multiple" size="3"' : '"');
+echo '<select name="' . $name . ($multiple ? '[]" multiple="multiple" size="' . $size . '"' : '"');
 foreach ($aAttribs as $key => $value) {
     echo ' ' . $key . (is_null($value) ? '' : '="' . $value . '"');
 }