MDL-61308 assign_submission: Privacy code for user rights.

mod/assign/classes/privacy/assignsubmission_provider.php

@@ -0,0 +1,88 @@
+<?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/>.
+
+/**
+ * This file contains the assignsubmission_provider interface.
+ *
+ * Assignment Sub plugins should implement this if they store personal information.
+ *
+ * @package mod_assign
+ * @copyright 2018 Adrian Greeve <adrian@moodle.com>
+ *
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_assign\privacy;
+
+use core_privacy\local\request\contextlist;
+
+defined('MOODLE_INTERNAL') || die();
+
+interface assignsubmission_provider extends \core_privacy\local\request\plugin\subplugin_provider {
+
+    /**
+     * Retrieves the contextids associated with the provided userid for this subplugin.
+     * NOTE if your subplugin must have an entry in the assign_submission table to work, then this
+     * method can be empty.
+     *
+     * @param int $userid The user ID to get context IDs for.
+     * @param \core_privacy\local\request\contextlist $contextlist Use add_from_sql with this object to add your context IDs.
+     */
+    public static function get_context_for_userid_within_submission(int $userid, contextlist $contextlist);
+
+    /**
+     * Returns student user ids related to the provided teacher ID. If it is possible that a student ID will not be returned by
+     * the sql query in \mod_assign\privacy\provider::find_grader_info() Then you need to provide some sql to retrive those
+     * student IDs. This is highly likely if you had to fill in get_context_for_userid_within_submission above.
+     *
+     * @param  useridlist $useridlist A user ID list object that you can append your user IDs to.
+     */
+    public static function get_student_user_ids(useridlist $useridlist);
+
+    /**
+     * This method is used to export any user data this sub-plugin has using the assign_plugin_request_data object to get the
+     * context and userid.
+     * assign_plugin_request_data contains:
+     * - context
+     * - submission object
+     * - current path (subcontext)
+     * - user object
+     *
+     * @param  assign_plugin_request_data $exportdata Information to use to export user data for this sub-plugin.
+     */
+    public static function export_submission_user_data(assign_plugin_request_data $exportdata);
+
+    /**
+     * Any call to this method should delete all user data for the context defined in the deletion_criteria.
+     * assign_plugin_request_data contains:
+     * - context
+     * - assign object
+     *
+     * @param assign_plugin_request_data $requestdata Information to use to delete user data for this submission.
+     */
+    public static function delete_submission_for_context(assign_plugin_request_data $requestdata);
+
+    /**
+     * A call to this method should delete user data (where practicle) from the userid and context.
+     * assign_plugin_request_data contains:
+     * - context
+     * - submission object
+     * - user object
+     * - assign object
+     *
+     * @param  assign_plugin_request_data $exportdata Details about the user and context to focus the deletion.
+     */
+    public static function delete_submission_for_userid(assign_plugin_request_data $exportdata);
+}

mod/assign/classes/privacy/submission_legacy_polyfill.php

@@ -0,0 +1,101 @@
+<?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/>.
+
+/**
+ * This file contains the polyfill to allow a plugin to operate with Moodle 3.3 up.
+ *
+ * @package mod_assign
+ * @copyright 2018 Adrian Greeve <adrian@moodle.com>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_assign\privacy;
+
+use core_privacy\local\request\contextlist;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * The trait used to provide backwards compatability for third-party plugins.
+ *
+ * @copyright 2018 Adrian Greeve <adrian@moodle.com>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+trait submission_legacy_polyfill {
+
+    /**
+     * Retrieves the contextids associated with the provided userid for this subplugin.
+     * NOTE if your subplugin must have an entry in the assign_submission table to work, then this
+     * method can be empty.
+     *
+     * @param  int $userid The user ID to get context IDs for.
+     * @param  \core_privacy\local\request\contextlist $contextlist Use add_from_sql with this object to add your context IDs.
+     */
+    public static function get_context_for_userid_within_submission(int $userid, contextlist $contextlist) {
+        return static::_get_context_for_userid_within_submission($userid, $contextlist);
+    }
+
+    /**
+     * Returns student user ids related to the provided teacher ID. If it is possible that a student ID will not be returned by
+     * the sql query in \mod_assign\privacy\provider::find_grader_info() Then you need to provide some sql to retrive those
+     * student IDs. This is highly likely if you had to fill in get_context_for_userid_within_submission above.
+     *
+     * @param  useridlist $useridlist A user ID list object that you can append your user IDs to.
+     */
+    public static function get_student_user_ids(useridlist $useridlist) {
+        return static::_get_student_user_ids($useridlist);
+    }
+
+    /**
+     * This method is used to export any user data this sub-plugin has using the assign_plugin_request_data object to get the
+     * context and userid.
+     * assign_plugin_request_data contains:
+     * - context
+     * - submission object
+     * - current path (subcontext)
+     * - user object
+     *
+     * @param  assign_plugin_request_data $exportdata Information to use to export user data for this sub-plugin.
+     */
+    public static function export_submission_user_data(assign_plugin_request_data $exportdata) {
+        return static::_export_submission_user_data($exportdata);
+    }
+
+    /**
+     * Any call to this method should delete all user data for the context defined in the deletion_criteria.
+     * assign_plugin_request_data contains:
+     * - context
+     * - assign object
+     *
+     * @param assign_plugin_request_data $requestdata Information to use to delete user data for this submission.
+     */
+    public static function delete_submission_for_context(assign_plugin_request_data $requestdata) {
+        return static::_delete_submission_for_context($requestdata);
+    }
+
+    /**
+     * A call to this method should delete user data (where practicle) from the userid and context.
+     * assign_plugin_request_data contains:
+     * - context
+     * - submission object
+     * - user object
+     * - assign object
+     *
+     * @param  assign_plugin_request_data $exportdata Details about the user and context to focus the deletion.
+     */
+    public static function delete_submission_for_userid(assign_plugin_request_data $exportdata) {
+        return static::_delete_submission_for_userid($exportdata);
+    }
+}

mod/assign/submission/comments/classes/privacy/provider.php

@@ -0,0 +1,131 @@
+<?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    assignsubmission_comments
+ * @copyright  2018 Adrian Greeve <adrian@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace assignsubmission_comments\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/mod/assign/locallib.php');
+
+use \core_privacy\local\metadata\collection;
+use \core_privacy\local\metadata\provider as metadataprovider;
+use \core_comment\privacy\provider as comments_provider;
+use \core_privacy\local\request\contextlist;
+use \mod_assign\privacy\assign_plugin_request_data;
+
+/**
+ * Privacy class for requesting user data.
+ *
+ * @package    assignsubmission_comments
+ * @copyright  2018 Adrian Greeve <adrian@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements metadataprovider, \mod_assign\privacy\assignsubmission_provider {
+
+    /**
+     * Return meta data about this plugin.
+     *
+     * @param  collection $collection A list of information to add to.
+     * @return collection Return the collection after adding to it.
+     */
+    public static function get_metadata(collection $collection) : collection {
+        $collection->link_subsystem('core_comment', 'privacy:metadata:commentpurpose');
+        return $collection;
+    }
+
+    /**
+     * It is possible to make a comment as a teacher without creating an entry in the submission table, so this is required
+     * to find those entries.
+     *
+     * @param  int $userid The user ID that we are finding contexts for.
+     * @param  contextlist $contextlist A context list to add sql and params to for contexts.
+     */
+    public static function get_context_for_userid_within_submission(int $userid, contextlist $contextlist) {
+        $sql = "SELECT contextid
+                  FROM {comments}
+                 WHERE component = :component
+                       AND commentarea = :commentarea
+                       AND userid = :userid";
+        $params = ['userid' => $userid, 'component' => 'assignsubmission_comments', 'commentarea' => 'submission_comments'];
+        $contextlist->add_from_sql($sql, $params);
+    }
+
+    /**
+     * Due to the fact that we can't rely on the queries in the mod_assign provider we have to add some additional sql.
+     *
+     * @param  \mod_assign\privacy\useridlist $useridlist An object for obtaining user IDs of students.
+     */
+    public static function get_student_user_ids(\mod_assign\privacy\useridlist $useridlist) {
+        $params = ['assignid' => $useridlist->get_assignid(), 'commentuserid' => $useridlist->get_teacherid(),
+                'commentuserid2' => $useridlist->get_teacherid()];
+        $sql = "SELECT DISTINCT c.userid AS id
+                  FROM {comments} c
+                  JOIN (SELECT c.itemid
+                          FROM {comments} c
+                          JOIN {assign_submission} s ON s.id = c.itemid AND s.assignment = :assignid
+                         WHERE c.userid = :commentuserid) aa ON aa.itemid = c.itemid
+                 WHERE c.userid NOT IN (:commentuserid2)";
+        $useridlist->add_from_sql($sql, $params);
+    }
+
+    /**
+     * Export all user data for this plugin.
+     *
+     * @param  assign_plugin_request_data $exportdata Data used to determine which context and user to export and other useful
+     * information to help with exporting.
+     */
+    public static function export_submission_user_data(assign_plugin_request_data $exportdata) {
+        $component = 'assignsubmission_comments';
+        $commentarea = 'submission_comments';
+
+        $userid = ($exportdata->get_user() != null);
+        $submission = $exportdata->get_pluginobject();
+
+        // For the moment we are only showing the comments made by this user.
+        comments_provider::export_comments($exportdata->get_context(), $component, $commentarea, $submission->id,
+                $exportdata->get_subcontext(), $userid);
+    }
+
+    /**
+     * Delete all the comments made for this context.
+     *
+     * @param  assign_plugin_request_data $requestdata Data to fulfill the deletion request.
+     */
+    public static function delete_submission_for_context(assign_plugin_request_data $requestdata) {
+        comments_provider::delete_comments_for_all_users($requestdata->get_context(), 'assignsubmission_comments',
+                'submission_comments');
+    }
+
+    /**
+     * A call to this method should delete user data (where practical) using the userid and submission.
+     *
+     * @param  assign_plugin_request_data $exportdata Details about the user and context to focus the deletion.
+     */
+    public static function delete_submission_for_userid(assign_plugin_request_data $exportdata) {
+        // Create an approved context list to delete the comments.
+        $contextlist = new \core_privacy\local\request\approved_contextlist($exportdata->get_user(), 'assignsubmission_comments',
+            [$exportdata->get_context()->id]);
+        comments_provider::delete_comments_for_user($contextlist, 'assignsubmission_comments', 'submission_comments');
+    }
+}

mod/assign/submission/comments/lang/en/assignsubmission_comments.php

@@ -24,6 +24,7 @@
 
 $string['blindmarkingname'] = 'Participant {$a}';
 $string['blindmarkingviewfullname'] = 'Participant {$a->participantnumber} ({$a->participantfullname})';
+$string['privacy:metadata:commentpurpose'] = 'Comments between the student and teacher about a submission.';
 $string['default'] = 'Enabled by default';
 $string['default_help'] = 'If set, this submission method will be enabled by default for all new assignments.';
 $string['enabled'] = 'Submission comments';