Notify all active login prompts when one login prompt is submitted. This allo...

chrome/browser/login_prompt.h

 // Copyright (c) 2009 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_LOGIN_PROMPT_H_
 #define CHROME_BROWSER_LOGIN_PROMPT_H_
 
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/lock.h"
+#include "base/ref_counted.h"
 #include "chrome/browser/password_manager/password_manager.h"
+#include "chrome/common/notification_observer.h"
+#include "chrome/common/notification_registrar.h"
 
 namespace net {
 class AuthChallengeInfo;
 }
 
 class ConstrainedWindow;
 class GURL;
 class TabContents;
 class URLRequest;
 
 // This is the base implementation for the OS-specific classes that route
 // authentication info to the URLRequest that needs it. These functions must
 // be implemented in a thread safe manner.
 class LoginHandler : public base::RefCountedThreadSafe<LoginHandler>,
-                     public LoginModelObserver {
+                     public LoginModelObserver,
+                     public NotificationObserver {
  public:
-  explicit LoginHandler(URLRequest* request);
+  LoginHandler(net::AuthChallengeInfo* auth_info, URLRequest* request);
   virtual ~LoginHandler();
 
   // Builds the platform specific LoginHandler. Used from within
   // CreateLoginPrompt() which creates tasks.
-  static LoginHandler* Create(URLRequest* request);
+  static LoginHandler* Create(net::AuthChallengeInfo* auth_info,
+                              URLRequest* request);
 
   // Initializes the underlying platform specific view.
   virtual void BuildViewForPasswordManager(PasswordManager* manager,
                                            std::wstring explanation) = 0;
 
   // Sets information about the authentication type (|form|) and the
   // |password_manager| for this profile.
   void SetPasswordForm(const webkit_glue::PasswordForm& form);
   void SetPasswordManager(PasswordManager* password_manager);
 
   // Returns the TabContents that needs authentication.
   TabContents* GetTabContentsForLogin() const;
 
   // Resend the request with authentication credentials.
   // This function can be called from either thread.
   void SetAuth(const std::wstring& username, const std::wstring& password);
 
   // Display the error page without asking for credentials again.
   // This function can be called from either thread.
   void CancelAuth();
 
   // Notify the handler that the request was cancelled.
   // This function can only be called from the IO thread.
   void OnRequestCancelled();
 
+  // Implements the NotificationObserver interface.
+  // Listens for AUTH_SUPPLIED and AUTH_CANCELLED notifications from other
+  // LoginHandlers so that this LoginHandler has the chance to dismiss itself
+  // if it was waiting for the same authentication.
+  virtual void Observe(NotificationType type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details);
+
  protected:
-
   void SetModel(LoginModel* model);
 
   void SetDialog(ConstrainedWindow* dialog);
 
-  // Notify observers that authentication is needed or received.  The automation
-  // proxy uses this for testing.
-  void SendNotifications();
+  // Notify observers that authentication is needed.
+  void NotifyAuthNeeded();
 
+  // Performs necessary cleanup before deletion.
   void ReleaseSoon();
 
+  // Who/where/what asked for the authentication.
+  net::AuthChallengeInfo* auth_info() const { return auth_info_.get(); }
+
  private:
+  // Starts observing notifications from other LoginHandlers.
+  void AddObservers();
+
+  // Stops observing notifications from other LoginHandlers.
+  void RemoveObservers();
+
+  // Notify observers that authentication is supplied.
+  void NotifyAuthSupplied(const std::wstring& username,
+                          const std::wstring& password);
+
+  // Notify observers that authentication is cancelled.
+  void NotifyAuthCancelled();
 
   // Returns whether authentication had been handled (SetAuth or CancelAuth).
   // If |set_handled| is true, it will mark authentication as handled.
   bool WasAuthHandled(bool set_handled);
 
   // Calls SetAuth from the IO loop.
   void SetAuthDeferred(const std::wstring& username,
                        const std::wstring& password);
 
   // Calls CancelAuth from the IO loop.
   void CancelAuthDeferred();
 
   // Closes the view_contents from the UI loop.
   void CloseContentsDeferred();
 
   // True if we've handled auth (SetAuth or CancelAuth has been called).
   bool handled_auth_;
   Lock handled_auth_lock_;
 
   // The ConstrainedWindow that is hosting our LoginView.
   // This should only be accessed on the UI loop.
   ConstrainedWindow* dialog_;
 
+  // Who/where/what asked for the authentication.
+  scoped_refptr<net::AuthChallengeInfo> auth_info_;
+
   // The request that wants login data.
   // This should only be accessed on the IO loop.
   URLRequest* request_;
 
   // The PasswordForm sent to the PasswordManager. This is so we can refer to it
   // when later notifying the password manager if the credentials were accepted
   // or rejected.
   // This should only be accessed on the UI loop.
   webkit_glue::PasswordForm password_form_;
 
   // Points to the password manager owned by the TabContents requesting auth.
   // Can be null if the TabContents is not a TabContents.
   // This should only be accessed on the UI loop.
   PasswordManager* password_manager_;
 
   // Cached from the URLRequest, in case it goes NULL on us.
   int render_process_host_id_;
   int tab_contents_id_;
 
   // If not null, points to a model we need to notify of our own destruction
   // so it doesn't try and access this when its too late.
   LoginModel* login_model_;
+
+  // Observes other login handlers so this login handler can respond.
+  NotificationRegistrar registrar_;
 };
 
 // Details to provide the NotificationObserver.  Used by the automation proxy
 // for testing.
 class LoginNotificationDetails {
  public:
   explicit LoginNotificationDetails(LoginHandler* handler)
       : handler_(handler) {}
   LoginHandler* handler() const { return handler_; }
 
  private:
   LoginNotificationDetails() {}
 
   LoginHandler* handler_;  // Where to send the response.
 
   DISALLOW_COPY_AND_ASSIGN(LoginNotificationDetails);
 };
 
+// Details to provide the NotificationObserver.  Used by the automation proxy
+// for testing and by other LoginHandlers to dismiss themselves when an
+// identical auth is supplied.
+class AuthSuppliedLoginNotificationDetails : public LoginNotificationDetails {
+ public:
+  AuthSuppliedLoginNotificationDetails(LoginHandler* handler,
+                                       const std::wstring& username,
+                                       const std::wstring& password)
+      : LoginNotificationDetails(handler),
+        username_(username),
+        password_(password) {}
+  const std::wstring& username() const { return username_; }
+  const std::wstring& password() const { return password_; }
+
+ private:
+  // The username that was used for the authentication.
+  const std::wstring username_;
+
+  // The password that was used for the authentication.
+  const std::wstring password_;
+
+  DISALLOW_COPY_AND_ASSIGN(AuthSuppliedLoginNotificationDetails);
+};
+
 // Prompts the user for their username and password.  This is designed to
 // be called on the background (I/O) thread, in response to
 // URLRequest::Delegate::OnAuthRequired.  The prompt will be created
 // on the main UI thread via a call to UI loop's InvokeLater, and will send the
 // credentials back to the URLRequest on the calling thread.
 // A LoginHandler object (which lives on the calling thread) is returned,
 // which can be used to set or cancel authentication programmatically.  The
 // caller must invoke OnRequestCancelled() on this LoginHandler before
 // destroying the URLRequest.
 LoginHandler* CreateLoginPrompt(net::AuthChallengeInfo* auth_info,
                                 URLRequest* request);
 
 // Helper to remove the ref from an URLRequest to the LoginHandler.
 // Should only be called from the IO thread, since it accesses an URLRequest.
 void ResetLoginHandlerForRequest(URLRequest* request);
 
 // Get the signon_realm under which the identity should be saved.
 std::string GetSignonRealm(const GURL& url,
                            const net::AuthChallengeInfo& auth_info);
 
 #endif  // CHROME_BROWSER_LOGIN_PROMPT_H_