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 // 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;
60 std::string MakePluginName(const char* environmentName)
62 std::stringstream fullName;
63 fullName << kPluginFullNamePrefix << environmentName << kPluginFullNamePostfix;
64 return std::move(fullName.str());
67 Dali::BaseHandle Create()
69 return Dali::WebEngine::New();
72 Dali::TypeRegistration type(typeid(Dali::WebEngine), typeid(Dali::BaseHandle), Create);
74 } // unnamed namespace
76 void* WebEngine::mHandle = nullptr;
77 WebEngine::CreateWebEngineFunction WebEngine::mCreateWebEnginePtr = nullptr;
78 WebEngine::DestroyWebEngineFunction WebEngine::mDestroyWebEnginePtr = nullptr;
80 WebEnginePtr WebEngine::New()
82 WebEngine* instance = new WebEngine();
83 if(!instance->Initialize())
92 Dali::WebEngineContext* WebEngine::GetContext()
94 if(!InitializePluginHandle())
99 using GetWebEngineContext = Dali::WebEngineContext* (*)();
100 GetWebEngineContext getWebEngineContextPtr = reinterpret_cast<GetWebEngineContext>(dlsym(mHandle, "GetWebEngineContext"));
101 if(getWebEngineContextPtr)
103 return getWebEngineContextPtr();
109 Dali::WebEngineCookieManager* WebEngine::GetCookieManager()
111 if(!InitializePluginHandle())
116 using GetWebEngineCookieManager = Dali::WebEngineCookieManager* (*)();
117 GetWebEngineCookieManager getWebEngineCookieManagerPtr = reinterpret_cast<GetWebEngineCookieManager>(dlsym(mHandle, "GetWebEngineCookieManager"));
118 if(getWebEngineCookieManagerPtr)
120 return getWebEngineCookieManagerPtr();
126 bool WebEngine::InitializePluginHandle()
130 DALI_LOG_ERROR("Plugin.so has been opened already.\n");
134 if(pluginName.length() == 0)
136 // pluginName is not initialized yet.
137 const char* name = EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_WEB_ENGINE_NAME);
140 pluginName = MakePluginName(name);
144 pluginName = std::string(kPluginFullNameDefault);
148 mHandle = dlopen(pluginName.c_str(), RTLD_LAZY);
151 DALI_LOG_ERROR("Can't load %s : %s\n", pluginName.c_str(), dlerror());
155 // Make sure that mHandle would be closed.
156 Dali::LifecycleController::Get().TerminateSignal().Connect(&WebEngine::ClosePluginHandle);
158 mCreateWebEnginePtr = reinterpret_cast<CreateWebEngineFunction>(dlsym(mHandle, "CreateWebEnginePlugin"));
159 if(mCreateWebEnginePtr == nullptr)
161 DALI_LOG_ERROR("Can't load symbol CreateWebEnginePlugin(), error: %s\n", dlerror());
165 mDestroyWebEnginePtr = reinterpret_cast<DestroyWebEngineFunction>(dlsym(mHandle, "DestroyWebEnginePlugin"));
166 if(mDestroyWebEnginePtr == nullptr)
168 DALI_LOG_ERROR("Can't load symbol DestroyWebEnginePlugin(), error: %s\n", dlerror());
175 void WebEngine::ClosePluginHandle()
184 WebEngine::WebEngine()
189 WebEngine::~WebEngine()
191 if(mPlugin != nullptr && mDestroyWebEnginePtr != nullptr)
194 mDestroyWebEnginePtr(mPlugin);
198 bool WebEngine::Initialize()
200 if(!InitializePluginHandle())
205 mPlugin = mCreateWebEnginePtr();
206 if(mPlugin == nullptr)
208 DALI_LOG_ERROR("Can't create the WebEnginePlugin object\n");
215 void WebEngine::Create(uint32_t width, uint32_t height, const std::string& locale, const std::string& timezoneId)
217 mPlugin->Create(width, height, locale, timezoneId);
220 void WebEngine::Create(uint32_t width, uint32_t height, uint32_t argc, char** argv)
222 mPlugin->Create(width, height, argc, argv);
225 void WebEngine::Destroy()
230 Dali::NativeImageSourcePtr WebEngine::GetNativeImageSource()
232 return mPlugin->GetNativeImageSource();
235 Dali::WebEngineSettings& WebEngine::GetSettings() const
237 return mPlugin->GetSettings();
240 Dali::WebEngineBackForwardList& WebEngine::GetBackForwardList() const
242 return mPlugin->GetBackForwardList();
245 void WebEngine::LoadUrl(const std::string& url)
247 mPlugin->LoadUrl(url);
250 std::string WebEngine::GetTitle() const
252 return mPlugin->GetTitle();
255 Dali::PixelData WebEngine::GetFavicon() const
257 return mPlugin->GetFavicon();
260 std::string WebEngine::GetUrl() const
262 return mPlugin->GetUrl();
265 std::string WebEngine::GetUserAgent() const
267 return mPlugin->GetUserAgent();
270 void WebEngine::SetUserAgent(const std::string& userAgent)
272 mPlugin->SetUserAgent(userAgent);
275 void WebEngine::LoadHtmlString(const std::string& htmlString)
277 mPlugin->LoadHtmlString(htmlString);
280 bool WebEngine::LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl)
282 return mPlugin->LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
285 bool WebEngine::LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
287 return mPlugin->LoadContents(contents, contentSize, mimeType, encoding, baseUri);
290 void WebEngine::Reload()
295 bool WebEngine::ReloadWithoutCache()
297 return mPlugin->ReloadWithoutCache();
300 void WebEngine::StopLoading()
302 mPlugin->StopLoading();
305 void WebEngine::Suspend()
310 void WebEngine::Resume()
315 void WebEngine::SuspendNetworkLoading()
317 mPlugin->SuspendNetworkLoading();
320 void WebEngine::ResumeNetworkLoading()
322 mPlugin->ResumeNetworkLoading();
325 bool WebEngine::AddCustomHeader(const std::string& name, const std::string& value)
327 return mPlugin->AddCustomHeader(name, value);
330 bool WebEngine::RemoveCustomHeader(const std::string& name)
332 return mPlugin->RemoveCustomHeader(name);
335 uint32_t WebEngine::StartInspectorServer(uint32_t port)
337 return mPlugin->StartInspectorServer(port);
340 bool WebEngine::StopInspectorServer()
342 return mPlugin->StopInspectorServer();
345 void WebEngine::ScrollBy(int32_t deltaX, int32_t deltaY)
347 mPlugin->ScrollBy(deltaX, deltaY);
350 bool WebEngine::ScrollEdgeBy(int32_t deltaX, int32_t deltaY)
352 return mPlugin->ScrollEdgeBy(deltaX, deltaY);
355 void WebEngine::SetScrollPosition(int32_t x, int32_t y)
357 mPlugin->SetScrollPosition(x, y);
360 Dali::Vector2 WebEngine::GetScrollPosition() const
362 return mPlugin->GetScrollPosition();
365 Dali::Vector2 WebEngine::GetScrollSize() const
367 return mPlugin->GetScrollSize();
370 Dali::Vector2 WebEngine::GetContentSize() const
372 return mPlugin->GetContentSize();
375 void WebEngine::RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback)
377 mPlugin->RegisterJavaScriptAlertCallback(callback);
380 void WebEngine::JavaScriptAlertReply()
382 mPlugin->JavaScriptAlertReply();
385 void WebEngine::RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback)
387 mPlugin->RegisterJavaScriptConfirmCallback(callback);
390 void WebEngine::JavaScriptConfirmReply(bool confirmed)
392 mPlugin->JavaScriptConfirmReply(confirmed);
395 void WebEngine::RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback)
397 mPlugin->RegisterJavaScriptPromptCallback(callback);
400 void WebEngine::JavaScriptPromptReply(const std::string& result)
402 mPlugin->JavaScriptPromptReply(result);
405 std::unique_ptr<Dali::WebEngineHitTest> WebEngine::CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode)
407 return mPlugin->CreateHitTest(x, y, mode);
410 bool WebEngine::CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback)
412 return mPlugin->CreateHitTestAsynchronously(x, y, mode, callback);
415 bool WebEngine::CanGoForward()
417 return mPlugin->CanGoForward();
420 void WebEngine::GoForward()
422 mPlugin->GoForward();
425 bool WebEngine::CanGoBack()
427 return mPlugin->CanGoBack();
430 void WebEngine::GoBack()
435 void WebEngine::EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler)
437 mPlugin->EvaluateJavaScript(script, resultHandler);
440 void WebEngine::AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler)
442 mPlugin->AddJavaScriptMessageHandler(exposedObjectName, handler);
445 void WebEngine::ClearAllTilesResources()
447 mPlugin->ClearAllTilesResources();
450 void WebEngine::ClearHistory()
452 mPlugin->ClearHistory();
455 void WebEngine::SetSize(uint32_t width, uint32_t height)
457 mPlugin->SetSize(width, height);
460 void WebEngine::EnableMouseEvents(bool enabled)
462 mPlugin->EnableMouseEvents(enabled);
465 void WebEngine::EnableKeyEvents(bool enabled)
467 mPlugin->EnableKeyEvents(enabled);
470 bool WebEngine::SendTouchEvent(const Dali::TouchEvent& touch)
472 return mPlugin->SendTouchEvent(touch);
475 bool WebEngine::SendKeyEvent(const Dali::KeyEvent& event)
477 return mPlugin->SendKeyEvent(event);
480 void WebEngine::SetFocus(bool focused)
482 mPlugin->SetFocus(focused);
485 void WebEngine::SetDocumentBackgroundColor(Dali::Vector4 color)
487 mPlugin->SetDocumentBackgroundColor(color);
490 void WebEngine::ClearTilesWhenHidden(bool cleared)
492 mPlugin->ClearTilesWhenHidden(cleared);
495 void WebEngine::SetTileCoverAreaMultiplier(float multiplier)
497 mPlugin->SetTileCoverAreaMultiplier(multiplier);
500 void WebEngine::EnableCursorByClient(bool enabled)
502 mPlugin->EnableCursorByClient(enabled);
505 std::string WebEngine::GetSelectedText() const
507 return mPlugin->GetSelectedText();
510 void WebEngine::SetPageZoomFactor(float zoomFactor)
512 mPlugin->SetPageZoomFactor(zoomFactor);
515 float WebEngine::GetPageZoomFactor() const
517 return mPlugin->GetPageZoomFactor();
520 void WebEngine::SetTextZoomFactor(float zoomFactor)
522 mPlugin->SetTextZoomFactor(zoomFactor);
525 float WebEngine::GetTextZoomFactor() const
527 return mPlugin->GetTextZoomFactor();
530 float WebEngine::GetLoadProgressPercentage() const
532 return mPlugin->GetLoadProgressPercentage();
535 void WebEngine::SetScaleFactor(float scaleFactor, Dali::Vector2 point)
537 mPlugin->SetScaleFactor(scaleFactor, point);
540 float WebEngine::GetScaleFactor() const
542 return mPlugin->GetScaleFactor();
545 void WebEngine::ActivateAccessibility(bool activated)
547 mPlugin->ActivateAccessibility(activated);
550 Accessibility::Address WebEngine::GetAccessibilityAddress()
552 return mPlugin->GetAccessibilityAddress();
555 bool WebEngine::SetVisibility(bool visible)
557 return mPlugin->SetVisibility(visible);
560 bool WebEngine::HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount)
562 return mPlugin->HighlightText(text, options, maxMatchCount);
565 void WebEngine::AddDynamicCertificatePath(const std::string& host, const std::string& certPath)
567 mPlugin->AddDynamicCertificatePath(host, certPath);
570 Dali::PixelData WebEngine::GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor)
572 return mPlugin->GetScreenshot(viewArea, scaleFactor);
575 bool WebEngine::GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback)
577 return mPlugin->GetScreenshotAsynchronously(viewArea, scaleFactor, callback);
580 bool WebEngine::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
582 return mPlugin->CheckVideoPlayingAsynchronously(callback);
585 void WebEngine::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
587 mPlugin->RegisterGeolocationPermissionCallback(callback);
590 void WebEngine::UpdateDisplayArea(Dali::Rect<int32_t> displayArea)
592 mPlugin->UpdateDisplayArea(displayArea);
595 void WebEngine::EnableVideoHole(bool enabled)
597 mPlugin->EnableVideoHole(enabled);
600 bool WebEngine::SendHoverEvent(const Dali::HoverEvent& event)
602 return mPlugin->SendHoverEvent(event);
605 bool WebEngine::SendWheelEvent(const Dali::WheelEvent& event)
607 return mPlugin->SendWheelEvent(event);
610 Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& WebEngine::FrameRenderedSignal()
612 return mPlugin->FrameRenderedSignal();
615 void WebEngine::RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
617 mPlugin->RegisterPageLoadStartedCallback(callback);
620 void WebEngine::RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
622 mPlugin->RegisterPageLoadInProgressCallback(callback);
625 void WebEngine::RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
627 mPlugin->RegisterPageLoadFinishedCallback(callback);
630 void WebEngine::RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback)
632 mPlugin->RegisterPageLoadErrorCallback(callback);
635 void WebEngine::RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback)
637 mPlugin->RegisterScrollEdgeReachedCallback(callback);
640 void WebEngine::RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback)
642 mPlugin->RegisterUrlChangedCallback(callback);
645 void WebEngine::RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback)
647 mPlugin->RegisterFormRepostDecidedCallback(callback);
650 void WebEngine::RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback)
652 mPlugin->RegisterConsoleMessageReceivedCallback(callback);
655 void WebEngine::RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback)
657 mPlugin->RegisterResponsePolicyDecidedCallback(callback);
660 void WebEngine::RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback)
662 mPlugin->RegisterNavigationPolicyDecidedCallback(callback);
665 void WebEngine::RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
667 mPlugin->RegisterCertificateConfirmedCallback(callback);
670 void WebEngine::RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
672 mPlugin->RegisterSslCertificateChangedCallback(callback);
675 void WebEngine::RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback)
677 mPlugin->RegisterHttpAuthHandlerCallback(callback);
680 void WebEngine::RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback)
682 mPlugin->RegisterContextMenuShownCallback(callback);
685 void WebEngine::RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback)
687 mPlugin->RegisterContextMenuHiddenCallback(callback);
690 void WebEngine::GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback)
692 mPlugin->GetPlainTextAsynchronously(callback);
695 } // namespace Adaptor
696 } // namespace Internal