Add an API for getting web view when request is intercepted.
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / web-view / web-view-impl.h
index a9917fd..6f5e386 100755 (executable)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
 
 /*
- * Copyright (c) 2021 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 
 // EXTERNAL INCLUDES
 #include <dali/devel-api/actors/actor-devel.h>
-#include <dali/devel-api/adaptor-framework/web-engine.h>
+#include <dali/devel-api/adaptor-framework/proxy-accessible.h>
+#include <dali/devel-api/adaptor-framework/web-engine/web-engine.h>
 #include <dali/public-api/images/image-operations.h>
 #include <dali/public-api/object/property-notification.h>
 #include <memory>
+#include <unordered_map>
 
 // INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/controls/control-accessible.h>
 #include <dali-toolkit/devel-api/controls/web-view/web-view.h>
 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
 #include <dali-toolkit/public-api/controls/control-impl.h>
@@ -38,8 +41,6 @@ namespace Toolkit
 class KeyEvent;
 class TouchEvent;
 class WebBackForwardList;
-class WebContext;
-class WebCookieManager;
 class WebSettings;
 class WebView;
 
@@ -73,19 +74,24 @@ public:
   static Toolkit::WebView New(uint32_t argc, char** argv);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::GetSettings()
+   * @copydoc Dali::Toolkit::WebView::FindWebView()
    */
-  Dali::Toolkit::WebSettings* GetSettings() const;
+  static Toolkit::WebView FindWebView(Dali::WebEnginePlugin* plugin);
 
   /**
    * @copydoc Dali::Toolkit::WebView::GetContext()
    */
-  Dali::Toolkit::WebContext* GetContext() const;
+  static Dali::WebEngineContext* GetContext();
 
   /**
    * @copydoc Dali::Toolkit::WebView::GetCookieManager()
    */
-  Dali::Toolkit::WebCookieManager* GetCookieManager() const;
+  static Dali::WebEngineCookieManager* GetCookieManager();
+
+  /**
+   * @copydoc Dali::Toolkit::WebView::GetSettings()
+   */
+  Dali::Toolkit::WebSettings* GetSettings() const;
 
   /**
    * @copydoc Dali::Toolkit::WebView::GetBackForwardList()
@@ -205,12 +211,12 @@ public:
   /**
    * @copydoc Dali::Toolkit::WebView::EvaluateJavaScript()
    */
-  void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
+  void EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler);
 
   /**
    * @copydoc Dali::Toolkit::WebView::AddJavaScriptMessageHandler()
    */
-  void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
+  void AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler);
 
   /**
    * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptAlertCallback()
@@ -313,84 +319,89 @@ public:
   void SetTtsFocus(bool focused);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::PageLoadStartedSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterPageLoadStartedCallback()
+   */
+  void RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
+
+  /**
+   * @copydoc Dali::Toolkit::WebView::RegisterPageLoadInProgressCallback()
    */
-  Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadStartedSignal();
+  void RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::PageLoadInProgressSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterPageLoadFinishedCallback()
    */
-  Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadInProgressSignal();
+  void RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::PageLoadFinishedSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterPageLoadErrorCallback()
    */
-  Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadFinishedSignal();
+  void RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::PageLoadErrorSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterScrollEdgeReachedCallback()
    */
-  Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
+  void RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::ScrollEdgeReachedSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterUrlChangedCallback()
    */
-  Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
+  void RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::UrlChangedSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterFormRepostDecidedCallback()
    */
-  Dali::Toolkit::WebView::WebViewUrlChangedSignalType& UrlChangedSignal();
+  void RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::FormRepostDecisionSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterFrameRenderedCallback()
    */
-  Dali::Toolkit::WebView::WebViewFormRepostDecisionSignalType& FormRepostDecisionSignal();
+  void RegisterFrameRenderedCallback(Dali::WebEnginePlugin::WebEngineFrameRenderedCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::FrameRenderedSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterConsoleMessageReceivedCallback()
    */
-  Dali::Toolkit::WebView::WebViewFrameRenderedSignalType& FrameRenderedSignal();
+  void RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::RequestInterceptorSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterResponsePolicyDecidedCallback()
    */
-  Dali::Toolkit::WebView::WebViewRequestInterceptorSignalType& RequestInterceptorSignal();
+  void RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::ConsoleMessageSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterNavigationPolicyDecidedCallback()
    */
-  Dali::Toolkit::WebView::WebViewConsoleMessageSignalType& ConsoleMessageSignal();
+  void RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::ResponsePolicyDecisionSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterCertificateConfirmedCallback()
    */
-  Dali::Toolkit::WebView::WebViewResponsePolicyDecisionSignalType& ResponsePolicyDecisionSignal();
+  void RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::CertificateConfirmSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterSslCertificateChangedCallback()
    */
-  Dali::Toolkit::WebView::WebViewCertificateSignalType& CertificateConfirmSignal();
+  void RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::SslCertificateChangedSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterHttpAuthHandlerCallback()
    */
-  Dali::Toolkit::WebView::WebViewCertificateSignalType& SslCertificateChangedSignal();
+  void RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::HttpAuthHandlerSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterContextMenuShownCallback()
    */
-  Dali::Toolkit::WebView::WebViewHttpAuthHandlerSignalType& HttpAuthHandlerSignal();
+  void RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::ContextMenuShownSignal()
+   * @copydoc Dali::Toolkit::WebView::RegisterContextMenuHiddenCallback()
    */
-  Dali::Toolkit::WebView::WebViewContextMenuShownSignalType& ContextMenuShownSignal();
+  void RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback);
 
   /**
-   * @copydoc Dali::Toolkit::WebView::ContextMenuHiddenSignal()
+   * @copydoc Dali::Toolkit::WebView::GetPlainTextAsynchronously()
    */
-  Dali::Toolkit::WebView::WebViewContextMenuHiddenSignalType& ContextMenuHiddenSignal();
+  void GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback);
 
 public: // Properties
   /**
@@ -411,17 +422,6 @@ public: // Properties
    */
   static Dali::Property::Value GetProperty(Dali::BaseObject* object, Dali::Property::Index propertyIndex);
 
-  /**
-   * Connects a callback function with the object's signals.
-   * @param[in] object The object providing the signal.
-   * @param[in] tracker Used to disconnect the signal.
-   * @param[in] signalName The signal to connect to.
-   * @param[in] functor A newly allocated FunctorDelegate.
-   * @return True if the signal was connected.
-   * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the c
-   */
-  static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
-
 private: // From Control
   /**
    * @copydoc Toolkit::Control::OnInitialize()
@@ -429,6 +429,11 @@ private: // From Control
   void OnInitialize() override;
 
   /**
+   * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
+   */
+  DevelControl::ControlAccessible* CreateAccessibleObject() override;
+
+  /**
    * @copydoc Toolkit::Control::GetNaturalSize
    */
   Vector3 GetNaturalSize() override;
@@ -460,6 +465,11 @@ private:
   WebView& operator=(const WebView& webView);
 
   /**
+   * @brief Gets web engine plugin.
+   */
+  Dali::WebEnginePlugin* GetPlugin() const;
+
+  /**
    * @brief Set an absolute scroll of the given view.
    * @param[in] x The coordinate x of scroll
    * @param[in] y The coordinate y of scroll
@@ -622,43 +632,6 @@ private:
   Dali::Toolkit::ImageView CreateImageView(Dali::PixelData pixel) const;
 
   /**
-   * @brief Callback function to be called when page load started.
-   * @param[in] url The url currently being loaded
-   */
-  void OnPageLoadStarted(const std::string& url);
-
-  /**
-   * @brief Callback function to be called when page is loading in progress.
-   * @param[in] url The url currently being loaded
-   */
-  void OnPageLoadInProgress(const std::string& url);
-
-  /**
-   * @brief Callback function to be called when page load finished.
-   * @param[in] url The url currently being loaded
-   */
-  void OnPageLoadFinished(const std::string& url);
-
-  /**
-   * @brief Callback function to be called when there is an error in page loading.
-   * @param[in] url The url currently being loaded
-   * @param[in] errorCode The error code
-   */
-  void OnPageLoadError(std::shared_ptr<Dali::WebEngineLoadError> error);
-
-  /**
-   * @brief Callback function to be called when scroll edge is reached.
-   * @param[in] edge The scroll edge reached.
-   */
-  void OnScrollEdgeReached(Dali::WebEnginePlugin::ScrollEdge edge);
-
-  /**
-   * @brief Callback function to be called when url is changed.
-   * @param[in] url The url currently being loaded
-   */
-  void OnUrlChanged(const std::string& url);
-
-  /**
    * @brief Signal occurs when the Web View has been touched.
    * @param[in] actor The Actor Touched
    * @param[in] touch The Touch Data.
@@ -683,12 +656,6 @@ private:
   bool OnWheelEvent(Actor actor, const Dali::WheelEvent& wheel);
 
   /**
-   * @brief Callback function to be called when form repost decision need be checked.
-   * @param[in] decision The new decision for form repost
-   */
-  void OnFormRepostDecision(std::shared_ptr<Dali::WebEngineFormRepostDecision> decision);
-
-  /**
    * @brief Callback function to be called when frame is rendered.
    */
   void OnFrameRendered();
@@ -712,78 +679,34 @@ private:
    */
   void OnScreenshotCaptured(Dali::PixelData pixel);
 
-  /**
-   * @brief Callback function to be called when http request need be intercepted.
-   * @param [in] request The http request interceptor.
-   */
-  void OnInterceptRequest(std::shared_ptr<Dali::WebEngineRequestInterceptor> interceptor);
-
-  /**
-   * @brief Callback function to be called when console message will be logged.
-   * @param[in] message The message logged.
-   */
-  void OnConsoleMessage(std::shared_ptr<Dali::WebEngineConsoleMessage> message);
-
-  /**
-   * @brief Callback function to be called when response policy need be decided.
-   * @param[in] decision The policy decided.
-   */
-  void OnResponsePolicyDecided(std::shared_ptr<Dali::WebEnginePolicyDecision> decision);
+protected:
+  class WebViewAccessible : public DevelControl::ControlAccessible
+  {
+  public:
+    WebViewAccessible() = delete;
 
-  /**
-   * @brief Callback function to be called when certificate need be confirmed.
-   * @param[in] certificate The certificate policy decision.
-   */
-  void OnCertificateConfirm(std::shared_ptr<Dali::WebEngineCertificate> certificate);
+    WebViewAccessible(Dali::Actor self, Dali::WebEngine& webEngine);
 
-  /**
-   * @brief Callback function to be called when ssl certificate is changed.
-   * @param[in] certificate The certificate information received.
-   */
-  void OnSslCertificateChanged(std::shared_ptr<Dali::WebEngineCertificate> certificate);
+  protected:
+    /**
+     * @copydoc Dali::Accessibility::ActorAccessible::DoGetChildren()
+     */
+    void DoGetChildren(std::vector<Dali::Accessibility::Accessible*>& children) override;
 
-  /**
-   * @brief Callback function to be called when http authentication need be confirmed.
-   * @param[in] handler The handler for http authentication
-   */
-  void OnHttpAuthenticationRequest(std::shared_ptr<Dali::WebEngineHttpAuthHandler> handler);
+  private:
+    void OnAccessibilityEnabled();
+    void OnAccessibilityDisabled();
+    void SetRemoteChildAddress(Dali::Accessibility::Address address);
 
-  /**
-   * @brief Callback function to be called when context menu would be shown.
-   * @param[in] e The scroll edge reached.
-   */
-  void OnContextMenuShown(std::shared_ptr<Dali::WebEngineContextMenu> menu);
-
-  /**
-   * @brief Callback function to be called when context menu would be hidden.
-   * @param[in] url The url currently being loaded
-   */
-  void OnContextMenuHidden(std::shared_ptr<Dali::WebEngineContextMenu> menu);
+    Dali::Accessibility::ProxyAccessible mRemoteChild;
+    Dali::WebEngine&                     mWebEngine;
+  };
 
 private:
   Dali::Toolkit::Visual::Base mVisual;
   Dali::Size                  mWebViewSize;
   Dali::WebEngine             mWebEngine;
 
-  Dali::Toolkit::WebView::WebViewPageLoadSignalType               mPageLoadStartedSignal;
-  Dali::Toolkit::WebView::WebViewPageLoadSignalType               mPageLoadInProgressSignal;
-  Dali::Toolkit::WebView::WebViewPageLoadSignalType               mPageLoadFinishedSignal;
-  Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType          mPageLoadErrorSignal;
-  Dali::Toolkit::WebView::WebViewUrlChangedSignalType             mUrlChangedSignal;
-  Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType      mScrollEdgeReachedSignal;
-  Dali::Toolkit::WebView::WebViewFormRepostDecisionSignalType     mFormRepostDecisionSignal;
-  Dali::Toolkit::WebView::WebViewFrameRenderedSignalType          mFrameRenderedSignal;
-  Dali::Toolkit::WebView::WebViewRequestInterceptorSignalType     mRequestInterceptorSignal;
-  Dali::Toolkit::WebView::WebViewConsoleMessageSignalType         mConsoleMessageSignal;
-  Dali::Toolkit::WebView::WebViewResponsePolicyDecisionSignalType mResponsePolicyDecisionSignal;
-  Dali::Toolkit::WebView::WebViewCertificateSignalType            mCertificateConfirmSignal;
-  Dali::Toolkit::WebView::WebViewCertificateSignalType            mSslCertificateChangedSignal;
-  Dali::Toolkit::WebView::WebViewHttpAuthHandlerSignalType        mHttpAuthHandlerSignal;
-  Dali::Toolkit::WebView::WebViewContextMenuShownSignalType       mContextMenuShownSignal;
-  Dali::Toolkit::WebView::WebViewContextMenuHiddenSignalType      mContextMenuHiddenSignal;
-
-  std::unique_ptr<Dali::Toolkit::WebContext>         mWebContext;
-  std::unique_ptr<Dali::Toolkit::WebCookieManager>   mWebCookieManager;
   std::unique_ptr<Dali::Toolkit::WebSettings>        mWebSettings;
   std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
 
@@ -796,6 +719,9 @@ private:
   bool                       mKeyEventsEnabled;
 
   Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback mScreenshotCapturedCallback;
+  Dali::WebEnginePlugin::WebEngineFrameRenderedCallback     mFrameRenderedCallback;
+
+  static std::unordered_map<Dali::WebEnginePlugin*, Dali::WeakHandle<Toolkit::WebView>> mPluginWebViewMap;
 };
 
 } // namespace Internal