2 * cupsGetDevices implementation for CUPS.
4 * Copyright 2008-2016 by Apple Inc.
6 * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
10 * Include necessary headers...
13 #include "cups-private.h"
14 #include "adminutil.h"
18 * 'cupsGetDevices()' - Get available printer devices.
20 * This function sends a CUPS-Get-Devices request and streams the discovered
21 * devices to the specified callback function. The "timeout" parameter controls
22 * how long the request lasts, while the "include_schemes" and "exclude_schemes"
23 * parameters provide comma-delimited lists of backends to include or omit from
24 * the request respectively.
26 * @since CUPS 1.4/macOS 10.6@
29 ipp_status_t
/* O - Request status - @code IPP_OK@ on success. */
31 http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
32 int timeout
, /* I - Timeout in seconds or @code CUPS_TIMEOUT_DEFAULT@ */
33 const char *include_schemes
, /* I - Comma-separated URI schemes to include or @code CUPS_INCLUDE_ALL@ */
34 const char *exclude_schemes
, /* I - Comma-separated URI schemes to exclude or @code CUPS_EXCLUDE_NONE@ */
35 cups_device_cb_t callback
, /* I - Callback function */
36 void *user_data
) /* I - User data pointer */
38 ipp_t
*request
, /* CUPS-Get-Devices request */
39 *response
; /* CUPS-Get-Devices response */
40 ipp_attribute_t
*attr
; /* Current attribute */
41 const char *device_class
, /* device-class value */
42 *device_id
, /* device-id value */
43 *device_info
, /* device-info value */
44 *device_location
, /* device-location value */
45 *device_make_and_model
, /* device-make-and-model value */
46 *device_uri
; /* device-uri value */
47 int blocking
; /* Current blocking-IO mode */
48 cups_option_t option
; /* in/exclude-schemes option */
49 http_status_t status
; /* HTTP status of request */
50 ipp_state_t state
; /* IPP response state */
54 * Range check input...
57 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
));
60 return (IPP_STATUS_ERROR_INTERNAL
);
63 http
= _cupsConnect();
66 return (IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
);
69 * Create a CUPS-Get-Devices request...
72 request
= ippNewRequest(IPP_OP_CUPS_GET_DEVICES
);
75 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "timeout",
80 option
.name
= "include-schemes";
81 option
.value
= (char *)include_schemes
;
83 cupsEncodeOptions2(request
, 1, &option
, IPP_TAG_OPERATION
);
88 option
.name
= "exclude-schemes";
89 option
.value
= (char *)exclude_schemes
;
91 cupsEncodeOptions2(request
, 1, &option
, IPP_TAG_OPERATION
);
95 * Send the request and do any necessary authentication...
100 DEBUG_puts("2cupsGetDevices: Sending request...");
101 status
= cupsSendRequest(http
, request
, "/", ippLength(request
));
103 DEBUG_puts("2cupsGetDevices: Waiting for response status...");
104 while (status
== HTTP_STATUS_CONTINUE
)
105 status
= httpUpdate(http
);
107 if (status
!= HTTP_STATUS_OK
)
111 if (status
== HTTP_STATUS_UNAUTHORIZED
)
114 * See if we can do authentication...
117 DEBUG_puts("2cupsGetDevices: Need authorization...");
119 if (!cupsDoAuthentication(http
, "POST", "/"))
120 httpReconnect2(http
, 30000, NULL
);
123 status
= HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED
;
129 else if (status
== HTTP_STATUS_UPGRADE_REQUIRED
)
132 * Force a reconnect with encryption...
135 DEBUG_puts("2cupsGetDevices: Need encryption...");
137 if (!httpReconnect2(http
, 30000, NULL
))
138 httpEncryption(http
, HTTP_ENCRYPTION_REQUIRED
);
140 #endif /* HAVE_SSL */
143 while (status
== HTTP_STATUS_UNAUTHORIZED
||
144 status
== HTTP_STATUS_UPGRADE_REQUIRED
);
146 DEBUG_printf(("2cupsGetDevices: status=%d", status
));
150 if (status
!= HTTP_STATUS_OK
)
152 _cupsSetHTTPError(status
);
153 return (cupsLastError());
157 * Read the response in non-blocking mode...
160 blocking
= httpGetBlocking(http
);
161 httpBlocking(http
, 0);
167 device_location
= "";
168 device_make_and_model
= NULL
;
172 DEBUG_puts("2cupsGetDevices: Reading response...");
176 if ((state
= ippRead(http
, response
)) == IPP_STATE_ERROR
)
179 DEBUG_printf(("2cupsGetDevices: state=%d, response->last=%p", state
, (void *)response
->last
));
181 if (!response
->attrs
)
184 while (attr
!= response
->last
)
187 attr
= response
->attrs
;
191 DEBUG_printf(("2cupsGetDevices: attr->name=\"%s\", attr->value_tag=%d",
192 attr
->name
, attr
->value_tag
));
196 if (device_class
&& device_id
&& device_info
&& device_make_and_model
&&
198 (*callback
)(device_class
, device_id
, device_info
,
199 device_make_and_model
, device_uri
, device_location
,
205 device_location
= "";
206 device_make_and_model
= NULL
;
209 else if (!strcmp(attr
->name
, "device-class") &&
210 attr
->value_tag
== IPP_TAG_KEYWORD
)
211 device_class
= attr
->values
[0].string
.text
;
212 else if (!strcmp(attr
->name
, "device-id") &&
213 attr
->value_tag
== IPP_TAG_TEXT
)
214 device_id
= attr
->values
[0].string
.text
;
215 else if (!strcmp(attr
->name
, "device-info") &&
216 attr
->value_tag
== IPP_TAG_TEXT
)
217 device_info
= attr
->values
[0].string
.text
;
218 else if (!strcmp(attr
->name
, "device-location") &&
219 attr
->value_tag
== IPP_TAG_TEXT
)
220 device_location
= attr
->values
[0].string
.text
;
221 else if (!strcmp(attr
->name
, "device-make-and-model") &&
222 attr
->value_tag
== IPP_TAG_TEXT
)
223 device_make_and_model
= attr
->values
[0].string
.text
;
224 else if (!strcmp(attr
->name
, "device-uri") &&
225 attr
->value_tag
== IPP_TAG_URI
)
226 device_uri
= attr
->values
[0].string
.text
;
229 while (state
!= IPP_STATE_DATA
);
231 DEBUG_printf(("2cupsGetDevices: state=%d, response->last=%p", state
, (void *)response
->last
));
233 if (device_class
&& device_id
&& device_info
&& device_make_and_model
&&
235 (*callback
)(device_class
, device_id
, device_info
,
236 device_make_and_model
, device_uri
, device_location
, user_data
);
239 * Set the IPP status and return...
242 httpBlocking(http
, blocking
);
245 if (status
== HTTP_STATUS_ERROR
)
246 _cupsSetError(IPP_STATUS_ERROR_INTERNAL
, strerror(http
->error
), 0);
249 attr
= ippFindAttribute(response
, "status-message", IPP_TAG_TEXT
);
251 DEBUG_printf(("cupsGetDevices: status-code=%s, status-message=\"%s\"",
252 ippErrorString(response
->request
.status
.status_code
),
253 attr
? attr
->values
[0].string
.text
: ""));
255 _cupsSetError(response
->request
.status
.status_code
,
256 attr
? attr
->values
[0].string
.text
:
257 ippErrorString(response
->request
.status
.status_code
), 0);
262 return (cupsLastError());