MDL-26511 qtype_multianswer: Improve support for embedded files

Author: Fragonite

.upgradenotes/MDL-26511-2026050101120698.yml

@@ -0,0 +1,9 @@
+issueNumber: MDL-26511
+notes:
+  qtype_multianswer:
+    - message: >-
+        Improved embedded file support for qtype_multianswer (Cloze) questions.
+        This change is backwards compatible with existing and imported
+        questions, with a new adhoc task for migrating legacy files to the
+        correct file area.
+      type: improved

public/question/type/multianswer/backup/moodle2/restore_qtype_multianswer_plugin.class.php

@@ -136,6 +136,26 @@ public function after_execute_question() {
         $rs->close();
     }
 
+    /**
+     * Migrate legacy answer files once all restore file processing has completed.
+     */
+    public function after_restore_question() {
+        global $DB;
+
+        $restoredquestionids = $DB->get_fieldset_sql(
+            "SELECT qma.question
+               FROM {question_multianswer} qma
+               JOIN {backup_ids_temp} bi ON bi.newitemid = qma.question
+              WHERE bi.backupid = ?
+                AND bi.itemname = 'question_created'",
+            [$this->get_restoreid()]
+        );
+
+        if (!empty($restoredquestionids)) {
+            qtype_multianswer\task\copy_legacy_answer_files::copy_legacy_answer_files_to_questiontext($restoredquestionids);
+        }
+    }
+
     public function recode_response($questionid, $sequencenumber, array $response) {
         global $DB;
 

public/question/type/multianswer/classes/task/copy_legacy_answer_files.php

@@ -0,0 +1,119 @@
+<?php
+// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
+
+namespace qtype_multianswer\task;
+
+/**
+ * Migrate legacy Cloze files from child answer areas to the parent questiontext file area.
+ *
+ * Historically, files embedded in multichoice subquestions were stored within the child
+ * question itself. Modern versions consolidate these files into the parent question.
+ *
+ * Filenames must be unique within the new parent questiontext area. If a single
+ * question contains identically named but differing files across its child areas,
+ * only the first unique filename is preserved. As a result, the affected question
+ * may inadvertently render a duplicated file in place of the intended one.
+ *
+ * @package     qtype_multianswer
+ * @copyright   2026 Catalyst IT Australia Pty Ltd
+ * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class copy_legacy_answer_files extends \core\task\adhoc_task {
+    #[\Override]
+    public function execute() {
+        $customdata = (array) $this->get_custom_data();
+        $questionids = $customdata['questionids'] ?? [];
+
+        $copied = self::copy_legacy_answer_files_to_questiontext($questionids);
+        mtrace("Copied {$copied} legacy Cloze answer files to parent questiontext areas.");
+    }
+
+    /**
+     * Copy legacy files from embedded subquestion answer areas to the parent Cloze questiontext area.
+     * This process is immutable and idempotent as questions and files are not modified.
+     *
+     * @param array $questionids Optionally limit the query to specific questions for performance.
+     * @return int The number of files copied.
+     */
+    public static function copy_legacy_answer_files_to_questiontext(array $questionids = []): int {
+        global $DB;
+
+        if (!empty($questionids)) {
+            [$insql, $params] = $DB->get_in_or_equal($questionids, SQL_PARAMS_NAMED);
+            $questionjoin = "AND parent.id {$insql}";
+        } else {
+            $params = [];
+            $questionjoin = '';
+        }
+
+        // NOT EXISTS excludes already migrated and colliding filenames.
+        // GROUP BY deduplicates cases where answer and answerfeedback both carry the same filename.
+        $sql = "SELECT MIN(f.id) AS fileid,
+                       f.filepath,
+                       f.filename,
+                       parent.id AS parentid,
+                       parentcontext.contextid AS parentcontextid
+                  FROM {files} f
+                  JOIN {question_answers} qa ON qa.id = f.itemid
+                  JOIN {question} child ON child.id = qa.question
+                  JOIN {question} parent ON parent.id = child.parent
+                  JOIN {question_versions} parentversion ON parentversion.questionid = parent.id
+                  JOIN {question_bank_entries} parententry ON parententry.id = parentversion.questionbankentryid
+                  JOIN {question_categories} parentcontext ON parentcontext.id = parententry.questioncategoryid
+                 WHERE f.component = 'question'
+                       AND f.filearea IN ('answer', 'answerfeedback')
+                       AND f.filename <> '.'
+                       AND parent.qtype = 'multianswer'
+                       {$questionjoin}
+                       AND NOT EXISTS (
+                           SELECT 1
+                             FROM {files} target
+                            WHERE target.contextid = parentcontext.contextid
+                                  AND target.component = 'question'
+                                  AND target.filearea = 'questiontext'
+                                  AND target.itemid = parent.id
+                                  AND target.filepath = f.filepath
+                                  AND target.filename = f.filename
+                       )
+              GROUP BY f.filepath, f.filename, parent.id, parentcontext.contextid
+              ORDER BY f.filepath, f.filename, parent.id";
+
+        $fs = get_file_storage();
+        $copied = 0;
+        $files = $DB->get_recordset_sql($sql, $params);
+        try {
+            foreach ($files as $filedata) {
+                $file = $fs->get_file_by_id($filedata->fileid);
+                if (!$file) {
+                    continue;
+                }
+                $fs->create_file_from_storedfile([
+                    'contextid' => $filedata->parentcontextid,
+                    'component' => 'question',
+                    'filearea' => 'questiontext',
+                    'itemid' => $filedata->parentid,
+                    'filepath' => $filedata->filepath,
+                    'filename' => $filedata->filename,
+                ], $file);
+                $copied++;
+            }
+        } finally {
+            $files->close();
+        }
+
+        return $copied;
+    }
+}

public/question/type/multianswer/db/upgrade.php

@@ -52,5 +52,13 @@ function xmldb_qtype_multianswer_upgrade($oldversion) {
     // Automatically generated Moodle v5.2.0 release upgrade line.
     // Put any upgrade step following this.
 
+    if ($oldversion < 2026042001) {
+        mtrace('Queueing legacy Cloze answer file copy task.');
+        $task = new \qtype_multianswer\task\copy_legacy_answer_files();
+        \core\task\manager::queue_adhoc_task($task, true);
+
+        upgrade_plugin_savepoint(true, 2026042001, 'qtype', 'multianswer');
+    }
+
     return true;
 }

public/question/type/multianswer/questiontype.php

@@ -407,6 +407,10 @@ function qtype_multianswer_initialise_multichoice_subquestion($wrapped) {
 
 function qtype_multianswer_extract_question($text) {
     // Variable $text is an array [text][format][itemid].
+
+    $rewritefileurls = fn($content): string =>
+        empty($text['itemid']) ? $content : file_rewrite_urls_to_pluginfile($content, $text['itemid']);
+
     $question = new stdClass();
     $question->qtype = 'multianswer';
     $question->questiontext = $text;
@@ -498,7 +502,7 @@ function qtype_multianswer_extract_question($text) {
         $wrapped->answer   = array();
         $wrapped->fraction = array();
         $wrapped->feedback = array();
-        $wrapped->questiontext['text'] = $answerregs[0];
+        $wrapped->questiontext['text'] = $rewritefileurls($answerregs[0]);
         $wrapped->questiontext['format'] = FORMAT_HTML;
         $wrapped->questiontext['itemid'] = '';
         $answerindex = 0;
@@ -519,7 +523,7 @@ function qtype_multianswer_extract_question($text) {
                 $feedback = html_entity_decode(
                         $altregs[ANSWER_ALTERNATIVE_REGEX_FEEDBACK], ENT_QUOTES, 'UTF-8');
                 $feedback = str_replace('\}', '}', $feedback);
-                $wrapped->feedback["{$answerindex}"]['text'] = str_replace('\#', '#', $feedback);
+                $wrapped->feedback["{$answerindex}"]['text'] = $rewritefileurls(str_replace('\#', '#', $feedback));
                 $wrapped->feedback["{$answerindex}"]['format'] = FORMAT_HTML;
                 $wrapped->feedback["{$answerindex}"]['itemid'] = '';
             } else {
@@ -543,7 +547,7 @@ function qtype_multianswer_extract_question($text) {
                 $answer = html_entity_decode(
                         $altregs[ANSWER_ALTERNATIVE_REGEX_ANSWER], ENT_QUOTES, 'UTF-8');
                 $answer = str_replace('\}', '}', $answer);
-                $wrapped->answer["{$answerindex}"] = str_replace('\#', '#', $answer);
+                $wrapped->answer["{$answerindex}"] = $rewritefileurls(str_replace('\#', '#', $answer));
                 if ($wrapped->qtype == 'multichoice') {
                     $wrapped->answer["{$answerindex}"] = array(
                             'text' => $wrapped->answer["{$answerindex}"],

public/question/type/multianswer/renderer.php

@@ -151,6 +151,19 @@ abstract public function subquestion(question_attempt $qa,
             question_display_options $options, $index,
             question_graded_automatically $subq);
 
+    /**
+     * Format question text and process embedded files using the parent question context.
+     *
+     * @param question_attempt $qa the current attempt.
+     * @param string $text the text to format.
+     * @param int $format the text format.
+     * @return string formatted text.
+     */
+    protected function format_embedded_text(question_attempt $qa, string $text, int $format): string {
+        $question = $qa->get_question();
+        return $question->format_text($text, $format, $qa, 'question', 'questiontext', $question->id);
+    }
+
     /**
      * Render the feedback pop-up contents.
      *
@@ -327,15 +340,21 @@ public function subquestion(question_attempt $qa, question_display_options $opti
             $correctanswer = $subq->get_correct_answer();
         }
 
-        $feedbackpopup = $this->feedback_popup($subq, $matchinganswer->fraction,
-                $subq->format_text($matchinganswer->feedback, $matchinganswer->feedbackformat,
-                        $qa, 'question', 'answerfeedback', $matchinganswer->id),
-                s($correctanswer->answer), $options);
+        $feedbackpopup = $this->feedback_popup(
+            $subq,
+            $matchinganswer->fraction,
+            $this->format_embedded_text($qa, $matchinganswer->feedback, $matchinganswer->feedbackformat),
+            s($correctanswer->answer),
+            $options
+        );
 
         $output = html_writer::start_tag('span', ['class' => 'subquestion']);
 
-        $output .= html_writer::tag('label', $this->get_answer_label(),
-                array('class' => 'subq accesshide', 'for' => $inputattributes['id']));
+        $output .= html_writer::tag(
+            'label',
+            $this->get_answer_label(),
+            ['class' => 'subq accesshide', 'for' => $inputattributes['id']]
+        );
         $output .= html_writer::empty_tag('input', $inputattributes);
         $output .= $this->get_feedback_image($feedbackimg, $feedbackpopup);
         $output .= html_writer::end_tag('span');
@@ -368,8 +387,7 @@ public function subquestion(question_attempt $qa, question_display_options $opti
         $rightanswer = null;
         foreach ($subq->get_order($qa) as $value => $ansid) {
             $ans = $subq->answers[$ansid];
-            $choices[$value] = $subq->format_text($ans->answer, $ans->answerformat,
-                    $qa, 'question', 'answer', $ansid);
+            $choices[$value] = $this->format_embedded_text($qa, $ans->answer, $ans->answerformat);
             if ($subq->is_choice_selected($response, $value)) {
                 $matchinganswer = $ans;
             }
@@ -397,15 +415,20 @@ public function subquestion(question_attempt $qa, question_display_options $opti
         if (!$matchinganswer) {
             $matchinganswer = new question_answer(0, '', null, '', FORMAT_HTML);
         }
-        $feedbackpopup = $this->feedback_popup($subq, $matchinganswer->fraction,
-                $subq->format_text($matchinganswer->feedback, $matchinganswer->feedbackformat,
-                        $qa, 'question', 'answerfeedback', $matchinganswer->id),
-                $subq->format_text($rightanswer->answer, $rightanswer->answerformat,
-                        $qa, 'question', 'answer', $rightanswer->id), $options);
+        $feedbackpopup = $this->feedback_popup(
+            $subq,
+            $matchinganswer->fraction,
+            $this->format_embedded_text($qa, $matchinganswer->feedback, $matchinganswer->feedbackformat),
+            $this->format_embedded_text($qa, $rightanswer->answer, $rightanswer->answerformat),
+            $options
+        );
 
         $output = html_writer::start_tag('span', array('class' => 'subquestion'));
-        $output .= html_writer::tag('label', $this->get_answer_label(),
-                array('class' => 'subq accesshide', 'for' => $inputattributes['id']));
+        $output .= html_writer::tag(
+            'label',
+            $this->get_answer_label(),
+            ['class' => 'subq accesshide', 'for' => $inputattributes['id']]
+        );
         $output .= $select;
         $output .= $this->get_feedback_image($feedbackimg, $feedbackpopup);
         $output .= html_writer::end_tag('span');
@@ -468,16 +491,19 @@ public function subquestion(question_attempt $qa, question_display_options $opti
 
             $result .= $this->choice_wrapper_start($class);
             $result .= html_writer::empty_tag('input', $inputattributes);
-            $result .= html_writer::tag('label', $subq->format_text($ans->answer,
-                    $ans->answerformat, $qa, 'question', 'answer', $ansid),
-                    array('for' => $inputattributes['id'], 'class' => 'form-check-label text-body'));
+            $result .= html_writer::tag(
+                'label',
+                $this->format_embedded_text($qa, $ans->answer, $ans->answerformat),
+                ['for' => $inputattributes['id'], 'class' => 'form-check-label text-body']
+            );
             $result .= $feedbackimg;
 
             if ($options->feedback && $isselected && trim($ans->feedback)) {
-                $result .= html_writer::tag('div',
-                        $subq->format_text($ans->feedback, $ans->feedbackformat,
-                                $qa, 'question', 'answerfeedback', $ansid),
-                        array('class' => 'specificfeedback'));
+                $result .= html_writer::tag(
+                    'div',
+                    $this->format_embedded_text($qa, $ans->feedback, $ans->feedbackformat),
+                    ['class' => 'specificfeedback']
+                );
             }
 
             $result .= $this->choice_wrapper_end();
@@ -499,9 +525,11 @@ public function subquestion(question_attempt $qa, question_display_options $opti
             foreach ($subq->answers as $ans) {
                 if (question_state::graded_state_for_fraction($ans->fraction) ==
                         question_state::$gradedright) {
-                    $feedback[] = get_string('correctansweris', 'qtype_multichoice',
-                            $subq->format_text($ans->answer, $ans->answerformat,
-                                    $qa, 'question', 'answer', $ansid));
+                    $feedback[] = get_string(
+                        'correctansweris',
+                        'qtype_multichoice',
+                        $this->format_embedded_text($qa, $ans->answer, $ans->answerformat)
+                    );
                     break;
                 }
             }
@@ -661,16 +689,19 @@ public function subquestion(question_attempt $qa, question_display_options $opti
 
             $result .= $this->choice_wrapper_start($class);
             $result .= html_writer::empty_tag('input', $inputattributes);
-            $result .= html_writer::tag('label', $subq->format_text($ans->answer,
-                                                                    $ans->answerformat, $qa, 'question', 'answer', $ansid),
-                                        ['for' => $inputattributes['id'], 'class' => 'form-check-label text-body']);
+            $result .= html_writer::tag(
+                'label',
+                $this->format_embedded_text($qa, $ans->answer, $ans->answerformat),
+                ['for' => $inputattributes['id'], 'class' => 'form-check-label text-body']
+            );
             $result .= $feedbackimg;
 
             if ($options->feedback && $isselected && trim($ans->feedback)) {
-                $result .= html_writer::tag('div',
-                                            $subq->format_text($ans->feedback, $ans->feedbackformat,
-                                                               $qa, 'question', 'answerfeedback', $ansid),
-                                            array('class' => 'specificfeedback'));
+                $result .= html_writer::tag(
+                    'div',
+                    $this->format_embedded_text($qa, $ans->feedback, $ans->feedbackformat),
+                    ['class' => 'specificfeedback']
+                );
             }
 
             $result .= $this->choice_wrapper_end();
@@ -692,7 +723,7 @@ public function subquestion(question_attempt $qa, question_display_options $opti
             $correct = [];
             foreach ($subq->answers as $ans) {
                 if (question_state::graded_state_for_fraction($ans->fraction) != question_state::$gradedwrong) {
-                    $correct[] = $subq->format_text($ans->answer, $ans->answerformat, $qa, 'question', 'answer', $ans->id);
+                    $correct[] = $this->format_embedded_text($qa, $ans->answer, $ans->answerformat);
                 }
             }
             $correct = '<ul><li>'.implode('</li><li>', $correct).'</li></ul>';