feat: render a read-only view of response editor content

Author: MHajoha

classes/local/attempt_ui/qpy_rich_text_editor.php

@@ -19,15 +19,18 @@
 use core\context;
 use core\di;
 use core\exception\coding_exception;
+use DOMDocumentFragment;
 use DOMElement;
 use DOMNode;
 use file_exception;
 use moodle_exception;
 use moodle_url;
 use MoodleQuickForm_editor;
+use qtype_questionpy\constants;
 use qtype_questionpy\local\files\response_file_service;
 use qtype_questionpy\local\files\validatable_upload_limits;
 use qtype_questionpy\utils;
+use qtype_questionpy_renderer;
 use question_attempt;
 use stored_file_creation_exception;
 
@@ -140,7 +143,43 @@ public static function from_element(DOMElement $element): ?static {
      * @throws stored_file_creation_exception
      */
     public function render(question_attempt $qa, question_ui_renderer $renderer): DOMNode {
-        // TODO: Maybe separate readonly view?
+        if ($renderer->options->readonly) {
+            global $PAGE;
+            /** @var qtype_questionpy_renderer $qpyrenderer */
+            $qpyrenderer = $PAGE->get_renderer('qtype_questionpy');
+
+            $responsestep = $qa->get_last_step_with_qt_var(constants::QT_VAR_RESPONSE);
+            $editorsdata = utils::get_qpy_editors_data($responsestep->get_qt_data());
+            $editordata = $editorsdata[$this->name] ?? null;
+
+            $html = $qpyrenderer->render_readonly_editor_content(
+                $editordata,
+                qubaid: $qa->get_usage_id(),
+                slot: $qa->get_slot(),
+                stepid: $responsestep->get_id(),
+                fieldname: $this->name,
+                options: $renderer->options,
+                rows: $this->rows,
+                cols: $this->cols
+            );
+            return dom_utils::html_to_fragment($this->element->ownerDocument, $html);
+        } {
+            return $this->render_writable($renderer, $qa);
+        }
+    }
+
+    /**
+     * Renders an editor using the usual Moodle APIs.
+     *
+     * @param question_ui_renderer $renderer
+     * @param question_attempt $qa
+     * @return DOMDocumentFragment|false|void
+     * @throws coding_exception
+     * @throws file_exception
+     * @throws moodle_exception
+     * @throws stored_file_creation_exception
+     */
+    public function render_writable(question_ui_renderer $renderer, question_attempt $qa) {
         $limits = $this->get_limits_in($renderer->options->context);
 
         $alleditorsdata = utils::get_qpy_editors_data($qa);

classes/local/files/response_file_service.php

@@ -217,7 +217,17 @@ public function prepare_split_draft_area(
      */
     public static function mangle_filename(string $fieldname, string $filename): string {
         // URL-encoding the fieldname ensures that our separator is the first occurrence of the separator.
-        return urlencode($fieldname) . static::MANGLE_SEPARATOR . $filename;
+        return self::mangled_prefix_for($fieldname) . $filename;
+    }
+
+    /**
+     * Returns the prefix used to mangle filenames belonging to the given field.
+     *
+     * @param string $fieldname The upload field name the file(s) belongs to.
+     * @return string
+     */
+    public static function mangled_prefix_for(string $fieldname): string {
+        return urlencode($fieldname) . static::MANGLE_SEPARATOR;
     }
 
     /**

renderer.php

@@ -277,7 +277,7 @@ protected function get_iframe_document(context $context, qtype_questionpy_questi
      * @throws coding_exception
      */
     protected function formulation_controls_feedback_in_iframe(
-        question_attempt         $qa, attempt_ui $ui, question_ui_renderer $renderer,
+        question_attempt $qa, attempt_ui $ui, question_ui_renderer $renderer,
         question_display_options $options, string $responseinputid, string $editorsinputid
     ): string {
         global $CFG;
@@ -616,4 +616,56 @@ public function render_readonly_file_view(question_attempt $qa, string $fieldnam
 
         return $result;
     }
+
+    /**
+     * Renders a read-only view of content entered into a {@see qpy_rich_text_editor} field.
+     *
+     * @param object|null $editordata
+     * @param int $qubaid
+     * @param int $slot
+     * @param int $stepid
+     * @param string $fieldname
+     * @param question_display_options $options
+     * @param int $rows
+     * @param int $cols
+     * @return string
+     * @throws coding_exception
+     */
+    public function render_readonly_editor_content(
+        ?object $editordata,
+        int $qubaid,
+        int $slot,
+        int $stepid,
+        string $fieldname,
+        question_display_options $options,
+        int $rows,
+        int $cols
+    ): string {
+        // Loosely based on qtype_essay_format_editor_renderer::response_area_read_only.
+
+        $content = '';
+        if ($editordata) {
+            // Replace the @@PLUGINFILE@@ placeholders with the correct pluginfile-URL prefix.
+            // TODO: We use the standard question attempt file serving here, which saves us from having to do access control
+            // ourselves, but also prevents us from using the actual (unmangled) filename when serving.
+            $prefix = moodle_url::make_pluginfile_url(
+                contextid: $options->context->id,
+                component: 'question',
+                area: constants::FILEAREA_RESPONSE_FILES,
+                itemid: null,
+                pathname: "/$qubaid/$slot/$stepid/",
+                filename: response_file_service::mangled_prefix_for($fieldname)
+            );
+            $text = str_replace('@@PLUGINFILE@@/', $prefix, $editordata->text);
+
+            $content = format_text($text, $editordata->format, options: ['para' => false]);
+        }
+
+        return html_writer::tag('div', $content, [
+            'role' => 'textbox',
+            'aria-readonly' => 'true',
+            'class' => 'readonly',
+            'style' => 'min-height: ' . ($rows * 1.5) . 'em;',
+        ]);
+    }
 }