Skip to content

Always HTML escape ampersand in dropdown #3224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lubber-de merged 10 commits into from
Mar 26, 2025
Merged

Always HTML escape ampersand in dropdown #3224

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8590c21
Force ampersand HTML escape
mvorisek Mar 15, 2025
0363abe
fix double escaping then
mvorisek Mar 18, 2025
669797f
fix double encoded value for cmp
mvorisek Mar 18, 2025
26c999d
improve comment
mvorisek Mar 20, 2025
db8ae11
improve ternary format
mvorisek Mar 21, 2025
b268c97
"get selectValues" prevent double escaping
mvorisek Mar 21, 2025
91276ed
fix "escaped ampersand" by browser when preserveHTML=false
mvorisek Mar 21, 2025
12eda65
fix double encoding on user input & paste
mvorisek Mar 22, 2025
ce50ed7
fix "create userChoice"/"add userSuggestion" with preserveHTML=false
mvorisek Mar 25, 2025
8320117
Revert "Force ampersand HTML escape"
mvorisek Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 30 additions & 17 deletions src/definitions/modules/dropdown.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@
: [values];
$.each(values, function (index, value) {
if (module.get.item(value) === false) {
html = settings.templates.addition(module.add.variables(message.addResult, value));
html = settings.templates.addition(module.add.variables(message.addResult, settings.templates.escape(value, settings)));
$userChoice = $('<div />')
.html(html)
.attr('data-' + metadata.value, value)
Expand Down Expand Up @@ -710,7 +710,9 @@
module.remove.message();
}
if (settings.allowAdditions) {
module.add.userSuggestion(module.escape.htmlEntities(query));
module.add.userSuggestion(settings.preserveHTML
? module.escape.htmlEntities(query)
: query);
}
if (module.is.searchSelection() && module.can.show() && module.is.focusedOnSearch() && !module.is.empty()) {
module.show();
Expand Down Expand Up @@ -1040,8 +1042,11 @@
let tokens = pasteValue.split(settings.delimiter);
let notFoundTokens = [];
tokens.forEach(function (value) {
if (module.set.selected(module.escape.htmlEntities(value.trim()), null, false, true) === false) {
notFoundTokens.push(value.trim());
const valueTrimmed = settings.preserveHTML
? module.escape.htmlEntities(value.trim())
: value.trim();
if (module.set.selected(valueTrimmed, null, false, true) === false) {
notFoundTokens.push(valueTrimmed);
}
});
event.preventDefault();
Expand Down Expand Up @@ -1779,7 +1784,9 @@
return $module.data(metadata.placeholderText) || '';
},
text: function () {
return settings.preserveHTML ? $text.html() : $text.text();
return settings.preserveHTML
? $text.html()
: $text.text();
},
query: function () {
return String($search.val()).trim();
Expand Down Expand Up @@ -1948,7 +1955,7 @@
.find('option')
.each(function () {
let $option = $(this);
let name = $option.html();
let name = module.escape.assumeUnescapedAmpersand($option.html());
let disabled = $option.attr('disabled');
let value = $option.attr('value') !== undefined
? $option.attr('value')
Expand All @@ -1971,7 +1978,7 @@
values.push({
name: name,
value: value,
text: module.escape.htmlEntities(text, true),
text: text,
disabled: disabled,
});
}
Expand Down Expand Up @@ -2050,7 +2057,7 @@
return;
}
if (isMultiple) {
if ($.inArray(module.escape.htmlEntities(String(optionValue)), value.map(String).map(module.escape.htmlEntities)) !== -1) {
if ($.inArray(module.escape.htmlEntities(String(optionValue)), value.map(String)) !== -1) {
$selectedItem = $selectedItem
? $selectedItem.add($choice)
: $choice;
Expand Down Expand Up @@ -2780,7 +2787,7 @@
.attr('data-' + metadata.text, value)
.removeClass(className.filtered);
if (!settings.hideAdditions) {
html = settings.templates.addition(module.add.variables(message.addResult, value));
html = settings.templates.addition(module.add.variables(message.addResult, settings.templates.escape(value, settings)));
$addition
.html(html);
}
Expand Down Expand Up @@ -3562,12 +3569,8 @@

return text.replace(regExp.escape, '\\$&');
},
htmlEntities: function (string, forceAmpersand) {
forceAmpersand = typeof forceAmpersand === 'number' ? false : forceAmpersand;

const badChars = forceAmpersand
? /["&'<>]/g
: /["'<>]|&(?![\d#A-Za-z]{1,12};)/g;
htmlEntities: function (string) {
const badChars = /["&'<>]/g;
const escape = {
'"': '&quot;',
'&': '&amp;',
Expand All @@ -3578,6 +3581,16 @@

return String(string).replace(badChars, (chr) => escape[chr]);
},

// https://github.com/fomantic/Fomantic-UI/issues/2782
// https://jsfiddle.net/wdyjfvz0/
assumeUnescapedAmpersand: function (string) {
if (settings.preserveHTML) {
return string;
}

return string.replace('&amp;', '&');
},
},

setting: function (name, value) {
Expand Down Expand Up @@ -3789,7 +3802,7 @@

maxSelections: false, // When set to a number, limits the number of selections to this count
useLabels: true, // whether multiple select should filter currently active selections from choices
delimiter: ',', // when multiselect uses normal <input >, the values will be delimited with this character
delimiter: ',', // when multiselect uses normal <input>, the values will be delimited with this character

showOnFocus: false, // show the menu on focus
allowReselection: false, // whether current value should trigger callbacks when reselected
Expand Down Expand Up @@ -3980,7 +3993,7 @@
return string;
}

const badChars = /["'<>]|&(?![\d#A-Za-z]{1,12};)/g;
const badChars = /["&'<>]/g;
const escape = {
'"': '&quot;',
'&': '&amp;',
Expand Down