codex-storage
/
deluge
mirror of https://github.com/codex-storage/deluge.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[WebUI] Move HTML entity encoding to client 

We should not be mangling the torrent data in the JSON API since this
can have unintended consquences with names and filepaths that can be
edited. If we escape those symbols in the JSON API then the data no
longer matches that stored by core. Therefore shift the encoding to the
client and consider dealing separetely with these entities when the user
first adds a torrent.

* Created a modified htmlEncode in Deluge Formatter based on extjs
method that also encodes single quotes.
* Removed renderers in ListViews since only templates specified via tpl
are used and any render attribute specified was a no-op.
* Removed old buggy escapeHtml

Resolves: https://dev.deluge-torrent.org/ticket/3459
Ref: https://docs.sencha.com/extjs/6.5.3/modern/src/String.js.html#Ext.String-method-htmlEncode
Ref: https://docs.sencha.com/extjs/3.4.0/source/Format.html#Ext-util-Format-method-htmlEncode
This commit is contained in:
Calum Lind 2022-02-14 10:23:19 +00:00
parent a5503c0c60
commit 8ece036770
No known key found for this signature in database
GPG Key ID: 90597A687B836BA3
5 changed files with 165 additions and 179 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
deluge/ui/web/js/deluge-all/Deluge.js
View File

@ -25,11 +25,6 @@ Ext.state.Manager.setProvider(
// Add some additional functions to ext and setup some of the
// configurable parameters
Ext.apply(Ext, {
escapeHTML: function (text) {
text = String(text).replace('<', '&lt;').replace('>', '&gt;');
return text.replace('&', '&amp;');
},
isObjectEmpty: function (obj) {
for (var i in obj) {
return false;

301
deluge/ui/web/js/deluge-all/Formatters.js
View File

@ -15,7 +15,23 @@
* @version 1.3
* @singleton
*/
Deluge.Formatters = {
Deluge.Formatters = (function () {
var charToEntity = {
'&': '&amp;',
'>': '&gt;',
'<': '&lt;',
'"': '&quot;',
"'": '&#39;',
};
var charToEntityRegex = new RegExp(
'(' + Object.keys(charToEntity).join('|') + ')',
'g'
);
var htmlEncodeReplaceFn = function (match, capture) {
return charToEntity[capture];
};
/**
* Formats a date string in the date representation of the current locale,
* based on the systems timezone.
@ -24,154 +40,162 @@ Deluge.Formatters = {
* @return {String} a string in the date representation of the current locale
* or "" if seconds < 0.
*/
date: function (timestamp) {
function zeroPad(num, count) {
var numZeropad = num + '';
while (numZeropad.length < count) {
numZeropad = '0' + numZeropad;
return (Formatters = {
date: function (timestamp) {
function zeroPad(num, count) {
var numZeropad = num + '';
while (numZeropad.length < count) {
numZeropad = '0' + numZeropad;
}
return numZeropad;
}
return numZeropad;
}
timestamp = timestamp * 1000;
var date = new Date(timestamp);
return String.format(
'{0}/{1}/{2} {3}:{4}:{5}',
zeroPad(date.getDate(), 2),
zeroPad(date.getMonth() + 1, 2),
date.getFullYear(),
zeroPad(date.getHours(), 2),
zeroPad(date.getMinutes(), 2),
zeroPad(date.getSeconds(), 2)
);
},
timestamp = timestamp * 1000;
var date = new Date(timestamp);
return String.format(
'{0}/{1}/{2} {3}:{4}:{5}',
zeroPad(date.getDate(), 2),
zeroPad(date.getMonth() + 1, 2),
date.getFullYear(),
zeroPad(date.getHours(), 2),
zeroPad(date.getMinutes(), 2),
zeroPad(date.getSeconds(), 2)
);
},
/**
* Formats the bytes value into a string with KiB, MiB or GiB units.
*
* @param {Number} bytes the filesize in bytes
* @param {Boolean} showZero pass in true to displays 0 values
* @return {String} formatted string with KiB, MiB or GiB units.
*/
size: function (bytes, showZero) {
if (!bytes && !showZero) return '';
bytes = bytes / 1024.0;
/**
* Formats the bytes value into a string with KiB, MiB or GiB units.
*
* @param {Number} bytes the filesize in bytes
* @param {Boolean} showZero pass in true to displays 0 values
* @return {String} formatted string with KiB, MiB or GiB units.
*/
size: function (bytes, showZero) {
if (!bytes && !showZero) return '';
bytes = bytes / 1024.0;
if (bytes < 1024) {
return bytes.toFixed(1) + ' KiB';
} else {
bytes = bytes / 1024;
}
if (bytes < 1024) {
return bytes.toFixed(1) + ' MiB';
} else {
bytes = bytes / 1024;
}
return bytes.toFixed(1) + ' GiB';
},
/**
* Formats the bytes value into a string with K, M or G units.
*
* @param {Number} bytes the filesize in bytes
* @param {Boolean} showZero pass in true to displays 0 values
* @return {String} formatted string with K, M or G units.
*/
sizeShort: function (bytes, showZero) {
if (!bytes && !showZero) return '';
bytes = bytes / 1024.0;
if (bytes < 1024) {
return bytes.toFixed(1) + ' K';
} else {
bytes = bytes / 1024;
}
if (bytes < 1024) {
return bytes.toFixed(1) + ' M';
} else {
bytes = bytes / 1024;
}
return bytes.toFixed(1) + ' G';
},
/**
* Formats a string to display a transfer speed utilizing {@link #size}
*
* @param {Number} bytes the number of bytes per second
* @param {Boolean} showZero pass in true to displays 0 values
* @return {String} formatted string with KiB, MiB or GiB units.
*/
speed: function (bytes, showZero) {
return !bytes && !showZero ? '' : fsize(bytes, showZero) + '/s';
},
/**
* Formats a string to show time in a human readable form.
*
* @param {Number} time the number of seconds
* @return {String} a formatted time string. will return '' if seconds == 0
*/
timeRemaining: function (time) {
if (time <= 0) {
return '&infin;';
}
time = time.toFixed(0);
if (time < 60) {
return time + 's';
} else {
time = time / 60;
}
if (time < 60) {
var minutes = Math.floor(time);
var seconds = Math.round(60 * (time - minutes));
if (seconds > 0) {
return minutes + 'm ' + seconds + 's';
if (bytes < 1024) {
return bytes.toFixed(1) + ' KiB';
} else {
return minutes + 'm';
bytes = bytes / 1024;
}
} else {
time = time / 60;
}
if (time < 24) {
var hours = Math.floor(time);
var minutes = Math.round(60 * (time - hours));
if (minutes > 0) {
return hours + 'h ' + minutes + 'm';
if (bytes < 1024) {
return bytes.toFixed(1) + ' MiB';
} else {
return hours + 'h';
bytes = bytes / 1024;
}
} else {
time = time / 24;
}
var days = Math.floor(time);
var hours = Math.round(24 * (time - days));
if (hours > 0) {
return days + 'd ' + hours + 'h';
} else {
return days + 'd';
}
},
return bytes.toFixed(1) + ' GiB';
},
/**
* Simply returns the value untouched, for when no formatting is required.
*
* @param {Mixed} value the value to be displayed
* @return the untouched value.
*/
plain: function (value) {
return value;
},
/**
* Formats the bytes value into a string with K, M or G units.
*
* @param {Number} bytes the filesize in bytes
* @param {Boolean} showZero pass in true to displays 0 values
* @return {String} formatted string with K, M or G units.
*/
sizeShort: function (bytes, showZero) {
if (!bytes && !showZero) return '';
bytes = bytes / 1024.0;
cssClassEscape: function (value) {
return value.toLowerCase().replace('.', '_');
},
};
if (bytes < 1024) {
return bytes.toFixed(1) + ' K';
} else {
bytes = bytes / 1024;
}
if (bytes < 1024) {
return bytes.toFixed(1) + ' M';
} else {
bytes = bytes / 1024;
}
return bytes.toFixed(1) + ' G';
},
/**
* Formats a string to display a transfer speed utilizing {@link #size}
*
* @param {Number} bytes the number of bytes per second
* @param {Boolean} showZero pass in true to displays 0 values
* @return {String} formatted string with KiB, MiB or GiB units.
*/
speed: function (bytes, showZero) {
return !bytes && !showZero ? '' : fsize(bytes, showZero) + '/s';
},
/**
* Formats a string to show time in a human readable form.
*
* @param {Number} time the number of seconds
* @return {String} a formatted time string. will return '' if seconds == 0
*/
timeRemaining: function (time) {
if (time <= 0) {
return '&infin;';
}
time = time.toFixed(0);
if (time < 60) {
return time + 's';
} else {
time = time / 60;
}
if (time < 60) {
var minutes = Math.floor(time);
var seconds = Math.round(60 * (time - minutes));
if (seconds > 0) {
return minutes + 'm ' + seconds + 's';
} else {
return minutes + 'm';
}
} else {
time = time / 60;
}
if (time < 24) {
var hours = Math.floor(time);
var minutes = Math.round(60 * (time - hours));
if (minutes > 0) {
return hours + 'h ' + minutes + 'm';
} else {
return hours + 'h';
}
} else {
time = time / 24;
}
var days = Math.floor(time);
var hours = Math.round(24 * (time - days));
if (hours > 0) {
return days + 'd ' + hours + 'h';
} else {
return days + 'd';
}
},
/**
* Simply returns the value untouched, for when no formatting is required.
*
* @param {Mixed} value the value to be displayed
* @return the untouched value.
*/
plain: function (value) {
return value;
},
cssClassEscape: function (value) {
return value.toLowerCase().replace('.', '_');
},
htmlEncode: function (value) {
return !value
? value
: String(value).replace(charToEntityRegex, htmlEncodeReplaceFn);
},
});
})();
var fsize = Deluge.Formatters.size;
var fsize_short = Deluge.Formatters.sizeShort;
var fspeed = Deluge.Formatters.speed;
@ -179,3 +203,4 @@ var ftime = Deluge.Formatters.timeRemaining;
var fdate = Deluge.Formatters.date;
var fplain = Deluge.Formatters.plain;
Ext.util.Format.cssClassEscape = Deluge.Formatters.cssClassEscape;
Ext.util.Format.htmlEncode = Deluge.Formatters.htmlEncode;

15
deluge/ui/web/js/deluge-all/add/AddWindow.js
View File

@ -64,20 +64,6 @@ Deluge.add.AddWindow = Ext.extend(Deluge.add.Window, {
this.addButton(_('Cancel'), this.onCancelClick, this);
this.addButton(_('Add'), this.onAddClick, this);
function torrentRenderer(value, p, r) {
if (r.data['info_hash']) {
return String.format(
'<div class="x-deluge-add-torrent-name">{0}</div>',
value
);
} else {
return String.format(
'<div class="x-deluge-add-torrent-name-loading">{0}</div>',
value
);
}
}
this.list = new Ext.list.ListView({
store: new Ext.data.SimpleStore({
fields: [
@ -91,7 +77,6 @@ Deluge.add.AddWindow = Ext.extend(Deluge.add.Window, {
id: 'torrent',
width: 150,
sortable: true,
renderer: torrentRenderer,
dataIndex: 'text',
tpl: new Ext.XTemplate(
'<div class="x-deluge-add-torrent-name">{text:htmlEncode}</div>'

1
deluge/ui/web/js/deluge-all/preferences/PreferencesWindow.js
View File

@ -46,7 +46,6 @@ Deluge.preferences.PreferencesWindow = Ext.extend(Ext.Window, {
columns: [
{
id: 'name',
renderer: fplain,
dataIndex: 'name',
},
],

22
deluge/ui/web/json_api.py
View File

@ -13,7 +13,6 @@ import shutil
import tempfile
from base64 import b64encode
from types import FunctionType
from xml.sax.saxutils import escape as xml_escape
from twisted.internet import defer, reactor
from twisted.internet.defer import Deferred, DeferredList
@ -375,8 +374,6 @@ class WebApi(JSONComponent):
methods available from the core RPC.
"""
XSS_VULN_KEYS = ['name', 'message', 'comment', 'tracker_status', 'peers']
def __init__(self):
super().__init__('Web', depend=['SessionProxy'])
self.hostlist = HostList()
@ -581,7 +578,7 @@ class WebApi(JSONComponent):
paths = []
info = {}
for index, torrent_file in enumerate(files):
path = xml_escape(torrent_file['path'])
path = torrent_file['path']
paths.append(path)
torrent_file['progress'] = file_progress[index]
torrent_file['priority'] = file_priorities[index]
@ -618,25 +615,10 @@ class WebApi(JSONComponent):
file_tree.walk(walk)
d.callback(file_tree.get_tree())
def _on_torrent_status(self, torrent, d):
for key in self.XSS_VULN_KEYS:
try:
if key == 'peers':
for peer in torrent[key]:
peer['client'] = xml_escape(peer['client'])
else:
torrent[key] = xml_escape(torrent[key])
except KeyError:
pass
d.callback(torrent)
@export
def get_torrent_status(self, torrent_id, keys):
"""Get the status for a torrent, filtered by status keys."""
main_deferred = Deferred()
d = component.get('SessionProxy').get_torrent_status(torrent_id, keys)
d.addCallback(self._on_torrent_status, main_deferred)
return main_deferred
return component.get('SessionProxy').get_torrent_status(torrent_id, keys)
@export
def get_torrent_files(self, torrent_id):