diff --git a/lib/db/services.php b/lib/db/services.php index 3a4370e4623..e98b2f4308a 100644 --- a/lib/db/services.php +++ b/lib/db/services.php @@ -1142,6 +1142,7 @@ $services = array( 'mod_assign_view_grading_table', 'mod_scorm_view_scorm', 'mod_page_view_page', + 'mod_resource_view_resource', ), 'enabled' => 0, 'restrictedusers' => 0, diff --git a/mod/resource/classes/external.php b/mod/resource/classes/external.php new file mode 100644 index 00000000000..de55514750d --- /dev/null +++ b/mod/resource/classes/external.php @@ -0,0 +1,107 @@ +. + +/** + * Resource external API + * + * @package mod_resource + * @category external + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 3.0 + */ + +defined('MOODLE_INTERNAL') || die; + +require_once("$CFG->libdir/externallib.php"); + +/** + * Resource external functions + * + * @package mod_resource + * @category external + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 3.0 + */ +class mod_resource_external extends external_api { + + /** + * Returns description of method parameters + * + * @return external_function_parameters + * @since Moodle 3.0 + */ + public static function view_resource_parameters() { + return new external_function_parameters( + array( + 'resourceid' => new external_value(PARAM_INT, 'resource instance id') + ) + ); + } + + /** + * Simulate the resource/view.php web interface page: trigger events, completion, etc... + * + * @param int $resourceid the resource instance id + * @return array of warnings and status result + * @since Moodle 3.0 + * @throws moodle_exception + */ + public static function view_resource($resourceid) { + global $DB, $CFG; + require_once($CFG->dirroot . "/mod/resource/lib.php"); + + $params = self::validate_parameters(self::view_resource_parameters(), + array( + 'resourceid' => $resourceid + )); + $warnings = array(); + + // Request and permission validation. + $resource = $DB->get_record('resource', array('id' => $params['resourceid']), '*', MUST_EXIST); + list($course, $cm) = get_course_and_cm_from_instance($resource, 'resource'); + + $context = context_module::instance($cm->id); + self::validate_context($context); + + require_capability('mod/resource:view', $context); + + // Call the resource/lib API. + resource_view($resource, $course, $cm, $context); + + $result = array(); + $result['status'] = true; + $result['warnings'] = $warnings; + return $result; + } + + /** + * Returns description of method result value + * + * @return external_description + * @since Moodle 3.0 + */ + public static function view_resource_returns() { + return new external_single_structure( + array( + 'status' => new external_value(PARAM_BOOL, 'status: true if success'), + 'warnings' => new external_warnings() + ) + ); + } + +} diff --git a/mod/resource/db/services.php b/mod/resource/db/services.php new file mode 100644 index 00000000000..7699540811a --- /dev/null +++ b/mod/resource/db/services.php @@ -0,0 +1,39 @@ +. + +/** + * Resource external functions and service definitions. + * + * @package mod_resource + * @category external + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 3.0 + */ + +defined('MOODLE_INTERNAL') || die; + +$functions = array( + + 'mod_resource_view_resource' => array( + 'classname' => 'mod_resource_external', + 'methodname' => 'view_resource', + 'description' => 'Simulate the view.php web interface resource: trigger events, completion, etc...', + 'type' => 'write', + 'capabilities' => 'mod/resource:view' + ), + +); diff --git a/mod/resource/lib.php b/mod/resource/lib.php index 943985404e2..b91d1e1bb44 100644 --- a/mod/resource/lib.php +++ b/mod/resource/lib.php @@ -475,3 +475,31 @@ function resource_dndupload_handle($uploadinfo) { return resource_add_instance($data, null); } + +/** + * Mark the activity completed (if required) and trigger the course_module_viewed event. + * + * @param stdClass $resource resource object + * @param stdClass $course course object + * @param stdClass $cm course module object + * @param stdClass $context context object + * @since Moodle 3.0 + */ +function resource_view($resource, $course, $cm, $context) { + + // Trigger course_module_viewed event. + $params = array( + 'context' => $context, + 'objectid' => $resource->id + ); + + $event = \mod_resource\event\course_module_viewed::create($params); + $event->add_record_snapshot('course_modules', $cm); + $event->add_record_snapshot('course', $course); + $event->add_record_snapshot('resource', $resource); + $event->trigger(); + + // Completion. + $completion = new completion_info($course); + $completion->set_module_viewed($cm); +} diff --git a/mod/resource/tests/externallib_test.php b/mod/resource/tests/externallib_test.php new file mode 100644 index 00000000000..6b79da136f5 --- /dev/null +++ b/mod/resource/tests/externallib_test.php @@ -0,0 +1,112 @@ +. + +/** + * External mod_resource functions unit tests + * + * @package mod_resource + * @category external + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 3.0 + */ + +defined('MOODLE_INTERNAL') || die(); + +global $CFG; + +require_once($CFG->dirroot . '/webservice/tests/helpers.php'); + +/** + * External mod_resource functions unit tests + * + * @package mod_resource + * @category external + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 3.0 + */ +class mod_resource_external_testcase extends externallib_advanced_testcase { + + /** + * Test view_resource + */ + public function test_view_resource() { + global $DB; + + $this->resetAfterTest(true); + + $this->setAdminUser(); + // Setup test data. + $course = $this->getDataGenerator()->create_course(); + $resource = $this->getDataGenerator()->create_module('resource', array('course' => $course->id)); + $context = context_module::instance($resource->cmid); + $cm = get_coursemodule_from_instance('resource', $resource->id); + + // Test invalid instance id. + try { + mod_resource_external::view_resource(0); + $this->fail('Exception expected due to invalid mod_resource 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_resource_external::view_resource($resource->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_resource_external::view_resource($resource->id); + $result = external_api::clean_returnvalue(mod_resource_external::view_resource_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_resource\event\course_module_viewed', $event); + $this->assertEquals($context, $event->get_context()); + $moodleurl = new \moodle_url('/mod/resource/view.php', array('id' => $cm->id)); + $this->assertEquals($moodleurl, $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/resource:view', CAP_PROHIBIT, $studentrole->id, $context->id); + accesslib_clear_all_caches_for_unit_testing(); + + try { + mod_resource_external::view_resource($resource->id); + $this->fail('Exception expected due to missing capability.'); + } catch (moodle_exception $e) { + $this->assertEquals('nopermissions', $e->errorcode); + } + + } +} diff --git a/mod/resource/tests/lib_test.php b/mod/resource/tests/lib_test.php new file mode 100644 index 00000000000..13855c3a1fd --- /dev/null +++ b/mod/resource/tests/lib_test.php @@ -0,0 +1,92 @@ +. + +/** + * Unit tests for mod_resource lib + * + * @package mod_resource + * @category external + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 3.0 + */ + +defined('MOODLE_INTERNAL') || die(); + + +/** + * Unit tests for mod_resource lib + * + * @package mod_resource + * @category external + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @since Moodle 3.0 + */ +class mod_resource_lib_testcase extends advanced_testcase { + + /** + * Prepares things before this test case is initialised + * @return void + */ + public static function setUpBeforeClass() { + global $CFG; + require_once($CFG->dirroot . '/mod/resource/lib.php'); + } + + /** + * Test resource_view + * @return void + */ + public function test_resource_view() { + global $CFG; + + $CFG->enablecompletion = 1; + $this->resetAfterTest(); + + $this->setAdminUser(); + // Setup test data. + $course = $this->getDataGenerator()->create_course(array('enablecompletion' => 1)); + $resource = $this->getDataGenerator()->create_module('resource', array('course' => $course->id), + array('completion' => 2, 'completionview' => 1)); + $context = context_module::instance($resource->cmid); + $cm = get_coursemodule_from_instance('resource', $resource->id); + + // Trigger and capture the event. + $sink = $this->redirectEvents(); + + resource_view($resource, $course, $cm, $context); + + $events = $sink->get_events(); + // 2 additional events thanks to completion. + $this->assertCount(3, $events); + $event = array_shift($events); + + // Checking that the event contains the expected values. + $this->assertInstanceOf('\mod_resource\event\course_module_viewed', $event); + $this->assertEquals($context, $event->get_context()); + $moodleurl = new \moodle_url('/mod/resource/view.php', array('id' => $cm->id)); + $this->assertEquals($moodleurl, $event->get_url()); + $this->assertEventContextNotUsed($event); + $this->assertNotEmpty($event->get_name()); + + // Check completion status. + $completion = new completion_info($course); + $completiondata = $completion->get_data($cm); + $this->assertEquals(1, $completiondata->completionstate); + + } +} diff --git a/mod/resource/version.php b/mod/resource/version.php index cd1ba6a0ad8..5c44c7857f0 100644 --- a/mod/resource/version.php +++ b/mod/resource/version.php @@ -24,7 +24,7 @@ defined('MOODLE_INTERNAL') || die(); -$plugin->version = 2015051100; // The current module version (Date: YYYYMMDDXX) +$plugin->version = 2015051101; // The current module version (Date: YYYYMMDDXX) $plugin->requires = 2015050500; // Requires this Moodle version $plugin->component = 'mod_resource'; // Full name of the plugin (used for diagnostics) $plugin->cron = 0; diff --git a/mod/resource/view.php b/mod/resource/view.php index bc55f031870..74bf44d82e8 100644 --- a/mod/resource/view.php +++ b/mod/resource/view.php @@ -24,6 +24,7 @@ */ require('../../config.php'); +require_once($CFG->dirroot.'/mod/resource/lib.php'); require_once($CFG->dirroot.'/mod/resource/locallib.php'); require_once($CFG->libdir.'/completionlib.php'); @@ -52,19 +53,8 @@ require_course_login($course, true, $cm); $context = context_module::instance($cm->id); require_capability('mod/resource:view', $context); -$params = array( - 'context' => $context, - 'objectid' => $resource->id -); -$event = \mod_resource\event\course_module_viewed::create($params); -$event->add_record_snapshot('course_modules', $cm); -$event->add_record_snapshot('course', $course); -$event->add_record_snapshot('resource', $resource); -$event->trigger(); - -// Update 'viewed' state if required by completion system -$completion = new completion_info($course); -$completion->set_module_viewed($cm); +// Completion and trigger events. +resource_view($resource, $course, $cm, $context); $PAGE->set_url('/mod/resource/view.php', array('id' => $cm->id));