Chrome proxy refactoring.

chrome/service/cloud_print/cloud_print_connector.cc

+// Copyright (c) 2011 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/service/cloud_print/cloud_print_connector.h"
+
+#include "base/md5.h"
+#include "base/rand_util.h"
+#include "base/string_number_conversions.h"
+#include "base/string_split.h"
+#include "base/stringprintf.h"
+#include "base/utf_string_conversions.h"
+#include "base/values.h"
+#include "chrome/service/cloud_print/cloud_print_consts.h"
+#include "chrome/service/cloud_print/cloud_print_helpers.h"
+#include "grit/generated_resources.h"
+#include "ui/base/l10n/l10n_util.h"
+
+CloudPrintConnector::CloudPrintConnector(
+    Client* client,
+    const std::string& proxy_id,
+    const GURL& cloud_print_server_url,
+    const DictionaryValue* print_system_settings)
+  : client_(client),
+    proxy_id_(proxy_id),
+    cloud_print_server_url_(cloud_print_server_url),
+    next_response_handler_(NULL) {
+  if (print_system_settings) {
+    // It is possible to have no print settings specified.
+    print_system_settings_.reset(print_system_settings->DeepCopy());
+  }
+}
+
+CloudPrintConnector::~CloudPrintConnector() {
+}
+
+bool CloudPrintConnector::Start() {
+  DCHECK(!print_system_.get());
+  VLOG(1) << "CP_PROXY: Starting proxy, id: " << proxy_id_;
+
+  pedning_tasks_.clear();
+
+  print_system_ =
+      cloud_print::PrintSystem::CreateInstance(print_system_settings_.get());
+  if (!print_system_.get()) {
+    NOTREACHED();
+    return false;  // No print system available, fail initalization.
+  }
+  cloud_print::PrintSystem::PrintSystemResult result = print_system_->Init();
+  if (!result.succeeded()) {
+    // We could not initialize the print system. We need to notify the server.
+    ReportUserMessage(kPrintSystemFailedMessageId, result.message());
+    print_system_.release();
+    return false;
+  }
+
+  // Start watching for updates from the print system.
+  print_server_watcher_ = print_system_->CreatePrintServerWatcher();
+  print_server_watcher_->StartWatching(this);
+
+  // Get list of registered printers.
+  AddPendingAvailableTask();
+  return true;
+}
+
+void CloudPrintConnector::Stop() {
+  VLOG(1) << "CP_PROXY: Stopping proxy, id: " << proxy_id_;

[Albert Bodenhamer, 2011/10/26 23:58:09]

Should we use the term proxy or connector?  I know we've been using them
interchangeably but this refactoring could be a good chance to get some
consistency here.

+  DCHECK(print_system_.get());
+  if (print_system_.get()) {
+    // Do uninitialization here.
+    pedning_tasks_.clear();
+    print_server_watcher_.release();
+    print_system_.release();
+  }
+}
+
+bool CloudPrintConnector::IsRunning() {
+  return print_system_.get() != NULL;
+}
+
+void CloudPrintConnector::RegisterPrinters(
+    const printing::PrinterList& printers) {
+  if (!IsRunning())
+    return;
+  printing::PrinterList::const_iterator it;
+  for (it = printers.begin(); it != printers.end(); ++it) {
+    AddPendingRegisterTask(*it);
+  }
+}
+
+// Check for jobs for specific printer
+void CloudPrintConnector::CheckForJobs(const std::string& reason,
+                                       const std::string& printer_id) {
+  if (!IsRunning())
+    return;
+  if (!printer_id.empty()) {
+    JobHandlerMap::iterator index = job_handler_map_.find(printer_id);
+    if (index != job_handler_map_.end())
+      index->second->CheckForJobs(reason);
+  } else {
+    for (JobHandlerMap::iterator index = job_handler_map_.begin();
+         index != job_handler_map_.end(); index++) {
+      index->second->CheckForJobs(reason);
+    }
+  }
+}
+
+void CloudPrintConnector::OnPrinterAdded() {
+  AddPendingAvailableTask();
+}
+
+void CloudPrintConnector::OnPrinterDeleted(const std::string& printer_id) {
+  AddPendingDeleteTask(printer_id);
+}
+
+void CloudPrintConnector::OnAuthError() {
+  client_->OnAuthFailed();
+}
+
+// CloudPrintURLFetcher::Delegate implementation.
+CloudPrintURLFetcher::ResponseAction CloudPrintConnector::HandleRawData(
+    const content::URLFetcher* source,
+    const GURL& url,
+    const std::string& data) {
+  // If this notification came as a result of user message call, stop it.
+  // Otherwise proceed continue processing.
+  if (user_message_request_.get() &&
+      user_message_request_->IsSameRequest(source))
+    return CloudPrintURLFetcher::STOP_PROCESSING;
+  return CloudPrintURLFetcher::CONTINUE_PROCESSING;
+}
+
+CloudPrintURLFetcher::ResponseAction CloudPrintConnector::HandleJSONData(
+    const content::URLFetcher* source,
+    const GURL& url,
+    DictionaryValue* json_data,
+    bool succeeded) {
+  if (!IsRunning())  // Orphant response. Connector has been stopped already.
+    return CloudPrintURLFetcher::STOP_PROCESSING;
+
+  DCHECK(next_response_handler_);
+  return (this->*next_response_handler_)(source, url, json_data, succeeded);
+}
+
+CloudPrintURLFetcher::ResponseAction
+CloudPrintConnector::HandlePrinterListResponse(
+    const content::URLFetcher* source,
+    const GURL& url,
+    DictionaryValue* json_data,
+    bool succeeded) {
+  DCHECK(succeeded);
+  if (!succeeded)
+    return CloudPrintURLFetcher::RETRY_REQUEST;
+
+  // Now we need to get the list of printers from the print system
+  // and split printers into 3 categories:
+  // - existing and registered printers
+  // - new printers
+  // - deleted printers
+
+  // Get list of the printers from the print system.
+  printing::PrinterList local_printers;
+  cloud_print::PrintSystem::PrintSystemResult result =
+      print_system_->EnumeratePrinters(&local_printers);
+  bool full_list = result.succeeded();
+  if (!result.succeeded()) {
+    std::string message = result.message();
+    if (message.empty())
+      message = l10n_util::GetStringUTF8(IDS_CLOUD_PRINT_ENUM_FAILED);
+    // There was a failure enumerating printers. Send a message to the server.
+    ReportUserMessage(kEnumPrintersFailedMessageId, message);
+  }
+
+  // Go through the list of the cloud printers and init print job handlers.
+  ListValue* printer_list = NULL;
+  // There may be no "printers" value in the JSON
+  if (json_data->GetList(kPrinterListValue, &printer_list) && printer_list) {
+    for (size_t index = 0; index < printer_list->GetSize(); index++) {
+      DictionaryValue* printer_data = NULL;
+      if (printer_list->GetDictionary(index, &printer_data)) {
+        std::string printer_name;
+        printer_data->GetString(kNameValue, &printer_name);
+        if (RemovePrinterFromList(printer_name, &local_printers)) {
+          InitJobHandlerForPrinter(printer_data);
+        } else {
+          // Cloud printer is not found on the local system.
+          if (full_list) {  // Delete only if we get the full list of printer.
+            std::string printer_id;
+            printer_data->GetString(kIdValue, &printer_id);
+            AddPendingDeleteTask(printer_id);
+          }
+        }
+      } else {
+        NOTREACHED();
+      }
+    }
+  }
+
+  request_ = NULL;
+  if (!local_printers.empty()) {
+    // Notify client that we have a list of printers available.
+    // Client will call us back to finish registration
+    client_->OnPrintersAvailable(local_printers);
+  }
+  ContinuePendingTaskProcessing();  // Continue processing background tasks.
+  return CloudPrintURLFetcher::STOP_PROCESSING;
+}
+
+CloudPrintURLFetcher::ResponseAction
+CloudPrintConnector::HandlePrinterDeleteResponse(
+    const content::URLFetcher* source,
+    const GURL& url,
+    DictionaryValue* json_data,
+    bool succeeded) {
+  VLOG(1) << "CP_PROXY: Handler printer delete response, succeeded:"
+          << succeeded << " url: " << url;
+  ContinuePendingTaskProcessing();  // Continue processing background tasks.
+  return CloudPrintURLFetcher::STOP_PROCESSING;
+}
+
+CloudPrintURLFetcher::ResponseAction
+CloudPrintConnector::HandleRegisterPrinterResponse(
+    const content::URLFetcher* source,
+    const GURL& url,
+    DictionaryValue* json_data,
+    bool succeeded) {
+  VLOG(1) << "CP_PROXY: Handler printer register response, succeeded:"
+          << succeeded << " url: " << url;
+  if (succeeded) {
+    ListValue* printer_list = NULL;
+    // There should be a "printers" value in the JSON
+    if (json_data->GetList(kPrinterListValue, &printer_list)) {
+      DictionaryValue* printer_data = NULL;
+      if (printer_list->GetDictionary(0, &printer_data))
+        InitJobHandlerForPrinter(printer_data);
+    }
+  }
+  ContinuePendingTaskProcessing();  // Continue processing background tasks.
+  return CloudPrintURLFetcher::STOP_PROCESSING;
+}
+
+
+CloudPrintURLFetcher::ResponseAction CloudPrintConnector::OnRequestAuthError() {
+  OnAuthError();
+  return CloudPrintURLFetcher::STOP_PROCESSING;
+}
+
+std::string CloudPrintConnector::GetAuthHeader() {
+  return CloudPrintHelpers::GetCloudPrintAuthHeader();
+}
+
+void CloudPrintConnector::StartGetRequest(const GURL& url,
+                                          int max_retries,
+                                          ResponseHandler handler) {
+  next_response_handler_ = handler;
+  request_ = new CloudPrintURLFetcher;
+  request_->StartGetRequest(url, this, max_retries, std::string());
+}
+
+void CloudPrintConnector::StartPostRequest(const GURL& url,
+                                           int max_retries,
+                                           const std::string& mime_type,
+                                           const std::string& post_data,
+                                           ResponseHandler handler) {
+  next_response_handler_ = handler;
+  request_ = new CloudPrintURLFetcher;
+  request_->StartPostRequest(
+      url, this, max_retries, mime_type, post_data, std::string());
+}
+
+void CloudPrintConnector::ReportUserMessage(const std::string& message_id,
+                                            const std::string& failure_msg) {
+  // This is a fire and forget type of function.
+  // Result of this request will be ignored.
+  std::string mime_boundary;
+  CloudPrintHelpers::CreateMimeBoundaryForUpload(&mime_boundary);
+  GURL url = CloudPrintHelpers::GetUrlForUserMessage(cloud_print_server_url_,
+                                                     message_id);
+  std::string post_data;
+  CloudPrintHelpers::AddMultipartValueForUpload(kMessageTextValue,
+                                                failure_msg,
+                                                mime_boundary,
+                                                std::string(),
+                                                &post_data);
+  // Terminate the request body
+  post_data.append("--" + mime_boundary + "--\r\n");
+  std::string mime_type("multipart/form-data; boundary=");
+  mime_type += mime_boundary;
+  user_message_request_ = new CloudPrintURLFetcher;
+  user_message_request_->StartPostRequest(url, this, 1, mime_type, post_data,
+                                          std::string());
+}
+
+bool CloudPrintConnector::RemovePrinterFromList(
+    const std::string& printer_name,
+    printing::PrinterList* printer_list) {
+  for (printing::PrinterList::iterator index = printer_list->begin();
+       index != printer_list->end(); index++) {
+    if (IsSamePrinter(index->printer_name, printer_name)) {
+      index = printer_list->erase(index);
+      return true;
+    }
+  }
+  return false;
+}
+
+void CloudPrintConnector::InitJobHandlerForPrinter(
+    DictionaryValue* printer_data) {
+  DCHECK(printer_data);
+  PrinterJobHandler::PrinterInfoFromCloud printer_info_cloud;
+  printer_data->GetString(kIdValue, &printer_info_cloud.printer_id);
+  DCHECK(!printer_info_cloud.printer_id.empty());
+  VLOG(1) << "CP_PROXY: Init job handler for printer id: "
+          << printer_info_cloud.printer_id;
+  JobHandlerMap::iterator index = job_handler_map_.find(
+      printer_info_cloud.printer_id);
+  if (index != job_handler_map_.end())
+    return;  // Nothing to do if we already have a job handler for this printer.
+
+  printing::PrinterBasicInfo printer_info;
+  printer_data->GetString(kNameValue, &printer_info.printer_name);
+  DCHECK(!printer_info.printer_name.empty());
+  printer_data->GetString(kPrinterDescValue,
+                          &printer_info.printer_description);
+  // Printer status is a string value which actually contains an integer.
+  std::string printer_status;
+  if (printer_data->GetString(kPrinterStatusValue, &printer_status)) {
+    base::StringToInt(printer_status, &printer_info.printer_status);
+  }
+  printer_data->GetString(kPrinterCapsHashValue,
+      &printer_info_cloud.caps_hash);
+  ListValue* tags_list = NULL;
+  if (printer_data->GetList(kTagsValue, &tags_list) && tags_list) {
+    for (size_t index = 0; index < tags_list->GetSize(); index++) {
+      std::string tag;
+      if (tags_list->GetString(index, &tag) &&
+          StartsWithASCII(tag, kTagsHashTagName, false)) {
+        std::vector<std::string> tag_parts;
+        base::SplitStringDontTrim(tag, '=', &tag_parts);
+        DCHECK_EQ(tag_parts.size(), 2U);
+        if (tag_parts.size() == 2)
+          printer_info_cloud.tags_hash = tag_parts[1];
+      }
+    }
+  }
+  scoped_refptr<PrinterJobHandler> job_handler;
+  job_handler = new PrinterJobHandler(printer_info,
+                                      printer_info_cloud,
+                                      cloud_print_server_url_,
+                                      print_system_.get(),
+                                      this);
+  job_handler_map_[printer_info_cloud.printer_id] = job_handler;
+  job_handler->Initialize();
+}
+
+void CloudPrintConnector::AddPendingAvailableTask() {
+  PendingTask task;
+  task.type = PEDNING_PRINTERS_AVAILABLE;
+  AddPendingTask(task);
+}
+
+void CloudPrintConnector::AddPendingDeleteTask(const std::string& id) {
+  PendingTask task;
+  task.type = PEDNING_PRINTER_DELETE;
+  task.printer_id = id;
+  AddPendingTask(task);
+}
+
+void CloudPrintConnector::AddPendingRegisterTask(
+    const printing::PrinterBasicInfo& info) {
+  PendingTask task;
+  task.type = PEDNING_PRINTER_REGISTER;
+  task.printer_info = info;
+  AddPendingTask(task);
+}
+
+void CloudPrintConnector::AddPendingTask(const PendingTask& task) {
+  pedning_tasks_.push_back(task);
+  // If this is the only pending task, we need to start the process.
+  if (pedning_tasks_.size() == 1) {
+    MessageLoop::current()->PostTask(
+        FROM_HERE, NewRunnableMethod(
+            this, &CloudPrintConnector::ProcessPendingTask));
+  }
+}
+
+void CloudPrintConnector::ProcessPendingTask() {
+  if (!IsRunning())
+    return;  // Orphant call.
+  if (pedning_tasks_.size() == 0)
+    return;  // No peding tasks.
+
+  PendingTask task = pedning_tasks_.front();
+
+  switch (task.type) {
+    case PEDNING_PRINTERS_AVAILABLE :
+      OnPrintersAvailable();
+      break;
+    case PEDNING_PRINTER_REGISTER :
+      OnPrinterRegister(task.printer_info);
+      break;
+    case PEDNING_PRINTER_DELETE :
+      OnPrinterDelete(task.printer_id);
+      break;
+    default:
+      NOTREACHED();
+  }
+}
+
+void CloudPrintConnector::OnPrintersAvailable() {
+  GURL printer_list_url =
+      CloudPrintHelpers::GetUrlForPrinterList(cloud_print_server_url_,
+                                              proxy_id_);
+  StartGetRequest(printer_list_url,
+                  kCloudPrintRegisterMaxRetryCount,
+                  &CloudPrintConnector::HandlePrinterListResponse);
+}
+
+void CloudPrintConnector::OnPrinterRegister(
+    const printing::PrinterBasicInfo& info) {
+  for (JobHandlerMap::iterator it = job_handler_map_.begin();
+       it != job_handler_map_.end(); ++it) {
+    if (IsSamePrinter(it->second->GetPrinterName(), info.printer_name)) {
+      // Printer already registered, continue to the next task.
+      ContinuePendingTaskProcessing();
+      return;
+    }
+  }
+
+  cloud_print::PrintSystem::PrinterCapsAndDefaultsCallback* callback =
+       NewCallback(this, &CloudPrintConnector::OnReceivePrinterCaps);
+  // Asnchronously fetch the printer caps and defaults. The story will
+  // continue in OnReceivePrinterCaps.
+  print_system_->GetPrinterCapsAndDefaults(
+      info.printer_name.c_str(), callback);
+}
+
+void CloudPrintConnector::OnPrinterDelete(const std::string& printer_id) {
+  // Remove corresponding printer job handler.
+  JobHandlerMap::iterator it = job_handler_map_.find(printer_id);
+  if (it != job_handler_map_.end()) {
+    it->second->Shutdown();
+    job_handler_map_.erase(it);
+  }
+
+  // TODO(gene): We probably should not try indefinitely here. Just once or

[Albert Bodenhamer, 2011/10/26 23:58:09]

Consider attaching a bug to a TODO.

+  // twice should be enough.
+  GURL url = CloudPrintHelpers::GetUrlForPrinterDelete(cloud_print_server_url_,
+                                                       printer_id);
+  StartGetRequest(url,
+                  kCloudPrintAPIMaxRetryCount,
+                  &CloudPrintConnector::HandlePrinterDeleteResponse);
+}
+
+void CloudPrintConnector::ContinuePendingTaskProcessing() {
+  if (pedning_tasks_.size() == 0)
+    return;  // No peding tasks.
+
+  // Delete current task and repost if we have more task avaialble.
+  pedning_tasks_.pop_front();
+  if (pedning_tasks_.size() != 0) {
+    MessageLoop::current()->PostTask(
+        FROM_HERE, NewRunnableMethod(
+            this, &CloudPrintConnector::ProcessPendingTask));
+  }
+}
+
+void CloudPrintConnector::OnReceivePrinterCaps(
+    bool succeeded,
+    const std::string& printer_name,
+    const printing::PrinterCapsAndDefaults& caps_and_defaults) {
+  if (!IsRunning())
+    return;  // Orphant call.
+  DCHECK(pedning_tasks_.size() > 0 &&
+         pedning_tasks_.front().type == PEDNING_PRINTER_REGISTER);
+
+  if (!succeeded) {
+    LOG(ERROR) << "CP_PROXY: Failed to get printer info for: " <<
+        printer_name;
+    // This printer failed to register, notify the server of this failure.
+    string16 printer_name_utf16 = UTF8ToUTF16(printer_name);
+    std::string status_message = l10n_util::GetStringFUTF8(
+        IDS_CLOUD_PRINT_REGISTER_PRINTER_FAILED,
+        printer_name_utf16);
+    ReportUserMessage(kGetPrinterCapsFailedMessageId, status_message);
+
+    ContinuePendingTaskProcessing();  // Skip this printer registration.
+    return;
+  }
+
+  const printing::PrinterBasicInfo& info = pedning_tasks_.front().printer_info;
+  DCHECK(IsSamePrinter(info.printer_name, printer_name));
+
+  std::string mime_boundary;
+  CloudPrintHelpers::CreateMimeBoundaryForUpload(&mime_boundary);
+  std::string post_data;
+
+  CloudPrintHelpers::AddMultipartValueForUpload(kProxyIdValue, proxy_id_,
+                                                mime_boundary,
+                                                std::string(), &post_data);
+  CloudPrintHelpers::AddMultipartValueForUpload(kPrinterNameValue,
+                                                info.printer_name,
+                                                mime_boundary,
+                                                std::string(), &post_data);
+  CloudPrintHelpers::AddMultipartValueForUpload(kPrinterDescValue,
+                                                info.printer_description,
+                                                mime_boundary,
+                                                std::string() , &post_data);
+  CloudPrintHelpers::AddMultipartValueForUpload(
+      kPrinterStatusValue, base::StringPrintf("%d", info.printer_status),
+      mime_boundary, std::string(), &post_data);
+  // Add printer options as tags.
+  CloudPrintHelpers::GenerateMultipartPostDataForPrinterTags(info.options,
+                                                             mime_boundary,
+                                                             &post_data);
+
+  CloudPrintHelpers::AddMultipartValueForUpload(
+      kPrinterCapsValue, caps_and_defaults.printer_capabilities,
+      mime_boundary, caps_and_defaults.caps_mime_type,
+      &post_data);
+  CloudPrintHelpers::AddMultipartValueForUpload(
+      kPrinterDefaultsValue, caps_and_defaults.printer_defaults,
+      mime_boundary, caps_and_defaults.defaults_mime_type,
+      &post_data);
+  // Send a hash of the printer capabilities to the server. We will use this
+  // later to check if the capabilities have changed
+  CloudPrintHelpers::AddMultipartValueForUpload(
+      kPrinterCapsHashValue,
+      base::MD5String(caps_and_defaults.printer_capabilities),
+      mime_boundary, std::string(), &post_data);
+
+  // Terminate the request body
+  post_data.append("--" + mime_boundary + "--\r\n");
+  std::string mime_type("multipart/form-data; boundary=");
+  mime_type += mime_boundary;
+
+  GURL post_url = CloudPrintHelpers::GetUrlForPrinterRegistration(
+      cloud_print_server_url_);
+  StartPostRequest(post_url,
+                   kCloudPrintAPIMaxRetryCount,
+                   mime_type,
+                   post_data,
+                   &CloudPrintConnector::HandleRegisterPrinterResponse);
+}
+
+bool CloudPrintConnector::IsSamePrinter(const std::string& name1,
+                                        const std::string& name2) const {
+  return (0 == base::strcasecmp(name1.c_str(), name2.c_str()));
+}
+