Refactored the BaseActionSource (#3063)

* Refactored the BaseActionSource

It now uses an interface `IActionSource` instead of a concrete class and further
subclasses. 

Instead of relying on a specific class for a certain action type, it now
uses methods with Optional as return values to determine a player or
machine issuing an action. Refer to the JavaDocs for the exact behaviour.

* `IActionHost` no longer extends `IGridHost`

It never used the additional functionality and if needed the `IGridNode`
will also provide a reference to the corresponding `IGridHost`.

Due to most crafting related GUIs being hardcoded to `IGridHost`, 
they no longer work when `IActionHost` is not extending it. Actually
`IActionHost` is the better solution for it, as it prevents us from looking
the grid up via the `IGridHost` and potentially finding a wrong grid.

* Interfaces now only lock the currently worked slot.

This allows `DualityInterface#onChangeInventory` to update slots of the same interface, should they be the source for a requested item and therefore updating their working set accordingly to queue further crafting requests for unfulfilled stack requirements.

src/api/java/appeng/api/networking/crafting/ICraftingCPU.java

@@ -24,7 +24,7 @@
 package appeng.api.networking.crafting;
 
 
-import appeng.api.networking.security.BaseActionSource;
+import appeng.api.networking.security.IActionSource;
 import appeng.api.networking.storage.IBaseMonitor;
 import appeng.api.storage.data.IAEItemStack;
 
@@ -40,7 +40,7 @@ public interface ICraftingCPU extends IBaseMonitor<IAEItemStack>
 	/**
 	 * @return the action source for the CPU.
 	 */
-	BaseActionSource getActionSource();
+	IActionSource getActionSource();
 
 	/**
 	 * @return the available storage in bytes

src/api/java/appeng/api/networking/crafting/ICraftingGrid.java

@@ -33,7 +33,7 @@ import net.minecraft.world.World;
 
 import appeng.api.networking.IGrid;
 import appeng.api.networking.IGridCache;
-import appeng.api.networking.security.BaseActionSource;
+import appeng.api.networking.security.IActionSource;
 import appeng.api.storage.data.IAEItemStack;
 
 
@@ -63,7 +63,7 @@ public interface ICraftingGrid extends IGridCache
 	 * @return a future which will at an undetermined point in the future get you the {@link ICraftingJob} do not wait
 	 * on this, your be waiting forever.
 	 */
-	Future<ICraftingJob> beginCraftingJob( World world, IGrid grid, BaseActionSource actionSrc, IAEItemStack craftWhat, ICraftingCallback callback );
+	Future<ICraftingJob> beginCraftingJob( World world, IGrid grid, IActionSource actionSrc, IAEItemStack craftWhat, ICraftingCallback callback );
 
 	/**
 	 * Submit the job to the Crafting system for processing.
@@ -82,7 +82,7 @@ public interface ICraftingGrid extends IGridCache
 	 * {@link ICraftingRequester} methods. if you send null, this object should be discarded after verifying the
 	 * return state.
 	 */
-	ICraftingLink submitJob( ICraftingJob job, ICraftingRequester requestingMachine, ICraftingCPU target, boolean prioritizePower, BaseActionSource src );
+	ICraftingLink submitJob( ICraftingJob job, ICraftingRequester requestingMachine, ICraftingCPU target, boolean prioritizePower, IActionSource src );
 
 	/**
 	 * @return list of all the crafting cpus on the grid

src/api/java/appeng/api/networking/security/BaseActionSource.java

@@ -1,41 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2013 AlgorithmX2
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-package appeng.api.networking.security;
-
-/**
- * TODO: Consider refactoring.
- */
-public class BaseActionSource
-{
-
-	public boolean isPlayer()
-	{
-		return false;
-	}
-
-	public boolean isMachine()
-	{
-		return false;
-	}
-}

src/api/java/appeng/api/networking/security/IActionHost.java

@@ -24,11 +24,10 @@
 package appeng.api.networking.security;
 
 
-import appeng.api.networking.IGridHost;
 import appeng.api.networking.IGridNode;
 
 
-public interface IActionHost extends IGridHost
+public interface IActionHost
 {
 
 	/**

src/api/java/appeng/api/networking/security/IActionSource.java

@@ -0,0 +1,77 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2013 AlgorithmX2
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package appeng.api.networking.security;
+
+
+import java.util.Optional;
+
+import javax.annotation.Nonnull;
+
+import net.minecraft.entity.player.EntityPlayer;
+
+
+/**
+ * The source of any action.
+ * 
+ * This can either be a {@link EntityPlayer} or an {@link IActionHost}.
+ * 
+ * In most cases this is used for security checks, but can be used to validate the source itself.
+ *
+ */
+public interface IActionSource
+{
+
+	/**
+	 * If present, AE will consider the player being the source for the action.
+	 * 
+	 * This will take precedence over {@link IActionSource#machine()} in any case.
+	 * 
+	 * @return An optional player issuing the action.
+	 */
+	@Nonnull
+	Optional<EntityPlayer> player();
+
+	/**
+	 * If present, it indicates the {@link IActionHost} of the source.
+	 * 
+	 * Should {@link IActionSource#player()} be absent, it will consider a machine as source.
+	 *
+	 * It is recommended to include the machine even when a player is present.
+	 * 
+	 * @return An optional machine issuing the action or acting as proxy for a player.
+	 */
+	@Nonnull
+	Optional<IActionHost> machine();
+
+	/**
+	 * An {@link IActionSource} can have multiple optional contexts.
+	 * 
+	 * It is strongly recommended to limit the uses for absolutely necessary cases.
+	 * 
+	 * Currently there are no public contexts made available by AE.
+	 * An example would be the context interfaces use internally to avoid looping items between each other.
+	 */
+	@Nonnull
+	<T> Optional<T> context( @Nonnull Class<T> key );
+}

src/api/java/appeng/api/networking/security/MachineSource.java

@@ -1,44 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2013 AlgorithmX2
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-package appeng.api.networking.security;
-
-/**
- * TODO: Consider refactoring.
- */
-public class MachineSource extends BaseActionSource
-{
-
-	public final IActionHost via;
-
-	public MachineSource( final IActionHost v )
-	{
-		this.via = v;
-	}
-
-	@Override
-	public boolean isMachine()
-	{
-		return true;
-	}
-}

src/api/java/appeng/api/networking/security/PlayerSource.java

@@ -1,49 +0,0 @@
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2013 AlgorithmX2
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-package appeng.api.networking.security;
-
-
-import net.minecraft.entity.player.EntityPlayer;
-
-/**
- * TODO: Consider refactoring.
- */
-public class PlayerSource extends BaseActionSource
-{
-
-	public final EntityPlayer player;
-	public final IActionHost via;
-
-	public PlayerSource( final EntityPlayer p, final IActionHost v )
-	{
-		this.player = p;
-		this.via = v;
-	}
-
-	@Override
-	public boolean isPlayer()
-	{
-		return true;
-	}
-}

src/api/java/appeng/api/networking/storage/IStackWatcherHost.java

@@ -24,7 +24,7 @@
 package appeng.api.networking.storage;
 
 
-import appeng.api.networking.security.BaseActionSource;
+import appeng.api.networking.security.IActionSource;
 import appeng.api.storage.StorageChannel;
 import appeng.api.storage.data.IAEStack;
 import appeng.api.storage.data.IItemList;
@@ -50,5 +50,5 @@ public interface IStackWatcherHost
 	 * @param src action source
 	 * @param chan storage channel
 	 */
-	void onStackChange( IItemList o, IAEStack fullStack, IAEStack diffStack, BaseActionSource src, StorageChannel chan );
+	void onStackChange( IItemList o, IAEStack fullStack, IAEStack diffStack, IActionSource src, StorageChannel chan );
 }

src/api/java/appeng/api/networking/storage/IStorageGrid.java

@@ -26,7 +26,7 @@ package appeng.api.networking.storage;
 
 import appeng.api.networking.IGridCache;
 import appeng.api.networking.IGridHost;
-import appeng.api.networking.security.BaseActionSource;
+import appeng.api.networking.security.IActionSource;
 import appeng.api.storage.ICellContainer;
 import appeng.api.storage.ICellProvider;
 import appeng.api.storage.IStorageMonitorable;
@@ -50,7 +50,7 @@ public interface IStorageGrid extends IGridCache, IStorageMonitorable
 	 *
 	 * @param input injected items
 	 */
-	void postAlterationOfStoredItems( StorageChannel chan, Iterable<? extends IAEStack> input, BaseActionSource src );
+	void postAlterationOfStoredItems( StorageChannel chan, Iterable<? extends IAEStack> input, IActionSource src );
 
 	/**
 	 * Used to add a cell provider to the storage system

src/api/java/appeng/api/storage/IMEInventory.java

@@ -25,7 +25,7 @@ package appeng.api.storage;
 
 
 import appeng.api.config.Actionable;
-import appeng.api.networking.security.BaseActionSource;
+import appeng.api.networking.security.IActionSource;
 import appeng.api.storage.data.IAEStack;
 import appeng.api.storage.data.IItemList;
 
@@ -52,7 +52,7 @@ public interface IMEInventory<StackType extends IAEStack>
 	 *
 	 * @return returns the number of items not added.
 	 */
-	StackType injectItems( StackType input, Actionable type, BaseActionSource src );
+	StackType injectItems( StackType input, Actionable type, IActionSource src );
 
 	/**
 	 * Extract the specified item from the ME Inventory
@@ -62,7 +62,7 @@ public interface IMEInventory<StackType extends IAEStack>
 	 *
 	 * @return returns the number of items extracted, null
 	 */
-	StackType extractItems( StackType request, Actionable mode, BaseActionSource src );
+	StackType extractItems( StackType request, Actionable mode, IActionSource src );
 
 	/**
 	 * request a full report of all available items, storage.

src/api/java/appeng/api/storage/IMEMonitorHandlerReceiver.java

@@ -24,7 +24,7 @@
 package appeng.api.storage;
 
 
-import appeng.api.networking.security.BaseActionSource;
+import appeng.api.networking.security.IActionSource;
 import appeng.api.networking.storage.IBaseMonitor;
 import appeng.api.storage.data.IAEStack;
 
@@ -46,7 +46,7 @@ public interface IMEMonitorHandlerReceiver<StackType extends IAEStack>
 	 *
 	 * @param change done change
 	 */
-	void postChange( IBaseMonitor<StackType> monitor, Iterable<StackType> change, BaseActionSource actionSource );
+	void postChange( IBaseMonitor<StackType> monitor, Iterable<StackType> change, IActionSource actionSource );
 
 	/**
 	 * called when the list updates its contents, this is mostly for handling power events.

src/api/java/appeng/api/storage/IStorageHelper.java

@@ -35,7 +35,7 @@ import net.minecraftforge.fluids.FluidStack;
 import appeng.api.networking.crafting.ICraftingLink;
 import appeng.api.networking.crafting.ICraftingRequester;
 import appeng.api.networking.energy.IEnergySource;
-import appeng.api.networking.security.BaseActionSource;
+import appeng.api.networking.security.IActionSource;
 import appeng.api.storage.data.IAEFluidStack;
 import appeng.api.storage.data.IAEItemStack;
 import appeng.api.storage.data.IItemList;
@@ -109,7 +109,7 @@ public interface IStorageHelper
 	 *
 	 * @return items that successfully extracted.
 	 */
-	IAEItemStack poweredExtraction( IEnergySource energy, IMEInventory<IAEItemStack> cell, IAEItemStack request, BaseActionSource src );
+	IAEItemStack poweredExtraction( IEnergySource energy, IMEInventory<IAEItemStack> cell, IAEItemStack request, IActionSource src );
 
 	/**
 	 * use energy from energy, to inject input items into cell, at the request of src
@@ -121,5 +121,5 @@ public interface IStorageHelper
 	 *
 	 * @return items that failed to insert.
 	 */
-	IAEItemStack poweredInsert( IEnergySource energy, IMEInventory<IAEItemStack> cell, IAEItemStack input, BaseActionSource src );
+	IAEItemStack poweredInsert( IEnergySource energy, IMEInventory<IAEItemStack> cell, IAEItemStack input, IActionSource src );
 }

src/api/java/appeng/api/storage/IStorageMonitorableAccessor.java

@@ -4,7 +4,7 @@ package appeng.api.storage;
 
 import javax.annotation.Nullable;
 
-import appeng.api.networking.security.BaseActionSource;
+import appeng.api.networking.security.IActionSource;
 
 
 /**
@@ -22,5 +22,5 @@ public interface IStorageMonitorableAccessor
 	 * @return Null if the network cannot be accessed by the given action source (i.e. security doesn't permit it).
 	 */
 	@Nullable
-	IStorageMonitorable getInventory( BaseActionSource src );
+	IStorageMonitorable getInventory( IActionSource src );
 }

src/api/java/appeng/api/storage/MEMonitorHandler.java

@@ -32,7 +32,7 @@ import com.google.common.collect.ImmutableList;
 
 import appeng.api.config.AccessRestriction;
 import appeng.api.config.Actionable;
-import appeng.api.networking.security.BaseActionSource;
+import appeng.api.networking.security.IActionSource;
 import appeng.api.storage.data.IAEStack;
 import appeng.api.storage.data.IItemList;
 
@@ -81,7 +81,7 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
 	}
 
 	@Override
-	public StackType injectItems( final StackType input, final Actionable mode, final BaseActionSource src )
+	public StackType injectItems( final StackType input, final Actionable mode, final IActionSource src )
 	{
 		if( mode == Actionable.SIMULATE )
 		{
@@ -95,7 +95,7 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
 		return this.internalHandler;
 	}
 
-	private StackType monitorDifference( final IAEStack original, final StackType leftOvers, final boolean extraction, final BaseActionSource src )
+	private StackType monitorDifference( final IAEStack original, final StackType leftOvers, final boolean extraction, final IActionSource src )
 	{
 		final StackType diff = (StackType) original.copy();
 
@@ -116,12 +116,12 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
 		return leftOvers;
 	}
 
-	protected void postChangesToListeners( final Iterable<StackType> changes, final BaseActionSource src )
+	protected void postChangesToListeners( final Iterable<StackType> changes, final IActionSource src )
 	{
 		this.notifyListenersOfChange( changes, src );
 	}
 
-	protected void notifyListenersOfChange( final Iterable<StackType> diff, final BaseActionSource src )
+	protected void notifyListenersOfChange( final Iterable<StackType> diff, final IActionSource src )
 	{
 		this.hasChanged = true;// need to update the cache.
 		final Iterator<Entry<IMEMonitorHandlerReceiver<StackType>, Object>> i = this.getListeners();
@@ -146,7 +146,7 @@ public class MEMonitorHandler<StackType extends IAEStack> implements IMEMonitor<
 	}
 
 	@Override
-	public StackType extractItems( final StackType request, final Actionable mode, final BaseActionSource src )
+	public StackType extractItems( final StackType request, final Actionable mode, final IActionSource src )
 	{
 		if( mode == Actionable.SIMULATE )
 		{