Merge branch 'MDL-36056-master-enrolkeywhitespace' of git://github.com/mudrd8mz/moodle
[moodle.git] / lib / form / dndupload.js
bloba902435bb240889eca3b030872d66c1be668564d
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.
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, contextid
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          *            contextid: id of the current cotnext
73          *            containerid: htmlid of container
74          *            repositories: array of repository objects passed from filepicker
75          *            filemanager: filemanager element we are working with
76          *            formcallback: callback  to filepicker element to refesh when uploaded
77          *          }
78          */
79         init: function(Y, options) {
80             this.Y = Y;
82             if (!this.browser_supported()) {
83                 Y.one('body').addClass('dndnotsupported');
84                 return; // Browser does not support the required functionality
85             }
87             // try and retrieve enabled upload repository
88             this.repositoryid = this.get_upload_repositoryid(options.repositories);
90             if (!this.repositoryid) {
91                 Y.one('body').addClass('dndnotsupported');
92                 return; // no upload repository is enabled to upload to
93             }
95             Y.one('body').addClass('dndsupported');
97             this.options = options;
98             this.acceptedtypes = options.acceptedtypes;
99             this.clientid = options.clientid;
100             this.maxbytes = options.maxbytes;
101             this.areamaxbytes = options.areamaxbytes;
102             this.itemid = options.itemid;
103             this.author = options.author;
104             this.container = this.Y.one('#'+options.containerid);
106             if (options.filemanager) {
107                 // Needed to tell the filemanager to redraw when files uploaded
108                 // and to check how many files are already uploaded
109                 this.filemanager = options.filemanager;
110             } else if (options.formcallback) {
112                 // Needed to tell the filepicker to update when a new
113                 // file is uploaded
114                 this.callback = options.formcallback;
115             } else {
116                 if (M.cfg.developerdebug) {
117                     alert('dndupload: Need to define either options.filemanager or options.formcallback');
118                 }
119                 return;
120             }
122             this.init_events();
123             this.init_page_events();
124         },
126         /**
127          * Check the browser has the required functionality
128          * @return true if browser supports drag/drop upload
129          */
130         browser_supported: function() {
132             if (typeof FileReader == 'undefined') {
133                 return false;
134             }
135             if (typeof FormData == 'undefined') {
136                 return false;
137             }
138             return true;
139         },
141         /**
142          * Get upload repoistory from array of enabled repositories
143          *
144          * @param array repositories repository objects passed from filepicker
145          * @param returns int id of upload repository or false if not found
146          */
147         get_upload_repositoryid: function(repositories) {
148             for (var i in repositories) {
149                 if (repositories[i].type == "upload") {
150                     return repositories[i].id;
151                 }
152             }
154             return false;
155         },
157         /**
158          * Initialise drag events on node container, all events need
159          * to be processed for drag and drop to work
160          */
161         init_events: function() {
162             this.Y.on('dragenter', this.drag_enter, this.container, this);
163             this.Y.on('dragleave', this.drag_leave, this.container, this);
164             this.Y.on('dragover',  this.drag_over,  this.container, this);
165             this.Y.on('drop',      this.drop,      this.container, this);
166         },
168         /**
169          * Initialise whole-page events (to show / hide the 'drop files here'
170          * message)
171          */
172         init_page_events: function() {
173             this.Y.on('dragenter', this.drag_enter_page, 'body', this);
174             this.Y.on('dragleave', this.drag_leave_page, 'body', this);
175         },
177         /**
178          * Check if the filemanager / filepicker is disabled
179          * @return bool - true if disabled
180          */
181         is_disabled: function() {
182             return (this.container.ancestor('.fitem.disabled') != null);
183         },
185         /**
186          * Show the 'drop files here' message when file(s) are dragged
187          * onto the page
188          */
189         drag_enter_page: function(e) {
190             if (this.is_disabled()) {
191                 return false;
192             }
193             if (!this.has_files(e)) {
194                 return false;
195             }
197             this.pageentercount++;
198             if (this.pageentercount >= 2) {
199                 this.pageentercount = 2;
200                 return false;
201             }
203             this.show_drop_target();
205             return false;
206         },
208         /**
209          * Hide the 'drop files here' message when file(s) are dragged off
210          * the page again
211          */
212         drag_leave_page: function(e) {
213             this.pageentercount--;
214             if (this.pageentercount == 1) {
215                 return false;
216             }
217             this.pageentercount = 0;
219             this.hide_drop_target();
221             return false;
222         },
224         /**
225          * Check if the drag contents are valid and then call
226          * preventdefault / stoppropagation to let the browser know
227          * we will handle this drag/drop
228          *
229          * @param e event object
230          * @return boolean true if a valid file drag event
231          */
232         check_drag: function(e) {
233             if (this.is_disabled()) {
234                 return false;
235             }
236             if (!this.has_files(e)) {
237                 return false;
238             }
240             e.preventDefault();
241             e.stopPropagation();
243             return true;
244         },
246         /**
247          * Handle a dragenter event, highlight the destination node
248          * when a suitable drag event occurs
249          */
250         drag_enter: function(e) {
251             if (!this.check_drag(e)) {
252                 return true;
253             }
255             this.entercount++;
256             if (this.entercount >= 2) {
257                 this.entercount = 2; // Just moved over a child element - nothing to do
258                 return false;
259             }
261             // These lines are needed if the user has dragged something directly
262             // from application onto the 'fileupload' box, without crossing another
263             // part of the page first
264             this.pageentercount = 2;
265             this.show_drop_target();
267             this.show_upload_ready();
268             return false;
269         },
271         /**
272          * Handle a dragleave event, Remove the highlight if dragged from
273          * node
274          */
275         drag_leave: function(e) {
276             if (!this.check_drag(e)) {
277                 return true;
278             }
280             this.entercount--;
281             if (this.entercount == 1) {
282                 return false; // Just moved over a child element - nothing to do
283             }
285             this.entercount = 0;
286             this.hide_upload_ready();
287             return false;
288         },
290         /**
291          * Handle a dragover event. Required to intercept to prevent the browser from
292          * handling the drag and drop event as normal
293          */
294         drag_over: function(e) {
295             if (!this.check_drag(e)) {
296                 return true;
297             }
299             return false;
300         },
302         /**
303          * Handle a drop event.  Remove the highlight and then upload each
304          * of the files (until we reach the file limit, or run out of files)
305          */
306         drop: function(e) {
307             if (!this.check_drag(e, true)) {
308                 return true;
309             }
311             this.entercount = 0;
312             this.pageentercount = 0;
313             this.hide_upload_ready();
314             this.hide_drop_target();
316             var files = e._event.dataTransfer.files;
317             if (this.filemanager) {
318                 var options = {
319                     files: files,
320                     options: this.options,
321                     repositoryid: this.repositoryid,
322                     currentfilecount: this.filemanager.filecount, // All files uploaded.
323                     currentfiles: this.filemanager.options.list, // Only the current folder.
324                     callback: Y.bind('update_filemanager', this),
325                     callbackprogress: Y.bind('update_progress', this),
326                     callbackcancel:Y.bind('hide_progress', this)
327                 };
328                 this.clear_progress();
329                 this.show_progress();
330                 var uploader = new dnduploader(options);
331                 uploader.start_upload();
332             } else {
333                 if (files.length >= 1) {
334                     options = {
335                         files:[files[0]],
336                         options: this.options,
337                         repositoryid: this.repositoryid,
338                         currentfilecount: 0,
339                         currentfiles: [],
340                         callback: Y.bind('update_filemanager', this),
341                         callbackprogress: Y.bind('update_progress', this),
342                         callbackcancel:Y.bind('hide_progress', this)
343                     };
344                     this.clear_progress();
345                     this.show_progress();
346                     uploader = new dnduploader(options);
347                     uploader.start_upload();
348                 }
349             }
351             return false;
352         },
354         /**
355          * Check to see if the drag event has any files in it
356          *
357          * @param e event object
358          * @return boolean true if event has files
359          */
360         has_files: function(e) {
361             // In some browsers, dataTransfer.types may be null for a
362             // 'dragover' event, so ensure a valid Array is always
363             // inspected.
364             var types = e._event.dataTransfer.types || [];
365             for (var i=0; i<types.length; i++) {
366                 if (types[i] == 'Files') {
367                     return true;
368                 }
369             }
370             return false;
371         },
373         /**
374          * Highlight the area where files could be dropped
375          */
376         show_drop_target: function() {
377             this.container.addClass('dndupload-ready');
378         },
380         hide_drop_target: function() {
381             this.container.removeClass('dndupload-ready');
382         },
384         /**
385          * Highlight the destination node (ready to drop)
386          */
387         show_upload_ready: function() {
388             this.container.addClass('dndupload-over');
389         },
391         /**
392          * Remove highlight on destination node
393          */
394         hide_upload_ready: function() {
395             this.container.removeClass('dndupload-over');
396         },
398         /**
399          * Show the element showing the upload in progress
400          */
401         show_progress: function() {
402             this.container.addClass('dndupload-inprogress');
403         },
405         /**
406          * Hide the element showing upload in progress
407          */
408         hide_progress: function() {
409             this.container.removeClass('dndupload-inprogress');
410         },
412         /**
413          * Tell the attached filemanager element (if any) to refresh on file
414          * upload
415          */
416         update_filemanager: function(params) {
417             this.hide_progress();
418             if (this.filemanager) {
419                 // update the filemanager that we've uploaded the files
420                 this.filemanager.filepicker_callback();
421             } else if (this.callback) {
422                 this.callback(params);
423             }
424         },
426         /**
427          * Clear the current progress bars
428          */
429         clear_progress: function() {
430             var filename;
431             for (filename in this.progressbars) {
432                 if (this.progressbars.hasOwnProperty(filename)) {
433                     this.progressbars[filename].progressouter.remove(true);
434                     delete this.progressbars[filename];
435                 }
436             }
437         },
439         /**
440          * Show the current progress of the uploaded file
441          */
442         update_progress: function(filename, percent) {
443             if (this.progressbars[filename] === undefined) {
444                 var dispfilename = filename;
445                 if (dispfilename.length > 50) {
446                     dispfilename = dispfilename.substr(0, 49)+'&hellip;';
447                 }
448                 var progressouter = this.container.create('<span>'+dispfilename+': <span class="dndupload-progress-outer"><span class="dndupload-progress-inner">&nbsp;</span></span><br /></span>');
449                 var progressinner = progressouter.one('.dndupload-progress-inner');
450                 var progresscontainer = this.container.one('.dndupload-progressbars');
451                 progresscontainer.appendChild(progressouter);
453                 this.progressbars[filename] = {
454                     progressouter: progressouter,
455                     progressinner: progressinner
456                 };
457             }
459             this.progressbars[filename].progressinner.setStyle('width', percent + '%');
460         }
461     };
463     var dnduploader = function(options) {
464         dnduploader.superclass.constructor.apply(this, arguments);
465     };
467     Y.extend(dnduploader, Y.Base, {
468         // The URL to send the upload data to.
469         api: M.cfg.wwwroot+'/repository/repository_ajax.php',
470         // Options passed into the filemanager/filepicker element.
471         options: {},
472         // The function to call when all uploads complete.
473         callback: null,
474         // The function to call as the upload progresses
475         callbackprogress: null,
476         // The function to call if the upload is cancelled
477         callbackcancel: null,
478         // The list of files dropped onto the element.
479         files: null,
480         // The ID of the 'upload' repository.
481         repositoryid: 0,
482         // Array of files already in the current folder (to check for name clashes).
483         currentfiles: null,
484         // Total number of files already uploaded (to check for exceeding limits).
485         currentfilecount: 0,
486         // Total size of the files present in the area.
487         currentareasize: 0,
488         // The list of files to upload.
489         uploadqueue: [],
490         // This list of files with name clashes.
491         renamequeue: [],
492         // Size of the current queue.
493         queuesize: 0,
494         // Set to true if the user has clicked on 'overwrite all'.
495         overwriteall: false,
496         // Set to true if the user has clicked on 'rename all'.
497         renameall: false,
499         /**
500          * Initialise the settings for the dnduploader
501          * @param object params - includes:
502          *                     options (copied from the filepicker / filemanager)
503          *                     repositoryid - ID of the upload repository
504          *                     callback - the function to call when uploads are complete
505          *                     currentfiles - the list of files already in the current folder in the filemanager
506          *                     currentfilecount - the total files already in the filemanager
507          *                     files - the list of files to upload
508          * @return void
509          */
510         initializer: function(params) {
511             this.options = params.options;
512             this.repositoryid = params.repositoryid;
513             this.callback = params.callback;
514             this.callbackprogress = params.callbackprogress;
515             this.callbackcancel = params.callbackcancel;
516             this.currentfiles = params.currentfiles;
517             this.currentfilecount = params.currentfilecount;
518             this.currentareasize = 0;
520             // Retrieve the current size of the area.
521             for (var i = 0; i < this.currentfiles.length; i++) {
522                 this.currentareasize += this.currentfiles[i].size;
523             };
525             if (!this.initialise_queue(params.files)) {
526                 if (this.callbackcancel) {
527                     this.callbackcancel();
528                 }
529             }
530         },
532         /**
533          * Entry point for starting the upload process (starts by processing any
534          * renames needed)
535          */
536         start_upload: function() {
537             this.process_renames(); // Automatically calls 'do_upload' once renames complete.
538         },
540         /**
541          * Display a message in a popup
542          * @param string msg - the message to display
543          * @param string type - 'error' or 'info'
544          */
545         print_msg: function(msg, type) {
546             var header = M.util.get_string('error', 'moodle');
547             if (type != 'error') {
548                 type = 'info'; // one of only two types excepted
549                 header = M.util.get_string('info', 'moodle');
550             }
551             if (!this.msg_dlg) {
552                 this.msg_dlg_node = Y.Node.create(M.core_filepicker.templates.message);
553                 this.msg_dlg_node.generateID();
555                 this.msg_dlg = new M.core.dialogue({
556                     bodyContent: this.msg_dlg_node,
557                     centered: true,
558                     modal: true,
559                     visible: false
560                 });
561                 this.msg_dlg.plug(Y.Plugin.Drag,{handles:['#'+this.msg_dlg_node.get('id')+' .yui3-widget-hd']});
562                 this.msg_dlg_node.one('.fp-msg-butok').on('click', function(e) {
563                     e.preventDefault();
564                     this.msg_dlg.hide();
565                 }, this);
566             }
568             this.msg_dlg.set('headerContent', header);
569             this.msg_dlg_node.removeClass('fp-msg-info').removeClass('fp-msg-error').addClass('fp-msg-'+type)
570             this.msg_dlg_node.one('.fp-msg-text').setContent(msg);
571             this.msg_dlg.show();
572         },
574         /**
575          * Check the size of each file and add to either the uploadqueue or, if there
576          * is a name clash, the renamequeue
577          * @param FileList files - the files to upload
578          * @return void
579          */
580         initialise_queue: function(files) {
581             this.uploadqueue = [];
582             this.renamequeue = [];
583             this.queuesize = 0;
585             // Loop through the files and find any name clashes with existing files.
586             var i;
587             for (i=0; i<files.length; i++) {
588                 if (this.options.maxbytes > 0 && files[i].size > this.options.maxbytes) {
589                     // Check filesize before attempting to upload.
590                     var maxbytesdisplay = this.display_size(this.options.maxbytes);
591                     this.print_msg(M.util.get_string('maxbytesfile', 'error', {
592                             file: files[i].name,
593                             size: maxbytesdisplay
594                         }), 'error');
595                     this.uploadqueue = []; // No uploads if one file is too big.
596                     return;
597                 }
599                 if (this.has_name_clash(files[i].name)) {
600                     this.renamequeue.push(files[i]);
601                 } else {
602                     if (!this.add_to_upload_queue(files[i], files[i].name, false)) {
603                         return false;
604                     }
605                 }
606                 this.queuesize += files[i].size;
607             }
608             return true;
609         },
611         /**
612          * Generate the display for file size
613          * @param int size The size to convert to human readable form
614          * @return string
615          */
616         display_size: function(size) {
617             // This is snippet of code (with some changes) is from the display_size function in moodlelib.
618             var gb = M.util.get_string('sizegb', 'moodle'),
619                 mb = M.util.get_string('sizemb', 'moodle'),
620                 kb = M.util.get_string('sizekb', 'moodle'),
621                 b  = M.util.get_string('sizeb', 'moodle');
623             if (size >= 1073741824) {
624                 size = Math.round(size / 1073741824 * 10) / 10 + gb;
625             } else if (size >= 1048576) {
626                 size = Math.round(size / 1048576 * 10) / 10 + mb;
627             } else if (size >= 1024) {
628                 size = Math.round(size / 1024 * 10) / 10 + kb;
629             } else {
630                 size = parseInt(size, 10) + ' ' + b;
631             }
633             return size;
634         },
636         /**
637          * Add a single file to the uploadqueue, whilst checking the maxfiles limit
638          * @param File file - the file to add
639          * @param string filename - the name to give the file on upload
640          * @param bool overwrite - true to overwrite the existing file
641          * @return bool true if added successfully
642          */
643         add_to_upload_queue: function(file, filename, overwrite) {
644             if (!overwrite) {
645                 this.currentfilecount++;
646             }
647             // The value for "unlimited files" is -1, so 0 should mean 0.
648             if (this.options.maxfiles >= 0 && this.currentfilecount > this.options.maxfiles) {
649                 // Too many files - abort entire upload.
650                 this.uploadqueue = [];
651                 this.renamequeue = [];
652                 this.print_msg(M.util.get_string('maxfilesreached', 'moodle', this.options.maxfiles), 'error');
653                 return false;
654             }
655             // The new file will cause the area to reach its limit, we cancel the upload of all files.
656             // -1 is the value defined by FILE_AREA_MAX_BYTES_UNLIMITED.
657             if (this.options.areamaxbytes > -1) {
658                 var sizereached = this.currentareasize + this.queuesize + file.size;
659                 if (sizereached > this.options.areamaxbytes) {
660                     this.uploadqueue = [];
661                     this.renamequeue = [];
662                     this.print_msg(M.util.get_string('maxareabytesreached', 'moodle'), 'error');
663                     return false;
664                 }
665             }
666             this.uploadqueue.push({file:file, filename:filename, overwrite:overwrite});
667             return true;
668         },
670         /**
671          * Take the next file from the renamequeue and ask the user what to do with
672          * it. Called recursively until the queue is empty, then calls do_upload.
673          * @return void
674          */
675         process_renames: function() {
676             if (this.renamequeue.length == 0) {
677                 // All rename processing complete - start the actual upload.
678                 this.do_upload();
679                 return;
680             }
681             var multiplefiles = (this.renamequeue.length > 1);
683             // Get the next file from the rename queue.
684             var file = this.renamequeue.shift();
685             // Generate a non-conflicting name for it.
686             var newname = this.generate_unique_name(file.name);
688             // If the user has clicked on overwrite/rename ALL then process
689             // this file, as appropriate, then process the rest of the queue.
690             if (this.overwriteall) {
691                 this.add_to_upload_queue(file, file.name, true);
692                 this.process_renames();
693                 return;
694             }
695             if (this.renameall) {
696                 this.add_to_upload_queue(file, newname, false);
697                 this.process_renames();
698                 return;
699             }
701             // Ask the user what to do with this file.
702             var self = this;
704             var process_dlg_node;
705             if (multiplefiles) {
706                 process_dlg_node = Y.Node.create(M.core_filepicker.templates.processexistingfilemultiple);
707             } else {
708                 process_dlg_node = Y.Node.create(M.core_filepicker.templates.processexistingfile);
709             }
710             var node = process_dlg_node;
711             node.generateID();
712             var process_dlg = new M.core.dialogue({
713                 bodyContent: node,
714                 headerContent: M.util.get_string('fileexistsdialogheader', 'repository'),
715                 centered: true,
716                 modal: true,
717                 visible: false
718             });
719             process_dlg.plug(Y.Plugin.Drag,{handles:['#'+node.get('id')+' .yui3-widget-hd']});
721             // Overwrite original.
722             node.one('.fp-dlg-butoverwrite').on('click', function(e) {
723                 e.preventDefault();
724                 process_dlg.hide();
725                 self.add_to_upload_queue(file, file.name, true);
726                 self.process_renames();
727             }, this);
729             // Rename uploaded file.
730             node.one('.fp-dlg-butrename').on('click', function(e) {
731                 e.preventDefault();
732                 process_dlg.hide();
733                 self.add_to_upload_queue(file, newname, false);
734                 self.process_renames();
735             }, this);
737             // Cancel all uploads.
738             node.one('.fp-dlg-butcancel').on('click', function(e) {
739                 e.preventDefault();
740                 process_dlg.hide();
741                 if (self.callbackcancel) {
742                     self.callbackcancel();
743                 }
744             }, this);
746             // When we are at the file limit, only allow 'overwrite', not rename.
747             if (this.currentfilecount == this.options.maxfiles) {
748                 node.one('.fp-dlg-butrename').setStyle('display', 'none');
749                 if (multiplefiles) {
750                     node.one('.fp-dlg-butrenameall').setStyle('display', 'none');
751                 }
752             }
754             // If there are more files still to go, offer the 'overwrite/rename all' options.
755             if (multiplefiles) {
756                 // Overwrite all original files.
757                 node.one('.fp-dlg-butoverwriteall').on('click', function(e) {
758                     e.preventDefault();
759                     process_dlg.hide();
760                     this.overwriteall = true;
761                     self.add_to_upload_queue(file, file.name, true);
762                     self.process_renames();
763                 }, this);
765                 // Rename all new files.
766                 node.one('.fp-dlg-butrenameall').on('click', function(e) {
767                     e.preventDefault();
768                     process_dlg.hide();
769                     this.renameall = true;
770                     self.add_to_upload_queue(file, newname, false);
771                     self.process_renames();
772                 }, this);
773             }
774             node.one('.fp-dlg-text').setContent(M.util.get_string('fileexists', 'moodle', file.name));
775             process_dlg_node.one('.fp-dlg-butrename').setContent(M.util.get_string('renameto', 'repository', newname));
777             // Destroy the dialog once it has been hidden.
778             process_dlg.after('visibleChange', function(e) {
779                 if (!process_dlg.get('visible')) {
780                     process_dlg.destroy(true);
781                 }
782             });
784             process_dlg.show();
785         },
787         /**
788          * Checks if there is already a file with the given name in the current folder
789          * or in the list of already uploading files
790          * @param string filename - the name to test
791          * @return bool true if the name already exists
792          */
793         has_name_clash: function(filename) {
794             // Check against the already uploaded files
795             var i;
796             for (i=0; i<this.currentfiles.length; i++) {
797                 if (filename == this.currentfiles[i].filename) {
798                     return true;
799                 }
800             }
801             // Check against the uploading files that have already been processed
802             for (i=0; i<this.uploadqueue.length; i++) {
803                 if (filename == this.uploadqueue[i].filename) {
804                     return true;
805                 }
806             }
807             return false;
808         },
810         /**
811          * Gets a unique file name
812          *
813          * @param string filename
814          * @return string the unique filename generated
815          */
816         generate_unique_name: function(filename) {
817             // Loop through increating numbers until a unique name is found.
818             while (this.has_name_clash(filename)) {
819                 filename = increment_filename(filename);
820             }
821             return filename;
822         },
824         /**
825          * Upload the next file from the uploadqueue - called recursively after each
826          * upload is complete, then handles the callback to the filemanager/filepicker
827          * @param lastresult - the last result from the server
828          */
829         do_upload: function(lastresult) {
830             if (this.uploadqueue.length > 0) {
831                 var filedetails = this.uploadqueue.shift();
832                 this.upload_file(filedetails.file, filedetails.filename, filedetails.overwrite);
833             } else {
834                 this.uploadfinished(lastresult);
835             }
836         },
838         /**
839          * Run the callback to the filemanager/filepicker
840          */
841         uploadfinished: function(lastresult) {
842             this.callback(lastresult);
843         },
845         /**
846          * Upload a single file via an AJAX call to the 'upload' repository. Automatically
847          * calls do_upload as each upload completes.
848          * @param File file - the file to upload
849          * @param string filename - the name to give the file
850          * @param bool overwrite - true if the existing file should be overwritten
851          */
852         upload_file: function(file, filename, overwrite) {
854             // This would be an ideal place to use the Y.io function
855             // however, this does not support data encoded using the
856             // FormData object, which is needed to transfer data from
857             // the DataTransfer object into an XMLHTTPRequest
858             // This can be converted when the YUI issue has been integrated:
859             // http://yuilibrary.com/projects/yui3/ticket/2531274
860             var xhr = new XMLHttpRequest();
861             var self = this;
863             // Update the progress bar
864             xhr.upload.addEventListener('progress', function(e) {
865                 if (e.lengthComputable && self.callbackprogress) {
866                     var percentage = Math.round((e.loaded * 100) / e.total);
867                     self.callbackprogress(filename, percentage);
868                 }
869             }, false);
871             xhr.onreadystatechange = function() { // Process the server response
872                 if (xhr.readyState == 4) {
873                     if (xhr.status == 200) {
874                         var result = JSON.parse(xhr.responseText);
875                         if (result) {
876                             if (result.error) {
877                                 self.print_msg(result.error, 'error'); // TODO add filename?
878                                 self.uploadfinished();
879                             } else {
880                                 // Only update the filepicker if there were no errors
881                                 if (result.event == 'fileexists') {
882                                     // Do not worry about this, as we only care about the last
883                                     // file uploaded, with the filepicker
884                                     result.file = result.newfile.filename;
885                                     result.url = result.newfile.url;
886                                 }
887                                 result.client_id = self.options.clientid;
888                                 if (self.callbackprogress) {
889                                     self.callbackprogress(filename, 100);
890                                 }
891                             }
892                         }
893                         self.do_upload(result); // continue uploading
894                     } else {
895                         self.print_msg(M.util.get_string('serverconnection', 'error'), 'error');
896                         self.uploadfinished();
897                     }
898                 }
899             };
901             // Prepare the data to send
902             var formdata = new FormData();
903             formdata.append('repo_upload_file', file); // The FormData class allows us to attach a file
904             formdata.append('sesskey', M.cfg.sesskey);
905             formdata.append('repo_id', this.repositoryid);
906             formdata.append('itemid', this.options.itemid);
907             if (this.options.author) {
908                 formdata.append('author', this.options.author);
909             }
910             if (this.options.filemanager) { // Filepickers do not have folders
911                 formdata.append('savepath', this.options.filemanager.currentpath);
912             }
913             formdata.append('title', filename);
914             if (overwrite) {
915                 formdata.append('overwrite', 1);
916             }
917             if (this.options.contextid) {
918                 formdata.append('ctx_id', this.options.contextid);
919             }
921             // Accepted types can be either a string or an array, but an array is
922             // expected in the processing script, so make sure we are sending an array
923             if (this.options.acceptedtypes.constructor == Array) {
924                 for (var i=0; i<this.options.acceptedtypes.length; i++) {
925                     formdata.append('accepted_types[]', this.options.acceptedtypes[i]);
926                 }
927             } else {
928                 formdata.append('accepted_types[]', this.options.acceptedtypes);
929             }
931             // Send the file & required details.
932             var uploadUrl = this.api;
933             if (uploadUrl.indexOf('?') !== -1) {
934                 uploadUrl += '&action=upload';
935             } else {
936                 uploadUrl += '?action=upload';
937             }
938             xhr.open("POST", uploadUrl, true);
939             xhr.send(formdata);
940             return true;
941         }
942     });
944     dnduploadhelper.init(Y, options);