com.taobao.android.builder.tools.manifest.ManifestHelper.java Source code

Java tutorial

Introduction

Here is the source code for com.taobao.android.builder.tools.manifest.ManifestHelper.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.tools.manifest;

import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

import com.android.build.gradle.internal.api.AppVariantContext;
import com.android.builder.model.AndroidLibrary;
import com.android.manifmerger.ManifestProvider;
import com.google.common.collect.Sets;
import com.taobao.android.builder.dependency.AtlasDependencyTree;
import com.taobao.android.builder.dependency.model.AwbBundle;
import com.taobao.android.builder.extension.AtlasExtension;
import com.taobao.android.builder.tools.bundleinfo.model.BundleInfo;
import org.apache.commons.lang.StringUtils;
import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.Node;
import org.dom4j.io.SAXReader;
import org.gradle.api.GradleException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Created by wuzhong on 2017/3/6.
 */
public class ManifestHelper {

    private static Logger sLogger = LoggerFactory.getLogger(ManifestHelper.class);

    public static List<ManifestProvider> getBundleManifest(AppVariantContext appVariantContext,
            AtlasDependencyTree dependencyTree, AtlasExtension atlasExtension) {

        Set<String> notMergedArtifacts = getNotMergedBundles(atlasExtension);

        List<ManifestProvider> bundleProviders = new ArrayList<>();

        for (AwbBundle awbBundle : dependencyTree.getAwbBundles()) {
            String cord = String.format("%s:%s", awbBundle.getResolvedCoordinates().getGroupId(),
                    awbBundle.getResolvedCoordinates().getArtifactId());

            if (null != notMergedArtifacts && notMergedArtifacts.contains(cord)) {
                continue;
            }

            bundleProviders.add(createManifestProvider(awbBundle.getAndroidLibrary(), appVariantContext));

            for (AndroidLibrary androidLibrary : awbBundle.getAndroidLibraries()) {
                bundleProviders.add(createManifestProvider(androidLibrary, appVariantContext));
            }

        }

        return bundleProviders;

    }

    public static boolean checkManifest(AppVariantContext appVariantContext, File fullManifest,
            AtlasDependencyTree dependencyTree, AtlasExtension atlasExtension) throws DocumentException {

        Set<String> notMergedArtifacts = getNotMergedBundles(atlasExtension);

        BundleInfo mainBundleInfo = new BundleInfo();
        collectBundleInfo(appVariantContext, mainBundleInfo, fullManifest, null);

        List<String> errors = new ArrayList<>();
        for (AwbBundle awbBundle : dependencyTree.getAwbBundles()) {
            String cord = String.format("%s:%s", awbBundle.getResolvedCoordinates().getGroupId(),
                    awbBundle.getResolvedCoordinates().getArtifactId());

            if (null != notMergedArtifacts && notMergedArtifacts.contains(cord)) {
                continue;
            }

            for (String activity : awbBundle.bundleInfo.getActivities()) {
                if (StringUtils.isNotEmpty(activity) && !mainBundleInfo.getActivities().contains(activity)) {
                    errors.add("miss activity:" + activity);
                }
            }

            for (String service : awbBundle.bundleInfo.getServices()) {
                if (StringUtils.isNotEmpty(service) && !mainBundleInfo.getServices().contains(service)) {
                    errors.add("miss service:" + service);
                }
            }

            for (String provider : awbBundle.bundleInfo.getContentProviders()) {
                if (StringUtils.isNotEmpty(provider) && !mainBundleInfo.getContentProviders().contains(provider)) {
                    errors.add("miss provider:" + provider);
                }
            }

            for (String receiver : awbBundle.bundleInfo.getReceivers()) {
                if (StringUtils.isNotEmpty(receiver) && !mainBundleInfo.getReceivers().contains(receiver)) {
                    errors.add("miss receiver:" + receiver);
                }
            }

        }

        if (errors.isEmpty()) {
            return true;
        }

        for (String err : errors) {
            sLogger.error(err);
        }

        throw new GradleException("manifest merge error :" + StringUtils.join(errors, ","));
    }

    private static Set<String> getNotMergedBundles(AtlasExtension atlasExtension) {
        Set<String> notMergedArtifacts = Sets.newHashSet();
        if (null != atlasExtension.getManifestOptions()
                && null != atlasExtension.getManifestOptions().getNotMergedBundles()) {
            notMergedArtifacts = atlasExtension.getManifestOptions().getNotMergedBundles();
        }
        return notMergedArtifacts;
    }

    private static ManifestProvider createManifestProvider(AndroidLibrary androidLibrary,
            AppVariantContext appVariantContext) {
        File modifyManifest = getModifyManifestFile(androidLibrary, appVariantContext);
        return new BundleManifestProvider(modifyManifest);
    }

    private static File getModifyManifestFile(AndroidLibrary androidLibrary, AppVariantContext appVariantContext) {
        return getModifyManifestFile(androidLibrary.getManifest(), appVariantContext);
    }

    public static File getModifyManifestFile(File manifest, AppVariantContext appVariantContext) {

        File modifyManifest = (File) appVariantContext.manifestMap.get(manifest.getAbsolutePath());

        //sLogger.error("get file : " + manifest.getAbsolutePath() + "->" + modifyManifest);

        if (null == modifyManifest || !modifyManifest.exists()) {
            return manifest;
        }
        return modifyManifest;
    }

    public static void collectBundleInfo(AppVariantContext appVariantContext, BundleInfo bundleInfo, File manifest,
            List<AndroidLibrary> androidLibraries) throws DocumentException {
        SAXReader reader = new SAXReader();
        Document document = reader.read(getModifyManifestFile(manifest, appVariantContext));// ?XML
        Element root = document.getRootElement();// 

        List<? extends Node> metadataNodes = root.selectNodes("//meta-data");
        for (Node node : metadataNodes) {
            Element element = (Element) node;
            Attribute attribute = element.attribute("name");
            if (attribute.getValue().equals("label")) {
                Attribute labelAttribute = element.attribute("value");
                bundleInfo.setName(labelAttribute.getValue());
            } else if (attribute.getValue().equals("description")) {
                Attribute descAttribute = element.attribute("value");
                bundleInfo.setDesc(descAttribute.getValue());
            }
        }

        addComponents(bundleInfo, root);

        if (null != androidLibraries) {
            for (AndroidLibrary depLib : androidLibraries) {
                SAXReader reader2 = new SAXReader();
                Document document2 = reader2.read(getModifyManifestFile(depLib.getManifest(), appVariantContext));// ?XML
                Element root2 = document2.getRootElement();// 
                addComponents(bundleInfo, root2);
            }
        }

    }

    private static void addComponents(BundleInfo bundleInfo, Element root) {
        List<? extends Node> serviceNodes = root.selectNodes("//service");
        for (Node node : serviceNodes) {
            Element element = (Element) node;
            Attribute attribute = element.attribute("name");
            bundleInfo.getServices().add(attribute.getValue());
        }
        List<? extends Node> receiverNodes = root.selectNodes("//receiver");
        for (Node node : receiverNodes) {
            Element element = (Element) node;
            Attribute attribute = element.attribute("name");
            bundleInfo.getReceivers().add(attribute.getValue());
        }
        List<? extends Node> providerNodes = root.selectNodes("//provider");
        for (Node node : providerNodes) {
            Element element = (Element) node;
            Attribute attribute = element.attribute("name");

            bundleInfo.getContentProviders().add(attribute.getValue());
        }
        List<? extends Node> activityNodes = root.selectNodes("//activity");
        for (Node node : activityNodes) {
            Element element = (Element) node;
            Attribute attribute = element.attribute("name");

            bundleInfo.getActivities().add(attribute.getValue());
        }
    }

    public static List<ManifestProvider> convert(List<ManifestProvider> manifestProviders,
            AppVariantContext appVariantContext) {
        List<ManifestProvider> modifyManifest = new ArrayList<>();

        for (ManifestProvider manifestProvider : manifestProviders) {

            File manifest = getModifyManifestFile(manifestProvider.getManifest(), appVariantContext);

            modifyManifest.add(new MainManifestProvider(manifest, manifestProvider.getName()));

        }

        return modifyManifest;
    }

    public static class BundleManifestProvider implements ManifestProvider {

        private File manifest;

        public BundleManifestProvider(File manifest) {
            this.manifest = manifest;
        }

        @Override
        public File getManifest() {
            return manifest;
        }

        @Override
        public String getName() {
            return manifest.getName();
        }
    }

    public static class MainManifestProvider implements ManifestProvider {

        private File manifest;
        private String name;

        public MainManifestProvider(File manifest, String name) {
            this.manifest = manifest;
            this.name = name;
        }

        @Override
        public File getManifest() {
            return manifest;
        }

        @Override
        public String getName() {
            return name;
        }
    }

    public static List<? extends AndroidLibrary> getManifestDependencies(List<AwbBundle> awbBundles,
            Set<String> notMergedArtifacts, org.gradle.api.logging.Logger logger) {

        List<AndroidLibrary> list = new ArrayList<>();

        for (AwbBundle lib : awbBundles) {
            // get the dependencies
            // [vliux] respect manifestOption.notMergedBundle
            String cord = String.format("%s:%s", lib.getResolvedCoordinates().getGroupId(),
                    lib.getResolvedCoordinates().getArtifactId());
            if (null == notMergedArtifacts || !notMergedArtifacts.contains(cord)) {

                list.add(lib.getAndroidLibrary());
                list.addAll(lib.getAndroidLibraries());

            } else {
                logger.info("[NotMergedManifest] " + cord);
            }
        }

        return list;
    }
}