Merge branch 'feat-spigot-framework'

Author: hykilpikonna

.gitignore

@@ -30,3 +30,4 @@ build
 .gradle
 data
 .mcpm
+*.pyc

README.md

@@ -31,6 +31,18 @@ For example, you can test the progress bar with:
 
 If you don't have JDK 19 installed or if you don't know where it's installed, you can use our JDK downloader tool to download a local version of JDK 19 without installing on the system. (TODO: Add tutorial after merging PR #8)
 
+## Development
+
+Setup and start a testing minecraft server: 
+
+1. `pip install -r requirements.txt`
+2. `python3 -m tools.start_server`
+
+Rebuild & update our MCPM plugin while the server is running:
+
+1. `python3 -m tools.update_build`
+2. `plugman reload mcpm` (Inside the server's command prompt)
+
 ## Brainstorm
 
 Server file/endpoint structure:

build.gradle

@@ -1,14 +1,26 @@
+import org.apache.tools.ant.filters.ReplaceTokens
+
 plugins {
     id 'java'
     id 'maven-publish'
     id 'checkstyle'
+    id "com.github.johnrengelman.shadow" version "7.1.2"
 }
 
 group 'org.hydev.csc207'
 version '0.1.0.51'
 
 repositories {
     mavenCentral()
+
+    // Spigot MC
+    maven {
+        url = 'https://hub.spigotmc.org/nexus/content/repositories/snapshots/'
+        content {
+            includeGroup 'org.bukkit'
+            includeGroup 'org.spigotmc'
+        }
+    }
 }
 
 java {
@@ -28,6 +40,12 @@ checkstyle {
 
 
 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'
@@ -42,6 +60,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'
@@ -57,6 +78,13 @@ dependencies {
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
 }
 
+processResources {
+    from(sourceSets.main.resources.srcDirs) {
+        filter ReplaceTokens, tokens: [version: version]
+    }
+    duplicatesStrategy = 'include'
+}
+
 publishing {
     repositories {
         maven {

requirements.txt

@@ -0,0 +1,4 @@
+requests
+hypy_utils>=1.0.16
+py-cpuinfo
+tqdm

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

@@ -0,0 +1,55 @@
+package org.hydev.mcpm;
+
+import org.bukkit.command.Command;
+import org.bukkit.command.CommandExecutor;
+import org.bukkit.command.CommandSender;
+import org.bukkit.plugin.java.JavaPlugin;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Arrays;
+import java.util.Objects;
+import java.util.logging.Logger;
+
+import static java.util.Objects.requireNonNull;
+
+/**
+ * Entrypoint for the Spigot plugin adapter of our program
+ */
+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.
+     */
+    @Override
+    public void onEnable()
+    {
+        // Initialize logger
+        log = getLogger();
+        log.info("Enabled!");
+
+        // Initialize controller
+        controller = new Controller();
+
+        // Register mcpm command
+        requireNonNull(this.getCommand("mcpm")).setExecutor(this);
+    }
+
+    /**
+     * onDisable() is called when our plugin is unloaded on a Spigot server.
+     */
+    @Override
+    public void onDisable()
+    {
+        log.info("Disabled!");
+    }
+
+    @Override
+    public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] args)
+    {
+        controller.runCommand(args, sender::sendMessage);
+        return true;
+    }
+}

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

@@ -1,6 +1,6 @@
 package org.hydev.mcpm.client.database;
 
-import org.hydev.mcpm.client.models.Plugin;
+import org.hydev.mcpm.client.models.PluginModel;
 
 import java.util.HashMap;
 import java.util.List;
@@ -15,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
@@ -44,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");
@@ -63,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");
@@ -75,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/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);
+}