Merge branch 'MDL-61033-master' of https://github.com/nashtechdev01/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) {
62     // Any changes to the list of dates that needs to be rolled should be same during course restore and course reset.
63     // See MDL-9367.
65     return array();
66 }
68 /**
69  * List the actions that correspond to a view of this module.
70  * This is used by the participation report.
71  *
72  * Note: This is not used by new logging system. Event with
73  *       crud = 'r' and edulevel = LEVEL_PARTICIPATING will
74  *       be considered as view action.
75  *
76  * @return array
77  */
78 function resource_get_view_actions() {
79     return array('view','view all');
80 }
82 /**
83  * List the actions that correspond to a post of this module.
84  * This is used by the participation report.
85  *
86  * Note: This is not used by new logging system. Event with
87  *       crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING
88  *       will be considered as post action.
89  *
90  * @return array
91  */
92 function resource_get_post_actions() {
93     return array('update', 'add');
94 }
96 /**
97  * Add resource instance.
98  * @param object $data
99  * @param object $mform
100  * @return int new resource instance id
101  */
102 function resource_add_instance($data, $mform) {
103     global $CFG, $DB;
104     require_once("$CFG->libdir/resourcelib.php");
105     require_once("$CFG->dirroot/mod/resource/locallib.php");
106     $cmid = $data->coursemodule;
107     $data->timemodified = time();
109     resource_set_display_options($data);
111     $data->id = $DB->insert_record('resource', $data);
113     // we need to use context now, so we need to make sure all needed info is already in db
114     $DB->set_field('course_modules', 'instance', $data->id, array('id'=>$cmid));
115     resource_set_mainfile($data);
117     $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
118     \core_completion\api::update_completion_date_event($cmid, 'resource', $data->id, $completiontimeexpected);
120     return $data->id;
123 /**
124  * Update resource instance.
125  * @param object $data
126  * @param object $mform
127  * @return bool true
128  */
129 function resource_update_instance($data, $mform) {
130     global $CFG, $DB;
131     require_once("$CFG->libdir/resourcelib.php");
132     $data->timemodified = time();
133     $data->id           = $data->instance;
134     $data->revision++;
136     resource_set_display_options($data);
138     $DB->update_record('resource', $data);
139     resource_set_mainfile($data);
141     $completiontimeexpected = !empty($data->completionexpected) ? $data->completionexpected : null;
142     \core_completion\api::update_completion_date_event($data->coursemodule, 'resource', $data->id, $completiontimeexpected);
144     return true;
147 /**
148  * Updates display options based on form input.
149  *
150  * Shared code used by resource_add_instance and resource_update_instance.
151  *
152  * @param object $data Data object
153  */
154 function resource_set_display_options($data) {
155     $displayoptions = array();
156     if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
157         $displayoptions['popupwidth']  = $data->popupwidth;
158         $displayoptions['popupheight'] = $data->popupheight;
159     }
160     if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
161         $displayoptions['printintro']   = (int)!empty($data->printintro);
162     }
163     if (!empty($data->showsize)) {
164         $displayoptions['showsize'] = 1;
165     }
166     if (!empty($data->showtype)) {
167         $displayoptions['showtype'] = 1;
168     }
169     if (!empty($data->showdate)) {
170         $displayoptions['showdate'] = 1;
171     }
172     $data->displayoptions = serialize($displayoptions);
175 /**
176  * Delete resource instance.
177  * @param int $id
178  * @return bool true
179  */
180 function resource_delete_instance($id) {
181     global $DB;
183     if (!$resource = $DB->get_record('resource', array('id'=>$id))) {
184         return false;
185     }
187     $cm = get_coursemodule_from_instance('resource', $id);
188     \core_completion\api::update_completion_date_event($cm->id, 'resource', $id, null);
190     // note: all context files are deleted automatically
192     $DB->delete_records('resource', array('id'=>$resource->id));
194     return true;
197 /**
198  * Given a course_module object, this function returns any
199  * "extra" information that may be needed when printing
200  * this activity in a course listing.
201  *
202  * See {@link get_array_of_activities()} in course/lib.php
203  *
204  * @param stdClass $coursemodule
205  * @return cached_cm_info info
206  */
207 function resource_get_coursemodule_info($coursemodule) {
208     global $CFG, $DB;
209     require_once("$CFG->libdir/filelib.php");
210     require_once("$CFG->dirroot/mod/resource/locallib.php");
211     require_once($CFG->libdir.'/completionlib.php');
213     $context = context_module::instance($coursemodule->id);
215     if (!$resource = $DB->get_record('resource', array('id'=>$coursemodule->instance),
216             'id, name, display, displayoptions, tobemigrated, revision, intro, introformat')) {
217         return NULL;
218     }
220     $info = new cached_cm_info();
221     $info->name = $resource->name;
222     if ($coursemodule->showdescription) {
223         // Convert intro to html. Do not filter cached version, filters run at display time.
224         $info->content = format_module_intro('resource', $resource, $coursemodule->id, false);
225     }
227     if ($resource->tobemigrated) {
228         $info->icon ='i/invalid';
229         return $info;
230     }
232     // See if there is at least one file.
233     $fs = get_file_storage();
234     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false, 0, 0, 1);
235     if (count($files) >= 1) {
236         $mainfile = reset($files);
237         $info->icon = file_file_icon($mainfile, 24);
238         $resource->mainfile = $mainfile->get_filename();
239     }
241     $display = resource_get_final_display_type($resource);
243     if ($display == RESOURCELIB_DISPLAY_POPUP) {
244         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
245         $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
246         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
247         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
248         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
249         $info->onclick = "window.open('$fullurl', '', '$wh'); return false;";
251     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
252         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
253         $info->onclick = "window.open('$fullurl'); return false;";
255     }
257     // If any optional extra details are turned on, store in custom data,
258     // add some file details as well to be used later by resource_get_optional_details() without retriving.
259     // Do not store filedetails if this is a reference - they will still need to be retrieved every time.
260     if (($filedetails = resource_get_file_details($resource, $coursemodule)) && empty($filedetails['isref'])) {
261         $displayoptions = @unserialize($resource->displayoptions);
262         $displayoptions['filedetails'] = $filedetails;
263         $info->customdata = serialize($displayoptions);
264     } else {
265         $info->customdata = $resource->displayoptions;
266     }
268     return $info;
271 /**
272  * Called when viewing course page. Shows extra details after the link if
273  * enabled.
274  *
275  * @param cm_info $cm Course module information
276  */
277 function resource_cm_info_view(cm_info $cm) {
278     global $CFG;
279     require_once($CFG->dirroot . '/mod/resource/locallib.php');
281     $resource = (object)array('displayoptions' => $cm->customdata);
282     $details = resource_get_optional_details($resource, $cm);
283     if ($details) {
284         $cm->set_after_link(' ' . html_writer::tag('span', $details,
285                 array('class' => 'resourcelinkdetails')));
286     }
289 /**
290  * Lists all browsable file areas
291  *
292  * @package  mod_resource
293  * @category files
294  * @param stdClass $course course object
295  * @param stdClass $cm course module object
296  * @param stdClass $context context object
297  * @return array
298  */
299 function resource_get_file_areas($course, $cm, $context) {
300     $areas = array();
301     $areas['content'] = get_string('resourcecontent', 'resource');
302     return $areas;
305 /**
306  * File browsing support for resource module content area.
307  *
308  * @package  mod_resource
309  * @category files
310  * @param stdClass $browser file browser instance
311  * @param stdClass $areas file areas
312  * @param stdClass $course course object
313  * @param stdClass $cm course module object
314  * @param stdClass $context context object
315  * @param string $filearea file area
316  * @param int $itemid item ID
317  * @param string $filepath file path
318  * @param string $filename file name
319  * @return file_info instance or null if not found
320  */
321 function resource_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
322     global $CFG;
324     if (!has_capability('moodle/course:managefiles', $context)) {
325         // students can not peak here!
326         return null;
327     }
329     $fs = get_file_storage();
331     if ($filearea === 'content') {
332         $filepath = is_null($filepath) ? '/' : $filepath;
333         $filename = is_null($filename) ? '.' : $filename;
335         $urlbase = $CFG->wwwroot.'/pluginfile.php';
336         if (!$storedfile = $fs->get_file($context->id, 'mod_resource', 'content', 0, $filepath, $filename)) {
337             if ($filepath === '/' and $filename === '.') {
338                 $storedfile = new virtual_root_file($context->id, 'mod_resource', 'content', 0);
339             } else {
340                 // not found
341                 return null;
342             }
343         }
344         require_once("$CFG->dirroot/mod/resource/locallib.php");
345         return new resource_content_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, true, false);
346     }
348     // note: resource_intro handled in file_browser automatically
350     return null;
353 /**
354  * Serves the resource files.
355  *
356  * @package  mod_resource
357  * @category files
358  * @param stdClass $course course object
359  * @param stdClass $cm course module object
360  * @param stdClass $context context object
361  * @param string $filearea file area
362  * @param array $args extra arguments
363  * @param bool $forcedownload whether or not force download
364  * @param array $options additional options affecting the file serving
365  * @return bool false if file not found, does not return if found - just send the file
366  */
367 function resource_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
368     global $CFG, $DB;
369     require_once("$CFG->libdir/resourcelib.php");
371     if ($context->contextlevel != CONTEXT_MODULE) {
372         return false;
373     }
375     require_course_login($course, true, $cm);
376     if (!has_capability('mod/resource:view', $context)) {
377         return false;
378     }
380     if ($filearea !== 'content') {
381         // intro is handled automatically in pluginfile.php
382         return false;
383     }
385     array_shift($args); // ignore revision - designed to prevent caching problems only
387     $fs = get_file_storage();
388     $relativepath = implode('/', $args);
389     $fullpath = rtrim("/$context->id/mod_resource/$filearea/0/$relativepath", '/');
390     do {
391         if (!$file = $fs->get_file_by_hash(sha1($fullpath))) {
392             if ($fs->get_file_by_hash(sha1("$fullpath/."))) {
393                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.htm"))) {
394                     break;
395                 }
396                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.html"))) {
397                     break;
398                 }
399                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/Default.htm"))) {
400                     break;
401                 }
402             }
403             $resource = $DB->get_record('resource', array('id'=>$cm->instance), 'id, legacyfiles', MUST_EXIST);
404             if ($resource->legacyfiles != RESOURCELIB_LEGACYFILES_ACTIVE) {
405                 return false;
406             }
407             if (!$file = resourcelib_try_file_migration('/'.$relativepath, $cm->id, $cm->course, 'mod_resource', 'content', 0)) {
408                 return false;
409             }
410             // file migrate - update flag
411             $resource->legacyfileslast = time();
412             $DB->update_record('resource', $resource);
413         }
414     } while (false);
416     // should we apply filters?
417     $mimetype = $file->get_mimetype();
418     if ($mimetype === 'text/html' or $mimetype === 'text/plain' or $mimetype === 'application/xhtml+xml') {
419         $filter = $DB->get_field('resource', 'filterfiles', array('id'=>$cm->instance));
420         $CFG->embeddedsoforcelinktarget = true;
421     } else {
422         $filter = 0;
423     }
425     // finally send the file
426     send_stored_file($file, null, $filter, $forcedownload, $options);
429 /**
430  * Return a list of page types
431  * @param string $pagetype current page type
432  * @param stdClass $parentcontext Block's parent context
433  * @param stdClass $currentcontext Current context of block
434  */
435 function resource_page_type_list($pagetype, $parentcontext, $currentcontext) {
436     $module_pagetype = array('mod-resource-*'=>get_string('page-mod-resource-x', 'resource'));
437     return $module_pagetype;
440 /**
441  * Export file resource contents
442  *
443  * @return array of file content
444  */
445 function resource_export_contents($cm, $baseurl) {
446     global $CFG, $DB;
447     $contents = array();
448     $context = context_module::instance($cm->id);
449     $resource = $DB->get_record('resource', array('id'=>$cm->instance), '*', MUST_EXIST);
451     $fs = get_file_storage();
452     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false);
454     foreach ($files as $fileinfo) {
455         $file = array();
456         $file['type'] = 'file';
457         $file['filename']     = $fileinfo->get_filename();
458         $file['filepath']     = $fileinfo->get_filepath();
459         $file['filesize']     = $fileinfo->get_filesize();
460         $file['fileurl']      = file_encode_url("$CFG->wwwroot/" . $baseurl, '/'.$context->id.'/mod_resource/content/'.$resource->revision.$fileinfo->get_filepath().$fileinfo->get_filename(), true);
461         $file['timecreated']  = $fileinfo->get_timecreated();
462         $file['timemodified'] = $fileinfo->get_timemodified();
463         $file['sortorder']    = $fileinfo->get_sortorder();
464         $file['userid']       = $fileinfo->get_userid();
465         $file['author']       = $fileinfo->get_author();
466         $file['license']      = $fileinfo->get_license();
467         $file['mimetype']     = $fileinfo->get_mimetype();
468         $file['isexternalfile'] = $fileinfo->is_external_file();
469         if ($file['isexternalfile']) {
470             $file['repositorytype'] = $fileinfo->get_repository_type();
471         }
472         $contents[] = $file;
473     }
475     return $contents;
478 /**
479  * Register the ability to handle drag and drop file uploads
480  * @return array containing details of the files / types the mod can handle
481  */
482 function resource_dndupload_register() {
483     return array('files' => array(
484                      array('extension' => '*', 'message' => get_string('dnduploadresource', 'mod_resource'))
485                  ));
488 /**
489  * Handle a file that has been uploaded
490  * @param object $uploadinfo details of the file / content that has been uploaded
491  * @return int instance id of the newly created mod
492  */
493 function resource_dndupload_handle($uploadinfo) {
494     // Gather the required info.
495     $data = new stdClass();
496     $data->course = $uploadinfo->course->id;
497     $data->name = $uploadinfo->displayname;
498     $data->intro = '';
499     $data->introformat = FORMAT_HTML;
500     $data->coursemodule = $uploadinfo->coursemodule;
501     $data->files = $uploadinfo->draftitemid;
503     // Set the display options to the site defaults.
504     $config = get_config('resource');
505     $data->display = $config->display;
506     $data->popupheight = $config->popupheight;
507     $data->popupwidth = $config->popupwidth;
508     $data->printintro = $config->printintro;
509     $data->showsize = (isset($config->showsize)) ? $config->showsize : 0;
510     $data->showtype = (isset($config->showtype)) ? $config->showtype : 0;
511     $data->showdate = (isset($config->showdate)) ? $config->showdate : 0;
512     $data->filterfiles = $config->filterfiles;
514     return resource_add_instance($data, null);
517 /**
518  * Mark the activity completed (if required) and trigger the course_module_viewed event.
519  *
520  * @param  stdClass $resource   resource object
521  * @param  stdClass $course     course object
522  * @param  stdClass $cm         course module object
523  * @param  stdClass $context    context object
524  * @since Moodle 3.0
525  */
526 function resource_view($resource, $course, $cm, $context) {
528     // Trigger course_module_viewed event.
529     $params = array(
530         'context' => $context,
531         'objectid' => $resource->id
532     );
534     $event = \mod_resource\event\course_module_viewed::create($params);
535     $event->add_record_snapshot('course_modules', $cm);
536     $event->add_record_snapshot('course', $course);
537     $event->add_record_snapshot('resource', $resource);
538     $event->trigger();
540     // Completion.
541     $completion = new completion_info($course);
542     $completion->set_module_viewed($cm);
545 /**
546  * Check if the module has any update that affects the current user since a given time.
547  *
548  * @param  cm_info $cm course module data
549  * @param  int $from the time to check updates from
550  * @param  array $filter  if we need to check only specific updates
551  * @return stdClass an object with the different type of areas indicating if they were updated or not
552  * @since Moodle 3.2
553  */
554 function resource_check_updates_since(cm_info $cm, $from, $filter = array()) {
555     $updates = course_check_module_updates_since($cm, $from, array('content'), $filter);
556     return $updates;
559 /**
560  * This function receives a calendar event and returns the action associated with it, or null if there is none.
561  *
562  * This is used by block_myoverview in order to display the event appropriately. If null is returned then the event
563  * is not displayed on the block.
564  *
565  * @param calendar_event $event
566  * @param \core_calendar\action_factory $factory
567  * @return \core_calendar\local\event\entities\action_interface|null
568  */
569 function mod_resource_core_calendar_provide_event_action(calendar_event $event,
570                                                       \core_calendar\action_factory $factory) {
571     $cm = get_fast_modinfo($event->courseid)->instances['resource'][$event->instance];
573     $completion = new \completion_info($cm->get_course());
575     $completiondata = $completion->get_data($cm, false);
577     if ($completiondata->completionstate != COMPLETION_INCOMPLETE) {
578         return null;
579     }
581     return $factory->create_instance(
582         get_string('view'),
583         new \moodle_url('/mod/resource/view.php', ['id' => $cm->id]),
584         1,
585         true
586     );