From 86b5b2f980a467b773c8eff55903c396b42a2423 Mon Sep 17 00:00:00 2001 From: Mihail Geshoski Date: Wed, 10 Oct 2018 16:02:26 +0800 Subject: [PATCH] MDL-63575 profilefield_datetime: Add support for removal of context users This issue is part of the MDL-62560 Epic. --- .../datetime/classes/privacy/provider.php | 47 ++++++++ .../field/datetime/tests/privacy_test.php | 113 +++++++++++++++++- 2 files changed, 157 insertions(+), 3 deletions(-) diff --git a/user/profile/field/datetime/classes/privacy/provider.php b/user/profile/field/datetime/classes/privacy/provider.php index 186dc706fed..a30174269d9 100644 --- a/user/profile/field/datetime/classes/privacy/provider.php +++ b/user/profile/field/datetime/classes/privacy/provider.php @@ -30,6 +30,8 @@ use \core_privacy\local\metadata\collection; use \core_privacy\local\request\contextlist; use \core_privacy\local\request\approved_contextlist; use \core_privacy\local\request\transform; +use core_privacy\local\request\userlist; +use core_privacy\local\request\approved_userlist; /** * Privacy class for requesting user data. @@ -39,6 +41,7 @@ use \core_privacy\local\request\transform; */ class provider implements \core_privacy\local\metadata\provider, + \core_privacy\local\request\core_userlist_provider, \core_privacy\local\request\plugin\provider { /** @@ -81,6 +84,37 @@ class provider implements return $contextlist; } + /** + * Get the list of users within a specific context. + * + * @param userlist $userlist The userlist containing the list of users who have data in this context/plugin combination. + */ + public static function get_users_in_context(userlist $userlist) { + $context = $userlist->get_context(); + + if (!$context instanceof \context_user) { + return; + } + + $params = [ + 'contextuser' => CONTEXT_USER, + 'contextid' => $context->id, + 'datatype' => 'datetime' + ]; + + $sql = "SELECT ctx.instanceid as userid + 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 = :contextuser + WHERE ctx.id = :contextid + AND uif.datatype = :datatype"; + + $userlist->add_from_sql('userid', $sql, $params); + } + /** * Export all user data for the specified user, in the specified contexts. * @@ -117,6 +151,19 @@ class provider implements } } + /** + * Delete multiple users within a single context. + * + * @param approved_userlist $userlist The approved context and user information to delete information for. + */ + public static function delete_data_for_users(approved_userlist $userlist) { + $context = $userlist->get_context(); + + if ($context instanceof \context_user) { + static::delete_data($context->instanceid); + } + } + /** * Delete all user data for the specified user, in the specified contexts. * diff --git a/user/profile/field/datetime/tests/privacy_test.php b/user/profile/field/datetime/tests/privacy_test.php index f3720e22ad4..ce789d29ecc 100644 --- a/user/profile/field/datetime/tests/privacy_test.php +++ b/user/profile/field/datetime/tests/privacy_test.php @@ -25,6 +25,8 @@ defined('MOODLE_INTERNAL') || die(); use \core_privacy\tests\provider_testcase; +use profilefield_datetime\privacy\provider; +use core_privacy\local\request\approved_userlist; /** * Unit tests for user\profile\field\datetime\classes\privacy\provider.php @@ -58,7 +60,7 @@ class profilefield_datetime_testcase extends provider_testcase { // Confirm we got the right number of user field data. $this->assertCount(1, $userfielddata); $context = context_user::instance($user->id); - $contextlist = \profilefield_datetime\privacy\provider::get_contexts_for_userid($user->id); + $contextlist = provider::get_contexts_for_userid($user->id); $this->assertEquals($context, $contextlist->current()); } @@ -111,7 +113,7 @@ class profilefield_datetime_testcase extends provider_testcase { // Check that we have two entries. $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]); $this->assertCount(2, $userinfodata); - \profilefield_datetime\privacy\provider::delete_data_for_all_users_in_context($context); + 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); @@ -141,13 +143,118 @@ class profilefield_datetime_testcase extends provider_testcase { $this->assertCount(2, $userinfodata); $approvedlist = new \core_privacy\local\request\approved_contextlist($user, 'profilefield_datetime', [$context->id]); - \profilefield_datetime\privacy\provider::delete_data_for_user($approvedlist); + 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('1524067200', reset($userinfodata)->data); } + /** + * Test that only users with a user context are fetched. + */ + public function test_get_users_in_context() { + $this->resetAfterTest(); + + $component = 'profilefield_datetime'; + + // Create profile category. + $categoryid = $this->add_profile_category(); + // Create profile field. + $profilefieldid = $this->add_profile_field($categoryid, 'datetime'); + + // Create a user. + $user = $this->getDataGenerator()->create_user(); + $usercontext = context_user::instance($user->id); + + // The list of users should not return anything yet (related data still haven't been created). + $userlist = new \core_privacy\local\request\userlist($usercontext, $component); + provider::get_users_in_context($userlist); + $this->assertCount(0, $userlist); + + $this->add_user_info_data($user->id, $profilefieldid, 'test data'); + + // The list of users for user context should return the user. + provider::get_users_in_context($userlist); + $this->assertCount(1, $userlist); + $expected = [$user->id]; + $actual = $userlist->get_userids(); + $this->assertEquals($expected, $actual); + + // The list of users for system context should not return any users. + $systemcontext = context_system::instance(); + $userlist = new \core_privacy\local\request\userlist($systemcontext, $component); + provider::get_users_in_context($userlist); + $this->assertCount(0, $userlist); + } + + /** + * Test that data for users in approved userlist is deleted. + */ + public function test_delete_data_for_users() { + $this->resetAfterTest(); + + $component = 'profilefield_datetime'; + // Create profile category. + $categoryid = $this->add_profile_category(); + // Create profile field. + $profilefieldid = $this->add_profile_field($categoryid, 'datetime'); + + // Create user1. + $user1 = $this->getDataGenerator()->create_user(); + $usercontext1 = context_user::instance($user1->id); + + // Create user2. + $user2 = $this->getDataGenerator()->create_user(); + $usercontext2 = context_user::instance($user2->id); + + $this->add_user_info_data($user1->id, $profilefieldid, 'test data'); + $this->add_user_info_data($user2->id, $profilefieldid, 'test data'); + + // The list of users for usercontext1 should return user1. + $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component); + provider::get_users_in_context($userlist1); + $this->assertCount(1, $userlist1); + $expected = [$user1->id]; + $actual = $userlist1->get_userids(); + $this->assertEquals($expected, $actual); + + // The list of users for usercontext2 should return user2. + $userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component); + provider::get_users_in_context($userlist2); + $this->assertCount(1, $userlist2); + $expected = [$user2->id]; + $actual = $userlist2->get_userids(); + $this->assertEquals($expected, $actual); + + // Add userlist1 to the approved user list. + $approvedlist = new approved_userlist($usercontext1, $component, $userlist1->get_userids()); + + // Delete user data using delete_data_for_user for usercontext1. + provider::delete_data_for_users($approvedlist); + + // Re-fetch users in usercontext1 - The user list should now be empty. + $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component); + provider::get_users_in_context($userlist1); + $this->assertCount(0, $userlist1); + + // Re-fetch users in usercontext2 - The user list should not be empty (user2). + $userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component); + provider::get_users_in_context($userlist2); + $this->assertCount(1, $userlist2); + + // User data should be only removed in the user context. + $systemcontext = context_system::instance(); + // Add userlist2 to the approved user list in the system context. + $approvedlist = new approved_userlist($systemcontext, $component, $userlist2->get_userids()); + // Delete user1 data using delete_data_for_user. + provider::delete_data_for_users($approvedlist); + // Re-fetch users in usercontext2 - The user list should not be empty (user2). + $userlist1 = new \core_privacy\local\request\userlist($usercontext2, $component); + provider::get_users_in_context($userlist1); + $this->assertCount(1, $userlist1); + } + /** * Add dummy user info data. *