From cb8823eb0b446d5c1b9b580e5578866e691771d8 Mon Sep 17 00:00:00 2001 From: liach Date: Wed, 15 May 2019 22:03:13 -0700 Subject: Feature/weave (#138) * Add weave/stitch style command system to enigma Also fixed divide by zero stupidity Signed-off-by: liach * Add tests for package access index and command Signed-off-by: liach * Minor tweaks Signed-off-by: liach --- src/main/java/cuchaz/enigma/CommandMain.java | 248 +++++---------------- .../analysis/index/PackageVisibilityIndex.java | 10 +- .../enigma/analysis/index/ReferenceIndex.java | 3 +- .../enigma/command/CheckMappingsCommand.java | 62 ++++++ src/main/java/cuchaz/enigma/command/Command.java | 140 ++++++++++++ .../enigma/command/ConvertMappingsCommand.java | 47 ++++ .../cuchaz/enigma/command/DecompileCommand.java | 33 +++ .../cuchaz/enigma/command/DeobfuscateCommand.java | 33 +++ .../cuchaz/enigma/PackageVisibilityIndexTest.java | 55 +++++ .../enigma/command/CheckMappingsCommandTest.java | 20 ++ .../cuchaz/enigma/inputs/packageAccess/Base.java | 7 + .../inputs/packageAccess/SamePackageChild.java | 12 + .../packageAccess/sub/OtherPackageChild.java | 14 ++ .../correctMappings/base/Base.mapping | 1 + .../packageAccess/correctMappings/base/One.mapping | 1 + .../packageAccess/correctMappings/two/Two.mapping | 1 + .../packageAccess/wrongMappings/base/Base.mapping | 1 + .../packageAccess/wrongMappings/one/One.mapping | 1 + .../packageAccess/wrongMappings/two/Two.mapping | 1 + 19 files changed, 488 insertions(+), 202 deletions(-) create mode 100644 src/main/java/cuchaz/enigma/command/CheckMappingsCommand.java create mode 100644 src/main/java/cuchaz/enigma/command/Command.java create mode 100644 src/main/java/cuchaz/enigma/command/ConvertMappingsCommand.java create mode 100644 src/main/java/cuchaz/enigma/command/DecompileCommand.java create mode 100644 src/main/java/cuchaz/enigma/command/DeobfuscateCommand.java create mode 100644 src/test/java/cuchaz/enigma/PackageVisibilityIndexTest.java create mode 100644 src/test/java/cuchaz/enigma/command/CheckMappingsCommandTest.java create mode 100644 src/test/java/cuchaz/enigma/inputs/packageAccess/Base.java create mode 100644 src/test/java/cuchaz/enigma/inputs/packageAccess/SamePackageChild.java create mode 100644 src/test/java/cuchaz/enigma/inputs/packageAccess/sub/OtherPackageChild.java create mode 100644 src/test/resources/packageAccess/correctMappings/base/Base.mapping create mode 100644 src/test/resources/packageAccess/correctMappings/base/One.mapping create mode 100644 src/test/resources/packageAccess/correctMappings/two/Two.mapping create mode 100644 src/test/resources/packageAccess/wrongMappings/base/Base.mapping create mode 100644 src/test/resources/packageAccess/wrongMappings/one/One.mapping create mode 100644 src/test/resources/packageAccess/wrongMappings/two/Two.mapping (limited to 'src') diff --git a/src/main/java/cuchaz/enigma/CommandMain.java b/src/main/java/cuchaz/enigma/CommandMain.java index db4fd125..5b250872 100644 --- a/src/main/java/cuchaz/enigma/CommandMain.java +++ b/src/main/java/cuchaz/enigma/CommandMain.java @@ -11,43 +11,45 @@ package cuchaz.enigma; -import cuchaz.enigma.analysis.index.JarIndex; -import cuchaz.enigma.translation.mapping.EntryMapping; -import cuchaz.enigma.translation.mapping.serde.MappingFormat; -import cuchaz.enigma.translation.mapping.tree.EntryTree; -import cuchaz.enigma.translation.representation.entry.ClassEntry; - -import java.io.File; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; +import cuchaz.enigma.command.*; + +import java.util.LinkedHashMap; import java.util.Locale; -import java.util.Set; -import java.util.jar.JarFile; -import java.util.stream.Collectors; +import java.util.Map; public class CommandMain { - public static void main(String[] args) throws Exception { + private static final Map COMMANDS = new LinkedHashMap<>(); + + public static void main(String... args) throws Exception { try { // process the command - String command = getArg(args, 0, "command", true).toLowerCase(Locale.ROOT); - switch (command) { - case "deobfuscate": - deobfuscate(args); - break; - case "decompile": - decompile(args); - break; - case "convertmappings": - convertMappings(args); - break; - case "checkmappings": - checkMappings(args); - break; - default: - throw new IllegalArgumentException("Command not recognized: " + command); + if (args.length < 1) + throw new IllegalArgumentException("Requires a command"); + String command = args[0].toLowerCase(Locale.ROOT); + + Command cmd = COMMANDS.get(command); + if (cmd == null) + throw new IllegalArgumentException("Command not recognized: " + command); + + if (!cmd.isValidArgument(args.length - 1)) { + throw new CommandHelpException(cmd); + } + + String[] cmdArgs = new String[args.length - 1]; + System.arraycopy(args, 1, cmdArgs, 0, args.length - 1); + + try { + cmd.run(cmdArgs); + } catch (Exception ex) { + throw new CommandHelpException(cmd, ex); } + } catch (CommandHelpException ex) { + System.err.println(ex.getMessage()); + System.out.println(String.format("%s - %s", Constants.NAME, Constants.VERSION)); + System.out.println("Command " + ex.command.name + " has encountered an error! Usage:"); + printHelp(ex.command); + System.exit(1); } catch (IllegalArgumentException ex) { System.err.println(ex.getMessage()); printHelp(); @@ -60,187 +62,41 @@ public class CommandMain { System.out.println("Usage:"); System.out.println("\tjava -cp enigma.jar cuchaz.enigma.CommandMain "); System.out.println("\twhere is one of:"); - System.out.println("\t\tdeobfuscate []"); - System.out.println("\t\tdecompile []"); - System.out.println("\t\tconvertmappings "); - System.out.println("\t\tcheckmappings "); - } - - private static void decompile(String[] args) throws Exception { - File fileJarIn = getReadableFile(getArg(args, 1, "in jar", true)); - File fileJarOut = getWritableFolder(getArg(args, 2, "out folder", true)); - Path fileMappings = getReadablePath(getArg(args, 3, "mappings file", false)); - Deobfuscator deobfuscator = getDeobfuscator(fileMappings, new JarFile(fileJarIn)); - deobfuscator.writeSources(fileJarOut.toPath(), new ConsoleProgressListener()); - } - - private static void deobfuscate(String[] args) throws Exception { - File fileJarIn = getReadableFile(getArg(args, 1, "in jar", true)); - File fileJarOut = getWritableFile(getArg(args, 2, "out jar", true)); - Path fileMappings = getReadablePath(getArg(args, 3, "mappings file", false)); - Deobfuscator deobfuscator = getDeobfuscator(fileMappings, new JarFile(fileJarIn)); - deobfuscator.writeTransformedJar(fileJarOut, new ConsoleProgressListener()); - } - private static Deobfuscator getDeobfuscator(Path fileMappings, JarFile jar) throws Exception { - System.out.println("Reading jar..."); - Deobfuscator deobfuscator = new Deobfuscator(jar); - if (fileMappings != null) { - System.out.println("Reading mappings..."); - EntryTree mappings = chooseEnigmaFormat(fileMappings).read(fileMappings, new ConsoleProgressListener()); - deobfuscator.setMappings(mappings); + for (Command command : COMMANDS.values()) { + printHelp(command); } - return deobfuscator; } - private static void convertMappings(String[] args) throws Exception { - Path fileMappings = getReadablePath(getArg(args, 1, "enigma mapping", true)); - File result = getWritableFile(getArg(args, 2, "enigma mapping", true)); - String name = getArg(args, 3, "format desc", true); - MappingFormat saveFormat; - try { - saveFormat = MappingFormat.valueOf(name.toUpperCase(Locale.ROOT)); - } catch (IllegalArgumentException e) { - throw new IllegalArgumentException(name + "is not a valid mapping format!"); - } - - System.out.println("Reading mappings..."); - - MappingFormat readFormat = chooseEnigmaFormat(fileMappings); - EntryTree mappings = readFormat.read(fileMappings, new ConsoleProgressListener()); - System.out.println("Saving new mappings..."); - - saveFormat.write(mappings, result.toPath(), new ConsoleProgressListener()); + private static void printHelp(Command command) { + System.out.println("\t\t" + command.name + " " + command.getUsage()); } - private static void checkMappings(String[] args) throws Exception { - File fileJarIn = getReadableFile(getArg(args, 1, "in jar", true)); - Path fileMappings = getReadablePath(getArg(args, 2, "enigma mapping", true)); - - System.out.println("Reading JAR..."); - Deobfuscator deobfuscator = new Deobfuscator(new JarFile(fileJarIn)); - System.out.println("Reading mappings..."); - - MappingFormat format = chooseEnigmaFormat(fileMappings); - EntryTree mappings = format.read(fileMappings, ProgressListener.VOID); - deobfuscator.setMappings(mappings); - - JarIndex idx = deobfuscator.getJarIndex(); - - boolean error = false; - - for (Set partition : idx.getPackageVisibilityIndex().getPartitions()) { - long packages = partition.stream().map(deobfuscator.getMapper()::deobfuscate).map(ClassEntry::getPackageName).distinct().count(); - if (packages > 1) { - error = true; - System.err.println("ERROR: Must be in one package:\n" + partition.stream().map(deobfuscator.getMapper()::deobfuscate).map(ClassEntry::toString).sorted().collect(Collectors.joining("\n"))); - } - } - - if (error) { - throw new Exception("Access violations detected"); + private static void register(Command command) { + Command old = COMMANDS.put(command.name, command); + if (old != null) { + System.err.println("Command " + old + " with name " + command.name + " has been substituted by " + command); } } - private static MappingFormat chooseEnigmaFormat(Path path) { - if (Files.isDirectory(path)) { - return MappingFormat.ENIGMA_DIRECTORY; - } else { - return MappingFormat.ENIGMA_FILE; - } - } - - private static String getArg(String[] args, int i, String name, boolean required) { - if (i >= args.length) { - if (required) { - throw new IllegalArgumentException(name + " is required"); - } else { - return null; - } - } - return args[i]; - } - - private static File getWritableFile(String path) { - if (path == null) { - return null; - } - File file = new File(path).getAbsoluteFile(); - File dir = file.getParentFile(); - if (dir == null) { - throw new IllegalArgumentException("Cannot write file: " + path); - } - // quick fix to avoid stupid stuff in Gradle code - if (!dir.isDirectory()) { - dir.mkdirs(); - } - return file; - } - - private static File getWritableFolder(String path) { - if (path == null) { - return null; - } - File dir = new File(path).getAbsoluteFile(); - if (!dir.exists()) { - throw new IllegalArgumentException("Cannot write to folder: " + dir); - } - return dir; + static { + register(new DeobfuscateCommand()); + register(new DecompileCommand()); + register(new ConvertMappingsCommand()); + register(new CheckMappingsCommand()); } - private static File getReadableFile(String path) { - if (path == null) { - return null; - } - File file = new File(path).getAbsoluteFile(); - if (!file.exists()) { - throw new IllegalArgumentException("Cannot find file: " + file.getAbsolutePath()); - } - return file; - } + private static final class CommandHelpException extends IllegalArgumentException { - private static Path getReadablePath(String path) { - if (path == null) { - return null; - } - Path file = Paths.get(path).toAbsolutePath(); - if (!Files.exists(file)) { - throw new IllegalArgumentException("Cannot find file: " + file.toString()); - } - return file; - } + final Command command; - public static class ConsoleProgressListener implements ProgressListener { - - private static final int ReportTime = 5000; // 5s - - private int totalWork; - private long startTime; - private long lastReportTime; - - @Override - public void init(int totalWork, String title) { - this.totalWork = totalWork; - this.startTime = System.currentTimeMillis(); - this.lastReportTime = this.startTime; - System.out.println(title); + CommandHelpException(Command command) { + this.command = command; } - @Override - public void step(int numDone, String message) { - long now = System.currentTimeMillis(); - boolean isLastUpdate = numDone == this.totalWork; - boolean shouldReport = isLastUpdate || now - this.lastReportTime > ReportTime; - - if (shouldReport) { - int percent = numDone * 100 / this.totalWork; - System.out.println(String.format("\tProgress: %3d%%", percent)); - this.lastReportTime = now; - } - if (isLastUpdate) { - double elapsedSeconds = (now - this.startTime) / 1000.0; - System.out.println(String.format("Finished in %.1f seconds", elapsedSeconds)); - } + CommandHelpException(Command command, Throwable cause) { + super(cause); + this.command = command; } } } diff --git a/src/main/java/cuchaz/enigma/analysis/index/PackageVisibilityIndex.java b/src/main/java/cuchaz/enigma/analysis/index/PackageVisibilityIndex.java index 9e9115fe..da28ac41 100644 --- a/src/main/java/cuchaz/enigma/analysis/index/PackageVisibilityIndex.java +++ b/src/main/java/cuchaz/enigma/analysis/index/PackageVisibilityIndex.java @@ -11,7 +11,7 @@ import cuchaz.enigma.translation.representation.entry.*; import java.util.*; public class PackageVisibilityIndex implements JarIndexer { - private static boolean isPackageVisibleOnlyRef(AccessFlags entryAcc, EntryReference ref, InheritanceIndex inheritanceIndex) { + private static boolean requiresSamePackage(AccessFlags entryAcc, EntryReference ref, InheritanceIndex inheritanceIndex) { if (entryAcc.isPublic()) return false; if (entryAcc.isProtected()) { Set callerAncestors = inheritanceIndex.getAncestors(ref.context.getContainingClass()); @@ -43,7 +43,7 @@ public class PackageVisibilityIndex implements JarIndexer { AccessFlags entryAcc = entryIndex.getFieldAccess(entry); if (!entryAcc.isPublic() && !entryAcc.isPrivate()) { for (EntryReference ref : referenceIndex.getReferencesToField(entry)) { - if (isPackageVisibleOnlyRef(entryAcc, ref, inheritanceIndex)) { + if (requiresSamePackage(entryAcc, ref, inheritanceIndex)) { addConnection(ref.entry.getContainingClass(), ref.context.getContainingClass()); } } @@ -54,7 +54,7 @@ public class PackageVisibilityIndex implements JarIndexer { AccessFlags entryAcc = entryIndex.getMethodAccess(entry); if (!entryAcc.isPublic() && !entryAcc.isPrivate()) { for (EntryReference ref : referenceIndex.getReferencesToMethod(entry)) { - if (isPackageVisibleOnlyRef(entryAcc, ref, inheritanceIndex)) { + if (requiresSamePackage(entryAcc, ref, inheritanceIndex)) { addConnection(ref.entry.getContainingClass(), ref.context.getContainingClass()); } } @@ -65,13 +65,13 @@ public class PackageVisibilityIndex implements JarIndexer { AccessFlags entryAcc = entryIndex.getClassAccess(entry); if (!entryAcc.isPublic() && !entryAcc.isPrivate()) { for (EntryReference ref : referenceIndex.getFieldTypeReferencesToClass(entry)) { - if (isPackageVisibleOnlyRef(entryAcc, ref, inheritanceIndex)) { + if (requiresSamePackage(entryAcc, ref, inheritanceIndex)) { addConnection(ref.entry.getContainingClass(), ref.context.getContainingClass()); } } for (EntryReference ref : referenceIndex.getMethodTypeReferencesToClass(entry)) { - if (isPackageVisibleOnlyRef(entryAcc, ref, inheritanceIndex)) { + if (requiresSamePackage(entryAcc, ref, inheritanceIndex)) { addConnection(ref.entry.getContainingClass(), ref.context.getContainingClass()); } } diff --git a/src/main/java/cuchaz/enigma/analysis/index/ReferenceIndex.java b/src/main/java/cuchaz/enigma/analysis/index/ReferenceIndex.java index 6764ac0c..04306bd9 100644 --- a/src/main/java/cuchaz/enigma/analysis/index/ReferenceIndex.java +++ b/src/main/java/cuchaz/enigma/analysis/index/ReferenceIndex.java @@ -92,7 +92,8 @@ public class ReferenceIndex implements JarIndexer { } private , C extends Entry> Multimap> remapReferencesTo(JarIndex index, Multimap> multimap) { - Multimap> resolved = HashMultimap.create(multimap.keySet().size(), multimap.size() / multimap.keySet().size()); + final int keySetSize = multimap.keySet().size(); + Multimap> resolved = HashMultimap.create(keySetSize, keySetSize == 0 ? 0 : multimap.size() / keySetSize); for (Map.Entry> entry : multimap.entries()) { resolved.put(remap(index, entry.getKey()), remap(index, entry.getValue())); } diff --git a/src/main/java/cuchaz/enigma/command/CheckMappingsCommand.java b/src/main/java/cuchaz/enigma/command/CheckMappingsCommand.java new file mode 100644 index 00000000..7ec7679c --- /dev/null +++ b/src/main/java/cuchaz/enigma/command/CheckMappingsCommand.java @@ -0,0 +1,62 @@ +package cuchaz.enigma.command; + +import cuchaz.enigma.Deobfuscator; +import cuchaz.enigma.ProgressListener; +import cuchaz.enigma.analysis.index.JarIndex; +import cuchaz.enigma.translation.mapping.EntryMapping; +import cuchaz.enigma.translation.mapping.serde.MappingFormat; +import cuchaz.enigma.translation.mapping.tree.EntryTree; +import cuchaz.enigma.translation.representation.entry.ClassEntry; + +import java.io.File; +import java.nio.file.Path; +import java.util.Set; +import java.util.jar.JarFile; +import java.util.stream.Collectors; + +public class CheckMappingsCommand extends Command { + + public CheckMappingsCommand() { + super("checkmappings"); + } + + @Override + public String getUsage() { + return " "; + } + + @Override + public boolean isValidArgument(int length) { + return length == 2; + } + + @Override + public void run(String... args) throws Exception { + File fileJarIn = getReadableFile(getArg(args, 0, "in jar", true)); + Path fileMappings = getReadablePath(getArg(args, 1, "mappings file", true)); + + System.out.println("Reading JAR..."); + Deobfuscator deobfuscator = new Deobfuscator(new JarFile(fileJarIn)); + System.out.println("Reading mappings..."); + + MappingFormat format = chooseEnigmaFormat(fileMappings); + EntryTree mappings = format.read(fileMappings, ProgressListener.VOID); + deobfuscator.setMappings(mappings); + + JarIndex idx = deobfuscator.getJarIndex(); + + boolean error = false; + + for (Set partition : idx.getPackageVisibilityIndex().getPartitions()) { + long packages = partition.stream().map(deobfuscator.getMapper()::deobfuscate).map(ClassEntry::getPackageName).distinct().count(); + if (packages > 1) { + error = true; + System.err.println("ERROR: Must be in one package:\n" + partition.stream().map(deobfuscator.getMapper()::deobfuscate).map(ClassEntry::toString).sorted().collect(Collectors.joining("\n"))); + } + } + + if (error) { + throw new IllegalStateException("Errors in package visibility detected, see SysErr above"); + } + } +} diff --git a/src/main/java/cuchaz/enigma/command/Command.java b/src/main/java/cuchaz/enigma/command/Command.java new file mode 100644 index 00000000..b107fb61 --- /dev/null +++ b/src/main/java/cuchaz/enigma/command/Command.java @@ -0,0 +1,140 @@ +package cuchaz.enigma.command; + +import cuchaz.enigma.Deobfuscator; +import cuchaz.enigma.ProgressListener; +import cuchaz.enigma.translation.mapping.EntryMapping; +import cuchaz.enigma.translation.mapping.serde.MappingFormat; +import cuchaz.enigma.translation.mapping.tree.EntryTree; + +import java.io.File; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.jar.JarFile; + +public abstract class Command { + public final String name; + + protected Command(String name) { + this.name = name; + } + + public abstract String getUsage(); + + public abstract boolean isValidArgument(int length); + + public abstract void run(String... args) throws Exception; + + protected static Deobfuscator getDeobfuscator(Path fileMappings, JarFile jar) throws Exception { + System.out.println("Reading jar..."); + Deobfuscator deobfuscator = new Deobfuscator(jar); + if (fileMappings != null) { + System.out.println("Reading mappings..."); + EntryTree mappings = chooseEnigmaFormat(fileMappings).read(fileMappings, new ConsoleProgressListener()); + deobfuscator.setMappings(mappings); + } + return deobfuscator; + } + + protected static MappingFormat chooseEnigmaFormat(Path path) { + if (Files.isDirectory(path)) { + return MappingFormat.ENIGMA_DIRECTORY; + } else { + return MappingFormat.ENIGMA_FILE; + } + } + + protected static File getWritableFile(String path) { + if (path == null) { + return null; + } + File file = new File(path).getAbsoluteFile(); + File dir = file.getParentFile(); + if (dir == null) { + throw new IllegalArgumentException("Cannot write file: " + path); + } + // quick fix to avoid stupid stuff in Gradle code + if (!dir.isDirectory()) { + dir.mkdirs(); + } + return file; + } + + protected static File getWritableFolder(String path) { + if (path == null) { + return null; + } + File dir = new File(path).getAbsoluteFile(); + if (!dir.exists()) { + throw new IllegalArgumentException("Cannot write to folder: " + dir); + } + return dir; + } + + protected static File getReadableFile(String path) { + if (path == null) { + return null; + } + File file = new File(path).getAbsoluteFile(); + if (!file.exists()) { + throw new IllegalArgumentException("Cannot find file: " + file.getAbsolutePath()); + } + return file; + } + + protected static Path getReadablePath(String path) { + if (path == null) { + return null; + } + Path file = Paths.get(path).toAbsolutePath(); + if (!Files.exists(file)) { + throw new IllegalArgumentException("Cannot find file: " + file.toString()); + } + return file; + } + + protected static String getArg(String[] args, int i, String name, boolean required) { + if (i >= args.length) { + if (required) { + throw new IllegalArgumentException(name + " is required"); + } else { + return null; + } + } + return args[i]; + } + + public static class ConsoleProgressListener implements ProgressListener { + + private static final int ReportTime = 5000; // 5s + + private int totalWork; + private long startTime; + private long lastReportTime; + + @Override + public void init(int totalWork, String title) { + this.totalWork = totalWork; + this.startTime = System.currentTimeMillis(); + this.lastReportTime = this.startTime; + System.out.println(title); + } + + @Override + public void step(int numDone, String message) { + long now = System.currentTimeMillis(); + boolean isLastUpdate = numDone == this.totalWork; + boolean shouldReport = isLastUpdate || now - this.lastReportTime > ReportTime; + + if (shouldReport) { + int percent = numDone * 100 / this.totalWork; + System.out.println(String.format("\tProgress: %3d%%", percent)); + this.lastReportTime = now; + } + if (isLastUpdate) { + double elapsedSeconds = (now - this.startTime) / 1000.0; + System.out.println(String.format("Finished in %.1f seconds", elapsedSeconds)); + } + } + } +} diff --git a/src/main/java/cuchaz/enigma/command/ConvertMappingsCommand.java b/src/main/java/cuchaz/enigma/command/ConvertMappingsCommand.java new file mode 100644 index 00000000..75d3791d --- /dev/null +++ b/src/main/java/cuchaz/enigma/command/ConvertMappingsCommand.java @@ -0,0 +1,47 @@ +package cuchaz.enigma.command; + +import cuchaz.enigma.translation.mapping.EntryMapping; +import cuchaz.enigma.translation.mapping.serde.MappingFormat; +import cuchaz.enigma.translation.mapping.tree.EntryTree; + +import java.io.File; +import java.nio.file.Path; +import java.util.Locale; + +public class ConvertMappingsCommand extends Command { + + public ConvertMappingsCommand() { + super("convertmappings"); + } + + @Override + public String getUsage() { + return " "; + } + + @Override + public boolean isValidArgument(int length) { + return length == 3; + } + + @Override + public void run(String... args) throws Exception { + Path fileMappings = getReadablePath(getArg(args, 0, "enigma mappings", true)); + File result = getWritableFile(getArg(args, 1, "converted mappings", true)); + String name = getArg(args, 2, "format desc", true); + MappingFormat saveFormat; + try { + saveFormat = MappingFormat.valueOf(name.toUpperCase(Locale.ROOT)); + } catch (IllegalArgumentException e) { + throw new IllegalArgumentException(name + "is not a valid mapping format!"); + } + + System.out.println("Reading mappings..."); + + MappingFormat readFormat = chooseEnigmaFormat(fileMappings); + EntryTree mappings = readFormat.read(fileMappings, new ConsoleProgressListener()); + System.out.println("Saving new mappings..."); + + saveFormat.write(mappings, result.toPath(), new ConsoleProgressListener()); + } +} diff --git a/src/main/java/cuchaz/enigma/command/DecompileCommand.java b/src/main/java/cuchaz/enigma/command/DecompileCommand.java new file mode 100644 index 00000000..a58d9085 --- /dev/null +++ b/src/main/java/cuchaz/enigma/command/DecompileCommand.java @@ -0,0 +1,33 @@ +package cuchaz.enigma.command; + +import cuchaz.enigma.Deobfuscator; + +import java.io.File; +import java.nio.file.Path; +import java.util.jar.JarFile; + +public class DecompileCommand extends Command { + + public DecompileCommand() { + super("decompile"); + } + + @Override + public String getUsage() { + return " []"; + } + + @Override + public boolean isValidArgument(int length) { + return length == 2 || length == 3; + } + + @Override + public void run(String... args) throws Exception { + File fileJarIn = getReadableFile(getArg(args, 0, "in jar", true)); + File fileJarOut = getWritableFolder(getArg(args, 1, "out folder", true)); + Path fileMappings = getReadablePath(getArg(args, 2, "mappings file", false)); + Deobfuscator deobfuscator = getDeobfuscator(fileMappings, new JarFile(fileJarIn)); + deobfuscator.writeSources(fileJarOut.toPath(), new Command.ConsoleProgressListener()); + } +} diff --git a/src/main/java/cuchaz/enigma/command/DeobfuscateCommand.java b/src/main/java/cuchaz/enigma/command/DeobfuscateCommand.java new file mode 100644 index 00000000..5d499385 --- /dev/null +++ b/src/main/java/cuchaz/enigma/command/DeobfuscateCommand.java @@ -0,0 +1,33 @@ +package cuchaz.enigma.command; + +import cuchaz.enigma.Deobfuscator; + +import java.io.File; +import java.nio.file.Path; +import java.util.jar.JarFile; + +public class DeobfuscateCommand extends Command { + + public DeobfuscateCommand() { + super("deobfuscate"); + } + + @Override + public String getUsage() { + return " []"; + } + + @Override + public boolean isValidArgument(int length) { + return length == 2 || length == 3; + } + + @Override + public void run(String... args) throws Exception { + File fileJarIn = getReadableFile(getArg(args, 0, "in jar", true)); + File fileJarOut = getWritableFile(getArg(args, 1, "out jar", true)); + Path fileMappings = getReadablePath(getArg(args, 2, "mappings file", false)); + Deobfuscator deobfuscator = getDeobfuscator(fileMappings, new JarFile(fileJarIn)); + deobfuscator.writeTransformedJar(fileJarOut, new Command.ConsoleProgressListener()); + } +} diff --git a/src/test/java/cuchaz/enigma/PackageVisibilityIndexTest.java b/src/test/java/cuchaz/enigma/PackageVisibilityIndexTest.java new file mode 100644 index 00000000..ae5d6d2c --- /dev/null +++ b/src/test/java/cuchaz/enigma/PackageVisibilityIndexTest.java @@ -0,0 +1,55 @@ +/******************************************************************************* + * Copyright (c) 2015 Jeff Martin. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the GNU Lesser General Public + * License v3.0 which accompanies this distribution, and is available at + * http://www.gnu.org/licenses/lgpl.html + * + * Contributors: + * Jeff Martin - initial API and implementation + ******************************************************************************/ + +package cuchaz.enigma; + +import cuchaz.enigma.analysis.ParsedJar; +import cuchaz.enigma.analysis.index.JarIndex; +import cuchaz.enigma.analysis.index.PackageVisibilityIndex; +import cuchaz.enigma.translation.representation.entry.ClassEntry; +import org.junit.Test; + +import java.util.jar.JarFile; + +import static cuchaz.enigma.TestEntryFactory.newClass; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.contains; +import static org.hamcrest.Matchers.containsInAnyOrder; + +public class PackageVisibilityIndexTest { + + private static final ClassEntry KEEP = newClass("cuchaz/enigma/inputs/Keep"); + private static final ClassEntry BASE = newClass("a"); + private static final ClassEntry SAME_PACKAGE_CHILD = newClass("b"); + private static final ClassEntry SAME_PACKAGE_CHILD_INNER = newClass("b$a"); + private static final ClassEntry OTHER_PACKAGE_CHILD = newClass("c"); + private static final ClassEntry OTHER_PACKAGE_CHILD_INNER = newClass("c$a"); + private final JarIndex jarIndex; + + public PackageVisibilityIndexTest() throws Exception { + jarIndex = JarIndex.empty(); + ParsedJar jar = new ParsedJar(new JarFile("build/test-obf/packageAccess.jar")); + jarIndex.indexJar(jar, s -> { + }); + } + + @Test + public void test() { + PackageVisibilityIndex visibilityIndex = jarIndex.getPackageVisibilityIndex(); + assertThat(visibilityIndex.getPartition(BASE), containsInAnyOrder(BASE, SAME_PACKAGE_CHILD, SAME_PACKAGE_CHILD_INNER)); + System.out.println(visibilityIndex.getPartitions()); + assertThat(visibilityIndex.getPartitions(), containsInAnyOrder( + containsInAnyOrder(BASE, SAME_PACKAGE_CHILD, SAME_PACKAGE_CHILD_INNER), + containsInAnyOrder(OTHER_PACKAGE_CHILD, OTHER_PACKAGE_CHILD_INNER), + contains(KEEP) + )); + } +} diff --git a/src/test/java/cuchaz/enigma/command/CheckMappingsCommandTest.java b/src/test/java/cuchaz/enigma/command/CheckMappingsCommandTest.java new file mode 100644 index 00000000..f3b9f85e --- /dev/null +++ b/src/test/java/cuchaz/enigma/command/CheckMappingsCommandTest.java @@ -0,0 +1,20 @@ +package cuchaz.enigma.command; + +import org.junit.Test; + +import java.io.File; + +public class CheckMappingsCommandTest { + + @Test(expected = IllegalStateException.class) + public void testWrong() throws Exception { + new CheckMappingsCommand().run(new File("build/test-obf/packageAccess.jar").getAbsolutePath(), new File("src/test/resources" + + "/packageAccess/wrongMappings").getAbsolutePath()); + } + + @Test + public void testRight() throws Exception { + new CheckMappingsCommand().run(new File("build/test-obf/packageAccess.jar").getAbsolutePath(), new File("src/test/resources" + + "/packageAccess/correctMappings").getAbsolutePath()); + } +} diff --git a/src/test/java/cuchaz/enigma/inputs/packageAccess/Base.java b/src/test/java/cuchaz/enigma/inputs/packageAccess/Base.java new file mode 100644 index 00000000..6f5fe304 --- /dev/null +++ b/src/test/java/cuchaz/enigma/inputs/packageAccess/Base.java @@ -0,0 +1,7 @@ +package cuchaz.enigma.inputs.packageAccess; + +public class Base { + protected int make() { + return 42; + } +} diff --git a/src/test/java/cuchaz/enigma/inputs/packageAccess/SamePackageChild.java b/src/test/java/cuchaz/enigma/inputs/packageAccess/SamePackageChild.java new file mode 100644 index 00000000..cf0f6574 --- /dev/null +++ b/src/test/java/cuchaz/enigma/inputs/packageAccess/SamePackageChild.java @@ -0,0 +1,12 @@ +package cuchaz.enigma.inputs.packageAccess; + +public class SamePackageChild extends Base { + + class Inner { + final int value; + + Inner() { + value = SamePackageChild.this.make(); // no synthetic method + } + } +} diff --git a/src/test/java/cuchaz/enigma/inputs/packageAccess/sub/OtherPackageChild.java b/src/test/java/cuchaz/enigma/inputs/packageAccess/sub/OtherPackageChild.java new file mode 100644 index 00000000..19fb19c2 --- /dev/null +++ b/src/test/java/cuchaz/enigma/inputs/packageAccess/sub/OtherPackageChild.java @@ -0,0 +1,14 @@ +package cuchaz.enigma.inputs.packageAccess.sub; + +import cuchaz.enigma.inputs.packageAccess.Base; + +public class OtherPackageChild extends Base { + + class Inner { + final int value; + + Inner() { + value = OtherPackageChild.this.make(); // synthetic method call + } + } +} diff --git a/src/test/resources/packageAccess/correctMappings/base/Base.mapping b/src/test/resources/packageAccess/correctMappings/base/Base.mapping new file mode 100644 index 00000000..0a86def0 --- /dev/null +++ b/src/test/resources/packageAccess/correctMappings/base/Base.mapping @@ -0,0 +1 @@ +CLASS a base/Base diff --git a/src/test/resources/packageAccess/correctMappings/base/One.mapping b/src/test/resources/packageAccess/correctMappings/base/One.mapping new file mode 100644 index 00000000..dd4c2083 --- /dev/null +++ b/src/test/resources/packageAccess/correctMappings/base/One.mapping @@ -0,0 +1 @@ +CLASS b base/One diff --git a/src/test/resources/packageAccess/correctMappings/two/Two.mapping b/src/test/resources/packageAccess/correctMappings/two/Two.mapping new file mode 100644 index 00000000..a179349c --- /dev/null +++ b/src/test/resources/packageAccess/correctMappings/two/Two.mapping @@ -0,0 +1 @@ +CLASS c two/Two diff --git a/src/test/resources/packageAccess/wrongMappings/base/Base.mapping b/src/test/resources/packageAccess/wrongMappings/base/Base.mapping new file mode 100644 index 00000000..0a86def0 --- /dev/null +++ b/src/test/resources/packageAccess/wrongMappings/base/Base.mapping @@ -0,0 +1 @@ +CLASS a base/Base diff --git a/src/test/resources/packageAccess/wrongMappings/one/One.mapping b/src/test/resources/packageAccess/wrongMappings/one/One.mapping new file mode 100644 index 00000000..15b42cf5 --- /dev/null +++ b/src/test/resources/packageAccess/wrongMappings/one/One.mapping @@ -0,0 +1 @@ +CLASS b one/One diff --git a/src/test/resources/packageAccess/wrongMappings/two/Two.mapping b/src/test/resources/packageAccess/wrongMappings/two/Two.mapping new file mode 100644 index 00000000..a179349c --- /dev/null +++ b/src/test/resources/packageAccess/wrongMappings/two/Two.mapping @@ -0,0 +1 @@ +CLASS c two/Two -- cgit v1.2.3