1215 lines
43 KiB
JavaScript
1215 lines
43 KiB
JavaScript
/*---------------------------------------------------------
|
|
* OpenERP Web core
|
|
*--------------------------------------------------------*/
|
|
var console;
|
|
if (!console) {
|
|
console = {log: function () {}};
|
|
}
|
|
if (!console.debug) {
|
|
console.debug = console.log;
|
|
}
|
|
|
|
openerp.web.core = function(openerp) {
|
|
/**
|
|
* John Resig Class with factory improvement
|
|
*/
|
|
(function() {
|
|
var initializing = false,
|
|
fnTest = /xyz/.test(function(){xyz;}) ? /\b_super\b/ : /.*/;
|
|
// The web Class implementation (does nothing)
|
|
/**
|
|
* Extended version of John Resig's Class pattern
|
|
*
|
|
* @class
|
|
*/
|
|
openerp.web.Class = function(){};
|
|
|
|
/**
|
|
* Subclass an existing class
|
|
*
|
|
* @param {Object} prop class-level properties (class attributes and instance methods) to set on the new class
|
|
*/
|
|
openerp.web.Class.extend = function(prop) {
|
|
var _super = this.prototype;
|
|
|
|
// Instantiate a web class (but only create the instance,
|
|
// don't run the init constructor)
|
|
initializing = true;
|
|
var prototype = new this();
|
|
initializing = false;
|
|
|
|
// Copy the properties over onto the new prototype
|
|
for (var name in prop) {
|
|
// Check if we're overwriting an existing function
|
|
prototype[name] = typeof prop[name] == "function" &&
|
|
typeof _super[name] == "function" &&
|
|
fnTest.test(prop[name]) ?
|
|
(function(name, fn) {
|
|
return function() {
|
|
var tmp = this._super;
|
|
|
|
// Add a new ._super() method that is the same
|
|
// method but on the super-class
|
|
this._super = _super[name];
|
|
|
|
// The method only need to be bound temporarily, so
|
|
// we remove it when we're done executing
|
|
var ret = fn.apply(this, arguments);
|
|
this._super = tmp;
|
|
|
|
return ret;
|
|
};
|
|
})(name, prop[name]) :
|
|
prop[name];
|
|
}
|
|
|
|
// The dummy class constructor
|
|
function Class() {
|
|
// All construction is actually done in the init method
|
|
if (!initializing && this.init) {
|
|
var ret = this.init.apply(this, arguments);
|
|
if (ret) { return ret; }
|
|
}
|
|
return this;
|
|
}
|
|
Class.include = function (properties) {
|
|
for (var name in properties) {
|
|
if (typeof properties[name] !== 'function'
|
|
|| !fnTest.test(properties[name])) {
|
|
prototype[name] = properties[name];
|
|
} else if (typeof prototype[name] === 'function'
|
|
&& prototype.hasOwnProperty(name)) {
|
|
prototype[name] = (function (name, fn, previous) {
|
|
return function () {
|
|
var tmp = this._super;
|
|
this._super = previous;
|
|
var ret = fn.apply(this, arguments);
|
|
this._super = tmp;
|
|
return ret;
|
|
}
|
|
})(name, properties[name], prototype[name]);
|
|
} else if (typeof _super[name] === 'function') {
|
|
prototype[name] = (function (name, fn) {
|
|
return function () {
|
|
var tmp = this._super;
|
|
this._super = _super[name];
|
|
var ret = fn.apply(this, arguments);
|
|
this._super = tmp;
|
|
return ret;
|
|
}
|
|
})(name, properties[name]);
|
|
}
|
|
}
|
|
};
|
|
|
|
// Populate our constructed prototype object
|
|
Class.prototype = prototype;
|
|
|
|
// Enforce the constructor to be what we expect
|
|
Class.constructor = Class;
|
|
|
|
// And make this class extendable
|
|
Class.extend = arguments.callee;
|
|
|
|
return Class;
|
|
};
|
|
})();
|
|
|
|
openerp.web.callback = function(obj, method) {
|
|
var callback = function() {
|
|
var args = Array.prototype.slice.call(arguments);
|
|
var r;
|
|
for(var i = 0; i < callback.callback_chain.length; i++) {
|
|
var c = callback.callback_chain[i];
|
|
if(c.unique) {
|
|
callback.callback_chain.splice(i, 1);
|
|
i -= 1;
|
|
}
|
|
var result = c.callback.apply(c.self, c.args.concat(args));
|
|
if (c.callback === method) {
|
|
// return the result of the original method
|
|
r = result;
|
|
}
|
|
// TODO special value to stop the chain
|
|
// openerp.web.callback_stop
|
|
}
|
|
return r;
|
|
};
|
|
callback.callback_chain = [];
|
|
callback.add = function(f) {
|
|
if(typeof(f) == 'function') {
|
|
f = { callback: f, args: Array.prototype.slice.call(arguments, 1) };
|
|
}
|
|
f.self = f.self || null;
|
|
f.args = f.args || [];
|
|
f.unique = !!f.unique;
|
|
if(f.position == 'last') {
|
|
callback.callback_chain.push(f);
|
|
} else {
|
|
callback.callback_chain.unshift(f);
|
|
}
|
|
return callback;
|
|
};
|
|
callback.add_first = function(f) {
|
|
return callback.add.apply(null,arguments);
|
|
};
|
|
callback.add_last = function(f) {
|
|
return callback.add({
|
|
callback: f,
|
|
args: Array.prototype.slice.call(arguments, 1),
|
|
position: "last"
|
|
});
|
|
};
|
|
|
|
return callback.add({
|
|
callback: method,
|
|
self:obj,
|
|
args:Array.prototype.slice.call(arguments, 2)
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Generates an inherited class that replaces all the methods by null methods (methods
|
|
* that does nothing and always return undefined).
|
|
*
|
|
* @param {Class} claz
|
|
* @param {Object} add Additional functions to override.
|
|
* @return {Class}
|
|
*/
|
|
openerp.web.generate_null_object_class = function(claz, add) {
|
|
var newer = {};
|
|
var copy_proto = function(prototype) {
|
|
for (var name in prototype) {
|
|
if(typeof prototype[name] == "function") {
|
|
newer[name] = function() {};
|
|
}
|
|
}
|
|
if (prototype.prototype)
|
|
copy_proto(prototype.prototype);
|
|
};
|
|
copy_proto(claz.prototype);
|
|
newer.init = openerp.web.Widget.prototype.init;
|
|
var tmpclass = claz.extend(newer);
|
|
return tmpclass.extend(add || {});
|
|
};
|
|
|
|
/**
|
|
* web error for lookup failure
|
|
*
|
|
* @class
|
|
*/
|
|
openerp.web.NotFound = openerp.web.Class.extend( /** @lends openerp.web.NotFound# */ {
|
|
});
|
|
openerp.web.KeyNotFound = openerp.web.NotFound.extend( /** @lends openerp.web.KeyNotFound# */ {
|
|
/**
|
|
* Thrown when a key could not be found in a mapping
|
|
*
|
|
* @constructs openerp.web.KeyNotFound
|
|
* @extends openerp.web.NotFound
|
|
* @param {String} key the key which could not be found
|
|
*/
|
|
init: function (key) {
|
|
this.key = key;
|
|
},
|
|
toString: function () {
|
|
return "The key " + this.key + " was not found";
|
|
}
|
|
});
|
|
openerp.web.ObjectNotFound = openerp.web.NotFound.extend( /** @lends openerp.web.ObjectNotFound# */ {
|
|
/**
|
|
* Thrown when an object path does not designate a valid class or object
|
|
* in the openerp hierarchy.
|
|
*
|
|
* @constructs openerp.web.ObjectNotFound
|
|
* @extends openerp.web.NotFound
|
|
* @param {String} path the invalid object path
|
|
*/
|
|
init: function (path) {
|
|
this.path = path;
|
|
},
|
|
toString: function () {
|
|
return "Could not find any object of path " + this.path;
|
|
}
|
|
});
|
|
openerp.web.Registry = openerp.web.Class.extend( /** @lends openerp.web.Registry# */ {
|
|
/**
|
|
* Stores a mapping of arbitrary key (strings) to object paths (as strings
|
|
* as well).
|
|
*
|
|
* Resolves those paths at query time in order to always fetch the correct
|
|
* object, even if those objects have been overloaded/replaced after the
|
|
* registry was created.
|
|
*
|
|
* An object path is simply a dotted name from the openerp root to the
|
|
* object pointed to (e.g. ``"openerp.web.Connection"`` for an OpenERP
|
|
* connection object).
|
|
*
|
|
* @constructs openerp.web.Registry
|
|
* @param {Object} mapping a mapping of keys to object-paths
|
|
*/
|
|
init: function (mapping) {
|
|
this.map = mapping || {};
|
|
},
|
|
/**
|
|
* Retrieves the object matching the provided key string.
|
|
*
|
|
* @param {String} key the key to fetch the object for
|
|
* @param {Boolean} [silent_error=false] returns undefined if the key or object is not found, rather than throwing an exception
|
|
* @returns {Class} the stored class, to initialize
|
|
*
|
|
* @throws {openerp.web.KeyNotFound} if the object was not in the mapping
|
|
* @throws {openerp.web.ObjectNotFound} if the object path was invalid
|
|
*/
|
|
get_object: function (key, silent_error) {
|
|
var path_string = this.map[key];
|
|
if (path_string === undefined) {
|
|
if (silent_error) { return void 'nooo'; }
|
|
throw new openerp.web.KeyNotFound(key);
|
|
}
|
|
|
|
var object_match = openerp;
|
|
var path = path_string.split('.');
|
|
// ignore first section
|
|
for(var i=1; i<path.length; ++i) {
|
|
object_match = object_match[path[i]];
|
|
|
|
if (object_match === undefined) {
|
|
if (silent_error) { return void 'noooooo'; }
|
|
throw new openerp.web.ObjectNotFound(path_string);
|
|
}
|
|
}
|
|
return object_match;
|
|
},
|
|
/**
|
|
* Tries a number of keys, and returns the first object matching one of
|
|
* the keys.
|
|
*
|
|
* @param {Array} keys a sequence of keys to fetch the object for
|
|
* @returns {Class} the first class found matching an object
|
|
*
|
|
* @throws {openerp.web.KeyNotFound} if none of the keys was in the mapping
|
|
* @trows {openerp.web.ObjectNotFound} if a found object path was invalid
|
|
*/
|
|
get_any: function (keys) {
|
|
for (var i=0; i<keys.length; ++i) {
|
|
var key = keys[i];
|
|
if (key === undefined || !(key in this.map)) {
|
|
continue;
|
|
}
|
|
|
|
return this.get_object(key);
|
|
}
|
|
throw new openerp.web.KeyNotFound(keys.join(','));
|
|
},
|
|
/**
|
|
* Adds a new key and value to the registry.
|
|
*
|
|
* This method can be chained.
|
|
*
|
|
* @param {String} key
|
|
* @param {String} object_path fully qualified dotted object path
|
|
* @returns {openerp.web.Registry} itself
|
|
*/
|
|
add: function (key, object_path) {
|
|
this.map[key] = object_path;
|
|
return this;
|
|
},
|
|
/**
|
|
* Creates and returns a copy of the current mapping, with the provided
|
|
* mapping argument added in (replacing existing keys if needed)
|
|
*
|
|
* @param {Object} [mapping={}] a mapping of keys to object-paths
|
|
*/
|
|
clone: function (mapping) {
|
|
return new openerp.web.Registry(
|
|
_.extend({}, this.map, mapping || {}));
|
|
}
|
|
});
|
|
|
|
openerp.web.CallbackEnabled = openerp.web.Class.extend(/** @lends openerp.web.CallbackEnabled# */{
|
|
/**
|
|
* @constructs openerp.web.CallbackEnabled
|
|
* @extends openerp.web.Class
|
|
*/
|
|
init: function() {
|
|
// Transform on_* method into openerp.web.callbacks
|
|
for (var name in this) {
|
|
if(typeof(this[name]) == "function") {
|
|
this[name].debug_name = name;
|
|
// bind ALL function to this not only on_and _do ?
|
|
if((/^on_|^do_/).test(name)) {
|
|
this[name] = openerp.web.callback(this, this[name]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
});
|
|
|
|
openerp.web.Connection = openerp.web.CallbackEnabled.extend( /** @lends openerp.web.Connection# */{
|
|
/**
|
|
* @constructs openerp.web.Connection
|
|
* @extends openerp.web.CallbackEnabled
|
|
*
|
|
* @param {String} [server] JSON-RPC endpoint hostname
|
|
* @param {String} [port] JSON-RPC endpoint port
|
|
*/
|
|
init: function() {
|
|
this._super();
|
|
// TODO: session store in cookie should be optional
|
|
this.name = openerp._session_id;
|
|
},
|
|
bind: function(host, protocol) {
|
|
var self = this;
|
|
this.host = (host == undefined) ? location.host : host;
|
|
this.protocol = (protocol == undefined) ? location.protocol : protocol;
|
|
this.prefix = this.protocol + '//' + this.host;
|
|
openerp.web.qweb.default_dict['_s'] = this.prefix
|
|
this.rpc_mode = (this.host == location.host) ? "json" : "jsonp";
|
|
this.rpc_function = (this.host == location.host) ? this.rpc_json : this.rpc_jsonp;
|
|
this.debug = (window.location.search.indexOf('?debug') !== -1);
|
|
this.session_id = false;
|
|
this.uid = false;
|
|
this.username = false;
|
|
this.user_context= {};
|
|
this.db = false;
|
|
this.module_list = [];
|
|
this.module_loaded = {"web": true};
|
|
this.context = {};
|
|
this.shortcuts = [];
|
|
this.active_id = null;
|
|
this.ready = $.Deferred();
|
|
return this.session_init();
|
|
},
|
|
/**
|
|
* Executes an RPC call, registering the provided callbacks.
|
|
*
|
|
* Registers a default error callback if none is provided, and handles
|
|
* setting the correct session id and session context in the parameter
|
|
* objects
|
|
*
|
|
* @param {String} url RPC endpoint
|
|
* @param {Object} params call parameters
|
|
* @param {Function} success_callback function to execute on RPC call success
|
|
* @param {Function} error_callback function to execute on RPC call failure
|
|
* @returns {jQuery.Deferred} jquery-provided ajax deferred
|
|
*/
|
|
rpc: function(url, params, success_callback, error_callback) {
|
|
var self = this;
|
|
// url can be an $.ajax option object
|
|
if (_.isString(url)) {
|
|
url = { url: url };
|
|
}
|
|
// Construct a JSON-RPC2 request, method is currently unused
|
|
params.session_id = this.session_id;
|
|
if (this.debug)
|
|
params.debug = 1;
|
|
var payload = {
|
|
jsonrpc: '2.0',
|
|
method: 'call',
|
|
params: params,
|
|
id: _.uniqueId('r')
|
|
};
|
|
var deferred = $.Deferred();
|
|
this.on_rpc_request();
|
|
this.rpc_function(url, payload).then(
|
|
function (response, textStatus, jqXHR) {
|
|
self.on_rpc_response();
|
|
if (!response.error) {
|
|
deferred.resolve(response["result"], textStatus, jqXHR);
|
|
} else if (response.error.data.type === "session_invalid") {
|
|
self.uid = false;
|
|
// TODO deprecate or use a deferred on login.do_ask_login()
|
|
self.on_session_invalid(function() {
|
|
self.rpc(url, payload.params,
|
|
function() { deferred.resolve.apply(deferred, arguments); },
|
|
function() { deferred.reject.apply(deferred, arguments); });
|
|
});
|
|
} else {
|
|
deferred.reject(response.error, $.Event());
|
|
}
|
|
},
|
|
function(jqXHR, textStatus, errorThrown) {
|
|
self.on_rpc_response();
|
|
var error = {
|
|
code: -32098,
|
|
message: "XmlHttpRequestError " + errorThrown,
|
|
data: {type: "xhr"+textStatus, debug: jqXHR.responseText, objects: [jqXHR, errorThrown] }
|
|
};
|
|
deferred.reject(error, $.Event());
|
|
});
|
|
// Allow deferred user to disable on_rpc_error in fail
|
|
deferred.fail(function() {
|
|
deferred.fail(function(error, event) {
|
|
if (!event.isDefaultPrevented()) {
|
|
self.on_rpc_error(error, event);
|
|
}
|
|
});
|
|
}).then(success_callback, error_callback).promise();
|
|
return deferred;
|
|
},
|
|
/**
|
|
* Raw JSON-RPC call
|
|
*
|
|
* @returns {jQuery.Deferred} ajax-webd deferred object
|
|
*/
|
|
rpc_json: function(url, payload) {
|
|
var self = this;
|
|
var ajax = _.extend({
|
|
type: "POST",
|
|
dataType: 'json',
|
|
contentType: 'application/json',
|
|
data: JSON.stringify(payload),
|
|
processData: false,
|
|
}, url);
|
|
return $.ajax(ajax);
|
|
},
|
|
rpc_jsonp: function(url, payload) {
|
|
var self = this;
|
|
// extracted from payload to set on the url
|
|
var data = {
|
|
session_id: this.session_id,
|
|
id: payload.id,
|
|
};
|
|
url.url = this.get_url(url.url);
|
|
var ajax = _.extend({
|
|
type: "GET",
|
|
dataType: 'jsonp',
|
|
jsonp: 'jsonp',
|
|
cache: false,
|
|
data: data
|
|
}, url);
|
|
var payload_str = JSON.stringify(payload);
|
|
var payload_url = $.param({r:payload_str});
|
|
if(playload_url.length < 2000) {
|
|
// Direct jsonp request
|
|
ajax.data.r = payload_str;
|
|
return $.ajax(ajax);
|
|
} else {
|
|
// Indirect jsonp request
|
|
var ifid = _.uniqueId('oe_rpc_iframe');
|
|
var display = options.openerp.debug ? 'block' : 'none';
|
|
var $iframe = $(_.str.sprintf("<iframe src='javascript:false;' name='%s' id='%s' style='display:%s'></iframe>", ifid, ifid, display));
|
|
var $form = $('<form>')
|
|
.attr('method', 'POST')
|
|
.attr('target', ifid)
|
|
.attr('enctype', "multipart/form-data")
|
|
.attr('action', ajax.url + '?' + $.param(data))
|
|
.append($('<input type="hidden" name="r" />').attr('value', payload_str))
|
|
.hide()
|
|
.appendTo($('body'));
|
|
var cleanUp = function() {
|
|
if ($iframe) {
|
|
$iframe.unbind("load").attr("src", "javascript:false;").remove();
|
|
}
|
|
$form.remove();
|
|
};
|
|
var deferred = $.Deferred();
|
|
// the first bind is fired up when the iframe is added to the DOM
|
|
$iframe.bind('load', function() {
|
|
// the second bind is fired up when the result of the form submission is received
|
|
$iframe.unbind('load').bind('load', function() {
|
|
$.ajax(ajax).always(function() {
|
|
cleanUp();
|
|
}).then(
|
|
function() { deferred.resolve.apply(deferred, arguments); },
|
|
function() { deferred.reject.apply(deferred, arguments); }
|
|
);
|
|
});
|
|
// now that the iframe can receive data, we fill and submit the form
|
|
$form.submit();
|
|
});
|
|
// append the iframe to the DOM (will trigger the first load)
|
|
$form.after($iframe);
|
|
return deferred;
|
|
}
|
|
},
|
|
on_rpc_request: function() {
|
|
},
|
|
on_rpc_response: function() {
|
|
},
|
|
on_rpc_error: function(error) {
|
|
},
|
|
/**
|
|
* Init a session, reloads from cookie, if it exists
|
|
*/
|
|
session_init: function () {
|
|
var self = this;
|
|
// TODO: session store in cookie should be optional
|
|
this.session_id = this.get_cookie('session_id');
|
|
return this.rpc("/web/session/get_session_info", {}).pipe(function(result) {
|
|
// If immediately follows a login (triggered by trying to restore
|
|
// an invalid session or no session at all), refresh session data
|
|
// (should not change, but just in case...)
|
|
_.extend(self, {
|
|
db: result.db,
|
|
username: result.login,
|
|
uid: result.uid,
|
|
user_context: result.context
|
|
});
|
|
var deferred = self.do_load_qweb(['/web/webclient/qweb']);
|
|
if(self.uid) {
|
|
return deferred.then(self.load_modules());
|
|
}
|
|
return deferred;
|
|
});
|
|
},
|
|
/**
|
|
* The session is validated either by login or by restoration of a previous session
|
|
*/
|
|
session_authenticate: function(db, login, password) {
|
|
var self = this;
|
|
var base_location = document.location.protocol + '//' + document.location.host;
|
|
var params = { db: db, login: login, password: password, base_location: base_location };
|
|
return this.rpc("/web/session/authenticate", params).pipe(function(result) {
|
|
_.extend(self, {
|
|
session_id: result.session_id,
|
|
db: result.db,
|
|
username: result.login,
|
|
uid: result.uid,
|
|
user_context: result.context
|
|
});
|
|
// TODO: session store in cookie should be optional
|
|
self.set_cookie('session_id', self.session_id);
|
|
return self.load_modules();
|
|
});
|
|
},
|
|
session_logout: function() {
|
|
this.set_cookie('session_id', '');
|
|
window.location.reload();
|
|
},
|
|
/**
|
|
* Fetches a cookie stored by an openerp session
|
|
*
|
|
* @private
|
|
* @param name the cookie's name
|
|
*/
|
|
get_cookie: function (name) {
|
|
if (!this.name) { return null; }
|
|
var nameEQ = this.name + '|' + name + '=';
|
|
var cookies = document.cookie.split(';');
|
|
for(var i=0; i<cookies.length; ++i) {
|
|
var cookie = cookies[i].replace(/^\s*/, '');
|
|
if(cookie.indexOf(nameEQ) === 0) {
|
|
return JSON.parse(decodeURIComponent(cookie.substring(nameEQ.length)));
|
|
}
|
|
}
|
|
return null;
|
|
},
|
|
/**
|
|
* Create a new cookie with the provided name and value
|
|
*
|
|
* @private
|
|
* @param name the cookie's name
|
|
* @param value the cookie's value
|
|
* @param ttl the cookie's time to live, 1 year by default, set to -1 to delete
|
|
*/
|
|
set_cookie: function (name, value, ttl) {
|
|
if (!this.name) { return; }
|
|
ttl = ttl || 24*60*60*365;
|
|
document.cookie = [
|
|
this.name + '|' + name + '=' + encodeURIComponent(JSON.stringify(value)),
|
|
'path=/',
|
|
'max-age=' + ttl,
|
|
'expires=' + new Date(new Date().getTime() + ttl*1000).toGMTString()
|
|
].join(';');
|
|
},
|
|
/**
|
|
* Load additional web addons of that instance and init them
|
|
*/
|
|
load_modules: function() {
|
|
var self = this;
|
|
if(openerp._modules_loaded) {
|
|
return $.when();
|
|
}
|
|
this.rpc('/web/session/modules', {}, function(result) {
|
|
self.module_list = result;
|
|
var lang = self.user_context.lang;
|
|
var params = { mods: ["web"].concat(result), lang: lang};
|
|
self.rpc('/web/webclient/translations',params).pipe(function(transs) {
|
|
openerp.web._t.database.set_bundle(transs);
|
|
var modules = self.module_list.join(',');
|
|
var file_list = ["/web/static/lib/datejs/globalization/" +
|
|
self.user_context.lang.replace("_", "-") + ".js"
|
|
];
|
|
return $.when(
|
|
self.rpc('/web/webclient/csslist', {mods: modules}, self.do_load_css),
|
|
self.rpc('/web/webclient/qweblist', {mods: modules}).pipe(self.do_load_qweb),
|
|
self.rpc('/web/webclient/jslist', {mods: modules}).pipe(function(files) {
|
|
return self.do_load_js(file_list.concat(files));
|
|
})
|
|
).then(function() {
|
|
self.ready.resolve();
|
|
});
|
|
});
|
|
});
|
|
},
|
|
do_load_css: function (files) {
|
|
var self = this;
|
|
_.each(files, function (file) {
|
|
$('head').append($('<link>', {
|
|
'href': self.get_url(file),
|
|
'rel': 'stylesheet',
|
|
'type': 'text/css'
|
|
}));
|
|
});
|
|
},
|
|
do_load_js: function(files) {
|
|
var self = this;
|
|
var d = $.Deferred();
|
|
if(files.length != 0) {
|
|
var file = files.shift();
|
|
var tag = document.createElement('script');
|
|
tag.type = 'text/javascript';
|
|
tag.src = self.get_url(file);
|
|
tag.onload = tag.onreadystatechange = function() {
|
|
if ( (tag.readyState && tag.readyState != "loaded" && tag.readyState != "complete") || tag.onload_done )
|
|
return;
|
|
tag.onload_done = true;
|
|
self.do_load_js(files).then(function () {
|
|
d.resolve();
|
|
});
|
|
};
|
|
var head = document.head || document.getElementsByTagName('head')[0];
|
|
head.appendChild(tag);
|
|
} else {
|
|
self.on_modules_loaded();
|
|
d.resolve();
|
|
}
|
|
return d;
|
|
},
|
|
do_load_qweb: function(files) {
|
|
var self = this;
|
|
if (files.length != 0) {
|
|
var file = files.shift();
|
|
return self.rpc('/web/proxy/load', {path: file}).pipe(function(xml) {
|
|
openerp.web.qweb.add_template(_.str.trim(xml));
|
|
return self.do_load_qweb(files);
|
|
});
|
|
} else {
|
|
return $.when();
|
|
}
|
|
},
|
|
on_modules_loaded: function() {
|
|
for(var j=0; j<this.module_list.length; j++) {
|
|
var mod = this.module_list[j];
|
|
if(this.module_loaded[mod])
|
|
continue;
|
|
openerp[mod] = {};
|
|
// init module mod
|
|
if(openerp._openerp[mod] != undefined) {
|
|
openerp._openerp[mod](openerp);
|
|
this.module_loaded[mod] = true;
|
|
}
|
|
}
|
|
},
|
|
get_url: function (file) {
|
|
return this.prefix + file;
|
|
},
|
|
/**
|
|
* Cooperative file download implementation, for ajaxy APIs.
|
|
*
|
|
* Requires that the server side implements an httprequest correctly
|
|
* setting the `fileToken` cookie to the value provided as the `token`
|
|
* parameter. The cookie *must* be set on the `/` path and *must not* be
|
|
* `httpOnly`.
|
|
*
|
|
* It would probably also be a good idea for the response to use a
|
|
* `Content-Disposition: attachment` header, especially if the MIME is a
|
|
* "known" type (e.g. text/plain, or for some browsers application/json
|
|
*
|
|
* @param {Object} options
|
|
* @param {String} [options.url] used to dynamically create a form
|
|
* @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
|
|
* @param {HTMLFormElement} [options.form] the form to submit in order to fetch the file
|
|
* @param {Function} [options.success] callback in case of download success
|
|
* @param {Function} [options.error] callback in case of request error, provided with the error body
|
|
* @param {Function} [options.complete] called after both ``success`` and ``error` callbacks have executed
|
|
*/
|
|
get_file: function (options) {
|
|
// need to detect when the file is done downloading (not used
|
|
// yet, but we'll need it to fix the UI e.g. with a throbber
|
|
// while dump is being generated), iframe load event only fires
|
|
// when the iframe content loads, so we need to go smarter:
|
|
// http://geekswithblogs.net/GruffCode/archive/2010/10/28/detecting-the-file-download-dialog-in-the-browser.aspx
|
|
var timer, token = new Date().getTime(),
|
|
cookie_name = 'fileToken', cookie_length = cookie_name.length,
|
|
CHECK_INTERVAL = 1000, id = _.uniqueId('get_file_frame'),
|
|
remove_form = false;
|
|
|
|
var $form, $form_data = $('<div>');
|
|
|
|
var complete = function () {
|
|
if (options.complete) { options.complete(); }
|
|
clearTimeout(timer);
|
|
$form_data.remove();
|
|
$target.remove();
|
|
if (remove_form && $form) { $form.remove(); }
|
|
};
|
|
var $target = $('<iframe style="display: none;">')
|
|
.attr({id: id, name: id})
|
|
.appendTo(document.body)
|
|
.load(function () {
|
|
if (options.error) { options.error(this.contentDocument.body); }
|
|
complete();
|
|
});
|
|
|
|
if (options.form) {
|
|
$form = $(options.form);
|
|
} else {
|
|
remove_form = true;
|
|
$form = $('<form>', {
|
|
action: options.url,
|
|
method: 'POST'
|
|
}).appendTo(document.body);
|
|
}
|
|
|
|
_(_.extend({}, options.data || {},
|
|
{session_id: this.session_id, token: token}))
|
|
.each(function (value, key) {
|
|
$('<input type="hidden" name="' + key + '">')
|
|
.val(value)
|
|
.appendTo($form_data);
|
|
});
|
|
|
|
$form
|
|
.append($form_data)
|
|
.attr('target', id)
|
|
.get(0).submit();
|
|
|
|
var waitLoop = function () {
|
|
var cookies = document.cookie.split(';');
|
|
// setup next check
|
|
timer = setTimeout(waitLoop, CHECK_INTERVAL);
|
|
for (var i=0; i<cookies.length; ++i) {
|
|
var cookie = cookies[i].replace(/^\s*/, '');
|
|
if (!cookie.indexOf(cookie_name === 0)) { continue; }
|
|
var cookie_val = cookie.substring(cookie_length + 1);
|
|
if (parseInt(cookie_val, 10) !== token) { continue; }
|
|
|
|
// clear cookie
|
|
document.cookie = _.str.sprintf("%s=;expires=%s;path=/",
|
|
cookie_name, new Date().toGMTString());
|
|
if (options.success) { options.success(); }
|
|
complete();
|
|
return;
|
|
}
|
|
};
|
|
timer = setTimeout(waitLoop, CHECK_INTERVAL);
|
|
}
|
|
});
|
|
|
|
/**
|
|
* Base class for all visual components. Provides a lot of functionalities helpful
|
|
* for the management of a part of the DOM.
|
|
*
|
|
* Widget handles:
|
|
* - Rendering with QWeb.
|
|
* - Life-cycle management and parenting (when a parent is destroyed, all its children are
|
|
* destroyed too).
|
|
* - Insertion in DOM.
|
|
*
|
|
* Guide to create implementations of the Widget class:
|
|
* ==============================================
|
|
*
|
|
* Here is a sample child class:
|
|
*
|
|
* MyWidget = openerp.base.Widget.extend({
|
|
* // the name of the QWeb template to use for rendering
|
|
* template: "MyQWebTemplate",
|
|
* // identifier prefix, it is useful to put an obvious one for debugging
|
|
* identifier_prefix: 'my-id-prefix-',
|
|
*
|
|
* init: function(parent) {
|
|
* this._super(parent);
|
|
* // stuff that you want to init before the rendering
|
|
* },
|
|
* start: function() {
|
|
* // stuff you want to make after the rendering, `this.$element` holds a correct value
|
|
* this.$element.find(".my_button").click(/* an example of event binding * /);
|
|
*
|
|
* // if you have some asynchronous operations, it's a good idea to return
|
|
* // a promise in start()
|
|
* var promise = this.rpc(...);
|
|
* return promise;
|
|
* }
|
|
* });
|
|
*
|
|
* Now this class can simply be used with the following syntax:
|
|
*
|
|
* var my_widget = new MyWidget(this);
|
|
* my_widget.appendTo($(".some-div"));
|
|
*
|
|
* With these two lines, the MyWidget instance was inited, rendered, it was inserted into the
|
|
* DOM inside the ".some-div" div and its events were binded.
|
|
*
|
|
* And of course, when you don't need that widget anymore, just do:
|
|
*
|
|
* my_widget.stop();
|
|
*
|
|
* That will kill the widget in a clean way and erase its content from the dom.
|
|
*/
|
|
openerp.web.Widget = openerp.web.CallbackEnabled.extend(/** @lends openerp.web.Widget# */{
|
|
/**
|
|
* The name of the QWeb template that will be used for rendering. Must be
|
|
* redefined in subclasses or the default render() method can not be used.
|
|
*
|
|
* @type string
|
|
*/
|
|
template: null,
|
|
/**
|
|
* The prefix used to generate an id automatically. Should be redefined in
|
|
* subclasses. If it is not defined, a generic identifier will be used.
|
|
*
|
|
* @type string
|
|
*/
|
|
identifier_prefix: 'generic-identifier-',
|
|
/**
|
|
* Tag name when creating a default $element.
|
|
* @type string
|
|
*/
|
|
tag_name: 'div',
|
|
/**
|
|
* Constructs the widget and sets its parent if a parent is given.
|
|
*
|
|
* @constructs openerp.web.Widget
|
|
* @extends openerp.web.CallbackEnabled
|
|
*
|
|
* @param {openerp.web.Widget} parent Binds the current instance to the given Widget instance.
|
|
* When that widget is destroyed by calling stop(), the current instance will be
|
|
* destroyed too. Can be null.
|
|
* @param {String} element_id Deprecated. Sets the element_id. Only useful when you want
|
|
* to bind the current Widget to an already existing part of the DOM, which is not compatible
|
|
* with the DOM insertion methods provided by the current implementation of Widget. So
|
|
* for new components this argument should not be provided any more.
|
|
*/
|
|
init: function(parent, /** @deprecated */ element_id) {
|
|
this._super();
|
|
this.session = openerp.connection;
|
|
// if given an element_id, try to get the associated DOM element and save
|
|
// a reference in this.$element. Else just generate a unique identifier.
|
|
this.element_id = element_id;
|
|
this.element_id = this.element_id || _.uniqueId(this.identifier_prefix);
|
|
var tmp = document.getElementById(this.element_id);
|
|
this.$element = tmp ? $(tmp) : $(document.createElement(this.tag_name));
|
|
|
|
this.widget_parent = parent;
|
|
this.widget_children = [];
|
|
if(parent && parent.widget_children) {
|
|
parent.widget_children.push(this);
|
|
}
|
|
// useful to know if the widget was destroyed and should not be used anymore
|
|
this.widget_is_stopped = false;
|
|
},
|
|
/**
|
|
* Renders the current widget and appends it to the given jQuery object or Widget.
|
|
*
|
|
* @param target A jQuery object or a Widget instance.
|
|
*/
|
|
appendTo: function(target) {
|
|
var self = this;
|
|
return this._render_and_insert(function(t) {
|
|
self.$element.appendTo(t);
|
|
}, target);
|
|
},
|
|
/**
|
|
* Renders the current widget and prepends it to the given jQuery object or Widget.
|
|
*
|
|
* @param target A jQuery object or a Widget instance.
|
|
*/
|
|
prependTo: function(target) {
|
|
var self = this;
|
|
return this._render_and_insert(function(t) {
|
|
self.$element.prependTo(t);
|
|
}, target);
|
|
},
|
|
/**
|
|
* Renders the current widget and inserts it after to the given jQuery object or Widget.
|
|
*
|
|
* @param target A jQuery object or a Widget instance.
|
|
*/
|
|
insertAfter: function(target) {
|
|
var self = this;
|
|
return this._render_and_insert(function(t) {
|
|
self.$element.insertAfter(t);
|
|
}, target);
|
|
},
|
|
/**
|
|
* Renders the current widget and inserts it before to the given jQuery object or Widget.
|
|
*
|
|
* @param target A jQuery object or a Widget instance.
|
|
*/
|
|
insertBefore: function(target) {
|
|
var self = this;
|
|
return this._render_and_insert(function(t) {
|
|
self.$element.insertBefore(t);
|
|
}, target);
|
|
},
|
|
/**
|
|
* Renders the current widget and replaces the given jQuery object.
|
|
*
|
|
* @param target A jQuery object or a Widget instance.
|
|
*/
|
|
replace: function(target) {
|
|
return this._render_and_insert(_.bind(function(t) {
|
|
this.$element.replaceAll(t);
|
|
}, this), target);
|
|
},
|
|
_render_and_insert: function(insertion, target) {
|
|
this.render_element();
|
|
if (target instanceof openerp.web.Widget)
|
|
target = target.$element;
|
|
insertion(target);
|
|
this.on_inserted(this.$element, this);
|
|
return this.start();
|
|
},
|
|
on_inserted: function(element, widget) {},
|
|
/**
|
|
* Renders the element and insert the result of the render() method in this.$element.
|
|
*/
|
|
render_element: function() {
|
|
var rendered = this.render();
|
|
if (rendered) {
|
|
var elem = $(rendered);
|
|
this.$element.replaceWith(elem);
|
|
this.$element = elem;
|
|
}
|
|
return this;
|
|
},
|
|
/**
|
|
* Renders the widget using QWeb, `this.template` must be defined.
|
|
* The context given to QWeb contains the "widget" key that references `this`.
|
|
*
|
|
* @param {Object} additional Additional context arguments to pass to the template.
|
|
*/
|
|
render: function (additional) {
|
|
if (this.template)
|
|
return openerp.web.qweb.render(this.template, _.extend({widget: this}, additional || {}));
|
|
return null;
|
|
},
|
|
/**
|
|
* Method called after rendering. Mostly used to bind actions, perform asynchronous
|
|
* calls, etc...
|
|
*
|
|
* By convention, the method should return a promise to inform the caller when
|
|
* this widget has been initialized.
|
|
*
|
|
* @returns {jQuery.Deferred}
|
|
*/
|
|
start: function() {
|
|
return $.Deferred().done().promise();
|
|
},
|
|
/**
|
|
* Destroys the current widget, also destroys all its children before destroying itself.
|
|
*/
|
|
stop: function() {
|
|
_.each(_.clone(this.widget_children), function(el) {
|
|
el.stop();
|
|
});
|
|
if(this.$element != null) {
|
|
this.$element.remove();
|
|
}
|
|
if (this.widget_parent && this.widget_parent.widget_children) {
|
|
this.widget_parent.widget_children = _.without(this.widget_parent.widget_children, this);
|
|
}
|
|
this.widget_parent = null;
|
|
this.widget_is_stopped = true;
|
|
},
|
|
/**
|
|
* Informs the action manager to do an action. This supposes that
|
|
* the action manager can be found amongst the ancestors of the current widget.
|
|
* If that's not the case this method will simply return `false`.
|
|
*/
|
|
do_action: function(action, on_finished) {
|
|
if (this.widget_parent) {
|
|
return this.widget_parent.do_action(action, on_finished);
|
|
}
|
|
return false;
|
|
},
|
|
do_notify: function() {
|
|
if (this.widget_parent) {
|
|
return this.widget_parent.do_notify.apply(this,arguments);
|
|
}
|
|
return false;
|
|
},
|
|
do_warn: function() {
|
|
if (this.widget_parent) {
|
|
return this.widget_parent.do_warn.apply(this,arguments);
|
|
}
|
|
return false;
|
|
},
|
|
|
|
rpc: function(url, data, success, error) {
|
|
var def = $.Deferred().then(success, error);
|
|
var self = this;
|
|
openerp.connection.rpc(url, data). then(function() {
|
|
if (!self.widget_is_stopped)
|
|
def.resolve.apply(def, arguments);
|
|
}, function() {
|
|
if (!self.widget_is_stopped)
|
|
def.reject.apply(def, arguments);
|
|
});
|
|
return def.promise();
|
|
}
|
|
});
|
|
|
|
/**
|
|
* @class
|
|
* @extends openerp.web.Widget
|
|
* @deprecated
|
|
* For retro compatibility only, the only difference with is that render() uses
|
|
* directly ``this`` instead of context with a ``widget`` key.
|
|
*/
|
|
openerp.web.OldWidget = openerp.web.Widget.extend(/** @lends openerp.web.OldWidget# */{
|
|
render: function (additional) {
|
|
return openerp.web.qweb.render(this.template, _.extend(_.extend({}, this), additional || {}));
|
|
}
|
|
});
|
|
|
|
openerp.web.TranslationDataBase = openerp.web.Class.extend(/** @lends openerp.web.TranslationDataBase# */{
|
|
/**
|
|
* @constructs openerp.web.TranslationDataBase
|
|
* @extends openerp.web.Class
|
|
*/
|
|
init: function() {
|
|
this.db = {};
|
|
this.parameters = {"direction": 'ltr',
|
|
"date_format": '%m/%d/%Y',
|
|
"time_format": '%H:%M:%S',
|
|
"grouping": [],
|
|
"decimal_point": ".",
|
|
"thousands_sep": ","};
|
|
},
|
|
set_bundle: function(translation_bundle) {
|
|
var self = this;
|
|
this.db = {};
|
|
var modules = _.keys(translation_bundle.modules);
|
|
modules.sort();
|
|
if (_.include(modules, "web")) {
|
|
modules = ["web"].concat(_.without(modules, "web"));
|
|
}
|
|
_.each(modules, function(name) {
|
|
self.add_module_translation(translation_bundle.modules[name]);
|
|
});
|
|
if (translation_bundle.lang_parameters) {
|
|
this.parameters = translation_bundle.lang_parameters;
|
|
this.parameters.grouping = py.eval(
|
|
this.parameters.grouping).toJSON();
|
|
}
|
|
},
|
|
add_module_translation: function(mod) {
|
|
var self = this;
|
|
_.each(mod.messages, function(message) {
|
|
if (self.db[message.id] === undefined) {
|
|
self.db[message.id] = message.string;
|
|
}
|
|
});
|
|
},
|
|
build_translation_function: function() {
|
|
var self = this;
|
|
var fcnt = function(str) {
|
|
var tmp = self.get(str);
|
|
return tmp === undefined ? str : tmp;
|
|
};
|
|
fcnt.database = this;
|
|
return fcnt;
|
|
},
|
|
get: function(key) {
|
|
if (this.db[key])
|
|
return this.db[key];
|
|
return undefined;
|
|
}
|
|
});
|
|
|
|
/** Configure blockui */
|
|
if ($.blockUI) {
|
|
$.blockUI.defaults.baseZ = 1100;
|
|
$.blockUI.defaults.message = '<img src="/web/static/src/img/throbber2.gif">';
|
|
}
|
|
|
|
/** Configure default qweb */
|
|
openerp.web._t = new openerp.web.TranslationDataBase().build_translation_function();
|
|
/**
|
|
* Lazy translation function, only performs the translation when actually
|
|
* printed (e.g. inserted into a template)
|
|
*
|
|
* Useful when defining translatable strings in code evaluated before the
|
|
* translation database is loaded, as class attributes or at the top-level of
|
|
* an OpenERP Web module
|
|
*
|
|
* @param {String} s string to translate
|
|
* @returns {Object} lazy translation object
|
|
*/
|
|
openerp.web._lt = function (s) {
|
|
return {toString: function () { return openerp.web._t(s); }}
|
|
};
|
|
openerp.web.qweb = new QWeb2.Engine();
|
|
openerp.web.qweb.debug = (window.location.search.indexOf('?debug') !== -1);
|
|
openerp.web.qweb.default_dict = {
|
|
'_' : _,
|
|
'_t' : openerp.web._t
|
|
};
|
|
openerp.web.qweb.format_text_node = function(s) {
|
|
// Note that 'this' is the Qweb Node of the text
|
|
var translation = this.node.parentNode.attributes['t-translation'];
|
|
if (translation && translation.value === 'off') {
|
|
return s;
|
|
}
|
|
var ts = _.str.trim(s);
|
|
if (ts.length === 0) {
|
|
return s;
|
|
}
|
|
var tr = openerp.web._t(ts);
|
|
return tr === ts ? s : tr;
|
|
}
|
|
|
|
/** Setup default connection */
|
|
openerp.connection = new openerp.web.Connection();
|
|
openerp.web.qweb.default_dict['__debug__'] = openerp.connection.debug;
|
|
|
|
/** Jquery extentions */
|
|
$.Mutex = (function() {
|
|
function Mutex() {
|
|
this.def = $.Deferred().resolve();
|
|
};
|
|
Mutex.prototype.exec = function(action) {
|
|
var current = this.def;
|
|
var next = this.def = $.Deferred();
|
|
return current.pipe(function() {
|
|
return $.when(action()).always(function() {
|
|
next.resolve();
|
|
});
|
|
});
|
|
};
|
|
return Mutex;
|
|
})();
|
|
|
|
$.async_when = function() {
|
|
var async = false;
|
|
var def = $.Deferred();
|
|
$.when.apply($, arguments).then(function() {
|
|
var args = arguments;
|
|
var action = function() {
|
|
def.resolve.apply(def, args);
|
|
};
|
|
if (async)
|
|
action();
|
|
else
|
|
setTimeout(action, 0);
|
|
}, function() {
|
|
var args = arguments;
|
|
var action = function() {
|
|
def.reject.apply(def, args);
|
|
};
|
|
if (async)
|
|
action();
|
|
else
|
|
setTimeout(action, 0);
|
|
});
|
|
async = true;
|
|
return def;
|
|
};
|
|
|
|
};
|
|
|
|
// vim:et fdc=0 fdl=0 foldnestmax=3 fdm=syntax:
|