allow accessor injections specified in JSON to use obfuscation entries from the JSON file

Mumfrey
1 parent fba0e0ff
Showing 7 changed files with 137 additions and 18 deletions
java/common/com/mumfrey/liteloader/transformers/ObfProvider.java
java/common/com/mumfrey/liteloader/transformers/access/AccessorTransformer.java
java/common/com/mumfrey/liteloader/transformers/event/EventInjectionTransformer.java
java/common/com/mumfrey/liteloader/transformers/event/EventTransformer.java
java/common/com/mumfrey/liteloader/transformers/event/json/JsonEvents.java
java/common/com/mumfrey/liteloader/transformers/event/json/JsonObfuscationTable.java
java/common/com/mumfrey/liteloader/transformers/event/json/ModEventInjectionTransformer.java
+package com.mumfrey.liteloader.transformers;
+
+import com.mumfrey.liteloader.core.runtime.Obf;
+
+/**
+ * Interface for dynamic (context-specific) obfuscation provider, used internally by ModEventInjectionTransformer to
+ * provide obf entries for the AccessorTransformer from JSON 
+ * 
+ * @author Adam Mummery-Smith
+ */
+public interface ObfProvider
+{
+	/**
+	 * Try to locate an obfuscation table entry by name (id), returns null if no entry was found
+	 * 
+	 * @param name
+	 * @return
+	 */
+	public abstract Obf getByName(String name);
+}
@@ -22,6 +22,7 @@ import org.objectweb.asm.tree.VarInsnNode;
 import com.mumfrey.liteloader.core.runtime.Obf;
 import com.mumfrey.liteloader.transformers.ByteCodeUtilities;
 import com.mumfrey.liteloader.transformers.ClassTransformer;
+import com.mumfrey.liteloader.transformers.ObfProvider;
 import com.mumfrey.liteloader.util.log.LiteLoaderLogger;
  
 /**
@@ -49,18 +50,29 @@ public abstract class AccessorTransformer extends ClassTransformer
 		private final Class<? extends Obf> table;
  
 		/**
+		 * Obfuscation provider for this context
+		 */
+		private final ObfProvider obfProvider;
+		
+		/**
 		 * Target class to inject into 
 		 */
 		private final Obf target;
  
 		protected AccessorInjection(String iface) throws IOException
 		{
+			this(iface, null);
+		}
+
+		protected AccessorInjection(String iface, ObfProvider obfProvider) throws IOException
+		{
 			ClassNode ifaceNode = this.loadClass(iface);
 			this.table = this.setupTable(ifaceNode);
 			this.target = this.setupTarget(ifaceNode);
 			this.iface = iface;
+			this.obfProvider = obfProvider;
 		}
-
+		
 		private ClassNode loadClass(String iface) throws IOException
 		{
 			byte[] bytes = this.getClassBytes(iface);
@@ -77,7 +89,22 @@ public abstract class AccessorTransformer extends ClassTransformer
  
 		private Obf getObf(String name)
 		{
-			return Obf.getByName(this.table, name);
+			if (this.obfProvider != null)
+			{
+				Obf obf = this.obfProvider.getByName(name);
+				if (obf != null)
+				{
+					return obf;
+				}
+			}
+			
+			Obf obf = Obf.getByName(this.table, name);
+			if (obf != null)
+			{
+				return obf;
+			}
+			
+			throw new RuntimeException("No obfuscation table entry could be found for '" + name + "'");
 		}
  
 		protected Obf getTarget()
@@ -318,7 +345,7 @@ public abstract class AccessorTransformer extends ClassTransformer
 		}
 	}
  
-	private List<AccessorInjection> accessors = new ArrayList<AccessorInjection>();
+	private final List<AccessorInjection> accessors = new ArrayList<AccessorInjection>();
  
 	public AccessorTransformer()
 	{
@@ -327,9 +354,14 @@ public abstract class AccessorTransformer extends ClassTransformer
  
 	public void addAccessor(String interfaceName)
 	{
+		this.addAccessor(interfaceName, null);
+	}
+	
+	public void addAccessor(String interfaceName, ObfProvider obfProvider)
+	{
 		try
 		{
-			this.accessors.add(new AccessorInjection(interfaceName));
+			this.accessors.add(new AccessorInjection(interfaceName, obfProvider));
 		}
 		catch (Exception ex)
 		{
 package com.mumfrey.liteloader.transformers.event;
  
+import com.mumfrey.liteloader.transformers.ObfProvider;
+
 import net.minecraft.launchwrapper.IClassTransformer;
  
 public abstract class EventInjectionTransformer implements IClassTransformer
@@ -85,4 +87,15 @@ public abstract class EventInjectionTransformer implements IClassTransformer
 	{
 		EventTransformer.addAccessor(interfaceName);
 	}
+	
+	/**
+	 * Register an access injection interface and provide a contextual obfuscation provider
+	 * 
+	 * @param interfaceName
+	 * @param obfProvider
+	 */
+	protected final void addAccessor(String interfaceName, ObfProvider obfProvider)
+	{
+		EventTransformer.addAccessor(interfaceName, obfProvider);
+	}
 }
@@ -19,6 +19,7 @@ import org.objectweb.asm.util.CheckClassAdapter;
  
 import com.mumfrey.liteloader.transformers.ByteCodeUtilities;
 import com.mumfrey.liteloader.transformers.ClassTransformer;
+import com.mumfrey.liteloader.transformers.ObfProvider;
 import com.mumfrey.liteloader.transformers.access.AccessorTransformer;
 import com.mumfrey.liteloader.util.log.LiteLoaderLogger;
  
@@ -191,6 +192,11 @@ public final class EventTransformer extends ClassTransformer
  
 	static void addAccessor(String interfaceName)
 	{
+		EventTransformer.addAccessor(interfaceName, null);
+	}
+	
+	static void addAccessor(String interfaceName, ObfProvider obfProvider)
+	{
 		if (EventTransformer.accessorTransformer == null)
 		{
 			EventTransformer.accessorTransformer = new AccessorTransformer()
@@ -200,7 +206,7 @@ public final class EventTransformer extends ClassTransformer
 			};
 		}
  
-		EventTransformer.accessorTransformer.addAccessor(interfaceName);
+		EventTransformer.accessorTransformer.addAccessor(interfaceName, obfProvider);
 	}
  
 	@Override
@@ -10,6 +10,7 @@ import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.annotations.SerializedName;
 import com.mumfrey.liteloader.core.runtime.Obf;
+import com.mumfrey.liteloader.transformers.ObfProvider;
  
 /**
  * Serialisable class which represents a set of event injection definitions. Instances of this class are
@@ -21,7 +22,7 @@ import com.mumfrey.liteloader.core.runtime.Obf;
  * 
  * @author Adam Mummery-Smith
  */
-public class JsonEvents implements Serializable
+public class JsonEvents implements Serializable, ObfProvider
 {
 	private static final long serialVersionUID = 1L;
  
@@ -71,9 +72,9 @@ public class JsonEvents implements Serializable
 	 */
 	private void parse()
 	{
-		if (this.events == null || this.events.isEmpty())
+		if (this.obfuscation == null)
 		{
-			throw new InvalidEventJsonException("No events were defined in the supplied JSON");
+			this.obfuscation = new JsonObfuscationTable();
 		}
  
 		try
@@ -84,10 +85,13 @@ public class JsonEvents implements Serializable
 			// Parse the descriptor list
 			this.methods = new JsonMethods(this.obfuscation, this.descriptors);
  
-			// Parse the events
-			for (JsonEvent event : this.events)
+			if (this.events != null)
 			{
-				event.parse(this.methods);
+				// Parse the events
+				for (JsonEvent event : this.events)
+				{
+					event.parse(this.methods);
+				}
 			}
  
 			if (this.accessors != null)
@@ -144,9 +148,18 @@ public class JsonEvents implements Serializable
  
 		for (String interfaceName : this.accessorInterfaces)
 		{
-			transformer.registerAccessor(interfaceName);
+			transformer.registerAccessor(interfaceName, this);
 		}
 	}
+	
+	/* (non-Javadoc)
+	 * @see com.mumfrey.liteloader.transformers.ObfProvider#getByName(java.lang.String)
+	 */
+	@Override
+	public Obf getByName(String name)
+	{
+		return this.obfuscation.getByName(name);
+	}
  
 //	public String toJson()
 //	{
@@ -88,13 +88,41 @@ public class JsonObfuscationTable implements Serializable
  
 		return this.parseClass(token);
 	}
+	
+	/**
+	 * Find an obf entry of any type by name
+	 * 
+	 * @param name
+	 */
+	public Obf getByName(String name)
+	{
+		Obf classObf = this.classObfs.get(name);
+		if (classObf != null)
+		{
+			return classObf;
+		}
+		
+		Obf methodObf = this.methodObfs.get(name);
+		if (methodObf != null)
+		{
+			return methodObf;
+		}
+		
+		Obf fieldObf = this.fieldObfs.get(name);
+		if (fieldObf != null)
+		{
+			return fieldObf;
+		}
+		
+		return null;
+	}
  
 	/**
 	 * @param token
 	 */
 	public Obf parseClass(String token)
 	{
-		return this.parseObf(token, this.classObfs);
+		return this.parseObf(token, this.classObfs, false);
 	}
  
 	/**
@@ -102,7 +130,7 @@ public class JsonObfuscationTable implements Serializable
 	 */
 	public Obf parseMethod(String token)
 	{
-		return this.parseObf(token, this.methodObfs);
+		return this.parseObf(token, this.methodObfs, false);
 	}
  
 	/**
@@ -110,14 +138,15 @@ public class JsonObfuscationTable implements Serializable
 	 */
 	public Obf parseField(String token)
 	{
-		return this.parseObf(token, this.fieldObfs);
+		return this.parseObf(token, this.fieldObfs, false);
 	}
  
 	/**
 	 * @param token
 	 * @param obfs
+	 * @param returnNullOnFailure return null instead of throwing an exception
 	 */
-	private Obf parseObf(String token, Map<String, Obf> obfs)
+	private Obf parseObf(String token, Map<String, Obf> obfs, boolean returnNullOnFailure)
 	{
 		String key = JsonEvents.parseToken(token);
  
@@ -140,6 +169,11 @@ public class JsonObfuscationTable implements Serializable
 				return packet;
 			}
  
+			if (returnNullOnFailure)
+			{
+				return null;
+			}
+			
 			throw new InvalidEventJsonException("The token " + token + " could not be resolved to a type");
 		}
  
@@ -3,6 +3,7 @@ package com.mumfrey.liteloader.transformers.event.json;
 import java.util.Map.Entry;
  
 import com.mumfrey.liteloader.transformers.ClassTransformer;
+import com.mumfrey.liteloader.transformers.ObfProvider;
 import com.mumfrey.liteloader.transformers.event.Event;
 import com.mumfrey.liteloader.transformers.event.EventInjectionTransformer;
 import com.mumfrey.liteloader.transformers.event.InjectionPoint;
@@ -75,8 +76,8 @@ public class ModEventInjectionTransformer extends EventInjectionTransformer
 		return super.addEvent(event, targetMethod, injectionPoint);
 	}
  
-	protected void registerAccessor(String interfaceName)
+	protected void registerAccessor(String interfaceName, ObfProvider obfProvider)
 	{
-		super.addAccessor(interfaceName);
+		super.addAccessor(interfaceName, obfProvider);
 	}
 }