LiteLoader 1.3.2_03

+ Added plugin channels support + small changes to exception/throwable logging + added some comments to uncommented interfaces

LiteLoader 1.3.2_03
+ Added plugin channels support + small changes to exception/throwable logging + added some comments to uncommented interfaces
Mumfrey
1 parent 71a4ac62
Showing 8 changed files with 388 additions and 24 deletions
java/com/mumfrey/liteloader/InitCompleteListener.java
java/com/mumfrey/liteloader/PluginChannelListener.java
java/com/mumfrey/liteloader/core/HookChat.java
java/com/mumfrey/liteloader/core/HookPluginChannels.java
java/com/mumfrey/liteloader/core/LiteLoader.java
java/com/mumfrey/liteloader/util/ModUtilities.java
java/com/mumfrey/liteloader/util/PrivateFields.java
java/net/minecraft/src/RenderLightningBolt.java
@@ -4,7 +4,19 @@ import net.minecraft.client.Minecraft;
  
 import com.mumfrey.liteloader.core.LiteLoader;
  
+/**
+ * Interface for mods which need to initialise stuff once the game initialisation is completed,
+ * for example mods which need to register new renderers.
+ *
+ * @author Adam Mummery-Smith
+ */
 public interface InitCompleteListener extends Tickable
 {
+	/**
+	 * Called as soon as the game is initialised and the main game loop is running
+	 * 
+	 * @param minecraft Minecraft instance
+	 * @param loader LiteLoader instance
+	 */
 	public abstract void onInitCompleted(Minecraft minecraft, LiteLoader loader);
 }
+package com.mumfrey.liteloader;
+
+import java.util.List;
+
+/**
+ * Interface for mods which want to use plugin channels
+ *
+ * @author Adam Mummery-Smith
+ */
+public interface PluginChannelListener extends LoginListener
+{
+	/**
+	 * Return a list of the plugin channels the mod wants to register
+	 * 
+	 * @return
+	 */
+	public abstract List<String> getChannels();
+	
+    /**
+     * Called when a custom payload packet arrives on a channel this mod has registered
+     * 
+     * @param channel Channel on which the custom payload was received
+     * @param length Length of the custom payload data
+     * @param data Custom payload data
+     */
+    public abstract void onCustomPayload(String channel, int length, byte[] data);
+}
@@ -3,6 +3,7 @@ package com.mumfrey.liteloader.core;
 import java.io.DataInputStream;
 import java.io.DataOutputStream;
 import java.io.IOException;
+import java.lang.reflect.Constructor;
 import java.util.Map;
  
 import net.minecraft.src.IntHashMap;
@@ -53,7 +54,7 @@ public class HookChat extends Packet3Chat
 		{
 			if (proxyClass != null)
 			{
-				proxyPacket = (Packet)proxyClass.newInstance();
+				proxyPacket = proxyClass.newInstance();
 			}
 		}
 		catch (Exception ex) {}
@@ -71,7 +72,12 @@ public class HookChat extends Packet3Chat
 		{
 			if (proxyClass != null)
 			{
-				proxyPacket = (Packet)proxyClass.newInstance();
+				proxyPacket = proxyClass.newInstance();
+				
+				if (proxyPacket instanceof Packet3Chat)
+				{
+					((Packet3Chat)proxyPacket).message = this.message;
+				}
 			}
 		}
 		catch (Exception ex) {}
@@ -142,15 +148,15 @@ public class HookChat extends Packet3Chat
      * 
      * @param force Force registration even if registration was already performed previously.
      */
-    public static void Register(boolean force)
+    @SuppressWarnings("unchecked")
+	public static void Register(boolean force)
 	{
-    	System.out.println("LITELOADER REGISTER");
 		if (!registered || force)
 		{
 			try
 			{
 			    IntHashMap packetIdToClassMap = Packet.packetIdToClassMap;
-			    proxyClass = (Class)packetIdToClassMap.lookup(3);
+			    proxyClass = (Class<? extends Packet>)packetIdToClassMap.lookup(3);
  
 			    if (proxyClass.equals(Packet3Chat.class))
 			    {
+package com.mumfrey.liteloader.core;
+
+import java.io.DataInputStream;
+import java.io.DataOutputStream;
+import java.io.IOException;
+import java.lang.reflect.Constructor;
+import java.util.Map;
+
+import com.mumfrey.liteloader.util.PrivateFields;
+
+import net.minecraft.src.IntHashMap;
+import net.minecraft.src.NetHandler;
+import net.minecraft.src.Packet;
+import net.minecraft.src.Packet250CustomPayload;
+import net.minecraft.src.Packet3Chat;
+
+public class HookPluginChannels extends Packet250CustomPayload
+{
+	/**
+	 * True if this class was registered with the base class
+	 */
+	private static boolean registered = false;
+	
+	/**
+	 * Handler module which is registered to handle inbound chat packets
+	 */
+	private static LiteLoader packetHandler; 
+	
+	/**
+	 * Class which was overridden and will be instanced for new packets
+	 */
+	private static Class<? extends Packet> proxyClass;
+	
+	/**
+	 * Instance of the proxy packet for this packet instance
+	 */
+	private Packet proxyPacket;
+	
+	public HookPluginChannels()
+	{
+		super();
+		
+		try
+		{
+			if (proxyClass != null)
+			{
+				proxyPacket = proxyClass.newInstance();
+			}
+		}
+		catch (Exception ex) {}
+	}
+	
+	public HookPluginChannels(String channel, byte[] data)
+	{
+		super(channel, data);
+
+		try
+		{
+			if (proxyClass != null)
+			{
+				proxyPacket = proxyClass.newInstance();
+				
+				if (proxyPacket instanceof Packet250CustomPayload)
+				{
+					((Packet250CustomPayload)proxyPacket).channel = this.channel;
+					((Packet250CustomPayload)proxyPacket).data = this.data;
+					((Packet250CustomPayload)proxyPacket).length = this.length;
+				}
+			}
+		}
+		catch (Exception ex) {}
+	}
+	
+
+	@Override
+	public void readPacketData(DataInputStream datainputstream) throws IOException
+	{
+		if (proxyPacket != null)
+		{
+			proxyPacket.readPacketData(datainputstream);
+			this.channel = ((Packet250CustomPayload)proxyPacket).channel;
+			this.length = ((Packet250CustomPayload)proxyPacket).length;
+			this.data = ((Packet250CustomPayload)proxyPacket).data;
+		}
+		else
+			super.readPacketData(datainputstream);
+	}
+
+	@Override
+	public void writePacketData(DataOutputStream dataoutputstream) throws IOException
+	{
+		if (proxyPacket != null)
+			proxyPacket.writePacketData(dataoutputstream);
+		else
+			super.writePacketData(dataoutputstream);
+	}
+
+	@Override
+	public void processPacket(NetHandler nethandler)
+	{
+		if (proxyPacket != null)
+			proxyPacket.processPacket(nethandler);
+		else
+			super.processPacket(nethandler);
+
+		if (packetHandler != null)
+		{
+			packetHandler.onPluginChannelMessage(this);
+		}
+	}
+
+	@Override
+	public int getPacketSize()
+	{
+		if (proxyPacket != null)
+			return proxyPacket.getPacketSize();
+		else
+			return super.getPacketSize();
+	}
+	
+	/**
+	 * Register the specified handler as the packet handler for this packet
+	 * @param handler
+	 */
+	public static void RegisterPacketHandler(LiteLoader handler)
+	{
+		packetHandler = handler;
+	}
+	
+	/**
+	 * Register this packet as the new packet for packet ID 250
+	 */
+    public static void Register()
+    {
+    	Register(false);
+    }
+
+    /**
+     * Register this packet as the new packet for packet ID 250 and optionally force re-registration even
+     * if registration was performed already.
+     * 
+     * @param force Force registration even if registration was already performed previously.
+     */
+    @SuppressWarnings("unchecked")
+	public static void Register(boolean force)
+	{
+		if (!registered || force)
+		{
+			try
+			{
+			    IntHashMap packetIdToClassMap = Packet.packetIdToClassMap;
+			    proxyClass = (Class<? extends Packet>)packetIdToClassMap.lookup(250);
+			    
+			    if (proxyClass.equals(Packet250CustomPayload.class))
+			    {
+			    	proxyClass = null;
+			    }
+			    
+			    packetIdToClassMap.removeObject(250);
+			    packetIdToClassMap.addKey(250, HookPluginChannels.class);
+
+			    Map packetClassToIdMap = PrivateFields.StaticFields.packetClassToIdMap.Get();
+			    packetClassToIdMap.put(HookPluginChannels.class, Integer.valueOf(250));
+			    
+			    registered = true;
+			}
+			catch (Exception ex)
+			{
+				ex.printStackTrace();
+			}
+		}
+	}
+}
@@ -13,6 +13,7 @@ import java.lang.reflect.Constructor;
 import java.lang.reflect.Method;
 import java.net.URL;
 import java.net.URLClassLoader;
+import java.nio.charset.Charset;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Iterator;
@@ -21,6 +22,7 @@ import java.util.List;
 import java.util.logging.ConsoleHandler;
 import java.util.logging.FileHandler;
 import java.util.logging.Formatter;
+import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.logging.StreamHandler;
 import java.util.zip.ZipEntry;
@@ -31,6 +33,7 @@ import net.minecraft.client.Minecraft;
 import net.minecraft.src.ConsoleLogManager;
 import net.minecraft.src.NetHandler;
 import net.minecraft.src.Packet1Login;
+import net.minecraft.src.Packet250CustomPayload;
 import net.minecraft.src.Packet3Chat;
 import net.minecraft.src.Timer;
  
@@ -39,6 +42,7 @@ import com.mumfrey.liteloader.ChatListener;
 import com.mumfrey.liteloader.InitCompleteListener;
 import com.mumfrey.liteloader.LiteMod;
 import com.mumfrey.liteloader.LoginListener;
+import com.mumfrey.liteloader.PluginChannelListener;
 import com.mumfrey.liteloader.Tickable;
 import com.mumfrey.liteloader.util.ModUtilities;
 import com.mumfrey.liteloader.util.PrivateFields;
@@ -47,14 +51,14 @@ import com.mumfrey.liteloader.util.PrivateFields;
  * LiteLoader is a simple loader which provides tick events to loaded mods 
  *
  * @author Adam Mummery-Smith
- * @version 1.3.2_02
+ * @version 1.3.2_03
  */
 public final class LiteLoader implements FilenameFilter
 {
 	/**
 	 * Liteloader version 
 	 */
-	private static final String LOADER_VERSION = "1.3.2_02";
+	private static final String LOADER_VERSION = "1.3.2_03";
  
 	/**
 	 * Minecraft versions that we will load mods for, this will be compared
@@ -122,6 +126,16 @@ public final class LiteLoader implements FilenameFilter
 	private LinkedList<LoginListener> loginListeners = new LinkedList<LoginListener>();
  
 	/**
+	 * List of mods which implement PluginChannelListener interface
+	 */
+	private LinkedList<PluginChannelListener> pluginChannelListeners = new LinkedList<PluginChannelListener>();
+	
+	/**
+	 * Mapping of plugin channel names to listeners 
+	 */
+	private HashMap<String,LinkedList<PluginChannelListener>> pluginChannels = new HashMap<String, LinkedList<PluginChannelListener>>();
+	
+	/**
 	 * Reference to the addUrl method on URLClassLoader
 	 */
 	private Method mAddUrl;
@@ -171,6 +185,7 @@ public final class LiteLoader implements FilenameFilter
 	/**
 	 * Set up reflection methods required by the loader
 	 */
+	@SuppressWarnings("unchecked")
 	private void prepareLoader()
 	{
 		try
@@ -183,10 +198,10 @@ public final class LiteLoader implements FilenameFilter
  
 			try
 			{
-				Class formatterClass = Minecraft.class.getClassLoader().loadClass(ModUtilities.getObfuscatedFieldName("net.minecraft.src.ConsoleLogFormatter", "em"));
-				Constructor defaultConstructor = formatterClass.getDeclaredConstructor();
+				Class<? extends Formatter> formatterClass = (Class<? extends Formatter>)Minecraft.class.getClassLoader().loadClass(ModUtilities.getObfuscatedFieldName("net.minecraft.src.ConsoleLogFormatter", "em"));
+				Constructor<? extends Formatter> defaultConstructor = formatterClass.getDeclaredConstructor();
 				defaultConstructor.setAccessible(true);
-				minecraftLogFormatter = (Formatter)defaultConstructor.newInstance();
+				minecraftLogFormatter = defaultConstructor.newInstance();
 			}
 			catch (Exception ex)
 			{
@@ -207,10 +222,8 @@ public final class LiteLoader implements FilenameFilter
 		}
 		catch (Exception ex)
 		{
-			logger.severe(ex.toString());
-			logger.severe(ex.getStackTrace().toString());
+			logger.log(Level.SEVERE, "Error initialising LiteLoader", ex);
 		}
-		
 	}
  
 	/**
@@ -446,11 +459,15 @@ public final class LiteLoader implements FilenameFilter
 				{
 					loginListeners.add((LoginListener)mod);
 				}
+				
+				if (mod instanceof PluginChannelListener)
+				{
+					pluginChannelListeners.add((PluginChannelListener)mod);
+				}
 			}
 			catch (Throwable th)
 			{
-				logger.warning("Error initialising mod '" + mod.getName() + "': " + th.toString());
-				th.printStackTrace();
+				logger.log(Level.WARNING, "Error initialising mod '" + mod.getName(), th);
 				iter.remove();
 			}
 		}
@@ -477,12 +494,19 @@ public final class LiteLoader implements FilenameFilter
 				HookLogin.loader = this;
 			}
  
+			// Plugin channels hook
+			if (pluginChannelListeners.size() > 0)
+			{
+				HookPluginChannels.Register();
+				HookPluginChannels.RegisterPacketHandler(this);
+			}
+			
 			// Tick hook
 			PrivateFields.minecraftProfiler.SetFinal(minecraft, new LiteLoaderHook(this, logger));
 		}
 		catch (Exception ex)
 		{
-			logger.warning("Error creating hooks: " + ex.toString());
+			logger.log(Level.WARNING, "Error creating hooks", ex);
 			ex.printStackTrace();
 		}
 	}
@@ -511,8 +535,7 @@ public final class LiteLoader implements FilenameFilter
 		}
 		catch (Throwable th)
 		{
-			logger.warning(th.toString());
-			th.printStackTrace();
+			logger.log(Level.WARNING, "Enumeration error", th);
 		}
  
 		return classes;
@@ -626,8 +649,7 @@ public final class LiteLoader implements FilenameFilter
 		}
 		catch (Throwable th)
 		{
-			logger.warning(th.toString());
-			th.printStackTrace();
+			logger.log(Level.WARNING, "checkAndAddClass error", th);
 		}
 	}
  
@@ -649,8 +671,7 @@ public final class LiteLoader implements FilenameFilter
 		}
 		catch (Throwable th)
 		{
-			logger.warning("Error adding class path entry: " + th.toString());
-			th.printStackTrace();
+			logger.log(Level.WARNING, "Error adding class path entry", th);
 		}
  
 		return false;
@@ -674,7 +695,7 @@ public final class LiteLoader implements FilenameFilter
 				}
 				catch (Throwable th)
 				{
-					logger.warning("Error initialising mod " + initMod.getName() + ": " + th.getClass().getSimpleName() + " - " + th.getMessage());
+					logger.log(Level.WARNING, "Error initialising mod " + initMod.getName(), th);
 				}
 			}
 		}
@@ -741,5 +762,103 @@ public final class LiteLoader implements FilenameFilter
 	{
 		for (LoginListener loginListener : loginListeners)
 			loginListener.onLogin(netHandler, loginPacket);
+		
+		setupPluginChannels();
+	}
+	
+	/**
+	 * Callback for the plugin channel hook
+	 * 
+	 * @param hookPluginChannels
+	 */
+	public void onPluginChannelMessage(HookPluginChannels hookPluginChannels)
+	{
+		if (hookPluginChannels != null && hookPluginChannels.channel != null && pluginChannels.containsKey(hookPluginChannels.channel))
+		{
+			for (PluginChannelListener pluginChannelListener : pluginChannels.get(hookPluginChannels.channel))
+			{
+				try
+				{
+					pluginChannelListener.onCustomPayload(hookPluginChannels.channel, hookPluginChannels.length, hookPluginChannels.data);
+				}
+				catch (Exception ex) {}
+			}
+		}
+	}
+	
+	/**
+	 * Delegate to ModUtilities.sendPluginChannelMessage
+	 * 
+	 * @param channel Channel to send data to
+	 * @param data Data to send
+	 */
+	public void sendPluginChannelMessage(String channel, byte[] data)
+	{
+		ModUtilities.sendPluginChannelMessage(channel, data);
+	}
+	
+	/**
+	 * Query loaded mods for registered channels 
+	 */
+	protected void setupPluginChannels()
+	{
+		// Clear any channels from before
+		pluginChannels.clear();
+		
+		// Enumerate mods for plugin channels
+		for (PluginChannelListener pluginChannelListener : pluginChannelListeners)
+		{
+			List<String> channels = pluginChannelListener.getChannels();
+			
+			if (channels != null)
+			{
+				for (String channel : channels)
+				{
+					if (channel.length() > 16 || channel.toUpperCase().equals("REGISTER") || channel.toUpperCase().equals("UNREGISTER"))
+						continue;
+					
+					if (!pluginChannels.containsKey(channel))
+					{
+						pluginChannels.put(channel, new LinkedList<PluginChannelListener>());
+					}
+					
+					pluginChannels.get(channel).add(pluginChannelListener);
+				}
+			}
+		}
+
+		// If any mods have registered channels, send the REGISTER packet
+		if (pluginChannels.keySet().size() > 0)
+		{
+			StringBuilder channelList = new StringBuilder();
+			boolean separator = false;
+			
+			for (String channel : pluginChannels.keySet())
+			{
+				if (separator) channelList.append("\u0000");
+				channelList.append(channel);
+				separator = true;
+			}
+			
+	        byte[] registrationData = channelList.toString().getBytes(Charset.forName("UTF8"));
+        
+	        sendPluginChannelMessage("REGISTER", registrationData);
+		}
 	}
 }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -9,6 +9,7 @@ import net.minecraft.client.Minecraft;
 import net.minecraft.src.IntHashMap;
 import net.minecraft.src.KeyBinding;
 import net.minecraft.src.Packet;
+import net.minecraft.src.Packet250CustomPayload;
 import net.minecraft.src.Render;
 import net.minecraft.src.RenderManager;
 import net.minecraft.src.Tessellator;
@@ -56,6 +57,30 @@ public abstract class ModUtilities
 			return false;
 		}
 	}
+	
+	/**
+	 * Send a plugin channel (custom payload) packet to the server
+	 * 
+	 * @param channel Channel to send the data
+	 * @param data
+	 */
+	public static void sendPluginChannelMessage(String channel, byte[] data)
+	{
+		if (channel == null || channel.length() > 16)
+			throw new RuntimeException("Invalid channel name specified"); 
+		
+		try
+		{
+			Minecraft minecraft = Minecraft.getMinecraft();
+			
+			if (minecraft.thePlayer != null)
+			{
+				Packet250CustomPayload payload = new Packet250CustomPayload(channel, data);
+				minecraft.thePlayer.sendQueue.addToSendQueue(payload);
+			}
+		}
+		catch (Exception ex) {}
+	}
  
 	/**
 	 * Abstraction helper function
@@ -84,6 +84,7 @@ public class PrivateFields&lt;P, T&gt;
 	 * @param instance Class to get the value of
 	 * @return field value or null if errors occur
 	 */
+	@SuppressWarnings("unchecked")
 	public T Get(P instance)
 	{
 		try
@@ -140,7 +140,8 @@ public class RenderLightningBolt extends Render
      * (Render<T extends Entity) and this method has signature public void doRender(T entity, double d, double d1,
      * double d2, float f, float f1). But JAD is pre 1.5 so doesn't do that.
      */
-    public void doRender(Entity par1Entity, double par2, double par4, double par6, float par8, float par9)
+    @Override
+	public void doRender(Entity par1Entity, double par2, double par4, double par6, float par8, float par9)
     {
         this.doRenderLightningBolt((EntityLightningBolt)par1Entity, par2, par4, par6, par8, par9);
     }