From ed834a643e3843c0f805ea33363c9f2889d2bab3 Mon Sep 17 00:00:00 2001 From: Raquel Medina Date: Mon, 9 Dec 2019 02:25:25 +0100 Subject: Add CBL processing CBL: Code Based Linking in the case of Alexa voice agent, or more generally Code Based Logging. It provides a url and code which allows the user to complete the authorization process and start using the authorized voice services. - add subscribeToLoginEvents verb - add cbl events handling - include new verb in vshl-core-api.json Bug-AGL: SPEC-2981 Signed-off-by: Raquel Medina Change-Id: If342d45638125682621cba707eac1d4ff5ad244c --- conf.d/project/etc/vshl-core-api.json | 3 + src/plugins/VshlCoreApi.cpp | 101 ++++++++++++++++++++- src/plugins/VshlCoreApi.h | 3 + src/plugins/core/VRRequestProcessor.h | 6 ++ src/plugins/core/VRRequestProcessorImpl.cpp | 14 +++ src/plugins/core/include/VRRequest.h | 6 ++ .../core/include/VRRequestProcessorDelegate.h | 4 + src/plugins/core/src/VRRequestImpl.cpp | 16 ++++ .../core/src/VRRequestProcessorDelegateImpl.cpp | 26 ++++++ src/plugins/voiceagents/VoiceAgentEventNames.h | 5 +- 10 files changed, 179 insertions(+), 5 deletions(-) diff --git a/conf.d/project/etc/vshl-core-api.json b/conf.d/project/etc/vshl-core-api.json index 44d578a..9121353 100644 --- a/conf.d/project/etc/vshl-core-api.json +++ b/conf.d/project/etc/vshl-core-api.json @@ -38,5 +38,8 @@ "uid": "setDefaultVoiceAgent", "privileges": "urn:AGL:permission:vshl-core:voiceagents:public", "action": "plugin://vshl-core#setDefaultVoiceAgent" + }, { + "uid": "subscribeToLoginEvents", + "action": "plugin://vshl-core#subscribeToLoginEvents" }] } diff --git a/src/plugins/VshlCoreApi.cpp b/src/plugins/VshlCoreApi.cpp index 4c32391..abe4577 100644 --- a/src/plugins/VshlCoreApi.cpp +++ b/src/plugins/VshlCoreApi.cpp @@ -48,6 +48,7 @@ static std::string VA_JSON_ATTR_DESCRIPTION = "description"; static std::string VA_JSON_ATTR_VENDOR = "vendor"; static std::string STARTLISTENING_JSON_ATTR_REQUEST = "request_id"; +static std::string SUBSCRIBE2LOGINEVENTS_JSON_ATTR_REQUEST = "request_id"; static std::string EVENTS_JSON_ATTR_VA_ID = "va_id"; static std::string EVENTS_JSON_ATTR_EVENTS = "events"; @@ -158,6 +159,42 @@ CTLP_CAPI(onDialogStateEvent, source, argsJ, eventJ) { return 0; } +CTLP_CAPI(onLoginPairReceivedEvent, source, argsJ, eventJ) { + if (sEventRouter == nullptr) { + return -1; + } + + string eventName = vshlcore::voiceagents::VSHL_EVENT_LOGINPAIR_RECEIVED_EVENT; + json eventJson = json::parse(json_object_to_json_string(eventJ)); + if (eventJson.find(EVENTS_JSON_ATTR_VA_ID) == eventJson.end()) { + sLogger->log(Level::ERROR, TAG, "onLoginPairReceivedEvent: No voiceagent id found."); + return -1; + } + std::string voiceAgentId(eventJson[EVENTS_JSON_ATTR_VA_ID].get()); + + sEventRouter->handleIncomingEvent(eventName, voiceAgentId, json_object_to_json_string(eventJ)); + + return 0; +} + +CTLP_CAPI(onLoginPairExpiredEvent, source, argsJ, eventJ) { + if (sEventRouter == nullptr) { + return -1; + } + + string eventName = vshlcore::voiceagents::VSHL_EVENT_LOGINPAIR_EXPIRED_EVENT; + json eventJson = json::parse(json_object_to_json_string(eventJ)); + if (eventJson.find(EVENTS_JSON_ATTR_VA_ID) == eventJson.end()) { + sLogger->log(Level::ERROR, TAG, "onLoginPairExpiredEvent: No voiceagent id found."); + return -1; + } + std::string voiceAgentId(eventJson[EVENTS_JSON_ATTR_VA_ID].get()); + + sEventRouter->handleIncomingEvent(eventName, voiceAgentId, json_object_to_json_string(eventJ)); + + return 0; +} + // Helper function to add events for voice agent to controller // configuration. It relies on the controller configuration being // available via the userdata of the API pointer. @@ -208,6 +245,22 @@ static int AddVoiceAgentEvents(std::string &agentApi) { json_object_object_add(eventJ, "action", actionJ); json_object_array_add(eventsJ, eventJ); + eventJ = json_object_new_object(); + uid = agentApi + "/voice_cbl_codepair_received_event"; + uidJ = json_object_new_string(uid.c_str()); + json_object_object_add(eventJ, "uid", uidJ); + actionJ = json_object_new_string("plugin://vshl-core#onLoginPairReceivedEvent"); + json_object_object_add(eventJ, "action", actionJ); + json_object_array_add(eventsJ, eventJ); + + eventJ = json_object_new_object(); + uid = agentApi + "/voice_cbl_codepair_expired_event"; + uidJ = json_object_new_string(uid.c_str()); + json_object_object_add(eventJ, "uid", uidJ); + actionJ = json_object_new_string("plugin://vshl-core#onLoginPairExpiredEvent"); + json_object_object_add(eventJ, "action", actionJ); + json_object_array_add(eventsJ, eventJ); + // Call into controller to add event actions // NOTE: AFAICT the JSON objects end up reused by the controller data // structures, so eventsJ should not be freed with a put after @@ -299,7 +352,7 @@ CTLP_CAPI(loadVoiceAgentsConfig, source, argsJ, eventJ) { return -1; } - string defaultVoiceAgent; + std::string defaultVoiceAgent; if (argsJ != nullptr) { // Parse any agent configs from controller arguments @@ -363,7 +416,7 @@ CTLP_CAPI(startListening, source, argsJ, eventJ) { } int result = 0; - string requestId = sVRRequestProcessor->startListening(); + std::string requestId = sVRRequestProcessor->startListening(); if (!requestId.empty()) { json responseJson; @@ -384,7 +437,7 @@ CTLP_CAPI(enumerateVoiceAgents, source, argsJ, eventJ) { if (sVoiceAgentsDataManager == nullptr) { return -1; } - + auto agents = sVoiceAgentsDataManager->getAllVoiceAgents(); std::string defaultAgentId(sVoiceAgentsDataManager->getDefaultVoiceAgent()); @@ -442,7 +495,7 @@ CTLP_CAPI(subscribe, source, argsJ, eventJ) { sLogger->log(Level::ERROR, TAG, "subscribe: No events array found in subscribe json"); return -1; } - list events(subscribeJson[EVENTS_JSON_ATTR_EVENTS].get>()); + std::list events(subscribeJson[EVENTS_JSON_ATTR_EVENTS].get>()); // Subscribe this client for the listed events. auto request = vshlcore::afb::AFBRequestImpl::create(source->request); @@ -483,3 +536,43 @@ CTLP_CAPI(setDefaultVoiceAgent, source, argsJ, eventJ) { afb_req_success(source->request, NULL, NULL); return 0; } + +CTLP_CAPI(subscribeToLoginEvents, source, argsJ, eventJ) { + if (sVoiceAgentsDataManager == nullptr) { + return -1; + } + + if (eventJ == nullptr) { + sLogger->log(Level::WARNING, TAG, "subscribeToLoginEvents: No arguments supplied."); + return -1; + } + + if (sVRRequestProcessor == nullptr) { + return -1; + } + + json subscribeJson = json::parse(json_object_to_json_string(eventJ)); + if (subscribeJson.find(EVENTS_JSON_ATTR_VA_ID) == subscribeJson.end()) { + sLogger->log(Level::ERROR, TAG, "subscribeToLoginEvents: No voiceagent id found in subscribe json"); + return -1; + } + std::string voiceAgentId(subscribeJson[EVENTS_JSON_ATTR_VA_ID].get()); + if (subscribeJson.find(EVENTS_JSON_ATTR_EVENTS) == subscribeJson.end()) { + sLogger->log(Level::ERROR, TAG, "subscribeToLoginEvents: No events array found in subscribe json"); + return -1; + } + std::list events(subscribeJson[EVENTS_JSON_ATTR_EVENTS].get>()); + + int result = 0; + std::string requestId = sVRRequestProcessor->subscribeToLoginEvents(voiceAgentId, &events); + + if (!requestId.empty()) { + json responseJson; + responseJson[SUBSCRIBE2LOGINEVENTS_JSON_ATTR_REQUEST] = requestId; + afb_req_success(source->request, json_tokener_parse(responseJson.dump().c_str()), NULL); + } else { + afb_req_fail(source->request, NULL, "Failed to subscribeToLoginEvents..."); + } + + return 0; +} diff --git a/src/plugins/VshlCoreApi.h b/src/plugins/VshlCoreApi.h index 5e56b75..eb90190 100644 --- a/src/plugins/VshlCoreApi.h +++ b/src/plugins/VshlCoreApi.h @@ -27,12 +27,15 @@ CTLP_INIT(plugin, ret); int onAuthStateEvent(CtlSourceT* source, json_object* argsJ, json_object* queryJ); int onConnectionStateEvent(CtlSourceT* source, json_object* argsJ, json_object* queryJ); int onDialogStateEvent(CtlSourceT* source, json_object* argsJ, json_object* queryJ); +int onLoginPairReceivedEvent(CtlSourceT* source, json_object* argsJ, json_object* queryJ); +int onLoginPairExpiredEvent(CtlSourceT* source, json_object* argsJ, json_object* queryJ); int loadVoiceAgentsConfig(CtlSourceT* source, json_object* argsJ, json_object* queryJ); int startListening(CtlSourceT* source, json_object* argsJ, json_object* queryJ); int cancelListening(CtlSourceT* source, json_object* argsJ, json_object* queryJ); int enumerateVoiceAgents(CtlSourceT* source, json_object* argsJ, json_object* queryJ); int subscribe(CtlSourceT* source, json_object* argsJ, json_object* queryJ); int setDefaultVoiceAgent(CtlSourceT* source, json_object* argsJ, json_object* queryJ); +int subscribeToLoginEvents(CtlSourceT* source, json_object* argsJ, json_object* queryJ); #ifdef __cplusplus } diff --git a/src/plugins/core/VRRequestProcessor.h b/src/plugins/core/VRRequestProcessor.h index 97e277a..037b27f 100644 --- a/src/plugins/core/VRRequestProcessor.h +++ b/src/plugins/core/VRRequestProcessor.h @@ -17,6 +17,7 @@ #include #include +#include #include "core/include/VRRequest.h" #include "core/include/VRRequestProcessorDelegate.h" @@ -43,6 +44,11 @@ public: // is returned. string startListening(); + // Triggers a voiceagent to generate events to provide info to allow + // the user to complete the authorization process (if required). + // Returns the request ID. An empty request ID is returned on failure. + string subscribeToLoginEvents(string va_id, list *args); + // Cancels all the active requests void cancel(); diff --git a/src/plugins/core/VRRequestProcessorImpl.cpp b/src/plugins/core/VRRequestProcessorImpl.cpp index c07f745..d9fa846 100644 --- a/src/plugins/core/VRRequestProcessorImpl.cpp +++ b/src/plugins/core/VRRequestProcessorImpl.cpp @@ -57,6 +57,20 @@ string VRRequestProcessor::startListening() { return mDelegate->startRequestForVoiceAgent(defaultVA); } +string VRRequestProcessor::subscribeToLoginEvents(std::string va_id, std::list *args) { + // Currently simply send the request to the default voice agent, ignoring va_id + shared_ptr defaultVA = mDelegate->getDefaultVoiceAgent(); + if (!defaultVA) { + mLogger->log(Level::ERROR, TAG, "Failed to subscribeToLoginEvents. No default voiceagent found."); + return ""; + } + + // If the requests container is not empty, then clear the + // existing requests in flight and create a new request. + mDelegate->cancelAllRequests(); + return mDelegate->loginEventsRequestForVoiceAgent(defaultVA, args); +} + void VRRequestProcessor::cancel() { // Cancel all pending requests mDelegate->cancelAllRequests(); diff --git a/src/plugins/core/include/VRRequest.h b/src/plugins/core/include/VRRequest.h index 8b9e842..feeac6d 100644 --- a/src/plugins/core/include/VRRequest.h +++ b/src/plugins/core/include/VRRequest.h @@ -16,6 +16,7 @@ #define VSHL_CORE_INCLUDE_VR_REQUEST_H_ #include +#include #include "interfaces/afb/IAFBApi.h" #include "interfaces/utilities/logging/ILogger.h" @@ -32,6 +33,7 @@ class VRRequest { public: // API Verbs static std::string VA_VERB_STARTLISTENING; + static std::string VA_VERB_SUBSCRIBETOCBLEVENTS; static std::string VA_VERB_CANCEL; // Create a VRRequest. @@ -48,6 +50,10 @@ public: // Returns true if started successfully. False otherwise. bool startListening(); + // Invokes the underlying voiceagent's subscribe to login events API. + // Returns true if successful, false otherwise. + bool subscribeToLoginEvents(std::list *args); + // Cancels the voice recognition in the unlerlying voiceagent. // Returns true if canceled successfully. False otherwise. bool cancel(); diff --git a/src/plugins/core/include/VRRequestProcessorDelegate.h b/src/plugins/core/include/VRRequestProcessorDelegate.h index 2c36d38..2ada2fb 100644 --- a/src/plugins/core/include/VRRequestProcessorDelegate.h +++ b/src/plugins/core/include/VRRequestProcessorDelegate.h @@ -17,6 +17,7 @@ #include #include +#include #include "core/include/VRRequest.h" #include "interfaces/afb/IAFBApi.h" @@ -55,6 +56,9 @@ public: // voiceagent is called. string startRequestForVoiceAgent(shared_ptr voiceAgent); + string loginEventsRequestForVoiceAgent(shared_ptr voiceAgent, + std::list *args); + // Cancel all requests void cancelAllRequests(); diff --git a/src/plugins/core/src/VRRequestImpl.cpp b/src/plugins/core/src/VRRequestImpl.cpp index 63302d8..d1a18ac 100644 --- a/src/plugins/core/src/VRRequestImpl.cpp +++ b/src/plugins/core/src/VRRequestImpl.cpp @@ -32,6 +32,7 @@ namespace core { string VRRequest::VA_VERB_STARTLISTENING = "startListening"; string VRRequest::VA_VERB_CANCEL = "cancel"; +string VRRequest::VA_VERB_SUBSCRIBETOCBLEVENTS = "subscribeToCBLEvents"; unique_ptr VRRequest::create( shared_ptr logger, @@ -76,6 +77,21 @@ bool VRRequest::startListening() { return true; } + bool VRRequest::subscribeToLoginEvents(std::list *args) { + json_object* argsJ = json_object_new_object(); + json_object* evJ = json_object_new_array(); + json_object* resultJ; + std::string error, info; + bool result = true; + + json_object_object_add(argsJ, "events", evJ); + int rc = mApi->callSync(mVoiceAgent->getApi(), VA_VERB_SUBSCRIBETOCBLEVENTS, argsJ, &resultJ, error, info); + + FREEIF(resultJ); + + return true; +} + bool VRRequest::cancel() { json_object* object = NULL; std::string error, info; diff --git a/src/plugins/core/src/VRRequestProcessorDelegateImpl.cpp b/src/plugins/core/src/VRRequestProcessorDelegateImpl.cpp index 78ef10a..57fc592 100644 --- a/src/plugins/core/src/VRRequestProcessorDelegateImpl.cpp +++ b/src/plugins/core/src/VRRequestProcessorDelegateImpl.cpp @@ -62,6 +62,32 @@ string VRRequestProcessorDelegate::startRequestForVoiceAgent( return newReqId; } +string VRRequestProcessorDelegate::loginEventsRequestForVoiceAgent( + shared_ptr voiceAgent, + std::list *args) { + if (!mApi) { + mLogger->log(Level::ERROR, TAG, "Failed to loginEventsRequestForVoiceAgent: " + voiceAgent->getId() + ", No API."); + return ""; + } + + // Generate a new request ID. + string newReqId = vshlcore::utilities::uuid::generateUUID(); + + // Create a new request and start listening. + shared_ptr newRequest = VRRequest::create(mLogger, mApi, newReqId, voiceAgent); + + mLogger->log(Level::DEBUG, TAG, "Starting login request with ID: " + newReqId); + if (!newRequest->subscribeToLoginEvents(args)) { + mLogger->log(Level::ERROR, TAG, "Failed to subscribe to login events."); + return ""; + } + + // Insert only if its started successfully. + mVRRequests.insert(make_pair(voiceAgent->getId(), newRequest)); + + return newReqId; +} + void VRRequestProcessorDelegate::cancelAllRequests() { // Cancel Pending requests if (!mVRRequests.empty()) { diff --git a/src/plugins/voiceagents/VoiceAgentEventNames.h b/src/plugins/voiceagents/VoiceAgentEventNames.h index 92cc8dc..abee50a 100644 --- a/src/plugins/voiceagents/VoiceAgentEventNames.h +++ b/src/plugins/voiceagents/VoiceAgentEventNames.h @@ -25,10 +25,13 @@ namespace voiceagents { static string VSHL_EVENT_AUTH_STATE_EVENT = "voice_authstate_event"; static string VSHL_EVENT_CONNECTION_STATE_EVENT = "voice_connectionstate_event"; static string VSHL_EVENT_DIALOG_STATE_EVENT = "voice_dialogstate_event"; +static string VSHL_EVENT_LOGINPAIR_RECEIVED_EVENT = "voice_cbl_codepair_received_event"; +static string VSHL_EVENT_LOGINPAIR_EXPIRED_EVENT = "voice_cbl_codepair_expired_event"; static list VSHL_EVENTS = { VSHL_EVENT_AUTH_STATE_EVENT, VSHL_EVENT_CONNECTION_STATE_EVENT, - VSHL_EVENT_DIALOG_STATE_EVENT, + VSHL_EVENT_DIALOG_STATE_EVENT, VSHL_EVENT_LOGINPAIR_RECEIVED_EVENT, + VSHL_EVENT_LOGINPAIR_EXPIRED_EVENT, }; } // namespace voiceagents -- cgit 1.2.3-korg