catalyst · gbarat87 · Nov 16, 2022 · Nov 16, 2022 · Nov 16, 2022 · Nov 16, 2022
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -9,9 +9,15 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - php: '8.0'
+          - php: '8.2'
             moodle-branch: 'master'
             database: 'pgsql'
+          - php: '8.1'
+            moodle-branch: 'MOODLE_403_STABLE'
+            database: 'mariadb'
+          - php: '8.0'
+            moodle-branch: 'MOODLE_402_STABLE'
+            database: 'pgsql'
           - php: '7.4'
             moodle-branch: 'MOODLE_401_STABLE'
             database: 'pgsql'
@@ -30,7 +36,7 @@ jobs:
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3
 
       mariadb:
-        image: mariadb:10.5
+        image: mariadb:10.6
         env:
           MYSQL_USER: 'root'
           MYSQL_ALLOW_EMPTY_PASSWORD: "true"
@@ -65,6 +71,9 @@ jobs:
       - name: Start JobeInABox
         run: sudo docker run -d -p 4000:80 --name jobe trampgeek/jobeinabox:latest
 
+      - name: Let JobeInABox settle
+        run: sleep 5s
+
       - name: Test JobeInABox
         run: |
           curl http://localhost:4000/jobe/index.php/restapi/languages
@@ -88,6 +97,7 @@ jobs:
           MOODLE_BRANCH: ${{ matrix.moodle-branch }}
 
       - name: PHP Lint
+        continue-on-error: true # This step will show errors but will not fail
         if: ${{ always() }}
         run: moodle-plugin-ci phplint
 
@@ -102,10 +112,12 @@ jobs:
         run: moodle-plugin-ci phpmd
 
       - name: Moodle Code Checker
+        continue-on-error: true # This step will show errors but will not fail
         if: ${{ always() }}
         run: moodle-plugin-ci codechecker --max-warnings 0
 
       - name: Moodle PHPDoc Checker
+        continue-on-error: true # This step will show errors but will not fail
         if: ${{ always() }}
         run: moodle-plugin-ci phpdoc
 

diff --git a/.gitignore b/.gitignore
@@ -33,3 +33,5 @@ NonRepoFiles/*
 /amd/src/ui_blockly.js
 /amd/src/ui_blockly.json
 /amd/src/.eslintrc.js
+.grunt
+
diff --git a/Readme.md b/Readme.md
diff --git a/ReadmeScratchpadUi.md b/ReadmeScratchpadUi.md
@@ -0,0 +1,113 @@
+## Scratchpad UI
+The **Scratchpad UI** is an extension to the **Ace UI**:
+- It is designed to allow the execution of code in the CodeRunner question in a manner similar to an IDE.
+- It contains two editor boxes, one on top of another, allowing users to enter and edit code in both.
+
+By default, only the top editor is visible and the **Scratchpad Area**, which contains the bottom editor, is hidden. 
+Clicking the **Scratchpad Button** shows the **Scratchpad Area**. 
+This includes a second editor, a **Run button** and a **Prefix with Answer** checkbox and an **Output Display Area**. 
+Additionally, there is a **Help Button** that provides information about how to use the Scratchpad. 
+
+It's possible to run code 'in-browser' by clicking the **Run Button**, _without_ making a submission via the **Check Button**:
+- If **Prefix with Answer** is not checked, only the code in the **Scratchpad Editor** is run -- allowing for a rough working spot to quickly check the result of code.
+- Otherwise, when **Prefix with Answer** is checked, the code in the **Scratchpad Editor** is appended to the code in the first editor before being run.
+
+The Run Button has some limitations when using its default configuration:
+- Does not support programs that use STDIN (by default);
+- Only supports textual STDOUT (by default).
+
+Note: *These features can be supported, see wrappers...*
+
+
+### Switching a Question to Use the Scratchpad UI
+
+To switch an Ace UI question to use the Scratchpad UI:
+   1. edit the question;
+   2. make sure the "Ace/Scratchpad compliant" tick-box is checked;
+   3. tick customise (second option, in first section);
+   4. in the "Customisation" section, change "Input UIs" from "Ace" to "Scratchpad";
+   5. save the question.
+
+### Serialisation
+
+Pressing CTRL ALT M will disable the plugin, exposing the underlying serialisation.
+For most UIs this serialisation is passed into the question template as STUDENT_ANSWER. 
+When "Ace/Scratchpad compliant" is ticked STUDENT_ANSWER is set to the value of the first editor instead.
+
+Note: The following information is not relevant unless you un-tick the "Ace/Scratchpad compliant" tick-box.
+
+The serialisation for this plugin is JSON, with fields:
+- `answer_code`: `[""]` A list containing a string with answer code from the first editor;
+- `test_code`: `[""]` A list containing a string with containing answer code from the second editor;
+- `show_hide`: `["1"]` when scratchpad is visible, otherwise `[""]`;
+- `prefix_ans`: `["1"]` when **Prefix with Answer** is checked, otherwise `[""]`.
+
+A special case is the default serialisation: `{"answer_code":[""],"test_code":[""],"show_hide":["1"],"prefix_ans":["1"]}` is converted to `""` (an empty string).
+
+The UI will also accept (and convert) JSON with only the field `answer_code` and strings to a valid serialisation.
+A valid serialisation is one with all four specified fields. All other serialisations will be rejected by the interface.
+
+### UI Parameters
+
+- `scratchpad_name`: display name of the scratchpad, used to hide/un-hide the scratchpad.
+- `button_name`: run button text.
+- `prefix_name`: prefix with answer check-box label text.
+- `help_text`: help text to show.
+- `run_lang`: language used to run code when the run button is clicked, this should be the language your wrapper is written in (if applicable).
+- `wrapper_src`: location of wrapper code to be used by the run button, if applicable:
+    - setting to `globalextra` will use text in global extra field,
+    - `prototypeextra` will use the prototype extra field.
+- `output_display_mode`: control how program output is displayed on runs, there are three modes:
+  - `text`: display program output as text, html escaped;
+  - `json`: display program output, when it is json, see next section...
+  - `html`: display program output as raw html.
+- `open_delimiter`: The opening delimiter to use when inserting answer or Scratchpad code. It will replace the default value `{|`.
+- `close_delimiter`: The closing delimiter to use when inserting answer or Scratchpad code. It will replace the default value `|}`.
+- `disable_scratchpad`:	disable the scratchpad, reverting to Ace UI from student perspective.
+- `invert_prefix`: inverts meaning of prefix_ans serialisation -- `'1'` means un-ticked, vice versa. This can be used to swap the default state.
+- `escape`: when `true` code will be JSON escaped (minus outer quotes `"`) before being inserted into the wrapper.
+- `params` : parameters for the sandbox webservice.
+
+### Wrappers
+A wrapper is used to wrap code before it is run using the sandbox.
+A wrapper could be used to enclose the code in a function call, or to run the program as a subprocess after manipulation.
+Some tasks that require this are: running languages installed on Jobe but not supported by coderunner; reading standard input during runs; or displaying Matplotlib graphs.
+
+
+You can insert the answer code and scratchpad code into the wrapper using `{| ANSWER_CODE |}` and `{| SCRATCHPAD_CODE |}` respectively.
+If the **Prefix with Answer** checkbox is unchecked `{| ANSWER_CODE |}` will be replaced with an empty string `''`.
+The default configuration uses the following wrapper:
+
+
+```
+{| ANSWER_CODE |}
+{| SCRATCHPAD_CODE |}
+```
+Whitespace is ignored between the delimiters (`{|`,`|}`) and the variable name, e.g. `{|ANSWER_CODE   |}` will be replaced.
+You can change the delimiters using the `open_delimiter` and `close_delimiter` UI Parameters. 
+
+
+Four UI parameters are of particular importance when writing wrappers:
+
+- `wrapper_src` sets the location of the wrapper code.
+- `run_lang` sets the language the Sandbox Webservice uses to run code when the **Run Button** is pressed.
+- `output_display_mode` controls how run output is displayed, see below. 
+- `escape` will escape (JSON escape with `"` removed from start and end) `ANSWER_CODE` and `SCRATCHPAD_CODE` before insertion into wrapper. Useful when inserting code into a string. NOTE: _single quotes `'` are NOT escaped.
+
+There are three modes of displaying program run output, set by `output_display_mode`:
+  - `text`: Display the output as text, html escaped. **(default)**
+  - `json`: Display programs that output JSON, useful for capturing stdin and displaying images. **(recommended)**
+    - Accepts JSON in run output with the fields:
+      - `returncode`: Exit code from program run.
+      - `stdout`: Stdout text from program run.
+      - `stderr`: Error text from program run.
+      - `files`: An object containing filenames mapped to base64 encoded images. These will be displayed below any stdout text.
+    - When the `returncode` is set to `42`, an HTML input field will be added after the last `stdout` received.
+      When the enter key is pressed inside the input, the input's value is added to stdin and the program is run again with this updated stdin.
+      This is repeated until `returncode` is not set to `42`.
+  - `html`: Display program output as raw html inside the output area. **(advanced)**
+    - This can be used to show images and insert other HTML.
+    - Giving an `<input>` element the class `coderunner-run-input` will add an event: when the enter key is pressed inside the input, the input's value is added to stdin and the program is run again with this updated stdin.
+
+Note: JSON is the preferred display mode; wrapper debugging is much simpler than HTML mode. 
+HTML output is only recommended if you are trying to display HTML elements and for very advanced users, enter at your own risk...
diff --git a/Untitled Document b/Untitled Document
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="MoodleCore">
+  <rule ref="moodle-extra"/>
+</ruleset>
diff --git a/ajax.php b/ajax.php
@@ -27,8 +27,7 @@
  * Assumed to be run after python questions have been tested, so focuses
  * only on C-specific aspects.
  *
- * @package    qtype
- * @subpackage coderunner
+ * @package    qtype_coderunner
  * @copyright  2015 Richard Lobb, University of Canterbury
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -51,10 +50,26 @@
 $coursecontext = context_course::instance($courseid);
 if ($qtype) {
     $questiontype = qtype_coderunner::get_prototype($qtype, $coursecontext);
-    if ($questiontype === null) {
+    if ($questiontype === null || is_array($questiontype)) {
+        $questionprototype = $questiontype;
         $questiontype = new stdClass();
         $questiontype->success = false;
-        $questiontype->error = "Error fetching prototype '$qtype'.";
+        if ($questiontype === null) {
+            $questiontype->error = json_encode(["error" => "missingprototype",
+                "alert" => "prototype_missing_alert", "extras" => ""]);
+        } else {
+            $extras = "";
+            foreach ($questionprototype as $component) {
+                $extras .= get_string(
+                    'listprototypeduplicates',
+                    'qtype_coderunner',
+                    ['id' => $component->id, 'name' => $component->name,
+                    'category' => $component->category]
+                );
+            }
+            $questiontype->error = json_encode(["error" => "duplicateprototype",
+                "alert" => "prototype_duplicate_alert", "extras" => $extras]);
+        }
     } else {
         $questiontype->success = true;
         $questiontype->error = '';
@@ -63,29 +78,32 @@
 } else if ($uiplugin) {
     $uiplugins = qtype_coderunner_ui_plugins::get_instance();
     $allnames = $uiplugins->all_names();
-    $uiparamstable = array();
-    $columnheaders = array();
+    $uiparamstable = [];
+    $columnheaders = [];
     if (!in_array($uiplugin, $allnames)) {
-        $uiheader = get_string('unknownuiplugin', 'qtype_coderunner', array('pluginname' => $uiplugin));
+        $uiheader = get_string('unknownuiplugin', 'qtype_coderunner', ['pluginname' => $uiplugin]);
     } else {
         $uiparams = $uiplugins->parameters($uiplugin);
         if ($uiparams->length() === 0) {
-            $uiheader = get_string('nouiparameters', 'qtype_coderunner', array('uiname' => $uiplugin));
+            $uiheader = get_string('nouiparameters', 'qtype_coderunner', ['uiname' => $uiplugin]);
         } else {
             $csv = implode(', ', $uiparams->all_names_starred());
-            $uiheader = get_string('uiparametertablehead', 'qtype_coderunner',
-                    array('uiname' => $uiplugin)) . $csv . '.';
+            $uiheader = get_string(
+                'uiparametertablehead',
+                'qtype_coderunner',
+                ['uiname' => $uiplugin]
+            ) . $csv . '.';
             $uiparamstable = $uiparams->table();
             $namehdr = get_string('uiparamname', 'qtype_coderunner');
             $descrhdr = get_string('uiparamdesc', 'qtype_coderunner');
             $defaulthdr = get_string('uiparamdefault', 'qtype_coderunner');
-            $columnheaders = array($namehdr, $descrhdr, $defaulthdr);
+            $columnheaders = [$namehdr, $descrhdr, $defaulthdr];
         }
     }
-    echo json_encode(array('header' => $uiheader,
+    echo json_encode(['header' => $uiheader,
         'uiparamstable' => $uiparamstable,
         'columnheaders' => $columnheaders,
         'showdetails' => get_string('showdetails', 'qtype_coderunner'),
-        'hidedetails' => get_string('hidedetails', 'qtype_coderunner')));
+        'hidedetails' => get_string('hidedetails', 'qtype_coderunner')]);
 }
 die();
diff --git a/amd/build/ajaxquestionloader.min.js b/amd/build/ajaxquestionloader.min.js