Started Rewriting Packet Handling

Started rewriting our packet handling code. Deleted PacketHandler in favor of using sided (Server-, Client-) packet handlers to make it easier to follow what's going on in our code. Added some event-based handling of updates which greatly simplified signaling that data needs to be sent, but it's not completely done yet.
2013-09-01 22:01:17 -04:00
parent efa5b3eb4c
commit 62fed83e2f
17 changed files with 421 additions and 221 deletions
--- a/StevenDimDoors/mod_pocketDim/core/IDimLink.java
+++ b/StevenDimDoors/mod_pocketDim/core/IDimLink.java
@@ -1,10 +1,8 @@
 package StevenDimDoors.mod_pocketDim.core;

-import java.io.Serializable;
-
 import StevenDimDoors.mod_pocketDim.util.Point4D;

-public interface IDimLink extends Serializable
+public interface IDimLink
 {
 	public final int TYPE_ENUM_MIN = 0;
 	public final int TYPE_ENUM_MAX = 8;
@@ -26,5 +24,4 @@ public interface IDimLink extends Serializable
 	public int childCount();
 	public IDimLink parent();
 	public int linkType();
-	public IDimLink setDestination(int x, int y, int z, NewDimData dimension);
 }
--- a/StevenDimDoors/mod_pocketDim/core/NewDimData.java
+++ b/StevenDimDoors/mod_pocketDim/core/NewDimData.java
@@ -1,5 +1,4 @@
 package StevenDimDoors.mod_pocketDim.core;
-import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -11,14 +10,15 @@ import StevenDimDoors.mod_pocketDim.DDProperties;
 import StevenDimDoors.mod_pocketDim.dungeon.DungeonData;
 import StevenDimDoors.mod_pocketDim.dungeon.pack.DungeonPack;
 import StevenDimDoors.mod_pocketDim.util.Point4D;
+import StevenDimDoors.mod_pocketDim.watcher.IOpaqueMessage;
+import StevenDimDoors.mod_pocketDim.watcher.IUpdateWatcher;

-public abstract class NewDimData implements Serializable
+public abstract class NewDimData
 {
 	private static class DimLink implements IDimLink
 	{
 		//DimLink is an inner class here to make it immutable to code outside NewDimData
 		
-		private static final long serialVersionUID = 1462177151401498444L;
 		private static final int EXPECTED_CHILDREN = 2;
 		
 		private Point4D source;
@@ -66,16 +66,9 @@ public abstract class NewDimData implements Serializable
 			return (tail.getDestination() != null);
 		}
 		
-		@Override		
-		public IDimLink setDestination(int x, int y, int z, NewDimData dimension)
+		public void setDestination(int x, int y, int z, NewDimData dimension)
 		{
-			if (dimension == null)
-			{
-				throw new IllegalArgumentException("dimension cannot be null.");
-			}
-			
 			tail.setDestination(new Point4D(x, y, z, dimension.id()));
-			return this;
 		}

 		@Override
@@ -179,9 +172,18 @@ public abstract class NewDimData implements Serializable
 		{
 			return source + " -> " + (hasDestination() ? destination() : "");
 		}
-	}
 		
-	private static final long serialVersionUID = 89361974746997260L;
+		public IOpaqueMessage toMessage()
+		{
+			return null;
+		}
+
+		public IOpaqueMessage toKey()
+		{
+			return null;
+		}
+	}
+	
 	private static Random random = new Random();
 	
 	private final int id;
@@ -197,8 +199,11 @@ public abstract class NewDimData implements Serializable
 	private Point4D origin;
 	private int orientation;
 	private DungeonData dungeon;
+	private final IUpdateWatcher dimWatcher;
+	private final IUpdateWatcher linkWatcher;
 	
-	protected NewDimData(int id, NewDimData parent, boolean isPocket, boolean isDungeon)
+	protected NewDimData(int id, NewDimData parent, boolean isPocket, boolean isDungeon,
+		IUpdateWatcher dimWatcher, IUpdateWatcher linkWatcher)
 	{
 		//The isPocket flag is redundant. It's meant as an integrity safeguard.
 		if (isPocket == (parent != null))
@@ -215,24 +220,33 @@ public abstract class NewDimData implements Serializable
 		this.linkList = new ArrayList<DimLink>(); //Should be stored in oct tree -- temporary solution
 		this.children = new ArrayList<NewDimData>(); 
 		this.parent = parent;
-		this.root = (parent != null ? parent.root : this);
-		this.depth = (parent != null ? parent.depth + 1 : 0);
 		this.packDepth = 0;
 		this.isDungeon = isDungeon;
 		this.isFilled = false;
 		this.orientation = 0;
 		this.origin = null;
 		this.dungeon = null;
+		this.dimWatcher = dimWatcher;
+		this.linkWatcher = linkWatcher;
 		
 		//Register with parent
-		addChildDimension(this);
+		if (parent != null)
+		{
+			//We don't need to raise an update event for adding a child because the child's creation will be signaled.
+			this.root = parent.root;
+			this.depth = parent.depth + 1;
+			parent.children.add(this);
+		}
+		else
+		{
+			this.root = this;
+			this.depth = 0;
+		}
 	}
 	
-	private void addChildDimension(NewDimData child)
-	{
-		children.add(child);
-	}
-
+	protected abstract IOpaqueMessage toMessage();
+	protected abstract IOpaqueMessage toKey();
+	
 	public IDimLink findNearestRift(World world, int range, int x, int y, int z)
 	{
 		//TODO: Rewrite this later to use an octtree
@@ -301,6 +315,8 @@ public abstract class NewDimData implements Serializable
 		{
 			link.overwrite(linkType);
 		}
+		//Link created!
+		linkWatcher.onCreated(link.toMessage());
 		return link;
 	}
 	
@@ -330,7 +346,8 @@ public abstract class NewDimData implements Serializable
 		{
 			link.overwrite(parent);
 		}
-		
+		//Link created!
+		linkWatcher.onCreated(link.toMessage());
 		return link;
 	}

@@ -344,6 +361,8 @@ public abstract class NewDimData implements Serializable
 		if (target != null)
 		{
 			linkList.remove(target);
+			//Raise deletion event
+			linkWatcher.onDeleted(target.toKey());
 			target.clear();
 		}
 		return (target != null);
@@ -356,6 +375,8 @@ public abstract class NewDimData implements Serializable
 		if (target != null)
 		{
 			linkList.remove(target);
+			//Raise deletion event
+			linkWatcher.onDeleted(target.toKey());
 			target.clear();
 		}
 		return (target != null);
@@ -400,6 +421,8 @@ public abstract class NewDimData implements Serializable
 	public void setFilled(boolean isFilled)
 	{
 		this.isFilled = isFilled;
+		//Raise the dim update event
+		dimWatcher.onUpdated(this.toMessage());
 	}
 	
 	public int id()
@@ -457,7 +480,7 @@ public abstract class NewDimData implements Serializable
 		return children;
 	}
 	
-	public void initializeDungeon(int originX, int originY, int originZ, int orientation, IDimLink link, DungeonData dungeon)
+	public void initializeDungeon(int originX, int originY, int originZ, int orientation, IDimLink incoming, DungeonData dungeon)
 	{
 		if (!isDungeon)
 		{
@@ -468,11 +491,13 @@ public abstract class NewDimData implements Serializable
 			throw new IllegalStateException("The dimension has already been initialized.");
 		}
 		
-		link.setDestination(originX, originY, originZ, this);
-		this.origin = link.destination();
+		setDestination(incoming, originX, originY, originZ);
+		this.origin = incoming.destination();
 		this.orientation = orientation;
 		this.dungeon = dungeon;
 		this.packDepth = calculatePackDepth(parent, dungeon);
+		//Raise the dim update event
+		dimWatcher.onUpdated(this.toMessage());
 	}
 	
 	private static int calculatePackDepth(NewDimData parent, DungeonData current)
@@ -507,7 +532,7 @@ public abstract class NewDimData implements Serializable
 		}
 	}

-	public void initializePocket(int originX, int originY, int originZ, int orientation, IDimLink link)
+	public void initializePocket(int originX, int originY, int originZ, int orientation, IDimLink incoming)
 	{
 		if (!isPocketDimension())
 		{
@@ -518,9 +543,19 @@ public abstract class NewDimData implements Serializable
 			throw new IllegalStateException("The dimension has already been initialized.");
 		}
 		
-		link.setDestination(originX, originY, originZ, this);
-		this.origin = link.destination();
+		setDestination(incoming, originX, originY, originZ);
+		this.origin = incoming.destination();
 		this.orientation = orientation;
+		//Raise the dim update event
+		dimWatcher.onUpdated(this.toMessage());
+	}
+	
+	public void setDestination(IDimLink incoming, int x, int y, int z)
+	{
+		DimLink link = (DimLink) incoming;
+		link.setDestination(x, y, z, this);
+		//Raise update event
+		linkWatcher.onUpdated(link.toMessage());
 	}

 	public IDimLink getRandomLink()
--- a/StevenDimDoors/mod_pocketDim/core/PocketManager.java
+++ b/StevenDimDoors/mod_pocketDim/core/PocketManager.java
@@ -1,9 +1,10 @@
 package StevenDimDoors.mod_pocketDim.core;

+import java.io.DataOutputStream;
 import java.io.File;
-import java.io.FileInputStream;
+import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
-import java.io.ObjectOutputStream;
+import java.io.IOException;
 import java.util.HashMap;

 import net.minecraft.entity.player.EntityPlayer;
@@ -12,11 +13,12 @@ import net.minecraft.tileentity.TileEntity;
 import net.minecraft.world.World;
 import net.minecraftforge.common.DimensionManager;
 import StevenDimDoors.mod_pocketDim.DDProperties;
-import StevenDimDoors.mod_pocketDim.ObjectSaveInputStream;
 import StevenDimDoors.mod_pocketDim.helpers.DeleteFolder;
 import StevenDimDoors.mod_pocketDim.tileentities.TileEntityRift;
 import StevenDimDoors.mod_pocketDim.util.Point4D;
-import cpw.mods.fml.common.FMLCommonHandler;
+import StevenDimDoors.mod_pocketDim.watcher.IOpaqueMessage;
+import StevenDimDoors.mod_pocketDim.watcher.IUpdateWatcher;
+import StevenDimDoors.mod_pocketDim.watcher.UpdateWatcherProxy;

 /**
 * This class regulates all the operations involving the storage and manipulation of dimensions. It handles saving dim data, teleporting the player, and 
@@ -30,19 +32,35 @@ public class PocketManager
 		//a public constructor from NewDimData. It's meant to stop us from constructing instances
 		//of NewDimData without using PocketManager's functions. In turn, that enforces that any
 		//link destinations must be real dimensions controlled by PocketManager.
-		
-		private static final long serialVersionUID = -3497038894870586232L;

-		public InnerDimData(int id, NewDimData parent, boolean isPocket, boolean isDungeon)
+		public InnerDimData(int id, NewDimData parent, boolean isPocket, boolean isDungeon,
+			IUpdateWatcher dimWatcher, IUpdateWatcher linkWatcher)
 		{
-			super(id, parent, isPocket, isDungeon);
+			super(id, parent, isPocket, isDungeon, dimWatcher, linkWatcher);
+		}
+
+		@Override
+		protected IOpaqueMessage toMessage()
+		{
+			// TODO Auto-generated method stub
+			return null;
+		}
+
+		@Override
+		protected IOpaqueMessage toKey()
+		{
+			// TODO Auto-generated method stub
+			return null;
 		}
 	}
 	
 	private static int OVERWORLD_DIMENSION_ID = 0;
 	
-	private static boolean isLoaded = false;
-	private static boolean isSaving = false;
+	private static volatile boolean isLoading = false;
+	private static volatile boolean isLoaded = false;
+	private static volatile boolean isSaving = false;
+	private static UpdateWatcherProxy linkWatcher = null;
+	private static UpdateWatcherProxy dimWatcher = null;

 	//HashMap that maps all the dimension IDs registered with DimDoors to their DD data.
 	private static HashMap<Integer, NewDimData> dimensionData = new HashMap<Integer, NewDimData>();
@@ -62,8 +80,17 @@ public class PocketManager
 		{
 			throw new IllegalStateException("Pocket dimensions have already been loaded!");
 		}
+		if (isLoading)
+		{
+			return;
+		}
+
+		isLoading = true;
+		
+		//Set up watcher proxies
+		dimWatcher = new UpdateWatcherProxy();
+		linkWatcher = new UpdateWatcherProxy();
 		
-		isLoaded = true;
 		loadInternal();
 		
 		//Register Limbo
@@ -72,6 +99,9 @@ public class PocketManager
 		
 		//Register pocket dimensions
 		registerPockets(properties);
+		
+		isLoaded = true;
+		isLoading = false;
 	}

 	public boolean clearPocket(NewDimData dimension)
@@ -103,6 +133,9 @@ public class PocketManager
 				File save = new File(DimensionManager.getCurrentSaveRootDirectory() + "/DimensionalDoors/pocketDimID" + dimension.id());
 				DeleteFolder.deleteFolder(save);
 			}
+			//Raise the dim deleted event
+			dimWatcher.onDeleted(dimension.toKey());
+			//dimension.implode()??? -- more like delete, but yeah
 			return true;
 		}
 		else
@@ -149,65 +182,6 @@ public class PocketManager
 		}
 	}

-	/**
-	 * Function that saves all dim data in a hashMap. Calling too often can cause Concurrent modification exceptions, so be careful.
-	 * @return
-	 */
-	public static void save()
-	{
-		//TODO change from saving serialized objects to just saving data for compatabilies sake. 
-		//TODO If saving is multithreaded as the concurrent modification exception implies, you should be synchronizing access. ~SenseiKiwi
-
-		if (!isLoaded)
-		{
-			return;
-		}
-		if (isSaving)
-		{
-			return;
-		}
-		World world = DimensionManager.getWorld(OVERWORLD_DIMENSION_ID);
-		if (world == null || world.isRemote)
-		{
-			return;
-		}	
-		if (DimensionManager.getCurrentSaveRootDirectory() != null)
-		{
-			isSaving = true;
-			HashMap<String, Object> comboSave = new HashMap<String, Object>();
-			comboSave.put("dimensionData", dimensionData);
-
-			FileOutputStream saveFile = null;
-			try
-			{
-				String saveFileName=DimensionManager.getCurrentSaveRootDirectory()+"/DimensionalDoorsDataTEMP";
-				saveFile = new FileOutputStream(saveFileName);
-
-				ObjectOutputStream save = new ObjectOutputStream(saveFile);
-				save.writeObject(comboSave);
-				save.close();
-				saveFile.close();
-
-				if (new File(DimensionManager.getCurrentSaveRootDirectory()+"/DimensionalDoorsDataOLD").exists())
-				{
-					new File(DimensionManager.getCurrentSaveRootDirectory()+"/DimensionalDoorsDataOLD").delete(); 
-				}
-				new File(DimensionManager.getCurrentSaveRootDirectory()+"/DimensionalDoorsData").renameTo(new File(DimensionManager.getCurrentSaveRootDirectory()+"/DimensionalDoorsDataOLD"));
-
-				new File(saveFileName).renameTo( new File(DimensionManager.getCurrentSaveRootDirectory()+"/DimensionalDoorsData"));
-			}
-			catch(Exception e)
-			{
-				e.printStackTrace();
-				System.err.println("Could not save data-- SEVERE");
-			}
-			finally
-			{
-				isSaving = false;
-			}
-		}
-	}
-
 	/**
 	 * loads the dim data from the saved hashMap. Also handles compatibility with old saves, see OldSaveHandler
 	 * @return
@@ -215,81 +189,68 @@ public class PocketManager
 	@SuppressWarnings("unchecked")
 	private static void loadInternal()
 	{
-		//FIXME: There are a lot of things to fix here... First, we shouldn't be created so many File instances
-		//when we could just hold references and reuse them. Second, duplicate code is BAD. Loading stuff should
-		//be a function so that you can apply it to the save file first, then the "backup", instead of duplicating
-		//so much code. >_<
+		// SenseiKiwi: This is a temporary function for testing purposes.
+		// We'll move on to using a text-based format in the future.
 		
-		boolean firstRun = false;
-		System.out.println("Loading DimDoors data");
-		FileInputStream saveFile = null;
-
-		if (!DimensionManager.getWorld(OVERWORLD_DIMENSION_ID).isRemote && DimensionManager.getCurrentSaveRootDirectory()!=null)
+		if (!DimensionManager.getWorld(OVERWORLD_DIMENSION_ID).isRemote &&
+			DimensionManager.getCurrentSaveRootDirectory() != null)
 		{
-			try
-			{
-				File dataStore = new File( DimensionManager.getCurrentSaveRootDirectory()+"/DimensionalDoorsData");
-				if (!dataStore.exists())
-				{
-					if (!new File( DimensionManager.getCurrentSaveRootDirectory()+"/DimensionalDoorsDataOLD").exists())
-					{
-						firstRun=true;
-					}
-				}
-				saveFile = new FileInputStream(dataStore);
-				ObjectSaveInputStream save = new ObjectSaveInputStream(saveFile);
-				HashMap<String, Object> comboSave = (HashMap<String, Object>) save.readObject();
+			System.out.println("Loading Dimensional Doors save data...");
+			File saveFile = new File(DimensionManager.getCurrentSaveRootDirectory() + "/dimdoors.dat");
+			//Missing code for converting the binary data in the file into an IOpaqueMessage
+			IOpaqueMessage saveData;
+			setState(saveData);
+			System.out.println("Loaded successfully!");
+		}
+	}
+	
+	public static void save()
+	{
+		// SenseiKiwi: This is a temporary function for testing purposes.
+		// We'll move on to using a text-based format in the future.

-				try
-				{
-					dimensionData = (HashMap<Integer, NewDimData>) comboSave.get("dimensionData");
-				}
-				catch(Exception e)
-				{
-					System.out.println("Could not load pocket dimension list. Saves are probably lost, but repairable. Move the files from individual pocket dim files to active ones. See MC thread for details.");
-				}
+		if (!isLoaded)
+		{
+			return;
+		}
+		World world = DimensionManager.getWorld(OVERWORLD_DIMENSION_ID);
+		if (world == null || world.isRemote || DimensionManager.getCurrentSaveRootDirectory() != null)
+		{
+			return;
+		}
+		//Check this last to make sure we set the flag shortly after.
+		if (isSaving)
+		{
+			return;
+		}

-				save.close();
-				saveFile.close();
-			}
-			catch (Exception e)
-			{
-				try
-				{
-					if (!firstRun)
-					{
-						System.out.println("Save data damaged, trying backup...");
-					}
-					World world=FMLCommonHandler.instance().getMinecraftServerInstance().worldServers[0];
-					File dataStore =new File( world.getSaveHandler().getMapFileFromName("idcounts").getParentFile().getParent()+"/DimensionalDoorsDataOLD");
-
-
-					saveFile = new FileInputStream(dataStore);
-					ObjectSaveInputStream save = new ObjectSaveInputStream(saveFile);
-					HashMap<String, Object> comboSave = (HashMap<String, Object>) save.readObject();
-
-					try
-					{
-						dimensionData = (HashMap<Integer, NewDimData>) comboSave.get("dimensionData");
-					}
-					catch (Exception e2)
-					{
-						System.out.println("Could not load pocket dim list. Saves probably lost, but repairable. Move the files from indivual pocket dim files to active ones. See MC thread for details.");
-					}
-
-					save.close();
-					saveFile.close();
-				}
-				catch (Exception e2)			
-				{
-					if (!firstRun)
-					{
-						System.err.println("Could not read data-- SEVERE");
-						e2.printStackTrace();
-					}
-				}
-			}
-		}	
+		isSaving = true;
+		try
+		{
+			System.out.println("Writing Dimensional Doors save data...");
+			String tempPath = DimensionManager.getCurrentSaveRootDirectory() + "/dimdoors.tmp";
+			String savePath = DimensionManager.getCurrentSaveRootDirectory() + "/dimdoors.dat";
+			File tempFile = new File(tempPath);
+			File saveFile = new File(savePath);
+			DataOutputStream writer = new DataOutputStream(new FileOutputStream(tempFile));
+			getState().writeToStream(writer);
+			writer.close();
+			saveFile.delete();
+			tempFile.renameTo(saveFile);
+			System.out.println("Saved successfully!");
+		}
+		catch (FileNotFoundException e)
+		{
+			e.printStackTrace();
+		}
+		catch (IOException e)
+		{
+			e.printStackTrace();
+		}
+		finally
+		{
+			isSaving = false;
+		}
 	}

 	public static boolean removeRift(World world, int x, int y, int z, int range, EntityPlayer player, ItemStack item)
@@ -340,7 +301,7 @@ public class PocketManager
 			throw new IllegalArgumentException("Cannot register a dimension with ID = " + dimensionID + " because it has already been registered.");
 		}

-		NewDimData dimension = new InnerDimData(dimensionID, parent, isPocket, isDungeon);
+		NewDimData dimension = new InnerDimData(dimensionID, parent, isPocket, isDungeon, dimWatcher, linkWatcher);
 		dimensionData.put(dimensionID, dimension);
 		return dimension;
 	}
@@ -395,4 +356,38 @@ public class PocketManager
 			return null;
 		}
 	}
+	
+	public static void registerDimWatcher(IUpdateWatcher watcher)
+	{
+		dimWatcher.registerReceiver(watcher);
+	}
+	
+	public static boolean unregisterDimWatcher(IUpdateWatcher watcher)
+	{
+		return dimWatcher.unregisterReceiver(watcher);
+	}
+	
+	public static void registerLinkWatcher(IUpdateWatcher watcher)
+	{
+		linkWatcher.registerReceiver(watcher);
+	}
+	
+	public static boolean unregisterLinkWatcher(IUpdateWatcher watcher)
+	{
+		return linkWatcher.unregisterReceiver(watcher);
+	}
+	
+	public static IOpaqueMessage getState()
+	{
+		
+	}
+	
+	public static void setState(IOpaqueMessage state)
+	{
+		if (isLoaded)
+		{
+			throw new IllegalStateException("Pocket dimensions have already been loaded!");
+		}
+		
+	}
 }