iss1757 - Add filter block

Author: EJMFarrow

corsscripts/ascii/stackascii.bundle.js

@@ -22,11 +22,14 @@ import regexall from './extractors/regexall.js';
 
 const extractorlib = { finalfunction, lastexpr, lastblock, regexmatch, regexall };
 
-export default function init(inputIds, transforms, operations) {
+export default function init(inputIds, operations) {
     const markdownContainerId = inputIds[0];
     // inputIds[1..N] correspond to each parsed answer entry in order.
+    const alloperations = operations;
+    const filters = operations.filter(operator => operator.operation === 'filter');
     const extractors = operations.filter(operator => operator.operation === 'extractor');
-    const inputTransforms = transforms ? transforms : 'latexwrap,boldfilter';
+    const markdownitinfo = filters.find(operator => operator.type === 'markdownit');
+    const inputTransforms = markdownitinfo ? markdownitinfo.transforms : 'latexwrap,boldfilter';
 
     const blockCollector = { blocks: [] };
 

corsscripts/ascii/stackascii.bundle.js.map

@@ -1050,10 +1050,13 @@
 $string['stackBlock_ascii_unknown_param'] = 'Unknown parameter \'{$a}\' for the ASCII block.';
 $string['stackBlock_ascii_param'] = 'Valid parameters are: {$a->param}.';
 
-$string['stackBlock_extractor_targetinput_required'] = 'You must define the targetinput for the extractor block to use.';
+$string['stackBlock_extractor_targetinput_required'] = 'You must define the targetinput for the extractor block to send the answer to.';
+$string['stackBlock_extractor_type_required'] = 'You must define the type of extractor you want to use.';
 $string['stackBlock_extractor_unknown_param'] = 'Unknown parameter \'{$a}\' for the extractor block.';
 $string['stackBlock_extractor_param'] = 'Valid parameters are: {$a->param}.';
 
+$string['stackBlock_filter_type_required'] = 'You must define the type of filter you want to use.';
+
 $string['stackBlock_jsxgraph_width']       = 'The width of a JSXGraph must use a known CSS-length unit.';
 $string['stackBlock_jsxgraph_height']      = 'The height of a JSXGraph must use a known CSS-length unit.';
 $string['stackBlock_jsxgraph_width_num']   = 'The numeric portion of the width of a JSXGraph must be a raw number and must not contain any extra chars.';

corsscripts/ascii/stackascii.js

@@ -11,6 +11,7 @@
 
 <p>[[input:ans1]] [[validation:ans1]]</p>
 [[ascii input="ans1" transforms="latexwrap"]]
+[[filter type="markdownit" transforms="latexwrap" /]]
 [[extractor targetinput="ans2" type="finalfunction"/]]
 [[/ascii]]
 <p>[[hint title="Input help"]][[commonstring key="free_text_fact"/]][[/hint]]</p>

lang/en/qtype_stack.php

@@ -56,15 +56,28 @@ public function compile($format, $options): ?MP_Node {
 
         // Get the details of filter and extractor blocks.
         $operations = [];
+        $isfilter = false;
         foreach ($this->children as $child) {
             if (is_a($child, 'stack_cas_castext2_extractor')) {
                 $options = $child->params;
                 $options['operation'] = 'extractor';
                 $inputs[] = $options['targetinput'];
                 $operations[] = $options;
+            } else if (is_a($child, 'stack_cas_castext2_filter')) {
+                $options = $child->params;
+                $options['operation'] = 'filter';
+                $operations[] = $options;
+                $isfilter = true;
             }
         }
 
+        if (!$isfilter) {
+            $defaultfilter = new StdClass();
+            $defaultfilter->operation = 'filter';
+            $defaultfilter->type = 'markdownit';
+            $defaultfilter->transforms = 'latexwrap,boldfilter';
+        }
+
         // Set default width and height here.
         // We want to push forward to overwrite the iframe defaults if they are not provided in the block parameters.
         $existsuserwidth = array_key_exists('width', $xpars);
@@ -115,7 +128,7 @@ public function compile($format, $options): ?MP_Node {
             return 'stack_js.request_access_to_input("' . $item . '"' . $extra . ')';
         }, $inputs, array_keys($inputs)));
         $linkcode = 'Promise.all([' . $answercalls . '])';
-        $linkcode .= ".then((inputIds) => {init(inputIds,'" . $xpars['transforms'] . "'," . json_encode($operations) . ");});";
+        $linkcode .= ".then((inputIds) => {init(inputIds," . json_encode($operations) . ");});";
 
         $r->items[] = new MP_String($linkcode);
         $r->items[] = new MP_String("\n</script>");

samplequestions/stacklibrary/Features/input-type-sample-questions/Free-text_final_answer.xml

@@ -63,6 +63,11 @@ public function validate(
             $err[] = stack_string('stackBlock_extractor_targetinput_required');
         }
 
+        if (!array_key_exists('type', $this->params)) {
+            $valid = false;
+            $err[] = stack_string('stackBlock_extractor_type_required');
+        }
+
         // Wrap the old string errors with the context details.
         foreach ($err as $er) {
             $errors[] = new $options['errclass']($er, $options['context'] . '/' . $this->position['start'] . '-' .

stack/cas/castext2/blocks/ascii.block.php

@@ -0,0 +1,92 @@
+<?php
+// This file is part of Stack - http://stack.maths.ed.ac.uk/
+//
+// Stack 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.
+//
+// Stack 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 Stack.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+/**
+ * A block for specifying parsing options in ascii blocks.
+ * @package    qtype_stack
+ * @copyright  2024 University of Edinburgh.
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once(__DIR__ . '/../block.interface.php');
+require_once(__DIR__ . '/../../../utils.class.php');
+
+class stack_cas_castext2_filter extends stack_cas_castext2_block {
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
+    public function compile($format, $options): ?MP_Node {
+        $r = new MP_List([
+            new MP_String('filter'),
+            new MP_String(json_encode($this->params)),
+        ]);
+
+        return $r;
+    }
+
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
+    public function is_flat(): bool {
+        // These are never flat.
+        return false;
+    }
+
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
+    public function validate_extract_attributes(): array {
+        // No CAS arguments.
+        return [];
+    }
+
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
+    public function validate(
+        &$errors = [],
+        $options = []
+    ): bool {
+        $valid = true;
+        $err = [];
+
+        if (!array_key_exists('type', $this->params)) {
+            $valid = false;
+            $err[] = stack_string('stackBlock_filter_type_required');
+        }
+
+        // Wrap the old string errors with the context details.
+        foreach ($err as $er) {
+            $errors[] = new $options['errclass']($er, $options['context'] . '/' . $this->position['start'] . '-' .
+                $this->position['end']);
+        }
+
+        return $valid;
+    }
+
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
+    public function postprocess(
+        array $params,
+        castext2_processor $processor,
+        castext2_placeholder_holder $holder
+    ): string {
+        return '';
+    }
+
+    /**
+     * Is this an interactive block?
+     * If true, we can't generate a static version.
+     * @return bool
+     */
+    public function is_interactive(): bool {
+        return true;
+    }
+}