<?php
// This file is part of mod_openbook for Moodle - http://moodle.org/
//
// It 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.
//
// It 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/>.

/**
 * Base class with common logic for some unit tests.
 *
 * @package       mod_openbook
 * @author        University of Geneva, E-Learning Team
 * @author        Academic Moodle Cooperation {@link http://www.academic-moodle-cooperation.org}
 * @copyright     2025 University of Geneva {@link http://www.unige.ch}
 * @license       http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace mod_openbook\local\tests;

use advanced_testcase;
use stdClass;
use context_module;
use mod_assign_test_generator;

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

// Make sure the code being tested is accessible.
global $CFG;
require_once($CFG->dirroot . '/mod/openbook/locallib.php'); // Include the code to test!
require_once($CFG->dirroot . '/mod/assign/tests/generator.php'); // Include assign's generator helper trait!

/**
 * This base class contains common logic for tests.
 *
 * @package   mod_openbook
 * @author    Philipp Hager
 * @copyright 2025 University of Geneva {@link http://www.unige.ch}
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
abstract class base extends advanced_testcase {
    // Import assign's generator helper trait to be able to easily add assign instances and submissions!
    use mod_assign_test_generator {
        create_instance as public create_assign;
        add_submission as public;
    }

    /** Default number of students to create */
    const DEFAULT_STUDENT_COUNT = 50;
    /** Default number of teachers to create */
    const DEFAULT_TEACHER_COUNT = 6;
    /** Default number of editing teachers to create */
    const DEFAULT_EDITING_TEACHER_COUNT = 6;
    /** Number of timestamps to create */
    const DEFAULT_TIMESTAMP_COUNT = 6;
    /** Number of groups to create */
    const GROUP_COUNT = 6;

    /** @var stdClass $course New course created to hold the assignments */
    protected $course = null;

    /** @var array $teachers List of DEFAULT_TEACHER_COUNT teachers in the course */
    protected $teachers = null;

    /** @var array $editingteachers List of DEFAULT_EDITING_TEACHER_COUNT editing teachers in the course */
    protected $editingteachers = null;

    /** @var array $students List of DEFAULT_STUDENT_COUNT students in the course */
    protected $students = null;

    /** @var array $groups List of 10 groups in the course */
    protected $groups = null;

    /** @var array $timestamps List of 10 different timestamps */
    protected $timestamps = null;

    /**
     * Setup function - we will create a course and add an tmt instance to it.
     */
    protected function setUp(): void {
        global $DB;

        $this->resetAfterTest(true);

        $this->course = self::getDataGenerator()->create_course();
        $this->teachers = [];
        for ($i = 0; $i < self::DEFAULT_TEACHER_COUNT; $i++) {
            array_push($this->teachers, self::getDataGenerator()->create_user());
        }

        $this->editingteachers = [];
        for ($i = 0; $i < self::DEFAULT_EDITING_TEACHER_COUNT; $i++) {
            array_push($this->editingteachers, self::getDataGenerator()->create_user());
        }

        $this->students = [];
        for ($i = 0; $i < self::DEFAULT_STUDENT_COUNT; $i++) {
            array_push($this->students, self::getDataGenerator()->create_user());
        }

        $this->groups = [];
        for ($i = 0; $i < self::GROUP_COUNT; $i++) {
            array_push($this->groups, self::getDataGenerator()->create_group(['courseid' => $this->course->id]));
        }

        $this->timestamps = [];
        for ($i = 0; $i < self::DEFAULT_TIMESTAMP_COUNT; $i++) {
            $hour = rand(0, 23);
            $minute = rand(0, 60);
            $second = rand(0, 60);
            $month = rand(1, 12);
            $day = rand(0, 31);
            $year = rand(1980, date('Y'));
            array_push($this->timestamps, mktime($hour, $minute, $second, $month, $day, $year));
        }

        $teacherrole = $DB->get_record('role', ['shortname' => 'teacher']);
        foreach ($this->teachers as $i => $teacher) {
            self::getDataGenerator()->enrol_user(
                $teacher->id,
                $this->course->id,
                $teacherrole->id
            );
            groups_add_member($this->groups[$i % self::GROUP_COUNT], $teacher);
        }

        $editingteacherrole = $DB->get_record('role', ['shortname' => 'editingteacher']);
        foreach ($this->editingteachers as $i => $editingteacher) {
            self::getDataGenerator()->enrol_user(
                $editingteacher->id,
                $this->course->id,
                $editingteacherrole->id
            );
            groups_add_member($this->groups[$i % self::GROUP_COUNT], $editingteacher);
        }

        $studentrole = $DB->get_record('role', ['shortname' => 'student']);
        foreach ($this->students as $i => $student) {
            self::getDataGenerator()->enrol_user(
                $student->id,
                $this->course->id,
                $studentrole->id
            );
            groups_add_member($this->groups[$i % self::GROUP_COUNT], $student);
        }

        // Make sure to run these tests as (editing)teacher, due to students getting no table if no files are present!
        self::setUser($this->editingteachers[0]);
    }

    /**
     * Convenience function to create a testable instance of a openbook instance.
     *
     * @param array $params Array of parameters to pass to the generator
     * @return openbook Testable wrapper around the openbook class.
     */
    protected function create_instance($params = []) {
        $generator = self::getDataGenerator()->get_plugin_generator('mod_openbook');
        if (!isset($params['course'])) {
            $params['course'] = $this->course->id;
        }
        $instance = $generator->create_instance($params);
        $cm = get_coursemodule_from_instance('openbook', $instance->id);
        $context = context_module::instance($cm->id);

        return new openbook($cm, $this->course, $context);
    }

    /**
     * Simulate a file upload
     *
     * @param int $userid
     * @param int $openbookid
     * @param string $filename
     * @param string $content
     * @return bool|int
     * @throws \coding_exception
     * @throws \dml_exception
     * @throws \file_exception
     * @throws \stored_file_creation_exception
     */
    protected function create_upload($userid, $openbookid, $filename, $content) {
        global $DB;

        $cm = get_coursemodule_from_instance('openbook', $openbookid);
        $context = context_module::instance($cm->id);
        $fs = get_file_storage();

        // We gotta create a new one!
        $filerecord = (object)[
            'contextid' => $context->id,
            'component' => 'mod_openbook',
            'filearea' => 'attachment',
            'itemid' => $userid,
            'userid' => $userid,
            'filename' => $filename,
            'filepath' => '/',
        ];
        $file = $fs->create_file_from_string($filerecord, $content);

        $dataobject = new stdClass();
        $dataobject->openbook = $openbookid;
        $dataobject->userid = $userid;
        $dataobject->timecreated = $file->get_timecreated();
        $dataobject->fileid = $file->get_id();
        $dataobject->studentapproval = 1; // Upload always means user approves.
        $dataobject->filename = $file->get_filename();
        $dataobject->type = OPENBOOK_MODE_UPLOAD;

        return $DB->insert_record('openbook_file', $dataobject);
    }
}
