/* * Copyright (c) 2019-2020 Adubbz, Atmosphère-NX * * This program is free software; you can redistribute it and/or modify it * under the terms and conditions of the GNU General Public License, * version 2, as published by the Free Software Foundation. * * This program is distributed in the hope it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include "ncm_content_meta_database_impl.hpp" namespace ams::ncm { Result ContentMetaDatabaseImpl::GetContentIdImpl(ContentId *out, const ContentMetaKey& key, ContentType type, std::optional id_offset) const { R_TRY(this->EnsureEnabled()); /* Find the meta key. */ const auto it = this->kvs->lower_bound(key); R_UNLESS(it != this->kvs->end(), ncm::ResultContentMetaNotFound()); R_UNLESS(it->GetKey().id == key.id, ncm::ResultContentMetaNotFound()); const auto found_key = it->GetKey(); /* Create a reader for this content meta. */ const void *meta; size_t meta_size; R_TRY(this->GetContentMetaPointer(&meta, &meta_size, found_key)); ContentMetaReader reader(meta, meta_size); /* Find the content info. */ const ContentInfo *content_info = nullptr; if (id_offset) { content_info = reader.GetContentInfo(type, *id_offset); } else { content_info = reader.GetContentInfo(type); } R_UNLESS(content_info != nullptr, ncm::ResultContentNotFound()); /* Save output. */ *out = content_info->content_id; return ResultSuccess(); } Result ContentMetaDatabaseImpl::Set(const ContentMetaKey &key, sf::InBuffer value) { R_TRY(this->EnsureEnabled()); return this->kvs->Set(key, value.GetPointer(), value.GetSize()); } Result ContentMetaDatabaseImpl::Get(sf::Out out_size, const ContentMetaKey &key, sf::OutBuffer out_value) { R_TRY(this->EnsureEnabled()); /* Get the entry from our key-value store. */ size_t size; R_TRY_CATCH(this->kvs->Get(std::addressof(size), out_value.GetPointer(), out_value.GetSize(), key)) { R_CONVERT(kvdb::ResultKeyNotFound, ncm::ResultContentMetaNotFound()) } R_END_TRY_CATCH; out_size.SetValue(size); return ResultSuccess(); } Result ContentMetaDatabaseImpl::Remove(const ContentMetaKey &key) { R_TRY(this->EnsureEnabled()); R_TRY_CATCH(this->kvs->Remove(key)) { R_CONVERT(kvdb::ResultKeyNotFound, ncm::ResultContentMetaNotFound()) } R_END_TRY_CATCH; return ResultSuccess(); } Result ContentMetaDatabaseImpl::GetContentIdByType(sf::Out out_content_id, const ContentMetaKey &key, ContentType type) { return this->GetContentIdImpl(out_content_id.GetPointer(), key, type, std::nullopt); } Result ContentMetaDatabaseImpl::ListContentInfo(sf::Out out_count, const sf::OutArray &out_info, const ContentMetaKey &key, s32 offset) { R_UNLESS(offset >= 0, ncm::ResultInvalidOffset()); R_TRY(this->EnsureEnabled()); /* Obtain the content meta for the given key. */ const void *meta; size_t meta_size; R_TRY(this->GetContentMetaPointer(&meta, &meta_size, key)); /* Create a reader. */ ContentMetaReader reader(meta, meta_size); /* Read content infos from the given offset up to the given count. */ size_t count; for (count = 0; count < out_info.GetSize() && count + offset < reader.GetContentCount(); count++) { out_info[count] = *reader.GetContentInfo(offset + count); } out_count.SetValue(count); return ResultSuccess(); } Result ContentMetaDatabaseImpl::List(sf::Out out_entries_total, sf::Out out_entries_written, const sf::OutArray &out_info, ContentMetaType meta_type, ApplicationId application_id, u64 min, u64 max, ContentInstallType install_type) { R_TRY(this->EnsureEnabled()); size_t entries_total = 0; size_t entries_written = 0; /* Iterate over all entries. */ for (auto &entry : *this->kvs) { const ContentMetaKey key = entry.GetKey(); /* Check if this entry matches the given filters. */ if (!((meta_type == ContentMetaType::Unknown || key.type == meta_type) && (min <= key.id && key.id <= max) && (install_type == ContentInstallType::Unknown || key.install_type == install_type))) { continue; } /* If application id is present, check if it matches the filter. */ if (application_id != InvalidApplicationId) { /* Obtain the content meta for the key. */ const void *meta; size_t meta_size; R_TRY(this->GetContentMetaPointer(&meta, &meta_size, key)); /* Create a reader. */ ContentMetaReader reader(meta, meta_size); /* Ensure application id matches, if present. */ if (const auto entry_application_id = reader.GetApplicationId(key); entry_application_id && application_id != *entry_application_id) { continue; } } /* Write the entry to the output buffer. */ if (entries_written < out_info.GetSize()) { out_info[entries_written++] = key; } entries_total++; } out_entries_total.SetValue(entries_total); out_entries_written.SetValue(entries_written); return ResultSuccess(); } Result ContentMetaDatabaseImpl::GetLatestContentMetaKey(sf::Out out_key, u64 id) { R_TRY(this->EnsureEnabled()); std::optional found_key = std::nullopt; /* Find the last key with the desired program id. */ for (auto entry = this->kvs->lower_bound(ContentMetaKey::MakeUnknownType(id, 0)); entry != this->kvs->end(); entry++) { /* No further entries will match the program id, discontinue. */ if (entry->GetKey().id != id) { break; } /* We are only interested in keys with the Full content install type. */ if (entry->GetKey().install_type == ContentInstallType::Full) { found_key = entry->GetKey(); } } /* Check if the key is absent. */ R_UNLESS(found_key, ncm::ResultContentMetaNotFound()); out_key.SetValue(*found_key); return ResultSuccess(); } Result ContentMetaDatabaseImpl::ListApplication(sf::Out out_entries_total, sf::Out out_entries_written, const sf::OutArray &out_keys, ContentMetaType type) { R_TRY(this->EnsureEnabled()); size_t entries_total = 0; size_t entries_written = 0; /* Iterate over all entries. */ for (auto &entry : *this->kvs) { const ContentMetaKey key = entry.GetKey(); /* Check if this entry matches the given filters. */ if (!(type == ContentMetaType::Unknown || key.type == type)) { continue; } /* Check if the entry has an application id. */ ContentMetaReader reader(entry.GetValuePointer(), entry.GetValueSize()); if (const auto entry_application_id = reader.GetApplicationId(key); entry_application_id) { /* Write the entry to the output buffer. */ if (entries_written < out_keys.GetSize()) { out_keys[entries_written++] = { key, *entry_application_id }; } entries_total++; } } out_entries_total.SetValue(entries_total); out_entries_written.SetValue(entries_written); return ResultSuccess(); } Result ContentMetaDatabaseImpl::Has(sf::Out out, const ContentMetaKey &key) { R_TRY(this->EnsureEnabled()); *out = false; /* Check if key is present. */ size_t size; R_TRY_CATCH(this->kvs->GetValueSize(&size, key)) { R_CONVERT(kvdb::ResultKeyNotFound, ResultSuccess()); } R_END_TRY_CATCH; *out = true; return ResultSuccess(); } Result ContentMetaDatabaseImpl::HasAll(sf::Out out, const sf::InArray &keys) { R_TRY(this->EnsureEnabled()); *out = false; /* Check if keys are present. */ for (size_t i = 0; i < keys.GetSize(); i++) { /* Check if we have the current key. */ bool has; R_TRY(this->Has(std::addressof(has), keys[i])); /* If we don't, then we can early return because we don't have all. */ R_SUCCEED_IF(!has); } *out = true; return ResultSuccess(); } Result ContentMetaDatabaseImpl::GetSize(sf::Out out_size, const ContentMetaKey &key) { R_TRY(this->EnsureEnabled()); /* Determine the content meta size for the key. */ size_t size; R_TRY(this->GetContentMetaSize(&size, key)); out_size.SetValue(size); return ResultSuccess(); } Result ContentMetaDatabaseImpl::GetRequiredSystemVersion(sf::Out out_version, const ContentMetaKey &key) { R_TRY(this->EnsureEnabled()); /* Only applications and patches have a required system version. */ R_UNLESS(key.type == ContentMetaType::Application || key.type == ContentMetaType::Patch, ncm::ResultInvalidContentMetaKey()); /* Obtain the content meta for the key. */ const void *meta; size_t meta_size; R_TRY(this->GetContentMetaPointer(&meta, &meta_size, key)); /* Create a reader. */ ContentMetaReader reader(meta, meta_size); /* Obtain the required system version. */ switch (key.type) { case ContentMetaType::Application: out_version.SetValue(reader.GetExtendedHeader()->required_system_version); break; case ContentMetaType::Patch: out_version.SetValue(reader.GetExtendedHeader()->required_system_version); break; AMS_UNREACHABLE_DEFAULT_CASE(); } return ResultSuccess(); } Result ContentMetaDatabaseImpl::GetPatchId(sf::Out out_patch_id, const ContentMetaKey &key) { R_TRY(this->EnsureEnabled()); /* Only applications can have patches. */ R_UNLESS(key.type == ContentMetaType::Application, ncm::ResultInvalidContentMetaKey()); /* Obtain the content meta for the key. */ const void *meta; size_t meta_size; R_TRY(this->GetContentMetaPointer(&meta, &meta_size, key)); /* Create a reader. */ ContentMetaReader reader(meta, meta_size); /* Obtain the patch id. */ out_patch_id.SetValue(reader.GetExtendedHeader()->patch_id); return ResultSuccess(); } Result ContentMetaDatabaseImpl::DisableForcibly() { this->disabled = true; return ResultSuccess(); } Result ContentMetaDatabaseImpl::LookupOrphanContent(const sf::OutArray &out_orphaned, const sf::InArray &content_ids) { R_TRY(this->EnsureEnabled()); R_UNLESS(out_orphaned.GetSize() >= content_ids.GetSize(), ncm::ResultBufferInsufficient()); /* Default to orphaned for all content ids. */ for (size_t i = 0; i < out_orphaned.GetSize(); i++) { out_orphaned[i] = true; } auto IsOrphanedContent = [](const sf::InArray &list, const ncm::ContentId &id) ALWAYS_INLINE_LAMBDA { /* Check if any input content ids match our found content id. */ for (size_t i = 0; i < list.GetSize(); i++) { if (list[i] == id) { return std::make_optional(i); } } /* TODO: C++20 (gcc 10) fixes ALWAYS_INLINE_LAMBDA in conjunction with trailing return types. */ /* This should be changed to std::nullopt once possible. */ return std::optional(std::nullopt); }; /* Iterate over all entries. */ for (auto &entry : *this->kvs) { ContentMetaReader reader(entry.GetValuePointer(), entry.GetValueSize()); /* Check if any of this entry's content infos matches one of the content ids for lookup. */ /* If they do, then the content id isn't orphaned. */ for (size_t i = 0; i < reader.GetContentCount(); i++) { if (auto found = IsOrphanedContent(content_ids, reader.GetContentInfo(i)->GetId()); found) { out_orphaned[*found] = false; } } } return ResultSuccess(); } Result ContentMetaDatabaseImpl::Commit() { R_TRY(this->EnsureEnabled()); /* Save and commit. */ R_TRY(this->kvs->Save()); return fs::CommitSaveData(this->mount_name); } Result ContentMetaDatabaseImpl::HasContent(sf::Out out, const ContentMetaKey &key, const ContentId &content_id) { /* Obtain the content meta for the key. */ const void *meta; size_t meta_size; R_TRY(this->GetContentMetaPointer(&meta, &meta_size, key)); /* Create a reader. */ ContentMetaReader reader(meta, meta_size); /* Optimistically suppose that we will find the content. */ out.SetValue(true); /* Check if any content infos contain a matching id. */ for (size_t i = 0; i < reader.GetContentCount(); i++) { R_SUCCEED_IF(content_id == reader.GetContentInfo(i)->GetId()); } /* We didn't find a content info. */ out.SetValue(false); return ResultSuccess(); } Result ContentMetaDatabaseImpl::ListContentMetaInfo(sf::Out out_entries_written, const sf::OutArray &out_meta_info, const ContentMetaKey &key, s32 offset) { R_UNLESS(offset >= 0, ncm::ResultInvalidOffset()); R_TRY(this->EnsureEnabled()); /* Obtain the content meta for the key. */ const void *meta; size_t meta_size; R_TRY(this->GetContentMetaPointer(&meta, &meta_size, key)); /* Create a reader. */ ContentMetaReader reader(meta, meta_size); /* Read content meta infos from the given offset up to the given count. */ size_t count; for (count = 0; count < out_meta_info.GetSize() && count + offset <= reader.GetContentMetaCount(); count++) { out_meta_info[count] = *reader.GetContentMetaInfo(count + offset); } /* Set the ouput value. */ out_entries_written.SetValue(count); return ResultSuccess(); } Result ContentMetaDatabaseImpl::GetAttributes(sf::Out out_attributes, const ContentMetaKey &key) { R_TRY(this->EnsureEnabled()); /* Obtain the content meta for the key. */ const void *meta; size_t meta_size; R_TRY(this->GetContentMetaPointer(&meta, &meta_size, key)); /* Create a reader. */ ContentMetaReader reader(meta, meta_size); /* Set the ouput value. */ out_attributes.SetValue(reader.GetHeader()->attributes); return ResultSuccess(); } Result ContentMetaDatabaseImpl::GetRequiredApplicationVersion(sf::Out out_version, const ContentMetaKey &key) { R_TRY(this->EnsureEnabled()); /* Obtain the content meta for the key. */ const void *meta; size_t meta_size; R_TRY(this->GetContentMetaPointer(&meta, &meta_size, key)); /* Create a reader. */ ContentMetaReader reader(meta, meta_size); /* Get the required version. */ u32 required_version; switch (key.type) { case ContentMetaType::AddOnContent: required_version = reader.GetExtendedHeader()->required_application_version; break; case ContentMetaType::Application: /* As of 9.0.0, applications can be dependent on a specific base application version. */ AMS_ABORT_UNLESS(hos::GetVersion() >= hos::Version_900); required_version = reader.GetExtendedHeader()->required_application_version; break; AMS_UNREACHABLE_DEFAULT_CASE(); } /* Set the ouput value. */ out_version.SetValue(required_version); return ResultSuccess(); } Result ContentMetaDatabaseImpl::GetContentIdByTypeAndIdOffset(sf::Out out_content_id, const ContentMetaKey &key, ContentType type, u8 id_offset) { return this->GetContentIdImpl(out_content_id.GetPointer(), key, type, std::make_optional(id_offset)); } }