From 3a3abbbbd80dd09e62ae80039d502610c1479a18 Mon Sep 17 00:00:00 2001 From: Jake Dallimore Date: Fri, 13 Apr 2018 11:49:35 +0800 Subject: [PATCH] MDL-61663 portfolio_googledocs: add privacy provider implementation --- .../googledocs/classes/privacy/provider.php | 79 +++++++++++++++++++ .../lang/en/portfolio_googledocs.php | 2 + .../tests/privacy_provider_test.php | 46 +++++++++++ 3 files changed, 127 insertions(+) create mode 100644 portfolio/googledocs/classes/privacy/provider.php create mode 100644 portfolio/googledocs/tests/privacy_provider_test.php diff --git a/portfolio/googledocs/classes/privacy/provider.php b/portfolio/googledocs/classes/privacy/provider.php new file mode 100644 index 00000000000..a28de087cca --- /dev/null +++ b/portfolio/googledocs/classes/privacy/provider.php @@ -0,0 +1,79 @@ +. + +/** + * Privacy class for requesting user data. + * + * @package portfolio_googledocs + * @copyright 2018 Jake Dallimore + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +namespace portfolio_googledocs\privacy; + +defined('MOODLE_INTERNAL') || die(); + +use core_privacy\local\metadata\collection; + +/** + * Provider for the portfolio_googledocs plugin. + * + * @copyright 2018 Jake Dallimore + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class provider implements + // This portfolio plugin does not store any data itself. + // It has no database tables, and it purely acts as a conduit, sending data externally. + \core_portfolio\privacy\portfolio_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) { + return $collection->add_external_location_link('Google Docs account', ['data' => 'privacy:metadata:data'], + 'privacy:metadata'); + } + + /** + * Export all portfolio data from each portfolio plugin for the specified userid and context. + * + * @param int $userid The user to export. + * @param \context $context The context to export. + * @param array $subcontext The subcontext within the context to export this information to. + * @param array $linkarray The weird and wonderful link array used to display information for a specific item + */ + public static function export_portfolio_user_data($userid, \context $context, array $subcontext, array $linkarray) { + } + + /** + * Delete all user information for the provided context. + * + * @param \context $context The context to delete user data for. + */ + public static function delete_portfolio_for_context(\context $context) { + } + + /** + * Delete all user information for the provided user and context. + * + * @param int $userid The user to delete + * @param \context $context The context to refine the deletion. + */ + public static function delete_portfolio_for_user($userid, \context $context) { + } +} diff --git a/portfolio/googledocs/lang/en/portfolio_googledocs.php b/portfolio/googledocs/lang/en/portfolio_googledocs.php index d5798cf715b..27183702fc9 100644 --- a/portfolio/googledocs/lang/en/portfolio_googledocs.php +++ b/portfolio/googledocs/lang/en/portfolio_googledocs.php @@ -29,5 +29,7 @@ $string['nooauthcredentials_help'] = 'To use the Google Drive portfolio plugin y $string['nosessiontoken'] = 'A session token does not exist preventing export to google.'; $string['oauthinfo'] = '

To use this plugin, you must register your site with Google, as described in the documentation Google OAuth 2.0 setup.

As part of the registration process, you will need to enter the following URL as \'Authorized Redirect URIs\':

{$a->callbackurl}

Once registered, you will be provided with a client ID and secret which can be used to configure all Google Drive and Picasa plugins.

'; $string['pluginname'] = 'Google Drive'; +$string['privacy:metadata'] = 'This plugin sends data externally to a linked Google account. It does not store data locally.'; +$string['privacy:metadata:data'] = 'Personal data passed through from the portfolio subsystem.'; $string['sendfailed'] = 'The file {$a} failed to transfer to google'; $string['secret'] = 'Secret'; diff --git a/portfolio/googledocs/tests/privacy_provider_test.php b/portfolio/googledocs/tests/privacy_provider_test.php new file mode 100644 index 00000000000..c57ec97c7cf --- /dev/null +++ b/portfolio/googledocs/tests/privacy_provider_test.php @@ -0,0 +1,46 @@ +. + +/** + * Privacy provider tests. + * + * @package portfolio_googledocs + * @copyright 2018 Jake Dallimore + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +defined('MOODLE_INTERNAL') || die(); + +/** + * Privacy provider tests class. + * + * @copyright 2018 Jake Dallimore + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class portfolio_googledocs_privacy_provider_test extends \core_privacy\tests\provider_testcase { + + /** + * Verify that a collection of metadata is returned for this component and that it just links to an external location. + */ + public function test_get_metadata() { + $collection = new \core_privacy\local\metadata\collection('portfolio_googledocs'); + $collection = \portfolio_googledocs\privacy\provider::get_metadata($collection); + $this->assertNotEmpty($collection); + $items = $collection->get_collection(); + $this->assertEquals(1, count($items)); + $this->assertInstanceOf(\core_privacy\local\metadata\types\external_location::class, $items[0]); + } +}