/*
- * "$Id: socket.c 4906 2006-01-10 20:53:28Z mike $"
+ * "$Id$"
*
- * AppSocket backend for the Common UNIX Printing System (CUPS).
+ * AppSocket backend for CUPS.
*
- * Copyright 1997-2006 by Easy Software Products, all rights reserved.
+ * Copyright 2007-2014 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
- * "LICENSE" which should have been included with this file. If this
- * file is missing or damaged please contact Easy Software Products
- * at:
+ * 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/".
*
- * 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
- *
- * This file is subject to the Apple OS-Developed Software exception.
- *
- * Contents:
- *
- * main() - Send a file to the printer or server.
+ * This file is subject to the Apple OS-Developed Software exception.
*/
/*
* Include necessary headers.
*/
-#include <cups/backend.h>
#include <cups/http-private.h>
-#include <cups/cups.h>
-#include <stdio.h>
-#include <stdlib.h>
+#include "backend-private.h"
#include <stdarg.h>
-#include <cups/string.h>
-#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
-#include <signal.h>
#ifdef WIN32
# include <winsock.h>
#endif /* WIN32 */
+/*
+ * Local functions...
+ */
+
+static ssize_t wait_bc(int device_fd, int secs);
+
+
/*
* 'main()' - Send a file to the printer or server.
*
main(int argc, /* I - Number of command-line arguments (6 or 7) */
char *argv[]) /* I - Command-line arguments */
{
- char method[255], /* Method in URI */
+ const char *device_uri; /* Device URI */
+ char scheme[255], /* Scheme in URI */
hostname[1024], /* Hostname */
username[255], /* Username info (not used) */
- resource[1024]; /* Resource info (not used) */
- int fp; /* Print file */
+ resource[1024], /* Resource info (not used) */
+ *options, /* Pointer to options */
+ *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 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 fd; /* AppSocket */
+ int device_fd; /* AppSocket */
int error; /* Error code (if any) */
- http_addrlist_t *addrlist; /* Address list */
- int rbytes; /* Number of bytes read */
- int wbytes; /* Number of bytes written */
- int nbytes; /* Number of bytes read */
- size_t tbytes; /* Total number of bytes written */
- char buffer[8192], /* Output buffer */
- *bufptr; /* Pointer into buffer */
- struct timeval timeout; /* Timeout for select() */
- fd_set input, /* Input set for select() */
- output; /* Output set for select() */
+ 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 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 */
if (argc == 1)
{
- puts("network socket \"Unknown\" \"AppSocket/HP JetDirect\"");
+ printf("network socket \"Unknown\" \"%s\"\n",
+ _cupsLangString(cupsLangDefault(), _("AppSocket/HP JetDirect")));
return (CUPS_BACKEND_OK);
}
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]"),
+ argv[0]);
return (CUPS_BACKEND_FAILED);
}
if (argc == 6)
{
- fp = 0;
- copies = 1;
+ print_fd = 0;
+ copies = 1;
}
else
{
* Try to open the print file...
*/
- if ((fp = open(argv[6], O_RDONLY)) < 0)
+ if ((print_fd = open(argv[6], O_RDONLY)) < 0)
{
- perror("ERROR: unable to open print file");
+ _cupsLangPrintError("ERROR", _("Unable to open print file"));
return (CUPS_BACKEND_FAILED);
}
* Extract the hostname and port number from the URI...
*/
- httpSeparateURI(argv[0], method, sizeof(method), username, sizeof(username),
- hostname, sizeof(hostname), &port,
+ 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,
resource, sizeof(resource));
if (port == 0)
port = 9100; /* Default to HP JetDirect/Tektronix PhaserShare */
/*
- * Then try to connect to the remote host...
+ * Get options, if any...
*/
- sprintf(portname, "%d", port);
+ waiteof = 1;
+ contimeout = 7 * 24 * 60 * 60;
- if ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
+ if ((options = strchr(resource, '?')) != NULL)
{
- fprintf(stderr, "ERROR: Unable to locate printer \'%s\'!\n", hostname);
- return (CUPS_BACKEND_STOP);
- }
+ /*
+ * Yup, terminate the device name string and move to the first
+ * character of the options...
+ */
- fprintf(stderr, "INFO: Attempting to connect to host %s on port %d\n",
- hostname, port);
+ *options++ = '\0';
- wbytes = 0;
+ /*
+ * Parse options...
+ */
- while (copies > 0)
- {
- for (delay = 5;;)
+ while (*options)
{
- if (!httpAddrConnect(addrlist, &fd))
- {
- error = errno;
- fd = -1;
+ /*
+ * Get the name...
+ */
- if (getenv("CLASS") != NULL)
- {
- /*
- * If the CLASS environment variable is set, the job was submitted
- * to a class and not to a specific queue. In this case, we want
- * to abort immediately so that the job can be requeued on the next
- * available printer in the class.
- */
+ name = options;
- fprintf(stderr, "INFO: Unable to connect to \"%s\", queuing on next printer in class...\n",
- hostname);
+ while (*options && *options != '=' && *options != '+' && *options != '&')
+ options ++;
- /*
- * Sleep 5 seconds to keep the job from requeuing too rapidly...
- */
+ if ((sep = *options) != '\0')
+ *options++ = '\0';
- sleep(5);
+ if (sep == '=')
+ {
+ /*
+ * Get the value...
+ */
- return (CUPS_BACKEND_FAILED);
- }
+ value = options;
- if (error == ECONNREFUSED || error == EHOSTDOWN ||
- error == EHOSTUNREACH)
- {
- fprintf(stderr, "INFO: Network host \'%s\' is busy; will retry in %d seconds...\n",
- hostname, delay);
- sleep(delay);
+ while (*options && *options != '+' && *options != '&')
+ options ++;
- if (delay < 30)
- delay += 5;
- }
- else
- {
- perror("ERROR: Unable to connect to printer (retrying in 30 seconds)");
- sleep(30);
- }
+ if (*options)
+ *options++ = '\0';
}
else
- break;
- }
+ value = (char *)"";
- /*
- * Now that we are "connected" to the port, ignore SIGTERM so that we
- * can finish out any page data the driver sends (e.g. to eject the
- * current page... Only ignore SIGTERM if we are printing data from
- * stdin (otherwise you can't cancel raw jobs...)
- */
+ /*
+ * Process the option...
+ */
- if (argc < 7)
- {
-#ifdef HAVE_SIGSET /* Use System V signals over POSIX to avoid bugs */
- sigset(SIGTERM, SIG_IGN);
-#elif defined(HAVE_SIGACTION)
- memset(&action, 0, sizeof(action));
+ if (!_cups_strcasecmp(name, "waiteof"))
+ {
+ /*
+ * Set the wait-for-eof value...
+ */
- sigemptyset(&action.sa_mask);
- action.sa_handler = SIG_IGN;
- sigaction(SIGTERM, &action, NULL);
-#else
- signal(SIGTERM, SIG_IGN);
-#endif /* HAVE_SIGSET */
+ 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 (!_cups_strcasecmp(name, "contimeout"))
+ {
+ /*
+ * Set the connection timeout...
+ */
+
+ if (atoi(value) > 0)
+ contimeout = atoi(value);
+ }
}
+ }
- /*
- * Finally, send the print file...
- */
+ /*
+ * Then try finding the remote host...
+ */
- copies --;
+ start_time = time(NULL);
+
+ sprintf(portname, "%d", port);
- if (fp != 0)
+ fputs("STATE: +connecting-to-device\n", stderr);
+ fprintf(stderr, "DEBUG: Looking up \"%s\"...\n", hostname);
+
+ while ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
+ {
+ _cupsLangPrintFilter(stderr, "INFO",
+ _("Unable to locate printer \"%s\"."), hostname);
+ sleep(10);
+
+ if (getenv("CLASS") != NULL)
{
- fputs("PAGE: 1 1\n", stderr);
- lseek(fp, 0, SEEK_SET);
+ fputs("STATE: -connecting-to-device\n", stderr);
+ return (CUPS_BACKEND_STOP);
}
+ }
- fputs("INFO: Connected to host, sending print job...\n", stderr);
+ /*
+ * See if the printer supports SNMP...
+ */
- tbytes = 0;
- while ((nbytes = read(fp, buffer, sizeof(buffer))) > 0)
- {
- /*
- * Write the print data to the printer...
- */
+ 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;
+
+ /*
+ * Wait for data from the filter...
+ */
+
+ if (print_fd == 0)
+ {
+ 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);
+ _cupsLangPrintFilter(stderr, "INFO", _("Connecting to printer."));
- tbytes += nbytes;
- bufptr = buffer;
+ for (delay = 5;;)
+ {
+ if ((addr = httpAddrConnect(addrlist, &device_fd)) == NULL)
+ {
+ error = errno;
+ device_fd = -1;
- while (nbytes > 0)
+ if (getenv("CLASS") != NULL)
{
/*
- * See if we are ready to read or write...
+ * If the CLASS environment variable is set, the job was submitted
+ * to a class and not to a specific queue. In this case, we want
+ * to abort immediately so that the job can be requeued on the next
+ * available printer in the class.
*/
- do
- {
- FD_ZERO(&input);
- FD_SET(fd, &input);
- FD_ZERO(&output);
- FD_SET(fd, &output);
- }
- while (select(fd + 1, &input, &output, NULL, NULL) < 0);
+ _cupsLangPrintFilter(stderr, "INFO",
+ _("Unable to contact printer, queuing on next "
+ "printer in class."));
- if (FD_ISSET(fd, &input))
+ /*
+ * Sleep 5 seconds to keep the job from requeuing too rapidly...
+ */
+
+ sleep(5);
+
+ return (CUPS_BACKEND_FAILED);
+ }
+
+ fprintf(stderr, "DEBUG: Connection error: %s\n", strerror(error));
+
+ if (error == ECONNREFUSED || error == EHOSTDOWN ||
+ error == EHOSTUNREACH)
+ {
+ if (contimeout && (time(NULL) - start_time) > contimeout)
{
- /*
- * Read backchannel data...
- */
-
- if ((rbytes = recv(fd, resource, sizeof(resource), 0)) > 0)
- {
- fprintf(stderr, "DEBUG: Received %d bytes of back-channel data!\n",
- rbytes);
- cupsBackchannelWrite(resource, rbytes, 1.0);
- }
+ _cupsLangPrintFilter(stderr, "ERROR",
+ _("The printer is not responding."));
+ return (CUPS_BACKEND_FAILED);
}
- if (FD_ISSET(fd, &output))
+ switch (error)
{
- /*
- * Write print data...
- */
-
- if ((wbytes = send(fd, bufptr, nbytes, 0)) < 0)
- {
- /*
- * Check for retryable errors...
- */
-
- if (errno != EAGAIN && errno != EINTR)
- {
- perror("ERROR: Unable to send print file to printer");
+ case EHOSTDOWN :
+ _cupsLangPrintFilter(stderr, "WARNING",
+ _("The printer may not exist or "
+ "is unavailable at this time."));
+ break;
+
+ case EHOSTUNREACH :
+ _cupsLangPrintFilter(stderr, "WARNING",
+ _("The printer is unreachable at this "
+ "time."));
+ break;
+
+ case ECONNREFUSED :
+ default :
+ _cupsLangPrintFilter(stderr, "WARNING",
+ _("The printer is in use."));
break;
- }
- }
- else
- {
- /*
- * Update count and pointer...
- */
-
- nbytes -= wbytes;
- bufptr += wbytes;
- }
}
- }
- if (wbytes < 0)
- break;
+ sleep((unsigned)delay);
- if (argc > 6)
- fprintf(stderr, "INFO: Sending print file, %lu bytes...\n",
- (unsigned long)tbytes);
+ if (delay < 30)
+ delay += 5;
+ }
+ else
+ {
+ _cupsLangPrintFilter(stderr, "ERROR",
+ _("The printer is not responding."));
+ sleep(30);
+ }
}
+ else
+ break;
+ }
- /*
- * Shutdown the socket and wait for the other end to finish...
- */
-
- fputs("INFO: Print file sent, waiting for printer to finish...\n", stderr);
+ fputs("STATE: -connecting-to-device\n", stderr);
+ _cupsLangPrintFilter(stderr, "INFO", _("Connected to printer."));
- shutdown(fd, 1);
+ fprintf(stderr, "DEBUG: Connected to %s:%d...\n",
+ httpAddrString(&(addr->addr), addrname, sizeof(addrname)),
+ httpAddrPort(&(addr->addr)));
- for (;;)
- {
- /*
- * Wait a maximum of 90 seconds for backchannel data or a closed
- * connection...
- */
+ /*
+ * Print everything...
+ */
- timeout.tv_sec = 90;
- timeout.tv_usec = 0;
+ tbytes = 0;
- FD_ZERO(&input);
- FD_SET(fd, &input);
+ if (bytes > 0)
+ tbytes += write(device_fd, buffer, (size_t)bytes);
-#ifdef __hpux
- if (select(fd + 1, (int *)&input, NULL, NULL, &timeout) > 0)
-#else
- if (select(fd + 1, &input, NULL, NULL, &timeout) > 0)
-#endif /* __hpux */
- {
- /*
- * Grab the data coming back and spit it out to stderr...
- */
+ while (copies > 0 && tbytes >= 0)
+ {
+ copies --;
- if ((rbytes = recv(fd, resource, sizeof(resource), 0)) > 0)
- {
- fprintf(stderr, "DEBUG: Received %d bytes of back-channel data!\n",
- rbytes);
- cupsBackchannelWrite(resource, rbytes, 1.0);
- }
- else
- break;
- }
- else
- break;
+ if (print_fd != 0)
+ {
+ fputs("PAGE: 1 1\n", stderr);
+ lseek(print_fd, 0, SEEK_SET);
}
+ tbytes = backendRunLoop(print_fd, device_fd, snmp_fd, &(addrlist->addr), 1,
+ 0, backendNetworkSideCB);
+
+ if (print_fd != 0 && tbytes >= 0)
+ _cupsLangPrintFilter(stderr, "INFO", _("Print file sent."));
+ }
+
+ fputs("STATE: +cups-waiting-for-job-completed\n", stderr);
+
+ if (waiteof)
+ {
/*
- * Close the socket connection...
+ * Shutdown the socket and wait for the other end to finish...
*/
- close(fd);
+ _cupsLangPrintFilter(stderr, "INFO", _("Waiting for printer to finish."));
+
+ shutdown(device_fd, 1);
+
+ while (wait_bc(device_fd, 90) > 0);
}
+ /*
+ * Collect the final page count as needed...
+ */
+
+ 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);
+
+ /*
+ * Close the socket connection...
+ */
+
+ close(device_fd);
+
httpAddrFreeList(addrlist);
/*
* Close the input file and return...
*/
- if (fp != 0)
- close(fp);
+ if (print_fd != 0)
+ close(print_fd);
+
+ return (CUPS_BACKEND_OK);
+}
+
+
+/*
+ * 'wait_bc()' - Wait for back-channel data...
+ */
+
+static ssize_t /* 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 (wbytes >= 0)
- fputs("INFO: Ready to print.\n", 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, (size_t)bytes, 1.0);
+ }
- return (wbytes < 0 ? CUPS_BACKEND_FAILED : CUPS_BACKEND_OK);
+ return (bytes);
+ }
+ else
+ return (-1);
}
/*
- * End of "$Id: socket.c 4906 2006-01-10 20:53:28Z mike $".
+ * End of "$Id$".
*/
projects / thirdparty / cups.git / blobdiff