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

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