Add ability to specify allowed blocks in the jpblockly files

packages/blockly/src/manager.ts

@@ -8,7 +8,14 @@ import { ISignal, Signal } from '@lumino/signaling';
 import * as Blockly from 'blockly';
 
 import { BlocklyRegistry } from './registry';
-import { ToolboxDefinition } from 'blockly/core/utils/toolbox';
+import {
+  BlockInfo,
+  DynamicCategoryInfo,
+  StaticCategoryInfo,
+  ToolboxDefinition,
+  ToolboxInfo,
+  ToolboxItemInfo
+} from 'blockly/core/utils/toolbox';
 
 /**
  * BlocklyManager the manager for each document
@@ -17,6 +24,7 @@ import { ToolboxDefinition } from 'blockly/core/utils/toolbox';
  */
 export class BlocklyManager {
   private _toolbox: string;
+  private _allowedBlocks: string[];
   private _generator: Blockly.Generator;
   private _registry: BlocklyRegistry;
   private _selectedKernel: KernelSpec.ISpecModel;
@@ -37,6 +45,7 @@ export class BlocklyManager {
     this._mimetypeService = mimetypeService;
 
     this._toolbox = 'default';
+    this._filterToolbox();
     this._generator = this._registry.generators.get('python');
 
     this._changed = new Signal<this, BlocklyManager.Change>(this);
@@ -112,6 +121,7 @@ export class BlocklyManager {
     if (this._toolbox !== name) {
       const toolbox = this._registry.toolboxes.get(name);
       this._toolbox = toolbox ? name : 'default';
+      this._filterToolbox();
       this._changed.emit('toolbox');
     }
   }
@@ -129,6 +139,73 @@ export class BlocklyManager {
     return list;
   }
 
+  /**
+   * Get the list of allowed blocks. If undefined, all blocks are allowed.
+   *
+   * @returns The list of allowed blocks.
+   */
+  getAllowedBlocks() {
+    return this._allowedBlocks;
+  }
+
+  /**
+   * Set the list of allowed blocks. If undefined, all blocks are allowed.
+   *
+   * @param allowedBlocks The list of allowed blocks.
+   */
+  setAllowedBlocks(allowedBlocks: string[]) {
+    this._allowedBlocks = allowedBlocks;
+    this._filterToolbox();
+    this._changed.emit('toolbox');
+  }
+
+  private _filterToolbox() {
+    const toolbox = this._registry.toolboxes.get(this._toolbox) as ToolboxInfo;
+    if (toolbox) {
+      this._filterContents(toolbox.contents);
+    }
+  }
+
+  private _filterContents(contents: ToolboxItemInfo[]): number {
+    let visible = 0;
+    contents.forEach(itemInfo => {
+      if ("kind" in itemInfo) {
+        if (itemInfo.kind.toUpperCase() === "CATEGORY") {
+          if ("contents" in itemInfo) {
+            const categoryInfo = itemInfo as StaticCategoryInfo;
+            if (this._filterContents(categoryInfo.contents) > 0) {
+              visible++;
+              categoryInfo.hidden = "false";
+            } else {
+              categoryInfo.hidden = "true";
+            }
+          } else if ("custom" in itemInfo) {
+            const categoryInfo = itemInfo as DynamicCategoryInfo;
+            if (this._allowedBlocks === undefined || this._allowedBlocks.includes(categoryInfo.custom.toLowerCase())) {
+              categoryInfo.hidden = "false";
+              visible++;
+              console.log("Category " + categoryInfo.custom + " is allowed");
+            } else {
+              categoryInfo.hidden = "true";
+              console.log("Category " + categoryInfo.custom + " is not allowed");
+            }
+          }
+        } else if (itemInfo.kind.toUpperCase() === "BLOCK") {
+          const blockInfo = itemInfo as BlockInfo;
+          if (this._allowedBlocks === undefined || this._allowedBlocks.includes(blockInfo.type.toLowerCase())) {
+            blockInfo.disabled = false;
+            blockInfo.disabledReasons = [];
+            visible++;
+          } else {
+            blockInfo.disabled = true;
+            blockInfo.disabledReasons = ["This block is not allowed"];
+          }
+        }
+      }
+    });
+    return visible;
+  }
+
   /**
    * Set the selected kernel.
    *

packages/blockly/src/widget.ts

@@ -174,6 +174,9 @@ export class BlocklyPanel extends SplitPanel {
             console.warn(`Unknown kernel in blockly file: ` + kernel);
           }
         }
+        if (metadata['allowed_blocks']) {
+          this._manager.setAllowedBlocks(metadata['allowed_blocks']);
+        }
       }
     } else {
       // Unsupported format
@@ -194,6 +197,7 @@ export class BlocklyPanel extends SplitPanel {
         workspace: workspace as any,
         metadata: {
           toolbox: this._manager.getToolbox(),
+          allowed_blocks: this._manager.getAllowedBlocks(),
           kernel: this._manager.kernel
         }
       };