first commit

question/format/missingword/classes/privacy/provider.php

@@ -0,0 +1,46 @@
+<?php
+// This file is part of Moodle - http://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 <http://www.gnu.org/licenses/>.
+
+/**
+ * Privacy Subsystem implementation for qformat_missingword.
+ *
+ * @package    qformat_missingword
+ * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace qformat_missingword\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Privacy Subsystem for qformat_missingword implementing null_provider.
+ *
+ * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider {
+
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return  string
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}

question/format/missingword/format.php

@@ -0,0 +1,181 @@
+<?php
+// This file is part of Moodle - http://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 <http://www.gnu.org/licenses/>.
+
+/**
+ * Missing word question importer.
+ *
+ * @package    qformat_missingword
+ * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+defined('MOODLE_INTERNAL') || die();
+
+
+/**
+ * Missing word question importer.
+ *
+ * This Moodle class provides all functions necessary to import and export
+ * one-correct-answer multiple choice questions in this format:
+ *
+ *    As soon as we begin to explore our body parts as infants
+ *    we become students of {=anatomy and physiology ~reflexology
+ *    ~science ~experiment}, and in a sense we remain students for life.
+ *
+ * Each answer is separated with a tilde ~, and the correct answer is
+ * prefixed with an equals sign =
+ *
+ * Percentage weights can be included by following the tilde with the
+ * desired percent.  Comments can be included for each choice by following
+ * the comment with a hash mark ("#") and the comment.  Example:
+ *
+ *    This is {=the best answer#comment on the best answer ~75%a good
+ *    answer#comment on the good answer ~a wrong one#comment on the bad answer}
+ *
+ * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class qformat_missingword extends qformat_default {
+
+    public function provide_import() {
+        return true;
+    }
+
+    /**
+     * Validate the given file.
+     *
+     * For more expensive or detailed integrity checks.
+     *
+     * @param stored_file $file the file to check
+     * @return string the error message that occurred while validating the given file
+     */
+    public function validate_file(stored_file $file): string {
+        return $this->validate_is_utf8_file($file);
+    }
+
+    public function readquestion($lines) {
+        // Given an array of lines known to define a question in
+        // this format, this function converts it into a question
+        // object suitable for processing and insertion into Moodle.
+
+        $question = $this->defaultquestion();
+        $comment = null; // Added by T Robb.
+        $text = implode(" ", $lines);
+
+        // Find answer section.
+
+        $answerstart = strpos($text, "{");
+        if ($answerstart === false) {
+            $this->error(get_string('beginanswernotfound', 'qformat_missingword'), $text);
+            return false;
+        }
+
+        $answerfinish = strpos($text, "}");
+        if ($answerfinish === false) {
+            $this->error(get_string('endanswernotfound', 'qformat_missingword'), $text);
+            return false;
+        }
+
+        $answerlength = $answerfinish - $answerstart;
+        $answertext = substr($text, $answerstart + 1, $answerlength - 1);
+
+        // Save the new question text.
+        $question->questiontext = substr_replace($text, "_____", $answerstart, $answerlength+1);
+        $question->name = $this->create_default_question_name($question->questiontext, get_string('questionname', 'question'));
+
+        // Parse the answers.
+        $answertext = str_replace("=", "~=", $answertext);
+        $answers = explode("~", $answertext);
+        if (isset($answers[0])) {
+            $answers[0] = trim($answers[0]);
+        }
+        if (empty($answers[0])) {
+            array_shift($answers);
+        }
+
+        $countanswers = count($answers);
+
+        switch ($countanswers) {
+            case 0:  // Invalid question.
+                $this->error(get_string('noanswerfound', 'qformat_missingword'), $answertext);
+                return false;
+
+            case 1:
+                $question->qtype = 'shortanswer';
+
+                $answer = trim($answers[0]);
+                if ($answer[0] == "=") {
+                    $answer = substr($answer, 1);
+                }
+                $question->answer[]   = $answer;
+                $question->fraction[] = 1;
+                $question->feedback[] = array('text' => '', 'format' => FORMAT_HTML);
+
+                return $question;
+
+            default:
+                $question->qtype = 'multichoice';
+                $question = $this->add_blank_combined_feedback($question);
+                $question->single = 1; // Only one answer allowed.
+
+                foreach ($answers as $key => $answer) {
+                    $answer = trim($answer);
+
+                    // Tom's addition starts here.
+                    $answeight = 0;
+                    if (strspn($answer, "1234567890%") > 0) {
+                        // Make sure that the percent sign is the last in the span.
+                        if (strpos($answer, "%") == strspn($answer, "1234567890%") - 1) {
+                            $answeight0 = substr($answer, 0, strspn($answer, "1234567890%"));
+                            $answeight = round(($answeight0/100), 2);
+                            $answer = substr($answer, (strspn($answer, "1234567890%")));
+                        }
+                    }
+                    if ($answer[0] == "=") {
+                        $answeight = 1;
+                    }
+                    // Remove the protective underscore for leading numbers in answers.
+                    if ($answer[0] == "_") {
+                        $answer = substr($answer, 1);
+                    }
+                    $answer = trim($answer);
+
+                    if (strpos($answer, "#") > 0) {
+                        $hashpos = strpos($answer, "#");
+                        $comment = substr(($answer), $hashpos+1);
+                        $answer  = substr($answer, 0, $hashpos);
+                    } else {
+                        $comment = " ";
+                    }
+                    // End of Tom's addition.
+
+                    if ($answer[0] == "=") {
+                        $question->fraction[$key] = $answeight;
+                        $answer = substr($answer, 1);
+                    } else {
+                        $question->fraction[$key] = $answeight;
+                    }
+                    $question->answer[$key]   = array('text' => $answer, 'format' => FORMAT_HTML);
+                    $question->feedback[$key] = array('text' => $comment, 'format' => FORMAT_HTML);
+                }
+
+                return $question;
+        }
+    }
+}
+
+

question/format/missingword/lang/en/qformat_missingword.php

@@ -0,0 +1,31 @@
+<?php
+// This file is part of Moodle - http://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 <http://www.gnu.org/licenses/>.
+
+/**
+ * Strings for component 'qformat_missingword', language 'en', branch 'MOODLE_20_STABLE'
+ *
+ * @package    qformat_missingword
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['pluginname'] = 'Missing word format';
+$string['pluginname_help'] = 'Missing word format enables questions to be imported via text file.';
+$string['pluginname_link'] = 'qformat/missingword';
+$string['beginanswernotfound'] = 'Could not find a required "{" character in imported file content.';
+$string['endanswernotfound'] = 'Could not find a required "}" character in imported file content.';
+$string['noanswerfound'] = 'No answers found in question';
+$string['privacy:metadata'] = 'The Missing word question format plugin does not store any personal data.';

question/format/missingword/tests/fixtures/question.missingword1.txt

@@ -0,0 +1,3 @@
+As soon as we begin to explore our body parts as infants
+we become students of {=anatomy and physiology ~reflexology
+~science ~experiment}, and in a sense we remain students for life.

question/format/missingword/tests/fixtures/question.missingword2.txt

@@ -0,0 +1,2 @@
+You can use the missing word format to import questions
+into both Moodle's Question bank and {=Lesson} activity.

question/format/missingword/tests/fixtures/question.missingword3.txt

@@ -0,0 +1,2 @@
+This is {=the best answer#comment on the best answer ~75%a good
+answer#comment on the good answer ~a wrong one#comment on the bad answer}

question/format/missingword/version.php

@@ -0,0 +1,32 @@
+<?php
+// This file is part of Moodle - http://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 <http://www.gnu.org/licenses/>.
+
+/**
+ * Version information for the calculated question type.
+ *
+ * @package    qformat_missingword
+ * @copyright  2011 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->component = 'qformat_missingword';
+$plugin->version   = 2024042200;
+
+$plugin->requires  = 2024041600;
+
+$plugin->maturity  = MATURITY_STABLE;