X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Foptions.php;h=99e26ba057e42d24dc85481c671ee1326074f10d;hp=fa18ccee7281059376c5bd6bdf4598d5c5a16919;hb=b65a57eafe670d1550f663704ec100a5fe719bef;hpb=2d24b622c4c2e78a2e43ba1bed9877556de18de9 diff --git a/functions/options.php b/functions/options.php index fa18ccee..99e26ba0 100644 --- a/functions/options.php +++ b/functions/options.php @@ -5,7 +5,7 @@ * * Functions needed to display the options pages. * - * @copyright 1999-2017 The SquirrelMail Project Team + * @copyright 1999-2018 The SquirrelMail Project Team * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail @@ -68,8 +68,22 @@ class SquirrelOption { * useful for indicating units, meanings of special values, etc. * @var string */ -//TODO: add trailing_text_small as has been done with 1.4.x 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 @@ -206,6 +220,8 @@ class SquirrelOption { $this->htmlencoded = $htmlencoded; $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 = ''; @@ -219,6 +235,8 @@ class SquirrelOption { //Check for a current value. if (isset($GLOBALS[$name])) { $this->value = $GLOBALS[$name]; + // TODO: This code should be something more like the following, but who knows what would break if it was changed at this point + // } else if (initial_value !== '') { } else if (!empty($initial_value)) { $this->value = $initial_value; } else { @@ -305,6 +323,22 @@ class SquirrelOption { $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 @@ -520,11 +554,11 @@ class SquirrelOption { $width = 25; } -//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 +//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 tags here; don't want HTML here!) if ($password) - return addPwField('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . sm_encode_html_special_chars($this->trailing_text); + return addPwField('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . ($this->trailing_text_small ? '' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '' : ''); else - return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . sm_encode_html_special_chars($this->trailing_text); + return addInput('new_' . $this->name, $this->value, $width, 0, $this->aExtraAttribs) . ' ' . ($this->trailing_text_small ? '' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '' : ''); } /** @@ -594,7 +628,7 @@ class SquirrelOption { $height = 5; } - return addSelect('new_' . $this->name, $this->possible_values, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height, !$this->htmlencoded) . sm_encode_html_special_chars($this->trailing_text); + return addSelect('new_' . $this->name, $this->possible_values, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height, !$this->htmlencoded) . ($this->trailing_text_small ? '' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '' : ''); } @@ -652,7 +686,7 @@ class SquirrelOption { $option_list = array('ignore' => _("unavailable")); - return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height) . sm_encode_html_special_chars($this->trailing_text); + return addSelect('new_' . $this->name, $option_list, $this->value, TRUE, $this->aExtraAttribs, $multiple_select, $height) . ($this->trailing_text_small ? '' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '' : ''); } @@ -733,7 +767,8 @@ class SquirrelOption { // 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); +//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 ? '' : '') . $this->trailing_text . ($this->trailing_text_small ? '' : ''), 'new_' . $this->name); } // radio buttons... @@ -747,7 +782,7 @@ class SquirrelOption { $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"; + $result = "$yes_option$nbsp$nbsp$nbsp$nbsp$no_option " . ($this->trailing_text_small ? '' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '' : ''); } @@ -815,6 +850,8 @@ class SquirrelOption { $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)); @@ -895,6 +932,8 @@ class SquirrelOption { $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: @@ -915,7 +954,7 @@ class SquirrelOption { */ function createWidget_Submit() { - return addSubmit($this->comment, $this->name, $this->aExtraAttribs) . sm_encode_html_special_chars($this->trailing_text); + return addSubmit($this->comment, $this->name, $this->aExtraAttribs) . ($this->trailing_text_small ? '' : '') . ($this->trailing_text_is_html ? $this->trailing_text : sm_encode_html_special_chars($this->trailing_text)) . ($this->trailing_text_small ? '' : ''); } @@ -1159,6 +1198,16 @@ function create_option_groups($optgrps, $optvals) { $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']);