Nested sitemaps

bundles/org.openhab.core.model.sitemap/src/org/openhab/core/model/sitemap/Sitemap.xtext

@@ -7,22 +7,31 @@ SitemapModel:
     {SitemapModel} (sitemaps += ModelSitemap)*;
 
 ModelSitemap:
-    'sitemap' name=ID ('label=' label=STRING)? ('icon=' icon=STRING)? '{'
+    'sitemap' name=ID ('label=' label=STRING)? ('icon=' icon=Icon)? '{'
     (children+=ModelWidget)*
     '}';
 
 ModelWidget:
-    (ModelLinkableWidget | ModelNonLinkableWidget);
+    ModelLinkableWidget | ModelNonLinkableWidget;
 
 ModelNonLinkableWidget:
-    ModelSwitch | ModelSelection | ModelSlider | ModelSetpoint | ModelVideo | ModelChart | ModelWebview | ModelColorpicker | ModelColortemperaturepicker | ModelMapview | ModelInput | ModelButton | ModelDefault;
+    ModelSwitch | ModelSelection | ModelSlider | ModelSetpoint | ModelVideo | ModelChart | ModelWebview | ModelColorpicker | ModelColortemperaturepicker | ModelMapview | ModelInput | ModelButton | ModelNestedSitemap | ModelDefault;
 
 ModelLinkableWidget:
     (ModelText | ModelGroup | ModelImage | ModelFrame | ModelButtongrid)
     ('{'
     (children+=ModelWidget)+
     '}')?;
 
+ModelNestedSitemap:
+    {ModelNestedSitemap} 'Sitemap' (('item=' item=ItemRef) | ('label=' label=(ID | STRING)) |
+    ('icon=' icon=Icon) | ('icon=' IconRules=ModelIconRuleList) | ('staticIcon=' staticIcon=Icon) |
+    ('name=' sitemapName=ID) | 
+    ('labelcolor=' labelColor=ModelColorArrayList) |
+    ('valuecolor=' valueColor=ModelColorArrayList) |
+    ('iconcolor=' iconColor=ModelColorArrayList) |
+    ('visibility=' visibility=ModelVisibilityRuleList))*;
+
 ModelFrame:
     {ModelFrame} 'Frame' (('item=' item=ItemRef) | ('label=' label=(ID | STRING)) |
     ('icon=' icon=Icon) | ('icon=' IconRules=ModelIconRuleList) | ('staticIcon=' staticIcon=Icon) |

bundles/org.openhab.core.model.sitemap/src/org/openhab/core/model/sitemap/internal/DslSitemapProvider.java

@@ -50,6 +50,7 @@
 import org.openhab.core.model.sitemap.sitemap.ModelMapping;
 import org.openhab.core.model.sitemap.sitemap.ModelMappingList;
 import org.openhab.core.model.sitemap.sitemap.ModelMapview;
+import org.openhab.core.model.sitemap.sitemap.ModelNestedSitemap;
 import org.openhab.core.model.sitemap.sitemap.ModelSelection;
 import org.openhab.core.model.sitemap.sitemap.ModelSetpoint;
 import org.openhab.core.model.sitemap.sitemap.ModelSitemap;
@@ -72,6 +73,7 @@
 import org.openhab.core.sitemap.LinkableWidget;
 import org.openhab.core.sitemap.Mapping;
 import org.openhab.core.sitemap.Mapview;
+import org.openhab.core.sitemap.NestedSitemap;
 import org.openhab.core.sitemap.Parent;
 import org.openhab.core.sitemap.Rule;
 import org.openhab.core.sitemap.Selection;
@@ -96,6 +98,7 @@
  *
  * @author Kai Kreuzer - Initial contribution
  * @author Mark Herwege - Separate registry from model
+ * @author Mark Herwege - Add support for nested sitemaps
  */
 @NonNullByDefault
 @Component(service = { SitemapProvider.class, DslSitemapProvider.class }, immediate = true)
@@ -133,12 +136,11 @@ protected void deactivate() {
     }
 
     @Override
-    public @Nullable Sitemap getSitemap(String sitemapName) {
+    public @Nullable Sitemap getSitemap(String name) {
         Sitemap sitemap = sitemapCache.entrySet().stream().filter(e -> !isIsolatedModel(e.getKey()))
-                .flatMap(e -> e.getValue().stream()).filter(s -> sitemapName.equals(s.getName())).findAny()
-                .orElse(null);
+                .flatMap(e -> e.getValue().stream()).filter(s -> name.equals(s.getName())).findAny().orElse(null);
         if (sitemap == null) {
-            logger.trace("Sitemap {} cannot be found", sitemapName);
+            logger.trace("Sitemap {} cannot be found", name);
         }
         return sitemap;
     }
@@ -251,6 +253,10 @@ private void addWidget(List<Widget> widgets, ModelWidget modelWidget, Parent par
                     ModelDefault modelDefault = (ModelDefault) modelWidget;
                     defaultWidget.setHeight(modelDefault.getHeight());
                     break;
+                case NestedSitemap nestedSitemapWidget:
+                    ModelNestedSitemap modelNestedSitemap = (ModelNestedSitemap) modelWidget;
+                    nestedSitemapWidget.setName(modelNestedSitemap.getSitemapName());
+                    break;
                 default:
                     break;
             }
@@ -287,6 +293,11 @@ private String getWidgetType(ModelWidget modelWidget) {
         String instanceTypeName = modelWidget.eClass().getInstanceTypeName();
         String widgetType = instanceTypeName
                 .substring(instanceTypeName.lastIndexOf("." + MODEL_TYPE_PREFIX) + MODEL_TYPE_PREFIX.length() + 1);
+        if (widgetType.equals("NestedSitemap")) {
+            // We need a different type for nested sitemaps, but can keep a common name for the model type, so we need
+            // to distinguish them here
+            widgetType = SitemapFactory.SITEMAP;
+        }
         return widgetType;
     }
 
@@ -316,8 +327,8 @@ private boolean addWidgetButtons(Buttongrid buttongridWidget, ModelButtongrid mo
                     "Defining buttons as properties of a Butongrid widget is deprecated although still supported; please prefer Button sub-widgets");
             EList<ModelButtonDefinition> modelButtons = modelButtonList.getElements();
             modelButtons.forEach(modelButton -> {
-                Button button = (Button) Objects.requireNonNull(sitemapFactory.createWidget(
-                        org.openhab.core.sitemap.internal.registry.SitemapFactoryImpl.BUTTON, buttongridWidget));
+                Button button = (Button) Objects
+                        .requireNonNull(sitemapFactory.createWidget(SitemapFactory.BUTTON, buttongridWidget));
                 button.setItem(modelButtongrid.getItem());
                 button.setRow(modelButton.getRow());
                 button.setColumn(modelButton.getColumn());
@@ -433,10 +444,9 @@ public void modelChanged(String modelName, EventType type) {
     }
 
     private void notifyRemovedSitemap(String modelName, Sitemap sitemap) {
-        String sitemapName = sitemap.getName();
+        String name = sitemap.getName();
         Sitemap existingSitemap = sitemapCache.entrySet().stream().filter(e -> !e.getKey().equals(modelName))
-                .flatMap(e -> e.getValue().stream()).filter(s -> sitemapName.equals(s.getName())).findAny()
-                .orElse(null);
+                .flatMap(e -> e.getValue().stream()).filter(s -> name.equals(s.getName())).findAny().orElse(null);
         if (existingSitemap != null) {
             // Another sitemap with the same name exists, so we need to update it to use the other one instead
             // of the removed one

bundles/org.openhab.core.model.sitemap/src/org/openhab/core/model/sitemap/internal/fileconverter/DslSitemapConverter.java

@@ -43,6 +43,7 @@
 import org.openhab.core.model.sitemap.sitemap.ModelMapping;
 import org.openhab.core.model.sitemap.sitemap.ModelMappingList;
 import org.openhab.core.model.sitemap.sitemap.ModelMapview;
+import org.openhab.core.model.sitemap.sitemap.ModelNestedSitemap;
 import org.openhab.core.model.sitemap.sitemap.ModelSelection;
 import org.openhab.core.model.sitemap.sitemap.ModelSetpoint;
 import org.openhab.core.model.sitemap.sitemap.ModelSitemap;
@@ -70,6 +71,7 @@
 import org.openhab.core.sitemap.LinkableWidget;
 import org.openhab.core.sitemap.Mapping;
 import org.openhab.core.sitemap.Mapview;
+import org.openhab.core.sitemap.NestedSitemap;
 import org.openhab.core.sitemap.Rule;
 import org.openhab.core.sitemap.Selection;
 import org.openhab.core.sitemap.Setpoint;
@@ -93,6 +95,7 @@
  * with the capabilities of parsing and generating file.
  *
  * @author Mark Herwege - Initial contribution
+ * @author Mark Herwege - Add support for nested sitemaps
  */
 @NonNullByDefault
 @Component(immediate = true, service = { SitemapSerializer.class, SitemapParser.class })
@@ -262,6 +265,11 @@ private ModelWidget buildModelWidget(Widget widget) {
                 modelChart.setInterpolation(chartWidget.getInterpolation());
                 modelWidget = modelChart;
             }
+            case NestedSitemap nestedSitemapWidget -> {
+                ModelNestedSitemap modelNestedSitemap = SitemapFactory.eINSTANCE.createModelNestedSitemap();
+                modelNestedSitemap.setSitemapName(nestedSitemapWidget.getName());
+                modelWidget = modelNestedSitemap;
+            }
             default -> {
                 ModelDefault modelDefault = SitemapFactory.eINSTANCE.createModelDefault();
                 if (widget instanceof Default defaultWidget) {

bundles/org.openhab.core.model.sitemap/src/org/openhab/core/model/sitemap/validation/SitemapValidator.xtend

@@ -35,6 +35,7 @@ import org.openhab.core.model.sitemap.sitemap.ModelWebview
 import org.openhab.core.model.sitemap.sitemap.ModelVideo
 import org.openhab.core.model.sitemap.sitemap.ModelWidget
 import org.openhab.core.model.sitemap.sitemap.SitemapPackage
+import org.openhab.core.model.sitemap.sitemap.ModelNestedSitemap
 
 /**
  * Custom validation rules.
@@ -47,7 +48,7 @@ class SitemapValidator extends AbstractSitemapValidator {
         "item=", "label=", "icon=", "staticIcon=", "labelcolor=", "valuecolor=", "iconcolor=", "visibility=",
         "url=", "encoding=", "service=", "refresh=", "period=", "legend=", "forceasitem=", "yAxisDecimalPattern=",
         "interpolation=", "mappings=", "height=", "switchSupport", "releaseOnly", "minValue=", "maxValue=", "step=",
-        "inputHint=", "buttons=", "row=", "column=", "stateless", "click=", "release="
+        "inputHint=", "buttons=", "row=", "column=", "stateless", "click=", "release=", "sitemapname="
     }
     val ALLOWED_HINTS = #{"text", "number", "date", "time", "datetime"}
     val ALLOWED_INTERPOLATION = #{"linear", "step"}
@@ -114,7 +115,10 @@ class SitemapValidator extends AbstractSitemapValidator {
 
     @Check
     def void checkWidgetHasItem(ModelWidget w) {
-        if (!(w instanceof ModelFrame || w instanceof ModelText || w instanceof ModelImage || w instanceof ModelVideo || w instanceof ModelWebview || w instanceof ModelButtongrid) && w.item === null) {
+        if (w instanceof ModelFrame || w instanceof ModelText || w instanceof ModelImage || w instanceof ModelVideo || w instanceof ModelWebview || w instanceof ModelButtongrid || w instanceof ModelNestedSitemap) {
+            return
+        }
+        if (w.item === null) {
             val node = NodeModelUtils.getNode(w)
             val line = node.startLine
             error(errorString(getWidgetType(w) + " widget doesn't have item defined", line),
@@ -377,4 +381,14 @@ class SitemapValidator extends AbstractSitemapValidator {
                 SitemapPackage.Literals.MODEL_WEBVIEW.getEStructuralFeature(SitemapPackage.MODEL_WEBVIEW__URL))
         }
     }
+
+    @Check
+    def void checkNestedSitemapParameters(ModelNestedSitemap w) {
+        if (w.item === null && w.sitemapName === null) {
+            val node = NodeModelUtils.getNode(w)
+            val line = node.startLine
+            error(errorString("Sitemap widget doesn't have item or sitemapname defined", line),
+                SitemapPackage.Literals.MODEL_NESTED_SITEMAP.getEStructuralFeature(SitemapPackage.MODEL_NESTED_SITEMAP__SITEMAP_NAME))
+        }
+    }
 }

bundles/org.openhab.core.model.yaml/src/main/java/org/openhab/core/model/yaml/internal/sitemaps/YamlSitemapDTO.java

@@ -176,6 +176,7 @@ private void addToList(@Nullable List<@NonNull String> list, String value) {
         result.command = partial.command;
         result.releaseCommand = partial.releaseCommand;
         result.stateless = partial.stateless;
+        result.name = partial.name;
 
         if (partial.label != null) {
             if (partial.label.isValueNode()) {
@@ -381,6 +382,7 @@ protected static class YamlPartialWidgetDTO {
         public String releaseCommand;
         public Boolean stateless;
         public JsonNode visibility;
+        public String name;
         public List<YamlPartialWidgetDTO> widgets;
     }
 }

bundles/org.openhab.core.model.yaml/src/main/java/org/openhab/core/model/yaml/internal/sitemaps/YamlSitemapProvider.java

@@ -38,6 +38,7 @@
 import org.openhab.core.sitemap.LinkableWidget;
 import org.openhab.core.sitemap.Mapping;
 import org.openhab.core.sitemap.Mapview;
+import org.openhab.core.sitemap.NestedSitemap;
 import org.openhab.core.sitemap.Parent;
 import org.openhab.core.sitemap.Rule;
 import org.openhab.core.sitemap.Selection;
@@ -64,6 +65,7 @@
  * These sitemaps are automatically exposed to the {@link SitemapRegistry}.
  *
  * @author Laurent Garnier - Initial contribution
+ * @author Mark Herwege - Add support for nested sitemaps
  */
 @NonNullByDefault
 @Component(immediate = true, service = { SitemapProvider.class, YamlSitemapProvider.class, YamlModelListener.class })
@@ -298,6 +300,9 @@ public void removedModel(String modelName, Collection<YamlSitemapDTO> elements)
                 case Default defaultWidget:
                     defaultWidget.setHeight(widgetDTO.height);
                     break;
+                case NestedSitemap nestedSitemapWidget:
+                    nestedSitemapWidget.setName(widgetDTO.name);
+                    break;
                 default:
                     break;
             }
@@ -387,12 +392,11 @@ private void addRuleConditions(List<Condition> conditions, @Nullable List<YamlCo
     }
 
     @Override
-    public @Nullable Sitemap getSitemap(String sitemapName) {
+    public @Nullable Sitemap getSitemap(String name) {
         Sitemap sitemap = sitemapsMap.entrySet().stream().filter(e -> !isIsolatedModel(e.getKey()))
-                .flatMap(e -> e.getValue().stream()).filter(s -> sitemapName.equals(s.getName())).findAny()
-                .orElse(null);
+                .flatMap(e -> e.getValue().stream()).filter(s -> name.equals(s.getName())).findAny().orElse(null);
         if (sitemap == null) {
-            logger.trace("Sitemap {} cannot be found", sitemapName);
+            logger.trace("Sitemap {} cannot be found", name);
         }
         return sitemap;
     }

bundles/org.openhab.core.model.yaml/src/main/java/org/openhab/core/model/yaml/internal/sitemaps/YamlWidgetDTO.java

@@ -12,7 +12,7 @@
  */
 package org.openhab.core.model.yaml.internal.sitemaps;
 
-import static org.openhab.core.sitemap.internal.registry.SitemapFactoryImpl.*;
+import static org.openhab.core.sitemap.registry.SitemapFactory.*;
 
 import java.math.BigDecimal;
 import java.util.ArrayList;
@@ -33,6 +33,7 @@
  * This is a data transfer object that is used to serialize widgets.
  *
  * @author Laurent Garnier - Initial contribution
+ * @author Mark Herwege - Add support for nested sitemaps
  */
 public class YamlWidgetDTO {
 
@@ -61,6 +62,7 @@ public class YamlWidgetDTO {
         MANDATORY_FIELDS.put(VIDEO, Set.of("url"));
         MANDATORY_FIELDS.put(MAPVIEW, Set.of("item"));
         MANDATORY_FIELDS.put(WEBVIEW, Set.of("url"));
+        MANDATORY_FIELDS.put(SITEMAP, Set.of());
         MANDATORY_FIELDS.put(DEFAULT, Set.of("item"));
 
         OPTIONAL_FIELDS.put(FRAME, Set.of("item"));
@@ -81,6 +83,7 @@ public class YamlWidgetDTO {
         OPTIONAL_FIELDS.put(VIDEO, Set.of("item", "encoding"));
         OPTIONAL_FIELDS.put(MAPVIEW, Set.of("height"));
         OPTIONAL_FIELDS.put(WEBVIEW, Set.of("item", "height"));
+        OPTIONAL_FIELDS.put(SITEMAP, Set.of("item", "name"));
         OPTIONAL_FIELDS.put(DEFAULT, Set.of("height"));
     }
 
@@ -113,6 +116,7 @@ public class YamlWidgetDTO {
     public String command;
     public String releaseCommand;
     public Boolean stateless;
+    public String name; // for NestedSitemap
 
     public Object visibility;
 
@@ -164,6 +168,7 @@ public boolean isValid(@NonNull List<@NonNull String> errors, @NonNull List<@Non
         ok &= isValidField("command", command, errors, warnings);
         ok &= isValidField("releaseCommand", releaseCommand, errors, warnings);
         ok &= isValidField("stateless", stateless, errors, warnings);
+        ok &= isValidField("name", name, errors, warnings);
 
         if ((SWITCH.equals(type) || SELECTION.equals(type)) && mappings != null && !mappings.isEmpty()) {
             for (YamlMappingDTO mapping : mappings) {
@@ -174,6 +179,9 @@ public boolean isValid(@NonNull List<@NonNull String> errors, @NonNull List<@Non
                 && minValue.doubleValue() > maxValue.doubleValue()) {
             addToList(warnings, "larger value %f for \"min\" field than value %f for \"max\" field"
                     .formatted(minValue.doubleValue(), maxValue.doubleValue()));
+        } else if (SITEMAP.equals(type) && (name == null || name.isBlank()) && (item == null || item.isBlank())) {
+            addToList(errors, "\"name\" or \"item\" field missing while mandatory for Sitemap widget");
+            ok = false;
         }
 
         List<String> ruleErrors = new ArrayList<>();
@@ -354,7 +362,7 @@ private void addToList(@Nullable List<@NonNull String> list, String value) {
     public int hashCode() {
         return Objects.hash(type, item, label, icon, mappings, switchSupport, releaseOnly, height, min, max, step, hint,
                 url, refresh, encoding, service, period, legend, forceAsItem, yAxisDecimalPattern, interpolation, row,
-                column, command, releaseCommand, stateless, visibility, widgets);
+                column, command, releaseCommand, stateless, visibility, widgets, name);
     }
 
     @Override
@@ -378,7 +386,8 @@ public boolean equals(@Nullable Object obj) {
                 && Objects.equals(interpolation, other.interpolation) && Objects.equals(row, other.row)
                 && Objects.equals(column, other.column) && Objects.equals(command, other.command)
                 && Objects.equals(releaseCommand, other.releaseCommand) && Objects.equals(stateless, other.stateless)
-                && Objects.equals(visibility, other.visibility) && Objects.equals(widgets, other.widgets);
+                && Objects.equals(visibility, other.visibility) && Objects.equals(widgets, other.widgets)
+                && Objects.equals(name, other.name);
     }
 
     record ButtonPosition(Integer row, Integer column) {

bundles/org.openhab.core.model.yaml/src/main/java/org/openhab/core/model/yaml/internal/sitemaps/fileconverter/YamlSitemapConverter.java

@@ -41,6 +41,7 @@
 import org.openhab.core.sitemap.LinkableWidget;
 import org.openhab.core.sitemap.Mapping;
 import org.openhab.core.sitemap.Mapview;
+import org.openhab.core.sitemap.NestedSitemap;
 import org.openhab.core.sitemap.Rule;
 import org.openhab.core.sitemap.Selection;
 import org.openhab.core.sitemap.Setpoint;
@@ -60,6 +61,7 @@
  * {@link YamlSitemapConverter} is the YAML converter for {@link Sitemap} objects.
  *
  * @author Laurent Garnier - Initial contribution
+ * @author Mark Herwege - Add support for nested sitemaps
  */
 @NonNullByDefault
 @Component(immediate = true, service = { SitemapSerializer.class, SitemapParser.class })
@@ -304,6 +306,9 @@ private YamlWidgetDTO buildWidgetDTO(Widget widget) {
                     dto.height = defaultWidget.getHeight();
                 }
             }
+            case NestedSitemap nestedSitemapWidget -> {
+                dto.name = nestedSitemapWidget.getName();
+            }
             default -> {
             }
         }