[Chrome OS] Refactor Canonicalize() method into base class to prepare for new Authenticator subclass

chrome/browser/chromeos/login/authenticator.h

 // Copyright (c) 2010 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_CHROMEOS_LOGIN_AUTHENTICATOR_H_
 #define CHROME_BROWSER_CHROMEOS_LOGIN_AUTHENTICATOR_H_
 #pragma once
 
 #include "base/basictypes.h"
 #include "base/ref_counted.h"
-#include "chrome/browser/chrome_thread.h"
 #include "chrome/browser/chromeos/login/login_status_consumer.h"
 #include "chrome/common/net/gaia/gaia_auth_consumer.h"
 
 class Profile;
 
 namespace chromeos {
 
 // An interface for objects that will authenticate a Chromium OS user.
 // When authentication successfully completes, will call
 // consumer_->OnLoginSuccess(|username|) on the UI thread.
 // On failure, will call consumer_->OnLoginFailure() on the UI thread.
 // On password change detected, will call
 // consumer_->OnPasswordChangeDetected() on the UI thread.
 class Authenticator : public base::RefCountedThreadSafe<Authenticator> {
  public:
-  explicit Authenticator(LoginStatusConsumer* consumer)
-      : consumer_(consumer) {
-  }
-  virtual ~Authenticator() {}
+  explicit Authenticator(LoginStatusConsumer* consumer);
+  virtual ~Authenticator();
 
   // Given a |username| and |password|, this method attempts to authenticate
   // to login.
   // Optionally |login_token| and |login_captcha| could be provided.
   // Returns true if we kick off the attempt successfully and false if we can't.
   // Must be called on the UI thread.
   virtual bool AuthenticateToLogin(Profile* profile,
                                    const std::string& username,
                                    const std::string& password,
                                    const std::string& login_token,
@@ skipping 26 matching lines @@
   virtual void RecoverEncryptedData(
       const std::string& old_password,
       const GaiaAuthConsumer::ClientLoginResult& credentials) = 0;
 
   // Call this method to erase the user's encrypted data
   // and create a new cryptohome.  |result| is the blob of auth
   // data passed back through OnPasswordChangeDetected().
   virtual void ResyncEncryptedData(
       const GaiaAuthConsumer::ClientLoginResult& credentials) = 0;
 
+  // Perform basic canonicalization of |email_address|, taking into account
+  // that gmail does not consider '.' or caps inside a username to matter.
+  // For example, c.masone@gmail.com == cMaSone@gmail.com, per
+  // http://mail.google.com/support/bin/answer.py?hl=en&ctx=mail&answer=10313#

[Zachary Kuznia, 2010/09/28 04:15:03]

Could you update this comment to note that anything after a '+' is also ignored?

[Chris Masone, 2010/09/28 04:33:17]

Done.

+  static std::string Canonicalize(const std::string& email_address);
+
  protected:
   LoginStatusConsumer* consumer_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(Authenticator);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROME_BROWSER_CHROMEOS_LOGIN_AUTHENTICATOR_H_