]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | /* |
f2d18633 | 2 | * "$Id$" |
ef416fc2 | 3 | * |
eac3a0a0 | 4 | * AppSocket backend for CUPS. |
ef416fc2 | 5 | * |
f3c17241 | 6 | * Copyright 2007-2012 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 | 75 | time_t start_time; /* Time of first connect */ |
c0e1af83 | 76 | int contimeout; /* Connection timeout */ |
fa73b229 | 77 | int waiteof; /* Wait for end-of-file? */ |
ef416fc2 | 78 | int port; /* Port number */ |
79 | char portname[255]; /* Port name */ | |
80 | int delay; /* Delay for retries... */ | |
ed486911 | 81 | int device_fd; /* AppSocket */ |
ef416fc2 | 82 | int error; /* Error code (if any) */ |
26d47ec6 | 83 | http_addrlist_t *addrlist, /* Address list */ |
db1f069b | 84 | *addr; /* Connected address */ |
26d47ec6 | 85 | char addrname[256]; /* Address name */ |
5a9febac | 86 | int snmp_enabled = 1; /* Is SNMP enabled? */ |
568fa3fa MS |
87 | int snmp_fd, /* SNMP socket */ |
88 | start_count, /* Page count via SNMP at start */ | |
426c6a59 MS |
89 | page_count, /* Page count via SNMP */ |
90 | have_supplies; /* Printer supports supply levels? */ | |
eac3a0a0 MS |
91 | ssize_t bytes = 0, /* Initial bytes read */ |
92 | tbytes; /* Total number of bytes written */ | |
93 | char buffer[1024]; /* Initial print buffer */ | |
ef416fc2 | 94 | #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET) |
95 | struct sigaction action; /* Actions for POSIX signals */ | |
96 | #endif /* HAVE_SIGACTION && !HAVE_SIGSET */ | |
97 | ||
98 | ||
99 | /* | |
100 | * Make sure status messages are not buffered... | |
101 | */ | |
102 | ||
103 | setbuf(stderr, NULL); | |
104 | ||
105 | /* | |
106 | * Ignore SIGPIPE signals... | |
107 | */ | |
108 | ||
109 | #ifdef HAVE_SIGSET | |
110 | sigset(SIGPIPE, SIG_IGN); | |
111 | #elif defined(HAVE_SIGACTION) | |
112 | memset(&action, 0, sizeof(action)); | |
113 | action.sa_handler = SIG_IGN; | |
114 | sigaction(SIGPIPE, &action, NULL); | |
115 | #else | |
116 | signal(SIGPIPE, SIG_IGN); | |
117 | #endif /* HAVE_SIGSET */ | |
118 | ||
119 | /* | |
120 | * Check command-line... | |
121 | */ | |
122 | ||
123 | if (argc == 1) | |
124 | { | |
8b450588 MS |
125 | printf("network socket \"Unknown\" \"%s\"\n", |
126 | _cupsLangString(cupsLangDefault(), _("AppSocket/HP JetDirect"))); | |
ef416fc2 | 127 | return (CUPS_BACKEND_OK); |
128 | } | |
129 | else if (argc < 6 || argc > 7) | |
130 | { | |
db1f069b | 131 | _cupsLangPrintf(stderr, |
0837b7e8 | 132 | _("Usage: %s job-id user title copies options [file]"), |
db1f069b | 133 | argv[0]); |
ef416fc2 | 134 | return (CUPS_BACKEND_FAILED); |
135 | } | |
136 | ||
137 | /* | |
138 | * If we have 7 arguments, print the file named on the command-line. | |
139 | * Otherwise, send stdin instead... | |
140 | */ | |
141 | ||
142 | if (argc == 6) | |
143 | { | |
ed486911 | 144 | print_fd = 0; |
145 | copies = 1; | |
ef416fc2 | 146 | } |
147 | else | |
148 | { | |
149 | /* | |
150 | * Try to open the print file... | |
151 | */ | |
152 | ||
ed486911 | 153 | if ((print_fd = open(argv[6], O_RDONLY)) < 0) |
ef416fc2 | 154 | { |
0837b7e8 | 155 | _cupsLangPrintError("ERROR", _("Unable to open print file")); |
ef416fc2 | 156 | return (CUPS_BACKEND_FAILED); |
157 | } | |
158 | ||
159 | copies = atoi(argv[4]); | |
160 | } | |
161 | ||
162 | /* | |
163 | * Extract the hostname and port number from the URI... | |
164 | */ | |
165 | ||
0268488e MS |
166 | while ((device_uri = cupsBackendDeviceURI(argv)) == NULL) |
167 | { | |
168 | _cupsLangPrintFilter(stderr, "INFO", _("Unable to locate printer.")); | |
169 | sleep(10); | |
170 | ||
171 | if (getenv("CLASS") != NULL) | |
172 | return (CUPS_BACKEND_FAILED); | |
173 | } | |
1f0275e3 | 174 | |
acb056cb MS |
175 | httpSeparateURI(HTTP_URI_CODING_ALL, device_uri, scheme, sizeof(scheme), |
176 | username, sizeof(username), hostname, sizeof(hostname), &port, | |
ef416fc2 | 177 | resource, sizeof(resource)); |
178 | ||
179 | if (port == 0) | |
180 | port = 9100; /* Default to HP JetDirect/Tektronix PhaserShare */ | |
181 | ||
fa73b229 | 182 | /* |
183 | * Get options, if any... | |
184 | */ | |
185 | ||
c0e1af83 | 186 | waiteof = 1; |
187 | contimeout = 7 * 24 * 60 * 60; | |
fa73b229 | 188 | |
189 | if ((options = strchr(resource, '?')) != NULL) | |
190 | { | |
191 | /* | |
192 | * Yup, terminate the device name string and move to the first | |
193 | * character of the options... | |
194 | */ | |
195 | ||
196 | *options++ = '\0'; | |
197 | ||
198 | /* | |
199 | * Parse options... | |
200 | */ | |
201 | ||
202 | while (*options) | |
203 | { | |
204 | /* | |
205 | * Get the name... | |
206 | */ | |
207 | ||
db1f069b | 208 | name = options; |
fa73b229 | 209 | |
db1f069b MS |
210 | while (*options && *options != '=' && *options != '+' && *options != '&') |
211 | options ++; | |
212 | ||
213 | if ((sep = *options) != '\0') | |
214 | *options++ = '\0'; | |
215 | ||
216 | if (sep == '=') | |
fa73b229 | 217 | { |
218 | /* | |
219 | * Get the value... | |
220 | */ | |
221 | ||
db1f069b | 222 | value = options; |
fa73b229 | 223 | |
db1f069b | 224 | while (*options && *options != '+' && *options != '&') |
fa73b229 | 225 | options ++; |
db1f069b MS |
226 | |
227 | if (*options) | |
228 | *options++ = '\0'; | |
fa73b229 | 229 | } |
230 | else | |
db1f069b | 231 | value = (char *)""; |
fa73b229 | 232 | |
233 | /* | |
234 | * Process the option... | |
235 | */ | |
236 | ||
88f9aafc | 237 | if (!_cups_strcasecmp(name, "waiteof")) |
fa73b229 | 238 | { |
239 | /* | |
240 | * Set the wait-for-eof value... | |
241 | */ | |
242 | ||
88f9aafc MS |
243 | waiteof = !value[0] || !_cups_strcasecmp(value, "on") || |
244 | !_cups_strcasecmp(value, "yes") || !_cups_strcasecmp(value, "true"); | |
fa73b229 | 245 | } |
5a9febac MS |
246 | else if (!_cups_strcasecmp(name, "snmp")) |
247 | { | |
248 | /* | |
249 | * Enable/disable SNMP stuff... | |
250 | */ | |
251 | ||
252 | snmp_enabled = !value[0] || !_cups_strcasecmp(value, "on") || | |
253 | _cups_strcasecmp(value, "yes") || | |
254 | _cups_strcasecmp(value, "true"); | |
255 | } | |
88f9aafc | 256 | else if (!_cups_strcasecmp(name, "contimeout")) |
c0e1af83 | 257 | { |
258 | /* | |
259 | * Set the connection timeout... | |
260 | */ | |
261 | ||
262 | if (atoi(value) > 0) | |
263 | contimeout = atoi(value); | |
264 | } | |
fa73b229 | 265 | } |
266 | } | |
267 | ||
ef416fc2 | 268 | /* |
c8fef167 | 269 | * Then try finding the remote host... |
ef416fc2 | 270 | */ |
271 | ||
4d301e69 | 272 | start_time = time(NULL); |
c0e1af83 | 273 | |
ef416fc2 | 274 | sprintf(portname, "%d", port); |
275 | ||
acb056cb | 276 | fputs("STATE: +connecting-to-device\n", stderr); |
1340db2d MS |
277 | fprintf(stderr, "DEBUG: Looking up \"%s\"...\n", hostname); |
278 | ||
0268488e | 279 | while ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL) |
ef416fc2 | 280 | { |
0268488e | 281 | _cupsLangPrintFilter(stderr, "INFO", |
0837b7e8 | 282 | _("Unable to locate printer \"%s\"."), hostname); |
0268488e MS |
283 | sleep(10); |
284 | ||
285 | if (getenv("CLASS") != NULL) | |
c8fef167 MS |
286 | { |
287 | fputs("STATE: -connecting-to-device\n", stderr); | |
0268488e | 288 | return (CUPS_BACKEND_STOP); |
c8fef167 MS |
289 | } |
290 | } | |
291 | ||
292 | /* | |
293 | * See if the printer supports SNMP... | |
294 | */ | |
295 | ||
5a9febac MS |
296 | if (snmp_enabled) |
297 | snmp_fd = _cupsSNMPOpen(addrlist->addr.addr.sa_family); | |
298 | else | |
299 | snmp_fd = -1; | |
300 | ||
301 | if (snmp_fd >= 0) | |
f14324a7 MS |
302 | have_supplies = !backendSNMPSupplies(snmp_fd, &(addrlist->addr), |
303 | &start_count, NULL); | |
c8fef167 MS |
304 | else |
305 | have_supplies = start_count = 0; | |
306 | ||
307 | /* | |
308 | * Wait for data from the filter... | |
309 | */ | |
310 | ||
311 | if (print_fd == 0) | |
eac3a0a0 | 312 | { |
f14324a7 | 313 | if (!backendWaitLoop(snmp_fd, &(addrlist->addr), 1, backendNetworkSideCB)) |
c8fef167 | 314 | return (CUPS_BACKEND_OK); |
eac3a0a0 MS |
315 | else if ((bytes = read(0, buffer, sizeof(buffer))) <= 0) |
316 | return (CUPS_BACKEND_OK); | |
317 | } | |
c8fef167 MS |
318 | |
319 | /* | |
320 | * Connect to the printer... | |
321 | */ | |
ef416fc2 | 322 | |
acb056cb | 323 | fprintf(stderr, "DEBUG: Connecting to %s:%d\n", hostname, port); |
0837b7e8 | 324 | _cupsLangPrintFilter(stderr, "INFO", _("Connecting to printer.")); |
ef416fc2 | 325 | |
ed486911 | 326 | for (delay = 5;;) |
ef416fc2 | 327 | { |
26d47ec6 | 328 | if ((addr = httpAddrConnect(addrlist, &device_fd)) == NULL) |
ef416fc2 | 329 | { |
ed486911 | 330 | error = errno; |
331 | device_fd = -1; | |
ef416fc2 | 332 | |
ed486911 | 333 | if (getenv("CLASS") != NULL) |
334 | { | |
335 | /* | |
336 | * If the CLASS environment variable is set, the job was submitted | |
337 | * to a class and not to a specific queue. In this case, we want | |
338 | * to abort immediately so that the job can be requeued on the next | |
339 | * available printer in the class. | |
340 | */ | |
ef416fc2 | 341 | |
0837b7e8 MS |
342 | _cupsLangPrintFilter(stderr, "INFO", |
343 | _("Unable to contact printer, queuing on next " | |
344 | "printer in class.")); | |
ef416fc2 | 345 | |
ed486911 | 346 | /* |
347 | * Sleep 5 seconds to keep the job from requeuing too rapidly... | |
348 | */ | |
ef416fc2 | 349 | |
ed486911 | 350 | sleep(5); |
ef416fc2 | 351 | |
ed486911 | 352 | return (CUPS_BACKEND_FAILED); |
353 | } | |
ef416fc2 | 354 | |
c7017ecc MS |
355 | fprintf(stderr, "DEBUG: Connection error: %s\n", strerror(error)); |
356 | ||
ed486911 | 357 | if (error == ECONNREFUSED || error == EHOSTDOWN || |
358 | error == EHOSTUNREACH) | |
359 | { | |
c0e1af83 | 360 | if (contimeout && (time(NULL) - start_time) > contimeout) |
361 | { | |
0837b7e8 MS |
362 | _cupsLangPrintFilter(stderr, "ERROR", |
363 | _("The printer is not responding.")); | |
c0e1af83 | 364 | return (CUPS_BACKEND_FAILED); |
365 | } | |
366 | ||
c7017ecc MS |
367 | switch (error) |
368 | { | |
369 | case EHOSTDOWN : | |
0837b7e8 | 370 | _cupsLangPrintFilter(stderr, "WARNING", |
22c9029b MS |
371 | _("The printer may not exist or " |
372 | "is unavailable at this time.")); | |
c7017ecc MS |
373 | break; |
374 | ||
375 | case EHOSTUNREACH : | |
0837b7e8 | 376 | _cupsLangPrintFilter(stderr, "WARNING", |
22c9029b MS |
377 | _("The printer is unreachable at this " |
378 | "time.")); | |
c7017ecc MS |
379 | break; |
380 | ||
381 | case ECONNREFUSED : | |
382 | default : | |
0837b7e8 | 383 | _cupsLangPrintFilter(stderr, "WARNING", |
f3c17241 | 384 | _("The printer is in use.")); |
c7017ecc MS |
385 | break; |
386 | } | |
c0e1af83 | 387 | |
ed486911 | 388 | sleep(delay); |
ef416fc2 | 389 | |
ed486911 | 390 | if (delay < 30) |
391 | delay += 5; | |
ef416fc2 | 392 | } |
393 | else | |
ed486911 | 394 | { |
0837b7e8 | 395 | _cupsLangPrintFilter(stderr, "ERROR", |
22c9029b | 396 | _("The printer is not responding.")); |
ed486911 | 397 | sleep(30); |
398 | } | |
ef416fc2 | 399 | } |
ed486911 | 400 | else |
401 | break; | |
402 | } | |
ef416fc2 | 403 | |
ed486911 | 404 | fputs("STATE: -connecting-to-device\n", stderr); |
0837b7e8 | 405 | _cupsLangPrintFilter(stderr, "INFO", _("Connected to printer.")); |
26d47ec6 | 406 | |
22c9029b MS |
407 | fprintf(stderr, "DEBUG: Connected to %s:%d...\n", |
408 | httpAddrString(&(addr->addr), addrname, sizeof(addrname)), | |
a469f8a5 | 409 | httpAddrPort(&(addr->addr))); |
ef416fc2 | 410 | |
ed486911 | 411 | /* |
412 | * Print everything... | |
413 | */ | |
ef416fc2 | 414 | |
ed486911 | 415 | tbytes = 0; |
ef416fc2 | 416 | |
eac3a0a0 MS |
417 | if (bytes > 0) |
418 | tbytes += write(device_fd, buffer, bytes); | |
419 | ||
ed486911 | 420 | while (copies > 0 && tbytes >= 0) |
421 | { | |
ef416fc2 | 422 | copies --; |
423 | ||
ed486911 | 424 | if (print_fd != 0) |
ef416fc2 | 425 | { |
426 | fputs("PAGE: 1 1\n", stderr); | |
ed486911 | 427 | lseek(print_fd, 0, SEEK_SET); |
ef416fc2 | 428 | } |
429 | ||
f14324a7 MS |
430 | tbytes = backendRunLoop(print_fd, device_fd, snmp_fd, &(addrlist->addr), 1, |
431 | 0, backendNetworkSideCB); | |
ef416fc2 | 432 | |
ed486911 | 433 | if (print_fd != 0 && tbytes >= 0) |
0837b7e8 | 434 | _cupsLangPrintFilter(stderr, "INFO", _("Print file sent.")); |
ed486911 | 435 | } |
ef416fc2 | 436 | |
ed486911 | 437 | if (waiteof) |
438 | { | |
439 | /* | |
440 | * Shutdown the socket and wait for the other end to finish... | |
441 | */ | |
ef416fc2 | 442 | |
0837b7e8 | 443 | _cupsLangPrintFilter(stderr, "INFO", _("Waiting for printer to finish.")); |
ef416fc2 | 444 | |
ed486911 | 445 | shutdown(device_fd, 1); |
ef416fc2 | 446 | |
323c5de1 | 447 | while (wait_bc(device_fd, 90) > 0); |
ed486911 | 448 | } |
ef416fc2 | 449 | |
568fa3fa MS |
450 | /* |
451 | * Collect the final page count as needed... | |
452 | */ | |
453 | ||
f14324a7 MS |
454 | if (have_supplies && |
455 | !backendSNMPSupplies(snmp_fd, &(addrlist->addr), &page_count, NULL) && | |
568fa3fa MS |
456 | page_count > start_count) |
457 | fprintf(stderr, "PAGE: total %d\n", page_count - start_count); | |
458 | ||
ed486911 | 459 | /* |
460 | * Close the socket connection... | |
461 | */ | |
ef416fc2 | 462 | |
ed486911 | 463 | close(device_fd); |
ef416fc2 | 464 | |
465 | httpAddrFreeList(addrlist); | |
466 | ||
467 | /* | |
468 | * Close the input file and return... | |
469 | */ | |
470 | ||
ed486911 | 471 | if (print_fd != 0) |
472 | close(print_fd); | |
ef416fc2 | 473 | |
c8fef167 | 474 | return (CUPS_BACKEND_OK); |
ef416fc2 | 475 | } |
476 | ||
477 | ||
f7deaa1a | 478 | /* |
323c5de1 | 479 | * 'wait_bc()' - Wait for back-channel data... |
480 | */ | |
481 | ||
482 | static int /* O - # bytes read or -1 on error */ | |
483 | wait_bc(int device_fd, /* I - Socket */ | |
484 | int secs) /* I - Seconds to wait */ | |
485 | { | |
486 | struct timeval timeout; /* Timeout for select() */ | |
487 | fd_set input; /* Input set for select() */ | |
488 | ssize_t bytes; /* Number of back-channel bytes read */ | |
489 | char buffer[1024]; /* Back-channel buffer */ | |
490 | ||
491 | ||
492 | /* | |
493 | * Wait up to "secs" seconds for backchannel data... | |
494 | */ | |
495 | ||
496 | timeout.tv_sec = secs; | |
497 | timeout.tv_usec = 0; | |
498 | ||
499 | FD_ZERO(&input); | |
500 | FD_SET(device_fd, &input); | |
501 | ||
502 | if (select(device_fd + 1, &input, NULL, NULL, &timeout) > 0) | |
503 | { | |
504 | /* | |
505 | * Grab the data coming back and spit it out to stderr... | |
506 | */ | |
507 | ||
508 | if ((bytes = read(device_fd, buffer, sizeof(buffer))) > 0) | |
509 | { | |
4d301e69 | 510 | fprintf(stderr, "DEBUG: Received %d bytes of back-channel data\n", |
323c5de1 | 511 | (int)bytes); |
512 | cupsBackChannelWrite(buffer, bytes, 1.0); | |
513 | } | |
514 | ||
515 | return (bytes); | |
516 | } | |
517 | else | |
518 | return (-1); | |
519 | } | |
520 | ||
521 | ||
522 | /* | |
f2d18633 | 523 | * End of "$Id$". |
ef416fc2 | 524 | */ |