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 *monitor_printer(_cups_monitor_t
*monitor
);
164 static ipp_t
*new_request(ipp_op_t op
, int version
, const char *uri
,
165 const char *user
, const char *title
,
166 int num_options
, cups_option_t
*options
,
167 const char *compression
, int copies
,
168 const char *format
, _ppd_cache_t
*pc
,
170 ipp_attribute_t
*media_col_sup
,
171 ipp_attribute_t
*doc_handling_sup
,
172 ipp_attribute_t
*print_color_mode_sup
);
173 static const char *password_cb(const char *prompt
, http_t
*http
,
174 const char *method
, const char *resource
,
176 static const char *quote_string(const char *s
, char *q
, size_t qsize
);
177 static void report_attr(ipp_attribute_t
*attr
);
178 static void report_printer_state(ipp_t
*ipp
);
179 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
180 static int run_as_user(char *argv
[], uid_t uid
,
181 const char *device_uri
, int fd
);
182 #endif /* HAVE_GSSAPI && HAVE_XPC */
183 static void sigterm_handler(int sig
);
184 static int timeout_cb(http_t
*http
, void *user_data
);
185 static void update_reasons(ipp_attribute_t
*attr
, const char *s
);
189 * 'main()' - Send a file to the printer or server.
193 * printer-uri job-id user title copies options [file]
196 int /* O - Exit status */
197 main(int argc
, /* I - Number of command-line args */
198 char *argv
[]) /* I - Command-line arguments */
200 int i
; /* Looping var */
201 int send_options
; /* Send job options? */
202 int num_options
; /* Number of printer options */
203 cups_option_t
*options
; /* Printer options */
204 const char *device_uri
; /* Device URI */
205 char scheme
[255], /* Scheme in URI */
206 hostname
[1024], /* Hostname */
207 resource
[1024], /* Resource info (printer name) */
208 addrname
[256], /* Address name */
209 *optptr
, /* Pointer to URI options */
210 *name
, /* Name of option */
211 *value
, /* Value of option */
212 sep
; /* Separator character */
213 int password_tries
= 0; /* Password tries */
214 http_addrlist_t
*addrlist
; /* Address of printer */
215 int snmp_enabled
= 1; /* Is SNMP enabled? */
216 int snmp_fd
, /* SNMP socket */
217 start_count
, /* Page count via SNMP at start */
218 page_count
, /* Page count via SNMP */
219 have_supplies
; /* Printer supports supply levels? */
220 int num_files
; /* Number of files to print */
221 char **files
, /* Files to print */
222 *compatfile
= NULL
; /* Compatibility filename */
223 off_t compatsize
= 0; /* Size of compatibility file */
224 int port
; /* Port number (not used) */
225 char portname
[255]; /* Port name */
226 char uri
[HTTP_MAX_URI
]; /* Updated URI without user/pass */
227 char print_job_name
[1024]; /* Update job-name for Print-Job */
228 http_status_t http_status
; /* Status of HTTP request */
229 ipp_status_t ipp_status
; /* Status of IPP request */
230 http_t
*http
; /* HTTP connection */
231 ipp_t
*request
, /* IPP request */
232 *response
, /* IPP response */
233 *supported
; /* get-printer-attributes response */
234 time_t start_time
; /* Time of first connect */
235 int contimeout
; /* Connection timeout */
236 int delay
, /* Delay for retries */
237 prev_delay
; /* Previous delay */
238 const char *compression
; /* Compression mode */
239 int waitjob
, /* Wait for job complete? */
240 waitjob_tries
= 0, /* Number of times we've waited */
241 waitprinter
; /* Wait for printer ready? */
242 time_t waittime
; /* Wait time for held jobs */
243 _cups_monitor_t monitor
; /* Monitoring data */
244 ipp_attribute_t
*job_id_attr
; /* job-id attribute */
245 int job_id
; /* job-id value */
246 ipp_attribute_t
*job_sheets
; /* job-media-sheets-completed */
247 ipp_attribute_t
*job_state
; /* job-state */
249 ipp_attribute_t
*compression_sup
; /* compression-supported */
250 #endif /* HAVE_LIBZ */
251 ipp_attribute_t
*copies_sup
; /* copies-supported */
252 ipp_attribute_t
*cups_version
; /* cups-version */
253 ipp_attribute_t
*encryption_sup
; /* job-password-encryption-supported */
254 ipp_attribute_t
*format_sup
; /* document-format-supported */
255 ipp_attribute_t
*job_auth
; /* job-authorization-uri */
256 ipp_attribute_t
*media_col_sup
; /* media-col-supported */
257 ipp_attribute_t
*operations_sup
; /* operations-supported */
258 ipp_attribute_t
*doc_handling_sup
; /* multiple-document-handling-supported */
259 ipp_attribute_t
*printer_state
; /* printer-state attribute */
260 ipp_attribute_t
*printer_accepting
; /* printer-is-accepting-jobs */
261 ipp_attribute_t
*print_color_mode_sup
;/* Does printer support print-color-mode? */
262 int create_job
= 0, /* Does printer support Create-Job? */
263 get_job_attrs
= 0, /* Does printer support Get-Job-Attributes? */
264 send_document
= 0, /* Does printer support Send-Document? */
265 validate_job
= 0, /* Does printer support Validate-Job? */
266 copies
, /* Number of copies for job */
267 copies_remaining
; /* Number of copies remaining */
268 const char *content_type
, /* CONTENT_TYPE environment variable */
269 *final_content_type
, /* FINAL_CONTENT_TYPE environment var */
270 *document_format
; /* document-format value */
271 int fd
; /* File descriptor */
272 off_t bytes
= 0; /* Bytes copied */
273 char buffer
[16384]; /* Copy buffer */
274 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
275 struct sigaction action
; /* Actions for POSIX signals */
276 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
277 int version
; /* IPP version */
278 ppd_file_t
*ppd
= NULL
; /* PPD file */
279 _ppd_cache_t
*pc
= NULL
; /* PPD cache and mapping data */
280 fd_set input
; /* Input set for select() */
284 * Make sure status messages are not buffered...
287 setbuf(stderr
, NULL
);
290 * Ignore SIGPIPE and catch SIGTERM signals...
294 sigset(SIGPIPE
, SIG_IGN
);
295 sigset(SIGTERM
, sigterm_handler
);
296 #elif defined(HAVE_SIGACTION)
297 memset(&action
, 0, sizeof(action
));
298 action
.sa_handler
= SIG_IGN
;
299 sigaction(SIGPIPE
, &action
, NULL
);
301 sigemptyset(&action
.sa_mask
);
302 sigaddset(&action
.sa_mask
, SIGTERM
);
303 action
.sa_handler
= sigterm_handler
;
304 sigaction(SIGTERM
, &action
, NULL
);
306 signal(SIGPIPE
, SIG_IGN
);
307 signal(SIGTERM
, sigterm_handler
);
308 #endif /* HAVE_SIGSET */
311 * Check command-line...
318 if ((s
= strrchr(argv
[0], '/')) != NULL
)
323 printf("network %s \"Unknown\" \"%s (%s)\"\n",
324 s
, _cupsLangString(cupsLangDefault(),
325 _("Internet Printing Protocol")), s
);
326 return (CUPS_BACKEND_OK
);
330 _cupsLangPrintf(stderr
,
331 _("Usage: %s job-id user title copies options [file]"),
333 return (CUPS_BACKEND_STOP
);
337 * Get the device URI...
340 while ((device_uri
= cupsBackendDeviceURI(argv
)) == NULL
)
342 _cupsLangPrintFilter(stderr
, "INFO", _("Unable to locate printer."));
345 if (getenv("CLASS") != NULL
)
346 return (CUPS_BACKEND_FAILED
);
349 if ((auth_info_required
= getenv("AUTH_INFO_REQUIRED")) == NULL
)
350 auth_info_required
= "none";
352 state_reasons
= _cupsArrayNewStrings(getenv("PRINTER_STATE_REASONS"), ',');
356 * For Kerberos, become the printing user (if we can) to get the credentials
360 if (!getuid() && (value
= getenv("AUTH_UID")) != NULL
&&
361 !getenv("AUTH_PASSWORD"))
363 uid_t uid
= (uid_t
)atoi(value
);
370 return (run_as_user(argv
, uid
, device_uri
, 0));
373 int status
= 0; /* Exit status */
375 for (i
= 6; i
< argc
&& !status
&& !job_canceled
; i
++)
377 if ((fd
= open(argv
[i
], O_RDONLY
)) >= 0)
379 status
= run_as_user(argv
, uid
, device_uri
, fd
);
384 _cupsLangPrintError("ERROR", _("Unable to open print file"));
385 status
= CUPS_BACKEND_FAILED
;
393 # else /* No XPC, just try to run as the user ID */
396 # endif /* HAVE_XPC */
398 #endif /* HAVE_GSSAPI */
401 * Get the (final) content type...
404 if ((content_type
= getenv("CONTENT_TYPE")) == NULL
)
405 content_type
= "application/octet-stream";
407 if ((final_content_type
= getenv("FINAL_CONTENT_TYPE")) == NULL
)
409 final_content_type
= content_type
;
411 if (!strncmp(final_content_type
, "printer/", 8))
412 final_content_type
= "application/vnd.cups-raw";
416 * Extract the hostname and printer name from the URI...
419 httpSeparateURI(HTTP_URI_CODING_ALL
, device_uri
, scheme
, sizeof(scheme
),
420 username
, sizeof(username
), hostname
, sizeof(hostname
), &port
,
421 resource
, sizeof(resource
));
424 port
= IPP_PORT
; /* Default to port 631 */
426 if (!strcmp(scheme
, "https") || !strcmp(scheme
, "ipps"))
427 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
429 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
432 * See if there are any options...
439 contimeout
= 7 * 24 * 60 * 60;
441 if ((optptr
= strchr(resource
, '?')) != NULL
)
444 * Yup, terminate the device name string and move to the first
445 * character of the optptr...
451 * Then parse the optptr...
462 while (*optptr
&& *optptr
!= '=' && *optptr
!= '+' && *optptr
!= '&')
465 if ((sep
= *optptr
) != '\0')
476 while (*optptr
&& *optptr
!= '+' && *optptr
!= '&')
486 * Process the option...
489 if (!_cups_strcasecmp(name
, "waitjob"))
492 * Wait for job completion?
495 waitjob
= !_cups_strcasecmp(value
, "on") ||
496 !_cups_strcasecmp(value
, "yes") ||
497 !_cups_strcasecmp(value
, "true");
499 else if (!_cups_strcasecmp(name
, "waitprinter"))
502 * Wait for printer idle?
505 waitprinter
= !_cups_strcasecmp(value
, "on") ||
506 !_cups_strcasecmp(value
, "yes") ||
507 !_cups_strcasecmp(value
, "true");
509 else if (!_cups_strcasecmp(name
, "encryption"))
512 * Enable/disable encryption?
515 if (!_cups_strcasecmp(value
, "always"))
516 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
517 else if (!_cups_strcasecmp(value
, "required"))
518 cupsSetEncryption(HTTP_ENCRYPT_REQUIRED
);
519 else if (!_cups_strcasecmp(value
, "never"))
520 cupsSetEncryption(HTTP_ENCRYPT_NEVER
);
521 else if (!_cups_strcasecmp(value
, "ifrequested"))
522 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
525 _cupsLangPrintFilter(stderr
, "ERROR",
526 _("Unknown encryption option value: \"%s\"."),
530 else if (!_cups_strcasecmp(name
, "snmp"))
533 * Enable/disable SNMP stuff...
536 snmp_enabled
= !value
[0] || !_cups_strcasecmp(value
, "on") ||
537 !_cups_strcasecmp(value
, "yes") ||
538 !_cups_strcasecmp(value
, "true");
540 else if (!_cups_strcasecmp(name
, "version"))
542 if (!strcmp(value
, "1.0"))
544 else if (!strcmp(value
, "1.1"))
546 else if (!strcmp(value
, "2.0"))
548 else if (!strcmp(value
, "2.1"))
550 else if (!strcmp(value
, "2.2"))
554 _cupsLangPrintFilter(stderr
, "ERROR",
555 _("Unknown version option value: \"%s\"."),
560 else if (!_cups_strcasecmp(name
, "compression"))
562 if (!_cups_strcasecmp(value
, "true") || !_cups_strcasecmp(value
, "yes") ||
563 !_cups_strcasecmp(value
, "on") || !_cups_strcasecmp(value
, "gzip"))
564 compression
= "gzip";
565 else if (!_cups_strcasecmp(value
, "deflate"))
566 compression
= "deflate";
567 else if (!_cups_strcasecmp(value
, "false") ||
568 !_cups_strcasecmp(value
, "no") ||
569 !_cups_strcasecmp(value
, "off") ||
570 !_cups_strcasecmp(value
, "none"))
571 compression
= "none";
573 #endif /* HAVE_LIBZ */
574 else if (!_cups_strcasecmp(name
, "contimeout"))
577 * Set the connection timeout...
581 contimeout
= atoi(value
);
589 _cupsLangPrintFilter(stderr
, "ERROR",
590 _("Unknown option \"%s\" with value \"%s\"."),
597 * If we have 7 arguments, print the file named on the command-line.
598 * Otherwise, copy stdin to a temporary file and print the temporary
606 send_options
= !_cups_strcasecmp(final_content_type
, "application/pdf") ||
607 !_cups_strcasecmp(final_content_type
, "application/vnd.cups-pdf") ||
608 !_cups_strncasecmp(final_content_type
, "image/", 6);
610 fputs("DEBUG: Sending stdin for job...\n", stderr
);
615 * Point to the files on the command-line...
618 num_files
= argc
- 6;
622 fprintf(stderr
, "DEBUG: %d files to send in job...\n", num_files
);
626 * Set the authentication info, if any...
629 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
634 * Use authentication information in the device URI...
637 if ((password
= strchr(username
, ':')) != NULL
)
640 cupsSetUser(username
);
646 * Try loading authentication information from the environment.
649 const char *ptr
= getenv("AUTH_USERNAME");
653 strlcpy(username
, ptr
, sizeof(username
));
657 password
= getenv("AUTH_PASSWORD");
661 * Try finding the remote server...
664 start_time
= time(NULL
);
666 sprintf(portname
, "%d", port
);
668 update_reasons(NULL
, "+connecting-to-device");
669 fprintf(stderr
, "DEBUG: Looking up \"%s\"...\n", hostname
);
671 while ((addrlist
= httpAddrGetList(hostname
, AF_UNSPEC
, portname
)) == NULL
)
673 _cupsLangPrintFilter(stderr
, "INFO",
674 _("Unable to locate printer \"%s\"."), hostname
);
677 if (getenv("CLASS") != NULL
)
679 update_reasons(NULL
, "-connecting-to-device");
680 return (CUPS_BACKEND_STOP
);
684 return (CUPS_BACKEND_OK
);
687 http
= httpConnect2(hostname
, port
, addrlist
, AF_UNSPEC
, cupsEncryption(), 1,
689 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
691 if (httpIsEncrypted(http
))
694 * Validate TLS credentials...
697 cups_array_t
*creds
; /* TLS credentials */
698 cups_array_t
*lcreds
= NULL
; /* Loaded credentials */
699 http_trust_t trust
; /* Trust level */
700 static const char *trusts
[] = { NULL
, "+cups-pki-invalid", "+cups-pki-changed", "+cups-pki-expired", NULL
, "+cups-pki-unknown" };
703 if (!httpCopyCredentials(http
, &creds
))
705 trust
= httpCredentialsGetTrust(creds
, hostname
);
707 update_reasons(NULL
, "-cups-pki-invalid,cups-pki-changed,cups-pki-expired,cups-pki-unknown");
710 update_reasons(NULL
, trusts
[trust
]);
711 return (CUPS_BACKEND_STOP
);
714 if (httpLoadCredentials(NULL
, &lcreds
, hostname
))
717 * Could not load the credentials, let's save the ones we have so we
718 * can detect changes...
721 httpSaveCredentials(NULL
, creds
, hostname
);
724 httpFreeCredentials(lcreds
);
725 httpFreeCredentials(creds
);
730 * See if the printer supports SNMP...
734 snmp_fd
= _cupsSNMPOpen(addrlist
->addr
.addr
.sa_family
);
739 have_supplies
= !backendSNMPSupplies(snmp_fd
, &(addrlist
->addr
),
742 have_supplies
= start_count
= 0;
745 * Wait for data from the filter...
750 if (!backendWaitLoop(snmp_fd
, &(addrlist
->addr
), 0, backendNetworkSideCB
))
751 return (CUPS_BACKEND_OK
);
752 else if ((bytes
= read(0, buffer
, sizeof(buffer
))) <= 0)
753 return (CUPS_BACKEND_OK
);
757 * Try connecting to the remote server...
760 delay
= _cupsNextDelay(0, &prev_delay
);
764 fprintf(stderr
, "DEBUG: Connecting to %s:%d\n", hostname
, port
);
765 _cupsLangPrintFilter(stderr
, "INFO", _("Connecting to printer."));
767 if (httpReconnect(http
))
769 int error
= errno
; /* Connection error */
771 if (http
->status
== HTTP_PKI_ERROR
)
772 update_reasons(NULL
, "+cups-certificate-error");
777 if (getenv("CLASS") != NULL
)
780 * If the CLASS environment variable is set, the job was submitted
781 * to a class and not to a specific queue. In this case, we want
782 * to abort immediately so that the job can be requeued on the next
783 * available printer in the class.
786 _cupsLangPrintFilter(stderr
, "INFO",
787 _("Unable to contact printer, queuing on next "
788 "printer in class."));
791 * Sleep 5 seconds to keep the job from requeuing too rapidly...
796 update_reasons(NULL
, "-connecting-to-device");
798 return (CUPS_BACKEND_FAILED
);
801 fprintf(stderr
, "DEBUG: Connection error: %s\n", strerror(errno
));
803 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
||
804 errno
== EHOSTUNREACH
)
806 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
808 _cupsLangPrintFilter(stderr
, "ERROR",
809 _("The printer is not responding."));
810 update_reasons(NULL
, "-connecting-to-device");
811 return (CUPS_BACKEND_FAILED
);
817 _cupsLangPrintFilter(stderr
, "WARNING",
818 _("The printer may not exist or "
819 "is unavailable at this time."));
823 _cupsLangPrintFilter(stderr
, "WARNING",
824 _("The printer is unreachable at this "
830 _cupsLangPrintFilter(stderr
, "WARNING",
831 _("The printer is in use."));
835 sleep((unsigned)delay
);
837 delay
= _cupsNextDelay(delay
, &prev_delay
);
841 _cupsLangPrintFilter(stderr
, "ERROR",
842 _("The printer is not responding."));
850 update_reasons(NULL
, "-cups-certificate-error");
852 while (http
->fd
< 0);
855 return (CUPS_BACKEND_OK
);
857 return (CUPS_BACKEND_FAILED
);
859 update_reasons(NULL
, "-connecting-to-device");
860 _cupsLangPrintFilter(stderr
, "INFO", _("Connected to printer."));
862 fprintf(stderr
, "DEBUG: Connected to %s:%d...\n",
863 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
864 httpAddrPort(http
->hostaddr
));
867 * Build a URI for the printer and fill the standard IPP attributes for
868 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
869 * might contain username:password information...
872 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), scheme
, NULL
, hostname
,
876 * First validate the destination and see if the device supports multiple
881 compression_sup
= NULL
;
882 #endif /* HAVE_LIBZ */
885 encryption_sup
= NULL
;
887 media_col_sup
= NULL
;
889 operations_sup
= NULL
;
890 doc_handling_sup
= NULL
;
891 print_color_mode_sup
= NULL
;
896 * Check for side-channel requests...
899 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
902 * Build the IPP request...
905 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
906 ippSetVersion(request
, version
/ 10, version
% 10);
907 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
910 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
911 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
918 fputs("DEBUG: Getting supported attributes...\n", stderr
);
920 if (http
->version
< HTTP_1_1
)
922 fprintf(stderr
, "DEBUG: Printer responded with HTTP version %d.%d.\n",
923 http
->version
/ 100, http
->version
% 100);
924 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
925 "cups-ipp-wrong-http-version");
928 supported
= cupsDoRequest(http
, request
, resource
);
929 ipp_status
= cupsLastError();
931 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
932 ippErrorString(ipp_status
), cupsLastErrorString());
934 if (ipp_status
<= IPP_OK_CONFLICT
)
938 fprintf(stderr
, "DEBUG: Get-Printer-Attributes returned %s.\n",
939 ippErrorString(ipp_status
));
941 if (ipp_status
== IPP_PRINTER_BUSY
||
942 ipp_status
== IPP_SERVICE_UNAVAILABLE
)
944 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
946 _cupsLangPrintFilter(stderr
, "ERROR",
947 _("The printer is not responding."));
948 return (CUPS_BACKEND_FAILED
);
951 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
953 report_printer_state(supported
);
955 sleep((unsigned)delay
);
957 delay
= _cupsNextDelay(delay
, &prev_delay
);
959 else if ((ipp_status
== IPP_BAD_REQUEST
||
960 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
> 10)
963 * Switch to IPP/1.1 or IPP/1.0...
968 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
970 "DEBUG: The printer does not support IPP/%d.%d, trying "
971 "IPP/1.1.\n", version
/ 10, version
% 10);
976 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
978 "DEBUG: The printer does not support IPP/%d.%d, trying "
979 "IPP/1.0.\n", version
/ 10, version
% 10);
985 else if (ipp_status
== IPP_NOT_FOUND
)
987 _cupsLangPrintFilter(stderr
, "ERROR",
988 _("The printer configuration is incorrect or the "
989 "printer no longer exists."));
991 ippDelete(supported
);
993 return (CUPS_BACKEND_STOP
);
995 else if (ipp_status
== IPP_FORBIDDEN
||
996 ipp_status
== IPP_AUTHENTICATION_CANCELED
)
998 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
999 /* WWW-Authenticate field value */
1001 if (!strncmp(www_auth
, "Negotiate", 9))
1002 auth_info_required
= "negotiate";
1003 else if (www_auth
[0])
1004 auth_info_required
= "username,password";
1006 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
1007 return (CUPS_BACKEND_AUTH_REQUIRED
);
1009 else if (ipp_status
!= IPP_NOT_AUTHORIZED
)
1011 _cupsLangPrintFilter(stderr
, "ERROR",
1012 _("Unable to get printer status."));
1015 httpReconnect(http
);
1018 ippDelete(supported
);
1023 if (!getenv("CLASS"))
1026 * Check printer-is-accepting-jobs = false and printer-state-reasons for the
1027 * "spool-area-full" keyword...
1032 if ((printer_accepting
= ippFindAttribute(supported
,
1033 "printer-is-accepting-jobs",
1034 IPP_TAG_BOOLEAN
)) != NULL
&&
1035 !printer_accepting
->values
[0].boolean
)
1037 else if (!printer_accepting
)
1038 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1039 "cups-ipp-missing-printer-is-accepting-jobs");
1041 if ((printer_state
= ippFindAttribute(supported
,
1042 "printer-state-reasons",
1043 IPP_TAG_KEYWORD
)) == NULL
)
1045 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1046 "cups-ipp-missing-printer-state-reasons");
1050 for (i
= 0; i
< printer_state
->num_values
; i
++)
1052 if (!strcmp(printer_state
->values
[0].string
.text
,
1053 "spool-area-full") ||
1054 !strncmp(printer_state
->values
[0].string
.text
, "spool-area-full-",
1065 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1067 report_printer_state(supported
);
1069 sleep((unsigned)delay
);
1071 delay
= _cupsNextDelay(delay
, &prev_delay
);
1073 ippDelete(supported
);
1075 ipp_status
= IPP_STATUS_ERROR_BUSY
;
1081 * Check for supported attributes...
1085 if ((compression_sup
= ippFindAttribute(supported
, "compression-supported",
1086 IPP_TAG_KEYWORD
)) != NULL
)
1089 * Check whether the requested compression is supported and/or default to
1090 * compression if supported...
1093 if (compression
&& !ippContainsString(compression_sup
, compression
))
1095 fprintf(stderr
, "DEBUG: Printer does not support the requested "
1096 "compression value \"%s\".\n", compression
);
1099 else if (!compression
)
1101 if (ippContainsString(compression_sup
, "gzip"))
1102 compression
= "gzip";
1103 else if (ippContainsString(compression_sup
, "deflate"))
1104 compression
= "deflate";
1107 fprintf(stderr
, "DEBUG: Automatically using \"%s\" compression.\n",
1111 #endif /* HAVE_LIBZ */
1113 if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
1114 IPP_TAG_RANGE
)) != NULL
)
1117 * Has the "copies-supported" attribute - does it have an upper
1121 fprintf(stderr
, "DEBUG: copies-supported=%d-%d\n",
1122 copies_sup
->values
[0].range
.lower
,
1123 copies_sup
->values
[0].range
.upper
);
1125 if (copies_sup
->values
[0].range
.upper
<= 1)
1126 copies_sup
= NULL
; /* No */
1129 cups_version
= ippFindAttribute(supported
, "cups-version", IPP_TAG_TEXT
);
1131 encryption_sup
= ippFindAttribute(supported
, "job-password-encryption-supported", IPP_TAG_KEYWORD
);
1133 if ((format_sup
= ippFindAttribute(supported
, "document-format-supported",
1134 IPP_TAG_MIMETYPE
)) != NULL
)
1136 fprintf(stderr
, "DEBUG: document-format-supported (%d values)\n",
1137 format_sup
->num_values
);
1138 for (i
= 0; i
< format_sup
->num_values
; i
++)
1139 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1140 format_sup
->values
[i
].string
.text
);
1143 if ((media_col_sup
= ippFindAttribute(supported
, "media-col-supported",
1144 IPP_TAG_KEYWORD
)) != NULL
)
1146 fprintf(stderr
, "DEBUG: media-col-supported (%d values)\n",
1147 media_col_sup
->num_values
);
1148 for (i
= 0; i
< media_col_sup
->num_values
; i
++)
1149 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1150 media_col_sup
->values
[i
].string
.text
);
1153 print_color_mode_sup
= ippFindAttribute(supported
, "print-color-mode-supported", IPP_TAG_KEYWORD
);
1155 if ((operations_sup
= ippFindAttribute(supported
, "operations-supported",
1156 IPP_TAG_ENUM
)) != NULL
)
1158 fprintf(stderr
, "DEBUG: operations-supported (%d values)\n",
1159 operations_sup
->num_values
);
1160 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1161 fprintf(stderr
, "DEBUG: [%d] = %s\n", i
,
1162 ippOpString(operations_sup
->values
[i
].integer
));
1164 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1165 if (operations_sup
->values
[i
].integer
== IPP_PRINT_JOB
)
1168 if (i
>= operations_sup
->num_values
)
1169 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1170 "cups-ipp-missing-print-job");
1172 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1173 if (operations_sup
->values
[i
].integer
== IPP_CANCEL_JOB
)
1176 if (i
>= operations_sup
->num_values
)
1177 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1178 "cups-ipp-missing-cancel-job");
1180 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1181 if (operations_sup
->values
[i
].integer
== IPP_GET_JOB_ATTRIBUTES
)
1184 if (i
>= operations_sup
->num_values
)
1185 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1186 "cups-ipp-missing-get-job-attributes");
1188 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1189 if (operations_sup
->values
[i
].integer
== IPP_GET_PRINTER_ATTRIBUTES
)
1192 if (i
>= operations_sup
->num_values
)
1193 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1194 "cups-ipp-missing-get-printer-attributes");
1196 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1198 if (operations_sup
->values
[i
].integer
== IPP_VALIDATE_JOB
)
1200 else if (operations_sup
->values
[i
].integer
== IPP_CREATE_JOB
)
1202 else if (operations_sup
->values
[i
].integer
== IPP_SEND_DOCUMENT
)
1204 else if (operations_sup
->values
[i
].integer
== IPP_GET_JOB_ATTRIBUTES
)
1208 if (create_job
&& !send_document
)
1210 fputs("DEBUG: Printer supports Create-Job but not Send-Document.\n",
1214 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1215 "cups-ipp-missing-send-document");
1219 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1220 "cups-ipp-missing-validate-job");
1223 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1224 "cups-ipp-missing-operations-supported");
1226 doc_handling_sup
= ippFindAttribute(supported
,
1227 "multiple-document-handling-supported",
1230 report_printer_state(supported
);
1232 while (!job_canceled
&& ipp_status
> IPP_OK_CONFLICT
);
1235 return (CUPS_BACKEND_OK
);
1238 * See if the printer is accepting jobs and is not stopped; if either
1239 * condition is true and we are printing to a class, requeue the job...
1242 if (getenv("CLASS") != NULL
)
1244 printer_state
= ippFindAttribute(supported
, "printer-state",
1246 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
1249 if (printer_state
== NULL
||
1250 (printer_state
->values
[0].integer
> IPP_PRINTER_PROCESSING
&&
1252 printer_accepting
== NULL
||
1253 !printer_accepting
->values
[0].boolean
)
1256 * If the CLASS environment variable is set, the job was submitted
1257 * to a class and not to a specific queue. In this case, we want
1258 * to abort immediately so that the job can be requeued on the next
1259 * available printer in the class.
1262 _cupsLangPrintFilter(stderr
, "INFO",
1263 _("Unable to contact printer, queuing on next "
1264 "printer in class."));
1266 ippDelete(supported
);
1270 * Sleep 5 seconds to keep the job from requeuing too rapidly...
1275 return (CUPS_BACKEND_FAILED
);
1280 * See if the printer supports multiple copies...
1283 copies
= atoi(argv
[4]);
1285 if (copies_sup
|| argc
< 7)
1286 copies_remaining
= 1;
1288 copies_remaining
= copies
;
1291 * Prepare remaining printing options...
1298 num_options
= cupsParseOptions(argv
[5], 0, &options
);
1300 if (!cups_version
&& media_col_sup
)
1303 * Load the PPD file and generate PWG attribute mapping information...
1306 ppd_attr_t
*mandatory
; /* cupsMandatory value */
1308 ppd
= ppdOpenFile(getenv("PPD"));
1309 pc
= _ppdCacheCreateWithPPD(ppd
);
1311 ppdMarkDefaults(ppd
);
1312 cupsMarkOptions(ppd
, num_options
, options
);
1314 if ((mandatory
= ppdFindAttr(ppd
, "cupsMandatory", NULL
)) != NULL
)
1315 strlcpy(mandatory_attrs
, mandatory
->value
, sizeof(mandatory_attrs
));
1319 * Validate job-password/-encryption...
1322 if (cupsGetOption("job-password", num_options
, options
))
1324 const char *keyword
; /* job-password-encryption value */
1325 static const char * const hashes
[] =
1326 { /* List of supported hash algorithms, in order of preference */
1337 if ((keyword
= cupsGetOption("job-password-encryption", num_options
, options
)) == NULL
|| !ippContainsString(encryption_sup
, keyword
))
1340 * Either no job-password-encryption or the value isn't supported by
1344 for (i
= 0; i
< (int)(sizeof(hashes
) / sizeof(hashes
[0])); i
++)
1345 if (ippContainsString(encryption_sup
, hashes
[i
]))
1348 if (i
< (int)(sizeof(hashes
) / sizeof(hashes
[0])))
1349 num_options
= cupsAddOption("job-password-encryption", hashes
[i
], num_options
, &options
);
1356 document_format
= NULL
;
1358 if (format_sup
!= NULL
)
1360 for (i
= 0; i
< format_sup
->num_values
; i
++)
1361 if (!_cups_strcasecmp(final_content_type
,
1362 format_sup
->values
[i
].string
.text
))
1364 document_format
= final_content_type
;
1368 if (!document_format
)
1370 for (i
= 0; i
< format_sup
->num_values
; i
++)
1371 if (!_cups_strcasecmp("application/octet-stream",
1372 format_sup
->values
[i
].string
.text
))
1374 document_format
= "application/octet-stream";
1380 fprintf(stderr
, "DEBUG: final_content_type=\"%s\", document_format=\"%s\"\n",
1381 final_content_type
, document_format
? document_format
: "(null)");
1384 * If the printer does not support HTTP/1.1 (which IPP requires), copy stdin
1385 * to a temporary file so that we can do a HTTP/1.0 submission...
1387 * (I hate compatibility hacks!)
1390 if (http
->version
< HTTP_1_1
&& num_files
== 0)
1392 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
1394 perror("DEBUG: Unable to create temporary file");
1395 return (CUPS_BACKEND_FAILED
);
1398 _cupsLangPrintFilter(stderr
, "INFO", _("Copying print data."));
1400 if ((compatsize
= write(fd
, buffer
, (size_t)bytes
)) < 0)
1402 perror("DEBUG: Unable to write temporary file");
1403 return (CUPS_BACKEND_FAILED
);
1406 if ((bytes
= backendRunLoop(-1, fd
, snmp_fd
, &(addrlist
->addr
), 0, 0,
1407 backendNetworkSideCB
)) < 0)
1408 return (CUPS_BACKEND_FAILED
);
1410 compatsize
+= bytes
;
1414 compatfile
= tmpfilename
;
1415 files
= &compatfile
;
1418 else if (http
->version
< HTTP_1_1
&& num_files
== 1)
1420 struct stat fileinfo
; /* File information */
1422 if (!stat(files
[0], &fileinfo
))
1423 compatsize
= fileinfo
.st_size
;
1427 * If the printer only claims to support IPP/1.0, or if the user specifically
1428 * included version=1.0 in the URI, then do not try to use Create-Job or
1429 * Send-Document. This is another dreaded compatibility hack, but
1430 * unfortunately there are enough broken printers out there that we need
1435 create_job
= send_document
= 0;
1438 * Start monitoring the printer in the background...
1442 monitor
.hostname
= hostname
;
1443 monitor
.user
= argv
[2];
1444 monitor
.resource
= resource
;
1445 monitor
.port
= port
;
1446 monitor
.version
= version
;
1448 monitor
.create_job
= create_job
;
1449 monitor
.get_job_attrs
= get_job_attrs
;
1450 monitor
.encryption
= cupsEncryption();
1451 monitor
.job_state
= IPP_JOB_PENDING
;
1452 monitor
.printer_state
= IPP_PRINTER_IDLE
;
1456 monitor
.job_name
= argv
[3];
1460 snprintf(print_job_name
, sizeof(print_job_name
), "%s - %s", argv
[1],
1462 monitor
.job_name
= print_job_name
;
1465 _cupsThreadCreate((_cups_thread_func_t
)monitor_printer
, &monitor
);
1468 * Validate access to the printer...
1471 while (!job_canceled
&& validate_job
)
1473 request
= new_request(IPP_VALIDATE_JOB
, version
, uri
, argv
[2],
1474 monitor
.job_name
, num_options
, options
, compression
,
1475 copies_sup
? copies
: 1, document_format
, pc
, ppd
,
1476 media_col_sup
, doc_handling_sup
, print_color_mode_sup
);
1478 response
= cupsDoRequest(http
, request
, resource
);
1480 ipp_status
= cupsLastError();
1482 fprintf(stderr
, "DEBUG: Validate-Job: %s (%s)\n",
1483 ippErrorString(ipp_status
), cupsLastErrorString());
1485 if ((job_auth
= ippFindAttribute(response
, "job-authorization-uri",
1486 IPP_TAG_URI
)) != NULL
)
1487 num_options
= cupsAddOption("job-authorization-uri",
1488 ippGetString(job_auth
, 0, NULL
), num_options
,
1491 ippDelete(response
);
1496 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1497 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1499 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1502 else if (ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
||
1503 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1504 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1505 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1506 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1507 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1509 else if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1510 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1511 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1513 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1514 /* WWW-Authenticate field value */
1516 if (!strncmp(www_auth
, "Negotiate", 9))
1517 auth_info_required
= "negotiate";
1518 else if (www_auth
[0])
1519 auth_info_required
= "username,password";
1523 else if (ipp_status
== IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
)
1526 * This is all too common...
1529 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1530 "cups-ipp-missing-validate-job");
1533 else if (ipp_status
< IPP_REDIRECTION_OTHER_SITE
||
1534 ipp_status
== IPP_BAD_REQUEST
)
1539 * Then issue the print-job request...
1544 while (!job_canceled
&& copies_remaining
> 0)
1547 * Check for side-channel requests...
1550 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1553 * Build the IPP job creation request...
1559 request
= new_request((num_files
> 1 || create_job
) ? IPP_CREATE_JOB
:
1561 version
, uri
, argv
[2], monitor
.job_name
, num_options
,
1562 options
, compression
, copies_sup
? copies
: 1,
1563 document_format
, pc
, ppd
, media_col_sup
,
1564 doc_handling_sup
, print_color_mode_sup
);
1570 if (num_files
> 1 || create_job
)
1571 response
= cupsDoRequest(http
, request
, resource
);
1574 size_t length
= 0; /* Length of request */
1578 fputs("DEBUG: Sending file using HTTP/1.0 Content-Length...\n", stderr
);
1579 length
= ippLength(request
) + (size_t)compatsize
;
1582 fputs("DEBUG: Sending file using HTTP/1.1 chunking...\n", stderr
);
1584 http_status
= cupsSendRequest(http
, request
, resource
, length
);
1585 if (http_status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
)
1587 if (compression
&& strcmp(compression
, "none"))
1588 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1592 if ((fd
= open(files
[0], O_RDONLY
)) < 0)
1594 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1595 return (CUPS_BACKEND_FAILED
);
1601 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1604 while (http_status
== HTTP_CONTINUE
&&
1605 (!job_canceled
|| compatsize
> 0))
1608 * Check for side-channel requests and more print data...
1613 FD_SET(snmp_fd
, &input
);
1614 FD_SET(CUPS_SC_FD
, &input
);
1616 while (select(fd
> snmp_fd
? fd
+ 1 : snmp_fd
+ 1, &input
, NULL
, NULL
,
1617 NULL
) <= 0 && !job_canceled
);
1619 if (FD_ISSET(snmp_fd
, &input
))
1620 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1622 if (FD_ISSET(fd
, &input
))
1624 if ((bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1626 fprintf(stderr
, "DEBUG: Read %d bytes...\n", (int)bytes
);
1628 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1632 else if (bytes
== 0 || (errno
!= EINTR
&& errno
!= EAGAIN
))
1637 if (http_status
== HTTP_ERROR
)
1638 fprintf(stderr
, "DEBUG: Error writing document data for "
1639 "Print-Job: %s\n", strerror(httpError(http
)));
1645 response
= cupsGetResponse(http
, resource
);
1649 ipp_status
= cupsLastError();
1651 fprintf(stderr
, "DEBUG: %s: %s (%s)\n",
1652 (num_files
> 1 || create_job
) ? "Create-Job" : "Print-Job",
1653 ippErrorString(ipp_status
), cupsLastErrorString());
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 http_status
= cupsSendRequest(http
, request
, resource
, 0);
1789 if (http_status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
)
1791 if (compression
&& strcmp(compression
, "none"))
1792 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1797 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1801 if ((fd
= open(files
[i
], O_RDONLY
)) < 0)
1803 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1804 return (CUPS_BACKEND_FAILED
);
1813 while (!job_canceled
&& http_status
== HTTP_CONTINUE
&&
1814 (bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1816 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1822 * Check for side-channel requests...
1825 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1833 if (http_status
== HTTP_ERROR
)
1834 fprintf(stderr
, "DEBUG: Error writing document data for "
1835 "Send-Document: %s\n", strerror(httpError(http
)));
1837 ippDelete(cupsGetResponse(http
, resource
));
1840 fprintf(stderr
, "DEBUG: Send-Document: %s (%s)\n",
1841 ippErrorString(cupsLastError()), cupsLastErrorString());
1843 if (cupsLastError() > IPP_OK_CONFLICT
&& !job_canceled
)
1845 ipp_status
= cupsLastError();
1847 _cupsLangPrintFilter(stderr
, "ERROR",
1848 _("Unable to add document to print job."));
1855 if (num_files
== 0 || fd
< 0)
1864 if (ipp_status
<= IPP_OK_CONFLICT
&& argc
> 6)
1866 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
1867 copies_remaining
--;
1869 else if ((ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
|| ipp_status
== IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
) &&
1871 document_format
&& strcmp(document_format
, "image/pwg-raster") && strcmp(document_format
, "image/urf"))
1874 * Need to reprocess the job as raster...
1877 fputs("JOBSTATE: cups-retry-as-raster\n", stderr
);
1879 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1883 else if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
1884 ipp_status
== IPP_NOT_POSSIBLE
||
1885 ipp_status
== IPP_PRINTER_BUSY
)
1890 * Need to reprocess the entire job; if we have a job ID, cancel the
1895 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1901 else if (ipp_status
== IPP_REQUEST_VALUE
||
1902 ipp_status
== IPP_ERROR_JOB_CANCELED
||
1903 ipp_status
== IPP_NOT_AUTHORIZED
||
1904 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1905 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1906 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1907 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
||
1908 ipp_status
== IPP_INTERNAL_ERROR
)
1911 * Print file is too large, job was canceled, we need new
1912 * authentication data, or we had some sort of error...
1917 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
)
1920 * Server is configured incorrectly; the policy for Create-Job and
1921 * Send-Document has to be the same (auth or no auth, encryption or
1922 * no encryption). Force the queue to stop since printing will never
1926 fputs("DEBUG: The server or printer is configured incorrectly.\n",
1928 fputs("DEBUG: The policy for Create-Job and Send-Document must have the "
1929 "same authentication and encryption requirements.\n", stderr
);
1931 ipp_status
= IPP_STATUS_ERROR_INTERNAL
;
1934 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1938 else if (ipp_status
== IPP_NOT_FOUND
)
1941 * Printer does not actually implement support for Create-Job/
1942 * Send-Document, so log the conformance issue and stop the printer.
1945 fputs("DEBUG: This printer claims to support Create-Job and "
1946 "Send-Document, but those operations failed.\n", stderr
);
1947 fputs("DEBUG: Add '?version=1.0' to the device URI to use legacy "
1948 "compatibility mode.\n", stderr
);
1949 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1950 "cups-ipp-missing-send-document");
1952 ipp_status
= IPP_INTERNAL_ERROR
; /* Force queue to stop */
1957 copies_remaining
--;
1960 * Wait for the job to complete...
1963 if (!job_id
|| !waitjob
|| !get_job_attrs
)
1966 fputs("STATE: +cups-waiting-for-job-completed\n", stderr
);
1968 _cupsLangPrintFilter(stderr
, "INFO", _("Waiting for job to complete."));
1970 for (delay
= _cupsNextDelay(0, &prev_delay
), waittime
= time(NULL
) + 30; !job_canceled
;)
1973 * Check for side-channel requests...
1976 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1979 * Check printer state...
1982 check_printer_state(http
, uri
, resource
, argv
[2], version
);
1984 if (cupsLastError() <= IPP_OK_CONFLICT
)
1988 * Build an IPP_GET_JOB_ATTRIBUTES request...
1991 request
= ippNewRequest(IPP_GET_JOB_ATTRIBUTES
);
1992 ippSetVersion(request
, version
/ 10, version
% 10);
1994 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1997 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2001 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2002 "requesting-user-name", NULL
, argv
[2]);
2004 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2005 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
2012 httpReconnect(http
);
2013 response
= cupsDoRequest(http
, request
, resource
);
2014 ipp_status
= cupsLastError();
2016 if (ipp_status
== IPP_NOT_FOUND
|| ipp_status
== IPP_NOT_POSSIBLE
)
2019 * Job has gone away and/or the server has no job history...
2022 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2023 "cups-ipp-missing-job-history");
2024 ippDelete(response
);
2026 ipp_status
= IPP_OK
;
2030 fprintf(stderr
, "DEBUG: Get-Job-Attributes: %s (%s)\n",
2031 ippErrorString(ipp_status
), cupsLastErrorString());
2033 if (ipp_status
<= IPP_OK_CONFLICT
)
2037 if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
2038 ipp_status
!= IPP_PRINTER_BUSY
)
2040 ippDelete(response
);
2041 ipp_status
= IPP_OK
;
2044 else if (ipp_status
== IPP_INTERNAL_ERROR
)
2048 if (waitjob_tries
> 4)
2050 ippDelete(response
);
2051 ipp_status
= IPP_OK
;
2059 if ((job_state
= ippFindAttribute(response
, "job-state",
2060 IPP_TAG_ENUM
)) != NULL
)
2063 * Reflect the remote job state in the local queue...
2067 job_state
->values
[0].integer
>= IPP_JOB_PENDING
&&
2068 job_state
->values
[0].integer
<= IPP_JOB_COMPLETED
)
2069 update_reasons(NULL
,
2070 remote_job_states
[job_state
->values
[0].integer
-
2073 if ((job_sheets
= ippFindAttribute(response
, "job-impressions-completed", IPP_TAG_INTEGER
)) == NULL
)
2074 job_sheets
= ippFindAttribute(response
, "job-media-sheets-completed", IPP_TAG_INTEGER
);
2077 fprintf(stderr
, "PAGE: total %d\n",
2078 job_sheets
->values
[0].integer
);
2081 * Stop polling if the job is finished or pending-held for 30 seconds...
2084 if (job_state
->values
[0].integer
> IPP_JSTATE_STOPPED
||
2085 (job_state
->values
[0].integer
== IPP_JSTATE_HELD
&& time(NULL
) > waittime
))
2087 ippDelete(response
);
2091 else if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
2092 ipp_status
!= IPP_NOT_POSSIBLE
&&
2093 ipp_status
!= IPP_PRINTER_BUSY
)
2096 * If the printer does not return a job-state attribute, it does not
2097 * conform to the IPP specification - break out immediately and fail
2101 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2102 "cups-ipp-missing-job-state");
2103 ipp_status
= IPP_INTERNAL_ERROR
;
2108 ippDelete(response
);
2111 * Wait before polling again...
2114 sleep((unsigned)delay
);
2116 delay
= _cupsNextDelay(delay
, &prev_delay
);
2121 * Cancel the job as needed...
2124 if (job_canceled
> 0 && job_id
> 0)
2126 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
2128 if (cupsLastError() > IPP_OK_CONFLICT
)
2129 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2133 * Check the printer state and report it if necessary...
2136 check_printer_state(http
, uri
, resource
, argv
[2], version
);
2138 if (cupsLastError() <= IPP_OK_CONFLICT
)
2142 * Collect the final page count as needed...
2145 if (have_supplies
&&
2146 !backendSNMPSupplies(snmp_fd
, &(http
->addrlist
->addr
), &page_count
,
2148 page_count
> start_count
)
2149 fprintf(stderr
, "PAGE: total %d\n", page_count
- start_count
);
2153 * See if we used Kerberos at all...
2157 auth_info_required
= "negotiate";
2158 #endif /* HAVE_GSSAPI */
2166 cupsFreeOptions(num_options
, options
);
2167 _ppdCacheDestroy(pc
);
2172 ippDelete(supported
);
2175 * Remove the temporary file(s) if necessary...
2179 unlink(tmpfilename
);
2182 * Return the queue status...
2185 if (ipp_status
== IPP_NOT_AUTHORIZED
|| ipp_status
== IPP_FORBIDDEN
||
2186 ipp_status
== IPP_AUTHENTICATION_CANCELED
||
2187 ipp_status
<= IPP_OK_CONFLICT
)
2188 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
2190 if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
)
2191 fputs("JOBSTATE: account-info-needed\n", stderr
);
2192 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
)
2193 fputs("JOBSTATE: account-closed\n", stderr
);
2194 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
)
2195 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2196 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2197 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2199 if (ipp_status
== IPP_NOT_AUTHORIZED
|| ipp_status
== IPP_FORBIDDEN
||
2200 ipp_status
== IPP_AUTHENTICATION_CANCELED
)
2201 return (CUPS_BACKEND_AUTH_REQUIRED
);
2202 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
2203 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
2204 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
2205 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2206 return (CUPS_BACKEND_HOLD
);
2207 else if (ipp_status
== IPP_INTERNAL_ERROR
)
2208 return (CUPS_BACKEND_STOP
);
2209 else if (ipp_status
== IPP_CONFLICT
)
2210 return (CUPS_BACKEND_FAILED
);
2211 else if (ipp_status
== IPP_REQUEST_VALUE
||
2212 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
2213 ipp_status
== IPP_DOCUMENT_FORMAT
|| job_canceled
< 0)
2215 if (ipp_status
== IPP_REQUEST_VALUE
)
2216 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job too large."));
2217 else if (ipp_status
== IPP_DOCUMENT_FORMAT
)
2218 _cupsLangPrintFilter(stderr
, "ERROR",
2219 _("Printer cannot print supplied content."));
2220 else if (ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
)
2221 _cupsLangPrintFilter(stderr
, "ERROR",
2222 _("Printer cannot print with supplied options."));
2224 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job canceled at printer."));
2226 return (CUPS_BACKEND_CANCEL
);
2228 else if (ipp_status
> IPP_OK_CONFLICT
&& ipp_status
!= IPP_ERROR_JOB_CANCELED
)
2229 return (CUPS_BACKEND_RETRY_CURRENT
);
2231 return (CUPS_BACKEND_OK
);
2236 * 'cancel_job()' - Cancel a print job.
2240 cancel_job(http_t
*http
, /* I - HTTP connection */
2241 const char *uri
, /* I - printer-uri */
2242 int id
, /* I - job-id */
2243 const char *resource
, /* I - Resource path */
2244 const char *user
, /* I - requesting-user-name */
2245 int version
) /* I - IPP version */
2247 ipp_t
*request
; /* Cancel-Job request */
2250 _cupsLangPrintFilter(stderr
, "INFO", _("Canceling print job."));
2252 request
= ippNewRequest(IPP_CANCEL_JOB
);
2253 ippSetVersion(request
, version
/ 10, version
% 10);
2255 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2257 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
2259 if (user
&& user
[0])
2260 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2261 "requesting-user-name", NULL
, user
);
2267 ippDelete(cupsDoRequest(http
, request
, resource
));
2272 * 'check_printer_state()' - Check the printer state.
2275 static ipp_pstate_t
/* O - Current printer-state */
2276 check_printer_state(
2277 http_t
*http
, /* I - HTTP connection */
2278 const char *uri
, /* I - Printer URI */
2279 const char *resource
, /* I - Resource path */
2280 const char *user
, /* I - Username, if any */
2281 int version
) /* I - IPP version */
2283 ipp_t
*request
, /* IPP request */
2284 *response
; /* IPP response */
2285 ipp_attribute_t
*attr
; /* Attribute in response */
2286 ipp_pstate_t printer_state
= IPP_PRINTER_STOPPED
;
2287 /* Current printer-state */
2291 * Send a Get-Printer-Attributes request and log the results...
2294 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
2295 ippSetVersion(request
, version
/ 10, version
% 10);
2297 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2300 if (user
&& user
[0])
2301 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2302 "requesting-user-name", NULL
, user
);
2304 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2305 "requested-attributes",
2306 (int)(sizeof(pattrs
) / sizeof(pattrs
[0])), NULL
, pattrs
);
2308 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
2310 report_printer_state(response
);
2312 if ((attr
= ippFindAttribute(response
, "printer-state",
2313 IPP_TAG_ENUM
)) != NULL
)
2314 printer_state
= (ipp_pstate_t
)attr
->values
[0].integer
;
2316 ippDelete(response
);
2319 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
2320 ippErrorString(cupsLastError()), cupsLastErrorString());
2323 * Return the printer-state value...
2326 return (printer_state
);
2331 * 'monitor_printer()' - Monitor the printer state.
2334 static void * /* O - Thread exit code */
2336 _cups_monitor_t
*monitor
) /* I - Monitoring data */
2338 http_t
*http
; /* Connection to printer */
2339 ipp_t
*request
, /* IPP request */
2340 *response
; /* IPP response */
2341 ipp_attribute_t
*attr
; /* Attribute in response */
2342 int delay
, /* Current delay */
2343 prev_delay
; /* Previous delay */
2344 ipp_op_t job_op
; /* Operation to use */
2345 int job_id
; /* Job ID */
2346 const char *job_name
; /* Job name */
2347 ipp_jstate_t job_state
; /* Job state */
2348 const char *job_user
; /* Job originating user name */
2349 int password_tries
= 0; /* Password tries */
2353 * Make a copy of the printer connection...
2356 http
= httpConnect2(monitor
->hostname
, monitor
->port
, NULL
, AF_UNSPEC
,
2357 monitor
->encryption
, 1, 0, NULL
);
2358 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
2360 cupsSetUser(username
);
2362 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
2365 * Loop until the job is canceled, aborted, or completed.
2368 delay
= _cupsNextDelay(0, &prev_delay
);
2370 monitor
->job_reasons
= 0;
2372 while (monitor
->job_state
< IPP_JOB_CANCELED
&& !job_canceled
)
2375 * Reconnect to the printer...
2378 if (!httpReconnect(http
))
2381 * Connected, so check on the printer state...
2384 monitor
->printer_state
= check_printer_state(http
, monitor
->uri
,
2388 if (cupsLastError() <= IPP_OK_CONFLICT
)
2391 if (monitor
->job_id
== 0 && monitor
->create_job
)
2394 * No job-id yet, so continue...
2397 goto monitor_disconnect
;
2401 * Check the status of the job itself...
2404 job_op
= (monitor
->job_id
> 0 && monitor
->get_job_attrs
) ?
2405 IPP_GET_JOB_ATTRIBUTES
: IPP_GET_JOBS
;
2406 request
= ippNewRequest(job_op
);
2407 ippSetVersion(request
, monitor
->version
/ 10, monitor
->version
% 10);
2409 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2410 NULL
, monitor
->uri
);
2411 if (job_op
== IPP_GET_JOB_ATTRIBUTES
)
2412 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2415 if (monitor
->user
&& monitor
->user
[0])
2416 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2417 "requesting-user-name", NULL
, monitor
->user
);
2419 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2420 "requested-attributes",
2421 (int)(sizeof(jattrs
) / sizeof(jattrs
[0])), NULL
, jattrs
);
2427 response
= cupsDoRequest(http
, request
, monitor
->resource
);
2429 fprintf(stderr
, "DEBUG: (monitor) %s: %s (%s)\n", ippOpString(job_op
),
2430 ippErrorString(cupsLastError()), cupsLastErrorString());
2432 if (cupsLastError() <= IPP_OK_CONFLICT
)
2435 if (job_op
== IPP_GET_JOB_ATTRIBUTES
)
2437 if ((attr
= ippFindAttribute(response
, "job-state",
2438 IPP_TAG_ENUM
)) != NULL
)
2439 monitor
->job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2441 monitor
->job_state
= IPP_JOB_COMPLETED
;
2445 for (attr
= response
->attrs
; attr
; attr
= attr
->next
)
2449 job_state
= IPP_JOB_PENDING
;
2452 while (attr
&& attr
->group_tag
!= IPP_TAG_JOB
)
2458 while (attr
&& attr
->group_tag
== IPP_TAG_JOB
)
2460 if (!strcmp(attr
->name
, "job-id") &&
2461 attr
->value_tag
== IPP_TAG_INTEGER
)
2462 job_id
= attr
->values
[0].integer
;
2463 else if (!strcmp(attr
->name
, "job-name") &&
2464 (attr
->value_tag
== IPP_TAG_NAME
||
2465 attr
->value_tag
== IPP_TAG_NAMELANG
))
2466 job_name
= attr
->values
[0].string
.text
;
2467 else if (!strcmp(attr
->name
, "job-state") &&
2468 attr
->value_tag
== IPP_TAG_ENUM
)
2469 job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2470 else if (!strcmp(attr
->name
, "job-originating-user-name") &&
2471 (attr
->value_tag
== IPP_TAG_NAME
||
2472 attr
->value_tag
== IPP_TAG_NAMELANG
))
2473 job_user
= attr
->values
[0].string
.text
;
2478 if (job_id
> 0 && job_name
&& !strcmp(job_name
, monitor
->job_name
) &&
2479 job_user
&& monitor
->user
&& !strcmp(job_user
, monitor
->user
))
2481 monitor
->job_id
= job_id
;
2482 monitor
->job_state
= job_state
;
2491 fprintf(stderr
, "DEBUG: (monitor) job-state = %s\n",
2492 ippEnumString("job-state", monitor
->job_state
));
2494 if (!job_canceled
&&
2495 (monitor
->job_state
== IPP_JOB_CANCELED
||
2496 monitor
->job_state
== IPP_JOB_ABORTED
))
2499 fprintf(stderr
, "DEBUG: (monitor) job_canceled = -1\n");
2502 if ((attr
= ippFindAttribute(response
, "job-state-reasons",
2503 IPP_TAG_KEYWORD
)) != NULL
)
2505 int i
, new_reasons
= 0; /* Looping var, new reasons */
2507 for (i
= 0; i
< attr
->num_values
; i
++)
2509 if (!strcmp(attr
->values
[i
].string
.text
,
2510 "account-authorization-failed"))
2511 new_reasons
|= _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
;
2512 else if (!strcmp(attr
->values
[i
].string
.text
, "account-closed"))
2513 new_reasons
|= _CUPS_JSR_ACCOUNT_CLOSED
;
2514 else if (!strcmp(attr
->values
[i
].string
.text
, "account-info-needed"))
2515 new_reasons
|= _CUPS_JSR_ACCOUNT_INFO_NEEDED
;
2516 else if (!strcmp(attr
->values
[i
].string
.text
,
2517 "account-limit-reached"))
2518 new_reasons
|= _CUPS_JSR_ACCOUNT_LIMIT_REACHED
;
2519 else if (!strcmp(attr
->values
[i
].string
.text
, "job-password-wait"))
2520 new_reasons
|= _CUPS_JSR_JOB_PASSWORD_WAIT
;
2521 else if (!strcmp(attr
->values
[i
].string
.text
, "job-release-wait"))
2522 new_reasons
|= _CUPS_JSR_JOB_RELEASE_WAIT
;
2523 if (!job_canceled
&&
2524 (!strncmp(attr
->values
[i
].string
.text
, "job-canceled-", 13) || !strcmp(attr
->values
[i
].string
.text
, "aborted-by-system")))
2528 if (new_reasons
!= monitor
->job_reasons
)
2530 if (new_reasons
& _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
)
2531 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2532 else if (new_reasons
& _CUPS_JSR_ACCOUNT_CLOSED
)
2533 fputs("JOBSTATE: account-closed\n", stderr
);
2534 else if (new_reasons
& _CUPS_JSR_ACCOUNT_INFO_NEEDED
)
2535 fputs("JOBSTATE: account-info-needed\n", stderr
);
2536 else if (new_reasons
& _CUPS_JSR_ACCOUNT_LIMIT_REACHED
)
2537 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2538 else if (new_reasons
& _CUPS_JSR_JOB_PASSWORD_WAIT
)
2539 fputs("JOBSTATE: job-password-wait\n", stderr
);
2540 else if (new_reasons
& _CUPS_JSR_JOB_RELEASE_WAIT
)
2541 fputs("JOBSTATE: job-release-wait\n", stderr
);
2543 fputs("JOBSTATE: job-printing\n", stderr
);
2545 monitor
->job_reasons
= new_reasons
;
2549 ippDelete(response
);
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
))
2560 * Disconnect from the printer - we'll reconnect on the next poll...
2565 _httpDisconnect(http
);
2569 * Sleep for N seconds...
2572 sleep((unsigned)delay
);
2574 delay
= _cupsNextDelay(delay
, &prev_delay
);
2578 * Cancel the job if necessary...
2581 if (job_canceled
> 0 && monitor
->job_id
> 0)
2583 if (!httpReconnect(http
))
2585 cancel_job(http
, monitor
->uri
, monitor
->job_id
, monitor
->resource
,
2586 monitor
->user
, monitor
->version
);
2588 if (cupsLastError() > IPP_OK_CONFLICT
)
2590 fprintf(stderr
, "DEBUG: (monitor) cancel_job() = %s\n", cupsLastErrorString());
2591 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2597 * Cleanup and return...
2607 * 'new_request()' - Create a new print creation or validation request.
2610 static ipp_t
* /* O - Request data */
2612 ipp_op_t op
, /* I - IPP operation code */
2613 int version
, /* I - IPP version number */
2614 const char *uri
, /* I - printer-uri value */
2615 const char *user
, /* I - requesting-user-name value */
2616 const char *title
, /* I - job-name value */
2617 int num_options
, /* I - Number of options to send */
2618 cups_option_t
*options
, /* I - Options to send */
2619 const char *compression
, /* I - compression value or NULL */
2620 int copies
, /* I - copies value or 0 */
2621 const char *format
, /* I - document-format value or NULL */
2622 _ppd_cache_t
*pc
, /* I - PPD cache and mapping data */
2623 ppd_file_t
*ppd
, /* I - PPD file data */
2624 ipp_attribute_t
*media_col_sup
, /* I - media-col-supported values */
2625 ipp_attribute_t
*doc_handling_sup
, /* I - multiple-document-handling-supported values */
2626 ipp_attribute_t
*print_color_mode_sup
)
2627 /* I - Printer supports print-color-mode */
2629 ipp_t
*request
; /* Request data */
2630 const char *keyword
; /* PWG keyword */
2631 ipp_tag_t group
; /* Current group */
2632 ipp_attribute_t
*attr
; /* Current attribute */
2633 char buffer
[1024]; /* Value buffer */
2637 * Create the IPP request...
2640 request
= ippNewRequest(op
);
2641 ippSetVersion(request
, version
/ 10, version
% 10);
2643 fprintf(stderr
, "DEBUG: %s IPP/%d.%d\n",
2644 ippOpString(request
->request
.op
.operation_id
),
2645 request
->request
.op
.version
[0],
2646 request
->request
.op
.version
[1]);
2649 * Add standard attributes...
2652 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
2653 fprintf(stderr
, "DEBUG: printer-uri=\"%s\"\n", uri
);
2657 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "requesting-user-name", NULL
, user
);
2658 fprintf(stderr
, "DEBUG: requesting-user-name=\"%s\"\n", user
);
2661 if (title
&& *title
)
2663 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
, title
);
2664 fprintf(stderr
, "DEBUG: job-name=\"%s\"\n", title
);
2667 if (format
&& op
!= IPP_CREATE_JOB
)
2669 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, format
);
2670 fprintf(stderr
, "DEBUG: document-format=\"%s\"\n", format
);
2674 if (compression
&& op
!= IPP_OP_CREATE_JOB
&& op
!= IPP_OP_VALIDATE_JOB
)
2676 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "compression", NULL
, compression
);
2677 fprintf(stderr
, "DEBUG: compression=\"%s\"\n", compression
);
2679 #endif /* HAVE_LIBZ */
2682 * Handle options on the command-line...
2685 if (num_options
> 0)
2690 * Send standard IPP attributes...
2693 fputs("DEBUG: Adding standard IPP operation/job attributes.\n", stderr
);
2695 copies
= _cupsConvertOptions(request
, ppd
, pc
, media_col_sup
, doc_handling_sup
, print_color_mode_sup
, user
, format
, copies
, num_options
, options
);
2698 * Map FaxOut options...
2701 if ((keyword
= cupsGetOption("phone", num_options
, options
)) != NULL
)
2703 ipp_t
*destination
; /* destination collection */
2704 char phone
[1024], /* Phone number string */
2705 *ptr
, /* Pointer into string */
2706 tel_uri
[1024]; /* tel: URI */
2707 static const char * const allowed
= "0123456789#*-+.()";
2708 /* Allowed characters */
2710 destination
= ippNew();
2713 * Unescape and filter out spaces and other characters that are not
2714 * allowed in a tel: URI.
2717 _httpDecodeURI(phone
, keyword
, sizeof(phone
));
2718 for (ptr
= phone
; *ptr
;)
2720 if (!strchr(allowed
, *ptr
))
2721 _cups_strcpy(ptr
, ptr
+ 1);
2726 httpAssembleURI(HTTP_URI_CODING_ALL
, tel_uri
, sizeof(tel_uri
), "tel", NULL
, NULL
, 0, phone
);
2727 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_URI
, "destination-uri", NULL
, tel_uri
);
2729 if ((keyword
= cupsGetOption("faxPrefix", num_options
,
2730 options
)) != NULL
&& *keyword
)
2732 char predial
[1024]; /* Pre-dial string */
2734 _httpDecodeURI(predial
, keyword
, sizeof(predial
));
2735 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_TEXT
, "pre-dial-string", NULL
, predial
);
2738 ippAddCollection(request
, IPP_TAG_JOB
, "destination-uris", destination
);
2739 ippDelete(destination
);
2745 * When talking to another CUPS server, send all options...
2748 fputs("DEBUG: Adding all operation/job attributes.\n", stderr
);
2749 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_OPERATION
);
2750 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_JOB
);
2753 if (copies
> 1 && (!pc
|| copies
<= pc
->max_copies
))
2754 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies", copies
);
2757 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10,
2758 ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2759 for (group
= IPP_TAG_ZERO
, attr
= ippFirstAttribute(request
);
2761 attr
= ippNextAttribute(request
))
2763 const char *name
= ippGetName(attr
);
2767 group
= IPP_TAG_ZERO
;
2771 if (group
!= ippGetGroupTag(attr
))
2773 group
= ippGetGroupTag(attr
);
2774 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(group
));
2777 ippAttributeString(attr
, buffer
, sizeof(buffer
));
2778 fprintf(stderr
, "DEBUG: %s %s%s %s\n", name
,
2779 ippGetCount(attr
) > 1 ? "1setOf " : "",
2780 ippTagString(ippGetValueTag(attr
)), buffer
);
2783 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(IPP_TAG_END
));
2790 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
2793 static const char * /* O - Password */
2794 password_cb(const char *prompt
, /* I - Prompt (not used) */
2795 http_t
*http
, /* I - Connection */
2796 const char *method
, /* I - Request method (not used) */
2797 const char *resource
, /* I - Resource path (not used) */
2798 int *password_tries
) /* I - Password tries */
2800 char def_username
[HTTP_MAX_VALUE
]; /* Default username */
2803 fprintf(stderr
, "DEBUG: password_cb(prompt=\"%s\", http=%p, method=\"%s\", "
2804 "resource=\"%s\", password_tries=%p(%d)), password=%p\n",
2805 prompt
, http
, method
, resource
, password_tries
, *password_tries
,
2812 if (!uri_credentials
)
2815 * Remember that we need to authenticate...
2818 auth_info_required
= "username,password";
2820 if (httpGetSubField(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "username",
2823 char quoted
[HTTP_MAX_VALUE
* 2 + 4];
2826 fprintf(stderr
, "ATTR: auth-info-default=%s,\n",
2827 quote_string(def_username
, quoted
, sizeof(quoted
)));
2831 if (password
&& *password
&& *password_tries
< 3)
2833 (*password_tries
) ++;
2835 cupsSetUser(username
);
2842 * Give up after 3 tries or if we don't have a password to begin with...
2851 * 'quote_string()' - Quote a string value.
2854 static const char * /* O - Quoted string */
2855 quote_string(const char *s
, /* I - String */
2856 char *q
, /* I - Quoted string buffer */
2857 size_t qsize
) /* I - Size of quoted string buffer */
2859 char *qptr
, /* Pointer into string buffer */
2860 *qend
; /* End of string buffer */
2864 qend
= q
+ qsize
- 5;
2875 while (*s
&& qptr
< qend
)
2877 if (*s
== '\\' || *s
== '\"' || *s
== '\'')
2879 if (qptr
< (qend
- 4))
2901 * 'report_attr()' - Report an IPP attribute value.
2905 report_attr(ipp_attribute_t
*attr
) /* I - Attribute */
2907 int i
; /* Looping var */
2908 char value
[1024], /* Value string */
2909 *valptr
; /* Pointer into value string */
2910 const char *cached
; /* Cached attribute */
2914 * Convert the attribute values into quoted strings...
2917 for (i
= 0, valptr
= value
;
2918 i
< attr
->num_values
&& valptr
< (value
+ sizeof(value
) - 10);
2924 switch (attr
->value_tag
)
2926 case IPP_TAG_INTEGER
:
2928 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), "%d", attr
->values
[i
].integer
);
2929 valptr
+= strlen(valptr
);
2934 case IPP_TAG_KEYWORD
:
2935 quote_string(attr
->values
[i
].string
.text
, valptr
, (size_t)(value
+ sizeof(value
) - valptr
));
2936 valptr
+= strlen(valptr
);
2941 * Unsupported value type...
2950 _cupsMutexLock(&report_mutex
);
2952 if ((cached
= cupsGetOption(attr
->name
, num_attr_cache
,
2953 attr_cache
)) == NULL
|| strcmp(cached
, value
))
2956 * Tell the scheduler about the new values...
2959 num_attr_cache
= cupsAddOption(attr
->name
, value
, num_attr_cache
,
2961 fprintf(stderr
, "ATTR: %s=%s\n", attr
->name
, value
);
2964 _cupsMutexUnlock(&report_mutex
);
2969 * 'report_printer_state()' - Report the printer state.
2973 report_printer_state(ipp_t
*ipp
) /* I - IPP response */
2975 ipp_attribute_t
*pa
, /* printer-alert */
2976 *pam
, /* printer-alert-message */
2977 *pmja
, /* printer-mandatory-job-attributes */
2978 *psm
, /* printer-state-message */
2979 *reasons
, /* printer-state-reasons */
2980 *marker
; /* marker-* attributes */
2981 char value
[1024], /* State/message string */
2982 *valptr
; /* Pointer into string */
2983 static int ipp_supplies
= -1;
2984 /* Report supply levels? */
2988 * Report alerts and messages...
2991 if ((pa
= ippFindAttribute(ipp
, "printer-alert", IPP_TAG_TEXT
)) != NULL
)
2994 if ((pam
= ippFindAttribute(ipp
, "printer-alert-message",
2995 IPP_TAG_TEXT
)) != NULL
)
2998 if ((pmja
= ippFindAttribute(ipp
, "printer-mandatory-job-attributes", IPP_TAG_KEYWORD
)) != NULL
)
3000 int i
, /* Looping var */
3001 count
= ippGetCount(pmja
); /* Number of values */
3003 for (i
= 0, valptr
= value
; i
< count
; i
++, valptr
+= strlen(valptr
))
3006 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), " %s", ippGetString(pmja
, i
, NULL
));
3008 strlcpy(value
, ippGetString(pmja
, i
, NULL
), sizeof(value
));
3011 if (strcmp(value
, mandatory_attrs
))
3013 strlcpy(mandatory_attrs
, value
, sizeof(mandatory_attrs
));
3014 fprintf(stderr
, "PPD: cupsMandatory=\"%s\"\n", value
);
3018 if ((psm
= ippFindAttribute(ipp
, "printer-state-message",
3019 IPP_TAG_TEXT
)) != NULL
)
3021 char *ptr
; /* Pointer into message */
3024 strlcpy(value
, "INFO: ", sizeof(value
));
3025 for (ptr
= psm
->values
[0].string
.text
, valptr
= value
+ 6;
3026 *ptr
&& valptr
< (value
+ sizeof(value
) - 6);
3029 if (*ptr
< ' ' && *ptr
> 0 && *ptr
!= '\t')
3032 * Substitute "<XX>" for the control character; sprintf is safe because
3033 * we always leave 6 chars free at the end...
3036 sprintf(valptr
, "<%02X>", *ptr
);
3046 fputs(value
, stderr
);
3050 * Now report printer-state-reasons, filtering out some of the reasons we never
3054 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
3055 IPP_TAG_KEYWORD
)) == NULL
)
3058 update_reasons(reasons
, NULL
);
3061 * Relay the current marker-* attribute values...
3064 if (ipp_supplies
< 0)
3066 ppd_file_t
*ppd
; /* PPD file */
3067 ppd_attr_t
*ppdattr
; /* Attribute in PPD file */
3069 if ((ppd
= ppdOpenFile(getenv("PPD"))) != NULL
&&
3070 (ppdattr
= ppdFindAttr(ppd
, "cupsIPPSupplies", NULL
)) != NULL
&&
3071 ppdattr
->value
&& _cups_strcasecmp(ppdattr
->value
, "true"))
3079 if (ipp_supplies
> 0)
3081 if ((marker
= ippFindAttribute(ipp
, "marker-colors", IPP_TAG_NAME
)) != NULL
)
3082 report_attr(marker
);
3083 if ((marker
= ippFindAttribute(ipp
, "marker-high-levels",
3084 IPP_TAG_INTEGER
)) != NULL
)
3085 report_attr(marker
);
3086 if ((marker
= ippFindAttribute(ipp
, "marker-levels",
3087 IPP_TAG_INTEGER
)) != NULL
)
3088 report_attr(marker
);
3089 if ((marker
= ippFindAttribute(ipp
, "marker-low-levels",
3090 IPP_TAG_INTEGER
)) != NULL
)
3091 report_attr(marker
);
3092 if ((marker
= ippFindAttribute(ipp
, "marker-message",
3093 IPP_TAG_TEXT
)) != NULL
)
3094 report_attr(marker
);
3095 if ((marker
= ippFindAttribute(ipp
, "marker-names", IPP_TAG_NAME
)) != NULL
)
3096 report_attr(marker
);
3097 if ((marker
= ippFindAttribute(ipp
, "marker-types",
3098 IPP_TAG_KEYWORD
)) != NULL
)
3099 report_attr(marker
);
3104 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3106 * 'run_as_user()' - Run the IPP backend as the printing user.
3108 * This function uses an XPC-based user agent to run the backend as the printing
3109 * user. We need to do this in order to have access to the user's Kerberos
3113 static int /* O - Exit status */
3114 run_as_user(char *argv
[], /* I - Command-line arguments */
3115 uid_t uid
, /* I - User ID */
3116 const char *device_uri
, /* I - Device URI */
3117 int fd
) /* I - File to print */
3119 const char *auth_negotiate
;/* AUTH_NEGOTIATE env var */
3120 xpc_connection_t conn
; /* Connection to XPC service */
3121 xpc_object_t request
; /* Request message dictionary */
3122 __block xpc_object_t response
; /* Response message dictionary */
3123 dispatch_semaphore_t sem
; /* Semaphore for waiting for response */
3124 int status
= CUPS_BACKEND_FAILED
;
3125 /* Status of request */
3128 fprintf(stderr
, "DEBUG: Running IPP backend as UID %d.\n", (int)uid
);
3131 * Connect to the user agent for the specified UID...
3134 conn
= xpc_connection_create_mach_service(kPMPrintUIToolAgent
,
3135 dispatch_get_global_queue(0, 0), 0);
3138 _cupsLangPrintFilter(stderr
, "ERROR",
3139 _("Unable to start backend process."));
3140 fputs("DEBUG: Unable to create connection to agent.\n", stderr
);
3144 xpc_connection_set_event_handler(conn
,
3145 ^(xpc_object_t event
)
3147 xpc_type_t messageType
= xpc_get_type(event
);
3149 if (messageType
== XPC_TYPE_ERROR
)
3151 if (event
== XPC_ERROR_CONNECTION_INTERRUPTED
)
3152 fprintf(stderr
, "DEBUG: Interrupted connection to service %s.\n",
3153 xpc_connection_get_name(conn
));
3154 else if (event
== XPC_ERROR_CONNECTION_INVALID
)
3155 fprintf(stderr
, "DEBUG: Connection invalid for service %s.\n",
3156 xpc_connection_get_name(conn
));
3158 fprintf(stderr
, "DEBUG: Unxpected error for service %s: %s\n",
3159 xpc_connection_get_name(conn
),
3160 xpc_dictionary_get_string(event
, XPC_ERROR_KEY_DESCRIPTION
));
3163 xpc_connection_set_target_uid(conn
, uid
);
3164 xpc_connection_resume(conn
);
3167 * Try starting the backend...
3170 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3171 xpc_dictionary_set_int64(request
, "command", kPMStartJob
);
3172 xpc_dictionary_set_string(request
, "device-uri", device_uri
);
3173 xpc_dictionary_set_string(request
, "job-id", argv
[1]);
3174 xpc_dictionary_set_string(request
, "user", argv
[2]);
3175 xpc_dictionary_set_string(request
, "title", argv
[3]);
3176 xpc_dictionary_set_string(request
, "copies", argv
[4]);
3177 xpc_dictionary_set_string(request
, "options", argv
[5]);
3178 xpc_dictionary_set_string(request
, "auth-info-required",
3179 getenv("AUTH_INFO_REQUIRED"));
3180 if ((auth_negotiate
= getenv("AUTH_NEGOTIATE")) != NULL
)
3181 xpc_dictionary_set_string(request
, "auth-negotiate", auth_negotiate
);
3182 xpc_dictionary_set_fd(request
, "stdin", fd
);
3183 xpc_dictionary_set_fd(request
, "stderr", 2);
3184 xpc_dictionary_set_fd(request
, "side-channel", CUPS_SC_FD
);
3186 sem
= dispatch_semaphore_create(0);
3189 xpc_connection_send_message_with_reply(conn
, request
,
3190 dispatch_get_global_queue(0,0),
3191 ^(xpc_object_t reply
)
3193 /* Save the response and wake up */
3194 if (xpc_get_type(reply
)
3195 == XPC_TYPE_DICTIONARY
)
3196 response
= xpc_retain(reply
);
3198 dispatch_semaphore_signal(sem
);
3201 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3202 xpc_release(request
);
3203 dispatch_release(sem
);
3207 child_pid
= (pid_t
)xpc_dictionary_get_int64(response
, "child-pid");
3209 xpc_release(response
);
3212 fprintf(stderr
, "DEBUG: Child PID=%d.\n", (int)child_pid
);
3215 _cupsLangPrintFilter(stderr
, "ERROR",
3216 _("Unable to start backend process."));
3217 fputs("DEBUG: No child PID.\n", stderr
);
3223 _cupsLangPrintFilter(stderr
, "ERROR",
3224 _("Unable to start backend process."));
3225 fputs("DEBUG: No reply from agent.\n", stderr
);
3230 * Then wait for the backend to finish...
3233 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3234 xpc_dictionary_set_int64(request
, "command", kPMWaitForJob
);
3235 xpc_dictionary_set_fd(request
, "stderr", 2);
3237 sem
= dispatch_semaphore_create(0);
3240 xpc_connection_send_message_with_reply(conn
, request
,
3241 dispatch_get_global_queue(0,0),
3242 ^(xpc_object_t reply
)
3244 /* Save the response and wake up */
3245 if (xpc_get_type(reply
)
3246 == XPC_TYPE_DICTIONARY
)
3247 response
= xpc_retain(reply
);
3249 dispatch_semaphore_signal(sem
);
3252 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3253 xpc_release(request
);
3254 dispatch_release(sem
);
3258 status
= (int)xpc_dictionary_get_int64(response
, "status");
3260 if (status
== SIGTERM
|| status
== SIGKILL
|| status
== SIGPIPE
)
3262 fprintf(stderr
, "DEBUG: Child terminated on signal %d.\n", status
);
3263 status
= CUPS_BACKEND_FAILED
;
3265 else if (WIFSIGNALED(status
))
3267 fprintf(stderr
, "DEBUG: Child crashed on signal %d.\n", status
);
3268 status
= CUPS_BACKEND_STOP
;
3270 else if (WIFEXITED(status
))
3272 status
= WEXITSTATUS(status
);
3273 fprintf(stderr
, "DEBUG: Child exited with status %d.\n", status
);
3276 xpc_release(response
);
3279 _cupsLangPrintFilter(stderr
, "ERROR",
3280 _("Unable to get backend exit status."));
3286 xpc_connection_cancel(conn
);
3292 #endif /* HAVE_GSSAPI && HAVE_XPC */
3296 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
3300 sigterm_handler(int sig
) /* I - Signal */
3302 (void)sig
; /* remove compiler warnings... */
3304 write(2, "DEBUG: Got SIGTERM.\n", 20);
3306 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3309 kill(child_pid
, sig
);
3312 #endif /* HAVE_GSSAPI && HAVE_XPC */
3317 * Flag that the job should be canceled...
3320 write(2, "DEBUG: sigterm_handler: job_canceled = 1.\n", 25);
3327 * The scheduler already tried to cancel us once, now just terminate
3328 * after removing our temp file!
3332 unlink(tmpfilename
);
3339 * 'timeout_cb()' - Handle HTTP timeouts.
3342 static int /* O - 1 to continue, 0 to cancel */
3343 timeout_cb(http_t
*http
, /* I - Connection to server (unused) */
3344 void *user_data
) /* I - User data (unused) */
3349 return (!job_canceled
);
3354 * 'update_reasons()' - Update the printer-state-reasons values.
3358 update_reasons(ipp_attribute_t
*attr
, /* I - printer-state-reasons or NULL */
3359 const char *s
) /* I - STATE: string or NULL */
3361 char op
; /* Add (+), remove (-), replace (\0) */
3362 cups_array_t
*new_reasons
; /* New reasons array */
3363 char *reason
, /* Current reason */
3364 add
[2048], /* Reasons added string */
3365 *addptr
, /* Pointer into add string */
3366 rem
[2048], /* Reasons removed string */
3367 *remptr
; /* Pointer into remove string */
3368 const char *addprefix
, /* Current add string prefix */
3369 *remprefix
; /* Current remove string prefix */
3372 fprintf(stderr
, "DEBUG: update_reasons(attr=%d(%s%s), s=\"%s\")\n",
3373 attr
? attr
->num_values
: 0, attr
? attr
->values
[0].string
.text
: "",
3374 attr
&& attr
->num_values
> 1 ? ",..." : "", s
? s
: "(null)");
3377 * Create an array of new reason keyword strings...
3382 int i
; /* Looping var */
3384 new_reasons
= cupsArrayNew((cups_array_func_t
)strcmp
, NULL
);
3387 for (i
= 0; i
< attr
->num_values
; i
++)
3389 reason
= attr
->values
[i
].string
.text
;
3391 if (strcmp(reason
, "none") &&
3392 strcmp(reason
, "none-report") &&
3393 strcmp(reason
, "paused") &&
3394 strncmp(reason
, "spool-area-full", 15) &&
3395 strcmp(reason
, "com.apple.print.recoverable-warning") &&
3396 strncmp(reason
, "cups-", 5))
3397 cupsArrayAdd(new_reasons
, reason
);
3402 if (*s
== '+' || *s
== '-')
3407 new_reasons
= _cupsArrayNewStrings(s
, ',');
3413 * Compute the changes...
3417 addprefix
= "STATE: +";
3420 remprefix
= "STATE: -";
3423 fprintf(stderr
, "DEBUG2: op='%c', new_reasons=%d, state_reasons=%d\n",
3424 op
? op
: ' ', cupsArrayCount(new_reasons
),
3425 cupsArrayCount(state_reasons
));
3427 _cupsMutexLock(&report_mutex
);
3435 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3437 reason
= (char *)cupsArrayNext(new_reasons
))
3439 if (!cupsArrayFind(state_reasons
, reason
))
3441 if (!strncmp(reason
, "cups-remote-", 12))
3444 * If we are setting cups-remote-xxx, remove all other cups-remote-xxx
3448 char *temp
; /* Current reason in state_reasons */
3450 cupsArraySave(state_reasons
);
3452 for (temp
= (char *)cupsArrayFirst(state_reasons
);
3454 temp
= (char *)cupsArrayNext(state_reasons
))
3455 if (!strncmp(temp
, "cups-remote-", 12))
3457 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, temp
);
3458 remptr
+= strlen(remptr
);
3461 cupsArrayRemove(state_reasons
, temp
);
3465 cupsArrayRestore(state_reasons
);
3468 cupsArrayAdd(state_reasons
, reason
);
3470 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3471 addptr
+= strlen(addptr
);
3482 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3484 reason
= (char *)cupsArrayNext(new_reasons
))
3486 if (cupsArrayFind(state_reasons
, reason
))
3488 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3489 remptr
+= strlen(remptr
);
3492 cupsArrayRemove(state_reasons
, reason
);
3499 * Replace reasons...
3502 for (reason
= (char *)cupsArrayFirst(state_reasons
);
3504 reason
= (char *)cupsArrayNext(state_reasons
))
3506 if (strncmp(reason
, "cups-", 5) && !cupsArrayFind(new_reasons
, reason
))
3508 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3509 remptr
+= strlen(remptr
);
3512 cupsArrayRemove(state_reasons
, reason
);
3516 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3518 reason
= (char *)cupsArrayNext(new_reasons
))
3520 if (!cupsArrayFind(state_reasons
, reason
))
3522 cupsArrayAdd(state_reasons
, reason
);
3524 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3525 addptr
+= strlen(addptr
);
3531 _cupsMutexUnlock(&report_mutex
);
3534 * Report changes and return...
3537 if (add
[0] && rem
[0])
3538 fprintf(stderr
, "%s\n%s\n", add
, rem
);
3540 fprintf(stderr
, "%s\n", add
);
3542 fprintf(stderr
, "%s\n", rem
);