]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - backend/socket.c
Update documentation.
[thirdparty/cups.git] / backend / socket.c
index 46d7f5edad389390fb6a982bf67f1f40b86f69c2..c16a1a097d2976d1e914158c936a71034d49f103 100644 (file)
@@ -1,23 +1,16 @@
 /*
- * "$Id: socket.c 7881 2008-08-28 20:21:56Z mike $"
+ * AppSocket backend for CUPS.
  *
- *   AppSocket backend for the Common UNIX Printing System (CUPS).
+ * Copyright 2007-2016 by Apple Inc.
+ * Copyright 1997-2007 by Easy Software Products, all rights reserved.
  *
- *   Copyright 2007-2009 by Apple Inc.
- *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
+ * 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"
+ * "LICENSE" which should have been included with this file.  If this
+ * file is missing or damaged, see the license at "http://www.cups.org/".
  *
- *   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"
- *   "LICENSE" which should have been included with this file.  If this
- *   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.
- *   wait_bc() - Wait for back-channel data...
+ * This file is subject to the Apple OS-Developed Software exception.
  */
 
 /*
@@ -46,7 +39,7 @@
  * Local functions...
  */
 
-static int     wait_bc(int device_fd, int secs);
+static ssize_t wait_bc(int device_fd, int secs);
 
 
 /*
@@ -72,24 +65,24 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
                sep;                    /* Option separator */
   int          print_fd;               /* Print file */
   int          copies;                 /* Number of copies to print */
-  time_t       start_time,             /* Time of first connect */
-               current_time,           /* Current time */
-               wait_time;              /* Time to wait before shutting down socket */
+  time_t       start_time;             /* Time of first connect */
   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 */
                *addr;                  /* Connected address */
   char         addrname[256];          /* Address name */
+  int          snmp_enabled = 1;       /* Is SNMP enabled? */
   int          snmp_fd,                /* SNMP socket */
                start_count,            /* Page count via SNMP at start */
                page_count,             /* Page count via SNMP */
                have_supplies;          /* Printer supports supply levels? */
-  ssize_t      tbytes;                 /* Total number of bytes written */
+  ssize_t      bytes = 0,              /* Initial bytes read */
+               tbytes;                 /* Total number of bytes written */
+  char         buffer[1024];           /* Initial print buffer */
 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
   struct sigaction action;             /* Actions for POSIX signals */
 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
@@ -128,7 +121,7 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
   else if (argc < 6 || argc > 7)
   {
     _cupsLangPrintf(stderr,
-                    _("Usage: %s job-id user title copies options [file]\n"),
+                    _("Usage: %s job-id user title copies options [file]"),
                     argv[0]);
     return (CUPS_BACKEND_FAILED);
   }
@@ -151,9 +144,7 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
 
     if ((print_fd = open(argv[6], O_RDONLY)) < 0)
     {
-      _cupsLangPrintf(stderr,
-                      _("ERROR: Unable to open print file \"%s\": %s\n"),
-                      argv[6], strerror(errno));
+      _cupsLangPrintError("ERROR", _("Unable to open print file"));
       return (CUPS_BACKEND_FAILED);
     }
 
@@ -164,8 +155,14 @@ main(int  argc,                            /* I - Number of command-line arguments (6 or 7) */
   * Extract the hostname and port number from the URI...
   */
 
-  if ((device_uri = cupsBackendDeviceURI(argv)) == NULL)
-    return (CUPS_BACKEND_FAILED);
+  while ((device_uri = cupsBackendDeviceURI(argv)) == NULL)
+  {
+    _cupsLangPrintFilter(stderr, "INFO", _("Unable to locate printer."));
+    sleep(10);
+
+    if (getenv("CLASS") != NULL)
+      return (CUPS_BACKEND_FAILED);
+  }
 
   httpSeparateURI(HTTP_URI_CODING_ALL, device_uri, scheme, sizeof(scheme),
                   username, sizeof(username), hostname, sizeof(hostname), &port,
@@ -229,16 +226,26 @@ main(int  argc,                           /* I - Number of command-line arguments (6 or 7) */
       * Process the option...
       */
 
-      if (!strcasecmp(name, "waiteof"))
+      if (!_cups_strcasecmp(name, "waiteof"))
       {
        /*
         * Set the wait-for-eof value...
        */
 
-        waiteof = !value[0] || !strcasecmp(value, "on") ||
-                 !strcasecmp(value, "yes") || !strcasecmp(value, "true");
+        waiteof = !value[0] || !_cups_strcasecmp(value, "on") ||
+                 !_cups_strcasecmp(value, "yes") || !_cups_strcasecmp(value, "true");
+      }
+      else if (!_cups_strcasecmp(name, "snmp"))
+      {
+        /*
+         * Enable/disable SNMP stuff...
+         */
+
+         snmp_enabled = !value[0] || !_cups_strcasecmp(value, "on") ||
+                        !_cups_strcasecmp(value, "yes") ||
+                        !_cups_strcasecmp(value, "true");
       }
-      else if (!strcasecmp(name, "contimeout"))
+      else if (!_cups_strcasecmp(name, "contimeout"))
       {
        /*
         * Set the connection timeout...
@@ -251,25 +258,46 @@ main(int  argc,                           /* I - Number of command-line arguments (6 or 7) */
   }
 
  /*
-  * Then try to connect to the remote host...
+  * Then try finding the remote host...
   */
 
   start_time = time(NULL);
 
-  sprintf(portname, "%d", port);
+  addrlist = backendLookup(hostname, port, NULL);
 
-  fputs("STATE: +connecting-to-device\n", stderr);
-  fprintf(stderr, "DEBUG: Looking up \"%s\"...\n", hostname);
+ /*
+  * See if the printer supports SNMP...
+  */
+
+  if (snmp_enabled)
+    snmp_fd = _cupsSNMPOpen(addrlist->addr.addr.sa_family);
+  else
+    snmp_fd = -1;
+
+  if (snmp_fd >= 0)
+    have_supplies = !backendSNMPSupplies(snmp_fd, &(addrlist->addr),
+                                         &start_count, NULL);
+  else
+    have_supplies = start_count = 0;
 
-  if ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
+ /*
+  * Wait for data from the filter...
+  */
+
+  if (print_fd == 0)
   {
-    _cupsLangPrintf(stderr, _("ERROR: Unable to locate printer \'%s\'\n"),
-                    hostname);
-    return (CUPS_BACKEND_STOP);
+    if (!backendWaitLoop(snmp_fd, &(addrlist->addr), 1, backendNetworkSideCB))
+      return (CUPS_BACKEND_OK);
+    else if ((bytes = read(0, buffer, sizeof(buffer))) <= 0)
+      return (CUPS_BACKEND_OK);
   }
 
+ /*
+  * Connect to the printer...
+  */
+
   fprintf(stderr, "DEBUG: Connecting to %s:%d\n", hostname, port);
-  _cupsLangPuts(stderr, _("INFO: Connecting to printer...\n"));
+  _cupsLangPrintFilter(stderr, "INFO", _("Connecting to printer."));
 
   for (delay = 5;;)
   {
@@ -287,9 +315,9 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
        * available printer in the class.
        */
 
-        _cupsLangPuts(stderr,
-                     _("INFO: Unable to contact printer, queuing on next "
-                       "printer in class...\n"));
+        _cupsLangPrintFilter(stderr, "INFO",
+                            _("Unable to contact printer, queuing on next "
+                              "printer in class."));
 
        /*
         * Sleep 5 seconds to keep the job from requeuing too rapidly...
@@ -300,31 +328,47 @@ main(int  argc,                           /* I - Number of command-line arguments (6 or 7) */
         return (CUPS_BACKEND_FAILED);
       }
 
-      if (error == ECONNREFUSED || error == EHOSTDOWN ||
-          error == EHOSTUNREACH)
+      fprintf(stderr, "DEBUG: Connection error: %s\n", strerror(error));
+
+      if (errno == ECONNREFUSED || errno == EHOSTDOWN || errno == EHOSTUNREACH || errno == ETIMEDOUT || errno == ENOTCONN)
       {
         if (contimeout && (time(NULL) - start_time) > contimeout)
        {
-         _cupsLangPuts(stderr, _("ERROR: Printer not responding\n"));
+         _cupsLangPrintFilter(stderr, "ERROR",
+                              _("The printer is not responding."));
          return (CUPS_BACKEND_FAILED);
        }
 
-       _cupsLangPrintf(stderr,
-                       _("WARNING: Network host \'%s\' is busy; will retry in "
-                         "%d seconds...\n"), hostname, delay);
-
-       sleep(delay);
+       switch (error)
+       {
+         case EHOSTDOWN :
+             _cupsLangPrintFilter(stderr, "WARNING",
+                                  _("The printer may not exist or "
+                                    "is unavailable at this time."));
+             break;
+
+         case EHOSTUNREACH :
+         default :
+             _cupsLangPrintFilter(stderr, "WARNING",
+                                  _("The printer is unreachable at this "
+                                    "time."));
+             break;
+
+         case ECONNREFUSED :
+             _cupsLangPrintFilter(stderr, "WARNING",
+                                  _("The printer is in use."));
+             break;
+        }
+
+       sleep((unsigned)delay);
 
        if (delay < 30)
          delay += 5;
       }
       else
       {
-        _cupsLangPrintf(stderr, "DEBUG: Connection error: %s\n",
-                       strerror(errno));
-       _cupsLangPuts(stderr,
-                     _("ERROR: Unable to connect to printer; will retry in 30 "
-                       "seconds...\n"));
+       _cupsLangPrintFilter(stderr, "ERROR",
+                            _("The printer is not responding."));
        sleep(30);
       }
     }
@@ -333,31 +377,11 @@ main(int  argc,                           /* I - Number of command-line arguments (6 or 7) */
   }
 
   fputs("STATE: -connecting-to-device\n", stderr);
-  _cupsLangPuts(stderr, _("INFO: Connected to printer...\n"));
-
-#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));
-
- /*
-  * See if the printer supports SNMP...
-  */
+  _cupsLangPrintFilter(stderr, "INFO", _("Connected to printer."));
 
-  if ((snmp_fd = _cupsSNMPOpen(addr->addr.addr.sa_family)) >= 0)
-  {
-    have_supplies = !backendSNMPSupplies(snmp_fd, &(addr->addr), &start_count,
-                                         NULL);
-  }
-  else
-    have_supplies = start_count = 0;
+  fprintf(stderr, "DEBUG: Connected to %s:%d...\n",
+         httpAddrString(&(addr->addr), addrname, sizeof(addrname)),
+         httpAddrPort(&(addr->addr)));
 
  /*
   * Print everything...
@@ -365,6 +389,9 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
 
   tbytes = 0;
 
+  if (bytes > 0)
+    tbytes += write(device_fd, buffer, (size_t)bytes);
+
   while (copies > 0 && tbytes >= 0)
   {
     copies --;
@@ -375,27 +402,14 @@ main(int  argc,                           /* I - Number of command-line arguments (6 or 7) */
       lseek(print_fd, 0, SEEK_SET);
     }
 
-    tbytes = backendRunLoop(print_fd, device_fd, snmp_fd, &(addr->addr), 1, 0, 
-                            backendNetworkSideCB);
+    tbytes = backendRunLoop(print_fd, device_fd, snmp_fd, &(addrlist->addr), 1,
+                            0, backendNetworkSideCB);
 
     if (print_fd != 0 && tbytes >= 0)
-      _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);
+      _cupsLangPrintFilter(stderr, "INFO", _("Print file sent."));
   }
 
- /*
-  * Wait up to 5 seconds to get any pending back-channel data...
-  */
-
-  wait_time = time(NULL) + 5;
-  while (wait_time >= time(&current_time))
-    if (wait_bc(device_fd, wait_time - current_time) <= 0)
-      break;
+  fputs("STATE: +cups-waiting-for-job-completed\n", stderr);
 
   if (waiteof)
   {
@@ -403,8 +417,7 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
     * Shutdown the socket and wait for the other end to finish...
     */
 
-    _cupsLangPuts(stderr,
-                  _("INFO: Print file sent, waiting for printer to finish...\n"));
+    _cupsLangPrintFilter(stderr, "INFO", _("Waiting for printer to finish."));
 
     shutdown(device_fd, 1);
 
@@ -415,8 +428,8 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
   * Collect the final page count as needed...
   */
 
-  if (have_supplies && 
-      !backendSNMPSupplies(snmp_fd, &(addr->addr), &page_count, NULL) &&
+  if (have_supplies &&
+      !backendSNMPSupplies(snmp_fd, &(addrlist->addr), &page_count, NULL) &&
       page_count > start_count)
     fprintf(stderr, "PAGE: total %d\n", page_count - start_count);
 
@@ -435,10 +448,7 @@ main(int  argc,                            /* I - Number of command-line arguments (6 or 7) */
   if (print_fd != 0)
     close(print_fd);
 
-  if (tbytes >= 0)
-    _cupsLangPuts(stderr, _("INFO: Ready to print.\n"));
-
-  return (tbytes < 0 ? CUPS_BACKEND_FAILED : CUPS_BACKEND_OK);
+  return (CUPS_BACKEND_OK);
 }
 
 
@@ -446,7 +456,7 @@ main(int  argc,                             /* I - Number of command-line arguments (6 or 7) */
  * 'wait_bc()' - Wait for back-channel data...
  */
 
-static int                             /* O - # bytes read or -1 on error */
+static ssize_t                         /* O - # bytes read or -1 on error */
 wait_bc(int device_fd,                 /* I - Socket */
         int secs)                      /* I - Seconds to wait */
 {
@@ -476,7 +486,7 @@ wait_bc(int device_fd,                      /* I - Socket */
     {
       fprintf(stderr, "DEBUG: Received %d bytes of back-channel data\n",
              (int)bytes);
-      cupsBackChannelWrite(buffer, bytes, 1.0);
+      cupsBackChannelWrite(buffer, (size_t)bytes, 1.0);
     }
 
     return (bytes);
@@ -484,8 +494,3 @@ wait_bc(int device_fd,                      /* I - Socket */
   else
     return (-1);
 }
-
-
-/*
- * End of "$Id: socket.c 7881 2008-08-28 20:21:56Z mike $".
- */