Add onGetUsbPrinterInfoRequested event to printerProvider API.

extensions/browser/api/printer_provider/printer_provider_api.cc

 // Copyright 2015 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 "extensions/browser/api/printer_provider/printer_provider_api.h"
 
 #include <map>
 #include <set>
 #include <utility>
 #include <vector>
 
 #include "base/bind.h"
 #include "base/i18n/rtl.h"
 #include "base/json/json_string_value_serializer.h"
 #include "base/macros.h"
-#include "base/memory/ref_counted_memory.h"
 #include "base/scoped_observer.h"
 #include "base/strings/string16.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/values.h"
+#include "device/usb/usb_device.h"
 #include "extensions/browser/api/printer_provider/printer_provider_print_job.h"
 #include "extensions/browser/api/printer_provider_internal/printer_provider_internal_api.h"
 #include "extensions/browser/api/printer_provider_internal/printer_provider_internal_api_observer.h"
 #include "extensions/browser/event_router.h"
 #include "extensions/browser/extension_registry.h"
 #include "extensions/browser/extension_registry_observer.h"
 #include "extensions/common/api/printer_provider.h"
 #include "extensions/common/api/printer_provider_internal.h"
+#include "extensions/common/api/usb.h"
 #include "extensions/common/extension.h"
 
+using device::UsbDevice;
+
 namespace extensions {
 
 namespace {
 
 // The separator between extension id and the extension's internal printer id
 // used when generating a printer id unique across extensions.
 const char kPrinterIdSeparator = ':';
 
 // Given an extension ID and an ID of a printer reported by the extension, it
 // generates a ID for the printer unique across extensions (assuming that the
@@ skipping 13 matching lines @@
                     std::string* extension_id,
                     std::string* internal_printer_id) {
   size_t separator = printer_id.find_first_of(kPrinterIdSeparator);
   if (separator == std::string::npos)
     return false;
   *extension_id = printer_id.substr(0, separator);
   *internal_printer_id = printer_id.substr(separator + 1);
   return true;
 }
 
+void UpdatePrinterWithExtensionInfo(base::DictionaryValue* printer,
+                                    const Extension* extension) {
+  std::string internal_printer_id;
+  CHECK(printer->GetString("id", &internal_printer_id));
+  printer->SetString("id",
+                     GeneratePrinterId(extension->id(), internal_printer_id));
+  printer->SetString("extensionId", extension->id());
+  printer->SetString("extensionName", extension->name());
+
+  base::string16 printer_name;
+  if (printer->GetString("name", &printer_name) &&
+      base::i18n::AdjustStringForLocaleDirection(&printer_name)) {
+    printer->SetString("name", printer_name);
+  }
+
+  base::string16 printer_description;
+  if (printer->GetString("description", &printer_description) &&
+      base::i18n::AdjustStringForLocaleDirection(&printer_description)) {
+    printer->SetString("description", printer_description);
+  }
+}
+
 // Holds information about a pending onGetPrintersRequested request;
 // in particular, the list of extensions to which the event was dispatched but
 // which haven't yet responded, and the |GetPrinters| callback associated with
 // the event.
 class GetPrintersRequest {
  public:
   explicit GetPrintersRequest(
       const PrinterProviderAPI::GetPrintersCallback& callback);
   ~GetPrintersRequest();
 
@@ skipping 33 matching lines @@
   // values reported by the extension.
   bool CompleteForExtension(const std::string& extension_id,
                             int request_id,
                             const base::ListValue& result);
 
   // Runs callbacks for the extension for all requests that are waiting for a
   // response from the extension with the provided extension id. Callbacks are
   // called as if the extension reported empty set of printers.
   void FailAllForExtension(const std::string& extension_id);
 
-  // Adds an extension id to the list of the extensions that need to respond
-  // to the event.
+  // Adds an extension id to the list of the extensions that need to respond to
+  // the event.
   bool AddSource(int request_id, const std::string& extension_id);
 
  private:
   int last_request_id_;
   std::map<int, GetPrintersRequest> pending_requests_;
 
   DISALLOW_COPY_AND_ASSIGN(PendingGetPrintersRequests);
 };
 
 // Keeps track of pending chrome.printerProvider.onGetCapabilityRequested
@@ skipping 13 matching lines @@
 
   // Runs all pending callbacks with empty capability value and clears the
   // set of pending requests.
   void FailAll();
 
  private:
   int last_request_id_;
   std::map<int, PrinterProviderAPI::GetCapabilityCallback> pending_requests_;
 };
 
-// Keeps track of pending chrome.printerProvider.ontPrintRequested requests
+// Keeps track of pending chrome.printerProvider.onPrintRequested requests
 // for an extension.
 class PendingPrintRequests {
  public:
   PendingPrintRequests();
   ~PendingPrintRequests();
 
   // Adds a new request to the set. Only information needed is the callback
   // associated with the request. Returns the id assigned to the request.
   int Add(const PrinterProviderPrintJob& job,
           const PrinterProviderAPI::PrintCallback& callback);
@@ skipping 12 matching lines @@
  private:
   struct PrintRequest {
     PrinterProviderAPI::PrintCallback callback;
     PrinterProviderPrintJob job;
   };
 
   int last_request_id_;
   std::map<int, PrintRequest> pending_requests_;
 };
 
+// Keeps track of pending chrome.printerProvider.onGetUsbPrinterInfoRequested
+// requests for an extension.
+class PendingUsbPrinterInfoRequests {
+ public:
+  PendingUsbPrinterInfoRequests();
+  ~PendingUsbPrinterInfoRequests();
+
+  // Adds a new request to the set. Only information needed is the callback
+  // associated with the request. Returns the id assigned to the request.
+  int Add(const PrinterProviderAPI::GetPrinterInfoCallback& callback);
+
+  // Completes the request with the provided request id. It runs the request
+  // callback and removes the request from the set.
+  void Complete(int request_id, const base::DictionaryValue& printer_info);
+
+  // Runs all pending callbacks with empty capability value and clears the
+  // set of pending requests.
+  void FailAll();
+
+ private:
+  int last_request_id_ = 0;
+  std::map<int, PrinterProviderAPI::GetPrinterInfoCallback> pending_requests_;
+};
+
 // Implements chrome.printerProvider API events.
 class PrinterProviderAPIImpl : public PrinterProviderAPI,
                                public PrinterProviderInternalAPIObserver,
                                public ExtensionRegistryObserver {
  public:
   explicit PrinterProviderAPIImpl(content::BrowserContext* browser_context);
   ~PrinterProviderAPIImpl() override;
 
  private:
   // PrinterProviderAPI implementation:
   void DispatchGetPrintersRequested(
       const PrinterProviderAPI::GetPrintersCallback& callback) override;
   void DispatchGetCapabilityRequested(
       const std::string& printer_id,
       const PrinterProviderAPI::GetCapabilityCallback& callback) override;
   void DispatchPrintRequested(
       const PrinterProviderPrintJob& job,
       const PrinterProviderAPI::PrintCallback& callback) override;
   const PrinterProviderPrintJob* GetPrintJob(const Extension* extension,
                                              int request_id) const override;
+  void DispatchGetUsbPrinterInfoRequested(
+      const std::string& extension_id,
+      scoped_refptr<UsbDevice> device,
+      const PrinterProviderAPI::GetPrinterInfoCallback& callback) override;
 
   // PrinterProviderInternalAPIObserver implementation:
   void OnGetPrintersResult(
       const Extension* extension,
       int request_id,
       const PrinterProviderInternalAPIObserver::PrinterInfoVector& result)
       override;
   void OnGetCapabilityResult(const Extension* extension,
                              int request_id,
                              const base::DictionaryValue& result) override;
   void OnPrintResult(
       const Extension* extension,
       int request_id,
       core_api::printer_provider_internal::PrintError error) override;
+  void OnGetUsbPrinterInfoResult(
+      const Extension* extension,
+      int request_id,
+      const core_api::printer_provider::PrinterInfo* printer_info) override;
 
   // ExtensionRegistryObserver implementation:
   void OnExtensionUnloaded(content::BrowserContext* browser_context,
                            const Extension* extension,
                            UnloadedExtensionInfo::Reason reason) override;
 
   // Called before chrome.printerProvider.onGetPrintersRequested event is
   // dispatched to an extension. It returns whether the extension is interested
   // in the event. If the extension listens to the event, it's added to the set
   // of |request| sources. |request| is |GetPrintersRequest| object associated
   // with the event.
   bool WillRequestPrinters(int request_id,
                            content::BrowserContext* browser_context,
                            const Extension* extension,
                            base::ListValue* args);
 
   content::BrowserContext* browser_context_;
 
   PendingGetPrintersRequests pending_get_printers_requests_;
 
   std::map<std::string, PendingPrintRequests> pending_print_requests_;
 
   std::map<std::string, PendingGetCapabilityRequests>
       pending_capability_requests_;
 
+  std::map<std::string, PendingUsbPrinterInfoRequests>
+      pending_usb_printer_info_requests_;
+
   ScopedObserver<PrinterProviderInternalAPI, PrinterProviderInternalAPIObserver>
       internal_api_observer_;
 
   ScopedObserver<ExtensionRegistry, ExtensionRegistryObserver>
       extension_registry_observer_;
 
   DISALLOW_COPY_AND_ASSIGN(PrinterProviderAPIImpl);
 };
 
 GetPrintersRequest::GetPrintersRequest(
@@ skipping 140 matching lines @@
   return &it->second.job;
 }
 
 void PendingPrintRequests::FailAll() {
   for (auto& request : pending_requests_)
     request.second.callback.Run(false,
                                 PrinterProviderAPI::GetDefaultPrintError());
   pending_requests_.clear();
 }
 
+PendingUsbPrinterInfoRequests::PendingUsbPrinterInfoRequests() {
+}
+
+PendingUsbPrinterInfoRequests::~PendingUsbPrinterInfoRequests() {
+}
+
+int PendingUsbPrinterInfoRequests::Add(
+    const PrinterProviderAPI::GetPrinterInfoCallback& callback) {
+  pending_requests_[++last_request_id_] = callback;
+  return last_request_id_;
+}
+
+void PendingUsbPrinterInfoRequests::Complete(
+    int request_id,
+    const base::DictionaryValue& printer_info) {
+  auto it = pending_requests_.find(request_id);
+  if (it == pending_requests_.end())
+    return;
+
+  PrinterProviderAPI::GetPrinterInfoCallback callback = it->second;
+  pending_requests_.erase(it);
+
+  callback.Run(printer_info);
+}
+
+void PendingUsbPrinterInfoRequests::FailAll() {
+  for (auto& request : pending_requests_) {
+    request.second.Run(base::DictionaryValue());
+  }
+  pending_requests_.clear();
+}
+
 PrinterProviderAPIImpl::PrinterProviderAPIImpl(
     content::BrowserContext* browser_context)
     : browser_context_(browser_context),
       internal_api_observer_(this),
       extension_registry_observer_(this) {
   internal_api_observer_.Add(
       PrinterProviderInternalAPI::GetFactoryInstance()->Get(browser_context));
   extension_registry_observer_.Add(ExtensionRegistry::Get(browser_context));
 }
 
@@ skipping 113 matching lines @@
 
 const PrinterProviderPrintJob* PrinterProviderAPIImpl::GetPrintJob(
     const Extension* extension,
     int request_id) const {
   auto it = pending_print_requests_.find(extension->id());
   if (it == pending_print_requests_.end())
     return nullptr;
   return it->second.GetPrintJob(request_id);
 }
 
+void PrinterProviderAPIImpl::DispatchGetUsbPrinterInfoRequested(
+    const std::string& extension_id,
+    scoped_refptr<UsbDevice> device,
+    const PrinterProviderAPI::GetPrinterInfoCallback& callback) {
+  EventRouter* event_router = EventRouter::Get(browser_context_);
+  if (!event_router->ExtensionHasEventListener(
+          extension_id, core_api::printer_provider::
+                            OnGetUsbPrinterInfoRequested::kEventName)) {
+    callback.Run(base::DictionaryValue());
+    return;
+  }
+
+  int request_id =
+      pending_usb_printer_info_requests_[extension_id].Add(callback);
+  core_api::usb::Device usb_device;
+  usb_device.device = device->unique_id();
+  usb_device.vendor_id = device->vendor_id();
+  usb_device.product_id = device->product_id();
+
+  scoped_ptr<base::ListValue> internal_args(new base::ListValue);
+  // Request id is not part of the public API and it will be massaged out in
+  // custom bindings.
+  internal_args->AppendInteger(request_id);
+  internal_args->Append(usb_device.ToValue().release());
+  scoped_ptr<Event> event(new Event(
+      core_api::printer_provider::OnGetUsbPrinterInfoRequested::kEventName,
+      internal_args.Pass()));
+  event_router->DispatchEventToExtension(extension_id, event.Pass());
+}
+
 void PrinterProviderAPIImpl::OnGetPrintersResult(
     const Extension* extension,
     int request_id,
     const PrinterProviderInternalAPIObserver::PrinterInfoVector& result) {
   base::ListValue printer_list;
 
   // Update some printer description properties to better identify the extension
   // managing the printer.
   for (size_t i = 0; i < result.size(); ++i) {
     scoped_ptr<base::DictionaryValue> printer(result[i]->ToValue());
-    std::string internal_printer_id;
-    CHECK(printer->GetString("id", &internal_printer_id));
-    printer->SetString("id",
-                       GeneratePrinterId(extension->id(), internal_printer_id));
-    printer->SetString("extensionId", extension->id());
-    printer->SetString("extensionName", extension->name());
-
-    base::string16 printer_name;
-    if (printer->GetString("name", &printer_name) &&
-        base::i18n::AdjustStringForLocaleDirection(&printer_name)) {
-      printer->SetString("name", printer_name);
-    }
-
-    base::string16 printer_description;
-    if (printer->GetString("description", &printer_description) &&
-        base::i18n::AdjustStringForLocaleDirection(&printer_description)) {
-      printer->SetString("description", printer_description);
-    }
-
-    printer_list.Append(printer.release());
+    UpdatePrinterWithExtensionInfo(printer.get(), extension);
+    printer_list.Append(printer.Pass());
   }
 
   pending_get_printers_requests_.CompleteForExtension(extension->id(),
                                                       request_id, printer_list);
 }
 
 void PrinterProviderAPIImpl::OnGetCapabilityResult(
     const Extension* extension,
     int request_id,
     const base::DictionaryValue& result) {
   pending_capability_requests_[extension->id()].Complete(request_id, result);
 }
 
 void PrinterProviderAPIImpl::OnPrintResult(
     const Extension* extension,
     int request_id,
     core_api::printer_provider_internal::PrintError error) {
   const std::string error_str =
       error == core_api::printer_provider_internal::PRINT_ERROR_NONE
           ? PrinterProviderAPI::GetDefaultPrintError()
           : core_api::printer_provider_internal::ToString(error);
   pending_print_requests_[extension->id()].Complete(
       request_id, error == core_api::printer_provider_internal::PRINT_ERROR_OK,
       error_str);
 }
 
+void PrinterProviderAPIImpl::OnGetUsbPrinterInfoResult(
+    const Extension* extension,
+    int request_id,
+    const core_api::printer_provider::PrinterInfo* result) {
+  if (result) {
+    scoped_ptr<base::DictionaryValue> printer(result->ToValue());
+    UpdatePrinterWithExtensionInfo(printer.get(), extension);
+    pending_usb_printer_info_requests_[extension->id()].Complete(request_id,
+                                                                 *printer);
+  } else {
+    pending_usb_printer_info_requests_[extension->id()].Complete(
+        request_id, base::DictionaryValue());
+  }
+}
+
 void PrinterProviderAPIImpl::OnExtensionUnloaded(
     content::BrowserContext* browser_context,
     const Extension* extension,
     UnloadedExtensionInfo::Reason reason) {
   pending_get_printers_requests_.FailAllForExtension(extension->id());
 
   auto print_it = pending_print_requests_.find(extension->id());
   if (print_it != pending_print_requests_.end()) {
     print_it->second.FailAll();
     pending_print_requests_.erase(print_it);
   }
 
   auto capability_it = pending_capability_requests_.find(extension->id());
   if (capability_it != pending_capability_requests_.end()) {
     capability_it->second.FailAll();
     pending_capability_requests_.erase(capability_it);
   }
+
+  auto usb_it = pending_usb_printer_info_requests_.find(extension->id());
+  if (usb_it != pending_usb_printer_info_requests_.end()) {
+    usb_it->second.FailAll();
+    pending_usb_printer_info_requests_.erase(usb_it);
+  }
 }
 
 bool PrinterProviderAPIImpl::WillRequestPrinters(
     int request_id,
     content::BrowserContext* browser_context,
     const Extension* extension,
     base::ListValue* args) {
   if (!extension)
     return false;
   EventRouter* event_router = EventRouter::Get(browser_context_);
@@ skipping 14 matching lines @@
   return new PrinterProviderAPIImpl(context);
 }
 
 // static
 std::string PrinterProviderAPI::GetDefaultPrintError() {
   return core_api::printer_provider_internal::ToString(
       core_api::printer_provider_internal::PRINT_ERROR_FAILED);
 }
 
 }  // namespace extensions