diff --git a/classes/privacy/provider.php b/classes/privacy/provider.php
index a3b6beeeb96b1f22d27f2e96deec6b9f5c6aaee2..c8f318eb499df2abda77fe5eb703d01d4f5bc2c1 100644
--- a/classes/privacy/provider.php
+++ b/classes/privacy/provider.php
@@ -28,11 +28,10 @@ namespace mod_pdfannotator\privacy;
defined('MOODLE_INTERNAL') || die();
use \core_privacy\local\request\approved_contextlist;
-use \core_privacy\local\request\deletion_criteria;
use \core_privacy\local\request\writer;
-use \core_privacy\local\request\helper as request_helper;
use \core_privacy\local\metadata\collection;
-use \core_privacy\local\request\transform;
+use core_privacy\local\request\approved_userlist;
+use core_privacy\local\request\userlist;
/**
* Description of provider
@@ -329,27 +328,41 @@ class provider implements \core_privacy\local\metadata\provider, \core_privacy\l
$instanceid = $DB->get_field('course_modules', 'instance', ['id' => $context->instanceid], MUST_EXIST);
// 1. Delete all reports this user made in this annotator.
- $DB->delete_records('pdfannotator_reports', ['pdfannotatorid' => $instanceid, 'userid' => $userid]);
+ $DB->delete_records(
+ 'pdfannotator_reports',
+ ['pdfannotatorid' => $instanceid, 'userid' => $userid]
+ );
// 2. Delete all votes this user made in this annotator.
- $sql = "SELECT v.id FROM {pdfannotator_votes} v WHERE v.userid = ? AND v.commentid IN (SELECT c.id FROM {pdfannotator_comments} c WHERE c.pdfannotatorid = ?)";
+ $sql = "SELECT v.id
+ FROM {pdfannotator_votes} v
+ WHERE v.userid = ? AND v.commentid IN
+ (SELECT c.id
+ FROM {pdfannotator_comments} c
+ WHERE c.pdfannotatorid = ?)";
$votes = $DB->get_records_sql($sql , array($userid, $instanceid));
foreach ($votes as $vote) {
$DB->delete_records('pdfannotator_votes', array("id" => $vote->id));
}
// 3. Delete all subscriptions this user made in this annotator.
- $sql = "SELECT s.id FROM {pdfannotator_subscriptions} s WHERE s.userid = ? AND s.annotationid IN "
- . "(SELECT a.id FROM {pdfannotator_annotations} a WHERE a.pdfannotatorid = ?)";
+ $sql = "SELECT s.id
+ FROM {pdfannotator_subscriptions} s
+ WHERE s.userid = ? AND s.annotationid IN
+ (SELECT a.id
+ FROM {pdfannotator_annotations} a
+ WHERE a.pdfannotatorid = ?)";
$subscriptions = $DB->get_records_sql($sql, array($userid, $instanceid));
foreach ($subscriptions as $subscription) {
$DB->delete_records('pdfannotator_subscriptions', array("id" => $subscription->id));
}
// 4. Select all comments this user made in this annotator.
- $comments = $DB->get_records_sql("SELECT c.* FROM {pdfannotator_comments} c WHERE c.pdfannotatorid = ? AND c.userid = ?", array($instanceid, $userid));
+ $sql = "SELECT c.*
+ FROM {pdfannotator_comments} c
+ WHERE c.pdfannotatorid = ? AND c.userid = ?";
+ $comments = $DB->get_records_sql($sql, array($instanceid, $userid));
foreach ($comments as $comment) {
-
// Delete question comments, their underlying annotation as well as all answers and subscriptions.
if ($comment->isquestion) {
self::delete_annotation($comment->annotationid);
@@ -389,6 +402,8 @@ class provider implements \core_privacy\local\metadata\provider, \core_privacy\l
// 1.2 Delete any votes for these comments.
$DB->delete_records('pdfannotator_votes', array("commentid" => $comment->id));
+ // Delete any pictures of the comment.
+ $DB->delete_records('files', array("component" => "mod_pdfannotator", "filearea" => "post", "itemid" => $comment->id));
}
// 1.3 Now delete all comments.
@@ -551,5 +566,13 @@ class provider implements \core_privacy\local\metadata\provider, \core_privacy\l
$DB->delete_records_select('pdfannotator_annotations', $sql, $params);
$DB->delete_records_select('pdfannotator_reports', $sql, $params);
$DB->delete_records_select('pdfannotator_comments', $sql, $params);
+
+ // Delete pictures in comments.
+ $DB->execute("DELETE FORM {files} imgs
+ WHERE imgs.component = 'mod_pdfannotator'
+ AND imgs.filearea = 'post'
+ AND imgs.userid {$userinsql}
+ AND imgs.itemid {$commentinsql}",
+ array_merge($userinparams, $commentinparams));
}
}
diff --git a/tests/privacy/provider_test.php b/tests/privacy/provider_test.php
new file mode 100644
index 0000000000000000000000000000000000000000..276431c141eadd71ea416ffb57b3450807c100eb
--- /dev/null
+++ b/tests/privacy/provider_test.php
@@ -0,0 +1,231 @@
+<?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/>.
+
+namespace mod_pdfannotator\privacy;
+
+use mod_pdfannotator\privacy\provider;
+use core_privacy\local\request\approved_contextlist;
+use core_privacy\local\request\approved_userlist;
+use core_privacy\tests\provider_testcase;
+use stdClass;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once(__DIR__ . '/../fixtures/test_indicator_max.php');
+require_once(__DIR__ . '/../fixtures/test_indicator_min.php');
+require_once(__DIR__ . '/../fixtures/test_target_site_users.php');
+require_once(__DIR__ . '/../fixtures/test_target_course_users.php');
+
+/**
+ * Unit tests for privacy.
+ *
+ * @package mod_pdfannotator
+ * @copyright IT Center RWTH Aachen University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider_test extends provider_testcase {
+
+ protected $course;
+ protected $cmcontext;
+ protected $user;
+ protected $pdffile;
+ protected $annotations;
+ protected $questions;
+ protected $answers;
+
+ public function setUp(): void {
+ global $DB;
+
+ $this->resetAfterTest();
+
+ // Create a course.
+ $generator = $this->getDataGenerator();
+ $this->course = $generator->create_course();
+
+ // Create a pdfannotator module.
+ $cm = $generator->create_module('pdfannotator', ['course' => $this->course->id]);
+ $this->cmcontext = \context_module::instance($cm->cmid);
+
+ // Create a user.
+ $this->user = $generator->create_user();
+
+ // Create a pdf object.
+ $pdfobject = new stdClass();
+ $pdfobject->course = $this->course->id;
+ $pdfobject->name = "PDF_Provider_Test";
+ $pdfobject->intro = "";
+ $pdfobject->introformat = 1;
+ $pdfobject->usevotes = 1;
+ $pdfobject->useprint = 1;
+ $pdfobject->useprintcomments = 1;
+ $pdfobject->use_studenttextbox = 0;
+ $pdfobject->use_studentdrawing = 0;
+ $pdfobject->useprivatecomments = 0;
+ $pdfobject->useprotectedcomments = 0;
+ $pdfobject->timecreated = time();
+ $pdfobject->timemodified = time();
+ $pdfobject->id = $DB->insert_record('pdfannotator', $pdfobject);
+ $this->pdffile = $pdfobject;
+
+ // Create an (pin as a test) annotation to the test pdf.
+ $annotationobj = new stdClass();
+ $annotationobj->pdfannotatorid = $this->pdffile->id;
+ $annotationobj->page = 1;
+ $annotationobj->userid = $this->user->id;
+ $pinannotation = $DB->get_record('pdfannotator_annotationtypes', ['name' => 'pin']);
+ $annotationobj->annotationtypeid = $pinannotation->id;
+ $annotationobj->data = json_encode(['x' => 365, 'y' => 166]);
+ $annotationobj->timecreated = time();
+ $annotationobj->timemodified = time();
+ $annotationobj->id = $DB->insert_record('pdfannotator_annotations', $annotationobj);
+ $this->annotations[] = $annotationobj;
+
+ // Create a question for the pin annotation.
+ $question = new stdClass();
+ $question->pdfannotatorid = $this->pdffile->id;
+ $question->annotationid = $this->annotations[0]->id;
+ $question->userid = $this->user->id;
+ $question->timecreated = time();
+ $question->timemodified = time();
+ $question->isquestion = 1;
+ $question->isdeleted = 0;
+ $question->ishidden = 0;
+ $question->solved = 0;
+ $question->id = $DB->insert_record('pdfannotator_comments', $question);
+ $this->questions[] = $question;
+
+ // Create a comment for the question above.
+ $answer = new stdClass();
+ $answer->pdfannotatorid = $this->pdffile->id;
+ $answer->annotationid = $this->annotations[0]->id;
+ $answer->userid = $this->user->id;
+ $answer->timecreated = time();
+ $answer->timemodified = time();
+ $answer->isquestion = 0;
+ $answer->isdeleted = 0;
+ $answer->ishidden = 0;
+ $answer->solved = 0;
+ $answer->id = $DB->insert_record('pdfannotator_comments', $answer);
+ $this->answers[] = $answer;
+ }
+
+ public function test_delete_data_for_users() {
+ global $DB;
+
+ $this->resetAfterTest();
+
+ $component = 'mod_pdfannotator';
+
+ $usercontext1 = \context_user::instance($this->user->id);
+ $userlist1 = new \core_privacy\local\request\userlist($usercontext1, $component);
+ provider::get_users_in_context($userlist1);
+ $this->assertCount(1, $userlist1);
+
+ // Create a comment for the question above.
+ $answer = new stdClass();
+ $answer->pdfannotatorid = $this->pdffile->id;
+ $answer->annotationid = $this->annotations[0]->id;
+ $answer->userid = $this->user->id;
+ $answer->timecreated = time();
+ $answer->timemodified = time();
+ $answer->isquestion = 0;
+ $answer->isdeleted = 0;
+ $answer->ishidden = 0;
+ $answer->solved = 0;
+ $answer->id = $DB->insert_record('pdfannotator_comments', $answer);
+ $this->answers[] = $answer;
+
+ // Report the first comment from the setUp().
+ $reportobj = new stdClass();
+ $reportobj->commentid = $this->answers[0]->id;
+ $reportobj->courseid = $this->course->id;
+ $reportobj->pdfannotatorid = $this->pdffile->id;
+ $reportobj->userid = $this->user->id;
+ $reportobj->timecreated = time();
+ $reportobj->seen = 0;
+ $reportobj->id = $DB->insert_record('pdfannotator_reports', $reportobj);
+
+ // Vote the second comment in the quetions[0].
+ $voteobj = new stdClass();
+ $voteobj->commentid = $this->answers[1]->id;
+ $voteobj->userid = $this->user->id;
+ $voteobj->vote = 1;
+ $voteobj->id = $DB->insert_record('pdfannotator_votes', $voteobj);
+
+ // Subscribe the questions[0].
+ $subscriptionsobj = new stdClass();
+ $subscriptionsobj->annotationid = $this->questions[0]->id;
+ $subscriptionsobj->userid = $this->user->id;
+ $subscriptionsobj->id = $DB->insert_record('pdfannotator_subscriptions', $voteobj);
+
+ // Perform delete_data_for_users.
+ $systemcontext = \context_system::instance();
+ $component = 'mod_pdfannotator';
+ $userlist = new approved_userlist($systemcontext, $component, $this->user->id);
+ // Delete using delete_data_for_user.
+ provider::delete_data_for_users($userlist);
+
+ list($userinsql, $userinparams) = $DB->get_in_or_equal($userlist->get_userids(), SQL_PARAMS_NAMED);
+
+ $annotatorid = $this->pdffile->id;
+
+ // Combine instance + user sql.
+ $params = array_merge(['pdfannotatorid' => $annotatorid], $userinparams);
+ $sql = "pdfannotatorid = :pdfannotatorid AND userid {$userinsql}";
+
+ // Count subscriptions.
+ $annotations = $DB->get_records('pdfannotator_annotations', ['pdfannotatorid' => $annotatorid]);
+ $annotationids = array_column($annotations, 'id');
+ list($subinsql, $subinparams) = $DB->get_in_or_equal($annotationids, SQL_PARAMS_NAMED);
+
+ $count_subs = $DB->count_records_sql("SELECT *
+ FROM {pdfannotator_subscriptions} sub
+ WHERE sub.userid {$userinsql}
+ AND sub.annotationid {$subinsql}",
+ array_merge($userinparams, $subinparams));
+ $this->assertCount(0, $count_subs);
+
+ // Count votes.
+ $comments = $DB->get_records('pdfannotator_comments', ['pdfannotatorid' => $annotatorid]);
+ $commentsids = array_column($comments, 'id');
+ list($commentinsql, $commentinparams) = $DB->get_in_or_equal($commentsids, SQL_PARAMS_NAMED);
+
+ $count_votes = $DB->count_records_sql("SELECT *
+ FORM {pdfannotator_votes} votes
+ WHERE vote.userid {$userinsql}
+ AND vote.commentid {$commentinsql}",
+ array_merge($userinparams, $commentinparams));
+ $this->assertCount(0, $count_votes);
+
+ // Count annotations, reports, and comments.
+ $count_annotations = count($DB->get_records_select('pdfannotator_annotations', $sql, $params));
+ $this->assertCount(0, $count_annotations);
+ $count_reports = count($DB->get_records_select('pdfannotator_reports', $sql, $params));
+ $this->assertCount(0, $count_reports);
+ $count_comments = count($DB->get_records_select('pdfannotator_comments', $sql, $params));
+ $this->assertCount(0, $count_comments);
+
+ // Count pictures in comments.
+ $count_pics = $DB->count_records_sql("SELECT *
+ FORM {files} imgs
+ WHERE imgs.component = 'mod_pdfannotator'
+ AND imgs.filearea = 'post'
+ AND imgs.userid {$userinsql}
+ AND imgs.itemid {$commentinsql}",
+ array_merge($userinparams, $commentinparams));
+ $this->assertCount(0, $count_pics);
+ }
+}
\ No newline at end of file