<?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 tests for core_comment.
 *
 * @package    core_comment
 * @category   test
 * @copyright  2018 Adrian Greeve <adrian@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();
global $CFG;

require_once($CFG->dirroot . '/comment/locallib.php');
require_once($CFG->dirroot . '/comment/lib.php');

use \core_privacy\tests\provider_testcase;

/**
 * Unit tests for comment/classes/privacy/policy
 *
 * @copyright  2018 Adrian Greeve <adrian@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class core_comment_privacy_testcase extends provider_testcase {

    protected function setUp() {
        $this->resetAfterTest();
    }

    /**
     * Check the exporting of comments for a user id in a context.
     */
    public function test_export_comments() {
        $course = $this->getDataGenerator()->create_course();
        $context = context_course::instance($course->id);

        $comment = $this->get_comment_object($context, $course);

        $user1 = $this->getDataGenerator()->create_user();
        $user2 = $this->getDataGenerator()->create_user();

        // Add comments.
        $comments = [];
        $firstcomment = 'This is the first comment';
        $this->setUser($user1);
        $comment->add($firstcomment);
        $comments[$user1->id] = $firstcomment;

        $secondcomment = 'From the second user';
        $this->setUser($user2);
        $comment->add($secondcomment);
        $comments[$user2->id] = $secondcomment;

        // Retrieve comments only for user1.
        $this->setUser($user1);
        $writer = \core_privacy\local\request\writer::with_context($context);
        \core_comment\privacy\provider::export_comments($context, 'block_comments', 'page_comments', 0, []);

        $data = $writer->get_data([get_string('commentsubcontext', 'core_comment')]);
        $exportedcomments = $data->comments;

        // There is only one comment made by this user.
        $this->assertCount(1, $exportedcomments);
        $comment = reset($exportedcomments);
        $this->assertEquals($comments[$user1->id], format_string($comment->content, FORMAT_PLAIN));

        // Retrieve comments from any user.
        \core_comment\privacy\provider::export_comments($context, 'block_comments', 'page_comments', 0, [], false);

        $data = $writer->get_data([get_string('commentsubcontext', 'core_comment')]);
        $exportedcomments = $data->comments;

        // The whole conversation is two comments.
        $this->assertCount(2, $exportedcomments);
        foreach ($exportedcomments as $comment) {
            $this->assertEquals($comments[$comment->userid], format_string($comment->content, FORMAT_PLAIN));
        }
    }

    /**
     * Tests the deletion of all comments in a context.
     */
    public function test_delete_comments_for_all_users() {
        global $DB;

        $course1 = $this->getDataGenerator()->create_course();
        $course2 = $this->getDataGenerator()->create_course();

        $coursecontext1 = context_course::instance($course1->id);
        $coursecontext2 = context_course::instance($course2->id);

        $user1 = $this->getDataGenerator()->create_user();
        $user2 = $this->getDataGenerator()->create_user();

        $comment1 = $this->get_comment_object($coursecontext1, $course1);
        $comment2 = $this->get_comment_object($coursecontext2, $course2);

        $this->setUser($user1);
        $comment1->add('First comment for user 1 on comment 1');
        $comment2->add('First comment for user 1 on comment 2');
        $this->setUser($user2);
        $comment1->add('First comment for user 2 on comment 1');
        $comment2->add('First comment for user 2 on comment 2');

        // Because of the way things are set up with validation, creating an entry with the same context in a different component
        // or comment area is a huge pain. We're just going to jam entries into the table instead.
        $record = (object) [
            'contextid' => $coursecontext1->id,
            'component' => 'block_comments',
            'commentarea' => 'other_comments',
            'itemid' => 2,
            'content' => 'Comment user 1 different comment area',
            'format' => 0,
            'userid' => $user1->id,
            'timecreated' => time()
        ];
        $DB->insert_record('comments', $record);
        $record = (object) [
            'contextid' => $coursecontext1->id,
            'component' => 'tool_dataprivacy',
            'commentarea' => 'page_comments',
            'itemid' => 2,
            'content' => 'Comment user 1 different component',
            'format' => 0,
            'userid' => $user1->id,
            'timecreated' => time()
        ];
        $DB->insert_record('comments', $record);

        // Delete only for the first context. All records in the comments table for this context should be removed.
        \core_comment\privacy\provider::delete_comments_for_all_users($coursecontext1, 'block_comments', 'page_comments', 0);
        // No records left here.
        $this->assertCount(0, $comment1->get_comments());
        // All of the records are left intact here.
        $this->assertCount(2, $comment2->get_comments());
        // Check the other comment area.
        $result = $DB->get_records('comments', ['commentarea' => 'other_comments']);
        $this->assertCount(1, $result);
        $data = array_shift($result);
        $this->assertEquals('other_comments', $data->commentarea);
        // Check the different component, same commentarea.
        $result = $DB->get_records('comments', ['component' => 'tool_dataprivacy']);
        $this->assertCount(1, $result);
        $data = array_shift($result);
        $this->assertEquals('tool_dataprivacy', $data->component);
    }

    /**
     * Tests the deletion of all comments in a context.
     */
    public function test_delete_comments_for_all_users_select() {
        global $DB;

        $course1 = $this->getDataGenerator()->create_course();
        $course2 = $this->getDataGenerator()->create_course();

        $coursecontext1 = context_course::instance($course1->id);
        $coursecontext2 = context_course::instance($course2->id);

        $user1 = $this->getDataGenerator()->create_user();
        $user2 = $this->getDataGenerator()->create_user();

        $comment1 = $this->get_comment_object($coursecontext1, $course1);
        $comment2 = $this->get_comment_object($coursecontext2, $course2);

        $this->setUser($user1);
        $comment1->add('First comment for user 1 on comment 1');
        $comment2->add('First comment for user 1 on comment 2');
        $this->setUser($user2);
        $comment1->add('First comment for user 2 on comment 1');
        $comment2->add('First comment for user 2 on comment 2');

        // Because of the way things are set up with validation, creating an entry with the same context in a different component
        // or comment area is a huge pain. We're just going to jam entries into the table instead.
        $record = (object) [
            'contextid' => $coursecontext1->id,
            'component' => 'block_comments',
            'commentarea' => 'other_comments',
            'itemid' => 2,
            'content' => 'Comment user 1 different comment area',
            'format' => 0,
            'userid' => $user1->id,
            'timecreated' => time()
        ];
        $DB->insert_record('comments', $record);
        $record = (object) [
            'contextid' => $coursecontext1->id,
            'component' => 'tool_dataprivacy',
            'commentarea' => 'page_comments',
            'itemid' => 2,
            'content' => 'Comment user 1 different component',
            'format' => 0,
            'userid' => $user1->id,
            'timecreated' => time()
        ];
        $DB->insert_record('comments', $record);

        // Delete only for the first context. All records in the comments table for this context should be removed.
        list($sql, $params) = $DB->get_in_or_equal([0, 1, 2, 3], SQL_PARAMS_NAMED);
        \core_comment\privacy\provider::delete_comments_for_all_users_select($coursecontext1,
            'block_comments', 'page_comments', $sql, $params);
        // No records left here.
        $this->assertCount(0, $comment1->get_comments());
        // All of the records are left intact here.
        $this->assertCount(2, $comment2->get_comments());
        // Check the other comment area.
        $result = $DB->get_records('comments', ['commentarea' => 'other_comments']);
        $this->assertCount(1, $result);
        $data = array_shift($result);
        $this->assertEquals('other_comments', $data->commentarea);
        // Check the different component, same commentarea.
        $result = $DB->get_records('comments', ['component' => 'tool_dataprivacy']);
        $this->assertCount(1, $result);
        $data = array_shift($result);
        $this->assertEquals('tool_dataprivacy', $data->component);
    }

    /**
     * Tests deletion of comments for a specified user and contexts.
     */
    public function test_delete_comments_for_user() {
        global $DB;

        $course1 = $this->getDataGenerator()->create_course();
        $course2 = $this->getDataGenerator()->create_course();
        $course3 = $this->getDataGenerator()->create_course();

        $coursecontext1 = context_course::instance($course1->id);
        $coursecontext2 = context_course::instance($course2->id);
        $coursecontext3 = context_course::instance($course3->id);

        $user1 = $this->getDataGenerator()->create_user();
        $user2 = $this->getDataGenerator()->create_user();

        $comment1 = $this->get_comment_object($coursecontext1, $course1);
        $comment2 = $this->get_comment_object($coursecontext2, $course2);
        $comment3 = $this->get_comment_object($coursecontext3, $course3);

        $this->setUser($user1);
        $comment1->add('First comment for user 1');
        $comment2->add('User 1 comment in second comment');

        $this->setUser($user2);
        $comment2->add('User two replied in comment two');
        $comment3->add('Comment three for user 2.');

        // Because of the way things are set up with validation, creating an entry with the same context in a different component
        // or comment area is a huge pain. We're just going to jam entries into the table instead.
        $record = (object) [
            'contextid' => $coursecontext1->id,
            'component' => 'block_comments',
            'commentarea' => 'other_comments',
            'itemid' => 2,
            'content' => 'Comment user 1 different comment area',
            'format' => 0,
            'userid' => $user1->id,
            'timecreated' => time()
        ];
        $DB->insert_record('comments', $record);
        $record = (object) [
            'contextid' => $coursecontext1->id,
            'component' => 'tool_dataprivacy',
            'commentarea' => 'page_comments',
            'itemid' => 2,
            'content' => 'Comment user 1 different component',
            'format' => 0,
            'userid' => $user1->id,
            'timecreated' => time()
        ];
        $DB->insert_record('comments', $record);

        // Delete the comments for user 1.
        $approvedcontextlist = new core_privacy\tests\request\approved_contextlist($user1, 'block_comments',
                [$coursecontext1->id, $coursecontext2->id]);
        \core_comment\privacy\provider::delete_comments_for_user($approvedcontextlist, 'block_comments', 'page_comments', 0);

        // No comments left in comments 1 as only user 1 commented there.
        $this->assertCount(0, $comment1->get_comments());
        // Only user 2 comments left in comments 2.
        $comment2comments = $comment2->get_comments();
        $this->assertCount(1, $comment2comments);
        $data = array_shift($comment2comments);
        $this->assertEquals($user2->id, $data->userid);
        // Nothing changed here as user 1 did not leave a comment.
        $comment3comments = $comment3->get_comments();
        $this->assertCount(1, $comment3comments);
        $data = array_shift($comment3comments);
        $this->assertEquals($user2->id, $data->userid);
        // Check the other comment area.
        $result = $DB->get_records('comments', ['commentarea' => 'other_comments']);
        $this->assertCount(1, $result);
        $data = array_shift($result);
        $this->assertEquals('other_comments', $data->commentarea);
        // Check the different component, same commentarea.
        $result = $DB->get_records('comments', ['component' => 'tool_dataprivacy']);
        $this->assertCount(1, $result);
        $data = array_shift($result);
        $this->assertEquals('tool_dataprivacy', $data->component);
    }

    /**
     * Tests deletion of comments for a specified userlist and context.
     */
    public function test_delete_comments_for_users() {
        global $DB;

        $course1 = $this->getDataGenerator()->create_course();
        $course2 = $this->getDataGenerator()->create_course();
        $course3 = $this->getDataGenerator()->create_course();

        $coursecontext1 = context_course::instance($course1->id);
        $coursecontext2 = context_course::instance($course2->id);
        $coursecontext3 = context_course::instance($course3->id);

        $user1 = $this->getDataGenerator()->create_user();
        $user2 = $this->getDataGenerator()->create_user();
        $user3 = $this->getDataGenerator()->create_user();

        $comment1 = $this->get_comment_object($coursecontext1, $course1);
        $comment2 = $this->get_comment_object($coursecontext2, $course2);
        $comment3 = $this->get_comment_object($coursecontext3, $course3);

        $this->setUser($user1);
        $comment1->add('First comment for user 1');
        $comment2->add('User 1 comment in second comment');

        $this->setUser($user2);
        $comment2->add('User two replied in comment two');

        $this->setUser($user3);
        $comment2->add('User 3 also writing on comment 2, but will not be deleted');
        $comment3->add('Only user 3 commenting in comment 3.');

        // Because of the way things are set up with validation, creating an entry with the same context in a different component
        // or comment area is a huge pain. We're just going to jam entries into the table instead.
        $record = (object) [
            'contextid' => $coursecontext1->id,
            'component' => 'block_comments',
            'commentarea' => 'other_comments',
            'itemid' => 2,
            'content' => 'Comment user 1 different comment area',
            'format' => 0,
            'userid' => $user1->id,
            'timecreated' => time()
        ];
        $DB->insert_record('comments', $record);
        $record = (object) [
            'contextid' => $coursecontext1->id,
            'component' => 'tool_dataprivacy',
            'commentarea' => 'page_comments',
            'itemid' => 2,
            'content' => 'Comment user 1 different component',
            'format' => 0,
            'userid' => $user1->id,
            'timecreated' => time()
        ];
        $DB->insert_record('comments', $record);

        // Delete the comments for users 1 and 2 in all 3 contexts.
        $approvedusers = [$user1->id, $user2->id];

        $approveduserlist = new core_privacy\local\request\approved_userlist($coursecontext1, 'block_comments', $approvedusers);
        \core_comment\privacy\provider::delete_comments_for_users($approveduserlist, 'block_comments', 'page_comments');

        $approveduserlist = new core_privacy\local\request\approved_userlist($coursecontext2, 'block_comments', $approvedusers);
        \core_comment\privacy\provider::delete_comments_for_users($approveduserlist, 'block_comments', 'page_comments');

        $approveduserlist = new core_privacy\local\request\approved_userlist($coursecontext3, 'block_comments', $approvedusers);
        \core_comment\privacy\provider::delete_comments_for_users($approveduserlist, 'block_comments', 'page_comments');

        // No comments left in comments 1 as only user 1 commented there.
        $this->assertCount(0, $comment1->get_comments());

        // Only user 3's comment left in comments 2 as user 1 and 2 were approved for deletion.
        $comment2comments = $comment2->get_comments();
        $this->assertCount(1, $comment2comments);
        $comment2comment = array_shift($comment2comments);
        $this->assertEquals($user3->id, $comment2comment->userid);

        // Nothing changed here as user 1 and 2 did not leave a comment.
        $comment3comments = $comment3->get_comments();
        $this->assertCount(1, $comment3comments);
        $data = array_shift($comment3comments);
        $this->assertEquals($user3->id, $data->userid);

        // Check the other comment area.
        $result = $DB->get_records('comments', ['commentarea' => 'other_comments']);
        $this->assertCount(1, $result);
        $data = array_shift($result);
        $this->assertEquals('other_comments', $data->commentarea);

        // Check the different component, same commentarea.
        $result = $DB->get_records('comments', ['component' => 'tool_dataprivacy']);
        $this->assertCount(1, $result);
        $data = array_shift($result);
        $this->assertEquals('tool_dataprivacy', $data->component);
    }

    /**
     * Creates a comment object
     *
     * @param  context $context A context object.
     * @param  stdClass $course A course object.
     * @return comment The comment object.
     */
    protected function get_comment_object($context, $course) {
        // Comment on course page.
        $args = new stdClass;
        $args->context = $context;
        $args->course = $course;
        $args->area = 'page_comments';
        $args->itemid = 0;
        $args->component = 'block_comments';
        $comment = new comment($args);
        $comment->set_post_permission(true);
        return $comment;
    }
}
