Merge commit '162768251949808ace6c66a4b930abf906b0a4da' into catalyst-main

Author: Go MergeUpstream

.github/workflows/ci.yml

@@ -4,44 +4,61 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
 
     services:
       postgres:
-        image: postgres:12
+        image: postgres:13
         env:
-          POSTGRES_USER: 'postgres'
-          POSTGRES_HOST_AUTH_METHOD: 'trust'
+          POSTGRES_USER: "postgres"
+          POSTGRES_HOST_AUTH_METHOD: "trust"
         ports:
           - 5432:5432
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3
 
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.3', '7.4', '8.0']
+        php: ["7.4", "8.0", 8.1', "8.2", "8.3"]
         moodle-branch:
           [
-            'MOODLE_39_STABLE',
-            'MOODLE_310_STABLE',
-            'MOODLE_311_STABLE',
-            'MOODLE_400_STABLE',
-            'MOODLE_401_STABLE'
+            "MOODLE_401_STABLE",
+            "MOODLE_402_STABLE",
+            "MOODLE_403_STABLE",
+            "MOODLE_404_STABLE",
+            "main",
           ]
         database: [pgsql]
         exclude:
           # Exclude Moodle+PHP incompatible versions
-          # See: https://docs.moodle.org/dev/Moodle_and_PHP
-          - moodle-branch: 'MOODLE_401_STABLE'
-            php: '7.3'
-          - moodle-branch: 'MOODLE_39_STABLE'
-            php: '8.0'
-          - moodle-branch: 'MOODLE_310_STABLE'
-            php: '8.0'
+          # See: https://moodledev.io/general/development/policies/php
+          - moodle-branch: "MOODLE_401_STABLE"
+            php: "8.2"
+          - moodle-branch: "MOODLE_401_STABLE"
+            php: "8.3"
+          - moodle-branch: "MOODLE_402_STABLE"
+            php: "7.4"
+          - moodle-branch: "MOODLE_402_STABLE"
+            php: "8.3"
+          - moodle-branch: "MOODLE_403_STABLE"
+            php: "7.4"
+          - moodle-branch: "MOODLE_403_STABLE"
+            php: "8.3"
+          - moodle-branch: "MOODLE_404_STABLE"
+            php: "7.4"
+          - moodle-branch: "MOODLE_404_STABLE"
+            php: "8.0"
+          - moodle-branch: "main"
+        include:
+          # Only test master against latest PHP until we know which
+          # versions are supported in the next release
+          - moodle-branch: "main"
+            php: "8.3"
+            database: "pgsql"
 
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           path: plugin
 
@@ -51,65 +68,79 @@ jobs:
           php-version: ${{ matrix.php }}
           extensions: ${{ matrix.extensions }}
           ini-values: max_input_vars=5000
+          # If you are not using code coverage, keep "none". Otherwise, use "pcov" (Moodle 3.10 and up) or "xdebug".
+          # If you try to use code coverage with "none", it will fallback to phpdbg (which has known problems).
           coverage: none
 
       - name: Initialise moodle-plugin-ci
         run: |
-          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3
+          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4
           echo $(cd ci/bin; pwd) >> $GITHUB_PATH
           echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
           sudo locale-gen en_AU.UTF-8
           echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
 
-      - name: Add filter & commons qtype
+      - name: Add Wiris filter
         run: |
           moodle-plugin-ci add-plugin wiris/moodle-filter_wiris
 
       - name: Install moodle-plugin-ci
-        run: |
-          moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
+        run: moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
         env:
           DB: ${{ matrix.database }}
           MOODLE_BRANCH: ${{ matrix.moodle-branch }}
 
       - name: PHP Lint
-        if: ${{ always() }}
+        if: ${{ !cancelled() }}
         run: moodle-plugin-ci phplint
 
-      - name: PHP Copy/Paste Detector
-        continue-on-error: true # This step will show errors but will not fail
-        if: ${{ always() }}
-        run: moodle-plugin-ci phpcpd
-
       - name: PHP Mess Detector
         continue-on-error: true # This step will show errors but will not fail
-        if: ${{ always() }}
+        if: ${{ !cancelled() }}
         run: moodle-plugin-ci phpmd
 
       - name: Moodle Code Checker
-        if: ${{ always() }}
-        run: moodle-plugin-ci codechecker --max-warnings 0
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpcs --max-warnings 0
+
+      - name: Moodle PHPDoc Checker
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpdoc --max-warnings 0
 
       - name: Validating
-        if: ${{ always() }}
+        if: ${{ !cancelled() }}
         run: moodle-plugin-ci validate
 
       - name: Check upgrade savepoints
-        if: ${{ always() }}
+        if: ${{ !cancelled() }}
         run: moodle-plugin-ci savepoints
 
       - name: Mustache Lint
-        if: ${{ always() }}
+        if: ${{ !cancelled() }}
         run: moodle-plugin-ci mustache
 
       - name: Grunt
-        if: ${{ always() }}
+        if: ${{ !cancelled() }}
         run: moodle-plugin-ci grunt --max-lint-warnings 0
 
       - name: PHPUnit tests
-        if: ${{ always() }}
-        run: moodle-plugin-ci phpunit
+        if: ${{ !cancelled() }}
+        run: moodle-plugin-ci phpunit --fail-on-warning
 
       - name: Behat features
-        if: ${{ always() }}
+        id: behat
+        if: ${{ !cancelled() }}
         run: moodle-plugin-ci behat --profile chrome
+
+      - name: Upload Behat Faildump
+        if: ${{ failure() && steps.behat.outcome == 'failure' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: Behat Faildump (${{ join(matrix.*, ', ') }})
+          path: ${{ github.workspace }}/moodledata/behat_dump
+          retention-days: 7
+          if-no-files-found: ignore
+
+      - name: Mark cancelled jobs as failed.
+        if: ${{ cancelled() }}
+        run: exit 1

.gitignore

@@ -1,3 +1,5 @@
 gpl.txt
 bu-git.xml
-**.DS_Store
+**.DS_Store
+
+quizzes/configuration.ini

classes/MoodleConfiguration.class.php

@@ -48,6 +48,18 @@ public function get($key) {
                 return $quizzeshandurl;
             }
         }
+        if ($key == 'quizzes.calc.url') {
+            $quizzescalcurl = get_config('qtype_wq', 'quizzescalcurl');
+            if (isset($quizzescalcurl) && !empty($quizzescalcurl)) {
+                return $quizzescalcurl;
+            }
+        }
+        if ($key == 'quizzes.graph.url') {
+            $quizzesgraphurl = get_config('qtype_wq', 'quizzesgraphurl');
+            if (isset($quizzesgraphurl) && !empty($quizzesgraphurl)) {
+                return $quizzesgraphurl;
+            }
+        }
         if ($key == 'quizzes.wirislauncher.url') {
             $quizzeswirislauncherurl = get_config('qtype_wq', 'quizzeswirislauncherurl');
             if (isset($quizzeswirislauncherurl) && !empty($quizzeswirislauncherurl)) {
@@ -72,7 +84,12 @@ public function get($key) {
         if ($key == 'quizzes.httpproxy.pass' && $moodleproxyenabled && $proxypassenabled) {
             return $CFG->proxypassword;
         }
-
+        if ($key == 'quizzes.maxconnections') {
+            $maxconnectionsdisabled = get_config('qtype_wq', 'maxconnections_disabled');
+            if ($maxconnectionsdisabled) {
+                return '-1';
+            }
+        }
         if ($key == 'quizzes.cache.dir') {
             return $CFG->dataroot . '/filter/wiris/cache';
         }

classes/moodlelockprovider.class.php

@@ -45,16 +45,15 @@ class moodlelockprovider {
      * **/
     // @codingStandardsIgnoreStart
     public function getLock($id) {
-    // @codingStandardsIgnoreStop
+        // @codingStandardsIgnoreStop
         $timeout = 10;
 
         $resource = $id;
 
         $lockfactory = new \core\lock\db_record_lock_factory('qtype_wq_persistenvariables');
         $lock = $lockfactory->get_lock($resource, $timeout);
         if ($lock === false) {
-            $lock->release();
-            throw new moodle_exception('couldnotaquirelock', 'qtype_wq', '','Could not acquire lock');
+            throw new moodle_exception('couldnotaquirelock', 'qtype_wq', '', 'Could not acquire lock');
         }
 
         return new moodlelock($lock);

db/upgrade.php

@@ -77,7 +77,7 @@ function xmldb_qtype_wq_upgrade($oldversion) {
 
     if ($oldversion < 2017011300) {
 
-         // Define table qtype_wq_variables to be created.
+        // Define table qtype_wq_variables to be created.
         $table = new xmldb_table('qtype_wq_variables');
 
         // Adding fields to table qtype_wq_variables.
@@ -102,12 +102,12 @@ function xmldb_qtype_wq_upgrade($oldversion) {
 
 function get_entities_table($table, $flags) {
     if ((version_compare(PHP_VERSION, '5.3.4') >= 0)) {
-        return get_html_translation_taquestionble($table, $flags, 'UTF-8');
+        return get_html_translation_table($table, $flags, 'UTF-8');
     } else {
         $isotable = get_html_translation_table($table, $flags);
         $utftable = array();
         foreach ($isotable as $key => $value) {
-            $utftable[utf8_encode($key)] = utf8_encode($value);
+            $utftable[mb_convert_encoding($key, 'UTF-8', 'ISO-8859-1')] = mb_convert_encoding($value, 'UTF-8', 'ISO-8859-1');
         }
         return $utftable;
     }

edit_wq_form.php

@@ -20,7 +20,6 @@
 class qtype_wq_edit_form extends question_edit_form {
     protected $base;
 
-
     public function __construct($base, $submiturl, $question, $category, $contexts, $formeditable) {
         // TODO: remove all but $base function parameters.
 
@@ -56,19 +55,29 @@ protected function definition_inner($mform) {
         $mform->addElement('hidden', 'wirislang', current_language(), array('class' => 'wirislang'));
         $mform->setType('wirislang', PARAM_TEXT);
 
-        // TODO: Delete this if when all questions are wq!
         if (isset($this->question->wirisquestion)) {
             $program = $this->question->wirisquestion->serialize();
         } else {
-            if (!empty($this->question->id)) {
-                $wiris = $DB->get_record('qtype_wq', array('question' => $this->question->id));
-            }
-            if (!empty($wiris)) {
-                // Existing question.
-                $program = $wiris->xml;
-            } else {
+            // If the wirisquestion is not already loaded in memory, load it from the DB directly.
+            if (empty($this->question->id)) {
                 // New question.
                 $program = '<question/>';
+            } else {
+                // Existing question.
+                $wiris = $DB->get_record('qtype_wq', array('question' => $this->question->id));
+                if (empty($wiris)) {
+                    // Corrupted question.
+                    $corruptwarning =
+                        $mform->createElement(
+                            'html',
+                            '<div class="wiriscorruptquestionedit">' . get_string('corruptquestion_edit', 'qtype_wq') . '</div>'
+                        );
+                    $mform->insertElementBefore($corruptwarning, 'generalheader');
+                    $program = '<question/>';
+                } else {
+                    // Question found in the DB.
+                    $program = $wiris->xml;
+                }
             }
         }
 

info.php

@@ -370,9 +370,6 @@ function wrs_createtablerow($testname, $reporttext, $solutionlink, $condition) {
 
 $output .= html_writer::start_tag('tr', array('class' => 'wrs_filter wrs_plugin'));
 
-require_once($CFG->dirroot . '/lib/editor/tinymce/lib.php');
-$tinyeditor = new tinymce_texteditor();
-
 $rb = com_wiris_quizzes_api_Quizzes::getInstance();
 
 $questionxml = '<question><wirisCasSession>&lt;session lang=&quot;en&quot; version=&quot;2.0&quot;' .

lang/ca/qtype_wq.php

@@ -74,7 +74,7 @@
 $string['cachedir'] = 'CACHE_DIR:';
 $string['serviceurl'] = 'SERVICE_URL:';
 $string['wqsummary'] = 'This adds a generic Wiris Quizzes question. Only for test purpose. It will be hide from here.';
-$string['wirisquestionincorrect'] = 'Sorry! The system can not generate one of the questions of the quiz. <br />Maybe there is a temporary connection problem right now. <br />Maybe the question algorithm has a bug, and fails sometimes. <br />Maybe it will fail always. <br />Don\'t panic... <br />You can retry the quiz, without penalty, just clicking Continue. <br />You can also tell the Teachers that there is an issue with the question titled: \'{$a->questionname}\'';
+$string['wirisquestionincorrect'] = 'El sistema no ha pogut generar una de les preguntes del qüestionari. Potser és un problema de connexió temporal, o que hi ha un problema en la configuració de la pregunta. Pots tornar a intentar aquest qüestionari sense cap penalització clicant Continuar. Si aquest error persisteix, pots dir als teus professors que hi ha un problema amb la pregunta {$a->questionname}';
 $string['wirisquizzeserror'] = 'Sorry! There was an error in Wiris Quizzes.';
 $string['failedtoloadwirisquizzesfromxml'] = 'Failed to load Wiris Quizzes XML definition for question id';
 $string['connectionsettings'] = 'Connection settings';
@@ -95,3 +95,6 @@
 $string['privacy:metadata:qtype_wq:xml'] = 'Wiris Quizzes Question XML';
 
 $string['auxiliar_text'] = 'Escriviu un raonament opcional per a la vostra resposta:';
+
+$string['corruptquestion_edit'] = 'AVÍS: Aquesta pregunta ha sigut corrompuda i se n\' perdut la informació matemàtica. Hem intentat refer tot el què hem pogut, però cal que reescriguis de nou l\'algorisme de CalcMe si la teva pregunta en tenia un, i que tornis a desar les opcions d\'entrada i validació personalitzades. Contacta amb el teu administrador per a més detalls.';
+$string['corruptquestion_attempt'] = 'La pregunta {$a->questionname} ha sigut corrompuda i no s\'ha pogut carregar. Si us plau, contacta amb els teus professors perquè ho puguin arreglar.';

lang/en/qtype_wq.php

@@ -17,7 +17,7 @@
 $string['wq'] = 'Wiris Quizzes';
 $string['pluginname'] = 'Wiris Quizzes';
 $string['access_provider_enabled'] = 'Access control';
-$string['access_provider_enabled_help'] = 'If enabled ony authenticated users can access Wiris services.';
+$string['access_provider_enabled_help'] = 'If enabled, only authenticated users can access Wiris services.';
 $string['pluginnamesummary'] = '';
 $string['wq_help'] = 'Generic Wiris Quizzes Help';
 $string['editingwq'] = 'Editing a generic Wiris Quizzes question';
@@ -74,7 +74,7 @@
 $string['cachedir'] = 'CACHE_DIR:';
 $string['serviceurl'] = 'SERVICE_URL:';
 $string['wqsummary'] = 'This adds a generic Wiris Quizzes question. Only for test purpose. It will be hide from here.';
-$string['wirisquestionincorrect'] = 'Sorry! The system can not generate one of the questions of the quiz. <br />Maybe there is a temporary connection problem right now. <br />Maybe the question algorithm has a bug, and fails sometimes. <br />Maybe it will fail always. <br />Don\'t panic... <br />You can retry the quiz, without penalty, just clicking Continue. <br />You can also tell the Teachers that there is an issue with the question titled: \'{$a->questionname}\'';
+$string['wirisquestionincorrect'] = 'Sorry! The system can not generate one of the questions of the quiz. Maybe there is a temporary connection problem right now, or there is a problem with how the question is set up. You can retry the quiz, without penalty, just clicking Continue. If this error persists, you can tell your teachers that there is an issue with the question {$a->questionname}.';
 $string['wirisquizzeserror'] = 'Sorry! There was an error in Wiris Quizzes.';
 $string['failedtoloadwirisquizzesfromxml'] = 'Failed to load Wiris Quizzes XML definition for question id';
 $string['connectionsettings'] = 'Connection settings';
@@ -97,11 +97,29 @@
 
 $string['compatibility_settings'] = 'Compatibility settings';
 $string['compatibility_settings_text'] = '';
-$string['filtercodes_compatibility_enabled'] = 'Compatibility with Filter Codes filter';
+$string['filtercodes_compatibility_enabled'] = 'FilterCodes compatibility';
 $string['filtercodes_compatibility_enabled_help'] = 'The Filter Codes filter is not compatible with certain WirisQuizzes features if the option "Escape tags" is selected. Enabling this option solves the compatibility problem. Do not enable it in any other situation.';
 
 $string['privacy:metadata:qtype_wq'] = 'Information about user\'s correct answer for a given WirisQuizzes question type';
 $string['privacy:metadata:qtype_wq:question'] = 'Wiris Quizzes question type id';
 $string['privacy:metadata:qtype_wq:xml'] = 'Wiris Quizzes Question XML';
 
 $string['auxiliar_text'] = 'Write an optional reasoning for your answer:';
+
+$string['log_server_errors'] = 'Log server errors';
+$string['log_server_errors_help'] = 'Extensively log errors coming from the WirisQuizzes service and other errors occurred when processing WirisQuizzes questions to your server logs. This might cause an increase in the size of your log files but might help the Wiris team troubleshoot issues.';
+
+$string['corruptquestion_edit'] = 'WARNING: This question was corrupted and its mathematical data was lost from the database. We have tried to restore everything we could, but you need to rebuild the CalcMe algorithm if your question had one, and any custom input options and validation options. Contact with your administrator for further information.';
+$string['corruptquestion_attempt'] = 'The question {$a->questionname} was corrupted and could not be loaded. Please contact with your teacher so they can fix it.';
+
+$string['quizzescalcurl'] = 'CalcMe URL';
+$string['quizzescalcurl_help'] = 'URL where to load the CalcMe web app.';
+
+$string['quizzesgraphurl'] = 'Graph tool URL';
+$string['quizzesgraphurl_help'] = 'URL where to load the tool used for graph rendering and graphical answer questions.';
+
+$string['maxconnections_disabled'] = 'Disable max connections protection';
+$string['maxconnections_disabled_help'] = 'Disables the protection mechanism that limits the number of concurrent connections to the WirisQuizzes server. Only enable this setting if your usage of WirisQuizzes reaches the concurrency limit and be mindful that your infrastructure will need to handle the increased number of concurrent connections to our server.';
+
+$string['mathjax_compatibity'] = 'MathJax compatibility';
+$string['mathjax_compatibity_help'] = '(Experimental) Enables compatibility with MathJax. This option is only needed if you want to use MathJax instead of MathType to render LaTeX formulas in WirisQuizzes questions. Formulas created with MathType or WirisQuizzes will still be rendered by MathType. For the best performance, we recommend using MathType to render all formulas.';