MDL-61308 assign_feedback: Privacy code for user rights.
[moodle.git] / mod / assign / feedback / file / 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_file
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_file\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 core_privacy\local\request\contextlist;
34 use \mod_assign\privacy\assignfeedback_provider;
35 use \mod_assign\privacy\assign_plugin_request_data;
36 use mod_assign\privacy\useridlist;
38 /**
39  * Privacy class for requesting user data.
40  *
41  * @package    assignfeedback_file
42  * @copyright  2018 Adrian Greeve <adrian@moodle.com>
43  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44  */
45 class provider implements metadataprovider, assignfeedback_provider {
47     /**
48      * Return meta data about this plugin.
49      *
50      * @param  collection $collection A list of information to add to.
51      * @return collection Return the collection after adding to it.
52      */
53     public static function get_metadata(collection $collection) : collection {
54         $collection->link_subsystem('core_files', 'privacy:metadata:filepurpose');
55         return $collection;
56     }
58     /**
59      * No need to fill in this method as all information can be acquired from the assign_grades table in the mod assign
60      * provider.
61      *
62      * @param  int $userid The user ID.
63      * @param  contextlist $contextlist The context list.
64      */
65     public static function get_context_for_userid_within_feedback(int $userid, contextlist $contextlist) {
66         // This uses the assign_grade table.
67     }
69     /**
70      * This also does not need to be filled in as this is already collected in the mod assign provider.
71      *
72      * @param  useridlist $useridlist A list of user IDs
73      */
74     public static function get_student_user_ids(useridlist $useridlist) {
75         // Not required.
76     }
78     /**
79      * Export all user data for this plugin.
80      *
81      * @param  assign_plugin_request_data $exportdata Data used to determine which context and user to export and other useful
82      * information to help with exporting.
83      */
84     public static function export_feedback_user_data(assign_plugin_request_data $exportdata) {
85         $currentpath = $exportdata->get_subcontext();
86         $currentpath[] = get_string('privacy:path', 'assignfeedback_file');
87         $assign = $exportdata->get_assign();
88         $plugin = $assign->get_plugin_by_type('assignfeedback', 'file');
89         $gradeid = $exportdata->get_pluginobject()->id;
90         $filefeedback = $plugin->get_file_feedback($gradeid);
91         if ($filefeedback) {
92             $fileareas = $plugin->get_file_areas();
93             foreach ($fileareas as $filearea => $notused) {
94                 \core_privacy\local\request\writer::with_context($exportdata->get_context())
95                         ->export_area_files($currentpath, 'assignfeedback_file', $filearea, $gradeid);
96             }
97         }
98     }
100     /**
101      * Any call to this method should delete all user data for the context defined in the deletion_criteria.
102      *
103      * @param  assign_plugin_request_data $requestdata Data useful for deleting user data from this sub-plugin.
104      */
105     public static function delete_feedback_for_context(assign_plugin_request_data $requestdata) {
107         $assign = $requestdata->get_assign();
108         $plugin = $assign->get_plugin_by_type('assignfeedback', 'file');
109         $fileareas = $plugin->get_file_areas();
110         $fs = get_file_storage();
111         foreach ($fileareas as $filearea => $notused) {
112             // Delete feedback files.
113             $fs->delete_area_files($requestdata->get_context()->id, 'assignfeedback_file', $filearea);
114         }
115         $plugin->delete_instance();
116     }
118     /**
119      * Calling this function should delete all user data associated with this grade.
120      *
121      * @param  assign_plugin_request_data $requestdata Data useful for deleting user data.
122      */
123     public static function delete_feedback_for_grade(assign_plugin_request_data $requestdata) {
124         global $DB;
126         $assign = $requestdata->get_assign();
127         $plugin = $assign->get_plugin_by_type('assignfeedback', 'file');
128         $fileareas = $plugin->get_file_areas();
129         $fs = get_file_storage();
130         foreach ($fileareas as $filearea => $notused) {
131             // Delete feedback files.
132             $fs->delete_area_files($requestdata->get_context()->id, 'assignfeedback_file', $filearea,
133                     $requestdata->get_pluginobject()->id);
134         }
136         // Delete table entries.
137         $DB->delete_records('assignfeedback_file', ['assignment' => $requestdata->get_assign()->get_instance()->id,
138                 'grade' => $requestdata->get_pluginobject()->id]);
139     }