add register/update shortcut
[apps/agl-service-homescreen.git] / src / hs-client.cpp
index e97f844..e8f0f7b 100644 (file)
  * limitations under the License.
  */
 
+#include <cstring>
 #include "hs-client.h"
 #include "hs-helper.h"
-#include "hmi-debug.h"
 
+static const char _event[] = "event";
 static const char _type[] = "type";
 static const char _text[] = "text";
 static const char _info[] = "info";
 static const char _icon[] = "icon";
 static const char _parameter[] = "parameter";
 static const char _replyto[] = "replyto";
+static const char _caller[] = "caller";
+static const char _shortcut[] = "shortcut";
+static const char _shortcut_id[] = "shortcut_id";
+static const char _shortcut_name[] = "shortcut_name";
+
+// homescreen-service event and event handler function list
+const std::unordered_map<std::string, HS_Client::func_handler> HS_Client::func_list {
+    {"tap_shortcut",        &HS_Client::tap_shortcut},
+    {"showWindow",          &HS_Client::showWindow},
+    {"hideWindow",          &HS_Client::hideWindow},
+    {"replyShowWindow",     &HS_Client::replyShowWindow},
+    {"on_screen_message",   &HS_Client::on_screen_message},
+    {"on_screen_reply",     &HS_Client::on_screen_reply},
+    {"subscribe",           &HS_Client::subscribe},
+    {"unsubscribe",         &HS_Client::unsubscribe},
+    {"showNotification",    &HS_Client::showNotification},
+    {"showInformation",     &HS_Client::showInformation},
+    {"registerShortcut",    &HS_Client::registerShortcut},
+    {"updateShortcut",      &HS_Client::updateShortcut}
+};
+
+std::list<std::pair<std::string, std::string>> HS_Client::shortcut_list;
 
 /**
  * HS_Client construction function
@@ -37,7 +60,7 @@ static const char _replyto[] = "replyto";
  */
 HS_Client::HS_Client(afb_req_t request, std::string id) : my_id(id)
 {
-    HMI_NOTICE("homescreen-service","called.");
+    AFB_DEBUG("called.");
     my_event = afb_api_make_event(request->api, id.c_str());
 }
 
@@ -53,7 +76,7 @@ HS_Client::HS_Client(afb_req_t request, std::string id) : my_id(id)
  */
 HS_Client::~HS_Client()
 {
-    HMI_NOTICE("homescreen-service","called.");
+    AFB_DEBUG("called.");
     afb_event_unref(my_event);
 }
 
@@ -61,20 +84,18 @@ HS_Client::~HS_Client()
  * push tap_shortcut event
  *
  * #### Parameters
- *  - appid: app's id.
+ *  - request : the request
  *
  * #### Return
- * result
+ * 0 : success
+ * others : fail
  *
  */
-int HS_Client::tap_shortcut(const char* appid)
+int HS_Client::tap_shortcut(afb_req_t request)
 {
-    if(!checkEvent(__FUNCTION__))
-        return 0;
-
-    HMI_NOTICE("homescreen-service","%s application_id = %s.", __FUNCTION__, appid);
+    AFB_INFO("request appid = %s.", my_id.c_str());
     struct json_object* push_obj = json_object_new_object();
-    hs_add_object_to_json_object_str( push_obj, 4, _application_id, appid,
+    hs_add_object_to_json_object_str( push_obj, 4, _application_id, my_id.c_str(),
     _type, __FUNCTION__);
     afb_event_push(my_event, push_obj);
     return 0;
@@ -84,71 +105,99 @@ int HS_Client::tap_shortcut(const char* appid)
  * push on_screen_message event
  *
  * #### Parameters
- *  - message: post message.
+ *  - request : the request
  *
  * #### Return
- * result
+ * 0 : success
+ * others : fail
  *
  */
-int HS_Client::on_screen_message(afb_req_t request, const char* message)
+int HS_Client::on_screen_message(afb_req_t request)
 {
-    if(!checkEvent(__FUNCTION__))
-        return 0;
-
-    HMI_NOTICE("homescreen-service","push %s event message [%s].", __FUNCTION__, message);
-    struct json_object* push_obj = json_object_new_object();
-    hs_add_object_to_json_object_str( push_obj, 4, _display_message, message,
-    _type, __FUNCTION__);
-    afb_event_push(my_event, push_obj);
-    return 0;
+    int ret = 0;
+    const char* value = afb_req_value(request, _display_message);
+    if (value) {
+        AFB_INFO("push %s event message [%s].", __FUNCTION__, value);
+        struct json_object* push_obj = json_object_new_object();
+        hs_add_object_to_json_object_str( push_obj, 4, _display_message, value,
+        _type, __FUNCTION__);
+        afb_event_push(my_event, push_obj);
+    }
+    else {
+        AFB_WARNING("Please input display_message");
+        ret = AFB_EVENT_BAD_REQUEST;
+    }
+    return ret;
 }
 
 /**
  * push on_screen_reply event
  *
  * #### Parameters
- *  - message: reply message.
+ *  - request : the request
  *
  * #### Return
- * result
+ * 0 : success
+ * others : fail
  *
  */
-int HS_Client::on_screen_reply(afb_req_t request, const char* message)
+int HS_Client::on_screen_reply(afb_req_t request)
 {
-    if(!checkEvent(__FUNCTION__))
-        return 0;
-
-    HMI_NOTICE("homescreen-service","push %s event message [%s].", __FUNCTION__, message);
-    struct json_object* push_obj = json_object_new_object();
-    hs_add_object_to_json_object_str( push_obj, 4, _reply_message, message,
-    _type, __FUNCTION__);
-    afb_event_push(my_event, push_obj);
-    return 0;
+    int ret = 0;
+    const char* value = afb_req_value(request, _reply_message);
+    if (value) {
+        AFB_INFO("push %s event message [%s].", __FUNCTION__, value);
+        struct json_object* push_obj = json_object_new_object();
+        hs_add_object_to_json_object_str( push_obj, 4, _reply_message, value,
+        _type, __FUNCTION__);
+        afb_event_push(my_event, push_obj);
+    }
+    else {
+        AFB_WARNING("Please input reply_message");
+        ret = AFB_EVENT_BAD_REQUEST;
+    }
+    return ret;
 }
 
 /**
  * subscribe event
  *
  * #### Parameters
- *  - event: homescreen event, tap_shortcut etc.
+ *  - request : the request
  *
  * #### Return
- * result
+ * 0 : success
+ * others : fail
  *
  */
-int HS_Client::subscribe(afb_req_t request, const char* event)
+int HS_Client::subscribe(afb_req_t request)
 {
+    AFB_DEBUG(" called.");
     int ret = 0;
-    auto ip = event_list.find(std::string(event));
-    if(ip == event_list.end()) {
-        event_list[std::string(event)] = 0;
-    }
-    if(!subscription) {
-        ret = afb_req_subscribe(request, my_event);
-        if(ret == 0) {
-            subscription = true;
+    const char *value = afb_req_value(request, _event);
+    if(value) {
+        AFB_INFO("subscribe event %s", value);
+        if(!isSupportEvent(value)) {
+            AFB_WARNING("subscibe event isn't existing.");
+            ret = AFB_EVENT_BAD_REQUEST;
+        }
+        else {
+            event_list.insert(std::string(value));
+            if(!subscription) {
+                ret = afb_req_subscribe(request, my_event);
+                if(ret == 0) {
+                    subscription = true;
+                }
+            }
+            if (!strcasecmp("updateShortcut", value)) {
+                pushUpdateShortcutEvent();
+            }
         }
     }
+    else {
+        AFB_WARNING("Please input event name");
+        ret = AFB_EVENT_BAD_REQUEST;
+    }
     return ret;
 }
 
@@ -156,89 +205,72 @@ int HS_Client::subscribe(afb_req_t request, const char* event)
  * unsubscribe event
  *
  * #### Parameters
- *  - event: homescreen event, tap_shortcut etc.
+ *  - request : the request
  *
  * #### Return
- * result
+ * 0 : success
+ * others : fail
  *
  */
-int HS_Client::unsubscribe(afb_req_t request, const char* event)
+int HS_Client::unsubscribe(afb_req_t request)
 {
+    AFB_DEBUG(" called.");
     int ret = 0;
-    event_list.erase(std::string(event));
-    if(event_list.empty()) {
-        ret = afb_req_unsubscribe(request, my_event);
+    const char *value = afb_req_value(request, _event);
+    if(value) {
+        AFB_INFO("unsubscribe %s event", value);
+        event_list.erase(std::string(value));
+        if(event_list.empty()) {
+            ret = afb_req_unsubscribe(request, my_event);
+        }
+    }
+    else {
+        AFB_WARNING("Please input event name");
+        ret = AFB_EVENT_BAD_REQUEST;
     }
     return ret;
 }
 
-/**
- * check if client subscribe event
- *
- * #### Parameters
- *  - event: homescreen event, tap_shortcut etc.
- *
- * #### Return
- * true: found
- * false: not found
- *
- */
-bool HS_Client::checkEvent(const char* event)
-{
-    auto ip = event_list.find(std::string(event));
-    if(ip == event_list.end())
-        return false;
-    else
-        return true;
-}
-
 /**
  * showWindow event
  *
- * input contents : {"application_id":"the appid that want to display", "parameter":{"area": "display area", ...}}
- *
  * #### Parameters
  * - request : the request
- * - appid : the appid that want to display
  *
  * #### Return
  * 0 : success
  * others : fail
  *
  */
-int HS_Client::showWindow(afb_req_t request, const char* appid)
+int HS_Client::showWindow(afb_req_t request)
 {
-    if(!checkEvent(__FUNCTION__))
-        return 0;
-
-    HMI_NOTICE("homescreen-service","%s application_id = %s.", __FUNCTION__, appid);
+    AFB_INFO("%s application_id = %s.", __FUNCTION__, my_id.c_str());
+    int ret = 0;
     struct json_object* push_obj = json_object_new_object();
-    hs_add_object_to_json_object_str( push_obj, 4, _application_id, appid, _type, __FUNCTION__);
+    hs_add_object_to_json_object_str( push_obj, 4, _application_id, my_id.c_str(), _type, __FUNCTION__);
     const char* param = afb_req_value(request, _parameter);
     if(param) {
         std::string req_appid = std::move(get_application_id(request));
         if(req_appid.empty()) {
-            HMI_NOTICE("homescreen-service","can't get application identifier");
+            AFB_WARNING("can't get application identifier");
             return AFB_REQ_GETAPPLICATIONID_ERROR;
         }
 
         struct json_object* param_obj = json_tokener_parse(param);
         json_object_object_add(param_obj, _replyto, json_object_new_string(req_appid.c_str()));
         json_object_object_add(push_obj, _parameter, param_obj);
+        afb_event_push(my_event, push_obj);
     }
     else {
-        HMI_ERROR("homescreen-service","please input correct parameter.");
-        return AFB_EVENT_BAD_REQUEST;
+        AFB_WARNING("please input correct parameter.");
+        ret = AFB_EVENT_BAD_REQUEST;
     }
-    afb_event_push(my_event, push_obj);
-    return 0;
+    return ret;
 }
 
 /**
  * hideWindow event
  *
- * input contents : {"application_id":"the appid that want to hide"}
- *
  * #### Parameters
  * - request : the request
  *
@@ -249,19 +281,19 @@ int HS_Client::showWindow(afb_req_t request, const char* appid)
  */
 int HS_Client::hideWindow(afb_req_t request)
 {
-    if(!checkEvent(__FUNCTION__))
-        return 0;
-
-    HMI_NOTICE("homescreen-service","%s called.", __FUNCTION__);
+    AFB_DEBUG(" called.");
     std::string req_appid = std::move(get_application_id(request));
     if(req_appid.empty()) {
-        HMI_NOTICE("homescreen-service","can't get application identifier");
+        AFB_WARNING("can't get application identifier");
         return AFB_REQ_GETAPPLICATIONID_ERROR;
     }
 
     struct json_object* push_obj = json_object_new_object();
-    hs_add_object_to_json_object_str( push_obj, 4, _application_id, req_appid.c_str(),
+    hs_add_object_to_json_object_str( push_obj, 4, _application_id, my_id.c_str(),
     _type, __FUNCTION__);
+    struct json_object* param_obj = json_object_new_object();
+    json_object_object_add(param_obj, _caller, json_object_new_string(req_appid.c_str()));
+    json_object_object_add(push_obj, _parameter, param_obj);
     afb_event_push(my_event, push_obj);
     return 0;
 }
@@ -269,43 +301,35 @@ int HS_Client::hideWindow(afb_req_t request)
 /**
  * replyShowWindow event
  *
- * input contens : {"application_id": "the appid that want to reply",  "parameter": {...}}
- *
  * #### Parameters
  * - request : the request
- * - appid : the appid that want to reply
  *
  * #### Return
  * 0 : success
  * others : fail
  *
  */
-int HS_Client::replyShowWindow(afb_req_t request, const char* appid)
+int HS_Client::replyShowWindow(afb_req_t request)
 {
-    if(!checkEvent(__FUNCTION__))
-        return 0;
-
-    HMI_NOTICE("homescreen-service","%s application_id = %s.", __FUNCTION__, appid);
+    AFB_INFO("%s application_id = %s.", __FUNCTION__, my_id.c_str());
+    int ret = 0;
     struct json_object* push_obj = json_object_new_object();
-    hs_add_object_to_json_object_str( push_obj, 4, _application_id, appid, _type, __FUNCTION__);
+    hs_add_object_to_json_object_str( push_obj, 4, _application_id, my_id.c_str(), _type, __FUNCTION__);
     const char* param = afb_req_value(request, _parameter);
     if(param) {
         json_object_object_add(push_obj, _parameter, json_tokener_parse(param));
+        afb_event_push(my_event, push_obj);
     }
     else {
-        HMI_ERROR("homescreen-service","please input correct parameter.");
-        return AFB_EVENT_BAD_REQUEST;
+        AFB_WARNING("please input correct parameter.");
+        ret = AFB_EVENT_BAD_REQUEST;
     }
-
-    afb_event_push(my_event, push_obj);
-    return 0;
+    return ret;
 }
 
 /**
  * showNotification event
  *
- * input contents : {"icon": "icon path", "text": "message contents"}
- *
  * #### Parameters
  *  - request : the request
  *
@@ -316,13 +340,14 @@ int HS_Client::replyShowWindow(afb_req_t request, const char* appid)
  */
 int HS_Client::showNotification(afb_req_t request)
 {
+    AFB_DEBUG(" called.");
     int ret = 0;
     const char *value = afb_req_value(request, _text);
     if(value) {
-        HMI_NOTICE("homescreen-service","text is %s", value);
+        AFB_INFO("text is %s", value);
         std::string appid =std::move(get_application_id(request));
         if(appid.empty()) {
-            HMI_NOTICE("homescreen-service","can't get application identifier");
+            AFB_WARNING("can't get application identifier");
             return AFB_REQ_GETAPPLICATIONID_ERROR;
         }
 
@@ -331,18 +356,19 @@ int HS_Client::showNotification(afb_req_t request)
         if(icon) {
             json_object_object_add(param_obj, _icon, json_object_new_string(icon));
             json_object_object_add(param_obj, _text, json_object_new_string(value));
+            json_object_object_add(param_obj, _caller, json_object_new_string(appid.c_str()));
             struct json_object* push_obj = json_object_new_object();
-            hs_add_object_to_json_object_str( push_obj, 4, _application_id, appid.c_str(), _type, __FUNCTION__);
+            hs_add_object_to_json_object_str( push_obj, 4, _application_id, my_id.c_str(), _type, __FUNCTION__);
             json_object_object_add(push_obj, _parameter, param_obj);
             afb_event_push(my_event, push_obj);
         }
         else {
-            HMI_NOTICE("homescreen-service","please input icon.");
+            AFB_WARNING("please input icon.");
             ret = AFB_REQ_SHOWNOTIFICATION_ERROR;
         }
     }
     else {
-        HMI_NOTICE("homescreen-service","please input text.");
+        AFB_WARNING("please input text.");
         ret = AFB_REQ_SHOWNOTIFICATION_ERROR;
     }
 
@@ -352,8 +378,6 @@ int HS_Client::showNotification(afb_req_t request)
 /**
  * showInformation event
  *
- * input contents : {"info": "information contents"}
- *
  * #### Parameters
  *  - request : the request
  *
@@ -364,27 +388,227 @@ int HS_Client::showNotification(afb_req_t request)
  */
 int HS_Client::showInformation(afb_req_t request)
 {
+    AFB_DEBUG(" called.");
     int ret = 0;
     const char *value = afb_req_value(request, _info);
     if(value) {
-        HMI_NOTICE("homescreen-service","info is %s", value);
+        AFB_INFO("info is %s", value);
         std::string appid = std::move(get_application_id(request));
         if(appid.empty()) {
-            HMI_NOTICE("homescreen-service","can't get application identifier");
+            AFB_WARNING("can't get application identifier");
             return AFB_REQ_GETAPPLICATIONID_ERROR;
         }
 
         struct json_object* param_obj = json_object_new_object();
         json_object_object_add(param_obj, _info, json_object_new_string(value));
         struct json_object* push_obj = json_object_new_object();
-        hs_add_object_to_json_object_str( push_obj, 4, _application_id, appid.c_str(), _type, __FUNCTION__);
+        hs_add_object_to_json_object_str( push_obj, 4, _application_id, my_id.c_str(), _type, __FUNCTION__);
         json_object_object_add(push_obj, _parameter, param_obj);
         afb_event_push(my_event, push_obj);
     }
     else {
-        HMI_NOTICE("homescreen-service","please input information.");
+        AFB_WARNING("please input information.");
         ret = AFB_REQ_SHOWINFORMATION_ERROR;
     }
 
     return ret;
 }
+
+/**
+ * registerShortcut event
+ *
+ * #### Parameters
+ *  - request : the request
+ *
+ * #### Return
+ * 0 : success
+ * others : fail
+ *
+ */
+int HS_Client::registerShortcut(afb_req_t request)
+{
+    int ret = 0;
+    struct json_object *param_obj;
+    if(json_object_object_get_ex(afb_req_json(request), _parameter, &param_obj)) {
+        struct json_object* push_obj = json_object_new_object();
+        hs_add_object_to_json_object_str( push_obj, 4, _application_id, my_id.c_str(), _type, __FUNCTION__);
+        json_object_object_add(push_obj, _parameter, param_obj);
+        afb_event_push(my_event, push_obj);
+    }
+    else {
+        AFB_WARNING("please input parameter.");
+        ret = AFB_EVENT_BAD_REQUEST;
+    }
+    return ret;
+}
+
+/**
+ * updateShortcut event
+ *
+ * #### Parameters
+ *  - request : the request
+ *
+ * #### Return
+ * 0 : success
+ * others : fail
+ *
+ */
+int HS_Client::updateShortcut(afb_req_t request)
+{
+    AFB_INFO("%s application_id = %s.", __FUNCTION__, my_id.c_str());
+    int ret = 0;
+    std::list<std::pair<std::string, std::string>> new_shortcut_list;
+    struct json_object *req_json = afb_req_json(request);
+    struct json_object *param_obj, *shortcut_obj;
+    if(json_object_object_get_ex(afb_req_json(request), _parameter, &param_obj)
+    && json_object_object_get_ex(param_obj, _shortcut, &shortcut_obj)) {
+        if(json_object_get_type(shortcut_obj) == json_type_array ) {
+            int array_len = json_object_array_length(shortcut_obj);
+            for (int i = 0; i < array_len; ++i) {
+                struct json_object *obj = json_object_array_get_idx(shortcut_obj, i);
+                struct json_object *appid_obj, *appname_obj;
+                if(json_object_object_get_ex(obj, _shortcut_id, &appid_obj)
+                && json_object_object_get_ex(obj, _shortcut_name, &appname_obj)) {
+                    new_shortcut_list.push_back(std::pair<std::string, std::string>(json_object_get_string(appid_obj), 
+                                                                                    json_object_get_string(appname_obj)));
+                }
+                else {
+                    AFB_WARNING("shortcut list json object pattern error.");
+                    ret = AFB_EVENT_BAD_REQUEST;
+                    break;
+                }
+            }
+        }
+        else {
+            AFB_WARNING("json object pattern error.");
+            ret = AFB_EVENT_BAD_REQUEST;
+        }
+    }
+    else {
+        AFB_WARNING("input json object error.");
+        ret = AFB_EVENT_BAD_REQUEST;
+    }
+
+    if(ret == 0) {
+        HS_Client::shortcut_list.swap(new_shortcut_list);
+        pushUpdateShortcutEvent();
+    }
+    return ret;
+}
+
+/**
+ * check if client subscribe event
+ *
+ * #### Parameters
+ *  - event: homescreen event, tap_shortcut etc.
+ *
+ * #### Return
+ * true: found
+ * false: not found
+ *
+ */
+bool HS_Client::checkEvent(const char* event)
+{
+    auto ip = event_list.find(std::string(event));
+    if(ip == event_list.end())
+        return false;
+    else
+        return true;
+}
+
+/**
+ * check if event is supporting
+ *
+ * #### Parameters
+ *  - event: homescreen event, tap_shortcut etc.
+ *
+ * #### Return
+ * true: support
+ * false: not fosupportund
+ *
+ */
+bool HS_Client::isSupportEvent(const char* event)
+{
+    int ret = hs_search_event_name_index(event);
+    return ret == -1 ? false : true;
+}
+
+/**
+ * handle homescreen event
+ *
+ * #### Parameters
+ *  - request : the request
+ *  - verb: request verb name
+ *
+ * #### Return
+ * 0: success
+ * others: fail
+ *
+ */
+int HS_Client::handleRequest(afb_req_t request, const char *verb)
+{
+    AFB_DEBUG("called.");
+    if((strcasecmp(verb, "subscribe") && strcasecmp(verb, "unsubscribe")) && !checkEvent(verb))
+        return 0;
+
+    int ret = AFB_EVENT_BAD_REQUEST;
+    auto ip = func_list.find(std::string(verb));
+    if(ip != func_list.end() && ip->second != nullptr) {
+        AFB_INFO("[%s]verb found", verb);
+        ret = (this->*(ip->second))(request);
+    }
+    return ret;
+}
+
+/**
+ * push event
+ *
+ * #### Parameters
+ *  - event : the event want to push
+ *  - param : the parameter contents of event
+ *
+ * #### Return
+ * 0 : success
+ * others : fail
+ *
+ */
+int HS_Client::pushEvent(const char *event, struct json_object *param)
+{
+    if(!checkEvent(event))
+        return 0;
+
+    AFB_INFO("called, event=%s.",event);
+    struct json_object* push_obj = json_object_new_object();
+    hs_add_object_to_json_object_str( push_obj, 4, _application_id, my_id.c_str(), _type, event);
+    if(param != nullptr)
+        json_object_object_add(push_obj, _parameter, param);
+    afb_event_push(my_event, push_obj);
+    return 0;
+}
+
+/**
+ * push updateShortcut event
+ *
+ * #### Parameters
+ *  None
+ *
+ * #### Return
+ * Nothing
+ *
+ */
+void HS_Client::pushUpdateShortcutEvent(void)
+{
+    struct json_object* arr_obj = json_object_new_array();
+    for(auto &it : HS_Client::shortcut_list) {
+        struct json_object* obj = json_object_new_object();
+        json_object_object_add(obj, _shortcut_id, json_object_new_string(it.first.c_str()));
+        json_object_object_add(obj, _shortcut_name, json_object_new_string(it.second.c_str()));
+        json_object_array_add(arr_obj, obj);
+    }
+    struct json_object* shortcut_obj = json_object_new_object();
+    json_object_object_add(shortcut_obj, _shortcut, arr_obj);
+    struct json_object* push_obj = json_object_new_object();
+    hs_add_object_to_json_object_str(push_obj, 4, _application_id, my_id.c_str(), _type, "updateShortcut");
+    json_object_object_add(push_obj, _parameter, shortcut_obj);
+    afb_event_push(my_event, push_obj);
+}   
\ No newline at end of file