From 71ae8603f51d52c2661b73d37f10f384660fa76f Mon Sep 17 00:00:00 2001 From: Shamim Rezaie Date: Fri, 7 Sep 2018 18:20:03 +1000 Subject: [PATCH 1/2] MDL-63140 mod_glossary: Add userid param to glossary calendar callbacks --- mod/glossary/lib.php | 14 ++++-- mod/glossary/tests/lib_test.php | 76 +++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+), 3 deletions(-) diff --git a/mod/glossary/lib.php b/mod/glossary/lib.php index 84055d4d35b..ae65fa7ae22 100644 --- a/mod/glossary/lib.php +++ b/mod/glossary/lib.php @@ -4226,15 +4226,23 @@ function mod_glossary_get_fontawesome_icon_map() { * * @param calendar_event $event * @param \core_calendar\action_factory $factory + * @param int $userid User id to use for all capability checks, etc. Set to 0 for current user (default). * @return \core_calendar\local\event\entities\action_interface|null */ function mod_glossary_core_calendar_provide_event_action(calendar_event $event, - \core_calendar\action_factory $factory) { - $cm = get_fast_modinfo($event->courseid)->instances['glossary'][$event->instance]; + \core_calendar\action_factory $factory, + int $userid = 0) { + global $USER; + + if (!$userid) { + $userid = $USER->id; + } + + $cm = get_fast_modinfo($event->courseid, $userid)->instances['glossary'][$event->instance]; $completion = new \completion_info($cm->get_course()); - $completiondata = $completion->get_data($cm, false); + $completiondata = $completion->get_data($cm, false, $userid); if ($completiondata->completionstate != COMPLETION_INCOMPLETE) { return null; diff --git a/mod/glossary/tests/lib_test.php b/mod/glossary/tests/lib_test.php index 5c9d31563a0..608b22d8aaf 100644 --- a/mod/glossary/tests/lib_test.php +++ b/mod/glossary/tests/lib_test.php @@ -141,6 +141,43 @@ class mod_glossary_lib_testcase extends advanced_testcase { $this->assertTrue($actionevent->is_actionable()); } + public function test_glossary_core_calendar_provide_event_action_for_user() { + global $CFG; + + $this->resetAfterTest(); + $this->setAdminUser(); + + // Create a course. + $course = $this->getDataGenerator()->create_course(); + + // Create a student. + $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); + + // Create the activity. + $glossary = $this->getDataGenerator()->create_module('glossary', array('course' => $course->id)); + + // Create a calendar event. + $event = $this->create_action_event($course->id, $glossary->id, + \core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED); + + // Now log out. + $CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users might still have some capabilities. + $this->setUser(); + + // Create an action factory. + $factory = new \core_calendar\action_factory(); + + // Decorate action event for the student. + $actionevent = mod_glossary_core_calendar_provide_event_action($event, $factory, $student->id); + + // Confirm the event was decorated. + $this->assertInstanceOf('\core_calendar\local\event\value_objects\action', $actionevent); + $this->assertEquals(get_string('view'), $actionevent->get_name()); + $this->assertInstanceOf('moodle_url', $actionevent->get_url()); + $this->assertEquals(1, $actionevent->get_item_count()); + $this->assertTrue($actionevent->is_actionable()); + } + public function test_glossary_core_calendar_provide_event_action_already_completed() { global $CFG; @@ -175,6 +212,45 @@ class mod_glossary_lib_testcase extends advanced_testcase { $this->assertNull($actionevent); } + public function test_glossary_core_calendar_provide_event_action_already_completed_for_user() { + global $CFG; + + $this->resetAfterTest(); + $this->setAdminUser(); + + $CFG->enablecompletion = 1; + + // Create a course. + $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1)); + + // Create a student. + $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); + + // Create the activity. + $glossary = $this->getDataGenerator()->create_module('glossary', array('course' => $course->id), + array('completion' => 2, 'completionview' => 1, 'completionexpected' => time() + DAYSECS)); + + // Get some additional data. + $cm = get_coursemodule_from_instance('glossary', $glossary->id); + + // Create a calendar event. + $event = $this->create_action_event($course->id, $glossary->id, + \core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED); + + // Mark the activity as completed for the user. + $completion = new completion_info($course); + $completion->set_module_viewed($cm, $student->id); + + // Create an action factory. + $factory = new \core_calendar\action_factory(); + + // Decorate action event. + $actionevent = mod_glossary_core_calendar_provide_event_action($event, $factory, $student->id); + + // Ensure result was null. + $this->assertNull($actionevent); + } + /** * Creates an action event. * From eeef0230efe17e10988d7676b669862c177e559a Mon Sep 17 00:00:00 2001 From: Shamim Rezaie Date: Fri, 7 Sep 2018 18:28:22 +1000 Subject: [PATCH 2/2] MDL-63140 mod_glossary: Check if the module is visible to the user --- mod/glossary/lib.php | 5 +++ mod/glossary/tests/lib_test.php | 58 +++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+) diff --git a/mod/glossary/lib.php b/mod/glossary/lib.php index ae65fa7ae22..53e2ba4620a 100644 --- a/mod/glossary/lib.php +++ b/mod/glossary/lib.php @@ -4240,6 +4240,11 @@ function mod_glossary_core_calendar_provide_event_action(calendar_event $event, $cm = get_fast_modinfo($event->courseid, $userid)->instances['glossary'][$event->instance]; + if (!$cm->uservisible) { + // The module is not visible to the user for any reason. + return null; + } + $completion = new \completion_info($cm->get_course()); $completiondata = $completion->get_data($cm, false, $userid); diff --git a/mod/glossary/tests/lib_test.php b/mod/glossary/tests/lib_test.php index 608b22d8aaf..32622395f85 100644 --- a/mod/glossary/tests/lib_test.php +++ b/mod/glossary/tests/lib_test.php @@ -141,6 +141,34 @@ class mod_glossary_lib_testcase extends advanced_testcase { $this->assertTrue($actionevent->is_actionable()); } + public function test_glossary_core_calendar_provide_event_action_as_non_user() { + global $CFG; + + $this->resetAfterTest(); + $this->setAdminUser(); + + // Create the activity. + $course = $this->getDataGenerator()->create_course(); + $glossary = $this->getDataGenerator()->create_module('glossary', array('course' => $course->id)); + + // Create a calendar event. + $event = $this->create_action_event($course->id, $glossary->id, + \core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED); + + // Now log out. + $CFG->forcelogin = true; // We don't want to be logged in as guest, as guest users might still have some capabilities. + $this->setUser(); + + // Create an action factory. + $factory = new \core_calendar\action_factory(); + + // Decorate action event for the student. + $actionevent = mod_glossary_core_calendar_provide_event_action($event, $factory); + + // Confirm the event is not shown at all. + $this->assertNull($actionevent); + } + public function test_glossary_core_calendar_provide_event_action_for_user() { global $CFG; @@ -178,6 +206,36 @@ class mod_glossary_lib_testcase extends advanced_testcase { $this->assertTrue($actionevent->is_actionable()); } + public function test_glossary_core_calendar_provide_event_action_in_hidden_section() { + $this->resetAfterTest(); + $this->setAdminUser(); + + // Create a course. + $course = $this->getDataGenerator()->create_course(); + + // Create a student. + $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); + + // Create the activity. + $glossary = $this->getDataGenerator()->create_module('glossary', array('course' => $course->id)); + + // Create a calendar event. + $event = $this->create_action_event($course->id, $glossary->id, + \core_completion\api::COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED); + + // Set sections 0 as hidden. + set_section_visible($course->id, 0, 0); + + // Create an action factory. + $factory = new \core_calendar\action_factory(); + + // Decorate action event for the student. + $actionevent = mod_glossary_core_calendar_provide_event_action($event, $factory, $student->id); + + // Confirm the event is not shown at all. + $this->assertNull($actionevent); + } + public function test_glossary_core_calendar_provide_event_action_already_completed() { global $CFG;