Release 2.0.22 (#234)

* feat: add verification timing and map captcha timing to bstats charts

* fix: use correct char ids for bStats

* fix: implement shutdown method to correctly stop certain services

* style: small codestyle improvements

build.gradle.kts

@@ -80,6 +80,8 @@ tasks {
     relocate("com.google.gson", "xyz.jonesdev.sonar.libs.gson")
     relocate("com.j256.ormlite", "xyz.jonesdev.sonar.libs.ormlite")
     relocate("com.github.benmanes.caffeine", "xyz.jonesdev.sonar.libs.caffeine")
+    relocate("com.mysql", "xyz.jonesdev.sonar.libs.mysql")
+    relocate("org.mariadb", "xyz.jonesdev.sonar.libs.mariadb")
 
     // TODO: actually fix this :/
     // We have to be careful here, so we don't accidentally break adventure

gradle.properties

@@ -1,3 +1,3 @@
 group=xyz.jonesdev.sonar
-version=2.0.21
+version=2.0.22
 description=Effective Anti-bot plugin for Velocity, BungeeCord, and Bukkit (1.7-latest)

sonar-api/src/main/java/xyz/jonesdev/sonar/api/config/SonarConfiguration.java

@@ -18,8 +18,6 @@
 package xyz.jonesdev.sonar.api.config;
 
 import com.j256.ormlite.db.DatabaseType;
-import com.j256.ormlite.jdbc.db.MariaDbDatabaseType;
-import com.j256.ormlite.jdbc.db.MysqlDatabaseType;
 import lombok.*;
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.minimessage.MiniMessage;
@@ -28,6 +26,8 @@ import org.jetbrains.annotations.Nullable;
 import xyz.jonesdev.sonar.api.Sonar;
 import xyz.jonesdev.sonar.api.command.SonarCommand;
 import xyz.jonesdev.sonar.api.logger.LoggerWrapper;
+import xyz.jonesdev.sonar.api.ormlite.MariaDbDatabaseTypeAdapter;
+import xyz.jonesdev.sonar.api.ormlite.MysqlDatabaseTypeAdapter;
 import xyz.jonesdev.sonar.api.webhook.DiscordWebhook;
 
 import java.io.File;
@@ -420,8 +420,13 @@ public final class SonarConfiguration {
     private Timing timing;
 
     @Getter
+    @RequiredArgsConstructor
     public enum Timing {
-      ALWAYS, DURING_ATTACK, NEVER
+      ALWAYS("Always"),
+      DURING_ATTACK("During Attack"),
+      NEVER("Never");
+
+      private final String displayName;
     }
 
     private final Map map = new Map();
@@ -560,13 +565,10 @@ public final class SonarConfiguration {
     @Getter
     @RequiredArgsConstructor
     public enum Type {
-      MYSQL("com.mysql.cj.jdbc.NonRegisteringDriver",
-        "jdbc:mysql://%s:%d/%s", new MysqlDatabaseType()),
-      MARIADB("org.mariadb.jdbc.Driver",
-        "jdbc:mariadb://%s:%d/%s", new MariaDbDatabaseType()),
-      NONE(null, null, null);
+      MYSQL("jdbc:mysql://%s:%d/%s", new MysqlDatabaseTypeAdapter()),
+      MARIADB("jdbc:mariadb://%s:%d/%s", new MariaDbDatabaseTypeAdapter()),
+      NONE(null, null);
 
-      private final String driverClassName;
       private final String connectionString;
       private final DatabaseType databaseType;
     }

sonar-api/src/main/java/xyz/jonesdev/sonar/api/controller/VerifiedPlayerController.java

@@ -81,6 +81,9 @@ public final class VerifiedPlayerController {
       return;
     }
 
+    // Initialize MySQL/MariaDB driver
+    database.getType().getDatabaseType().loadDriver();
+
     try {
       connectionSource = new JdbcPooledConnectionSource(
         String.format(database.getType().getConnectionString(),
@@ -116,6 +119,21 @@ public final class VerifiedPlayerController {
     }
   }
 
+  /**
+   * Closes the connection if instantiated
+   */
+  public void close() {
+    // The connection source will always be null if the database type is NONE.
+    if (connectionSource != null) {
+      try {
+        // Properly close the connection
+        connectionSource.close();
+      } catch (Exception exception) {
+        LOGGER.error("Error closing database: {}", exception);
+      }
+    }
+  }
+
   /**
    * Clear all old entries using the given timestamp.
    */

sonar-api/src/main/java/xyz/jonesdev/sonar/api/ormlite/MariaDbDatabaseTypeAdapter.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright (C) 2023-2024 Sonar Contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package xyz.jonesdev.sonar.api.ormlite;
+
+import com.j256.ormlite.jdbc.db.MariaDbDatabaseType;
+import org.jetbrains.annotations.NotNull;
+
+public final class MariaDbDatabaseTypeAdapter extends MariaDbDatabaseType {
+
+  @Override
+  protected String @NotNull [] getDriverClassNames() {
+    return new String[]{"xyz.jonesdev.sonar.libs.mariadb.jdbc.Driver"};
+  }
+}

sonar-api/src/main/java/xyz/jonesdev/sonar/api/ormlite/MysqlDatabaseTypeAdapter.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright (C) 2023-2024 Sonar Contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package xyz.jonesdev.sonar.api.ormlite;
+
+import com.j256.ormlite.jdbc.db.MysqlDatabaseType;
+import org.jetbrains.annotations.NotNull;
+
+public final class MysqlDatabaseTypeAdapter extends MysqlDatabaseType {
+
+  @Override
+  protected String @NotNull [] getDriverClassNames() {
+    return new String[]{"xyz.jonesdev.sonar.libs.mysql.cj.jdbc.Driver"};
+  }
+}

sonar-bukkit/src/main/java/xyz/jonesdev/sonar/bukkit/SonarBukkit.java

@@ -22,6 +22,7 @@ import lombok.Getter;
 import net.kyori.adventure.audience.Audience;
 import net.kyori.adventure.platform.bukkit.BukkitAudiences;
 import org.bstats.bukkit.Metrics;
+import org.bstats.charts.SimplePie;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import xyz.jonesdev.sonar.api.Sonar;
@@ -82,11 +83,18 @@ public final class SonarBukkit extends SonarBootstrap<SonarBukkitPlugin> {
     }
   };
 
+  private Metrics metrics;
+
   @Override
   public void enable() {
-
     // Initialize bStats.org metrics
-    new Metrics(getPlugin(), getPlatform().getMetricsId());
+    metrics = new Metrics(getPlugin(), getPlatform().getMetricsId());
+
+    // Add charts for some configuration options
+    metrics.addCustomChart(new SimplePie("verification",
+      () -> getConfig().getVerification().getTiming().getDisplayName()));
+    metrics.addCustomChart(new SimplePie("captcha",
+      () -> getConfig().getVerification().getMap().getTiming().getDisplayName()));
 
     // Register Sonar command
     Objects.requireNonNull(getPlugin().getCommand("sonar")).setExecutor(new BukkitSonarCommand());
@@ -103,4 +111,10 @@ public final class SonarBukkit extends SonarBootstrap<SonarBukkitPlugin> {
     getPlugin().getServer().getScheduler().runTaskTimerAsynchronously(getPlugin(),
       Sonar.get().getVerboseHandler()::update, 4L, 4L);
   }
+
+  @Override
+  public void disable() {
+    // Make sure to properly shutdown bStats metrics
+    metrics.shutdown();
+  }
 }

sonar-bungee/src/main/java/xyz/jonesdev/sonar/bungee/SonarBungee.java

@@ -22,6 +22,7 @@ import lombok.Getter;
 import net.kyori.adventure.audience.Audience;
 import net.kyori.adventure.platform.bungeecord.BungeeAudiences;
 import org.bstats.bungeecord.Metrics;
+import org.bstats.charts.SimplePie;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import xyz.jonesdev.sonar.api.Sonar;
@@ -82,11 +83,18 @@ public final class SonarBungee extends SonarBootstrap<SonarBungeePlugin> {
     }
   };
 
+  private Metrics metrics;
+
   @Override
   public void enable() {
-
     // Initialize bStats.org metrics
-    new Metrics(getPlugin(), getPlatform().getMetricsId());
+    metrics = new Metrics(getPlugin(), getPlatform().getMetricsId());
+
+    // Add charts for some configuration options
+    metrics.addCustomChart(new SimplePie("verification",
+      () -> getConfig().getVerification().getTiming().getDisplayName()));
+    metrics.addCustomChart(new SimplePie("captcha",
+      () -> getConfig().getVerification().getMap().getTiming().getDisplayName()));
 
     // Register Sonar command
     getPlugin().getServer().getPluginManager().registerCommand(getPlugin(), new BungeeSonarCommand());
@@ -109,4 +117,10 @@ public final class SonarBungee extends SonarBootstrap<SonarBungeePlugin> {
     // Make sure to inject into the server's connection handler
     FallbackInjectionHelper.inject();
   }
+
+  @Override
+  public void disable() {
+    // Make sure to properly shutdown bStats metrics
+    metrics.shutdown();
+  }
 }

sonar-common/src/main/java/xyz/jonesdev/sonar/common/boot/LibraryLoader.java

@@ -61,12 +61,14 @@ class LibraryLoader {
         .groupId("com{}mysql")
         .artifactId("mysql-connector-j")
         .version("8.3.0")
+        .relocate("com{}mysql", "xyz{}jonesdev{}sonar{}libs{}mysql")
         .build(),
       // MariaDB driver
       Library.builder()
         .groupId("org{}mariadb{}jdbc")
         .artifactId("mariadb-java-client")
         .version("3.3.3")
+        .relocate("org{}mariadb", "xyz{}jonesdev{}sonar{}libs{}mariadb")
         .build()
     );
   }

sonar-common/src/main/java/xyz/jonesdev/sonar/common/boot/SonarBootstrap.java

@@ -156,14 +156,23 @@ public abstract class SonarBootstrap<T> implements Sonar {
     }
 
     // Reinitialize database controller
+    if (verifiedPlayerController != null) {
+      // Close the old connection first
+      verifiedPlayerController.close();
+    }
     verifiedPlayerController = new VerifiedPlayerController();
   }
 
-  public void shutdown() {
+  public final void shutdown() {
+    // Initialize shutdown process
     getLogger().info("Starting shutdown process...");
-
-    // ...
-
+    // Close database connection
+    verifiedPlayerController.close();
+    // Run the per-platform disable method
+    disable();
+    // Thank the user for using Sonar
     getLogger().info("Successfully shut down. Goodbye!");
   }
+
+  public abstract void disable();
 }

sonar-velocity/src/main/java/xyz/jonesdev/sonar/velocity/SonarVelocity.java

@@ -20,6 +20,8 @@ package xyz.jonesdev.sonar.velocity;
 import com.alessiodp.libby.VelocityLibraryManager;
 import lombok.Getter;
 import net.kyori.adventure.audience.Audience;
+import org.bstats.charts.SimplePie;
+import org.bstats.velocity.Metrics;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import xyz.jonesdev.sonar.api.Sonar;
@@ -85,11 +87,18 @@ public final class SonarVelocity extends SonarBootstrap<SonarVelocityPlugin> {
     }
   };
 
+  private Metrics metrics;
+
   @Override
   public void enable() {
-
     // Initialize bStats.org metrics
-    getPlugin().getMetricsFactory().make(getPlugin(), getPlatform().getMetricsId());
+    metrics = getPlugin().getMetricsFactory().make(getPlugin(), getPlatform().getMetricsId());
+
+    // Add charts for some configuration options
+    metrics.addCustomChart(new SimplePie("verification",
+      () -> getConfig().getVerification().getTiming().getDisplayName()));
+    metrics.addCustomChart(new SimplePie("captcha",
+      () -> getConfig().getVerification().getMap().getTiming().getDisplayName()));
 
     // Register Sonar command
     getPlugin().getServer().getCommandManager().register("sonar", new VelocitySonarCommand());
@@ -119,4 +128,10 @@ public final class SonarVelocity extends SonarBootstrap<SonarVelocityPlugin> {
     // Make sure to inject into the server's connection handler
     FallbackInjectionHelper.inject(getPlugin().getServer());
   }
+
+  @Override
+  public void disable() {
+    // Make sure to properly shutdown bStats metrics
+    metrics.shutdown();
+  }
 }