2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
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.
19 #include <dali/internal/web-engine/common/web-engine-impl.h>
22 #include <dali/integration-api/debug.h>
23 #include <dali/public-api/object/type-registry.h>
28 #include <dali/devel-api/adaptor-framework/environment-variable.h>
29 #include <dali/devel-api/adaptor-framework/lifecycle-controller.h>
30 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-back-forward-list.h>
31 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-certificate.h>
32 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-console-message.h>
33 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-context-menu.h>
34 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-context.h>
35 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-cookie-manager.h>
36 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-http-auth-handler.h>
37 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-load-error.h>
38 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-policy-decision.h>
39 #include <dali/devel-api/adaptor-framework/web-engine/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>
50 namespace // unnamed namespace
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";
56 std::string MakePluginName(const char* environmentName)
58 std::stringstream fullName;
59 fullName << kPluginFullNamePrefix << environmentName << kPluginFullNamePostfix;
60 return std::move(fullName.str());
63 Dali::BaseHandle Create()
65 return Dali::WebEngine::New();
68 Dali::TypeRegistration type(typeid(Dali::WebEngine), typeid(Dali::BaseHandle), Create);
71 * @brief Control the WebEnginePlugin library lifecycle.
73 struct WebEnginePluginObject
76 WebEnginePluginObject()
79 mCreateWebEnginePtr{nullptr},
80 mDestroyWebEnginePtr{nullptr},
81 mGetWebEngineContextPtr{nullptr},
82 mGetWebEngineCookieManagerPtr{nullptr}
86 ~WebEnginePluginObject()
95 bool InitializePluginHandle()
99 DALI_LOG_ERROR("Plugin.so has been opened already.\n");
103 if(mPluginName.length() == 0)
105 // mPluginName is not initialized yet.
106 const char* name = EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_WEB_ENGINE_NAME);
109 mPluginName = MakePluginName(name);
113 mPluginName = std::string(kPluginFullNameDefault);
117 mHandle = dlopen(mPluginName.c_str(), RTLD_LAZY);
120 DALI_LOG_ERROR("Can't load %s : %s\n", mPluginName.c_str(), dlerror());
124 mCreateWebEnginePtr = reinterpret_cast<CreateWebEngineFunction>(dlsym(mHandle, "CreateWebEnginePlugin"));
125 if(mCreateWebEnginePtr == nullptr)
127 DALI_LOG_ERROR("Can't load symbol CreateWebEnginePlugin(), error: %s\n", dlerror());
132 mDestroyWebEnginePtr = reinterpret_cast<DestroyWebEngineFunction>(dlsym(mHandle, "DestroyWebEnginePlugin"));
133 if(mDestroyWebEnginePtr == nullptr)
135 DALI_LOG_ERROR("Can't load symbol DestroyWebEnginePlugin(), error: %s\n", dlerror());
142 bool InitializeContextHandle()
144 if(!InitializePluginHandle())
149 mGetWebEngineContextPtr = reinterpret_cast<GetWebEngineContext>(dlsym(mHandle, "GetWebEngineContext"));
151 if(!mGetWebEngineContextPtr)
153 DALI_LOG_ERROR("Can't load symbol GetWebEngineContext(), error: %s\n", dlerror());
160 bool InitializeCookieManagerHandle()
162 if(!InitializePluginHandle())
167 mGetWebEngineCookieManagerPtr = reinterpret_cast<GetWebEngineCookieManager>(dlsym(mHandle, "GetWebEngineCookieManager"));
169 if(!mGetWebEngineCookieManagerPtr)
171 DALI_LOG_ERROR("Can't load symbol GetWebEngineCookieManager(), error: %s\n", dlerror());
179 WebEnginePluginObject(const WebEnginePluginObject&) = delete;
180 WebEnginePluginObject(WebEnginePluginObject&&) = delete;
181 WebEnginePluginObject& operator=(const WebEnginePluginObject&) = delete;
182 WebEnginePluginObject& operator=(WebEnginePluginObject&&) = delete;
185 std::string mPluginName; ///< Name of web engine plugin
186 /// Note: Dali WebView policy does not allow to use multiple web engines in an application.
187 /// So once pluginName is set to non-empty string, it will not change.
190 using CreateWebEngineFunction = Dali::WebEnginePlugin* (*)();
191 using DestroyWebEngineFunction = void (*)(Dali::WebEnginePlugin* plugin);
193 using GetWebEngineContext = Dali::WebEngineContext* (*)();
194 using GetWebEngineCookieManager = Dali::WebEngineCookieManager* (*)();
196 void* mHandle; ///< Handle for the loaded library
197 CreateWebEngineFunction mCreateWebEnginePtr; ///< Function to create plugin instance
198 DestroyWebEngineFunction mDestroyWebEnginePtr; ///< Function to destroy plugin instance
200 GetWebEngineContext mGetWebEngineContextPtr; ///< Function to get WebEngineContext
201 GetWebEngineCookieManager mGetWebEngineCookieManagerPtr; ///< Function to get WebEngineCookieManager
204 static WebEnginePluginObject gPluginHandle; // Keep this object as static, so Let we assume that library closed after all WebEngines are disposed.
206 } // unnamed namespace
208 WebEnginePtr WebEngine::New()
210 WebEngine* instance = new WebEngine();
211 if(!instance->Initialize())
220 Dali::WebEngineContext* WebEngine::GetContext()
222 if(!gPluginHandle.InitializeContextHandle())
227 if(gPluginHandle.mGetWebEngineContextPtr)
229 return gPluginHandle.mGetWebEngineContextPtr();
235 Dali::WebEngineCookieManager* WebEngine::GetCookieManager()
237 if(!gPluginHandle.InitializeCookieManagerHandle())
242 if(gPluginHandle.mGetWebEngineCookieManagerPtr)
244 return gPluginHandle.mGetWebEngineCookieManagerPtr();
250 WebEngine::WebEngine()
255 WebEngine::~WebEngine()
257 if(mPlugin != nullptr)
260 if(gPluginHandle.mDestroyWebEnginePtr != nullptr)
262 gPluginHandle.mDestroyWebEnginePtr(mPlugin);
268 bool WebEngine::Initialize()
270 if(!gPluginHandle.InitializePluginHandle())
275 mPlugin = gPluginHandle.mCreateWebEnginePtr();
276 if(mPlugin == nullptr)
278 DALI_LOG_ERROR("Can't create the WebEnginePlugin object\n");
284 void WebEngine::Create(uint32_t width, uint32_t height, const std::string& locale, const std::string& timezoneId)
286 mPlugin->Create(width, height, locale, timezoneId);
289 void WebEngine::Create(uint32_t width, uint32_t height, uint32_t argc, char** argv)
291 mPlugin->Create(width, height, argc, argv);
294 void WebEngine::Destroy()
299 Dali::WebEnginePlugin* WebEngine::GetPlugin() const
304 Dali::NativeImageSourcePtr WebEngine::GetNativeImageSource()
306 return mPlugin->GetNativeImageSource();
309 Dali::WebEngineSettings& WebEngine::GetSettings() const
311 return mPlugin->GetSettings();
314 Dali::WebEngineBackForwardList& WebEngine::GetBackForwardList() const
316 return mPlugin->GetBackForwardList();
319 void WebEngine::LoadUrl(const std::string& url)
321 mPlugin->LoadUrl(url);
324 std::string WebEngine::GetTitle() const
326 return mPlugin->GetTitle();
329 Dali::PixelData WebEngine::GetFavicon() const
331 return mPlugin->GetFavicon();
334 std::string WebEngine::GetUrl() const
336 return mPlugin->GetUrl();
339 std::string WebEngine::GetUserAgent() const
341 return mPlugin->GetUserAgent();
344 void WebEngine::SetUserAgent(const std::string& userAgent)
346 mPlugin->SetUserAgent(userAgent);
349 void WebEngine::LoadHtmlString(const std::string& htmlString)
351 mPlugin->LoadHtmlString(htmlString);
354 bool WebEngine::LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl)
356 return mPlugin->LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
359 bool WebEngine::LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
361 return mPlugin->LoadContents(contents, contentSize, mimeType, encoding, baseUri);
364 void WebEngine::Reload()
369 bool WebEngine::ReloadWithoutCache()
371 return mPlugin->ReloadWithoutCache();
374 void WebEngine::StopLoading()
376 mPlugin->StopLoading();
379 void WebEngine::Suspend()
384 void WebEngine::Resume()
389 void WebEngine::SuspendNetworkLoading()
391 mPlugin->SuspendNetworkLoading();
394 void WebEngine::ResumeNetworkLoading()
396 mPlugin->ResumeNetworkLoading();
399 bool WebEngine::AddCustomHeader(const std::string& name, const std::string& value)
401 return mPlugin->AddCustomHeader(name, value);
404 bool WebEngine::RemoveCustomHeader(const std::string& name)
406 return mPlugin->RemoveCustomHeader(name);
409 uint32_t WebEngine::StartInspectorServer(uint32_t port)
411 return mPlugin->StartInspectorServer(port);
414 bool WebEngine::StopInspectorServer()
416 return mPlugin->StopInspectorServer();
419 void WebEngine::ScrollBy(int32_t deltaX, int32_t deltaY)
421 mPlugin->ScrollBy(deltaX, deltaY);
424 bool WebEngine::ScrollEdgeBy(int32_t deltaX, int32_t deltaY)
426 return mPlugin->ScrollEdgeBy(deltaX, deltaY);
429 void WebEngine::SetScrollPosition(int32_t x, int32_t y)
431 mPlugin->SetScrollPosition(x, y);
434 Dali::Vector2 WebEngine::GetScrollPosition() const
436 return mPlugin->GetScrollPosition();
439 Dali::Vector2 WebEngine::GetScrollSize() const
441 return mPlugin->GetScrollSize();
444 Dali::Vector2 WebEngine::GetContentSize() const
446 return mPlugin->GetContentSize();
449 void WebEngine::RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback)
451 mPlugin->RegisterJavaScriptAlertCallback(callback);
454 void WebEngine::JavaScriptAlertReply()
456 mPlugin->JavaScriptAlertReply();
459 void WebEngine::RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback)
461 mPlugin->RegisterJavaScriptConfirmCallback(callback);
464 void WebEngine::JavaScriptConfirmReply(bool confirmed)
466 mPlugin->JavaScriptConfirmReply(confirmed);
469 void WebEngine::RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback)
471 mPlugin->RegisterJavaScriptPromptCallback(callback);
474 void WebEngine::JavaScriptPromptReply(const std::string& result)
476 mPlugin->JavaScriptPromptReply(result);
479 std::unique_ptr<Dali::WebEngineHitTest> WebEngine::CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode)
481 return mPlugin->CreateHitTest(x, y, mode);
484 bool WebEngine::CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback)
486 return mPlugin->CreateHitTestAsynchronously(x, y, mode, callback);
489 bool WebEngine::CanGoForward()
491 return mPlugin->CanGoForward();
494 void WebEngine::GoForward()
496 mPlugin->GoForward();
499 bool WebEngine::CanGoBack()
501 return mPlugin->CanGoBack();
504 void WebEngine::GoBack()
509 void WebEngine::EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler)
511 mPlugin->EvaluateJavaScript(script, resultHandler);
514 void WebEngine::AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler)
516 mPlugin->AddJavaScriptMessageHandler(exposedObjectName, handler);
519 void WebEngine::ClearAllTilesResources()
521 mPlugin->ClearAllTilesResources();
524 void WebEngine::ClearHistory()
526 mPlugin->ClearHistory();
529 void WebEngine::SetSize(uint32_t width, uint32_t height)
531 mPlugin->SetSize(width, height);
534 void WebEngine::EnableMouseEvents(bool enabled)
536 mPlugin->EnableMouseEvents(enabled);
539 void WebEngine::EnableKeyEvents(bool enabled)
541 mPlugin->EnableKeyEvents(enabled);
544 bool WebEngine::SendTouchEvent(const Dali::TouchEvent& touch)
546 return mPlugin->SendTouchEvent(touch);
549 bool WebEngine::SendKeyEvent(const Dali::KeyEvent& event)
551 return mPlugin->SendKeyEvent(event);
554 void WebEngine::SetFocus(bool focused)
556 mPlugin->SetFocus(focused);
559 void WebEngine::SetDocumentBackgroundColor(Dali::Vector4 color)
561 mPlugin->SetDocumentBackgroundColor(color);
564 void WebEngine::ClearTilesWhenHidden(bool cleared)
566 mPlugin->ClearTilesWhenHidden(cleared);
569 void WebEngine::SetTileCoverAreaMultiplier(float multiplier)
571 mPlugin->SetTileCoverAreaMultiplier(multiplier);
574 void WebEngine::EnableCursorByClient(bool enabled)
576 mPlugin->EnableCursorByClient(enabled);
579 std::string WebEngine::GetSelectedText() const
581 return mPlugin->GetSelectedText();
584 void WebEngine::SetPageZoomFactor(float zoomFactor)
586 mPlugin->SetPageZoomFactor(zoomFactor);
589 float WebEngine::GetPageZoomFactor() const
591 return mPlugin->GetPageZoomFactor();
594 void WebEngine::SetTextZoomFactor(float zoomFactor)
596 mPlugin->SetTextZoomFactor(zoomFactor);
599 float WebEngine::GetTextZoomFactor() const
601 return mPlugin->GetTextZoomFactor();
604 float WebEngine::GetLoadProgressPercentage() const
606 return mPlugin->GetLoadProgressPercentage();
609 void WebEngine::SetScaleFactor(float scaleFactor, Dali::Vector2 point)
611 mPlugin->SetScaleFactor(scaleFactor, point);
614 float WebEngine::GetScaleFactor() const
616 return mPlugin->GetScaleFactor();
619 void WebEngine::ActivateAccessibility(bool activated)
621 mPlugin->ActivateAccessibility(activated);
624 Accessibility::Address WebEngine::GetAccessibilityAddress()
626 return mPlugin->GetAccessibilityAddress();
629 bool WebEngine::SetVisibility(bool visible)
631 return mPlugin->SetVisibility(visible);
634 bool WebEngine::HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount)
636 return mPlugin->HighlightText(text, options, maxMatchCount);
639 void WebEngine::AddDynamicCertificatePath(const std::string& host, const std::string& certPath)
641 mPlugin->AddDynamicCertificatePath(host, certPath);
644 Dali::PixelData WebEngine::GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor)
646 return mPlugin->GetScreenshot(viewArea, scaleFactor);
649 bool WebEngine::GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback)
651 return mPlugin->GetScreenshotAsynchronously(viewArea, scaleFactor, callback);
654 bool WebEngine::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
656 return mPlugin->CheckVideoPlayingAsynchronously(callback);
659 void WebEngine::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
661 mPlugin->RegisterGeolocationPermissionCallback(callback);
664 void WebEngine::UpdateDisplayArea(Dali::Rect<int32_t> displayArea)
666 mPlugin->UpdateDisplayArea(displayArea);
669 void WebEngine::EnableVideoHole(bool enabled)
671 mPlugin->EnableVideoHole(enabled);
674 bool WebEngine::SendHoverEvent(const Dali::HoverEvent& event)
676 return mPlugin->SendHoverEvent(event);
679 bool WebEngine::SendWheelEvent(const Dali::WheelEvent& event)
681 return mPlugin->SendWheelEvent(event);
684 Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& WebEngine::FrameRenderedSignal()
686 return mPlugin->FrameRenderedSignal();
689 void WebEngine::RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
691 mPlugin->RegisterPageLoadStartedCallback(callback);
694 void WebEngine::RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
696 mPlugin->RegisterPageLoadInProgressCallback(callback);
699 void WebEngine::RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
701 mPlugin->RegisterPageLoadFinishedCallback(callback);
704 void WebEngine::RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback)
706 mPlugin->RegisterPageLoadErrorCallback(callback);
709 void WebEngine::RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback)
711 mPlugin->RegisterScrollEdgeReachedCallback(callback);
714 void WebEngine::RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback)
716 mPlugin->RegisterUrlChangedCallback(callback);
719 void WebEngine::RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback)
721 mPlugin->RegisterFormRepostDecidedCallback(callback);
724 void WebEngine::RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback)
726 mPlugin->RegisterConsoleMessageReceivedCallback(callback);
729 void WebEngine::RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback)
731 mPlugin->RegisterResponsePolicyDecidedCallback(callback);
734 void WebEngine::RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback)
736 mPlugin->RegisterNavigationPolicyDecidedCallback(callback);
739 void WebEngine::RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
741 mPlugin->RegisterCertificateConfirmedCallback(callback);
744 void WebEngine::RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
746 mPlugin->RegisterSslCertificateChangedCallback(callback);
749 void WebEngine::RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback)
751 mPlugin->RegisterHttpAuthHandlerCallback(callback);
754 void WebEngine::RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback)
756 mPlugin->RegisterContextMenuShownCallback(callback);
759 void WebEngine::RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback)
761 mPlugin->RegisterContextMenuHiddenCallback(callback);
764 void WebEngine::GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback)
766 mPlugin->GetPlainTextAsynchronously(callback);
769 } // namespace Adaptor
770 } // namespace Internal