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-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>
43 namespace // unnamed namespace
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";
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;
53 std::string MakePluginName(const char* environmentName)
55 std::stringstream fullName;
56 fullName << kPluginFullNamePrefix << environmentName << kPluginFullNamePostfix;
57 return std::move(fullName.str());
60 Dali::BaseHandle Create()
62 return Dali::WebEngine::New();
65 Dali::TypeRegistration type(typeid(Dali::WebEngine), typeid(Dali::BaseHandle), Create);
67 } // unnamed namespace
69 WebEnginePtr WebEngine::New()
71 WebEngine* instance = new WebEngine();
73 if(!instance->Initialize())
82 WebEngine::WebEngine()
85 mCreateWebEnginePtr(NULL),
86 mDestroyWebEnginePtr(NULL)
90 WebEngine::~WebEngine()
94 if(mDestroyWebEnginePtr != NULL)
97 mDestroyWebEnginePtr(mPlugin);
104 bool WebEngine::InitializePluginHandle()
106 if(pluginName.length() == 0)
108 // pluginName is not initialized yet.
109 const char* name = EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_WEB_ENGINE_NAME);
112 pluginName = MakePluginName(name);
113 mHandle = dlopen(pluginName.c_str(), RTLD_LAZY);
119 pluginName = std::string(kPluginFullNameDefault);
122 mHandle = dlopen(pluginName.c_str(), RTLD_LAZY);
125 DALI_LOG_ERROR("Can't load %s : %s\n", pluginName.c_str(), dlerror());
132 bool WebEngine::Initialize()
136 if(!InitializePluginHandle())
141 mCreateWebEnginePtr = reinterpret_cast<CreateWebEngineFunction>(dlsym(mHandle, "CreateWebEnginePlugin"));
142 if(mCreateWebEnginePtr == NULL)
144 DALI_LOG_ERROR("Can't load symbol CreateWebEnginePlugin(), error: %s\n", error);
148 mDestroyWebEnginePtr = reinterpret_cast<DestroyWebEngineFunction>(dlsym(mHandle, "DestroyWebEnginePlugin"));
150 if(mDestroyWebEnginePtr == NULL)
152 DALI_LOG_ERROR("Can't load symbol DestroyWebEnginePlugin(), error: %s\n", error);
156 mPlugin = mCreateWebEnginePtr();
160 DALI_LOG_ERROR("Can't create the WebEnginePlugin object\n");
167 void WebEngine::Create(int width, int height, const std::string& locale, const std::string& timezoneId)
169 mPlugin->Create(width, height, locale, timezoneId);
172 void WebEngine::Create(int width, int height, int argc, char** argv)
174 mPlugin->Create(width, height, argc, argv);
177 void WebEngine::Destroy()
182 Dali::NativeImageInterfacePtr WebEngine::GetNativeImageSource()
184 return mPlugin->GetNativeImageSource();
187 Dali::WebEngineSettings& WebEngine::GetSettings() const
189 return mPlugin->GetSettings();
192 Dali::WebEngineContext& WebEngine::GetContext() const
194 return mPlugin->GetContext();
197 Dali::WebEngineCookieManager& WebEngine::GetCookieManager() const
199 return mPlugin->GetCookieManager();
202 Dali::WebEngineBackForwardList& WebEngine::GetBackForwardList() const
204 return mPlugin->GetBackForwardList();
207 void WebEngine::LoadUrl(const std::string& url)
209 mPlugin->LoadUrl(url);
212 std::string WebEngine::GetTitle() const
214 return mPlugin->GetTitle();
217 Dali::PixelData WebEngine::GetFavicon() const
219 return mPlugin->GetFavicon();
222 const std::string& WebEngine::GetUrl()
224 return mPlugin->GetUrl();
227 const std::string& WebEngine::GetUserAgent() const
229 return mPlugin->GetUserAgent();
232 void WebEngine::SetUserAgent(const std::string& userAgent)
234 mPlugin->SetUserAgent(userAgent);
237 void WebEngine::LoadHtmlString(const std::string& htmlString)
239 mPlugin->LoadHtmlString(htmlString);
242 bool WebEngine::LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl)
244 return mPlugin->LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
247 bool WebEngine::LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
249 return mPlugin->LoadContents(contents, contentSize, mimeType, encoding, baseUri);
252 void WebEngine::Reload()
257 bool WebEngine::ReloadWithoutCache()
259 return mPlugin->ReloadWithoutCache();
262 void WebEngine::StopLoading()
264 mPlugin->StopLoading();
267 void WebEngine::Suspend()
272 void WebEngine::Resume()
277 void WebEngine::SuspendNetworkLoading()
279 mPlugin->SuspendNetworkLoading();
282 void WebEngine::ResumeNetworkLoading()
284 mPlugin->ResumeNetworkLoading();
287 bool WebEngine::AddCustomHeader(const std::string& name, const std::string& value)
289 return mPlugin->AddCustomHeader(name, value);
292 bool WebEngine::RemoveCustomHeader(const std::string& name)
294 return mPlugin->RemoveCustomHeader(name);
297 uint32_t WebEngine::StartInspectorServer(uint32_t port)
299 return mPlugin->StartInspectorServer(port);
302 bool WebEngine::StopInspectorServer()
304 return mPlugin->StopInspectorServer();
307 void WebEngine::ScrollBy(int deltaX, int deltaY)
309 mPlugin->ScrollBy(deltaX, deltaY);
312 bool WebEngine::ScrollEdgeBy(int deltaX, int deltaY)
314 return mPlugin->ScrollEdgeBy(deltaX, deltaY);
317 void WebEngine::SetScrollPosition(int x, int y)
319 mPlugin->SetScrollPosition(x, y);
322 Dali::Vector2 WebEngine::GetScrollPosition() const
324 return mPlugin->GetScrollPosition();
327 Dali::Vector2 WebEngine::GetScrollSize() const
329 return mPlugin->GetScrollSize();
332 Dali::Vector2 WebEngine::GetContentSize() const
334 return mPlugin->GetContentSize();
337 void WebEngine::RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback)
339 mPlugin->RegisterJavaScriptAlertCallback(callback);
342 void WebEngine::JavaScriptAlertReply()
344 mPlugin->JavaScriptAlertReply();
347 void WebEngine::RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback)
349 mPlugin->RegisterJavaScriptAlertCallback(callback);
352 void WebEngine::JavaScriptConfirmReply(bool confirmed)
354 mPlugin->JavaScriptConfirmReply(confirmed);
357 void WebEngine::RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback)
359 mPlugin->RegisterJavaScriptPromptCallback(callback);
362 void WebEngine::JavaScriptPromptReply(const std::string& result)
364 mPlugin->JavaScriptPromptReply(result);
367 bool WebEngine::CanGoForward()
369 return mPlugin->CanGoForward();
372 void WebEngine::GoForward()
374 mPlugin->GoForward();
377 bool WebEngine::CanGoBack()
379 return mPlugin->CanGoBack();
382 void WebEngine::GoBack()
387 void WebEngine::EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler)
389 mPlugin->EvaluateJavaScript(script, resultHandler);
392 void WebEngine::AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler)
394 mPlugin->AddJavaScriptMessageHandler(exposedObjectName, handler);
397 void WebEngine::ClearAllTilesResources()
399 mPlugin->ClearAllTilesResources();
402 void WebEngine::ClearHistory()
404 mPlugin->ClearHistory();
407 void WebEngine::SetSize(int width, int height)
409 mPlugin->SetSize(width, height);
412 void WebEngine::EnableMouseEvents(bool enabled)
414 mPlugin->EnableMouseEvents(enabled);
417 void WebEngine::EnableKeyEvents(bool enabled)
419 mPlugin->EnableKeyEvents(enabled);
422 bool WebEngine::SendTouchEvent(const Dali::TouchEvent& touch)
424 return mPlugin->SendTouchEvent(touch);
427 bool WebEngine::SendKeyEvent(const Dali::KeyEvent& event)
429 return mPlugin->SendKeyEvent(event);
432 void WebEngine::SetFocus(bool focused)
434 mPlugin->SetFocus(focused);
437 void WebEngine::SetDocumentBackgroundColor(Dali::Vector4 color)
439 mPlugin->SetDocumentBackgroundColor(color);
442 void WebEngine::ClearTilesWhenHidden(bool cleared)
444 mPlugin->ClearTilesWhenHidden(cleared);
447 void WebEngine::SetTileCoverAreaMultiplier(float multiplier)
449 mPlugin->SetTileCoverAreaMultiplier(multiplier);
452 void WebEngine::EnableCursorByClient(bool enabled)
454 mPlugin->EnableCursorByClient(enabled);
457 std::string WebEngine::GetSelectedText() const
459 return mPlugin->GetSelectedText();
462 void WebEngine::SetPageZoomFactor(float zoomFactor)
464 mPlugin->SetPageZoomFactor(zoomFactor);
467 float WebEngine::GetPageZoomFactor() const
469 return mPlugin->GetPageZoomFactor();
472 void WebEngine::SetTextZoomFactor(float zoomFactor)
474 mPlugin->SetTextZoomFactor(zoomFactor);
477 float WebEngine::GetTextZoomFactor() const
479 return mPlugin->GetTextZoomFactor();
482 float WebEngine::GetLoadProgressPercentage() const
484 return mPlugin->GetLoadProgressPercentage();
487 void WebEngine::SetScaleFactor(float scaleFactor, Dali::Vector2 point)
489 mPlugin->SetScaleFactor(scaleFactor, point);
492 float WebEngine::GetScaleFactor() const
494 return mPlugin->GetScaleFactor();
497 void WebEngine::ActivateAccessibility(bool activated)
499 mPlugin->ActivateAccessibility(activated);
502 bool WebEngine::SetVisibility(bool visible)
504 return mPlugin->SetVisibility(visible);
507 bool WebEngine::HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount)
509 return mPlugin->HighlightText(text, options, maxMatchCount);
512 void WebEngine::AddDynamicCertificatePath(const std::string& host, const std::string& certPath)
514 mPlugin->AddDynamicCertificatePath(host, certPath);
517 Dali::PixelData WebEngine::GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor)
519 return mPlugin->GetScreenshot(viewArea, scaleFactor);
522 bool WebEngine::GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback)
524 return mPlugin->GetScreenshotAsynchronously(viewArea, scaleFactor, callback);
527 bool WebEngine::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
529 return mPlugin->CheckVideoPlayingAsynchronously(callback);
532 void WebEngine::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
534 mPlugin->RegisterGeolocationPermissionCallback(callback);
537 void WebEngine::UpdateDisplayArea(Dali::Rect<int> displayArea)
539 mPlugin->UpdateDisplayArea(displayArea);
542 void WebEngine::EnableVideoHole(bool enabled)
544 mPlugin->EnableVideoHole(enabled);
547 bool WebEngine::SendHoverEvent( const Dali::HoverEvent& event )
549 return mPlugin->SendHoverEvent( event );
552 bool WebEngine::SendWheelEvent( const Dali::WheelEvent& event )
554 return mPlugin->SendWheelEvent( event );
557 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& WebEngine::PageLoadStartedSignal()
559 return mPlugin->PageLoadStartedSignal();
562 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& WebEngine::PageLoadInProgressSignal()
564 return mPlugin->PageLoadInProgressSignal();
567 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& WebEngine::PageLoadFinishedSignal()
569 return mPlugin->PageLoadFinishedSignal();
572 Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& WebEngine::PageLoadErrorSignal()
574 return mPlugin->PageLoadErrorSignal();
577 Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& WebEngine::ScrollEdgeReachedSignal()
579 return mPlugin->ScrollEdgeReachedSignal();
582 Dali::WebEnginePlugin::WebEngineUrlChangedSignalType& WebEngine::UrlChangedSignal()
584 return mPlugin->UrlChangedSignal();
587 Dali::WebEnginePlugin::WebEngineFormRepostDecisionSignalType& WebEngine::FormRepostDecisionSignal()
589 return mPlugin->FormRepostDecisionSignal();
592 Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& WebEngine::FrameRenderedSignal()
594 return mPlugin->FrameRenderedSignal();
597 } // namespace Adaptor
598 } // namespace Internal