/atlas-gradle-plugin/atlas-plugin/src/main/java/com/taobao/android/builder/tasks/tpatch/TPatchTask.java

/*
 *
 *
 *                                  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.builder.tasks.tpatch;

import com.alibaba.fastjson.JSON;
import com.android.build.gradle.internal.api.AppVariantContext;
import com.android.build.gradle.internal.api.AppVariantOutputContext;
import com.android.build.gradle.internal.scope.ConventionMappingHelper;
import com.android.build.gradle.internal.tasks.BaseTask;
import com.android.build.gradle.internal.variant.ApkVariantOutputData;
import com.android.build.gradle.internal.variant.BaseVariantOutputData;
import com.android.builder.signing.DefaultSigningConfig;
import com.taobao.android.TPatchTool;
import com.taobao.android.builder.AtlasBuildContext;
import com.taobao.android.builder.extension.TBuildType;
import com.taobao.android.builder.tasks.manager.MtlBaseTaskAction;
import com.taobao.android.builder.tools.BuildHelper;
import com.taobao.android.builder.tools.VersionUtils;
import com.taobao.android.builder.tools.manifest.ManifestFileUtils;
import com.taobao.android.builder.tools.update.UpdateInfo;
import com.taobao.android.object.ApkFileList;
import com.taobao.android.object.ArtifactBundleInfo;
import com.taobao.android.object.BuildPatchInfos;

import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.dom4j.DocumentException;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.StopExecutionException;
import org.gradle.api.tasks.TaskAction;

import java.io.File;
import java.io.IOException;
import java.io.Serializable;
import java.util.Set;
import java.util.concurrent.Callable;

/**
 * Andfix的patch的任务
 * Created by wuzhong
 */
public class TPatchTask extends BaseTask {

    private TPatchContext patchContext;

    private DefaultSigningConfig signingConfig;

    private File outPatchFolder;

    @TaskAction
    public void doTPatch() throws Exception {

        patchContext = getPatchContext();
        signingConfig = getSigningConfig();
        outPatchFolder = getOutPatchFolder();

        // 获取容器版本
        String baseApkVersion = patchContext.getBaseVersionName();
        String newApkVersion = patchContext.versionName;

        File baseApk = patchContext.getBaseApk();

        File newApk = patchContext.diffApkFile;
        boolean retainMainBundleRes = true;

        if (null == newApk || !newApk.exists()) {
            newApk = patchContext.newApk;
            retainMainBundleRes = false;
        }

        getLogger().info("BaseApk:" +
                                 baseApk +
                                 ",baseVersion:" +
                                 baseApkVersion +
                                 ",newApk:" +
                                 newApk +
                                 ",newApkVersion:" +
                                 newApkVersion);

        TPatchTool tPatchTool = new TPatchTool(baseApk,
                                               newApk,
                                               baseApkVersion,
                                               newApkVersion,
                                               patchContext.diffBundleDex);

        tPatchTool.setMainBundleName(patchContext.mainBundleName);
        if (StringUtils.isNotBlank(patchContext.excludeFiles)) {
            tPatchTool.setNotIncludeFiles(patchContext.excludeFiles.split(","));
        }
        tPatchTool.setRetainMainBundleRes(retainMainBundleRes);
        if (null != patchContext.artifactBundleInfos) {
            tPatchTool.setArtifactBundleInfos(patchContext.artifactBundleInfos);
        }

        tPatchTool.setBaseApkFileList(patchContext.getBaseApkFiles());
        tPatchTool.setNewApkFileList(patchContext.getNewApkFiles());
        tPatchTool.setLogger(getILogger());
        tPatchTool.setOnlyIncludeModifyBundle(patchContext.onlyBuildModifyAwb);
        tPatchTool.setNoPatchBundles(patchContext.notPatchBundles);

        ApkFileList apkFileList = AtlasBuildContext.finalApkFileList;
        try {

            tPatchTool.setDexcode(apkFileList.getMainBundle().get("classes.dex"));

            FileUtils.writeStringToFile(new File(getOutPatchFolder(), "tpatch-bundles.json"),
                                        JSON.toJSONString(patchContext.artifactBundleInfos));

            getLogger().info("start to do patch");
            tPatchTool.doPatch(outPatchFolder,
                               true,
                               new File(getOutPatchFolder(), "patchs.json"),
                               StringUtils.isNotEmpty(patchContext.tpatchHistoryUrl),
                               patchContext.tpatchHistoryUrl,
                               patchContext.appSignName);
            getLogger().info("finish  do patch");

            File patchJson = new File(getOutPatchFolder(), "patchs.json");
            File updateJson = new File(getOutPatchFolder(), "update.json");
            String json = FileUtils.readFileToString(patchJson);
            BuildPatchInfos patchInfos = JSON.parseObject(json, BuildPatchInfos.class);
            UpdateInfo updateInfo = new UpdateInfo(patchInfos);
            FileUtils.writeStringToFile(updateJson, JSON.toJSONString(updateInfo, true));
        } catch (Exception e) {
            e.printStackTrace();
            throw new StopExecutionException(e.getMessage());
        }

        File baseVesrionApk = new File(patchContext.newApk.getParentFile(),
                                       patchContext.newApk.getName()
                                               .replace(".apk", "-" + baseApkVersion + ".apk"));
        FileUtils.copyFile(patchContext.getBaseApk(), baseVesrionApk);
        if (patchContext.writeBuildInfo && StringUtils.isNotEmpty(patchContext.buildId)) {
            File buildFile = new File(getOutPatchFolder(), "build.txt");
            FileUtils.writeStringToFile(buildFile,
                                        patchContext.buildId +
                                                "," +
                                                patchContext.versionName +
                                                "," +
                                                apkFileList.getMainBundle().get("classes.dex"));
            if (buildFile != null && buildFile.exists()) {
                getLogger().debug("write build to apk!");
                BuildHelper.writeFileToApk(buildFile, baseVesrionApk, "assets/build.txt");
            }
            BuildHelper.reSign(baseVesrionApk, signingConfig);
        }

        FileUtils.forceDelete(patchContext.newApk);
    }

    @OutputDirectory
    public File getOutPatchFolder() {
        return outPatchFolder;
    }

    public DefaultSigningConfig getSigningConfig() {
        return signingConfig;
    }

    @Input
    public TPatchContext getPatchContext() {
        return patchContext;
    }

    public static class ConfigAction extends MtlBaseTaskAction<TPatchTask> {

        private AppVariantContext appVariantContext;

        public ConfigAction(AppVariantContext appVariantContext,
                            BaseVariantOutputData baseVariantOutputData) {
            super(appVariantContext, baseVariantOutputData);
            this.appVariantContext = appVariantContext;
        }

        @Override
        public String getName() {
            return scope.getTaskName("Create", "TPatch");
        }

        @Override
        public Class<TPatchTask> getType() {
            return TPatchTask.class;
        }

        @Override
        public void execute(TPatchTask tPatchTask) {

            super.execute(tPatchTask);

            final TBuildType tBuildType = appVariantContext.getBuildType();

            if (null == tBuildType ||
                    null == tBuildType.getPatchConfig() ||
                    !tBuildType.getPatchConfig().isCreateTPatch()) {
                tPatchTask.setEnabled(false);
                return;
            }

            final ApkVariantOutputData variantOutputData = (ApkVariantOutputData) scope.getVariantOutputData();

            ConventionMappingHelper.map(tPatchTask, "outPatchFolder", new Callable<File>() {

                @Override
                public File call() throws Exception {
                    return getAppVariantOutputContext().getTPatchFolder();
                }
            });

            ConventionMappingHelper.map(tPatchTask,
                                        "signingConfig",
                                        new Callable<DefaultSigningConfig>() {

                                            @Override
                                            public DefaultSigningConfig call() throws Exception {
                                                return appVariantContext.getSigningConfig();
                                            }
                                        });

            ConventionMappingHelper.map(tPatchTask, "patchContext", new Callable<TPatchContext>() {

                @Override
                public TPatchContext call() throws Exception {

                    TPatchContext tPatchContext = new TPatchContext();

                    AppVariantOutputContext appVariantOutputContext = getAppVariantOutputContext();

                    tPatchContext.diffApkFile = appVariantOutputContext.getDiffApk();
                    tPatchContext.newApk = appVariantOutputContext.getApkOutputFile(true);
                    tPatchContext.outPatchFolder = appVariantOutputContext.getTPatchFolder();
                    tPatchContext.manifestFile = variantOutputData.manifestProcessorTask.getManifestOutputFile();
                    tPatchContext.apExplodeFolder = appVariantContext.apContext.getApExploredFolder();
                    tPatchContext.versionName = VersionUtils.getVersionName((ApkVariantOutputData) baseVariantOutputData,
                                                                            variantOutputData.manifestProcessorTask
                                                                                    .getManifestOutputFile());
                    tPatchContext.tpatchHistoryUrl = tBuildType.getPatchConfig()
                            .getTpatchHistoryUrl();
                    tPatchContext.onlyBuildModifyAwb = tBuildType.getPatchConfig()
                            .getOnlyBuildModifyAwb();
                    tPatchContext.artifactBundleInfos = appVariantOutputContext.artifactBundleInfos;
                    tPatchContext.notPatchBundles = tBuildType.getPatchConfig().getNoPatchBundles();
                    tPatchContext.mainBundleName = tBuildType.getPatchConfig()
                            .getTpatchMainBundleName();
                    tPatchContext.excludeFiles = tBuildType.getPatchConfig()
                            .gettPatchNotIncludeFiles()
                            .isEmpty() ? "" : StringUtils.join(tBuildType.getPatchConfig()
                                                                       .gettPatchNotIncludeFiles(),
                                                               ",");

                    tPatchContext.buildId = tBuildType.getPatchConfig().getBuildId();
                    tPatchContext.writeBuildInfo = tBuildType.getPatchConfig()
                            .isTpatchWriteBuildInfo();
                    tPatchContext.diffBundleDex = tBuildType.getPatchConfig()
                            .isOnlyIncrementInAwb();
                    tPatchContext.appSignName = tBuildType.getPatchConfig().getAppSignName();

                    return tPatchContext;
                }
            });
        }
    }

    public static class TPatchContext implements Serializable {

        public File diffApkFile;

        public File newApk;

        public File outPatchFolder;

        public File manifestFile;

        public File apExplodeFolder;

        public String versionName;

        public String tpatchHistoryUrl;

        public Boolean onlyBuildModifyAwb;

        public String notPatchBundles;

        public String buildId;

        public boolean writeBuildInfo;

        /**
         * 判断是否对bundle的dex文件进行diff操作
         */
        public boolean diffBundleDex;

        //    @Parameter(property = "android.patch.mainBundleName", defaultValue = "libcom_taobao_maindex")
        public String mainBundleName;

        public Set<ArtifactBundleInfo> artifactBundleInfos;

        /**
         * patch需要排除的目录
         */
        public String excludeFiles;

        public String appSignName;

        public static final String APK_FILE_MD5 = "apk-files.txt";

        public File getNewApkFiles() throws IOException {
            ApkFileList apkFileList = AtlasBuildContext.finalApkFileList;
            File apkFiles = new File(outPatchFolder.getParentFile(), APK_FILE_MD5);
            FileUtils.writeStringToFile(apkFiles, JSON.toJSONString(apkFileList));
            return apkFiles;
        }

        public File getBaseApk() {
            File apkFile = new File(apExplodeFolder, "android.apk");
            return apkFile;
        }

        public File getBaseApkFiles() {
            File apkFileList = new File(apExplodeFolder, APK_FILE_MD5);
            return apkFileList;
        }

        public String getBaseVersionName() throws IOException, DocumentException {
            File apManifestFile = new File(apExplodeFolder, "AndroidManifest.xml");
            String baseVersionName = ManifestFileUtils.getVersionName(apManifestFile);
            return baseVersionName;
        }
    }
}