| /* |
| * 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. |
| */ |
| |
| #include "MultiApkGenerator.h" |
| |
| #include <algorithm> |
| #include <string> |
| |
| #include "androidfw/StringPiece.h" |
| |
| #include "LoadedApk.h" |
| #include "ResourceUtils.h" |
| #include "ValueVisitor.h" |
| #include "configuration/ConfigurationParser.h" |
| #include "filter/AbiFilter.h" |
| #include "filter/Filter.h" |
| #include "format/Archive.h" |
| #include "format/binary/XmlFlattener.h" |
| #include "optimize/VersionCollapser.h" |
| #include "process/IResourceTableConsumer.h" |
| #include "split/TableSplitter.h" |
| #include "util/Files.h" |
| #include "xml/XmlDom.h" |
| #include "xml/XmlUtil.h" |
| |
| namespace aapt { |
| |
| using ::aapt::configuration::AndroidSdk; |
| using ::aapt::configuration::Artifact; |
| using ::aapt::configuration::PostProcessingConfiguration; |
| using ::aapt::xml::kSchemaAndroid; |
| using ::aapt::xml::XmlResource; |
| using ::android::StringPiece; |
| |
| namespace { |
| |
| Maybe<AndroidSdk> GetAndroidSdk(const Artifact& artifact, const PostProcessingConfiguration& config, |
| IDiagnostics* diag) { |
| if (!artifact.android_sdk_group) { |
| return {}; |
| } |
| |
| const std::string& group_name = artifact.android_sdk_group.value(); |
| auto group = config.android_sdk_groups.find(group_name); |
| // TODO: Remove validation when configuration parser ensures referential integrity. |
| if (group == config.android_sdk_groups.end()) { |
| diag->Error(DiagMessage() << "could not find referenced group '" << group_name << "'"); |
| return {}; |
| } |
| |
| return group->second; |
| } |
| |
| } // namespace |
| |
| /** |
| * Context wrapper that allows the min Android SDK value to be overridden. |
| */ |
| class ContextWrapper : public IAaptContext { |
| public: |
| explicit ContextWrapper(IAaptContext* context) |
| : context_(context), min_sdk_(context_->GetMinSdkVersion()) { |
| } |
| |
| PackageType GetPackageType() override { |
| return context_->GetPackageType(); |
| } |
| |
| SymbolTable* GetExternalSymbols() override { |
| return context_->GetExternalSymbols(); |
| } |
| |
| IDiagnostics* GetDiagnostics() override { |
| if (source_diag_) { |
| return source_diag_.get(); |
| } |
| return context_->GetDiagnostics(); |
| } |
| |
| const std::string& GetCompilationPackage() override { |
| return context_->GetCompilationPackage(); |
| } |
| |
| uint8_t GetPackageId() override { |
| return context_->GetPackageId(); |
| } |
| |
| NameMangler* GetNameMangler() override { |
| return context_->GetNameMangler(); |
| } |
| |
| bool IsVerbose() override { |
| return context_->IsVerbose(); |
| } |
| |
| int GetMinSdkVersion() override { |
| return min_sdk_; |
| } |
| |
| void SetMinSdkVersion(int min_sdk) { |
| min_sdk_ = min_sdk; |
| } |
| |
| void SetSource(const Source& source) { |
| source_diag_ = util::make_unique<SourcePathDiagnostics>(source, context_->GetDiagnostics()); |
| } |
| |
| private: |
| IAaptContext* context_; |
| std::unique_ptr<SourcePathDiagnostics> source_diag_; |
| |
| int min_sdk_ = -1; |
| }; |
| |
| MultiApkGenerator::MultiApkGenerator(LoadedApk* apk, IAaptContext* context) |
| : apk_(apk), context_(context) { |
| } |
| |
| bool MultiApkGenerator::FromBaseApk(const MultiApkGeneratorOptions& options) { |
| // TODO(safarmer): Handle APK version codes for the generated APKs. |
| const PostProcessingConfiguration& config = options.config; |
| |
| const std::string& apk_name = file::GetFilename(apk_->GetSource().path).to_string(); |
| const StringPiece ext = file::GetExtension(apk_name); |
| const std::string base_name = apk_name.substr(0, apk_name.rfind(ext.to_string())); |
| |
| std::unordered_set<std::string> artifacts_to_keep = options.kept_artifacts; |
| std::unordered_set<std::string> filtered_artifacts; |
| std::unordered_set<std::string> kept_artifacts; |
| |
| // For now, just write out the stripped APK since ABI splitting doesn't modify anything else. |
| for (const Artifact& artifact : config.artifacts) { |
| SourcePathDiagnostics diag{{apk_name}, context_->GetDiagnostics()}; |
| |
| FilterChain filters; |
| |
| if (!artifact.name && !config.artifact_format) { |
| diag.Error( |
| DiagMessage() << "Artifact does not have a name and no global name template defined"); |
| return false; |
| } |
| |
| Maybe<std::string> maybe_artifact_name = |
| (artifact.name) ? artifact.Name(apk_name, &diag) |
| : artifact.ToArtifactName(config.artifact_format.value(), apk_name, &diag); |
| |
| if (!maybe_artifact_name) { |
| diag.Error(DiagMessage() << "Could not determine split APK artifact name"); |
| return false; |
| } |
| |
| const std::string& artifact_name = maybe_artifact_name.value(); |
| |
| ContextWrapper wrapped_context{context_}; |
| wrapped_context.SetSource({artifact_name}); |
| |
| if (!options.kept_artifacts.empty()) { |
| const auto& it = artifacts_to_keep.find(artifact_name); |
| if (it == artifacts_to_keep.end()) { |
| filtered_artifacts.insert(artifact_name); |
| if (context_->IsVerbose()) { |
| context_->GetDiagnostics()->Note(DiagMessage(artifact_name) << "skipping artifact"); |
| } |
| continue; |
| } else { |
| artifacts_to_keep.erase(it); |
| kept_artifacts.insert(artifact_name); |
| } |
| } |
| |
| std::unique_ptr<ResourceTable> table = |
| FilterTable(artifact, config, *apk_->GetResourceTable(), &wrapped_context, &filters); |
| if (!table) { |
| return false; |
| } |
| |
| std::unique_ptr<XmlResource> manifest; |
| if (!UpdateManifest(artifact, config, &manifest, &diag)) { |
| diag.Error(DiagMessage() << "could not update AndroidManifest.xml for output artifact"); |
| return false; |
| } |
| |
| std::string out = options.out_dir; |
| if (!file::mkdirs(out)) { |
| diag.Warn(DiagMessage() << "could not create out dir: " << out); |
| } |
| file::AppendPath(&out, artifact_name); |
| |
| if (context_->IsVerbose()) { |
| diag.Note(DiagMessage() << "Generating split: " << out); |
| } |
| |
| std::unique_ptr<IArchiveWriter> writer = CreateZipFileArchiveWriter(&diag, out); |
| |
| if (context_->IsVerbose()) { |
| diag.Note(DiagMessage() << "Writing output: " << out); |
| } |
| |
| if (!apk_->WriteToArchive(&wrapped_context, table.get(), options.table_flattener_options, |
| &filters, writer.get(), manifest.get())) { |
| return false; |
| } |
| } |
| |
| // Make sure all of the requested artifacts were valid. If there are any kept artifacts left, |
| // either the config or the command line was wrong. |
| if (!artifacts_to_keep.empty()) { |
| context_->GetDiagnostics()->Error( |
| DiagMessage() << "The configuration and command line to filter artifacts do not match"); |
| |
| context_->GetDiagnostics()->Error(DiagMessage() << kept_artifacts.size() << " kept:"); |
| for (const auto& artifact : kept_artifacts) { |
| context_->GetDiagnostics()->Error(DiagMessage() << " " << artifact); |
| } |
| |
| context_->GetDiagnostics()->Error(DiagMessage() << filtered_artifacts.size() << " filtered:"); |
| for (const auto& artifact : filtered_artifacts) { |
| context_->GetDiagnostics()->Error(DiagMessage() << " " << artifact); |
| } |
| |
| context_->GetDiagnostics()->Error(DiagMessage() << artifacts_to_keep.size() << " missing:"); |
| for (const auto& artifact : artifacts_to_keep) { |
| context_->GetDiagnostics()->Error(DiagMessage() << " " << artifact); |
| } |
| |
| return false; |
| } |
| |
| return true; |
| } |
| |
| std::unique_ptr<ResourceTable> MultiApkGenerator::FilterTable( |
| const configuration::Artifact& artifact, |
| const configuration::PostProcessingConfiguration& config, const ResourceTable& old_table, |
| IAaptContext* context, FilterChain* filters) { |
| TableSplitterOptions splits; |
| AxisConfigFilter axis_filter; |
| ContextWrapper wrapped_context{context}; |
| |
| if (artifact.abi_group) { |
| const std::string& group_name = artifact.abi_group.value(); |
| |
| auto group = config.abi_groups.find(group_name); |
| // TODO: Remove validation when configuration parser ensures referential integrity. |
| if (group == config.abi_groups.end()) { |
| context->GetDiagnostics()->Error(DiagMessage() << "could not find referenced ABI group '" |
| << group_name << "'"); |
| return {}; |
| } |
| filters->AddFilter(AbiFilter::FromAbiList(group->second)); |
| } |
| |
| if (artifact.screen_density_group) { |
| const std::string& group_name = artifact.screen_density_group.value(); |
| |
| auto group = config.screen_density_groups.find(group_name); |
| // TODO: Remove validation when configuration parser ensures referential integrity. |
| if (group == config.screen_density_groups.end()) { |
| context->GetDiagnostics()->Error(DiagMessage() |
| << "could not find referenced group '" << group_name << "'"); |
| return {}; |
| } |
| |
| const std::vector<ConfigDescription>& densities = group->second; |
| for (const auto& density_config : densities) { |
| splits.preferred_densities.push_back(density_config.density); |
| } |
| } |
| |
| if (artifact.locale_group) { |
| const std::string& group_name = artifact.locale_group.value(); |
| auto group = config.locale_groups.find(group_name); |
| // TODO: Remove validation when configuration parser ensures referential integrity. |
| if (group == config.locale_groups.end()) { |
| context->GetDiagnostics()->Error(DiagMessage() |
| << "could not find referenced group '" << group_name << "'"); |
| return {}; |
| } |
| |
| const std::vector<ConfigDescription>& locales = group->second; |
| for (const auto& locale : locales) { |
| axis_filter.AddConfig(locale); |
| } |
| splits.config_filter = &axis_filter; |
| } |
| |
| Maybe<AndroidSdk> sdk = GetAndroidSdk(artifact, config, context->GetDiagnostics()); |
| if (sdk && sdk.value().min_sdk_version) { |
| wrapped_context.SetMinSdkVersion(sdk.value().min_sdk_version.value()); |
| } |
| |
| std::unique_ptr<ResourceTable> table = old_table.Clone(); |
| |
| VersionCollapser collapser; |
| if (!collapser.Consume(&wrapped_context, table.get())) { |
| context->GetDiagnostics()->Error(DiagMessage() << "Failed to strip versioned resources"); |
| return {}; |
| } |
| |
| TableSplitter splitter{{}, splits}; |
| splitter.SplitTable(table.get()); |
| return table; |
| } |
| |
| bool MultiApkGenerator::UpdateManifest(const Artifact& artifact, |
| const PostProcessingConfiguration& config, |
| std::unique_ptr<XmlResource>* updated_manifest, |
| IDiagnostics* diag) { |
| const xml::XmlResource* apk_manifest = apk_->GetManifest(); |
| if (apk_manifest == nullptr) { |
| return false; |
| } |
| |
| *updated_manifest = apk_manifest->Clone(); |
| XmlResource* manifest = updated_manifest->get(); |
| |
| // Make sure the first element is <manifest> with package attribute. |
| xml::Element* manifest_el = manifest->root.get(); |
| if (manifest_el == nullptr) { |
| return false; |
| } |
| |
| if (!manifest_el->namespace_uri.empty() || manifest_el->name != "manifest") { |
| diag->Error(DiagMessage(manifest->file.source) << "root tag must be <manifest>"); |
| return false; |
| } |
| |
| // Update the versionCode attribute. |
| xml::Attribute* versionCode = manifest_el->FindAttribute(kSchemaAndroid, "versionCode"); |
| if (versionCode == nullptr) { |
| diag->Error(DiagMessage(manifest->file.source) << "manifest must have a versionCode attribute"); |
| return false; |
| } |
| |
| auto* compiled_version = ValueCast<BinaryPrimitive>(versionCode->compiled_value.get()); |
| if (compiled_version == nullptr) { |
| diag->Error(DiagMessage(manifest->file.source) << "versionCode is invalid"); |
| return false; |
| } |
| |
| int new_version = compiled_version->value.data + artifact.version; |
| versionCode->compiled_value = ResourceUtils::TryParseInt(std::to_string(new_version)); |
| |
| // Check to see if the minSdkVersion needs to be updated. |
| Maybe<AndroidSdk> maybe_sdk = GetAndroidSdk(artifact, config, diag); |
| if (maybe_sdk) { |
| // TODO(safarmer): Handle the rest of the Android SDK. |
| const AndroidSdk& android_sdk = maybe_sdk.value(); |
| |
| if (xml::Element* uses_sdk_el = manifest_el->FindChild({}, "uses-sdk")) { |
| if (xml::Attribute* min_sdk_attr = |
| uses_sdk_el->FindAttribute(xml::kSchemaAndroid, "minSdkVersion")) { |
| // Populate with a pre-compiles attribute to we don't need to relink etc. |
| const std::string& min_sdk_str = std::to_string(android_sdk.min_sdk_version.value()); |
| min_sdk_attr->compiled_value = ResourceUtils::TryParseInt(min_sdk_str); |
| } else { |
| // There was no minSdkVersion. This is strange since at this point we should have been |
| // through the manifest fixer which sets the default minSdkVersion. |
| diag->Error(DiagMessage(manifest->file.source) << "missing minSdkVersion from <uses-sdk>"); |
| return false; |
| } |
| } else { |
| // No uses-sdk present. This is strange since at this point we should have been |
| // through the manifest fixer which should have added it. |
| diag->Error(DiagMessage(manifest->file.source) << "missing <uses-sdk> from <manifest>"); |
| return false; |
| } |
| } |
| |
| if (artifact.screen_density_group) { |
| auto densities = config.screen_density_groups.find(artifact.screen_density_group.value()); |
| CHECK(densities != config.screen_density_groups.end()) << "Missing density group"; |
| |
| xml::Element* screens_el = manifest_el->FindChild({}, "compatible-screens"); |
| if (!screens_el) { |
| // create a new element. |
| std::unique_ptr<xml::Element> new_screens_el = util::make_unique<xml::Element>(); |
| new_screens_el->name = "compatible-screens"; |
| screens_el = new_screens_el.get(); |
| manifest_el->InsertChild(0, std::move(new_screens_el)); |
| } else { |
| // clear out the old element. |
| screens_el->GetChildElements().clear(); |
| } |
| |
| for (const auto& density : densities->second) { |
| std::unique_ptr<xml::Element> screen_el = util::make_unique<xml::Element>(); |
| screen_el->name = "screen"; |
| const char* density_str = density.toString().string(); |
| screen_el->attributes.push_back(xml::Attribute{kSchemaAndroid, "screenDensity", density_str}); |
| screens_el->AppendChild(std::move(screen_el)); |
| } |
| } |
| |
| return true; |
| } |
| |
| } // namespace aapt |