Merge branch 'MDL-58399-master' of git://github.com/jleyva/moodle
[moodle.git] / mod / resource / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package    mod_resource
20  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
24 defined('MOODLE_INTERNAL') || die;
26 /**
27  * List of features supported in Resource module
28  * @param string $feature FEATURE_xx constant for requested feature
29  * @return mixed True if module supports feature, false if not, null if doesn't know
30  */
31 function resource_supports($feature) {
32     switch($feature) {
33         case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;
34         case FEATURE_GROUPS:                  return false;
35         case FEATURE_GROUPINGS:               return false;
36         case FEATURE_MOD_INTRO:               return true;
37         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
38         case FEATURE_GRADE_HAS_GRADE:         return false;
39         case FEATURE_GRADE_OUTCOMES:          return false;
40         case FEATURE_BACKUP_MOODLE2:          return true;
41         case FEATURE_SHOW_DESCRIPTION:        return true;
43         default: return null;
44     }
45 }
47 /**
48  * Returns all other caps used in module
49  * @return array
50  */
51 function resource_get_extra_capabilities() {
52     return array('moodle/site:accessallgroups');
53 }
55 /**
56  * This function is used by the reset_course_userdata function in moodlelib.
57  * @param $data the data submitted from the reset course.
58  * @return array status array
59  */
60 function resource_reset_userdata($data) {
61     return array();
62 }
64 /**
65  * List the actions that correspond to a view of this module.
66  * This is used by the participation report.
67  *
68  * Note: This is not used by new logging system. Event with
69  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
70  *       be considered as view action.
71  *
72  * @return array
73  */
74 function resource_get_view_actions() {
75     return array('view','view all');
76 }
78 /**
79  * List the actions that correspond to a post of this module.
80  * This is used by the participation report.
81  *
82  * Note: This is not used by new logging system. Event with
83  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
84  *       will be considered as post action.
85  *
86  * @return array
87  */
88 function resource_get_post_actions() {
89     return array('update', 'add');
90 }
92 /**
93  * Add resource instance.
94  * @param object $data
95  * @param object $mform
96  * @return int new resource instance id
97  */
98 function resource_add_instance($data, $mform) {
99     global $CFG, $DB;
100     require_once("$CFG->libdir/resourcelib.php");
101     require_once("$CFG->dirroot/mod/resource/locallib.php");
102     $cmid = $data->coursemodule;
103     $data->timemodified = time();
105     resource_set_display_options($data);
107     $data->id = $DB->insert_record('resource', $data);
109     // we need to use context now, so we need to make sure all needed info is already in db
110     $DB->set_field('course_modules', 'instance', $data->id, array('id'=>$cmid));
111     resource_set_mainfile($data);
113     $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
114     \core_completion\api::update_completion_date_event($cmid, 'resource', $data->id, $completiontimeexpected);
116     return $data->id;
119 /**
120  * Update resource instance.
121  * @param object $data
122  * @param object $mform
123  * @return bool true
124  */
125 function resource_update_instance($data, $mform) {
126     global $CFG, $DB;
127     require_once("$CFG->libdir/resourcelib.php");
128     $data->timemodified = time();
129     $data->id           = $data->instance;
130     $data->revision++;
132     resource_set_display_options($data);
134     $DB->update_record('resource', $data);
135     resource_set_mainfile($data);
137     $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
138     \core_completion\api::update_completion_date_event($data->coursemodule, 'resource', $data->id, $completiontimeexpected);
140     return true;
143 /**
144  * Updates display options based on form input.
145  *
146  * Shared code used by resource_add_instance and resource_update_instance.
147  *
148  * @param object $data Data object
149  */
150 function resource_set_display_options($data) {
151     $displayoptions = array();
152     if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
153         $displayoptions['popupwidth']  = $data->popupwidth;
154         $displayoptions['popupheight'] = $data->popupheight;
155     }
156     if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
157         $displayoptions['printintro']   = (int)!empty($data->printintro);
158     }
159     if (!empty($data->showsize)) {
160         $displayoptions['showsize'] = 1;
161     }
162     if (!empty($data->showtype)) {
163         $displayoptions['showtype'] = 1;
164     }
165     if (!empty($data->showdate)) {
166         $displayoptions['showdate'] = 1;
167     }
168     $data->displayoptions = serialize($displayoptions);
171 /**
172  * Delete resource instance.
173  * @param int $id
174  * @return bool true
175  */
176 function resource_delete_instance($id) {
177     global $DB;
179     if (!$resource = $DB->get_record('resource', array('id'=>$id))) {
180         return false;
181     }
183     $cm = get_coursemodule_from_instance('resource', $id);
184     \core_completion\api::update_completion_date_event($cm->id, 'resource', $id, null);
186     // note: all context files are deleted automatically
188     $DB->delete_records('resource', array('id'=>$resource->id));
190     return true;
193 /**
194  * Given a course_module object, this function returns any
195  * "extra" information that may be needed when printing
196  * this activity in a course listing.
197  *
198  * See {@link get_array_of_activities()} in course/lib.php
199  *
200  * @param stdClass $coursemodule
201  * @return cached_cm_info info
202  */
203 function resource_get_coursemodule_info($coursemodule) {
204     global $CFG, $DB;
205     require_once("$CFG->libdir/filelib.php");
206     require_once("$CFG->dirroot/mod/resource/locallib.php");
207     require_once($CFG->libdir.'/completionlib.php');
209     $context = context_module::instance($coursemodule->id);
211     if (!$resource = $DB->get_record('resource', array('id'=>$coursemodule->instance),
212             'id, name, display, displayoptions, tobemigrated, revision, intro, introformat')) {
213         return NULL;
214     }
216     $info = new cached_cm_info();
217     $info->name = $resource->name;
218     if ($coursemodule->showdescription) {
219         // Convert intro to html. Do not filter cached version, filters run at display time.
220         $info->content = format_module_intro('resource', $resource, $coursemodule->id, false);
221     }
223     if ($resource->tobemigrated) {
224         $info->icon ='i/invalid';
225         return $info;
226     }
228     // See if there is at least one file.
229     $fs = get_file_storage();
230     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false, 0, 0, 1);
231     if (count($files) >= 1) {
232         $mainfile = reset($files);
233         $info->icon = file_file_icon($mainfile, 24);
234         $resource->mainfile = $mainfile->get_filename();
235     }
237     $display = resource_get_final_display_type($resource);
239     if ($display == RESOURCELIB_DISPLAY_POPUP) {
240         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
241         $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
242         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
243         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
244         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
245         $info->onclick = "window.open('$fullurl', '', '$wh'); return false;";
247     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
248         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
249         $info->onclick = "window.open('$fullurl'); return false;";
251     }
253     // If any optional extra details are turned on, store in custom data,
254     // add some file details as well to be used later by resource_get_optional_details() without retriving.
255     // Do not store filedetails if this is a reference - they will still need to be retrieved every time.
256     if (($filedetails = resource_get_file_details($resource, $coursemodule)) && empty($filedetails['isref'])) {
257         $displayoptions = @unserialize($resource->displayoptions);
258         $displayoptions['filedetails'] = $filedetails;
259         $info->customdata = serialize($displayoptions);
260     } else {
261         $info->customdata = $resource->displayoptions;
262     }
264     return $info;
267 /**
268  * Called when viewing course page. Shows extra details after the link if
269  * enabled.
270  *
271  * @param cm_info $cm Course module information
272  */
273 function resource_cm_info_view(cm_info $cm) {
274     global $CFG;
275     require_once($CFG->dirroot . '/mod/resource/locallib.php');
277     $resource = (object)array('displayoptions' => $cm->customdata);
278     $details = resource_get_optional_details($resource, $cm);
279     if ($details) {
280         $cm->set_after_link(' ' . html_writer::tag('span', $details,
281                 array('class' => 'resourcelinkdetails')));
282     }
285 /**
286  * Lists all browsable file areas
287  *
288  * @package  mod_resource
289  * @category files
290  * @param stdClass $course course object
291  * @param stdClass $cm course module object
292  * @param stdClass $context context object
293  * @return array
294  */
295 function resource_get_file_areas($course, $cm, $context) {
296     $areas = array();
297     $areas['content'] = get_string('resourcecontent', 'resource');
298     return $areas;
301 /**
302  * File browsing support for resource module content area.
303  *
304  * @package  mod_resource
305  * @category files
306  * @param stdClass $browser file browser instance
307  * @param stdClass $areas file areas
308  * @param stdClass $course course object
309  * @param stdClass $cm course module object
310  * @param stdClass $context context object
311  * @param string $filearea file area
312  * @param int $itemid item ID
313  * @param string $filepath file path
314  * @param string $filename file name
315  * @return file_info instance or null if not found
316  */
317 function resource_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
318     global $CFG;
320     if (!has_capability('moodle/course:managefiles', $context)) {
321         // students can not peak here!
322         return null;
323     }
325     $fs = get_file_storage();
327     if ($filearea === 'content') {
328         $filepath = is_null($filepath) ? '/' : $filepath;
329         $filename = is_null($filename) ? '.' : $filename;
331         $urlbase = $CFG->wwwroot.'/pluginfile.php';
332         if (!$storedfile = $fs->get_file($context->id, 'mod_resource', 'content', 0, $filepath, $filename)) {
333             if ($filepath === '/' and $filename === '.') {
334                 $storedfile = new virtual_root_file($context->id, 'mod_resource', 'content', 0);
335             } else {
336                 // not found
337                 return null;
338             }
339         }
340         require_once("$CFG->dirroot/mod/resource/locallib.php");
341         return new resource_content_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, true, false);
342     }
344     // note: resource_intro handled in file_browser automatically
346     return null;
349 /**
350  * Serves the resource files.
351  *
352  * @package  mod_resource
353  * @category files
354  * @param stdClass $course course object
355  * @param stdClass $cm course module object
356  * @param stdClass $context context object
357  * @param string $filearea file area
358  * @param array $args extra arguments
359  * @param bool $forcedownload whether or not force download
360  * @param array $options additional options affecting the file serving
361  * @return bool false if file not found, does not return if found - just send the file
362  */
363 function resource_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
364     global $CFG, $DB;
365     require_once("$CFG->libdir/resourcelib.php");
367     if ($context->contextlevel != CONTEXT_MODULE) {
368         return false;
369     }
371     require_course_login($course, true, $cm);
372     if (!has_capability('mod/resource:view', $context)) {
373         return false;
374     }
376     if ($filearea !== 'content') {
377         // intro is handled automatically in pluginfile.php
378         return false;
379     }
381     array_shift($args); // ignore revision - designed to prevent caching problems only
383     $fs = get_file_storage();
384     $relativepath = implode('/', $args);
385     $fullpath = rtrim("/$context->id/mod_resource/$filearea/0/$relativepath", '/');
386     do {
387         if (!$file = $fs->get_file_by_hash(sha1($fullpath))) {
388             if ($fs->get_file_by_hash(sha1("$fullpath/."))) {
389                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.htm"))) {
390                     break;
391                 }
392                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.html"))) {
393                     break;
394                 }
395                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/Default.htm"))) {
396                     break;
397                 }
398             }
399             $resource = $DB->get_record('resource', array('id'=>$cm->instance), 'id, legacyfiles', MUST_EXIST);
400             if ($resource->legacyfiles != RESOURCELIB_LEGACYFILES_ACTIVE) {
401                 return false;
402             }
403             if (!$file = resourcelib_try_file_migration('/'.$relativepath, $cm->id, $cm->course, 'mod_resource', 'content', 0)) {
404                 return false;
405             }
406             // file migrate - update flag
407             $resource->legacyfileslast = time();
408             $DB->update_record('resource', $resource);
409         }
410     } while (false);
412     // should we apply filters?
413     $mimetype = $file->get_mimetype();
414     if ($mimetype === 'text/html' or $mimetype === 'text/plain' or $mimetype === 'application/xhtml+xml') {
415         $filter = $DB->get_field('resource', 'filterfiles', array('id'=>$cm->instance));
416         $CFG->embeddedsoforcelinktarget = true;
417     } else {
418         $filter = 0;
419     }
421     // finally send the file
422     send_stored_file($file, null, $filter, $forcedownload, $options);
425 /**
426  * Return a list of page types
427  * @param string $pagetype current page type
428  * @param stdClass $parentcontext Block's parent context
429  * @param stdClass $currentcontext Current context of block
430  */
431 function resource_page_type_list($pagetype, $parentcontext, $currentcontext) {
432     $module_pagetype = array('mod-resource-*'=>get_string('page-mod-resource-x', 'resource'));
433     return $module_pagetype;
436 /**
437  * Export file resource contents
438  *
439  * @return array of file content
440  */
441 function resource_export_contents($cm, $baseurl) {
442     global $CFG, $DB;
443     $contents = array();
444     $context = context_module::instance($cm->id);
445     $resource = $DB->get_record('resource', array('id'=>$cm->instance), '*', MUST_EXIST);
447     $fs = get_file_storage();
448     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false);
450     foreach ($files as $fileinfo) {
451         $file = array();
452         $file['type'] = 'file';
453         $file['filename']     = $fileinfo->get_filename();
454         $file['filepath']     = $fileinfo->get_filepath();
455         $file['filesize']     = $fileinfo->get_filesize();
456         $file['fileurl']      = file_encode_url("$CFG->wwwroot/" . $baseurl, '/'.$context->id.'/mod_resource/content/'.$resource->revision.$fileinfo->get_filepath().$fileinfo->get_filename(), true);
457         $file['timecreated']  = $fileinfo->get_timecreated();
458         $file['timemodified'] = $fileinfo->get_timemodified();
459         $file['sortorder']    = $fileinfo->get_sortorder();
460         $file['userid']       = $fileinfo->get_userid();
461         $file['author']       = $fileinfo->get_author();
462         $file['license']      = $fileinfo->get_license();
463         $file['mimetype']     = $fileinfo->get_mimetype();
464         $file['isexternalfile'] = $fileinfo->is_external_file();
465         if ($file['isexternalfile']) {
466             $file['repositorytype'] = $fileinfo->get_repository_type();
467         }
468         $contents[] = $file;
469     }
471     return $contents;
474 /**
475  * Register the ability to handle drag and drop file uploads
476  * @return array containing details of the files / types the mod can handle
477  */
478 function resource_dndupload_register() {
479     return array('files' => array(
480                      array('extension' => '*', 'message' => get_string('dnduploadresource', 'mod_resource'))
481                  ));
484 /**
485  * Handle a file that has been uploaded
486  * @param object $uploadinfo details of the file / content that has been uploaded
487  * @return int instance id of the newly created mod
488  */
489 function resource_dndupload_handle($uploadinfo) {
490     // Gather the required info.
491     $data = new stdClass();
492     $data->course = $uploadinfo->course->id;
493     $data->name = $uploadinfo->displayname;
494     $data->intro = '';
495     $data->introformat = FORMAT_HTML;
496     $data->coursemodule = $uploadinfo->coursemodule;
497     $data->files = $uploadinfo->draftitemid;
499     // Set the display options to the site defaults.
500     $config = get_config('resource');
501     $data->display = $config->display;
502     $data->popupheight = $config->popupheight;
503     $data->popupwidth = $config->popupwidth;
504     $data->printintro = $config->printintro;
505     $data->showsize = (isset($config->showsize)) ? $config->showsize : 0;
506     $data->showtype = (isset($config->showtype)) ? $config->showtype : 0;
507     $data->showdate = (isset($config->showdate)) ? $config->showdate : 0;
508     $data->filterfiles = $config->filterfiles;
510     return resource_add_instance($data, null);
513 /**
514  * Mark the activity completed (if required) and trigger the course_module_viewed event.
515  *
516  * @param  stdClass $resource   resource object
517  * @param  stdClass $course     course object
518  * @param  stdClass $cm         course module object
519  * @param  stdClass $context    context object
520  * @since Moodle 3.0
521  */
522 function resource_view($resource, $course, $cm, $context) {
524     // Trigger course_module_viewed event.
525     $params = array(
526         'context' => $context,
527         'objectid' => $resource->id
528     );
530     $event = \mod_resource\event\course_module_viewed::create($params);
531     $event->add_record_snapshot('course_modules', $cm);
532     $event->add_record_snapshot('course', $course);
533     $event->add_record_snapshot('resource', $resource);
534     $event->trigger();
536     // Completion.
537     $completion = new completion_info($course);
538     $completion->set_module_viewed($cm);
541 /**
542  * Check if the module has any update that affects the current user since a given time.
543  *
544  * @param  cm_info $cm course module data
545  * @param  int $from the time to check updates from
546  * @param  array $filter  if we need to check only specific updates
547  * @return stdClass an object with the different type of areas indicating if they were updated or not
548  * @since Moodle 3.2
549  */
550 function resource_check_updates_since(cm_info $cm, $from, $filter = array()) {
551     $updates = course_check_module_updates_since($cm, $from, array('content'), $filter);
552     return $updates;
555 /**
556  * Handles creating actions for events.
557  *
558  * @param calendar_event $event
559  * @param \core_calendar\action_factory $factory
560  * @return \core_calendar\local\event\value_objects\action|\core_calendar\local\interfaces\action_interface|null
561  */
562 function mod_resource_core_calendar_provide_event_action(calendar_event $event,
563                                                       \core_calendar\action_factory $factory) {
564     $cm = get_fast_modinfo($event->courseid)->instances['resource'][$event->instance];
566     $course = new stdClass();
567     $course->id = $event->courseid;
568     $completion = new \completion_info($course);
570     $completiondata = $completion->get_data($cm, false);
572     if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
573         return null;
574     }
576     return $factory->create_instance(
577         get_string('view'),
578         new \moodle_url('/mod/resource/view.php', ['id' => $cm->id]),
579         1,
580         true
581     );