Merge branch 'MDL-63102-master' of git://github.com/peterRd/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;
45 defined('MOODLE_INTERNAL') || die();
47 /**
48  * Class containing helper methods for processing data requests.
49  *
50  * @copyright  2018 Jun Pataleta
51  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
52  */
53 class api {
55     /** Data export request type. */
56     const DATAREQUEST_TYPE_EXPORT = 1;
58     /** Data deletion request type. */
59     const DATAREQUEST_TYPE_DELETE = 2;
61     /** Other request type. Usually of enquiries to the DPO. */
62     const DATAREQUEST_TYPE_OTHERS = 3;
64     /** Newly submitted and we haven't yet started finding out where they have data. */
65     const DATAREQUEST_STATUS_PENDING = 0;
67     /** Newly submitted and we have started to find the location of data. */
68     const DATAREQUEST_STATUS_PREPROCESSING = 1;
70     /** Metadata ready and awaiting review and approval by the Data Protection officer. */
71     const DATAREQUEST_STATUS_AWAITING_APPROVAL = 2;
73     /** Request approved and will be processed soon. */
74     const DATAREQUEST_STATUS_APPROVED = 3;
76     /** The request is now being processed. */
77     const DATAREQUEST_STATUS_PROCESSING = 4;
79     /** Information/other request completed. */
80     const DATAREQUEST_STATUS_COMPLETE = 5;
82     /** Data request cancelled by the user. */
83     const DATAREQUEST_STATUS_CANCELLED = 6;
85     /** Data request rejected by the DPO. */
86     const DATAREQUEST_STATUS_REJECTED = 7;
88     /** Data request download ready. */
89     const DATAREQUEST_STATUS_DOWNLOAD_READY = 8;
91     /** Data request expired. */
92     const DATAREQUEST_STATUS_EXPIRED = 9;
94     /** Data delete request completed, account is removed. */
95     const DATAREQUEST_STATUS_DELETED = 10;
97     /** Approve data request. */
98     const DATAREQUEST_ACTION_APPROVE = 1;
100     /** Reject data request. */
101     const DATAREQUEST_ACTION_REJECT = 2;
103     /**
104      * Determines whether the user can contact the site's Data Protection Officer via Moodle.
105      *
106      * @return boolean True when tool_dataprivacy|contactdataprotectionofficer is enabled.
107      * @throws dml_exception
108      */
109     public static function can_contact_dpo() {
110         return get_config('tool_dataprivacy', 'contactdataprotectionofficer') == 1;
111     }
113     /**
114      * Checks whether the current user has the capability to manage data requests.
115      *
116      * @param int $userid The user ID.
117      * @return bool
118      */
119     public static function can_manage_data_requests($userid) {
120         // Privacy officers can manage data requests.
121         return self::is_site_dpo($userid);
122     }
124     /**
125      * Checks if the current user can manage the data registry at the provided id.
126      *
127      * @param int $contextid Fallback to system context id.
128      * @throws \required_capability_exception
129      * @return null
130      */
131     public static function check_can_manage_data_registry($contextid = false) {
132         if ($contextid) {
133             $context = \context_helper::instance_by_id($contextid);
134         } else {
135             $context = \context_system::instance();
136         }
138         require_capability('tool/dataprivacy:managedataregistry', $context);
139     }
141     /**
142      * Fetches the list of configured privacy officer roles.
143      *
144      * Every time this function is called, it checks each role if they have the 'managedatarequests' capability and removes
145      * any role that doesn't have the required capability anymore.
146      *
147      * @return int[]
148      * @throws dml_exception
149      */
150     public static function get_assigned_privacy_officer_roles() {
151         $roleids = [];
153         // Get roles from config.
154         $configroleids = explode(',', str_replace(' ', '', get_config('tool_dataprivacy', 'dporoles')));
155         if (!empty($configroleids)) {
156             // Fetch roles that have the capability to manage data requests.
157             $capableroles = array_keys(get_roles_with_capability('tool/dataprivacy:managedatarequests'));
159             // Extract the configured roles that have the capability from the list of capable roles.
160             $roleids = array_intersect($capableroles, $configroleids);
161         }
163         return $roleids;
164     }
166     /**
167      * Fetches the role shortnames of Data Protection Officer roles.
168      *
169      * @return array An array of the DPO role shortnames
170      */
171     public static function get_dpo_role_names() : array {
172         global $DB;
174         $dporoleids = self::get_assigned_privacy_officer_roles();
175         $dponames = array();
177         if (!empty($dporoleids)) {
178             list($insql, $inparams) = $DB->get_in_or_equal($dporoleids);
179             $dponames = $DB->get_fieldset_select('role', 'shortname', "id {$insql}", $inparams);
180         }
182         return $dponames;
183     }
185     /**
186      * Fetches the list of users with the Privacy Officer role.
187      */
188     public static function get_site_dpos() {
189         // Get role(s) that can manage data requests.
190         $dporoles = self::get_assigned_privacy_officer_roles();
192         $dpos = [];
193         $context = context_system::instance();
194         foreach ($dporoles as $roleid) {
195             $allnames = get_all_user_name_fields(true, 'u');
196             $fields = 'u.id, u.confirmed, u.username, '. $allnames . ', ' .
197                       'u.maildisplay, u.mailformat, u.maildigest, u.email, u.emailstop, u.city, '.
198                       'u.country, u.picture, u.idnumber, u.department, u.institution, '.
199                       'u.lang, u.timezone, u.lastaccess, u.mnethostid, u.auth, u.suspended, u.deleted, ' .
200                       'r.name AS rolename, r.sortorder, '.
201                       'r.shortname AS roleshortname, rn.name AS rolecoursealias';
202             // Fetch users that can manage data requests.
203             $dpos += get_role_users($roleid, $context, false, $fields);
204         }
206         // If the site has no data protection officer, defer to site admin(s).
207         if (empty($dpos)) {
208             $dpos = get_admins();
209         }
210         return $dpos;
211     }
213     /**
214      * Checks whether a given user is a site Privacy Officer.
215      *
216      * @param int $userid The user ID.
217      * @return bool
218      */
219     public static function is_site_dpo($userid) {
220         $dpos = self::get_site_dpos();
221         return array_key_exists($userid, $dpos) || is_siteadmin();
222     }
224     /**
225      * Lodges a data request and sends the request details to the site Data Protection Officer(s).
226      *
227      * @param int $foruser The user whom the request is being made for.
228      * @param int $type The request type.
229      * @param string $comments Request comments.
230      * @return data_request
231      * @throws invalid_persistent_exception
232      * @throws coding_exception
233      */
234     public static function create_data_request($foruser, $type, $comments = '') {
235         global $USER;
237         $datarequest = new data_request();
238         // The user the request is being made for.
239         $datarequest->set('userid', $foruser);
241         $requestinguser = $USER->id;
242         // Check when the user is making a request on behalf of another.
243         if ($requestinguser != $foruser) {
244             if (self::is_site_dpo($requestinguser)) {
245                 // The user making the request is a DPO. Should be fine.
246                 $datarequest->set('dpo', $requestinguser);
247             }
248         }
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);
258         // Store subject access request.
259         $datarequest->create();
261         // Fire an ad hoc task to initiate the data request process.
262         $task = new initiate_data_request_task();
263         $task->set_custom_data(['requestid' => $datarequest->get('id')]);
264         manager::queue_adhoc_task($task, true);
266         return $datarequest;
267     }
269     /**
270      * Fetches the list of the data requests.
271      *
272      * If user ID is provided, it fetches the data requests for the user.
273      * Otherwise, it fetches all of the data requests, provided that the user has the capability to manage data requests.
274      * (e.g. Users with the Data Protection Officer roles)
275      *
276      * @param int $userid The User ID.
277      * @param int[] $statuses The status filters.
278      * @param int[] $types The request type filters.
279      * @param string $sort The order by clause.
280      * @param int $offset Amount of records to skip.
281      * @param int $limit Amount of records to fetch.
282      * @return data_request[]
283      * @throws coding_exception
284      * @throws dml_exception
285      */
286     public static function get_data_requests($userid = 0, $statuses = [], $types = [], $sort = '', $offset = 0, $limit = 0) {
287         global $DB, $USER;
288         $results = [];
289         $sqlparams = [];
290         $sqlconditions = [];
292         // Set default sort.
293         if (empty($sort)) {
294             $sort = 'status ASC, timemodified ASC';
295         }
297         // Set status filters.
298         if (!empty($statuses)) {
299             list($statusinsql, $sqlparams) = $DB->get_in_or_equal($statuses, SQL_PARAMS_NAMED);
300             $sqlconditions[] = "status $statusinsql";
301         }
303         // Set request type filter.
304         if (!empty($types)) {
305             list($typeinsql, $typeparams) = $DB->get_in_or_equal($types, SQL_PARAMS_NAMED);
306             $sqlconditions[] = "type $typeinsql";
307             $sqlparams = array_merge($sqlparams, $typeparams);
308         }
310         if ($userid) {
311             // Get the data requests for the user or data requests made by the user.
312             $sqlconditions[] = "(userid = :userid OR requestedby = :requestedby)";
313             $params = [
314                 'userid' => $userid,
315                 'requestedby' => $userid
316             ];
318             // Build a list of user IDs that the user is allowed to make data requests for.
319             // Of course, the user should be included in this list.
320             $alloweduserids = [$userid];
321             // Get any users that the user can make data requests for.
322             if ($children = helper::get_children_of_user($userid)) {
323                 // Get the list of user IDs of the children and merge to the allowed user IDs.
324                 $alloweduserids = array_merge($alloweduserids, array_keys($children));
325             }
326             list($insql, $inparams) = $DB->get_in_or_equal($alloweduserids, SQL_PARAMS_NAMED);
327             $sqlconditions[] .= "userid $insql";
328             $select = implode(' AND ', $sqlconditions);
329             $params = array_merge($params, $inparams, $sqlparams);
331             $results = data_request::get_records_select($select, $params, $sort, '*', $offset, $limit);
332         } else {
333             // If the current user is one of the site's Data Protection Officers, then fetch all data requests.
334             if (self::is_site_dpo($USER->id)) {
335                 if (!empty($sqlconditions)) {
336                     $select = implode(' AND ', $sqlconditions);
337                     $results = data_request::get_records_select($select, $sqlparams, $sort, '*', $offset, $limit);
338                 } else {
339                     $results = data_request::get_records(null, $sort, '', $offset, $limit);
340                 }
341             }
342         }
344         // If any are due to expire, expire them and re-fetch updated data.
345         if (empty($statuses)
346                 || in_array(self::DATAREQUEST_STATUS_DOWNLOAD_READY, $statuses)
347                 || in_array(self::DATAREQUEST_STATUS_EXPIRED, $statuses)) {
348             $expiredrequests = data_request::get_expired_requests($userid);
350             if (!empty($expiredrequests)) {
351                 data_request::expire($expiredrequests);
352                 $results = self::get_data_requests($userid, $statuses, $types, $sort, $offset, $limit);
353             }
354         }
356         return $results;
357     }
359     /**
360      * Fetches the count of data request records based on the given parameters.
361      *
362      * @param int $userid The User ID.
363      * @param int[] $statuses The status filters.
364      * @param int[] $types The request type filters.
365      * @return int
366      * @throws coding_exception
367      * @throws dml_exception
368      */
369     public static function get_data_requests_count($userid = 0, $statuses = [], $types = []) {
370         global $DB, $USER;
371         $count = 0;
372         $sqlparams = [];
373         $sqlconditions = [];
374         if (!empty($statuses)) {
375             list($statusinsql, $sqlparams) = $DB->get_in_or_equal($statuses, SQL_PARAMS_NAMED);
376             $sqlconditions[] = "status $statusinsql";
377         }
378         if (!empty($types)) {
379             list($typeinsql, $typeparams) = $DB->get_in_or_equal($types, SQL_PARAMS_NAMED);
380             $sqlconditions[] = "type $typeinsql";
381             $sqlparams = array_merge($sqlparams, $typeparams);
382         }
383         if ($userid) {
384             // Get the data requests for the user or data requests made by the user.
385             $sqlconditions[] = "(userid = :userid OR requestedby = :requestedby)";
386             $params = [
387                 'userid' => $userid,
388                 'requestedby' => $userid
389             ];
391             // Build a list of user IDs that the user is allowed to make data requests for.
392             // Of course, the user should be included in this list.
393             $alloweduserids = [$userid];
394             // Get any users that the user can make data requests for.
395             if ($children = helper::get_children_of_user($userid)) {
396                 // Get the list of user IDs of the children and merge to the allowed user IDs.
397                 $alloweduserids = array_merge($alloweduserids, array_keys($children));
398             }
399             list($insql, $inparams) = $DB->get_in_or_equal($alloweduserids, SQL_PARAMS_NAMED);
400             $sqlconditions[] .= "userid $insql";
401             $select = implode(' AND ', $sqlconditions);
402             $params = array_merge($params, $inparams, $sqlparams);
404             $count = data_request::count_records_select($select, $params);
405         } else {
406             // If the current user is one of the site's Data Protection Officers, then fetch all data requests.
407             if (self::is_site_dpo($USER->id)) {
408                 if (!empty($sqlconditions)) {
409                     $select = implode(' AND ', $sqlconditions);
410                     $count = data_request::count_records_select($select, $sqlparams);
411                 } else {
412                     $count = data_request::count_records();
413                 }
414             }
415         }
417         return $count;
418     }
420     /**
421      * Checks whether there is already an existing pending/in-progress data request for a user for a given request type.
422      *
423      * @param int $userid The user ID.
424      * @param int $type The request type.
425      * @return bool
426      * @throws coding_exception
427      * @throws dml_exception
428      */
429     public static function has_ongoing_request($userid, $type) {
430         global $DB;
432         // Check if the user already has an incomplete data request of the same type.
433         $nonpendingstatuses = [
434             self::DATAREQUEST_STATUS_COMPLETE,
435             self::DATAREQUEST_STATUS_CANCELLED,
436             self::DATAREQUEST_STATUS_REJECTED,
437             self::DATAREQUEST_STATUS_DOWNLOAD_READY,
438             self::DATAREQUEST_STATUS_EXPIRED,
439             self::DATAREQUEST_STATUS_DELETED,
440         ];
441         list($insql, $inparams) = $DB->get_in_or_equal($nonpendingstatuses, SQL_PARAMS_NAMED);
442         $select = 'type = :type AND userid = :userid AND status NOT ' . $insql;
443         $params = array_merge([
444             'type' => $type,
445             'userid' => $userid
446         ], $inparams);
448         return data_request::record_exists_select($select, $params);
449     }
451     /**
452      * Determines whether a request is active or not based on its status.
453      *
454      * @param int $status The request status.
455      * @return bool
456      */
457     public static function is_active($status) {
458         // List of statuses which doesn't require any further processing.
459         $finalstatuses = [
460             self::DATAREQUEST_STATUS_COMPLETE,
461             self::DATAREQUEST_STATUS_CANCELLED,
462             self::DATAREQUEST_STATUS_REJECTED,
463             self::DATAREQUEST_STATUS_DOWNLOAD_READY,
464             self::DATAREQUEST_STATUS_EXPIRED,
465             self::DATAREQUEST_STATUS_DELETED,
466         ];
468         return !in_array($status, $finalstatuses);
469     }
471     /**
472      * Cancels the data request for a given request ID.
473      *
474      * @param int $requestid The request identifier.
475      * @param int $status The request status.
476      * @param int $dpoid The user ID of the Data Protection Officer
477      * @param string $comment The comment about the status update.
478      * @return bool
479      * @throws invalid_persistent_exception
480      * @throws coding_exception
481      */
482     public static function update_request_status($requestid, $status, $dpoid = 0, $comment = '') {
483         // Update the request.
484         $datarequest = new data_request($requestid);
485         $datarequest->set('status', $status);
486         if ($dpoid) {
487             $datarequest->set('dpo', $dpoid);
488         }
489         // Update the comment if necessary.
490         if (!empty(trim($comment))) {
491             $params = [
492                 'date' => userdate(time()),
493                 'comment' => $comment
494             ];
495             $commenttosave = get_string('datecomment', 'tool_dataprivacy', $params);
496             // Check if there's an existing DPO comment.
497             $currentcomment = trim($datarequest->get('dpocomment'));
498             if ($currentcomment) {
499                 // Append the new comment to the current comment and give them 1 line space in between.
500                 $commenttosave = $currentcomment . PHP_EOL . PHP_EOL . $commenttosave;
501             }
502             $datarequest->set('dpocomment', $commenttosave);
503         }
505         return $datarequest->update();
506     }
508     /**
509      * Fetches a request based on the request ID.
510      *
511      * @param int $requestid The request identifier
512      * @return data_request
513      */
514     public static function get_request($requestid) {
515         return new data_request($requestid);
516     }
518     /**
519      * Approves a data request based on the request ID.
520      *
521      * @param int $requestid The request identifier
522      * @return bool
523      * @throws coding_exception
524      * @throws dml_exception
525      * @throws invalid_persistent_exception
526      * @throws required_capability_exception
527      * @throws moodle_exception
528      */
529     public static function approve_data_request($requestid) {
530         global $USER;
532         // Check first whether the user can manage data requests.
533         if (!self::can_manage_data_requests($USER->id)) {
534             $context = context_system::instance();
535             throw new required_capability_exception($context, 'tool/dataprivacy:managedatarequests', 'nopermissions', '');
536         }
538         // Check if request is already awaiting for approval.
539         $request = new data_request($requestid);
540         if ($request->get('status') != self::DATAREQUEST_STATUS_AWAITING_APPROVAL) {
541             throw new moodle_exception('errorrequestnotwaitingforapproval', 'tool_dataprivacy');
542         }
544         // Update the status and the DPO.
545         $result = self::update_request_status($requestid, self::DATAREQUEST_STATUS_APPROVED, $USER->id);
547         // Approve all the contexts attached to the request.
548         // Currently, approving the request implicitly approves all associated contexts, but this may change in future, allowing
549         // users to selectively approve certain contexts only.
550         self::update_request_contexts_with_status($requestid, contextlist_context::STATUS_APPROVED);
552         // Fire an ad hoc task to initiate the data request process.
553         $task = new process_data_request_task();
554         $task->set_custom_data(['requestid' => $requestid]);
555         if ($request->get('type') == self::DATAREQUEST_TYPE_EXPORT) {
556             $task->set_userid($request->get('userid'));
557         }
558         manager::queue_adhoc_task($task, true);
560         return $result;
561     }
563     /**
564      * Rejects a data request based on the request ID.
565      *
566      * @param int $requestid The request identifier
567      * @return bool
568      * @throws coding_exception
569      * @throws dml_exception
570      * @throws invalid_persistent_exception
571      * @throws required_capability_exception
572      * @throws moodle_exception
573      */
574     public static function deny_data_request($requestid) {
575         global $USER;
577         if (!self::can_manage_data_requests($USER->id)) {
578             $context = context_system::instance();
579             throw new required_capability_exception($context, 'tool/dataprivacy:managedatarequests', 'nopermissions', '');
580         }
582         // Check if request is already awaiting for approval.
583         $request = new data_request($requestid);
584         if ($request->get('status') != self::DATAREQUEST_STATUS_AWAITING_APPROVAL) {
585             throw new moodle_exception('errorrequestnotwaitingforapproval', 'tool_dataprivacy');
586         }
588         // Update the status and the DPO.
589         return self::update_request_status($requestid, self::DATAREQUEST_STATUS_REJECTED, $USER->id);
590     }
592     /**
593      * Sends a message to the site's Data Protection Officer about a request.
594      *
595      * @param stdClass $dpo The DPO user record
596      * @param data_request $request The data request
597      * @return int|false
598      * @throws coding_exception
599      * @throws moodle_exception
600      */
601     public static function notify_dpo($dpo, data_request $request) {
602         global $PAGE, $SITE;
604         $output = $PAGE->get_renderer('tool_dataprivacy');
606         $usercontext = \context_user::instance($request->get('requestedby'));
607         $requestexporter = new data_request_exporter($request, ['context' => $usercontext]);
608         $requestdata = $requestexporter->export($output);
610         // Create message to send to the Data Protection Officer(s).
611         $typetext = null;
612         $typetext = $requestdata->typename;
613         $subject = get_string('datarequestemailsubject', 'tool_dataprivacy', $typetext);
615         $requestedby = $requestdata->requestedbyuser;
616         $datarequestsurl = new moodle_url('/admin/tool/dataprivacy/datarequests.php');
617         $message = new message();
618         $message->courseid          = $SITE->id;
619         $message->component         = 'tool_dataprivacy';
620         $message->name              = 'contactdataprotectionofficer';
621         $message->userfrom          = $requestedby->id;
622         $message->replyto           = $requestedby->email;
623         $message->replytoname       = $requestedby->fullname;
624         $message->subject           = $subject;
625         $message->fullmessageformat = FORMAT_HTML;
626         $message->notification      = 1;
627         $message->contexturl        = $datarequestsurl;
628         $message->contexturlname    = get_string('datarequests', 'tool_dataprivacy');
630         // Prepare the context data for the email message body.
631         $messagetextdata = [
632             'requestedby' => $requestedby->fullname,
633             'requesttype' => $typetext,
634             'requestdate' => userdate($requestdata->timecreated),
635             'requestorigin' => $SITE->fullname,
636             'requestoriginurl' => new moodle_url('/'),
637             'requestcomments' => $requestdata->messagehtml,
638             'datarequestsurl' => $datarequestsurl
639         ];
640         $requestingfor = $requestdata->foruser;
641         if ($requestedby->id == $requestingfor->id) {
642             $messagetextdata['requestfor'] = $messagetextdata['requestedby'];
643         } else {
644             $messagetextdata['requestfor'] = $requestingfor->fullname;
645         }
647         // Email the data request to the Data Protection Officer(s)/Admin(s).
648         $messagetextdata['dponame'] = fullname($dpo);
649         // Render message email body.
650         $messagehtml = $output->render_from_template('tool_dataprivacy/data_request_email', $messagetextdata);
651         $message->userto = $dpo;
652         $message->fullmessage = html_to_text($messagehtml);
653         $message->fullmessagehtml = $messagehtml;
655         // Send message.
656         return message_send($message);
657     }
659     /**
660      * Checks whether a non-DPO user can make a data request for another user.
661      *
662      * @param   int     $user The user ID of the target user.
663      * @param   int     $requester The user ID of the user making the request.
664      * @return  bool
665      */
666     public static function can_create_data_request_for_user($user, $requester = null) {
667         $usercontext = \context_user::instance($user);
669         return has_capability('tool/dataprivacy:makedatarequestsforchildren', $usercontext, $requester);
670     }
672     /**
673      * Require that the current user can make a data request for the specified other user.
674      *
675      * @param   int     $user The user ID of the target user.
676      * @param   int     $requester The user ID of the user making the request.
677      * @return  bool
678      */
679     public static function require_can_create_data_request_for_user($user, $requester = null) {
680         $usercontext = \context_user::instance($user);
682         require_capability('tool/dataprivacy:makedatarequestsforchildren', $usercontext, $requester);
684         return true;
685     }
687     /**
688      * Checks whether a user can download a data request.
689      *
690      * @param int $userid Target user id (subject of data request)
691      * @param int $requesterid Requester user id (person who requsted it)
692      * @param int|null $downloaderid Person who wants to download user id (default current)
693      * @return bool
694      * @throws coding_exception
695      */
696     public static function can_download_data_request_for_user($userid, $requesterid, $downloaderid = null) {
697         global $USER;
699         if (!$downloaderid) {
700             $downloaderid = $USER->id;
701         }
703         $usercontext = \context_user::instance($userid);
704         // If it's your own and you have the right capability, you can download it.
705         if ($userid == $downloaderid && has_capability('tool/dataprivacy:downloadownrequest', $usercontext, $downloaderid)) {
706             return true;
707         }
708         // If you can download anyone's in that context, you can download it.
709         if (has_capability('tool/dataprivacy:downloadallrequests', $usercontext, $downloaderid)) {
710             return true;
711         }
712         // If you can have the 'child access' ability to request in that context, and you are the one
713         // who requested it, then you can download it.
714         if ($requesterid == $downloaderid && self::can_create_data_request_for_user($userid, $requesterid)) {
715             return true;
716         }
717         return false;
718     }
720     /**
721      * Gets an action menu link to download a data request.
722      *
723      * @param \context_user $usercontext User context (of user who the data is for)
724      * @param int $requestid Request id
725      * @return \action_menu_link_secondary Action menu link
726      * @throws coding_exception
727      */
728     public static function get_download_link(\context_user $usercontext, $requestid) {
729         $downloadurl = moodle_url::make_pluginfile_url($usercontext->id,
730                 'tool_dataprivacy', 'export', $requestid, '/', 'export.zip', true);
731         $downloadtext = get_string('download', 'tool_dataprivacy');
732         return new \action_menu_link_secondary($downloadurl, null, $downloadtext);
733     }
735     /**
736      * Creates a new data purpose.
737      *
738      * @param stdClass $record
739      * @return \tool_dataprivacy\purpose.
740      */
741     public static function create_purpose(stdClass $record) {
742         $purpose = new purpose(0, $record);
743         $purpose->create();
745         return $purpose;
746     }
748     /**
749      * Updates an existing data purpose.
750      *
751      * @param stdClass $record
752      * @return \tool_dataprivacy\purpose.
753      */
754     public static function update_purpose(stdClass $record) {
755         if (!isset($record->sensitivedatareasons)) {
756             $record->sensitivedatareasons = '';
757         }
759         $purpose = new purpose($record->id);
760         $purpose->from_record($record);
762         $result = $purpose->update();
764         return $purpose;
765     }
767     /**
768      * Deletes a data purpose.
769      *
770      * @param int $id
771      * @return bool
772      */
773     public static function delete_purpose($id) {
774         $purpose = new purpose($id);
775         if ($purpose->is_used()) {
776             throw new \moodle_exception('Purpose with id ' . $id . ' can not be deleted because it is used.');
777         }
778         return $purpose->delete();
779     }
781     /**
782      * Get all system data purposes.
783      *
784      * @return \tool_dataprivacy\purpose[]
785      */
786     public static function get_purposes() {
787         return purpose::get_records([], 'name', 'ASC');
788     }
790     /**
791      * Creates a new data category.
792      *
793      * @param stdClass $record
794      * @return \tool_dataprivacy\category.
795      */
796     public static function create_category(stdClass $record) {
797         $category = new category(0, $record);
798         $category->create();
800         return $category;
801     }
803     /**
804      * Updates an existing data category.
805      *
806      * @param stdClass $record
807      * @return \tool_dataprivacy\category.
808      */
809     public static function update_category(stdClass $record) {
810         $category = new category($record->id);
811         $category->from_record($record);
813         $result = $category->update();
815         return $category;
816     }
818     /**
819      * Deletes a data category.
820      *
821      * @param int $id
822      * @return bool
823      */
824     public static function delete_category($id) {
825         $category = new category($id);
826         if ($category->is_used()) {
827             throw new \moodle_exception('Category with id ' . $id . ' can not be deleted because it is used.');
828         }
829         return $category->delete();
830     }
832     /**
833      * Get all system data categories.
834      *
835      * @return \tool_dataprivacy\category[]
836      */
837     public static function get_categories() {
838         return category::get_records([], 'name', 'ASC');
839     }
841     /**
842      * Sets the context instance purpose and category.
843      *
844      * @param \stdClass $record
845      * @return \tool_dataprivacy\context_instance
846      */
847     public static function set_context_instance($record) {
848         if ($instance = context_instance::get_record_by_contextid($record->contextid, false)) {
849             // Update.
850             $instance->from_record($record);
852             if (empty($record->purposeid) && empty($record->categoryid)) {
853                 // We accept one of them to be null but we delete it if both are null.
854                 self::unset_context_instance($instance);
855                 return;
856             }
858         } else {
859             // Add.
860             $instance = new context_instance(0, $record);
861         }
862         $instance->save();
864         return $instance;
865     }
867     /**
868      * Unsets the context instance record.
869      *
870      * @param \tool_dataprivacy\context_instance $instance
871      * @return null
872      */
873     public static function unset_context_instance(context_instance $instance) {
874         $instance->delete();
875     }
877     /**
878      * Sets the context level purpose and category.
879      *
880      * @throws \coding_exception
881      * @param \stdClass $record
882      * @return contextlevel
883      */
884     public static function set_contextlevel($record) {
885         global $DB;
887         if ($record->contextlevel != CONTEXT_SYSTEM && $record->contextlevel != CONTEXT_USER) {
888             throw new \coding_exception('Only context system and context user can set a contextlevel ' .
889                 'purpose and retention');
890         }
892         if ($contextlevel = contextlevel::get_record_by_contextlevel($record->contextlevel, false)) {
893             // Update.
894             $contextlevel->from_record($record);
895         } else {
896             // Add.
897             $contextlevel = new contextlevel(0, $record);
898         }
899         $contextlevel->save();
901         // We sync with their defaults as we removed these options from the defaults page.
902         $classname = \context_helper::get_class_for_level($record->contextlevel);
903         list($purposevar, $categoryvar) = data_registry::var_names_from_context($classname);
904         set_config($purposevar, $record->purposeid, 'tool_dataprivacy');
905         set_config($categoryvar, $record->categoryid, 'tool_dataprivacy');
907         return $contextlevel;
908     }
910     /**
911      * Returns the effective category given a context instance.
912      *
913      * @param \context $context
914      * @param int $forcedvalue Use this categoryid value as if this was this context instance category.
915      * @return category|false
916      */
917     public static function get_effective_context_category(\context $context, $forcedvalue=false) {
918         if (!data_registry::defaults_set()) {
919             return false;
920         }
922         return data_registry::get_effective_context_value($context, 'category', $forcedvalue);
923     }
925     /**
926      * Returns the effective purpose given a context instance.
927      *
928      * @param \context $context
929      * @param int $forcedvalue Use this purposeid value as if this was this context instance purpose.
930      * @return purpose|false
931      */
932     public static function get_effective_context_purpose(\context $context, $forcedvalue = false) {
933         if (!data_registry::defaults_set()) {
934             return false;
935         }
937         return data_registry::get_effective_context_value($context, 'purpose', $forcedvalue);
938     }
940     /**
941      * Returns the effective category given a context level.
942      *
943      * @param int $contextlevel
944      * @param int $forcedvalue Use this categoryid value as if this was this context level category.
945      * @return category|false
946      */
947     public static function get_effective_contextlevel_category($contextlevel, $forcedvalue=false) {
948         if (!data_registry::defaults_set()) {
949             return false;
950         }
952         return data_registry::get_effective_contextlevel_value($contextlevel, 'category', $forcedvalue);
953     }
955     /**
956      * Returns the effective purpose given a context level.
957      *
958      * @param int $contextlevel
959      * @param int $forcedvalue Use this purposeid value as if this was this context level purpose.
960      * @return purpose|false
961      */
962     public static function get_effective_contextlevel_purpose($contextlevel, $forcedvalue=false) {
963         if (!data_registry::defaults_set()) {
964             return false;
965         }
967         return data_registry::get_effective_contextlevel_value($contextlevel, 'purpose', $forcedvalue);
968     }
970     /**
971      * Updates the status of an expired context.
972      *
973      * @param \tool_dataprivacy\expired_context $expiredctx
974      * @param int $status
975      * @return null
976      */
977     public static function set_expired_context_status(expired_context $expiredctx, $status) {
978         $expiredctx->set('status', $status);
979         $expiredctx->save();
980     }
982     /**
983      * Adds the contexts from the contextlist_collection to the request with the status provided.
984      *
985      * @param contextlist_collection $clcollection a collection of contextlists for all components.
986      * @param int $requestid the id of the request.
987      * @param int $status the status to set the contexts to.
988      */
989     public static function add_request_contexts_with_status(contextlist_collection $clcollection, int $requestid, int $status) {
990         $request = new data_request($requestid);
991         foreach ($clcollection as $contextlist) {
992             // Convert the \core_privacy\local\request\contextlist into a contextlist persistent and store it.
993             $clp = \tool_dataprivacy\contextlist::from_contextlist($contextlist);
994             $clp->create();
995             $contextlistid = $clp->get('id');
997             // Store the associated contexts in the contextlist.
998             foreach ($contextlist->get_contextids() as $contextid) {
999                 if ($request->get('type') == static::DATAREQUEST_TYPE_DELETE) {
1000                     $context = \context::instance_by_id($contextid);
1001                     if (($purpose = static::get_effective_context_purpose($context)) && !empty($purpose->get('protected'))) {
1002                         continue;
1003                     }
1004                 }
1005                 $context = new contextlist_context();
1006                 $context->set('contextid', $contextid)
1007                     ->set('contextlistid', $contextlistid)
1008                     ->set('status', $status)
1009                     ->create();
1010             }
1012             // Create the relation to the request.
1013             $requestcontextlist = request_contextlist::create_relation($requestid, $contextlistid);
1014             $requestcontextlist->create();
1015         }
1016     }
1018     /**
1019      * Sets the status of all contexts associated with the request.
1020      *
1021      * @param int $requestid the requestid to which the contexts belong.
1022      * @param int $status the status to set to.
1023      * @throws \dml_exception if the requestid is invalid.
1024      * @throws \moodle_exception if the status is invalid.
1025      */
1026     public static function update_request_contexts_with_status(int $requestid, int $status) {
1027         // Validate contextlist_context status using the persistent's attribute validation.
1028         $contextlistcontext = new contextlist_context();
1029         $contextlistcontext->set('status', $status);
1030         if (array_key_exists('status', $contextlistcontext->get_errors())) {
1031             throw new moodle_exception("Invalid contextlist_context status: $status");
1032         }
1034         // Validate requestid using the persistent's record validation.
1035         // A dml_exception is thrown if the record is missing.
1036         $datarequest = new data_request($requestid);
1038         // Bulk update the status of the request contexts.
1039         global $DB;
1041         $select = "SELECT ctx.id as id
1042                      FROM {" . request_contextlist::TABLE . "} rcl
1043                      JOIN {" . contextlist::TABLE . "} cl ON rcl.contextlistid = cl.id
1044                      JOIN {" . contextlist_context::TABLE . "} ctx ON cl.id = ctx.contextlistid
1045                     WHERE rcl.requestid = ?";
1047         // Fetch records IDs to be updated and update by chunks, if applicable (limit of 1000 records per update).
1048         $limit = 1000;
1049         $idstoupdate = $DB->get_fieldset_sql($select, [$requestid]);
1050         $count = count($idstoupdate);
1051         $idchunks = $idstoupdate;
1052         if ($count > $limit) {
1053             $idchunks = array_chunk($idstoupdate, $limit);
1054         }
1055         $transaction = $DB->start_delegated_transaction();
1056         $initialparams = [$status];
1057         foreach ($idchunks as $chunk) {
1058             list($insql, $inparams) = $DB->get_in_or_equal($chunk);
1059             $update = "UPDATE {" . contextlist_context::TABLE . "}
1060                           SET status = ?
1061                         WHERE id $insql";
1062             $params = array_merge($initialparams, $inparams);
1063             $DB->execute($update, $params);
1064         }
1065         $transaction->allow_commit();
1066     }
1068     /**
1069      * Finds all request contextlists having at least on approved context, and returns them as in a contextlist_collection.
1070      *
1071      * @param data_request $request the data request with which the contextlists are associated.
1072      * @return contextlist_collection the collection of approved_contextlist objects.
1073      */
1074     public static function get_approved_contextlist_collection_for_request(data_request $request) : contextlist_collection {
1075         $foruser = core_user::get_user($request->get('userid'));
1077         // Fetch all approved contextlists and create the core_privacy\local\request\contextlist objects here.
1078         global $DB;
1079         $sql = "SELECT cl.component, ctx.contextid
1080                   FROM {" . request_contextlist::TABLE . "} rcl
1081                   JOIN {" . contextlist::TABLE . "} cl ON rcl.contextlistid = cl.id
1082                   JOIN {" . contextlist_context::TABLE . "} ctx ON cl.id = ctx.contextlistid
1083                  WHERE rcl.requestid = ?
1084                    AND ctx.status = ?
1085               ORDER BY cl.component, ctx.contextid";
1087         // Create the approved contextlist collection object.
1088         $lastcomponent = null;
1089         $approvedcollection = new contextlist_collection($foruser->id);
1091         $rs = $DB->get_recordset_sql($sql, [$request->get('id'), contextlist_context::STATUS_APPROVED]);
1092         foreach ($rs as $record) {
1093             // If we encounter a new component, and we've built up contexts for the last, then add the approved_contextlist for the
1094             // last (the one we've just finished with) and reset the context array for the next one.
1095             if ($lastcomponent != $record->component) {
1096                 if (!empty($contexts)) {
1097                     $approvedcollection->add_contextlist(new approved_contextlist($foruser, $lastcomponent, $contexts));
1098                 }
1099                 $contexts = [];
1100             }
1102             $contexts[] = $record->contextid;
1103             $lastcomponent = $record->component;
1104         }
1105         $rs->close();
1107         // The data for the last component contextlist won't have been written yet, so write it now.
1108         if (!empty($contexts)) {
1109             $approvedcollection->add_contextlist(new approved_contextlist($foruser, $lastcomponent, $contexts));
1110         }
1112         return $approvedcollection;
1113     }
1115     /**
1116      * Updates the default category and purpose for a given context level (and optionally, a plugin).
1117      *
1118      * @param int $contextlevel The context level.
1119      * @param int $categoryid The ID matching the category.
1120      * @param int $purposeid The ID matching the purpose record.
1121      * @param int $activity The name of the activity that we're making a defaults configuration for.
1122      * @param bool $override Whether to override the purpose/categories of existing instances to these defaults.
1123      * @return boolean True if set/unset config succeeds. Otherwise, it throws an exception.
1124      */
1125     public static function set_context_defaults($contextlevel, $categoryid, $purposeid, $activity = null, $override = false) {
1126         global $DB;
1128         // Get the class name associated with this context level.
1129         $classname = context_helper::get_class_for_level($contextlevel);
1130         list($purposevar, $categoryvar) = data_registry::var_names_from_context($classname, $activity);
1132         // Check the default category to be set.
1133         if ($categoryid == context_instance::INHERIT) {
1134             unset_config($categoryvar, 'tool_dataprivacy');
1136         } else {
1137             // Make sure the given category ID exists first.
1138             $categorypersistent = new category($categoryid);
1139             $categorypersistent->read();
1141             // Then set the new default value.
1142             set_config($categoryvar, $categoryid, 'tool_dataprivacy');
1143         }
1145         // Check the default purpose to be set.
1146         if ($purposeid == context_instance::INHERIT) {
1147             // If the defaults is set to inherit, just unset the config value.
1148             unset_config($purposevar, 'tool_dataprivacy');
1150         } else {
1151             // Make sure the given purpose ID exists first.
1152             $purposepersistent = new purpose($purposeid);
1153             $purposepersistent->read();
1155             // Then set the new default value.
1156             set_config($purposevar, $purposeid, 'tool_dataprivacy');
1157         }
1159         // Unset instances that have been assigned with custom purpose and category, if override was specified.
1160         if ($override) {
1161             // We'd like to find context IDs that we want to unset.
1162             $statements = ["SELECT c.id as contextid FROM {context} c"];
1163             // Based on this context level.
1164             $params = ['contextlevel' => $contextlevel];
1166             if ($contextlevel == CONTEXT_MODULE) {
1167                 // If we're deleting module context instances, we need to make sure the instance ID is in the course modules table.
1168                 $statements[] = "JOIN {course_modules} cm ON cm.id = c.instanceid";
1169                 // And that the module is listed on the modules table.
1170                 $statements[] = "JOIN {modules} m ON m.id = cm.module";
1172                 if ($activity) {
1173                     // If we're overriding for an activity module, make sure that the context instance matches that activity.
1174                     $statements[] = "AND m.name = :modname";
1175                     $params['modname'] = $activity;
1176                 }
1177             }
1178             // Make sure this context instance exists in the tool_dataprivacy_ctxinstance table.
1179             $statements[] = "JOIN {tool_dataprivacy_ctxinstance} tdc ON tdc.contextid = c.id";
1180             // And that the context level of this instance matches the given context level.
1181             $statements[] = "WHERE c.contextlevel = :contextlevel";
1183             // Build our SQL query by gluing the statements.
1184             $sql = implode("\n", $statements);
1186             // Get the context records matching our query.
1187             $contextids = $DB->get_fieldset_sql($sql, $params);
1189             // Delete the matching context instances.
1190             foreach ($contextids as $contextid) {
1191                 if ($instance = context_instance::get_record_by_contextid($contextid, false)) {
1192                     self::unset_context_instance($instance);
1193                 }
1194             }
1195         }
1197         return true;
1198     }