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-61307 core_rating: Add implementation of Privacy API
- Loading branch information
1 parent
e143bae
commit c0ca1a2
Showing
4 changed files
with
569 additions
and
1 deletion.
There are no files selected for viewing
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,135 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * Helpers for the core_rating subsystem implementation of privacy. | ||
| * | ||
| * @package core_rating | ||
| * @copyright 2018 Andrew Nicols <andrew@nicols.co.uk> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace core_rating\phpunit; | ||
|
|
||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| use \core_privacy\tests\request\content_writer; | ||
|
|
||
| global $CFG; | ||
|
|
||
| /** | ||
| * Helpers for the core_rating subsystem implementation of privacy. | ||
| * | ||
| * @copyright 2018 Andrew Nicols <andrew@nicols.co.uk> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| trait privacy_helper { | ||
| /** | ||
| * Fetch all ratings on a subcontext. | ||
| * | ||
| * @param \context $context The context being stored. | ||
| * @param array $subcontext The subcontext path to check. | ||
| * @return array | ||
| */ | ||
| protected function get_ratings_on_subcontext(\context $context, array $subcontext) { | ||
| $writer = \core_privacy\local\request\writer::with_context($context); | ||
| return $writer->get_related_data($subcontext, 'rating'); | ||
| } | ||
|
|
||
| /** | ||
| * Check that all included ratings belong to the specified user. | ||
| * | ||
| * @param int $userid The ID of the user being stored. | ||
| * @param \context $context The context being stored. | ||
| * @param array $subcontext The subcontext path to check. | ||
| * @param string $component The component being stored. | ||
| * @param string $ratingarea The rating area to store results for. | ||
| * @param int $itemid The itemid to store. | ||
| */ | ||
| protected function assert_all_own_ratings_on_context( | ||
| int $userid, | ||
| \context $context, | ||
| array $subcontext, | ||
| $component, | ||
| $ratingarea, | ||
| $itemid | ||
| ) { | ||
| $writer = \core_privacy\local\request\writer::with_context($context); | ||
| $rm = new \rating_manager(); | ||
| $dbratings = $rm->get_all_ratings_for_item((object) [ | ||
| 'context' => $context, | ||
| 'component' => $component, | ||
| 'ratingarea' => $ratingarea, | ||
| 'itemid' => $itemid, | ||
| ]); | ||
|
|
||
| $exportedratings = $this->get_ratings_on_subcontext($context, $subcontext); | ||
|
|
||
| foreach ($exportedratings as $ratingid => $rating) { | ||
| $this->assertTrue(isset($dbratings[$ratingid])); | ||
| $this->assertEquals($userid, $rating->author); | ||
| $this->assert_rating_matches($dbratings[$ratingid], $rating); | ||
| } | ||
|
|
||
| foreach ($dbratings as $rating) { | ||
| if ($rating->userid == $userid) { | ||
| $this->assertEquals($rating->id, $ratingid); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Check that all included ratings are valid. They may belong to any user. | ||
| * | ||
| * @param \context $context The context being stored. | ||
| * @param array $subcontext The subcontext path to check. | ||
| * @param string $component The component being stored. | ||
| * @param string $ratingarea The rating area to store results for. | ||
| * @param int $itemid The itemid to store. | ||
| */ | ||
| protected function assert_all_ratings_on_context(\context $context, array $subcontext, $component, $ratingarea, $itemid) { | ||
| $writer = \core_privacy\local\request\writer::with_context($context); | ||
| $rm = new \rating_manager(); | ||
| $dbratings = $rm->get_all_ratings_for_item((object) [ | ||
| 'context' => $context, | ||
| 'component' => $component, | ||
| 'ratingarea' => $ratingarea, | ||
| 'itemid' => $itemid, | ||
| ]); | ||
|
|
||
| $exportedratings = $this->get_ratings_on_subcontext($context, $subcontext); | ||
|
|
||
| foreach ($exportedratings as $ratingid => $rating) { | ||
| $this->assertTrue(isset($dbratings[$ratingid])); | ||
| $this->assert_rating_matches($dbratings[$ratingid], $rating); | ||
| } | ||
|
|
||
| foreach ($dbratings as $rating) { | ||
| $this->assertTrue(isset($exportedratings[$rating->id])); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Assert that the rating matches. | ||
| * | ||
| * @param \stdClass $expected The expected rating structure | ||
| * @param \stdClass $stored The actual rating structure | ||
| */ | ||
| protected function assert_rating_matches($expected, $stored) { | ||
| $this->assertEquals($expected->rating, $stored->rating); | ||
| $this->assertEquals($expected->userid, $stored->author); | ||
| } | ||
| } |
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,162 @@ | ||
| <?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 core_ratings. | ||
| * | ||
| * @package core_rating | ||
| * @copyright 2018 Andrew Nicols <andrew@nicols.co.uk> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| namespace core_rating\privacy; | ||
|
|
||
| use \core_privacy\local\metadata\collection; | ||
|
|
||
| defined('MOODLE_INTERNAL') || die(); | ||
|
|
||
| require_once($CFG->dirroot . '/rating/lib.php'); | ||
|
|
||
| /** | ||
| * Privacy Subsystem implementation for core_ratings. | ||
| * | ||
| * @copyright 2018 Andrew Nicols <andrew@nicols.co.uk> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class provider implements | ||
| // The ratings subsystem contains data. | ||
| \core_privacy\local\metadata\provider, | ||
|
|
||
| // The ratings subsystem is only ever used to store data for other components. | ||
| // It does not store any data of its own and does not need to implement the \core_privacy\local\request\subsystem\provider | ||
| // as a result. | ||
|
|
||
| // The ratings subsystem provides a data service to other components. | ||
| \core_privacy\local\request\subsystem\plugin_provider { | ||
|
|
||
| /** | ||
| * Returns metadata about the ratings subsystem. | ||
| * | ||
| * @param collection $collection The initialised collection to add items to. | ||
| * @return collection A listing of user data stored through the subsystem. | ||
| */ | ||
| public static function get_metadata(collection $collection) : collection { | ||
| // The table 'rating' cotains data that a user has entered. | ||
| // It stores the user-entered rating alongside a mapping to describe what was mapped. | ||
| $collection->add_database_table('rating', [ | ||
| 'rating' => 'privacy:metadata:rating:rating', | ||
| 'userid' => 'privacy:metadata:rating:userid', | ||
| 'timecreated' => 'privacy:metadata:rating:timecreated', | ||
| 'timemodified' => 'privacy:metadata:rating:timemodified', | ||
| ], 'privacy:metadata:rating'); | ||
|
|
||
| return $collection; | ||
| } | ||
|
|
||
| /** | ||
| * Export all ratings which match the specified component, areaid, and itemid. | ||
| * | ||
| * If requesting ratings for a users own content, and you wish to include all ratings of that content, specify | ||
| * $onlyuser as false. | ||
| * | ||
| * When requesting ratings for another users content, you should only export the ratings that the specified user | ||
| * made themselves. | ||
| * | ||
| * @param int $userid The user whose information is to be exported | ||
| * @param \context $context The context being stored. | ||
| * @param array $subcontext The subcontext within the context to export this information | ||
| * @param string $component The component to fetch data from | ||
| * @param string $ratingarea The ratingarea that the data was stored in within the component | ||
| * @param int $itemid The itemid within that ratingarea | ||
| * @param bool $onlyuser Whether to only export ratings that the current user has made, or all ratings | ||
| */ | ||
| public static function export_area_ratings( | ||
| int $userid, | ||
| \context $context, | ||
| array $subcontext, | ||
| string $component, | ||
| string $ratingarea, | ||
| int $itemid, | ||
| bool $onlyuser = true | ||
| ) { | ||
| global $DB; | ||
|
|
||
| $rm = new \rating_manager(); | ||
| $ratings = $rm->get_all_ratings_for_item((object) [ | ||
| 'context' => $context, | ||
| 'component' => $component, | ||
| 'ratingarea' => $ratingarea, | ||
| 'itemid' => $itemid, | ||
| ]); | ||
|
|
||
| if ($onlyuser) { | ||
| $ratings = array_filter($ratings, function($rating) use ($userid){ | ||
| return ($rating->userid == $userid); | ||
| }); | ||
| } | ||
|
|
||
| if (empty($ratings)) { | ||
| return; | ||
| } | ||
|
|
||
| $toexport = array_map(function($rating) { | ||
| return (object) [ | ||
| 'rating' => $rating->rating, | ||
| 'author' => $rating->userid, | ||
| ]; | ||
| }, $ratings); | ||
|
|
||
| $writer = \core_privacy\local\request\writer::with_context($context) | ||
| ->export_related_data($subcontext, 'rating', $toexport); | ||
| } | ||
|
|
||
| /** | ||
| * Get the SQL required to find all submission items where this user has had any involvements. | ||
| * | ||
| * @param string $alias The name of the table alias to use. | ||
| * @param string $component The na eof the component to fetch ratings for. | ||
| * @param string $ratingarea The rating area to fetch results for. | ||
| * @param string $itemidjoin The right-hand-side of the JOIN ON clause. | ||
| * @param int $userid The ID of the user being stored. | ||
| * @return \stdClass | ||
| */ | ||
| public static function get_sql_join($alias, $component, $ratingarea, $itemidjoin, $userid) { | ||
| static $count = 0; | ||
| $count++; | ||
|
|
||
| // Join the rating table with the specified alias and the relevant join params. | ||
| $join = "LEFT JOIN {rating} {$alias} ON "; | ||
| $join .= "{$alias}.component = :ratingcomponent{$count} AND "; | ||
| $join .= "{$alias}.ratingarea = :ratingarea{$count} AND "; | ||
| $join .= "{$alias}.itemid = {$itemidjoin}"; | ||
|
|
||
| // Match against the specified user. | ||
| $userwhere = "{$alias}.userid = :ratinguserid{$count}"; | ||
|
|
||
| $params = [ | ||
| 'ratingcomponent' . $count => $component, | ||
| 'ratingarea' . $count => $ratingarea, | ||
| 'ratinguserid' . $count => $userid, | ||
| ]; | ||
|
|
||
| $return = (object) [ | ||
| 'join' => $join, | ||
| 'params' => $params, | ||
| 'userwhere' => $userwhere, | ||
| ]; | ||
| return $return; | ||
| } | ||
| } |
Oops, something went wrong.