Skip to content

Commit

Permalink
MDL-63621 core_cohort: 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 eff881a commit 0395106
Show file tree
Hide file tree
Showing 2 changed files with 170 additions and 0 deletions.
49 changes: 49 additions & 0 deletions cohort/classes/privacy/provider.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
use core_privacy\local\request\approved_contextlist;
use core_privacy\local\request\transform;
use core_privacy\local\request\writer;
use core_privacy\local\request\userlist;
use core_privacy\local\request\approved_userlist;

/**
* Privacy class for requesting user data.
Expand All @@ -40,6 +42,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_system && !$context instanceof \context_coursecat) {
return;
}

$params = [
'contextid' => $context->id,
'contextsystem' => CONTEXT_SYSTEM,
'contextcoursecat' => CONTEXT_COURSECAT,
];

$sql = "SELECT cm.userid as userid
FROM {cohort_members} cm
JOIN {cohort} c
ON cm.cohortid = c.id
JOIN {context} ctx
ON c.contextid = ctx.id
AND (ctx.contextlevel = :contextsystem
OR ctx.contextlevel = :contextcoursecat)
WHERE ctx.id = :contextid";

$userlist->add_from_sql('userid', $sql, $params);
}

/**
* Export all user data for the specified user, in the specified contexts.
*
Expand Down Expand Up @@ -150,6 +184,21 @@ public static function delete_data_for_all_users_in_context(\context $context) {
static::delete_data($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_system || $context instanceof \context_coursecat) {
foreach ($userlist->get_userids() as $userid) {
static::delete_data($context, $userid);
}
}
}

/**
* Delete all user data for the specified user, in the specified contexts.
*
Expand Down
121 changes: 121 additions & 0 deletions cohort/tests/privacy_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
use core_privacy\local\request\approved_contextlist;
use core_privacy\local\request\writer;
use core_privacy\tests\provider_testcase;
use core_privacy\local\request\approved_userlist;

/**
* Unit tests for cohort\classes\privacy\provider.php
Expand Down Expand Up @@ -218,4 +219,124 @@ public function test_delete_data_for_user() {
$cohortscount = $DB->get_records('cohort');
$this->assertCount(2, (array) $cohortscount);
}

/**
* Test that only users within a course context are fetched.
*/
public function test_get_users_in_context() {
$component = 'core_cohort';

// Create system cohort and category cohort.
$coursecategory = $this->getDataGenerator()->create_category();
$coursecategoryctx = \context_coursecat::instance($coursecategory->id);
$systemctx = \context_system::instance();
$categorycohort = $this->getDataGenerator()->create_cohort([
'contextid' => $coursecategoryctx->id,
'name' => 'Category cohort 1',
]);
// Create user.
$user = $this->getDataGenerator()->create_user();
$userctx = \context_user::instance($user->id);

$userlist1 = new \core_privacy\local\request\userlist($coursecategoryctx, $component);
provider::get_users_in_context($userlist1);
$this->assertCount(0, $userlist1);

$userlist2 = new \core_privacy\local\request\userlist($systemctx, $component);
provider::get_users_in_context($userlist2);
$this->assertCount(0, $userlist2);

$systemcohort = $this->getDataGenerator()->create_cohort([
'contextid' => $systemctx->id,
'name' => 'System cohort 1'
]);
// Create user and add to the system and category cohorts.
cohort_add_member($categorycohort->id, $user->id);
cohort_add_member($systemcohort->id, $user->id);

// The list of users within the coursecat context should contain user.
$userlist1 = new \core_privacy\local\request\userlist($coursecategoryctx, $component);
provider::get_users_in_context($userlist1);
$this->assertCount(1, $userlist1);
$expected = [$user->id];
$actual = $userlist1->get_userids();
$this->assertEquals($expected, $actual);

// The list of users within the system context should contain user.
$userlist2 = new \core_privacy\local\request\userlist($systemctx, $component);
provider::get_users_in_context($userlist2);
$this->assertCount(1, $userlist2);
$expected = [$user->id];
$actual = $userlist2->get_userids();
$this->assertEquals($expected, $actual);

// The list of users within the user context should be empty.
$userlist3 = new \core_privacy\local\request\userlist($userctx, $component);
provider::get_users_in_context($userlist3);
$this->assertCount(0, $userlist3);
}

/**
* Test that data for users in approved userlist is deleted.
*/
public function test_delete_data_for_users() {
$component = 'core_cohort';

// Create system cohort and category cohort.
$coursecategory = $this->getDataGenerator()->create_category();
$coursecategoryctx = \context_coursecat::instance($coursecategory->id);
$systemctx = \context_system::instance();
$categorycohort = $this->getDataGenerator()->create_cohort([
'contextid' => $coursecategoryctx->id,
'name' => 'Category cohort 1',
]);
// Create user1.
$user1 = $this->getDataGenerator()->create_user();
$userctx1 = \context_user::instance($user1->id);
// Create user2.
$user2 = $this->getDataGenerator()->create_user();

$systemcohort = $this->getDataGenerator()->create_cohort([
'contextid' => $systemctx->id,
'name' => 'System cohort 1'
]);
// Create user and add to the system and category cohorts.
cohort_add_member($categorycohort->id, $user1->id);
cohort_add_member($systemcohort->id, $user1->id);
cohort_add_member($categorycohort->id, $user2->id);

$userlist1 = new \core_privacy\local\request\userlist($coursecategoryctx, $component);
provider::get_users_in_context($userlist1);
$this->assertCount(2, $userlist1);

$userlist2 = new \core_privacy\local\request\userlist($systemctx, $component);
provider::get_users_in_context($userlist2);
$this->assertCount(1, $userlist2);

// Convert $userlist1 into an approved_contextlist.
$approvedlist1 = new approved_userlist($coursecategoryctx, $component, $userlist1->get_userids());
// Delete using delete_data_for_user.
provider::delete_data_for_users($approvedlist1);

// Re-fetch users in coursecategoryctx.
$userlist1 = new \core_privacy\local\request\userlist($coursecategoryctx, $component);
provider::get_users_in_context($userlist1);
// The user data in coursecategoryctx should be deleted.
$this->assertCount(0, $userlist1);
// Re-fetch users in coursecategoryctx.
$userlist2 = new \core_privacy\local\request\userlist($systemctx, $component);
provider::get_users_in_context($userlist2);
// The user data in coursecontext2 should be still present.
$this->assertCount(1, $userlist2);

// Convert $userlist2 into an approved_contextlist in the user context.
$approvedlist3 = new approved_userlist($userctx1, $component, $userlist2->get_userids());
// Delete using delete_data_for_user.
provider::delete_data_for_users($approvedlist3);
// Re-fetch users in coursecontext1.
$userlist3 = new \core_privacy\local\request\userlist($systemctx, $component);
provider::get_users_in_context($userlist3);
// The user data in systemcontext should not be deleted.
$this->assertCount(1, $userlist3);
}
}

0 comments on commit 0395106

Please sign in to comment.