MDL-61829 block_community: Implement privacy provider

blocks/community/classes/privacy/provider.php

@@ -0,0 +1,181 @@
+<?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 block_community.
+ *
+ * @package    block_community
+ * @copyright  2018 Zig Tan <zig@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace block_community\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use \core_privacy\local\request\approved_contextlist;
+use \core_privacy\local\request\contextlist;
+use \core_privacy\local\request\writer;
+use \core_privacy\local\request\deletion_criteria;
+use \core_privacy\local\metadata\collection;
+
+/**
+ * Privacy Subsystem implementation for block_community.
+ *
+ * @copyright  2018 Zig Tan <zig@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\plugin\provider {
+
+    /**
+     * Returns information about how block_community stores its data.
+     *
+     * @param   collection     $collection The initialised collection to add items to.
+     * @return  collection     A listing of user data stored through this system.
+     */
+    public static function get_metadata(collection $collection) {
+        $collection->add_database_table(
+            'block_community',
+            [
+                'coursename' => 'privacy:metadata:block_community:coursename',
+                'coursedescription' => 'privacy:metadata:block_community:coursedescription',
+                'courseurl' => 'privacy:metadata:block_community:courseurl',
+                'imageurl' => 'privacy:metadata:block_community:imageurl',
+                'userid' => 'privacy:metadata:block_community:userid',
+            ],
+            'privacy:metadata:block_community'
+        );
+
+        return $collection;
+    }
+
+    /**
+     * Get the list of contexts that contain user information for the specified user.
+     *
+     * @param   int         $userid     The user to search.
+     * @return  contextlist   $contextlist  The contextlist containing the list of contexts used in this plugin.
+     */
+    public static function get_contexts_for_userid($userid) {
+        $contextlist = new \core_privacy\local\request\contextlist();
+
+        // The block_community data is associated at the user context level, so retrieve the user's context id.
+        $sql = "SELECT c.id
+                  FROM {block_community} bc
+                  JOIN {context} c ON c.instanceid = bc.userid AND c.contextlevel = :contextuser
+                 WHERE bc.userid = :userid
+              GROUP BY c.id";
+
+        $params = [
+            'contextuser'   => CONTEXT_USER,
+            'userid'        => $userid
+        ];
+
+        $contextlist->add_from_sql($sql, $params);
+
+        return $contextlist;
+    }
+
+    /**
+     * Export all user data for the specified user using the User context level.
+     *
+     * @param   approved_contextlist    $contextlist    The approved contexts to export information for.
+     */
+    public static function export_user_data(approved_contextlist $contextlist) {
+        global $DB;
+
+        // If the user has block_community data, then only the User context should be present so get the first context.
+        $contexts = $contextlist->get_contexts();
+        if (count($contexts) == 0) {
+            return;
+        }
+        $context = reset($contexts);
+
+        // Sanity check that context is at the User context level, then get the userid.
+        if ($context->contextlevel !== CONTEXT_USER) {
+            return;
+        }
+        $userid = $context->instanceid;
+
+        // The block_community data export is organised in: {User Context}/Community Finder/My communities/data.json.
+        $subcontext = [
+            get_string('pluginname', 'block_community'),
+            get_string('mycommunities', 'block_community')
+        ];
+
+        $sql = "SELECT bc.id as id,
+                       bc.coursename as name,
+                       bc.coursedescription as description,
+                       bc.courseurl as url,
+                       bc.imageurl as imageurl
+                  FROM {block_community} bc
+                 WHERE bc.userid = :userid
+              ORDER BY bc.coursename";
+
+        $params = [
+            'userid' => $userid
+        ];
+
+        $communities = $DB->get_records_sql($sql, $params);
+
+        $data = (object) [
+            'communities' => $communities
+        ];
+
+        writer::with_context($context)->export_data($subcontext, $data);
+    }
+
+    /**
+     * Delete all data for all users in the specified context.
+     *
+     * @param   context $context   The specific context to delete data for.
+     */
+    public static function delete_data_for_all_users_in_context(\context $context) {
+        global $DB;
+
+        // Sanity check that context is at the User context level, then get the userid.
+        if ($context->contextlevel !== CONTEXT_USER) {
+            return;
+        }
+        $userid = $context->instanceid;
+
+        $DB->delete_records('block_community', ['userid' => $userid]);
+    }
+
+    /**
+     * Delete all user data for the specified user.
+     *
+     * @param   approved_contextlist $contextlist  The approved contexts and user information to delete information for.
+     */
+    public static function delete_data_for_user(approved_contextlist $contextlist) {
+        global $DB;
+
+        // If the user has block_community data, then only the User context should be present so get the first context.
+        $contexts = $contextlist->get_contexts();
+        if (count($contexts) == 0) {
+            return;
+        }
+        $context = reset($contexts);
+
+        // Sanity check that context is at the User context level, then get the userid.
+        if ($context->contextlevel !== CONTEXT_USER) {
+            return;
+        }
+        $userid = $context->instanceid;
+
+        $DB->delete_records('block_community', ['userid' => $userid]);
+    }
+
+}

blocks/community/lang/en/block_community.php

@@ -95,6 +95,12 @@
 $string['orderbyratingaverage'] = 'Rating';
 $string['outcomes'] = 'Outcomes: {$a}';
 $string['pluginname'] = 'Community finder';
+$string['privacy:metadata:block_community'] = 'The Community block stores links to shared community courses users can enrol in.';
+$string['privacy:metadata:block_community:coursename'] = 'The name of the linked community course.';
+$string['privacy:metadata:block_community:coursedescription'] = 'The description of the linked community course.';
+$string['privacy:metadata:block_community:courseurl'] = 'The course URL of the linked community course.';
+$string['privacy:metadata:block_community:imageurl'] = 'The image URL of the linked community course.';
+$string['privacy:metadata:block_community:userid'] = 'The ID of the user who created the linked community course.';
 $string['rateandcomment'] = 'Rate and comment';
 $string['rating'] = 'Rating';
 $string['removecommunitycourse'] = 'Remove community course';