MDL-61663 portfolio_boxnet: add privacy provider implementation
authorJake Dallimore <jake@moodle.com>
Fri, 13 Apr 2018 02:37:56 +0000 (10:37 +0800)
committerJake Dallimore <jake@moodle.com>
Fri, 13 Apr 2018 06:47:42 +0000 (14:47 +0800)
portfolio/boxnet/classes/privacy/provider.php [new file with mode: 0644]
portfolio/boxnet/lang/en/portfolio_boxnet.php
portfolio/boxnet/tests/privacy_provider_test.php [new file with mode: 0644]

diff --git a/portfolio/boxnet/classes/privacy/provider.php b/portfolio/boxnet/classes/privacy/provider.php
new file mode 100644 (file)
index 0000000..c83fe4a
--- /dev/null
@@ -0,0 +1,79 @@
+<?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 class for requesting user data.
+ *
+ * @package    portfolio_boxnet
+ * @copyright  2018 Jake Dallimore <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace portfolio_boxnet\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_privacy\local\metadata\collection;
+
+/**
+ * Provider for the portfolio_boxnet plugin.
+ *
+ * @copyright  2018 Jake Dallimore <jrhdallimore@gmail.com>
+ * @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) : collection {
+        return $collection->add_external_location_link('Box cloud storage', ['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(int $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(int $userid, \context $context) {
+    }
+}
index 8933cb3..93fae84 100644 (file)
@@ -39,6 +39,8 @@ $string['notarget'] = 'You must specify either an existing folder or a new folde
 $string['noticket'] = 'Could not retrieve a ticket from Box to begin the authentication session';
 $string['password'] = 'Your Box password (will not be stored)';
 $string['pluginname'] = 'Box';
 $string['noticket'] = 'Could not retrieve a ticket from Box to begin the authentication session';
 $string['password'] = 'Your Box password (will not be stored)';
 $string['pluginname'] = 'Box';
+$string['privacy:metadata'] = 'This plugin sends data externally to a linked Box account. It does not store data locally.';
+$string['privacy:metadata:data'] = 'Personal data passed through from the portfolio subsystem.';
 $string['sendfailed'] = 'Failed to send content to Box: {$a}';
 $string['setupinfo'] = 'Setup instructions';
 $string['setupinfodetails'] = 'To obtain a client ID and secret, log in to Box and visit the <a href="{$a->servicesurl}">Box developers page</a>. Follow \'Create new application\' and create a new application for your Moodle site. The client ID and secret are displayed in the \'OAuth2 parameters\' section of the application edit form. Optionally, you can also provide other information about your Moodle site.';
 $string['sendfailed'] = 'Failed to send content to Box: {$a}';
 $string['setupinfo'] = 'Setup instructions';
 $string['setupinfodetails'] = 'To obtain a client ID and secret, log in to Box and visit the <a href="{$a->servicesurl}">Box developers page</a>. Follow \'Create new application\' and create a new application for your Moodle site. The client ID and secret are displayed in the \'OAuth2 parameters\' section of the application edit form. Optionally, you can also provide other information about your Moodle site.';
diff --git a/portfolio/boxnet/tests/privacy_provider_test.php b/portfolio/boxnet/tests/privacy_provider_test.php
new file mode 100644 (file)
index 0000000..efbd354
--- /dev/null
@@ -0,0 +1,46 @@
+<?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 provider tests.
+ *
+ * @package    portfolio_boxnet
+ * @copyright  2018 Jake Dallimore <jrhdallimore@gmail.com>
+ * @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 <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class portfolio_boxnet_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_boxnet');
+        $collection = \portfolio_boxnet\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]);
+    }
+}