[CUPS] Implement the Print Job notification.

chrome/browser/chromeos/printing/cups_print_job_notification.cc

+// Copyright 2016 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 "chrome/browser/chromeos/printing/cups_print_job_notification.h"
+
+#include "base/strings/string_number_conversions.h"
+#include "base/strings/utf_string_conversions.h"
+#include "chrome/browser/browser_process.h"
+#include "chrome/browser/chromeos/printing/cups_print_job.h"
+#include "chrome/browser/chromeos/printing/cups_print_job_manager.h"
+#include "chrome/browser/chromeos/printing/cups_print_job_manager_factory.h"
+#include "chrome/browser/notifications/notification_ui_manager.h"
+#include "chrome/browser/profiles/profile.h"
+#include "chrome/grit/generated_resources.h"
+#include "ui/base/l10n/l10n_util.h"
+#include "ui/base/resource/resource_bundle.h"
+#include "ui/chromeos/resources/grit/ui_chromeos_resources.h"
+#include "ui/message_center/message_center.h"
+#include "ui/message_center/notification_types.h"
+
+namespace chromeos {
+
+namespace {
+
+const char kCupsPrintJobNotificationId[] =
+    "chrome://settings/printing/cups-print-job-notification";
+
+class CupsPrintJobNotificationDelegate : public NotificationDelegate {
+ public:
+  explicit CupsPrintJobNotificationDelegate(CupsPrintJobNotification* item)
+      : item_(item) {}
+
+  // NotificationDelegate overrides:
+  void Close(bool by_user) override {
+    if (by_user)
+      item_->CloseNotificationByUser();
+  }
+
+  bool HasClickedListener() override { return true; }
+
+  void ButtonClick(int button_index) override {
+    item_->ClickOnNotificationButton(button_index);
+  }
+
+  std::string id() const override { return item_->GetNotificationId(); }
+
+ private:
+  ~CupsPrintJobNotificationDelegate() override {}
+
+  CupsPrintJobNotification* item_;
+
+  DISALLOW_COPY_AND_ASSIGN(CupsPrintJobNotificationDelegate);
+};
+
+}  // namespace
+
+CupsPrintJobNotification::CupsPrintJobNotification(CupsPrintJob* print_job,
+                                                   Profile* profile)
+    : notification_id_(print_job->GetUniqueId()),
+      print_job_(print_job),
+      delegate_(new CupsPrintJobNotificationDelegate(this)),
+      profile_(profile) {
+  // Create a notification for the print job. The title, body, icon and buttons
+  // of the notification will be updated in UpdateNotification().
+  notification_.reset(new Notification(
+      message_center::NOTIFICATION_TYPE_SIMPLE,
+      base::string16(),  // title
+      base::string16(),  // body
+      gfx::Image(),      // icon
+      message_center::NotifierId(message_center::NotifierId::SYSTEM_COMPONENT,
+                                 kCupsPrintJobNotificationId),
+      base::string16(),  // display_source
+      GURL(kCupsPrintJobNotificationId),
+      notification_id_,  // tag
+      message_center::RichNotificationData(), delegate_.get()));
+  UpdateNotification();
+}
+
+CupsPrintJobNotification::~CupsPrintJobNotification() {}
+
+void CupsPrintJobNotification::OnPrintJobStatusUpdated() {
+  UpdateNotification();
+}
+
+void CupsPrintJobNotification::CloseNotificationByUser() {
+  closed_in_middle_ = true;
+  g_browser_process->message_center()->RemoveNotification(GetNotificationId(),
+                                                          true /* by_user */);
+}
+
+void CupsPrintJobNotification::ClickOnNotificationButton(int button_index) {
+  DCHECK(button_index >= 0 &&
+         static_cast<size_t>(button_index) < button_commands_->size());
+
+  CupsPrintJobNotification::ButtonCommand button_command =
+      button_commands_->at(button_index);
+  CupsPrintJobManager* print_job_manager =
+      CupsPrintJobManagerFactory::GetForBrowserContext(profile_);
+  const ProfileID profile_id = NotificationUIManager::GetProfileID(profile_);
+
+  switch (button_command) {
+    case ButtonCommand::CANCEL_PRINTING:
+      print_job_manager->CancelPrintJob(print_job_);
+      g_browser_process->notification_ui_manager()->CancelById(
+          GetNotificationId(), profile_id);
+      // |print_job_| is deleted by CupsPrintManager when the print job is
+      // cancelled, thus set it to nullptr.
+      print_job_ = nullptr;
+      break;
+    case ButtonCommand::PAUSE_PRINTING:
+      print_job_manager->SuspendPrintJob(print_job_);
+      break;
+    case ButtonCommand::RESUME_PRINTING:
+      print_job_manager->ResumePrintJob(print_job_);
+      break;
+    case ButtonCommand::GET_HELP:
+      break;
+  }
+}
+
+const std::string& CupsPrintJobNotification::GetNotificationId() {
+  return notification_id_;
+}
+
+void CupsPrintJobNotification::UpdateNotification() {
+  DCHECK(print_job_->state() != CupsPrintJob::State::STATE_CANCELLED);

[skau, 2016/10/27 01:43:01]

Is this because jobs are canceled by closing the notification?

[xdai1, 2016/10/28 23:59:54]

Yes, the notification is gone after the job is cancelled (see line 103 in this
file). And CupsPrintJobNotificationManager doesn't observe the
OnPrintJobCancelled event. 

+
+  UpdateNotificationTitle();
+  UpdateNotificationIcon();
+  UpdateNotificationBodyMessage();
+  UpdateNotificationType();
+  UpdateNotificationButtons();
+
+  if (closed_in_middle_ &&
+      print_job_->state() == CupsPrintJob::State::STATE_PAGE_DONE) {
+    // If the notification was closed during the printing, prevent showing the
+    // following printing progress.
+    g_browser_process->notification_ui_manager()->Update(*notification_,
+                                                         profile_);
+  } else if (print_job_->state() == CupsPrintJob::State::STATE_PAGE_DONE) {
+    // If it was not closed, update the notification message directly.
+    g_browser_process->notification_ui_manager()->Add(*notification_, profile_);

[skau, 2016/10/27 01:43:00]

Did you mean to update here?  The comment doesn't seem to match the code.

Also, can you separate the state == STATE_PAGE_DONE case from the others.  You
should note why it's special.

[xdai1, 2016/10/28 23:59:53]

Yes, that's the way to implement it. Add an existing visible notification will
just update the notification.

+  } else {
+    closed_in_middle_ = false;
+    // In order to make sure it pop up, we should delete it before readding it.
+    const ProfileID profile_id = NotificationUIManager::GetProfileID(profile_);
+    g_browser_process->notification_ui_manager()->CancelById(
+        GetNotificationId(), profile_id);
+    g_browser_process->notification_ui_manager()->Add(*notification_, profile_);
+  }
+}
+
+void CupsPrintJobNotification::UpdateNotificationTitle() {
+  notification_->set_title(base::UTF8ToUTF16(print_job_->document_title()));
+}
+
+void CupsPrintJobNotification::UpdateNotificationIcon() {
+  ResourceBundle& bundle = ResourceBundle::GetSharedInstance();
+  switch (print_job_->state()) {
+    case CupsPrintJob::State::STATE_WAITING:
+      notification_->set_icon(
+          bundle.GetImageNamed(IDR_PRINT_NOTIFICATION_WAITING));
+      break;
+    case CupsPrintJob::State::STATE_STARTED:
+    case CupsPrintJob::State::STATE_PAGE_DONE:
+    case CupsPrintJob::State::STATE_SUSPENDED:
+    case CupsPrintJob::State::STATE_RESUMED:
+      notification_->set_icon(
+          bundle.GetImageNamed(IDR_PRINT_NOTIFICATION_PRINTING));
+      break;
+    case CupsPrintJob::State::STATE_DOCUMENT_DONE:
+      notification_->set_icon(
+          bundle.GetImageNamed(IDR_PRINT_NOTIFICATION_DONE));
+      break;
+    case CupsPrintJob::State::STATE_ERROR:
+      notification_->set_icon(
+          bundle.GetImageNamed(IDR_PRINT_NOTIFICATION_ERROR));
+      break;
+    default:
+      break;
+  }
+}
+
+void CupsPrintJobNotification::UpdateNotificationBodyMessage() {
+  base::string16 message;
+  switch (print_job_->state()) {
+    case CupsPrintJob::State::STATE_NONE:
+      break;
+    case CupsPrintJob::State::STATE_WAITING:
+      message = l10n_util::GetStringFUTF16(
+          IDS_PRINT_JOB_WAITING_NOTIFICATION_MESSAGE,
+          base::IntToString16(print_job_->total_page_number()),
+          base::UTF8ToUTF16(print_job_->printer().display_name()));
+      break;
+    case CupsPrintJob::State::STATE_STARTED:
+    case CupsPrintJob::State::STATE_PAGE_DONE:
+    case CupsPrintJob::State::STATE_SUSPENDED:

[skau, 2016/10/27 01:43:00]

Does SUSPENDED belong here?  Do we have no messaging surrounding a paused state?

[xdai1, 2016/10/28 23:59:54]

Right. We don't have special message for the pause state.

+    case CupsPrintJob::State::STATE_RESUMED:
+      message = l10n_util::GetStringFUTF16(
+          IDS_PRINT_JOB_PRINTING_NOTIFICATION_MESSAGE,
+          base::IntToString16(print_job_->total_page_number()),
+          base::UTF8ToUTF16(print_job_->printer().display_name()));
+
+      break;
+    case CupsPrintJob::State::STATE_DOCUMENT_DONE:
+      message = l10n_util::GetStringFUTF16(
+          IDS_PRINT_JOB_DONE_NOTIFICATION_MESSAGE,
+          base::IntToString16(print_job_->total_page_number()),
+          base::UTF8ToUTF16(print_job_->printer().display_name()));
+      break;
+    case CupsPrintJob::State::STATE_ERROR:
+      message = l10n_util::GetStringFUTF16(
+          IDS_PRINT_JOB_ERROR_NOTIFICATION_MESSAGE,
+          base::IntToString16(print_job_->total_page_number()),
+          base::UTF8ToUTF16(print_job_->printer().display_name()));
+      break;
+    default:
+      break;
+  }
+  notification_->set_message(message);
+}
+
+void CupsPrintJobNotification::UpdateNotificationType() {
+  switch (print_job_->state()) {
+    case CupsPrintJob::State::STATE_STARTED:
+    case CupsPrintJob::State::STATE_PAGE_DONE:
+    case CupsPrintJob::State::STATE_SUSPENDED:
+    case CupsPrintJob::State::STATE_RESUMED:
+      notification_->set_type(message_center::NOTIFICATION_TYPE_PROGRESS);
+      notification_->set_progress(print_job_->printed_page_number() * 100 /
+                                  print_job_->total_page_number());
+      break;
+    case CupsPrintJob::State::STATE_NONE:
+    case CupsPrintJob::State::STATE_WAITING:
+    case CupsPrintJob::State::STATE_DOCUMENT_DONE:
+    case CupsPrintJob::State::STATE_ERROR:
+    default:
+      notification_->set_type(message_center::NOTIFICATION_TYPE_SIMPLE);
+      break;
+  }
+}
+
+void CupsPrintJobNotification::UpdateNotificationButtons() {
+  std::vector<message_center::ButtonInfo> buttons;
+  button_commands_ = GetButtonCommands();
+  for (auto& iter : *button_commands_.get()) {

[skau, 2016/10/27 01:43:01]

iter isn't an iterator, it's a ButtonCommand.

[skau, 2016/10/27 01:43:01]

You shouldn't need get() here

[xdai1, 2016/10/28 23:59:54]

Done.

[xdai1, 2016/10/28 23:59:54]

Done.

+    message_center::ButtonInfo button_info =
+        message_center::ButtonInfo(GetButtonLabel(iter));
+    button_info.icon = GetButtonIcon(iter);
+    buttons.push_back(button_info);
+  }
+  notification_->set_buttons(buttons);
+}
+
+std::unique_ptr<std::vector<CupsPrintJobNotification::ButtonCommand>>
+CupsPrintJobNotification::GetButtonCommands() const {
+  std::unique_ptr<std::vector<CupsPrintJobNotification::ButtonCommand>>
+      commands(new std::vector<CupsPrintJobNotification::ButtonCommand>());

[skau, 2016/10/27 01:43:01]

MakeUnique is preferred

+  switch (print_job_->state()) {
+    case CupsPrintJob::State::STATE_WAITING:
+      commands->push_back(ButtonCommand::CANCEL_PRINTING);
+      break;
+    case CupsPrintJob::State::STATE_STARTED:
+    case CupsPrintJob::State::STATE_PAGE_DONE:
+    case CupsPrintJob::State::STATE_RESUMED:
+      commands->push_back(ButtonCommand::PAUSE_PRINTING);
+      commands->push_back(ButtonCommand::CANCEL_PRINTING);
+      break;
+    case CupsPrintJob::State::STATE_SUSPENDED:
+      commands->push_back(ButtonCommand::RESUME_PRINTING);
+      commands->push_back(ButtonCommand::CANCEL_PRINTING);
+      break;
+    case CupsPrintJob::State::STATE_ERROR:
+      commands->push_back(ButtonCommand::GET_HELP);
+      break;
+    default:
+      break;
+  }
+  return commands;
+}
+
+base::string16 CupsPrintJobNotification::GetButtonLabel(
+    ButtonCommand button) const {
+  switch (button) {
+    case ButtonCommand::CANCEL_PRINTING:
+      return l10n_util::GetStringUTF16(
+          IDS_PRINT_JOB_NOTIFICATION_CANCEL_BUTTON);
+    case ButtonCommand::PAUSE_PRINTING:
+      return l10n_util::GetStringUTF16(IDS_PRINT_JOB_NOTIFICATION_PAUSE_BUTTON);
+    case ButtonCommand::RESUME_PRINTING:
+      return l10n_util::GetStringUTF16(
+          IDS_PRINT_JOB_NOTIFICATION_RESUME_BUTTON);
+    case ButtonCommand::GET_HELP:
+      return l10n_util::GetStringUTF16(
+          IDS_PRINT_JOB_NOTIFICATION_GET_HELP_BUTTON);
+  }
+}
+
+gfx::Image CupsPrintJobNotification::GetButtonIcon(ButtonCommand button) const {
+  ResourceBundle& bundle = ResourceBundle::GetSharedInstance();
+  gfx::Image icon;
+  switch (button) {
+    case ButtonCommand::CANCEL_PRINTING:
+      icon = bundle.GetImageNamed(IDR_PRINT_NOTIFICATION_CANCEL);
+      break;
+    case ButtonCommand::PAUSE_PRINTING:
+      icon = bundle.GetImageNamed(IDR_PRINT_NOTIFICATION_PAUSE);
+      break;
+    case ButtonCommand::RESUME_PRINTING:
+      // TODO(xdai): Add "Resume" icon once it's available.
+      break;
+    case ButtonCommand::GET_HELP:
+      // TODO(xdai): Add "Get help" icon once it's available.
+      break;
+  }
+  return icon;
+}
+
+}  // namespace chromeos