]> git.ipfire.org Git - thirdparty/cups.git/blob - backend/ipp.c
Update ipp documentation to reflect the behavior of configuring WiFi on IPP USB printers.
[thirdparty/cups.git] / backend / ipp.c
1 /*
2 * IPP backend for CUPS.
3 *
4 * Copyright © 2007-2019 by Apple Inc.
5 * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
6 *
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
8 * information.
9 */
10
11 /*
12 * Include necessary headers.
13 */
14
15 #include "backend-private.h"
16 #include <cups/ppd-private.h>
17 #include <cups/array-private.h>
18 #include <sys/types.h>
19 #include <sys/stat.h>
20 #include <sys/wait.h>
21 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
22 # include <xpc/xpc.h>
23 # define kPMPrintUIToolAgent "com.apple.printuitool.agent"
24 # define kPMStartJob 100
25 # define kPMWaitForJob 101
26 extern void xpc_connection_set_target_uid(xpc_connection_t connection,
27 uid_t uid);
28 #endif /* HAVE_GSSAPI && HAVE_XPC */
29
30
31 /*
32 * Bits for job-state-reasons we care about...
33 */
34
35 #define _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED 0x01
36 #define _CUPS_JSR_ACCOUNT_CLOSED 0x02
37 #define _CUPS_JSR_ACCOUNT_INFO_NEEDED 0x04
38 #define _CUPS_JSR_ACCOUNT_LIMIT_REACHED 0x08
39 #define _CUPS_JSR_JOB_PASSWORD_WAIT 0x10
40 #define _CUPS_JSR_JOB_RELEASE_WAIT 0x20
41 #define _CUPS_JSR_DOCUMENT_FORMAT_ERROR 0x40
42 #define _CUPS_JSR_DOCUMENT_UNPRINTABLE 0x80
43
44
45 /*
46 * Types...
47 */
48
49 typedef struct _cups_monitor_s /**** Monitoring data ****/
50 {
51 const char *uri, /* Printer URI */
52 *hostname, /* Hostname */
53 *user, /* Username */
54 *resource; /* Resource path */
55 int port, /* Port number */
56 version, /* IPP version */
57 job_id, /* Job ID for submitted job */
58 job_reasons, /* Job state reasons bits */
59 create_job, /* Support Create-Job? */
60 get_job_attrs; /* Support Get-Job-Attributes? */
61 const char *job_name; /* Job name for submitted job */
62 http_encryption_t encryption; /* Use encryption? */
63 ipp_jstate_t job_state; /* Current job state */
64 ipp_pstate_t printer_state; /* Current printer state */
65 int retryable; /* Is this a job that should be retried? */
66 } _cups_monitor_t;
67
68
69 /*
70 * Globals...
71 */
72
73 static const char *auth_info_required;
74 /* New auth-info-required value */
75 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
76 static pid_t child_pid = 0; /* Child process ID */
77 #endif /* HAVE_GSSAPI && HAVE_XPC */
78 static const char * const jattrs[] = /* Job attributes we want */
79 {
80 "job-id",
81 "job-impressions-completed",
82 "job-media-sheets-completed",
83 "job-name",
84 "job-originating-user-name",
85 "job-state",
86 "job-state-reasons"
87 };
88 static int job_canceled = 0,
89 /* Job cancelled? */
90 uri_credentials = 0;
91 /* Credentials supplied in URI? */
92 static char username[256] = "",
93 /* Username for device URI */
94 *password = NULL;
95 /* Password for device URI */
96 static const char * const pattrs[] = /* Printer attributes we want */
97 {
98 #ifdef HAVE_LIBZ
99 "compression-supported",
100 #endif /* HAVE_LIBZ */
101 "copies-supported",
102 "cups-version",
103 "document-format-supported",
104 "job-password-encryption-supported",
105 "marker-colors",
106 "marker-high-levels",
107 "marker-levels",
108 "marker-low-levels",
109 "marker-message",
110 "marker-names",
111 "marker-types",
112 "media-col-supported",
113 "multiple-document-handling-supported",
114 "operations-supported",
115 "print-color-mode-supported",
116 "printer-alert",
117 "printer-alert-description",
118 "printer-is-accepting-jobs",
119 "printer-mandatory-job-attributes",
120 "printer-state",
121 "printer-state-message",
122 "printer-state-reasons"
123 };
124 static const char * const remote_job_states[] =
125 { /* Remote job state keywords */
126 "+cups-remote-pending",
127 "+cups-remote-pending-held",
128 "+cups-remote-processing",
129 "+cups-remote-stopped",
130 "+cups-remote-canceled",
131 "+cups-remote-aborted",
132 "+cups-remote-completed"
133 };
134 static _cups_mutex_t report_mutex = _CUPS_MUTEX_INITIALIZER;
135 /* Mutex to control access */
136 static int num_attr_cache = 0;
137 /* Number of cached attributes */
138 static cups_option_t *attr_cache = NULL;
139 /* Cached attributes */
140 static cups_array_t *state_reasons; /* Array of printe-state-reasons keywords */
141 static char tmpfilename[1024] = "";
142 /* Temporary spool file name */
143 static char mandatory_attrs[1024] = "";
144 /* cupsMandatory value */
145
146
147 /*
148 * Local functions...
149 */
150
151 static void cancel_job(http_t *http, const char *uri, int id,
152 const char *resource, const char *user,
153 int version);
154 static ipp_pstate_t check_printer_state(http_t *http, const char *uri,
155 const char *resource,
156 const char *user, int version);
157 static void debug_attributes(ipp_t *ipp);
158 static void *monitor_printer(_cups_monitor_t *monitor);
159 static ipp_t *new_request(ipp_op_t op, int version, const char *uri,
160 const char *user, const char *title,
161 int num_options, cups_option_t *options,
162 const char *compression, int copies,
163 const char *format, _ppd_cache_t *pc,
164 ppd_file_t *ppd,
165 ipp_attribute_t *media_col_sup,
166 ipp_attribute_t *doc_handling_sup,
167 ipp_attribute_t *print_color_mode_sup);
168 static const char *password_cb(const char *prompt, http_t *http,
169 const char *method, const char *resource,
170 int *user_data);
171 static const char *quote_string(const char *s, char *q, size_t qsize);
172 static void report_attr(ipp_attribute_t *attr);
173 static void report_printer_state(ipp_t *ipp);
174 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
175 static int run_as_user(char *argv[], uid_t uid,
176 const char *device_uri, int fd);
177 #endif /* HAVE_GSSAPI && HAVE_XPC */
178 static void sigterm_handler(int sig);
179 static int timeout_cb(http_t *http, void *user_data);
180 static void update_reasons(ipp_attribute_t *attr, const char *s);
181
182
183 /*
184 * 'main()' - Send a file to the printer or server.
185 *
186 * Usage:
187 *
188 * printer-uri job-id user title copies options [file]
189 */
190
191 int /* O - Exit status */
192 main(int argc, /* I - Number of command-line args */
193 char *argv[]) /* I - Command-line arguments */
194 {
195 int i; /* Looping var */
196 int send_options; /* Send job options? */
197 int num_options; /* Number of printer options */
198 cups_option_t *options; /* Printer options */
199 const char *device_uri; /* Device URI */
200 char scheme[255], /* Scheme in URI */
201 hostname[1024], /* Hostname */
202 resource[1024], /* Resource info (printer name) */
203 addrname[256], /* Address name */
204 *optptr, /* Pointer to URI options */
205 *name, /* Name of option */
206 *value, /* Value of option */
207 sep; /* Separator character */
208 int password_tries = 0; /* Password tries */
209 http_addrlist_t *addrlist; /* Address of printer */
210 int snmp_enabled = 1; /* Is SNMP enabled? */
211 int snmp_fd, /* SNMP socket */
212 start_count, /* Page count via SNMP at start */
213 page_count, /* Page count via SNMP */
214 have_supplies; /* Printer supports supply levels? */
215 int num_files; /* Number of files to print */
216 char **files, /* Files to print */
217 *compatfile = NULL; /* Compatibility filename */
218 off_t compatsize = 0; /* Size of compatibility file */
219 int port; /* Port number (not used) */
220 char uri[HTTP_MAX_URI]; /* Updated URI without user/pass */
221 char print_job_name[1024]; /* Update job-name for Print-Job */
222 http_status_t http_status; /* Status of HTTP request */
223 ipp_status_t ipp_status; /* Status of IPP request */
224 http_t *http; /* HTTP connection */
225 ipp_t *request, /* IPP request */
226 *response, /* IPP response */
227 *supported; /* get-printer-attributes response */
228 time_t start_time; /* Time of first connect */
229 int contimeout; /* Connection timeout */
230 int delay, /* Delay for retries */
231 prev_delay; /* Previous delay */
232 const char *compression; /* Compression mode */
233 int waitjob, /* Wait for job complete? */
234 waitjob_tries = 0, /* Number of times we've waited */
235 waitprinter; /* Wait for printer ready? */
236 time_t waittime; /* Wait time for held jobs */
237 _cups_monitor_t monitor; /* Monitoring data */
238 ipp_attribute_t *job_id_attr; /* job-id attribute */
239 int job_id; /* job-id value */
240 ipp_attribute_t *job_sheets; /* job-media-sheets-completed */
241 ipp_attribute_t *job_state; /* job-state */
242 #ifdef HAVE_LIBZ
243 ipp_attribute_t *compression_sup; /* compression-supported */
244 #endif /* HAVE_LIBZ */
245 ipp_attribute_t *copies_sup; /* copies-supported */
246 ipp_attribute_t *cups_version; /* cups-version */
247 ipp_attribute_t *encryption_sup; /* job-password-encryption-supported */
248 ipp_attribute_t *format_sup; /* document-format-supported */
249 ipp_attribute_t *job_auth; /* job-authorization-uri */
250 ipp_attribute_t *media_col_sup; /* media-col-supported */
251 ipp_attribute_t *operations_sup; /* operations-supported */
252 ipp_attribute_t *doc_handling_sup; /* multiple-document-handling-supported */
253 ipp_attribute_t *printer_state; /* printer-state attribute */
254 ipp_attribute_t *printer_accepting; /* printer-is-accepting-jobs */
255 ipp_attribute_t *print_color_mode_sup;/* Does printer support print-color-mode? */
256 int create_job = 0, /* Does printer support Create-Job? */
257 get_job_attrs = 0, /* Does printer support Get-Job-Attributes? */
258 send_document = 0, /* Does printer support Send-Document? */
259 validate_job = 0, /* Does printer support Validate-Job? */
260 copies, /* Number of copies for job */
261 copies_remaining; /* Number of copies remaining */
262 const char *content_type, /* CONTENT_TYPE environment variable */
263 *final_content_type, /* FINAL_CONTENT_TYPE environment var */
264 *document_format; /* document-format value */
265 int fd; /* File descriptor */
266 off_t bytes = 0; /* Bytes copied */
267 char buffer[16384]; /* Copy buffer */
268 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
269 struct sigaction action; /* Actions for POSIX signals */
270 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
271 int version; /* IPP version */
272 ppd_file_t *ppd = NULL; /* PPD file */
273 _ppd_cache_t *pc = NULL; /* PPD cache and mapping data */
274 fd_set input; /* Input set for select() */
275
276
277 /*
278 * Make sure status messages are not buffered...
279 */
280
281 setbuf(stderr, NULL);
282
283 /*
284 * Ignore SIGPIPE and catch SIGTERM signals...
285 */
286
287 #ifdef HAVE_SIGSET
288 sigset(SIGPIPE, SIG_IGN);
289 sigset(SIGTERM, sigterm_handler);
290 #elif defined(HAVE_SIGACTION)
291 memset(&action, 0, sizeof(action));
292 action.sa_handler = SIG_IGN;
293 sigaction(SIGPIPE, &action, NULL);
294
295 sigemptyset(&action.sa_mask);
296 sigaddset(&action.sa_mask, SIGTERM);
297 action.sa_handler = sigterm_handler;
298 sigaction(SIGTERM, &action, NULL);
299 #else
300 signal(SIGPIPE, SIG_IGN);
301 signal(SIGTERM, sigterm_handler);
302 #endif /* HAVE_SIGSET */
303
304 /*
305 * Check command-line...
306 */
307
308 if (argc == 1)
309 {
310 char *s;
311
312 if ((s = strrchr(argv[0], '/')) != NULL)
313 s ++;
314 else
315 s = argv[0];
316
317 printf("network %s \"Unknown\" \"%s (%s)\"\n",
318 s, _cupsLangString(cupsLangDefault(),
319 _("Internet Printing Protocol")), s);
320 return (CUPS_BACKEND_OK);
321 }
322 else if (argc < 6)
323 {
324 _cupsLangPrintf(stderr,
325 _("Usage: %s job-id user title copies options [file]"),
326 argv[0]);
327 return (CUPS_BACKEND_STOP);
328 }
329
330 /*
331 * Get the device URI...
332 */
333
334 while ((device_uri = cupsBackendDeviceURI(argv)) == NULL)
335 {
336 _cupsLangPrintFilter(stderr, "INFO", _("Unable to locate printer."));
337 sleep(10);
338
339 if (getenv("CLASS") != NULL)
340 return (CUPS_BACKEND_FAILED);
341 }
342
343 if ((auth_info_required = getenv("AUTH_INFO_REQUIRED")) == NULL)
344 auth_info_required = "none";
345
346 state_reasons = _cupsArrayNewStrings(getenv("PRINTER_STATE_REASONS"), ',');
347
348 #ifdef HAVE_GSSAPI
349 /*
350 * For Kerberos, become the printing user (if we can) to get the credentials
351 * that way.
352 */
353
354 if (!getuid() && (value = getenv("AUTH_UID")) != NULL)
355 {
356 uid_t uid = (uid_t)atoi(value);
357 /* User ID */
358
359 # ifdef HAVE_XPC
360 if (uid > 0)
361 {
362 if (argc == 6)
363 return (run_as_user(argv, uid, device_uri, 0));
364 else
365 {
366 int status = 0; /* Exit status */
367
368 for (i = 6; i < argc && !status && !job_canceled; i ++)
369 {
370 if ((fd = open(argv[i], O_RDONLY)) >= 0)
371 {
372 status = run_as_user(argv, uid, device_uri, fd);
373 close(fd);
374 }
375 else
376 {
377 _cupsLangPrintError("ERROR", _("Unable to open print file"));
378 status = CUPS_BACKEND_FAILED;
379 }
380 }
381
382 return (status);
383 }
384 }
385
386 # else /* No XPC, just try to run as the user ID */
387 if (uid > 0)
388 setuid(uid);
389 # endif /* HAVE_XPC */
390 }
391 #endif /* HAVE_GSSAPI */
392
393 /*
394 * Get the (final) content type...
395 */
396
397 if ((content_type = getenv("CONTENT_TYPE")) == NULL)
398 content_type = "application/octet-stream";
399
400 if ((final_content_type = getenv("FINAL_CONTENT_TYPE")) == NULL)
401 {
402 final_content_type = content_type;
403
404 if (!strncmp(final_content_type, "printer/", 8))
405 final_content_type = "application/vnd.cups-raw";
406 }
407
408 /*
409 * Extract the hostname and printer name from the URI...
410 */
411
412 httpSeparateURI(HTTP_URI_CODING_ALL, device_uri, scheme, sizeof(scheme),
413 username, sizeof(username), hostname, sizeof(hostname), &port,
414 resource, sizeof(resource));
415
416 if (!port)
417 port = IPP_PORT; /* Default to port 631 */
418
419 if (!strcmp(scheme, "https") || !strcmp(scheme, "ipps"))
420 cupsSetEncryption(HTTP_ENCRYPTION_ALWAYS);
421 else
422 cupsSetEncryption(HTTP_ENCRYPTION_IF_REQUESTED);
423
424 /*
425 * See if there are any options...
426 */
427
428 compression = NULL;
429 version = 20;
430 waitjob = 1;
431 waitprinter = 1;
432 contimeout = 7 * 24 * 60 * 60;
433
434 if ((optptr = strchr(resource, '?')) != NULL)
435 {
436 /*
437 * Yup, terminate the device name string and move to the first
438 * character of the optptr...
439 */
440
441 *optptr++ = '\0';
442
443 /*
444 * Then parse the optptr...
445 */
446
447 while (*optptr)
448 {
449 /*
450 * Get the name...
451 */
452
453 name = optptr;
454
455 while (*optptr && *optptr != '=' && *optptr != '+' && *optptr != '&')
456 optptr ++;
457
458 if ((sep = *optptr) != '\0')
459 *optptr++ = '\0';
460
461 if (sep == '=')
462 {
463 /*
464 * Get the value...
465 */
466
467 value = optptr;
468
469 while (*optptr && *optptr != '+' && *optptr != '&')
470 optptr ++;
471
472 if (*optptr)
473 *optptr++ = '\0';
474 }
475 else
476 value = (char *)"";
477
478 /*
479 * Process the option...
480 */
481
482 if (!_cups_strcasecmp(name, "waitjob"))
483 {
484 /*
485 * Wait for job completion?
486 */
487
488 waitjob = !_cups_strcasecmp(value, "on") ||
489 !_cups_strcasecmp(value, "yes") ||
490 !_cups_strcasecmp(value, "true");
491 }
492 else if (!_cups_strcasecmp(name, "waitprinter"))
493 {
494 /*
495 * Wait for printer idle?
496 */
497
498 waitprinter = !_cups_strcasecmp(value, "on") ||
499 !_cups_strcasecmp(value, "yes") ||
500 !_cups_strcasecmp(value, "true");
501 }
502 else if (!_cups_strcasecmp(name, "encryption"))
503 {
504 /*
505 * Enable/disable encryption?
506 */
507
508 if (!_cups_strcasecmp(value, "always"))
509 cupsSetEncryption(HTTP_ENCRYPTION_ALWAYS);
510 else if (!_cups_strcasecmp(value, "required"))
511 cupsSetEncryption(HTTP_ENCRYPTION_REQUIRED);
512 else if (!_cups_strcasecmp(value, "never"))
513 cupsSetEncryption(HTTP_ENCRYPTION_NEVER);
514 else if (!_cups_strcasecmp(value, "ifrequested"))
515 cupsSetEncryption(HTTP_ENCRYPTION_IF_REQUESTED);
516 else
517 {
518 _cupsLangPrintFilter(stderr, "ERROR",
519 _("Unknown encryption option value: \"%s\"."),
520 value);
521 }
522 }
523 else if (!_cups_strcasecmp(name, "snmp"))
524 {
525 /*
526 * Enable/disable SNMP stuff...
527 */
528
529 snmp_enabled = !value[0] || !_cups_strcasecmp(value, "on") ||
530 !_cups_strcasecmp(value, "yes") ||
531 !_cups_strcasecmp(value, "true");
532 }
533 else if (!_cups_strcasecmp(name, "version"))
534 {
535 if (!strcmp(value, "1.0"))
536 version = 10;
537 else if (!strcmp(value, "1.1"))
538 version = 11;
539 else if (!strcmp(value, "2.0"))
540 version = 20;
541 else if (!strcmp(value, "2.1"))
542 version = 21;
543 else if (!strcmp(value, "2.2"))
544 version = 22;
545 else
546 {
547 _cupsLangPrintFilter(stderr, "ERROR",
548 _("Unknown version option value: \"%s\"."),
549 value);
550 }
551 }
552 #ifdef HAVE_LIBZ
553 else if (!_cups_strcasecmp(name, "compression"))
554 {
555 if (!_cups_strcasecmp(value, "true") || !_cups_strcasecmp(value, "yes") ||
556 !_cups_strcasecmp(value, "on") || !_cups_strcasecmp(value, "gzip"))
557 compression = "gzip";
558 else if (!_cups_strcasecmp(value, "deflate"))
559 compression = "deflate";
560 else if (!_cups_strcasecmp(value, "false") ||
561 !_cups_strcasecmp(value, "no") ||
562 !_cups_strcasecmp(value, "off") ||
563 !_cups_strcasecmp(value, "none"))
564 compression = "none";
565 }
566 #endif /* HAVE_LIBZ */
567 else if (!_cups_strcasecmp(name, "contimeout"))
568 {
569 /*
570 * Set the connection timeout...
571 */
572
573 if (atoi(value) > 0)
574 contimeout = atoi(value);
575 }
576 else
577 {
578 /*
579 * Unknown option...
580 */
581
582 _cupsLangPrintFilter(stderr, "ERROR",
583 _("Unknown option \"%s\" with value \"%s\"."),
584 name, value);
585 }
586 }
587 }
588
589 /*
590 * If we have 7 arguments, print the file named on the command-line.
591 * Otherwise, copy stdin to a temporary file and print the temporary
592 * file.
593 */
594
595 if (argc == 6)
596 {
597 num_files = 0;
598 files = NULL;
599 send_options = !_cups_strcasecmp(final_content_type, "application/pdf") ||
600 !_cups_strcasecmp(final_content_type, "application/vnd.cups-pdf") ||
601 !_cups_strncasecmp(final_content_type, "image/", 6);
602
603 fputs("DEBUG: Sending stdin for job...\n", stderr);
604 }
605 else
606 {
607 /*
608 * Point to the files on the command-line...
609 */
610
611 num_files = argc - 6;
612 files = argv + 6;
613 send_options = 1;
614
615 fprintf(stderr, "DEBUG: %d files to send in job...\n", num_files);
616 }
617
618 /*
619 * Set the authentication info, if any...
620 */
621
622 cupsSetPasswordCB2((cups_password_cb2_t)password_cb, &password_tries);
623
624 if (username[0])
625 {
626 /*
627 * Use authentication information in the device URI...
628 */
629
630 if ((password = strchr(username, ':')) != NULL)
631 *password++ = '\0';
632
633 cupsSetUser(username);
634 uri_credentials = 1;
635 }
636 else
637 {
638 /*
639 * Try loading authentication information from the environment.
640 */
641
642 const char *ptr = getenv("AUTH_USERNAME");
643
644 if (ptr)
645 {
646 strlcpy(username, ptr, sizeof(username));
647 cupsSetUser(ptr);
648 }
649
650 password = getenv("AUTH_PASSWORD");
651 }
652
653 /*
654 * Try finding the remote server...
655 */
656
657 start_time = time(NULL);
658
659 addrlist = backendLookup(hostname, port, &job_canceled);
660
661 http = httpConnect2(hostname, port, addrlist, AF_UNSPEC, cupsEncryption(), 1,
662 0, NULL);
663 httpSetTimeout(http, 30.0, timeout_cb, NULL);
664
665 /*
666 * See if the printer supports SNMP...
667 */
668
669 if (snmp_enabled)
670 snmp_fd = _cupsSNMPOpen(addrlist->addr.addr.sa_family);
671 else
672 snmp_fd = -1;
673
674 if (snmp_fd >= 0)
675 have_supplies = !backendSNMPSupplies(snmp_fd, &(addrlist->addr),
676 &start_count, NULL);
677 else
678 have_supplies = start_count = 0;
679
680 /*
681 * Wait for data from the filter...
682 */
683
684 if (num_files == 0)
685 {
686 if (!backendWaitLoop(snmp_fd, &(addrlist->addr), 0, backendNetworkSideCB))
687 return (CUPS_BACKEND_OK);
688 else if ((bytes = read(0, buffer, sizeof(buffer))) <= 0)
689 return (CUPS_BACKEND_OK);
690 }
691
692 /*
693 * Try connecting to the remote server...
694 */
695
696 delay = _cupsNextDelay(0, &prev_delay);
697
698 do
699 {
700 fprintf(stderr, "DEBUG: Connecting to %s:%d\n", hostname, port);
701 _cupsLangPrintFilter(stderr, "INFO", _("Connecting to printer."));
702
703 if (httpReconnect2(http, 30000, NULL))
704 {
705 int error = errno; /* Connection error */
706
707 if (http->status == HTTP_STATUS_CUPS_PKI_ERROR)
708 update_reasons(NULL, "+cups-certificate-error");
709
710 if (job_canceled)
711 break;
712
713 if (getenv("CLASS") != NULL)
714 {
715 /*
716 * If the CLASS environment variable is set, the job was submitted
717 * to a class and not to a specific queue. In this case, we want
718 * to abort immediately so that the job can be requeued on the next
719 * available printer in the class.
720 */
721
722 _cupsLangPrintFilter(stderr, "INFO",
723 _("Unable to contact printer, queuing on next "
724 "printer in class."));
725
726 /*
727 * Sleep 5 seconds to keep the job from requeuing too rapidly...
728 */
729
730 sleep(5);
731
732 update_reasons(NULL, "-connecting-to-device");
733
734 return (CUPS_BACKEND_FAILED);
735 }
736
737 fprintf(stderr, "DEBUG: Connection error: %s\n", strerror(errno));
738
739 if (errno == ECONNREFUSED || errno == EHOSTDOWN || errno == EHOSTUNREACH || errno == ETIMEDOUT || errno == ENOTCONN)
740 {
741 if (contimeout && (time(NULL) - start_time) > contimeout)
742 {
743 _cupsLangPrintFilter(stderr, "ERROR",
744 _("The printer is not responding."));
745 update_reasons(NULL, "-connecting-to-device");
746 return (CUPS_BACKEND_FAILED);
747 }
748
749 switch (error)
750 {
751 case EHOSTDOWN :
752 _cupsLangPrintFilter(stderr, "WARNING",
753 _("The printer may not exist or "
754 "is unavailable at this time."));
755 break;
756
757 case EHOSTUNREACH :
758 default :
759 _cupsLangPrintFilter(stderr, "WARNING",
760 _("The printer is unreachable at this "
761 "time."));
762 break;
763
764 case ECONNREFUSED :
765 _cupsLangPrintFilter(stderr, "WARNING",
766 _("The printer is in use."));
767 break;
768 }
769
770 sleep((unsigned)delay);
771
772 delay = _cupsNextDelay(delay, &prev_delay);
773 }
774 else
775 {
776 _cupsLangPrintFilter(stderr, "ERROR",
777 _("The printer is not responding."));
778 sleep(30);
779 }
780
781 if (job_canceled)
782 break;
783 }
784 else
785 update_reasons(NULL, "-cups-certificate-error");
786 }
787 while (http->fd < 0);
788
789 if (job_canceled)
790 return (CUPS_BACKEND_OK);
791 else if (!http)
792 return (CUPS_BACKEND_FAILED);
793
794 if (httpIsEncrypted(http))
795 {
796 /*
797 * Validate TLS credentials...
798 */
799
800 cups_array_t *creds; /* TLS credentials */
801 cups_array_t *lcreds = NULL; /* Loaded credentials */
802 http_trust_t trust; /* Trust level */
803 char credinfo[1024], /* Information on credentials */
804 lcredinfo[1024];/* Information on saved credentials */
805 static const char * const trusts[] = { NULL, "+cups-pki-invalid", "+cups-pki-changed", "+cups-pki-expired", NULL, "+cups-pki-unknown" };
806 /* Trust keywords */
807 static const char * const trust_msgs[] =
808 {
809 "Credentials are OK/trusted",
810 "Credentials are invalid",
811 "Credentials have changed",
812 "Credentials are expired",
813 "Credentials have been renewed",
814 "Credentials are unknown/new"
815 };
816
817 fputs("DEBUG: Connection is encrypted.\n", stderr);
818
819 if (!httpCopyCredentials(http, &creds))
820 {
821 trust = httpCredentialsGetTrust(creds, hostname);
822 httpCredentialsString(creds, credinfo, sizeof(credinfo));
823
824 fprintf(stderr, "DEBUG: %s (%s)\n", trust_msgs[trust], cupsLastErrorString());
825 fprintf(stderr, "DEBUG: Printer credentials: %s\n", credinfo);
826
827 if (!httpLoadCredentials(NULL, &lcreds, hostname))
828 {
829 httpCredentialsString(lcreds, lcredinfo, sizeof(lcredinfo));
830 fprintf(stderr, "DEBUG: Stored credentials: %s\n", lcredinfo);
831 }
832 else
833 fputs("DEBUG: No stored credentials.\n", stderr);
834
835 update_reasons(NULL, "-cups-pki-invalid,cups-pki-changed,cups-pki-expired,cups-pki-unknown");
836 if (trusts[trust])
837 {
838 update_reasons(NULL, trusts[trust]);
839 return (CUPS_BACKEND_STOP);
840 }
841
842 if (!lcreds)
843 {
844 /*
845 * Could not load the credentials, let's save the ones we have so we
846 * can detect changes...
847 */
848
849 httpSaveCredentials(NULL, creds, hostname);
850 }
851
852 httpFreeCredentials(lcreds);
853 httpFreeCredentials(creds);
854 }
855 else
856 {
857 fputs("DEBUG: No printer credentials.\n", stderr);
858
859 update_reasons(NULL, "cups-pki-unknown");
860 return (CUPS_BACKEND_STOP);
861 }
862 }
863
864 update_reasons(NULL, "-connecting-to-device");
865 _cupsLangPrintFilter(stderr, "INFO", _("Connected to printer."));
866
867 fprintf(stderr, "DEBUG: Connected to %s:%d...\n",
868 httpAddrString(http->hostaddr, addrname, sizeof(addrname)),
869 httpAddrPort(http->hostaddr));
870
871 /*
872 * Build a URI for the printer and fill the standard IPP attributes for
873 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
874 * might contain username:password information...
875 */
876
877 httpAssembleURI(HTTP_URI_CODING_ALL, uri, sizeof(uri), scheme, NULL, hostname,
878 port, resource);
879
880 /*
881 * First validate the destination and see if the device supports multiple
882 * copies...
883 */
884
885 #ifdef HAVE_LIBZ
886 compression_sup = NULL;
887 #endif /* HAVE_LIBZ */
888 copies_sup = NULL;
889 cups_version = NULL;
890 encryption_sup = NULL;
891 format_sup = NULL;
892 media_col_sup = NULL;
893 supported = NULL;
894 operations_sup = NULL;
895 doc_handling_sup = NULL;
896 print_color_mode_sup = NULL;
897
898 do
899 {
900 /*
901 * Check for side-channel requests...
902 */
903
904 backendCheckSideChannel(snmp_fd, http->hostaddr);
905
906 /*
907 * Build the IPP request...
908 */
909
910 request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES);
911 ippSetVersion(request, version / 10, version % 10);
912 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
913 NULL, uri);
914
915 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
916 "requested-attributes", sizeof(pattrs) / sizeof(pattrs[0]),
917 NULL, pattrs);
918
919 /*
920 * Do the request...
921 */
922
923 fputs("DEBUG: Getting supported attributes...\n", stderr);
924
925 if (http->version < HTTP_VERSION_1_1)
926 {
927 fprintf(stderr, "DEBUG: Printer responded with HTTP version %d.%d.\n",
928 http->version / 100, http->version % 100);
929 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
930 "cups-ipp-wrong-http-version");
931 }
932
933 supported = cupsDoRequest(http, request, resource);
934 ipp_status = cupsLastError();
935
936 fprintf(stderr, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
937 ippErrorString(ipp_status), cupsLastErrorString());
938
939 if (ipp_status <= IPP_STATUS_OK_CONFLICTING)
940 password_tries = 0;
941 else
942 {
943 fprintf(stderr, "DEBUG: Get-Printer-Attributes returned %s.\n",
944 ippErrorString(ipp_status));
945
946 if (ipp_status == IPP_STATUS_ERROR_BUSY ||
947 ipp_status == IPP_STATUS_ERROR_SERVICE_UNAVAILABLE)
948 {
949 if (contimeout && (time(NULL) - start_time) > contimeout)
950 {
951 _cupsLangPrintFilter(stderr, "ERROR",
952 _("The printer is not responding."));
953 return (CUPS_BACKEND_FAILED);
954 }
955
956 _cupsLangPrintFilter(stderr, "INFO", _("The printer is in use."));
957
958 report_printer_state(supported);
959
960 sleep((unsigned)delay);
961
962 delay = _cupsNextDelay(delay, &prev_delay);
963 }
964 else if ((ipp_status == IPP_STATUS_ERROR_BAD_REQUEST ||
965 ipp_status == IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED) && version > 10)
966 {
967 /*
968 * Switch to IPP/1.1 or IPP/1.0...
969 */
970
971 if (version >= 20)
972 {
973 _cupsLangPrintFilter(stderr, "INFO", _("Preparing to print."));
974 fprintf(stderr,
975 "DEBUG: The printer does not support IPP/%d.%d, trying "
976 "IPP/1.1.\n", version / 10, version % 10);
977 version = 11;
978 }
979 else
980 {
981 _cupsLangPrintFilter(stderr, "INFO", _("Preparing to print."));
982 fprintf(stderr,
983 "DEBUG: The printer does not support IPP/%d.%d, trying "
984 "IPP/1.0.\n", version / 10, version % 10);
985 version = 10;
986 }
987
988 httpReconnect2(http, 30000, NULL);
989 }
990 else if (ipp_status == IPP_STATUS_ERROR_NOT_FOUND)
991 {
992 _cupsLangPrintFilter(stderr, "ERROR",
993 _("The printer configuration is incorrect or the "
994 "printer no longer exists."));
995
996 ippDelete(supported);
997
998 return (CUPS_BACKEND_STOP);
999 }
1000 else if (ipp_status == IPP_STATUS_ERROR_FORBIDDEN ||
1001 ipp_status == IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED)
1002 {
1003 const char *www_auth = httpGetField(http, HTTP_FIELD_WWW_AUTHENTICATE);
1004 /* WWW-Authenticate field value */
1005
1006 if (!strncmp(www_auth, "Negotiate", 9))
1007 auth_info_required = "negotiate";
1008 else if (www_auth[0])
1009 auth_info_required = "username,password";
1010
1011 fprintf(stderr, "ATTR: auth-info-required=%s\n", auth_info_required);
1012 return (CUPS_BACKEND_AUTH_REQUIRED);
1013 }
1014 else if (ipp_status != IPP_STATUS_ERROR_NOT_AUTHORIZED)
1015 {
1016 _cupsLangPrintFilter(stderr, "ERROR",
1017 _("Unable to get printer status."));
1018 sleep(10);
1019
1020 httpReconnect2(http, 30000, NULL);
1021 }
1022
1023 ippDelete(supported);
1024 supported = NULL;
1025 continue;
1026 }
1027
1028 if (!getenv("CLASS"))
1029 {
1030 /*
1031 * Check printer-is-accepting-jobs = false and printer-state-reasons for the
1032 * "spool-area-full" keyword...
1033 */
1034
1035 int busy = 0;
1036
1037 if ((printer_accepting = ippFindAttribute(supported,
1038 "printer-is-accepting-jobs",
1039 IPP_TAG_BOOLEAN)) != NULL &&
1040 !printer_accepting->values[0].boolean)
1041 busy = 1;
1042 else if (!printer_accepting)
1043 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1044 "cups-ipp-missing-printer-is-accepting-jobs");
1045
1046 if ((printer_state = ippFindAttribute(supported,
1047 "printer-state-reasons",
1048 IPP_TAG_KEYWORD)) == NULL)
1049 {
1050 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1051 "cups-ipp-missing-printer-state-reasons");
1052 }
1053 else if (!busy)
1054 {
1055 for (i = 0; i < printer_state->num_values; i ++)
1056 {
1057 if (!strcmp(printer_state->values[0].string.text,
1058 "spool-area-full") ||
1059 !strncmp(printer_state->values[0].string.text, "spool-area-full-",
1060 16))
1061 {
1062 busy = 1;
1063 break;
1064 }
1065 }
1066 }
1067
1068 if (busy)
1069 {
1070 _cupsLangPrintFilter(stderr, "INFO", _("The printer is in use."));
1071
1072 report_printer_state(supported);
1073
1074 sleep((unsigned)delay);
1075
1076 delay = _cupsNextDelay(delay, &prev_delay);
1077
1078 ippDelete(supported);
1079 supported = NULL;
1080 ipp_status = IPP_STATUS_ERROR_BUSY;
1081 continue;
1082 }
1083 }
1084
1085 /*
1086 * Check for supported attributes...
1087 */
1088
1089 #ifdef HAVE_LIBZ
1090 if ((compression_sup = ippFindAttribute(supported, "compression-supported",
1091 IPP_TAG_KEYWORD)) != NULL)
1092 {
1093 /*
1094 * Check whether the requested compression is supported and/or default to
1095 * compression if supported...
1096 */
1097
1098 if (compression && !ippContainsString(compression_sup, compression))
1099 {
1100 fprintf(stderr, "DEBUG: Printer does not support the requested "
1101 "compression value \"%s\".\n", compression);
1102 compression = NULL;
1103 }
1104 else if (!compression && (!strcmp(final_content_type, "image/pwg-raster") || !strcmp(final_content_type, "image/urf")))
1105 {
1106 if (ippContainsString(compression_sup, "gzip"))
1107 compression = "gzip";
1108 else if (ippContainsString(compression_sup, "deflate"))
1109 compression = "deflate";
1110
1111 if (compression)
1112 fprintf(stderr, "DEBUG: Automatically using \"%s\" compression.\n",
1113 compression);
1114 }
1115 }
1116 #endif /* HAVE_LIBZ */
1117
1118 if ((copies_sup = ippFindAttribute(supported, "copies-supported",
1119 IPP_TAG_RANGE)) != NULL)
1120 {
1121 /*
1122 * Has the "copies-supported" attribute - does it have an upper
1123 * bound > 1?
1124 */
1125
1126 fprintf(stderr, "DEBUG: copies-supported=%d-%d\n",
1127 copies_sup->values[0].range.lower,
1128 copies_sup->values[0].range.upper);
1129
1130 if (copies_sup->values[0].range.upper <= 1)
1131 copies_sup = NULL; /* No */
1132 }
1133
1134 if ((cups_version = ippFindAttribute(supported, "cups-version", IPP_TAG_TEXT)) != NULL)
1135 {
1136 const char *val = ippGetString(cups_version, 0, NULL);
1137
1138 fprintf(stderr, "DEBUG: cups-version = \"%s\"\n", val);
1139 if (!strcmp(val, "cups-version"))
1140 cups_version = NULL; /* Bogus cups-version value returned by buggy printers! */
1141 }
1142
1143 encryption_sup = ippFindAttribute(supported, "job-password-encryption-supported", IPP_TAG_KEYWORD);
1144
1145 if ((format_sup = ippFindAttribute(supported, "document-format-supported",
1146 IPP_TAG_MIMETYPE)) != NULL)
1147 {
1148 fprintf(stderr, "DEBUG: document-format-supported (%d values)\n",
1149 format_sup->num_values);
1150 for (i = 0; i < format_sup->num_values; i ++)
1151 fprintf(stderr, "DEBUG: [%d] = \"%s\"\n", i,
1152 format_sup->values[i].string.text);
1153 }
1154
1155 if ((media_col_sup = ippFindAttribute(supported, "media-col-supported",
1156 IPP_TAG_KEYWORD)) != NULL)
1157 {
1158 fprintf(stderr, "DEBUG: media-col-supported (%d values)\n",
1159 media_col_sup->num_values);
1160 for (i = 0; i < media_col_sup->num_values; i ++)
1161 fprintf(stderr, "DEBUG: [%d] = \"%s\"\n", i,
1162 media_col_sup->values[i].string.text);
1163 }
1164
1165 print_color_mode_sup = ippFindAttribute(supported, "print-color-mode-supported", IPP_TAG_KEYWORD);
1166
1167 if ((operations_sup = ippFindAttribute(supported, "operations-supported",
1168 IPP_TAG_ENUM)) != NULL)
1169 {
1170 fprintf(stderr, "DEBUG: operations-supported (%d values)\n",
1171 operations_sup->num_values);
1172 for (i = 0; i < operations_sup->num_values; i ++)
1173 fprintf(stderr, "DEBUG: [%d] = %s\n", i,
1174 ippOpString(operations_sup->values[i].integer));
1175
1176 for (i = 0; i < operations_sup->num_values; i ++)
1177 if (operations_sup->values[i].integer == IPP_OP_PRINT_JOB)
1178 break;
1179
1180 if (i >= operations_sup->num_values)
1181 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1182 "cups-ipp-missing-print-job");
1183
1184 for (i = 0; i < operations_sup->num_values; i ++)
1185 if (operations_sup->values[i].integer == IPP_OP_CANCEL_JOB)
1186 break;
1187
1188 if (i >= operations_sup->num_values)
1189 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1190 "cups-ipp-missing-cancel-job");
1191
1192 for (i = 0; i < operations_sup->num_values; i ++)
1193 if (operations_sup->values[i].integer == IPP_OP_GET_JOB_ATTRIBUTES)
1194 break;
1195
1196 if (i >= operations_sup->num_values)
1197 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1198 "cups-ipp-missing-get-job-attributes");
1199
1200 for (i = 0; i < operations_sup->num_values; i ++)
1201 if (operations_sup->values[i].integer == IPP_OP_GET_PRINTER_ATTRIBUTES)
1202 break;
1203
1204 if (i >= operations_sup->num_values)
1205 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1206 "cups-ipp-missing-get-printer-attributes");
1207
1208 for (i = 0; i < operations_sup->num_values; i ++)
1209 {
1210 if (operations_sup->values[i].integer == IPP_OP_VALIDATE_JOB)
1211 validate_job = 1;
1212 else if (operations_sup->values[i].integer == IPP_OP_CREATE_JOB)
1213 create_job = 1;
1214 else if (operations_sup->values[i].integer == IPP_OP_SEND_DOCUMENT)
1215 send_document = 1;
1216 else if (operations_sup->values[i].integer == IPP_OP_GET_JOB_ATTRIBUTES)
1217 get_job_attrs = 1;
1218 }
1219
1220 if (create_job && !send_document)
1221 {
1222 fputs("DEBUG: Printer supports Create-Job but not Send-Document.\n",
1223 stderr);
1224 create_job = 0;
1225
1226 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1227 "cups-ipp-missing-send-document");
1228 }
1229
1230 if (!validate_job)
1231 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1232 "cups-ipp-missing-validate-job");
1233 }
1234 else
1235 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1236 "cups-ipp-missing-operations-supported");
1237
1238 doc_handling_sup = ippFindAttribute(supported,
1239 "multiple-document-handling-supported",
1240 IPP_TAG_KEYWORD);
1241
1242 report_printer_state(supported);
1243 }
1244 while (!job_canceled && ipp_status > IPP_STATUS_OK_CONFLICTING);
1245
1246 if (job_canceled)
1247 return (CUPS_BACKEND_OK);
1248
1249 /*
1250 * See if the printer is accepting jobs and is not stopped; if either
1251 * condition is true and we are printing to a class, requeue the job...
1252 */
1253
1254 if (getenv("CLASS") != NULL)
1255 {
1256 printer_state = ippFindAttribute(supported, "printer-state",
1257 IPP_TAG_ENUM);
1258 printer_accepting = ippFindAttribute(supported, "printer-is-accepting-jobs",
1259 IPP_TAG_BOOLEAN);
1260
1261 if (printer_state == NULL ||
1262 (printer_state->values[0].integer > IPP_PSTATE_PROCESSING &&
1263 waitprinter) ||
1264 printer_accepting == NULL ||
1265 !printer_accepting->values[0].boolean)
1266 {
1267 /*
1268 * If the CLASS environment variable is set, the job was submitted
1269 * to a class and not to a specific queue. In this case, we want
1270 * to abort immediately so that the job can be requeued on the next
1271 * available printer in the class.
1272 */
1273
1274 _cupsLangPrintFilter(stderr, "INFO",
1275 _("Unable to contact printer, queuing on next "
1276 "printer in class."));
1277
1278 ippDelete(supported);
1279 httpClose(http);
1280
1281 /*
1282 * Sleep 5 seconds to keep the job from requeuing too rapidly...
1283 */
1284
1285 sleep(5);
1286
1287 return (CUPS_BACKEND_FAILED);
1288 }
1289 }
1290
1291 /*
1292 * See if the printer supports multiple copies...
1293 */
1294
1295 copies = atoi(argv[4]);
1296
1297 if (copies_sup || argc < 7)
1298 copies_remaining = 1;
1299 else
1300 copies_remaining = copies;
1301
1302 /*
1303 * Prepare remaining printing options...
1304 */
1305
1306 options = NULL;
1307
1308 if (send_options)
1309 {
1310 num_options = cupsParseOptions(argv[5], 0, &options);
1311
1312 if (!cups_version && media_col_sup)
1313 {
1314 /*
1315 * Load the PPD file and generate PWG attribute mapping information...
1316 */
1317
1318 ppd_attr_t *mandatory; /* cupsMandatory value */
1319
1320 ppd = ppdOpenFile(getenv("PPD"));
1321 pc = _ppdCacheCreateWithPPD(ppd);
1322
1323 ppdMarkDefaults(ppd);
1324 cupsMarkOptions(ppd, num_options, options);
1325
1326 if ((mandatory = ppdFindAttr(ppd, "cupsMandatory", NULL)) != NULL)
1327 strlcpy(mandatory_attrs, mandatory->value, sizeof(mandatory_attrs));
1328 }
1329
1330 /*
1331 * Validate job-password/-encryption...
1332 */
1333
1334 if (cupsGetOption("job-password", num_options, options))
1335 {
1336 const char *keyword; /* job-password-encryption value */
1337 static const char * const hashes[] =
1338 { /* List of supported hash algorithms, in order of preference */
1339 "sha-512",
1340 "sha-384",
1341 "sha-512_256",
1342 "sha-512-224",
1343 "sha-256",
1344 "sha-224",
1345 "sha",
1346 "none"
1347 };
1348
1349 if ((keyword = cupsGetOption("job-password-encryption", num_options, options)) == NULL || !ippContainsString(encryption_sup, keyword))
1350 {
1351 /*
1352 * Either no job-password-encryption or the value isn't supported by
1353 * the printer...
1354 */
1355
1356 for (i = 0; i < (int)(sizeof(hashes) / sizeof(hashes[0])); i ++)
1357 if (ippContainsString(encryption_sup, hashes[i]))
1358 break;
1359
1360 if (i < (int)(sizeof(hashes) / sizeof(hashes[0])))
1361 num_options = cupsAddOption("job-password-encryption", hashes[i], num_options, &options);
1362 }
1363 }
1364 }
1365 else
1366 num_options = 0;
1367
1368 document_format = NULL;
1369
1370 if (format_sup != NULL)
1371 {
1372 if (ippContainsString(format_sup, final_content_type))
1373 document_format = final_content_type;
1374 else if (ippContainsString(format_sup, "application/octet-stream"))
1375 document_format = "application/octet-stream";
1376 }
1377
1378 fprintf(stderr, "DEBUG: final_content_type=\"%s\", document_format=\"%s\"\n",
1379 final_content_type, document_format ? document_format : "(null)");
1380
1381 /*
1382 * If the printer does not support HTTP/1.1 (which IPP requires), copy stdin
1383 * to a temporary file so that we can do a HTTP/1.0 submission...
1384 *
1385 * (I hate compatibility hacks!)
1386 */
1387
1388 if (http->version < HTTP_VERSION_1_1 && num_files == 0)
1389 {
1390 if ((fd = cupsTempFd(tmpfilename, sizeof(tmpfilename))) < 0)
1391 {
1392 perror("DEBUG: Unable to create temporary file");
1393 return (CUPS_BACKEND_FAILED);
1394 }
1395
1396 _cupsLangPrintFilter(stderr, "INFO", _("Copying print data."));
1397
1398 if ((compatsize = write(fd, buffer, (size_t)bytes)) < 0)
1399 {
1400 perror("DEBUG: Unable to write temporary file");
1401 return (CUPS_BACKEND_FAILED);
1402 }
1403
1404 if ((bytes = backendRunLoop(-1, fd, snmp_fd, &(addrlist->addr), 0, 0,
1405 backendNetworkSideCB)) < 0)
1406 return (CUPS_BACKEND_FAILED);
1407
1408 compatsize += bytes;
1409
1410 close(fd);
1411
1412 compatfile = tmpfilename;
1413 files = &compatfile;
1414 num_files = 1;
1415 }
1416 else if (http->version < HTTP_VERSION_1_1 && num_files == 1)
1417 {
1418 struct stat fileinfo; /* File information */
1419
1420 if (!stat(files[0], &fileinfo))
1421 compatsize = fileinfo.st_size;
1422 }
1423
1424 /*
1425 * If the printer only claims to support IPP/1.0, or if the user specifically
1426 * included version=1.0 in the URI, then do not try to use Create-Job or
1427 * Send-Document. This is another dreaded compatibility hack, but
1428 * unfortunately there are enough broken printers out there that we need
1429 * this for now...
1430 */
1431
1432 if (version == 10)
1433 create_job = send_document = 0;
1434
1435 /*
1436 * Start monitoring the printer in the background...
1437 */
1438
1439 monitor.uri = uri;
1440 monitor.hostname = hostname;
1441 monitor.user = argv[2];
1442 monitor.resource = resource;
1443 monitor.port = port;
1444 monitor.version = version;
1445 monitor.job_id = 0;
1446 monitor.create_job = create_job;
1447 monitor.get_job_attrs = get_job_attrs;
1448 monitor.encryption = cupsEncryption();
1449 monitor.job_state = IPP_JSTATE_PENDING;
1450 monitor.printer_state = IPP_PSTATE_IDLE;
1451 monitor.retryable = argc == 6 && document_format && strcmp(document_format, "image/pwg-raster") && strcmp(document_format, "image/urf");
1452
1453 fprintf(stderr, "DEBUG: retryable=%d\n", monitor.retryable);
1454
1455 if (create_job)
1456 {
1457 monitor.job_name = argv[3];
1458 }
1459 else
1460 {
1461 snprintf(print_job_name, sizeof(print_job_name), "%s - %s", argv[1],
1462 argv[3]);
1463 monitor.job_name = print_job_name;
1464 }
1465
1466 _cupsThreadCreate((_cups_thread_func_t)monitor_printer, &monitor);
1467
1468 /*
1469 * Validate access to the printer...
1470 */
1471
1472 while (!job_canceled && validate_job)
1473 {
1474 request = new_request(IPP_OP_VALIDATE_JOB, version, uri, argv[2],
1475 monitor.job_name, num_options, options, compression,
1476 copies_sup ? copies : 1, document_format, pc, ppd,
1477 media_col_sup, doc_handling_sup, print_color_mode_sup);
1478
1479 response = cupsDoRequest(http, request, resource);
1480
1481 ipp_status = cupsLastError();
1482
1483 fprintf(stderr, "DEBUG: Validate-Job: %s (%s)\n",
1484 ippErrorString(ipp_status), cupsLastErrorString());
1485 debug_attributes(response);
1486
1487 if ((job_auth = ippFindAttribute(response, "job-authorization-uri",
1488 IPP_TAG_URI)) != NULL)
1489 num_options = cupsAddOption("job-authorization-uri",
1490 ippGetString(job_auth, 0, NULL), num_options,
1491 &options);
1492
1493 if (ipp_status == IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED || ipp_status == IPP_STATUS_OK_CONFLICTING)
1494 {
1495 /*
1496 * One or more options are not supported...
1497 */
1498
1499 ipp_attribute_t *attr; /* Unsupported attribute */
1500
1501 if ((attr = ippFindAttribute(response, "sides", IPP_TAG_ZERO)) != NULL)
1502 {
1503 /*
1504 * The sides value is not supported, revert to one-sided as needed...
1505 */
1506
1507 const char *sides = cupsGetOption("sides", num_options, options);
1508
1509 if (!sides || !strncmp(sides, "two-sided-", 10))
1510 {
1511 fputs("DEBUG: Unable to do two-sided printing, setting sides to 'one-sided'.\n", stderr);
1512 num_options = cupsAddOption("sides", "one-sided", num_options, &options);
1513 }
1514 }
1515 }
1516
1517 ippDelete(response);
1518
1519 if (job_canceled)
1520 break;
1521
1522 if (ipp_status == IPP_STATUS_ERROR_SERVICE_UNAVAILABLE ||
1523 ipp_status == IPP_STATUS_ERROR_BUSY)
1524 {
1525 _cupsLangPrintFilter(stderr, "INFO", _("The printer is in use."));
1526 sleep(10);
1527 }
1528 else if (ipp_status == IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED ||
1529 ipp_status == IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES ||
1530 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED ||
1531 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED ||
1532 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED ||
1533 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED)
1534 goto cleanup;
1535 else if (ipp_status == IPP_STATUS_ERROR_FORBIDDEN ||
1536 ipp_status == IPP_STATUS_ERROR_NOT_AUTHORIZED ||
1537 ipp_status == IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED)
1538 {
1539 const char *www_auth = httpGetField(http, HTTP_FIELD_WWW_AUTHENTICATE);
1540 /* WWW-Authenticate field value */
1541
1542 if (!strncmp(www_auth, "Negotiate", 9))
1543 auth_info_required = "negotiate";
1544 else if (www_auth[0])
1545 auth_info_required = "username,password";
1546
1547 goto cleanup;
1548 }
1549 else if (ipp_status == IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED)
1550 {
1551 /*
1552 * This is all too common...
1553 */
1554
1555 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1556 "cups-ipp-missing-validate-job");
1557 break;
1558 }
1559 else if (ipp_status < IPP_STATUS_REDIRECTION_OTHER_SITE ||
1560 ipp_status == IPP_STATUS_ERROR_BAD_REQUEST)
1561 break;
1562 else if (job_auth == NULL && ipp_status > IPP_STATUS_ERROR_BAD_REQUEST)
1563 goto cleanup;
1564 }
1565
1566 /*
1567 * Then issue the print-job request...
1568 */
1569
1570 job_id = 0;
1571
1572 while (!job_canceled && copies_remaining > 0)
1573 {
1574 /*
1575 * Check for side-channel requests...
1576 */
1577
1578 backendCheckSideChannel(snmp_fd, http->hostaddr);
1579
1580 /*
1581 * Build the IPP job creation request...
1582 */
1583
1584 if (job_canceled)
1585 break;
1586
1587 request = new_request((num_files > 1 || create_job) ? IPP_OP_CREATE_JOB :
1588 IPP_OP_PRINT_JOB,
1589 version, uri, argv[2], monitor.job_name, num_options,
1590 options, compression, copies_sup ? copies : 1,
1591 document_format, pc, ppd, media_col_sup,
1592 doc_handling_sup, print_color_mode_sup);
1593
1594 /*
1595 * Do the request...
1596 */
1597
1598 if (num_files > 1 || create_job)
1599 response = cupsDoRequest(http, request, resource);
1600 else
1601 {
1602 size_t length = 0; /* Length of request */
1603
1604 if (compatsize > 0)
1605 {
1606 fputs("DEBUG: Sending file using HTTP/1.0 Content-Length...\n", stderr);
1607 length = ippLength(request) + (size_t)compatsize;
1608 }
1609 else
1610 fputs("DEBUG: Sending file using HTTP/1.1 chunking...\n", stderr);
1611
1612 http_status = cupsSendRequest(http, request, resource, length);
1613 if (http_status == HTTP_STATUS_CONTINUE && request->state == IPP_STATE_DATA)
1614 {
1615 if (compression && strcmp(compression, "none"))
1616 httpSetField(http, HTTP_FIELD_CONTENT_ENCODING, compression);
1617
1618 if (num_files == 1)
1619 {
1620 if ((fd = open(files[0], O_RDONLY)) < 0)
1621 {
1622 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1623 return (CUPS_BACKEND_FAILED);
1624 }
1625 }
1626 else
1627 {
1628 fd = 0;
1629 http_status = cupsWriteRequestData(http, buffer, (size_t)bytes);
1630 }
1631
1632 while (http_status == HTTP_STATUS_CONTINUE &&
1633 (!job_canceled || compatsize > 0))
1634 {
1635 /*
1636 * Check for side-channel requests and more print data...
1637 */
1638
1639 FD_ZERO(&input);
1640 FD_SET(fd, &input);
1641 FD_SET(snmp_fd, &input);
1642 FD_SET(CUPS_SC_FD, &input);
1643
1644 while (select(fd > snmp_fd ? fd + 1 : snmp_fd + 1, &input, NULL, NULL,
1645 NULL) <= 0 && !job_canceled);
1646
1647 if (FD_ISSET(snmp_fd, &input))
1648 backendCheckSideChannel(snmp_fd, http->hostaddr);
1649
1650 if (FD_ISSET(fd, &input))
1651 {
1652 if ((bytes = read(fd, buffer, sizeof(buffer))) > 0)
1653 {
1654 fprintf(stderr, "DEBUG: Read %d bytes...\n", (int)bytes);
1655
1656 if ((http_status = cupsWriteRequestData(http, buffer, (size_t)bytes))
1657 != HTTP_STATUS_CONTINUE)
1658 break;
1659 }
1660 else if (bytes == 0 || (errno != EINTR && errno != EAGAIN))
1661 break;
1662 }
1663 }
1664
1665 if (http_status == HTTP_STATUS_ERROR)
1666 fprintf(stderr, "DEBUG: Error writing document data for "
1667 "Print-Job: %s\n", strerror(httpError(http)));
1668
1669 if (num_files == 1)
1670 close(fd);
1671 }
1672
1673 response = cupsGetResponse(http, resource);
1674 ippDelete(request);
1675 }
1676
1677 ipp_status = cupsLastError();
1678
1679 fprintf(stderr, "DEBUG: %s: %s (%s)\n",
1680 (num_files > 1 || create_job) ? "Create-Job" : "Print-Job",
1681 ippErrorString(ipp_status), cupsLastErrorString());
1682 debug_attributes(response);
1683
1684 if (ipp_status > IPP_STATUS_OK_CONFLICTING)
1685 {
1686 job_id = 0;
1687
1688 if (job_canceled)
1689 break;
1690
1691 if (ipp_status == IPP_STATUS_ERROR_SERVICE_UNAVAILABLE ||
1692 ipp_status == IPP_STATUS_ERROR_NOT_POSSIBLE ||
1693 ipp_status == IPP_STATUS_ERROR_BUSY)
1694 {
1695 _cupsLangPrintFilter(stderr, "INFO", _("The printer is in use."));
1696 sleep(10);
1697
1698 if (num_files == 0)
1699 {
1700 /*
1701 * We can't re-submit when we have no files to print, so exit
1702 * immediately with the right status code...
1703 */
1704
1705 goto cleanup;
1706 }
1707 }
1708 else if (ipp_status == IPP_STATUS_ERROR_JOB_CANCELED ||
1709 ipp_status == IPP_STATUS_ERROR_NOT_AUTHORIZED ||
1710 ipp_status == IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES ||
1711 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED ||
1712 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED ||
1713 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED ||
1714 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED)
1715 goto cleanup;
1716 else
1717 {
1718 /*
1719 * Update auth-info-required as needed...
1720 */
1721
1722 _cupsLangPrintFilter(stderr, "ERROR",
1723 _("Print job was not accepted."));
1724
1725 if (ipp_status == IPP_STATUS_ERROR_FORBIDDEN ||
1726 ipp_status == IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED)
1727 {
1728 const char *www_auth = httpGetField(http, HTTP_FIELD_WWW_AUTHENTICATE);
1729 /* WWW-Authenticate field value */
1730
1731 if (!strncmp(www_auth, "Negotiate", 9))
1732 auth_info_required = "negotiate";
1733 else if (www_auth[0])
1734 auth_info_required = "username,password";
1735 }
1736 else if (ipp_status == IPP_STATUS_ERROR_REQUEST_VALUE)
1737 {
1738 /*
1739 * Print file is too large, abort this job...
1740 */
1741
1742 goto cleanup;
1743 }
1744 else
1745 sleep(10);
1746
1747 if (num_files == 0)
1748 {
1749 /*
1750 * We can't re-submit when we have no files to print, so exit
1751 * immediately with the right status code...
1752 */
1753
1754 goto cleanup;
1755 }
1756 }
1757 }
1758 else if ((job_id_attr = ippFindAttribute(response, "job-id",
1759 IPP_TAG_INTEGER)) == NULL)
1760 {
1761 fputs("DEBUG: Print job accepted - job ID unknown.\n", stderr);
1762 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1763 "cups-ipp-missing-job-id");
1764 job_id = 0;
1765 }
1766 else
1767 {
1768 password_tries = 0;
1769 monitor.job_id = job_id = job_id_attr->values[0].integer;
1770 fprintf(stderr, "DEBUG: Print job accepted - job ID %d.\n", job_id);
1771 }
1772
1773 ippDelete(response);
1774
1775 if (job_canceled)
1776 break;
1777
1778 if (job_id && (num_files > 1 || create_job))
1779 {
1780 for (i = 0; num_files == 0 || i < num_files; i ++)
1781 {
1782 /*
1783 * Check for side-channel requests...
1784 */
1785
1786 backendCheckSideChannel(snmp_fd, http->hostaddr);
1787
1788 /*
1789 * Send the next file in the job...
1790 */
1791
1792 request = ippNewRequest(IPP_OP_SEND_DOCUMENT);
1793 ippSetVersion(request, version / 10, version % 10);
1794
1795 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
1796 NULL, uri);
1797
1798 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id",
1799 job_id);
1800
1801 if (argv[2][0])
1802 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
1803 "requesting-user-name", NULL, argv[2]);
1804
1805 ippAddBoolean(request, IPP_TAG_OPERATION, "last-document",
1806 (i + 1) >= num_files);
1807
1808 if (document_format)
1809 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE,
1810 "document-format", NULL, document_format);
1811
1812 if (compression)
1813 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
1814 "compression", NULL, compression);
1815
1816 fprintf(stderr, "DEBUG: Sending file %d using chunking...\n", i + 1);
1817 fprintf(stderr, "DEBUG: IPP/%d.%d %s #%d\n", version / 10, version % 10, ippOpString(ippGetOperation(request)), ippGetRequestId(request));
1818 debug_attributes(request);
1819
1820 http_status = cupsSendRequest(http, request, resource, 0);
1821 if (http_status == HTTP_STATUS_CONTINUE && request->state == IPP_STATE_DATA)
1822 {
1823 if (compression && strcmp(compression, "none"))
1824 httpSetField(http, HTTP_FIELD_CONTENT_ENCODING, compression);
1825
1826 if (num_files == 0)
1827 {
1828 fd = 0;
1829 http_status = cupsWriteRequestData(http, buffer, (size_t)bytes);
1830 }
1831 else
1832 {
1833 if ((fd = open(files[i], O_RDONLY)) < 0)
1834 {
1835 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1836 return (CUPS_BACKEND_FAILED);
1837 }
1838 }
1839 }
1840 else
1841 fd = -1;
1842
1843 if (fd >= 0)
1844 {
1845 while (!job_canceled && http_status == HTTP_STATUS_CONTINUE &&
1846 (bytes = read(fd, buffer, sizeof(buffer))) > 0)
1847 {
1848 if ((http_status = cupsWriteRequestData(http, buffer, (size_t)bytes))
1849 != HTTP_STATUS_CONTINUE)
1850 break;
1851 else
1852 {
1853 /*
1854 * Check for side-channel requests...
1855 */
1856
1857 backendCheckSideChannel(snmp_fd, http->hostaddr);
1858 }
1859 }
1860
1861 if (fd > 0)
1862 close(fd);
1863 }
1864
1865 if (http_status == HTTP_STATUS_ERROR)
1866 fprintf(stderr, "DEBUG: Error writing document data for "
1867 "Send-Document: %s\n", strerror(httpError(http)));
1868
1869 response = cupsGetResponse(http, resource);
1870 ippDelete(request);
1871
1872 fprintf(stderr, "DEBUG: Send-Document: %s (%s)\n", ippErrorString(cupsLastError()), cupsLastErrorString());
1873 debug_attributes(response);
1874
1875 if (cupsLastError() > IPP_STATUS_OK_CONFLICTING && !job_canceled)
1876 {
1877 ipp_attribute_t *reasons = ippFindAttribute(response, "job-state-reasons", IPP_TAG_KEYWORD);
1878 /* job-state-reasons values */
1879
1880 ipp_status = cupsLastError();
1881
1882 if (ippContainsString(reasons, "document-format-error"))
1883 ipp_status = IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR;
1884 else if (ippContainsString(reasons, "document-unprintable"))
1885 ipp_status = IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE;
1886
1887 ippDelete(response);
1888 _cupsLangPrintFilter(stderr, "ERROR", _("Unable to add document to print job."));
1889 break;
1890 }
1891 else
1892 {
1893 ippDelete(response);
1894
1895 password_tries = 0;
1896
1897 if (num_files == 0 || fd < 0)
1898 break;
1899 }
1900 }
1901 }
1902
1903 if (job_canceled)
1904 break;
1905
1906 if (ipp_status <= IPP_STATUS_OK_CONFLICTING && argc > 6)
1907 {
1908 fprintf(stderr, "PAGE: 1 %d\n", copies_sup ? atoi(argv[4]) : 1);
1909 copies_remaining --;
1910 }
1911 else if ((ipp_status == IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED || ipp_status == IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR || ipp_status == IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE) &&
1912 argc == 6 &&
1913 document_format && strcmp(document_format, "image/pwg-raster") && strcmp(document_format, "image/urf"))
1914 {
1915 /*
1916 * Need to reprocess the job as raster...
1917 */
1918
1919 fputs("JOBSTATE: cups-retry-as-raster\n", stderr);
1920 if (job_id > 0)
1921 cancel_job(http, uri, job_id, resource, argv[2], version);
1922
1923 goto cleanup;
1924 }
1925 else if (ipp_status == IPP_STATUS_ERROR_SERVICE_UNAVAILABLE ||
1926 ipp_status == IPP_STATUS_ERROR_NOT_POSSIBLE ||
1927 ipp_status == IPP_STATUS_ERROR_BUSY)
1928 {
1929 if (argc == 6)
1930 {
1931 /*
1932 * Need to reprocess the entire job; if we have a job ID, cancel the
1933 * job first...
1934 */
1935
1936 if (job_id > 0)
1937 cancel_job(http, uri, job_id, resource, argv[2], version);
1938
1939 goto cleanup;
1940 }
1941 continue;
1942 }
1943 else if (ipp_status == IPP_STATUS_ERROR_REQUEST_VALUE ||
1944 ipp_status == IPP_STATUS_ERROR_JOB_CANCELED ||
1945 ipp_status == IPP_STATUS_ERROR_NOT_AUTHORIZED ||
1946 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED ||
1947 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED ||
1948 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED ||
1949 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED ||
1950 ipp_status == IPP_STATUS_ERROR_INTERNAL)
1951 {
1952 /*
1953 * Print file is too large, job was canceled, we need new
1954 * authentication data, or we had some sort of error...
1955 */
1956
1957 goto cleanup;
1958 }
1959 else if (ipp_status == IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED)
1960 {
1961 /*
1962 * Server is configured incorrectly; the policy for Create-Job and
1963 * Send-Document has to be the same (auth or no auth, encryption or
1964 * no encryption). Force the queue to stop since printing will never
1965 * work.
1966 */
1967
1968 fputs("DEBUG: The server or printer is configured incorrectly.\n",
1969 stderr);
1970 fputs("DEBUG: The policy for Create-Job and Send-Document must have the "
1971 "same authentication and encryption requirements.\n", stderr);
1972
1973 ipp_status = IPP_STATUS_ERROR_INTERNAL;
1974
1975 if (job_id > 0)
1976 cancel_job(http, uri, job_id, resource, argv[2], version);
1977
1978 goto cleanup;
1979 }
1980 else if (ipp_status == IPP_STATUS_ERROR_NOT_FOUND)
1981 {
1982 /*
1983 * Printer does not actually implement support for Create-Job/
1984 * Send-Document, so log the conformance issue and stop the printer.
1985 */
1986
1987 fputs("DEBUG: This printer claims to support Create-Job and "
1988 "Send-Document, but those operations failed.\n", stderr);
1989 fputs("DEBUG: Add '?version=1.0' to the device URI to use legacy "
1990 "compatibility mode.\n", stderr);
1991 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
1992 "cups-ipp-missing-send-document");
1993
1994 ipp_status = IPP_STATUS_ERROR_INTERNAL; /* Force queue to stop */
1995
1996 goto cleanup;
1997 }
1998 else
1999 copies_remaining --;
2000
2001 /*
2002 * Wait for the job to complete...
2003 */
2004
2005 if (!job_id || !waitjob || !get_job_attrs)
2006 continue;
2007
2008 fputs("STATE: +cups-waiting-for-job-completed\n", stderr);
2009
2010 _cupsLangPrintFilter(stderr, "INFO", _("Waiting for job to complete."));
2011
2012 for (delay = _cupsNextDelay(0, &prev_delay), waittime = time(NULL) + 30; !job_canceled;)
2013 {
2014 /*
2015 * Check for side-channel requests...
2016 */
2017
2018 backendCheckSideChannel(snmp_fd, http->hostaddr);
2019
2020 /*
2021 * Check printer state...
2022 */
2023
2024 check_printer_state(http, uri, resource, argv[2], version);
2025
2026 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING)
2027 password_tries = 0;
2028
2029 /*
2030 * Build an IPP_OP_GET_JOB_ATTRIBUTES request...
2031 */
2032
2033 request = ippNewRequest(IPP_OP_GET_JOB_ATTRIBUTES);
2034 ippSetVersion(request, version / 10, version % 10);
2035
2036 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
2037 NULL, uri);
2038
2039 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id",
2040 job_id);
2041
2042 if (argv[2][0])
2043 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
2044 "requesting-user-name", NULL, argv[2]);
2045
2046 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
2047 "requested-attributes", sizeof(jattrs) / sizeof(jattrs[0]),
2048 NULL, jattrs);
2049
2050 fprintf(stderr, "DEBUG: IPP/%d.%d %s #%d\n", version / 10, version % 10, ippOpString(ippGetOperation(request)), ippGetRequestId(request));
2051 debug_attributes(request);
2052
2053 /*
2054 * Do the request...
2055 */
2056
2057 httpReconnect2(http, 30000, NULL);
2058 response = cupsDoRequest(http, request, resource);
2059 ipp_status = cupsLastError();
2060
2061 if (ipp_status == IPP_STATUS_ERROR_NOT_FOUND || ipp_status == IPP_STATUS_ERROR_NOT_POSSIBLE)
2062 {
2063 /*
2064 * Job has gone away and/or the server has no job history...
2065 */
2066
2067 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
2068 "cups-ipp-missing-job-history");
2069 ippDelete(response);
2070
2071 ipp_status = IPP_STATUS_OK;
2072 break;
2073 }
2074
2075 fprintf(stderr, "DEBUG: Get-Job-Attributes: %s (%s)\n",
2076 ippErrorString(ipp_status), cupsLastErrorString());
2077 debug_attributes(response);
2078
2079 if (ipp_status <= IPP_STATUS_OK_CONFLICTING)
2080 password_tries = 0;
2081 else
2082 {
2083 if (ipp_status != IPP_STATUS_ERROR_SERVICE_UNAVAILABLE &&
2084 ipp_status != IPP_STATUS_ERROR_BUSY)
2085 {
2086 ippDelete(response);
2087 ipp_status = IPP_STATUS_OK;
2088 break;
2089 }
2090 else if (ipp_status == IPP_STATUS_ERROR_INTERNAL)
2091 {
2092 waitjob_tries ++;
2093
2094 if (waitjob_tries > 4)
2095 {
2096 ippDelete(response);
2097 ipp_status = IPP_STATUS_OK;
2098 break;
2099 }
2100 }
2101 }
2102
2103 if (response)
2104 {
2105 if ((job_state = ippFindAttribute(response, "job-state",
2106 IPP_TAG_ENUM)) != NULL)
2107 {
2108 /*
2109 * Reflect the remote job state in the local queue...
2110 */
2111
2112 if (cups_version &&
2113 job_state->values[0].integer >= IPP_JSTATE_PENDING &&
2114 job_state->values[0].integer <= IPP_JSTATE_COMPLETED)
2115 update_reasons(NULL,
2116 remote_job_states[job_state->values[0].integer -
2117 IPP_JSTATE_PENDING]);
2118
2119 if ((job_sheets = ippFindAttribute(response, "job-impressions-completed", IPP_TAG_INTEGER)) == NULL)
2120 job_sheets = ippFindAttribute(response, "job-media-sheets-completed", IPP_TAG_INTEGER);
2121
2122 if (job_sheets)
2123 fprintf(stderr, "PAGE: total %d\n",
2124 job_sheets->values[0].integer);
2125
2126 /*
2127 * Stop polling if the job is finished or pending-held...
2128 */
2129
2130 if (job_state->values[0].integer > IPP_JSTATE_STOPPED || job_state->values[0].integer == IPP_JSTATE_HELD)
2131 {
2132 ippDelete(response);
2133 break;
2134 }
2135 }
2136 else if (ipp_status != IPP_STATUS_ERROR_SERVICE_UNAVAILABLE &&
2137 ipp_status != IPP_STATUS_ERROR_NOT_POSSIBLE &&
2138 ipp_status != IPP_STATUS_ERROR_BUSY)
2139 {
2140 /*
2141 * If the printer does not return a job-state attribute, it does not
2142 * conform to the IPP specification - break out immediately and fail
2143 * the job...
2144 */
2145
2146 update_reasons(NULL, "+cups-ipp-conformance-failure-report,"
2147 "cups-ipp-missing-job-state");
2148 ipp_status = IPP_STATUS_ERROR_INTERNAL;
2149 break;
2150 }
2151 }
2152
2153 ippDelete(response);
2154
2155 /*
2156 * Wait before polling again...
2157 */
2158
2159 sleep((unsigned)delay);
2160
2161 delay = _cupsNextDelay(delay, &prev_delay);
2162 }
2163 }
2164
2165 /*
2166 * Cancel the job as needed...
2167 */
2168
2169 if (job_canceled > 0 && job_id > 0)
2170 {
2171 cancel_job(http, uri, job_id, resource, argv[2], version);
2172
2173 if (cupsLastError() > IPP_STATUS_OK_CONFLICTING)
2174 _cupsLangPrintFilter(stderr, "ERROR", _("Unable to cancel print job."));
2175 }
2176
2177 /*
2178 * Check the printer state and report it if necessary...
2179 */
2180
2181 check_printer_state(http, uri, resource, argv[2], version);
2182
2183 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING)
2184 password_tries = 0;
2185
2186 /*
2187 * Collect the final page count as needed...
2188 */
2189
2190 if (have_supplies &&
2191 !backendSNMPSupplies(snmp_fd, &(http->addrlist->addr), &page_count,
2192 NULL) &&
2193 page_count > start_count)
2194 fprintf(stderr, "PAGE: total %d\n", page_count - start_count);
2195
2196 #ifdef HAVE_GSSAPI
2197 /*
2198 * See if we used Kerberos at all...
2199 */
2200
2201 if (http->gssctx)
2202 auth_info_required = "negotiate";
2203 #endif /* HAVE_GSSAPI */
2204
2205 /*
2206 * Free memory...
2207 */
2208
2209 cleanup:
2210
2211 cupsFreeOptions(num_options, options);
2212 _ppdCacheDestroy(pc);
2213 ppdClose(ppd);
2214
2215 httpClose(http);
2216
2217 ippDelete(supported);
2218
2219 /*
2220 * Remove the temporary file(s) if necessary...
2221 */
2222
2223 if (tmpfilename[0])
2224 unlink(tmpfilename);
2225
2226 /*
2227 * Return the queue status...
2228 */
2229
2230 if (ipp_status == IPP_STATUS_ERROR_NOT_AUTHORIZED || ipp_status == IPP_STATUS_ERROR_FORBIDDEN ||
2231 ipp_status == IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED ||
2232 ipp_status <= IPP_STATUS_OK_CONFLICTING)
2233 fprintf(stderr, "ATTR: auth-info-required=%s\n", auth_info_required);
2234
2235 if (ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED)
2236 fputs("JOBSTATE: account-info-needed\n", stderr);
2237 else if (ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED)
2238 fputs("JOBSTATE: account-closed\n", stderr);
2239 else if (ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED)
2240 fputs("JOBSTATE: account-limit-reached\n", stderr);
2241 else if (ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED)
2242 fputs("JOBSTATE: account-authorization-failed\n", stderr);
2243
2244 if (job_canceled)
2245 return (CUPS_BACKEND_OK);
2246 else if (ipp_status == IPP_STATUS_ERROR_NOT_AUTHORIZED || ipp_status == IPP_STATUS_ERROR_FORBIDDEN || ipp_status == IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED)
2247 return (CUPS_BACKEND_AUTH_REQUIRED);
2248 else if (ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED ||
2249 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED ||
2250 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED ||
2251 ipp_status == IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED)
2252 return (CUPS_BACKEND_HOLD);
2253 else if (ipp_status == IPP_STATUS_ERROR_INTERNAL)
2254 return (CUPS_BACKEND_STOP);
2255 else if (ipp_status == IPP_STATUS_ERROR_CONFLICTING || ipp_status == IPP_STATUS_ERROR_REQUEST_ENTITY || ipp_status == IPP_STATUS_ERROR_REQUEST_VALUE)
2256 return (CUPS_BACKEND_FAILED);
2257 else if (ipp_status == IPP_STATUS_ERROR_REQUEST_VALUE ||
2258 ipp_status == IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES ||
2259 ipp_status == IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED || job_canceled < 0)
2260 {
2261 if (ipp_status == IPP_STATUS_ERROR_REQUEST_VALUE)
2262 _cupsLangPrintFilter(stderr, "ERROR", _("Print job too large."));
2263 else if (ipp_status == IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED)
2264 _cupsLangPrintFilter(stderr, "ERROR",
2265 _("Printer cannot print supplied content."));
2266 else if (ipp_status == IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES)
2267 _cupsLangPrintFilter(stderr, "ERROR",
2268 _("Printer cannot print with supplied options."));
2269 else
2270 _cupsLangPrintFilter(stderr, "ERROR", _("Print job canceled at printer."));
2271
2272 return (CUPS_BACKEND_CANCEL);
2273 }
2274 else if (ipp_status > IPP_STATUS_OK_CONFLICTING && ipp_status != IPP_STATUS_ERROR_JOB_CANCELED)
2275 return (CUPS_BACKEND_RETRY_CURRENT);
2276 else
2277 return (CUPS_BACKEND_OK);
2278 }
2279
2280
2281 /*
2282 * 'cancel_job()' - Cancel a print job.
2283 */
2284
2285 static void
2286 cancel_job(http_t *http, /* I - HTTP connection */
2287 const char *uri, /* I - printer-uri */
2288 int id, /* I - job-id */
2289 const char *resource, /* I - Resource path */
2290 const char *user, /* I - requesting-user-name */
2291 int version) /* I - IPP version */
2292 {
2293 ipp_t *request; /* Cancel-Job request */
2294
2295
2296 _cupsLangPrintFilter(stderr, "INFO", _("Canceling print job."));
2297
2298 request = ippNewRequest(IPP_OP_CANCEL_JOB);
2299 ippSetVersion(request, version / 10, version % 10);
2300
2301 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
2302 NULL, uri);
2303 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id", id);
2304
2305 if (user && user[0])
2306 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
2307 "requesting-user-name", NULL, user);
2308
2309 /*
2310 * Do the request...
2311 */
2312
2313 ippDelete(cupsDoRequest(http, request, resource));
2314 }
2315
2316
2317 /*
2318 * 'check_printer_state()' - Check the printer state.
2319 */
2320
2321 static ipp_pstate_t /* O - Current printer-state */
2322 check_printer_state(
2323 http_t *http, /* I - HTTP connection */
2324 const char *uri, /* I - Printer URI */
2325 const char *resource, /* I - Resource path */
2326 const char *user, /* I - Username, if any */
2327 int version) /* I - IPP version */
2328 {
2329 ipp_t *request, /* IPP request */
2330 *response; /* IPP response */
2331 ipp_attribute_t *attr; /* Attribute in response */
2332 ipp_pstate_t printer_state = IPP_PSTATE_STOPPED;
2333 /* Current printer-state */
2334
2335
2336 /*
2337 * Send a Get-Printer-Attributes request and log the results...
2338 */
2339
2340 request = ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES);
2341 ippSetVersion(request, version / 10, version % 10);
2342
2343 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
2344 NULL, uri);
2345
2346 if (user && user[0])
2347 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
2348 "requesting-user-name", NULL, user);
2349
2350 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
2351 "requested-attributes",
2352 (int)(sizeof(pattrs) / sizeof(pattrs[0])), NULL, pattrs);
2353
2354 fprintf(stderr, "DEBUG: IPP/%d.%d %s #%d\n", version / 10, version % 10, ippOpString(ippGetOperation(request)), ippGetRequestId(request));
2355 debug_attributes(request);
2356
2357 if ((response = cupsDoRequest(http, request, resource)) != NULL)
2358 {
2359 report_printer_state(response);
2360
2361 if ((attr = ippFindAttribute(response, "printer-state",
2362 IPP_TAG_ENUM)) != NULL)
2363 printer_state = (ipp_pstate_t)attr->values[0].integer;
2364 }
2365
2366 fprintf(stderr, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
2367 ippErrorString(cupsLastError()), cupsLastErrorString());
2368 debug_attributes(response);
2369 ippDelete(response);
2370
2371 /*
2372 * Return the printer-state value...
2373 */
2374
2375 return (printer_state);
2376 }
2377
2378
2379 /*
2380 * 'debug_attributes()' - Print out the request or response attributes as DEBUG
2381 * messages...
2382 */
2383
2384 static void
2385 debug_attributes(ipp_t *ipp) /* I - Request or response message */
2386 {
2387 ipp_tag_t group; /* Current group */
2388 ipp_attribute_t *attr; /* Current attribute */
2389 char buffer[1024]; /* Value buffer */
2390
2391
2392 for (group = IPP_TAG_ZERO, attr = ippFirstAttribute(ipp);
2393 attr;
2394 attr = ippNextAttribute(ipp))
2395 {
2396 const char *name = ippGetName(attr);
2397
2398 if (!name)
2399 {
2400 group = IPP_TAG_ZERO;
2401 continue;
2402 }
2403
2404 if (group != ippGetGroupTag(attr))
2405 {
2406 group = ippGetGroupTag(attr);
2407 fprintf(stderr, "DEBUG: ---- %s ----\n", ippTagString(group));
2408 }
2409
2410 if (!strcmp(name, "job-password"))
2411 strlcpy(buffer, "---", sizeof(buffer));
2412 else
2413 ippAttributeString(attr, buffer, sizeof(buffer));
2414
2415 fprintf(stderr, "DEBUG: %s %s%s %s\n", name,
2416 ippGetCount(attr) > 1 ? "1setOf " : "",
2417 ippTagString(ippGetValueTag(attr)), buffer);
2418 }
2419
2420 fprintf(stderr, "DEBUG: ---- %s ----\n", ippTagString(IPP_TAG_END));
2421 }
2422
2423
2424 /*
2425 * 'monitor_printer()' - Monitor the printer state.
2426 */
2427
2428 static void * /* O - Thread exit code */
2429 monitor_printer(
2430 _cups_monitor_t *monitor) /* I - Monitoring data */
2431 {
2432 http_t *http; /* Connection to printer */
2433 ipp_t *request, /* IPP request */
2434 *response; /* IPP response */
2435 ipp_attribute_t *attr; /* Attribute in response */
2436 int delay, /* Current delay */
2437 prev_delay; /* Previous delay */
2438 ipp_op_t job_op; /* Operation to use */
2439 int job_id; /* Job ID */
2440 const char *job_name; /* Job name */
2441 ipp_jstate_t job_state; /* Job state */
2442 const char *job_user; /* Job originating user name */
2443 int password_tries = 0; /* Password tries */
2444
2445
2446 /*
2447 * Make a copy of the printer connection...
2448 */
2449
2450 http = httpConnect2(monitor->hostname, monitor->port, NULL, AF_UNSPEC,
2451 monitor->encryption, 1, 0, NULL);
2452 httpSetTimeout(http, 30.0, timeout_cb, NULL);
2453 if (username[0])
2454 cupsSetUser(username);
2455
2456 cupsSetPasswordCB2((cups_password_cb2_t)password_cb, &password_tries);
2457
2458 /*
2459 * Loop until the job is canceled, aborted, or completed.
2460 */
2461
2462 delay = _cupsNextDelay(0, &prev_delay);
2463
2464 monitor->job_reasons = 0;
2465
2466 while (monitor->job_state < IPP_JSTATE_CANCELED && !job_canceled)
2467 {
2468 /*
2469 * Reconnect to the printer as needed...
2470 */
2471
2472 if (httpGetFd(http) < 0)
2473 httpReconnect2(http, 30000, NULL);
2474
2475 if (httpGetFd(http) >= 0)
2476 {
2477 /*
2478 * Connected, so check on the printer state...
2479 */
2480
2481 monitor->printer_state = check_printer_state(http, monitor->uri,
2482 monitor->resource,
2483 monitor->user,
2484 monitor->version);
2485 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING)
2486 password_tries = 0;
2487
2488 if (monitor->job_id == 0 && monitor->create_job)
2489 {
2490 /*
2491 * No job-id yet, so continue...
2492 */
2493
2494 goto monitor_sleep;
2495 }
2496
2497 /*
2498 * Check the status of the job itself...
2499 */
2500
2501 job_op = (monitor->job_id > 0 && monitor->get_job_attrs) ?
2502 IPP_OP_GET_JOB_ATTRIBUTES : IPP_OP_GET_JOBS;
2503 request = ippNewRequest(job_op);
2504 ippSetVersion(request, monitor->version / 10, monitor->version % 10);
2505
2506 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri",
2507 NULL, monitor->uri);
2508 if (job_op == IPP_OP_GET_JOB_ATTRIBUTES)
2509 ippAddInteger(request, IPP_TAG_OPERATION, IPP_TAG_INTEGER, "job-id",
2510 monitor->job_id);
2511
2512 if (monitor->user && monitor->user[0])
2513 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME,
2514 "requesting-user-name", NULL, monitor->user);
2515
2516 ippAddStrings(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD,
2517 "requested-attributes",
2518 (int)(sizeof(jattrs) / sizeof(jattrs[0])), NULL, jattrs);
2519
2520 /*
2521 * Do the request...
2522 */
2523
2524 response = cupsDoRequest(http, request, monitor->resource);
2525
2526 fprintf(stderr, "DEBUG: (monitor) %s: %s (%s)\n", ippOpString(job_op),
2527 ippErrorString(cupsLastError()), cupsLastErrorString());
2528
2529 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING)
2530 password_tries = 0;
2531
2532 if (job_op == IPP_OP_GET_JOB_ATTRIBUTES)
2533 {
2534 if ((attr = ippFindAttribute(response, "job-state",
2535 IPP_TAG_ENUM)) != NULL)
2536 monitor->job_state = (ipp_jstate_t)attr->values[0].integer;
2537 else
2538 monitor->job_state = IPP_JSTATE_COMPLETED;
2539 }
2540 else if (response)
2541 {
2542 for (attr = response->attrs; attr; attr = attr->next)
2543 {
2544 job_id = 0;
2545 job_name = NULL;
2546 job_state = IPP_JSTATE_PENDING;
2547 job_user = NULL;
2548
2549 while (attr && attr->group_tag != IPP_TAG_JOB)
2550 attr = attr->next;
2551
2552 if (!attr)
2553 break;
2554
2555 while (attr && attr->group_tag == IPP_TAG_JOB)
2556 {
2557 if (!strcmp(attr->name, "job-id") &&
2558 attr->value_tag == IPP_TAG_INTEGER)
2559 job_id = attr->values[0].integer;
2560 else if (!strcmp(attr->name, "job-name") &&
2561 (attr->value_tag == IPP_TAG_NAME ||
2562 attr->value_tag == IPP_TAG_NAMELANG))
2563 job_name = attr->values[0].string.text;
2564 else if (!strcmp(attr->name, "job-state") &&
2565 attr->value_tag == IPP_TAG_ENUM)
2566 job_state = (ipp_jstate_t)attr->values[0].integer;
2567 else if (!strcmp(attr->name, "job-originating-user-name") &&
2568 (attr->value_tag == IPP_TAG_NAME ||
2569 attr->value_tag == IPP_TAG_NAMELANG))
2570 job_user = attr->values[0].string.text;
2571
2572 attr = attr->next;
2573 }
2574
2575 if (job_id > 0 && job_name && !strcmp(job_name, monitor->job_name) &&
2576 job_user && monitor->user && !strcmp(job_user, monitor->user))
2577 {
2578 monitor->job_id = job_id;
2579 monitor->job_state = job_state;
2580 break;
2581 }
2582
2583 if (!attr)
2584 break;
2585 }
2586 }
2587
2588 fprintf(stderr, "DEBUG: (monitor) job-state = %s\n", ippEnumString("job-state", (int)monitor->job_state));
2589
2590 if (!job_canceled &&
2591 (monitor->job_state == IPP_JSTATE_CANCELED ||
2592 monitor->job_state == IPP_JSTATE_ABORTED))
2593 {
2594 job_canceled = -1;
2595 fprintf(stderr, "DEBUG: (monitor) job_canceled = -1\n");
2596 }
2597
2598 if ((attr = ippFindAttribute(response, "job-state-reasons",
2599 IPP_TAG_KEYWORD)) != NULL)
2600 {
2601 int i, new_reasons = 0; /* Looping var, new reasons */
2602
2603 for (i = 0; i < attr->num_values; i ++)
2604 {
2605 if (!strcmp(attr->values[i].string.text, "account-authorization-failed"))
2606 new_reasons |= _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED;
2607 else if (!strcmp(attr->values[i].string.text, "account-closed"))
2608 new_reasons |= _CUPS_JSR_ACCOUNT_CLOSED;
2609 else if (!strcmp(attr->values[i].string.text, "account-info-needed"))
2610 new_reasons |= _CUPS_JSR_ACCOUNT_INFO_NEEDED;
2611 else if (!strcmp(attr->values[i].string.text, "account-limit-reached"))
2612 new_reasons |= _CUPS_JSR_ACCOUNT_LIMIT_REACHED;
2613 else if (!strcmp(attr->values[i].string.text, "job-password-wait"))
2614 new_reasons |= _CUPS_JSR_JOB_PASSWORD_WAIT;
2615 else if (!strcmp(attr->values[i].string.text, "job-release-wait"))
2616 new_reasons |= _CUPS_JSR_JOB_RELEASE_WAIT;
2617 else if (!strcmp(attr->values[i].string.text, "document-format-error"))
2618 new_reasons |= _CUPS_JSR_DOCUMENT_FORMAT_ERROR;
2619 else if (!strcmp(attr->values[i].string.text, "document-unprintable"))
2620 new_reasons |= _CUPS_JSR_DOCUMENT_UNPRINTABLE;
2621
2622 if (!job_canceled && (!strncmp(attr->values[i].string.text, "job-canceled-", 13) || !strcmp(attr->values[i].string.text, "aborted-by-system")))
2623 job_canceled = 1;
2624 }
2625
2626 if (new_reasons != monitor->job_reasons)
2627 {
2628 if (new_reasons & _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED)
2629 fputs("JOBSTATE: account-authorization-failed\n", stderr);
2630 else if (new_reasons & _CUPS_JSR_ACCOUNT_CLOSED)
2631 fputs("JOBSTATE: account-closed\n", stderr);
2632 else if (new_reasons & _CUPS_JSR_ACCOUNT_INFO_NEEDED)
2633 fputs("JOBSTATE: account-info-needed\n", stderr);
2634 else if (new_reasons & _CUPS_JSR_ACCOUNT_LIMIT_REACHED)
2635 fputs("JOBSTATE: account-limit-reached\n", stderr);
2636 else if (new_reasons & _CUPS_JSR_JOB_PASSWORD_WAIT)
2637 fputs("JOBSTATE: job-password-wait\n", stderr);
2638 else if (new_reasons & _CUPS_JSR_JOB_RELEASE_WAIT)
2639 fputs("JOBSTATE: job-release-wait\n", stderr);
2640 else if (new_reasons & (_CUPS_JSR_DOCUMENT_FORMAT_ERROR | _CUPS_JSR_DOCUMENT_UNPRINTABLE))
2641 {
2642 if (monitor->retryable)
2643 {
2644 /*
2645 * Can't print this, so retry as raster...
2646 */
2647
2648 job_canceled = 1;
2649 fputs("JOBSTATE: cups-retry-as-raster\n", stderr);
2650 }
2651 else if (new_reasons & _CUPS_JSR_DOCUMENT_FORMAT_ERROR)
2652 {
2653 fputs("JOBSTATE: document-format-error\n", stderr);
2654 }
2655 else
2656 {
2657 fputs("JOBSTATE: document-unprintable\n", stderr);
2658 }
2659 }
2660 else
2661 fputs("JOBSTATE: job-printing\n", stderr);
2662
2663 monitor->job_reasons = new_reasons;
2664 }
2665 }
2666
2667 ippDelete(response);
2668
2669 fprintf(stderr, "DEBUG: (monitor) job-state = %s\n", ippEnumString("job-state", (int)monitor->job_state));
2670
2671 if (!job_canceled &&
2672 (monitor->job_state == IPP_JSTATE_CANCELED ||
2673 monitor->job_state == IPP_JSTATE_ABORTED))
2674 job_canceled = -1;
2675 }
2676
2677 /*
2678 * Sleep for N seconds...
2679 */
2680
2681 monitor_sleep:
2682
2683 sleep((unsigned)delay);
2684
2685 delay = _cupsNextDelay(delay, &prev_delay);
2686 }
2687
2688 /*
2689 * Cancel the job if necessary...
2690 */
2691
2692 if (job_canceled > 0 && monitor->job_id > 0)
2693 {
2694 if (httpGetFd(http) < 0)
2695 httpReconnect2(http, 30000, NULL);
2696
2697 if (httpGetFd(http) >= 0)
2698 {
2699 cancel_job(http, monitor->uri, monitor->job_id, monitor->resource,
2700 monitor->user, monitor->version);
2701
2702 if (cupsLastError() > IPP_STATUS_OK_CONFLICTING)
2703 {
2704 fprintf(stderr, "DEBUG: (monitor) cancel_job() = %s\n", cupsLastErrorString());
2705 _cupsLangPrintFilter(stderr, "ERROR", _("Unable to cancel print job."));
2706 }
2707 }
2708 }
2709
2710 /*
2711 * Cleanup and return...
2712 */
2713
2714 httpClose(http);
2715
2716 return (NULL);
2717 }
2718
2719
2720 /*
2721 * 'new_request()' - Create a new print creation or validation request.
2722 */
2723
2724 static ipp_t * /* O - Request data */
2725 new_request(
2726 ipp_op_t op, /* I - IPP operation code */
2727 int version, /* I - IPP version number */
2728 const char *uri, /* I - printer-uri value */
2729 const char *user, /* I - requesting-user-name value */
2730 const char *title, /* I - job-name value */
2731 int num_options, /* I - Number of options to send */
2732 cups_option_t *options, /* I - Options to send */
2733 const char *compression, /* I - compression value or NULL */
2734 int copies, /* I - copies value or 0 */
2735 const char *format, /* I - document-format value or NULL */
2736 _ppd_cache_t *pc, /* I - PPD cache and mapping data */
2737 ppd_file_t *ppd, /* I - PPD file data */
2738 ipp_attribute_t *media_col_sup, /* I - media-col-supported values */
2739 ipp_attribute_t *doc_handling_sup, /* I - multiple-document-handling-supported values */
2740 ipp_attribute_t *print_color_mode_sup)
2741 /* I - Printer supports print-color-mode */
2742 {
2743 ipp_t *request; /* Request data */
2744 const char *keyword; /* PWG keyword */
2745
2746
2747 /*
2748 * Create the IPP request...
2749 */
2750
2751 request = ippNewRequest(op);
2752 ippSetVersion(request, version / 10, version % 10);
2753
2754 fprintf(stderr, "DEBUG: %s IPP/%d.%d\n",
2755 ippOpString(request->request.op.operation_id),
2756 request->request.op.version[0],
2757 request->request.op.version[1]);
2758
2759 /*
2760 * Add standard attributes...
2761 */
2762
2763 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_URI, "printer-uri", NULL, uri);
2764 fprintf(stderr, "DEBUG: printer-uri=\"%s\"\n", uri);
2765
2766 if (user && *user)
2767 {
2768 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "requesting-user-name", NULL, user);
2769 fprintf(stderr, "DEBUG: requesting-user-name=\"%s\"\n", user);
2770 }
2771
2772 if (title && *title)
2773 {
2774 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_NAME, "job-name", NULL, title);
2775 fprintf(stderr, "DEBUG: job-name=\"%s\"\n", title);
2776 }
2777
2778 if (format && op != IPP_OP_CREATE_JOB)
2779 {
2780 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_MIMETYPE, "document-format", NULL, format);
2781 fprintf(stderr, "DEBUG: document-format=\"%s\"\n", format);
2782 }
2783
2784 #ifdef HAVE_LIBZ
2785 if (compression && op != IPP_OP_CREATE_JOB && op != IPP_OP_VALIDATE_JOB)
2786 {
2787 ippAddString(request, IPP_TAG_OPERATION, IPP_TAG_KEYWORD, "compression", NULL, compression);
2788 fprintf(stderr, "DEBUG: compression=\"%s\"\n", compression);
2789 }
2790 #endif /* HAVE_LIBZ */
2791
2792 /*
2793 * Handle options on the command-line...
2794 */
2795
2796 if (num_options > 0)
2797 {
2798 if (pc)
2799 {
2800 /*
2801 * Send standard IPP attributes...
2802 */
2803
2804 fputs("DEBUG: Adding standard IPP operation/job attributes.\n", stderr);
2805
2806 copies = _cupsConvertOptions(request, ppd, pc, media_col_sup, doc_handling_sup, print_color_mode_sup, user, format, copies, num_options, options);
2807
2808 /*
2809 * Map FaxOut options...
2810 */
2811
2812 if ((keyword = cupsGetOption("phone", num_options, options)) != NULL)
2813 {
2814 ipp_t *destination; /* destination collection */
2815 char phone[1024], /* Phone number string */
2816 *ptr, /* Pointer into string */
2817 tel_uri[1024]; /* tel: URI */
2818 static const char * const allowed = "0123456789#*-+.()pw";
2819 /* Allowed characters */
2820
2821 destination = ippNew();
2822
2823 /*
2824 * Unescape and filter out spaces and other characters that are not
2825 * allowed in a tel: URI.
2826 */
2827
2828 _httpDecodeURI(phone, keyword, sizeof(phone));
2829 for (ptr = phone; *ptr;)
2830 {
2831 if (*ptr == ',')
2832 *ptr = 'p';
2833 else if (!strchr(allowed, *ptr))
2834 _cups_strcpy(ptr, ptr + 1);
2835 else
2836 ptr ++;
2837 }
2838
2839 httpAssembleURI(HTTP_URI_CODING_ALL, tel_uri, sizeof(tel_uri), "tel", NULL, NULL, 0, phone);
2840 ippAddString(destination, IPP_TAG_JOB, IPP_TAG_URI, "destination-uri", NULL, tel_uri);
2841
2842 if ((keyword = cupsGetOption("faxPrefix", num_options,
2843 options)) != NULL && *keyword)
2844 {
2845 char predial[1024]; /* Pre-dial string */
2846
2847 _httpDecodeURI(predial, keyword, sizeof(predial));
2848 ippAddString(destination, IPP_TAG_JOB, IPP_TAG_TEXT, "pre-dial-string", NULL, predial);
2849 }
2850
2851 ippAddCollection(request, IPP_TAG_JOB, "destination-uris", destination);
2852 ippDelete(destination);
2853 }
2854 }
2855 else
2856 {
2857 /*
2858 * When talking to another CUPS server, send all options...
2859 */
2860
2861 fputs("DEBUG: Adding all operation/job attributes.\n", stderr);
2862 cupsEncodeOptions2(request, num_options, options, IPP_TAG_OPERATION);
2863 cupsEncodeOptions2(request, num_options, options, IPP_TAG_JOB);
2864 }
2865
2866 if (copies > 1 && (!pc || copies <= pc->max_copies))
2867 ippAddInteger(request, IPP_TAG_JOB, IPP_TAG_INTEGER, "copies", copies);
2868 }
2869
2870 fprintf(stderr, "DEBUG: IPP/%d.%d %s #%d\n", version / 10, version % 10, ippOpString(ippGetOperation(request)), ippGetRequestId(request));
2871 debug_attributes(request);
2872
2873 return (request);
2874 }
2875
2876
2877 /*
2878 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
2879 */
2880
2881 static const char * /* O - Password */
2882 password_cb(const char *prompt, /* I - Prompt (not used) */
2883 http_t *http, /* I - Connection */
2884 const char *method, /* I - Request method (not used) */
2885 const char *resource, /* I - Resource path (not used) */
2886 int *password_tries) /* I - Password tries */
2887 {
2888 char def_username[HTTP_MAX_VALUE]; /* Default username */
2889
2890
2891 fprintf(stderr, "DEBUG: password_cb(prompt=\"%s\", http=%p, method=\"%s\", "
2892 "resource=\"%s\", password_tries=%p(%d)), password=%p\n",
2893 prompt, http, method, resource, password_tries, *password_tries,
2894 password);
2895
2896 (void)prompt;
2897 (void)method;
2898 (void)resource;
2899
2900 if (!uri_credentials)
2901 {
2902 /*
2903 * Remember that we need to authenticate...
2904 */
2905
2906 auth_info_required = "username,password";
2907
2908 if (httpGetSubField(http, HTTP_FIELD_WWW_AUTHENTICATE, "username",
2909 def_username))
2910 {
2911 char quoted[HTTP_MAX_VALUE * 2 + 4];
2912 /* Quoted string */
2913
2914 fprintf(stderr, "ATTR: auth-info-default=%s,\n",
2915 quote_string(def_username, quoted, sizeof(quoted)));
2916 }
2917 }
2918
2919 if (password && *password && *password_tries < 3)
2920 {
2921 (*password_tries) ++;
2922
2923 cupsSetUser(username);
2924
2925 return (password);
2926 }
2927 else
2928 {
2929 /*
2930 * Give up after 3 tries or if we don't have a password to begin with...
2931 */
2932
2933 return (NULL);
2934 }
2935 }
2936
2937
2938 /*
2939 * 'quote_string()' - Quote a string value.
2940 */
2941
2942 static const char * /* O - Quoted string */
2943 quote_string(const char *s, /* I - String */
2944 char *q, /* I - Quoted string buffer */
2945 size_t qsize) /* I - Size of quoted string buffer */
2946 {
2947 char *qptr, /* Pointer into string buffer */
2948 *qend; /* End of string buffer */
2949
2950
2951 qptr = q;
2952 qend = q + qsize - 5;
2953
2954 if (qend < q)
2955 {
2956 *q = '\0';
2957 return (q);
2958 }
2959
2960 *qptr++ = '\'';
2961 *qptr++ = '\"';
2962
2963 while (*s && qptr < qend)
2964 {
2965 if (*s == '\\' || *s == '\"' || *s == '\'')
2966 {
2967 if (qptr < (qend - 4))
2968 {
2969 *qptr++ = '\\';
2970 *qptr++ = '\\';
2971 *qptr++ = '\\';
2972 }
2973 else
2974 break;
2975 }
2976
2977 *qptr++ = *s++;
2978 }
2979
2980 *qptr++ = '\"';
2981 *qptr++ = '\'';
2982 *qptr = '\0';
2983
2984 return (q);
2985 }
2986
2987
2988 /*
2989 * 'report_attr()' - Report an IPP attribute value.
2990 */
2991
2992 static void
2993 report_attr(ipp_attribute_t *attr) /* I - Attribute */
2994 {
2995 int i; /* Looping var */
2996 char value[1024], /* Value string */
2997 *valptr; /* Pointer into value string */
2998 const char *cached; /* Cached attribute */
2999
3000
3001 /*
3002 * Convert the attribute values into quoted strings...
3003 */
3004
3005 for (i = 0, valptr = value;
3006 i < attr->num_values && valptr < (value + sizeof(value) - 10);
3007 i ++)
3008 {
3009 if (i > 0)
3010 *valptr++ = ',';
3011
3012 switch (attr->value_tag)
3013 {
3014 case IPP_TAG_INTEGER :
3015 case IPP_TAG_ENUM :
3016 snprintf(valptr, sizeof(value) - (size_t)(valptr - value), "%d", attr->values[i].integer);
3017 valptr += strlen(valptr);
3018 break;
3019
3020 case IPP_TAG_TEXT :
3021 case IPP_TAG_NAME :
3022 case IPP_TAG_KEYWORD :
3023 quote_string(attr->values[i].string.text, valptr, (size_t)(value + sizeof(value) - valptr));
3024 valptr += strlen(valptr);
3025 break;
3026
3027 default :
3028 /*
3029 * Unsupported value type...
3030 */
3031
3032 return;
3033 }
3034 }
3035
3036 *valptr = '\0';
3037
3038 _cupsMutexLock(&report_mutex);
3039
3040 if ((cached = cupsGetOption(attr->name, num_attr_cache,
3041 attr_cache)) == NULL || strcmp(cached, value))
3042 {
3043 /*
3044 * Tell the scheduler about the new values...
3045 */
3046
3047 num_attr_cache = cupsAddOption(attr->name, value, num_attr_cache,
3048 &attr_cache);
3049 fprintf(stderr, "ATTR: %s=%s\n", attr->name, value);
3050 }
3051
3052 _cupsMutexUnlock(&report_mutex);
3053 }
3054
3055
3056 /*
3057 * 'report_printer_state()' - Report the printer state.
3058 */
3059
3060 static void
3061 report_printer_state(ipp_t *ipp) /* I - IPP response */
3062 {
3063 ipp_attribute_t *pa, /* printer-alert */
3064 *pam, /* printer-alert-message */
3065 *pmja, /* printer-mandatory-job-attributes */
3066 *psm, /* printer-state-message */
3067 *reasons, /* printer-state-reasons */
3068 *marker; /* marker-* attributes */
3069 char value[1024], /* State/message string */
3070 *valptr; /* Pointer into string */
3071 static int ipp_supplies = -1;
3072 /* Report supply levels? */
3073
3074
3075 /*
3076 * Report alerts and messages...
3077 */
3078
3079 if ((pa = ippFindAttribute(ipp, "printer-alert", IPP_TAG_TEXT)) != NULL)
3080 report_attr(pa);
3081
3082 if ((pam = ippFindAttribute(ipp, "printer-alert-message",
3083 IPP_TAG_TEXT)) != NULL)
3084 report_attr(pam);
3085
3086 if ((pmja = ippFindAttribute(ipp, "printer-mandatory-job-attributes", IPP_TAG_KEYWORD)) != NULL)
3087 {
3088 int i, /* Looping var */
3089 count = ippGetCount(pmja); /* Number of values */
3090
3091 for (i = 0, valptr = value; i < count; i ++, valptr += strlen(valptr))
3092 {
3093 if (i)
3094 snprintf(valptr, sizeof(value) - (size_t)(valptr - value), " %s", ippGetString(pmja, i, NULL));
3095 else
3096 strlcpy(value, ippGetString(pmja, i, NULL), sizeof(value));
3097 }
3098
3099 if (strcmp(value, mandatory_attrs))
3100 {
3101 strlcpy(mandatory_attrs, value, sizeof(mandatory_attrs));
3102 fprintf(stderr, "PPD: cupsMandatory=\"%s\"\n", value);
3103 }
3104 }
3105
3106 if ((psm = ippFindAttribute(ipp, "printer-state-message",
3107 IPP_TAG_TEXT)) != NULL)
3108 {
3109 char *ptr; /* Pointer into message */
3110
3111
3112 strlcpy(value, "INFO: ", sizeof(value));
3113 for (ptr = psm->values[0].string.text, valptr = value + 6;
3114 *ptr && valptr < (value + sizeof(value) - 6);
3115 ptr ++)
3116 {
3117 if (*ptr < ' ' && *ptr > 0 && *ptr != '\t')
3118 {
3119 /*
3120 * Substitute "<XX>" for the control character; sprintf is safe because
3121 * we always leave 6 chars free at the end...
3122 */
3123
3124 sprintf(valptr, "<%02X>", *ptr);
3125 valptr += 4;
3126 }
3127 else
3128 *valptr++ = *ptr;
3129 }
3130
3131 *valptr++ = '\n';
3132 *valptr = '\0';
3133
3134 fputs(value, stderr);
3135 }
3136
3137 /*
3138 * Now report printer-state-reasons, filtering out some of the reasons we never
3139 * want to set...
3140 */
3141
3142 if ((reasons = ippFindAttribute(ipp, "printer-state-reasons",
3143 IPP_TAG_KEYWORD)) == NULL)
3144 return;
3145
3146 update_reasons(reasons, NULL);
3147
3148 /*
3149 * Relay the current marker-* attribute values...
3150 */
3151
3152 if (ipp_supplies < 0)
3153 {
3154 ppd_file_t *ppd; /* PPD file */
3155 ppd_attr_t *ppdattr; /* Attribute in PPD file */
3156
3157 if ((ppd = ppdOpenFile(getenv("PPD"))) != NULL &&
3158 (ppdattr = ppdFindAttr(ppd, "cupsIPPSupplies", NULL)) != NULL &&
3159 ppdattr->value && _cups_strcasecmp(ppdattr->value, "true"))
3160 ipp_supplies = 0;
3161 else
3162 ipp_supplies = 1;
3163
3164 ppdClose(ppd);
3165 }
3166
3167 if (ipp_supplies > 0)
3168 {
3169 if ((marker = ippFindAttribute(ipp, "marker-colors", IPP_TAG_NAME)) != NULL)
3170 report_attr(marker);
3171 if ((marker = ippFindAttribute(ipp, "marker-high-levels",
3172 IPP_TAG_INTEGER)) != NULL)
3173 report_attr(marker);
3174 if ((marker = ippFindAttribute(ipp, "marker-levels",
3175 IPP_TAG_INTEGER)) != NULL)
3176 report_attr(marker);
3177 if ((marker = ippFindAttribute(ipp, "marker-low-levels",
3178 IPP_TAG_INTEGER)) != NULL)
3179 report_attr(marker);
3180 if ((marker = ippFindAttribute(ipp, "marker-message",
3181 IPP_TAG_TEXT)) != NULL)
3182 report_attr(marker);
3183 if ((marker = ippFindAttribute(ipp, "marker-names", IPP_TAG_NAME)) != NULL)
3184 report_attr(marker);
3185 if ((marker = ippFindAttribute(ipp, "marker-types",
3186 IPP_TAG_KEYWORD)) != NULL)
3187 report_attr(marker);
3188 }
3189 }
3190
3191
3192 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3193 /*
3194 * 'run_as_user()' - Run the IPP backend as the printing user.
3195 *
3196 * This function uses an XPC-based user agent to run the backend as the printing
3197 * user. We need to do this in order to have access to the user's Kerberos
3198 * credentials.
3199 */
3200
3201 static int /* O - Exit status */
3202 run_as_user(char *argv[], /* I - Command-line arguments */
3203 uid_t uid, /* I - User ID */
3204 const char *device_uri, /* I - Device URI */
3205 int fd) /* I - File to print */
3206 {
3207 const char *auth_negotiate;/* AUTH_NEGOTIATE env var */
3208 xpc_connection_t conn; /* Connection to XPC service */
3209 xpc_object_t request; /* Request message dictionary */
3210 __block xpc_object_t response; /* Response message dictionary */
3211 dispatch_semaphore_t sem; /* Semaphore for waiting for response */
3212 int status = CUPS_BACKEND_FAILED;
3213 /* Status of request */
3214
3215
3216 fprintf(stderr, "DEBUG: Running IPP backend as UID %d.\n", (int)uid);
3217
3218 /*
3219 * Connect to the user agent for the specified UID...
3220 */
3221
3222 conn = xpc_connection_create_mach_service(kPMPrintUIToolAgent,
3223 dispatch_get_global_queue(0, 0), 0);
3224 if (!conn)
3225 {
3226 _cupsLangPrintFilter(stderr, "ERROR",
3227 _("Unable to start backend process."));
3228 fputs("DEBUG: Unable to create connection to agent.\n", stderr);
3229 goto cleanup;
3230 }
3231
3232 xpc_connection_set_event_handler(conn,
3233 ^(xpc_object_t event)
3234 {
3235 xpc_type_t messageType = xpc_get_type(event);
3236
3237 if (messageType == XPC_TYPE_ERROR)
3238 {
3239 if (event == XPC_ERROR_CONNECTION_INTERRUPTED)
3240 fprintf(stderr, "DEBUG: Interrupted connection to service %s.\n",
3241 xpc_connection_get_name(conn));
3242 else if (event == XPC_ERROR_CONNECTION_INVALID)
3243 fprintf(stderr, "DEBUG: Connection invalid for service %s.\n",
3244 xpc_connection_get_name(conn));
3245 else
3246 fprintf(stderr, "DEBUG: Unxpected error for service %s: %s\n",
3247 xpc_connection_get_name(conn),
3248 xpc_dictionary_get_string(event, XPC_ERROR_KEY_DESCRIPTION));
3249 }
3250 });
3251 xpc_connection_set_target_uid(conn, uid);
3252 xpc_connection_resume(conn);
3253
3254 /*
3255 * Try starting the backend...
3256 */
3257
3258 request = xpc_dictionary_create(NULL, NULL, 0);
3259 xpc_dictionary_set_int64(request, "command", kPMStartJob);
3260 xpc_dictionary_set_string(request, "device-uri", device_uri);
3261 xpc_dictionary_set_string(request, "job-id", argv[1]);
3262 xpc_dictionary_set_string(request, "user", argv[2]);
3263 xpc_dictionary_set_string(request, "title", argv[3]);
3264 xpc_dictionary_set_string(request, "copies", argv[4]);
3265 xpc_dictionary_set_string(request, "options", argv[5]);
3266 xpc_dictionary_set_string(request, "auth-info-required",
3267 getenv("AUTH_INFO_REQUIRED"));
3268 if ((auth_negotiate = getenv("AUTH_NEGOTIATE")) != NULL)
3269 xpc_dictionary_set_string(request, "auth-negotiate", auth_negotiate);
3270 xpc_dictionary_set_fd(request, "stdin", fd);
3271 xpc_dictionary_set_fd(request, "stderr", 2);
3272 xpc_dictionary_set_fd(request, "side-channel", CUPS_SC_FD);
3273
3274 sem = dispatch_semaphore_create(0);
3275 response = NULL;
3276
3277 xpc_connection_send_message_with_reply(conn, request,
3278 dispatch_get_global_queue(0,0),
3279 ^(xpc_object_t reply)
3280 {
3281 /* Save the response and wake up */
3282 if (xpc_get_type(reply)
3283 == XPC_TYPE_DICTIONARY)
3284 response = xpc_retain(reply);
3285
3286 dispatch_semaphore_signal(sem);
3287 });
3288
3289 dispatch_semaphore_wait(sem, DISPATCH_TIME_FOREVER);
3290 xpc_release(request);
3291 dispatch_release(sem);
3292
3293 if (response)
3294 {
3295 child_pid = (pid_t)xpc_dictionary_get_int64(response, "child-pid");
3296
3297 xpc_release(response);
3298
3299 if (child_pid)
3300 fprintf(stderr, "DEBUG: Child PID=%d.\n", (int)child_pid);
3301 else
3302 {
3303 _cupsLangPrintFilter(stderr, "ERROR",
3304 _("Unable to start backend process."));
3305 fputs("DEBUG: No child PID.\n", stderr);
3306 goto cleanup;
3307 }
3308 }
3309 else
3310 {
3311 _cupsLangPrintFilter(stderr, "ERROR",
3312 _("Unable to start backend process."));
3313 fputs("DEBUG: No reply from agent.\n", stderr);
3314 goto cleanup;
3315 }
3316
3317 /*
3318 * Then wait for the backend to finish...
3319 */
3320
3321 request = xpc_dictionary_create(NULL, NULL, 0);
3322 xpc_dictionary_set_int64(request, "command", kPMWaitForJob);
3323 xpc_dictionary_set_fd(request, "stderr", 2);
3324
3325 sem = dispatch_semaphore_create(0);
3326 response = NULL;
3327
3328 xpc_connection_send_message_with_reply(conn, request,
3329 dispatch_get_global_queue(0,0),
3330 ^(xpc_object_t reply)
3331 {
3332 /* Save the response and wake up */
3333 if (xpc_get_type(reply)
3334 == XPC_TYPE_DICTIONARY)
3335 response = xpc_retain(reply);
3336
3337 dispatch_semaphore_signal(sem);
3338 });
3339
3340 dispatch_semaphore_wait(sem, DISPATCH_TIME_FOREVER);
3341 xpc_release(request);
3342 dispatch_release(sem);
3343
3344 if (response)
3345 {
3346 status = (int)xpc_dictionary_get_int64(response, "status");
3347
3348 if (status == SIGTERM || status == SIGKILL || status == SIGPIPE)
3349 {
3350 fprintf(stderr, "DEBUG: Child terminated on signal %d.\n", status);
3351 status = CUPS_BACKEND_FAILED;
3352 }
3353 else if (WIFSIGNALED(status))
3354 {
3355 fprintf(stderr, "DEBUG: Child crashed on signal %d.\n", status);
3356 status = CUPS_BACKEND_STOP;
3357 }
3358 else if (WIFEXITED(status))
3359 {
3360 status = WEXITSTATUS(status);
3361 fprintf(stderr, "DEBUG: Child exited with status %d.\n", status);
3362 }
3363
3364 xpc_release(response);
3365 }
3366 else
3367 _cupsLangPrintFilter(stderr, "ERROR",
3368 _("Unable to get backend exit status."));
3369
3370 cleanup:
3371
3372 if (conn)
3373 {
3374 xpc_connection_cancel(conn);
3375 xpc_release(conn);
3376 }
3377
3378 return (status);
3379 }
3380 #endif /* HAVE_GSSAPI && HAVE_XPC */
3381
3382
3383 /*
3384 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
3385 */
3386
3387 static void
3388 sigterm_handler(int sig) /* I - Signal */
3389 {
3390 (void)sig; /* remove compiler warnings... */
3391
3392 write(2, "DEBUG: Got SIGTERM.\n", 20);
3393
3394 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3395 if (child_pid)
3396 {
3397 kill(child_pid, sig);
3398 child_pid = 0;
3399 }
3400 #endif /* HAVE_GSSAPI && HAVE_XPC */
3401
3402 if (!job_canceled)
3403 {
3404 /*
3405 * Flag that the job should be canceled...
3406 */
3407
3408 write(2, "DEBUG: sigterm_handler: job_canceled = 1.\n", 25);
3409
3410 job_canceled = 1;
3411 return;
3412 }
3413
3414 /*
3415 * The scheduler already tried to cancel us once, now just terminate
3416 * after removing our temp file!
3417 */
3418
3419 if (tmpfilename[0])
3420 unlink(tmpfilename);
3421
3422 _exit(1);
3423 }
3424
3425
3426 /*
3427 * 'timeout_cb()' - Handle HTTP timeouts.
3428 */
3429
3430 static int /* O - 1 to continue, 0 to cancel */
3431 timeout_cb(http_t *http, /* I - Connection to server (unused) */
3432 void *user_data) /* I - User data (unused) */
3433 {
3434 (void)http;
3435 (void)user_data;
3436
3437 return (!job_canceled);
3438 }
3439
3440
3441 /*
3442 * 'update_reasons()' - Update the printer-state-reasons values.
3443 */
3444
3445 static void
3446 update_reasons(ipp_attribute_t *attr, /* I - printer-state-reasons or NULL */
3447 const char *s) /* I - STATE: string or NULL */
3448 {
3449 char op; /* Add (+), remove (-), replace (\0) */
3450 cups_array_t *new_reasons; /* New reasons array */
3451 char *reason, /* Current reason */
3452 add[2048], /* Reasons added string */
3453 *addptr, /* Pointer into add string */
3454 rem[2048], /* Reasons removed string */
3455 *remptr; /* Pointer into remove string */
3456 const char *addprefix, /* Current add string prefix */
3457 *remprefix; /* Current remove string prefix */
3458
3459
3460 fprintf(stderr, "DEBUG: update_reasons(attr=%d(%s%s), s=\"%s\")\n",
3461 attr ? attr->num_values : 0, attr ? attr->values[0].string.text : "",
3462 attr && attr->num_values > 1 ? ",..." : "", s ? s : "(null)");
3463
3464 /*
3465 * Create an array of new reason keyword strings...
3466 */
3467
3468 if (attr)
3469 {
3470 int i; /* Looping var */
3471
3472 new_reasons = cupsArrayNew((cups_array_func_t)strcmp, NULL);
3473 op = '\0';
3474
3475 for (i = 0; i < attr->num_values; i ++)
3476 {
3477 reason = attr->values[i].string.text;
3478
3479 if (strcmp(reason, "none") &&
3480 strcmp(reason, "none-report") &&
3481 strcmp(reason, "paused") &&
3482 strncmp(reason, "spool-area-full", 15) &&
3483 strcmp(reason, "com.apple.print.recoverable-warning") &&
3484 strncmp(reason, "cups-", 5))
3485 cupsArrayAdd(new_reasons, reason);
3486 }
3487 }
3488 else if (s)
3489 {
3490 if (*s == '+' || *s == '-')
3491 op = *s++;
3492 else
3493 op = '\0';
3494
3495 new_reasons = _cupsArrayNewStrings(s, ',');
3496 }
3497 else
3498 return;
3499
3500 /*
3501 * Compute the changes...
3502 */
3503
3504 add[0] = '\0';
3505 addprefix = "STATE: +";
3506 addptr = add;
3507 rem[0] = '\0';
3508 remprefix = "STATE: -";
3509 remptr = rem;
3510
3511 fprintf(stderr, "DEBUG2: op='%c', new_reasons=%d, state_reasons=%d\n",
3512 op ? op : ' ', cupsArrayCount(new_reasons),
3513 cupsArrayCount(state_reasons));
3514
3515 _cupsMutexLock(&report_mutex);
3516
3517 if (op == '+')
3518 {
3519 /*
3520 * Add reasons...
3521 */
3522
3523 for (reason = (char *)cupsArrayFirst(new_reasons);
3524 reason;
3525 reason = (char *)cupsArrayNext(new_reasons))
3526 {
3527 if (!cupsArrayFind(state_reasons, reason))
3528 {
3529 if (!strncmp(reason, "cups-remote-", 12))
3530 {
3531 /*
3532 * If we are setting cups-remote-xxx, remove all other cups-remote-xxx
3533 * keywords...
3534 */
3535
3536 char *temp; /* Current reason in state_reasons */
3537
3538 cupsArraySave(state_reasons);
3539
3540 for (temp = (char *)cupsArrayFirst(state_reasons);
3541 temp;
3542 temp = (char *)cupsArrayNext(state_reasons))
3543 if (!strncmp(temp, "cups-remote-", 12))
3544 {
3545 snprintf(remptr, sizeof(rem) - (size_t)(remptr - rem), "%s%s", remprefix, temp);
3546 remptr += strlen(remptr);
3547 remprefix = ",";
3548
3549 cupsArrayRemove(state_reasons, temp);
3550 break;
3551 }
3552
3553 cupsArrayRestore(state_reasons);
3554 }
3555
3556 cupsArrayAdd(state_reasons, reason);
3557
3558 snprintf(addptr, sizeof(add) - (size_t)(addptr - add), "%s%s", addprefix, reason);
3559 addptr += strlen(addptr);
3560 addprefix = ",";
3561 }
3562 }
3563 }
3564 else if (op == '-')
3565 {
3566 /*
3567 * Remove reasons...
3568 */
3569
3570 for (reason = (char *)cupsArrayFirst(new_reasons);
3571 reason;
3572 reason = (char *)cupsArrayNext(new_reasons))
3573 {
3574 if (cupsArrayFind(state_reasons, reason))
3575 {
3576 snprintf(remptr, sizeof(rem) - (size_t)(remptr - rem), "%s%s", remprefix, reason);
3577 remptr += strlen(remptr);
3578 remprefix = ",";
3579
3580 cupsArrayRemove(state_reasons, reason);
3581 }
3582 }
3583 }
3584 else
3585 {
3586 /*
3587 * Replace reasons...
3588 */
3589
3590 for (reason = (char *)cupsArrayFirst(state_reasons);
3591 reason;
3592 reason = (char *)cupsArrayNext(state_reasons))
3593 {
3594 if (strncmp(reason, "cups-", 5) && !cupsArrayFind(new_reasons, reason))
3595 {
3596 snprintf(remptr, sizeof(rem) - (size_t)(remptr - rem), "%s%s", remprefix, reason);
3597 remptr += strlen(remptr);
3598 remprefix = ",";
3599
3600 cupsArrayRemove(state_reasons, reason);
3601 }
3602 }
3603
3604 for (reason = (char *)cupsArrayFirst(new_reasons);
3605 reason;
3606 reason = (char *)cupsArrayNext(new_reasons))
3607 {
3608 if (!cupsArrayFind(state_reasons, reason))
3609 {
3610 cupsArrayAdd(state_reasons, reason);
3611
3612 snprintf(addptr, sizeof(add) - (size_t)(addptr - add), "%s%s", addprefix, reason);
3613 addptr += strlen(addptr);
3614 addprefix = ",";
3615 }
3616 }
3617 }
3618
3619 cupsArrayDelete(new_reasons);
3620
3621 _cupsMutexUnlock(&report_mutex);
3622
3623 /*
3624 * Report changes and return...
3625 */
3626
3627 if (add[0] && rem[0])
3628 fprintf(stderr, "%s\n%s\n", add, rem);
3629 else if (add[0])
3630 fprintf(stderr, "%s\n", add);
3631 else if (rem[0])
3632 fprintf(stderr, "%s\n", rem);
3633 }