2 * "$Id: socket.c 9793 2011-05-20 03:49:49Z mike $"
4 * AppSocket backend for CUPS.
6 * Copyright 2007-2011 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * "LICENSE" which should have been included with this file. If this
13 * file is missing or damaged, see the license at "http://www.cups.org/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * main() - Send a file to the printer or server.
20 * wait_bc() - Wait for back-channel data...
24 * Include necessary headers.
27 #include <cups/http-private.h>
28 #include "backend-private.h"
30 #include <sys/types.h>
38 # include <sys/socket.h>
39 # include <netinet/in.h>
40 # include <arpa/inet.h>
49 static int wait_bc(int device_fd, int secs);
53 * 'main()' - Send a file to the printer or server.
57 * printer-uri job-id user title copies options [file]
60 int /* O - Exit status */
61 main(int argc, /* I - Number of command-line arguments (6 or 7) */
62 char *argv[]) /* I - Command-line arguments */
64 const char *device_uri; /* Device URI */
65 char scheme[255], /* Scheme in URI */
66 hostname[1024], /* Hostname */
67 username[255], /* Username info (not used) */
68 resource[1024], /* Resource info (not used) */
69 *options, /* Pointer to options */
70 *name, /* Name of option */
71 *value, /* Value of option */
72 sep; /* Option separator */
73 int print_fd; /* Print file */
74 int copies; /* Number of copies to print */
75 time_t start_time; /* Time of first connect */
77 time_t current_time, /* Current time */
78 wait_time; /* Time to wait before shutting down socket */
79 #endif /* __APPLE__ */
80 int contimeout; /* Connection timeout */
81 int waiteof; /* Wait for end-of-file? */
82 int port; /* Port number */
83 char portname[255]; /* Port name */
84 int delay; /* Delay for retries... */
85 int device_fd; /* AppSocket */
86 int error; /* Error code (if any) */
87 http_addrlist_t *addrlist, /* Address list */
88 *addr; /* Connected address */
89 char addrname[256]; /* Address name */
90 int snmp_fd, /* SNMP socket */
91 start_count, /* Page count via SNMP at start */
92 page_count, /* Page count via SNMP */
93 have_supplies; /* Printer supports supply levels? */
94 ssize_t bytes = 0, /* Initial bytes read */
95 tbytes; /* Total number of bytes written */
96 char buffer[1024]; /* Initial print buffer */
97 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
98 struct sigaction action; /* Actions for POSIX signals */
99 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
103 * Make sure status messages are not buffered...
106 setbuf(stderr, NULL);
109 * Ignore SIGPIPE signals...
113 sigset(SIGPIPE, SIG_IGN);
114 #elif defined(HAVE_SIGACTION)
115 memset(&action, 0, sizeof(action));
116 action.sa_handler = SIG_IGN;
117 sigaction(SIGPIPE, &action, NULL);
119 signal(SIGPIPE, SIG_IGN);
120 #endif /* HAVE_SIGSET */
123 * Check command-line...
128 printf("network socket \"Unknown\" \"%s\"\n",
129 _cupsLangString(cupsLangDefault(), _("AppSocket/HP JetDirect")));
130 return (CUPS_BACKEND_OK);
132 else if (argc < 6 || argc > 7)
134 _cupsLangPrintf(stderr,
135 _("Usage: %s job-id user title copies options [file]"),
137 return (CUPS_BACKEND_FAILED);
141 * If we have 7 arguments, print the file named on the command-line.
142 * Otherwise, send stdin instead...
153 * Try to open the print file...
156 if ((print_fd = open(argv[6], O_RDONLY)) < 0)
158 _cupsLangPrintError("ERROR", _("Unable to open print file"));
159 return (CUPS_BACKEND_FAILED);
162 copies = atoi(argv[4]);
166 * Extract the hostname and port number from the URI...
169 while ((device_uri = cupsBackendDeviceURI(argv)) == NULL)
171 _cupsLangPrintFilter(stderr, "INFO", _("Unable to locate printer."));
174 if (getenv("CLASS") != NULL)
175 return (CUPS_BACKEND_FAILED);
178 httpSeparateURI(HTTP_URI_CODING_ALL, device_uri, scheme, sizeof(scheme),
179 username, sizeof(username), hostname, sizeof(hostname), &port,
180 resource, sizeof(resource));
183 port = 9100; /* Default to HP JetDirect/Tektronix PhaserShare */
186 * Get options, if any...
190 contimeout = 7 * 24 * 60 * 60;
192 if ((options = strchr(resource, '?')) != NULL)
195 * Yup, terminate the device name string and move to the first
196 * character of the options...
213 while (*options && *options != '=' && *options != '+' && *options != '&')
216 if ((sep = *options) != '\0')
227 while (*options && *options != '+' && *options != '&')
237 * Process the option...
240 if (!_cups_strcasecmp(name, "waiteof"))
243 * Set the wait-for-eof value...
246 waiteof = !value[0] || !_cups_strcasecmp(value, "on") ||
247 !_cups_strcasecmp(value, "yes") || !_cups_strcasecmp(value, "true");
249 else if (!_cups_strcasecmp(name, "contimeout"))
252 * Set the connection timeout...
256 contimeout = atoi(value);
262 * Then try finding the remote host...
265 start_time = time(NULL);
267 sprintf(portname, "%d", port);
269 fputs("STATE: +connecting-to-device\n", stderr);
270 fprintf(stderr, "DEBUG: Looking up \"%s\"...\n", hostname);
272 while ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
274 _cupsLangPrintFilter(stderr, "INFO",
275 _("Unable to locate printer \"%s\"."), hostname);
278 if (getenv("CLASS") != NULL)
280 fputs("STATE: -connecting-to-device\n", stderr);
281 return (CUPS_BACKEND_STOP);
286 * See if the printer supports SNMP...
289 if ((snmp_fd = _cupsSNMPOpen(addrlist->addr.addr.sa_family)) >= 0)
291 have_supplies = !backendSNMPSupplies(snmp_fd, &(addrlist->addr),
295 have_supplies = start_count = 0;
298 * Wait for data from the filter...
303 if (!backendWaitLoop(snmp_fd, &(addrlist->addr), 1, backendNetworkSideCB))
304 return (CUPS_BACKEND_OK);
305 else if ((bytes = read(0, buffer, sizeof(buffer))) <= 0)
306 return (CUPS_BACKEND_OK);
310 * Connect to the printer...
313 fprintf(stderr, "DEBUG: Connecting to %s:%d\n", hostname, port);
314 _cupsLangPrintFilter(stderr, "INFO", _("Connecting to printer."));
318 if ((addr = httpAddrConnect(addrlist, &device_fd)) == NULL)
323 if (getenv("CLASS") != NULL)
326 * If the CLASS environment variable is set, the job was submitted
327 * to a class and not to a specific queue. In this case, we want
328 * to abort immediately so that the job can be requeued on the next
329 * available printer in the class.
332 _cupsLangPrintFilter(stderr, "INFO",
333 _("Unable to contact printer, queuing on next "
334 "printer in class."));
337 * Sleep 5 seconds to keep the job from requeuing too rapidly...
342 return (CUPS_BACKEND_FAILED);
345 fprintf(stderr, "DEBUG: Connection error: %s\n", strerror(error));
347 if (error == ECONNREFUSED || error == EHOSTDOWN ||
348 error == EHOSTUNREACH)
350 if (contimeout && (time(NULL) - start_time) > contimeout)
352 _cupsLangPrintFilter(stderr, "ERROR",
353 _("The printer is not responding."));
354 return (CUPS_BACKEND_FAILED);
360 _cupsLangPrintFilter(stderr, "WARNING",
361 _("The printer may not exist or "
362 "is unavailable at this time."));
366 _cupsLangPrintFilter(stderr, "WARNING",
367 _("The printer is unreachable at this "
373 _cupsLangPrintFilter(stderr, "WARNING",
374 _("The printer is busy."));
385 _cupsLangPrintFilter(stderr, "ERROR",
386 _("The printer is not responding."));
394 fputs("STATE: -connecting-to-device\n", stderr);
395 _cupsLangPrintFilter(stderr, "INFO", _("Connected to printer."));
397 fprintf(stderr, "DEBUG: Connected to %s:%d...\n",
398 httpAddrString(&(addr->addr), addrname, sizeof(addrname)),
399 _httpAddrPort(&(addr->addr)));
402 * Print everything...
408 tbytes += write(device_fd, buffer, bytes);
410 while (copies > 0 && tbytes >= 0)
416 fputs("PAGE: 1 1\n", stderr);
417 lseek(print_fd, 0, SEEK_SET);
420 tbytes = backendRunLoop(print_fd, device_fd, snmp_fd, &(addrlist->addr), 1,
421 0, backendNetworkSideCB);
423 if (print_fd != 0 && tbytes >= 0)
424 _cupsLangPrintFilter(stderr, "INFO", _("Print file sent."));
429 * Wait up to 5 seconds to get any pending back-channel data...
432 wait_time = time(NULL) + 5;
433 while (wait_time >= time(¤t_time))
434 if (wait_bc(device_fd, wait_time - current_time) <= 0)
436 #endif /* __APPLE__ */
441 * Shutdown the socket and wait for the other end to finish...
444 _cupsLangPrintFilter(stderr, "INFO", _("Waiting for printer to finish."));
446 shutdown(device_fd, 1);
448 while (wait_bc(device_fd, 90) > 0);
452 * Collect the final page count as needed...
456 !backendSNMPSupplies(snmp_fd, &(addrlist->addr), &page_count, NULL) &&
457 page_count > start_count)
458 fprintf(stderr, "PAGE: total %d\n", page_count - start_count);
461 * Close the socket connection...
466 httpAddrFreeList(addrlist);
469 * Close the input file and return...
475 _cupsLangPrintFilter(stderr, "INFO", _("Ready to print."));
477 return (CUPS_BACKEND_OK);
482 * 'wait_bc()' - Wait for back-channel data...
485 static int /* O - # bytes read or -1 on error */
486 wait_bc(int device_fd, /* I - Socket */
487 int secs) /* I - Seconds to wait */
489 struct timeval timeout; /* Timeout for select() */
490 fd_set input; /* Input set for select() */
491 ssize_t bytes; /* Number of back-channel bytes read */
492 char buffer[1024]; /* Back-channel buffer */
496 * Wait up to "secs" seconds for backchannel data...
499 timeout.tv_sec = secs;
503 FD_SET(device_fd, &input);
505 if (select(device_fd + 1, &input, NULL, NULL, &timeout) > 0)
508 * Grab the data coming back and spit it out to stderr...
511 if ((bytes = read(device_fd, buffer, sizeof(buffer))) > 0)
513 fprintf(stderr, "DEBUG: Received %d bytes of back-channel data\n",
515 cupsBackChannelWrite(buffer, bytes, 1.0);
526 * End of "$Id: socket.c 9793 2011-05-20 03:49:49Z mike $".