com.taobao.android.apatch.ApkPatch.java Source code

Java tutorial

Introduction

Here is the source code for com.taobao.android.apatch.ApkPatch.java

Source

/*
 *
 *
 *                                  Apache License
 *                            Version 2.0, January 2004
 *                         http://www.apache.org/licenses/
 *
 *    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 *
 *    1. Definitions.
 *
 *       "License" shall mean the terms and conditions for use, reproduction,
 *       and distribution as defined by Sections 1 through 9 of this document.
 *
 *       "Licensor" shall mean the copyright owner or entity authorized by
 *       the copyright owner that is granting the License.
 *
 *       "Legal Entity" shall mean the union of the acting entity and all
 *       other entities that control, are controlled by, or are under common
 *       control with that entity. For the purposes of this definition,
 *       "control" means (i) the power, direct or indirect, to cause the
 *       direction or management of such entity, whether by contract or
 *       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 *       outstanding shares, or (iii) beneficial ownership of such entity.
 *
 *       "You" (or "Your") shall mean an individual or Legal Entity
 *       exercising permissions granted by this License.
 *
 *       "Source" form shall mean the preferred form for making modifications,
 *       including but not limited to software source code, documentation
 *       source, and configuration files.
 *
 *       "Object" form shall mean any form resulting from mechanical
 *       transformation or translation of a Source form, including but
 *       not limited to compiled object code, generated documentation,
 *       and conversions to other media types.
 *
 *       "Work" shall mean the work of authorship, whether in Source or
 *       Object form, made available under the License, as indicated by a
 *       copyright notice that is included in or attached to the work
 *       (an example is provided in the Appendix below).
 *
 *       "Derivative Works" shall mean any work, whether in Source or Object
 *       form, that is based on (or derived from) the Work and for which the
 *       editorial revisions, annotations, elaborations, or other modifications
 *       represent, as a whole, an original work of authorship. For the purposes
 *       of this License, Derivative Works shall not include works that remain
 *       separable from, or merely link (or bind by name) to the interfaces of,
 *       the Work and Derivative Works thereof.
 *
 *       "Contribution" shall mean any work of authorship, including
 *       the original version of the Work and any modifications or additions
 *       to that Work or Derivative Works thereof, that is intentionally
 *       submitted to Licensor for inclusion in the Work by the copyright owner
 *       or by an individual or Legal Entity authorized to submit on behalf of
 *       the copyright owner. For the purposes of this definition, "submitted"
 *       means any form of electronic, verbal, or written communication sent
 *       to the Licensor or its representatives, including but not limited to
 *       communication on electronic mailing lists, source code control systems,
 *       and issue tracking systems that are managed by, or on behalf of, the
 *       Licensor for the purpose of discussing and improving the Work, but
 *       excluding communication that is conspicuously marked or otherwise
 *       designated in writing by the copyright owner as "Not a Contribution."
 *
 *       "Contributor" shall mean Licensor and any individual or Legal Entity
 *       on behalf of whom a Contribution has been received by Licensor and
 *       subsequently incorporated within the Work.
 *
 *    2. Grant of Copyright License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       copyright license to reproduce, prepare Derivative Works of,
 *       publicly display, publicly perform, sublicense, and distribute the
 *       Work and such Derivative Works in Source or Object form.
 *
 *    3. Grant of Patent License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       (except as stated in this section) patent license to make, have made,
 *       use, offer to sell, sell, import, and otherwise transfer the Work,
 *       where such license applies only to those patent claims licensable
 *       by such Contributor that are necessarily infringed by their
 *       Contribution(s) alone or by combination of their Contribution(s)
 *       with the Work to which such Contribution(s) was submitted. If You
 *       institute patent litigation against any entity (including a
 *       cross-claim or counterclaim in a lawsuit) alleging that the Work
 *       or a Contribution incorporated within the Work constitutes direct
 *       or contributory patent infringement, then any patent licenses
 *       granted to You under this License for that Work shall terminate
 *       as of the date such litigation is filed.
 *
 *    4. Redistribution. You may reproduce and distribute copies of the
 *       Work or Derivative Works thereof in any medium, with or without
 *       modifications, and in Source or Object form, provided that You
 *       meet the following conditions:
 *
 *       (a) You must give any other recipients of the Work or
 *           Derivative Works a copy of this License; and
 *
 *       (b) You must cause any modified files to carry prominent notices
 *           stating that You changed the files; and
 *
 *       (c) You must retain, in the Source form of any Derivative Works
 *           that You distribute, all copyright, patent, trademark, and
 *           attribution notices from the Source form of the Work,
 *           excluding those notices that do not pertain to any part of
 *           the Derivative Works; and
 *
 *       (d) If the Work includes a "NOTICE" text file as part of its
 *           distribution, then any Derivative Works that You distribute must
 *           include a readable copy of the attribution notices contained
 *           within such NOTICE file, excluding those notices that do not
 *           pertain to any part of the Derivative Works, in at least one
 *           of the following places: within a NOTICE text file distributed
 *           as part of the Derivative Works; within the Source form or
 *           documentation, if provided along with the Derivative Works; or,
 *           within a display generated by the Derivative Works, if and
 *           wherever such third-party notices normally appear. The contents
 *           of the NOTICE file are for informational purposes only and
 *           do not modify the License. You may add Your own attribution
 *           notices within Derivative Works that You distribute, alongside
 *           or as an addendum to the NOTICE text from the Work, provided
 *           that such additional attribution notices cannot be construed
 *           as modifying the License.
 *
 *       You may add Your own copyright statement to Your modifications and
 *       may provide additional or different license terms and conditions
 *       for use, reproduction, or distribution of Your modifications, or
 *       for any such Derivative Works as a whole, provided Your use,
 *       reproduction, and distribution of the Work otherwise complies with
 *       the conditions stated in this License.
 *
 *    5. Submission of Contributions. Unless You explicitly state otherwise,
 *       any Contribution intentionally submitted for inclusion in the Work
 *       by You to the Licensor shall be under the terms and conditions of
 *       this License, without any additional terms or conditions.
 *       Notwithstanding the above, nothing herein shall supersede or modify
 *       the terms of any separate license agreement you may have executed
 *       with Licensor regarding such Contributions.
 *
 *    6. Trademarks. This License does not grant permission to use the trade
 *       names, trademarks, service marks, or product names of the Licensor,
 *       except as required for reasonable and customary use in describing the
 *       origin of the Work and reproducing the content of the NOTICE file.
 *
 *    7. Disclaimer of Warranty. Unless required by applicable law or
 *       agreed to in writing, Licensor provides the Work (and each
 *       Contributor provides its Contributions) on an "AS IS" BASIS,
 *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 *       implied, including, without limitation, any warranties or conditions
 *       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
 *       PARTICULAR PURPOSE. You are solely responsible for determining the
 *       appropriateness of using or redistributing the Work and assume any
 *       risks associated with Your exercise of permissions under this License.
 *
 *    8. Limitation of Liability. In no event and under no legal theory,
 *       whether in tort (including negligence), contract, or otherwise,
 *       unless required by applicable law (such as deliberate and grossly
 *       negligent acts) or agreed to in writing, shall any Contributor be
 *       liable to You for damages, including any direct, indirect, special,
 *       incidental, or consequential damages of any character arising as a
 *       result of this License or out of the use or inability to use the
 *       Work (including but not limited to damages for loss of goodwill,
 *       work stoppage, computer failure or malfunction, or any and all
 *       other commercial damages or losses), even if such Contributor
 *       has been advised of the possibility of such damages.
 *
 *    9. Accepting Warranty or Additional Liability. While redistributing
 *       the Work or Derivative Works thereof, You may choose to offer,
 *       and charge a fee for, acceptance of support, warranty, indemnity,
 *       or other liability obligations and/or rights consistent with this
 *       License. However, in accepting such obligations, You may act only
 *       on Your own behalf and on Your sole responsibility, not on behalf
 *       of any other Contributor, and only if You agree to indemnify,
 *       defend, and hold each Contributor harmless for any liability
 *       incurred by, or claims asserted against, such Contributor by reason
 *       of your accepting any such warranty or additional liability.
 *
 *    END OF TERMS AND CONDITIONS
 *
 *    APPENDIX: How to apply the Apache License to your work.
 *
 *       To apply the Apache License to your work, attach the following
 *       boilerplate notice, with the fields enclosed by brackets "[]"
 *       replaced with your own identifying information. (Don't include
 *       the brackets!)  The text should be enclosed in the appropriate
 *       comment syntax for the file format. We also recommend that a
 *       file or class name and description of purpose be included on the
 *       same "printed page" as the copyright notice for easier
 *       identification within third-party archives.
 *
 *    Copyright 2016 Alibaba Group
 *
 *    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.taobao.android.apatch;

import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import com.taobao.android.APatchTool;
import com.taobao.android.PatchMethodTool;
import com.taobao.android.apatch.utils.Formater;
import com.taobao.android.apatch.utils.SmaliDiffUtils;
import com.taobao.android.apatch.utils.TypeGenUtil;
import com.taobao.android.differ.dex.DexDiffer;
import com.taobao.android.differ.dex.PatchException;
import com.taobao.android.object.DexDiffInfo;
import org.apache.commons.io.FileUtils;
import org.jf.dexlib2.dexbacked.DexBackedAnnotation;
import org.jf.dexlib2.dexbacked.DexBackedAnnotationElement;
import org.jf.dexlib2.dexbacked.DexBackedClassDef;
import org.jf.dexlib2.dexbacked.DexBackedMethod;
import org.jf.dexlib2.dexbacked.value.DexBackedAnnotationEncodedValue;
import org.jf.dexlib2.dexbacked.value.DexBackedArrayEncodedValue;
import org.jf.dexlib2.dexbacked.value.DexBackedTypeEncodedValue;
import org.jf.dexlib2.iface.Annotation;
import org.jf.dexlib2.iface.AnnotationElement;
import org.jf.dexlib2.iface.value.EncodedValue;
import org.jf.dexlib2.iface.value.TypeEncodedValue;
import org.jf.util.ClassFileNameHandler;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.sql.Date;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.jar.Attributes;
import java.util.jar.Manifest;

/**
 * @author sanping.li@alipay.com
 */
public class ApkPatch extends com.taobao.android.apatch.Build {

    private List<File> baseFiles = Lists.newArrayList();
    private List<File> newFiles = Lists.newArrayList();

    private File diffFile;
    private File diffJsonFile;
    private Set<String> classes;

    public static String currentClassType;

    // ???
    public void setPath(String filterPath) {
        this.filterPath = filterPath;
    }

    public ApkPatch(File baseFile, File newFile, String name, File out) {
        super(name, out);
        this.baseFiles.add(baseFile);
        this.newFiles.add(newFile);

    }

    public ApkPatch(List<File> baseFiles, List<File> newFiles, String name, File out) {
        super(name, out);
        this.baseFiles = baseFiles;
        this.newFiles = newFiles;

    }

    public void setDiffFile(File diffFile) {
        this.diffFile = diffFile;
    }

    public void setDiffJsonFile(File diffJsonFile) {
        this.diffJsonFile = diffJsonFile;
    }

    public File doPatch() throws PatchException {
        try {
            File aptchFolder = new File(out, name);
            File smaliDir = new File(aptchFolder, "smali");
            if (!smaliDir.exists()) {
                smaliDir.mkdirs();
            }
            try {
                FileUtils.cleanDirectory(smaliDir);
            } catch (IOException e) {
                throw new RuntimeException(e);
            }

            File dexFile = new File(aptchFolder, "diff.dex");
            if (dexFile.exists() && !dexFile.delete()) {
                throw new RuntimeException("diff.dex can't be removed.");
            }
            File outFile = new File(aptchFolder, "diff" + SUFFIX);
            if (outFile.exists() && !outFile.delete()) {
                throw new RuntimeException("diff" + SUFFIX + " can't be removed.");
            }

            currentTimeStamp = System.currentTimeMillis();
            DexDiffer dexDiffer = new DexDiffer(baseFiles, newFiles, 19);
            // ???
            if ((this.filterPath != null) && !(this.filterPath.equals(""))) {
                dexDiffer.createFilter(this.filterPath);
            }
            //diff
            DexDiffInfo info = dexDiffer.doDiff();
            dexDiffer.setDexDiffFilter(new AndFixFilterImpl(info));

            //diffFilter
            dexDiffer.dexFilter();

            info.update();
            //json
            if (null != diffFile && null != diffJsonFile) {
                info.writeToFile(name, diffFile, diffJsonFile);
            }
            //?dex
            classes = SmaliDiffUtils.buildCode(smaliDir, dexFile, info);
            if (null == classes || classes.size() <= 0) {
                return null;
            }

            //?dex
            if (APatchTool.debug) {
                PatchMethodTool.modifyMethod(dexFile.getAbsolutePath(), dexFile.getAbsolutePath(), true);
            }

            File smaliDir2 = new File(aptchFolder, "smali2");
            if (!smaliDir2.exists()) {
                smaliDir2.mkdirs();
            }
            try {
                FileUtils.cleanDirectory(smaliDir2);
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
            prepareClasses = buildPrepareClass(smaliDir2, newFiles, info);
            DexDiffInfo.release();
            build(outFile, dexFile);
            File file = release(aptchFolder, dexFile, outFile);
            release();
            return file;
        } catch (Exception e) {
            throw new PatchException(e);
        }
    }

    private static Set<String> buildPrepareClass(File smaliDir, List<File> newFiles, DexDiffInfo info)
            throws PatchException {
        Set<DexBackedClassDef> classes = Sets.newHashSet();
        classes = SmaliDiffUtils.scanClasses(smaliDir, newFiles);
        ArrayList<String> methods = new ArrayList<String>();
        {
            Set<DexBackedMethod> tempSet = info.getModifiedMethods();
            for (DexBackedMethod methodRef : tempSet) {
                String template = methodRef.getDefiningClass() + "->" + methodRef.getName();
                methods.add(template);
                System.out.println("template: " + template);
                if (superClasses.containsKey(methodRef.getDefiningClass())) {
                    ArrayList<String> derivedClasses = superClasses.get(methodRef.getDefiningClass());
                    for (int i = 0; i < derivedClasses.size(); i++) {
                        template = derivedClasses.get(i) + "->" + methodRef.getName();
                        System.out.println("template: " + template);
                        methods.add(template);
                    }
                }
            }
        }

        Set<String> prepareClasses = new HashSet<String>();
        try {
            final ClassFileNameHandler inFileNameHandler = new ClassFileNameHandler(smaliDir, ".smali");
            for (DexBackedClassDef classDef : classes) {
                currentClassType = null;
                String className = TypeGenUtil.newType(classDef.getType());
                // baksmali.disassembleClass(classDef, outFileNameHandler, options);
                File smaliFile = inFileNameHandler.getUniqueFilenameForClass(className);
                if (!smaliFile.exists()) {
                    continue;
                }
                //classprepare
                getClassAnnotaionPrepareClasses(classDef, prepareClasses, info);

                BufferedReader br = new BufferedReader(new FileReader(smaliFile));
                String data = br.readLine();// null?
                while (data != null) {
                    boolean find = false;
                    for (String m : methods) {
                        if (data.contains(m)) {
                            find = true;
                            break;
                        }
                    }
                    if (find) {
                        prepareClasses.add(className.substring(1, className.length() - 1).replace('/', '.'));
                        System.out.println("prepare class: " + className);
                        break;
                    }
                    data = br.readLine(); // ?
                }
                br.close();

            }
        } catch (Exception e) {
            throw new PatchException(e);
        }
        for (DexBackedMethod method : info.getModifiedMethods()) {
            prepareClasses.add(method.getDefiningClass().substring(1, method.getDefiningClass().length() - 1)
                    .replace("/", "."));
        }
        //modifyanatationprepare
        //        getMethodAnnotaionPrepareClasses(info,prepareClasses);
        return prepareClasses;
    }

    public static void getMethodAnnotaionPrepareClasses(DexDiffInfo dexDiffInfo, Set<String> prepareclasses) {

        for (DexBackedMethod method : dexDiffInfo.getModifiedMethods()) {
            Set<? extends Annotation> annotations = method.getAnnotations();
            if (annotations == null) {
                continue;
            }
            for (Annotation annotation : annotations) {
                String type = annotation.getType();
                if (type != null && type.startsWith("L") && type.endsWith(";")) {
                    prepareclasses.add(type.substring(1, type.length() - 1).replace('/', '.'));
                    System.out.println("prepare class: " + type);
                }
                Set<? extends AnnotationElement> elements = annotation.getElements();
                for (AnnotationElement dexBackedAnnotationElement : elements) {
                    if (dexBackedAnnotationElement.getValue() instanceof DexBackedArrayEncodedValue) {
                        List<? extends EncodedValue> values = ((DexBackedArrayEncodedValue) dexBackedAnnotationElement
                                .getValue()).getValue();
                        for (EncodedValue encodedValue : values) {
                            if (encodedValue instanceof TypeEncodedValue) {
                                prepareclasses.add(((TypeEncodedValue) encodedValue).getValue()
                                        .substring(1, ((TypeEncodedValue) encodedValue).getValue().length() - 1)
                                        .replace('/', '.'));
                                System.out
                                        .println("prepare class: " + ((TypeEncodedValue) encodedValue).getValue());
                            }
                        }

                    } else if (dexBackedAnnotationElement.getValue() instanceof DexBackedTypeEncodedValue) {
                        String value = ((DexBackedTypeEncodedValue) dexBackedAnnotationElement.getValue())
                                .getValue();
                        prepareclasses.add(value.substring(1, value.length() - 1).replace('/', '.'));
                        System.out.println("prepare class: " + value);
                    }
                }
            }
        }

    }

    public static void getClassAnnotaionPrepareClasses(DexBackedClassDef classDef, Set<String> prepareclasses,
            DexDiffInfo dexDiffInfo) {

        for (DexBackedClassDef modifyClasses : dexDiffInfo.getModifiedClasses()) {
            if (classDef.getType().equals(modifyClasses.getType())) {
                if (classDef.getAnnotations() != null) {
                    Set<? extends DexBackedAnnotation> annotations = classDef.getAnnotations();
                    for (DexBackedAnnotation annotation : annotations) {
                        String type = annotation.getType();
                        if (type != null && type.startsWith("L") && type.endsWith(";")) {
                            prepareclasses.add(type.substring(1, type.length() - 1).replace('/', '.'));
                            System.out.println("prepare class: " + type);
                        }
                        Set<? extends DexBackedAnnotationElement> elements = annotation.getElements();
                        for (DexBackedAnnotationElement dexBackedAnnotationElement : elements) {
                            if (dexBackedAnnotationElement.getValue() instanceof DexBackedArrayEncodedValue) {
                                List<? extends EncodedValue> values = ((DexBackedArrayEncodedValue) dexBackedAnnotationElement
                                        .getValue()).getValue();
                                for (EncodedValue encodedValue : values) {
                                    if (encodedValue instanceof TypeEncodedValue) {
                                        prepareclasses.add(((TypeEncodedValue) encodedValue).getValue()
                                                .substring(1,
                                                        ((TypeEncodedValue) encodedValue).getValue().length() - 1)
                                                .replace('/', '.'));
                                        System.out.println(
                                                "prepare class: " + ((TypeEncodedValue) encodedValue).getValue());
                                    }
                                }

                            } else if (dexBackedAnnotationElement.getValue() instanceof DexBackedTypeEncodedValue) {
                                String value = ((DexBackedTypeEncodedValue) dexBackedAnnotationElement.getValue())
                                        .getValue();
                                prepareclasses.add(value.substring(1, value.length() - 1).replace('/', '.'));
                                System.out.println("prepare class: " + value);
                            } else if (dexBackedAnnotationElement
                                    .getValue() instanceof DexBackedAnnotationEncodedValue) {
                                String value = ((DexBackedAnnotationEncodedValue) dexBackedAnnotationElement
                                        .getValue()).getType();
                            }

                        }
                    }

                }
            }
        }

    }

    @SuppressWarnings("deprecation")
    protected Manifest getMeta() {
        Manifest manifest = new Manifest();
        Attributes main = manifest.getMainAttributes();
        main.putValue("Manifest-Version", "1.0");
        main.putValue("Created-By", "1.0 (ApkPatch)");
        main.putValue("Created-Time", new Date(System.currentTimeMillis()).toGMTString());
        main.putValue("From-File", baseFiles.get(0).getName());
        main.putValue("To-File", newFiles.get(0).getName());
        main.putValue("Patch-Name", name);
        main.putValue(name + "-Patch-Classes", Formater.dotStringList(classes));
        main.putValue(name + "-Prepare-Classes", Formater.dotStringList(prepareClasses));
        main.putValue(name + "-Used-Methods", Formater.dotStringList(usedMethods));
        main.putValue(name + "-Modified-Classes", Formater.dotStringList(modifiedClasses));
        main.putValue(name + "-Used-Classes", Formater.dotStringList(usedClasses));
        main.putValue(name + "-add-classes", Formater.dotStringList(addClasses));
        return manifest;
    }

    public static void main(String[] args) throws IOException, PatchException {

        String baseDir = "/Users/lilong/Downloads/tpatch/";
        File from = new File(baseDir + "classes.dex");
        File to = new File(baseDir + "classes1.dex");

        File out = new File(baseDir);
        // FileUtils.cleanDirectory(out);

        String keystore = "/Users/seker/programs/debugsign/seker.keystore";
        String password = "12345678";
        String alias = "seker.keystore";
        String entry = "12345678";
        String name = "main";
        //        APatchTool.mappingFile = new File("/Users/lilong/Downloads/mapping.txt/target/proguard/full-mapping.txt");
        ApkPatch apkPatch = new ApkPatch(from, to, name, out);
        apkPatch.setDiffFile(new File(baseDir, "diff.txt"));
        StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace();
        for (StackTraceElement stackTraceElement : stackTraceElements) {
            System.out.println(stackTraceElement.getClassName() + ":" + stackTraceElement.getMethodName());
        }
        apkPatch.doPatch();
    }
}