1 /*---------------------------------------------------------
3 *---------------------------------------------------------*/
5 openerp.web.views = function(instance) {
6 var QWeb = instance.web.qweb,
9 instance.web.ActionManager = instance.web.Widget.extend({
10 init: function(parent) {
12 this.inner_action = null;
13 this.inner_widget = null;
15 this.dialog_widget = null;
16 this.breadcrumbs = [];
17 this.on('history_back', this, function() {
18 return this.history_back();
22 this._super.apply(this, arguments);
23 this.$el.on('click', 'a.oe_breadcrumb_item', this.on_breadcrumb_clicked);
25 dialog_stop: function () {
27 this.dialog.destroy();
32 * Add a new item to the breadcrumb
34 * If the title of an item is an array, the multiple title mode is in use.
35 * (eg: a widget with multiple views might need to display a title for each view)
36 * In multiple title mode, the show() callback can check the index it receives
37 * in order to detect which of its titles has been clicked on by the user.
39 * @param {Object} item breadcrumb item
40 * @param {Object} item.widget widget containing the view(s) to be added to the breadcrumb added
41 * @param {Function} [item.show] triggered whenever the widget should be shown back
42 * @param {Function} [item.hide] triggered whenever the widget should be shown hidden
43 * @param {Function} [item.destroy] triggered whenever the widget should be destroyed
44 * @param {String|Array} [item.title] title(s) of the view(s) to be displayed in the breadcrumb
45 * @param {Function} [item.get_title] should return the title(s) of the view(s) to be displayed in the breadcrumb
47 push_breadcrumb: function(item) {
48 var last = this.breadcrumbs.slice(-1)[0];
53 show: function(index) {
54 this.widget.$el.show();
57 this.widget.$el.hide();
60 this.widget.destroy();
62 get_title: function() {
63 return this.title || this.widget.get('title');
66 item.id = _.uniqueId('breadcrumb_');
67 this.breadcrumbs.push(item);
69 history_back: function() {
70 var last = this.breadcrumbs.slice(-1)[0];
74 var title = last.get_title();
75 if (_.isArray(title) && title.length > 1) {
76 return this.select_breadcrumb(this.breadcrumbs.length - 1, title.length - 2);
77 } else if (this.breadcrumbs.length === 1) {
78 // Only one single titled item in breadcrumb, most of the time you want to trigger back to home
81 var prev = this.breadcrumbs[this.breadcrumbs.length - 2];
82 title = prev.get_title();
83 return this.select_breadcrumb(this.breadcrumbs.length - 2, _.isArray(title) ? title.length - 1 : undefined);
86 on_breadcrumb_clicked: function(ev) {
87 var $e = $(ev.target);
88 var id = $e.data('id');
90 for (var i = this.breadcrumbs.length - 1; i >= 0; i--) {
91 if (this.breadcrumbs[i].id == id) {
96 var subindex = $e.parent().find('a.oe_breadcrumb_item[data-id=' + $e.data('id') + ']').index($e);
97 this.select_breadcrumb(index, subindex);
99 select_breadcrumb: function(index, subindex) {
100 var next_item = this.breadcrumbs[index + 1];
101 if (next_item && next_item.on_reverse_breadcrumb) {
102 next_item.on_reverse_breadcrumb(this.breadcrumbs[index].widget);
104 for (var i = this.breadcrumbs.length - 1; i >= 0; i--) {
106 if (this.remove_breadcrumb(i) === false) {
111 var item = this.breadcrumbs[index];
113 this.inner_widget = item.widget;
114 this.inner_action = item.action;
117 clear_breadcrumbs: function() {
118 for (var i = this.breadcrumbs.length - 1; i >= 0; i--) {
119 if (this.remove_breadcrumb(0) === false) {
124 remove_breadcrumb: function(index) {
125 var item = this.breadcrumbs.splice(index, 1)[0];
127 var dups = _.filter(this.breadcrumbs, function(it) {
128 return item.widget === it.widget;
131 if (this.getParent().has_uncommitted_changes()) {
132 this.inner_widget = item.widget;
133 this.inner_action = item.action;
134 this.breadcrumbs.splice(index, 0, item);
141 var last_widget = this.breadcrumbs.slice(-1)[0];
143 this.inner_widget = last_widget.widget;
144 this.inner_action = last_widget.action;
147 get_title: function() {
149 for (var i = 0; i < this.breadcrumbs.length; i += 1) {
150 var item = this.breadcrumbs[i];
151 var tit = item.get_title();
152 if (!_.isArray(tit)) {
155 for (var j = 0; j < tit.length; j += 1) {
156 var label = _.escape(tit[j]);
157 if (i === this.breadcrumbs.length - 1 && j === tit.length - 1) {
158 titles.push(_.str.sprintf('<span class="oe_breadcrumb_item">%s</span>', label));
160 titles.push(_.str.sprintf('<a href="#" class="oe_breadcrumb_item" data-id="%s">%s</a>', item.id, label));
164 return titles.join(' <span class="oe_fade">/</span> ');
166 do_push_state: function(state) {
168 if (this.getParent() && this.getParent().do_push_state) {
169 if (this.inner_action) {
170 if (this.inner_action._push_me === false) {
171 // this action has been explicitly marked as not pushable
174 state['title'] = this.inner_action.name;
175 if(this.inner_action.type == 'ir.actions.act_window') {
176 state['model'] = this.inner_action.res_model;
178 if (this.inner_action.menu_id) {
179 state['menu_id'] = this.inner_action.menu_id;
181 if (this.inner_action.id) {
182 state['action'] = this.inner_action.id;
183 } else if (this.inner_action.type == 'ir.actions.client') {
184 state['action'] = this.inner_action.tag;
186 _.each(this.inner_action.params, function(v, k) {
187 if(_.isString(v) || _.isNumber(v)) {
191 state = _.extend(params || {}, state);
193 if (this.inner_action.context) {
194 if (this.inner_action.context.active_id) {
195 state["active_id"] = this.inner_action.context.active_id;
197 if (this.inner_action.context.active_ids) {
198 state["active_ids"] = this.inner_action.context.active_ids.join(',');
203 this.getParent().do_push_state(state);
207 do_load_state: function(state, warm) {
211 if (_.isString(state.action) && instance.web.client_actions.contains(state.action)) {
212 var action_client = {
213 type: "ir.actions.client",
216 _push_me: state._push_me,
219 action_loaded = this.do_action(action_client);
221 var run_action = (!this.inner_widget || !this.inner_widget.action) || this.inner_widget.action.id !== state.action;
223 var add_context = {};
224 if (state.active_id) {
225 add_context.active_id = state.active_id;
227 if (state.active_ids) {
228 // The jQuery BBQ plugin does some parsing on values that are valid integers.
229 // It means that if there's only one item, it will do parseInt() on it,
230 // otherwise it will keep the comma seperated list as string.
231 add_context.active_ids = state.active_ids.toString().split(',').map(function(id) {
232 return parseInt(id, 10) || id;
236 action_loaded = this.do_action(state.action, { additional_context: add_context });
237 $.when(action_loaded || null).done(function() {
238 instance.webclient.menu.has_been_loaded.done(function() {
239 if (self.inner_action && self.inner_action.id) {
240 instance.webclient.menu.open_action(self.inner_action.id);
246 } else if (state.model && state.id) {
247 // TODO handle context & domain ?
250 res_model: state.model,
252 type: 'ir.actions.act_window',
253 views: [[false, 'form']]
255 action_loaded = this.do_action(action);
256 } else if (state.sa) {
257 // load session action
259 action_loaded = this.rpc('/web/session/get_session_action', {key: state.sa}).then(function(action) {
261 return self.do_action(action);
266 $.when(action_loaded || null).done(function() {
267 if (self.inner_widget && self.inner_widget.do_load_state) {
268 self.inner_widget.do_load_state(state, warm);
273 * Execute an OpenERP action
275 * @param {Number|String|Object} Can be either an action id, a client action or an action descriptor.
276 * @param {Object} [options]
277 * @param {Boolean} [options.clear_breadcrumbs=false] Clear the breadcrumbs history list
278 * @param {Function} [options.on_reverse_breadcrumb] Callback to be executed whenever an anterior breadcrumb item is clicked on.
279 * @param {Function} [options.on_close] Callback to be executed when the dialog is closed (only relevant for target=new actions)
280 * @param {Function} [options.action_menu_id] Manually set the menu id on the fly.
281 * @param {Object} [options.additional_context] Additional context to be merged with the action's context.
282 * @return {jQuery.Deferred} Action loaded
284 do_action: function(action, options) {
285 options = _.defaults(options || {}, {
286 clear_breadcrumbs: false,
287 on_reverse_breadcrumb: function() {},
288 on_close: function() {},
289 action_menu_id: null,
290 additional_context: {},
292 if (action === false) {
293 action = { type: 'ir.actions.act_window_close' };
294 } else if (_.isString(action) && instance.web.client_actions.contains(action)) {
295 var action_client = { type: "ir.actions.client", tag: action, params: {} };
296 return this.do_action(action_client, options);
297 } else if (_.isNumber(action) || _.isString(action)) {
299 return self.rpc("/web/action/load", { action_id: action }).then(function(result) {
300 return self.do_action(result, options);
304 // Ensure context & domain are evaluated and can be manipulated/used
305 var ncontext = new instance.web.CompoundContext(options.additional_context, action.context || {});
306 action.context = instance.web.pyeval.eval('context', ncontext);
307 if (action.context.active_id || action.context.active_ids) {
308 // Here we assume that when an `active_id` or `active_ids` is used
309 // in the context, we are in a `related` action, so we disable the
310 // searchview's default custom filters.
311 action.context.search_disable_custom_filters = true;
314 action.domain = instance.web.pyeval.eval(
315 'domain', action.domain, action.context || {});
319 console.error("No type for action", action);
320 return $.Deferred().reject();
322 var type = action.type.replace(/\./g,'_');
323 var popup = action.target === 'new';
324 var inline = action.target === 'inline' || action.target === 'inlineview';
325 action.flags = _.defaults(action.flags || {}, {
326 views_switcher : !popup && !inline,
327 search_view : !popup && !inline,
328 action_buttons : !popup && !inline,
329 sidebar : !popup && !inline,
330 pager : !popup && !inline,
331 display_title : !popup,
332 search_disable_custom_filters: action.context && action.context.search_disable_custom_filters
334 action.menu_id = options.action_menu_id;
335 if (!(type in this)) {
336 console.error("Action manager can't handle action of type " + action.type, action);
337 return $.Deferred().reject();
339 return this[type](action, options);
341 null_action: function() {
343 this.clear_breadcrumbs();
347 * @param {Object} executor
348 * @param {Object} executor.action original action
349 * @param {Function<instance.web.Widget>} executor.widget function used to fetch the widget instance
350 * @param {String} executor.klass CSS class to add on the dialog root, if action.target=new
351 * @param {Function<instance.web.Widget, undefined>} executor.post_process cleanup called after a widget has been added as inner_widget
352 * @param {Object} options
355 ir_actions_common: function(executor, options) {
356 if (this.inner_widget && executor.action.target !== 'new') {
357 if (this.getParent().has_uncommitted_changes()) {
358 return $.Deferred().reject();
359 } else if (options.clear_breadcrumbs) {
360 this.clear_breadcrumbs();
363 var widget = executor.widget();
364 if (executor.action.target === 'new') {
365 if (this.dialog_widget && !this.dialog_widget.isDestroyed()) {
366 this.dialog_widget.destroy();
369 this.dialog = new instance.web.Dialog(this, {
370 dialogClass: executor.klass,
372 this.dialog.on("closing", null, options.on_close);
373 this.dialog.dialog_title = executor.action.name;
374 if (widget instanceof instance.web.ViewManager) {
375 _.extend(widget.flags, {
376 $buttons: this.dialog.$buttons,
377 footer_to_buttons: true,
380 this.dialog_widget = widget;
381 this.dialog_widget.setParent(this.dialog);
382 var initialized = this.dialog_widget.appendTo(this.dialog.$el);
387 this.inner_action = executor.action;
388 this.inner_widget = widget;
389 executor.post_process(widget);
390 return this.inner_widget.appendTo(this.$el);
393 ir_actions_act_window: function (action, options) {
396 return this.ir_actions_common({
397 widget: function () { return new instance.web.ViewManagerAction(self, action); },
399 klass: 'oe_act_window',
400 post_process: function (widget) { widget.add_breadcrumb(options.on_reverse_breadcrumb); }
403 ir_actions_client: function (action, options) {
405 var ClientWidget = instance.web.client_actions.get_object(action.tag);
407 if (!(ClientWidget.prototype instanceof instance.web.Widget)) {
409 if (next = ClientWidget(this, action)) {
410 return this.do_action(next, options);
415 return this.ir_actions_common({
416 widget: function () { return new ClientWidget(self, action); },
418 klass: 'oe_act_client',
419 post_process: function(widget) {
420 self.push_breadcrumb({
423 on_reverse_breadcrumb: options.on_reverse_breadcrumb,
425 if (action.tag !== 'reload') {
426 self.do_push_state({});
431 ir_actions_act_window_close: function (action, options) {
438 ir_actions_server: function (action, options) {
440 this.rpc('/web/action/run', {
441 action_id: action.id,
442 context: action.context || {}
443 }).done(function (action) {
444 self.do_action(action, options)
447 ir_actions_report_xml: function(action, options) {
449 instance.web.blockUI();
450 return instance.web.pyeval.eval_domains_and_contexts({
451 contexts: [action.context],
453 }).then(function(res) {
454 action = _.clone(action);
455 action.context = res.context;
456 var c = instance.webclient.crashmanager;
457 return $.Deferred(function (d) {
458 self.session.get_file({
460 data: {action: JSON.stringify(action)},
461 complete: instance.web.unblockUI,
470 c.rpc_error.apply(c, arguments);
477 ir_actions_act_url: function (action) {
478 window.open(action.url, action.target === 'self' ? '_self' : '_blank');
483 instance.web.ViewManager = instance.web.Widget.extend({
484 template: "ViewManager",
485 init: function(parent, dataset, views, flags) {
487 this.url_states = {};
488 this.model = dataset ? dataset.model : undefined;
489 this.dataset = dataset;
490 this.searchview = null;
491 this.active_view = null;
492 this.views_src = _.map(views, function(x) {
493 if (x instanceof Array) {
494 var view_type = x[1];
495 var View = instance.web.views.get_object(view_type, true);
496 var view_label = View ? View.prototype.display_name : (void 'nope');
499 view_type: view_type,
501 button_label: View ? _.str.sprintf(_t('%(view_type)s view'), {'view_type': (view_label || view_type)}) : (void 'nope'),
508 this.flags = flags || {};
509 this.registry = instance.web.views;
510 this.views_history = [];
511 this.view_completely_inited = $.Deferred();
514 * @returns {jQuery.Deferred} initial view loading promise
519 this.$el.find('.oe_view_manager_switch a').click(function() {
520 self.switch_mode($(this).data('view-type'));
523 _.each(this.views_src, function(view) {
524 self.views[view.view_type] = $.extend({}, view, {
525 deferred : $.Deferred(),
528 $buttons : self.$el.find('.oe_view_manager_buttons'),
529 $sidebar : self.flags.sidebar ? self.$el.find('.oe_view_manager_sidebar') : undefined,
530 $pager : self.$el.find('.oe_view_manager_pager'),
531 action : self.action,
532 action_views_ids : views_ids
533 }, self.flags, self.flags[view.view_type] || {}, view.options || {})
535 views_ids[view.view_type] = view.view_id;
537 if (this.flags.views_switcher === false) {
538 this.$el.find('.oe_view_manager_switch').hide();
540 // If no default view defined, switch to the first one in sequence
541 var default_view = this.flags.default_view || this.views_src[0].view_type;
542 return this.switch_mode(default_view);
544 switch_mode: function(view_type, no_store, view_options) {
546 var view = this.views[view_type];
548 var form = this.views['form'];
549 if (!view || (form && form.controller && !form.controller.can_be_discarded())) {
550 self.trigger('switch_mode', view_type, no_store, view_options);
551 return $.Deferred().reject();
554 this.views_history.push(view_type);
556 this.active_view = view_type;
558 if (!view.controller) {
559 view_promise = this.do_create_view(view_type);
560 } else if (this.searchview
561 && self.flags.auto_search
562 && view.controller.searchable !== false) {
563 this.searchview.ready.done(this.searchview.do_search);
566 if (this.searchview) {
567 this.searchview[(view.controller.searchable === false || this.searchview.options.hidden) ? 'hide' : 'show']();
570 this.$el.find('.oe_view_manager_switch a').parent().removeClass('active');
572 .find('.oe_view_manager_switch a').filter('[data-view-type="' + view_type + '"]')
573 .parent().addClass('active');
575 return $.when(view_promise).done(function () {
576 _.each(_.keys(self.views), function(view_name) {
577 var controller = self.views[view_name].controller;
579 var container = self.$el.find(".oe_view_manager_view_" + view_name + ":first");
580 if (view_name === view_type) {
582 controller.do_show(view_options || {});
585 controller.do_hide();
589 self.trigger('switch_mode', view_type, no_store, view_options);
592 do_create_view: function(view_type) {
593 // Lazy loading of views
595 var view = this.views[view_type];
596 var viewclass = this.registry.get_object(view_type);
597 var options = _.clone(view.options);
598 if (view_type === "form" && this.action && (this.action.target == 'new' || this.action.target == 'inline')) {
599 options.initial_mode = 'edit';
601 var controller = new viewclass(this, this.dataset, view.view_id, options);
603 controller.on('history_back', this, function() {
604 var am = self.getParent();
605 if (am && am.trigger) {
606 return am.trigger('history_back');
610 controller.on("change:title", this, function() {
611 if (self.active_view === view_type) {
612 self.set_title(controller.get('title'));
616 if (view.embedded_view) {
617 controller.set_embedded_view(view.embedded_view);
619 controller.on('switch_mode', self, this.switch_mode);
620 controller.on('previous_view', self, this.prev_view);
622 var container = this.$el.find(".oe_view_manager_view_" + view_type);
623 var view_promise = controller.appendTo(container);
624 this.views[view_type].controller = controller;
625 this.views[view_type].deferred.resolve(view_type);
626 return $.when(view_promise).done(function() {
628 && self.flags.auto_search
629 && view.controller.searchable !== false) {
630 self.searchview.ready.done(self.searchview.do_search);
632 self.view_completely_inited.resolve();
634 self.trigger("controller_inited",view_type,controller);
638 * @returns {Number|Boolean} the view id of the given type, false if not found
640 get_view_id: function(view_type) {
641 return this.views[view_type] && this.views[view_type].view_id || false;
643 set_title: function(title) {
644 this.$el.find('.oe_view_title_text:first').text(title);
646 add_breadcrumb: function(on_reverse_breadcrumb) {
648 var views = [this.active_view || this.views_src[0].view_type];
649 this.on('switch_mode', self, function(mode) {
650 var last = views.slice(-1)[0];
652 if (mode !== 'form') {
658 this.getParent().push_breadcrumb({
661 show: function(index) {
662 var view_to_select = views[index];
663 var state = self.url_states[view_to_select];
664 self.do_push_state(state || {});
665 $.when(self.switch_mode(view_to_select)).done(function() {
669 get_title: function() {
672 _.each(self.getParent().breadcrumbs, function(bc, i) {
673 if (bc.widget === self) {
677 var next = self.getParent().breadcrumbs.slice(currentIndex + 1)[0];
678 var titles = _.map(views, function(v) {
679 var controller = self.views[v].controller;
681 id = controller.datarecord.id;
683 return controller.get('title');
685 if (next && next.action && next.action.res_id && self.dataset &&
686 self.active_view === 'form' && self.dataset.model === next.action.res_model && id === next.action.res_id) {
687 // If the current active view is a formview and the next item in the breadcrumbs
688 // is an action on same object (model / res_id), then we omit the current formview's title
693 on_reverse_breadcrumb: on_reverse_breadcrumb,
697 * Returns to the view preceding the caller view in this manager's
698 * navigation history (the navigation history is appended to via
701 * @param {Object} [options]
702 * @param {Boolean} [options.created=false] resource was created
703 * @param {String} [options.default=null] view to switch to if no previous view
704 * @returns {$.Deferred} switching end signal
706 prev_view: function (options) {
707 options = options || {};
708 var current_view = this.views_history.pop();
709 var previous_view = this.views_history[this.views_history.length - 1] || options['default'];
710 if (options.created && current_view === 'form' && previous_view === 'list') {
711 // APR special case: "If creation mode from list (and only from a list),
712 // after saving, go to page view (don't come back in list)"
713 return this.switch_mode('form');
714 } else if (options.created && !previous_view && this.action && this.action.flags.default_view === 'form') {
715 // APR special case: "If creation from dashboard, we have no previous view
716 return this.switch_mode('form');
718 return this.switch_mode(previous_view, true);
721 * Sets up the current viewmanager's search view.
723 * @param {Number|false} view_id the view to use or false for a default one
724 * @returns {jQuery.Deferred} search view startup deferred
726 setup_search_view: function(view_id, search_defaults) {
728 if (this.searchview) {
729 this.searchview.destroy();
732 hidden: this.flags.search_view === false,
733 disable_custom_filters: this.flags.search_disable_custom_filters,
735 this.searchview = new instance.web.SearchView(this, this.dataset, view_id, search_defaults, options);
737 this.searchview.on('search_data', self, this.do_searchview_search);
738 return this.searchview.appendTo(this.$el.find(".oe_view_manager_view_search"));
740 do_searchview_search: function(domains, contexts, groupbys) {
742 controller = this.views[this.active_view].controller,
743 action_context = this.action.context || {};
744 instance.web.pyeval.eval_domains_and_contexts({
745 domains: [this.action.domain || []].concat(domains || []),
746 contexts: [action_context].concat(contexts || []),
747 group_by_seq: groupbys || []
748 }).done(function (results) {
749 self.dataset._model = new instance.web.Model(
750 self.dataset.model, results.context, results.domain);
751 var groupby = results.group_by.length
753 : action_context.group_by;
754 if (_.isString(groupby)) {
757 $.when(controller.do_search(results.domain, results.context, groupby || [])).then(function() {
758 self.view_completely_inited.resolve();
763 * Called when one of the view want to execute an action
765 on_action: function(action) {
767 on_create: function() {
769 on_remove: function() {
771 on_edit: function() {
774 * Called by children view after executing an action
776 on_action_executed: function () {
780 instance.web.ViewManagerAction = instance.web.ViewManager.extend({
781 template:"ViewManagerAction",
783 * @constructs instance.web.ViewManagerAction
784 * @extends instance.web.ViewManager
786 * @param {instance.web.ActionManager} parent parent object/widget
787 * @param {Object} action descriptor for the action this viewmanager needs to manage its views.
789 init: function(parent, action) {
790 // dataset initialization will take the session from ``this``, so if we
791 // do not have it yet (and we don't, because we've not called our own
792 // ``_super()``) rpc requests will blow up.
793 var flags = action.flags || {};
794 if (!('auto_search' in flags)) {
795 flags.auto_search = action.auto_search !== false;
797 if (action.res_model == 'board.board' && action.view_mode === 'form') {
798 // Special case for Dashboards
800 views_switcher : false,
801 display_title : false,
805 action_buttons : false
808 this._super(parent, null, action.views, flags);
809 this.session = parent.session;
810 this.action = action;
811 var dataset = new instance.web.DataSetSearch(this, action.res_model, action.context, action.domain);
813 dataset.ids.push(action.res_id);
816 this.dataset = dataset;
819 * Initializes the ViewManagerAction: sets up the searchview (if the
820 * searchview is enabled in the manager's action flags), calls into the
821 * parent to initialize the primary view and (if the VMA has a searchview)
822 * launches an initial search after both views are done rendering.
827 search_defaults = {};
828 _.each(this.action.context, function (value, key) {
829 var match = /^search_default_(.*)$/.exec(key);
831 search_defaults[match[1]] = value;
835 var searchview_id = this.action['search_view_id'] && this.action['search_view_id'][0];
837 searchview_loaded = this.setup_search_view(searchview_id || false, search_defaults);
839 var main_view_loaded = this._super();
841 var manager_ready = $.when(searchview_loaded, main_view_loaded, this.view_completely_inited);
843 this.$el.find('.oe_debug_view').change(this.on_debug_changed);
844 this.$el.addClass("oe_view_manager_" + (this.action.target || 'current'));
845 return manager_ready;
847 on_debug_changed: function (evt) {
849 $sel = $(evt.currentTarget),
850 $option = $sel.find('option:selected'),
852 current_view = this.views[this.active_view].controller;
855 var dialog = new instance.web.Dialog(this, { title: _t("Fields View Get"), width: '95%' }).open();
856 $('<pre>').text(instance.web.json_node_to_xml(current_view.fields_view.arch, true)).appendTo(dialog.$el);
860 name: _t("JS Tests"),
862 type : 'ir.actions.act_url',
863 url: '/web/tests?mod=*'
867 var ids = current_view.get_selected_ids();
868 if (ids.length === 1) {
869 this.dataset.call('perm_read', [ids]).done(function(result) {
870 var dialog = new instance.web.Dialog(this, {
871 title: _.str.sprintf(_t("View Log (%s)"), self.dataset.model),
873 }, QWeb.render('ViewManagerDebugViewLog', {
875 format : instance.web.format_value
880 case 'toggle_layout_outline':
881 current_view.rendering_engine.toggle_layout_debugging();
884 current_view.open_defaults_dialog();
888 name: _t("Technical Translation"),
889 res_model : 'ir.translation',
890 domain : [['type', '!=', 'object'], '|', ['name', '=', this.dataset.model], ['name', 'ilike', this.dataset.model + ',']],
891 views: [[false, 'list'], [false, 'form']],
892 type : 'ir.actions.act_window',
898 this.dataset.call('fields_get', [false, {}]).done(function (fields) {
899 var $root = $('<dl>');
900 _(fields).each(function (attributes, name) {
901 $root.append($('<dt>').append($('<h4>').text(name)));
902 var $attrs = $('<dl>').appendTo($('<dd>').appendTo($root));
903 _(attributes).each(function (def, name) {
904 if (def instanceof Object) {
905 def = JSON.stringify(def);
908 .append($('<dt>').text(name))
909 .append($('<dd style="white-space: pre-wrap;">').text(def));
912 new instance.web.Dialog(self, {
913 title: _.str.sprintf(_t("Model %s fields"),
915 width: '95%'}, $root).open();
918 case 'edit_workflow':
919 return this.do_action({
920 res_model : 'workflow',
921 domain : [['osv', '=', this.dataset.model]],
922 views: [[false, 'list'], [false, 'form'], [false, 'diagram']],
923 type : 'ir.actions.act_window',
929 this.do_edit_resource($option.data('model'), $option.data('id'), { name : $option.text() });
931 case 'manage_filters':
933 res_model: 'ir.filters',
934 views: [[false, 'list'], [false, 'form']],
935 type: 'ir.actions.act_window',
937 search_default_my_filters: true,
938 search_default_model_id: this.dataset.model
942 case 'print_workflow':
943 if (current_view.get_selected_ids && current_view.get_selected_ids().length == 1) {
944 instance.web.blockUI();
946 context: { active_ids: current_view.get_selected_ids() },
947 report_name: "workflow.instance.graph",
949 model: this.dataset.model,
950 id: current_view.get_selected_ids()[0],
954 this.session.get_file({
956 data: {action: JSON.stringify(action)},
957 complete: instance.web.unblockUI
963 console.log("No debug handler for ", val);
966 evt.currentTarget.selectedIndex = 0;
968 do_edit_resource: function(model, id, action) {
969 var action = _.extend({
972 type : 'ir.actions.act_window',
975 views : [[false, 'form']],
978 action_buttons : true,
980 resize_textareas : true
984 this.do_action(action);
986 switch_mode: function (view_type, no_store, options) {
989 return $.when(this._super.apply(this, arguments)).done(function () {
990 var controller = self.views[self.active_view].controller;
991 self.$el.find('.oe_debug_view').html(QWeb.render('ViewManagerDebug', {
998 do_create_view: function(view_type) {
999 var r = this._super.apply(this, arguments);
1000 var view = this.views[view_type].controller;
1001 view.set({ 'title': this.action.name });
1004 get_action_manager: function() {
1006 while (cur = cur.getParent()) {
1007 if (cur instanceof instance.web.ActionManager) {
1013 set_title: function(title) {
1014 this.$el.find('.oe_breadcrumb_title:first').html(this.get_action_manager().get_title());
1016 do_push_state: function(state) {
1017 if (this.getParent() && this.getParent().do_push_state) {
1018 state["view_type"] = this.active_view;
1019 this.url_states[this.active_view] = state;
1020 this.getParent().do_push_state(state);
1023 do_load_state: function(state, warm) {
1026 if (state.view_type && state.view_type !== this.active_view) {
1028 this.views[this.active_view].deferred.then(function() {
1029 return self.switch_mode(state.view_type, true);
1034 $.when(defs).done(function() {
1035 self.views[self.active_view].controller.do_load_state(state, warm);
1040 instance.web.Sidebar = instance.web.Widget.extend({
1041 init: function(parent) {
1043 this._super(parent);
1044 var view = this.getParent();
1046 { 'name' : 'print', 'label' : _t('Print'), },
1047 { 'name' : 'other', 'label' : _t('More'), }
1053 this.fileupload_id = _.uniqueId('oe_fileupload');
1054 $(window).on(this.fileupload_id, function() {
1055 var args = [].slice.call(arguments).slice(1);
1056 self.do_attachement_update(self.dataset, self.model_id,args);
1057 instance.web.unblockUI();
1064 this.$el.on('click','.oe_dropdown_menu li a', function(event) {
1065 var section = $(this).data('section');
1066 var index = $(this).data('index');
1067 var item = self.items[section][index];
1068 if (item.callback) {
1069 item.callback.apply(self, [item]);
1070 } else if (item.action) {
1071 self.on_item_action_clicked(item);
1072 } else if (item.url) {
1075 event.preventDefault();
1078 redraw: function() {
1080 self.$el.html(QWeb.render('Sidebar', {widget: self}));
1082 // Hides Sidebar sections when item list is empty
1083 this.$('.oe_form_dropdown_section').each(function() {
1084 $(this).toggle(!!$(this).find('li').length);
1087 self.$("[title]").tipsy({
1093 * For each item added to the section:
1096 * will be used as the item's name in the sidebar, can be html
1099 * descriptor for the action which will be executed, ``action`` and
1100 * ``callback`` should be exclusive
1103 * function to call when the item is clicked in the sidebar, called
1104 * with the item descriptor as its first argument (so information
1105 * can be stored as additional keys on the object passed to
1108 * ``classname`` (optional)
1109 * ``@class`` set on the sidebar serialization of the item
1111 * ``title`` (optional)
1112 * will be set as the item's ``@title`` (tooltip)
1114 * @param {String} section_code
1115 * @param {Array<{label, action | callback[, classname][, title]}>} items
1117 add_items: function(section_code, items) {
1120 this.items[section_code].push.apply(this.items[section_code],items);
1124 add_toolbar: function(toolbar) {
1126 _.each(['print','action','relate'], function(type) {
1127 var items = toolbar[type];
1129 for (var i = 0; i < items.length; i++) {
1131 label: items[i]['name'],
1133 classname: 'oe_sidebar_' + type
1136 self.add_items(type=='print' ? 'print' : 'other', items);
1140 on_item_action_clicked: function(item) {
1142 self.getParent().sidebar_eval_context().done(function (sidebar_eval_context) {
1143 var ids = self.getParent().get_selected_ids();
1144 if (ids.length == 0) {
1145 instance.web.dialog($("<div />").text(_t("You must choose at least one record.")), { title: _t("Warning"), modal: true });
1148 var active_ids_context = {
1151 active_model: self.getParent().dataset.model
1153 var c = instance.web.pyeval.eval('context',
1154 new instance.web.CompoundContext(
1155 sidebar_eval_context, active_ids_context));
1156 self.rpc("/web/action/load", {
1157 action_id: item.action.id,
1159 }).done(function(result) {
1160 result.context = new instance.web.CompoundContext(
1161 result.context || {}, active_ids_context)
1162 .set_eval_context(c);
1163 result.flags = result.flags || {};
1164 result.flags.new_window = true;
1165 self.do_action(result, {
1166 on_close: function() {
1168 self.getParent().reload();
1174 do_attachement_update: function(dataset, model_id, args) {
1176 this.dataset = dataset;
1177 this.model_id = model_id;
1178 if (args && args[0].error) {
1179 this.do_warn( instance.web.qweb.render('message_error_uploading'), args[0].error);
1182 this.on_attachments_loaded([]);
1184 var dom = [ ['res_model', '=', dataset.model], ['res_id', '=', model_id], ['type', 'in', ['binary', 'url']] ];
1185 var ds = new instance.web.DataSetSearch(this, 'ir.attachment', dataset.get_context(), dom);
1186 ds.read_slice(['name', 'url', 'type', 'create_uid', 'create_date', 'write_uid', 'write_date'], {}).done(this.on_attachments_loaded);
1189 on_attachments_loaded: function(attachments) {
1192 var prefix = this.session.url('/web/binary/saveas', {model: 'ir.attachment', field: 'datas', filename_field: 'name'});
1193 _.each(attachments,function(a) {
1195 if(a.type === "binary") {
1196 a.url = prefix + '&id=' + a.id + '&t=' + (new Date().getTime());
1199 self.items['files'] = attachments;
1201 this.$('.oe_sidebar_add_attachment .oe_form_binary_file').change(this.on_attachment_changed);
1202 this.$el.find('.oe_sidebar_delete_item').click(this.on_attachment_delete);
1204 on_attachment_changed: function(e) {
1205 var $e = $(e.target);
1206 if ($e.val() !== '') {
1207 this.$el.find('form.oe_form_binary_form').submit();
1208 $e.parent().find('input[type=file]').prop('disabled', true);
1209 $e.parent().find('button').prop('disabled', true).find('img, span').toggle();
1210 this.$('.oe_sidebar_add_attachment span').text(_t('Uploading...'));
1211 instance.web.blockUI();
1214 on_attachment_delete: function(e) {
1216 e.stopPropagation();
1218 var $e = $(e.currentTarget);
1219 if (confirm(_t("Do you really want to delete this attachment ?"))) {
1220 (new instance.web.DataSet(this, 'ir.attachment')).unlink([parseInt($e.attr('data-id'), 10)]).done(function() {
1221 self.do_attachement_update(self.dataset, self.model_id);
1227 instance.web.View = instance.web.Widget.extend({
1228 // name displayed in view switchers
1231 * Define a view type for each view to allow automatic call to fields_view_get.
1233 view_type: undefined,
1234 init: function(parent, dataset, view_id, options) {
1235 this._super(parent);
1236 this.dataset = dataset;
1237 this.view_id = view_id;
1238 this.set_default_options(options);
1240 start: function () {
1241 return this.load_view();
1243 load_view: function(context) {
1245 var view_loaded_def;
1246 if (this.embedded_view) {
1247 view_loaded_def = $.Deferred();
1248 $.async_when().done(function() {
1249 view_loaded_def.resolve(self.embedded_view);
1252 if (! this.view_type)
1253 console.warn("view_type is not defined", this);
1254 view_loaded_def = instance.web.fields_view_get({
1255 "model": this.dataset._model,
1256 "view_id": this.view_id,
1257 "view_type": this.view_type,
1258 "toolbar": !!this.options.$sidebar,
1261 return view_loaded_def.then(function(r) {
1262 self.fields_view = r;
1263 // add css classes that reflect the (absence of) access rights
1264 self.$el.addClass('oe_view')
1265 .toggleClass('oe_cannot_create', !self.is_action_enabled('create'))
1266 .toggleClass('oe_cannot_edit', !self.is_action_enabled('edit'))
1267 .toggleClass('oe_cannot_delete', !self.is_action_enabled('delete'));
1268 return $.when(self.view_loading(r)).then(function() {
1269 self.trigger('view_loaded', r);
1273 view_loading: function(r) {
1275 set_default_options: function(options) {
1276 this.options = options || {};
1277 _.defaults(this.options, {
1278 // All possible views options should be defaulted here
1282 action_views_ids: {}
1286 * Fetches and executes the action identified by ``action_data``.
1288 * @param {Object} action_data the action descriptor data
1289 * @param {String} action_data.name the action name, used to uniquely identify the action to find and execute it
1290 * @param {String} [action_data.special=null] special action handlers (currently: only ``'cancel'``)
1291 * @param {String} [action_data.type='workflow'] the action type, if present, one of ``'object'``, ``'action'`` or ``'workflow'``
1292 * @param {Object} [action_data.context=null] additional action context, to add to the current context
1293 * @param {instance.web.DataSet} dataset a dataset object used to communicate with the server
1294 * @param {Object} [record_id] the identifier of the object on which the action is to be applied
1295 * @param {Function} on_closed callback to execute when dialog is closed or when the action does not generate any result (no new action)
1297 do_execute_action: function (action_data, dataset, record_id, on_closed) {
1299 var result_handler = function () {
1300 if (on_closed) { on_closed.apply(null, arguments); }
1301 if (self.getParent() && self.getParent().on_action_executed) {
1302 return self.getParent().on_action_executed.apply(null, arguments);
1305 var context = new instance.web.CompoundContext(dataset.get_context(), action_data.context || {});
1307 var handler = function (action) {
1308 if (action && action.constructor == Object) {
1309 var ncontext = new instance.web.CompoundContext(context);
1312 active_id: record_id,
1313 active_ids: [record_id],
1314 active_model: dataset.model
1317 ncontext.add(action.context || {});
1318 action.context = ncontext;
1319 return self.do_action(action, {
1320 on_close: result_handler,
1323 self.do_action({"type":"ir.actions.act_window_close"});
1324 return result_handler();
1328 if (action_data.special === 'cancel') {
1329 return handler({"type":"ir.actions.act_window_close"});
1330 } else if (action_data.type=="object") {
1331 var args = [[record_id]], additional_args = [];
1332 if (action_data.args) {
1334 // Warning: quotes and double quotes problem due to json and xml clash
1335 // Maybe we should force escaping in xml or do a better parse of the args array
1336 additional_args = JSON.parse(action_data.args.replace(/'/g, '"'));
1337 args = args.concat(additional_args);
1339 console.error("Could not JSON.parse arguments", action_data.args);
1343 return dataset.call_button(action_data.name, args).then(handler);
1344 } else if (action_data.type=="action") {
1345 return this.rpc('/web/action/load', {
1346 action_id: action_data.name,
1347 context: instance.web.pyeval.eval('context', context),
1351 return dataset.exec_workflow(record_id, action_data.name).then(handler);
1355 * Directly set a view to use instead of calling fields_view_get. This method must
1356 * be called before start(). When an embedded view is set, underlying implementations
1357 * of instance.web.View must use the provided view instead of any other one.
1359 * @param embedded_view A view.
1361 set_embedded_view: function(embedded_view) {
1362 this.embedded_view = embedded_view;
1364 do_show: function () {
1367 do_hide: function () {
1370 is_active: function () {
1371 var manager = this.getParent();
1372 return !manager || !manager.active_view
1373 || manager.views[manager.active_view].controller === this;
1375 * Wraps fn to only call it if the current view is the active one. If the
1376 * current view is not active, doesn't call fn.
1378 * fn can not return anything, as a non-call to fn can't return anything
1381 * @param {Function} fn function to wrap in the active guard
1383 guard_active: function (fn) {
1385 return function () {
1386 if (self.is_active()) {
1387 fn.apply(self, arguments);
1391 do_push_state: function(state) {
1392 if (this.getParent() && this.getParent().do_push_state) {
1393 this.getParent().do_push_state(state);
1396 do_load_state: function(state, warm) {
1399 * Switches to a specific view type
1401 do_switch_view: function() {
1402 this.trigger.apply(this, ['switch_mode'].concat(_.toArray(arguments)));
1405 * Cancels the switch to the current view, switches to the previous one
1407 * @param {Object} [options]
1408 * @param {Boolean} [options.created=false] resource was created
1409 * @param {String} [options.default=null] view to switch to if no previous view
1412 do_search: function(view) {
1414 on_sidebar_export: function() {
1415 new instance.web.DataExport(this, this.dataset).open();
1417 sidebar_eval_context: function () {
1421 * Asks the view to reload itself, if the reloading is asynchronous should
1422 * return a {$.Deferred} indicating when the reloading is done.
1424 reload: function () {
1428 * Return whether the user can perform the action ('create', 'edit', 'delete') in this view.
1429 * An action is disabled by setting the corresponding attribute in the view's main element,
1430 * like: <form string="" create="false" edit="false" delete="false">
1432 is_action_enabled: function(action) {
1433 var attrs = this.fields_view.arch.attrs;
1434 return (action in attrs) ? JSON.parse(attrs[action]) : true;
1439 * Performs a fields_view_get and apply postprocessing.
1440 * return a {$.Deferred} resolved with the fvg
1442 * @param {Object} [args]
1443 * @param {String|Object} args.model instance.web.Model instance or string repr of the model
1444 * @param {null|Object} args.context context if args.model is a string
1445 * @param {null|Number} args.view_id id of the view to be loaded, default view if null
1446 * @param {null|String} args.view_type type of view to be loaded if view_id is null
1447 * @param {Boolean} [args.toolbar=false] get the toolbar definition
1449 instance.web.fields_view_get = function(args) {
1450 function postprocess(fvg) {
1451 var doc = $.parseXML(fvg.arch).documentElement;
1452 fvg.arch = instance.web.xml_to_json(doc, (doc.nodeName.toLowerCase() !== 'kanban'));
1453 if ('id' in fvg.fields) {
1454 // Special case for id's
1455 var id_field = fvg.fields['id'];
1456 id_field.original_type = id_field.type;
1457 id_field.type = 'id';
1459 _.each(fvg.fields, function(field) {
1460 _.each(field.views || {}, function(view) {
1466 args = _.defaults(args, {
1469 var model = args.model;
1470 if (typeof model === 'string') {
1471 model = new instance.web.Model(args.model, args.context);
1473 return args.model.call('fields_view_get', [args.view_id, args.view_type, model.context(), args.toolbar]).then(function(fvg) {
1474 return postprocess(fvg);
1478 instance.web.xml_to_json = function(node, strip_whitespace) {
1479 switch (node.nodeType) {
1481 return instance.web.xml_to_json(node.documentElement, strip_whitespace);
1484 return (strip_whitespace && node.data.trim() === '') ? undefined : node.data;
1486 var attrs = $(node).getAttributes();
1487 _.each(['domain', 'filter_domain', 'context', 'default_get'], function(key) {
1490 attrs[key] = JSON.parse(attrs[key]);
1495 tag: node.tagName.toLowerCase(),
1497 children: _.compact(_.map(node.childNodes, function(node) {
1498 return instance.web.xml_to_json(node, strip_whitespace);
1503 instance.web.json_node_to_xml = function(node, human_readable, indent) {
1504 // For debugging purpose, this function will convert a json node back to xml
1505 indent = indent || 0;
1506 var sindent = (human_readable ? (new Array(indent + 1).join('\t')) : ''),
1507 r = sindent + '<' + node.tag,
1508 cr = human_readable ? '\n' : '';
1510 if (typeof(node) === 'string') {
1511 return sindent + node;
1512 } else if (typeof(node.tag) !== 'string' || !node.children instanceof Array || !node.attrs instanceof Object) {
1514 _.str.sprintf(_t("Node [%s] is not a JSONified XML node"),
1515 JSON.stringify(node)));
1517 for (var attr in node.attrs) {
1518 var vattr = node.attrs[attr];
1519 if (typeof(vattr) !== 'string') {
1521 vattr = JSON.stringify(vattr);
1523 vattr = vattr.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"');
1524 if (human_readable) {
1525 vattr = vattr.replace(/"/g, "'");
1527 r += ' ' + attr + '="' + vattr + '"';
1529 if (node.children && node.children.length) {
1532 for (var i = 0, ii = node.children.length; i < ii; i++) {
1533 childs.push(instance.web.json_node_to_xml(node.children[i], human_readable, indent + 1));
1535 r += childs.join(cr);
1536 r += cr + sindent + '</' + node.tag + '>';
1542 instance.web.xml_to_str = function(node) {
1543 if (window.XMLSerializer) {
1544 return (new XMLSerializer()).serializeToString(node);
1545 } else if (window.ActiveXObject) {
1548 throw new Error(_t("Could not serialize XML"));
1553 * Registry for all the main views
1555 instance.web.views = new instance.web.Registry();
1559 // vim:et fdc=0 fdl=0 foldnestmax=3 fdm=syntax: