course/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/>.
  15
  16 /**
  17  * Javascript library for enableing a drag and drop upload to courses
  18  *
  19  * @package    core
  20  * @subpackage course
  21  * @copyright  2012 Davo Smith
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 M.course_dndupload = {
  25     // YUI object.
  26     Y: null,
  27     // URL for upload requests
  28     url: M.cfg.wwwroot + '/course/dndupload.php',
  29     // maximum size of files allowed in this form
  30     maxbytes: 0,
  31     // ID of the course we are on
  32     courseid: null,
  33     // Data about the different file/data handlers that are available
  34     handlers: null,
  35     // Nasty hack to distinguish between dragenter(first entry),
  36     // dragenter+dragleave(moving between child elements) and dragleave (leaving element)
  37     entercount: 0,
  38     // Used to keep track of the section we are dragging across - to make
  39     // spotting movement between sections more reliable
  40     currentsection: null,
  41     // Used to store the pending uploads whilst the user is being asked for further input
  42     uploadqueue: null,
  43     // True if the there is currently a dialog being shown (asking for a name, or giving a
  44     // choice of file handlers)
  45     uploaddialog: false,
  46     // An array containing the last selected file handler for each file type
  47     lastselected: null,
  48
  49     // The following are used to identify specific parts of the course page
  50
  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',
  60
  61     /**
  62      * Initalise the drag and drop upload interface
  63      * Note: one and only one of options.filemanager and options.formcallback must be defined
  64      *
  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
  70      *          }
  71      */
  72     init: function(Y, options) {
  73         this.Y = Y;
  74
  75         if (!this.browser_supported()) {
  76             return; // Browser does not support the required functionality
  77         }
  78
  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();
  84
  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.
  89         }
  90         sections.each( function(el) {
  91             this.add_preview_element(el);
  92             this.init_events(el);
  93         }, this);
  94
  95         if (options.showstatus) {
  96             this.add_status_div();
  97         }
  98     },
  99
 100     /**
 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)
 103      */
 104     add_status_div: function() {
 105         var coursecontents = document.getElementById(this.pagecontentid);
 106         if (!coursecontents) {
 107             return;
 108         }
 109
 110         var div = document.createElement('div');
 111         div.id = 'dndupload-status';
 112         div.style.opacity = 0.0;
 113         coursecontents.insertBefore(div, coursecontents.firstChild);
 114
 115         var Y = this.Y;
 116         div = Y.one(div);
 117         var handlefile = (this.handlers.filehandlers.length > 0);
 118         var handletext = false;
 119         var handlelink = false;
 120         var i;
 121         for (i=0; i<this.handlers.types.length; i++) {
 122             switch (this.handlers.types[i].identifier) {
 123             case 'text':
 124             case 'text/html':
 125                 handletext = true;
 126                 break;
 127             case 'url':
 128                 handlelink = true;
 129                 break;
 130             }
 131         }
 132         $msgident = 'dndworking';
 133         if (handlefile) {
 134             $msgident += 'file';
 135         }
 136         if (handletext) {
 137             $msgident += 'text';
 138         }
 139         if (handlelink) {
 140             $msgident += 'link';
 141         }
 142         div.setContent(M.util.get_string($msgident, 'moodle'));
 143
 144         var fadeanim = new Y.Anim({
 145             node: '#dndupload-status',
 146             from: {
 147                 opacity: 0.0,
 148                 top: '-30px'
 149             },
 150
 151             to: {
 152                 opacity: 1.0,
 153                 top: '0px'
 154             },
 155             duration: 0.5
 156         });
 157         fadeanim.once('end', function(e) {
 158             this.set('reverse', 1);
 159             Y.later(3000, this, 'run', null, false);
 160         });
 161         fadeanim.run();
 162     },
 163
 164     /**
 165      * Check the browser has the required functionality
 166      * @return true if browser supports drag/drop upload
 167      */
 168     browser_supported: function() {
 169         if (typeof FileReader == 'undefined') {
 170             return false;
 171         }
 172         if (typeof FormData == 'undefined') {
 173             return false;
 174         }
 175         return true;
 176     },
 177
 178     /**
 179      * Initialise drag events on node container, all events need
 180      * to be processed for drag and drop to work
 181      * @param el the element to add events to
 182      */
 183     init_events: function(el) {
 184         this.Y.on('dragenter', this.drag_enter, el, this);
 185         this.Y.on('dragleave', this.drag_leave, el, this);
 186         this.Y.on('dragover',  this.drag_over,  el, this);
 187         this.Y.on('drop',      this.drop,       el, this);
 188     },
 189
 190     /**
 191      * Work out which course section a given element is in
 192      * @param el the child DOM element within the section
 193      * @return the DOM element representing the section
 194      */
 195     get_section: function(el) {
 196         var sectionclasses = this.sectionclasses;
 197         return el.ancestor( function(test) {
 198             var i;
 199             for (i=0; i<sectionclasses.length; i++) {
 200                 if (!test.hasClass(sectionclasses[i])) {
 201                     return false;
 202                 }
 203                 return true;
 204             }
 205         }, true);
 206     },
 207
 208     /**
 209      * Work out the number of the section we have been dropped on to, from the section element
 210      * @param DOMElement section the selected section
 211      * @return int the section number
 212      */
 213     get_section_number: function(section) {
 214         var sectionid = section.get('id').split('-');
 215         if (sectionid.length < 2 || sectionid[0] != 'section') {
 216             return false;
 217         }
 218         return parseInt(sectionid[1]);
 219     },
 220
 221     /**
 222      * Check if the event includes data of the given type
 223      * @param e the event details
 224      * @param type the data type to check for
 225      * @return true if the data type is found in the event data
 226      */
 227     types_includes: function(e, type) {
 228         var i;
 229         var types = e._event.dataTransfer.types;
 230         for (i=0; i<types.length; i++) {
 231             if (types[i] == type) {
 232                 return true;
 233             }
 234         }
 235         return false;
 236     },
 237
 238     /**
 239      * Look through the event data, checking it against the registered data types
 240      * (in order of priority) and return details of the first matching data type
 241      * @param e the event details
 242      * @return object|false - false if not found or an object {
 243      *           realtype: the type as given by the browser
 244      *           addmessage: the message to show to the user during dragging
 245      *           namemessage: the message for requesting a name for the resource from the user
 246      *           type: the identifier of the type (may match several 'realtype's)
 247      *           }
 248      */
 249     drag_type: function(e) {
 250         // Check there is some data attached.
 251         if (e._event.dataTransfer === null) {
 252             return false;
 253         }
 254         if (e._event.dataTransfer.types === null) {
 255             return false;
 256         }
 257         if (e._event.dataTransfer.types.length == 0) {
 258             return false;
 259         }
 260
 261         // Check for files first.
 262         if (this.types_includes(e, 'Files')) {
 263             if (e.type != 'drop' || e._event.dataTransfer.files.length != 0) {
 264                 if (this.handlers.filehandlers.length == 0) {
 265                     return false; // No available file handlers - ignore this drag.
 266                 }
 267                 return {
 268                     realtype: 'Files',
 269                     addmessage: M.util.get_string('addfilehere', 'moodle'),
 270                     namemessage: null, // Should not be asked for anyway
 271                     type: 'Files'
 272                 };
 273             }
 274         }
 275
 276         // Check each of the registered types.
 277         var types = this.handlers.types;
 278         for (var i=0; i<types.length; i++) {
 279             // Check each of the different identifiers for this type
 280             var dttypes = types[i].datatransfertypes;
 281             for (var j=0; j<dttypes.length; j++) {
 282                 if (this.types_includes(e, dttypes[j])) {
 283                     return {
 284                         realtype: dttypes[j],
 285                         addmessage: types[i].addmessage,
 286                         namemessage: types[i].namemessage,
 287                         handlermessage: types[i].handlermessage,
 288                         type: types[i].identifier,
 289                         handlers: types[i].handlers
 290                     };
 291                 }
 292             }
 293         }
 294         return false; // No types we can handle
 295     },
 296
 297     /**
 298      * Check the content of the drag/drop includes a type we can handle, then, if
 299      * it is, notify the browser that we want to handle it
 300      * @param event e
 301      * @return string type of the event or false
 302      */
 303     check_drag: function(e) {
 304         var type = this.drag_type(e);
 305         if (type) {
 306             // Notify browser that we will handle this drag/drop
 307             e.stopPropagation();
 308             e.preventDefault();
 309         }
 310         return type;
 311     },
 312
 313     /**
 314      * Handle a dragenter event: add a suitable 'add here' message
 315      * when a drag event occurs, containing a registered data type
 316      * @param e event data
 317      * @return false to prevent the event from continuing to be processed
 318      */
 319     drag_enter: function(e) {
 320         if (!(type = this.check_drag(e))) {
 321             return false;
 322         }
 323
 324         var section = this.get_section(e.currentTarget);
 325         if (!section) {
 326             return false;
 327         }
 328
 329         if (this.currentsection && this.currentsection != section) {
 330             this.currentsection = section;
 331             this.entercount = 1;
 332         } else {
 333             this.entercount++;
 334             if (this.entercount > 2) {
 335                 this.entercount = 2;
 336                 return false;
 337             }
 338         }
 339
 340         this.show_preview_element(section, type);
 341
 342         return false;
 343     },
 344
 345     /**
 346      * Handle a dragleave event: remove the 'add here' message (if present)
 347      * @param e event data
 348      * @return false to prevent the event from continuing to be processed
 349      */
 350     drag_leave: function(e) {
 351         if (!this.check_drag(e)) {
 352             return false;
 353         }
 354
 355         this.entercount--;
 356         if (this.entercount == 1) {
 357             return false;
 358         }
 359         this.entercount = 0;
 360         this.currentsection = null;
 361
 362         this.hide_preview_element();
 363         return false;
 364     },
 365
 366     /**
 367      * Handle a dragover event: just prevent the browser default (necessary
 368      * to allow drag and drop handling to work)
 369      * @param e event data
 370      * @return false to prevent the event from continuing to be processed
 371      */
 372     drag_over: function(e) {
 373         this.check_drag(e);
 374         return false;
 375     },
 376
 377     /**
 378      * Handle a drop event: hide the 'add here' message, check the attached
 379      * data type and start the upload process
 380      * @param e event data
 381      * @return false to prevent the event from continuing to be processed
 382      */
 383     drop: function(e) {
 384         if (!(type = this.check_drag(e))) {
 385             return false;
 386         }
 387
 388         this.hide_preview_element();
 389
 390         // Work out the number of the section we are on (from its id)
 391         var section = this.get_section(e.currentTarget);
 392         var sectionnumber = this.get_section_number(section);
 393
 394         // Process the file or the included data
 395         if (type.type == 'Files') {
 396             var files = e._event.dataTransfer.files;
 397             for (var i=0, f; f=files[i]; i++) {
 398                 this.handle_file(f, section, sectionnumber);
 399             }
 400         } else {
 401             var contents = e._event.dataTransfer.getData(type.realtype);
 402             if (contents) {
 403                 this.handle_item(type, contents, section, sectionnumber);
 404             }
 405         }
 406
 407         return false;
 408     },
 409
 410     /**
 411      * Find or create the 'ul' element that contains all of the module
 412      * instances in this section
 413      * @param section the DOM element representing the section
 414      * @return false to prevent the event from continuing to be processed
 415      */
 416     get_mods_element: function(section) {
 417         // Find the 'ul' containing the list of mods
 418         var modsel = section.one(this.modslistselector);
 419         if (!modsel) {
 420             // Create the above 'ul' if it doesn't exist
 421             modsel = document.createElement('ul');
 422             modsel.className = 'section img-text';
 423             var contentel = section.get('children').pop();
 424             var brel = contentel.get('children').pop();
 425             contentel.insertBefore(modsel, brel);
 426             modsel = this.Y.one(modsel);
 427         }
 428
 429         return modsel;
 430     },
 431
 432     /**
 433      * Add a new dummy item to the list of mods, to be replaced by a real
 434      * item & link once the AJAX upload call has completed
 435      * @param name the label to show in the element
 436      * @param section the DOM element reperesenting the course section
 437      * @return DOM element containing the new item
 438      */
 439     add_resource_element: function(name, section, module) {
 440         var modsel = this.get_mods_element(section);
 441
 442         var resel = {
 443             parent: modsel,
 444             li: document.createElement('li'),
 445             div: document.createElement('div'),
 446             indentdiv: document.createElement('div'),
 447             a: document.createElement('a'),
 448             icon: document.createElement('img'),
 449             namespan: document.createElement('span'),
 450             groupingspan: document.createElement('span'),
 451             progressouter: document.createElement('span'),
 452             progress: document.createElement('span')
 453         };
 454
 455         resel.li.className = 'activity ' + module + ' modtype_' + module;
 456
 457         resel.indentdiv.className = 'mod-indent';
 458         resel.li.appendChild(resel.indentdiv);
 459
 460         resel.div.className = 'activityinstance';
 461         resel.indentdiv.appendChild(resel.div);
 462
 463         resel.a.href = '#';
 464         resel.div.appendChild(resel.a);
 465
 466         resel.icon.src = M.util.image_url('i/ajaxloader');
 467         resel.icon.className = 'activityicon iconlarge';
 468         resel.a.appendChild(resel.icon);
 469
 470         resel.namespan.className = 'instancename';
 471         resel.namespan.innerHTML = name;
 472         resel.a.appendChild(resel.namespan);
 473
 474         resel.groupingspan.className = 'groupinglabel';
 475         resel.div.appendChild(resel.groupingspan);
 476
 477         resel.progressouter.className = 'dndupload-progress-outer';
 478         resel.progress.className = 'dndupload-progress-inner';
 479         resel.progress.innerHTML = '&nbsp;';
 480         resel.progressouter.appendChild(resel.progress);
 481         resel.div.appendChild(resel.progressouter);
 482
 483         modsel.insertBefore(resel.li, modsel.get('children').pop()); // Leave the 'preview element' at the bottom
 484
 485         return resel;
 486     },
 487
 488     /**
 489      * Hide any visible dndupload-preview elements on the page
 490      */
 491     hide_preview_element: function() {
 492         this.Y.all('li.dndupload-preview').addClass('dndupload-hidden');
 493         this.Y.all('.dndupload-over').removeClass('dndupload-over');
 494     },
 495
 496     /**
 497      * Unhide the preview element for the given section and set it to display
 498      * the correct message
 499      * @param section the YUI node representing the selected course section
 500      * @param type the details of the data type detected in the drag (including the message to display)
 501      */
 502     show_preview_element: function(section, type) {
 503         this.hide_preview_element();
 504         var preview = section.one('li.dndupload-preview').removeClass('dndupload-hidden');
 505         section.addClass('dndupload-over');
 506
 507         // Horrible work-around to allow the 'Add X here' text to be a drop target in Firefox.
 508         var node = preview.one('span').getDOMNode();
 509         node.firstChild.nodeValue = type.addmessage;
 510     },
 511
 512     /**
 513      * Add the preview element to a course section. Note: this needs to be done before 'addEventListener'
 514      * is called, otherwise Firefox will ignore events generated when the mouse is over the preview
 515      * element (instead of passing them up to the parent element)
 516      * @param section the YUI node representing the selected course section
 517      */
 518     add_preview_element: function(section) {
 519         var modsel = this.get_mods_element(section);
 520         var preview = {
 521             li: document.createElement('li'),
 522             div: document.createElement('div'),
 523             icon: document.createElement('img'),
 524             namespan: document.createElement('span')
 525         };
 526
 527         preview.li.className = 'dndupload-preview dndupload-hidden';
 528
 529         preview.div.className = 'mod-indent';
 530         preview.li.appendChild(preview.div);
 531
 532         preview.icon.src = M.util.image_url('t/addfile');
 533         preview.icon.className = 'icon';
 534         preview.div.appendChild(preview.icon);
 535
 536         preview.div.appendChild(document.createTextNode(' '));
 537
 538         preview.namespan.className = 'instancename';
 539         preview.namespan.innerHTML = M.util.get_string('addfilehere', 'moodle');
 540         preview.div.appendChild(preview.namespan);
 541
 542         modsel.appendChild(preview.li);
 543     },
 544
 545     /**
 546      * Find the registered handler for the given file type. If there is more than one, ask the
 547      * user which one to use. Then upload the file to the server
 548      * @param file the details of the file, taken from the FileList in the drop event
 549      * @param section the DOM element representing the selected course section
 550      * @param sectionnumber the number of the selected course section
 551      */
 552     handle_file: function(file, section, sectionnumber) {
 553         var handlers = new Array();
 554         var filehandlers = this.handlers.filehandlers;
 555         var extension = '';
 556         var dotpos = file.name.lastIndexOf('.');
 557         if (dotpos != -1) {
 558             extension = file.name.substr(dotpos+1, file.name.length).toLowerCase();
 559         }
 560
 561         for (var i=0; i<filehandlers.length; i++) {
 562             if (filehandlers[i].extension == '*' || filehandlers[i].extension == extension) {
 563                 handlers.push(filehandlers[i]);
 564             }
 565         }
 566
 567         if (handlers.length == 0) {
 568             // No handlers at all (not even 'resource'?)
 569             return;
 570         }
 571
 572         if (handlers.length == 1) {
 573             this.upload_file(file, section, sectionnumber, handlers[0].module);
 574             return;
 575         }
 576
 577         this.file_handler_dialog(handlers, extension, file, section, sectionnumber);
 578     },
 579
 580     /**
 581      * Show a dialog box, allowing the user to choose what to do with the file they are uploading
 582      * @param handlers the available handlers to choose between
 583      * @param extension the extension of the file being uploaded
 584      * @param file the File object being uploaded
 585      * @param section the DOM element of the section being uploaded to
 586      * @param sectionnumber the number of the selected course section
 587      */
 588     file_handler_dialog: function(handlers, extension, file, section, sectionnumber) {
 589         if (this.uploaddialog) {
 590             var details = new Object();
 591             details.isfile = true;
 592             details.handlers = handlers;
 593             details.extension = extension;
 594             details.file = file;
 595             details.section = section;
 596             details.sectionnumber = sectionnumber;
 597             this.uploadqueue.push(details);
 598             return;
 599         }
 600         this.uploaddialog = true;
 601
 602         var timestamp = new Date().getTime();
 603         var uploadid = Math.round(Math.random()*100000)+'-'+timestamp;
 604         var content = '';
 605         var sel;
 606         if (extension in this.lastselected) {
 607             sel = this.lastselected[extension];
 608         } else {
 609             sel = handlers[0].module;
 610         }
 611         content += '<p>'+M.util.get_string('actionchoice', 'moodle', file.name)+'</p>';
 612         content += '<div id="dndupload_handlers'+uploadid+'">';
 613         for (var i=0; i<handlers.length; i++) {
 614             var id = 'dndupload_handler'+uploadid+handlers[i].module;
 615             var checked = (handlers[i].module == sel) ? 'checked="checked" ' : '';
 616             content += '<input type="radio" name="handler" value="'+handlers[i].module+'" id="'+id+'" '+checked+'/>';
 617             content += ' <label for="'+id+'">';
 618             content += handlers[i].message;
 619             content += '</label><br/>';
 620         }
 621         content += '</div>';
 622
 623         var Y = this.Y;
 624         var self = this;
 625         var panel = new M.core.dialogue({
 626             bodyContent: content,
 627             width: '350px',
 628             modal: true,
 629             visible: true,
 630             render: true,
 631             align: {
 632                 node: null,
 633                 points: [Y.WidgetPositionAlign.CC, Y.WidgetPositionAlign.CC]
 634             }
 635         });
 636         // When the panel is hidden - destroy it and then check for other pending uploads
 637         panel.after("visibleChange", function(e) {
 638             if (!panel.get('visible')) {
 639                 panel.destroy(true);
 640                 self.check_upload_queue();
 641             }
 642         });
 643
 644         // Add the submit/cancel buttons to the bottom of the dialog.
 645         panel.addButton({
 646             label: M.util.get_string('upload', 'moodle'),
 647             action: function(e) {
 648                 e.preventDefault();
 649                 // Find out which module was selected
 650                 var module = false;
 651                 var div = Y.one('#dndupload_handlers'+uploadid);
 652                 div.all('input').each(function(input) {
 653                     if (input.get('checked')) {
 654                         module = input.get('value');
 655                     }
 656                 });
 657                 if (!module) {
 658                     return;
 659                 }
 660                 panel.hide();
 661                 // Remember this selection for next time
 662                 self.lastselected[extension] = module;
 663                 // Do the upload
 664                 self.upload_file(file, section, sectionnumber, module);
 665             },
 666             section: Y.WidgetStdMod.FOOTER
 667         });
 668         panel.addButton({
 669             label: M.util.get_string('cancel', 'moodle'),
 670             action: function(e) {
 671                 e.preventDefault();
 672                 panel.hide();
 673             },
 674             section: Y.WidgetStdMod.FOOTER
 675         });
 676     },
 677
 678     /**
 679      * Check to see if there are any other dialog boxes to show, now that the current one has
 680      * been dealt with
 681      */
 682     check_upload_queue: function() {
 683         this.uploaddialog = false;
 684         if (this.uploadqueue.length == 0) {
 685             return;
 686         }
 687
 688         var details = this.uploadqueue.shift();
 689         if (details.isfile) {
 690             this.file_handler_dialog(details.handlers, details.extension, details.file, details.section, details.sectionnumber);
 691         } else {
 692             this.handle_item(details.type, details.contents, details.section, details.sectionnumber);
 693         }
 694     },
 695
 696     /**
 697      * Do the file upload: show the dummy element, use an AJAX call to send the data
 698      * to the server, update the progress bar for the file, then replace the dummy
 699      * element with the real information once the AJAX call completes
 700      * @param file the details of the file, taken from the FileList in the drop event
 701      * @param section the DOM element representing the selected course section
 702      * @param sectionnumber the number of the selected course section
 703      */
 704     upload_file: function(file, section, sectionnumber, module) {
 705
 706         // This would be an ideal place to use the Y.io function
 707         // however, this does not support data encoded using the
 708         // FormData object, which is needed to transfer data from
 709         // the DataTransfer object into an XMLHTTPRequest
 710         // This can be converted when the YUI issue has been integrated:
 711         // http://yuilibrary.com/projects/yui3/ticket/2531274
 712         var xhr = new XMLHttpRequest();
 713         var self = this;
 714
 715         if (file.size > this.maxbytes) {
 716             alert("'"+file.name+"' "+M.util.get_string('filetoolarge', 'moodle'));
 717             return;
 718         }
 719
 720         // Add the file to the display
 721         var resel = this.add_resource_element(file.name, section, module);
 722
 723         // Update the progress bar as the file is uploaded
 724         xhr.upload.addEventListener('progress', function(e) {
 725             if (e.lengthComputable) {
 726                 var percentage = Math.round((e.loaded * 100) / e.total);
 727                 resel.progress.style.width = percentage + '%';
 728             }
 729         }, false);
 730
 731         // Wait for the AJAX call to complete, then update the
 732         // dummy element with the returned details
 733         xhr.onreadystatechange = function() {
 734             if (xhr.readyState == 4) {
 735                 if (xhr.status == 200) {
 736                     var result = JSON.parse(xhr.responseText);
 737                     if (result) {
 738                         if (result.error == 0) {
 739                             // All OK - update the dummy element
 740                             if (result.content) {
 741                                 // A label
 742                                 resel.indentdiv.innerHTML = '<div class="activityinstance" ></div>' + result.content + result.commands;
 743                             } else {
 744                                 // Not a label
 745                                 resel.icon.src = result.icon;
 746                                 resel.a.href = result.link;
 747                                 resel.namespan.innerHTML = result.name;
 748
 749                                 if (!parseInt(result.visible, 10)) {
 750                                     resel.a.className = 'dimmed';
 751                                 }
 752
 753                                 if (result.groupingname) {
 754                                     resel.groupingspan.innerHTML = '(' + result.groupingname + ')';
 755                                 } else {
 756                                     resel.div.removeChild(resel.groupingspan);
 757                                 }
 758
 759                                 resel.div.removeChild(resel.progressouter);
 760                                 resel.indentdiv.innerHTML += result.commands;
 761                                 if (result.onclick) {
 762                                     resel.a.onclick = result.onclick;
 763                                 }
 764                                 if (self.Y.UA.gecko > 0) {
 765                                     // Fix a Firefox bug which makes sites with a '~' in their wwwroot
 766                                     // log the user out when clicking on the link (before refreshing the page).
 767                                     resel.div.innerHTML = unescape(resel.div.innerHTML);
 768                                 }
 769                             }
 770                             resel.li.id = result.elementid;
 771                             self.add_editing(result.elementid);
 772                         } else {
 773                             // Error - remove the dummy element
 774                             resel.parent.removeChild(resel.li);
 775                             alert(result.error);
 776                         }
 777                     }
 778                 } else {
 779                     alert(M.util.get_string('servererror', 'moodle'));
 780                 }
 781             }
 782         };
 783
 784         // Prepare the data to send
 785         var formData = new FormData();
 786         formData.append('repo_upload_file', file);
 787         formData.append('sesskey', M.cfg.sesskey);
 788         formData.append('course', this.courseid);
 789         formData.append('section', sectionnumber);
 790         formData.append('module', module);
 791         formData.append('type', 'Files');
 792
 793         // Send the AJAX call
 794         xhr.open("POST", this.url, true);
 795         xhr.send(formData);
 796     },
 797
 798     /**
 799      * Show a dialog box to gather the name of the resource / activity to be created
 800      * from the uploaded content
 801      * @param type the details of the type of content
 802      * @param contents the contents to be uploaded
 803      * @section the DOM element for the section being uploaded to
 804      * @sectionnumber the number of the section being uploaded to
 805      */
 806     handle_item: function(type, contents, section, sectionnumber) {
 807         if (type.handlers.length == 0) {
 808             // Nothing to handle this - should not have got here
 809             return;
 810         }
 811
 812         if (type.handlers.length == 1 && type.handlers[0].noname) {
 813             // Only one handler and it doesn't need a name (i.e. a label).
 814             this.upload_item('', type.type, contents, section, sectionnumber, type.handlers[0].module);
 815             this.check_upload_queue();
 816             return;
 817         }
 818
 819         if (this.uploaddialog) {
 820             var details = new Object();
 821             details.isfile = false;
 822             details.type = type;
 823             details.contents = contents;
 824             details.section = section;
 825             details.setcionnumber = sectionnumber;
 826             this.uploadqueue.push(details);
 827             return;
 828         }
 829         this.uploaddialog = true;
 830
 831         var timestamp = new Date().getTime();
 832         var uploadid = Math.round(Math.random()*100000)+'-'+timestamp;
 833         var nameid = 'dndupload_handler_name'+uploadid;
 834         var content = '';
 835         if (type.handlers.length > 1) {
 836             content += '<p>'+type.handlermessage+'</p>';
 837             content += '<div id="dndupload_handlers'+uploadid+'">';
 838             var sel = type.handlers[0].module;
 839             for (var i=0; i<type.handlers.length; i++) {
 840                 var id = 'dndupload_handler'+uploadid+type.handlers[i].module;
 841                 var checked = (type.handlers[i].module == sel) ? 'checked="checked" ' : '';
 842                 content += '<input type="radio" name="handler" value="'+i+'" id="'+id+'" '+checked+'/>';
 843                 content += ' <label for="'+id+'">';
 844                 content += type.handlers[i].message;
 845                 content += '</label><br/>';
 846             }
 847             content += '</div>';
 848         }
 849         var disabled = (type.handlers[0].noname) ? ' disabled = "disabled" ' : '';
 850         content += '<label for="'+nameid+'">'+type.namemessage+'</label>';
 851         content += ' <input type="text" id="'+nameid+'" value="" '+disabled+' />';
 852
 853         var Y = this.Y;
 854         var self = this;
 855         var panel = new M.core.dialogue({
 856             bodyContent: content,
 857             width: '350px',
 858             modal: true,
 859             visible: true,
 860             render: true,
 861             align: {
 862                 node: null,
 863                 points: [Y.WidgetPositionAlign.CC, Y.WidgetPositionAlign.CC]
 864             }
 865         });
 866
 867         // When the panel is hidden - destroy it and then check for other pending uploads
 868         panel.after("visibleChange", function(e) {
 869             if (!panel.get('visible')) {
 870                 panel.destroy(true);
 871                 self.check_upload_queue();
 872             }
 873         });
 874
 875         var namefield = Y.one('#'+nameid);
 876         var submit = function(e) {
 877             e.preventDefault();
 878             var name = Y.Lang.trim(namefield.get('value'));
 879             var module = false;
 880             var noname = false;
 881             if (type.handlers.length > 1) {
 882                 // Find out which module was selected
 883                 var div = Y.one('#dndupload_handlers'+uploadid);
 884                 div.all('input').each(function(input) {
 885                     if (input.get('checked')) {
 886                         var idx = input.get('value');
 887                         module = type.handlers[idx].module;
 888                         noname = type.handlers[idx].noname;
 889                     }
 890                 });
 891                 if (!module) {
 892                     return;
 893                 }
 894             } else {
 895                 module = type.handlers[0].module;
 896                 noname = type.handlers[0].noname;
 897             }
 898             if (name == '' && !noname) {
 899                 return;
 900             }
 901             if (noname) {
 902                 name = '';
 903             }
 904             panel.hide();
 905             // Do the upload
 906             self.upload_item(name, type.type, contents, section, sectionnumber, module);
 907         };
 908
 909         // Add the submit/cancel buttons to the bottom of the dialog.
 910         panel.addButton({
 911             label: M.util.get_string('upload', 'moodle'),
 912             action: submit,
 913             section: Y.WidgetStdMod.FOOTER,
 914             name: 'submit'
 915         });
 916         panel.addButton({
 917             label: M.util.get_string('cancel', 'moodle'),
 918             action: function(e) {
 919                 e.preventDefault();
 920                 panel.hide();
 921             },
 922             section: Y.WidgetStdMod.FOOTER
 923         });
 924         var submitbutton = panel.getButton('submit').button;
 925         namefield.on('key', submit, 'enter'); // Submit the form if 'enter' pressed
 926         namefield.after('keyup', function() {
 927             if (Y.Lang.trim(namefield.get('value')) == '') {
 928                 submitbutton.disable();
 929             } else {
 930                 submitbutton.enable();
 931             }
 932         });
 933
 934         // Enable / disable the 'name' box, depending on the handler selected.
 935         for (i=0; i<type.handlers.length; i++) {
 936             if (type.handlers[i].noname) {
 937                 Y.one('#dndupload_handler'+uploadid+type.handlers[i].module).on('click', function (e) {
 938                     namefield.set('disabled', 'disabled');
 939                     submitbutton.enable();
 940                 });
 941             } else {
 942                 Y.one('#dndupload_handler'+uploadid+type.handlers[i].module).on('click', function (e) {
 943                     namefield.removeAttribute('disabled');
 944                     namefield.focus();
 945                     if (Y.Lang.trim(namefield.get('value')) == '') {
 946                         submitbutton.disable();
 947                     }
 948                 });
 949             }
 950         }
 951
 952         // Focus on the 'name' box
 953         Y.one('#'+nameid).focus();
 954     },
 955
 956     /**
 957      * Upload any data types that are not files: display a dummy resource element, send
 958      * the data to the server, update the progress bar for the file, then replace the
 959      * dummy element with the real information once the AJAX call completes
 960      * @param name the display name for the resource / activity to create
 961      * @param type the details of the data type found in the drop event
 962      * @param contents the actual data that was dropped
 963      * @param section the DOM element representing the selected course section
 964      * @param sectionnumber the number of the selected course section
 965      * @param module the module chosen to handle this upload
 966      */
 967     upload_item: function(name, type, contents, section, sectionnumber, module) {
 968
 969         // This would be an ideal place to use the Y.io function
 970         // however, this does not support data encoded using the
 971         // FormData object, which is needed to transfer data from
 972         // the DataTransfer object into an XMLHTTPRequest
 973         // This can be converted when the YUI issue has been integrated:
 974         // http://yuilibrary.com/projects/yui3/ticket/2531274
 975         var xhr = new XMLHttpRequest();
 976         var self = this;
 977
 978         // Add the item to the display
 979         var resel = this.add_resource_element(name, section, module);
 980
 981         // Wait for the AJAX call to complete, then update the
 982         // dummy element with the returned details
 983         xhr.onreadystatechange = function() {
 984             if (xhr.readyState == 4) {
 985                 if (xhr.status == 200) {
 986                     var result = JSON.parse(xhr.responseText);
 987                     if (result) {
 988                         if (result.error == 0) {
 989                             // All OK - update the dummy element
 990                             if (result.content) {
 991                                 // A label
 992                                 resel.indentdiv.innerHTML = '<div class="activityinstance" ></div>' + result.content + result.commands;
 993                             } else {
 994                                 // Not a label
 995                                 resel.icon.src = result.icon;
 996                                 resel.a.href = result.link;
 997                                 resel.namespan.innerHTML = result.name;
 998
 999                                 if (!parseInt(result.visible, 10)) {
1000                                     resel.a.className = 'dimmed';
1001                                 }
1002
1003                                 if (result.groupingname) {
1004                                     resel.groupingspan.innerHTML = '(' + result.groupingname + ')';
1005                                 } else {
1006                                     resel.div.removeChild(resel.groupingspan);
1007                                 }
1008
1009                                 resel.div.removeChild(resel.progressouter);
1010                                 resel.div.innerHTML += result.commands;
1011                                 if (result.onclick) {
1012                                     resel.a.onclick = result.onclick;
1013                                 }
1014                                 if (self.Y.UA.gecko > 0) {
1015                                     // Fix a Firefox bug which makes sites with a '~' in their wwwroot
1016                                     // log the user out when clicking on the link (before refreshing the page).
1017                                     resel.div.innerHTML = unescape(resel.div.innerHTML);
1018                                 }
1019                             }
1020                             resel.li.id = result.elementid;
1021                             self.add_editing(result.elementid, sectionnumber);
1022                         } else {
1023                             // Error - remove the dummy element
1024                             resel.parent.removeChild(resel.li);
1025                             alert(result.error);
1026                         }
1027                     }
1028                 } else {
1029                     alert(M.util.get_string('servererror', 'moodle'));
1030                 }
1031             }
1032         };
1033
1034         // Prepare the data to send
1035         var formData = new FormData();
1036         formData.append('contents', contents);
1037         formData.append('displayname', name);
1038         formData.append('sesskey', M.cfg.sesskey);
1039         formData.append('course', this.courseid);
1040         formData.append('section', sectionnumber);
1041         formData.append('type', type);
1042         formData.append('module', module);
1043
1044         // Send the data
1045         xhr.open("POST", this.url, true);
1046         xhr.send(formData);
1047     },
1048
1049     /**
1050      * Call the AJAX course editing initialisation to add the editing tools
1051      * to the newly-created resource link
1052      * @param elementid the id of the DOM element containing the new resource link
1053      * @param sectionnumber the number of the selected course section
1054      */
1055     add_editing: function(elementid) {
1056         YUI().use('moodle-course-coursebase', function(Y) {
1057             M.course.coursebase.invoke_function('setup_for_resource', '#' + elementid);
1058         });
1059     }
1060 };