Merge branch 'MDL-62135-master' of git://github.com/FMCorz/moodle
[moodle.git] / admin / tool / log / store / standard / 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_standard
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_standard\privacy;
27 defined('MOODLE_INTERNAL') || die();
29 use context;
30 use core_privacy\local\metadata\collection;
31 use core_privacy\local\request\contextlist;
33 /**
34  * Data provider class.
35  *
36  * @package    logstore_standard
37  * @copyright  2018 Frédéric Massart
38  * @author     Frédéric Massart <fred@branchup.tech>
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class provider implements
42     \core_privacy\local\metadata\provider,
43     \tool_log\local\privacy\logstore_provider {
45     use \tool_log\local\privacy\moodle_database_export_and_delete;
47     /**
48      * Returns metadata.
49      *
50      * @param collection $collection The initialised collection to add items to.
51      * @return collection A listing of user data stored through this system.
52      */
53     public static function get_metadata(collection $collection) : collection {
54         $collection->add_database_table('log', [
55             'eventname' => 'privacy:metadata:log:eventname',
56             'userid' => 'privacy:metadata:log:userid',
57             'relateduserid' => 'privacy:metadata:log:relateduserid',
58             'anonymous' => 'privacy:metadata:log:anonymous',
59             'other' => 'privacy:metadata:log:other',
60             'timecreated' => 'privacy:metadata:log:timecreated',
61             'origin' => 'privacy:metadata:log:origin',
62             'ip' => 'privacy:metadata:log:ip',
63             'realuserid' => 'privacy:metadata:log:realuserid',
64         ], 'privacy:metadata:log');
65         return $collection;
66     }
68     /**
69      * Add contexts that contain user information for the specified user.
70      *
71      * @param contextlist $contextlist The contextlist to add the contexts to.
72      * @param int $userid The user to find the contexts for.
73      * @return void
74      */
75     public static function add_contexts_for_userid(contextlist $contextlist, $userid) {
76         $sql = "
77             SELECT ctx.id
78               FROM {context} ctx
79               JOIN {logstore_standard_log} l
80                 ON l.contextid = ctx.id
81              WHERE l.userid = :userid1
82                 OR l.relateduserid = :userid2
83                 OR l.realuserid = :userid3";
84         $contextlist->add_from_sql($sql, [
85             'userid1' => $userid,
86             'userid2' => $userid,
87             'userid3' => $userid,
88         ]);
89     }
91     /**
92      * Get the database object.
93      *
94      * @return array Containing moodle_database, string, or null values.
95      */
96     protected static function get_database_and_table() {
97         global $DB;
98         return [$DB, 'logstore_standard_log'];
99     }
101     /**
102      * Get the path to export the logs to.
103      *
104      * @return array
105      */
106     protected static function get_export_subcontext() {
107         return [get_string('privacy:path:logs', 'tool_log'), get_string('pluginname', 'logstore_standard')];
108     }