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

use core_external\external_api;
use mod_folder_external;

/**
 * External mod_folder functions unit tests
 *
 * @package    mod_folder
 * @category   external
 * @copyright  2015 Juan Leyva <juan@moodle.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @since      Moodle 3.0
 */
final class externallib_test extends \core_external\tests\externallib_testcase {
    /**
     * Test view_folder
     */
    public function test_view_folder(): void {
        global $DB;

        $this->resetAfterTest(true);

        $this->setAdminUser();
        // Setup test data.
        $course = $this->getDataGenerator()->create_course();
        $folder = $this->getDataGenerator()->create_module('folder', array('course' => $course->id));
        $context = \context_module::instance($folder->cmid);
        $cm = get_coursemodule_from_instance('folder', $folder->id);

        // Test invalid instance id.
        try {
            mod_folder_external::view_folder(0);
            $this->fail('Exception expected due to invalid mod_folder instance id.');
        } catch (\moodle_exception $e) {
            $this->assertEquals('invalidrecord', $e->errorcode);
        }

        // Test not-enrolled user.
        $user = self::getDataGenerator()->create_user();
        $this->setUser($user);
        try {
            mod_folder_external::view_folder($folder->id);
            $this->fail('Exception expected due to not enrolled user.');
        } catch (\moodle_exception $e) {
            $this->assertEquals('requireloginerror', $e->errorcode);
        }

        // Test user with full capabilities.
        $studentrole = $DB->get_record('role', array('shortname' => 'student'));
        $this->getDataGenerator()->enrol_user($user->id, $course->id, $studentrole->id);

        // Trigger and capture the event.
        $sink = $this->redirectEvents();

        $result = mod_folder_external::view_folder($folder->id);
        $result = external_api::clean_returnvalue(mod_folder_external::view_folder_returns(), $result);

        $events = $sink->get_events();
        $this->assertCount(1, $events);
        $event = array_shift($events);

        // Checking that the event contains the expected values.
        $this->assertInstanceOf('\mod_folder\event\course_module_viewed', $event);
        $this->assertEquals($context, $event->get_context());
        $moodlefolder = new \moodle_url('/mod/folder/view.php', array('id' => $cm->id));
        $this->assertEquals($moodlefolder, $event->get_url());
        $this->assertEventContextNotUsed($event);
        $this->assertNotEmpty($event->get_name());

        // Test user with no capabilities.
        // We need a explicit prohibit since this capability is only defined in authenticated user and guest roles.
        assign_capability('mod/folder:view', CAP_PROHIBIT, $studentrole->id, $context->id);
        // Empty all the caches that may be affected by this change.
        accesslib_clear_all_caches_for_unit_testing();
        \course_modinfo::clear_instance_cache();

        try {
            mod_folder_external::view_folder($folder->id);
            $this->fail('Exception expected due to missing capability.');
        } catch (\moodle_exception $e) {
            $this->assertEquals('requireloginerror', $e->errorcode);
        }
    }

    /**
     * Test test_mod_folder_get_folders_by_courses
     */
    public function test_mod_folder_get_folders_by_courses(): void {
        global $DB;

        $this->resetAfterTest(true);

        $course1 = self::getDataGenerator()->create_course();
        $course2 = self::getDataGenerator()->create_course();

        $student = self::getDataGenerator()->create_user();
        $studentrole = $DB->get_record('role', array('shortname' => 'student'));
        $this->getDataGenerator()->enrol_user($student->id, $course1->id, $studentrole->id);

        self::setUser($student);

        // First folder.
        $record = new \stdClass();
        $record->course = $course1->id;
        $record->forcedownload = 1;
        $folder1 = self::getDataGenerator()->create_module('folder', $record);

        // Second folder.
        $record = new \stdClass();
        $record->course = $course2->id;
        $record->forcedownload = 0;
        $folder2 = self::getDataGenerator()->create_module('folder', $record);

        // Execute real Moodle enrolment as we'll call unenrol() method on the instance later.
        $enrol = enrol_get_plugin('manual');
        $enrolinstances = enrol_get_instances($course2->id, true);
        foreach ($enrolinstances as $courseenrolinstance) {
            if ($courseenrolinstance->enrol == "manual") {
                $instance2 = $courseenrolinstance;
                break;
            }
        }
        $enrol->enrol_user($instance2, $student->id, $studentrole->id);

        $returndescription = mod_folder_external::get_folders_by_courses_returns();

        // Create what we expect to be returned when querying the two courses.
        $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'lang', 'revision',
                                'timemodified', 'display', 'showexpanded', 'showdownloadfolder', 'section', 'visible',
                                'forcedownload', 'groupmode', 'groupingid', 'enableaitools', 'enabledaiactions');

        // Add expected coursemodule and data.
        $folder1->coursemodule = $folder1->cmid;
        $folder1->introformat = 1;
        $folder1->section = 0;
        $folder1->visible = true;
        $folder1->groupmode = 0;
        $folder1->groupingid = 0;
        $folder1->introfiles = [];
        $folder1->lang = '';
        $folder1->enableaitools = null;
        $folder1->enabledaiactions = null;

        $folder2->coursemodule = $folder2->cmid;
        $folder2->introformat = 1;
        $folder2->section = 0;
        $folder2->visible = true;
        $folder2->groupmode = 0;
        $folder2->groupingid = 0;
        $folder2->introfiles = [];
        $folder2->lang = '';
        $folder2->enableaitools = null;
        $folder2->enabledaiactions = null;

        foreach ($expectedfields as $field) {
            $expected1[$field] = $folder1->{$field};
            $expected2[$field] = $folder2->{$field};
        }

        $expectedfolders = array($expected2, $expected1);

        // Call the external function passing course ids.
        $result = mod_folder_external::get_folders_by_courses(array($course2->id, $course1->id));
        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedfolders, $result['folders']);
        $this->assertCount(0, $result['warnings']);

        // Call the external function without passing course id.
        $result = mod_folder_external::get_folders_by_courses();
        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedfolders, $result['folders']);
        $this->assertCount(0, $result['warnings']);

        // Add a file to the intro.
        $fileintroname = "fileintro.txt";
        $filerecordinline = array(
            'contextid' => \context_module::instance($folder2->cmid)->id,
            'component' => 'mod_folder',
            'filearea'  => 'intro',
            'itemid'    => 0,
            'filepath'  => '/',
            'filename'  => $fileintroname,
        );
        $fs = get_file_storage();
        $timepost = time();
        $fs->create_file_from_string($filerecordinline, 'image contents (not really)');

        $result = mod_folder_external::get_folders_by_courses(array($course2->id, $course1->id));
        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertCount(1, $result['folders'][0]['introfiles']);
        $this->assertEquals($fileintroname, $result['folders'][0]['introfiles'][0]['filename']);

        // Unenrol user from second course.
        $enrol->unenrol_user($instance2, $student->id);
        array_shift($expectedfolders);

        // Call the external function without passing course id.
        $result = mod_folder_external::get_folders_by_courses();
        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedfolders, $result['folders']);

        // Call for the second course we unenrolled the user from, expected warning.
        $result = mod_folder_external::get_folders_by_courses(array($course2->id));
        $this->assertCount(1, $result['warnings']);
        $this->assertEquals('1', $result['warnings'][0]['warningcode']);
        $this->assertEquals($course2->id, $result['warnings'][0]['itemid']);
    }
}
