chrome/browser/chromeos/dbus/printer_service_provider.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_CHROMEOS_DBUS_PRINTER_SERVICE_PROVIDER_H_
   6 #define CHROME_BROWSER_CHROMEOS_DBUS_PRINTER_SERVICE_PROVIDER_H_
   7
   8 #include <string>
   9
  10 #include "base/memory/weak_ptr.h"
  11 #include "chromeos/dbus/services/cros_dbus_service.h"
  12 #include "dbus/exported_object.h"
  13
  14 class NotificationUIManager;
  15
  16 namespace dbus {
  17 class MethodCall;
  18 class Response;
  19 }
  20
  21 namespace chromeos {
  22
  23 // This class provides printer service for CrosDBusService.
  24 // It detects attached printers and show user help page.
  25 //
  26 // The following methods are exported.
  27 //
  28 // Interface: org.chromium.LibCrosServiceInterface (kLibCrosServiceInterface)
  29 // Method: PrinterAdded (kPrinterAdded)
  30 // Parameters: string:vendor Optional, USB vendor ID.
  31 //             string:product Optional, USB product ID.
  32 //
  33 //   Display help page to advice user to use Cloud Print.
  34 //
  35 //   The returned signal will contain the three values:
  36 //
  37 // This service can be manually tested dbus-send on ChromeOS.
  38 //
  39 // 1. Open a terminal and run the following:
  40 //
  41 //   % dbus-send --system --type=method_call
  42 //       --dest=org.chromium.LibCrosService /org/chromium/LibCrosService
  43 //       org.chromium.LibCrosServiceInterface.PrinterAdded
  44 //       string:123 string:456
  45 //
  46 // 2. Go back to ChromeOS and check if new tab with information is opened.
  47
  48 class PrinterServiceProvider
  49     : public CrosDBusService::ServiceProviderInterface {
  50  public:
  51   PrinterServiceProvider();
  52   ~PrinterServiceProvider() override;
  53
  54   // CrosDBusService::ServiceProviderInterface override.
  55   void Start(scoped_refptr<dbus::ExportedObject> exported_object) override;
  56
  57  protected:
  58   virtual void ShowCloudPrintHelp(const std::string& vendor,
  59                                   const std::string& product);
  60
  61  private:
  62   friend class PrinterServiceProviderAppSearchEnabledTest;
  63
  64   void SetNotificationUIManagerForTesting(NotificationUIManager* manager);
  65
  66   // Called from ExportedObject, when PrinterAdded() is exported as
  67   // a D-Bus method, or failed to be exported.
  68   void OnExported(const std::string& interface_name,
  69                   const std::string& method_name,
  70                   bool success);
  71
  72   // Invoked when usb printer is detected.
  73   // Called on UI thread from dbus request.
  74   void PrinterAdded(dbus::MethodCall* method_call,
  75                     dbus::ExportedObject::ResponseSender response_sender);
  76
  77   NotificationUIManager* notification_ui_manager_;
  78
  79   scoped_refptr<dbus::ExportedObject> exported_object_;
  80   base::WeakPtrFactory<PrinterServiceProvider> weak_ptr_factory_;
  81
  82   DISALLOW_COPY_AND_ASSIGN(PrinterServiceProvider);
  83 };
  84
  85 }  // namespace chromeos
  86
  87 #endif  // CHROME_BROWSER_CHROMEOS_DBUS_PRINTER_SERVICE_PROVIDER_H_
  88