<?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 qtype_multianswer;

use qtype_multianswer;
use qtype_multianswer_edit_form;
use qtype_multichoice_base;
use question_bank;
use stdClass;
use test_question_maker;

defined('MOODLE_INTERNAL') || die();

global $CFG;
require_once($CFG->dirroot . '/question/engine/tests/helpers.php');
require_once($CFG->dirroot . '/question/type/multianswer/questiontype.php');
require_once($CFG->dirroot . '/question/type/edit_question_form.php');
require_once($CFG->dirroot . '/question/type/multianswer/edit_multianswer_form.php');


/**
 * Unit tests for the multianswer question definition class.
 *
 * @package   qtype_multianswer
 * @copyright 2011 The Open University
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @covers    \qtype_multianswer
 */
final class question_type_test extends \advanced_testcase {
    /** @var qtype_multianswer instance of the question type class to test. */
    protected $qtype;

    protected function setUp(): void {
        parent::setUp();
        $this->qtype = new qtype_multianswer();
    }

    protected function tearDown(): void {
        $this->qtype = null;
        parent::tearDown();
    }

    protected function get_test_question_data() {
        global $USER;
        $q = new \stdClass();
        $q->id = 0;
        $q->name = 'Simple multianswer';
        $q->category = 0;
        $q->contextid = 0;
        $q->parent = 0;
        $q->questiontext =
                'Complete this opening line of verse: "The {#1} and the {#2} went to sea".';
        $q->questiontextformat = FORMAT_HTML;
        $q->generalfeedback = 'Generalfeedback: It\'s from "The Owl and the Pussy-cat" by Lear: ' .
                '"The owl and the pussycat went to see';
        $q->generalfeedbackformat = FORMAT_HTML;
        $q->defaultmark = 2;
        $q->penalty = 0.3333333;
        $q->status = \core_question\local\bank\question_version_status::QUESTION_STATUS_READY;
        $q->versionid = 0;
        $q->version = 1;
        $q->questionbankentryid = 0;
        $q->length = 1;
        $q->stamp = make_unique_id_code();
        $q->timecreated = time();
        $q->timemodified = time();
        $q->createdby = $USER->id;
        $q->modifiedby = $USER->id;
        $q->options = new stdClass();

        $sadata = new \stdClass();
        $sadata->id = 1;
        $sadata->qtype = 'shortanswer';
        $sadata->defaultmark = 1;
        $sadata->options = new stdClass();
        $sadata->options->usecase = true;
        $sadata->options->answers[1] = (object) array('answer' => 'Bow-wow', 'fraction' => 0);
        $sadata->options->answers[2] = (object) array('answer' => 'Wiggly worm', 'fraction' => 0);
        $sadata->options->answers[3] = (object) array('answer' => 'Pussy-cat', 'fraction' => 1);

        $mcdata = new \stdClass();
        $mcdata->id = 1;
        $mcdata->qtype = 'multichoice';
        $mcdata->defaultmark = 1;
        $mcdata->options = new stdClass();
        $mcdata->options->single = true;
        $mcdata->options->answers[1] = (object) array('answer' => 'Dog', 'fraction' => 0);
        $mcdata->options->answers[2] = (object) array('answer' => 'Owl', 'fraction' => 1);
        $mcdata->options->answers[3] = (object) array('answer' => '*', 'fraction' => 0);

        $q->options->questions = array(
            1 => $sadata,
            2 => $mcdata,
        );

        return $q;
    }

    public function test_name(): void {
        $this->assertEquals($this->qtype->name(), 'multianswer');
    }

    public function test_can_analyse_responses(): void {
        $this->assertFalse($this->qtype->can_analyse_responses());
    }

    public function test_get_random_guess_score(): void {
        $q = test_question_maker::get_question_data('multianswer', 'twosubq');
        $this->assertEqualsWithDelta(0.1666667, $this->qtype->get_random_guess_score($q), 0.0000001);
    }

    public function test_get_random_guess_score_with_missing_subquestion(): void {
        global $DB;
        $this->resetAfterTest();

        // Create a question referring to a subquesion that has got lost (which happens some time).
        /** @var \core_question_generator $generator */
        $generator = $this->getDataGenerator()->get_plugin_generator('core_question');
        $category = $generator->create_question_category();
        $question = $generator->create_question('multianswer', 'twosubq', ['category' => $category->id]);
        // Add a non-existent subquestion id to the list.
        $sequence = $DB->get_field('question_multianswer', 'sequence', ['question' => $question->id], MUST_EXIST);
        $DB->set_field('question_multianswer', 'sequence', $sequence . ',-1', ['question' => $question->id]);

        // Verify that computing the random guess score does not give an error.
        $questiondata = question_bank::load_question_data($question->id);
        $this->assertEqualsWithDelta(0.1666667, $this->qtype->get_random_guess_score($questiondata), 0.0000001);
    }

    public function test_get_random_guess_score_with_all_missing_subquestions(): void {
        $this->resetAfterTest();

        // Create a question where all subquestions are missing.
        $questiondata = test_question_maker::get_question_data('multianswer', 'twosubq');
        foreach ($questiondata->options->questions as $subq) {
            $subq->qtype = 'subquestion_replacement';
        }

        // Verify that computing the random guess score does not give an error.
        $this->assertNull($this->qtype->get_random_guess_score($questiondata));
    }

    public function test_load_question(): void {
        $this->resetAfterTest();

        $syscontext = \context_system::instance();
        /** @var \core_question_generator $generator */
        $generator = $this->getDataGenerator()->get_plugin_generator('core_question');
        $category = $generator->create_question_category(['contextid' => $syscontext->id]);

        $fromform = \test_question_maker::get_question_form_data('multianswer');
        $fromform->category = $category->id . ',' . $syscontext->id;

        $question = new \stdClass();
        $question->category = $category->id;
        $question->qtype = 'multianswer';
        $question->createdby = 0;

        // Note, $question gets modified during save because of the way subquestions
        // are extracted.
        $question = $this->qtype->save_question($question, $fromform);

        $questiondata = question_bank::load_question_data($question->id);

        $this->assertEquals(['id', 'category', 'parent', 'name', 'questiontext', 'questiontextformat',
                'generalfeedback', 'generalfeedbackformat', 'defaultmark', 'penalty', 'qtype',
                'length', 'stamp', 'timecreated', 'timemodified', 'createdby', 'modifiedby', 'idnumber', 'contextid',
                'status', 'versionid', 'version', 'questionbankentryid', 'categoryobject', 'options', 'hints'],
                array_keys(get_object_vars($questiondata)));
        $this->assertEquals($category->id, $questiondata->category);
        $this->assertEquals(0, $questiondata->parent);
        $this->assertEquals($fromform->name, $questiondata->name);
        $this->assertEquals($fromform->questiontext, $questiondata->questiontext);
        $this->assertEquals($fromform->questiontextformat, $questiondata->questiontextformat);
        $this->assertEquals($fromform->generalfeedback['text'], $questiondata->generalfeedback);
        $this->assertEquals($fromform->generalfeedback['format'], $questiondata->generalfeedbackformat);
        $this->assertEquals($fromform->defaultmark, $questiondata->defaultmark);
        $this->assertEquals(0, $questiondata->penalty);
        $this->assertEquals('multianswer', $questiondata->qtype);
        $this->assertEquals(1, $questiondata->length);
        $this->assertEquals(\core_question\local\bank\question_version_status::QUESTION_STATUS_READY, $questiondata->status);
        $this->assertEquals($question->createdby, $questiondata->createdby);
        $this->assertEquals($question->createdby, $questiondata->modifiedby);
        $this->assertEquals('', $questiondata->idnumber);
        $this->assertEquals($category->contextid, $questiondata->contextid);

        // Build the expected hint base.
        $hintbase = [
            'questionid' => $questiondata->id,
            'shownumcorrect' => 0,
            'clearwrong' => 0,
            'options' => null];
        $expectedhints = [];
        foreach ($fromform->hint as $key => $value) {
            $hint = $hintbase + [
                'hint' => $value['text'],
                'hintformat' => $value['format'],
            ];
            $expectedhints[] = (object)$hint;
        }
        // Need to get rid of ids.
        $gothints = array_map(function($hint) {
            unset($hint->id);
            return $hint;
        }, $questiondata->hints);
        // Compare hints.
        $this->assertEquals($expectedhints, array_values($gothints));

        // Options.
        $this->assertEquals(['answers', 'questions'], array_keys(get_object_vars($questiondata->options)));
        $this->assertEquals(count($fromform->options->questions), count($questiondata->options->questions));

        // Option answers.
        $this->assertEquals([], $questiondata->options->answers);

        // Build the expected questions. We aren't going deeper to subquestion answers, options... that's another qtype job.
        $expectedquestions = [];
        foreach ($fromform->options->questions as $key => $value) {
            $question = [
                'id' => $value->id,
                'category' => $category->id,
                'parent' => $questiondata->id,
                'name' => $value->name,
                'questiontext' => $value->questiontext,
                'questiontextformat' => $value->questiontextformat,
                'generalfeedback' => $value->generalfeedback,
                'generalfeedbackformat' => $value->generalfeedbackformat,
                'defaultmark' => (float) $value->defaultmark,
                'penalty' => (float)$value->penalty,
                'qtype' => $value->qtype,
                'length' => $value->length,
                'stamp' => $value->stamp,
                'timecreated' => $value->timecreated,
                'timemodified' => $value->timemodified,
                'createdby' => $value->createdby,
                'modifiedby' => $value->modifiedby,
            ];
            $expectedquestions[] = (object)$question;
        }
        // Need to get rid of (version, idnumber, options, hints, maxmark). They are missing @ fromform.
        $gotquestions = array_map(function($question) {
                $question->id = (int) $question->id;
                $question->category = (int) $question->category;
                $question->defaultmark = (float) $question->defaultmark;
                $question->penalty = (float) $question->penalty;
                $question->length = (int) $question->length;
                $question->timecreated = (int) $question->timecreated;
                $question->timemodified = (int) $question->timemodified;
                $question->createdby = (int) $question->createdby;
                $question->modifiedby = (int) $question->modifiedby;
                unset($question->idnumber);
                unset($question->options);
                unset($question->hints);
                unset($question->maxmark);
                return $question;
        }, $questiondata->options->questions);
        // Compare questions.
        $this->assertEquals($expectedquestions, array_values($gotquestions));
    }

    public function test_question_saving_twosubq(): void {
        $this->resetAfterTest(true);
        $this->setAdminUser();

        $questiondata = \test_question_maker::get_question_data('multianswer');

        $formdata = \test_question_maker::get_question_form_data('multianswer');

        $generator = $this->getDataGenerator()->get_plugin_generator('core_question');
        $cat = $generator->create_question_category(array());

        $formdata->category = "{$cat->id},{$cat->contextid}";
        qtype_multianswer_edit_form::mock_submit((array)$formdata);

        $form = \qtype_multianswer_test_helper::get_question_editing_form($cat, $questiondata);

        $this->assertTrue($form->is_validated());

        $fromform = $form->get_data();
        // Create a new question version with the form submission.
        unset($questiondata->id);
        $returnedfromsave = $this->qtype->save_question($questiondata, $fromform);
        $actualquestionsdata = question_load_questions(array($returnedfromsave->id));
        $actualquestiondata = end($actualquestionsdata);

        foreach ($questiondata as $property => $value) {
            if (!in_array($property, ['id', 'timemodified', 'timecreated', 'options', 'hints', 'stamp',
                'idnumber', 'version', 'versionid', 'questionbankentryid', 'contextid', 'category', 'status'])) {
                $this->assertEquals($value, $actualquestiondata->$property);
            }
        }

        foreach ($questiondata->options as $optionname => $value) {
            if ($optionname != 'questions') {
                $this->assertEquals($value, $actualquestiondata->options->$optionname);
            }
        }

        foreach ($questiondata->hints as $hint) {
            $actualhint = array_shift($actualquestiondata->hints);
            foreach ($hint as $property => $value) {
                if (!in_array($property, array('id', 'questionid', 'options'))) {
                    $this->assertEquals($value, $actualhint->$property);
                }
            }
        }

        $this->assertObjectHasProperty('questions', $actualquestiondata->options);

        $subqpropstoignore =
            ['id', 'category', 'parent', 'contextid', 'question', 'options', 'stamp', 'timemodified',
                'timecreated', 'status', 'idnumber', 'version', 'versionid', 'questionbankentryid'];
        foreach ($questiondata->options->questions as $subqno => $subq) {
            $actualsubq = $actualquestiondata->options->questions[$subqno];
            foreach ($subq as $subqproperty => $subqvalue) {
                if (!in_array($subqproperty, $subqpropstoignore)) {
                    $this->assertEquals($subqvalue, $actualsubq->$subqproperty);
                }
            }
            foreach ($subq->options as $optionname => $value) {
                if (!in_array($optionname, array('answers'))) {
                    $this->assertEquals($value, $actualsubq->options->$optionname);
                }
            }
            foreach ($subq->options->answers as $answer) {
                $actualanswer = array_shift($actualsubq->options->answers);
                foreach ($answer as $ansproperty => $ansvalue) {
                    // These questions do not use 'answerformat', will ignore it.
                    if (!in_array($ansproperty, array('id', 'question', 'answerformat'))) {
                        $this->assertEquals($ansvalue, $actualanswer->$ansproperty);
                    }
                }
            }
        }
    }

    /**
     *  Verify that the multiplechoice variants parameters are correctly interpreted from
     *  the question text
     */
    public function test_questiontext_extraction_of_multiplechoice_subquestions_variants(): void {
        $questiontext = array();
        $questiontext['format'] = FORMAT_HTML;
        $questiontext['itemid'] = '';
        $questiontext['text'] = '<p>Match the following cities with the correct state:</p>
            <ul>
            <li>1 San Francisco:{1:MULTICHOICE:=California#OK~%33.33333%Ohio#Not really~Arizona#Wrong}</li>
            <li>2 Tucson:{1:MC:%0%California#Wrong~%33,33333%Ohio#Not really~=Arizona#OK}</li>
            <li>3 Los Angeles:{1:MULTICHOICE_S:=California#OK~%33.33333%Ohio#Not really~Arizona#Wrong}</li>
            <li>4 Phoenix:{1:MCS:%0%California#Wrong~%33,33333%Ohio#Not really~=Arizona#OK}</li>
            <li>5 San Francisco:{1:MULTICHOICE_H:=California#OK~%33.33333%Ohio#Not really~Arizona#Wrong}</li>
            <li>6 Tucson:{1:MCH:%0%California#Wrong~%33,33333%Ohio#Not really~=Arizona#OK}</li>
            <li>7 Los Angeles:{1:MULTICHOICE_HS:=California#OK~%33.33333%Ohio#Not really~Arizona#Wrong}</li>
            <li>8 Phoenix:{1:MCHS:%0%California#Wrong~%33,33333%Ohio#Not really~=Arizona#OK}</li>
            <li>9 San Francisco:{1:MULTICHOICE_V:=California#OK~%33.33333%Ohio#Not really~Arizona#Wrong}</li>
            <li>10 Tucson:{1:MCV:%0%California#Wrong~%33,33333%Ohio#Not really~=Arizona#OK}</li>
            <li>11 Los Angeles:{1:MULTICHOICE_VS:=California#OK~%33.33333%Ohio#Not really~Arizona#Wrong}</li>
            <li>12 Phoenix:{1:MCVS:%0%California#Wrong~%33,33333%Ohio#Not really~=Arizona#OK}</li>
            </ul>';

        $q = qtype_multianswer_extract_question($questiontext);
        foreach ($q->options->questions as $key => $sub) {
            $this->assertSame($sub->qtype, 'multichoice');
            if ($key == 1 || $key == 2 || $key == 5 || $key == 6 || $key == 9 || $key == 10) {
                $this->assertSame($sub->shuffleanswers, 0);
            } else {
                $this->assertSame($sub->shuffleanswers, 1);
            }
            if ($key == 1 || $key == 2 || $key == 3 || $key == 4) {
                $this->assertSame($sub->layout, qtype_multichoice_base::LAYOUT_DROPDOWN);
            } else if ($key == 5 || $key == 6 || $key == 7 || $key == 8) {
                $this->assertSame($sub->layout, qtype_multichoice_base::LAYOUT_HORIZONTAL);
            } else if ($key == 9 || $key == 10 || $key == 11 || $key == 12) {
                $this->assertSame($sub->layout, qtype_multichoice_base::LAYOUT_VERTICAL);
            }
            foreach ($sub->feedback as $key => $feedback) {
                if ($feedback['text'] === 'OK') {
                    $this->assertEquals(1, $sub->fraction[$key]);
                } else if ($feedback['text'] === 'Wrong') {
                    $this->assertEquals(0, $sub->fraction[$key]);
                } else {
                    $this->assertEquals('Not really', $feedback['text']);
                    $this->assertEquals(0.3333333, $sub->fraction[$key]);
                }
            }
        }
    }

    /**
     * Test get_question_options.
     *
     * @covers \qtype_multianswer::get_question_options
     */
    public function test_get_question_options(): void {
        global $DB;

        $this->resetAfterTest(true);

        $syscontext = \context_system::instance();
        $generator = $this->getDataGenerator()->get_plugin_generator('core_question');
        $category = $generator->create_question_category(['contextid' => $syscontext->id]);

        $fromform = test_question_maker::get_question_form_data('multianswer', 'twosubq');
        $fromform->category = $category->id . ',' . $syscontext->id;

        $question = new \stdClass();
        $question->category = $category->id;
        $question->qtype = 'multianswer';
        $question->createdby = 0;

        $question = $this->qtype->save_question($question, $fromform);
        $questiondata = question_bank::load_question_data($question->id);

        $questiontodeletekey = array_keys($questiondata->options->questions)[0];
        $questiontodelete = $questiondata->options->questions[$questiontodeletekey];

        $this->assertCount(2, $questiondata->options->questions);
        $this->assertEquals('shortanswer', $questiondata->options->questions[$questiontodeletekey]->qtype);

        // Forcibly delete a subquestion to ensure get_question_options replaces it.
        $DB->delete_records('question', ['id' => $questiontodelete->id]);
        $this->qtype->get_question_options($questiondata);

        $this->assertCount(2, $questiondata->options->questions);
        $this->assertEquals('subquestion_replacement', $questiondata->options->questions[$questiontodeletekey]->qtype);
    }

    /**
     * Saving a new version of the question should retain the original subquestion versions, with their own qtype data.
     */
    public function test_save_question_options(): void {
        global $DB;
        $this->resetAfterTest(true);
        $this->setAdminUser();

        /** @var \core_question_generator $generator */
        $generator = $this->getDataGenerator()->get_plugin_generator('core_question');
        $cat = $generator->create_question_category([]);
        $question = $generator->create_question('multianswer', 'twosubq', ['category' => $cat->id]);

        get_question_options($question);
        $originalsubq1 = reset($question->options->questions);
        $originalsubq2 = next($question->options->questions);

        // Assert that the original subquestions are the expected types, and they have options records.
        $this->assertEquals('shortanswer', $originalsubq1->qtype);
        $this->assertTrue($DB->record_exists('qtype_shortanswer_options', ['questionid' => $originalsubq1->id]));
        $this->assertEquals('multichoice', $originalsubq2->qtype);
        $this->assertTrue($DB->record_exists('qtype_multichoice_options', ['questionid' => $originalsubq2->id]));

        // Edit the question, replacing the subquestions with two new questions of different types.
        $editedquestion = test_question_maker::get_question_data('multianswer', 'twosubq');
        $editedquestion->id = $question->id;
        $editedquestion->category = $cat->id;
        $editedquestion->context = \context_helper::instance_by_id($cat->contextid);
        $editedsubq1 = test_question_maker::get_question_form_data('multichoice', 'one_of_four');
        $editedsubq1->id = $originalsubq1->id;
        $editedsubq1->qtype = 'multichoice';
        $editedsubq2 = test_question_maker::get_question_form_data('shortanswer', 'frogtoad');
        $editedsubq2->id = $originalsubq2->id;
        $editedsubq2->qtype = 'shortanswer';
        $editedquestion->options->questions = [$editedsubq1, $editedsubq2];
        $this->qtype->save_question_options($editedquestion);

        $newquestion = $DB->get_record('question', ['id' => $question->id]);
        get_question_options($newquestion);
        $newsubq1 = reset($newquestion->options->questions);
        $newsubq2 = next($newquestion->options->questions);

        // The new subquestions are different types, and did not re-use IDs from the original subquestions.
        $this->assertEquals('multichoice', $newsubq1->qtype);
        $this->assertFalse(in_array($newsubq1->id, [$originalsubq1->id, $originalsubq2->id]));
        $this->assertEquals('shortanswer', $newsubq2->qtype);
        $this->assertFalse(in_array($newsubq2->id, [$originalsubq1->id, $originalsubq2->id]));

        // The original questions and option records still exist.
        $this->assertTrue($DB->record_exists('question', ['id' => $originalsubq1->id]));
        $this->assertTrue($DB->record_exists('qtype_shortanswer_options', ['questionid' => $originalsubq1->id]));
        $this->assertTrue($DB->record_exists('question', ['id' => $originalsubq2->id]));
        $this->assertTrue($DB->record_exists('qtype_multichoice_options', ['questionid' => $originalsubq2->id]));
    }
}
