pmg-gui/js/QuarantineList.js
Thomas Lamprecht 0bd9ee2261 fix #3164: allow one to display all quarantined spam mails
If the API call returned more than one pmail entry, inject an "all"
entry which, if selected, drops the user parameter and loads the
quarantine mails of all users from the backend.

The webinterface has only some issues regarding deselection (all in
the grid header or if we need to deselect due to the search filtering
out some elements) - for that the underlying issue was found and a
widget toolkit patch was provided.

The rest seems now pretty performant, albeit more than a few 100k
mails may become a problem here. But, in such big setups the mail
admin won't tinker to much whith the users mail anyway, if they are
even alowed to do so depending on their jurisdictions privacy laws
and companies privacy policy.

So, basically this is more for evaluation or for smaller setups but
got quite often requested, and as there's not more data
exposed/returned then already available I see no real argument
against it.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-03-22 09:50:24 +01:00

374 lines
8.5 KiB
JavaScript

Ext.define('PMG.QuarantineList', {
extend: 'Ext.grid.GridPanel',
xtype: 'pmgQuarantineList',
emptyText: gettext('No E-Mail address selected'),
viewConfig: {
deferEmptyText: false,
},
config: {
emailSelection: false,
notFoundText: gettext('No data in database'),
},
statics: {
from: 0,
to: 0,
},
allowPositionSave: false,
controller: {
xclass: 'Ext.app.ViewController',
init: function(view) {
let me = this;
if (PMG.view === 'quarantineview') {
view.emailSelection = false;
me.setEmptyText();
}
let emailCombobox = me.lookupReference('email');
emailCombobox.setVisible(view.emailSelection);
emailCombobox.setDisabled(!view.emailSelection);
let from;
if (PMG.QuarantineList.from !== 0) {
from = new Date(PMG.QuarantineList.from * 1000);
} else {
from = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
}
let to;
if (PMG.QuarantineList.to !== 0) {
to = new Date(PMG.QuarantineList.to * 1000);
} else {
to = new Date();
}
// we to this to trigger the change event of those fields
me.lookupReference('from').setValue(from);
me.lookupReference('to').setValue(to);
Proxmox.Utils.monStoreErrors(view.getView(), view.getStore());
me.load(function() {
if (view.cselect) {
view.setSelection(view.getStore().getById(view.cselect));
}
});
},
// ExtJS cannot dynamically change the emptyText on grids, so implement ourself
setEmptyText: function(emptyText) {
let me = this;
let view = me.getView();
let tableview = view.getView();
tableview.emptyText = `<div class="x-grid-empty">${emptyText || view.notFoundText}</div>`;
},
load: function(callback) {
let me = this;
me.allowPositionSave = false;
let view = me.getView();
let store = view.getStore();
if (view.emailSelection) {
if (!me.lookupReference('email').getSelection()) {
return; // if the combobox has no selection we do not reload
}
me.setEmptyText();
}
// deselect all first, else ExtJS does some funky O(n^3) comparissions as it tries
// to keep the selection, but we do not care for that on a new load anyway
view.getSelectionModel().deselectAll();
store.load(function() {
if (me.savedPosition !== undefined) {
if (store.getCount() - 1 < me.savedPosition) {
me.savedPosition = store.getCount() - 1;
}
view.setSelection(store.getAt(me.savedPosition));
} else {
view.setSelection();
}
if (Ext.isFunction(callback)) {
callback();
}
me.allowPositionSave = true;
});
},
setFrom: function(from) {
let view = this.getView();
let params = view.getStore().getProxy().getExtraParams();
params.starttime = from;
PMG.QuarantineList.from = from;
view.getStore().getProxy().setExtraParams(params);
},
setTo: function(to) {
let end_of_to = to + 24*60*60; // we want the end of the day
let view = this.getView();
let params = view.getStore().getProxy().getExtraParams();
params.endtime = end_of_to;
PMG.QuarantineList.to = to; // we save the start of the day here
view.getStore().getProxy().setExtraParams(params);
},
setUser: function(user) {
let view = this.getView();
let params = view.getStore().getProxy().getExtraParams();
if (user === null) {
delete params.pmail;
} else {
params.pmail = user;
}
view.getStore().getProxy().setExtraParams(params);
view.user = user;
},
changeTime: function(field, value) {
let me = this;
me.allowPositionSave = false;
me.savedPosition = undefined;
if (!value) {
return;
}
let val = value.getTime() / 1000;
let combobox = me.lookupReference('email');
let params = combobox.getStore().getProxy().getExtraParams();
let to = me.lookupReference('to');
let from = me.lookupReference('from');
if (field.name === 'from') {
me.setFrom(val);
params.starttime = val;
to.setMinValue(value);
} else if (field.name === 'to') {
me.setTo(val);
params.endtime = val + 24*60*60;
from.setMaxValue(value);
} else {
return;
}
combobox.getStore().getProxy().setExtraParams(params);
combobox.getStore().load();
me.load();
},
resetEmail: function() {
let me = this;
let view = me.getView();
if (view.emailSelection) {
me.setUser(undefined);
}
},
changeEmail: function(tb, value) {
let me = this;
me.savedPosition = undefined;
me.allowPositionSave = false;
if (value === 'all') {
me.setUser(null);
} else {
me.setUser(value);
}
me.load();
},
savePosition: function(grid, selected, eopts) {
let me = this;
if (!me.allowPositionSave) {
return;
}
if (!selected.length) {
me.savedPosition = undefined;
return;
}
let view = me.getView();
let id = view.getStore().indexOf(selected[0]);
me.savedPosition = id;
},
doFilter: function(searchValue, store, sm) {
const selected = sm.getSelection();
const selectedRecordId = selected.length === 1 ? selected[0].id : null;
let clearSelectedMail = true;
let toDeselect = [];
store.filterBy(function(record) {
let match = false;
Ext.each(['subject', 'from'], property => {
if (record.data[property] === null) {
return;
}
let v = record.data[property].toString();
if (v !== undefined) {
v = v.toLowerCase();
if (v.includes(searchValue)) {
match = true;
if (record.id === selectedRecordId) {
clearSelectedMail = false;
}
}
}
});
if (!match && sm.isSelected(record)) {
toDeselect.push(record);
}
return match;
});
if (toDeselect.length > 0) {
sm.deselect(toDeselect, true);
sm.maybeFireSelectionChange(true);
}
return selectedRecordId !== null && clearSelectedMail;
},
updateFilter: async function(field) {
let me = this;
let view = me.getView();
let store = view.getStore();
let sm = view.getSelectionModel();
let searchValue = field.getValue().toLowerCase();
// supress store event if not empty, let filterBy below trigger it to avoid glitches
store.clearFilter(searchValue.length > 0);
field.triggers.clear.setVisible(searchValue.length > 0);
if (searchValue.length === 0) {
me.setEmptyText();
return;
}
me.setEmptyText(gettext('No match found'));
let clearSelection = me.doFilter(searchValue, store, sm);
if (clearSelection) {
view.setSelection();
}
},
control: {
'#': {
beforedestroy: 'resetEmail',
selectionchange: 'savePosition',
},
'combobox[reference=email]': {
change: 'changeEmail',
},
datefield: {
change: {
fn: 'changeTime',
},
},
},
},
features: [
{
ftype: 'grouping',
groupHeaderTpl: '{columnName}: {name} ({children.length})',
},
],
tbar: {
layout: {
type: 'vbox',
align: 'stretch',
},
defaults: {
margin: 2,
},
items: [
{
xtype: 'datefield',
name: 'from',
fieldLabel: gettext('Since'),
reference: 'from',
format: 'Y-m-d',
},
{
xtype: 'datefield',
name: 'to',
fieldLabel: gettext('Until'),
reference: 'to',
format: 'Y-m-d',
},
{
xtype: 'combobox',
hidden: true,
displayField: 'mail',
valueField: 'mail',
listConfig: {
emptyText:
'<div class="x-grid-empty">' +
gettext('No data in database') +
'</div>',
},
store: {
proxy: {
type: 'proxmox',
url: '/api2/json/quarantine/spamusers',
},
fields: [
{
name: 'mail',
renderer: Ext.htmlEncode,
},
],
listeners: {
load: function(store, records, successfull) {
if (successfull && records.length > 1) {
store.insert(0, { mail: 'all' });
}
},
},
},
queryMode: 'local',
editable: true,
typeAhead: true,
forceSelection: true,
autoSelect: true,
anyMatch: true,
selectOnFocus: true,
reference: 'email',
fieldLabel: 'E-Mail',
},
{
xtype: 'textfield',
name: 'filter',
fieldLabel: gettext('Search'),
emptyText: gettext('Subject, Sender'),
enableKeyEvents: true,
triggers: {
clear: {
cls: 'pmx-clear-trigger',
weight: -1,
hidden: true,
handler: function() {
let me = this;
me.setValue('');
// setValue does not results in a keyup event, so trigger manually
me.up('grid').getController().updateFilter(me);
},
},
},
listeners: {
buffer: 500,
keyup: 'updateFilter',
},
},
],
},
});