GH-58 Add basic Parcel locker business logic

README.md

@@ -45,8 +45,14 @@ more.
 - [ ] Add translation system, more languages
 - [ ] Add delivery codes, so any person knowing the code can pick up the parcel
 - [ ] Add delivery time, so the parcel can be picked up only in a specific time
+- [ ] Parcel permissions for user
+- [ ] Parcel return logic
+- [ ] Banned parcel items (configurable)
+- [ ] Parcel fee
 - [ ] Rewrite database to ORMLite (far in future)
 - [ ] Add "business" logic
+- [ ] Add more parcel types (fragile, etc...)
+- [ ] Add option to config for parcel locker space (e.g. max parcels within a locker)
 - [ ] Rewrite Position class to use Integers instead of Doubles 
 - [ ] Finish GUIs
 - [ ] Add more GUIs (admin GUI, parcel create GUI, etc.)

build.gradle.kts

@@ -29,7 +29,7 @@ repositories {
 
 dependencies {
     // minecraft development api
-    compileOnly("org.spigotmc:spigot-api:1.20.1-experimental-SNAPSHOT")
+    compileOnly("org.spigotmc:spigot-api:1.20.1-R0.1-SNAPSHOT")
     implementation("net.kyori:adventure-platform-bukkit:4.3.0")
     implementation("net.kyori:adventure-text-minimessage:4.14.0")
     implementation("dev.rollczi.litecommands:bukkit-adventure:2.8.9")
@@ -40,6 +40,9 @@ dependencies {
     // gui library
     implementation("dev.triumphteam:triumph-gui:3.1.5")
 
+    // economy
+    compileOnly("com.github.MilkBowl:VaultAPI:1.7.1")
+
     // CDN
     implementation("net.dzikoysk:cdn:1.14.4")
 
@@ -104,6 +107,8 @@ bukkit {
         "Plugin that provides functionality of parcel lockers in Minecraft, allowing players to send and receive parcels safely."
     website = "https://github.com/EternalCodeTeam/ParcelLockers"
     version = "1.0.0-SNAPSHOT"
+    depend = listOf("Vault")
+    loadBefore = listOf("Vault")
 }
 
 tasks.withType<JavaCompile> {

src/main/java/com/eternalcode/parcellockers/ParcelLockerCommand.java

@@ -7,7 +7,10 @@
 import dev.rollczi.litecommands.command.execute.Execute;
 import dev.rollczi.litecommands.command.permission.Permission;
 import dev.rollczi.litecommands.command.route.Route;
+import net.kyori.adventure.text.minimessage.MiniMessage;
 import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.ItemStack;
 
 @Route(name = "parcellockers", aliases = {"parcellocker"})
 @Permission("parcellockers.admin")
@@ -16,11 +19,13 @@ public class ParcelLockerCommand {
     private final ConfigurationManager configManager;
     private final PluginConfiguration config;
     private final NotificationAnnouncer announcer;
+    private final MiniMessage miniMessage;
 
-    public ParcelLockerCommand(ConfigurationManager configManager, PluginConfiguration config, NotificationAnnouncer announcer) {
+    public ParcelLockerCommand(ConfigurationManager configManager, PluginConfiguration config, NotificationAnnouncer announcer, MiniMessage miniMessage) {
         this.configManager = configManager;
         this.config = config;
         this.announcer = announcer;
+        this.miniMessage = miniMessage;
     }
 
     @Async
@@ -30,4 +35,10 @@ void reload(CommandSender sender) {
         this.announcer.sendMessage(sender, this.config.messages.reload);
     }
 
+    @Execute(route = "give")
+    void give(Player player) {
+        ItemStack parcelItem = this.config.settings.parcelLockerItem.toGuiItem(this.miniMessage).getItemStack();
+        player.getInventory().addItem(parcelItem);
+    }
+
 }

src/main/java/com/eternalcode/parcellockers/ParcelLockers.java

@@ -7,6 +7,9 @@
 import com.eternalcode.parcellockers.command.handler.PermissionMessage;
 import com.eternalcode.parcellockers.configuration.ConfigurationManager;
 import com.eternalcode.parcellockers.configuration.implementation.PluginConfiguration;
+import com.eternalcode.parcellockers.controller.ParcelLockerBreakController;
+import com.eternalcode.parcellockers.controller.ParcelLockerInteractionController;
+import com.eternalcode.parcellockers.controller.ParcelLockerPlaceController;
 import com.eternalcode.parcellockers.database.DataSourceFactory;
 import com.eternalcode.parcellockers.database.ParcelDatabaseService;
 import com.eternalcode.parcellockers.database.ParcelLockerDatabaseService;
@@ -16,7 +19,6 @@
 import com.eternalcode.parcellockers.parcel.Parcel;
 import com.eternalcode.parcellockers.parcel.ParcelManager;
 import com.eternalcode.parcellockers.parcellocker.ParcelLockerManager;
-import com.eternalcode.parcellockers.parcellocker.repository.ParcelLockerRepository;
 import com.eternalcode.parcellockers.updater.UpdaterService;
 import com.eternalcode.parcellockers.util.legacy.LegacyColorProcessor;
 import com.google.common.base.Stopwatch;
@@ -29,22 +31,27 @@
 import io.sentry.Sentry;
 import net.kyori.adventure.platform.bukkit.BukkitAudiences;
 import net.kyori.adventure.text.minimessage.MiniMessage;
+import net.milkbowl.vault.economy.Economy;
 import org.bstats.bukkit.Metrics;
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
+import org.bukkit.plugin.RegisteredServiceProvider;
 import org.bukkit.plugin.java.JavaPlugin;
 
 import java.util.Arrays;
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import java.util.stream.Stream;
 
 public final class ParcelLockers extends JavaPlugin {
 
     private LiteCommands<CommandSender> liteCommands;
 
     private BukkitAudiences audiences;
 
+    private Economy economy;
+
     @Override
     public void onEnable() {
         Stopwatch started = Stopwatch.createStarted();
@@ -74,27 +81,41 @@ public void onEnable() {
 
         HikariDataSource dataSource = DataSourceFactory.buildHikariDataSource(config, this.getDataFolder());
 
-        ParcelLockerRepository parcelLockerRepository = new ParcelLockerDatabaseService(dataSource);
+        ParcelLockerDatabaseService parcelLockerDatabaseService = new ParcelLockerDatabaseService(dataSource);
+        parcelLockerDatabaseService.updatePositionCache();
+
         ParcelDatabaseService parcelRepository = new ParcelDatabaseService(dataSource);
 
-        ParcelManager parcelManager = new ParcelManager(this, config, announcer, parcelRepository, parcelLockerRepository);
-        ParcelLockerManager parcelLockerManager = new ParcelLockerManager(parcelLockerRepository);
-
-        MainGUI mainGUI = new MainGUI(this, this.getServer(), miniMessage, config, parcelRepository, parcelLockerRepository);
-        ParcelListGUI parcelListGUI = new ParcelListGUI(this, this.getServer(), miniMessage, config, parcelRepository, parcelLockerRepository, mainGUI);
+        ParcelManager parcelManager = new ParcelManager(this, config, announcer, parcelRepository, parcelLockerDatabaseService);
+        ParcelLockerManager parcelLockerManager = new ParcelLockerManager(parcelLockerDatabaseService);
 
+        MainGUI mainGUI = new MainGUI(this, this.getServer(), miniMessage, config, parcelRepository, parcelLockerDatabaseService);
+        ParcelListGUI parcelListGUI = new ParcelListGUI(this, miniMessage, config, parcelRepository, parcelLockerDatabaseService, mainGUI);
+
         this.liteCommands = LiteBukkitAdventurePlatformFactory.builder(this.getServer(), "parcellockers", false, this.audiences, true)
                 .argument(Parcel.class, new ParcelArgument(parcelRepository))
                 .argument(Player.class, new PlayerArgument(this.getServer(), config))
                 .contextualBind(Player.class, new BukkitOnlyPlayerContextual<>(config.messages.onlyForPlayers))
                 .commandInstance(
-                        new ParcelCommand(this.getServer(), parcelLockerRepository, announcer, config, mainGUI, parcelListGUI, parcelManager),
-                        new ParcelLockerCommand(configManager, config, announcer)
+                        new ParcelCommand(this.getServer(), parcelLockerDatabaseService, announcer, config, mainGUI, parcelListGUI, parcelManager),
+                        new ParcelLockerCommand(configManager, config, announcer, miniMessage)
                 )
                 .invalidUsageHandler(new InvalidUsage(announcer, config))
                 .permissionHandler(new PermissionMessage(announcer, config))
                 .register();
 
+        if (!this.setupEconomy()) {
+            this.getLogger().severe("Disabling due to no Vault dependency found!");
+            this.getServer().getPluginManager().disablePlugin(this);
+            return;
+        }
+
+        Stream.of(
+            new ParcelLockerInteractionController(parcelLockerDatabaseService, miniMessage, config),
+            new ParcelLockerPlaceController(config, miniMessage, this, parcelLockerDatabaseService, announcer),
+            new ParcelLockerBreakController(parcelLockerDatabaseService, announcer, config.messages)
+        ).forEach(controller -> this.getServer().getPluginManager().registerEvents(controller, this));
+
         new Metrics(this, 17677);
         new UpdaterService(this.getDescription());
 
@@ -132,6 +153,24 @@ private void softwareCheck() {
         logger.info("Your server is running on supported software, congratulations!");
         logger.info("Server version: " + this.getServer().getVersion());
     }
+
+    private boolean setupEconomy() {
+        if (this.getServer().getPluginManager().getPlugin("Vault") == null) {
+            return false;
+        }
+
+        RegisteredServiceProvider<Economy> rsp = this.getServer().getServicesManager().getRegistration(Economy.class);
+        if (rsp == null) {
+            return false;
+        }
+
+        this.economy = rsp.getProvider();
+        return true;
+    }
+
+    public Economy getEconomy() {
+        return this.economy;
+    }
 }
 
 

src/main/java/com/eternalcode/parcellockers/configuration/implementation/ConfigItem.java

@@ -28,6 +28,7 @@ public GuiItem toGuiItem(MiniMessage miniMessage, GuiAction<InventoryClickEvent>
             .lore(this.lore.stream().map(element -> RESET_ITEM.append(miniMessage.deserialize(element))).toList())
             .flags(ItemFlag.HIDE_ATTRIBUTES)
             .flags(ItemFlag.HIDE_ENCHANTS)
+            .glow(this.glow)
             .asGuiItem(action);
     }
 

src/main/java/com/eternalcode/parcellockers/configuration/implementation/PluginConfiguration.java

@@ -57,6 +57,21 @@ public static class Settings {
 
         @Description({" ", "# The database password."})
         public String password = "";
+
+        @Description({" ", "# The parcel locker item."})
+        public ConfigItem parcelLockerItem = new ConfigItem()
+                .setName("&3Parcel locker")
+                .setType(Material.CHEST)
+                .setLore(List.of("&bPlace to create a parcel locker."));
+
+        @Description({" ", "# Small parcel cost."})
+        public double smallParcelCost = 5.0;
+
+        @Description({" ", "# Medium parcel cost."})
+        public double mediumParcelCost = 10.0;
+
+        @Description({" ", "# Large parcel cost."})
+        public double largeParcelCost = 15.0;
     }
 
     @Contextual
@@ -71,7 +86,12 @@ public static class Messages {
         public String failedToCreateParcel = "&7» &cAn error occurred while creating the parcel.";
         public String parcelSuccessfullyDeleted = "&7» &aParcel deleted successfully.";
         public String failedToDeleteParcel = "&7» &cAn error occurred while deleting the parcel.";
-
+        public String failedToCreateParcelLocker = "&7» &cCould not create the parcel locker.";
+        public String parcelLockerSuccessfullyCreated = "&7» &aParcel locker created successfully.";
+        public String enterDescriptionPrompt = "&7» &6Enter a description for the parcel locker:";
+        public String cannotBreakParcelLocker = "&7» &cYou have no permission to break the parcel locker.";
+        public String parcelLockerSuccessfullyDeleted = "&7» &aParcel locker deleted successfully.";
+        public String broadcastParcelLockerRemoved = "&7» &a&lWARNING! &r&4The parcel locker at &c{X} {Y} {Z} in world {WORLD} &4has been removed by &4{PLAYER}!";
         @Description({" ", "# The parcel info message."})
         public List<String> parcelInfoMessages = List.of(
             "&7» &6Parcel info:",
@@ -98,6 +118,36 @@ public static class GuiSettings {
         @Description({" ", "# The item of the sent parcels GUI"})
         public String sentParcelsTitle = "&6Sent parcels";
 
+        @Description({" ", "# The item of the parcel locker main GUI"})
+        public String parcelLockerMainGuiTitle = "&3Parcel locker";
+
+        @Description({" ", "# The item of the parcel locker sending GUI"})
+        public String parcelLockerSendingGuiTitle = "&3Parcel sending";
+
+        @Description({" ", "# The item of the small parcel size button"})
+        public ConfigItem smallParcelSizeItem = new ConfigItem()
+                .setName("&aSmall")
+                .setLore(List.of("&bClick to select the small parcel size."))
+                .setType(Material.LIME_STAINED_GLASS);
+
+        @Description({" ", "# The item of the medium parcel size button"})
+        public ConfigItem mediumParcelSizeItem = new ConfigItem()
+                .setName("&eMedium")
+                .setLore(List.of("&bClick to select the medium parcel size."))
+                .setType(Material.YELLOW_STAINED_GLASS);
+
+        @Description({" ", "# The item of the large parcel size button"})
+        public ConfigItem largeParcelSizeItem = new ConfigItem()
+                .setName("&cLarge")
+                .setLore(List.of("&bClick to select the large parcel size."))
+                .setType(Material.RED_STAINED_GLASS);
+
+        @Description({" ", "# The item of the priority button"})
+        public ConfigItem priorityItem = new ConfigItem()
+                .setName("&aPriority")
+                .setLore(List.of("&bClick to select the priority."))
+                .setType(Material.REDSTONE);
+
         @Description({" ", "# The close button item"})
         public ConfigItem closeItem = new ConfigItem()
                 .setName("&cClose")
@@ -135,6 +185,27 @@ public static class GuiSettings {
                 .setLore(List.of("&eClick to show all parcels, which you sent or received in the past."))
                 .setType(Material.WRITTEN_BOOK);
 
+        @Description({" ", "# The item of the parcel locker collect button"})
+        public ConfigItem parcelLockerCollectItem = new ConfigItem()
+                .setName("&aCollect parcels")
+                .setLore(List.of("&aClick to collect your parcels."))
+                .setType(Material.HOPPER)
+                .setGlow(true);
+
+        @Description({" ", "# The item of the parcel locker send button"})
+        public ConfigItem parcelLockerSendItem = new ConfigItem()
+                .setName("&bSend parcels")
+                .setLore(List.of("&bClick to send parcels."))
+                .setType(Material.SCULK_SHRIEKER)
+                .setGlow(true);
+
+        @Description({" ", "# The item of the parcel locker status button"})
+        public ConfigItem parcelLockerStatusItem = new ConfigItem()
+                .setName("&3Parcel locker status")
+                .setLore(List.of("&bClick to show the status of your parcel locker."))
+                .setType(Material.END_PORTAL_FRAME)
+                .setGlow(true);
+
         @Description({" ", "# The item of the parcel"})
         public ConfigItem parcelItem = new ConfigItem()
                 .setName("&6{NAME}")
@@ -151,6 +222,12 @@ public static class GuiSettings {
                 )
                 .setType(Material.CHEST_MINECART);
 
+        @Description({" ", "# The item of the parcel item storage button"})
+        public ConfigItem parcelStorageItem = new ConfigItem()
+            .setName("&6Parcel storage")
+            .setLore(List.of("&eClick to edit the parcel content."))
+            .setType(Material.CHEST);
+
         @Description({" ", "# The item of the previous page button"})
         public ConfigItem previousPageItem = new ConfigItem()
                 .setName("&bPrevious page")
@@ -162,6 +239,27 @@ public static class GuiSettings {
                 .setName("&bNext page")
                 .setLore(List.of("&bClick to go to the next page."))
                 .setType(Material.ARROW);
+
+        @Description({" ", "# The item of the confirm items button"})
+        public ConfigItem confirmItemsItem = new ConfigItem()
+                .setName("&aConfirm items")
+                .setLore(List.of("&aClick to confirm the items."))
+                .setType(Material.LIME_WOOL);
+
+        @Description({" ", "# The item of the cancel items button"})
+        public ConfigItem cancelItemsItem = new ConfigItem()
+                .setName("&cCancel items")
+                .setLore(List.of("&cClick to cancel the items."))
+                .setType(Material.RED_WOOL);
+
+        @Description({" ", "# The name of the parcel small content GUI"})
+        public String parcelSmallContentGuiTitle = "&aSmall parcel content";
+
+        @Description({" ", "# The name of the parcel medium content GUI"})
+        public String parcelMediumContentGuiTitle = "&eMedium parcel content";
+
+        @Description({" ", "# The name of the parcel large content GUI"})
+        public String parcelLargeContentGuiTitle = "&cLarge parcel content";
     }
 
     @Override