2 * Copyright (c) 2020 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 "web-view-impl.h"
23 #include <dali/devel-api/scripting/enum-helper.h>
24 #include <dali/devel-api/scripting/scripting.h>
25 #include <dali/public-api/common/stage.h>
26 #include <dali/public-api/adaptor-framework/native-image-source.h>
27 #include <dali/public-api/object/type-registry.h>
28 #include <dali/public-api/object/type-registry-helper.h>
31 #include <dali-toolkit/devel-api/controls/control-devel.h>
32 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
33 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
49 return Toolkit::WebView::New();
52 DALI_ENUM_TO_STRING_TABLE_BEGIN( CacheModel )
53 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, DOCUMENT_VIEWER )
54 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, DOCUMENT_BROWSER )
55 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, PRIMARY_WEB_BROWSER )
56 DALI_ENUM_TO_STRING_TABLE_END( CacheModel )
58 DALI_ENUM_TO_STRING_TABLE_BEGIN( CookieAcceptPolicy )
59 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, ALWAYS )
60 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, NEVER )
61 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, NO_THIRD_PARTY )
62 DALI_ENUM_TO_STRING_TABLE_END( CookieAcceptPolicy )
64 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::WebView, Toolkit::Control, Create )
66 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "url", STRING, URL )
67 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "cacheModel", STRING, CACHE_MODEL )
68 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "cookieAcceptPolicy", STRING, COOKIE_ACCEPT_POLICY )
69 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "userAgent", STRING, USER_AGENT )
70 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "enableJavaScript", BOOLEAN, ENABLE_JAVASCRIPT )
71 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "loadImagesAutomatically", BOOLEAN, LOAD_IMAGES_AUTOMATICALLY )
72 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "defaultTextEncodingName", STRING, DEFAULT_TEXT_ENCODING_NAME )
73 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "defaultFontSize", INTEGER, DEFAULT_FONT_SIZE )
75 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadStarted", PAGE_LOAD_STARTED_SIGNAL )
76 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadFinished", PAGE_LOAD_FINISHED_SIGNAL )
77 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadError", PAGE_LOAD_ERROR_SIGNAL )
79 DALI_TYPE_REGISTRATION_END()
81 const std::string kEmptyString;
83 } // anonymous namepsace
85 #define GET_ENUM_STRING( structName, inputExp ) \
86 Scripting::GetLinearEnumerationName< Toolkit::WebView::structName::Type >( static_cast< Toolkit::WebView::structName::Type >( inputExp ), structName##_TABLE, structName##_TABLE_COUNT )
88 #define GET_ENUM_VALUE( structName, inputExp, outputExp ) \
89 Scripting::GetEnumerationProperty< Toolkit::WebView::structName::Type >( inputExp, structName##_TABLE, structName##_TABLE_COUNT, outputExp )
91 WebView::WebView( const std::string& locale, const std::string& timezoneId )
92 : Control( ControlBehaviour( ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS ) ),
95 mWebViewSize( Stage::GetCurrent().GetSize() ),
97 mPageLoadStartedSignal(),
98 mPageLoadFinishedSignal(),
99 mPageLoadErrorSignal()
101 mWebEngine = Dali::WebEngine::New();
103 // WebEngine is empty when it is not properly initialized.
106 mWebEngine.Create( mWebViewSize.width, mWebViewSize.height, locale, timezoneId );
119 Toolkit::WebView WebView::New()
121 WebView* impl = new WebView();
122 Toolkit::WebView handle = Toolkit::WebView( *impl );
128 Toolkit::WebView WebView::New( const std::string& locale, const std::string& timezoneId )
130 WebView* impl = new WebView( locale, timezoneId );
131 Toolkit::WebView handle = Toolkit::WebView( *impl );
137 void WebView::OnInitialize()
139 Self().SetProperty( Actor::Property::KEYBOARD_FOCUSABLE, true );
140 Self().TouchSignal().Connect( this, &WebView::OnTouchEvent );
144 mWebEngine.PageLoadStartedSignal().Connect( this, &WebView::OnPageLoadStarted );
145 mWebEngine.PageLoadFinishedSignal().Connect( this, &WebView::OnPageLoadFinished );
146 mWebEngine.PageLoadErrorSignal().Connect( this, &WebView::OnPageLoadError );
150 void WebView::LoadUrl( const std::string& url )
155 Texture texture = Dali::Texture::New( *mWebEngine.GetNativeImageSource() );
156 const std::string nativeImageUrl = Dali::Toolkit::TextureManager::AddTexture( texture );
157 mVisual = Toolkit::VisualFactory::Get().CreateVisual(
158 { { Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE } ,
159 { Toolkit::ImageVisual::Property::URL, nativeImageUrl } } );
163 // Clean up previously registered visual and add new one.
164 DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
165 mWebEngine.LoadUrl( url );
170 void WebView::LoadHTMLString( const std::string& htmlString )
174 Texture texture = Dali::Texture::New( *mWebEngine.GetNativeImageSource() );
175 const std::string nativeImageUrl = Dali::Toolkit::TextureManager::AddTexture( texture );
176 mVisual = Toolkit::VisualFactory::Get().CreateVisual(
177 { { Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE } ,
178 { Toolkit::ImageVisual::Property::URL, nativeImageUrl } } );
182 DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
183 mWebEngine.LoadHTMLString( htmlString );
188 void WebView::Reload()
196 void WebView::StopLoading()
200 mWebEngine.StopLoading();
204 void WebView::Suspend()
208 mWebEngine.Suspend();
212 void WebView::Resume()
220 bool WebView::CanGoForward()
222 return mWebEngine ? mWebEngine.CanGoForward() : false;
225 void WebView::GoForward()
229 mWebEngine.GoForward();
233 bool WebView::CanGoBack()
235 return mWebEngine ? mWebEngine.CanGoBack() : false;
238 void WebView::GoBack()
246 void WebView::EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler )
250 mWebEngine.EvaluateJavaScript( script, resultHandler );
254 void WebView::AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler )
258 mWebEngine.AddJavaScriptMessageHandler( exposedObjectName, handler );
262 void WebView::ClearHistory()
266 mWebEngine.ClearHistory();
270 void WebView::ClearCache()
274 mWebEngine.ClearCache();
278 void WebView::ClearCookies()
282 mWebEngine.ClearCookies();
286 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadStartedSignal()
288 return mPageLoadStartedSignal;
291 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadFinishedSignal()
293 return mPageLoadFinishedSignal;
296 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& WebView::PageLoadErrorSignal()
298 return mPageLoadErrorSignal;
301 void WebView::OnPageLoadStarted( const std::string& url )
303 if( !mPageLoadStartedSignal.Empty() )
305 Dali::Toolkit::WebView handle( GetOwner() );
306 mPageLoadStartedSignal.Emit( handle, url );
310 void WebView::OnPageLoadFinished( const std::string& url )
312 if( !mPageLoadFinishedSignal.Empty() )
314 Dali::Toolkit::WebView handle( GetOwner() );
315 mPageLoadFinishedSignal.Emit( handle, url );
319 void WebView::OnPageLoadError( const std::string& url, int errorCode )
321 if( !mPageLoadErrorSignal.Empty() )
323 Dali::Toolkit::WebView handle( GetOwner() );
324 mPageLoadErrorSignal.Emit( handle, url, static_cast< Toolkit::WebView::LoadErrorCode >( errorCode ) );
328 bool WebView::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
330 Dali::BaseHandle handle( object );
332 bool connected = false;
333 Toolkit::WebView webView = Toolkit::WebView::DownCast( handle );
335 if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_STARTED_SIGNAL ) )
337 webView.PageLoadStartedSignal().Connect( tracker, functor );
340 else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_FINISHED_SIGNAL ) )
342 webView.PageLoadFinishedSignal().Connect( tracker, functor );
345 else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_ERROR_SIGNAL ) )
347 webView.PageLoadErrorSignal().Connect( tracker, functor );
354 Vector3 WebView::GetNaturalSize()
358 Vector2 rendererNaturalSize;
359 mVisual.GetNaturalSize( rendererNaturalSize );
360 return Vector3( rendererNaturalSize );
363 return Vector3( mWebViewSize );
366 void WebView::OnRelayout( const Vector2& size, RelayoutContainer& container )
368 Control::OnRelayout( size, container );
370 if( size.width > 0 && size.height > 0 && mWebViewSize != size )
376 mWebEngine.SetSize( size.width, size.height );
381 void WebView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
383 Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
387 WebView& impl = GetImpl( webView );
390 case Toolkit::WebView::Property::URL:
393 if( value.Get( url ) )
399 case Toolkit::WebView::Property::CACHE_MODEL:
401 Toolkit::WebView::CacheModel::Type output = impl.GetCacheModel();
402 GET_ENUM_VALUE( CacheModel, value, output );
403 impl.SetCacheModel( output );
406 case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
408 Toolkit::WebView::CookieAcceptPolicy::Type output = impl.GetCookieAcceptPolicy();
409 GET_ENUM_VALUE( CookieAcceptPolicy, value, output );
410 impl.SetCookieAcceptPolicy( output );
413 case Toolkit::WebView::Property::USER_AGENT:
416 if( value.Get( input ) )
418 impl.SetUserAgent( input );
422 case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
425 if( value.Get( input ) )
427 impl.EnableJavaScript( input );
431 case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
434 if( value.Get( input ) )
436 impl.LoadImagesAutomatically( input );
440 case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
443 if( value.Get( input ) )
445 impl.SetDefaultTextEncodingName( input );
449 case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
452 if( value.Get( input ) )
454 impl.SetDefaultFontSize( input );
462 Property::Value WebView::GetProperty( BaseObject* object, Property::Index propertyIndex )
464 Property::Value value;
466 Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
470 WebView& impl = GetImpl( webView );
471 switch( propertyIndex )
473 case Toolkit::WebView::Property::URL:
478 case Toolkit::WebView::Property::CACHE_MODEL:
480 value = GET_ENUM_STRING( CacheModel, impl.GetCacheModel() );
483 case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
485 value = GET_ENUM_STRING( CookieAcceptPolicy, impl.GetCookieAcceptPolicy() );
488 case Toolkit::WebView::Property::USER_AGENT:
490 value = impl.GetUserAgent();
493 case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
495 value = impl.IsJavaScriptEnabled();
498 case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
500 value = impl.AreImagesAutomaticallyLoaded();
503 case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
505 value = impl.GetDefaultTextEncodingName();
508 case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
510 value = impl.GetDefaultFontSize();
521 bool WebView::OnTouchEvent( Actor actor, const Dali::TouchData& touch )
527 result = mWebEngine.SendTouchEvent( touch );
532 bool WebView::OnKeyEvent( const Dali::KeyEvent& event )
538 result = mWebEngine.SendKeyEvent( event );
543 Toolkit::WebView::CacheModel::Type WebView::GetCacheModel() const
545 return mWebEngine ? static_cast< Toolkit::WebView::CacheModel::Type >( mWebEngine.GetCacheModel() ) : Toolkit::WebView::CacheModel::DOCUMENT_VIEWER;
548 void WebView::SetCacheModel( Toolkit::WebView::CacheModel::Type cacheModel )
552 mWebEngine.SetCacheModel( static_cast< WebEnginePlugin::CacheModel >( cacheModel ) );
556 Toolkit::WebView::CookieAcceptPolicy::Type WebView::GetCookieAcceptPolicy() const
558 return mWebEngine ? static_cast< Toolkit::WebView::CookieAcceptPolicy::Type >( mWebEngine.GetCookieAcceptPolicy() ) : Toolkit::WebView::CookieAcceptPolicy::NO_THIRD_PARTY;
561 void WebView::SetCookieAcceptPolicy( Toolkit::WebView::CookieAcceptPolicy::Type policy )
565 mWebEngine.SetCookieAcceptPolicy( static_cast< WebEnginePlugin::CookieAcceptPolicy >( policy ) );
569 const std::string& WebView::GetUserAgent() const
571 return mWebEngine ? mWebEngine.GetUserAgent() : kEmptyString;
574 void WebView::SetUserAgent( const std::string& userAgent )
578 mWebEngine.SetUserAgent( userAgent );
582 bool WebView::IsJavaScriptEnabled() const
584 return mWebEngine ? mWebEngine.IsJavaScriptEnabled() : true;
587 void WebView::EnableJavaScript( bool enabled )
591 mWebEngine.EnableJavaScript( enabled );
595 bool WebView::AreImagesAutomaticallyLoaded() const
597 return mWebEngine ? mWebEngine.AreImagesAutomaticallyLoaded() : true;
600 void WebView::LoadImagesAutomatically( bool automatic )
604 mWebEngine.LoadImagesAutomatically( automatic );
608 const std::string& WebView::GetDefaultTextEncodingName() const
610 return mWebEngine ? mWebEngine.GetDefaultTextEncodingName() : kEmptyString;
613 void WebView::SetDefaultTextEncodingName( const std::string& defaultTextEncodingName )
617 mWebEngine.SetDefaultTextEncodingName( defaultTextEncodingName );
621 int WebView::GetDefaultFontSize() const
623 return mWebEngine ? mWebEngine.GetDefaultFontSize() : 0;
626 void WebView::SetDefaultFontSize( int defaultFontSize )
630 mWebEngine.SetDefaultFontSize( defaultFontSize );
634 #undef GET_ENUM_STRING
635 #undef GET_ENUM_VALUE
637 } // namespace Internal
639 } // namespace Toolkit