src/widget_app.c

   1 /*
   2  * Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #include <stdlib.h>
  19
  20 #include <bundle.h>
  21 #include <bundle_internal.h>
  22 #include <aul.h>
  23 #include <dlog.h>
  24 #include <glib.h>
  25 #include <glib-object.h>
  26 #include <stdlib.h>
  27 #include <app_control.h>
  28 #include <app_control_internal.h>
  29 #include <Elementary.h>
  30 #include <widget_errno.h>
  31 #include <widget_instance.h>
  32 #include <widget_service_internal.h>
  33 #include <aul_app_com.h>
  34 #include <Ecore_Wayland.h>
  35 #include <system_info.h>
  36
  37 #include "widget_app.h"
  38 #include "widget-log.h"
  39 #include "widget-private.h"
  40 #include "widget_app_internal.h"
  41
  42 #ifdef LOG_TAG
  43 #undef LOG_TAG
  44 #endif
  45
  46 #define STR_MAX_BUF 128
  47 #define LOG_TAG "CAPI_WIDGET_APPLICATION"
  48 #define K_REASON    "__WC_K_REASON__"
  49
  50 typedef enum _widget_obj_state_e {
  51         WC_READY = 0,
  52         WC_RUNNING = 1,
  53         WC_PAUSED = 2,
  54         WC_TERMINATED = 3
  55 } widget_obj_state_e;
  56
  57 struct app_event_handler {
  58         app_event_type_e type;
  59         app_event_cb cb;
  60         void *data;
  61 };
  62
  63 struct app_event_info {
  64         app_event_type_e type;
  65         void *value;
  66 };
  67
  68 struct _widget_class {
  69         void *user_data;
  70         widget_instance_lifecycle_callback_s ops;
  71         char *classid;
  72         struct _widget_class *next;
  73         struct _widget_class *prev;
  74 };
  75
  76 struct _widget_context {
  77         char *id;
  78         struct _widget_class *provider;
  79         int state;
  80         void *tag;
  81         Evas_Object *win;
  82         bundle *content;
  83         widget_instance_lifecycle_callback_s ops;
  84 };
  85
  86 typedef struct _widget_class widget_class_s;
  87 typedef struct _widget_context widget_context_s;
  88
  89 static int caller_pid = 0;
  90 static widget_app_lifecycle_callback_s *app_ops;
  91 static void *app_user_data = NULL;
  92 static char *appid = NULL;
  93 static widget_class_h class_provider = NULL;
  94 static GList *contexts = NULL;
  95 static char *viewer_endpoint = NULL;
  96
  97 static inline bool _is_widget_feature_enabled(void)
  98 {
  99         static bool feature = false;
 100         static bool retrieved = false;
 101         int ret;
 102
 103         if (retrieved == true)
 104                 return feature;
 105
 106         ret = system_info_get_platform_bool(
 107                         "http://tizen.org/feature/shell.appwidget", &feature);
 108         if (ret != SYSTEM_INFO_ERROR_NONE) {
 109                 _E("failed to get system info");
 110                 return false;
 111         }
 112
 113         retrieved = true;
 114
 115         return feature;
 116 }
 117
 118 static gint __comp_by_id(gconstpointer a, gconstpointer b)
 119 {
 120         widget_context_s *wc = (widget_context_s*)a;
 121
 122         return strcmp(wc->id, (const char*)b);
 123 }
 124
 125 static widget_context_s* __find_context_by_id(const char *id)
 126 {
 127         GList* ret = g_list_find_custom(contexts, id, __comp_by_id);
 128
 129         if (ret == NULL)
 130                 return NULL;
 131
 132         return ret->data;
 133 }
 134
 135 static int __send_update_status(const char *class_id, const char *instance_id,
 136         int status, bundle *extra, int internal_only)
 137 {
 138         bundle *b = extra;
 139
 140         if (b == NULL)
 141                 b = bundle_create();
 142
 143         bundle_add_str(b, WIDGET_K_ID, class_id);
 144         bundle_add_str(b, WIDGET_K_INSTANCE, instance_id);
 145         bundle_add_byte(b, WIDGET_K_STATUS, &status, sizeof(int));
 146
 147         aul_app_com_send(viewer_endpoint, b);
 148
 149         if (extra == NULL)
 150                 bundle_free(b);
 151
 152         return 0;
 153 }
 154
 155 static int __instance_create(widget_class_h handle, const char *id, bundle *b)
 156 {
 157         widget_context_s *wc = NULL;
 158         int w = 0, h = 0;
 159         char *w_str = NULL, *h_str = NULL;
 160         char *remain = NULL;
 161         int ret = 0;
 162
 163         wc = (widget_context_s *)malloc(sizeof(widget_context_s));
 164         if (!wc)
 165                 return WIDGET_ERROR_OUT_OF_MEMORY;
 166
 167         wc->state = WC_READY;
 168         wc->id = g_strdup(id);
 169         wc->provider = handle;
 170         wc->win = NULL;
 171
 172         wc->content = bundle_dup(b);
 173         bundle_get_str(b, WIDGET_K_WIDTH, &w_str);
 174         bundle_get_str(b, WIDGET_K_HEIGHT, &h_str);
 175
 176         if (w_str)
 177                 w = (int)g_ascii_strtoll(w_str, &remain, 10);
 178
 179         if (h_str)
 180                 h = (int)g_ascii_strtoll(h_str, &remain, 10);
 181
 182         contexts = g_list_append(contexts, wc);
 183
 184         handle->ops.create(wc, b, w, h, handle->user_data);
 185
 186         ret = __send_update_status(handle->classid, wc->id, WIDGET_INSTANCE_EVENT_CREATE, b, 0);
 187
 188         return ret;
 189 }
 190
 191 static int __instance_destroy(widget_class_h handle, const char *id, widget_destroy_type_e reason, bundle *b)
 192 {
 193         widget_context_s *wc = __find_context_by_id(id);
 194         int ret = 0;
 195
 196         if (wc) {
 197                 wc->state = WC_TERMINATED;
 198                 handle->ops.destroy(wc, (widget_app_destroy_type_e)reason, b, handle->user_data);
 199
 200                 ret = __send_update_status(handle->classid, id, WIDGET_INSTANCE_EVENT_TERMINATE, b, 0);
 201
 202                 contexts = g_list_remove(contexts, wc);
 203
 204                 if (wc->id)
 205                         free(wc->id);
 206                 free(wc);
 207         } else {
 208                 _E("could not find widget obj: %s", id);
 209                 ret = WIDGET_ERROR_INVALID_PARAMETER;
 210         }
 211
 212         return ret;
 213 }
 214
 215 static widget_class_h __find_class_handler(const char *class_id, widget_class_h handle)
 216 {
 217         if (!class_id || !handle)
 218                 return NULL;
 219
 220         widget_class_h head = handle;
 221
 222         while (head) {
 223                 if (head->classid && strcmp(head->classid, class_id) == 0)
 224                         return head;
 225
 226                 head = head->next;
 227         }
 228
 229         return NULL;
 230 }
 231
 232 static void __control(bundle *b)
 233 {
 234         char *class_id = NULL;
 235         char *id = NULL;
 236         char *operation = NULL;
 237         char *reason = NULL;
 238         char *remain = NULL;
 239         int destroy_type = WIDGET_DESTROY_TYPE_DEFAULT;
 240
 241         widget_class_h handle = NULL;
 242         bundle_get_str(b, WIDGET_K_CLASS, &class_id);
 243         /* for previous version compatibility, use appid for default class id */
 244         if (class_id == NULL)
 245                 class_id = appid;
 246
 247         bundle_get_str(b, WIDGET_K_INSTANCE, &id);
 248         bundle_get_str(b, WIDGET_K_OPERATION, &operation);
 249
 250         handle = __find_class_handler(class_id, class_provider);
 251         if (!handle) {
 252                 _E("no handle provided: %s", class_id);
 253                 goto error;
 254         }
 255
 256         if (!operation) {
 257                 _E("no operation provided");
 258                 goto error;
 259         }
 260
 261         if (strcmp(operation, "create") == 0) {
 262                 __instance_create(handle, id, b);
 263         } else if (strcmp(operation, "resize") == 0) {
 264                 /* TODO */
 265         } else if (strcmp(operation, "update") == 0) {
 266                 /* TODO */
 267         } else if (strcmp(operation, "destroy") == 0) {
 268                 bundle_get_str(b, WIDGET_K_REASON, &reason);
 269                 if (reason)
 270                         destroy_type = (int)g_ascii_strtoll(reason, &remain, 10);
 271
 272                 __instance_destroy(handle, id, destroy_type, b);
 273         } else if (strcmp(operation, "resume") == 0) {
 274                 /* TODO */
 275         } else if (strcmp(operation, "pause") == 0) {
 276                 /* TODO */
 277         }
 278
 279         return;
 280 error:
 281         LOGD("error on control");
 282         return;
 283 }
 284
 285 static void __show_all()
 286 {
 287         LOGD("resume");
 288 }
 289
 290 static int __aul_handler(aul_type type, bundle *b, void *data)
 291 {
 292         char *caller = NULL;
 293         char *remain = NULL;
 294
 295         switch (type) {
 296         case AUL_START:
 297                 if (b) {
 298                         bundle_get_str(b, WIDGET_K_CALLER, &caller);
 299                         if (caller)
 300                                 caller_pid = g_ascii_strtoll(caller, &remain, 10);
 301                         else {
 302                                 /* using caller appid and query pid using caller appid? */
 303                                 _E("no caller pid");
 304                         }
 305                 }
 306
 307                 __control(b);
 308                 break;
 309         case AUL_RESUME:
 310                 __show_all();
 311                 break;
 312         case AUL_TERMINATE:
 313                 widget_app_exit();
 314                 break;
 315         default:
 316                 break;
 317         }
 318
 319         return 0;
 320 }
 321
 322
 323 static int __before_loop(int argc, char **argv)
 324 {
 325         int r;
 326         bundle *kb = NULL;
 327         char *wayland_display = NULL;
 328         char *xdg_runtime_dir = NULL;
 329
 330 #if !(GLIB_CHECK_VERSION(2, 36, 0))
 331         g_type_init();
 332 #endif
 333
 334         kb = bundle_import_from_argv(argc, argv);
 335         if (kb) {
 336                 bundle_get_str(kb, AUL_K_WAYLAND_WORKING_DIR, &xdg_runtime_dir);
 337                 bundle_get_str(kb, AUL_K_WAYLAND_DISPLAY, &wayland_display);
 338                 bundle_get_str(kb, WIDGET_K_ENDPOINT, &viewer_endpoint);
 339
 340                 if (xdg_runtime_dir)
 341                         setenv("XDG_RUNTIME_DIR", xdg_runtime_dir, 1);
 342
 343                 if (wayland_display)
 344                         setenv("WAYLAND_DISPLAY", wayland_display, 1);
 345
 346                 bundle_free(kb);
 347                 kb = NULL;
 348         } else {
 349                 _E("failed to get launch argv");
 350         }
 351
 352         elm_init(argc, argv);
 353
 354         r = aul_launch_init(__aul_handler, NULL);
 355         if (r < 0) {
 356                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__,
 357                                         "Fail to call the aul_launch_init");
 358         }
 359
 360         r = aul_launch_argv_handler(argc, argv);
 361         if (r < 0) {
 362                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__,
 363                                         "Fail to call the aul_launch_argv_handler");
 364         }
 365
 366         r = app_get_id(&appid);
 367         if (r != APP_ERROR_NONE)
 368                 return r;
 369
 370         class_provider = app_ops->create(app_user_data);
 371         if (class_provider == NULL) {
 372                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__,
 373                                         "widget_class is NULL");
 374         }
 375
 376         return WIDGET_ERROR_NONE;
 377 }
 378
 379 static void __after_loop()
 380 {
 381         if (app_ops->terminate)
 382                 app_ops->terminate(app_user_data);
 383
 384         elm_shutdown();
 385 }
 386
 387 EXPORT_API int widget_app_main(int argc, char **argv,
 388                                 widget_app_lifecycle_callback_s *callback, void *user_data)
 389 {
 390         int r;
 391
 392         if (!_is_widget_feature_enabled()) {
 393                 _E("not supported");
 394                 return WIDGET_ERROR_NOT_SUPPORTED;
 395         }
 396
 397         if (argc <= 0 || argv == NULL || callback == NULL)
 398                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__, NULL);
 399
 400         if (callback->create == NULL)
 401                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__, "widget_app_create_cb() callback must be registered");
 402
 403         app_ops = callback;
 404         app_user_data = user_data;
 405         r = __before_loop(argc, argv);
 406         if (r < 0)
 407                 return r;
 408
 409         ecore_main_loop_begin();
 410         aul_status_update(STATUS_DYING);
 411         __after_loop();
 412
 413         return WIDGET_ERROR_NONE;
 414 }
 415
 416 EXPORT_API int widget_app_exit(void)
 417 {
 418         if (!_is_widget_feature_enabled()) {
 419                 _E("not supported");
 420                 return WIDGET_ERROR_NOT_SUPPORTED;
 421         }
 422
 423         ecore_main_loop_quit();
 424
 425         return WIDGET_ERROR_NONE;
 426 }
 427
 428 static gboolean __finish_event_cb(gpointer user_data)
 429 {
 430         if (user_data == NULL)
 431                 return FALSE;
 432
 433         widget_context_s *wc = (widget_context_s *)user_data;
 434
 435         switch (wc->state) {
 436         case WC_READY:
 437
 438                 break;
 439         case WC_RUNNING:
 440
 441                 break;
 442         case WC_PAUSED:
 443
 444                 break;
 445         default:
 446                 break;
 447         }
 448
 449
 450         return FALSE;
 451 }
 452
 453 EXPORT_API int widget_app_terminate_context(widget_context_h context)
 454 {
 455         if (!_is_widget_feature_enabled()) {
 456                 _E("not supported");
 457                 return WIDGET_ERROR_NOT_SUPPORTED;
 458         }
 459
 460         if (context == NULL)
 461                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__, NULL);
 462
 463         g_idle_add(__finish_event_cb, context);
 464         return WIDGET_ERROR_NONE;
 465 }
 466
 467 EXPORT_API int widget_app_foreach_context(widget_context_cb cb, void *data)
 468 {
 469         if (!_is_widget_feature_enabled()) {
 470                 _E("not supported");
 471                 return WIDGET_ERROR_NOT_SUPPORTED;
 472         }
 473
 474         if (!cb)
 475                 return WIDGET_ERROR_INVALID_PARAMETER;
 476
 477         return WIDGET_ERROR_NONE;
 478 }
 479
 480 EXPORT_API int widget_app_add_event_handler(app_event_handler_h *event_handler,
 481                                         app_event_type_e event_type, app_event_cb callback,
 482                                         void *user_data)
 483 {
 484         if (!_is_widget_feature_enabled()) {
 485                 _E("not supported");
 486                 return WIDGET_ERROR_NOT_SUPPORTED;
 487         }
 488
 489         /* TODO */
 490         if (!event_handler || !callback)
 491                 return WIDGET_ERROR_INVALID_PARAMETER;
 492
 493         switch (event_type) {
 494         case APP_EVENT_LOW_MEMORY:
 495         case APP_EVENT_LOW_BATTERY:
 496         case APP_EVENT_LANGUAGE_CHANGED:
 497         case APP_EVENT_DEVICE_ORIENTATION_CHANGED:
 498         case APP_EVENT_REGION_FORMAT_CHANGED:
 499         case APP_EVENT_SUSPENDED_STATE_CHANGED:
 500
 501                 break;
 502         default:
 503                 return WIDGET_ERROR_INVALID_PARAMETER;
 504         }
 505
 506         return WIDGET_ERROR_NONE;
 507 }
 508
 509 EXPORT_API int widget_app_remove_event_handler(app_event_handler_h
 510                                                 event_handler)
 511 {
 512         if (!_is_widget_feature_enabled()) {
 513                 _E("not supported");
 514                 return WIDGET_ERROR_NOT_SUPPORTED;
 515         }
 516
 517         /* TODO */
 518         if (!event_handler)
 519                 return WIDGET_ERROR_INVALID_PARAMETER;
 520
 521         return WIDGET_ERROR_NONE;
 522 }
 523
 524 EXPORT_API const char* widget_app_get_id(widget_context_h context)
 525 {
 526         if (!_is_widget_feature_enabled()) {
 527                 _E("not supported");
 528                 set_last_result(WIDGET_ERROR_NOT_SUPPORTED);
 529                 return NULL;
 530         }
 531
 532         if (!context) {
 533                 set_last_result(WIDGET_ERROR_INVALID_PARAMETER);
 534                 return NULL;
 535         }
 536
 537         return context->id;
 538 }
 539
 540 EXPORT_API int widget_app_get_elm_win(widget_context_h context,
 541                                         Evas_Object **win)
 542 {
 543         widget_context_s *cxt = (widget_context_s*)context;
 544         Evas_Object *ret_win;
 545         Ecore_Wl_Window *wl_win;
 546
 547         if (!_is_widget_feature_enabled()) {
 548                 _E("not supported");
 549                 return WIDGET_ERROR_NOT_SUPPORTED;
 550         }
 551
 552         if (context == NULL || win == NULL)
 553                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__, NULL);
 554
 555         ret_win = elm_win_add(NULL, cxt->id, ELM_WIN_BASIC);
 556         if (ret_win == NULL) {
 557                 _E("failed to create window");
 558                 return WIDGET_ERROR_FAULT;
 559         }
 560
 561         wl_win = elm_win_wl_window_get(ret_win);
 562         if (wl_win == NULL) {
 563                 _E("failed to get wayland window");
 564                 evas_object_del(ret_win);
 565                 return WIDGET_ERROR_FAULT;
 566         }
 567
 568         ecore_wl_window_class_name_set(wl_win, cxt->id);
 569
 570         *win = ret_win;
 571         cxt->win = ret_win;
 572
 573         return WIDGET_ERROR_NONE;
 574 }
 575
 576 widget_class_h _widget_class_create(widget_class_s *prev, const char *class_id,
 577                 widget_instance_lifecycle_callback_s callback, void *user_data)
 578 {
 579         widget_class_s *wc;
 580
 581         if (!_is_widget_feature_enabled()) {
 582                 _E("not supported");
 583                 set_last_result(WIDGET_ERROR_NOT_SUPPORTED);
 584                 return NULL;
 585         }
 586
 587         if (class_id == NULL) {
 588                 set_last_result(WIDGET_ERROR_INVALID_PARAMETER);
 589                 return NULL;
 590         }
 591
 592         wc = (widget_class_s *)malloc(sizeof(widget_class_s));
 593         if (wc == NULL) {
 594                 _E("failed to malloc : %s", __FUNCTION__);
 595                 set_last_result(WIDGET_ERROR_OUT_OF_MEMORY);
 596                 return NULL;
 597         }
 598
 599         wc->classid = strdup(class_id);
 600         wc->user_data = user_data;
 601         wc->ops = callback;
 602         wc->next = prev;
 603         wc->prev = NULL;
 604
 605         set_last_result(WIDGET_ERROR_NONE);
 606
 607         if (prev)
 608                 prev->prev = wc;
 609
 610         return wc;
 611 }
 612
 613 EXPORT_API widget_class_h widget_app_class_add(widget_class_h widget_class, const char *class_id,
 614                 widget_instance_lifecycle_callback_s callback, void *user_data)
 615 {
 616         return _widget_class_create(widget_class, class_id, callback, user_data);
 617 }
 618
 619 EXPORT_API widget_class_h widget_app_class_create(widget_instance_lifecycle_callback_s callback, void *user_data)
 620 {
 621         return _widget_class_create(class_provider, appid, callback, user_data);
 622 }
 623
 624 EXPORT_API int widget_app_context_set_tag(widget_context_h context, void *tag)
 625 {
 626         if (!_is_widget_feature_enabled()) {
 627                 _E("not supported");
 628                 return WIDGET_ERROR_NOT_SUPPORTED;
 629         }
 630
 631         if (context == NULL)
 632                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__, NULL);
 633
 634         context->tag = tag;
 635
 636         return WIDGET_ERROR_NONE;
 637 }
 638
 639 EXPORT_API int widget_app_context_get_tag(widget_context_h context, void **tag)
 640 {
 641         if (!_is_widget_feature_enabled()) {
 642                 _E("not supported");
 643                 return WIDGET_ERROR_NOT_SUPPORTED;
 644         }
 645
 646         if (context == NULL || tag == NULL)
 647                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__, NULL);
 648
 649         *tag = context->tag;
 650
 651         return WIDGET_ERROR_NONE;
 652 }
 653
 654 EXPORT_API int widget_app_context_set_content_info(widget_context_h context, bundle *content_info)
 655 {
 656         const char *class_id = NULL;
 657         int ret = 0;
 658
 659         if (!_is_widget_feature_enabled()) {
 660                 _E("not supported");
 661                 return WIDGET_ERROR_NOT_SUPPORTED;
 662         }
 663
 664         if (context == NULL || content_info == NULL)
 665                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__, NULL);
 666
 667         if (context->provider == NULL)
 668                 return widget_app_error(WIDGET_ERROR_INVALID_PARAMETER, __FUNCTION__, NULL);
 669
 670         class_id = context->provider->classid;
 671
 672         if (class_id == NULL)
 673                 return widget_app_error(WIDGET_ERROR_FAULT, __FUNCTION__, NULL);
 674
 675         ret = __send_update_status(class_id, context->id, WIDGET_INSTANCE_EVENT_UPDATE, content_info, true);
 676
 677         if (ret < 0) {
 678                 _E("failed to send content info: %s of %s (%d)", context->id, class_id, ret);
 679                 return widget_app_error(WIDGET_ERROR_IO_ERROR, __FUNCTION__, NULL);
 680         }
 681
 682         return WIDGET_ERROR_NONE;
 683 }
 684
 685 EXPORT_API int widget_app_context_set_title(widget_context_h context, const char *title)
 686 {
 687         if (!_is_widget_feature_enabled()) {
 688                 _E("not supported");
 689                 return WIDGET_ERROR_NOT_SUPPORTED;
 690         }
 691
 692         /* TODO
 693          call elm_win_title_set()
 694          */
 695
 696         if (!context || !title)
 697                 return WIDGET_ERROR_INVALID_PARAMETER;
 698
 699         return WIDGET_ERROR_NONE;
 700 }
 701