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/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-policy-decision.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>
  37
  38 namespace Dali
  39 {
  40 namespace Internal
  41 {
  42 namespace Adaptor
  43 {
  44 namespace // unnamed namespace
  45 {
  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";
  49
  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;
  53
  54 std::string MakePluginName(const char* environmentName)
  55 {
  56   std::stringstream fullName;
  57   fullName << kPluginFullNamePrefix << environmentName << kPluginFullNamePostfix;
  58   return std::move(fullName.str());
  59 }
  60
  61 Dali::BaseHandle Create()
  62 {
  63   return Dali::WebEngine::New();
  64 }
  65
  66 Dali::TypeRegistration type(typeid(Dali::WebEngine), typeid(Dali::BaseHandle), Create);
  67
  68 } // unnamed namespace
  69
  70 WebEnginePtr WebEngine::New()
  71 {
  72   WebEngine* instance = new WebEngine();
  73
  74   if(!instance->Initialize())
  75   {
  76     delete instance;
  77     return nullptr;
  78   }
  79
  80   return instance;
  81 }
  82
  83 WebEngine::WebEngine()
  84 : mPlugin(NULL),
  85   mHandle(NULL),
  86   mCreateWebEnginePtr(NULL),
  87   mDestroyWebEnginePtr(NULL)
  88 {
  89 }
  90
  91 WebEngine::~WebEngine()
  92 {
  93   if(mHandle != NULL)
  94   {
  95     if(mDestroyWebEnginePtr != NULL)
  96     {
  97       mPlugin->Destroy();
  98       mDestroyWebEnginePtr(mPlugin);
  99     }
 100
 101     dlclose(mHandle);
 102   }
 103 }
 104
 105 bool WebEngine::InitializePluginHandle()
 106 {
 107   if(pluginName.length() == 0)
 108   {
 109     // pluginName is not initialized yet.
 110     const char* name = EnvironmentVariable::GetEnvironmentVariable(DALI_ENV_WEB_ENGINE_NAME);
 111     if(name)
 112     {
 113       pluginName = MakePluginName(name);
 114       mHandle    = dlopen(pluginName.c_str(), RTLD_LAZY);
 115       if(mHandle)
 116       {
 117         return true;
 118       }
 119     }
 120     pluginName = std::string(kPluginFullNameDefault);
 121   }
 122
 123   mHandle = dlopen(pluginName.c_str(), RTLD_LAZY);
 124   if(!mHandle)
 125   {
 126     DALI_LOG_ERROR("Can't load %s : %s\n", pluginName.c_str(), dlerror());
 127     return false;
 128   }
 129
 130   return true;
 131 }
 132
 133 bool WebEngine::Initialize()
 134 {
 135   char* error = NULL;
 136
 137   if(!InitializePluginHandle())
 138   {
 139     return false;
 140   }
 141
 142   mCreateWebEnginePtr = reinterpret_cast<CreateWebEngineFunction>(dlsym(mHandle, "CreateWebEnginePlugin"));
 143   if(mCreateWebEnginePtr == NULL)
 144   {
 145     DALI_LOG_ERROR("Can't load symbol CreateWebEnginePlugin(), error: %s\n", error);
 146     return false;
 147   }
 148
 149   mDestroyWebEnginePtr = reinterpret_cast<DestroyWebEngineFunction>(dlsym(mHandle, "DestroyWebEnginePlugin"));
 150
 151   if(mDestroyWebEnginePtr == NULL)
 152   {
 153     DALI_LOG_ERROR("Can't load symbol DestroyWebEnginePlugin(), error: %s\n", error);
 154     return false;
 155   }
 156
 157   mPlugin = mCreateWebEnginePtr();
 158
 159   if(mPlugin == NULL)
 160   {
 161     DALI_LOG_ERROR("Can't create the WebEnginePlugin object\n");
 162     return false;
 163   }
 164
 165   return true;
 166 }
 167
 168 void WebEngine::Create(int width, int height, const std::string& locale, const std::string& timezoneId)
 169 {
 170   mPlugin->Create(width, height, locale, timezoneId);
 171 }
 172
 173 void WebEngine::Create(int width, int height, int argc, char** argv)
 174 {
 175   mPlugin->Create(width, height, argc, argv);
 176 }
 177
 178 void WebEngine::Destroy()
 179 {
 180   mPlugin->Destroy();
 181 }
 182
 183 Dali::NativeImageInterfacePtr WebEngine::GetNativeImageSource()
 184 {
 185   return mPlugin->GetNativeImageSource();
 186 }
 187
 188 Dali::WebEngineSettings& WebEngine::GetSettings() const
 189 {
 190   return mPlugin->GetSettings();
 191 }
 192
 193 Dali::WebEngineContext& WebEngine::GetContext() const
 194 {
 195   return mPlugin->GetContext();
 196 }
 197
 198 Dali::WebEngineCookieManager& WebEngine::GetCookieManager() const
 199 {
 200   return mPlugin->GetCookieManager();
 201 }
 202
 203 Dali::WebEngineBackForwardList& WebEngine::GetBackForwardList() const
 204 {
 205   return mPlugin->GetBackForwardList();
 206 }
 207
 208 void WebEngine::LoadUrl(const std::string& url)
 209 {
 210   mPlugin->LoadUrl(url);
 211 }
 212
 213 std::string WebEngine::GetTitle() const
 214 {
 215   return mPlugin->GetTitle();
 216 }
 217
 218 Dali::PixelData WebEngine::GetFavicon() const
 219 {
 220   return mPlugin->GetFavicon();
 221 }
 222
 223 const std::string& WebEngine::GetUrl()
 224 {
 225   return mPlugin->GetUrl();
 226 }
 227
 228 const std::string& WebEngine::GetUserAgent() const
 229 {
 230   return mPlugin->GetUserAgent();
 231 }
 232
 233 void WebEngine::SetUserAgent(const std::string& userAgent)
 234 {
 235   mPlugin->SetUserAgent(userAgent);
 236 }
 237
 238 void WebEngine::LoadHtmlString(const std::string& htmlString)
 239 {
 240   mPlugin->LoadHtmlString(htmlString);
 241 }
 242
 243 void WebEngine::Reload()
 244 {
 245   mPlugin->Reload();
 246 }
 247
 248 void WebEngine::StopLoading()
 249 {
 250   mPlugin->StopLoading();
 251 }
 252
 253 void WebEngine::Suspend()
 254 {
 255   mPlugin->Suspend();
 256 }
 257
 258 void WebEngine::Resume()
 259 {
 260   mPlugin->Resume();
 261 }
 262
 263 void WebEngine::ScrollBy(int deltaX, int deltaY)
 264 {
 265   mPlugin->ScrollBy(deltaX, deltaY);
 266 }
 267
 268 void WebEngine::SetScrollPosition(int x, int y)
 269 {
 270   mPlugin->SetScrollPosition(x, y);
 271 }
 272
 273 void WebEngine::GetScrollPosition(int& x, int& y) const
 274 {
 275   mPlugin->GetScrollPosition(x, y);
 276 }
 277
 278 void WebEngine::GetScrollSize(int& width, int& height) const
 279 {
 280   mPlugin->GetScrollSize(width, height);
 281 }
 282
 283 void WebEngine::GetContentSize(int& width, int& height) const
 284 {
 285   mPlugin->GetContentSize(width, height);
 286 }
 287
 288 bool WebEngine::CanGoForward()
 289 {
 290   return mPlugin->CanGoForward();
 291 }
 292
 293 void WebEngine::GoForward()
 294 {
 295   mPlugin->GoForward();
 296 }
 297
 298 bool WebEngine::CanGoBack()
 299 {
 300   return mPlugin->CanGoBack();
 301 }
 302
 303 void WebEngine::GoBack()
 304 {
 305   mPlugin->GoBack();
 306 }
 307
 308 void WebEngine::EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler)
 309 {
 310   mPlugin->EvaluateJavaScript(script, resultHandler);
 311 }
 312
 313 void WebEngine::AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler)
 314 {
 315   mPlugin->AddJavaScriptMessageHandler(exposedObjectName, handler);
 316 }
 317
 318 void WebEngine::ClearAllTilesResources()
 319 {
 320   mPlugin->ClearAllTilesResources();
 321 }
 322
 323 void WebEngine::ClearHistory()
 324 {
 325   mPlugin->ClearHistory();
 326 }
 327
 328 void WebEngine::SetSize(int width, int height)
 329 {
 330   mPlugin->SetSize(width, height);
 331 }
 332
 333 bool WebEngine::SendTouchEvent(const Dali::TouchEvent& touch)
 334 {
 335   return mPlugin->SendTouchEvent(touch);
 336 }
 337
 338 bool WebEngine::SendKeyEvent(const Dali::KeyEvent& event)
 339 {
 340   return mPlugin->SendKeyEvent(event);
 341 }
 342
 343 void WebEngine::SetFocus(bool focused)
 344 {
 345   mPlugin->SetFocus(focused);
 346 }
 347
 348 void WebEngine::UpdateDisplayArea(Dali::Rect<int> displayArea)
 349 {
 350   mPlugin->UpdateDisplayArea(displayArea);
 351 }
 352
 353 void WebEngine::EnableVideoHole(bool enabled)
 354 {
 355   mPlugin->EnableVideoHole(enabled);
 356 }
 357
 358 void WebEngine::RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
 359 {
 360   mPlugin->RegisterPageLoadStartedCallback(callback);
 361 }
 362
 363 void WebEngine::RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
 364 {
 365   mPlugin->RegisterPageLoadFinishedCallback(callback);
 366 }
 367
 368 void WebEngine::RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback)
 369 {
 370   mPlugin->RegisterPageLoadErrorCallback(callback);
 371 }
 372
 373 void WebEngine::RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback)
 374 {
 375   mPlugin->RegisterScrollEdgeReachedCallback(callback);
 376 }
 377
 378 void WebEngine::RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback)
 379 {
 380   mPlugin->RegisterUrlChangedCallback(callback);
 381 }
 382
 383 void WebEngine::RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback)
 384 {
 385   mPlugin->RegisterNavigationPolicyDecidedCallback(callback);
 386 }
 387
 388 void WebEngine::GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback)
 389 {
 390   mPlugin->GetPlainTextAsynchronously(callback);
 391 }
 392
 393 } // namespace Adaptor
 394 } // namespace Internal
 395 } // namespace Dali