/**
* Test edit_page. We won't test all the possible cases because that's already
* done in the tests for wiki_save_section / wiki_save_page.
*/
public function test_edit_page()
{
$this->create_individual_wikis_with_groups();
// Test user with full capabilities.
$this->setUser($this->student);
$newpage = $this->getDataGenerator()->get_plugin_generator('mod_wiki')->create_page($this->wikisepind, array('group' => $this->group1->id, 'content' => 'Test'));
// Test edit whole page.
$sectioncontent = '<h1>Title1</h1>Text inside section';
$newpagecontent = $sectioncontent . '<h1>Title2</h1>Text inside section';
$result = mod_wiki_external::edit_page($newpage->id, $newpagecontent);
$result = external_api::clean_returnvalue(mod_wiki_external::edit_page_returns(), $result);
$this->assertInternalType('int', $result['pageid']);
$version = wiki_get_current_version($result['pageid']);
$this->assertEquals($newpagecontent, $version->content);
// Test edit section.
$newsectioncontent = '<h1>Title2</h1>New test2';
$section = 'Title2';
$result = mod_wiki_external::edit_page($newpage->id, $newsectioncontent, $section);
$result = external_api::clean_returnvalue(mod_wiki_external::edit_page_returns(), $result);
$this->assertInternalType('int', $result['pageid']);
$expected = $sectioncontent . $newsectioncontent;
$version = wiki_get_current_version($result['pageid']);
$this->assertEquals($expected, $version->content);
// Test locked section.
$newsectioncontent = '<h1>Title2</h1>New test2';
$section = 'Title2';
try {
// Using user 1 to avoid other users to edit.
wiki_set_lock($newpage->id, 1, $section, true);
mod_wiki_external::edit_page($newpage->id, $newsectioncontent, $section);
$this->fail('Exception expected due to locked section');
} catch (moodle_exception $e) {
$this->assertEquals('pageislocked', $e->errorcode);
}
// Test edit non existing section.
$newsectioncontent = '<h1>Title3</h1>New test3';
$section = 'Title3';
try {
mod_wiki_external::edit_page($newpage->id, $newsectioncontent, $section);
$this->fail('Exception expected due to non existing section in the page.');
} catch (moodle_exception $e) {
$this->assertEquals('invalidsection', $e->errorcode);
}
}
public function test_mod_wiki_get_wikis_by_courses()
{
// 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', '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;
$wiki2->coursemodule = $wiki2->cmid;
$wiki2->introformat = 1;
$wiki2->section = 0;
$wiki2->visible = true;
$wiki2->groupmode = 0;
$wiki2->groupingid = 0;
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);
// Prohibit capability = mod:wiki:viewpage on Course1 for students.
assign_capability('mod/wiki:viewpage', CAP_PROHIBIT, $this->studentrole->id, $contextcourse1->id);
accesslib_clear_all_caches_for_unit_testing();
$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(isset($wikis['wikis'][0]['intro']));
// Prohibit capability = mod:wiki:createpage on Course1 for students.
assign_capability('mod/wiki:createpage', CAP_PROHIBIT, $this->studentrole->id, $contextcourse1->id);
accesslib_clear_all_caches_for_unit_testing();
$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 get_subwikis.
*/
public function test_get_subwikis()
{
// 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_page_contents with groups. We won't test all the possible cases because that's already
* done in the tests for get_subwiki_pages.
*/
public function test_get_page_contents_with_groups()
{
// Create testing data.
$this->create_individual_wikis_with_groups();
// Try to get page from a valid group in separate groups wiki.
$this->setUser($this->student);
$expectedfpsepg1indstu = array('id' => $this->fpsepg1indstu->id, 'wikiid' => $this->wikisepind->id, 'subwikiid' => $this->fpsepg1indstu->subwikiid, 'groupid' => $this->group1->id, 'userid' => $this->student->id, 'title' => $this->fpsepg1indstu->title, 'cachedcontent' => $this->fpsepg1indstu->cachedcontent, 'contentformat' => 1, 'caneditpage' => true);
$result = mod_wiki_external::get_page_contents($this->fpsepg1indstu->id);
$result = external_api::clean_returnvalue(mod_wiki_external::get_page_contents_returns(), $result);
$this->assertEquals($expectedfpsepg1indstu, $result['page']);
// Check that teacher can view a group pages without belonging to it.
$this->setUser($this->teacher);
$result = mod_wiki_external::get_page_contents($this->fpsepg1indstu->id);
$result = external_api::clean_returnvalue(mod_wiki_external::get_page_contents_returns(), $result);
$this->assertEquals($expectedfpsepg1indstu, $result['page']);
}
/**
* Test view_page.
*/
public function test_view_page()
{
// 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);
}
}
