avs-device-sdk/CapabilityAgents/DoNotDisturb/include/DoNotDisturbCA/DoNotDisturbCapabilityAgent.h

/*
 * Copyright 2018 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_CAPABILITYAGENTS_DONOTDISTURB_INCLUDE_DONOTDISTURBCA_DONOTDISTURBCAPABILITYAGENT_H_
#define ALEXA_CLIENT_SDK_CAPABILITYAGENTS_DONOTDISTURB_INCLUDE_DONOTDISTURBCA_DONOTDISTURBCAPABILITYAGENT_H_

#include <atomic>
#include <memory>
#include <mutex>

#include <rapidjson/document.h>

#include <AVSCommon/AVS/CapabilityAgent.h>
#include <AVSCommon/AVS/CapabilityConfiguration.h>
#include <AVSCommon/AVS/ExceptionErrorType.h>
#include <AVSCommon/SDKInterfaces/CapabilitiesDelegateInterface.h>
#include <AVSCommon/SDKInterfaces/CapabilityConfigurationInterface.h>
#include <AVSCommon/SDKInterfaces/ConnectionStatusObserverInterface.h>
#include <AVSCommon/SDKInterfaces/MessageSenderInterface.h>
#include <AVSCommon/Utils/RequiresShutdown.h>
#include <AVSCommon/Utils/Threading/Executor.h>
#include <RegistrationManager/CustomerDataHandler.h>
#include <RegistrationManager/CustomerDataManager.h>
#include <Settings/Storage/DeviceSettingStorageInterface.h>
#include <Settings/DeviceSettingsManager.h>
#include <Settings/SettingEventSenderInterface.h>
#include <Settings/Setting.h>

namespace alexaClientSDK {
namespace capabilityAgents {
namespace doNotDisturb {

/**
 * Capability Agent to handle Alexa.DoNotDisturb AVS Interface.
 *
 * When DoNotDisturb mode is on AVS blocks some interactions from reaching the device so the customer won't be
 * disturbed. Locally SDK provides only the way to get immediate state of the DND mode, track its changes coming from
 * any source and update it making sure that it will be synchronized with AVS. No other customer experience is affected.
 */
class DoNotDisturbCapabilityAgent
        : public std::enable_shared_from_this<DoNotDisturbCapabilityAgent>
        , public avsCommon::avs::CapabilityAgent
        , public avsCommon::sdkInterfaces::CapabilityConfigurationInterface
        , public avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
        , public avsCommon::utils::RequiresShutdown
        , public registrationManager::CustomerDataHandler
        , public settings::SettingEventSenderInterface {
public:
    /**
     * Destructor.
     */
    ~DoNotDisturbCapabilityAgent() override = default;

    /**
     * Factory method to create a capability agent instance.
     *
     * @param customerDataManager Component to register Capability Agent as customer data container (equalizer state).
     * @param exceptionEncounteredSender Interface to report exceptions to AVS.
     * @param messageSender Interface to send events to AVS.
     * @param settingsManager A settingsManager object that manages do not disturb setting.
     * @param settingsStorage The storage interface that will be used to store device settings.
     * @return A new instance of @c DoNotDisturbCapabilityAgent on success, @c nullptr otherwise.
     */
    static std::shared_ptr<DoNotDisturbCapabilityAgent> create(
        std::shared_ptr<registrationManager::CustomerDataManager> customerDataManager,
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender,
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender,
        std::shared_ptr<settings::DeviceSettingsManager> settingsManager,
        std::shared_ptr<settings::storage::DeviceSettingStorageInterface> settingsStorage);

    /// @name CapabilityAgent Functions
    /// @{
    avsCommon::avs::DirectiveHandlerConfiguration getConfiguration() const override;
    void handleDirectiveImmediately(std::shared_ptr<avsCommon::avs::AVSDirective> directive) override;
    void preHandleDirective(std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info) override;
    void handleDirective(std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info) override;
    void cancelDirective(std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info) override;
    /// @}

    /// @name CapabilityConfigurationInterface Functions
    /// @{
    std::unordered_set<std::shared_ptr<avsCommon::avs::CapabilityConfiguration>> getCapabilityConfigurations() override;
    /// @}

    // @name RequiresShutdown Functions
    /// @{
    void doShutdown() override;
    /// @}

    /// @name CustomerDataHandler Functions
    /// @{
    void clearData() override;
    /// @}

    /// @name SettingEventSenderInterface Functions
    /// @{
    std::shared_future<bool> sendChangedEvent(const std::string& value) override;
    std::shared_future<bool> sendReportEvent(const std::string& value) override;
    /// @}

    /// @name ConnectionStatusObserverInterface Functions
    /// @{
    void onConnectionStatusChanged(const Status status, const ChangedReason reason) override;
    /// @}

private:
    /**
     * Constructor.
     *
     * @param customerDataManager Component to register Capability Agent as customer data container (equalizer state).
     * @param exceptionEncounteredSender Interface to report exceptions to AVS.
     * @param messageSender Interface to send events to AVS.
     * @param settingsManager A settingsManager object that manages do not disturb setting.
     */
    DoNotDisturbCapabilityAgent(
        std::shared_ptr<registrationManager::CustomerDataManager> customerDataManager,
        std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> exceptionEncounteredSender,
        std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> messageSender,
        std::shared_ptr<settings::DeviceSettingsManager> settingsManager);

    /**
     * Method to initialize the new instance of the capability agent.
     *
     * @param settingsStorage The storage interface that will be used to store device settings.
     * @return True on succes, false otherwise.
     */
    bool initialize(std::shared_ptr<settings::storage::DeviceSettingStorageInterface> settingsStorage);

    /**
     * Sends a DND event to the AVS.
     *
     * @param eventName Name of the event to send.
     * @param value Valid JSON string representation of the boolean value. I.e. either "true" or "false".
     * @return Future to track the completion status of the message.
     */
    std::shared_future<avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status> sendDNDEvent(
        const std::string& eventName,
        const std::string& value);

    /**
     * Prepares AVS Interface DCF configuration and keeps it internally.
     */
    void generateCapabilityConfiguration();

    /**
     * Handles the Alexa.DoNotDisturb.SetDoNotDisturb AVS Directive.
     *
     * @param info Directive details.
     * @param JSON document containing the parsed directive payload.
     * @return true if operation succeeds and could be reported as such to AVS, false if an error occurred. False
     * implies that exception has been reported to AVS and directive is already processed.
     */
    bool handleSetDoNotDisturbDirective(
        std::shared_ptr<avsCommon::avs::CapabilityAgent::DirectiveInfo> info,
        rapidjson::Document& document);

    /// Set of capability configurations that will get published using DCF
    std::unordered_set<std::shared_ptr<avsCommon::avs::CapabilityConfiguration>> m_capabilityConfigurations;

    /// The @c MessageSenderInterface used to send event messages.
    std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> m_messageSender;

    /// The device settings manager object.
    std::shared_ptr<settings::DeviceSettingsManager> m_settingsManager;

    /// The do not disturb mode setting.
    std::shared_ptr<settings::Setting<bool>> m_dndModeSetting;

    /// The storage interface that will be used to store device settings.
    std::shared_ptr<settings::storage::DeviceSettingStorageInterface> m_settingsStorage;

    /**
     * Flag indicating latest reported connection status. True if SDK is connected to the AVS and ready,
     * false otherwise.
     */
    bool m_isConnected;

    /// Mutex to synchronize operations related to connection state.
    std::mutex m_connectedStateMutex;

    /// Flag indicating whether there were changes made to the DND status while being offline.
    std::atomic_bool m_hasOfflineChanges;

    /// An executor used for serializing requests on agent's own thread of execution.
    avsCommon::utils::threading::Executor m_executor;
};

}  // namespace doNotDisturb
}  // namespace capabilityAgents
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPABILITYAGENTS_DONOTDISTURB_INCLUDE_DONOTDISTURBCA_DONOTDISTURBCAPABILITYAGENT_H_