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 <algorithm>
  32 #include <cstdio>
  33
  34 #include "cpptoml/cpptoml.h"
  35
  36 #include "runxdg.hpp"
  37
  38 #define RUNXDG_CONFIG "runxdg.toml"
  39
  40 void fatal(const char* format, ...)
  41 {
  42   va_list va_args;
  43   va_start(va_args, format);
  44   vfprintf(stderr, format, va_args);
  45   va_end(va_args);
  46
  47   exit(EXIT_FAILURE);
  48 }
  49
  50 void warn(const char* format, ...)
  51 {
  52   va_list va_args;
  53   va_start(va_args, format);
  54   vfprintf(stderr, format, va_args);
  55   va_end(va_args);
  56 }
  57
  58 void debug(const char* format, ...)
  59 {
  60   va_list va_args;
  61   va_start(va_args, format);
  62   vfprintf(stderr, format, va_args);
  63   va_end(va_args);
  64 }
  65
  66 void RunXDG::notify_ivi_control_cb (ilmObjectType object, t_ilm_uint id,
  67                                     t_ilm_bool created)
  68 {
  69   if (object == ILM_SURFACE) {
  70     struct ilmSurfaceProperties surf_props;
  71
  72     ilm_getPropertiesOfSurface(id, &surf_props);
  73     pid_t surf_pid = surf_props.creatorPid;
  74
  75     if (!created) {
  76       AGL_DEBUG("ivi surface (id=%d, pid=%d) destroyed.", id, surf_pid);
  77       m_launcher->unregister_surfpid(surf_pid);
  78       m_surfaces.erase(surf_pid);
  79       return;
  80     }
  81
  82     AGL_DEBUG("ivi surface (id=%d, pid=%d) is created.", id, surf_pid);
  83
  84     m_launcher->register_surfpid(surf_pid);
  85     if (m_launcher->m_rid &&
  86         surf_pid == m_launcher->find_surfpid_by_rid(m_launcher->m_rid)) {
  87       setup_surface(id);
  88     }
  89     m_surfaces[surf_pid] = id;
  90   } else if (object == ILM_LAYER) {
  91     if (created)
  92       AGL_DEBUG("ivi layer: %d created.", id);
  93     else
  94       AGL_DEBUG("ivi layer: %d destroyed.", id);
  95   }
  96 }
  97
  98 void RunXDG::notify_ivi_control_cb_static (ilmObjectType object, t_ilm_uint id,
  99                                            t_ilm_bool created, void *user_data)
 100 {
 101   RunXDG *runxdg = static_cast<RunXDG*>(user_data);
 102   runxdg->notify_ivi_control_cb(object, id, created);
 103 }
 104
 105 int POSIXLauncher::launch (std::string& name)
 106 {
 107   pid_t pid;
 108
 109   pid = fork();
 110   if (pid < 0) {
 111     AGL_DEBUG("cannot fork()");
 112     return -1;
 113   }
 114
 115   if (pid == 0) {
 116     // child
 117     const char **argv = new const char * [m_args_v.size() + 1];
 118     for (unsigned int i = 0; i < m_args_v.size(); ++i) {
 119       argv[i] = m_args_v[i].c_str();
 120     }
 121     argv[m_args_v.size()] = NULL;
 122
 123     execv(argv[0], (char **)argv);
 124
 125     AGL_FATAL("fail to execve(%s)", argv[0]);
 126   }
 127   // parent
 128
 129   return pid;
 130 }
 131
 132 void POSIXLauncher::loop (volatile sig_atomic_t& e_flag)
 133 {
 134   int status;
 135   pid_t ret;
 136
 137   while (!e_flag) {
 138     ret = waitpid(m_rid, &status, 0);
 139     if (ret < 0) {
 140       if (errno == EINTR) {
 141         AGL_DEBUG("catch EINTR while waitpid()");
 142         continue;
 143       }
 144       break;
 145     }
 146   }
 147
 148   if (ret > 0) {
 149     if (WIFEXITED(status)) {
 150       AGL_DEBUG("%s terminated, return %d", m_args_v[0].c_str(),
 151                 WEXITSTATUS(status));
 152     }
 153     if (WIFSIGNALED(status)) {
 154       AGL_DEBUG("%s terminated by signal %d", m_args_v[0].c_str(),
 155                 WTERMSIG(status));
 156     }
 157   }
 158
 159   if (e_flag) {
 160     /* parent killed by someone, so need to kill children */
 161     AGL_DEBUG("killpg(0, SIGTERM)");
 162     killpg(0, SIGTERM);
 163   }
 164 }
 165
 166 int AFMDBusLauncher::get_dbus_message_bus (GBusType bus_type,
 167                                            GDBusConnection * &conn)
 168 {
 169   GError* err = NULL;
 170
 171   conn = g_bus_get_sync(bus_type, NULL, &err);
 172   if (err) {
 173     AGL_WARN("Failed to get session bus: %s", err->message);
 174     g_clear_error (&err);
 175     return -1;
 176   }
 177
 178   return 0;
 179 }
 180
 181 int AFMDBusLauncher::launch (std::string &name)
 182 {
 183   GDBusMessage*       msg;
 184   GDBusMessage*       re;
 185   GDBusConnection*    conn;
 186   GError*             err = NULL;
 187   GVariant*           body;
 188   char*               val;
 189   const char*         xdg_app = name.c_str();
 190
 191   if (get_dbus_message_bus(G_BUS_TYPE_SESSION, conn)) {
 192     return -1;
 193   }
 194
 195   msg = g_dbus_message_new_method_call (
 196       DBUS_SERVICE,
 197       DBUS_PATH,
 198       DBUS_INTERFACE,
 199       "start");
 200
 201   if (msg == NULL) {
 202     AGL_WARN("Failed to allocate the dbus message");
 203     g_object_unref(conn);
 204     return -1;
 205   }
 206
 207   g_dbus_message_set_body(msg, g_variant_new("(s)", xdg_app));
 208
 209   re = g_dbus_connection_send_message_with_reply_sync (
 210       conn, msg, G_DBUS_SEND_MESSAGE_FLAGS_NONE, -1, NULL, NULL, &err);
 211
 212   if (err != NULL) {
 213     AGL_WARN("unable to send message: %s", err->message);
 214     g_clear_error(&err);
 215     g_object_unref(conn);
 216     g_object_unref(msg);
 217     return -1;
 218   }
 219
 220   g_dbus_connection_flush_sync(conn, NULL, &err);
 221   if (err != NULL) {
 222     AGL_WARN("unable to flush message queue: %s", err->message);
 223     g_object_unref(conn);
 224     g_object_unref(msg);
 225     g_object_unref(re);
 226     return -1;
 227   }
 228
 229   body = g_dbus_message_get_body(re);
 230   g_variant_get(body, "(&s)", &val);
 231
 232   AGL_DEBUG("dbus message get (%s)", val);
 233
 234   pid_t rid = std::stol(std::string(val));
 235   AGL_DEBUG("RID = %d", rid);
 236
 237   g_object_unref(conn);
 238   g_object_unref(msg);
 239   g_object_unref(re);
 240
 241   return rid;
 242 }
 243
 244 volatile sig_atomic_t e_flag = 0;
 245
 246 static void sigterm_handler (int signum)
 247 {
 248   e_flag = 1;
 249 }
 250
 251 static void init_signal (void)
 252 {
 253   struct sigaction act, info;
 254
 255   /* Setup signal for SIGTERM */
 256   if (!sigaction(SIGTERM, NULL, &info)) {
 257     if (info.sa_handler == SIG_IGN) {
 258       AGL_DEBUG("SIGTERM being ignored.");
 259     } else if (info.sa_handler == SIG_DFL) {
 260       AGL_DEBUG("SIGTERM being defaulted.");
 261     }
 262   }
 263
 264   act.sa_handler = &sigterm_handler;
 265   if (sigemptyset(&act.sa_mask) != 0) {
 266     AGL_FATAL("Cannot initialize sigaction");
 267   }
 268   act.sa_flags = 0;
 269
 270   if (sigaction(SIGTERM, &act, &info) != 0) {
 271     AGL_FATAL("Cannot register signal handler for SIGTERM");
 272   }
 273 }
 274
 275 int RunXDG::init_wm (void)
 276 {
 277   m_wm = new LibWindowmanager();
 278   if (m_wm->init(m_port, m_token.c_str())) {
 279     AGL_DEBUG("cannot initialize windowmanager");
 280     return -1;
 281   }
 282
 283   std::function< void(json_object*) > h_active = [](json_object* object) {
 284     AGL_DEBUG("Got Event_Active");
 285   };
 286
 287   std::function< void(json_object*) > h_inactive = [](json_object* object) {
 288     AGL_DEBUG("Got Event_Inactive");
 289   };
 290
 291   std::function< void(json_object*) > h_visible = [](json_object* object) {
 292     AGL_DEBUG("Got Event_Visible");
 293   };
 294
 295   std::function< void(json_object*) > h_invisible = [](json_object* object) {
 296     AGL_DEBUG("Got Event_Invisible");
 297   };
 298
 299   std::function< void(json_object*) > h_syncdraw =
 300       [this](json_object* object) {
 301     AGL_DEBUG("Got Event_SyncDraw");
 302     json_object* obj = json_object_new_object();
 303     json_object_object_add(obj, this->m_wm->kKeyDrawingName,
 304                            json_object_new_string(this->m_role.c_str()));
 305     this->m_wm->endDraw(obj);
 306   };
 307
 308   std::function< void(json_object*) > h_flushdraw= [](json_object* object) {
 309     AGL_DEBUG("Got Event_FlushDraw");
 310   };
 311
 312   m_wm->set_event_handler(LibWindowmanager::Event_Active, h_active);
 313   m_wm->set_event_handler(LibWindowmanager::Event_Inactive, h_inactive);
 314   m_wm->set_event_handler(LibWindowmanager::Event_Visible, h_visible);
 315   m_wm->set_event_handler(LibWindowmanager::Event_Invisible, h_invisible);
 316   m_wm->set_event_handler(LibWindowmanager::Event_SyncDraw, h_syncdraw);
 317   m_wm->set_event_handler(LibWindowmanager::Event_FlushDraw, h_flushdraw);
 318
 319   return 0;
 320 }
 321
 322 int RunXDG::init_hs (void)
 323 {
 324   m_hs = new LibHomeScreen();
 325   if (m_hs->init(m_port, m_token.c_str())) {
 326     AGL_DEBUG("cannot initialize homescreen");
 327     return -1;
 328   }
 329
 330   std::function< void(json_object*) > handler = [this] (json_object* object) {
 331     json_object *val;
 332
 333     if (json_object_object_get_ex(object, "application_name", &val)) {
 334       const char *name = json_object_get_string(val);
 335
 336       AGL_DEBUG("Event_TapShortcut <%s>", name);
 337
 338       if (strcmp(name, this->m_role.c_str()) == 0) {
 339         // check app exist and re-launch if needed
 340         AGL_DEBUG("Activesurface %s ", this->m_role.c_str());
 341
 342         json_object *obj = json_object_new_object();
 343         json_object_object_add(obj, this->m_wm->kKeyDrawingName,
 344                                json_object_new_string(this->m_role.c_str()));
 345         json_object_object_add(obj, this->m_wm->kKeyDrawingArea,
 346                                json_object_new_string("normal.full"));
 347
 348         this->m_wm->activateSurface(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
 449
 450   auto path = std::string(getenv("AFM_APP_INSTALL_DIR"));
 451   path = path + "/" + RUNXDG_CONFIG;
 452
 453   // Parse config file of runxdg
 454   if (parse_config(path.c_str())) {
 455     AGL_FATAL("Error in config");
 456   }
 457
 458   AGL_DEBUG("id=[%s], name=[%s], path=[%s], port=%lu, token=[%s]",
 459             m_id.c_str(), m_role.c_str(), m_path.c_str(),
 460             m_port, m_token.c_str());
 461
 462   // Setup HomeScreen/WindowManager API
 463   if (init_wm())
 464     AGL_FATAL("cannot setup wm API");
 465
 466   if (init_hs())
 467     AGL_FATAL("cannot setup hs API");
 468
 469   // Setup ilmController API
 470   m_ic = new ILMControl(notify_ivi_control_cb_static, this);
 471
 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     json_object *obj = json_object_new_object();
 495     json_object_object_add(obj, m_wm->kKeyDrawingName,
 496                            json_object_new_string(m_role.c_str()));
 497     json_object_object_add(obj, m_wm->kKeyDrawingArea,
 498                            json_object_new_string("normal.full"));
 499     m_wm->activateSurface(obj);
 500   }
 501 }
 502
 503 void POSIXLauncher::register_surfpid (pid_t surf_pid)
 504 {
 505   if (surf_pid == m_rid) {
 506     if (!std::count(m_pid_v.begin(), m_pid_v.end(), surf_pid)) {
 507       AGL_DEBUG("surface creator(pid=%d) registered", surf_pid);
 508       m_pid_v.push_back(surf_pid);
 509       AGL_DEBUG("m_pid_v.count(%d) = %d", surf_pid,
 510                 std::count(m_pid_v.begin(), m_pid_v.end(), surf_pid));
 511     }
 512   }
 513 }
 514
 515 void POSIXLauncher::unregister_surfpid (pid_t surf_pid)
 516 {
 517   auto beg = m_pid_v.begin();
 518   auto end = m_pid_v.end();
 519   m_pid_v.erase(std::remove(beg, end, surf_pid), end);
 520   AGL_DEBUG("Unregistered surface (id=%d sz=%u)", surf_pid, m_pid_v.size());
 521 }
 522
 523 pid_t POSIXLauncher::find_surfpid_by_rid (pid_t rid)
 524 {
 525   AGL_DEBUG("find surfpid by rid(%d)", rid);
 526   if (std::count(m_pid_v.begin(), m_pid_v.end(), rid)) {
 527     AGL_DEBUG("found return(%d)", rid);
 528     return rid;
 529   }
 530
 531   return -1;
 532 }
 533
 534 void AFMLauncher::register_surfpid (pid_t surf_pid)
 535 {
 536   pid_t pgid = 0;
 537
 538   pgid = getpgid(surf_pid);
 539
 540   if (pgid < 0) {
 541     AGL_DEBUG("fail to get process group id");
 542     return;
 543   }
 544
 545   AGL_DEBUG("Surface creator is pid=%d, pgid=%d", surf_pid, pgid);
 546
 547   if (!m_pgids.count(pgid)) {
 548     m_pgids[pgid] = surf_pid;
 549   }
 550 }
 551
 552 void AFMLauncher::unregister_surfpid (pid_t surf_pid)
 553 {
 554   auto itr = m_pgids.begin();
 555   while (itr != m_pgids.end()) {
 556     if (itr->second == surf_pid) {
 557       m_pgids.erase(itr++);
 558     } else {
 559       ++itr;
 560     }
 561   }
 562 }
 563
 564 pid_t AFMLauncher::find_surfpid_by_rid (pid_t rid)
 565 {
 566   auto itr = m_pgids.find(rid);
 567   if (itr != m_pgids.end())
 568     return itr->second;
 569
 570   return -1;
 571 }
 572
 573 void RunXDG::start (void)
 574 {
 575   // Initialize SIGTERM handler
 576   init_signal();
 577
 578   /* Launch XDG application */
 579   m_launcher->m_rid = m_launcher->launch(m_id);
 580   if (m_launcher->m_rid < 0) {
 581     AGL_FATAL("cannot launch XDG app (%s)", m_id);
 582   }
 583
 584   // take care 1st time launch
 585   AGL_DEBUG("waiting for notification: surafce created");
 586   m_pending_create = true;
 587
 588   // in case, target app has already run
 589   if (m_launcher->m_rid) {
 590     pid_t surf_pid = m_launcher->find_surfpid_by_rid(m_launcher->m_rid);
 591     if (surf_pid > 0) {
 592       AGL_DEBUG("match: surf:pid=%d, afm:rid=%d", surf_pid,
 593                 m_launcher->m_rid);
 594       auto itr = m_surfaces.find(surf_pid);
 595       if (itr != m_surfaces.end()) {
 596         int id = itr->second;
 597         AGL_DEBUG("surface %d for <%s> already exists", id,
 598                   m_role.c_str());
 599         setup_surface(id);
 600       }
 601     }
 602   }
 603   m_launcher->loop(e_flag);
 604 }
 605
 606 int main (int argc, const char* argv[])
 607 {
 608   // Set debug flags
 609   // setenv("USE_HMI_DEBUG", "5", 1);
 610   // setenv("WAYLAND_DEBUG", "1", 1);
 611
 612   // Parse args
 613   int port;
 614   const char *token;
 615
 616   if (argc < 3) {
 617     AGL_FATAL("Missing port and token");
 618   }
 619
 620   // Get app id
 621   const char *afm_id = getenv("AFM_ID");
 622   if (afm_id == NULL || !afm_id[0]) {
 623     afm_id = argv[0];
 624   }
 625
 626   try {
 627     port = std::stol(argv[1]);
 628     token = argv[2];
 629   } catch (const std::invalid_argument& e) {
 630     AGL_FATAL("Invalid argument");
 631   } catch (const std::out_of_range& e) {
 632     AGL_FATAL("Out of range");
 633   }
 634
 635   RunXDG runxdg(port, token, afm_id);
 636
 637   runxdg.start();
 638
 639   return 0;
 640 }