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