Merge branch 'MDL-36900-master' of git://github.com/FMCorz/moodle
[moodle.git] / lib / form / dndupload.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * Javascript library for enableing a drag and drop upload interface
18  *
19  * @package    moodlecore
20  * @subpackage form
21  * @copyright  2011 Davo Smith
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 M.form_dndupload = {}
27 M.form_dndupload.init = function(Y, options) {
28     var dnduploadhelper = {
29         // YUI object.
30         Y: null,
31         // URL for upload requests
32         url: M.cfg.wwwroot + '/repository/repository_ajax.php?action=upload',
33         // options may include: itemid, acceptedtypes, maxfiles, maxbytes, clientid, repositoryid, author
34         options: {},
35         // itemid used for repository upload
36         itemid: null,
37         // accepted filetypes accepted by this form passed to repository
38         acceptedtypes: [],
39         // maximum size of files allowed in this form
40         maxbytes: 0,
41         // Maximum combined size of files allowed in this form. {@link FILE_AREA_MAX_BYTES_UNLIMITED}
42         areamaxbytes: -1,
43         // unqiue id of this form field used for html elements
44         clientid: '',
45         // upload repository id, used for upload
46         repositoryid: 0,
47         // container which holds the node which recieves drag events
48         container: null,
49         // filemanager element we are working with
50         filemanager: null,
51         // callback  to filepicker element to refesh when uploaded
52         callback: null,
53         // Nasty hack to distinguish between dragenter(first entry),
54         // dragenter+dragleave(moving between child elements) and dragleave (leaving element)
55         entercount: 0,
56         pageentercount: 0,
57         // Holds the progress bar elements for each file.
58         progressbars: {},
60         /**
61          * Initalise the drag and drop upload interface
62          * Note: one and only one of options.filemanager and options.formcallback must be defined
63          *
64          * @param Y the YUI object
65          * @param object options {
66          *            itemid: itemid used for repository upload in this form
67          *            acceptdtypes: accepted filetypes by this form
68          *            maxfiles: maximum number of files this form allows
69          *            maxbytes: maximum size of files allowed in this form
70          *            areamaxbytes: maximum combined size of files allowed in this form
71          *            clientid: unqiue id of this form field used for html elements
72          *            containerid: htmlid of container
73          *            repositories: array of repository objects passed from filepicker
74          *            filemanager: filemanager element we are working with
75          *            formcallback: callback  to filepicker element to refesh when uploaded
76          *          }
77          */
78         init: function(Y, options) {
79             this.Y = Y;
81             if (!this.browser_supported()) {
82                 Y.one('body').addClass('dndnotsupported');
83                 return; // Browser does not support the required functionality
84             }
85             Y.one('body').addClass('dndsupported');
87             // try and retrieve enabled upload repository
88             this.repositoryid = this.get_upload_repositoryid(options.repositories);
90             if (!this.repositoryid) {
91                 return; // no upload repository is enabled to upload to
92             }
94             this.options = options;
95             this.acceptedtypes = options.acceptedtypes;
96             this.clientid = options.clientid;
97             this.maxbytes = options.maxbytes;
98             this.areamaxbytes = options.areamaxbytes;
99             this.itemid = options.itemid;
100             this.author = options.author;
101             this.container = this.Y.one('#'+options.containerid);
103             if (options.filemanager) {
104                 // Needed to tell the filemanager to redraw when files uploaded
105                 // and to check how many files are already uploaded
106                 this.filemanager = options.filemanager;
107             } else if (options.formcallback) {
109                 // Needed to tell the filepicker to update when a new
110                 // file is uploaded
111                 this.callback = options.formcallback;
112             } else {
113                 if (M.cfg.developerdebug) {
114                     alert('dndupload: Need to define either options.filemanager or options.formcallback');
115                 }
116                 return;
117             }
119             this.init_events();
120             this.init_page_events();
121         },
123         /**
124          * Check the browser has the required functionality
125          * @return true if browser supports drag/drop upload
126          */
127         browser_supported: function() {
129             if (typeof FileReader == 'undefined') {
130                 return false;
131             }
132             if (typeof FormData == 'undefined') {
133                 return false;
134             }
135             return true;
136         },
138         /**
139          * Get upload repoistory from array of enabled repositories
140          *
141          * @param array repositories repository objects passed from filepicker
142          * @param returns int id of upload repository or false if not found
143          */
144         get_upload_repositoryid: function(repositories) {
145             for (var i in repositories) {
146                 if (repositories[i].type == "upload") {
147                     return repositories[i].id;
148                 }
149             }
151             return false;
152         },
154         /**
155          * Initialise drag events on node container, all events need
156          * to be processed for drag and drop to work
157          */
158         init_events: function() {
159             this.Y.on('dragenter', this.drag_enter, this.container, this);
160             this.Y.on('dragleave', this.drag_leave, this.container, this);
161             this.Y.on('dragover',  this.drag_over,  this.container, this);
162             this.Y.on('drop',      this.drop,      this.container, this);
163         },
165         /**
166          * Initialise whole-page events (to show / hide the 'drop files here'
167          * message)
168          */
169         init_page_events: function() {
170             this.Y.on('dragenter', this.drag_enter_page, 'body', this);
171             this.Y.on('dragleave', this.drag_leave_page, 'body', this);
172         },
174         /**
175          * Check if the filemanager / filepicker is disabled
176          * @return bool - true if disabled
177          */
178         is_disabled: function() {
179             return (this.container.ancestor('.fitem.disabled') != null);
180         },
182         /**
183          * Show the 'drop files here' message when file(s) are dragged
184          * onto the page
185          */
186         drag_enter_page: function(e) {
187             if (this.is_disabled()) {
188                 return false;
189             }
190             if (!this.has_files(e)) {
191                 return false;
192             }
194             this.pageentercount++;
195             if (this.pageentercount >= 2) {
196                 this.pageentercount = 2;
197                 return false;
198             }
200             this.show_drop_target();
202             return false;
203         },
205         /**
206          * Hide the 'drop files here' message when file(s) are dragged off
207          * the page again
208          */
209         drag_leave_page: function(e) {
210             this.pageentercount--;
211             if (this.pageentercount == 1) {
212                 return false;
213             }
214             this.pageentercount = 0;
216             this.hide_drop_target();
218             return false;
219         },
221         /**
222          * Check if the drag contents are valid and then call
223          * preventdefault / stoppropagation to let the browser know
224          * we will handle this drag/drop
225          *
226          * @param e event object
227          * @return boolean true if a valid file drag event
228          */
229         check_drag: function(e) {
230             if (this.is_disabled()) {
231                 return false;
232             }
233             if (!this.has_files(e)) {
234                 return false;
235             }
237             e.preventDefault();
238             e.stopPropagation();
240             return true;
241         },
243         /**
244          * Handle a dragenter event, highlight the destination node
245          * when a suitable drag event occurs
246          */
247         drag_enter: function(e) {
248             if (!this.check_drag(e)) {
249                 return true;
250             }
252             this.entercount++;
253             if (this.entercount >= 2) {
254                 this.entercount = 2; // Just moved over a child element - nothing to do
255                 return false;
256             }
258             // These lines are needed if the user has dragged something directly
259             // from application onto the 'fileupload' box, without crossing another
260             // part of the page first
261             this.pageentercount = 2;
262             this.show_drop_target();
264             this.show_upload_ready();
265             return false;
266         },
268         /**
269          * Handle a dragleave event, Remove the highlight if dragged from
270          * node
271          */
272         drag_leave: function(e) {
273             if (!this.check_drag(e)) {
274                 return true;
275             }
277             this.entercount--;
278             if (this.entercount == 1) {
279                 return false; // Just moved over a child element - nothing to do
280             }
282             this.entercount = 0;
283             this.hide_upload_ready();
284             return false;
285         },
287         /**
288          * Handle a dragover event. Required to intercept to prevent the browser from
289          * handling the drag and drop event as normal
290          */
291         drag_over: function(e) {
292             if (!this.check_drag(e)) {
293                 return true;
294             }
296             return false;
297         },
299         /**
300          * Handle a drop event.  Remove the highlight and then upload each
301          * of the files (until we reach the file limit, or run out of files)
302          */
303         drop: function(e) {
304             if (!this.check_drag(e, true)) {
305                 return true;
306             }
308             this.entercount = 0;
309             this.pageentercount = 0;
310             this.hide_upload_ready();
311             this.hide_drop_target();
313             var files = e._event.dataTransfer.files;
314             if (this.filemanager) {
315                 var options = {
316                     files: files,
317                     options: this.options,
318                     repositoryid: this.repositoryid,
319                     currentfilecount: this.filemanager.filecount, // All files uploaded.
320                     currentfiles: this.filemanager.options.list, // Only the current folder.
321                     callback: Y.bind('update_filemanager', this),
322                     callbackprogress: Y.bind('update_progress', this),
323                     callbackcancel:Y.bind('hide_progress', this)
324                 };
325                 this.clear_progress();
326                 this.show_progress();
327                 var uploader = new dnduploader(options);
328                 uploader.start_upload();
329             } else {
330                 if (files.length >= 1) {
331                     options = {
332                         files:[files[0]],
333                         options: this.options,
334                         repositoryid: this.repositoryid,
335                         currentfilecount: 0,
336                         currentfiles: [],
337                         callback: Y.bind('update_filemanager', this),
338                         callbackprogress: Y.bind('update_progress', this),
339                         callbackcancel:Y.bind('hide_progress', this)
340                     };
341                     this.clear_progress();
342                     this.show_progress();
343                     uploader = new dnduploader(options);
344                     uploader.start_upload();
345                 }
346             }
348             return false;
349         },
351         /**
352          * Check to see if the drag event has any files in it
353          *
354          * @param e event object
355          * @return boolean true if event has files
356          */
357         has_files: function(e) {
358             var types = e._event.dataTransfer.types;
359             for (var i=0; i<types.length; i++) {
360                 if (types[i] == 'Files') {
361                     return true;
362                 }
363             }
364             return false;
365         },
367         /**
368          * Highlight the area where files could be dropped
369          */
370         show_drop_target: function() {
371             this.container.addClass('dndupload-ready');
372         },
374         hide_drop_target: function() {
375             this.container.removeClass('dndupload-ready');
376         },
378         /**
379          * Highlight the destination node (ready to drop)
380          */
381         show_upload_ready: function() {
382             this.container.addClass('dndupload-over');
383         },
385         /**
386          * Remove highlight on destination node
387          */
388         hide_upload_ready: function() {
389             this.container.removeClass('dndupload-over');
390         },
392         /**
393          * Show the element showing the upload in progress
394          */
395         show_progress: function() {
396             this.container.addClass('dndupload-inprogress');
397         },
399         /**
400          * Hide the element showing upload in progress
401          */
402         hide_progress: function() {
403             this.container.removeClass('dndupload-inprogress');
404         },
406         /**
407          * Tell the attached filemanager element (if any) to refresh on file
408          * upload
409          */
410         update_filemanager: function(params) {
411             this.hide_progress();
412             if (this.filemanager) {
413                 // update the filemanager that we've uploaded the files
414                 this.filemanager.filepicker_callback();
415             } else if (this.callback) {
416                 this.callback(params);
417             }
418         },
420         /**
421          * Clear the current progress bars
422          */
423         clear_progress: function() {
424             var filename;
425             for (filename in this.progressbars) {
426                 if (this.progressbars.hasOwnProperty(filename)) {
427                     this.progressbars[filename].progressouter.remove(true);
428                     delete this.progressbars[filename];
429                 }
430             }
431         },
433         /**
434          * Show the current progress of the uploaded file
435          */
436         update_progress: function(filename, percent) {
437             if (this.progressbars[filename] === undefined) {
438                 var dispfilename = filename;
439                 if (dispfilename.length > 50) {
440                     dispfilename = dispfilename.substr(0, 49)+'&hellip;';
441                 }
442                 var progressouter = this.container.create('<span>'+dispfilename+': <span class="dndupload-progress-outer"><span class="dndupload-progress-inner">&nbsp;</span></span><br /></span>');
443                 var progressinner = progressouter.one('.dndupload-progress-inner');
444                 var progresscontainer = this.container.one('.dndupload-progressbars');
445                 progresscontainer.appendChild(progressouter);
447                 this.progressbars[filename] = {
448                     progressouter: progressouter,
449                     progressinner: progressinner
450                 };
451             }
453             this.progressbars[filename].progressinner.setStyle('width', percent + '%');
454         }
455     };
457     var dnduploader = function(options) {
458         dnduploader.superclass.constructor.apply(this, arguments);
459     };
461     Y.extend(dnduploader, Y.Base, {
462         // The URL to send the upload data to.
463         api: M.cfg.wwwroot+'/repository/repository_ajax.php',
464         // Options passed into the filemanager/filepicker element.
465         options: {},
466         // The function to call when all uploads complete.
467         callback: null,
468         // The function to call as the upload progresses
469         callbackprogress: null,
470         // The function to call if the upload is cancelled
471         callbackcancel: null,
472         // The list of files dropped onto the element.
473         files: null,
474         // The ID of the 'upload' repository.
475         repositoryid: 0,
476         // Array of files already in the current folder (to check for name clashes).
477         currentfiles: null,
478         // Total number of files already uploaded (to check for exceeding limits).
479         currentfilecount: 0,
480         // Total size of the files present in the area.
481         currentareasize: 0,
482         // The list of files to upload.
483         uploadqueue: [],
484         // This list of files with name clashes.
485         renamequeue: [],
486         // Size of the current queue.
487         queuesize: 0,
488         // Set to true if the user has clicked on 'overwrite all'.
489         overwriteall: false,
490         // Set to true if the user has clicked on 'rename all'.
491         renameall: false,
493         /**
494          * Initialise the settings for the dnduploader
495          * @param object params - includes:
496          *                     options (copied from the filepicker / filemanager)
497          *                     repositoryid - ID of the upload repository
498          *                     callback - the function to call when uploads are complete
499          *                     currentfiles - the list of files already in the current folder in the filemanager
500          *                     currentfilecount - the total files already in the filemanager
501          *                     files - the list of files to upload
502          * @return void
503          */
504         initializer: function(params) {
505             this.options = params.options;
506             this.repositoryid = params.repositoryid;
507             this.callback = params.callback;
508             this.callbackprogress = params.callbackprogress;
509             this.callbackcancel = params.callbackcancel;
510             this.currentfiles = params.currentfiles;
511             this.currentfilecount = params.currentfilecount;
512             this.currentareasize = 0;
514             // Retrieve the current size of the area.
515             for (var i = 0; i < this.currentfiles.length; i++) {
516                 this.currentareasize += this.currentfiles[i].size;
517             };
519             if (!this.initialise_queue(params.files)) {
520                 if (this.callbackcancel) {
521                     this.callbackcancel();
522                 }
523             }
524         },
526         /**
527          * Entry point for starting the upload process (starts by processing any
528          * renames needed)
529          */
530         start_upload: function() {
531             this.process_renames(); // Automatically calls 'do_upload' once renames complete.
532         },
534         /**
535          * Display a message in a popup
536          * @param string msg - the message to display
537          * @param string type - 'error' or 'info'
538          */
539         print_msg: function(msg, type) {
540             var header = M.str.moodle.error;
541             if (type != 'error') {
542                 type = 'info'; // one of only two types excepted
543                 header = M.str.moodle.info;
544             }
545             if (!this.msg_dlg) {
546                 this.msg_dlg_node = Y.Node.createWithFilesSkin(M.core_filepicker.templates.message);
547                 this.msg_dlg_node.generateID();
549                 this.msg_dlg = new Y.Panel({
550                     srcNode      : this.msg_dlg_node,
551                     zIndex       : 8000,
552                     centered     : true,
553                     modal        : true,
554                     visible      : false,
555                     render       : true
556                 });
557                 this.msg_dlg.plug(Y.Plugin.Drag,{handles:['#'+this.msg_dlg_node.get('id')+' .yui3-widget-hd']});
558                 this.msg_dlg_node.one('.fp-msg-butok').on('click', function(e) {
559                     e.preventDefault();
560                     this.msg_dlg.hide();
561                 }, this);
562             }
564             this.msg_dlg.set('headerContent', header);
565             this.msg_dlg_node.removeClass('fp-msg-info').removeClass('fp-msg-error').addClass('fp-msg-'+type)
566             this.msg_dlg_node.one('.fp-msg-text').setContent(msg);
567             this.msg_dlg.show();
568         },
570         /**
571          * Check the size of each file and add to either the uploadqueue or, if there
572          * is a name clash, the renamequeue
573          * @param FileList files - the files to upload
574          * @return void
575          */
576         initialise_queue: function(files) {
577             this.uploadqueue = [];
578             this.renamequeue = [];
579             this.queuesize = 0;
581             // Loop through the files and find any name clashes with existing files.
582             var i;
583             for (i=0; i<files.length; i++) {
584                 if (this.options.maxbytes > 0 && files[i].size > this.options.maxbytes) {
585                     // Check filesize before attempting to upload.
586                     this.print_msg(M.util.get_string('maxbytesforfile', 'moodle', files[i].name), 'error');
587                     this.uploadqueue = []; // No uploads if one file is too big.
588                     return;
589                 }
591                 if (this.has_name_clash(files[i].name)) {
592                     this.renamequeue.push(files[i]);
593                 } else {
594                     if (!this.add_to_upload_queue(files[i], files[i].name, false)) {
595                         return false;
596                     }
597                 }
598                 this.queuesize += files[i].size;
599             }
600             return true;
601         },
603         /**
604          * Add a single file to the uploadqueue, whilst checking the maxfiles limit
605          * @param File file - the file to add
606          * @param string filename - the name to give the file on upload
607          * @param bool overwrite - true to overwrite the existing file
608          * @return bool true if added successfully
609          */
610         add_to_upload_queue: function(file, filename, overwrite) {
611             if (!overwrite) {
612                 this.currentfilecount++;
613             }
614             // The value for "unlimited files" is -1, so 0 should mean 0.
615             if (this.options.maxfiles >= 0 && this.currentfilecount > this.options.maxfiles) {
616                 // Too many files - abort entire upload.
617                 this.uploadqueue = [];
618                 this.renamequeue = [];
619                 this.print_msg(M.util.get_string('maxfilesreached', 'moodle', this.options.maxfiles), 'error');
620                 return false;
621             }
622             // The new file will cause the area to reach its limit, we cancel the upload of all files.
623             // -1 is the value defined by FILE_AREA_MAX_BYTES_UNLIMITED.
624             if (this.options.areamaxbytes > -1) {
625                 var sizereached = this.currentareasize + this.queuesize + file.size;
626                 if (sizereached > this.options.areamaxbytes) {
627                     this.uploadqueue = [];
628                     this.renamequeue = [];
629                     this.print_msg(M.util.get_string('maxareabytesreached', 'moodle'), 'error');
630                     return false;
631                 }
632             }
633             this.uploadqueue.push({file:file, filename:filename, overwrite:overwrite});
634             return true;
635         },
637         /**
638          * Take the next file from the renamequeue and ask the user what to do with
639          * it. Called recursively until the queue is empty, then calls do_upload.
640          * @return void
641          */
642         process_renames: function() {
643             if (this.renamequeue.length == 0) {
644                 // All rename processing complete - start the actual upload.
645                 this.do_upload();
646                 return;
647             }
648             var multiplefiles = (this.renamequeue.length > 1);
650             // Get the next file from the rename queue.
651             var file = this.renamequeue.shift();
652             // Generate a non-conflicting name for it.
653             var newname = this.generate_unique_name(file.name);
655             // If the user has clicked on overwrite/rename ALL then process
656             // this file, as appropriate, then process the rest of the queue.
657             if (this.overwriteall) {
658                 this.add_to_upload_queue(file, file.name, true);
659                 this.process_renames();
660                 return;
661             }
662             if (this.renameall) {
663                 this.add_to_upload_queue(file, newname, false);
664                 this.process_renames();
665                 return;
666             }
668             // Ask the user what to do with this file.
669             var self = this;
671             var process_dlg_node;
672             if (multiplefiles) {
673                 process_dlg_node = Y.Node.createWithFilesSkin(M.core_filepicker.templates.processexistingfilemultiple);
674             } else {
675                 process_dlg_node = Y.Node.createWithFilesSkin(M.core_filepicker.templates.processexistingfile);
676             }
677             var node = process_dlg_node;
678             node.generateID();
679             var process_dlg = new Y.Panel({
680                 srcNode      : node,
681                 headerContent: M.str.repository.fileexistsdialogheader,
682                 zIndex       : 8000,
683                 centered     : true,
684                 modal        : true,
685                 visible      : false,
686                 render       : true,
687                 buttons      : {}
688             });
689             process_dlg.plug(Y.Plugin.Drag,{handles:['#'+node.get('id')+' .yui3-widget-hd']});
691             // Overwrite original.
692             node.one('.fp-dlg-butoverwrite').on('click', function(e) {
693                 e.preventDefault();
694                 process_dlg.hide();
695                 self.add_to_upload_queue(file, file.name, true);
696                 self.process_renames();
697             }, this);
699             // Rename uploaded file.
700             node.one('.fp-dlg-butrename').on('click', function(e) {
701                 e.preventDefault();
702                 process_dlg.hide();
703                 self.add_to_upload_queue(file, newname, false);
704                 self.process_renames();
705             }, this);
707             // Cancel all uploads.
708             node.one('.fp-dlg-butcancel').on('click', function(e) {
709                 e.preventDefault();
710                 process_dlg.hide();
711                 if (self.callbackcancel) {
712                     self.callbackcancel();
713                 }
714             }, this);
716             // When we are at the file limit, only allow 'overwrite', not rename.
717             if (this.currentfilecount == this.options.maxfiles) {
718                 node.one('.fp-dlg-butrename').setStyle('display', 'none');
719                 if (multiplefiles) {
720                     node.one('.fp-dlg-butrenameall').setStyle('display', 'none');
721                 }
722             }
724             // If there are more files still to go, offer the 'overwrite/rename all' options.
725             if (multiplefiles) {
726                 // Overwrite all original files.
727                 node.one('.fp-dlg-butoverwriteall').on('click', function(e) {
728                     e.preventDefault();
729                     process_dlg.hide();
730                     this.overwriteall = true;
731                     self.add_to_upload_queue(file, file.name, true);
732                     self.process_renames();
733                 }, this);
735                 // Rename all new files.
736                 node.one('.fp-dlg-butrenameall').on('click', function(e) {
737                     e.preventDefault();
738                     process_dlg.hide();
739                     this.renameall = true;
740                     self.add_to_upload_queue(file, newname, false);
741                     self.process_renames();
742                 }, this);
743             }
744             node.one('.fp-dlg-text').setContent(M.util.get_string('fileexists', 'moodle', file.name));
745             process_dlg_node.one('.fp-dlg-butrename').setContent(M.util.get_string('renameto', 'repository', newname));
747             // Destroy the dialog once it has been hidden.
748             process_dlg.after('visibleChange', function(e) {
749                 if (!process_dlg.get('visible')) {
750                     process_dlg.destroy(true);
751                 }
752             });
754             process_dlg.show();
755         },
757         /**
758          * Checks if there is already a file with the given name in the current folder
759          * or in the list of already uploading files
760          * @param string filename - the name to test
761          * @return bool true if the name already exists
762          */
763         has_name_clash: function(filename) {
764             // Check against the already uploaded files
765             var i;
766             for (i=0; i<this.currentfiles.length; i++) {
767                 if (filename == this.currentfiles[i].filename) {
768                     return true;
769                 }
770             }
771             // Check against the uploading files that have already been processed
772             for (i=0; i<this.uploadqueue.length; i++) {
773                 if (filename == this.uploadqueue[i].filename) {
774                     return true;
775                 }
776             }
777             return false;
778         },
780         /**
781          * Gets a unique file name
782          *
783          * @param string filename
784          * @return string the unique filename generated
785          */
786         generate_unique_name: function(filename) {
787             // Loop through increating numbers until a unique name is found.
788             while (this.has_name_clash(filename)) {
789                 filename = increment_filename(filename);
790             }
791             return filename;
792         },
794         /**
795          * Upload the next file from the uploadqueue - called recursively after each
796          * upload is complete, then handles the callback to the filemanager/filepicker
797          * @param lastresult - the last result from the server
798          */
799         do_upload: function(lastresult) {
800             if (this.uploadqueue.length > 0) {
801                 var filedetails = this.uploadqueue.shift();
802                 this.upload_file(filedetails.file, filedetails.filename, filedetails.overwrite);
803             } else {
804                 this.uploadfinished(lastresult);
805             }
806         },
808         /**
809          * Run the callback to the filemanager/filepicker
810          */
811         uploadfinished: function(lastresult) {
812             this.callback(lastresult);
813         },
815         /**
816          * Upload a single file via an AJAX call to the 'upload' repository. Automatically
817          * calls do_upload as each upload completes.
818          * @param File file - the file to upload
819          * @param string filename - the name to give the file
820          * @param bool overwrite - true if the existing file should be overwritten
821          */
822         upload_file: function(file, filename, overwrite) {
824             // This would be an ideal place to use the Y.io function
825             // however, this does not support data encoded using the
826             // FormData object, which is needed to transfer data from
827             // the DataTransfer object into an XMLHTTPRequest
828             // This can be converted when the YUI issue has been integrated:
829             // http://yuilibrary.com/projects/yui3/ticket/2531274
830             var xhr = new XMLHttpRequest();
831             var self = this;
833             // Update the progress bar
834             xhr.upload.addEventListener('progress', function(e) {
835                 if (e.lengthComputable && self.callbackprogress) {
836                     var percentage = Math.round((e.loaded * 100) / e.total);
837                     self.callbackprogress(filename, percentage);
838                 }
839             }, false);
841             xhr.onreadystatechange = function() { // Process the server response
842                 if (xhr.readyState == 4) {
843                     if (xhr.status == 200) {
844                         var result = JSON.parse(xhr.responseText);
845                         if (result) {
846                             if (result.error) {
847                                 self.print_msg(result.error, 'error'); // TODO add filename?
848                                 self.uploadfinished();
849                             } else {
850                                 // Only update the filepicker if there were no errors
851                                 if (result.event == 'fileexists') {
852                                     // Do not worry about this, as we only care about the last
853                                     // file uploaded, with the filepicker
854                                     result.file = result.newfile.filename;
855                                     result.url = result.newfile.url;
856                                 }
857                                 result.client_id = self.options.clientid;
858                                 if (self.callbackprogress) {
859                                     self.callbackprogress(filename, 100);
860                                 }
861                             }
862                         }
863                         self.do_upload(result); // continue uploading
864                     } else {
865                         self.print_msg(M.util.get_string('serverconnection', 'error'), 'error');
866                         self.uploadfinished();
867                     }
868                 }
869             };
871             // Prepare the data to send
872             var formdata = new FormData();
873             formdata.append('action', 'upload');
874             formdata.append('repo_upload_file', file); // The FormData class allows us to attach a file
875             formdata.append('sesskey', M.cfg.sesskey);
876             formdata.append('repo_id', this.repositoryid);
877             formdata.append('itemid', this.options.itemid);
878             if (this.options.author) {
879                 formdata.append('author', this.options.author);
880             }
881             if (this.options.filemanager) { // Filepickers do not have folders
882                 formdata.append('savepath', this.options.filemanager.currentpath);
883             }
884             formdata.append('title', filename);
885             if (overwrite) {
886                 formdata.append('overwrite', 1);
887             }
889             // Accepted types can be either a string or an array, but an array is
890             // expected in the processing script, so make sure we are sending an array
891             if (this.options.acceptedtypes.constructor == Array) {
892                 for (var i=0; i<this.options.acceptedtypes.length; i++) {
893                     formdata.append('accepted_types[]', this.options.acceptedtypes[i]);
894                 }
895             } else {
896                 formdata.append('accepted_types[]', this.options.acceptedtypes);
897             }
899             // Send the file & required details
900             xhr.open("POST", this.api, true);
901             xhr.send(formdata);
902             return true;
903         }
904     });
906     dnduploadhelper.init(Y, options);
907 };