1 // This file is part of Moodle - http://moodle.org/
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.
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/>.
17 * Javascript library for enableing a drag and drop upload to courses
21 * @copyright 2012 Davo Smith
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 M.course_dndupload = {
27 // URL for upload requests
28 url: M.cfg.wwwroot + '/course/dndupload.php',
29 // maximum size of files allowed in this form
31 // ID of the course we are on
33 // Data about the different file/data handlers that are available
35 // Nasty hack to distinguish between dragenter(first entry),
36 // dragenter+dragleave(moving between child elements) and dragleave (leaving element)
38 // Used to keep track of the section we are dragging across - to make
39 // spotting movement between sections more reliable
41 // Used to store the pending uploads whilst the user is being asked for further input
43 // True if the there is currently a dialog being shown (asking for a name, or giving a
44 // choice of file handlers)
46 // An array containing the last selected file handler for each file type
49 // The following are used to identify specific parts of the course page
51 // The type of HTML element that is a course section
52 sectiontypename: 'li',
53 // The classes that an element must have to be identified as a course section
54 sectionclasses: ['section', 'main'],
55 // The ID of the main content area of the page (for adding the 'status' div)
56 pagecontentid: 'page',
57 // The selector identifying the list of modules within a section (note changing this may require
58 // changes to the get_mods_element function)
59 modslistselector: 'ul.section',
62 * Initalise the drag and drop upload interface
63 * Note: one and only one of options.filemanager and options.formcallback must be defined
65 * @param Y the YUI object
66 * @param object options {
67 * courseid: ID of the course we are on
68 * maxbytes: maximum size of files allowed in this form
69 * handlers: Data about the different file/data handlers that are available
72 init: function(Y, options) {
75 if (!this.browser_supported()) {
76 return; // Browser does not support the required functionality
79 this.maxbytes = options.maxbytes;
80 this.courseid = options.courseid;
81 this.handlers = options.handlers;
82 this.uploadqueue = new Array();
83 this.lastselected = new Array();
85 var sectionselector = this.sectiontypename + '.' + this.sectionclasses.join('.');
86 var sections = this.Y.all(sectionselector);
87 if (sections.isEmpty()) {
88 return; // No sections - incompatible course format or front page.
90 sections.each( function(el) {
91 this.add_preview_element(el);
95 if (options.showstatus) {
96 this.add_status_div();
101 * Add a div element to tell the user that drag and drop upload
102 * is available (or to explain why it is not available)
104 add_status_div: function() {
106 coursecontents = Y.one('#' + this.pagecontentid),
108 handlefile = (this.handlers.filehandlers.length > 0),
115 if (!coursecontents) {
119 div = Y.Node.create('<div id="dndupload-status"></div>').setStyle('opacity', '0.0');
120 coursecontents.insert(div, 0);
122 for (i = 0; i < this.handlers.types.length; i++) {
123 switch (this.handlers.types[i].identifier) {
133 $msgident = 'dndworking';
143 div.setContent(M.util.get_string($msgident, 'moodle'));
145 styletop = div.getStyle('top') || '0px';
146 styletopunit = styletop.replace(/^\d+/, '');
147 styletop = parseInt(styletop.replace(/\D*$/, ''), 10);
149 var fadeanim = new Y.Anim({
150 node: '#dndupload-status',
153 top: (styletop - 30).toString() + styletopunit
158 top: styletop.toString() + styletopunit
162 fadeanim.once('end', function(e) {
163 this.set('reverse', 1);
164 Y.later(3000, this, 'run', null, false);
170 * Check the browser has the required functionality
171 * @return true if browser supports drag/drop upload
173 browser_supported: function() {
174 if (typeof FileReader == 'undefined') {
177 if (typeof FormData == 'undefined') {
184 * Initialise drag events on node container, all events need
185 * to be processed for drag and drop to work
186 * @param el the element to add events to
188 init_events: function(el) {
189 this.Y.on('dragenter', this.drag_enter, el, this);
190 this.Y.on('dragleave', this.drag_leave, el, this);
191 this.Y.on('dragover', this.drag_over, el, this);
192 this.Y.on('drop', this.drop, el, this);
196 * Work out which course section a given element is in
197 * @param el the child DOM element within the section
198 * @return the DOM element representing the section
200 get_section: function(el) {
201 var sectionclasses = this.sectionclasses;
202 return el.ancestor( function(test) {
204 for (i=0; i<sectionclasses.length; i++) {
205 if (!test.hasClass(sectionclasses[i])) {
214 * Work out the number of the section we have been dropped on to, from the section element
215 * @param DOMElement section the selected section
216 * @return int the section number
218 get_section_number: function(section) {
219 var sectionid = section.get('id').split('-');
220 if (sectionid.length < 2 || sectionid[0] != 'section') {
223 return parseInt(sectionid[1]);
227 * Check if the event includes data of the given type
228 * @param e the event details
229 * @param type the data type to check for
230 * @return true if the data type is found in the event data
232 types_includes: function(e, type) {
234 var types = e._event.dataTransfer.types;
235 type = type.toLowerCase();
236 for (i=0; i<types.length; i++) {
237 if (!types.hasOwnProperty(i)) {
240 if (types[i].toLowerCase() === type) {
248 * Look through the event data, checking it against the registered data types
249 * (in order of priority) and return details of the first matching data type
250 * @param e the event details
251 * @return object|false - false if not found or an object {
252 * realtype: the type as given by the browser
253 * addmessage: the message to show to the user during dragging
254 * namemessage: the message for requesting a name for the resource from the user
255 * type: the identifier of the type (may match several 'realtype's)
258 drag_type: function(e) {
259 // Check there is some data attached.
260 if (e._event.dataTransfer === null) {
263 if (e._event.dataTransfer.types === null) {
266 if (e._event.dataTransfer.types.length == 0) {
270 // Check for files first.
271 if (this.types_includes(e, 'Files')) {
272 if (e.type != 'drop' || e._event.dataTransfer.files.length != 0) {
273 if (this.handlers.filehandlers.length == 0) {
274 return false; // No available file handlers - ignore this drag.
278 addmessage: M.util.get_string('addfilehere', 'moodle'),
279 namemessage: null, // Should not be asked for anyway
285 // Check each of the registered types.
286 var types = this.handlers.types;
287 for (var i=0; i<types.length; i++) {
288 // Check each of the different identifiers for this type
289 var dttypes = types[i].datatransfertypes;
290 for (var j=0; j<dttypes.length; j++) {
291 if (this.types_includes(e, dttypes[j])) {
293 realtype: dttypes[j],
294 addmessage: types[i].addmessage,
295 namemessage: types[i].namemessage,
296 handlermessage: types[i].handlermessage,
297 type: types[i].identifier,
298 handlers: types[i].handlers
303 return false; // No types we can handle
307 * Check the content of the drag/drop includes a type we can handle, then, if
308 * it is, notify the browser that we want to handle it
310 * @return string type of the event or false
312 check_drag: function(e) {
313 var type = this.drag_type(e);
315 // Notify browser that we will handle this drag/drop
323 * Handle a dragenter event: add a suitable 'add here' message
324 * when a drag event occurs, containing a registered data type
325 * @param e event data
326 * @return false to prevent the event from continuing to be processed
328 drag_enter: function(e) {
329 if (!(type = this.check_drag(e))) {
333 var section = this.get_section(e.currentTarget);
338 if (this.currentsection && this.currentsection != section) {
339 this.currentsection = section;
343 if (this.entercount > 2) {
349 this.show_preview_element(section, type);
355 * Handle a dragleave event: remove the 'add here' message (if present)
356 * @param e event data
357 * @return false to prevent the event from continuing to be processed
359 drag_leave: function(e) {
360 if (!this.check_drag(e)) {
365 if (this.entercount == 1) {
369 this.currentsection = null;
371 this.hide_preview_element();
376 * Handle a dragover event: just prevent the browser default (necessary
377 * to allow drag and drop handling to work)
378 * @param e event data
379 * @return false to prevent the event from continuing to be processed
381 drag_over: function(e) {
387 * Handle a drop event: hide the 'add here' message, check the attached
388 * data type and start the upload process
389 * @param e event data
390 * @return false to prevent the event from continuing to be processed
393 if (!(type = this.check_drag(e))) {
397 this.hide_preview_element();
399 // Work out the number of the section we are on (from its id)
400 var section = this.get_section(e.currentTarget);
401 var sectionnumber = this.get_section_number(section);
403 // Process the file or the included data
404 if (type.type == 'Files') {
405 var files = e._event.dataTransfer.files;
406 for (var i=0, f; f=files[i]; i++) {
407 this.handle_file(f, section, sectionnumber);
410 var contents = e._event.dataTransfer.getData(type.realtype);
412 this.handle_item(type, contents, section, sectionnumber);
420 * Find or create the 'ul' element that contains all of the module
421 * instances in this section
422 * @param section the DOM element representing the section
423 * @return false to prevent the event from continuing to be processed
425 get_mods_element: function(section) {
426 // Find the 'ul' containing the list of mods
427 var modsel = section.one(this.modslistselector);
429 // Create the above 'ul' if it doesn't exist
430 modsel = document.createElement('ul');
431 modsel.className = 'section img-text';
432 var contentel = section.get('children').pop();
433 var brel = contentel.get('children').pop();
434 contentel.insertBefore(modsel, brel);
435 modsel = this.Y.one(modsel);
442 * Add a new dummy item to the list of mods, to be replaced by a real
443 * item & link once the AJAX upload call has completed
444 * @param name the label to show in the element
445 * @param section the DOM element reperesenting the course section
446 * @return DOM element containing the new item
448 add_resource_element: function(name, section, module) {
449 var modsel = this.get_mods_element(section);
453 li: document.createElement('li'),
454 div: document.createElement('div'),
455 indentdiv: document.createElement('div'),
456 a: document.createElement('a'),
457 icon: document.createElement('img'),
458 namespan: document.createElement('span'),
459 groupingspan: document.createElement('span'),
460 progressouter: document.createElement('span'),
461 progress: document.createElement('span')
464 resel.li.className = 'activity ' + module + ' modtype_' + module;
466 resel.indentdiv.className = 'mod-indent';
467 resel.li.appendChild(resel.indentdiv);
469 resel.div.className = 'activityinstance';
470 resel.indentdiv.appendChild(resel.div);
473 resel.div.appendChild(resel.a);
475 resel.icon.src = M.util.image_url('i/ajaxloader');
476 resel.icon.className = 'activityicon iconlarge';
477 resel.a.appendChild(resel.icon);
479 resel.namespan.className = 'instancename';
480 resel.namespan.innerHTML = name;
481 resel.a.appendChild(resel.namespan);
483 resel.groupingspan.className = 'groupinglabel';
484 resel.div.appendChild(resel.groupingspan);
486 resel.progressouter.className = 'dndupload-progress-outer';
487 resel.progress.className = 'dndupload-progress-inner';
488 resel.progress.innerHTML = ' ';
489 resel.progressouter.appendChild(resel.progress);
490 resel.div.appendChild(resel.progressouter);
492 modsel.insertBefore(resel.li, modsel.get('children').pop()); // Leave the 'preview element' at the bottom
498 * Hide any visible dndupload-preview elements on the page
500 hide_preview_element: function() {
501 this.Y.all('li.dndupload-preview').addClass('dndupload-hidden');
502 this.Y.all('.dndupload-over').removeClass('dndupload-over');
506 * Unhide the preview element for the given section and set it to display
507 * the correct message
508 * @param section the YUI node representing the selected course section
509 * @param type the details of the data type detected in the drag (including the message to display)
511 show_preview_element: function(section, type) {
512 this.hide_preview_element();
513 var preview = section.one('li.dndupload-preview').removeClass('dndupload-hidden');
514 section.addClass('dndupload-over');
516 // Horrible work-around to allow the 'Add X here' text to be a drop target in Firefox.
517 var node = preview.one('span').getDOMNode();
518 node.firstChild.nodeValue = type.addmessage;
522 * Add the preview element to a course section. Note: this needs to be done before 'addEventListener'
523 * is called, otherwise Firefox will ignore events generated when the mouse is over the preview
524 * element (instead of passing them up to the parent element)
525 * @param section the YUI node representing the selected course section
527 add_preview_element: function(section) {
528 var modsel = this.get_mods_element(section);
530 li: document.createElement('li'),
531 div: document.createElement('div'),
532 icon: document.createElement('img'),
533 namespan: document.createElement('span')
536 preview.li.className = 'dndupload-preview dndupload-hidden';
538 preview.div.className = 'mod-indent';
539 preview.li.appendChild(preview.div);
541 preview.icon.src = M.util.image_url('t/addfile');
542 preview.icon.className = 'icon';
543 preview.div.appendChild(preview.icon);
545 preview.div.appendChild(document.createTextNode(' '));
547 preview.namespan.className = 'instancename';
548 preview.namespan.innerHTML = M.util.get_string('addfilehere', 'moodle');
549 preview.div.appendChild(preview.namespan);
551 modsel.appendChild(preview.li);
555 * Find the registered handler for the given file type. If there is more than one, ask the
556 * user which one to use. Then upload the file to the server
557 * @param file the details of the file, taken from the FileList in the drop event
558 * @param section the DOM element representing the selected course section
559 * @param sectionnumber the number of the selected course section
561 handle_file: function(file, section, sectionnumber) {
562 var handlers = new Array();
563 var filehandlers = this.handlers.filehandlers;
565 var dotpos = file.name.lastIndexOf('.');
567 extension = file.name.substr(dotpos+1, file.name.length).toLowerCase();
570 for (var i=0; i<filehandlers.length; i++) {
571 if (filehandlers[i].extension == '*' || filehandlers[i].extension == extension) {
572 handlers.push(filehandlers[i]);
576 if (handlers.length == 0) {
577 // No handlers at all (not even 'resource'?)
581 if (handlers.length == 1) {
582 this.upload_file(file, section, sectionnumber, handlers[0].module);
586 this.file_handler_dialog(handlers, extension, file, section, sectionnumber);
590 * Show a dialog box, allowing the user to choose what to do with the file they are uploading
591 * @param handlers the available handlers to choose between
592 * @param extension the extension of the file being uploaded
593 * @param file the File object being uploaded
594 * @param section the DOM element of the section being uploaded to
595 * @param sectionnumber the number of the selected course section
597 file_handler_dialog: function(handlers, extension, file, section, sectionnumber) {
598 if (this.uploaddialog) {
599 var details = new Object();
600 details.isfile = true;
601 details.handlers = handlers;
602 details.extension = extension;
604 details.section = section;
605 details.sectionnumber = sectionnumber;
606 this.uploadqueue.push(details);
609 this.uploaddialog = true;
611 var timestamp = new Date().getTime();
612 var uploadid = Math.round(Math.random()*100000)+'-'+timestamp;
615 if (extension in this.lastselected) {
616 sel = this.lastselected[extension];
618 sel = handlers[0].module;
620 content += '<p>'+M.util.get_string('actionchoice', 'moodle', file.name)+'</p>';
621 content += '<div id="dndupload_handlers'+uploadid+'">';
622 for (var i=0; i<handlers.length; i++) {
623 var id = 'dndupload_handler'+uploadid+handlers[i].module;
624 var checked = (handlers[i].module == sel) ? 'checked="checked" ' : '';
625 content += '<input type="radio" name="handler" value="'+handlers[i].module+'" id="'+id+'" '+checked+'/>';
626 content += ' <label for="'+id+'">';
627 content += handlers[i].message;
628 content += '</label><br/>';
634 var panel = new M.core.dialogue({
635 bodyContent: content,
642 points: [Y.WidgetPositionAlign.CC, Y.WidgetPositionAlign.CC]
645 // When the panel is hidden - destroy it and then check for other pending uploads
646 panel.after("visibleChange", function(e) {
647 if (!panel.get('visible')) {
649 self.check_upload_queue();
653 // Add the submit/cancel buttons to the bottom of the dialog.
655 label: M.util.get_string('upload', 'moodle'),
656 action: function(e) {
658 // Find out which module was selected
660 var div = Y.one('#dndupload_handlers'+uploadid);
661 div.all('input').each(function(input) {
662 if (input.get('checked')) {
663 module = input.get('value');
670 // Remember this selection for next time
671 self.lastselected[extension] = module;
673 self.upload_file(file, section, sectionnumber, module);
675 section: Y.WidgetStdMod.FOOTER
678 label: M.util.get_string('cancel', 'moodle'),
679 action: function(e) {
683 section: Y.WidgetStdMod.FOOTER
688 * Check to see if there are any other dialog boxes to show, now that the current one has
691 check_upload_queue: function() {
692 this.uploaddialog = false;
693 if (this.uploadqueue.length == 0) {
697 var details = this.uploadqueue.shift();
698 if (details.isfile) {
699 this.file_handler_dialog(details.handlers, details.extension, details.file, details.section, details.sectionnumber);
701 this.handle_item(details.type, details.contents, details.section, details.sectionnumber);
706 * Do the file upload: show the dummy element, use an AJAX call to send the data
707 * to the server, update the progress bar for the file, then replace the dummy
708 * element with the real information once the AJAX call completes
709 * @param file the details of the file, taken from the FileList in the drop event
710 * @param section the DOM element representing the selected course section
711 * @param sectionnumber the number of the selected course section
713 upload_file: function(file, section, sectionnumber, module) {
715 // This would be an ideal place to use the Y.io function
716 // however, this does not support data encoded using the
717 // FormData object, which is needed to transfer data from
718 // the DataTransfer object into an XMLHTTPRequest
719 // This can be converted when the YUI issue has been integrated:
720 // http://yuilibrary.com/projects/yui3/ticket/2531274
721 var xhr = new XMLHttpRequest();
724 if (file.size > this.maxbytes) {
725 alert("'"+file.name+"' "+M.util.get_string('filetoolarge', 'moodle'));
729 // Add the file to the display
730 var resel = this.add_resource_element(file.name, section, module);
732 // Update the progress bar as the file is uploaded
733 xhr.upload.addEventListener('progress', function(e) {
734 if (e.lengthComputable) {
735 var percentage = Math.round((e.loaded * 100) / e.total);
736 resel.progress.style.width = percentage + '%';
740 // Wait for the AJAX call to complete, then update the
741 // dummy element with the returned details
742 xhr.onreadystatechange = function() {
743 if (xhr.readyState == 4) {
744 if (xhr.status == 200) {
745 var result = JSON.parse(xhr.responseText);
747 if (result.error == 0) {
748 // All OK - update the dummy element
749 if (result.content) {
751 resel.indentdiv.innerHTML = '<div class="activityinstance" ></div>' + result.content + result.commands;
754 resel.icon.src = result.icon;
755 resel.a.href = result.link;
756 resel.namespan.innerHTML = result.name;
758 if (!parseInt(result.visible, 10)) {
759 resel.a.className = 'dimmed';
762 if (result.groupingname) {
763 resel.groupingspan.innerHTML = '(' + result.groupingname + ')';
765 resel.div.removeChild(resel.groupingspan);
768 resel.div.removeChild(resel.progressouter);
769 resel.indentdiv.innerHTML += result.commands;
770 if (result.onclick) {
771 resel.a.onclick = result.onclick;
773 if (self.Y.UA.gecko > 0) {
774 // Fix a Firefox bug which makes sites with a '~' in their wwwroot
775 // log the user out when clicking on the link (before refreshing the page).
776 resel.div.innerHTML = unescape(resel.div.innerHTML);
779 resel.li.id = result.elementid;
780 self.add_editing(result.elementid);
782 // Error - remove the dummy element
783 resel.parent.removeChild(resel.li);
788 alert(M.util.get_string('servererror', 'moodle'));
793 // Prepare the data to send
794 var formData = new FormData();
795 formData.append('repo_upload_file', file);
796 formData.append('sesskey', M.cfg.sesskey);
797 formData.append('course', this.courseid);
798 formData.append('section', sectionnumber);
799 formData.append('module', module);
800 formData.append('type', 'Files');
802 // Send the AJAX call
803 xhr.open("POST", this.url, true);
808 * Show a dialog box to gather the name of the resource / activity to be created
809 * from the uploaded content
810 * @param type the details of the type of content
811 * @param contents the contents to be uploaded
812 * @section the DOM element for the section being uploaded to
813 * @sectionnumber the number of the section being uploaded to
815 handle_item: function(type, contents, section, sectionnumber) {
816 if (type.handlers.length == 0) {
817 // Nothing to handle this - should not have got here
821 if (type.handlers.length == 1 && type.handlers[0].noname) {
822 // Only one handler and it doesn't need a name (i.e. a label).
823 this.upload_item('', type.type, contents, section, sectionnumber, type.handlers[0].module);
824 this.check_upload_queue();
828 if (this.uploaddialog) {
829 var details = new Object();
830 details.isfile = false;
832 details.contents = contents;
833 details.section = section;
834 details.setcionnumber = sectionnumber;
835 this.uploadqueue.push(details);
838 this.uploaddialog = true;
840 var timestamp = new Date().getTime();
841 var uploadid = Math.round(Math.random()*100000)+'-'+timestamp;
842 var nameid = 'dndupload_handler_name'+uploadid;
844 if (type.handlers.length > 1) {
845 content += '<p>'+type.handlermessage+'</p>';
846 content += '<div id="dndupload_handlers'+uploadid+'">';
847 var sel = type.handlers[0].module;
848 for (var i=0; i<type.handlers.length; i++) {
849 var id = 'dndupload_handler'+uploadid+type.handlers[i].module;
850 var checked = (type.handlers[i].module == sel) ? 'checked="checked" ' : '';
851 content += '<input type="radio" name="handler" value="'+i+'" id="'+id+'" '+checked+'/>';
852 content += ' <label for="'+id+'">';
853 content += type.handlers[i].message;
854 content += '</label><br/>';
858 var disabled = (type.handlers[0].noname) ? ' disabled = "disabled" ' : '';
859 content += '<label for="'+nameid+'">'+type.namemessage+'</label>';
860 content += ' <input type="text" id="'+nameid+'" value="" '+disabled+' />';
864 var panel = new M.core.dialogue({
865 bodyContent: content,
872 points: [Y.WidgetPositionAlign.CC, Y.WidgetPositionAlign.CC]
876 // When the panel is hidden - destroy it and then check for other pending uploads
877 panel.after("visibleChange", function(e) {
878 if (!panel.get('visible')) {
880 self.check_upload_queue();
884 var namefield = Y.one('#'+nameid);
885 var submit = function(e) {
887 var name = Y.Lang.trim(namefield.get('value'));
890 if (type.handlers.length > 1) {
891 // Find out which module was selected
892 var div = Y.one('#dndupload_handlers'+uploadid);
893 div.all('input').each(function(input) {
894 if (input.get('checked')) {
895 var idx = input.get('value');
896 module = type.handlers[idx].module;
897 noname = type.handlers[idx].noname;
904 module = type.handlers[0].module;
905 noname = type.handlers[0].noname;
907 if (name == '' && !noname) {
915 self.upload_item(name, type.type, contents, section, sectionnumber, module);
918 // Add the submit/cancel buttons to the bottom of the dialog.
920 label: M.util.get_string('upload', 'moodle'),
922 section: Y.WidgetStdMod.FOOTER,
926 label: M.util.get_string('cancel', 'moodle'),
927 action: function(e) {
931 section: Y.WidgetStdMod.FOOTER
933 var submitbutton = panel.getButton('submit').button;
934 namefield.on('key', submit, 'enter'); // Submit the form if 'enter' pressed
935 namefield.after('keyup', function() {
936 if (Y.Lang.trim(namefield.get('value')) == '') {
937 submitbutton.disable();
939 submitbutton.enable();
943 // Enable / disable the 'name' box, depending on the handler selected.
944 for (i=0; i<type.handlers.length; i++) {
945 if (type.handlers[i].noname) {
946 Y.one('#dndupload_handler'+uploadid+type.handlers[i].module).on('click', function (e) {
947 namefield.set('disabled', 'disabled');
948 submitbutton.enable();
951 Y.one('#dndupload_handler'+uploadid+type.handlers[i].module).on('click', function (e) {
952 namefield.removeAttribute('disabled');
954 if (Y.Lang.trim(namefield.get('value')) == '') {
955 submitbutton.disable();
961 // Focus on the 'name' box
962 Y.one('#'+nameid).focus();
966 * Upload any data types that are not files: display a dummy resource element, send
967 * the data to the server, update the progress bar for the file, then replace the
968 * dummy element with the real information once the AJAX call completes
969 * @param name the display name for the resource / activity to create
970 * @param type the details of the data type found in the drop event
971 * @param contents the actual data that was dropped
972 * @param section the DOM element representing the selected course section
973 * @param sectionnumber the number of the selected course section
974 * @param module the module chosen to handle this upload
976 upload_item: function(name, type, contents, section, sectionnumber, module) {
978 // This would be an ideal place to use the Y.io function
979 // however, this does not support data encoded using the
980 // FormData object, which is needed to transfer data from
981 // the DataTransfer object into an XMLHTTPRequest
982 // This can be converted when the YUI issue has been integrated:
983 // http://yuilibrary.com/projects/yui3/ticket/2531274
984 var xhr = new XMLHttpRequest();
987 // Add the item to the display
988 var resel = this.add_resource_element(name, section, module);
990 // Wait for the AJAX call to complete, then update the
991 // dummy element with the returned details
992 xhr.onreadystatechange = function() {
993 if (xhr.readyState == 4) {
994 if (xhr.status == 200) {
995 var result = JSON.parse(xhr.responseText);
997 if (result.error == 0) {
998 // All OK - update the dummy element
999 if (result.content) {
1001 resel.indentdiv.innerHTML = '<div class="activityinstance" ></div>' + result.content + result.commands;
1004 resel.icon.src = result.icon;
1005 resel.a.href = result.link;
1006 resel.namespan.innerHTML = result.name;
1008 if (!parseInt(result.visible, 10)) {
1009 resel.a.className = 'dimmed';
1012 if (result.groupingname) {
1013 resel.groupingspan.innerHTML = '(' + result.groupingname + ')';
1015 resel.div.removeChild(resel.groupingspan);
1018 resel.div.removeChild(resel.progressouter);
1019 resel.div.innerHTML += result.commands;
1020 if (result.onclick) {
1021 resel.a.onclick = result.onclick;
1023 if (self.Y.UA.gecko > 0) {
1024 // Fix a Firefox bug which makes sites with a '~' in their wwwroot
1025 // log the user out when clicking on the link (before refreshing the page).
1026 resel.div.innerHTML = unescape(resel.div.innerHTML);
1029 resel.li.id = result.elementid;
1030 self.add_editing(result.elementid, sectionnumber);
1032 // Error - remove the dummy element
1033 resel.parent.removeChild(resel.li);
1034 alert(result.error);
1038 alert(M.util.get_string('servererror', 'moodle'));
1043 // Prepare the data to send
1044 var formData = new FormData();
1045 formData.append('contents', contents);
1046 formData.append('displayname', name);
1047 formData.append('sesskey', M.cfg.sesskey);
1048 formData.append('course', this.courseid);
1049 formData.append('section', sectionnumber);
1050 formData.append('type', type);
1051 formData.append('module', module);
1054 xhr.open("POST", this.url, true);
1059 * Call the AJAX course editing initialisation to add the editing tools
1060 * to the newly-created resource link
1061 * @param elementid the id of the DOM element containing the new resource link
1062 * @param sectionnumber the number of the selected course section
1064 add_editing: function(elementid) {
1065 YUI().use('moodle-course-coursebase', function(Y) {
1066 M.course.coursebase.invoke_function('setup_for_resource', '#' + elementid);