2 * IPP backend for CUPS.
4 * Copyright 2007-2016 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
7 * These coded instructions, statements, and computer programs are the
8 * property of Apple Inc. and are protected by Federal copyright
9 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
10 * "LICENSE" which should have been included with this file. If this
11 * file is missing or damaged, see the license at "http://www.cups.org/".
13 * This file is subject to the Apple OS-Developed Software exception.
17 * Include necessary headers.
20 #include "backend-private.h"
21 #include <cups/ppd-private.h>
22 #include <cups/array-private.h>
23 #include <sys/types.h>
26 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
28 # define kPMPrintUIToolAgent "com.apple.printuitool.agent"
29 # define kPMStartJob 100
30 # define kPMWaitForJob 101
31 # ifdef HAVE_XPC_PRIVATE_H
32 # include <xpc/private.h>
34 extern void xpc_connection_set_target_uid(xpc_connection_t connection
,
36 # endif /* HAVE_XPC_PRIVATE_H */
37 #endif /* HAVE_GSSAPI && HAVE_XPC */
41 * Bits for job-state-reasons we care about...
44 #define _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED 0x01
45 #define _CUPS_JSR_ACCOUNT_CLOSED 0x02
46 #define _CUPS_JSR_ACCOUNT_INFO_NEEDED 0x04
47 #define _CUPS_JSR_ACCOUNT_LIMIT_REACHED 0x08
48 #define _CUPS_JSR_JOB_PASSWORD_WAIT 0x10
49 #define _CUPS_JSR_JOB_RELEASE_WAIT 0x20
56 typedef struct _cups_monitor_s
/**** Monitoring data ****/
58 const char *uri
, /* Printer URI */
59 *hostname
, /* Hostname */
61 *resource
; /* Resource path */
62 int port
, /* Port number */
63 version
, /* IPP version */
64 job_id
, /* Job ID for submitted job */
65 job_reasons
, /* Job state reasons bits */
66 create_job
, /* Support Create-Job? */
67 get_job_attrs
; /* Support Get-Job-Attributes? */
68 const char *job_name
; /* Job name for submitted job */
69 http_encryption_t encryption
; /* Use encryption? */
70 ipp_jstate_t job_state
; /* Current job state */
71 ipp_pstate_t printer_state
; /* Current printer state */
79 static const char *auth_info_required
;
80 /* New auth-info-required value */
81 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
82 static pid_t child_pid
= 0; /* Child process ID */
83 #endif /* HAVE_GSSAPI && HAVE_XPC */
84 static const char * const jattrs
[] = /* Job attributes we want */
87 "job-impressions-completed",
88 "job-media-sheets-completed",
90 "job-originating-user-name",
94 static int job_canceled
= 0,
97 /* Credentials supplied in URI? */
98 static char username
[256] = "",
99 /* Username for device URI */
101 /* Password for device URI */
102 static const char * const pattrs
[] = /* Printer attributes we want */
105 "compression-supported",
106 #endif /* HAVE_LIBZ */
109 "document-format-supported",
110 "job-password-encryption-supported",
112 "marker-high-levels",
118 "media-col-supported",
119 "multiple-document-handling-supported",
120 "operations-supported",
121 "print-color-mode-supported",
123 "printer-alert-description",
124 "printer-is-accepting-jobs",
125 "printer-mandatory-job-attributes",
127 "printer-state-message",
128 "printer-state-reasons"
130 static const char * const remote_job_states
[] =
131 { /* Remote job state keywords */
132 "+cups-remote-pending",
133 "+cups-remote-pending-held",
134 "+cups-remote-processing",
135 "+cups-remote-stopped",
136 "+cups-remote-canceled",
137 "+cups-remote-aborted",
138 "+cups-remote-completed"
140 static _cups_mutex_t report_mutex
= _CUPS_MUTEX_INITIALIZER
;
141 /* Mutex to control access */
142 static int num_attr_cache
= 0;
143 /* Number of cached attributes */
144 static cups_option_t
*attr_cache
= NULL
;
145 /* Cached attributes */
146 static cups_array_t
*state_reasons
; /* Array of printe-state-reasons keywords */
147 static char tmpfilename
[1024] = "";
148 /* Temporary spool file name */
149 static char mandatory_attrs
[1024] = "";
150 /* cupsMandatory value */
157 static void cancel_job(http_t
*http
, const char *uri
, int id
,
158 const char *resource
, const char *user
,
160 static ipp_pstate_t
check_printer_state(http_t
*http
, const char *uri
,
161 const char *resource
,
162 const char *user
, int version
);
163 static void debug_attributes(ipp_t
*ipp
);
164 static void *monitor_printer(_cups_monitor_t
*monitor
);
165 static ipp_t
*new_request(ipp_op_t op
, int version
, const char *uri
,
166 const char *user
, const char *title
,
167 int num_options
, cups_option_t
*options
,
168 const char *compression
, int copies
,
169 const char *format
, _ppd_cache_t
*pc
,
171 ipp_attribute_t
*media_col_sup
,
172 ipp_attribute_t
*doc_handling_sup
,
173 ipp_attribute_t
*print_color_mode_sup
);
174 static const char *password_cb(const char *prompt
, http_t
*http
,
175 const char *method
, const char *resource
,
177 static const char *quote_string(const char *s
, char *q
, size_t qsize
);
178 static void report_attr(ipp_attribute_t
*attr
);
179 static void report_printer_state(ipp_t
*ipp
);
180 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
181 static int run_as_user(char *argv
[], uid_t uid
,
182 const char *device_uri
, int fd
);
183 #endif /* HAVE_GSSAPI && HAVE_XPC */
184 static void sigterm_handler(int sig
);
185 static int timeout_cb(http_t
*http
, void *user_data
);
186 static void update_reasons(ipp_attribute_t
*attr
, const char *s
);
190 * 'main()' - Send a file to the printer or server.
194 * printer-uri job-id user title copies options [file]
197 int /* O - Exit status */
198 main(int argc
, /* I - Number of command-line args */
199 char *argv
[]) /* I - Command-line arguments */
201 int i
; /* Looping var */
202 int send_options
; /* Send job options? */
203 int num_options
; /* Number of printer options */
204 cups_option_t
*options
; /* Printer options */
205 const char *device_uri
; /* Device URI */
206 char scheme
[255], /* Scheme in URI */
207 hostname
[1024], /* Hostname */
208 resource
[1024], /* Resource info (printer name) */
209 addrname
[256], /* Address name */
210 *optptr
, /* Pointer to URI options */
211 *name
, /* Name of option */
212 *value
, /* Value of option */
213 sep
; /* Separator character */
214 int password_tries
= 0; /* Password tries */
215 http_addrlist_t
*addrlist
; /* Address of printer */
216 int snmp_enabled
= 1; /* Is SNMP enabled? */
217 int snmp_fd
, /* SNMP socket */
218 start_count
, /* Page count via SNMP at start */
219 page_count
, /* Page count via SNMP */
220 have_supplies
; /* Printer supports supply levels? */
221 int num_files
; /* Number of files to print */
222 char **files
, /* Files to print */
223 *compatfile
= NULL
; /* Compatibility filename */
224 off_t compatsize
= 0; /* Size of compatibility file */
225 int port
; /* Port number (not used) */
226 char portname
[255]; /* Port name */
227 char uri
[HTTP_MAX_URI
]; /* Updated URI without user/pass */
228 char print_job_name
[1024]; /* Update job-name for Print-Job */
229 http_status_t http_status
; /* Status of HTTP request */
230 ipp_status_t ipp_status
; /* Status of IPP request */
231 http_t
*http
; /* HTTP connection */
232 ipp_t
*request
, /* IPP request */
233 *response
, /* IPP response */
234 *supported
; /* get-printer-attributes response */
235 time_t start_time
; /* Time of first connect */
236 int contimeout
; /* Connection timeout */
237 int delay
, /* Delay for retries */
238 prev_delay
; /* Previous delay */
239 const char *compression
; /* Compression mode */
240 int waitjob
, /* Wait for job complete? */
241 waitjob_tries
= 0, /* Number of times we've waited */
242 waitprinter
; /* Wait for printer ready? */
243 time_t waittime
; /* Wait time for held jobs */
244 _cups_monitor_t monitor
; /* Monitoring data */
245 ipp_attribute_t
*job_id_attr
; /* job-id attribute */
246 int job_id
; /* job-id value */
247 ipp_attribute_t
*job_sheets
; /* job-media-sheets-completed */
248 ipp_attribute_t
*job_state
; /* job-state */
250 ipp_attribute_t
*compression_sup
; /* compression-supported */
251 #endif /* HAVE_LIBZ */
252 ipp_attribute_t
*copies_sup
; /* copies-supported */
253 ipp_attribute_t
*cups_version
; /* cups-version */
254 ipp_attribute_t
*encryption_sup
; /* job-password-encryption-supported */
255 ipp_attribute_t
*format_sup
; /* document-format-supported */
256 ipp_attribute_t
*job_auth
; /* job-authorization-uri */
257 ipp_attribute_t
*media_col_sup
; /* media-col-supported */
258 ipp_attribute_t
*operations_sup
; /* operations-supported */
259 ipp_attribute_t
*doc_handling_sup
; /* multiple-document-handling-supported */
260 ipp_attribute_t
*printer_state
; /* printer-state attribute */
261 ipp_attribute_t
*printer_accepting
; /* printer-is-accepting-jobs */
262 ipp_attribute_t
*print_color_mode_sup
;/* Does printer support print-color-mode? */
263 int create_job
= 0, /* Does printer support Create-Job? */
264 get_job_attrs
= 0, /* Does printer support Get-Job-Attributes? */
265 send_document
= 0, /* Does printer support Send-Document? */
266 validate_job
= 0, /* Does printer support Validate-Job? */
267 copies
, /* Number of copies for job */
268 copies_remaining
; /* Number of copies remaining */
269 const char *content_type
, /* CONTENT_TYPE environment variable */
270 *final_content_type
, /* FINAL_CONTENT_TYPE environment var */
271 *document_format
; /* document-format value */
272 int fd
; /* File descriptor */
273 off_t bytes
= 0; /* Bytes copied */
274 char buffer
[16384]; /* Copy buffer */
275 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
276 struct sigaction action
; /* Actions for POSIX signals */
277 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
278 int version
; /* IPP version */
279 ppd_file_t
*ppd
= NULL
; /* PPD file */
280 _ppd_cache_t
*pc
= NULL
; /* PPD cache and mapping data */
281 fd_set input
; /* Input set for select() */
285 * Make sure status messages are not buffered...
288 setbuf(stderr
, NULL
);
291 * Ignore SIGPIPE and catch SIGTERM signals...
295 sigset(SIGPIPE
, SIG_IGN
);
296 sigset(SIGTERM
, sigterm_handler
);
297 #elif defined(HAVE_SIGACTION)
298 memset(&action
, 0, sizeof(action
));
299 action
.sa_handler
= SIG_IGN
;
300 sigaction(SIGPIPE
, &action
, NULL
);
302 sigemptyset(&action
.sa_mask
);
303 sigaddset(&action
.sa_mask
, SIGTERM
);
304 action
.sa_handler
= sigterm_handler
;
305 sigaction(SIGTERM
, &action
, NULL
);
307 signal(SIGPIPE
, SIG_IGN
);
308 signal(SIGTERM
, sigterm_handler
);
309 #endif /* HAVE_SIGSET */
312 * Check command-line...
319 if ((s
= strrchr(argv
[0], '/')) != NULL
)
324 printf("network %s \"Unknown\" \"%s (%s)\"\n",
325 s
, _cupsLangString(cupsLangDefault(),
326 _("Internet Printing Protocol")), s
);
327 return (CUPS_BACKEND_OK
);
331 _cupsLangPrintf(stderr
,
332 _("Usage: %s job-id user title copies options [file]"),
334 return (CUPS_BACKEND_STOP
);
338 * Get the device URI...
341 while ((device_uri
= cupsBackendDeviceURI(argv
)) == NULL
)
343 _cupsLangPrintFilter(stderr
, "INFO", _("Unable to locate printer."));
346 if (getenv("CLASS") != NULL
)
347 return (CUPS_BACKEND_FAILED
);
350 if ((auth_info_required
= getenv("AUTH_INFO_REQUIRED")) == NULL
)
351 auth_info_required
= "none";
353 state_reasons
= _cupsArrayNewStrings(getenv("PRINTER_STATE_REASONS"), ',');
357 * For Kerberos, become the printing user (if we can) to get the credentials
361 if (!getuid() && (value
= getenv("AUTH_UID")) != NULL
&&
362 !getenv("AUTH_PASSWORD"))
364 uid_t uid
= (uid_t
)atoi(value
);
371 return (run_as_user(argv
, uid
, device_uri
, 0));
374 int status
= 0; /* Exit status */
376 for (i
= 6; i
< argc
&& !status
&& !job_canceled
; i
++)
378 if ((fd
= open(argv
[i
], O_RDONLY
)) >= 0)
380 status
= run_as_user(argv
, uid
, device_uri
, fd
);
385 _cupsLangPrintError("ERROR", _("Unable to open print file"));
386 status
= CUPS_BACKEND_FAILED
;
394 # else /* No XPC, just try to run as the user ID */
397 # endif /* HAVE_XPC */
399 #endif /* HAVE_GSSAPI */
402 * Get the (final) content type...
405 if ((content_type
= getenv("CONTENT_TYPE")) == NULL
)
406 content_type
= "application/octet-stream";
408 if ((final_content_type
= getenv("FINAL_CONTENT_TYPE")) == NULL
)
410 final_content_type
= content_type
;
412 if (!strncmp(final_content_type
, "printer/", 8))
413 final_content_type
= "application/vnd.cups-raw";
417 * Extract the hostname and printer name from the URI...
420 httpSeparateURI(HTTP_URI_CODING_ALL
, device_uri
, scheme
, sizeof(scheme
),
421 username
, sizeof(username
), hostname
, sizeof(hostname
), &port
,
422 resource
, sizeof(resource
));
425 port
= IPP_PORT
; /* Default to port 631 */
427 if (!strcmp(scheme
, "https") || !strcmp(scheme
, "ipps"))
428 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
430 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
433 * See if there are any options...
440 contimeout
= 7 * 24 * 60 * 60;
442 if ((optptr
= strchr(resource
, '?')) != NULL
)
445 * Yup, terminate the device name string and move to the first
446 * character of the optptr...
452 * Then parse the optptr...
463 while (*optptr
&& *optptr
!= '=' && *optptr
!= '+' && *optptr
!= '&')
466 if ((sep
= *optptr
) != '\0')
477 while (*optptr
&& *optptr
!= '+' && *optptr
!= '&')
487 * Process the option...
490 if (!_cups_strcasecmp(name
, "waitjob"))
493 * Wait for job completion?
496 waitjob
= !_cups_strcasecmp(value
, "on") ||
497 !_cups_strcasecmp(value
, "yes") ||
498 !_cups_strcasecmp(value
, "true");
500 else if (!_cups_strcasecmp(name
, "waitprinter"))
503 * Wait for printer idle?
506 waitprinter
= !_cups_strcasecmp(value
, "on") ||
507 !_cups_strcasecmp(value
, "yes") ||
508 !_cups_strcasecmp(value
, "true");
510 else if (!_cups_strcasecmp(name
, "encryption"))
513 * Enable/disable encryption?
516 if (!_cups_strcasecmp(value
, "always"))
517 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
518 else if (!_cups_strcasecmp(value
, "required"))
519 cupsSetEncryption(HTTP_ENCRYPT_REQUIRED
);
520 else if (!_cups_strcasecmp(value
, "never"))
521 cupsSetEncryption(HTTP_ENCRYPT_NEVER
);
522 else if (!_cups_strcasecmp(value
, "ifrequested"))
523 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
526 _cupsLangPrintFilter(stderr
, "ERROR",
527 _("Unknown encryption option value: \"%s\"."),
531 else if (!_cups_strcasecmp(name
, "snmp"))
534 * Enable/disable SNMP stuff...
537 snmp_enabled
= !value
[0] || !_cups_strcasecmp(value
, "on") ||
538 !_cups_strcasecmp(value
, "yes") ||
539 !_cups_strcasecmp(value
, "true");
541 else if (!_cups_strcasecmp(name
, "version"))
543 if (!strcmp(value
, "1.0"))
545 else if (!strcmp(value
, "1.1"))
547 else if (!strcmp(value
, "2.0"))
549 else if (!strcmp(value
, "2.1"))
551 else if (!strcmp(value
, "2.2"))
555 _cupsLangPrintFilter(stderr
, "ERROR",
556 _("Unknown version option value: \"%s\"."),
561 else if (!_cups_strcasecmp(name
, "compression"))
563 if (!_cups_strcasecmp(value
, "true") || !_cups_strcasecmp(value
, "yes") ||
564 !_cups_strcasecmp(value
, "on") || !_cups_strcasecmp(value
, "gzip"))
565 compression
= "gzip";
566 else if (!_cups_strcasecmp(value
, "deflate"))
567 compression
= "deflate";
568 else if (!_cups_strcasecmp(value
, "false") ||
569 !_cups_strcasecmp(value
, "no") ||
570 !_cups_strcasecmp(value
, "off") ||
571 !_cups_strcasecmp(value
, "none"))
572 compression
= "none";
574 #endif /* HAVE_LIBZ */
575 else if (!_cups_strcasecmp(name
, "contimeout"))
578 * Set the connection timeout...
582 contimeout
= atoi(value
);
590 _cupsLangPrintFilter(stderr
, "ERROR",
591 _("Unknown option \"%s\" with value \"%s\"."),
598 * If we have 7 arguments, print the file named on the command-line.
599 * Otherwise, copy stdin to a temporary file and print the temporary
607 send_options
= !_cups_strcasecmp(final_content_type
, "application/pdf") ||
608 !_cups_strcasecmp(final_content_type
, "application/vnd.cups-pdf") ||
609 !_cups_strncasecmp(final_content_type
, "image/", 6);
611 fputs("DEBUG: Sending stdin for job...\n", stderr
);
616 * Point to the files on the command-line...
619 num_files
= argc
- 6;
623 fprintf(stderr
, "DEBUG: %d files to send in job...\n", num_files
);
627 * Set the authentication info, if any...
630 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
635 * Use authentication information in the device URI...
638 if ((password
= strchr(username
, ':')) != NULL
)
641 cupsSetUser(username
);
647 * Try loading authentication information from the environment.
650 const char *ptr
= getenv("AUTH_USERNAME");
654 strlcpy(username
, ptr
, sizeof(username
));
658 password
= getenv("AUTH_PASSWORD");
662 * Try finding the remote server...
665 start_time
= time(NULL
);
667 sprintf(portname
, "%d", port
);
669 update_reasons(NULL
, "+connecting-to-device");
670 fprintf(stderr
, "DEBUG: Looking up \"%s\"...\n", hostname
);
672 while ((addrlist
= httpAddrGetList(hostname
, AF_UNSPEC
, portname
)) == NULL
)
674 _cupsLangPrintFilter(stderr
, "INFO",
675 _("Unable to locate printer \"%s\"."), hostname
);
678 if (getenv("CLASS") != NULL
)
680 update_reasons(NULL
, "-connecting-to-device");
681 return (CUPS_BACKEND_STOP
);
685 return (CUPS_BACKEND_OK
);
688 http
= httpConnect2(hostname
, port
, addrlist
, AF_UNSPEC
, cupsEncryption(), 1,
690 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
693 * See if the printer supports SNMP...
697 snmp_fd
= _cupsSNMPOpen(addrlist
->addr
.addr
.sa_family
);
702 have_supplies
= !backendSNMPSupplies(snmp_fd
, &(addrlist
->addr
),
705 have_supplies
= start_count
= 0;
708 * Wait for data from the filter...
713 if (!backendWaitLoop(snmp_fd
, &(addrlist
->addr
), 0, backendNetworkSideCB
))
714 return (CUPS_BACKEND_OK
);
715 else if ((bytes
= read(0, buffer
, sizeof(buffer
))) <= 0)
716 return (CUPS_BACKEND_OK
);
720 * Try connecting to the remote server...
723 delay
= _cupsNextDelay(0, &prev_delay
);
727 fprintf(stderr
, "DEBUG: Connecting to %s:%d\n", hostname
, port
);
728 _cupsLangPrintFilter(stderr
, "INFO", _("Connecting to printer."));
730 if (httpReconnect(http
))
732 int error
= errno
; /* Connection error */
734 if (http
->status
== HTTP_PKI_ERROR
)
735 update_reasons(NULL
, "+cups-certificate-error");
740 if (getenv("CLASS") != NULL
)
743 * If the CLASS environment variable is set, the job was submitted
744 * to a class and not to a specific queue. In this case, we want
745 * to abort immediately so that the job can be requeued on the next
746 * available printer in the class.
749 _cupsLangPrintFilter(stderr
, "INFO",
750 _("Unable to contact printer, queuing on next "
751 "printer in class."));
754 * Sleep 5 seconds to keep the job from requeuing too rapidly...
759 update_reasons(NULL
, "-connecting-to-device");
761 return (CUPS_BACKEND_FAILED
);
764 fprintf(stderr
, "DEBUG: Connection error: %s\n", strerror(errno
));
766 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
||
767 errno
== EHOSTUNREACH
)
769 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
771 _cupsLangPrintFilter(stderr
, "ERROR",
772 _("The printer is not responding."));
773 update_reasons(NULL
, "-connecting-to-device");
774 return (CUPS_BACKEND_FAILED
);
780 _cupsLangPrintFilter(stderr
, "WARNING",
781 _("The printer may not exist or "
782 "is unavailable at this time."));
786 _cupsLangPrintFilter(stderr
, "WARNING",
787 _("The printer is unreachable at this "
793 _cupsLangPrintFilter(stderr
, "WARNING",
794 _("The printer is in use."));
798 sleep((unsigned)delay
);
800 delay
= _cupsNextDelay(delay
, &prev_delay
);
804 _cupsLangPrintFilter(stderr
, "ERROR",
805 _("The printer is not responding."));
813 update_reasons(NULL
, "-cups-certificate-error");
815 while (http
->fd
< 0);
818 return (CUPS_BACKEND_OK
);
820 return (CUPS_BACKEND_FAILED
);
822 if (httpIsEncrypted(http
))
825 * Validate TLS credentials...
828 cups_array_t
*creds
; /* TLS credentials */
829 cups_array_t
*lcreds
= NULL
; /* Loaded credentials */
830 http_trust_t trust
; /* Trust level */
831 char credinfo
[1024], /* Information on credentials */
832 lcredinfo
[1024];/* Information on saved credentials */
833 static const char * const trusts
[] = { NULL
, "+cups-pki-invalid", "+cups-pki-changed", "+cups-pki-expired", NULL
, "+cups-pki-unknown" };
835 static const char * const trust_msgs
[] =
837 "Credentials are OK/trusted",
838 "Credentials are invalid",
839 "Credentials have changed",
840 "Credentials are expired",
841 "Credentials have been renewed",
842 "Credentials are unknown/new"
845 fputs("DEBUG: Connection is encrypted.\n", stderr
);
847 if (!httpCopyCredentials(http
, &creds
))
849 trust
= httpCredentialsGetTrust(creds
, hostname
);
850 httpCredentialsString(creds
, credinfo
, sizeof(credinfo
));
852 fprintf(stderr
, "DEBUG: %s (%s)\n", trust_msgs
[trust
], cupsLastErrorString());
853 fprintf(stderr
, "DEBUG: Printer credentials: %s\n", credinfo
);
855 if (!httpLoadCredentials(NULL
, &lcreds
, hostname
))
857 httpCredentialsString(lcreds
, lcredinfo
, sizeof(lcredinfo
));
858 fprintf(stderr
, "DEBUG: Stored credentials: %s\n", lcredinfo
);
861 fputs("DEBUG: No stored credentials.\n", stderr
);
863 update_reasons(NULL
, "-cups-pki-invalid,cups-pki-changed,cups-pki-expired,cups-pki-unknown");
866 update_reasons(NULL
, trusts
[trust
]);
867 return (CUPS_BACKEND_STOP
);
873 * Could not load the credentials, let's save the ones we have so we
874 * can detect changes...
877 httpSaveCredentials(NULL
, creds
, hostname
);
880 httpFreeCredentials(lcreds
);
881 httpFreeCredentials(creds
);
885 fputs("DEBUG: No printer credentials.\n", stderr
);
887 update_reasons(NULL
, "cups-pki-unknown");
888 return (CUPS_BACKEND_STOP
);
892 update_reasons(NULL
, "-connecting-to-device");
893 _cupsLangPrintFilter(stderr
, "INFO", _("Connected to printer."));
895 fprintf(stderr
, "DEBUG: Connected to %s:%d...\n",
896 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
897 httpAddrPort(http
->hostaddr
));
900 * Build a URI for the printer and fill the standard IPP attributes for
901 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
902 * might contain username:password information...
905 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), scheme
, NULL
, hostname
,
909 * First validate the destination and see if the device supports multiple
914 compression_sup
= NULL
;
915 #endif /* HAVE_LIBZ */
918 encryption_sup
= NULL
;
920 media_col_sup
= NULL
;
922 operations_sup
= NULL
;
923 doc_handling_sup
= NULL
;
924 print_color_mode_sup
= NULL
;
929 * Check for side-channel requests...
932 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
935 * Build the IPP request...
938 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
939 ippSetVersion(request
, version
/ 10, version
% 10);
940 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
943 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
944 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
951 fputs("DEBUG: Getting supported attributes...\n", stderr
);
953 if (http
->version
< HTTP_1_1
)
955 fprintf(stderr
, "DEBUG: Printer responded with HTTP version %d.%d.\n",
956 http
->version
/ 100, http
->version
% 100);
957 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
958 "cups-ipp-wrong-http-version");
961 supported
= cupsDoRequest(http
, request
, resource
);
962 ipp_status
= cupsLastError();
964 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
965 ippErrorString(ipp_status
), cupsLastErrorString());
967 if (ipp_status
<= IPP_OK_CONFLICT
)
971 fprintf(stderr
, "DEBUG: Get-Printer-Attributes returned %s.\n",
972 ippErrorString(ipp_status
));
974 if (ipp_status
== IPP_PRINTER_BUSY
||
975 ipp_status
== IPP_SERVICE_UNAVAILABLE
)
977 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
979 _cupsLangPrintFilter(stderr
, "ERROR",
980 _("The printer is not responding."));
981 return (CUPS_BACKEND_FAILED
);
984 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
986 report_printer_state(supported
);
988 sleep((unsigned)delay
);
990 delay
= _cupsNextDelay(delay
, &prev_delay
);
992 else if ((ipp_status
== IPP_BAD_REQUEST
||
993 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
> 10)
996 * Switch to IPP/1.1 or IPP/1.0...
1001 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
1003 "DEBUG: The printer does not support IPP/%d.%d, trying "
1004 "IPP/1.1.\n", version
/ 10, version
% 10);
1009 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
1011 "DEBUG: The printer does not support IPP/%d.%d, trying "
1012 "IPP/1.0.\n", version
/ 10, version
% 10);
1016 httpReconnect(http
);
1018 else if (ipp_status
== IPP_NOT_FOUND
)
1020 _cupsLangPrintFilter(stderr
, "ERROR",
1021 _("The printer configuration is incorrect or the "
1022 "printer no longer exists."));
1024 ippDelete(supported
);
1026 return (CUPS_BACKEND_STOP
);
1028 else if (ipp_status
== IPP_FORBIDDEN
||
1029 ipp_status
== IPP_AUTHENTICATION_CANCELED
)
1031 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1032 /* WWW-Authenticate field value */
1034 if (!strncmp(www_auth
, "Negotiate", 9))
1035 auth_info_required
= "negotiate";
1036 else if (www_auth
[0])
1037 auth_info_required
= "username,password";
1039 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
1040 return (CUPS_BACKEND_AUTH_REQUIRED
);
1042 else if (ipp_status
!= IPP_NOT_AUTHORIZED
)
1044 _cupsLangPrintFilter(stderr
, "ERROR",
1045 _("Unable to get printer status."));
1048 httpReconnect(http
);
1051 ippDelete(supported
);
1056 if (!getenv("CLASS"))
1059 * Check printer-is-accepting-jobs = false and printer-state-reasons for the
1060 * "spool-area-full" keyword...
1065 if ((printer_accepting
= ippFindAttribute(supported
,
1066 "printer-is-accepting-jobs",
1067 IPP_TAG_BOOLEAN
)) != NULL
&&
1068 !printer_accepting
->values
[0].boolean
)
1070 else if (!printer_accepting
)
1071 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1072 "cups-ipp-missing-printer-is-accepting-jobs");
1074 if ((printer_state
= ippFindAttribute(supported
,
1075 "printer-state-reasons",
1076 IPP_TAG_KEYWORD
)) == NULL
)
1078 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1079 "cups-ipp-missing-printer-state-reasons");
1083 for (i
= 0; i
< printer_state
->num_values
; i
++)
1085 if (!strcmp(printer_state
->values
[0].string
.text
,
1086 "spool-area-full") ||
1087 !strncmp(printer_state
->values
[0].string
.text
, "spool-area-full-",
1098 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1100 report_printer_state(supported
);
1102 sleep((unsigned)delay
);
1104 delay
= _cupsNextDelay(delay
, &prev_delay
);
1106 ippDelete(supported
);
1108 ipp_status
= IPP_STATUS_ERROR_BUSY
;
1114 * Check for supported attributes...
1118 if ((compression_sup
= ippFindAttribute(supported
, "compression-supported",
1119 IPP_TAG_KEYWORD
)) != NULL
)
1122 * Check whether the requested compression is supported and/or default to
1123 * compression if supported...
1126 if (compression
&& !ippContainsString(compression_sup
, compression
))
1128 fprintf(stderr
, "DEBUG: Printer does not support the requested "
1129 "compression value \"%s\".\n", compression
);
1132 else if (!compression
&& (!strcmp(final_content_type
, "image/pwg-raster") || !strcmp(final_content_type
, "image/urf")))
1134 if (ippContainsString(compression_sup
, "gzip"))
1135 compression
= "gzip";
1136 else if (ippContainsString(compression_sup
, "deflate"))
1137 compression
= "deflate";
1140 fprintf(stderr
, "DEBUG: Automatically using \"%s\" compression.\n",
1144 #endif /* HAVE_LIBZ */
1146 if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
1147 IPP_TAG_RANGE
)) != NULL
)
1150 * Has the "copies-supported" attribute - does it have an upper
1154 fprintf(stderr
, "DEBUG: copies-supported=%d-%d\n",
1155 copies_sup
->values
[0].range
.lower
,
1156 copies_sup
->values
[0].range
.upper
);
1158 if (copies_sup
->values
[0].range
.upper
<= 1)
1159 copies_sup
= NULL
; /* No */
1162 cups_version
= ippFindAttribute(supported
, "cups-version", IPP_TAG_TEXT
);
1164 encryption_sup
= ippFindAttribute(supported
, "job-password-encryption-supported", IPP_TAG_KEYWORD
);
1166 if ((format_sup
= ippFindAttribute(supported
, "document-format-supported",
1167 IPP_TAG_MIMETYPE
)) != NULL
)
1169 fprintf(stderr
, "DEBUG: document-format-supported (%d values)\n",
1170 format_sup
->num_values
);
1171 for (i
= 0; i
< format_sup
->num_values
; i
++)
1172 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1173 format_sup
->values
[i
].string
.text
);
1176 if ((media_col_sup
= ippFindAttribute(supported
, "media-col-supported",
1177 IPP_TAG_KEYWORD
)) != NULL
)
1179 fprintf(stderr
, "DEBUG: media-col-supported (%d values)\n",
1180 media_col_sup
->num_values
);
1181 for (i
= 0; i
< media_col_sup
->num_values
; i
++)
1182 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1183 media_col_sup
->values
[i
].string
.text
);
1186 print_color_mode_sup
= ippFindAttribute(supported
, "print-color-mode-supported", IPP_TAG_KEYWORD
);
1188 if ((operations_sup
= ippFindAttribute(supported
, "operations-supported",
1189 IPP_TAG_ENUM
)) != NULL
)
1191 fprintf(stderr
, "DEBUG: operations-supported (%d values)\n",
1192 operations_sup
->num_values
);
1193 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1194 fprintf(stderr
, "DEBUG: [%d] = %s\n", i
,
1195 ippOpString(operations_sup
->values
[i
].integer
));
1197 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1198 if (operations_sup
->values
[i
].integer
== IPP_PRINT_JOB
)
1201 if (i
>= operations_sup
->num_values
)
1202 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1203 "cups-ipp-missing-print-job");
1205 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1206 if (operations_sup
->values
[i
].integer
== IPP_CANCEL_JOB
)
1209 if (i
>= operations_sup
->num_values
)
1210 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1211 "cups-ipp-missing-cancel-job");
1213 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1214 if (operations_sup
->values
[i
].integer
== IPP_GET_JOB_ATTRIBUTES
)
1217 if (i
>= operations_sup
->num_values
)
1218 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1219 "cups-ipp-missing-get-job-attributes");
1221 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1222 if (operations_sup
->values
[i
].integer
== IPP_GET_PRINTER_ATTRIBUTES
)
1225 if (i
>= operations_sup
->num_values
)
1226 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1227 "cups-ipp-missing-get-printer-attributes");
1229 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1231 if (operations_sup
->values
[i
].integer
== IPP_VALIDATE_JOB
)
1233 else if (operations_sup
->values
[i
].integer
== IPP_CREATE_JOB
)
1235 else if (operations_sup
->values
[i
].integer
== IPP_SEND_DOCUMENT
)
1237 else if (operations_sup
->values
[i
].integer
== IPP_GET_JOB_ATTRIBUTES
)
1241 if (create_job
&& !send_document
)
1243 fputs("DEBUG: Printer supports Create-Job but not Send-Document.\n",
1247 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1248 "cups-ipp-missing-send-document");
1252 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1253 "cups-ipp-missing-validate-job");
1256 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1257 "cups-ipp-missing-operations-supported");
1259 doc_handling_sup
= ippFindAttribute(supported
,
1260 "multiple-document-handling-supported",
1263 report_printer_state(supported
);
1265 while (!job_canceled
&& ipp_status
> IPP_OK_CONFLICT
);
1268 return (CUPS_BACKEND_OK
);
1271 * See if the printer is accepting jobs and is not stopped; if either
1272 * condition is true and we are printing to a class, requeue the job...
1275 if (getenv("CLASS") != NULL
)
1277 printer_state
= ippFindAttribute(supported
, "printer-state",
1279 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
1282 if (printer_state
== NULL
||
1283 (printer_state
->values
[0].integer
> IPP_PRINTER_PROCESSING
&&
1285 printer_accepting
== NULL
||
1286 !printer_accepting
->values
[0].boolean
)
1289 * If the CLASS environment variable is set, the job was submitted
1290 * to a class and not to a specific queue. In this case, we want
1291 * to abort immediately so that the job can be requeued on the next
1292 * available printer in the class.
1295 _cupsLangPrintFilter(stderr
, "INFO",
1296 _("Unable to contact printer, queuing on next "
1297 "printer in class."));
1299 ippDelete(supported
);
1303 * Sleep 5 seconds to keep the job from requeuing too rapidly...
1308 return (CUPS_BACKEND_FAILED
);
1313 * See if the printer supports multiple copies...
1316 copies
= atoi(argv
[4]);
1318 if (copies_sup
|| argc
< 7)
1319 copies_remaining
= 1;
1321 copies_remaining
= copies
;
1324 * Prepare remaining printing options...
1331 num_options
= cupsParseOptions(argv
[5], 0, &options
);
1333 if (!cups_version
&& media_col_sup
)
1336 * Load the PPD file and generate PWG attribute mapping information...
1339 ppd_attr_t
*mandatory
; /* cupsMandatory value */
1341 ppd
= ppdOpenFile(getenv("PPD"));
1342 pc
= _ppdCacheCreateWithPPD(ppd
);
1344 ppdMarkDefaults(ppd
);
1345 cupsMarkOptions(ppd
, num_options
, options
);
1347 if ((mandatory
= ppdFindAttr(ppd
, "cupsMandatory", NULL
)) != NULL
)
1348 strlcpy(mandatory_attrs
, mandatory
->value
, sizeof(mandatory_attrs
));
1352 * Validate job-password/-encryption...
1355 if (cupsGetOption("job-password", num_options
, options
))
1357 const char *keyword
; /* job-password-encryption value */
1358 static const char * const hashes
[] =
1359 { /* List of supported hash algorithms, in order of preference */
1370 if ((keyword
= cupsGetOption("job-password-encryption", num_options
, options
)) == NULL
|| !ippContainsString(encryption_sup
, keyword
))
1373 * Either no job-password-encryption or the value isn't supported by
1377 for (i
= 0; i
< (int)(sizeof(hashes
) / sizeof(hashes
[0])); i
++)
1378 if (ippContainsString(encryption_sup
, hashes
[i
]))
1381 if (i
< (int)(sizeof(hashes
) / sizeof(hashes
[0])))
1382 num_options
= cupsAddOption("job-password-encryption", hashes
[i
], num_options
, &options
);
1389 document_format
= NULL
;
1391 if (format_sup
!= NULL
)
1393 if (ippContainsString(format_sup
, final_content_type
))
1394 document_format
= final_content_type
;
1395 else if (ippContainsString(format_sup
, "application/octet-stream"))
1396 document_format
= "application/octet-stream";
1399 fprintf(stderr
, "DEBUG: final_content_type=\"%s\", document_format=\"%s\"\n",
1400 final_content_type
, document_format
? document_format
: "(null)");
1403 * If the printer does not support HTTP/1.1 (which IPP requires), copy stdin
1404 * to a temporary file so that we can do a HTTP/1.0 submission...
1406 * (I hate compatibility hacks!)
1409 if (http
->version
< HTTP_1_1
&& num_files
== 0)
1411 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
1413 perror("DEBUG: Unable to create temporary file");
1414 return (CUPS_BACKEND_FAILED
);
1417 _cupsLangPrintFilter(stderr
, "INFO", _("Copying print data."));
1419 if ((compatsize
= write(fd
, buffer
, (size_t)bytes
)) < 0)
1421 perror("DEBUG: Unable to write temporary file");
1422 return (CUPS_BACKEND_FAILED
);
1425 if ((bytes
= backendRunLoop(-1, fd
, snmp_fd
, &(addrlist
->addr
), 0, 0,
1426 backendNetworkSideCB
)) < 0)
1427 return (CUPS_BACKEND_FAILED
);
1429 compatsize
+= bytes
;
1433 compatfile
= tmpfilename
;
1434 files
= &compatfile
;
1437 else if (http
->version
< HTTP_1_1
&& num_files
== 1)
1439 struct stat fileinfo
; /* File information */
1441 if (!stat(files
[0], &fileinfo
))
1442 compatsize
= fileinfo
.st_size
;
1446 * If the printer only claims to support IPP/1.0, or if the user specifically
1447 * included version=1.0 in the URI, then do not try to use Create-Job or
1448 * Send-Document. This is another dreaded compatibility hack, but
1449 * unfortunately there are enough broken printers out there that we need
1454 create_job
= send_document
= 0;
1457 * Start monitoring the printer in the background...
1461 monitor
.hostname
= hostname
;
1462 monitor
.user
= argv
[2];
1463 monitor
.resource
= resource
;
1464 monitor
.port
= port
;
1465 monitor
.version
= version
;
1467 monitor
.create_job
= create_job
;
1468 monitor
.get_job_attrs
= get_job_attrs
;
1469 monitor
.encryption
= cupsEncryption();
1470 monitor
.job_state
= IPP_JOB_PENDING
;
1471 monitor
.printer_state
= IPP_PRINTER_IDLE
;
1475 monitor
.job_name
= argv
[3];
1479 snprintf(print_job_name
, sizeof(print_job_name
), "%s - %s", argv
[1],
1481 monitor
.job_name
= print_job_name
;
1484 _cupsThreadCreate((_cups_thread_func_t
)monitor_printer
, &monitor
);
1487 * Validate access to the printer...
1490 while (!job_canceled
&& validate_job
)
1492 request
= new_request(IPP_VALIDATE_JOB
, version
, uri
, argv
[2],
1493 monitor
.job_name
, num_options
, options
, compression
,
1494 copies_sup
? copies
: 1, document_format
, pc
, ppd
,
1495 media_col_sup
, doc_handling_sup
, print_color_mode_sup
);
1497 response
= cupsDoRequest(http
, request
, resource
);
1499 ipp_status
= cupsLastError();
1501 fprintf(stderr
, "DEBUG: Validate-Job: %s (%s)\n",
1502 ippErrorString(ipp_status
), cupsLastErrorString());
1503 debug_attributes(response
);
1505 if ((job_auth
= ippFindAttribute(response
, "job-authorization-uri",
1506 IPP_TAG_URI
)) != NULL
)
1507 num_options
= cupsAddOption("job-authorization-uri",
1508 ippGetString(job_auth
, 0, NULL
), num_options
,
1511 ippDelete(response
);
1516 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1517 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1519 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1522 else if (ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
||
1523 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1524 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1525 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1526 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1527 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1529 else if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1530 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1531 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1533 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1534 /* WWW-Authenticate field value */
1536 if (!strncmp(www_auth
, "Negotiate", 9))
1537 auth_info_required
= "negotiate";
1538 else if (www_auth
[0])
1539 auth_info_required
= "username,password";
1543 else if (ipp_status
== IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
)
1546 * This is all too common...
1549 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1550 "cups-ipp-missing-validate-job");
1553 else if (ipp_status
< IPP_REDIRECTION_OTHER_SITE
||
1554 ipp_status
== IPP_BAD_REQUEST
)
1559 * Then issue the print-job request...
1564 while (!job_canceled
&& copies_remaining
> 0)
1567 * Check for side-channel requests...
1570 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1573 * Build the IPP job creation request...
1579 request
= new_request((num_files
> 1 || create_job
) ? IPP_CREATE_JOB
:
1581 version
, uri
, argv
[2], monitor
.job_name
, num_options
,
1582 options
, compression
, copies_sup
? copies
: 1,
1583 document_format
, pc
, ppd
, media_col_sup
,
1584 doc_handling_sup
, print_color_mode_sup
);
1590 if (num_files
> 1 || create_job
)
1591 response
= cupsDoRequest(http
, request
, resource
);
1594 size_t length
= 0; /* Length of request */
1598 fputs("DEBUG: Sending file using HTTP/1.0 Content-Length...\n", stderr
);
1599 length
= ippLength(request
) + (size_t)compatsize
;
1602 fputs("DEBUG: Sending file using HTTP/1.1 chunking...\n", stderr
);
1604 http_status
= cupsSendRequest(http
, request
, resource
, length
);
1605 if (http_status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
)
1607 if (compression
&& strcmp(compression
, "none"))
1608 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1612 if ((fd
= open(files
[0], O_RDONLY
)) < 0)
1614 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1615 return (CUPS_BACKEND_FAILED
);
1621 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1624 while (http_status
== HTTP_CONTINUE
&&
1625 (!job_canceled
|| compatsize
> 0))
1628 * Check for side-channel requests and more print data...
1633 FD_SET(snmp_fd
, &input
);
1634 FD_SET(CUPS_SC_FD
, &input
);
1636 while (select(fd
> snmp_fd
? fd
+ 1 : snmp_fd
+ 1, &input
, NULL
, NULL
,
1637 NULL
) <= 0 && !job_canceled
);
1639 if (FD_ISSET(snmp_fd
, &input
))
1640 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1642 if (FD_ISSET(fd
, &input
))
1644 if ((bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1646 fprintf(stderr
, "DEBUG: Read %d bytes...\n", (int)bytes
);
1648 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1652 else if (bytes
== 0 || (errno
!= EINTR
&& errno
!= EAGAIN
))
1657 if (http_status
== HTTP_ERROR
)
1658 fprintf(stderr
, "DEBUG: Error writing document data for "
1659 "Print-Job: %s\n", strerror(httpError(http
)));
1665 response
= cupsGetResponse(http
, resource
);
1669 ipp_status
= cupsLastError();
1671 fprintf(stderr
, "DEBUG: %s: %s (%s)\n",
1672 (num_files
> 1 || create_job
) ? "Create-Job" : "Print-Job",
1673 ippErrorString(ipp_status
), cupsLastErrorString());
1674 debug_attributes(response
);
1676 if (ipp_status
> IPP_OK_CONFLICT
)
1683 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1684 ipp_status
== IPP_STATUS_ERROR_NOT_POSSIBLE
||
1685 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1687 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1693 * We can't re-submit when we have no files to print, so exit
1694 * immediately with the right status code...
1700 else if (ipp_status
== IPP_STATUS_ERROR_JOB_CANCELED
||
1701 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1702 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1703 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1704 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1705 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1706 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1711 * Update auth-info-required as needed...
1714 _cupsLangPrintFilter(stderr
, "ERROR",
1715 _("Print job was not accepted."));
1717 if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1718 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1720 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1721 /* WWW-Authenticate field value */
1723 if (!strncmp(www_auth
, "Negotiate", 9))
1724 auth_info_required
= "negotiate";
1725 else if (www_auth
[0])
1726 auth_info_required
= "username,password";
1728 else if (ipp_status
== IPP_REQUEST_VALUE
)
1731 * Print file is too large, abort this job...
1742 * We can't re-submit when we have no files to print, so exit
1743 * immediately with the right status code...
1750 else if ((job_id_attr
= ippFindAttribute(response
, "job-id",
1751 IPP_TAG_INTEGER
)) == NULL
)
1753 fputs("DEBUG: Print job accepted - job ID unknown.\n", stderr
);
1754 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1755 "cups-ipp-missing-job-id");
1761 monitor
.job_id
= job_id
= job_id_attr
->values
[0].integer
;
1762 fprintf(stderr
, "DEBUG: Print job accepted - job ID %d.\n", job_id
);
1765 ippDelete(response
);
1770 if (job_id
&& (num_files
> 1 || create_job
))
1772 for (i
= 0; num_files
== 0 || i
< num_files
; i
++)
1775 * Check for side-channel requests...
1778 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1781 * Send the next file in the job...
1784 request
= ippNewRequest(IPP_SEND_DOCUMENT
);
1785 ippSetVersion(request
, version
/ 10, version
% 10);
1787 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1790 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1794 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1795 "requesting-user-name", NULL
, argv
[2]);
1797 ippAddBoolean(request
, IPP_TAG_OPERATION
, "last-document",
1798 (i
+ 1) >= num_files
);
1800 if (document_format
)
1801 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
1802 "document-format", NULL
, document_format
);
1805 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1806 "compression", NULL
, compression
);
1808 fprintf(stderr
, "DEBUG: Sending file %d using chunking...\n", i
+ 1);
1809 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
1810 debug_attributes(request
);
1812 http_status
= cupsSendRequest(http
, request
, resource
, 0);
1813 if (http_status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
)
1815 if (compression
&& strcmp(compression
, "none"))
1816 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1821 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1825 if ((fd
= open(files
[i
], O_RDONLY
)) < 0)
1827 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1828 return (CUPS_BACKEND_FAILED
);
1837 while (!job_canceled
&& http_status
== HTTP_CONTINUE
&&
1838 (bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1840 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1846 * Check for side-channel requests...
1849 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1857 if (http_status
== HTTP_ERROR
)
1858 fprintf(stderr
, "DEBUG: Error writing document data for "
1859 "Send-Document: %s\n", strerror(httpError(http
)));
1861 response
= cupsGetResponse(http
, resource
);
1864 fprintf(stderr
, "DEBUG: Send-Document: %s (%s)\n",
1865 ippErrorString(cupsLastError()), cupsLastErrorString());
1866 debug_attributes(response
);
1867 ippDelete(response
);
1869 if (cupsLastError() > IPP_OK_CONFLICT
&& !job_canceled
)
1871 ipp_status
= cupsLastError();
1873 _cupsLangPrintFilter(stderr
, "ERROR",
1874 _("Unable to add document to print job."));
1881 if (num_files
== 0 || fd
< 0)
1890 if (ipp_status
<= IPP_OK_CONFLICT
&& argc
> 6)
1892 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
1893 copies_remaining
--;
1895 else if ((ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
|| ipp_status
== IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
) &&
1897 document_format
&& strcmp(document_format
, "image/pwg-raster") && strcmp(document_format
, "image/urf"))
1900 * Need to reprocess the job as raster...
1903 fputs("JOBSTATE: cups-retry-as-raster\n", stderr
);
1905 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1909 else if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
1910 ipp_status
== IPP_NOT_POSSIBLE
||
1911 ipp_status
== IPP_PRINTER_BUSY
)
1916 * Need to reprocess the entire job; if we have a job ID, cancel the
1921 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1927 else if (ipp_status
== IPP_REQUEST_VALUE
||
1928 ipp_status
== IPP_ERROR_JOB_CANCELED
||
1929 ipp_status
== IPP_NOT_AUTHORIZED
||
1930 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1931 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1932 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1933 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
||
1934 ipp_status
== IPP_INTERNAL_ERROR
)
1937 * Print file is too large, job was canceled, we need new
1938 * authentication data, or we had some sort of error...
1943 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
)
1946 * Server is configured incorrectly; the policy for Create-Job and
1947 * Send-Document has to be the same (auth or no auth, encryption or
1948 * no encryption). Force the queue to stop since printing will never
1952 fputs("DEBUG: The server or printer is configured incorrectly.\n",
1954 fputs("DEBUG: The policy for Create-Job and Send-Document must have the "
1955 "same authentication and encryption requirements.\n", stderr
);
1957 ipp_status
= IPP_STATUS_ERROR_INTERNAL
;
1960 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1964 else if (ipp_status
== IPP_NOT_FOUND
)
1967 * Printer does not actually implement support for Create-Job/
1968 * Send-Document, so log the conformance issue and stop the printer.
1971 fputs("DEBUG: This printer claims to support Create-Job and "
1972 "Send-Document, but those operations failed.\n", stderr
);
1973 fputs("DEBUG: Add '?version=1.0' to the device URI to use legacy "
1974 "compatibility mode.\n", stderr
);
1975 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1976 "cups-ipp-missing-send-document");
1978 ipp_status
= IPP_INTERNAL_ERROR
; /* Force queue to stop */
1983 copies_remaining
--;
1986 * Wait for the job to complete...
1989 if (!job_id
|| !waitjob
|| !get_job_attrs
)
1992 fputs("STATE: +cups-waiting-for-job-completed\n", stderr
);
1994 _cupsLangPrintFilter(stderr
, "INFO", _("Waiting for job to complete."));
1996 for (delay
= _cupsNextDelay(0, &prev_delay
), waittime
= time(NULL
) + 30; !job_canceled
;)
1999 * Check for side-channel requests...
2002 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
2005 * Check printer state...
2008 check_printer_state(http
, uri
, resource
, argv
[2], version
);
2010 if (cupsLastError() <= IPP_OK_CONFLICT
)
2014 * Build an IPP_GET_JOB_ATTRIBUTES request...
2017 request
= ippNewRequest(IPP_GET_JOB_ATTRIBUTES
);
2018 ippSetVersion(request
, version
/ 10, version
% 10);
2020 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2023 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2027 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2028 "requesting-user-name", NULL
, argv
[2]);
2030 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2031 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
2034 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2035 debug_attributes(request
);
2041 httpReconnect(http
);
2042 response
= cupsDoRequest(http
, request
, resource
);
2043 ipp_status
= cupsLastError();
2045 if (ipp_status
== IPP_NOT_FOUND
|| ipp_status
== IPP_NOT_POSSIBLE
)
2048 * Job has gone away and/or the server has no job history...
2051 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2052 "cups-ipp-missing-job-history");
2053 ippDelete(response
);
2055 ipp_status
= IPP_OK
;
2059 fprintf(stderr
, "DEBUG: Get-Job-Attributes: %s (%s)\n",
2060 ippErrorString(ipp_status
), cupsLastErrorString());
2061 debug_attributes(response
);
2063 if (ipp_status
<= IPP_OK_CONFLICT
)
2067 if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
2068 ipp_status
!= IPP_PRINTER_BUSY
)
2070 ippDelete(response
);
2071 ipp_status
= IPP_OK
;
2074 else if (ipp_status
== IPP_INTERNAL_ERROR
)
2078 if (waitjob_tries
> 4)
2080 ippDelete(response
);
2081 ipp_status
= IPP_OK
;
2089 if ((job_state
= ippFindAttribute(response
, "job-state",
2090 IPP_TAG_ENUM
)) != NULL
)
2093 * Reflect the remote job state in the local queue...
2097 job_state
->values
[0].integer
>= IPP_JOB_PENDING
&&
2098 job_state
->values
[0].integer
<= IPP_JOB_COMPLETED
)
2099 update_reasons(NULL
,
2100 remote_job_states
[job_state
->values
[0].integer
-
2103 if ((job_sheets
= ippFindAttribute(response
, "job-impressions-completed", IPP_TAG_INTEGER
)) == NULL
)
2104 job_sheets
= ippFindAttribute(response
, "job-media-sheets-completed", IPP_TAG_INTEGER
);
2107 fprintf(stderr
, "PAGE: total %d\n",
2108 job_sheets
->values
[0].integer
);
2111 * Stop polling if the job is finished or pending-held for 30 seconds...
2114 if (job_state
->values
[0].integer
> IPP_JSTATE_STOPPED
||
2115 (job_state
->values
[0].integer
== IPP_JSTATE_HELD
&& time(NULL
) > waittime
))
2117 ippDelete(response
);
2121 else if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
2122 ipp_status
!= IPP_NOT_POSSIBLE
&&
2123 ipp_status
!= IPP_PRINTER_BUSY
)
2126 * If the printer does not return a job-state attribute, it does not
2127 * conform to the IPP specification - break out immediately and fail
2131 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2132 "cups-ipp-missing-job-state");
2133 ipp_status
= IPP_INTERNAL_ERROR
;
2138 ippDelete(response
);
2141 * Wait before polling again...
2144 sleep((unsigned)delay
);
2146 delay
= _cupsNextDelay(delay
, &prev_delay
);
2151 * Cancel the job as needed...
2154 if (job_canceled
> 0 && job_id
> 0)
2156 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
2158 if (cupsLastError() > IPP_OK_CONFLICT
)
2159 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2163 * Check the printer state and report it if necessary...
2166 check_printer_state(http
, uri
, resource
, argv
[2], version
);
2168 if (cupsLastError() <= IPP_OK_CONFLICT
)
2172 * Collect the final page count as needed...
2175 if (have_supplies
&&
2176 !backendSNMPSupplies(snmp_fd
, &(http
->addrlist
->addr
), &page_count
,
2178 page_count
> start_count
)
2179 fprintf(stderr
, "PAGE: total %d\n", page_count
- start_count
);
2183 * See if we used Kerberos at all...
2187 auth_info_required
= "negotiate";
2188 #endif /* HAVE_GSSAPI */
2196 cupsFreeOptions(num_options
, options
);
2197 _ppdCacheDestroy(pc
);
2202 ippDelete(supported
);
2205 * Remove the temporary file(s) if necessary...
2209 unlink(tmpfilename
);
2212 * Return the queue status...
2215 if (ipp_status
== IPP_NOT_AUTHORIZED
|| ipp_status
== IPP_FORBIDDEN
||
2216 ipp_status
== IPP_AUTHENTICATION_CANCELED
||
2217 ipp_status
<= IPP_OK_CONFLICT
)
2218 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
2220 if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
)
2221 fputs("JOBSTATE: account-info-needed\n", stderr
);
2222 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
)
2223 fputs("JOBSTATE: account-closed\n", stderr
);
2224 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
)
2225 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2226 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2227 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2229 if (ipp_status
== IPP_NOT_AUTHORIZED
|| ipp_status
== IPP_FORBIDDEN
||
2230 ipp_status
== IPP_AUTHENTICATION_CANCELED
)
2231 return (CUPS_BACKEND_AUTH_REQUIRED
);
2232 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
2233 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
2234 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
2235 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2236 return (CUPS_BACKEND_HOLD
);
2237 else if (ipp_status
== IPP_INTERNAL_ERROR
)
2238 return (CUPS_BACKEND_STOP
);
2239 else if (ipp_status
== IPP_CONFLICT
)
2240 return (CUPS_BACKEND_FAILED
);
2241 else if (ipp_status
== IPP_REQUEST_VALUE
||
2242 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
2243 ipp_status
== IPP_DOCUMENT_FORMAT
|| job_canceled
< 0)
2245 if (ipp_status
== IPP_REQUEST_VALUE
)
2246 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job too large."));
2247 else if (ipp_status
== IPP_DOCUMENT_FORMAT
)
2248 _cupsLangPrintFilter(stderr
, "ERROR",
2249 _("Printer cannot print supplied content."));
2250 else if (ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
)
2251 _cupsLangPrintFilter(stderr
, "ERROR",
2252 _("Printer cannot print with supplied options."));
2254 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job canceled at printer."));
2256 return (CUPS_BACKEND_CANCEL
);
2258 else if (ipp_status
> IPP_OK_CONFLICT
&& ipp_status
!= IPP_ERROR_JOB_CANCELED
)
2259 return (CUPS_BACKEND_RETRY_CURRENT
);
2261 return (CUPS_BACKEND_OK
);
2266 * 'cancel_job()' - Cancel a print job.
2270 cancel_job(http_t
*http
, /* I - HTTP connection */
2271 const char *uri
, /* I - printer-uri */
2272 int id
, /* I - job-id */
2273 const char *resource
, /* I - Resource path */
2274 const char *user
, /* I - requesting-user-name */
2275 int version
) /* I - IPP version */
2277 ipp_t
*request
; /* Cancel-Job request */
2280 _cupsLangPrintFilter(stderr
, "INFO", _("Canceling print job."));
2282 request
= ippNewRequest(IPP_CANCEL_JOB
);
2283 ippSetVersion(request
, version
/ 10, version
% 10);
2285 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2287 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
2289 if (user
&& user
[0])
2290 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2291 "requesting-user-name", NULL
, user
);
2297 ippDelete(cupsDoRequest(http
, request
, resource
));
2302 * 'check_printer_state()' - Check the printer state.
2305 static ipp_pstate_t
/* O - Current printer-state */
2306 check_printer_state(
2307 http_t
*http
, /* I - HTTP connection */
2308 const char *uri
, /* I - Printer URI */
2309 const char *resource
, /* I - Resource path */
2310 const char *user
, /* I - Username, if any */
2311 int version
) /* I - IPP version */
2313 ipp_t
*request
, /* IPP request */
2314 *response
; /* IPP response */
2315 ipp_attribute_t
*attr
; /* Attribute in response */
2316 ipp_pstate_t printer_state
= IPP_PRINTER_STOPPED
;
2317 /* Current printer-state */
2321 * Send a Get-Printer-Attributes request and log the results...
2324 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
2325 ippSetVersion(request
, version
/ 10, version
% 10);
2327 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2330 if (user
&& user
[0])
2331 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2332 "requesting-user-name", NULL
, user
);
2334 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2335 "requested-attributes",
2336 (int)(sizeof(pattrs
) / sizeof(pattrs
[0])), NULL
, pattrs
);
2338 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2339 debug_attributes(request
);
2341 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
2343 report_printer_state(response
);
2345 if ((attr
= ippFindAttribute(response
, "printer-state",
2346 IPP_TAG_ENUM
)) != NULL
)
2347 printer_state
= (ipp_pstate_t
)attr
->values
[0].integer
;
2350 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
2351 ippErrorString(cupsLastError()), cupsLastErrorString());
2352 debug_attributes(response
);
2353 ippDelete(response
);
2356 * Return the printer-state value...
2359 return (printer_state
);
2364 * 'debug_attributes()' - Print out the request or response attributes as DEBUG
2369 debug_attributes(ipp_t
*ipp
) /* I - Request or response message */
2371 ipp_tag_t group
; /* Current group */
2372 ipp_attribute_t
*attr
; /* Current attribute */
2373 char buffer
[1024]; /* Value buffer */
2376 for (group
= IPP_TAG_ZERO
, attr
= ippFirstAttribute(ipp
);
2378 attr
= ippNextAttribute(ipp
))
2380 const char *name
= ippGetName(attr
);
2384 group
= IPP_TAG_ZERO
;
2388 if (group
!= ippGetGroupTag(attr
))
2390 group
= ippGetGroupTag(attr
);
2391 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(group
));
2394 if (!strcmp(name
, "job-password"))
2395 strlcpy(buffer
, "---", sizeof(buffer
));
2397 ippAttributeString(attr
, buffer
, sizeof(buffer
));
2399 fprintf(stderr
, "DEBUG: %s %s%s %s\n", name
,
2400 ippGetCount(attr
) > 1 ? "1setOf " : "",
2401 ippTagString(ippGetValueTag(attr
)), buffer
);
2404 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(IPP_TAG_END
));
2409 * 'monitor_printer()' - Monitor the printer state.
2412 static void * /* O - Thread exit code */
2414 _cups_monitor_t
*monitor
) /* I - Monitoring data */
2416 http_t
*http
; /* Connection to printer */
2417 ipp_t
*request
, /* IPP request */
2418 *response
; /* IPP response */
2419 ipp_attribute_t
*attr
; /* Attribute in response */
2420 int delay
, /* Current delay */
2421 prev_delay
; /* Previous delay */
2422 ipp_op_t job_op
; /* Operation to use */
2423 int job_id
; /* Job ID */
2424 const char *job_name
; /* Job name */
2425 ipp_jstate_t job_state
; /* Job state */
2426 const char *job_user
; /* Job originating user name */
2427 int password_tries
= 0; /* Password tries */
2431 * Make a copy of the printer connection...
2434 http
= httpConnect2(monitor
->hostname
, monitor
->port
, NULL
, AF_UNSPEC
,
2435 monitor
->encryption
, 1, 0, NULL
);
2436 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
2438 cupsSetUser(username
);
2440 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
2443 * Loop until the job is canceled, aborted, or completed.
2446 delay
= _cupsNextDelay(0, &prev_delay
);
2448 monitor
->job_reasons
= 0;
2450 while (monitor
->job_state
< IPP_JOB_CANCELED
&& !job_canceled
)
2453 * Reconnect to the printer...
2456 if (!httpReconnect(http
))
2459 * Connected, so check on the printer state...
2462 monitor
->printer_state
= check_printer_state(http
, monitor
->uri
,
2466 if (cupsLastError() <= IPP_OK_CONFLICT
)
2469 if (monitor
->job_id
== 0 && monitor
->create_job
)
2472 * No job-id yet, so continue...
2475 goto monitor_disconnect
;
2479 * Check the status of the job itself...
2482 job_op
= (monitor
->job_id
> 0 && monitor
->get_job_attrs
) ?
2483 IPP_GET_JOB_ATTRIBUTES
: IPP_GET_JOBS
;
2484 request
= ippNewRequest(job_op
);
2485 ippSetVersion(request
, monitor
->version
/ 10, monitor
->version
% 10);
2487 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2488 NULL
, monitor
->uri
);
2489 if (job_op
== IPP_GET_JOB_ATTRIBUTES
)
2490 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2493 if (monitor
->user
&& monitor
->user
[0])
2494 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2495 "requesting-user-name", NULL
, monitor
->user
);
2497 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2498 "requested-attributes",
2499 (int)(sizeof(jattrs
) / sizeof(jattrs
[0])), NULL
, jattrs
);
2505 response
= cupsDoRequest(http
, request
, monitor
->resource
);
2507 fprintf(stderr
, "DEBUG: (monitor) %s: %s (%s)\n", ippOpString(job_op
),
2508 ippErrorString(cupsLastError()), cupsLastErrorString());
2510 if (cupsLastError() <= IPP_OK_CONFLICT
)
2513 if (job_op
== IPP_GET_JOB_ATTRIBUTES
)
2515 if ((attr
= ippFindAttribute(response
, "job-state",
2516 IPP_TAG_ENUM
)) != NULL
)
2517 monitor
->job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2519 monitor
->job_state
= IPP_JOB_COMPLETED
;
2523 for (attr
= response
->attrs
; attr
; attr
= attr
->next
)
2527 job_state
= IPP_JOB_PENDING
;
2530 while (attr
&& attr
->group_tag
!= IPP_TAG_JOB
)
2536 while (attr
&& attr
->group_tag
== IPP_TAG_JOB
)
2538 if (!strcmp(attr
->name
, "job-id") &&
2539 attr
->value_tag
== IPP_TAG_INTEGER
)
2540 job_id
= attr
->values
[0].integer
;
2541 else if (!strcmp(attr
->name
, "job-name") &&
2542 (attr
->value_tag
== IPP_TAG_NAME
||
2543 attr
->value_tag
== IPP_TAG_NAMELANG
))
2544 job_name
= attr
->values
[0].string
.text
;
2545 else if (!strcmp(attr
->name
, "job-state") &&
2546 attr
->value_tag
== IPP_TAG_ENUM
)
2547 job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2548 else if (!strcmp(attr
->name
, "job-originating-user-name") &&
2549 (attr
->value_tag
== IPP_TAG_NAME
||
2550 attr
->value_tag
== IPP_TAG_NAMELANG
))
2551 job_user
= attr
->values
[0].string
.text
;
2556 if (job_id
> 0 && job_name
&& !strcmp(job_name
, monitor
->job_name
) &&
2557 job_user
&& monitor
->user
&& !strcmp(job_user
, monitor
->user
))
2559 monitor
->job_id
= job_id
;
2560 monitor
->job_state
= job_state
;
2569 fprintf(stderr
, "DEBUG: (monitor) job-state = %s\n",
2570 ippEnumString("job-state", monitor
->job_state
));
2572 if (!job_canceled
&&
2573 (monitor
->job_state
== IPP_JOB_CANCELED
||
2574 monitor
->job_state
== IPP_JOB_ABORTED
))
2577 fprintf(stderr
, "DEBUG: (monitor) job_canceled = -1\n");
2580 if ((attr
= ippFindAttribute(response
, "job-state-reasons",
2581 IPP_TAG_KEYWORD
)) != NULL
)
2583 int i
, new_reasons
= 0; /* Looping var, new reasons */
2585 for (i
= 0; i
< attr
->num_values
; i
++)
2587 if (!strcmp(attr
->values
[i
].string
.text
,
2588 "account-authorization-failed"))
2589 new_reasons
|= _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
;
2590 else if (!strcmp(attr
->values
[i
].string
.text
, "account-closed"))
2591 new_reasons
|= _CUPS_JSR_ACCOUNT_CLOSED
;
2592 else if (!strcmp(attr
->values
[i
].string
.text
, "account-info-needed"))
2593 new_reasons
|= _CUPS_JSR_ACCOUNT_INFO_NEEDED
;
2594 else if (!strcmp(attr
->values
[i
].string
.text
,
2595 "account-limit-reached"))
2596 new_reasons
|= _CUPS_JSR_ACCOUNT_LIMIT_REACHED
;
2597 else if (!strcmp(attr
->values
[i
].string
.text
, "job-password-wait"))
2598 new_reasons
|= _CUPS_JSR_JOB_PASSWORD_WAIT
;
2599 else if (!strcmp(attr
->values
[i
].string
.text
, "job-release-wait"))
2600 new_reasons
|= _CUPS_JSR_JOB_RELEASE_WAIT
;
2601 if (!job_canceled
&&
2602 (!strncmp(attr
->values
[i
].string
.text
, "job-canceled-", 13) || !strcmp(attr
->values
[i
].string
.text
, "aborted-by-system")))
2606 if (new_reasons
!= monitor
->job_reasons
)
2608 if (new_reasons
& _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
)
2609 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2610 else if (new_reasons
& _CUPS_JSR_ACCOUNT_CLOSED
)
2611 fputs("JOBSTATE: account-closed\n", stderr
);
2612 else if (new_reasons
& _CUPS_JSR_ACCOUNT_INFO_NEEDED
)
2613 fputs("JOBSTATE: account-info-needed\n", stderr
);
2614 else if (new_reasons
& _CUPS_JSR_ACCOUNT_LIMIT_REACHED
)
2615 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2616 else if (new_reasons
& _CUPS_JSR_JOB_PASSWORD_WAIT
)
2617 fputs("JOBSTATE: job-password-wait\n", stderr
);
2618 else if (new_reasons
& _CUPS_JSR_JOB_RELEASE_WAIT
)
2619 fputs("JOBSTATE: job-release-wait\n", stderr
);
2621 fputs("JOBSTATE: job-printing\n", stderr
);
2623 monitor
->job_reasons
= new_reasons
;
2627 ippDelete(response
);
2629 fprintf(stderr
, "DEBUG: (monitor) job-state = %s\n",
2630 ippEnumString("job-state", monitor
->job_state
));
2632 if (!job_canceled
&&
2633 (monitor
->job_state
== IPP_JOB_CANCELED
||
2634 monitor
->job_state
== IPP_JOB_ABORTED
))
2638 * Disconnect from the printer - we'll reconnect on the next poll...
2643 _httpDisconnect(http
);
2647 * Sleep for N seconds...
2650 sleep((unsigned)delay
);
2652 delay
= _cupsNextDelay(delay
, &prev_delay
);
2656 * Cancel the job if necessary...
2659 if (job_canceled
> 0 && monitor
->job_id
> 0)
2661 if (!httpReconnect(http
))
2663 cancel_job(http
, monitor
->uri
, monitor
->job_id
, monitor
->resource
,
2664 monitor
->user
, monitor
->version
);
2666 if (cupsLastError() > IPP_OK_CONFLICT
)
2668 fprintf(stderr
, "DEBUG: (monitor) cancel_job() = %s\n", cupsLastErrorString());
2669 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2675 * Cleanup and return...
2685 * 'new_request()' - Create a new print creation or validation request.
2688 static ipp_t
* /* O - Request data */
2690 ipp_op_t op
, /* I - IPP operation code */
2691 int version
, /* I - IPP version number */
2692 const char *uri
, /* I - printer-uri value */
2693 const char *user
, /* I - requesting-user-name value */
2694 const char *title
, /* I - job-name value */
2695 int num_options
, /* I - Number of options to send */
2696 cups_option_t
*options
, /* I - Options to send */
2697 const char *compression
, /* I - compression value or NULL */
2698 int copies
, /* I - copies value or 0 */
2699 const char *format
, /* I - document-format value or NULL */
2700 _ppd_cache_t
*pc
, /* I - PPD cache and mapping data */
2701 ppd_file_t
*ppd
, /* I - PPD file data */
2702 ipp_attribute_t
*media_col_sup
, /* I - media-col-supported values */
2703 ipp_attribute_t
*doc_handling_sup
, /* I - multiple-document-handling-supported values */
2704 ipp_attribute_t
*print_color_mode_sup
)
2705 /* I - Printer supports print-color-mode */
2707 ipp_t
*request
; /* Request data */
2708 const char *keyword
; /* PWG keyword */
2712 * Create the IPP request...
2715 request
= ippNewRequest(op
);
2716 ippSetVersion(request
, version
/ 10, version
% 10);
2718 fprintf(stderr
, "DEBUG: %s IPP/%d.%d\n",
2719 ippOpString(request
->request
.op
.operation_id
),
2720 request
->request
.op
.version
[0],
2721 request
->request
.op
.version
[1]);
2724 * Add standard attributes...
2727 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
2728 fprintf(stderr
, "DEBUG: printer-uri=\"%s\"\n", uri
);
2732 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "requesting-user-name", NULL
, user
);
2733 fprintf(stderr
, "DEBUG: requesting-user-name=\"%s\"\n", user
);
2736 if (title
&& *title
)
2738 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
, title
);
2739 fprintf(stderr
, "DEBUG: job-name=\"%s\"\n", title
);
2742 if (format
&& op
!= IPP_CREATE_JOB
)
2744 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, format
);
2745 fprintf(stderr
, "DEBUG: document-format=\"%s\"\n", format
);
2749 if (compression
&& op
!= IPP_OP_CREATE_JOB
&& op
!= IPP_OP_VALIDATE_JOB
)
2751 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "compression", NULL
, compression
);
2752 fprintf(stderr
, "DEBUG: compression=\"%s\"\n", compression
);
2754 #endif /* HAVE_LIBZ */
2757 * Handle options on the command-line...
2760 if (num_options
> 0)
2765 * Send standard IPP attributes...
2768 fputs("DEBUG: Adding standard IPP operation/job attributes.\n", stderr
);
2770 copies
= _cupsConvertOptions(request
, ppd
, pc
, media_col_sup
, doc_handling_sup
, print_color_mode_sup
, user
, format
, copies
, num_options
, options
);
2773 * Map FaxOut options...
2776 if ((keyword
= cupsGetOption("phone", num_options
, options
)) != NULL
)
2778 ipp_t
*destination
; /* destination collection */
2779 char phone
[1024], /* Phone number string */
2780 *ptr
, /* Pointer into string */
2781 tel_uri
[1024]; /* tel: URI */
2782 static const char * const allowed
= "0123456789#*-+.()";
2783 /* Allowed characters */
2785 destination
= ippNew();
2788 * Unescape and filter out spaces and other characters that are not
2789 * allowed in a tel: URI.
2792 _httpDecodeURI(phone
, keyword
, sizeof(phone
));
2793 for (ptr
= phone
; *ptr
;)
2795 if (!strchr(allowed
, *ptr
))
2796 _cups_strcpy(ptr
, ptr
+ 1);
2801 httpAssembleURI(HTTP_URI_CODING_ALL
, tel_uri
, sizeof(tel_uri
), "tel", NULL
, NULL
, 0, phone
);
2802 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_URI
, "destination-uri", NULL
, tel_uri
);
2804 if ((keyword
= cupsGetOption("faxPrefix", num_options
,
2805 options
)) != NULL
&& *keyword
)
2807 char predial
[1024]; /* Pre-dial string */
2809 _httpDecodeURI(predial
, keyword
, sizeof(predial
));
2810 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_TEXT
, "pre-dial-string", NULL
, predial
);
2813 ippAddCollection(request
, IPP_TAG_JOB
, "destination-uris", destination
);
2814 ippDelete(destination
);
2820 * When talking to another CUPS server, send all options...
2823 fputs("DEBUG: Adding all operation/job attributes.\n", stderr
);
2824 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_OPERATION
);
2825 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_JOB
);
2828 if (copies
> 1 && (!pc
|| copies
<= pc
->max_copies
))
2829 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies", copies
);
2832 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2833 debug_attributes(request
);
2840 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
2843 static const char * /* O - Password */
2844 password_cb(const char *prompt
, /* I - Prompt (not used) */
2845 http_t
*http
, /* I - Connection */
2846 const char *method
, /* I - Request method (not used) */
2847 const char *resource
, /* I - Resource path (not used) */
2848 int *password_tries
) /* I - Password tries */
2850 char def_username
[HTTP_MAX_VALUE
]; /* Default username */
2853 fprintf(stderr
, "DEBUG: password_cb(prompt=\"%s\", http=%p, method=\"%s\", "
2854 "resource=\"%s\", password_tries=%p(%d)), password=%p\n",
2855 prompt
, http
, method
, resource
, password_tries
, *password_tries
,
2862 if (!uri_credentials
)
2865 * Remember that we need to authenticate...
2868 auth_info_required
= "username,password";
2870 if (httpGetSubField(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "username",
2873 char quoted
[HTTP_MAX_VALUE
* 2 + 4];
2876 fprintf(stderr
, "ATTR: auth-info-default=%s,\n",
2877 quote_string(def_username
, quoted
, sizeof(quoted
)));
2881 if (password
&& *password
&& *password_tries
< 3)
2883 (*password_tries
) ++;
2885 cupsSetUser(username
);
2892 * Give up after 3 tries or if we don't have a password to begin with...
2901 * 'quote_string()' - Quote a string value.
2904 static const char * /* O - Quoted string */
2905 quote_string(const char *s
, /* I - String */
2906 char *q
, /* I - Quoted string buffer */
2907 size_t qsize
) /* I - Size of quoted string buffer */
2909 char *qptr
, /* Pointer into string buffer */
2910 *qend
; /* End of string buffer */
2914 qend
= q
+ qsize
- 5;
2925 while (*s
&& qptr
< qend
)
2927 if (*s
== '\\' || *s
== '\"' || *s
== '\'')
2929 if (qptr
< (qend
- 4))
2951 * 'report_attr()' - Report an IPP attribute value.
2955 report_attr(ipp_attribute_t
*attr
) /* I - Attribute */
2957 int i
; /* Looping var */
2958 char value
[1024], /* Value string */
2959 *valptr
; /* Pointer into value string */
2960 const char *cached
; /* Cached attribute */
2964 * Convert the attribute values into quoted strings...
2967 for (i
= 0, valptr
= value
;
2968 i
< attr
->num_values
&& valptr
< (value
+ sizeof(value
) - 10);
2974 switch (attr
->value_tag
)
2976 case IPP_TAG_INTEGER
:
2978 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), "%d", attr
->values
[i
].integer
);
2979 valptr
+= strlen(valptr
);
2984 case IPP_TAG_KEYWORD
:
2985 quote_string(attr
->values
[i
].string
.text
, valptr
, (size_t)(value
+ sizeof(value
) - valptr
));
2986 valptr
+= strlen(valptr
);
2991 * Unsupported value type...
3000 _cupsMutexLock(&report_mutex
);
3002 if ((cached
= cupsGetOption(attr
->name
, num_attr_cache
,
3003 attr_cache
)) == NULL
|| strcmp(cached
, value
))
3006 * Tell the scheduler about the new values...
3009 num_attr_cache
= cupsAddOption(attr
->name
, value
, num_attr_cache
,
3011 fprintf(stderr
, "ATTR: %s=%s\n", attr
->name
, value
);
3014 _cupsMutexUnlock(&report_mutex
);
3019 * 'report_printer_state()' - Report the printer state.
3023 report_printer_state(ipp_t
*ipp
) /* I - IPP response */
3025 ipp_attribute_t
*pa
, /* printer-alert */
3026 *pam
, /* printer-alert-message */
3027 *pmja
, /* printer-mandatory-job-attributes */
3028 *psm
, /* printer-state-message */
3029 *reasons
, /* printer-state-reasons */
3030 *marker
; /* marker-* attributes */
3031 char value
[1024], /* State/message string */
3032 *valptr
; /* Pointer into string */
3033 static int ipp_supplies
= -1;
3034 /* Report supply levels? */
3038 * Report alerts and messages...
3041 if ((pa
= ippFindAttribute(ipp
, "printer-alert", IPP_TAG_TEXT
)) != NULL
)
3044 if ((pam
= ippFindAttribute(ipp
, "printer-alert-message",
3045 IPP_TAG_TEXT
)) != NULL
)
3048 if ((pmja
= ippFindAttribute(ipp
, "printer-mandatory-job-attributes", IPP_TAG_KEYWORD
)) != NULL
)
3050 int i
, /* Looping var */
3051 count
= ippGetCount(pmja
); /* Number of values */
3053 for (i
= 0, valptr
= value
; i
< count
; i
++, valptr
+= strlen(valptr
))
3056 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), " %s", ippGetString(pmja
, i
, NULL
));
3058 strlcpy(value
, ippGetString(pmja
, i
, NULL
), sizeof(value
));
3061 if (strcmp(value
, mandatory_attrs
))
3063 strlcpy(mandatory_attrs
, value
, sizeof(mandatory_attrs
));
3064 fprintf(stderr
, "PPD: cupsMandatory=\"%s\"\n", value
);
3068 if ((psm
= ippFindAttribute(ipp
, "printer-state-message",
3069 IPP_TAG_TEXT
)) != NULL
)
3071 char *ptr
; /* Pointer into message */
3074 strlcpy(value
, "INFO: ", sizeof(value
));
3075 for (ptr
= psm
->values
[0].string
.text
, valptr
= value
+ 6;
3076 *ptr
&& valptr
< (value
+ sizeof(value
) - 6);
3079 if (*ptr
< ' ' && *ptr
> 0 && *ptr
!= '\t')
3082 * Substitute "<XX>" for the control character; sprintf is safe because
3083 * we always leave 6 chars free at the end...
3086 sprintf(valptr
, "<%02X>", *ptr
);
3096 fputs(value
, stderr
);
3100 * Now report printer-state-reasons, filtering out some of the reasons we never
3104 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
3105 IPP_TAG_KEYWORD
)) == NULL
)
3108 update_reasons(reasons
, NULL
);
3111 * Relay the current marker-* attribute values...
3114 if (ipp_supplies
< 0)
3116 ppd_file_t
*ppd
; /* PPD file */
3117 ppd_attr_t
*ppdattr
; /* Attribute in PPD file */
3119 if ((ppd
= ppdOpenFile(getenv("PPD"))) != NULL
&&
3120 (ppdattr
= ppdFindAttr(ppd
, "cupsIPPSupplies", NULL
)) != NULL
&&
3121 ppdattr
->value
&& _cups_strcasecmp(ppdattr
->value
, "true"))
3129 if (ipp_supplies
> 0)
3131 if ((marker
= ippFindAttribute(ipp
, "marker-colors", IPP_TAG_NAME
)) != NULL
)
3132 report_attr(marker
);
3133 if ((marker
= ippFindAttribute(ipp
, "marker-high-levels",
3134 IPP_TAG_INTEGER
)) != NULL
)
3135 report_attr(marker
);
3136 if ((marker
= ippFindAttribute(ipp
, "marker-levels",
3137 IPP_TAG_INTEGER
)) != NULL
)
3138 report_attr(marker
);
3139 if ((marker
= ippFindAttribute(ipp
, "marker-low-levels",
3140 IPP_TAG_INTEGER
)) != NULL
)
3141 report_attr(marker
);
3142 if ((marker
= ippFindAttribute(ipp
, "marker-message",
3143 IPP_TAG_TEXT
)) != NULL
)
3144 report_attr(marker
);
3145 if ((marker
= ippFindAttribute(ipp
, "marker-names", IPP_TAG_NAME
)) != NULL
)
3146 report_attr(marker
);
3147 if ((marker
= ippFindAttribute(ipp
, "marker-types",
3148 IPP_TAG_KEYWORD
)) != NULL
)
3149 report_attr(marker
);
3154 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3156 * 'run_as_user()' - Run the IPP backend as the printing user.
3158 * This function uses an XPC-based user agent to run the backend as the printing
3159 * user. We need to do this in order to have access to the user's Kerberos
3163 static int /* O - Exit status */
3164 run_as_user(char *argv
[], /* I - Command-line arguments */
3165 uid_t uid
, /* I - User ID */
3166 const char *device_uri
, /* I - Device URI */
3167 int fd
) /* I - File to print */
3169 const char *auth_negotiate
;/* AUTH_NEGOTIATE env var */
3170 xpc_connection_t conn
; /* Connection to XPC service */
3171 xpc_object_t request
; /* Request message dictionary */
3172 __block xpc_object_t response
; /* Response message dictionary */
3173 dispatch_semaphore_t sem
; /* Semaphore for waiting for response */
3174 int status
= CUPS_BACKEND_FAILED
;
3175 /* Status of request */
3178 fprintf(stderr
, "DEBUG: Running IPP backend as UID %d.\n", (int)uid
);
3181 * Connect to the user agent for the specified UID...
3184 conn
= xpc_connection_create_mach_service(kPMPrintUIToolAgent
,
3185 dispatch_get_global_queue(0, 0), 0);
3188 _cupsLangPrintFilter(stderr
, "ERROR",
3189 _("Unable to start backend process."));
3190 fputs("DEBUG: Unable to create connection to agent.\n", stderr
);
3194 xpc_connection_set_event_handler(conn
,
3195 ^(xpc_object_t event
)
3197 xpc_type_t messageType
= xpc_get_type(event
);
3199 if (messageType
== XPC_TYPE_ERROR
)
3201 if (event
== XPC_ERROR_CONNECTION_INTERRUPTED
)
3202 fprintf(stderr
, "DEBUG: Interrupted connection to service %s.\n",
3203 xpc_connection_get_name(conn
));
3204 else if (event
== XPC_ERROR_CONNECTION_INVALID
)
3205 fprintf(stderr
, "DEBUG: Connection invalid for service %s.\n",
3206 xpc_connection_get_name(conn
));
3208 fprintf(stderr
, "DEBUG: Unxpected error for service %s: %s\n",
3209 xpc_connection_get_name(conn
),
3210 xpc_dictionary_get_string(event
, XPC_ERROR_KEY_DESCRIPTION
));
3213 xpc_connection_set_target_uid(conn
, uid
);
3214 xpc_connection_resume(conn
);
3217 * Try starting the backend...
3220 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3221 xpc_dictionary_set_int64(request
, "command", kPMStartJob
);
3222 xpc_dictionary_set_string(request
, "device-uri", device_uri
);
3223 xpc_dictionary_set_string(request
, "job-id", argv
[1]);
3224 xpc_dictionary_set_string(request
, "user", argv
[2]);
3225 xpc_dictionary_set_string(request
, "title", argv
[3]);
3226 xpc_dictionary_set_string(request
, "copies", argv
[4]);
3227 xpc_dictionary_set_string(request
, "options", argv
[5]);
3228 xpc_dictionary_set_string(request
, "auth-info-required",
3229 getenv("AUTH_INFO_REQUIRED"));
3230 if ((auth_negotiate
= getenv("AUTH_NEGOTIATE")) != NULL
)
3231 xpc_dictionary_set_string(request
, "auth-negotiate", auth_negotiate
);
3232 xpc_dictionary_set_fd(request
, "stdin", fd
);
3233 xpc_dictionary_set_fd(request
, "stderr", 2);
3234 xpc_dictionary_set_fd(request
, "side-channel", CUPS_SC_FD
);
3236 sem
= dispatch_semaphore_create(0);
3239 xpc_connection_send_message_with_reply(conn
, request
,
3240 dispatch_get_global_queue(0,0),
3241 ^(xpc_object_t reply
)
3243 /* Save the response and wake up */
3244 if (xpc_get_type(reply
)
3245 == XPC_TYPE_DICTIONARY
)
3246 response
= xpc_retain(reply
);
3248 dispatch_semaphore_signal(sem
);
3251 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3252 xpc_release(request
);
3253 dispatch_release(sem
);
3257 child_pid
= (pid_t
)xpc_dictionary_get_int64(response
, "child-pid");
3259 xpc_release(response
);
3262 fprintf(stderr
, "DEBUG: Child PID=%d.\n", (int)child_pid
);
3265 _cupsLangPrintFilter(stderr
, "ERROR",
3266 _("Unable to start backend process."));
3267 fputs("DEBUG: No child PID.\n", stderr
);
3273 _cupsLangPrintFilter(stderr
, "ERROR",
3274 _("Unable to start backend process."));
3275 fputs("DEBUG: No reply from agent.\n", stderr
);
3280 * Then wait for the backend to finish...
3283 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3284 xpc_dictionary_set_int64(request
, "command", kPMWaitForJob
);
3285 xpc_dictionary_set_fd(request
, "stderr", 2);
3287 sem
= dispatch_semaphore_create(0);
3290 xpc_connection_send_message_with_reply(conn
, request
,
3291 dispatch_get_global_queue(0,0),
3292 ^(xpc_object_t reply
)
3294 /* Save the response and wake up */
3295 if (xpc_get_type(reply
)
3296 == XPC_TYPE_DICTIONARY
)
3297 response
= xpc_retain(reply
);
3299 dispatch_semaphore_signal(sem
);
3302 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3303 xpc_release(request
);
3304 dispatch_release(sem
);
3308 status
= (int)xpc_dictionary_get_int64(response
, "status");
3310 if (status
== SIGTERM
|| status
== SIGKILL
|| status
== SIGPIPE
)
3312 fprintf(stderr
, "DEBUG: Child terminated on signal %d.\n", status
);
3313 status
= CUPS_BACKEND_FAILED
;
3315 else if (WIFSIGNALED(status
))
3317 fprintf(stderr
, "DEBUG: Child crashed on signal %d.\n", status
);
3318 status
= CUPS_BACKEND_STOP
;
3320 else if (WIFEXITED(status
))
3322 status
= WEXITSTATUS(status
);
3323 fprintf(stderr
, "DEBUG: Child exited with status %d.\n", status
);
3326 xpc_release(response
);
3329 _cupsLangPrintFilter(stderr
, "ERROR",
3330 _("Unable to get backend exit status."));
3336 xpc_connection_cancel(conn
);
3342 #endif /* HAVE_GSSAPI && HAVE_XPC */
3346 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
3350 sigterm_handler(int sig
) /* I - Signal */
3352 (void)sig
; /* remove compiler warnings... */
3354 write(2, "DEBUG: Got SIGTERM.\n", 20);
3356 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3359 kill(child_pid
, sig
);
3362 #endif /* HAVE_GSSAPI && HAVE_XPC */
3367 * Flag that the job should be canceled...
3370 write(2, "DEBUG: sigterm_handler: job_canceled = 1.\n", 25);
3377 * The scheduler already tried to cancel us once, now just terminate
3378 * after removing our temp file!
3382 unlink(tmpfilename
);
3389 * 'timeout_cb()' - Handle HTTP timeouts.
3392 static int /* O - 1 to continue, 0 to cancel */
3393 timeout_cb(http_t
*http
, /* I - Connection to server (unused) */
3394 void *user_data
) /* I - User data (unused) */
3399 return (!job_canceled
);
3404 * 'update_reasons()' - Update the printer-state-reasons values.
3408 update_reasons(ipp_attribute_t
*attr
, /* I - printer-state-reasons or NULL */
3409 const char *s
) /* I - STATE: string or NULL */
3411 char op
; /* Add (+), remove (-), replace (\0) */
3412 cups_array_t
*new_reasons
; /* New reasons array */
3413 char *reason
, /* Current reason */
3414 add
[2048], /* Reasons added string */
3415 *addptr
, /* Pointer into add string */
3416 rem
[2048], /* Reasons removed string */
3417 *remptr
; /* Pointer into remove string */
3418 const char *addprefix
, /* Current add string prefix */
3419 *remprefix
; /* Current remove string prefix */
3422 fprintf(stderr
, "DEBUG: update_reasons(attr=%d(%s%s), s=\"%s\")\n",
3423 attr
? attr
->num_values
: 0, attr
? attr
->values
[0].string
.text
: "",
3424 attr
&& attr
->num_values
> 1 ? ",..." : "", s
? s
: "(null)");
3427 * Create an array of new reason keyword strings...
3432 int i
; /* Looping var */
3434 new_reasons
= cupsArrayNew((cups_array_func_t
)strcmp
, NULL
);
3437 for (i
= 0; i
< attr
->num_values
; i
++)
3439 reason
= attr
->values
[i
].string
.text
;
3441 if (strcmp(reason
, "none") &&
3442 strcmp(reason
, "none-report") &&
3443 strcmp(reason
, "paused") &&
3444 strncmp(reason
, "spool-area-full", 15) &&
3445 strcmp(reason
, "com.apple.print.recoverable-warning") &&
3446 strncmp(reason
, "cups-", 5))
3447 cupsArrayAdd(new_reasons
, reason
);
3452 if (*s
== '+' || *s
== '-')
3457 new_reasons
= _cupsArrayNewStrings(s
, ',');
3463 * Compute the changes...
3467 addprefix
= "STATE: +";
3470 remprefix
= "STATE: -";
3473 fprintf(stderr
, "DEBUG2: op='%c', new_reasons=%d, state_reasons=%d\n",
3474 op
? op
: ' ', cupsArrayCount(new_reasons
),
3475 cupsArrayCount(state_reasons
));
3477 _cupsMutexLock(&report_mutex
);
3485 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3487 reason
= (char *)cupsArrayNext(new_reasons
))
3489 if (!cupsArrayFind(state_reasons
, reason
))
3491 if (!strncmp(reason
, "cups-remote-", 12))
3494 * If we are setting cups-remote-xxx, remove all other cups-remote-xxx
3498 char *temp
; /* Current reason in state_reasons */
3500 cupsArraySave(state_reasons
);
3502 for (temp
= (char *)cupsArrayFirst(state_reasons
);
3504 temp
= (char *)cupsArrayNext(state_reasons
))
3505 if (!strncmp(temp
, "cups-remote-", 12))
3507 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, temp
);
3508 remptr
+= strlen(remptr
);
3511 cupsArrayRemove(state_reasons
, temp
);
3515 cupsArrayRestore(state_reasons
);
3518 cupsArrayAdd(state_reasons
, reason
);
3520 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3521 addptr
+= strlen(addptr
);
3532 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3534 reason
= (char *)cupsArrayNext(new_reasons
))
3536 if (cupsArrayFind(state_reasons
, reason
))
3538 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3539 remptr
+= strlen(remptr
);
3542 cupsArrayRemove(state_reasons
, reason
);
3549 * Replace reasons...
3552 for (reason
= (char *)cupsArrayFirst(state_reasons
);
3554 reason
= (char *)cupsArrayNext(state_reasons
))
3556 if (strncmp(reason
, "cups-", 5) && !cupsArrayFind(new_reasons
, reason
))
3558 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3559 remptr
+= strlen(remptr
);
3562 cupsArrayRemove(state_reasons
, reason
);
3566 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3568 reason
= (char *)cupsArrayNext(new_reasons
))
3570 if (!cupsArrayFind(state_reasons
, reason
))
3572 cupsArrayAdd(state_reasons
, reason
);
3574 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3575 addptr
+= strlen(addptr
);
3581 _cupsMutexUnlock(&report_mutex
);
3584 * Report changes and return...
3587 if (add
[0] && rem
[0])
3588 fprintf(stderr
, "%s\n%s\n", add
, rem
);
3590 fprintf(stderr
, "%s\n", add
);
3592 fprintf(stderr
, "%s\n", rem
);