addons/web/static/src/js/core.js

   1 /*---------------------------------------------------------
   2  * OpenERP Web core
   3  *--------------------------------------------------------*/
   4 var console;
   5 if (!console) {
   6     console = {log: function () {}};
   7 }
   8 if (!console.debug) {
   9     console.debug = console.log;
  10 }
  11
  12 openerp.web.core = function(openerp) {
  13 openerp.web.qweb = new QWeb2.Engine();
  14 openerp.web.qweb.debug = (window.location.search.indexOf('?debug') !== -1);
  15 /**
  16  * John Resig Class with factory improvement
  17  */
  18 (function() {
  19     var initializing = false,
  20         fnTest = /xyz/.test(function(){xyz;}) ? /\b_super\b/ : /.*/;
  21     // The web Class implementation (does nothing)
  22     /**
  23      * Extended version of John Resig's Class pattern
  24      *
  25      * @class
  26      */
  27     openerp.web.Class = function(){};
  28
  29     /**
  30      * Subclass an existing class
  31      *
  32      * @param {Object} prop class-level properties (class attributes and instance methods) to set on the new class
  33      */
  34     openerp.web.Class.extend = function(prop) {
  35         var _super = this.prototype;
  36
  37         // Instantiate a web class (but only create the instance,
  38         // don't run the init constructor)
  39         initializing = true;
  40         var prototype = new this();
  41         initializing = false;
  42
  43         // Copy the properties over onto the new prototype
  44         for (var name in prop) {
  45             // Check if we're overwriting an existing function
  46             prototype[name] = typeof prop[name] == "function" &&
  47                               typeof _super[name] == "function" &&
  48                               fnTest.test(prop[name]) ?
  49                     (function(name, fn) {
  50                         return function() {
  51                             var tmp = this._super;
  52
  53                             // Add a new ._super() method that is the same
  54                             // method but on the super-class
  55                             this._super = _super[name];
  56
  57                             // The method only need to be bound temporarily, so
  58                             // we remove it when we're done executing
  59                             var ret = fn.apply(this, arguments);
  60                             this._super = tmp;
  61
  62                             return ret;
  63                         };
  64                     })(name, prop[name]) :
  65                     prop[name];
  66         }
  67
  68         // The dummy class constructor
  69         function Class() {
  70             // All construction is actually done in the init method
  71             if (!initializing && this.init) {
  72                 var ret = this.init.apply(this, arguments);
  73                 if (ret) { return ret; }
  74             }
  75             return this;
  76         }
  77         Class.include = function (properties) {
  78             for (var name in properties) {
  79                 if (typeof properties[name] !== 'function'
  80                         || !fnTest.test(properties[name])) {
  81                     prototype[name] = properties[name];
  82                 } else if (typeof prototype[name] === 'function'
  83                            && prototype.hasOwnProperty(name)) {
  84                     prototype[name] = (function (name, fn, previous) {
  85                         return function () {
  86                             var tmp = this._super;
  87                             this._super = previous;
  88                             var ret = fn.apply(this, arguments);
  89                             this._super = tmp;
  90                             return ret;
  91                         }
  92                     })(name, properties[name], prototype[name]);
  93                 } else if (typeof _super[name] === 'function') {
  94                     prototype[name] = (function (name, fn) {
  95                         return function () {
  96                             var tmp = this._super;
  97                             this._super = _super[name];
  98                             var ret = fn.apply(this, arguments);
  99                             this._super = tmp;
 100                             return ret;
 101                         }
 102                     })(name, properties[name]);
 103                 }
 104             }
 105         };
 106
 107         // Populate our constructed prototype object
 108         Class.prototype = prototype;
 109
 110         // Enforce the constructor to be what we expect
 111         Class.constructor = Class;
 112
 113         // And make this class extendable
 114         Class.extend = arguments.callee;
 115
 116         return Class;
 117     };
 118 })();
 119
 120 openerp.web.callback = function(obj, method) {
 121     var callback = function() {
 122         var args = Array.prototype.slice.call(arguments);
 123         var r;
 124         for(var i = 0; i < callback.callback_chain.length; i++)  {
 125             var c = callback.callback_chain[i];
 126             if(c.unique) {
 127                 callback.callback_chain.splice(i, 1);
 128                 i -= 1;
 129             }
 130             r = c.callback.apply(c.self, c.args.concat(args));
 131             // TODO special value to stop the chain
 132             // openerp.web.callback_stop
 133         }
 134         return r;
 135     };
 136     callback.callback_chain = [];
 137     callback.add = function(f) {
 138         if(typeof(f) == 'function') {
 139             f = { callback: f, args: Array.prototype.slice.call(arguments, 1) };
 140         }
 141         f.self = f.self || null;
 142         f.args = f.args || [];
 143         f.unique = !!f.unique;
 144         if(f.position == 'last') {
 145             callback.callback_chain.push(f);
 146         } else {
 147             callback.callback_chain.unshift(f);
 148         }
 149         return callback;
 150     };
 151     callback.add_first = function(f) {
 152         return callback.add.apply(null,arguments);
 153     };
 154     callback.add_last = function(f) {
 155         return callback.add({
 156             callback: f,
 157             args: Array.prototype.slice.call(arguments, 1),
 158             position: "last"
 159         });
 160     };
 161
 162     return callback.add({
 163         callback: method,
 164         self:obj,
 165         args:Array.prototype.slice.call(arguments, 2)
 166     });
 167 };
 168
 169 /**
 170  * Generates an inherited class that replaces all the methods by null methods (methods
 171  * that does nothing and always return undefined).
 172  *
 173  * @param {Class} claz
 174  * @param {Object} add Additional functions to override.
 175  * @return {Class}
 176  */
 177 openerp.web.generate_null_object_class = function(claz, add) {
 178     var newer = {};
 179     var copy_proto = function(prototype) {
 180         for (var name in prototype) {
 181             if(typeof prototype[name] == "function") {
 182                 newer[name] = function() {};
 183             }
 184         }
 185         if (prototype.prototype)
 186             copy_proto(prototype.prototype);
 187     };
 188     copy_proto(claz.prototype);
 189     newer.init = openerp.web.Widget.prototype.init;
 190     var tmpclass = claz.extend(newer);
 191     return tmpclass.extend(add || {});
 192 };
 193
 194 /**
 195  * web error for lookup failure
 196  *
 197  * @class
 198  */
 199 openerp.web.NotFound = openerp.web.Class.extend( /** @lends openerp.web.NotFound# */ {
 200 });
 201 openerp.web.KeyNotFound = openerp.web.NotFound.extend( /** @lends openerp.web.KeyNotFound# */ {
 202     /**
 203      * Thrown when a key could not be found in a mapping
 204      *
 205      * @constructs openerp.web.KeyNotFound
 206      * @extends openerp.web.NotFound
 207      * @param {String} key the key which could not be found
 208      */
 209     init: function (key) {
 210         this.key = key;
 211     },
 212     toString: function () {
 213         return "The key " + this.key + " was not found";
 214     }
 215 });
 216 openerp.web.ObjectNotFound = openerp.web.NotFound.extend( /** @lends openerp.web.ObjectNotFound# */ {
 217     /**
 218      * Thrown when an object path does not designate a valid class or object
 219      * in the openerp hierarchy.
 220      *
 221      * @constructs openerp.web.ObjectNotFound
 222      * @extends openerp.web.NotFound
 223      * @param {String} path the invalid object path
 224      */
 225     init: function (path) {
 226         this.path = path;
 227     },
 228     toString: function () {
 229         return "Could not find any object of path " + this.path;
 230     }
 231 });
 232 openerp.web.Registry = openerp.web.Class.extend( /** @lends openerp.web.Registry# */ {
 233     /**
 234      * Stores a mapping of arbitrary key (strings) to object paths (as strings
 235      * as well).
 236      *
 237      * Resolves those paths at query time in order to always fetch the correct
 238      * object, even if those objects have been overloaded/replaced after the
 239      * registry was created.
 240      *
 241      * An object path is simply a dotted name from the openerp root to the
 242      * object pointed to (e.g. ``"openerp.web.Session"`` for an OpenERP
 243      * session object).
 244      *
 245      * @constructs openerp.web.Registry
 246      * @param {Object} mapping a mapping of keys to object-paths
 247      */
 248     init: function (mapping) {
 249         this.map = mapping || {};
 250     },
 251     /**
 252      * Retrieves the object matching the provided key string.
 253      *
 254      * @param {String} key the key to fetch the object for
 255      * @returns {Class} the stored class, to initialize
 256      *
 257      * @throws {openerp.web.KeyNotFound} if the object was not in the mapping
 258      * @throws {openerp.web.ObjectNotFound} if the object path was invalid
 259      */
 260     get_object: function (key) {
 261         var path_string = this.map[key];
 262         if (path_string === undefined) {
 263             throw new openerp.web.KeyNotFound(key);
 264         }
 265
 266         var object_match = openerp;
 267         var path = path_string.split('.');
 268         // ignore first section
 269         for(var i=1; i<path.length; ++i) {
 270             object_match = object_match[path[i]];
 271
 272             if (object_match === undefined) {
 273                 throw new openerp.web.ObjectNotFound(path_string);
 274             }
 275         }
 276         return object_match;
 277     },
 278     /**
 279      * Tries a number of keys, and returns the first object matching one of
 280      * the keys.
 281      *
 282      * @param {Array} keys a sequence of keys to fetch the object for
 283      * @returns {Class} the first class found matching an object
 284      *
 285      * @throws {openerp.web.KeyNotFound} if none of the keys was in the mapping
 286      * @trows {openerp.web.ObjectNotFound} if a found object path was invalid
 287      */
 288     get_any: function (keys) {
 289         for (var i=0; i<keys.length; ++i) {
 290             var key = keys[i];
 291             if (key === undefined || !(key in this.map)) {
 292                 continue;
 293             }
 294
 295             return this.get_object(key);
 296         }
 297         throw new openerp.web.KeyNotFound(keys.join(','));
 298     },
 299     /**
 300      * Adds a new key and value to the registry.
 301      *
 302      * This method can be chained.
 303      *
 304      * @param {String} key
 305      * @param {String} object_path fully qualified dotted object path
 306      * @returns {openerp.web.Registry} itself
 307      */
 308     add: function (key, object_path) {
 309         this.map[key] = object_path;
 310         return this;
 311     },
 312     /**
 313      * Creates and returns a copy of the current mapping, with the provided
 314      * mapping argument added in (replacing existing keys if needed)
 315      *
 316      * @param {Object} [mapping={}] a mapping of keys to object-paths
 317      */
 318     clone: function (mapping) {
 319         return new openerp.web.Registry(
 320             _.extend({}, this.map, mapping || {}));
 321     }
 322 });
 323
 324 openerp.web.CallbackEnabled = openerp.web.Class.extend(/** @lends openerp.web.CallbackEnabled# */{
 325     /**
 326      * @constructs openerp.web.CallbackEnabled
 327      * @extends openerp.web.Class
 328      */
 329     init: function() {
 330         // Transform on_* method into openerp.web.callbacks
 331         for (var name in this) {
 332             if(typeof(this[name]) == "function") {
 333                 this[name].debug_name = name;
 334                 // bind ALL function to this not only on_and _do ?
 335                 if((/^on_|^do_/).test(name)) {
 336                     this[name] = openerp.web.callback(this, this[name]);
 337                 }
 338             }
 339         }
 340     }
 341 });
 342
 343 openerp.web.Session = openerp.web.CallbackEnabled.extend( /** @lends openerp.web.Session# */{
 344     /**
 345      * @constructs openerp.web.Session
 346      * @extends openerp.web.CallbackEnabled
 347      *
 348      * @param {String} [server] JSON-RPC endpoint hostname
 349      * @param {String} [port] JSON-RPC endpoint port
 350      */
 351     init: function(server, port) {
 352         this._super();
 353         this.server = (server == undefined) ? location.hostname : server;
 354         this.port = (port == undefined) ? location.port : port;
 355         this.rpc_mode = (server == location.hostname) ? "ajax" : "jsonp";
 356         this.debug = (window.location.search.indexOf('?debug') !== -1);
 357         this.session_id = false;
 358         this.uid = false;
 359         this.user_context= {};
 360         this.db = false;
 361         this.module_list = [];
 362         this.module_loaded = {"web": true};
 363         this.context = {};
 364         this.shortcuts = [];
 365         this.active_id = null;
 366     },
 367     start: function() {
 368         this.session_restore();
 369     },
 370     /**
 371      * Executes an RPC call, registering the provided callbacks.
 372      *
 373      * Registers a default error callback if none is provided, and handles
 374      * setting the correct session id and session context in the parameter
 375      * objects
 376      *
 377      * @param {String} url RPC endpoint
 378      * @param {Object} params call parameters
 379      * @param {Function} success_callback function to execute on RPC call success
 380      * @param {Function} error_callback function to execute on RPC call failure
 381      * @returns {jQuery.Deferred} jquery-provided ajax deferred
 382      */
 383     rpc: function(url, params, success_callback, error_callback) {
 384         var self = this;
 385         // Construct a JSON-RPC2 request, method is currently unused
 386         params.session_id = this.session_id;
 387         if (this.debug) params.debug = 1;
 388
 389         // Call using the rpc_mode
 390         var deferred = $.Deferred();
 391         this.rpc_ajax(url, {
 392             jsonrpc: "2.0",
 393             method: "call",
 394             params: params,
 395             id: _.uniqueId('browser-client-')
 396         }).then(function () {deferred.resolve.apply(deferred, arguments);},
 397                 function(error) {deferred.reject(error, $.Event());});
 398         return deferred.fail(function() {
 399             deferred.fail(function(error, event) {
 400                 if (!event.isDefaultPrevented()) {
 401                     self.on_rpc_error(error, event);
 402                 }
 403             });
 404         }).then(success_callback, error_callback).promise();
 405     },
 406     /**
 407      * Raw JSON-RPC call
 408      *
 409      * @returns {jQuery.Deferred} ajax-webd deferred object
 410      */
 411     rpc_ajax: function(url, payload) {
 412         var self = this;
 413         this.on_rpc_request();
 414         // url can be an $.ajax option object
 415         if (_.isString(url)) {
 416             url = {
 417                 url: url
 418             }
 419         }
 420         var ajax = _.extend({
 421             type: "POST",
 422             url: url,
 423             dataType: 'json',
 424             contentType: 'application/json',
 425             data: JSON.stringify(payload),
 426             processData: false
 427         }, url);
 428         var deferred = $.Deferred();
 429         $.ajax(ajax).done(function(response, textStatus, jqXHR) {
 430             self.on_rpc_response();
 431             if (!response.error) {
 432                 deferred.resolve(response["result"], textStatus, jqXHR);
 433                 return;
 434             }
 435             if (response.error.data.type !== "session_invalid") {
 436                 deferred.reject(response.error);
 437                 return;
 438             }
 439             self.uid = false;
 440             self.on_session_invalid(function() {
 441                 self.rpc(url, payload.params,
 442                     function() {
 443                         deferred.resolve.apply(deferred, arguments);
 444                     },
 445                     function(error, event) {
 446                         event.preventDefault();
 447                         deferred.reject.apply(deferred, arguments);
 448                     });
 449             });
 450         }).fail(function(jqXHR, textStatus, errorThrown) {
 451             self.on_rpc_response();
 452             var error = {
 453                 code: -32098,
 454                 message: "XmlHttpRequestError " + errorThrown,
 455                 data: {type: "xhr"+textStatus, debug: jqXHR.responseText, objects: [jqXHR, errorThrown] }
 456             };
 457             deferred.reject(error);
 458         });
 459         return deferred.promise();
 460     },
 461     on_rpc_request: function() {
 462     },
 463     on_rpc_response: function() {
 464     },
 465     on_rpc_error: function(error) {
 466     },
 467     /**
 468      * The session is validated either by login or by restoration of a previous session
 469      */
 470     on_session_valid: function() {
 471         if(!openerp._modules_loaded)
 472             this.load_modules();
 473     },
 474     on_session_invalid: function(contination) {
 475     },
 476     session_is_valid: function() {
 477         return this.uid;
 478     },
 479     session_login: function(db, login, password, success_callback) {
 480         var self = this;
 481         var params = { db: db, login: login, password: password };
 482         return this.rpc("/web/session/login", params, function(result) {
 483             self.session_id = result.session_id;
 484             self.uid = result.uid;
 485             self.user_context = result.context;
 486             self.db = result.db;
 487             self.session_save();
 488             return true;
 489         }).then(success_callback);
 490     },
 491     /**
 492      * Reloads uid and session_id from local storage, if they exist
 493      */
 494     session_restore: function () {
 495         var self = this;
 496         this.session_id = this.get_cookie('session_id');
 497         return this.rpc("/web/session/get_session_info", {}).then(function(result) {
 498             self.uid = result.uid;
 499             self.user_context = result.context;
 500             self.db = result.db;
 501             if (self.uid)
 502                 self.on_session_valid();
 503             else
 504                 self.on_session_invalid();
 505         }, function() {
 506             self.on_session_invalid();
 507         });
 508     },
 509     /**
 510      * Saves the session id and uid locally
 511      */
 512     session_save: function () {
 513         this.set_cookie('session_id', this.session_id);
 514     },
 515     logout: function() {
 516         this.set_cookie('session_id', '');
 517         this.reload_client();
 518     },
 519     reload_client: function() {
 520         window.location.reload();
 521     },
 522     /**
 523      * Fetches a cookie stored by an openerp session
 524      *
 525      * @private
 526      * @param name the cookie's name
 527      */
 528     get_cookie: function (name) {
 529         var nameEQ = this.element_id + '|' + name + '=';
 530         var cookies = document.cookie.split(';');
 531         for(var i=0; i<cookies.length; ++i) {
 532             var cookie = cookies[i].replace(/^\s*/, '');
 533             if(cookie.indexOf(nameEQ) === 0) {
 534                 return JSON.parse(decodeURIComponent(cookie.substring(nameEQ.length)));
 535             }
 536         }
 537         return null;
 538     },
 539     /**
 540      * Create a new cookie with the provided name and value
 541      *
 542      * @private
 543      * @param name the cookie's name
 544      * @param value the cookie's value
 545      * @param ttl the cookie's time to live, 1 year by default, set to -1 to delete
 546      */
 547     set_cookie: function (name, value, ttl) {
 548         ttl = ttl || 24*60*60*365;
 549         document.cookie = [
 550             this.element_id + '|' + name + '=' + encodeURIComponent(JSON.stringify(value)),
 551             'max-age=' + ttl,
 552             'expires=' + new Date(new Date().getTime() + ttl*1000).toGMTString()
 553         ].join(';');
 554     },
 555     /**
 556      * Load additional web addons of that instance and init them
 557      */
 558     load_modules: function() {
 559         var self = this;
 560         this.rpc('/web/session/modules', {}, function(result) {
 561             self.module_list = result;
 562             var lang = self.user_context.lang;
 563             var params = { mods: ["web"].concat(result), lang: lang};
 564             self.rpc('/web/webclient/translations',params).then(function(transs) {
 565                 openerp.web._t.database.set_bundle(transs);
 566                 var modules = self.module_list.join(',');
 567                 var file_list = ["/web/static/lib/datejs/globalization/" +
 568                     self.user_context.lang.replace("_", "-") + ".js"
 569                 ];
 570
 571                 self.rpc('/web/webclient/csslist', {"mods": modules}, self.do_load_css);
 572                 self.rpc('/web/webclient/jslist', {"mods": modules}, function(files) {
 573                     self.do_load_js(file_list.concat(files));
 574                 });
 575                 openerp._modules_loaded = true;
 576             });
 577         });
 578     },
 579     do_load_css: function (files) {
 580         var self = this;
 581         _.each(files, function (file) {
 582             $('head').append($('<link>', {
 583                 'href': file,
 584                 'rel': 'stylesheet',
 585                 'type': 'text/css'
 586             }));
 587         });
 588     },
 589     do_load_js: function(files) {
 590         var self = this;
 591         if(files.length != 0) {
 592             var file = files.shift();
 593             var tag = document.createElement('script');
 594             tag.type = 'text/javascript';
 595             tag.src = file;
 596             tag.onload = tag.onreadystatechange = function() {
 597                 if ( (tag.readyState && tag.readyState != "loaded" && tag.readyState != "complete") || tag.onload_done )
 598                     return;
 599                 tag.onload_done = true;
 600                 self.do_load_js(files);
 601             };
 602             document.head.appendChild(tag);
 603         } else {
 604             this.on_modules_loaded();
 605         }
 606     },
 607     on_modules_loaded: function() {
 608         for(var j=0; j<this.module_list.length; j++) {
 609             var mod = this.module_list[j];
 610             if(this.module_loaded[mod])
 611                 continue;
 612             openerp[mod] = {};
 613             // init module mod
 614             if(openerp._openerp[mod] != undefined) {
 615                 openerp._openerp[mod](openerp);
 616                 this.module_loaded[mod] = true;
 617             }
 618         }
 619     },
 620     /**
 621      * Cooperative file download implementation, for ajaxy APIs.
 622      *
 623      * Requires that the server side implements an httprequest correctly
 624      * setting the `fileToken` cookie to the value provided as the `token`
 625      * parameter. The cookie *must* be set on the `/` path and *must not* be
 626      * `httpOnly`.
 627      *
 628      * It would probably also be a good idea for the response to use a
 629      * `Content-Disposition: attachment` header, especially if the MIME is a
 630      * "known" type (e.g. text/plain, or for some browsers application/json
 631      *
 632      * @param {Object} options
 633      * @param {String} [options.url] used to dynamically create a form
 634      * @param {Object} [options.data] data to add to the form submission. If can be used without a form, in which case a form is created from scratch. Otherwise, added to form data
 635      * @param {HTMLFormElement} [options.form] the form to submit in order to fetch the file
 636      * @param {Function} [options.success] callback in case of download success
 637      * @param {Function} [options.error] callback in case of request error, provided with the error body
 638      * @param {Function} [options.complete] called after both ``success`` and ``error` callbacks have executed
 639      */
 640     get_file: function (options) {
 641         // need to detect when the file is done downloading (not used
 642         // yet, but we'll need it to fix the UI e.g. with a throbber
 643         // while dump is being generated), iframe load event only fires
 644         // when the iframe content loads, so we need to go smarter:
 645         // http://geekswithblogs.net/GruffCode/archive/2010/10/28/detecting-the-file-download-dialog-in-the-browser.aspx
 646         var timer, token = new Date().getTime(),
 647             cookie_name = 'fileToken', cookie_length = cookie_name.length,
 648             CHECK_INTERVAL = 1000, id = _.uniqueId('get_file_frame'),
 649             remove_form = false;
 650
 651         var $form, $form_data = $('<div>');
 652
 653         var complete = function () {
 654             if (options.complete) { options.complete(); }
 655             clearTimeout(timer);
 656             $form_data.remove();
 657             $target.remove();
 658             if (remove_form && $form) { $form.remove(); }
 659         };
 660         var $target = $('<iframe style="display: none;">')
 661             .attr({id: id, name: id})
 662             .appendTo(document.body)
 663             .load(function () {
 664                 if (options.error) { options.error(this.contentDocument.body); }
 665                 complete();
 666             });
 667
 668         if (options.form) {
 669             $form = $(options.form);
 670         } else {
 671             remove_form = true;
 672             $form = $('<form>', {
 673                 action: options.url,
 674                 method: 'POST'
 675             }).appendTo(document.body);
 676         }
 677
 678         _(_.extend({}, options.data || {},
 679                    {session_id: this.session_id, token: token}))
 680             .each(function (value, key) {
 681                 $('<input type="hidden" name="' + key + '">')
 682                     .val(value)
 683                     .appendTo($form_data);
 684             });
 685
 686         $form
 687             .append($form_data)
 688             .attr('target', id)
 689             .get(0).submit();
 690
 691         var waitLoop = function () {
 692             var cookies = document.cookie.split(';');
 693             // setup next check
 694             timer = setTimeout(waitLoop, CHECK_INTERVAL);
 695             for (var i=0; i<cookies.length; ++i) {
 696                 var cookie = cookies[i].replace(/^\s*/, '');
 697                 if (!cookie.indexOf(cookie_name === 0)) { continue; }
 698                 var cookie_val = cookie.substring(cookie_length + 1);
 699                 if (parseInt(cookie_val, 10) !== token) { continue; }
 700
 701                 // clear cookie
 702                 document.cookie = _.sprintf("%s=;expires=%s;path=/",
 703                     cookie_name, new Date().toGMTString());
 704                 if (options.success) { options.success(); }
 705                 complete();
 706                 return;
 707             }
 708         };
 709         timer = setTimeout(waitLoop, CHECK_INTERVAL);
 710     }
 711 });
 712
 713 openerp.web.SessionAware = openerp.web.CallbackEnabled.extend(/** @lends openerp.web.SessionAware# */{
 714     /**
 715      * Utility class that any class is allowed to extend to easy common manipulations.
 716      *
 717      * It provides rpc calls, callback on all methods preceded by "on_" or "do_" and a
 718      * logging facility.
 719      *
 720      * @constructs openerp.web.SessionAware
 721      * @extends openerp.web.CallbackEnabled
 722      *
 723      * @param {openerp.web.Session} session
 724      */
 725     init: function(session) {
 726         this._super();
 727         this.session = session;
 728     },
 729     /**
 730      * Performs a JSON-RPC call
 731      *
 732      * @param {String} url endpoint url
 733      * @param {Object} data RPC parameters
 734      * @param {Function} success RPC call success callback
 735      * @param {Function} error RPC call error callback
 736      * @returns {jQuery.Deferred} deferred object for the RPC call
 737      */
 738     rpc: function(url, data, success, error) {
 739         return this.session.rpc(url, data, success, error);
 740     }
 741 });
 742
 743 /**
 744  * Base class for all visual components. Provides a lot of functionalities helpful
 745  * for the management of a part of the DOM.
 746  *
 747  * Widget handles:
 748  * - Rendering with QWeb.
 749  * - Life-cycle management and parenting (when a parent is destroyed, all its children are
 750  *     destroyed too).
 751  * - Insertion in DOM.
 752  *
 753  * Widget also extends SessionAware for ease of use.
 754  *
 755  * Guide to create implementations of the Widget class:
 756  * ==============================================
 757  *
 758  * Here is a sample child class:
 759  *
 760  * MyWidget = openerp.base.Widget.extend({
 761  *     // the name of the QWeb template to use for rendering
 762  *     template: "MyQWebTemplate",
 763  *     // identifier prefix, it is useful to put an obvious one for debugging
 764  *     identifier_prefix: 'my-id-prefix-',
 765  *
 766  *     init: function(parent) {
 767  *         this._super(parent);
 768  *         // stuff that you want to init before the rendering
 769  *     },
 770  *     start: function() {
 771  *         // stuff you want to make after the rendering, `this.$element` holds a correct value
 772  *         this.$element.find(".my_button").click(/* an example of event binding * /);
 773  *
 774  *         // if you have some asynchronous operations, it's a good idea to return
 775  *         // a promise in start()
 776  *         var promise = this.rpc(...);
 777  *         return promise;
 778  *     }
 779  * });
 780  *
 781  * Now this class can simply be used with the following syntax:
 782  *
 783  * var my_widget = new MyWidget(this);
 784  * my_widget.appendTo($(".some-div"));
 785  *
 786  * With these two lines, the MyWidget instance was inited, rendered, it was inserted into the
 787  * DOM inside the ".some-div" div and its events were binded.
 788  *
 789  * And of course, when you don't need that widget anymore, just do:
 790  *
 791  * my_widget.stop();
 792  *
 793  * That will kill the widget in a clean way and erase its content from the dom.
 794  */
 795 openerp.web.Widget = openerp.web.SessionAware.extend(/** @lends openerp.web.Widget# */{
 796     /**
 797      * The name of the QWeb template that will be used for rendering. Must be
 798      * redefined in subclasses or the default render() method can not be used.
 799      *
 800      * @type string
 801      */
 802     template: null,
 803     /**
 804      * The prefix used to generate an id automatically. Should be redefined in
 805      * subclasses. If it is not defined, a generic identifier will be used.
 806      *
 807      * @type string
 808      */
 809     identifier_prefix: 'generic-identifier-',
 810     /**
 811      * Construct the widget and set its parent if a parent is given.
 812      *
 813      * @constructs openerp.web.Widget
 814      * @extends openerp.web.SessionAware
 815      *
 816      * @param {openerp.web.Widget} parent Binds the current instance to the given Widget instance.
 817      * When that widget is destroyed by calling stop(), the current instance will be
 818      * destroyed too. Can be null.
 819      * @param {String} element_id Deprecated. Sets the element_id. Only useful when you want
 820      * to bind the current Widget to an already existing part of the DOM, which is not compatible
 821      * with the DOM insertion methods provided by the current implementation of Widget. So
 822      * for new components this argument should not be provided any more.
 823      */
 824     init: function(parent, /** @deprecated */ element_id) {
 825         this._super((parent || {}).session);
 826         // if given an element_id, try to get the associated DOM element and save
 827         // a reference in this.$element. Else just generate a unique identifier.
 828         this.element_id = element_id;
 829         this.element_id = this.element_id || _.uniqueId(this.identifier_prefix);
 830         var tmp = document.getElementById(this.element_id);
 831         this.$element = tmp ? $(tmp) : undefined;
 832
 833         this.widget_parent = parent;
 834         this.widget_children = [];
 835         if(parent && parent.widget_children) {
 836             parent.widget_children.push(this);
 837         }
 838         // useful to know if the widget was destroyed and should not be used anymore
 839         this.widget_is_stopped = false;
 840     },
 841     /**
 842      * Render the current widget and appends it to the given jQuery object or Widget.
 843      *
 844      * @param target A jQuery object or a Widget instance.
 845      */
 846     appendTo: function(target) {
 847         var self = this;
 848         return this._render_and_insert(function(t) {
 849             self.$element.appendTo(t);
 850         }, target);
 851     },
 852     /**
 853      * Render the current widget and prepends it to the given jQuery object or Widget.
 854      *
 855      * @param target A jQuery object or a Widget instance.
 856      */
 857     prependTo: function(target) {
 858         var self = this;
 859         return this._render_and_insert(function(t) {
 860             self.$element.prependTo(t);
 861         }, target);
 862     },
 863     /**
 864      * Render the current widget and inserts it after to the given jQuery object or Widget.
 865      *
 866      * @param target A jQuery object or a Widget instance.
 867      */
 868     insertAfter: function(target) {
 869         var self = this;
 870         return this._render_and_insert(function(t) {
 871             self.$element.insertAfter(t);
 872         }, target);
 873     },
 874     /**
 875      * Render the current widget and inserts it before to the given jQuery object or Widget.
 876      *
 877      * @param target A jQuery object or a Widget instance.
 878      */
 879     insertBefore: function(target) {
 880         var self = this;
 881         return this._render_and_insert(function(t) {
 882             self.$element.insertBefore(t);
 883         }, target);
 884     },
 885     _render_and_insert: function(insertion, target) {
 886         var rendered = this.render();
 887         this.$element = $(rendered);
 888         if (target instanceof openerp.web.Widget)
 889             target = target.$element;
 890         insertion(target);
 891         this.on_inserted(this.$element, this);
 892         return this.start();
 893     },
 894     on_inserted: function(element, widget) {},
 895     /**
 896      * Renders the widget using QWeb, `this.template` must be defined.
 897      * The context given to QWeb contains the "widget" key that references `this`.
 898      *
 899      * @param {Object} additional Additional context arguments to pass to the template.
 900      */
 901     render: function (additional) {
 902         return openerp.web.qweb.render(this.template, _.extend({widget: this}, additional || {}));
 903     },
 904     /**
 905      * Method called after rendering. Mostly used to bind actions, perform asynchronous
 906      * calls, etc...
 907      *
 908      * By convention, the method should return a promise to inform the caller when
 909      * this widget has been initialized.
 910      *
 911      * @returns {jQuery.Deferred}
 912      */
 913     start: function() {
 914         /* The default implementation is only useful for retro-compatibility, it is
 915         not necessary to call it using _super() when using Widget for new components. */
 916         if (!this.$element) {
 917             var tmp = document.getElementById(this.element_id);
 918             this.$element = tmp ? $(tmp) : undefined;
 919         }
 920         return $.Deferred().done().promise();
 921     },
 922     /**
 923      * Destroys the current widget, also destroy all its children before destroying itself.
 924      */
 925     stop: function() {
 926         _.each(_.clone(this.widget_children), function(el) {
 927             el.stop();
 928         });
 929         if(this.$element != null) {
 930             this.$element.remove();
 931         }
 932         if (this.widget_parent && this.widget_parent.widget_children) {
 933             this.widget_parent.widget_children = _.without(this.widget_parent.widget_children, this);
 934         }
 935         this.widget_parent = null;
 936         this.widget_is_stopped = true;
 937     },
 938     /**
 939      * Inform the action manager to do an action. Of course, this suppose that
 940      * the action manager can be found amongst the ancestors of the current widget.
 941      * If that's not the case this method will simply return `false`.
 942      */
 943     do_action: function(action, on_finished) {
 944         if (this.widget_parent) {
 945             return this.widget_parent.do_action(action, on_finished);
 946         }
 947         return false;
 948     },
 949     do_notify: function() {
 950         if (this.widget_parent) {
 951             return this.widget_parent.do_notify.apply(this,arguments);
 952         }
 953         return false;
 954     },
 955     do_warn: function() {
 956         if (this.widget_parent) {
 957             return this.widget_parent.do_warn.apply(this,arguments);
 958         }
 959         return false;
 960     },
 961     rpc: function(url, data, success, error) {
 962         var def = $.Deferred().then(success, error);
 963         var self = this;
 964         this._super(url, data). then(function() {
 965             if (!self.widget_is_stopped)
 966                 def.resolve.apply(def, arguments);
 967         }, function() {
 968             if (!self.widget_is_stopped)
 969                 def.reject.apply(def, arguments);
 970         });
 971         return def.promise();
 972     }
 973 });
 974
 975 /**
 976  * @class
 977  * @extends openerp.web.Widget
 978  * @deprecated
 979  * For retro compatibility only, the only difference with is that render() uses
 980  * directly ``this`` instead of context with a ``widget`` key.
 981  */
 982 openerp.web.OldWidget = openerp.web.Widget.extend(/** @lends openerp.web.OldWidget# */{
 983     render: function (additional) {
 984         return openerp.web.qweb.render(this.template, _.extend(_.extend({}, this), additional || {}));
 985     }
 986 });
 987
 988 openerp.web.TranslationDataBase = openerp.web.Class.extend(/** @lends openerp.web.TranslationDataBase# */{
 989     /**
 990      * @constructs openerp.web.TranslationDataBase
 991      * @extends openerp.web.Class
 992      */
 993     init: function() {
 994         this.db = {};
 995         this.parameters = {"direction": 'ltr',
 996                         "date_format": '%m/%d/%Y',
 997                         "time_format": '%H:%M:%S',
 998                         "grouping": "[]",
 999                         "decimal_point": ".",
1000                         "thousands_sep": ","};
1001     },
1002     set_bundle: function(translation_bundle) {
1003         var self = this;
1004         this.db = {};
1005         var modules = _.keys(translation_bundle.modules).sort();
1006         if (_.include(modules, "web")) {
1007             modules = ["web"].concat(_.without(modules, "web"));
1008         }
1009         _.each(modules, function(name) {
1010             self.add_module_translation(translation_bundle.modules[name]);
1011         });
1012         if (translation_bundle.lang_parameters) {
1013             this.parameters = translation_bundle.lang_parameters;
1014         }
1015     },
1016     add_module_translation: function(mod) {
1017         var self = this;
1018         _.each(mod.messages, function(message) {
1019             if (self.db[message.id] === undefined) {
1020                 self.db[message.id] = message.string;
1021             }
1022         });
1023     },
1024     build_translation_function: function() {
1025         var self = this;
1026         var fcnt = function(str) {
1027             var tmp = self.get(str);
1028             return tmp === undefined ? str : tmp;
1029         };
1030         fcnt.database = this;
1031         return fcnt;
1032     },
1033     get: function(key) {
1034         if (this.db[key])
1035             return this.db[key];
1036         return undefined;
1037     }
1038 });
1039
1040 openerp.web._t = new openerp.web.TranslationDataBase().build_translation_function();
1041
1042 };
1043
1044 // vim:et fdc=0 fdl=0 foldnestmax=3 fdm=syntax: