/*
*
*
*
* 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.core.GradleVariantConfiguration;
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.taobao.android.builder.AtlasBuildContext;
import com.taobao.android.builder.dependency.AtlasDependencyTree;
import com.taobao.android.builder.dependency.diff.DependencyCompareUtils;
import com.taobao.android.builder.dependency.diff.DependencyDiff;
import com.taobao.android.builder.dependency.model.AwbBundle;
import com.taobao.android.builder.dependency.output.DependencyJson;
import com.taobao.android.builder.tasks.manager.MtlBaseTaskAction;
import com.taobao.android.builder.tools.bundleinfo.model.BundleInfo;
import com.taobao.android.builder.tools.manifest.ManifestFileUtils;
import com.taobao.android.object.ArtifactBundleInfo;
import com.taobao.android.object.DiffType;
import org.apache.commons.io.FileUtils;
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.gradle.api.tasks.InputDirectory;
import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.Optional;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.TaskAction;
import java.io.File;
import java.io.IOException;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Callable;
/**
* Created by wuzhong on 16/6/24.
*/
public class DiffBundleInfoTask extends BaseTask {
private AppVariantOutputContext appVariantOutputContext;
private File apDir;
private File manifestFile;
private File outJsonFile;
private DependencyDiff dependencyDiff;
@OutputDirectory
@Optional
public File getOutJsonFile() {
return outJsonFile;
}
@InputFile
@Optional
public File getManifestFile() {
return manifestFile;
}
public DependencyDiff getDependencyDiff() {
return dependencyDiff;
}
@InputDirectory
@Optional
public File getApDir() {
return apDir;
}
/**
* 生成这个文件
*/
@TaskAction
public void generate() throws IOException {
dependencyDiff = getDependencyDiff();
//如果是patch的话,得到diff的操作
if (null == dependencyDiff) {
return;
}
try {
appVariantOutputContext.artifactBundleInfos = getArtifactBundleInfo(getDependencyDiff(),
getManifestFile(),
getApDir());
FileUtils.writeStringToFile(new File(getOutJsonFile(), "dependencyDiff.json"),
JSON.toJSONString(dependencyDiff, true));
} catch (Exception e) {
throw new GradleException(e.getMessage());
}
}
private Set<ArtifactBundleInfo> getArtifactBundleInfo(DependencyDiff dependencyDiff,
File mainfestFile,
File apDir) throws IOException, DocumentException {
Set<ArtifactBundleInfo> artifactBundleInfos = new HashSet<ArtifactBundleInfo>();
if (null == apDir) {
throw new GradleException("No Ap dependency found!");
}
File apManifest = new File(apDir, "AndroidManifest.xml");
String apVersion = null;
try {
apVersion = ManifestFileUtils.getVersionName(apManifest);
} catch (Exception e) {
throw new GradleException(e.getMessage(), e);
}
// 1. 首先添加主bundle
ArtifactBundleInfo mainBundleInfo = getMainArtifactBundInfo(mainfestFile);
mainBundleInfo.setBaseVersion(apVersion);
mainBundleInfo.setMainBundle(true);
mainBundleInfo.setVersion(appVariantOutputContext.getVariantContext()
.getVariantConfiguration()
.getVersionName());
if (dependencyDiff.getMainDexDiffs().size() > 0) {
mainBundleInfo.setDiffType(DiffType.MODIFY);
} else {
mainBundleInfo.setDiffType(DiffType.NONE);
}
artifactBundleInfos.add(mainBundleInfo);
// 2. 添加各自的bundle
AtlasDependencyTree atlasDependencyTree = AtlasBuildContext.androidDependencyTrees.get(
appVariantOutputContext.getVariantContext().
getVariantConfiguration().getFullName());
for (AwbBundle awbBundle : atlasDependencyTree.getAwbBundles()) {
BundleInfo bundleInfo = awbBundle.bundleInfo;
ArtifactBundleInfo awbBundleInfo = new ArtifactBundleInfo();
awbBundleInfo.setMainBundle(false);
awbBundleInfo.setDependency(bundleInfo.getDependency());
awbBundleInfo.setPkgName(bundleInfo.getPkgName());
awbBundleInfo.setApplicationName(bundleInfo.getApplicationName());
awbBundleInfo.setArtifactId(awbBundle.getResolvedCoordinates().getArtifactId());
awbBundleInfo.setName(bundleInfo.getName());
String version = bundleInfo.getVersion();
if (version.indexOf("@") > 0) {
String[] arr = version.split("@");
version = arr[arr.length - 1];
}
awbBundleInfo.setVersion(version);
String libBundleName = getBundleName(awbBundle);
if (dependencyDiff.getAwbDiffs().contains(libBundleName)) {
if (dependencyDiff.getNewAwbs().contains(libBundleName)) {
awbBundleInfo.setDiffType(DiffType.ADD);
} else {
awbBundleInfo.setDiffType(DiffType.MODIFY);
}
} else {
awbBundleInfo.setDiffType(DiffType.NONE);
}
artifactBundleInfos.add(awbBundleInfo);
}
return artifactBundleInfos;
}
private String getBundleName(AwbBundle libraryDependency) {
return libraryDependency.getResolvedCoordinates().getGroupId() +
":" +
libraryDependency.getResolvedCoordinates().getArtifactId();
}
private static ArtifactBundleInfo getMainArtifactBundInfo(File manifestFile) {
ArtifactBundleInfo mainBundleInfo = new ArtifactBundleInfo();
SAXReader reader = new SAXReader();
Document document = null;// 读取XML文件
try {
document = reader.read(manifestFile);
} catch (DocumentException e) {
throw new GradleException(e.getMessage(), e);
}
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");
mainBundleInfo.setName(labelAttribute.getValue());
}
}
List<? extends Node> applicatNodes = root.selectNodes("//application");
for (Node node : applicatNodes) {
Element element = (Element) node;
Attribute attribute = element.attribute("name");
if (attribute != null) {
mainBundleInfo.setApplicationName(attribute.getValue());
}
}
if ("manifest".equalsIgnoreCase(root.getName())) {
List<Attribute> attributes = root.attributes();
for (Attribute attr : attributes) {
if (StringUtils.equalsIgnoreCase(attr.getName(), "versionName")) {
String versionName = attr.getValue();
mainBundleInfo.setVersion(versionName);
}
}
}
String pkgName = root.attributeValue("package");
mainBundleInfo.setPkgName(pkgName);
return mainBundleInfo;
}
public static class ConfigAction extends MtlBaseTaskAction<DiffBundleInfoTask> {
private AppVariantContext appVariantContext;
public ConfigAction(AppVariantContext appVariantContext,
BaseVariantOutputData baseVariantOutputData) {
super(appVariantContext, baseVariantOutputData);
this.appVariantContext = appVariantContext;
}
/**
* Return the name of the task to be configured.
*/
@Override
public String getName() {
return scope.getTaskName("DiffBundleInfo");
}
/**
* Return the class type of the task to be configured.
*/
@Override
public Class<DiffBundleInfoTask> getType() {
return DiffBundleInfoTask.class;
}
/**
* Performs this action against the given object.
*
* @param diffBundleInfoTask The object to perform the action on.
*/
@Override
public void execute(DiffBundleInfoTask diffBundleInfoTask) {
super.execute(diffBundleInfoTask);
final ApkVariantOutputData variantOutputData = (ApkVariantOutputData) scope.getVariantOutputData();
final GradleVariantConfiguration config = scope.getVariantScope()
.getVariantConfiguration();
ConventionMappingHelper.map(diffBundleInfoTask, "outJsonFile", new Callable<File>() {
@Override
public File call() throws Exception {
File file = scope.getVariantScope().getGlobalScope().getOutputsDir();
if (!file.exists()) {
file.mkdirs();
}
return file;
}
});
ConventionMappingHelper.map(diffBundleInfoTask, "manifestFile", new Callable<File>() {
@Override
public File call() throws Exception {
return variantOutputData.manifestProcessorTask.getManifestOutputFile();
}
});
//设置DependencyDiff
ConventionMappingHelper.map(diffBundleInfoTask,
"dependencyDiff",
new Callable<DependencyDiff>() {
@Override
public DependencyDiff call() throws Exception {
if (null !=
appVariantContext.apContext.getApExploredFolder() &&
appVariantContext.apContext.getApExploredFolder()
.exists()) {
DependencyJson dependencyJson = AtlasBuildContext.androidDependencyTrees
.get(scope.getVariantOutputData().variantData
.getName())
.getDependencyJson();
File baseDependencyFile = new File(
appVariantContext.apContext.getApExploredFolder(),
"dependencies.txt");
if (baseDependencyFile.exists()) {
DependencyDiff dependencyDiff = DependencyCompareUtils
.diff(baseDependencyFile,
dependencyJson);
return dependencyDiff;
}
}
return null;
}
});
ConventionMappingHelper.map(diffBundleInfoTask, "apDir", new Callable<File>() {
@Override
public File call() throws Exception {
if (null != appVariantContext.apContext.getApExploredFolder() &&
appVariantContext.apContext.getApExploredFolder().exists()) {
return appVariantContext.apContext.getApExploredFolder();
}
return null;
}
});
diffBundleInfoTask.appVariantOutputContext = getAppVariantOutputContext();
}
}
}