Extending facet's mechanism of gathering changes

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

Adding option to gathering changes for update from widgets, sections, details facet.

Changes are represented by update_info { fields [] ((field_info)), commands [] ((command_info))  } object.

* On calling get_update_info() method widget, section and facet returns update_info object which represents all changes in nested objects. Thus usually widgets are creating update_infos, their containers are merging them.
* This object can be then used in details facet update method. In order to use it command_mode = 'init' has to be set. Command mode was introduced to support backward compatibility.
* command_info consists of command and priority. Priority can be set to specify exact exectuting order of commands. It can be defined on facet level by setting widget's priority. When widgit is creating command_info it should pas its priority to it.

3 files changed, 286 insertions, 63 deletions

diff --git a/install/ui/details.js b/install/ui/details.js
index 93bb3e8a..d17e06f4 100644
--- a/install/ui/details.js
+++ b/install/ui/details.js
@@ -207,6 +207,20 @@ IPA.details_section = function(spec) {
         }
     };
 
+    that.get_update_info = function() {
+
+        var update_info = IPA.update_info_builder.new_update_info();
+
+        var fields = that.fields.values;
+        for(var i=0; i < fields.length; i++) {
+            update_info = IPA.update_info_builder.merge(
+                update_info,
+                fields[i].get_update_info());
+        }
+
+        return update_info;
+    };
+
     init();
 
     // methods that should be invoked by subclasses
@@ -280,6 +294,8 @@ IPA.details_facet = function(spec) {
     that.entity = spec.entity;
     that.pre_execute_hook = spec.pre_execute_hook;
     that.post_update_hook = spec.post_update_hook;
+    that.update_command_name = spec.update_command_name || 'mod';
+    that.command_mode = spec.command_mode || 'save'; // [save, info]
 
     that.label = spec.label || IPA.messages && IPA.messages.facets && IPA.messages.facets.details;
     that.facet_group = spec.facet_group || 'settings';
@@ -398,11 +414,7 @@ IPA.details_facet = function(spec) {
                 if (that.update_button.hasClass('action-button-disabled')) return false;
 
                 if (!that.validate()) {
-                    var dialog = IPA.message_dialog({
-                        title: IPA.messages.dialogs.validation_title,
-                        message: IPA.messages.dialogs.validation_message
-                    });
-                    dialog.open();
+                    that.show_validation_error();
                     return false;
                 }
 
@@ -590,6 +602,32 @@ IPA.details_facet = function(spec) {
         }
     };
 
+    that.save_as_update_info = function(only_dirty, require_value) {
+
+        var record = {};
+        var update_info = IPA.update_info_builder.new_update_info();
+        var sections = that.sections.values;
+
+        that.save(record);
+
+        for (var i=0; i<sections.length; i++) {
+            var section = sections[i];
+
+            var section_fields = section.fields.values;
+            for (var j=0; j<section_fields.length; j++) {
+                var field = section_fields[j];
+                if (only_dirty && !field.is_dirty()) continue;
+
+                var values = record[field.name];
+                if (require_value && !values) continue;
+
+                update_info.append_field(field, values);
+            }
+        }
+
+        return update_info;
+    };
+
     that.reset = function() {
         var sections = that.sections.values;
         for (var i=0; i<sections.length; i++) {
@@ -599,6 +637,7 @@ IPA.details_facet = function(spec) {
         that.enable_update(false);
     };
 
+
     that.validate = function() {
         var valid = true;
         var sections = that.sections.values;
@@ -609,81 +648,123 @@ IPA.details_facet = function(spec) {
         return valid;
     };
 
-    that.update = function(on_win, on_fail) {
 
-        function on_success(data, text_status, xhr) {
-            if (on_win)
-                on_win(data, text_status, xhr);
-            if (data.error)
-                return;
+    that.on_update_success = function(data, text_status, xhr) {
 
-            if (that.post_update_hook) {
-                that.post_update_hook(data, text_status);
-                return;
-            }
+        if (data.error)
+            return;
 
-            var result = data.result.result;
-            that.load(result);
+        if (that.post_update_hook) {
+            that.post_update_hook(data, text_status);
+            return;
         }
 
-        function on_error(xhr, text_status, error_thrown) {
-            if (on_fail)
-                on_fail(xhr, text_status, error_thrown);
+        var result = data.result.result;
+        that.load(result);
+    };
+
+    that.on_update_error = function(xhr, text_status, error_thrown) {
+    };
+
+    that.add_fields_to_command = function(update_info, command) {
+
+        for (var i=0; i < update_info.fields.length; i++) {
+            var field_info = update_info.fields[i];
+            var values = field_info.field.save();
+            IPA.command_builder.add_field_option(
+                command,
+                field_info.field,
+                values);
         }
+    };
 
-        var args = that.get_primary_key();
+    that.create_fields_update_command = function(update_info, on_win, on_fail) {
 
+        var args = that.get_primary_key();
         var command = IPA.command({
             entity: that.entity.name,
-            method: 'mod',
+            method: that.update_command_name,
             args: args,
             options: {
                 all: true,
                 rights: true
             },
-            on_success: on_success,
-            on_error: on_error
+            on_success: on_win,
+            on_error: on_fail
         });
 
-        var record = {};
-        that.save(record);
+        //set command options
+        that.add_fields_to_command(update_info, command);
 
-        var sections = that.sections.values;
-        for (var i=0; i<sections.length; i++) {
-            var section = sections[i];
+        return command;
+    };
 
-            var section_fields = section.fields.values;
-            for (var j=0; j<section_fields.length; j++) {
-                var field = section_fields[j];
-                if (!field.is_dirty()) continue;
+    that.create_batch_update_command = function(update_info, on_win, on_fail) {
 
-                var values = record[field.name];
-                if (!values) continue;
-
-                var metadata = field.metadata;
-                if (metadata) {
-                    if (metadata.primary_key) continue;
-                    if (values.length === 1) {
-                        command.set_option(field.name, values[0]);
-                    } else if (field.join) {
-                        command.set_option(field.name, values.join(','));
-                    } else {
-                        command.set_option(field.name, values);
-                    }
-                } else {
-                    if (values.length) {
-                        command.add_option('setattr', field.name+'='+values[0]);
-                    } else {
-                        command.add_option('setattr', field.name+'=');
-                    }
-                    for (var k=1; k<values.length; k++) {
-                        command.add_option('addattr', field.name+'='+values[k]);
-                    }
-                }
-            }
+        var batch = IPA.batch_command({
+            'name': that.entity.name + '_details_update',
+            'on_success': on_win,
+            'on_error': on_fail
+        });
+
+        var new_update_info = IPA.update_info_builder.copy(update_info);
+
+        if (update_info.fields.length > 0) {
+            new_update_info.append_command(
+                that.create_fields_update_command(update_info),
+                IPA.config.default_priority);
         }
 
-        //alert(JSON.stringify(command.to_json()));
+        new_update_info.commands.sort(function(a, b) {
+            return a.priority - b.priority;
+        });
+
+        for (var i=0; i < new_update_info.commands.length; i++) {
+            batch.add_command(new_update_info.commands[i].command);
+        }
+
+        return batch;
+    };
+
+    that.show_validation_error = function() {
+        var dialog = IPA.message_dialog({
+            title: IPA.messages.dialogs.validation_title,
+            message: IPA.messages.dialogs.validation_message
+        });
+        dialog.open();
+    };
+
+    that.update = function(on_win, on_fail) {
+
+        var on_success = function(data, text_status, xhr) {
+            that.on_update_success(data, text_status, xhr);
+            if (on_win) on_win.call(this, data, text_status, xhr);
+        };
+
+        var on_error = function(xhr, text_status, error_thrown) {
+            that.on_update_error(xhr, text_status, error_thrown);
+            if (on_fail) on_fail.call(this, xhr, text_status, error_thrown);
+        };
+
+        var command, update_info;
+
+        if(that.command_mode === 'info') {
+            update_info = that.get_update_info();
+        } else {
+            update_info = that.save_as_update_info(true, true);
+        }
+
+        if (update_info.commands.length <= 0) {
+            //normal command
+            command = that.create_fields_update_command(update_info,
+                                                        on_success,
+                                                        on_error);
+        } else {
+            //batch command
+            command = that.create_batch_update_command(update_info,
+                                                        on_success,
+                                                        on_error);
+        }
 
         if (that.pre_execute_hook){
             that.pre_execute_hook(command);
@@ -720,7 +801,7 @@ IPA.details_facet = function(spec) {
 
         command.on_error = that.on_error;
 
-        if (that.pre_execute_hook){
+        if (that.pre_execute_hook) {
             that.pre_execute_hook(command);
         }
 
@@ -736,6 +817,22 @@ IPA.details_facet = function(spec) {
         }
     };
 
+    that.get_update_info = function() {
+
+        var update_info = IPA.update_info_builder.new_update_info();
+
+        for (var i = 0; i < that.sections.length; i++) {
+            var section = that.sections.values[i];
+            if(section.get_update_info) {
+                update_info = IPA.update_info_builder.merge(
+                    update_info,
+                    section.get_update_info());
+            }
+        }
+
+        return update_info;
+    };
+
     that.add_sections(spec.sections);
 
     that.details_facet_create_content = that.create_content;
@@ -744,3 +841,112 @@ IPA.details_facet = function(spec) {
     return that;
 };
 
+IPA.update_info = function(spec) {
+
+    var that = {};
+
+    that.fields = spec.fields || [];
+    that.commands = spec.commands || [];
+
+    that.append_field = function(field, value) {
+        that.fields.push(IPA.update_info_builder.new_field_info(field, value));
+    };
+
+    that.append_command = function (command, priority) {
+        that.commands.push(IPA.update_info_builder.new_command_info(command,
+                                                                    priority));
+    };
+
+    return that;
+};
+
+IPA.command_info = function(spec) {
+
+    var that = {};
+
+    that.command = spec.command;
+    that.priority = spec.priority || IPA.config.default_priority;
+
+    return that;
+};
+
+IPA.field_info = function(spec) {
+
+    var that = {};
+
+    that.field = spec.field;
+    that.value = spec.value;
+
+    return that;
+};
+
+IPA.update_info_builder = function() {
+
+    var that = {};
+
+    that.new_update_info = function (fields, commands) {
+        return IPA.update_info({
+            fields: fields,
+            commands: commands
+        });
+    };
+
+    that.new_field_info = function(field, value) {
+        return IPA.field_info({
+            field: field,
+            value: value
+        });
+    };
+
+    that.new_command_info = function(command, priority) {
+        return IPA.command_info({
+            command: command,
+            priority: priority
+        });
+    };
+
+    that.merge = function(a, b) {
+        return that.new_update_info(
+            a.fields.concat(b.fields),
+            a.commands.concat(b.commands));
+    };
+
+    that.copy = function(original) {
+        return that.new_update_info(
+            original.fields.concat([]),
+            original.commands.concat([]));
+    };
+
+    return that;
+}();
+
+IPA.command_builder = function() {
+
+    var that = {};
+
+    that.add_field_option = function(command, field, values) {
+        if (!field || !values) return;
+
+        if (field.metadata) {
+            if (field.metadata.primary_key) return;
+            if (values.length === 1) {
+                command.set_option(field.name, values[0]);
+            } else if (field.join) {
+                command.set_option(field.name, values.join(','));
+            } else {
+                command.set_option(field.name, values);
+            }
+        } else {
+            if (values.length) {
+                command.add_option('setattr', field.name+'='+values[0]);
+            } else {
+                command.add_option('setattr', field.name+'=');
+            }
+            for (var k=1; k<values.length; k++) {
+                command.add_option('addattr', field.name+'='+values[k]);
+            }
+        }
+    };
+
+    return that;
+}();
diff --git a/install/ui/ipa.js b/install/ui/ipa.js
index c0aa98b9..4dd627ff 100644
--- a/install/ui/ipa.js
+++ b/install/ui/ipa.js
@@ -204,14 +204,14 @@ var IPA = function() {
                 that.add_entity(entity);
 
             } catch (e) {
-                if (e.expected){
+                if (e.expected) {
                     /*expected exceptions thrown by builder just mean that
                       entities are not to be registered. */
                     return null;
                 }
-                if (e.message){
+                if (e.message) {
                     alert(e.message);
-                }else{
+                } else {
                     alert(e);
                 }
                 return null;
@@ -1086,3 +1086,7 @@ IPA.error_list = function() {
     that.clear();
     return that;
 };
+
+IPA.config = {
+    default_priority: 500
+};
diff --git a/install/ui/widget.js b/install/ui/widget.js
index fb87c899..c3260659 100644
--- a/install/ui/widget.js
+++ b/install/ui/widget.js
@@ -59,6 +59,8 @@ IPA.widget = function(spec) {
 
     that.metadata = spec.metadata;
 
+    that.priority = spec.priority;
+
     that.values = [];
     that.dirty = false;
     that.valid = true;
@@ -290,6 +292,17 @@ IPA.widget = function(spec) {
     that.update = function() {
     };
 
+    that.get_update_info = function() {
+
+        var update_info = IPA.update_info_builder.new_update_info();
+        if(that.is_dirty()) {
+            update_info.fields.push(IPA.update_info_builder.new_field_info(
+                that,
+                that.save()));
+        }
+        return update_info;
+    };
+
     /**
      * This function saves the values entered in the UI.
      * It returns the values in an array, or null if
@@ -2140,4 +2153,4 @@ IPA.html_util = function() {
     };
 
     return that;
-}();
+}();
\ No newline at end of file