[IMP] 7.0 add m2x options for view (#305)

web_m2x_options/README.rst

@@ -16,7 +16,7 @@ add some new display control options.
 The options provided include the possibility to remove "Create..." and/or
 "Create and Edit..." entries from many2one and many2many drop down lists. You
 can also change the default number of entries appearing in the drop-down, or
- prevent the dialog box poping in case of validation error occurring.
+prevent the dialog box popping in case of validation error occurring.
 
 If not specified, the module will avoid proposing any of the create options
 if the current user have no permission rights to create the related object.
@@ -99,13 +99,40 @@ To add these parameters go to Configuration -> Technical -> Parameters -> System
 - web_m2x_options.search_more: True
 
 
+ir.actions.act_window context options
+-------------------------------------
+
+The following options can be specified in the ``context`` field of an
+``ir.actions.act_window`` to provide the same functionality at the form level:
+
+``create`` *boolean* (Default: depends if user have create rights)
+
+  Whether to display the "Create..." entry in dropdown panels.
+
+``create_edit`` *boolean* (Default: depends if user have create rights)
+
+  Whether to display the "Create and Edit..." entry in dropdown panels.
+
+``m2o_dialog`` *boolean* (Default: depends if user have create rights)
+
+  Whether to display the many2one dialog in case of validation error.
+
+``limit`` *int* (Default: openerp default value is ``7``)
+
+  Number of displayed records in drop-down panels.
+
+``search_more`` *boolean*
+
+  Whether to always display the "Search More..." entry in dropdown panels.
+
+
 Example
 -------
 
 Your XML form view definition could contain::
 
     ...
-    <field name="partner_id" options="{'limit': 10, 'create': false, 'create_edit': false, 'search_more':true 'field_color':'state', 'colors':{'active':'green'}}"/>
+    <field name="partner_id" options="{'limit': 10, 'create': false, 'create_edit': false, 'search_more': true, 'field_color': 'state', 'colors': {'active':'green'}}"/>
     ...
 
 Note

web_m2x_options/__openerp__.py

@@ -2,7 +2,7 @@
 
 {
     "name": 'web_m2x_options',
-    "version": "0.1",
+    "version": "7.0.1.0.0",
     "description": """
 =====================================================
 Add new options for many2one and many2manytags field:
@@ -43,7 +43,8 @@ Thanks to:
     "js": [
         'static/src/js/form.js',
     ],
-    "author": "Tuxservices,Odoo Community Association (OCA)",
+    "author": "Tuxservices,initOS GmbH,Odoo Community Association (OCA)",
+    "license": "AGPL-3",
     "installable": True,
     "active": False,
 }

web_m2x_options/static/src/js/form.js

@@ -14,49 +14,69 @@ openerp.web_m2x_options = function (instance) {
                    'web_m2x_options.search_more',
                    'web_m2x_options.m2o_dialog',];
 
-    instance.web.form.FieldMany2One = instance.web.form.FieldMany2One.extend({
-
-        start: function() {
-            this._super.apply(this, arguments);
-            return this.get_options();
-        },
-
-        get_options: function() {
-            var self = this;
-            if (!_.isUndefined(this.view) && _.isUndefined(this.view.ir_options_loaded)) {
-            this.view.ir_options_loaded = $.Deferred();
-            this.view.ir_options = {};
+    var get_options = function(widget) {
+        if (!_.isUndefined(widget.view) && _.isUndefined(widget.view.ir_options_loaded)) {
+            widget.view.ir_options_loaded = $.Deferred();
+            widget.view.ir_options = {};
             (new instance.web.Model("ir.config_parameter"))
             .query(["key", "value"]).filter([['key', 'in', OPTIONS]])
             .all().then(function(records) {
                 _(records).each(function(record) {
-                    self.view.ir_options[record.key] = record.value;
+                    // don't overwrite from global parameters if already set from context or widget
+                    if (_.isUndefined(widget.view.ir_options[record.key])) {
+                        widget.view.ir_options[record.key] = record.value;
+                    }
                 });
-                self.view.ir_options_loaded.resolve();
+                widget.view.ir_options_loaded.resolve();
             });
-                return this.view.ir_options_loaded;
+            return widget.view.ir_options_loaded;
         }
+        // options from widget are only available here
+        _(OPTIONS).each(function(option) {
+            var p = option.indexOf('.');
+            if (p < 0) return;
+            var key = option.substring(p + 1); // w/o 'web_m2x_options' prefix
+            // ... hence set from context ...
+            if (!_.isUndefined(widget.view.dataset.context[key])) {
+                widget.view.ir_options[option] = widget.view.dataset.context[key];
+            }
+            // ... and (overwrite) from widget here ...
+            if (!_.isUndefined(widget.options[key])) {
+                widget.view.ir_options[option] = widget.options[key];
+            }
+            // ... but don't overwrite from global parameters above
+        });
         return $.when();
-        },
+    };
 
-        is_option_set: function(option) {
+    var is_option_set = function(option) {
         if (_.isUndefined(option)) {
-                return false
+            return false;
         }
-            var is_string = typeof option === 'string'
-            var is_bool = typeof option === 'boolean'
+        var is_string = typeof option === 'string';
+        var is_bool = typeof option === 'boolean';
         if (is_string) {
-                return option === 'true' || option === 'True'
+            return option === 'true' || option === 'True';
         } else if (is_bool) {
-                return option
+            return option;
         }
-            return false
+        return false;
+    };
+
+    instance.web.form.FieldMany2One = instance.web.form.FieldMany2One.extend({
+
+        start: function() {
+            this._super.apply(this, arguments);
+            return get_options(this);
         },
 
         show_error_displayer: function () {
-            if(this.is_option_set(this.options.m2o_dialog) ||
-               _.isUndefined(this.options.m2o_dialog) && this.is_option_set(this.view.ir_options['web_m2x_options.m2o_dialog']) ||
-               this.can_create && _.isUndefined(this.options.m2o_dialog) && _.isUndefined(this.view.ir_options['web_m2x_options.m2o_dialog'])) {
+            var allow_dialog = this.can_create;
+            if (!_.isUndefined(this.view.ir_options['web_m2x_options.m2o_dialog'])) {
+                allow_dialog = is_option_set(this.view.ir_options['web_m2x_options.m2o_dialog']);
+            }
+
+            if (allow_dialog) {
                 new instance.web.form.M2ODialog(this).open();
             }
         },
@@ -65,27 +85,28 @@ openerp.web_m2x_options = function (instance) {
             var Objects = new instance.web.Model(this.field.relation);
             var def = $.Deferred();
             var self = this;
-            // add options limit used to change number of selections record
-            // returned.
 
             if (_.isUndefined(this.view))
                     return this._super.apply(this, arguments);
+
+            var ctx = self.view.dataset.context;
+
+            // add options limit used to change number of selections record
+            // returned.
+
             if (!_.isUndefined(this.view.ir_options['web_m2x_options.limit'])) {
                 this.limit = parseInt(this.view.ir_options['web_m2x_options.limit']);
             }
 
-            if (typeof this.options.limit === 'number') {
-                this.limit = this.options.limit;
-            }
-
             // add options search_more to force enable or disable search_more button
-            if (this.is_option_set(this.options.search_more) || _.isUndefined(this.options.search_more) && this.is_option_set(self.view.ir_options['web_m2x_options.search_more'])) {
-                this.search_more = true
+            this.search_more = false;
+            if (!_.isUndefined(this.view.ir_options['web_m2x_options.search_more'])) {
+                this.search_more = is_option_set(this.view.ir_options['web_m2x_options.search_more']);
             }
 
             // add options field_color and colors to color item(s) depending on field_color value
-            this.field_color = this.options.field_color
-            this.colors = this.options.colors
+            this.field_color = this.options.field_color;
+            this.colors = this.options.colors;
 
             var dataset = new instance.web.DataSet(this, this.field.relation,
                                                    self.build_context());
@@ -100,7 +121,9 @@ openerp.web_m2x_options = function (instance) {
                 self.build_context()));
 
             var create_rights;
-            if (typeof this.options.create === "undefined" ||
+            if (typeof ctx.create === "undefined" ||
+                typeof ctx.create_edit === "undefined" ||
+                typeof this.options.create === "undefined" ||
                 typeof this.options.create_edit === "undefined") {
                 create_rights = new instance.web.Model(this.field.relation).call(
                     "check_access_rights", ["create", false]);
@@ -176,9 +199,12 @@ openerp.web_m2x_options = function (instance) {
                     return x[1];
                 });
 
-                if ((_.isUndefined(self.options.create) && _.isUndefined(self.view.ir_options['web_m2x_options.create']) && can_create) ||
-		            (_.isUndefined(self.options.create) && self.view.ir_options['web_m2x_options.create'] == "True") ||
-                    self.options.create) {
+                var allow_create = can_create;
+                if (!_.isUndefined(self.view.ir_options['web_m2x_options.create'])) {
+                    allow_create = is_option_set(self.view.ir_options['web_m2x_options.create']);
+                }
+
+                if (allow_create) {
 
                     if (search_val.length > 0 &&
                         !_.include(raw_result, search_val)) {
@@ -198,9 +224,12 @@ openerp.web_m2x_options = function (instance) {
 
                 // create...
 
-                if ((_.isUndefined(self.options.create_edit) && _.isUndefined(self.view.ir_options['web_m2x_options.create_edit']) && can_create) ||
-		            (_.isUndefined(self.options.create) && self.view.ir_options['web_m2x_options.create_edit'] == "True") ||
-                    self.options.create_edit) {
+                var allow_create_edit = can_create;
+                if (!_.isUndefined(self.view.ir_options['web_m2x_options.create_edit'])) {
+                    allow_create_edit = is_option_set(self.view.ir_options['web_m2x_options.create_edit']);
+                }
+
+                if (allow_create_edit) {
 
                     values.push({
                         label: _t("Create and Edit..."),
@@ -225,33 +254,20 @@ openerp.web_m2x_options = function (instance) {
 
     instance.web.form.FieldMany2ManyTags.include({
 
-        show_error_displayer: function () {
-            if ((typeof this.options.m2o_dialog === 'undefined' && this.can_create) ||
-                this.options.m2o_dialog) {
-                new instance.web.form.M2ODialog(this).open();
-            }
-        },
-
         start: function() {
             this._super.apply(this, arguments);
-            return this.get_options();
+            return get_options(this);
         },
 
-        get_options: function() {
-            var self = this;
-            if (_.isUndefined(this.view.ir_options_loaded)) {
-                this.view.ir_options_loaded = $.Deferred();
-                this.view.ir_options = {};
-                (new instance.web.Model("ir.config_parameter"))
-                        .query(["key", "value"]).filter([['key', 'in', OPTIONS]])
-                        .all().then(function(records) {
-                        _(records).each(function(record) {
-                    self.view.ir_options[record.key] = record.value;
-                    });
-                self.view.ir_options_loaded.resolve();
-            });
+        show_error_displayer: function () {
+            var allow_dialog = this.can_create;
+            if (!_.isUndefined(this.view.ir_options['web_m2x_options.m2o_dialog'])) {
+                allow_dialog = is_option_set(this.view.ir_options['web_m2x_options.m2o_dialog']);
+            }
+
+            if (allow_dialog) {
+                new instance.web.form.M2ODialog(this).open();
             }
-            return this.view.ir_options_loaded;
         },
 
         /**
@@ -260,6 +276,7 @@ openerp.web_m2x_options = function (instance) {
 
         get_search_result: function(search_val) {
             var self = this;
+            var ctx = self.view.dataset.context;
 
             // add options limit used to change number of selections record
             // returned.
@@ -268,10 +285,6 @@ openerp.web_m2x_options = function (instance) {
                 this.limit = parseInt(this.view.ir_options['web_m2x_options.limit']);
             }
 
-            if (typeof this.options.limit === 'number') {
-                this.limit = this.options.limit;
-            }
-
             var dataset = new instance.web.DataSet(this, this.field.relation, self.build_context());
             var blacklist = this.get_search_blacklist();
             this.last_query = search_val;
@@ -306,9 +319,12 @@ openerp.web_m2x_options = function (instance) {
                 }
                 // quick create
 
-                if ((_.isUndefined(self.options.create) && _.isUndefined(self.view.ir_options['web_m2x_options.create'])) ||
-		            (_.isUndefined(self.options.create) && self.view.ir_options['web_m2x_options.create'] == 'True') ||
-                    self.options.create) {
+                var allow_create = true;
+                if (!_.isUndefined(self.view.ir_options['web_m2x_options.create'])) {
+                    allow_create = is_option_set(self.view.ir_options['web_m2x_options.create']);
+                }
+
+                if (allow_create) {
 
                     var raw_result = _(data.result).map(function(x) {return x[1];});
                     if (search_val.length > 0 && !_.include(raw_result, search_val)) {
@@ -324,9 +340,12 @@ openerp.web_m2x_options = function (instance) {
                 }
                 // create...
 
-                if ((_.isUndefined(self.options.create_edit === 'undefined') && _.isUndefined(self.view.ir_options['web_m2x_options.create_edit'])) ||
-	            (_.isUndefined(self.options.create) && self.view.ir_options['web_m2x_options.create_edit'] == 'True') ||
-                    self.options.create_edit) {
+                var allow_create_edit = true;
+                if (!_.isUndefined(self.view.ir_options['web_m2x_options.create_edit'])) {
+                    allow_create_edit = is_option_set(self.view.ir_options['web_m2x_options.create_edit']);
+                }
+
+                if (allow_create_edit) {
 
                     values.push({
                         label: _t("Create and Edit..."),
@@ -338,7 +357,7 @@ openerp.web_m2x_options = function (instance) {
                 }
 
                 return values;
-            })
+            });
         },
     });
 };