1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_ASH_PRINTING_PRINTER_CONFIGURER_H_
#define CHROME_BROWSER_ASH_PRINTING_PRINTER_CONFIGURER_H_
#include <memory>
#include <string>
#include "base/functional/callback_forward.h"
#include "base/memory/scoped_refptr.h"
#include "url/gurl.h"
namespace chromeos {
class PpdProvider;
class Printer;
}
namespace ash {
class DlcserviceClient;
// These values are written to logs. New enum values can be added, but existing
// enums must never be renumbered or deleted and reused.
enum class PrinterSetupResult {
kFatalError = 0, // Setup failed in an unrecognized way
kSuccess = 1, // Printer set up successfully
kPrinterUnreachable = 2, // Could not reach printer
kDbusError = 3, // Could not contact debugd
kNativePrintersNotAllowed = 4, // Tried adding/editing printers policy set
kInvalidPrinterUpdate = 5, // Tried updating printer with invalid values
kComponentUnavailable = 6, // Could not install component
kEditSuccess = 7, // Printer edited successfully
kPrinterSentWrongResponse = 8, // Printer sent unexpected response
kPrinterIsNotAutoconfigurable = 9, // Printer requires PPD
// PPD errors
kPpdTooLarge = 10, // PPD exceeds size limit
kInvalidPpd = 11, // PPD rejected by cupstestppd
kPpdNotFound = 12, // Could not find PPD
kPpdUnretrievable = 13, // Could not download PPD
// Other errors
kIoError = 14, // I/O error in CUPS
kMemoryAllocationError = 15, // Memory allocation error in Cups
kBadUri = 16, // Printer's URI is incorrect
kManualSetupRequired = 17, // Printer requires manual setup
// Space left for additional errors
// Specific DBus errors. This must stay in sync with the DBusLibraryError
// enum and PrinterSetupResultFromDbusErrorCode().
kDbusNoReply = 64, // Deprecated
kDbusTimeout = 65, // Generic timeout error (c.f. dbus-protocol.h)
// Printer was removed before the setup was completed (setup cancelled)
kPrinterRemoved = 66,
kPrintscanmgrDbusNoReply = 67, // No reply from printscanmgr over D-Bus.
kDebugdDbusNoReply = 68, // No reply from debugd over D-Bus.
kMaxValue = kDebugdDbusNoReply // Maximum value for histograms
};
// These values are written to logs. New enum values can be added, but existing
// enums must never be renumbered or deleted and reused.
// Records the source of a successful USB printer setup.
enum class UsbPrinterSetupSource {
kSettings = 0, // USB printer installed via Settings.
kPrintPreview = 1, // USB printer installed via Print Preview.
kAutoconfigured = 2, // USB printer installed automatically.
kMaxValue = kAutoconfigured,
};
using PrinterSetupCallback = base::OnceCallback<void(PrinterSetupResult)>;
// Configures printers by retrieving PPDs and registering the printer with CUPS.
// Class must be constructed and used on the UI thread.
class PrinterConfigurer {
public:
static std::unique_ptr<PrinterConfigurer> Create(
scoped_refptr<chromeos::PpdProvider> ppd_provider,
DlcserviceClient* dlc_service_client);
PrinterConfigurer(const PrinterConfigurer&) = delete;
PrinterConfigurer& operator=(const PrinterConfigurer&) = delete;
virtual ~PrinterConfigurer() = default;
// Set up |printer| retrieving the appropriate PPD and registering the printer
// with CUPS. |callback| is called with the result of the operation. This
// method must be called on the UI thread and will run |callback| on the
// UI thread. Do not use this method directly, use `SetUpPrinter` from
// `CupsPrintersManager` instead. Keep in mind that this method install a new
// printer in the CUPS daemon and `CupsPrintersManager` must track all
// printers installed in CUPS daemon. Calling this method directly will cause
// `CupsPrintersManager` to have a different list of installed printers than
// the CUPS daemon, which is the source of strange bugs and flaky tests.
virtual void SetUpPrinterInCups(const chromeos::Printer& printer,
PrinterSetupCallback callback) = 0;
// Return an opaque fingerprint of the fields used to set up a printer with
// CUPS. The idea here is that if this fingerprint changes for a printer, we
// need to reconfigure CUPS. This fingerprint is not guaranteed to be stable
// across reboots.
static std::string SetupFingerprint(const chromeos::Printer& printer);
// Records UMA metrics for USB printer setup.
static void RecordUsbPrinterSetupSource(UsbPrinterSetupSource source);
// Returns a generated EULA GURL for the provided |license|. |license| is the
// identifier tag of the printer's license information.
static GURL GeneratePrinterEulaUrl(const std::string& license);
protected:
PrinterConfigurer() = default;
};
// Return a message for |result| that can be used in device-log.
std::string ResultCodeToMessage(const PrinterSetupResult result);
} // namespace ash
#endif // CHROME_BROWSER_ASH_PRINTING_PRINTER_CONFIGURER_H_
|
