From fcedf5a69bd02835a531310a7330189b3a769e27 Mon Sep 17 00:00:00 2001 From: Adrian Greeve Date: Mon, 12 Mar 2018 16:10:38 +0800 Subject: [PATCH] MDL-61629 message_airnotifier: Add privacy files and unit tests. --- .../airnotifier/classes/privacy/provider.php | 165 ++++++++++++++++++ .../lang/en/message_airnotifier.php | 17 ++ .../output/airnotifier/tests/privacy_test.php | 163 +++++++++++++++++ 3 files changed, 345 insertions(+) create mode 100644 message/output/airnotifier/classes/privacy/provider.php create mode 100644 message/output/airnotifier/tests/privacy_test.php diff --git a/message/output/airnotifier/classes/privacy/provider.php b/message/output/airnotifier/classes/privacy/provider.php new file mode 100644 index 00000000000..a20ae1e0a4f --- /dev/null +++ b/message/output/airnotifier/classes/privacy/provider.php @@ -0,0 +1,165 @@ +. + +/** + * Privacy class for requesting user data. + * + * @package message_airnotifier + * @copyright 2018 Adrian Greeve + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +namespace message_airnotifier\privacy; + +defined('MOODLE_INTERNAL') || die(); + +use \core_privacy\local\metadata\collection; +use \core_privacy\local\request\contextlist; +use \core_privacy\local\request\approved_contextlist; +use \core_privacy\local\request\transform; + +/** + * Privacy class for requesting user data. + * + * @package message_airnotifier + * @copyright 2018 Adrian Greeve + * @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 { + + /** + * 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->link_subsystem('core_user', 'privacy:metadata:usersubsystem'); + $collection->add_database_table('message_airnotifier_devices', [ + 'userdeviceid' => 'privacy:metadata:userdeviceid', + 'enabled' => 'privacy:metadata:enabled' + ], 'privacy:metadata:tableexplanation'); + $collection->link_external_location('External airnotifier site.', [ + 'userid' => 'privacy:metadata:userid', + 'username' => 'privacy:metadata:username', + 'userfromid' => 'privacy:metadata:userfromid', + 'userfromfullname' => 'privacy:metadata:userfromfullname', + 'date' => 'privacy:metadata:date', + 'subject' => 'privacy:metadata:subject', + 'notification' => 'privacy:metadata:notification', + 'smallmessage' => 'privacy:metadata:smallmessage', + 'fullmessage' => 'privacy:metadata:fullmessage' + ], 'privacy:metadata:externalpurpose'); + // This system is unaware of user preferences such as message_provider_moodle_instantmessage_loggedin. + 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) { + $sql = "SELECT ctx.id + FROM {message_airnotifier_devices} mad + JOIN {user_devices} ud ON ud.id = mad.userdeviceid + JOIN {user} u ON ud.userid = u.id + JOIN {context} ctx ON ctx.instanceid = u.id AND ctx.contextlevel = :contextlevel + WHERE ud.userid = :userid"; + + $params = ['userid' => $userid, 'contextlevel' => CONTEXT_USER]; + + $contextlist = new contextlist(); + $contextlist->add_from_sql($sql, $params); + return $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) { + $results = static::get_records($contextlist->get_user()->id); + $context = $contextlist->current(); + foreach ($results as $result) { + $data = (object)[ + 'appid' => $result->appid, + 'pushid' => $result->pushid, + 'name' => $result->name, + 'model' => $result->model, + 'platform' => $result->platform, + 'version' => $result->version, + 'timecreated' => transform::datetime($result->timecreated), + 'timemodified' => transform::datetime($result->timemodified), + 'enabled' => transform::yesno($result->enable) + ]; + \core_privacy\local\request\writer::with_context($context)->export_data([ + get_string('privacy:subcontext', 'message_airnotifier'), + $result->model . '_' . $result->pushid + ], $data); + } + } + + /** + * Delete all use data which matches the specified deletion_criteria. + * + * @param context $context A user context. + */ + public static function delete_data_for_all_users_in_context(\context $context) { + static::delete_data($context->instanceid); + } + + /** + * 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) { + static::delete_data($contextlist->get_user()->id); + } + + /** + * Delete data related to a userid. + * + * @param int $userid The user ID + */ + protected static function delete_data($userid) { + global $DB; + + foreach (static::get_records($userid) as $record) { + $DB->delete_records('message_airnotifier_devices', ['id' => $record->id]); + } + } + + /** + * Get records related to this plugin and user. + * + * @param int $userid The user ID + * @return array An array of records. + */ + protected static function get_records($userid) { + global $DB; + $sql = "SELECT mad.id, mad.enable, ud.appid, ud.name, ud.model, ud.platform, ud.version, ud.timecreated, ud.timemodified, + ud.pushid + FROM {message_airnotifier_devices} mad + JOIN {user_devices} ud ON mad.userdeviceid = ud.id + WHERE ud.userid = :userid"; + $params = ['userid' => $userid]; + return $DB->get_records_sql($sql, $params); + } +} diff --git a/message/output/airnotifier/lang/en/message_airnotifier.php b/message/output/airnotifier/lang/en/message_airnotifier.php index d900e439519..666fcda4c3c 100644 --- a/message/output/airnotifier/lang/en/message_airnotifier.php +++ b/message/output/airnotifier/lang/en/message_airnotifier.php @@ -41,6 +41,23 @@ $string['nodevices'] = 'No registered devices. Devices will automatically appear $string['nopermissiontomanagedevices'] = 'You don\'t have permission to manage devices.'; $string['notconfigured'] = 'The Airnotifier server hasn\'t been configured so Airnotifier messages cannot be sent'; $string['pluginname'] = 'Mobile'; +$string['privacy:appiddescription'] = 'This is an identifier to the application being used.'; +$string['privacy:enableddescription'] = 'If this device is enabled for airnotifier.'; +$string['privacy:metadata:enabled'] = 'If the airnotifier device is enabled.'; +$string['privacy:metadata:date'] = 'The date that the message was sent.'; +$string['privacy:metadata:externalpurpose'] = 'This information is sent to an external site to be ultimately delivered to the mobile device of the user.'; +$string['privacy:metadata:fullmessage'] = 'The full message.'; +$string['privacy:metadata:notification'] = 'If this message is a notification.'; +$string['privacy:metadata:smallmessage'] = 'An section of the message.'; +$string['privacy:metadata:subject'] = 'The subject line of the message.'; +$string['privacy:metadata:tableexplanation'] = 'Airnotifier device information is stored here.'; +$string['privacy:metadata:userdeviceid'] = 'The ID linking to the user\'s mobile device'; +$string['privacy:metadata:userfromfullname'] = 'The full name of the user that sent the message.'; +$string['privacy:metadata:userfromid'] = 'The user ID of the author of the message.'; +$string['privacy:metadata:userid'] = 'The user ID.'; +$string['privacy:metadata:username'] = 'The username for the user.'; +$string['privacy:metadata:usersubsystem'] = 'This plugin is connected to the user subsystem.'; +$string['privacy:subcontext'] = 'Message Airnotifier'; $string['sitemustberegistered'] = 'In order to use the public Airnotifier instance you must register your site with Moodle.net'; $string['showhide'] = 'Enable/disable the device.'; $string['requestaccesskey'] = 'Request access key'; diff --git a/message/output/airnotifier/tests/privacy_test.php b/message/output/airnotifier/tests/privacy_test.php new file mode 100644 index 00000000000..7559b43458f --- /dev/null +++ b/message/output/airnotifier/tests/privacy_test.php @@ -0,0 +1,163 @@ +. +/** + * Base class for unit tests for message_airnotifier. + * + * @package message_airnotifier + * @copyright 2018 Adrian Greeve + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +defined('MOODLE_INTERNAL') || die(); + +use \core_privacy\tests\provider_testcase; +/** + * Unit tests for message\output\airnotifier\classes\privacy\provider.php + * + * @copyright 2018 Adrian Greeve + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class message_airnotifier_testcase extends provider_testcase { + + /** + * Basic setup for these tests. + */ + public function setUp() { + $this->resetAfterTest(true); + } + + /** + * / + * @param object $user User object + * @param string $pushid unique string + */ + protected function add_device($user, $pushid) { + global $DB; + + // Add fake core device. + $device = array( + 'appid' => 'com.moodle.moodlemobile', + 'name' => 'occam', + 'model' => 'Nexus 4', + 'platform' => 'Android', + 'version' => '4.2.2', + 'pushid' => $pushid, + 'uuid' => 'asdnfl348qlksfaasef859', + 'userid' => $user->id, + 'timecreated' => time(), + 'timemodified' => time(), + ); + $coredeviceid = $DB->insert_record('user_devices', (object) $device); + + $airnotifierdev = array( + 'userdeviceid' => $coredeviceid, + 'enable' => 1 + ); + $airnotifierdevid = $DB->insert_record('message_airnotifier_devices', (object) $airnotifierdev); + } + + /** + * Test returning metadata. + */ + public function test_get_metadata() { + $collection = new \core_privacy\local\metadata\collection('message_airnotifier'); + $collection = \message_airnotifier\privacy\provider::get_metadata($collection); + $this->assertNotEmpty($collection); + } + + /** + * Test getting the context for the user ID related to this plugin. + */ + public function test_get_contexts_for_userid() { + + $user = $this->getDataGenerator()->create_user(); + $context = context_user::instance($user->id); + + $this->add_device($user, 'apuJih874kj'); + $this->add_device($user, 'bdu09Ikjjsu'); + + $contextlist = \message_airnotifier\privacy\provider::get_contexts_for_userid($user->id); + $this->assertEquals($context->id, $contextlist->current()->id); + } + + /** + * Test that data is exported correctly for this plugin. + */ + public function test_export_user_data() { + $user = $this->getDataGenerator()->create_user(); + $context = context_user::instance($user->id); + + $this->add_device($user, 'apuJih874kj'); + $this->add_device($user, 'bdu09Ikjjsu'); + + $writer = \core_privacy\local\request\writer::with_context($context); + $this->assertFalse($writer->has_any_data()); + $this->export_context_data_for_user($user->id, $context, 'message_airnotifier'); + + // First device. + $data = $writer->get_data([get_string('privacy:subcontext', 'message_airnotifier'), 'Nexus 4_apuJih874kj']); + $this->assertEquals('com.moodle.moodlemobile', $data->appid); + + // Second device. + $data = $writer->get_data([get_string('privacy:subcontext', 'message_airnotifier'), 'Nexus 4_bdu09Ikjjsu']); + $this->assertEquals('bdu09Ikjjsu', $data->pushid); + } + + /** + * Test that user data is deleted using the context. + */ + public function test_delete_data_for_all_users_in_context() { + global $DB; + + $user = $this->getDataGenerator()->create_user(); + $context = context_user::instance($user->id); + + $this->add_device($user, 'apuJih874kj'); + + // Check that we have an entry. + $devices = $DB->get_records('message_airnotifier_devices'); + $this->assertCount(1, $devices); + + \message_airnotifier\privacy\provider::delete_data_for_all_users_in_context($context); + + // Check that it has now been deleted. + $devices = $DB->get_records('message_airnotifier_devices'); + $this->assertCount(0, $devices); + } + + /** + * Test that user data is deleted for this user. + */ + public function test_delete_data_for_user() { + global $DB; + + $user = $this->getDataGenerator()->create_user(); + $context = context_user::instance($user->id); + + $this->add_device($user, 'apuJih874kj'); + + // Check that we have an entry. + $devices = $DB->get_records('message_airnotifier_devices'); + $this->assertCount(1, $devices); + + $approvedlist = new \core_privacy\local\request\approved_contextlist($user, 'message_airnotifier', [$context->id]); + \message_airnotifier\privacy\provider::delete_data_for_user($approvedlist); + + // Check that it has now been deleted. + $devices = $DB->get_records('message_airnotifier_devices'); + $this->assertCount(0, $devices); + } +}