Merge branch 'main' into patch-mirror

Author: hykilpikonna

README.md

@@ -94,8 +94,8 @@ There's 3 different ways you can search for new plugins:
 You can execute these commands in any environment using the `search` subcommand:
 ```shell
 mcpm search JedCore # Search for a plugin with the name "JedCore"
-mcpm search --by-keyword "protect land" # Search for a plugin that has protect in its description.
-mcpm search --by-command claim # Search for a plugin that provides a /claim command.
+mcpm search --keyword "protect land" # Search for a plugin that has protect in its description.
+mcpm search --command claim # Search for a plugin that provides a /claim command.
 ```
 
 # Install Plugins
@@ -112,8 +112,6 @@ For example, you can install a plugin that provides a `claim` command using the
 
 ```shell
 mcpm install JedCore # Installs the latest version of the JedCore plugin.
-mcpm install --by-keyword "protect land" # This is also provided for consistency with search.
-mcpm install --by-command claim # This will install the latest version of a command that provides claim!
 ```
 
 We recommend you use the search command before installing anything,

build.gradle

@@ -51,6 +51,7 @@ task checkStyle(type: GradleBuild) {
 dependencies {
     // The Spigot API with no shadowing. Requires the OSS repo.
     compileOnly 'org.spigotmc:spigot-api:1.19-R0.1-SNAPSHOT'
+    testImplementation 'org.spigotmc:spigot-api:1.19-R0.1-SNAPSHOT'
 
     // Argument parser
     // https://mvnrepository.com/artifact/net.sourceforge.argparse4j/argparse4j
@@ -90,6 +91,10 @@ dependencies {
     // https://mvnrepository.com/artifact/com.github.luben/zstd-jni
     implementation 'com.github.luben:zstd-jni:1.5.2-5'
 
+    // ZSTD but pure java for platforms that doesn't support native
+    // https://mvnrepository.com/artifact/io.airlift/aircompressor
+    implementation 'io.airlift:aircompressor:0.21'
+
     // Unit tests
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.9.0'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.9.0'

crawl.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+set -e
+
+# Get script dir
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+pushd "$SCRIPT_DIR"
+
+PY="/home/azalea/.conda/envs/310/bin/python3"
+
+# Crawl packages
+$PY -m tools.run org.hydev.mcpm.server.crawlers.SpigetCrawler
+
+# Create database
+$PY -m tools.run org.hydev.mcpm.server.crawlers.spiget.CreateDatabase
+
+# Zstd compression
+rm -rf .mcpm/db.zst
+zstd -f -19 -T36 .mcpm/db
+
+popd

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

@@ -16,6 +16,11 @@
  */
 public class Constants
 {
+    // This is technically not a constant, but it should only be changed by SpigotEntry to true.
+    // It cannot be put inside SpigotEntry because accessing SpigotEntry would try to initialize the class, then it
+    // will try to import Spigot packages which doesn't exist outside of Spigot.
+    public static boolean IS_MINECRAFT = false;
+
     public static final ObjectMapper JACKSON = new ObjectMapper()
         .disable(FAIL_ON_UNKNOWN_PROPERTIES).enable(INDENT_OUTPUT);
 

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

@@ -4,17 +4,14 @@
 import org.bukkit.command.Command;
 import org.bukkit.command.CommandExecutor;
 import org.bukkit.command.CommandSender;
-import org.bukkit.command.TabCompleter;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.hydev.mcpm.client.arguments.ArgsParser;
 import org.hydev.mcpm.client.arguments.CommandsFactory;
 import org.hydev.mcpm.client.arguments.parsers.CommandParser;
 import org.hydev.mcpm.utils.ColorLogger;
 import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 import java.util.logging.Logger;
 
@@ -25,6 +22,12 @@
  */
 public class SpigotEntry extends JavaPlugin implements CommandExecutor
 {
+    public SpigotEntry()
+    {
+        // Let the other parts of our program know that we're in minecraft
+        Constants.IS_MINECRAFT = true;
+    }
+
     private Logger log;
 
     private ArgsParser parser;

src/main/java/org/hydev/mcpm/client/DatabaseManager.java

@@ -1,35 +1,37 @@
 package org.hydev.mcpm.client;
 
+import org.hydev.mcpm.client.database.LocalPluginTracker;
 import org.hydev.mcpm.client.database.PluginTracker;
 import org.hydev.mcpm.client.database.boundary.SearchPackagesBoundary;
+import org.hydev.mcpm.client.database.fetcher.LocalDatabaseFetcher;
 import org.hydev.mcpm.client.database.inputs.SearchPackagesInput;
 import org.hydev.mcpm.client.database.results.SearchPackagesResult;
+import org.hydev.mcpm.client.database.searchusecase.SearchInteractor;
 import org.hydev.mcpm.client.installer.InstallResult;
 import org.hydev.mcpm.client.installer.input.InstallInput;
 import org.hydev.mcpm.client.models.PluginVersion;
 import org.hydev.mcpm.client.models.PluginYml;
 
+import java.net.URI;
 import java.util.List;
 
 /**
  * Database API
  */
 public class DatabaseManager {
-
     private final PluginTracker localPluginTracker;
     private final SearchPackagesBoundary searchInteractor;
 
-    public DatabaseManager(PluginTracker localPluginTracker, SearchPackagesBoundary searchInteractor) {
-        this.localPluginTracker = localPluginTracker;
-        this.searchInteractor = searchInteractor;
+    public DatabaseManager(PluginTracker tracker, SearchPackagesBoundary searcher) {
+        this.localPluginTracker = tracker;
+        this.searchInteractor = searcher;
     }
 
     /**
      *
-     * Search if the plugin exists, throw exception if it does not exist and return the information of
-     * the pluigin needs to be installed.
+     * Search if the plugin exists, return the Search Results
      *
-     * @param input the plugin input pending for installation
+     * @param input the input pending for installation
      */
     public SearchPackagesResult getSearchResult(InstallInput input) {
         SearchPackagesInput searchPackagesInput = new SearchPackagesInput(input.type(), input.name(), false);
@@ -39,16 +41,35 @@ public SearchPackagesResult getSearchResult(InstallInput input) {
     }
 
     /**
-     * check if plugin already installed locally
+     * check if plugin with given version already installed locally
+     *
+     * @param pluginName The version of the installed plugin
+     * */
+    public boolean checkPluginInstalledByName(String pluginName) {
+        var name = pluginName;
+
+        List<PluginYml> pluginInstalled = localPluginTracker.listInstalled();
+        for (PluginYml pluginYml : pluginInstalled) {
+            if (pluginYml != null && pluginYml.name() != null && pluginYml.name().equals(name)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+
+    /**
+     * check if plugin with given name already installed locally
      *
      * @param pluginVersion The version of the installed plugin
      * */
-    public boolean checkPluginInstalled(PluginVersion pluginVersion) {
+    public boolean checkPluginInstalledByVersion(PluginVersion pluginVersion) {
         var name = pluginVersion.meta().name();
 
         List<PluginYml> pluginInstalled = localPluginTracker.listInstalled();
         for (PluginYml pluginYml : pluginInstalled) {
-            if (pluginYml != null && pluginYml.name() != null && pluginYml.name().equals(name)) {
+            if (pluginYml != null && pluginYml.version() != null &&
+                    pluginYml.version().equals(pluginVersion.meta().version())) {
                 return true;
             }
         }

src/main/java/org/hydev/mcpm/client/Downloader.java

@@ -9,15 +9,13 @@
 
 import java.io.*;
 import java.net.HttpURLConnection;
+import java.net.URL;
 import java.nio.file.Files;
 import java.util.ArrayList;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
-import java.net.URL;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
-import java.util.concurrent.TimeUnit;
 
 import static java.lang.String.format;
 
@@ -140,18 +138,20 @@ public Downloader threads(int threads)
     /**
      * Displays a demo for downloader.
      *
-     * @param args Arguments are ignored.
+     * @param args Not used
      */
-    public static void main(String[] args) throws IOException {
-        // Remember to chang link to test
-        String link = "https://sd.blackball.lv/library/Introduction_to_Algorithms_Third_Edition_(2009).pdf";
-        File out = new File("./Introduction_to_Algorithms_Third_Edition.pdf");
-        String link1 = "https://www.iusb.edu/students/academic-success-programs/academic-centers-for-excellence/docs/Basic%20Math%20Review%20Card.pdf";
-        File out1 = new File("./Math.pdf");
-        Downloader downloader = new Downloader();
+    public static void main(String[] args)
+    {
+        String link = "https://mcpm.hydev.org/db";
+        File out = new File("./build/db.json");
+        String link1 = "https://mcpm.hydev.org/db.zst";
+        File out1 = new File("./build/db.zst");
+        Downloader downloader = new Downloader().showProgress(true).threads(2);
         Map<String, File> urls = new HashMap<>();
         urls.put(link, out);
         urls.put(link1, out1);
         downloader.downloadFiles(urls);
+        out.delete();
+        out1.delete();
     }
 }

src/main/java/org/hydev/mcpm/client/arguments/CommandsFactory.java

@@ -4,8 +4,10 @@
 import org.hydev.mcpm.client.Downloader;
 import org.hydev.mcpm.client.arguments.parsers.*;
 import org.hydev.mcpm.client.commands.entries.*;
+import org.hydev.mcpm.client.database.CheckForUpdatesInteractor;
 import org.hydev.mcpm.client.database.ListAllInteractor;
 import org.hydev.mcpm.client.database.LocalPluginTracker;
+import org.hydev.mcpm.client.database.MatchPluginsInteractor;
 import org.hydev.mcpm.client.database.export.ExportInteractor;
 import org.hydev.mcpm.client.database.fetcher.LocalDatabaseFetcher;
 import org.hydev.mcpm.client.database.fetcher.ProgressBarFetcherListener;
@@ -14,6 +16,7 @@
 import org.hydev.mcpm.client.injector.PluginLoader;
 import org.hydev.mcpm.client.installer.InstallInteractor;
 import org.hydev.mcpm.client.installer.SpigotPluginDownloader;
+import org.hydev.mcpm.client.updater.UpdateInteractor;
 import org.hydev.mcpm.utils.ColorLogger;
 
 import java.util.List;
@@ -32,24 +35,34 @@ private CommandsFactory() { }
     /**
      * Creates a list of general parsers for the ArgsParser class.
      *
+     * @param isMinecraft If we're in the minecraft env
      * @return Returns a list of argument parsers that work in any environment (Server & CLI).
      */
-    public static List<CommandParser> baseParsers() {
-        var fetcherListener = new ProgressBarFetcherListener();
+    public static List<CommandParser> baseParsers(boolean isMinecraft) {
         var mirror = new MirrorSelector();
         var fetcher = new LocalDatabaseFetcher(mirror.selectedMirrorSupplier());
         var tracker = new LocalPluginTracker();
-        var searcher = new SearchInteractor(fetcher, fetcherListener);
+        var loader = isMinecraft ? new PluginLoader() : null;
+        var listener = new ProgressBarFetcherListener();
+        var searcher = new SearchInteractor(fetcher, listener);
+        var installer = new InstallInteractor(
+            new SpigotPluginDownloader(new Downloader(), mirror.selectedMirrorSupplier()),
+            new DatabaseManager(tracker, searcher),
+            loader
+        );
+        var matcher = new MatchPluginsInteractor(fetcher, listener);
+        var updateChecker = new CheckForUpdatesInteractor(matcher);
+        var updater = new UpdateInteractor(updateChecker, installer, tracker);
+
+        // Controllers
         var exportPluginsController = new ExportPluginsController(new ExportInteractor(tracker));
         var listController = new ListController(new ListAllInteractor(tracker));
-        
         var searchController = new SearchPackagesController(searcher);
         var mirrorController = new MirrorController(mirror);
         var infoController = new InfoController(tracker);
-        var installController = new InstallController(new InstallInteractor(
-            new SpigotPluginDownloader(new Downloader(), mirror.selectedMirrorSupplier()),
-            new DatabaseManager(tracker, searcher)));
-        var refreshController = new RefreshController(fetcher, fetcherListener, mirror);
+        var installController = new InstallController(installer);
+        var updateController = new UpdateController(updater);
+        var refreshController = new RefreshController(fetcher, listener, mirror);
 
         /*
          * Add general parsers to this list!
@@ -63,7 +76,8 @@ public static List<CommandParser> baseParsers() {
             new MirrorParser(mirrorController),
             new InfoParser(infoController),
             new InstallParser(installController),
-            new RefreshParser(refreshController)
+            new RefreshParser(refreshController),
+            new UpdateParser(updateController)
         );
     }
 
@@ -90,7 +104,7 @@ public static List<CommandParser> serverParsers() {
             new UnloadParser(unloadController)
         );
 
-        return Stream.concat(baseParsers().stream(), serverOnly.stream()).toList();
+        return Stream.concat(baseParsers(true).stream(), serverOnly.stream()).toList();
     }
 
     /**
@@ -99,7 +113,7 @@ public static List<CommandParser> serverParsers() {
      * @return An ArgsParser object. Invoke ArgsParser#parse to see more.
      */
     public static ArgsParser baseArgsParser() {
-        return new ArgsParser(baseParsers(), ColorLogger.toStdOut());
+        return new ArgsParser(baseParsers(false), ColorLogger.toStdOut());
     }
 
     /**

src/main/java/org/hydev/mcpm/client/arguments/parsers/SearchParser.java

@@ -4,20 +4,18 @@
 import net.sourceforge.argparse4j.inf.Namespace;
 import net.sourceforge.argparse4j.inf.Subparser;
 import org.hydev.mcpm.client.commands.entries.SearchPackagesController;
+
+import java.util.List;
 import java.util.function.Consumer;
 
 /**
  * SearchParser has two arguments: "type" and "text."
  * When the user runs the search command, the program prompts the user to specify the type of
  * search and the search text.
+ *
+ * @author Jerry Zhu (https://github.com/jerryzhu509)
  */
-public class SearchParser implements CommandParser {
-    private final SearchPackagesController controller;
-
-    public SearchParser(SearchPackagesController controller) {
-        this.controller = controller;
-    }
-
+public record SearchParser(SearchPackagesController controller) implements CommandParser {
     @Override
     public String name() {
         return "search";
@@ -30,20 +28,31 @@ public String description() {
 
     @Override
     public void configure(Subparser parser) {
-        parser.addArgument("by").choices("name", "keyword", "command")
-                .setDefault("name").dest("type")
-                .help("Specifies the Type of Search");
+        // Default search by name, if -k is specified then search by keyword
+        var type = parser.addMutuallyExclusiveGroup();
+        type.addArgument("-k", "--keyword").action(Arguments.storeTrue()).dest("byKeyword")
+            .help("Search by keyword in descriptions");
+        type.addArgument("-c", "--command").action(Arguments.storeTrue()).dest("byCommand")
+            .help("Search by command");
+
+        // Content of the search
         parser.addArgument("text").dest("text").nargs("+")
-                .help("Specifies the search text.");
+            .help("Specifies the search text.");
         parser.addArgument("-n", "--no-cache").action(Arguments.storeTrue()).dest("noCache")
-                .help("Specifies whether to use local cache or not.");
+            .help("Specifies whether to use local cache or not.");
     }
 
     @Override
     public void run(Namespace details, Consumer<String> log) {
-        var t = details.getList("text");
-        controller.searchPackages(details.getString("type"),
-                String.join(" ", details.getList("text")),
-                !details.getBoolean("noCache"), log);
+        // Convert type
+        var type = "name";
+        if (details.getBoolean("byKeyword"))
+            type = "keyword";
+        if (details.getBoolean("byCommand"))
+            type = "command";
+
+        // Call searchPackages
+        List<String> t = details.getList("text");
+        controller.searchPackages(type, String.join(" ", t), !details.getBoolean("noCache"), log);
     }
 }