Merge pull request #11 from CSC207-2022F-UofT/feat-plugin-loader

Author: hykilpikonna

build.gradle

@@ -3,6 +3,7 @@ import org.apache.tools.ant.filters.ReplaceTokens
 plugins {
     id 'java'
     id 'maven-publish'
+    id "com.github.johnrengelman.shadow" version "7.1.2"
 }
 
 group 'org.hydev.csc207'
@@ -32,6 +33,9 @@ dependencies {
     // The Spigot API with no shadowing. Requires the OSS repo.
     compileOnly 'org.spigotmc:spigot-api:1.19-R0.1-SNAPSHOT'
 
+    // https://mvnrepository.com/artifact/net.sourceforge.argparse4j/argparse4j
+    implementation 'net.sourceforge.argparse4j:argparse4j:0.9.0'
+
     // Apache HTTP Client
     // https://mvnrepository.com/artifact/org.apache.httpcomponents.client5/httpclient5-fluent
     implementation 'org.apache.httpcomponents.client5:httpclient5-fluent:5.2-beta1'
@@ -46,6 +50,9 @@ dependencies {
     // https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind
     implementation 'com.fasterxml.jackson.core:jackson-databind:2.14.0-rc1'
 
+    // https://mvnrepository.com/artifact/com.google.guava/guava
+    implementation 'com.google.guava:guava:31.1-jre'
+
     // YAML parser
     // https://mvnrepository.com/artifact/org.yaml/snakeyaml
     implementation group: 'org.yaml', name: 'snakeyaml', version: '1.33'

src/main/java/org/hydev/mcpm/ArgsParser.java

@@ -0,0 +1,22 @@
+package org.hydev.mcpm;
+
+import net.sourceforge.argparse4j.ArgumentParsers;
+import net.sourceforge.argparse4j.inf.ArgumentParser;
+import net.sourceforge.argparse4j.inf.ArgumentParserException;
+
+/**
+ * Static collection of argument parsers for the command line
+ *
+ * @author Azalea (https://github.com/hykilpikonna)
+ * @since 2022-10-30
+ */
+public class ArgsParser
+{
+    public static final ArgumentParser LOADER;
+
+    static
+    {
+        LOADER = ArgumentParsers.newFor("loader").build().defaultHelp(true);
+        LOADER.addArgument("name");
+    }
+}

src/main/java/org/hydev/mcpm/Controller.java

@@ -0,0 +1,80 @@
+package org.hydev.mcpm;
+
+import net.sourceforge.argparse4j.inf.ArgumentParserException;
+import org.hydev.mcpm.client.injector.*;
+
+import java.util.function.Consumer;
+
+import static java.lang.String.format;
+import static org.hydev.mcpm.utils.Sugar.sub;
+import static org.hydev.mcpm.utils.Sugar.subFrom;
+
+
+/**
+ * Controller of the program
+ *
+ * @author Azalea (https://github.com/hykilpikonna)
+ * @since 2022-10-30
+ */
+public class Controller
+{
+    private final LoadBoundary loader;
+    private final UnloadBoundary unloader;
+    private final ReloadBoundary reloader;
+
+    public Controller()
+    {
+        var pl = new PluginLoader();
+        loader = pl;
+        unloader = pl;
+        reloader = pl;
+    }
+
+    /**
+     * Run a command
+     *
+     * @param args Command-line arguments (not including the command name/path)
+     * @param log Callback logger
+     */
+    public void runCommand(String[] args, Consumer<String> log)
+    {
+        if (args.length == 0) return;
+
+        var cmd = args[0].toLowerCase();
+        switch (cmd)
+        {
+            case "load", "unload", "reload" ->
+            {
+                try
+                {
+                    var a = ArgsParser.LOADER.parseArgs(subFrom(args, 1));
+                    var name = a.getString("name");
+
+                    try
+                    {
+                        switch (cmd)
+                        {
+                            case "load" -> loader.loadPlugin(name);
+                            case "unload" -> unloader.unloadPlugin(name);
+                            case "reload" -> reloader.reloadPlugin(name);
+                        }
+                        log.accept(format("Plugin %s %sed", name, cmd));
+                    }
+                    catch (PluginNotFoundException e)
+                    {
+                        log.accept(format("Plugin %s not found", name));
+                    }
+                }
+                catch (ArgumentParserException e)
+                {
+                    log.accept("Error: " + e.getMessage());
+                    log.accept(ArgsParser.LOADER.formatHelp());
+                }
+            }
+            default ->
+            {
+                log.accept("Usage: /mcpm <install/uninstall/update/search/load/unload/reload/help>");
+            }
+        }
+    }
+}

src/main/java/org/hydev/mcpm/SpigotEntry.java

@@ -6,6 +6,7 @@
 import org.bukkit.plugin.java.JavaPlugin;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Arrays;
 import java.util.Objects;
 import java.util.logging.Logger;
 
@@ -17,6 +18,7 @@
 public class SpigotEntry extends JavaPlugin implements CommandExecutor
 {
     private Logger log;
+    private Controller controller;
 
     /**
      * onEnable() is called when our plugin is loaded on a Spigot server.
@@ -26,7 +28,10 @@ public void onEnable()
     {
         // Initialize logger
         log = getLogger();
-        log.info("[MCPM] Enabled!");
+        log.info("Enabled!");
+
+        // Initialize controller
+        controller = new Controller();
 
         // Register mcpm command
         requireNonNull(this.getCommand("mcpm")).setExecutor(this);
@@ -38,13 +43,13 @@ public void onEnable()
     @Override
     public void onDisable()
     {
-        log.info("[MCPM] Disabled!");
+        log.info("Disabled!");
     }
 
     @Override
     public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] args)
     {
-        sender.sendMessage("This command is not yet implemented, meow~");
-        return false;
+        controller.runCommand(args, sender::sendMessage);
+        return true;
     }
 }

src/main/java/org/hydev/mcpm/client/database/DatabaseLoader.java

@@ -1,9 +1,7 @@
 package org.hydev.mcpm.client.database;
 
-import org.hydev.mcpm.client.models.Plugin;
+import org.hydev.mcpm.client.models.PluginModel;
 
-import javax.xml.crypto.Data;
-import java.io.File;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -17,13 +15,13 @@
 public class DatabaseLoader
 {
     /** Name index: map[lower-cased name] = Plugin of that name */
-    private final Map<String, Plugin> nameIndex;
+    private final Map<String, PluginModel> nameIndex;
 
     /** Keyword index: map[lower keyword] = List[plugins that contain the keyword either in name or description] */
-    private final Map<String, List<Plugin>> keywordIndex;
+    private final Map<String, List<PluginModel>> keywordIndex;
 
     /** Command index: map[lower command name/alias] = List[plugins that provide the command or alias] */
-    private final Map<String, List<Plugin>> commandIndex;
+    private final Map<String, List<PluginModel>> commandIndex;
 
     /**
      * Load database, create index for faster searching through the database
@@ -46,7 +44,7 @@ public DatabaseLoader(String path)
      * @param name Name of the plugin
      * @return Plugin of that name, or null if not found
      */
-    public Plugin findByName(String name)
+    public PluginModel findByName(String name)
     {
         // TODO: Implement this
         throw new UnsupportedOperationException("TODO");
@@ -65,7 +63,7 @@ public Plugin findByName(String name)
      * @param keyword Keyword
      * @return List of packages matching the keyword, or empty list
      */
-    public List<Plugin> searchByKeyword(String keyword)
+    public List<PluginModel> searchByKeyword(String keyword)
     {
         // TODO: Implement this
         throw new UnsupportedOperationException("TODO");
@@ -77,7 +75,7 @@ public List<Plugin> searchByKeyword(String keyword)
      * @param command Command name
      * @return Plugins that provides the command, or empty list
      */
-    public List<Plugin> searchByCommand(String command)
+    public List<PluginModel> searchByCommand(String command)
     {
         // TODO: Implement this
         throw new UnsupportedOperationException("TODO");

src/main/java/org/hydev/mcpm/client/database/LocalPluginTracker.java

@@ -1,6 +1,5 @@
 package org.hydev.mcpm.client.database;
 
-import org.hydev.mcpm.client.models.Plugin;
 import org.hydev.mcpm.client.models.PluginVersion;
 
 import java.io.File;

src/main/java/org/hydev/mcpm/client/injector/LoadBoundary.java

@@ -0,0 +1,29 @@
+package org.hydev.mcpm.client.injector;
+
+import java.io.File;
+
+/**
+ * Interface for loading a locally installed plugin.
+ *
+ * @author Azalea (https://github.com/hykilpikonna)
+ * @since 2022-10-29
+ */
+public interface LoadBoundary
+{
+    /**
+     * Dynamically load a local plugin through JVM reflections and classloader hacks
+     *
+     * @param name Loaded plugin name
+     * @return True if success, false if failed
+     * @throws PluginNotFoundException Plugin of the name is not found in the plugins directory
+     */
+    public boolean loadPlugin(String name) throws PluginNotFoundException;
+
+    /**
+     * Dynamically load a local plugin through JVM reflections and classloader hacks
+     *
+     * @param jar Local jar file path
+     * @return True if success, false if failed
+     */
+    public boolean loadPlugin(File jar);
+}