MDL-61663 portfolio_mahara: add privacy provider implementation
authorJake Dallimore <jake@moodle.com>
Tue, 20 Mar 2018 01:37:15 +0000 (09:37 +0800)
committerJake Dallimore <jake@moodle.com>
Fri, 13 Apr 2018 06:47:42 +0000 (14:47 +0800)
portfolio/mahara/classes/privacy/provider.php [new file with mode: 0644]
portfolio/mahara/lang/en/portfolio_mahara.php
portfolio/mahara/tests/privacy_provider_test.php [new file with mode: 0644]

diff --git a/portfolio/mahara/classes/privacy/provider.php b/portfolio/mahara/classes/privacy/provider.php
new file mode 100644 (file)
index 0000000..1dab5b6
--- /dev/null
@@ -0,0 +1,78 @@
+<?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_mahara
+ * @copyright  2018 Jake Dallimore <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace portfolio_mahara\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use core_privacy\local\metadata\collection;
+
+/**
+ * Provider for the portfolio_mahara 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('Mahara site', ['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 527eaf6..572eabe 100644 (file)
@@ -43,5 +43,7 @@ $string['mnet_wronghost'] = 'Remote host did not match the transfer record for t
 $string['pf_description'] = 'Allow users to push Moodle content to this host<br />Subscribe to <b>and</b> publish this service to allow authenticated users in your site to push content to {$a}<br /><ul><li><em>Dependency</em>: You must also <strong>publish</strong> the SSO (Identify Provider) service to {$a}.</li><li><em>Dependency</em>: You must also <strong>subscribe</strong> to the SSO (Service Provider) service on {$a}</li><li><em>Dependency</em>: You must also enable the MNet authentication plugin.</li></ul><br />';
 $string['pf_name'] = 'Portfolio services';
 $string['pluginname'] = 'Mahara ePortfolio';
+$string['privacy:metadata'] = 'This plugin sends data externally to a linked Mahara application. It does not store data locally.';
+$string['privacy:metadata:data'] = 'Personal data passed through from the portfolio subsystem.';
 $string['senddisallowed'] = 'You cannot transfer files to Mahara at this time';
 $string['url'] = 'URL';
diff --git a/portfolio/mahara/tests/privacy_provider_test.php b/portfolio/mahara/tests/privacy_provider_test.php
new file mode 100644 (file)
index 0000000..a864e2b
--- /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_mahara
+ * @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_mahara_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_mahara');
+        $collection = \portfolio_mahara\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]);
+    }
+}