Merge pull request #1470 from maths/api-static

Add "static" content flag to API question render response.

Author: sangwinc

api/README.md

@@ -75,6 +75,7 @@ The response is again a JSON document, with the following fields:
 - an int field `questionseed` indicating the seed used for this response
 - an int array `questionvariants` containing all variant seeds of the question
 - an array of arrays `iframes` of arguments to create iframes to hold JS panels e.g. JSXGraph, GeoGebra
+- a boolean field `isinteractive`, indicating if the question contains elements preventing a static representation. If true, a printed version of the question would make no sense
 
 The input configuration consists of the following fields:
 

api/controller/RenderController.php

@@ -137,6 +137,7 @@ public function __invoke(Request $request, Response $response, array $args): Res
         $renderresponse->questionseed = $question->seed;
         $renderresponse->questionvariants = $question->deployedseeds;
         $renderresponse->iframes = StackIframeHolder::$iframes;
+        $renderresponse->isinteractive = $question->is_interactive();
 
         $response->getBody()->write(json_encode($renderresponse));
         return $response->withHeader('Content-Type', 'application/json');

api/dtos/StackRenderResponse.php

@@ -41,6 +41,8 @@ class StackRenderResponse {
     public $questionvariants;
     /** @var array */
     public $iframes;
+    /** @var bool */
+    public $isinteractive;
 }
 
 // phpcs:ignore moodle.Commenting.MissingDocblock.Class

question.php

@@ -2006,6 +2006,7 @@ public static function compile($id, $questionvariables, $inputs, $prts, $options
         $units = false;
         $forbiddenkeys = [];
         $sec = new stack_cas_security();
+        \stack_cas_castext2_block::$isinteractive = false;
 
         // Some counter resets to ensure that the result is the same even if
         // we for some reason would compile twice in a session.
@@ -2254,7 +2255,7 @@ public static function compile($id, $questionvariables, $inputs, $prts, $options
 
         // Remember to collect the extracted strings once all has been done.
         $cc['static-castext-strings'] = $map->get_map();
-
+        $cc['is-interactive'] = \stack_cas_castext2_block::$isinteractive;
         return $cc;
     }
 
@@ -2289,4 +2290,12 @@ public function format_text($text, $format, $qa, $component, $filearea, $itemid,
         $text = $qa->rewrite_pluginfile_urls($text, $component, $filearea, $itemid);
         return format_text($text, $format, $formatoptions);
     }
+
+    /**
+     * Is the question interactive?
+     * @return bool
+     */
+    public function is_interactive() {
+        return $this->get_cached('is-interactive');
+    }
 }

stack/cas/castext2/block.interface.php

@@ -51,6 +51,11 @@ abstract class stack_cas_castext2_block {
     // Store any errors.
     // phpcs:ignore moodle.Commenting.VariableComment.Missing
     public $err = [];
+    /**
+     * Keeps track of whether the current question has interactove elements.
+     * @var bool
+     */
+    public static $isinteractive = false;
 
     // phpcs:ignore moodle.Commenting.MissingDocblock.Function
     public function __construct(
@@ -94,6 +99,15 @@ public function is_flat(): bool {
         return true;
     }
 
+    /**
+     * Is this an interactive block?
+     * If true, we can't generate a static version.
+     * @return bool
+     */
+    public function is_interactive(): bool {
+        return false;
+    }
+
     /**
      * If this is not a flat block this will be called with the response from CAS and
      * should execute whatever additional logic is needed. Register JavaScript and such

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

@@ -82,4 +82,13 @@ public function validate(&$errors=[], $options=[]): bool {
         }
         return true;
     }
+
+    /**
+     * Is this an interactive block?
+     * If true, we can't generate a static version.
+     * @return bool
+     */
+    public function is_interactive(): bool {
+        return true;
+    }
 }

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

@@ -105,4 +105,13 @@ public function postprocess(array $params, castext2_processor $processor, castex
     public function validate_extract_attributes(): array {
         return [];
     }
+
+    /**
+     * Is this an interactive block?
+     * If true, we can't generate a static version.
+     * @return bool
+     */
+    public function is_interactive(): bool {
+        return true;
+    }
 }

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

@@ -148,4 +148,13 @@ public function validate(&$errors=[], $options=[]): bool {
         }
         return true;
     }
+
+    /**
+     * Is this an interactive block?
+     * If true, we can't generate a static version.
+     * @return bool
+     */
+    public function is_interactive(): bool {
+        return true;
+    }
 }

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

@@ -82,4 +82,13 @@ public function postprocess(array $params, castext2_processor $processor,
 
         return $content;
     }
+
+    /**
+     * Is this an interactive block?
+     * If true, we can't generate a static version.
+     * @return bool
+     */
+    public function is_interactive(): bool {
+        return true;
+    }
 }

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

@@ -60,4 +60,13 @@ public function validate(
         }
         return true;
     }
+
+    /**
+     * Is this an interactive block?
+     * If true, we can't generate a static version.
+     * @return bool
+     */
+    public function is_interactive(): bool {
+        return true;
+    }
 }