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-context.h>
31 #include <dali/devel-api/adaptor-framework/web-engine-cookie-manager.h>
32 #include <dali/devel-api/adaptor-framework/web-engine-request-interceptor.h>
33 #include <dali/devel-api/adaptor-framework/web-engine-settings.h>
34 #include <dali/internal/system/common/environment-variables.h>
35 #include <dali/public-api/adaptor-framework/native-image-source.h>
36 #include <dali/public-api/images/pixel-data.h>
44 namespace // unnamed namespace
46 constexpr char const* const kPluginFullNamePrefix = "libdali2-web-engine-";
47 constexpr char const* const kPluginFullNamePostfix = "-plugin.so";
48 constexpr char const* const kPluginFullNameDefault = "libdali2-web-engine-plugin.so";
50 // Note: Dali WebView policy does not allow to use multiple web engines in an application.
51 // So once pluginName is set to non-empty string, it will not change.
52 std::string pluginName;
54 std::string MakePluginName(const char* environmentName)
56 std::stringstream fullName;
57 fullName << kPluginFullNamePrefix << environmentName << kPluginFullNamePostfix;
58 return std::move(fullName.str());
61 Dali::BaseHandle Create()
63 return Dali::WebEngine::New();
66 Dali::TypeRegistration type(typeid(Dali::WebEngine), typeid(Dali::BaseHandle), Create);
68 } // unnamed namespace
70 WebEnginePtr WebEngine::New()
72 WebEngine* instance = new WebEngine();
74 if(!instance->Initialize())
83 WebEngine::WebEngine()
86 mCreateWebEnginePtr(NULL),
87 mDestroyWebEnginePtr(NULL)
91 WebEngine::~WebEngine()
95 if(mDestroyWebEnginePtr != NULL)
98 mDestroyWebEnginePtr(mPlugin);
105 bool WebEngine::InitializePluginHandle()
107 if(pluginName.length() == 0)
109 // pluginName is not initialized yet.
110 const char* name = EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_WEB_ENGINE_NAME);
113 pluginName = MakePluginName(name);
114 mHandle = dlopen(pluginName.c_str(), RTLD_LAZY);
120 pluginName = std::string(kPluginFullNameDefault);
123 mHandle = dlopen(pluginName.c_str(), RTLD_LAZY);
126 DALI_LOG_ERROR("Can't load %s : %s\n", pluginName.c_str(), dlerror());
133 bool WebEngine::Initialize()
137 if(!InitializePluginHandle())
142 mCreateWebEnginePtr = reinterpret_cast<CreateWebEngineFunction>(dlsym(mHandle, "CreateWebEnginePlugin"));
143 if(mCreateWebEnginePtr == NULL)
145 DALI_LOG_ERROR("Can't load symbol CreateWebEnginePlugin(), error: %s\n", error);
149 mDestroyWebEnginePtr = reinterpret_cast<DestroyWebEngineFunction>(dlsym(mHandle, "DestroyWebEnginePlugin"));
151 if(mDestroyWebEnginePtr == NULL)
153 DALI_LOG_ERROR("Can't load symbol DestroyWebEnginePlugin(), error: %s\n", error);
157 mPlugin = mCreateWebEnginePtr();
161 DALI_LOG_ERROR("Can't create the WebEnginePlugin object\n");
168 void WebEngine::Create(int width, int height, const std::string& locale, const std::string& timezoneId)
170 mPlugin->Create(width, height, locale, timezoneId);
173 void WebEngine::Create(int width, int height, int argc, char** argv)
175 mPlugin->Create(width, height, argc, argv);
178 void WebEngine::Destroy()
183 Dali::NativeImageInterfacePtr WebEngine::GetNativeImageSource()
185 return mPlugin->GetNativeImageSource();
188 Dali::WebEngineSettings& WebEngine::GetSettings() const
190 return mPlugin->GetSettings();
193 Dali::WebEngineContext& WebEngine::GetContext() const
195 return mPlugin->GetContext();
198 Dali::WebEngineCookieManager& WebEngine::GetCookieManager() const
200 return mPlugin->GetCookieManager();
203 Dali::WebEngineBackForwardList& WebEngine::GetBackForwardList() const
205 return mPlugin->GetBackForwardList();
208 void WebEngine::LoadUrl(const std::string& url)
210 mPlugin->LoadUrl(url);
213 std::string WebEngine::GetTitle() const
215 return mPlugin->GetTitle();
218 Dali::PixelData WebEngine::GetFavicon() const
220 return mPlugin->GetFavicon();
223 const std::string& WebEngine::GetUrl()
225 return mPlugin->GetUrl();
228 const std::string& WebEngine::GetUserAgent() const
230 return mPlugin->GetUserAgent();
233 void WebEngine::SetUserAgent(const std::string& userAgent)
235 mPlugin->SetUserAgent(userAgent);
238 void WebEngine::LoadHtmlString(const std::string& htmlString)
240 mPlugin->LoadHtmlString(htmlString);
243 bool WebEngine::LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl)
245 return mPlugin->LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
248 bool WebEngine::LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
250 return mPlugin->LoadContents(contents, contentSize, mimeType, encoding, baseUri);
253 void WebEngine::Reload()
258 bool WebEngine::ReloadWithoutCache()
260 return mPlugin->ReloadWithoutCache();
263 void WebEngine::StopLoading()
265 mPlugin->StopLoading();
268 void WebEngine::Suspend()
273 void WebEngine::Resume()
278 void WebEngine::SuspendNetworkLoading()
280 mPlugin->SuspendNetworkLoading();
283 void WebEngine::ResumeNetworkLoading()
285 mPlugin->ResumeNetworkLoading();
288 bool WebEngine::AddCustomHeader(const std::string& name, const std::string& value)
290 return mPlugin->AddCustomHeader(name, value);
293 bool WebEngine::RemoveCustomHeader(const std::string& name)
295 return mPlugin->RemoveCustomHeader(name);
298 uint32_t WebEngine::StartInspectorServer(uint32_t port)
300 return mPlugin->StartInspectorServer(port);
303 bool WebEngine::StopInspectorServer()
305 return mPlugin->StopInspectorServer();
308 void WebEngine::ScrollBy(int deltaX, int deltaY)
310 mPlugin->ScrollBy(deltaX, deltaY);
313 bool WebEngine::ScrollEdgeBy(int deltaX, int deltaY)
315 return mPlugin->ScrollEdgeBy(deltaX, deltaY);
318 void WebEngine::SetScrollPosition(int x, int y)
320 mPlugin->SetScrollPosition(x, y);
323 Dali::Vector2 WebEngine::GetScrollPosition() const
325 return mPlugin->GetScrollPosition();
328 Dali::Vector2 WebEngine::GetScrollSize() const
330 return mPlugin->GetScrollSize();
333 Dali::Vector2 WebEngine::GetContentSize() const
335 return mPlugin->GetContentSize();
338 void WebEngine::RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback)
340 mPlugin->RegisterJavaScriptAlertCallback(callback);
343 void WebEngine::JavaScriptAlertReply()
345 mPlugin->JavaScriptAlertReply();
348 void WebEngine::RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback)
350 mPlugin->RegisterJavaScriptAlertCallback(callback);
353 void WebEngine::JavaScriptConfirmReply(bool confirmed)
355 mPlugin->JavaScriptConfirmReply(confirmed);
358 void WebEngine::RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback)
360 mPlugin->RegisterJavaScriptPromptCallback(callback);
363 void WebEngine::JavaScriptPromptReply(const std::string& result)
365 mPlugin->JavaScriptPromptReply(result);
368 bool WebEngine::CanGoForward()
370 return mPlugin->CanGoForward();
373 void WebEngine::GoForward()
375 mPlugin->GoForward();
378 bool WebEngine::CanGoBack()
380 return mPlugin->CanGoBack();
383 void WebEngine::GoBack()
388 void WebEngine::EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler)
390 mPlugin->EvaluateJavaScript(script, resultHandler);
393 void WebEngine::AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler)
395 mPlugin->AddJavaScriptMessageHandler(exposedObjectName, handler);
398 void WebEngine::ClearAllTilesResources()
400 mPlugin->ClearAllTilesResources();
403 void WebEngine::ClearHistory()
405 mPlugin->ClearHistory();
408 void WebEngine::SetSize(int width, int height)
410 mPlugin->SetSize(width, height);
413 void WebEngine::EnableMouseEvents(bool enabled)
415 mPlugin->EnableMouseEvents(enabled);
418 void WebEngine::EnableKeyEvents(bool enabled)
420 mPlugin->EnableKeyEvents(enabled);
423 bool WebEngine::SendTouchEvent(const Dali::TouchEvent& touch)
425 return mPlugin->SendTouchEvent(touch);
428 bool WebEngine::SendKeyEvent(const Dali::KeyEvent& event)
430 return mPlugin->SendKeyEvent(event);
433 void WebEngine::SetFocus(bool focused)
435 mPlugin->SetFocus(focused);
438 void WebEngine::SetDocumentBackgroundColor(Dali::Vector4 color)
440 mPlugin->SetDocumentBackgroundColor(color);
443 void WebEngine::ClearTilesWhenHidden(bool cleared)
445 mPlugin->ClearTilesWhenHidden(cleared);
448 void WebEngine::SetTileCoverAreaMultiplier(float multiplier)
450 mPlugin->SetTileCoverAreaMultiplier(multiplier);
453 void WebEngine::EnableCursorByClient(bool enabled)
455 mPlugin->EnableCursorByClient(enabled);
458 std::string WebEngine::GetSelectedText() const
460 return mPlugin->GetSelectedText();
463 void WebEngine::SetPageZoomFactor(float zoomFactor)
465 mPlugin->SetPageZoomFactor(zoomFactor);
468 float WebEngine::GetPageZoomFactor() const
470 return mPlugin->GetPageZoomFactor();
473 void WebEngine::SetTextZoomFactor(float zoomFactor)
475 mPlugin->SetTextZoomFactor(zoomFactor);
478 float WebEngine::GetTextZoomFactor() const
480 return mPlugin->GetTextZoomFactor();
483 float WebEngine::GetLoadProgressPercentage() const
485 return mPlugin->GetLoadProgressPercentage();
488 void WebEngine::SetScaleFactor(float scaleFactor, Dali::Vector2 point)
490 mPlugin->SetScaleFactor(scaleFactor, point);
493 float WebEngine::GetScaleFactor() const
495 return mPlugin->GetScaleFactor();
498 void WebEngine::ActivateAccessibility(bool activated)
500 mPlugin->ActivateAccessibility(activated);
503 bool WebEngine::SetVisibility(bool visible)
505 return mPlugin->SetVisibility(visible);
508 bool WebEngine::HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount)
510 return mPlugin->HighlightText(text, options, maxMatchCount);
513 void WebEngine::AddDynamicCertificatePath(const std::string& host, const std::string& certPath)
515 mPlugin->AddDynamicCertificatePath(host, certPath);
518 Dali::PixelData WebEngine::GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor)
520 return mPlugin->GetScreenshot(viewArea, scaleFactor);
523 bool WebEngine::GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback)
525 return mPlugin->GetScreenshotAsynchronously(viewArea, scaleFactor, callback);
528 bool WebEngine::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
530 return mPlugin->CheckVideoPlayingAsynchronously(callback);
533 void WebEngine::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
535 mPlugin->RegisterGeolocationPermissionCallback(callback);
538 void WebEngine::UpdateDisplayArea(Dali::Rect<int> displayArea)
540 mPlugin->UpdateDisplayArea(displayArea);
543 void WebEngine::EnableVideoHole(bool enabled)
545 mPlugin->EnableVideoHole(enabled);
548 bool WebEngine::SendHoverEvent( const Dali::HoverEvent& event )
550 return mPlugin->SendHoverEvent( event );
553 bool WebEngine::SendWheelEvent( const Dali::WheelEvent& event )
555 return mPlugin->SendWheelEvent( event );
558 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& WebEngine::PageLoadStartedSignal()
560 return mPlugin->PageLoadStartedSignal();
563 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& WebEngine::PageLoadInProgressSignal()
565 return mPlugin->PageLoadInProgressSignal();
568 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& WebEngine::PageLoadFinishedSignal()
570 return mPlugin->PageLoadFinishedSignal();
573 Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& WebEngine::PageLoadErrorSignal()
575 return mPlugin->PageLoadErrorSignal();
578 Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& WebEngine::ScrollEdgeReachedSignal()
580 return mPlugin->ScrollEdgeReachedSignal();
583 Dali::WebEnginePlugin::WebEngineUrlChangedSignalType& WebEngine::UrlChangedSignal()
585 return mPlugin->UrlChangedSignal();
588 Dali::WebEnginePlugin::WebEngineFormRepostDecisionSignalType& WebEngine::FormRepostDecisionSignal()
590 return mPlugin->FormRepostDecisionSignal();
593 Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& WebEngine::FrameRenderedSignal()
595 return mPlugin->FrameRenderedSignal();
598 Dali::WebEnginePlugin::WebEngineRequestInterceptorSignalType& WebEngine::RequestInterceptorSignal()
600 return mPlugin->RequestInterceptorSignal();
603 } // namespace Adaptor
604 } // namespace Internal