2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include "wrt-client.h"
20 #include <dpl/log/log.h>
21 #include <dpl/optional_typedefs.h>
22 #include <dpl/exception.h>
23 #include <common/application_data.h>
24 #include <core_module.h>
25 #include <global_logic.h>
26 #include <localization_setting.h>
27 #include <widget_deserialize_model.h>
29 #include <dpl/localization/w3c_file_localization.h>
30 #include <dpl/localization/LanguageTagsProvider.h>
32 //W3C PACKAGING enviroment variable name
33 #define W3C_DEBUG_ENV_VARIABLE "DEBUG_LOAD_FINISH"
35 // window signal callback
36 const char *EDJE_SHOW_BACKWARD_SIGNAL = "show,backward,signal";
37 const std::string VIEWMODE_TYPE_FULLSCREEN = "fullscreen";
38 const std::string VIEWMODE_TYPE_MAXIMIZED = "maximized";
40 WrtClient::WrtClient(int argc, char **argv) :
41 Application(argc, argv, "wrt-client", false),
42 DPL::TaskDecl<WrtClient>(this),
44 m_initializing(false),
49 m_returnStatus(ReturnStatus::Succeeded),
50 m_widgetState(WidgetState::WidgetState_Stopped)
53 LogDebug("App Created");
56 WrtClient::~WrtClient()
58 LogDebug("App Finished");
61 WrtClient::ReturnStatus::Type WrtClient::getReturnStatus() const
63 return m_returnStatus;
66 void WrtClient::OnStop()
68 LogInfo("Stopping Dummy Client");
72 void WrtClient::OnCreate()
75 ADD_PROFILING_POINT("OnCreate callback", "point");
80 void WrtClient::OnResume()
82 if (m_widgetState != WidgetState_Suspended) {
83 LogWarning("Widget is not suspended, resuming was skipped");
87 m_widgetState = WidgetState_Running;
91 void WrtClient::OnPause()
95 if (m_widgetState != WidgetState_Running) {
96 LogWarning("Widget is not running to be suspended");
100 m_widgetState = WidgetState_Suspended;
103 void WrtClient::OnReset(bundle *b)
106 // bundle argument is freed after OnReset() is returned
107 // So bundle duplication is needed
108 ApplicationDataSingleton::Instance().setBundle(bundle_dup(b));
110 if (true == m_initializing) {
111 LogDebug("can not handle reset event");
114 if (true == m_launched) {
115 if (m_widgetState == WidgetState_Stopped) {
116 LogError("Widget is not running to be reset");
120 m_windowData->emitSignalForUserLayout(EDJE_SHOW_BACKWARD_SIGNAL, "");
121 m_widgetState = WidgetState_Running;
123 if (true == checkArgument())
134 void WrtClient::OnTerminate()
136 LogDebug("Wrt Shutdown now");
140 void WrtClient::showHelpAndQuit()
142 printf("Usage: wrt-client [OPTION]... [WIDGET: ID]...\n"
144 "Mandatory arguments to long options are mandatory for short "
146 " -h, --help show this help\n"
148 "launch widget with given tizen ID\n"
150 "launch widget with given tizen ID\n"
156 bool WrtClient::checkArgument()
158 LogInfo("checkArgument");
160 std::string arg = m_argv[0];
166 if (arg.find("wrt-client") != std::string::npos)
174 if (arg == "-h" || arg == "--help") {
177 } else if (arg == "-l" || arg == "--launch" ||
178 arg == "-t" || arg == "--tizen") {
182 m_tizenId = std::string(m_argv[2]);
187 size_t pos = arg.find_last_of('/');
189 if (pos != std::string::npos) {
190 arg = arg.erase(0, pos + 1);
193 // Launch widget based on application basename
195 LogDebug("Tizen id: " << m_tizenId);
201 void WrtClient::setStep()
205 AddStep(&WrtClient::initStep);
207 setSdkLauncherDebugData();
209 AddStep(&WrtClient::launchStep);
210 AddStep(&WrtClient::shutdownStep);
212 m_initializing = true;
214 DPL::Event::ControllerEventHandler<NextStepEvent>::PostEvent(NextStepEvent());
217 void WrtClient::setSdkLauncherDebugData()
219 LogDebug("setSdkLauncherDebugData");
221 /* check bundle from sdk launcher */
222 bundle *bundleFromSdkLauncher;
223 bundleFromSdkLauncher = bundle_import_from_argv(m_argc, m_argv);
224 const char *bundle_debug = bundle_get_val(bundleFromSdkLauncher, "debug");
225 const char *bundle_pid = bundle_get_val(bundleFromSdkLauncher, "pid");
226 if (bundle_debug != NULL && bundle_pid != NULL) {
227 if (strcmp(bundle_debug, "true") == 0) {
229 m_sdkLauncherPid = atoi(bundle_pid);
234 bundle_free(bundleFromSdkLauncher);
237 bool WrtClient::checkDebugMode(SDKDebugData* debugData)
239 LogError("Checking for debug mode");
242 bool debugMode = debugData->debugMode;
244 LogInfo("[DEBUG_MODE] Widget is launched in " <<
245 (debugMode ? "DEBUG" : "RETAIL") <<
248 if (debugMode == true) {
249 // In WAC widget, only test widgets can use web inspector.
251 // every launched widgets as debug mode can use it.
252 if (m_dao->getWidgetType().appType == WrtDB::APP_TYPE_WAC20)
255 GlobalLogicSingleton::Instance().GetGlobalModel()
256 ->DeveloperMode.Get();
257 //This code will be activated
258 //after WAC test certificate is used by SDK
259 //bool isTestWidget = view->m_widgetModel->IsTestWidget.Get();
262 // LogInfo("This is not WAC Test Widget");
265 if (!developerMode) {
266 LogInfo("This is not WAC Developer Mode");
274 void WrtClient::OnEventReceived(const NextStepEvent& /*event*/)
276 LogDebug("Executing next step");
280 void WrtClient::initStep()
283 if (WRT::CoreModuleSingleton::Instance().Init()) {
284 m_initialized = true;
286 m_returnStatus = ReturnStatus::Failed;
287 SwitchToStep(&WrtClient::shutdownStep);
290 // ecore_event_jobs are processed sequentially without concession to
291 // other type events. To give a chance of execute to other events,
292 // ecore_timer_add was used.
293 DPL::Event::ControllerEventHandler<NextStepEvent>::PostTimedEvent(
294 NextStepEvent(),0.001);
297 bool WrtClient::checkWACTestCertififedWidget()
299 // WAC Waikiki Beta Release Core Specification: Widget Runtime
302 // WR-4710 The WRT MUST enable debug functions only for WAC test widgets
303 // i.e. the functions must not be usable for normal WAC widgets, even when
304 // a WAC test widget is executing.
305 ADD_PROFILING_POINT("DeveloperModeCheck", "start");
308 // A widget signed with a WAC-issued test certificate as described in
311 bool developerWidget = m_dao->isTestWidget();
313 GlobalLogicSingleton::Instance().GetGlobalModel()->DeveloperMode.Get();
315 LogDebug("Is WAC test widget: " << developerWidget);
316 LogDebug("Is developer Mode: " << developerMode);
318 if (developerWidget) {
321 LogError("WAC test certified developer widget is needed for " <<
325 //TODO: WR-4660 (show popup about developer widget
327 LogInfo("POPUP: THIS IS TEST WIDGET!");
330 ADD_PROFILING_POINT("DeveloperModeCheck", "stop");
334 void WrtClient::loadFinishCallback(Evas_Object* webview)
336 ADD_PROFILING_POINT("loadFinishCallback", "start");
337 SDKDebugData* debug = new SDKDebugData;
338 debug->debugMode = m_debugMode;
339 debug->pid = new unsigned long(getpid());
341 LogInfo("Post result of launch");
343 // Start inspector server, if current mode is debugger mode.
344 // In the WK2 case, ewk_view_inspector_server_start should
345 // be called after WebProcess is created.
346 if (checkDebugMode(debug))
349 ewk_view_inspector_server_start(m_widget->GetCurrentWebview(), 0);
350 if (debug->portnum == 0) {
351 LogWarning("Failed to get portnum");
353 LogInfo("Assigned port number for inspector : "
357 LogDebug("Debug mode is disabled");
360 //w3c packaging test debug (message on 4>)
361 const char * makeScreen = getenv(W3C_DEBUG_ENV_VARIABLE);
362 if(makeScreen != NULL && strcmp(makeScreen, "1") == 0)
364 FILE* doutput = fdopen(4, "w");
365 fprintf(doutput,"didFinishLoadForFrameCallback: ready\n");
370 LogDebug("Launch succesfull");
373 m_initializing = false;
375 ADD_PROFILING_POINT("loadFinishCallback", "stop");
376 printf("launched\n");
381 m_returnStatus = ReturnStatus::Failed;
383 DPL::Event::ControllerEventHandler<NextStepEvent>::
384 PostEvent(NextStepEvent());
389 LogDebug("Send RT signal to wrt-launcher(pid: " << m_sdkLauncherPid);
391 /* send real time signal with result to wrt-launcher */
393 LogDebug("userData->portnum : " << debug->portnum);
394 sv.sival_int = debug->portnum;
398 sigqueue(m_sdkLauncherPid, SIGRTMIN, sv);
401 ApplicationDataSingleton::Instance().freeBundle();
403 LogDebug("Cleaning wrtClient launch resources...");
408 void WrtClient::progressFinishCallback()
410 m_splashScreen->stopSplashScreen();
413 void WrtClient::webkitExitCallback()
415 LogDebug("window close called, terminating app");
416 SwitchToStep(&WrtClient::shutdownStep);
417 DPL::Event::ControllerEventHandler<NextStepEvent>::PostEvent(
421 void WrtClient::webCrashCallback()
423 LogError("webProcess crashed");
424 SwitchToStep(&WrtClient::shutdownStep);
425 DPL::Event::ControllerEventHandler<NextStepEvent>::PostEvent(
430 void WrtClient::launchStep()
432 ADD_PROFILING_POINT("launchStep", "start");
433 LogDebug("Launching widget ...");
435 ADD_PROFILING_POINT("getRunnableWidgetObject", "start");
436 m_widget = WRT::CoreModuleSingleton::Instance()
437 .getRunnableWidgetObject(m_tizenId);
438 ADD_PROFILING_POINT("getRunnableWidgetObject", "stop");
441 LogError("RunnableWidgetObject is NULL, stop launchStep");
442 DPL::Event::ControllerEventHandler<NextStepEvent>::PostEvent(
447 if (m_widgetState == WidgetState_Running) {
448 LogWarning("Widget already running, stop launchStep");
449 DPL::Event::ControllerEventHandler<NextStepEvent>::PostEvent(
454 if (m_widgetState == WidgetState_Authorizing) {
455 LogWarning("Widget already authorizing, stop launchStep");
456 DPL::Event::ControllerEventHandler<NextStepEvent>::PostEvent(
461 m_dao.reset(new WrtDB::WidgetDAOReadOnly(DPL::FromASCIIString(m_tizenId)));
462 DPL::Optional<DPL::String> defloc = m_dao->getDefaultlocale();
465 LanguageTagsProviderSingleton::Instance().addWidgetDefaultLocales(*defloc);
468 LocalizationSetting::SetLanguageChangedCallback(
469 languageChangedCallback, this);
471 ADD_PROFILING_POINT("CreateWindow", "start");
472 m_windowData.reset(new WindowData(static_cast<unsigned long>(getpid())));
473 ADD_PROFILING_POINT("CreateWindow", "stop");
475 WRT::UserDelegatesPtr cbs(new WRT::UserDelegates);
476 ADD_PROFILING_POINT("Create splash screen", "start");
477 m_splashScreen.reset(
478 new SplashScreenSupport(m_windowData->m_win));
479 if (m_splashScreen->createSplashScreen(m_dao->getSplashImgSrc())) {
480 m_splashScreen->startSplashScreen();
481 cbs->progressFinish = DPL::MakeDelegate(this, &WrtClient::progressFinishCallback);
483 ADD_PROFILING_POINT("Create splash screen", "stop");
484 DPL::OptionalString startUrl = W3CFileLocalization::getStartFile(m_dao);
485 m_widget->PrepareView(DPL::ToUTF8String(*startUrl),
486 m_windowData->m_win);
487 //you can't show window with splash screen before PrepareView
488 //ewk_view_add_with_context() in viewLogic breaks window
490 WrtDB::WidgetLocalizedInfo localizedInfo =
491 W3CFileLocalization::getLocalizedInfo(m_dao);
492 std:: string name = "";
493 if (!(localizedInfo.name.IsNull())) {
494 name = DPL::ToUTF8String(*(localizedInfo.name));
496 elm_win_title_set(m_windowData->m_win, name.c_str());
497 evas_object_show(m_windowData->m_win);
498 initializeWindowModes();
499 connectElmCallback();
501 if (!checkWACTestCertififedWidget())
503 LogWarning("WAC Certificate failed, stop launchStep");
507 m_widgetState = WidgetState_Authorizing;
508 if (!m_widget->CheckBeforeLaunch()) {
509 LogError("CheckBeforeLaunch failed, stop launchStep");
510 DPL::Event::ControllerEventHandler<NextStepEvent>::PostEvent(
514 LogInfo("Widget launch accepted. Entering running state");
515 m_widgetState = WidgetState_Running;
517 cbs->loadFinish = DPL::MakeDelegate(this, &WrtClient::loadFinishCallback);
518 cbs->bufferSet = DPL::MakeDelegate(this, &WrtClient::setLayout);
519 cbs->bufferUnset = DPL::MakeDelegate(this, &WrtClient::unsetLayout);
520 cbs->webkitExit = DPL::MakeDelegate(this, &WrtClient::webkitExitCallback);
521 cbs->webCrash = DPL::MakeDelegate(this, &WrtClient::webCrashCallback);
522 cbs->toggleFullscreen = DPL::MakeDelegate(m_windowData.get(), &WindowData::toggleFullscreen);
524 m_widget->SetUserDelegates(cbs);
526 m_windowData->emitSignalForUserLayout(EDJE_SHOW_BACKWARD_SIGNAL, "");
527 ADD_PROFILING_POINT("launchStep", "stop");
530 void WrtClient::initializeWindowModes()
532 Assert(m_windowData);
534 auto windowModes = m_dao->getWindowModes();
535 bool fullscreen = false;
536 bool backbutton = false;
537 if (m_dao->getWidgetType().appType == WrtDB::APP_TYPE_TIZENWEBAPP) {
538 WidgetSettings widgetSettings;
539 m_dao->getWidgetSettings(widgetSettings);
540 WidgetSettingList settings(widgetSettings);
542 (settings.getBackButtonPresence() == BackButton_Enable);
546 FOREACH(it, windowModes)
548 std::string viewMode = DPL::ToUTF8String(*it);
549 if (viewMode == VIEWMODE_TYPE_FULLSCREEN) {
552 } else if (viewMode == VIEWMODE_TYPE_MAXIMIZED) {
557 WrtDB::WidgetLocalizedInfo localizedInfo =
558 W3CFileLocalization::getLocalizedInfo(m_dao);
559 std::string name = "";
560 if (!(localizedInfo.name.IsNull())) {
561 name = DPL::ToUTF8String(*(localizedInfo.name));
563 LogInfo("initializeWindowModes " << m_debugMode);
565 m_windowData->m_debugMode = FALSE;
568 m_windowData->m_debugMode = TRUE;
571 m_windowData->m_debugMode = FALSE;
574 WindowData::CtxMenuItems ctxMenuItems;
576 WindowData::CtxMenuItem ctxMenuBackword;
577 ctxMenuBackword.label = WRT_OPTION_LABEL_BACKWARD;
578 ctxMenuBackword.icon = WRT_OPTION_ICON_BACKWARD;
579 ctxMenuBackword.callback = backwardCallback;
580 ctxMenuBackword.data = this;
581 ctxMenuItems.push_back(ctxMenuBackword);
583 WindowData::CtxMenuItem ctxMenuReload;
584 ctxMenuReload.label = WRT_OPTION_LABEL_RELOAD;
585 ctxMenuReload.icon = WRT_OPTION_ICON_RELOAD;
586 ctxMenuReload.callback = reloadCallback;
587 ctxMenuReload.data = this;
588 ctxMenuItems.push_back(ctxMenuReload);
590 WindowData::CtxMenuItem ctxMenuForward;
591 ctxMenuForward.label = WRT_OPTION_LABEL_FORWARD;
592 ctxMenuForward.icon = WRT_OPTION_ICON_FORWARD;
593 ctxMenuForward.callback = forwardCallback;
594 ctxMenuForward.data = this;
595 ctxMenuItems.push_back(ctxMenuForward);
597 m_windowData->setViewMode(name.c_str(),
603 void WrtClient::backButtonCallback(void* data,
604 Evas_Object * /*obj*/,
605 void * /*event_info*/)
607 LogInfo("BackButtonCallback");
610 WrtClient* This = static_cast<WrtClient*>(data);
612 This->m_widget->Backward();
615 void WrtClient::backwardCallback(void *data,
616 Evas_Object */*obj*/,
617 void */*event_info*/)
619 LogInfo("BackButtonCallback");
622 WrtClient* This = static_cast<WrtClient*>(data);
624 This->m_widget->Backward();
625 This->m_windowData->initFullViewMode();
628 void WrtClient::reloadCallback(void *data,
629 Evas_Object */*obj*/,
630 void */*event_info*/)
632 LogInfo("reloadCallback");
634 WrtClient* This = static_cast<WrtClient*>(data);
636 This->m_widget->Reload();
637 This->m_windowData->initFullViewMode();
640 void WrtClient::forwardCallback(void *data,
641 Evas_Object */*obj*/,
642 void */*event_info*/)
644 LogInfo("forwardCallback");
646 WrtClient* This = static_cast<WrtClient*>(data);
648 This->m_widget->Forward();
649 This->m_windowData->initFullViewMode();
653 void WrtClient::connectElmCallback()
655 Assert(m_windowData);
657 if (m_dao->getWidgetType().appType == WrtDB::APP_TYPE_TIZENWEBAPP) {
658 WidgetSettings widgetSettings;
659 m_dao->getWidgetSettings(widgetSettings);
660 WidgetSettingList settings(widgetSettings);
661 if (settings.getBackButtonPresence() == BackButton_Enable) {
662 m_windowData->addFloatBackButtonCallback(
664 &WrtClient::backButtonCallback,
668 WidgetSettingScreenLock rotationValue = settings.getRotationValue();
669 if (rotationValue == Screen_Portrait) {
670 elm_win_rotation_with_resize_set(m_windowData->m_win, 0);
671 } else if (rotationValue == Screen_Landscape) {
672 elm_win_rotation_with_resize_set(m_windowData->m_win, 270);
674 elm_win_rotation_with_resize_set(m_windowData->m_win, 0);
679 void WrtClient::setLayout(Evas_Object* newBuffer) {
680 LogDebug("add new webkit buffer to window");
682 elm_object_content_set(m_windowData->m_conformant, newBuffer);
683 evas_object_show(newBuffer);
684 evas_object_focus_set(newBuffer, EINA_TRUE);
687 void WrtClient::unsetLayout(Evas_Object* currentBuffer) {
688 LogDebug("remove current webkit buffer from window");
689 Assert(currentBuffer);
690 evas_object_hide(currentBuffer);
691 elm_object_content_unset(m_windowData->m_conformant);
694 void WrtClient::shutdownStep()
696 LogDebug("Closing Wrt connection ...");
697 if (m_initialized && m_widget) {
698 m_widgetState = WidgetState_Stopped;
701 m_windowData.reset();
702 WRT::CoreModuleSingleton::Instance().Terminate();
703 m_initialized = false;
708 int WrtClient::languageChangedCallback(void *data)
710 LogDebug("Language Changed");
713 WrtClient* wrtClient = static_cast<WrtClient*>(data);
714 if(!(wrtClient->m_dao))
717 // reset function fetches system locales and recreates language tags
718 LanguageTagsProviderSingleton::Instance().resetLanguageTags();
719 // widget default locales are added to language tags below
720 DPL::OptionalString defloc = wrtClient->m_dao->getDefaultlocale();
723 LanguageTagsProviderSingleton::Instance().addWidgetDefaultLocales(*defloc);
726 if (wrtClient->m_launched &&
727 wrtClient->m_widgetState != WidgetState_Stopped) {
728 wrtClient->m_widget->ReloadStartPage();
733 void WrtClient::Quit()
736 DPL::Application::Quit();
742 UNHANDLED_EXCEPTION_HANDLER_BEGIN
744 ADD_PROFILING_POINT("main-entered", "point");
746 // Output on stdout will be flushed after every newline character,
747 // even if it is redirected to a pipe. This is useful for running
748 // from a script and parsing output.
749 // (Standard behavior of stdlib is to use full buffering when
750 // redirected to a pipe, which means even after an end of line
751 // the output may not be flushed).
754 // set evas backend type
755 if (!getenv("ELM_ENGINE")) {
756 if (!setenv("ELM_ENGINE", "gl", 1)) {
757 LogDebug("Enable backend");
761 LogDebug("ELM_ENGINE : " << getenv("ELM_ENGINE"));
765 setenv("COREGL_FASTPATH", "1", 1);
767 setenv("CAIRO_GL_COMPOSITOR", "msaa", 1);
768 setenv("CAIRO_GL_LAZY_FLUSHING", "yes", 1);
769 setenv("ELM_IMAGE_CACHE", "0", 1);
772 DPL::Log::LogSystemSingleton::Instance().SetTag("WRT-CLIENT");
774 WrtClient app(argc, argv);
776 ADD_PROFILING_POINT("Before appExec", "point");
777 int ret = app.Exec();
778 LogDebug("App returned: " << ret);
779 ret = app.getReturnStatus();
780 LogDebug("WrtClient returned: " << ret);
783 UNHANDLED_EXCEPTION_HANDLER_END