2 * IPP backend for CUPS.
4 * Copyright 2007-2017 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/".
15 * Include necessary headers.
18 #include "backend-private.h"
19 #include <cups/ppd-private.h>
20 #include <cups/array-private.h>
21 #include <sys/types.h>
24 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
26 # define kPMPrintUIToolAgent "com.apple.printuitool.agent"
27 # define kPMStartJob 100
28 # define kPMWaitForJob 101
29 # ifdef HAVE_XPC_PRIVATE_H
30 # include <xpc/private.h>
32 extern void xpc_connection_set_target_uid(xpc_connection_t connection
,
34 # endif /* HAVE_XPC_PRIVATE_H */
35 #endif /* HAVE_GSSAPI && HAVE_XPC */
39 * Bits for job-state-reasons we care about...
42 #define _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED 0x01
43 #define _CUPS_JSR_ACCOUNT_CLOSED 0x02
44 #define _CUPS_JSR_ACCOUNT_INFO_NEEDED 0x04
45 #define _CUPS_JSR_ACCOUNT_LIMIT_REACHED 0x08
46 #define _CUPS_JSR_JOB_PASSWORD_WAIT 0x10
47 #define _CUPS_JSR_JOB_RELEASE_WAIT 0x20
54 typedef struct _cups_monitor_s
/**** Monitoring data ****/
56 const char *uri
, /* Printer URI */
57 *hostname
, /* Hostname */
59 *resource
; /* Resource path */
60 int port
, /* Port number */
61 version
, /* IPP version */
62 job_id
, /* Job ID for submitted job */
63 job_reasons
, /* Job state reasons bits */
64 create_job
, /* Support Create-Job? */
65 get_job_attrs
; /* Support Get-Job-Attributes? */
66 const char *job_name
; /* Job name for submitted job */
67 http_encryption_t encryption
; /* Use encryption? */
68 ipp_jstate_t job_state
; /* Current job state */
69 ipp_pstate_t printer_state
; /* Current printer state */
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 */
85 "job-impressions-completed",
86 "job-media-sheets-completed",
88 "job-originating-user-name",
92 static int job_canceled
= 0,
95 /* Credentials supplied in URI? */
96 static char username
[256] = "",
97 /* Username for device URI */
99 /* Password for device URI */
100 static const char * const pattrs
[] = /* Printer attributes we want */
103 "compression-supported",
104 #endif /* HAVE_LIBZ */
107 "document-format-supported",
108 "job-password-encryption-supported",
110 "marker-high-levels",
116 "media-col-supported",
117 "multiple-document-handling-supported",
118 "operations-supported",
119 "print-color-mode-supported",
121 "printer-alert-description",
122 "printer-is-accepting-jobs",
123 "printer-mandatory-job-attributes",
125 "printer-state-message",
126 "printer-state-reasons"
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"
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 */
155 static void cancel_job(http_t
*http
, const char *uri
, int id
,
156 const char *resource
, const char *user
,
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
,
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
,
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
);
188 * 'main()' - Send a file to the printer or server.
192 * printer-uri job-id user title copies options [file]
195 int /* O - Exit status */
196 main(int argc
, /* I - Number of command-line args */
197 char *argv
[]) /* I - Command-line arguments */
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 */
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() */
282 * Make sure status messages are not buffered...
285 setbuf(stderr
, NULL
);
288 * Ignore SIGPIPE and catch SIGTERM signals...
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
);
299 sigemptyset(&action
.sa_mask
);
300 sigaddset(&action
.sa_mask
, SIGTERM
);
301 action
.sa_handler
= sigterm_handler
;
302 sigaction(SIGTERM
, &action
, NULL
);
304 signal(SIGPIPE
, SIG_IGN
);
305 signal(SIGTERM
, sigterm_handler
);
306 #endif /* HAVE_SIGSET */
309 * Check command-line...
316 if ((s
= strrchr(argv
[0], '/')) != NULL
)
321 printf("network %s \"Unknown\" \"%s (%s)\"\n",
322 s
, _cupsLangString(cupsLangDefault(),
323 _("Internet Printing Protocol")), s
);
324 return (CUPS_BACKEND_OK
);
328 _cupsLangPrintf(stderr
,
329 _("Usage: %s job-id user title copies options [file]"),
331 return (CUPS_BACKEND_STOP
);
335 * Get the device URI...
338 while ((device_uri
= cupsBackendDeviceURI(argv
)) == NULL
)
340 _cupsLangPrintFilter(stderr
, "INFO", _("Unable to locate printer."));
343 if (getenv("CLASS") != NULL
)
344 return (CUPS_BACKEND_FAILED
);
347 if ((auth_info_required
= getenv("AUTH_INFO_REQUIRED")) == NULL
)
348 auth_info_required
= "none";
350 state_reasons
= _cupsArrayNewStrings(getenv("PRINTER_STATE_REASONS"), ',');
354 * For Kerberos, become the printing user (if we can) to get the credentials
358 if (!getuid() && (value
= getenv("AUTH_UID")) != NULL
&&
359 !getenv("AUTH_PASSWORD"))
361 uid_t uid
= (uid_t
)atoi(value
);
368 return (run_as_user(argv
, uid
, device_uri
, 0));
371 int status
= 0; /* Exit status */
373 for (i
= 6; i
< argc
&& !status
&& !job_canceled
; i
++)
375 if ((fd
= open(argv
[i
], O_RDONLY
)) >= 0)
377 status
= run_as_user(argv
, uid
, device_uri
, fd
);
382 _cupsLangPrintError("ERROR", _("Unable to open print file"));
383 status
= CUPS_BACKEND_FAILED
;
391 # else /* No XPC, just try to run as the user ID */
394 # endif /* HAVE_XPC */
396 #endif /* HAVE_GSSAPI */
399 * Get the (final) content type...
402 if ((content_type
= getenv("CONTENT_TYPE")) == NULL
)
403 content_type
= "application/octet-stream";
405 if ((final_content_type
= getenv("FINAL_CONTENT_TYPE")) == NULL
)
407 final_content_type
= content_type
;
409 if (!strncmp(final_content_type
, "printer/", 8))
410 final_content_type
= "application/vnd.cups-raw";
414 * Extract the hostname and printer name from the URI...
417 httpSeparateURI(HTTP_URI_CODING_ALL
, device_uri
, scheme
, sizeof(scheme
),
418 username
, sizeof(username
), hostname
, sizeof(hostname
), &port
,
419 resource
, sizeof(resource
));
422 port
= IPP_PORT
; /* Default to port 631 */
424 if (!strcmp(scheme
, "https") || !strcmp(scheme
, "ipps"))
425 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
427 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
430 * See if there are any options...
437 contimeout
= 7 * 24 * 60 * 60;
439 if ((optptr
= strchr(resource
, '?')) != NULL
)
442 * Yup, terminate the device name string and move to the first
443 * character of the optptr...
449 * Then parse the optptr...
460 while (*optptr
&& *optptr
!= '=' && *optptr
!= '+' && *optptr
!= '&')
463 if ((sep
= *optptr
) != '\0')
474 while (*optptr
&& *optptr
!= '+' && *optptr
!= '&')
484 * Process the option...
487 if (!_cups_strcasecmp(name
, "waitjob"))
490 * Wait for job completion?
493 waitjob
= !_cups_strcasecmp(value
, "on") ||
494 !_cups_strcasecmp(value
, "yes") ||
495 !_cups_strcasecmp(value
, "true");
497 else if (!_cups_strcasecmp(name
, "waitprinter"))
500 * Wait for printer idle?
503 waitprinter
= !_cups_strcasecmp(value
, "on") ||
504 !_cups_strcasecmp(value
, "yes") ||
505 !_cups_strcasecmp(value
, "true");
507 else if (!_cups_strcasecmp(name
, "encryption"))
510 * Enable/disable encryption?
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
);
523 _cupsLangPrintFilter(stderr
, "ERROR",
524 _("Unknown encryption option value: \"%s\"."),
528 else if (!_cups_strcasecmp(name
, "snmp"))
531 * Enable/disable SNMP stuff...
534 snmp_enabled
= !value
[0] || !_cups_strcasecmp(value
, "on") ||
535 !_cups_strcasecmp(value
, "yes") ||
536 !_cups_strcasecmp(value
, "true");
538 else if (!_cups_strcasecmp(name
, "version"))
540 if (!strcmp(value
, "1.0"))
542 else if (!strcmp(value
, "1.1"))
544 else if (!strcmp(value
, "2.0"))
546 else if (!strcmp(value
, "2.1"))
548 else if (!strcmp(value
, "2.2"))
552 _cupsLangPrintFilter(stderr
, "ERROR",
553 _("Unknown version option value: \"%s\"."),
558 else if (!_cups_strcasecmp(name
, "compression"))
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";
571 #endif /* HAVE_LIBZ */
572 else if (!_cups_strcasecmp(name
, "contimeout"))
575 * Set the connection timeout...
579 contimeout
= atoi(value
);
587 _cupsLangPrintFilter(stderr
, "ERROR",
588 _("Unknown option \"%s\" with value \"%s\"."),
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
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);
608 fputs("DEBUG: Sending stdin for job...\n", stderr
);
613 * Point to the files on the command-line...
616 num_files
= argc
- 6;
620 fprintf(stderr
, "DEBUG: %d files to send in job...\n", num_files
);
624 * Set the authentication info, if any...
627 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
632 * Use authentication information in the device URI...
635 if ((password
= strchr(username
, ':')) != NULL
)
638 cupsSetUser(username
);
644 * Try loading authentication information from the environment.
647 const char *ptr
= getenv("AUTH_USERNAME");
651 strlcpy(username
, ptr
, sizeof(username
));
655 password
= getenv("AUTH_PASSWORD");
659 * Try finding the remote server...
662 start_time
= time(NULL
);
664 addrlist
= backendLookup(hostname
, port
, &job_canceled
);
666 http
= httpConnect2(hostname
, port
, addrlist
, AF_UNSPEC
, cupsEncryption(), 1,
668 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
671 * See if the printer supports SNMP...
675 snmp_fd
= _cupsSNMPOpen(addrlist
->addr
.addr
.sa_family
);
680 have_supplies
= !backendSNMPSupplies(snmp_fd
, &(addrlist
->addr
),
683 have_supplies
= start_count
= 0;
686 * Wait for data from the filter...
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
);
698 * Try connecting to the remote server...
701 delay
= _cupsNextDelay(0, &prev_delay
);
705 fprintf(stderr
, "DEBUG: Connecting to %s:%d\n", hostname
, port
);
706 _cupsLangPrintFilter(stderr
, "INFO", _("Connecting to printer."));
708 if (httpReconnect(http
))
710 int error
= errno
; /* Connection error */
712 if (http
->status
== HTTP_PKI_ERROR
)
713 update_reasons(NULL
, "+cups-certificate-error");
718 if (getenv("CLASS") != NULL
)
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.
727 _cupsLangPrintFilter(stderr
, "INFO",
728 _("Unable to contact printer, queuing on next "
729 "printer in class."));
732 * Sleep 5 seconds to keep the job from requeuing too rapidly...
737 update_reasons(NULL
, "-connecting-to-device");
739 return (CUPS_BACKEND_FAILED
);
742 fprintf(stderr
, "DEBUG: Connection error: %s\n", strerror(errno
));
744 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
|| errno
== EHOSTUNREACH
|| errno
== ETIMEDOUT
|| errno
== ENOTCONN
)
746 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
748 _cupsLangPrintFilter(stderr
, "ERROR",
749 _("The printer is not responding."));
750 update_reasons(NULL
, "-connecting-to-device");
751 return (CUPS_BACKEND_FAILED
);
757 _cupsLangPrintFilter(stderr
, "WARNING",
758 _("The printer may not exist or "
759 "is unavailable at this time."));
764 _cupsLangPrintFilter(stderr
, "WARNING",
765 _("The printer is unreachable at this "
770 _cupsLangPrintFilter(stderr
, "WARNING",
771 _("The printer is in use."));
775 sleep((unsigned)delay
);
777 delay
= _cupsNextDelay(delay
, &prev_delay
);
781 _cupsLangPrintFilter(stderr
, "ERROR",
782 _("The printer is not responding."));
790 update_reasons(NULL
, "-cups-certificate-error");
792 while (http
->fd
< 0);
795 return (CUPS_BACKEND_OK
);
797 return (CUPS_BACKEND_FAILED
);
799 if (httpIsEncrypted(http
))
802 * Validate TLS credentials...
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" };
812 static const char * const trust_msgs
[] =
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"
822 fputs("DEBUG: Connection is encrypted.\n", stderr
);
824 if (!httpCopyCredentials(http
, &creds
))
826 trust
= httpCredentialsGetTrust(creds
, hostname
);
827 httpCredentialsString(creds
, credinfo
, sizeof(credinfo
));
829 fprintf(stderr
, "DEBUG: %s (%s)\n", trust_msgs
[trust
], cupsLastErrorString());
830 fprintf(stderr
, "DEBUG: Printer credentials: %s\n", credinfo
);
832 if (!httpLoadCredentials(NULL
, &lcreds
, hostname
))
834 httpCredentialsString(lcreds
, lcredinfo
, sizeof(lcredinfo
));
835 fprintf(stderr
, "DEBUG: Stored credentials: %s\n", lcredinfo
);
838 fputs("DEBUG: No stored credentials.\n", stderr
);
840 update_reasons(NULL
, "-cups-pki-invalid,cups-pki-changed,cups-pki-expired,cups-pki-unknown");
843 update_reasons(NULL
, trusts
[trust
]);
844 return (CUPS_BACKEND_STOP
);
850 * Could not load the credentials, let's save the ones we have so we
851 * can detect changes...
854 httpSaveCredentials(NULL
, creds
, hostname
);
857 httpFreeCredentials(lcreds
);
858 httpFreeCredentials(creds
);
862 fputs("DEBUG: No printer credentials.\n", stderr
);
864 update_reasons(NULL
, "cups-pki-unknown");
865 return (CUPS_BACKEND_STOP
);
869 update_reasons(NULL
, "-connecting-to-device");
870 _cupsLangPrintFilter(stderr
, "INFO", _("Connected to printer."));
872 fprintf(stderr
, "DEBUG: Connected to %s:%d...\n",
873 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
874 httpAddrPort(http
->hostaddr
));
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...
882 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), scheme
, NULL
, hostname
,
886 * First validate the destination and see if the device supports multiple
891 compression_sup
= NULL
;
892 #endif /* HAVE_LIBZ */
895 encryption_sup
= NULL
;
897 media_col_sup
= NULL
;
899 operations_sup
= NULL
;
900 doc_handling_sup
= NULL
;
901 print_color_mode_sup
= NULL
;
906 * Check for side-channel requests...
909 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
912 * Build the IPP request...
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",
920 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
921 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
928 fputs("DEBUG: Getting supported attributes...\n", stderr
);
930 if (http
->version
< HTTP_1_1
)
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");
938 supported
= cupsDoRequest(http
, request
, resource
);
939 ipp_status
= cupsLastError();
941 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
942 ippErrorString(ipp_status
), cupsLastErrorString());
944 if (ipp_status
<= IPP_OK_CONFLICT
)
948 fprintf(stderr
, "DEBUG: Get-Printer-Attributes returned %s.\n",
949 ippErrorString(ipp_status
));
951 if (ipp_status
== IPP_PRINTER_BUSY
||
952 ipp_status
== IPP_SERVICE_UNAVAILABLE
)
954 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
956 _cupsLangPrintFilter(stderr
, "ERROR",
957 _("The printer is not responding."));
958 return (CUPS_BACKEND_FAILED
);
961 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
963 report_printer_state(supported
);
965 sleep((unsigned)delay
);
967 delay
= _cupsNextDelay(delay
, &prev_delay
);
969 else if ((ipp_status
== IPP_BAD_REQUEST
||
970 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
> 10)
973 * Switch to IPP/1.1 or IPP/1.0...
978 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
980 "DEBUG: The printer does not support IPP/%d.%d, trying "
981 "IPP/1.1.\n", version
/ 10, version
% 10);
986 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
988 "DEBUG: The printer does not support IPP/%d.%d, trying "
989 "IPP/1.0.\n", version
/ 10, version
% 10);
995 else if (ipp_status
== IPP_NOT_FOUND
)
997 _cupsLangPrintFilter(stderr
, "ERROR",
998 _("The printer configuration is incorrect or the "
999 "printer no longer exists."));
1001 ippDelete(supported
);
1003 return (CUPS_BACKEND_STOP
);
1005 else if (ipp_status
== IPP_FORBIDDEN
||
1006 ipp_status
== IPP_AUTHENTICATION_CANCELED
)
1008 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1009 /* WWW-Authenticate field value */
1011 if (!strncmp(www_auth
, "Negotiate", 9))
1012 auth_info_required
= "negotiate";
1013 else if (www_auth
[0])
1014 auth_info_required
= "username,password";
1016 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
1017 return (CUPS_BACKEND_AUTH_REQUIRED
);
1019 else if (ipp_status
!= IPP_NOT_AUTHORIZED
)
1021 _cupsLangPrintFilter(stderr
, "ERROR",
1022 _("Unable to get printer status."));
1025 httpReconnect(http
);
1028 ippDelete(supported
);
1033 if (!getenv("CLASS"))
1036 * Check printer-is-accepting-jobs = false and printer-state-reasons for the
1037 * "spool-area-full" keyword...
1042 if ((printer_accepting
= ippFindAttribute(supported
,
1043 "printer-is-accepting-jobs",
1044 IPP_TAG_BOOLEAN
)) != NULL
&&
1045 !printer_accepting
->values
[0].boolean
)
1047 else if (!printer_accepting
)
1048 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1049 "cups-ipp-missing-printer-is-accepting-jobs");
1051 if ((printer_state
= ippFindAttribute(supported
,
1052 "printer-state-reasons",
1053 IPP_TAG_KEYWORD
)) == NULL
)
1055 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1056 "cups-ipp-missing-printer-state-reasons");
1060 for (i
= 0; i
< printer_state
->num_values
; i
++)
1062 if (!strcmp(printer_state
->values
[0].string
.text
,
1063 "spool-area-full") ||
1064 !strncmp(printer_state
->values
[0].string
.text
, "spool-area-full-",
1075 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1077 report_printer_state(supported
);
1079 sleep((unsigned)delay
);
1081 delay
= _cupsNextDelay(delay
, &prev_delay
);
1083 ippDelete(supported
);
1085 ipp_status
= IPP_STATUS_ERROR_BUSY
;
1091 * Check for supported attributes...
1095 if ((compression_sup
= ippFindAttribute(supported
, "compression-supported",
1096 IPP_TAG_KEYWORD
)) != NULL
)
1099 * Check whether the requested compression is supported and/or default to
1100 * compression if supported...
1103 if (compression
&& !ippContainsString(compression_sup
, compression
))
1105 fprintf(stderr
, "DEBUG: Printer does not support the requested "
1106 "compression value \"%s\".\n", compression
);
1109 else if (!compression
&& (!strcmp(final_content_type
, "image/pwg-raster") || !strcmp(final_content_type
, "image/urf")))
1111 if (ippContainsString(compression_sup
, "gzip"))
1112 compression
= "gzip";
1113 else if (ippContainsString(compression_sup
, "deflate"))
1114 compression
= "deflate";
1117 fprintf(stderr
, "DEBUG: Automatically using \"%s\" compression.\n",
1121 #endif /* HAVE_LIBZ */
1123 if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
1124 IPP_TAG_RANGE
)) != NULL
)
1127 * Has the "copies-supported" attribute - does it have an upper
1131 fprintf(stderr
, "DEBUG: copies-supported=%d-%d\n",
1132 copies_sup
->values
[0].range
.lower
,
1133 copies_sup
->values
[0].range
.upper
);
1135 if (copies_sup
->values
[0].range
.upper
<= 1)
1136 copies_sup
= NULL
; /* No */
1139 cups_version
= ippFindAttribute(supported
, "cups-version", IPP_TAG_TEXT
);
1141 encryption_sup
= ippFindAttribute(supported
, "job-password-encryption-supported", IPP_TAG_KEYWORD
);
1143 if ((format_sup
= ippFindAttribute(supported
, "document-format-supported",
1144 IPP_TAG_MIMETYPE
)) != NULL
)
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
);
1153 if ((media_col_sup
= ippFindAttribute(supported
, "media-col-supported",
1154 IPP_TAG_KEYWORD
)) != NULL
)
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
);
1163 print_color_mode_sup
= ippFindAttribute(supported
, "print-color-mode-supported", IPP_TAG_KEYWORD
);
1165 if ((operations_sup
= ippFindAttribute(supported
, "operations-supported",
1166 IPP_TAG_ENUM
)) != NULL
)
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
));
1174 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1175 if (operations_sup
->values
[i
].integer
== IPP_PRINT_JOB
)
1178 if (i
>= operations_sup
->num_values
)
1179 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1180 "cups-ipp-missing-print-job");
1182 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1183 if (operations_sup
->values
[i
].integer
== IPP_CANCEL_JOB
)
1186 if (i
>= operations_sup
->num_values
)
1187 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1188 "cups-ipp-missing-cancel-job");
1190 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1191 if (operations_sup
->values
[i
].integer
== IPP_GET_JOB_ATTRIBUTES
)
1194 if (i
>= operations_sup
->num_values
)
1195 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1196 "cups-ipp-missing-get-job-attributes");
1198 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1199 if (operations_sup
->values
[i
].integer
== IPP_GET_PRINTER_ATTRIBUTES
)
1202 if (i
>= operations_sup
->num_values
)
1203 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1204 "cups-ipp-missing-get-printer-attributes");
1206 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1208 if (operations_sup
->values
[i
].integer
== IPP_VALIDATE_JOB
)
1210 else if (operations_sup
->values
[i
].integer
== IPP_CREATE_JOB
)
1212 else if (operations_sup
->values
[i
].integer
== IPP_SEND_DOCUMENT
)
1214 else if (operations_sup
->values
[i
].integer
== IPP_GET_JOB_ATTRIBUTES
)
1218 if (create_job
&& !send_document
)
1220 fputs("DEBUG: Printer supports Create-Job but not Send-Document.\n",
1224 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1225 "cups-ipp-missing-send-document");
1229 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1230 "cups-ipp-missing-validate-job");
1233 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1234 "cups-ipp-missing-operations-supported");
1236 doc_handling_sup
= ippFindAttribute(supported
,
1237 "multiple-document-handling-supported",
1240 report_printer_state(supported
);
1242 while (!job_canceled
&& ipp_status
> IPP_OK_CONFLICT
);
1245 return (CUPS_BACKEND_OK
);
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...
1252 if (getenv("CLASS") != NULL
)
1254 printer_state
= ippFindAttribute(supported
, "printer-state",
1256 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
1259 if (printer_state
== NULL
||
1260 (printer_state
->values
[0].integer
> IPP_PRINTER_PROCESSING
&&
1262 printer_accepting
== NULL
||
1263 !printer_accepting
->values
[0].boolean
)
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.
1272 _cupsLangPrintFilter(stderr
, "INFO",
1273 _("Unable to contact printer, queuing on next "
1274 "printer in class."));
1276 ippDelete(supported
);
1280 * Sleep 5 seconds to keep the job from requeuing too rapidly...
1285 return (CUPS_BACKEND_FAILED
);
1290 * See if the printer supports multiple copies...
1293 copies
= atoi(argv
[4]);
1295 if (copies_sup
|| argc
< 7)
1296 copies_remaining
= 1;
1298 copies_remaining
= copies
;
1301 * Prepare remaining printing options...
1308 num_options
= cupsParseOptions(argv
[5], 0, &options
);
1310 if (!cups_version
&& media_col_sup
)
1313 * Load the PPD file and generate PWG attribute mapping information...
1316 ppd_attr_t
*mandatory
; /* cupsMandatory value */
1318 ppd
= ppdOpenFile(getenv("PPD"));
1319 pc
= _ppdCacheCreateWithPPD(ppd
);
1321 ppdMarkDefaults(ppd
);
1322 cupsMarkOptions(ppd
, num_options
, options
);
1324 if ((mandatory
= ppdFindAttr(ppd
, "cupsMandatory", NULL
)) != NULL
)
1325 strlcpy(mandatory_attrs
, mandatory
->value
, sizeof(mandatory_attrs
));
1329 * Validate job-password/-encryption...
1332 if (cupsGetOption("job-password", num_options
, options
))
1334 const char *keyword
; /* job-password-encryption value */
1335 static const char * const hashes
[] =
1336 { /* List of supported hash algorithms, in order of preference */
1347 if ((keyword
= cupsGetOption("job-password-encryption", num_options
, options
)) == NULL
|| !ippContainsString(encryption_sup
, keyword
))
1350 * Either no job-password-encryption or the value isn't supported by
1354 for (i
= 0; i
< (int)(sizeof(hashes
) / sizeof(hashes
[0])); i
++)
1355 if (ippContainsString(encryption_sup
, hashes
[i
]))
1358 if (i
< (int)(sizeof(hashes
) / sizeof(hashes
[0])))
1359 num_options
= cupsAddOption("job-password-encryption", hashes
[i
], num_options
, &options
);
1366 document_format
= NULL
;
1368 if (format_sup
!= NULL
)
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";
1376 fprintf(stderr
, "DEBUG: final_content_type=\"%s\", document_format=\"%s\"\n",
1377 final_content_type
, document_format
? document_format
: "(null)");
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...
1383 * (I hate compatibility hacks!)
1386 if (http
->version
< HTTP_1_1
&& num_files
== 0)
1388 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
1390 perror("DEBUG: Unable to create temporary file");
1391 return (CUPS_BACKEND_FAILED
);
1394 _cupsLangPrintFilter(stderr
, "INFO", _("Copying print data."));
1396 if ((compatsize
= write(fd
, buffer
, (size_t)bytes
)) < 0)
1398 perror("DEBUG: Unable to write temporary file");
1399 return (CUPS_BACKEND_FAILED
);
1402 if ((bytes
= backendRunLoop(-1, fd
, snmp_fd
, &(addrlist
->addr
), 0, 0,
1403 backendNetworkSideCB
)) < 0)
1404 return (CUPS_BACKEND_FAILED
);
1406 compatsize
+= bytes
;
1410 compatfile
= tmpfilename
;
1411 files
= &compatfile
;
1414 else if (http
->version
< HTTP_1_1
&& num_files
== 1)
1416 struct stat fileinfo
; /* File information */
1418 if (!stat(files
[0], &fileinfo
))
1419 compatsize
= fileinfo
.st_size
;
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
1431 create_job
= send_document
= 0;
1434 * Start monitoring the printer in the background...
1438 monitor
.hostname
= hostname
;
1439 monitor
.user
= argv
[2];
1440 monitor
.resource
= resource
;
1441 monitor
.port
= port
;
1442 monitor
.version
= version
;
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
;
1452 monitor
.job_name
= argv
[3];
1456 snprintf(print_job_name
, sizeof(print_job_name
), "%s - %s", argv
[1],
1458 monitor
.job_name
= print_job_name
;
1461 _cupsThreadCreate((_cups_thread_func_t
)monitor_printer
, &monitor
);
1464 * Validate access to the printer...
1467 while (!job_canceled
&& validate_job
)
1469 request
= new_request(IPP_OP_VALIDATE_JOB
, version
, uri
, argv
[2],
1470 monitor
.job_name
, num_options
, options
, compression
,
1471 copies_sup
? copies
: 1, document_format
, pc
, ppd
,
1472 media_col_sup
, doc_handling_sup
, print_color_mode_sup
);
1474 response
= cupsDoRequest(http
, request
, resource
);
1476 ipp_status
= cupsLastError();
1478 fprintf(stderr
, "DEBUG: Validate-Job: %s (%s)\n",
1479 ippErrorString(ipp_status
), cupsLastErrorString());
1480 debug_attributes(response
);
1482 if ((job_auth
= ippFindAttribute(response
, "job-authorization-uri",
1483 IPP_TAG_URI
)) != NULL
)
1484 num_options
= cupsAddOption("job-authorization-uri",
1485 ippGetString(job_auth
, 0, NULL
), num_options
,
1488 ippDelete(response
);
1493 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1494 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1496 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1499 else if (ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
||
1500 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1501 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1502 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1503 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1504 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1506 else if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1507 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1508 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1510 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1511 /* WWW-Authenticate field value */
1513 if (!strncmp(www_auth
, "Negotiate", 9))
1514 auth_info_required
= "negotiate";
1515 else if (www_auth
[0])
1516 auth_info_required
= "username,password";
1520 else if (ipp_status
== IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
)
1523 * This is all too common...
1526 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1527 "cups-ipp-missing-validate-job");
1530 else if (ipp_status
< IPP_REDIRECTION_OTHER_SITE
||
1531 ipp_status
== IPP_BAD_REQUEST
)
1533 else if (job_auth
== NULL
&& ipp_status
> IPP_BAD_REQUEST
)
1538 * Then issue the print-job request...
1543 while (!job_canceled
&& copies_remaining
> 0)
1546 * Check for side-channel requests...
1549 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1552 * Build the IPP job creation request...
1558 request
= new_request((num_files
> 1 || create_job
) ? IPP_CREATE_JOB
:
1560 version
, uri
, argv
[2], monitor
.job_name
, num_options
,
1561 options
, compression
, copies_sup
? copies
: 1,
1562 document_format
, pc
, ppd
, media_col_sup
,
1563 doc_handling_sup
, print_color_mode_sup
);
1569 if (num_files
> 1 || create_job
)
1570 response
= cupsDoRequest(http
, request
, resource
);
1573 size_t length
= 0; /* Length of request */
1577 fputs("DEBUG: Sending file using HTTP/1.0 Content-Length...\n", stderr
);
1578 length
= ippLength(request
) + (size_t)compatsize
;
1581 fputs("DEBUG: Sending file using HTTP/1.1 chunking...\n", stderr
);
1583 http_status
= cupsSendRequest(http
, request
, resource
, length
);
1584 if (http_status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
)
1586 if (compression
&& strcmp(compression
, "none"))
1587 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1591 if ((fd
= open(files
[0], O_RDONLY
)) < 0)
1593 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1594 return (CUPS_BACKEND_FAILED
);
1600 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1603 while (http_status
== HTTP_CONTINUE
&&
1604 (!job_canceled
|| compatsize
> 0))
1607 * Check for side-channel requests and more print data...
1612 FD_SET(snmp_fd
, &input
);
1613 FD_SET(CUPS_SC_FD
, &input
);
1615 while (select(fd
> snmp_fd
? fd
+ 1 : snmp_fd
+ 1, &input
, NULL
, NULL
,
1616 NULL
) <= 0 && !job_canceled
);
1618 if (FD_ISSET(snmp_fd
, &input
))
1619 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1621 if (FD_ISSET(fd
, &input
))
1623 if ((bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1625 fprintf(stderr
, "DEBUG: Read %d bytes...\n", (int)bytes
);
1627 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1631 else if (bytes
== 0 || (errno
!= EINTR
&& errno
!= EAGAIN
))
1636 if (http_status
== HTTP_ERROR
)
1637 fprintf(stderr
, "DEBUG: Error writing document data for "
1638 "Print-Job: %s\n", strerror(httpError(http
)));
1644 response
= cupsGetResponse(http
, resource
);
1648 ipp_status
= cupsLastError();
1650 fprintf(stderr
, "DEBUG: %s: %s (%s)\n",
1651 (num_files
> 1 || create_job
) ? "Create-Job" : "Print-Job",
1652 ippErrorString(ipp_status
), cupsLastErrorString());
1653 debug_attributes(response
);
1655 if (ipp_status
> IPP_OK_CONFLICT
)
1662 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1663 ipp_status
== IPP_STATUS_ERROR_NOT_POSSIBLE
||
1664 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1666 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1672 * We can't re-submit when we have no files to print, so exit
1673 * immediately with the right status code...
1679 else if (ipp_status
== IPP_STATUS_ERROR_JOB_CANCELED
||
1680 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1681 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1682 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1683 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1684 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1685 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1690 * Update auth-info-required as needed...
1693 _cupsLangPrintFilter(stderr
, "ERROR",
1694 _("Print job was not accepted."));
1696 if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1697 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1699 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1700 /* WWW-Authenticate field value */
1702 if (!strncmp(www_auth
, "Negotiate", 9))
1703 auth_info_required
= "negotiate";
1704 else if (www_auth
[0])
1705 auth_info_required
= "username,password";
1707 else if (ipp_status
== IPP_REQUEST_VALUE
)
1710 * Print file is too large, abort this job...
1721 * We can't re-submit when we have no files to print, so exit
1722 * immediately with the right status code...
1729 else if ((job_id_attr
= ippFindAttribute(response
, "job-id",
1730 IPP_TAG_INTEGER
)) == NULL
)
1732 fputs("DEBUG: Print job accepted - job ID unknown.\n", stderr
);
1733 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1734 "cups-ipp-missing-job-id");
1740 monitor
.job_id
= job_id
= job_id_attr
->values
[0].integer
;
1741 fprintf(stderr
, "DEBUG: Print job accepted - job ID %d.\n", job_id
);
1744 ippDelete(response
);
1749 if (job_id
&& (num_files
> 1 || create_job
))
1751 for (i
= 0; num_files
== 0 || i
< num_files
; i
++)
1754 * Check for side-channel requests...
1757 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1760 * Send the next file in the job...
1763 request
= ippNewRequest(IPP_SEND_DOCUMENT
);
1764 ippSetVersion(request
, version
/ 10, version
% 10);
1766 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1769 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1773 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1774 "requesting-user-name", NULL
, argv
[2]);
1776 ippAddBoolean(request
, IPP_TAG_OPERATION
, "last-document",
1777 (i
+ 1) >= num_files
);
1779 if (document_format
)
1780 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
1781 "document-format", NULL
, document_format
);
1784 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1785 "compression", NULL
, compression
);
1787 fprintf(stderr
, "DEBUG: Sending file %d using chunking...\n", i
+ 1);
1788 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
1789 debug_attributes(request
);
1791 http_status
= cupsSendRequest(http
, request
, resource
, 0);
1792 if (http_status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
)
1794 if (compression
&& strcmp(compression
, "none"))
1795 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1800 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1804 if ((fd
= open(files
[i
], O_RDONLY
)) < 0)
1806 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1807 return (CUPS_BACKEND_FAILED
);
1816 while (!job_canceled
&& http_status
== HTTP_CONTINUE
&&
1817 (bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1819 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1825 * Check for side-channel requests...
1828 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1836 if (http_status
== HTTP_ERROR
)
1837 fprintf(stderr
, "DEBUG: Error writing document data for "
1838 "Send-Document: %s\n", strerror(httpError(http
)));
1840 response
= cupsGetResponse(http
, resource
);
1843 fprintf(stderr
, "DEBUG: Send-Document: %s (%s)\n",
1844 ippErrorString(cupsLastError()), cupsLastErrorString());
1845 debug_attributes(response
);
1846 ippDelete(response
);
1848 if (cupsLastError() > IPP_OK_CONFLICT
&& !job_canceled
)
1850 ipp_status
= cupsLastError();
1852 _cupsLangPrintFilter(stderr
, "ERROR",
1853 _("Unable to add document to print job."));
1860 if (num_files
== 0 || fd
< 0)
1869 if (ipp_status
<= IPP_OK_CONFLICT
&& argc
> 6)
1871 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
1872 copies_remaining
--;
1874 else if ((ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
|| ipp_status
== IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
) &&
1876 document_format
&& strcmp(document_format
, "image/pwg-raster") && strcmp(document_format
, "image/urf"))
1879 * Need to reprocess the job as raster...
1882 fputs("JOBSTATE: cups-retry-as-raster\n", stderr
);
1884 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1888 else if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
1889 ipp_status
== IPP_NOT_POSSIBLE
||
1890 ipp_status
== IPP_PRINTER_BUSY
)
1895 * Need to reprocess the entire job; if we have a job ID, cancel the
1900 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1906 else if (ipp_status
== IPP_REQUEST_VALUE
||
1907 ipp_status
== IPP_ERROR_JOB_CANCELED
||
1908 ipp_status
== IPP_NOT_AUTHORIZED
||
1909 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1910 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1911 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1912 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
||
1913 ipp_status
== IPP_INTERNAL_ERROR
)
1916 * Print file is too large, job was canceled, we need new
1917 * authentication data, or we had some sort of error...
1922 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
)
1925 * Server is configured incorrectly; the policy for Create-Job and
1926 * Send-Document has to be the same (auth or no auth, encryption or
1927 * no encryption). Force the queue to stop since printing will never
1931 fputs("DEBUG: The server or printer is configured incorrectly.\n",
1933 fputs("DEBUG: The policy for Create-Job and Send-Document must have the "
1934 "same authentication and encryption requirements.\n", stderr
);
1936 ipp_status
= IPP_STATUS_ERROR_INTERNAL
;
1939 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1943 else if (ipp_status
== IPP_NOT_FOUND
)
1946 * Printer does not actually implement support for Create-Job/
1947 * Send-Document, so log the conformance issue and stop the printer.
1950 fputs("DEBUG: This printer claims to support Create-Job and "
1951 "Send-Document, but those operations failed.\n", stderr
);
1952 fputs("DEBUG: Add '?version=1.0' to the device URI to use legacy "
1953 "compatibility mode.\n", stderr
);
1954 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1955 "cups-ipp-missing-send-document");
1957 ipp_status
= IPP_INTERNAL_ERROR
; /* Force queue to stop */
1962 copies_remaining
--;
1965 * Wait for the job to complete...
1968 if (!job_id
|| !waitjob
|| !get_job_attrs
)
1971 fputs("STATE: +cups-waiting-for-job-completed\n", stderr
);
1973 _cupsLangPrintFilter(stderr
, "INFO", _("Waiting for job to complete."));
1975 for (delay
= _cupsNextDelay(0, &prev_delay
), waittime
= time(NULL
) + 30; !job_canceled
;)
1978 * Check for side-channel requests...
1981 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1984 * Check printer state...
1987 check_printer_state(http
, uri
, resource
, argv
[2], version
);
1989 if (cupsLastError() <= IPP_OK_CONFLICT
)
1993 * Build an IPP_GET_JOB_ATTRIBUTES request...
1996 request
= ippNewRequest(IPP_GET_JOB_ATTRIBUTES
);
1997 ippSetVersion(request
, version
/ 10, version
% 10);
1999 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2002 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2006 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2007 "requesting-user-name", NULL
, argv
[2]);
2009 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2010 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
2013 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2014 debug_attributes(request
);
2020 httpReconnect(http
);
2021 response
= cupsDoRequest(http
, request
, resource
);
2022 ipp_status
= cupsLastError();
2024 if (ipp_status
== IPP_NOT_FOUND
|| ipp_status
== IPP_NOT_POSSIBLE
)
2027 * Job has gone away and/or the server has no job history...
2030 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2031 "cups-ipp-missing-job-history");
2032 ippDelete(response
);
2034 ipp_status
= IPP_OK
;
2038 fprintf(stderr
, "DEBUG: Get-Job-Attributes: %s (%s)\n",
2039 ippErrorString(ipp_status
), cupsLastErrorString());
2040 debug_attributes(response
);
2042 if (ipp_status
<= IPP_OK_CONFLICT
)
2046 if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
2047 ipp_status
!= IPP_PRINTER_BUSY
)
2049 ippDelete(response
);
2050 ipp_status
= IPP_OK
;
2053 else if (ipp_status
== IPP_INTERNAL_ERROR
)
2057 if (waitjob_tries
> 4)
2059 ippDelete(response
);
2060 ipp_status
= IPP_OK
;
2068 if ((job_state
= ippFindAttribute(response
, "job-state",
2069 IPP_TAG_ENUM
)) != NULL
)
2072 * Reflect the remote job state in the local queue...
2076 job_state
->values
[0].integer
>= IPP_JOB_PENDING
&&
2077 job_state
->values
[0].integer
<= IPP_JOB_COMPLETED
)
2078 update_reasons(NULL
,
2079 remote_job_states
[job_state
->values
[0].integer
-
2082 if ((job_sheets
= ippFindAttribute(response
, "job-impressions-completed", IPP_TAG_INTEGER
)) == NULL
)
2083 job_sheets
= ippFindAttribute(response
, "job-media-sheets-completed", IPP_TAG_INTEGER
);
2086 fprintf(stderr
, "PAGE: total %d\n",
2087 job_sheets
->values
[0].integer
);
2090 * Stop polling if the job is finished or pending-held for 30 seconds...
2093 if (job_state
->values
[0].integer
> IPP_JSTATE_STOPPED
||
2094 (job_state
->values
[0].integer
== IPP_JSTATE_HELD
&& time(NULL
) > waittime
))
2096 ippDelete(response
);
2100 else if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
2101 ipp_status
!= IPP_NOT_POSSIBLE
&&
2102 ipp_status
!= IPP_PRINTER_BUSY
)
2105 * If the printer does not return a job-state attribute, it does not
2106 * conform to the IPP specification - break out immediately and fail
2110 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2111 "cups-ipp-missing-job-state");
2112 ipp_status
= IPP_INTERNAL_ERROR
;
2117 ippDelete(response
);
2120 * Wait before polling again...
2123 sleep((unsigned)delay
);
2125 delay
= _cupsNextDelay(delay
, &prev_delay
);
2130 * Cancel the job as needed...
2133 if (job_canceled
> 0 && job_id
> 0)
2135 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
2137 if (cupsLastError() > IPP_OK_CONFLICT
)
2138 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2142 * Check the printer state and report it if necessary...
2145 check_printer_state(http
, uri
, resource
, argv
[2], version
);
2147 if (cupsLastError() <= IPP_OK_CONFLICT
)
2151 * Collect the final page count as needed...
2154 if (have_supplies
&&
2155 !backendSNMPSupplies(snmp_fd
, &(http
->addrlist
->addr
), &page_count
,
2157 page_count
> start_count
)
2158 fprintf(stderr
, "PAGE: total %d\n", page_count
- start_count
);
2162 * See if we used Kerberos at all...
2166 auth_info_required
= "negotiate";
2167 #endif /* HAVE_GSSAPI */
2175 cupsFreeOptions(num_options
, options
);
2176 _ppdCacheDestroy(pc
);
2181 ippDelete(supported
);
2184 * Remove the temporary file(s) if necessary...
2188 unlink(tmpfilename
);
2191 * Return the queue status...
2194 if (ipp_status
== IPP_NOT_AUTHORIZED
|| ipp_status
== IPP_FORBIDDEN
||
2195 ipp_status
== IPP_AUTHENTICATION_CANCELED
||
2196 ipp_status
<= IPP_OK_CONFLICT
)
2197 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
2199 if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
)
2200 fputs("JOBSTATE: account-info-needed\n", stderr
);
2201 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
)
2202 fputs("JOBSTATE: account-closed\n", stderr
);
2203 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
)
2204 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2205 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2206 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2208 if (ipp_status
== IPP_NOT_AUTHORIZED
|| ipp_status
== IPP_FORBIDDEN
||
2209 ipp_status
== IPP_AUTHENTICATION_CANCELED
)
2210 return (CUPS_BACKEND_AUTH_REQUIRED
);
2211 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
2212 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
2213 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
2214 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2215 return (CUPS_BACKEND_HOLD
);
2216 else if (ipp_status
== IPP_INTERNAL_ERROR
)
2217 return (CUPS_BACKEND_STOP
);
2218 else if (ipp_status
== IPP_CONFLICT
|| ipp_status
== IPP_STATUS_ERROR_REQUEST_ENTITY
|| ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
)
2219 return (CUPS_BACKEND_FAILED
);
2220 else if (ipp_status
== IPP_REQUEST_VALUE
||
2221 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
2222 ipp_status
== IPP_DOCUMENT_FORMAT
|| job_canceled
< 0)
2224 if (ipp_status
== IPP_REQUEST_VALUE
)
2225 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job too large."));
2226 else if (ipp_status
== IPP_DOCUMENT_FORMAT
)
2227 _cupsLangPrintFilter(stderr
, "ERROR",
2228 _("Printer cannot print supplied content."));
2229 else if (ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
)
2230 _cupsLangPrintFilter(stderr
, "ERROR",
2231 _("Printer cannot print with supplied options."));
2233 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job canceled at printer."));
2235 return (CUPS_BACKEND_CANCEL
);
2237 else if (ipp_status
> IPP_OK_CONFLICT
&& ipp_status
!= IPP_ERROR_JOB_CANCELED
)
2238 return (CUPS_BACKEND_RETRY_CURRENT
);
2240 return (CUPS_BACKEND_OK
);
2245 * 'cancel_job()' - Cancel a print job.
2249 cancel_job(http_t
*http
, /* I - HTTP connection */
2250 const char *uri
, /* I - printer-uri */
2251 int id
, /* I - job-id */
2252 const char *resource
, /* I - Resource path */
2253 const char *user
, /* I - requesting-user-name */
2254 int version
) /* I - IPP version */
2256 ipp_t
*request
; /* Cancel-Job request */
2259 _cupsLangPrintFilter(stderr
, "INFO", _("Canceling print job."));
2261 request
= ippNewRequest(IPP_CANCEL_JOB
);
2262 ippSetVersion(request
, version
/ 10, version
% 10);
2264 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2266 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
2268 if (user
&& user
[0])
2269 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2270 "requesting-user-name", NULL
, user
);
2276 ippDelete(cupsDoRequest(http
, request
, resource
));
2281 * 'check_printer_state()' - Check the printer state.
2284 static ipp_pstate_t
/* O - Current printer-state */
2285 check_printer_state(
2286 http_t
*http
, /* I - HTTP connection */
2287 const char *uri
, /* I - Printer URI */
2288 const char *resource
, /* I - Resource path */
2289 const char *user
, /* I - Username, if any */
2290 int version
) /* I - IPP version */
2292 ipp_t
*request
, /* IPP request */
2293 *response
; /* IPP response */
2294 ipp_attribute_t
*attr
; /* Attribute in response */
2295 ipp_pstate_t printer_state
= IPP_PRINTER_STOPPED
;
2296 /* Current printer-state */
2300 * Send a Get-Printer-Attributes request and log the results...
2303 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
2304 ippSetVersion(request
, version
/ 10, version
% 10);
2306 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2309 if (user
&& user
[0])
2310 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2311 "requesting-user-name", NULL
, user
);
2313 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2314 "requested-attributes",
2315 (int)(sizeof(pattrs
) / sizeof(pattrs
[0])), NULL
, pattrs
);
2317 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2318 debug_attributes(request
);
2320 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
2322 report_printer_state(response
);
2324 if ((attr
= ippFindAttribute(response
, "printer-state",
2325 IPP_TAG_ENUM
)) != NULL
)
2326 printer_state
= (ipp_pstate_t
)attr
->values
[0].integer
;
2329 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
2330 ippErrorString(cupsLastError()), cupsLastErrorString());
2331 debug_attributes(response
);
2332 ippDelete(response
);
2335 * Return the printer-state value...
2338 return (printer_state
);
2343 * 'debug_attributes()' - Print out the request or response attributes as DEBUG
2348 debug_attributes(ipp_t
*ipp
) /* I - Request or response message */
2350 ipp_tag_t group
; /* Current group */
2351 ipp_attribute_t
*attr
; /* Current attribute */
2352 char buffer
[1024]; /* Value buffer */
2355 for (group
= IPP_TAG_ZERO
, attr
= ippFirstAttribute(ipp
);
2357 attr
= ippNextAttribute(ipp
))
2359 const char *name
= ippGetName(attr
);
2363 group
= IPP_TAG_ZERO
;
2367 if (group
!= ippGetGroupTag(attr
))
2369 group
= ippGetGroupTag(attr
);
2370 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(group
));
2373 if (!strcmp(name
, "job-password"))
2374 strlcpy(buffer
, "---", sizeof(buffer
));
2376 ippAttributeString(attr
, buffer
, sizeof(buffer
));
2378 fprintf(stderr
, "DEBUG: %s %s%s %s\n", name
,
2379 ippGetCount(attr
) > 1 ? "1setOf " : "",
2380 ippTagString(ippGetValueTag(attr
)), buffer
);
2383 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(IPP_TAG_END
));
2388 * 'monitor_printer()' - Monitor the printer state.
2391 static void * /* O - Thread exit code */
2393 _cups_monitor_t
*monitor
) /* I - Monitoring data */
2395 http_t
*http
; /* Connection to printer */
2396 ipp_t
*request
, /* IPP request */
2397 *response
; /* IPP response */
2398 ipp_attribute_t
*attr
; /* Attribute in response */
2399 int delay
, /* Current delay */
2400 prev_delay
; /* Previous delay */
2401 ipp_op_t job_op
; /* Operation to use */
2402 int job_id
; /* Job ID */
2403 const char *job_name
; /* Job name */
2404 ipp_jstate_t job_state
; /* Job state */
2405 const char *job_user
; /* Job originating user name */
2406 int password_tries
= 0; /* Password tries */
2410 * Make a copy of the printer connection...
2413 http
= httpConnect2(monitor
->hostname
, monitor
->port
, NULL
, AF_UNSPEC
,
2414 monitor
->encryption
, 1, 0, NULL
);
2415 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
2417 cupsSetUser(username
);
2419 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
2422 * Loop until the job is canceled, aborted, or completed.
2425 delay
= _cupsNextDelay(0, &prev_delay
);
2427 monitor
->job_reasons
= 0;
2429 while (monitor
->job_state
< IPP_JOB_CANCELED
&& !job_canceled
)
2432 * Reconnect to the printer as needed...
2435 if (httpGetFd(http
) < 0)
2436 httpReconnect(http
);
2438 if (httpGetFd(http
) >= 0)
2441 * Connected, so check on the printer state...
2444 monitor
->printer_state
= check_printer_state(http
, monitor
->uri
,
2448 if (cupsLastError() <= IPP_OK_CONFLICT
)
2451 if (monitor
->job_id
== 0 && monitor
->create_job
)
2454 * No job-id yet, so continue...
2461 * Check the status of the job itself...
2464 job_op
= (monitor
->job_id
> 0 && monitor
->get_job_attrs
) ?
2465 IPP_GET_JOB_ATTRIBUTES
: IPP_GET_JOBS
;
2466 request
= ippNewRequest(job_op
);
2467 ippSetVersion(request
, monitor
->version
/ 10, monitor
->version
% 10);
2469 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2470 NULL
, monitor
->uri
);
2471 if (job_op
== IPP_GET_JOB_ATTRIBUTES
)
2472 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2475 if (monitor
->user
&& monitor
->user
[0])
2476 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2477 "requesting-user-name", NULL
, monitor
->user
);
2479 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2480 "requested-attributes",
2481 (int)(sizeof(jattrs
) / sizeof(jattrs
[0])), NULL
, jattrs
);
2487 response
= cupsDoRequest(http
, request
, monitor
->resource
);
2489 fprintf(stderr
, "DEBUG: (monitor) %s: %s (%s)\n", ippOpString(job_op
),
2490 ippErrorString(cupsLastError()), cupsLastErrorString());
2492 if (cupsLastError() <= IPP_OK_CONFLICT
)
2495 if (job_op
== IPP_GET_JOB_ATTRIBUTES
)
2497 if ((attr
= ippFindAttribute(response
, "job-state",
2498 IPP_TAG_ENUM
)) != NULL
)
2499 monitor
->job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2501 monitor
->job_state
= IPP_JOB_COMPLETED
;
2505 for (attr
= response
->attrs
; attr
; attr
= attr
->next
)
2509 job_state
= IPP_JOB_PENDING
;
2512 while (attr
&& attr
->group_tag
!= IPP_TAG_JOB
)
2518 while (attr
&& attr
->group_tag
== IPP_TAG_JOB
)
2520 if (!strcmp(attr
->name
, "job-id") &&
2521 attr
->value_tag
== IPP_TAG_INTEGER
)
2522 job_id
= attr
->values
[0].integer
;
2523 else if (!strcmp(attr
->name
, "job-name") &&
2524 (attr
->value_tag
== IPP_TAG_NAME
||
2525 attr
->value_tag
== IPP_TAG_NAMELANG
))
2526 job_name
= attr
->values
[0].string
.text
;
2527 else if (!strcmp(attr
->name
, "job-state") &&
2528 attr
->value_tag
== IPP_TAG_ENUM
)
2529 job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2530 else if (!strcmp(attr
->name
, "job-originating-user-name") &&
2531 (attr
->value_tag
== IPP_TAG_NAME
||
2532 attr
->value_tag
== IPP_TAG_NAMELANG
))
2533 job_user
= attr
->values
[0].string
.text
;
2538 if (job_id
> 0 && job_name
&& !strcmp(job_name
, monitor
->job_name
) &&
2539 job_user
&& monitor
->user
&& !strcmp(job_user
, monitor
->user
))
2541 monitor
->job_id
= job_id
;
2542 monitor
->job_state
= job_state
;
2551 fprintf(stderr
, "DEBUG: (monitor) job-state = %s\n",
2552 ippEnumString("job-state", monitor
->job_state
));
2554 if (!job_canceled
&&
2555 (monitor
->job_state
== IPP_JOB_CANCELED
||
2556 monitor
->job_state
== IPP_JOB_ABORTED
))
2559 fprintf(stderr
, "DEBUG: (monitor) job_canceled = -1\n");
2562 if ((attr
= ippFindAttribute(response
, "job-state-reasons",
2563 IPP_TAG_KEYWORD
)) != NULL
)
2565 int i
, new_reasons
= 0; /* Looping var, new reasons */
2567 for (i
= 0; i
< attr
->num_values
; i
++)
2569 if (!strcmp(attr
->values
[i
].string
.text
,
2570 "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
,
2577 "account-limit-reached"))
2578 new_reasons
|= _CUPS_JSR_ACCOUNT_LIMIT_REACHED
;
2579 else if (!strcmp(attr
->values
[i
].string
.text
, "job-password-wait"))
2580 new_reasons
|= _CUPS_JSR_JOB_PASSWORD_WAIT
;
2581 else if (!strcmp(attr
->values
[i
].string
.text
, "job-release-wait"))
2582 new_reasons
|= _CUPS_JSR_JOB_RELEASE_WAIT
;
2583 if (!job_canceled
&&
2584 (!strncmp(attr
->values
[i
].string
.text
, "job-canceled-", 13) || !strcmp(attr
->values
[i
].string
.text
, "aborted-by-system")))
2588 if (new_reasons
!= monitor
->job_reasons
)
2590 if (new_reasons
& _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
)
2591 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2592 else if (new_reasons
& _CUPS_JSR_ACCOUNT_CLOSED
)
2593 fputs("JOBSTATE: account-closed\n", stderr
);
2594 else if (new_reasons
& _CUPS_JSR_ACCOUNT_INFO_NEEDED
)
2595 fputs("JOBSTATE: account-info-needed\n", stderr
);
2596 else if (new_reasons
& _CUPS_JSR_ACCOUNT_LIMIT_REACHED
)
2597 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2598 else if (new_reasons
& _CUPS_JSR_JOB_PASSWORD_WAIT
)
2599 fputs("JOBSTATE: job-password-wait\n", stderr
);
2600 else if (new_reasons
& _CUPS_JSR_JOB_RELEASE_WAIT
)
2601 fputs("JOBSTATE: job-release-wait\n", stderr
);
2603 fputs("JOBSTATE: job-printing\n", stderr
);
2605 monitor
->job_reasons
= new_reasons
;
2609 ippDelete(response
);
2611 fprintf(stderr
, "DEBUG: (monitor) job-state = %s\n",
2612 ippEnumString("job-state", monitor
->job_state
));
2614 if (!job_canceled
&&
2615 (monitor
->job_state
== IPP_JOB_CANCELED
||
2616 monitor
->job_state
== IPP_JOB_ABORTED
))
2621 * Sleep for N seconds...
2626 sleep((unsigned)delay
);
2628 delay
= _cupsNextDelay(delay
, &prev_delay
);
2632 * Cancel the job if necessary...
2635 if (job_canceled
> 0 && monitor
->job_id
> 0)
2637 if (httpGetFd(http
) < 0)
2638 httpReconnect(http
);
2640 if (httpGetFd(http
) >= 0)
2642 cancel_job(http
, monitor
->uri
, monitor
->job_id
, monitor
->resource
,
2643 monitor
->user
, monitor
->version
);
2645 if (cupsLastError() > IPP_OK_CONFLICT
)
2647 fprintf(stderr
, "DEBUG: (monitor) cancel_job() = %s\n", cupsLastErrorString());
2648 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2654 * Cleanup and return...
2664 * 'new_request()' - Create a new print creation or validation request.
2667 static ipp_t
* /* O - Request data */
2669 ipp_op_t op
, /* I - IPP operation code */
2670 int version
, /* I - IPP version number */
2671 const char *uri
, /* I - printer-uri value */
2672 const char *user
, /* I - requesting-user-name value */
2673 const char *title
, /* I - job-name value */
2674 int num_options
, /* I - Number of options to send */
2675 cups_option_t
*options
, /* I - Options to send */
2676 const char *compression
, /* I - compression value or NULL */
2677 int copies
, /* I - copies value or 0 */
2678 const char *format
, /* I - document-format value or NULL */
2679 _ppd_cache_t
*pc
, /* I - PPD cache and mapping data */
2680 ppd_file_t
*ppd
, /* I - PPD file data */
2681 ipp_attribute_t
*media_col_sup
, /* I - media-col-supported values */
2682 ipp_attribute_t
*doc_handling_sup
, /* I - multiple-document-handling-supported values */
2683 ipp_attribute_t
*print_color_mode_sup
)
2684 /* I - Printer supports print-color-mode */
2686 ipp_t
*request
; /* Request data */
2687 const char *keyword
; /* PWG keyword */
2691 * Create the IPP request...
2694 request
= ippNewRequest(op
);
2695 ippSetVersion(request
, version
/ 10, version
% 10);
2697 fprintf(stderr
, "DEBUG: %s IPP/%d.%d\n",
2698 ippOpString(request
->request
.op
.operation_id
),
2699 request
->request
.op
.version
[0],
2700 request
->request
.op
.version
[1]);
2703 * Add standard attributes...
2706 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
2707 fprintf(stderr
, "DEBUG: printer-uri=\"%s\"\n", uri
);
2711 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "requesting-user-name", NULL
, user
);
2712 fprintf(stderr
, "DEBUG: requesting-user-name=\"%s\"\n", user
);
2715 if (title
&& *title
)
2717 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
, title
);
2718 fprintf(stderr
, "DEBUG: job-name=\"%s\"\n", title
);
2721 if (format
&& op
!= IPP_CREATE_JOB
)
2723 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, format
);
2724 fprintf(stderr
, "DEBUG: document-format=\"%s\"\n", format
);
2728 if (compression
&& op
!= IPP_OP_CREATE_JOB
&& op
!= IPP_OP_VALIDATE_JOB
)
2730 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "compression", NULL
, compression
);
2731 fprintf(stderr
, "DEBUG: compression=\"%s\"\n", compression
);
2733 #endif /* HAVE_LIBZ */
2736 * Handle options on the command-line...
2739 if (num_options
> 0)
2744 * Send standard IPP attributes...
2747 fputs("DEBUG: Adding standard IPP operation/job attributes.\n", stderr
);
2749 copies
= _cupsConvertOptions(request
, ppd
, pc
, media_col_sup
, doc_handling_sup
, print_color_mode_sup
, user
, format
, copies
, num_options
, options
);
2752 * Map FaxOut options...
2755 if ((keyword
= cupsGetOption("phone", num_options
, options
)) != NULL
)
2757 ipp_t
*destination
; /* destination collection */
2758 char phone
[1024], /* Phone number string */
2759 *ptr
, /* Pointer into string */
2760 tel_uri
[1024]; /* tel: URI */
2761 static const char * const allowed
= "0123456789#*-+.()";
2762 /* Allowed characters */
2764 destination
= ippNew();
2767 * Unescape and filter out spaces and other characters that are not
2768 * allowed in a tel: URI.
2771 _httpDecodeURI(phone
, keyword
, sizeof(phone
));
2772 for (ptr
= phone
; *ptr
;)
2774 if (!strchr(allowed
, *ptr
))
2775 _cups_strcpy(ptr
, ptr
+ 1);
2780 httpAssembleURI(HTTP_URI_CODING_ALL
, tel_uri
, sizeof(tel_uri
), "tel", NULL
, NULL
, 0, phone
);
2781 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_URI
, "destination-uri", NULL
, tel_uri
);
2783 if ((keyword
= cupsGetOption("faxPrefix", num_options
,
2784 options
)) != NULL
&& *keyword
)
2786 char predial
[1024]; /* Pre-dial string */
2788 _httpDecodeURI(predial
, keyword
, sizeof(predial
));
2789 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_TEXT
, "pre-dial-string", NULL
, predial
);
2792 ippAddCollection(request
, IPP_TAG_JOB
, "destination-uris", destination
);
2793 ippDelete(destination
);
2799 * When talking to another CUPS server, send all options...
2802 fputs("DEBUG: Adding all operation/job attributes.\n", stderr
);
2803 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_OPERATION
);
2804 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_JOB
);
2807 if (copies
> 1 && (!pc
|| copies
<= pc
->max_copies
))
2808 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies", copies
);
2811 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2812 debug_attributes(request
);
2819 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
2822 static const char * /* O - Password */
2823 password_cb(const char *prompt
, /* I - Prompt (not used) */
2824 http_t
*http
, /* I - Connection */
2825 const char *method
, /* I - Request method (not used) */
2826 const char *resource
, /* I - Resource path (not used) */
2827 int *password_tries
) /* I - Password tries */
2829 char def_username
[HTTP_MAX_VALUE
]; /* Default username */
2832 fprintf(stderr
, "DEBUG: password_cb(prompt=\"%s\", http=%p, method=\"%s\", "
2833 "resource=\"%s\", password_tries=%p(%d)), password=%p\n",
2834 prompt
, http
, method
, resource
, password_tries
, *password_tries
,
2841 if (!uri_credentials
)
2844 * Remember that we need to authenticate...
2847 auth_info_required
= "username,password";
2849 if (httpGetSubField(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "username",
2852 char quoted
[HTTP_MAX_VALUE
* 2 + 4];
2855 fprintf(stderr
, "ATTR: auth-info-default=%s,\n",
2856 quote_string(def_username
, quoted
, sizeof(quoted
)));
2860 if (password
&& *password
&& *password_tries
< 3)
2862 (*password_tries
) ++;
2864 cupsSetUser(username
);
2871 * Give up after 3 tries or if we don't have a password to begin with...
2880 * 'quote_string()' - Quote a string value.
2883 static const char * /* O - Quoted string */
2884 quote_string(const char *s
, /* I - String */
2885 char *q
, /* I - Quoted string buffer */
2886 size_t qsize
) /* I - Size of quoted string buffer */
2888 char *qptr
, /* Pointer into string buffer */
2889 *qend
; /* End of string buffer */
2893 qend
= q
+ qsize
- 5;
2904 while (*s
&& qptr
< qend
)
2906 if (*s
== '\\' || *s
== '\"' || *s
== '\'')
2908 if (qptr
< (qend
- 4))
2930 * 'report_attr()' - Report an IPP attribute value.
2934 report_attr(ipp_attribute_t
*attr
) /* I - Attribute */
2936 int i
; /* Looping var */
2937 char value
[1024], /* Value string */
2938 *valptr
; /* Pointer into value string */
2939 const char *cached
; /* Cached attribute */
2943 * Convert the attribute values into quoted strings...
2946 for (i
= 0, valptr
= value
;
2947 i
< attr
->num_values
&& valptr
< (value
+ sizeof(value
) - 10);
2953 switch (attr
->value_tag
)
2955 case IPP_TAG_INTEGER
:
2957 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), "%d", attr
->values
[i
].integer
);
2958 valptr
+= strlen(valptr
);
2963 case IPP_TAG_KEYWORD
:
2964 quote_string(attr
->values
[i
].string
.text
, valptr
, (size_t)(value
+ sizeof(value
) - valptr
));
2965 valptr
+= strlen(valptr
);
2970 * Unsupported value type...
2979 _cupsMutexLock(&report_mutex
);
2981 if ((cached
= cupsGetOption(attr
->name
, num_attr_cache
,
2982 attr_cache
)) == NULL
|| strcmp(cached
, value
))
2985 * Tell the scheduler about the new values...
2988 num_attr_cache
= cupsAddOption(attr
->name
, value
, num_attr_cache
,
2990 fprintf(stderr
, "ATTR: %s=%s\n", attr
->name
, value
);
2993 _cupsMutexUnlock(&report_mutex
);
2998 * 'report_printer_state()' - Report the printer state.
3002 report_printer_state(ipp_t
*ipp
) /* I - IPP response */
3004 ipp_attribute_t
*pa
, /* printer-alert */
3005 *pam
, /* printer-alert-message */
3006 *pmja
, /* printer-mandatory-job-attributes */
3007 *psm
, /* printer-state-message */
3008 *reasons
, /* printer-state-reasons */
3009 *marker
; /* marker-* attributes */
3010 char value
[1024], /* State/message string */
3011 *valptr
; /* Pointer into string */
3012 static int ipp_supplies
= -1;
3013 /* Report supply levels? */
3017 * Report alerts and messages...
3020 if ((pa
= ippFindAttribute(ipp
, "printer-alert", IPP_TAG_TEXT
)) != NULL
)
3023 if ((pam
= ippFindAttribute(ipp
, "printer-alert-message",
3024 IPP_TAG_TEXT
)) != NULL
)
3027 if ((pmja
= ippFindAttribute(ipp
, "printer-mandatory-job-attributes", IPP_TAG_KEYWORD
)) != NULL
)
3029 int i
, /* Looping var */
3030 count
= ippGetCount(pmja
); /* Number of values */
3032 for (i
= 0, valptr
= value
; i
< count
; i
++, valptr
+= strlen(valptr
))
3035 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), " %s", ippGetString(pmja
, i
, NULL
));
3037 strlcpy(value
, ippGetString(pmja
, i
, NULL
), sizeof(value
));
3040 if (strcmp(value
, mandatory_attrs
))
3042 strlcpy(mandatory_attrs
, value
, sizeof(mandatory_attrs
));
3043 fprintf(stderr
, "PPD: cupsMandatory=\"%s\"\n", value
);
3047 if ((psm
= ippFindAttribute(ipp
, "printer-state-message",
3048 IPP_TAG_TEXT
)) != NULL
)
3050 char *ptr
; /* Pointer into message */
3053 strlcpy(value
, "INFO: ", sizeof(value
));
3054 for (ptr
= psm
->values
[0].string
.text
, valptr
= value
+ 6;
3055 *ptr
&& valptr
< (value
+ sizeof(value
) - 6);
3058 if (*ptr
< ' ' && *ptr
> 0 && *ptr
!= '\t')
3061 * Substitute "<XX>" for the control character; sprintf is safe because
3062 * we always leave 6 chars free at the end...
3065 sprintf(valptr
, "<%02X>", *ptr
);
3075 fputs(value
, stderr
);
3079 * Now report printer-state-reasons, filtering out some of the reasons we never
3083 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
3084 IPP_TAG_KEYWORD
)) == NULL
)
3087 update_reasons(reasons
, NULL
);
3090 * Relay the current marker-* attribute values...
3093 if (ipp_supplies
< 0)
3095 ppd_file_t
*ppd
; /* PPD file */
3096 ppd_attr_t
*ppdattr
; /* Attribute in PPD file */
3098 if ((ppd
= ppdOpenFile(getenv("PPD"))) != NULL
&&
3099 (ppdattr
= ppdFindAttr(ppd
, "cupsIPPSupplies", NULL
)) != NULL
&&
3100 ppdattr
->value
&& _cups_strcasecmp(ppdattr
->value
, "true"))
3108 if (ipp_supplies
> 0)
3110 if ((marker
= ippFindAttribute(ipp
, "marker-colors", IPP_TAG_NAME
)) != NULL
)
3111 report_attr(marker
);
3112 if ((marker
= ippFindAttribute(ipp
, "marker-high-levels",
3113 IPP_TAG_INTEGER
)) != NULL
)
3114 report_attr(marker
);
3115 if ((marker
= ippFindAttribute(ipp
, "marker-levels",
3116 IPP_TAG_INTEGER
)) != NULL
)
3117 report_attr(marker
);
3118 if ((marker
= ippFindAttribute(ipp
, "marker-low-levels",
3119 IPP_TAG_INTEGER
)) != NULL
)
3120 report_attr(marker
);
3121 if ((marker
= ippFindAttribute(ipp
, "marker-message",
3122 IPP_TAG_TEXT
)) != NULL
)
3123 report_attr(marker
);
3124 if ((marker
= ippFindAttribute(ipp
, "marker-names", IPP_TAG_NAME
)) != NULL
)
3125 report_attr(marker
);
3126 if ((marker
= ippFindAttribute(ipp
, "marker-types",
3127 IPP_TAG_KEYWORD
)) != NULL
)
3128 report_attr(marker
);
3133 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3135 * 'run_as_user()' - Run the IPP backend as the printing user.
3137 * This function uses an XPC-based user agent to run the backend as the printing
3138 * user. We need to do this in order to have access to the user's Kerberos
3142 static int /* O - Exit status */
3143 run_as_user(char *argv
[], /* I - Command-line arguments */
3144 uid_t uid
, /* I - User ID */
3145 const char *device_uri
, /* I - Device URI */
3146 int fd
) /* I - File to print */
3148 const char *auth_negotiate
;/* AUTH_NEGOTIATE env var */
3149 xpc_connection_t conn
; /* Connection to XPC service */
3150 xpc_object_t request
; /* Request message dictionary */
3151 __block xpc_object_t response
; /* Response message dictionary */
3152 dispatch_semaphore_t sem
; /* Semaphore for waiting for response */
3153 int status
= CUPS_BACKEND_FAILED
;
3154 /* Status of request */
3157 fprintf(stderr
, "DEBUG: Running IPP backend as UID %d.\n", (int)uid
);
3160 * Connect to the user agent for the specified UID...
3163 conn
= xpc_connection_create_mach_service(kPMPrintUIToolAgent
,
3164 dispatch_get_global_queue(0, 0), 0);
3167 _cupsLangPrintFilter(stderr
, "ERROR",
3168 _("Unable to start backend process."));
3169 fputs("DEBUG: Unable to create connection to agent.\n", stderr
);
3173 xpc_connection_set_event_handler(conn
,
3174 ^(xpc_object_t event
)
3176 xpc_type_t messageType
= xpc_get_type(event
);
3178 if (messageType
== XPC_TYPE_ERROR
)
3180 if (event
== XPC_ERROR_CONNECTION_INTERRUPTED
)
3181 fprintf(stderr
, "DEBUG: Interrupted connection to service %s.\n",
3182 xpc_connection_get_name(conn
));
3183 else if (event
== XPC_ERROR_CONNECTION_INVALID
)
3184 fprintf(stderr
, "DEBUG: Connection invalid for service %s.\n",
3185 xpc_connection_get_name(conn
));
3187 fprintf(stderr
, "DEBUG: Unxpected error for service %s: %s\n",
3188 xpc_connection_get_name(conn
),
3189 xpc_dictionary_get_string(event
, XPC_ERROR_KEY_DESCRIPTION
));
3192 xpc_connection_set_target_uid(conn
, uid
);
3193 xpc_connection_resume(conn
);
3196 * Try starting the backend...
3199 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3200 xpc_dictionary_set_int64(request
, "command", kPMStartJob
);
3201 xpc_dictionary_set_string(request
, "device-uri", device_uri
);
3202 xpc_dictionary_set_string(request
, "job-id", argv
[1]);
3203 xpc_dictionary_set_string(request
, "user", argv
[2]);
3204 xpc_dictionary_set_string(request
, "title", argv
[3]);
3205 xpc_dictionary_set_string(request
, "copies", argv
[4]);
3206 xpc_dictionary_set_string(request
, "options", argv
[5]);
3207 xpc_dictionary_set_string(request
, "auth-info-required",
3208 getenv("AUTH_INFO_REQUIRED"));
3209 if ((auth_negotiate
= getenv("AUTH_NEGOTIATE")) != NULL
)
3210 xpc_dictionary_set_string(request
, "auth-negotiate", auth_negotiate
);
3211 xpc_dictionary_set_fd(request
, "stdin", fd
);
3212 xpc_dictionary_set_fd(request
, "stderr", 2);
3213 xpc_dictionary_set_fd(request
, "side-channel", CUPS_SC_FD
);
3215 sem
= dispatch_semaphore_create(0);
3218 xpc_connection_send_message_with_reply(conn
, request
,
3219 dispatch_get_global_queue(0,0),
3220 ^(xpc_object_t reply
)
3222 /* Save the response and wake up */
3223 if (xpc_get_type(reply
)
3224 == XPC_TYPE_DICTIONARY
)
3225 response
= xpc_retain(reply
);
3227 dispatch_semaphore_signal(sem
);
3230 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3231 xpc_release(request
);
3232 dispatch_release(sem
);
3236 child_pid
= (pid_t
)xpc_dictionary_get_int64(response
, "child-pid");
3238 xpc_release(response
);
3241 fprintf(stderr
, "DEBUG: Child PID=%d.\n", (int)child_pid
);
3244 _cupsLangPrintFilter(stderr
, "ERROR",
3245 _("Unable to start backend process."));
3246 fputs("DEBUG: No child PID.\n", stderr
);
3252 _cupsLangPrintFilter(stderr
, "ERROR",
3253 _("Unable to start backend process."));
3254 fputs("DEBUG: No reply from agent.\n", stderr
);
3259 * Then wait for the backend to finish...
3262 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3263 xpc_dictionary_set_int64(request
, "command", kPMWaitForJob
);
3264 xpc_dictionary_set_fd(request
, "stderr", 2);
3266 sem
= dispatch_semaphore_create(0);
3269 xpc_connection_send_message_with_reply(conn
, request
,
3270 dispatch_get_global_queue(0,0),
3271 ^(xpc_object_t reply
)
3273 /* Save the response and wake up */
3274 if (xpc_get_type(reply
)
3275 == XPC_TYPE_DICTIONARY
)
3276 response
= xpc_retain(reply
);
3278 dispatch_semaphore_signal(sem
);
3281 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3282 xpc_release(request
);
3283 dispatch_release(sem
);
3287 status
= (int)xpc_dictionary_get_int64(response
, "status");
3289 if (status
== SIGTERM
|| status
== SIGKILL
|| status
== SIGPIPE
)
3291 fprintf(stderr
, "DEBUG: Child terminated on signal %d.\n", status
);
3292 status
= CUPS_BACKEND_FAILED
;
3294 else if (WIFSIGNALED(status
))
3296 fprintf(stderr
, "DEBUG: Child crashed on signal %d.\n", status
);
3297 status
= CUPS_BACKEND_STOP
;
3299 else if (WIFEXITED(status
))
3301 status
= WEXITSTATUS(status
);
3302 fprintf(stderr
, "DEBUG: Child exited with status %d.\n", status
);
3305 xpc_release(response
);
3308 _cupsLangPrintFilter(stderr
, "ERROR",
3309 _("Unable to get backend exit status."));
3315 xpc_connection_cancel(conn
);
3321 #endif /* HAVE_GSSAPI && HAVE_XPC */
3325 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
3329 sigterm_handler(int sig
) /* I - Signal */
3331 (void)sig
; /* remove compiler warnings... */
3333 write(2, "DEBUG: Got SIGTERM.\n", 20);
3335 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3338 kill(child_pid
, sig
);
3341 #endif /* HAVE_GSSAPI && HAVE_XPC */
3346 * Flag that the job should be canceled...
3349 write(2, "DEBUG: sigterm_handler: job_canceled = 1.\n", 25);
3356 * The scheduler already tried to cancel us once, now just terminate
3357 * after removing our temp file!
3361 unlink(tmpfilename
);
3368 * 'timeout_cb()' - Handle HTTP timeouts.
3371 static int /* O - 1 to continue, 0 to cancel */
3372 timeout_cb(http_t
*http
, /* I - Connection to server (unused) */
3373 void *user_data
) /* I - User data (unused) */
3378 return (!job_canceled
);
3383 * 'update_reasons()' - Update the printer-state-reasons values.
3387 update_reasons(ipp_attribute_t
*attr
, /* I - printer-state-reasons or NULL */
3388 const char *s
) /* I - STATE: string or NULL */
3390 char op
; /* Add (+), remove (-), replace (\0) */
3391 cups_array_t
*new_reasons
; /* New reasons array */
3392 char *reason
, /* Current reason */
3393 add
[2048], /* Reasons added string */
3394 *addptr
, /* Pointer into add string */
3395 rem
[2048], /* Reasons removed string */
3396 *remptr
; /* Pointer into remove string */
3397 const char *addprefix
, /* Current add string prefix */
3398 *remprefix
; /* Current remove string prefix */
3401 fprintf(stderr
, "DEBUG: update_reasons(attr=%d(%s%s), s=\"%s\")\n",
3402 attr
? attr
->num_values
: 0, attr
? attr
->values
[0].string
.text
: "",
3403 attr
&& attr
->num_values
> 1 ? ",..." : "", s
? s
: "(null)");
3406 * Create an array of new reason keyword strings...
3411 int i
; /* Looping var */
3413 new_reasons
= cupsArrayNew((cups_array_func_t
)strcmp
, NULL
);
3416 for (i
= 0; i
< attr
->num_values
; i
++)
3418 reason
= attr
->values
[i
].string
.text
;
3420 if (strcmp(reason
, "none") &&
3421 strcmp(reason
, "none-report") &&
3422 strcmp(reason
, "paused") &&
3423 strncmp(reason
, "spool-area-full", 15) &&
3424 strcmp(reason
, "com.apple.print.recoverable-warning") &&
3425 strncmp(reason
, "cups-", 5))
3426 cupsArrayAdd(new_reasons
, reason
);
3431 if (*s
== '+' || *s
== '-')
3436 new_reasons
= _cupsArrayNewStrings(s
, ',');
3442 * Compute the changes...
3446 addprefix
= "STATE: +";
3449 remprefix
= "STATE: -";
3452 fprintf(stderr
, "DEBUG2: op='%c', new_reasons=%d, state_reasons=%d\n",
3453 op
? op
: ' ', cupsArrayCount(new_reasons
),
3454 cupsArrayCount(state_reasons
));
3456 _cupsMutexLock(&report_mutex
);
3464 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3466 reason
= (char *)cupsArrayNext(new_reasons
))
3468 if (!cupsArrayFind(state_reasons
, reason
))
3470 if (!strncmp(reason
, "cups-remote-", 12))
3473 * If we are setting cups-remote-xxx, remove all other cups-remote-xxx
3477 char *temp
; /* Current reason in state_reasons */
3479 cupsArraySave(state_reasons
);
3481 for (temp
= (char *)cupsArrayFirst(state_reasons
);
3483 temp
= (char *)cupsArrayNext(state_reasons
))
3484 if (!strncmp(temp
, "cups-remote-", 12))
3486 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, temp
);
3487 remptr
+= strlen(remptr
);
3490 cupsArrayRemove(state_reasons
, temp
);
3494 cupsArrayRestore(state_reasons
);
3497 cupsArrayAdd(state_reasons
, reason
);
3499 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3500 addptr
+= strlen(addptr
);
3511 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3513 reason
= (char *)cupsArrayNext(new_reasons
))
3515 if (cupsArrayFind(state_reasons
, reason
))
3517 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3518 remptr
+= strlen(remptr
);
3521 cupsArrayRemove(state_reasons
, reason
);
3528 * Replace reasons...
3531 for (reason
= (char *)cupsArrayFirst(state_reasons
);
3533 reason
= (char *)cupsArrayNext(state_reasons
))
3535 if (strncmp(reason
, "cups-", 5) && !cupsArrayFind(new_reasons
, reason
))
3537 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3538 remptr
+= strlen(remptr
);
3541 cupsArrayRemove(state_reasons
, reason
);
3545 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3547 reason
= (char *)cupsArrayNext(new_reasons
))
3549 if (!cupsArrayFind(state_reasons
, reason
))
3551 cupsArrayAdd(state_reasons
, reason
);
3553 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3554 addptr
+= strlen(addptr
);
3560 _cupsMutexUnlock(&report_mutex
);
3563 * Report changes and return...
3566 if (add
[0] && rem
[0])
3567 fprintf(stderr
, "%s\n%s\n", add
, rem
);
3569 fprintf(stderr
, "%s\n", add
);
3571 fprintf(stderr
, "%s\n", rem
);