[thirdparty/cups.git] / cups / getdevices.c

/*
 * "$Id$"
 *
 *   cupsGetDevices implementation for the Common UNIX Printing System (CUPS).
 *
 *   Copyright 2008-2009 by Apple Inc.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Apple Inc. and are protected by Federal copyright
 *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
 *   which should have been included with this file.  If this file is
 *   file is missing or damaged, see the license at "http://www.cups.org/".
 *
 *   This file is subject to the Apple OS-Developed Software exception.
 *
 * Contents:
 *
 *   cupsGetDevices() - Get available printer devices.
 */

/*
 * Include necessary headers...
 */

#include "globals.h"
#include "debug.h"


/*
 * 'cupsGetDevices()' - Get available printer devices.
 *
 * This function sends a CUPS-Get-Devices request and streams the discovered
 * devices to the specified callback function. The "timeout" parameter controls
 * how long the request lasts, while the "include_schemes" and "exclude_schemes"
 * parameters provide comma-delimited lists of backends to include or omit from
 * the request respectively.
 *
 * @since CUPS 1.4@
 */

ipp_status_t				/* O - Request status - @code IPP_OK@ on success. */
cupsGetDevices(
    http_t           *http,		/* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
    int              timeout,		/* I - Timeout in seconds or @code CUPS_TIMEOUT_DEFAULT@ */
    const char       *include_schemes,	/* I - Comma-separated URI schemes to include or @code CUPS_INCLUDE_ALL@ */
    const char       *exclude_schemes,	/* I - Comma-separated URI schemes to exclude or @code CUPS_EXCLUDE_NONE@ */
    cups_device_cb_t callback,		/* I - Callback function */
    void             *user_data)	/* I - User data pointer */
{
  ipp_t		*request,		/* CUPS-Get-Devices request */
		*response;		/* CUPS-Get-Devices response */
  ipp_attribute_t *attr;		/* Current attribute */
  const char	*device_class,		/* device-class value */
		*device_id,		/* device-id value */
		*device_info,		/* device-info value */
		*device_location,	/* device-location value */
		*device_make_and_model,	/* device-make-and-model value */
		*device_uri;		/* device-uri value */
  int		blocking;		/* Current blocking-IO mode */
  cups_option_t	option;			/* in/exclude-schemes option */
  http_status_t	status;			/* HTTP status of request */
  ipp_state_t	state;			/* IPP response state */


 /*
  * Range check input...
  */

  DEBUG_printf(("cupsGetDevices(http=%p, timeout=%d, include_schemes=\"%s\", "
                "exclude_schemes=\"%s\", callback=%p, user_data=%p)", http,
		timeout, include_schemes, exclude_schemes, callback,
		user_data));

  if (!callback)
    return (IPP_INTERNAL_ERROR);

  if (!http)
    http = _cupsConnect();

  if (!http)
    return (IPP_SERVICE_UNAVAILABLE);

 /*
  * Create a CUPS-Get-Devices request...
  */

  request = ippNewRequest(CUPS_GET_DEVICES);

  if (timeout > 0)
    ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "timeout",
                  timeout);

  if (include_schemes)
  {
    option.name  = "include-schemes";
    option.value = (char *)include_schemes;

    cupsEncodeOptions2(request, 1, &option, IPP_TAG_OPERATION);
  }

  if (exclude_schemes)
  {
    option.name  = "exclude-schemes";
    option.value = (char *)exclude_schemes;

    cupsEncodeOptions2(request, 1, &option, IPP_TAG_OPERATION);
  }

 /*
  * Send the request and do any necessary authentication...
  */

  do
  {
    DEBUG_puts("2cupsGetDevices: Sending request...");
    status = cupsSendRequest(http, request, "/", ippLength(request));

    DEBUG_puts("2cupsGetDevices: Waiting for response status...");
    while (status == HTTP_CONTINUE)
      status = httpUpdate(http);

    if (status != HTTP_OK)
    {
      httpFlush(http);

      if (status == HTTP_UNAUTHORIZED)
      {
       /*
	* See if we can do authentication...
	*/

	DEBUG_puts("2cupsGetDevices: Need authorization...");

	if (!cupsDoAuthentication(http, "POST", "/"))
	  httpReconnect(http);
	else
	  break;
      }

#ifdef HAVE_SSL
      else if (status == HTTP_UPGRADE_REQUIRED)
      {
       /*
	* Force a reconnect with encryption...
	*/

	DEBUG_puts("2cupsGetDevices: Need encryption...");

	if (!httpReconnect(http))
	  httpEncryption(http, HTTP_ENCRYPT_REQUIRED);
      }
#endif /* HAVE_SSL */
    }
  }
  while (status == HTTP_UNAUTHORIZED || status == HTTP_UPGRADE_REQUIRED);

  DEBUG_printf(("2cupsGetDevices: status=%d", status));

  ippDelete(request);

  if (status != HTTP_OK)
  {
    _cupsSetHTTPError(status);
    return (cupsLastError());
  }

 /*
  * Read the response in non-blocking mode...
  */

  blocking = httpGetBlocking(http);
  httpBlocking(http, 0);

  response              = ippNew();
  device_class          = NULL;
  device_id             = NULL;
  device_info           = NULL;
  device_location       = "";
  device_make_and_model = NULL;
  device_uri            = NULL;
  attr                  = NULL;

  DEBUG_puts("2cupsGetDevices: Reading response...");

  do
  {
    if ((state = ippRead(http, response)) == IPP_ERROR)
      break;

    DEBUG_printf(("2cupsGetDevices: state=%d, response->last=%p", state,
                  response->last));

    if (!response->attrs)
      continue;

    while (attr != response->last)
    {
      if (!attr)
	attr = response->attrs;
      else
        attr = attr->next;

      DEBUG_printf(("2cupsGetDevices: attr->name=\"%s\", attr->value_tag=%d",
                    attr->name, attr->value_tag));

      if (!attr->name)
      {
        if (device_class && device_id && device_info && device_make_and_model &&
	    device_uri)
          (*callback)(device_class, device_id, device_info,
	              device_make_and_model, device_uri, device_location,
		      user_data);

	device_class          = NULL;
	device_id             = NULL;
	device_info           = NULL;
	device_location       = "";
	device_make_and_model = NULL;
	device_uri            = NULL;
      }
      else if (!strcmp(attr->name, "device-class") &&
               attr->value_tag == IPP_TAG_KEYWORD)
        device_class = attr->values[0].string.text;
      else if (!strcmp(attr->name, "device-id") &&
               attr->value_tag == IPP_TAG_TEXT)
        device_id = attr->values[0].string.text;
      else if (!strcmp(attr->name, "device-info") &&
               attr->value_tag == IPP_TAG_TEXT)
        device_info = attr->values[0].string.text;
      else if (!strcmp(attr->name, "device-location") &&
               attr->value_tag == IPP_TAG_TEXT)
        device_location = attr->values[0].string.text;
      else if (!strcmp(attr->name, "device-make-and-model") &&
               attr->value_tag == IPP_TAG_TEXT)
        device_make_and_model = attr->values[0].string.text;
      else if (!strcmp(attr->name, "device-uri") &&
               attr->value_tag == IPP_TAG_URI)
        device_uri = attr->values[0].string.text;
    }
  }
  while (state != IPP_DATA);

  DEBUG_printf(("2cupsGetDevices: state=%d, response->last=%p", state,
		response->last));

  if (device_class && device_id && device_info && device_make_and_model &&
      device_uri)
    (*callback)(device_class, device_id, device_info,
		device_make_and_model, device_uri, device_location, user_data);

 /*
  * Set the IPP status and return...
  */

  httpBlocking(http, blocking);
  httpFlush(http);

  if (status == IPP_ERROR)
    _cupsSetError(IPP_ERROR, NULL, 0);
  else
  {
    attr = ippFindAttribute(response, "status-message", IPP_TAG_TEXT);

    DEBUG_printf(("cupsGetDevices: status-code=%s, status-message=\"%s\"",
		  ippErrorString(response->request.status.status_code),
		  attr ? attr->values[0].string.text : ""));

    _cupsSetError(response->request.status.status_code,
		  attr ? attr->values[0].string.text :
		      ippErrorString(response->request.status.status_code), 0);
  }

  ippDelete(response);

  return (cupsLastError());
}


/*
 * End of "$Id$".
 */
Commit	Line	Data
ae71f5de MS	1	/*
	2	* "$Id$"
	3	*
	4	* cupsGetDevices implementation for the Common UNIX Printing System (CUPS).
	5	*
e07d4801	6	* Copyright 2008-2009 by Apple Inc.
ae71f5de MS	7	*
	8	* These coded instructions, statements, and computer programs are the
	9	* property of Apple Inc. and are protected by Federal copyright
	10	* law. Distribution and use rights are outlined in the file "LICENSE.txt"
	11	* which should have been included with this file. If this file is
	12	* file is missing or damaged, see the license at "http://www.cups.org/".
	13	*
	14	* This file is subject to the Apple OS-Developed Software exception.
	15	*
	16	* Contents:
	17	*
749b1e90	18	* cupsGetDevices() - Get available printer devices.
ae71f5de MS	19	*/
	20
	21	/*
	22	* Include necessary headers...
	23	*/
	24
	25	#include "globals.h"
	26	#include "debug.h"
	27
	28
	29	/*
	30	* 'cupsGetDevices()' - Get available printer devices.
	31	*
	32	* This function sends a CUPS-Get-Devices request and streams the discovered
	33	* devices to the specified callback function. The "timeout" parameter controls
ed6e7faf MS	34	* how long the request lasts, while the "include_schemes" and "exclude_schemes"
	35	* parameters provide comma-delimited lists of backends to include or omit from
	36	* the request respectively.
ae71f5de MS	37	*
	38	* @since CUPS 1.4@
	39	*/
	40
	41	ipp_status_t /* O - Request status - @code IPP_OK@ on success. */
	42	cupsGetDevices(
	43	http_t http, / I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
	44	int timeout, /* I - Timeout in seconds or @code CUPS_TIMEOUT_DEFAULT@ */
ed6e7faf	45	const char include_schemes, / I - Comma-separated URI schemes to include or @code CUPS_INCLUDE_ALL@ */
ae71f5de MS	46	const char exclude_schemes, / I - Comma-separated URI schemes to exclude or @code CUPS_EXCLUDE_NONE@ */
	47	cups_device_cb_t callback, /* I - Callback function */
	48	void user_data) / I - User data pointer */
	49	{
	50	ipp_t request, / CUPS-Get-Devices request */
	51	response; / CUPS-Get-Devices response */
	52	ipp_attribute_t attr; / Current attribute */
	53	const char device_class, / device-class value */
	54	device_id, / device-id value */
	55	device_info, / device-info value */
749b1e90	56	device_location, / device-location value */
ae71f5de MS	57	device_make_and_model, / device-make-and-model value */
	58	device_uri; / device-uri value */
	59	int blocking; /* Current blocking-IO mode */
ed6e7faf	60	cups_option_t option; /* in/exclude-schemes option */
ae71f5de MS	61	http_status_t status; /* HTTP status of request */
	62	ipp_state_t state; /* IPP response state */
	63
	64
	65	/*
	66	* Range check input...
	67	*/
	68
e07d4801 MS	69	DEBUG_printf(("cupsGetDevices(http=%p, timeout=%d, include_schemes=\"%s\", "
	70	"exclude_schemes=\"%s\", callback=%p, user_data=%p)", http,
	71	timeout, include_schemes, exclude_schemes, callback,
	72	user_data));
	73
ae71f5de MS	74	if (!callback)
	75	return (IPP_INTERNAL_ERROR);
	76
	77	if (!http)
	78	http = _cupsConnect();
	79
	80	if (!http)
	81	return (IPP_SERVICE_UNAVAILABLE);
	82
	83	/*
	84	* Create a CUPS-Get-Devices request...
	85	*/
	86
	87	request = ippNewRequest(CUPS_GET_DEVICES);
	88
	89	if (timeout > 0)
	90	ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "timeout",
	91	timeout);
	92
ed6e7faf MS	93	if (include_schemes)
	94	{
	95	option.name = "include-schemes";
	96	option.value = (char *)include_schemes;
	97
	98	cupsEncodeOptions2(request, 1, &option, IPP_TAG_OPERATION);
	99	}
	100
ae71f5de MS	101	if (exclude_schemes)
	102	{
	103	option.name = "exclude-schemes";
	104	option.value = (char *)exclude_schemes;
	105
	106	cupsEncodeOptions2(request, 1, &option, IPP_TAG_OPERATION);
	107	}
	108
	109	/*
	110	* Send the request and do any necessary authentication...
	111	*/
	112
	113	do
	114	{
e07d4801	115	DEBUG_puts("2cupsGetDevices: Sending request...");
ae71f5de MS	116	status = cupsSendRequest(http, request, "/", ippLength(request));
ae71f5de MS	117
e07d4801	118	DEBUG_puts("2cupsGetDevices: Waiting for response status...");
ae71f5de MS	119	while (status == HTTP_CONTINUE)
	120	status = httpUpdate(http);
	121
	122	if (status != HTTP_OK)
	123	{
	124	httpFlush(http);
	125
	126	if (status == HTTP_UNAUTHORIZED)
	127	{
	128	/*
	129	* See if we can do authentication...
	130	*/
	131
e07d4801	132	DEBUG_puts("2cupsGetDevices: Need authorization...");
ae71f5de	133
e07d4801	134	if (!cupsDoAuthentication(http, "POST", "/"))
ae71f5de	135	httpReconnect(http);
e07d4801 MS	136	else
e07d4801 MS	137	break;
ae71f5de MS	138	}
	139
	140	#ifdef HAVE_SSL
	141	else if (status == HTTP_UPGRADE_REQUIRED)
	142	{
	143	/*
	144	* Force a reconnect with encryption...
	145	*/
	146
e07d4801	147	DEBUG_puts("2cupsGetDevices: Need encryption...");
ae71f5de MS	148
	149	if (!httpReconnect(http))
	150	httpEncryption(http, HTTP_ENCRYPT_REQUIRED);
	151	}
	152	#endif /* HAVE_SSL */
	153	}
	154	}
	155	while (status == HTTP_UNAUTHORIZED \|\| status == HTTP_UPGRADE_REQUIRED);
	156
e07d4801	157	DEBUG_printf(("2cupsGetDevices: status=%d", status));
ae71f5de MS	158
	159	ippDelete(request);
	160
	161	if (status != HTTP_OK)
	162	{
	163	_cupsSetHTTPError(status);
	164	return (cupsLastError());
	165	}
	166
	167	/*
	168	* Read the response in non-blocking mode...
	169	*/
	170
	171	blocking = httpGetBlocking(http);
	172	httpBlocking(http, 0);
	173
	174	response = ippNew();
	175	device_class = NULL;
	176	device_id = NULL;
	177	device_info = NULL;
749b1e90	178	device_location = "";
ae71f5de MS	179	device_make_and_model = NULL;
	180	device_uri = NULL;
	181	attr = NULL;
	182
e07d4801	183	DEBUG_puts("2cupsGetDevices: Reading response...");
ae71f5de MS	184
	185	do
	186	{
	187	if ((state = ippRead(http, response)) == IPP_ERROR)
	188	break;
	189
e07d4801	190	DEBUG_printf(("2cupsGetDevices: state=%d, response->last=%p", state,
ae71f5de MS	191	response->last));
	192
	193	if (!response->attrs)
	194	continue;
	195
	196	while (attr != response->last)
	197	{
	198	if (!attr)
	199	attr = response->attrs;
	200	else
	201	attr = attr->next;
	202
e07d4801 MS	203	DEBUG_printf(("2cupsGetDevices: attr->name=\"%s\", attr->value_tag=%d",
e07d4801 MS	204	attr->name, attr->value_tag));
ae71f5de MS	205
	206	if (!attr->name)
	207	{
	208	if (device_class && device_id && device_info && device_make_and_model &&
	209	device_uri)
	210	(*callback)(device_class, device_id, device_info,
749b1e90 MS	211	device_make_and_model, device_uri, device_location,
749b1e90 MS	212	user_data);
ae71f5de MS	213
	214	device_class = NULL;
	215	device_id = NULL;
	216	device_info = NULL;
749b1e90	217	device_location = "";
ae71f5de MS	218	device_make_and_model = NULL;
	219	device_uri = NULL;
	220	}
	221	else if (!strcmp(attr->name, "device-class") &&
	222	attr->value_tag == IPP_TAG_KEYWORD)
	223	device_class = attr->values[0].string.text;
	224	else if (!strcmp(attr->name, "device-id") &&
	225	attr->value_tag == IPP_TAG_TEXT)
	226	device_id = attr->values[0].string.text;
	227	else if (!strcmp(attr->name, "device-info") &&
	228	attr->value_tag == IPP_TAG_TEXT)
	229	device_info = attr->values[0].string.text;
749b1e90 MS	230	else if (!strcmp(attr->name, "device-location") &&
	231	attr->value_tag == IPP_TAG_TEXT)
	232	device_location = attr->values[0].string.text;
ae71f5de MS	233	else if (!strcmp(attr->name, "device-make-and-model") &&
	234	attr->value_tag == IPP_TAG_TEXT)
	235	device_make_and_model = attr->values[0].string.text;
	236	else if (!strcmp(attr->name, "device-uri") &&
	237	attr->value_tag == IPP_TAG_URI)
	238	device_uri = attr->values[0].string.text;
	239	}
	240	}
	241	while (state != IPP_DATA);
	242
e07d4801	243	DEBUG_printf(("2cupsGetDevices: state=%d, response->last=%p", state,
ae71f5de MS	244	response->last));
	245
	246	if (device_class && device_id && device_info && device_make_and_model &&
	247	device_uri)
	248	(*callback)(device_class, device_id, device_info,
749b1e90	249	device_make_and_model, device_uri, device_location, user_data);
ae71f5de MS	250
	251	/*
	252	* Set the IPP status and return...
	253	*/
	254
	255	httpBlocking(http, blocking);
8922323b	256	httpFlush(http);
ae71f5de MS	257
ae71f5de MS	258	if (status == IPP_ERROR)
749b1e90	259	_cupsSetError(IPP_ERROR, NULL, 0);
ae71f5de MS	260	else
	261	{
	262	attr = ippFindAttribute(response, "status-message", IPP_TAG_TEXT);
	263
e07d4801	264	DEBUG_printf(("cupsGetDevices: status-code=%s, status-message=\"%s\"",
ae71f5de MS	265	ippErrorString(response->request.status.status_code),
	266	attr ? attr->values[0].string.text : ""));
	267
	268	_cupsSetError(response->request.status.status_code,
749b1e90 MS	269	attr ? attr->values[0].string.text :
749b1e90 MS	270	ippErrorString(response->request.status.status_code), 0);
ae71f5de MS	271	}
	272
	273	ippDelete(response);
	274
	275	return (cupsLastError());
	276	}
	277
	278
	279	/*
	280	* End of "$Id$".
	281	*/