on-demand release 3.7dev+
[moodle.git] / admin / tool / dataprivacy / createdatarequest_form.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  * The contact form to the site's Data Protection Officer
19  *
20  * @copyright 2018 onwards Jun Pataleta
21  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
22  * @package tool_dataprivacy
23  */
25 use tool_dataprivacy\api;
26 use tool_dataprivacy\local\helper;
28 defined('MOODLE_INTERNAL') || die();
30 require_once($CFG->libdir.'/formslib.php');
32 /**
33  * The contact form to the site's Data Protection Officer
34  *
35  * @copyright 2018 onwards Jun Pataleta
36  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
37  * @package tool_dataprivacy
38  */
39 class tool_dataprivacy_data_request_form extends moodleform {
41     /** @var bool Flag to indicate whether this form is being rendered for managing data requests or for regular requests. */
42     protected $manage = false;
44     /**
45      * Form definition.
46      *
47      * @throws coding_exception
48      */
49     public function definition() {
50         global $USER;
51         $mform =& $this->_form;
53         $this->manage = $this->_customdata['manage'];
54         if ($this->manage) {
55             $options = [
56                 'ajax' => 'tool_dataprivacy/form-user-selector',
57                 'valuehtmlcallback' => function($value) {
58                     global $OUTPUT;
60                     $allusernames = get_all_user_name_fields(true);
61                     $fields = 'id, email, ' . $allusernames;
62                     $user = \core_user::get_user($value, $fields);
63                     $useroptiondata = [
64                         'fullname' => fullname($user),
65                         'email' => $user->email
66                     ];
67                     return $OUTPUT->render_from_template('tool_dataprivacy/form-user-selector-suggestion', $useroptiondata);
68                 }
69             ];
70             $mform->addElement('autocomplete', 'userid', get_string('requestfor', 'tool_dataprivacy'), [], $options);
71             $mform->addRule('userid', null, 'required', null, 'client');
73         } else {
74             // Get users whom you are being a guardian to if your role has the capability to make data requests for children.
75             if ($children = helper::get_children_of_user($USER->id)) {
76                 $useroptions = [
77                     $USER->id => fullname($USER)
78                 ];
79                 foreach ($children as $key => $child) {
80                     $useroptions[$key] = fullname($child);
81                 }
82                 $mform->addElement('autocomplete', 'userid', get_string('requestfor', 'tool_dataprivacy'), $useroptions);
83                 $mform->addRule('userid', null, 'required', null, 'client');
85             } else {
86                 // Requesting for self.
87                 $mform->addElement('hidden', 'userid', $USER->id);
88             }
89         }
91         $mform->setType('userid', PARAM_INT);
93         // Subject access request type.
94         $options = [
95             api::DATAREQUEST_TYPE_EXPORT => get_string('requesttypeexport', 'tool_dataprivacy'),
96             api::DATAREQUEST_TYPE_DELETE => get_string('requesttypedelete', 'tool_dataprivacy')
97         ];
98         $mform->addElement('select', 'type', get_string('requesttype', 'tool_dataprivacy'), $options);
99         $mform->setType('type', PARAM_INT);
100         $mform->addHelpButton('type', 'requesttype', 'tool_dataprivacy');
102         // Request comments text area.
103         $textareaoptions = ['cols' => 60, 'rows' => 10];
104         $mform->addElement('textarea', 'comments', get_string('requestcomments', 'tool_dataprivacy'), $textareaoptions);
105         $mform->setType('type', PARAM_ALPHANUM);
106         $mform->addHelpButton('comments', 'requestcomments', 'tool_dataprivacy');
108         // Action buttons.
109         $this->add_action_buttons();
111     }
113     /**
114      * Form validation.
115      *
116      * @param array $data
117      * @param array $files
118      * @return array
119      * @throws coding_exception
120      * @throws dml_exception
121      */
122     public function validation($data, $files) {
123         $errors = [];
125         $validrequesttypes = [
126             api::DATAREQUEST_TYPE_EXPORT,
127             api::DATAREQUEST_TYPE_DELETE
128         ];
129         if (!in_array($data['type'], $validrequesttypes)) {
130             $errors['type'] = get_string('errorinvalidrequesttype', 'tool_dataprivacy');
131         }
133         if (api::has_ongoing_request($data['userid'], $data['type'])) {
134             $errors['type'] = get_string('errorrequestalreadyexists', 'tool_dataprivacy');
135         }
137         return $errors;
138     }