L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-61309 mod_forum: Implement the Privacy API

Browse Source
This commit is contained in:
Andrew Nicols
2018-02-08 10:22:02 +08:00
parent 6b6226160d
commit 2fefe3ca68
6 changed files with 2260 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mod/forum/classes/privacy/provider.php
+887
View File
@@ -0,0 +1,887 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Privacy Subsystem implementation for mod_forum.
*
* @package mod_forum
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_forum\privacy;
use \core_privacy\local\request\approved_contextlist;
use \core_privacy\local\request\deletion_criteria;
use \core_privacy\local\request\writer;
use \core_privacy\local\request\helper as request_helper;
use \core_privacy\local\metadata\collection;
use \core_privacy\local\request\transform;
defined('MOODLE_INTERNAL') || die();
/**
* Implementation of the privacy subsystem plugin provider for the forum activity module.
*
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class provider implements
// This plugin has data.
\core_privacy\local\metadata\provider,
// This plugin currently implements the original plugin\provider interface.
\core_privacy\local\request\plugin\provider,
// This plugin has some sitewide user preferences to export.
\core_privacy\local\request\user_preference_provider
{
use subcontext_info;
/**
* Returns meta data about this system.
*
* @param collection $items The initialised collection to add items to.
* @return collection A listing of user data stored through this system.
*/
public static function get_metadata(collection $items) {
// The 'forum' table does not store any specific user data.
$items->add_database_table('forum_digests', [
'forum' => 'privacy:metadata:forum_digests:forum',
'userid' => 'privacy:metadata:forum_digests:userid',
'maildigest' => 'privacy:metadata:forum_digests:maildigest',
], 'privacy:metadata:forum_digests');
// The 'forum_discussions' table stores the metadata about each forum discussion.
$items->add_database_table('forum_discussions', [
'name' => 'privacy:metadata:forum_discussions:name',
'userid' => 'privacy:metadata:forum_discussions:userid',
'assessed' => 'privacy:metadata:forum_discussions:assessed',
'timemodified' => 'privacy:metadata:forum_discussions:timemodified',
'usermodified' => 'privacy:metadata:forum_discussions:usermodified',
], 'privacy:metadata:forum_discussions');
// The 'forum_discussion_subs' table stores information about which discussions a user is subscribed to.
$items->add_database_table('forum_discussion_subs', [
'discussionid' => 'privacy:metadata:forum_discussion_subs:discussionid',
'preference' => 'privacy:metadata:forum_discussion_subs:preference',
'userid' => 'privacy:metadata:forum_discussion_subs:userid',
], 'privacy:metadata:forum_discussion_subs');
// The 'forum_posts' table stores the metadata about each forum discussion.
$items->add_database_table('forum_posts', [
'discussion' => 'privacy:metadata:forum_posts:discussion',
'parent' => 'privacy:metadata:forum_posts:parent',
'created' => 'privacy:metadata:forum_posts:created',
'modified' => 'privacy:metadata:forum_posts:modified',
'subject' => 'privacy:metadata:forum_posts:subject',
'message' => 'privacy:metadata:forum_posts:message',
'userid' => 'privacy:metadata:forum_posts:userid',
], 'privacy:metadata:forum_posts');
// The 'forum_queue' table contains user data, but it is only a temporary cache of other data.
// We should not need to export it as it does not allow profiling of a user.
// The 'forum_read' table stores data about which forum posts have been read by each user.
$items->add_database_table('forum_read', [
'userid' => 'privacy:metadata:forum_read:userid',
'discussionid' => 'privacy:metadata:forum_read:discussionid',
'postid' => 'privacy:metadata:forum_read:postid',
'firstread' => 'privacy:metadata:forum_read:firstread',
'lastread' => 'privacy:metadata:forum_read:lastread',
], 'privacy:metadata:forum_read');
// The 'forum_subscriptions' table stores information about which forums a user is subscribed to.
$items->add_database_table('forum_subscriptions', [
'userid' => 'privacy:metadata:forum_subscriptions:userid',
'forum' => 'privacy:metadata:forum_subscriptions:forum',
], 'privacy:metadata:forum_subscriptions');
// The 'forum_subscriptions' table stores information about which forums a user is subscribed to.
$items->add_database_table('forum_track_prefs', [
'userid' => 'privacy:metadata:forum_track_prefs:userid',
'forumid' => 'privacy:metadata:forum_track_prefs:forumid',
], 'privacy:metadata:forum_track_prefs');
// Forum posts can be tagged and rated.
$items->link_subsystem('core_tag', 'privacy:metadata:core_tag');
$items->link_subsystem('core_rating', 'privacy:metadata:core_rating');
// There are several user preferences.
$items->add_user_preference('maildigest', 'privacy:metadata:preference:maildigest');
$items->add_user_preference('autosubscribe', 'privacy:metadata:preference:autosubscribe');
$items->add_user_preference('trackforums', 'privacy:metadata:preference:trackforums');
$items->add_user_preference('markasreadonnotification', 'privacy:metadata:preference:markasreadonnotification');
return $items;
}
/**
* Get the list of contexts that contain user information for the specified user.
*
* In the case of forum, that is any forum where the user has made any post, rated any content, or has any preferences.
*
* @param int $userid The user to search.
* @return contextlist $contextlist The contextlist containing the list of contexts used in this plugin.
*/
public static function get_contexts_for_userid($userid) {
$ratingsql = \core_rating\privacy\provider::get_sql_join('rat', 'mod_forum', 'post', 'p.id', $userid);
// Fetch all forum discussions, and forum posts.
$sql = "SELECT c.id
FROM {context} c
INNER JOIN {course_modules} cm ON cm.id = c.instanceid AND c.contextlevel = :contextlevel
INNER JOIN {modules} m ON m.id = cm.module AND m.name = :modname
INNER JOIN {forum} f ON f.id = cm.instance
LEFT JOIN {forum_discussions} d ON d.forum = f.id
LEFT JOIN {forum_posts} p ON p.discussion = d.id
LEFT JOIN {forum_digests} dig ON dig.forum = f.id
LEFT JOIN {forum_subscriptions} sub ON sub.forum = f.id
LEFT JOIN {forum_track_prefs} pref ON pref.forumid = f.id
LEFT JOIN {forum_read} hasread ON hasread.forumid = f.id
LEFT JOIN {forum_discussion_subs} dsub ON dsub.forum = f.id
{$ratingsql->join}
WHERE (
p.userid = :postuserid OR
d.userid = :discussionuserid OR
dig.userid = :digestuserid OR
sub.userid = :subuserid OR
pref.userid = :prefuserid OR
hasread.userid = :hasreaduserid OR
dsub.userid = :dsubuserid OR
{$ratingsql->userwhere}
)
";
$params = [
'modname' => 'forum',
'contextlevel' => CONTEXT_MODULE,
'postuserid' => $userid,
'discussionuserid' => $userid,
'digestuserid' => $userid,
'subuserid' => $userid,
'prefuserid' => $userid,
'hasreaduserid' => $userid,
'dsubuserid' => $userid,
];
$params += $ratingsql->params;
$contextlist = new \core_privacy\local\request\contextlist();
$contextlist->add_from_sql($sql, $params);
return $contextlist;
}
/**
* Store all user preferences for the plugin.
*
* @param int $userid The userid of the user whose data is to be exported.
*/
public static function export_user_preferences($userid) {
$user = \core_user::get_user($userid);
switch ($user->maildigest) {
case 1:
$digestdescription = get_string('emaildigestcomplete');
break;
case 2:
$digestdescription = get_string('emaildigestsubjects');
break;
case 0:
default:
$digestdescription = get_string('emaildigestoff');
break;
}
writer::export_user_preference('mod_forum', 'maildigest', $user->maildigest, $digestdescription);
switch ($user->autosubscribe) {
case 0:
$subscribedescription = get_string('autosubscribeno');
break;
case 1:
default:
$subscribedescription = get_string('autosubscribeyes');
break;
}
writer::export_user_preference('mod_forum', 'autosubscribe', $user->autosubscribe, $subscribedescription);
switch ($user->trackforums) {
case 0:
$trackforumdescription = get_string('trackforumsno');
break;
case 1:
default:
$trackforumdescription = get_string('trackforumsyes');
break;
}
writer::export_user_preference('mod_forum', 'trackforums', $user->trackforums, $trackforumdescription);
$markasreadonnotification = get_user_preferences('markasreadonnotification', null, $user->id);
if (null !== $markasreadonnotification) {
switch ($markasreadonnotification) {
case 0:
$markasreadonnotificationdescription = get_string('markasreadonnotificationno', 'mod_forum');
break;
case 1:
default:
$markasreadonnotificationdescription = get_string('markasreadonnotificationyes', 'mod_forum');
break;
}
writer::export_user_preference('mod_forum', 'markasreadonnotification', $markasreadonnotification,
$markasreadonnotificationdescription);
}
}
/**
* Export all user data for the specified user, in the specified contexts.
*
* @param approved_contextlist $contextlist The approved contexts to export information for.
*/
public static function export_user_data(approved_contextlist $contextlist) {
global $DB;
if (empty($contextlist)) {
return;
}
$user = $contextlist->get_user();
$userid = $user->id;
list($contextsql, $contextparams) = $DB->get_in_or_equal($contextlist->get_contextids(), SQL_PARAMS_NAMED);
$sql = "SELECT
c.id AS contextid,
f.*,
cm.id AS cmid,
dig.maildigest,
sub.userid AS subscribed,
pref.userid AS tracked
FROM {context} c
INNER JOIN {course_modules} cm ON cm.id = c.instanceid
INNER JOIN {forum} f ON f.id = cm.instance
LEFT JOIN {forum_digests} dig ON dig.forum = f.id AND dig.userid = :digestuserid
LEFT JOIN {forum_subscriptions} sub ON sub.forum = f.id AND sub.userid = :subuserid
LEFT JOIN {forum_track_prefs} pref ON pref.forumid = f.id AND pref.userid = :prefuserid
WHERE (
c.id {$contextsql}
)
";
$params = [
'digestuserid' => $userid,
'subuserid' => $userid,
'prefuserid' => $userid,
];
$params += $contextparams;
// Keep a mapping of forumid to contextid.
$mappings = [];
$forums = $DB->get_recordset_sql($sql, $params);
foreach ($forums as $forum) {
$mappings[$forum->id] = $forum->contextid;
$context = \context::instance_by_id($mappings[$forum->id]);
// Store the main forum data.
$data = request_helper::get_context_data($context, $user);
writer::with_context($context)
->export_data([], $data);
request_helper::export_context_files($context, $user);
// Store relevant metadata about this forum instance.
static::export_digest_data($userid, $forum);
static::export_subscription_data($userid, $forum);
static::export_tracking_data($userid, $forum);
}
$forums->close();
if (!empty($mappings)) {
// Store all discussion data for this forum.
static::export_discussion_data($userid, $mappings);
// Store all post data for this forum.
static::export_all_posts($userid, $mappings);
}
}
/**
* Store all information about all discussions that we have detected this user to have access to.
*
* @param int $userid The userid of the user whose data is to be exported.
* @param array $mappings A list of mappings from forumid => contextid.
* @return array Which forums had data written for them.
*/
protected static function export_discussion_data($userid, array $mappings) {
global $DB;
// Find all of the discussions, and discussion subscriptions for this forum.
list($foruminsql, $forumparams) = $DB->get_in_or_equal(array_keys($mappings), SQL_PARAMS_NAMED);
$sql = "SELECT
d.*,
g.name as groupname,
dsub.preference
FROM {forum} f
INNER JOIN {forum_discussions} d ON d.forum = f.id
LEFT JOIN {groups} g ON g.id = d.groupid
LEFT JOIN {forum_discussion_subs} dsub ON dsub.discussion = d.id
LEFT JOIN {forum_posts} p ON p.discussion = d.id
WHERE f.id ${foruminsql}
AND (
d.userid = :discussionuserid OR
p.userid = :postuserid OR
dsub.userid = :dsubuserid
)
";
$params = [
'postuserid' => $userid,
'discussionuserid' => $userid,
'dsubuserid' => $userid,
];
$params += $forumparams;
// Keep track of the forums which have data.
$forumswithdata = [];
$discussions = $DB->get_recordset_sql($sql, $params);
foreach ($discussions as $discussion) {
// No need to take timestart into account as the user has some involvement already.
// Ignore discussion timeend as it should not block access to user data.
$forumswithdata[$discussion->forum] = true;
$context = \context::instance_by_id($mappings[$discussion->forum]);
// Store related metadata for this discussion.
static::export_discussion_subscription_data($userid, $context, $discussion);
$discussiondata = (object) [
'name' => format_string($discussion->name, true),
'pinned' => transform::yesno((bool) $discussion->pinned),
'timemodified' => transform::datetime($discussion->timemodified),
'usermodified' => transform::datetime($discussion->usermodified),
];
// Store the discussion content.
writer::with_context($context)
->export_data(static::get_discussion_area($discussion), $discussiondata);
// Forum discussions do not have any files associately directly with them.
}
$discussions->close();
return $forumswithdata;
}
/**
* Store all information about all posts that we have detected this user to have access to.
*
* @param int $userid The userid of the user whose data is to be exported.
* @param array $mappings A list of mappings from forumid => contextid.
* @return array Which forums had data written for them.
*/
protected static function export_all_posts($userid, array $mappings) {
global $DB;
// Find all of the posts, and post subscriptions for this forum.
list($foruminsql, $forumparams) = $DB->get_in_or_equal(array_keys($mappings), SQL_PARAMS_NAMED);
$ratingsql = \core_rating\privacy\provider::get_sql_join('rat', 'mod_forum', 'post', 'p.id', $userid);
$sql = "SELECT
p.discussion AS id,
f.id AS forumid,
d.name,
d.groupid
FROM {forum} f
INNER JOIN {forum_discussions} d ON d.forum = f.id
INNER JOIN {forum_posts} p ON p.discussion = d.id
LEFT JOIN {forum_read} fr ON fr.postid = p.id
{$ratingsql->join}
WHERE f.id ${foruminsql} AND
(
p.userid = :postuserid OR
fr.userid = :readuserid OR
{$ratingsql->userwhere}
)
GROUP BY f.id, p.discussion, d.name, d.groupid
";
$params = [
'postuserid' => $userid,
'readuserid' => $userid,
];
$params += $forumparams;
$params += $ratingsql->params;
$discussions = $DB->get_records_sql($sql, $params);
foreach ($discussions as $discussion) {
$context = \context::instance_by_id($mappings[$discussion->forumid]);
static::export_all_posts_in_discussion($userid, $context, $discussion);
}
}
/**
* Store all information about all posts that we have detected this user to have access to.
*
* @param int $userid The userid of the user whose data is to be exported.
* @param \context $context The instance of the forum context.
* @param \stdClass $discussion The discussion whose data is being exported.
*/
protected static function export_all_posts_in_discussion($userid, \context $context, \stdClass $discussion) {
global $DB, $USER;
$discussionid = $discussion->id;
// Find all of the posts, and post subscriptions for this forum.
$ratingsql = \core_rating\privacy\provider::get_sql_join('rat', 'mod_forum', 'post', 'p.id', $userid);
$sql = "SELECT
p.*,
d.forum AS forumid,
fr.firstread,
fr.lastread,
fr.id AS readflag,
rat.id AS hasratings
FROM {forum_discussions} d
INNER JOIN {forum_posts} p ON p.discussion = d.id
LEFT JOIN {forum_read} fr ON fr.postid = p.id AND fr.userid = :readuserid
{$ratingsql->join} AND {$ratingsql->userwhere}
WHERE d.id = :discussionid
";
$params = [
'discussionid' => $discussionid,
'readuserid' => $userid,
];
$params += $ratingsql->params;
// Keep track of the forums which have data.
$structure = (object) [
'children' => [],
];
$posts = $DB->get_records_sql($sql, $params);
foreach ($posts as $post) {
$post->hasdata = (isset($post->hasdata)) ? $post->hasdata : false;
$post->hasdata = $post->hasdata || !empty($post->hasratings);
$post->hasdata = $post->hasdata || $post->readflag;
$post->hasdata = $post->hasdata || ($post->userid == $USER->id);
if (0 == $post->parent) {
$structure->children[$post->id] = $post;
} else {
if (empty($posts[$post->parent]->children)) {
$posts[$post->parent]->children = [];
}
$posts[$post->parent]->children[$post->id] = $post;
}
// Set all parents.
if ($post->hasdata) {
$curpost = $post;
while ($curpost->parent != 0) {
$curpost = $posts[$curpost->parent];
$curpost->hasdata = true;
}
}
}
$discussionarea = static::get_discussion_area($discussion);
$discussionarea[] = get_string('posts', 'mod_forum');
static::export_posts_in_structure($userid, $context, $discussionarea, $structure);
}
/**
* Export all posts in the provided structure.
*
* @param int $userid The userid of the user whose data is to be exported.
* @param \context $context The instance of the forum context.
* @param array $parentarea The subcontext of the parent.
* @param \stdClass $structure The post structure and all of its children
*/
protected static function export_posts_in_structure($userid, \context $context, $parentarea, \stdClass $structure) {
foreach ($structure->children as $post) {
if (!$post->hasdata) {
// This tree has no content belonging to the user. Skip it and all children.
continue;
}
$postarea = array_merge($parentarea, static::get_post_area($post));
// Store the post content.
static::export_post_data($userid, $context, $postarea, $post);
if (isset($post->children)) {
// Now export children of this post.
static::export_posts_in_structure($userid, $context, $postarea, $post);
}
}
}
/**
* Export all data in the post.
*
* @param int $userid The userid of the user whose data is to be exported.
* @param \context $context The instance of the forum context.
* @param array $postarea The subcontext of the parent.
* @param \stdClass $post The post structure and all of its children
*/
protected static function export_post_data($userid, \context $context, $postarea, $post) {
// Store related metadata.
static::export_read_data($userid, $context, $postarea, $post);
$postdata = (object) [
'subject' => format_string($post->subject, true),
'created' => transform::datetime($post->created),
'modified' => transform::datetime($post->modified),
'author' => transform::user($post->userid),
];
$postdata->message = writer::with_context($context)
->rewrite_pluginfile_urls($postarea, 'mod_forum', 'post', $post->id, $post->message);
$postdata->message = format_text($postdata->message, $post->messageformat, (object) [
'para' => false,
'trusted' => $post->messagetrust,
'context' => $context,
]);
writer::with_context($context)
// Store the post.
->export_data($postarea, $postdata)
// Store the associated files.
->export_area_files($postarea, 'mod_forum', 'post', $post->id);
if ($post->userid == $userid) {
// Store all ratings against this post as the post belongs to the user. All ratings on it are ratings of their content.
\core_rating\privacy\provider::export_area_ratings($userid, $context, $postarea, 'mod_forum', 'post', $post->id, false);
// Store all tags against this post as the tag belongs to the user.
\core_tag\privacy\provider::export_item_tags($userid, $context, $postarea, 'mod_forum', 'forum_posts', $post->id);
// Export all user data stored for this post from the plagiarism API.
$coursecontext = $context->get_course_context();
\core_plagiarism\privacy\provider::export_plagiarism_user_data($userid, $context, $postarea, [
'cmid' => $context->instanceid,
'course' => $coursecontext->instanceid,
'forum' => $post->forumid,
'discussionid' => $post->discussion,
'postid' => $post->id,
]);
}
// Check for any ratings that the user has made on this post.
\core_rating\privacy\provider::export_area_ratings($userid,
$context,
$postarea,
'mod_forum',
'post',
$post->id,
$userid,
true
);
}
/**
* Store data about daily digest preferences
*
* @param int $userid The userid of the user whose data is to be exported.
* @param \stdClass $forum The forum whose data is being exported.
* @return bool Whether any data was stored.
*/
protected static function export_digest_data($userid, \stdClass $forum) {
if (null !== $forum->maildigest) {
// The user has a specific maildigest preference for this forum.
$a = (object) [
'forum' => format_string($forum->name, true),
];
switch ($forum->maildigest) {
case 0:
$a->type = get_string('emaildigestoffshort', 'mod_forum');
break;
case 1:
$a->type = get_string('emaildigestcompleteshort', 'mod_forum');
break;
case 2:
$a->type = get_string('emaildigestsubjectsshort', 'mod_forum');
break;
}
writer::with_context(\context_module::instance($forum->cmid))
->export_metadata([], 'digestpreference', $forum->maildigest,
get_string('privacy:digesttypepreference', 'mod_forum', $a));
return true;
}
return false;
}
/**
* Store data about whether the user subscribes to forum.
*
* @param int $userid The userid of the user whose data is to be exported.
* @param \stdClass $forum The forum whose data is being exported.
* @return bool Whether any data was stored.
*/
protected static function export_subscription_data($userid, \stdClass $forum) {
if (null !== $forum->subscribed) {
// The user is subscribed to this forum.
writer::with_context(\context_module::instance($forum->cmid))
->export_metadata([], 'subscriptionpreference', 1, get_string('privacy:subscribedtoforum', 'mod_forum'));
return true;
}
return false;
}
/**
* Store data about whether the user subscribes to this particular discussion.
*
* @param int $userid The userid of the user whose data is to be exported.
* @param \context_module $context The instance of the forum context.
* @param \stdClass $discussion The discussion whose data is being exported.
* @return bool Whether any data was stored.
*/
protected static function export_discussion_subscription_data($userid, \context_module $context, \stdClass $discussion) {
$area = static::get_discussion_area($discussion);
if (null !== $discussion->preference) {
// The user has a specific subscription preference for this discussion.
$a = (object) [];
switch ($discussion->preference) {
case \mod_forum\subscriptions::FORUM_DISCUSSION_UNSUBSCRIBED:
$a->preference = get_string('unsubscribed', 'mod_forum');
break;
default:
$a->preference = get_string('subscribed', 'mod_forum');
break;
}
writer::with_context($context)
->export_metadata(
$area,
'subscriptionpreference',
$discussion->preference,
get_string('privacy:discussionsubscriptionpreference', 'mod_forum', $a)
);
return true;
}
return true;
}
/**
* Store forum read-tracking data about a particular forum.
*
* This is whether a forum has read-tracking enabled or not.
*
* @param int $userid The userid of the user whose data is to be exported.
* @param \stdClass $forum The forum whose data is being exported.
* @return bool Whether any data was stored.
*/
protected static function export_tracking_data($userid, \stdClass $forum) {
if (null !== $forum->tracked) {
// The user has a main preference to track all forums, but has opted out of this one.
writer::with_context(\context_module::instance($forum->cmid))
->export_metadata([], 'trackreadpreference', 0, get_string('privacy:readtrackingdisabled', 'mod_forum'));
return true;
}
return false;
}
/**
* Store read-tracking information about a particular forum post.
*
* @param int $userid The userid of the user whose data is to be exported.
* @param \context_module $context The instance of the forum context.
* @param array $postarea The subcontext for this post.
* @param \stdClass $post The post whose data is being exported.
* @return bool Whether any data was stored.
*/
protected static function export_read_data($userid, \context_module $context, array $postarea, \stdClass $post) {
if (null !== $post->firstread) {
$a = (object) [
'firstread' => $post->firstread,
'lastread' => $post->lastread,
];
writer::with_context($context)
->export_metadata(
$postarea,
'postread',
(object) [
'firstread' => $post->firstread,
'lastread' => $post->lastread,
],
get_string('privacy:postwasread', 'mod_forum', $a)
);
return true;
}
return false;
}
/**
* Delete all data for all users in the specified context.
*
* @param context $context The specific context to delete data for.
*/
public static function delete_data_for_all_users_in_context(\context $context) {
global $DB;
// Check that this is a context_module.
if (!$context instanceof \context_module) {
return;
}
// Get the course module.
$cm = $DB->get_record('course_modules', ['id' => $context->instanceid]);
$forum = $DB->get_record('forum', ['id' => $cm->instance]);
$DB->delete_records('forum_track_prefs', ['forumid' => $forum->id]);
$DB->delete_records('forum_subscriptions', ['forum' => $forum->id]);
$DB->delete_records('forum_read', ['forumid' => $forum->id]);
// Delete all discussion items.
$DB->delete_records_select(
'forum_queue',
"discussionid IN (SELECT id FROM {forum_discussions} WHERE forum = :forum)",
[
'forum' => $forum->id,
]
);
$DB->delete_records_select(
'forum_posts',
"discussion IN (SELECT id FROM {forum_discussions} WHERE forum = :forum)",
[
'forum' => $forum->id,
]
);
$DB->delete_records('forum_discussion_subs', ['forum' => $forum->id]);
$DB->delete_records('forum_discussions', ['forum' => $forum->id]);
// Delete all files from the posts.
$fs = get_file_storage();
$fs->delete_area_files($context->id, 'mod_forum', 'post');
// Delete all ratings in the context.
$rm = new \rating_manager();
$rm->delete_ratings((object) [
'contextid' => $context->id,
]);
// Delete all Tags.
\core_tag_tag::delete_instances('mod_forum', 'post', $context->id);
}
/**
* Delete all user data for the specified user, in the specified contexts.
*
* @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
*/
public static function delete_data_for_user(approved_contextlist $contextlist) {
global $DB;
foreach ($contextlist as $context) {
// Get the course module.
$cm = $DB->get_record('course_modules', ['id' => $context->instanceid]);
$forum = $DB->get_record('forum', ['id' => $cm->instance]);
$DB->delete_records('forum_track_prefs', [
'forumid' => $forum->id,
'userid' => $userid,
]);
$DB->delete_records('forum_subscriptions', [
'forum' => $forum->id,
'userid' => $userid,
]);
$DB->delete_records('forum_read', [
'forumid' => $forum->id,
'userid' => $userid,
]);
// Delete all discussion items.
$DB->delete_records_select(
'forum_queue',
"userid AND discussionid IN (SELECT id FROM {forum_discussions} WHERE forum = :forum)",
[
'userid' => $userid,
'forum' => $forum->id,
]
);
$DB->delete_records('forum_discussion_subs', [
'forum' => $forum->id,
'userid' => $userid,
]);
$uniquediscussions = $DB->get_recordset('forum_discussions', [
'forum' => $forum->id,
'userid' => $userid,
]);
foreach ($uniquediscussions as $discussion) {
// Do not delete discussion or forum posts.
// Instead update them to reflect that the content has been deleted.
$postsql = "userid = :userid AND discussion IN (SELECT id FROM {forum_discussions} WHERE forum = :forum)";
$postparams = [
'forum' => $forum->id,
'userid' => $userid,
];
// Update the subject.
$DB->set_field_select('forum_posts', 'subject', '', $postsql, $postparams);
'subject',
get_string('privacy:request:delete:post:subject', 'mod_forum'),
$postsql,
$postparams);
// Update the subject and its format.
$DB->set_field_select('forum_posts', 'message', '', $postsql, $postparams);
'forum_posts',
'message',
get_string('privacy:request:delete:post:message', 'mod_forum'),
$postsql,
$postparams);
$DB->set_field_select('forum_posts', 'messageformat', FORMAT_PLAIN, $postsql, $postparams);
$discussion->name = get_string('privacy:request:delete:discussion:name', 'mod_forum', null, $lang);
$DB->update_record('forum_discussions', $discussion);
// Note: Do _not_ delete ratings.
// Ratings are aggregate fields and deleting the rating of this post will have an effect on the rating
// of any post.
// Delete all Tags.
\core_tag_tag::delete_instances('mod_forum', 'post', $context->id);
}
$uniquediscussions->close();
// Delete all files from the posts.
$fs = get_file_storage();
$fs->delete_area_files($context->id, 'mod_forum', 'post');
}
}
}
mod/forum/classes/privacy/subcontext_info.php
+123
View File
@@ -0,0 +1,123 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Privacy Subsystem implementation for mod_forum.
*
* @package mod_forum
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace mod_forum\privacy;
use \core_privacy\request\approved_contextlist;
use \core_privacy\request\writer;
use \core_privacy\metadata\item_collection;
defined('MOODLE_INTERNAL') || die();
/**
* Subcontext subcontext_info trait.
*
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
trait subcontext_info {
/**
* Get the discussion part of the subcontext.
*
* @param \stdClass $discussion The discussion
* @return array
*/
protected static function get_discussion_area(\stdClass $discussion) {
$pathparts = [];
if (!empty($discussion->groupname)) {
$pathparts[] = get_string('groups');
$pathparts[] = $discussion->groupname;
}
$parts = [
$discussion->id,
$discussion->name,
];
$discussionname = implode('-', $parts);
$pathparts[] = get_string('discussions', 'mod_forum');
$pathparts[] = $discussionname;
return $pathparts;
}
/**
* Get the post part of the subcontext.
*
* @param \stdClass $post The post.
* @return array
*/
protected static function get_post_area(\stdClass $post) {
$parts = [
$post->created,
$post->subject,
$post->id,
];
$area[] = implode('-', $parts);
return $area;
}
/**
* Get the parent subcontext for the supplied forum, discussion, and post combination.
*
* @param \stdClass $post The post.
* @return array
*/
protected static function get_post_area_for_parent(\stdClass $post) {
global $DB;
$subcontext = [];
if ($parent = $DB->get_record('forum_posts', ['id' => $post->parent], 'id, created, subject')) {
$subcontext = array_merge($subcontext, static::get_post_area($parent));
}
$subcontext = array_merge($subcontext, static::get_post_area($post));
return $subcontext;
}
/**
* Get the subcontext for the supplied forum, discussion, and post combination.
*
* @param \stdClass $forum The forum.
* @param \stdClass $discussion The discussion
* @param \stdClass $post The post.
* @return array
*/
protected static function get_subcontext($forum, $discussion = null, $post = null) {
$subcontext = [];
if (null !== $discussion) {
$subcontext += self::get_discussion_area($discussion);
if (null !== $post) {
$subcontext[] = get_string('posts', 'mod_forum');
$subcontext = array_merge($subcontext, static::get_post_area_for_parent($post));
}
}
return $subcontext;
}
}
mod/forum/lang/en/forum.php
+52
View File
@@ -225,6 +225,7 @@ $string['forum:allowforcesubscribe'] = 'Allow force subscribe';
$string['forum:canoverridediscussionlock'] = 'Reply to locked discussions';
$string['forumauthorhidden'] = 'Author (hidden)';
$string['forumblockingalmosttoomanyposts'] = 'You are approaching the posting threshold. You have posted {$a->numposts} times in the last {$a->blockperiod} and the limit is {$a->blockafter} posts.';
$string['forumbodydeleted'] = 'The content of this forum post has been removed and can no longer be accessed.';
$string['forumbodyhidden'] = 'This post cannot be viewed by you, probably because you have not posted in the discussion, the maximum editing time hasn\'t passed yet, the discussion has not started or the discussion has expired.';
$string['forum:canposttomygroups'] = 'Can post to all groups you have access to';
$string['forum:createattachment'] = 'Create attachments';
@@ -247,6 +248,7 @@ $string['forum:replypost'] = 'Reply to posts';
$string['forums'] = 'Forums';
$string['forum:splitdiscussions'] = 'Split discussions';
$string['forum:startdiscussion'] = 'Start new discussions';
$string['forumsubjectdeleted'] = 'This forum post has been removed';
$string['forumsubjecthidden'] = 'Subject (hidden)';
$string['forumtracked'] = 'Unread posts are being tracked';
$string['forumtrackednot'] = 'Unread posts are not being tracked';
@@ -424,6 +426,56 @@ $string['postsmadebyuserincourse'] = 'Posts made by {$a->fullname} in {$a->cours
$string['posttoforum'] = 'Post to forum';
$string['postupdated'] = 'Your post was updated';
$string['potentialsubscribers'] = 'Potential subscribers';
$string['privacy:digesttypenone'] = 'We do not hold any data relating to a preferred forum digest type for this forum.';
$string['privacy:digesttypepreference'] = 'You have chosen to receive the following forum digest type: "{$a->type}".';
$string['privacy:discussionsubscriptionpreference'] = 'You have chosen the following discussion subscription preference for this forum: "{$a->preference}"';
$string['privacy:metadata:core_tag'] = 'The forum makes use of the tag subsystem to support tagging of posts.';
$string['privacy:metadata:core_rating'] = 'The forum makes use of the rating subsystem to support the rating of posts.';
$string['privacy:metadata:forum_digests'] = 'Information about the digest preferences for each forum.';
$string['privacy:metadata:forum_digests:forum'] = 'The forum subscribed to.';
$string['privacy:metadata:forum_digests:maildigest'] = 'The digest preference.';
$string['privacy:metadata:forum_digests:userid'] = 'The ID of the user with the digest preference.';
$string['privacy:metadata:forum_discussion_subs'] = 'Information about the subscriptions to individual forum discussions.';
$string['privacy:metadata:forum_discussion_subs:discussionid'] = 'The ID of the discussion that was subscribed to.';
$string['privacy:metadata:forum_discussion_subs:preference'] = 'The start time of the subscription.';
$string['privacy:metadata:forum_discussion_subs:userid'] = 'The ID of the user with the discussion subscription.';
$string['privacy:metadata:forum_discussions'] = 'Information about the individual forum discussions that a user has created.';
$string['privacy:metadata:forum_discussions:assessed'] = 'TODOD - what does this field store';
$string['privacy:metadata:forum_discussions:name'] = 'The name of the discussion, as chosen by the author.';
$string['privacy:metadata:forum_discussions:timemodified'] = 'The time that the discussion was last modified.';
$string['privacy:metadata:forum_discussions:userid'] = 'The ID of the user who created the discussion';
$string['privacy:metadata:forum_discussions:usermodified'] = 'The ID of the user who last modified the discussion in some way.';
$string['privacy:metadata:forum_posts'] = 'Information about the digest preferences for each forum.';
$string['privacy:metadata:forum_posts:created'] = 'The time that the post was created.';
$string['privacy:metadata:forum_posts:discussion'] = 'The discussion that the post is in.';
$string['privacy:metadata:forum_posts:message'] = 'The message of the forum post.';
$string['privacy:metadata:forum_posts:modified'] = 'The time that the post was last modified.';
$string['privacy:metadata:forum_posts:parent'] = 'The parent post that was replied to.';
$string['privacy:metadata:forum_posts:subject'] = 'The subject of the forum post.';
$string['privacy:metadata:forum_posts:totalscore'] = 'The message of the forum post.';
$string['privacy:metadata:forum_posts:userid'] = 'The ID of the user who authored the forum post.';
$string['privacy:metadata:forum_read'] = 'Information about which posts have been read by the user.';
$string['privacy:metadata:forum_read:discussionid'] = 'The discussion that the post is in.';
$string['privacy:metadata:forum_read:firstread'] = 'The first time that the post was read.';
$string['privacy:metadata:forum_read:lastread'] = 'The most recent time that the post was read.';
$string['privacy:metadata:forum_read:postid'] = 'The post that was read.';
$string['privacy:metadata:forum_read:userid'] = 'The ID of the user that this record relates to.';
$string['privacy:metadata:forum_subscriptions'] = 'Information about which forums the user has subscribed to.';
$string['privacy:metadata:forum_subscriptions:forum'] = 'The forum that was subscribed to.';
$string['privacy:metadata:forum_subscriptions:userid'] = 'The ID of the user that this forum subscription relates to.';
$string['privacy:metadata:forum_track_prefs'] = 'Information about which forums the user has chosen to track post reads for.';
$string['privacy:metadata:forum_track_prefs:forumid'] = 'The forum that has read tracking enabled.';
$string['privacy:metadata:forum_track_prefs:userid'] = 'The ID of the user that this forum tracking preference relates to.';
$string['privacy:metadata:preference:autosubscribe'] = 'Whether to subscribe to discussions when replying to posts within them.';
$string['privacy:metadata:preference:maildigest'] = 'The site-wide mail digest preference.';
$string['privacy:metadata:preference:markasreadonnotification'] = 'Whether to mark forum posts as read when receiving them as messages.';
$string['privacy:metadata:preference:trackforums'] = 'Whether to enable read tracking.';
$string['privacy:postwasread'] = 'This post was first read on {$a->firstread} and most recently read on {$a->lastread}';
$string['privacy:readtrackingdisabled'] = 'You have chosen to not track which posts that you have read within this forum.';
$string['privacy:request:delete:discussion:name'] = 'Delete at the request of the author';
$string['privacy:request:delete:post:message'] = 'The content of this post has been deleted at the request of its author.';
$string['privacy:request:delete:post:subject'] = 'Delete at the request of the author';
$string['privacy:subscribedtoforum'] = 'You are subscribed to this forum.';
$string['processingdigest'] = 'Processing email digest for user {$a}';
$string['processingpost'] = 'Processing post {$a}';
$string['prune'] = 'Split';
mod/forum/tests/helper.php
+166
View File
@@ -0,0 +1,166 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Helper functions used by several tests.
*
* @package mod_forum
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
global $CFG;
/**
* Helper functions used by several tests.
*
* @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
trait helper {
/**
* Helper to create the required number of users in the specified
* course.
* Users are enrolled as students.
*
* @param stdClass $course The course object
* @param integer $count The number of users to create
* @return array The users created
*/
protected function helper_create_users($course, $count) {
$users = array();
for ($i = 0; $i < $count; $i++) {
$user = $this->getDataGenerator()->create_user();
$this->getDataGenerator()->enrol_user($user->id, $course->id);
$users[] = $user;
}
return $users;
}
/**
* Create a new discussion and post within the specified forum, as the
* specified author.
*
* @param stdClass $forum The forum to post in
* @param stdClass $author The author to post as
* @return array An array containing the discussion object, and the post object
*/
protected function helper_post_to_forum($forum, $author) {
global $DB;
$generator = $this->getDataGenerator()->get_plugin_generator('mod_forum');
// Create a discussion in the forum, and then add a post to that discussion.
$record = new stdClass();
$record->course = $forum->course;
$record->userid = $author->id;
$record->forum = $forum->id;
$discussion = $generator->create_discussion($record);
// Retrieve the post which was created by create_discussion.
$post = $DB->get_record('forum_posts', array('discussion' => $discussion->id));
return array($discussion, $post);
}
/**
* Update the post time for the specified post by $factor.
*
* @param stdClass $post The post to update
* @param int $factor The amount to update by
*/
protected function helper_update_post_time($post, $factor) {
global $DB;
// Update the post to have a created in the past.
$DB->set_field('forum_posts', 'created', $post->created + $factor, array('id' => $post->id));
}
/**
* Update the subscription time for the specified user/discussion by $factor.
*
* @param stdClass $user The user to update
* @param stdClass $discussion The discussion to update for this user
* @param int $factor The amount to update by
*/
protected function helper_update_subscription_time($user, $discussion, $factor) {
global $DB;
$sub = $DB->get_record('forum_discussion_subs', array('userid' => $user->id, 'discussion' => $discussion->id));
// Update the subscription to have a preference in the past.
$DB->set_field('forum_discussion_subs', 'preference', $sub->preference + $factor, array('id' => $sub->id));
}
/**
* Create a new post within an existing discussion, as the specified author.
*
* @param stdClass $forum The forum to post in
* @param stdClass $discussion The discussion to post in
* @param stdClass $author The author to post as
* @return stdClass The forum post
*/
protected function helper_post_to_discussion($forum, $discussion, $author) {
global $DB;
$generator = $this->getDataGenerator()->get_plugin_generator('mod_forum');
// Add a post to the discussion.
$record = new stdClass();
$record->course = $forum->course;
$strre = get_string('re', 'forum');
$record->subject = $strre . ' ' . $discussion->subject;
$record->userid = $author->id;
$record->forum = $forum->id;
$record->discussion = $discussion->id;
$record->mailnow = 1;
$post = $generator->create_post($record);
return $post;
}
/**
* Create a new post within an existing discussion, as the specified author.
*
* @param stdClass $parent The post being replied to
* @param stdClass $author The author to post as
* @return stdClass The forum post
*/
protected function helper_reply_to_post($parent, $author) {
global $DB;
$generator = $this->getDataGenerator()->get_plugin_generator('mod_forum');
// Add a post to the discussion.
$strre = get_string('re', 'forum');
$record = (object) [
'discussion' => $parent->discussion,
'parent' => $parent->id,
'userid' => $author->id,
'mailnow' => 1,
'subject' => $strre . ' ' . $parent->subject,
];
$post = $generator->create_post($record);
return $post;
}
}
mod/forum/tests/privacy_provider_test.php
+1031
View File
File diff suppressed because it is too large Load Diff
tag/classes/tests/privacy_helper.php
+1 -4
View File
@@ -75,10 +75,7 @@ trait privacy_helper {
$this->assertCount(count($dbtags), $exportedtags);
foreach ($dbtags as $tag) {
$this->assertTrue(isset($exportedtags[$tag->id]));
$this->assertEquals($exportedtags[$tag->id]->name, $tag->name);
$this->assertEquals($exportedtags[$tag->id]->rawname, $tag->rawname);
$this->assertEquals($exportedtags[$tag->id]->flag, $tag->flag);
$this->assertContains($tag->rawname, $exportedtags);
}
}
}