odoo
/
odoo
2
0
Fork 0
Code Pull Requests Releases Activity

[FIX] breakage in case of repeated calls to getFile for the same form: remove token after download has completed (or errored out) 

also add some documentation for openerp.base.Session.getFile

bzr revid: xmo@openerp.com-20110830090514-pa5lnxvee4qfg0zp
This commit is contained in:
Xavier Morel 2011-08-30 11:05:14 +02:00
parent 9c0486b738
commit 79fb169fc7
2 changed files with 29 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
addons/base/static/src/js/chrome.js
View File

@ -348,17 +348,14 @@ openerp.base.Database = openerp.base.Widget.extend({
$.blockUI({message:'<img src="/base/static/src/img/throbber2.gif">'});
self.session.getFile({
form: form,
success: function () {
$.unblockUI();
},
error: function (body) {
$.unblockUI();
var error = body.firstChild.data.split('|');
self.display_error({
title: error[0],
error: error[1]
});
}
},
complete: $.unblockUI
});
}
});

30
addons/base/static/src/js/core.js
View File

@ -614,6 +614,24 @@ openerp.base.Session = openerp.base.CallbackEnabled.extend( /** @lends openerp.b
}
}
},
/**
* 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 {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
*/
getFile: 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
@ -622,8 +640,14 @@ openerp.base.Session = openerp.base.CallbackEnabled.extend( /** @lends openerp.b
// 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,
self = this, CHECK_INTERVAL = 100, id = _.uniqueId('get_file_frame');
var complete = function () { clearTimeout(timer); $target.remove(); };
self = this, CHECK_INTERVAL = 100, id = _.uniqueId('get_file_frame'),
$token = $('<input type="hidden" name="token" value="' + token +'">');
var complete = function () {
if (options.complete) { options.complete(); }
clearTimeout(timer);
$token.remove();
$target.remove();
};
var $target = $('<iframe style="display: none;">')
.attr({id: id, name: id})
.appendTo(document.body)
@ -634,7 +658,7 @@ openerp.base.Session = openerp.base.CallbackEnabled.extend( /** @lends openerp.b
complete();
});
$(options.form)
.append('<input type="hidden" name="token" value="' + token +'">')
.append($token)
.attr('target', id)
.get(0).submit();