| /* |
| * Copyright (C) 2018 The Android Open Source Project |
| * |
| * 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.android.build.gradle.internal.tasks |
| |
| import com.android.SdkConstants |
| import com.android.build.gradle.internal.InternalScope.FEATURES |
| import com.android.build.gradle.internal.InternalScope.LOCAL_DEPS |
| import com.android.build.gradle.internal.TaskManager |
| import com.android.build.gradle.internal.component.ApkCreationConfig |
| import com.android.build.gradle.internal.component.ComponentCreationConfig |
| import com.android.build.gradle.internal.component.ConsumableCreationConfig |
| import com.android.build.gradle.internal.fusedlibrary.FusedLibraryInternalArtifactType |
| import com.android.build.gradle.internal.fusedlibrary.FusedLibraryVariantScope |
| import com.android.build.gradle.internal.packaging.defaultExcludes |
| import com.android.build.gradle.internal.pipeline.StreamFilter.PROJECT_RESOURCES |
| import com.android.build.gradle.internal.publishing.AndroidArtifacts |
| import com.android.build.gradle.internal.scope.InternalArtifactType |
| import com.android.build.gradle.internal.scope.InternalArtifactType.JAVAC |
| import com.android.build.gradle.internal.scope.InternalArtifactType.JAVA_RES |
| import com.android.build.gradle.internal.scope.InternalArtifactType.RUNTIME_R_CLASS_CLASSES |
| import com.android.build.gradle.internal.services.getBuildService |
| import com.android.build.gradle.internal.tasks.factory.TaskCreationAction |
| import com.android.build.gradle.internal.tasks.factory.VariantTaskCreationAction |
| import com.android.build.gradle.internal.utils.fromDisallowChanges |
| import com.android.build.gradle.internal.utils.setDisallowChanges |
| import com.android.build.gradle.tasks.getChangesInSerializableForm |
| import com.android.builder.files.SerializableInputChanges |
| import org.gradle.api.attributes.Usage |
| import org.gradle.api.file.ConfigurableFileCollection |
| import org.gradle.api.file.FileCollection |
| import org.gradle.api.file.RegularFileProperty |
| import org.gradle.api.model.ObjectFactory |
| import org.gradle.api.provider.ListProperty |
| import org.gradle.api.provider.SetProperty |
| import org.gradle.api.tasks.Classpath |
| import org.gradle.api.tasks.Input |
| import org.gradle.api.tasks.InputFiles |
| import org.gradle.api.tasks.Optional |
| import org.gradle.api.tasks.OutputDirectory |
| import org.gradle.api.tasks.OutputFile |
| import org.gradle.api.tasks.PathSensitive |
| import org.gradle.api.tasks.PathSensitivity |
| import org.gradle.api.tasks.TaskProvider |
| import org.gradle.api.tasks.util.PatternSet |
| import org.gradle.work.DisableCachingByDefault |
| import org.gradle.work.Incremental |
| import org.gradle.work.InputChanges |
| import java.io.File |
| import java.util.concurrent.Callable |
| import java.util.function.Predicate |
| import javax.inject.Inject |
| |
| /** |
| * Task to merge java resources from multiple modules |
| */ |
| @DisableCachingByDefault |
| abstract class MergeJavaResourceTask |
| @Inject constructor(objects: ObjectFactory) : NewIncrementalTask() { |
| |
| @get:InputFiles |
| @get:Incremental |
| @get:PathSensitive(PathSensitivity.RELATIVE) |
| @get:Optional |
| abstract val projectJavaRes: ConfigurableFileCollection |
| |
| @get:Classpath |
| @get:Incremental |
| @get:Optional |
| abstract val projectJavaResAsJars: ConfigurableFileCollection |
| |
| @get:Classpath |
| @get:Incremental |
| @get:Optional |
| abstract val subProjectJavaRes: ConfigurableFileCollection |
| |
| @get:Classpath |
| @get:Incremental |
| @get:Optional |
| abstract val externalLibJavaRes: ConfigurableFileCollection |
| |
| @get:Classpath |
| @get:Incremental |
| @get:Optional |
| abstract val featureJavaRes: ConfigurableFileCollection |
| |
| @get:Input |
| @Suppress("DEPRECATION") // Legacy support |
| lateinit var mergeScopes: Collection<com.android.build.api.transform.QualifiedContent.ScopeType> |
| private set |
| |
| @get:Input |
| abstract val excludes: SetProperty<String> |
| |
| @get:Input |
| abstract val pickFirsts: SetProperty<String> |
| |
| @get:Input |
| abstract val merges: SetProperty<String> |
| |
| @get:Input |
| @get:Optional |
| abstract val noCompress: ListProperty<String> |
| |
| private lateinit var intermediateDir: File |
| |
| @get:OutputDirectory |
| lateinit var cacheDir: File |
| private set |
| |
| private lateinit var incrementalStateFile: File |
| |
| @get:OutputFile |
| val outputFile: RegularFileProperty = objects.fileProperty() |
| |
| // The runnable implementing the processing is not able to deal with fine-grained file but |
| // instead is expecting directories of files. Use the unfiltered collection (since the filtering |
| // changes the FileCollection of directories into a FileTree of files) to process, but don't |
| // use it as a task input, it's covered by [projectJavaRes] and [projectJavaResAsJars] above. |
| // This is a workaround for the lack of gradle custom snapshotting: |
| // https://github.com/gradle/gradle/issues/8503. |
| private lateinit var unfilteredProjectJavaRes: FileCollection |
| |
| override fun doTaskAction(inputChanges: InputChanges) { |
| if (inputChanges.isIncremental) { |
| // TODO(b/225872980): Unify with IncrementalChanges.classpathToRelativeFileSet |
| // (see IncrementalMergerFileUtils.collectChanges) |
| doIncrementalTaskAction( |
| listOf( |
| inputChanges.getChangesInSerializableForm(projectJavaRes), |
| inputChanges.getChangesInSerializableForm(projectJavaResAsJars), |
| inputChanges.getChangesInSerializableForm(subProjectJavaRes), |
| inputChanges.getChangesInSerializableForm(externalLibJavaRes), |
| inputChanges.getChangesInSerializableForm(featureJavaRes) |
| ).let { |
| SerializableInputChanges( |
| roots = it.flatMap(SerializableInputChanges::roots), |
| changes = it.flatMap(SerializableInputChanges::changes)) } |
| ) |
| |
| } else { |
| doFullTaskAction() |
| } |
| } |
| |
| private fun doFullTaskAction() { |
| workerExecutor.noIsolation().submit(MergeJavaResWorkAction::class.java) { |
| it.initializeFromAndroidVariantTask(this) |
| it.projectJavaRes.from(unfilteredProjectJavaRes) |
| it.subProjectJavaRes.from(subProjectJavaRes) |
| it.externalLibJavaRes.from(externalLibJavaRes) |
| it.featureJavaRes.from(featureJavaRes) |
| it.outputFile.set(outputFile) |
| it.incrementalStateFile.set(incrementalStateFile) |
| it.incremental.set(false) |
| it.cacheDir.set(cacheDir) |
| it.noCompress.set(noCompress) |
| it.excludes.set(excludes) |
| it.pickFirsts.set(pickFirsts) |
| it.merges.set(merges) |
| } |
| } |
| |
| private fun doIncrementalTaskAction( |
| changedInputs: SerializableInputChanges, |
| ) { |
| if (!incrementalStateFile.isFile) { |
| doFullTaskAction() |
| return |
| } |
| workerExecutor.noIsolation().submit(MergeJavaResWorkAction::class.java) { |
| it.initializeFromAndroidVariantTask(this) |
| it.projectJavaRes.from(unfilteredProjectJavaRes) |
| it.subProjectJavaRes.from(subProjectJavaRes) |
| it.externalLibJavaRes.from(externalLibJavaRes) |
| it.featureJavaRes.from(featureJavaRes) |
| it.outputFile.set(outputFile) |
| it.incrementalStateFile.set(incrementalStateFile) |
| it.incremental.set(true) |
| it.cacheDir.set(cacheDir) |
| it.changedInputs.set(changedInputs) |
| it.noCompress.set(noCompress) |
| it.excludes.set(excludes) |
| it.pickFirsts.set(pickFirsts) |
| it.merges.set(merges) |
| } |
| } |
| |
| class CreationAction( |
| @Suppress("DEPRECATION") // Legacy support |
| private val mergeScopes: Collection<com.android.build.api.transform.QualifiedContent.ScopeType>, |
| creationConfig: ConsumableCreationConfig |
| ) : VariantTaskCreationAction<MergeJavaResourceTask, ConsumableCreationConfig>( |
| creationConfig |
| ) { |
| |
| private val projectJavaResFromStreams: FileCollection? |
| |
| override val name: String |
| get() = computeTaskName("merge", "JavaResource") |
| |
| override val type: Class<MergeJavaResourceTask> |
| get() = MergeJavaResourceTask::class.java |
| |
| init { |
| if (creationConfig.needsJavaResStreams) { |
| // Because ordering matters for Transform pipeline, we need to fetch the java res |
| // as soon as this creation action is instantiated, if needed. |
| projectJavaResFromStreams = |
| creationConfig.transformManager |
| .getPipelineOutputAsFileCollection(PROJECT_RESOURCES) |
| // We must also consume corresponding streams to avoid duplicates; any downstream |
| // transforms will use the merged-java-res stream instead. |
| @Suppress("DEPRECATION") // Legacy support |
| creationConfig.transformManager |
| .consumeStreams(mutableSetOf(com.android.build.api.transform.QualifiedContent.Scope.PROJECT), setOf(com.android.build.api.transform.QualifiedContent.DefaultContentType.RESOURCES)) |
| } else { |
| projectJavaResFromStreams = null |
| } |
| } |
| |
| override fun handleProvider( |
| taskProvider: TaskProvider<MergeJavaResourceTask> |
| ) { |
| super.handleProvider(taskProvider) |
| val fileName = if (creationConfig.componentType.isBaseModule) { |
| "base.jar" |
| } else { |
| TaskManager.getFeatureFileName( |
| creationConfig.services.projectInfo.path, |
| SdkConstants.DOT_JAR |
| ) |
| } |
| creationConfig.artifacts.setInitialProvider( |
| taskProvider, |
| MergeJavaResourceTask::outputFile |
| ).withName(fileName).on(InternalArtifactType.MERGED_JAVA_RES) |
| } |
| |
| override fun configure( |
| task: MergeJavaResourceTask |
| ) { |
| super.configure(task) |
| |
| if (projectJavaResFromStreams != null) { |
| task.projectJavaResAsJars.fromDisallowChanges(projectJavaResFromStreams) |
| task.unfilteredProjectJavaRes = projectJavaResFromStreams |
| } else { |
| val projectJavaRes = getProjectJavaRes(creationConfig) |
| task.unfilteredProjectJavaRes = projectJavaRes |
| task.projectJavaRes.from(projectJavaRes.asFileTree.matching(patternSet)) |
| } |
| task.projectJavaRes.disallowChanges() |
| |
| @Suppress("DEPRECATION") // Legacy support |
| run { |
| if (mergeScopes.contains(com.android.build.api.transform.QualifiedContent.Scope.SUB_PROJECTS)) { |
| task.subProjectJavaRes.fromDisallowChanges( |
| creationConfig.variantDependencies.getArtifactFileCollection( |
| AndroidArtifacts.ConsumedConfigType.RUNTIME_CLASSPATH, |
| AndroidArtifacts.ArtifactScope.PROJECT, |
| AndroidArtifacts.ArtifactType.JAVA_RES |
| ) |
| ) |
| } |
| task.subProjectJavaRes.disallowChanges() |
| |
| if (mergeScopes.contains(com.android.build.api.transform.QualifiedContent.Scope.EXTERNAL_LIBRARIES) || mergeScopes.contains( |
| LOCAL_DEPS |
| ) |
| ) { |
| // Local jars are treated the same as external libraries |
| task.externalLibJavaRes.fromDisallowChanges(getExternalLibJavaRes(creationConfig, mergeScopes)) |
| } |
| task.externalLibJavaRes.disallowChanges() |
| } |
| |
| if (mergeScopes.contains(FEATURES)) { |
| task.featureJavaRes.fromDisallowChanges( |
| creationConfig.variantDependencies.getArtifactFileCollection( |
| AndroidArtifacts.ConsumedConfigType.REVERSE_METADATA_VALUES, |
| AndroidArtifacts.ArtifactScope.PROJECT, |
| AndroidArtifacts.ArtifactType.REVERSE_METADATA_JAVA_RES |
| ) |
| ) |
| } |
| task.featureJavaRes.disallowChanges() |
| |
| task.mergeScopes = mergeScopes |
| task.excludes.setDisallowChanges(creationConfig.packaging.resources.excludes) |
| task.pickFirsts.setDisallowChanges(creationConfig.packaging.resources.pickFirsts) |
| task.merges.setDisallowChanges(creationConfig.packaging.resources.merges) |
| task.intermediateDir = |
| creationConfig.paths.getIncrementalDir("${creationConfig.name}-mergeJavaRes") |
| task.cacheDir = File(task.intermediateDir, "zip-cache") |
| task.incrementalStateFile = File(task.intermediateDir, "merge-state") |
| if (creationConfig is ApkCreationConfig) { |
| creationConfig.androidResourcesCreationConfig?.let { |
| task.noCompress.set(it.androidResources.noCompress) |
| } ?: run { |
| task.noCompress.set(emptyList()) |
| } |
| } |
| task.noCompress.disallowChanges() |
| } |
| } |
| |
| class CreationActionFusedLibrary( |
| val creationConfig: FusedLibraryVariantScope |
| ) : TaskCreationAction<MergeJavaResourceTask>() { |
| |
| override val name: String |
| get() = "mergeLibraryJavaResources" |
| override val type: Class<MergeJavaResourceTask> |
| get() = MergeJavaResourceTask::class.java |
| |
| override fun handleProvider(taskProvider: TaskProvider<MergeJavaResourceTask>) { |
| super.handleProvider(taskProvider) |
| |
| creationConfig.artifacts.setInitialProvider( |
| taskProvider, |
| MergeJavaResourceTask::outputFile |
| ).withName("base.jar").on(FusedLibraryInternalArtifactType.MERGED_JAVA_RES) |
| } |
| |
| override fun configure(task: MergeJavaResourceTask) { |
| task.configureVariantProperties("", task.project.gradle.sharedServices) |
| task.subProjectJavaRes.from( |
| creationConfig.dependencies.getArtifactFileCollection( |
| Usage.JAVA_RUNTIME, |
| creationConfig.mergeSpec, |
| AndroidArtifacts.ArtifactType.JAVA_RES |
| ) |
| ) |
| |
| // For configuring the merging rules (we may want to add DSL for this in the future. |
| task.excludes.setDisallowChanges(defaultExcludes) |
| task.pickFirsts.setDisallowChanges(emptySet()) |
| task.merges.setDisallowChanges(emptySet()) |
| |
| task.intermediateDir = creationConfig.layout.buildDirectory |
| .dir(SdkConstants.FD_INTERMEDIATES) |
| .map { it.dir("mergeJavaRes") }.get().asFile |
| task.cacheDir = File(task.intermediateDir, "zip-cache") |
| task.incrementalStateFile = File(task.intermediateDir, "merge-state") |
| |
| // External libraries can just be consumed via the subProjectJavaRes (the inputs are |
| // only intended for finer grain incremental runs. |
| task.externalLibJavaRes.disallowChanges() |
| |
| // No sources in fused library projects, so none of the below need set. |
| task.projectJavaRes.disallowChanges() |
| task.projectJavaResAsJars.disallowChanges() |
| task.unfilteredProjectJavaRes = task.project.files() |
| task.featureJavaRes.disallowChanges() |
| |
| // mergeScopes is unused by the task. |
| task.mergeScopes = setOf() |
| } |
| |
| } |
| |
| companion object { |
| |
| private val excludedFileSuffixes = |
| listOf(SdkConstants.DOT_CLASS, SdkConstants.DOT_NATIVE_LIBS) |
| |
| // predicate logic must match patternSet logic below |
| val predicate = Predicate<String> { path -> |
| excludedFileSuffixes.none { path.endsWith(it) } |
| } |
| |
| // patternSet logic must match predicate logic above |
| val patternSet: PatternSet |
| get() { |
| val patternSet = PatternSet() |
| excludedFileSuffixes.forEach { patternSet.exclude("**/*$it") } |
| return patternSet |
| } |
| } |
| } |
| |
| fun getProjectJavaRes( |
| creationConfig: ComponentCreationConfig |
| ): FileCollection { |
| val javaRes = creationConfig.services.fileCollection() |
| javaRes.from(creationConfig.artifacts.get(JAVA_RES)) |
| // use lazy file collection here in case an annotationProcessor dependency is add via |
| // Configuration.defaultDependencies(), for example. |
| javaRes.from( |
| Callable { |
| if (projectHasAnnotationProcessors(creationConfig)) { |
| creationConfig.artifacts.get(JAVAC) |
| } else { |
| listOf<File>() |
| } |
| } |
| ) |
| creationConfig.oldVariantApiLegacySupport?.variantData?.allPreJavacGeneratedBytecode?.let { |
| javaRes.from(it) |
| } |
| creationConfig.oldVariantApiLegacySupport?.variantData?.allPostJavacGeneratedBytecode?.let { |
| javaRes.from(it) |
| } |
| if (creationConfig.global.namespacedAndroidResources) { |
| javaRes.from(creationConfig.artifacts.get(RUNTIME_R_CLASS_CLASSES)) |
| } |
| if (creationConfig.packageJacocoRuntime) { |
| javaRes.from(creationConfig.artifacts.get(InternalArtifactType.JACOCO_CONFIG_RESOURCES_JAR)) |
| } |
| return javaRes |
| } |
| |
| private fun getExternalLibJavaRes( |
| creationConfig: ComponentCreationConfig, |
| @Suppress("DEPRECATION") // Legacy support |
| mergeScopes: Collection<com.android.build.api.transform.QualifiedContent.ScopeType> |
| ): FileCollection { |
| val externalLibJavaRes = creationConfig.services.fileCollection() |
| @Suppress("DEPRECATION") // Legacy support |
| if (mergeScopes.contains(com.android.build.api.transform.QualifiedContent.Scope.EXTERNAL_LIBRARIES)) { |
| externalLibJavaRes.from( |
| creationConfig.variantDependencies.getArtifactFileCollection( |
| AndroidArtifacts.ConsumedConfigType.RUNTIME_CLASSPATH, |
| AndroidArtifacts.ArtifactScope.EXTERNAL, |
| AndroidArtifacts.ArtifactType.JAVA_RES |
| ) |
| ) |
| } |
| if (mergeScopes.contains(LOCAL_DEPS)) { |
| externalLibJavaRes.from(creationConfig.computeLocalPackagedJars()) |
| } |
| return externalLibJavaRes |
| } |
| |
| /** Returns true if anything's been added to the annotation processor configuration. */ |
| fun projectHasAnnotationProcessors(creationConfig: ComponentCreationConfig): Boolean { |
| val config = creationConfig.variantDependencies.annotationProcessorConfiguration |
| return config.incoming.dependencies.isNotEmpty() |
| } |
