addons/web/static/src/js/views.js

   1 /*---------------------------------------------------------
   2  * OpenERP web library
   3  *---------------------------------------------------------*/
   4
   5 openerp.web.views = function(instance) {
   6 var QWeb = instance.web.qweb,
   7     _t = instance.web._t;
   8
   9 instance.web.ActionManager = instance.web.Widget.extend({
  10     init: function(parent) {
  11         this._super(parent);
  12         this.inner_action = null;
  13         this.inner_viewmanager = null;
  14         this.dialog = null;
  15         this.dialog_viewmanager = null;
  16         this.client_widget = null;
  17     },
  18     dialog_stop: function () {
  19         if (this.dialog) {
  20             this.dialog_viewmanager.destroy();
  21             this.dialog_viewmanager = null;
  22             this.dialog.destroy();
  23             this.dialog = null;
  24         }
  25     },
  26     content_stop: function () {
  27         if (this.inner_viewmanager) {
  28             this.inner_viewmanager.destroy();
  29             this.inner_viewmanager = null;
  30         }
  31         if (this.client_widget) {
  32             this.client_widget.destroy();
  33             this.client_widget = null;
  34         }
  35     },
  36     do_push_state: function(state) {
  37         if (this.getParent() && this.getParent().do_push_state) {
  38             if (this.inner_action) {
  39                 state['model'] = this.inner_action.res_model;
  40                 if (this.inner_action.id) {
  41                     state['action_id'] = this.inner_action.id;
  42                 }
  43             }
  44             this.getParent().do_push_state(state);
  45         }
  46     },
  47     do_load_state: function(state, warm) {
  48         var self = this,
  49             action_loaded;
  50         if (state.action_id) {
  51             var run_action = (!this.inner_viewmanager) || this.inner_viewmanager.action.id !== state.action_id;
  52             if (run_action) {
  53                 this.null_action();
  54                 action_loaded = this.do_action(state.action_id);
  55                 instance.webclient.menu.has_been_loaded.then(function() {
  56                     instance.webclient.menu.open_action(state.action_id);
  57                 });
  58             }
  59         } else if (state.model && state.id) {
  60             // TODO handle context & domain ?
  61             this.null_action();
  62             var action = {
  63                 res_model: state.model,
  64                 res_id: state.id,
  65                 type: 'ir.actions.act_window',
  66                 views: [[false, 'form']]
  67             };
  68             action_loaded = this.do_action(action);
  69         } else if (state.sa) {
  70             // load session action
  71             var self = this;
  72             this.null_action();
  73             action_loaded = this.rpc('/web/session/get_session_action',  {key: state.sa}).pipe(function(action) {
  74                 if (action) {
  75                     return self.do_action(action);
  76                 }
  77             });
  78         } else if (state.client_action) {
  79             this.null_action();
  80             this.ir_actions_client(state.client_action);
  81         }
  82
  83         $.when(action_loaded || null).then(function() {
  84             if (self.inner_viewmanager) {
  85                 self.inner_viewmanager.do_load_state(state, warm);
  86             }
  87         });
  88     },
  89     do_action: function(action, on_close) {
  90         if (_.isNumber(action)) {
  91             var self = this;
  92             return self.rpc("/web/action/load", { action_id: action }, function(result) {
  93                 self.do_action(result.result, on_close);
  94             });
  95         }
  96         if (!action.type) {
  97             console.error("No type for action", action);
  98             return;
  99         }
 100         var type = action.type.replace(/\./g,'_');
 101         var popup = action.target === 'new';
 102         var inline = action.target === 'inline';
 103         action.flags = _.extend({
 104             views_switcher : !popup && !inline,
 105             search_view : !popup && !inline,
 106             action_buttons : !popup && !inline,
 107             sidebar : !popup && !inline,
 108             pager : !popup && !inline,
 109             display_title : !popup
 110         }, action.flags || {});
 111         if (!(type in this)) {
 112             console.error("Action manager can't handle action of type " + action.type, action);
 113             return;
 114         }
 115         return this[type](action, on_close);
 116     },
 117     null_action: function() {
 118         this.dialog_stop();
 119         this.content_stop();
 120     },
 121     ir_actions_act_window: function (action, on_close) {
 122         var self = this;
 123         if (_(['base.module.upgrade', 'base.setup.installer'])
 124                 .contains(action.res_model)) {
 125             var old_close = on_close;
 126             on_close = function () {
 127                 instance.webclient.do_reload().then(old_close);
 128             };
 129         }
 130         if (action.target === 'new') {
 131             if (this.dialog == null) {
 132                 this.dialog = new instance.web.Dialog(this, { width: '80%' });
 133                 if(on_close)
 134                     this.dialog.on_close.add(on_close);
 135             } else {
 136                 this.dialog_viewmanager.destroy();
 137             }
 138             this.dialog.dialog_title = action.name;
 139             this.dialog_viewmanager = new instance.web.ViewManagerAction(this, action);
 140             this.dialog_viewmanager.appendTo(this.dialog.$element);
 141             this.dialog.open();
 142         } else  {
 143             this.dialog_stop();
 144             this.content_stop();
 145             if(action.menu_id) {
 146                 return this.getParent().do_action(action, function () {
 147                     instance.webclient.menu.open_menu(action.menu_id);
 148                 });
 149             }
 150             this.inner_action = action;
 151             this.inner_viewmanager = new instance.web.ViewManagerAction(this, action);
 152             this.inner_viewmanager.appendTo(this.$element);
 153         }
 154     },
 155     ir_actions_act_window_close: function (action, on_closed) {
 156         if (!this.dialog && on_closed) {
 157             on_closed();
 158         }
 159         this.dialog_stop();
 160     },
 161     ir_actions_server: function (action, on_closed) {
 162         var self = this;
 163         this.rpc('/web/action/run', {
 164             action_id: action.id,
 165             context: action.context || {}
 166         }).then(function (action) {
 167             self.do_action(action, on_closed)
 168         });
 169     },
 170     ir_actions_client: function (action) {
 171         this.content_stop();
 172         this.dialog_stop();
 173         var ClientWidget = instance.web.client_actions.get_object(action.tag);
 174         (this.client_widget = new ClientWidget(this, action.params)).appendTo(this.$element);
 175     },
 176     ir_actions_report_xml: function(action, on_closed) {
 177         var self = this;
 178         $.blockUI();
 179         self.rpc("/web/session/eval_domain_and_context", {
 180             contexts: [action.context],
 181             domains: []
 182         }).then(function(res) {
 183             action = _.clone(action);
 184             action.context = res.context;
 185             self.session.get_file({
 186                 url: '/web/report',
 187                 data: {action: JSON.stringify(action)},
 188                 complete: $.unblockUI,
 189                 success: function(){
 190                     if (!self.dialog && on_closed) {
 191                         on_closed();
 192                     }
 193                     self.dialog_stop();
 194                 },
 195                 error: instance.webclient.crashmanager.on_rpc_error
 196             })
 197         });
 198     },
 199     ir_actions_act_url: function (action) {
 200         window.open(action.url, action.target === 'self' ? '_self' : '_blank');
 201     },
 202     ir_ui_menu: function (action) {
 203         this.getParent().do_action(action);
 204     }
 205 });
 206
 207 instance.web.ViewManager =  instance.web.Widget.extend({
 208     template: "ViewManager",
 209     init: function(parent, dataset, views, flags) {
 210         this._super(parent);
 211         this.model = dataset ? dataset.model : undefined;
 212         this.dataset = dataset;
 213         this.searchview = null;
 214         this.active_view = null;
 215         this.views_src = _.map(views, function(x) {
 216             if (x instanceof Array) {
 217                 var View = instance.web.views.get_object(x[1], true);
 218                 return {
 219                     view_id: x[0],
 220                     view_type: x[1],
 221                     label: View ? View.prototype.display_name : (void 'nope')
 222                 };
 223             } else {
 224                 return x;
 225             }
 226         });
 227         this.views = {};
 228         this.flags = flags || {};
 229         this.registry = instance.web.views;
 230         this.views_history = [];
 231     },
 232     /**
 233      * @returns {jQuery.Deferred} initial view loading promise
 234      */
 235     start: function() {
 236         this._super();
 237         var self = this;
 238         this.$element.find('.oe_view_manager_switch a').click(function() {
 239             self.on_mode_switch($(this).data('view-type'));
 240         }).tipsy();
 241         var views_ids = {};
 242         _.each(this.views_src, function(view) {
 243             self.views[view.view_type] = $.extend({}, view, {
 244                 deferred : $.Deferred(),
 245                 controller : null,
 246                 options : _.extend({
 247                     $buttons : self.$element.find('.oe_view_manager_buttons'),
 248                     $sidebar : self.flags.sidebar ? self.$element.find('.oe_view_manager_sidebar') : undefined,
 249                     $pager : self.$element.find('.oe_view_manager_pager'),
 250                     action : self.action,
 251                     action_views_ids : views_ids
 252                 }, self.flags, self.flags[view.view_type] || {}, view.options || {})
 253             });
 254             views_ids[view.view_type] = view.view_id;
 255         });
 256         if (this.flags.views_switcher === false) {
 257             this.$element.find('.oe_view_manager_switch').hide();
 258         }
 259         // If no default view defined, switch to the first one in sequence
 260         var default_view = this.flags.default_view || this.views_src[0].view_type;
 261         return this.on_mode_switch(default_view);
 262     },
 263     /**
 264      * Asks the view manager to switch visualization mode.
 265      *
 266      * @param {String} view_type type of view to display
 267      * @param {Boolean} [no_store=false] don't store the view being switched to on the switch stack
 268      * @returns {jQuery.Deferred} new view loading promise
 269      */
 270     on_mode_switch: function(view_type, no_store) {
 271         var self = this;
 272         var view = this.views[view_type];
 273         var view_promise;
 274         if(!view)
 275             return $.Deferred().reject();
 276
 277         if (!no_store) {
 278             this.views_history.push(view_type);
 279         }
 280         this.active_view = view_type;
 281
 282         if (!view.controller) {
 283             // Lazy loading of views
 284             var controllerclass = this.registry.get_object(view_type);
 285             var options = _.clone(view.options);
 286             if (view_type === "form" && this.action) {
 287                 switch (this.action.target) {
 288                     case 'new':
 289                     case 'inline':
 290                         options.initial_mode = 'edit';
 291                         break;
 292                 }
 293             }
 294             var controller = new controllerclass(this, this.dataset, view.view_id, options);
 295             if (view.embedded_view) {
 296                 controller.set_embedded_view(view.embedded_view);
 297             }
 298             controller.do_switch_view.add_last(this.on_mode_switch);
 299             controller.do_prev_view.add_last(this.on_prev_view);
 300             var container = this.$element.find(".oe_view_manager_view_" + view_type);
 301             view_promise = controller.appendTo(container);
 302             this.views[view_type].controller = controller;
 303             this.views[view_type].deferred.resolve(view_type);
 304             $.when(view_promise).then(function() {
 305                 self.on_controller_inited(view_type, controller);
 306                 if (self.searchview
 307                         && self.flags.auto_search
 308                         && view.controller.searchable !== false) {
 309                     self.searchview.ready.then(self.searchview.do_search);
 310                 }
 311             });
 312         } else if (this.searchview
 313                 && self.flags.auto_search
 314                 && view.controller.searchable !== false) {
 315             this.searchview.ready.then(this.searchview.do_search);
 316         }
 317
 318         if (this.searchview) {
 319             this.searchview[(view.controller.searchable === false || this.searchview.hidden) ? 'hide' : 'show']();
 320         }
 321
 322         this.$element
 323             .find('.oe_view_manager_switch a').parent().removeClass('active')
 324         this.$element
 325             .find('.oe_view_manager_switch a').filter('[data-view-type="' + view_type + '"]')
 326             .parent().addClass('active');
 327
 328         $.when(view_promise).then(function () {
 329             _.each(_.keys(self.views), function(view_name) {
 330                 var controller = self.views[view_name].controller;
 331                 if (controller) {
 332                     if (view_name === view_type) {
 333                         controller.do_show();
 334                     } else {
 335                         controller.do_hide();
 336                     }
 337                 }
 338             });
 339
 340             self.$element.find('.oe_view_title_text:first').text(
 341                     self.display_title());
 342         });
 343         return view_promise;
 344     },
 345     /**
 346      * Returns to the view preceding the caller view in this manager's
 347      * navigation history (the navigation history is appended to via
 348      * on_mode_switch)
 349      *
 350      * @param {Object} [options]
 351      * @param {Boolean} [options.created=false] resource was created
 352      * @param {String} [options.default=null] view to switch to if no previous view
 353      * @returns {$.Deferred} switching end signal
 354      */
 355     on_prev_view: function (options) {
 356         options = options || {};
 357         var current_view = this.views_history.pop();
 358         var previous_view = this.views_history[this.views_history.length - 1] || options['default'];
 359         if (options.created && current_view === 'form' && previous_view === 'list') {
 360             // APR special case: "If creation mode from list (and only from a list),
 361             // after saving, go to page view (don't come back in list)"
 362             return this.on_mode_switch('form');
 363         } else if (options.created && !previous_view && this.action && this.action.flags.default_view === 'form') {
 364             // APR special case: "If creation from dashboard, we have no previous view
 365             return this.on_mode_switch('form');
 366         }
 367         return this.on_mode_switch(previous_view, true);
 368     },
 369     /**
 370      * Sets up the current viewmanager's search view.
 371      *
 372      * @param {Number|false} view_id the view to use or false for a default one
 373      * @returns {jQuery.Deferred} search view startup deferred
 374      */
 375     setup_search_view: function(view_id, search_defaults) {
 376         var self = this;
 377         if (this.searchview) {
 378             this.searchview.destroy();
 379         }
 380         this.searchview = new instance.web.SearchView(this, this.dataset, view_id, search_defaults, this.flags.search_view === false);
 381
 382         this.searchview.on_search.add(this.do_searchview_search);
 383         return this.searchview.appendTo(this.$element.find(".oe_view_manager_view_search"));
 384     },
 385     do_searchview_search: function(domains, contexts, groupbys) {
 386         var self = this,
 387             controller = this.views[this.active_view].controller,
 388             action_context = this.action.context || {};
 389         this.rpc('/web/session/eval_domain_and_context', {
 390             domains: [this.action.domain || []].concat(domains || []),
 391             contexts: [action_context].concat(contexts || []),
 392             group_by_seq: groupbys || []
 393         }, function (results) {
 394             self.dataset._model = new instance.web.Model(
 395                 self.dataset.model, results.context, results.domain);
 396             var groupby = results.group_by.length
 397                         ? results.group_by
 398                         : action_context.group_by;
 399             if (_.isString(groupby)) {
 400                 groupby = [groupby];
 401             }
 402             controller.do_search(results.domain, results.context, groupby || []);
 403         });
 404     },
 405     /**
 406      * Event launched when a controller has been inited.
 407      *
 408      * @param {String} view_type type of view
 409      * @param {String} view the inited controller
 410      */
 411     on_controller_inited: function(view_type, view) {
 412     },
 413     /**
 414      * Called when one of the view want to execute an action
 415      */
 416     on_action: function(action) {
 417     },
 418     on_create: function() {
 419     },
 420     on_remove: function() {
 421     },
 422     on_edit: function() {
 423     },
 424     /**
 425      * Called by children view after executing an action
 426      */
 427     on_action_executed: function () {
 428     },
 429     display_title: function () {
 430         var view = this.views[this.active_view];
 431         if (view) {
 432             // ick
 433             return view.controller.fields_view.arch.attrs.string;
 434         }
 435         return '';
 436     }
 437 });
 438
 439 instance.web.ViewManagerAction = instance.web.ViewManager.extend({
 440     template:"ViewManagerAction",
 441     /**
 442      * @constructs instance.web.ViewManagerAction
 443      * @extends instance.web.ViewManager
 444      *
 445      * @param {instance.web.ActionManager} parent parent object/widget
 446      * @param {Object} action descriptor for the action this viewmanager needs to manage its views.
 447      */
 448     init: function(parent, action) {
 449         // dataset initialization will take the session from ``this``, so if we
 450         // do not have it yet (and we don't, because we've not called our own
 451         // ``_super()``) rpc requests will blow up.
 452         var flags = action.flags || {};
 453         if (!('auto_search' in flags)) {
 454             flags.auto_search = action.auto_search !== false;
 455         }
 456         if (action.res_model == 'board.board' && action.view_mode === 'form') {
 457             // Special case for Dashboards
 458             _.extend(flags, {
 459                 views_switcher : false,
 460                 display_title : false,
 461                 search_view : false,
 462                 pager : false,
 463                 sidebar : false,
 464                 action_buttons : false
 465             });
 466         }
 467         this._super(parent, null, action.views, flags);
 468         this.session = parent.session;
 469         this.action = action;
 470         var dataset = new instance.web.DataSetSearch(this, action.res_model, action.context, action.domain);
 471         if (action.res_id) {
 472             dataset.ids.push(action.res_id);
 473             dataset.index = 0;
 474         }
 475         this.dataset = dataset;
 476
 477         // setup storage for session-wise menu hiding
 478         if (this.session.hidden_menutips) {
 479             return;
 480         }
 481         this.session.hidden_menutips = {}
 482     },
 483     /**
 484      * Initializes the ViewManagerAction: sets up the searchview (if the
 485      * searchview is enabled in the manager's action flags), calls into the
 486      * parent to initialize the primary view and (if the VMA has a searchview)
 487      * launches an initial search after both views are done rendering.
 488      */
 489     start: function() {
 490         var self = this,
 491             searchview_loaded,
 492             search_defaults = {};
 493         _.each(this.action.context, function (value, key) {
 494             var match = /^search_default_(.*)$/.exec(key);
 495             if (match) {
 496                 search_defaults[match[1]] = value;
 497             }
 498         });
 499         // init search view
 500         var searchview_id = this.action['search_view_id'] && this.action['search_view_id'][0];
 501
 502         searchview_loaded = this.setup_search_view(searchview_id || false, search_defaults);
 503
 504         var main_view_loaded = this._super();
 505
 506         var manager_ready = $.when(searchview_loaded, main_view_loaded);
 507
 508         this.$element.find('.oe_debug_view').change(this.on_debug_changed);
 509
 510         if (this.action.help && !this.flags.low_profile) {
 511             var Users = new instance.web.DataSet(self, 'res.users'),
 512                 $tips = this.$element.find('.oe_view_manager_menu_tips');
 513             $tips.delegate('blockquote button', 'click', function() {
 514                 var $this = $(this);
 515                 //noinspection FallthroughInSwitchStatementJS
 516                 switch ($this.attr('name')) {
 517                 case 'disable':
 518                     Users.write(self.session.uid, {menu_tips:false});
 519                 case 'hide':
 520                     $this.closest('blockquote').hide();
 521                     self.session.hidden_menutips[self.action.id] = true;
 522                 }
 523             });
 524             if (!(self.action.id in self.session.hidden_menutips)) {
 525                 Users.read_ids([this.session.uid], ['menu_tips']).then(function(users) {
 526                     var user = users[0];
 527                     if (!(user && user.id === self.session.uid)) {
 528                         return;
 529                     }
 530                     $tips.find('blockquote').toggle(user.menu_tips);
 531                 });
 532             }
 533         }
 534
 535         return manager_ready;
 536     },
 537     on_debug_changed: function (evt) {
 538         var self = this,
 539             $sel = $(evt.currentTarget),
 540             $option = $sel.find('option:selected'),
 541             val = $sel.val(),
 542             current_view = this.views[this.active_view].controller;
 543         switch (val) {
 544             case 'fvg':
 545                 var dialog = new instance.web.Dialog(this, { title: _t("Fields View Get"), width: '95%' }).open();
 546                 $('<pre>').text(instance.web.json_node_to_xml(current_view.fields_view.arch, true)).appendTo(dialog.$element);
 547                 break;
 548             case 'perm_read':
 549                 var ids = current_view.get_selected_ids();
 550                 if (ids.length === 1) {
 551                     this.dataset.call('perm_read', [ids]).then(function(result) {
 552                         var dialog = new instance.web.Dialog(this, {
 553                             title: _.str.sprintf(_t("View Log (%s)"), self.dataset.model),
 554                             width: 400
 555                         }, QWeb.render('ViewManagerDebugViewLog', {
 556                             perm : result[0],
 557                             format : instance.web.format_value
 558                         })).open();
 559                     });
 560                 }
 561                 break;
 562             case 'toggle_layout_outline':
 563                 current_view.rendering_engine.toggle_layout_debugging();
 564                 break;
 565             case 'fields':
 566                 this.dataset.call_and_eval(
 567                         'fields_get', [false, {}], null, 1).then(function (fields) {
 568                     var $root = $('<dl>');
 569                     _(fields).each(function (attributes, name) {
 570                         $root.append($('<dt>').append($('<h4>').text(name)));
 571                         var $attrs = $('<dl>').appendTo(
 572                                 $('<dd>').appendTo($root));
 573                         _(attributes).each(function (def, name) {
 574                             if (def instanceof Object) {
 575                                 def = JSON.stringify(def);
 576                             }
 577                             $attrs
 578                                 .append($('<dt>').text(name))
 579                                 .append($('<dd style="white-space: pre-wrap;">').text(def));
 580                         });
 581                     });
 582                     new instance.web.Dialog(self, {
 583                         title: _.str.sprintf(_t("Model %s fields"),
 584                                              self.dataset.model),
 585                         width: '95%'}, $root).open();
 586                 });
 587                 break;
 588             case 'manage_views':
 589                 if (current_view.fields_view && current_view.fields_view.arch) {
 590                     var view_editor = new instance.web.ViewEditor(current_view, current_view.$element, this.dataset, current_view.fields_view.arch);
 591                     view_editor.start();
 592                 } else {
 593                     this.do_warn(_t("Manage Views"),
 594                             _t("Could not find current view declaration"));
 595                 }
 596                 break;
 597             case 'edit_workflow':
 598                 return this.do_action({
 599                     res_model : 'workflow',
 600                     domain : [['osv', '=', this.dataset.model]],
 601                     views: [[false, 'list'], [false, 'form'], [false, 'diagram']],
 602                     type : 'ir.actions.act_window',
 603                     view_type : 'list',
 604                     view_mode : 'list'
 605                 });
 606                 break;
 607             case 'edit':
 608                 this.do_edit_resource($option.data('model'), $option.data('id'), { name : $option.text() });
 609                 break;
 610             default:
 611                 if (val) {
 612                     console.log("No debug handler for ", val);
 613                 }
 614         }
 615         evt.currentTarget.selectedIndex = 0;
 616     },
 617     do_edit_resource: function(model, id, action) {
 618         var action = _.extend({
 619             res_model : model,
 620             res_id : id,
 621             type : 'ir.actions.act_window',
 622             view_type : 'form',
 623             view_mode : 'form',
 624             views : [[false, 'form']],
 625             target : 'new',
 626             flags : {
 627                 action_buttons : true,
 628                 form : {
 629                     resize_textareas : true
 630                 }
 631             }
 632         }, action || {});
 633         this.do_action(action);
 634     },
 635     on_mode_switch: function (view_type, no_store) {
 636         var self = this;
 637
 638         return $.when(this._super(view_type, no_store)).then(function () {
 639             self.shortcut_check(self.views[view_type]);
 640
 641             var controller = self.views[self.active_view].controller,
 642                 fvg = controller.fields_view,
 643                 view_id = (fvg && fvg.view_id) || '--';
 644             self.$element.find('.oe_debug_view').html(QWeb.render('ViewManagerDebug', {
 645                 view: controller,
 646                 view_manager: self
 647             }));
 648             if (!self.action.name && fvg) {
 649                 self.$element.find('.oe_view_title_text').text(fvg.arch.attrs.string || fvg.name);
 650             }
 651
 652         });
 653     },
 654     do_push_state: function(state) {
 655         if (this.getParent() && this.getParent().do_push_state) {
 656             state["view_type"] = this.active_view;
 657             this.getParent().do_push_state(state);
 658         }
 659     },
 660     do_load_state: function(state, warm) {
 661         var self = this,
 662             defs = [];
 663         if (state.view_type && state.view_type !== this.active_view) {
 664             defs.push(
 665                 this.views[this.active_view].deferred.pipe(function() {
 666                     return self.on_mode_switch(state.view_type, true);
 667                 })
 668             );
 669         }
 670
 671         $.when(defs).then(function() {
 672             self.views[self.active_view].controller.do_load_state(state, warm);
 673         });
 674     },
 675     shortcut_check : function(view) {
 676         var self = this;
 677         var grandparent = this.getParent() && this.getParent().getParent();
 678         // display shortcuts if on the first view for the action
 679         var $shortcut_toggle = this.$element.find('.oe-shortcut-toggle');
 680         if (!this.action.name ||
 681             !(view.view_type === this.views_src[0].view_type
 682                 && view.view_id === this.views_src[0].view_id)) {
 683             $shortcut_toggle.hide();
 684             return;
 685         }
 686         $shortcut_toggle.removeClass('oe-shortcut-remove').show();
 687         if (_(this.session.shortcuts).detect(function (shortcut) {
 688                     return shortcut.res_id === self.session.active_id; })) {
 689             $shortcut_toggle.addClass("oe-shortcut-remove");
 690         }
 691         this.shortcut_add_remove();
 692     },
 693     shortcut_add_remove: function() {
 694         var self = this;
 695         var $shortcut_toggle = this.$element.find('.oe-shortcut-toggle');
 696         $shortcut_toggle
 697             .unbind("click")
 698             .click(function() {
 699                 if ($shortcut_toggle.hasClass("oe-shortcut-remove")) {
 700                     $(self.session.shortcuts.binding).trigger('remove-current');
 701                     $shortcut_toggle.removeClass("oe-shortcut-remove");
 702                 } else {
 703                     $(self.session.shortcuts.binding).trigger('add', {
 704                         'user_id': self.session.uid,
 705                         'res_id': self.session.active_id,
 706                         'resource': 'ir.ui.menu',
 707                         'name': self.action.name
 708                     });
 709                     $shortcut_toggle.addClass("oe-shortcut-remove");
 710                 }
 711             });
 712     },
 713     display_title: function () {
 714         return this.action.name;
 715     }
 716 });
 717
 718 instance.web.Sidebar = instance.web.Widget.extend({
 719     init: function(parent) {
 720         this._super(parent);
 721         var view = this.getParent();
 722         this.sections = [
 723             { 'name' : 'print', 'label' : _t('Print'), },
 724             { 'name' : 'files', 'label' : _t('Attachement'), },
 725             { 'name' : 'other', 'label' : _t('More'), }
 726         ];
 727         this.items = {
 728             'print' : [],
 729             'files' : [],
 730             'other' : [
 731                     { label: _t("Import"), callback: view.on_sidebar_import },
 732                     { label: _t("Export"), callback: view.on_sidebar_export }
 733             ]
 734         }
 735         if (this.session.uid === 1) {
 736             var item = { label: _t("Translate"), callback: view.on_sidebar_translate, title: _t("Technical translation") };
 737             this.items.other.push(item);
 738         }
 739     },
 740     start: function() {
 741         var self = this;
 742         this._super(this);
 743         this.redraw();
 744         this.$element.on('click','.oe_dropdown_toggle',function(event) {
 745             $(this).parent().find('ul').toggle();
 746             return false;
 747         });
 748         this.$element.on('click','.oe_dropdown_menu li a', function(event) {
 749             var section = $(this).data('section');
 750             var index = $(this).data('index');
 751             $(this).closest('ul').hide();
 752             var item = self.items[section][index];
 753             if (item.callback) {
 754                 item.callback.apply(self, [item]);
 755             } else if (item.action) {
 756                 self.on_item_action_clicked(item);
 757             } else if (item.url) {
 758                 return true;
 759             }
 760             return false;
 761         });
 762         //this.$div.html(QWeb.render('FormView.sidebar.attachments', this));
 763         //this.$element.find('.oe-binary-file').change(this.on_attachment_changed);
 764         //this.$element.find('.oe-sidebar-attachment-delete').click(this.on_attachment_delete);
 765     },
 766     redraw: function() {
 767         var self = this;
 768         self.$element.html(QWeb.render('Sidebar', {widget: self}));
 769         this.$element.find('ul').hide();
 770     },
 771     /**
 772      * For each item added to the section:
 773      *
 774      * ``label``
 775      *     will be used as the item's name in the sidebar, can be html
 776      *
 777      * ``action``
 778      *     descriptor for the action which will be executed, ``action`` and
 779      *     ``callback`` should be exclusive
 780      *
 781      * ``callback``
 782      *     function to call when the item is clicked in the sidebar, called
 783      *     with the item descriptor as its first argument (so information
 784      *     can be stored as additional keys on the object passed to
 785      *     ``add_items``)
 786      *
 787      * ``classname`` (optional)
 788      *     ``@class`` set on the sidebar serialization of the item
 789      *
 790      * ``title`` (optional)
 791      *     will be set as the item's ``@title`` (tooltip)
 792      *
 793      * @param {String} section_code
 794      * @param {Array<{label, action | callback[, classname][, title]}>} items
 795      */
 796     add_items: function(section_code, items) {
 797         var self = this;
 798         if (items) {
 799             this.items[section_code].push.apply(this.items[section_code],items);
 800             this.redraw();
 801         }
 802     },
 803     add_toolbar: function(toolbar) {
 804         var self = this;
 805         _.each(['print','action','relate'], function(type) {
 806             var items = toolbar[type];
 807             if (items) {
 808                 for (var i = 0; i < items.length; i++) {
 809                     items[i] = {
 810                         label: items[i]['name'],
 811                         action: items[i],
 812                         classname: 'oe_sidebar_' + type
 813                     }
 814                 }
 815                 self.add_items(type=='print' ? 'print' : 'other', items);
 816             }
 817         });
 818     },
 819     on_item_action_clicked: function(item) {
 820         var self = this;
 821         self.getParent().sidebar_context().then(function (context) {
 822             var ids = self.getParent().get_selected_ids();
 823             if (ids.length == 0) {
 824                 instance.web.dialog($("<div />").text(_t("You must choose at least one record.")), { title: _t("Warning"), modal: true });
 825                 return false;
 826             }
 827             var additional_context = _.extend({
 828                 active_id: ids[0],
 829                 active_ids: ids,
 830                 active_model: self.getParent().dataset.model
 831             }, context);
 832             self.rpc("/web/action/load", {
 833                 action_id: item.action.id,
 834                 context: additional_context
 835             }, function(result) {
 836                 result.result.context = _.extend(result.result.context || {},
 837                     additional_context);
 838                 result.result.flags = result.result.flags || {};
 839                 result.result.flags.new_window = true;
 840                 self.do_action(result.result, function () {
 841                     // reload view
 842                     self.getParent().reload();
 843                 });
 844             });
 845         });
 846     },
 847     do_attachement_update: function(dataset, model_id) {
 848         if (!model_id) {
 849             this.on_attachments_loaded([]);
 850         } else {
 851             var dom = [ ['res_model', '=', dataset.model], ['res_id', '=', model_id], ['type', 'in', ['binary', 'url']] ];
 852             var ds = new instance.web.DataSetSearch(this, 'ir.attachment', dataset.get_context(), dom);
 853             ds.read_slice(['name', 'url', 'type'], {}).then(this.on_attachments_loaded);
 854         }
 855     },
 856     on_attachments_loaded: function(attachments) {
 857         var self = this;
 858         var items = [];
 859         // TODO: preprend: _s +
 860         var prefix = '/web/binary/saveas?session_id=' + self.session.session_id + '&model=ir.attachment&field=datas&filename_field=name&id=';
 861         _.each(attachments,function(a) {
 862             a.label = a.name;
 863             if(a.type === "binary") {
 864                 a.url = prefix  + a.id + '&t=' + (new Date().getTime());
 865             }
 866         });
 867         attachments.push( { label: _t("Add..."), callback: self.on_attachment_add } );
 868         self.items['files'] = attachments;
 869         self.redraw();
 870     },
 871     on_attachment_add: function(e) {
 872         this.$element.find('.oe_sidebar_add').show();
 873     },
 874     on_attachment_changed: function(e) {
 875         return;
 876         window[this.element_id + '_iframe'] = this.do_update;
 877         var $e = $(e.target);
 878         if ($e.val() != '') {
 879             this.$element.find('form.oe-binary-form').submit();
 880             $e.parent().find('input[type=file]').prop('disabled', true);
 881             $e.parent().find('button').prop('disabled', true).find('img, span').toggle();
 882         }
 883     },
 884     on_attachment_delete: function(e) {
 885         return;
 886         var self = this, $e = $(e.currentTarget);
 887         var name = _.str.trim($e.parent().find('a.oe-sidebar-attachments-link').text());
 888         if (confirm(_.str.sprintf(_t("Do you really want to delete the attachment %s?"), name))) {
 889             this.rpc('/web/dataset/unlink', {
 890                 model: 'ir.attachment',
 891                 ids: [parseInt($e.attr('data-id'))]
 892             }, function(r) {
 893                 $e.parent().remove();
 894                 self.do_notify("Delete an attachment", "The attachment '" + name + "' has been deleted");
 895             });
 896         }
 897     }
 898 });
 899
 900 instance.web.TranslateDialog = instance.web.Dialog.extend({
 901     dialog_title: {toString: function () { return _t("Translations"); }},
 902     init: function(view) {
 903         // TODO fme: should add the language to fields_view_get because between the fields view get
 904         // and the moment the user opens the translation dialog, the user language could have been changed
 905         this.view_language = view.session.user_context.lang;
 906         this['on_button' + _t("Save")] = this.on_button_Save;
 907         this['on_button' + _t("Close")] = this.on_button_Close;
 908         this._super(view, {
 909             width: '80%',
 910             height: '80%'
 911         });
 912         this.view = view;
 913         this.view_type = view.fields_view.type || '';
 914         this.$fields_form = null;
 915         this.$view_form = null;
 916         this.$sidebar_form = null;
 917         this.translatable_fields_keys = _.map(this.view.translatable_fields || [], function(i) { return i.name });
 918         this.languages = null;
 919         this.languages_loaded = $.Deferred();
 920         (new instance.web.DataSetSearch(this, 'res.lang', this.view.dataset.get_context(),
 921             [['translatable', '=', '1']])).read_slice(['code', 'name'], { sort: 'id' }).then(this.on_languages_loaded);
 922     },
 923     start: function() {
 924         var self = this;
 925         this._super();
 926         $.when(this.languages_loaded).then(function() {
 927             self.$element.html(instance.web.qweb.render('TranslateDialog', { widget: self }));
 928             self.$fields_form = self.$element.find('.oe_translation_form');
 929             self.$fields_form.find('.oe_trad_field').change(function() {
 930                 $(this).toggleClass('touched', ($(this).val() != $(this).attr('data-value')));
 931             });
 932         });
 933         return this;
 934     },
 935     on_languages_loaded: function(langs) {
 936         this.languages = langs;
 937         this.languages_loaded.resolve();
 938     },
 939     do_load_fields_values: function(callback) {
 940         var self = this,
 941             deffered = [];
 942         this.$fields_form.find('.oe_trad_field').val('').removeClass('touched');
 943         _.each(self.languages, function(lg) {
 944             var deff = $.Deferred();
 945             deffered.push(deff);
 946             var callback = function(values) {
 947                 _.each(self.translatable_fields_keys, function(f) {
 948                     self.$fields_form.find('.oe_trad_field[name="' + lg.code + '-' + f + '"]').val(values[0][f] || '').attr('data-value', values[0][f] || '');
 949                 });
 950                 deff.resolve();
 951             };
 952             if (lg.code === self.view_language) {
 953                 var values = {};
 954                 _.each(self.translatable_fields_keys, function(field) {
 955                     values[field] = self.view.fields[field].get_value();
 956                 });
 957                 callback([values]);
 958             } else {
 959                 self.rpc('/web/dataset/get', {
 960                     model: self.view.dataset.model,
 961                     ids: [self.view.datarecord.id],
 962                     fields: self.translatable_fields_keys,
 963                     context: self.view.dataset.get_context({
 964                         'lang': lg.code
 965                     })}, callback);
 966             }
 967         });
 968         $.when.apply(null, deffered).then(callback);
 969     },
 970     open: function(field) {
 971         var self = this,
 972             sup = this._super;
 973         $.when(this.languages_loaded).then(function() {
 974             if (self.view.translatable_fields && self.view.translatable_fields.length) {
 975                 self.do_load_fields_values(function() {
 976                     sup.call(self);
 977                     if (field) {
 978                         var $field_input = self.$element.find('tr[data-field="' + field.name + '"] td:nth-child(2) *:first-child');
 979                         self.$element.scrollTo($field_input);
 980                         $field_input.focus();
 981                     }
 982                 });
 983             } else {
 984                 sup.call(self);
 985             }
 986         });
 987     },
 988     on_button_Save: function() {
 989         var trads = {},
 990             self = this,
 991             trads_mutex = new $.Mutex();
 992         self.$fields_form.find('.oe_trad_field.touched').each(function() {
 993             var field = $(this).attr('name').split('-');
 994             if (!trads[field[0]]) {
 995                 trads[field[0]] = {};
 996             }
 997             trads[field[0]][field[1]] = $(this).val();
 998         });
 999         _.each(trads, function(data, code) {
1000             if (code === self.view_language) {
1001                 _.each(data, function(value, field) {
1002                     self.view.fields[field].set_value(value);
1003                 });
1004             }
1005             trads_mutex.exec(function() {
1006                 return self.view.dataset.write(self.view.datarecord.id, data, { context : { 'lang': code } });
1007             });
1008         });
1009         this.close();
1010     },
1011     on_button_Close: function() {
1012         this.close();
1013     }
1014 });
1015
1016 instance.web.View = instance.web.Widget.extend({
1017     template: "EmptyComponent",
1018     // name displayed in view switchers
1019     display_name: '',
1020     /**
1021      * Define a view type for each view to allow automatic call to fields_view_get.
1022      */
1023     view_type: undefined,
1024     init: function(parent, dataset, view_id, options) {
1025         this._super(parent);
1026         this.dataset = dataset;
1027         this.view_id = view_id;
1028         this.set_default_options(options);
1029     },
1030     start: function() {
1031         return this.load_view();
1032     },
1033     load_view: function() {
1034         if (this.embedded_view) {
1035             var def = $.Deferred();
1036             var self = this;
1037             $.async_when().then(function() {def.resolve(self.embedded_view);});
1038             return def.pipe(this.on_loaded);
1039         } else {
1040             var context = new instance.web.CompoundContext(this.dataset.get_context());
1041             if (! this.view_type)
1042                 console.warn("view_type is not defined", this);
1043             return this.rpc("/web/view/load", {
1044                 "model": this.dataset.model,
1045                 "view_id": this.view_id,
1046                 "view_type": this.view_type,
1047                 toolbar: !!this.options.$sidebar,
1048                 context: context
1049                 }).pipe(this.on_loaded);
1050         }
1051     },
1052     /**
1053      * Called after a successful call to fields_view_get.
1054      * Must return a promise.
1055      */
1056     on_loaded: function(fields_view_get) {
1057     },
1058     set_default_options: function(options) {
1059         this.options = options || {};
1060         _.defaults(this.options, {
1061             // All possible views options should be defaulted here
1062             $sidebar: null,
1063             sidebar_id: null,
1064             action: null,
1065             action_views_ids: {}
1066         });
1067     },
1068     open_translate_dialog: function(field) {
1069         if (!this.translate_dialog) {
1070             this.translate_dialog = new instance.web.TranslateDialog(this).start();
1071         }
1072         this.translate_dialog.open(field);
1073     },
1074     /**
1075      * Fetches and executes the action identified by ``action_data``.
1076      *
1077      * @param {Object} action_data the action descriptor data
1078      * @param {String} action_data.name the action name, used to uniquely identify the action to find and execute it
1079      * @param {String} [action_data.special=null] special action handlers (currently: only ``'cancel'``)
1080      * @param {String} [action_data.type='workflow'] the action type, if present, one of ``'object'``, ``'action'`` or ``'workflow'``
1081      * @param {Object} [action_data.context=null] additional action context, to add to the current context
1082      * @param {instance.web.DataSet} dataset a dataset object used to communicate with the server
1083      * @param {Object} [record_id] the identifier of the object on which the action is to be applied
1084      * @param {Function} on_closed callback to execute when dialog is closed or when the action does not generate any result (no new action)
1085      */
1086     do_execute_action: function (action_data, dataset, record_id, on_closed) {
1087         var self = this;
1088         var result_handler = function () {
1089             if (on_closed) { on_closed.apply(null, arguments); }
1090             if (self.getParent() && self.getParent().on_action_executed) {
1091                 return self.getParent().on_action_executed.apply(null, arguments);
1092             }
1093         };
1094         var context = new instance.web.CompoundContext(dataset.get_context(), action_data.context || {});
1095
1096         var handler = function (r) {
1097             var action = r.result;
1098             if (action && action.constructor == Object) {
1099                 var ncontext = new instance.web.CompoundContext(context);
1100                 if (record_id) {
1101                     ncontext.add({
1102                         active_id: record_id,
1103                         active_ids: [record_id],
1104                         active_model: dataset.model
1105                     });
1106                 }
1107                 ncontext.add(action.context || {});
1108                 return self.rpc('/web/session/eval_domain_and_context', {
1109                     contexts: [ncontext],
1110                     domains: []
1111                 }).pipe(function (results) {
1112                     action.context = results.context;
1113                     /* niv: previously we were overriding once more with action_data.context,
1114                      * I assumed this was not a correct behavior and removed it
1115                      */
1116                     return self.do_action(action, result_handler);
1117                 }, null);
1118             } else {
1119                 return result_handler();
1120             }
1121         };
1122
1123         if (action_data.special) {
1124             return handler({result: {"type":"ir.actions.act_window_close"}});
1125         } else if (action_data.type=="object") {
1126             var args = [[record_id]], additional_args = [];
1127             if (action_data.args) {
1128                 try {
1129                     // Warning: quotes and double quotes problem due to json and xml clash
1130                     // Maybe we should force escaping in xml or do a better parse of the args array
1131                     additional_args = JSON.parse(action_data.args.replace(/'/g, '"'));
1132                     args = args.concat(additional_args);
1133                 } catch(e) {
1134                     console.error("Could not JSON.parse arguments", action_data.args);
1135                 }
1136             }
1137             args.push(context);
1138             return dataset.call_button(action_data.name, args, handler);
1139         } else if (action_data.type=="action") {
1140             return this.rpc('/web/action/load', { action_id: parseInt(action_data.name, 10), context: context, do_not_eval: true}, handler);
1141         } else  {
1142             return dataset.exec_workflow(record_id, action_data.name, handler);
1143         }
1144     },
1145     /**
1146      * Directly set a view to use instead of calling fields_view_get. This method must
1147      * be called before start(). When an embedded view is set, underlying implementations
1148      * of instance.web.View must use the provided view instead of any other one.
1149      *
1150      * @param embedded_view A view.
1151      */
1152     set_embedded_view: function(embedded_view) {
1153         this.embedded_view = embedded_view;
1154     },
1155     do_show: function () {
1156         this.$element.show();
1157     },
1158     do_hide: function () {
1159         this.$element.hide();
1160     },
1161     do_push_state: function(state) {
1162         if (this.getParent() && this.getParent().do_push_state) {
1163             this.getParent().do_push_state(state);
1164         }
1165     },
1166     do_load_state: function(state, warm) {
1167     },
1168     /**
1169      * Switches to a specific view type
1170      *
1171      * @param {String} view view type to switch to
1172      */
1173     do_switch_view: function(view) {
1174     },
1175     /**
1176      * Cancels the switch to the current view, switches to the previous one
1177      *
1178      * @param {Object} [options]
1179      * @param {Boolean} [options.created=false] resource was created
1180      * @param {String} [options.default=null] view to switch to if no previous view
1181      */
1182     do_prev_view: function (options) {
1183     },
1184     do_search: function(view) {
1185     },
1186     on_sidebar_import: function() {
1187         var import_view = new instance.web.DataImport(this, this.dataset);
1188         import_view.start();
1189     },
1190     on_sidebar_export: function() {
1191         var export_view = new instance.web.DataExport(this, this.dataset);
1192         export_view.start();
1193     },
1194     on_sidebar_translate: function() {
1195         return this.do_action({
1196             res_model : 'ir.translation',
1197             domain : [['type', '!=', 'object'], '|', ['name', '=', this.dataset.model], ['name', 'ilike', this.dataset.model + ',']],
1198             views: [[false, 'list'], [false, 'form']],
1199             type : 'ir.actions.act_window',
1200             view_type : "list",
1201             view_mode : "list"
1202         });
1203     },
1204     sidebar_context: function () {
1205         return $.when();
1206     },
1207     /**
1208      * Asks the view to reload itself, if the reloading is asynchronous should
1209      * return a {$.Deferred} indicating when the reloading is done.
1210      */
1211     reload: function () {
1212         return $.when();
1213     }
1214 });
1215
1216 instance.web.xml_to_json = function(node) {
1217     switch (node.nodeType) {
1218         case 3:
1219         case 4:
1220             return node.data;
1221         break;
1222         case 1:
1223             var attrs = $(node).getAttributes();
1224             _.each(['domain', 'filter_domain', 'context', 'default_get'], function(key) {
1225                 if (attrs[key]) {
1226                     try {
1227                         attrs[key] = JSON.parse(attrs[key]);
1228                     } catch(e) { }
1229                 }
1230             });
1231             return {
1232                 tag: node.tagName.toLowerCase(),
1233                 attrs: attrs,
1234                 children: _.map(node.childNodes, instance.web.xml_to_json)
1235             }
1236     }
1237 }
1238 instance.web.json_node_to_xml = function(node, human_readable, indent) {
1239     // For debugging purpose, this function will convert a json node back to xml
1240     // Maybe useful for xml view editor
1241     indent = indent || 0;
1242     var sindent = (human_readable ? (new Array(indent + 1).join('\t')) : ''),
1243         r = sindent + '<' + node.tag,
1244         cr = human_readable ? '\n' : '';
1245
1246     if (typeof(node) === 'string') {
1247         return sindent + node;
1248     } else if (typeof(node.tag) !== 'string' || !node.children instanceof Array || !node.attrs instanceof Object) {
1249         throw("Node a json node");
1250     }
1251     for (var attr in node.attrs) {
1252         var vattr = node.attrs[attr];
1253         if (typeof(vattr) !== 'string') {
1254             // domains, ...
1255             vattr = JSON.stringify(vattr);
1256         }
1257         vattr = vattr.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
1258         if (human_readable) {
1259             vattr = vattr.replace(/&quot;/g, "'");
1260         }
1261         r += ' ' + attr + '="' + vattr + '"';
1262     }
1263     if (node.children && node.children.length) {
1264         r += '>' + cr;
1265         var childs = [];
1266         for (var i = 0, ii = node.children.length; i < ii; i++) {
1267             childs.push(instance.web.json_node_to_xml(node.children[i], human_readable, indent + 1));
1268         }
1269         r += childs.join(cr);
1270         r += cr + sindent + '</' + node.tag + '>';
1271         return r;
1272     } else {
1273         return r + '/>';
1274     }
1275 }
1276 instance.web.xml_to_str = function(node) {
1277     if (window.ActiveXObject) {
1278         return node.xml;
1279     } else {
1280         return (new XMLSerializer()).serializeToString(node);
1281     }
1282 }
1283 instance.web.str_to_xml = function(s) {
1284     if (window.DOMParser) {
1285         var dp = new DOMParser();
1286         var r = dp.parseFromString(s, "text/xml");
1287         if (r.body && r.body.firstChild && r.body.firstChild.nodeName == 'parsererror') {
1288             throw new Error("Could not parse string to xml");
1289         }
1290         return r;
1291     }
1292     var xDoc;
1293     try {
1294         xDoc = new ActiveXObject("MSXML2.DOMDocument");
1295     } catch (e) {
1296         throw new Error("Could not find a DOM Parser: " + e.message);
1297     }
1298     xDoc.async = false;
1299     xDoc.preserveWhiteSpace = true;
1300     xDoc.loadXML(s);
1301     return xDoc;
1302 }
1303
1304 /**
1305  * Registry for all the client actions key: tag value: widget
1306  */
1307 instance.web.client_actions = new instance.web.Registry();
1308
1309 /**
1310  * Registry for all the main views
1311  */
1312 instance.web.views = new instance.web.Registry();
1313
1314 };
1315
1316 // vim:et fdc=0 fdl=0 foldnestmax=3 fdm=syntax: