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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsPrinterListCUPS.h"
#include "mozilla/IntegerRange.h"
#include "mozilla/Maybe.h"
#include "nsCUPSShim.h"
#include "nsPrinterCUPS.h"
#include "nsString.h"
#include "prenv.h"
// Use a local static to initialize the CUPS shim lazily, when it's needed.
// This is used in order to avoid a global constructor.
static nsCUPSShim& CupsShim() {
static nsCUPSShim sCupsShim;
return sCupsShim;
}
using PrinterInfo = nsPrinterListBase::PrinterInfo;
/**
* Retrieves a human-readable name for the printer from CUPS.
* https://www.cups.org/doc/cupspm.html#basic-destination-information
*/
static void GetDisplayNameForPrinter(const cups_dest_t& aDest,
nsAString& aName) {
// macOS clients expect prettified printer names
// while GTK clients expect non-prettified names.
// If you change this, please change NamedPrinter accordingly.
#ifdef XP_MACOSX
const char* displayName = CupsShim().cupsGetOption(
"printer-info", aDest.num_options, aDest.options);
if (displayName) {
CopyUTF8toUTF16(MakeStringSpan(displayName), aName);
}
#endif
}
NS_IMETHODIMP
nsPrinterListCUPS::InitPrintSettingsFromPrinter(
const nsAString& aPrinterName, nsIPrintSettings* aPrintSettings) {
MOZ_ASSERT(aPrintSettings);
// Set a default file name.
nsAutoString filename;
nsresult rv = aPrintSettings->GetToFileName(filename);
if (NS_FAILED(rv) || filename.IsEmpty()) {
const char* path = PR_GetEnv("PWD");
if (!path) {
path = PR_GetEnv("HOME");
}
if (path) {
CopyUTF8toUTF16(mozilla::MakeStringSpan(path), filename);
filename.AppendLiteral("/mozilla.pdf");
} else {
filename.AssignLiteral("mozilla.pdf");
}
aPrintSettings->SetToFileName(filename);
}
aPrintSettings->SetIsInitializedFromPrinter(true);
return NS_OK;
}
static int CupsDestCallback(void* user_data, unsigned aFlags,
cups_dest_t* aDest) {
MOZ_ASSERT(user_data);
nsTArray<PrinterInfo>* printerInfoList =
reinterpret_cast<nsTArray<PrinterInfo>*>(user_data);
cups_dest_t* ownedDest = nullptr;
mozilla::DebugOnly<const int> numCopied =
CupsShim().cupsCopyDest(aDest, 0, &ownedDest);
MOZ_ASSERT(numCopied == 1);
nsString name;
GetDisplayNameForPrinter(*aDest, name);
printerInfoList->AppendElement(PrinterInfo{std::move(name), ownedDest});
return aFlags == CUPS_DEST_FLAGS_MORE ? 1 : 0;
}
nsTArray<PrinterInfo> nsPrinterListCUPS::Printers() const {
if (!CupsShim().InitOkay()) {
return {};
}
nsTArray<PrinterInfo> printerInfoList;
if (!CupsShim().cupsEnumDests(
CUPS_DEST_FLAGS_NONE,
0 /* timeout, 0 timeout shouldn't be a problem since we are masking
CUPS_PRINTER_DISCOVERED */
,
nullptr /* cancel* */, CUPS_PRINTER_LOCAL,
CUPS_PRINTER_FAX | CUPS_PRINTER_SCANNER | CUPS_PRINTER_DISCOVERED,
&CupsDestCallback, &printerInfoList)) {
return {};
}
return printerInfoList;
}
RefPtr<nsIPrinter> nsPrinterListCUPS::CreatePrinter(PrinterInfo aInfo) const {
return mozilla::MakeRefPtr<nsPrinterCUPS>(
mCommonPaperInfo, CupsShim(), std::move(aInfo.mName),
static_cast<cups_dest_t*>(aInfo.mCupsHandle));
}
mozilla::Maybe<PrinterInfo> nsPrinterListCUPS::PrinterByName(
nsString aPrinterName) const {
mozilla::Maybe<PrinterInfo> rv;
if (!CupsShim().InitOkay()) {
return rv;
}
// Will contain the printer, if found. This must be fully owned, and not a
// member of another array of printers.
cups_dest_t* printer = nullptr;
#ifdef XP_MACOSX
// On OS X the printer name given to this function is the readable/display
// name and not the CUPS name, so we iterate over all the printers for now.
// See bug 1659807 for one approach to improve perf here.
{
nsAutoCString printerName;
CopyUTF16toUTF8(aPrinterName, printerName);
cups_dest_t* printers = nullptr;
const auto numPrinters = CupsShim().cupsGetDests(&printers);
for (auto i : mozilla::IntegerRange(0, numPrinters)) {
const char* const displayName = CupsShim().cupsGetOption(
"printer-info", printers[i].num_options, printers[i].options);
if (printerName == displayName) {
// The second arg to CupsShim().cupsCopyDest is called num_dests, but
// it actually copies num_dests + 1 elements.
CupsShim().cupsCopyDest(printers + i, 0, &printer);
break;
}
}
CupsShim().cupsFreeDests(numPrinters, printers);
}
#else
// On GTK, we only ever show the CUPS name of printers, so we can use
// cupsGetNamedDest directly.
{
const auto printerName = NS_ConvertUTF16toUTF8(aPrinterName);
printer = CupsShim().cupsGetNamedDest(CUPS_HTTP_DEFAULT, printerName.get(),
nullptr);
}
#endif
if (printer) {
// Since the printer name had to be passed by-value, we can move the
// name from that.
rv.emplace(PrinterInfo{std::move(aPrinterName), printer});
}
return rv;
}
mozilla::Maybe<PrinterInfo> nsPrinterListCUPS::PrinterBySystemName(
nsString aPrinterName) const {
mozilla::Maybe<PrinterInfo> rv;
if (!CupsShim().InitOkay()) {
return rv;
}
const auto printerName = NS_ConvertUTF16toUTF8(aPrinterName);
if (cups_dest_t* const printer = CupsShim().cupsGetNamedDest(
CUPS_HTTP_DEFAULT, printerName.get(), nullptr)) {
rv.emplace(PrinterInfo{std::move(aPrinterName), printer});
}
return rv;
}
nsresult nsPrinterListCUPS::SystemDefaultPrinterName(nsAString& aName) const {
aName.Truncate();
if (!CupsShim().InitOkay()) {
return NS_ERROR_FAILURE;
}
// Passing in nullptr for the name will return the default, if any.
cups_dest_t* dest =
CupsShim().cupsGetNamedDest(CUPS_HTTP_DEFAULT, /* name */ nullptr,
/* instance */ nullptr);
if (!dest) {
return NS_OK;
}
GetDisplayNameForPrinter(*dest, aName);
if (aName.IsEmpty()) {
CopyUTF8toUTF16(mozilla::MakeStringSpan(dest->name), aName);
}
CupsShim().cupsFreeDests(1, dest);
return NS_OK;
}
|
