| // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CHROME_BROWSER_EXTENSIONS_API_IDENTITY_WEB_AUTH_FLOW_H_ |
| #define CHROME_BROWSER_EXTENSIONS_API_IDENTITY_WEB_AUTH_FLOW_H_ |
| |
| #include <string> |
| |
| #include "apps/shell_window_registry.h" |
| #include "content/public/browser/notification_observer.h" |
| #include "content/public/browser/notification_registrar.h" |
| #include "content/public/browser/web_contents_observer.h" |
| #include "ui/gfx/rect.h" |
| #include "url/gurl.h" |
| |
| class Profile; |
| class WebAuthFlowTest; |
| |
| namespace content { |
| class NotificationDetails; |
| class NotificationSource; |
| class RenderViewHost; |
| class WebContents; |
| } |
| |
| namespace extensions { |
| |
| // Controller class for web based auth flows. The WebAuthFlow creates |
| // a dialog window in the scope approval component app by firing an |
| // event. A webview embedded in the dialog will navigate to the |
| // |provider_url| passed to the WebAuthFlow constructor. |
| // |
| // The WebAuthFlow monitors the WebContents of the webview, and |
| // notifies its delegate interface any time the WebContents navigates |
| // to a new URL or changes title. The delegate is expected to delete |
| // the flow when navigation reaches a known target location. |
| // |
| // The window is not displayed until the first page load |
| // completes. This allows the flow to complete without flashing a |
| // window on screen if the provider immediately redirects to the |
| // target URL. |
| // |
| // A WebAuthFlow can be started in Mode::SILENT, which never displays |
| // a window. If a window would be required, the flow fails. |
| class WebAuthFlow : public content::NotificationObserver, |
| public content::WebContentsObserver, |
| public apps::ShellWindowRegistry::Observer { |
| public: |
| enum Mode { |
| INTERACTIVE, // Show UI to the user if necessary. |
| SILENT // No UI should be shown. |
| }; |
| |
| enum Failure { |
| WINDOW_CLOSED, // Window closed by user. |
| INTERACTION_REQUIRED, // Non-redirect page load in silent mode. |
| LOAD_FAILED |
| }; |
| |
| class Delegate { |
| public: |
| // Called when the auth flow fails. This means that the flow did not result |
| // in a successful redirect to a valid redirect URL. |
| virtual void OnAuthFlowFailure(Failure failure) = 0; |
| // Called on redirects and other navigations to see if the URL should stop |
| // the flow. |
| virtual void OnAuthFlowURLChange(const GURL& redirect_url) = 0; |
| // Called when the title of the current page changes. |
| virtual void OnAuthFlowTitleChange(const std::string& title) = 0; |
| |
| protected: |
| virtual ~Delegate() {} |
| }; |
| |
| // Creates an instance with the given parameters. |
| // Caller owns |delegate|. |
| WebAuthFlow(Delegate* delegate, |
| Profile* profile, |
| const GURL& provider_url, |
| Mode mode); |
| |
| virtual ~WebAuthFlow(); |
| |
| // Starts the flow. |
| virtual void Start(); |
| |
| // Prevents further calls to the delegate and deletes the flow. |
| void DetachDelegateAndDelete(); |
| |
| private: |
| friend class ::WebAuthFlowTest; |
| |
| // ::ShellWindowRegistry::Observer implementation. |
| virtual void OnShellWindowAdded(apps::ShellWindow* shell_window) OVERRIDE; |
| virtual void OnShellWindowIconChanged(apps::ShellWindow* shell_window) |
| OVERRIDE; |
| virtual void OnShellWindowRemoved(apps::ShellWindow* shell_window) OVERRIDE; |
| |
| // NotificationObserver implementation. |
| virtual void Observe(int type, |
| const content::NotificationSource& source, |
| const content::NotificationDetails& details) OVERRIDE; |
| |
| // WebContentsObserver implementation. |
| virtual void DidStopLoading(content::RenderViewHost* render_view_host) |
| OVERRIDE; |
| virtual void DidNavigateMainFrame( |
| const content::LoadCommittedDetails& details, |
| const content::FrameNavigateParams& params) OVERRIDE; |
| virtual void RenderProcessGone(base::TerminationStatus status) OVERRIDE; |
| virtual void DidStartProvisionalLoadForFrame( |
| int64 frame_id, |
| int64 parent_frame_id, |
| bool is_main_frame, |
| const GURL& validated_url, |
| bool is_error_page, |
| bool is_iframe_srcdoc, |
| content::RenderViewHost* render_view_host) OVERRIDE; |
| virtual void DidFailProvisionalLoad(int64 frame_id, |
| const base::string16& frame_unique_name, |
| bool is_main_frame, |
| const GURL& validated_url, |
| int error_code, |
| const base::string16& error_description, |
| content::RenderViewHost* render_view_host) |
| OVERRIDE; |
| |
| void BeforeUrlLoaded(const GURL& url); |
| void AfterUrlLoaded(); |
| |
| Delegate* delegate_; |
| Profile* profile_; |
| GURL provider_url_; |
| Mode mode_; |
| |
| apps::ShellWindow* shell_window_; |
| std::string shell_window_key_; |
| bool embedded_window_created_; |
| |
| content::NotificationRegistrar registrar_; |
| |
| DISALLOW_COPY_AND_ASSIGN(WebAuthFlow); |
| }; |
| |
| } // namespace extensions |
| |
| #endif // CHROME_BROWSER_EXTENSIONS_API_IDENTITY_WEB_AUTH_FLOW_H_ |