[cros login] Split login related classes into subfolders.

chrome/browser/chromeos/login/user.h

-// 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_CHROMEOS_LOGIN_USER_H_
-#define CHROME_BROWSER_CHROMEOS_LOGIN_USER_H_
-
-#include <string>
-#include <vector>
-
-#include "ash/session/user_info.h"
-#include "base/basictypes.h"
-#include "base/strings/string16.h"
-#include "chrome/browser/chromeos/login/user_image.h"
-#include "third_party/skia/include/core/SkBitmap.h"
-#include "ui/gfx/image/image_skia.h"
-
-namespace chromeos {
-
-extern const int kDefaultImagesCount;
-
-// Information that is passed around while authentication is in progress. The
-// credentials may consist of a |user_id|, |password| pair or a GAIA
-// |auth_code|. The |user_id_hash| is used to locate the user's home directory
-// mount point for the user. It is set when the mount has been completed.
-class UserContext {
- public:
-  // The authentication flow used during sign-in.
-  enum AuthFlow {
-    // Online authentication against GAIA. GAIA did not redirect to a SAML IdP.
-    AUTH_FLOW_GAIA_WITHOUT_SAML,
-    // Online authentication against GAIA. GAIA redirected to a SAML IdP.
-    AUTH_FLOW_GAIA_WITH_SAML,
-    // Offline authentication against a cached key.
-    AUTH_FLOW_OFFLINE
-  };
-
-  UserContext();
-  UserContext(const std::string& user_id,
-              const std::string& password,
-              const std::string& auth_code);
-  UserContext(const std::string& user_id,
-              const std::string& password,
-              const std::string& auth_code,
-              const std::string& user_id_hash);
-  UserContext(const std::string& user_id,
-              const std::string& password,
-              const std::string& auth_code,
-              const std::string& user_id_hash,
-              bool is_using_oauth,
-              AuthFlow auth_flow);
-  ~UserContext();
-  bool operator==(const UserContext& context) const;
-
-  void CopyFrom(const UserContext& other);
-
-  const std::string& GetUserID() const;
-  const std::string& GetPassword() const;
-  bool DoesNeedPasswordHashing() const;
-  const std::string& GetKeyLabel() const;
-  const std::string& GetAuthCode() const;
-  const std::string& GetUserIDHash() const;
-  bool IsUsingOAuth() const;
-  AuthFlow GetAuthFlow() const;
-
-  bool HasCredentials() const;
-
-  void SetUserID(const std::string& user_id);
-  void SetPassword(const std::string& password);
-  void SetDoesNeedPasswordHashing(bool does_need_password_hashing);
-  void SetKeyLabel(const std::string& key_label);
-  void SetAuthCode(const std::string& auth_code);
-  void SetUserIDHash(const std::string& user_id_hash);
-  void SetIsUsingOAuth(bool is_using_oauth);
-
- private:
-  std::string user_id_;
-  std::string password_;
-  bool does_need_password_hashing_;
-  std::string key_label_;
-  std::string auth_code_;
-  std::string user_id_hash_;
-  bool is_using_oauth_;
-  AuthFlow auth_flow_;
-};
-
-// A class representing information about a previously logged in user.
-// Each user has a canonical email (username), returned by |email()| and
-// may have a different displayed email (in the raw form as entered by user),
-// returned by |displayed_email()|.
-// Displayed emails are for use in UI only, anywhere else users must be referred
-// to by |email()|.
-class User : public ash::UserInfo {
- public:
-  // The user type. Used in a histogram; do not modify existing types.
-  typedef enum {
-    // Regular user, has a user name and password.
-    USER_TYPE_REGULAR = 0,
-    // Guest user, logs in without authentication.
-    USER_TYPE_GUEST = 1,
-    // Retail mode user, logs in without authentication. This is a special user
-    // type used in retail mode only.
-    USER_TYPE_RETAIL_MODE = 2,
-    // Public account user, logs in without authentication. Available only if
-    // enabled through policy.
-    USER_TYPE_PUBLIC_ACCOUNT = 3,
-    // Locally managed user, logs in only with local authentication.
-    USER_TYPE_LOCALLY_MANAGED = 4,
-    // Kiosk app robot, logs in without authentication.
-    USER_TYPE_KIOSK_APP = 5,
-    // Maximum histogram value.
-    NUM_USER_TYPES = 6
-  } UserType;
-
-  // User OAuth token status according to the last check.
-  // Please note that enum values 1 and 2 were used for OAuth1 status and are
-  // deprecated now.
-  typedef enum {
-     OAUTH_TOKEN_STATUS_UNKNOWN  = 0,
-     OAUTH2_TOKEN_STATUS_INVALID = 3,
-     OAUTH2_TOKEN_STATUS_VALID   = 4,
-  } OAuthTokenStatus;
-
-  // Returned as |image_index| when user-selected file or photo is used as
-  // user image.
-  static const int kExternalImageIndex = -1;
-  // Returned as |image_index| when user profile image is used as user image.
-  static const int kProfileImageIndex = -2;
-  static const int kInvalidImageIndex = -3;
-
-  enum WallpaperType {
-    /* DAILY = 0 */    // Removed.  Do not re-use the id!
-    CUSTOMIZED = 1,    // Selected by user.
-    DEFAULT = 2,       // Default.
-    /* UNKNOWN = 3 */  // Removed.  Do not re-use the id!
-    ONLINE = 4,        // WallpaperInfo.file denotes an URL.
-    POLICY = 5,        // Controlled by policy, can't be changed by the user.
-    WALLPAPER_TYPE_COUNT = 6
-  };
-
-  // Returns the user type.
-  virtual UserType GetType() const = 0;
-
-  // The email the user used to log in.
-  const std::string& email() const { return email_; }
-
-  // The displayed user name.
-  base::string16 display_name() const { return display_name_; }
-
-  // ash::UserInfo
-  virtual std::string GetEmail() const OVERRIDE;
-  virtual base::string16 GetDisplayName() const OVERRIDE;
-  virtual base::string16 GetGivenName() const OVERRIDE;
-  virtual const gfx::ImageSkia& GetImage() const OVERRIDE;
-  virtual std::string GetUserID() const OVERRIDE;
-
-  // Returns the account name part of the email. Use the display form of the
-  // email if available and use_display_name == true. Otherwise use canonical.
-  std::string GetAccountName(bool use_display_email) const;
-
-  // Whether the user has a default image.
-  bool HasDefaultImage() const;
-
-  // True if user image can be synced.
-  virtual bool CanSyncImage() const;
-
-  int image_index() const { return image_index_; }
-  bool has_raw_image() const { return user_image_.has_raw_image(); }
-  // Returns raw representation of static user image.
-  const UserImage::RawImage& raw_image() const {
-    return user_image_.raw_image();
-  }
-  bool has_animated_image() const { return user_image_.has_animated_image(); }
-  // Returns raw representation of animated user image.
-  const UserImage::RawImage& animated_image() const {
-    return user_image_.animated_image();
-  }
-
-  // Whether |raw_image| contains data in format that is considered safe to
-  // decode in sensitive environment (on Login screen).
-  bool image_is_safe_format() const { return user_image_.is_safe_format(); }
-
-  // Returns the URL of user image, if there is any. Currently only the profile
-  // image has a URL, for other images empty URL is returned.
-  GURL image_url() const { return user_image_.url(); }
-
-  // True if user image is a stub (while real image is being loaded from file).
-  bool image_is_stub() const { return image_is_stub_; }
-
-  // True if image is being loaded from file.
-  bool image_is_loading() const { return image_is_loading_; }
-
-  // The displayed (non-canonical) user email.
-  virtual std::string display_email() const;
-
-  // OAuth token status for this user.
-  OAuthTokenStatus oauth_token_status() const { return oauth_token_status_; }
-
-  // Whether online authentication against GAIA should be enforced during the
-  // user's next sign-in.
-  bool force_online_signin() const { return force_online_signin_; }
-
-  // True if the user's session can be locked (i.e. the user has a password with
-  // which to unlock the session).
-  virtual bool can_lock() const;
-
-  virtual std::string username_hash() const;
-
-  // True if current user is logged in.
-  virtual bool is_logged_in() const;
-
-  // True if current user is active within the current session.
-  virtual bool is_active() const;
-
-  // True if the user Profile is created.
-  bool is_profile_created() const {
-    return profile_is_created_;
-  }
-
- protected:
-  friend class SupervisedUserManagerImpl;
-  friend class UserManagerImpl;
-  friend class UserImageManagerImpl;
-  // For testing:
-  friend class MockUserManager;
-  friend class FakeLoginUtils;
-  friend class FakeUserManager;
-  friend class UserAddingScreenTest;
-
-  // Do not allow anyone else to create new User instances.
-  static User* CreateRegularUser(const std::string& email);
-  static User* CreateGuestUser();
-  static User* CreateKioskAppUser(const std::string& kiosk_app_username);
-  static User* CreateLocallyManagedUser(const std::string& username);
-  static User* CreateRetailModeUser();
-  static User* CreatePublicAccountUser(const std::string& email);
-
-  explicit User(const std::string& email);
-  virtual ~User();
-
-  const std::string* GetAccountLocale() const {
-    return account_locale_.get();
-  }
-
-  // Setters are private so only UserManager can call them.
-  void SetAccountLocale(const std::string& resolved_account_locale);
-
-  void SetImage(const UserImage& user_image, int image_index);
-
-  void SetImageURL(const GURL& image_url);
-
-  // Sets a stub image until the next |SetImage| call. |image_index| may be
-  // one of |kExternalImageIndex| or |kProfileImageIndex|.
-  // If |is_loading| is |true|, that means user image is being loaded from file.
-  void SetStubImage(int image_index, bool is_loading);
-
-  void set_display_name(const base::string16& display_name) {
-    display_name_ = display_name;
-  }
-
-  void set_given_name(const base::string16& given_name) {
-    given_name_ = given_name;
-  }
-
-  void set_display_email(const std::string& display_email) {
-    display_email_ = display_email;
-  }
-
-  const UserImage& user_image() const { return user_image_; }
-
-  void set_oauth_token_status(OAuthTokenStatus status) {
-    oauth_token_status_ = status;
-  }
-
-  void set_force_online_signin(bool force_online_signin) {
-    force_online_signin_ = force_online_signin;
-  }
-
-  void set_username_hash(const std::string& username_hash) {
-    username_hash_ = username_hash;
-  }
-
-  void set_is_logged_in(bool is_logged_in) {
-    is_logged_in_ = is_logged_in;
-  }
-
-  void set_can_lock(bool can_lock) {
-    can_lock_ = can_lock;
-  }
-
-  void set_is_active(bool is_active) {
-    is_active_ = is_active;
-  }
-
-  void set_profile_is_created() {
-    profile_is_created_ = true;
-  }
-
-  // True if user has google account (not a guest or managed user).
-  bool has_gaia_account() const;
-
- private:
-  std::string email_;
-  base::string16 display_name_;
-  base::string16 given_name_;
-  // The displayed user email, defaults to |email_|.
-  std::string display_email_;
-  UserImage user_image_;
-  OAuthTokenStatus oauth_token_status_;
-  bool force_online_signin_;
-
-  // This is set to chromeos locale if account data has been downloaded.
-  // (Or failed to download, but at least one download attempt finished).
-  // An empty string indicates error in data load, or in
-  // translation of Account locale to chromeos locale.
-  scoped_ptr<std::string> account_locale_;
-
-  // Used to identify homedir mount point.
-  std::string username_hash_;
-
-  // Either index of a default image for the user, |kExternalImageIndex| or
-  // |kProfileImageIndex|.
-  int image_index_;
-
-  // True if current user image is a stub set by a |SetStubImage| call.
-  bool image_is_stub_;
-
-  // True if current user image is being loaded from file.
-  bool image_is_loading_;
-
-  // True if user is able to lock screen.
-  bool can_lock_;
-
-  // True if user is currently logged in in current session.
-  bool is_logged_in_;
-
-  // True if user is currently logged in and active in current session.
-  bool is_active_;
-
-  // True if user Profile is created
-  bool profile_is_created_;
-
-  DISALLOW_COPY_AND_ASSIGN(User);
-};
-
-// List of known users.
-typedef std::vector<User*> UserList;
-
-}  // namespace chromeos
-
-#endif  // CHROME_BROWSER_CHROMEOS_LOGIN_USER_H_