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 mixed 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                         type: types[i].identifier,
 288                         handlers: types[i].handlers
 289                     };
 290                 }
 291             }
 292         }
 293         return false; // No types we can handle
 294     },
 295
 296     /**
 297      * Check the content of the drag/drop includes a type we can handle, then, if
 298      * it is, notify the browser that we want to handle it
 299      * @param event e
 300      * @return string type of the event or false
 301      */
 302     check_drag: function(e) {
 303         var type = this.drag_type(e);
 304         if (type) {
 305             // Notify browser that we will handle this drag/drop
 306             e.stopPropagation();
 307             e.preventDefault();
 308         }
 309         return type;
 310     },
 311
 312     /**
 313      * Handle a dragenter event: add a suitable 'add here' message
 314      * when a drag event occurs, containing a registered data type
 315      * @param e event data
 316      * @return false to prevent the event from continuing to be processed
 317      */
 318     drag_enter: function(e) {
 319         if (!(type = this.check_drag(e))) {
 320             return false;
 321         }
 322
 323         var section = this.get_section(e.currentTarget);
 324         if (!section) {
 325             return false;
 326         }
 327
 328         if (this.currentsection && this.currentsection != section) {
 329             this.currentsection = section;
 330             this.entercount = 1;
 331         } else {
 332             this.entercount++;
 333             if (this.entercount > 2) {
 334                 this.entercount = 2;
 335                 return false;
 336             }
 337         }
 338
 339         this.show_preview_element(section, type);
 340
 341         return false;
 342     },
 343
 344     /**
 345      * Handle a dragleave event: remove the 'add here' message (if present)
 346      * @param e event data
 347      * @return false to prevent the event from continuing to be processed
 348      */
 349     drag_leave: function(e) {
 350         if (!this.check_drag(e)) {
 351             return false;
 352         }
 353
 354         this.entercount--;
 355         if (this.entercount == 1) {
 356             return false;
 357         }
 358         this.entercount = 0;
 359         this.currentsection = null;
 360
 361         this.hide_preview_element();
 362         return false;
 363     },
 364
 365     /**
 366      * Handle a dragover event: just prevent the browser default (necessary
 367      * to allow drag and drop handling to work)
 368      * @param e event data
 369      * @return false to prevent the event from continuing to be processed
 370      */
 371     drag_over: function(e) {
 372         this.check_drag(e);
 373         return false;
 374     },
 375
 376     /**
 377      * Handle a drop event: hide the 'add here' message, check the attached
 378      * data type and start the upload process
 379      * @param e event data
 380      * @return false to prevent the event from continuing to be processed
 381      */
 382     drop: function(e) {
 383         if (!(type = this.check_drag(e))) {
 384             return false;
 385         }
 386
 387         this.hide_preview_element();
 388
 389         // Work out the number of the section we are on (from its id)
 390         var section = this.get_section(e.currentTarget);
 391         var sectionnumber = this.get_section_number(section);
 392
 393         // Process the file or the included data
 394         if (type.type == 'Files') {
 395             var files = e._event.dataTransfer.files;
 396             for (var i=0, f; f=files[i]; i++) {
 397                 this.handle_file(f, section, sectionnumber);
 398             }
 399         } else {
 400             var contents = e._event.dataTransfer.getData(type.realtype);
 401             if (contents) {
 402                 this.handle_item(type, contents, section, sectionnumber);
 403             }
 404         }
 405
 406         return false;
 407     },
 408
 409     /**
 410      * Find or create the 'ul' element that contains all of the module
 411      * instances in this section
 412      * @param section the DOM element representing the section
 413      * @return false to prevent the event from continuing to be processed
 414      */
 415     get_mods_element: function(section) {
 416         // Find the 'ul' containing the list of mods
 417         var modsel = section.one(this.modslistselector);
 418         if (!modsel) {
 419             // Create the above 'ul' if it doesn't exist
 420             var modsel = document.createElement('ul');
 421             modsel.className = 'section img-text';
 422             var contentel = section.get('children').pop();
 423             var brel = contentel.get('children').pop();
 424             contentel.insertBefore(modsel, brel);
 425             modsel = this.Y.one(modsel);
 426         }
 427
 428         return modsel;
 429     },
 430
 431     /**
 432      * Add a new dummy item to the list of mods, to be replaced by a real
 433      * item & link once the AJAX upload call has completed
 434      * @param name the label to show in the element
 435      * @param section the DOM element reperesenting the course section
 436      * @return DOM element containing the new item
 437      */
 438     add_resource_element: function(name, section) {
 439         var modsel = this.get_mods_element(section);
 440
 441         var resel = {
 442             parent: modsel,
 443             li: document.createElement('li'),
 444             div: document.createElement('div'),
 445             indentdiv: document.createElement('div'),
 446             a: document.createElement('a'),
 447             icon: document.createElement('img'),
 448             namespan: document.createElement('span'),
 449             groupingspan: document.createElement('span'),
 450             progressouter: document.createElement('span'),
 451             progress: document.createElement('span')
 452         };
 453
 454         resel.li.className = 'activity resource modtype_resource';
 455
 456         resel.indentdiv.className = 'mod-indent';
 457         resel.li.appendChild(resel.indentdiv);
 458
 459         resel.div.className = 'activityinstance';
 460         resel.indentdiv.appendChild(resel.div);
 461
 462         resel.a.href = '#';
 463         resel.div.appendChild(resel.a);
 464
 465         resel.icon.src = M.util.image_url('i/ajaxloader');
 466         resel.icon.className = 'activityicon iconlarge';
 467         resel.a.appendChild(resel.icon);
 468
 469         resel.namespan.className = 'instancename';
 470         resel.namespan.innerHTML = name;
 471         resel.a.appendChild(resel.namespan);
 472
 473         resel.groupingspan.className = 'groupinglabel';
 474         resel.div.appendChild(resel.groupingspan);
 475
 476         resel.progressouter.className = 'dndupload-progress-outer';
 477         resel.progress.className = 'dndupload-progress-inner';
 478         resel.progress.innerHTML = '&nbsp;';
 479         resel.progressouter.appendChild(resel.progress);
 480         resel.div.appendChild(resel.progressouter);
 481
 482         modsel.insertBefore(resel.li, modsel.get('children').pop()); // Leave the 'preview element' at the bottom
 483
 484         return resel;
 485     },
 486
 487     /**
 488      * Hide any visible dndupload-preview elements on the page
 489      */
 490     hide_preview_element: function() {
 491         this.Y.all('li.dndupload-preview').addClass('dndupload-hidden');
 492     },
 493
 494     /**
 495      * Unhide the preview element for the given section and set it to display
 496      * the correct message
 497      * @param section the YUI node representing the selected course section
 498      * @param type the details of the data type detected in the drag (including the message to display)
 499      */
 500     show_preview_element: function(section, type) {
 501         this.hide_preview_element();
 502         var preview = section.one('li.dndupload-preview').removeClass('dndupload-hidden');
 503         preview.one('span').setContent(type.addmessage);
 504     },
 505
 506     /**
 507      * Add the preview element to a course section. Note: this needs to be done before 'addEventListener'
 508      * is called, otherwise Firefox will ignore events generated when the mouse is over the preview
 509      * element (instead of passing them up to the parent element)
 510      * @param section the YUI node representing the selected course section
 511      */
 512     add_preview_element: function(section) {
 513         var modsel = this.get_mods_element(section);
 514         var preview = {
 515             li: document.createElement('li'),
 516             div: document.createElement('div'),
 517             icon: document.createElement('img'),
 518             namespan: document.createElement('span')
 519         };
 520
 521         preview.li.className = 'dndupload-preview dndupload-hidden';
 522
 523         preview.div.className = 'mod-indent';
 524         preview.li.appendChild(preview.div);
 525
 526         preview.icon.src = M.util.image_url('t/addfile');
 527         preview.icon.className = 'icon';
 528         preview.div.appendChild(preview.icon);
 529
 530         preview.div.appendChild(document.createTextNode(' '));
 531
 532         preview.namespan.className = 'instancename';
 533         preview.namespan.innerHTML = M.util.get_string('addfilehere', 'moodle');
 534         preview.div.appendChild(preview.namespan);
 535
 536         modsel.appendChild(preview.li);
 537     },
 538
 539     /**
 540      * Find the registered handler for the given file type. If there is more than one, ask the
 541      * user which one to use. Then upload the file to the server
 542      * @param file the details of the file, taken from the FileList in the drop event
 543      * @param section the DOM element representing the selected course section
 544      * @param sectionnumber the number of the selected course section
 545      */
 546     handle_file: function(file, section, sectionnumber) {
 547         var handlers = new Array();
 548         var filehandlers = this.handlers.filehandlers;
 549         var extension = '';
 550         var dotpos = file.name.lastIndexOf('.');
 551         if (dotpos != -1) {
 552             extension = file.name.substr(dotpos+1, file.name.length);
 553         }
 554
 555         for (var i=0; i<filehandlers.length; i++) {
 556             if (filehandlers[i].extension == '*' || filehandlers[i].extension == extension) {
 557                 handlers.push(filehandlers[i]);
 558             }
 559         }
 560
 561         if (handlers.length == 0) {
 562             // No handlers at all (not even 'resource'?)
 563             return;
 564         }
 565
 566         if (handlers.length == 1) {
 567             this.upload_file(file, section, sectionnumber, handlers[0].module);
 568             return;
 569         }
 570
 571         this.file_handler_dialog(handlers, extension, file, section, sectionnumber);
 572     },
 573
 574     /**
 575      * Show a dialog box, allowing the user to choose what to do with the file they are uploading
 576      * @param handlers the available handlers to choose between
 577      * @param extension the extension of the file being uploaded
 578      * @param file the File object being uploaded
 579      * @param section the DOM element of the section being uploaded to
 580      * @param sectionnumber the number of the selected course section
 581      */
 582     file_handler_dialog: function(handlers, extension, file, section, sectionnumber) {
 583         if (this.uploaddialog) {
 584             var details = new Object();
 585             details.isfile = true;
 586             details.handlers = handlers;
 587             details.extension = extension;
 588             details.file = file;
 589             details.section = section;
 590             details.sectionnumber = sectionnumber;
 591             this.uploadqueue.push(details);
 592             return;
 593         }
 594         this.uploaddialog = true;
 595
 596         var timestamp = new Date().getTime();
 597         var uploadid = Math.round(Math.random()*100000)+'-'+timestamp;
 598         var content = '';
 599         var sel;
 600         if (extension in this.lastselected) {
 601             sel = this.lastselected[extension];
 602         } else {
 603             sel = handlers[0].module;
 604         }
 605         content += '<p>'+M.util.get_string('actionchoice', 'moodle', file.name)+'</p>';
 606         content += '<div id="dndupload_handlers'+uploadid+'">';
 607         for (var i=0; i<handlers.length; i++) {
 608             var id = 'dndupload_handler'+uploadid+handlers[i].module;
 609             var checked = (handlers[i].module == sel) ? 'checked="checked" ' : '';
 610             content += '<input type="radio" name="handler" value="'+handlers[i].module+'" id="'+id+'" '+checked+'/>';
 611             content += ' <label for="'+id+'">';
 612             content += handlers[i].message;
 613             content += '</label><br/>';
 614         }
 615         content += '</div>';
 616
 617         var Y = this.Y;
 618         var self = this;
 619         var panel = new Y.Panel({
 620             bodyContent: content,
 621             width: 350,
 622             zIndex: 5,
 623             centered: true,
 624             modal: true,
 625             visible: true,
 626             render: true,
 627             buttons: [{
 628                 value: M.util.get_string('upload', 'moodle'),
 629                 action: function(e) {
 630                     e.preventDefault();
 631                     // Find out which module was selected
 632                     var module = false;
 633                     var div = Y.one('#dndupload_handlers'+uploadid);
 634                     div.all('input').each(function(input) {
 635                         if (input.get('checked')) {
 636                             module = input.get('value');
 637                         }
 638                     });
 639                     if (!module) {
 640                         return;
 641                     }
 642                     panel.hide();
 643                     // Remember this selection for next time
 644                     self.lastselected[extension] = module;
 645                     // Do the upload
 646                     self.upload_file(file, section, sectionnumber, module);
 647                 },
 648                 section: Y.WidgetStdMod.FOOTER
 649             },{
 650                 value: M.util.get_string('cancel', 'moodle'),
 651                 action: function(e) {
 652                     e.preventDefault();
 653                     panel.hide();
 654                 },
 655                 section: Y.WidgetStdMod.FOOTER
 656             }]
 657         });
 658         // When the panel is hidden - destroy it and then check for other pending uploads
 659         panel.after("visibleChange", function(e) {
 660             if (!panel.get('visible')) {
 661                 panel.destroy(true);
 662                 self.check_upload_queue();
 663             }
 664         });
 665     },
 666
 667     /**
 668      * Check to see if there are any other dialog boxes to show, now that the current one has
 669      * been dealt with
 670      */
 671     check_upload_queue: function() {
 672         this.uploaddialog = false;
 673         if (this.uploadqueue.length == 0) {
 674             return;
 675         }
 676
 677         var details = this.uploadqueue.shift();
 678         if (details.isfile) {
 679             this.file_handler_dialog(details.handlers, details.extension, details.file, details.section, details.sectionnumber);
 680         } else {
 681             this.handle_item(details.type, details.contents, details.section, details.sectionnumber);
 682         }
 683     },
 684
 685     /**
 686      * Do the file upload: show the dummy element, use an AJAX call to send the data
 687      * to the server, update the progress bar for the file, then replace the dummy
 688      * element with the real information once the AJAX call completes
 689      * @param file the details of the file, taken from the FileList in the drop event
 690      * @param section the DOM element representing the selected course section
 691      * @param sectionnumber the number of the selected course section
 692      */
 693     upload_file: function(file, section, sectionnumber, module) {
 694
 695         // This would be an ideal place to use the Y.io function
 696         // however, this does not support data encoded using the
 697         // FormData object, which is needed to transfer data from
 698         // the DataTransfer object into an XMLHTTPRequest
 699         // This can be converted when the YUI issue has been integrated:
 700         // http://yuilibrary.com/projects/yui3/ticket/2531274
 701         var xhr = new XMLHttpRequest();
 702         var self = this;
 703
 704         if (file.size > this.maxbytes) {
 705             alert("'"+file.name+"' "+M.util.get_string('filetoolarge', 'moodle'));
 706             return;
 707         }
 708
 709         // Add the file to the display
 710         var resel = this.add_resource_element(file.name, section);
 711
 712         // Update the progress bar as the file is uploaded
 713         xhr.upload.addEventListener('progress', function(e) {
 714             if (e.lengthComputable) {
 715                 var percentage = Math.round((e.loaded * 100) / e.total);
 716                 resel.progress.style.width = percentage + '%';
 717             }
 718         }, false);
 719
 720         // Wait for the AJAX call to complete, then update the
 721         // dummy element with the returned details
 722         xhr.onreadystatechange = function() {
 723             if (xhr.readyState == 4) {
 724                 if (xhr.status == 200) {
 725                     var result = JSON.parse(xhr.responseText);
 726                     if (result) {
 727                         if (result.error == 0) {
 728                             // All OK - update the dummy element
 729                             resel.icon.src = result.icon;
 730                             resel.a.href = result.link;
 731                             resel.namespan.innerHTML = result.name;
 732                             if (!parseInt(result.visible, 10)) {
 733                                 resel.a.className = 'dimmed';
 734                             }
 735
 736                             if (result.groupingname) {
 737                                 resel.groupingspan.innerHTML = '(' + result.groupingname + ')';
 738                             } else {
 739                                 resel.div.removeChild(resel.groupingspan);
 740                             }
 741
 742                             resel.div.removeChild(resel.progressouter);
 743                             resel.li.id = result.elementid;
 744                             resel.indentdiv.innerHTML += result.commands;
 745                             if (result.onclick) {
 746                                 resel.a.onclick = result.onclick;
 747                             }
 748                             if (self.Y.UA.gecko > 0) {
 749                                 // Fix a Firefox bug which makes sites with a '~' in their wwwroot
 750                                 // log the user out when clicking on the link (before refreshing the page).
 751                                 resel.div.innerHTML = unescape(resel.div.innerHTML);
 752                             }
 753                             self.add_editing(result.elementid);
 754                         } else {
 755                             // Error - remove the dummy element
 756                             resel.parent.removeChild(resel.li);
 757                             alert(result.error);
 758                         }
 759                     }
 760                 } else {
 761                     alert(M.util.get_string('servererror', 'moodle'));
 762                 }
 763             }
 764         };
 765
 766         // Prepare the data to send
 767         var formData = new FormData();
 768         formData.append('repo_upload_file', file);
 769         formData.append('sesskey', M.cfg.sesskey);
 770         formData.append('course', this.courseid);
 771         formData.append('section', sectionnumber);
 772         formData.append('module', module);
 773         formData.append('type', 'Files');
 774
 775         // Send the AJAX call
 776         xhr.open("POST", this.url, true);
 777         xhr.send(formData);
 778     },
 779
 780     /**
 781      * Show a dialog box to gather the name of the resource / activity to be created
 782      * from the uploaded content
 783      * @param type the details of the type of content
 784      * @param contents the contents to be uploaded
 785      * @section the DOM element for the section being uploaded to
 786      * @sectionnumber the number of the section being uploaded to
 787      */
 788     handle_item: function(type, contents, section, sectionnumber) {
 789         if (type.handlers.length == 0) {
 790             // Nothing to handle this - should not have got here
 791             return;
 792         }
 793
 794         if (this.uploaddialog) {
 795             var details = new Object();
 796             details.isfile = false;
 797             details.type = type;
 798             details.contents = contents;
 799             details.section = section;
 800             details.setcionnumber = sectionnumber;
 801             this.uploadqueue.push(details);
 802             return;
 803         }
 804         this.uploaddialog = true;
 805
 806         var timestamp = new Date().getTime();
 807         var uploadid = Math.round(Math.random()*100000)+'-'+timestamp;
 808         var nameid = 'dndupload_handler_name'+uploadid;
 809         var content = '';
 810         content += '<label for="'+nameid+'">'+type.namemessage+'</label>';
 811         content += ' <input type="text" id="'+nameid+'" value="" />';
 812         if (type.handlers.length > 1) {
 813             content += '<div id="dndupload_handlers'+uploadid+'">';
 814             var sel = type.handlers[0].module;
 815             for (var i=0; i<type.handlers.length; i++) {
 816                 var id = 'dndupload_handler'+uploadid;
 817                 var checked = (type.handlers[i].module == sel) ? 'checked="checked" ' : '';
 818                 content += '<input type="radio" name="handler" value="'+type.handlers[i].module+'" id="'+id+'" '+checked+'/>';
 819                 content += ' <label for="'+id+'">';
 820                 content += type.handlers[i].message;
 821                 content += '</label><br/>';
 822             }
 823             content += '</div>';
 824         }
 825
 826         var Y = this.Y;
 827         var self = this;
 828         var panel = new Y.Panel({
 829             bodyContent: content,
 830             width: 350,
 831             zIndex: 5,
 832             centered: true,
 833             modal: true,
 834             visible: true,
 835             render: true,
 836             buttons: [{
 837                 value: M.util.get_string('upload', 'moodle'),
 838                 action: function(e) {
 839                     e.preventDefault();
 840                     var name = Y.one('#dndupload_handler_name'+uploadid).get('value');
 841                     name = name.replace(/^\s\s*/, '').replace(/\s\s*$/, ''); // Trim
 842                     if (name == '') {
 843                         return;
 844                     }
 845                     var module = false;
 846                     if (type.handlers.length > 1) {
 847                         // Find out which module was selected
 848                         var div = Y.one('#dndupload_handlers'+uploadid);
 849                         div.all('input').each(function(input) {
 850                             if (input.get('checked')) {
 851                                 module = input.get('value');
 852                             }
 853                         });
 854                         if (!module) {
 855                             return;
 856                         }
 857                     } else {
 858                         module = type.handlers[0].module;
 859                     }
 860                     panel.hide();
 861                     // Do the upload
 862                     self.upload_item(name, type.type, contents, section, sectionnumber, module);
 863                 },
 864                 section: Y.WidgetStdMod.FOOTER
 865             },{
 866                 value: M.util.get_string('cancel', 'moodle'),
 867                 action: function(e) {
 868                     e.preventDefault();
 869                     panel.hide();
 870                 },
 871                 section: Y.WidgetStdMod.FOOTER
 872             }]
 873         });
 874         // When the panel is hidden - destroy it and then check for other pending uploads
 875         panel.after("visibleChange", function(e) {
 876             if (!panel.get('visible')) {
 877                 panel.destroy(true);
 878                 self.check_upload_queue();
 879             }
 880         });
 881         // Focus on the 'name' box
 882         Y.one('#'+nameid).focus();
 883     },
 884
 885     /**
 886      * Upload any data types that are not files: display a dummy resource element, send
 887      * the data to the server, update the progress bar for the file, then replace the
 888      * dummy element with the real information once the AJAX call completes
 889      * @param name the display name for the resource / activity to create
 890      * @param type the details of the data type found in the drop event
 891      * @param contents the actual data that was dropped
 892      * @param section the DOM element representing the selected course section
 893      * @param sectionnumber the number of the selected course section
 894      * @param module the module chosen to handle this upload
 895      */
 896     upload_item: function(name, type, contents, section, sectionnumber, module) {
 897
 898         // This would be an ideal place to use the Y.io function
 899         // however, this does not support data encoded using the
 900         // FormData object, which is needed to transfer data from
 901         // the DataTransfer object into an XMLHTTPRequest
 902         // This can be converted when the YUI issue has been integrated:
 903         // http://yuilibrary.com/projects/yui3/ticket/2531274
 904         var xhr = new XMLHttpRequest();
 905         var self = this;
 906
 907         // Add the item to the display
 908         var resel = this.add_resource_element(name, section);
 909
 910         // Wait for the AJAX call to complete, then update the
 911         // dummy element with the returned details
 912         xhr.onreadystatechange = function() {
 913             if (xhr.readyState == 4) {
 914                 if (xhr.status == 200) {
 915                     var result = JSON.parse(xhr.responseText);
 916                     if (result) {
 917                         if (result.error == 0) {
 918                             // All OK - update the dummy element
 919                             resel.icon.src = result.icon;
 920                             resel.a.href = result.link;
 921                             resel.namespan.innerHTML = result.name;
 922                             if (!parseInt(result.visible, 10)) {
 923                                 resel.a.className = 'dimmed';
 924                             }
 925
 926                             if (result.groupingname) {
 927                                 resel.groupingspan.innerHTML = '(' + result.groupingname + ')';
 928                             } else {
 929                                 resel.div.removeChild(resel.groupingspan);
 930                             }
 931
 932                             resel.div.removeChild(resel.progressouter);
 933                             resel.li.id = result.elementid;
 934                             resel.div.innerHTML += result.commands;
 935                             if (result.onclick) {
 936                                 resel.a.onclick = result.onclick;
 937                             }
 938                             if (self.Y.UA.gecko > 0) {
 939                                 // Fix a Firefox bug which makes sites with a '~' in their wwwroot
 940                                 // log the user out when clicking on the link (before refreshing the page).
 941                                 resel.div.innerHTML = unescape(resel.div.innerHTML);
 942                             }
 943                             self.add_editing(result.elementid, sectionnumber);
 944                         } else {
 945                             // Error - remove the dummy element
 946                             resel.parent.removeChild(resel.li);
 947                             alert(result.error);
 948                         }
 949                     }
 950                 } else {
 951                     alert(M.util.get_string('servererror', 'moodle'));
 952                 }
 953             }
 954         };
 955
 956         // Prepare the data to send
 957         var formData = new FormData();
 958         formData.append('contents', contents);
 959         formData.append('displayname', name);
 960         formData.append('sesskey', M.cfg.sesskey);
 961         formData.append('course', this.courseid);
 962         formData.append('section', sectionnumber);
 963         formData.append('type', type);
 964         formData.append('module', module);
 965
 966         // Send the data
 967         xhr.open("POST", this.url, true);
 968         xhr.send(formData);
 969     },
 970
 971     /**
 972      * Call the AJAX course editing initialisation to add the editing tools
 973      * to the newly-created resource link
 974      * @param elementid the id of the DOM element containing the new resource link
 975      * @param sectionnumber the number of the selected course section
 976      */
 977     add_editing: function(elementid) {
 978         YUI().use('moodle-course-coursebase', function(Y) {
 979             M.course.coursebase.invoke_function('setup_for_resource', '#' + elementid);
 980         });
 981     }
 982 };