e786687611f160ce1ca1cad6cd4f1407fee649ab
[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);
112     return $data->id;
115 /**
116  * Update resource instance.
117  * @param object $data
118  * @param object $mform
119  * @return bool true
120  */
121 function resource_update_instance($data, $mform) {
122     global $CFG, $DB;
123     require_once("$CFG->libdir/resourcelib.php");
124     $data->timemodified = time();
125     $data->id           = $data->instance;
126     $data->revision++;
128     resource_set_display_options($data);
130     $DB->update_record('resource', $data);
131     resource_set_mainfile($data);
132     return true;
135 /**
136  * Updates display options based on form input.
137  *
138  * Shared code used by resource_add_instance and resource_update_instance.
139  *
140  * @param object $data Data object
141  */
142 function resource_set_display_options($data) {
143     $displayoptions = array();
144     if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
145         $displayoptions['popupwidth']  = $data->popupwidth;
146         $displayoptions['popupheight'] = $data->popupheight;
147     }
148     if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
149         $displayoptions['printintro']   = (int)!empty($data->printintro);
150     }
151     if (!empty($data->showsize)) {
152         $displayoptions['showsize'] = 1;
153     }
154     if (!empty($data->showtype)) {
155         $displayoptions['showtype'] = 1;
156     }
157     if (!empty($data->showdate)) {
158         $displayoptions['showdate'] = 1;
159     }
160     $data->displayoptions = serialize($displayoptions);
163 /**
164  * Delete resource instance.
165  * @param int $id
166  * @return bool true
167  */
168 function resource_delete_instance($id) {
169     global $DB;
171     if (!$resource = $DB->get_record('resource', array('id'=>$id))) {
172         return false;
173     }
175     // note: all context files are deleted automatically
177     $DB->delete_records('resource', array('id'=>$resource->id));
179     return true;
182 /**
183  * Given a course_module object, this function returns any
184  * "extra" information that may be needed when printing
185  * this activity in a course listing.
186  *
187  * See {@link get_array_of_activities()} in course/lib.php
188  *
189  * @param stdClass $coursemodule
190  * @return cached_cm_info info
191  */
192 function resource_get_coursemodule_info($coursemodule) {
193     global $CFG, $DB;
194     require_once("$CFG->libdir/filelib.php");
195     require_once("$CFG->dirroot/mod/resource/locallib.php");
196     require_once($CFG->libdir.'/completionlib.php');
198     $context = context_module::instance($coursemodule->id);
200     if (!$resource = $DB->get_record('resource', array('id'=>$coursemodule->instance),
201             'id, name, display, displayoptions, tobemigrated, revision, intro, introformat')) {
202         return NULL;
203     }
205     $info = new cached_cm_info();
206     $info->name = $resource->name;
207     if ($coursemodule->showdescription) {
208         // Convert intro to html. Do not filter cached version, filters run at display time.
209         $info->content = format_module_intro('resource', $resource, $coursemodule->id, false);
210     }
212     if ($resource->tobemigrated) {
213         $info->icon ='i/invalid';
214         return $info;
215     }
216     $fs = get_file_storage();
217     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false); // TODO: this is not very efficient!!
218     if (count($files) >= 1) {
219         $mainfile = reset($files);
220         $info->icon = file_file_icon($mainfile, 24);
221         $resource->mainfile = $mainfile->get_filename();
222     }
224     $display = resource_get_final_display_type($resource);
226     if ($display == RESOURCELIB_DISPLAY_POPUP) {
227         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
228         $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
229         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
230         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
231         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
232         $info->onclick = "window.open('$fullurl', '', '$wh'); return false;";
234     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
235         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
236         $info->onclick = "window.open('$fullurl'); return false;";
238     }
240     // If any optional extra details are turned on, store in custom data
241     $info->customdata = $resource->displayoptions;
243     return $info;
246 /**
247  * Called when viewing course page. Shows extra details after the link if
248  * enabled.
249  *
250  * @param cm_info $cm Course module information
251  */
252 function resource_cm_info_view(cm_info $cm) {
253     global $CFG;
254     require_once($CFG->dirroot . '/mod/resource/locallib.php');
256     $resource = (object)array('displayoptions' => $cm->customdata);
257     $details = resource_get_optional_details($resource, $cm);
258     if ($details) {
259         $cm->set_after_link(' ' . html_writer::tag('span', $details,
260                 array('class' => 'resourcelinkdetails')));
261     }
264 /**
265  * Lists all browsable file areas
266  *
267  * @package  mod_resource
268  * @category files
269  * @param stdClass $course course object
270  * @param stdClass $cm course module object
271  * @param stdClass $context context object
272  * @return array
273  */
274 function resource_get_file_areas($course, $cm, $context) {
275     $areas = array();
276     $areas['content'] = get_string('resourcecontent', 'resource');
277     return $areas;
280 /**
281  * File browsing support for resource module content area.
282  *
283  * @package  mod_resource
284  * @category files
285  * @param stdClass $browser file browser instance
286  * @param stdClass $areas file areas
287  * @param stdClass $course course object
288  * @param stdClass $cm course module object
289  * @param stdClass $context context object
290  * @param string $filearea file area
291  * @param int $itemid item ID
292  * @param string $filepath file path
293  * @param string $filename file name
294  * @return file_info instance or null if not found
295  */
296 function resource_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
297     global $CFG;
299     if (!has_capability('moodle/course:managefiles', $context)) {
300         // students can not peak here!
301         return null;
302     }
304     $fs = get_file_storage();
306     if ($filearea === 'content') {
307         $filepath = is_null($filepath) ? '/' : $filepath;
308         $filename = is_null($filename) ? '.' : $filename;
310         $urlbase = $CFG->wwwroot.'/pluginfile.php';
311         if (!$storedfile = $fs->get_file($context->id, 'mod_resource', 'content', 0, $filepath, $filename)) {
312             if ($filepath === '/' and $filename === '.') {
313                 $storedfile = new virtual_root_file($context->id, 'mod_resource', 'content', 0);
314             } else {
315                 // not found
316                 return null;
317             }
318         }
319         require_once("$CFG->dirroot/mod/resource/locallib.php");
320         return new resource_content_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, true, false);
321     }
323     // note: resource_intro handled in file_browser automatically
325     return null;
328 /**
329  * Serves the resource files.
330  *
331  * @package  mod_resource
332  * @category files
333  * @param stdClass $course course object
334  * @param stdClass $cm course module object
335  * @param stdClass $context context object
336  * @param string $filearea file area
337  * @param array $args extra arguments
338  * @param bool $forcedownload whether or not force download
339  * @param array $options additional options affecting the file serving
340  * @return bool false if file not found, does not return if found - just send the file
341  */
342 function resource_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
343     global $CFG, $DB;
344     require_once("$CFG->libdir/resourcelib.php");
346     if ($context->contextlevel != CONTEXT_MODULE) {
347         return false;
348     }
350     require_course_login($course, true, $cm);
351     if (!has_capability('mod/resource:view', $context)) {
352         return false;
353     }
355     if ($filearea !== 'content') {
356         // intro is handled automatically in pluginfile.php
357         return false;
358     }
360     array_shift($args); // ignore revision - designed to prevent caching problems only
362     $fs = get_file_storage();
363     $relativepath = implode('/', $args);
364     $fullpath = rtrim("/$context->id/mod_resource/$filearea/0/$relativepath", '/');
365     do {
366         if (!$file = $fs->get_file_by_hash(sha1($fullpath))) {
367             if ($fs->get_file_by_hash(sha1("$fullpath/."))) {
368                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.htm"))) {
369                     break;
370                 }
371                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.html"))) {
372                     break;
373                 }
374                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/Default.htm"))) {
375                     break;
376                 }
377             }
378             $resource = $DB->get_record('resource', array('id'=>$cm->instance), 'id, legacyfiles', MUST_EXIST);
379             if ($resource->legacyfiles != RESOURCELIB_LEGACYFILES_ACTIVE) {
380                 return false;
381             }
382             if (!$file = resourcelib_try_file_migration('/'.$relativepath, $cm->id, $cm->course, 'mod_resource', 'content', 0)) {
383                 return false;
384             }
385             // file migrate - update flag
386             $resource->legacyfileslast = time();
387             $DB->update_record('resource', $resource);
388         }
389     } while (false);
391     // should we apply filters?
392     $mimetype = $file->get_mimetype();
393     if ($mimetype === 'text/html' or $mimetype === 'text/plain' or $mimetype === 'application/xhtml+xml') {
394         $filter = $DB->get_field('resource', 'filterfiles', array('id'=>$cm->instance));
395         $CFG->embeddedsoforcelinktarget = true;
396     } else {
397         $filter = 0;
398     }
400     // finally send the file
401     send_stored_file($file, null, $filter, $forcedownload, $options);
404 /**
405  * Return a list of page types
406  * @param string $pagetype current page type
407  * @param stdClass $parentcontext Block's parent context
408  * @param stdClass $currentcontext Current context of block
409  */
410 function resource_page_type_list($pagetype, $parentcontext, $currentcontext) {
411     $module_pagetype = array('mod-resource-*'=>get_string('page-mod-resource-x', 'resource'));
412     return $module_pagetype;
415 /**
416  * Export file resource contents
417  *
418  * @return array of file content
419  */
420 function resource_export_contents($cm, $baseurl) {
421     global $CFG, $DB;
422     $contents = array();
423     $context = context_module::instance($cm->id);
424     $resource = $DB->get_record('resource', array('id'=>$cm->instance), '*', MUST_EXIST);
426     $fs = get_file_storage();
427     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false);
429     foreach ($files as $fileinfo) {
430         $file = array();
431         $file['type'] = 'file';
432         $file['filename']     = $fileinfo->get_filename();
433         $file['filepath']     = $fileinfo->get_filepath();
434         $file['filesize']     = $fileinfo->get_filesize();
435         $file['fileurl']      = file_encode_url("$CFG->wwwroot/" . $baseurl, '/'.$context->id.'/mod_resource/content/'.$resource->revision.$fileinfo->get_filepath().$fileinfo->get_filename(), true);
436         $file['timecreated']  = $fileinfo->get_timecreated();
437         $file['timemodified'] = $fileinfo->get_timemodified();
438         $file['sortorder']    = $fileinfo->get_sortorder();
439         $file['userid']       = $fileinfo->get_userid();
440         $file['author']       = $fileinfo->get_author();
441         $file['license']      = $fileinfo->get_license();
442         $contents[] = $file;
443     }
445     return $contents;
448 /**
449  * Register the ability to handle drag and drop file uploads
450  * @return array containing details of the files / types the mod can handle
451  */
452 function resource_dndupload_register() {
453     return array('files' => array(
454                      array('extension' => '*', 'message' => get_string('dnduploadresource', 'mod_resource'))
455                  ));
458 /**
459  * Handle a file that has been uploaded
460  * @param object $uploadinfo details of the file / content that has been uploaded
461  * @return int instance id of the newly created mod
462  */
463 function resource_dndupload_handle($uploadinfo) {
464     // Gather the required info.
465     $data = new stdClass();
466     $data->course = $uploadinfo->course->id;
467     $data->name = $uploadinfo->displayname;
468     $data->intro = '';
469     $data->introformat = FORMAT_HTML;
470     $data->coursemodule = $uploadinfo->coursemodule;
471     $data->files = $uploadinfo->draftitemid;
473     // Set the display options to the site defaults.
474     $config = get_config('resource');
475     $data->display = $config->display;
476     $data->popupheight = $config->popupheight;
477     $data->popupwidth = $config->popupwidth;
478     $data->printintro = $config->printintro;
479     $data->showsize = (isset($config->showsize)) ? $config->showsize : 0;
480     $data->showtype = (isset($config->showtype)) ? $config->showtype : 0;
481     $data->showdate = (isset($config->showdate)) ? $config->showdate : 0;
482     $data->filterfiles = $config->filterfiles;
484     return resource_add_instance($data, null);
487 /**
488  * Mark the activity completed (if required) and trigger the course_module_viewed event.
489  *
490  * @param  stdClass $resource   resource object
491  * @param  stdClass $course     course object
492  * @param  stdClass $cm         course module object
493  * @param  stdClass $context    context object
494  * @since Moodle 3.0
495  */
496 function resource_view($resource, $course, $cm, $context) {
498     // Trigger course_module_viewed event.
499     $params = array(
500         'context' => $context,
501         'objectid' => $resource->id
502     );
504     $event = \mod_resource\event\course_module_viewed::create($params);
505     $event->add_record_snapshot('course_modules', $cm);
506     $event->add_record_snapshot('course', $course);
507     $event->add_record_snapshot('resource', $resource);
508     $event->trigger();
510     // Completion.
511     $completion = new completion_info($course);
512     $completion->set_module_viewed($cm);