MDL-62289 tool_dataprivacy: Ensure all user data deleted.
[moodle.git] / admin / tool / dataprivacy / classes / expired_user_contexts.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  * Expired contexts manager for CONTEXT_USER.
19  *
20  * @package    tool_dataprivacy
21  * @copyright  2018 David Monllao
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace tool_dataprivacy;
26 use tool_dataprivacy\purpose;
27 use tool_dataprivacy\context_instance;
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * Expired contexts manager for CONTEXT_USER.
33  *
34  * @copyright  2018 David Monllao
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class expired_user_contexts extends \tool_dataprivacy\expired_contexts_manager {
39     /**
40      * Only user level.
41      *
42      * @return int[]
43      */
44     protected function get_context_levels() {
45         return [CONTEXT_USER];
46     }
48     /**
49      * Returns the user context instances that are expired.
50      *
51      * @return \stdClass[]
52      */
53     protected function get_expired_contexts() {
54         global $DB;
56         // Including context info + last login timestamp.
57         $fields = 'ctx.id AS id, ' . \context_helper::get_preload_record_columns_sql('ctx');
59         $purpose = api::get_effective_contextlevel_purpose(CONTEXT_USER);
61         // Calculate what is considered expired according to the context level effective purpose (= now + retention period).
62         $expiredtime = new \DateTime();
63         $retention = new \DateInterval($purpose->get('retentionperiod'));
64         $expiredtime->sub($retention);
66         $sql = "SELECT $fields FROM {context} ctx
67                   JOIN {user} u ON ctx.contextlevel = ? AND ctx.instanceid = u.id
68                   LEFT JOIN {tool_dataprivacy_ctxexpired} expiredctx ON ctx.id = expiredctx.contextid
69                  WHERE u.lastaccess <= ? AND u.lastaccess > 0 AND expiredctx.id IS NULL
70                 ORDER BY ctx.path, ctx.contextlevel ASC";
71         $possiblyexpired = $DB->get_recordset_sql($sql, [CONTEXT_USER, $expiredtime->getTimestamp()]);
73         $expiredcontexts = [];
74         foreach ($possiblyexpired as $record) {
76             \context_helper::preload_from_record($record);
78             // No strict checking as the context may already be deleted (e.g. we just deleted a course,
79             // module contexts below it will not exist).
80             $context = \context::instance_by_id($record->id, false);
81             if (!$context) {
82                 continue;
83             }
85             if (is_siteadmin($context->instanceid)) {
86                 continue;
87             }
89             $courses = enrol_get_users_courses($context->instanceid, false, ['enddate']);
90             foreach ($courses as $course) {
91                 if (!$course->enddate) {
92                     // We can not know it what is going on here, so we prefer to be conservative.
93                     continue 2;
94                 }
96                 if ($course->enddate >= time()) {
97                     // Future or ongoing course.
98                     continue 2;
99                 }
100             }
102             $expiredcontexts[$context->id] = $context;
103         }
105         return $expiredcontexts;
106     }
108     /**
109      * Deletes user data from the provided context.
110      *
111      * Overwritten to delete the user.
112      *
113      * @param \core_privacy\manager $privacymanager
114      * @param \tool_dataprivacy\expired_context $expiredctx
115      * @return \context|false
116      */
117     protected function delete_expired_context(\core_privacy\manager $privacymanager, \tool_dataprivacy\expired_context $expiredctx) {
118         $context = \context::instance_by_id($expiredctx->get('contextid'), IGNORE_MISSING);
119         if (!$context) {
120             api::delete_expired_context($expiredctx->get('contextid'));
121             return false;
122         }
124         if (!PHPUNIT_TEST) {
125             mtrace('Deleting context ' . $context->id . ' - ' .
126                 shorten_text($context->get_context_name(true, true)));
127         }
129         // To ensure that all user data is deleted, instead of deleting by context, we run through and collect any stray
130         // contexts for the user that may still exist and call delete_data_for_user().
131         $user = \core_user::get_user($context->instanceid, '*', MUST_EXIST);
132         $approvedlistcollection = new \core_privacy\local\request\contextlist_collection($user->id);
133         $contextlistcollection = $privacymanager->get_contexts_for_userid($user->id);
135         foreach ($contextlistcollection as $contextlist) {
136             $approvedlistcollection->add_contextlist(new \core_privacy\local\request\approved_contextlist(
137                 $user,
138                 $contextlist->get_component(),
139                 $contextlist->get_contextids()
140             ));
141         }
143         $privacymanager->delete_data_for_user($approvedlistcollection);
144         api::set_expired_context_status($expiredctx, expired_context::STATUS_CLEANED);
146         // Delete the user.
147         delete_user($user);
149         return $context;
150     }