[Tizen] Set custom fragment shader to the visual used in WebView
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / web-view / web-view-impl.cpp
1 /*
2  * Copyright (c) 2020 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 "web-view-impl.h"
20
21 // EXTERNAL INCLUDES
22 #include <cstring>
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>
29
30 // INTERNAL INCLUDES
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>
35
36 namespace Dali
37 {
38
39 namespace Toolkit
40 {
41
42 namespace Internal
43 {
44
45 namespace
46 {
47
48 BaseHandle Create()
49 {
50   return Toolkit::WebView::New();
51 }
52
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 )
58
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 )
64
65 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::WebView, Toolkit::Control, Create )
66
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          )
75
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              )
79
80 DALI_TYPE_REGISTRATION_END()
81
82 const std::string kEmptyString;
83
84 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
85
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
92   \n
93   void main()\n
94   {\n
95       gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * vec4( mixColor, 1.0 );\n
96   }\n
97 );
98
99 Dali::Toolkit::Visual::Base CreateNativeImageVisual( NativeImageInterfacePtr nativeImageInterface )
100 {
101   std::string fragmentShader;
102
103   const char* fragmentPrefix = nativeImageInterface->GetCustomFragmentPrefix();
104   if( fragmentPrefix )
105   {
106     fragmentShader = fragmentPrefix;
107     fragmentShader += FRAGMENT_SHADER_TEXTURE;
108   }
109   else
110   {
111     fragmentShader = FRAGMENT_SHADER_TEXTURE;
112   }
113
114   const char* customSamplerTypename = nativeImageInterface->GetCustomSamplerTypename();
115   if( customSamplerTypename )
116   {
117     fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
118   }
119
120   Texture texture = Dali::Texture::New( *nativeImageInterface );
121   const std::string nativeImageUrl = Dali::Toolkit::TextureManager::AddTexture( texture );
122
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 } } );
127 }
128
129 } // anonymous namepsace
130
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 )
133
134 #define GET_ENUM_VALUE( structName, inputExp, outputExp ) \
135   Scripting::GetEnumerationProperty< Toolkit::WebView::structName::Type >( inputExp, structName##_TABLE, structName##_TABLE_COUNT, outputExp )
136
137 WebView::WebView( const std::string& locale, const std::string& timezoneId )
138 : Control( ControlBehaviour( ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS ) ),
139   mUrl(),
140   mVisual(),
141   mWebViewSize( Stage::GetCurrent().GetSize() ),
142   mWebEngine(),
143   mPageLoadStartedSignal(),
144   mPageLoadFinishedSignal(),
145   mPageLoadErrorSignal()
146 {
147   mWebEngine = Dali::WebEngine::New();
148
149   // WebEngine is empty when it is not properly initialized.
150   if( mWebEngine )
151   {
152     mWebEngine.Create( mWebViewSize.width, mWebViewSize.height, locale, timezoneId );
153   }
154 }
155
156 WebView::WebView()
157 : WebView( "", "" )
158 {
159 }
160
161 WebView::~WebView()
162 {
163 }
164
165 Toolkit::WebView WebView::New()
166 {
167   WebView* impl = new WebView();
168   Toolkit::WebView handle = Toolkit::WebView( *impl );
169
170   impl->Initialize();
171   return handle;
172 }
173
174 Toolkit::WebView WebView::New( const std::string& locale, const std::string& timezoneId )
175 {
176   WebView* impl = new WebView( locale, timezoneId );
177   Toolkit::WebView handle = Toolkit::WebView( *impl );
178
179   impl->Initialize();
180   return handle;
181 }
182
183 void WebView::OnInitialize()
184 {
185   Self().SetProperty( Actor::Property::KEYBOARD_FOCUSABLE, true );
186   Self().TouchedSignal().Connect( this, &WebView::OnTouchEvent );
187
188   if( mWebEngine )
189   {
190     mWebEngine.PageLoadStartedSignal().Connect( this, &WebView::OnPageLoadStarted );
191     mWebEngine.PageLoadFinishedSignal().Connect( this, &WebView::OnPageLoadFinished );
192     mWebEngine.PageLoadErrorSignal().Connect( this, &WebView::OnPageLoadError );
193   }
194 }
195
196 void WebView::LoadUrl( const std::string& url )
197 {
198   mUrl = url;
199   if( mWebEngine )
200   {
201     mVisual = CreateNativeImageVisual( mWebEngine.GetNativeImageSource() );
202
203     if( mVisual )
204     {
205       // Clean up previously registered visual and add new one.
206       DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
207       mWebEngine.LoadUrl( url );
208     }
209   }
210 }
211
212 void WebView::LoadHTMLString( const std::string& htmlString )
213 {
214   if( mWebEngine )
215   {
216     mVisual = CreateNativeImageVisual( mWebEngine.GetNativeImageSource() );
217
218     if( mVisual )
219     {
220       DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
221       mWebEngine.LoadHTMLString( htmlString );
222     }
223   }
224 }
225
226 void WebView::Reload()
227 {
228   if( mWebEngine )
229   {
230     mWebEngine.Reload();
231   }
232 }
233
234 void WebView::StopLoading()
235 {
236   if( mWebEngine )
237   {
238     mWebEngine.StopLoading();
239   }
240 }
241
242 void WebView::Suspend()
243 {
244   if( mWebEngine )
245   {
246     mWebEngine.Suspend();
247   }
248 }
249
250 void WebView::Resume()
251 {
252   if( mWebEngine )
253   {
254     mWebEngine.Resume();
255   }
256 }
257
258 bool WebView::CanGoForward()
259 {
260   return mWebEngine ? mWebEngine.CanGoForward() : false;
261 }
262
263 void WebView::GoForward()
264 {
265   if( mWebEngine )
266   {
267     mWebEngine.GoForward();
268   }
269 }
270
271 bool WebView::CanGoBack()
272 {
273   return mWebEngine ? mWebEngine.CanGoBack() : false;
274 }
275
276 void WebView::GoBack()
277 {
278   if( mWebEngine )
279   {
280     mWebEngine.GoBack();
281   }
282 }
283
284 void WebView::EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler )
285 {
286   if( mWebEngine )
287   {
288     mWebEngine.EvaluateJavaScript( script, resultHandler );
289   }
290 }
291
292 void WebView::AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler )
293 {
294   if( mWebEngine )
295   {
296     mWebEngine.AddJavaScriptMessageHandler( exposedObjectName, handler );
297   }
298 }
299
300 void WebView::ClearHistory()
301 {
302   if( mWebEngine )
303   {
304     mWebEngine.ClearHistory();
305   }
306 }
307
308 void WebView::ClearCache()
309 {
310   if( mWebEngine )
311   {
312     mWebEngine.ClearCache();
313   }
314 }
315
316 void WebView::ClearCookies()
317 {
318   if( mWebEngine )
319   {
320     mWebEngine.ClearCookies();
321   }
322 }
323
324 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadStartedSignal()
325 {
326   return mPageLoadStartedSignal;
327 }
328
329 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadFinishedSignal()
330 {
331   return mPageLoadFinishedSignal;
332 }
333
334 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& WebView::PageLoadErrorSignal()
335 {
336   return mPageLoadErrorSignal;
337 }
338
339 void WebView::OnPageLoadStarted( const std::string& url )
340 {
341   if( !mPageLoadStartedSignal.Empty() )
342   {
343     Dali::Toolkit::WebView handle( GetOwner() );
344     mPageLoadStartedSignal.Emit( handle, url );
345   }
346 }
347
348 void WebView::OnPageLoadFinished( const std::string& url )
349 {
350   if( !mPageLoadFinishedSignal.Empty() )
351   {
352     Dali::Toolkit::WebView handle( GetOwner() );
353     mPageLoadFinishedSignal.Emit( handle, url );
354   }
355 }
356
357 void WebView::OnPageLoadError( const std::string& url, int errorCode )
358 {
359   if( !mPageLoadErrorSignal.Empty() )
360   {
361     Dali::Toolkit::WebView handle( GetOwner() );
362     mPageLoadErrorSignal.Emit( handle, url, static_cast< Toolkit::WebView::LoadErrorCode >( errorCode ) );
363   }
364 }
365
366 bool WebView::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
367 {
368   Dali::BaseHandle handle( object );
369
370   bool connected = false;
371   Toolkit::WebView webView = Toolkit::WebView::DownCast( handle );
372
373   if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_STARTED_SIGNAL ) )
374   {
375     webView.PageLoadStartedSignal().Connect( tracker, functor );
376     connected = true;
377   }
378   else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_FINISHED_SIGNAL ) )
379   {
380     webView.PageLoadFinishedSignal().Connect( tracker, functor );
381     connected = true;
382   }
383   else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_ERROR_SIGNAL ) )
384   {
385     webView.PageLoadErrorSignal().Connect( tracker, functor );
386     connected = true;
387   }
388
389   return connected;
390 }
391
392 Vector3 WebView::GetNaturalSize()
393 {
394   if( mVisual )
395   {
396     Vector2 rendererNaturalSize;
397     mVisual.GetNaturalSize( rendererNaturalSize );
398     return Vector3( rendererNaturalSize );
399   }
400
401   return Vector3( mWebViewSize );
402 }
403
404 void WebView::OnRelayout( const Vector2& size, RelayoutContainer& container )
405 {
406   Control::OnRelayout( size, container );
407
408   if( size.width > 0 && size.height > 0 && mWebViewSize != size )
409   {
410     mWebViewSize = size;
411
412     if( mWebEngine )
413     {
414       mWebEngine.SetSize( size.width, size.height );
415     }
416   }
417 }
418
419 void WebView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
420 {
421   Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
422
423   if( webView )
424   {
425     WebView& impl = GetImpl( webView );
426     switch( index )
427     {
428       case Toolkit::WebView::Property::URL:
429       {
430         std::string url;
431         if( value.Get( url ) )
432         {
433           impl.LoadUrl( url );
434         }
435         break;
436       }
437       case Toolkit::WebView::Property::CACHE_MODEL:
438       {
439         Toolkit::WebView::CacheModel::Type output = impl.GetCacheModel();
440         GET_ENUM_VALUE( CacheModel, value, output );
441         impl.SetCacheModel( output );
442         break;
443       }
444       case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
445       {
446         Toolkit::WebView::CookieAcceptPolicy::Type output = impl.GetCookieAcceptPolicy();
447         GET_ENUM_VALUE( CookieAcceptPolicy, value, output );
448         impl.SetCookieAcceptPolicy( output );
449         break;
450       }
451       case Toolkit::WebView::Property::USER_AGENT:
452       {
453         std::string input;
454         if( value.Get( input ) )
455         {
456           impl.SetUserAgent( input );
457         }
458         break;
459       }
460       case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
461       {
462         bool input;
463         if( value.Get( input ) )
464         {
465           impl.EnableJavaScript( input );
466         }
467         break;
468       }
469       case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
470       {
471         bool input;
472         if( value.Get( input ) )
473         {
474           impl.LoadImagesAutomatically( input );
475         }
476         break;
477       }
478       case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
479       {
480         std::string input;
481         if( value.Get( input ) )
482         {
483           impl.SetDefaultTextEncodingName( input );
484         }
485         break;
486       }
487       case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
488       {
489         int input;
490         if( value.Get( input ) )
491         {
492           impl.SetDefaultFontSize( input );
493         }
494         break;
495       }
496     }
497   }
498 }
499
500 Property::Value WebView::GetProperty( BaseObject* object, Property::Index propertyIndex )
501 {
502   Property::Value value;
503
504   Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
505
506   if( webView )
507   {
508     WebView& impl = GetImpl( webView );
509     switch( propertyIndex )
510     {
511       case Toolkit::WebView::Property::URL:
512       {
513         value = impl.mUrl;
514         break;
515       }
516       case Toolkit::WebView::Property::CACHE_MODEL:
517       {
518         value = GET_ENUM_STRING( CacheModel, impl.GetCacheModel() );
519         break;
520       }
521       case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
522       {
523         value = GET_ENUM_STRING( CookieAcceptPolicy, impl.GetCookieAcceptPolicy() );
524         break;
525       }
526       case Toolkit::WebView::Property::USER_AGENT:
527       {
528         value = impl.GetUserAgent();
529         break;
530       }
531       case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
532       {
533         value = impl.IsJavaScriptEnabled();
534         break;
535       }
536       case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
537       {
538         value = impl.AreImagesAutomaticallyLoaded();
539         break;
540       }
541       case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
542       {
543         value = impl.GetDefaultTextEncodingName();
544         break;
545       }
546       case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
547       {
548         value = impl.GetDefaultFontSize();
549         break;
550       }
551       default:
552          break;
553     }
554   }
555
556   return value;
557 }
558
559 bool WebView::OnTouchEvent( Actor actor, const Dali::TouchEvent& touch )
560 {
561   bool result = false;
562
563   if( mWebEngine )
564   {
565     result = mWebEngine.SendTouchEvent( touch );
566   }
567   return result;
568 }
569
570 bool WebView::OnKeyEvent( const Dali::KeyEvent& event )
571 {
572   bool result = false;
573
574   if( mWebEngine )
575   {
576     result = mWebEngine.SendKeyEvent( event );
577   }
578   return result;
579 }
580
581 Toolkit::WebView::CacheModel::Type WebView::GetCacheModel() const
582 {
583   return mWebEngine ? static_cast< Toolkit::WebView::CacheModel::Type >( mWebEngine.GetCacheModel() ) : Toolkit::WebView::CacheModel::DOCUMENT_VIEWER;
584 }
585
586 void WebView::SetCacheModel( Toolkit::WebView::CacheModel::Type cacheModel )
587 {
588   if( mWebEngine )
589   {
590     mWebEngine.SetCacheModel( static_cast< WebEnginePlugin::CacheModel >( cacheModel ) );
591   }
592 }
593
594 Toolkit::WebView::CookieAcceptPolicy::Type WebView::GetCookieAcceptPolicy() const
595 {
596   return mWebEngine ? static_cast< Toolkit::WebView::CookieAcceptPolicy::Type >( mWebEngine.GetCookieAcceptPolicy() ) : Toolkit::WebView::CookieAcceptPolicy::NO_THIRD_PARTY;
597 }
598
599 void WebView::SetCookieAcceptPolicy( Toolkit::WebView::CookieAcceptPolicy::Type policy )
600 {
601   if( mWebEngine )
602   {
603     mWebEngine.SetCookieAcceptPolicy( static_cast< WebEnginePlugin::CookieAcceptPolicy >( policy ) );
604   }
605 }
606
607 const std::string& WebView::GetUserAgent() const
608 {
609   return mWebEngine ? mWebEngine.GetUserAgent() : kEmptyString;
610 }
611
612 void WebView::SetUserAgent( const std::string& userAgent )
613 {
614   if( mWebEngine )
615   {
616     mWebEngine.SetUserAgent( userAgent );
617   }
618 }
619
620 bool WebView::IsJavaScriptEnabled() const
621 {
622   return mWebEngine ? mWebEngine.IsJavaScriptEnabled() : true;
623 }
624
625 void WebView::EnableJavaScript( bool enabled )
626 {
627   if( mWebEngine )
628   {
629     mWebEngine.EnableJavaScript( enabled );
630   }
631 }
632
633 bool WebView::AreImagesAutomaticallyLoaded() const
634 {
635   return mWebEngine ? mWebEngine.AreImagesAutomaticallyLoaded() : true;
636 }
637
638 void WebView::LoadImagesAutomatically( bool automatic )
639 {
640   if( mWebEngine )
641   {
642     mWebEngine.LoadImagesAutomatically( automatic );
643   }
644 }
645
646 const std::string& WebView::GetDefaultTextEncodingName() const
647 {
648   return mWebEngine ? mWebEngine.GetDefaultTextEncodingName() : kEmptyString;
649 }
650
651 void WebView::SetDefaultTextEncodingName( const std::string& defaultTextEncodingName )
652 {
653   if( mWebEngine )
654   {
655     mWebEngine.SetDefaultTextEncodingName( defaultTextEncodingName );
656   }
657 }
658
659 int WebView::GetDefaultFontSize() const
660 {
661   return mWebEngine ? mWebEngine.GetDefaultFontSize() : 0;
662 }
663
664 void WebView::SetDefaultFontSize( int defaultFontSize )
665 {
666   if( mWebEngine )
667   {
668     mWebEngine.SetDefaultFontSize( defaultFontSize );
669   }
670 }
671
672 #undef GET_ENUM_STRING
673 #undef GET_ENUM_VALUE
674
675 } // namespace Internal
676
677 } // namespace Toolkit
678
679 } // namespace Dali