298d8215f6300ea00196bced4d6997c05e736afe
[moodle.git] / admin / tool / log / store / legacy / classes / privacy / provider.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  * Data provider.
19  *
20  * @package    logstore_legacy
21  * @copyright  2018 Frédéric Massart
22  * @author     Frédéric Massart <fred@branchup.tech>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 namespace logstore_legacy\privacy;
27 defined('MOODLE_INTERNAL') || die();
29 use context;
30 use core_privacy\local\metadata\collection;
31 use core_privacy\local\request\approved_contextlist;
32 use core_privacy\local\request\contextlist;
33 use core_privacy\local\request\transform;
34 use core_privacy\local\request\writer;
35 use tool_log\local\privacy\helper;
37 /**
38  * Data provider class.
39  *
40  * @package    logstore_legacy
41  * @copyright  2018 Frédéric Massart
42  * @author     Frédéric Massart <fred@branchup.tech>
43  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44  */
45 class provider implements
46     \core_privacy\local\metadata\provider,
47     \tool_log\local\privacy\logstore_provider {
49     /**
50      * Returns metadata.
51      *
52      * @param collection $collection The initialised collection to add items to.
53      * @return collection A listing of user data stored through this system.
54      */
55     public static function get_metadata(collection $collection) : collection {
56         $collection->add_external_location_link('log', [
57             'time' => 'privacy:metadata:log:time',
58             'userid' => 'privacy:metadata:log:userid',
59             'ip' => 'privacy:metadata:log:ip',
60             'action' => 'privacy:metadata:log:action',
61             'url' => 'privacy:metadata:log:url',
62             'info' => 'privacy:metadata:log:info',
63         ], 'privacy:metadata:log');
64         return $collection;
65     }
67     /**
68      * Add contexts that contain user information for the specified user.
69      *
70      * @param contextlist $contextlist The contextlist to add the contexts to.
71      * @param int $userid The user to find the contexts for.
72      * @return void
73      */
74     public static function add_contexts_for_userid(contextlist $contextlist, $userid) {
75         $sql = "
76             SELECT ctx.id
77               FROM {context} ctx
78               JOIN {log} l
79                 ON (l.cmid = 0 AND l.course = ctx.instanceid AND ctx.contextlevel = :courselevel)
80                 OR (l.cmid > 0 AND l.cmid = ctx.instanceid AND ctx.contextlevel = :modulelevel)
81                 OR (l.course <= 0 AND ctx.id = :syscontextid)
82              WHERE l.userid = :userid";
83         $params = [
84             'courselevel' => CONTEXT_COURSE,
85             'modulelevel' => CONTEXT_MODULE,
86             'syscontextid' => SYSCONTEXTID,
87             'userid' => $userid,
88         ];
89         $contextlist->add_from_sql($sql, $params);
90     }
92     /**
93      * Export all user data for the specified user, in the specified contexts.
94      *
95      * @param approved_contextlist $contextlist The approved contexts to export information for.
96      */
97     public static function export_user_data(approved_contextlist $contextlist) {
98         global $DB;
100         $userid = $contextlist->get_user()->id;
101         list($insql, $inparams) = static::get_sql_where_from_contexts($contextlist->get_contexts());
102         if (empty($insql)) {
103             return;
104         }
105         $sql = "userid = :userid AND $insql";
106         $params = array_merge($inparams, ['userid' => $userid]);
108         $path = [get_string('privacy:path:logs', 'tool_log'), get_string('pluginname', 'logstore_legacy')];
109         $flush = function($lastcontextid, $data) use ($path) {
110             $context = context::instance_by_id($lastcontextid);
111             writer::with_context($context)->export_data($path, (object) ['logs' => $data]);
112         };
114         $lastcontextid = null;
115         $data = [];
116         $recordset = $DB->get_recordset_select('log', $sql, $params, 'course, cmid, time, id');
117         foreach ($recordset as $record) {
118             $event = \logstore_legacy\event\legacy_logged::restore_legacy($record);
119             $context = $event->get_context();
120             if ($lastcontextid && $lastcontextid != $context->id) {
121                 $flush($lastcontextid, $data);
122                 $data = [];
123             }
125             $extra = $event->get_logextra();
126             $data[] = [
127                 'name' => $event->get_name(),
128                 'description' => $event->get_description(),
129                 'timecreated' => transform::datetime($event->timecreated),
130                 'ip' => $extra['ip'],
131                 'origin' => helper::transform_origin($extra['origin']),
132             ];
134             $lastcontextid = $context->id;
135         }
136         if ($lastcontextid) {
137             $flush($lastcontextid, $data);
138         }
139         $recordset->close();
140     }
142     /**
143      * Delete all data for all users in the specified context.
144      *
145      * @param context $context The specific context to delete data for.
146      */
147     public static function delete_data_for_all_users_in_context(context $context) {
148         global $DB;
149         list($sql, $params) = static::get_sql_where_from_contexts([$context]);
150         if (empty($sql)) {
151             return;
152         }
153         $DB->delete_records_select('log', $sql, $params);
154     }
156     /**
157      * Delete all user data for the specified user, in the specified contexts.
158      *
159      * @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
160      */
161     public static function delete_data_for_user(approved_contextlist $contextlist) {
162         global $DB;
163         list($sql, $params) = static::get_sql_where_from_contexts($contextlist->get_contexts());
164         if (empty($sql)) {
165             return;
166         }
167         $userid = $contextlist->get_user()->id;
168         $DB->delete_records_select('log', "$sql AND userid = :userid", array_merge($params, ['userid' => $userid]));
169     }
171     /**
172      * Get an SQL where statement from a list of contexts.
173      *
174      * @param array $contexts The contexts.
175      * @return array [$sql, $params]
176      */
177     protected static function get_sql_where_from_contexts(array $contexts) {
178         global $DB;
180         $sorted = array_reduce($contexts, function ($carry, $context) {
181             $level = $context->contextlevel;
182             if ($level == CONTEXT_MODULE || $level == CONTEXT_COURSE) {
183                 $carry[$level][] = $context->instanceid;
184             } else if ($level == CONTEXT_SYSTEM) {
185                 $carry[$level] = $context->id;
186             }
187             return $carry;
188         }, [
189             CONTEXT_COURSE => [],
190             CONTEXT_MODULE => [],
191             CONTEXT_SYSTEM => null,
192         ]);
194         $sqls = [];
195         $params = [];
197         if (!empty($sorted[CONTEXT_MODULE])) {
198             list($insql, $inparams) = $DB->get_in_or_equal($sorted[CONTEXT_MODULE], SQL_PARAMS_NAMED);
199             $sqls[] = "cmid $insql";
200             $params = array_merge($params, $inparams);
201         }
203         if (!empty($sorted[CONTEXT_COURSE])) {
204             list($insql, $inparams) = $DB->get_in_or_equal($sorted[CONTEXT_COURSE], SQL_PARAMS_NAMED);
206             $sqls[] = "cmid = 0 AND course $insql";
207             $params = array_merge($params, $inparams);
208         }
210         if (!empty($sorted[CONTEXT_SYSTEM])) {
211             $sqls[] = "course <= 0";
212         }
214         if (empty($sqls)) {
215             return [null, null];
216         }
218         return ['((' . implode(') OR (', $sqls) . '))', $params];
219     }