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 java.util.List;
  16 import java.util.Map;
  17 import java.util.stream.Stream;
  18
  19 import javax.script.ScriptEngine;
  20
  21 import org.eclipse.jdt.annotation.NonNullByDefault;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.openhab.automation.jsscripting.internal.fs.watch.JSDependencyTracker;
  24 import org.openhab.core.automation.module.script.ScriptDependencyTracker;
  25 import org.openhab.core.automation.module.script.ScriptEngineFactory;
  26 import org.openhab.core.config.core.ConfigurableService;
  27 import org.osgi.framework.Constants;
  28 import org.osgi.service.component.annotations.Activate;
  29 import org.osgi.service.component.annotations.Component;
  30 import org.osgi.service.component.annotations.Modified;
  31 import org.osgi.service.component.annotations.Reference;
  32
  33 import com.oracle.truffle.js.scriptengine.GraalJSEngineFactory;
  34
  35 /**
  36  * An implementation of {@link ScriptEngineFactory} with customizations for GraalJS ScriptEngines.
  37  *
  38  * @author Jonathan Gilbert - Initial contribution
  39  * @author Dan Cunningham - Script injections
  40  */
  41 @Component(service = ScriptEngineFactory.class, configurationPid = "org.openhab.jsscripting", property = Constants.SERVICE_PID
  42         + "=org.openhab.jsscripting")
  43 @ConfigurableService(category = "automation", label = "JS Scripting", description_uri = "automation:jsscripting")
  44 @NonNullByDefault
  45 public final class GraalJSScriptEngineFactory implements ScriptEngineFactory {
  46     private static final String CFG_INJECTION_ENABLED = "injectionEnabled";
  47     private static final String CFG_USE_INCLUDED_LIBRARY = "useIncludedLibrary";
  48
  49     private static final GraalJSEngineFactory factory = new GraalJSEngineFactory();
  50
  51     private static final List<String> scriptTypes = createScriptTypes();
  52
  53     private static List<String> createScriptTypes() {
  54         // Add those for backward compatibility (existing scripts may rely on those MIME types)
  55         List<String> backwardCompat = List.of("application/javascript;version=ECMAScript-2021", "graaljs");
  56         return Stream.of(factory.getMimeTypes(), factory.getExtensions(), backwardCompat).flatMap(List::stream)
  57                 .toList();
  58     }
  59
  60     private boolean injectionEnabled = true;
  61     private boolean useIncludedLibrary = true;
  62
  63     private final JSScriptServiceUtil jsScriptServiceUtil;
  64     private final JSDependencyTracker jsDependencyTracker;
  65
  66     @Activate
  67     public GraalJSScriptEngineFactory(final @Reference JSScriptServiceUtil jsScriptServiceUtil,
  68             final @Reference JSDependencyTracker jsDependencyTracker, Map<String, Object> config) {
  69         this.jsDependencyTracker = jsDependencyTracker;
  70         this.jsScriptServiceUtil = jsScriptServiceUtil;
  71         modified(config);
  72     }
  73
  74     @Override
  75     public List<String> getScriptTypes() {
  76         return scriptTypes;
  77     }
  78
  79     @Override
  80     public void scopeValues(ScriptEngine scriptEngine, Map<String, Object> scopeValues) {
  81         // noop; they are retrieved via modules, not injected
  82     }
  83
  84     @Override
  85     public @Nullable ScriptEngine createScriptEngine(String scriptType) {
  86         if (!scriptTypes.contains(scriptType)) {
  87             return null;
  88         }
  89         return new DebuggingGraalScriptEngine<>(new OpenhabGraalJSScriptEngine(injectionEnabled, useIncludedLibrary,
  90                 jsScriptServiceUtil, jsDependencyTracker));
  91     }
  92
  93     @Override
  94     public @Nullable ScriptDependencyTracker getDependencyTracker() {
  95         return jsDependencyTracker;
  96     }
  97
  98     @Modified
  99     protected void modified(Map<String, ?> config) {
 100         Object injectionEnabled = config.get(CFG_INJECTION_ENABLED);
 101         this.injectionEnabled = injectionEnabled == null || (boolean) injectionEnabled;
 102         Object useIncludedLibrary = config.get(CFG_USE_INCLUDED_LIBRARY);
 103         this.useIncludedLibrary = useIncludedLibrary == null || (boolean) useIncludedLibrary;
 104     }
 105 }