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