mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-21 00:12:56 +02:00
Code Issues Projects Releases Wiki Activity

MDL-63615 message_airnotifier: 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-11 10:52:50 +08:00 committed by David Monllao
parent 99ed2697bd
commit 325d9b50e2
2 changed files with 136 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
message/output/airnotifier/classes/privacy/provider.php
View File

@ -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.
@ -38,7 +40,10 @@ use \core_privacy\local\request\transform;
* @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\plugin\provider {
class provider implements
\core_privacy\local\metadata\provider,
\core_privacy\local\request\core_userlist_provider,
\core_privacy\local\request\plugin\provider {
/**
* Returns meta data about this system.
@ -88,6 +93,35 @@ 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 ud.userid as userid
FROM {message_airnotifier_devices} mad
JOIN {user_devices} ud
ON ud.id = mad.userdeviceid
JOIN {context} ctx
ON ctx.instanceid = ud.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.
*
@ -129,6 +163,19 @@ class provider implements \core_privacy\local\metadata\provider, \core_privacy\l
static::delete_data($context->instanceid);
}
/**
* 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.
*

88
message/output/airnotifier/tests/privacy_test.php
View File

@ -24,6 +24,9 @@
defined('MOODLE_INTERNAL') || die();
use \core_privacy\tests\provider_testcase;
use \message_airnotifier\privacy\provider;
use \core_privacy\local\request\approved_userlist;
/**
* Unit tests for message\output\airnotifier\classes\privacy\provider.php
*
@ -160,4 +163,89 @@ class message_airnotifier_testcase extends provider_testcase {
$devices = $DB->get_records('message_airnotifier_devices');
$this->assertCount(0, $devices);
}
/**
* Test that only users with a user context are fetched.
*/
public function test_get_users_in_context() {
$component = 'message_airnotifier';
// Create user.
$user = $this->getDataGenerator()->create_user();
$usercontext = context_user::instance($user->id);
// The lists of users for the user context should be empty.
// Related user data have not been created yet.
$userlist = new \core_privacy\local\request\userlist($usercontext, $component);
provider::get_users_in_context($userlist);
$this->assertCount(0, $userlist);
$this->add_device($user, 'apuJih874kj');
$this->add_device($user, 'bdu09Ikjjsu');
// The list of users for userlist should return one user (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 should only return users in the user context.
$systemcontext = context_system::instance();
$userlist1 = new \core_privacy\local\request\userlist($systemcontext, $component);
provider::get_users_in_context($userlist1);
$this->assertCount(0, $userlist1);
}
/**
* Test that data for users in approved userlist is deleted.
*/
public function test_delete_data_for_users() {
$component = 'message_airnotifier';
// 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_device($user1, 'apuJih874kj');
$this->add_device($user1, 'cpuJih874kp');
$this->add_device($user2, 'bdu09Ikjjsu');
// The list of users for usercontext1 should return one user (user1).
$userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
provider::get_users_in_context($userlist1);
$this->assertCount(1, $userlist1);
// The list of users for usercontext2 should return one user (user2).
$userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
provider::get_users_in_context($userlist2);
$this->assertCount(1, $userlist2);
$approvedlist = new approved_userlist($usercontext1, $component, $userlist1->get_userids());
// Delete using delete_data_for_user.
provider::delete_data_for_users($approvedlist);
// Re-fetch users in usercontext1 - the user data should now be empty.
$userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
provider::get_users_in_context($userlist1);
$this->assertCount(0, $userlist1);
// The list of users for usercontext2 should still return one user (user2).
$userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
provider::get_users_in_context($userlist2);
$this->assertCount(1, $userlist2);
// User data should only be removed in the user context.
$systemcontext = context_system::instance();
$approvedlist = new approved_userlist($systemcontext, $component, $userlist2->get_userids());
// Delete using delete_data_for_user.
provider::delete_data_for_users($approvedlist);
// Re-fetch users in usercontext2 - the user data should still be present.
$userlist2 = new \core_privacy\local\request\userlist($usercontext2, $component);
provider::get_users_in_context($userlist2);
$this->assertCount(1, $userlist2);
}
}