3 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * This script delegates file serving to individual plugins
23 * @copyright 2008 Petr Skoda (http://skodak.org)
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 // disable moodle specific debug messages and any errors in output
28 //define('NO_DEBUG_DISPLAY', true);
29 //TODO: uncomment this once the file api stabilises a bit more
31 require_once('config.php');
32 require_once('lib/filelib.php');
34 $relativepath = get_file_argument();
35 $forcedownload = optional_param('forcedownload', 0, PARAM_BOOL
);
37 // relative path must start with '/'
39 print_error('invalidargorconf');
40 } else if ($relativepath[0] != '/') {
41 print_error('pathdoesnotstartslash');
44 // extract relative path components
45 $args = explode('/', ltrim($relativepath, '/'));
47 if (count($args) < 3) { // always at least context, component and filearea
48 print_error('invalidarguments');
51 $contextid = (int)array_shift($args);
52 $component = clean_param(array_shift($args), PARAM_SAFEDIR
);
53 $filearea = clean_param(array_shift($args), PARAM_SAFEDIR
);
55 list($context, $course, $cm) = get_context_info_array($contextid);
57 $fs = get_file_storage();
59 // If the file is a Flash file and that the user flash player is outdated return a flash upgrader MDL-20841
60 $mimetype = mimeinfo('type', $args[count($args)-1]);
61 if (!empty($CFG->excludeoldflashclients
) && $mimetype == 'application/x-shockwave-flash'&& !empty($SESSION->flashversion
)) {
62 $userplayerversion = explode('.', $SESSION->flashversion
);
63 $requiredplayerversion = explode('.', $CFG->excludeoldflashclients
);
64 if (($userplayerversion[0] < $requiredplayerversion[0]) ||
65 ($userplayerversion[0] == $requiredplayerversion[0] && $userplayerversion[1] < $requiredplayerversion[1]) ||
66 ($userplayerversion[0] == $requiredplayerversion[0] && $userplayerversion[1] == $requiredplayerversion[1]
67 && $userplayerversion[2] < $requiredplayerversion[2])) {
68 $path = $CFG->dirroot
."/lib/flashdetect/flashupgrade.swf"; // Alternate content asking user to upgrade Flash
69 $filename = "flashupgrade.swf";
70 send_file($path, $filename, O
, 0, false, false, 'application/x-shockwave-flash'); // Do not cache
74 // ========================================================================================================================
75 if ($component === 'blog') {
77 if ($context->contextlevel
!= CONTEXT_SYSTEM
) {
78 send_file_not_found();
80 if ($filearea !== 'attachment' and $filearea !== 'post') {
81 send_file_not_found();
84 if (empty($CFG->bloglevel
)) {
85 print_error('siteblogdisable', 'blog');
88 if ($CFG->bloglevel
< BLOG_GLOBAL_LEVEL
) {
91 print_error('noguest');
93 if ($CFG->bloglevel
== BLOG_USER_LEVEL
) {
94 if ($USER->id
!= $entry->userid
) {
95 send_file_not_found();
99 $entryid = (int)array_shift($args);
100 if (!$entry = $DB->get_record('post', array('module'=>'blog', 'id'=>$entryid))) {
101 send_file_not_found();
104 if ('publishstate' === 'public') {
105 if ($CFG->forcelogin
) {
109 } else if ('publishstate' === 'site') {
112 } else if ('publishstate' === 'draft') {
114 if ($USER->id
!= $entry->userid
) {
115 send_file_not_found();
119 $filename = array_pop($args);
120 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
122 if (!$file = $fs->get_file($context->id
, $component, $filearea, $entryid, $filepath, $filename) or $file->is_directory()) {
123 send_file_not_found();
126 send_stored_file($file, 10*60, 0, true); // download MUST be forced - security!
128 // ========================================================================================================================
129 } else if ($component === 'grade') {
130 if (($filearea === 'outcome' or $filearea === 'scale') and $context->contextlevel
== CONTEXT_SYSTEM
) {
131 // Global gradebook files
132 if ($CFG->forcelogin
) {
136 $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
138 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
139 send_file_not_found();
142 session_get_instance()->write_close(); // unlock session during fileserving
143 send_stored_file($file, 60*60, 0, $forcedownload);
145 } else if ($filearea === 'feedback' and $context->contextlevel
== CONTEXT_COURSE
) {
146 //TODO: nobody implemented this yet in grade edit form!!
147 send_file_not_found();
149 if ($CFG->forcelogin ||
$course->id
!== SITEID
) {
150 require_login($course);
153 $fullpath = "/$context->id/$component/$filearea/".implode('/', $args);
155 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
156 send_file_not_found();
159 session_get_instance()->write_close(); // unlock session during fileserving
160 send_stored_file($file, 60*60, 0, $forcedownload);
162 send_file_not_found();
165 // ========================================================================================================================
166 } else if ($component === 'tag') {
167 if ($filearea === 'description' and $context->contextlevel
== CONTEXT_SYSTEM
) {
169 // All tag descriptions are going to be public but we still need to respect forcelogin
170 if ($CFG->forcelogin
) {
174 $fullpath = "/$context->id/tag/description/".implode('/', $args);
176 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
177 send_file_not_found();
180 session_get_instance()->write_close(); // unlock session during fileserving
181 send_stored_file($file, 60*60, 0, true);
184 send_file_not_found();
187 // ========================================================================================================================
188 } else if ($component === 'calendar') {
189 if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_SYSTEM
) {
191 // All events here are public the one requirement is that we respect forcelogin
192 if ($CFG->forcelogin
) {
196 // Get the event if from the args array
197 $eventid = array_shift($args);
199 // Load the event from the database
200 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'eventtype'=>'site'))) {
201 send_file_not_found();
203 // Check that we got an event and that it's userid is that of the user
205 // Get the file and serve if successful
206 $filename = array_pop($args);
207 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
208 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
209 send_file_not_found();
212 session_get_instance()->write_close(); // unlock session during fileserving
213 send_stored_file($file, 60*60, 0, $forcedownload);
215 } else if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_USER
) {
217 // Must be logged in, if they are not then they obviously can't be this user
220 // Don't want guests here, potentially saves a DB call
222 send_file_not_found();
225 // Get the event if from the args array
226 $eventid = array_shift($args);
228 // Load the event from the database - user id must match
229 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'userid'=>$USER->id
, 'eventtype'=>'user'))) {
230 send_file_not_found();
233 // Get the file and serve if successful
234 $filename = array_pop($args);
235 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
236 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
237 send_file_not_found();
240 session_get_instance()->write_close(); // unlock session during fileserving
241 send_stored_file($file, 60*60, 0, $forcedownload);
243 } else if ($filearea === 'event_description' and $context->contextlevel
== CONTEXT_COURSE
) {
245 // Respect forcelogin and require login unless this is the site.... it probably
246 // should NEVER be the site
247 if ($CFG->forcelogin ||
$course->id
!== SITEID
) {
248 require_login($course);
251 // Must be able to at least view the course
252 if (!is_enrolled($context) and !is_viewing($context)) {
253 //TODO: hmm, do we really want to block guests here?
254 send_file_not_found();
258 $eventid = array_shift($args);
260 // Load the event from the database we need to check whether it is
261 // a) valid course event
263 // Group events use the course context (there is no group context)
264 if (!$event = $DB->get_record('event', array('id'=>(int)$eventid, 'courseid'=>$course->id
))) {
265 send_file_not_found();
268 // If its a group event require either membership of view all groups capability
269 if ($event->eventtype
=== 'group') {
270 if (!has_capability('moodle/site:accessallgroups', $context) && !groups_is_member($event->groupid
, $USER->id
)) {
271 send_file_not_found();
273 } else if ($event->eventtype
=== 'course') {
277 send_file_not_found();
280 // If we get this far we can serve the file
281 $filename = array_pop($args);
282 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
283 if (!$file = $fs->get_file($context->id
, $component, $filearea, $eventid, $filepath, $filename) or $file->is_directory()) {
284 send_file_not_found();
287 session_get_instance()->write_close(); // unlock session during fileserving
288 send_stored_file($file, 60*60, 0, $forcedownload);
291 send_file_not_found();
294 // ========================================================================================================================
295 } else if ($component === 'user') {
296 if ($filearea === 'icon' and $context->contextlevel
== CONTEXT_USER
) {
297 if (!empty($CFG->forcelogin
) and !isloggedin()) {
298 // protect images if login required and not logged in;
299 // do not use require_login() because it is expensive and not suitable here anyway
300 redirect($OUTPUT->pix_url('u/f1'));
302 $filename = array_pop($args);
303 if ($filename !== 'f1' and $filename !== 'f2') {
304 redirect($OUTPUT->pix_url('u/f1'));
306 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', $filename.'/.png')) {
307 if (!$file = $fs->get_file($context->id
, 'user', 'icon', 0, '/', $filename.'/.jpg')) {
308 redirect($OUTPUT->pix_url('u/f1'));
312 send_stored_file($file, 60*60*24); // enable long caching, there are many images on each page
314 } else if ($filearea === 'private' and $context->contextlevel
== CONTEXT_USER
) {
318 send_file_not_found();
321 if ($USER->id
!== $context->instanceid
) {
322 send_file_not_found();
325 $filename = array_pop($args);
326 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
327 if (!$file = $fs->get_file($context->id
, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
328 send_file_not_found();
331 session_get_instance()->write_close(); // unlock session during fileserving
332 send_stored_file($file, 0, 0, true); // must force download - security!
334 } else if ($filearea === 'profile' and $context->contextlevel
== CONTEXT_USER
) {
336 if ($CFG->forcelogin
) {
340 $userid = $context->instanceid
;
342 if ($USER->id
== $userid) {
343 // always can access own
345 } else if (!empty($CFG->forceloginforprofiles
)) {
349 send_file_not_found();
352 // we allow access to site profile of all course contacts (usually teachers)
353 if (!has_coursecontact_role($userid) && !has_capability('moodle/user:viewdetails', $context)) {
354 send_file_not_found();
358 if (has_capability('moodle/user:viewdetails', $context)) {
361 $courses = enrol_get_my_courses();
364 while (!$canview && count($courses) > 0) {
365 $course = array_shift($courses);
366 if (has_capability('moodle/user:viewdetails', get_context_instance(CONTEXT_COURSE
, $course->id
))) {
372 $filename = array_pop($args);
373 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
374 if (!$file = $fs->get_file($context->id
, $component, $filearea, 0, $filepath, $filename) or $file->is_directory()) {
375 send_file_not_found();
378 session_get_instance()->write_close(); // unlock session during fileserving
379 send_stored_file($file, 0, 0, true); // must force download - security!
381 } else if ($filearea === 'profile' and $context->contextlevel
== CONTEXT_COURSE
) {
382 $userid = (int)array_shift($args);
383 $usercontext = get_context_instance(CONTEXT_USER
, $userid);
385 if ($CFG->forcelogin
) {
389 if (!empty($CFG->forceloginforprofiles
)) {
392 print_error('noguest');
395 //TODO: review this logic of user profile access prevention
396 if (!has_coursecontact_role($userid) and !has_capability('moodle/user:viewdetails', $usercontext)) {
397 print_error('usernotavailable');
399 if (!has_capability('moodle/user:viewdetails', $context) && !has_capability('moodle/user:viewdetails', $usercontext)) {
400 print_error('cannotviewprofile');
402 if (!is_enrolled($context, $userid)) {
403 print_error('notenrolledprofile');
405 if (groups_get_course_groupmode($course) == SEPARATEGROUPS
and !has_capability('moodle/site:accessallgroups', $context)) {
406 print_error('groupnotamember');
410 $filename = array_pop($args);
411 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
412 if (!$file = $fs->get_file($usercontext->id
, 'user', 'profile', 0, $filepath, $filename) or $file->is_directory()) {
413 send_file_not_found();
416 session_get_instance()->write_close(); // unlock session during fileserving
417 send_stored_file($file, 0, 0, true); // must force download - security!
419 } else if ($filearea === 'backup' and $context->contextlevel
== CONTEXT_USER
) {
423 send_file_not_found();
425 $userid = $context->instanceid
;
427 if ($USER->id
!= $userid) {
428 send_file_not_found();
431 $filename = array_pop($args);
432 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
433 if (!$file = $fs->get_file($context->id
, 'user', 'backup', 0, $filepath, $filename) or $file->is_directory()) {
434 send_file_not_found();
437 session_get_instance()->write_close(); // unlock session during fileserving
438 send_stored_file($file, 0, 0, true); // must force download - security!
441 send_file_not_found();
444 // ========================================================================================================================
445 } else if ($component === 'coursecat') {
446 if ($context->contextlevel
!= CONTEXT_COURSECAT
) {
447 send_file_not_found();
450 if ($filearea === 'description') {
451 if ($CFG->forcelogin
) {
452 // no login necessary - unless login forced everywhere
456 $filename = array_pop($args);
457 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
458 if (!$file = $fs->get_file($context->id
, 'coursecat', 'description', 0, $filepath, $filename) or $file->is_directory()) {
459 send_file_not_found();
462 session_get_instance()->write_close(); // unlock session during fileserving
463 send_stored_file($file, 60*60, 0, $forcedownload);
465 send_file_not_found();
468 // ========================================================================================================================
469 } else if ($component === 'course') {
470 if ($context->contextlevel
!= CONTEXT_COURSE
) {
471 send_file_not_found();
474 if ($filearea === 'summary') {
475 if ($CFG->forcelogin
) {
479 $filename = array_pop($args);
480 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
481 if (!$file = $fs->get_file($context->id
, 'course', 'summary', 0, $filepath, $filename) or $file->is_directory()) {
482 send_file_not_found();
485 session_get_instance()->write_close(); // unlock session during fileserving
486 send_stored_file($file, 60*60, 0, $forcedownload);
488 } else if ($filearea === 'section') {
489 if ($CFG->forcelogin
) {
490 require_login($course);
491 } else if ($course->id
!== SITEID
) {
492 require_login($course);
495 $sectionid = (int)array_shift($args);
497 if ($course->numsections
< $sectionid) {
498 if (!has_capability('moodle/course:update', $context)) {
499 // disable access to invisible sections if can not edit course
500 // this is going to break some ugly hacks, but is necessary
501 send_file_not_found();
505 $filename = array_pop($args);
506 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
507 if (!$file = $fs->get_file($context->id
, 'course', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
508 send_file_not_found();
511 session_get_instance()->write_close(); // unlock session during fileserving
512 send_stored_file($file, 60*60, 0, $forcedownload);
515 send_file_not_found();
518 } else if ($component === 'group') {
519 if ($context->contextlevel
!= CONTEXT_COURSE
) {
520 send_file_not_found();
523 require_login($course);
525 $groupid = (int)array_shift($args);
527 $group = $DB->get_record('groups', array('id'=>$groupid, 'courseid'=>$course->id
), '*', MUST_EXIST
);
528 if (!has_capability('moodle/site:accessallgroups', $context) && !groups_is_member($group->id
, $USER->id
)) {
529 send_file_not_found();
532 if ($filearea === 'description') {
533 $filename = array_pop($args);
534 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
535 if (!$file = $fs->get_file($context->id
, 'group', 'description', $group->id
, $filepath, $filename) or $file->is_directory()) {
536 send_file_not_found();
539 session_get_instance()->write_close(); // unlock session during fileserving
540 send_stored_file($file, 60*60, 0, $forcedownload);
542 } else if ($filearea === 'icon') {
543 $filename = array_pop($args);
545 if ($filename !== 'f1' and $filename !== 'f2') {
546 send_file_not_found();
548 if (!$file = $fs->get_file($context->id
, 'group', 'icon', $group->id
, '/', $filename.'.png')) {
549 if (!$file = $fs->get_file($context->id
, 'group', 'icon', $group->id
, '/', $filename.'.jpg')) {
550 send_file_not_found();
554 session_get_instance()->write_close(); // unlock session during fileserving
555 send_stored_file($file, 60*60);
558 send_file_not_found();
561 } else if ($component === 'grouping') {
562 if ($context->contextlevel
!= CONTEXT_COURSE
) {
563 send_file_not_found();
566 require_login($course);
568 $groupingid = (int)array_shift($args);
570 // note: everybody has access to grouping desc images for now
571 if ($filearea === 'description') {
573 $filename = array_pop($args);
574 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
575 if (!$file = $fs->get_file($context->id
, 'grouping', 'description', $groupingid, $filepath, $filename) or $file->is_directory()) {
576 send_file_not_found();
579 session_get_instance()->write_close(); // unlock session during fileserving
580 send_stored_file($file, 60*60, 0, $forcedownload);
583 send_file_not_found();
586 // ========================================================================================================================
587 } else if ($component === 'backup') {
588 if ($filearea === 'course' and $context->contextlevel
== CONTEXT_COURSE
) {
589 require_login($course);
590 require_capability('moodle/backup:downloadfile', $context);
592 $filename = array_pop($args);
593 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
594 if (!$file = $fs->get_file($context->id
, 'backup', 'course', 0, $filepath, $filename) or $file->is_directory()) {
595 send_file_not_found();
598 session_get_instance()->write_close(); // unlock session during fileserving
599 send_stored_file($file, 0, 0, $forcedownload);
601 } else if ($filearea === 'section' and $context->contextlevel
== CONTEXT_COURSE
) {
602 require_login($course);
603 require_capability('moodle/backup:downloadfile', $context);
605 $sectionid = (int)array_shift($args);
607 $filename = array_pop($args);
608 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
609 if (!$file = $fs->get_file($context->id
, 'backup', 'section', $sectionid, $filepath, $filename) or $file->is_directory()) {
610 send_file_not_found();
613 session_get_instance()->write_close();
614 send_stored_file($file, 60*60, 0, $forcedownload);
616 } else if ($filearea === 'activity' and $context->contextlevel
== CONTEXT_MODULE
) {
617 require_login($course, false, $cm);
618 require_capability('moodle/backup:downloadfile', $context);
620 $filename = array_pop($args);
621 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
622 if (!$file = $fs->get_file($context->id
, 'backup', 'activity', 0, $filepath, $filename) or $file->is_directory()) {
623 send_file_not_found();
626 session_get_instance()->write_close();
627 send_stored_file($file, 60*60, 0, $forcedownload);
630 send_file_not_found();
633 // ========================================================================================================================
634 } else if (strpos($component, 'mod_') === 0) {
635 $modname = substr($component, 4);
636 if (!file_exists("$CFG->dirroot/mod/$modname/lib.php")) {
637 send_file_not_found();
639 require_once("$CFG->dirroot/mod/$modname/lib.php");
641 if ($context->contextlevel
== CONTEXT_MODULE
) {
642 if ($cm->modname
!== $modname) {
643 // somebody tries to gain illegal access, cm type must match the component!
644 send_file_not_found();
648 if ($filearea === 'intro') {
649 if (!plugin_supports('mod', $modname, FEATURE_MOD_INTRO
, true)) {
650 send_file_not_found();
652 require_course_login($course, true, $cm);
654 // all users may access it
655 $filename = array_pop($args);
656 $filepath = $args ?
'/'.implode('/', $args).'/' : '/';
657 if (!$file = $fs->get_file($context->id
, 'mod_'.$modname, 'intro', 0, $filepath, $filename) or $file->is_directory()) {
658 send_file_not_found();
661 $lifetime = isset($CFG->filelifetime
) ?
$CFG->filelifetime
: 86400;
663 // finally send the file
664 send_stored_file($file, $lifetime, 0);
667 $filefunction = $component.'_pluginfile';
668 $filefunctionold = $modname.'_pluginfile';
669 if (function_exists($filefunction)) {
670 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
671 $filefunction($course, $cm, $context, $filearea, $args, $forcedownload);
672 } else if (function_exists($filefunctionold)) {
673 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
674 $filefunctionold($course, $cm, $context, $filearea, $args, $forcedownload);
677 send_file_not_found();
679 // ========================================================================================================================
680 } else if (strpos($component, 'block_') === 0) {
681 $blockname = substr($component, 6);
682 // note: no more class methods in blocks please, that is ....
683 if (!file_exists("$CFG->dirroot/blocks/$blockname/lib.php")) {
684 send_file_not_found();
686 require_once("$CFG->dirroot/blocks/$blockname/lib.php");
688 if ($context->contextlevel
== CONTEXT_BLOCK
) {
689 $birecord = $DB->get_record('block_instances', array('id'=>$context->instanceid
), '*',MUST_EXIST
);
690 if ($birecord->blockname
!== $blockname) {
691 // somebody tries to gain illegal access, cm type must match the component!
692 send_file_not_found();
698 $filefunction = $component.'_pluginfile';
699 if (function_exists($filefunction)) {
700 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
701 $filefunction($course, $birecord, $context, $filearea, $args, $forcedownload);
704 send_file_not_found();
706 } else if (strpos($component, '_') === false) {
707 // all core subsystems have to be specified above, no more guessing here!
708 send_file_not_found();
711 // try to serve general plugin file in arbitrary context
712 $dir = get_component_directory($component);
713 if (!file_exists("$dir/lib.php")) {
714 send_file_not_found();
716 include_once("$dir/lib.php");
718 $filefunction = $component.'_pluginfile';
719 if (function_exists($filefunction)) {
720 // if the function exists, it must send the file and terminate. Whatever it returns leads to "not found"
721 $filefunction($course, $cm, $context, $filearea, $args, $forcedownload);
724 send_file_not_found();