Merge pull request #104 from google/plugins-full

implemented plugin system

Author: borisf

ClassySharkWS/src/com/google/classyshark/Version.java

@@ -22,5 +22,5 @@
 public class Version {
 
     public static final int MAJOR = 6;
-    public static final int MINOR = 4;
+    public static final int MINOR = 5;
 }

ClassySharkWS/src/com/google/classyshark/gui/panel/ClassySharkPanel.java

@@ -32,7 +32,7 @@
 import com.google.classyshark.silverghost.SilverGhost;
 import com.google.classyshark.silverghost.exporter.Exporter;
 import com.google.classyshark.silverghost.methodscounter.ClassNode;
-import com.google.classyshark.silverghost.tokensmapper.ProguardMapper;
+import com.google.classyshark.silverghost.TokensMapper;
 import com.google.classyshark.silverghost.translator.Translator;
 
 import javax.swing.JFileChooser;
@@ -446,11 +446,11 @@ protected void done() {
 
     private void readMappingFile(final File resultFile) {
         SwingWorker<Void, Void> worker = new SwingWorker<Void, Void>() {
-            private ProguardMapper reverseMappings;
+            private TokensMapper reverseMappings;
 
             @Override
             protected Void doInBackground() throws Exception {
-                reverseMappings = SilverGhost.readMappingFile(resultFile);
+                reverseMappings = silverGhost.readMappingFile(resultFile);
                 return null;
             }
 

ClassySharkWS/src/com/google/classyshark/silverghost/FullArchiveReader.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2016 Google, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.classyshark.silverghost;
+
+import com.google.classyshark.silverghost.translator.Translator;
+import java.io.File;
+
+public interface FullArchiveReader {
+    void readAsyncArchive(File file);
+
+    Translator buildTranslator(String className, File archiveFile);
+}

ClassySharkWS/src/com/google/classyshark/silverghost/SilverGhost.java

@@ -17,14 +17,12 @@
 package com.google.classyshark.silverghost;
 
 import com.google.classyshark.gui.panel.reducer.Reducer;
+import com.google.classyshark.silverghost.plugins.EmptyFullArchiveReader;
 import com.google.classyshark.silverghost.contentreader.ContentReader;
-import com.google.classyshark.silverghost.tokensmapper.MappingReader;
-import com.google.classyshark.silverghost.tokensmapper.ProguardMapper;
+import com.google.classyshark.silverghost.plugins.IdentityMapper;
 import com.google.classyshark.silverghost.translator.Translator;
 import com.google.classyshark.silverghost.translator.TranslatorFactory;
-
 import java.io.File;
-import java.io.IOException;
 import java.util.List;
 
 /**
@@ -36,7 +34,13 @@ public class SilverGhost {
     private Reducer reducer;
     private Translator translator;
     private ContentReader contentReader;
-    private ProguardMapper proguardMapper = ProguardMapper.IDENTITY;
+    private static TokensMapper tokensMapper;
+    private static FullArchiveReader fullArchiveReader;
+
+    static {
+        tokensMapper = new IdentityMapper();
+        fullArchiveReader = new EmptyFullArchiveReader();
+    }
 
     public SilverGhost() {
     }
@@ -45,7 +49,7 @@ public void setBinaryArchive(File binArchive) {
         this.binaryArchive = binArchive;
 
         // TODO think of initialyzing data members as they hold prev file state
-        proguardMapper = ProguardMapper.IDENTITY;
+        tokensMapper = new IdentityMapper();
     }
 
     //                     1. READ CONTENTS
@@ -56,6 +60,8 @@ public void readContents() {
         reducer = new Reducer(contentReader.getAllClassNames());
         System.out.println("Archive Reading "
                 + (System.currentTimeMillis() - start) + " ms ");
+
+        fullArchiveReader.readAsyncArchive(binaryArchive);
     }
 
     public File getBinaryArchive() {
@@ -91,19 +97,13 @@ public boolean isArchiveError() {
     }
 
     //                     2. READ MAPPINGS FILE
-    public static ProguardMapper readMappingFile(File mappingFile) {
-        try {
-            MappingReader mr = new MappingReader(mappingFile);
-            ProguardMapper proguardMapper = new ProguardMapper();
-            mr.pump(proguardMapper);
-            return proguardMapper;
-        } catch (IOException e) {
-            return ProguardMapper.IDENTITY;
-        }
+    public TokensMapper readMappingFile(File mappingFile) {
+        tokensMapper.readMappings(mappingFile);
+        return tokensMapper;
     }
 
-    public void addMappings(ProguardMapper proguardMapper) {
-        this.proguardMapper = proguardMapper;
+    public void addMappings(TokensMapper tokensMapper) {
+        this.tokensMapper = tokensMapper;
     }
 
     //                     3. BINARY ARCHIVE ELEMENT
@@ -113,8 +113,8 @@ public void translateArchiveElement(String elementName) {
                 TranslatorFactory.createTranslator(
                         elementName,
                         getBinaryArchive(),
-                        reducer.getAllClassNames());
-        translator.addMapper(this.proguardMapper);
+                        reducer.getAllClassNames(), fullArchiveReader);
+        translator.addMapper(tokensMapper);
         translator.apply();
     }
 

ClassySharkWS/src/com/google/classyshark/silverghost/TokensMapper.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2016 Google, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.classyshark.silverghost;
+
+import java.io.File;
+import java.util.Map;
+
+public interface TokensMapper {
+
+    TokensMapper readMappings(File file);
+
+    Map<String,String> getReverseClasses();
+}

ClassySharkWS/src/com/google/classyshark/silverghost/plugins/EmptyFullArchiveReader.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2016 Google, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.classyshark.silverghost.plugins;
+
+import com.google.classyshark.silverghost.FullArchiveReader;
+import com.google.classyshark.silverghost.TokensMapper;
+import com.google.classyshark.silverghost.translator.Translator;
+import java.io.File;
+import java.util.LinkedList;
+import java.util.List;
+
+public class EmptyFullArchiveReader implements FullArchiveReader{
+    @Override
+    public void readAsyncArchive(File file) {
+
+    }
+
+    @Override
+    public Translator buildTranslator(String className, File archiveFile) {
+        return new Translator() {
+            @Override
+            public String getClassName() {
+                return "Empty";
+            }
+
+            @Override
+            public void addMapper(TokensMapper reverseMappings) {
+
+            }
+
+            @Override
+            public void apply() {
+
+            }
+
+            @Override
+            public List<ELEMENT> getElementsList() {
+                return new LinkedList<>();
+            }
+
+            @Override
+            public List<String> getDependencies() {
+                return new LinkedList<>();
+            }
+        };
+    }
+}

ClassySharkWS/src/com/google/classyshark/silverghost/plugins/IdentityMapper.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2016 Google, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.classyshark.silverghost.plugins;
+
+import com.google.classyshark.silverghost.TokensMapper;
+import java.io.File;
+import java.util.Map;
+import java.util.TreeMap;
+
+public class IdentityMapper implements TokensMapper {
+
+    private Map<String, String> identityMap = new TreeMap<>();
+
+    public IdentityMapper() {
+
+    }
+
+    @Override
+    public TokensMapper readMappings(File file) {
+        return this;
+    }
+
+    @Override
+    public Map<String, String> getReverseClasses() {
+        return this.identityMap;
+    }
+}

ClassySharkWS/src/com/google/classyshark/silverghost/translator/Translator.java

@@ -16,8 +16,7 @@
 
 package com.google.classyshark.silverghost.translator;
 
-import com.google.classyshark.silverghost.tokensmapper.ProguardMapper;
-
+import com.google.classyshark.silverghost.TokensMapper;
 import java.util.List;
 
 /**
@@ -49,7 +48,7 @@ public ELEMENT(String word, TAG tag) {
 
     String getClassName();
 
-    void addMapper(ProguardMapper reverseMappings);
+    void addMapper(TokensMapper reverseMappings);
 
     void apply();
 

ClassySharkWS/src/com/google/classyshark/silverghost/translator/TranslatorFactory.java

@@ -16,34 +16,42 @@
 
 package com.google.classyshark.silverghost.translator;
 
+import com.google.classyshark.silverghost.FullArchiveReader;
+import com.google.classyshark.silverghost.plugins.EmptyFullArchiveReader;
 import com.google.classyshark.silverghost.translator.apk.ApkTranslator;
 import com.google.classyshark.silverghost.translator.dex.DexInfoTranslator;
 import com.google.classyshark.silverghost.translator.elf.ElfTranslator;
 import com.google.classyshark.silverghost.translator.jar.JarInfoTranslator;
 import com.google.classyshark.silverghost.translator.java.JavaTranslator;
 import com.google.classyshark.silverghost.translator.xml.AndroidXmlTranslator;
-
 import java.io.File;
 import java.util.LinkedList;
 import java.util.List;
 
 /**
- *  Creates translators based on class names and archives
+ * Creates translators based on class names and archives
  */
 public class TranslatorFactory {
 
     public static Translator createTranslator(String className, File archiveFile) {
-        return createTranslator(className, archiveFile, new LinkedList<String>());
+        return createTranslator(className, archiveFile, new LinkedList<String>(), null);
     }
 
+
     public static Translator createTranslator(String className, File archiveFile,
                                               List<String> allClassNames) {
-        if(className.endsWith(".xml")) {
+        return createTranslator(className, archiveFile, allClassNames, null);
+    }
+
+
+    public static Translator createTranslator(String className, File archiveFile,
+                                              List<String> allClassNames, FullArchiveReader fullArchiveReader) {
+        if (className.endsWith(".xml")) {
             return new AndroidXmlTranslator(className, archiveFile);
         }
 
         if (className.endsWith(".dex")) {
-           return new DexInfoTranslator(className, archiveFile);
+            return new DexInfoTranslator(className, archiveFile);
         }
 
         if (className.endsWith(".jar")) {
@@ -58,6 +66,11 @@ public static Translator createTranslator(String className, File archiveFile,
             return new ElfTranslator(className, archiveFile);
         }
 
+        if (fullArchiveReader != null &&
+                !(fullArchiveReader instanceof EmptyFullArchiveReader)) {
+            return fullArchiveReader.buildTranslator(className, archiveFile);
+        }
+
         return new JavaTranslator(className, archiveFile);
     }
 }

ClassySharkWS/src/com/google/classyshark/silverghost/translator/apk/ApkTranslator.java

@@ -18,7 +18,7 @@
 
 import com.google.classyshark.silverghost.contentreader.dex.DexlibLoader;
 import com.google.classyshark.silverghost.io.SherlockHash;
-import com.google.classyshark.silverghost.tokensmapper.ProguardMapper;
+import com.google.classyshark.silverghost.TokensMapper;
 import com.google.classyshark.silverghost.translator.Translator;
 import org.jf.dexlib2.dexbacked.DexBackedDexFile;
 import org.jf.dexlib2.iface.DexFile;
@@ -59,7 +59,7 @@ public String getClassName() {
     }
 
     @Override
-    public void addMapper(ProguardMapper reverseMappings) {
+    public void addMapper(TokensMapper reverseMappings) {
 
     }
 

ClassySharkWS/src/com/google/classyshark/silverghost/translator/dex/DexInfoTranslator.java

@@ -18,7 +18,7 @@
 
 import com.google.classyshark.silverghost.contentreader.dex.DexlibLoader;
 import com.google.classyshark.silverghost.io.SherlockHash;
-import com.google.classyshark.silverghost.tokensmapper.ProguardMapper;
+import com.google.classyshark.silverghost.TokensMapper;
 import com.google.classyshark.silverghost.translator.Translator;
 import com.google.classyshark.silverghost.translator.apk.ApkTranslator;
 import org.jf.dexlib2.dexbacked.DexBackedDexFile;
@@ -52,7 +52,7 @@ public String getClassName() {
     }
 
     @Override
-    public void addMapper(ProguardMapper reverseMappings) {
+    public void addMapper(TokensMapper reverseMappings) {
 
     }