/** * Copyright (C) 2021 Saturneric * * This file is part of GpgFrontend. * * GpgFrontend is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * GpgFrontend is distributed in the hope that 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 GpgFrontend. If not, see . * * The initial version of the source code is inherited from * the gpg4usb project, which is under GPL-3.0-or-later. * * All the source code of GpgFrontend was modified and released by * Saturneric starting on May 12, 2021. * * SPDX-License-Identifier: GPL-3.0-or-later * */ #include "CacheManager.h" #include #include #include #include "core/function/DataObjectOperator.h" #include "core/utils/MemoryUtils.h" namespace GpgFrontend { template class ThreadSafeMap { public: using MapType = std::map; using IteratorType = typename MapType::iterator; void insert(const Key& key, const Value& value) { std::unique_lock lock(mutex_); (*map_)[key] = value; } auto get(const Key& key) -> std::optional { std::shared_lock lock(mutex_); auto it = map_->find(key); if (it != map_->end()) { return it->second; } return std::nullopt; } auto exists(const Key& key) -> bool { std::shared_lock lock(mutex_); return map_->count(key) > 0; } auto begin() -> IteratorType { return map_mirror_->begin(); } auto end() -> IteratorType { return map_mirror_->end(); } auto mirror() -> ThreadSafeMap& { std::shared_lock lock(mutex_); *map_mirror_ = *map_; return *this; } auto remove(QString key) -> bool { std::unique_lock lock(mutex_); auto it = map_->find(key); if (it != map_->end()) { map_->erase(it); return true; } return false; } private: std::unique_ptr> map_mirror_ = std::move(SecureCreateUniqueObject()); std::unique_ptr> map_ = std::move(SecureCreateUniqueObject()); mutable std::shared_mutex mutex_; }; class CacheManager::Impl : public QObject { Q_OBJECT public: Impl() : flush_timer_(new QTimer(this)) { connect(flush_timer_, &QTimer::timeout, this, &Impl::slot_flush_cache_storage); flush_timer_->start(15000); // load data from storage load_all_cache_storage(); } void SaveDurableCache(QString key, const QJsonDocument& value, bool flush) { auto data_object_key = get_data_object_key(key); durable_cache_storage_.insert(key, value); if (!key_storage_.contains(key)) { GF_CORE_LOG_DEBUG("register new key of cache", key); key_storage_.push_back(key); } if (flush) slot_flush_cache_storage(); } auto LoadDurableCache(const QString& key) -> QJsonDocument { auto data_object_key = get_data_object_key(key); if (!durable_cache_storage_.exists(key)) { durable_cache_storage_.insert(key, load_cache_storage(key, {})); } auto cache = durable_cache_storage_.get(key); if (cache.has_value()) return cache.value(); return {}; } auto LoadDurableCache(const QString& key, QJsonDocument default_value) -> QJsonDocument { auto data_object_key = get_data_object_key(key); if (!durable_cache_storage_.exists(key)) { durable_cache_storage_.insert( key, load_cache_storage(key, std::move(default_value))); } auto cache = durable_cache_storage_.get(key); if (cache.has_value()) return cache.value(); return {}; } auto ResetDurableCache(const QString& key) -> bool { auto data_object_key = get_data_object_key(key); return durable_cache_storage_.remove(key); } void FlushCacheStorage() { this->slot_flush_cache_storage(); } void SaveCache(const QString& key, QString value) { runtime_cache_storage_.insert(key, new QString(std::move(value))); } auto LoadCache(const QString& key) -> QString { auto* value = runtime_cache_storage_.object(key); if (value == nullptr) return {}; return *value; } void ResetCache(const QString& key) { runtime_cache_storage_.remove(key); } private slots: /** * @brief * */ void slot_flush_cache_storage() { for (const auto& cache : durable_cache_storage_.mirror()) { auto key = get_data_object_key(cache.first); GF_CORE_LOG_TRACE("save cache into filesystem, key {}", key); GpgFrontend::DataObjectOperator::GetInstance().SaveDataObj( key, QJsonDocument(cache.second)); } GpgFrontend::DataObjectOperator::GetInstance().SaveDataObj( drk_key_, QJsonDocument(key_storage_)); } private: QCache runtime_cache_storage_; ThreadSafeMap durable_cache_storage_; QJsonArray key_storage_; QTimer* flush_timer_; const QString drk_key_ = "__cache_manage_data_register_key_list"; /** * @brief Get the data object key object * * @param key * @return QString */ static auto get_data_object_key(const QString& key) -> QString { return QString("__cache_data_%1").arg(key); } /** * @brief * * @param key * @param default_value * @return QJsonObject */ static auto load_cache_storage(const QString& key, QJsonDocument default_value) -> QJsonDocument { auto data_object_key = get_data_object_key(key); auto stored_data = GpgFrontend::DataObjectOperator::GetInstance().GetDataObject( data_object_key); if (stored_data.has_value()) return stored_data.value(); return default_value; } /** * @brief * */ void load_all_cache_storage() { GF_CORE_LOG_DEBUG("start to load all cache from file system"); auto stored_data = GpgFrontend::DataObjectOperator::GetInstance().GetDataObject(drk_key_); // get cache data list from file system QJsonArray registered_key_list; if (stored_data->isArray()) { registered_key_list = stored_data->array(); } else { GpgFrontend::DataObjectOperator::GetInstance().SaveDataObj( drk_key_, QJsonDocument(QJsonArray())); } for (const auto& key : registered_key_list) { load_cache_storage(key.toString(), {}); } key_storage_ = registered_key_list; } /** * @brief * * @param key */ void register_cache_key(const QString& key) {} }; CacheManager::CacheManager(int channel) : SingletonFunctionObject(channel), p_(SecureCreateUniqueObject()) {} CacheManager::~CacheManager() { p_->FlushCacheStorage(); } void CacheManager::SaveDurableCache(const QString& key, const QJsonDocument& value, bool flush) { p_->SaveDurableCache(key, value, flush); } auto CacheManager::LoadDurableCache(const QString& key) -> QJsonDocument { return p_->LoadDurableCache(key); } auto CacheManager::LoadDurableCache(const QString& key, QJsonDocument default_value) -> QJsonDocument { return p_->LoadDurableCache(key, std::move(default_value)); } auto CacheManager::ResetDurableCache(const QString& key) -> bool { return p_->ResetDurableCache(key); } void CacheManager::SaveCache(const QString& key, QString value) { p_->SaveCache(key, std::move(value)); } auto CacheManager::LoadCache(const QString& key) -> QString { return p_->LoadCache(key); } void CacheManager::ResetCache(const QString& key) { return p_->ResetCache(key); } } // namespace GpgFrontend #include "CacheManager.moc"