SQLiteAlertStorage.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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.
 */

#ifndef ALEXA_CLIENT_SDK_ACSDKALERTS_INCLUDE_ACSDKALERTS_STORAGE_SQLITEALERTSTORAGE_H_
#define ALEXA_CLIENT_SDK_ACSDKALERTS_INCLUDE_ACSDKALERTS_STORAGE_SQLITEALERTSTORAGE_H_

#include <set>

#include <AVSCommon/SDKInterfaces/Audio/AlertsAudioFactoryInterface.h>
#include <AVSCommon/SDKInterfaces/Audio/AudioFactoryInterface.h>
#include <AVSCommon/Utils/Configuration/ConfigurationNode.h>
#include <AVSCommon/Utils/Metrics/MetricRecorderInterface.h>
#include <AVSCommon/Utils/WaitEvent.h>
#include <SQLiteStorage/SQLiteDatabase.h>

#include "acsdkAlerts/Storage/AlertStorageInterface.h"

namespace alexaClientSDK {
namespace acsdkAlerts {
namespace storage {

class SQLiteAlertStorage : public AlertStorageInterface {
public:
    static std::shared_ptr<AlertStorageInterface> createAlertStorageInterface(
        const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationRoot,
        const std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface>& audioFactory,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder = nullptr);

    static std::unique_ptr<SQLiteAlertStorage> create(
        const avsCommon::utils::configuration::ConfigurationNode& configurationRoot,
        const std::shared_ptr<avsCommon::sdkInterfaces::audio::AlertsAudioFactoryInterface>& alertsAudioFactory,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder = nullptr);

    ~SQLiteAlertStorage();

    bool createDatabase() override;

    bool open() override;

    void close() override;

    bool store(std::shared_ptr<Alert> alert) override;

    bool storeOfflineAlert(const std::string& token, const std::string& scheduledTime, const std::string& eventTime)
        override;

    bool load(
        std::vector<std::shared_ptr<Alert>>* alertContainer,
        std::shared_ptr<settings::DeviceSettingsManager> settingsManager) override;

    bool loadOfflineAlerts(rapidjson::Value* alertContainer, rapidjson::Document::AllocatorType& allocator) override;

    bool modify(std::shared_ptr<Alert> alert) override;

    bool erase(std::shared_ptr<Alert> alert) override;

    bool eraseOffline(const std::string& token, int id) override;

    bool bulkErase(const std::list<std::shared_ptr<Alert>>& alertList) override;

    bool clearDatabase() override;

    enum class StatLevel {
        ONE_LINE,
        ALERTS_SUMMARY,
        EVERYTHING
    };

    void printStats(StatLevel level = StatLevel::ONE_LINE);

private:
    SQLiteAlertStorage(
        const std::string& dbFilePath,
        const std::shared_ptr<avsCommon::sdkInterfaces::audio::AlertsAudioFactoryInterface>& alertsAudioFactory,
        std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder);

    bool loadHelper(
        int dbVersion,
        std::vector<std::shared_ptr<Alert>>* alertContainer,
        std::shared_ptr<settings::DeviceSettingsManager> settingsManager);

    bool storeOfflineAlertHelper(
        const int dbVersion,
        const std::string& token,
        const std::string& scheduledTime,
        const std::string& eventTime);

    bool loadOfflineAlertsHelper(
        const int dbVersion,
        rapidjson::Value* alertContainer,
        rapidjson::Document::AllocatorType& allocator);

    bool eraseOfflineHelper(const int dbVersion, const std::string& token);

    bool alertExists(const int dbVersion, const std::string& token);

    bool isOfflineTableV1Legacy();

    bool offlineAlertExists(const int dbVersion, const std::string& token);

    bool migrateOfflineAlertsDbFromV1ToV2();

    bool migrateAlertsDbFromV2ToV3();

    bool modifyAlert(const int dbVersion, std::shared_ptr<Alert> alert);

    template <typename Task, typename... Args>
    bool retryDataMigration(Task task, Args&&... args);

    std::shared_ptr<avsCommon::sdkInterfaces::audio::AlertsAudioFactoryInterface> m_alertsAudioFactory;

    alexaClientSDK::storage::sqliteStorage::SQLiteDatabase m_db;

    std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> m_metricRecorder;

    avsCommon::utils::RetryTimer m_retryTimer;

    avsCommon::utils::WaitEvent m_waitRetryEvent;
};

}  // namespace storage
}  // namespace acsdkAlerts
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_ACSDKALERTS_INCLUDE_ACSDKALERTS_STORAGE_SQLITEALERTSTORAGE_H_