2 * cupsGetDevices implementation for CUPS.
4 * Copyright 2008-2016 by Apple Inc.
6 * These coded instructions, statements, and computer programs are the
7 * property of Apple Inc. and are protected by Federal copyright
8 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
9 * which should have been included with this file. If this file is
10 * missing or damaged, see the license at "http://www.cups.org/".
12 * This file is subject to the Apple OS-Developed Software exception.
16 * Include necessary headers...
19 #include "cups-private.h"
20 #include "adminutil.h"
24 * 'cupsGetDevices()' - Get available printer devices.
26 * This function sends a CUPS-Get-Devices request and streams the discovered
27 * devices to the specified callback function. The "timeout" parameter controls
28 * how long the request lasts, while the "include_schemes" and "exclude_schemes"
29 * parameters provide comma-delimited lists of backends to include or omit from
30 * the request respectively.
32 * @since CUPS 1.4/macOS 10.6@
35 ipp_status_t
/* O - Request status - @code IPP_OK@ on success. */
37 http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
38 int timeout
, /* I - Timeout in seconds or @code CUPS_TIMEOUT_DEFAULT@ */
39 const char *include_schemes
, /* I - Comma-separated URI schemes to include or @code CUPS_INCLUDE_ALL@ */
40 const char *exclude_schemes
, /* I - Comma-separated URI schemes to exclude or @code CUPS_EXCLUDE_NONE@ */
41 cups_device_cb_t callback
, /* I - Callback function */
42 void *user_data
) /* I - User data pointer */
44 ipp_t
*request
, /* CUPS-Get-Devices request */
45 *response
; /* CUPS-Get-Devices response */
46 ipp_attribute_t
*attr
; /* Current attribute */
47 const char *device_class
, /* device-class value */
48 *device_id
, /* device-id value */
49 *device_info
, /* device-info value */
50 *device_location
, /* device-location value */
51 *device_make_and_model
, /* device-make-and-model value */
52 *device_uri
; /* device-uri value */
53 int blocking
; /* Current blocking-IO mode */
54 cups_option_t option
; /* in/exclude-schemes option */
55 http_status_t status
; /* HTTP status of request */
56 ipp_state_t state
; /* IPP response state */
60 * Range check input...
63 DEBUG_printf(("cupsGetDevices(http=%p, timeout=%d, include_schemes=\"%s\", exclude_schemes=\"%s\", callback=%p, user_data=%p)", (void *)http
, timeout
, include_schemes
, exclude_schemes
, (void *)callback
, user_data
));
66 return (IPP_STATUS_ERROR_INTERNAL
);
69 http
= _cupsConnect();
72 return (IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
);
75 * Create a CUPS-Get-Devices request...
78 request
= ippNewRequest(IPP_OP_CUPS_GET_DEVICES
);
81 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "timeout",
86 option
.name
= "include-schemes";
87 option
.value
= (char *)include_schemes
;
89 cupsEncodeOptions2(request
, 1, &option
, IPP_TAG_OPERATION
);
94 option
.name
= "exclude-schemes";
95 option
.value
= (char *)exclude_schemes
;
97 cupsEncodeOptions2(request
, 1, &option
, IPP_TAG_OPERATION
);
101 * Send the request and do any necessary authentication...
106 DEBUG_puts("2cupsGetDevices: Sending request...");
107 status
= cupsSendRequest(http
, request
, "/", ippLength(request
));
109 DEBUG_puts("2cupsGetDevices: Waiting for response status...");
110 while (status
== HTTP_STATUS_CONTINUE
)
111 status
= httpUpdate(http
);
113 if (status
!= HTTP_STATUS_OK
)
117 if (status
== HTTP_STATUS_UNAUTHORIZED
)
120 * See if we can do authentication...
123 DEBUG_puts("2cupsGetDevices: Need authorization...");
125 if (!cupsDoAuthentication(http
, "POST", "/"))
126 httpReconnect2(http
, 30000, NULL
);
129 status
= HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED
;
135 else if (status
== HTTP_STATUS_UPGRADE_REQUIRED
)
138 * Force a reconnect with encryption...
141 DEBUG_puts("2cupsGetDevices: Need encryption...");
143 if (!httpReconnect2(http
, 30000, NULL
))
144 httpEncryption(http
, HTTP_ENCRYPTION_REQUIRED
);
146 #endif /* HAVE_SSL */
149 while (status
== HTTP_STATUS_UNAUTHORIZED
||
150 status
== HTTP_STATUS_UPGRADE_REQUIRED
);
152 DEBUG_printf(("2cupsGetDevices: status=%d", status
));
156 if (status
!= HTTP_STATUS_OK
)
158 _cupsSetHTTPError(status
);
159 return (cupsLastError());
163 * Read the response in non-blocking mode...
166 blocking
= httpGetBlocking(http
);
167 httpBlocking(http
, 0);
173 device_location
= "";
174 device_make_and_model
= NULL
;
178 DEBUG_puts("2cupsGetDevices: Reading response...");
182 if ((state
= ippRead(http
, response
)) == IPP_STATE_ERROR
)
185 DEBUG_printf(("2cupsGetDevices: state=%d, response->last=%p", state
, (void *)response
->last
));
187 if (!response
->attrs
)
190 while (attr
!= response
->last
)
193 attr
= response
->attrs
;
197 DEBUG_printf(("2cupsGetDevices: attr->name=\"%s\", attr->value_tag=%d",
198 attr
->name
, attr
->value_tag
));
202 if (device_class
&& device_id
&& device_info
&& device_make_and_model
&&
204 (*callback
)(device_class
, device_id
, device_info
,
205 device_make_and_model
, device_uri
, device_location
,
211 device_location
= "";
212 device_make_and_model
= NULL
;
215 else if (!strcmp(attr
->name
, "device-class") &&
216 attr
->value_tag
== IPP_TAG_KEYWORD
)
217 device_class
= attr
->values
[0].string
.text
;
218 else if (!strcmp(attr
->name
, "device-id") &&
219 attr
->value_tag
== IPP_TAG_TEXT
)
220 device_id
= attr
->values
[0].string
.text
;
221 else if (!strcmp(attr
->name
, "device-info") &&
222 attr
->value_tag
== IPP_TAG_TEXT
)
223 device_info
= attr
->values
[0].string
.text
;
224 else if (!strcmp(attr
->name
, "device-location") &&
225 attr
->value_tag
== IPP_TAG_TEXT
)
226 device_location
= attr
->values
[0].string
.text
;
227 else if (!strcmp(attr
->name
, "device-make-and-model") &&
228 attr
->value_tag
== IPP_TAG_TEXT
)
229 device_make_and_model
= attr
->values
[0].string
.text
;
230 else if (!strcmp(attr
->name
, "device-uri") &&
231 attr
->value_tag
== IPP_TAG_URI
)
232 device_uri
= attr
->values
[0].string
.text
;
235 while (state
!= IPP_STATE_DATA
);
237 DEBUG_printf(("2cupsGetDevices: state=%d, response->last=%p", state
, (void *)response
->last
));
239 if (device_class
&& device_id
&& device_info
&& device_make_and_model
&&
241 (*callback
)(device_class
, device_id
, device_info
,
242 device_make_and_model
, device_uri
, device_location
, user_data
);
245 * Set the IPP status and return...
248 httpBlocking(http
, blocking
);
251 if (status
== HTTP_STATUS_ERROR
)
252 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(http
->error
), 0);
255 attr
= ippFindAttribute(response
, "status-message", IPP_TAG_TEXT
);
257 DEBUG_printf(("cupsGetDevices: status-code=%s, status-message=\"%s\"",
258 ippErrorString(response
->request
.status
.status_code
),
259 attr
? attr
->values
[0].string
.text
: ""));
261 _cupsSetError(response
->request
.status
.status_code
,
262 attr
? attr
->values
[0].string
.text
:
263 ippErrorString(response
->request
.status
.status_code
), 0);
268 return (cupsLastError());