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/devel-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>
34 #include <dali-toolkit/public-api/visuals/image-visual-properties.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 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
86 const char* FRAGMENT_SHADER_TEXTURE = DALI_COMPOSE_SHADER(
87 varying mediump vec2 vTexCoord;\n
88 uniform sampler2D sTexture;\n
89 uniform lowp vec4 uColor;\n
90 uniform lowp vec3 mixColor;\n
91 uniform lowp float preMultipliedAlpha;\n
95 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * vec4( mixColor, 1.0 );\n
99 Dali::Toolkit::Visual::Base CreateNativeImageVisual( NativeImageInterfacePtr nativeImageInterface )
101 std::string fragmentShader;
103 const char* fragmentPrefix = nativeImageInterface->GetCustomFragmentPrefix();
106 fragmentShader = fragmentPrefix;
107 fragmentShader += FRAGMENT_SHADER_TEXTURE;
111 fragmentShader = FRAGMENT_SHADER_TEXTURE;
114 const char* customSamplerTypename = nativeImageInterface->GetCustomSamplerTypename();
115 if( customSamplerTypename )
117 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
120 Texture texture = Dali::Texture::New( *nativeImageInterface );
121 const std::string nativeImageUrl = Dali::Toolkit::TextureManager::AddTexture( texture );
123 return Toolkit::VisualFactory::Get().CreateVisual(
124 { { Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE } ,
125 { Toolkit::Visual::Property::SHADER, { { Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, fragmentShader } } },
126 { Toolkit::ImageVisual::Property::URL, nativeImageUrl } } );
129 } // anonymous namepsace
131 #define GET_ENUM_STRING( structName, inputExp ) \
132 Scripting::GetLinearEnumerationName< Toolkit::WebView::structName::Type >( static_cast< Toolkit::WebView::structName::Type >( inputExp ), structName##_TABLE, structName##_TABLE_COUNT )
134 #define GET_ENUM_VALUE( structName, inputExp, outputExp ) \
135 Scripting::GetEnumerationProperty< Toolkit::WebView::structName::Type >( inputExp, structName##_TABLE, structName##_TABLE_COUNT, outputExp )
137 WebView::WebView( const std::string& locale, const std::string& timezoneId )
138 : Control( ControlBehaviour( ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS ) ),
141 mWebViewSize( Stage::GetCurrent().GetSize() ),
143 mPageLoadStartedSignal(),
144 mPageLoadFinishedSignal(),
145 mPageLoadErrorSignal()
147 mWebEngine = Dali::WebEngine::New();
149 // WebEngine is empty when it is not properly initialized.
152 mWebEngine.Create( mWebViewSize.width, mWebViewSize.height, locale, timezoneId );
165 Toolkit::WebView WebView::New()
167 WebView* impl = new WebView();
168 Toolkit::WebView handle = Toolkit::WebView( *impl );
174 Toolkit::WebView WebView::New( const std::string& locale, const std::string& timezoneId )
176 WebView* impl = new WebView( locale, timezoneId );
177 Toolkit::WebView handle = Toolkit::WebView( *impl );
183 void WebView::OnInitialize()
185 Self().SetProperty( Actor::Property::KEYBOARD_FOCUSABLE, true );
186 Self().TouchedSignal().Connect( this, &WebView::OnTouchEvent );
190 mWebEngine.PageLoadStartedSignal().Connect( this, &WebView::OnPageLoadStarted );
191 mWebEngine.PageLoadFinishedSignal().Connect( this, &WebView::OnPageLoadFinished );
192 mWebEngine.PageLoadErrorSignal().Connect( this, &WebView::OnPageLoadError );
196 void WebView::LoadUrl( const std::string& url )
201 mVisual = CreateNativeImageVisual( mWebEngine.GetNativeImageSource() );
205 // Clean up previously registered visual and add new one.
206 DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
207 mWebEngine.LoadUrl( url );
212 void WebView::LoadHTMLString( const std::string& htmlString )
216 mVisual = CreateNativeImageVisual( mWebEngine.GetNativeImageSource() );
220 DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
221 mWebEngine.LoadHTMLString( htmlString );
226 void WebView::Reload()
234 void WebView::StopLoading()
238 mWebEngine.StopLoading();
242 void WebView::Suspend()
246 mWebEngine.Suspend();
250 void WebView::Resume()
258 bool WebView::CanGoForward()
260 return mWebEngine ? mWebEngine.CanGoForward() : false;
263 void WebView::GoForward()
267 mWebEngine.GoForward();
271 bool WebView::CanGoBack()
273 return mWebEngine ? mWebEngine.CanGoBack() : false;
276 void WebView::GoBack()
284 void WebView::EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler )
288 mWebEngine.EvaluateJavaScript( script, resultHandler );
292 void WebView::AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler )
296 mWebEngine.AddJavaScriptMessageHandler( exposedObjectName, handler );
300 void WebView::ClearHistory()
304 mWebEngine.ClearHistory();
308 void WebView::ClearCache()
312 mWebEngine.ClearCache();
316 void WebView::ClearCookies()
320 mWebEngine.ClearCookies();
324 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadStartedSignal()
326 return mPageLoadStartedSignal;
329 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadFinishedSignal()
331 return mPageLoadFinishedSignal;
334 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& WebView::PageLoadErrorSignal()
336 return mPageLoadErrorSignal;
339 void WebView::OnPageLoadStarted( const std::string& url )
341 if( !mPageLoadStartedSignal.Empty() )
343 Dali::Toolkit::WebView handle( GetOwner() );
344 mPageLoadStartedSignal.Emit( handle, url );
348 void WebView::OnPageLoadFinished( const std::string& url )
350 if( !mPageLoadFinishedSignal.Empty() )
352 Dali::Toolkit::WebView handle( GetOwner() );
353 mPageLoadFinishedSignal.Emit( handle, url );
357 void WebView::OnPageLoadError( const std::string& url, int errorCode )
359 if( !mPageLoadErrorSignal.Empty() )
361 Dali::Toolkit::WebView handle( GetOwner() );
362 mPageLoadErrorSignal.Emit( handle, url, static_cast< Toolkit::WebView::LoadErrorCode >( errorCode ) );
366 bool WebView::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
368 Dali::BaseHandle handle( object );
370 bool connected = false;
371 Toolkit::WebView webView = Toolkit::WebView::DownCast( handle );
373 if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_STARTED_SIGNAL ) )
375 webView.PageLoadStartedSignal().Connect( tracker, functor );
378 else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_FINISHED_SIGNAL ) )
380 webView.PageLoadFinishedSignal().Connect( tracker, functor );
383 else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_ERROR_SIGNAL ) )
385 webView.PageLoadErrorSignal().Connect( tracker, functor );
392 Vector3 WebView::GetNaturalSize()
396 Vector2 rendererNaturalSize;
397 mVisual.GetNaturalSize( rendererNaturalSize );
398 return Vector3( rendererNaturalSize );
401 return Vector3( mWebViewSize );
404 void WebView::OnRelayout( const Vector2& size, RelayoutContainer& container )
406 Control::OnRelayout( size, container );
408 if( size.width > 0 && size.height > 0 && mWebViewSize != size )
414 mWebEngine.SetSize( size.width, size.height );
419 void WebView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
421 Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
425 WebView& impl = GetImpl( webView );
428 case Toolkit::WebView::Property::URL:
431 if( value.Get( url ) )
437 case Toolkit::WebView::Property::CACHE_MODEL:
439 Toolkit::WebView::CacheModel::Type output = impl.GetCacheModel();
440 GET_ENUM_VALUE( CacheModel, value, output );
441 impl.SetCacheModel( output );
444 case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
446 Toolkit::WebView::CookieAcceptPolicy::Type output = impl.GetCookieAcceptPolicy();
447 GET_ENUM_VALUE( CookieAcceptPolicy, value, output );
448 impl.SetCookieAcceptPolicy( output );
451 case Toolkit::WebView::Property::USER_AGENT:
454 if( value.Get( input ) )
456 impl.SetUserAgent( input );
460 case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
463 if( value.Get( input ) )
465 impl.EnableJavaScript( input );
469 case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
472 if( value.Get( input ) )
474 impl.LoadImagesAutomatically( input );
478 case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
481 if( value.Get( input ) )
483 impl.SetDefaultTextEncodingName( input );
487 case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
490 if( value.Get( input ) )
492 impl.SetDefaultFontSize( input );
500 Property::Value WebView::GetProperty( BaseObject* object, Property::Index propertyIndex )
502 Property::Value value;
504 Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
508 WebView& impl = GetImpl( webView );
509 switch( propertyIndex )
511 case Toolkit::WebView::Property::URL:
516 case Toolkit::WebView::Property::CACHE_MODEL:
518 value = GET_ENUM_STRING( CacheModel, impl.GetCacheModel() );
521 case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
523 value = GET_ENUM_STRING( CookieAcceptPolicy, impl.GetCookieAcceptPolicy() );
526 case Toolkit::WebView::Property::USER_AGENT:
528 value = impl.GetUserAgent();
531 case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
533 value = impl.IsJavaScriptEnabled();
536 case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
538 value = impl.AreImagesAutomaticallyLoaded();
541 case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
543 value = impl.GetDefaultTextEncodingName();
546 case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
548 value = impl.GetDefaultFontSize();
559 bool WebView::OnTouchEvent( Actor actor, const Dali::TouchEvent& touch )
565 result = mWebEngine.SendTouchEvent( touch );
570 bool WebView::OnKeyEvent( const Dali::KeyEvent& event )
576 result = mWebEngine.SendKeyEvent( event );
581 Toolkit::WebView::CacheModel::Type WebView::GetCacheModel() const
583 return mWebEngine ? static_cast< Toolkit::WebView::CacheModel::Type >( mWebEngine.GetCacheModel() ) : Toolkit::WebView::CacheModel::DOCUMENT_VIEWER;
586 void WebView::SetCacheModel( Toolkit::WebView::CacheModel::Type cacheModel )
590 mWebEngine.SetCacheModel( static_cast< WebEnginePlugin::CacheModel >( cacheModel ) );
594 Toolkit::WebView::CookieAcceptPolicy::Type WebView::GetCookieAcceptPolicy() const
596 return mWebEngine ? static_cast< Toolkit::WebView::CookieAcceptPolicy::Type >( mWebEngine.GetCookieAcceptPolicy() ) : Toolkit::WebView::CookieAcceptPolicy::NO_THIRD_PARTY;
599 void WebView::SetCookieAcceptPolicy( Toolkit::WebView::CookieAcceptPolicy::Type policy )
603 mWebEngine.SetCookieAcceptPolicy( static_cast< WebEnginePlugin::CookieAcceptPolicy >( policy ) );
607 const std::string& WebView::GetUserAgent() const
609 return mWebEngine ? mWebEngine.GetUserAgent() : kEmptyString;
612 void WebView::SetUserAgent( const std::string& userAgent )
616 mWebEngine.SetUserAgent( userAgent );
620 bool WebView::IsJavaScriptEnabled() const
622 return mWebEngine ? mWebEngine.IsJavaScriptEnabled() : true;
625 void WebView::EnableJavaScript( bool enabled )
629 mWebEngine.EnableJavaScript( enabled );
633 bool WebView::AreImagesAutomaticallyLoaded() const
635 return mWebEngine ? mWebEngine.AreImagesAutomaticallyLoaded() : true;
638 void WebView::LoadImagesAutomatically( bool automatic )
642 mWebEngine.LoadImagesAutomatically( automatic );
646 const std::string& WebView::GetDefaultTextEncodingName() const
648 return mWebEngine ? mWebEngine.GetDefaultTextEncodingName() : kEmptyString;
651 void WebView::SetDefaultTextEncodingName( const std::string& defaultTextEncodingName )
655 mWebEngine.SetDefaultTextEncodingName( defaultTextEncodingName );
659 int WebView::GetDefaultFontSize() const
661 return mWebEngine ? mWebEngine.GetDefaultFontSize() : 0;
664 void WebView::SetDefaultFontSize( int defaultFontSize )
668 mWebEngine.SetDefaultFontSize( defaultFontSize );
672 #undef GET_ENUM_STRING
673 #undef GET_ENUM_VALUE
675 } // namespace Internal
677 } // namespace Toolkit