MDL-61994 mod_glossary: implement privacy providers

mod/glossary/classes/privacy/provider.php

@@ -0,0 +1,332 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Privacy Subsystem implementation for mod_glossary.
+ *
+ * @package   mod_glossary
+ * @copyright 2018 Simey Lameze <simey@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_glossary\privacy;
+use core_privacy\local\metadata\collection;
+use core_privacy\local\request\approved_contextlist;
+use core_privacy\local\request\contextlist;
+use core_privacy\local\request\deletion_criteria;
+use core_privacy\local\request\helper;
+use core_privacy\local\request\writer;
+
+defined('MOODLE_INTERNAL') || die();
+/**
+ * Implementation of the privacy subsystem plugin provider for the glossary activity module.
+ *
+ * @copyright 2018 Simey Lameze <simey@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements
+    // This plugin stores personal data.
+    \core_privacy\local\metadata\provider,
+    // This plugin is a core_user_data_provider.
+    \core_privacy\local\request\plugin\provider {
+
+    /**
+     * Return the fields which contain personal data.
+     *
+     * @param collection $items a reference to the collection to use to store the metadata.
+     * @return collection the updated collection of metadata items.
+     */
+    public static function get_metadata(collection $items) {
+        $items->add_database_table(
+            'glossary_entries',
+            [
+                'glossaryid'    => 'privacy:metadata:glossary_entries:glossaryid',
+                'userid'        => 'privacy:metadata:glossary_entries:userid',
+                'concept'       => 'privacy:metadata:glossary_entries:concept',
+                'definition'    => 'privacy:metadata:glossary_entries:definition',
+                'attachment'    => 'privacy:metadata:glossary_entries:attachment',
+                'timemodified'  => 'privacy:metadata:glossary_entries:timemodified',
+            ],
+            'privacy:metadata:glossary_entries'
+        );
+
+        $items->add_subsystem_link('core_files', [], 'privacy:metadata:core_files');
+        $items->add_subsystem_link('core_comment', [], 'privacy:metadata:core_comments');
+        $items->add_subsystem_link('core_tag', [], 'privacy:metadata:core_tag');
+        $items->add_subsystem_link('core_ratings', [], 'privacy:metadata:core_ratings');
+        return $items;
+    }
+
+    /**
+     * Get the list of contexts that contain user information for the specified user.
+     *
+     * @param int $userid the userid.
+     * @return contextlist the list of contexts containing user info for the user.
+     */
+    public static function get_contexts_for_userid($userid) {
+        $ratingquery = \core_rating\privacy\provider::get_sql_join('r', 'mod_glossary', 'entry', 'ge.id', $userid);
+
+        $sql = "SELECT c.id
+                  FROM {context} c
+            INNER JOIN {course_modules} cm ON cm.id = c.instanceid AND c.contextlevel = :contextlevel
+            INNER JOIN {modules} m ON m.id = cm.module AND m.name = :modname
+            INNER JOIN {glossary} g ON g.id = cm.instance
+            INNER JOIN {glossary_entries} ge ON ge.glossaryid = g.id
+             LEFT JOIN {comments} com ON com.commentarea =:commentarea AND com.itemid = ge.id
+            {$ratingquery->join}
+                 WHERE ge.userid = :glossaryentryuserid OR com.userid = :commentuserid OR {$ratingquery->userwhere}";
+        $params = [
+            'contextlevel' => CONTEXT_MODULE,
+            'modname' => 'glossary',
+            'commentarea' => 'glossary_entry',
+            'glossaryentryuserid' => $userid,
+            'commentuserid' => $userid,
+        ] + $ratingquery->params;
+
+        $contextlist = new contextlist();
+        $contextlist->add_from_sql($sql, $params);
+
+        return $contextlist;
+    }
+
+    /**
+     * Export personal data for the given approved_contextlist.
+     *
+     * User and context information is contained within the contextlist.
+     *
+     * @param approved_contextlist $contextlist a list of contexts approved for export.
+     */
+    public static function export_user_data(approved_contextlist $contextlist) {
+        global $DB;
+
+        if (empty($contextlist->count())) {
+            return;
+        }
+
+        $user = $contextlist->get_user();
+
+        list($contextsql, $contextparams) = $DB->get_in_or_equal($contextlist->get_contextids(), SQL_PARAMS_NAMED);
+        $sql = "SELECT ge.id as entryid,
+                       cm.id AS cmid,
+                       ge.userid,
+                       ge.concept,
+                       ge.definition,
+                       ge.definitionformat,
+                       ge.attachment,
+                       ge.timecreated,
+                       ge.timemodified
+                  FROM {glossary_entries} ge
+                  JOIN {glossary} g ON ge.glossaryid = g.id
+                  JOIN {course_modules} cm ON g.id = cm.instance
+                  JOIN {context} c ON cm.id = c.instanceid
+                 WHERE c.id {$contextsql}
+                   AND ge.userid = :userid
+             OR EXISTS (SELECT 1 FROM {comments} com WHERE com.commentarea = :commentarea AND com.itemid = ge.id
+                        AND com.userid = :commentuserid)
+             OR EXISTS (SELECT 1 FROM {rating} r WHERE r.contextid = c.id AND r.itemid  = ge.id
+                        AND r.component = :ratingcomponent
+                   AND r.ratingarea = :ratingarea
+                   AND r.userid = :ratinguserid)
+               ORDER BY ge.id, cm.id";
+        $params = [
+            'userid' => $user->id,
+            'commentarea' => 'glossary_entry',
+            'commentuserid' => $user->id,
+            'ratingcomponent' => 'mod_glossary',
+            'ratingarea' => 'entry',
+            'ratinguserid' => $user->id
+        ] + $contextparams;
+        $glossaryentries = $DB->get_recordset_sql($sql, $params);
+
+        // Reference to the glossary activity seen in the last iteration of the loop. By comparing this with the
+        // current record, and because we know the results are ordered, we know when we've moved to the entries
+        // for a new glossary activity and therefore when we can export the complete data for the last activity.
+        $lastcmid = null;
+
+        $glossarydata = [];
+        foreach ($glossaryentries as $record) {
+            $concept = format_string($record->concept);
+            $path = array_merge([get_string('entries', 'mod_glossary'), $concept . " ({$record->entryid})"]);
+
+            // If we've moved to a new glossary, then write the last glossary data and reinit the glossary data array.
+            if (!is_null($lastcmid)) {
+                if ($lastcmid != $record->cmid) {
+                    if (!empty($glossarydata)) {
+                        $context = \context_module::instance($lastcmid);
+                        self::export_glossary_data_for_user($glossarydata, $context, [], $user);
+                        $glossarydata = [];
+                    }
+                }
+            }
+            $lastcmid = $record->cmid;
+            $context = \context_module::instance($lastcmid);
+
+            // Export files added on the glossary entry definition field.
+            $definition = format_text(writer::with_context($context)->rewrite_pluginfile_urls($path, 'mod_glossary',
+                'entry',  $record->entryid, $record->definition), $record->definitionformat);
+
+            // Export just the files attached to this user entry.
+            if ($record->userid == $user->id) {
+                // Get all files attached to the glossary attachment.
+                writer::with_context($context)->export_area_files($path, 'mod_glossary', 'entry', $record->entryid);
+
+                // Get all files attached to the glossary attachment.
+                writer::with_context($context)->export_area_files($path, 'mod_glossary', 'attachment', $record->entryid);
+            }
+
+            // Export associated comments.
+            \core_comment\privacy\provider::export_comments($context, 'mod_glossary', 'glossary_entry',
+                    $record->entryid, $path, $record->userid != $user->id);
+
+            // Export associated tags.
+            \core_tag\privacy\provider::export_item_tags($user->id, $context, $path, 'mod_glossary', 'glossary_entries',
+                    $record->entryid, $record->userid != $user->id);
+
+            // Export associated ratings.
+            \core_rating\privacy\provider::export_area_ratings($user->id, $context, $path, 'mod_glossary', 'entry',
+                    $record->entryid, $record->userid != $user->id);
+
+            $glossarydata['entries'][] = [
+                'concept'       => $record->concept,
+                'definition'    => $definition,
+                'timecreated'   => \core_privacy\local\request\transform::datetime($record->timecreated),
+                'timemodified'  => \core_privacy\local\request\transform::datetime($record->timemodified)
+            ];
+        }
+        $glossaryentries->close();
+
+        // The data for the last activity won't have been written yet, so make sure to write it now!
+        if (!empty($glossarydata)) {
+            $context = \context_module::instance($lastcmid);
+            self::export_glossary_data_for_user($glossarydata, $context, [], $user);
+        }
+    }
+
+    /**
+     * Export the supplied personal data for a single glossary activity, along with any generic data or area files.
+     *
+     * @param array $glossarydata The personal data to export for the glossary.
+     * @param \context_module $context The context of the glossary.
+     * @param array $subcontext The location within the current context that this data belongs.
+     * @param \stdClass $user the user record
+     */
+    protected static function export_glossary_data_for_user(array $glossarydata, \context_module $context,
+                                                            array $subcontext, \stdClass $user) {
+        // Fetch the generic module data for the glossary.
+        $contextdata = helper::get_context_data($context, $user);
+        // Merge with glossary data and write it.
+        $contextdata = (object)array_merge((array)$contextdata, $glossarydata);
+        writer::with_context($context)->export_data($subcontext, $contextdata);
+        // Write generic module intro files.
+        helper::export_context_files($context, $user);
+    }
+
+    /**
+     * Delete all data for all users in the specified context.
+     *
+     * @param \context $context the context to delete in.
+     */
+    public static function delete_data_for_all_users_in_context(\context $context) {
+        global $DB;
+        if (empty($context)) {
+            return;
+        }
+
+        if ($context->contextlevel != CONTEXT_MODULE) {
+            return;
+        }
+
+        $instanceid = $DB->get_field('course_modules', 'instance', ['id' => $context->instanceid], MUST_EXIST);
+        $DB->record_exists('glossary', ['id' => $context->instanceid]);
+        $DB->delete_records('glossary_entries', ['glossaryid' => $instanceid]);
+
+        if ($context->contextlevel == CONTEXT_MODULE) {
+            $instanceid = $DB->get_field('course_modules', 'instance', ['id' => $context->instanceid], MUST_EXIST);
+            $DB->record_exists('glossary', ['id' => $context->instanceid]);
+
+            $entries = $DB->get_records('glossary_entries', ['glossaryid' => $instanceid]);
+            foreach ($entries as $entry) {
+                // Delete related entry categories.
+                $DB->delete_records('glossary_entries_categories', ['entryid' => $entry->id]);
+
+                // Delete related entry aliases.
+                $DB->delete_records('glossary_alias', ['entryid' => $entry->id]);
+            }
+
+            // Delete entry and attachment files.
+            get_file_storage()->delete_area_files($context->id, 'mod_glossary', 'entry');
+            get_file_storage()->delete_area_files($context->id, 'mod_glossary', 'attachment');
+
+            // Delete related ratings.
+            \core_rating\privacy\provider::delete_ratings($context, 'mod_glossary', 'entry');
+
+            // Delete comments.
+            \core_comment\privacy\provider::delete_comments_for_all_users($context, 'mod_glossary', 'glossary_entry');
+
+            // Delete tags.
+            \core_tag\privacy\provider::delete_item_tags($context, 'mod_glossary', 'glossary_entries');
+
+            // Now delete all user related entries.
+            $DB->delete_records('glossary_entries', ['glossaryid' => $instanceid]);
+        }
+    }
+
+    /**
+     * Delete all user data for the specified user, in the specified contexts.
+     *
+     * @param approved_contextlist $contextlist a list of contexts approved for deletion.
+     */
+    public static function delete_data_for_user(approved_contextlist $contextlist) {
+        global $DB;
+
+        if (empty($contextlist->count())) {
+            return;
+        }
+
+        $userid = $contextlist->get_user()->id;
+        foreach ($contextlist->get_contexts() as $context) {
+            if ($context->contextlevel == CONTEXT_MODULE) {
+
+                $instanceid = $DB->get_field('course_modules', 'instance', ['id' => $context->instanceid], MUST_EXIST);
+                $DB->record_exists('glossary', ['id' => $context->instanceid]);
+
+                $entries = $DB->get_records('glossary_entries', ['glossaryid' => $instanceid, 'userid' => $userid]);
+                foreach ($entries as $entry) {
+                    // Delete related entry categories.
+                    $DB->delete_records('glossary_entries_categories', ['entryid' => $entry->id]);
+
+                    // Delete related entry aliases.
+                    $DB->delete_records('glossary_alias', ['entryid' => $entry->id]);
+
+                    // Delete tags.
+                    \core_tag\privacy\provider::delete_item_tags($context, 'mod_glossary', 'glossary_entries', $entry->id);
+
+                    // Delete entry and attachment files.
+                    get_file_storage()->delete_area_files($context->id, 'mod_glossary', 'entry', $entry->id);
+                    get_file_storage()->delete_area_files($context->id, 'mod_glossary', 'attachment', $entry->id);
+
+                    // Delete related ratings.
+                    \core_rating\privacy\provider::delete_ratings($context, 'mod_glossary', 'entry', $entry->id);
+                }
+
+                // Delete comments.
+                \core_comment\privacy\provider::delete_comments_for_user($contextlist, 'mod_glossary', 'glossary_entry');
+
+                // Now delete all user related entries.
+                $DB->delete_records('glossary_entries', ['glossaryid' => $instanceid, 'userid' => $userid]);
+            }
+        }
+    }
+}

mod/glossary/lang/en/glossary.php

@@ -266,6 +266,18 @@
 $string['print'] = 'Print';
 $string['printerfriendly'] = 'Printer-friendly version';
 $string['printviewnotallowed'] = 'Print view isn\'t allowed';
+$string['privacy'] = 'Privacy of results';
+$string['privacy:metadata:core_comments'] = 'Comments made on glossary definitions are stored using core_comment system';
+$string['privacy:metadata:core_files'] = 'Files linked to glossary definitions are stored using the core_files system';
+$string['privacy:metadata:core_ratings'] = 'Ratings added to glossary entries are stored using core_ratings system ';
+$string['privacy:metadata:core_tag'] = 'Tags added to glossary definitions are stored using core_tag system ';
+$string['privacy:metadata:glossary_entries'] = 'Information about the user\'s entries for a given glossary activity';
+$string['privacy:metadata:glossary_entries:attachment'] = 'The attachment of the entry the user added';
+$string['privacy:metadata:glossary_entries:concept'] = 'The concept of the entry the user added';
+$string['privacy:metadata:glossary_entries:definition'] = 'The definition of the entry the user added';
+$string['privacy:metadata:glossary_entries:glossaryid'] = 'The ID of the glossary activity the user is providing entry for';
+$string['privacy:metadata:glossary_entries:userid'] = 'The ID of the user that is adding this glossary entry';
+$string['privacy:metadata:glossary_entries:timemodified'] = 'The timestamp indicating when the glossary entry was modified by the user';
 $string['question'] = 'Question';
 $string['rejectedentries'] = 'Rejected entries';
 $string['rejectionrpt'] = 'Rejection report';