Merge branch 'MDL-62564-integration-master-1' of git://github.com/mihailges/moodle
[moodle.git] / admin / tool / dataprivacy / classes / api.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  * Class containing helper methods for processing data requests.
19  *
20  * @package    tool_dataprivacy
21  * @copyright  2018 Jun Pataleta
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace tool_dataprivacy;
26 use coding_exception;
27 use context_helper;
28 use context_system;
29 use core\invalid_persistent_exception;
30 use core\message\message;
31 use core\task\manager;
32 use core_privacy\local\request\approved_contextlist;
33 use core_privacy\local\request\contextlist_collection;
34 use core_user;
35 use dml_exception;
36 use moodle_exception;
37 use moodle_url;
38 use required_capability_exception;
39 use stdClass;
40 use tool_dataprivacy\external\data_request_exporter;
41 use tool_dataprivacy\local\helper;
42 use tool_dataprivacy\task\initiate_data_request_task;
43 use tool_dataprivacy\task\process_data_request_task;
44 use tool_dataprivacy\data_request;
46 defined('MOODLE_INTERNAL') || die();
48 /**
49  * Class containing helper methods for processing data requests.
50  *
51  * @copyright  2018 Jun Pataleta
52  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
53  */
54 class api {
56     /** Data export request type. */
57     const DATAREQUEST_TYPE_EXPORT = 1;
59     /** Data deletion request type. */
60     const DATAREQUEST_TYPE_DELETE = 2;
62     /** Other request type. Usually of enquiries to the DPO. */
63     const DATAREQUEST_TYPE_OTHERS = 3;
65     /** Newly submitted and we haven't yet started finding out where they have data. */
66     const DATAREQUEST_STATUS_PENDING = 0;
68     /** Newly submitted and we have started to find the location of data. */
69     const DATAREQUEST_STATUS_PREPROCESSING = 1;
71     /** Metadata ready and awaiting review and approval by the Data Protection officer. */
72     const DATAREQUEST_STATUS_AWAITING_APPROVAL = 2;
74     /** Request approved and will be processed soon. */
75     const DATAREQUEST_STATUS_APPROVED = 3;
77     /** The request is now being processed. */
78     const DATAREQUEST_STATUS_PROCESSING = 4;
80     /** Information/other request completed. */
81     const DATAREQUEST_STATUS_COMPLETE = 5;
83     /** Data request cancelled by the user. */
84     const DATAREQUEST_STATUS_CANCELLED = 6;
86     /** Data request rejected by the DPO. */
87     const DATAREQUEST_STATUS_REJECTED = 7;
89     /** Data request download ready. */
90     const DATAREQUEST_STATUS_DOWNLOAD_READY = 8;
92     /** Data request expired. */
93     const DATAREQUEST_STATUS_EXPIRED = 9;
95     /** Data delete request completed, account is removed. */
96     const DATAREQUEST_STATUS_DELETED = 10;
98     /** Approve data request. */
99     const DATAREQUEST_ACTION_APPROVE = 1;
101     /** Reject data request. */
102     const DATAREQUEST_ACTION_REJECT = 2;
104     /**
105      * Determines whether the user can contact the site's Data Protection Officer via Moodle.
106      *
107      * @return boolean True when tool_dataprivacy|contactdataprotectionofficer is enabled.
108      * @throws dml_exception
109      */
110     public static function can_contact_dpo() {
111         return get_config('tool_dataprivacy', 'contactdataprotectionofficer') == 1;
112     }
114     /**
115      * Checks whether the current user has the capability to manage data requests.
116      *
117      * @param int $userid The user ID.
118      * @return bool
119      */
120     public static function can_manage_data_requests($userid) {
121         // Privacy officers can manage data requests.
122         return self::is_site_dpo($userid);
123     }
125     /**
126      * Checks if the current user can manage the data registry at the provided id.
127      *
128      * @param int $contextid Fallback to system context id.
129      * @throws \required_capability_exception
130      * @return null
131      */
132     public static function check_can_manage_data_registry($contextid = false) {
133         if ($contextid) {
134             $context = \context_helper::instance_by_id($contextid);
135         } else {
136             $context = \context_system::instance();
137         }
139         require_capability('tool/dataprivacy:managedataregistry', $context);
140     }
142     /**
143      * Fetches the list of configured privacy officer roles.
144      *
145      * Every time this function is called, it checks each role if they have the 'managedatarequests' capability and removes
146      * any role that doesn't have the required capability anymore.
147      *
148      * @return int[]
149      * @throws dml_exception
150      */
151     public static function get_assigned_privacy_officer_roles() {
152         $roleids = [];
154         // Get roles from config.
155         $configroleids = explode(',', str_replace(' ', '', get_config('tool_dataprivacy', 'dporoles')));
156         if (!empty($configroleids)) {
157             // Fetch roles that have the capability to manage data requests.
158             $capableroles = array_keys(get_roles_with_capability('tool/dataprivacy:managedatarequests'));
160             // Extract the configured roles that have the capability from the list of capable roles.
161             $roleids = array_intersect($capableroles, $configroleids);
162         }
164         return $roleids;
165     }
167     /**
168      * Fetches the role shortnames of Data Protection Officer roles.
169      *
170      * @return array An array of the DPO role shortnames
171      */
172     public static function get_dpo_role_names() : array {
173         global $DB;
175         $dporoleids = self::get_assigned_privacy_officer_roles();
176         $dponames = array();
178         if (!empty($dporoleids)) {
179             list($insql, $inparams) = $DB->get_in_or_equal($dporoleids);
180             $dponames = $DB->get_fieldset_select('role', 'shortname', "id {$insql}", $inparams);
181         }
183         return $dponames;
184     }
186     /**
187      * Fetches the list of users with the Privacy Officer role.
188      */
189     public static function get_site_dpos() {
190         // Get role(s) that can manage data requests.
191         $dporoles = self::get_assigned_privacy_officer_roles();
193         $dpos = [];
194         $context = context_system::instance();
195         foreach ($dporoles as $roleid) {
196             $allnames = get_all_user_name_fields(true, 'u');
197             $fields = 'u.id, u.confirmed, u.username, '. $allnames . ', ' .
198                       'u.maildisplay, u.mailformat, u.maildigest, u.email, u.emailstop, u.city, '.
199                       'u.country, u.picture, u.idnumber, u.department, u.institution, '.
200                       'u.lang, u.timezone, u.lastaccess, u.mnethostid, u.auth, u.suspended, u.deleted, ' .
201                       'r.name AS rolename, r.sortorder, '.
202                       'r.shortname AS roleshortname, rn.name AS rolecoursealias';
203             // Fetch users that can manage data requests.
204             $dpos += get_role_users($roleid, $context, false, $fields);
205         }
207         // If the site has no data protection officer, defer to site admin(s).
208         if (empty($dpos)) {
209             $dpos = get_admins();
210         }
211         return $dpos;
212     }
214     /**
215      * Checks whether a given user is a site Privacy Officer.
216      *
217      * @param int $userid The user ID.
218      * @return bool
219      */
220     public static function is_site_dpo($userid) {
221         $dpos = self::get_site_dpos();
222         return array_key_exists($userid, $dpos) || is_siteadmin();
223     }
225     /**
226      * Lodges a data request and sends the request details to the site Data Protection Officer(s).
227      *
228      * @param int $foruser The user whom the request is being made for.
229      * @param int $type The request type.
230      * @param string $comments Request comments.
231      * @param int $creationmethod The creation method of the data request.
232      * @return data_request
233      * @throws invalid_persistent_exception
234      * @throws coding_exception
235      */
236     public static function create_data_request($foruser, $type, $comments = '',
237                                                $creationmethod = data_request::DATAREQUEST_CREATION_MANUAL) {
238         global $USER, $ADMIN;
240         $datarequest = new data_request();
241         // The user the request is being made for.
242         $datarequest->set('userid', $foruser);
244         // The cron is considered to be a guest user when it creates a data request.
245         // NOTE: This should probably be changed. We should leave the default value for $requestinguser if
246         // the request is not explicitly created by a specific user.
247         $requestinguser = (isguestuser() && $creationmethod == data_request::DATAREQUEST_CREATION_AUTO) ?
248                 $ADMIN->id : $USER->id;
249         // The user making the request.
250         $datarequest->set('requestedby', $requestinguser);
251         // Set status.
252         $datarequest->set('status', self::DATAREQUEST_STATUS_PENDING);
253         // Set request type.
254         $datarequest->set('type', $type);
255         // Set request comments.
256         $datarequest->set('comments', $comments);
257         // Set the creation method.
258         $datarequest->set('creationmethod', $creationmethod);
260         // Store subject access request.
261         $datarequest->create();
263         // Fire an ad hoc task to initiate the data request process.
264         $task = new initiate_data_request_task();
265         $task->set_custom_data(['requestid' => $datarequest->get('id')]);
266         manager::queue_adhoc_task($task, true);
268         return $datarequest;
269     }
271     /**
272      * Fetches the list of the data requests.
273      *
274      * If user ID is provided, it fetches the data requests for the user.
275      * Otherwise, it fetches all of the data requests, provided that the user has the capability to manage data requests.
276      * (e.g. Users with the Data Protection Officer roles)
277      *
278      * @param int $userid The User ID.
279      * @param int[] $statuses The status filters.
280      * @param int[] $types The request type filters.
281      * @param int[] $creationmethods The request creation method filters.
282      * @param string $sort The order by clause.
283      * @param int $offset Amount of records to skip.
284      * @param int $limit Amount of records to fetch.
285      * @return data_request[]
286      * @throws coding_exception
287      * @throws dml_exception
288      */
289     public static function get_data_requests($userid = 0, $statuses = [], $types = [], $creationmethods = [],
290                                              $sort = '', $offset = 0, $limit = 0) {
291         global $DB, $USER;
292         $results = [];
293         $sqlparams = [];
294         $sqlconditions = [];
296         // Set default sort.
297         if (empty($sort)) {
298             $sort = 'status ASC, timemodified ASC';
299         }
301         // Set status filters.
302         if (!empty($statuses)) {
303             list($statusinsql, $sqlparams) = $DB->get_in_or_equal($statuses, SQL_PARAMS_NAMED);
304             $sqlconditions[] = "status $statusinsql";
305         }
307         // Set request type filter.
308         if (!empty($types)) {
309             list($typeinsql, $typeparams) = $DB->get_in_or_equal($types, SQL_PARAMS_NAMED);
310             $sqlconditions[] = "type $typeinsql";
311             $sqlparams = array_merge($sqlparams, $typeparams);
312         }
314         // Set request creation method filter.
315         if (!empty($creationmethods)) {
316             list($typeinsql, $typeparams) = $DB->get_in_or_equal($creationmethods, SQL_PARAMS_NAMED);
317             $sqlconditions[] = "creationmethod $typeinsql";
318             $sqlparams = array_merge($sqlparams, $typeparams);
319         }
321         if ($userid) {
322             // Get the data requests for the user or data requests made by the user.
323             $sqlconditions[] = "(userid = :userid OR requestedby = :requestedby)";
324             $params = [
325                 'userid' => $userid,
326                 'requestedby' => $userid
327             ];
329             // Build a list of user IDs that the user is allowed to make data requests for.
330             // Of course, the user should be included in this list.
331             $alloweduserids = [$userid];
332             // Get any users that the user can make data requests for.
333             if ($children = helper::get_children_of_user($userid)) {
334                 // Get the list of user IDs of the children and merge to the allowed user IDs.
335                 $alloweduserids = array_merge($alloweduserids, array_keys($children));
336             }
337             list($insql, $inparams) = $DB->get_in_or_equal($alloweduserids, SQL_PARAMS_NAMED);
338             $sqlconditions[] .= "userid $insql";
339             $select = implode(' AND ', $sqlconditions);
340             $params = array_merge($params, $inparams, $sqlparams);
342             $results = data_request::get_records_select($select, $params, $sort, '*', $offset, $limit);
343         } else {
344             // If the current user is one of the site's Data Protection Officers, then fetch all data requests.
345             if (self::is_site_dpo($USER->id)) {
346                 if (!empty($sqlconditions)) {
347                     $select = implode(' AND ', $sqlconditions);
348                     $results = data_request::get_records_select($select, $sqlparams, $sort, '*', $offset, $limit);
349                 } else {
350                     $results = data_request::get_records(null, $sort, '', $offset, $limit);
351                 }
352             }
353         }
355         // If any are due to expire, expire them and re-fetch updated data.
356         if (empty($statuses)
357                 || in_array(self::DATAREQUEST_STATUS_DOWNLOAD_READY, $statuses)
358                 || in_array(self::DATAREQUEST_STATUS_EXPIRED, $statuses)) {
359             $expiredrequests = data_request::get_expired_requests($userid);
361             if (!empty($expiredrequests)) {
362                 data_request::expire($expiredrequests);
363                 $results = self::get_data_requests($userid, $statuses, $types, $creationmethods, $sort, $offset, $limit);
364             }
365         }
367         return $results;
368     }
370     /**
371      * Fetches the count of data request records based on the given parameters.
372      *
373      * @param int $userid The User ID.
374      * @param int[] $statuses The status filters.
375      * @param int[] $types The request type filters.
376      * @param int[] $creationmethods The request creation method filters.
377      * @return int
378      * @throws coding_exception
379      * @throws dml_exception
380      */
381     public static function get_data_requests_count($userid = 0, $statuses = [], $types = [], $creationmethods = []) {
382         global $DB, $USER;
383         $count = 0;
384         $sqlparams = [];
385         $sqlconditions = [];
386         if (!empty($statuses)) {
387             list($statusinsql, $sqlparams) = $DB->get_in_or_equal($statuses, SQL_PARAMS_NAMED);
388             $sqlconditions[] = "status $statusinsql";
389         }
390         if (!empty($types)) {
391             list($typeinsql, $typeparams) = $DB->get_in_or_equal($types, SQL_PARAMS_NAMED);
392             $sqlconditions[] = "type $typeinsql";
393             $sqlparams = array_merge($sqlparams, $typeparams);
394         }
395         if (!empty($creationmethods)) {
396             list($typeinsql, $typeparams) = $DB->get_in_or_equal($creationmethods, SQL_PARAMS_NAMED);
397             $sqlconditions[] = "creationmethod $typeinsql";
398             $sqlparams = array_merge($sqlparams, $typeparams);
399         }
400         if ($userid) {
401             // Get the data requests for the user or data requests made by the user.
402             $sqlconditions[] = "(userid = :userid OR requestedby = :requestedby)";
403             $params = [
404                 'userid' => $userid,
405                 'requestedby' => $userid
406             ];
408             // Build a list of user IDs that the user is allowed to make data requests for.
409             // Of course, the user should be included in this list.
410             $alloweduserids = [$userid];
411             // Get any users that the user can make data requests for.
412             if ($children = helper::get_children_of_user($userid)) {
413                 // Get the list of user IDs of the children and merge to the allowed user IDs.
414                 $alloweduserids = array_merge($alloweduserids, array_keys($children));
415             }
416             list($insql, $inparams) = $DB->get_in_or_equal($alloweduserids, SQL_PARAMS_NAMED);
417             $sqlconditions[] .= "userid $insql";
418             $select = implode(' AND ', $sqlconditions);
419             $params = array_merge($params, $inparams, $sqlparams);
421             $count = data_request::count_records_select($select, $params);
422         } else {
423             // If the current user is one of the site's Data Protection Officers, then fetch all data requests.
424             if (self::is_site_dpo($USER->id)) {
425                 if (!empty($sqlconditions)) {
426                     $select = implode(' AND ', $sqlconditions);
427                     $count = data_request::count_records_select($select, $sqlparams);
428                 } else {
429                     $count = data_request::count_records();
430                 }
431             }
432         }
434         return $count;
435     }
437     /**
438      * Checks whether there is already an existing pending/in-progress data request for a user for a given request type.
439      *
440      * @param int $userid The user ID.
441      * @param int $type The request type.
442      * @return bool
443      * @throws coding_exception
444      * @throws dml_exception
445      */
446     public static function has_ongoing_request($userid, $type) {
447         global $DB;
449         // Check if the user already has an incomplete data request of the same type.
450         $nonpendingstatuses = [
451             self::DATAREQUEST_STATUS_COMPLETE,
452             self::DATAREQUEST_STATUS_CANCELLED,
453             self::DATAREQUEST_STATUS_REJECTED,
454             self::DATAREQUEST_STATUS_DOWNLOAD_READY,
455             self::DATAREQUEST_STATUS_EXPIRED,
456             self::DATAREQUEST_STATUS_DELETED,
457         ];
458         list($insql, $inparams) = $DB->get_in_or_equal($nonpendingstatuses, SQL_PARAMS_NAMED);
459         $select = 'type = :type AND userid = :userid AND status NOT ' . $insql;
460         $params = array_merge([
461             'type' => $type,
462             'userid' => $userid
463         ], $inparams);
465         return data_request::record_exists_select($select, $params);
466     }
468     /**
469      * Determines whether a request is active or not based on its status.
470      *
471      * @param int $status The request status.
472      * @return bool
473      */
474     public static function is_active($status) {
475         // List of statuses which doesn't require any further processing.
476         $finalstatuses = [
477             self::DATAREQUEST_STATUS_COMPLETE,
478             self::DATAREQUEST_STATUS_CANCELLED,
479             self::DATAREQUEST_STATUS_REJECTED,
480             self::DATAREQUEST_STATUS_DOWNLOAD_READY,
481             self::DATAREQUEST_STATUS_EXPIRED,
482             self::DATAREQUEST_STATUS_DELETED,
483         ];
485         return !in_array($status, $finalstatuses);
486     }
488     /**
489      * Cancels the data request for a given request ID.
490      *
491      * @param int $requestid The request identifier.
492      * @param int $status The request status.
493      * @param int $dpoid The user ID of the Data Protection Officer
494      * @param string $comment The comment about the status update.
495      * @return bool
496      * @throws invalid_persistent_exception
497      * @throws coding_exception
498      */
499     public static function update_request_status($requestid, $status, $dpoid = 0, $comment = '') {
500         // Update the request.
501         $datarequest = new data_request($requestid);
502         $datarequest->set('status', $status);
503         if ($dpoid) {
504             $datarequest->set('dpo', $dpoid);
505         }
506         // Update the comment if necessary.
507         if (!empty(trim($comment))) {
508             $params = [
509                 'date' => userdate(time()),
510                 'comment' => $comment
511             ];
512             $commenttosave = get_string('datecomment', 'tool_dataprivacy', $params);
513             // Check if there's an existing DPO comment.
514             $currentcomment = trim($datarequest->get('dpocomment'));
515             if ($currentcomment) {
516                 // Append the new comment to the current comment and give them 1 line space in between.
517                 $commenttosave = $currentcomment . PHP_EOL . PHP_EOL . $commenttosave;
518             }
519             $datarequest->set('dpocomment', $commenttosave);
520         }
522         return $datarequest->update();
523     }
525     /**
526      * Fetches a request based on the request ID.
527      *
528      * @param int $requestid The request identifier
529      * @return data_request
530      */
531     public static function get_request($requestid) {
532         return new data_request($requestid);
533     }
535     /**
536      * Approves a data request based on the request ID.
537      *
538      * @param int $requestid The request identifier
539      * @return bool
540      * @throws coding_exception
541      * @throws dml_exception
542      * @throws invalid_persistent_exception
543      * @throws required_capability_exception
544      * @throws moodle_exception
545      */
546     public static function approve_data_request($requestid) {
547         global $USER;
549         // Check first whether the user can manage data requests.
550         if (!self::can_manage_data_requests($USER->id)) {
551             $context = context_system::instance();
552             throw new required_capability_exception($context, 'tool/dataprivacy:managedatarequests', 'nopermissions', '');
553         }
555         // Check if request is already awaiting for approval.
556         $request = new data_request($requestid);
557         if ($request->get('status') != self::DATAREQUEST_STATUS_AWAITING_APPROVAL) {
558             throw new moodle_exception('errorrequestnotwaitingforapproval', 'tool_dataprivacy');
559         }
561         // Update the status and the DPO.
562         $result = self::update_request_status($requestid, self::DATAREQUEST_STATUS_APPROVED, $USER->id);
564         // Approve all the contexts attached to the request.
565         // Currently, approving the request implicitly approves all associated contexts, but this may change in future, allowing
566         // users to selectively approve certain contexts only.
567         self::update_request_contexts_with_status($requestid, contextlist_context::STATUS_APPROVED);
569         // Fire an ad hoc task to initiate the data request process.
570         $task = new process_data_request_task();
571         $task->set_custom_data(['requestid' => $requestid]);
572         if ($request->get('type') == self::DATAREQUEST_TYPE_EXPORT) {
573             $task->set_userid($request->get('userid'));
574         }
575         manager::queue_adhoc_task($task, true);
577         return $result;
578     }
580     /**
581      * Rejects a data request based on the request ID.
582      *
583      * @param int $requestid The request identifier
584      * @return bool
585      * @throws coding_exception
586      * @throws dml_exception
587      * @throws invalid_persistent_exception
588      * @throws required_capability_exception
589      * @throws moodle_exception
590      */
591     public static function deny_data_request($requestid) {
592         global $USER;
594         if (!self::can_manage_data_requests($USER->id)) {
595             $context = context_system::instance();
596             throw new required_capability_exception($context, 'tool/dataprivacy:managedatarequests', 'nopermissions', '');
597         }
599         // Check if request is already awaiting for approval.
600         $request = new data_request($requestid);
601         if ($request->get('status') != self::DATAREQUEST_STATUS_AWAITING_APPROVAL) {
602             throw new moodle_exception('errorrequestnotwaitingforapproval', 'tool_dataprivacy');
603         }
605         // Update the status and the DPO.
606         return self::update_request_status($requestid, self::DATAREQUEST_STATUS_REJECTED, $USER->id);
607     }
609     /**
610      * Sends a message to the site's Data Protection Officer about a request.
611      *
612      * @param stdClass $dpo The DPO user record
613      * @param data_request $request The data request
614      * @return int|false
615      * @throws coding_exception
616      * @throws moodle_exception
617      */
618     public static function notify_dpo($dpo, data_request $request) {
619         global $PAGE, $SITE;
621         $output = $PAGE->get_renderer('tool_dataprivacy');
623         $usercontext = \context_user::instance($request->get('requestedby'));
624         $requestexporter = new data_request_exporter($request, ['context' => $usercontext]);
625         $requestdata = $requestexporter->export($output);
627         // Create message to send to the Data Protection Officer(s).
628         $typetext = null;
629         $typetext = $requestdata->typename;
630         $subject = get_string('datarequestemailsubject', 'tool_dataprivacy', $typetext);
632         $requestedby = $requestdata->requestedbyuser;
633         $datarequestsurl = new moodle_url('/admin/tool/dataprivacy/datarequests.php');
634         $message = new message();
635         $message->courseid          = $SITE->id;
636         $message->component         = 'tool_dataprivacy';
637         $message->name              = 'contactdataprotectionofficer';
638         $message->userfrom          = $requestedby->id;
639         $message->replyto           = $requestedby->email;
640         $message->replytoname       = $requestedby->fullname;
641         $message->subject           = $subject;
642         $message->fullmessageformat = FORMAT_HTML;
643         $message->notification      = 1;
644         $message->contexturl        = $datarequestsurl;
645         $message->contexturlname    = get_string('datarequests', 'tool_dataprivacy');
647         // Prepare the context data for the email message body.
648         $messagetextdata = [
649             'requestedby' => $requestedby->fullname,
650             'requesttype' => $typetext,
651             'requestdate' => userdate($requestdata->timecreated),
652             'requestorigin' => $SITE->fullname,
653             'requestoriginurl' => new moodle_url('/'),
654             'requestcomments' => $requestdata->messagehtml,
655             'datarequestsurl' => $datarequestsurl
656         ];
657         $requestingfor = $requestdata->foruser;
658         if ($requestedby->id == $requestingfor->id) {
659             $messagetextdata['requestfor'] = $messagetextdata['requestedby'];
660         } else {
661             $messagetextdata['requestfor'] = $requestingfor->fullname;
662         }
664         // Email the data request to the Data Protection Officer(s)/Admin(s).
665         $messagetextdata['dponame'] = fullname($dpo);
666         // Render message email body.
667         $messagehtml = $output->render_from_template('tool_dataprivacy/data_request_email', $messagetextdata);
668         $message->userto = $dpo;
669         $message->fullmessage = html_to_text($messagehtml);
670         $message->fullmessagehtml = $messagehtml;
672         // Send message.
673         return message_send($message);
674     }
676     /**
677      * Checks whether a non-DPO user can make a data request for another user.
678      *
679      * @param   int     $user The user ID of the target user.
680      * @param   int     $requester The user ID of the user making the request.
681      * @return  bool
682      */
683     public static function can_create_data_request_for_user($user, $requester = null) {
684         $usercontext = \context_user::instance($user);
686         return has_capability('tool/dataprivacy:makedatarequestsforchildren', $usercontext, $requester);
687     }
689     /**
690      * Require that the current user can make a data request for the specified other user.
691      *
692      * @param   int     $user The user ID of the target user.
693      * @param   int     $requester The user ID of the user making the request.
694      * @return  bool
695      */
696     public static function require_can_create_data_request_for_user($user, $requester = null) {
697         $usercontext = \context_user::instance($user);
699         require_capability('tool/dataprivacy:makedatarequestsforchildren', $usercontext, $requester);
701         return true;
702     }
704     /**
705      * Checks whether a user can download a data request.
706      *
707      * @param int $userid Target user id (subject of data request)
708      * @param int $requesterid Requester user id (person who requsted it)
709      * @param int|null $downloaderid Person who wants to download user id (default current)
710      * @return bool
711      * @throws coding_exception
712      */
713     public static function can_download_data_request_for_user($userid, $requesterid, $downloaderid = null) {
714         global $USER;
716         if (!$downloaderid) {
717             $downloaderid = $USER->id;
718         }
720         $usercontext = \context_user::instance($userid);
721         // If it's your own and you have the right capability, you can download it.
722         if ($userid == $downloaderid && has_capability('tool/dataprivacy:downloadownrequest', $usercontext, $downloaderid)) {
723             return true;
724         }
725         // If you can download anyone's in that context, you can download it.
726         if (has_capability('tool/dataprivacy:downloadallrequests', $usercontext, $downloaderid)) {
727             return true;
728         }
729         // If you can have the 'child access' ability to request in that context, and you are the one
730         // who requested it, then you can download it.
731         if ($requesterid == $downloaderid && self::can_create_data_request_for_user($userid, $requesterid)) {
732             return true;
733         }
734         return false;
735     }
737     /**
738      * Gets an action menu link to download a data request.
739      *
740      * @param \context_user $usercontext User context (of user who the data is for)
741      * @param int $requestid Request id
742      * @return \action_menu_link_secondary Action menu link
743      * @throws coding_exception
744      */
745     public static function get_download_link(\context_user $usercontext, $requestid) {
746         $downloadurl = moodle_url::make_pluginfile_url($usercontext->id,
747                 'tool_dataprivacy', 'export', $requestid, '/', 'export.zip', true);
748         $downloadtext = get_string('download', 'tool_dataprivacy');
749         return new \action_menu_link_secondary($downloadurl, null, $downloadtext);
750     }
752     /**
753      * Creates a new data purpose.
754      *
755      * @param stdClass $record
756      * @return \tool_dataprivacy\purpose.
757      */
758     public static function create_purpose(stdClass $record) {
759         $purpose = new purpose(0, $record);
760         $purpose->create();
762         return $purpose;
763     }
765     /**
766      * Updates an existing data purpose.
767      *
768      * @param stdClass $record
769      * @return \tool_dataprivacy\purpose.
770      */
771     public static function update_purpose(stdClass $record) {
772         if (!isset($record->sensitivedatareasons)) {
773             $record->sensitivedatareasons = '';
774         }
776         $purpose = new purpose($record->id);
777         $purpose->from_record($record);
779         $result = $purpose->update();
781         return $purpose;
782     }
784     /**
785      * Deletes a data purpose.
786      *
787      * @param int $id
788      * @return bool
789      */
790     public static function delete_purpose($id) {
791         $purpose = new purpose($id);
792         if ($purpose->is_used()) {
793             throw new \moodle_exception('Purpose with id ' . $id . ' can not be deleted because it is used.');
794         }
795         return $purpose->delete();
796     }
798     /**
799      * Get all system data purposes.
800      *
801      * @return \tool_dataprivacy\purpose[]
802      */
803     public static function get_purposes() {
804         return purpose::get_records([], 'name', 'ASC');
805     }
807     /**
808      * Creates a new data category.
809      *
810      * @param stdClass $record
811      * @return \tool_dataprivacy\category.
812      */
813     public static function create_category(stdClass $record) {
814         $category = new category(0, $record);
815         $category->create();
817         return $category;
818     }
820     /**
821      * Updates an existing data category.
822      *
823      * @param stdClass $record
824      * @return \tool_dataprivacy\category.
825      */
826     public static function update_category(stdClass $record) {
827         $category = new category($record->id);
828         $category->from_record($record);
830         $result = $category->update();
832         return $category;
833     }
835     /**
836      * Deletes a data category.
837      *
838      * @param int $id
839      * @return bool
840      */
841     public static function delete_category($id) {
842         $category = new category($id);
843         if ($category->is_used()) {
844             throw new \moodle_exception('Category with id ' . $id . ' can not be deleted because it is used.');
845         }
846         return $category->delete();
847     }
849     /**
850      * Get all system data categories.
851      *
852      * @return \tool_dataprivacy\category[]
853      */
854     public static function get_categories() {
855         return category::get_records([], 'name', 'ASC');
856     }
858     /**
859      * Sets the context instance purpose and category.
860      *
861      * @param \stdClass $record
862      * @return \tool_dataprivacy\context_instance
863      */
864     public static function set_context_instance($record) {
865         if ($instance = context_instance::get_record_by_contextid($record->contextid, false)) {
866             // Update.
867             $instance->from_record($record);
869             if (empty($record->purposeid) && empty($record->categoryid)) {
870                 // We accept one of them to be null but we delete it if both are null.
871                 self::unset_context_instance($instance);
872                 return;
873             }
875         } else {
876             // Add.
877             $instance = new context_instance(0, $record);
878         }
879         $instance->save();
881         return $instance;
882     }
884     /**
885      * Unsets the context instance record.
886      *
887      * @param \tool_dataprivacy\context_instance $instance
888      * @return null
889      */
890     public static function unset_context_instance(context_instance $instance) {
891         $instance->delete();
892     }
894     /**
895      * Sets the context level purpose and category.
896      *
897      * @throws \coding_exception
898      * @param \stdClass $record
899      * @return contextlevel
900      */
901     public static function set_contextlevel($record) {
902         global $DB;
904         if ($record->contextlevel != CONTEXT_SYSTEM && $record->contextlevel != CONTEXT_USER) {
905             throw new \coding_exception('Only context system and context user can set a contextlevel ' .
906                 'purpose and retention');
907         }
909         if ($contextlevel = contextlevel::get_record_by_contextlevel($record->contextlevel, false)) {
910             // Update.
911             $contextlevel->from_record($record);
912         } else {
913             // Add.
914             $contextlevel = new contextlevel(0, $record);
915         }
916         $contextlevel->save();
918         // We sync with their defaults as we removed these options from the defaults page.
919         $classname = \context_helper::get_class_for_level($record->contextlevel);
920         list($purposevar, $categoryvar) = data_registry::var_names_from_context($classname);
921         set_config($purposevar, $record->purposeid, 'tool_dataprivacy');
922         set_config($categoryvar, $record->categoryid, 'tool_dataprivacy');
924         return $contextlevel;
925     }
927     /**
928      * Returns the effective category given a context instance.
929      *
930      * @param \context $context
931      * @param int $forcedvalue Use this categoryid value as if this was this context instance category.
932      * @return category|false
933      */
934     public static function get_effective_context_category(\context $context, $forcedvalue = false) {
935         if (!data_registry::defaults_set()) {
936             return false;
937         }
939         return data_registry::get_effective_context_value($context, 'category', $forcedvalue);
940     }
942     /**
943      * Returns the effective purpose given a context instance.
944      *
945      * @param \context $context
946      * @param int $forcedvalue Use this purposeid value as if this was this context instance purpose.
947      * @return purpose|false
948      */
949     public static function get_effective_context_purpose(\context $context, $forcedvalue = false) {
950         if (!data_registry::defaults_set()) {
951             return false;
952         }
954         return data_registry::get_effective_context_value($context, 'purpose', $forcedvalue);
955     }
957     /**
958      * Returns the effective category given a context level.
959      *
960      * @param int $contextlevel
961      * @return category|false
962      */
963     public static function get_effective_contextlevel_category($contextlevel) {
964         if (!data_registry::defaults_set()) {
965             return false;
966         }
968         return data_registry::get_effective_contextlevel_value($contextlevel, 'category');
969     }
971     /**
972      * Returns the effective purpose given a context level.
973      *
974      * @param int $contextlevel
975      * @param int $forcedvalue Use this purposeid value as if this was this context level purpose.
976      * @return purpose|false
977      */
978     public static function get_effective_contextlevel_purpose($contextlevel, $forcedvalue=false) {
979         if (!data_registry::defaults_set()) {
980             return false;
981         }
983         return data_registry::get_effective_contextlevel_value($contextlevel, 'purpose', $forcedvalue);
984     }
986     /**
987      * Creates an expired context record for the provided context id.
988      *
989      * @param int $contextid
990      * @return \tool_dataprivacy\expired_context
991      */
992     public static function create_expired_context($contextid) {
993         $record = (object)[
994             'contextid' => $contextid,
995             'status' => expired_context::STATUS_EXPIRED,
996         ];
997         $expiredctx = new expired_context(0, $record);
998         $expiredctx->save();
1000         return $expiredctx;
1001     }
1003     /**
1004      * Deletes an expired context record.
1005      *
1006      * @param int $id The tool_dataprivacy_ctxexpire id.
1007      * @return bool True on success.
1008      */
1009     public static function delete_expired_context($id) {
1010         $expiredcontext = new expired_context($id);
1011         return $expiredcontext->delete();
1012     }
1014     /**
1015      * Updates the status of an expired context.
1016      *
1017      * @param \tool_dataprivacy\expired_context $expiredctx
1018      * @param int $status
1019      * @return null
1020      */
1021     public static function set_expired_context_status(expired_context $expiredctx, $status) {
1022         $expiredctx->set('status', $status);
1023         $expiredctx->save();
1024     }
1026     /**
1027      * Adds the contexts from the contextlist_collection to the request with the status provided.
1028      *
1029      * @param contextlist_collection $clcollection a collection of contextlists for all components.
1030      * @param int $requestid the id of the request.
1031      * @param int $status the status to set the contexts to.
1032      */
1033     public static function add_request_contexts_with_status(contextlist_collection $clcollection, int $requestid, int $status) {
1034         $request = new data_request($requestid);
1035         $user = \core_user::get_user($request->get('userid'));
1036         foreach ($clcollection as $contextlist) {
1037             // Convert the \core_privacy\local\request\contextlist into a contextlist persistent and store it.
1038             $clp = \tool_dataprivacy\contextlist::from_contextlist($contextlist);
1039             $clp->create();
1040             $contextlistid = $clp->get('id');
1042             // Store the associated contexts in the contextlist.
1043             foreach ($contextlist->get_contextids() as $contextid) {
1044                 if ($request->get('type') == static::DATAREQUEST_TYPE_DELETE) {
1045                     $context = \context::instance_by_id($contextid);
1046                     $purpose = static::get_effective_context_purpose($context);
1048                     // Data can only be deleted from it if the context is either expired, or unprotected.
1049                     if (!expired_contexts_manager::is_context_expired_or_unprotected_for_user($context, $user)) {
1050                         continue;
1051                     }
1052                 }
1054                 $context = new contextlist_context();
1055                 $context->set('contextid', $contextid)
1056                     ->set('contextlistid', $contextlistid)
1057                     ->set('status', $status)
1058                     ->create();
1059             }
1061             // Create the relation to the request.
1062             $requestcontextlist = request_contextlist::create_relation($requestid, $contextlistid);
1063             $requestcontextlist->create();
1064         }
1065     }
1067     /**
1068      * Sets the status of all contexts associated with the request.
1069      *
1070      * @param int $requestid the requestid to which the contexts belong.
1071      * @param int $status the status to set to.
1072      * @throws \dml_exception if the requestid is invalid.
1073      * @throws \moodle_exception if the status is invalid.
1074      */
1075     public static function update_request_contexts_with_status(int $requestid, int $status) {
1076         // Validate contextlist_context status using the persistent's attribute validation.
1077         $contextlistcontext = new contextlist_context();
1078         $contextlistcontext->set('status', $status);
1079         if (array_key_exists('status', $contextlistcontext->get_errors())) {
1080             throw new moodle_exception("Invalid contextlist_context status: $status");
1081         }
1083         // Validate requestid using the persistent's record validation.
1084         // A dml_exception is thrown if the record is missing.
1085         $datarequest = new data_request($requestid);
1087         // Bulk update the status of the request contexts.
1088         global $DB;
1090         $select = "SELECT ctx.id as id
1091                      FROM {" . request_contextlist::TABLE . "} rcl
1092                      JOIN {" . contextlist::TABLE . "} cl ON rcl.contextlistid = cl.id
1093                      JOIN {" . contextlist_context::TABLE . "} ctx ON cl.id = ctx.contextlistid
1094                     WHERE rcl.requestid = ?";
1096         // Fetch records IDs to be updated and update by chunks, if applicable (limit of 1000 records per update).
1097         $limit = 1000;
1098         $idstoupdate = $DB->get_fieldset_sql($select, [$requestid]);
1099         $count = count($idstoupdate);
1100         $idchunks = $idstoupdate;
1101         if ($count > $limit) {
1102             $idchunks = array_chunk($idstoupdate, $limit);
1103         }
1104         $transaction = $DB->start_delegated_transaction();
1105         $initialparams = [$status];
1106         foreach ($idchunks as $chunk) {
1107             list($insql, $inparams) = $DB->get_in_or_equal($chunk);
1108             $update = "UPDATE {" . contextlist_context::TABLE . "}
1109                           SET status = ?
1110                         WHERE id $insql";
1111             $params = array_merge($initialparams, $inparams);
1112             $DB->execute($update, $params);
1113         }
1114         $transaction->allow_commit();
1115     }
1117     /**
1118      * Finds all request contextlists having at least on approved context, and returns them as in a contextlist_collection.
1119      *
1120      * @param data_request $request the data request with which the contextlists are associated.
1121      * @return contextlist_collection the collection of approved_contextlist objects.
1122      */
1123     public static function get_approved_contextlist_collection_for_request(data_request $request) : contextlist_collection {
1124         $foruser = core_user::get_user($request->get('userid'));
1126         // Fetch all approved contextlists and create the core_privacy\local\request\contextlist objects here.
1127         global $DB;
1128         $sql = "SELECT cl.component, ctx.contextid
1129                   FROM {" . request_contextlist::TABLE . "} rcl
1130                   JOIN {" . contextlist::TABLE . "} cl ON rcl.contextlistid = cl.id
1131                   JOIN {" . contextlist_context::TABLE . "} ctx ON cl.id = ctx.contextlistid
1132                  WHERE rcl.requestid = ?
1133                    AND ctx.status = ?
1134               ORDER BY cl.component, ctx.contextid";
1136         // Create the approved contextlist collection object.
1137         $lastcomponent = null;
1138         $approvedcollection = new contextlist_collection($foruser->id);
1140         $rs = $DB->get_recordset_sql($sql, [$request->get('id'), contextlist_context::STATUS_APPROVED]);
1141         foreach ($rs as $record) {
1142             // If we encounter a new component, and we've built up contexts for the last, then add the approved_contextlist for the
1143             // last (the one we've just finished with) and reset the context array for the next one.
1144             if ($lastcomponent != $record->component) {
1145                 if (!empty($contexts)) {
1146                     $approvedcollection->add_contextlist(new approved_contextlist($foruser, $lastcomponent, $contexts));
1147                 }
1148                 $contexts = [];
1149             }
1151             if ($request->get('type') == static::DATAREQUEST_TYPE_DELETE) {
1152                 $context = \context::instance_by_id($record->contextid);
1153                 $purpose = static::get_effective_context_purpose($context);
1154                 // Data can only be deleted from it if the context is either expired, or unprotected.
1155                 if (!expired_contexts_manager::is_context_expired_or_unprotected_for_user($context, $foruser)) {
1156                     continue;
1157                 }
1158             }
1160             $contexts[] = $record->contextid;
1161             $lastcomponent = $record->component;
1162         }
1163         $rs->close();
1165         // The data for the last component contextlist won't have been written yet, so write it now.
1166         if (!empty($contexts)) {
1167             $approvedcollection->add_contextlist(new approved_contextlist($foruser, $lastcomponent, $contexts));
1168         }
1170         return $approvedcollection;
1171     }
1173     /**
1174      * Updates the default category and purpose for a given context level (and optionally, a plugin).
1175      *
1176      * @param int $contextlevel The context level.
1177      * @param int $categoryid The ID matching the category.
1178      * @param int $purposeid The ID matching the purpose record.
1179      * @param int $activity The name of the activity that we're making a defaults configuration for.
1180      * @param bool $override Whether to override the purpose/categories of existing instances to these defaults.
1181      * @return boolean True if set/unset config succeeds. Otherwise, it throws an exception.
1182      */
1183     public static function set_context_defaults($contextlevel, $categoryid, $purposeid, $activity = null, $override = false) {
1184         global $DB;
1186         // Get the class name associated with this context level.
1187         $classname = context_helper::get_class_for_level($contextlevel);
1188         list($purposevar, $categoryvar) = data_registry::var_names_from_context($classname, $activity);
1190         // Check the default category to be set.
1191         if ($categoryid == context_instance::INHERIT) {
1192             unset_config($categoryvar, 'tool_dataprivacy');
1194         } else {
1195             // Make sure the given category ID exists first.
1196             $categorypersistent = new category($categoryid);
1197             $categorypersistent->read();
1199             // Then set the new default value.
1200             set_config($categoryvar, $categoryid, 'tool_dataprivacy');
1201         }
1203         // Check the default purpose to be set.
1204         if ($purposeid == context_instance::INHERIT) {
1205             // If the defaults is set to inherit, just unset the config value.
1206             unset_config($purposevar, 'tool_dataprivacy');
1208         } else {
1209             // Make sure the given purpose ID exists first.
1210             $purposepersistent = new purpose($purposeid);
1211             $purposepersistent->read();
1213             // Then set the new default value.
1214             set_config($purposevar, $purposeid, 'tool_dataprivacy');
1215         }
1217         // Unset instances that have been assigned with custom purpose and category, if override was specified.
1218         if ($override) {
1219             // We'd like to find context IDs that we want to unset.
1220             $statements = ["SELECT c.id as contextid FROM {context} c"];
1221             // Based on this context level.
1222             $params = ['contextlevel' => $contextlevel];
1224             if ($contextlevel == CONTEXT_MODULE) {
1225                 // If we're deleting module context instances, we need to make sure the instance ID is in the course modules table.
1226                 $statements[] = "JOIN {course_modules} cm ON cm.id = c.instanceid";
1227                 // And that the module is listed on the modules table.
1228                 $statements[] = "JOIN {modules} m ON m.id = cm.module";
1230                 if ($activity) {
1231                     // If we're overriding for an activity module, make sure that the context instance matches that activity.
1232                     $statements[] = "AND m.name = :modname";
1233                     $params['modname'] = $activity;
1234                 }
1235             }
1236             // Make sure this context instance exists in the tool_dataprivacy_ctxinstance table.
1237             $statements[] = "JOIN {tool_dataprivacy_ctxinstance} tdc ON tdc.contextid = c.id";
1238             // And that the context level of this instance matches the given context level.
1239             $statements[] = "WHERE c.contextlevel = :contextlevel";
1241             // Build our SQL query by gluing the statements.
1242             $sql = implode("\n", $statements);
1244             // Get the context records matching our query.
1245             $contextids = $DB->get_fieldset_sql($sql, $params);
1247             // Delete the matching context instances.
1248             foreach ($contextids as $contextid) {
1249                 if ($instance = context_instance::get_record_by_contextid($contextid, false)) {
1250                     self::unset_context_instance($instance);
1251                 }
1252             }
1253         }
1255         return true;
1256     }
1258     /**
1259      * Format the supplied date interval as a retention period.
1260      *
1261      * @param   \DateInterval   $interval
1262      * @return  string
1263      */
1264     public static function format_retention_period(\DateInterval $interval) : string {
1265         // It is one or another.
1266         if ($interval->y) {
1267             $formattedtime = get_string('numyears', 'moodle', $interval->format('%y'));
1268         } else if ($interval->m) {
1269             $formattedtime = get_string('nummonths', 'moodle', $interval->format('%m'));
1270         } else if ($interval->d) {
1271             $formattedtime = get_string('numdays', 'moodle', $interval->format('%d'));
1272         } else {
1273             $formattedtime = get_string('retentionperiodzero', 'tool_dataprivacy');
1274         }
1276         return $formattedtime;
1277     }