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
  18 import javax.script.ScriptEngine;
  19
  20 import org.eclipse.jdt.annotation.NonNullByDefault;
  21 import org.eclipse.jdt.annotation.Nullable;
  22 import org.openhab.automation.jsscripting.internal.fs.watch.JSDependencyTracker;
  23 import org.openhab.core.automation.module.script.ScriptDependencyTracker;
  24 import org.openhab.core.automation.module.script.ScriptEngineFactory;
  25 import org.openhab.core.config.core.ConfigurableService;
  26 import org.osgi.framework.Constants;
  27 import org.osgi.service.component.annotations.Activate;
  28 import org.osgi.service.component.annotations.Component;
  29 import org.osgi.service.component.annotations.Modified;
  30 import org.osgi.service.component.annotations.Reference;
  31
  32 /**
  33  * An implementation of {@link ScriptEngineFactory} with customizations for GraalJS ScriptEngines.
  34  *
  35  * @author Jonathan Gilbert - Initial contribution
  36  * @author Dan Cunningham - Script injections
  37  */
  38 @Component(service = ScriptEngineFactory.class, configurationPid = "org.openhab.jsscripting", property = Constants.SERVICE_PID
  39         + "=org.openhab.jsscripting")
  40 @ConfigurableService(category = "automation", label = "JS Scripting", description_uri = "automation:jsscripting")
  41 @NonNullByDefault
  42 public final class GraalJSScriptEngineFactory implements ScriptEngineFactory {
  43     private static final String CFG_INJECTION_ENABLED = "injectionEnabled";
  44     private static final String INJECTION_CODE = "Object.assign(this, require('openhab'));";
  45     private boolean injectionEnabled = true;
  46
  47     public static final String MIME_TYPE = "application/javascript;version=ECMAScript-2021";
  48     private static final String ALT_MIME_TYPE = "text/javascript;version=ECMAScript-2021";
  49     private static final String ALIAS = "graaljs";
  50
  51     private final JSScriptServiceUtil jsScriptServiceUtil;
  52     private final JSDependencyTracker jsDependencyTracker;
  53
  54     @Activate
  55     public GraalJSScriptEngineFactory(final @Reference JSScriptServiceUtil jsScriptServiceUtil,
  56             final @Reference JSDependencyTracker jsDependencyTracker, Map<String, Object> config) {
  57         this.jsDependencyTracker = jsDependencyTracker;
  58         this.jsScriptServiceUtil = jsScriptServiceUtil;
  59         modified(config);
  60     }
  61
  62     @Override
  63     public List<String> getScriptTypes() {
  64
  65         /*
  66          * Whilst we run in parallel with Nashorn, we use a custom mime-type to avoid
  67          * disrupting Nashorn scripts. When Nashorn is removed, we take over the standard
  68          * JS runtime.
  69          */
  70
  71         // GraalJSEngineFactory graalJSEngineFactory = new GraalJSEngineFactory();
  72         //
  73         // scriptTypes.addAll(graalJSEngineFactory.getMimeTypes());
  74         // scriptTypes.addAll(graalJSEngineFactory.getExtensions());
  75
  76         return List.of(MIME_TYPE, ALT_MIME_TYPE, ALIAS);
  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         return new DebuggingGraalScriptEngine<>(
  87                 new OpenhabGraalJSScriptEngine(injectionEnabled ? INJECTION_CODE : null, jsScriptServiceUtil));
  88     }
  89
  90     @Override
  91     public @Nullable ScriptDependencyTracker getDependencyTracker() {
  92         return jsDependencyTracker;
  93     }
  94
  95     @Modified
  96     protected void modified(Map<String, ?> config) {
  97         Object injectionEnabled = config.get(CFG_INJECTION_ENABLED);
  98         this.injectionEnabled = injectionEnabled == null || (Boolean) injectionEnabled;
  99     }
 100 }