MDL-31114 Alert when max files reached
[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         // itemid used for repository upload
34         itemid: null,
35         // accepted filetypes accepted by this form passed to repository
36         acceptedtypes: [],
37         // maximum number of files this form allows
38         maxfiles: 0,
39         // maximum size of files allowed in this form
40         maxbytes: 0,
41         // unqiue id of this form field used for html elements
42         clientid: '',
43         // upload repository id, used for upload
44         repositoryid: 0,
45         // container which holds the node which recieves drag events
46         container: null,
47         // filemanager element we are working with
48         filemanager: null,
49         // callback  to filepicker element to refesh when uploaded
50         callback: null,
51         // Nasty hack to distinguish between dragenter(first entry),
52         // dragenter+dragleave(moving between child elements) and dragleave (leaving element)
53         entercount: 0,
56         /**
57          * Initalise the drag and drop upload interface
58          * Note: one and only one of options.filemanager and options.formcallback must be defined
59          *
60          * @param Y the YUI object
61          * @param object options {
62          *            itemid: itemid used for repository upload in this form
63          *            acceptdtypes: accepted filetypes by this form
64          *            maxfiles: maximum number of files this form allows
65          *            maxbytes: maximum size of files allowed in this form
66          *            clientid: unqiue id of this form field used for html elements
67          *            containerprefix: prefix of htmlid of container
68          *            repositories: array of repository objects passed from filepicker
69          *            filemanager: filemanager element we are working with
70          *            callback: callback  to filepicker element to refesh when uploaded
71          *          }
72          */
73         init: function(Y, options) {
74             this.Y = Y;
76             if (!this.browser_supported()) {
77                 return; // Browser does not support the required functionality
78             }
80             // try and retrieve enabled upload repository
81             this.repositoryid = this.get_upload_repositoryid(options.repositories);
83             if (!this.repositoryid) {
84                 return; // no upload repository is enabled to upload to
85             }
87             this.acceptedtypes = options.acceptedtypes;
88             this.clientid = options.clientid;
89             this.maxfiles = options.maxfiles;
90             this.maxbytes = options.maxbytes;
91             this.itemid = options.itemid;
92             this.container = this.Y.one(options.containerprefix + this.clientid);
94             if (options.filemanager) {
95                 // Needed to tell the filemanager to redraw when files uploaded
96                 // and to check how many files are already uploaded
97                 this.filemanager = options.filemanager;
98             } else if (options.formcallback) {
100                 // Needed to tell the filepicker to update when a new
101                 // file is uploaded
102                 this.callback = options.formcallback;
103             } else {
104                 if (M.cfg.developerdebug) {
105                     alert('dndupload: Need to define either options.filemanager or options.callback');
106                 }
107                 return;
108             }
110             this.init_events();
111             this.Y.one('#dndenabled-'+this.clientid).setStyle('display', 'inline');
112         },
114         /**
115          * Check the browser has the required functionality
116          * @return true if browser supports drag/drop upload
117          */
118         browser_supported: function() {
120             if (typeof FileReader == 'undefined') {
121                 return false;
122             }
123             if (typeof FormData == 'undefined') {
124                 return false;
125             }
126             return true;
127         },
129         /**
130          * Get upload repoistory from array of enabled repositories
131          *
132          * @param array repositories repository objects passed from filepicker
133          * @param returns int id of upload repository or false if not found
134          */
135         get_upload_repositoryid: function(repositories) {
136             for (var i in repositories) {
137                 if (repositories[i].type == "upload") {
138                     return repositories[i].id;
139                 }
140             }
142             return false;
143         },
145         /**
146          * Initialise drag events on node container, all events need
147          * to be processed for drag and drop to work
148          */
149         init_events: function() {
150             this.Y.on('dragenter', this.drag_enter, this.container, this);
151             this.Y.on('dragleave', this.drag_leave, this.container, this);
152             this.Y.on('dragover',  this.drag_over,  this.container, this);
153             this.Y.on('drop',      this.drop,      this.container, this);
154         },
156         /**
157          * Check if the drag contents are valid and then call
158          * preventdefault / stoppropagation to let the browser know
159          * we will handle this drag/drop
160          *
161          * @param e event object
162          * @return boolean true if a valid file drag event
163          */
164         check_drag: function(e, maxfilesalert) {
165             if (!this.has_files(e)) {
166                 return false;
167             }
169             e.preventDefault();
170             e.stopPropagation();
172             if (this.reached_maxfiles()) {
173                 if (typeof(maxfilesalert) != 'undefined' && maxfilesalert) {
174                     alert(M.util.get_string('maxfilesreached', 'moodle', this.maxfiles));
175                 }
176                 return false;
177             }
179             return true;
180         },
182         /**
183          * Handle a dragenter event, highlight the destination node
184          * when a suitable drag event occurs
185          */
186         drag_enter: function(e) {
187             if (!this.check_drag(e)) {
188                 return true;
189             }
191             this.entercount++;
192             if (this.entercount >= 2) {
193                 this.entercount = 2; // Just moved over a child element - nothing to do
194                 return false;
195             }
197             this.show_upload_ready();
198             return false;
199         },
201         /**
202          * Handle a dragleave event, Remove the highlight if dragged from
203          * node
204          */
205         drag_leave: function(e) {
206             if (!this.check_drag(e)) {
207                 return true;
208             }
210             this.entercount--;
211             if (this.entercount == 1) {
212                 return false; // Just moved over a child element - nothing to do
213             }
215             this.entercount = 0;
216             this.hide_upload_ready();
217             return false;
218         },
220         /**
221          * Handle a dragover event. Required to intercept to prevent the browser from
222          * handling the drag and drop event as normal
223          */
224         drag_over: function(e) {
225             if (!this.check_drag(e)) {
226                 return true;
227             }
229             return false;
230         },
232         /**
233          * Handle a drop event.  Remove the highlight and then upload each
234          * of the files (until we reach the file limit, or run out of files)
235          */
236         drop: function(e) {
237             if (!this.check_drag(e, true)) {
238                 return true;
239             }
241             this.entercount = 0;
242             this.hide_upload_ready();
243             this.show_progress_spinner();
245             var files = e._event.dataTransfer.files;
246             if (this.filemanager) {
247                 var currentfilecount = this.filemanager.filecount;
248                 for (var i=0, f; f=files[i]; i++) {
249                     if (currentfilecount >= this.maxfiles && this.maxfiles != -1) {
250                         alert(M.util.get_string('maxfilesreached', 'moodle', this.maxfiles));
251                         break;
252                     }
253                     if (this.upload_file(f)) {
254                         currentfilecount++;
255                     }
256                 }
257             } else {
258                 if (files.length >= 1) {
259                     this.upload_file(files[0]);
260                 }
261             }
263             return false;
264         },
266         /**
267          * Check to see if the drag event has any files in it
268          *
269          * @param e event object
270          * @return boolean true if event has files
271          */
272         has_files: function(e) {
273             var types = e._event.dataTransfer.types;
274             for (var i=0; i<types.length; i++) {
275                 if (types[i] == 'Files') {
276                     return true;
277                 }
278             }
279             return false;
280         },
282         /**
283          * Check if reached the maximumum number of allowed files
284          *
285          * @return boolean true if reached maximum number of files
286          */
287         reached_maxfiles: function() {
288             if (this.filemanager) {
289                 if (this.filemanager.filecount >= this.maxfiles && this.maxfiles != -1) {
290                     return true;
291                 }
292             }
293             return false;
294         },
296         /**
297          * Highlight the destination node
298          */
299         show_upload_ready: function() {
300             this.container.addClass('dndupload-over');
301         },
303         /**
304          * Remove highlight on destination node
305          */
306         hide_upload_ready: function() {
307             this.container.removeClass('dndupload-over');
308         },
310         /**
311          * Display a progress spinner in the destination node
312          */
313         show_progress_spinner: function() {
314             // add a loading spinner to show something is happening
315             var loadingspinner = this.Y.Node.create('<div id="dndprogresspinner-'+this.clientid+'" style="text-align: center">');
316             loadingspinner.append('<img src="'+M.util.image_url('i/loading_small')+'" />');
317             this.container.append(loadingspinner);
318         },
320         /**
321          * Remove progress spinner in the destination node
322          */
323         hide_progress_spinner: function() {
324             this.Y.one('#dndprogresspinner-'+this.clientid).remove();
325         },
327         /**
328          * Tell the attached filemanager element (if any) to refresh on file
329          * upload
330          */
331         update_filemanager: function() {
332             if (this.filemanager) {
333                 // update the filemanager that we've uploaded the files
334                 this.filemanager.filepicker_callback();
335             }
336         },
338         /**
339          * Upload a single file via an AJAX call to the 'upload' repository
340          */
341         upload_file: function(file) {
342             if (file.size > this.maxbytes && this.maxbytes > 0) {
343                 // Check filesize before attempting to upload
344                 this.hide_progress_spinner();
345                 alert(M.util.get_string('uploadformlimit', 'moodle')+"\n'"+file.name+"'");
346                 return false;
347             }
349             // This would be an ideal place to use the Y.io function
350             // however, this does not support data encoded using the
351             // FormData object, which is needed to transfer data from
352             // the DataTransfer object into an XMLHTTPRequest
353             // This can be converted when the YUI issue has been integrated:
354             // http://yuilibrary.com/projects/yui3/ticket/2531274
355             var xhr = new XMLHttpRequest();
356             var self = this;
357             xhr.onreadystatechange = function() { // Process the server response
358                 if (xhr.readyState == 4) {
359                     self.hide_progress_spinner();
360                     if (xhr.status == 200) {
361                         var result = JSON.parse(xhr.responseText);
362                         if (result) {
363                             if (result.error) {
364                                 alert(result.error);
365                             } else if (self.callback) {
366                                 // Only update the filepicker if there were no errors
367                                 if (result.event == 'fileexists') {
368                                     // Do not worry about this, as we only care about the last
369                                     // file uploaded, with the filepicker
370                                     result.file = result.newfile.filename;
371                                     result.url = result.newfile.url;
372                                 }
373                                 result.client_id = self.clientid;
374                                 self.callback(result);
375                             } else {
376                                 self.update_filemanager();
377                             }
378                         }
379                     } else {
380                         alert(M.util.get_string('serverconnection', 'error'));
381                     }
382                 }
383             };
385             // Prepare the data to send
386             var formdata = new FormData();
387             formdata.append('repo_upload_file', file); // The FormData class allows us to attach a file
388             formdata.append('sesskey', M.cfg.sesskey);
389             formdata.append('repo_id', this.repositoryid);
390             formdata.append('itemid', this.itemid);
391             if (this.filemanager) { // Filepickers do not have folders
392                 formdata.append('savepath', this.filemanager.currentpath);
393             }
395             if (this.acceptedtypes.constructor == Array) {
396                 for (var i=0; i<this.acceptedtypes.length; i++) {
397                     formdata.append('accepted_types[]', this.acceptedtypes[i]);
398                 }
399             } else {
400                 formdata.append('accepted_types[]', this.acceptedtypes);
401             }
403             // Send the file & required details
404             xhr.open("POST", this.url, true);
405             xhr.send(formdata);
406             return true;
407         }
408     };
410     dnduploadhelper.init(Y, options);
411 };