From 0e1e1bd3a470e44a79fb3c917477d6f865ff5257 Mon Sep 17 00:00:00 2001 From: zaaarf Date: Sat, 18 Mar 2023 19:30:31 +0100 Subject: feat: anonymous and inner class handling, implemented united @Find --- .../ftbsc/lll/exceptions/NotAProxyException.java | 21 +++ .../java/ftbsc/lll/processor/LilleroProcessor.java | 84 +++++----- .../java/ftbsc/lll/processor/tools/ASTUtils.java | 177 +++++++++++---------- .../ftbsc/lll/processor/tools/ArrayContainer.java | 38 +++++ 4 files changed, 190 insertions(+), 130 deletions(-) create mode 100644 src/main/java/ftbsc/lll/exceptions/NotAProxyException.java create mode 100644 src/main/java/ftbsc/lll/processor/tools/ArrayContainer.java (limited to 'src/main/java/ftbsc') diff --git a/src/main/java/ftbsc/lll/exceptions/NotAProxyException.java b/src/main/java/ftbsc/lll/exceptions/NotAProxyException.java new file mode 100644 index 0000000..4c2eeaa --- /dev/null +++ b/src/main/java/ftbsc/lll/exceptions/NotAProxyException.java @@ -0,0 +1,21 @@ +package ftbsc.lll.exceptions; + +import ftbsc.lll.processor.annotations.Find; +import ftbsc.lll.proxies.FieldProxy; +import ftbsc.lll.proxies.MethodProxy; + +/** + * Thrown when a method is annotated with {@link Find} but does not + * return a {@link MethodProxy} or a {@link FieldProxy} + */ +public class NotAProxyException extends RuntimeException { + + /** + * Constructs a exception for the specified method. + * @param parent the FQN of the class containing the method + * @param method the name of the method wrongly annotated + */ + public NotAProxyException(String parent, String method) { + super(String.format("Annotated method %s::%s does not return a proxy!", parent, method)); + } +} diff --git a/src/main/java/ftbsc/lll/processor/LilleroProcessor.java b/src/main/java/ftbsc/lll/processor/LilleroProcessor.java index 432738c..9d4900e 100644 --- a/src/main/java/ftbsc/lll/processor/LilleroProcessor.java +++ b/src/main/java/ftbsc/lll/processor/LilleroProcessor.java @@ -4,7 +4,9 @@ import com.squareup.javapoet.*; import ftbsc.lll.IInjector; import ftbsc.lll.exceptions.AmbiguousDefinitionException; import ftbsc.lll.exceptions.InvalidResourceException; +import ftbsc.lll.exceptions.NotAProxyException; import ftbsc.lll.processor.annotations.*; +import ftbsc.lll.processor.tools.ArrayContainer; import ftbsc.lll.processor.tools.obfuscation.ObfuscationMapper; import ftbsc.lll.proxies.FieldProxy; import ftbsc.lll.proxies.MethodProxy; @@ -154,8 +156,13 @@ public class LilleroProcessor extends AbstractProcessor { //find class information Patch patchAnn = cl.getAnnotation(Patch.class); String targetClassFQN = - findClassName(getClassFullyQualifiedName(patchAnn, Patch::value), this.mapper) - .replace('/', '.'); + findClassName( + getClassFullyQualifiedName( + patchAnn, + Patch::value, + getInnerName(patchAnn, Patch::innerClass, Patch::anonymousClassCounter) + ), this.mapper + ).replace('/', '.'); //find package information Element packageElement = cl.getEnclosingElement(); @@ -300,74 +307,59 @@ public class LilleroProcessor extends AbstractProcessor { } /** - * Finds any method annotated with {@link FindMethod} or {@link FindField} within the given - * class, and builds the {@link MethodSpec} necessary for building it. + * Finds any method annotated with {@link Find} within the given class, generates + * the {@link MethodSpec} necessary for building it. * @param cl the class to search * @return a {@link List} of method specs * @since 0.2.0 */ private List generateRequestedProxies(TypeElement cl, ObfuscationMapper mapper) { List generated = new ArrayList<>(); - findAnnotatedMethods(cl, FindMethod.class) + findAnnotatedMethods(cl, Find.class) .stream() .filter(m -> !m.getModifiers().contains(Modifier.STATIC)) //skip static stuff as we can't override it .filter(m -> !m.getModifiers().contains(Modifier.FINAL)) //in case someone is trying to be funny .forEach(m -> { - ExecutableElement targetMethod = (ExecutableElement) findMemberFromStub(m, processingEnv); + boolean isMethod = isMethodProxyStub(m); + Element target = findMemberFromStub(m, processingEnv); + MethodSpec.Builder b = MethodSpec.overriding(m); - String targetParentFQN = findClassName(((TypeElement) targetMethod.getEnclosingElement()).getQualifiedName().toString(), mapper); + String targetParentFQN = findClassName(((TypeElement) target.getEnclosingElement()).getQualifiedName().toString(), mapper); + String methodDescriptor = isMethod ? descriptorFromExecutableElement((ExecutableElement) target) : null; b.addStatement("$T bd = $T.builder($S)", MethodProxy.Builder.class, MethodProxy.class, - findMemberName(targetParentFQN, targetMethod.getSimpleName().toString(), descriptorFromExecutableElement(targetMethod), mapper) + findMemberName(targetParentFQN, target.getSimpleName().toString(), methodDescriptor, mapper) ); b.addStatement("bd.setParent($S)", targetParentFQN); - for(Modifier mod : targetMethod.getModifiers()) + for(Modifier mod : target.getModifiers()) b.addStatement("bd.addModifier($L)", mapModifier(mod)); - for(VariableElement p : targetMethod.getParameters()) { - if(p.asType().getKind().isPrimitive()) - b.addStatement("bd.addParameter($T.class)", p.asType()); - else b.addStatement("bd.addParameter($S, $L)", getInnermostComponentType(p.asType()), getArrayLevel(p.asType())); + if(isMethod) { + ExecutableElement targetMethod = (ExecutableElement) target; + for(VariableElement p : targetMethod.getParameters()) { + ArrayContainer param = new ArrayContainer(p.asType()); + b.addStatement( + "bd.addParameter($S, $L)", + param.innermostComponent, + param.arrayLevel + ); + } + ArrayContainer ret = new ArrayContainer(targetMethod.getReturnType()); + b.addStatement( + "bd.setReturnType($S, $L)", + ret.innermostComponent, + ret.arrayLevel + ); + } else { + ArrayContainer arr = new ArrayContainer(target.asType()); + b.addStatement("bd.setType($S, $L)", arr.innermostComponent, arr.arrayLevel); } - if(targetMethod.getReturnType().getKind().isPrimitive()) - b.addStatement("bd.setReturnType($T.class)", targetMethod.getReturnType()); - else b.addStatement("bd.setReturnType($S, $L)", getInnermostComponentType(targetMethod.getReturnType()), getArrayLevel(targetMethod.getReturnType())); - - b.addStatement("return bd.build()"); - - generated.add(b.build()); - }); - findAnnotatedMethods(cl, FindField.class) - .stream() - .filter(m -> !m.getModifiers().contains(Modifier.STATIC)) - .filter(m -> !m.getModifiers().contains(Modifier.FINAL)) - .forEach(m -> { - VariableElement targetField = (VariableElement) findMemberFromStub(m, processingEnv); - MethodSpec.Builder b = MethodSpec.overriding(m); - - String targetParentFQN = findClassName(((TypeElement) targetField.getEnclosingElement()).getQualifiedName().toString(), mapper); - - b.addStatement("$T bd = $T.builder($S)", - FieldProxy.Builder.class, - FieldProxy.class, - findMemberName(targetParentFQN, targetField.getSimpleName().toString(), null, mapper) - ); - - b.addStatement("bd.setParent($S)", ((TypeElement) targetField.getEnclosingElement()).getQualifiedName().toString()); - - for(Modifier mod : targetField.getModifiers()) - b.addStatement("bd.addModifier($L)", mapModifier(mod)); - - if(targetField.asType().getKind().isPrimitive()) - b.addStatement("bd.setType($T.class)", targetField.asType()); - else b.addStatement("bd.setType($S, $L)", getInnermostComponentType(targetField.asType()), getArrayLevel(targetField.asType())); - b.addStatement("return bd.build()"); generated.add(b.build()); diff --git a/src/main/java/ftbsc/lll/processor/tools/ASTUtils.java b/src/main/java/ftbsc/lll/processor/tools/ASTUtils.java index d492382..72506a0 100644 --- a/src/main/java/ftbsc/lll/processor/tools/ASTUtils.java +++ b/src/main/java/ftbsc/lll/processor/tools/ASTUtils.java @@ -3,12 +3,14 @@ package ftbsc.lll.processor.tools; import com.squareup.javapoet.*; import ftbsc.lll.exceptions.AmbiguousDefinitionException; import ftbsc.lll.exceptions.MappingNotFoundException; +import ftbsc.lll.exceptions.NotAProxyException; import ftbsc.lll.exceptions.TargetNotFoundException; -import ftbsc.lll.processor.annotations.FindField; -import ftbsc.lll.processor.annotations.FindMethod; +import ftbsc.lll.processor.annotations.Find; import ftbsc.lll.processor.annotations.Patch; import ftbsc.lll.processor.annotations.Target; import ftbsc.lll.processor.tools.obfuscation.ObfuscationMapper; +import ftbsc.lll.proxies.FieldProxy; +import ftbsc.lll.proxies.MethodProxy; import javax.annotation.processing.ProcessingEnvironment; import javax.lang.model.element.*; @@ -82,46 +84,45 @@ public class ASTUtils { } /** - * Calculates the array nesting level for a {@link TypeMirror}. - * @param t the type mirror to get it for - * @return the array nesting level + * Safely extracts a {@link Class} from an annotation and gets its fully qualified name. + * @param ann the annotation containing the class + * @param parentFunction the annotation function returning the class + * @param innerName a string containing the inner class name or anonymous class number, may be null + * @param the type of the annotation carrying the information + * @return the fully qualified name of the given class * @since 0.3.0 */ - public static int getArrayLevel(TypeMirror t) { - int arrayLevel = 0; - while(t.getKind() == TypeKind.ARRAY) { - t = ((ArrayType) t).getComponentType(); - arrayLevel++; + public static String getClassFullyQualifiedName(T ann, Function> parentFunction, String innerName) { + String fqn; + try { + fqn = parentFunction.apply(ann).getCanonicalName(); + } catch(MirroredTypeException e) { + fqn = e.getTypeMirror().toString(); } - return arrayLevel; + if(innerName != null) + fqn = String.format("%s$%s", fqn, innerName); + return fqn; } /** - * Calculates the array nesting level for a {@link TypeMirror}. - * @param t the type mirror to get it for - * @return the array nesting level - * @since 0.3.0 - */ - public static TypeMirror getInnermostComponentType(TypeMirror t) { - while(t.getKind() == TypeKind.ARRAY) - t = ((ArrayType) t).getComponentType(); - return t; - } - - /** - * Safely extracts a {@link Class} from an annotation and gets its fully qualified name. + * Extracts * @param ann the annotation containing the class - * @param fun the annotation function returning the class + * @param innerClassFunction the annotation function returning the inner class name + * @param anonymousCounterFunction the annotation function returning the anonymous class counter * @param the type of the annotation carrying the information * @return the fully qualified name of the given class * @since 0.3.0 */ - public static String getClassFullyQualifiedName(T ann, Function> fun) { - try { - return fun.apply(ann).getCanonicalName(); - } catch(MirroredTypeException e) { - return e.getTypeMirror().toString(); + public static String getInnerName(T ann, Function innerClassFunction, Function anonymousCounterFunction) { + String inner = null; + if(!innerClassFunction.apply(ann).equals("")) + inner = innerClassFunction.apply(ann); + if(anonymousCounterFunction.apply(ann) != 0) { + if(inner != null) + throw new AmbiguousDefinitionException(String.format("Unclear inner class, is it %s or %d?", inner, anonymousCounterFunction.apply(ann))); + else inner = anonymousCounterFunction.apply(ann).toString(); } + return inner; } /** @@ -166,18 +167,27 @@ public class ASTUtils { * Finds the class name and maps it to the correct format. * @param patchAnn the {@link Patch} annotation containing target class info * @param finderAnn an annotation containing metadata about the target, may be null - * @param parentFun the function to get the parent from the finderAnn * @return the fully qualified class name * @since 0.3.0 */ - private static String findClassName(Patch patchAnn, T finderAnn, Function> parentFun) { + private static String findClassName(Patch patchAnn, Find finderAnn) { String fullyQualifiedName; if(finderAnn != null) { - fullyQualifiedName = getClassFullyQualifiedName(finderAnn, parentFun); + fullyQualifiedName = + getClassFullyQualifiedName( + finderAnn, + Find::parent, + getInnerName(finderAnn, Find::parentInnerClass, Find::parentAnonymousClassCounter) + ); if(!fullyQualifiedName.equals("java.lang.Object")) return findClassName(fullyQualifiedName, null); } - fullyQualifiedName = getClassFullyQualifiedName(patchAnn, Patch::value); + fullyQualifiedName = + getClassFullyQualifiedName( + patchAnn, + Patch::value, + getInnerName(patchAnn, Patch::innerClass, Patch::anonymousClassCounter) + ); return findClassName(fullyQualifiedName, null); } @@ -199,32 +209,32 @@ public class ASTUtils { } /** - * Finds a method given name, container and descriptor. - * @param parentFQN the fully qualified name of the parent class of the method + * Finds a member given the name, the container class and (if it's a method) the descriptor. + * @param parentFQN the fully qualified name of the parent class * @param name the name to search for - * @param descr the descriptor to search for - * @param strict whether the search should be strict (see {@link Target#strict()} for more info) + * @param descr the descriptor to search for, or null if it's not a method + * @param strict whether the search should be strict (see {@link Target#strict()} for more info), + * only applies to method searches + * @param field whether the member being searched is a field * @param env the {@link ProcessingEnvironment} to perform the operation in - * @return the desired method, if it exists + * @return the desired member, if it exists * @throws AmbiguousDefinitionException if it finds more than one candidate * @throws TargetNotFoundException if it finds no valid candidate * @since 0.3.0 */ - private static ExecutableElement findMethod(String parentFQN, String name, String descr, boolean strict, ProcessingEnvironment env) { + private static Element findMember(String parentFQN, String name, String descr, boolean strict, boolean field, ProcessingEnvironment env) { TypeElement parent = env.getElementUtils().getTypeElement(parentFQN); if(parent == null) throw new AmbiguousDefinitionException(String.format("Could not find parent class %s!", parentFQN)); - //try to find by name - List candidates = parent.getEnclosedElements() + List candidates = parent.getEnclosedElements() .stream() - .filter(e -> e instanceof ExecutableElement) - .map(e -> (ExecutableElement) e) + .filter(e -> (field && e instanceof VariableElement) || e instanceof ExecutableElement) .filter(e -> e.getSimpleName().contentEquals(name)) .collect(Collectors.toList()); if(candidates.size() == 0) throw new TargetNotFoundException(String.format("%s %s", name, descr)); - if(candidates.size() == 1 && !strict) + if(candidates.size() == 1 && (!strict || field)) return candidates.get(0); if(descr == null) { throw new AmbiguousDefinitionException( @@ -232,6 +242,7 @@ public class ASTUtils { ); } else { candidates = candidates.stream() + .map(e -> (ExecutableElement) e) .filter(strict ? c -> descr.equals(descriptorFromExecutableElement(c)) : c -> descr.split("\\)")[0].equalsIgnoreCase(descriptorFromExecutableElement(c).split("\\)")[0]) @@ -248,7 +259,7 @@ public class ASTUtils { /** * Finds the real class member (field or method) corresponding to a stub annotated with - * {@link Target} or {@link FindMethod} or {@link FindField}. + * {@link Target} or {@link Find}. * @param stub the {@link ExecutableElement} for the stub * @param env the {@link ProcessingEnvironment} to perform the operation in * @return the {@link Element} corresponding to the method or field @@ -259,44 +270,42 @@ public class ASTUtils { public static Element findMemberFromStub(ExecutableElement stub, ProcessingEnvironment env) { //the parent always has a @Patch annotation Patch patchAnn = stub.getEnclosingElement().getAnnotation(Patch.class); - //there should ever only be one of these + //there should ever only be one of these two Target targetAnn = stub.getAnnotation(Target.class); //if this is null strict mode is always disabled - FindMethod findMethodAnn = stub.getAnnotation(FindMethod.class); //this may be null, it means no fallback info - FindField findFieldAnn = stub.getAnnotation(FindField.class); - String parentFQN, memberName; - if(findFieldAnn == null) { //methods - parentFQN = findClassName(patchAnn, findMethodAnn, FindMethod::parent); - String methodDescriptor = - findMethodAnn != null - ? methodDescriptorFromParams(findMethodAnn, FindMethod::params, env.getElementUtils()) - : descriptorFromExecutableElement(stub); - memberName = - findMethodAnn != null && !findMethodAnn.name().equals("") - ? findMethodAnn.name() - : stub.getSimpleName().toString(); - return findMethod( - parentFQN, - memberName, - methodDescriptor, - targetAnn != null && targetAnn.strict(), - env - ); - } else { //fields - parentFQN = findClassName(patchAnn, findFieldAnn, FindField::parent); - memberName = findFieldAnn.name().equals("") - ? stub.getSimpleName().toString() - : findFieldAnn.name(); - TypeElement parent = env.getElementUtils().getTypeElement(parentFQN); - List candidates = - parent.getEnclosedElements() - .stream() - .filter(f -> f instanceof VariableElement) - .filter(f -> f.getSimpleName().contentEquals(memberName)) - .map(f -> (VariableElement) f) - .collect(Collectors.toList()); - if(candidates.size() == 0) - throw new TargetNotFoundException(stub.getSimpleName().toString()); - else return candidates.get(0); //there can only ever be one - } + Find findAnn = stub.getAnnotation(Find.class); //this may be null, it means no fallback info + String parentFQN = findClassName(patchAnn, findAnn); + String methodDescriptor = + findAnn != null + ? methodDescriptorFromParams(findAnn, Find::params, env.getElementUtils()) + : descriptorFromExecutableElement(stub); + String memberName = + findAnn != null && !findAnn.name().equals("") + ? findAnn.name() + : stub.getSimpleName().toString(); + return findMember( + parentFQN, + memberName, + methodDescriptor, + targetAnn != null && targetAnn.strict(), + !isMethodProxyStub(stub), + env + ); + } + + /** + * Utility method for finding out what type of proxy a method is. + * It will fail if the return type is not a known type of proxy. + * @param m the annotated {@link ExecutableElement} + * @return whether it returns a {@link MethodProxy} or a {@link FieldProxy} + * @throws NotAProxyException if it's neither + * @since 0.4.0 + */ + public static boolean isMethodProxyStub(ExecutableElement m) { + String returnTypeFQN = m.getReturnType().toString(); + if(returnTypeFQN.equals("ftbsc.lll.proxies.FieldProxy")) + return false; + else if(returnTypeFQN.equals("ftbsc.lll.proxies.MethodProxy")) + return true; + else throw new NotAProxyException(m.getEnclosingElement().getSimpleName().toString(), m.getSimpleName().toString()); } } diff --git a/src/main/java/ftbsc/lll/processor/tools/ArrayContainer.java b/src/main/java/ftbsc/lll/processor/tools/ArrayContainer.java new file mode 100644 index 0000000..c32a621 --- /dev/null +++ b/src/main/java/ftbsc/lll/processor/tools/ArrayContainer.java @@ -0,0 +1,38 @@ +package ftbsc.lll.processor.tools; + +import javax.lang.model.type.ArrayType; +import javax.lang.model.type.TypeKind; +import javax.lang.model.type.TypeMirror; + +/** + * Utility class that extrapolates information from a {@link TypeMirror}, + * making it considerably easier to get informations about an + * array. + * @since 0.4.0 + */ +public class ArrayContainer { + /** + * The nesting level of the array - a type who is not an array will have 0. + */ + public final int arrayLevel; + + /** + * The innermost component of the array, corresponding to the type of the base + * component. + */ + public final TypeMirror innermostComponent; + + /** + * Creates a new {@link ArrayContainer} from a {@link TypeMirror}. + * @param t the {@link TypeMirror} representing the type. + */ + public ArrayContainer(TypeMirror t) { + int arrayLevel = 0; + while(t.getKind() == TypeKind.ARRAY) { + t = ((ArrayType) t).getComponentType(); + arrayLevel++; + } + this.arrayLevel = arrayLevel; + this.innermostComponent = t; + } +} -- cgit v1.2.3-56-ga3b1