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
|
// Copyright 2016 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.
#ifndef PRINTING_BACKEND_CUPS_PRINTER_H_
#define PRINTING_BACKEND_CUPS_PRINTER_H_
#include <cups/cups.h>
#include <memory>
#include <string>
#include <vector>
#include "printing/backend/cups_deleters.h"
#include "printing/printing_export.h"
#include "url/gurl.h"
namespace printing {
struct PrinterBasicInfo;
// Provides information regarding cups options.
class PRINTING_EXPORT CupsOptionProvider {
public:
virtual ~CupsOptionProvider() = default;
// Returns the supported ipp attributes for the given |option_name|.
// ipp_attribute_t* is owned by CupsOptionProvider.
virtual ipp_attribute_t* GetSupportedOptionValues(
const char* option_name) const = 0;
// Returns supported attribute values for |option_name| where the value can be
// convered to a string.
virtual std::vector<base::StringPiece> GetSupportedOptionValueStrings(
const char* option_name) const = 0;
// Returns the default ipp attributes for the given |option_name|.
// ipp_attribute_t* is owned by CupsOptionProvider.
virtual ipp_attribute_t* GetDefaultOptionValue(
const char* option_name) const = 0;
// Returns true if the |value| is supported by option |name|.
virtual bool CheckOptionSupported(const char* name,
const char* value) const = 0;
};
// Represents a CUPS printer.
// Retrieves information from CUPS printer objects as requested. This class
// is only valid as long as the CupsConnection which created it exists as they
// share an http connection which the CupsConnection closes on destruction.
class PRINTING_EXPORT CupsPrinter : public CupsOptionProvider {
public:
// Represents the margins that CUPS reports for some given media.
// Its members are valued in PWG units (100ths of mm).
// This struct approximates a cups_size_t, which is BLRT.
struct CupsMediaMargins {
int bottom;
int left;
int right;
int top;
};
// Create a printer with a connection defined by |http| and |dest|.
CupsPrinter(http_t* http, ScopedDestination dest);
CupsPrinter(CupsPrinter&& printer);
~CupsPrinter() override;
// Returns true if this is the default printer
bool is_default() const;
// CupsOptionProvider
ipp_attribute_t* GetSupportedOptionValues(
const char* option_name) const override;
std::vector<base::StringPiece> GetSupportedOptionValueStrings(
const char* option_name) const override;
ipp_attribute_t* GetDefaultOptionValue(
const char* option_name) const override;
bool CheckOptionSupported(const char* name, const char* value) const override;
// Returns the contents of the PPD retrieved from the print server.
std::string GetPPD() const;
// Returns the name of the printer as configured in CUPS
std::string GetName() const;
std::string GetMakeAndModel() const;
// Returns the "printer-info" option of the printer as configured in CUPS.
std::string GetInfo() const;
std::string GetUri() const;
// Lazily initialize dest info as it can require a network call
bool EnsureDestInfo() const;
// Populates |basic_info| with the relevant information about the printer
bool ToPrinterInfo(PrinterBasicInfo* basic_info) const;
// Start a print job. Writes the id of the started job to |job_id|. |job_id|
// is 0 if there is an error. |title| is not sent if empty. |username| is
// not sent if empty. Check availability before using this operation. Usage
// on an unavailable printer is undefined.
ipp_status_t CreateJob(int* job_id,
const std::string& title,
const std::string& username,
const std::vector<cups_option_t>& options);
// Add a document to a print job. |job_id| must be non-zero and refer to a
// job started with CreateJob. |docname| will be displayed in print status
// if not empty. |last_doc| should be true if this is the last document for
// this print job. |username| is not sent if empty. |options| should be IPP
// key value pairs for the Send-Document operation.
bool StartDocument(int job_id,
const std::string& docname,
bool last_doc,
const std::string& username,
const std::vector<cups_option_t>& options);
// Add data to the current document started by StartDocument. Calling this
// without a started document will fail.
bool StreamData(const std::vector<char>& buffer);
// Finish the current document. Another document can be added or the job can
// be closed to complete printing.
bool FinishDocument();
// Close the job. If the job is not closed, the documents will not be
// printed. |job_id| should match the id from CreateJob. |username| is not
// sent if empty.
ipp_status_t CloseJob(int job_id, const std::string& username);
// Cancel the print job |job_id|. Returns true if the operation succeeded.
// Returns false if it failed for any reason.
bool CancelJob(int job_id);
// Queries CUPS for the margins of the media named by |media_id|.
//
// A |media_id| is any vendor ID known to CUPS for a given printer.
// Vendor IDs are exemplified by the keys of the big map in
// print_media_l10n.cc.
//
// Returns all zeroes if the CUPS API call fails.
CupsMediaMargins GetMediaMarginsByName(const std::string& media_id);
private:
// http connection owned by the CupsConnection which created this object
http_t* const cups_http_;
// information to identify a printer
ScopedDestination destination_;
// opaque object containing printer attributes and options
mutable ScopedDestInfo dest_info_;
DISALLOW_COPY_AND_ASSIGN(CupsPrinter);
};
} // namespace printing
#endif // PRINTING_BACKEND_CUPS_PRINTER_H_
|
