Blame SOURCES/cups-failover-backend.patch

edc0eb
diff --git a/backend/Makefile b/backend/Makefile
edc0eb
index 3038682..6642016 100644
edc0eb
--- a/backend/Makefile
edc0eb
+++ b/backend/Makefile
edc0eb
@@ -28,6 +28,7 @@ include ../Makedefs
edc0eb
 RBACKENDS =	\
edc0eb
 		ipp \
edc0eb
 		lpd \
edc0eb
+		failover \
edc0eb
 		$(DNSSD_BACKEND)
edc0eb
 UBACKENDS =	\
edc0eb
 		snmp \
edc0eb
@@ -51,6 +52,7 @@ LIBOBJS	=	\
edc0eb
 OBJS	=	\
edc0eb
 		ipp.o \
edc0eb
 		lpd.o \
edc0eb
+		failover.o \
edc0eb
 		dnssd.o \
edc0eb
 		snmp.o \
edc0eb
 		socket.o \
edc0eb
@@ -275,6 +277,13 @@ lpd:	lpd.o ../cups/$(LIBCUPS) libbackend.a
edc0eb
 	echo Linking $@...
edc0eb
 	$(LD_CC) $(LDFLAGS) -o lpd lpd.o libbackend.a $(LIBS)
edc0eb
 
edc0eb
+#
edc0eb
+# failover
edc0eb
+#
edc0eb
+
edc0eb
+failover:	failover.o ../cups/$(LIBCUPS) libbackend.a
edc0eb
+	echo Linking $@...
edc0eb
+	$(LD_CC) $(LDFLAGS) -o failover failover.o libbackend.a $(LIBS)
edc0eb
 
edc0eb
 #
edc0eb
 # snmp
edc0eb
diff --git a/backend/failover.c b/backend/failover.c
edc0eb
new file mode 100644
edc0eb
index 0000000..9affd8f
edc0eb
--- /dev/null
edc0eb
+++ b/backend/failover.c
edc0eb
@@ -0,0 +1,837 @@
edc0eb
+/*
edc0eb
+ * Failover Backend for the Common UNIX Printing System (CUPS).
edc0eb
+ *
edc0eb
+ * Copyright (c) 2014, Red Hat, Inc.
edc0eb
+ * All rights reserved.
edc0eb
+ *
edc0eb
+ * Redistribution and use in source and binary forms, with or without
edc0eb
+ * modification, are permitted provided that the following conditions
edc0eb
+ * are met:
edc0eb
+ *
edc0eb
+ * * Redistributions of source code must retain the above copyright
edc0eb
+ *   notice, this list of conditions and the following disclaimer.
edc0eb
+ * * Redistributions in binary form must reproduce the above copyright
edc0eb
+ *   notice, this list of conditions and the following disclaimer in the
edc0eb
+ *   documentation and/or other materials provided with the distribution.
edc0eb
+ * * Neither the name of Red Hat, Inc. nor the names of its contributors
edc0eb
+ *   may be used to endorse or promote products derived from this software
edc0eb
+ *   without specific prior written permission.
edc0eb
+ *
edc0eb
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
edc0eb
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
edc0eb
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
edc0eb
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT,
edc0eb
+ * INC.  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
edc0eb
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
edc0eb
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
edc0eb
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
edc0eb
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
edc0eb
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
edc0eb
+ * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
edc0eb
+ * DAMAGE.
edc0eb
+ *
edc0eb
+ * Original version by Clark Hale, Red Hat, Inc.
edc0eb
+ *
edc0eb
+ * This backend presents a fake printer that will choose the first
edc0eb
+ * available printer from a list of IPP URIs.
edc0eb
+ *
edc0eb
+ * Option failover contains a comma separated list of IPP URIs.  The
edc0eb
+ * URIs are attempted in-order.
edc0eb
+ *
edc0eb
+ * Option failover-retries contains an integer that indicates how many
edc0eb
+ * times to iterate through the failover list before completely
edc0eb
+ * failing.
edc0eb
+ *
edc0eb
+ * Contents:
edc0eb
+ *   main()                   - Checks each printer in a failover list, and
edc0eb
+ *                              sends job data to the first available printer
edc0eb
+ *   move_job()               - Sends and IPP Move-Job request
edc0eb
+ *   check_printer()          - Checks a printer's attributes to see
edc0eb
+ *                              if it's enabled and accepting jobs
edc0eb
+ *   read_config()            - Read the backends configuration from
edc0eb
+ *                              options
edc0eb
+ *   get_printer_attributes() - Sends an IPP Get-Attributes request to
edc0eb
+ *                              a URI
edc0eb
+ *   sigterm_handler()        - Handle SIGTERM that cancels the job
edc0eb
+ *   password_cb()            - Password call back used to disable password
edc0eb
+ *                              prompt
edc0eb
+ */
edc0eb
+#include <stdlib.h>
edc0eb
+#include <stdio.h>
edc0eb
+#include <string.h>
edc0eb
+#include <sys/wait.h>
edc0eb
+#include <cups/http-private.h>
edc0eb
+#include <cups/http.h>
edc0eb
+#include "backend-private.h"
edc0eb
+
edc0eb
+/*
edc0eb
+ * Return Values
edc0eb
+ */
edc0eb
+typedef enum fo_state_e
edc0eb
+{
edc0eb
+  FO_PRINTER_GOOD = 0,
edc0eb
+  FO_PRINTER_BAD,
edc0eb
+  FO_PRINTER_BUSY,
edc0eb
+  FO_AUTH_REQUIRED
edc0eb
+} fo_state_t;
edc0eb
+
edc0eb
+/*
edc0eb
+ * Constants
edc0eb
+ */
edc0eb
+#define FAILOVER_DEFAULT_RETRIES        (3)
edc0eb
+#define FAILOVER_PASSWORD_RETRIES_MAX   (3)
edc0eb
+
edc0eb
+/*
edc0eb
+ * Local Functions
edc0eb
+ */
edc0eb
+static       int   check_printer(const char *device_uri);
edc0eb
+static       int   read_config(cups_array_t *printer_array, int *retries,
edc0eb
+                               const char *options);
edc0eb
+static       int   get_printer_attributes(const char *device_uri,
edc0eb
+                                          ipp_t **attributes);
edc0eb
+static       int   move_job(int jobid, const char *dest);
edc0eb
+static       void  sigterm_handler(int sig);
edc0eb
+static const char *password_cb(const char *);
edc0eb
+
edc0eb
+/*
edc0eb
+ * Global Variables
edc0eb
+ */
edc0eb
+static int         job_canceled = 0;     /* Job canceled */
edc0eb
+static char       *password = NULL;      /* password for device */
edc0eb
+static int         password_retries = 0;
edc0eb
+static const char *auth_info_required = "none";
edc0eb
+
edc0eb
+/*
edc0eb
+ * 'main()' - Checks each printer in a failover list, and
edc0eb
+ *            sends job data to the first available printer
edc0eb
+ * Usage:
edc0eb
+ *    printer-uri job-id user title copies options [file]
edc0eb
+ *
edc0eb
+ *    The printer-uri option is not used, but it still required to fit
edc0eb
+ *    to the backend(7) standards.
edc0eb
+ */
edc0eb
+int
edc0eb
+main(int argc, char *argv[])
edc0eb
+{
edc0eb
+  const char   *selected_uri = NULL;      /* URI of selected printer     */
edc0eb
+  const char   *tmp_device_uri;           /* Device URI to check         */
edc0eb
+  cups_array_t *printer_array;            /* Array of available printers */
edc0eb
+  int           printer_count = 0;        /* current printer array index */
edc0eb
+  int           retry_max = 1;            /* maximum retries before exit */
edc0eb
+  int           retry_count = 0;          /* current retry number        */
edc0eb
+  int           auth_failed_count = 0;    /* auth failures per loop      */
edc0eb
+  int           rc = CUPS_BACKEND_OK;
edc0eb
+#if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
edc0eb
+  struct        sigaction action;       /* Actions for POSIX signals */
edc0eb
+#endif /* HAVE_SIGACTION && !HAVE_SIGSET */
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Check args
edc0eb
+  */
edc0eb
+  if (argc == 1)
edc0eb
+  {
edc0eb
+   /*
edc0eb
+    * print out discovery data
edc0eb
+    */
edc0eb
+    char *backendName;
edc0eb
+
edc0eb
+    if ((backendName = strrchr(argv[0], '/')) != NULL)
edc0eb
+      backendName++;
edc0eb
+    else
edc0eb
+      backendName = argv[0];
edc0eb
+
edc0eb
+    _cupsLangPrintf(stderr,"network %s \"Unknown\" \"%s (%s)\"\n",
edc0eb
+                    backendName,
edc0eb
+                    _cupsLangString(cupsLangDefault(), _("Failover Printer")),
edc0eb
+                    backendName);
edc0eb
+
edc0eb
+    return (CUPS_BACKEND_OK);
edc0eb
+  }
edc0eb
+  else if (argc < 6)
edc0eb
+  {
edc0eb
+    _cupsLangPrintf(stderr,
edc0eb
+                    _("Usage: %s job-id user title copies options [file]"),
edc0eb
+                    argv[0]);
edc0eb
+    return (CUPS_BACKEND_STOP);
edc0eb
+  }
edc0eb
+
edc0eb
+  fprintf(stderr, "DEBUG: Failover backend starting up.\n");
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Don't buffer status messages
edc0eb
+  */
edc0eb
+  setbuf(stderr, NULL);
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Ignore SIGPIPE and catch SIGTERM signals...
edc0eb
+  */
edc0eb
+#ifdef HAVE_SIGSET
edc0eb
+  sigset(SIGPIPE, SIG_IGN);
edc0eb
+  sigset(SIGTERM, sigterm_handler);
edc0eb
+#elif defined(HAVE_SIGACTION)
edc0eb
+  memset(&action, 0, sizeof(action));
edc0eb
+  action.sa_handler = SIG_IGN;
edc0eb
+  sigaction(SIGPIPE, &action, NULL);
edc0eb
+
edc0eb
+  sigemptyset(&action.sa_mask);
edc0eb
+  sigaddset(&action.sa_mask, SIGTERM);
edc0eb
+  action.sa_handler = sigterm_handler;
edc0eb
+  sigaction(SIGTERM, &action, NULL);
edc0eb
+#else
edc0eb
+  signal(SIGPIPE, SIG_IGN);
edc0eb
+  signal(SIGTERM, sigterm_handler);
edc0eb
+#endif /* HAVE_SIGSET */
edc0eb
+
edc0eb
+  printer_array = cupsArrayNew(NULL, NULL);
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Read Configuration
edc0eb
+  */
edc0eb
+  if ((rc = read_config(printer_array, &retry_max,
edc0eb
+                        argv[5])) != CUPS_BACKEND_OK)
edc0eb
+  {
edc0eb
+    fprintf(stderr, "ERROR: Failed to read configuration options!\n");
edc0eb
+    goto cleanup;
edc0eb
+  }
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Main Retry Loop
edc0eb
+  */
edc0eb
+  for (retry_count = 0; retry_count < retry_max; retry_count++)
edc0eb
+  {
edc0eb
+    fprintf(stderr, "DEBUG: Retry loop #%d\n", retry_count + 1);
edc0eb
+
edc0eb
+   /*
edc0eb
+    * Reset Counters
edc0eb
+    */
edc0eb
+    printer_count = 0;
edc0eb
+    auth_failed_count = 0;
edc0eb
+
edc0eb
+    tmp_device_uri = (char *)cupsArrayFirst(printer_array);
edc0eb
+
edc0eb
+    do
edc0eb
+    {
edc0eb
+      if (job_canceled)
edc0eb
+      {
edc0eb
+        fprintf(stderr, "DEBUG: Job Canceled\n");
edc0eb
+        goto cleanup;
edc0eb
+      }
edc0eb
+
edc0eb
+      fprintf(stderr,"DEBUG: Checking printer #%d: %s\n",
edc0eb
+              printer_count+1, tmp_device_uri);
edc0eb
+
edc0eb
+      rc = check_printer(tmp_device_uri);
edc0eb
+
edc0eb
+      // Printer is available and not busy.
edc0eb
+      if ( rc == FO_PRINTER_GOOD )
edc0eb
+      {
edc0eb
+        selected_uri = tmp_device_uri;
edc0eb
+        break;
edc0eb
+      }
edc0eb
+      // Printer is busy
edc0eb
+      else if (rc == FO_PRINTER_BUSY)
edc0eb
+      {
edc0eb
+        fprintf(stderr, "DEBUG: Waiting for job to complete.\n");
edc0eb
+        sleep(2);
edc0eb
+        continue;
edc0eb
+      }
edc0eb
+      // Authorization is required to access the printer.
edc0eb
+      else if (rc == FO_AUTH_REQUIRED)
edc0eb
+      {
edc0eb
+        auth_failed_count++;
edc0eb
+        fprintf(stderr, "DEBUG: auth_failed_count = %d\n", auth_failed_count);
edc0eb
+      }
edc0eb
+      // Printer is stopped or not accepting jobs
edc0eb
+      else
edc0eb
+      {
edc0eb
+        if (!printer_count)
edc0eb
+          fprintf(stderr, "INFO: Primary Printer, %s, not available.  "
edc0eb
+                  "Attempting Failovers...\n",
edc0eb
+                  tmp_device_uri);
edc0eb
+        else
edc0eb
+          fprintf(stderr, "INFO: Failover Printer, %s, not available.  "
edc0eb
+                  "Attempting Failovers..\n",
edc0eb
+                  tmp_device_uri);
edc0eb
+        printer_count++;
edc0eb
+        tmp_device_uri = (char *)cupsArrayNext(printer_array);
edc0eb
+      }
edc0eb
+    } while (tmp_device_uri != NULL);
edc0eb
+
edc0eb
+    if (selected_uri && !printer_count)
edc0eb
+      fprintf(stderr, "STATE: -primary-printer-failed\n");
edc0eb
+    else
edc0eb
+      fprintf(stderr, "STATE: +primary-printer-failed\n");
edc0eb
+
edc0eb
+    if (job_canceled)
edc0eb
+    {
edc0eb
+      fprintf(stderr, "DEBUG: Job Canceled\n");
edc0eb
+      goto cleanup;
edc0eb
+    }
edc0eb
+
edc0eb
+    if (!selected_uri && auth_failed_count == printer_count)
edc0eb
+    {
edc0eb
+      fprintf(stderr, "ERROR:  All failover printers failed with "
edc0eb
+              "authorization issues.\n");
edc0eb
+      rc = CUPS_BACKEND_AUTH_REQUIRED;
edc0eb
+      fprintf(stderr, "ATTR: auth-info-required=%s\n", auth_info_required);
edc0eb
+      goto cleanup;
edc0eb
+    }
edc0eb
+    else if (!selected_uri && retry_count + 1 < retry_max)
edc0eb
+    {
edc0eb
+      fprintf(stderr, "INFO: No suitable printer found...retrying...\n");
edc0eb
+      sleep(2);
edc0eb
+      continue;
edc0eb
+    }
edc0eb
+    else if (selected_uri)
edc0eb
+    {
edc0eb
+      fprintf(stderr, "DEBUG: Using printer, %s.\n", selected_uri);
edc0eb
+      break;
edc0eb
+    }
edc0eb
+  }
edc0eb
+
edc0eb
+  if (!selected_uri)
edc0eb
+  {
edc0eb
+    fprintf(stderr, "ERROR: No suitable printer found.  Aborting print\n");
edc0eb
+    rc = CUPS_BACKEND_FAILED;
edc0eb
+    goto cleanup;
edc0eb
+  }
edc0eb
+
edc0eb
+  rc = move_job(atoi(argv[1]), selected_uri);
edc0eb
+
edc0eb
+  if (job_canceled)
edc0eb
+    rc = CUPS_BACKEND_OK;
edc0eb
+
edc0eb
+cleanup :
edc0eb
+  if (job_canceled)
edc0eb
+    rc = CUPS_BACKEND_OK;
edc0eb
+
edc0eb
+  tmp_device_uri = (char *)cupsArrayFirst(printer_array);
edc0eb
+  do
edc0eb
+  {
edc0eb
+    free((void *)tmp_device_uri);
edc0eb
+  } while ((tmp_device_uri = (char *)cupsArrayNext(printer_array)) != NULL);
edc0eb
+
edc0eb
+  cupsArrayDelete(printer_array);
edc0eb
+  sleep(2);
edc0eb
+  return (rc);
edc0eb
+}
edc0eb
+
edc0eb
+/*
edc0eb
+ * 'check_printer()' - Checks the status of a remote printer and returns
edc0eb
+ *                     back a good/bad/busy status.
edc0eb
+ */
edc0eb
+int
edc0eb
+check_printer(const char *device_uri)
edc0eb
+{
edc0eb
+  ipp_t           *attributes = NULL;     /* attributes for device_uri */
edc0eb
+  ipp_attribute_t *tmp_attribute;         /* for examining attribs     */
edc0eb
+  int              rc = FO_PRINTER_GOOD;  /* return code               */
edc0eb
+  char            *reason;                /* printer state reason */
edc0eb
+  int              i;
edc0eb
+
edc0eb
+  fprintf(stderr, "DEBUG: Checking printer %s\n",device_uri);
edc0eb
+
edc0eb
+  rc = get_printer_attributes(device_uri, &attributes);
edc0eb
+  if ( rc != CUPS_BACKEND_OK )
edc0eb
+  {
edc0eb
+    fprintf(stderr, "DEBUG: Failed to get attributes from printer: %s\n",
edc0eb
+            device_uri);
edc0eb
+    if ( rc == CUPS_BACKEND_AUTH_REQUIRED )
edc0eb
+      return (FO_AUTH_REQUIRED);
edc0eb
+    else
edc0eb
+      return (FO_PRINTER_BAD);
edc0eb
+  }
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Check if printer is accepting jobs
edc0eb
+  */
edc0eb
+  if ((tmp_attribute = ippFindAttribute(attributes,
edc0eb
+                                        "printer-is-accepting-jobs",
edc0eb
+                                        IPP_TAG_BOOLEAN)) != NULL &&
edc0eb
+      !tmp_attribute->values[0].boolean)
edc0eb
+  {
edc0eb
+    fprintf(stderr,
edc0eb
+            "DEBUG: Printer, %s, is not accepting jobs.\n",
edc0eb
+            device_uri);
edc0eb
+
edc0eb
+    rc = FO_PRINTER_BAD;
edc0eb
+  }
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Check if printer is stopped or busy processing
edc0eb
+  */
edc0eb
+  if ((tmp_attribute = ippFindAttribute(attributes,
edc0eb
+                                        "printer-state",
edc0eb
+                                        IPP_TAG_ENUM)) != NULL)
edc0eb
+  {
edc0eb
+    // Printer Stopped
edc0eb
+    if ( tmp_attribute->values[0].integer == IPP_PRINTER_STOPPED )
edc0eb
+    {
edc0eb
+      fprintf(stderr, "DEBUG: Printer, %s, stopped.\n", device_uri);
edc0eb
+      rc = FO_PRINTER_BAD;
edc0eb
+    }
edc0eb
+    // Printer Busy
edc0eb
+    else if ( tmp_attribute->values[0].integer == IPP_PRINTER_PROCESSING )
edc0eb
+    {
edc0eb
+      fprintf(stderr, "DEBUG: Printer %s is busy.\n", device_uri);
edc0eb
+      rc = FO_PRINTER_BUSY;
edc0eb
+    }
edc0eb
+  }
edc0eb
+
edc0eb
+  /*
edc0eb
+   * Parse through the printer-state-reasons
edc0eb
+   */
edc0eb
+  if ((tmp_attribute = ippFindAttribute(attributes, "printer-state-reasons",
edc0eb
+                                        IPP_TAG_KEYWORD)) != NULL)
edc0eb
+  {
edc0eb
+    for (i = 0; i < tmp_attribute->num_values; i++)
edc0eb
+    {
edc0eb
+      reason = tmp_attribute->values[i].string.text;
edc0eb
+      int len = strlen(reason);
edc0eb
+
edc0eb
+      if (len > 8 && !strcmp(reason + len - 8, "-warning"))
edc0eb
+      {
edc0eb
+        fprintf(stderr, "DEBUG: Printer Supply Warning, %s\n", reason);
edc0eb
+        rc = FO_PRINTER_BAD;
edc0eb
+      }
edc0eb
+      else if (len > 6 && !strcmp(reason + len - 6, "-error"))
edc0eb
+      {
edc0eb
+        fprintf(stderr, "DEBUG: Printer Supply Error, %s\n", reason);
edc0eb
+        rc = FO_PRINTER_BAD;
edc0eb
+      }
edc0eb
+    }
edc0eb
+  }
edc0eb
+
edc0eb
+  return (rc);
edc0eb
+}
edc0eb
+
edc0eb
+/*
edc0eb
+ * 'read_config()' - Parses the failover and failover-retries options
edc0eb
+ *
edc0eb
+ */
edc0eb
+static int
edc0eb
+read_config(cups_array_t *printer_array, int *retries, const char *options)
edc0eb
+{
edc0eb
+
edc0eb
+  const char    *tmp;                   /* temporary ptr                     */
edc0eb
+  char          *tok_tmp;               /* temporary ptr for option  parsing */
edc0eb
+  int            jobopts_count = 0;     /* number of options                 */
edc0eb
+  cups_option_t *jobopts = NULL;        /* job options                       */
edc0eb
+
edc0eb
+
edc0eb
+  fprintf(stderr, "DEBUG: Reading Configuration.\n");
edc0eb
+  jobopts_count = cupsParseOptions(options, 0, &jobopts);
edc0eb
+
edc0eb
+  if (!jobopts_count)
edc0eb
+  {
edc0eb
+    fprintf(stderr,
edc0eb
+            "ERROR: No job options!  Cannot find failover options!\n");
edc0eb
+    return (CUPS_BACKEND_STOP);
edc0eb
+  }
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Get attributes from the primary printer
edc0eb
+  */
edc0eb
+  fprintf(stderr, "DEBUG: Searching for failover option.\n");
edc0eb
+
edc0eb
+  if ((tmp = cupsGetOption("failover", jobopts_count, jobopts)) != NULL)
edc0eb
+  {
edc0eb
+    fprintf(stderr, "DEBUG: Failover option contents: %s.\n", tmp);
edc0eb
+
edc0eb
+    tok_tmp = strdup(tmp);
edc0eb
+
edc0eb
+    tmp = strtok(tok_tmp, ",");
edc0eb
+    do
edc0eb
+    {
edc0eb
+      cupsArrayAdd(printer_array, strdup(tmp));
edc0eb
+    } while ((tmp = strtok(NULL,",")) != NULL);
edc0eb
+
edc0eb
+    free(tok_tmp);
edc0eb
+  }
edc0eb
+  else
edc0eb
+  {
edc0eb
+   /*
edc0eb
+    * The queue is misconfigured, so return back CUPS_BACKEND_STOP
edc0eb
+    */
edc0eb
+    fprintf(stderr, "ERROR: failover option not specified!\n");
edc0eb
+    return (CUPS_BACKEND_STOP);
edc0eb
+  }
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Get the failover-retries value, if it exists.
edc0eb
+  */
edc0eb
+  fprintf(stderr, "DEBUG: Searching for failover-retries option.\n");
edc0eb
+
edc0eb
+  if ((tmp = cupsGetOption("failover-retries",
edc0eb
+                           jobopts_count, jobopts)) != NULL)
edc0eb
+  {
edc0eb
+    fprintf(stderr, "DEBUG: failover-retries option contents: %s.\n", tmp);
edc0eb
+    *retries = atoi(tmp);
edc0eb
+  }
edc0eb
+  else
edc0eb
+  {
edc0eb
+    *retries = FAILOVER_DEFAULT_RETRIES;
edc0eb
+    fprintf(stderr, "DEBUG: Failed to get failover-retries option\n");
edc0eb
+    fprintf(stderr, "DEBUG: Defaulted to %d retries\n", *retries);
edc0eb
+  }
edc0eb
+
edc0eb
+  return (CUPS_BACKEND_OK);
edc0eb
+}
edc0eb
+
edc0eb
+/*
edc0eb
+ * 'get_printer_attributes()' - Sends an IPP Get-Attributes request to
edc0eb
+ *                              a URI
edc0eb
+ */
edc0eb
+int
edc0eb
+get_printer_attributes(const char *device_uri, ipp_t **attributes)
edc0eb
+{
edc0eb
+  char               uri[HTTP_MAX_URI];         /* Updated URI without login */
edc0eb
+  int                version;                   /* IPP version */
edc0eb
+  char               scheme[256];               /* Scheme in URI */
edc0eb
+  ipp_status_t       ipp_status;                /* Status of IPP request */
edc0eb
+  char               hostname[1024];            /* Hostname */
edc0eb
+  char               resource[1024];            /* Resource infoo */
edc0eb
+  char               addrname[256];             /* Address name */
edc0eb
+  int                port;                      /* IPP Port number */
edc0eb
+  char               portname[255];             /* Port as string */
edc0eb
+  http_t            *http;                      /* HTTP connection */
edc0eb
+  ipp_t             *request;                   /* IPP request */
edc0eb
+  int                rc = CUPS_BACKEND_OK;      /* Return Code */
edc0eb
+  char               username[256];             /* Username for device URI */
edc0eb
+  char              *option_ptr;                /* for parsing resource opts */
edc0eb
+  const char * const pattrs[] =                 /* Printer attributes wanted */
edc0eb
+    {
edc0eb
+      "printer-is-accepting-jobs",
edc0eb
+      "printer-state",
edc0eb
+      "printer-state-reasons"
edc0eb
+    };
edc0eb
+
edc0eb
+  if (job_canceled)
edc0eb
+    return (CUPS_BACKEND_OK);
edc0eb
+
edc0eb
+  fprintf(stderr, "DEBUG: Getting Printer Attributes.\n");
edc0eb
+  fprintf(stderr, "DEBUG: Device URL %s.\n", device_uri);
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Parse device_uri
edc0eb
+  */
edc0eb
+  if (httpSeparateURI(HTTP_URI_CODING_ALL, device_uri, scheme, sizeof(scheme),
edc0eb
+                     username, sizeof(username), hostname, sizeof(hostname),
edc0eb
+                     &port, resource, sizeof(resource)) != HTTP_URI_OK)
edc0eb
+  {
edc0eb
+    fprintf(stderr, "ERROR: Problem parsing device_uri, %s\n", device_uri);
edc0eb
+    return (CUPS_BACKEND_STOP);
edc0eb
+  }
edc0eb
+
edc0eb
+  if (!port)
edc0eb
+    port = IPP_PORT;
edc0eb
+
edc0eb
+  sprintf(portname, "%d", port);
edc0eb
+
edc0eb
+  fprintf(stderr, "DEBUG: Getting Printer Attributes.\n");
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Configure password
edc0eb
+  */
edc0eb
+  cupsSetPasswordCB(password_cb);
edc0eb
+
edc0eb
+ /*
edc0eb
+  * reset, in case a previous attempt for
edc0eb
+  * another printer left residue
edc0eb
+  */
edc0eb
+  cupsSetUser(NULL);
edc0eb
+  password = NULL;
edc0eb
+  password_retries = 0;
edc0eb
+
edc0eb
+  if (*username)
edc0eb
+  {
edc0eb
+    if ((password = strchr(username, ':')) != NULL)
edc0eb
+    {
edc0eb
+      *password = '\0';
edc0eb
+      password++;
edc0eb
+    }
edc0eb
+
edc0eb
+    cupsSetUser(username);
edc0eb
+  }
edc0eb
+  else if (!getuid())
edc0eb
+  {
edc0eb
+    const char *username_env;
edc0eb
+
edc0eb
+    if ((username_env = getenv("AUTH_USERNAME")) != NULL)
edc0eb
+    {
edc0eb
+      cupsSetUser(username_env);
edc0eb
+      password = getenv("AUTH_PASSWORD");
edc0eb
+    }
edc0eb
+  }
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Try connecting to the remote server...
edc0eb
+  */
edc0eb
+  fprintf(stderr, "DEBUG: Connecting to %s:%d\n", hostname, port);
edc0eb
+  _cupsLangPuts(stderr, _("INFO: Connecting to printer...\n"));
edc0eb
+
edc0eb
+  http = httpConnectEncrypt(hostname, port, cupsEncryption());
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Deal the socket not being open.
edc0eb
+  */
edc0eb
+  if (!http)
edc0eb
+  {
edc0eb
+    int error = errno;          /* Connection error */
edc0eb
+
edc0eb
+    switch (error)
edc0eb
+    {
edc0eb
+    case EHOSTDOWN :
edc0eb
+      _cupsLangPuts(stderr, _("WARNING: "
edc0eb
+                              "The printer may not exist or "
edc0eb
+                              "is unavailable at this time.\n"));
edc0eb
+      break;
edc0eb
+    case EHOSTUNREACH :
edc0eb
+      _cupsLangPuts(stderr, _("WARNING: "
edc0eb
+                              "The printer is unreachable at this "
edc0eb
+                              "time.\n"));
edc0eb
+      break;
edc0eb
+    case ECONNREFUSED :
edc0eb
+      _cupsLangPuts(stderr, _("WARNING: "
edc0eb
+                              "Connection Refused.\n"));
edc0eb
+      break;
edc0eb
+    default :
edc0eb
+      fprintf(stderr, "DEBUG: Connection error: %s\n", strerror(errno));
edc0eb
+      break;
edc0eb
+    }
edc0eb
+
edc0eb
+    rc = CUPS_BACKEND_FAILED;
edc0eb
+    sleep(5);
edc0eb
+    goto prt_available_cleanup;
edc0eb
+  }
edc0eb
+
edc0eb
+
edc0eb
+#ifdef AF_INET6
edc0eb
+  if (http->hostaddr->addr.sa_family == AF_INET6)
edc0eb
+    fprintf(stderr, "DEBUG: Connected to [%s]:%d (IPv6)...\n",
edc0eb
+            httpAddrString(http->hostaddr, addrname, sizeof(addrname)),
edc0eb
+            ntohs(http->hostaddr->ipv6.sin6_port));
edc0eb
+  else
edc0eb
+#endif /* AF_INET6 */
edc0eb
+  if (http->hostaddr->addr.sa_family == AF_INET)
edc0eb
+    fprintf(stderr, "DEBUG: Connected to %s:%d (IPv4)...\n",
edc0eb
+            httpAddrString(http->hostaddr, addrname, sizeof(addrname)),
edc0eb
+            ntohs(http->hostaddr->ipv4.sin_port));
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Search the resource string for options.
edc0eb
+  * We only care about version, for the moment.
edc0eb
+  */
edc0eb
+  version = 11;
edc0eb
+
edc0eb
+  if ((option_ptr = strchr(resource, '?')) != NULL)
edc0eb
+  {
edc0eb
+    *option_ptr++ = '\0';
edc0eb
+
edc0eb
+    if ((option_ptr = strstr(option_ptr, "version="))!=NULL)
edc0eb
+    {
edc0eb
+      int   minor;       /* minor version from URI */
edc0eb
+      int   major;       /* major version from URI */
edc0eb
+      char *version_str; /* ipp version */
edc0eb
+
edc0eb
+      option_ptr += 8;
edc0eb
+      version_str = option_ptr;
edc0eb
+
edc0eb
+      while (*option_ptr && *option_ptr != '&' && *option_ptr != '+')
edc0eb
+        option_ptr++;
edc0eb
+
edc0eb
+      if (*option_ptr)
edc0eb
+        *option_ptr = '\0';
edc0eb
+
edc0eb
+      sscanf(version_str, "%d.%d", &major, &minor);
edc0eb
+
edc0eb
+      version = (major * 10) + minor;
edc0eb
+
edc0eb
+      switch(version)
edc0eb
+      {
edc0eb
+      case 10 :
edc0eb
+      case 11 :
edc0eb
+      case 20 :
edc0eb
+      case 21 :
edc0eb
+        fprintf(stderr,
edc0eb
+                "DEBUG: Set version to %d from URI\n",
edc0eb
+                version);
edc0eb
+        break;
edc0eb
+      default :
edc0eb
+        _cupsLangPrintf(stderr,
edc0eb
+                        _("DEBUG: Invalid version, %d, from URI.  "
edc0eb
+                          "Using default of 1.1 \n"),
edc0eb
+                        version);
edc0eb
+        version = 11;
edc0eb
+      }
edc0eb
+    }
edc0eb
+  }
edc0eb
+
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Build a URI for the printer.  We can't use the URI in argv[0]
edc0eb
+  * because it might contain username:password information...
edc0eb
+  */
edc0eb
+  if (httpAssembleURI(HTTP_URI_CODING_ALL, uri, sizeof(uri), scheme, NULL,
edc0eb
+                      hostname, port, resource) != HTTP_URI_OK)
edc0eb
+  {
edc0eb
+    fprintf(stderr, "ERROR: Problem assembling printer URI from host %s, "
edc0eb
+            "port %d, resource %s\n", hostname, port, resource);
edc0eb
+    return (CUPS_BACKEND_STOP);
edc0eb
+  }
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Build the IPP request...
edc0eb
+  */
edc0eb
+  request = ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES);
edc0eb
+  request->request.op.version[0] = version / 10;
edc0eb
+  request->request.op.version[1] = version % 10;
edc0eb
+
edc0eb
+  ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
edc0eb
+               NULL, uri);
edc0eb
+
edc0eb
+  ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
edc0eb
+                "requested-attributes", sizeof(pattrs) / sizeof(pattrs[0]),
edc0eb
+                NULL, pattrs);
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Do the request...
edc0eb
+  */
edc0eb
+  fputs("DEBUG: Getting supported attributes...\n", stderr);
edc0eb
+
edc0eb
+  fprintf(stderr, "DEBUG: IPP Request Structure Built.\n");
edc0eb
+
edc0eb
+  *attributes = cupsDoRequest(http, request, resource);
edc0eb
+  ipp_status = cupsLastError();
edc0eb
+
edc0eb
+  fprintf(stderr, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
edc0eb
+          ippErrorString(ipp_status), cupsLastErrorString());
edc0eb
+
edc0eb
+  if (ipp_status > IPP_OK_CONFLICT)
edc0eb
+  {
edc0eb
+    fprintf(stderr, "DEBUG: Get-Printer-Attributes returned %s.\n",
edc0eb
+            ippErrorString(ipp_status));
edc0eb
+    switch(ipp_status)
edc0eb
+    {
edc0eb
+    case IPP_FORBIDDEN :
edc0eb
+    case IPP_NOT_AUTHORIZED :
edc0eb
+      _cupsLangPuts(stderr, _("ERROR: Not Authorized.\n"));
edc0eb
+      rc = CUPS_BACKEND_AUTH_REQUIRED;
edc0eb
+      break;
edc0eb
+    case IPP_PRINTER_BUSY :
edc0eb
+    case IPP_SERVICE_UNAVAILABLE :
edc0eb
+      _cupsLangPuts(stderr, _("ERROR: "
edc0eb
+                              "The printer is not responding.\n"));
edc0eb
+      rc = CUPS_BACKEND_FAILED;
edc0eb
+      break;
edc0eb
+    case IPP_BAD_REQUEST :
edc0eb
+    case IPP_VERSION_NOT_SUPPORTED :
edc0eb
+      fprintf(stderr, "ERROR: Destination does not support IPP version %d\n",
edc0eb
+              version);
edc0eb
+    case IPP_NOT_FOUND :
edc0eb
+      _cupsLangPuts(stderr, _("ERROR: "
edc0eb
+                              "The printer configuration is incorrect or the "
edc0eb
+                              "printer no longer exists.\n"));
edc0eb
+      rc = CUPS_BACKEND_STOP;
edc0eb
+      break;
edc0eb
+    default :
edc0eb
+      rc = CUPS_BACKEND_FAILED;
edc0eb
+    }
edc0eb
+    goto prt_available_cleanup;
edc0eb
+  }
edc0eb
+
edc0eb
+prt_available_cleanup :
edc0eb
+  httpClose(http);
edc0eb
+  return (rc);
edc0eb
+}
edc0eb
+
edc0eb
+static int
edc0eb
+move_job(int        jobid,              /* Job ID */
edc0eb
+         const char *dest)              /* Destination ipp address */
edc0eb
+{
edc0eb
+  ipp_t *request;                       /* IPP Request */
edc0eb
+  char  job_uri[HTTP_MAX_URI];          /* job-uri */
edc0eb
+
edc0eb
+  http_t* http = httpConnectEncrypt(cupsServer(), ippPort(), cupsEncryption());
edc0eb
+
edc0eb
+  if (!http)
edc0eb
+  {
edc0eb
+    _cupsLangPrintf(stderr,
edc0eb
+                    _("failover: Unable to connect to server: %s\n"),
edc0eb
+                    strerror(errno));
edc0eb
+    return (CUPS_BACKEND_FAILED);
edc0eb
+  }
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Build a CUPS_MOVE_JOB request, which requires the following
edc0eb
+  * attributes:
edc0eb
+  *
edc0eb
+  *    job-uri/printer-uri
edc0eb
+  *    job-printer-uri
edc0eb
+  *    requesting-user-name
edc0eb
+  */
edc0eb
+
edc0eb
+  request = ippNewRequest(CUPS_MOVE_JOB);
edc0eb
+
edc0eb
+  snprintf(job_uri, sizeof(job_uri), "ipp://localhost/jobs/%d", jobid);
edc0eb
+  ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "job-uri", NULL,
edc0eb
+               job_uri);
edc0eb
+
edc0eb
+  ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
edc0eb
+               "requesting-user-name",
edc0eb
+               NULL, cupsUser());
edc0eb
+
edc0eb
+  ippAddString(request, IPP_TAG_JOB, IPP_TAG_URI, "job-printer-uri",
edc0eb
+               NULL, dest);
edc0eb
+
edc0eb
+ /*
edc0eb
+  * Do the request and get back a response...
edc0eb
+  */
edc0eb
+
edc0eb
+  ippDelete(cupsDoRequest(http, request, "/jobs"));
edc0eb
+
edc0eb
+  httpClose(http);
edc0eb
+
edc0eb
+  if (cupsLastError() > IPP_OK_CONFLICT)
edc0eb
+  {
edc0eb
+    _cupsLangPrintf(stderr, "failover: %s\n", cupsLastErrorString());
edc0eb
+    return (CUPS_BACKEND_FAILED);
edc0eb
+  }
edc0eb
+  else
edc0eb
+    return (CUPS_BACKEND_OK);
edc0eb
+}
edc0eb
+
edc0eb
+/*
edc0eb
+ * 'sigterm_handler()' - handles a sigterm, i.e. job canceled
edc0eb
+ */
edc0eb
+static void
edc0eb
+sigterm_handler(int sig)
edc0eb
+{
edc0eb
+  if (!job_canceled)
edc0eb
+  {
edc0eb
+    write(2, "DEBUG: Got SIGTERM.\n", 20);
edc0eb
+    job_canceled = 1;
edc0eb
+  }
edc0eb
+  else
edc0eb
+  {
edc0eb
+   /*
edc0eb
+    * Job has already been canceled, so just exit
edc0eb
+    */
edc0eb
+    exit(1);
edc0eb
+  }
edc0eb
+}
edc0eb
+
edc0eb
+/*
edc0eb
+ * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
edc0eb
+ */
edc0eb
+static const char *                     /* O - Password  */
edc0eb
+password_cb(const char *prompt)         /* I - Prompt (not used) */
edc0eb
+{
edc0eb
+  auth_info_required = "username,password";
edc0eb
+  password_retries++;
edc0eb
+
edc0eb
+  if(password_retries < FAILOVER_PASSWORD_RETRIES_MAX)
edc0eb
+    return (password);
edc0eb
+  else
edc0eb
+    return (NULL);
edc0eb
+}