Add OpenPlayerSaveEvent

Closes #156

api/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <artifactId>openinvparent</artifactId>
     <groupId>com.lishid</groupId>
-    <version>4.3.2-SNAPSHOT</version>
+    <version>4.4.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>openinvapi</artifactId>

api/src/main/java/com/lishid/openinv/event/OpenPlayerSaveEvent.java

@@ -0,0 +1,74 @@
+package com.lishid.openinv.event;
+
+import com.lishid.openinv.internal.ISpecialInventory;
+import org.bukkit.entity.Player;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Event fired before OpenInv saves a player's data.
+ */
+public class OpenPlayerSaveEvent extends Event implements Cancellable {
+
+  private static final HandlerList HANDLERS = new HandlerList();
+
+  private final Player player;
+  private final ISpecialInventory inventory;
+  private boolean cancelled = false;
+
+  public OpenPlayerSaveEvent(@NotNull Player player, @NotNull ISpecialInventory inventory) {
+    this.player = player;
+    this.inventory = inventory;
+  }
+
+  /**
+   * Get the {@link Player} whose data is being saved.
+   *
+   * @return player the Player whose data is being saved
+   */
+  public @NotNull Player getPlayer() {
+    return player;
+  }
+
+  /**
+   * Get the {@link ISpecialInventory} that triggered the save by being closed.
+   *
+   * @return the special inventory
+   */
+  public @NotNull ISpecialInventory getInventory() {
+    return inventory;
+  }
+
+  /**
+   * Get whether the event is cancelled.
+   *
+   * @return true if the event is cancelled
+   */
+  @Override
+  public boolean isCancelled() {
+    return cancelled;
+  }
+
+  /**
+   * Set whether the event is cancelled.
+   *
+   * @param cancel whether the event is cancelled
+   */
+  @Override
+  public void setCancelled(boolean cancel) {
+    this.cancelled = cancel;
+  }
+
+  @NotNull
+  @Override
+  public HandlerList getHandlers() {
+    return HANDLERS;
+  }
+
+  public static HandlerList getHandlerList() {
+    return HANDLERS;
+  }
+
+}

assembly/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>com.lishid</groupId>
     <artifactId>openinvparent</artifactId>
-    <version>4.3.2-SNAPSHOT</version>
+    <version>4.4.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>openinvassembly</artifactId>

internal/v1_19_R3/pom.xml

@@ -23,7 +23,7 @@
     <artifactId>openinvparent</artifactId>
     <groupId>com.lishid</groupId>
     <relativePath>../../pom.xml</relativePath>
-    <version>4.3.2-SNAPSHOT</version>
+    <version>4.4.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>openinvadapter1_19_R3</artifactId>

internal/v1_20_R1/pom.xml

@@ -23,7 +23,7 @@
     <artifactId>openinvparent</artifactId>
     <groupId>com.lishid</groupId>
     <relativePath>../../pom.xml</relativePath>
-    <version>4.3.2-SNAPSHOT</version>
+    <version>4.4.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>openinvadapter1_20_R1</artifactId>

plugin/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <artifactId>openinvparent</artifactId>
     <groupId>com.lishid</groupId>
-    <version>4.3.2-SNAPSHOT</version>
+    <version>4.4.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>openinvplugincore</artifactId>

plugin/src/main/java/com/lishid/openinv/InventoryListener.java

@@ -63,11 +63,11 @@ record InventoryListener(OpenInv plugin) implements Listener {
 
         ISpecialInventory specialInventory = InventoryAccess.getEnderChest(event.getInventory());
         if (specialInventory != null) {
-            this.plugin.handleCloseInventory(event.getPlayer(), specialInventory);
+            this.plugin.handleCloseInventory(specialInventory);
         } else {
             specialInventory = InventoryAccess.getPlayerInventory(event.getInventory());
             if (specialInventory != null) {
-                this.plugin.handleCloseInventory(event.getPlayer(), specialInventory);
+                this.plugin.handleCloseInventory(specialInventory);
             }
         }
     }

plugin/src/main/java/com/lishid/openinv/OpenInv.java

@@ -23,6 +23,7 @@ import com.lishid.openinv.commands.OpenInvCommand;
 import com.lishid.openinv.commands.SearchContainerCommand;
 import com.lishid.openinv.commands.SearchEnchantCommand;
 import com.lishid.openinv.commands.SearchInvCommand;
+import com.lishid.openinv.event.OpenPlayerSaveEvent;
 import com.lishid.openinv.internal.IAnySilentContainer;
 import com.lishid.openinv.internal.ISpecialEnderChest;
 import com.lishid.openinv.internal.ISpecialInventory;
@@ -544,7 +545,7 @@ public class OpenInv extends JavaPlugin implements IOpenInv {
         }
     }
 
-    void handleCloseInventory(@NotNull HumanEntity exViewer, @NotNull ISpecialInventory inventory) {
+    void handleCloseInventory(@NotNull ISpecialInventory inventory) {
         Map<UUID, ? extends ISpecialInventory> map = inventory instanceof ISpecialPlayerInventory ? inventories : enderChests;
         UUID key = inventory.getPlayer().getUniqueId();
         @Nullable ISpecialInventory loaded = map.get(key);
@@ -576,11 +577,18 @@ public class OpenInv extends JavaPlugin implements IOpenInv {
             // Re-fetch from map - prevents duplicate saves on multi-close.
             ISpecialInventory current = map.remove(key);
 
-            if (!disableSaving()
-                    && current != null
-                    && current.getPlayer() instanceof Player player
-                    && !player.isOnline()) {
-                    this.accessor.getPlayerDataManager().inject(player).saveData();
+            if (disableSaving()
+                || current == null
+                || !(current.getPlayer() instanceof Player player)
+                || player.isOnline()) {
+                return;
+            }
+
+            OpenPlayerSaveEvent event = new OpenPlayerSaveEvent(player, current);
+            getServer().getPluginManager().callEvent(event);
+
+            if (!event.isCancelled()) {
+                this.accessor.getPlayerDataManager().inject(player).saveData();
             }
         });
     }

pom.xml

@@ -21,7 +21,7 @@
   <artifactId>openinvparent</artifactId>
   <name>OpenInv</name>
   <url>http://dev.bukkit.org/bukkit-plugins/openinv/</url>
-  <version>4.3.2-SNAPSHOT</version>
+  <version>4.4.0-SNAPSHOT</version>
 
   <packaging>pom</packaging>
 
@@ -84,13 +84,13 @@
         <artifactId>openinvapi</artifactId>
         <groupId>com.lishid</groupId>
         <scope>compile</scope>
-        <version>4.3.2-SNAPSHOT</version>
+        <version>4.4.0-SNAPSHOT</version>
       </dependency>
       <dependency>
         <artifactId>openinvplugincore</artifactId>
         <groupId>com.lishid</groupId>
         <scope>compile</scope>
-        <version>4.3.2-SNAPSHOT</version>
+        <version>4.4.0-SNAPSHOT</version>
         <exclusions>
           <exclusion>
             <groupId>com.lishid</groupId>