MDL-61308 assign_feedback: Privacy code for user rights.
[moodle.git] / mod / assign / feedback / editpdf / classes / privacy / provider.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  * Privacy class for requesting user data.
19  *
20  * @package    assignfeedback_editpdf
21  * @copyright  2018 Adrian Greeve <adrian@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace assignfeedback_editpdf\privacy;
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot . '/mod/assign/locallib.php');
31 use \core_privacy\local\metadata\collection;
32 use \core_privacy\local\metadata\provider as metadataprovider;
33 use \mod_assign\privacy\assignfeedback_provider;
34 use \core_privacy\local\request\writer;
35 use \core_privacy\local\request\contextlist;
36 use \mod_assign\privacy\assign_plugin_request_data;
37 use \mod_assign\privacy\useridlist;
39 /**
40  * Privacy class for requesting user data.
41  *
42  * @package    assignfeedback_editpdf
43  * @copyright  2018 Adrian Greeve <adrian@moodle.com>
44  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
45  */
46 class provider implements metadataprovider, assignfeedback_provider {
48     /**
49      * Return meta data about this plugin.
50      *
51      * @param  collection $collection A list of information to add to.
52      * @return collection Return the collection after adding to it.
53      */
54     public static function get_metadata(collection $collection) : collection {
55         $quickdata = [
56             'userid' => 'privacy:metadata:userid',
57             'rawtext' => 'privacy:metadata:rawtextpurpose',
58             'colour' => 'privacy:metadata:colourpurpose'
59         ];
60         $collection->add_database_table('assignfeedback_editpdf_quick', $quickdata, 'privacy:metadata:tablepurpose');
61         $collection->add_subsystem_link('core_files', [], 'privacy:metadata:filepurpose');
62         $collection->add_subsystem_link('core_fileconverted', [], 'privacy:metadata:conversionpurpose');
63         return $collection;
64     }
66     /**
67      * No need to fill in this method as all information can be acquired from the assign_grades table in the mod assign
68      * provider.
69      *
70      * @param  int $userid The user ID.
71      * @param  contextlist $contextlist The context list.
72      */
73     public static function get_context_for_userid_within_feedback(int $userid, contextlist $contextlist) {
74         // This uses the assign_grade table.
75     }
77     /**
78      * This also does not need to be filled in as this is already collected in the mod assign provider.
79      *
80      * @param  useridlist $useridlist A list of user IDs
81      */
82     public static function get_student_user_ids(useridlist $useridlist) {
83         // Not required.
84     }
86     /**
87      * Export all user data for this plugin.
88      *
89      * @param  assign_plugin_request_data $exportdata Data used to determine which context and user to export and other useful
90      * information to help with exporting.
91      */
92     public static function export_feedback_user_data(assign_plugin_request_data $exportdata) {
93         $currentpath = $exportdata->get_subcontext();
94         $currentpath[] = get_string('privacy:path', 'assignfeedback_editpdf');
95         $assign = $exportdata->get_assign();
96         $plugin = $assign->get_plugin_by_type('assignfeedback', 'editpdf');
97         $fileareas = $plugin->get_file_areas();
98         $grade = $exportdata->get_pluginobject();
99         foreach ($fileareas as $filearea => $notused) {
100             writer::with_context($exportdata->get_context())
101                     ->export_area_files($currentpath, 'assignfeedback_editpdf', $filearea, $grade->id);
102         }
103     }
105     /**
106      * Any call to this method should delete all user data for the context defined in the deletion_criteria.
107      *
108      * @param  assign_plugin_request_data $requestdata Data useful for deleting user data from this sub-plugin.
109      */
110     public static function delete_feedback_for_context(assign_plugin_request_data $requestdata) {
112         $assign = $requestdata->get_assign();
113         $plugin = $assign->get_plugin_by_type('assignfeedback', 'editpdf');
114         $fileareas = $plugin->get_file_areas();
115         $fs = get_file_storage();
116         foreach ($fileareas as $filearea => $notused) {
117             // Delete pdf files.
118             $fs->delete_area_files($requestdata->get_context()->id, 'assignfeedback_editpdf', $filearea);
119         }
120         // Delete entries from the tables.
121         $plugin->delete_instance();
122     }
124     /**
125      * Calling this function should delete all user data associated with this grade.
126      *
127      * @param  assign_plugin_request_data $requestdata Data useful for deleting user data.
128      */
129     public static function delete_feedback_for_grade(assign_plugin_request_data $requestdata) {
130         global $DB;
132         $assign = $requestdata->get_assign();
133         $plugin = $assign->get_plugin_by_type('assignfeedback', 'editpdf');
134         $fileareas = $plugin->get_file_areas();
135         $fs = get_file_storage();
136         foreach ($fileareas as $filearea => $notused) {
137             // Delete pdf files.
138             $fs->delete_area_files($requestdata->get_context()->id, 'assignfeedback_editpdf',
139                     $filearea, $requestdata->get_pluginobject()->id);
140         }
142         // Remove table entries.
143         $DB->delete_records('assignfeedback_editpdf_annot', ['gradeid' => $requestdata->get_pluginobject()->id]);
144         $DB->delete_records('assignfeedback_editpdf_cmnt', ['gradeid' => $requestdata->get_pluginobject()->id]);
145         // Submission records in assignfeedback_editpdf_queue will be cleaned up in a scheduled task
146     }