mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-61309 mod_forum: Implement the Privacy API
- Loading branch information
1 parent
2de389a
commit caef648
Showing
7 changed files
with
2,265 additions
and
46 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 helper 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) : Array { | ||
| $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) : Array { | ||
| $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; | ||
|
|
||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.