Add a "ShortcutReader" interface (#2025)

- add a ShortcutReader interface for type safety reasons
- use ShortcutReader interface in GenericContainersManager

Author: madoar

phoenicis-containers/src/main/java/org/phoenicis/containers/GenericContainersManager.java

@@ -27,6 +27,7 @@
 import org.phoenicis.containers.dto.WinePrefixContainerDTO;
 import org.phoenicis.library.LibraryManager;
 import org.phoenicis.library.ShortcutManager;
+import org.phoenicis.library.ShortcutReader;
 import org.phoenicis.library.dto.ShortcutCategoryDTO;
 import org.phoenicis.library.dto.ShortcutDTO;
 import org.phoenicis.scripts.interpreter.ScriptInterpreter;
@@ -135,17 +136,22 @@ public void deleteContainer(ContainerDTO container, Consumer<ContainerDTO> onSuc
                     final InteractiveScriptSession interactiveScriptSession = this.scriptInterpreter
                             .createInteractiveSession();
 
-                    interactiveScriptSession.eval(
-                            "const ShortcutReader = include(\"engines." + engineId + ".shortcuts.reader\");",
-                            ignored -> interactiveScriptSession.eval("new ShortcutReader()", output -> {
-                                final org.graalvm.polyglot.Value shortcutReader = (org.graalvm.polyglot.Value) output;
-                                shortcutReader.invokeMember("of", shortcut);
-                                final String containerName = shortcutReader.invokeMember("getContainer")
-                                        .as(String.class);
+                    interactiveScriptSession.eval("include(\"engines." + engineId + ".shortcuts.reader\");",
+                            result -> {
+                                final org.graalvm.polyglot.Value shortcutReaderClass = (org.graalvm.polyglot.Value) result;
+
+                                final ShortcutReader shortcutReader = shortcutReaderClass.newInstance()
+                                        .as(ShortcutReader.class);
+
+                                shortcutReader.of(shortcut);
+
+                                final String containerName = shortcutReader.getContainer();
+
                                 if (containerName.equals(container.getName())) {
                                     this.shortcutManager.deleteShortcut(shortcut);
                                 }
-                            }, onError), onError);
+                            },
+                            onError);
                 });
 
         onSuccess.accept(container);

phoenicis-library/src/main/java/org/phoenicis/library/ShortcutManager.java

@@ -24,8 +24,8 @@
 import org.phoenicis.configuration.security.Safe;
 import org.phoenicis.library.dto.ShortcutDTO;
 import org.phoenicis.library.dto.ShortcutInfoDTO;
-import org.phoenicis.scripts.session.InteractiveScriptSession;
 import org.phoenicis.scripts.interpreter.ScriptInterpreter;
+import org.phoenicis.scripts.session.InteractiveScriptSession;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -120,12 +120,16 @@ public void createShortcut(ShortcutDTO shortcutDTO) {
     public void uninstallFromShortcut(ShortcutDTO shortcutDTO, Consumer<Exception> errorCallback) {
         final InteractiveScriptSession interactiveScriptSession = scriptInterpreter.createInteractiveSession();
 
-        interactiveScriptSession.eval("const ShortcutReader = include(\"engines.wine.shortcuts.reader\");",
-                ignored -> interactiveScriptSession.eval("new ShortcutReader()", output -> {
-                    final Value shortcutReader = (Value) output;
-                    shortcutReader.invokeMember("of", shortcutDTO);
-                    shortcutReader.invokeMember("uninstall");
-                }, errorCallback), errorCallback);
+        interactiveScriptSession.eval("include(\"engines.wine.shortcuts.reader\");",
+                result -> {
+                    Value shortcutReaderClass = (Value) result;
+
+                    ShortcutReader shortcutReader = shortcutReaderClass.newInstance().as(ShortcutReader.class);
+
+                    shortcutReader.of(shortcutDTO);
+                    shortcutReader.uninstall();
+                },
+                errorCallback);
     }
 
     public void deleteShortcut(ShortcutDTO shortcutDTO) {
@@ -216,6 +220,7 @@ public void updateShortcut(ShortcutDTO shortcutDTO) {
 
     /**
      * creates a file with a resource fallback
+     *
      * @param path file path
      * @param resource resource which shall be used if file path cannot be accessed
      * @return created file

phoenicis-library/src/main/java/org/phoenicis/library/ShortcutReader.java

@@ -0,0 +1,41 @@
+package org.phoenicis.library;
+
+import org.phoenicis.library.dto.ShortcutDTO;
+
+import java.util.List;
+
+/**
+ * Interface for all shortcut reader implementations
+ */
+public interface ShortcutReader {
+    /**
+     * Sets the shortcut
+     *
+     * @param shortcut The shortcut
+     */
+    void of(ShortcutDTO shortcut);
+
+    /**
+     * Returns the name of the container belonging to the shortcut
+     *
+     * @return The container name
+     */
+    String getContainer();
+
+    /**
+     * Runs a shortcut with the given user arguments
+     *
+     * @param arguments The user arguments
+     */
+    void run(List<String> arguments);
+
+    /**
+     * Stops the running shortcut
+     */
+    void stop();
+
+    /**
+     * Uninstalls the shortcut
+     */
+    void uninstall();
+}

phoenicis-library/src/main/java/org/phoenicis/library/ShortcutRunner.java

@@ -20,8 +20,8 @@
 
 import org.graalvm.polyglot.Value;
 import org.phoenicis.library.dto.ShortcutDTO;
-import org.phoenicis.scripts.session.InteractiveScriptSession;
 import org.phoenicis.scripts.interpreter.ScriptInterpreter;
+import org.phoenicis.scripts.session.InteractiveScriptSession;
 
 import java.util.List;
 import java.util.function.Consumer;
@@ -42,25 +42,31 @@ public void run(String shortcutName, List<String> arguments, Consumer<Exception>
     public void run(ShortcutDTO shortcutDTO, List<String> arguments, Consumer<Exception> errorCallback) {
         final InteractiveScriptSession interactiveScriptSession = scriptInterpreter.createInteractiveSession();
 
-        interactiveScriptSession.eval("const ShortcutReader = include(\"engines.wine.shortcuts.reader\");",
-                ignored -> interactiveScriptSession.eval("new ShortcutReader()", output -> {
-                    final Value shortcutReader = (Value) output;
+        interactiveScriptSession.eval("include(\"engines.wine.shortcuts.reader\");",
+                result -> {
+                    Value shortcutReaderClass = (Value) result;
 
-                    shortcutReader.invokeMember("of", shortcutDTO);
-                    shortcutReader.invokeMember("run", arguments);
-                }, errorCallback), errorCallback);
+                    ShortcutReader shortcutReader = shortcutReaderClass.newInstance().as(ShortcutReader.class);
+
+                    shortcutReader.of(shortcutDTO);
+                    shortcutReader.run(arguments);
+                },
+                errorCallback);
     }
 
     public void stop(ShortcutDTO shortcutDTO, Consumer<Exception> errorCallback) {
         final InteractiveScriptSession interactiveScriptSession = scriptInterpreter.createInteractiveSession();
 
-        interactiveScriptSession.eval("const ShortcutReader = include(\"engines.wine.shortcuts.reader\");",
-                ignored -> interactiveScriptSession.eval("new ShortcutReader()", output -> {
-                    final Value shortcutReader = (Value) output;
+        interactiveScriptSession.eval("include(\"engines.wine.shortcuts.reader\");",
+                result -> {
+                    Value shortcutReaderClass = (Value) result;
+
+                    ShortcutReader shortcutReader = shortcutReaderClass.newInstance().as(ShortcutReader.class);
 
-                    shortcutReader.invokeMember("of", shortcutDTO);
-                    shortcutReader.invokeMember("stop");
-                }, errorCallback), errorCallback);
+                    shortcutReader.of(shortcutDTO);
+                    shortcutReader.stop();
+                },
+                errorCallback);
     }
 
 }