[PR] Merge pull request #78 from CSC207-2022F-UofT/patch-mirror

hykilpikonna · web-flow · commit 70b510f5ab41 · 2022-11-28T13:16:14.000-05:00
[U] Apply selected mirror to LocalDatabaseFetcher and Downloader
diff --git a/.gitignore b/.gitignore
@@ -31,5 +31,4 @@ build
 data
 .mcpm
 *.pyc
-
 plugins
diff --git a/build.gradle b/build.gradle
@@ -43,6 +43,10 @@ checkstyle {
     maxWarnings = 5
 }
 
+task checkStyle(type: GradleBuild) {
+    tasks = ['checkStyleMain', 'checkStyleTest']
+}
+
 
 dependencies {
     // The Spigot API with no shadowing. Requires the OSS repo.
diff --git a/src/main/java/org/hydev/mcpm/client/arguments/ArgsParser.java b/src/main/java/org/hydev/mcpm/client/arguments/ArgsParser.java
@@ -49,6 +49,7 @@ public ArgsParser(List<CommandParser> allParsers, Consumer<String> log) {
 
         // Create help string and help command
         help = "mcpm: Minecraft Plugin Package Manager\n" + String.join("", allParsers.stream()
+            .filter(it -> !it.description().isBlank())
             .map(it -> String.format("&f/mcpm %s &6- %s&r\n", it.name(), it.description())).toList()) +
             "To view the help message of a command, use /mcpm <command> -h";
         var helpSub = parsers.addParser("help", false);
diff --git a/src/main/java/org/hydev/mcpm/client/arguments/CommandsFactory.java b/src/main/java/org/hydev/mcpm/client/arguments/CommandsFactory.java
@@ -21,7 +21,6 @@
 import org.hydev.mcpm.client.updater.UpdateInteractor;
 import org.hydev.mcpm.utils.ColorLogger;
 
-import java.net.URI;
 import java.util.List;
 import java.util.function.Consumer;
 import java.util.stream.Stream;
@@ -42,33 +41,35 @@ private CommandsFactory() { }
      * @return Returns a list of argument parsers that work in any environment (Server & CLI).
      */
     public static List<CommandParser> baseParsers(boolean isMinecraft) {
-        var host = URI.create("https://mcpm.hydev.org");
-        var fetcher = new LocalDatabaseFetcher(host);
+        var mirror = new MirrorSelector();
+        var fetcher = new LocalDatabaseFetcher(mirror.selectedMirrorSupplier());
         var tracker = new LocalPluginTracker();
         var jarFinder = new LocalJarFinder();
 
         var loader = isMinecraft ? new PluginLoader(jarFinder) : null;
         var listener = new ProgressBarFetcherListener();
         var searcher = new SearchInteractor(fetcher, listener);
         var installer = new InstallInteractor(
-            new SpigotPluginDownloader(new Downloader(), host.toString()),
+            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(new MirrorSelector());
+        var mirrorController = new MirrorController(mirror);
         var infoController = new InfoController(tracker);
 
         var databaseManager = new DatabaseManager(tracker, searcher);
         var installController = new InstallController(installer);
         var uninstallController = new UninstallController(new Uninstaller(tracker, loader, jarFinder));
         var updateController = new UpdateController(updater);
+        var refreshController = new RefreshController(fetcher, listener, mirror);
 
         /*
          * Add general parsers to this list!
@@ -82,6 +83,7 @@ public static List<CommandParser> baseParsers(boolean isMinecraft) {
             new MirrorParser(mirrorController),
             new InfoParser(infoController),
             new InstallParser(installController),
+            new RefreshParser(refreshController),
             new UninstallParser(uninstallController),
             new UpdateParser(updateController)
         );
diff --git a/src/main/java/org/hydev/mcpm/client/arguments/parsers/CommandParser.java b/src/main/java/org/hydev/mcpm/client/arguments/parsers/CommandParser.java
@@ -14,7 +14,7 @@ public interface CommandParser extends CommandHandler {
     String name();
 
     /**
-     * Description of the command
+     * Description of the command. If the description is empty, it will not show up in the help menu.
      *
      * @return Description
      */
diff --git a/src/main/java/org/hydev/mcpm/client/arguments/parsers/MirrorParser.java b/src/main/java/org/hydev/mcpm/client/arguments/parsers/MirrorParser.java
@@ -31,11 +31,12 @@ public String description()
     @Override
     public void run(Namespace details, Consumer<String> log)
     {
-        switch (details.getString("op"))
+        var op = details.getString("op");
+        switch (op)
         {
             case "ping" -> controller.ping(details.getBoolean("refresh"), log);
             case "select" -> controller.select(details.getString("host"), log);
-            default -> throw new RuntimeException();
+            default -> throw new UnsupportedOperationException("Unknown operation: " + op);
         }
     }
 
diff --git a/src/main/java/org/hydev/mcpm/client/arguments/parsers/RefreshParser.java b/src/main/java/org/hydev/mcpm/client/arguments/parsers/RefreshParser.java
@@ -0,0 +1,49 @@
+package org.hydev.mcpm.client.arguments.parsers;
+
+import net.sourceforge.argparse4j.inf.Namespace;
+import net.sourceforge.argparse4j.inf.Subparser;
+import org.hydev.mcpm.client.commands.entries.RefreshController;
+
+import java.io.IOException;
+import java.util.function.Consumer;
+
+/**
+ * Refresh the database cache and mirror list
+ *
+ * @author Azalea (https://github.com/hykilpikonna)
+ * @since 2022-11-24
+ */
+public record RefreshParser(RefreshController controller) implements CommandParser
+{
+    @Override
+    public String name()
+    {
+        return "refresh";
+    }
+
+    @Override
+    public String description()
+    {
+        return "Refresh cached plugin database";
+    }
+
+    @Override
+    public void configure(Subparser parser)
+    {
+
+    }
+
+    @Override
+    public void run(Namespace details, Consumer<String> log)
+    {
+        try
+        {
+            controller.refresh();
+            log.accept("&aDatabase refreshed successfully!");
+        }
+        catch (IOException e)
+        {
+            log.accept("&cDatabase refresh failed: " + e.getMessage());
+        }
+    }
+}
diff --git a/src/main/java/org/hydev/mcpm/client/commands/entries/MirrorController.java b/src/main/java/org/hydev/mcpm/client/commands/entries/MirrorController.java
@@ -59,6 +59,9 @@ public void ping(boolean refresh, Consumer<String> log)
                     List.of((selected.host().equals(it.k().host()) ? "&6> " : "&f  ") + it.k().host(),
                         formatPing(it.v()), formatSpeed(it.k().speed()))).toList(),
                 List.of(":Host", "Delay:", "Speed:")));
+
+            // User feedback
+            log.accept("You can use /mcpm mirror select <host> to select a mirror.");
         }
         catch (IOException e)
         {
diff --git a/src/main/java/org/hydev/mcpm/client/commands/entries/RefreshController.java b/src/main/java/org/hydev/mcpm/client/commands/entries/RefreshController.java
@@ -0,0 +1,35 @@
+package org.hydev.mcpm.client.commands.entries;
+
+import org.hydev.mcpm.client.database.fetcher.DatabaseFetcher;
+import org.hydev.mcpm.client.database.fetcher.DatabaseFetcherListener;
+import org.hydev.mcpm.client.database.mirrors.MirrorSelectBoundary;
+
+import java.io.IOException;
+
+/**
+ * Controller for the refresh command
+ *
+ * @author Azalea (https://github.com/hykilpikonna)
+ * @since 2022-11-24
+ */
+public record RefreshController(
+    DatabaseFetcher fetcher,
+    DatabaseFetcherListener listener,
+    MirrorSelectBoundary mirror
+)
+{
+    /**
+     * Refresh the database cache and mirror list
+     */
+    public void refresh() throws IOException
+    {
+        // Refresh local database
+        if (fetcher.fetchDatabase(false, listener) == null)
+        {
+            throw new IOException("Database fetching failed");
+        }
+
+        // Refresh mirror list
+        mirror.updateMirrors();
+    }
+}
diff --git a/src/main/java/org/hydev/mcpm/client/database/fetcher/LocalDatabaseFetcher.java b/src/main/java/org/hydev/mcpm/client/database/fetcher/LocalDatabaseFetcher.java
@@ -18,14 +18,17 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.security.NoSuchAlgorithmException;
+import java.util.function.Supplier;
 
 import static org.hydev.mcpm.Constants.JACKSON;
+import static org.hydev.mcpm.utils.GeneralUtils.concatUri;
 
 /**
  * A database fetcher that has a local persistent cache along and a network fallback.
  */
 public class LocalDatabaseFetcher implements DatabaseFetcher {
-    private final URI host;
+    private final Supplier<URI> host;
     private final Path cacheDirectory;
 
     private Database localDatabase;
@@ -45,7 +48,7 @@ public class LocalDatabaseFetcher implements DatabaseFetcher {
      * @param host The host URL MCPM server mirror that will be used to request database files.
      *             Example: "http://mcpm.hydev.com"
      */
-    public LocalDatabaseFetcher(URI host) {
+    public LocalDatabaseFetcher(Supplier<URI> host) {
         this(host, Path.of(".mcpm/"));
     }
 
@@ -56,15 +59,15 @@ public LocalDatabaseFetcher(URI host) {
      *             Example: "http://mcpm.hydev.com"
      * @param cacheDirectory The directory that the cached database and hash file will be stored (as child files).
      */
-    public LocalDatabaseFetcher(URI host, Path cacheDirectory) {
+    public LocalDatabaseFetcher(Supplier<URI> host, Path cacheDirectory) {
         this.host = host;
         this.cacheDirectory = cacheDirectory;
     }
 
     private ClassicHttpRequest requestTo(String path) {
-        var request = new HttpGet(URI.create(host.toString() + "/" + path));
+        var request = new HttpGet(concatUri(host.get(),  path));
 
-        request.addHeader("Host", host.getHost());
+        request.addHeader("Host", host.get().getHost());
         request.addHeader("User-Agent", USER_AGENT);
         request.addHeader("Accepts", "application/json");
 
diff --git a/src/main/java/org/hydev/mcpm/client/database/mirrors/MirrorSelectBoundary.java b/src/main/java/org/hydev/mcpm/client/database/mirrors/MirrorSelectBoundary.java
@@ -4,8 +4,10 @@
 import org.jetbrains.annotations.NotNull;
 
 import java.io.IOException;
+import java.net.URI;
 import java.util.List;
 import java.util.Map;
+import java.util.function.Supplier;
 
 import static java.util.Comparator.comparingInt;
 import static org.hydev.mcpm.utils.NetworkUtils.ping;
@@ -63,4 +65,26 @@ default List<Pair<Mirror, Integer>> pingMirrors() throws IOException
      * @param mirror A selected mirror
      */
     void setSelectedMirror(Mirror mirror) throws IOException;
+
+    /**
+     * Get the selected mirror as a URI supplier
+     *
+     * @return URI supplier function
+     */
+    default Supplier<URI> selectedMirrorSupplier()
+    {
+        return () ->
+        {
+            try
+            {
+                return getSelectedMirror().uri();
+            }
+            catch (IOException e)
+            {
+                // Fallback
+                e.printStackTrace();
+                return URI.create("https://mcpm.hydev.org/");
+            }
+        };
+    }
 }
diff --git a/src/main/java/org/hydev/mcpm/client/database/mirrors/MirrorSelector.java b/src/main/java/org/hydev/mcpm/client/database/mirrors/MirrorSelector.java
@@ -19,9 +19,13 @@
  * @author Azalea (https://github.com/hykilpikonna)
  * @since 2022-11-01
  */
-public class MirrorSelector implements MirrorSelectBoundary
+public record MirrorSelector(String mirrorListUrl) implements MirrorSelectBoundary
 {
-    public static final String MIRROR_LIST_URL = "https://mcprs.hydev.org/mirrorlist.yml";
+    public MirrorSelector()
+    {
+        this("https://mcprs.hydev.org/mirrorlist.yml");
+    }
+
     private static final ObjectMapper YML = new ObjectMapper(new YAMLFactory());
     private static final File LOCAL_PATH = new File(CFG_PATH, "mirrorlist.yml");
     private static final File LOCAL_SEL = new File(CFG_PATH, "selected.yml");
@@ -41,7 +45,7 @@ public class MirrorSelector implements MirrorSelectBoundary
     public void updateMirrors() throws IOException
     {
         // Send request to fetch mirror list
-        var yml = Request.get(MIRROR_LIST_URL).execute().returnContent().asString();
+        var yml = Request.get(mirrorListUrl()).execute().returnContent().asString();
 
         // Try parsing the YML
         YML.readValue(yml, new TypeReference<List<Mirror>>(){});
diff --git a/src/main/java/org/hydev/mcpm/client/database/searchusecase/SearchInteractor.java b/src/main/java/org/hydev/mcpm/client/database/searchusecase/SearchInteractor.java
@@ -17,7 +17,6 @@ public class SearchInteractor implements SearchPackagesBoundary {
     private final DatabaseFetcher fetcher;
     private final DatabaseFetcherListener listener;
 
-
     /**
      * Creates a new database with the provided database fetcher.
      * Consider passing LocalDatabaseFetcher. Defaults to the ProgressBarFetcherListener.
diff --git a/src/main/java/org/hydev/mcpm/client/installer/InstallInteractor.java b/src/main/java/org/hydev/mcpm/client/installer/InstallInteractor.java
@@ -119,15 +119,15 @@ public InstallResult installPlugin(InstallInput installInput)
     public static void main(String[] args) {
         new File(FILEPATH).mkdirs();
         var host = URI.create("https://mcpm.hydev.org");
-        var fetcher = new LocalDatabaseFetcher(host);
+        var fetcher = new LocalDatabaseFetcher(() -> host);
         var tracker = new LocalPluginTracker();
         var searcher = new SearchInteractor(fetcher);
         Downloader downloader = new Downloader();
         PluginLoader loader = null;
-        SpigotPluginDownloader spigotPluginDownloader = new SpigotPluginDownloader(downloader);
+        SpigotPluginDownloader spigotPluginDownloader = new SpigotPluginDownloader(downloader, () -> host);
         DatabaseManager databaseManager = new DatabaseManager(tracker, searcher);
         InstallInteractor installInteractor = new InstallInteractor(spigotPluginDownloader, databaseManager, loader);
         InstallInput installInput = new InstallInput("JedCore", SearchPackagesType.BY_NAME, true, true);
         installInteractor.installPlugin(installInput);
     }
-}
+}
diff --git a/src/main/java/org/hydev/mcpm/client/installer/SpigotPluginDownloader.java b/src/main/java/org/hydev/mcpm/client/installer/SpigotPluginDownloader.java
@@ -3,6 +3,10 @@
 import org.hydev.mcpm.client.Downloader;
 
 import java.io.File;
+import java.net.URI;
+import java.util.function.Supplier;
+
+import static org.hydev.mcpm.utils.GeneralUtils.concatUri;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Paths;
@@ -17,26 +21,17 @@
 public class SpigotPluginDownloader implements PluginDownloader {
 
     private final Downloader downloader;
-    private final String baseUrl;
-
-    /**
-     * Initialize the Spigot Plugin Downloader*
-     *
-     * @param downloader The file downloader
-     * */
-    public SpigotPluginDownloader(Downloader downloader) {
-        this(downloader, "https://mcpm.hydev.org");
-    }
+    private final Supplier<URI> host;
 
     /**
      * Initialize the Spigot Plugin Downloader
      *
      * @param downloader The file downloader
-     * @param baseUrl base URL for web brower
+     * @param host Base URL provider
      * */
-    public SpigotPluginDownloader(Downloader downloader, String baseUrl) {
+    public SpigotPluginDownloader(Downloader downloader, Supplier<URI> host) {
         this.downloader = downloader;
-        this.baseUrl = baseUrl;
+        this.host = host;
     }
 
     /**
@@ -64,8 +59,9 @@ public void download(long pluginId, long pluginVersion, String destination) {
      *
      * @param pluginId Spigot Plugin ID
      * @param pluginVersion Spigot Plugin Version ID
-     * */
+     */
     private String constructUrl(long pluginId, long pluginVersion) {
-        return String.format("%s/pkgs/spiget/%s/%s/release.jar", baseUrl, pluginId, pluginVersion);
+
+        return concatUri(host.get(), String.format("pkgs/spiget/%s/%s/release.jar", pluginId, pluginVersion)).toString();
     }
 }
diff --git a/src/main/java/org/hydev/mcpm/utils/ColorLogger.java b/src/main/java/org/hydev/mcpm/utils/ColorLogger.java
diff --git a/src/main/java/org/hydev/mcpm/utils/GeneralUtils.java b/src/main/java/org/hydev/mcpm/utils/GeneralUtils.java
diff --git a/src/test/java/org/hydev/mcpm/client/database/MirrorSelectorTest.java b/src/test/java/org/hydev/mcpm/client/database/MirrorSelectorTest.java
diff --git a/tools/run.py b/tools/run.py

-Original file line number
+Diff line change
 data
 .mcpm
 *.pyc
+-
 plugins
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,10 @@ checkstyle {`
`43`	`43`	`maxWarnings = 5`
`44`	`44`	`}`
`45`	`45`
	`46`	`+task checkStyle(type: GradleBuild) {`
	`47`	`+ tasks = ['checkStyleMain', 'checkStyleTest']`
	`48`	`+}`
	`49`	`+`
`46`	`50`
`47`	`51`	`dependencies {`
`48`	`52`	`// The Spigot API with no shadowing. Requires the OSS repo.`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public interface CommandParser extends CommandHandler {`
`14`	`14`	`String name();`
`15`	`15`
`16`	`16`	`/**`
`17`		`- * Description of the command`
	`17`	`+ * Description of the command. If the description is empty, it will not show up in the help menu.`
`18`	`18`	`*`
`19`	`19`	`* @return Description`
`20`	`20`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -31,11 +31,12 @@ public String description()`
`31`	`31`	`@Override`
`32`	`32`	`public void run(Namespace details, Consumer<String> log)`
`33`	`33`	`{`
`34`		`- switch (details.getString("op"))`
	`34`	`+ var op = details.getString("op");`
	`35`	`+ switch (op)`
`35`	`36`	`{`
`36`	`37`	`case "ping" -> controller.ping(details.getBoolean("refresh"), log);`
`37`	`38`	`case "select" -> controller.select(details.getString("host"), log);`
`38`		`- default -> throw new RuntimeException();`
	`39`	`+ default -> throw new UnsupportedOperationException("Unknown operation: " + op);`
`39`	`40`	`}`
`40`	`41`	`}`
`41`	`42`
Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,9 @@ public void ping(boolean refresh, Consumer<String> log)`
`59`	`59`	`List.of((selected.host().equals(it.k().host()) ? "&6> " : "&f ") + it.k().host(),`
`60`	`60`	`formatPing(it.v()), formatSpeed(it.k().speed()))).toList(),`
`61`	`61`	`List.of(":Host", "Delay:", "Speed:")));`
	`62`	`+`
	`63`	`+ // User feedback`
	`64`	`+ log.accept("You can use /mcpm mirror select <host> to select a mirror.");`
`62`	`65`	`}`
`63`	`66`	`catch (IOException e)`
`64`	`67`	`{`