MDL-68076 core: webservice to get the feedback url
authorShamim Rezaie <shamim@moodle.com>
Sun, 3 May 2020 06:05:19 +0000 (16:05 +1000)
committerShamim Rezaie <shamim@moodle.com>
Thu, 4 Jun 2020 01:38:46 +0000 (11:38 +1000)
lib/classes/external/userfeedback/generate_url.php [new file with mode: 0644]
lib/db/services.php
lib/tests/external/userfeedback/generate_url_test.php [new file with mode: 0644]
version.php

diff --git a/lib/classes/external/userfeedback/generate_url.php b/lib/classes/external/userfeedback/generate_url.php
new file mode 100644 (file)
index 0000000..821e3c8
--- /dev/null
@@ -0,0 +1,98 @@
+<?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/>.
+
+/**
+ * External API to generate and return the URL of the feedback site.
+ *
+ * @package    core
+ * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\external\userfeedback;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once("$CFG->libdir/externallib.php");
+
+use external_api;
+use external_function_parameters;
+use external_value;
+use external_single_structure;
+use external_multiple_structure;
+
+/**
+ * The external API to generate and return the feedback url.
+ *
+ * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class generate_url extends external_api {
+    /**
+     * Returns description of parameters.
+     *
+     * @return external_function_parameters
+     */
+    public static function execute_parameters() {
+        return new external_function_parameters([
+            'contextid' => new external_value(PARAM_INT, 'The context id of the page the user is in'),
+        ]);
+    }
+
+    /**
+     * Prepare and return the URL of the feedback site
+     *
+     * @param int $contextid The context id
+     * @return \stdClass
+     */
+    public static function execute(int $contextid) {
+        global $CFG, $PAGE;
+
+        require_once($CFG->libdir . '/adminlib.php');
+
+        external_api::validate_parameters(self::execute_parameters(), ['contextid' => $contextid]);
+
+        $context = \context::instance_by_id($contextid);
+        self::validate_context($context);
+        $PAGE->set_context($context);
+
+        $baseurl = $CFG->userfeedback_url ?? 'https://feedback.moodle.org/lms';
+        $lang = clean_param(current_language(), PARAM_LANG); // Avoid breaking WS because of incorrect package langs.
+        $moodleurl = $CFG->wwwroot;
+        $moodleversion = $CFG->release;
+        $theme = $PAGE->theme->name;
+        $themeversion = get_component_version('theme_' . $theme);
+
+        $firstseparator = strpos($baseurl, '?') === false ? '?' : '&';
+
+        $url = $baseurl . $firstseparator . 'lang=' . $lang;
+        $url .= '&moodle_url=' . rawurlencode($moodleurl) .
+                '&moodle_version=' . rawurlencode($moodleversion) .
+                '&theme=' . rawurlencode($theme) .
+                '&theme_version=' . $themeversion;
+
+        return $url;
+    }
+
+    /**
+     * Returns description of method result value
+     *
+     * @return external_value
+     */
+    public static function execute_returns() {
+        return new external_value(PARAM_URL, 'Feedback site\'s URL');
+    }
+}
index 3a1521d..71d22db 100644 (file)
@@ -2809,6 +2809,16 @@ $functions = array(
         'ajax'          => 'true',
         'capabilities'  => '',
     ],
+    'core_get_userfeedback_url' => [
+        'classname'     => 'core\external\userfeedback\generate_url',
+        'methodname'    => 'execute',
+        'classpath'     => '',
+        'description'   => 'Generate a dynamic URL for the external user feedback site.' .
+                           ' The URL includes some parameters to pre-fill the user feedback form.',
+        'type'          => 'read',
+        'ajax'          => 'true',
+        'capabilities'  => '',
+    ],
 );
 
 $services = array(
diff --git a/lib/tests/external/userfeedback/generate_url_test.php b/lib/tests/external/userfeedback/generate_url_test.php
new file mode 100644 (file)
index 0000000..c205038
--- /dev/null
@@ -0,0 +1,118 @@
+<?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/>.
+
+/**
+ * External functions test for generate_url.
+ *
+ * @package    core
+ * @category   test
+ * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\external\userfeedback;
+
+defined('MOODLE_INTERNAL') || die();
+
+use externallib_advanced_testcase;
+use context_system;
+use context_course;
+use external_api;
+
+global $CFG;
+
+require_once($CFG->dirroot . '/webservice/tests/helpers.php');
+
+/**
+ * Class generate_url_testcase
+ *
+ * @copyright  2020 Shamim Rezaie <shamim@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @coversDefaultClass generate_url
+ */
+class generate_url_testcase extends externallib_advanced_testcase {
+
+    /**
+     * Test the behaviour of generate_url().
+     *
+     * @covers ::execute
+     */
+    public function test_record_action_system() {
+        $this->resetAfterTest();
+
+        $course = $this->getDataGenerator()->create_course();
+        $user = $this->getDataGenerator()->create_and_enrol($course, 'student');
+        $context = context_system::instance();
+
+        $this->setUser($user);
+
+        // Call the WS and check the requested data is returned as expected.
+        $result = generate_url::execute($context->id);
+        $result = external_api::clean_returnvalue(generate_url::execute_returns(), $result);
+
+        $this->assertStringStartsWith('https://feedback.moodle.org/lms', $result);
+        $this->assertStringContainsString('?lang=en', $result);
+        $this->assertStringContainsString('&moodle_url=https%3A%2F%2Fwww.example.com%2Fmoodle', $result);
+        $this->assertStringContainsString('&theme=boost', $result);
+    }
+
+    /**
+     * Test the behaviour of generate_url() in a course with a course theme.
+     *
+     * @covers ::execute
+     */
+    public function test_record_action_course_theme() {
+        $this->resetAfterTest();
+
+        // Enable course themes.
+        set_config('allowcoursethemes', 1);
+
+        $course = $this->getDataGenerator()->create_course(['theme' => 'classic']);
+        $user = $this->getDataGenerator()->create_and_enrol($course, 'student');
+        $context = context_course::instance($course->id);
+
+        $this->setUser($user);
+
+        // Call the WS and check the requested data is returned as expected.
+        $result = generate_url::execute($context->id);
+        $result = external_api::clean_returnvalue(generate_url::execute_returns(), $result);
+
+        $this->assertStringContainsString('&theme=classic', $result);
+    }
+
+    /**
+     * Test the behaviour of generate_url() when a custom feedback url is set.
+     *
+     * @covers ::execute
+     */
+    public function test_record_action_custom_feedback_url() {
+        $this->resetAfterTest();
+
+        // Enable course themes.
+        set_config('userfeedback_url', 'https://feedback.moodle.org/abc');
+
+        $user = $this->getDataGenerator()->create_user();
+        $context = context_system::instance();
+
+        $this->setUser($user);
+
+        // Call the WS and check the requested data is returned as expected.
+        $result = generate_url::execute($context->id);
+        $result = external_api::clean_returnvalue(generate_url::execute_returns(), $result);
+
+        $this->assertStringStartsWith('https://feedback.moodle.org/abc', $result);
+    }
+}
index 17fac9b..9dec882 100644 (file)
@@ -29,7 +29,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$version  = 2020052900.01;              // YYYYMMDD      = weekly release date of this DEV branch.
+$version  = 2020052900.02;              // YYYYMMDD      = weekly release date of this DEV branch.
                                         //         RR    = release increments - 00 in DEV branches.
                                         //           .XX = incremental changes.
 $release  = '3.9dev+ (Build: 20200529)'; // Human-friendly version name