// 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_LOGIN_DISPLAY_H_
#define CHROME_BROWSER_CHROMEOS_LOGIN_LOGIN_DISPLAY_H_
#include <string>
#include <vector>
#include "base/callback.h"
#include "base/strings/string16.h"
#include "chrome/browser/chromeos/login/help_app_launcher.h"
#include "chrome/browser/chromeos/login/remove_user_delegate.h"
#include "chrome/browser/chromeos/login/user.h"
#include "chrome/browser/chromeos/login/user_manager.h"
#include "ui/gfx/image/image.h"
#include "ui/gfx/native_widget_types.h"
#include "ui/gfx/rect.h"
namespace chromeos {
// TODO(nkostylev): Extract interface, create a BaseLoginDisplay class.
// An abstract class that defines login UI implementation.
class LoginDisplay : public RemoveUserDelegate {
public:
// Supported authentication types for login.
enum AuthType {
// Authenticates using the user's regular password.
OFFLINE_PASSWORD,
// Authenticates by forced online GAIA sign in.
ONLINE_SIGN_IN,
// Authenticates with a 4 digit numeric pin.
NUMERIC_PIN,
// Authenticates by clicking pod when it is focused.
USER_CLICK,
};
// Sign in error IDs that require detailed error screen and not just
// a simple error bubble.
enum SigninError {
// Shown in case of critical TPM error.
TPM_ERROR,
};
class Delegate {
public:
// Cancels current password changed flow.
virtual void CancelPasswordChangedFlow() = 0;
// Create new Google account.
virtual void CreateAccount() = 0;
// Complete sign process with specified |user_context|.
// Used for new users authenticated through an extension.
virtual void CompleteLogin(const UserContext& user_context) = 0;
// Returns name of the currently connected network.
virtual base::string16 GetConnectedNetworkName() = 0;
// Returns true if sign in is in progress.
virtual bool IsSigninInProgress() const = 0;
// Sign in using |username| and |password| specified.
// Used for known users only.
virtual void Login(const UserContext& user_context) = 0;
// Sign in as a retail mode user.
virtual void LoginAsRetailModeUser() = 0;
// Sign in into guest session.
virtual void LoginAsGuest() = 0;
// Decrypt cryptohome using user provided |old_password|
// and migrate to new password.
virtual void MigrateUserData(const std::string& old_password) = 0;
// Sign in into the public account identified by |username|.
virtual void LoginAsPublicAccount(const std::string& username) = 0;
// Login to kiosk mode for app with |app_id|.
virtual void LoginAsKioskApp(const std::string& app_id,
bool diagnostic_mode) = 0;
// Notify the delegate when the sign-in UI is finished loading.
virtual void OnSigninScreenReady() = 0;
// Called when existing user pod is selected in the UI.
virtual void OnUserSelected(const std::string& username) = 0;
// Called when the user requests enterprise enrollment.
virtual void OnStartEnterpriseEnrollment() = 0;
// Called when the user requests kiosk enable screen.
virtual void OnStartKioskEnableScreen() = 0;
// Called when the user requests device reset.
virtual void OnStartDeviceReset() = 0;
// Called when the owner permission for kiosk app auto launch is requested.
virtual void OnStartKioskAutolaunchScreen() = 0;
// Shows wrong HWID screen.
virtual void ShowWrongHWIDScreen() = 0;
// Restarts the public-session auto-login timer if it is running.
virtual void ResetPublicSessionAutoLoginTimer() = 0;
// Ignore password change, remove existing cryptohome and
// force full sync of user data.
virtual void ResyncUserData() = 0;
// Sets the displayed email for the next login attempt with |CompleteLogin|.
// If it succeeds, user's displayed email value will be updated to |email|.
virtual void SetDisplayEmail(const std::string& email) = 0;
// Sign out the currently signed in user.
// Used when the lock screen is being displayed.
virtual void Signout() = 0;
protected:
virtual ~Delegate();
};
// |background_bounds| determines the bounds of login UI background.
LoginDisplay(Delegate* delegate, const gfx::Rect& background_bounds);
virtual ~LoginDisplay();
// Clears and enables fields on user pod or GAIA frame.
virtual void ClearAndEnablePassword() = 0;
// Initializes login UI with the user pods based on list of known users and
// guest, new user pods if those are enabled.
virtual void Init(const UserList& users,
bool show_guest,
bool show_users,
bool show_new_user) = 0;
// Notifies the login UI that the preferences defining how to visualize it to
// the user have changed and it needs to refresh.
virtual void OnPreferencesChanged() = 0;
// Called when user image has been changed.
// |user| contains updated user.
virtual void OnUserImageChanged(const User& user) = 0;
// After this call login display should be ready to be smoothly destroyed
// (e.g. hide throbber, etc.).
virtual void OnFadeOut() = 0;
// Called when user is successfully authenticated.
virtual void OnLoginSuccess(const std::string& username) = 0;
// Changes enabled state of the UI.
virtual void SetUIEnabled(bool is_enabled) = 0;
// Selects user entry with specified |index|.
// Does nothing if current user is already selected.
virtual void SelectPod(int index) = 0;
// Displays a banner on the login screen containing |message|.
virtual void ShowBannerMessage(const std::string& message) = 0;
// Shows a button with an icon inside the user pod of |username|.
virtual void ShowUserPodButton(const std::string& username,
const std::string& iconURL,
const base::Closure& click_callback) = 0;
// Hides the user pod button for a user.
virtual void HideUserPodButton(const std::string& username) = 0;
// Set the authentication type to be used on the lock screen.
virtual void SetAuthType(const std::string& username,
AuthType auth_type,
const std::string& initial_value) = 0;
// Returns the authentication type used for |username|.
virtual AuthType GetAuthType(const std::string& username) const = 0;
// Displays simple error bubble with |error_msg_id| specified.
// |login_attempts| shows number of login attempts made by current user.
// |help_topic_id| is additional help topic that is presented as link.
virtual void ShowError(int error_msg_id,
int login_attempts,
HelpAppLauncher::HelpTopic help_topic_id) = 0;
// Displays detailed error screen for error with ID |error_id|.
virtual void ShowErrorScreen(LoginDisplay::SigninError error_id) = 0;
// Proceed with Gaia flow because password has changed.
virtual void ShowGaiaPasswordChanged(const std::string& username) = 0;
// Show password changed dialog. If |show_password_error| is not null
// user already tried to enter old password but it turned out to be incorrect.
virtual void ShowPasswordChangedDialog(bool show_password_error) = 0;
// Shows signin UI with specified email.
virtual void ShowSigninUI(const std::string& email) = 0;
// Hides or shows login UI control bar with [Shut down] / [Add user] buttons.
virtual void ShowControlBar(bool show) = 0;
gfx::Rect background_bounds() const { return background_bounds_; }
void set_background_bounds(const gfx::Rect& background_bounds) {
background_bounds_ = background_bounds;
}
Delegate* delegate() { return delegate_; }
void set_delegate(Delegate* delegate) { delegate_ = delegate; }
gfx::NativeWindow parent_window() const { return parent_window_; }
void set_parent_window(gfx::NativeWindow window) { parent_window_ = window; }
bool is_signin_completed() const { return is_signin_completed_; }
void set_signin_completed(bool value) { is_signin_completed_ = value; }
int width() const { return background_bounds_.width(); }
protected:
// Login UI delegate (controller).
Delegate* delegate_;
// Parent window, might be used to create dialog windows.
gfx::NativeWindow parent_window_;
// Bounds of the login UI background.
gfx::Rect background_bounds_;
// True if signin for user has completed.
// TODO(nkostylev): Find a better place to store this state
// in redesigned login stack.
// Login stack (and this object) will be recreated for next user sign in.
bool is_signin_completed_;
DISALLOW_COPY_AND_ASSIGN(LoginDisplay);
};
} // namespace chromeos
#endif // CHROME_BROWSER_CHROMEOS_LOGIN_LOGIN_DISPLAY_H_