e29e3788a8cfeac8666f06c6377005de7f001d9e
[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) {
165             if (!this.has_files(e)) {
166                 return false;
167             }
169             e.preventDefault();
170             e.stopPropagation();
172             if (this.reached_maxfiles()) {
173                 return false;
174             }
176             return true;
177         },
179         /**
180          * Handle a dragenter event, highlight the destination node
181          * when a suitable drag event occurs
182          */
183         drag_enter: function(e) {
184             if (!this.check_drag(e)) {
185                 return true;
186             }
188             this.entercount++;
189             if (this.entercount >= 2) {
190                 this.entercount = 2; // Just moved over a child element - nothing to do
191                 return false;
192             }
194             this.show_upload_ready();
195             return false;
196         },
198         /**
199          * Handle a dragleave event, Remove the highlight if dragged from
200          * node
201          */
202         drag_leave: function(e) {
203             if (!this.check_drag(e)) {
204                 return true;
205             }
207             this.entercount--;
208             if (this.entercount == 1) {
209                 return false; // Just moved over a child element - nothing to do
210             }
212             this.entercount = 0;
213             this.hide_upload_ready();
214             return false;
215         },
217         /**
218          * Handle a dragover event. Required to intercept to prevent the browser from
219          * handling the drag and drop event as normal
220          */
221         drag_over: function(e) {
222             if (!this.check_drag(e)) {
223                 return true;
224             }
226             return false;
227         },
229         /**
230          * Handle a drop event.  Remove the highlight and then upload each
231          * of the files (until we reach the file limit, or run out of files)
232          */
233         drop: function(e) {
234             if (!this.check_drag(e)) {
235                 return true;
236             }
238             this.entercount = 0;
239             this.hide_upload_ready();
240             this.show_progress_spinner();
242             var files = e._event.dataTransfer.files;
243             if (this.filemanager) {
244                 var currentfilecount = this.filemanager.filecount;
245                 for (var i=0, f; f=files[i]; i++) {
246                     if (currentfilecount >= this.maxfiles && this.maxfiles != -1) {
247                         break;
248                     }
249                     if (this.upload_file(f)) {
250                         currentfilecount++;
251                     }
252                 }
253             } else {
254                 if (files.length >= 1) {
255                     this.upload_file(files[0]);
256                 }
257             }
259             return false;
260         },
262         /**
263          * Check to see if the drag event has any files in it
264          *
265          * @param e event object
266          * @return boolean true if event has files
267          */
268         has_files: function(e) {
269             var types = e._event.dataTransfer.types;
270             for (var i=0; i<types.length; i++) {
271                 if (types[i] == 'Files') {
272                     return true;
273                 }
274             }
275             return false;
276         },
278         /**
279          * Check if reached the maximumum number of allowed files
280          *
281          * @return boolean true if reached maximum number of files
282          */
283         reached_maxfiles: function() {
284             if (this.filemanager) {
285                 if (this.filemanager.filecount >= this.maxfiles && this.maxfiles != -1) {
286                     return true;
287                 }
288             }
289             return false;
290         },
292         /**
293          * Highlight the destination node
294          */
295         show_upload_ready: function() {
296             this.container.addClass('dndupload-over');
297         },
299         /**
300          * Remove highlight on destination node
301          */
302         hide_upload_ready: function() {
303             this.container.removeClass('dndupload-over');
304         },
306         /**
307          * Display a progress spinner in the destination node
308          */
309         show_progress_spinner: function() {
310             // add a loading spinner to show something is happening
311             var loadingspinner = this.Y.Node.create('<div id="dndprogresspinner-'+this.clientid+'" style="text-align: center">');
312             loadingspinner.append('<img src="'+M.util.image_url('i/loading_small')+'" />');
313             this.container.append(loadingspinner);
314         },
316         /**
317          * Remove progress spinner in the destination node
318          */
319         hide_progress_spinner: function() {
320             this.Y.one('#dndprogresspinner-'+this.clientid).remove();
321         },
323         /**
324          * Tell the attached filemanager element (if any) to refresh on file
325          * upload
326          */
327         update_filemanager: function() {
328             if (this.filemanager) {
329                 // update the filemanager that we've uploaded the files
330                 this.filemanager.filepicker_callback();
331             }
332         },
334         /**
335          * Upload a single file via an AJAX call to the 'upload' repository
336          */
337         upload_file: function(file) {
338             if (file.size > this.maxbytes && this.maxbytes > 0) {
339                 // Check filesize before attempting to upload
340                 this.hide_progress_spinner();
341                 alert(M.util.get_string('uploadformlimit', 'moodle')+"\n'"+file.name+"'");
342                 return false;
343             }
345             // This would be an ideal place to use the Y.io function
346             // however, this does not support data encoded using the
347             // FormData object, which is needed to transfer data from
348             // the DataTransfer object into an XMLHTTPRequest
349             // This can be converted when the YUI issue has been integrated:
350             // http://yuilibrary.com/projects/yui3/ticket/2531274
351             var xhr = new XMLHttpRequest();
352             var self = this;
353             xhr.onreadystatechange = function() { // Process the server response
354                 if (xhr.readyState == 4) {
355                     self.hide_progress_spinner();
356                     if (xhr.status == 200) {
357                         var result = JSON.parse(xhr.responseText);
358                         if (result) {
359                             if (result.error) {
360                                 alert(result.error);
361                             } else if (self.callback) {
362                                 // Only update the filepicker if there were no errors
363                                 if (result.event == 'fileexists') {
364                                     // Do not worry about this, as we only care about the last
365                                     // file uploaded, with the filepicker
366                                     result.file = result.newfile.filename;
367                                     result.url = result.newfile.url;
368                                 }
369                                 result.client_id = self.clientid;
370                                 self.callback(result);
371                             } else {
372                                 self.update_filemanager();
373                             }
374                         }
375                     } else {
376                         alert(M.util.get_string('serverconnection', 'error'));
377                     }
378                 }
379             };
381             // Prepare the data to send
382             var formdata = new FormData();
383             formdata.append('repo_upload_file', file); // The FormData class allows us to attach a file
384             formdata.append('sesskey', M.cfg.sesskey);
385             formdata.append('repo_id', this.repositoryid);
386             formdata.append('itemid', this.itemid);
387             if (this.filemanager) { // Filepickers do not have folders
388                 formdata.append('savepath', this.filemanager.currentpath);
389             }
391             if (this.acceptedtypes.constructor == Array) {
392                 for (var i=0; i<this.acceptedtypes.length; i++) {
393                     formdata.append('accepted_types[]', this.acceptedtypes[i]);
394                 }
395             } else {
396                 formdata.append('accepted_types[]', this.acceptedtypes);
397             }
399             // Send the file & required details
400             xhr.open("POST", this.url, true);
401             xhr.send(formdata);
402             return true;
403         }
404     };
406     dnduploadhelper.init(Y, options);
407 };