Refactored action list and control buttons to use shared list of actions

This is a first step for implementing action panels which will also use the shared list of actions.

This effor changes the way how action list and control buttons are defined. First all actions are defined on facet level - attribute 'actions' in spec file. Implementation of action list widget is not specified on facet level. It is left in facet header. A list of action names used in action list can be now specified in facet spec in 'header_actions' attribute.
Control buttons use similar concept. Facet by default is using control_buttons_widget. Details and search facet are defining their own default actions (refresh/add/remove/update/reset). Additional buttons can be defined as array of action names on facet level in control_buttons attribute.

state_evaluators and state_listeners were united. They are called state_evaluators but they uses state_listener concept, they are attached to an event. For former state_evaluator the event is post_load. They are defined in spec in state attribute. State object purpose is to aggregate states from all state evaluators. It offers changed event to which can other objects subscribe. It also has summary evaluator which evaluation conditions.  Summary evaluator creates summary status with human readable description. It can be used by facet header.

https://fedorahosted.org/freeipa/ticket/2248

1 files changed, 368 insertions, 179 deletions

diff --git a/install/ui/facet.js b/install/ui/facet.js
index 31a9df73..ef8a0624 100644
--- a/install/ui/facet.js
+++ b/install/ui/facet.js
@@ -28,6 +28,8 @@
 IPA.facet = function(spec, no_init) {
 
     spec = spec || {};
+    spec.state = spec.state || {};
+    $.extend(spec.state, { factory: IPA.state });
 
     var that = {};
 
@@ -42,7 +44,10 @@ IPA.facet = function(spec, no_init) {
     that.disable_breadcrumb = spec.disable_breadcrumb;
     that.disable_facet_tabs = spec.disable_facet_tabs;
 
-    that.action_list = spec.action_list;
+    that.action_state = IPA.build(spec.state);
+    that.actions = IPA.build({ actions: spec.actions }, IPA.action_holder_builder);
+
+    that.header_actions = spec.header_actions;
     that.header = spec.header || IPA.facet_header({ facet: that });
 
     that._needs_update = spec.needs_update;
@@ -299,16 +304,17 @@ IPA.facet = function(spec, no_init) {
 
     that.init_facet = function() {
 
+        that.action_state.init(that);
+        that.actions.init(that);
+        that.header.init();
+
         var buttons_spec = {
             factory: IPA.control_buttons_widget,
             name: 'control-buttons',
-            'class': 'control-buttons'
+            'class': 'control-buttons',
+            buttons: spec.control_buttons
         };
 
-        if (spec.control_buttons) {
-            $.extend(buttons_spec, spec.control_buttons);
-        }
-
         that.control_buttons = IPA.build(buttons_spec);
         that.control_buttons.init(that);
     };
@@ -335,9 +341,9 @@ IPA.facet_header = function(spec) {
 
     that.facet = spec.facet;
 
-    var init = function() {
+    that.init = function() {
 
-        if (that.facet.action_list) {
+        if (that.facet.header_actions) {
 
             var widget_builder = IPA.widget_builder({
                 widget_options: {
@@ -345,10 +351,17 @@ IPA.facet_header = function(spec) {
                 }
             });
 
-            that.action_list = widget_builder.build_widget(that.facet.action_list);
-            that.action_list.init();
+            var widget = {
+                factory: IPA.action_list_widget,
+                actions: that.facet.header_actions
+            };
+
+            that.action_list = widget_builder.build_widget(widget);
+            that.action_list.init(that.facet);
         }
 
+        that.facet.action_state.changed.attach(that.update_summary);
+
         that.title_widget = IPA.facet_title();
     };
 
@@ -587,17 +600,15 @@ IPA.facet_header = function(spec) {
                 }
             }
         }
+    };
 
-        if (that.action_list) {
-            that.action_list.update(result);
-
-            var state = that.action_list.state;
-            var icon_tooltip = that.action_list.state_evaluator.get_description();
-            if (state.length > 0) {
-                var css_class = state.join(' ');
-                that.title_widget.set_class(css_class);
-                that.title_widget.set_icon_tooltip(icon_tooltip);
-            }
+    that.update_summary = function() {
+        var summary = that.facet.action_state.summary();
+
+        if (summary.state.length > 0) {
+            var css_class = summary.state.join(' ');
+            that.title_widget.set_class(css_class);
+            that.title_widget.set_icon_tooltip(summary.description);
         }
 
         that.adjust_elements();
@@ -645,8 +656,6 @@ IPA.facet_header = function(spec) {
         that.load();
     };
 
-    init();
-
     return that;
 };
 
@@ -801,7 +810,7 @@ IPA.table_facet = function(spec, no_init) {
 
         that.table.pagination_control.css('visibility', 'visible');
 
-        that.post_load.notify();
+        that.post_load.notify([data], that);
         that.clear_expired_flag();
     };
 
@@ -1245,19 +1254,79 @@ IPA.action = function(spec) {
 
     that.name = spec.name;
     that.label = spec.label;
+
+    that.enabled = spec.enabled !== undefined ? spec.enabled : true;
     that.enable_cond = spec.enable_cond || [];
     that.disable_cond = spec.disable_cond || [];
+    that.enabled_changed = IPA.observer();
+
+    that.visible = spec.visible !== undefined ? spec.visible : true;
+    that.show_cond = spec.show_cond || [];
+    that.hide_cond = spec.hide_cond || [];
+    that.visible_changed = IPA.observer();
+
     that.handler = spec.handler;
-    that.needs_confirm = spec.needs_confirm !== undefined ? spec.needs_confirm : true;
+
+    that.needs_confirm = spec.needs_confirm !== undefined ? spec.needs_confirm : false;
     that.confirm_msg = spec.confirm_msg || IPA.messages.actions.confirm;
 
-    that.execute = function(facet, on_success, on_error) {
+
+    that.execute_action = function(facet, on_success, on_error) {
 
         if (that.handler) {
             that.handler(facet, on_success, on_error);
         }
     };
 
+    that.execute = function(facet, on_success, on_error) {
+
+        if (!that.enabled || !that.visible) return;
+
+        if (that.needs_confirm) {
+
+            var confirmed = false;
+
+            if (that.confirm_dialog) {
+
+                var dialog = IPA.build(that.confirm_dialog);
+                confirmed = dialog.confirm(that.facet);
+            } else {
+                var msg = that.get_confirm_message();
+                confirmed = IPA.confirm(msg);
+            }
+
+            if (!confirmed) return;
+        }
+
+        that.execute_action(facet, on_success, on_error);
+    };
+
+    that.get_confirm_message = function() {
+        return that.confirm_msg;
+    };
+
+    that.set_enabled = function(enabled) {
+
+        var old = that.enabled;
+
+        that.enabled = enabled;
+
+        if (old !== that.enabled) {
+            that.enabled_changed.notify([that.enabled], that);
+        }
+    };
+
+    that.set_visible = function(visible) {
+
+        var old = that.visible;
+
+        that.visible = visible;
+
+        if (old !== that.visible) {
+            that.visible_changed.notify([that.visible], that);
+        }
+    };
+
     return that;
 };
 
@@ -1269,32 +1338,189 @@ IPA.action_builder = function(spec) {
     return that;
 };
 
-IPA.state_evaluator = function(spec) {
+
+IPA.action_holder = function(spec) {
 
     spec = spec || {};
 
     var that = {};
 
-    that.evaluate = function() {
-        that.state = [];
-        return that.state;
+    that.actions = $.ordered_map();
+
+    that.init = function(facet) {
+
+        var i, action, actions;
+
+        that.facet = facet;
+        actions = IPA.build(spec.actions, IPA.action_builder) || [];
+
+        for (i=0; i<actions.length; i++) {
+            action = actions[i];
+            that.actions.put(action.name, action);
+        }
+
+        that.facet.action_state.changed.attach(that.state_changed);
+        that.facet.post_load.attach(that.on_load);
     };
 
-    that.get_description = function() {
-        return that.description || '';
+    that.state_changed = function(state) {
+
+        var actions, action, i, enabled, visible;
+
+        actions = that.actions.values;
+
+        for (i=0; i<actions.length; i++) {
+
+            action = actions[i];
+
+            enabled = IPA.eval_cond(action.enable_cond, action.disable_cond, state);
+            visible = IPA.eval_cond(action.show_cond, action.hide_cond, state);
+            action.set_enabled(enabled);
+            action.set_visible(visible);
+        }
+    };
+
+    that.get = function(name) {
+        return that.actions.get(name);
+    };
+
+    that.add = function(action) {
+        that.actions.put(action.name, action);
+    };
+
+    that.on_load = function() {
+        var state = that.facet.action_state.get();
+        that.state_changed(state);
     };
 
     return that;
 };
 
-IPA.state_listener = function(spec) {
+IPA.action_holder_builder = function(spec) {
 
     spec = spec || {};
+    spec.factory = spec.factory || IPA.action_holder;
+    var that = IPA.builder(spec);
+    return that;
+};
+
+
+IPA.state = function(spec) {
+
+    spec = spec || {};
+    spec.summary_evaluator = spec.summary_evaluator || IPA.summary_evaluator;
 
     var that = {};
 
+    that.state = $.ordered_map();
+
+    //when state changes. Params: state, Context: this
+    that.changed = IPA.observer();
+
+    that.evaluators = IPA.build(spec.evaluators, IPA.state_evaluator_builder) || [];
+    that.summary_evaluator = IPA.build(spec.summary_evaluator);
+
+    that.summary_conditions = spec.summary_conditions || [];
+
+    that.init = function(facet) {
+
+        var i, evaluator;
+
+        that.facet = facet;
+
+        for (i=0; i<that.evaluators.length; i++) {
+            evaluator = that.evaluators[i];
+            evaluator.init(facet);
+            evaluator.changed.attach(that.on_eval_changed);
+        }
+    };
+
+    that.on_eval_changed = function() {
+
+        var evaluator = this;
+
+        that.state.put(evaluator.name, evaluator.state);
+
+        that.notify();
+    };
+
+    that.get = function() {
+
+        var state, i;
+
+        state = [];
+
+        var values = that.state.values;
+
+        for (i=0; i<values.length; i++) {
+            $.merge(state, values[i]);
+        }
+
+        return state;
+    };
+
+    that.summary = function() {
+
+        var summary = that.summary_evaluator.evaluate(that);
+        return summary;
+    };
+
+    that.notify = function(state) {
+
+        state = state || that.get();
+
+        that.changed.notify([state], that);
+    };
+
+    return that;
+};
+
+IPA.summary_evaluator = function(spec) {
+
+    spec = spec || {};
+
+    var that = {};
+
+    that.evaluate = function(state) {
+
+        var conds, cond, i, summary, state_a;
+
+        conds = state.summary_conditions;
+        state_a = state.get();
+
+        for (i=0; i<conds.length; i++) {
+            cond = conds[i];
+            if (IPA.eval_cond(cond.pos, cond.neg, state_a)) {
+                summary = {
+                    state: cond.state,
+                    description: cond.description
+                };
+                break;
+            }
+        }
+
+        summary = summary ||  {
+            state: state_a,
+            description: ''
+        };
+
+        return summary;
+    };
+
+    return that;
+};
+
+IPA.state_evaluator = function(spec) {
+
+    spec = spec || {};
+
+    var that = {};
+
+    that.name = spec.name || 'state_evaluator';
     that.event_name = spec.event;
-    that.state_changed = IPA.observer();
+
+    //when state changes. Params: state, Context: this
+    that.changed = IPA.observer();
     that.state = [];
 
     that.init = function(facet) {
@@ -1305,75 +1531,86 @@ IPA.state_listener = function(spec) {
     };
 
     that.on_event = function() {
-        that.state_changed.notify();
     };
 
-    that.get_description = function() {
-        return that.description || '';
+    that.notify_on_change = function(old_state) {
+
+        if (IPA.array_diff(that.state, old_state)) {
+            that.changed.notify([that.state], that);
+        }
     };
 
     return that;
 };
 
-IPA.state_listener_builder = function(spec) {
+IPA.state_evaluator_builder = function(spec) {
 
     spec = spec || {};
-    spec.factory = spec.factory || IPA.state_listener;
+    spec.factory = spec.factory || IPA.state_evaluator;
     var that = IPA.builder(spec);
     return that;
 };
 
-IPA.dirty_state_listener = function(spec) {
+IPA.dirty_state_evaluator = function(spec) {
 
     spec = spec || {};
 
     spec.event = spec.event || 'dirty_changed';
 
-    var that = IPA.state_listener(spec);
+    var that = IPA.state_evaluator(spec);
+    that.name = spec.name || 'dirty_state_evaluator';
 
     that.on_event = function(dirty) {
+
+        var old_state = that.state;
         that.state = [];
 
         if (dirty) {
             that.state.push('dirty');
         }
 
-        that.state_changed.notify();
+        that.notify_on_change(old_state);
     };
 
     return that;
 };
 
-IPA.selected_state_listener = function(spec) {
+IPA.selected_state_evaluator = function(spec) {
 
     spec = spec || {};
 
     spec.event = spec.event || 'select_changed';
 
-    var that = IPA.state_listener(spec);
+    var that = IPA.state_evaluator(spec);
+    that.name = spec.name || 'selected_state_evaluator';
 
     that.on_event = function(selected) {
+
+        var old_state = that.state;
         that.state = [];
 
         if (selected && selected.length > 0) {
             that.state.push('item-selected');
         }
 
-        that.state_changed.notify();
+        that.notify_on_change(old_state);
     };
 
     return that;
 };
 
-IPA.self_service_state_listener = function(spec) {
+IPA.self_service_state_evaluator = function(spec) {
 
     spec = spec || {};
 
     spec.event = spec.event || 'post_load';
 
-    var that = IPA.state_listener(spec);
+    var that = IPA.state_evaluator(spec);
+    that.name = spec.name || 'self_service_state_evaluator';
 
     that.on_event = function() {
+
+        var old_state = that.state;
         that.state = [];
 
         var self_service = IPA.nav.name === 'self-service';
@@ -1382,7 +1619,7 @@ IPA.self_service_state_listener = function(spec) {
             that.state.push('self-service');
         }
 
-        that.state_changed.notify();
+        that.notify_on_change(old_state);
     };
 
     return that;
@@ -1400,17 +1637,22 @@ IPA.action_button_widget = function(spec) {
     that.href = spec.href || that.name;
     that.icon = spec.icon;
 
-    that.needs_confirm = spec.needs_confirm !== undefined ? spec.needs_confirm : false;
-    that.confirm_msg = spec.confirm_msg || IPA.messages.actions.confirm;
-    that.confirm_dialog = spec.confirm_dialog;
+    that.action_name = spec.action || that.name;
 
-    that.action = IPA.build(spec.action, IPA.action_builder);
     that.enabled = spec.enabled !== undefined ? spec.enabled : true;
     that.visible = spec.visible !== undefined ? spec.visible : true;
 
     that.show_cond = spec.show_cond || [];
     that.hide_cond = spec.hide_cond || [];
 
+    that.init = function(facet) {
+
+        that.facet = facet;
+        that.action = that.facet.actions.get(that.action_name);
+        that.action.enabled_changed.attach(that.set_enabled);
+        that.action.visible_changed.attach(that.set_visible);
+    };
+
     that.create = function(container) {
 
         that.widget_create(container);
@@ -1426,42 +1668,15 @@ IPA.action_button_widget = function(spec) {
             }
         }).appendTo(container);
 
-        that.set_enabled(that.enabled);
-        that.set_visible(that.visible);
+        that.set_enabled(that.action.enabled);
+        that.set_visible(that.action.visible);
     };
 
     that.on_click = function() {
 
         if (!that.enabled) return;
 
-        if (that.needs_confirm) {
-
-            var confirmed = false;
-
-            if (that.confirm_dialog) {
-
-                var dialog = IPA.build(that.confirm_dialog);
-                confirmed = dialog.confirm(that.facet);
-            } else {
-                var msg = that.get_confirm_message();
-                confirmed = IPA.confirm(msg);
-            }
-
-            if (!confirmed) return;
-        }
-
-        that.execute_action();
-    };
-
-    that.get_confirm_message = function() {
-        return that.confirm_msg;
-    };
-
-    that.execute_action = function() {
-
-        if (that.action) {
-            that.action.execute(that.facet);
-        }
+        that.action.execute(that.facet);
     };
 
     that.set_enabled = function(enabled) {
@@ -1508,27 +1723,16 @@ IPA.control_buttons_widget = function(spec) {
     var that = IPA.widget(spec);
 
     that.buttons = IPA.build(spec.buttons, IPA.action_button_widget_builder) || [];
-    that.state_listeners = IPA.build(spec.state_listeners, IPA.state_listener_builder) || [];
-    that.state = [];
 
     that.init = function(facet) {
 
         var i;
 
-        for (i=0; i<that.state_listeners.length; i++) {
-
-            var listener = that.state_listeners[i];
-            listener.init(facet);
-            listener.state_changed.attach(that.on_state_change);
-        }
-
         for (i=0; i<that.buttons.length; i++) {
 
             var button = that.buttons[i];
-            button.facet = facet;
+            button.init(facet);
         }
-
-        that.on_state_change();
     };
 
     that.create = function(container) {
@@ -1544,36 +1748,6 @@ IPA.control_buttons_widget = function(spec) {
         }
     };
 
-    that.on_state_change = function() {
-
-        that.get_state();
-        that.reevaluate();
-    };
-
-    that.get_state = function() {
-
-        that.state = [];
-
-        for (var i=0; i<that.state_listeners.length; i++) {
-
-            var listener = that.state_listeners[i];
-            that.state.push.apply(that.state, listener.state);
-        }
-    };
-
-    that.reevaluate = function() {
-
-        for (var i=0; i<that.buttons.length; i++) {
-
-            var button = that.buttons[i];
-            var action = button.action;
-            var enabled = IPA.eval_cond(action.enable_cond, action.disable_cond, that.state);
-            var visible = IPA.eval_cond(button.show_cond, button.hide_cond, that.state);
-            button.set_enabled(enabled);
-            button.set_visible(visible);
-        }
-    };
-
     return that;
 };
 
@@ -1626,21 +1800,51 @@ IPA.action_list_widget = function(spec) {
 
     var that = IPA.composite_widget(spec);
 
-    that.actions = IPA.build(spec.actions, IPA.action_builder) || [];
-    that.state_evaluator = IPA.build(spec.state_evaluator);
-    that.state = [];
+    that.action_names = spec.actions || [];
+    that.actions = $.ordered_map();
+
+    that.init = function(facet) {
+
+        var options, actions, action, name, i;
+
+        that.facet = facet;
 
-    that.init = function() {
         that.action_select = that.widgets.get_widget('action');
         that.apply_button = that.widgets.get_widget('apply');
 
         that.action_select.value_changed.attach(that.on_action_change);
         that.apply_button.click = that.on_apply;
 
-        var options = [];
+        for (i=0; i<that.action_names.length; i++) {
+            name = that.action_names[i];
+            action = that.facet.actions.get(name);
+            that.add_action(action, true);
+        }
+
+        that.init_options();
+    };
+
+    that.add_action = function(action, batch) {
+        that.actions.put(action.name, action);
+        action.enabled_changed.attach(that.action_enabled_changed);
+        action.visible_changed.attach(that.action_visible_changed);
 
-        for (var i=0; i< that.actions.length; i++) {
-            var action = that.actions[i];
+        if(!batch) {
+            that.init_options();
+            that.recreate_options();
+            that.select_first_enabled();
+        }
+    };
+
+    that.init_options = function() {
+
+        var options, actions, action, i;
+
+        options = [];
+        actions = that.actions.values;
+
+        for (i=0; i< actions.length; i++) {
+            action = actions[i];
             options.push({
                 label: action.label,
                 value: action.name
@@ -1650,71 +1854,62 @@ IPA.action_list_widget = function(spec) {
         that.action_select.options = options;
     };
 
+    that.recreate_options = function() {
+
+        that.action_select.create_options();
+    };
+
     that.on_action_change = function() {
 
-        var selected = that.action_select.save()[0];
-        var action = that.get_action(selected);
-        var enabled = that.action_enabled(action);
-        that.apply_button.set_enabled(enabled);
+        var action = that.get_selected();
+        that.apply_button.set_enabled(action.enabled);
     };
 
     that.on_apply = function() {
-        var selected = that.action_select.save()[0];
-        var action = that.get_action(selected);
-        var enabled = that.action_enabled(action);
-        var facet = that.entity.get_facet();
 
-        if (enabled) {
-            action.execute(facet,
+        var action = that.get_selected();
+
+        if (action.enabled) {
+            action.execute(that.facet,
                            that.on_action_success,
                            that.on_action_error);
         }
     };
 
     that.on_action_success = function() {
-        var facet = that.entity.get_facet();
-        facet.refresh();
-    };
 
-    that.on_action_error = function() {
-        var facet = that.entity.get_facet();
-        facet.refresh();
+        that.facet.refresh();
     };
 
-    that.update = function(result) {
+    that.on_action_error = function() {
 
-        that.get_state(result);
-        var disabled = that.get_disabled();
-        that.action_select.enable_options();
-        that.action_select.disable_options(disabled);
-        that.select_first_enabled();
+        that.facet.refresh();
     };
 
-    that.get_state = function(result) {
+    that.action_enabled_changed = function(enabled) {
+        var action = this;
+        var selected_action = that.get_selected();
+        that.action_select.set_options_enabled(action.enabled, [action.name]);
 
-        if (that.state_evaluator) {
-            that.state = that.state_evaluator.evaluate(result);
+        if (!action.enabled && action === selected_action) {
+            that.select_first_enabled();
         }
     };
 
-    that.get_action = function(name) {
-
-        for (var i=0; i< that.actions.length; i++) {
-            var action = that.actions[i];
-            if (action.name === name) {
-                return action;
-            }
-        }
-        return null;
+    that.get_selected = function() {
+        var selected = that.action_select.save()[0];
+        var action = that.actions.get(selected);
+        return action;
     };
 
     that.get_disabled = function() {
 
         var disabled = [];
+        var actions = that.action.values;
 
-        for (var i=0; i< that.actions.length; i++) {
-            var action = that.actions[i];
-            if (!that.action_enabled(action)) {
+        for (var i=0; i< actions.length; i++) {
+            var action = actions[i];
+            if (!that.action.enabled) {
                 disabled.push(action.name);
             }
         }
@@ -1722,21 +1917,15 @@ IPA.action_list_widget = function(spec) {
         return disabled;
     };
 
-    that.action_enabled = function(action) {
-
-        var enabled = IPA.eval_cond(action.enable_cond,
-                                    action.disable_cond,
-                                    that.state);
-        return enabled;
-    };
-
     that.select_first_enabled = function() {
 
-        var first = that.actions[0].name;
+        var actions = that.actions.values;
+
+        var first = actions[0].name;
 
-        for (var i=0; i< that.actions.length; i++) {
-            var action = that.actions[i];
-            if (that.action_enabled(action)) {
+        for (var i=0; i< actions.length; i++) {
+            var action = actions[i];
+            if (action.enabled) {
                 first = action.name;
                 break;
             }