diff --git a/repository/wikimedia/classes/privacy/provider.php b/repository/wikimedia/classes/privacy/provider.php new file mode 100644 index 00000000000..3ad811e3e33 --- /dev/null +++ b/repository/wikimedia/classes/privacy/provider.php @@ -0,0 +1,135 @@ +. + +/** + * Privacy Subsystem implementation for repository_wikimedia. + * + * @package repository_wikimedia + * @copyright 2018 Zig Tan + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace repository_wikimedia\privacy; + +use core_privacy\local\metadata\collection; +use core_privacy\local\request\approved_contextlist; +use core_privacy\local\request\context; +use core_privacy\local\request\contextlist; +use core_privacy\local\request\writer; + +defined('MOODLE_INTERNAL') || die(); + +/** + * Privacy Subsystem for repository_wikimedia implementing metadata and plugin providers. + * + * @copyright 2018 Zig Tan + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class provider implements + \core_privacy\local\metadata\provider, + \core_privacy\local\request\plugin\provider, + \core_privacy\local\request\user_preference_provider +{ + + /** + * Returns meta data about this system. + * + * @param collection $collection The initialised collection to add items to. + * @return collection A listing of user data stored through this system. + */ + public static function get_metadata(collection $collection) { + $collection->add_external_location_link( + 'wikimedia.org', + [ + 'search_text' => 'privacy:metadata:repository_wikimedia:search_text' + ], + 'privacy:metadata:repository_wikimedia' + ); + + $collection->add_user_preference( + 'repository_wikimedia_maxwidth', + 'privacy:metadata:repository_wikimedia:preference:maxwidth' + ); + + $collection->add_user_preference( + 'repository_wikimedia_maxheight', + 'privacy:metadata:repository_wikimedia:preference:maxheight' + ); + + return $collection; + } + + /** + * Get the list of contexts that contain user information for the specified user. + * + * @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) { + return new contextlist(); + } + + /** + * 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) { + } + + /** + * 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) { + } + + /** + * 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) { + } + + /** + * Export 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) { + $maxwidth = get_user_preferences('repository_wikimedia_maxwidth', null, $userid); + if ($maxwidth !== null) { + writer::export_user_preference( + 'repository_wikimedia', + 'repository_wikimedia_maxwidth', + $maxwidth, + get_string('privacy:metadata:repository_wikimedia:preference:maxwidth', 'repository_wikimedia') + ); + } + + $maxheight = get_user_preferences('repository_wikimedia_maxheight', null, $userid); + if ($maxheight !== null) { + writer::export_user_preference( + 'repository_wikimedia', + 'repository_wikimedia_maxheight', + $maxheight, + get_string('privacy:metadata:repository_wikimedia:preference:maxheight', 'repository_wikimedia') + ); + } + } +} diff --git a/repository/wikimedia/lang/en/repository_wikimedia.php b/repository/wikimedia/lang/en/repository_wikimedia.php index 31146839c6f..9d54711fa98 100644 --- a/repository/wikimedia/lang/en/repository_wikimedia.php +++ b/repository/wikimedia/lang/en/repository_wikimedia.php @@ -29,3 +29,7 @@ $string['wikimedia:view'] = 'View wikimedia repository'; $string['configplugin'] = 'Wikimedia repository type configuration'; $string['maxwidth'] = 'Max image width (px)'; $string['maxheight'] = 'Max image height (px)'; +$string['privacy:metadata:repository_wikimedia'] = 'The Wikimedia repository plugin does store user preferences, and transmits user data from Moodle to the remote system.'; +$string['privacy:metadata:repository_wikimedia:search_text'] = 'The Wikimedia repository user search text query.'; +$string['privacy:metadata:repository_wikimedia:preference:maxwidth'] = 'The user preference Max Width configured for the Wikimedia repository.'; +$string['privacy:metadata:repository_wikimedia:preference:maxheight'] = 'The user preference Max Height configured for the Wikimedia repository.';