user_view.cc revision 5f1c94371a64b3196d4be9466099bb892df9b88e 
1// Copyright 2014 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#include "ash/system/user/user_view.h"
6
7#include <algorithm>
8
9#include "ash/multi_profile_uma.h"
10#include "ash/popup_message.h"
11#include "ash/session/session_state_delegate.h"
12#include "ash/shell.h"
13#include "ash/shell_delegate.h"
14#include "ash/system/tray/system_tray.h"
15#include "ash/system/tray/system_tray_delegate.h"
16#include "ash/system/tray/tray_popup_label_button.h"
17#include "ash/system/tray/tray_popup_label_button_border.h"
18#include "ash/system/user/button_from_view.h"
19#include "ash/system/user/config.h"
20#include "ash/system/user/rounded_image_view.h"
21#include "ash/system/user/user_card_view.h"
22#include "components/user_manager/user_info.h"
23#include "grit/ash_resources.h"
24#include "grit/ash_strings.h"
25#include "ui/base/l10n/l10n_util.h"
26#include "ui/base/resource/resource_bundle.h"
27#include "ui/views/layout/fill_layout.h"
28#include "ui/views/painter.h"
29#include "ui/wm/core/shadow_types.h"
30
31namespace ash {
32namespace tray {
33
34namespace {
35
36const int kPublicAccountLogoutButtonBorderImagesNormal[] = {
37    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
38    IDR_AURA_TRAY_POPUP_LABEL_BUTTON_NORMAL_BACKGROUND,
39    IDR_AURA_TRAY_POPUP_LABEL_BUTTON_NORMAL_BACKGROUND,
40    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
41    IDR_AURA_TRAY_POPUP_LABEL_BUTTON_NORMAL_BACKGROUND,
42    IDR_AURA_TRAY_POPUP_LABEL_BUTTON_NORMAL_BACKGROUND,
43    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
44    IDR_AURA_TRAY_POPUP_LABEL_BUTTON_NORMAL_BACKGROUND,
45    IDR_AURA_TRAY_POPUP_LABEL_BUTTON_NORMAL_BACKGROUND,
46};
47
48const int kPublicAccountLogoutButtonBorderImagesHovered[] = {
49    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
50    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
51    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
52    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
53    IDR_AURA_TRAY_POPUP_LABEL_BUTTON_HOVER_BACKGROUND,
54    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
55    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
56    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
57    IDR_AURA_TRAY_POPUP_PUBLIC_ACCOUNT_LOGOUT_BUTTON_BORDER,
58};
59
60// When a hover border is used, it is starting this many pixels before the icon
61// position.
62const int kTrayUserTileHoverBorderInset = 10;
63
64// Offsetting the popup message relative to the tray menu.
65const int kPopupMessageOffset = 25;
66
67// Switch to a user with the given |user_index|.
68void SwitchUser(ash::MultiProfileIndex user_index) {
69  // Do not switch users when the log screen is presented.
70  if (ash::Shell::GetInstance()
71          ->session_state_delegate()
72          ->IsUserSessionBlocked())
73    return;
74
75  DCHECK(user_index > 0);
76  ash::SessionStateDelegate* delegate =
77      ash::Shell::GetInstance()->session_state_delegate();
78  ash::MultiProfileUMA::RecordSwitchActiveUser(
79      ash::MultiProfileUMA::SWITCH_ACTIVE_USER_BY_TRAY);
80  delegate->SwitchActiveUser(delegate->GetUserInfo(user_index)->GetUserID());
81}
82
83class LogoutButton : public TrayPopupLabelButton {
84 public:
85  // If |placeholder| is true, button is used as placeholder. That means that
86  // button is inactive and is not painted, but consume the same ammount of
87  // space, as if it was painted.
88  LogoutButton(views::ButtonListener* listener,
89               const base::string16& text,
90               bool placeholder)
91      : TrayPopupLabelButton(listener, text), placeholder_(placeholder) {
92    SetEnabled(!placeholder_);
93  }
94
95  virtual ~LogoutButton() {}
96
97 private:
98  virtual void Paint(gfx::Canvas* canvas,
99                     const views::CullSet& cull_set) OVERRIDE {
100    // Just skip paint if this button used as a placeholder.
101    if (!placeholder_)
102      TrayPopupLabelButton::Paint(canvas, cull_set);
103  }
104
105  bool placeholder_;
106  DISALLOW_COPY_AND_ASSIGN(LogoutButton);
107};
108
109class UserViewMouseWatcherHost : public views::MouseWatcherHost {
110 public:
111  explicit UserViewMouseWatcherHost(const gfx::Rect& screen_area)
112      : screen_area_(screen_area) {}
113  virtual ~UserViewMouseWatcherHost() {}
114
115  // Implementation of MouseWatcherHost.
116  virtual bool Contains(const gfx::Point& screen_point,
117                        views::MouseWatcherHost::MouseEventType type) OVERRIDE {
118    return screen_area_.Contains(screen_point);
119  }
120
121 private:
122  gfx::Rect screen_area_;
123
124  DISALLOW_COPY_AND_ASSIGN(UserViewMouseWatcherHost);
125};
126
127// The menu item view which gets shown when the user clicks in multi profile
128// mode onto the user item.
129class AddUserView : public views::View {
130 public:
131  // The |owner| is the view for which this view gets created.
132  AddUserView(ButtonFromView* owner);
133  virtual ~AddUserView();
134
135  // Get the anchor view for a message.
136  views::View* anchor() { return anchor_; }
137
138 private:
139  // Overridden from views::View.
140  virtual gfx::Size GetPreferredSize() const OVERRIDE;
141
142  // Create the additional client content for this item.
143  void AddContent();
144
145  // This is the content we create and show.
146  views::View* add_user_;
147
148  // This is the owner view of this item.
149  ButtonFromView* owner_;
150
151  // The anchor view for targetted bubble messages.
152  views::View* anchor_;
153
154  DISALLOW_COPY_AND_ASSIGN(AddUserView);
155};
156
157AddUserView::AddUserView(ButtonFromView* owner)
158    : add_user_(NULL), owner_(owner), anchor_(NULL) {
159  AddContent();
160  owner_->ForceBorderVisible(true);
161}
162
163AddUserView::~AddUserView() {
164  owner_->ForceBorderVisible(false);
165}
166
167gfx::Size AddUserView::GetPreferredSize() const {
168  return owner_->bounds().size();
169}
170
171void AddUserView::AddContent() {
172  SetLayoutManager(new views::FillLayout());
173  set_background(views::Background::CreateSolidBackground(kBackgroundColor));
174
175  add_user_ = new views::View;
176  add_user_->SetBorder(views::Border::CreateEmptyBorder(
177      0, kTrayUserTileHoverBorderInset, 0, 0));
178
179  add_user_->SetLayoutManager(new views::BoxLayout(
180      views::BoxLayout::kHorizontal, 0, 0, kTrayPopupPaddingBetweenItems));
181  AddChildViewAt(add_user_, 0);
182
183  // Add the [+] icon which is also the anchor for messages.
184  RoundedImageView* icon = new RoundedImageView(kTrayAvatarCornerRadius, true);
185  anchor_ = icon;
186  icon->SetImage(*ui::ResourceBundle::GetSharedInstance()
187                      .GetImageNamed(IDR_AURA_UBER_TRAY_ADD_MULTIPROFILE_USER)
188                      .ToImageSkia(),
189                 gfx::Size(kTrayAvatarSize, kTrayAvatarSize));
190  add_user_->AddChildView(icon);
191
192  // Add the command text.
193  views::Label* command_label = new views::Label(
194      l10n_util::GetStringUTF16(IDS_ASH_STATUS_TRAY_SIGN_IN_ANOTHER_ACCOUNT));
195  command_label->SetHorizontalAlignment(gfx::ALIGN_LEFT);
196  add_user_->AddChildView(command_label);
197}
198
199}  // namespace
200
201UserView::UserView(SystemTrayItem* owner,
202                   user::LoginStatus login,
203                   MultiProfileIndex index,
204                   bool for_detailed_view)
205    : multiprofile_index_(index),
206      user_card_view_(NULL),
207      owner_(owner),
208      is_user_card_button_(false),
209      logout_button_(NULL),
210      add_user_disabled_(false),
211      for_detailed_view_(for_detailed_view),
212      focus_manager_(NULL) {
213  CHECK_NE(user::LOGGED_IN_NONE, login);
214  if (!index) {
215    // Only the logged in user will have a background. All other users will have
216    // to allow the TrayPopupContainer highlighting the menu line.
217    set_background(views::Background::CreateSolidBackground(
218        login == user::LOGGED_IN_PUBLIC ? kPublicAccountBackgroundColor
219                                        : kBackgroundColor));
220  }
221  SetLayoutManager(new views::BoxLayout(
222      views::BoxLayout::kHorizontal, 0, 0, kTrayPopupPaddingBetweenItems));
223  // The logout button must be added before the user card so that the user card
224  // can correctly calculate the remaining available width.
225  // Note that only the current multiprofile user gets a button.
226  if (!multiprofile_index_)
227    AddLogoutButton(login);
228  AddUserCard(login);
229}
230
231UserView::~UserView() {
232  RemoveAddUserMenuOption();
233}
234
235void UserView::MouseMovedOutOfHost() {
236  RemoveAddUserMenuOption();
237}
238
239TrayUser::TestState UserView::GetStateForTest() const {
240  if (add_menu_option_.get()) {
241    return add_user_disabled_ ? TrayUser::ACTIVE_BUT_DISABLED
242                              : TrayUser::ACTIVE;
243  }
244
245  if (!is_user_card_button_)
246    return TrayUser::SHOWN;
247
248  return static_cast<ButtonFromView*>(user_card_view_)->is_hovered_for_test()
249             ? TrayUser::HOVERED
250             : TrayUser::SHOWN;
251}
252
253gfx::Rect UserView::GetBoundsInScreenOfUserButtonForTest() {
254  DCHECK(user_card_view_);
255  return user_card_view_->GetBoundsInScreen();
256}
257
258gfx::Size UserView::GetPreferredSize() const {
259  gfx::Size size = views::View::GetPreferredSize();
260  // Only the active user panel will be forced to a certain height.
261  if (!multiprofile_index_) {
262    size.set_height(
263        std::max(size.height(), kTrayPopupItemHeight + GetInsets().height()));
264  }
265  return size;
266}
267
268int UserView::GetHeightForWidth(int width) const {
269  return GetPreferredSize().height();
270}
271
272void UserView::Layout() {
273  gfx::Rect contents_area(GetContentsBounds());
274  if (user_card_view_ && logout_button_) {
275    // Give the logout button the space it requests.
276    gfx::Rect logout_area = contents_area;
277    logout_area.ClampToCenteredSize(logout_button_->GetPreferredSize());
278    logout_area.set_x(contents_area.right() - logout_area.width());
279
280    // Give the remaining space to the user card.
281    gfx::Rect user_card_area = contents_area;
282    int remaining_width = contents_area.width() - logout_area.width();
283    if (IsMultiProfileSupportedAndUserActive() ||
284        IsMultiAccountSupportedAndUserActive()) {
285      // In multiprofile/multiaccount case |user_card_view_| and
286      // |logout_button_| have to have the same height.
287      int y = std::min(user_card_area.y(), logout_area.y());
288      int height = std::max(user_card_area.height(), logout_area.height());
289      logout_area.set_y(y);
290      logout_area.set_height(height);
291      user_card_area.set_y(y);
292      user_card_area.set_height(height);
293
294      // In multiprofile mode we have also to increase the size of the card by
295      // the size of the border to make it overlap with the logout button.
296      user_card_area.set_width(std::max(0, remaining_width + 1));
297
298      // To make the logout button symmetrical with the user card we also make
299      // the button longer by the same size the hover area in front of the icon
300      // got inset.
301      logout_area.set_width(logout_area.width() +
302                            kTrayUserTileHoverBorderInset);
303    } else {
304      // In all other modes we have to make sure that there is enough spacing
305      // between the two.
306      remaining_width -= kTrayPopupPaddingBetweenItems;
307    }
308    user_card_area.set_width(remaining_width);
309    user_card_view_->SetBoundsRect(user_card_area);
310    logout_button_->SetBoundsRect(logout_area);
311  } else if (user_card_view_) {
312    user_card_view_->SetBoundsRect(contents_area);
313  } else if (logout_button_) {
314    logout_button_->SetBoundsRect(contents_area);
315  }
316}
317
318void UserView::ButtonPressed(views::Button* sender, const ui::Event& event) {
319  if (sender == logout_button_) {
320    Shell::GetInstance()->metrics()->RecordUserMetricsAction(
321        ash::UMA_STATUS_AREA_SIGN_OUT);
322    RemoveAddUserMenuOption();
323    Shell::GetInstance()->system_tray_delegate()->SignOut();
324  } else if (sender == user_card_view_ && !multiprofile_index_ &&
325             IsMultiAccountSupportedAndUserActive()) {
326    owner_->TransitionDetailedView();
327  } else if (sender == user_card_view_ &&
328             IsMultiProfileSupportedAndUserActive()) {
329    if (!multiprofile_index_) {
330      ToggleAddUserMenuOption();
331    } else {
332      RemoveAddUserMenuOption();
333      SwitchUser(multiprofile_index_);
334      // Since the user list is about to change the system menu should get
335      // closed.
336      owner_->system_tray()->CloseSystemBubble();
337    }
338  } else if (add_menu_option_.get() &&
339             sender == add_menu_option_->GetContentsView()) {
340    RemoveAddUserMenuOption();
341    // Let the user add another account to the session.
342    MultiProfileUMA::RecordSigninUser(MultiProfileUMA::SIGNIN_USER_BY_TRAY);
343    Shell::GetInstance()->system_tray_delegate()->ShowUserLogin();
344    owner_->system_tray()->CloseSystemBubble();
345  } else {
346    NOTREACHED();
347  }
348}
349
350void UserView::OnWillChangeFocus(View* focused_before, View* focused_now) {
351  if (focused_now)
352    RemoveAddUserMenuOption();
353}
354
355void UserView::OnDidChangeFocus(View* focused_before, View* focused_now) {
356  // Nothing to do here.
357}
358
359void UserView::AddLogoutButton(user::LoginStatus login) {
360  const base::string16 title =
361      user::GetLocalizedSignOutStringForStatus(login, true);
362  TrayPopupLabelButton* logout_button =
363      new LogoutButton(this, title, for_detailed_view_);
364  logout_button->SetAccessibleName(title);
365  logout_button_ = logout_button;
366  // In public account mode, the logout button border has a custom color.
367  if (login == user::LOGGED_IN_PUBLIC) {
368    scoped_ptr<TrayPopupLabelButtonBorder> border(
369        new TrayPopupLabelButtonBorder());
370    border->SetPainter(false,
371                       views::Button::STATE_NORMAL,
372                       views::Painter::CreateImageGridPainter(
373                           kPublicAccountLogoutButtonBorderImagesNormal));
374    border->SetPainter(false,
375                       views::Button::STATE_HOVERED,
376                       views::Painter::CreateImageGridPainter(
377                           kPublicAccountLogoutButtonBorderImagesHovered));
378    border->SetPainter(false,
379                       views::Button::STATE_PRESSED,
380                       views::Painter::CreateImageGridPainter(
381                           kPublicAccountLogoutButtonBorderImagesHovered));
382    logout_button_->SetBorder(border.PassAs<views::Border>());
383  }
384  AddChildView(logout_button_);
385}
386
387void UserView::AddUserCard(user::LoginStatus login) {
388  // Add padding around the panel.
389  SetBorder(views::Border::CreateEmptyBorder(kTrayPopupUserCardVerticalPadding,
390                                             kTrayPopupPaddingHorizontal,
391                                             kTrayPopupUserCardVerticalPadding,
392                                             kTrayPopupPaddingHorizontal));
393
394  views::TrayBubbleView* bubble_view =
395      owner_->system_tray()->GetSystemBubble()->bubble_view();
396  int max_card_width =
397      bubble_view->GetMaximumSize().width() -
398      (2 * kTrayPopupPaddingHorizontal + kTrayPopupPaddingBetweenItems);
399  if (logout_button_)
400    max_card_width -= logout_button_->GetPreferredSize().width();
401  user_card_view_ =
402      new UserCardView(login, max_card_width, multiprofile_index_);
403  bool clickable = IsMultiProfileSupportedAndUserActive() ||
404                   IsMultiAccountSupportedAndUserActive();
405  if (clickable) {
406    // To allow the border to start before the icon, reduce the size before and
407    // add an inset to the icon to get the spacing.
408    if (!multiprofile_index_) {
409      SetBorder(views::Border::CreateEmptyBorder(
410          kTrayPopupUserCardVerticalPadding,
411          kTrayPopupPaddingHorizontal - kTrayUserTileHoverBorderInset,
412          kTrayPopupUserCardVerticalPadding,
413          kTrayPopupPaddingHorizontal));
414      user_card_view_->SetBorder(views::Border::CreateEmptyBorder(
415          0, kTrayUserTileHoverBorderInset, 0, 0));
416    }
417    gfx::Insets insets = gfx::Insets(1, 1, 1, 1);
418    views::View* contents_view = user_card_view_;
419    ButtonFromView* button = NULL;
420    if (!for_detailed_view_) {
421      if (multiprofile_index_) {
422        // Since the activation border needs to be drawn around the tile, we
423        // have to put the tile into another view which fills the menu panel,
424        // but keeping the offsets of the content.
425        contents_view = new views::View();
426        contents_view->SetBorder(views::Border::CreateEmptyBorder(
427            kTrayPopupUserCardVerticalPadding,
428            kTrayPopupPaddingHorizontal,
429            kTrayPopupUserCardVerticalPadding,
430            kTrayPopupPaddingHorizontal));
431        contents_view->SetLayoutManager(new views::FillLayout());
432        SetBorder(views::Border::CreateEmptyBorder(0, 0, 0, 0));
433        contents_view->AddChildView(user_card_view_);
434        insets = gfx::Insets(1, 1, 1, 3);
435      }
436      button = new ButtonFromView(contents_view,
437                                  this,
438                                  !multiprofile_index_,
439                                  insets);
440      // TODO(skuhne): For accessibility we need to call |SetAccessibleName|
441      // with a useful name (string freeze for M37 has passed).
442    } else {
443      // We want user card for detailed view to have exactly the same look
444      // as user card for default view. That's why we wrap it in a button
445      // without click listener and special hover behavior.
446      button = new ButtonFromView(contents_view, NULL, false, insets);
447    }
448    // A click on the button should not trigger a focus change.
449    button->set_request_focus_on_press(false);
450    user_card_view_ = button;
451    is_user_card_button_ = true;
452  }
453  AddChildViewAt(user_card_view_, 0);
454  // Card for supervised user can consume more space than currently
455  // available. In that case we should increase system bubble's width.
456  if (login == user::LOGGED_IN_PUBLIC)
457    bubble_view->SetWidth(GetPreferredSize().width());
458}
459
460void UserView::ToggleAddUserMenuOption() {
461  if (add_menu_option_.get()) {
462    RemoveAddUserMenuOption();
463    return;
464  }
465
466  // Note: We do not need to install a global event handler to delete this
467  // item since it will destroyed automatically before the menu / user menu item
468  // gets destroyed..
469  add_menu_option_.reset(new views::Widget);
470  views::Widget::InitParams params;
471  params.type = views::Widget::InitParams::TYPE_TOOLTIP;
472  params.keep_on_top = true;
473  params.context = this->GetWidget()->GetNativeWindow();
474  params.accept_events = true;
475  params.ownership = views::Widget::InitParams::WIDGET_OWNS_NATIVE_WIDGET;
476  params.opacity = views::Widget::InitParams::TRANSLUCENT_WINDOW;
477  add_menu_option_->Init(params);
478  add_menu_option_->SetOpacity(0xFF);
479  add_menu_option_->GetNativeWindow()->set_owned_by_parent(false);
480  SetShadowType(add_menu_option_->GetNativeView(), wm::SHADOW_TYPE_NONE);
481
482  // Position it below our user card.
483  gfx::Rect bounds = user_card_view_->GetBoundsInScreen();
484  bounds.set_y(bounds.y() + bounds.height());
485  add_menu_option_->SetBounds(bounds);
486
487  // Show the content.
488  add_menu_option_->SetAlwaysOnTop(true);
489  add_menu_option_->Show();
490
491  AddUserView* add_user_view =
492      new AddUserView(static_cast<ButtonFromView*>(user_card_view_));
493
494  const SessionStateDelegate* delegate =
495      Shell::GetInstance()->session_state_delegate();
496  add_user_disabled_ = delegate->NumberOfLoggedInUsers() >=
497                       delegate->GetMaximumNumberOfLoggedInUsers();
498  ButtonFromView* button = new ButtonFromView(
499      add_user_view,
500      add_user_disabled_ ? NULL : this,
501      !add_user_disabled_,
502      gfx::Insets(1, 1, 1, 1));
503  button->set_request_focus_on_press(false);
504  button->SetAccessibleName(
505      l10n_util::GetStringUTF16(IDS_ASH_STATUS_TRAY_SIGN_IN_ANOTHER_ACCOUNT));
506  button->ForceBorderVisible(true);
507  add_menu_option_->SetContentsView(button);
508
509  if (add_user_disabled_) {
510    ui::ResourceBundle& bundle = ui::ResourceBundle::GetSharedInstance();
511    popup_message_.reset(new PopupMessage(
512        bundle.GetLocalizedString(IDS_ASH_STATUS_TRAY_CAPTION_CANNOT_ADD_USER),
513        bundle.GetLocalizedString(IDS_ASH_STATUS_TRAY_MESSAGE_CANNOT_ADD_USER),
514        PopupMessage::ICON_WARNING,
515        add_user_view->anchor(),
516        views::BubbleBorder::TOP_LEFT,
517        gfx::Size(parent()->bounds().width() - kPopupMessageOffset, 0),
518        2 * kPopupMessageOffset));
519  } else {
520    // We activate the entry automatically if invoked with focus.
521    if (user_card_view_->HasFocus()) {
522      button->GetFocusManager()->SetFocusedView(button);
523      user_card_view_->GetFocusManager()->SetFocusedView(button);
524    }
525  }
526  // Find the screen area which encloses both elements and sets then a mouse
527  // watcher which will close the "menu".
528  gfx::Rect area = user_card_view_->GetBoundsInScreen();
529  area.set_height(2 * area.height());
530  mouse_watcher_.reset(
531      new views::MouseWatcher(new UserViewMouseWatcherHost(area), this));
532  mouse_watcher_->Start();
533  // Install a listener to focus changes so that we can remove the card when
534  // the focus gets changed. When called through the destruction of the bubble,
535  // the FocusManager cannot be determined anymore and we remember it here.
536  focus_manager_ = user_card_view_->GetFocusManager();
537  focus_manager_->AddFocusChangeListener(this);
538}
539
540void UserView::RemoveAddUserMenuOption() {
541  if (!add_menu_option_.get())
542    return;
543  focus_manager_->RemoveFocusChangeListener(this);
544  focus_manager_ = NULL;
545  if (user_card_view_->GetFocusManager())
546    user_card_view_->GetFocusManager()->ClearFocus();
547  popup_message_.reset();
548  mouse_watcher_.reset();
549  add_menu_option_.reset();
550}
551
552}  // namespace tray
553}  // namespace ash
554