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