1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
odoo.define('web.fileUploadMixin', function (require) {
'use strict';
/**
* Mixin to be used in view Controllers to manage uploads and generate progress bars.
* supported views: kanban, list
*/
const { csrf_token, _t } = require('web.core');
const ProgressBar = require('web.ProgressBar');
const ProgressCard = require('web.ProgressCard');
const ProgressBarMixin = {
custom_events: {
progress_bar_abort: '_onProgressBarAbort',
},
init() {
/**
* Contains the uploads currently happening, used to attach progress bars.
* e.g: {'fileUploadId45': {progressBar, progressCard, ...params}}
*/
this._fileUploads = {};
},
//--------------------------------------------------------------------------
// Private
//--------------------------------------------------------------------------
/**
* used to use a mocked version of Xhr in the tests.
*
* @private
* @returns {XMLHttpRequest}
*/
_createXhr() {
return new window.XMLHttpRequest();
},
/**
* @private
*/
_getFileUploadRenderOptions() {
return {
predicate: () => true,
targetCallback: undefined,
};
},
/**
* @private
* @returns {string} upload route
*/
_getFileUploadRoute() {
return '/web/binary/upload_attachment';
},
/**
* @private
* @param {Object} params
* @param {Object[]} params.files
* @param {XMLHttpRequest} params.xhr
*/
_makeFileUpload(params) {
const { files, xhr } = params;
const fileUploadId = _.uniqueId('fileUploadId');
const formData = new FormData();
const formDataKeys = this._makeFileUploadFormDataKeys(Object.assign({ fileUploadId }, params));
formData.append('csrf_token', csrf_token);
for (const key in formDataKeys) {
if (formDataKeys[key] !== undefined) {
formData.append(key, formDataKeys[key]);
}
}
for (const file of files) {
formData.append('ufile', file);
}
return {
fileUploadId,
xhr,
title: files.length === 1
? files[0].name
: _.str.sprintf(_t("%s Files"), files.length),
type: files.length === 1 ? files[0].type : undefined,
formData,
};
},
/**
* @private
* @param {Object} param0
* @param {string} param0.fileUploadId
* @returns {Object} the list of the form entries of a file upload.
*/
_makeFileUploadFormDataKeys({ fileUploadId }) {
return {
callback: fileUploadId,
};
},
/**
* @private
* @param {integer} fileUploadId
*/
async _removeFileUpload(fileUploadId) {
const upload = this._fileUploads[fileUploadId];
upload.progressCard && upload.progressCard.destroy();
upload.progressBar && upload.progressBar.destroy();
delete this._fileUploads[fileUploadId];
await this.reload();
},
/**
* @private
*/
async _renderFileUploads() {
const { predicate, targetCallback } = this._getFileUploadRenderOptions();
for (const fileUploadId in this._fileUploads) {
const upload = this._fileUploads[fileUploadId];
if (!predicate(upload)) {
continue;
}
if (!upload.progressBar) {
if (!upload.recordId || this.viewType !== 'kanban') {
upload.progressCard = new ProgressCard(this, {
title: upload.title,
type: upload.type,
viewType: this.viewType,
});
}
upload.progressBar = new ProgressBar(this, {
xhr: upload.xhr,
title: upload.title,
fileUploadId,
});
}
let $targetCard;
if (upload.progressCard) {
await upload.progressCard.prependTo(this.renderer.$el);
$targetCard = upload.progressCard.$el;
} else if (targetCallback) {
$targetCard = targetCallback(upload);
}
await upload.progressBar.appendTo($targetCard);
}
},
/**
* @private
* @param {Object[]} files
* @param {Object} [params] optional additional data
*/
async _uploadFiles(files, params={}) {
if (!files || !files.length) { return; }
await new Promise(resolve => {
const xhr = this._createXhr();
xhr.open('POST', this._getFileUploadRoute());
const fileUploadData = this._makeFileUpload(Object.assign({ files, xhr }, params));
const { fileUploadId, formData } = fileUploadData;
this._fileUploads[fileUploadId] = fileUploadData;
xhr.upload.addEventListener("progress", ev => {
this._updateFileUploadProgress(fileUploadId, ev);
});
const progressPromise = this._onBeforeUpload();
xhr.onload = async () => {
await progressPromise;
resolve();
this._onUploadLoad({ fileUploadId, xhr });
};
xhr.onerror = async () => {
await progressPromise;
resolve();
this._onUploadError({ fileUploadId, xhr });
};
xhr.send(formData);
});
},
/**
* @private
* @param {string} fileUploadId
* @param {ProgressEvent} ev
*/
_updateFileUploadProgress(fileUploadId, ev) {
const { progressCard, progressBar } = this._fileUploads[fileUploadId];
progressCard && progressCard.update(ev.loaded, ev.total);
progressBar && progressBar.update(ev.loaded, ev.total);
},
//--------------------------------------------------------------------------
// Handlers
//--------------------------------------------------------------------------
/**
* Hook to customize the behaviour of _uploadFiles() before an upload is made.
*
* @private
*/
async _onBeforeUpload() {
await this._renderFileUploads();
},
/**
* @private
* @param {OdooEvent} ev
* @param {integer} ev.data.fileUploadId
*/
_onProgressBarAbort(ev) {
this._removeFileUpload(ev.data.fileUploadId);
},
/**
* Hook to customize the behaviour of the xhr.onload of an upload.
*
* @private
* @param {string} param0.fileUploadId
*/
_onUploadLoad({ fileUploadId }) {
this._removeFileUpload(fileUploadId);
},
/**
* Hook to customize the behaviour of the xhr.onerror of an upload.
*
* @private
* @param {string} param1.fileUploadId
* @param {XMLHttpRequest} param0.xhr
*/
_onUploadError({ fileUploadId, xhr }) {
this.do_notify(xhr.status, _.str.sprintf(_t('message: %s'), xhr.reponseText), true);
this._removeFileUpload(fileUploadId);
},
};
return ProgressBarMixin;
});
|
