openerp.web.data = function(openerp) { /** * Serializes the sort criterion array of a dataset into a form which can be * consumed by OpenERP's RPC APIs. * * @param {Array} criterion array of fields, from first to last criteria, prefixed with '-' for reverse sorting * @returns {String} SQL-like sorting string (``ORDER BY``) clause */ openerp.web.serialize_sort = function (criterion) { return _.map(criterion, function (criteria) { if (criteria[0] === '-') { return criteria.slice(1) + ' DESC'; } return criteria + ' ASC'; }).join(', '); }; openerp.web.DataGroup = openerp.web.OldWidget.extend( /** @lends openerp.web.DataGroup# */{ /** * Management interface between views and grouped collections of OpenERP * records. * * The root DataGroup is instantiated with the relevant information * (a session, a model, a domain, a context and a group_by sequence), the * domain and context may be empty. It is then interacted with via * :js:func:`~openerp.web.DataGroup.list`, which is used to read the * content of the current grouping level. * * @constructs openerp.web.DataGroup * @extends openerp.web.OldWidget * * @param {openerp.web.OldWidget} parent widget * @param {String} model name of the model managed by this DataGroup * @param {Array} domain search domain for this DataGroup * @param {Object} context context of the DataGroup's searches * @param {Array} group_by sequence of fields by which to group * @param {Number} [level=0] nesting level of the group */ init: function(parent, model, domain, context, group_by, level) { this._super(parent, null); if (group_by) { if (group_by.length || context['group_by_no_leaf']) { return new openerp.web.ContainerDataGroup( this, model, domain, context, group_by, level); } else { return new openerp.web.GrouplessDataGroup( this, model, domain, context, level); } } this.model = model; this.context = context; this.domain = domain; this.level = level || 0; }, cls: 'DataGroup' }); openerp.web.ContainerDataGroup = openerp.web.DataGroup.extend( /** @lends openerp.web.ContainerDataGroup# */ { /** * * @constructs openerp.web.ContainerDataGroup * @extends openerp.web.DataGroup * * @param session * @param model * @param domain * @param context * @param group_by * @param level */ init: function (parent, model, domain, context, group_by, level) { this._super(parent, model, domain, context, null, level); this.group_by = group_by; }, /** * The format returned by ``read_group`` is absolutely dreadful: * * * A ``__context`` key provides future grouping levels * * A ``__domain`` key provides the domain for the next search * * The current grouping value is provided through the name of the * current grouping name e.g. if currently grouping on ``user_id``, then * the ``user_id`` value for this group will be provided through the * ``user_id`` key. * * Similarly, the number of items in the group (not necessarily direct) * is provided via ``${current_field}_count`` * * Other aggregate fields are just dumped there * * This function slightly improves the grouping records by: * * * Adding a ``grouped_on`` property providing the current grouping field * * Adding a ``value`` and a ``length`` properties which replace the * ``$current_field`` and ``${current_field}_count`` ones * * Moving aggregate values into an ``aggregates`` property object * * Context and domain keys remain as-is, they should not be used externally * but in case they're needed... * * @param {Object} group ``read_group`` record */ transform_group: function (group) { var field_name = this.group_by[0]; // In cases where group_by_no_leaf and no group_by, the result of // read_group has aggregate fields but no __context or __domain. // Create default (empty) values for those so that things don't break var fixed_group = _.extend( {__context: {group_by: []}, __domain: []}, group); var aggregates = {}; _(fixed_group).each(function (value, key) { if (key.indexOf('__') === 0 || key === field_name || key === field_name + '_count') { return; } aggregates[key] = value || 0; }); var group_size = fixed_group[field_name + '_count'] || fixed_group.__count || 0; var leaf_group = fixed_group.__context.group_by.length === 0; return { __context: fixed_group.__context, __domain: fixed_group.__domain, grouped_on: field_name, // if terminal group (or no group) and group_by_no_leaf => use group.__count length: group_size, value: fixed_group[field_name], // A group is openable if it's not a leaf in group_by_no_leaf mode openable: !(leaf_group && this.context['group_by_no_leaf']), aggregates: aggregates }; }, fetch: function (fields) { // internal method var d = new $.Deferred(); var self = this; this.rpc('/web/group/read', { model: this.model, context: this.context, domain: this.domain, fields: _.uniq(this.group_by.concat(fields)), group_by_fields: this.group_by, sort: openerp.web.serialize_sort(this.sort) }, function () { }).then(function (response) { var data_groups = _(response).map( _.bind(self.transform_group, self)); self.groups = data_groups; d.resolveWith(self, [data_groups]); }, function () { d.rejectWith.apply(d, [self, arguments]); }); return d.promise(); }, /** * The items of a list have the following properties: * * ``length`` * the number of records contained in the group (and all of its * sub-groups). This does *not* provide the size of the "next level" * of the group, unless the group is terminal (no more groups within * it). * ``grouped_on`` * the name of the field this level was grouped on, this is mostly * used for display purposes, in order to know the name of the current * level of grouping. The ``grouped_on`` should be the same for all * objects of the list. * ``value`` * the value which led to this group (this is the value all contained * records have for the current ``grouped_on`` field name). * ``aggregates`` * a mapping of other aggregation fields provided by ``read_group`` * * @param {Array} fields the list of fields to aggregate in each group, can be empty * @param {Function} ifGroups function executed if any group is found (DataGroup.group_by is non-null and non-empty), called with a (potentially empty) list of groups as parameters. * @param {Function} ifRecords function executed if there is no grouping left to perform, called with a DataSet instance as parameter */ list: function (fields, ifGroups, ifRecords) { var self = this; this.fetch(fields).then(function (group_records) { ifGroups(_(group_records).map(function (group) { var child_context = _.extend({}, self.context, group.__context); return _.extend( new openerp.web.DataGroup( self, self.model, group.__domain, child_context, child_context.group_by, self.level + 1), group, {sort: self.sort}); })); }); } }); openerp.web.GrouplessDataGroup = openerp.web.DataGroup.extend( /** @lends openerp.web.GrouplessDataGroup# */ { /** * * @constructs openerp.web.GrouplessDataGroup * @extends openerp.web.DataGroup * * @param session * @param model * @param domain * @param context * @param level */ init: function (parent, model, domain, context, level) { this._super(parent, model, domain, context, null, level); }, list: function (fields, ifGroups, ifRecords) { ifRecords(_.extend( new openerp.web.DataSetSearch(this, this.model), {domain: this.domain, context: this.context, _sort: this.sort})); } }); openerp.web.StaticDataGroup = openerp.web.GrouplessDataGroup.extend( /** @lends openerp.web.StaticDataGroup# */ { /** * A specialization of groupless data groups, relying on a single static * dataset as its records provider. * * @constructs openerp.web.StaticDataGroup * @extends openerp.web.GrouplessDataGroup * @param {openep.web.DataSetStatic} dataset a static dataset backing the groups */ init: function (dataset) { this.dataset = dataset; }, list: function (fields, ifGroups, ifRecords) { ifRecords(this.dataset); } }); openerp.web.DataSet = openerp.web.OldWidget.extend( /** @lends openerp.web.DataSet# */{ /** * DateaManagement interface between views and the collection of selected * OpenERP records (represents the view's state?) * * @constructs openerp.web.DataSet * @extends openerp.web.OldWidget * * @param {String} model the OpenERP model this dataset will manage */ init: function(parent, model, context) { this._super(parent); this.model = model; this.context = context || {}; this.index = null; this._sort = []; }, previous: function () { this.index -= 1; if (!this.ids.length) { this.index = null; } else if (this.index < 0) { this.index = this.ids.length - 1; } return this; }, next: function () { this.index += 1; if (!this.ids.length) { this.index = null; } else if (this.index >= this.ids.length) { this.index = 0; } return this; }, select_id: function(id) { var idx = this.get_id_index(id); if (idx === null) { return false; } else { this.index = idx; return true; } }, get_id_index: function(id) { for (var i=0, ii=this.ids.length; i= ids.length - 1) { this.index = ids.length - 1; } }, unlink: function(ids) { this.on_unlink(ids); return $.Deferred().resolve({result: true}); }, on_unlink: function(ids) { this.set_ids(_.without.apply(null, [this.ids].concat(ids))); } }); openerp.web.DataSetSearch = openerp.web.DataSet.extend(/** @lends openerp.web.DataSetSearch */{ /** * @constructs openerp.web.DataSetSearch * @extends openerp.web.DataSet * * @param {Object} parent * @param {String} model * @param {Object} context * @param {Array} domain */ init: function(parent, model, context, domain) { this._super(parent, model, context); this.domain = domain || []; this.offset = 0; this._length; // subset records[offset:offset+limit] // is it necessary ? this.ids = []; }, /** * Read a slice of the records represented by this DataSet, based on its * domain and context. * * @params {Object} options * @param {Array} [options.fields] fields to read and return, by default all fields are returned * @param {Object} [options.context] context data to add to the request payload, on top of the DataSet's own context * @param {Array} [options.domain] domain data to add to the request payload, ANDed with the dataset's domain * @param {Number} [options.offset=0] The index from which selected records should be returned * @param {Number} [options.limit=null] The maximum number of records to return * @returns {$.Deferred} */ read_slice: function (fields, options) { options = options || {}; var self = this; var offset = options.offset || 0; return this.rpc('/web/dataset/search_read', { model: this.model, fields: fields || false, domain: this.get_domain(options.domain), context: this.get_context(options.context), sort: this.sort(), offset: offset, limit: options.limit || false }).pipe(function (result) { self.ids = result.ids; self.offset = offset; self._length = result.length; return result.records; }); }, get_domain: function (other_domain) { if (other_domain) { return new openerp.web.CompoundDomain(this.domain, other_domain); } return this.domain; }, unlink: function(ids, callback, error_callback) { var self = this; return this._super(ids, function(result) { self.ids = _.without.apply(_, [self.ids].concat(ids)); if (this.index !== null) { self.index = self.index <= self.ids.length - 1 ? self.index : (self.ids.length > 0 ? self.ids.length -1 : 0); } if (callback) callback(result); }, error_callback); }, size: function () { if (this._length !== undefined) { return this._length; } return this._super(); } }); openerp.web.BufferedDataSet = openerp.web.DataSetStatic.extend({ virtual_id_prefix: "one2many_v_id_", debug_mode: true, init: function() { this._super.apply(this, arguments); this.reset_ids([]); this.last_default_get = {}; }, default_get: function(fields, options) { return this._super(fields, options).then(this.on_default_get); }, on_default_get: function(res) { this.last_default_get = res; }, create: function(data, callback, error_callback) { var cached = {id:_.uniqueId(this.virtual_id_prefix), values: data, defaults: this.last_default_get}; this.to_create.push(_.extend(_.clone(cached), {values: _.clone(cached.values)})); this.cache.push(cached); var prom = $.Deferred().then(callback); prom.resolve({result: cached.id}); return prom.promise(); }, write: function (id, data, options, callback) { var self = this; var record = _.detect(this.to_create, function(x) {return x.id === id;}); record = record || _.detect(this.to_write, function(x) {return x.id === id;}); var dirty = false; if (record) { for (var k in data) { if (record.values[k] === undefined || record.values[k] !== data[k]) { dirty = true; break; } } $.extend(record.values, data); } else { dirty = true; record = {id: id, values: data}; self.to_write.push(record); } var cached = _.detect(this.cache, function(x) {return x.id === id;}); if (!cached) { cached = {id: id, values: {}}; this.cache.push(cached); } $.extend(cached.values, record.values); if (dirty) this.on_change(); var to_return = $.Deferred().then(callback); to_return.resolve({result: true}); return to_return.promise(); }, unlink: function(ids, callback, error_callback) { var self = this; _.each(ids, function(id) { if (! _.detect(self.to_create, function(x) { return x.id === id; })) { self.to_delete.push({id: id}) } }); this.to_create = _.reject(this.to_create, function(x) { return _.include(ids, x.id);}); this.to_write = _.reject(this.to_write, function(x) { return _.include(ids, x.id);}); this.cache = _.reject(this.cache, function(x) { return _.include(ids, x.id);}); this.set_ids(_.without.apply(_, [this.ids].concat(ids))); this.on_change(); return $.async_when({result: true}).then(callback); }, reset_ids: function(ids) { this.set_ids(ids); this.to_delete = []; this.to_create = []; this.to_write = []; this.cache = []; this.delete_all = false; }, on_change: function() {}, read_ids: function (ids, fields, options) { var self = this; var to_get = []; _.each(ids, function(id) { var cached = _.detect(self.cache, function(x) {return x.id === id;}); var created = _.detect(self.to_create, function(x) {return x.id === id;}); if (created) { _.each(fields, function(x) {if (cached.values[x] === undefined) cached.values[x] = created.defaults[x] || false;}); } else { if (!cached || !_.all(fields, function(x) {return cached.values[x] !== undefined})) to_get.push(id); } }); var completion = $.Deferred(); var return_records = function() { var records = _.map(ids, function(id) { return _.extend({}, _.detect(self.cache, function(c) {return c.id === id;}).values, {"id": id}); }); if (self.debug_mode) { if (_.include(records, undefined)) { throw "Record not correctly loaded"; } } var sort_fields = self._sort, compare = function (v1, v2) { return (v1 < v2) ? -1 : (v1 > v2) ? 1 : 0; }; // Array.sort is not necessarily stable. We must be careful with this because // sorting an array where all items are considered equal is a worst-case that // will randomize the array with an unstable sort! Therefore we must avoid // sorting if there are no sort_fields (i.e. all items are considered equal) // See also: http://ecma262-5.com/ELS5_Section_15.htm#Section_15.4.4.11 // http://code.google.com/p/v8/issues/detail?id=90 if (sort_fields.length) { records.sort(function (a, b) { return _.reduce(sort_fields, function (acc, field) { if (acc) { return acc; } var sign = 1; if (field[0] === '-') { sign = -1; field = field.slice(1); } return sign * compare(a[field], b[field]); }, 0); }); } completion.resolve(records); }; if(to_get.length > 0) { var rpc_promise = this._super(to_get, fields, options).then(function(records) { _.each(records, function(record, index) { var id = to_get[index]; var cached = _.detect(self.cache, function(x) {return x.id === id;}); if (!cached) { self.cache.push({id: id, values: record}); } else { // I assume cache value is prioritary cached.values = _.defaults(_.clone(cached.values), record); } }); return_records(); }); $.when(rpc_promise).fail(function() {completion.reject();}); } else { return_records(); } return completion.promise(); }, call_button: function (method, args, callback, error_callback) { var id = args[0][0], index; for(var i=0, len=this.cache.length; i