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

Merge branch 'MDL-63692-master' of git://github.com/sarjona/moodle

Browse Source
This commit is contained in:
Andrew Nicols 2018-11-20 07:51:40 +08:00
commit 08cd15658a
10 changed files with 2261 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
favourites/classes/privacy/provider.php
View File

@ -172,9 +172,11 @@ class provider implements
* @param \context $context The context to which deletion is scoped.
* @param string $component The favourite's component name.
* @param string $itemtype The favourite's itemtype.
* @param int $itemid Optional itemid associated with component.
* @throws \dml_exception if any errors are encountered during deletion.
*/
public static function delete_favourites_for_all_users(\context $context, string $component, string $itemtype) {
public static function delete_favourites_for_all_users(\context $context, string $component, string $itemtype,
int $itemid = 0) {
global $DB;
$params = [
@ -184,6 +186,11 @@ class provider implements
];
$select = "component = :component AND itemtype =:itemtype AND contextid = :contextid";
if (!empty($itemid)) {
$select .= " AND itemid = :itemid";
$params['itemid'] = $itemid;
}
$DB->delete_records_select('favourite', $select, $params);
}
@ -193,10 +200,11 @@ class provider implements
* @param \core_privacy\local\request\approved_userlist $userlist The approved contexts and user information
* to delete information for.
* @param string $itemtype The favourite's itemtype.
* @param int $itemid Optional itemid associated with component.
* @throws \dml_exception if any errors are encountered during deletion.
*/
public static function delete_favourites_for_userlist(\core_privacy\local\request\approved_userlist $userlist,
string $itemtype) {
string $itemtype, int $itemid = 0) {
global $DB;
$userids = $userlist->get_userids();
@ -217,6 +225,11 @@ class provider implements
$params += $userparams;
$select = "component = :component AND itemtype = :itemtype AND contextid = :contextid AND userid $usersql";
if (!empty($itemid)) {
$select .= " AND itemid = :itemid";
$params['itemid'] = $itemid;
}
$DB->delete_records_select('favourite', $select, $params);
}
@ -224,12 +237,14 @@ class provider implements
* Delete all favourites for the specified user, in the specified contexts.
*
* @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
* @param string $component
* @param string $itemtype
* @param string $component The favourite's component name.
* @param string $itemtype The favourite's itemtype.
* @param int $itemid Optional itemid associated with component.
* @throws \coding_exception
* @throws \dml_exception
*/
public static function delete_favourites_for_user(approved_contextlist $contextlist, string $component, string $itemtype) {
public static function delete_favourites_for_user(approved_contextlist $contextlist, string $component, string $itemtype,
int $itemid = 0) {
global $DB;
$userid = $contextlist->get_user()->id;
@ -244,6 +259,12 @@ class provider implements
$params += $inparams;
$select = "userid = :userid AND component = :component AND itemtype =:itemtype AND contextid $insql";
if (!empty($itemid)) {
$select .= " AND itemid = :itemid";
$params['itemid'] = $itemid;
}
$DB->delete_records_select('favourite', $select, $params);
}
}

40
group/classes/privacy/provider.php
View File

@ -68,6 +68,8 @@ class provider implements
'timeadded' => 'privacy:metadata:groups:timeadded',
], 'privacy:metadata:groups');
$collection->link_subsystem('core_message', 'privacy:metadata:core_message');
return $collection;
}
@ -88,7 +90,7 @@ class provider implements
$subcontext[] = get_string('groups', 'core_group');
$sql = "SELECT gm.id, gm.timeadded, gm.userid, g.name
$sql = "SELECT gm.id, gm.timeadded, gm.userid, g.name, gm.groupid
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE g.courseid = :courseid
@ -107,7 +109,7 @@ class provider implements
$groups = $DB->get_records_sql($sql, $params);
$groups = array_map(function($group) {
$groupstoexport = array_map(function($group) {
return (object) [
'name' => format_string($group->name),
'timeadded' => transform::datetime($group->timeadded),
@ -117,8 +119,14 @@ class provider implements
if (!empty($groups)) {
\core_privacy\local\request\writer::with_context($context)
->export_data($subcontext, (object) [
'groups' => $groups,
'groups' => $groupstoexport,
]);
foreach ($groups as $group) {
// Export associated conversations to this group.
\core_message\privacy\provider::export_conversations($USER->id, 'core_group', 'groups',
$context, [], $group->groupid);
}
}
}
@ -148,6 +156,13 @@ class provider implements
$params['itemid'] = $itemid;
}
// Delete the group conversations.
$groups = $DB->get_records_select('groups_members', $select, $params);
foreach ($groups as $group) {
\core_message\privacy\provider::delete_conversations_for_all_users($context, 'core_group', 'groups', $group->groupid);
}
// Remove members from the group.
$DB->delete_records_select('groups_members', $select, $params);
// Purge the group and grouping cache for users.
@ -191,6 +206,13 @@ class provider implements
$params['itemid'] = $itemid;
}
// Delete the group conversations.
$groups = $DB->get_records_select('groups_members', $select, $params);
foreach ($groups as $group) {
\core_message\privacy\provider::delete_conversations_for_user($contextlist, 'core_group', 'groups', $group->groupid);
}
// Remove members from the group.
$DB->delete_records_select('groups_members', $select, $params);
// Invalidate the group and grouping cache for the user.
@ -227,6 +249,9 @@ class provider implements
}
$userlist->add_from_sql('userid', $sql, $params);
// Get the users with some group conversation in this context.
\core_message\privacy\provider::add_conversations_in_context($userlist, 'core_group', 'groups', $itemid);
}
/**
@ -258,6 +283,12 @@ class provider implements
$params['itemid'] = $itemid;
}
// Delete the group conversations for these users.
$groups = $DB->get_records_select('groups_members', $select, $params);
foreach ($groups as $group) {
\core_message\privacy\provider::delete_conversations_for_users($userlist, 'core_group', 'groups', $group->groupid);
}
$DB->delete_records_select('groups_members', $select, $params);
// Invalidate the group and grouping cache for the user.
@ -294,6 +325,9 @@ class provider implements
$contextlist->add_from_sql($sql, $params);
// Get the contexts where the userid has group conversations.
\core_message\privacy\provider::add_contexts_for_conversations($contextlist, $userid, 'core_group', 'groups', $itemid);
return $contextlist;
}

148
group/tests/privacy_provider_test.php
View File

@ -45,10 +45,9 @@ class core_group_privacy_provider_testcase extends provider_testcase {
$collection = new collection('core_group');
$newcollection = provider::get_metadata($collection);
$itemcollection = $newcollection->get_collection();
$this->assertCount(1, $itemcollection);
$table = reset($itemcollection);
$this->assertCount(2, $itemcollection);
$table = array_shift($itemcollection);
$this->assertEquals('groups_members', $table->get_name());
$this->assertEquals('privacy:metadata:groups', $table->get_summary());
@ -56,6 +55,10 @@ class core_group_privacy_provider_testcase extends provider_testcase {
$this->assertArrayHasKey('groupid', $privacyfields);
$this->assertArrayHasKey('userid', $privacyfields);
$this->assertArrayHasKey('timeadded', $privacyfields);
$table = array_shift($itemcollection);
$this->assertEquals('core_message', $table->get_name());
$this->assertEquals('privacy:metadata:core_message', $table->get_summary());
}
/**
@ -508,6 +511,145 @@ class core_group_privacy_provider_testcase extends provider_testcase {
);
}
/**
* Test for provider::delete_groups_for_users() to delete group memberships of a component.
*/
public function test_delete_groups_for_users_for_component() {
global $DB;
$this->resetAfterTest();
$course1 = $this->getDataGenerator()->create_course();
$course2 = $this->getDataGenerator()->create_course();
$course3 = $this->getDataGenerator()->create_course();
$group1a = $this->getDataGenerator()->create_group(array('courseid' => $course1->id));
$group1b = $this->getDataGenerator()->create_group(array('courseid' => $course1->id));
$group2a = $this->getDataGenerator()->create_group(array('courseid' => $course2->id));
$group2b = $this->getDataGenerator()->create_group(array('courseid' => $course2->id));
$group3a = $this->getDataGenerator()->create_group(array('courseid' => $course3->id));
$group3b = $this->getDataGenerator()->create_group(array('courseid' => $course3->id));
$user1 = $this->getDataGenerator()->create_user();
$user2 = $this->getDataGenerator()->create_user();
$this->getDataGenerator()->enrol_user($user1->id, $course1->id, null, 'self');
$this->getDataGenerator()->enrol_user($user1->id, $course2->id, null, 'self');
$this->getDataGenerator()->enrol_user($user1->id, $course3->id, null, 'self');
$this->getDataGenerator()->enrol_user($user2->id, $course1->id, null, 'self');
$this->getDataGenerator()->enrol_user($user2->id, $course2->id, null, 'self');
$this->getDataGenerator()->enrol_user($user2->id, $course3->id, null, 'self');
$this->getDataGenerator()->create_group_member(
array('groupid' => $group1a->id, 'userid' => $user1->id, 'component' => 'enrol_self'));
$this->getDataGenerator()->create_group_member(
array('groupid' => $group1b->id, 'userid' => $user2->id, 'component' => 'enrol_self'));
$this->getDataGenerator()->create_group_member(
array('groupid' => $group2a->id, 'userid' => $user1->id, 'component' => 'enrol_self'));
$this->getDataGenerator()->create_group_member(
array('groupid' => $group2b->id, 'userid' => $user2->id, 'component' => 'enrol_self'));
$this->getDataGenerator()->create_group_member(array('groupid' => $group3a->id, 'userid' => $user1->id));
$this->getDataGenerator()->create_group_member(array('groupid' => $group3b->id, 'userid' => $user2->id));
$this->assertEquals(
2,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE g.courseid = ?", [$course1->id])
);
$this->assertEquals(
2,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE g.courseid = ?", [$course2->id])
);
$this->assertEquals(
2,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE g.courseid = ?", [$course2->id])
);
$this->assertEquals(
3,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE gm.userid = ?", [$user1->id])
);
// Delete user1 and user2 from groups in course1.
$coursecontext1 = context_course::instance($course1->id);
$approveduserlist = new \core_privacy\local\request\approved_userlist($coursecontext1, 'core_group',
[$user1->id, $user2->id]);
provider::delete_groups_for_users($approveduserlist, 'enrol_self');
$this->assertEquals(
0,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE g.courseid = ?", [$course1->id])
);
$this->assertEquals(
2,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE g.courseid = ?", [$course2->id])
);
$this->assertEquals(
2,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE g.courseid = ?", [$course3->id])
);
$this->assertEquals(
2,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE gm.userid = ?", [$user1->id])
);
// Delete user1 and user2 from course3.
$coursecontext3 = context_course::instance($course3->id);
$approveduserlist = new \core_privacy\local\request\approved_userlist($coursecontext3, 'core_group',
[$user1->id, $user2->id]);
provider::delete_groups_for_users($approveduserlist, 'enrol_self');
$this->assertEquals(
0,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE g.courseid = ?", [$course1->id])
);
$this->assertEquals(
2,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE g.courseid = ?", [$course2->id])
);
$this->assertEquals(
2,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE g.courseid = ?", [$course3->id])
);
$this->assertEquals(
2,
$DB->count_records_sql("SELECT COUNT(gm.id)
FROM {groups_members} gm
JOIN {groups} g ON gm.groupid = g.id
WHERE gm.userid = ?", [$user1->id])
);
}
/**
* Test for provider::delete_groups_for_user() to check deleting from cache.
*/

1
lang/en/group.php
View File

@ -175,6 +175,7 @@ $string['overview'] = 'Overview';
$string['potentialmembers'] = 'Potential members: {$a}';
$string['potentialmembs'] = 'Potential members';
$string['printerfriendly'] = 'Printer-friendly display';
$string['privacy:metadata:core_message'] = 'The group conversations';
$string['privacy:metadata:groups'] = 'A record of group membership.';
$string['privacy:metadata:groups:groupid'] = 'The ID of the group.';
$string['privacy:metadata:groups:timeadded'] = 'The timestamp indicating when the user was added to the group.';

2
lang/en/message.php
View File

@ -143,6 +143,7 @@ $string['participants'] = 'Participants';
$string['permitted'] = 'Permitted';
$string['privacy'] = 'Privacy';
$string['privacy_desc'] = 'You can restrict who can message you';
$string['privacy:metadata:core_favourites'] = 'The conversations starred by the user';
$string['privacy:metadata:messages'] = 'Messages';
$string['privacy:metadata:messages:conversationid'] = 'The ID of the conversation';
$string['privacy:metadata:messages:fullmessage'] = 'The full message';
@ -189,6 +190,7 @@ $string['privacy:metadata:notifications:useridfrom'] = 'The ID of the user who s
$string['privacy:metadata:notifications:useridto'] = 'The ID of the user who received the notification';
$string['privacy:metadata:preference:core_message_settings'] = 'Settings related to messaging';
$string['privacy:request:preference:set'] = 'The value of the setting \'{$a->name}\' was \'{$a->value}\'';
$string['privacy:export:conversationprefix'] = 'Conversation: ';
$string['processorsettings'] = 'Processor settings';
$string['removecontact'] = 'Remove contact';
$string['removecontactconfirm'] = 'Are you sure you want to remove {$a} from your contacts?';

20
lib/db/upgrade.php
View File

@ -2834,5 +2834,25 @@ function xmldb_main_upgrade($oldversion) {
upgrade_main_savepoint(true, 2018111900.01);
}
if ($oldversion < 2018112000.00) {
// Update favourited conversations, so they are saved in the proper context instead of the system.
$sql = "SELECT f.*, mc.contextid as conversationctx
FROM {favourite} f
JOIN {message_conversations} mc
ON mc.id = f.itemid";
$favouritedconversations = $DB->get_records_sql($sql);
foreach ($favouritedconversations as $fc) {
if (empty($fc->conversationctx)) {
$conversationidctx = \context_user::instance($fc->userid)->id;
} else {
$conversationidctx = $fc->conversationctx;
}
$DB->set_field('favourite', 'contextid', $conversationidctx, ['id' => $fc->id]);
}
upgrade_main_savepoint(true, 2018112000.00);
}
return true;
}

35
message/classes/api.php
View File

@ -927,16 +927,24 @@ class api {
* @throws \moodle_exception if the user or conversation don't exist.
*/
public static function set_favourite_conversation(int $conversationid, int $userid) : favourite {
global $DB;
if (!self::is_user_in_conversation($userid, $conversationid)) {
throw new \moodle_exception("Conversation doesn't exist or user is not a member");
}
$systemcontext = \context_system::instance();
$ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
if ($favourite = $ufservice->get_favourite('core_message', 'message_conversations', $conversationid, $systemcontext)) {
return $favourite;
// Get the context for this conversation.
$conversation = $DB->get_record('message_conversations', ['id' => $conversationid]);
$userctx = \context_user::instance($userid);
if (empty($conversation->contextid)) {
// When the conversation hasn't any contextid value defined, the favourite will be added to the user context.
$conversationctx = $userctx;
} else {
return $ufservice->create_favourite('core_message', 'message_conversations', $conversationid, $systemcontext);
// If the contextid is defined, the favourite will be added there.
$conversationctx = \context::instance_by_id($conversation->contextid);
}
$ufservice = \core_favourites\service_factory::get_service_for_user_context($userctx);
return $ufservice->create_favourite('core_message', 'message_conversations', $conversationid, $conversationctx);
}
/**
@ -947,8 +955,21 @@ class api {
* @throws \moodle_exception if the favourite does not exist for the user.
*/
public static function unset_favourite_conversation(int $conversationid, int $userid) {
$ufservice = \core_favourites\service_factory::get_service_for_user_context(\context_user::instance($userid));
$ufservice->delete_favourite('core_message', 'message_conversations', $conversationid, \context_system::instance());
global $DB;
// Get the context for this conversation.
$conversation = $DB->get_records('message_conversations', ['id' => $conversationid]);
$userctx = \context_user::instance($userid);
if (empty($conversation->contextid)) {
// When the conversation hasn't any contextid value defined, the favourite will be added to the user context.
$conversationctx = $userctx;
} else {
// If the contextid is defined, the favourite will be added there.
$conversationctx = \context::instance_by_id($conversation->contextid);
}
$ufservice = \core_favourites\service_factory::get_service_for_user_context($userctx);
$ufservice->delete_favourite('core_message', 'message_conversations', $conversationid, $conversationctx);
}
/**

600
message/classes/privacy/provider.php
View File

@ -41,10 +41,20 @@ defined('MOODLE_INTERNAL') || die();
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class provider implements
// The messaging subsystem contains data.
\core_privacy\local\metadata\provider,
// The messaging subsystem provides all the messages at user context - i.e. individual ones.
\core_privacy\local\request\subsystem\provider,
// This plugin has some sitewide user preferences to export.
\core_privacy\local\request\user_preference_provider,
\core_privacy\local\request\core_userlist_provider {
// This plugin is capable of determining which users have data within it.
\core_privacy\local\request\core_userlist_provider,
// The messaging subsystem provides a data service to other components.
\core_privacy\local\request\subsystem\plugin_provider {
/**
* Return the fields which contain personal data.
@ -147,6 +157,9 @@ class provider implements
$items->add_user_preference('core_message_messageprovider_settings',
'privacy:metadata:preference:core_message_settings');
// Add favourite conversations.
$items->link_subsystem('core_favourites', 'privacy:metadata:core_favourites');
return $items;
}
@ -196,8 +209,18 @@ class provider implements
$hasdata = false;
$hasdata = $hasdata || $DB->record_exists_select('notifications', 'useridfrom = ? OR useridto = ?', [$userid, $userid]);
$hasdata = $hasdata || $DB->record_exists('message_conversation_members', ['userid' => $userid]);
$hasdata = $hasdata || $DB->record_exists('messages', ['useridfrom' => $userid]);
$sql = "SELECT mc.id
FROM {message_conversations} mc
JOIN {message_conversation_members} mcm
ON (mcm.conversationid = mc.id AND mcm.userid = :userid)
WHERE mc.contextid IS NULL";
$hasdata = $hasdata || $DB->record_exists_sql($sql, ['userid' => $userid]);
$sql = "SELECT mc.id
FROM {message_conversations} mc
JOIN {messages} m
ON (m.conversationid = mc.id AND m.useridfrom = :useridfrom)
WHERE mc.contextid IS NULL";
$hasdata = $hasdata || $DB->record_exists_sql($sql, ['useridfrom' => $userid]);
$hasdata = $hasdata || $DB->record_exists_select('message_contacts', 'userid = ? OR contactid = ?', [$userid, $userid]);
$hasdata = $hasdata || $DB->record_exists_select('message_users_blocked', 'userid = ? OR blockeduserid = ?',
[$userid, $userid]);
@ -208,6 +231,9 @@ class provider implements
$contextlist->add_user_context($userid);
}
// Add favourite conversations.
\core_favourites\privacy\provider::add_contexts_for_userid($contextlist, $userid, 'core_message', 'message_conversations');
return $contextlist;
}
@ -236,8 +262,18 @@ class provider implements
$hasdata = false;
$hasdata = $hasdata || $DB->record_exists_select('notifications', 'useridfrom = ? OR useridto = ?', [$userid, $userid]);
$hasdata = $hasdata || $DB->record_exists('message_conversation_members', ['userid' => $userid]);
$hasdata = $hasdata || $DB->record_exists('messages', ['useridfrom' => $userid]);
$sql = "SELECT mc.id
FROM {message_conversations} mc
JOIN {message_conversation_members} mcm
ON (mcm.conversationid = mc.id AND mcm.userid = :userid)
WHERE mc.contextid IS NULL";
$hasdata = $hasdata || $DB->record_exists_sql($sql, ['userid' => $userid]);
$sql = "SELECT mc.id
FROM {message_conversations} mc
JOIN {messages} m
ON (m.conversationid = mc.id AND m.useridfrom = :useridfrom)
WHERE mc.contextid IS NULL";
$hasdata = $hasdata || $DB->record_exists_sql($sql, ['useridfrom' => $userid]);
$hasdata = $hasdata || $DB->record_exists_select('message_contacts', 'userid = ? OR contactid = ?', [$userid, $userid]);
$hasdata = $hasdata || $DB->record_exists_select('message_users_blocked', 'userid = ? OR blockeduserid = ?',
[$userid, $userid]);
@ -247,6 +283,16 @@ class provider implements
if ($hasdata) {
$userlist->add_user($userid);
}
// Add favourite conversations.
$component = $userlist->get_component();
if ($component != 'core_message') {
$userlist->set_component('core_message');
}
\core_favourites\privacy\provider::add_userids_for_context($userlist, 'message_conversations');
if ($component != 'core_message') {
$userlist->set_component($component);
}
}
/**
@ -282,8 +328,9 @@ class provider implements
// Export the notifications.
self::export_user_data_notifications($userid);
// Export the messages, with any related actions.
self::export_user_data_messages($userid);
// Conversations with empty contextid should be exported here because they are not related to any component/itemid.
$context = reset($contexts);
self::export_conversations($userid, '', '', $context);
}
/**
@ -345,6 +392,397 @@ class provider implements
static::delete_user_data($context->instanceid);
}
/**
* Provide a list of contexts which have conversations for the user, in the respective area (component/itemtype combination).
*
* This method is to be called by consumers of the messaging subsystem (plugins), in their get_contexts_for_userid() method,
* to add the contexts for items which may have any conversation, but would normally not be reported as having user data by the
* plugin responsible for them.
*
* @param contextlist $contextlist
* @param int $userid The id of the user in scope.
* @param string $component the frankenstyle component name.
* @param string $itemtype the type of the conversation items.
* @param int $itemid Optional itemid associated with component.
*/
public static function add_contexts_for_conversations(contextlist $contextlist, int $userid, string $component,
string $itemtype, int $itemid = 0) {
// Search for conversations for this user in this area.
$sql = "SELECT mc.contextid
FROM {message_conversations} mc
JOIN {message_conversation_members} mcm
ON (mcm.conversationid = mc.id AND mcm.userid = :userid)
JOIN {context} ctx
ON mc.contextid = ctx.id
WHERE mc.component = :component AND mc.itemtype = :itemtype";
$params = [
'userid' => $userid,
'component' => $component,
'itemtype' => $itemtype,
];
if (!empty($itemid)) {
$sql .= " AND itemid = :itemid";
$params['itemid'] = $itemid;
}
$contextlist->add_from_sql($sql, $params);
// Add favourite conversations. We don't need to filter by itemid because for now they are in the system context.
\core_favourites\privacy\provider::add_contexts_for_userid($contextlist, $userid, 'core_message', 'message_conversations');
}
/**
* Add the list of users who have a conversation in the specified area (component + itemtype + itemid).
*
* @param userlist $userlist The userlist to add the users to.
* @param string $component The component to check.
* @param string $itemtype The type of the conversation items.
* @param int $itemid Optional itemid associated with component.
*/
public static function add_conversations_in_context(userlist $userlist, string $component, string $itemtype, int $itemid = 0) {
$sql = "SELECT mcm.userid
FROM {message_conversation_members} mcm
INNER JOIN {message_conversations} mc
ON mc.id = mcm.conversationid
WHERE mc.contextid = :contextid AND mc.component = :component AND mc.itemtype = :itemtype";
$params = [
'contextid' => $userlist->get_context()->id,
'component' => $component,
'itemtype' => $itemtype
];
if (!empty($itemid)) {
$sql .= " AND itemid = :itemid";
$params['itemid'] = $itemid;
}
$userlist->add_from_sql('userid', $sql, $params);
// Add favourite conversations.
$component = $userlist->get_component();
if ($component != 'core_message') {
$userlist->set_component('core_message');
}
\core_favourites\privacy\provider::add_userids_for_context($userlist, 'message_conversations');
if ($component != 'core_message') {
$userlist->set_component($component);
}
}
/**
* Store all conversations which match the specified component, itemtype, and itemid.
*
* Conversations without context (for now, the private ones) are stored in '<$context> | Messages | <Other user id>'.
* Conversations with context are stored in '<$context> | Messages | <Conversation item type> | <Conversation name>'.
*
* @param int $userid The user whose information is to be exported.
* @param string $component The component to fetch data from.
* @param string $itemtype The itemtype that the data was exported in within the component.
* @param \context $context The context to export for.
* @param array $subcontext The sub-context in which to export this data.
* @param int $itemid Optional itemid associated with component.
*/
public static function export_conversations(int $userid, string $component, string $itemtype, \context $context,
array $subcontext = [], int $itemid = 0) {
global $DB;
// Search for conversations for this user in this area.
$sql = "SELECT DISTINCT mc.*
FROM {message_conversations} mc
JOIN {message_conversation_members} mcm
ON (mcm.conversationid = mc.id AND mcm.userid = :userid)";
$params = [
'userid' => $userid
];
// Get the conversations for the defined component and itemtype.
if (!empty($component) && !empty($itemtype)) {
$sql .= " WHERE mc.component = :component AND mc.itemtype = :itemtype";
$params['component'] = $component;
$params['itemtype'] = $itemtype;
if (!empty($itemid)) {
$sql .= " AND mc.itemid = :itemid";
$params['itemid'] = $itemid;
}
} else {
// Get all the conversations without any component and itemtype, so with null contextid.
$sql .= " WHERE mc.contextid IS NULL";
}
if ($conversations = $DB->get_records_sql($sql, $params)) {
// Export conversation messages.
foreach ($conversations as $conversation) {
self::export_user_data_conversation_messages($userid, $conversation, $context, $subcontext);
}
}
}
/**
* Deletes all group memberships for a specified context and component.
*
* @param \context $context Details about which context to delete group memberships for.
* @param string $component The component to delete. Empty string means no component.
* @param string $itemtype The itemtype of the component to delele. Empty string means no itemtype.
* @param int $itemid Optional itemid associated with component.
*/
public static function delete_conversations_for_all_users(\context $context, string $component, string $itemtype,
int $itemid = 0) {
global $DB;
if (empty($context)) {
return;
}
$select = "contextid = :contextid AND component = :component AND itemtype = :itemtype";
$params = [
'contextid' => $context->id,
'component' => $component,
'itemtype' => $itemtype
];
if (!empty($itemid)) {
$select .= " AND itemid = :itemid";
$params['itemid'] = $itemid;
}
// Get and remove all the conversations and messages for the specified context and area.
if ($conversationids = $DB->get_records_select('message_conversations', $select, $params, '', 'id')) {
$conversationids = array_keys($conversationids);
$messageids = $DB->get_records_list('messages', 'conversationid', $conversationids);
$messageids = array_keys($messageids);
// Delete these favourite conversations to all the users.
foreach ($conversationids as $conversationid) {
\core_favourites\privacy\provider::delete_favourites_for_all_users(
$context,
'core_message',
'message_conversations',
$conversationid);
}
// Delete messages and user_actions.
$DB->delete_records_list('message_user_actions', 'messageid', $messageids);
$DB->delete_records_list('messages', 'id', $messageids);
// Delete members and conversations.
$DB->delete_records_list('message_conversation_members', 'conversationid', $conversationids);
$DB->delete_records_list('message_conversations', 'id', $conversationids);
}
}
/**
* Deletes all records for a user from a list of approved contexts.
*
* When the component and the itemtype are empty and there is only one user context in the list, all the
* conversations without contextid will be removed. However, if the component and itemtype are defined,
* only the conversations in these area for the contexts in $contextlist wil be deleted.
*
* @param approved_contextlist $contextlist Contains the user ID and a list of contexts to be deleted from.
* @param string $component The component to delete. Empty string means no component.
* @param string $itemtype The itemtype of the component to delele. Empty string means no itemtype.
* @param int $itemid Optional itemid associated with component.
*/
public static function delete_conversations_for_user(approved_contextlist $contextlist, string $component, string $itemtype,
int $itemid = 0) {
self::delete_user_data_conversations(
$contextlist->get_user()->id,
$contextlist->get_contextids(),
$component,
$itemtype,
$itemid
);
}
/**
* Deletes all records for multiple users within a single context.
*
* @param approved_userlist $userlist The approved context and user information to delete information for.
* @param string $component The component to delete. Empty string means no component.
* @param string $itemtype The itemtype of the component to delele. Empty string means no itemtype.
* @param int $itemid Optional itemid associated with component.
*/
public static function delete_conversations_for_users(approved_userlist $userlist, string $component, string $itemtype,
int $itemid = 0) {
global $DB;
$userids = $userlist->get_userids();
if (empty($userids)) {
return;
}
$context = $userlist->get_context();
$select = "mc.contextid = :contextid AND mc.component = :component AND mc.itemtype = :itemtype";
$params = [
'contextid' => $context->id,
'component' => $component,
'itemtype' => $itemtype
];
if (!empty($itemid)) {
$select .= " AND itemid = :itemid";
$params['itemid'] = $itemid;
}
// Get conversations in this area where the specified users are a member of.
list($useridsql, $useridparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
$sql = "SELECT DISTINCT mcm.conversationid as id
FROM {message_conversation_members} mcm
INNER JOIN {message_conversations} mc
ON mc.id = mcm.conversationid
WHERE mcm.userid $useridsql AND $select";
$params += $useridparams;
$conversationids = array_keys($DB->get_records_sql($sql, $params));
if (!empty($conversationids)) {
list($conversationidsql, $conversationidparams) = $DB->get_in_or_equal($conversationids, SQL_PARAMS_NAMED);
// Get all the messages for these conversations which has some action stored for these users.
$sql = "SELECT DISTINCT m.id
FROM {messages} m
INNER JOIN {message_conversations} mc
ON mc.id = m.conversationid
INNER JOIN {message_user_actions} mua
ON mua.messageid = m.id
WHERE mua.userid $useridsql AND mc.id $conversationidsql";
$params = $useridparams + $conversationidparams;
$messageids = array_keys($DB->get_records_sql($sql, $params));
if (!empty($messageids)) {
// Delete all the user_actions for the messages on these conversations where the user has any action.
list($messageidsql, $messageidparams) = $DB->get_in_or_equal($messageids, SQL_PARAMS_NAMED);
$select = "messageid $messageidsql AND userid $useridsql";
$DB->delete_records_select('message_user_actions', $select, $messageidparams + $useridparams);
}
// Get all the messages for these conversations sent by these users.
$sql = "SELECT DISTINCT m.id
FROM {messages} m
WHERE m.useridfrom $useridsql AND m.conversationid $conversationidsql";
// Reuse the $params var because it contains the useridparams and the conversationids.
$messageids = array_keys($DB->get_records_sql($sql, $params));
if (!empty($messageids)) {
// Delete all the user_actions for the messages sent by any of these users.
$DB->delete_records_list('message_user_actions', 'messageid', $messageids);
// Delete all the messages sent by any of these users.
$DB->delete_records_list('messages', 'id', $messageids);
}
// In that case, conversations can't be removed, because they could have more members and messages.
// So, remove only users from the context conversations where they are member of.
$sql = "conversationid $conversationidsql AND userid $useridsql";
// Reuse the $params var because it contains the useridparams and the conversationids.
$DB->delete_records_select('message_conversation_members', $sql, $params);
// Delete the favourite conversations.
$userlist = new \core_privacy\local\request\approved_userlist($context, 'core_message', $userids);
\core_favourites\privacy\provider::delete_favourites_for_userlist(
$userlist,
'message_conversations'
);
}
}
/**
* Deletes all records for multiple users within multiple contexts in a component area.
*
* @param int $userid The user identifier to delete information for.
* @param array $contextids The context identifiers to delete information for. Empty array means no context (for
* individual conversations).
* @param string $component The component to delete. Empty string means no component (for individual conversations).
* @param string $itemtype The itemtype of the component to delele. Empty string means no itemtype (for individual
* conversations).
* @param int $itemid Optional itemid associated with component.
*/
protected static function delete_user_data_conversations(int $userid, array $contextids, string $component,
string $itemtype, int $itemid = 0) {
global $DB;
if (empty($contextids) && empty($component) && empty($itemtype) && empty($itemid)) {
// Individual conversations haven't context, component neither itemtype.
$select = "mc.contextid IS NULL";
$params = [];
} else {
list($contextidsql, $contextidparams) = $DB->get_in_or_equal($contextids, SQL_PARAMS_NAMED);
$select = "mc.contextid $contextidsql AND mc.component = :component AND mc.itemtype = :itemtype";
$params = [
'component' => $component,
'itemtype' => $itemtype
];
$params += $contextidparams;
if (!empty($itemid)) {
$select .= " AND itemid = :itemid";
$params['itemid'] = $itemid;
}
}
// Get conversations in these contexts where the specified userid is a member of.
$sql = "SELECT DISTINCT mcm.conversationid as id
FROM {message_conversation_members} mcm
INNER JOIN {message_conversations} mc
ON mc.id = mcm.conversationid
WHERE mcm.userid = :userid AND $select";
$params['userid'] = $userid;
$conversationids = array_keys($DB->get_records_sql($sql, $params));
if (!empty($conversationids)) {
list($conversationidsql, $conversationidparams) = $DB->get_in_or_equal($conversationids, SQL_PARAMS_NAMED);
// Get all the messages for these conversations which has some action stored for the userid.
$sql = "SELECT DISTINCT m.id
FROM {messages} m
INNER JOIN {message_conversations} mc
ON mc.id = m.conversationid
INNER JOIN {message_user_actions} mua
ON mua.messageid = m.id
WHERE mua.userid = :userid AND mc.id $conversationidsql";
$params = ['userid' => $userid] + $conversationidparams;
$messageids = array_keys($DB->get_records_sql($sql, $params));
if (!empty($messageids)) {
// Delete all the user_actions for the messages on these conversations where the user has any action.
list($messageidsql, $messageidparams) = $DB->get_in_or_equal($messageids, SQL_PARAMS_NAMED);
$select = "messageid $messageidsql AND userid = :userid";
$DB->delete_records_select('message_user_actions', $select, $messageidparams + ['userid' => $userid]);
}
// Get all the messages for these conversations sent by the userid.
$sql = "SELECT DISTINCT m.id
FROM {messages} m
WHERE m.useridfrom = :userid AND m.conversationid $conversationidsql";
// Reuse the $params var because it contains the userid and the conversationids.
$messageids = array_keys($DB->get_records_sql($sql, $params));
if (!empty($messageids)) {
// Delete all the user_actions for the messages sent by the userid.
$DB->delete_records_list('message_user_actions', 'messageid', $messageids);
// Delete all the messages sent by the userid.
$DB->delete_records_list('messages', 'id', $messageids);
}
// In that case, conversations can't be removed, because they could have more members and messages.
// So, remove only userid from the context conversations where he/she is member of.
$sql = "conversationid $conversationidsql AND userid = :userid";
// Reuse the $params var because it contains the userid and the conversationids.
$DB->delete_records_select('message_conversation_members', $sql, $params);
// Delete the favourite conversations.
if (empty($contextids) && empty($component) && empty($itemtype) && empty($itemid)) {
// Favourites for individual conversations are stored into the user context.
$favouritectxids = [\context_user::instance($userid)->id];
} else {
$favouritectxids = $contextids;
}
$contextlist = new \core_privacy\local\request\approved_contextlist(
\core_user::get_user($userid),
'core_message',
$favouritectxids
);
\core_favourites\privacy\provider::delete_favourites_for_user(
$contextlist,
'core_message',
'message_conversations'
);
}
}
/**
* Delete all user data for the specified user.
*
@ -353,9 +791,10 @@ class provider implements
protected static function delete_user_data(int $userid) {
global $DB;
$DB->delete_records('messages', ['useridfrom' => $userid]);
$DB->delete_records('message_user_actions', ['userid' => $userid]);
$DB->delete_records('message_conversation_members', ['userid' => $userid]);
// Delete individual conversations information for this user.
self::delete_user_data_conversations($userid, [], '', '');
// Delete contacts, requests, users blocked and notifications.
$DB->delete_records_select('message_contacts', 'userid = ? OR contactid = ?', [$userid, $userid]);
$DB->delete_records_select('message_contact_requests', 'userid = ? OR requesteduserid = ?', [$userid, $userid]);
$DB->delete_records_select('message_users_blocked', 'userid = ? OR blockeduserid = ?', [$userid, $userid]);
@ -438,73 +877,102 @@ class provider implements
}
/**
* Export the messaging data.
* Export conversation messages.
*
* @param int $userid
* @param int $userid The user identifier.
* @param \stdClass $conversation The conversation to export the messages.
* @param \context $context The context to export for.
* @param array $subcontext The sub-context in which to export this data.
*/
protected static function export_user_data_messages(int $userid) {
protected static function export_user_data_conversation_messages(int $userid, \stdClass $conversation, \context $context,
array $subcontext = []) {
global $DB;
$context = \context_user::instance($userid);
// Get all the messages for this conversation from start to finish.
$sql = "SELECT m.*, muadelete.timecreated as timedeleted, muaread.timecreated as timeread
FROM {messages} m
LEFT JOIN {message_user_actions} muadelete
ON m.id = muadelete.messageid AND muadelete.action = :deleteaction AND muadelete.userid = :deleteuserid
LEFT JOIN {message_user_actions} muaread
ON m.id = muaread.messageid AND muaread.action = :readaction AND muaread.userid = :readuserid
WHERE conversationid = :conversationid
ORDER BY m.timecreated ASC";
$messages = $DB->get_recordset_sql($sql, ['deleteaction' => \core_message\api::MESSAGE_ACTION_DELETED,
'readaction' => \core_message\api::MESSAGE_ACTION_READ, 'conversationid' => $conversation->id,
'deleteuserid' => $userid, 'readuserid' => $userid]);
$messagedata = [];
foreach ($messages as $message) {
$timeread = !is_null($message->timeread) ? transform::datetime($message->timeread) : '-';
$issender = $userid == $message->useridfrom;
$sql = "SELECT DISTINCT mcm.conversationid as id
FROM {message_conversation_members} mcm
WHERE mcm.userid = :userid";
if ($conversations = $DB->get_records_sql($sql, ['userid' => $userid])) {
// Ok, let's get the other users in the conversations.
$conversationids = array_keys($conversations);
list($conversationidsql, $conversationparams) = $DB->get_in_or_equal($conversationids, SQL_PARAMS_NAMED);
$userfields = \user_picture::fields('u');
$userssql = "SELECT mcm.conversationid, $userfields
FROM {user} u
INNER JOIN {message_conversation_members} mcm
ON u.id = mcm.userid
WHERE mcm.conversationid $conversationidsql
AND mcm.userid != :userid
AND u.deleted = 0";
$otherusers = $DB->get_records_sql($userssql, $conversationparams + ['userid' => $userid]);
foreach ($conversations as $conversation) {
$otheruserfullname = get_string('unknownuser', 'core_message');
$data = [
'issender' => transform::yesno($issender),
'message' => message_format_message_text($message),
'timecreated' => transform::datetime($message->timecreated),
'timeread' => $timeread
];
if ($conversation->type == \core_message\api::MESSAGE_CONVERSATION_TYPE_GROUP && !$issender) {
// Only export sender for group conversations when is not the current user.
$data['sender'] = transform::user($message->useridfrom);
}
// It's possible the other user has requested to be deleted, so might not exist
// as a conversation member, or they have just been deleted.
if (isset($otherusers[$conversation->id])) {
$otheruserfullname = fullname($otherusers[$conversation->id]);
if (!is_null($message->timedeleted)) {
$data['timedeleted'] = transform::datetime($message->timedeleted);
}
$messagedata[] = (object) $data;
}
$messages->close();
if (!empty($messagedata)) {
// Get subcontext.
if (empty($conversation->contextid)) {
// Conversations without context are stored in 'Messages | <Other user id>'.
$members = $DB->get_records('message_conversation_members', ['conversationid' => $conversation->id]);
$members = array_filter($members, function ($member) use ($userid) {
return $member->userid != $userid;
});
if ($otheruser = reset($members)) {
$otherusertext = $otheruser->userid;
} else {
$otherusertext = get_string('unknownuser', 'core_message') . '_' . $conversation->id;
}
// Get all the messages for this conversation from start to finish.
$sql = "SELECT m.*, muadelete.timecreated as timedeleted, muaread.timecreated as timeread
FROM {messages} m
LEFT JOIN {message_user_actions} muadelete
ON m.id = muadelete.messageid AND muadelete.action = :deleteaction
LEFT JOIN {message_user_actions} muaread
ON m.id = muaread.messageid AND muaread.action = :readaction
WHERE conversationid = :conversationid
ORDER BY m.timecreated ASC";
$messages = $DB->get_recordset_sql($sql, ['deleteaction' => \core_message\api::MESSAGE_ACTION_DELETED,
'readaction' => \core_message\api::MESSAGE_ACTION_READ, 'conversationid' => $conversation->id]);
$messagedata = [];
foreach ($messages as $message) {
$timeread = !is_null($message->timeread) ? transform::datetime($message->timeread) : '-';
$issender = $userid == $message->useridfrom;
$subcontext = array_merge(
$subcontext,
[get_string('messages', 'core_message'), $otherusertext]
);
$data = [
'sender' => transform::yesno($issender),
'message' => message_format_message_text($message),
'timecreated' => transform::datetime($message->timecreated),
'timeread' => $timeread
];
if (!is_null($message->timedeleted)) {
$data['timedeleted'] = transform::datetime($message->timedeleted);
}
$messagedata[] = (object) $data;
// Get the context for the favourite conversation.
$conversationctx = \context_user::instance($userid);
} else {
// Conversations with context are stored in 'Messages | <Conversation item type> | <Conversation name>'.
if (get_string_manager()->string_exists($conversation->itemtype, $conversation->component)) {
$itemtypestring = get_string($conversation->itemtype, $conversation->component);
} else {
// If the itemtype doesn't exist in the component string file, the raw itemtype will be returned.
$itemtypestring = $conversation->itemtype;
}
$messages->close();
writer::with_context($context)->export_data([get_string('messages', 'core_message'), $otheruserfullname],
(object) $messagedata);
$conversationname = get_string('privacy:export:conversationprefix', 'core_message') . $conversation->name;
$subcontext = array_merge(
$subcontext,
[get_string('messages', 'core_message'), $itemtypestring, $conversationname]
);
// Get the context for the favourite conversation.
$conversationctx = \context::instance_by_id($conversation->contextid);
}
// Export the conversation messages.
writer::with_context($context)->export_data($subcontext, (object) $messagedata);
// Get user's favourites information for the particular conversation.
$conversationfavourite = \core_favourites\privacy\provider::get_favourites_info_for_user($userid, $conversationctx,
'core_message', 'message_conversations', $conversation->id);
if ($conversationfavourite) {
// If the conversation has been favorited by the user, include it in the export.
writer::with_context($context)->export_related_data($subcontext, 'starred', (object) $conversationfavourite);
}
}
}

1498
message/tests/privacy_provider_test.php
View File

File diff suppressed because it is too large Load Diff

2
version.php
View File

@ -29,7 +29,7 @@
defined('MOODLE_INTERNAL') || die();
$version = 2018111900.01; // YYYYMMDD = weekly release date of this DEV branch.
$version = 2018112000.00; // YYYYMMDD = weekly release date of this DEV branch.
// RR = release increments - 00 in DEV branches.
// .XX = incremental changes.