Qtype_drawlines: Implement shownumcorrect, showmisplaced #882022

Author: Mahmoud Kassaei

classes/line.php

@@ -177,7 +177,7 @@ public static function is_item_positioned_correctly_on_axis($responsecoord, $lin
      * Parse the input and return the parts in a list of 'cx', 'cy' with or whothout 'r'.
      *
      * @param string $dropzone, the string in a given format with or whithout radius
-     * @param bool $radius, if set to true, return the list with radius, otherwise with radius
+     * @param bool $radius, if set to true, return the list with radius, otherwise without radius
      * @return int[], a list of 'cx', 'cy' with or whothout 'r'.
      */
     public static function parse_into_cx_cy_with_or_without_radius(string $dropzone, bool $radius = false): array {

edit_drawlines_form.php

@@ -172,11 +172,11 @@ protected function get_per_line_fields(MoodleQuickForm $mform, string $label, ar
     /**
      * Create the form elements required by one hint.
      *
-     * @param string $withclearwrong whether this quesiton type uses the 'Clear wrong' option on hints.
+     * @param string $withshowmisplaced whether this quesiton type uses the 'show misplaced' option on hints.
      * @param string $withshownumpartscorrect whether this quesiton type uses the 'Show num parts correct' option on hints.
      * @return array form field elements for one hint.
      */
-    protected function get_hint_fields($withclearwrong = false, $withshownumpartscorrect = false) {
+    protected function get_hint_fields($withshowmisplaced = true, $withshownumpartscorrect = false) {
         $mform = $this->_form;
 
         $repeated = [];
@@ -187,7 +187,7 @@ protected function get_hint_fields($withclearwrong = false, $withshownumpartscor
         $repeated[] = $mform->createElement('checkbox', 'hintshownumcorrect',
                 get_string('options', 'question'),
                 get_string('shownumpartscorrect', 'question'));
-        $repeated[] = $mform->createElement('checkbox', 'hintoptions', '',
+        $repeated[] = $mform->createElement('checkbox', 'hintshowmisplaced', '',
                 get_string('showmisplaced', 'qtype_' . $this->qtype()));
 
         return [$repeated, $repeatedoptions];
@@ -256,16 +256,18 @@ protected function data_preprocessing_lines(stdClass $question): object {
     }
 
     #[\Override]
-    protected function data_preprocessing_hints($question, $withclearwrong = false,
-            $withshownumpartscorrect = false) {
+    protected function data_preprocessing_hints($question, $withshowmisplaced = false,
+                                                $withshownumpartscorrect = false) {
         if (empty($question->hints)) {
             return $question;
         }
-        parent::data_preprocessing_hints($question, $withclearwrong, $withshownumpartscorrect);
+        parent::data_preprocessing_hints($question, false, $withshownumpartscorrect);
 
         $question->hintoptions = [];
-        foreach ($question->hints as $hint) {
-            $question->hintoptions[] = $hint->options;
+        foreach ($question->hints as $key => $hint) {
+            if ($withshowmisplaced) {
+                $question->hintshowmisplaced[] = $hint->options;
+            }
         }
 
         return $question;

lang/en/qtype_drawlines.php

@@ -31,8 +31,8 @@
 $string['correctanswersare'] = 'The correct answers are: {$a}';
 $string['dropbackground'] = 'Background image for Draw lines';
 
-$string['formerror_nobgimage'] = 'You need to select an image to use as the background for the drag and drop area.';
 $string['formerror_invalidimagesize'] = 'Image file should not be larger than 600x600 px. The uploaded image file size is {$a->width}x{$a->height} px.';
+$string['formerror_nobgimage'] = 'You need to select an image to use as the background for the drag and drop area.';
 $string['formerror_nolines'] = 'You need to expand \'Line 1\' and fill the form for it';
 $string['formerror_notype'] = 'You have to select a type for Line {$a}';
 $string['formerror_zoneend'] = 'End zone coordinates should be in x,y;r format, where x,y are the coordinates of the centre of a circle and r is the radius.';
@@ -75,6 +75,10 @@
 $string['refresh'] = 'Refresh preview';
 
 $string['showmisplaced'] = 'State which zones are incorrectly placed';
+$string['showmisplacedcoordinate'] = 'The coordinate {$a} is placed incorrectly.';
+$string['showmisplacedcoordinates'] = 'The coordinates {$a} are placed incorrectly.';
+$string['showmisplacedline'] = 'The {$a} is placed incorrectly.';
+$string['showmisplacedlines'] = 'The {$a} are placed incorrectly.';
 $string['summarisechoice'] = '{$a->no}. {$a->text}';
 $string['summarisechoiceno'] = 'Item {$a}';
 $string['summariseplace'] = '{$a->no}. {$a->text}';
@@ -89,9 +93,9 @@
 
 $string['xleft'] = 'Left';
 
-$string['yougot1right'] = 'You have correctly selected one point.';
+$string['yougot1right'] = 'You have correctly selected one coordinate.';
 $string['yougot1rightline'] = 'You have correctly selected one line.';
-$string['yougotnright'] = 'You have correctly selected {$a->num} points.';
+$string['yougotnright'] = 'You have correctly selected {$a->num} coordinates.';
 $string['yougotnrightline'] = 'You have correctly selected {$a->num} lines.';
 $string['ytop'] = 'Top';
 

questiontype.php

@@ -16,6 +16,9 @@
 
 use qtype_drawlines\line;
 
+defined('MOODLE_INTERNAL') || die();
+require_once($CFG->libdir.'/questionlib.php');
+
 /**
  * The Draw lines question type class.
  *
@@ -115,32 +118,31 @@ public function save_hints($fromform, $withparts = false) {
         }
 
         if ($withparts) {
-            if (!empty($fromform->hintclearwrong)) {
-                $numclears = max(array_keys($fromform->hintclearwrong)) + 1;
-            } else {
-                $numclears = 0;
-            }
             if (!empty($fromform->hintshownumcorrect)) {
                 $numshows = max(array_keys($fromform->hintshownumcorrect)) + 1;
             } else {
                 $numshows = 0;
             }
-            $numhints = max($numhints, $numclears, $numshows);
-        }
+            // The hintshowmisplaced variable uses hintoptions from the DB in hint table.
+            $fromform->hintshowmisplaced = $fromform->hintoptions;
+            if ($fromform->hintshowmisplaced) {
+                $nummisplaced = max(array_keys($fromform->hintshowmisplaced)) + 1;
+            } else {
+                $nummisplaced = 0;
+            }
 
+            $numhints = max($numhints, $nummisplaced, $numshows);
+        }
         for ($i = 0; $i < $numhints; $i += 1) {
             if (html_is_blank($fromform->hint[$i]['text'])) {
                 $fromform->hint[$i]['text'] = '';
             }
 
             if ($withparts) {
-                $clearwrong = !empty($fromform->hintclearwrong[$i]);
                 $shownumcorrect = !empty($fromform->hintshownumcorrect[$i]);
-                $statewhichincorrect = !empty($fromform->hintoptions[$i]);
+                $showmisplaced = !empty($fromform->hintshowmisplaced[$i]);
             }
-
-            if (empty($fromform->hint[$i]['text']) && empty($clearwrong) &&
-                    empty($shownumcorrect) && empty($statewhichincorrect)) {
+            if (empty($fromform->hint[$i]['text']) && empty($shownumcorrect) && empty($showmisplaced)) {
                 continue;
             }
 
@@ -157,9 +159,8 @@ public function save_hints($fromform, $withparts = false) {
                     $context, 'question', 'hint', $hint->id);
             $hint->hintformat = $fromform->hint[$i]['format'];
             if ($withparts) {
-                $hint->clearwrong = $clearwrong;
                 $hint->shownumcorrect = $shownumcorrect;
-                $hint->options = $statewhichincorrect;
+                $hint->options = $showmisplaced;
             }
             $DB->update_record('question_hints', $hint);
         }
@@ -211,6 +212,11 @@ public function make_line(stdClass $line): line {
                 $line->zonestart, $line->zoneend);
     }
 
+    #[\Override]
+    protected function make_hint($hint) {
+        return question_hint_drawlines::load_from_record($hint);
+    }
+
     #[\Override]
     public function delete_question($questionid, $contextid) {
         global $DB;
@@ -394,3 +400,44 @@ public function get_possible_responses($questiondata) {
         return $parts;
     }
 }
+
+/**
+ * Question hint for drawlines.
+ * An extension of {@link question_hint} for questions like match and multiple
+ * choice with multiple answers, where there are options for whether to show the
+ * number of parts right at each stage, and to reset the wrong parts.
+ *
+ * @package   qtype_drawlines
+ * @copyright  2025 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+ class question_hint_drawlines extends question_hint_with_parts {
+
+    /** @var bool option to display the parts of the question that were wrong on retry.*/
+    public $showmisplaced;
+
+    /**
+     * Constructor.
+     * @param int the hint id from the database.
+     * @param string $hint The hint text
+     * @param int the corresponding text FORMAT_... type.
+     * @param bool $shownumcorrect whether the number of right parts should be shown
+     * @param bool $clearwrong whether the wrong parts should be reset.
+     * @param bool $showmisplaced whether the show the wrong parts.
+     */
+    public function __construct($id, $hint, $hintformat, $shownumcorrect,
+            $clearwrong, $showmisplaced) {
+        parent::__construct($id, $hint, $hintformat, $shownumcorrect, $clearwrong);
+        $this->showmisplaced = $showmisplaced;
+    }
+
+    /**
+     * Create a basic hint from a row loaded from the question_hints table in the database.
+     * @param object $row with property options as well as hint, shownumcorrect and clearwrong set.
+     * @return question_hint_drawlines
+     */
+    public static function load_from_record($row) {
+        return new question_hint_drawlines($row->id, $row->hint, $row->hintformat,
+                $row->shownumcorrect, $row->clearwrong, $row->options);
+    }
+}

renderer.php

@@ -164,7 +164,10 @@ public function formulation_and_controls(question_attempt $qa, question_display_
 
     #[\Override]
     public function specific_feedback(question_attempt $qa) {
-        return $this->combined_feedback($qa);
+        $output = '';
+        $output .= $this->combined_feedback($qa);
+        $hint = $qa->get_applicable_hint();
+        return $output;
     }
 
     #[\Override]
@@ -193,6 +196,72 @@ public function correct_response(question_attempt $qa) {
         return $this->correct_choices($rightanswers);
     }
 
+    #[\Override]
+    protected function hint(question_attempt $qa, question_hint $hint) {
+        $output = '';
+        $question = $qa->get_question();
+        $response = $qa->get_last_qt_data();
+        $grademethod = $qa->get_question()->grademethod;
+        // Accumulate the wrong coords for each lines to be displayed and hint options.
+        $wrongcoords = [];
+        if ($hint->showmisplaced) {
+            foreach ($question->lines as $key => $line) {
+                if (in_array($question->field($key), array_keys($response))) {
+                    $coords = explode(' ', $response[$question->field($key)]);
+                    if ($question->grademethod === 'partial') {
+                        // Label the line.
+                        $linelabelstart = null;
+                        $linelabelend = null;
+                        if (!line::is_dragitem_in_the_right_place($coords[0], $line->zonestart)) {
+                            $linelabelstart = ' Line ' . $line->number;
+                            $wrongcoords[] = html_writer::tag('span', $linelabelstart .
+                                ' start(' . $coords[0] . ')', ['class' => 'misplaced']);
+                        }
+                        if (!line::is_dragitem_in_the_right_place($coords[1], $line->zoneend)) {
+                            if (is_null($linelabelstart)) {
+                                // Do not repeat the line number for the end-prt of the line coordinates.
+                                $linelabelend = ' Line ' . $line->number;
+                            }
+                            $wrongcoords[] = html_writer::tag('span', $linelabelend .
+                                ' end(' . $coords[1] . ')', ['class' => 'misplaced']);
+                        }
+                    } else {
+                        if (!(line::is_dragitem_in_the_right_place($coords[0], $line->zonestart) &&
+                            line::is_dragitem_in_the_right_place($coords[1], $line->zoneend))) {
+                            $wrongcoords[] = html_writer::tag('span', ' Line ' . $line->number .
+                                ' start(' . $coords[0] . ') end(' . $coords[1] . ')', ['class' => 'misplaced']);
+                        }
+                    }
+                }
+            }
+            if (empty($wrongcoords)) {
+                $output .= '';
+            } else if (count($wrongcoords) === 1) {
+                if ($grademethod === 'partial') {
+                    $output .= html_writer::tag('div',
+                        get_string('showmisplacedcoordinate', 'qtype_drawlines', implode($wrongcoords)),
+                        ['class' => 'misplacedinfo']);
+                } else {
+                    $output .= html_writer::tag('div',
+                        get_string('showmisplacedline', 'qtype_drawlines', implode($wrongcoords)),
+                        ['class' => 'misplacedinfo']);
+                }
+            } else {
+                if ($grademethod === 'partial') {
+                    $output .= html_writer::tag('div',
+                        get_string('showmisplacedcoordinates', 'qtype_drawlines', implode(',', $wrongcoords)),
+                        ['class' => 'misplacedinfo']);
+                } else {
+                    $output .= html_writer::tag('div',
+                        get_string('showmisplacedlines', 'qtype_drawlines', implode(',', $wrongcoords)),
+                        ['class' => 'misplacedinfo']);
+                }
+            }
+        }
+        $output .= parent::hint($qa, $hint);
+        return $output;
+    }
+
     /**
      * Function returns string based on number of correct answers.
      *
@@ -214,16 +283,29 @@ protected function correct_choices(array $right): string {
     #[\Override]
     protected function num_parts_correct(question_attempt $qa): string {
         $a = new stdClass();
-        list($a->num, $a->outof) = $qa->get_question()->get_num_parts_right(
-                $qa->get_last_qt_data());
-        if (is_null($a->outof)) {
+        $grademethod = $qa->get_question()->grademethod;
+        if ($grademethod === 'partial') {
+            [$a->num, $a->outof] = $qa->get_question()->get_num_parts_right_grade_partial($qa->get_last_qt_data());
+        } else {
+            [$a->num, $a->outof] = $qa->get_question()->get_num_parts_right_grade_allornone($qa->get_last_qt_data());
+        }
+        if ($a->num === 0 || is_null($a->outof)) {
             return '';
-        } else if ($a->num == 1) {
-            return html_writer::tag('p', get_string('yougot1right', 'qtype_drawlines'));
+        }
+        if ($a->num == 1) {
+            if ($grademethod === 'partial') {
+                return html_writer::tag('p', get_string('yougot1right', 'qtype_drawlines', $a));
+            } else {
+                return html_writer::tag('p', get_string('yougot1rightline', 'qtype_drawlines', $a));
+            }
         } else {
             $f = new NumberFormatter(current_language(), NumberFormatter::SPELLOUT);
             $a->num = $f->format($a->num);
-            return html_writer::tag('p', get_string('yougotnright', 'qtype_drawlines', $a));
+            if ($grademethod === 'partial') {
+                return html_writer::tag('p', get_string('yougotnright', 'qtype_drawlines', $a));
+            } else {
+                return html_writer::tag('p', get_string('yougotnrightline', 'qtype_drawlines', $a));
+            }
         }
     }
 }

styles.css

@@ -65,3 +65,13 @@ form.mform fieldset#id_previewareaheader .dropbackground {
 form.mform fieldset#id_previewareaheader div.ddarea {
     text-align: center;
 }
+
+.que.drawlines dive.misplacedinfo {
+    margin: 2px;
+}
+
+.que.drawlines span.misplaced {
+    background-color: #c8ff00;
+    opacity: .6;
+    margin: 2px;
+}

tests/behat/backup_and_restore.feature

@@ -64,4 +64,4 @@ Feature: Test duplicating a course containing a draw lines question
     And I click on "Multiple tries" "link"
     And the following fields match these values:
       | Hint 1 | You are trying to draw 2 lines by placing the start and end markers for each line on the map.   |
-      | Hint 2 | You have to find the positins for start and end of each line as described in the question text. |
+      | Hint 2 | You have to find the positions for start and end of each line as described in the question text. |

tests/behat/import.feature

@@ -27,3 +27,20 @@ Feature: Test importing draw lines questions
     And I should see "1. Draw 2 lines on the map. A line segment from A (line starting point) to B (line Ending point), and another one from C to D."
     And I press "Continue"
     And I should see "Drawlines to edit"
+
+  @javascript @_file_upload
+  Scenario: Verify the imported question for hints.
+    Given I am on the "Course 1" "core_question > course question import" page logged in as teacher
+    And I set the field "id_format_xml" to "1"
+    And I upload "question/type/drawlines/tests/fixtures/testquestion_drawlines_mkmap_twolines.xml" file to "Import" filemanager
+    And I expand all fieldsets
+    And I press "id_submitbutton"
+    And I should see "Parsing questions from import file."
+    And I press "Continue"
+    And I should see "Drawlines to edit"
+    When I am on the "Drawlines to edit" "core_question > edit" page logged in as "teacher"
+    And I expand all fieldsets
+    Then the following fields match these values:
+      | hintshownumcorrect[0] | Checked |
+      | hintshownumcorrect[1] | Checked |
+      | hintshowmisplaced[1]  | Checked |