summaryrefslogtreecommitdiff
path: root/src/main/java/cuchaz/enigma/convert/MappingsConverter.java
diff options
context:
space:
mode:
authorGravatar lclc982016-07-04 18:14:22 +1000
committerGravatar lclc982016-07-04 18:14:22 +1000
commit59e189bef2b5e6d129fb7c2c988ed0b2130e36ac (patch)
tree2b638e60905251de85a4917152d6fc39a4112194 /src/main/java/cuchaz/enigma/convert/MappingsConverter.java
parentFixed Obf Class list order (diff)
downloadenigma-fork-59e189bef2b5e6d129fb7c2c988ed0b2130e36ac.tar.gz
enigma-fork-59e189bef2b5e6d129fb7c2c988ed0b2130e36ac.tar.xz
enigma-fork-59e189bef2b5e6d129fb7c2c988ed0b2130e36ac.zip
Reformat
Diffstat (limited to 'src/main/java/cuchaz/enigma/convert/MappingsConverter.java')
-rw-r--r--src/main/java/cuchaz/enigma/convert/MappingsConverter.java540
1 files changed, 0 insertions, 540 deletions
diff --git a/src/main/java/cuchaz/enigma/convert/MappingsConverter.java b/src/main/java/cuchaz/enigma/convert/MappingsConverter.java
deleted file mode 100644
index 7739adf..0000000
--- a/src/main/java/cuchaz/enigma/convert/MappingsConverter.java
+++ /dev/null
@@ -1,540 +0,0 @@
1/*******************************************************************************
2 * Copyright (c) 2015 Jeff Martin.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the GNU Lesser General Public
5 * License v3.0 which accompanies this distribution, and is available at
6 * http://www.gnu.org/licenses/lgpl.html
7 * <p>
8 * Contributors:
9 * Jeff Martin - initial API and implementation
10 ******************************************************************************/
11package cuchaz.enigma.convert;
12
13import com.google.common.collect.*;
14
15import java.util.*;
16import java.util.jar.JarFile;
17
18import cuchaz.enigma.Constants;
19import cuchaz.enigma.Deobfuscator;
20import cuchaz.enigma.analysis.JarIndex;
21import cuchaz.enigma.convert.ClassNamer.SidedClassNamer;
22import cuchaz.enigma.mapping.*;
23
24public class MappingsConverter {
25
26 public static ClassMatches computeClassMatches(JarFile sourceJar, JarFile destJar, Mappings mappings) {
27
28 // index jars
29 System.out.println("Indexing source jar...");
30 JarIndex sourceIndex = new JarIndex();
31 sourceIndex.indexJar(sourceJar, false);
32 System.out.println("Indexing dest jar...");
33 JarIndex destIndex = new JarIndex();
34 destIndex.indexJar(destJar, false);
35
36 // compute the matching
37 ClassMatching matching = computeMatching(sourceJar, sourceIndex, destJar, destIndex, null);
38 return new ClassMatches(matching.matches());
39 }
40
41 public static ClassMatching computeMatching(JarFile sourceJar, JarIndex sourceIndex, JarFile destJar, JarIndex destIndex, BiMap<ClassEntry, ClassEntry> knownMatches) {
42
43 System.out.println("Iteratively matching classes");
44
45 ClassMatching lastMatching = null;
46 int round = 0;
47 SidedClassNamer sourceNamer = null;
48 SidedClassNamer destNamer = null;
49 for (boolean useReferences : Arrays.asList(false, true)) {
50
51 int numUniqueMatchesLastTime = 0;
52 if (lastMatching != null) {
53 numUniqueMatchesLastTime = lastMatching.uniqueMatches().size();
54 }
55
56 while (true) {
57
58 System.out.println("Round " + (++round) + "...");
59
60 // init the matching with identity settings
61 ClassMatching matching = new ClassMatching(
62 new ClassIdentifier(sourceJar, sourceIndex, sourceNamer, useReferences),
63 new ClassIdentifier(destJar, destIndex, destNamer, useReferences)
64 );
65
66 if (knownMatches != null) {
67 matching.addKnownMatches(knownMatches);
68 }
69
70 if (lastMatching == null) {
71 // search all classes
72 matching.match(sourceIndex.getObfClassEntries(), destIndex.getObfClassEntries());
73 } else {
74 // we already know about these matches from last time
75 matching.addKnownMatches(lastMatching.uniqueMatches());
76
77 // search unmatched and ambiguously-matched classes
78 matching.match(lastMatching.unmatchedSourceClasses(), lastMatching.unmatchedDestClasses());
79 for (ClassMatch match : lastMatching.ambiguousMatches()) {
80 matching.match(match.sourceClasses, match.destClasses);
81 }
82 }
83 System.out.println(matching);
84 BiMap<ClassEntry, ClassEntry> uniqueMatches = matching.uniqueMatches();
85
86 // did we match anything new this time?
87 if (uniqueMatches.size() > numUniqueMatchesLastTime) {
88 numUniqueMatchesLastTime = uniqueMatches.size();
89 lastMatching = matching;
90 } else {
91 break;
92 }
93
94 // update the namers
95 ClassNamer namer = new ClassNamer(uniqueMatches);
96 sourceNamer = namer.getSourceNamer();
97 destNamer = namer.getDestNamer();
98 }
99 }
100
101 return lastMatching;
102 }
103
104 public static Mappings newMappings(ClassMatches matches, Mappings oldMappings, Deobfuscator sourceDeobfuscator, Deobfuscator destDeobfuscator) {
105
106 // sort the unique matches by size of inner class chain
107 Multimap<Integer, java.util.Map.Entry<ClassEntry, ClassEntry>> matchesByDestChainSize = HashMultimap.create();
108 for (java.util.Map.Entry<ClassEntry, ClassEntry> match : matches.getUniqueMatches().entrySet()) {
109 int chainSize = destDeobfuscator.getJarIndex().getObfClassChain(match.getValue()).size();
110 matchesByDestChainSize.put(chainSize, match);
111 }
112
113 // build the mappings (in order of small-to-large inner chains)
114 Mappings newMappings = new Mappings();
115 List<Integer> chainSizes = Lists.newArrayList(matchesByDestChainSize.keySet());
116 Collections.sort(chainSizes);
117 for (int chainSize : chainSizes) {
118 for (java.util.Map.Entry<ClassEntry, ClassEntry> match : matchesByDestChainSize.get(chainSize)) {
119
120 // get class info
121 ClassEntry obfSourceClassEntry = match.getKey();
122 ClassEntry obfDestClassEntry = match.getValue();
123 List<ClassEntry> destClassChain = destDeobfuscator.getJarIndex().getObfClassChain(obfDestClassEntry);
124
125 ClassMapping sourceMapping = sourceDeobfuscator.getMappings().getClassByObf(obfSourceClassEntry);
126 if (sourceMapping == null) {
127 // if this class was never deobfuscated, don't try to match it
128 continue;
129 }
130
131 // find out where to make the dest class mapping
132 if (destClassChain.size() == 1) {
133 // not an inner class, add directly to mappings
134 newMappings.addClassMapping(migrateClassMapping(obfDestClassEntry, sourceMapping, matches, false));
135 } else {
136 // inner class, find the outer class mapping
137 ClassMapping destMapping = null;
138 for (int i = 0; i < destClassChain.size() - 1; i++) {
139 ClassEntry destChainClassEntry = destClassChain.get(i);
140 if (destMapping == null) {
141 destMapping = newMappings.getClassByObf(destChainClassEntry);
142 if (destMapping == null) {
143 destMapping = new ClassMapping(destChainClassEntry.getName());
144 newMappings.addClassMapping(destMapping);
145 }
146 } else {
147 destMapping = destMapping.getInnerClassByObfSimple(destChainClassEntry.getInnermostClassName());
148 if (destMapping == null) {
149 destMapping = new ClassMapping(destChainClassEntry.getName());
150 destMapping.addInnerClassMapping(destMapping);
151 }
152 }
153 }
154 if (destMapping != null) {
155 destMapping.addInnerClassMapping(migrateClassMapping(obfDestClassEntry, sourceMapping, matches, true));
156 }
157 }
158 }
159 }
160 return newMappings;
161 }
162
163 private static ClassMapping migrateClassMapping(ClassEntry newObfClass, ClassMapping oldClassMapping, final ClassMatches matches, boolean useSimpleName) {
164
165 ClassNameReplacer replacer = className -> {
166 ClassEntry newClassEntry = matches.getUniqueMatches().get(new ClassEntry(className));
167 if (newClassEntry != null) {
168 return newClassEntry.getName();
169 }
170 return null;
171 };
172
173 ClassMapping newClassMapping;
174 String deobfName = oldClassMapping.getDeobfName();
175 if (deobfName != null) {
176 if (useSimpleName) {
177 deobfName = new ClassEntry(deobfName).getSimpleName();
178 }
179 newClassMapping = new ClassMapping(newObfClass.getName(), deobfName);
180 } else {
181 newClassMapping = new ClassMapping(newObfClass.getName());
182 }
183
184 // migrate fields
185 for (FieldMapping oldFieldMapping : oldClassMapping.fields()) {
186 if (canMigrate(oldFieldMapping.getObfType(), matches)) {
187 newClassMapping.addFieldMapping(new FieldMapping(oldFieldMapping, replacer));
188 } else {
189 System.out.println(String.format("Can't map field, dropping: %s.%s %s",
190 oldClassMapping.getDeobfName(),
191 oldFieldMapping.getDeobfName(),
192 oldFieldMapping.getObfType()
193 ));
194 }
195 }
196
197 // migrate methods
198 for (MethodMapping oldMethodMapping : oldClassMapping.methods()) {
199 if (canMigrate(oldMethodMapping.getObfSignature(), matches)) {
200 newClassMapping.addMethodMapping(new MethodMapping(oldMethodMapping, replacer));
201 } else {
202 System.out.println(String.format("Can't map method, dropping: %s.%s %s",
203 oldClassMapping.getDeobfName(),
204 oldMethodMapping.getDeobfName(),
205 oldMethodMapping.getObfSignature()
206 ));
207 }
208 }
209
210 return newClassMapping;
211 }
212
213 private static boolean canMigrate(Signature oldObfSignature, ClassMatches classMatches) {
214 for (Type oldObfType : oldObfSignature.types()) {
215 if (!canMigrate(oldObfType, classMatches)) {
216 return false;
217 }
218 }
219 return true;
220 }
221
222 private static boolean canMigrate(Type oldObfType, ClassMatches classMatches) {
223
224 // non classes can be migrated
225 if (!oldObfType.hasClass()) {
226 return true;
227 }
228
229 // non obfuscated classes can be migrated
230 ClassEntry classEntry = oldObfType.getClassEntry();
231 if (!classEntry.getPackageName().equals(Constants.NONE_PACKAGE)) {
232 return true;
233 }
234
235 // obfuscated classes with mappings can be migrated
236 return classMatches.getUniqueMatches().containsKey(classEntry);
237 }
238
239 public interface Doer<T extends Entry> {
240 Collection<T> getDroppedEntries(MappingsChecker checker);
241
242 Collection<T> getObfEntries(JarIndex jarIndex);
243
244 Collection<? extends MemberMapping<T>> getMappings(ClassMapping destClassMapping);
245
246 Set<T> filterEntries(Collection<T> obfEntries, T obfSourceEntry, ClassMatches classMatches);
247
248 void setUpdateObfMember(ClassMapping classMapping, MemberMapping<T> memberMapping, T newEntry);
249
250 boolean hasObfMember(ClassMapping classMapping, T obfEntry);
251
252 void removeMemberByObf(ClassMapping classMapping, T obfEntry);
253 }
254
255 public static Doer<FieldEntry> getFieldDoer() {
256 return new Doer<FieldEntry>() {
257
258 @Override
259 public Collection<FieldEntry> getDroppedEntries(MappingsChecker checker) {
260 return checker.getDroppedFieldMappings().keySet();
261 }
262
263 @Override
264 public Collection<FieldEntry> getObfEntries(JarIndex jarIndex) {
265 return jarIndex.getObfFieldEntries();
266 }
267
268 @Override
269 public Collection<? extends MemberMapping<FieldEntry>> getMappings(ClassMapping destClassMapping) {
270 return (Collection<? extends MemberMapping<FieldEntry>>) destClassMapping.fields();
271 }
272
273 @Override
274 public Set<FieldEntry> filterEntries(Collection<FieldEntry> obfDestFields, FieldEntry obfSourceField, ClassMatches classMatches) {
275 Set<FieldEntry> out = Sets.newHashSet();
276 for (FieldEntry obfDestField : obfDestFields) {
277 Type translatedDestType = translate(obfDestField.getType(), classMatches.getUniqueMatches().inverse());
278 if (translatedDestType.equals(obfSourceField.getType())) {
279 out.add(obfDestField);
280 }
281 }
282 return out;
283 }
284
285 @Override
286 public void setUpdateObfMember(ClassMapping classMapping, MemberMapping<FieldEntry> memberMapping, FieldEntry newField) {
287 FieldMapping fieldMapping = (FieldMapping) memberMapping;
288 classMapping.setFieldObfNameAndType(fieldMapping.getObfName(), fieldMapping.getObfType(), newField.getName(), newField.getType());
289 }
290
291 @Override
292 public boolean hasObfMember(ClassMapping classMapping, FieldEntry obfField) {
293 return classMapping.getFieldByObf(obfField.getName(), obfField.getType()) != null;
294 }
295
296 @Override
297 public void removeMemberByObf(ClassMapping classMapping, FieldEntry obfField) {
298 classMapping.removeFieldMapping(classMapping.getFieldByObf(obfField.getName(), obfField.getType()));
299 }
300 };
301 }
302
303 public static Doer<BehaviorEntry> getMethodDoer() {
304 return new Doer<BehaviorEntry>() {
305
306 @Override
307 public Collection<BehaviorEntry> getDroppedEntries(MappingsChecker checker) {
308 return checker.getDroppedMethodMappings().keySet();
309 }
310
311 @Override
312 public Collection<BehaviorEntry> getObfEntries(JarIndex jarIndex) {
313 return jarIndex.getObfBehaviorEntries();
314 }
315
316 @Override
317 public Collection<? extends MemberMapping<BehaviorEntry>> getMappings(ClassMapping destClassMapping) {
318 return (Collection<? extends MemberMapping<BehaviorEntry>>) destClassMapping.methods();
319 }
320
321 @Override
322 public Set<BehaviorEntry> filterEntries(Collection<BehaviorEntry> obfDestFields, BehaviorEntry obfSourceField, ClassMatches classMatches) {
323 Set<BehaviorEntry> out = Sets.newHashSet();
324 for (BehaviorEntry obfDestField : obfDestFields) {
325 Signature translatedDestSignature = translate(obfDestField.getSignature(), classMatches.getUniqueMatches().inverse());
326 if (translatedDestSignature == null && obfSourceField.getSignature() == null) {
327 out.add(obfDestField);
328 } else if (translatedDestSignature == null || obfSourceField.getSignature() == null) {
329 // skip it
330 } else if (translatedDestSignature.equals(obfSourceField.getSignature())) {
331 out.add(obfDestField);
332 }
333 }
334 return out;
335 }
336
337 @Override
338 public void setUpdateObfMember(ClassMapping classMapping, MemberMapping<BehaviorEntry> memberMapping, BehaviorEntry newBehavior) {
339 MethodMapping methodMapping = (MethodMapping) memberMapping;
340 classMapping.setMethodObfNameAndSignature(methodMapping.getObfName(), methodMapping.getObfSignature(), newBehavior.getName(), newBehavior.getSignature());
341 }
342
343 @Override
344 public boolean hasObfMember(ClassMapping classMapping, BehaviorEntry obfBehavior) {
345 return classMapping.getMethodByObf(obfBehavior.getName(), obfBehavior.getSignature()) != null;
346 }
347
348 @Override
349 public void removeMemberByObf(ClassMapping classMapping, BehaviorEntry obfBehavior) {
350 classMapping.removeMethodMapping(classMapping.getMethodByObf(obfBehavior.getName(), obfBehavior.getSignature()));
351 }
352 };
353 }
354
355 public static <T extends Entry> MemberMatches<T> computeMemberMatches(Deobfuscator destDeobfuscator, Mappings destMappings, ClassMatches classMatches, Doer<T> doer) {
356
357 MemberMatches<T> memberMatches = new MemberMatches<>();
358
359 // unmatched source fields are easy
360 MappingsChecker checker = new MappingsChecker(destDeobfuscator.getJarIndex());
361 checker.dropBrokenMappings(destMappings);
362 for (T destObfEntry : doer.getDroppedEntries(checker)) {
363 T srcObfEntry = translate(destObfEntry, classMatches.getUniqueMatches().inverse());
364 memberMatches.addUnmatchedSourceEntry(srcObfEntry);
365 }
366
367 // get matched fields (anything that's left after the checks/drops is matched(
368 for (ClassMapping classMapping : destMappings.classes()) {
369 collectMatchedFields(memberMatches, classMapping, classMatches, doer);
370 }
371
372 // get unmatched dest fields
373 for (T destEntry : doer.getObfEntries(destDeobfuscator.getJarIndex())) {
374 if (!memberMatches.isMatchedDestEntry(destEntry)) {
375 memberMatches.addUnmatchedDestEntry(destEntry);
376 }
377 }
378
379 System.out.println("Automatching " + memberMatches.getUnmatchedSourceEntries().size() + " unmatched source entries...");
380
381 // go through the unmatched source fields and try to pick out the easy matches
382 for (ClassEntry obfSourceClass : Lists.newArrayList(memberMatches.getSourceClassesWithUnmatchedEntries())) {
383 for (T obfSourceEntry : Lists.newArrayList(memberMatches.getUnmatchedSourceEntries(obfSourceClass))) {
384
385 // get the possible dest matches
386 ClassEntry obfDestClass = classMatches.getUniqueMatches().get(obfSourceClass);
387
388 // filter by type/signature
389 Set<T> obfDestEntries = doer.filterEntries(memberMatches.getUnmatchedDestEntries(obfDestClass), obfSourceEntry, classMatches);
390
391 if (obfDestEntries.size() == 1) {
392 // make the easy match
393 memberMatches.makeMatch(obfSourceEntry, obfDestEntries.iterator().next());
394 } else if (obfDestEntries.isEmpty()) {
395 // no match is possible =(
396 memberMatches.makeSourceUnmatchable(obfSourceEntry);
397 }
398 }
399 }
400
401 System.out.println(String.format("Ended up with %d ambiguous and %d unmatchable source entries",
402 memberMatches.getUnmatchedSourceEntries().size(),
403 memberMatches.getUnmatchableSourceEntries().size()
404 ));
405
406 return memberMatches;
407 }
408
409 private static <T extends Entry> void collectMatchedFields(MemberMatches<T> memberMatches, ClassMapping destClassMapping, ClassMatches classMatches, Doer<T> doer) {
410
411 // get the fields for this class
412 for (MemberMapping<T> destEntryMapping : doer.getMappings(destClassMapping)) {
413 T destObfField = destEntryMapping.getObfEntry(destClassMapping.getObfEntry());
414 T srcObfField = translate(destObfField, classMatches.getUniqueMatches().inverse());
415 memberMatches.addMatch(srcObfField, destObfField);
416 }
417
418 // recurse
419 for (ClassMapping destInnerClassMapping : destClassMapping.innerClasses()) {
420 collectMatchedFields(memberMatches, destInnerClassMapping, classMatches, doer);
421 }
422 }
423
424 @SuppressWarnings("unchecked")
425 private static <T extends Entry> T translate(T in, BiMap<ClassEntry, ClassEntry> map) {
426 if (in instanceof FieldEntry) {
427 return (T) new FieldEntry(
428 map.get(in.getClassEntry()),
429 in.getName(),
430 translate(((FieldEntry) in).getType(), map)
431 );
432 } else if (in instanceof MethodEntry) {
433 return (T) new MethodEntry(
434 map.get(in.getClassEntry()),
435 in.getName(),
436 translate(((MethodEntry) in).getSignature(), map)
437 );
438 } else if (in instanceof ConstructorEntry) {
439 return (T) new ConstructorEntry(
440 map.get(in.getClassEntry()),
441 translate(((ConstructorEntry) in).getSignature(), map)
442 );
443 }
444 throw new Error("Unhandled entry type: " + in.getClass());
445 }
446
447 private static Type translate(Type type, final BiMap<ClassEntry, ClassEntry> map) {
448 return new Type(type, inClassName -> {
449 ClassEntry outClassEntry = map.get(new ClassEntry(inClassName));
450 if (outClassEntry == null) {
451 return null;
452 }
453 return outClassEntry.getName();
454 });
455 }
456
457 private static Signature translate(Signature signature, final BiMap<ClassEntry, ClassEntry> map) {
458 if (signature == null) {
459 return null;
460 }
461 return new Signature(signature, inClassName -> {
462 ClassEntry outClassEntry = map.get(new ClassEntry(inClassName));
463 if (outClassEntry == null) {
464 return null;
465 }
466 return outClassEntry.getName();
467 });
468 }
469
470 public static <T extends Entry> void applyMemberMatches(Mappings mappings, ClassMatches classMatches, MemberMatches<T> memberMatches, Doer<T> doer) {
471 for (ClassMapping classMapping : mappings.classes()) {
472 applyMemberMatches(classMapping, classMatches, memberMatches, doer);
473 }
474 }
475
476 private static <T extends Entry> void applyMemberMatches(ClassMapping classMapping, ClassMatches classMatches, MemberMatches<T> memberMatches, Doer<T> doer) {
477
478 // get the classes
479 ClassEntry obfDestClass = classMapping.getObfEntry();
480
481 // make a map of all the renames we need to make
482 Map<T, T> renames = Maps.newHashMap();
483 for (MemberMapping<T> memberMapping : Lists.newArrayList(doer.getMappings(classMapping))) {
484 T obfOldDestEntry = memberMapping.getObfEntry(obfDestClass);
485 T obfSourceEntry = getSourceEntryFromDestMapping(memberMapping, obfDestClass, classMatches);
486
487 // but drop the unmatchable things
488 if (memberMatches.isUnmatchableSourceEntry(obfSourceEntry)) {
489 doer.removeMemberByObf(classMapping, obfOldDestEntry);
490 continue;
491 }
492
493 T obfNewDestEntry = memberMatches.matches().get(obfSourceEntry);
494 if (obfNewDestEntry != null && !obfOldDestEntry.getName().equals(obfNewDestEntry.getName())) {
495 renames.put(obfOldDestEntry, obfNewDestEntry);
496 }
497 }
498
499 if (!renames.isEmpty()) {
500
501 // apply to this class (should never need more than n passes)
502 int numRenamesAppliedThisRound;
503 do {
504 numRenamesAppliedThisRound = 0;
505
506 for (MemberMapping<T> memberMapping : Lists.newArrayList(doer.getMappings(classMapping))) {
507 T obfOldDestEntry = memberMapping.getObfEntry(obfDestClass);
508 T obfNewDestEntry = renames.get(obfOldDestEntry);
509 if (obfNewDestEntry != null) {
510 // make sure this rename won't cause a collision
511 // otherwise, save it for the next round and try again next time
512 if (!doer.hasObfMember(classMapping, obfNewDestEntry)) {
513 doer.setUpdateObfMember(classMapping, memberMapping, obfNewDestEntry);
514 renames.remove(obfOldDestEntry);
515 numRenamesAppliedThisRound++;
516 }
517 }
518 }
519 } while (numRenamesAppliedThisRound > 0);
520
521 if (!renames.isEmpty()) {
522 System.err.println(String.format("WARNING: Couldn't apply all the renames for class %s. %d renames left.",
523 classMapping.getObfFullName(), renames.size()
524 ));
525 for (Map.Entry<T, T> entry : renames.entrySet()) {
526 System.err.println(String.format("\t%s -> %s", entry.getKey().getName(), entry.getValue().getName()));
527 }
528 }
529 }
530
531 // recurse
532 for (ClassMapping innerClassMapping : classMapping.innerClasses()) {
533 applyMemberMatches(innerClassMapping, classMatches, memberMatches, doer);
534 }
535 }
536
537 private static <T extends Entry> T getSourceEntryFromDestMapping(MemberMapping<T> destMemberMapping, ClassEntry obfDestClass, ClassMatches classMatches) {
538 return translate(destMemberMapping.getObfEntry(obfDestClass), classMatches.getUniqueMatches().inverse());
539 }
540}