[REST] New REST APIs to generate DSL syntax for items and things

Related to openhab#4509

Added REST APIs:

 - GET /file-format/existing/items to create file format for all existing items in registry
 - GET /file-format/existing/item/{itemname} to create file format for an existing item in registry
 - GET /file-format/existing/things to create file format for all existing things in registry
 - GET /file-format/existing/thing/{thingUID} to create file format for an existing thing in registry
 - GET /file-format/existing/thing-from-inbox/{thingUID} to create file format for an existing thing in discovey registry

All these APIs have a boolean parameter named "hideDefaultParameters" to hide or show the configuration parameters having the default value. They are hidden by default.

Signed-off-by: Laurent Garnier <[email protected]>

Author: lolodomo

bundles/org.openhab.core.io.rest.core/src/main/java/org/openhab/core/io/rest/core/internal/fileformat/FileFormatResource.java

@@ -26,6 +26,7 @@
  * come from.
  *
  * @author Kai Kreuzer - Initial contribution
+ * @author Laurent Garnier - Added method generateSyntaxFromModel
  */
 @NonNullByDefault
 public interface ModelRepository {
@@ -92,4 +93,13 @@ public interface ModelRepository {
      * @param listener the listener to remove
      */
     void removeModelRepositoryChangeListener(ModelRepositoryChangeListener listener);
+
+    /**
+     * Generate the syntax from a provided model content.
+     *
+     * @param modelType the model type
+     * @param modelContent the content of the model
+     * @return the corresponding syntax
+     */
+    String generateSyntaxFromModel(String modelType, EObject modelContent);
 }

bundles/org.openhab.core.model.core/src/main/java/org/openhab/core/model/core/ModelRepository.java

@@ -13,6 +13,7 @@
 package org.openhab.core.model.core.internal;
 
 import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
@@ -50,6 +51,7 @@
  * @author Kai Kreuzer - Initial contribution
  * @author Oliver Libutzki - Added reloadAllModelsOfType method
  * @author Simon Kaufmann - added validation of models before loading them
+ * @author Laurent Garnier - Added method generateSyntaxFromModel
  */
 @Component(immediate = true)
 @NonNullByDefault
@@ -64,6 +66,8 @@ public class ModelRepositoryImpl implements ModelRepository {
 
     private final SafeEMF safeEmf;
 
+    private int counter;
+
     @Activate
     public ModelRepositoryImpl(final @Reference SafeEMF safeEmf) {
         this.safeEmf = safeEmf;
@@ -171,7 +175,8 @@ public Iterable<String> getAllModelNamesOfType(final String modelType) {
 
             return resourceListCopy.stream()
                     .filter(input -> input.getURI().lastSegment().contains(".") && input.isLoaded()
-                            && modelType.equalsIgnoreCase(input.getURI().fileExtension()))
+                            && modelType.equalsIgnoreCase(input.getURI().fileExtension())
+                            && !input.getURI().lastSegment().startsWith("tmp_"))
                     .map(from -> from.getURI().path()).toList();
         }
     }
@@ -227,6 +232,26 @@ public void removeModelRepositoryChangeListener(ModelRepositoryChangeListener li
         listeners.remove(listener);
     }
 
+    @Override
+    public String generateSyntaxFromModel(String modelType, EObject modelContent) {
+        String result = "";
+        synchronized (resourceSet) {
+            String name = "tmp_generated_syntax_%d.%s".formatted(++counter, modelType);
+            Resource resource = resourceSet.createResource(URI.createURI(name));
+            try {
+                resource.getContents().add(modelContent);
+                ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+                resource.save(outputStream, Map.of(XtextResource.OPTION_ENCODING, StandardCharsets.UTF_8.name()));
+                result = new String(outputStream.toByteArray());
+            } catch (IOException e) {
+                logger.warn("Exception when saving the model {}", resource.getURI().lastSegment());
+            } finally {
+                resourceSet.getResources().remove(resource);
+            }
+        }
+        return result;
+    }
+
     private @Nullable Resource getResource(String name) {
         return resourceSet.getResource(URI.createURI(name), false);
     }

bundles/org.openhab.core.model.core/src/main/java/org/openhab/core/model/core/internal/ModelRepositoryImpl.java

@@ -20,6 +20,7 @@ Import-Package: javax.measure,\
  org.openhab.core.common.registry,\
  org.openhab.core.i18n,\
  org.openhab.core.items,\
+ org.openhab.core.items.syntax,\
  org.openhab.core.items.dto,\
  org.openhab.core.library.items,\
  org.openhab.core.library.types,\

bundles/org.openhab.core.model.item/bnd.bnd

@@ -18,19 +18,24 @@ org.openhab.core.model
 
 import com.google.inject.Binder
 import com.google.inject.name.Names
+import org.openhab.core.model.formatting.ItemsFormatter
 import org.openhab.core.model.internal.valueconverter.ItemValueConverters
 import org.eclipse.xtext.conversion.IValueConverterService
+import org.eclipse.xtext.formatting.IFormatter
 import org.eclipse.xtext.linking.lazy.LazyURIEncoder
 
 /** 
  * Use this class to register components to be used at runtime / without the Equinox extension registry.
  */
 class ItemsRuntimeModule extends AbstractItemsRuntimeModule {
-    
     override Class<? extends IValueConverterService> bindIValueConverterService() {
         return ItemValueConverters
     }
-    
+
+    override Class<? extends IFormatter> bindIFormatter() {
+        return ItemsFormatter
+    }
+
     override void configureUseIndexFragmentsForLazyLinking(Binder binder) {
         binder.bind(Boolean.TYPE).annotatedWith(Names.named(LazyURIEncoder.USE_INDEXED_FRAGMENTS_BINDING)).toInstance(
             Boolean.FALSE)

bundles/org.openhab.core.model.item/src/org/openhab/core/model/ItemsRuntimeModule.xtend

@@ -26,17 +26,17 @@ class ItemsFormatter extends AbstractDeclarativeFormatter {
 
 	override protected void configureFormatting(FormattingConfig c) {
 		c.setLinewrap(1, 1, 2).before(modelGroupItemRule)
-		c.setLinewrap(1, 1, 2).before(modelItemTypeRule)
+		c.setLinewrap(1, 1, 2).before(modelNormalItemRule)
 
 		c.setNoSpace().withinKeywordPairs("<", ">")
 		c.setNoSpace().withinKeywordPairs("(", ")")
+		c.setNoSpace().withinKeywordPairs("[", "]")
 
-		c.setIndentationIncrement.after(modelItemTypeRule)
-		c.setIndentationDecrement.before(modelItemTypeRule)
-		c.setIndentationIncrement.after(modelGroupItemRule)
-		c.setIndentationDecrement.before(modelGroupItemRule)
+		c.setNoSpace().around(":", "=")
+		c.setNoSpace().before(",")
+
+		c.autoLinewrap = 400
 
-		c.autoLinewrap = 160
 		c.setLinewrap(0, 1, 2).before(SL_COMMENTRule)
 		c.setLinewrap(0, 1, 2).before(ML_COMMENTRule)
 		c.setLinewrap(0, 1, 1).after(ML_COMMENTRule)
@@ -48,4 +48,16 @@ class ItemsFormatter extends AbstractDeclarativeFormatter {
 			locator.before(pair.second)
 		}
 	}
+
+	def around(FormattingConfig.ElementLocator locator, String ... listKW) {
+		for (keyword : findKeywords(listKW)) {
+			locator.around(keyword)
+		}
+	}
+
+	def before(FormattingConfig.ElementLocator locator, String ... listKW) {
+		for (keyword : findKeywords(listKW)) {
+			locator.before(keyword)
+		}
+	}
 }