broken-save - Comments and tweaks

Author: EJMFarrow

db/upgrade.php

@@ -974,16 +974,15 @@ function xmldb_qtype_stack_upgrade($oldversion) {
         upgrade_plugin_savepoint(true, 2024043000, 'qtype', 'stack');
     }
 
-    if ($oldversion < 2025042300) {
+    if ($oldversion < 2025042500) {
         $table = new xmldb_table('qtype_stack_options');
         $field = new xmldb_field('isbroken', XMLDB_TYPE_INTEGER, '4', null, XMLDB_NOTNULL, null, '0', 'stackversion');
-        // Conditionally launch add field scientificnotation.
         if (!$dbman->field_exists($table, $field)) {
             $dbman->add_field($table, $field);
         }
 
         // STACK savepoint reached.
-        upgrade_plugin_savepoint(true, 2025042300, 'qtype', 'stack');
+        upgrade_plugin_savepoint(true, 2025042500, 'qtype', 'stack');
     }
     // Add new upgrade blocks just above here.
 

edit_stack_form.php

@@ -104,11 +104,14 @@ public function set_data($question) {
         }
 
         parent::set_data($question);
+        // If the question is broken we run validation when the form is loaded to display errors.
+        // We have to temporarily remove the broken flag from the form to stop the validation
+        // beign by-passed.
         if ($question->options->isbroken) {
             $mform = $this->_form;
-            $mform->setDefault('savebroken', 0);
+            $mform->setDefault('isbroken', 0);
             $this->is_validated();
-            $mform->setDefault('savebroken', 1);
+            $mform->setDefault('isbroken', 1);
         }
     }
 
@@ -174,11 +177,11 @@ protected function definition() {
                 stack_string('fixdollars'), stack_string('fixdollarslabel'));
         $mform->insertElementBefore($fixdollars, 'buttonar');
         $mform->addHelpButton('fixdollars', 'fixdollars', 'qtype_stack');
-        $savebroken = $mform->createElement('checkbox', 'savebroken',
-                stack_string('savebroken'), stack_string('savebrokenlabel'));
-        $mform->setDefault('savebroken', $this->question->options->isbroken);
-        $mform->insertElementBefore($savebroken, 'buttonar');
-        $mform->addHelpButton('savebroken', 'savebroken', 'qtype_stack');
+        $isbroken = $mform->createElement('checkbox', 'isbroken',
+                stack_string('isbroken'), stack_string('isbrokenlabel'));
+        $mform->setDefault('isbroken', $this->question->options->isbroken);
+        $mform->insertElementBefore($isbroken, 'buttonar');
+        $mform->addHelpButton('isbroken', 'isbroken', 'qtype_stack');
         $mform->closeHeaderBefore('fixdollars');
 
         // There is no un-closeHeaderBefore, so fake it.
@@ -830,6 +833,7 @@ protected function data_preprocessing_inputs($question) {
         foreach ($question->inputs as $inputname => $input) {
             $question->{$inputname . 'type'}               = $input->type;
             $question->{$inputname . 'modelans'}           = $input->tans;
+            // Cast to int required to avoid erroneous validation messages on loading a broken question.
             $question->{$inputname . 'boxsize'}            = (int) $input->boxsize;
             // TO-DO: remove this when we delete it from the DB.
             $question->{$inputname . 'strictsyntax'}       = true;
@@ -957,7 +961,9 @@ protected function prepare_text_field($field, $text, $format, $itemid, $filearea
     // phpcs:ignore moodle.Commenting.MissingDocblock.Function
     public function validation($fromform, $files) {
         $errors = parent::validation($fromform, $files);
-        if (empty($fromform['savebroken'])) {
+        // By-pass STACK-specific validation if question is marked as broken.
+        // Moodle validation still performed.
+        if (empty($fromform['isbroken'])) {
             $qtype = new qtype_stack();
             return $qtype->validate_fromform($fromform, $errors);
         } else {

lang/en/qtype_stack.php

@@ -141,9 +141,9 @@
 $string['fixdollarslabel'] = 'Replace <code>$...$</code> with <code>\(...\)</code>, <code>$$...$$</code> with <code>\[...\]</code> and <code>@...@</code> with <code>{@...@}</code> on save.';
 $string['fixdollars_help'] = 'This option is useful if are copying and pasting (or typing) TeX with <code>$...$</code> and <code>$$...$$</code> delimiters. Those delimiters will be replaced by the recommended delimiters during the save process.';
 $string['forbiddendoubledollars'] = 'Please use the delimiters <code>\(...\)</code> for inline maths and <code>\[...\]</code> for display maths. <code>$...$</code> and <code>$$...$$</code> are not permitted. There is an option at the end of the form to fix this automatically.';
-$string['savebroken'] = 'Save as broken';
-$string['savebrokenlabel'] = 'Mark the question as broken. This will allow the question to be saved even with errors but it will not be displayed.';
-$string['savebroken_help'] = 'This option allows you to save your work even if a question is incomplete or has errors. You or a colleague can then return to work on it later.';
+$string['isbroken'] = 'Save as broken';
+$string['isbrokenlabel'] = 'Mark the question as broken. This will allow the question to be saved even with errors but it will not be displayed to students.';
+$string['isbroken_help'] = 'This option allows you to save your work even if a question is incomplete or has errors. You or a colleague can then return to work on it later.';
 $string['forbidfloat'] = 'Forbid float';
 $string['forbidfloat_help'] = 'If set to yes, then any answer of the student which has a floating point number will be rejected as invalid.';
 $string['forbidfloat_link'] = '%%WWWROOT%%/question/type/stack/doc/doc.php/Authoring/Inputs.md#Forbid_Floats';

question.php

@@ -364,9 +364,13 @@ public function start_attempt(question_attempt_step $step, $variant) {
      * Once we know the random seed, we can initialise all the other parts of the question.
      */
     public function initialise_question_from_seed() {
+        // If the question is marked as broken skip straight to error output.
         // We can detect a logically faulty question by checking if the cache can
         // return anything if it can't then we can simply skip to the output of errors.
-        if ($this->get_cached('units') !== null) {
+        if ($this->isbroken) {
+            // Question is marked as broken. Students should not see it.
+            $this->runtimeerrors[stack_string('questionbroken')] = true;
+        } else if ($this->get_cached('units') !== null) {
             // Build up the question session out of all the bits that need to go into it.
             // 1. question variables.
             $session = new stack_cas_session2([], $this->options, $this->seed);
@@ -491,9 +495,6 @@ public function initialise_question_from_seed() {
             if ($session->get_valid()) {
                 $session->instantiate();
             }
-            if ($this->isbroken) {
-                $this->runtimeerrors[stack_string('questionbroken')] = true;
-            }
             if ($session->get_errors()) {
                 // In previous versions we threw an exception here.
                 // Upgrade and import stops errors being caught during validation when the question was edited or deployed.

questiontype.php

@@ -174,7 +174,7 @@ public function save_question_options($fromform) {
         $options->logicsymbol               = $fromform->logicsymbol;
         $options->matrixparens              = $fromform->matrixparens;
         $options->variantsselectionseed     = $fromform->variantsselectionseed;
-        $options->isbroken                  = !empty($fromform->savebroken) ? 1 : 0;
+        $options->isbroken                  = !empty($fromform->isbroken) ? 1 : 0;
 
         // We will not have the values for this.
         $options->compiledcache             = '{}';

stack/maxima/stackmaxima.mac

@@ -191,7 +191,7 @@ if is(MAXIMA_VERSION_NUM>30.0) then compile(scientific_notation)$
 texput(QMCHAR, "\\color{red}{?}");
 texput(theta, "\\theta");
 
-/* Issue #615 suggests we make matrix multiplication much more promenent. 
+/* Issue #615 suggests we make matrix multiplication much more promenent.
    This is possible, but would be confused with notation for Hadamard product.
 
    texput(".","\\circ ",infix);
@@ -3267,14 +3267,14 @@ hasAddConst(expr, vars) := block([othervars, const, deriv, allvariables, strict]
     if debug then print(["Variables in expression: ", othervars]),
 	for var in vars do othervars : delete(var,othervars),
     if debug then print(["Remaining variables after deletion: ", othervars]),
-    
+
 
     /* check number of candidates, should be exactly 1 */
     if length(othervars) = 0 then
         return([false, "ATAddConst_noconst"]),
     if length(othervars) > 1 then
         return([false, "ATAddConst_severalconst"]),
-    
+
     /* if there is one candidate, check if it's exactly additive or something else */
     const : othervars[1],
     deriv : ev(diff(expr,const), simp),
@@ -3507,4 +3507,4 @@ is_lang(code):=ev(is(%_STACK_LANG=code),simp=true)$
 
 /* Stack expects some output with the version number the output happens at */
 /* maximalocal.mac after additional library loading */
-stackmaximaversion:2025040200$
+stackmaximaversion:2025042500$

version.php

@@ -24,7 +24,7 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2025042300;
+$plugin->version   = 2025042500;
 $plugin->requires  = 2022041900;
 $plugin->cron      = 0;
 $plugin->component = 'qtype_stack';