From 4a973080ddecf7ec660d4bf93ccbc5c25dca4909 Mon Sep 17 00:00:00 2001 From: Mihail Geshoski Date: Wed, 10 Oct 2018 15:28:59 +0800 Subject: [PATCH] MDL-63532 core_portfolio: Add support for removal of context users This issue is part of the MDL-62560 Epic. --- portfolio/classes/privacy/provider.php | 56 +++++++++++ portfolio/tests/privacy_provider_test.php | 108 ++++++++++++++++++++-- 2 files changed, 158 insertions(+), 6 deletions(-) diff --git a/portfolio/classes/privacy/provider.php b/portfolio/classes/privacy/provider.php index 8ea61c9f3f1..02df44e6b05 100644 --- a/portfolio/classes/privacy/provider.php +++ b/portfolio/classes/privacy/provider.php @@ -30,6 +30,8 @@ use core_privacy\local\request\context; 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; /** * Provider for the portfolio API. @@ -41,6 +43,7 @@ class provider implements // The core portfolio system stores preferences related to the other portfolio subsystems. \core_privacy\local\metadata\provider, \core_privacy\local\request\plugin\provider, + \core_privacy\local\request\core_userlist_provider, // The portfolio subsystem will be called by other components. \core_privacy\local\request\subsystem\plugin_provider { @@ -96,6 +99,42 @@ 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 = [ + 'contextid' => $context->id, + 'contextuser' => CONTEXT_USER, + ]; + + $sql = "SELECT ctx.instanceid as userid + FROM {portfolio_instance_user} piu + JOIN {context} ctx + ON ctx.instanceid = piu.userid + AND ctx.contextlevel = :contextuser + WHERE ctx.id = :contextid"; + + $userlist->add_from_sql('userid', $sql, $params); + + $sql = "SELECT ctx.instanceid as userid + FROM {portfolio_log} pl + JOIN {context} ctx + ON ctx.instanceid = pl.userid + AND ctx.contextlevel = :contextuser + WHERE ctx.id = :contextid"; + + $userlist->add_from_sql('userid', $sql, $params); + } + /** * Export all user data for the specified user, in the specified contexts. * @@ -191,6 +230,23 @@ 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) { + global $DB; + + $context = $userlist->get_context(); + + if ($context instanceof \context_user) { + $DB->delete_records('portfolio_instance_user', ['userid' => $context->instanceid]); + $DB->delete_records('portfolio_tempdata', ['userid' => $context->instanceid]); + $DB->delete_records('portfolio_log', ['userid' => $context->instanceid]); + } + } + /** * Delete all user data for the specified user, in the specified contexts. * diff --git a/portfolio/tests/privacy_provider_test.php b/portfolio/tests/privacy_provider_test.php index a1e2a663969..b2777fa4c31 100644 --- a/portfolio/tests/privacy_provider_test.php +++ b/portfolio/tests/privacy_provider_test.php @@ -24,6 +24,9 @@ defined('MOODLE_INTERNAL') || die(); +use core_portfolio\privacy\provider; +use core_privacy\local\request\approved_userlist; + /** * Privacy provider tests class. * @@ -70,7 +73,7 @@ class portfolio_privacy_provider_test extends \core_privacy\tests\provider_testc */ public function test_get_metadata() { $collection = new \core_privacy\local\metadata\collection('core_portfolio'); - $collection = \core_portfolio\privacy\provider::get_metadata($collection); + $collection = provider::get_metadata($collection); $this->assertNotEmpty($collection); $items = $collection->get_collection(); $this->assertEquals(4, count($items)); @@ -88,7 +91,7 @@ class portfolio_privacy_provider_test extends \core_privacy\tests\provider_testc $user = $this->getDataGenerator()->create_user(); $context = context_user::instance($user->id); $this->create_portfolio_data('googledocs', 'Google Docs', $user, 'visible', 1); - $contextlist = \core_portfolio\privacy\provider::get_contexts_for_userid($user->id); + $contextlist = provider::get_contexts_for_userid($user->id); $this->assertEquals($context->id, $contextlist->current()->id); } @@ -101,7 +104,7 @@ class portfolio_privacy_provider_test extends \core_privacy\tests\provider_testc $context = context_user::instance($user->id); $this->create_portfolio_data('googledocs', 'Google Docs', $user, 'visible', 1); $contextlist = new \core_privacy\local\request\approved_contextlist($user, 'core_portfolio', [$context->id]); - \core_portfolio\privacy\provider::export_user_data($contextlist); + provider::export_user_data($contextlist); $writer = \core_privacy\local\request\writer::with_context($context); $portfoliodata = $writer->get_data([get_string('privacy:path', 'portfolio')]); $this->assertEquals('Google Docs', $portfoliodata->{'Google Docs'}->name); @@ -120,12 +123,12 @@ class portfolio_privacy_provider_test extends \core_privacy\tests\provider_testc $this->create_portfolio_data('onedrive', 'Microsoft onedrive', $user2, 'visible', 1); // Check a system context sent through. $systemcontext = context_system::instance(); - \core_portfolio\privacy\provider::delete_data_for_all_users_in_context($systemcontext); + provider::delete_data_for_all_users_in_context($systemcontext); $records = $DB->get_records('portfolio_instance_user'); $this->assertCount(2, $records); $this->assertCount(4, $DB->get_records('portfolio_log')); $context = context_user::instance($user1->id); - \core_portfolio\privacy\provider::delete_data_for_all_users_in_context($context); + provider::delete_data_for_all_users_in_context($context); $records = $DB->get_records('portfolio_instance_user'); // Only one entry should remain for user 2. $this->assertCount(1, $records); @@ -152,7 +155,7 @@ class portfolio_privacy_provider_test extends \core_privacy\tests\provider_testc $context = context_user::instance($user1->id); $contextlist = new \core_privacy\local\request\approved_contextlist($user1, 'core_portfolio', [$context->id]); - \core_portfolio\privacy\provider::delete_data_for_user($contextlist); + provider::delete_data_for_user($contextlist); $records = $DB->get_records('portfolio_instance_user'); // Only one entry should remain for user 2. $this->assertCount(1, $records); @@ -160,4 +163,97 @@ class portfolio_privacy_provider_test extends \core_privacy\tests\provider_testc $this->assertEquals($user2->id, $data->userid); $this->assertCount(2, $DB->get_records('portfolio_log')); } + + /** + * Test that only users with a user context are fetched. + */ + public function test_get_users_in_context() { + $this->resetAfterTest(); + + $component = 'core_portfolio'; + // 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); + + // Create portfolio data for user. + $this->create_portfolio_data('googledocs', 'Google Docs', $user, + 'visible', 1); + + // 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 = 'core_portfolio'; + // Create user1. + $user1 = $this->getDataGenerator()->create_user(); + $usercontext1 = context_user::instance($user1->id); + // Create user1. + $user2 = $this->getDataGenerator()->create_user(); + $usercontext2 = context_user::instance($user2->id); + + // Create portfolio data for user1 and user2. + $this->create_portfolio_data('googledocs', 'Google Docs', $user1, + 'visible', 1); + $this->create_portfolio_data('onedrive', 'Microsoft onedrive', $user2, + 'visible', 1); + + // 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); + } }