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