]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | /* |
b19ccc9e | 2 | * "$Id: socket.c 7881 2008-08-28 20:21:56Z mike $" |
ef416fc2 | 3 | * |
4 | * AppSocket backend for the Common UNIX Printing System (CUPS). | |
5 | * | |
f8b3a85b | 6 | * Copyright 2007-2010 by Apple Inc. |
f7deaa1a | 7 | * Copyright 1997-2007 by Easy Software Products, all rights reserved. |
ef416fc2 | 8 | * |
9 | * These coded instructions, statements, and computer programs are the | |
bc44d920 | 10 | * property of Apple Inc. and are protected by Federal copyright |
11 | * law. Distribution and use rights are outlined in the file "LICENSE.txt" | |
ef416fc2 | 12 | * "LICENSE" which should have been included with this file. If this |
bc44d920 | 13 | * file is missing or damaged, see the license at "http://www.cups.org/". |
ef416fc2 | 14 | * |
15 | * This file is subject to the Apple OS-Developed Software exception. | |
16 | * | |
17 | * Contents: | |
18 | * | |
f7deaa1a | 19 | * main() - Send a file to the printer or server. |
323c5de1 | 20 | * wait_bc() - Wait for back-channel data... |
ef416fc2 | 21 | */ |
22 | ||
23 | /* | |
24 | * Include necessary headers. | |
25 | */ | |
26 | ||
ef416fc2 | 27 | #include <cups/http-private.h> |
ed486911 | 28 | #include "backend-private.h" |
ef416fc2 | 29 | #include <stdarg.h> |
ef416fc2 | 30 | #include <sys/types.h> |
31 | #include <sys/stat.h> | |
ef416fc2 | 32 | |
33 | #ifdef WIN32 | |
34 | # include <winsock.h> | |
35 | #else | |
36 | # include <unistd.h> | |
37 | # include <fcntl.h> | |
38 | # include <sys/socket.h> | |
39 | # include <netinet/in.h> | |
40 | # include <arpa/inet.h> | |
41 | # include <netdb.h> | |
42 | #endif /* WIN32 */ | |
43 | ||
44 | ||
f7deaa1a | 45 | /* |
46 | * Local functions... | |
47 | */ | |
48 | ||
323c5de1 | 49 | static int wait_bc(int device_fd, int secs); |
f7deaa1a | 50 | |
51 | ||
ef416fc2 | 52 | /* |
53 | * 'main()' - Send a file to the printer or server. | |
54 | * | |
55 | * Usage: | |
56 | * | |
57 | * printer-uri job-id user title copies options [file] | |
58 | */ | |
59 | ||
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 */ | |
63 | { | |
1f0275e3 | 64 | const char *device_uri; /* Device URI */ |
acb056cb | 65 | char scheme[255], /* Scheme in URI */ |
ef416fc2 | 66 | hostname[1024], /* Hostname */ |
67 | username[255], /* Username info (not used) */ | |
fa73b229 | 68 | resource[1024], /* Resource info (not used) */ |
69 | *options, /* Pointer to options */ | |
db1f069b MS |
70 | *name, /* Name of option */ |
71 | *value, /* Value of option */ | |
72 | sep; /* Option separator */ | |
ed486911 | 73 | int print_fd; /* Print file */ |
ef416fc2 | 74 | int copies; /* Number of copies to print */ |
f8b3a85b MS |
75 | time_t start_time; /* Time of first connect */ |
76 | #ifdef __APPLE__ | |
77 | time_t current_time, /* Current time */ | |
5f64df29 | 78 | wait_time; /* Time to wait before shutting down socket */ |
f8b3a85b | 79 | #endif /* __APPLE__ */ |
c0e1af83 | 80 | int contimeout; /* Connection timeout */ |
fa73b229 | 81 | int waiteof; /* Wait for end-of-file? */ |
ef416fc2 | 82 | int port; /* Port number */ |
83 | char portname[255]; /* Port name */ | |
84 | int delay; /* Delay for retries... */ | |
ed486911 | 85 | int device_fd; /* AppSocket */ |
ef416fc2 | 86 | int error; /* Error code (if any) */ |
26d47ec6 | 87 | http_addrlist_t *addrlist, /* Address list */ |
db1f069b | 88 | *addr; /* Connected address */ |
26d47ec6 | 89 | char addrname[256]; /* Address name */ |
568fa3fa MS |
90 | int snmp_fd, /* SNMP socket */ |
91 | start_count, /* Page count via SNMP at start */ | |
426c6a59 MS |
92 | page_count, /* Page count via SNMP */ |
93 | have_supplies; /* Printer supports supply levels? */ | |
ed486911 | 94 | ssize_t tbytes; /* Total number of bytes written */ |
ef416fc2 | 95 | #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET) |
96 | struct sigaction action; /* Actions for POSIX signals */ | |
97 | #endif /* HAVE_SIGACTION && !HAVE_SIGSET */ | |
98 | ||
99 | ||
100 | /* | |
101 | * Make sure status messages are not buffered... | |
102 | */ | |
103 | ||
104 | setbuf(stderr, NULL); | |
105 | ||
106 | /* | |
107 | * Ignore SIGPIPE signals... | |
108 | */ | |
109 | ||
110 | #ifdef HAVE_SIGSET | |
111 | sigset(SIGPIPE, SIG_IGN); | |
112 | #elif defined(HAVE_SIGACTION) | |
113 | memset(&action, 0, sizeof(action)); | |
114 | action.sa_handler = SIG_IGN; | |
115 | sigaction(SIGPIPE, &action, NULL); | |
116 | #else | |
117 | signal(SIGPIPE, SIG_IGN); | |
118 | #endif /* HAVE_SIGSET */ | |
119 | ||
120 | /* | |
121 | * Check command-line... | |
122 | */ | |
123 | ||
124 | if (argc == 1) | |
125 | { | |
8b450588 MS |
126 | printf("network socket \"Unknown\" \"%s\"\n", |
127 | _cupsLangString(cupsLangDefault(), _("AppSocket/HP JetDirect"))); | |
ef416fc2 | 128 | return (CUPS_BACKEND_OK); |
129 | } | |
130 | else if (argc < 6 || argc > 7) | |
131 | { | |
db1f069b MS |
132 | _cupsLangPrintf(stderr, |
133 | _("Usage: %s job-id user title copies options [file]\n"), | |
134 | argv[0]); | |
ef416fc2 | 135 | return (CUPS_BACKEND_FAILED); |
136 | } | |
137 | ||
138 | /* | |
139 | * If we have 7 arguments, print the file named on the command-line. | |
140 | * Otherwise, send stdin instead... | |
141 | */ | |
142 | ||
143 | if (argc == 6) | |
144 | { | |
ed486911 | 145 | print_fd = 0; |
146 | copies = 1; | |
ef416fc2 | 147 | } |
148 | else | |
149 | { | |
150 | /* | |
151 | * Try to open the print file... | |
152 | */ | |
153 | ||
ed486911 | 154 | if ((print_fd = open(argv[6], O_RDONLY)) < 0) |
ef416fc2 | 155 | { |
080811b1 MS |
156 | _cupsLangPrintf(stderr, |
157 | _("ERROR: Unable to open print file \"%s\": %s\n"), | |
158 | argv[6], strerror(errno)); | |
ef416fc2 | 159 | return (CUPS_BACKEND_FAILED); |
160 | } | |
161 | ||
162 | copies = atoi(argv[4]); | |
163 | } | |
164 | ||
165 | /* | |
166 | * Extract the hostname and port number from the URI... | |
167 | */ | |
168 | ||
1f0275e3 MS |
169 | if ((device_uri = cupsBackendDeviceURI(argv)) == NULL) |
170 | return (CUPS_BACKEND_FAILED); | |
171 | ||
acb056cb MS |
172 | httpSeparateURI(HTTP_URI_CODING_ALL, device_uri, scheme, sizeof(scheme), |
173 | username, sizeof(username), hostname, sizeof(hostname), &port, | |
ef416fc2 | 174 | resource, sizeof(resource)); |
175 | ||
176 | if (port == 0) | |
177 | port = 9100; /* Default to HP JetDirect/Tektronix PhaserShare */ | |
178 | ||
fa73b229 | 179 | /* |
180 | * Get options, if any... | |
181 | */ | |
182 | ||
c0e1af83 | 183 | waiteof = 1; |
184 | contimeout = 7 * 24 * 60 * 60; | |
fa73b229 | 185 | |
186 | if ((options = strchr(resource, '?')) != NULL) | |
187 | { | |
188 | /* | |
189 | * Yup, terminate the device name string and move to the first | |
190 | * character of the options... | |
191 | */ | |
192 | ||
193 | *options++ = '\0'; | |
194 | ||
195 | /* | |
196 | * Parse options... | |
197 | */ | |
198 | ||
199 | while (*options) | |
200 | { | |
201 | /* | |
202 | * Get the name... | |
203 | */ | |
204 | ||
db1f069b | 205 | name = options; |
fa73b229 | 206 | |
db1f069b MS |
207 | while (*options && *options != '=' && *options != '+' && *options != '&') |
208 | options ++; | |
209 | ||
210 | if ((sep = *options) != '\0') | |
211 | *options++ = '\0'; | |
212 | ||
213 | if (sep == '=') | |
fa73b229 | 214 | { |
215 | /* | |
216 | * Get the value... | |
217 | */ | |
218 | ||
db1f069b | 219 | value = options; |
fa73b229 | 220 | |
db1f069b | 221 | while (*options && *options != '+' && *options != '&') |
fa73b229 | 222 | options ++; |
db1f069b MS |
223 | |
224 | if (*options) | |
225 | *options++ = '\0'; | |
fa73b229 | 226 | } |
227 | else | |
db1f069b | 228 | value = (char *)""; |
fa73b229 | 229 | |
230 | /* | |
231 | * Process the option... | |
232 | */ | |
233 | ||
234 | if (!strcasecmp(name, "waiteof")) | |
235 | { | |
236 | /* | |
237 | * Set the wait-for-eof value... | |
238 | */ | |
239 | ||
240 | waiteof = !value[0] || !strcasecmp(value, "on") || | |
241 | !strcasecmp(value, "yes") || !strcasecmp(value, "true"); | |
242 | } | |
c0e1af83 | 243 | else if (!strcasecmp(name, "contimeout")) |
244 | { | |
245 | /* | |
246 | * Set the connection timeout... | |
247 | */ | |
248 | ||
249 | if (atoi(value) > 0) | |
250 | contimeout = atoi(value); | |
251 | } | |
fa73b229 | 252 | } |
253 | } | |
254 | ||
ef416fc2 | 255 | /* |
256 | * Then try to connect to the remote host... | |
257 | */ | |
258 | ||
4d301e69 | 259 | start_time = time(NULL); |
c0e1af83 | 260 | |
ef416fc2 | 261 | sprintf(portname, "%d", port); |
262 | ||
acb056cb | 263 | fputs("STATE: +connecting-to-device\n", stderr); |
1340db2d MS |
264 | fprintf(stderr, "DEBUG: Looking up \"%s\"...\n", hostname); |
265 | ||
ef416fc2 | 266 | if ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL) |
267 | { | |
4d301e69 | 268 | _cupsLangPrintf(stderr, _("ERROR: Unable to locate printer \'%s\'\n"), |
db1f069b | 269 | hostname); |
ef416fc2 | 270 | return (CUPS_BACKEND_STOP); |
271 | } | |
272 | ||
acb056cb | 273 | fprintf(stderr, "DEBUG: Connecting to %s:%d\n", hostname, port); |
8b450588 | 274 | _cupsLangPuts(stderr, _("INFO: Connecting to printer...\n")); |
ef416fc2 | 275 | |
ed486911 | 276 | for (delay = 5;;) |
ef416fc2 | 277 | { |
26d47ec6 | 278 | if ((addr = httpAddrConnect(addrlist, &device_fd)) == NULL) |
ef416fc2 | 279 | { |
ed486911 | 280 | error = errno; |
281 | device_fd = -1; | |
ef416fc2 | 282 | |
ed486911 | 283 | if (getenv("CLASS") != NULL) |
284 | { | |
285 | /* | |
286 | * If the CLASS environment variable is set, the job was submitted | |
287 | * to a class and not to a specific queue. In this case, we want | |
288 | * to abort immediately so that the job can be requeued on the next | |
289 | * available printer in the class. | |
290 | */ | |
ef416fc2 | 291 | |
db1f069b MS |
292 | _cupsLangPuts(stderr, |
293 | _("INFO: Unable to contact printer, queuing on next " | |
294 | "printer in class...\n")); | |
ef416fc2 | 295 | |
ed486911 | 296 | /* |
297 | * Sleep 5 seconds to keep the job from requeuing too rapidly... | |
298 | */ | |
ef416fc2 | 299 | |
ed486911 | 300 | sleep(5); |
ef416fc2 | 301 | |
ed486911 | 302 | return (CUPS_BACKEND_FAILED); |
303 | } | |
ef416fc2 | 304 | |
ed486911 | 305 | if (error == ECONNREFUSED || error == EHOSTDOWN || |
306 | error == EHOSTUNREACH) | |
307 | { | |
c0e1af83 | 308 | if (contimeout && (time(NULL) - start_time) > contimeout) |
309 | { | |
4d301e69 | 310 | _cupsLangPuts(stderr, _("ERROR: Printer not responding\n")); |
c0e1af83 | 311 | return (CUPS_BACKEND_FAILED); |
312 | } | |
313 | ||
db1f069b | 314 | _cupsLangPrintf(stderr, |
4d301e69 MS |
315 | _("WARNING: Network host \'%s\' is busy; will retry in " |
316 | "%d seconds...\n"), hostname, delay); | |
c0e1af83 | 317 | |
ed486911 | 318 | sleep(delay); |
ef416fc2 | 319 | |
ed486911 | 320 | if (delay < 30) |
321 | delay += 5; | |
ef416fc2 | 322 | } |
323 | else | |
ed486911 | 324 | { |
db1f069b MS |
325 | _cupsLangPrintf(stderr, "DEBUG: Connection error: %s\n", |
326 | strerror(errno)); | |
327 | _cupsLangPuts(stderr, | |
4d301e69 MS |
328 | _("ERROR: Unable to connect to printer; will retry in 30 " |
329 | "seconds...\n")); | |
ed486911 | 330 | sleep(30); |
331 | } | |
ef416fc2 | 332 | } |
ed486911 | 333 | else |
334 | break; | |
335 | } | |
ef416fc2 | 336 | |
ed486911 | 337 | fputs("STATE: -connecting-to-device\n", stderr); |
8b450588 | 338 | _cupsLangPuts(stderr, _("INFO: Connected to printer...\n")); |
26d47ec6 | 339 | |
340 | #ifdef AF_INET6 | |
341 | if (addr->addr.addr.sa_family == AF_INET6) | |
342 | fprintf(stderr, "DEBUG: Connected to [%s]:%d (IPv6)...\n", | |
c0e1af83 | 343 | httpAddrString(&addr->addr, addrname, sizeof(addrname)), |
344 | ntohs(addr->addr.ipv6.sin6_port)); | |
26d47ec6 | 345 | else |
346 | #endif /* AF_INET6 */ | |
347 | if (addr->addr.addr.sa_family == AF_INET) | |
348 | fprintf(stderr, "DEBUG: Connected to %s:%d (IPv4)...\n", | |
c0e1af83 | 349 | httpAddrString(&addr->addr, addrname, sizeof(addrname)), |
350 | ntohs(addr->addr.ipv4.sin_port)); | |
ef416fc2 | 351 | |
568fa3fa MS |
352 | /* |
353 | * See if the printer supports SNMP... | |
354 | */ | |
355 | ||
7a14d768 | 356 | if ((snmp_fd = _cupsSNMPOpen(addr->addr.addr.sa_family)) >= 0) |
1f0275e3 | 357 | { |
426c6a59 MS |
358 | have_supplies = !backendSNMPSupplies(snmp_fd, &(addr->addr), &start_count, |
359 | NULL); | |
1f0275e3 MS |
360 | } |
361 | else | |
426c6a59 | 362 | have_supplies = start_count = 0; |
568fa3fa | 363 | |
ed486911 | 364 | /* |
365 | * Print everything... | |
366 | */ | |
ef416fc2 | 367 | |
ed486911 | 368 | tbytes = 0; |
ef416fc2 | 369 | |
ed486911 | 370 | while (copies > 0 && tbytes >= 0) |
371 | { | |
ef416fc2 | 372 | copies --; |
373 | ||
ed486911 | 374 | if (print_fd != 0) |
ef416fc2 | 375 | { |
376 | fputs("PAGE: 1 1\n", stderr); | |
ed486911 | 377 | lseek(print_fd, 0, SEEK_SET); |
ef416fc2 | 378 | } |
379 | ||
ef55b745 | 380 | tbytes = backendRunLoop(print_fd, device_fd, snmp_fd, &(addr->addr), 1, 0, |
568fa3fa | 381 | backendNetworkSideCB); |
ef416fc2 | 382 | |
ed486911 | 383 | if (print_fd != 0 && tbytes >= 0) |
db1f069b | 384 | _cupsLangPrintf(stderr, |
c0e1af83 | 385 | #ifdef HAVE_LONG_LONG |
db1f069b | 386 | _("INFO: Sent print file, %lld bytes...\n"), |
c0e1af83 | 387 | #else |
db1f069b | 388 | _("INFO: Sent print file, %ld bytes...\n"), |
c0e1af83 | 389 | #endif /* HAVE_LONG_LONG */ |
db1f069b | 390 | CUPS_LLCAST tbytes); |
ed486911 | 391 | } |
ef416fc2 | 392 | |
f8b3a85b | 393 | #ifdef __APPLE__ |
323c5de1 | 394 | /* |
5f64df29 | 395 | * Wait up to 5 seconds to get any pending back-channel data... |
323c5de1 | 396 | */ |
397 | ||
5f64df29 | 398 | wait_time = time(NULL) + 5; |
9a4f8274 MS |
399 | while (wait_time >= time(¤t_time)) |
400 | if (wait_bc(device_fd, wait_time - current_time) <= 0) | |
5f64df29 | 401 | break; |
f8b3a85b | 402 | #endif /* __APPLE__ */ |
323c5de1 | 403 | |
ed486911 | 404 | if (waiteof) |
405 | { | |
406 | /* | |
407 | * Shutdown the socket and wait for the other end to finish... | |
408 | */ | |
ef416fc2 | 409 | |
db1f069b MS |
410 | _cupsLangPuts(stderr, |
411 | _("INFO: Print file sent, waiting for printer to finish...\n")); | |
ef416fc2 | 412 | |
ed486911 | 413 | shutdown(device_fd, 1); |
ef416fc2 | 414 | |
323c5de1 | 415 | while (wait_bc(device_fd, 90) > 0); |
ed486911 | 416 | } |
ef416fc2 | 417 | |
568fa3fa MS |
418 | /* |
419 | * Collect the final page count as needed... | |
420 | */ | |
421 | ||
426c6a59 | 422 | if (have_supplies && |
568fa3fa MS |
423 | !backendSNMPSupplies(snmp_fd, &(addr->addr), &page_count, NULL) && |
424 | page_count > start_count) | |
425 | fprintf(stderr, "PAGE: total %d\n", page_count - start_count); | |
426 | ||
ed486911 | 427 | /* |
428 | * Close the socket connection... | |
429 | */ | |
ef416fc2 | 430 | |
ed486911 | 431 | close(device_fd); |
ef416fc2 | 432 | |
433 | httpAddrFreeList(addrlist); | |
434 | ||
435 | /* | |
436 | * Close the input file and return... | |
437 | */ | |
438 | ||
ed486911 | 439 | if (print_fd != 0) |
440 | close(print_fd); | |
ef416fc2 | 441 | |
ed486911 | 442 | if (tbytes >= 0) |
db1f069b | 443 | _cupsLangPuts(stderr, _("INFO: Ready to print.\n")); |
ef416fc2 | 444 | |
ed486911 | 445 | return (tbytes < 0 ? CUPS_BACKEND_FAILED : CUPS_BACKEND_OK); |
ef416fc2 | 446 | } |
447 | ||
448 | ||
f7deaa1a | 449 | /* |
323c5de1 | 450 | * 'wait_bc()' - Wait for back-channel data... |
451 | */ | |
452 | ||
453 | static int /* O - # bytes read or -1 on error */ | |
454 | wait_bc(int device_fd, /* I - Socket */ | |
455 | int secs) /* I - Seconds to wait */ | |
456 | { | |
457 | struct timeval timeout; /* Timeout for select() */ | |
458 | fd_set input; /* Input set for select() */ | |
459 | ssize_t bytes; /* Number of back-channel bytes read */ | |
460 | char buffer[1024]; /* Back-channel buffer */ | |
461 | ||
462 | ||
463 | /* | |
464 | * Wait up to "secs" seconds for backchannel data... | |
465 | */ | |
466 | ||
467 | timeout.tv_sec = secs; | |
468 | timeout.tv_usec = 0; | |
469 | ||
470 | FD_ZERO(&input); | |
471 | FD_SET(device_fd, &input); | |
472 | ||
473 | if (select(device_fd + 1, &input, NULL, NULL, &timeout) > 0) | |
474 | { | |
475 | /* | |
476 | * Grab the data coming back and spit it out to stderr... | |
477 | */ | |
478 | ||
479 | if ((bytes = read(device_fd, buffer, sizeof(buffer))) > 0) | |
480 | { | |
4d301e69 | 481 | fprintf(stderr, "DEBUG: Received %d bytes of back-channel data\n", |
323c5de1 | 482 | (int)bytes); |
483 | cupsBackChannelWrite(buffer, bytes, 1.0); | |
484 | } | |
485 | ||
486 | return (bytes); | |
487 | } | |
488 | else | |
489 | return (-1); | |
490 | } | |
491 | ||
492 | ||
493 | /* | |
b19ccc9e | 494 | * End of "$Id: socket.c 7881 2008-08-28 20:21:56Z mike $". |
ef416fc2 | 495 | */ |