Move common cloud print methods from service/cloud_print to common/cloud_print.

chrome/service/cloud_print/cloud_print_connector.cc

 // 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.
 
 #include "chrome/service/cloud_print/cloud_print_connector.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.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/common/cloud_print/cloud_print_constants.h"
 #include "chrome/common/cloud_print/cloud_print_helpers.h"
 #include "chrome/service/cloud_print/cloud_print_consts.h"

[msw, 2012/11/17 00:22:30]

Please remove if now unused.

[Chen Yu, 2012/11/26 12:07:06]

Done.

 #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 ConnectorSettings& settings)
   : client_(client),
     next_response_handler_(NULL) {
   settings_.CopyFrom(settings);
 }
 
 bool CloudPrintConnector::InitPrintSystem() {
   if (print_system_.get())
     return true;
   print_system_ = cloud_print::PrintSystem::CreateInstance(
       settings_.print_system_settings());
   if (!print_system_.get()) {
     NOTREACHED();
     return false;  // No memory.
   }
   cloud_print::PrintSystem::PrintSystemResult result = print_system_->Init();
   if (!result.succeeded()) {
     print_system_ = NULL;
     // We could not initialize the print system. We need to notify the server.
-    ReportUserMessage(kPrintSystemFailedMessageId, result.message());
+    ReportUserMessage(cloud_print::kPrintSystemFailedMessageId,

[msw, 2012/11/17 00:22:30]

nit: consider putting this file's contents in the cloud_print namespace and
removing the specifiers.

[Chen Yu, 2012/11/26 12:07:06]

Done.

+                      result.message());
     return false;
   }
   return true;
 }
 
 bool CloudPrintConnector::Start() {
   VLOG(1) << "CP_CONNECTOR: Starting connector"
           << ", proxy id: " << settings_.proxy_id();
 
   pending_tasks_.clear();
@@ skipping 51 matching lines @@
     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 {
       std::string status_message = l10n_util::GetStringUTF8(
           IDS_CLOUD_PRINT_ZOMBIE_PRINTER);
       LOG(ERROR) << "CP_CONNECTOR: " << status_message <<
           " Printer_id: " << printer_id;
-      ReportUserMessage(kZombiePrinterMessageId, status_message);
+      ReportUserMessage(cloud_print::kZombiePrinterMessageId, status_message);
     }
   } else {
     for (JobHandlerMap::iterator index = job_handler_map_.begin();
          index != job_handler_map_.end(); index++) {
       index->second->CheckForJobs(reason);
     }
   }
 }
 
 void CloudPrintConnector::OnPrinterAdded() {
@@ skipping 64 matching lines @@
   printing::PrinterList local_printers;
   cloud_print::PrintSystem::PrintSystemResult result =
       print_system_->EnumeratePrinters(&local_printers);
   bool full_list = result.succeeded();
   if (!full_list) {
     std::string message = result.message();
     if (message.empty())
       message = l10n_util::GetStringFUTF8(IDS_CLOUD_PRINT_ENUM_FAILED,
           l10n_util::GetStringUTF16(IDS_GOOGLE_CLOUD_PRINT));
     // There was a failure enumerating printers. Send a message to the server.
-    ReportUserMessage(kEnumPrintersFailedMessageId, message);
+    ReportUserMessage(cloud_print::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(cloud_print::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);
+        printer_data->GetString(cloud_print::kNameValue, &printer_name);
         std::string printer_id;
-        printer_data->GetString(kIdValue, &printer_id);
+        printer_data->GetString(cloud_print::kIdValue, &printer_id);
         if (settings_.IsPrinterBlacklisted(printer_name)) {
           VLOG(1) << "CP_CONNECTOR: Deleting " << printer_name <<
               " id: " << printer_id << " as blacklisted";
           AddPendingDeleteTask(printer_id);
         } else if (RemovePrinterFromList(printer_name, &local_printers)) {
           InitJobHandlerForPrinter(printer_data);
         } else {
           // Cloud printer is not found on the local system.
           if (full_list || settings_.delete_on_enum_fail()) {
             // Delete if we get the full list of printers or
@@ skipping 78 matching lines @@
   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;
   cloud_print::CreateMimeBoundaryForUpload(&mime_boundary);
-  GURL url = CloudPrintHelpers::GetUrlForUserMessage(settings_.server_url(),
-                                                     message_id);
+  GURL url = cloud_print::GetUrlForUserMessage(settings_.server_url(),
+                                               message_id);
   std::string post_data;
-  cloud_print::AddMultipartValueForUpload(kMessageTextValue, failure_msg,
-      mime_boundary, std::string(), &post_data);
+  cloud_print::AddMultipartValueForUpload(cloud_print::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);
+  printer_data->GetString(cloud_print::kIdValue,
+                          &printer_info_cloud.printer_id);
   DCHECK(!printer_info_cloud.printer_id.empty());
   VLOG(1) << "CP_CONNECTOR: Init job handler"
           << ", 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);
+  printer_data->GetString(cloud_print::kNameValue, &printer_info.printer_name);
   DCHECK(!printer_info.printer_name.empty());
-  printer_data->GetString(kPrinterDescValue,
+  printer_data->GetString(cloud_print::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)) {
+  if (printer_data->GetString(
+      cloud_print::kPrinterStatusValue, &printer_status)) {
     base::StringToInt(printer_status, &printer_info.printer_status);
   }
-  printer_data->GetString(kPrinterCapsHashValue,
+  printer_data->GetString(cloud_print::kPrinterCapsHashValue,
       &printer_info_cloud.caps_hash);
   ListValue* tags_list = NULL;
-  if (printer_data->GetList(kTagsValue, &tags_list) && tags_list) {
+  if (printer_data->GetList(cloud_print::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];
       }
@@ skipping 68 matching lines @@
 
   // Delete current task and repost if we have more task available.
   pending_tasks_.pop_front();
   if (pending_tasks_.size() != 0) {
     MessageLoop::current()->PostTask(
         FROM_HERE, base::Bind(&CloudPrintConnector::ProcessPendingTask, this));
   }
 }
 
 void CloudPrintConnector::OnPrintersAvailable() {
-  GURL printer_list_url = CloudPrintHelpers::GetUrlForPrinterList(
+  GURL printer_list_url = cloud_print::GetUrlForPrinterList(
       settings_.server_url(), settings_.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) {
@@ skipping 16 matching lines @@
   // 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
   // twice should be enough.
   // Bug: http://code.google.com/p/chromium/issues/detail?id=101850
-  GURL url = CloudPrintHelpers::GetUrlForPrinterDelete(
+  GURL url = cloud_print::GetUrlForPrinterDelete(
       settings_.server_url(), printer_id, "printer_deleted");
   StartGetRequest(url,
                   kCloudPrintAPIMaxRetryCount,
                   &CloudPrintConnector::HandlePrinterDeleteResponse);
 }
 
 void CloudPrintConnector::OnReceivePrinterCaps(
     bool succeeded,
     const std::string& printer_name,
     const printing::PrinterCapsAndDefaults& caps_and_defaults) {
   if (!IsRunning())
     return;  // Orphant call.
   DCHECK(pending_tasks_.size() > 0 &&
          pending_tasks_.front().type == PENDING_PRINTER_REGISTER);
 
   if (!succeeded) {
     LOG(ERROR) << "CP_CONNECTOR: Failed to get printer info"
                << ", printer name: " << 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,
         l10n_util::GetStringUTF16(IDS_GOOGLE_CLOUD_PRINT));
-    ReportUserMessage(kGetPrinterCapsFailedMessageId, status_message);
+    ReportUserMessage(cloud_print::kGetPrinterCapsFailedMessageId,
+                      status_message);
 
     ContinuePendingTaskProcessing();  // Skip this printer registration.
     return;
   }
 
   const printing::PrinterBasicInfo& info = pending_tasks_.front().printer_info;
   DCHECK(IsSamePrinter(info.printer_name, printer_name));
 
   std::string mime_boundary;
   cloud_print::CreateMimeBoundaryForUpload(&mime_boundary);
   std::string post_data;
 
-  cloud_print::AddMultipartValueForUpload(kProxyIdValue, settings_.proxy_id(),
-      mime_boundary, std::string(), &post_data);
-  cloud_print::AddMultipartValueForUpload(kPrinterNameValue, info.printer_name,
-      mime_boundary, std::string(), &post_data);
-  cloud_print::AddMultipartValueForUpload(kPrinterDescValue,
-      info.printer_description, mime_boundary, std::string() , &post_data);
-  cloud_print::AddMultipartValueForUpload(kPrinterStatusValue,
+  cloud_print::AddMultipartValueForUpload(cloud_print::kProxyIdValue,
+      settings_.proxy_id(), mime_boundary, std::string(), &post_data);
+  cloud_print::AddMultipartValueForUpload(cloud_print::kPrinterNameValue,
+      info.printer_name, mime_boundary, std::string(), &post_data);
+  cloud_print::AddMultipartValueForUpload(cloud_print::kPrinterDescValue,
+      info.printer_description, mime_boundary, std::string(), &post_data);
+  cloud_print::AddMultipartValueForUpload(cloud_print::kPrinterStatusValue,
       base::StringPrintf("%d", info.printer_status),
       mime_boundary, std::string(), &post_data);
   post_data += CloudPrintHelpers::GetPostDataForPrinterTags(info,
                                                             mime_boundary);
-  cloud_print::AddMultipartValueForUpload(kPrinterCapsValue,
+  cloud_print::AddMultipartValueForUpload(cloud_print::kPrinterCapsValue,
       caps_and_defaults.printer_capabilities, mime_boundary,
       caps_and_defaults.caps_mime_type, &post_data);
-  cloud_print::AddMultipartValueForUpload(kPrinterDefaultsValue,
+  cloud_print::AddMultipartValueForUpload(cloud_print::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
-  cloud_print::AddMultipartValueForUpload(kPrinterCapsHashValue,
+  cloud_print::AddMultipartValueForUpload(cloud_print::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(
+  GURL post_url = cloud_print::GetUrlForPrinterRegistration(
       settings_.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()));
 }