dali/internal/web-engine/common/web-engine-impl.cpp

   1 /*
   2  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   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 // CLASS HEADER
  19 #include <dali/internal/web-engine/common/web-engine-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/integration-api/debug.h>
  23 #include <dali/public-api/object/type-registry.h>
  24 #include <dlfcn.h>
  25 #include <sstream>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali/devel-api/adaptor-framework/environment-variable.h>
  29 #include <dali/devel-api/adaptor-framework/web-engine-back-forward-list.h>
  30 #include <dali/devel-api/adaptor-framework/web-engine-certificate.h>
  31 #include <dali/devel-api/adaptor-framework/web-engine-console-message.h>
  32 #include <dali/devel-api/adaptor-framework/web-engine-context-menu.h>
  33 #include <dali/devel-api/adaptor-framework/web-engine-context.h>
  34 #include <dali/devel-api/adaptor-framework/web-engine-cookie-manager.h>
  35 #include <dali/devel-api/adaptor-framework/web-engine-http-auth-handler.h>
  36 #include <dali/devel-api/adaptor-framework/web-engine-load-error.h>
  37 #include <dali/devel-api/adaptor-framework/web-engine-policy-decision.h>
  38 #include <dali/devel-api/adaptor-framework/web-engine-request-interceptor.h>
  39 #include <dali/devel-api/adaptor-framework/web-engine-settings.h>
  40 #include <dali/internal/system/common/environment-variables.h>
  41 #include <dali/public-api/adaptor-framework/native-image-source.h>
  42 #include <dali/public-api/images/pixel-data.h>
  43
  44 namespace Dali
  45 {
  46 namespace Internal
  47 {
  48 namespace Adaptor
  49 {
  50 namespace // unnamed namespace
  51 {
  52 constexpr char const* const kPluginFullNamePrefix  = "libdali2-web-engine-";
  53 constexpr char const* const kPluginFullNamePostfix = "-plugin.so";
  54 constexpr char const* const kPluginFullNameDefault = "libdali2-web-engine-plugin.so";
  55
  56 // Note: Dali WebView policy does not allow to use multiple web engines in an application.
  57 // So once pluginName is set to non-empty string, it will not change.
  58 std::string pluginName;
  59
  60 std::string MakePluginName(const char* environmentName)
  61 {
  62   std::stringstream fullName;
  63   fullName << kPluginFullNamePrefix << environmentName << kPluginFullNamePostfix;
  64   return std::move(fullName.str());
  65 }
  66
  67 Dali::BaseHandle Create()
  68 {
  69   return Dali::WebEngine::New();
  70 }
  71
  72 Dali::TypeRegistration type(typeid(Dali::WebEngine), typeid(Dali::BaseHandle), Create);
  73
  74 } // unnamed namespace
  75
  76 WebEnginePtr WebEngine::New()
  77 {
  78   WebEngine* instance = new WebEngine();
  79
  80   if(!instance->Initialize())
  81   {
  82     delete instance;
  83     return nullptr;
  84   }
  85
  86   return instance;
  87 }
  88
  89 WebEngine::WebEngine()
  90 : mPlugin(NULL),
  91   mHandle(NULL),
  92   mCreateWebEnginePtr(NULL),
  93   mDestroyWebEnginePtr(NULL)
  94 {
  95 }
  96
  97 WebEngine::~WebEngine()
  98 {
  99   if(mHandle != NULL)
 100   {
 101     if(mDestroyWebEnginePtr != NULL)
 102     {
 103       mPlugin->Destroy();
 104       mDestroyWebEnginePtr(mPlugin);
 105     }
 106
 107     dlclose(mHandle);
 108   }
 109 }
 110
 111 bool WebEngine::InitializePluginHandle()
 112 {
 113   if(pluginName.length() == 0)
 114   {
 115     // pluginName is not initialized yet.
 116     const char* name = EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_WEB_ENGINE_NAME);
 117     if(name)
 118     {
 119       pluginName = MakePluginName(name);
 120       mHandle    = dlopen(pluginName.c_str(), RTLD_LAZY);
 121       if(mHandle)
 122       {
 123         return true;
 124       }
 125     }
 126     pluginName = std::string(kPluginFullNameDefault);
 127   }
 128
 129   mHandle = dlopen(pluginName.c_str(), RTLD_LAZY);
 130   if(!mHandle)
 131   {
 132     DALI_LOG_ERROR("Can't load %s : %s\n", pluginName.c_str(), dlerror());
 133     return false;
 134   }
 135
 136   return true;
 137 }
 138
 139 bool WebEngine::Initialize()
 140 {
 141   char* error = NULL;
 142
 143   if(!InitializePluginHandle())
 144   {
 145     return false;
 146   }
 147
 148   mCreateWebEnginePtr = reinterpret_cast<CreateWebEngineFunction>(dlsym(mHandle, "CreateWebEnginePlugin"));
 149   if(mCreateWebEnginePtr == NULL)
 150   {
 151     DALI_LOG_ERROR("Can't load symbol CreateWebEnginePlugin(), error: %s\n", error);
 152     return false;
 153   }
 154
 155   mDestroyWebEnginePtr = reinterpret_cast<DestroyWebEngineFunction>(dlsym(mHandle, "DestroyWebEnginePlugin"));
 156
 157   if(mDestroyWebEnginePtr == NULL)
 158   {
 159     DALI_LOG_ERROR("Can't load symbol DestroyWebEnginePlugin(), error: %s\n", error);
 160     return false;
 161   }
 162
 163   mPlugin = mCreateWebEnginePtr();
 164
 165   if(mPlugin == NULL)
 166   {
 167     DALI_LOG_ERROR("Can't create the WebEnginePlugin object\n");
 168     return false;
 169   }
 170
 171   return true;
 172 }
 173
 174 void WebEngine::Create(uint32_t width, uint32_t height, const std::string& locale, const std::string& timezoneId)
 175 {
 176   mPlugin->Create(width, height, locale, timezoneId);
 177 }
 178
 179 void WebEngine::Create(uint32_t width, uint32_t height, uint32_t argc, char** argv)
 180 {
 181   mPlugin->Create(width, height, argc, argv);
 182 }
 183
 184 void WebEngine::Destroy()
 185 {
 186   mPlugin->Destroy();
 187 }
 188
 189 Dali::NativeImageInterfacePtr WebEngine::GetNativeImageSource()
 190 {
 191   return mPlugin->GetNativeImageSource();
 192 }
 193
 194 Dali::WebEngineSettings& WebEngine::GetSettings() const
 195 {
 196   return mPlugin->GetSettings();
 197 }
 198
 199 Dali::WebEngineContext& WebEngine::GetContext() const
 200 {
 201   return mPlugin->GetContext();
 202 }
 203
 204 Dali::WebEngineCookieManager& WebEngine::GetCookieManager() const
 205 {
 206   return mPlugin->GetCookieManager();
 207 }
 208
 209 Dali::WebEngineBackForwardList& WebEngine::GetBackForwardList() const
 210 {
 211   return mPlugin->GetBackForwardList();
 212 }
 213
 214 void WebEngine::LoadUrl(const std::string& url)
 215 {
 216   mPlugin->LoadUrl(url);
 217 }
 218
 219 std::string WebEngine::GetTitle() const
 220 {
 221   return mPlugin->GetTitle();
 222 }
 223
 224 Dali::PixelData WebEngine::GetFavicon() const
 225 {
 226   return mPlugin->GetFavicon();
 227 }
 228
 229 std::string WebEngine::GetUrl() const
 230 {
 231   return mPlugin->GetUrl();
 232 }
 233
 234 std::string WebEngine::GetUserAgent() const
 235 {
 236   return mPlugin->GetUserAgent();
 237 }
 238
 239 void WebEngine::SetUserAgent(const std::string& userAgent)
 240 {
 241   mPlugin->SetUserAgent(userAgent);
 242 }
 243
 244 void WebEngine::LoadHtmlString(const std::string& htmlString)
 245 {
 246   mPlugin->LoadHtmlString(htmlString);
 247 }
 248
 249 bool WebEngine::LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl)
 250 {
 251   return mPlugin->LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
 252 }
 253
 254 bool WebEngine::LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
 255 {
 256   return mPlugin->LoadContents(contents, contentSize, mimeType, encoding, baseUri);
 257 }
 258
 259 void WebEngine::Reload()
 260 {
 261   mPlugin->Reload();
 262 }
 263
 264 bool WebEngine::ReloadWithoutCache()
 265 {
 266   return mPlugin->ReloadWithoutCache();
 267 }
 268
 269 void WebEngine::StopLoading()
 270 {
 271   mPlugin->StopLoading();
 272 }
 273
 274 void WebEngine::Suspend()
 275 {
 276   mPlugin->Suspend();
 277 }
 278
 279 void WebEngine::Resume()
 280 {
 281   mPlugin->Resume();
 282 }
 283
 284 void WebEngine::SuspendNetworkLoading()
 285 {
 286   mPlugin->SuspendNetworkLoading();
 287 }
 288
 289 void WebEngine::ResumeNetworkLoading()
 290 {
 291   mPlugin->ResumeNetworkLoading();
 292 }
 293
 294 bool WebEngine::AddCustomHeader(const std::string& name, const std::string& value)
 295 {
 296   return mPlugin->AddCustomHeader(name, value);
 297 }
 298
 299 bool WebEngine::RemoveCustomHeader(const std::string& name)
 300 {
 301   return mPlugin->RemoveCustomHeader(name);
 302 }
 303
 304 uint32_t WebEngine::StartInspectorServer(uint32_t port)
 305 {
 306   return mPlugin->StartInspectorServer(port);
 307 }
 308
 309 bool WebEngine::StopInspectorServer()
 310 {
 311   return mPlugin->StopInspectorServer();
 312 }
 313
 314 void WebEngine::ScrollBy(int32_t deltaX, int32_t deltaY)
 315 {
 316   mPlugin->ScrollBy(deltaX, deltaY);
 317 }
 318
 319 bool WebEngine::ScrollEdgeBy(int32_t deltaX, int32_t deltaY)
 320 {
 321   return mPlugin->ScrollEdgeBy(deltaX, deltaY);
 322 }
 323
 324 void WebEngine::SetScrollPosition(int32_t x, int32_t y)
 325 {
 326   mPlugin->SetScrollPosition(x, y);
 327 }
 328
 329 Dali::Vector2 WebEngine::GetScrollPosition() const
 330 {
 331   return mPlugin->GetScrollPosition();
 332 }
 333
 334 Dali::Vector2 WebEngine::GetScrollSize() const
 335 {
 336   return mPlugin->GetScrollSize();
 337 }
 338
 339 Dali::Vector2 WebEngine::GetContentSize() const
 340 {
 341   return mPlugin->GetContentSize();
 342 }
 343
 344 void WebEngine::RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback)
 345 {
 346   mPlugin->RegisterJavaScriptAlertCallback(callback);
 347 }
 348
 349 void WebEngine::JavaScriptAlertReply()
 350 {
 351   mPlugin->JavaScriptAlertReply();
 352 }
 353
 354 void WebEngine::RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback)
 355 {
 356   mPlugin->RegisterJavaScriptConfirmCallback(callback);
 357 }
 358
 359 void WebEngine::JavaScriptConfirmReply(bool confirmed)
 360 {
 361   mPlugin->JavaScriptConfirmReply(confirmed);
 362 }
 363
 364 void WebEngine::RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback)
 365 {
 366   mPlugin->RegisterJavaScriptPromptCallback(callback);
 367 }
 368
 369 void WebEngine::JavaScriptPromptReply(const std::string& result)
 370 {
 371   mPlugin->JavaScriptPromptReply(result);
 372 }
 373
 374 std::unique_ptr<Dali::WebEngineHitTest> WebEngine::CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode)
 375 {
 376   return mPlugin->CreateHitTest(x, y, mode);
 377 }
 378
 379 bool WebEngine::CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback)
 380 {
 381   return mPlugin->CreateHitTestAsynchronously(x, y, mode, callback);
 382 }
 383
 384 bool WebEngine::CanGoForward()
 385 {
 386   return mPlugin->CanGoForward();
 387 }
 388
 389 void WebEngine::GoForward()
 390 {
 391   mPlugin->GoForward();
 392 }
 393
 394 bool WebEngine::CanGoBack()
 395 {
 396   return mPlugin->CanGoBack();
 397 }
 398
 399 void WebEngine::GoBack()
 400 {
 401   mPlugin->GoBack();
 402 }
 403
 404 void WebEngine::EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler)
 405 {
 406   mPlugin->EvaluateJavaScript(script, resultHandler);
 407 }
 408
 409 void WebEngine::AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler)
 410 {
 411   mPlugin->AddJavaScriptMessageHandler(exposedObjectName, handler);
 412 }
 413
 414 void WebEngine::ClearAllTilesResources()
 415 {
 416   mPlugin->ClearAllTilesResources();
 417 }
 418
 419 void WebEngine::ClearHistory()
 420 {
 421   mPlugin->ClearHistory();
 422 }
 423
 424 void WebEngine::SetSize(uint32_t width, uint32_t height)
 425 {
 426   mPlugin->SetSize(width, height);
 427 }
 428
 429 void WebEngine::EnableMouseEvents(bool enabled)
 430 {
 431   mPlugin->EnableMouseEvents(enabled);
 432 }
 433
 434 void WebEngine::EnableKeyEvents(bool enabled)
 435 {
 436   mPlugin->EnableKeyEvents(enabled);
 437 }
 438
 439 bool WebEngine::SendTouchEvent(const Dali::TouchEvent& touch)
 440 {
 441   return mPlugin->SendTouchEvent(touch);
 442 }
 443
 444 bool WebEngine::SendKeyEvent(const Dali::KeyEvent& event)
 445 {
 446   return mPlugin->SendKeyEvent(event);
 447 }
 448
 449 void WebEngine::SetFocus(bool focused)
 450 {
 451   mPlugin->SetFocus(focused);
 452 }
 453
 454 void WebEngine::SetDocumentBackgroundColor(Dali::Vector4 color)
 455 {
 456   mPlugin->SetDocumentBackgroundColor(color);
 457 }
 458
 459 void WebEngine::ClearTilesWhenHidden(bool cleared)
 460 {
 461   mPlugin->ClearTilesWhenHidden(cleared);
 462 }
 463
 464 void WebEngine::SetTileCoverAreaMultiplier(float multiplier)
 465 {
 466   mPlugin->SetTileCoverAreaMultiplier(multiplier);
 467 }
 468
 469 void WebEngine::EnableCursorByClient(bool enabled)
 470 {
 471   mPlugin->EnableCursorByClient(enabled);
 472 }
 473
 474 std::string WebEngine::GetSelectedText() const
 475 {
 476   return mPlugin->GetSelectedText();
 477 }
 478
 479 void WebEngine::SetPageZoomFactor(float zoomFactor)
 480 {
 481   mPlugin->SetPageZoomFactor(zoomFactor);
 482 }
 483
 484 float WebEngine::GetPageZoomFactor() const
 485 {
 486   return mPlugin->GetPageZoomFactor();
 487 }
 488
 489 void WebEngine::SetTextZoomFactor(float zoomFactor)
 490 {
 491   mPlugin->SetTextZoomFactor(zoomFactor);
 492 }
 493
 494 float WebEngine::GetTextZoomFactor() const
 495 {
 496   return mPlugin->GetTextZoomFactor();
 497 }
 498
 499 float WebEngine::GetLoadProgressPercentage() const
 500 {
 501   return mPlugin->GetLoadProgressPercentage();
 502 }
 503
 504 void WebEngine::SetScaleFactor(float scaleFactor, Dali::Vector2 point)
 505 {
 506   mPlugin->SetScaleFactor(scaleFactor, point);
 507 }
 508
 509 float WebEngine::GetScaleFactor() const
 510 {
 511   return mPlugin->GetScaleFactor();
 512 }
 513
 514 void WebEngine::ActivateAccessibility(bool activated)
 515 {
 516   mPlugin->ActivateAccessibility(activated);
 517 }
 518
 519 bool WebEngine::SetVisibility(bool visible)
 520 {
 521   return mPlugin->SetVisibility(visible);
 522 }
 523
 524 bool WebEngine::HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount)
 525 {
 526   return mPlugin->HighlightText(text, options, maxMatchCount);
 527 }
 528
 529 void WebEngine::AddDynamicCertificatePath(const std::string& host, const std::string& certPath)
 530 {
 531   mPlugin->AddDynamicCertificatePath(host, certPath);
 532 }
 533
 534 Dali::PixelData WebEngine::GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor)
 535 {
 536   return mPlugin->GetScreenshot(viewArea, scaleFactor);
 537 }
 538
 539 bool WebEngine::GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback)
 540 {
 541   return mPlugin->GetScreenshotAsynchronously(viewArea, scaleFactor, callback);
 542 }
 543
 544 bool WebEngine::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
 545 {
 546   return mPlugin->CheckVideoPlayingAsynchronously(callback);
 547 }
 548
 549 void WebEngine::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
 550 {
 551   mPlugin->RegisterGeolocationPermissionCallback(callback);
 552 }
 553
 554 void WebEngine::UpdateDisplayArea(Dali::Rect<int32_t> displayArea)
 555 {
 556   mPlugin->UpdateDisplayArea(displayArea);
 557 }
 558
 559 void WebEngine::EnableVideoHole(bool enabled)
 560 {
 561   mPlugin->EnableVideoHole(enabled);
 562 }
 563
 564 bool WebEngine::SendHoverEvent(const Dali::HoverEvent& event)
 565 {
 566   return mPlugin->SendHoverEvent(event);
 567 }
 568
 569 bool WebEngine::SendWheelEvent(const Dali::WheelEvent& event)
 570 {
 571   return mPlugin->SendWheelEvent(event);
 572 }
 573
 574 Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& WebEngine::FrameRenderedSignal()
 575 {
 576   return mPlugin->FrameRenderedSignal();
 577 }
 578
 579 void WebEngine::RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
 580 {
 581   mPlugin->RegisterPageLoadStartedCallback(callback);
 582 }
 583
 584 void WebEngine::RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
 585 {
 586   mPlugin->RegisterPageLoadInProgressCallback(callback);
 587 }
 588
 589 void WebEngine::RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
 590 {
 591   mPlugin->RegisterPageLoadFinishedCallback(callback);
 592 }
 593
 594 void WebEngine::RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback)
 595 {
 596   mPlugin->RegisterPageLoadErrorCallback(callback);
 597 }
 598
 599 void WebEngine::RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback)
 600 {
 601   mPlugin->RegisterScrollEdgeReachedCallback(callback);
 602 }
 603
 604 void WebEngine::RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback)
 605 {
 606   mPlugin->RegisterUrlChangedCallback(callback);
 607 }
 608
 609 void WebEngine::RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback)
 610 {
 611   mPlugin->RegisterFormRepostDecidedCallback(callback);
 612 }
 613
 614 void WebEngine::RegisterRequestInterceptorCallback(Dali::WebEnginePlugin::WebEngineRequestInterceptorCallback callback)
 615 {
 616   mPlugin->RegisterRequestInterceptorCallback(callback);
 617 }
 618
 619 void WebEngine::RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback)
 620 {
 621   mPlugin->RegisterConsoleMessageReceivedCallback(callback);
 622 }
 623
 624 void WebEngine::RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback)
 625 {
 626   mPlugin->RegisterResponsePolicyDecidedCallback(callback);
 627 }
 628
 629 void WebEngine::RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
 630 {
 631   mPlugin->RegisterCertificateConfirmedCallback(callback);
 632 }
 633
 634 void WebEngine::RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
 635 {
 636   mPlugin->RegisterSslCertificateChangedCallback(callback);
 637 }
 638
 639 void WebEngine::RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback)
 640 {
 641   mPlugin->RegisterHttpAuthHandlerCallback(callback);
 642 }
 643
 644 void WebEngine::RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback)
 645 {
 646   mPlugin->RegisterContextMenuShownCallback(callback);
 647 }
 648
 649 void WebEngine::RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback)
 650 {
 651   mPlugin->RegisterContextMenuHiddenCallback(callback);
 652 }
 653
 654 } // namespace Adaptor
 655 } // namespace Internal
 656 } // namespace Dali