Merge pull request rdkcentral#5856 from yuvaramachandran-gurusamy/sprint/24Q4/RDK-53913_XCast_OutOfProcess

apatel859 · web-flow · commit b2e98f497e12 · 2024-11-07T14:37:04.000-05:00
RDK-53913: Convert XCast plugin as OutOfProcess with fix for crash and event subscription failure
diff --git a/XCast/XCast.cpp b/XCast/XCast.cpp
@@ -316,6 +316,12 @@ const string XCast::Initialize(PluginHost::IShell *service)
             ASSERT(_connectionId != 0);
         #endif
 
+        auto configConnection = _xcast->QueryInterface<Exchange::IConfiguration>();
+        if (configConnection != nullptr) {
+            configConnection->Configure(_service);
+            configConnection->Release();
+        }
+
         PluginHost::IStateControl* stateControl(_xcast->QueryInterface<PluginHost::IStateControl>());
 
         if (stateControl == nullptr) {
diff --git a/XCast/XCast.h b/XCast/XCast.h
@@ -33,6 +33,7 @@
 
 #include "Module.h"
 #include <interfaces/IXCast.h>
+#include <interfaces/IConfiguration.h>
 #include "tracing/Logging.h"
 #include "tptimer.h"
 #include "libIBus.h"
diff --git a/XCast/XCastImplementation.cpp b/XCast/XCastImplementation.cpp
@@ -30,9 +30,8 @@
 #endif
 
 #define SERVER_DETAILS "127.0.0.1:9998"
-#define NETWORK_CALLSIGN "org.rdk.Network"
-#define NETWORK_CALLSIGN_VER NETWORK_CALLSIGN ".1"
-#define THUNDER_RPC_TIMEOUT 2000
+#define NETWORK_CALLSIGN_VER "org.rdk.Network.1"
+#define THUNDER_RPC_TIMEOUT 5000
 #define MAX_SECURITY_TOKEN_SIZE 1024
 
 #define API_VERSION_NUMBER_MAJOR 1
@@ -65,6 +64,11 @@ namespace Plugin {
     XCastImplementation::~XCastImplementation()
     {
         Deinitialize();
+        if (nullptr != mShell)
+        {
+            mShell->Release();
+            mShell = nullptr;
+        }
     }
 
     void XCastImplementation::Register(Exchange::IXCast::INotification* sink)
@@ -123,6 +127,15 @@ namespace Plugin {
         }
     }
 
+    uint32_t XCastImplementation::Configure(PluginHost::IShell* service)
+    {
+        LOGINFO("Configuring XCast");
+        ASSERT(service != nullptr);
+        mShell = service;
+        mShell->AddRef();
+        return Core::ERROR_NONE;
+    }
+
     uint32_t XCastImplementation::enableCastService(string friendlyname,bool enableService) const
     {
         LOGINFO("XcastService::enableCastService: ARGS = %s : %d", friendlyname.c_str(), enableService);
@@ -395,68 +408,59 @@ namespace Plugin {
 
     std::string XCastImplementation::getSecurityToken()
     {
-        std::string token = "token=";
-        int tokenLength = 0;
-        unsigned char buffer[MAX_SECURITY_TOKEN_SIZE] = {0};
-        static std::string endpoint;
-
-        if(endpoint.empty()) {
-            Core::SystemInfo::GetEnvironment(_T("THUNDER_ACCESS"), endpoint);
-            LOGINFO("Thunder RPC Endpoint read from env - %s", endpoint.c_str());
-        }
-
-        if(endpoint.empty()) {
-            Core::File file("/etc/WPEFramework/config.json");
-            if(file.Open(true)) {
-                JsonObject config;
-                if(config.IElement::FromFile(file)) {
-                    Core::JSON::String port = config.Get("port");
-                    Core::JSON::String binding = config.Get("binding");
-                    if(!binding.Value().empty() && !port.Value().empty())
-                        endpoint = binding.Value() + ":" + port.Value();
-                }
-                file.Close();
-            }
-
-            if(endpoint.empty()) 
-                endpoint = _T("127.0.0.1:9998");
-
-            LOGINFO("Thunder RPC Endpoint read from config file - %s", endpoint.c_str());
-            Core::SystemInfo::SetEnvironment(_T("THUNDER_ACCESS"), endpoint);
-        }
-            
-        string payload = "http://localhost";
-        if(payload.empty()) {
-            tokenLength = GetSecurityToken(sizeof(buffer), buffer);
-        } else {
-            int buffLength = std::min(sizeof(buffer), payload.length());
-            ::memcpy(buffer, payload.c_str(), buffLength);
-            tokenLength = GetToken(sizeof(buffer), buffLength, buffer);
+        if (nullptr == mShell)
+        {
+            return (std::string(""));
         }
 
-        if(tokenLength > 0) {
-            token.append((char*)buffer);
-        } else {
-            token.clear();
+        std::string token;
+        auto security = mShell->QueryInterfaceByCallsign<PluginHost::IAuthenticate>("SecurityAgent");
+        if (nullptr != security)
+        {
+            std::string payload = "http://localhost";
+            if (security->CreateToken(static_cast<uint16_t>(payload.length()),
+                                        reinterpret_cast<const uint8_t *>(payload.c_str()),
+                                        token) == Core::ERROR_NONE)
+            {
+                LOGINFO("got security token - %s", token.empty() ? "" : token.c_str());
+            }
+            else
+            {
+                LOGERR("failed to get security token");
+            }
+            security->Release();
+        }
+        else
+        {
+            LOGERR("No security agent\n");
         }
 
-        LOGINFO("Thunder token - %s", token.empty() ? "" : token.c_str());
-        return token;
+        std::string query = "token=" + token;
+        Core::SystemInfo::SetEnvironment(_T("THUNDER_ACCESS"), (_T(SERVER_DETAILS)));
+        return query;
     }
 
     // Thunder plugins communication
-	void XCastImplementation::getThunderPlugins()
+    void XCastImplementation::getThunderPlugins()
     {
         string token = getSecurityToken();
 
         if (nullptr == m_ControllerObj)
         {
-            m_ControllerObj = new WPEFramework::JSONRPC::LinkType<Core::JSON::IElement>("", "", false, token);
+            if(token.empty())
+            {
+                m_ControllerObj = new WPEFramework::JSONRPC::LinkType<Core::JSON::IElement>("", "", false);
+            }
+            else
+            {
+                m_ControllerObj = new WPEFramework::JSONRPC::LinkType<Core::JSON::IElement>("","", false, token);
+            }
 
             if (nullptr != m_ControllerObj)
             {
+                LOGINFO("JSONRPC: Controller: initialization ok");
                 bool isSubscribed = false;
-                auto ev_ret = m_ControllerObj->Subscribe<JsonObject>(1000, _T("statechange"),&XCastImplementation::eventHandler_pluginState,this);
+                auto ev_ret = m_ControllerObj->Subscribe<JsonObject>(THUNDER_RPC_TIMEOUT, _T("statechange"),&XCastImplementation::eventHandler_pluginState,this);
                 if (ev_ret == Core::ERROR_NONE)
                 {
                     LOGINFO("Controller - statechange event subscribed");
diff --git a/XCast/XCastImplementation.h b/XCast/XCastImplementation.h
@@ -22,6 +22,7 @@
 #include "Module.h"
 #include <interfaces/Ids.h>
 #include <interfaces/IXCast.h>
+#include <interfaces/IConfiguration.h>
 #include "tracing/Logging.h"
 #include "XCastManager.h"
 #include "XCastNotifier.h"
@@ -102,7 +103,6 @@ namespace Plugin {
         virtual uint32_t Request(const command state) override { return Core::ERROR_GENERAL; }
         virtual void Register(IStateControl::INotification* notification) override {}
         virtual void Unregister(IStateControl::INotification* notification) override {}
-        virtual uint32_t Configure(PluginHost::IShell* service) override { return Core::ERROR_NONE; }
 
         virtual uint32_t Initialize(bool networkStandbyMode) override;
         virtual void Deinitialize(void) override;
@@ -137,6 +137,7 @@ namespace Plugin {
         std::list<Exchange::IXCast::INotification*> _notificationClients;
         static XCastImplementation* _instance;
         bool m_networkStandbyMode{false};
+        PluginHost::IShell* mShell;
         
         void dispatchEvent(Event,string callsign, const JsonObject &params);
         void Dispatch(Event event,string callsign, const JsonObject params);
@@ -161,6 +162,9 @@ namespace Plugin {
         bool getDefaultNameAndIPAddress(std::string& interface, std::string& ipaddress);
         void updateNWConnectivityStatus(std::string nwInterface, bool nwConnected, std::string ipaddress = "");
 
+        // IConfiguration interface
+        uint32_t Configure(PluginHost::IShell* shell);
+
     public:
         XCastImplementation();
         virtual ~XCastImplementation();
diff --git a/XCast/XCastManager.cpp b/XCast/XCastManager.cpp
@@ -289,6 +289,7 @@ bool XCastManager::initialize(const std::string& gdial_interface_name, bool netw
 
 void XCastManager::deinitialize()
 {
+    LOGINFO("Destroying gdialService instance");
     lock_guard<recursive_mutex> lock(m_mutexSync);
     if (nullptr != gdialCastObj)
     {
@@ -422,7 +423,7 @@ bool XCastManager::envGetValue(const char *key, std::string &value)
 int XCastManager::applicationStateChanged( string app, string state, string id, string error)
 {
     int status = 0;
-    LOGINFO("XcastService::ApplicationStateChanged  ARGS = %s : %s : %s : %s ", app.c_str(), id.c_str() , state.c_str() , error.c_str());
+    LOGINFO("ARGS = %s : %s : %s : %s ", app.c_str(), id.c_str() , state.c_str() , error.c_str());
     lock_guard<recursive_mutex> lock(m_mutexSync);
     if (gdialCastObj != NULL)
     {
@@ -436,7 +437,7 @@ int XCastManager::applicationStateChanged( string app, string state, string id,
 
 void XCastManager::enableCastService(string friendlyname,bool enableService)
 {
-    LOGINFO("XcastService::enableCastService ARGS = %s : %d ", friendlyname.c_str(), enableService);
+    LOGINFO("ARGS = %s : %d ", friendlyname.c_str(), enableService);
     lock_guard<recursive_mutex> lock(m_mutexSync);
     if(gdialCastObj != NULL)
     {
@@ -450,12 +451,12 @@ void XCastManager::enableCastService(string friendlyname,bool enableService)
 
 void XCastManager::updateFriendlyName(string friendlyname)
 {
-    LOGINFO("XcastService::updateFriendlyName ARGS = %s ", friendlyname.c_str());
+    LOGINFO("ARGS = %s ", friendlyname.c_str());
     lock_guard<recursive_mutex> lock(m_mutexSync);
     if(gdialCastObj != NULL)
     {
         gdialCastObj->FriendlyNameChanged( friendlyname);
-        LOGINFO("XcastService send onFriendlyNameChanged");
+        LOGINFO("XcastService send FriendlyNameChanged");
     }
     else
         LOGINFO(" gdialCastObj is NULL ");
@@ -507,11 +508,9 @@ void XCastManager::registerApplications(std::vector<DynamicAppConfig*>& appConfi
         LOGINFO(" gdialCastObj is NULL ");
         if (nullptr != appReqList)
         {
-            for (RegisterAppEntry* appEntry : appReqList->getValues())
-            {
-                delete appEntry;
-            }
+            LOGINFO("[%p] Freeing appConfigList",appReqList);
             delete appReqList;
+            appReqList = nullptr;
         }
     }
 }
@@ -563,4 +562,4 @@ bool XCastManager::IsAppEnabled(char* strAppName)
 #endif //RFC_ENABLED
 
     return ret;
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -289,6 +289,7 @@ bool XCastManager::initialize(const std::string& gdial_interface_name, bool netw`
`289`	`289`
`290`	`290`	`void XCastManager::deinitialize()`
`291`	`291`	`{`
	`292`	`+ LOGINFO("Destroying gdialService instance");`
`292`	`293`	`lock_guard<recursive_mutex> lock(m_mutexSync);`
`293`	`294`	`if (nullptr != gdialCastObj)`
`294`	`295`	`{`
`@@ -422,7 +423,7 @@ bool XCastManager::envGetValue(const char *key, std::string &value)`
`422`	`423`	`int XCastManager::applicationStateChanged( string app, string state, string id, string error)`
`423`	`424`	`{`
`424`	`425`	`int status = 0;`
`425`		`- LOGINFO("XcastService::ApplicationStateChanged ARGS = %s : %s : %s : %s ", app.c_str(), id.c_str() , state.c_str() , error.c_str());`
	`426`	`+ LOGINFO("ARGS = %s : %s : %s : %s ", app.c_str(), id.c_str() , state.c_str() , error.c_str());`
`426`	`427`	`lock_guard<recursive_mutex> lock(m_mutexSync);`
`427`	`428`	`if (gdialCastObj != NULL)`
`428`	`429`	`{`
`@@ -436,7 +437,7 @@ int XCastManager::applicationStateChanged( string app, string state, string id,`
`436`	`437`
`437`	`438`	`void XCastManager::enableCastService(string friendlyname,bool enableService)`
`438`	`439`	`{`
`439`		`- LOGINFO("XcastService::enableCastService ARGS = %s : %d ", friendlyname.c_str(), enableService);`
	`440`	`+ LOGINFO("ARGS = %s : %d ", friendlyname.c_str(), enableService);`
`440`	`441`	`lock_guard<recursive_mutex> lock(m_mutexSync);`
`441`	`442`	`if(gdialCastObj != NULL)`
`442`	`443`	`{`
`@@ -450,12 +451,12 @@ void XCastManager::enableCastService(string friendlyname,bool enableService)`
`450`	`451`
`451`	`452`	`void XCastManager::updateFriendlyName(string friendlyname)`
`452`	`453`	`{`
`453`		`- LOGINFO("XcastService::updateFriendlyName ARGS = %s ", friendlyname.c_str());`
	`454`	`+ LOGINFO("ARGS = %s ", friendlyname.c_str());`
`454`	`455`	`lock_guard<recursive_mutex> lock(m_mutexSync);`
`455`	`456`	`if(gdialCastObj != NULL)`
`456`	`457`	`{`
`457`	`458`	`gdialCastObj->FriendlyNameChanged( friendlyname);`
`458`		`- LOGINFO("XcastService send onFriendlyNameChanged");`
	`459`	`+ LOGINFO("XcastService send FriendlyNameChanged");`
`459`	`460`	`}`
`460`	`461`	`else`
`461`	`462`	`LOGINFO(" gdialCastObj is NULL ");`
`@@ -507,11 +508,9 @@ void XCastManager::registerApplications(std::vector<DynamicAppConfig*>& appConfi`
`507`	`508`	`LOGINFO(" gdialCastObj is NULL ");`
`508`	`509`	`if (nullptr != appReqList)`
`509`	`510`	`{`
`510`		`- for (RegisterAppEntry* appEntry : appReqList->getValues())`
`511`		`- {`
`512`		`- delete appEntry;`
`513`		`- }`
	`511`	`+ LOGINFO("[%p] Freeing appConfigList",appReqList);`
`514`	`512`	`delete appReqList;`
	`513`	`+ appReqList = nullptr;`
`515`	`514`	`}`
`516`	`515`	`}`
`517`	`516`	`}`
`@@ -563,4 +562,4 @@ bool XCastManager::IsAppEnabled(char* strAppName)`
`563`	`562`	`#endif //RFC_ENABLED`
`564`	`563`
`565`	`564`	`return ret;`
`566`		`-}`
	`565`	`+}`