Skip to content

Commit

Permalink
MDL-63586 profilefield_menu: Add support for removal of context users
Browse files Browse the repository at this point in the history 
This issue is part of the MDL-62560 Epic.
  • Loading branch information
Mihail Geshoski authored and David Monllao committed Oct 22, 2018
1 parent 67280a7 commit 150156a
Show file tree
Hide file tree
Showing 2 changed files with 154 additions and 3 deletions.
47 changes: 47 additions & 0 deletions user/profile/field/menu/classes/privacy/provider.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,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\userlist;
use core_privacy\local\request\approved_userlist;

/**
* Privacy class for requesting user data.
Expand All @@ -38,6 +40,7 @@
*/
class provider implements
\core_privacy\local\metadata\provider,
\core_privacy\local\request\core_userlist_provider,
\core_privacy\local\request\plugin\provider {

/**
Expand Down Expand Up @@ -80,6 +83,37 @@ public static function get_contexts_for_userid(int $userid) : contextlist {
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' => 'menu'
];

$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.
*
Expand Down Expand Up @@ -116,6 +150,19 @@ public static function delete_data_for_all_users_in_context(\context $context) {
}
}

/**
* 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.
*
Expand Down
110 changes: 107 additions & 3 deletions user/profile/field/menu/tests/privacy_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
defined('MOODLE_INTERNAL') || die();

use \core_privacy\tests\provider_testcase;
use profilefield_menu\privacy\provider;
use core_privacy\local\request\approved_userlist;

/**
* Unit tests for user\profile\field\menu\classes\privacy\provider.php
Expand Down Expand Up @@ -58,7 +60,7 @@ public function test_get_contexts_for_userid() {
// Confirm we got the right number of user field data.
$this->assertCount(1, $userfielddata);
$context = context_user::instance($user->id);
$contextlist = \profilefield_menu\privacy\provider::get_contexts_for_userid($user->id);
$contextlist = provider::get_contexts_for_userid($user->id);
$this->assertEquals($context, $contextlist->current());
}

Expand Down Expand Up @@ -110,7 +112,7 @@ public function test_delete_data_for_all_users_in_context() {
// Check that we have two entries.
$userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
$this->assertCount(2, $userinfodata);
\profilefield_menu\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);
Expand Down Expand Up @@ -140,13 +142,115 @@ public function test_delete_data_for_user() {
$this->assertCount(2, $userinfodata);
$approvedlist = new \core_privacy\local\request\approved_contextlist($user, 'profilefield_menu',
[$context->id]);
\profilefield_menu\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('test menu', reset($userinfodata)->data);
}

/**
* Test that only users with a user context are fetched.
*/
public function test_get_users_in_context() {
$this->resetAfterTest();

$component = 'profilefield_menu';
// Create profile category.
$categoryid = $this->add_profile_category();
// Create menu profile field.
$profilefieldid = $this->add_profile_field($categoryid, 'menu');

// 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_menu';
// Create profile category.
$categoryid = $this->add_profile_category();
// Create menu profile field.
$profilefieldid = $this->add_profile_field($categoryid, 'menu');

// 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.
*
Expand Down

0 comments on commit 150156a

Please sign in to comment.