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) 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       m_ivi_id = id;
  87       setup_surface();
  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 = [this](json_object* object) {
 284     AGL_DEBUG("Got Event_Active");
 285     t_ilm_surface s_ids[1] = { this->m_ivi_id };
 286     ilm_setInputFocus(s_ids, 1, ILM_INPUT_DEVICE_KEYBOARD, ILM_TRUE);
 287   };
 288
 289   std::function< void(json_object*) > h_inactive = [this](json_object* object) {
 290     AGL_DEBUG("Got Event_Inactive");
 291     t_ilm_surface s_ids[1] = { this->m_ivi_id };
 292     ilm_setInputFocus(s_ids, 1, ILM_INPUT_DEVICE_KEYBOARD, ILM_FALSE);
 293   };
 294
 295   std::function< void(json_object*) > h_visible = [](json_object* object) {
 296     AGL_DEBUG("Got Event_Visible");
 297   };
 298
 299   std::function< void(json_object*) > h_invisible = [](json_object* object) {
 300     AGL_DEBUG("Got Event_Invisible");
 301   };
 302
 303   std::function< void(json_object*) > h_syncdraw =
 304       [this](json_object* object) {
 305     AGL_DEBUG("Got Event_SyncDraw");
 306     json_object* obj = json_object_new_object();
 307     json_object_object_add(obj, this->m_wm->kKeyDrawingName,
 308                            json_object_new_string(this->m_role.c_str()));
 309     this->m_wm->endDraw(obj);
 310   };
 311
 312   std::function< void(json_object*) > h_flushdraw= [](json_object* object) {
 313     AGL_DEBUG("Got Event_FlushDraw");
 314   };
 315
 316   m_wm->set_event_handler(LibWindowmanager::Event_Active, h_active);
 317   m_wm->set_event_handler(LibWindowmanager::Event_Inactive, h_inactive);
 318   m_wm->set_event_handler(LibWindowmanager::Event_Visible, h_visible);
 319   m_wm->set_event_handler(LibWindowmanager::Event_Invisible, h_invisible);
 320   m_wm->set_event_handler(LibWindowmanager::Event_SyncDraw, h_syncdraw);
 321   m_wm->set_event_handler(LibWindowmanager::Event_FlushDraw, h_flushdraw);
 322
 323   return 0;
 324 }
 325
 326 int RunXDG::init_hs (void)
 327 {
 328   m_hs = new LibHomeScreen();
 329   if (m_hs->init(m_port, m_token.c_str())) {
 330     AGL_DEBUG("cannot initialize homescreen");
 331     return -1;
 332   }
 333
 334   std::function< void(json_object*) > handler = [this] (json_object* object) {
 335     json_object *val;
 336
 337     if (json_object_object_get_ex(object, "application_name", &val)) {
 338       const char *name = json_object_get_string(val);
 339
 340       AGL_DEBUG("Event_TapShortcut <%s>", name);
 341
 342       if (strcmp(name, this->m_role.c_str()) == 0) {
 343         // check app exist and re-launch if needed
 344         AGL_DEBUG("Activesurface %s ", this->m_role.c_str());
 345
 346         json_object *obj = json_object_new_object();
 347         json_object_object_add(obj, this->m_wm->kKeyDrawingName,
 348                                json_object_new_string(this->m_role.c_str()));
 349         json_object_object_add(obj, this->m_wm->kKeyDrawingArea,
 350                                json_object_new_string("normal.full"));
 351
 352         this->m_wm->activateSurface(obj);
 353       }
 354     }
 355   };
 356   m_hs->set_event_handler(LibHomeScreen::Event_TapShortcut, handler);
 357
 358   std::function< void(json_object*) > h_default= [](json_object* object) {
 359     const char *j_str = json_object_to_json_string(object);
 360     AGL_DEBUG("Got event [%s]", j_str);
 361   };
 362   m_hs->set_event_handler(LibHomeScreen::Event_OnScreenMessage, h_default);
 363
 364   return 0;
 365 }
 366
 367 int RunXDG::parse_config (const char *path_to_config)
 368 {
 369   auto config = cpptoml::parse_file(path_to_config);
 370
 371   if (config == nullptr) {
 372     AGL_DEBUG("cannot parse %s", path_to_config);
 373     return -1;
 374   }
 375
 376   AGL_DEBUG("[%s] parsed", path_to_config);
 377
 378   auto app = config->get_table("application");
 379   if (app == nullptr) {
 380     AGL_DEBUG("cannto find [application]");
 381     return -1;
 382   }
 383
 384   m_role = *(app->get_as<std::string>("role"));
 385   m_path = *(app->get_as<std::string>("path"));
 386   if (m_role.empty() || m_path.empty()) {
 387     AGL_FATAL("No name or path defined in config");
 388   }
 389
 390   std::string method = *(app->get_as<std::string>("method"));
 391   if (method.empty()) {
 392     method = std::string("POSIX");
 393   }
 394
 395   POSIXLauncher *pl;
 396
 397   /* Setup API of launcher */
 398   if (method == "POSIX") {
 399     pl = new POSIXLauncher();
 400     m_launcher = pl;
 401   } else if (method == "AFM_DBUS") {
 402     m_launcher = new AFMDBusLauncher();
 403     return 0;
 404   } else if (method == "AFM_WEBSOCKET") {
 405     m_launcher = new AFMWebSocketLauncher();
 406     return 0;
 407   } else {
 408     AGL_FATAL("Unknown type of launcher");
 409   }
 410
 411   // setup argv[0]
 412   pl->m_args_v.push_back(m_path);
 413
 414   // setup argv[1..n]
 415   auto params = app->get_array_of<std::string>("params");
 416   for (const auto& param : *params)
 417   {
 418     // replace special string "@port@" and "@token@"
 419     size_t found = param.find("@port@");
 420     if (found != std::string::npos) {
 421       std::string sub1 = param.substr(0, found);
 422       std::string sub2 = param.substr(found + 6, param.size() - found);
 423       std::string str = sub1 + std::to_string(m_port) + sub2;
 424       pl->m_args_v.push_back(str);
 425       AGL_DEBUG("params[%s] (match @port@)", str.c_str());
 426       continue;
 427     }
 428
 429     found = param.find("@token@");
 430     if (found != std::string::npos) {
 431       std::string sub1 = param.substr(0, found);
 432       std::string sub2 = param.substr(found + 7, param.size() - found);
 433       std::string str = sub1 + m_token + sub2;
 434       pl->m_args_v.push_back(str);
 435       AGL_DEBUG("params[%s] (match @token@)", str.c_str());
 436       continue;
 437     }
 438
 439     pl->m_args_v.push_back(param);
 440
 441     AGL_DEBUG("params[%s]", param.c_str());
 442   }
 443
 444   return 0;
 445 }
 446
 447 RunXDG::RunXDG (int port, const char* token, const char* id)
 448 {
 449   m_id = std::string(id);
 450   m_port = port;
 451   m_token = std::string(token);
 452
 453
 454   auto path = std::string(getenv("AFM_APP_INSTALL_DIR"));
 455   path = path + "/" + RUNXDG_CONFIG;
 456
 457   // Parse config file of runxdg
 458   if (parse_config(path.c_str())) {
 459     AGL_FATAL("Error in config");
 460   }
 461
 462   AGL_DEBUG("id=[%s], name=[%s], path=[%s], port=%lu, token=[%s]",
 463             m_id.c_str(), m_role.c_str(), m_path.c_str(),
 464             m_port, m_token.c_str());
 465
 466   // Setup HomeScreen/WindowManager API
 467   if (init_wm())
 468     AGL_FATAL("cannot setup wm API");
 469
 470   if (init_hs())
 471     AGL_FATAL("cannot setup hs API");
 472
 473   // Setup ilmController API
 474   m_ic = new ILMControl(notify_ivi_control_cb_static, this);
 475
 476   AGL_DEBUG("RunXDG created.");
 477 }
 478
 479 void RunXDG::setup_surface (void)
 480 {
 481   std::string sid = std::to_string(m_ivi_id);
 482
 483   // This surface is mine, register pair app_name and ivi id.
 484   json_object *obj = json_object_new_object();
 485   json_object_object_add(obj, m_wm->kKeyDrawingName,
 486                          json_object_new_string(m_role.c_str()));
 487   json_object_object_add(obj, m_wm->kKeyIviId,
 488                          json_object_new_string(sid.c_str()));
 489
 490   AGL_DEBUG("requestSurfaceXDG(%s,%s)", m_role.c_str(), sid.c_str());
 491   m_wm->requestSurfaceXDG(obj);
 492
 493   if (m_pending_create) {
 494     // Recovering 1st time tap_shortcut is dropped because
 495     // the application has not been run yet (1st time launch)
 496     m_pending_create = false;
 497
 498     json_object *obj = json_object_new_object();
 499     json_object_object_add(obj, m_wm->kKeyDrawingName,
 500                            json_object_new_string(m_role.c_str()));
 501     json_object_object_add(obj, m_wm->kKeyDrawingArea,
 502                            json_object_new_string("normal.full"));
 503     m_wm->activateSurface(obj);
 504   }
 505 }
 506
 507 void POSIXLauncher::register_surfpid (pid_t surf_pid)
 508 {
 509   if (surf_pid == m_rid) {
 510     if (!std::count(m_pid_v.begin(), m_pid_v.end(), surf_pid)) {
 511       AGL_DEBUG("surface creator(pid=%d) registered", surf_pid);
 512       m_pid_v.push_back(surf_pid);
 513       AGL_DEBUG("m_pid_v.count(%d) = %d", surf_pid,
 514                 std::count(m_pid_v.begin(), m_pid_v.end(), surf_pid));
 515     }
 516   }
 517 }
 518
 519 void POSIXLauncher::unregister_surfpid (pid_t surf_pid)
 520 {
 521   auto itr = m_pid_v.begin();
 522   while (itr != m_pid_v.end()) {
 523     if (*itr == surf_pid) {
 524       m_pid_v.erase(itr++);
 525     } else {
 526       ++itr;
 527     }
 528   }
 529 }
 530
 531 pid_t POSIXLauncher::find_surfpid_by_rid (pid_t rid)
 532 {
 533   AGL_DEBUG("find surfpid by rid(%d)", rid);
 534   if (std::count(m_pid_v.begin(), m_pid_v.end(), rid)) {
 535     AGL_DEBUG("found return(%d)", rid);
 536     return rid;
 537   }
 538
 539   return -1;
 540 }
 541
 542 void AFMLauncher::register_surfpid (pid_t surf_pid)
 543 {
 544   pid_t pgid = 0;
 545
 546   pgid = getpgid(surf_pid);
 547
 548   if (pgid < 0) {
 549     AGL_DEBUG("fail to get process group id");
 550     return;
 551   }
 552
 553   AGL_DEBUG("Surface creator is pid=%d, pgid=%d", surf_pid, pgid);
 554
 555   if (!m_pgids.count(pgid)) {
 556     m_pgids[pgid] = surf_pid;
 557   }
 558 }
 559
 560 void AFMLauncher::unregister_surfpid (pid_t surf_pid)
 561 {
 562   auto itr = m_pgids.begin();
 563   while (itr != m_pgids.end()) {
 564     if (itr->second == surf_pid) {
 565       m_pgids.erase(itr++);
 566     } else {
 567       ++itr;
 568     }
 569   }
 570 }
 571
 572 pid_t AFMLauncher::find_surfpid_by_rid (pid_t rid)
 573 {
 574   auto itr = m_pgids.find(rid);
 575   if (itr != m_pgids.end())
 576     return itr->second;
 577
 578   return -1;
 579 }
 580
 581 void RunXDG::start (void)
 582 {
 583   // Initialize SIGTERM handler
 584   init_signal();
 585
 586   /* Launch XDG application */
 587   m_launcher->m_rid = m_launcher->launch(m_id);
 588   if (m_launcher->m_rid < 0) {
 589     AGL_FATAL("cannot launch XDG app (%s)", m_id);
 590   }
 591
 592   // take care 1st time launch
 593   AGL_DEBUG("waiting for notification: surafce created");
 594   m_pending_create = true;
 595
 596   ilm_commitChanges();
 597
 598   // in case, target app has already run
 599   if (m_launcher->m_rid) {
 600     pid_t surf_pid = m_launcher->find_surfpid_by_rid(m_launcher->m_rid);
 601     if (surf_pid > 0) {
 602       AGL_DEBUG("match: surf:pid=%d, afm:rid=%d", surf_pid,
 603                 m_launcher->m_rid);
 604       auto itr = m_surfaces.find(surf_pid);
 605       if (itr != m_surfaces.end()) {
 606         int id = itr->second;
 607         AGL_DEBUG("surface %d for <%s> already exists", id,
 608                   m_role.c_str());
 609         m_ivi_id = id;
 610         setup_surface();
 611       }
 612     }
 613   }
 614
 615   ilm_commitChanges();
 616   m_launcher->loop(e_flag);
 617 }
 618
 619 int main (int argc, const char* argv[])
 620 {
 621   // Set debug flags
 622   // setenv("USE_HMI_DEBUG", "5", 1);
 623   // setenv("WAYLAND_DEBUG", "1", 1);
 624
 625   // Parse args
 626   int port;
 627   const char *token;
 628
 629   if (argc < 3) {
 630     AGL_FATAL("Missing port and token");
 631   }
 632
 633   // Get app id
 634   const char *afm_id = getenv("AFM_ID");
 635   if (afm_id == NULL || !afm_id[0]) {
 636     afm_id = argv[0];
 637   }
 638
 639   try {
 640     port = std::stol(argv[1]);
 641     token = argv[2];
 642   } catch (const std::invalid_argument& e) {
 643     AGL_FATAL("Invalid argument");
 644   } catch (const std::out_of_range& e) {
 645     AGL_FATAL("Out of range");
 646   }
 647
 648   RunXDG runxdg(port, token, afm_id);
 649
 650   runxdg.start();
 651
 652   return 0;
 653 }