1// Copyright 2020 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17// This file contains the module implementation for android_app_set.
18
19import (
20	"strconv"
21	"strings"
22
23	"github.com/google/blueprint/proptools"
24
25	"android/soong/android"
26)
27
28func init() {
29	RegisterAppSetBuildComponents(android.InitRegistrationContext)
30}
31
32func RegisterAppSetBuildComponents(ctx android.RegistrationContext) {
33	ctx.RegisterModuleType("android_app_set", AndroidAppSetFactory)
34}
35
36type AndroidAppSetProperties struct {
37	// APK Set path
38	Set *string
39
40	// Specifies that this app should be installed to the priv-app directory,
41	// where the system will grant it additional privileges not available to
42	// normal apps.
43	Privileged *bool
44
45	// APKs in this set use prerelease SDK version
46	Prerelease *bool
47
48	// Names of modules to be overridden. Listed modules can only be other apps
49	//	(in Make or Soong).
50	Overrides []string
51}
52
53type AndroidAppSet struct {
54	android.ModuleBase
55	android.DefaultableModuleBase
56	prebuilt android.Prebuilt
57
58	properties   AndroidAppSetProperties
59	packedOutput android.WritablePath
60	installFile  string
61	apkcertsFile android.ModuleOutPath
62}
63
64func (as *AndroidAppSet) Name() string {
65	return as.prebuilt.Name(as.ModuleBase.Name())
66}
67
68func (as *AndroidAppSet) IsInstallable() bool {
69	return true
70}
71
72func (as *AndroidAppSet) Prebuilt() *android.Prebuilt {
73	return &as.prebuilt
74}
75
76func (as *AndroidAppSet) Privileged() bool {
77	return Bool(as.properties.Privileged)
78}
79
80func (as *AndroidAppSet) OutputFile() android.Path {
81	return as.packedOutput
82}
83
84func (as *AndroidAppSet) InstallFile() string {
85	return as.installFile
86}
87
88func (as *AndroidAppSet) APKCertsFile() android.Path {
89	return as.apkcertsFile
90}
91
92var TargetCpuAbi = map[string]string{
93	"arm":    "ARMEABI_V7A",
94	"arm64":  "ARM64_V8A",
95	"x86":    "X86",
96	"x86_64": "X86_64",
97}
98
99func SupportedAbis(ctx android.ModuleContext) []string {
100	abiName := func(targetIdx int, deviceArch string) string {
101		if abi, found := TargetCpuAbi[deviceArch]; found {
102			return abi
103		}
104		ctx.ModuleErrorf("Target %d has invalid Arch: %s", targetIdx, deviceArch)
105		return "BAD_ABI"
106	}
107
108	var result []string
109	for i, target := range ctx.Config().Targets[android.Android] {
110		result = append(result, abiName(i, target.Arch.ArchType.String()))
111	}
112	return result
113}
114
115func (as *AndroidAppSet) GenerateAndroidBuildActions(ctx android.ModuleContext) {
116	as.packedOutput = android.PathForModuleOut(ctx, ctx.ModuleName()+".zip")
117	as.apkcertsFile = android.PathForModuleOut(ctx, "apkcerts.txt")
118	// We are assuming here that the install file in the APK
119	// set has `.apk` suffix. If it doesn't the build will fail.
120	// APK sets containing APEX files are handled elsewhere.
121	as.installFile = as.BaseModuleName() + ".apk"
122	screenDensities := "all"
123	if dpis := ctx.Config().ProductAAPTPrebuiltDPI(); len(dpis) > 0 {
124		screenDensities = strings.ToUpper(strings.Join(dpis, ","))
125	}
126	// TODO(asmundak): handle locales.
127	// TODO(asmundak): do we support device features
128	ctx.Build(pctx,
129		android.BuildParams{
130			Rule:           extractMatchingApks,
131			Description:    "Extract APKs from APK set",
132			Output:         as.packedOutput,
133			ImplicitOutput: as.apkcertsFile,
134			Inputs:         android.Paths{as.prebuilt.SingleSourcePath(ctx)},
135			Args: map[string]string{
136				"abis":              strings.Join(SupportedAbis(ctx), ","),
137				"allow-prereleased": strconv.FormatBool(proptools.Bool(as.properties.Prerelease)),
138				"screen-densities":  screenDensities,
139				"sdk-version":       ctx.Config().PlatformSdkVersion().String(),
140				"stem":              as.BaseModuleName(),
141				"apkcerts":          as.apkcertsFile.String(),
142				"partition":         as.PartitionTag(ctx.DeviceConfig()),
143			},
144		})
145}
146
147// android_app_set extracts a set of APKs based on the target device
148// configuration and installs this set as "split APKs".
149// The extracted set always contains an APK whose name is
150// _module_name_.apk and every split APK matching target device.
151// The extraction of the density-specific splits depends on
152// PRODUCT_AAPT_PREBUILT_DPI variable. If present (its value should
153// be a list density names: LDPI, MDPI, HDPI, etc.), only listed
154// splits will be extracted. Otherwise all density-specific splits
155// will be extracted.
156func AndroidAppSetFactory() android.Module {
157	module := &AndroidAppSet{}
158	module.AddProperties(&module.properties)
159	InitJavaModule(module, android.DeviceSupported)
160	android.InitSingleSourcePrebuiltModule(module, &module.properties, "Set")
161	return module
162}
163