1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
/*
* Copyright (C) 2017 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.res
import com.android.build.api.variant.impl.BuiltArtifactsLoaderImpl
import com.android.build.gradle.internal.AndroidJarInput
import com.android.build.gradle.internal.component.ApkCreationConfig
import com.android.build.gradle.internal.component.DynamicFeatureCreationConfig
import com.android.build.gradle.internal.initialize
import com.android.build.gradle.internal.publishing.AndroidArtifacts
import com.android.build.gradle.internal.publishing.AndroidArtifacts.ArtifactScope.PROJECT
import com.android.build.gradle.internal.publishing.AndroidArtifacts.ArtifactType.FEATURE_RESOURCE_PKG
import com.android.build.gradle.internal.publishing.AndroidArtifacts.ConsumedConfigType.COMPILE_CLASSPATH
import com.android.build.gradle.internal.scope.InternalArtifactType
import com.android.build.gradle.internal.services.Aapt2Input
import com.android.build.gradle.internal.services.getErrorFormatMode
import com.android.build.gradle.internal.services.registerAaptService
import com.android.build.gradle.internal.tasks.BuildAnalyzer
import com.android.build.gradle.internal.tasks.NonIncrementalTask
import com.android.build.gradle.internal.tasks.factory.features.AndroidResourcesTaskCreationAction
import com.android.build.gradle.internal.tasks.factory.VariantTaskCreationAction
import com.android.build.gradle.internal.tasks.factory.features.AndroidResourcesTaskCreationActionImpl
import com.android.build.gradle.internal.utils.fromDisallowChanges
import com.android.build.gradle.internal.utils.setDisallowChanges
import com.android.build.gradle.internal.utils.toImmutableList
import com.android.build.gradle.options.BooleanOption
import com.android.build.gradle.options.StringOption
import com.android.builder.core.ComponentTypeImpl
import com.android.builder.internal.aapt.AaptOptions
import com.android.builder.internal.aapt.AaptPackageConfig
import com.android.ide.common.attribution.TaskCategoryLabel
import com.android.ide.common.resources.mergeIdentifiedSourceSetFiles
import com.android.sdklib.AndroidVersion
import com.android.utils.FileUtils
import com.google.common.collect.ImmutableList
import com.google.common.collect.ImmutableSet
import org.gradle.api.artifacts.ArtifactCollection
import org.gradle.api.file.ConfigurableFileCollection
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.file.FileCollection
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.provider.ListProperty
import org.gradle.api.provider.Property
import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFile
import org.gradle.api.tasks.InputFiles
import org.gradle.api.tasks.Internal
import org.gradle.api.tasks.Nested
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 java.io.File
import java.io.IOException
/**
* Task to link app resources into a proto format so that it can be consumed by the bundle tool.
*/
@CacheableTask
@BuildAnalyzer(taskCategoryLabels = [TaskCategoryLabel.ANDROID_RESOURCES])
abstract class LinkAndroidResForBundleTask : NonIncrementalTask() {
@get:Input
abstract val debuggable: Property<Boolean>
// Not an input as it is only used to rewrite exceptions and doesn't affect task output
@get:Internal
abstract val mergeBlameLogFolder: DirectoryProperty
// Not an input as it is only used to rewrite exceptions and doesn't affect task output
@get:Internal
abstract val manifestMergeBlameFile: RegularFileProperty
private var buildTargetDensity: String? = null
@get:OutputFile
abstract val bundledResFile: RegularFileProperty
@get:InputFiles
@get:PathSensitive(PathSensitivity.RELATIVE)
lateinit var featureResourcePackages: FileCollection
private set
@get:Input
@get:Optional
abstract val resOffset: Property<Int>
@get:OutputDirectory
lateinit var incrementalFolder: File
private set
@get:Input
abstract val excludeResSourcesForReleaseBundles: Property<Boolean>
@get:Nested
abstract val aapt2: Aapt2Input
@get:Nested
abstract val androidJarInput: AndroidJarInput
// No effect on task output, used for generating absolute paths for error messaging.
@get:Internal
abstract val sourceSetMaps: ConfigurableFileCollection
private var compiledDependenciesResources: ArtifactCollection? = null
override fun doTaskAction() {
val manifestFile = manifestFile.get().asFile
val outputFile = bundledResFile.get().asFile
FileUtils.mkdirs(outputFile.parentFile)
val featurePackagesBuilder = ImmutableList.builder<File>()
for (featurePackage in featureResourcePackages) {
val buildElements = BuiltArtifactsLoaderImpl.loadFromDirectory(featurePackage)
if (buildElements?.elements?.size != 1) {
throw IOException("Found more than one PROCESSED_RES output at $featurePackage")
}
featurePackagesBuilder.add(File(buildElements.elements.first().outputFile))
}
val compiledDependenciesResourcesDirs =
getCompiledDependenciesResources()?.reversed()?.toImmutableList() ?: emptyList<File>()
val identifiedSourceSetMap =
mergeIdentifiedSourceSetFiles(sourceSetMaps.files.filterNotNull())
val config = AaptPackageConfig(
androidJarPath = androidJarInput.getAndroidJar().get().absolutePath,
generateProtos = true,
manifestFile = manifestFile,
options = AaptOptions(noCompress.get(), aaptAdditionalParameters.get()),
resourceOutputApk = outputFile,
componentType = ComponentTypeImpl.BASE_APK,
packageId = resOffset.orNull,
allowReservedPackageId = minSdkVersion < AndroidVersion.VersionCodes.O,
dependentFeatures = featurePackagesBuilder.build(),
resourceDirs = ImmutableList.Builder<File>().addAll(compiledDependenciesResourcesDirs)
.add(
checkNotNull(getInputResourcesDir().orNull?.asFile)
).build(),
resourceConfigs = ImmutableSet.copyOf(resConfig),
// We only want to exclude res sources for release builds and when the flag is turned on
// This will result in smaller release bundles
excludeSources = excludeResSourcesForReleaseBundles.get() && debuggable.get().not(),
mergeBlameDirectory = mergeBlameLogFolder.get().asFile,
manifestMergeBlameFile = manifestMergeBlameFile.orNull?.asFile,
identifiedSourceSetMap = identifiedSourceSetMap
)
if (logger.isInfoEnabled) {
logger.info("Aapt output file {}", outputFile.absolutePath)
}
val aapt2ServiceKey = aapt2.registerAaptService()
workerExecutor.noIsolation().submit(Aapt2ProcessResourcesRunnable::class.java) {
it.initializeFromAndroidVariantTask(this)
it.aapt2ServiceKey.set(aapt2ServiceKey)
it.request.set(config)
it.errorFormatMode.set(aapt2.getErrorFormatMode())
}
}
@get:InputFile
@get:PathSensitive(PathSensitivity.NAME_ONLY)
abstract val manifestFile: RegularFileProperty
@InputFiles
@Optional
@PathSensitive(PathSensitivity.RELATIVE)
abstract fun getInputResourcesDir(): DirectoryProperty
@get:Input
lateinit var resConfig: Collection<String> private set
@get:Input
abstract val noCompress: ListProperty<String>
@get:Input
abstract val aaptAdditionalParameters: ListProperty<String>
/**
* Returns a file collection of the directories containing the compiled remote libraries
* resource files.
*/
@Optional
@InputFiles
@PathSensitive(PathSensitivity.RELATIVE)
fun getCompiledDependenciesResources(): FileCollection? {
return compiledDependenciesResources?.artifactFiles
}
@get:Input
var minSdkVersion: Int = 1
private set
class CreationAction(apkCreationConfig: ApkCreationConfig) :
VariantTaskCreationAction<LinkAndroidResForBundleTask, ApkCreationConfig>(
apkCreationConfig
), AndroidResourcesTaskCreationAction by AndroidResourcesTaskCreationActionImpl(
apkCreationConfig
) {
override val name: String
get() = computeTaskName("bundle", "Resources")
override val type: Class<LinkAndroidResForBundleTask>
get() = LinkAndroidResForBundleTask::class.java
override fun handleProvider(
taskProvider: TaskProvider<LinkAndroidResForBundleTask>
) {
super.handleProvider(taskProvider)
creationConfig.artifacts.setInitialProvider(
taskProvider,
LinkAndroidResForBundleTask::bundledResFile
).withName("bundled-res.ap_").on(InternalArtifactType.LINKED_RES_FOR_BUNDLE)
}
override fun configure(
task: LinkAndroidResForBundleTask
) {
super.configure(task)
val projectOptions = creationConfig.services.projectOptions
task.incrementalFolder = creationConfig.paths.getIncrementalDir(name)
creationConfig.artifacts.setTaskInputToFinalProduct(
InternalArtifactType.BUNDLE_MANIFEST,
task.manifestFile)
creationConfig.artifacts.setTaskInputToFinalProduct(
InternalArtifactType.MERGED_RES,
task.getInputResourcesDir()
)
task.featureResourcePackages = creationConfig.variantDependencies.getArtifactFileCollection(
COMPILE_CLASSPATH, PROJECT, FEATURE_RESOURCE_PKG)
if (creationConfig.componentType.isDynamicFeature && creationConfig is DynamicFeatureCreationConfig) {
task.resOffset.set(creationConfig.resOffset)
task.resOffset.disallowChanges()
}
task.debuggable.setDisallowChanges(creationConfig.debuggable)
task.noCompress.setDisallowChanges(
androidResourcesCreationConfig.androidResources.noCompress
)
task.aaptAdditionalParameters.setDisallowChanges(
androidResourcesCreationConfig.androidResources.aaptAdditionalParameters
)
task.excludeResSourcesForReleaseBundles
.setDisallowChanges(
projectOptions.getProvider(BooleanOption.EXCLUDE_RES_SOURCES_FOR_RELEASE_BUNDLES)
)
task.buildTargetDensity =
projectOptions.get(StringOption.IDE_BUILD_TARGET_DENSITY)
task.mergeBlameLogFolder.setDisallowChanges(creationConfig.artifacts.get(InternalArtifactType.MERGED_RES_BLAME_FOLDER))
task.minSdkVersion = creationConfig.minSdkVersion.apiLevel
task.resConfig = androidResourcesCreationConfig.resourceConfigurations
task.manifestMergeBlameFile.setDisallowChanges(creationConfig.artifacts.get(
InternalArtifactType.MANIFEST_MERGE_BLAME_FILE
))
if (androidResourcesCreationConfig.isPrecompileDependenciesResourcesEnabled) {
task.compiledDependenciesResources = creationConfig.variantDependencies.getArtifactCollection(
AndroidArtifacts.ConsumedConfigType.RUNTIME_CLASSPATH,
AndroidArtifacts.ArtifactScope.ALL,
AndroidArtifacts.ArtifactType.COMPILED_DEPENDENCIES_RESOURCES
)
}
creationConfig.services.initializeAapt2Input(task.aapt2)
task.androidJarInput.initialize(creationConfig)
if (projectOptions[BooleanOption.ENABLE_SOURCE_SET_PATHS_MAP]) {
val sourceSetMap =
creationConfig.artifacts.get(InternalArtifactType.SOURCE_SET_PATH_MAP)
task.sourceSetMaps.fromDisallowChanges(
creationConfig.services.fileCollection(sourceSetMap)
)
task.dependsOn(sourceSetMap)
} else {
task.sourceSetMaps.disallowChanges()
}
}
}
}
|
