]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - cups/getdevices.c
Remove all of the Subversion keywords from various source files.
[thirdparty/cups.git] / cups / getdevices.c
index 6843e5afd12562c07deedfdd5cd43e4104798c9b..c3e828785e427331535be8b37efe390a067dcf84 100644 (file)
@@ -1,28 +1,22 @@
 /*
- * "$Id$"
+ * cupsGetDevices implementation for CUPS.
  *
- *   cupsGetDevices implementation for the Common UNIX Printing System (CUPS).
+ * Copyright 2008-2013 by Apple Inc.
  *
- *   Copyright 2008 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:
+ * 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.
  */
 
 /*
  * Include necessary headers...
  */
 
-#include "globals.h"
-#include "debug.h"
+#include "cups-private.h"
 
 
 /*
  *
  * 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 "exclude_schemes" parameter provides
- * a comma-delimited list of backends to omit from the request.
+ * 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@
+ * @since CUPS 1.4/OS X 10.6@
  */
 
 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 */
@@ -50,10 +46,11 @@ cupsGetDevices(
   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;                 /* exclude-schemes option */
+  cups_option_t        option;                 /* in/exclude-schemes option */
   http_status_t        status;                 /* HTTP status of request */
   ipp_state_t  state;                  /* IPP response state */
 
@@ -62,25 +59,35 @@ cupsGetDevices(
   * Range check input...
   */
 
+  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));
+
   if (!callback)
-    return (IPP_INTERNAL_ERROR);
+    return (IPP_STATUS_ERROR_INTERNAL);
 
   if (!http)
     http = _cupsConnect();
 
   if (!http)
-    return (IPP_SERVICE_UNAVAILABLE);
+    return (IPP_STATUS_ERROR_SERVICE_UNAVAILABLE);
 
  /*
   * Create a CUPS-Get-Devices request...
   */
 
-  request = ippNewRequest(CUPS_GET_DEVICES);
+  request = ippNewRequest(IPP_OP_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";
@@ -95,55 +102,57 @@ cupsGetDevices(
 
   do
   {
-    DEBUG_puts("cupsGetDevices: Sending request...");
+    DEBUG_puts("2cupsGetDevices: Sending request...");
     status = cupsSendRequest(http, request, "/", ippLength(request));
 
-    DEBUG_puts("cupsGetDevices: Waiting for response status...");
-    while (status == HTTP_CONTINUE)
+    DEBUG_puts("2cupsGetDevices: Waiting for response status...");
+    while (status == HTTP_STATUS_CONTINUE)
       status = httpUpdate(http);
 
-    if (status != HTTP_OK)
+    if (status != HTTP_STATUS_OK)
     {
       httpFlush(http);
 
-      if (status == HTTP_UNAUTHORIZED)
+      if (status == HTTP_STATUS_UNAUTHORIZED)
       {
        /*
        * See if we can do authentication...
        */
 
-       int auth_result;
-
-       DEBUG_puts("cupsGetDevices: Need authorization...");
+       DEBUG_puts("2cupsGetDevices: Need authorization...");
 
-       if ((auth_result = cupsDoAuthentication(http, "POST", "/")) == 0)
-         httpReconnect(http);
-       else if (auth_result < 0)
-         http->status = status = HTTP_FORBIDDEN;
+       if (!cupsDoAuthentication(http, "POST", "/"))
+         httpReconnect2(http, 30000, NULL);
+       else
+       {
+         status = HTTP_STATUS_CUPS_AUTHORIZATION_CANCELED;
+         break;
+       }
       }
 
 #ifdef HAVE_SSL
-      else if (status == HTTP_UPGRADE_REQUIRED)
+      else if (status == HTTP_STATUS_UPGRADE_REQUIRED)
       {
        /*
        * Force a reconnect with encryption...
        */
 
-       DEBUG_puts("cupsGetDevices: Need encryption...");
+       DEBUG_puts("2cupsGetDevices: Need encryption...");
 
-       if (!httpReconnect(http))
-         httpEncryption(http, HTTP_ENCRYPT_REQUIRED);
+       if (!httpReconnect2(http, 30000, NULL))
+         httpEncryption(http, HTTP_ENCRYPTION_REQUIRED);
       }
 #endif /* HAVE_SSL */
     }
   }
-  while (status == HTTP_UNAUTHORIZED || status == HTTP_UPGRADE_REQUIRED);
+  while (status == HTTP_STATUS_UNAUTHORIZED ||
+         status == HTTP_STATUS_UPGRADE_REQUIRED);
 
-  DEBUG_printf(("cupsGetDevices: status=%d\n", status));
+  DEBUG_printf(("2cupsGetDevices: status=%d", status));
 
   ippDelete(request);
 
-  if (status != HTTP_OK)
+  if (status != HTTP_STATUS_OK)
   {
     _cupsSetHTTPError(status);
     return (cupsLastError());
@@ -160,19 +169,19 @@ cupsGetDevices(
   device_class          = NULL;
   device_id             = NULL;
   device_info           = NULL;
+  device_location       = "";
   device_make_and_model = NULL;
   device_uri            = NULL;
   attr                  = NULL;
 
-  DEBUG_puts("cupsGetDevices: Reading response...");
+  DEBUG_puts("2cupsGetDevices: Reading response...");
 
   do
   {
-    if ((state = ippRead(http, response)) == IPP_ERROR)
+    if ((state = ippRead(http, response)) == IPP_STATE_ERROR)
       break;
 
-    DEBUG_printf(("cupsGetDevices: state=%d, response->last=%p\n", state,
-                  response->last));
+    DEBUG_printf(("2cupsGetDevices: state=%d, response->last=%p", state, (void *)response->last));
 
     if (!response->attrs)
       continue;
@@ -184,19 +193,21 @@ cupsGetDevices(
       else
         attr = attr->next;
 
-      DEBUG_printf(("cupsGetDevices: attr->name=\"%s\", attr->value_tag=%d\n",
-                    attr->name ? attr->name : "(null)", attr->value_tag));
+      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, user_data);
+                     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;
       }
@@ -209,6 +220,9 @@ cupsGetDevices(
       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;
@@ -217,43 +231,38 @@ cupsGetDevices(
         device_uri = attr->values[0].string.text;
     }
   }
-  while (state != IPP_DATA);
+  while (state != IPP_STATE_DATA);
 
-  DEBUG_printf(("cupsGetDevices: state=%d, response->last=%p\n", state,
-               response->last));
+  DEBUG_printf(("2cupsGetDevices: state=%d, response->last=%p", state, (void *)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, user_data);
+               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);
+  if (status == HTTP_STATUS_ERROR)
+    _cupsSetError(IPP_STATUS_ERROR_INTERNAL, strerror(http->error), 0);
   else
   {
     attr = ippFindAttribute(response, "status-message", IPP_TAG_TEXT);
 
-    DEBUG_printf(("cupsGetDevices: status-code=%s, status-message=\"%s\"\n",
+    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));
+                 attr ? attr->values[0].string.text :
+                     ippErrorString(response->request.status.status_code), 0);
   }
 
   ippDelete(response);
 
   return (cupsLastError());
 }
-
-
-/*
- * End of "$Id$".
- */