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

   1 /**
   2  * Copyright (c) 2010-2021 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.nio.channels.SeekableByteChannel;
  20 import java.nio.file.AccessMode;
  21 import java.nio.file.FileSystems;
  22 import java.nio.file.LinkOption;
  23 import java.nio.file.NoSuchFileException;
  24 import java.nio.file.OpenOption;
  25 import java.nio.file.Path;
  26 import java.nio.file.Paths;
  27 import java.nio.file.attribute.FileAttribute;
  28 import java.time.Duration;
  29 import java.time.ZonedDateTime;
  30 import java.util.Collections;
  31 import java.util.Map;
  32 import java.util.Set;
  33 import java.util.function.Consumer;
  34 import java.util.function.Function;
  35
  36 import javax.script.ScriptContext;
  37 import javax.script.ScriptException;
  38
  39 import org.eclipse.jdt.annotation.NonNullByDefault;
  40 import org.eclipse.jdt.annotation.Nullable;
  41 import org.graalvm.polyglot.Context;
  42 import org.graalvm.polyglot.Engine;
  43 import org.graalvm.polyglot.HostAccess;
  44 import org.graalvm.polyglot.Value;
  45 import org.openhab.automation.jsscripting.internal.fs.DelegatingFileSystem;
  46 import org.openhab.automation.jsscripting.internal.fs.PrefixedSeekableByteChannel;
  47 import org.openhab.automation.jsscripting.internal.fs.ReadOnlySeekableByteArrayChannel;
  48 import org.openhab.automation.jsscripting.internal.fs.watch.JSDependencyTracker;
  49 import org.openhab.automation.jsscripting.internal.scriptengine.InvocationInterceptingScriptEngineWithInvocable;
  50 import org.openhab.core.automation.module.script.ScriptExtensionAccessor;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 import com.oracle.truffle.js.scriptengine.GraalJSScriptEngine;
  55
  56 /**
  57  * GraalJS Script Engine implementation
  58  *
  59  * @author Jonathan Gilbert - Initial contribution
  60  * @author Dan Cunningham - Script injections
  61  */
  62 public class OpenhabGraalJSScriptEngine extends InvocationInterceptingScriptEngineWithInvocable<GraalJSScriptEngine> {
  63
  64     private static final Logger LOGGER = LoggerFactory.getLogger(OpenhabGraalJSScriptEngine.class);
  65     private static final String GLOBAL_REQUIRE = "require(\"@jsscripting-globals\");";
  66     private static final String REQUIRE_WRAPPER_NAME = "__wraprequire__";
  67     // final CommonJS search path for our library
  68     private static final Path NODE_DIR = Paths.get("node_modules");
  69
  70     // these fields start as null because they are populated on first use
  71     private @NonNullByDefault({}) String engineIdentifier;
  72     private @NonNullByDefault({}) Consumer<String> scriptDependencyListener;
  73
  74     private boolean initialized = false;
  75     private String globalScript;
  76
  77     /**
  78      * Creates an implementation of ScriptEngine (& Invocable), wrapping the contained engine, that tracks the script
  79      * lifecycle and provides hooks for scripts to do so too.
  80      */
  81     public OpenhabGraalJSScriptEngine(@Nullable String injectionCode) {
  82         super(null); // delegate depends on fields not yet initialised, so we cannot set it immediately
  83         this.globalScript = GLOBAL_REQUIRE + (injectionCode != null ? injectionCode : "");
  84
  85         // Custom translate JS Objects - > Java Objects
  86         HostAccess hostAccess = HostAccess.newBuilder(HostAccess.ALL)
  87                 // Translate JS-Joda ZonedDateTime to java.time.ZonedDateTime
  88                 .targetTypeMapping(Value.class, ZonedDateTime.class, (v) -> v.hasMember("withFixedOffsetZone"), v -> {
  89                     return ZonedDateTime
  90                             .parse(v.invokeMember("withFixedOffsetZone").invokeMember("toString").asString());
  91                 }, HostAccess.TargetMappingPrecedence.LOW)
  92
  93                 // Translate JS-Joda Duration to java.time.Duration
  94                 .targetTypeMapping(Value.class, Duration.class,
  95                         // picking two members to check as Duration has many common function names
  96                         (v) -> v.hasMember("minusDuration") && v.hasMember("toNanos"), v -> {
  97                             return Duration.ofNanos(v.invokeMember("toNanos").asLong());
  98                         }, HostAccess.TargetMappingPrecedence.LOW)
  99                 .build();
 100
 101         delegate = GraalJSScriptEngine.create(
 102                 Engine.newBuilder().allowExperimentalOptions(true).option("engine.WarnInterpreterOnly", "false")
 103                         .build(),
 104                 Context.newBuilder("js").allowExperimentalOptions(true).allowAllAccess(true).allowHostAccess(hostAccess)
 105                         .option("js.commonjs-require-cwd", JSDependencyTracker.LIB_PATH)
 106                         .option("js.nashorn-compat", "true") // to ease migration
 107                         .option("js.ecmascript-version", "2021") // nashorn compat will enforce es5 compatibility, we
 108                                                                  // want ecma2021
 109                         .option("js.commonjs-require", "true") // enable CommonJS module support
 110                         .hostClassLoader(getClass().getClassLoader())
 111                         .fileSystem(new DelegatingFileSystem(FileSystems.getDefault().provider()) {
 112                             @Override
 113                             public SeekableByteChannel newByteChannel(Path path, Set<? extends OpenOption> options,
 114                                     FileAttribute<?>... attrs) throws IOException {
 115                                 if (scriptDependencyListener != null) {
 116                                     scriptDependencyListener.accept(path.toString());
 117                                 }
 118
 119                                 if (path.toString().endsWith(".js")) {
 120                                     SeekableByteChannel sbc = null;
 121                                     if (isRootNodePath(path)) {
 122                                         InputStream is = getClass().getResourceAsStream(nodeFileToResource(path));
 123                                         if (is == null) {
 124                                             throw new IOException("Could not read " + path.toString());
 125                                         }
 126                                         sbc = new ReadOnlySeekableByteArrayChannel(is.readAllBytes());
 127                                     } else {
 128                                         sbc = super.newByteChannel(path, options, attrs);
 129                                     }
 130                                     return new PrefixedSeekableByteChannel(
 131                                             ("require=" + REQUIRE_WRAPPER_NAME + "(require);").getBytes(), sbc);
 132                                 } else {
 133                                     return super.newByteChannel(path, options, attrs);
 134                                 }
 135                             }
 136
 137                             @Override
 138                             public void checkAccess(Path path, Set<? extends AccessMode> modes,
 139                                     LinkOption... linkOptions) throws IOException {
 140                                 if (isRootNodePath(path)) {
 141                                     if (getClass().getResource(nodeFileToResource(path)) == null) {
 142                                         throw new NoSuchFileException(path.toString());
 143                                     }
 144                                 } else {
 145                                     super.checkAccess(path, modes, linkOptions);
 146                                 }
 147                             }
 148
 149                             @Override
 150                             public Map<String, Object> readAttributes(Path path, String attributes,
 151                                     LinkOption... options) throws IOException {
 152                                 if (isRootNodePath(path)) {
 153                                     return Collections.singletonMap("isRegularFile", true);
 154                                 }
 155                                 return super.readAttributes(path, attributes, options);
 156                             }
 157
 158                             @Override
 159                             public Path toRealPath(Path path, LinkOption... linkOptions) throws IOException {
 160                                 if (isRootNodePath(path)) {
 161                                     return path;
 162                                 }
 163                                 return super.toRealPath(path, linkOptions);
 164                             }
 165                         }));
 166     }
 167
 168     @Override
 169     protected void beforeInvocation() {
 170         if (initialized) {
 171             return;
 172         }
 173
 174         ScriptContext ctx = delegate.getContext();
 175
 176         // these are added post-construction, so we need to fetch them late
 177         this.engineIdentifier = (String) ctx.getAttribute(CONTEXT_KEY_ENGINE_IDENTIFIER);
 178         if (this.engineIdentifier == null) {
 179             throw new IllegalStateException("Failed to retrieve engine identifier from engine bindings");
 180         }
 181
 182         ScriptExtensionAccessor scriptExtensionAccessor = (ScriptExtensionAccessor) ctx
 183                 .getAttribute(CONTEXT_KEY_EXTENSION_ACCESSOR);
 184         if (scriptExtensionAccessor == null) {
 185             throw new IllegalStateException("Failed to retrieve script extension accessor from engine bindings");
 186         }
 187
 188         scriptDependencyListener = (Consumer<String>) ctx
 189                 .getAttribute("oh.dependency-listener"/* CONTEXT_KEY_DEPENDENCY_LISTENER */);
 190         if (scriptDependencyListener == null) {
 191             LOGGER.warn(
 192                     "Failed to retrieve script script dependency listener from engine bindings. Script dependency tracking will be disabled.");
 193         }
 194
 195         ScriptExtensionModuleProvider scriptExtensionModuleProvider = new ScriptExtensionModuleProvider(
 196                 scriptExtensionAccessor);
 197
 198         Function<Function<Object[], Object>, Function<String, Object>> wrapRequireFn = originalRequireFn -> moduleName -> scriptExtensionModuleProvider
 199                 .locatorFor(delegate.getPolyglotContext(), engineIdentifier).locateModule(moduleName)
 200                 .map(m -> (Object) m).orElseGet(() -> originalRequireFn.apply(new Object[] { moduleName }));
 201
 202         delegate.getBindings(ScriptContext.ENGINE_SCOPE).put(REQUIRE_WRAPPER_NAME, wrapRequireFn);
 203         delegate.put("require", wrapRequireFn.apply((Function<Object[], Object>) delegate.get("require")));
 204
 205         initialized = true;
 206
 207         try {
 208             eval(globalScript);
 209         } catch (ScriptException e) {
 210             LOGGER.error("Could not inject global script", e);
 211         }
 212     }
 213
 214     /**
 215      * Tests if this is a root node directory, `/node_modules`, `C:\node_modules`, etc...
 216      *
 217      * @param path
 218      * @return
 219      */
 220     private boolean isRootNodePath(Path path) {
 221         return path.startsWith(path.getRoot().resolve(NODE_DIR));
 222     }
 223
 224     /**
 225      * Converts a root node path to a class resource path for loading local modules
 226      * Ex: C:\node_modules\foo.js -> /node_modules/foo.js
 227      *
 228      * @param path
 229      * @return
 230      */
 231     private String nodeFileToResource(Path path) {
 232         return "/" + path.subpath(0, path.getNameCount()).toString().replace('\\', '/');
 233     }
 234 }