Merge branch 'MDL-63903-master' of https://github.com/snake/moodle
[moodle.git] / admin / tool / dataprivacy / classes / task / delete_existing_deleted_users.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  * Scheduled task to create delete data request for pre-existing deleted users.
19  *
20  * @package    tool_dataprivacy
21  * @copyright  2018 Mihail Geshoski
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace tool_dataprivacy\task;
27 use core\task\scheduled_task;
28 use tool_dataprivacy\api;
29 use tool_dataprivacy\data_request;
31 defined('MOODLE_INTERNAL') || die();
33 require_once($CFG->dirroot . '/' . $CFG->admin . '/tool/dataprivacy/lib.php');
35 /**
36  * Scheduled task to create delete data request for pre-existing deleted users.
37  *
38  * @package    tool_dataprivacy
39  * @copyright  2018 Mihail Geshoski
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
42 class delete_existing_deleted_users extends scheduled_task {
44     /**
45      * Returns the task name.
46      *
47      * @return string
48      */
49     public function get_name() {
50         return get_string('deleteexistingdeleteduserstask', 'tool_dataprivacy');
51     }
53     /**
54      * Run the task to delete expired data request files and update request statuses.
55      *
56      */
57     public function execute() {
58         global $DB;
60         // Select all deleted users that do not have any delete data requests created for them.
61         $sql = "SELECT DISTINCT(u.id)
62                   FROM {user} u
63              LEFT JOIN {tool_dataprivacy_request} r
64                        ON u.id = r.userid
65                  WHERE u.deleted = ?
66                        AND (r.id IS NULL
67                            OR r.type != ?)";
69         $params = [
70             1,
71             api::DATAREQUEST_TYPE_DELETE
72         ];
74         $deletedusers = $DB->get_records_sql($sql, $params);
75         $createdrequests = 0;
77         foreach ($deletedusers as $user) {
78             api::create_data_request($user->id, api::DATAREQUEST_TYPE_DELETE,
79                     get_string('datarequestcreatedfromscheduledtask', 'tool_dataprivacy'),
80                     data_request::DATAREQUEST_CREATION_AUTO);
81             $createdrequests++;
82         }
84         if ($createdrequests > 0) {
85             mtrace($createdrequests . ' delete data request(s) created for existing deleted users');
86         }
87     }
88 }