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
|
// 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.
// Implementations of IPP requests for printer queue information.
#ifndef PRINTING_BACKEND_CUPS_JOBS_H_
#define PRINTING_BACKEND_CUPS_JOBS_H_
#include <cups/cups.h>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
#include "base/component_export.h"
#include "base/version.h"
#include "printing/printer_query_result.h"
// This file contains a collection of functions used to query IPP printers or
// print servers and the related code to parse these responses. All Get*
// operations block on the network request and cannot be run on the UI thread.
namespace printing {
struct PrinterStatus;
// Represents a print job sent to the queue.
struct COMPONENT_EXPORT(PRINT_BACKEND) CupsJob {
// Corresponds to job-state from RFC2911.
enum JobState {
UNKNOWN,
PENDING, // waiting to be processed
HELD, // the job has not begun printing and will not without intervention
COMPLETED,
PROCESSING, // job is being sent to the printer/printed
STOPPED, // job was being processed and has now stopped
CANCELED, // either the spooler or a user canclled the job
ABORTED // an error occurred causing the printer to give up
};
// Possible reasons sent by CUPS in job-state-reason
// The strings are hardcoded in CUPS code and these strings the only once are
// currently needed.
enum class JobStateReason {
kJobCompletedWithErrors = 0,
kCupsHeldForAuthentication,
};
CupsJob();
CupsJob(const CupsJob& other);
~CupsJob();
// Returns true if `job`.state_reasons contains `reason`.
bool ContainsStateReason(JobStateReason reason) const;
// job id
int id = -1;
// printer name in CUPS
std::string printer_id;
JobState state = UNKNOWN;
// the last page printed
int current_pages = -1;
// detail for the job state
std::vector<std::string> state_reasons;
// human readable message explaining the state
std::string state_message;
// most recent timestamp where the job entered PROCESSING
int processing_started = 0;
};
struct COMPONENT_EXPORT(PRINT_BACKEND) PrinterInfo {
PrinterInfo();
PrinterInfo(const PrinterInfo& info);
~PrinterInfo();
// printer-make-and-model
std::string make_and_model;
// document-format-supported
// MIME types for supported formats.
std::vector<std::string> document_formats;
// document-format-default
// MIME type for default format.
std::string document_format_default;
// document-format-preferred
// MIME type for preferred format.
std::string document_format_preferred;
// urf-supported
// A collection of supported URF printing modes.
std::vector<std::string> urf_supported;
// pdf-version-supported
// A collection of supported PDF versions.
std::vector<std::string> pdf_versions;
// ipp-features-supported
// A collection of supported IPP features.
std::vector<std::string> ipp_features;
// mopria-certified
// Mopria certification level of the printer.
std::string mopria_certified;
// printer-kind
// A collection of supported printing categories.
std::vector<std::string> printer_kind;
// ipp-versions-supported
// A collection of supported IPP protocol versions.
std::vector<base::Version> ipp_versions;
// Does ipp-features-supported contain 'ipp-everywhere'.
bool ipp_everywhere = false;
// URI of OAuth2 Authorization Server and scope. Empty strings if not set.
std::string oauth_server;
std::string oauth_scope;
};
// Specifies classes of jobs.
enum JobCompletionState {
COMPLETED, // only completed jobs
PROCESSING // only jobs that are being processed
};
// Converts a JobStateReason to the exact string returned by CUPS.
const std::string_view COMPONENT_EXPORT(PRINT_BACKEND)
ToJobStateReasonString(CupsJob::JobStateReason stateReason);
// Returns the uri for printer with `id` as served by CUPS. Assumes that `id` is
// a valid CUPS printer name and performs no error checking or escaping.
std::string COMPONENT_EXPORT(PRINT_BACKEND)
PrinterUriFromName(const std::string& id);
// Extracts structured job information from the `response` for `printer_id`.
// Extracted jobs are added to `jobs`.
void ParseJobsResponse(ipp_t* response,
const std::string& printer_id,
std::vector<CupsJob>* jobs);
// Attempts to extract a PrinterStatus object out of `response`.
void ParsePrinterStatus(ipp_t* response, PrinterStatus* printer_status);
// Queries the printer at `address` on `port` with a Get-Printer-Attributes
// request to populate `printer_info` and `printer_status`. If `encrypted` is
// true, request is made using ipps, otherwise, ipp is used.
PrinterQueryResult COMPONENT_EXPORT(PRINT_BACKEND)
GetPrinterInfo(const std::string& address,
int port,
const std::string& resource,
bool encrypted,
PrinterInfo* printer_info,
PrinterStatus* printer_status);
// Attempts to retrieve printer status using connection `http` for `printer_id`.
// Returns true if succcssful and updates the fields in `printer_status` as
// appropriate. Returns false if the request failed.
bool GetPrinterStatus(http_t* http,
const std::string& printer_id,
PrinterStatus* printer_status);
// Attempts to retrieve job information using connection `http` for the printer
// named `printer_id`. Retrieves at most `limit` jobs. If `completed` then
// completed jobs are retrieved. Otherwise, jobs that are currently in progress
// are retrieved. Results are added to `jobs` if the operation was successful.
bool GetCupsJobs(http_t* http,
const std::string& printer_id,
int limit,
JobCompletionState completed,
std::vector<CupsJob>* jobs);
} // namespace printing
#endif // PRINTING_BACKEND_CUPS_JOBS_H_
|
