/*
- * "$Id: socket.c 6403 2007-03-27 16:00: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 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 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:
- *
- * 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.
- * side_cb() - Handle side-channel requests...
+ * This file is subject to the Apple OS-Developed Software exception.
*/
/*
* Local functions...
*/
-static void side_cb(int print_fd, int device_fd, int use_bc);
+static ssize_t wait_bc(int device_fd, int secs);
/*
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) */
*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 */
- *addr; /* Connected address */
+ *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 */
+ 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 ((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(HTTP_URI_CODING_ALL, cupsBackendDeviceURI(argv),
- 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)
* 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 ((sep = *options) != '\0')
+ *options++ = '\0';
- if (*options == '=')
+ 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...
*/
- 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 (!strcasecmp(name, "contimeout"))
+ 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...
}
/*
- * Then try to connect to the remote host...
+ * Then try finding the remote host...
*/
- recoverable = 0;
- start_time = time(NULL);
+ start_time = time(NULL);
- sprintf(portname, "%d", port);
+ addrlist = backendLookup(hostname, port, NULL);
- if ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
+ /*
+ * 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;
+
+ /*
+ * Wait for data from the filter...
+ */
+
+ if (print_fd == 0)
{
- fprintf(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);
}
- fprintf(stderr, _("INFO: Attempting to connect to host %s on port %d\n"),
- hostname, port);
+ /*
+ * Connect to the printer...
+ */
- fputs("STATE: +connecting-to-device\n", stderr);
+ fprintf(stderr, "DEBUG: Connecting to %s:%d\n", hostname, port);
+ _cupsLangPrintFilter(stderr, "INFO", _("Connecting to printer."));
for (delay = 5;;)
{
* available printer in the class.
*/
- fputs(_("INFO: Unable to contact printer, queuing on next "
- "printer in class...\n"), stderr);
+ _cupsLangPrintFilter(stderr, "INFO",
+ _("Unable to contact printer, queuing on next "
+ "printer in class."));
/*
* Sleep 5 seconds to keep the job from requeuing too rapidly...
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)
{
- fputs(_("ERROR: Printer not responding!\n"), stderr);
+ _cupsLangPrintFilter(stderr, "ERROR",
+ _("The printer is not responding."));
return (CUPS_BACKEND_FAILED);
}
- recoverable = 1;
-
- fprintf(stderr,
- _("WARNING: recoverable: 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
{
- recoverable = 1;
-
- fprintf(stderr, "DEBUG: Connection error: %s\n", strerror(errno));
- fputs(_("ERROR: recoverable: Unable to connect to printer; will "
- "retry in 30 seconds...\n"), stderr);
+ _cupsLangPrintFilter(stderr, "ERROR",
+ _("The printer is not responding."));
sleep(30);
}
}
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);
- fprintf(stderr, _("INFO: Connected to %s...\n"), hostname);
+ _cupsLangPrintFilter(stderr, "INFO", _("Connected to printer."));
-#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));
+ fprintf(stderr, "DEBUG: Connected to %s:%d...\n",
+ httpAddrString(&(addr->addr), addrname, sizeof(addrname)),
+ httpAddrPort(&(addr->addr)));
/*
* Print everything...
tbytes = 0;
+ if (bytes > 0)
+ tbytes += write(device_fd, buffer, (size_t)bytes);
+
while (copies > 0 && tbytes >= 0)
{
copies --;
lseek(print_fd, 0, SEEK_SET);
}
- tbytes = backendRunLoop(print_fd, device_fd, 1, side_cb);
+ tbytes = backendRunLoop(print_fd, device_fd, snmp_fd, &(addrlist->addr), 1,
+ 0, backendNetworkSideCB);
if (print_fd != 0 && tbytes >= 0)
- fprintf(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."));
}
+ fputs("STATE: +cups-waiting-for-job-completed\n", stderr);
+
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);
+ _cupsLangPrintFilter(stderr, "INFO", _("Waiting for printer to finish."));
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);
+ while (wait_bc(device_fd, 90) > 0);
+ }
- if (select(device_fd + 1, &input, NULL, NULL, &timeout) > 0)
- {
- /*
- * Grab the data coming back and spit it out to stderr...
- */
+ /*
+ * Collect the final page count as needed...
+ */
- 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;
- }
- }
+ 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...
if (print_fd != 0)
close(print_fd);
- if (tbytes >= 0)
- fputs(_("INFO: Ready to print.\n"), stderr);
-
- return (tbytes < 0 ? CUPS_BACKEND_FAILED : CUPS_BACKEND_OK);
+ return (CUPS_BACKEND_OK);
}
/*
- * 'side_cb()' - Handle side-channel requests...
+ * 'wait_bc()' - Wait for back-channel data...
*/
-static void
-side_cb(int print_fd, /* I - Print file */
- int device_fd, /* I - Device file */
- int use_bc) /* I - Using back-channel? */
+static ssize_t /* O - # bytes read or -1 on error */
+wait_bc(int device_fd, /* I - Socket */
+ int secs) /* I - Seconds to wait */
{
- 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 */
+ 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 */
- datalen = sizeof(data);
+ /*
+ * Wait up to "secs" seconds for backchannel data...
+ */
- if (cupsSideChannelRead(&command, &status, data, &datalen, 1.0))
- {
- fputs(_("WARNING: Failed to read side-channel request!\n"), stderr);
- return;
- }
+ timeout.tv_sec = secs;
+ timeout.tv_usec = 0;
- switch (command)
- {
- case CUPS_SC_CMD_DRAIN_OUTPUT :
- /*
- * Our sockets disable the Nagle algorithm and data is sent immediately.
- */
+ FD_ZERO(&input);
+ FD_SET(device_fd, &input);
- status = CUPS_SC_STATUS_OK;
- datalen = 0;
- break;
+ if (select(device_fd + 1, &input, NULL, NULL, &timeout) > 0)
+ {
+ /*
+ * Grab the data coming back and spit it out to stderr...
+ */
- case CUPS_SC_CMD_GET_BIDI :
- data[0] = use_bc;
- datalen = 1;
- break;
+ 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);
+ }
- default :
- status = CUPS_SC_STATUS_NOT_IMPLEMENTED;
- datalen = 0;
- break;
+ return (bytes);
}
-
- cupsSideChannelWrite(command, status, data, datalen, 1.0);
+ else
+ return (-1);
}
-
-
-/*
- * End of "$Id: socket.c 6403 2007-03-27 16:00:56Z mike $".
- */
projects / thirdparty / cups.git / blobdiff