MDL-71639 qbank_exporttoxml: Add Export to xml plugin to core

This implementation will introduce a qbank plugin "exporttoxml"
which will implement the export to xml action in the question
bank view by replacing the core class. Having this plugin will
give users the flexibility of enabling or disabling this action.

lib/classes/plugin_manager.php

@@ -1941,6 +1941,7 @@ class core_plugin_manager {
             'qbank' => [
                 'deletequestion',
                 'editquestion',
+                'exporttoxml',
                 'exportquestions',
                 'importquestions',
                 'viewcreator',

lib/questionlib.php

@@ -2357,24 +2357,14 @@ function question_make_export_url($contextid, $categoryid, $format, $withcategor
  *      question_bank::load_question_data() or question_bank::make_question().
  *      (Only ->id and ->contextid are used.)
  * @return moodle_url the requested URL.
+ * @deprecated since Moodle 4.0
+ * @see \qbank_exporttoxml\helper::question_get_export_single_question_url()
+ * @todo Final deprecation on Moodle 4.4 MDL-72438
  */
 function question_get_export_single_question_url($question) {
-    $params = ['id' => $question->id, 'sesskey' => sesskey()];
-    $context = context::instance_by_id($question->contextid);
-    switch ($context->contextlevel) {
-        case CONTEXT_MODULE:
-            $params['cmid'] = $context->instanceid;
-            break;
-
-        case CONTEXT_COURSE:
-            $params['courseid'] = $context->instanceid;
-            break;
-
-        default:
-            $params['courseid'] = SITEID;
-    }
-
-    return new moodle_url('/question/exportone.php', $params);
+    debugging('Function question_get_export_single_question_url() has been deprecated and moved to qbank_exporttoxml plugin,
+     please use qbank_exporttoxml\helper::question_get_export_single_question_url() instead.', DEBUG_DEVELOPER);
+    qbank_exporttoxml\helper::question_get_export_single_question_url($question);
 }
 
 /**

lib/tests/questionlib_test.php

@@ -2068,36 +2068,6 @@ class core_questionlib_testcase extends advanced_testcase {
         $this->assertCount(2, $parentcategories);
     }
 
-    public function test_question_get_export_single_question_url() {
-        $generator = $this->getDataGenerator();
-
-        // Create a course and an activity.
-        $course = $generator->create_course();
-        $quiz = $generator->create_module('quiz', ['course' => $course->id]);
-
-        // Create a question in each place.
-        $questiongenerator = $generator->get_plugin_generator('core_question');
-        $courseqcat = $questiongenerator->create_question_category(['contextid' => context_course::instance($course->id)->id]);
-        $courseq = $questiongenerator->create_question('truefalse', null, ['category' => $courseqcat->id]);
-        $quizqcat = $questiongenerator->create_question_category(['contextid' => context_module::instance($quiz->cmid)->id]);
-        $quizq = $questiongenerator->create_question('truefalse', null, ['category' => $quizqcat->id]);
-        $systemqcat = $questiongenerator->create_question_category();
-        $systemq = $questiongenerator->create_question('truefalse', null, ['category' => $systemqcat->id]);
-
-        // Verify some URLs.
-        $this->assertEquals(new moodle_url('/question/exportone.php',
-                ['id' => $courseq->id, 'courseid' => $course->id, 'sesskey' => sesskey()]),
-                question_get_export_single_question_url(question_bank::load_question_data($courseq->id)));
-
-        $this->assertEquals(new moodle_url('/question/exportone.php',
-                ['id' => $quizq->id, 'cmid' => $quiz->cmid, 'sesskey' => sesskey()]),
-                question_get_export_single_question_url(question_bank::load_question($quizq->id)));
-
-        $this->assertEquals(new moodle_url('/question/exportone.php',
-                ['id' => $systemq->id, 'courseid' => SITEID, 'sesskey' => sesskey()]),
-                question_get_export_single_question_url(question_bank::load_question($systemq->id)));
-    }
-
     /**
      * Get test cases for test_core_question_find_next_unused_idnumber.
      *

question/bank/exporttoxml/classes/export_xml_action_column.php

+<?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/>.
+
+namespace qbank_exporttoxml;
+
+use core_question\local\bank\menu_action_column_base;
+
+/**
+ * Question bank column export the question in Moodle XML format.
+ *
+ * @package   qbank_exporttoxml
+ * @copyright 2019 The Open University
+ * @author    2021 Safat Shahin <safatshahin@catalyst-au.net>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class export_xml_action_column extends menu_action_column_base {
+
+    /** @var string avoids repeated calls to get_string('duplicate'). */
+    protected $strexportasxml;
+
+    public function init(): void {
+        parent::init();
+        $this->strexportasxml = get_string('exportasxml', 'question');
+    }
+
+    public function get_name(): string {
+        return 'exportasxmlaction';
+    }
+
+    protected function get_url_icon_and_label(\stdClass $question): array {
+        if (!\question_bank::is_qtype_installed($question->qtype)) {
+            // It sometimes happens that people end up with junk questions
+            // in their question bank of a type that is no longer installed.
+            // We cannot do most actions on them, because that leads to errors.
+            return [null, null, null];
+        }
+
+        if (!question_has_capability_on($question, 'view')) {
+            return [null, null, null];
+        }
+
+        return [helper::question_get_export_single_question_url($question),
+                't/download', $this->strexportasxml];
+    }
+
+}

question/bank/exporttoxml/classes/helper.php

+<?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/>.
+
+namespace qbank_exporttoxml;
+
+/**
+ * Class helper for export plugin.
+ *
+ * @package    qbank_exporttoxml
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Safat Shahin <safatshahin@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class helper {
+
+    /**
+     * Get the URL to export a single question (exportone.php).
+     *
+     * @param \stdClass|\question_definition $question the question definition as obtained from
+     *      question_bank::load_question_data() or question_bank::make_question().
+     *      (Only ->id and ->contextid are used.)
+     * @return \moodle_url the requested URL.
+     */
+    public static function question_get_export_single_question_url($question): \moodle_url {
+        $params = ['id' => $question->id, 'sesskey' => sesskey()];
+        $context = \context::instance_by_id($question->contextid);
+        switch ($context->contextlevel) {
+            case CONTEXT_MODULE:
+                $params['cmid'] = $context->instanceid;
+                break;
+
+            case CONTEXT_COURSE:
+                $params['courseid'] = $context->instanceid;
+                break;
+
+            default:
+                $params['courseid'] = SITEID;
+        }
+
+        return new \moodle_url('/question/bank/exporttoxml/exportone.php', $params);
+    }
+
+}

question/bank/exporttoxml/classes/plugin_feature.php

+<?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/>.
+
+namespace qbank_exporttoxml;
+
+use core_question\local\bank\plugin_features_base;
+
+/**
+ * Class plugin_feature is the entrypoint for the columns.
+ *
+ * @package    qbank_exporttoxml
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Safat Shahin <safatshahin@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class plugin_feature extends plugin_features_base {
+
+    public function get_question_columns($qbank): array {
+        return [
+            new export_xml_action_column($qbank)
+        ];
+    }
+
+}

question/bank/exporttoxml/classes/privacy/provider.php

+<?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/>.
+
+namespace qbank_exporttoxml\privacy;
+
+/**
+ * Privacy Subsystem for qbank_exporttoxml implementing null_provider.
+ *
+ * @package    qbank_exporttoxml
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Safat Shahin <safatshahin@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider {
+
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}

question/bank/exporttoxml/exportone.php

+<?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/>.
+
+/**
+ * Script to download the export of a single question.
+ *
+ * @package    qbank_exporttoxml
+ * @copyright  2015 the Open University
+ * @author     Safat Shahin <safatshahin@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once(__DIR__ . '/../../../config.php');
+require_once($CFG->libdir . '/questionlib.php');
+require_once($CFG->dirroot . '/question/format/xml/format.php');
+
+// Get the parameters from the URL.
+$questionid = required_param('id', PARAM_INT);
+$cmid = optional_param('cmid', 0, PARAM_INT);
+$courseid = optional_param('courseid', 0, PARAM_INT);
+$urlparams = ['id' => $questionid, 'sesskey' => sesskey()];
+
+\core_question\local\bank\helper::require_plugin_enabled('qbank_exporttoxml');
+
+if ($cmid) {
+    $cm = get_coursemodule_from_id(null, $cmid);
+    require_login($cm->course, false, $cm);
+    $thiscontext = context_module::instance($cmid);
+    $urlparams['cmid'] = $cmid;
+} else if ($courseid) {
+    require_login($courseid, false);
+    $thiscontext = context_course::instance($courseid);
+    $urlparams['courseid'] = $courseid;
+} else {
+    throw new moodle_exception('missingcourseorcmid', 'question');
+}
+require_sesskey();
+
+// Load the necessary data.
+$contexts = new question_edit_contexts($thiscontext);
+$questiondata = question_bank::load_question_data($questionid);
+
+// Check permissions.
+question_require_capability_on($questiondata, 'view');
+
+// Initialise $PAGE. Nothing is output, so this does not really matter. Just avoids notices.
+$nexturl = new moodle_url('/question/type/stack/questiontestrun.php', $urlparams);
+$PAGE->set_url('/question/bank/exporttoxml/exportone.php', $urlparams);
+$PAGE->set_heading($COURSE->fullname);
+$PAGE->set_pagelayout('admin');
+
+// Set up the export format.
+$qformat = new qformat_xml();
+$filename = question_default_export_filename($COURSE, $questiondata) .
+        $qformat->export_file_extension();
+$qformat->setContexts($contexts->having_one_edit_tab_cap('export'));
+$qformat->setCourse($COURSE);
+$qformat->setQuestions([$questiondata]);
+$qformat->setCattofile(false);
+$qformat->setContexttofile(false);
+
+// Do the export.
+if (!$qformat->exportpreprocess()) {
+    send_file_not_found();
+}
+if (!$content = $qformat->exportprocess(true)) {
+    send_file_not_found();
+}
+send_file($content, $filename, 0, 0, true, true, $qformat->mime_type());

question/bank/exporttoxml/lang/en/qbank_exporttoxml.php

+<?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/>.
+
+/**
+ * Strings for component qbank_exporttoxml, language 'en'
+ *
+ * @package    qbank_exporttoxml
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Safat Shahin <safatshahin@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['pluginname'] = 'Export to XML';
+$string['privacy:metadata'] = 'Export to xml question bank plugin does not store any user data.';

question/bank/exporttoxml/tests/behat/export_to_xml_action.feature

+@qbank @qbank_exporttoxml
+Feature: Use the qbank plugin manager page for exporttoxml
+  In order to check the plugin behaviour with enable and disable
+
+  Background:
+    Given the following "courses" exist:
+      | fullname | shortname | category |
+      | Course 1 | C1        | 0        |
+    And the following "activities" exist:
+      | activity   | name      | course | idnumber |
+      | quiz       | Test quiz | C1     | quiz1    |
+    And the following "question categories" exist:
+      | contextlevel | reference | name           |
+      | Course         | C1     | Test questions |
+    And the following "questions" exist:
+      | questioncategory | qtype     | name           | questiontext              |
+      | Test questions   | truefalse | First question | Answer the first question |
+
+  Scenario: Enable/disable exporttoxml column from the base view
+    Given I log in as "admin"
+    When I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I should see "Export to XML"
+    And I click on "Disable" "link" in the "Export to XML" "table_row"
+    And I am on the "Test quiz" "quiz activity" page
+    And I navigate to "Question bank > Questions" in current page administration
+    And I click on "#action-menu-toggle-2" "css_element" in the "First question" "table_row"
+    Then I should not see "Export as Moodle XML"
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I click on "Enable" "link" in the "Export to XML" "table_row"
+    And I am on the "Test quiz" "quiz activity" page
+    And I navigate to "Question bank > Questions" in current page administration
+    And I click on "#action-menu-toggle-2" "css_element" in the "First question" "table_row"
+    And I should see "Export as Moodle XML"

question/bank/exporttoxml/tests/helper_test.php

+<?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/>.
+
+namespace qbank_exporttoxml;
+
+use context_course;
+use context_module;
+use moodle_url;
+use question_bank;
+
+/**
+ * Class helper unit tests.
+ *
+ * @package    qbank_exporttoxml
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Safat Shahin <safatshahin@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @coversDefaultClass \qbank_exporttoxml\helper
+ */
+class helper_test extends \advanced_testcase {
+
+    /**
+     * Test the export single question url.
+     *
+     * @covers ::question_get_export_single_question_url
+     */
+    public function test_question_get_export_single_question_url() {
+        $this->resetAfterTest();
+        $generator = $this->getDataGenerator();
+
+        // Create a course and an activity.
+        $course = $generator->create_course();
+        $quiz = $generator->create_module('quiz', ['course' => $course->id]);
+
+        // Create a question in each place.
+        $questiongenerator = $generator->get_plugin_generator('core_question');
+        $courseqcat = $questiongenerator->create_question_category(['contextid' => context_course::instance($course->id)->id]);
+        $courseq = $questiongenerator->create_question('truefalse', null, ['category' => $courseqcat->id]);
+        $quizqcat = $questiongenerator->create_question_category(['contextid' => context_module::instance($quiz->cmid)->id]);
+        $quizq = $questiongenerator->create_question('truefalse', null, ['category' => $quizqcat->id]);
+        $systemqcat = $questiongenerator->create_question_category();
+        $systemq = $questiongenerator->create_question('truefalse', null, ['category' => $systemqcat->id]);
+
+        // Verify some URLs.
+        $this->assertEquals(new moodle_url('/question/bank/exporttoxml/exportone.php',
+                ['id' => $courseq->id, 'courseid' => $course->id, 'sesskey' => sesskey()]),
+                helper::question_get_export_single_question_url(
+                        question_bank::load_question_data($courseq->id)));
+
+        $this->assertEquals(new moodle_url('/question/bank/exporttoxml/exportone.php',
+                ['id' => $quizq->id, 'cmid' => $quiz->cmid, 'sesskey' => sesskey()]),
+                helper::question_get_export_single_question_url(
+                        question_bank::load_question($quizq->id)));
+
+        $this->assertEquals(new moodle_url('/question/bank/exporttoxml/exportone.php',
+                ['id' => $systemq->id, 'courseid' => SITEID, 'sesskey' => sesskey()]),
+                helper::question_get_export_single_question_url(
+                        question_bank::load_question($systemq->id)));
+    }
+
+}

question/bank/exporttoxml/version.php

+<?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/>.
+
+/**
+ * Version information for qbank_exporttoxml.
+ *
+ * @package    qbank_exporttoxml
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Safat Shahin <safatshahin@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->component = 'qbank_exporttoxml';
+$plugin->version   = 2021083100;
+$plugin->requires  = 2021052500;
+$plugin->maturity  = MATURITY_STABLE;

question/classes/bank/export_xml_action_column.php

@@ -58,7 +58,7 @@ class export_xml_action_column extends menu_action_column_base {
             return [null, null, null];
         }
 
-        return [question_get_export_single_question_url($question),
+        return [\qbank_exporttoxml\helper::question_get_export_single_question_url($question),
                 't/download', $this->strexportasxml];
     }
 }

question/upgrade.txt

@@ -7,6 +7,10 @@ This files describes API changes for code that uses the question API.
    classes are moved classes/local/bank and all the feature classes will be moved to
    the plugin for that feature.
 
+2) Function question_get_export_single_question_url() in questionlib has been deprecated
+   and moved to qbank_exporttoxml plugin, the new location is:
+   qbank_exporttoxml\exporttoxml_helper::question_get_export_single_question_url().
+
 === 3.9 ==
 
 1) For years, the ..._questions_in_use callback has been the right way for plugins to