weekly release 3.0dev
[moodle.git] / mod / resource / lib.php
CommitLineData
28f672b2 1<?php
2
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/>.
2a439ba7 17
28f672b2 18/**
11e41f1a 19 * @package mod_resource
702ab58c
PS
20 * @copyright 2009 Petr Skoda {@link http://skodak.org}
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28f672b2 22 */
23
702ab58c
PS
24defined('MOODLE_INTERNAL') || die;
25
aa54ed7b 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 */
31function 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;
aa54ed7b 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;
a345de6e 40 case FEATURE_BACKUP_MOODLE2: return true;
3e4c2435 41 case FEATURE_SHOW_DESCRIPTION: return true;
214b1cf7 42
aa54ed7b 43 default: return null;
44 }
45}
713d78ea 46
28f672b2 47/**
aa54ed7b 48 * Returns all other caps used in module
49 * @return array
28f672b2 50 */
aa54ed7b 51function resource_get_extra_capabilities() {
52 return array('moodle/site:accessallgroups');
53}
3d30a455 54
d18830fe 55/**
aa54ed7b 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
28f672b2 59 */
aa54ed7b 60function resource_reset_userdata($data) {
61 return array();
62}
65634a81 63
aa54ed7b 64/**
b2b4ec30
RT
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 *
aa54ed7b 72 * @return array
73 */
74function resource_get_view_actions() {
cf051cc4 75 return array('view','view all');
aa54ed7b 76}
65634a81 77
aa54ed7b 78/**
b2b4ec30
RT
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 *
aa54ed7b 86 * @return array
87 */
88function resource_get_post_actions() {
cf051cc4 89 return array('update', 'add');
aa54ed7b 90}
65634a81 91
aa54ed7b 92/**
93 * Add resource instance.
94 * @param object $data
95 * @param object $mform
c6c9a3bc 96 * @return int new resource instance id
aa54ed7b 97 */
98function resource_add_instance($data, $mform) {
99 global $CFG, $DB;
100 require_once("$CFG->libdir/resourcelib.php");
abed5d65 101 require_once("$CFG->dirroot/mod/resource/locallib.php");
f79321f1 102 $cmid = $data->coursemodule;
aa54ed7b 103 $data->timemodified = time();
a2c57666 104
105 resource_set_display_options($data);
d18830fe 106
aa54ed7b 107 $data->id = $DB->insert_record('resource', $data);
d18830fe 108
aa54ed7b 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));
f79321f1 111 resource_set_mainfile($data);
aa54ed7b 112 return $data->id;
113}
cccb016a 114
aa54ed7b 115/**
116 * Update resource instance.
117 * @param object $data
118 * @param object $mform
119 * @return bool true
120 */
121function resource_update_instance($data, $mform) {
122 global $CFG, $DB;
123 require_once("$CFG->libdir/resourcelib.php");
aa54ed7b 124 $data->timemodified = time();
125 $data->id = $data->instance;
126 $data->revision++;
2a439ba7 127
a2c57666 128 resource_set_display_options($data);
129
130 $DB->update_record('resource', $data);
131 resource_set_mainfile($data);
132 return true;
133}
134
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 */
142function resource_set_display_options($data) {
aa54ed7b 143 $displayoptions = array();
144 if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
145 $displayoptions['popupwidth'] = $data->popupwidth;
146 $displayoptions['popupheight'] = $data->popupheight;
65634a81 147 }
aa54ed7b 148 if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
aa54ed7b 149 $displayoptions['printintro'] = (int)!empty($data->printintro);
3efe78df 150 }
a2c57666 151 if (!empty($data->showsize)) {
152 $displayoptions['showsize'] = 1;
153 }
154 if (!empty($data->showtype)) {
155 $displayoptions['showtype'] = 1;
156 }
aa54ed7b 157 $data->displayoptions = serialize($displayoptions);
d18830fe 158}
159
28f672b2 160/**
aa54ed7b 161 * Delete resource instance.
28f672b2 162 * @param int $id
aa54ed7b 163 * @return bool true
28f672b2 164 */
d18830fe 165function resource_delete_instance($id) {
aa54ed7b 166 global $DB;
ec81373f 167
aa54ed7b 168 if (!$resource = $DB->get_record('resource', array('id'=>$id))) {
d18830fe 169 return false;
170 }
79035d46 171
aa54ed7b 172 // note: all context files are deleted automatically
ec81373f 173
aa54ed7b 174 $DB->delete_records('resource', array('id'=>$resource->id));
d18830fe 175
aa54ed7b 176 return true;
d18830fe 177}
178
28f672b2 179/**
180 * Given a course_module object, this function returns any
181 * "extra" information that may be needed when printing
182 * this activity in a course listing.
183 *
184 * See {@link get_array_of_activities()} in course/lib.php
185 *
3c620d7f 186 * @param stdClass $coursemodule
3e4c2435 187 * @return cached_cm_info info
28f672b2 188 */
8dddba42 189function resource_get_coursemodule_info($coursemodule) {
aa54ed7b 190 global $CFG, $DB;
191 require_once("$CFG->libdir/filelib.php");
192 require_once("$CFG->dirroot/mod/resource/locallib.php");
516c5eca
PS
193 require_once($CFG->libdir.'/completionlib.php');
194
bf0f06b1 195 $context = context_module::instance($coursemodule->id);
ec81373f 196
3e4c2435 197 if (!$resource = $DB->get_record('resource', array('id'=>$coursemodule->instance),
198 'id, name, display, displayoptions, tobemigrated, revision, intro, introformat')) {
aa54ed7b 199 return NULL;
af65e103 200 }
ec81373f 201
3e4c2435 202 $info = new cached_cm_info();
aa54ed7b 203 $info->name = $resource->name;
3e4c2435 204 if ($coursemodule->showdescription) {
205 // Convert intro to html. Do not filter cached version, filters run at display time.
206 $info->content = format_module_intro('resource', $resource, $coursemodule->id, false);
207 }
8dddba42 208
aa54ed7b 209 if ($resource->tobemigrated) {
c3847443 210 $info->icon ='i/invalid';
aa54ed7b 211 return $info;
af65e103 212 }
f79321f1 213 $fs = get_file_storage();
3d8f1d3a 214 $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false); // TODO: this is not very efficient!!
f79321f1 215 if (count($files) >= 1) {
020088d6 216 $mainfile = reset($files);
72225e18 217 $info->icon = file_file_icon($mainfile, 24);
f79321f1
DC
218 $resource->mainfile = $mainfile->get_filename();
219 }
d18830fe 220
aa54ed7b 221 $display = resource_get_final_display_type($resource);
9f741612 222
aa54ed7b 223 if ($display == RESOURCELIB_DISPLAY_POPUP) {
224 $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
225 $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
226 $width = empty($options['popupwidth']) ? 620 : $options['popupwidth'];
227 $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
228 $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
3e4c2435 229 $info->onclick = "window.open('$fullurl', '', '$wh'); return false;";
6da4b261 230
aa54ed7b 231 } else if ($display == RESOURCELIB_DISPLAY_NEW) {
232 $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
3e4c2435 233 $info->onclick = "window.open('$fullurl'); return false;";
6da4b261 234
6da4b261 235 }
89bfeee0 236
a2c57666 237 // If any optional extra details are turned on, store in custom data
238 $info->customdata = resource_get_optional_details($resource, $coursemodule);
239
aa54ed7b 240 return $info;
6da4b261 241}
f3221af9 242
a2c57666 243/**
244 * Called when viewing course page. Shows extra details after the link if
245 * enabled.
246 *
247 * @param cm_info $cm Course module information
248 */
249function resource_cm_info_view(cm_info $cm) {
73ee2fda 250 $details = $cm->customdata;
a2c57666 251 if ($details) {
252 $cm->set_after_link(' ' . html_writer::tag('span', $details,
253 array('class' => 'resourcelinkdetails')));
254 }
255}
f3221af9 256
28f672b2 257/**
aa54ed7b 258 * Lists all browsable file areas
d2b7803e
DC
259 *
260 * @package mod_resource
261 * @category files
262 * @param stdClass $course course object
263 * @param stdClass $cm course module object
264 * @param stdClass $context context object
28f672b2 265 * @return array
266 */
aa54ed7b 267function resource_get_file_areas($course, $cm, $context) {
268 $areas = array();
64f93798 269 $areas['content'] = get_string('resourcecontent', 'resource');
aa54ed7b 270 return $areas;
f3221af9 271}
272
28f672b2 273/**
f1b8bcf7 274 * File browsing support for resource module content area.
d2b7803e
DC
275 *
276 * @package mod_resource
277 * @category files
278 * @param stdClass $browser file browser instance
279 * @param stdClass $areas file areas
280 * @param stdClass $course course object
281 * @param stdClass $cm course module object
282 * @param stdClass $context context object
283 * @param string $filearea file area
284 * @param int $itemid item ID
285 * @param string $filepath file path
286 * @param string $filename file name
287 * @return file_info instance or null if not found
28f672b2 288 */
aa54ed7b 289function resource_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
290 global $CFG;
a69be0d8 291
64f93798
PS
292 if (!has_capability('moodle/course:managefiles', $context)) {
293 // students can not peak here!
294 return null;
295 }
a69be0d8 296
aa54ed7b 297 $fs = get_file_storage();
a69be0d8 298
64f93798 299 if ($filearea === 'content') {
aa54ed7b 300 $filepath = is_null($filepath) ? '/' : $filepath;
301 $filename = is_null($filename) ? '.' : $filename;
a69be0d8 302
aa54ed7b 303 $urlbase = $CFG->wwwroot.'/pluginfile.php';
64f93798 304 if (!$storedfile = $fs->get_file($context->id, 'mod_resource', 'content', 0, $filepath, $filename)) {
aa54ed7b 305 if ($filepath === '/' and $filename === '.') {
64f93798 306 $storedfile = new virtual_root_file($context->id, 'mod_resource', 'content', 0);
a69be0d8 307 } else {
aa54ed7b 308 // not found
309 return null;
a69be0d8 310 }
311 }
aa54ed7b 312 require_once("$CFG->dirroot/mod/resource/locallib.php");
64f93798 313 return new resource_content_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, true, false);
a69be0d8 314 }
315
aa54ed7b 316 // note: resource_intro handled in file_browser automatically
a69be0d8 317
aa54ed7b 318 return null;
a69be0d8 319}
320
0b5a80a1 321/**
aa54ed7b 322 * Serves the resource files.
d2b7803e
DC
323 *
324 * @package mod_resource
325 * @category files
326 * @param stdClass $course course object
327 * @param stdClass $cm course module object
328 * @param stdClass $context context object
329 * @param string $filearea file area
330 * @param array $args extra arguments
331 * @param bool $forcedownload whether or not force download
261cbbac 332 * @param array $options additional options affecting the file serving
b4ff85aa 333 * @return bool false if file not found, does not return if found - just send the file
28f672b2 334 */
261cbbac 335function resource_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
aa54ed7b 336 global $CFG, $DB;
337 require_once("$CFG->libdir/resourcelib.php");
0d06b6fd 338
64f93798 339 if ($context->contextlevel != CONTEXT_MODULE) {
aa54ed7b 340 return false;
3efe78df 341 }
342
64f93798 343 require_course_login($course, true, $cm);
ce459060
PS
344 if (!has_capability('mod/resource:view', $context)) {
345 return false;
346 }
3efe78df 347
64f93798
PS
348 if ($filearea !== 'content') {
349 // intro is handled automatically in pluginfile.php
aa54ed7b 350 return false;
3efe78df 351 }
352
aa54ed7b 353 array_shift($args); // ignore revision - designed to prevent caching problems only
3efe78df 354
aa54ed7b 355 $fs = get_file_storage();
64f93798 356 $relativepath = implode('/', $args);
fe3c5dae
PS
357 $fullpath = rtrim("/$context->id/mod_resource/$filearea/0/$relativepath", '/');
358 do {
359 if (!$file = $fs->get_file_by_hash(sha1($fullpath))) {
9815ccee 360 if ($fs->get_file_by_hash(sha1("$fullpath/."))) {
fe3c5dae
PS
361 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.htm"))) {
362 break;
363 }
364 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.html"))) {
365 break;
366 }
367 if ($file = $fs->get_file_by_hash(sha1("$fullpath/Default.htm"))) {
368 break;
369 }
370 }
371 $resource = $DB->get_record('resource', array('id'=>$cm->instance), 'id, legacyfiles', MUST_EXIST);
372 if ($resource->legacyfiles != RESOURCELIB_LEGACYFILES_ACTIVE) {
373 return false;
374 }
375 if (!$file = resourcelib_try_file_migration('/'.$relativepath, $cm->id, $cm->course, 'mod_resource', 'content', 0)) {
376 return false;
377 }
378 // file migrate - update flag
379 $resource->legacyfileslast = time();
380 $DB->update_record('resource', $resource);
0d06b6fd 381 }
fe3c5dae 382 } while (false);
ffcfd8a7 383
aa54ed7b 384 // should we apply filters?
385 $mimetype = $file->get_mimetype();
112aed60 386 if ($mimetype === 'text/html' or $mimetype === 'text/plain' or $mimetype === 'application/xhtml+xml') {
64f93798 387 $filter = $DB->get_field('resource', 'filterfiles', array('id'=>$cm->instance));
4eaa964f 388 $CFG->embeddedsoforcelinktarget = true;
aa54ed7b 389 } else {
390 $filter = 0;
18a2a0cb 391 }
18a2a0cb 392
aa54ed7b 393 // finally send the file
0c431257 394 send_stored_file($file, null, $filter, $forcedownload, $options);
13ca1e06 395}
b1627a92
DC
396
397/**
398 * Return a list of page types
399 * @param string $pagetype current page type
400 * @param stdClass $parentcontext Block's parent context
401 * @param stdClass $currentcontext Current context of block
402 */
b38e2e28 403function resource_page_type_list($pagetype, $parentcontext, $currentcontext) {
b1627a92
DC
404 $module_pagetype = array('mod-resource-*'=>get_string('page-mod-resource-x', 'resource'));
405 return $module_pagetype;
406}
ec0d6ea2
DC
407
408/**
409 * Export file resource contents
410 *
411 * @return array of file content
412 */
413function resource_export_contents($cm, $baseurl) {
414 global $CFG, $DB;
415 $contents = array();
bf0f06b1 416 $context = context_module::instance($cm->id);
ec0d6ea2
DC
417 $resource = $DB->get_record('resource', array('id'=>$cm->instance), '*', MUST_EXIST);
418
419 $fs = get_file_storage();
420 $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false);
421
422 foreach ($files as $fileinfo) {
423 $file = array();
424 $file['type'] = 'file';
425 $file['filename'] = $fileinfo->get_filename();
426 $file['filepath'] = $fileinfo->get_filepath();
427 $file['filesize'] = $fileinfo->get_filesize();
428 $file['fileurl'] = file_encode_url("$CFG->wwwroot/" . $baseurl, '/'.$context->id.'/mod_resource/content/'.$resource->revision.$fileinfo->get_filepath().$fileinfo->get_filename(), true);
429 $file['timecreated'] = $fileinfo->get_timecreated();
430 $file['timemodified'] = $fileinfo->get_timemodified();
431 $file['sortorder'] = $fileinfo->get_sortorder();
432 $file['userid'] = $fileinfo->get_userid();
433 $file['author'] = $fileinfo->get_author();
434 $file['license'] = $fileinfo->get_license();
435 $contents[] = $file;
436 }
437
438 return $contents;
439}
32528f94
DS
440
441/**
442 * Register the ability to handle drag and drop file uploads
443 * @return array containing details of the files / types the mod can handle
444 */
6b8b0b2e 445function resource_dndupload_register() {
32528f94
DS
446 return array('files' => array(
447 array('extension' => '*', 'message' => get_string('dnduploadresource', 'mod_resource'))
448 ));
449}
450
451/**
452 * Handle a file that has been uploaded
453 * @param object $uploadinfo details of the file / content that has been uploaded
454 * @return int instance id of the newly created mod
455 */
6b8b0b2e 456function resource_dndupload_handle($uploadinfo) {
abed5d65
DS
457 // Gather the required info.
458 $data = new stdClass();
459 $data->course = $uploadinfo->course->id;
460 $data->name = $uploadinfo->displayname;
5fece0f2 461 $data->intro = '';
abed5d65
DS
462 $data->introformat = FORMAT_HTML;
463 $data->coursemodule = $uploadinfo->coursemodule;
464 $data->files = $uploadinfo->draftitemid;
465
466 // Set the display options to the site defaults.
32528f94 467 $config = get_config('resource');
abed5d65
DS
468 $data->display = $config->display;
469 $data->popupheight = $config->popupheight;
470 $data->popupwidth = $config->popupwidth;
abed5d65 471 $data->printintro = $config->printintro;
10654e32
SH
472 $data->showsize = (isset($config->showsize)) ? $config->showsize : 0;
473 $data->showtype = (isset($config->showtype)) ? $config->showtype : 0;
a274df85 474 $data->filterfiles = $config->filterfiles;
32528f94 475
abed5d65 476 return resource_add_instance($data, null);
32528f94 477}