NetworkManagerImplementation.h

/**
* If not stated otherwise in this file or this component's LICENSE
* file the following copyright and licenses apply:
*
* Copyright 2022 RDK Management
*
* 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.
**/

#pragma once


#include "Module.h"
#include <iostream>
#include <net/if.h>
#include <arpa/inet.h>
#include <linux/rtnetlink.h>

using namespace std;

//#include <interfaces/INetworkManager.h>
#include "INetworkManager.h"
#include "NetworkManagerLogger.h"
#include "WiFiSignalStrengthMonitor.h"
#include "NetworkManagerConnectivity.h"
#include "NetworkManagerStunClient.h"

#define LOG_ENTRY_FUNCTION() { NMLOG_TRACE("Entering=%s", __FUNCTION__ ); }

namespace WPEFramework
{
    namespace Plugin
    {
        class NetworkManagerImplementation : public Exchange::INetworkManager
        {
        enum NetworkEvents {
                NETMGR_PING,
                NETMGR_TRACE,
            };

        class Config : public Core::JSON::Container {
        private:
            Config(const Config&);
            Config& operator=(const Config&);

        public:
            class ConnectivityConf : public Core::JSON::Container {
            public:
                ConnectivityConf& operator=(const ConnectivityConf&) = delete;

                ConnectivityConf()
                    : Core::JSON::Container()
                    , endpoint_1(_T("http://clients3.google.com/generate_204"))
                    , endpoint_2(_T(""))
                    , endpoint_3(_T(""))
                    , endpoint_4(_T(""))
                    , endpoint_5(_T(""))
                    , ConnectivityCheckInterval(6)
                {
                    Add(_T("endpoint_1"), &endpoint_1);
                    Add(_T("endpoint_2"), &endpoint_2);
                    Add(_T("endpoint_3"), &endpoint_3);
                    Add(_T("endpoint_4"), &endpoint_4);
                    Add(_T("endpoint_5"), &endpoint_5);
                    Add(_T("interval"), &ConnectivityCheckInterval);
                }
                ~ConnectivityConf() override = default;

            public:
                /* connectivity configuration */
                Core::JSON::String endpoint_1;
                Core::JSON::String endpoint_2;
                Core::JSON::String endpoint_3;
                Core::JSON::String endpoint_4;
                Core::JSON::String endpoint_5;
                Core::JSON::DecUInt32 ConnectivityCheckInterval;
            };

            class Stun : public Core::JSON::Container {
                public:
                    Stun& operator=(const Stun&) = delete;

                    Stun()
                        : Core::JSON::Container()
                        , stunEndpoint(_T("stun.l.google.com"))
                        , port(19302)
                        , interval(30)
                    {
                        Add(_T("endpoint"), &stunEndpoint);
                        Add(_T("port"), &port);
                        Add(_T("interval"), &interval);
                    }
                    ~Stun() override = default;

                public:
                    /* stun configuration */
                    Core::JSON::String stunEndpoint;
                    Core::JSON::DecUInt32 port;
                    Core::JSON::DecUInt32 interval;
            };

        public:
            Config()
                : Core::JSON::Container()
                {
                    Add(_T("connectivity"), &connectivityConf);
                    Add(_T("stun"), &stun);
                    Add(_T("loglevel"), &loglevel);
                }
            ~Config() override = default;

        public:
            ConnectivityConf connectivityConf;
            Stun stun;
            Core::JSON::DecUInt32 loglevel;
        };

        public:
            NetworkManagerImplementation();
            ~NetworkManagerImplementation() override;

            // Do not allow copy/move constructors
            NetworkManagerImplementation(const NetworkManagerImplementation &) = delete;
            NetworkManagerImplementation &operator=(const NetworkManagerImplementation &) = delete;

            BEGIN_INTERFACE_MAP(NetworkManagerImplementation)
            INTERFACE_ENTRY(Exchange::INetworkManager)
            END_INTERFACE_MAP

            // Handle Notification registration/removal
            uint32_t Register(INetworkManager::INotification *notification) override;
            uint32_t Unregister(INetworkManager::INotification *notification) override;

        public:
            // Below Control APIs will work with RDK or GNome NW.
            /* @brief Get all the Available Interfaces */
            uint32_t GetAvailableInterfaces (IInterfaceDetailsIterator*& interfaces/* @out */) override;

            /* @brief Get the active Interface used for external world communication */
            uint32_t GetPrimaryInterface (string& interface /* @out */) override;
            /* @brief Set the active Interface used for external world communication */
            uint32_t SetPrimaryInterface (const string& interface/* @in */) override;

            /* @brief Enable/Disable the given interface */
            uint32_t SetInterfaceState(const string& interface/* @in */, const bool& isEnabled/* @in */) override;
            /* @brief Get the state of given interface */
            uint32_t GetInterfaceState(const string& interface/* @in */, bool& isEnabled/* @out */) override;

            /* @brief Get IP Address Of the Interface */
            uint32_t GetIPSettings(const string& interface /* @in */, const string &ipversion /* @in */, IPAddressInfo& result /* @out */) override;
            /* @brief Set IP Address Of the Interface */
            uint32_t SetIPSettings(const string& interface /* @in */, const string &ipversion /* @in */, const IPAddressInfo& address /* @in */) override;

            // WiFi Specific Methods
            /* @brief Initiate a WIFI Scan; This is Async method and returns the scan results as Event */
            uint32_t StartWiFiScan(const WiFiFrequency frequency /* @in */);
            uint32_t StopWiFiScan(void) override;

            uint32_t GetKnownSSIDs(IStringIterator*& ssids /* @out */) override;
            uint32_t AddToKnownSSIDs(const WiFiConnectTo& ssid /* @in */) override;
            uint32_t RemoveKnownSSID(const string& ssid /* @in */) override;

            uint32_t WiFiConnect(const WiFiConnectTo& ssid /* @in */) override;
            uint32_t WiFiDisconnect(void) override;
            uint32_t GetConnectedSSID(WiFiSSIDInfo&  ssidInfo /* @out */) override;

            uint32_t StartWPS(const WiFiWPS& method /* @in */, const string& wps_pin /* @in */) override;
            uint32_t StopWPS(void) override;
            uint32_t GetWifiState(WiFiState &state) override;
            uint32_t GetWiFiSignalStrength(string& ssid /* @out */, string& signalStrength /* @out */, WiFiSignalQuality& quality /* @out */) override;

            uint32_t SetStunEndpoint (string const endPoint /* @in */, const uint32_t port /* @in */, const uint32_t bindTimeout /* @in */, const uint32_t cacheTimeout /* @in */) override;
            uint32_t GetStunEndpoint (string &endPoint /* @out */, uint32_t& port /* @out */, uint32_t& bindTimeout /* @out */, uint32_t& cacheTimeout /* @out */) const override;

            /* @brief Get ConnectivityTest Endpoints */
            uint32_t GetConnectivityTestEndpoints(IStringIterator*& endPoints/* @out */) const override;
            /* @brief Set ConnectivityTest Endpoints */
            uint32_t SetConnectivityTestEndpoints(IStringIterator* const endPoints /* @in */) override;

            /* @brief Get Internet Connectivty Status */ 
            uint32_t IsConnectedToInternet(const string &ipversion /* @in */, InternetStatus &result /* @out */) override;
            /* @brief Get Authentication URL if the device is behind Captive Portal */ 
            uint32_t GetCaptivePortalURI(string &endPoints/* @out */) const override;

            /* @brief Start The Internet Connectivity Monitoring */ 
            uint32_t StartConnectivityMonitoring(const uint32_t interval/* @in */) override;
            /* @brief Stop The Internet Connectivity Monitoring */ 
            uint32_t StopConnectivityMonitoring(void) const override;

            /* @brief Get the Public IP used for external world communication */
            uint32_t GetPublicIP (const string &ipversion /* @in */,  string& ipAddress /* @out */) override;

            /* @brief Request for ping and get the response in as event. The GUID used in the request will be returned in the event. */
            uint32_t Ping (const string ipversion /* @in */,  const string endpoint /* @in */, const uint32_t noOfRequest /* @in */, const uint16_t timeOutInSeconds /* @in */, const string guid /* @in */, string& response /* @out */) override;

            /* @brief Request for trace get the response in as event. The GUID used in the request will be returned in the event. */
            uint32_t Trace (const string ipversion /* @in */,  const string endpoint /* @in */, const uint32_t noOfRequest /* @in */, const string guid /* @in */, string& response /* @out */) override;

            uint32_t GetSupportedSecurityModes(ISecurityModeIterator*& securityModes /* @out */) const override;

            /* @brief Set the network manager plugin log level */
            uint32_t SetLogLevel(const NMLogging& logLevel /* @in */) override;

            /* @brief configure network manager plugin */
            uint32_t Configure(const string& configLine /* @in */, NMLogging& logLevel /* @out */) override;

            /* Events */
            void ReportInterfaceStateChangedEvent(INetworkManager::InterfaceState state, string interface);
            void ReportIPAddressChangedEvent(const string& interface, bool isAcquired, bool isIPv6, const string& ipAddress);
            void ReportActiveInterfaceChangedEvent(const string prevActiveInterface, const string currentActiveinterface);
            void ReportInternetStatusChangedEvent(const InternetStatus oldState, const InternetStatus newstate);
            void ReportAvailableSSIDsEvent(const string jsonOfWiFiScanResults);
            void ReportWiFiStateChangedEvent(const INetworkManager::WiFiState state);
            void ReportWiFiSignalStrengthChangedEvent(const string ssid , const string signalLevel , const WiFiSignalQuality signalQuality);

        private:
            void platform_init();
            void retryIarmEventRegistration();
            void threadEventRegistration();
            void executeExternally(NetworkEvents event, const string commandToExecute, string& response);

        private:
            std::list<Exchange::INetworkManager::INotification *> _notificationCallbacks;
            Core::CriticalSection _notificationLock;
            string m_defaultInterface;
            string m_publicIP;
            stun::client stunClient;
            string m_stunEndPoint;
            uint16_t m_stunPort;
            uint16_t m_stunBindTimeout;
            uint16_t m_stunCacheTimeout;
            std::thread m_registrationThread;
        public:
            WiFiSignalStrengthMonitor m_wifiSignalMonitor;
            mutable ConnectivityMonitor connectivityMonitor;
        };
    }
}