From 734c7452d38744760c33faccf868e2296d900035 Mon Sep 17 00:00:00 2001 From: Juan Leyva Date: Wed, 20 May 2015 11:04:06 +0200 Subject: [PATCH] MDL-50008 folder: New Web Service mod_folder_view_folder --- lib/db/services.php | 1 + mod/folder/classes/external.php | 107 ++++++++++++++++++++++++ mod/folder/db/services.php | 39 +++++++++ mod/folder/tests/externallib_test.php | 112 ++++++++++++++++++++++++++ mod/folder/version.php | 2 +- version.php | 2 +- 6 files changed, 261 insertions(+), 2 deletions(-) create mode 100644 mod/folder/classes/external.php create mode 100644 mod/folder/db/services.php create mode 100644 mod/folder/tests/externallib_test.php diff --git a/lib/db/services.php b/lib/db/services.php index d270a7573bc..032c38af981 100644 --- a/lib/db/services.php +++ b/lib/db/services.php @@ -1141,6 +1141,7 @@ $services = array( 'core_user_add_user_private_files', 'mod_assign_view_grading_table', 'mod_scorm_view_scorm', + 'mod_folder_view_folder', ), 'enabled' => 0, 'restrictedusers' => 0, diff --git a/mod/folder/classes/external.php b/mod/folder/classes/external.php new file mode 100644 index 00000000000..c5478000478 --- /dev/null +++ b/mod/folder/classes/external.php @@ -0,0 +1,107 @@ +. + +/** + * folder external API + * + * @package mod_folder + * @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"); + +/** + * folder external functions + * + * @package mod_folder + * @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_folder_external extends external_api { + + /** + * Returns description of method parameters + * + * @return external_function_parameters + * @since Moodle 3.0 + */ + public static function view_folder_parameters() { + return new external_function_parameters( + array( + 'folderid' => new external_value(PARAM_INT, 'folder instance id') + ) + ); + } + + /** + * Simulate the folder/view.php web interface page: trigger events, completion, etc... + * + * @param int $folderid the folder instance id + * @return array of warnings and status result + * @since Moodle 3.0 + * @throws moodle_exception + */ + public static function view_folder($folderid) { + global $DB, $CFG; + require_once($CFG->dirroot . "/mod/folder/lib.php"); + + $params = self::validate_parameters(self::view_folder_parameters(), + array( + 'folderid' => $folderid + )); + $warnings = array(); + + // Request and permission validation. + $folder = $DB->get_record('folder', array('id' => $params['folderid']), '*', MUST_EXIST); + list($course, $cm) = get_course_and_cm_from_instance($folder, 'folder'); + + $context = context_module::instance($cm->id); + self::validate_context($context); + + require_capability('mod/folder:view', $context); + + // Call the page/lib API. + folder_view($folder, $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_folder_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/folder/db/services.php b/mod/folder/db/services.php new file mode 100644 index 00000000000..737ae35b34a --- /dev/null +++ b/mod/folder/db/services.php @@ -0,0 +1,39 @@ +. + +/** + * folder external functions and service definitions. + * + * @package mod_folder + * @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_folder_view_folder' => array( + 'classname' => 'mod_folder_external', + 'methodname' => 'view_folder', + 'description' => 'Simulate the view.php web interface folder: trigger events, completion, etc...', + 'type' => 'write', + 'capabilities' => 'mod/folder:view' + ), + +); diff --git a/mod/folder/tests/externallib_test.php b/mod/folder/tests/externallib_test.php new file mode 100644 index 00000000000..14c3cb50dfc --- /dev/null +++ b/mod/folder/tests/externallib_test.php @@ -0,0 +1,112 @@ +. + +/** + * External mod_folder functions unit tests + * + * @package mod_folder + * @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_folder functions unit tests + * + * @package mod_folder + * @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_folder_external_testcase extends externallib_advanced_testcase { + + /** + * Test view_folder + */ + public function test_view_folder() { + 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); + accesslib_clear_all_caches_for_unit_testing(); + + try { + mod_folder_external::view_folder($folder->id); + $this->fail('Exception expected due to missing capability.'); + } catch (moodle_exception $e) { + $this->assertEquals('nopermissions', $e->errorcode); + } + + } +} diff --git a/mod/folder/version.php b/mod/folder/version.php index f4699f2538a..ecfc2083917 100644 --- a/mod/folder/version.php +++ b/mod/folder/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_folder'; // Full name of the plugin (used for diagnostics) $plugin->cron = 0; diff --git a/version.php b/version.php index a152794e316..13f61c2dfee 100644 --- a/version.php +++ b/version.php @@ -29,7 +29,7 @@ defined('MOODLE_INTERNAL') || die(); -$version = 2015073000.00; // YYYYMMDD = weekly release date of this DEV branch. +$version = 2015073000.01; // YYYYMMDD = weekly release date of this DEV branch. // RR = release increments - 00 in DEV branches. // .XX = incremental changes. -- 2.17.1