freeipa/install/ui/search.js
Petr Vobornik bbe672a2ae Facet expiration flag
Problem:

For performance reason a facet may cache the data in browser's memory. There should be a flag to indicate whether a facet has expired and should be refreshed. The expired flag could be set by these events:

 1) any update operation
 2) changing search filter in search facet
 3) switching page in a multi-paged search/association facet
 4) switching direct/indirect view in association facet
 5) facet expiration time
A facet should be able to use these methods to refresh itself:
 6) on demand: an expired facet should be refreshed when a user opens it.
 7) automatic: an open facet should automatically refresh itself when it expires.

Solution:

This patch solves cases: #2, #3, #5, #6. Case #4 works without any change. Case #1 will be solved later. Case #7 is deffered.

Default expiration timeout was set to 10 minutes.

In this patch are also updated facet.needs_update methods to reflect changes in containing facets.

https://fedorahosted.org/freeipa/ticket/2075
2012-03-29 13:39:37 +02:00

379 lines
10 KiB
JavaScript

/*jsl:import ipa.js */
/* Authors:
* Pavel Zuna <pzuna@redhat.com>
* Adam Young <ayoung@redhat.com>
* Endi S. Dewata <edewata@redhat.com>
* Petr Vobornik <pvoborni@redhat.com>
*
* Copyright (C) 2010 Red Hat
* see file 'COPYING' for use and warranty information
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/* REQUIRES: ipa.js */
IPA.search_facet = function(spec) {
spec = spec || {};
spec.name = spec.name || 'search';
spec.managed_entity = spec.managed_entity ? IPA.get_entity(spec.managed_entity) : spec.entity;
spec.disable_breadcrumb =
spec.disable_breadcrumb === undefined ? true : spec.disable_breadcrumb;
spec.disable_facet_tabs =
spec.disable_facet_tabs === undefined ? true : spec.disable_facet_tabs;
var that = IPA.table_facet(spec);
that.deleter_dialog = spec.deleter_dialog || IPA.search_deleter_dialog;
var init = function() {
that.init_table(that.managed_entity);
};
that.create_header = function(container) {
that.facet_create_header(container);
var div = $('<div/>', {
'class': 'right-aligned-facet-controls'
}).appendTo(that.controls);
div.append(IPA.create_network_spinner());
var filter_container = $('<div/>', {
'class': 'search-filter'
}).appendTo(div);
that.filter = $('<input/>', {
type: 'text',
name: 'filter'
}).appendTo(filter_container);
that.filter.keypress(function(e) {
/* if the key pressed is the enter key */
if (e.which == 13) {
that.find();
}
});
that.find_button = IPA.action_button({
name: 'find',
icon: 'search-icon',
click: function() {
that.find();
return false;
}
}).appendTo(filter_container);
that.refresh_button = IPA.action_button({
name: 'refresh',
href: 'refresh',
label: IPA.messages.buttons.refresh,
icon: 'reset-icon',
click: function() {
that.refresh();
return false;
}
}).appendTo(that.controls);
that.remove_button = IPA.action_button({
name: 'remove',
label: IPA.messages.buttons.remove,
icon: 'remove-icon',
click: function() {
if (!that.remove_button.hasClass('action-button-disabled')) {
that.show_remove_dialog();
}
return false;
}
}).appendTo(that.controls);
that.add_button = IPA.action_button({
name: 'add',
label: IPA.messages.buttons.add,
icon: 'add-icon',
click: function() {
if (!that.add_button.hasClass('action-button-disabled')) {
that.show_add_dialog();
}
return false;
}
}).appendTo(that.controls);
var self_service = IPA.nav.name === 'self-service';
if (self_service) {
that.remove_button.css('display', 'none');
that.add_button.css('display', 'none');
}
};
that.show = function() {
that.facet_show();
var filter = IPA.nav.get_state(that.entity.name+'-filter');
that.old_filter = filter || '';
that.old_pkeys = that.managed_entity.get_primary_key_prefix();
if (that.filter) {
that.filter.val(filter);
}
};
that.needs_update = function() {
if (that._needs_update !== undefined) return that._needs_update;
var needs_update = that.facet_needs_update();
//check if state changed
var pkeys = that.managed_entity.get_primary_key_prefix();
needs_update = needs_update || IPA.array_diff(pkeys, that.old_pkeys);
return needs_update;
};
that.show_add_dialog = function() {
var dialog = that.managed_entity.get_dialog('add');
dialog.open(that.container);
};
that.show_remove_dialog = function() {
var values = that.get_selected_values();
var title;
if (!values.length) {
title = IPA.messages.dialogs.remove_empty;
alert(title);
return;
}
var dialog = that.managed_entity.get_dialog('remove');
if (!dialog) {
dialog = that.deleter_dialog();
}
dialog.entity_name = that.managed_entity.name;
dialog.entity = that.managed_entity;
dialog.facet = that;
title = IPA.messages.dialogs.remove_title;
var label = that.managed_entity.metadata.label;
dialog.title = title.replace('${entity}', label);
dialog.set_values(values);
dialog.open(that.container);
};
that.find = function() {
var filter = that.filter.val();
var old_filter = IPA.nav.get_state(that.managed_entity.name+'-filter');
var state = {};
state[that.managed_entity.name + '-filter'] = filter;
if (filter !== old_filter) that.set_expired_flag();
IPA.nav.push_state(state);
};
that.get_search_command_name = function() {
var name = that.managed_entity.name + '_find';
if (that.pagination && !that.search_all_entries) {
name += '_pkeys';
}
return name;
};
that.create_refresh_command = function() {
var filter = that.managed_entity.get_primary_key_prefix();
filter.push(IPA.nav.get_state(that.managed_entity.name+'-filter'));
var command = IPA.command({
name: that.get_search_command_name(),
entity: that.managed_entity.name,
method: 'find',
args: filter,
options: {
all: that.search_all_attributes
}
});
if (that.pagination) {
if (!that.search_all_entries) command.set_option('pkey_only', true);
command.set_option('sizelimit', 0);
}
return command;
};
that.refresh = function() {
var command = that.create_refresh_command();
command.on_success = function(data, text_status, xhr) {
that.filter.focus();
that.load(data);
that.show_content();
};
command.on_error = function(xhr, text_status, error_thrown) {
that.report_error(error_thrown);
};
command.execute();
};
that.clear = function() {
if (that.needs_clear()) {
that.table.clear();
}
};
that.needs_clear = function() {
var clear = false;
var filter = IPA.nav.get_state(that.entity.name+'-filter') || '';
clear = that.old_filter !== '' || that.old_filter !== filter;
var pkeys = that.managed_entity.get_primary_key_prefix();
clear = clear || IPA.array_diff(pkeys, that.old_pkeys);
return clear;
};
init();
// methods that should be invoked by subclasses
that.search_facet_refresh = that.refresh;
that.search_facet_create_refresh_command = that.create_refresh_command;
return that;
};
IPA.search_deleter_dialog = function(spec) {
spec = spec || {};
var that = IPA.deleter_dialog(spec);
that.create_command = function() {
var batch = IPA.batch_command({
error_message: IPA.messages.search.partial_delete
});
var pkeys = that.entity.get_primary_key_prefix();
for (var i=0; i<that.values.length; i++) {
var command = IPA.command({
entity: that.entity.name,
method: 'del'
});
for (var j=0; j<pkeys.length; j++) {
command.add_arg(pkeys[j]);
}
var value = that.values[i];
if (value instanceof Object) {
for (var key in value) {
if (value.hasOwnProperty(key)) {
if (key === 'pkey'){
command.add_arg(value[key]);
} else {
command.set_option(key, value[key]);
}
}
}
} else {
command.add_arg(value);
}
batch.add_command(command);
}
return batch;
};
that.execute = function() {
var batch = that.create_command();
batch.on_success = function() {
that.facet.refresh();
that.close();
};
batch.on_error = function() {
that.facet.refresh();
that.close();
};
batch.execute();
};
that.search_deleter_dialog_create_command = that.create_command;
return that;
};
/*TODO. this has much copied code from above. Refactor the search_facet
To either be nested or not nested. */
IPA.nested_search_facet = function(spec) {
spec = spec || {};
spec.managed_entity = IPA.get_entity(spec.nested_entity);
spec.disable_breadcrumb = false;
spec.disable_facet_tabs = false;
var that = IPA.search_facet(spec);
that.show = function() {
that.facet_show();
that.header.set_pkey(
IPA.nav.get_state(IPA.current_entity.name+'-pkey'));
var filter = IPA.nav.get_state(that.managed_entity.name+'-filter');
that.old_filter = filter || '';
that.old_pkeys = that.managed_entity.get_primary_key_prefix();
if (that.filter) {
that.filter.val(filter);
}
};
that.refresh = function() {
var pkey = IPA.nav.get_state(that.entity.name+'-pkey');
if ((!pkey) && (that.entity.redirect_facet)) {
that.redirect();
return;
}
that.search_facet_refresh();
};
return that;
};