Code Polish v1 (#2103)

* Remove Spigot platform modules and related dependencies

This commit removes all Spigot platform-specific modules, classes, and build configurations, including `AbstractSpigotPlatform`, `NbtApiInitializer`, and corresponding project configuration files (POMs). This cleanup helps streamline the project and eliminates dependencies on Spigot and NBT-API.

* Bumped Java version usage to 21.

* Remove deprecated economy-related classes and implementations.

This commit removes obsolete economy-related classes, interfaces, and implementations. The code cleanup includes `AbstractEconomy`, `Benefit`, `DepositEconomyOperation`, and economy implementations like `Economy_Vault` and `Economy_VaultUnlocked`. These were either redundant or replaced by new approaches.

* Refactor economy package structure.

Renamed and updated references for the "economyrevamp" package to "economy" for better clarity and consistency across the project. This includes file paths, imports, and related classes. No functional changes were made.

* Remove deprecated classes and methods from the codebase.

This commit eliminates several deprecated classes and methods across various packages, including ItemExpression, ShopModerator, and VaultPermissionProvider. Redundant functionality has been consolidated or replaced with newer implementations, improving maintainability and reducing legacy code bloat.

* Fix typo in method documentation in Shop.java

Corrected "attacked" to "attached" in the JavaDoc of the `checkShop` method to ensure the comment accurately describes the method's purpose. This improves code clarity and reduces potential confusion for developers.

* Update changelog.

* Update dependencies and adjust logging and API methods

Updated several dependencies, including updating commons-lang3 to 3.18.0, and adjusted dependency scopes and exclusions for better modularity. Refactored the `getPlayerLocale` method to use `QUser` instead of `UUID`. Minor logging implementation improvements were also applied.

* Switch to `CommonUtil` and refactor method calls for consistency.

Replaced usages of `StringUtils` with `CommonUtil` and updated methods for improved readability and modernized coding conventions. Bumped version in relevant `pom.xml` files to ensure compatibility, streamlined code paths using `getFirst()` replacements, and adjusted dependency scopes for better package management.

* Refactor type declarations and optimize utility methods

Replaced `EnumSet` and `EnumMap` with `HashSet` and `HashMap` for better maintainability and flexibility. Streamlined `instanceof` type casts by adding `final` for clarity and potential performance benefits. Removed deprecated or redundant methods and added logical safeguards for more robust behavior.

* Add a config to enable/disable enchants for display items, add a workaround for PacketEvents not supporting custom enchants for itemstack conversion.

* Revert distribution changes since updated changes don't seem to work when implemented according to the CodeMC docs.

Author: creatorfromhell

.changelog/6.2.0.11.md

@@ -7,17 +7,20 @@
 - Update configuration system?
     - auto updating?
     - Allows removal of the update code
-- Remove waste spigot modules?
-    - Any versions of 1.20 that can be discarded due to low use?
 - Bug fixing, of course
 - Sign parser implementation?
     - probably have to re-evaluate since it's been awhile since it has been looked at...
 
 # 6.2.0.11
 
 ## Major Changes
+- Removed Spigot Platform Modules, and stopped loading QS if Spigot is detected. This will mean that unless the protocol changes that we use for display items, QS won't need updated for each version.
+- Revamped Economy Code Completely
+  - New classes for all economy-related systems
+  - Any economy-related or benefits-related events are incompatible with previous versions.
 
-## Internals/DeveloperAPIs
+## Internals/Developer APIs
+- Removed several deprecated methods and classes.
 - Revamped the interaction manager. It is now more flexible and allows external additions
   - This involves two classes InteractionBehavior and InteractionType.
   - InteractionType details the type of interaction such as: STANDING_LEFT_CLICK_SIGN, STANDING_LEFT_CLICK_SHOP
@@ -30,7 +33,11 @@
        manager.interaction(new MyTradeInteraction());
        manager.behavior(new MyTradeBehavior());
     ```
+- Replaced some apache commons calls that could be easily replaced with built-in java methods, reduces some calls by ~ 1100ms/method call
 
 ## Minor Changes
+- Bump Java version up to 21
+- Added shop.display-allow-enchants to enable/disable enchantments for display items on shops.
+- Added workaround for packetevents not supporting custom enchants on itemstacks for virtual display items.
 
 ## Fixes

addon/bluemap/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.ghostchu</groupId>
         <artifactId>quickshop-hikari</artifactId>
-        <version>6.2.0.11-SNAPSHOT-1</version>
+        <version>6.2.0.11-SNAPSHOT-4</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <groupId>com.ghostchu.quickshop.addon</groupId>
@@ -47,22 +47,16 @@
 
     <dependencies>
         <dependency>
-            <groupId>org.spigotmc</groupId>
-            <artifactId>spigot-api</artifactId>
+            <groupId>io.papermc.paper</groupId>
+            <artifactId>paper-api</artifactId>
+            <version>${depend.paper}</version>
         </dependency>
         <dependency>
             <groupId>com.ghostchu</groupId>
             <artifactId>quickshop-bukkit</artifactId>
             <version>${project.parent.version}</version>
             <scope>provided</scope>
         </dependency>
-        <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
-        <dependency>
-            <groupId>org.apache.commons</groupId>
-            <artifactId>commons-lang3</artifactId>
-            <version>${depend.commons.lang3}</version>
-            <scope>provided</scope>
-        </dependency>
         <dependency>
             <groupId>de.bluecolored.bluemap</groupId>
             <artifactId>BlueMapAPI</artifactId>

addon/discordsrv/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.ghostchu</groupId>
         <artifactId>quickshop-hikari</artifactId>
-        <version>6.2.0.11-SNAPSHOT-1</version>
+        <version>6.2.0.11-SNAPSHOT-4</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <groupId>com.ghostchu.quickshop.addon</groupId>
@@ -50,8 +50,9 @@
 
     <dependencies>
         <dependency>
-            <groupId>org.spigotmc</groupId>
-            <artifactId>spigot-api</artifactId>
+            <groupId>io.papermc.paper</groupId>
+            <artifactId>paper-api</artifactId>
+            <version>${depend.paper}</version>
         </dependency>
         <dependency>
             <groupId>com.ghostchu</groupId>

addon/discordsrv/src/main/java/com/ghostchu/quickshop/addon/discordsrv/Main.java

@@ -70,7 +70,7 @@ public void onEnable() {
     quickshop.getShopPermissionManager().registerPermission(BuiltInShopPermissionGroup.ADMINISTRATOR.getNamespacedNode(), this, "discordalert");
     try {
       this.databaseHelper = new DiscordDatabaseHelper(this, quickshop.getSqlManager(), quickshop.getDbPrefix());
-    } catch(SQLException e) {
+    } catch(final SQLException e) {
       getLogger().log(Level.SEVERE, "Failed to connect to database, please check your database settings.", e);
       Bukkit.getPluginManager().disablePlugin(this);
       return;
@@ -94,12 +94,6 @@ public JDAWrapper getJdaWrapper() {
     return jdaWrapper;
   }
 
-  @Deprecated
-  public boolean isServerNotifactionFeatureEnabled(@NotNull final NotificationFeature feature) {
-
-    return isServerNotificationFeatureEnabled(feature);
-  }
-
   public boolean isServerNotificationFeatureEnabled(@NotNull final NotificationFeature feature) {
 
     return getConfig().getBoolean("features." + feature.getConfigNode(), true);

addon/discordsrv/src/main/java/com/ghostchu/quickshop/addon/discordsrv/command/SubCommand_Discord.java

@@ -37,7 +37,7 @@ public void onCommand(final Player sender, @NotNull final String commandLabel, @
       qs.text().of(sender, "command-incorrect", "/quickshop discord <features> <enable/disable>").send();
       return;
     }
-    final NotificationFeature feature = getFeatureByName(parser.getArgs().get(0));
+    final NotificationFeature feature = getFeatureByName(parser.getArgs().getFirst());
     if(feature == null) {
       qs.text().of(sender, "command-incorrect", "/quickshop discord <features> <enable/disable>").send();
       return;

addon/discordsrv/src/main/java/com/ghostchu/quickshop/addon/discordsrv/database/DiscordDatabaseHelper.java

@@ -10,7 +10,6 @@
 import com.ghostchu.quickshop.common.util.JsonUtil;
 import com.ghostchu.quickshop.util.Util;
 import com.ghostchu.quickshop.util.logger.Log;
-import org.apache.commons.lang3.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -30,7 +29,7 @@ public DiscordDatabaseHelper(@NotNull final Main plugin, @NotNull final SQLManag
     this.plugin = plugin;
     try {
       DiscordTables.initializeTables(sqlManager, dbPrefix);
-    } catch(SQLException e) {
+    } catch(final SQLException e) {
       plugin.getLogger().log(Level.WARNING, "Cannot initialize tables", e);
       throw e;
     }
@@ -50,11 +49,11 @@ public DiscordDatabaseHelper(@NotNull final Main plugin, @NotNull final SQLManag
     } else {
       settings.getSettings().put(feature, status);
     }
-    try(SQLQuery query = DiscordTables.DISCORD_PLAYERS.createQuery()
+    try(final SQLQuery query = DiscordTables.DISCORD_PLAYERS.createQuery()
             .setLimit(1)
             .addCondition("player", playerUuid)
             .build().execute();
-        ResultSet set = query.getResultSet()) {
+        final ResultSet set = query.getResultSet()) {
       final Integer integer;
       if(set.next()) {
         integer = DiscordTables.DISCORD_PLAYERS.createUpdate()
@@ -77,12 +76,12 @@ public DiscordDatabaseHelper(@NotNull final Main plugin, @NotNull final SQLManag
   public NotificationSettings getPlayerNotifactionSetting(@NotNull final UUID uuid) throws SQLException {
 
     Util.ensureThread(true);
-    try(SQLQuery query = DiscordTables.DISCORD_PLAYERS.createQuery().selectColumns("notifaction").addCondition("player",
-                                                                                                               uuid).setLimit(1).build().execute(); ResultSet set = query.getResultSet()) {
+    try(final SQLQuery query = DiscordTables.DISCORD_PLAYERS.createQuery().selectColumns("notifaction").addCondition("player",
+                                                                                                                     uuid).setLimit(1).build().execute(); final ResultSet set = query.getResultSet()) {
       if(set.next()) {
         final String json = set.getString("notifaction");
         Log.debug("Json data: " + json);
-        if(StringUtils.isNotEmpty(json)) {
+        if(!CommonUtil.isEmptyString(json)) {
           if(CommonUtil.isJson(json)) {
             return JsonUtil.getGson().fromJson(json, NotificationSettings.class);
           }
@@ -109,7 +108,7 @@ public boolean isNotifactionFeatureEnabled(@NotNull final UUID uuid, @NotNull fi
       final NotificationSettings settings = getPlayerNotifactionSetting(uuid);
       Log.debug("Notifaction Settings: " + settings);
       return settings.getSettings().getOrDefault(feature, defValue);
-    } catch(SQLException e) {
+    } catch(final SQLException e) {
       return defValue;
     }
   }

addon/discordsrv/src/main/java/com/ghostchu/quickshop/addon/discordsrv/message/MessageManager.java

@@ -2,9 +2,9 @@
 
 import com.ghostchu.quickshop.addon.discordsrv.Main;
 import com.ghostchu.quickshop.api.obj.QUser;
+import com.ghostchu.quickshop.common.util.CommonUtil;
 import github.scarsz.discordsrv.dependencies.jda.api.EmbedBuilder;
 import github.scarsz.discordsrv.dependencies.jda.api.entities.MessageEmbed;
-import org.apache.commons.lang3.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -46,7 +46,7 @@ private void scanClass(@Nullable final Object obj) {
         if(annotation == null) {
           continue;
         }
-        if(StringUtils.isEmpty(annotation.key())) {
+        if(CommonUtil.isEmptyString(annotation.key())) {
           continue;
         }
 
@@ -57,7 +57,7 @@ private void scanClass(@Nullable final Object obj) {
         } else {
           plugin.getLogger().warning("Skipping message " + obj.getClass().getName() + "." + declaredMethod.getName() + " for registering: Unsupported return type: " + declaredMethod.getReturnType().getName());
         }
-      } catch(Throwable e) {
+      } catch(final Throwable e) {
         plugin.getLogger().log(Level.WARNING, "Failed to register message: " + declaredMethod.getDeclaringClass().getName() + "." + declaredMethod.getName(), e);
       }
     }
@@ -76,12 +76,12 @@ public MessageEmbed getEmbedMessage(@NotNull final String key, @Nullable final Q
     }
     try {
       final Object returns = method.getValue().invoke(method.getKey(), receiver, placeholders);
-      if(!(returns instanceof MessageEmbed embed)) {
+      if(!(returns instanceof final MessageEmbed embed)) {
         plugin.getLogger().log(Level.WARNING, "Cannot handle embed message: " + key + " Mismatched type!");
         return failSafeEmbedMessage(key);
       }
       return embed;
-    } catch(IllegalAccessException | InvocationTargetException e) {
+    } catch(final IllegalAccessException | InvocationTargetException e) {
       plugin.getLogger().log(Level.WARNING, "Cannot handle embed message: " + key, e);
       return failSafeEmbedMessage(key);
     }
@@ -111,12 +111,12 @@ public String getRegularMessage(@NotNull final String key, @Nullable final UUID
     }
     try {
       final Object returns = method.getValue().invoke(method.getKey(), receiver, placeholders);
-      if(!(returns instanceof String msg)) {
+      if(!(returns instanceof final String msg)) {
         plugin.getLogger().log(Level.WARNING, "Cannot handle message: " + key + " Mismatched type!");
         return failSafeMessage(key);
       }
       return msg;
-    } catch(IllegalAccessException | InvocationTargetException e) {
+    } catch(final IllegalAccessException | InvocationTargetException e) {
       plugin.getLogger().log(Level.WARNING, "Cannot handle message: " + key, e);
       return failSafeMessage(key);
     }

addon/discordsrv/src/main/java/com/ghostchu/quickshop/addon/discordsrv/message/MessageRepository.java

@@ -3,10 +3,10 @@
 import com.ghostchu.quickshop.QuickShop;
 import com.ghostchu.quickshop.addon.discordsrv.parser.EmbedMessageParser;
 import com.ghostchu.quickshop.api.obj.QUser;
+import com.ghostchu.quickshop.common.util.CommonUtil;
 import github.scarsz.discordsrv.dependencies.jda.api.EmbedBuilder;
 import github.scarsz.discordsrv.dependencies.jda.api.entities.MessageEmbed;
 import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
-import org.apache.commons.lang3.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -44,7 +44,7 @@ private MessageEmbed applyPlaceHolders(@NotNull final MessageEmbed embed, @NotNu
 
     final EmbedBuilder builder = new EmbedBuilder(embed);
     for(final Map.Entry<String, String> entry : placeholders.entrySet()) {
-      if(StringUtils.isEmpty(entry.getValue())) {
+      if(CommonUtil.isEmptyString(entry.getValue())) {
         entry.setValue(ZERO_WIDTH_SPACE);
       }
     }

addon/discordsrv/src/main/java/com/ghostchu/quickshop/addon/discordsrv/parser/EmbedMessageParser.java

@@ -8,7 +8,6 @@
 import github.scarsz.discordsrv.dependencies.jda.api.entities.MessageEmbed;
 import lombok.Data;
 import lombok.NoArgsConstructor;
-import org.apache.commons.lang3.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -50,7 +49,7 @@ public MessageEmbed parse(@NotNull final String json) {
     if(dto.getThumbnail() != null) {
       builder.setThumbnail(emptyDefault(dto.getThumbnail().getUrl()));
     }
-    if(dto.getImage() != null && StringUtils.isNotBlank(dto.getImage().getUrl())) {
+    if(dto.getImage() != null && !CommonUtil.isBlank(dto.getImage().getUrl())) {
       builder.setImage(emptyDefault(dto.getImage().getUrl()));
     }
     if(dto.getAuthor() != null) {
@@ -62,10 +61,10 @@ public MessageEmbed parse(@NotNull final String json) {
         if(field != null && field.getName() != null && field.getValue() != null) {
           String fieldName = field.getName();
           String fieldValue = field.getValue();
-          if(StringUtils.isEmpty(fieldName)) {
+          if(CommonUtil.isEmptyString(fieldName)) {
             fieldName = ZERO_WIDTH_SPACE;
           }
-          if(StringUtils.isEmpty(fieldValue)) {
+          if(CommonUtil.isEmptyString(fieldValue)) {
             fieldValue = ZERO_WIDTH_SPACE;
           }
           builder.addField(fieldName, fieldValue, field.inline);
@@ -78,7 +77,7 @@ public MessageEmbed parse(@NotNull final String json) {
   @Nullable
   private String emptyDefault(@Nullable final String v) {
 
-    if(v == null || StringUtils.isBlank(v) || !v.startsWith("http")) {
+    if(v == null || CommonUtil.isBlank(v) || !v.startsWith("http")) {
       return null;
     }
     return v;

addon/discount/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>com.ghostchu</groupId>
         <artifactId>quickshop-hikari</artifactId>
-        <version>6.2.0.11-SNAPSHOT-1</version>
+        <version>6.2.0.11-SNAPSHOT-4</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <groupId>com.ghostchu.quickshop.addon</groupId>
@@ -49,8 +49,9 @@
 
     <dependencies>
         <dependency>
-            <groupId>org.spigotmc</groupId>
-            <artifactId>spigot-api</artifactId>
+            <groupId>io.papermc.paper</groupId>
+            <artifactId>paper-api</artifactId>
+            <version>${depend.paper}</version>
         </dependency>
         <dependency>
             <groupId>com.ghostchu</groupId>
@@ -59,11 +60,11 @@
             <scope>provided</scope>
         </dependency>
         <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
-        <dependency>
+        <!--<dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>
             <version>${depend.commons.lang3}</version>
             <scope>provided</scope>
-        </dependency>
+        </dependency>-->
     </dependencies>
 </project>