MDL-68665 assignfeedback_editpdf: Add filearea to persist stamps
[moodle.git] / mod / assign / feedback / editpdf / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains the version information for the comments feedback plugin
19  *
20  * @package assignfeedback_editpdf
21  * @copyright  2012 Davo Smith
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 global $CFG;
28 require_once($CFG->dirroot . '/mod/assign/locallib.php');
30 /**
31  * Serves assignment feedback and other files.
32  *
33  * @param mixed $course course or id of the course
34  * @param mixed $cm course module or id of the course module
35  * @param context $context
36  * @param string $filearea
37  * @param array $args
38  * @param bool $forcedownload
39  * @param array $options - List of options affecting file serving.
40  * @return bool false if file not found, does not return if found - just send the file
41  */
42 function assignfeedback_editpdf_pluginfile(
43     $course,
44     $cm,
45     context $context,
46     $filearea,
47     $args,
48     $forcedownload,
49     array $options = array()
50 ) {
51     global $DB;
52     if ($filearea === 'systemstamps') {
54         if ($context->contextlevel !== CONTEXT_SYSTEM) {
55             return false;
56         }
58         $filename = array_pop($args);
59         $filepath = '/' . implode('/', $args) . '/';
61         $fs = get_file_storage();
62         $file = $fs->get_file($context->id, 'assignfeedback_editpdf', $filearea, 0, $filepath, $filename);
63         if (!$file) {
64             return false;
65         }
67         $options['cacheability'] = 'public';
68         $options['immutable'] = true;
70         send_stored_file($file, 0, 0, true, $options);
71     }
73     if ($context->contextlevel == CONTEXT_MODULE) {
75         require_login($course, false, $cm);
76         $itemid = (int)array_shift($args);
78         $assign = new assign($context, $cm, $course);
80         $record = $DB->get_record('assign_grades', array('id' => $itemid), 'userid,assignment', MUST_EXIST);
81         $userid = $record->userid;
82         if ($assign->get_instance()->id != $record->assignment) {
83             return false;
84         }
86         // Rely on mod_assign checking permissions.
87         if (!$assign->can_view_submission($userid)) {
88             return false;
89         }
91         $relativepath = implode('/', $args);
93         $fullpath = "/{$context->id}/assignfeedback_editpdf/$filearea/$itemid/$relativepath";
95         $fs = get_file_storage();
96         if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
97             return false;
98         }
99         // Download MUST be forced - security!
100         send_stored_file($file, 0, 0, true, $options);// Check if we want to retrieve the stamps.
101     }