feat: add player quit event handling to close viewer context (#810)

Co-authored-by: Natan <[email protected]>

Author: mtbarr

inventory-framework-platform-bukkit/src/main/java/me/devnatan/inventoryframework/IFInventoryListener.java

@@ -16,6 +16,7 @@
 import org.bukkit.event.inventory.InventoryType;
 import org.bukkit.event.player.PlayerDropItemEvent;
 import org.bukkit.event.player.PlayerPickupItemEvent;
+import org.bukkit.event.player.PlayerQuitEvent;
 import org.bukkit.event.server.PluginDisableEvent;
 import org.bukkit.inventory.Inventory;
 import org.bukkit.inventory.PlayerInventory;
@@ -35,28 +36,51 @@ public void onPluginDisable(final PluginDisableEvent event) {
         viewFrame.unregister();
     }
 
-    @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true)
-    public void onInventoryClick(final InventoryClickEvent event) {
-        if (!(event.getWhoClicked() instanceof Player)) return;
-
-        final Player player = (Player) event.getWhoClicked();
+    @EventHandler
+    public void onPlayerQuit(PlayerQuitEvent event) {
+        final Player player = (Player) event.getPlayer();
         final Viewer viewer = viewFrame.getViewer(player);
         if (viewer == null) return;
 
-        final IFRenderContext context = viewer.getActiveContext();
-        final Component clickedComponent = context.getComponentsAt(event.getRawSlot()).stream()
-                .filter(Component::isVisible)
-                .findFirst()
-                .orElse(null);
-        final ViewContainer clickedContainer = event.getClickedInventory() instanceof PlayerInventory
-                ? viewer.getSelfContainer()
-                : context.getContainer();
-
+        final IFRenderContext context = viewer.getCurrentContext();
         final RootView root = context.getRoot();
-        final IFSlotClickContext clickContext = root.getElementFactory()
-                .createSlotClickContext(event.getRawSlot(), viewer, clickedContainer, clickedComponent, event, false);
+        final IFCloseContext closeContext = root.getElementFactory().createCloseContext(viewer, context, event);
 
-        root.getPipeline().execute(StandardPipelinePhases.CLICK, clickContext);
+        root.getPipeline().execute(StandardPipelinePhases.CLOSE, closeContext);
+    }
+
+    @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true)
+    public void onInventoryClick(final InventoryClickEvent event) {
+        if (!(event.getWhoClicked() instanceof Player)) return;
+
+        final Player player = (Player) event.getWhoClicked();
+        try {
+            final Viewer viewer = viewFrame.getViewer(player);
+            if (viewer == null) return;
+
+            final IFRenderContext context = viewer.getActiveContext();
+            final Component clickedComponent = context.getComponentsAt(event.getRawSlot()).stream()
+                    .filter(Component::isVisible)
+                    .findFirst()
+                    .orElse(null);
+            final ViewContainer clickedContainer = event.getClickedInventory() instanceof PlayerInventory
+                    ? viewer.getSelfContainer()
+                    : context.getContainer();
+
+            final RootView root = context.getRoot();
+            final IFSlotClickContext clickContext = root.getElementFactory()
+                    .createSlotClickContext(
+                            event.getRawSlot(), viewer, clickedContainer, clickedComponent, event, false);
+
+            root.getPipeline().execute(StandardPipelinePhases.CLICK, clickContext);
+        } catch (Exception e) {
+            // TODO custom error handling to customize on error behavior
+            viewFrame
+                    .getOwner()
+                    .getLogger()
+                    .severe("An error occurred while processing an inventory click event: " + e.getMessage());
+            player.closeInventory();
+        }
     }
 
     @SuppressWarnings("unused")

inventory-framework-platform/src/main/java/me/devnatan/inventoryframework/PlatformView.java

@@ -11,7 +11,12 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Function;
 import java.util.function.Supplier;
-import me.devnatan.inventoryframework.component.*;
+
+import me.devnatan.inventoryframework.component.ComponentFactory;
+import me.devnatan.inventoryframework.component.ItemComponentBuilder;
+import me.devnatan.inventoryframework.component.Pagination;
+import me.devnatan.inventoryframework.component.PaginationStateBuilder;
+import me.devnatan.inventoryframework.component.PaginationValueConsumer;
 import me.devnatan.inventoryframework.context.IFCloseContext;
 import me.devnatan.inventoryframework.context.IFConfinedContext;
 import me.devnatan.inventoryframework.context.IFContext;
@@ -70,6 +75,7 @@ protected PlatformView() {
     }
 
     // region Open & Close
+
     /**
      * Closes all contexts that are currently active in this view.
      */
@@ -111,32 +117,38 @@ final String open(List<Viewer> viewers, Object initialData) {
     /**
      * Opens an already active context to a viewer.
      *
-     * @param contextId The id of the context.
-     * @param viewer The viewer to open the context to.
+     * @param contextId   The id of the context.
+     * @param viewer      The viewer to open the context to.
      * @param initialData Initial data.
      */
     @SuppressWarnings("unchecked")
     final void open(String contextId, Viewer viewer, Object initialData) {
-        IFRenderContext targetContext = null;
-        for (final IFContext context : getInternalContexts()) {
-            if (context.getId().toString().equals(contextId)) {
-                targetContext = (IFRenderContext) context;
-                break;
+        try {
+            IFRenderContext targetContext = null;
+            for (final IFContext context : getInternalContexts()) {
+                if (context.getId().toString().equals(contextId)) {
+                    targetContext = (IFRenderContext) context;
+                    break;
+                }
             }
-        }
 
-        if (targetContext == null) throw new IllegalArgumentException("Context not found: " + contextId);
-        if (!targetContext.isActive()) throw new IllegalStateException("Invalidated");
-
-        viewer.setActiveContext(targetContext);
-        onViewerAdded((TContext) targetContext, (TViewer) viewer.getPlatformInstance(), initialData);
-        targetContext.addViewer(viewer);
-        getFramework().addViewer(viewer);
-        viewer.open(targetContext.getContainer());
+            if (targetContext == null) throw new IllegalArgumentException("Context not found: " + contextId);
+            if (!targetContext.isActive()) throw new IllegalStateException("Invalidated");
+
+            viewer.setActiveContext(targetContext);
+            onViewerAdded((TContext) targetContext, (TViewer) viewer.getPlatformInstance(), initialData);
+            targetContext.addViewer(viewer);
+            getFramework().addViewer(viewer);
+            viewer.open(targetContext.getContainer());
+        } catch (Exception e) {
+            viewer.close();
+            e.printStackTrace(); // todo use custom error handler
+        }
     }
     // endregion
 
     // region Navigation
+
     /**
      * <p><b><i>This is an internal inventory-framework API that should not be used from outside of
      * this library. No compatibility guarantees are provided.</i></b>
@@ -236,6 +248,7 @@ public final void back(@NotNull Viewer viewer, Object initialData) {
     }
 
     // region Contexts
+
     /**
      * Returns the context that is linked to the specified viewer in this view.
      * <p>
@@ -387,14 +400,15 @@ public final Iterator<TContext> iterator() {
     }
 
     // region Refs API
+
     /**
      * Creates a new unassigned reference instance.
      * <p>
      * <b><i> This API is experimental and is not subject to the general compatibility guarantees
      * such API may be changed or may be removed completely in any further release. </i></b>
      *
-     * @return A new unassigned {@link Ref} instance.
      * @param <E> Type of the element hold by this reference.
+     * @return A new unassigned {@link Ref} instance.
      * @see <a href="https://github.com/DevNatan/inventory-framework/wiki/refs-api">Refs API on Wiki</a>
      */
     @ApiStatus.Experimental
@@ -408,8 +422,8 @@ protected final <E> Ref<E> ref() {
      * <b><i> This API is experimental and is not subject to the general compatibility guarantees
      * such API may be changed or may be removed completely in any further release. </i></b>
      *
-     * @return A new unassigned {@link Ref} instance.
      * @param <E> Type of the element hold by this reference.
+     * @return A new unassigned {@link Ref} instance.
      * @see <a href="https://github.com/DevNatan/inventory-framework/wiki/refs-api">Refs API on Wiki</a>
      */
     @ApiStatus.Experimental
@@ -419,6 +433,7 @@ protected final <E> Ref<List<E>> multiRefs() {
     // endregion
 
     // region Public Platform Handlers
+
     /**
      * Called when the view is about to be configured, the returned object will be the view's
      * configuration.
@@ -516,9 +531,9 @@ public void onResume(@NotNull TContext origin, @NotNull TContext target) {}
      * <b><i> This API is experimental and is not subject to the general compatibility guarantees
      * such API may be changed or may be removed completely in any further release. </i></b>
      *
-     * @param context 	The context.
-     * @param viewer 	Who was added to the context.
-     * @param data    	Initial data set wen the viewer was added.
+     * @param context The context.
+     * @param viewer  Who was added to the context.
+     * @param data    Initial data set wen the viewer was added.
      */
     @ApiStatus.OverrideOnly
     @ApiStatus.Experimental
@@ -533,14 +548,15 @@ public void onViewerAdded(@NotNull TContext context, @NotNull TViewer viewer, Ob
      * such API may be changed or may be removed completely in any further release. </i></b>
      *
      * @param context The context.
-     * @param viewer Who was removed from the context.
+     * @param viewer  Who was removed from the context.
      */
     @ApiStatus.OverrideOnly
     @ApiStatus.Experimental
     public void onViewerRemoved(@NotNull TContext context, @NotNull TViewer viewer) {}
     // endregion
 
     // region Internals
+
     /**
      * <p><b><i>This is an internal inventory-framework API that should not be used from outside of
      * this library. No compatibility guarantees are provided.</i></b>