XML edit

.github/workflows/moodle-ci.yml

@@ -8,7 +8,7 @@ jobs:
 
     services:
       postgres:
-        image: postgres:15
+        image: postgres:16
         env:
           POSTGRES_USER: 'postgres'
           POSTGRES_HOST_AUTH_METHOD: 'trust'
@@ -126,6 +126,7 @@ jobs:
           moodle-plugin-ci add-plugin maths/moodle-qbehaviour_dfexplicitvaildate
           moodle-plugin-ci add-plugin maths/moodle-qbehaviour_dfcbmexplicitvaildate
           moodle-plugin-ci add-plugin maths/moodle-qbehaviour_adaptivemultipart
+          moodle-plugin-ci add-plugin maths/moodle-qbank_importasversion
 
           moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
 
@@ -158,6 +159,7 @@ jobs:
           moodle-plugin-ci add-plugin maths/moodle-qbehaviour_dfexplicitvaildate
           moodle-plugin-ci add-plugin maths/moodle-qbehaviour_dfcbmexplicitvaildate
           moodle-plugin-ci add-plugin maths/moodle-qbehaviour_adaptivemultipart
+          moodle-plugin-ci add-plugin maths/moodle-qbank_importasversion
 
           moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
 

api/controller/DiffController.php

@@ -24,10 +24,10 @@
 
 namespace api\controller;
 defined('MOODLE_INTERNAL') || die();
-require_once(__DIR__ . '/../dtos/StackRenderResponse.php');
+require_once(__DIR__ . '/../dtos/StackDiffResponse.php');
 require_once(__DIR__ . '/../util/StackQuestionLoader.php');
 
-use api\dtos\StackRenderResponse;
+use api\dtos\StackDiffResponse;
 use api\util\StackQuestionLoader;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
@@ -39,11 +39,11 @@ public function __invoke(Request $request, Response $response, array $args): Res
         // TO-DO: Validate.
         $data = $request->getParsedBody();
 
-        $renderresponse = new StackRenderResponse();
+        $diffresponse = new StackDiffResponse();
         $diff = StackQuestionLoader::detect_differences($data["questionDefinition"]);
-        $renderresponse->diff = $diff;
+        $diffresponse->diff = $diff;
 
-        $response->getBody()->write(json_encode($renderresponse));
+        $response->getBody()->write(json_encode($diffresponse));
         return $response->withHeader('Content-Type', 'application/json');
     }
 }

api/questiondefaults.yml

@@ -9,7 +9,7 @@ question:
   penalty: '0.1'
   hidden: '0'
   idnumber: ''
-  stackversion: '2025042500'
+  stackversion: '2025102200'
   questionvariables: 'ta1:1;'
   specificfeedback: '<p>[[feedback:prt1]]</p>'
   specificfeedbackformat: html

api/util/StackQuestionLoader.php

@@ -121,7 +121,7 @@ public static function loadxml($xml, $includetests = false) {
         // Use (array) because isset($xmldata->question->defaultgrade) returns true if the element is empty and
         // empty() returns true if element is 0. Casting to array returns [] and [0] which return false and true respectively.
         $question->defaultmark = (array) $xmldata->question->defaultgrade ? (float) $xmldata->question->defaultgrade :
-            self::get_default('question', 'defaultgrade', 1.0);
+            self::get_default('question', 'defaultgrade', 1);
         $question->penalty = (array) $xmldata->question->penalty ? (float) $xmldata->question->penalty :
             self::get_default('question', 'penalty', 0.1);
 
@@ -164,7 +164,7 @@ public static function loadxml($xml, $includetests = false) {
                 self::get_default(
                     'question',
                     'prtcorrect',
-                    get_string('defaultprtcorrectfeedback', 'qtype_stack', null)
+                    get_config('qtype_stack', 'prtcorrect')
                 );
             $question->prtcorrectformat = self::get_default('question', 'prtcorrectformat', 'html');
         }
@@ -179,7 +179,7 @@ public static function loadxml($xml, $includetests = false) {
                 self::get_default(
                     'question',
                     'prtpartiallycorrect',
-                    get_string('defaultprtpartiallycorrectfeedback', 'qtype_stack', null)
+                    get_config('qtype_stack', 'prtpartiallycorrect')
                 );
             $question->prtpartiallycorrectformat =
                 self::get_default('question', 'prtpartiallycorrectformat', 'html');
@@ -195,7 +195,7 @@ public static function loadxml($xml, $includetests = false) {
                 self::get_default(
                     'question',
                     'prtincorrect',
-                    get_string('defaultprtincorrectfeedback', 'qtype_stack', null)
+                    get_config('qtype_stack', 'prtincorrect')
                 );
             $question->prtincorrectformat =
                 self::get_default('question', 'prtincorrectformat', 'html');
@@ -633,7 +633,7 @@ public static function yaml_to_xml($yamlstring) {
         // Name is a special case. Has text tag but no format.
         $name = (string) $xml->question->name ? (string) $xml->question->name : self::get_default('question', 'name', 'Default');
         $xml->question->name = new SimpleXMLElement('<root></root>');
-        $xml->question->name->addChild('text', $name);
+        $xml->question->name->text = $name;
         return $xml;
     }
 

doc/en/Developer/Development_history.md

@@ -2,6 +2,12 @@
 
 For current and future plans, see [Development track](Development_track.md) and [Future plans](Future_plans.md).
 
+## Version 4.12.0
+
+- Validation of XML imports. XML files that fail validation will be marked as broken but still imported where possible.
+- Editing of question XML within STACK from link in STACK dashboard. STACK now requires the importasversion plugin to make this possible.
+- Much code tidying to comply with updated to Moodle Code Checker.
+
 ## Version 4.11.0
 
 Released October 2025.

doc/en/Installation/index.md

@@ -62,7 +62,7 @@ Please note
 
 Instructions for installing a more recent version of Maxima on CentOS 6 are available on the [Moodle forum](https://moodle.org/mod/forum/discuss.php?d=270956)  (Oct 2014).
 
-## 3. Add some additional question behaviours
+## 3. Add some additional question behaviours and importasversion
 
 STACK requires these.
 
@@ -77,12 +77,17 @@ Alternatively, get the code using git by running the following command in the to
 Alternatively, get the code using git by running the following command in the top level folder of your Moodle install:
 
         git clone https://github.com/maths/moodle-qbehaviour_dfcbmexplicitvaildate.git question/behaviour/dfcbmexplicitvaildate
-2. Obtain adaptivemutlipart behaviour code. You can [download the zip file](https://github.com/maths/moodle-qbehaviour_adaptivemultipart/zipball/master), unzip it, and place it in the directory `moodle/question/behaviour/adaptivemultipart`. (You will need to rename the directory `moodle-qbehaviour_adaptivemultipart  -> adaptivemultipart`.)
+3. Obtain adaptivemutlipart behaviour code. You can [download the zip file](https://github.com/maths/moodle-qbehaviour_adaptivemultipart/zipball/master), unzip it, and place it in the directory `moodle/question/behaviour/adaptivemultipart`. (You will need to rename the directory `moodle-qbehaviour_adaptivemultipart  -> adaptivemultipart`.)
 
 Alternatively, get the code using git by running the following command in the top level folder of your Moodle install:
 
         git clone https://github.com/maths/moodle-qbehaviour_adaptivemultipart.git question/behaviour/adaptivemultipart
-3. Login to Moodle as the admin user and click on Notifications in the Site Administration panel.
+4. Obtain importasversion code. You can [download the zip file](https://github.com/maths/moodle-qbank_importasversion/archive/refs/heads/main.zip), unzip it, and place it in the directory `moodle/question/bank/importasversion`. (You will need to rename the directory `moodle-qbehaviour_importasversion  -> importasversion`.)
+
+Alternatively, get the code using git by running the following command in the top level folder of your Moodle install:
+
+        git clone https://github.com/maths/moodle-qbank_importasversion.git question/bank/importasversion
+5. Login to Moodle as the admin user and click on Notifications in the Site Administration panel.
 
 ## 4. Add the STACK question type
 
@@ -164,6 +169,12 @@ If STACK is already installed, as described above, it can be updated via git, li
         cd ..
         cd adaptivemultipart/
         git pull
+        cd ..
+        cd ..
+        cd bank/importasversion
+        git pull
+
+If upgrading from an older version of STACK, you may need to install the importasversion plugin as instructed in installation step 3.
 
 2. Then login as admin in your moodle and update the database.
 

lang/en/qtype_stack.php

@@ -471,7 +471,7 @@
 $string['settingcaspreparse_false'] = 'Do not preparse (not recommended)';
 $string['settingdefaultinputoptions'] = 'Default input options';
 $string['settingdefaultinputoptions_desc'] = 'Used when creating a new question, or adding a new input to an existing question.';
-$string['settingdefaultquestionoptions'] = 'Default input options';
+$string['settingdefaultquestionoptions'] = 'Default question options';
 $string['settingdefaultquestionoptions_desc'] = 'Used when creating a new question.';
 $string['settingmathsdisplay'] = 'Maths filter';
 $string['settingmathsdisplay_mathjax'] = 'MathJax';
@@ -622,6 +622,8 @@
 $string['exportthisquestion_help'] = 'This will create a Moodle XML export file containing just this one question. One example of when this is useful if you think this question demonstrates a bug in STACK that you would like to report to the developers.';
 $string['tidyquestion'] = '<i class="fa fa-sort-amount-asc"></i> Tidy inputs and PRTs';
 $string['sendgeneralfeedback'] = '<i class="fa fa-file-text"></i> Send general feedback to the CAS';
+$string['editxml'] = '<i class="fa fa-align-left"></i> Edit question XML';
+$string['reloadsavedXML'] = '<i class="fa fa-rotate-left"></i> Reload saved version of question';
 $string['seetodolist'] = '<i class="fa fa-exclamation-triangle"></i> Find <tt>[[todo]]</tt> blocks';
 $string['seetodolist_desc'] = 'The purpose of this page is to find all questions containing <tt>[[todo]]</tt> blocks and to group them by any tags. Questions that have been marked as broken will also be found and displayed.';
 $string['seetodolist_help'] = 'Clicking on the question name takes you to the dashboard.  You can also preview the question.';
@@ -640,7 +642,7 @@
 $string['splitsummary'] = 'Split summary';
 $string['variants'] = 'Variants';
 
-$string['importwillfail'] = 'Import will fail.';
+$string['importwillfail'] = 'This question cannot be saved or imported in its current state.';
 $string['noroots'] = 'The graph of this PRT has no roots. Does it have nodes?';
 $string['structuralproblem'] = 'The PRT structure is malformed.';
 $string['missingnextnode'] = 'The PRT structure is malformed. {$a->type} next node for PRT {$a->prt} node {$a->node} is invalid. It has been set to stop.';
@@ -666,6 +668,11 @@
 $string['clearedthecache'] = 'CAS cached has been cleared.';
 $string['clearingcachefiles'] = 'Clearing cached STACK plot files {$a->done}/{$a->total}';
 $string['clearthecache'] = 'Clear the cache';
+$string['editxmlintro'] = 'You can edit the XML of the question here and then save it as a new version of the question. Validation failures will result in a a warning being displayed and the saved question will be marked as broken (i.e. the <code>&lt;isbroken&gt;</code> tag will be set to 1). Serious issues with node layout may prevent the question from being saved. Missing question parts or invalid values are likely to cause an error. In most cases, you should see an error message and receive a warning that the question has not been saved. You can then edit your changes and try again. With great power comes great responsibility, however. If you are not careful with your XML, you will encounter issues and obscure error messages that you are protected from when using the normal question edit form. Please save frequently and/ or edit your question in another application to avoid losing work.';
+$string['editxmltitle'] = 'Edit question XML';
+$string['editxmlquestion'] = 'Question XML';
+$string['editxmlbutton'] = 'Save as new version and continue editing';
+$string['xmldisplayerror'] = ' There was a problem displaying the XML.';
 $string['healthcheck'] = 'STACK healthcheck';
 $string['healthcheck_desc'] = 'The <a href="{$a->link}">healthcheck script</a> helps you verify that all aspects of STACK are working properly.';
 $string['healthcheckcache_db'] = 'CAS results are being cached in the database.';

questiontestrun.php

@@ -91,6 +91,7 @@
 $exportparams['id'] = $question->id;
 
 $questionbanklinkedit = new moodle_url('/question/type/stack/questioneditlatest.php', $editparams);
+$questionxmllink = new moodle_url('/question/type/stack/questionxmledit.php', $editparams);
 $questionbanklink = new moodle_url('/question/edit.php', $qbankparams);
 $exportquestionlink = new moodle_url('/question/bank/exporttoxml/exportone.php', $exportparams);
 $exportquestionlink->param('sesskey', sesskey());
@@ -156,6 +157,11 @@
     stack_string('seetodolist'),
     ['class' => 'nav-link']
 );
+$links[] = html_writer::link(
+    $questionxmllink,
+    stack_string('editxml'),
+    ['class' => 'nav-link']
+);
 echo html_writer::tag('nav', implode(' ', $links), ['class' => 'nav']);
 
 flush();