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/images/native-image.h>
27 #include <dali/public-api/adaptor-framework/native-image-source.h>
28 #include <dali/public-api/object/type-registry.h>
29 #include <dali/public-api/object/type-registry-helper.h>
32 #include <dali-toolkit/devel-api/controls/control-devel.h>
33 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
34 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
50 return Toolkit::WebView::New();
53 DALI_ENUM_TO_STRING_TABLE_BEGIN( CacheModel )
54 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, DOCUMENT_VIEWER )
55 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, DOCUMENT_BROWSER )
56 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, PRIMARY_WEB_BROWSER )
57 DALI_ENUM_TO_STRING_TABLE_END( CacheModel )
59 DALI_ENUM_TO_STRING_TABLE_BEGIN( CookieAcceptPolicy )
60 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, ALWAYS )
61 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, NEVER )
62 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, NO_THIRD_PARTY )
63 DALI_ENUM_TO_STRING_TABLE_END( CookieAcceptPolicy )
65 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::WebView, Toolkit::Control, Create )
67 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "url", STRING, URL )
68 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "cacheModel", STRING, CACHE_MODEL )
69 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "cookieAcceptPolicy", STRING, COOKIE_ACCEPT_POLICY )
70 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "userAgent", STRING, USER_AGENT )
71 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "enableJavaScript", BOOLEAN, ENABLE_JAVASCRIPT )
72 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "loadImagesAutomatically", BOOLEAN, LOAD_IMAGES_AUTOMATICALLY )
73 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "defaultTextEncodingName", STRING, DEFAULT_TEXT_ENCODING_NAME )
74 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "defaultFontSize", INTEGER, DEFAULT_FONT_SIZE )
76 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadStarted", PAGE_LOAD_STARTED_SIGNAL )
77 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadFinished", PAGE_LOAD_FINISHED_SIGNAL )
78 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadError", PAGE_LOAD_ERROR_SIGNAL )
80 DALI_TYPE_REGISTRATION_END()
82 const std::string kEmptyString;
84 } // anonymous namepsace
86 #define GET_ENUM_STRING( structName, inputExp ) \
87 Scripting::GetLinearEnumerationName< Toolkit::WebView::structName::Type >( static_cast< Toolkit::WebView::structName::Type >( inputExp ), structName##_TABLE, structName##_TABLE_COUNT )
89 #define GET_ENUM_VALUE( structName, inputExp, outputExp ) \
90 Scripting::GetEnumerationProperty< Toolkit::WebView::structName::Type >( inputExp, structName##_TABLE, structName##_TABLE_COUNT, outputExp )
92 WebView::WebView( const std::string& locale, const std::string& timezoneId )
93 : Control( ControlBehaviour( ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS ) ),
96 mWebViewSize( Stage::GetCurrent().GetSize() ),
98 mPageLoadStartedSignal(),
99 mPageLoadFinishedSignal(),
100 mPageLoadErrorSignal()
102 mWebEngine = Dali::WebEngine::New();
104 // WebEngine is empty when it is not properly initialized.
107 mWebEngine.Create( mWebViewSize.width, mWebViewSize.height, locale, timezoneId );
120 Toolkit::WebView WebView::New()
122 WebView* impl = new WebView();
123 Toolkit::WebView handle = Toolkit::WebView( *impl );
129 Toolkit::WebView WebView::New( const std::string& locale, const std::string& timezoneId )
131 WebView* impl = new WebView( locale, timezoneId );
132 Toolkit::WebView handle = Toolkit::WebView( *impl );
138 void WebView::OnInitialize()
140 Self().SetKeyboardFocusable( true );
141 Self().TouchSignal().Connect( this, &WebView::OnTouchEvent );
145 mWebEngine.PageLoadStartedSignal().Connect( this, &WebView::OnPageLoadStarted );
146 mWebEngine.PageLoadFinishedSignal().Connect( this, &WebView::OnPageLoadFinished );
147 mWebEngine.PageLoadErrorSignal().Connect( this, &WebView::OnPageLoadError );
151 void WebView::LoadUrl( const std::string& url )
156 Texture texture = Dali::Texture::New( *mWebEngine.GetNativeImageSource() );
157 const std::string nativeImageUrl = Dali::Toolkit::TextureManager::AddTexture( texture );
158 mVisual = Toolkit::VisualFactory::Get().CreateVisual(
159 { { Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE } ,
160 { Toolkit::ImageVisual::Property::URL, nativeImageUrl } } );
164 // Clean up previously registered visual and add new one.
165 DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
166 mWebEngine.LoadUrl( url );
171 void WebView::LoadHTMLString( const std::string& htmlString )
175 Texture texture = Dali::Texture::New( *mWebEngine.GetNativeImageSource() );
176 const std::string nativeImageUrl = Dali::Toolkit::TextureManager::AddTexture( texture );
178 mVisual = Toolkit::VisualFactory::Get().CreateVisual(
179 { { Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE } ,
180 { Toolkit::ImageVisual::Property::URL, nativeImageUrl } } );
184 DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
185 mWebEngine.LoadHTMLString( htmlString );
190 void WebView::Reload()
198 void WebView::StopLoading()
202 mWebEngine.StopLoading();
206 void WebView::Suspend()
210 mWebEngine.Suspend();
214 void WebView::Resume()
222 bool WebView::CanGoForward()
224 return mWebEngine ? mWebEngine.CanGoForward() : false;
227 void WebView::GoForward()
231 mWebEngine.GoForward();
235 bool WebView::CanGoBack()
237 return mWebEngine ? mWebEngine.CanGoBack() : false;
240 void WebView::GoBack()
248 void WebView::EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler )
252 mWebEngine.EvaluateJavaScript( script, resultHandler );
256 void WebView::AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler )
260 mWebEngine.AddJavaScriptMessageHandler( exposedObjectName, handler );
264 void WebView::ClearHistory()
268 mWebEngine.ClearHistory();
272 void WebView::ClearCache()
276 mWebEngine.ClearCache();
280 void WebView::ClearCookies()
284 mWebEngine.ClearCookies();
288 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadStartedSignal()
290 return mPageLoadStartedSignal;
293 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadFinishedSignal()
295 return mPageLoadFinishedSignal;
298 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& WebView::PageLoadErrorSignal()
300 return mPageLoadErrorSignal;
303 void WebView::OnPageLoadStarted( const std::string& url )
305 if( !mPageLoadStartedSignal.Empty() )
307 Dali::Toolkit::WebView handle( GetOwner() );
308 mPageLoadStartedSignal.Emit( handle, url );
312 void WebView::OnPageLoadFinished( const std::string& url )
314 if( !mPageLoadFinishedSignal.Empty() )
316 Dali::Toolkit::WebView handle( GetOwner() );
317 mPageLoadFinishedSignal.Emit( handle, url );
321 void WebView::OnPageLoadError( const std::string& url, int errorCode )
323 if( !mPageLoadErrorSignal.Empty() )
325 Dali::Toolkit::WebView handle( GetOwner() );
326 mPageLoadErrorSignal.Emit( handle, url, static_cast< Toolkit::WebView::LoadErrorCode >( errorCode ) );
330 bool WebView::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
332 Dali::BaseHandle handle( object );
334 bool connected = false;
335 Toolkit::WebView webView = Toolkit::WebView::DownCast( handle );
337 if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_STARTED_SIGNAL ) )
339 webView.PageLoadStartedSignal().Connect( tracker, functor );
342 else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_FINISHED_SIGNAL ) )
344 webView.PageLoadFinishedSignal().Connect( tracker, functor );
347 else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_ERROR_SIGNAL ) )
349 webView.PageLoadErrorSignal().Connect( tracker, functor );
356 Vector3 WebView::GetNaturalSize()
360 Vector2 rendererNaturalSize;
361 mVisual.GetNaturalSize( rendererNaturalSize );
362 return Vector3( rendererNaturalSize );
365 return Vector3( mWebViewSize );
368 void WebView::OnRelayout( const Vector2& size, RelayoutContainer& container )
370 Control::OnRelayout( size, container );
372 if( size.width > 0 && size.height > 0 && mWebViewSize != size )
378 mWebEngine.SetSize( size.width, size.height );
383 void WebView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
385 Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
389 WebView& impl = GetImpl( webView );
392 case Toolkit::WebView::Property::URL:
395 if( value.Get( url ) )
401 case Toolkit::WebView::Property::CACHE_MODEL:
403 Toolkit::WebView::CacheModel::Type output = impl.GetCacheModel();
404 GET_ENUM_VALUE( CacheModel, value, output );
405 impl.SetCacheModel( output );
408 case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
410 Toolkit::WebView::CookieAcceptPolicy::Type output = impl.GetCookieAcceptPolicy();
411 GET_ENUM_VALUE( CookieAcceptPolicy, value, output );
412 impl.SetCookieAcceptPolicy( output );
415 case Toolkit::WebView::Property::USER_AGENT:
418 if( value.Get( input ) )
420 impl.SetUserAgent( input );
424 case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
427 if( value.Get( input ) )
429 impl.EnableJavaScript( input );
433 case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
436 if( value.Get( input ) )
438 impl.LoadImagesAutomatically( input );
442 case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
445 if( value.Get( input ) )
447 impl.SetDefaultTextEncodingName( input );
451 case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
454 if( value.Get( input ) )
456 impl.SetDefaultFontSize( input );
464 Property::Value WebView::GetProperty( BaseObject* object, Property::Index propertyIndex )
466 Property::Value value;
468 Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
472 WebView& impl = GetImpl( webView );
473 switch( propertyIndex )
475 case Toolkit::WebView::Property::URL:
480 case Toolkit::WebView::Property::CACHE_MODEL:
482 value = GET_ENUM_STRING( CacheModel, impl.GetCacheModel() );
485 case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
487 value = GET_ENUM_STRING( CookieAcceptPolicy, impl.GetCookieAcceptPolicy() );
490 case Toolkit::WebView::Property::USER_AGENT:
492 value = impl.GetUserAgent();
495 case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
497 value = impl.IsJavaScriptEnabled();
500 case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
502 value = impl.AreImagesAutomaticallyLoaded();
505 case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
507 value = impl.GetDefaultTextEncodingName();
510 case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
512 value = impl.GetDefaultFontSize();
523 bool WebView::OnTouchEvent( Actor actor, const Dali::TouchData& touch )
529 result = mWebEngine.SendTouchEvent( touch );
534 bool WebView::OnKeyEvent( const Dali::KeyEvent& event )
540 result = mWebEngine.SendKeyEvent( event );
545 Toolkit::WebView::CacheModel::Type WebView::GetCacheModel() const
547 return mWebEngine ? static_cast< Toolkit::WebView::CacheModel::Type >( mWebEngine.GetCacheModel() ) : Toolkit::WebView::CacheModel::DOCUMENT_VIEWER;
550 void WebView::SetCacheModel( Toolkit::WebView::CacheModel::Type cacheModel )
554 mWebEngine.SetCacheModel( static_cast< WebEnginePlugin::CacheModel >( cacheModel ) );
558 Toolkit::WebView::CookieAcceptPolicy::Type WebView::GetCookieAcceptPolicy() const
560 return mWebEngine ? static_cast< Toolkit::WebView::CookieAcceptPolicy::Type >( mWebEngine.GetCookieAcceptPolicy() ) : Toolkit::WebView::CookieAcceptPolicy::NO_THIRD_PARTY;
563 void WebView::SetCookieAcceptPolicy( Toolkit::WebView::CookieAcceptPolicy::Type policy )
567 mWebEngine.SetCookieAcceptPolicy( static_cast< WebEnginePlugin::CookieAcceptPolicy >( policy ) );
571 const std::string& WebView::GetUserAgent() const
573 return mWebEngine ? mWebEngine.GetUserAgent() : kEmptyString;
576 void WebView::SetUserAgent( const std::string& userAgent )
580 mWebEngine.SetUserAgent( userAgent );
584 bool WebView::IsJavaScriptEnabled() const
586 return mWebEngine ? mWebEngine.IsJavaScriptEnabled() : true;
589 void WebView::EnableJavaScript( bool enabled )
593 mWebEngine.EnableJavaScript( enabled );
597 bool WebView::AreImagesAutomaticallyLoaded() const
599 return mWebEngine ? mWebEngine.AreImagesAutomaticallyLoaded() : true;
602 void WebView::LoadImagesAutomatically( bool automatic )
606 mWebEngine.LoadImagesAutomatically( automatic );
610 const std::string& WebView::GetDefaultTextEncodingName() const
612 return mWebEngine ? mWebEngine.GetDefaultTextEncodingName() : kEmptyString;
615 void WebView::SetDefaultTextEncodingName( const std::string& defaultTextEncodingName )
619 mWebEngine.SetDefaultTextEncodingName( defaultTextEncodingName );
623 int WebView::GetDefaultFontSize() const
625 return mWebEngine ? mWebEngine.GetDefaultFontSize() : 0;
628 void WebView::SetDefaultFontSize( int defaultFontSize )
632 mWebEngine.SetDefaultFontSize( defaultFontSize );
636 #undef GET_ENUM_STRING
637 #undef GET_ENUM_VALUE
639 } // namespace Internal
641 } // namespace Toolkit