git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.automation.jsscripting.internal;
  14
  15 import static org.openhab.core.automation.module.script.ScriptEngineFactory.*;
  16
  17 import java.io.IOException;
  18 import java.io.InputStream;
  19 import java.io.InputStreamReader;
  20 import java.io.Reader;
  21 import java.nio.channels.SeekableByteChannel;
  22 import java.nio.file.AccessMode;
  23 import java.nio.file.FileSystems;
  24 import java.nio.file.LinkOption;
  25 import java.nio.file.NoSuchFileException;
  26 import java.nio.file.OpenOption;
  27 import java.nio.file.Path;
  28 import java.nio.file.Paths;
  29 import java.nio.file.attribute.FileAttribute;
  30 import java.time.Duration;
  31 import java.time.ZonedDateTime;
  32 import java.util.Collections;
  33 import java.util.Map;
  34 import java.util.Set;
  35 import java.util.concurrent.locks.Lock;
  36 import java.util.concurrent.locks.ReentrantLock;
  37 import java.util.function.Consumer;
  38 import java.util.function.Function;
  39
  40 import javax.script.ScriptContext;
  41 import javax.script.ScriptException;
  42
  43 import org.eclipse.jdt.annotation.Nullable;
  44 import org.graalvm.polyglot.Context;
  45 import org.graalvm.polyglot.Engine;
  46 import org.graalvm.polyglot.HostAccess;
  47 import org.graalvm.polyglot.Source;
  48 import org.graalvm.polyglot.Value;
  49 import org.openhab.automation.jsscripting.internal.fs.DelegatingFileSystem;
  50 import org.openhab.automation.jsscripting.internal.fs.PrefixedSeekableByteChannel;
  51 import org.openhab.automation.jsscripting.internal.fs.ReadOnlySeekableByteArrayChannel;
  52 import org.openhab.automation.jsscripting.internal.fs.watch.JSDependencyTracker;
  53 import org.openhab.automation.jsscripting.internal.scriptengine.InvocationInterceptingScriptEngineWithInvocableAndAutoCloseable;
  54 import org.openhab.core.automation.module.script.ScriptExtensionAccessor;
  55 import org.openhab.core.items.Item;
  56 import org.openhab.core.library.types.QuantityType;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 import com.oracle.truffle.js.scriptengine.GraalJSScriptEngine;
  61
  62 /**
  63  * GraalJS ScriptEngine implementation
  64  *
  65  * @author Jonathan Gilbert - Initial contribution
  66  * @author Dan Cunningham - Script injections
  67  * @author Florian Hotze - Create lock object for multi-thread synchronization; Inject the {@link JSRuntimeFeatures}
  68  *         into the JS context; Fix memory leak caused by HostObject by making HostAccess reference static; Switch to
  69  *         {@link Lock} for multi-thread synchronization; globals & openhab-js injection code caching
  70  */
  71 public class OpenhabGraalJSScriptEngine
  72         extends InvocationInterceptingScriptEngineWithInvocableAndAutoCloseable<GraalJSScriptEngine> {
  73
  74     private static final Logger LOGGER = LoggerFactory.getLogger(OpenhabGraalJSScriptEngine.class);
  75     private static Source GLOBAL_SOURCE;
  76     static {
  77         try {
  78             GLOBAL_SOURCE = Source.newBuilder("js", getFileAsReader("node_modules/@jsscripting-globals.js"),
  79                     "@jsscripting-globals.js").cached(true).build();
  80         } catch (IOException e) {
  81             throw new RuntimeException("Failed to load @jsscripting-globals.js", e);
  82         }
  83     }
  84
  85     private static Source OPENHAB_JS_SOURCE;
  86     static {
  87         try {
  88             OPENHAB_JS_SOURCE = Source
  89                     .newBuilder("js", getFileAsReader("node_modules/@openhab-globals.js"), "@openhab-globals.js")
  90                     .cached(true).build();
  91         } catch (IOException e) {
  92             throw new RuntimeException("Failed to load @openhab-globals.js", e);
  93         }
  94     }
  95     private static final String OPENHAB_JS_INJECTION_CODE = "Object.assign(this, require('openhab'));";
  96
  97     private static final String REQUIRE_WRAPPER_NAME = "__wraprequire__";
  98     /** Final CommonJS search path for our library */
  99     private static final Path NODE_DIR = Paths.get("node_modules");
 100     /** Shared Polyglot {@link Engine} across all instances of {@link OpenhabGraalJSScriptEngine} */
 101     private static final Engine ENGINE = Engine.newBuilder().allowExperimentalOptions(true)
 102             .option("engine.WarnInterpreterOnly", "false").build();
 103     /** Provides unlimited host access as well as custom translations from JS to Java Objects */
 104     private static final HostAccess HOST_ACCESS = HostAccess.newBuilder(HostAccess.ALL)
 105             // Translate JS-Joda ZonedDateTime to java.time.ZonedDateTime
 106             .targetTypeMapping(Value.class, ZonedDateTime.class, v -> v.hasMember("withFixedOffsetZone"),
 107                     v -> ZonedDateTime.parse(v.invokeMember("withFixedOffsetZone").invokeMember("toString").asString()),
 108                     HostAccess.TargetMappingPrecedence.LOW)
 109
 110             // Translate JS-Joda Duration to java.time.Duration
 111             .targetTypeMapping(Value.class, Duration.class,
 112                     // picking two members to check as Duration has many common function names
 113                     v -> v.hasMember("minusDuration") && v.hasMember("toNanos"),
 114                     v -> Duration.ofNanos(v.invokeMember("toNanos").asLong()), HostAccess.TargetMappingPrecedence.LOW)
 115
 116             // Translate openhab-js Item to org.openhab.core.items.Item
 117             .targetTypeMapping(Value.class, Item.class, v -> v.hasMember("rawItem"),
 118                     v -> v.getMember("rawItem").as(Item.class), HostAccess.TargetMappingPrecedence.LOW)
 119
 120             // Translate openhab-js Quantity to org.openhab.core.library.types.QuantityType
 121             .targetTypeMapping(Value.class, QuantityType.class, v -> v.hasMember("raw") && v.hasMember("toUnit"),
 122                     v -> v.getMember("raw").as(QuantityType.class), HostAccess.TargetMappingPrecedence.LOW)
 123             .build();
 124
 125     /** {@link Lock} synchronization of multi-thread access */
 126     private final Lock lock = new ReentrantLock();
 127     private final JSRuntimeFeatures jsRuntimeFeatures;
 128
 129     // these fields start as null because they are populated on first use
 130     private String engineIdentifier;
 131     private @Nullable Consumer<String> scriptDependencyListener;
 132
 133     private boolean initialized = false;
 134     private final boolean injectionEnabled;
 135     private final boolean useIncludedLibrary;
 136
 137     /**
 138      * Creates an implementation of ScriptEngine (& Invocable), wrapping the contained engine, that tracks the script
 139      * lifecycle and provides hooks for scripts to do so too.
 140      */
 141     public OpenhabGraalJSScriptEngine(boolean injectionEnabled, boolean useIncludedLibrary,
 142             JSScriptServiceUtil jsScriptServiceUtil) {
 143         super(null); // delegate depends on fields not yet initialised, so we cannot set it immediately
 144         this.injectionEnabled = injectionEnabled;
 145         this.useIncludedLibrary = useIncludedLibrary;
 146         this.jsRuntimeFeatures = jsScriptServiceUtil.getJSRuntimeFeatures(lock);
 147
 148         LOGGER.debug("Initializing GraalJS script engine...");
 149
 150         delegate = GraalJSScriptEngine.create(ENGINE,
 151                 Context.newBuilder("js").allowExperimentalOptions(true).allowAllAccess(true)
 152                         .allowHostAccess(HOST_ACCESS).option("js.commonjs-require-cwd", JSDependencyTracker.LIB_PATH)
 153                         .option("js.nashorn-compat", "true") // Enable Nashorn compat mode as openhab-js relies on
 154                                                              // accessors, see
 155                                                              // https://github.com/oracle/graaljs/blob/master/docs/user/NashornMigrationGuide.md#accessors
 156                         .option("js.ecmascript-version", "2022") // If Nashorn compat is enabled, it will enforce ES5
 157                                                                  // compatibility, we want ECMA2022
 158                         .option("js.commonjs-require", "true") // Enable CommonJS module support
 159                         .hostClassLoader(getClass().getClassLoader())
 160                         .fileSystem(new DelegatingFileSystem(FileSystems.getDefault().provider()) {
 161                             @Override
 162                             public SeekableByteChannel newByteChannel(Path path, Set<? extends OpenOption> options,
 163                                     FileAttribute<?>... attrs) throws IOException {
 164                                 Consumer<String> localScriptDependencyListener = scriptDependencyListener;
 165                                 if (localScriptDependencyListener != null) {
 166                                     localScriptDependencyListener.accept(path.toString());
 167                                 }
 168
 169                                 if (path.toString().endsWith(".js")) {
 170                                     SeekableByteChannel sbc = null;
 171                                     if (isRootNodePath(path)) {
 172                                         InputStream is = getClass().getResourceAsStream(nodeFileToResource(path));
 173                                         if (is == null) {
 174                                             throw new IOException("Could not read " + path.toString());
 175                                         }
 176                                         sbc = new ReadOnlySeekableByteArrayChannel(is.readAllBytes());
 177                                     } else {
 178                                         sbc = super.newByteChannel(path, options, attrs);
 179                                     }
 180                                     return new PrefixedSeekableByteChannel(
 181                                             ("require=" + REQUIRE_WRAPPER_NAME + "(require);").getBytes(), sbc);
 182                                 } else {
 183                                     return super.newByteChannel(path, options, attrs);
 184                                 }
 185                             }
 186
 187                             @Override
 188                             public void checkAccess(Path path, Set<? extends AccessMode> modes,
 189                                     LinkOption... linkOptions) throws IOException {
 190                                 if (isRootNodePath(path)) {
 191                                     if (getClass().getResource(nodeFileToResource(path)) == null) {
 192                                         throw new NoSuchFileException(path.toString());
 193                                     }
 194                                 } else {
 195                                     super.checkAccess(path, modes, linkOptions);
 196                                 }
 197                             }
 198
 199                             @Override
 200                             public Map<String, Object> readAttributes(Path path, String attributes,
 201                                     LinkOption... options) throws IOException {
 202                                 if (isRootNodePath(path)) {
 203                                     return Collections.singletonMap("isRegularFile", true);
 204                                 }
 205                                 return super.readAttributes(path, attributes, options);
 206                             }
 207
 208                             @Override
 209                             public Path toRealPath(Path path, LinkOption... linkOptions) throws IOException {
 210                                 if (isRootNodePath(path)) {
 211                                     return path;
 212                                 }
 213                                 return super.toRealPath(path, linkOptions);
 214                             }
 215                         }));
 216     }
 217
 218     @Override
 219     protected void beforeInvocation() {
 220         super.beforeInvocation();
 221
 222         lock.lock();
 223
 224         if (initialized) {
 225             return;
 226         }
 227
 228         ScriptContext ctx = delegate.getContext();
 229         if (ctx == null) {
 230             throw new IllegalStateException("Failed to retrieve script context");
 231         }
 232
 233         // these are added post-construction, so we need to fetch them late
 234         this.engineIdentifier = (String) ctx.getAttribute(CONTEXT_KEY_ENGINE_IDENTIFIER);
 235         if (this.engineIdentifier == null) {
 236             throw new IllegalStateException("Failed to retrieve engine identifier from engine bindings");
 237         }
 238
 239         ScriptExtensionAccessor scriptExtensionAccessor = (ScriptExtensionAccessor) ctx
 240                 .getAttribute(CONTEXT_KEY_EXTENSION_ACCESSOR);
 241         if (scriptExtensionAccessor == null) {
 242             throw new IllegalStateException("Failed to retrieve script extension accessor from engine bindings");
 243         }
 244
 245         scriptDependencyListener = (Consumer<String>) ctx
 246                 .getAttribute("oh.dependency-listener"/* CONTEXT_KEY_DEPENDENCY_LISTENER */);
 247         if (scriptDependencyListener == null) {
 248             LOGGER.warn(
 249                     "Failed to retrieve script script dependency listener from engine bindings. Script dependency tracking will be disabled.");
 250         }
 251
 252         ScriptExtensionModuleProvider scriptExtensionModuleProvider = new ScriptExtensionModuleProvider(
 253                 scriptExtensionAccessor, lock);
 254
 255         // Wrap the "require" function to also allow loading modules from the ScriptExtensionModuleProvider
 256         Function<Function<Object[], Object>, Function<String, Object>> wrapRequireFn = originalRequireFn -> moduleName -> scriptExtensionModuleProvider
 257                 .locatorFor(delegate.getPolyglotContext(), engineIdentifier).locateModule(moduleName)
 258                 .map(m -> (Object) m).orElseGet(() -> originalRequireFn.apply(new Object[] { moduleName }));
 259         delegate.getBindings(ScriptContext.ENGINE_SCOPE).put(REQUIRE_WRAPPER_NAME, wrapRequireFn);
 260         delegate.put("require", wrapRequireFn.apply((Function<Object[], Object>) delegate.get("require")));
 261
 262         // Injections into the JS runtime
 263         jsRuntimeFeatures.getFeatures().forEach((key, obj) -> {
 264             LOGGER.debug("Injecting {} into the JS runtime...", key);
 265             delegate.put(key, obj);
 266         });
 267
 268         initialized = true;
 269
 270         try {
 271             LOGGER.debug("Evaluating cached global script...");
 272             delegate.getPolyglotContext().eval(GLOBAL_SOURCE);
 273             if (this.injectionEnabled) {
 274                 if (this.useIncludedLibrary) {
 275                     LOGGER.debug("Evaluating cached openhab-js injection...");
 276                     delegate.getPolyglotContext().eval(OPENHAB_JS_SOURCE);
 277                 } else {
 278                     LOGGER.debug("Evaluating openhab-js injection from the file system...");
 279                     eval(OPENHAB_JS_INJECTION_CODE);
 280                 }
 281             }
 282             LOGGER.debug("Successfully initialized GraalJS script engine.");
 283         } catch (ScriptException e) {
 284             LOGGER.error("Could not inject global script", e);
 285         }
 286     }
 287
 288     @Override
 289     protected Object afterInvocation(Object obj) {
 290         lock.unlock();
 291         return super.afterInvocation(obj);
 292     }
 293
 294     @Override
 295     protected Exception afterThrowsInvocation(Exception e) {
 296         lock.unlock();
 297         return super.afterThrowsInvocation(e);
 298     }
 299
 300     @Override
 301     public void close() {
 302         jsRuntimeFeatures.close();
 303     }
 304
 305     /**
 306      * Tests if this is a root node directory, `/node_modules`, `C:\node_modules`, etc...
 307      *
 308      * @param path a root path
 309      * @return whether the given path is a node root directory
 310      */
 311     private boolean isRootNodePath(Path path) {
 312         return path.startsWith(path.getRoot().resolve(NODE_DIR));
 313     }
 314
 315     /**
 316      * Converts a root node path to a class resource path for loading local modules
 317      * Ex: C:\node_modules\foo.js -> /node_modules/foo.js
 318      *
 319      * @param path a root path, e.g. C:\node_modules\foo.js
 320      * @return the class resource path for loading local modules
 321      */
 322     private String nodeFileToResource(Path path) {
 323         return "/" + path.subpath(0, path.getNameCount()).toString().replace('\\', '/');
 324     }
 325
 326     /**
 327      * @param fileName filename relative to the resources folder
 328      * @return file as {@link InputStreamReader}
 329      */
 330     private static Reader getFileAsReader(String fileName) throws IOException {
 331         InputStream ioStream = OpenhabGraalJSScriptEngine.class.getClassLoader().getResourceAsStream(fileName);
 332
 333         if (ioStream == null) {
 334             throw new IOException(fileName + " not found");
 335         }
 336
 337         return new InputStreamReader(ioStream);
 338     }
 339 }