/*
*
*
*
* 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.merge;
/**
* Created by wuzhong on 16/6/13.
*/
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.android.builder.model.AndroidLibrary;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
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.dependency.model.SoLibrary;
import com.taobao.android.builder.tasks.manager.MtlBaseTaskAction;
import com.taobao.android.builder.tools.solib.NativeSoUtils;
import org.apache.commons.lang.StringUtils;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.TaskAction;
import java.io.File;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Callable;
/**
* 处理各种so依赖的任务
* Created by shenghua.nish on 2015-08-25 下午2:24.
*/
public class MergeSoLibTask extends BaseTask {
/**
* 主bundle有的jnifolders,包含主和依赖的aar的jni目录
*/
Set<File> jniFolders;
/**
* 主bundle依赖的solib
*/
List<SoLibrary> mainDexSoLibraries;
/**
* 依赖的awbs
*/
List<AwbBundle> awbLibs;
@Input
Set<String> supportAbis;
@Input
Set<String> removeSoFiles;
@OutputDirectory
File mainBundleOutputFolder;
/**
* 当主dex和awb的so重复的时候是否报错
*/
@Input
Boolean failOnDuplicateSo;
AppVariantOutputContext appVariantOutputContext;
/**
* 生成so的目录
*/
@TaskAction
void generate() {
List<File> scanDirs = new ArrayList<File>();
//先生成主bundle的jnifolder目录
if (!getMainBundleOutputFolder().exists()) {
getMainBundleOutputFolder().mkdirs();
}
for (File jniFolder : getJniFolders()) {
if (jniFolder.exists() && jniFolder.isDirectory()) {
NativeSoUtils.copyLocalNativeLibraries(jniFolder,
getMainBundleOutputFolder(),
getSupportAbis(),
getRemoveSoFiles());
}
}
scanDirs.add(getMainBundleOutputFolder());
//增加主bundle依赖的solib的so
for (SoLibrary mainSoLib : getMainDexSoLibraries()) {
File explodeFolder = mainSoLib.getFolder();
if (explodeFolder.exists() && explodeFolder.isDirectory()) {
NativeSoUtils.copyLocalNativeLibraries(explodeFolder,
getMainBundleOutputFolder(),
getSupportAbis(),
getRemoveSoFiles());
}
}
//处理awb bundle的so
for (AwbBundle awbLib : getAwbLibs()) {
File awbOutputFolder = new File(appVariantOutputContext.getAwbJniFolder(awbLib), "lib");
awbOutputFolder.mkdirs();
scanDirs.add(awbOutputFolder);
File awbJniFolder = awbLib.getAndroidLibrary().getJniFolder();
if (awbJniFolder.exists() && awbJniFolder.isDirectory()) {
NativeSoUtils.copyLocalNativeLibraries(awbJniFolder,
awbOutputFolder,
getSupportAbis(),
getRemoveSoFiles());
}
//为了兼容之前老的aar，awb格式
File libJniFolder = new File(awbLib.getAndroidLibrary().getFolder(), "libs");
if (libJniFolder.exists() && libJniFolder.isDirectory()) {
NativeSoUtils.copyLocalNativeLibraries(libJniFolder,
awbOutputFolder,
getSupportAbis(),
getRemoveSoFiles());
}
List<? extends AndroidLibrary> deps = awbLib.getAndroidLibraries();
for (AndroidLibrary dep : deps) {
File depJniFolder = dep.getJniFolder();
if (depJniFolder.exists() && depJniFolder.isDirectory()) {
NativeSoUtils.copyLocalNativeLibraries(depJniFolder,
awbOutputFolder,
getSupportAbis(),
getRemoveSoFiles());
}
//为了兼容之前老的aar，awb格式
File depLibsFolder = new File(dep.getFolder(), "libs");
if (depLibsFolder.exists() && depLibsFolder.isDirectory()) {
NativeSoUtils.copyLocalNativeLibraries(depLibsFolder,
awbOutputFolder,
getSupportAbis(),
getRemoveSoFiles());
}
}
List<SoLibrary> solibs = awbLib.getSoLibraries();
if (null != solibs) {
for (SoLibrary solib : solibs) {
File explodeFolder = solib.getFolder();
if (explodeFolder.exists() && explodeFolder.isDirectory()) {
NativeSoUtils.copyLocalNativeLibraries(explodeFolder,
awbOutputFolder,
getSupportAbis(),
getRemoveSoFiles());
}
}
}
}
//判断是否有重复的so文件
// 进行重复文件的查询
Map<String, Multimap<String, File>> soMaps = NativeSoUtils.getAbiSoFiles(getSupportAbis(),
getRemoveSoFiles(),
scanDirs);
boolean hasDup = false;
for (Map.Entry<String, Multimap<String, File>> entry : soMaps.entrySet()) {
String abi = entry.getKey();
Multimap<String, File> soFiles = soMaps.get(abi);
for (String soKey : soFiles.keys()) {
if (soFiles.get(soKey).size() > 1) {
getILogger().warning("[SO Duplicate][" +
abi +
"]:" +
StringUtils.join(soFiles.get(soKey), ","));
hasDup = true;
} else {
getILogger().verbose("[SO][" +
abi +
"]:" +
StringUtils.join(soFiles.get(soKey), ","));
}
}
}
// if (hasDup && getFailOnDuplicateSo()) {
// throw new RuntimeException("SO file has duplicate files!See detail info!");
// }
}
public static class ConfigAction extends MtlBaseTaskAction<MergeSoLibTask> {
AtlasDependencyTree dependencyTree;
private AppVariantContext appVariantContext;
public ConfigAction(AppVariantContext appVariantContext,
BaseVariantOutputData baseVariantOutputData) {
super(appVariantContext, baseVariantOutputData);
this.appVariantContext = appVariantContext;
GradleVariantConfiguration config = scope.getVariantScope().getVariantConfiguration();
dependencyTree = AtlasBuildContext.androidDependencyTrees.get(config.getFullName());
}
/**
* Return the name of the task to be configured.
*/
@Override
public String getName() {
return scope.getTaskName("merge", "SoLib");
}
/**
* Return the class type of the task to be configured.
*/
@Override
public Class<MergeSoLibTask> getType() {
return MergeSoLibTask.class;
}
/**
* Performs this action against the given object.
*
* @param copySoLibTask The object to perform the action on.
*/
@Override
public void execute(MergeSoLibTask copySoLibTask) {
super.execute(copySoLibTask);
final AppVariantOutputContext appVariantOutputContext = getAppVariantOutputContext();
final ApkVariantOutputData variantOutputData = (ApkVariantOutputData) appVariantOutputContext
.getOutputScope()
.getVariantOutputData();
final GradleVariantConfiguration config = scope.getVariantScope()
.getVariantConfiguration();
ConventionMappingHelper.map(copySoLibTask, "jniFolders", new Callable<Set<File>>() {
@Override
public Set call() throws Exception {
Set<File> set = new HashSet<File>();
for (AndroidLibrary aarBundle : dependencyTree.getMainBundle().getAndroidLibraries()) {
if (!aarBundle.isOptional()) {
File jniFolder = new File(aarBundle.getFolder(), "libs");
if (jniFolder.isDirectory()) {
set.add(jniFolder);
}
}
}
return set;
}
});
ConventionMappingHelper.map(copySoLibTask, "awbLibs", new Callable<List>() {
@Override
public List call() throws Exception {
return dependencyTree.getAwbBundles();
}
});
ConventionMappingHelper.map(copySoLibTask, "mainDexSoLibraries", new Callable<List>() {
@Override
public List call() throws Exception {
return dependencyTree.getMainBundle().getSoLibraries();
}
});
ConventionMappingHelper.map(copySoLibTask, "supportAbis", new Callable<Set>() {
@Override
public Set call() throws Exception {
if (variantOutputData.getMainOutputFile()
.getFilter(com.android.build.OutputFile.ABI) != null) {
return ImmutableSet.of(variantOutputData.getMainOutputFile()
.getFilter(com.android.build.OutputFile.ABI));
}
Set<String> supportedAbis = config.getSupportedAbis();
if (supportedAbis != null) {
return supportedAbis;
}
return ImmutableSet.of();
}
});
ConventionMappingHelper.map(copySoLibTask, "removeSoFiles", new Callable<Set>() {
@Override
public Set call() throws Exception {
return appVariantContext.getAtlasExtension()
.getTBuildConfig()
.getRemoveSoFiles();
}
});
// File mainJniOutputFolder = new File(
// config.getGlobalScope().getBuildDir() , "/" + AndroidProject.FD_INTERMEDIATES + "/jniFolder/"
// + config.getVariantData().getVariantConfiguration().getDirName());
final File mainJniOutputFolder = appVariantContext.getBaseVariantData().ndkCompileTask.getSoFolder();
copySoLibTask.setMainBundleOutputFolder(mainJniOutputFolder);
copySoLibTask.appVariantOutputContext = appVariantOutputContext;
// ConventionMappingHelper.map(processSolibTask, "awbBundleOutputFolder", new Callable<File>() {
// @Override
// public File call() throws Exception {
// return awbJniOutputFolder;
// }
// });
copySoLibTask.setVariantName(appVariantContext.getBaseVariantData().getName());
}
}
public Set<File> getJniFolders() {
return jniFolders;
}
public void setJniFolders(Set<File> jniFolders) {
this.jniFolders = jniFolders;
}
public List<SoLibrary> getMainDexSoLibraries() {
return mainDexSoLibraries;
}
public void setMainDexSoLibraries(List<SoLibrary> mainDexSoLibraries) {
this.mainDexSoLibraries = mainDexSoLibraries;
}
public List<AwbBundle> getAwbLibs() {
return awbLibs;
}
public void setAwbLibs(List<AwbBundle> awbLibs) {
this.awbLibs = awbLibs;
}
public Set<String> getSupportAbis() {
return supportAbis;
}
public void setSupportAbis(Set<String> supportAbis) {
this.supportAbis = supportAbis;
}
public File getMainBundleOutputFolder() {
return mainBundleOutputFolder;
}
public void setMainBundleOutputFolder(File mainBundleOutputFolder) {
this.mainBundleOutputFolder = mainBundleOutputFolder;
}
public Set<String> getRemoveSoFiles() {
return removeSoFiles;
}
public void setRemoveSoFiles(Set<String> removeSoFiles) {
this.removeSoFiles = removeSoFiles;
}
}