From a4555fb2ecd6f4d23329cb1b4904814701c298f9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Stefan=20H=C3=B6hn?= <stefan@andreaundstefanhoehn.de>
Date: Sat, 25 Dec 2021 14:04:03 +0100
Subject: [PATCH] [blockly] fix item.getAttributes
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Stefan Höhn <stefan@andreaundstefanhoehn.de>
---
 .../definitions/blockly/blocks-items.js       | 63 +++++++++++++++++--
 .../definitions/blockly/blocks-things.js      |  2 +-
 .../settings/rules/script/blockly-editor.vue  |  2 +-
 3 files changed, 61 insertions(+), 6 deletions(-)

diff --git a/bundles/org.openhab.ui/web/src/assets/definitions/blockly/blocks-items.js b/bundles/org.openhab.ui/web/src/assets/definitions/blockly/blocks-items.js
index c84de96a8c..5465f938de 100644
--- a/bundles/org.openhab.ui/web/src/assets/definitions/blockly/blocks-items.js
+++ b/bundles/org.openhab.ui/web/src/assets/definitions/blockly/blocks-items.js
@@ -87,25 +87,80 @@ export default function (f7) {
     return [code, 0]
   }
 
+  /*
+  * Provides all attributes from an item
+  * - name: String
+  * - label: String
+  * - state: State
+  * - category: String
+  * - tags: Array
+  * - groups: Array
+  * - type: String
+  * Blockly part
+  */
   Blockly.Blocks['oh_getitem_attribute'] = {
     init: function () {
+      let thisBlock = this
+      let dropdown = new Blockly.FieldDropdown(
+        [['name', 'Name'], ['label', 'Label'], ['state', 'State'], ['category', 'Category'], ['tags', 'Tags'], ['groups', 'GroupNames'], ['type', 'Type']],
+        function (newMode) {
+          thisBlock.updateType_(newMode)
+        })
       this.appendValueInput('item')
         .appendField('get ')
-        .appendField(new Blockly.FieldDropdown([['name', 'Name'], ['label', 'Label'], ['state', 'State'], ['category', 'Category'], ['tags', 'Tags'], ['groups', 'GroupNames'], ['type', 'Type']]), 'attributeName')
+        .appendField(dropdown, 'attributeName')
         .appendField('of item')
         .setCheck('oh_itemtype')
       this.setInputsInline(false)
-      this.setOutput(true, 'any')
+      this.setOutput(true, 'String')
       this.setColour(0)
-      this.setTooltip('Retrieve a specific attribute from the item')
+      this.setTooltip('Retrieve a specific attribute from the item. Note that groups and tags return a list and should be used with the loops-block \'for each item ... in list\'. ')
       this.setHelpUrl('https://www.openhab.org/docs/configuration/items.html')
+    },
+    /**
+    * Modify this block to have the correct output type based on the attribute.
+    */
+    updateType_: function (newAttributeName) {
+      let attributeName = this.getFieldValue('attributeName')
+      if (newAttributeName === 'Tags' || newAttributeName === 'GroupNames') {
+        this.outputConnection.setCheck('Array')
+      } else {
+        this.outputConnection.setCheck('String')
+      }
+    },
+    /**
+    * Create XML to represent the input and output types.
+    * @return {!Element} XML storage element.
+    * @this {Blockly.Block}
+    */
+    mutationToDom: function () {
+      let container = Blockly.utils.xml.createElement('mutation')
+      container.setAttribute('attributeName', this.getFieldValue('attributeName'))
+      return container
+    },
+    /**
+    * Parse XML to restore the input and output types.
+    * @param {!Element} xmlElement XML storage element.
+    * @this {Blockly.Block}
+    */
+    domToMutation: function (xmlElement) {
+      this.updateType_(xmlElement.getAttribute('attributeName'))
     }
   }
 
+  /*
+  * Provides all attributes from an item
+  * Code part
+  */
   Blockly.JavaScript['oh_getitem_attribute'] = function (block) {
     const theItem = Blockly.JavaScript.valueToCode(block, 'item', Blockly.JavaScript.ORDER_ATOMIC)
     const attributeName = block.getFieldValue('attributeName')
-    let code = `${theItem}.get${attributeName}()`
+    let code = ''
+    if (attributeName === 'Tags' || attributeName === 'GroupNames') {
+      code = `Java.from(${theItem}.get${attributeName}())`
+    } else {
+      code = `${theItem}.get${attributeName}()`
+    }
     return [code, 0]
   }
 }
diff --git a/bundles/org.openhab.ui/web/src/assets/definitions/blockly/blocks-things.js b/bundles/org.openhab.ui/web/src/assets/definitions/blockly/blocks-things.js
index c43f2b77e7..b89c2832ef 100644
--- a/bundles/org.openhab.ui/web/src/assets/definitions/blockly/blocks-things.js
+++ b/bundles/org.openhab.ui/web/src/assets/definitions/blockly/blocks-things.js
@@ -29,7 +29,7 @@ export default function defineOHBlocks (f7) {
   Blockly.Blocks['oh_getthing_state'] = {
     init: function () {
       this.appendValueInput('thingUid')
-        .appendField('get thing state')
+        .appendField('get thing status')
         .setCheck('String')
       this.setInputsInline(false)
       this.setOutput(true, 'String')
diff --git a/bundles/org.openhab.ui/web/src/pages/settings/rules/script/blockly-editor.vue b/bundles/org.openhab.ui/web/src/pages/settings/rules/script/blockly-editor.vue
index 06c0fa446f..17ab9422d6 100644
--- a/bundles/org.openhab.ui/web/src/pages/settings/rules/script/blockly-editor.vue
+++ b/bundles/org.openhab.ui/web/src/pages/settings/rules/script/blockly-editor.vue
@@ -344,7 +344,7 @@
           <sep gap="48" />
           <block type="oh_thing" />
           <block type="oh_getthing_state">
-            <value name="itemName">
+            <value name="thingUid">
               <shadow type="oh_thing" />
             </value>
           </block>