/*
*
*
*
* 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 java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Callable;
import com.alibaba.fastjson.JSON;
import com.android.annotations.NonNull;
import com.android.annotations.Nullable;
import com.android.build.gradle.AndroidGradleOptions;
import com.android.build.gradle.internal.api.ApContext;
import com.android.build.gradle.internal.api.AppVariantContext;
import com.android.build.gradle.internal.core.GradleVariantConfiguration;
import com.android.build.gradle.internal.dsl.AaptOptions;
import com.android.build.gradle.internal.scope.ConventionMappingHelper;
import com.android.build.gradle.internal.tasks.BaseTask;
import com.android.build.gradle.internal.variant.BaseVariantData;
import com.android.build.gradle.internal.variant.BaseVariantOutputData;
import com.android.build.gradle.internal.variant.SplitHandlingPolicy;
import com.android.builder.core.AaptPackageProcessBuilder;
import com.android.builder.core.AndroidBuilder;
import com.android.builder.core.AtlasBuilder;
import com.android.builder.core.VariantType;
import com.android.builder.model.AndroidLibrary;
import com.android.ide.common.blame.MergingLog;
import com.android.ide.common.blame.MergingLogRewriter;
import com.android.ide.common.blame.ParsingProcessOutputHandler;
import com.android.ide.common.blame.parser.ToolOutputParser;
import com.android.ide.common.blame.parser.aapt.AaptOutputParser;
import com.android.ide.common.process.ProcessException;
import com.android.ide.common.process.ProcessOutputHandler;
import com.google.common.collect.Iterators;
import com.taobao.android.builder.AtlasBuildContext;
import com.taobao.android.builder.extension.PatchConfig;
import com.taobao.android.builder.tasks.manager.MtlBaseTaskAction;
import com.taobao.android.builder.tools.diff.DiffResExtractor;
import com.taobao.android.builder.tools.manifest.ManifestFileUtils;
import com.taobao.android.object.ApkFileList;
import org.apache.commons.beanutils.BeanUtils;
import org.apache.commons.io.FileUtils;
import org.dom4j.DocumentException;
import org.gradle.api.GradleException;
import org.gradle.api.tasks.InputDirectory;
import org.gradle.api.tasks.InputFile;
import org.gradle.api.tasks.StopExecutionException;
import org.gradle.api.tasks.TaskAction;
import static com.android.build.gradle.internal.api.ApContext.APK_FILE_LIST;
/**
* 处理diff.ap_的task
* Created by wuzhong
*/
public class TPatchDiffResAPBuildTask extends BaseTask {
private File manifestFile;
private File baseManifestFile;
private AaptOptions aaptOptions;
private File diffResDir;
private List<? extends AndroidLibrary> libraries;
private String packageForR;
private File packageOutputFile;
private VariantType type;
private boolean debuggable;
private boolean pseudoLocalesEnabled;
private Collection<String> resourceConfigs;
private Collection<String> splits;
private String preferredDensity;
private File mergeBlameLogFolder;
private boolean enforceUniquePackageName;
@TaskAction
protected void doAction() throws IOException {
manifestFile = getManifestFile();
aaptOptions = getAaptOptions();
diffResDir = getDiffResDir();
resourceConfigs = getResourceConfigs();
preferredDensity = getPreferredDensity();
//TODO minifyManifest
File miniManifest = new File(packageOutputFile.getParentFile(), "AndroidManifest.xml");
try {
ManifestFileUtils.createPatchManifest(manifestFile, getBaseManifestFile(), miniManifest);
} catch (DocumentException e) {
throw new GradleException(e.getMessage());
}
File assetsFolder = new File(diffResDir, "assets");
File resFolder = new File(diffResDir, "res");
if (!assetsFolder.exists()) {
assetsFolder.mkdirs();
}
if (!resFolder.exists()) {
resFolder.mkdirs();
}
AaptPackageProcessBuilder aaptPackageCommandBuilder = new AaptPackageProcessBuilder(
miniManifest,
aaptOptions).setAssetsFolder(assetsFolder)
.setResFolder(resFolder)
.setLibraries(libraries)
.setPackageForR(packageForR)
.setResPackageOutput(packageOutputFile.getAbsolutePath())
.setType(type)
.setDebuggable(debuggable)
.setPseudoLocalesEnabled(pseudoLocalesEnabled)
.setResourceConfigs(resourceConfigs)
.setSplits(splits)
.setPreferredDensity(preferredDensity);
@NonNull
AndroidBuilder builder = getBuilder();
MergingLog mergingLog = new MergingLog(mergeBlameLogFolder);
ProcessOutputHandler processOutputHandler = new ParsingProcessOutputHandler(new ToolOutputParser(
new AaptOutputParser(),
getILogger()), new MergingLogRewriter(mergingLog, builder.getErrorReporter()));
try {
if (builder instanceof AtlasBuilder) {
((AtlasBuilder)builder).processResources(aaptPackageCommandBuilder,
enforceUniquePackageName,
processOutputHandler);
}
} catch (IOException e) {
throw new RuntimeException(e);
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (ProcessException e) {
throw new RuntimeException(e);
}
}
public static class ConfigAction extends MtlBaseTaskAction<TPatchDiffResAPBuildTask> {
private AppVariantContext appVariantContext;
public ConfigAction(AppVariantContext appVariantContext,
BaseVariantOutputData baseVariantOutputData) {
super(appVariantContext, baseVariantOutputData);
this.appVariantContext = appVariantContext;
}
@Override
public String getName() {
return scope.getTaskName("processDiffResources");
}
@Override
public Class<TPatchDiffResAPBuildTask> getType() {
return TPatchDiffResAPBuildTask.class;
}
@Override
public void execute(TPatchDiffResAPBuildTask processDiffResources) {
super.execute(processDiffResources);
PatchConfig patchConfig = appVariantContext.getBuildType().getPatchConfig();
if (null == patchConfig || !patchConfig.isCreateTPatch()) {
processDiffResources.setEnabled(false);
return;
}
//AAPT command params
final BaseVariantData variantData = appVariantContext.getVariantData();
final GradleVariantConfiguration config = variantData.getVariantConfiguration();
final BaseVariantOutputData variantOutputData = scope.getVariantOutputData();
if (variantData.getSplitHandlingPolicy() ==
SplitHandlingPolicy.RELEASE_21_AND_AFTER_POLICY) {
Set<String> allFilters = new HashSet<String>();
allFilters.addAll(variantData.getFilters(com.android.build.OutputFile.FilterType.DENSITY));
allFilters.addAll(variantData.getFilters(com.android.build.OutputFile.FilterType.LANGUAGE));
processDiffResources.splits = allFilters;
}
processDiffResources.mergeBlameLogFolder = scope.getVariantScope()
.getResourceBlameLogDir();
processDiffResources.pseudoLocalesEnabled = config.getBuildType()
.isPseudoLocalesEnabled();
//设置ap的输出
processDiffResources.packageOutputFile = (getAppVariantOutputContext().getDiffResourceAp());
processDiffResources.type = (config.getType());
processDiffResources.debuggable = (config.getBuildType().isDebuggable());
//TODO
// processDiffResources.setAndroidBuilder(scope.getGlobalScope().getAndroidBuilder());
ConventionMappingHelper.map(processDiffResources, "manifestFile", new Callable<File>() {
@Override
public File call() throws Exception {
return variantOutputData.manifestProcessorTask.getOutputFile();
}
});
ConventionMappingHelper.map(processDiffResources, "baseManifestFile", new Callable<File>() {
@Override
public File call() throws Exception {
return new File(appVariantContext.apContext.getApExploredFolder(), "AndroidManifest.xml");
}
});
ConventionMappingHelper.map(processDiffResources,
"aaptOptions",
new Callable<AaptOptions>() {
@Override
public AaptOptions call() throws Exception {
//设置aapt参数
AaptOptions aaptOptions = scope.getGlobalScope()
.getExtension()
.getAaptOptions();
if (null == aaptOptions.getAdditionalParameters() ||
!aaptOptions.getAdditionalParameters()
.contains("-B")) {
PatchConfig patchConfig = appVariantContext.getBuildType()
.getPatchConfig();
if (patchConfig == null ||
!(patchConfig.isCreateAPatch() ||
patchConfig.isCreateTPatch())) {
return aaptOptions;
}
AaptOptions cloneAaptOptions = new AaptOptions();
try {
BeanUtils.copyProperties(cloneAaptOptions,
aaptOptions);
} catch (Throwable e) {
throw new StopExecutionException(e.getMessage());
}
aaptOptions = cloneAaptOptions;
List<String> additionParameters = aaptOptions
.getAdditionalParameters();
if (null == additionParameters) {
additionParameters = new ArrayList<String>();
}
additionParameters.add("-B");
additionParameters.add(appVariantContext.apContext
.getBaseApk()
.getAbsolutePath());
}
return aaptOptions;
}
});
ConventionMappingHelper.map(processDiffResources,
"resourceConfigs",
new Callable<Collection<String>>() {
@Override
public Collection<String> call() throws Exception {
Collection<String> resConfigs = config.getMergedFlavor()
.getResourceConfigurations();
if (resConfigs.size() == 1 &&
Iterators.getOnlyElement(resConfigs.iterator())
.equals("auto")) {
if (scope.getGlobalScope()
.getAndroidBuilder()
.getTargetInfo()
.getBuildTools()
.getRevision()
.getMajor() >= 21) {
return variantData.discoverListOfResourceConfigsNotDensities();
} else {
return variantData.discoverListOfResourceConfigs();
}
}
return config.getMergedFlavor()
.getResourceConfigurations();
}
});
ConventionMappingHelper.map(processDiffResources,
"preferredDensity",
new Callable<String>() {
@Override
@Nullable
public String call() throws Exception {
String variantFilter = variantOutputData.getMainOutputFile()
.getFilter(com.android.build.OutputFile.DENSITY);
if (variantFilter != null) {
return variantFilter;
}
return AndroidGradleOptions.getBuildTargetDensity(
scope.getGlobalScope().getProject());
}
});
ConventionMappingHelper.map(processDiffResources, "diffResDir", new Callable<File>() {
@Override
public File call() throws Exception {
PatchConfig patchConfig = appVariantContext.getBuildType().getPatchConfig();
if (patchConfig == null) {
return null;
}
File baseApk = new File(appVariantContext.apContext.getApExploredFolder(),
ApContext.AP_INLINE_APK_FILENAME);
File baseApkFileList = new File(appVariantContext.apContext.getApExploredFolder(),
APK_FILE_LIST);
File currentApk = getAppVariantOutputContext().getApkOutputFile(true);
if (!baseApk.exists() || !currentApk.exists() || !baseApkFileList.exists()) {
return null;
}
File rawResDir = new File(scope.getGlobalScope().getIntermediatesDir(),
"tpatch" +
File.separator +
config.getFullName() +
File.separator +
"raw-res");
File diffDir = new File(scope.getGlobalScope().getIntermediatesDir(),
"tpatch" +
File.separator +
config.getFullName() +
File.separator +
"diff-res");
if (diffDir.exists()) {
return diffDir;
}
diffDir.mkdirs();
rawResDir.mkdirs();
//TODO
ApkFileList baseApkFiles = JSON.parseObject(FileUtils.readFileToString(
baseApkFileList), ApkFileList.class);
ApkFileList currentApkFiles = AtlasBuildContext.finalApkFileList;
Set<String> diffFiles = new HashSet<String>();
HashMap<String, String> baseFiles = baseApkFiles.getMainBundle();
HashMap<String, String> newFiles = currentApkFiles.getMainBundle();
if (null != newFiles) {
for (Map.Entry<String, String> entry : newFiles.entrySet()) {
String name = entry.getKey();
if (name.startsWith("res/")) {
String md5 = entry.getValue();
String baseMd5 = baseFiles.get(name);
if (null == baseMd5 || !baseMd5.equals(md5)) {
diffFiles.add(name);
}
}
}
}
FileUtils.copyDirectory(scope.getVariantScope().getFinalResourcesDir(),
new File(rawResDir, "res"));
FileUtils.copyDirectory(variantData.mergeAssetsTask.getOutputDir(),
new File(rawResDir, "assets"));
DiffResExtractor.extractDiff(diffFiles,
currentApk,
baseApk,
rawResDir,
diffDir);
return diffDir;
}
});
}
}
@InputFile
public File getManifestFile() {
return manifestFile;
}
@InputFile
public File getBaseManifestFile() {
return baseManifestFile;
}
public AaptOptions getAaptOptions() {
return aaptOptions;
}
@InputDirectory
public File getDiffResDir() {
return diffResDir;
}
public Collection<String> getResourceConfigs() {
return resourceConfigs;
}
public String getPreferredDensity() {
return preferredDensity;
}
}