first commit

question/bank/exporttoxml/classes/export_xml_action.php

@@ -0,0 +1,59 @@
+<?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\question_action_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 extends question_action_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_menu_position(): int {
+        return 600;
+    }
+
+    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

@@ -0,0 +1,56 @@
+<?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

@@ -0,0 +1,37 @@
+<?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_actions($qbank): array {
+        return [
+            new export_xml_action($qbank)
+        ];
+    }
+
+}

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

@@ -0,0 +1,32 @@
+<?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

@@ -0,0 +1,82 @@
+<?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 core_question\local\bank\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

@@ -0,0 +1,27 @@
+<?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'] = 'The Export to xml question bank plugin does not store any personal data.';

question/bank/exporttoxml/lib.php

@@ -0,0 +1,46 @@
+<?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/>.
+
+/**
+ * Helper functions and callbacks.
+ *
+ * @package    qbank_exporttoxml
+ * @copyright  2023 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+use core\plugininfo\qbank;
+use qbank_exporttoxml\helper;
+
+/**
+ * Callback to add content to the question preview screen.
+ *
+ * @param question_definition $question the question being previewed.
+ * @param int $courseid the course id.
+ * @return string HTML to add to the question preview screen.
+ */
+function qbank_exporttoxml_preview_display(question_definition $question, int $courseid): string {
+    if (!qbank::is_plugin_enabled('qbank_exporttoxml')) {
+        return '';
+    }
+
+    if (!question_has_capability_on($question, 'view')) {
+        return '';
+    }
+
+    $exporturl = helper::question_get_export_single_question_url($question);
+    return html_writer::div(html_writer::link($exporturl, get_string('exportonequestion', 'question')));
+}

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

@@ -0,0 +1,29 @@
+@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" "mod_quiz > question bank" page
+    Then the "Export as Moodle XML" action should not exist for the "First question" question in the question bank
+    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" "mod_quiz > question bank" page
+    And the "Export as Moodle XML" action should exist for the "First question" question in the question bank

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

@@ -0,0 +1,27 @@
+@qbank @qbank_previewquestion
+Feature: A teacher can export a question as XML from the preview question screen
+  To help reuse questions
+  As a teacher
+  I can easily export the question I am previewing
+
+  Background:
+    Given the following "users" exist:
+      | username |
+      | teacher  |
+    And the following "courses" exist:
+      | fullname | shortname |
+      | Course 1 | C1        |
+    And the following "course enrolments" exist:
+      | user    | course | role           |
+      | teacher | C1     | editingteacher |
+    And the following "question categories" exist:
+      | name           | contextlevel | reference |
+      | Test questions | Course       | C1        |
+    And the following "questions" exist:
+      | questioncategory | qtype     | name                          |
+      | Test questions   | numerical | Test question to be previewed |
+
+  Scenario: Question preview shows the question and other information
+    When I am on the "Test question to be previewed" "core_question > preview" page logged in as teacher
+    Then the state of "What is pi to two d.p.?" question is shown as "Not yet answered"
+    And "Download this question in Moodle XML format" "link" should exist

question/bank/exporttoxml/tests/helper_test.php

@@ -0,0 +1,74 @@
+<?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(): void {
+        $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

@@ -0,0 +1,31 @@
+<?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   = 2024042200;
+$plugin->requires  = 2024041600;
+$plugin->maturity  = MATURITY_STABLE;