MDL-62032 profilefield_text: Add privacy files and unit tests
authorMihail Geshoski <mihail@moodle.com>
Thu, 3 May 2018 08:07:55 +0000 (16:07 +0800)
committerMihail Geshoski <mihail@moodle.com>
Thu, 3 May 2018 08:07:55 +0000 (16:07 +0800)
user/profile/field/text/classes/privacy/provider.php [new file with mode: 0644]
user/profile/field/text/lang/en/profilefield_text.php
user/profile/field/text/tests/privacy_test.php [new file with mode: 0644]

diff --git a/user/profile/field/text/classes/privacy/provider.php b/user/profile/field/text/classes/privacy/provider.php
new file mode 100644 (file)
index 0000000..0a0d718
--- /dev/null
@@ -0,0 +1,173 @@
+<?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 class for requesting user data.
+ *
+ * @package    profilefield_text
+ * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace profilefield_text\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use \core_privacy\local\metadata\collection;
+use \core_privacy\local\request\contextlist;
+use \core_privacy\local\request\approved_contextlist;
+
+/**
+ * Privacy class for requesting user data.
+ *
+ * @copyright  2018 Mihail Geshoski <mihail@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 meta data about this system.
+     *
+     * @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 {
+        return $collection->add_database_table('user_info_data', [
+            'userid' => 'privacy:metadata:profilefield_text:userid',
+            'fieldid' => 'privacy:metadata:profilefield_text:fieldid',
+            'data' => 'privacy:metadata:profilefield_text:data',
+            'dataformat' => 'privacy:metadata:profilefield_text:dataformat'
+        ], 'privacy:metadata:profilefield_text:tableexplanation');
+    }
+
+    /**
+     * 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(int $userid) : contextlist {
+        $sql = "SELECT ctx.id
+                  FROM {user_info_data} uda
+                  JOIN {user_info_field} uif ON uda.fieldid = uif.id
+                  JOIN {context} ctx ON ctx.instanceid = uda.userid
+                       AND ctx.contextlevel = :contextlevel
+                 WHERE uda.userid = :userid
+                       AND uif.datatype = :datatype";
+        $params = [
+            'userid' => $userid,
+            'contextlevel' => CONTEXT_USER,
+            'datatype' => 'text'
+        ];
+        $contextlist = new contextlist();
+        $contextlist->add_from_sql($sql, $params);
+
+        return $contextlist;
+    }
+
+    /**
+     * Export all user data for the specified user, in the specified contexts.
+     *
+     * @param approved_contextlist $contextlist The approved contexts to export information for.
+     */
+    public static function export_user_data(approved_contextlist $contextlist) {
+        $user = $contextlist->get_user();
+        foreach ($contextlist->get_contexts() as $context) {
+            // Check if the context is a user context.
+            if ($context->contextlevel == CONTEXT_USER && $context->instanceid == $user->id) {
+                $results = static::get_records($user->id);
+                foreach ($results as $result) {
+                    $data = (object) [
+                        'name' => $result->name,
+                        'description' => $result->description,
+                        'data' => $result->data
+                    ];
+                    \core_privacy\local\request\writer::with_context($context)->export_data([
+                        get_string('pluginname', 'profilefield_text')], $data);
+                }
+            }
+        }
+    }
+
+    /**
+     * Delete all user data which matches the specified context.
+     *
+     * @param   context $context A user context.
+     */
+    public static function delete_data_for_all_users_in_context(\context $context) {
+        // Delete data only for user context.
+        if ($context->contextlevel == CONTEXT_USER) {
+            static::delete_data($context->instanceid);
+        }
+    }
+
+    /**
+     * Delete all user data for the specified user, in the specified contexts.
+     *
+     * @param   approved_contextlist    $contextlist    The approved contexts and user information to delete information for.
+     */
+    public static function delete_data_for_user(approved_contextlist $contextlist) {
+        $user = $contextlist->get_user();
+        foreach ($contextlist->get_contexts() as $context) {
+            // Check if the context is a user context.
+            if ($context->contextlevel == CONTEXT_USER && $context->instanceid == $user->id) {
+                static::delete_data($context->instanceid);
+            }
+        }
+    }
+
+    /**
+     * Delete data related to a userid.
+     *
+     * @param  int $userid The user ID
+     */
+    protected static function delete_data($userid) {
+        global $DB;
+
+        $params = [
+            'userid' => $userid,
+            'datatype' => 'text'
+        ];
+
+        $DB->delete_records_select('user_info_data', "fieldid IN (
+                SELECT id FROM {user_info_field} WHERE datatype = :datatype)
+                AND userid = :userid", $params);
+    }
+
+    /**
+     * Get records related to this plugin and user.
+     *
+     * @param  int $userid The user ID
+     * @return array An array of records.
+     */
+    protected static function get_records($userid) {
+        global $DB;
+
+        $sql = "SELECT *
+                  FROM {user_info_data} uda
+                  JOIN {user_info_field} uif ON uda.fieldid = uif.id
+                 WHERE uda.userid = :userid
+                       AND uif.datatype = :datatype";
+        $params = [
+            'userid' => $userid,
+            'datatype' => 'text'
+        ];
+
+        return $DB->get_records_sql($sql, $params);
+    }
+}
index 28aa2d1..cbab664 100644 (file)
@@ -23,3 +23,8 @@
  */
 
 $string['pluginname'] = 'Text input';
+$string['privacy:metadata:profilefield_text:userid'] = 'The ID of the user which data is stored by the Text input plugin.';
+$string['privacy:metadata:profilefield_text:fieldid'] = 'The ID of the profile field.';
+$string['privacy:metadata:profilefield_text:data'] = 'The stored user data.';
+$string['privacy:metadata:profilefield_text:dataformat'] = 'The format of the stored user data.';
+$string['privacy:metadata:profilefield_text:tableexplanation'] = 'Additional user information is stored here.';
diff --git a/user/profile/field/text/tests/privacy_test.php b/user/profile/field/text/tests/privacy_test.php
new file mode 100644 (file)
index 0000000..3f5aec8
--- /dev/null
@@ -0,0 +1,209 @@
+<?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/>.
+
+/**
+ * Base class for unit tests for profilefield_text.
+ *
+ * @package    profilefield_text
+ * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+use \core_privacy\tests\provider_testcase;
+
+/**
+ * Unit tests for user\profile\field\text\classes\privacy\provider.php
+ *
+ * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class profilefield_text_testcase extends provider_testcase {
+
+    /**
+     * Basic setup for these tests.
+     */
+    public function setUp() {
+        $this->resetAfterTest(true);
+    }
+
+    /**
+     * Test getting the context for the user ID related to this plugin.
+     */
+    public function test_get_contexts_for_userid() {
+        global $DB;
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create profile field.
+        $profilefieldid = $this->add_profile_field($categoryid, 'text');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $this->add_user_info_data($user->id, $profilefieldid, 'test data');
+        // Get the field that was created.
+        $userfielddata = $DB->get_records('user_info_data', array('userid' => $user->id));
+        // Confirm we got the right number of user field data.
+        $this->assertCount(1, $userfielddata);
+        $context = context_user::instance($user->id);
+        $contextlist = \profilefield_text\privacy\provider::get_contexts_for_userid($user->id);
+        $this->assertEquals($context, $contextlist->current());
+    }
+
+    /**
+     * Test that data is exported correctly for this plugin.
+     */
+    public function test_export_user_data() {
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create text profile field.
+        $textprofilefieldid = $this->add_profile_field($categoryid, 'text');
+        // Create checkbox profile field.
+        $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $context = context_user::instance($user->id);
+        // Add text user info data.
+        $this->add_user_info_data($user->id, $textprofilefieldid, 'test text');
+        // Add checkbox user info data.
+        $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
+        $writer = \core_privacy\local\request\writer::with_context($context);
+        $this->assertFalse($writer->has_any_data());
+        $this->export_context_data_for_user($user->id, $context, 'profilefield_text');
+        $data = $writer->get_data([get_string('pluginname', 'profilefield_text')]);
+        $this->assertCount(3, (array) $data);
+        $this->assertEquals('Test field', $data->name);
+        $this->assertEquals('This is a test.', $data->description);
+        $this->assertEquals('test text', $data->data);
+    }
+
+    /**
+     * Test that user data is deleted using the context.
+     */
+    public function test_delete_data_for_all_users_in_context() {
+        global $DB;
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create text profile field.
+        $textprofilefieldid = $this->add_profile_field($categoryid, 'text');
+        // Create checkbox profile field.
+        $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $context = context_user::instance($user->id);
+        // Add text user info data.
+        $this->add_user_info_data($user->id, $textprofilefieldid, 'test text');
+        // Add checkbox user info data.
+        $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
+        // Check that we have two entries.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(2, $userinfodata);
+        \profilefield_text\privacy\provider::delete_data_for_all_users_in_context($context);
+        // Check that the correct profile field has been deleted.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(1, $userinfodata);
+        $this->assertNotEquals('test text', reset($userinfodata)->data);
+    }
+
+    /**
+     * Test that user data is deleted for this user.
+     */
+    public function test_delete_data_for_user() {
+        global $DB;
+        // Create profile category.
+        $categoryid = $this->add_profile_category();
+        // Create text profile field.
+        $textprofilefieldid = $this->add_profile_field($categoryid, 'text');
+        // Create checkbox profile field.
+        $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
+        // Create a user.
+        $user = $this->getDataGenerator()->create_user();
+        $context = context_user::instance($user->id);
+        // Add text user info data.
+        $this->add_user_info_data($user->id, $textprofilefieldid, 'test text');
+        // Add checkbox user info data.
+        $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
+        // Check that we have two entries.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(2, $userinfodata);
+        $approvedlist = new \core_privacy\local\request\approved_contextlist($user, 'profilefield_text',
+            [$context->id]);
+        \profilefield_text\privacy\provider::delete_data_for_user($approvedlist);
+        // Check that the correct profile field has been deleted.
+        $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
+        $this->assertCount(1, $userinfodata);
+        $this->assertNotEquals('test text', reset($userinfodata)->data);
+    }
+
+    /**
+     * Add dummy user info data.
+     *
+     * @param int $userid The ID of the user
+     * @param int $fieldid The ID of the field
+     * @param string $data The data
+     */
+    private function add_user_info_data($userid, $fieldid, $data) {
+        global $DB;
+
+        $userinfodata = array(
+            'userid' => $userid,
+            'fieldid' => $fieldid,
+            'data' => $data,
+            'dataformat' => 0
+        );
+
+        $DB->insert_record('user_info_data', $userinfodata);
+    }
+
+    /**
+     * Add dummy profile category.
+     *
+     * @return int The ID of the profile category
+     */
+    private function add_profile_category() {
+        global $DB;
+        // Create a new profile category.
+        $cat = new stdClass();
+        $cat->name = 'Test category';
+        $cat->sortorder = 1;
+
+        return $DB->insert_record('user_info_category', $cat);
+    }
+
+    /**
+     * Add dummy profile field.
+     *
+     * @param int $categoryid The ID of the profile category
+     * @param string $datatype The datatype of the profile field
+     * @return int The ID of the profile field
+     */
+    private function add_profile_field($categoryid, $datatype) {
+        global $DB;
+        // Create a new profile field.
+        $data = new stdClass();
+        $data->datatype = $datatype;
+        $data->shortname = 'tstField';
+        $data->name = 'Test field';
+        $data->description = 'This is a test.';
+        $data->required = false;
+        $data->locked = false;
+        $data->forceunique = false;
+        $data->signup = false;
+        $data->visible = '0';
+        $data->categoryid = $categoryid;
+
+        return $DB->insert_record('user_info_field', $data);
+    }
+}