mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-17 21:49:15 +01:00
Code Issues Projects Releases Wiki Activity

MDL-63534 core_user: Add support for removal of context users

Browse Source 
This issue is part of the MDL-62560 Epic.
This commit is contained in:
Mihail Geshoski 2018-10-10 15:47:27 +08:00 committed by David Monllao
parent 44a0a2bd66
commit d4d28485c7
2 changed files with 169 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
user/classes/privacy/provider.php
View File

@ -31,6 +31,8 @@ use \core_privacy\local\request\transform;
use \core_privacy\local\request\contextlist;
use \core_privacy\local\request\approved_contextlist;
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.
@ -39,7 +41,10 @@ use \core_privacy\local\request\writer;
* @copyright 2018 Adrian Greeve <adrian@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\subsystem\provider {
class provider implements
\core_privacy\local\metadata\provider,
\core_privacy\local\request\core_userlist_provider,
\core_privacy\local\request\subsystem\provider {
/**
* Returns information about the user data stored in this component.
@ -196,6 +201,30 @@ class provider implements \core_privacy\local\metadata\provider, \core_privacy\l
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 instanceid as userid
FROM {context}
WHERE id = :contextid and contextlevel = :contextuser";
$userlist->add_from_sql('userid', $sql, $params);
}
/**
* Export all user data for the specified user, in the specified contexts.
*
@ -225,6 +254,20 @@ class provider implements \core_privacy\local\metadata\provider, \core_privacy\l
}
}
/**
* 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_user_data($context->instanceid, $context);
}
}
/**
* Delete all user data for the specified user, in the specified contexts.
*

125
user/tests/privacy_test.php
View File

@ -26,6 +26,8 @@ defined('MOODLE_INTERNAL') || die();
global $CFG;
use \core_privacy\tests\provider_testcase;
use \core_user\privacy\provider;
use \core_privacy\local\request\approved_userlist;
require_once($CFG->dirroot . "/user/lib.php");
@ -271,6 +273,129 @@ class core_user_privacy_testcase extends provider_testcase {
$this->assertEquals($user->email, $record->email);
}
/**
* Test that only users with a user context are fetched.
*/
public function test_get_users_in_context() {
$this->resetAfterTest();
$component = 'core_user';
// Create a user.
$user = $this->getDataGenerator()->create_user();
$usercontext = \context_user::instance($user->id);
$userlist = new \core_privacy\local\request\userlist($usercontext, $component);
// 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() {
global $DB;
$this->resetAfterTest();
$component = 'core_user';
// Create user1.
$user1 = $this->getDataGenerator()->create_user([
'idnumber' => 'A0023',
'emailstop' => 1,
'icq' => 'aksdjf98',
'phone1' => '555 3257',
'institution' => 'test',
'department' => 'Science',
'city' => 'Perth',
'country' => 'au'
]);
$usercontext1 = \context_user::instance($user1->id);
$userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
// Create user2.
$user2 = $this->getDataGenerator()->create_user([
'idnumber' => 'A0024',
'emailstop' => 1,
'icq' => 'aksdjf981',
'phone1' => '555 3258',
'institution' => 'test',
'department' => 'Science',
'city' => 'Perth',
'country' => 'au'
]);
$usercontext2 = \context_user::instance($user2->id);
$userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
// The list of users for usercontext1 should return user1.
provider::get_users_in_context($userlist1);
$this->assertCount(1, $userlist1);
// The list of users for usercontext2 should return user2.
provider::get_users_in_context($userlist2);
$this->assertCount(1, $userlist2);
// Add userlist1 to the approved user list.
$approvedlist = new approved_userlist($usercontext1, $component, $userlist1->get_userids());
// Delete using delete_data_for_users().
provider::delete_data_for_users($approvedlist);
// Now check that there is still a record for user1 (deleted user), but non-critical information is removed.
$record = $DB->get_record('user', ['id' => $user1->id]);
$this->assertEmpty($record->idnumber);
$this->assertEmpty($record->emailstop);
$this->assertEmpty($record->icq);
$this->assertEmpty($record->phone1);
$this->assertEmpty($record->institution);
$this->assertEmpty($record->department);
$this->assertEmpty($record->city);
$this->assertEmpty($record->country);
$this->assertEmpty($record->timezone);
$this->assertEmpty($record->timecreated);
$this->assertEmpty($record->timemodified);
$this->assertEmpty($record->firstnamephonetic);
// Check for critical fields.
// Deleted should now be 1.
$this->assertEquals(1, $record->deleted);
$this->assertEquals($user1->id, $record->id);
$this->assertEquals($user1->username, $record->username);
$this->assertEquals($user1->password, $record->password);
$this->assertEquals($user1->firstname, $record->firstname);
$this->assertEquals($user1->lastname, $record->lastname);
$this->assertEquals($user1->email, $record->email);
// Now check that the record and information for user2 is still present.
$record = $DB->get_record('user', ['id' => $user2->id]);
$this->assertNotEmpty($record->idnumber);
$this->assertNotEmpty($record->emailstop);
$this->assertNotEmpty($record->icq);
$this->assertNotEmpty($record->phone1);
$this->assertNotEmpty($record->institution);
$this->assertNotEmpty($record->department);
$this->assertNotEmpty($record->city);
$this->assertNotEmpty($record->country);
$this->assertNotEmpty($record->timezone);
$this->assertNotEmpty($record->timecreated);
$this->assertNotEmpty($record->timemodified);
$this->assertNotEmpty($record->firstnamephonetic);
$this->assertEquals(0, $record->deleted);
$this->assertEquals($user2->id, $record->id);
$this->assertEquals($user2->username, $record->username);
$this->assertEquals($user2->password, $record->password);
$this->assertEquals($user2->firstname, $record->firstname);
$this->assertEquals($user2->lastname, $record->lastname);
$this->assertEquals($user2->email, $record->email);
}
/**
* Create user data for a user.
*