Proyectos de Subversion Moodle

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

use core_external\external_api;

use externallib_advanced_testcase;

use mod_wiki_external;

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

global $CFG;

require_once($CFG->dirroot . '/webservice/tests/helpers.php');

require_once($CFG->dirroot . '/mod/wiki/lib.php');

/**

 * Wiki module external functions tests

 *

 * @package    mod_wiki

 * @category   external

 * @copyright  2015 Dani Palou <dani@moodle.com>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 * @since      Moodle 3.1

 */

final class externallib_test extends externallib_advanced_testcase {

    /** @var \stdClass course record. */

    protected $course;

    /** @var \stdClass activity record. */

    protected $wiki;

    /** @var \stdClass activity record. */

    protected $wikisep;

    /** @var \stdClass activity record. */

    protected $wikivis;

    /** @var \stdClass activity record. */

    protected $wikisepind;

    /** @var \stdClass activity record. */

    protected $wikivisind;

    /** @var \context_module context instance. */

    protected $context;

    /** @var \StdClass */

    protected $cm;

    /** @var \stdClass user record. */

    protected $student;

    /** @var \stdClass user record. */

    protected $student2;

    /** @var \stdClass user record. */

    protected $teacher;

    /** @var mixed a fieldset object, false or exception if error not found. */

    protected $studentrole;

    /** @var mixed a fieldset object, false or exception if error not found. */

    protected $teacherrole;

    /** @var \stdClass first page. */

    protected $firstpage;

    /** @var \stdClass group record */

    protected $group1;

    /** @var \stdClass group record */

    protected $group2;

    /** @var \stdClass first page. */

    protected $fpsepg1;

    /** @var \stdClass first page. */

    protected $fpsepg2;

    /** @var \stdClass first page. */

    protected $fpsepall;

    /** @var \stdClass first page. */

    protected $fpvisg1;

    /** @var \stdClass first page. */

    protected $fpvisg2;

    /** @var \stdClass first page. */

    protected $fpvisall;

    /** @var \stdClass first page. */

    protected $fpsepg1indt;

    /** @var \stdClass first page. */

    protected $fpsepg2indt;

    /** @var \stdClass first page. */

    protected $fpsepallindt;

    /** @var \stdClass first page. */

    protected $fpvisg1indt;

    /** @var \stdClass first page. */

    protected $fpvisg2indt;

    /** @var \stdClass first page. */

    protected $fpvisallindt;

    /** @var \stdClass first page. */

    protected $fpsepg1indstu;

    /** @var \stdClass first page. */

    protected $fpvisg1indstu;

    /** @var \stdClass first page. */

    protected $fpsepg1indstu2;

    /** @var \stdClass first page. */

    protected $fpvisg1indstu2;

    /** @var \stdClass user record. */

    protected $studentnotincourse;

    /** @var \stdClass course record. */

    protected $anothercourse;

    /** @var \stdClass group record. */

    protected $groupnotincourse;

    /**

     * Set up for every test

     */

    public function setUp(): void {

        global $DB;

        parent::setUp();

        $this->resetAfterTest();

        $this->setAdminUser();

        // Setup test data.

        $this->course = $this->getDataGenerator()->create_course();

        $this->wiki = $this->getDataGenerator()->create_module('wiki', array('course' => $this->course->id));

        $this->context = \context_module::instance($this->wiki->cmid);

        $this->cm = get_coursemodule_from_instance('wiki', $this->wiki->id);

        // Create users.

        $this->student = self::getDataGenerator()->create_user();

        $this->student2 = self::getDataGenerator()->create_user();

        $this->teacher = self::getDataGenerator()->create_user();

        // Users enrolments.

        $this->studentrole = $DB->get_record('role', array('shortname' => 'student'));

        $this->teacherrole = $DB->get_record('role', array('shortname' => 'editingteacher'));

        $this->getDataGenerator()->enrol_user($this->student->id, $this->course->id, $this->studentrole->id, 'manual');

        $this->getDataGenerator()->enrol_user($this->student2->id, $this->course->id, $this->studentrole->id, 'manual');

        $this->getDataGenerator()->enrol_user($this->teacher->id, $this->course->id, $this->teacherrole->id, 'manual');

        // Create first pages.

        $this->firstpage = $this->getDataGenerator()->get_plugin_generator('mod_wiki')->create_first_page($this->wiki,

            array('tags' => array('Cats', 'Dogs')));

    }

    /**

     * Create two collaborative wikis (separate/visible groups), 2 groups and a first page for each wiki and group.

     */

    private function create_collaborative_wikis_with_groups() {

        // Create groups and add student to one of them.

        if (!isset($this->group1)) {

            $this->group1 = $this->getDataGenerator()->create_group(array('courseid' => $this->course->id));

            $this->getDataGenerator()->create_group_member(array('userid' => $this->student->id, 'groupid' => $this->group1->id));

            $this->getDataGenerator()->create_group_member(array('userid' => $this->student2->id, 'groupid' => $this->group1->id));

        }

        if (!isset($this->group2)) {

            $this->group2 = $this->getDataGenerator()->create_group(array('courseid' => $this->course->id));

        }

        // Create two collaborative wikis.

        $this->wikisep = $this->getDataGenerator()->create_module('wiki',

                                                        array('course' => $this->course->id, 'groupmode' => SEPARATEGROUPS));

        $this->wikivis = $this->getDataGenerator()->create_module('wiki',

                                                        array('course' => $this->course->id, 'groupmode' => VISIBLEGROUPS));

        // Create pages.

        $wikigenerator = $this->getDataGenerator()->get_plugin_generator('mod_wiki');

        $this->fpsepg1 = $wikigenerator->create_first_page($this->wikisep, array('group' => $this->group1->id));

        $this->fpsepg2 = $wikigenerator->create_first_page($this->wikisep, array('group' => $this->group2->id));

        $this->fpsepall = $wikigenerator->create_first_page($this->wikisep, array('group' => 0)); // All participants.

        $this->fpvisg1 = $wikigenerator->create_first_page($this->wikivis, array('group' => $this->group1->id));

        $this->fpvisg2 = $wikigenerator->create_first_page($this->wikivis, array('group' => $this->group2->id));

        $this->fpvisall = $wikigenerator->create_first_page($this->wikivis, array('group' => 0)); // All participants.

    }

    /**

     * Create two individual wikis (separate/visible groups), 2 groups and a first page for each wiki and group.

     */

    private function create_individual_wikis_with_groups() {

        // Create groups and add student to one of them.

        if (!isset($this->group1)) {

            $this->group1 = $this->getDataGenerator()->create_group(array('courseid' => $this->course->id));

            $this->getDataGenerator()->create_group_member(array('userid' => $this->student->id, 'groupid' => $this->group1->id));

            $this->getDataGenerator()->create_group_member(array('userid' => $this->student2->id, 'groupid' => $this->group1->id));

        }

        if (!isset($this->group2)) {

            $this->group2 = $this->getDataGenerator()->create_group(array('courseid' => $this->course->id));

        }

        // Create two individual wikis.

        $this->wikisepind = $this->getDataGenerator()->create_module('wiki', array('course' => $this->course->id,

                                                        'groupmode' => SEPARATEGROUPS, 'wikimode' => 'individual'));

        $this->wikivisind = $this->getDataGenerator()->create_module('wiki', array('course' => $this->course->id,

                                                        'groupmode' => VISIBLEGROUPS, 'wikimode' => 'individual'));

        // Create pages. Student can only create pages in his groups.

        $wikigenerator = $this->getDataGenerator()->get_plugin_generator('mod_wiki');

        $this->setUser($this->teacher);

        $this->fpsepg1indt = $wikigenerator->create_first_page($this->wikisepind, array('group' => $this->group1->id));

        $this->fpsepg2indt = $wikigenerator->create_first_page($this->wikisepind, array('group' => $this->group2->id));

        $this->fpsepallindt = $wikigenerator->create_first_page($this->wikisepind, array('group' => 0)); // All participants.

        $this->fpvisg1indt = $wikigenerator->create_first_page($this->wikivisind, array('group' => $this->group1->id));

        $this->fpvisg2indt = $wikigenerator->create_first_page($this->wikivisind, array('group' => $this->group2->id));

        $this->fpvisallindt = $wikigenerator->create_first_page($this->wikivisind, array('group' => 0)); // All participants.

        $this->setUser($this->student);

        $this->fpsepg1indstu = $wikigenerator->create_first_page($this->wikisepind, array('group' => $this->group1->id));

        $this->fpvisg1indstu = $wikigenerator->create_first_page($this->wikivisind, array('group' => $this->group1->id));

        $this->setUser($this->student2);

        $this->fpsepg1indstu2 = $wikigenerator->create_first_page($this->wikisepind, array('group' => $this->group1->id));

        $this->fpvisg1indstu2 = $wikigenerator->create_first_page($this->wikivisind, array('group' => $this->group1->id));

    }

    /*

     * Test get wikis by courses

     */

    public function test_mod_wiki_get_wikis_by_courses(): void {

        // Create additional course.

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

        // Second wiki.

        $record = new \stdClass();

        $record->course = $course2->id;

        $wiki2 = self::getDataGenerator()->create_module('wiki', $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, $this->student->id, $this->studentrole->id);

        self::setUser($this->student);

        $returndescription = mod_wiki_external::get_wikis_by_courses_returns();

        // Create what we expect to be returned when querying the two courses.

        // First for the student user.

        $expectedfields = array('id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'lang',

                'firstpagetitle', 'wikimode', 'defaultformat', 'forceformat', 'editbegin', 'editend', 'section', 'visible',

                'groupmode', 'groupingid');

        // Add expected coursemodule and data.

        $wiki1 = $this->wiki;

        $wiki1->coursemodule = $wiki1->cmid;

        $wiki1->introformat = 1;

        $wiki1->section = 0;

        $wiki1->visible = true;

        $wiki1->groupmode = 0;

        $wiki1->groupingid = 0;

        $wiki1->introfiles = [];

        $wiki1->lang = '';

        $wiki2->coursemodule = $wiki2->cmid;

        $wiki2->introformat = 1;

        $wiki2->section = 0;

        $wiki2->visible = true;

        $wiki2->groupmode = 0;

        $wiki2->groupingid = 0;

        $wiki2->introfiles = [];

        $wiki2->lang = '';

        foreach ($expectedfields as $field) {

            $expected1[$field] = $wiki1->{$field};

            $expected2[$field] = $wiki2->{$field};

        }

        // Users can create pages by default.

        $expected1['cancreatepages'] = true;

        $expected2['cancreatepages'] = true;

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

        // Call the external function passing course ids.

        $result = mod_wiki_external::get_wikis_by_courses(array($course2->id, $this->course->id));

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedwikis, $result['wikis']);

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

        // Call the external function without passing course id.

        $result = mod_wiki_external::get_wikis_by_courses();

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedwikis, $result['wikis']);

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

        // Unenrol user from second course and alter expected wikis.

        $enrol->unenrol_user($instance2, $this->student->id);

        array_shift($expectedwikis);

        // Call the external function without passing course id.

        $result = mod_wiki_external::get_wikis_by_courses();

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedwikis, $result['wikis']);

        // Call for the second course we unenrolled the user from, expected warning.

        $result = mod_wiki_external::get_wikis_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']);

        // Now, try as a teacher for getting all the additional fields.

        self::setUser($this->teacher);

        $additionalfields = array('timecreated', 'timemodified');

        foreach ($additionalfields as $field) {

            $expectedwikis[0][$field] = $wiki1->{$field};

        }

        $result = mod_wiki_external::get_wikis_by_courses();

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedwikis, $result['wikis']);

        // Admin also should get all the information.

        self::setAdminUser();

        $result = mod_wiki_external::get_wikis_by_courses(array($this->course->id));

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedwikis, $result['wikis']);

        // Now, prohibit capabilities.

        $this->setUser($this->student);

        $contextcourse1 = \context_course::instance($this->course->id);

        // Default student role allows to view wiki and create pages.

        $wikis = mod_wiki_external::get_wikis_by_courses(array($this->course->id));

        $wikis = external_api::clean_returnvalue(mod_wiki_external::get_wikis_by_courses_returns(), $wikis);

        $this->assertEquals('Test wiki 1', $wikis['wikis'][0]['intro']);

        $this->assertEquals(1, $wikis['wikis'][0]['cancreatepages']);

        // Prohibit capability = mod:wiki:viewpage on Course1 for students.

        assign_capability('mod/wiki:viewpage', CAP_PROHIBIT, $this->studentrole->id, $contextcourse1->id, true);

        accesslib_clear_all_caches_for_unit_testing();

        \course_modinfo::clear_instance_cache(null);

        $wikis = mod_wiki_external::get_wikis_by_courses(array($this->course->id));

        $wikis = external_api::clean_returnvalue(mod_wiki_external::get_wikis_by_courses_returns(), $wikis);

        $this->assertEquals(0, count($wikis['wikis']));

        // Prohibit capability = mod:wiki:createpage on Course1 for students.

        assign_capability('mod/wiki:viewpage', CAP_ALLOW, $this->studentrole->id, $contextcourse1->id, true);

        assign_capability('mod/wiki:createpage', CAP_PROHIBIT, $this->studentrole->id, $contextcourse1->id);

        accesslib_clear_all_caches_for_unit_testing();

        \course_modinfo::clear_instance_cache(null);

        $wikis = mod_wiki_external::get_wikis_by_courses(array($this->course->id));

        $wikis = external_api::clean_returnvalue(mod_wiki_external::get_wikis_by_courses_returns(), $wikis);

        $this->assertFalse($wikis['wikis'][0]['cancreatepages']);

    }

    /**

     * Test view_wiki.

     */

    public function test_view_wiki(): void {

        // Test invalid instance id.

        try {

            mod_wiki_external::view_wiki(0);

            $this->fail('Exception expected due to invalid mod_wiki instance id.');

        } catch (\moodle_exception $e) {

            $this->assertEquals('incorrectwikiid', $e->errorcode);

        }

        // Test not-enrolled user.

        $usernotenrolled = self::getDataGenerator()->create_user();

        $this->setUser($usernotenrolled);

        try {

            mod_wiki_external::view_wiki($this->wiki->id);

            $this->fail('Exception expected due to not enrolled user.');

        } catch (\moodle_exception $e) {

            $this->assertEquals('requireloginerror', $e->errorcode);

        }

        // Test user with full capabilities.

        $this->setUser($this->student);

        // Trigger and capture the event.

        $sink = $this->redirectEvents();

        $result = mod_wiki_external::view_wiki($this->wiki->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::view_wiki_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_wiki\event\course_module_viewed', $event);

        $this->assertEquals($this->context, $event->get_context());

        $moodlewiki = new \moodle_url('/mod/wiki/view.php', array('id' => $this->cm->id));

        $this->assertEquals($moodlewiki, $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 allowed for students by default.

        assign_capability('mod/wiki:viewpage', CAP_PROHIBIT, $this->studentrole->id, $this->context->id);

        accesslib_clear_all_caches_for_unit_testing();

        try {

            mod_wiki_external::view_wiki($this->wiki->id);

            $this->fail('Exception expected due to missing capability.');

        } catch (\moodle_exception $e) {

            $this->assertEquals('cannotviewpage', $e->errorcode);

        }

    }

    /**

     * Test view_page.

     */

    public function test_view_page(): void {

        // Test invalid page id.

        try {

            mod_wiki_external::view_page(0);

            $this->fail('Exception expected due to invalid view_page page id.');

        } catch (\moodle_exception $e) {

            $this->assertEquals('incorrectpageid', $e->errorcode);

        }

        // Test not-enrolled user.

        $usernotenrolled = self::getDataGenerator()->create_user();

        $this->setUser($usernotenrolled);

        try {

            mod_wiki_external::view_page($this->firstpage->id);

            $this->fail('Exception expected due to not enrolled user.');

        } catch (\moodle_exception $e) {

            $this->assertEquals('requireloginerror', $e->errorcode);

        }

        // Test user with full capabilities.

        $this->setUser($this->student);

        // Trigger and capture the event.

        $sink = $this->redirectEvents();

        $result = mod_wiki_external::view_page($this->firstpage->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::view_page_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_wiki\event\page_viewed', $event);

        $this->assertEquals($this->context, $event->get_context());

        $pageurl = new \moodle_url('/mod/wiki/view.php', array('pageid' => $this->firstpage->id));

        $this->assertEquals($pageurl, $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 allowed for students by default.

        assign_capability('mod/wiki:viewpage', CAP_PROHIBIT, $this->studentrole->id, $this->context->id);

        accesslib_clear_all_caches_for_unit_testing();

        try {

            mod_wiki_external::view_page($this->firstpage->id);

            $this->fail('Exception expected due to missing capability.');

        } catch (\moodle_exception $e) {

            $this->assertEquals('cannotviewpage', $e->errorcode);

        }

    }

    /**

     * Test get_subwikis.

     */

    public function test_get_subwikis(): void {

        // Test invalid wiki id.

        try {

            mod_wiki_external::get_subwikis(0);

            $this->fail('Exception expected due to invalid get_subwikis wiki id.');

        } catch (\moodle_exception $e) {

            $this->assertEquals('incorrectwikiid', $e->errorcode);

        }

        // Test not-enrolled user.

        $usernotenrolled = self::getDataGenerator()->create_user();

        $this->setUser($usernotenrolled);

        try {

            mod_wiki_external::get_subwikis($this->wiki->id);

            $this->fail('Exception expected due to not enrolled user.');

        } catch (\moodle_exception $e) {

            $this->assertEquals('requireloginerror', $e->errorcode);

        }

        // Test user with full capabilities.

        $this->setUser($this->student);

        // Create what we expect to be returned. We only test a basic case because deep testing is already done

        // in the tests for wiki_get_visible_subwikis.

        $expectedsubwikis = array();

        $expectedsubwiki = array(

                'id' => $this->firstpage->subwikiid,

                'wikiid' => $this->wiki->id,

                'groupid' => 0,

                'userid' => 0,

                'canedit' => true

            );

        $expectedsubwikis[] = $expectedsubwiki;

        $result = mod_wiki_external::get_subwikis($this->wiki->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwikis_returns(), $result);

        $this->assertEquals($expectedsubwikis, $result['subwikis']);

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

        // Test user with no capabilities.

        // We need a explicit prohibit since this capability is allowed for students by default.

        assign_capability('mod/wiki:viewpage', CAP_PROHIBIT, $this->studentrole->id, $this->context->id);

        accesslib_clear_all_caches_for_unit_testing();

        try {

            mod_wiki_external::get_subwikis($this->wiki->id);

            $this->fail('Exception expected due to missing capability.');

        } catch (\moodle_exception $e) {

            $this->assertEquals('nopermissions', $e->errorcode);

        }

    }

    /**

     * Test get_subwiki_pages using an invalid wiki instance.

     */

    public function test_get_subwiki_pages_invalid_instance(): void {

        $this->expectException(\moodle_exception::class);

        mod_wiki_external::get_subwiki_pages(0);

    }

    /**

     * Test get_subwiki_pages using a user not enrolled in the course.

     */

    public function test_get_subwiki_pages_unenrolled_user(): void {

        // Create and use the user.

        $usernotenrolled = self::getDataGenerator()->create_user();

        $this->setUser($usernotenrolled);

        $this->expectException(\require_login_exception::class);

        mod_wiki_external::get_subwiki_pages($this->wiki->id);

    }

    /**

     * Test get_subwiki_pages using a hidden wiki as student.

     */

    public function test_get_subwiki_pages_hidden_wiki_as_student(): void {

        // Create a hidden wiki and try to get the list of pages.

        $hiddenwiki = $this->getDataGenerator()->create_module('wiki',

                            array('course' => $this->course->id, 'visible' => false));

        $this->setUser($this->student);

        $this->expectException(\require_login_exception::class);

        mod_wiki_external::get_subwiki_pages($hiddenwiki->id);

    }

    /**

     * Test get_subwiki_pages without the viewpage capability.

     */

    public function test_get_subwiki_pages_without_viewpage_capability(): void {

        // Prohibit capability = mod/wiki:viewpage on the course for students.

        $contextcourse = \context_course::instance($this->course->id);

        assign_capability('mod/wiki:viewpage', CAP_PROHIBIT, $this->studentrole->id, $contextcourse->id);

        accesslib_clear_all_caches_for_unit_testing();

        $this->setUser($this->student);

        $this->expectException(\moodle_exception::class);

        mod_wiki_external::get_subwiki_pages($this->wiki->id);

    }

    /**

     * Test get_subwiki_pages using an invalid userid.

     */

    public function test_get_subwiki_pages_invalid_userid(): void {

        // Create an individual wiki.

        $indwiki = $this->getDataGenerator()->create_module('wiki',

                                array('course' => $this->course->id, 'wikimode' => 'individual'));

        $this->expectException(\moodle_exception::class);

        mod_wiki_external::get_subwiki_pages($indwiki->id, 0, -10);

    }

    /**

     * Test get_subwiki_pages using an invalid groupid.

     */

    public function test_get_subwiki_pages_invalid_groupid(): void {

        // Create testing data.

        $this->create_collaborative_wikis_with_groups();

        $this->expectException(\moodle_exception::class);

        mod_wiki_external::get_subwiki_pages($this->wikisep->id, -111);

    }

    /**

     * Test get_subwiki_pages, check that a student can't see another user pages in an individual wiki without groups.

     */

    public function test_get_subwiki_pages_individual_student_see_other_user(): void {

        // Create an individual wiki.

        $indwiki = $this->getDataGenerator()->create_module('wiki',

                                array('course' => $this->course->id, 'wikimode' => 'individual'));

        $this->setUser($this->student);

        $this->expectException(\moodle_exception::class);

        mod_wiki_external::get_subwiki_pages($indwiki->id, 0, $this->teacher->id);

    }

    /**

     * Test get_subwiki_pages, check that a student can't get the pages from another group in

     * a collaborative wiki using separate groups.

     */

    public function test_get_subwiki_pages_collaborative_separate_groups_student_see_other_group(): void {

        // Create testing data.

        $this->create_collaborative_wikis_with_groups();

        $this->setUser($this->student);

        $this->expectException(\moodle_exception::class);

        mod_wiki_external::get_subwiki_pages($this->wikisep->id, $this->group2->id);

    }

    /**

     * Test get_subwiki_pages, check that a student can't get the pages from another group in

     * an individual wiki using separate groups.

     */

    public function test_get_subwiki_pages_individual_separate_groups_student_see_other_group(): void {

        // Create testing data.

        $this->create_individual_wikis_with_groups();

        $this->setUser($this->student);

        $this->expectException(\moodle_exception::class);

        mod_wiki_external::get_subwiki_pages($this->wikisepind->id, $this->group2->id, $this->teacher->id);

    }

    /**

     * Test get_subwiki_pages, check that a student can't get the pages from all participants in

     * a collaborative wiki using separate groups.

     */

    public function test_get_subwiki_pages_collaborative_separate_groups_student_see_all_participants(): void {

        // Create testing data.

        $this->create_collaborative_wikis_with_groups();

        $this->setUser($this->student);

        $this->expectException(\moodle_exception::class);

        mod_wiki_external::get_subwiki_pages($this->wikisep->id, 0);

    }

    /**

     * Test get_subwiki_pages, check that a student can't get the pages from all participants in

     * an individual wiki using separate groups.

     */

    public function test_get_subwiki_pages_individual_separate_groups_student_see_all_participants(): void {

        // Create testing data.

        $this->create_individual_wikis_with_groups();

        $this->setUser($this->student);

        $this->expectException(\moodle_exception::class);

        mod_wiki_external::get_subwiki_pages($this->wikisepind->id, 0, $this->teacher->id);

    }

    /**

     * Test get_subwiki_pages without groups and collaborative wiki.

     */

    public function test_get_subwiki_pages_collaborative(): void {

        // Test user with full capabilities.

        $this->setUser($this->student);

        // Set expected result: first page.

        $expectedpages = array();

        $expectedfirstpage = (array) $this->firstpage;

        $expectedfirstpage['caneditpage'] = true; // No groups and students have 'mod/wiki:editpage' capability.

        $expectedfirstpage['firstpage'] = true;

        $expectedfirstpage['contentformat'] = 1;

        $expectedfirstpage['tags'] = \core_tag\external\util::get_item_tags('mod_wiki', 'wiki_pages', $this->firstpage->id);

        // Cast to expected.

        $expectedfirstpage['tags'][0]['isstandard'] = (bool) $expectedfirstpage['tags'][0]['isstandard'];

        $expectedfirstpage['tags'][1]['isstandard'] = (bool) $expectedfirstpage['tags'][1]['isstandard'];

        $expectedpages[] = $expectedfirstpage;

        $result = mod_wiki_external::get_subwiki_pages($this->wiki->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that groupid param is ignored since the wiki isn't using groups.

        $result = mod_wiki_external::get_subwiki_pages($this->wiki->id, 1234);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that userid param is ignored since the wiki is collaborative.

        $result = mod_wiki_external::get_subwiki_pages($this->wiki->id, 1234, 1234);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Add a new page to the wiki and test again. We'll use a custom title so it's returned first if sorted by title.

        $newpage = $this->getDataGenerator()->get_plugin_generator('mod_wiki')->create_page(

                                $this->wiki, array('title' => 'AAA'));

        $expectednewpage = (array) $newpage;

        $expectednewpage['caneditpage'] = true; // No groups and students have 'mod/wiki:editpage' capability.

        $expectednewpage['firstpage'] = false;

        $expectednewpage['contentformat'] = 1;

        $expectednewpage['tags'] = array();

        array_unshift($expectedpages, $expectednewpage); // Add page to the beginning since it orders by title by default.

        $result = mod_wiki_external::get_subwiki_pages($this->wiki->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Now we'll order by ID. Since first page was created first it'll have a lower ID.

        $expectedpages = array($expectedfirstpage, $expectednewpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wiki->id, 0, 0, array('sortby' => 'id'));

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that WS doesn't return page content if includecontent is false, it returns the size instead.

        foreach ($expectedpages as $i => $expectedpage) {

            $expectedpages[$i]['contentsize'] = \core_text::strlen($expectedpages[$i]['cachedcontent']);

            unset($expectedpages[$i]['cachedcontent']);

            unset($expectedpages[$i]['contentformat']);

        }

        $result = mod_wiki_external::get_subwiki_pages($this->wiki->id, 0, 0, array('sortby' => 'id', 'includecontent' => 0));

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

    }

    /**

     * Test get_subwiki_pages without groups.

     */

    public function test_get_subwiki_pages_individual(): void {

        // Create an individual wiki to test userid param.

        $indwiki = $this->getDataGenerator()->create_module('wiki',

                                array('course' => $this->course->id, 'wikimode' => 'individual'));

        // Perform a request before creating any page to check that an empty array is returned if subwiki doesn't exist.

        $result = mod_wiki_external::get_subwiki_pages($indwiki->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals(array(), $result['pages']);

        // Create first pages as student and teacher.

        $this->setUser($this->student);

        $indfirstpagestudent = $this->getDataGenerator()->get_plugin_generator('mod_wiki')->create_first_page($indwiki);

        $this->setUser($this->teacher);

        $indfirstpageteacher = $this->getDataGenerator()->get_plugin_generator('mod_wiki')->create_first_page($indwiki);

        // Check that teacher can get his pages.

        $expectedteacherpage = (array) $indfirstpageteacher;

        $expectedteacherpage['caneditpage'] = true;

        $expectedteacherpage['firstpage'] = true;

        $expectedteacherpage['contentformat'] = 1;

        $expectedteacherpage['tags'] = array();

        $expectedpages = array($expectedteacherpage);

        $result = mod_wiki_external::get_subwiki_pages($indwiki->id, 0, $this->teacher->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that the teacher can see the student's pages.

        $expectedstudentpage = (array) $indfirstpagestudent;

        $expectedstudentpage['caneditpage'] = true;

        $expectedstudentpage['firstpage'] = true;

        $expectedstudentpage['contentformat'] = 1;

        $expectedstudentpage['tags'] = array();

        $expectedpages = array($expectedstudentpage);

        $result = mod_wiki_external::get_subwiki_pages($indwiki->id, 0, $this->student->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Now check that student can get his pages.

        $this->setUser($this->student);

        $result = mod_wiki_external::get_subwiki_pages($indwiki->id, 0, $this->student->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that not using userid uses current user.

        $result = mod_wiki_external::get_subwiki_pages($indwiki->id, 0);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

    }

    /**

     * Test get_subwiki_pages with groups and collaborative wikis.

     */

    public function test_get_subwiki_pages_separate_groups_collaborative(): void {

        // Create testing data.

        $this->create_collaborative_wikis_with_groups();

        $this->setUser($this->student);

        // Try to get pages from a valid group in separate groups wiki.

        $expectedpage = (array) $this->fpsepg1;

        $expectedpage['caneditpage'] = true; // User belongs to group and has 'mod/wiki:editpage' capability.

        $expectedpage['firstpage'] = true;

        $expectedpage['contentformat'] = 1;

        $expectedpage['tags'] = array();

        $expectedpages = array($expectedpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wikisep->id, $this->group1->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Let's check that not using groupid returns the same result (current group).

        $result = mod_wiki_external::get_subwiki_pages($this->wikisep->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that teacher can view a group pages without belonging to it.

        $this->setUser($this->teacher);

        $result = mod_wiki_external::get_subwiki_pages($this->wikisep->id, $this->group1->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that teacher can get the pages from all participants.

        $expectedpage = (array) $this->fpsepall;

        $expectedpage['caneditpage'] = true;

        $expectedpage['firstpage'] = true;

        $expectedpage['contentformat'] = 1;

        $expectedpage['tags'] = array();

        $expectedpages = array($expectedpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wikisep->id, 0);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

    }

    /**

     * Test get_subwiki_pages with groups and collaborative wikis.

     */

    public function test_get_subwiki_pages_visible_groups_collaborative(): void {

        // Create testing data.

        $this->create_collaborative_wikis_with_groups();

        $this->setUser($this->student);

        // Try to get pages from a valid group in visible groups wiki.

        $expectedpage = (array) $this->fpvisg1;

        $expectedpage['caneditpage'] = true; // User belongs to group and has 'mod/wiki:editpage' capability.

        $expectedpage['firstpage'] = true;

        $expectedpage['contentformat'] = 1;

        $expectedpage['tags'] = array();

        $expectedpages = array($expectedpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wikivis->id, $this->group1->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that with visible groups a student can get the pages of groups he doesn't belong to.

        $expectedpage = (array) $this->fpvisg2;

        $expectedpage['caneditpage'] = false; // User doesn't belong to group so he can't edit the page.

        $expectedpage['firstpage'] = true;

        $expectedpage['contentformat'] = 1;

        $expectedpage['tags'] = array();

        $expectedpages = array($expectedpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wikivis->id, $this->group2->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that with visible groups a student can get the pages of all participants.

        $expectedpage = (array) $this->fpvisall;

        $expectedpage['caneditpage'] = false;

        $expectedpage['firstpage'] = true;

        $expectedpage['contentformat'] = 1;

        $expectedpage['tags'] = array();

        $expectedpages = array($expectedpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wikivis->id, 0);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

    }

    /**

     * Test get_subwiki_pages with groups and individual wikis.

     */

    public function test_get_subwiki_pages_separate_groups_individual(): void {

        // Create testing data.

        $this->create_individual_wikis_with_groups();

        $this->setUser($this->student);

        // Check that student can retrieve his pages from separate wiki.

        $expectedpage = (array) $this->fpsepg1indstu;

        $expectedpage['caneditpage'] = true;

        $expectedpage['firstpage'] = true;

        $expectedpage['contentformat'] = 1;

        $expectedpage['tags'] = array();

        $expectedpages = array($expectedpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wikisepind->id, $this->group1->id, $this->student->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that not using userid uses current user.

        $result = mod_wiki_external::get_subwiki_pages($this->wikisepind->id, $this->group1->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that the teacher can see the student pages.

        $this->setUser($this->teacher);

        $result = mod_wiki_external::get_subwiki_pages($this->wikisepind->id, $this->group1->id, $this->student->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that a student can see pages from another user that belongs to his groups.

        $this->setUser($this->student);

        $expectedpage = (array) $this->fpsepg1indstu2;

        $expectedpage['caneditpage'] = false;

        $expectedpage['firstpage'] = true;

        $expectedpage['contentformat'] = 1;

        $expectedpage['tags'] = array();

        $expectedpages = array($expectedpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wikisepind->id, $this->group1->id, $this->student2->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

    }

    /**

     * Test get_subwiki_pages with groups and individual wikis.

     */

    public function test_get_subwiki_pages_visible_groups_individual(): void {

        // Create testing data.

        $this->create_individual_wikis_with_groups();

        $this->setUser($this->student);

        // Check that student can retrieve his pages from visible wiki.

        $expectedpage = (array) $this->fpvisg1indstu;

        $expectedpage['caneditpage'] = true;

        $expectedpage['firstpage'] = true;

        $expectedpage['contentformat'] = 1;

        $expectedpage['tags'] = array();

        $expectedpages = array($expectedpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wikivisind->id, $this->group1->id, $this->student->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that student can see teacher pages in visible groups, even if the user doesn't belong to the group.

        $expectedpage = (array) $this->fpvisg2indt;

        $expectedpage['caneditpage'] = false;

        $expectedpage['firstpage'] = true;

        $expectedpage['contentformat'] = 1;

        $expectedpage['tags'] = array();

        $expectedpages = array($expectedpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wikivisind->id, $this->group2->id, $this->teacher->id);

        $result = external_api::clean_returnvalue(mod_wiki_external::get_subwiki_pages_returns(), $result);

        $this->assertEquals($expectedpages, $result['pages']);

        // Check that with visible groups a student can get the pages of all participants.

        $expectedpage = (array) $this->fpvisallindt;

        $expectedpage['caneditpage'] = false;

        $expectedpage['firstpage'] = true;

        $expectedpage['contentformat'] = 1;

        $expectedpage['tags'] = array();

        $expectedpages = array($expectedpage);

        $result = mod_wiki_external::get_subwiki_pages($this->wikivisind->id, 0, $this->teacher->id);