MDL-28221 resource: fixed a typo in variable names
[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
20  * @subpackage resource
21  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die;
27 /**
28  * List of features supported in Resource module
29  * @param string $feature FEATURE_xx constant for requested feature
30  * @return mixed True if module supports feature, false if not, null if doesn't know
31  */
32 function resource_supports($feature) {
33     switch($feature) {
34         case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;
35         case FEATURE_GROUPS:                  return false;
36         case FEATURE_GROUPINGS:               return false;
37         case FEATURE_GROUPMEMBERSONLY:        return true;
38         case FEATURE_MOD_INTRO:               return true;
39         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
40         case FEATURE_GRADE_HAS_GRADE:         return false;
41         case FEATURE_GRADE_OUTCOMES:          return false;
42         case FEATURE_BACKUP_MOODLE2:          return true;
44         default: return null;
45     }
46 }
48 /**
49  * Returns all other caps used in module
50  * @return array
51  */
52 function resource_get_extra_capabilities() {
53     return array('moodle/site:accessallgroups');
54 }
56 /**
57  * This function is used by the reset_course_userdata function in moodlelib.
58  * @param $data the data submitted from the reset course.
59  * @return array status array
60  */
61 function resource_reset_userdata($data) {
62     return array();
63 }
65 /**
66  * List of view style log actions
67  * @return array
68  */
69 function resource_get_view_actions() {
70     return array('view','view all');
71 }
73 /**
74  * List of update style log actions
75  * @return array
76  */
77 function resource_get_post_actions() {
78     return array('update', 'add');
79 }
81 /**
82  * Add resource instance.
83  * @param object $data
84  * @param object $mform
85  * @return int new resource instance id
86  */
87 function resource_add_instance($data, $mform) {
88     global $CFG, $DB;
89     require_once("$CFG->libdir/resourcelib.php");
90     $cmid = $data->coursemodule;
91     $data->timemodified = time();
92     $displayoptions = array();
93     if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
94         $displayoptions['popupwidth']  = $data->popupwidth;
95         $displayoptions['popupheight'] = $data->popupheight;
96     }
97     if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
98         $displayoptions['printheading'] = (int)!empty($data->printheading);
99         $displayoptions['printintro']   = (int)!empty($data->printintro);
100     }
101     $data->displayoptions = serialize($displayoptions);
103     $data->id = $DB->insert_record('resource', $data);
105     // we need to use context now, so we need to make sure all needed info is already in db
106     $DB->set_field('course_modules', 'instance', $data->id, array('id'=>$cmid));
107     resource_set_mainfile($data);
108     return $data->id;
111 /**
112  * Update resource instance.
113  * @param object $data
114  * @param object $mform
115  * @return bool true
116  */
117 function resource_update_instance($data, $mform) {
118     global $CFG, $DB;
119     require_once("$CFG->libdir/resourcelib.php");
120     $data->timemodified = time();
121     $data->id           = $data->instance;
122     $data->revision++;
124     $displayoptions = array();
125     if ($data->display == RESOURCELIB_DISPLAY_POPUP) {
126         $displayoptions['popupwidth']  = $data->popupwidth;
127         $displayoptions['popupheight'] = $data->popupheight;
128     }
129     if (in_array($data->display, array(RESOURCELIB_DISPLAY_AUTO, RESOURCELIB_DISPLAY_EMBED, RESOURCELIB_DISPLAY_FRAME))) {
130         $displayoptions['printheading'] = (int)!empty($data->printheading);
131         $displayoptions['printintro']   = (int)!empty($data->printintro);
132     }
133     $data->displayoptions = serialize($displayoptions);
135     $DB->update_record('resource', $data);
136     resource_set_mainfile($data);
137     return true;
140 /**
141  * Delete resource instance.
142  * @param int $id
143  * @return bool true
144  */
145 function resource_delete_instance($id) {
146     global $DB;
148     if (!$resource = $DB->get_record('resource', array('id'=>$id))) {
149         return false;
150     }
152     // note: all context files are deleted automatically
154     $DB->delete_records('resource', array('id'=>$resource->id));
156     return true;
159 /**
160  * Return use outline
161  * @param object $course
162  * @param object $user
163  * @param object $mod
164  * @param object $resource
165  * @return object|null
166  */
167 function resource_user_outline($course, $user, $mod, $resource) {
168     global $DB;
170     if ($logs = $DB->get_records('log', array('userid'=>$user->id, 'module'=>'resource',
171                                               'action'=>'view', 'info'=>$resource->id), 'time ASC')) {
173         $numviews = count($logs);
174         $lastlog = array_pop($logs);
176         $result = new stdClass();
177         $result->info = get_string('numviews', '', $numviews);
178         $result->time = $lastlog->time;
180         return $result;
181     }
182     return NULL;
185 /**
186  * Return use complete
187  * @param object $course
188  * @param object $user
189  * @param object $mod
190  * @param object $resource
191  */
192 function resource_user_complete($course, $user, $mod, $resource) {
193     global $CFG, $DB;
195     if ($logs = $DB->get_records('log', array('userid'=>$user->id, 'module'=>'resource',
196                                               'action'=>'view', 'info'=>$resource->id), 'time ASC')) {
197         $numviews = count($logs);
198         $lastlog = array_pop($logs);
200         $strmostrecently = get_string('mostrecently');
201         $strnumviews = get_string('numviews', '', $numviews);
203         echo "$strnumviews - $strmostrecently ".userdate($lastlog->time);
205     } else {
206         print_string('neverseen', 'resource');
207     }
210 /**
211  * Returns the users with data in one resource
212  *
213  * @todo: deprecated - to be deleted in 2.2
214  *
215  * @param int $resourceid
216  * @return bool false
217  */
218 function resource_get_participants($resourceid) {
219     return false;
222 /**
223  * Given a course_module object, this function returns any
224  * "extra" information that may be needed when printing
225  * this activity in a course listing.
226  *
227  * See {@link get_array_of_activities()} in course/lib.php
228  *
229  * @param object $coursemodule
230  * @return object info
231  */
232 function resource_get_coursemodule_info($coursemodule) {
233     global $CFG, $DB;
234     require_once("$CFG->libdir/filelib.php");
235     require_once("$CFG->dirroot/mod/resource/locallib.php");
236     require_once($CFG->libdir.'/completionlib.php');
238     $context = get_context_instance(CONTEXT_MODULE, $coursemodule->id);
240     if (!$resource = $DB->get_record('resource', array('id'=>$coursemodule->instance), 'id, name, display, displayoptions, tobemigrated, revision')) {
241         return NULL;
242     }
244     $info = new stdClass();
245     $info->name = $resource->name;
247     if ($resource->tobemigrated) {
248         $info->icon ='i/cross_red_big';
249         return $info;
250     }
251     $fs = get_file_storage();
252     $files = $fs->get_area_files($context->id, 'mod_resource', 'content', 0, 'sortorder DESC, id ASC', false); // TODO: this is not very efficient!!
253     if (count($files) >= 1) {
254         $mainfile = array_pop($files);
255         $info->icon = file_extension_icon($mainfile->get_filename());
256         $resource->mainfile = $mainfile->get_filename();
257     }
259     $display = resource_get_final_display_type($resource);
261     if ($display == RESOURCELIB_DISPLAY_POPUP) {
262         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
263         $options = empty($resource->displayoptions) ? array() : unserialize($resource->displayoptions);
264         $width  = empty($options['popupwidth'])  ? 620 : $options['popupwidth'];
265         $height = empty($options['popupheight']) ? 450 : $options['popupheight'];
266         $wh = "width=$width,height=$height,toolbar=no,location=no,menubar=no,copyhistory=no,status=no,directories=no,scrollbars=yes,resizable=yes";
267         $info->extra = "onclick=\"window.open('$fullurl', '', '$wh'); return false;\"";
269     } else if ($display == RESOURCELIB_DISPLAY_NEW) {
270         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
271         $info->extra = "onclick=\"window.open('$fullurl'); return false;\"";
273     } else if ($display == RESOURCELIB_DISPLAY_OPEN) {
274         $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
275         $info->extra = "onclick=\"window.location.href ='$fullurl';return false;\"";
277     } else if ($display == RESOURCELIB_DISPLAY_DOWNLOAD) {
278         if (empty($mainfile)) {
279             return NULL;
280         }
281         // do not open any window because it would be left there after download
282         $path = '/'.$context->id.'/mod_resource/content/'.$resource->revision.$mainfile->get_filepath().$mainfile->get_filename();
283         $fullurl = addslashes_js(file_encode_url($CFG->wwwroot.'/pluginfile.php', $path, true));
285         // When completion information is enabled for download files, make
286         // the JavaScript version go to the view page with redirect set,
287         // instead of directly to the file, otherwise we can't make it tick
288         // the box for them
289         if (!$course = $DB->get_record('course', array('id'=>$coursemodule->course), 'id, enablecompletion')) {
290             return NULL;
291         }
292         $completion = new completion_info($course);
293         if ($completion->is_enabled($coursemodule) == COMPLETION_TRACKING_AUTOMATIC) {
294             $fullurl = "$CFG->wwwroot/mod/resource/view.php?id=$coursemodule->id&amp;redirect=1";
295         }
296         $info->extra = "onclick=\"window.open('$fullurl'); return false;\"";
297     }
299     return $info;
303 /**
304  * Lists all browsable file areas
305  * @param object $course
306  * @param object $cm
307  * @param object $context
308  * @return array
309  */
310 function resource_get_file_areas($course, $cm, $context) {
311     $areas = array();
312     $areas['content'] = get_string('resourcecontent', 'resource');
313     return $areas;
316 /**
317  * File browsing support for resource module content area.
318  * @param object $browser
319  * @param object $areas
320  * @param object $course
321  * @param object $cm
322  * @param object $context
323  * @param string $filearea
324  * @param int $itemid
325  * @param string $filepath
326  * @param string $filename
327  * @return object file_info instance or null if not found
328  */
329 function resource_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
330     global $CFG;
332     if (!has_capability('moodle/course:managefiles', $context)) {
333         // students can not peak here!
334         return null;
335     }
337     $fs = get_file_storage();
339     if ($filearea === 'content') {
340         $filepath = is_null($filepath) ? '/' : $filepath;
341         $filename = is_null($filename) ? '.' : $filename;
343         $urlbase = $CFG->wwwroot.'/pluginfile.php';
344         if (!$storedfile = $fs->get_file($context->id, 'mod_resource', 'content', 0, $filepath, $filename)) {
345             if ($filepath === '/' and $filename === '.') {
346                 $storedfile = new virtual_root_file($context->id, 'mod_resource', 'content', 0);
347             } else {
348                 // not found
349                 return null;
350             }
351         }
352         require_once("$CFG->dirroot/mod/resource/locallib.php");
353         return new resource_content_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, true, false);
354     }
356     // note: resource_intro handled in file_browser automatically
358     return null;
361 /**
362  * Serves the resource files.
363  * @param object $course
364  * @param object $cm
365  * @param object $context
366  * @param string $filearea
367  * @param array $args
368  * @param bool $forcedownload
369  * @return bool false if file not found, does not return if found - just send the file
370  */
371 function resource_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
372     global $CFG, $DB;
373     require_once("$CFG->libdir/resourcelib.php");
375     if ($context->contextlevel != CONTEXT_MODULE) {
376         return false;
377     }
379     require_course_login($course, true, $cm);
380     if (!has_capability('mod/resource:view', $context)) {
381         return false;
382     }
384     if ($filearea !== 'content') {
385         // intro is handled automatically in pluginfile.php
386         return false;
387     }
389     array_shift($args); // ignore revision - designed to prevent caching problems only
391     $fs = get_file_storage();
392     $relativepath = implode('/', $args);
393     $fullpath = rtrim("/$context->id/mod_resource/$filearea/0/$relativepath", '/');
394     do {
395         if (!$file = $fs->get_file_by_hash(sha1($fullpath))) {
396             if ($fs->get_file_by_hash(sha1("$fullpath/."))) {
397                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.htm"))) {
398                     break;
399                 }
400                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/index.html"))) {
401                     break;
402                 }
403                 if ($file = $fs->get_file_by_hash(sha1("$fullpath/Default.htm"))) {
404                     break;
405                 }
406             }
407             $resource = $DB->get_record('resource', array('id'=>$cm->instance), 'id, legacyfiles', MUST_EXIST);
408             if ($resource->legacyfiles != RESOURCELIB_LEGACYFILES_ACTIVE) {
409                 return false;
410             }
411             if (!$file = resourcelib_try_file_migration('/'.$relativepath, $cm->id, $cm->course, 'mod_resource', 'content', 0)) {
412                 return false;
413             }
414             // file migrate - update flag
415             $resource->legacyfileslast = time();
416             $DB->update_record('resource', $resource);
417         }
418     } while (false);
420     // should we apply filters?
421     $mimetype = $file->get_mimetype();
422     if ($mimetype === 'text/html' or $mimetype === 'text/plain') {
423         $filter = $DB->get_field('resource', 'filterfiles', array('id'=>$cm->instance));
424         $CFG->embeddedsoforcelinktarget = true;
425     } else {
426         $filter = 0;
427     }
429     // finally send the file
430     send_stored_file($file, 86400, $filter, $forcedownload);
433 /**
434  * Return a list of page types
435  * @param string $pagetype current page type
436  * @param stdClass $parentcontext Block's parent context
437  * @param stdClass $currentcontext Current context of block
438  */
439 function resource_page_type_list($pagetype, $parentcontext, $currentcontext) {
440     $module_pagetype = array('mod-resource-*'=>get_string('page-mod-resource-x', 'resource'));
441     return $module_pagetype;