com.taobao.android.builder.tasks.app.prepare.PreparePackageIdsTask.java Source code

Java tutorial

Introduction

Here is the source code for com.taobao.android.builder.tasks.app.prepare.PreparePackageIdsTask.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.builder.tasks.app.prepare;

/**
 * Created by wuzhong on 16/6/13.
 */

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.tasks.BaseTask;
import com.android.build.gradle.internal.variant.BaseVariantOutputData;
import com.taobao.android.builder.AtlasBuildContext;
import com.taobao.android.builder.dependency.AtlasDependencyTree;
import com.taobao.android.builder.dependency.model.AwbBundle;
import com.taobao.android.builder.tasks.manager.MtlBaseTaskAction;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.gradle.api.GradleException;
import org.gradle.api.tasks.TaskAction;

import java.io.File;
import java.io.IOException;
import java.util.*;

/**
 * ?packageId
 */
public class PreparePackageIdsTask extends BaseTask {

    AppVariantContext appVariantContext;
    AppVariantOutputContext.AppBuildInfo appBuildInfo;

    /**
     * packageid  30 - 127
     */
    @TaskAction
    void generate() throws IOException {

        File packageIdFile = appVariantContext.getAtlasExtension().getTBuildConfig().getPackageIdFile();
        File apPackageIdFile = appVariantContext.apContext.getPackageIdFile();
        boolean isAutoPackageId = appVariantContext.getAtlasExtension().getTBuildConfig().isAutoPackageId();

        Map<String, String> autoConfigMap = new HashMap<String, String>();
        if (null != apPackageIdFile && apPackageIdFile.exists()) {
            autoConfigMap.putAll(loadPackageIdProperties(apPackageIdFile));
        } else if (null != packageIdFile && packageIdFile.exists()) {
            autoConfigMap.putAll(loadPackageIdProperties(packageIdFile));
        }

        AtlasDependencyTree atlasDependencyTree = AtlasBuildContext.androidDependencyTrees.get(getVariantName());

        for (AwbBundle awbBundle : atlasDependencyTree.getAwbBundles()) {
            String key = awbBundle.getResolvedCoordinates().getGroupId() + ":"
                    + awbBundle.getResolvedCoordinates().getArtifactId();
            if (autoConfigMap.containsKey(key)) {
                continue;
            }

            File customPackageIDFile = new File(awbBundle.getAndroidLibrary().getFolder(), "customPackageID.txt");
            String packageId = getCustomPackageId(customPackageIDFile);
            if (StringUtils.isNotEmpty(packageId) && StringUtils.isNumeric(packageId)) {
                autoConfigMap.put(key, packageId);
            } else {
                autoConfigMap.put(key, "");
            }
        }

        if (isAutoPackageId && autoConfigMap.containsValue("")) {

            //?autoConfig
            List<String> keys = new ArrayList<String>(autoConfigMap.keySet());
            Collections.sort(keys);

            for (String key : keys) {
                if ("".equals(autoConfigMap.get(key))) {
                    for (int i = 30; i <= 127; i++) {
                        if (!autoConfigMap.values().contains(String.valueOf(i))) {
                            autoConfigMap.put(key, String.valueOf(i));
                            break;
                        }
                    }
                }
            }

        }

        AtlasBuildContext.customPackageIdMaps = autoConfigMap;

        //wite package Id file
        File outPkgFile = new File(getProject().getBuildDir(), "outputs/packageIdFile.properties");
        writeProperties(autoConfigMap, outPkgFile);

        appBuildInfo.setPackageIdFile(outPkgFile);

        //check value
        if (autoConfigMap.containsValue("")) {
            getLogger().error(JSON.toJSONString(autoConfigMap, true));
            throw new GradleException("packageId ?");
        }

        if (autoConfigMap.size() != new HashSet(autoConfigMap.values()).size()) {
            //            getLogger().error(JSON.toJSONString(autoConfigMap, true));

            Map<String, PackageIdItem> idItemMap = new HashMap<String, PackageIdItem>();

            for (String key : autoConfigMap.keySet()) {
                String customPackageId = autoConfigMap.get(key);
                PackageIdItem packageIdItem = idItemMap.get(customPackageId);
                if (null == packageIdItem) {
                    String[] split = customPackageId.split("\\.");
                    packageIdItem = new PackageIdItem();
                    packageIdItem.packageId = Integer.valueOf(split[0]);
                    if (split.length > 1) {
                        packageIdItem.typeIdOffset = Integer.valueOf(split[1]);
                    }
                    idItemMap.put(customPackageId, packageIdItem);
                }
                packageIdItem.bundles.add(key);
            }

            Collection<PackageIdItem> collection = idItemMap.values();
            List<PackageIdItem> packageList = new ArrayList<PackageIdItem>(collection);
            Collections.sort(packageList, new Comparator<PackageIdItem>() {
                @Override
                public int compare(PackageIdItem o1, PackageIdItem o2) {
                    return o1.packageId - o2.packageId;
                }
            });
            getLogger().error(JSON.toJSONString(packageList, true));

            throw new GradleException("packageId ???");
        }

        // check if packageID is not used
        Map<String, String> autoConfigMap2 = new HashMap<>(autoConfigMap);
        for (AwbBundle awbBundle : atlasDependencyTree.getAwbBundles()) {
            String key = awbBundle.getResolvedCoordinates().getGroupId() + ":"
                    + awbBundle.getResolvedCoordinates().getArtifactId();
            autoConfigMap2.remove(key);
        }
        if (autoConfigMap2.size() > 0) {
            File outPkgFile2 = new File(getProject().getBuildDir(),
                    "outputs/warning-unusedPackageIdFile.properties");
            writeProperties(autoConfigMap2, outPkgFile2);
        }

    }

    private void writeProperties(Map<String, String> map, File file) {
        file.delete();
        file.getParentFile().mkdirs();
        try {
            List<String> lines = new ArrayList<String>();
            for (String key : map.keySet()) {
                lines.add(key + "=" + map.get(key));
            }
            FileUtils.writeLines(file, lines);
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

    /**
     * ?packageId
     *
     * @param packageIdFile
     * @return
     */
    private Map<String, String> loadPackageIdProperties(File packageIdFile) throws IOException {
        Map<String, String> values = new HashMap<String, String>();
        if (null != packageIdFile && packageIdFile.exists() && packageIdFile.isFile()) {
            List<String> lines = FileUtils.readLines(packageIdFile);
            for (String line : lines) {
                String[] lineValues = StringUtils.split(line, "=");
                if (null != lineValues && lineValues.length >= 2) {
                    String key = StringUtils.trim(lineValues[0]);
                    String value = StringUtils.trim(lineValues[1]);
                    values.put(key, value);
                }
            }
        }
        return values;
    }

    private String getCustomPackageId(File customIdFile) throws IOException {
        if (null != customIdFile && customIdFile.exists()) {
            return FileUtils.readFileToString(customIdFile);
        }
        return "";
    }

    public static class ConfigAction extends MtlBaseTaskAction<PreparePackageIdsTask> {

        private AppVariantContext appVariantContext;

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

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

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

        @Override
        public void execute(PreparePackageIdsTask packageIdsTask) {

            super.execute(packageIdsTask);

            packageIdsTask.appVariantContext = appVariantContext;
            packageIdsTask.appBuildInfo = getAppVariantOutputContext().appBuildInfo;

        }
    }

    public static class PackageIdItem {
        public int packageId;
        public int typeIdOffset;
        public List<String> bundles = new ArrayList<String>();
    }

}