AccessorTransformer.java
20.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
/*
* This file is part of LiteLoader.
* Copyright (C) 2012-16 Adam Mummery-Smith
* All Rights Reserved.
*/
package com.mumfrey.liteloader.transformers.event;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.spongepowered.asm.lib.Opcodes;
import org.spongepowered.asm.lib.Type;
import org.spongepowered.asm.lib.tree.*;
import org.spongepowered.asm.util.Annotations;
import org.spongepowered.asm.util.Bytecode;
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.transformers.access.Accessor;
import com.mumfrey.liteloader.transformers.access.Invoker;
import com.mumfrey.liteloader.transformers.access.ObfTableClass;
import com.mumfrey.liteloader.util.log.LiteLoaderLogger;
import net.minecraft.launchwrapper.Launch;
/**
* Transformer which can inject accessor methods defined by an annotated
* interface into a target class.
*
* @author Adam Mummery-Smith
*/
abstract class AccessorTransformer extends ClassTransformer
{
static final String EXCEPTION = "com/mumfrey/liteloader/transformers/access/AccessorException";
static final Pattern ordinalRefPattern = Pattern.compile("^#([0-9]{1,5})$");
/**
* An injection record
*
* @author Adam Mummery-Smith
*/
class AccessorInjection
{
/**
* Full name of the interface to inject
*/
private final String iface;
/**
* Obfuscation table class specified by the interface
*/
private final Class<? extends Obf> table;
/**
* Obfuscation provider for this context
*/
private final ObfProvider obfProvider;
/**
* Target class to inject into
*/
private final Obf target;
/**
* Create a new new accessor using the specified template interface
*
* @param iface Template interface
* @throws IOException Thrown if an problem occurs when loading the
* interface bytecode
*/
protected AccessorInjection(String iface) throws IOException, ClassNotFoundException
{
this(iface, null);
}
/**
* Create a new new accessor using the specified template interface
*
* @param iface Template interface
* @param obfProvider Obfuscation provider for this context
* @throws IOException Thrown if an problem occurs when loading the
* interface bytecode
* @throws ClassNotFoundException
*/
protected AccessorInjection(String iface, ObfProvider obfProvider) throws IOException, ClassNotFoundException
{
ClassNode ifaceNode = ByteCodeUtilities.loadClass(iface, false);
if (ifaceNode.interfaces.size() > 0)
{
String interfaceList = ifaceNode.interfaces.toString().replace('/', '.');
throw new RuntimeException("Accessor interface must not extend other interfaces. Found " + interfaceList + " in " + iface);
}
this.iface = iface;
this.obfProvider = obfProvider;
this.table = this.setupTable(ifaceNode);
this.target = this.setupTarget(ifaceNode);
}
/**
* Get an obfuscation table mapping by name, first uses any supplied
* context provider, then any obfuscation table class specified by an
* {@link ObfTableClass} annotation on the interface itself, and fails
* over onto the LiteLoader obfuscation table. If the entry is not
* matched in any of the above locations then an exception is thrown.
*
* @param name Obfuscation table entry to fetch
*/
private Obf getObf(List<String> names)
{
String name = names.get(0);
Matcher ordinalPattern = AccessorTransformer.ordinalRefPattern.matcher(name);
if (ordinalPattern.matches())
{
int ordinal = Integer.parseInt(ordinalPattern.group(1));
return new Obf.Ord(ordinal);
}
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;
}
if (names.size() > 0 && names.size() < 4)
{
String name2 = names.size() > 1 ? names.get(1) : name;
String name3 = names.size() > 2 ? names.get(2) : name;
return new AccessorTransformer.Mapping(name, name2, name3);
}
throw new RuntimeException("Invalid obfuscation table entry specified: '" + names + "'");
}
/**
* Get the target class of this injection
*/
protected Obf getTarget()
{
return this.target;
}
/**
* Inspects the target class for an {@link ObfTableClass} annotation and
* attempts to get a handle for the class specified. On failure, the
* LiteLoader {@link Obf} is returned.
*/
@SuppressWarnings("unchecked")
private Class<? extends Obf> setupTable(ClassNode ifaceNode)
{
AnnotationNode annotation = Annotations.getInvisible(ifaceNode, ObfTableClass.class);
if (annotation != null)
{
try
{
Type obfTableType = Annotations.<Type>getValue(annotation);
return (Class<? extends Obf>)Class.forName(obfTableType.getClassName(), true, Launch.classLoader);
}
catch (ClassNotFoundException ex)
{
ex.printStackTrace();
}
}
return Obf.class;
}
/**
* Locates the {@link Accessor} annotation on the interface in order to
* determine the target class.
*/
private Obf setupTarget(ClassNode ifaceNode)
{
AnnotationNode annotation = Annotations.getInvisible(ifaceNode, Accessor.class);
if (annotation == null)
{
throw new RuntimeException("Accessor interfaces must be annotated with an @Accessor annotation specifying the target class");
}
List<String> targetClass = Annotations.<String>getValue(annotation, "value", true);
if (targetClass.isEmpty())
{
throw new RuntimeException("Invalid @Accessor annotation, the annotation must specify a target class");
}
return this.getObf(targetClass);
}
/**
* Apply this injection to the specified target ClassNode
*
* @param classNode Class tree to apply to
*/
protected void apply(ClassNode classNode)
{
String ifaceRef = this.iface.replace('.', '/');
if (classNode.interfaces.contains(ifaceRef))
{
LiteLoaderLogger.debug("[AccessorTransformer] Skipping %s because %s was already applied", classNode.name, this.iface);
return;
}
classNode.interfaces.add(ifaceRef);
try
{
LiteLoaderLogger.debug("[AccessorTransformer] Loading %s", this.iface);
ClassNode ifaceNode = ByteCodeUtilities.loadClass(this.iface, AccessorTransformer.this);
for (MethodNode method : ifaceNode.methods)
{
this.addMethod(classNode, method);
}
}
catch (Exception ex)
{
ex.printStackTrace();
}
}
/**
* Add a method from the interface to the target class
*
* @param classNode Target class
* @param method Method to add
*/
private void addMethod(ClassNode classNode, MethodNode method)
{
if (!this.addMethodToClass(classNode, method))
{
LiteLoaderLogger.debug("[AccessorTransformer] Method %s already exists in %s", method.name, classNode.name);
return;
}
LiteLoaderLogger.debug("[AccessorTransformer] Attempting to add %s to %s", method.name, classNode.name);
List<String> targetId = null;
AnnotationNode accessor = Annotations.getInvisible(method, Accessor.class);
AnnotationNode invoker = Annotations.getInvisible(method, Invoker.class);
if (accessor != null)
{
targetId = Annotations.<String>getValue(accessor, "value", true);
Obf target = this.getObf(targetId);
if (this.injectAccessor(classNode, method, target)) return;
}
else if (invoker != null)
{
targetId = Annotations.<String>getValue(invoker, "value", true);
Obf target = this.getObf(targetId);
if (this.injectInvoker(classNode, method, target)) return;
}
else
{
LiteLoaderLogger.severe("[AccessorTransformer] Method %s for %s has no @Accessor or @Invoker annotation, the method will "
+ "be ABSTRACT!", method.name, this.iface);
this.injectException(classNode, method, AccessorTransformer.EXCEPTION, "No @Accessor or @Invoker annotation on method");
return;
}
LiteLoaderLogger.severe("[AccessorTransformer] Method %s for %s could not locate target member, the method will be ABSTRACT!",
method.name, this.iface);
this.injectException(classNode, method, AccessorTransformer.EXCEPTION,
"Accessor could not locate target class member '" + targetId + "'");
}
/**
* Inject an accessor method into the target class
*
* @param classNode
* @param method
* @param targetName
*/
private boolean injectAccessor(ClassNode classNode, MethodNode method, Obf target)
{
FieldNode targetField = ByteCodeUtilities.findField(classNode, target);
if (targetField != null)
{
LiteLoaderLogger.debug("[AccessorTransformer] Found field %s for %s", targetField.name, method.name);
if (Type.getReturnType(method.desc) != Type.VOID_TYPE)
{
this.populateGetter(classNode, method, targetField);
}
else
{
this.populateSetter(classNode, method, targetField);
}
return true;
}
return false;
}
/**
* Inject an invoke (proxy) method into the target class
*
* @param classNode
* @param method
* @param targetName
*/
private boolean injectInvoker(ClassNode classNode, MethodNode method, Obf target)
{
MethodNode targetMethod = ByteCodeUtilities.findMethod(classNode, target, method.desc);
if (targetMethod != null)
{
LiteLoaderLogger.debug("[AccessorTransformer] Found method %s for %s", targetMethod.name, method.name);
this.populateInvoker(classNode, method, targetMethod);
return true;
}
return false;
}
/**
* Populate the bytecode instructions for a getter accessor
*
* @param classNode
* @param method
* @param field
*/
private void populateGetter(ClassNode classNode, MethodNode method, FieldNode field)
{
Type returnType = Type.getReturnType(method.desc);
Type fieldType = Type.getType(field.desc);
if (!returnType.equals(fieldType))
{
throw new RuntimeException("Incompatible types! Field type: " + fieldType + " Method type: " + returnType);
}
boolean isStatic = (field.access & Opcodes.ACC_STATIC) != 0;
method.instructions.clear();
method.maxLocals = Bytecode.getFirstNonArgLocalIndex(method);
method.maxStack = fieldType.getSize();
if (isStatic)
{
method.instructions.add(new FieldInsnNode(Opcodes.GETSTATIC, classNode.name, field.name, field.desc));
}
else
{
method.instructions.add(new VarInsnNode(Opcodes.ALOAD, 0));
method.instructions.add(new FieldInsnNode(Opcodes.GETFIELD, classNode.name, field.name, field.desc));
}
method.instructions.add(new InsnNode(returnType.getOpcode(Opcodes.IRETURN)));
}
/**
* Populate the bytecode instructions for a setter
*
* @param classNode
* @param method
* @param field
*/
private void populateSetter(ClassNode classNode, MethodNode method, FieldNode field)
{
Type[] argTypes = Type.getArgumentTypes(method.desc);
if (argTypes.length != 1)
{
throw new RuntimeException("Invalid setter! " + method.name + " must take exactly one argument");
}
Type argType = argTypes[0];
Type fieldType = Type.getType(field.desc);
if (!argType.equals(fieldType))
{
throw new RuntimeException("Incompatible types! Field type: " + fieldType + " Method type: " + argType);
}
boolean isStatic = (field.access & Opcodes.ACC_STATIC) != 0;
method.instructions.clear();
method.maxLocals = Bytecode.getFirstNonArgLocalIndex(method);
method.maxStack = fieldType.getSize();
if (isStatic)
{
method.instructions.add(new VarInsnNode(argType.getOpcode(Opcodes.ILOAD), 0));
method.instructions.add(new FieldInsnNode(Opcodes.PUTSTATIC, classNode.name, field.name, field.desc));
}
else
{
method.instructions.add(new VarInsnNode(Opcodes.ALOAD, 0));
method.instructions.add(new VarInsnNode(argType.getOpcode(Opcodes.ILOAD), 1));
method.instructions.add(new FieldInsnNode(Opcodes.PUTFIELD, classNode.name, field.name, field.desc));
}
method.instructions.add(new InsnNode(Opcodes.RETURN));
}
/**
* Populate the bytecode instructions for an invoker (proxy) method
*
* @param classNode
* @param method
* @param targetMethod
*/
private void populateInvoker(ClassNode classNode, MethodNode method, MethodNode targetMethod)
{
Type[] args = Type.getArgumentTypes(targetMethod.desc);
Type returnType = Type.getReturnType(targetMethod.desc);
boolean isStatic = (targetMethod.access & Opcodes.ACC_STATIC) != 0;
method.instructions.clear();
method.maxStack = (method.maxLocals = Bytecode.getFirstNonArgLocalIndex(method)) + 1;
if (isStatic)
{
Bytecode.loadArgs(args, method.instructions, 0);
method.instructions.add(new MethodInsnNode(Opcodes.INVOKESTATIC, classNode.name, targetMethod.name, targetMethod.desc, false));
}
else
{
method.instructions.add(new VarInsnNode(Opcodes.ALOAD, 0));
Bytecode.loadArgs(args, method.instructions, 1);
method.instructions.add(new MethodInsnNode(Opcodes.INVOKESPECIAL, classNode.name, targetMethod.name, targetMethod.desc, false));
}
method.instructions.add(new InsnNode(returnType.getOpcode(Opcodes.IRETURN)));
}
/**
* Populate bytecode instructions for a method which throws an exception
*
* @param classNode
* @param method
* @param exceptionType
* @param message
*/
private void injectException(ClassNode classNode, MethodNode method, String exceptionType, String message)
{
InsnList insns = method.instructions;
method.maxStack = 2;
insns.clear();
insns.add(new TypeInsnNode(Opcodes.NEW, exceptionType));
insns.add(new InsnNode(Opcodes.DUP));
insns.add(new LdcInsnNode(message));
insns.add(new MethodInsnNode(Opcodes.INVOKESPECIAL, exceptionType, "<init>", "(Ljava/lang/String;)V", false));
insns.add(new InsnNode(Opcodes.ATHROW));
}
/**
* Add a method from the template interface to the target class
*
* @param classNode
* @param method
*/
private boolean addMethodToClass(ClassNode classNode, MethodNode method)
{
MethodNode existingMethod = ByteCodeUtilities.findTargetMethod(classNode, method);
if (existingMethod != null) return false;
classNode.methods.add(method);
method.access = method.access & ~Opcodes.ACC_ABSTRACT;
return true;
}
}
protected static class Mapping extends Obf
{
protected Mapping(String seargeName, String obfName, String mcpName)
{
super(seargeName, obfName, mcpName);
}
}
/**
* List of accessors to inject
*/
private final List<AccessorInjection> accessors = new ArrayList<AccessorInjection>();
/**
* ctor
*/
public AccessorTransformer()
{
this.addAccessors();
}
/**
* @param interfaceName
*/
public void addAccessor(String interfaceName)
{
this.addAccessor(interfaceName, null);
}
/**
* Add an accessor to the accessors list
*
* @param interfaceName
* @param obfProvider
*/
public void addAccessor(String interfaceName, ObfProvider obfProvider)
{
try
{
this.accessors.add(new AccessorInjection(interfaceName, obfProvider));
}
catch (Exception ex)
{
LiteLoaderLogger.debug(ex);
}
}
/* (non-Javadoc)
* @see net.minecraft.launchwrapper.IClassTransformer
* #transform(java.lang.String, java.lang.String, byte[])
*/
@Override
public byte[] transform(String name, String transformedName, byte[] basicClass)
{
ClassNode classNode = null;
classNode = this.apply(name, transformedName, basicClass, classNode);
if (classNode != null)
{
this.postTransform(name, transformedName, classNode);
return this.writeClass(classNode);
}
return basicClass;
}
/**
* Apply this transformer, used when this transformer is acting as a
* delegate via another transformer (eg. an EventTransformer) and the parent
* transformer already has a ClassNode for the target class.
*
* @param name
* @param transformedName
* @param basicClass
* @param classNode
*/
public ClassNode apply(String name, String transformedName, byte[] basicClass, ClassNode classNode)
{
for (Iterator<AccessorInjection> iter = this.accessors.iterator(); iter.hasNext(); )
{
AccessorInjection accessor = iter.next();
Obf target = accessor.getTarget();
if (target.obf.equals(transformedName) || target.name.equals(transformedName))
{
LiteLoaderLogger.debug("[AccessorTransformer] Processing access injections in %s", transformedName);
if (classNode == null) classNode = this.readClass(basicClass, true);
accessor.apply(classNode);
iter.remove();
}
}
return classNode;
}
/**
* Subclasses should add their accessors here
*/
protected void addAccessors()
{
}
/**
* Called after transformation is applied, allows custom transforms to be
* performed by subclasses.
*
* @param name
* @param transformedName
* @param classNode
*/
protected void postTransform(String name, String transformedName, ClassNode classNode)
{
}
}