Add access to various system registries, OSGi instances and the ability to run and enable/disable rules to DSL scripts

Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>

Author: Ravi Nadahar

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

@@ -19,6 +19,7 @@ Export-Package: org.openhab.core.model.script,\
  org.openhab.core.model.script.validation
 Import-Package: \
  org.openhab.core.audio,\
+ org.openhab.core.automation,\
  org.openhab.core.automation.module.script.action,\
  org.openhab.core.automation.module.script.rulesupport.shared,\
  org.openhab.core.common.registry,\

bundles/org.openhab.core.model.script/pom.xml

@@ -50,6 +50,11 @@
       <artifactId>org.openhab.core.io.net</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.openhab.core.bundles</groupId>
+      <artifactId>org.openhab.core.automation</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.openhab.core.bundles</groupId>
       <artifactId>org.openhab.core.automation.module.script</artifactId>

bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/ScriptServiceUtil.java

@@ -16,8 +16,11 @@
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.concurrent.atomic.AtomicReference;
 
+import org.openhab.core.automation.RuleManager;
+import org.openhab.core.automation.RuleRegistry;
 import org.openhab.core.events.EventPublisher;
 import org.openhab.core.items.ItemRegistry;
+import org.openhab.core.items.MetadataRegistry;
 import org.openhab.core.model.core.ModelRepository;
 import org.openhab.core.model.script.engine.ScriptEngine;
 import org.openhab.core.model.script.engine.action.ActionService;
@@ -50,6 +53,9 @@ public class ScriptServiceUtil {
     private final ThingRegistry thingRegistry;
     private final EventPublisher eventPublisher;
     private final ModelRepository modelRepository;
+    private final MetadataRegistry metadataRegistry;
+    private final RuleRegistry ruleRegistry;
+    private final RuleManager ruleManager;
     private final Scheduler scheduler;
 
     private final AtomicReference<ScriptEngine> scriptEngine = new AtomicReference<>();
@@ -59,11 +65,15 @@ public class ScriptServiceUtil {
     @Activate
     public ScriptServiceUtil(final @Reference ItemRegistry itemRegistry, final @Reference ThingRegistry thingRegistry,
             final @Reference EventPublisher eventPublisher, final @Reference ModelRepository modelRepository,
-            final @Reference Scheduler scheduler) {
+            final @Reference MetadataRegistry metadataRegistry, final @Reference RuleRegistry ruleRegistry,
+            final @Reference RuleManager ruleManager, final @Reference Scheduler scheduler) {
         this.itemRegistry = itemRegistry;
         this.thingRegistry = thingRegistry;
         this.eventPublisher = eventPublisher;
         this.modelRepository = modelRepository;
+        this.metadataRegistry = metadataRegistry;
+        this.ruleRegistry = ruleRegistry;
+        this.ruleManager = ruleManager;
         this.scheduler = scheduler;
 
         if (instance != null) {
@@ -91,6 +101,10 @@ public ItemRegistry getItemRegistryInstance() {
         return itemRegistry;
     }
 
+    public static ThingRegistry getThingRegistry() {
+        return getInstance().thingRegistry;
+    }
+
     public ThingRegistry getThingRegistryInstance() {
         return thingRegistry;
     }
@@ -107,6 +121,30 @@ public ModelRepository getModelRepositoryInstance() {
         return modelRepository;
     }
 
+    public static MetadataRegistry getMetadataRegistry() {
+        return getInstance().metadataRegistry;
+    }
+
+    public MetadataRegistry getMetadataRegistryInstance() {
+        return metadataRegistry;
+    }
+
+    public static RuleRegistry getRuleRegistry() {
+        return getInstance().ruleRegistry;
+    }
+
+    public RuleRegistry getRuleRegistryInstance() {
+        return ruleRegistry;
+    }
+
+    public static RuleManager getRuleManager() {
+        return getInstance().ruleManager;
+    }
+
+    public RuleManager getRuleManagerInstance() {
+        return ruleManager;
+    }
+
     public static Scheduler getScheduler() {
         return getInstance().scheduler;
     }

bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/actions/System.java

@@ -0,0 +1,182 @@
+/*
+ * Copyright (c) 2010-2026 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.core.model.script.actions;
+
+import java.util.Map;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+import org.openhab.core.automation.RuleManager;
+import org.openhab.core.automation.RuleRegistry;
+import org.openhab.core.items.ItemRegistry;
+import org.openhab.core.items.MetadataRegistry;
+import org.openhab.core.model.script.ScriptServiceUtil;
+import org.openhab.core.model.script.engine.action.ActionDoc;
+import org.openhab.core.thing.ThingRegistry;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.FrameworkUtil;
+import org.osgi.framework.ServiceReference;
+
+/**
+ * {@link System} provides DSL access to things like OSGi instances, system registries and the ability to run other
+ * rules.
+ *
+ * @author Ravi Nadahar - Initial contribution
+ */
+@NonNullByDefault
+public class System {
+
+    /**
+     * Retrieve an OSGi instance of the specified {@link Class}, if it exists.
+     *
+     * @param <T> the class type.
+     * @param clazz the class of the instance to get.
+     * @return The instance or {@code null} if the instance wasn't found.
+     */
+    @ActionDoc(text = "acquire an OSGi instance")
+    public static @Nullable <T> T getInstance(Class<T> clazz) {
+        Bundle bundle = FrameworkUtil.getBundle(clazz);
+        if (bundle != null) {
+            BundleContext bc = bundle.getBundleContext();
+            if (bc != null) {
+                ServiceReference<T> ref = bc.getServiceReference(clazz);
+                if (ref != null) {
+                    return bc.getService(ref);
+                }
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Run the rule with the specified UID.
+     *
+     * @param ruleUID the UID of the rule to run.
+     * @return A copy of the rule context, including possible return values.
+     * @throws IllegalArgumentException If a rule with the specified UID doesn't exist.
+     */
+    @ActionDoc(text = "run the rule with the specified UID")
+    public static Map<String, Object> runRule(String ruleUID) {
+        RuleManager ruleManager = ScriptServiceUtil.getRuleManager();
+        if (ruleManager.getStatus(ruleUID) == null) {
+            throw new IllegalArgumentException("Rule with UID '" + ruleUID + "' doesn't exist");
+        }
+        return ruleManager.runNow(ruleUID);
+    }
+
+    /**
+     * Run the rule with the specified UID with the specified context.
+     *
+     * @param ruleUID the UID of the rule to run.
+     * @param context the {@link Map} of {@link String} and {@link Object} pairs that constitutes the context.
+     * @return A copy of the rule context, including possible return values.
+     * @throws IllegalArgumentException If a rule with the specified UID doesn't exist.
+     */
+    @ActionDoc(text = "run the rule with the specified UID and context")
+    public static Map<String, Object> runRule(String ruleUID, Map<String, Object> context) {
+        RuleManager ruleManager = ScriptServiceUtil.getRuleManager();
+        if (ruleManager.getStatus(ruleUID) == null) {
+            throw new IllegalArgumentException("Rule with UID '" + ruleUID + "' doesn't exist");
+        }
+        return ruleManager.runNow(ruleUID, false, context);
+    }
+
+    /**
+     * Run the rule with the specified UID with the specified context, while optionally taking conditions into
+     * account.
+     *
+     * @param ruleUID the UID of the rule to run.
+     * @param considerConditions {@code true} to not run the rule if its conditions don't qualify.
+     * @param context the {@link Map} of {@link String} and {@link Object} pairs that constitutes the context.
+     * @return A copy of the rule context, including possible return values.
+     * @throws IllegalArgumentException If a rule with the specified UID doesn't exist.
+     */
+    @ActionDoc(text = "run the rule with the specified UID, condition evaluation setting and context")
+    public static Map<String, Object> runRule(String ruleUID, boolean considerConditions, Map<String, Object> context) {
+        RuleManager ruleManager = ScriptServiceUtil.getRuleManager();
+        if (ruleManager.getStatus(ruleUID) == null) {
+            throw new IllegalArgumentException("Rule with UID '" + ruleUID + "' doesn't exist");
+        }
+        return ruleManager.runNow(ruleUID, considerConditions, context);
+    }
+
+    /**
+     * Check whether the specified rule is enabled.
+     *
+     * @param ruleUID the UID of the rule to check.
+     * @return {@code true} if the rule is enabled, {@code false} otherwise.
+     * @throws IllegalArgumentException If a rule with the specified UID doesn't exist.
+     */
+    @ActionDoc(text = "check whether the specified rule rule is enabled")
+    public static boolean isRuleEnabled(String ruleUID) {
+        RuleManager ruleManager = ScriptServiceUtil.getRuleManager();
+        Boolean result = ruleManager.isEnabled(ruleUID);
+        if (result == null) {
+            throw new IllegalArgumentException("Rule with UID '" + ruleUID + "' doesn't exist");
+        }
+        return result.booleanValue();
+    }
+
+    /**
+     * Set whether the specified rule is enabled.
+     *
+     * @param ruleUID the UID of the rule to enable or disable.
+     * @param enabled {@code true} to enable the rule, {@code false} to disable the rule.
+     * @throws IllegalArgumentException If a rule with the specified UID doesn't exist.
+     */
+    @ActionDoc(text = "set whether the specified rule is enabled")
+    public static void setRuleEnabled(String ruleUID, boolean enabled) {
+        ScriptServiceUtil.getRuleManager().setEnabled(ruleUID, enabled);
+    }
+
+    /**
+     * @return The {@link ThingRegistry}.
+     */
+    @ActionDoc(text = "get the thing registry")
+    public static ThingRegistry getThingRegistry() {
+        return ScriptServiceUtil.getThingRegistry();
+    }
+
+    /**
+     * @return The {@link MetadataRegistry}.
+     */
+    @ActionDoc(text = "get the metadata registry")
+    public static MetadataRegistry getMetadataRegistry() {
+        return ScriptServiceUtil.getMetadataRegistry();
+    }
+
+    /**
+     * @return The {@link ItemRegistry}.
+     */
+    @ActionDoc(text = "get the item registry")
+    public static ItemRegistry getItemRegistry() {
+        return ScriptServiceUtil.getItemRegistry();
+    }
+
+    /**
+     * @return The {@link RuleRegistry}.
+     */
+    @ActionDoc(text = "get the rule registry")
+    public static RuleRegistry getRuleRegistry() {
+        return ScriptServiceUtil.getRuleRegistry();
+    }
+
+    /**
+     * @return The {@link RuleManager}.
+     */
+    @ActionDoc(text = "get the rule manager")
+    public static RuleManager getRuleManager() {
+        return ScriptServiceUtil.getRuleManager();
+    }
+}

bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/scoping/ScriptImplicitlyImportedTypes.java

@@ -35,6 +35,7 @@
 import org.openhab.core.model.script.actions.Log;
 import org.openhab.core.model.script.actions.Ping;
 import org.openhab.core.model.script.actions.ScriptExecution;
+import org.openhab.core.model.script.actions.System;
 import org.openhab.core.model.script.actions.Transformation;
 import org.openhab.core.model.script.engine.IActionServiceProvider;
 import org.openhab.core.model.script.engine.IThingActionsProvider;
@@ -76,6 +77,7 @@ protected List<Class<?>> getExtensionClasses() {
         result.add(Ping.class);
         result.add(Transformation.class);
         result.add(ScriptExecution.class);
+        result.add(System.class);
         result.add(URLEncoder.class);
 
         result.addAll(getActionClasses());
@@ -92,6 +94,7 @@ protected List<Class<?>> getStaticImportClasses() {
         result.add(Ping.class);
         result.add(Transformation.class);
         result.add(ScriptExecution.class);
+        result.add(System.class);
         result.add(URLEncoder.class);
         result.add(CoreUtil.class);