Creates notifications for display resolution change.

ash/display/resolution_notification_controller.cc

+// Copyright 2013 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.
+
+#include "ash/display/resolution_notification_controller.h"
+
+#include "ash/display/display_controller.h"
+#include "ash/display/display_manager.h"
+#include "ash/shell.h"
+#include "base/strings/utf_string_conversions.h"
+#include "grit/ash_resources.h"
+#include "grit/ash_strings.h"
+#include "ui/base/l10n/l10n_util.h"
+#include "ui/base/l10n/time_format.h"
+#include "ui/base/resource/resource_bundle.h"
+#include "ui/gfx/display.h"
+#include "ui/gfx/screen.h"
+#include "ui/message_center/message_center.h"
+#include "ui/message_center/notification.h"
+#include "ui/message_center/notification_delegate.h"
+
+using message_center::Notification;
+
+namespace ash {
+namespace internal {
+namespace {
+
+bool g_use_timer = true;
+
+class ResolutionChangeNotificationDelegate
+    : public message_center::NotificationDelegate {
+ public:
+  ResolutionChangeNotificationDelegate(
+      ResolutionNotificationController* controller,
+      bool has_timeout);
+
+ protected:
+  virtual ~ResolutionChangeNotificationDelegate();
+
+ private:
+  // message_center::NotificationDelegate overrides:
+  virtual void Display() OVERRIDE;
+  virtual void Error() OVERRIDE;
+  virtual void Close(bool by_user) OVERRIDE;
+  virtual void Click() OVERRIDE;
+  virtual void ButtonClick(int button_index) OVERRIDE;
+
+  ResolutionNotificationController* controller_;
+  bool has_timeout_;
+
+  DISALLOW_COPY_AND_ASSIGN(ResolutionChangeNotificationDelegate);
+};
+
+ResolutionChangeNotificationDelegate::ResolutionChangeNotificationDelegate(
+    ResolutionNotificationController* controller,
+    bool has_timeout)
+    : controller_(controller),
+      has_timeout_(has_timeout) {
+  DCHECK(controller_);
+}
+
+ResolutionChangeNotificationDelegate::~ResolutionChangeNotificationDelegate() {
+}
+
+void ResolutionChangeNotificationDelegate::Display() {
+}
+
+void ResolutionChangeNotificationDelegate::Error() {
+}
+
+void ResolutionChangeNotificationDelegate::Close(bool by_user) {
+  if (by_user)
+    controller_->AcceptResolutionChange();
+}
+
+void ResolutionChangeNotificationDelegate::Click() {
+}
+
+void ResolutionChangeNotificationDelegate::ButtonClick(int button_index) {
+  // If there's the timeout, the first button is "Accept". Otherwise the
+  // button click should be "Revert".
+  if (has_timeout_ && button_index == 0)
+    controller_->AcceptResolutionChange();
+  else
+    controller_->RevertResolutionChange();
+}
+
+}  // namespace
+
+// static
+const int ResolutionNotificationController::kTimeoutInSec = 15;
+
+// static
+const char ResolutionNotificationController::kNotificationId[] =
+    "chrome://settings/display/resolution";
+
+ResolutionNotificationController::ResolutionChangeInfo::ResolutionChangeInfo(
+    int64 display_id,
+    const gfx::Size& old_resolution,
+    const gfx::Size& new_resolution,
+    const base::Closure& accept_callback)
+    : display_id(display_id),
+      old_resolution(old_resolution),
+      new_resolution(new_resolution),
+      accept_callback(accept_callback),
+      timeout_count(0) {
+  DisplayManager* display_manager = Shell::GetInstance()->display_manager();
+  if (!display_manager->HasInternalDisplay() &&
+      display_manager->num_connected_displays() == 1u) {
+    timeout_count = kTimeoutInSec;
+  }
+}
+
+ResolutionNotificationController::ResolutionChangeInfo::
+    ~ResolutionChangeInfo() {
+}
+
+ResolutionNotificationController::ResolutionNotificationController() {
+  Shell::GetInstance()->display_controller()->AddObserver(this);
+  Shell::GetScreen()->AddObserver(this);
+}
+
+ResolutionNotificationController::~ResolutionNotificationController() {
+  Shell::GetInstance()->display_controller()->RemoveObserver(this);
+  Shell::GetScreen()->RemoveObserver(this);
+}
+
+void ResolutionNotificationController::SetDisplayResolutionAndNotify(
+    int64 display_id,
+    const gfx::Size& old_resolution,
+    const gfx::Size& new_resolution,
+    const base::Closure& accept_callback) {
+  change_info_.reset(new ResolutionChangeInfo(
+      display_id, old_resolution, new_resolution, accept_callback));
+
+  // SetDisplayResolution() causes OnConfigurationChanged() and the notification
+  // will be shown at that point.
+  Shell::GetInstance()->display_manager()->SetDisplayResolution(
+      display_id, new_resolution);
+}
+
+bool ResolutionNotificationController::DoesNotificationTimeout() {
+  return change_info_ && change_info_->timeout_count > 0;
+}
+
+void ResolutionNotificationController::CreateOrUpdateNotification() {
+  message_center::MessageCenter* message_center =
+      message_center::MessageCenter::Get();
+  if (!change_info_) {
+    message_center->RemoveNotification(kNotificationId, false /* by_user */);
+    return;
+  }
+
+  base::string16 timeout_message;
+  message_center::RichNotificationData data;
+  if (change_info_->timeout_count > 0) {
+    data.buttons.push_back(message_center::ButtonInfo(
+        l10n_util::GetStringUTF16(IDS_ASH_DISPLAY_RESOLUTION_CHANGE_ACCEPT)));
+    timeout_message = l10n_util::GetStringFUTF16(
+        IDS_ASH_DISPLAY_RESOLUTION_TIMEOUT,
+        ui::TimeFormat::TimeDurationLong(
+            base::TimeDelta::FromSeconds(change_info_->timeout_count)));
+  }
+  data.buttons.push_back(message_center::ButtonInfo(
+        l10n_util::GetStringUTF16(IDS_ASH_DISPLAY_RESOLUTION_CHANGE_REVERT)));
+
+  ui::ResourceBundle& bundle = ui::ResourceBundle::GetSharedInstance();
+  scoped_ptr<Notification> notification(new Notification(
+      message_center::NOTIFICATION_TYPE_SIMPLE,
+      kNotificationId,
+      l10n_util::GetStringFUTF16(
+          IDS_ASH_STATUS_TRAY_DISPLAY_RESOLUTION_CHANGED,
+          UTF8ToUTF16(Shell::GetInstance()->display_manager()->
+              GetDisplayNameForId(change_info_->display_id)),
+          UTF8ToUTF16(change_info_->new_resolution.ToString())),
+      timeout_message,
+      bundle.GetImageNamed(IDR_AURA_UBER_TRAY_DISPLAY),
+      base::string16() /* display_source */,
+      std::string() /* extension_id */,
+      data,
+      new ResolutionChangeNotificationDelegate(
+          this, change_info_->timeout_count > 0)));
+  notification->SetSystemPriority();
+  message_center->AddNotification(notification.Pass());
+}
+
+void ResolutionNotificationController::OnTimerTick() {
+  if (!change_info_)
+    return;
+
+  --change_info_->timeout_count;
+  if (change_info_->timeout_count == 0)
+    RevertResolutionChange();
+  else
+    CreateOrUpdateNotification();
+}
+
+void ResolutionNotificationController::AcceptResolutionChange() {
+  message_center::MessageCenter::Get()->RemoveNotification(
+      kNotificationId, false /* by_user */);
+  base::Closure callback = change_info_->accept_callback;
+  change_info_.reset();
+  callback.Run();
+}
+
+void ResolutionNotificationController::RevertResolutionChange() {
+  message_center::MessageCenter::Get()->RemoveNotification(
+      kNotificationId, false /* by_user */);
+  int64 display_id = change_info_->display_id;
+  gfx::Size old_resolution = change_info_->old_resolution;
+  change_info_.reset();
+  Shell::GetInstance()->display_manager()->SetDisplayResolution(
+      display_id, old_resolution);
+}
+
+void ResolutionNotificationController::OnDisplayBoundsChanged(
+    const gfx::Display& display) {
+}
+
+void ResolutionNotificationController::OnDisplayAdded(
+    const gfx::Display& new_display) {
+}
+
+void ResolutionNotificationController::OnDisplayRemoved(
+    const gfx::Display& old_display) {
+  if (change_info_ && change_info_->display_id == old_display.id()) {
+    if (change_info_->timeout_count > 0)
+      RevertResolutionChange();
+    else
+      AcceptResolutionChange();

[Daniel Erat, 2013/08/09 15:50:24]

can you explain this part? why does the change get accepted here?

[Jun Mukai, 2013/08/09 16:49:16]

What I concerned is the following situation:
1. connect external display, change its resolution (no timeout)
2. used for hours or so, but do not dismiss the notification at all, hidden in
the message center
3. and then disconnect the display
4. a few days later, connect the same display again

In that case, the user uses the display happily, so it should not revert the
change at disconnect.


But I changed my mind:
- because this notification has SystemPriority, it keeps appearing as far as
possible, until the user takes an action (close/click/click buttons)
- modifies 'Click' handler to accept. When the user clicks over the
notification, it means accept
- so, it should revert the change here, it means the disconnection happens
without any user's action

[Daniel Erat, 2013/08/09 16:55:46]

ah, i didn't realize that this was for the multiple-display, timeout-is-unneeded
case. it might be worth adding a comment explaining this, but i think that the
logic that you had here (accepting the change even if the user didn't manually
dismiss the notification) was okay.

+  }
+}
+
+void ResolutionNotificationController::OnDisplayConfigurationChanged() {
+  if (!change_info_)
+    return;
+
+  CreateOrUpdateNotification();
+  if (g_use_timer && change_info_->timeout_count > 0) {
+    change_info_->timer.Start(FROM_HERE,
+                              base::TimeDelta::FromSeconds(1),
+                              this,
+                              &ResolutionNotificationController::OnTimerTick);
+  }
+}
+
+void ResolutionNotificationController::SuppressTimerForTest() {
+  g_use_timer = false;
+}
+
+}  // namespace internal
+}  // namespace ash