MDL-38378 Take rid of harcoded db prefix and bump.
[moodle.git] / course / dnduploadlib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Library to handle drag and drop course uploads
19  *
20  * @package    core
21  * @subpackage lib
22  * @copyright  2012 Davo smith
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 require_once($CFG->dirroot.'/repository/lib.php');
29 require_once($CFG->dirroot.'/repository/upload/lib.php');
30 require_once($CFG->dirroot.'/course/lib.php');
32 /**
33  * Add the Javascript to enable drag and drop upload to a course page
34  *
35  * @param object $course The currently displayed course
36  * @param array $modnames The list of enabled (visible) modules on this site
37  * @return void
38  */
39 function dndupload_add_to_course($course, $modnames) {
40     global $CFG, $PAGE;
42     $showstatus = optional_param('notifyeditingon', false, PARAM_BOOL);
44     // Get all handlers.
45     $handler = new dndupload_handler($course, $modnames);
46     $jsdata = $handler->get_js_data();
47     if (empty($jsdata->types) && empty($jsdata->filehandlers)) {
48         return; // No valid handlers - don't enable drag and drop.
49     }
51     // Add the javascript to the page.
52     $jsmodule = array(
53         'name' => 'coursedndupload',
54         'fullpath' => new moodle_url('/course/dndupload.js'),
55         'strings' => array(
56             array('addfilehere', 'moodle'),
57             array('dndworkingfiletextlink', 'moodle'),
58             array('dndworkingfilelink', 'moodle'),
59             array('dndworkingfiletext', 'moodle'),
60             array('dndworkingfile', 'moodle'),
61             array('dndworkingtextlink', 'moodle'),
62             array('dndworkingtext', 'moodle'),
63             array('dndworkinglink', 'moodle'),
64             array('filetoolarge', 'moodle'),
65             array('actionchoice', 'moodle'),
66             array('servererror', 'moodle'),
67             array('upload', 'moodle'),
68             array('cancel', 'moodle')
69         ),
70         'requires' => array('node', 'event', 'panel', 'json', 'anim')
71     );
72     $vars = array(
73         array('courseid' => $course->id,
74               'maxbytes' => get_max_upload_file_size($CFG->maxbytes, $course->maxbytes),
75               'handlers' => $handler->get_js_data(),
76               'showstatus' => $showstatus)
77     );
79     $PAGE->requires->js_init_call('M.course_dndupload.init', $vars, true, $jsmodule);
80 }
83 /**
84  * Stores all the information about the available dndupload handlers
85  *
86  * @package    core
87  * @copyright  2012 Davo Smith
88  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
89  */
90 class dndupload_handler {
92     /**
93      * @var array A list of all registered mime types that can be dropped onto a course
94      *            along with the modules that will handle them.
95      */
96     protected $types = array();
98     /**
99      * @var array  A list of the different file types (extensions) that different modules
100      *             will handle.
101      */
102     protected $filehandlers = array();
104     /**
105      * Gather a list of dndupload handlers from the different mods
106      *
107      * @param object $course The course this is being added to (to check course_allowed_module() )
108      */
109     public function __construct($course, $modnames = null) {
110         global $CFG;
112         // Add some default types to handle.
113         // Note: 'Files' type is hard-coded into the Javascript as this needs to be ...
114         // ... treated a little differently.
115         $this->add_type('url', array('url', 'text/uri-list', 'text/x-moz-url'), get_string('addlinkhere', 'moodle'),
116                         get_string('nameforlink', 'moodle'), 10);
117         $this->add_type('text/html', array('text/html'), get_string('addpagehere', 'moodle'),
118                         get_string('nameforpage', 'moodle'), 20);
119         $this->add_type('text', array('text', 'text/plain'), get_string('addpagehere', 'moodle'),
120                         get_string('nameforpage', 'moodle'), 30);
122         // Loop through all modules to find handlers.
123         $mods = get_plugin_list_with_function('mod', 'dndupload_register');
124         foreach ($mods as $component => $funcname) {
125             list($modtype, $modname) = normalize_component($component);
126             if ($modnames && !array_key_exists($modname, $modnames)) {
127                 continue; // Module is deactivated (hidden) at the site level.
128             }
129             if (!course_allowed_module($course, $modname)) {
130                 continue; // User does not have permission to add this module to the course.
131             }
132             $resp = $funcname();
133             if (!$resp) {
134                 continue;
135             }
136             if (isset($resp['files'])) {
137                 foreach ($resp['files'] as $file) {
138                     $this->add_file_handler($file['extension'], $modname, $file['message']);
139                 }
140             }
141             if (isset($resp['addtypes'])) {
142                 foreach ($resp['addtypes'] as $type) {
143                     if (isset($type['priority'])) {
144                         $priority = $type['priority'];
145                     } else {
146                         $priority = 100;
147                     }
148                     $this->add_type($type['identifier'], $type['datatransfertypes'],
149                                     $type['addmessage'], $type['namemessage'], $priority);
150                 }
151             }
152             if (isset($resp['types'])) {
153                 foreach ($resp['types'] as $type) {
154                     $noname = !empty($type['noname']);
155                     $this->add_type_handler($type['identifier'], $modname, $type['message'], $noname);
156                 }
157             }
158         }
159     }
161     /**
162      * Used to add a new mime type that can be drag and dropped onto a
163      * course displayed in a browser window
164      *
165      * @param string $identifier The name that this type will be known as
166      * @param array $datatransfertypes An array of the different types in the browser
167      *                                 'dataTransfer.types' object that will map to this type
168      * @param string $addmessage The message to display in the browser when this type is being
169      *                           dragged onto the page
170      * @param string $namemessage The message to pop up when asking for the name to give the
171      *                            course module instance when it is created
172      * @param int $priority Controls the order in which types are checked by the browser (mainly
173      *                      needed to check for 'text' last as that is usually given as fallback)
174      */
175     public function add_type($identifier, $datatransfertypes, $addmessage, $namemessage, $priority=100) {
176         if ($this->is_known_type($identifier)) {
177             throw new coding_exception("Type $identifier is already registered");
178         }
180         $add = new stdClass;
181         $add->identifier = $identifier;
182         $add->datatransfertypes = $datatransfertypes;
183         $add->addmessage = $addmessage;
184         $add->namemessage = $namemessage;
185         $add->priority = $priority;
186         $add->handlers = array();
188         $this->types[$identifier] = $add;
189     }
191     /**
192      * Used to declare that a particular module will handle a particular type
193      * of dropped data
194      *
195      * @param string $type The name of the type (as declared in add_type)
196      * @param string $module The name of the module to handle this type
197      * @param string $message The message to show the user if more than one handler is registered
198      *                        for a type and the user needs to make a choice between them
199      * @param bool $noname If true, the 'name' dialog should be disabled in the pop-up.
200      * @throws coding_exception
201      */
202     public function add_type_handler($type, $module, $message, $noname) {
203         if (!$this->is_known_type($type)) {
204             throw new coding_exception("Trying to add handler for unknown type $type");
205         }
207         $add = new stdClass;
208         $add->type = $type;
209         $add->module = $module;
210         $add->message = $message;
211         $add->noname = $noname ? 1 : 0;
213         $this->types[$type]->handlers[] = $add;
214     }
216     /**
217      * Used to declare that a particular module will handle a particular type
218      * of dropped file
219      *
220      * @param string $extension The file extension to handle ('*' for all types)
221      * @param string $module The name of the module to handle this type
222      * @param string $message The message to show the user if more than one handler is registered
223      *                        for a type and the user needs to make a choice between them
224      */
225     public function add_file_handler($extension, $module, $message) {
226         $extension = strtolower($extension);
228         $add = new stdClass;
229         $add->extension = $extension;
230         $add->module = $module;
231         $add->message = $message;
233         $this->filehandlers[] = $add;
234     }
236     /**
237      * Check to see if the type has been registered
238      *
239      * @param string $type The identifier of the type you are interested in
240      * @return bool True if the type is registered
241      */
242     public function is_known_type($type) {
243         return array_key_exists($type, $this->types);
244     }
246     /**
247      * Check to see if the module in question has registered to handle the
248      * type given
249      *
250      * @param string $module The name of the module
251      * @param string $type The identifier of the type
252      * @return bool True if the module has registered to handle that type
253      */
254     public function has_type_handler($module, $type) {
255         if (!$this->is_known_type($type)) {
256             throw new coding_exception("Checking for handler for unknown type $type");
257         }
258         foreach ($this->types[$type]->handlers as $handler) {
259             if ($handler->module == $module) {
260                 return true;
261             }
262         }
263         return false;
264     }
266     /**
267      * Check to see if the module in question has registered to handle files
268      * with the given extension (or to handle all file types)
269      *
270      * @param string $module The name of the module
271      * @param string $extension The extension of the uploaded file
272      * @return bool True if the module has registered to handle files with
273      *              that extension (or to handle all file types)
274      */
275     public function has_file_handler($module, $extension) {
276         foreach ($this->filehandlers as $handler) {
277             if ($handler->module == $module) {
278                 if ($handler->extension == '*' || $handler->extension == $extension) {
279                     return true;
280                 }
281             }
282         }
283         return false;
284     }
286     /**
287      * Gets a list of the file types that are handled by a particular module
288      *
289      * @param string $module The name of the module to check
290      * @return array of file extensions or string '*'
291      */
292     public function get_handled_file_types($module) {
293         $types = array();
294         foreach ($this->filehandlers as $handler) {
295             if ($handler->module == $module) {
296                 if ($handler->extension == '*') {
297                     return '*';
298                 } else {
299                     // Prepending '.' as otherwise mimeinfo fails.
300                     $types[] = '.'.$handler->extension;
301                 }
302             }
303         }
304         return $types;
305     }
307     /**
308      * Returns an object to pass onto the javascript code with data about all the
309      * registered file / type handlers
310      *
311      * @return object Data to pass on to Javascript code
312      */
313     public function get_js_data() {
314         global $CFG;
316         $ret = new stdClass;
318         // Sort the types by priority.
319         uasort($this->types, array($this, 'type_compare'));
321         $ret->types = array();
322         if (!empty($CFG->dndallowtextandlinks)) {
323             foreach ($this->types as $type) {
324                 if (empty($type->handlers)) {
325                     continue; // Skip any types without registered handlers.
326                 }
327                 $ret->types[] = $type;
328             }
329         }
331         $ret->filehandlers = $this->filehandlers;
332         $uploadrepo = repository::get_instances(array('type' => 'upload'));
333         if (empty($uploadrepo)) {
334             $ret->filehandlers = array(); // No upload repo => no file handlers.
335         }
337         return $ret;
338     }
340     /**
341      * Comparison function used when sorting types by priority
342      * @param object $type1 first type to compare
343      * @param object $type2 second type to compare
344      * @return integer -1 for $type1 < $type2; 1 for $type1 > $type2; 0 for equal
345      */
346     protected function type_compare($type1, $type2) {
347         if ($type1->priority < $type2->priority) {
348             return -1;
349         }
350         if ($type1->priority > $type2->priority) {
351             return 1;
352         }
353         return 0;
354     }
358 /**
359  * Processes the upload, creating the course module and returning the result
360  *
361  * @package    core
362  * @copyright  2012 Davo Smith
363  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
364  */
365 class dndupload_ajax_processor {
367     /** Returned when no error has occurred */
368     const ERROR_OK = 0;
370     /** @var object The course that we are uploading to */
371     protected $course = null;
373     /** @var context_course The course context for capability checking */
374     protected $context = null;
376     /** @var int The section number we are uploading to */
377     protected $section = null;
379     /** @var string The type of upload (e.g. 'Files', 'text/plain') */
380     protected $type = null;
382     /** @var object The details of the module type that will be created */
383     protected $module= null;
385     /** @var object The course module that has been created */
386     protected $cm = null;
388     /** @var dndupload_handler used to check the allowed file types */
389     protected $dnduploadhandler = null;
391     /** @var string The name to give the new activity instance */
392     protected $displayname = null;
394     /**
395      * Set up some basic information needed to handle the upload
396      *
397      * @param int $courseid The ID of the course we are uploading to
398      * @param int $section The section number we are uploading to
399      * @param string $type The type of upload (as reported by the browser)
400      * @param string $modulename The name of the module requested to handle this upload
401      */
402     public function __construct($courseid, $section, $type, $modulename) {
403         global $DB;
405         if (!defined('AJAX_SCRIPT')) {
406             throw new coding_exception('dndupload_ajax_processor should only be used within AJAX requests');
407         }
409         $this->course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
411         require_login($this->course, false);
412         $this->context = context_course::instance($this->course->id);
414         if (!is_number($section) || $section < 0) {
415             throw new coding_exception("Invalid section number $section");
416         }
417         $this->section = $section;
418         $this->type = $type;
420         if (!$this->module = $DB->get_record('modules', array('name' => $modulename))) {
421             throw new coding_exception("Module $modulename does not exist");
422         }
424         $this->dnduploadhandler = new dndupload_handler($this->course);
425     }
427     /**
428      * Check if this upload is a 'file' upload
429      *
430      * @return bool true if it is a 'file' upload, false otherwise
431      */
432     protected function is_file_upload() {
433         return ($this->type == 'Files');
434     }
436     /**
437      * Process the upload - creating the module in the course and returning the result to the browser
438      *
439      * @param string $displayname optional the name (from the browser) to give the course module instance
440      * @param string $content optional the content of the upload (for non-file uploads)
441      */
442     public function process($displayname = null, $content = null) {
443         require_capability('moodle/course:manageactivities', $this->context);
445         if ($this->is_file_upload()) {
446             require_capability('moodle/course:managefiles', $this->context);
447             if ($content != null) {
448                 throw new moodle_exception('fileuploadwithcontent', 'moodle');
449             }
450         } else {
451             if (empty($content)) {
452                 throw new moodle_exception('dnduploadwithoutcontent', 'moodle');
453             }
454         }
456         require_sesskey();
458         $this->displayname = $displayname;
460         if ($this->is_file_upload()) {
461             $this->handle_file_upload();
462         } else {
463             $this->handle_other_upload($content);
464         }
465     }
467     /**
468      * Handle uploads containing files - create the course module, ask the upload repository
469      * to process the file, ask the mod to set itself up, then return the result to the browser
470      */
471     protected function handle_file_upload() {
472         global $CFG;
474         // Add the file to a draft file area.
475         $draftitemid = file_get_unused_draft_itemid();
476         $maxbytes = get_max_upload_file_size($CFG->maxbytes, $this->course->maxbytes);
477         $types = $this->dnduploadhandler->get_handled_file_types($this->module->name);
478         $repo = repository::get_instances(array('type' => 'upload'));
479         if (empty($repo)) {
480             throw new moodle_exception('errornouploadrepo', 'moodle');
481         }
482         $repo = reset($repo); // Get the first (and only) upload repo.
483         $details = $repo->process_upload(null, $maxbytes, $types, '/', $draftitemid);
484         if (empty($this->displayname)) {
485             $this->displayname = $this->display_name_from_file($details['file']);
486         }
488         // Create a course module to hold the new instance.
489         $this->create_course_module();
491         // Ask the module to set itself up.
492         $moduledata = $this->prepare_module_data($draftitemid);
493         $instanceid = plugin_callback('mod', $this->module->name, 'dndupload', 'handle', array($moduledata), 'invalidfunction');
494         if ($instanceid === 'invalidfunction') {
495             throw new coding_exception("{$this->module->name} does not support drag and drop upload (missing {$this->module->name}_dndupload_handle function");
496         }
498         // Finish setting up the course module.
499         $this->finish_setup_course_module($instanceid);
500     }
502     /**
503      * Handle uploads not containing file - create the course module, ask the mod to
504      * set itself up, then return the result to the browser
505      *
506      * @param string $content the content uploaded to the browser
507      */
508     protected function handle_other_upload($content) {
509         // Check this plugin is registered to handle this type of upload
510         if (!$this->dnduploadhandler->has_type_handler($this->module->name, $this->type)) {
511             $info = (object)array('modname' => $this->module->name, 'type' => $this->type);
512             throw new moodle_exception('moddoesnotsupporttype', 'moodle', $info);
513         }
515         // Create a course module to hold the new instance.
516         $this->create_course_module();
518         // Ask the module to set itself up.
519         $moduledata = $this->prepare_module_data(null, $content);
520         $instanceid = plugin_callback('mod', $this->module->name, 'dndupload', 'handle', array($moduledata), 'invalidfunction');
521         if ($instanceid === 'invalidfunction') {
522             throw new coding_exception("{$this->module->name} does not support drag and drop upload (missing {$this->module->name}_dndupload_handle function");
523         }
525         // Finish setting up the course module.
526         $this->finish_setup_course_module($instanceid);
527     }
529     /**
530      * Generate the name of the mod instance from the name of the file
531      * (remove the extension and convert underscore => space
532      *
533      * @param string $filename the filename of the uploaded file
534      * @return string the display name to use
535      */
536     protected function display_name_from_file($filename) {
537         $pos = textlib::strrpos($filename, '.');
538         if ($pos) { // Want to skip if $pos === 0 OR $pos === false.
539             $filename = textlib::substr($filename, 0, $pos);
540         }
541         return str_replace('_', ' ', $filename);
542     }
544     /**
545      * Create the coursemodule to hold the file/content that has been uploaded
546      */
547     protected function create_course_module() {
548         if (!course_allowed_module($this->course, $this->module->name)) {
549             throw new coding_exception("The module {$this->module->name} is not allowed to be added to this course");
550         }
552         $this->cm = new stdClass();
553         $this->cm->course = $this->course->id;
554         $this->cm->section = $this->section;
555         $this->cm->module = $this->module->id;
556         $this->cm->modulename = $this->module->name;
557         $this->cm->instance = 0; // This will be filled in after we create the instance.
558         $this->cm->visible = 1;
559         $this->cm->groupmode = $this->course->groupmode;
560         $this->cm->groupingid = $this->course->defaultgroupingid;
562         // Set the correct default for completion tracking.
563         $this->cm->completion = COMPLETION_TRACKING_NONE;
564         $completion = new completion_info($this->course);
565         if ($completion->is_enabled()) {
566             if (plugin_supports('mod', $this->cm->modulename, FEATURE_MODEDIT_DEFAULT_COMPLETION, true)) {
567                 $this->cm->completion = COMPLETION_TRACKING_MANUAL;
568             }
569         }
571         if (!$this->cm->id = add_course_module($this->cm)) {
572             throw new coding_exception("Unable to create the course module");
573         }
574         // The following are used inside some few core functions, so may as well set them here.
575         $this->cm->coursemodule = $this->cm->id;
576         $groupbuttons = ($this->course->groupmode or (!$this->course->groupmodeforce));
577         if ($groupbuttons and plugin_supports('mod', $this->module->name, FEATURE_GROUPS, 0)) {
578             $this->cm->groupmodelink = (!$this->course->groupmodeforce);
579         } else {
580             $this->cm->groupmodelink = false;
581             $this->cm->groupmode = false;
582         }
583     }
585     /**
586      * Gather together all the details to pass on to the mod, so that it can initialise it's
587      * own database tables
588      *
589      * @param int $draftitemid optional the id of the draft area containing the file (for file uploads)
590      * @param string $content optional the content dropped onto the course (for non-file uploads)
591      * @return object data to pass on to the mod, containing:
592      *              string $type the 'type' as registered with dndupload_handler (or 'Files')
593      *              object $course the course the upload was for
594      *              int $draftitemid optional the id of the draft area containing the files
595      *              int $coursemodule id of the course module that has already been created
596      *              string $displayname the name to use for this activity (can be overriden by the mod)
597      */
598     protected function prepare_module_data($draftitemid = null, $content = null) {
599         $data = new stdClass();
600         $data->type = $this->type;
601         $data->course = $this->course;
602         if ($draftitemid) {
603             $data->draftitemid = $draftitemid;
604         } else if ($content) {
605             $data->content = $content;
606         }
607         $data->coursemodule = $this->cm->id;
608         $data->displayname = $this->displayname;
609         return $data;
610     }
612     /**
613      * Called after the mod has set itself up, to finish off any course module settings
614      * (set instance id, add to correct section, set visibility, etc.) and send the response
615      *
616      * @param int $instanceid id returned by the mod when it was created
617      */
618     protected function finish_setup_course_module($instanceid) {
619         global $DB, $USER;
621         if (!$instanceid) {
622             // Something has gone wrong - undo everything we can.
623             course_delete_module($this->cm->id);
624             throw new moodle_exception('errorcreatingactivity', 'moodle', '', $this->module->name);
625         }
627         // Note the section visibility
628         $visible = get_fast_modinfo($this->course)->get_section_info($this->section)->visible;
630         $DB->set_field('course_modules', 'instance', $instanceid, array('id' => $this->cm->id));
631         // Rebuild the course cache after update action
632         rebuild_course_cache($this->course->id, true);
633         $this->course->modinfo = null; // Otherwise we will just get the old version back again.
635         $sectionid = course_add_cm_to_section($this->course, $this->cm->id, $this->section);
637         set_coursemodule_visible($this->cm->id, $visible);
638         if (!$visible) {
639             $DB->set_field('course_modules', 'visibleold', 1, array('id' => $this->cm->id));
640         }
642         // retrieve the final info about this module.
643         $info = get_fast_modinfo($this->course);
644         if (!isset($info->cms[$this->cm->id])) {
645             // The course module has not been properly created in the course - undo everything.
646             course_delete_module($this->cm->id);
647             throw new moodle_exception('errorcreatingactivity', 'moodle', '', $this->module->name);
648         }
649         $mod = $info->get_cm($this->cm->id);
650         $mod->groupmodelink = $this->cm->groupmodelink;
651         $mod->groupmode = $this->cm->groupmode;
653         // Trigger mod_created event with information about this module.
654         $eventdata = new stdClass();
655         $eventdata->modulename = $mod->modname;
656         $eventdata->name       = $mod->name;
657         $eventdata->cmid       = $mod->id;
658         $eventdata->courseid   = $this->course->id;
659         $eventdata->userid     = $USER->id;
660         events_trigger('mod_created', $eventdata);
662         add_to_log($this->course->id, "course", "add mod",
663                    "../mod/{$mod->modname}/view.php?id=$mod->id",
664                    "{$mod->modname} $instanceid");
665         add_to_log($this->course->id, $mod->modname, "add",
666                    "view.php?id=$mod->id",
667                    "$instanceid", $mod->id);
669         $this->send_response($mod);
670     }
672     /**
673      * Send the details of the newly created activity back to the client browser
674      *
675      * @param cm_info $mod details of the mod just created
676      */
677     protected function send_response($mod) {
678         global $OUTPUT, $PAGE;
679         $courserenderer = $PAGE->get_renderer('core', 'course');
681         $resp = new stdClass();
682         $resp->error = self::ERROR_OK;
683         $resp->icon = $mod->get_icon_url()->out();
684         $resp->name = $mod->name;
685         if ($mod->has_view()) {
686             $resp->link = $mod->get_url()->out();
687         } else {
688             $resp->link = null;
689         }
690         $resp->content = $mod->get_content();
691         $resp->elementid = 'module-'.$mod->id;
692         $actions = course_get_cm_edit_actions($mod, 0, $mod->sectionnum);
693         $resp->commands = ' '. $courserenderer->course_section_cm_edit_actions($actions);
694         $resp->onclick = $mod->get_on_click();
695         $resp->visible = $mod->visible;
697         // if using groupings, then display grouping name
698         if (!empty($mod->groupingid) && has_capability('moodle/course:managegroups', $this->context)) {
699             $groupings = groups_get_all_groupings($this->course->id);
700             $resp->groupingname = format_string($groupings[$mod->groupingid]->name);
701         }
703         echo $OUTPUT->header();
704         echo json_encode($resp);
705         die();
706     }