*
* Functions needed to display the options pages.
*
- * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @copyright 1999-2017 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
* @subpackage prefs
*/
-/**********************************************/
-/* 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('SMOPT_TYPE_COMMENT', 7);
-define('SMOPT_TYPE_FLDRLIST', 8);
-define('SMOPT_TYPE_FLDRLIST_MULTI', 9);
-
-/* Define constants for the options refresh levels. */
-define('SMOPT_REFRESH_NONE', 0);
-define('SMOPT_REFRESH_FOLDERLIST', 1);
-define('SMOPT_REFRESH_ALL', 2);
-
-/* Define constants for the options size. */
-define('SMOPT_SIZE_TINY', 0);
-define('SMOPT_SIZE_SMALL', 1);
-define('SMOPT_SIZE_MEDIUM', 2);
-define('SMOPT_SIZE_LARGE', 3);
-define('SMOPT_SIZE_HUGE', 4);
-define('SMOPT_SIZE_NORMAL', 5);
-
-define('SMOPT_SAVE_DEFAULT', 'save_option');
-define('SMOPT_SAVE_NOOP', 'save_option_noop');
-
/**
* SquirrelOption: An option for SquirrelMail.
*
* @subpackage prefs
*/
class SquirrelOption {
+ /**
+ * The original option configuration array
+ * @var array
+ */
+ var $raw_option_array;
/**
* The name of this setting
* @var string
* @var string
*/
var $caption;
+ /**
+ * Whether or not the caption text is allowed to wrap
+ * @var boolean
+ */
+ var $caption_wrap;
/**
* The type of INPUT element
*
* @var string
*/
var $trailing_text;
+ /**
+ * Indicates that the widget's "trailing text"
+ * should be displayed in a smaller sized font
+ *
+ * @var boolean
+ */
+ var $trailing_text_small;
+ /**
+ * Indicates that the widget's "trailing text"
+ * contains HTML and should not thus be
+ * sanitized (encoded)
+ *
+ * @var boolean
+ */
+ var $trailing_text_is_html;
+ /**
+ * 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;
+ /**
+ * associative array, treated the same as $possible_values
+ * (see its documentation below), but usually expected to
+ * have its first value contain a list of IMAP folders, an
+ * array itself in the format as passed back by
+ * sqimap_mailbox_list(). Used to display folder selector
+ * for possible values of an associative edit list option
+ * widget
+ *
+ * @since 1.5.2
+ * @var array
+ */
+ var $poss_value_folders;
/**
* text displayed to the user
*
var $htmlencoded=false;
/**
* Controls folder list limits in SMOPT_TYPE_FLDRLIST and
- * SMOPT_TYPE_FLDRLIST_MULTI widgets.
+ * SMOPT_TYPE_FLDRLIST_MULTI widgets as well as the optional
+ * embedded folder lists provided for inputting values for
+ * the SMOPT_TYPE_EDIT_LIST and SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE
+ * :idgets.
* See $flag argument in sqimap_mailbox_option_list() function.
* @var string
* @since 1.5.1
var $folder_filter='noselect';
/**
- * Constructor function
+ * Constructor (PHP5 style, required in some future version of PHP)
+ * @param array $raw_option_array
* @param string $name
* @param string $caption
* @param integer $type
* @param array $possible_values
* @param bool $htmlencoded
*/
- function SquirrelOption
- ($name, $caption, $type, $refresh_level, $initial_value = '', $possible_values = '', $htmlencoded = false) {
+ function __construct
+ ($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_MEDIUM;
+ $this->size = SMOPT_SIZE_NORMAL;
$this->trailing_text = '';
+ $this->trailing_text_small = FALSE;
+ $this->trailing_text_is_html = FALSE;
+ $this->yes_text = '';
+ $this->no_text = '';
$this->comment = '';
+ $this->layout_type = 0;
+ $this->use_add_widget = TRUE;
+ $this->use_delete_widget = TRUE;
+ $this->poss_value_folders = '';
$this->aExtraAttribs = array();
$this->post_script = '';
/* 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. */
- if (($type != SMOPT_TYPE_HIDDEN) && ($type != SMOPT_TYPE_COMMENT)) {
+ if ($type != SMOPT_TYPE_HIDDEN
+ && $type != SMOPT_TYPE_INFO
+ && $type != SMOPT_TYPE_COMMENT) {
$this->save_function = SMOPT_SAVE_DEFAULT;
} else {
$this->save_function = SMOPT_SAVE_NOOP;
}
}
+ /**
+ * Constructor (PHP4 style, kept for compatibility reasons)
+ * @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
+ ($raw_option_array, $name, $caption, $type, $refresh_level, $initial_value = '', $possible_values = '', $htmlencoded = false) {
+ self::__construct($raw_option_array, $name, $caption, $type, $refresh_level, $initial_value, $possible_values, $htmlencoded);
+ }
+
+ /** 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
+ || $this->type == SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE);
+ }
+
/**
* Set the value for this option.
* @param mixed $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
$this->trailing_text = $trailing_text;
}
+ /**
+ * Set the trailing_text_small for this option.
+ * @param boolean $trailing_text_small
+ */
+ function setTrailingTextSmall($trailing_text_small) {
+ $this->trailing_text_small = $trailing_text_small;
+ }
+
+ /**
+ * Set the trailing_text_is_html for this option.
+ * @param boolean $trailing_text_is_html
+ */
+ function setTrailingTextIsHtml($trailing_text_is_html) {
+ $this->trailing_text_is_html = $trailing_text_is_html;
+ }
+
+ /**
+ * 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 "poss value folders" value for this option.
+ See the associative edit list widget, which uses this
+ to offer folder list selection for the values */
+ function setPossValueFolders($poss_value_folders) {
+ $this->poss_value_folders = $poss_value_folders;
+ }
+
+ /**
+ * 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
}
/**
- * Set the trailing_text for this option.
+ * Set the folder_filter for this option.
* @param string $folder_filter
* @since 1.5.1
*/
/**
* 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
- if (!empty($this->new_value)) {
+ 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;
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_FLDRLIST_MULTI:
$result = $this->createWidget_FolderList(TRUE);
break;
+ case SMOPT_TYPE_EDIT_LIST:
+ $result = $this->createWidget_EditList();
+ break;
+ case SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE:
+ $result = $this->createWidget_EditListAssociative();
+ 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:
error_box (
sprintf(_("Option Type '%s' Not Found"), $this->type)
$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;
}
/* Now, return the created widget. */
- return ($result);
+ return $result;
+ }
+
+ /**
+ * Creates info block
+ * @return string html formated output
+ */
+ function createWidget_Info() {
+ // return sq_htmlspecialchars($this->value);
+ // like COMMENT, allow HTML here
+ return $this->value;
}
/**
* 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() {
+ function createWidget_String($password=FALSE) {
switch ($this->size) {
case SMOPT_SIZE_TINY:
$width = 5;
$width = 25;
}
- return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text);
+//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 (also, we have <small> tags here; don't want HTML here!)
+ if ($password)
+ return addPwField('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . ($this->trailing_text_small ? '<small>' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '</small>' : '');
+ else
+ return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . ($this->trailing_text_small ? '<small>' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '</small>' : '');
}
/**
- * 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!
*
- * @return string html formated selection box
+ * 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() {
+ 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
- return addSelect('new_' . $this->name, $this->possible_values, $this->value, TRUE, $this->aExtraAttribs) . htmlspecialchars($this->trailing_text);
+
+ // 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:
+ $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) . ($this->trailing_text_small ? '<small>' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '</small>' : '');
}
*/
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('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) . ($this->trailing_text_small ? '<small>' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '</small>' : '');
}
}
/**
- * 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() {
+ function createWidget_Boolean($checkbox=TRUE) {
- global $oTemplate;
- $nbsp = $oTemplate->fetch('non_breaking_space.tpl');
+ global $oTemplate, $nbsp;
+
+
+ // checkbox...
+ //
+ if ($checkbox) {
+//TODO: Why isn't trailing_text being sanitized with sm_encode_special_chars()??? If this is a bug, add that, then add the option to display unsanitized if $this->trailing_text_is_html is enabled
+ $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_small ? '<small>' : '') . $this->trailing_text . ($this->trailing_text_small ? '</small>' : ''), 'new_' . $this->name);
+ }
+
+ // 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 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');
+ /* 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 = addRadioBox('new_' . $this->name, ($this->value == SMPREF_NO), SMPREF_NO, array_merge(array('id' => 'new_' . $this->name . '_no'), $this->aExtraAttribs)) . $nbsp . create_label(_("No"), 'new_' . $this->name . '_no');
+ /* 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);
}
return ($result);
}
+ /**
+ * Creates a (non-associative) 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() {
+
+ 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;
+ }
+
+ 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('use_input_widget', $this->use_add_widget);
+ $oTemplate->assign('use_delete_widget', $this->use_delete_widget);
+
+ $oTemplate->assign('trailing_text', $this->trailing_text);
+ $oTemplate->assign('trailing_text_small', $this->trailing_text_small);
+ $oTemplate->assign('trailing_text_is_html', $this->trailing_text_is_html);
+ $oTemplate->assign('possible_values', $this->possible_values);
+ $oTemplate->assign('current_value', $this->value);
+ $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; i=f-1; j=e-1; } 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].text; break; } }'), $this->aExtraAttribs), TRUE, $height));
+// NOTE: i=f-1; j=e-1 is in lieu of break 2
+ $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"), $this->layout_type));
+ }
+
+ }
+
+ /**
+ * Creates an associative 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_EditListAssociative() {
+
+ 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;
+ }
+
+
+ // ensure correct format of current value(s)
+ //
+ if (empty($this->possible_values)) $this->possible_values = array();
+ if (!is_array($this->possible_values)) $this->possible_values = array($this->possible_values);
+
+
+ $oTemplate->assign('name', $this->name);
+ $oTemplate->assign('current_value', $this->value);
+ $oTemplate->assign('possible_values', $this->possible_values);
+ $oTemplate->assign('poss_value_folders', $this->poss_value_folders);
+ $oTemplate->assign('folder_filter', $this->folder_filter);
+
+ $oTemplate->assign('use_input_widget', $this->use_add_widget);
+ $oTemplate->assign('use_delete_widget', $this->use_delete_widget);
+
+ $oTemplate->assign('checkbox_widget', addCheckBox('delete_' . $this->name, FALSE, SMPREF_YES, array_merge(array('id' => 'delete_' . $this->name), $this->aExtraAttribs)));
+
+//FIXME: $this->aExtraAttribs probably should only be used in one place
+ $oTemplate->assign('input_key_widget', addInput('add_' . $this->name . '_key', '', 22, 0, $this->aExtraAttribs));
+ $oTemplate->assign('input_value_widget', addInput('add_' . $this->name . '_value', '', 12, 0, $this->aExtraAttribs));
+
+ $oTemplate->assign('select_height', $height);
+
+ $oTemplate->assign('aAttribs', $this->aExtraAttribs);
+
+ $oTemplate->assign('trailing_text', $this->trailing_text);
+ $oTemplate->assign('trailing_text_small', $this->trailing_text_small);
+ $oTemplate->assign('trailing_text_is_html', $this->trailing_text_is_html);
+
+ switch ($this->layout_type) {
+ case SMOPT_EDIT_LIST_LAYOUT_SELECT:
+ return $oTemplate->fetch('edit_list_associative_widget.tpl');
+ case SMOPT_EDIT_LIST_LAYOUT_LIST:
+ return $oTemplate->fetch('edit_list_associative_widget_list_style.tpl');
+ default:
+ error_box(sprintf(_("Associative Edit List Layout Type '%s' Not Found"), $this->layout_type));
+ }
+
+ }
+
+ /**
+ * Creates a submit button
+ *
+ * @return string html formated submit button widget
+ *
+ */
+ function createWidget_Submit() {
+
+ return addSubmit($this->comment, $this->name, $this->aExtraAttribs) . ($this->trailing_text_small ? '<small>' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '</small>' : '');
+
+ }
+
/**
*
*/
*
*/
function changed() {
+
+ // edit lists have a lot going on, so we'll always process them
+ //
+ if ($this->type == SMOPT_TYPE_EDIT_LIST
+ || $this->type == SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE)
+ return TRUE;
+
return ($this->value != $this->new_value);
}
} /* End of SquirrelOption class*/
return;
}
+ // if the widget is a selection list, make sure the new
+ // value is actually in the selection list and is not an
+ // injection attack
+ //
+ if ($option->type == SMOPT_TYPE_STRLIST
+ && !array_key_exists($option->new_value, $option->possible_values))
+ return;
+
+
+ // all other widgets except TEXTAREAs should never be allowed to have newlines
+ //
+ else if ($option->type != SMOPT_TYPE_TEXTAREA)
+ $option->new_value = str_replace(array("\r", "\n"), '', $option->new_value);
+
+
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));
+
+ // associative edit lists are handled similar to
+ // non-associative ones
+ //
+ } else if ($option->type == SMOPT_TYPE_EDIT_LIST_ASSOCIATIVE) {
+
+ 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
+ //
+ $new_element_key = '';
+ $new_element_value = '';
+ $retrieve_key = sqGetGlobalVar('add_' . $option->name . '_key', $new_element_key, SQ_POST);
+ $retrieve_value = sqGetGlobalVar('add_' . $option->name . '_value', $new_element_value, SQ_POST);
+
+ if ((isset($option->use_add_widget) && $option->use_add_widget)
+ && ($retrieve_key || $retrieve_value)) {
+ $new_element_key = trim($new_element_key);
+ $new_element_value = trim($new_element_value);
+ if ($option->poss_value_folders && empty($new_element_key))
+ $new_element_value = '';
+ if (!empty($new_element_key) || !empty($new_element_value)) {
+ if (empty($new_element_key)) $new_element_key = '0';
+ $option->possible_values[$new_element_key] = $new_element_value;
+ }
+ }
+
+ // 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)) {
+
+ if ($option->layout_type == SMOPT_EDIT_LIST_LAYOUT_SELECT) {
+ foreach ($option->new_value as $key)
+ unset($option->possible_values[urldecode($key)]);
+ }
+ else
+ $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->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);
+
+ // For integer fields, make sure we only have digits...
+ // We'll be nice and instead of just converting to an integer,
+ // we'll physically remove each non-digit in the string.
+ //
+ else if ($option->type == SMOPT_TYPE_INTEGER) {
+ $option->new_value = preg_replace('/[^0-9]/', '', $option->new_value);
+ setPref($data_dir, $username, $option->name, $option->new_value);
+ }
+
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 = '';
+
}
/**
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['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']);
$next_option->setTrailingText($optset['trailing_text']);
}
+ /* If provided, set the trailing_text_small for this option. */
+ if (isset($optset['trailing_text_small'])) {
+ $next_option->setTrailingTextSmall($optset['trailing_text_small']);
+ }
+
+ /* If provided, set the trailing_text_is_html for this option. */
+ if (isset($optset['trailing_text_is_html'])) {
+ $next_option->setTrailingTextIsHtml($optset['trailing_text_is_html']);
+ }
+
+ /* 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 poss_value_folders value for this option. */
+ if (isset($optset['poss_value_folders'])) {
+ $next_option->setPossValueFolders($optset['poss_value_folders']);
+ }
+
+ /* 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']);
projects / squirrelmail.git / blobdiff