modify register/update shortcut
[src/libhomescreen.git] / src / libhomescreen.cpp
index 42ab8b1..24487e8 100644 (file)
@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2017 TOYOTA MOTOR CORPORATION
+ * Copyright (c) 2018,2019 TOYOTA MOTOR CORPORATION
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +26,7 @@
 #include <cstdio>
 #include <cstdlib>
 #include <cstring>
+#include <thread>
 
 #include <libhomescreen.hpp>
 #include "hmi-debug.h"
@@ -33,18 +35,37 @@ using namespace std;
 
 static bool has_verb(const string& verb);
 static const char API[] = "homescreen";
+static const char ApplicationId[] = "application_id";
 
 const std::vector<std::string> LibHomeScreen::api_list {
        std::string("ping"), // debug do not use
        std::string("tap_shortcut"), // HomeScreen Application only
        std::string("on_screen_message"),
+       std::string("on_screen_reply"),
        std::string("subscribe"),
-       std::string("unsubscribe")
+       std::string("unsubscribe"),
+       std::string("showWindow"),
+       std::string("hideWindow"),
+       std::string("replyShowWindow"),
+       std::string("showNotification"),
+       std::string("showInformation"),
+       std::string("getRunnables"),
+       std::string("registerShortcut"),
+       std::string("updateShortcut")
 };
 
 const std::vector<std::string> LibHomeScreen::event_list {
-       std::string("tap_shortcut"),
+//     std::string("tap_shortcut"),
+       std::string("showWindow"),
        std::string("on_screen_message"),
+       std::string("on_screen_reply"),
+       std::string("hideWindow"),
+       std::string("replyShowWindow"),
+       std::string("showNotification"),
+       std::string("showInformation"),
+       std::string("application-list-changed"),
+       std::string("registerShortcut"),
+       std::string("updateShortcut"),
        std::string("none")
 };
 
@@ -74,6 +95,12 @@ static void _on_reply_static(void *closure, struct afb_wsj1_msg *msg)
 }
 
 
+static void event_loop_run(struct sd_event* loop){
+       sd_event_loop(loop);
+       sd_event_unref(loop);
+}
+
+
 /**
  * constructor
  */
@@ -86,14 +113,14 @@ LibHomeScreen::LibHomeScreen()
  */
 LibHomeScreen::~LibHomeScreen()
 {
-       if(mploop)
-       {
-               sd_event_unref(mploop);
-       }
        if(sp_websock != NULL)
        {
                afb_wsj1_unref(sp_websock);
        }
+       if(mploop)
+       {
+               sd_event_exit(mploop, 0);
+       }
 }
 
 /**
@@ -164,16 +191,22 @@ int LibHomeScreen::initialize_websocket()
        mploop = NULL;
        onEvent = nullptr;
        onReply = nullptr;
-       int ret = sd_event_default(&mploop);
+       int ret = sd_event_new(&mploop);
        if(ret < 0)
        {
                HMI_ERROR("libhomescreen","Failed to create event loop");
                goto END;
        }
 
+       {
+               // enforce context to avoid initialization/goto error
+               std::thread th(event_loop_run, mploop);
+               th.detach();
+       }
+
        /* Initialize interface from websocket */
        minterface.on_hangup = _on_hangup_static;
-       minterface.on_call = _on_call_static; /* Is this necessary? */
+       minterface.on_call = _on_call_static;
        minterface.on_event = _on_event_static;
        muri += "ws://localhost:" + to_string(mport) + "/api?token=" + mtoken; /*To be modified*/
        sp_websock = afb_ws_client_connect_wsj1(mploop, muri.c_str(), &minterface, this);
@@ -188,10 +221,6 @@ int LibHomeScreen::initialize_websocket()
 
        return 0;
 END:
-       if(mploop)
-       {
-               sd_event_unref(mploop);
-       }
        return -1;
 }
 
@@ -201,22 +230,18 @@ END:
  * When HomeScreen shortcut area is tapped, sending a event
  *
  * #### Parameters
- * - application_name [in] : Tapped application name (label)
+ * - application_id [in] : Tapped application id (label)
  *
  * #### Return
  * - Returns 0 on success or -1 in case of error.
  */
-int LibHomeScreen::tapShortcut(const char* application_name)
+int LibHomeScreen::tapShortcut(const char* application_id)
 {
-       if(!sp_websock)
-       {
-               return -1;
-       }
+       struct json_object* obj = json_object_new_object();
+       struct json_object* val = json_object_new_string("normal");
+       json_object_object_add(obj, "area", val);
 
-       struct json_object* j_obj = json_object_new_object();
-       struct json_object* val = json_object_new_string(application_name);
-       json_object_object_add(j_obj, "application_name", val);
-       return this->call("tap_shortcut", j_obj);
+       return showWindow(application_id, obj);
 }
 
 /**
@@ -243,6 +268,30 @@ int LibHomeScreen::onScreenMessage(const char* display_message)
        return this->call("on_screen_message", j_obj);
 }
 
+/**
+ * Sending onScreen reply event
+ *
+ * Sending OnScreen reply event to applications from HomeScreen
+ *
+ * #### Parameters
+ * - reply_message [in] : message for reply
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ */
+int LibHomeScreen::onScreenReply(const char* reply_message)
+{
+       if(!sp_websock)
+       {
+               return -1;
+       }
+
+       struct json_object* j_obj = json_object_new_object();
+       struct json_object* val = json_object_new_string(reply_message);
+       json_object_object_add(j_obj, "reply_message", val);
+       return this->call("on_screen_reply", j_obj);
+}
+
 /**
  * Setting Event Handler
  *
@@ -254,23 +303,38 @@ int LibHomeScreen::onScreenMessage(const char* display_message)
  *
  * #### Return
  * Nothing
+ *
+ * #### Note
+ * Don't release json_object by json_object_put in handler_func.
+ * The resource is released by libafbwsc library.
  */
 void LibHomeScreen::set_event_handler(enum EventType et, handler_func f)
 {
-       if (et >= 1 && et <= 2) {
-               switch (et) {
-                       case Event_TapShortcut:
-                               this->subscribe(LibHomeScreen::event_list[0]);
-                               break;
-                       case Event_OnScreenMessage:
-                               this->subscribe(LibHomeScreen::event_list[1]);
-                               break;
-               }
-
+       if (et > Event_Min && et < Event_Max) {
                this->handlers[et] = std::move(f);
        }
 }
 
+/**
+ * This function subscribe HomeScreen event
+ *
+ * #### Parameters
+ * None
+ *
+ * #### Return
+ * - Nothing
+ *
+ * #### Note
+ * To call HomeScreen's subscribe APIs.
+ *
+ */
+void LibHomeScreen::publishSubscription(void)
+{
+       for(auto &it : handlers) {
+               this->subscribe(LibHomeScreen::event_list[it.first - 1]);
+       }
+}
+
 /**
  * This function calls the API of HomeScreen via WebSocket
  *
@@ -396,6 +460,219 @@ int LibHomeScreen::unsubscribe(const string& event_name)
        return ret;
 }
 
+/**
+ * Sending show window event
+ *
+ * Call HomeScreen Service's showWindow verb to request display id's screen.
+ *
+ * #### Parameters
+ * - application_id [in] : This argument should be specified to the application's id.
+ * - json [in] : This argument should be specified to the json parameters.
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
+int LibHomeScreen::showWindow(const char* application_id, json_object* json)
+{
+       if(!sp_websock)
+       {
+               return -1;
+       }
+
+       struct json_object* j_obj = json_object_new_object();
+       struct json_object* val = json_object_new_string(application_id);
+       json_object_object_add(j_obj, ApplicationId, val);
+
+       if (json == nullptr) {
+               struct json_object* j_json = json_object_new_object();
+               struct json_object* value = json_object_new_string("normal");
+               json_object_object_add(j_json, "area", value);
+               json_object_object_add(j_obj, "parameter", j_json);
+       }
+       else {
+               json_object_object_add(j_obj, "parameter", json);
+       }
+
+       return this->call("showWindow", j_obj);
+}
+
+/**
+ * Sending hide window event
+ *
+ * Call HomeScreen Service's hideWindow verb to release id's screen.
+ *
+ * #### Parameters
+ * - application_id [in] : This argument should be specified to the application's id.
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
+int LibHomeScreen::hideWindow(const char* application_id)
+{
+       if(!sp_websock)
+       {
+               return -1;
+       }
+
+       struct json_object* j_obj = json_object_new_object();
+       struct json_object* val = json_object_new_string(application_id);
+       json_object_object_add(j_obj, ApplicationId, val);
+
+       return this->call("hideWindow", j_obj);
+}
+
+/**
+ * Sending reply onscreen message event
+ *
+ * Call HomeScreen Service's replyShowWindow verb to reply onscreen message.
+ *
+ * #### Parameters
+ * - application_id [in] : This argument should be specified to the onscreen reply to applilcation id.
+ * - json [in] : This argument should be specified to the json parameters.
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
+int LibHomeScreen::replyShowWindow(const char* application_id, json_object* json)
+{
+       if(!sp_websock)
+       {
+               return -1;
+       }
+
+       if (json == nullptr) {
+               HMI_WARNING("libhomescreen", "replyShowWindow`s parameter is null");
+               return -1;
+       }
+
+       struct json_object* j_obj = json_object_new_object();
+       struct json_object* val = json_object_new_string(application_id);
+       json_object_object_add(j_obj, ApplicationId, val);
+       json_object_object_add(j_obj, "parameter", json);
+
+       return this->call("replyShowWindow", j_obj);
+}
+
+/**
+ * Sending show notification event
+ *
+ * Call HomeScreen Service's notification verb to show notification on Status Bar.
+ *
+ * #### Parameters
+ * - json [in] : This argument should be specified to the json parameters.
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
+int LibHomeScreen::showNotification(json_object* json)
+{
+       if(!sp_websock)
+       {
+               return -1;
+       }
+
+       return this->call("showNotification", json);
+}
+
+/**
+ * Sending show information event
+ *
+ * Call HomeScreen Service's information verb to show notification on Information Bar.
+ *
+ * #### Parameters
+ * - json [in] : This argument should be specified to the json parameters.
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
+int LibHomeScreen::showInformation(json_object* json)
+{
+       if(!sp_websock)
+       {
+               return -1;
+       }
+
+       return this->call("showInformation", json);
+}
+
+/**
+ * get runnables list
+ *
+ * Call HomeScreen Service's getRunnables verb to get runnalbes list.
+ *
+ * #### Parameters
+ * - Nothing
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
+int LibHomeScreen::getRunnables(void)
+{
+       return this->call("getRunnables", nullptr);
+}
+
+/**
+ * register shortcut to homescreen
+ *
+ * Call HomeScreen Service's registerShortcut verb to regitster shortcut.
+ *
+ * #### Parameters
+ * - json [in] : This argument should be specified to the json parameters.
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
+int LibHomeScreen::registerShortcut(const char* application_id, json_object* json)
+{
+    if(!sp_websock)
+    {
+               return -1;
+    }
+
+       struct json_object* j_obj = json_object_new_object();
+       struct json_object* val = json_object_new_string(application_id);
+       json_object_object_add(j_obj, ApplicationId, val);
+       json_object_object_add(j_obj, "parameter", json);
+
+    return this->call("registerShortcut", j_obj);
+}
+
+
+/**
+ * update shortcut to launcher
+ *
+ * Call HomeScreen Service's updateShortcut verb to update shortcut.
+ *
+ * #### Parameters
+ * - json [in] : This argument should be specified to the json parameters.
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
+int LibHomeScreen::updateShortcut(const char* application_id, json_object* json)
+{
+    if(!sp_websock)
+    {
+               return -1;
+    }
+
+       struct json_object* j_obj = json_object_new_object();
+       struct json_object* val = json_object_new_string(application_id);
+       json_object_object_add(j_obj, ApplicationId, val);
+       json_object_object_add(j_obj, "parameter", json);
+
+    return this->call("updateShortcut", j_obj);
+}
+
+
 /************* Callback Function *************/
 
 void LibHomeScreen::on_hangup(void *closure, struct afb_wsj1 *wsj)
@@ -412,8 +689,8 @@ void LibHomeScreen::on_call(void *closure, const char *api, const char *verb, st
 }
 
 /*
-* event is like "homescreen/tap_shortcut"
-* msg is like {"event":"homescreen\/tap_shortcut","data":{"application_name":"hoge"},"jtype":"afb-event"}
+* event is like "homescreen/hvac"
+* msg is like {"event":"homescreen\/hvac","data":{"type":"tap_shortcut"},"jtype":"afb-event"}
 * so you can get
        event name : struct json_object obj = json_object_object_get(msg,"event")
 */
@@ -426,7 +703,11 @@ void LibHomeScreen::on_event(void *closure, const char *event, struct afb_wsj1_m
        }
 
        struct json_object* ev_contents = afb_wsj1_msg_object_j(msg);
-       struct json_object *json_data = json_object_object_get(ev_contents, "data");
+       struct json_object *json_data;
+       if(!json_object_object_get_ex(ev_contents, "data", &json_data)) {
+               HMI_ERROR("libhomescreen", "got ev_contents error.");
+               return;
+       }
 
        if(onEvent != nullptr)
        {
@@ -434,35 +715,23 @@ void LibHomeScreen::on_event(void *closure, const char *event, struct afb_wsj1_m
                onEvent(ev, ev_contents);
        }
 
-       const char* event_only = strchr(event, '/');
-       if (event_only != nullptr) {
-               event_only = event_only + 1;
+       const char* event_type = nullptr;
+       struct json_object *json_event_type;
+       if(json_object_object_get_ex(json_data, "type", &json_event_type)) {
+               event_type = json_object_get_string(json_event_type);
        }
-
-       if (strcasecmp(event_only, LibHomeScreen::event_list[0].c_str()) == 0) {
-               auto i = this->handlers.find(Event_TapShortcut);
-
-               struct json_object *json_application_name = json_object_object_get(json_data, "application_name");
-               const char* application_name = json_object_get_string(json_application_name);
-
-               if ( i != this->handlers.end() ) {
-                       i->second(application_name);
-               }
+       else {
+               HMI_WARNING("libhomescreen","event_type is null.");
+               return;
        }
-       else if (strcasecmp(event_only, LibHomeScreen::event_list[1].c_str()) == 0) {
-
-               auto i = this->handlers.find(Event_OnScreenMessage);
 
-               struct json_object *json_display_message = json_object_object_get(json_data, "display_message");
-               const char* display_message = json_object_get_string(json_display_message);
-
-               if ( i != this->handlers.end() ) {
-                       i->second(display_message);
+       int e_type = getEventType(event_type);
+       if(e_type < Event_Max) {
+               auto it = this->handlers.find(EventType(e_type));
+               if ( it != this->handlers.end() ) {
+                       it->second(json_data);
                }
-
        }
-
-       json_object_put(ev_contents);
 }
 
 /**
@@ -476,9 +745,21 @@ void LibHomeScreen::on_reply(void *closure, struct afb_wsj1_msg *msg)
        {
                struct json_object* reply = afb_wsj1_msg_object_j(msg);
                onReply(reply);
+       }
+}
 
-               json_object_put(reply);
+/*
+* convert event name to event type
+*/
+int LibHomeScreen::getEventType(const char *event)
+{
+       int i = 0;
+       for(; i < LibHomeScreen::event_list.size(); ++i) {
+               if (strcasecmp(event, LibHomeScreen::event_list[i].c_str()) == 0) {
+                       break;
+               }
        }
+       return (i + 1) < Event_Max ? i : Event_Max;
 }
 
 static bool has_verb(const string& verb)