2 * Copyright (c) 2021 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/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>
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 WebEnginePtr WebEngine::New()
78 WebEngine* instance = new WebEngine();
80 if(!instance->Initialize())
89 WebEngine::WebEngine()
92 mCreateWebEnginePtr(NULL),
93 mDestroyWebEnginePtr(NULL)
97 WebEngine::~WebEngine()
101 if(mDestroyWebEnginePtr != NULL)
104 mDestroyWebEnginePtr(mPlugin);
111 bool WebEngine::InitializePluginHandle()
113 if(pluginName.length() == 0)
115 // pluginName is not initialized yet.
116 const char* name = EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_WEB_ENGINE_NAME);
119 pluginName = MakePluginName(name);
120 mHandle = dlopen(pluginName.c_str(), RTLD_LAZY);
126 pluginName = std::string(kPluginFullNameDefault);
129 mHandle = dlopen(pluginName.c_str(), RTLD_LAZY);
132 DALI_LOG_ERROR("Can't load %s : %s\n", pluginName.c_str(), dlerror());
139 bool WebEngine::Initialize()
143 if(!InitializePluginHandle())
148 mCreateWebEnginePtr = reinterpret_cast<CreateWebEngineFunction>(dlsym(mHandle, "CreateWebEnginePlugin"));
149 if(mCreateWebEnginePtr == NULL)
151 DALI_LOG_ERROR("Can't load symbol CreateWebEnginePlugin(), error: %s\n", error);
155 mDestroyWebEnginePtr = reinterpret_cast<DestroyWebEngineFunction>(dlsym(mHandle, "DestroyWebEnginePlugin"));
157 if(mDestroyWebEnginePtr == NULL)
159 DALI_LOG_ERROR("Can't load symbol DestroyWebEnginePlugin(), error: %s\n", error);
163 mPlugin = mCreateWebEnginePtr();
167 DALI_LOG_ERROR("Can't create the WebEnginePlugin object\n");
174 void WebEngine::Create(int width, int height, const std::string& locale, const std::string& timezoneId)
176 mPlugin->Create(width, height, locale, timezoneId);
179 void WebEngine::Create(int width, int height, int argc, char** argv)
181 mPlugin->Create(width, height, argc, argv);
184 void WebEngine::Destroy()
189 Dali::NativeImageInterfacePtr WebEngine::GetNativeImageSource()
191 return mPlugin->GetNativeImageSource();
194 Dali::WebEngineSettings& WebEngine::GetSettings() const
196 return mPlugin->GetSettings();
199 Dali::WebEngineContext& WebEngine::GetContext() const
201 return mPlugin->GetContext();
204 Dali::WebEngineCookieManager& WebEngine::GetCookieManager() const
206 return mPlugin->GetCookieManager();
209 Dali::WebEngineBackForwardList& WebEngine::GetBackForwardList() const
211 return mPlugin->GetBackForwardList();
214 void WebEngine::LoadUrl(const std::string& url)
216 mPlugin->LoadUrl(url);
219 std::string WebEngine::GetTitle() const
221 return mPlugin->GetTitle();
224 Dali::PixelData WebEngine::GetFavicon() const
226 return mPlugin->GetFavicon();
229 const std::string& WebEngine::GetUrl()
231 return mPlugin->GetUrl();
234 const std::string& WebEngine::GetUserAgent() const
236 return mPlugin->GetUserAgent();
239 void WebEngine::SetUserAgent(const std::string& userAgent)
241 mPlugin->SetUserAgent(userAgent);
244 void WebEngine::LoadHtmlString(const std::string& htmlString)
246 mPlugin->LoadHtmlString(htmlString);
249 bool WebEngine::LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl)
251 return mPlugin->LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
254 bool WebEngine::LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
256 return mPlugin->LoadContents(contents, contentSize, mimeType, encoding, baseUri);
259 void WebEngine::Reload()
264 bool WebEngine::ReloadWithoutCache()
266 return mPlugin->ReloadWithoutCache();
269 void WebEngine::StopLoading()
271 mPlugin->StopLoading();
274 void WebEngine::Suspend()
279 void WebEngine::Resume()
284 void WebEngine::SuspendNetworkLoading()
286 mPlugin->SuspendNetworkLoading();
289 void WebEngine::ResumeNetworkLoading()
291 mPlugin->ResumeNetworkLoading();
294 bool WebEngine::AddCustomHeader(const std::string& name, const std::string& value)
296 return mPlugin->AddCustomHeader(name, value);
299 bool WebEngine::RemoveCustomHeader(const std::string& name)
301 return mPlugin->RemoveCustomHeader(name);
304 uint32_t WebEngine::StartInspectorServer(uint32_t port)
306 return mPlugin->StartInspectorServer(port);
309 bool WebEngine::StopInspectorServer()
311 return mPlugin->StopInspectorServer();
314 void WebEngine::ScrollBy(int deltaX, int deltaY)
316 mPlugin->ScrollBy(deltaX, deltaY);
319 bool WebEngine::ScrollEdgeBy(int deltaX, int deltaY)
321 return mPlugin->ScrollEdgeBy(deltaX, deltaY);
324 void WebEngine::SetScrollPosition(int x, int y)
326 mPlugin->SetScrollPosition(x, y);
329 Dali::Vector2 WebEngine::GetScrollPosition() const
331 return mPlugin->GetScrollPosition();
334 Dali::Vector2 WebEngine::GetScrollSize() const
336 return mPlugin->GetScrollSize();
339 Dali::Vector2 WebEngine::GetContentSize() const
341 return mPlugin->GetContentSize();
344 void WebEngine::RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback)
346 mPlugin->RegisterJavaScriptAlertCallback(callback);
349 void WebEngine::JavaScriptAlertReply()
351 mPlugin->JavaScriptAlertReply();
354 void WebEngine::RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback)
356 mPlugin->RegisterJavaScriptConfirmCallback(callback);
359 void WebEngine::JavaScriptConfirmReply(bool confirmed)
361 mPlugin->JavaScriptConfirmReply(confirmed);
364 void WebEngine::RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback)
366 mPlugin->RegisterJavaScriptPromptCallback(callback);
369 void WebEngine::JavaScriptPromptReply(const std::string& result)
371 mPlugin->JavaScriptPromptReply(result);
374 bool WebEngine::CanGoForward()
376 return mPlugin->CanGoForward();
379 void WebEngine::GoForward()
381 mPlugin->GoForward();
384 bool WebEngine::CanGoBack()
386 return mPlugin->CanGoBack();
389 void WebEngine::GoBack()
394 void WebEngine::EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler)
396 mPlugin->EvaluateJavaScript(script, resultHandler);
399 void WebEngine::AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler)
401 mPlugin->AddJavaScriptMessageHandler(exposedObjectName, handler);
404 void WebEngine::ClearAllTilesResources()
406 mPlugin->ClearAllTilesResources();
409 void WebEngine::ClearHistory()
411 mPlugin->ClearHistory();
414 void WebEngine::SetSize(int width, int height)
416 mPlugin->SetSize(width, height);
419 void WebEngine::EnableMouseEvents(bool enabled)
421 mPlugin->EnableMouseEvents(enabled);
424 void WebEngine::EnableKeyEvents(bool enabled)
426 mPlugin->EnableKeyEvents(enabled);
429 bool WebEngine::SendTouchEvent(const Dali::TouchEvent& touch)
431 return mPlugin->SendTouchEvent(touch);
434 bool WebEngine::SendKeyEvent(const Dali::KeyEvent& event)
436 return mPlugin->SendKeyEvent(event);
439 void WebEngine::SetFocus(bool focused)
441 mPlugin->SetFocus(focused);
444 void WebEngine::SetDocumentBackgroundColor(Dali::Vector4 color)
446 mPlugin->SetDocumentBackgroundColor(color);
449 void WebEngine::ClearTilesWhenHidden(bool cleared)
451 mPlugin->ClearTilesWhenHidden(cleared);
454 void WebEngine::SetTileCoverAreaMultiplier(float multiplier)
456 mPlugin->SetTileCoverAreaMultiplier(multiplier);
459 void WebEngine::EnableCursorByClient(bool enabled)
461 mPlugin->EnableCursorByClient(enabled);
464 std::string WebEngine::GetSelectedText() const
466 return mPlugin->GetSelectedText();
469 void WebEngine::SetPageZoomFactor(float zoomFactor)
471 mPlugin->SetPageZoomFactor(zoomFactor);
474 float WebEngine::GetPageZoomFactor() const
476 return mPlugin->GetPageZoomFactor();
479 void WebEngine::SetTextZoomFactor(float zoomFactor)
481 mPlugin->SetTextZoomFactor(zoomFactor);
484 float WebEngine::GetTextZoomFactor() const
486 return mPlugin->GetTextZoomFactor();
489 float WebEngine::GetLoadProgressPercentage() const
491 return mPlugin->GetLoadProgressPercentage();
494 void WebEngine::SetScaleFactor(float scaleFactor, Dali::Vector2 point)
496 mPlugin->SetScaleFactor(scaleFactor, point);
499 float WebEngine::GetScaleFactor() const
501 return mPlugin->GetScaleFactor();
504 void WebEngine::ActivateAccessibility(bool activated)
506 mPlugin->ActivateAccessibility(activated);
509 bool WebEngine::SetVisibility(bool visible)
511 return mPlugin->SetVisibility(visible);
514 bool WebEngine::HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount)
516 return mPlugin->HighlightText(text, options, maxMatchCount);
519 void WebEngine::AddDynamicCertificatePath(const std::string& host, const std::string& certPath)
521 mPlugin->AddDynamicCertificatePath(host, certPath);
524 Dali::PixelData WebEngine::GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor)
526 return mPlugin->GetScreenshot(viewArea, scaleFactor);
529 bool WebEngine::GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback)
531 return mPlugin->GetScreenshotAsynchronously(viewArea, scaleFactor, callback);
534 bool WebEngine::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
536 return mPlugin->CheckVideoPlayingAsynchronously(callback);
539 void WebEngine::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
541 mPlugin->RegisterGeolocationPermissionCallback(callback);
544 void WebEngine::UpdateDisplayArea(Dali::Rect<int> displayArea)
546 mPlugin->UpdateDisplayArea(displayArea);
549 void WebEngine::EnableVideoHole(bool enabled)
551 mPlugin->EnableVideoHole(enabled);
554 bool WebEngine::SendHoverEvent(const Dali::HoverEvent& event)
556 return mPlugin->SendHoverEvent(event);
559 bool WebEngine::SendWheelEvent(const Dali::WheelEvent& event)
561 return mPlugin->SendWheelEvent(event);
564 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& WebEngine::PageLoadStartedSignal()
566 return mPlugin->PageLoadStartedSignal();
569 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& WebEngine::PageLoadInProgressSignal()
571 return mPlugin->PageLoadInProgressSignal();
574 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& WebEngine::PageLoadFinishedSignal()
576 return mPlugin->PageLoadFinishedSignal();
579 Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& WebEngine::PageLoadErrorSignal()
581 return mPlugin->PageLoadErrorSignal();
584 Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& WebEngine::ScrollEdgeReachedSignal()
586 return mPlugin->ScrollEdgeReachedSignal();
589 Dali::WebEnginePlugin::WebEngineUrlChangedSignalType& WebEngine::UrlChangedSignal()
591 return mPlugin->UrlChangedSignal();
594 Dali::WebEnginePlugin::WebEngineFormRepostDecisionSignalType& WebEngine::FormRepostDecisionSignal()
596 return mPlugin->FormRepostDecisionSignal();
599 Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& WebEngine::FrameRenderedSignal()
601 return mPlugin->FrameRenderedSignal();
604 Dali::WebEnginePlugin::WebEngineRequestInterceptorSignalType& WebEngine::RequestInterceptorSignal()
606 return mPlugin->RequestInterceptorSignal();
609 Dali::WebEnginePlugin::WebEngineConsoleMessageSignalType& WebEngine::ConsoleMessageSignal()
611 return mPlugin->ConsoleMessageSignal();
614 Dali::WebEnginePlugin::WebEnginePolicyDecisionSignalType& WebEngine::PolicyDecisionSignal()
616 return mPlugin->PolicyDecisionSignal();
619 Dali::WebEnginePlugin::WebEngineCertificateSignalType& WebEngine::CertificateConfirmSignal()
621 return mPlugin->CertificateConfirmSignal();
624 Dali::WebEnginePlugin::WebEngineCertificateSignalType& WebEngine::SslCertificateChangedSignal()
626 return mPlugin->SslCertificateChangedSignal();
629 Dali::WebEnginePlugin::WebEngineHttpAuthHandlerSignalType& WebEngine::HttpAuthHandlerSignal()
631 return mPlugin->HttpAuthHandlerSignal();
634 Dali::WebEnginePlugin::WebEngineContextMenuCustomizedSignalType& WebEngine::ContextMenuCustomizedSignal()
636 return mPlugin->ContextMenuCustomizedSignal();
639 Dali::WebEnginePlugin::WebEngineContextMenuItemSelectedSignalType& WebEngine::ContextMenuItemSelectedSignal()
641 return mPlugin->ContextMenuItemSelectedSignal();
644 } // namespace Adaptor
645 } // namespace Internal