refactor: allow multiple containers within a single container block e…

…ntity
refinedmods · Apr 5, 2024 · ead7eed · ead7eed
1 parent 22b47e4
commit ead7eed
Show file tree

Hide file tree

Showing 47 changed files with 533 additions and 355 deletions.
diff --git a/...src/main/java/com/refinedmods/refinedstorage2/api/network/node/GraphNetworkComponent.java b/...src/main/java/com/refinedmods/refinedstorage2/api/network/node/GraphNetworkComponent.java
@@ -29,7 +29,7 @@ public interface GraphNetworkComponent extends NetworkComponent {
     <T> Set<T> getContainers(Class<T> clazz);
 
     /**
-     * Retrieves a container by key, defined in {@link NetworkNodeContainer#createKey()}.
+     * Retrieves a container by key, defined in {@link NetworkNodeContainer#getKey()}.
      *
      * @param key the key
      * @return the container, or null if not found

diff --git a/...java/com/refinedmods/refinedstorage2/api/network/node/container/NetworkNodeContainer.java b/...java/com/refinedmods/refinedstorage2/api/network/node/container/NetworkNodeContainer.java
@@ -1,6 +1,5 @@
 package com.refinedmods.refinedstorage2.api.network.node.container;
 
-import com.refinedmods.refinedstorage2.api.network.node.GraphNetworkComponent;
 import com.refinedmods.refinedstorage2.api.network.node.NetworkNode;
 
 import javax.annotation.Nullable;
@@ -18,12 +17,13 @@ public interface NetworkNodeContainer {
      * The key must be kept stable, and must stay the same for the lifetime of the container.
      * If it changes after adding it into the graph, the container would not be removed from the key index when the
      * container is removed!
-     * The container can be queried by {@link GraphNetworkComponent#getContainer(Object)}.
+     * The container can be queried by
+     * {@link com.refinedmods.refinedstorage2.api.network.node.GraphNetworkComponent#getContainer(Object)}.
      *
      * @return the key, or null if indexing is not required
      */
     @Nullable
-    default Object createKey() {
+    default Object getKey() {
         return null;
     }
 

diff --git a/...java/com/refinedmods/refinedstorage2/api/network/impl/node/GraphNetworkComponentImpl.java b/...java/com/refinedmods/refinedstorage2/api/network/impl/node/GraphNetworkComponentImpl.java
@@ -58,7 +58,7 @@ public void onContainerRemoved(final NetworkNodeContainer container) {
     }
 
     private void addToIndex(final NetworkNodeContainer container) {
-        final Object key = container.createKey();
+        final Object key = container.getKey();
         if (key != null) {
             byKeyIndex.put(key, container);
         }
@@ -74,7 +74,7 @@ private void addToIndex(final Class<?> indexKey, final NetworkNodeContainer cont
     }
 
     private void removeFromIndex(final NetworkNodeContainer container) {
-        final Object key = container.createKey();
+        final Object key = container.getKey();
         if (key != null) {
             byKeyIndex.remove(key);
         }

diff --git a/.../com/refinedmods/refinedstorage2/api/network/impl/node/GraphNetworkComponentImplTest.java b/.../com/refinedmods/refinedstorage2/api/network/impl/node/GraphNetworkComponentImplTest.java
@@ -213,7 +213,7 @@ public NetworkNode getNode() {
             }
 
             @Override
-            public Object createKey() {
+            public Object getKey() {
                 return "key0";
             }
         };
@@ -225,7 +225,7 @@ public NetworkNode getNode() {
             }
 
             @Override
-            public Object createKey() {
+            public Object getKey() {
                 return "key1";
             }
         };
@@ -252,7 +252,7 @@ public NetworkNode getNode() {
             }
 
             @Override
-            public Object createKey() {
+            public Object getKey() {
                 return "key0";
             }
         };
@@ -264,7 +264,7 @@ public NetworkNode getNode() {
             }
 
             @Override
-            public Object createKey() {
+            public Object getKey() {
                 return "key1";
             }
         };

diff --git a/...-platform-api/src/main/java/com/refinedmods/refinedstorage2/platform/api/PlatformApi.java b/...-platform-api/src/main/java/com/refinedmods/refinedstorage2/platform/api/PlatformApi.java
@@ -4,6 +4,7 @@
 import com.refinedmods.refinedstorage2.api.network.Network;
 import com.refinedmods.refinedstorage2.api.network.NetworkComponent;
 import com.refinedmods.refinedstorage2.api.network.energy.EnergyStorage;
+import com.refinedmods.refinedstorage2.api.network.node.NetworkNode;
 import com.refinedmods.refinedstorage2.api.network.security.SecurityPolicy;
 import com.refinedmods.refinedstorage2.api.resource.ResourceKey;
 import com.refinedmods.refinedstorage2.platform.api.constructordestructor.ConstructorStrategyFactory;
@@ -30,7 +31,8 @@
 import com.refinedmods.refinedstorage2.platform.api.storagemonitor.StorageMonitorExtractionStrategy;
 import com.refinedmods.refinedstorage2.platform.api.storagemonitor.StorageMonitorInsertionStrategy;
 import com.refinedmods.refinedstorage2.platform.api.support.energy.EnergyItemHelper;
-import com.refinedmods.refinedstorage2.platform.api.support.network.PlatformNetworkNodeContainer;
+import com.refinedmods.refinedstorage2.platform.api.support.network.ConnectionLogic;
+import com.refinedmods.refinedstorage2.platform.api.support.network.InWorldNetworkNodeContainer;
 import com.refinedmods.refinedstorage2.platform.api.support.network.bounditem.NetworkBoundItemHelper;
 import com.refinedmods.refinedstorage2.platform.api.support.network.bounditem.SlotReference;
 import com.refinedmods.refinedstorage2.platform.api.support.network.bounditem.SlotReferenceFactory;
@@ -46,6 +48,8 @@
 import java.util.Collection;
 import java.util.Optional;
 import java.util.Set;
+import java.util.function.Supplier;
+import javax.annotation.Nullable;
 
 import net.minecraft.core.BlockPos;
 import net.minecraft.network.FriendlyByteBuf;
@@ -57,6 +61,7 @@
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.level.Level;
+import net.minecraft.world.level.block.entity.BlockEntity;
 import net.minecraft.world.level.block.entity.BlockEntityType;
 import net.minecraft.world.level.block.state.BlockState;
 import org.apiguardian.api.API;
@@ -107,11 +112,20 @@ public interface PlatformApi {
 
     BuiltinUpgradeDestinations getBuiltinUpgradeDestinations();
 
-    void requestNetworkNodeInitialization(PlatformNetworkNodeContainer container, Level level, Runnable callback);
+    InWorldNetworkNodeContainer createInWorldNetworkNodeContainer(BlockEntity blockEntity,
+                                                                  NetworkNode node,
+                                                                  String name,
+                                                                  int priority,
+                                                                  @Nullable ConnectionLogic connectionLogic,
+                                                                  @Nullable Supplier<Object> keyProvider);
 
-    void requestNetworkNodeRemoval(PlatformNetworkNodeContainer container, Level level);
+    void onNetworkNodeContainerInitialized(InWorldNetworkNodeContainer container,
+                                           @Nullable Level level,
+                                           @Nullable Runnable callback);
 
-    void requestNetworkNodeUpdate(PlatformNetworkNodeContainer container, Level level);
+    void onNetworkNodeContainerRemoved(InWorldNetworkNodeContainer container, @Nullable Level level);
+
+    void onNetworkNodeContainerUpdated(InWorldNetworkNodeContainer container, @Nullable Level level);
 
     GridInsertionStrategy createGridInsertionStrategy(AbstractContainerMenu containerMenu,
                                                       ServerPlayer player,

diff --git a/...form-api/src/main/java/com/refinedmods/refinedstorage2/platform/api/PlatformApiProxy.java b/...form-api/src/main/java/com/refinedmods/refinedstorage2/platform/api/PlatformApiProxy.java
@@ -4,6 +4,7 @@
 import com.refinedmods.refinedstorage2.api.network.Network;
 import com.refinedmods.refinedstorage2.api.network.NetworkComponent;
 import com.refinedmods.refinedstorage2.api.network.energy.EnergyStorage;
+import com.refinedmods.refinedstorage2.api.network.node.NetworkNode;
 import com.refinedmods.refinedstorage2.api.network.security.SecurityPolicy;
 import com.refinedmods.refinedstorage2.api.resource.ResourceKey;
 import com.refinedmods.refinedstorage2.platform.api.constructordestructor.ConstructorStrategyFactory;
@@ -30,7 +31,8 @@
 import com.refinedmods.refinedstorage2.platform.api.storagemonitor.StorageMonitorExtractionStrategy;
 import com.refinedmods.refinedstorage2.platform.api.storagemonitor.StorageMonitorInsertionStrategy;
 import com.refinedmods.refinedstorage2.platform.api.support.energy.EnergyItemHelper;
-import com.refinedmods.refinedstorage2.platform.api.support.network.PlatformNetworkNodeContainer;
+import com.refinedmods.refinedstorage2.platform.api.support.network.ConnectionLogic;
+import com.refinedmods.refinedstorage2.platform.api.support.network.InWorldNetworkNodeContainer;
 import com.refinedmods.refinedstorage2.platform.api.support.network.bounditem.NetworkBoundItemHelper;
 import com.refinedmods.refinedstorage2.platform.api.support.network.bounditem.SlotReference;
 import com.refinedmods.refinedstorage2.platform.api.support.network.bounditem.SlotReferenceFactory;
@@ -46,6 +48,7 @@
 import java.util.Collection;
 import java.util.Optional;
 import java.util.Set;
+import java.util.function.Supplier;
 import javax.annotation.Nullable;
 
 import net.minecraft.core.BlockPos;
@@ -58,6 +61,7 @@
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.level.Level;
+import net.minecraft.world.level.block.entity.BlockEntity;
 import net.minecraft.world.level.block.entity.BlockEntityType;
 import net.minecraft.world.level.block.state.BlockState;
 
@@ -178,20 +182,36 @@ public BuiltinUpgradeDestinations getBuiltinUpgradeDestinations() {
     }
 
     @Override
-    public void requestNetworkNodeInitialization(final PlatformNetworkNodeContainer container,
-                                                 final Level level,
-                                                 final Runnable callback) {
-        ensureLoaded().requestNetworkNodeInitialization(container, level, callback);
+    public InWorldNetworkNodeContainer createInWorldNetworkNodeContainer(
+        final BlockEntity blockEntity,
+        final NetworkNode node,
+        final String name,
+        final int priority,
+        @Nullable final ConnectionLogic connectionLogic,
+        @Nullable final Supplier<Object> keySupplier
+    ) {
+        return ensureLoaded().createInWorldNetworkNodeContainer(
+            blockEntity, node, name, priority, connectionLogic, keySupplier
+        );
     }
 
     @Override
-    public void requestNetworkNodeRemoval(final PlatformNetworkNodeContainer container, final Level level) {
-        ensureLoaded().requestNetworkNodeRemoval(container, level);
+    public void onNetworkNodeContainerInitialized(final InWorldNetworkNodeContainer container,
+                                                  @Nullable final Level level,
+                                                  @Nullable final Runnable callback) {
+        ensureLoaded().onNetworkNodeContainerInitialized(container, level, callback);
     }
 
     @Override
-    public void requestNetworkNodeUpdate(final PlatformNetworkNodeContainer container, final Level level) {
-        ensureLoaded().requestNetworkNodeUpdate(container, level);
+    public void onNetworkNodeContainerRemoved(final InWorldNetworkNodeContainer container,
+                                              @Nullable final Level level) {
+        ensureLoaded().onNetworkNodeContainerRemoved(container, level);
+    }
+
+    @Override
+    public void onNetworkNodeContainerUpdated(final InWorldNetworkNodeContainer container,
+                                              @Nullable final Level level) {
+        ensureLoaded().onNetworkNodeContainerUpdated(container, level);
     }
 
     @Override

diff --git a/...i/src/main/java/com/refinedmods/refinedstorage2/platform/api/security/SecurityHelper.java b/...i/src/main/java/com/refinedmods/refinedstorage2/platform/api/security/SecurityHelper.java
@@ -3,13 +3,27 @@
 import com.refinedmods.refinedstorage2.api.network.Network;
 import com.refinedmods.refinedstorage2.api.network.node.NetworkNode;
 import com.refinedmods.refinedstorage2.api.network.security.Permission;
+import com.refinedmods.refinedstorage2.platform.api.support.network.InWorldNetworkNodeContainer;
+
+import java.util.Set;
 
 import net.minecraft.server.level.ServerPlayer;
 
 public final class SecurityHelper {
     private SecurityHelper() {
     }
 
+    public static boolean isAllowed(final ServerPlayer player,
+                                    final Permission permission,
+                                    final Set<InWorldNetworkNodeContainer> containers) {
+        for (final InWorldNetworkNodeContainer container : containers) {
+            if (!isAllowed(player, permission, container.getNode())) {
+                return false;
+            }
+        }
+        return true;
+    }
+
     public static boolean isAllowed(final ServerPlayer player, final Permission permission, final NetworkNode node) {
         final Network network = node.getNetwork();
         if (network == null) {

diff --git a/...refinedstorage2/platform/api/support/network/AbstractNetworkNodeContainerBlockEntity.java b/...refinedstorage2/platform/api/support/network/AbstractNetworkNodeContainerBlockEntity.java
@@ -3,87 +3,73 @@
 import com.refinedmods.refinedstorage2.api.network.node.NetworkNode;
 import com.refinedmods.refinedstorage2.platform.api.PlatformApi;
 
+import java.util.HashSet;
+import java.util.Set;
+import javax.annotation.Nullable;
+
 import net.minecraft.core.BlockPos;
-import net.minecraft.core.Direction;
-import net.minecraft.core.GlobalPos;
 import net.minecraft.world.level.block.entity.BlockEntity;
 import net.minecraft.world.level.block.entity.BlockEntityType;
 import net.minecraft.world.level.block.state.BlockState;
 import org.apiguardian.api.API;
 
-import static java.util.Objects.requireNonNull;
-
 @API(status = API.Status.STABLE, since = "2.0.0-milestone.1.2")
 public abstract class AbstractNetworkNodeContainerBlockEntity<T extends NetworkNode> extends BlockEntity
-    implements PlatformNetworkNodeContainer {
-    private final T node;
+    implements NetworkNodeContainerBlockEntity {
+    protected static final String MAIN_CONTAINER_NAME = "main";
+
+    protected final T mainNode;
+    protected final InWorldNetworkNodeContainer mainContainer;
+
+    @Nullable
+    protected Runnable initializationCallback;
+
+    private final Set<InWorldNetworkNodeContainer> containers = new HashSet<>();
 
     protected AbstractNetworkNodeContainerBlockEntity(final BlockEntityType<?> type,
                                                       final BlockPos pos,
                                                       final BlockState state,
-                                                      final T node) {
+                                                      final T mainNode) {
         super(type, pos, state);
-        this.node = node;
+        this.mainContainer = PlatformApi.INSTANCE.createInWorldNetworkNodeContainer(
+            this,
+            mainNode,
+            MAIN_CONTAINER_NAME,
+            getPriority(),
+            null,
+            this::createKey
+        );
+        this.containers.add(mainContainer);
+        this.mainNode = mainNode;
     }
 
-    @Override
-    public void clearRemoved() {
-        super.clearRemoved();
-        if (level == null || level.isClientSide) {
-            return;
-        }
-        PlatformApi.INSTANCE.requestNetworkNodeInitialization(this, level, this::onNetworkInNodeInitialized);
+    @Nullable
+    protected Object createKey() {
+        return null;
     }
 
-    @Override
-    public boolean isContainerRemoved() {
-        return isRemoved();
+    protected int getPriority() {
+        return 0;
     }
 
-    protected void onNetworkInNodeInitialized() {
+    @Override
+    public void clearRemoved() {
+        super.clearRemoved();
+        containers.forEach(container -> PlatformApi.INSTANCE.onNetworkNodeContainerInitialized(
+            container,
+            level,
+            initializationCallback
+        ));
     }
 
     @Override
     public void setRemoved() {
         super.setRemoved();
-        if (level == null || level.isClientSide) {
-            return;
-        }
-        PlatformApi.INSTANCE.requestNetworkNodeRemoval(this, level);
-    }
-
-    @Override
-    public T getNode() {
-        return node;
-    }
-
-    @Override
-    public void addOutgoingConnections(final ConnectionSink sink) {
-        for (final Direction direction : Direction.values()) {
-            sink.tryConnectInSameDimension(worldPosition.relative(direction), direction.getOpposite());
-        }
-    }
-
-    @Override
-    public boolean canAcceptIncomingConnection(final Direction incomingDirection, final BlockState connectingState) {
-        return true;
-    }
-
-    @Override
-    public BlockState getContainerBlockState() {
-        return getBlockState();
-    }
-
-    @Override
-    public GlobalPos getContainerPosition() {
-        return GlobalPos.of(requireNonNull(level).dimension(), worldPosition);
+        containers.forEach(container -> PlatformApi.INSTANCE.onNetworkNodeContainerRemoved(container, level));
     }
 
     @Override
-    public String toString() {
-        return "NetworkNodeContainerBlockEntity{"
-            + "node=" + node
-            + ", worldPosition=" + worldPosition
-            + "}";
+    public Set<InWorldNetworkNodeContainer> getContainers() {
+        return containers;
     }
 }