]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - backend/socket.c
Import CUPS 1.4svn r7023 into easysw/current.
[thirdparty/cups.git] / backend / socket.c
index 93a5f76bfb1d96ccfc241b23920d02aeab6365f6..5d66a160616bbbe92c67d48c898a1cb98e58ec7f 100644 (file)
@@ -1,31 +1,24 @@
 /*
- * "$Id$"
+ * "$Id: socket.c 6910 2007-09-04 20:34:29Z mike $"
  *
  *   AppSocket backend for the Common UNIX Printing System (CUPS).
  *
- *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
+ *   Copyright 2007 by Apple Inc.
+ *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
  *
  *   These coded instructions, statements, and computer programs are the
- *   property of Easy Software Products and are protected by Federal
- *   copyright law.  Distribution and use rights are outlined in the file
+ *   property of Apple Inc. and are protected by Federal copyright
+ *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  *   "LICENSE" which should have been included with this file.  If this
- *   file is missing or damaged please contact Easy Software Products
- *   at:
- *
- *       Attn: CUPS Licensing Information
- *       Easy Software Products
- *       44141 Airport View Drive, Suite 204
- *       Hollywood, Maryland 20636 USA
- *
- *       Voice: (301) 373-9600
- *       EMail: cups-info@cups.org
- *         WWW: http://www.cups.org
+ *   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:
  *
- *   main() - Send a file to the printer or server.
+ *   main()    - Send a file to the printer or server.
+ *   side_cb() - Handle side-channel requests...
+ *   wait_bc() - Wait for back-channel data...
  */
 
 /*
 #endif /* WIN32 */
 
 
+/*
+ * Local functions...
+ */
+
+static void    side_cb(int print_fd, int device_fd, int use_bc);
+static int     wait_bc(int device_fd, int secs);
+
+
 /*
  * 'main()' - Send a file to the printer or server.
  *
@@ -67,22 +68,24 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
                username[255],          /* Username info (not used) */
                resource[1024],         /* Resource info (not used) */
                *options,               /* Pointer to options */
-               name[255],              /* Name of option */
-               value[255],             /* Value of option */
-               *ptr;                   /* Pointer into name or value */
+               *name,                  /* Name of option */
+               *value,                 /* Value of option */
+               sep;                    /* Option separator */
   int          print_fd;               /* Print file */
   int          copies;                 /* Number of copies to print */
+  time_t       start_time;             /* Time of first connect */
+  int          recoverable;            /* Recoverable error shown? */
+  int          contimeout;             /* Connection timeout */
   int          waiteof;                /* Wait for end-of-file? */
   int          port;                   /* Port number */
   char         portname[255];          /* Port name */
   int          delay;                  /* Delay for retries... */
   int          device_fd;              /* AppSocket */
   int          error;                  /* Error code (if any) */
-  http_addrlist_t *addrlist;           /* Address list */
+  http_addrlist_t *addrlist,           /* Address list */
+               *addr;                  /* Connected address */
+  char         addrname[256];          /* Address name */
   ssize_t      tbytes;                 /* Total number of bytes written */
-  struct timeval timeout;              /* Timeout for select() */
-  fd_set       input;                  /* Input set for select() */
-  ssize_t      bc_bytes;               /* Number of back-channel bytes read */
 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
   struct sigaction action;             /* Actions for POSIX signals */
 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
@@ -119,8 +122,9 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
   }
   else if (argc < 6 || argc > 7)
   {
-    fprintf(stderr, "Usage: %s job-id user title copies options [file]\n",
-            argv[0]);
+    _cupsLangPrintf(stderr,
+                    _("Usage: %s job-id user title copies options [file]\n"),
+                    argv[0]);
     return (CUPS_BACKEND_FAILED);
   }
 
@@ -165,7 +169,8 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
   * Get options, if any...
   */
 
-  waiteof = 1;
+  waiteof    = 1;
+  contimeout = 7 * 24 * 60 * 60;
 
   if ((options = strchr(resource, '?')) != NULL)
   {
@@ -186,29 +191,30 @@ main(int  argc,                           /* I - Number of command-line arguments (6 or 7) */
       * Get the name...
       */
 
-      for (ptr = name; *options && *options != '=';)
-        if (ptr < (name + sizeof(name) - 1))
-          *ptr++ = *options++;
-      *ptr = '\0';
+      name = options;
+
+      while (*options && *options != '=' && *options != '+' && *options != '&')
+        options ++;
 
-      if (*options == '=')
+      if ((sep = *options) != '\0')
+        *options++ = '\0';
+
+      if (sep == '=')
       {
        /*
         * Get the value...
        */
 
-        options ++;
-
-       for (ptr = value; *options && *options != '+' && *options != '&';)
-          if (ptr < (value + sizeof(value) - 1))
-            *ptr++ = *options++;
-       *ptr = '\0';
+        value = options;
 
-       if (*options == '+' || *options == '&')
+       while (*options && *options != '+' && *options != '&')
          options ++;
+
+        if (*options)
+         *options++ = '\0';
       }
       else
-        value[0] = '\0';
+        value = (char *)"";
 
      /*
       * Process the option...
@@ -223,6 +229,15 @@ main(int  argc,                            /* I - Number of command-line arguments (6 or 7) */
         waiteof = !value[0] || !strcasecmp(value, "on") ||
                  !strcasecmp(value, "yes") || !strcasecmp(value, "true");
       }
+      else if (!strcasecmp(name, "contimeout"))
+      {
+       /*
+        * Set the connection timeout...
+       */
+
+       if (atoi(value) > 0)
+         contimeout = atoi(value);
+      }
     }
   }
 
@@ -230,22 +245,27 @@ main(int  argc,                           /* I - Number of command-line arguments (6 or 7) */
   * Then try to connect to the remote host...
   */
 
+  recoverable = 0;
+  start_time  = time(NULL);
+
   sprintf(portname, "%d", port);
 
   if ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
   {
-    fprintf(stderr, "ERROR: Unable to locate printer \'%s\'!\n", hostname);
+    _cupsLangPrintf(stderr, _("ERROR: Unable to locate printer \'%s\'!\n"),
+                    hostname);
     return (CUPS_BACKEND_STOP);
   }
 
-  fprintf(stderr, "INFO: Attempting to connect to host %s on port %d\n",
-          hostname, port);
+  _cupsLangPrintf(stderr,
+                  _("INFO: Attempting to connect to host %s on port %d\n"),
+                  hostname, port);
 
   fputs("STATE: +connecting-to-device\n", stderr);
 
   for (delay = 5;;)
   {
-    if (!httpAddrConnect(addrlist, &device_fd))
+    if ((addr = httpAddrConnect(addrlist, &device_fd)) == NULL)
     {
       error     = errno;
       device_fd = -1;
@@ -259,8 +279,9 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
        * available printer in the class.
        */
 
-        fprintf(stderr, "INFO: Unable to connect to \"%s\", queuing on next printer in class...\n",
-               hostname);
+        _cupsLangPuts(stderr,
+                     _("INFO: Unable to contact printer, queuing on next "
+                       "printer in class...\n"));
 
        /*
         * Sleep 5 seconds to keep the job from requeuing too rapidly...
@@ -274,9 +295,19 @@ main(int  argc,                            /* I - Number of command-line arguments (6 or 7) */
       if (error == ECONNREFUSED || error == EHOSTDOWN ||
           error == EHOSTUNREACH)
       {
-       fprintf(stderr,
-               "INFO: Network host \'%s\' is busy; will retry in %d seconds...\n",
-                hostname, delay);
+        if (contimeout && (time(NULL) - start_time) > contimeout)
+       {
+         _cupsLangPuts(stderr, _("ERROR: Printer not responding!\n"));
+         return (CUPS_BACKEND_FAILED);
+       }
+
+        recoverable = 1;
+
+       _cupsLangPrintf(stderr,
+                       _("WARNING: recoverable: Network host \'%s\' is busy; "
+                         "will retry in %d seconds...\n"),
+                       hostname, delay);
+
        sleep(delay);
 
        if (delay < 30)
@@ -284,7 +315,13 @@ main(int  argc,                            /* I - Number of command-line arguments (6 or 7) */
       }
       else
       {
-       perror("ERROR: Unable to connect to printer (retrying in 30 seconds)");
+        recoverable = 1;
+
+        _cupsLangPrintf(stderr, "DEBUG: Connection error: %s\n",
+                       strerror(errno));
+       _cupsLangPuts(stderr,
+                     _("ERROR: recoverable: Unable to connect to printer; "
+                       "will retry in 30 seconds...\n"));
        sleep(30);
       }
     }
@@ -292,7 +329,32 @@ main(int  argc,                            /* I - Number of command-line arguments (6 or 7) */
       break;
   }
 
+  if (recoverable)
+  {
+   /*
+    * If we've shown a recoverable error make sure the printer proxies
+    * have a chance to see the recovered message. Not pretty but
+    * necessary for now...
+    */
+
+    fputs("INFO: recovered: \n", stderr);
+    sleep(5);
+  }
+
   fputs("STATE: -connecting-to-device\n", stderr);
+  _cupsLangPrintf(stderr, _("INFO: Connected to %s...\n"), hostname);
+
+#ifdef AF_INET6
+  if (addr->addr.addr.sa_family == AF_INET6)
+    fprintf(stderr, "DEBUG: Connected to [%s]:%d (IPv6)...\n", 
+           httpAddrString(&addr->addr, addrname, sizeof(addrname)),
+           ntohs(addr->addr.ipv6.sin6_port));
+  else
+#endif /* AF_INET6 */
+    if (addr->addr.addr.sa_family == AF_INET)
+      fprintf(stderr, "DEBUG: Connected to %s:%d (IPv4)...\n",
+             httpAddrString(&addr->addr, addrname, sizeof(addrname)),
+             ntohs(addr->addr.ipv4.sin_port));
 
  /*
   * Print everything...
@@ -310,58 +372,36 @@ main(int  argc,                           /* I - Number of command-line arguments (6 or 7) */
       lseek(print_fd, 0, SEEK_SET);
     }
 
-    tbytes = backendRunLoop(print_fd, device_fd, 1);
+    tbytes = backendRunLoop(print_fd, device_fd, 1, side_cb);
 
     if (print_fd != 0 && tbytes >= 0)
-      fprintf(stderr, "INFO: Sent print file, " CUPS_LLFMT " bytes...\n",
-             CUPS_LLCAST tbytes);
+      _cupsLangPrintf(stderr,
+#ifdef HAVE_LONG_LONG
+                     _("INFO: Sent print file, %lld bytes...\n"),
+#else
+                     _("INFO: Sent print file, %ld bytes...\n"),
+#endif /* HAVE_LONG_LONG */
+                     CUPS_LLCAST tbytes);
   }
 
+ /*
+  * Get any pending back-channel data...
+  */
+
+  while (wait_bc(device_fd, 5) > 0);
+
   if (waiteof)
   {
    /*
     * Shutdown the socket and wait for the other end to finish...
     */
 
-    fputs("INFO: Print file sent, waiting for printer to finish...\n", stderr);
+    _cupsLangPuts(stderr,
+                  _("INFO: Print file sent, waiting for printer to finish...\n"));
 
     shutdown(device_fd, 1);
 
-    for (;;)
-    {
-     /*
-      * Wait a maximum of 90 seconds for backchannel data or a closed
-      * connection...
-      */
-
-      timeout.tv_sec  = 90;
-      timeout.tv_usec = 0;
-
-      FD_ZERO(&input);
-      FD_SET(device_fd, &input);
-
-#ifdef __hpux
-      if (select(device_fd + 1, (int *)&input, NULL, NULL, &timeout) > 0)
-#else
-      if (select(device_fd + 1, &input, NULL, NULL, &timeout) > 0)
-#endif /* __hpux */
-      {
-       /*
-       * Grab the data coming back and spit it out to stderr...
-       */
-
-       if ((bc_bytes = read(device_fd, resource, sizeof(resource))) > 0)
-       {
-         fprintf(stderr, "DEBUG: Received %d bytes of back-channel data!\n",
-                 (int)bc_bytes);
-         cupsBackChannelWrite(resource, bc_bytes, 1.0);
-       }
-       else
-         break;
-      }
-      else
-       break;
-    }
+    while (wait_bc(device_fd, 90) > 0);
   }
 
  /*
@@ -380,12 +420,118 @@ main(int  argc,                          /* I - Number of command-line arguments (6 or 7) */
     close(print_fd);
 
   if (tbytes >= 0)
-    fputs("INFO: Ready to print.\n", stderr);
+    _cupsLangPuts(stderr, _("INFO: Ready to print.\n"));
 
   return (tbytes < 0 ? CUPS_BACKEND_FAILED : CUPS_BACKEND_OK);
 }
 
 
 /*
- * End of "$Id$".
+ * 'side_cb()' - Handle side-channel requests...
+ */
+
+static void
+side_cb(int print_fd,                  /* I - Print file */
+        int device_fd,                 /* I - Device file */
+       int use_bc)                     /* I - Using back-channel? */
+{
+  cups_sc_command_t    command;        /* Request command */
+  cups_sc_status_t     status;         /* Request/response status */
+  char                 data[2048];     /* Request/response data */
+  int                  datalen;        /* Request/response data size */
+  const char           *device_id;     /* 1284DEVICEID env var */
+
+
+  datalen = sizeof(data);
+
+  if (cupsSideChannelRead(&command, &status, data, &datalen, 1.0))
+  {
+    _cupsLangPuts(stderr, _("WARNING: Failed to read side-channel request!\n"));
+    return;
+  }
+
+  switch (command)
+  {
+    case CUPS_SC_CMD_DRAIN_OUTPUT :
+       /*
+        * Our sockets disable the Nagle algorithm and data is sent immediately.
+       */
+
+        if (backendDrainOutput(print_fd, device_fd))
+         status = CUPS_SC_STATUS_IO_ERROR;
+       else 
+          status = CUPS_SC_STATUS_OK;
+
+       datalen = 0;
+        break;
+
+    case CUPS_SC_CMD_GET_BIDI :
+        data[0] = use_bc;
+        datalen = 1;
+        break;
+
+    case CUPS_SC_CMD_GET_DEVICE_ID :
+        if ((device_id = getenv("1284DEVICEID")) != NULL)
+       {
+         strlcpy(data, device_id, sizeof(data));
+         datalen = (int)strlen(data);
+         break;
+       }
+
+    default :
+        status  = CUPS_SC_STATUS_NOT_IMPLEMENTED;
+       datalen = 0;
+       break;
+  }
+
+  cupsSideChannelWrite(command, status, data, datalen, 1.0);
+}
+
+
+/*
+ * 'wait_bc()' - Wait for back-channel data...
+ */
+
+static int                             /* O - # bytes read or -1 on error */
+wait_bc(int device_fd,                 /* I - Socket */
+        int secs)                      /* I - Seconds to wait */
+{
+  struct timeval timeout;              /* Timeout for select() */
+  fd_set       input;                  /* Input set for select() */
+  ssize_t      bytes;                  /* Number of back-channel bytes read */
+  char         buffer[1024];           /* Back-channel buffer */
+
+
+ /*
+  * Wait up to "secs" seconds for backchannel data...
+  */
+
+  timeout.tv_sec  = secs;
+  timeout.tv_usec = 0;
+
+  FD_ZERO(&input);
+  FD_SET(device_fd, &input);
+
+  if (select(device_fd + 1, &input, NULL, NULL, &timeout) > 0)
+  {
+   /*
+    * Grab the data coming back and spit it out to stderr...
+    */
+
+    if ((bytes = read(device_fd, buffer, sizeof(buffer))) > 0)
+    {
+      fprintf(stderr, "DEBUG: Received %d bytes of back-channel data!\n",
+             (int)bytes);
+      cupsBackChannelWrite(buffer, bytes, 1.0);
+    }
+
+    return (bytes);
+  }
+  else
+    return (-1);
+}
+
+
+/*
+ * End of "$Id: socket.c 6910 2007-09-04 20:34:29Z mike $".
  */