Make web engine context be a singleton.
[platform/core/uifw/dali-adaptor.git] / dali / internal / web-engine / common / web-engine-impl.cpp
1 /*
2  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
3  *
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  *
16  */
17
18 // CLASS HEADER
19 #include <dali/internal/web-engine/common/web-engine-impl.h>
20
21 // EXTERNAL INCLUDES
22 #include <dali/integration-api/debug.h>
23 #include <dali/public-api/object/type-registry.h>
24 #include <dlfcn.h>
25 #include <sstream>
26
27 // INTERNAL INCLUDES
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>
43
44 namespace Dali
45 {
46 namespace Internal
47 {
48 namespace Adaptor
49 {
50 namespace // unnamed namespace
51 {
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";
55
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;
59
60 std::string MakePluginName(const char* environmentName)
61 {
62   std::stringstream fullName;
63   fullName << kPluginFullNamePrefix << environmentName << kPluginFullNamePostfix;
64   return std::move(fullName.str());
65 }
66
67 Dali::BaseHandle Create()
68 {
69   return Dali::WebEngine::New();
70 }
71
72 Dali::TypeRegistration type(typeid(Dali::WebEngine), typeid(Dali::BaseHandle), Create);
73
74 } // unnamed namespace
75
76 void*                               WebEngine::mHandle              = nullptr;
77 WebEngine::CreateWebEngineFunction  WebEngine::mCreateWebEnginePtr  = nullptr;
78 WebEngine::DestroyWebEngineFunction WebEngine::mDestroyWebEnginePtr = nullptr;
79
80 WebEnginePtr WebEngine::New()
81 {
82   WebEngine* instance = new WebEngine();
83   if(!instance->Initialize())
84   {
85     delete instance;
86     return nullptr;
87   }
88
89   return instance;
90 }
91
92 Dali::WebEngineContext* WebEngine::GetContext()
93 {
94   if(!InitializePluginHandle())
95   {
96     return nullptr;
97   }
98
99   using GetWebEngineContext                  = Dali::WebEngineContext* (*)();
100   GetWebEngineContext getWebEngineContextPtr = reinterpret_cast<GetWebEngineContext>(dlsym(mHandle, "GetWebEngineContext"));
101   if(getWebEngineContextPtr)
102   {
103     return getWebEngineContextPtr();
104   }
105
106   return nullptr;
107 }
108
109 Dali::WebEngineCookieManager* WebEngine::GetCookieManager()
110 {
111   if(!InitializePluginHandle())
112   {
113     return nullptr;
114   }
115
116   using GetWebEngineCookieManager                        = Dali::WebEngineCookieManager* (*)();
117   GetWebEngineCookieManager getWebEngineCookieManagerPtr = reinterpret_cast<GetWebEngineCookieManager>(dlsym(mHandle, "GetWebEngineCookieManager"));
118   if(getWebEngineCookieManagerPtr)
119   {
120     return getWebEngineCookieManagerPtr();
121   }
122
123   return nullptr;
124 }
125
126 bool WebEngine::InitializePluginHandle()
127 {
128   if(mHandle)
129   {
130     DALI_LOG_ERROR("Plugin.so has been opened already.\n");
131     return true;
132   }
133
134   if(pluginName.length() == 0)
135   {
136     // pluginName is not initialized yet.
137     const char* name = EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_WEB_ENGINE_NAME);
138     if(name)
139     {
140       pluginName = MakePluginName(name);
141     }
142     else
143     {
144       pluginName = std::string(kPluginFullNameDefault);
145     }
146   }
147
148   mHandle = dlopen(pluginName.c_str(), RTLD_LAZY);
149   if(!mHandle)
150   {
151     DALI_LOG_ERROR("Can't load %s : %s\n", pluginName.c_str(), dlerror());
152     return false;
153   }
154
155   // Make sure that mHandle would be closed.
156   Dali::LifecycleController::Get().TerminateSignal().Connect(&WebEngine::ClosePluginHandle);
157
158   mCreateWebEnginePtr = reinterpret_cast<CreateWebEngineFunction>(dlsym(mHandle, "CreateWebEnginePlugin"));
159   if(mCreateWebEnginePtr == nullptr)
160   {
161     DALI_LOG_ERROR("Can't load symbol CreateWebEnginePlugin(), error: %s\n", dlerror());
162     return false;
163   }
164
165   mDestroyWebEnginePtr = reinterpret_cast<DestroyWebEngineFunction>(dlsym(mHandle, "DestroyWebEnginePlugin"));
166   if(mDestroyWebEnginePtr == nullptr)
167   {
168     DALI_LOG_ERROR("Can't load symbol DestroyWebEnginePlugin(), error: %s\n", dlerror());
169     return false;
170   }
171
172   return true;
173 }
174
175 void WebEngine::ClosePluginHandle()
176 {
177   if(mHandle)
178   {
179     dlclose(mHandle);
180     mHandle = nullptr;
181   }
182 }
183
184 WebEngine::WebEngine()
185 : mPlugin(nullptr)
186 {
187 }
188
189 WebEngine::~WebEngine()
190 {
191   if(mPlugin != nullptr && mDestroyWebEnginePtr != nullptr)
192   {
193     mPlugin->Destroy();
194     mDestroyWebEnginePtr(mPlugin);
195   }
196 }
197
198 bool WebEngine::Initialize()
199 {
200   if(!InitializePluginHandle())
201   {
202     return false;
203   }
204
205   mPlugin = mCreateWebEnginePtr();
206   if(mPlugin == nullptr)
207   {
208     DALI_LOG_ERROR("Can't create the WebEnginePlugin object\n");
209     return false;
210   }
211
212   return true;
213 }
214
215 void WebEngine::Create(uint32_t width, uint32_t height, const std::string& locale, const std::string& timezoneId)
216 {
217   mPlugin->Create(width, height, locale, timezoneId);
218 }
219
220 void WebEngine::Create(uint32_t width, uint32_t height, uint32_t argc, char** argv)
221 {
222   mPlugin->Create(width, height, argc, argv);
223 }
224
225 void WebEngine::Destroy()
226 {
227   mPlugin->Destroy();
228 }
229
230 Dali::NativeImageSourcePtr WebEngine::GetNativeImageSource()
231 {
232   return mPlugin->GetNativeImageSource();
233 }
234
235 Dali::WebEngineSettings& WebEngine::GetSettings() const
236 {
237   return mPlugin->GetSettings();
238 }
239
240 Dali::WebEngineBackForwardList& WebEngine::GetBackForwardList() const
241 {
242   return mPlugin->GetBackForwardList();
243 }
244
245 void WebEngine::LoadUrl(const std::string& url)
246 {
247   mPlugin->LoadUrl(url);
248 }
249
250 std::string WebEngine::GetTitle() const
251 {
252   return mPlugin->GetTitle();
253 }
254
255 Dali::PixelData WebEngine::GetFavicon() const
256 {
257   return mPlugin->GetFavicon();
258 }
259
260 std::string WebEngine::GetUrl() const
261 {
262   return mPlugin->GetUrl();
263 }
264
265 std::string WebEngine::GetUserAgent() const
266 {
267   return mPlugin->GetUserAgent();
268 }
269
270 void WebEngine::SetUserAgent(const std::string& userAgent)
271 {
272   mPlugin->SetUserAgent(userAgent);
273 }
274
275 void WebEngine::LoadHtmlString(const std::string& htmlString)
276 {
277   mPlugin->LoadHtmlString(htmlString);
278 }
279
280 bool WebEngine::LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl)
281 {
282   return mPlugin->LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
283 }
284
285 bool WebEngine::LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
286 {
287   return mPlugin->LoadContents(contents, contentSize, mimeType, encoding, baseUri);
288 }
289
290 void WebEngine::Reload()
291 {
292   mPlugin->Reload();
293 }
294
295 bool WebEngine::ReloadWithoutCache()
296 {
297   return mPlugin->ReloadWithoutCache();
298 }
299
300 void WebEngine::StopLoading()
301 {
302   mPlugin->StopLoading();
303 }
304
305 void WebEngine::Suspend()
306 {
307   mPlugin->Suspend();
308 }
309
310 void WebEngine::Resume()
311 {
312   mPlugin->Resume();
313 }
314
315 void WebEngine::SuspendNetworkLoading()
316 {
317   mPlugin->SuspendNetworkLoading();
318 }
319
320 void WebEngine::ResumeNetworkLoading()
321 {
322   mPlugin->ResumeNetworkLoading();
323 }
324
325 bool WebEngine::AddCustomHeader(const std::string& name, const std::string& value)
326 {
327   return mPlugin->AddCustomHeader(name, value);
328 }
329
330 bool WebEngine::RemoveCustomHeader(const std::string& name)
331 {
332   return mPlugin->RemoveCustomHeader(name);
333 }
334
335 uint32_t WebEngine::StartInspectorServer(uint32_t port)
336 {
337   return mPlugin->StartInspectorServer(port);
338 }
339
340 bool WebEngine::StopInspectorServer()
341 {
342   return mPlugin->StopInspectorServer();
343 }
344
345 void WebEngine::ScrollBy(int32_t deltaX, int32_t deltaY)
346 {
347   mPlugin->ScrollBy(deltaX, deltaY);
348 }
349
350 bool WebEngine::ScrollEdgeBy(int32_t deltaX, int32_t deltaY)
351 {
352   return mPlugin->ScrollEdgeBy(deltaX, deltaY);
353 }
354
355 void WebEngine::SetScrollPosition(int32_t x, int32_t y)
356 {
357   mPlugin->SetScrollPosition(x, y);
358 }
359
360 Dali::Vector2 WebEngine::GetScrollPosition() const
361 {
362   return mPlugin->GetScrollPosition();
363 }
364
365 Dali::Vector2 WebEngine::GetScrollSize() const
366 {
367   return mPlugin->GetScrollSize();
368 }
369
370 Dali::Vector2 WebEngine::GetContentSize() const
371 {
372   return mPlugin->GetContentSize();
373 }
374
375 void WebEngine::RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback)
376 {
377   mPlugin->RegisterJavaScriptAlertCallback(callback);
378 }
379
380 void WebEngine::JavaScriptAlertReply()
381 {
382   mPlugin->JavaScriptAlertReply();
383 }
384
385 void WebEngine::RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback)
386 {
387   mPlugin->RegisterJavaScriptConfirmCallback(callback);
388 }
389
390 void WebEngine::JavaScriptConfirmReply(bool confirmed)
391 {
392   mPlugin->JavaScriptConfirmReply(confirmed);
393 }
394
395 void WebEngine::RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback)
396 {
397   mPlugin->RegisterJavaScriptPromptCallback(callback);
398 }
399
400 void WebEngine::JavaScriptPromptReply(const std::string& result)
401 {
402   mPlugin->JavaScriptPromptReply(result);
403 }
404
405 std::unique_ptr<Dali::WebEngineHitTest> WebEngine::CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode)
406 {
407   return mPlugin->CreateHitTest(x, y, mode);
408 }
409
410 bool WebEngine::CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback)
411 {
412   return mPlugin->CreateHitTestAsynchronously(x, y, mode, callback);
413 }
414
415 bool WebEngine::CanGoForward()
416 {
417   return mPlugin->CanGoForward();
418 }
419
420 void WebEngine::GoForward()
421 {
422   mPlugin->GoForward();
423 }
424
425 bool WebEngine::CanGoBack()
426 {
427   return mPlugin->CanGoBack();
428 }
429
430 void WebEngine::GoBack()
431 {
432   mPlugin->GoBack();
433 }
434
435 void WebEngine::EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler)
436 {
437   mPlugin->EvaluateJavaScript(script, resultHandler);
438 }
439
440 void WebEngine::AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler)
441 {
442   mPlugin->AddJavaScriptMessageHandler(exposedObjectName, handler);
443 }
444
445 void WebEngine::ClearAllTilesResources()
446 {
447   mPlugin->ClearAllTilesResources();
448 }
449
450 void WebEngine::ClearHistory()
451 {
452   mPlugin->ClearHistory();
453 }
454
455 void WebEngine::SetSize(uint32_t width, uint32_t height)
456 {
457   mPlugin->SetSize(width, height);
458 }
459
460 void WebEngine::EnableMouseEvents(bool enabled)
461 {
462   mPlugin->EnableMouseEvents(enabled);
463 }
464
465 void WebEngine::EnableKeyEvents(bool enabled)
466 {
467   mPlugin->EnableKeyEvents(enabled);
468 }
469
470 bool WebEngine::SendTouchEvent(const Dali::TouchEvent& touch)
471 {
472   return mPlugin->SendTouchEvent(touch);
473 }
474
475 bool WebEngine::SendKeyEvent(const Dali::KeyEvent& event)
476 {
477   return mPlugin->SendKeyEvent(event);
478 }
479
480 void WebEngine::SetFocus(bool focused)
481 {
482   mPlugin->SetFocus(focused);
483 }
484
485 void WebEngine::SetDocumentBackgroundColor(Dali::Vector4 color)
486 {
487   mPlugin->SetDocumentBackgroundColor(color);
488 }
489
490 void WebEngine::ClearTilesWhenHidden(bool cleared)
491 {
492   mPlugin->ClearTilesWhenHidden(cleared);
493 }
494
495 void WebEngine::SetTileCoverAreaMultiplier(float multiplier)
496 {
497   mPlugin->SetTileCoverAreaMultiplier(multiplier);
498 }
499
500 void WebEngine::EnableCursorByClient(bool enabled)
501 {
502   mPlugin->EnableCursorByClient(enabled);
503 }
504
505 std::string WebEngine::GetSelectedText() const
506 {
507   return mPlugin->GetSelectedText();
508 }
509
510 void WebEngine::SetPageZoomFactor(float zoomFactor)
511 {
512   mPlugin->SetPageZoomFactor(zoomFactor);
513 }
514
515 float WebEngine::GetPageZoomFactor() const
516 {
517   return mPlugin->GetPageZoomFactor();
518 }
519
520 void WebEngine::SetTextZoomFactor(float zoomFactor)
521 {
522   mPlugin->SetTextZoomFactor(zoomFactor);
523 }
524
525 float WebEngine::GetTextZoomFactor() const
526 {
527   return mPlugin->GetTextZoomFactor();
528 }
529
530 float WebEngine::GetLoadProgressPercentage() const
531 {
532   return mPlugin->GetLoadProgressPercentage();
533 }
534
535 void WebEngine::SetScaleFactor(float scaleFactor, Dali::Vector2 point)
536 {
537   mPlugin->SetScaleFactor(scaleFactor, point);
538 }
539
540 float WebEngine::GetScaleFactor() const
541 {
542   return mPlugin->GetScaleFactor();
543 }
544
545 void WebEngine::ActivateAccessibility(bool activated)
546 {
547   mPlugin->ActivateAccessibility(activated);
548 }
549
550 Accessibility::Address WebEngine::GetAccessibilityAddress()
551 {
552   return mPlugin->GetAccessibilityAddress();
553 }
554
555 bool WebEngine::SetVisibility(bool visible)
556 {
557   return mPlugin->SetVisibility(visible);
558 }
559
560 bool WebEngine::HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount)
561 {
562   return mPlugin->HighlightText(text, options, maxMatchCount);
563 }
564
565 void WebEngine::AddDynamicCertificatePath(const std::string& host, const std::string& certPath)
566 {
567   mPlugin->AddDynamicCertificatePath(host, certPath);
568 }
569
570 Dali::PixelData WebEngine::GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor)
571 {
572   return mPlugin->GetScreenshot(viewArea, scaleFactor);
573 }
574
575 bool WebEngine::GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback)
576 {
577   return mPlugin->GetScreenshotAsynchronously(viewArea, scaleFactor, callback);
578 }
579
580 bool WebEngine::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
581 {
582   return mPlugin->CheckVideoPlayingAsynchronously(callback);
583 }
584
585 void WebEngine::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
586 {
587   mPlugin->RegisterGeolocationPermissionCallback(callback);
588 }
589
590 void WebEngine::UpdateDisplayArea(Dali::Rect<int32_t> displayArea)
591 {
592   mPlugin->UpdateDisplayArea(displayArea);
593 }
594
595 void WebEngine::EnableVideoHole(bool enabled)
596 {
597   mPlugin->EnableVideoHole(enabled);
598 }
599
600 bool WebEngine::SendHoverEvent(const Dali::HoverEvent& event)
601 {
602   return mPlugin->SendHoverEvent(event);
603 }
604
605 bool WebEngine::SendWheelEvent(const Dali::WheelEvent& event)
606 {
607   return mPlugin->SendWheelEvent(event);
608 }
609
610 Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& WebEngine::FrameRenderedSignal()
611 {
612   return mPlugin->FrameRenderedSignal();
613 }
614
615 void WebEngine::RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
616 {
617   mPlugin->RegisterPageLoadStartedCallback(callback);
618 }
619
620 void WebEngine::RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
621 {
622   mPlugin->RegisterPageLoadInProgressCallback(callback);
623 }
624
625 void WebEngine::RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
626 {
627   mPlugin->RegisterPageLoadFinishedCallback(callback);
628 }
629
630 void WebEngine::RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback)
631 {
632   mPlugin->RegisterPageLoadErrorCallback(callback);
633 }
634
635 void WebEngine::RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback)
636 {
637   mPlugin->RegisterScrollEdgeReachedCallback(callback);
638 }
639
640 void WebEngine::RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback)
641 {
642   mPlugin->RegisterUrlChangedCallback(callback);
643 }
644
645 void WebEngine::RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback)
646 {
647   mPlugin->RegisterFormRepostDecidedCallback(callback);
648 }
649
650 void WebEngine::RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback)
651 {
652   mPlugin->RegisterConsoleMessageReceivedCallback(callback);
653 }
654
655 void WebEngine::RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback)
656 {
657   mPlugin->RegisterResponsePolicyDecidedCallback(callback);
658 }
659
660 void WebEngine::RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback)
661 {
662   mPlugin->RegisterNavigationPolicyDecidedCallback(callback);
663 }
664
665 void WebEngine::RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
666 {
667   mPlugin->RegisterCertificateConfirmedCallback(callback);
668 }
669
670 void WebEngine::RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
671 {
672   mPlugin->RegisterSslCertificateChangedCallback(callback);
673 }
674
675 void WebEngine::RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback)
676 {
677   mPlugin->RegisterHttpAuthHandlerCallback(callback);
678 }
679
680 void WebEngine::RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback)
681 {
682   mPlugin->RegisterContextMenuShownCallback(callback);
683 }
684
685 void WebEngine::RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback)
686 {
687   mPlugin->RegisterContextMenuHiddenCallback(callback);
688 }
689
690 void WebEngine::GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback)
691 {
692   mPlugin->GetPlainTextAsynchronously(callback);
693 }
694
695 } // namespace Adaptor
696 } // namespace Internal
697 } // namespace Dali