X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Foptions.php;h=f7b208bdc3c7b3b7efb2444ae28810b29c3cb843;hb=402686269fca5ed8f50a33e3368f5410fb5ef89e;hp=02ed86c970b9af1828f7097cc7453a8595f7731e;hpb=4b5049de2fa934c45599d6e4c74bf2bbee10d34d;p=squirrelmail.git diff --git a/functions/options.php b/functions/options.php index 02ed86c9..f7b208bd 100644 --- a/functions/options.php +++ b/functions/options.php @@ -26,6 +26,9 @@ 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 constants for the options refresh levels. */ define('SMOPT_REFRESH_NONE', 0); @@ -144,7 +147,8 @@ class SquirrelOption { */ var $htmlencoded=false; /** - * Controls folder list limits in SMOPT_TYPE_FLDRLIST widget. + * 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 @@ -274,10 +278,12 @@ class SquirrelOption { /** * 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 @@ -315,11 +321,19 @@ 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; default: -//FIXME: can we throw an error here instead? either way, we don't want HTML here! - $result = '' - . sprintf(_("Option Type '%s' Not Found"), $this->type) - . ''; + error_box ( + sprintf(_("Option Type '%s' Not Found"), $this->type) + ); } /* Add the "post script" for this option. */ @@ -331,7 +345,7 @@ class SquirrelOption { } /* Now, return the created widget. */ - return ($result); + return $result; } /** @@ -367,19 +381,71 @@ class SquirrelOption { * $this->possible_values are assumed to be display-safe. * Use with care! * + * @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_StrList() { + function createWidget_StrList($multiple_select=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 - return addSelect('new_' . $this->name, $this->possible_values, $this->value, TRUE, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text); + + 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; + } + + 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() { + 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) @@ -390,7 +456,7 @@ class SquirrelOption { // list of folders (boxes array) // if (is_array($text)) { - $option_list = array_merge($option_list, sqimap_mailbox_option_array(0, array(strtolower($this->value)), 0, $text, $this->folder_filter)); + $option_list = array_merge($option_list, sqimap_mailbox_option_array(0, 0, $text, $this->folder_filter)); // just one option here // @@ -403,7 +469,7 @@ class SquirrelOption { $option_list = array('ignore' => _("unavailable")); - return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text); + return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height) . htmlspecialchars($this->trailing_text); } @@ -466,8 +532,7 @@ class SquirrelOption { */ function createWidget_Boolean() { - global $oTemplate; - $nbsp = $oTemplate->fetch('non_breaking_space.tpl'); + global $oTemplate, $nbsp; /* 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(_("Yes"), 'new_' . $this->name . '_yes'); @@ -497,6 +562,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); + + } + /** * */ @@ -509,21 +613,68 @@ 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) { + + // 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->type == SMOPT_TYPE_FLDRLIST_MULTI + || $option->type == SMOPT_TYPE_STRLIST_MULTI) + setPref($data_dir, $username, $option->name, serialize($option->new_value)); + + else + setPref($data_dir, $username, $option->name, $option->new_value); + } /** @@ -626,4 +777,3 @@ function create_option_groups($optgrps, $optvals) { return ($result); } -// vim: et ts=4