src/runxdg.cpp

   1 /*
   2  * Copyright (c) 2017 Panasonic Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in all
  12  * copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <unistd.h>
  26 #include <stdarg.h>
  27 #include <sys/stat.h>
  28 #include <sys/time.h>
  29 #include <sys/wait.h>
  30
  31 #include <cstdio>
  32
  33 #include "cpptoml/cpptoml.h"
  34
  35 #include "runxdg.hpp"
  36
  37 #define RUNXDG_CONFIG "runxdg.toml"
  38
  39 void fatal(const char* format, ...)
  40 {
  41   va_list va_args;
  42   va_start(va_args, format);
  43   vfprintf(stderr, format, va_args);
  44   va_end(va_args);
  45
  46   exit(EXIT_FAILURE);
  47 }
  48
  49 void warn(const char* format, ...)
  50 {
  51   va_list va_args;
  52   va_start(va_args, format);
  53   vfprintf(stderr, format, va_args);
  54   va_end(va_args);
  55 }
  56
  57 void debug(const char* format, ...)
  58 {
  59   va_list va_args;
  60   va_start(va_args, format);
  61   vfprintf(stderr, format, va_args);
  62   va_end(va_args);
  63 }
  64
  65 void RunXDG::notify_ivi_control_cb (ilmObjectType object, t_ilm_uint id,
  66                                     t_ilm_bool created)
  67 {
  68   if (object == ILM_SURFACE) {
  69     struct ilmSurfaceProperties surf_props;
  70
  71     ilm_getPropertiesOfSurface(id, &surf_props);
  72     pid_t surf_pid = surf_props.creatorPid;
  73
  74     if (!created) {
  75       AGL_DEBUG("ivi surface (id=%d, pid=%d)surf_pid destroyed.", id, surf_pid);
  76       m_launcher->unregister_surfpid(surf_pid);
  77       m_surfaces.erase(surf_pid);
  78       return;
  79     }
  80
  81     AGL_DEBUG("ivi surface (id=%d, pid=%d) is created.", id, surf_pid);
  82
  83     m_launcher->register_surfpid(surf_pid);
  84     if (m_launcher->m_rid &&
  85         surf_pid == m_launcher->find_surfpid_by_rid(m_launcher->m_rid)) {
  86       setup_surface(id);
  87     }
  88     m_surfaces[surf_pid] = id;
  89   } else if (object == ILM_LAYER) {
  90     if (created)
  91       AGL_DEBUG("ivi layer: %d created.", id);
  92     else
  93       AGL_DEBUG("ivi layer: %d destroyed.", id);
  94   }
  95 }
  96
  97 void RunXDG::notify_ivi_control_cb_static (ilmObjectType object, t_ilm_uint id,
  98                                            t_ilm_bool created, void *user_data)
  99 {
 100   RunXDG *runxdg = static_cast<RunXDG*>(user_data);
 101   runxdg->notify_ivi_control_cb(object, id, created);
 102 }
 103
 104 int POSIXLauncher::launch (std::string& name)
 105 {
 106   pid_t pid;
 107
 108   pid = fork();
 109   if (pid < 0) {
 110     AGL_DEBUG("cannot fork()");
 111     return -1;
 112   }
 113
 114   if (pid == 0) {
 115     // child
 116     const char **argv = new const char * [m_args_v.size() + 1];
 117     for (unsigned int i = 0; i < m_args_v.size(); ++i) {
 118       argv[i] = m_args_v[i].c_str();
 119     }
 120     argv[m_args_v.size()] = NULL;
 121
 122     execv(argv[0], (char **)argv);
 123
 124     AGL_FATAL("fail to execve(%s)", argv[0]);
 125   }
 126   // parent
 127
 128   return pid;
 129 }
 130
 131 void POSIXLauncher::loop (volatile sig_atomic_t& e_flag)
 132 {
 133   int status;
 134   pid_t ret;
 135
 136   while (!e_flag) {
 137     ret = waitpid(m_rid, &status, 0);
 138     if (ret < 0) {
 139       if (errno == EINTR) {
 140         AGL_DEBUG("catch EINTR while waitpid()");
 141         continue;
 142       }
 143       break;
 144     }
 145   }
 146
 147   if (ret > 0) {
 148     if (WIFEXITED(status)) {
 149       AGL_DEBUG("%s terminated, return %d", m_args_v[0].c_str(),
 150                 WEXITSTATUS(status));
 151     }
 152     if (WIFSIGNALED(status)) {
 153       AGL_DEBUG("%s terminated by signal %d", m_args_v[0].c_str(),
 154                 WTERMSIG(status));
 155     }
 156   }
 157
 158   if (e_flag) {
 159     /* parent killed by someone, so need to kill children */
 160     AGL_DEBUG("killpg(0, SIGTERM)");
 161     killpg(0, SIGTERM);
 162   }
 163 }
 164
 165 int AFMDBusLauncher::get_dbus_message_bus (GBusType bus_type,
 166                                            GDBusConnection * &conn)
 167 {
 168   GError* err = NULL;
 169
 170   conn = g_bus_get_sync(bus_type, NULL, &err);
 171   if (err) {
 172     AGL_WARN("Failed to get session bus: %s", err->message);
 173     g_clear_error (&err);
 174     return -1;
 175   }
 176
 177   return 0;
 178 }
 179
 180 int AFMDBusLauncher::launch (std::string &name)
 181 {
 182   GDBusMessage*       msg;
 183   GDBusMessage*       re;
 184   GDBusConnection*    conn;
 185   GError*             err = NULL;
 186   GVariant*           body;
 187   char*               val;
 188   const char*         xdg_app = name.c_str();
 189
 190   if (get_dbus_message_bus(G_BUS_TYPE_SESSION, conn)) {
 191     return -1;
 192   }
 193
 194   msg = g_dbus_message_new_method_call (
 195       DBUS_SERVICE,
 196       DBUS_PATH,
 197       DBUS_INTERFACE,
 198       "start");
 199
 200   if (msg == NULL) {
 201     AGL_WARN("Failed to allocate the dbus message");
 202     g_object_unref(conn);
 203     return -1;
 204   }
 205
 206   g_dbus_message_set_body(msg, g_variant_new("(s)", xdg_app));
 207
 208   re = g_dbus_connection_send_message_with_reply_sync (
 209       conn, msg, G_DBUS_SEND_MESSAGE_FLAGS_NONE, -1, NULL, NULL, &err);
 210
 211   if (err != NULL) {
 212     AGL_WARN("unable to send message: %s", err->message);
 213     g_clear_error(&err);
 214     g_object_unref(conn);
 215     g_object_unref(msg);
 216     return -1;
 217   }
 218
 219   g_dbus_connection_flush_sync(conn, NULL, &err);
 220   if (err != NULL) {
 221     AGL_WARN("unable to flush message queue: %s", err->message);
 222     g_object_unref(conn);
 223     g_object_unref(msg);
 224     g_object_unref(re);
 225     return -1;
 226   }
 227
 228   body = g_dbus_message_get_body(re);
 229   g_variant_get(body, "(&s)", &val);
 230
 231   AGL_DEBUG("dbus message get (%s)", val);
 232
 233   pid_t rid = std::stol(std::string(val));
 234   AGL_DEBUG("RID = %d", rid);
 235
 236   g_object_unref(conn);
 237   g_object_unref(msg);
 238   g_object_unref(re);
 239
 240   return rid;
 241 }
 242
 243 volatile sig_atomic_t e_flag = 0;
 244
 245 static void sigterm_handler (int signum)
 246 {
 247   e_flag = 1;
 248 }
 249
 250 static void init_signal (void)
 251 {
 252   struct sigaction act, info;
 253
 254   /* Setup signal for SIGTERM */
 255   if (!sigaction(SIGTERM, NULL, &info)) {
 256     if (info.sa_handler == SIG_IGN) {
 257       AGL_DEBUG("SIGTERM being ignored.");
 258     } else if (info.sa_handler == SIG_DFL) {
 259       AGL_DEBUG("SIGTERM being defaulted.");
 260     }
 261   }
 262
 263   act.sa_handler = &sigterm_handler;
 264   if (sigemptyset(&act.sa_mask) != 0) {
 265     AGL_FATAL("Cannot initialize sigaction");
 266   }
 267   act.sa_flags = 0;
 268
 269   if (sigaction(SIGTERM, &act, &info) != 0) {
 270     AGL_FATAL("Cannot register signal handler for SIGTERM");
 271   }
 272 }
 273
 274 int RunXDG::init_wm (void)
 275 {
 276   m_wm = new LibWindowmanager();
 277   if (m_wm->init(m_port, m_token.c_str())) {
 278     AGL_DEBUG("cannot initialize windowmanager");
 279     return -1;
 280   }
 281
 282   std::function< void(json_object*) > h_active = [](json_object* object) {
 283     AGL_DEBUG("Got Event_Active");
 284   };
 285
 286   std::function< void(json_object*) > h_inactive = [](json_object* object) {
 287     AGL_DEBUG("Got Event_Inactive");
 288   };
 289
 290   std::function< void(json_object*) > h_visible = [](json_object* object) {
 291     AGL_DEBUG("Got Event_Visible");
 292   };
 293
 294   std::function< void(json_object*) > h_invisible = [](json_object* object) {
 295     AGL_DEBUG("Got Event_Invisible");
 296   };
 297
 298   std::function< void(json_object*) > h_syncdraw =
 299       [this](json_object* object) {
 300     AGL_DEBUG("Got Event_SyncDraw");
 301     json_object* obj = json_object_new_object();
 302     json_object_object_add(obj, this->m_wm->kKeyDrawingName,
 303                            json_object_new_string(this->m_role.c_str()));
 304     this->m_wm->endDraw(obj);
 305   };
 306
 307   std::function< void(json_object*) > h_flushdraw= [](json_object* object) {
 308     AGL_DEBUG("Got Event_FlushDraw");
 309   };
 310
 311   m_wm->set_event_handler(LibWindowmanager::Event_Active, h_active);
 312   m_wm->set_event_handler(LibWindowmanager::Event_Inactive, h_inactive);
 313   m_wm->set_event_handler(LibWindowmanager::Event_Visible, h_visible);
 314   m_wm->set_event_handler(LibWindowmanager::Event_Invisible, h_invisible);
 315   m_wm->set_event_handler(LibWindowmanager::Event_SyncDraw, h_syncdraw);
 316   m_wm->set_event_handler(LibWindowmanager::Event_FlushDraw, h_flushdraw);
 317
 318   return 0;
 319 }
 320
 321 int RunXDG::init_hs (void)
 322 {
 323   m_hs = new LibHomeScreen();
 324   if (m_hs->init(m_port, m_token.c_str())) {
 325     AGL_DEBUG("cannot initialize homescreen");
 326     return -1;
 327   }
 328
 329   std::function< void(json_object*) > handler = [this] (json_object* object) {
 330     json_object *val;
 331
 332     if (json_object_object_get_ex(object, "application_name", &val)) {
 333       const char *name = json_object_get_string(val);
 334
 335       AGL_DEBUG("Event_TapShortcut <%s>", name);
 336
 337           json_object *para, *area;
 338           json_object_object_get_ex(object, "parameter", &para);
 339           json_object_object_get_ex(para, "area", &area);
 340           const char *displayArea = json_object_get_string(area);
 341           AGL_DEBUG("display area=%s",displayArea);
 342
 343       json_object *obj = json_object_new_object();
 344       json_object_object_add(obj, this->m_wm->kKeyDrawingName,
 345                              json_object_new_string(this->m_role.c_str()));
 346       json_object_object_add(obj, this->m_wm->kKeyDrawingArea,
 347                                json_object_new_string(displayArea));
 348           this->m_wm->activateWindow(obj);
 349
 350     }
 351   };
 352   m_hs->set_event_handler(LibHomeScreen::Event_TapShortcut, handler);
 353
 354   std::function< void(json_object*) > h_default= [](json_object* object) {
 355     const char *j_str = json_object_to_json_string(object);
 356     AGL_DEBUG("Got event [%s]", j_str);
 357   };
 358   m_hs->set_event_handler(LibHomeScreen::Event_OnScreenMessage, h_default);
 359
 360   return 0;
 361 }
 362
 363 int RunXDG::parse_config (const char *path_to_config)
 364 {
 365   auto config = cpptoml::parse_file(path_to_config);
 366
 367   if (config == nullptr) {
 368     AGL_DEBUG("cannot parse %s", path_to_config);
 369     return -1;
 370   }
 371
 372   AGL_DEBUG("[%s] parsed", path_to_config);
 373
 374   auto app = config->get_table("application");
 375   if (app == nullptr) {
 376     AGL_DEBUG("cannto find [application]");
 377     return -1;
 378   }
 379
 380   m_role = *(app->get_as<std::string>("role"));
 381   m_path = *(app->get_as<std::string>("path"));
 382   if (m_role.empty() || m_path.empty()) {
 383     AGL_FATAL("No name or path defined in config");
 384   }
 385
 386   std::string method = *(app->get_as<std::string>("method"));
 387   if (method.empty()) {
 388     method = std::string("POSIX");
 389   }
 390
 391   POSIXLauncher *pl;
 392
 393   /* Setup API of launcher */
 394   if (method == "POSIX") {
 395     pl = new POSIXLauncher();
 396     m_launcher = pl;
 397   } else if (method == "AFM_DBUS") {
 398     m_launcher = new AFMDBusLauncher();
 399     return 0;
 400   } else if (method == "AFM_WEBSOCKET") {
 401     m_launcher = new AFMWebSocketLauncher();
 402     return 0;
 403   } else {
 404     AGL_FATAL("Unknown type of launcher");
 405   }
 406
 407   // setup argv[0]
 408   pl->m_args_v.push_back(m_path);
 409
 410   // setup argv[1..n]
 411   auto params = app->get_array_of<std::string>("params");
 412   for (const auto& param : *params)
 413   {
 414     // replace special string "@port@" and "@token@"
 415     size_t found = param.find("@port@");
 416     if (found != std::string::npos) {
 417       std::string sub1 = param.substr(0, found);
 418       std::string sub2 = param.substr(found + 6, param.size() - found);
 419       std::string str = sub1 + std::to_string(m_port) + sub2;
 420       pl->m_args_v.push_back(str);
 421       AGL_DEBUG("params[%s] (match @port@)", str.c_str());
 422       continue;
 423     }
 424
 425     found = param.find("@token@");
 426     if (found != std::string::npos) {
 427       std::string sub1 = param.substr(0, found);
 428       std::string sub2 = param.substr(found + 7, param.size() - found);
 429       std::string str = sub1 + m_token + sub2;
 430       pl->m_args_v.push_back(str);
 431       AGL_DEBUG("params[%s] (match @token@)", str.c_str());
 432       continue;
 433     }
 434
 435     pl->m_args_v.push_back(param);
 436
 437     AGL_DEBUG("params[%s]", param.c_str());
 438   }
 439
 440   return 0;
 441 }
 442
 443 RunXDG::RunXDG (int port, const char* token, const char* id)
 444 {
 445   m_id = std::string(id);
 446   m_port = port;
 447   m_token = std::string(token);
 448   is_first = true;
 449
 450
 451   auto path = std::string(getenv("AFM_APP_INSTALL_DIR"));
 452   path = path + "/" + RUNXDG_CONFIG;
 453
 454   // Parse config file of runxdg
 455   if (parse_config(path.c_str())) {
 456     AGL_FATAL("Error in config");
 457   }
 458
 459   AGL_DEBUG("id=[%s], name=[%s], path=[%s], port=%lu, token=[%s]",
 460             m_id.c_str(), m_role.c_str(), m_path.c_str(),
 461             m_port, m_token.c_str());
 462
 463   // Setup HomeScreen/WindowManager API
 464   if (init_wm())
 465     AGL_FATAL("cannot setup wm API");
 466
 467   if (init_hs())
 468     AGL_FATAL("cannot setup hs API");
 469
 470   // Setup ilmController API
 471   m_ic = new ILMControl(notify_ivi_control_cb_static, this);
 472   AGL_DEBUG("RunXDG created.");
 473 }
 474
 475 void RunXDG::setup_surface (int id)
 476 {
 477   std::string sid = std::to_string(id);
 478
 479   // This surface is mine, register pair app_name and ivi id.
 480   json_object *obj = json_object_new_object();
 481   json_object_object_add(obj, m_wm->kKeyDrawingName,
 482                          json_object_new_string(m_role.c_str()));
 483   json_object_object_add(obj, m_wm->kKeyIviId,
 484                          json_object_new_string(sid.c_str()));
 485
 486   AGL_DEBUG("requestSurfaceXDG(%s,%s)", m_role.c_str(), sid.c_str());
 487   m_wm->requestSurfaceXDG(obj);
 488
 489   if (m_pending_create) {
 490     // Recovering 1st time tap_shortcut is dropped because
 491     // the application has not been run yet (1st time launch)
 492     m_pending_create = false;
 493
 494   AGL_DEBUG("requestSurface(%s,%s)", m_role.c_str(), sid.c_str());
 495     json_object *obj = json_object_new_object();
 496     json_object_object_add(obj, m_wm->kKeyDrawingName,
 497                            json_object_new_string(m_role.c_str()));
 498     json_object_object_add(obj, m_wm->kKeyDrawingArea,
 499                            json_object_new_string("normal.full"));
 500     m_wm->activateWindow(obj);
 501   }
 502 }
 503
 504 void POSIXLauncher::register_surfpid (pid_t surf_pid)
 505 {
 506   if (surf_pid == m_rid) {
 507     if (!std::count(m_pid_v.begin(), m_pid_v.end(), surf_pid)) {
 508       AGL_DEBUG("surface creator(pid=%d) registered", surf_pid);
 509       m_pid_v.push_back(surf_pid);
 510       AGL_DEBUG("m_pid_v.count(%d) = %d", surf_pid,
 511                 std::count(m_pid_v.begin(), m_pid_v.end(), surf_pid));
 512     }
 513   }
 514 }
 515
 516 void POSIXLauncher::unregister_surfpid (pid_t surf_pid)
 517 {
 518   auto itr = m_pid_v.begin();
 519   while (itr != m_pid_v.end()) {
 520     if (*itr == surf_pid) {
 521       m_pid_v.erase(itr++);
 522     } else {
 523       ++itr;
 524     }
 525   }
 526 }
 527
 528 pid_t POSIXLauncher::find_surfpid_by_rid (pid_t rid)
 529 {
 530   if (std::count(m_pid_v.begin(), m_pid_v.end(), rid)) {
 531     AGL_DEBUG("found return(%d)", rid);
 532     return rid;
 533   }
 534
 535   return -1;
 536 }
 537
 538 void AFMLauncher::register_surfpid (pid_t surf_pid)
 539 {
 540   pid_t pgid = 0;
 541
 542   pgid = getpgid(surf_pid);
 543
 544   if (pgid < 0) {
 545     AGL_DEBUG("fail to get process group id");
 546     return;
 547   }
 548
 549   AGL_DEBUG("Surface creator is pid=%d, pgid=%d", surf_pid, pgid);
 550
 551   if (!m_pgids.count(pgid)) {
 552     m_pgids[pgid] = surf_pid;
 553   }
 554 }
 555
 556 void AFMLauncher::unregister_surfpid (pid_t surf_pid)
 557 {
 558   auto itr = m_pgids.begin();
 559   while (itr != m_pgids.end()) {
 560     if (itr->second == surf_pid) {
 561       m_pgids.erase(itr++);
 562     } else {
 563       ++itr;
 564     }
 565   }
 566 }
 567
 568 pid_t AFMLauncher::find_surfpid_by_rid (pid_t rid)
 569 {
 570   auto itr = m_pgids.find(rid);
 571   if (itr != m_pgids.end())
 572     return itr->second;
 573
 574   return -1;
 575 }
 576
 577 void RunXDG::start (void)
 578 {
 579   // Initialize SIGTERM handler
 580   init_signal();
 581
 582   /* Launch XDG application */
 583   m_launcher->m_rid = m_launcher->launch(m_id);
 584   if (m_launcher->m_rid < 0) {
 585     AGL_FATAL("cannot launch XDG app (%s)", m_id);
 586   }
 587
 588   // take care 1st time launch
 589   AGL_DEBUG("waiting for notification: surafce created");
 590   m_pending_create = true;
 591
 592   // in case, target app has already run
 593   if (m_launcher->m_rid) {
 594           AGL_DEBUG("RunXDG::start");
 595     pid_t surf_pid = m_launcher->find_surfpid_by_rid(m_launcher->m_rid);
 596           AGL_DEBUG("surf_pid--=%d",surf_pid);
 597     if (surf_pid > 0) {
 598       AGL_DEBUG("match: surf:pid=%d, afm:rid=%d", surf_pid,
 599                 m_launcher->m_rid);
 600       auto itr = m_surfaces.find(surf_pid);
 601       if (itr != m_surfaces.end()) {
 602         int id = itr->second;
 603         AGL_DEBUG("surface %d for <%s> already exists", id,
 604                   m_role.c_str());
 605         setup_surface(id);
 606       }
 607     }
 608   }
 609   m_launcher->loop(e_flag);
 610 }
 611
 612 int main (int argc, const char* argv[])
 613 {
 614   // Set debug flags
 615   // setenv("USE_HMI_DEBUG", "5", 1);
 616   // setenv("WAYLAND_DEBUG", "1", 1);
 617
 618   // Parse args
 619   int port;
 620   const char *token;
 621
 622   if (argc < 3) {
 623     AGL_FATAL("Missing port and token");
 624   }
 625
 626   // Get app id
 627   const char *afm_id = getenv("AFM_ID");
 628   if (afm_id == NULL || !afm_id[0]) {
 629     afm_id = argv[0];
 630   }
 631
 632   try {
 633     port = std::stol(argv[1]);
 634     token = argv[2];
 635   } catch (const std::invalid_argument& e) {
 636     AGL_FATAL("Invalid argument");
 637   } catch (const std::out_of_range& e) {
 638     AGL_FATAL("Out of range");
 639   }
 640
 641   RunXDG runxdg(port, token, afm_id);
 642
 643   runxdg.start();
 644
 645   return 0;
 646 }