4 * IPP backend for CUPS.
6 * Copyright 2007-2014 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * "LICENSE" which should have been included with this file. If this
13 * file is missing or damaged, see the license at "http://www.cups.org/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * Include necessary headers.
22 #include "backend-private.h"
23 #include <cups/array-private.h>
24 #include <sys/types.h>
27 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
29 # define kPMPrintUIToolAgent "com.apple.printuitool.agent"
30 # define kPMStartJob 100
31 # define kPMWaitForJob 101
32 # ifdef HAVE_XPC_PRIVATE_H
33 # include <xpc/private.h>
35 extern void xpc_connection_set_target_uid(xpc_connection_t connection
,
37 # endif /* HAVE_XPC_PRIVATE_H */
38 #endif /* HAVE_GSSAPI && HAVE_XPC */
42 * Bits for job-state-reasons we care about...
45 #define _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED 0x01
46 #define _CUPS_JSR_ACCOUNT_CLOSED 0x02
47 #define _CUPS_JSR_ACCOUNT_INFO_NEEDED 0x04
48 #define _CUPS_JSR_ACCOUNT_LIMIT_REACHED 0x08
49 #define _CUPS_JSR_JOB_PASSWORD_WAIT 0x10
50 #define _CUPS_JSR_JOB_RELEASE_WAIT 0x20
57 typedef struct _cups_monitor_s
/**** Monitoring data ****/
59 const char *uri
, /* Printer URI */
60 *hostname
, /* Hostname */
62 *resource
; /* Resource path */
63 int port
, /* Port number */
64 version
, /* IPP version */
65 job_id
, /* Job ID for submitted job */
66 job_reasons
, /* Job state reasons bits */
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;
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",
109 "marker-high-levels",
115 "media-col-supported",
116 "multiple-document-handling-supported",
117 "operations-supported",
118 "print-color-mode-supported",
120 "printer-alert-description",
121 "printer-is-accepting-jobs",
123 "printer-state-message",
124 "printer-state-reasons"
126 static const char * const remote_job_states
[] =
127 { /* Remote job state keywords */
128 "+cups-remote-pending",
129 "+cups-remote-pending-held",
130 "+cups-remote-processing",
131 "+cups-remote-stopped",
132 "+cups-remote-canceled",
133 "+cups-remote-aborted",
134 "+cups-remote-completed"
136 static _cups_mutex_t report_mutex
= _CUPS_MUTEX_INITIALIZER
;
137 /* Mutex to control access */
138 static int num_attr_cache
= 0;
139 /* Number of cached attributes */
140 static cups_option_t
*attr_cache
= NULL
;
141 /* Cached attributes */
142 static cups_array_t
*state_reasons
; /* Array of printe-state-reasons keywords */
143 static char tmpfilename
[1024] = "";
144 /* Temporary spool file name */
151 static void cancel_job(http_t
*http
, const char *uri
, int id
,
152 const char *resource
, const char *user
,
154 static ipp_pstate_t
check_printer_state(http_t
*http
, const char *uri
,
155 const char *resource
,
156 const char *user
, int version
);
157 static void *monitor_printer(_cups_monitor_t
*monitor
);
158 static ipp_t
*new_request(ipp_op_t op
, int version
, const char *uri
,
159 const char *user
, const char *title
,
160 int num_options
, cups_option_t
*options
,
161 const char *compression
, int copies
,
162 const char *format
, _ppd_cache_t
*pc
,
164 ipp_attribute_t
*media_col_sup
,
165 ipp_attribute_t
*doc_handling_sup
,
166 ipp_attribute_t
*print_color_mode_sup
);
167 static const char *password_cb(const char *prompt
, http_t
*http
,
168 const char *method
, const char *resource
,
170 static const char *quote_string(const char *s
, char *q
, size_t qsize
);
171 static void report_attr(ipp_attribute_t
*attr
);
172 static void report_printer_state(ipp_t
*ipp
);
173 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
174 static int run_as_user(char *argv
[], uid_t uid
,
175 const char *device_uri
, int fd
);
176 #endif /* HAVE_GSSAPI && HAVE_XPC */
177 static void sigterm_handler(int sig
);
178 static int timeout_cb(http_t
*http
, void *user_data
);
179 static void update_reasons(ipp_attribute_t
*attr
, const char *s
);
183 * 'main()' - Send a file to the printer or server.
187 * printer-uri job-id user title copies options [file]
190 int /* O - Exit status */
191 main(int argc
, /* I - Number of command-line args */
192 char *argv
[]) /* I - Command-line arguments */
194 int i
; /* Looping var */
195 int send_options
; /* Send job options? */
196 int num_options
; /* Number of printer options */
197 cups_option_t
*options
; /* Printer options */
198 const char *device_uri
; /* Device URI */
199 char scheme
[255], /* Scheme in URI */
200 hostname
[1024], /* Hostname */
201 resource
[1024], /* Resource info (printer name) */
202 addrname
[256], /* Address name */
203 *optptr
, /* Pointer to URI options */
204 *name
, /* Name of option */
205 *value
, /* Value of option */
206 sep
; /* Separator character */
207 int password_tries
= 0; /* Password tries */
208 http_addrlist_t
*addrlist
; /* Address of printer */
209 int snmp_enabled
= 1; /* Is SNMP enabled? */
210 int snmp_fd
, /* SNMP socket */
211 start_count
, /* Page count via SNMP at start */
212 page_count
, /* Page count via SNMP */
213 have_supplies
; /* Printer supports supply levels? */
214 int num_files
; /* Number of files to print */
215 char **files
, /* Files to print */
216 *compatfile
= NULL
; /* Compatibility filename */
217 off_t compatsize
= 0; /* Size of compatibility file */
218 int port
; /* Port number (not used) */
219 char portname
[255]; /* Port name */
220 char uri
[HTTP_MAX_URI
]; /* Updated URI without user/pass */
221 char print_job_name
[1024]; /* Update job-name for Print-Job */
222 http_status_t http_status
; /* Status of HTTP request */
223 ipp_status_t ipp_status
; /* Status of IPP request */
224 http_t
*http
; /* HTTP connection */
225 ipp_t
*request
, /* IPP request */
226 *response
, /* IPP response */
227 *supported
; /* get-printer-attributes response */
228 time_t start_time
; /* Time of first connect */
229 int contimeout
; /* Connection timeout */
230 int delay
, /* Delay for retries */
231 prev_delay
; /* Previous delay */
232 const char *compression
; /* Compression mode */
233 int waitjob
, /* Wait for job complete? */
234 waitjob_tries
= 0, /* Number of times we've waited */
235 waitprinter
; /* Wait for printer ready? */
236 _cups_monitor_t monitor
; /* Monitoring data */
237 ipp_attribute_t
*job_id_attr
; /* job-id attribute */
238 int job_id
; /* job-id value */
239 ipp_attribute_t
*job_sheets
; /* job-media-sheets-completed */
240 ipp_attribute_t
*job_state
; /* job-state */
242 ipp_attribute_t
*compression_sup
; /* compression-supported */
243 #endif /* HAVE_LIBZ */
244 ipp_attribute_t
*copies_sup
; /* copies-supported */
245 ipp_attribute_t
*cups_version
; /* cups-version */
246 ipp_attribute_t
*format_sup
; /* document-format-supported */
247 ipp_attribute_t
*job_auth
; /* job-authorization-uri */
248 ipp_attribute_t
*media_col_sup
; /* media-col-supported */
249 ipp_attribute_t
*operations_sup
; /* operations-supported */
250 ipp_attribute_t
*doc_handling_sup
; /* multiple-document-handling-supported */
251 ipp_attribute_t
*printer_state
; /* printer-state attribute */
252 ipp_attribute_t
*printer_accepting
; /* printer-is-accepting-jobs */
253 ipp_attribute_t
*print_color_mode_sup
;/* Does printer support print-color-mode? */
254 int create_job
= 0, /* Does printer support Create-Job? */
255 get_job_attrs
= 0, /* Does printer support Get-Job-Attributes? */
256 send_document
= 0, /* Does printer support Send-Document? */
257 validate_job
= 0, /* Does printer support Validate-Job? */
258 copies
, /* Number of copies for job */
259 copies_remaining
; /* Number of copies remaining */
260 const char *content_type
, /* CONTENT_TYPE environment variable */
261 *final_content_type
, /* FINAL_CONTENT_TYPE environment var */
262 *document_format
; /* document-format value */
263 int fd
; /* File descriptor */
264 off_t bytes
= 0; /* Bytes copied */
265 char buffer
[16384]; /* Copy buffer */
266 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
267 struct sigaction action
; /* Actions for POSIX signals */
268 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
269 int version
; /* IPP version */
270 ppd_file_t
*ppd
= NULL
; /* PPD file */
271 _ppd_cache_t
*pc
= NULL
; /* PPD cache and mapping data */
272 fd_set input
; /* Input set for select() */
276 * Make sure status messages are not buffered...
279 setbuf(stderr
, NULL
);
282 * Ignore SIGPIPE and catch SIGTERM signals...
286 sigset(SIGPIPE
, SIG_IGN
);
287 sigset(SIGTERM
, sigterm_handler
);
288 #elif defined(HAVE_SIGACTION)
289 memset(&action
, 0, sizeof(action
));
290 action
.sa_handler
= SIG_IGN
;
291 sigaction(SIGPIPE
, &action
, NULL
);
293 sigemptyset(&action
.sa_mask
);
294 sigaddset(&action
.sa_mask
, SIGTERM
);
295 action
.sa_handler
= sigterm_handler
;
296 sigaction(SIGTERM
, &action
, NULL
);
298 signal(SIGPIPE
, SIG_IGN
);
299 signal(SIGTERM
, sigterm_handler
);
300 #endif /* HAVE_SIGSET */
303 * Check command-line...
310 if ((s
= strrchr(argv
[0], '/')) != NULL
)
315 printf("network %s \"Unknown\" \"%s (%s)\"\n",
316 s
, _cupsLangString(cupsLangDefault(),
317 _("Internet Printing Protocol")), s
);
318 return (CUPS_BACKEND_OK
);
322 _cupsLangPrintf(stderr
,
323 _("Usage: %s job-id user title copies options [file]"),
325 return (CUPS_BACKEND_STOP
);
329 * Get the device URI...
332 while ((device_uri
= cupsBackendDeviceURI(argv
)) == NULL
)
334 _cupsLangPrintFilter(stderr
, "INFO", _("Unable to locate printer."));
337 if (getenv("CLASS") != NULL
)
338 return (CUPS_BACKEND_FAILED
);
341 if ((auth_info_required
= getenv("AUTH_INFO_REQUIRED")) == NULL
)
342 auth_info_required
= "none";
344 state_reasons
= _cupsArrayNewStrings(getenv("PRINTER_STATE_REASONS"), ',');
348 * For Kerberos, become the printing user (if we can) to get the credentials
352 if (!getuid() && (value
= getenv("AUTH_UID")) != NULL
&&
353 !getenv("AUTH_PASSWORD"))
355 uid_t uid
= (uid_t
)atoi(value
);
362 return (run_as_user(argv
, uid
, device_uri
, 0));
365 int status
= 0; /* Exit status */
367 for (i
= 6; i
< argc
&& !status
&& !job_canceled
; i
++)
369 if ((fd
= open(argv
[i
], O_RDONLY
)) >= 0)
371 status
= run_as_user(argv
, uid
, device_uri
, fd
);
376 _cupsLangPrintError("ERROR", _("Unable to open print file"));
377 status
= CUPS_BACKEND_FAILED
;
385 # else /* No XPC, just try to run as the user ID */
388 # endif /* HAVE_XPC */
390 #endif /* HAVE_GSSAPI */
393 * Get the (final) content type...
396 if ((content_type
= getenv("CONTENT_TYPE")) == NULL
)
397 content_type
= "application/octet-stream";
399 if ((final_content_type
= getenv("FINAL_CONTENT_TYPE")) == NULL
)
401 final_content_type
= content_type
;
403 if (!strncmp(final_content_type
, "printer/", 8))
404 final_content_type
= "application/vnd.cups-raw";
408 * Extract the hostname and printer name from the URI...
411 httpSeparateURI(HTTP_URI_CODING_ALL
, device_uri
, scheme
, sizeof(scheme
),
412 username
, sizeof(username
), hostname
, sizeof(hostname
), &port
,
413 resource
, sizeof(resource
));
416 port
= IPP_PORT
; /* Default to port 631 */
418 if (!strcmp(scheme
, "https") || !strcmp(scheme
, "ipps"))
419 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
421 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
424 * See if there are any options...
431 contimeout
= 7 * 24 * 60 * 60;
433 if ((optptr
= strchr(resource
, '?')) != NULL
)
436 * Yup, terminate the device name string and move to the first
437 * character of the optptr...
443 * Then parse the optptr...
454 while (*optptr
&& *optptr
!= '=' && *optptr
!= '+' && *optptr
!= '&')
457 if ((sep
= *optptr
) != '\0')
468 while (*optptr
&& *optptr
!= '+' && *optptr
!= '&')
478 * Process the option...
481 if (!_cups_strcasecmp(name
, "waitjob"))
484 * Wait for job completion?
487 waitjob
= !_cups_strcasecmp(value
, "on") ||
488 !_cups_strcasecmp(value
, "yes") ||
489 !_cups_strcasecmp(value
, "true");
491 else if (!_cups_strcasecmp(name
, "waitprinter"))
494 * Wait for printer idle?
497 waitprinter
= !_cups_strcasecmp(value
, "on") ||
498 !_cups_strcasecmp(value
, "yes") ||
499 !_cups_strcasecmp(value
, "true");
501 else if (!_cups_strcasecmp(name
, "encryption"))
504 * Enable/disable encryption?
507 if (!_cups_strcasecmp(value
, "always"))
508 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
509 else if (!_cups_strcasecmp(value
, "required"))
510 cupsSetEncryption(HTTP_ENCRYPT_REQUIRED
);
511 else if (!_cups_strcasecmp(value
, "never"))
512 cupsSetEncryption(HTTP_ENCRYPT_NEVER
);
513 else if (!_cups_strcasecmp(value
, "ifrequested"))
514 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
517 _cupsLangPrintFilter(stderr
, "ERROR",
518 _("Unknown encryption option value: \"%s\"."),
522 else if (!_cups_strcasecmp(name
, "snmp"))
525 * Enable/disable SNMP stuff...
528 snmp_enabled
= !value
[0] || !_cups_strcasecmp(value
, "on") ||
529 _cups_strcasecmp(value
, "yes") ||
530 _cups_strcasecmp(value
, "true");
532 else if (!_cups_strcasecmp(name
, "version"))
534 if (!strcmp(value
, "1.0"))
536 else if (!strcmp(value
, "1.1"))
538 else if (!strcmp(value
, "2.0"))
540 else if (!strcmp(value
, "2.1"))
542 else if (!strcmp(value
, "2.2"))
546 _cupsLangPrintFilter(stderr
, "ERROR",
547 _("Unknown version option value: \"%s\"."),
552 else if (!_cups_strcasecmp(name
, "compression"))
554 if (!_cups_strcasecmp(value
, "true") || !_cups_strcasecmp(value
, "yes") ||
555 !_cups_strcasecmp(value
, "on") || !_cups_strcasecmp(value
, "gzip"))
556 compression
= "gzip";
557 else if (!_cups_strcasecmp(value
, "deflate"))
558 compression
= "deflate";
559 else if (!_cups_strcasecmp(value
, "false") ||
560 !_cups_strcasecmp(value
, "no") ||
561 !_cups_strcasecmp(value
, "off") ||
562 !_cups_strcasecmp(value
, "none"))
563 compression
= "none";
565 #endif /* HAVE_LIBZ */
566 else if (!_cups_strcasecmp(name
, "contimeout"))
569 * Set the connection timeout...
573 contimeout
= atoi(value
);
581 _cupsLangPrintFilter(stderr
, "ERROR",
582 _("Unknown option \"%s\" with value \"%s\"."),
589 * If we have 7 arguments, print the file named on the command-line.
590 * Otherwise, copy stdin to a temporary file and print the temporary
598 send_options
= !_cups_strcasecmp(final_content_type
, "application/pdf") ||
599 !_cups_strcasecmp(final_content_type
, "application/vnd.cups-pdf") ||
600 !_cups_strncasecmp(final_content_type
, "image/", 6);
602 fputs("DEBUG: Sending stdin for job...\n", stderr
);
607 * Point to the files on the command-line...
610 num_files
= argc
- 6;
614 fprintf(stderr
, "DEBUG: %d files to send in job...\n", num_files
);
618 * Set the authentication info, if any...
621 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
626 * Use authentication information in the device URI...
629 if ((password
= strchr(username
, ':')) != NULL
)
632 cupsSetUser(username
);
637 * Try loading authentication information from the environment.
640 const char *ptr
= getenv("AUTH_USERNAME");
644 strlcpy(username
, ptr
, sizeof(username
));
648 password
= getenv("AUTH_PASSWORD");
652 * Try finding the remote server...
655 start_time
= time(NULL
);
657 sprintf(portname
, "%d", port
);
659 update_reasons(NULL
, "+connecting-to-device");
660 fprintf(stderr
, "DEBUG: Looking up \"%s\"...\n", hostname
);
662 while ((addrlist
= httpAddrGetList(hostname
, AF_UNSPEC
, portname
)) == NULL
)
664 _cupsLangPrintFilter(stderr
, "INFO",
665 _("Unable to locate printer \"%s\"."), hostname
);
668 if (getenv("CLASS") != NULL
)
670 update_reasons(NULL
, "-connecting-to-device");
671 return (CUPS_BACKEND_STOP
);
675 return (CUPS_BACKEND_OK
);
678 http
= httpConnect2(hostname
, port
, addrlist
, AF_UNSPEC
, cupsEncryption(), 1,
680 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
682 if (httpIsEncrypted(http
))
685 * Validate TLS credentials...
688 cups_array_t
*creds
; /* TLS credentials */
689 http_trust_t trust
; /* Trust level */
690 static const char *trusts
[] = { NULL
, "+cups-pki-invalid", "+cups-pki-changed", "+cups-pki-expired", NULL
, "+cups-pki-unknown" };
693 if (!httpCopyCredentials(http
, &creds
))
695 trust
= httpCredentialsGetTrust(creds
, hostname
);
697 update_reasons(NULL
, "-cups-pki-invalid,cups-pki-changed,cups-pki-expired,cups-pki-unknown");
700 update_reasons(NULL
, trusts
[trust
]);
701 return (CUPS_BACKEND_STOP
);
704 httpFreeCredentials(creds
);
709 * See if the printer supports SNMP...
713 snmp_fd
= _cupsSNMPOpen(addrlist
->addr
.addr
.sa_family
);
718 have_supplies
= !backendSNMPSupplies(snmp_fd
, &(addrlist
->addr
),
721 have_supplies
= start_count
= 0;
724 * Wait for data from the filter...
729 if (!backendWaitLoop(snmp_fd
, &(addrlist
->addr
), 0, backendNetworkSideCB
))
730 return (CUPS_BACKEND_OK
);
731 else if ((bytes
= read(0, buffer
, sizeof(buffer
))) <= 0)
732 return (CUPS_BACKEND_OK
);
736 * Try connecting to the remote server...
739 delay
= _cupsNextDelay(0, &prev_delay
);
743 fprintf(stderr
, "DEBUG: Connecting to %s:%d\n", hostname
, port
);
744 _cupsLangPrintFilter(stderr
, "INFO", _("Connecting to printer."));
746 if (httpReconnect(http
))
748 int error
= errno
; /* Connection error */
750 if (http
->status
== HTTP_PKI_ERROR
)
751 update_reasons(NULL
, "+cups-certificate-error");
756 if (getenv("CLASS") != NULL
)
759 * If the CLASS environment variable is set, the job was submitted
760 * to a class and not to a specific queue. In this case, we want
761 * to abort immediately so that the job can be requeued on the next
762 * available printer in the class.
765 _cupsLangPrintFilter(stderr
, "INFO",
766 _("Unable to contact printer, queuing on next "
767 "printer in class."));
770 * Sleep 5 seconds to keep the job from requeuing too rapidly...
775 update_reasons(NULL
, "-connecting-to-device");
777 return (CUPS_BACKEND_FAILED
);
780 fprintf(stderr
, "DEBUG: Connection error: %s\n", strerror(errno
));
782 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
||
783 errno
== EHOSTUNREACH
)
785 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
787 _cupsLangPrintFilter(stderr
, "ERROR",
788 _("The printer is not responding."));
789 update_reasons(NULL
, "-connecting-to-device");
790 return (CUPS_BACKEND_FAILED
);
796 _cupsLangPrintFilter(stderr
, "WARNING",
797 _("The printer may not exist or "
798 "is unavailable at this time."));
802 _cupsLangPrintFilter(stderr
, "WARNING",
803 _("The printer is unreachable at this "
809 _cupsLangPrintFilter(stderr
, "WARNING",
810 _("The printer is in use."));
814 sleep((unsigned)delay
);
816 delay
= _cupsNextDelay(delay
, &prev_delay
);
820 _cupsLangPrintFilter(stderr
, "ERROR",
821 _("The printer is not responding."));
829 update_reasons(NULL
, "-cups-certificate-error");
831 while (http
->fd
< 0);
834 return (CUPS_BACKEND_OK
);
836 return (CUPS_BACKEND_FAILED
);
838 update_reasons(NULL
, "-connecting-to-device");
839 _cupsLangPrintFilter(stderr
, "INFO", _("Connected to printer."));
841 fprintf(stderr
, "DEBUG: Connected to %s:%d...\n",
842 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
843 httpAddrPort(http
->hostaddr
));
846 * Build a URI for the printer and fill the standard IPP attributes for
847 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
848 * might contain username:password information...
851 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), scheme
, NULL
, hostname
,
855 * First validate the destination and see if the device supports multiple
860 compression_sup
= NULL
;
861 #endif /* HAVE_LIBZ */
865 media_col_sup
= NULL
;
867 operations_sup
= NULL
;
868 doc_handling_sup
= NULL
;
869 print_color_mode_sup
= NULL
;
874 * Check for side-channel requests...
877 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
880 * Build the IPP request...
883 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
884 ippSetVersion(request
, version
/ 10, version
% 10);
885 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
888 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
889 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
896 fputs("DEBUG: Getting supported attributes...\n", stderr
);
898 if (http
->version
< HTTP_1_1
)
900 fprintf(stderr
, "DEBUG: Printer responded with HTTP version %d.%d.\n",
901 http
->version
/ 100, http
->version
% 100);
902 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
903 "cups-ipp-wrong-http-version");
906 supported
= cupsDoRequest(http
, request
, resource
);
907 ipp_status
= cupsLastError();
909 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
910 ippErrorString(ipp_status
), cupsLastErrorString());
912 if (ipp_status
<= IPP_OK_CONFLICT
)
916 fprintf(stderr
, "DEBUG: Get-Printer-Attributes returned %s.\n",
917 ippErrorString(ipp_status
));
919 if (ipp_status
== IPP_PRINTER_BUSY
||
920 ipp_status
== IPP_SERVICE_UNAVAILABLE
)
922 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
924 _cupsLangPrintFilter(stderr
, "ERROR",
925 _("The printer is not responding."));
926 return (CUPS_BACKEND_FAILED
);
929 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
931 report_printer_state(supported
);
933 sleep((unsigned)delay
);
935 delay
= _cupsNextDelay(delay
, &prev_delay
);
937 else if ((ipp_status
== IPP_BAD_REQUEST
||
938 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
> 10)
941 * Switch to IPP/1.1 or IPP/1.0...
946 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
948 "DEBUG: The printer does not support IPP/%d.%d, trying "
949 "IPP/1.1.\n", version
/ 10, version
% 10);
954 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
956 "DEBUG: The printer does not support IPP/%d.%d, trying "
957 "IPP/1.0.\n", version
/ 10, version
% 10);
963 else if (ipp_status
== IPP_NOT_FOUND
)
965 _cupsLangPrintFilter(stderr
, "ERROR",
966 _("The printer configuration is incorrect or the "
967 "printer no longer exists."));
969 ippDelete(supported
);
971 return (CUPS_BACKEND_STOP
);
973 else if (ipp_status
== IPP_FORBIDDEN
||
974 ipp_status
== IPP_AUTHENTICATION_CANCELED
)
976 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
977 /* WWW-Authenticate field value */
979 if (!strncmp(www_auth
, "Negotiate", 9))
980 auth_info_required
= "negotiate";
981 else if (www_auth
[0])
982 auth_info_required
= "username,password";
984 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
985 return (CUPS_BACKEND_AUTH_REQUIRED
);
987 else if (ipp_status
!= IPP_NOT_AUTHORIZED
)
989 _cupsLangPrintFilter(stderr
, "ERROR",
990 _("Unable to get printer status."));
996 ippDelete(supported
);
1001 if (!getenv("CLASS"))
1004 * Check printer-is-accepting-jobs = false and printer-state-reasons for the
1005 * "spool-area-full" keyword...
1010 if ((printer_accepting
= ippFindAttribute(supported
,
1011 "printer-is-accepting-jobs",
1012 IPP_TAG_BOOLEAN
)) != NULL
&&
1013 !printer_accepting
->values
[0].boolean
)
1015 else if (!printer_accepting
)
1016 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1017 "cups-ipp-missing-printer-is-accepting-jobs");
1019 if ((printer_state
= ippFindAttribute(supported
,
1020 "printer-state-reasons",
1021 IPP_TAG_KEYWORD
)) == NULL
)
1023 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1024 "cups-ipp-missing-printer-state-reasons");
1028 for (i
= 0; i
< printer_state
->num_values
; i
++)
1030 if (!strcmp(printer_state
->values
[0].string
.text
,
1031 "spool-area-full") ||
1032 !strncmp(printer_state
->values
[0].string
.text
, "spool-area-full-",
1043 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1045 report_printer_state(supported
);
1047 sleep((unsigned)delay
);
1049 delay
= _cupsNextDelay(delay
, &prev_delay
);
1051 ippDelete(supported
);
1053 ipp_status
= IPP_STATUS_ERROR_BUSY
;
1059 * Check for supported attributes...
1063 if ((compression_sup
= ippFindAttribute(supported
, "compression-supported",
1064 IPP_TAG_KEYWORD
)) != NULL
)
1067 * Check whether the requested compression is supported and/or default to
1068 * compression if supported...
1071 if (compression
&& !ippContainsString(compression_sup
, compression
))
1073 fprintf(stderr
, "DEBUG: Printer does not support the requested "
1074 "compression value \"%s\".\n", compression
);
1077 else if (!compression
)
1079 if (ippContainsString(compression_sup
, "gzip"))
1080 compression
= "gzip";
1081 else if (ippContainsString(compression_sup
, "deflate"))
1082 compression
= "deflate";
1085 fprintf(stderr
, "DEBUG: Automatically using \"%s\" compression.\n",
1089 #endif /* HAVE_LIBZ */
1091 if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
1092 IPP_TAG_RANGE
)) != NULL
)
1095 * Has the "copies-supported" attribute - does it have an upper
1099 fprintf(stderr
, "DEBUG: copies-supported=%d-%d\n",
1100 copies_sup
->values
[0].range
.lower
,
1101 copies_sup
->values
[0].range
.upper
);
1103 if (copies_sup
->values
[0].range
.upper
<= 1)
1104 copies_sup
= NULL
; /* No */
1107 cups_version
= ippFindAttribute(supported
, "cups-version", IPP_TAG_TEXT
);
1109 if ((format_sup
= ippFindAttribute(supported
, "document-format-supported",
1110 IPP_TAG_MIMETYPE
)) != NULL
)
1112 fprintf(stderr
, "DEBUG: document-format-supported (%d values)\n",
1113 format_sup
->num_values
);
1114 for (i
= 0; i
< format_sup
->num_values
; i
++)
1115 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1116 format_sup
->values
[i
].string
.text
);
1119 if ((media_col_sup
= ippFindAttribute(supported
, "media-col-supported",
1120 IPP_TAG_KEYWORD
)) != NULL
)
1122 fprintf(stderr
, "DEBUG: media-col-supported (%d values)\n",
1123 media_col_sup
->num_values
);
1124 for (i
= 0; i
< media_col_sup
->num_values
; i
++)
1125 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1126 media_col_sup
->values
[i
].string
.text
);
1129 print_color_mode_sup
= ippFindAttribute(supported
, "print-color-mode-supported", IPP_TAG_KEYWORD
);
1131 if ((operations_sup
= ippFindAttribute(supported
, "operations-supported",
1132 IPP_TAG_ENUM
)) != NULL
)
1134 fprintf(stderr
, "DEBUG: operations-supported (%d values)\n",
1135 operations_sup
->num_values
);
1136 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1137 fprintf(stderr
, "DEBUG: [%d] = %s\n", i
,
1138 ippOpString(operations_sup
->values
[i
].integer
));
1140 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1141 if (operations_sup
->values
[i
].integer
== IPP_PRINT_JOB
)
1144 if (i
>= operations_sup
->num_values
)
1145 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1146 "cups-ipp-missing-print-job");
1148 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1149 if (operations_sup
->values
[i
].integer
== IPP_CANCEL_JOB
)
1152 if (i
>= operations_sup
->num_values
)
1153 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1154 "cups-ipp-missing-cancel-job");
1156 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1157 if (operations_sup
->values
[i
].integer
== IPP_GET_JOB_ATTRIBUTES
)
1160 if (i
>= operations_sup
->num_values
)
1161 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1162 "cups-ipp-missing-get-job-attributes");
1164 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1165 if (operations_sup
->values
[i
].integer
== IPP_GET_PRINTER_ATTRIBUTES
)
1168 if (i
>= operations_sup
->num_values
)
1169 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1170 "cups-ipp-missing-get-printer-attributes");
1172 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1174 if (operations_sup
->values
[i
].integer
== IPP_VALIDATE_JOB
)
1176 else if (operations_sup
->values
[i
].integer
== IPP_CREATE_JOB
)
1178 else if (operations_sup
->values
[i
].integer
== IPP_SEND_DOCUMENT
)
1180 else if (operations_sup
->values
[i
].integer
== IPP_GET_JOB_ATTRIBUTES
)
1184 if (create_job
&& !send_document
)
1186 fputs("DEBUG: Printer supports Create-Job but not Send-Document.\n",
1190 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1191 "cups-ipp-missing-send-document");
1195 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1196 "cups-ipp-missing-validate-job");
1199 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1200 "cups-ipp-missing-operations-supported");
1202 doc_handling_sup
= ippFindAttribute(supported
,
1203 "multiple-document-handling-supported",
1206 report_printer_state(supported
);
1208 while (!job_canceled
&& ipp_status
> IPP_OK_CONFLICT
);
1211 return (CUPS_BACKEND_OK
);
1214 * See if the printer is accepting jobs and is not stopped; if either
1215 * condition is true and we are printing to a class, requeue the job...
1218 if (getenv("CLASS") != NULL
)
1220 printer_state
= ippFindAttribute(supported
, "printer-state",
1222 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
1225 if (printer_state
== NULL
||
1226 (printer_state
->values
[0].integer
> IPP_PRINTER_PROCESSING
&&
1228 printer_accepting
== NULL
||
1229 !printer_accepting
->values
[0].boolean
)
1232 * If the CLASS environment variable is set, the job was submitted
1233 * to a class and not to a specific queue. In this case, we want
1234 * to abort immediately so that the job can be requeued on the next
1235 * available printer in the class.
1238 _cupsLangPrintFilter(stderr
, "INFO",
1239 _("Unable to contact printer, queuing on next "
1240 "printer in class."));
1242 ippDelete(supported
);
1246 * Sleep 5 seconds to keep the job from requeuing too rapidly...
1251 return (CUPS_BACKEND_FAILED
);
1256 * See if the printer supports multiple copies...
1259 copies
= atoi(argv
[4]);
1261 if (copies_sup
|| argc
< 7)
1262 copies_remaining
= 1;
1264 copies_remaining
= copies
;
1267 * Prepare remaining printing options...
1274 num_options
= cupsParseOptions(argv
[5], 0, &options
);
1276 if (!cups_version
&& media_col_sup
)
1279 * Load the PPD file and generate PWG attribute mapping information...
1282 ppd
= ppdOpenFile(getenv("PPD"));
1283 pc
= _ppdCacheCreateWithPPD(ppd
);
1285 ppdMarkDefaults(ppd
);
1286 cupsMarkOptions(ppd
, num_options
, options
);
1292 document_format
= NULL
;
1294 if (format_sup
!= NULL
)
1296 for (i
= 0; i
< format_sup
->num_values
; i
++)
1297 if (!_cups_strcasecmp(final_content_type
,
1298 format_sup
->values
[i
].string
.text
))
1300 document_format
= final_content_type
;
1304 if (!document_format
)
1306 for (i
= 0; i
< format_sup
->num_values
; i
++)
1307 if (!_cups_strcasecmp("application/octet-stream",
1308 format_sup
->values
[i
].string
.text
))
1310 document_format
= "application/octet-stream";
1316 fprintf(stderr
, "DEBUG: final_content_type=\"%s\", document_format=\"%s\"\n",
1317 final_content_type
, document_format
? document_format
: "(null)");
1320 * If the printer does not support HTTP/1.1 (which IPP requires), copy stdin
1321 * to a temporary file so that we can do a HTTP/1.0 submission...
1323 * (I hate compatibility hacks!)
1326 if (http
->version
< HTTP_1_1
&& num_files
== 0)
1328 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
1330 perror("DEBUG: Unable to create temporary file");
1331 return (CUPS_BACKEND_FAILED
);
1334 _cupsLangPrintFilter(stderr
, "INFO", _("Copying print data."));
1336 if ((compatsize
= write(fd
, buffer
, (size_t)bytes
)) < 0)
1338 perror("DEBUG: Unable to write temporary file");
1339 return (CUPS_BACKEND_FAILED
);
1342 if ((bytes
= backendRunLoop(-1, fd
, snmp_fd
, &(addrlist
->addr
), 0, 0,
1343 backendNetworkSideCB
)) < 0)
1344 return (CUPS_BACKEND_FAILED
);
1346 compatsize
+= bytes
;
1350 compatfile
= tmpfilename
;
1351 files
= &compatfile
;
1354 else if (http
->version
< HTTP_1_1
&& num_files
== 1)
1356 struct stat fileinfo
; /* File information */
1358 if (!stat(files
[0], &fileinfo
))
1359 compatsize
= fileinfo
.st_size
;
1363 * If the printer only claims to support IPP/1.0, or if the user specifically
1364 * included version=1.0 in the URI, then do not try to use Create-Job or
1365 * Send-Document. This is another dreaded compatibility hack, but
1366 * unfortunately there are enough broken printers out there that we need
1371 create_job
= send_document
= 0;
1374 * Start monitoring the printer in the background...
1378 monitor
.hostname
= hostname
;
1379 monitor
.user
= argv
[2];
1380 monitor
.resource
= resource
;
1381 monitor
.port
= port
;
1382 monitor
.version
= version
;
1384 monitor
.get_job_attrs
= get_job_attrs
;
1385 monitor
.encryption
= cupsEncryption();
1386 monitor
.job_state
= IPP_JOB_PENDING
;
1387 monitor
.printer_state
= IPP_PRINTER_IDLE
;
1391 monitor
.job_name
= argv
[3];
1395 snprintf(print_job_name
, sizeof(print_job_name
), "%s - %s", argv
[1],
1397 monitor
.job_name
= print_job_name
;
1400 _cupsThreadCreate((_cups_thread_func_t
)monitor_printer
, &monitor
);
1403 * Validate access to the printer...
1406 while (!job_canceled
&& validate_job
)
1408 request
= new_request(IPP_VALIDATE_JOB
, version
, uri
, argv
[2],
1409 monitor
.job_name
, num_options
, options
, compression
,
1410 copies_sup
? copies
: 1, document_format
, pc
, ppd
,
1411 media_col_sup
, doc_handling_sup
, print_color_mode_sup
);
1413 response
= cupsDoRequest(http
, request
, resource
);
1415 ipp_status
= cupsLastError();
1417 fprintf(stderr
, "DEBUG: Validate-Job: %s (%s)\n",
1418 ippErrorString(ipp_status
), cupsLastErrorString());
1420 if ((job_auth
= ippFindAttribute(response
, "job-authorization-uri",
1421 IPP_TAG_URI
)) != NULL
)
1422 num_options
= cupsAddOption("job-authorization-uri",
1423 ippGetString(job_auth
, 0, NULL
), num_options
,
1426 ippDelete(response
);
1431 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1432 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1434 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1437 else if (ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
||
1438 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1439 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1440 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1441 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1442 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1444 else if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1445 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1447 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1448 /* WWW-Authenticate field value */
1450 if (!strncmp(www_auth
, "Negotiate", 9))
1451 auth_info_required
= "negotiate";
1452 else if (www_auth
[0])
1453 auth_info_required
= "username,password";
1457 else if (ipp_status
== IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
)
1460 * This is all too common...
1463 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1464 "cups-ipp-missing-validate-job");
1467 else if (ipp_status
< IPP_REDIRECTION_OTHER_SITE
||
1468 ipp_status
== IPP_BAD_REQUEST
)
1473 * Then issue the print-job request...
1478 while (!job_canceled
&& copies_remaining
> 0)
1481 * Check for side-channel requests...
1484 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1487 * Build the IPP job creation request...
1493 request
= new_request((num_files
> 1 || create_job
) ? IPP_CREATE_JOB
:
1495 version
, uri
, argv
[2], monitor
.job_name
, num_options
,
1496 options
, compression
, copies_sup
? copies
: 1,
1497 document_format
, pc
, ppd
, media_col_sup
,
1498 doc_handling_sup
, print_color_mode_sup
);
1504 if (num_files
> 1 || create_job
)
1505 response
= cupsDoRequest(http
, request
, resource
);
1508 size_t length
= 0; /* Length of request */
1512 fputs("DEBUG: Sending file using HTTP/1.0 Content-Length...\n", stderr
);
1513 length
= ippLength(request
) + (size_t)compatsize
;
1516 fputs("DEBUG: Sending file using HTTP/1.1 chunking...\n", stderr
);
1518 http_status
= cupsSendRequest(http
, request
, resource
, length
);
1519 if (http_status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
)
1521 if (compression
&& strcmp(compression
, "none"))
1522 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1526 if ((fd
= open(files
[0], O_RDONLY
)) < 0)
1528 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1529 return (CUPS_BACKEND_FAILED
);
1535 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1538 while (http_status
== HTTP_CONTINUE
&&
1539 (!job_canceled
|| compatsize
> 0))
1542 * Check for side-channel requests and more print data...
1547 FD_SET(snmp_fd
, &input
);
1549 while (select(fd
> snmp_fd
? fd
+ 1 : snmp_fd
+ 1, &input
, NULL
, NULL
,
1550 NULL
) <= 0 && !job_canceled
);
1552 if (FD_ISSET(snmp_fd
, &input
))
1553 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1555 if (FD_ISSET(fd
, &input
))
1557 if ((bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1559 fprintf(stderr
, "DEBUG: Read %d bytes...\n", (int)bytes
);
1561 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1565 else if (bytes
== 0 || (errno
!= EINTR
&& errno
!= EAGAIN
))
1570 if (http_status
== HTTP_ERROR
)
1571 fprintf(stderr
, "DEBUG: Error writing document data for "
1572 "Print-Job: %s\n", strerror(httpError(http
)));
1578 response
= cupsGetResponse(http
, resource
);
1582 ipp_status
= cupsLastError();
1584 fprintf(stderr
, "DEBUG: %s: %s (%s)\n",
1585 (num_files
> 1 || create_job
) ? "Create-Job" : "Print-Job",
1586 ippErrorString(ipp_status
), cupsLastErrorString());
1588 if (ipp_status
> IPP_OK_CONFLICT
)
1595 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1596 ipp_status
== IPP_STATUS_ERROR_NOT_POSSIBLE
||
1597 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1599 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1605 * We can't re-submit when we have no files to print, so exit
1606 * immediately with the right status code...
1612 else if (ipp_status
== IPP_STATUS_ERROR_JOB_CANCELED
||
1613 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1614 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1615 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1616 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1617 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1618 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1623 * Update auth-info-required as needed...
1626 _cupsLangPrintFilter(stderr
, "ERROR",
1627 _("Print job was not accepted."));
1629 if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1630 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1632 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1633 /* WWW-Authenticate field value */
1635 if (!strncmp(www_auth
, "Negotiate", 9))
1636 auth_info_required
= "negotiate";
1637 else if (www_auth
[0])
1638 auth_info_required
= "username,password";
1640 else if (ipp_status
== IPP_REQUEST_VALUE
)
1643 * Print file is too large, abort this job...
1654 * We can't re-submit when we have no files to print, so exit
1655 * immediately with the right status code...
1662 else if ((job_id_attr
= ippFindAttribute(response
, "job-id",
1663 IPP_TAG_INTEGER
)) == NULL
)
1665 fputs("DEBUG: Print job accepted - job ID unknown.\n", stderr
);
1666 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1667 "cups-ipp-missing-job-id");
1673 monitor
.job_id
= job_id
= job_id_attr
->values
[0].integer
;
1674 fprintf(stderr
, "DEBUG: Print job accepted - job ID %d.\n", job_id
);
1677 ippDelete(response
);
1682 if (job_id
&& (num_files
> 1 || create_job
))
1684 for (i
= 0; num_files
== 0 || i
< num_files
; i
++)
1687 * Check for side-channel requests...
1690 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1693 * Send the next file in the job...
1696 request
= ippNewRequest(IPP_SEND_DOCUMENT
);
1697 ippSetVersion(request
, version
/ 10, version
% 10);
1699 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1702 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1706 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1707 "requesting-user-name", NULL
, argv
[2]);
1709 ippAddBoolean(request
, IPP_TAG_OPERATION
, "last-document",
1710 (i
+ 1) >= num_files
);
1712 if (document_format
)
1713 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
1714 "document-format", NULL
, document_format
);
1717 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1718 "compression", NULL
, compression
);
1720 fprintf(stderr
, "DEBUG: Sending file %d using chunking...\n", i
+ 1);
1721 http_status
= cupsSendRequest(http
, request
, resource
, 0);
1722 if (http_status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
)
1724 if (compression
&& strcmp(compression
, "none"))
1725 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1730 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1734 if ((fd
= open(files
[i
], O_RDONLY
)) < 0)
1736 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1737 return (CUPS_BACKEND_FAILED
);
1746 while (!job_canceled
&& http_status
== HTTP_CONTINUE
&&
1747 (bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1749 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1755 * Check for side-channel requests...
1758 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1766 if (http_status
== HTTP_ERROR
)
1767 fprintf(stderr
, "DEBUG: Error writing document data for "
1768 "Send-Document: %s\n", strerror(httpError(http
)));
1770 ippDelete(cupsGetResponse(http
, resource
));
1773 fprintf(stderr
, "DEBUG: Send-Document: %s (%s)\n",
1774 ippErrorString(cupsLastError()), cupsLastErrorString());
1776 if (cupsLastError() > IPP_OK_CONFLICT
)
1778 ipp_status
= cupsLastError();
1780 _cupsLangPrintFilter(stderr
, "ERROR",
1781 _("Unable to add document to print job."));
1788 if (num_files
== 0 || fd
< 0)
1794 if (ipp_status
<= IPP_OK_CONFLICT
&& argc
> 6)
1796 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
1797 copies_remaining
--;
1799 else if ((ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
|| ipp_status
== IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
) &&
1801 document_format
&& strcmp(document_format
, "image/pwg-raster") && strcmp(document_format
, "image/urf"))
1804 * Need to reprocess the job as raster...
1807 fputs("JOBSTATE: cups-retry-as-raster\n", stderr
);
1809 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1813 else if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
1814 ipp_status
== IPP_NOT_POSSIBLE
||
1815 ipp_status
== IPP_PRINTER_BUSY
)
1820 * Need to reprocess the entire job; if we have a job ID, cancel the
1825 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1831 else if (ipp_status
== IPP_REQUEST_VALUE
||
1832 ipp_status
== IPP_ERROR_JOB_CANCELED
||
1833 ipp_status
== IPP_NOT_AUTHORIZED
||
1834 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1835 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1836 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1837 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
||
1838 ipp_status
== IPP_INTERNAL_ERROR
)
1841 * Print file is too large, job was canceled, we need new
1842 * authentication data, or we had some sort of error...
1847 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
)
1850 * Server is configured incorrectly; the policy for Create-Job and
1851 * Send-Document has to be the same (auth or no auth, encryption or
1852 * no encryption). Force the queue to stop since printing will never
1856 fputs("DEBUG: The server or printer is configured incorrectly.\n",
1858 fputs("DEBUG: The policy for Create-Job and Send-Document must have the "
1859 "same authentication and encryption requirements.\n", stderr
);
1861 ipp_status
= IPP_STATUS_ERROR_INTERNAL
;
1864 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1868 else if (ipp_status
== IPP_NOT_FOUND
)
1871 * Printer does not actually implement support for Create-Job/
1872 * Send-Document, so log the conformance issue and stop the printer.
1875 fputs("DEBUG: This printer claims to support Create-Job and "
1876 "Send-Document, but those operations failed.\n", stderr
);
1877 fputs("DEBUG: Add '?version=1.0' to the device URI to use legacy "
1878 "compatibility mode.\n", stderr
);
1879 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1880 "cups-ipp-missing-send-document");
1882 ipp_status
= IPP_INTERNAL_ERROR
; /* Force queue to stop */
1887 copies_remaining
--;
1890 * Wait for the job to complete...
1893 if (!job_id
|| !waitjob
|| !get_job_attrs
)
1896 fputs("STATE: +cups-waiting-for-job-completed\n", stderr
);
1898 _cupsLangPrintFilter(stderr
, "INFO", _("Waiting for job to complete."));
1900 for (delay
= _cupsNextDelay(0, &prev_delay
); !job_canceled
;)
1903 * Check for side-channel requests...
1906 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1909 * Check printer state...
1912 check_printer_state(http
, uri
, resource
, argv
[2], version
);
1914 if (cupsLastError() <= IPP_OK_CONFLICT
)
1918 * Build an IPP_GET_JOB_ATTRIBUTES request...
1921 request
= ippNewRequest(IPP_GET_JOB_ATTRIBUTES
);
1922 ippSetVersion(request
, version
/ 10, version
% 10);
1924 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1927 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1931 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1932 "requesting-user-name", NULL
, argv
[2]);
1934 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1935 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
1942 httpReconnect(http
);
1943 response
= cupsDoRequest(http
, request
, resource
);
1944 ipp_status
= cupsLastError();
1946 if (ipp_status
== IPP_NOT_FOUND
|| ipp_status
== IPP_NOT_POSSIBLE
)
1949 * Job has gone away and/or the server has no job history...
1952 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1953 "cups-ipp-missing-job-history");
1954 ippDelete(response
);
1956 ipp_status
= IPP_OK
;
1960 fprintf(stderr
, "DEBUG: Get-Job-Attributes: %s (%s)\n",
1961 ippErrorString(ipp_status
), cupsLastErrorString());
1963 if (ipp_status
<= IPP_OK_CONFLICT
)
1967 if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
1968 ipp_status
!= IPP_PRINTER_BUSY
)
1970 ippDelete(response
);
1971 ipp_status
= IPP_OK
;
1974 else if (ipp_status
== IPP_INTERNAL_ERROR
)
1978 if (waitjob_tries
> 4)
1980 ippDelete(response
);
1981 ipp_status
= IPP_OK
;
1989 if ((job_state
= ippFindAttribute(response
, "job-state",
1990 IPP_TAG_ENUM
)) != NULL
)
1993 * Reflect the remote job state in the local queue...
1997 job_state
->values
[0].integer
>= IPP_JOB_PENDING
&&
1998 job_state
->values
[0].integer
<= IPP_JOB_COMPLETED
)
1999 update_reasons(NULL
,
2000 remote_job_states
[job_state
->values
[0].integer
-
2003 if ((job_sheets
= ippFindAttribute(response
,
2004 "job-media-sheets-completed",
2005 IPP_TAG_INTEGER
)) == NULL
)
2006 job_sheets
= ippFindAttribute(response
,
2007 "job-impressions-completed",
2011 fprintf(stderr
, "PAGE: total %d\n",
2012 job_sheets
->values
[0].integer
);
2015 * Stop polling if the job is finished or pending-held...
2018 if (job_state
->values
[0].integer
> IPP_JOB_STOPPED
)
2020 ippDelete(response
);
2024 else if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
2025 ipp_status
!= IPP_NOT_POSSIBLE
&&
2026 ipp_status
!= IPP_PRINTER_BUSY
)
2029 * If the printer does not return a job-state attribute, it does not
2030 * conform to the IPP specification - break out immediately and fail
2034 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2035 "cups-ipp-missing-job-state");
2036 ipp_status
= IPP_INTERNAL_ERROR
;
2041 ippDelete(response
);
2044 * Wait before polling again...
2047 sleep((unsigned)delay
);
2049 delay
= _cupsNextDelay(delay
, &prev_delay
);
2054 * Cancel the job as needed...
2057 if (job_canceled
> 0 && job_id
> 0)
2059 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
2061 if (cupsLastError() > IPP_OK_CONFLICT
)
2062 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2066 * Check the printer state and report it if necessary...
2069 check_printer_state(http
, uri
, resource
, argv
[2], version
);
2071 if (cupsLastError() <= IPP_OK_CONFLICT
)
2075 * Collect the final page count as needed...
2078 if (have_supplies
&&
2079 !backendSNMPSupplies(snmp_fd
, &(http
->addrlist
->addr
), &page_count
,
2081 page_count
> start_count
)
2082 fprintf(stderr
, "PAGE: total %d\n", page_count
- start_count
);
2086 * See if we used Kerberos at all...
2090 auth_info_required
= "negotiate";
2091 #endif /* HAVE_GSSAPI */
2099 cupsFreeOptions(num_options
, options
);
2100 _ppdCacheDestroy(pc
);
2105 ippDelete(supported
);
2108 * Remove the temporary file(s) if necessary...
2112 unlink(tmpfilename
);
2115 * Return the queue status...
2118 if (ipp_status
== IPP_NOT_AUTHORIZED
|| ipp_status
== IPP_FORBIDDEN
||
2119 ipp_status
== IPP_AUTHENTICATION_CANCELED
||
2120 ipp_status
<= IPP_OK_CONFLICT
)
2121 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
2123 if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
)
2124 fputs("JOBSTATE: account-info-needed\n", stderr
);
2125 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
)
2126 fputs("JOBSTATE: account-closed\n", stderr
);
2127 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
)
2128 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2129 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2130 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2132 if (ipp_status
== IPP_NOT_AUTHORIZED
|| ipp_status
== IPP_FORBIDDEN
||
2133 ipp_status
== IPP_AUTHENTICATION_CANCELED
)
2134 return (CUPS_BACKEND_AUTH_REQUIRED
);
2135 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
2136 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
2137 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
2138 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2139 return (CUPS_BACKEND_HOLD
);
2140 else if (ipp_status
== IPP_INTERNAL_ERROR
)
2141 return (CUPS_BACKEND_STOP
);
2142 else if (ipp_status
== IPP_CONFLICT
)
2143 return (CUPS_BACKEND_FAILED
);
2144 else if (ipp_status
== IPP_REQUEST_VALUE
||
2145 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
2146 ipp_status
== IPP_DOCUMENT_FORMAT
|| job_canceled
< 0)
2148 if (ipp_status
== IPP_REQUEST_VALUE
)
2149 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job too large."));
2150 else if (ipp_status
== IPP_DOCUMENT_FORMAT
)
2151 _cupsLangPrintFilter(stderr
, "ERROR",
2152 _("Printer cannot print supplied content."));
2153 else if (ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
)
2154 _cupsLangPrintFilter(stderr
, "ERROR",
2155 _("Printer cannot print with supplied options."));
2157 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job canceled at printer."));
2159 return (CUPS_BACKEND_CANCEL
);
2161 else if (ipp_status
> IPP_OK_CONFLICT
&& ipp_status
!= IPP_ERROR_JOB_CANCELED
)
2162 return (CUPS_BACKEND_RETRY_CURRENT
);
2164 return (CUPS_BACKEND_OK
);
2169 * 'cancel_job()' - Cancel a print job.
2173 cancel_job(http_t
*http
, /* I - HTTP connection */
2174 const char *uri
, /* I - printer-uri */
2175 int id
, /* I - job-id */
2176 const char *resource
, /* I - Resource path */
2177 const char *user
, /* I - requesting-user-name */
2178 int version
) /* I - IPP version */
2180 ipp_t
*request
; /* Cancel-Job request */
2183 _cupsLangPrintFilter(stderr
, "INFO", _("Canceling print job."));
2185 request
= ippNewRequest(IPP_CANCEL_JOB
);
2186 ippSetVersion(request
, version
/ 10, version
% 10);
2188 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2190 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
2192 if (user
&& user
[0])
2193 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2194 "requesting-user-name", NULL
, user
);
2200 ippDelete(cupsDoRequest(http
, request
, resource
));
2205 * 'check_printer_state()' - Check the printer state.
2208 static ipp_pstate_t
/* O - Current printer-state */
2209 check_printer_state(
2210 http_t
*http
, /* I - HTTP connection */
2211 const char *uri
, /* I - Printer URI */
2212 const char *resource
, /* I - Resource path */
2213 const char *user
, /* I - Username, if any */
2214 int version
) /* I - IPP version */
2216 ipp_t
*request
, /* IPP request */
2217 *response
; /* IPP response */
2218 ipp_attribute_t
*attr
; /* Attribute in response */
2219 ipp_pstate_t printer_state
= IPP_PRINTER_STOPPED
;
2220 /* Current printer-state */
2224 * Send a Get-Printer-Attributes request and log the results...
2227 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
2228 ippSetVersion(request
, version
/ 10, version
% 10);
2230 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2233 if (user
&& user
[0])
2234 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2235 "requesting-user-name", NULL
, user
);
2237 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2238 "requested-attributes",
2239 (int)(sizeof(pattrs
) / sizeof(pattrs
[0])), NULL
, pattrs
);
2241 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
2243 report_printer_state(response
);
2245 if ((attr
= ippFindAttribute(response
, "printer-state",
2246 IPP_TAG_ENUM
)) != NULL
)
2247 printer_state
= (ipp_pstate_t
)attr
->values
[0].integer
;
2249 ippDelete(response
);
2252 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
2253 ippErrorString(cupsLastError()), cupsLastErrorString());
2256 * Return the printer-state value...
2259 return (printer_state
);
2264 * 'monitor_printer()' - Monitor the printer state.
2267 static void * /* O - Thread exit code */
2269 _cups_monitor_t
*monitor
) /* I - Monitoring data */
2271 http_t
*http
; /* Connection to printer */
2272 ipp_t
*request
, /* IPP request */
2273 *response
; /* IPP response */
2274 ipp_attribute_t
*attr
; /* Attribute in response */
2275 int delay
, /* Current delay */
2276 prev_delay
; /* Previous delay */
2277 ipp_op_t job_op
; /* Operation to use */
2278 int job_id
; /* Job ID */
2279 const char *job_name
; /* Job name */
2280 ipp_jstate_t job_state
; /* Job state */
2281 const char *job_user
; /* Job originating user name */
2282 int password_tries
= 0; /* Password tries */
2286 * Make a copy of the printer connection...
2289 http
= httpConnect2(monitor
->hostname
, monitor
->port
, NULL
, AF_UNSPEC
,
2290 monitor
->encryption
, 1, 0, NULL
);
2291 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
2293 cupsSetUser(username
);
2295 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
2298 * Loop until the job is canceled, aborted, or completed.
2301 delay
= _cupsNextDelay(0, &prev_delay
);
2303 monitor
->job_reasons
= 0;
2305 while (monitor
->job_state
< IPP_JOB_CANCELED
&& !job_canceled
)
2308 * Reconnect to the printer...
2311 if (!httpReconnect(http
))
2314 * Connected, so check on the printer state...
2317 monitor
->printer_state
= check_printer_state(http
, monitor
->uri
,
2321 if (cupsLastError() <= IPP_OK_CONFLICT
)
2325 * Check the status of the job itself...
2328 job_op
= (monitor
->job_id
> 0 && monitor
->get_job_attrs
) ?
2329 IPP_GET_JOB_ATTRIBUTES
: IPP_GET_JOBS
;
2330 request
= ippNewRequest(job_op
);
2331 ippSetVersion(request
, monitor
->version
/ 10, monitor
->version
% 10);
2333 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2334 NULL
, monitor
->uri
);
2335 if (job_op
== IPP_GET_JOB_ATTRIBUTES
)
2336 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2339 if (monitor
->user
&& monitor
->user
[0])
2340 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2341 "requesting-user-name", NULL
, monitor
->user
);
2343 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2344 "requested-attributes",
2345 (int)(sizeof(jattrs
) / sizeof(jattrs
[0])), NULL
, jattrs
);
2351 response
= cupsDoRequest(http
, request
, monitor
->resource
);
2353 fprintf(stderr
, "DEBUG: (monitor) %s: %s (%s)\n", ippOpString(job_op
),
2354 ippErrorString(cupsLastError()), cupsLastErrorString());
2356 if (cupsLastError() <= IPP_OK_CONFLICT
)
2359 if (job_op
== IPP_GET_JOB_ATTRIBUTES
)
2361 if ((attr
= ippFindAttribute(response
, "job-state",
2362 IPP_TAG_ENUM
)) != NULL
)
2363 monitor
->job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2365 monitor
->job_state
= IPP_JOB_COMPLETED
;
2369 for (attr
= response
->attrs
; attr
; attr
= attr
->next
)
2373 job_state
= IPP_JOB_PENDING
;
2376 while (attr
&& attr
->group_tag
!= IPP_TAG_JOB
)
2382 while (attr
&& attr
->group_tag
== IPP_TAG_JOB
)
2384 if (!strcmp(attr
->name
, "job-id") &&
2385 attr
->value_tag
== IPP_TAG_INTEGER
)
2386 job_id
= attr
->values
[0].integer
;
2387 else if (!strcmp(attr
->name
, "job-name") &&
2388 (attr
->value_tag
== IPP_TAG_NAME
||
2389 attr
->value_tag
== IPP_TAG_NAMELANG
))
2390 job_name
= attr
->values
[0].string
.text
;
2391 else if (!strcmp(attr
->name
, "job-state") &&
2392 attr
->value_tag
== IPP_TAG_ENUM
)
2393 job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2394 else if (!strcmp(attr
->name
, "job-originating-user-name") &&
2395 (attr
->value_tag
== IPP_TAG_NAME
||
2396 attr
->value_tag
== IPP_TAG_NAMELANG
))
2397 job_user
= attr
->values
[0].string
.text
;
2402 if (job_id
> 0 && job_name
&& !strcmp(job_name
, monitor
->job_name
) &&
2403 job_user
&& monitor
->user
&& !strcmp(job_user
, monitor
->user
))
2405 monitor
->job_id
= job_id
;
2406 monitor
->job_state
= job_state
;
2415 if ((attr
= ippFindAttribute(response
, "job-state-reasons",
2416 IPP_TAG_KEYWORD
)) != NULL
)
2418 int i
, new_reasons
= 0; /* Looping var, new reasons */
2420 for (i
= 0; i
< attr
->num_values
; i
++)
2422 if (!strcmp(attr
->values
[i
].string
.text
,
2423 "account-authorization-failed"))
2424 new_reasons
|= _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
;
2425 else if (!strcmp(attr
->values
[i
].string
.text
, "account-closed"))
2426 new_reasons
|= _CUPS_JSR_ACCOUNT_CLOSED
;
2427 else if (!strcmp(attr
->values
[i
].string
.text
, "account-info-needed"))
2428 new_reasons
|= _CUPS_JSR_ACCOUNT_INFO_NEEDED
;
2429 else if (!strcmp(attr
->values
[i
].string
.text
,
2430 "account-limit-reached"))
2431 new_reasons
|= _CUPS_JSR_ACCOUNT_LIMIT_REACHED
;
2432 else if (!strcmp(attr
->values
[i
].string
.text
, "job-password-wait"))
2433 new_reasons
|= _CUPS_JSR_JOB_PASSWORD_WAIT
;
2434 else if (!strcmp(attr
->values
[i
].string
.text
, "job-release-wait"))
2435 new_reasons
|= _CUPS_JSR_JOB_RELEASE_WAIT
;
2438 if (new_reasons
!= monitor
->job_reasons
)
2440 if (new_reasons
& _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
)
2441 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2442 else if (new_reasons
& _CUPS_JSR_ACCOUNT_CLOSED
)
2443 fputs("JOBSTATE: account-closed\n", stderr
);
2444 else if (new_reasons
& _CUPS_JSR_ACCOUNT_INFO_NEEDED
)
2445 fputs("JOBSTATE: account-info-needed\n", stderr
);
2446 else if (new_reasons
& _CUPS_JSR_ACCOUNT_LIMIT_REACHED
)
2447 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2448 else if (new_reasons
& _CUPS_JSR_JOB_PASSWORD_WAIT
)
2449 fputs("JOBSTATE: job-password-wait\n", stderr
);
2450 else if (new_reasons
& _CUPS_JSR_JOB_RELEASE_WAIT
)
2451 fputs("JOBSTATE: job-release-wait\n", stderr
);
2453 fputs("JOBSTATE: job-printing\n", stderr
);
2455 monitor
->job_reasons
= new_reasons
;
2459 ippDelete(response
);
2461 fprintf(stderr
, "DEBUG: (monitor) job-state=%s\n",
2462 ippEnumString("job-state", monitor
->job_state
));
2464 if (!job_canceled
&&
2465 (monitor
->job_state
== IPP_JOB_CANCELED
||
2466 monitor
->job_state
== IPP_JOB_ABORTED
))
2470 * Disconnect from the printer - we'll reconnect on the next poll...
2473 _httpDisconnect(http
);
2477 * Sleep for N seconds...
2480 sleep((unsigned)delay
);
2482 delay
= _cupsNextDelay(delay
, &prev_delay
);
2486 * Cancel the job if necessary...
2489 if (job_canceled
> 0 && monitor
->job_id
> 0)
2491 if (!httpReconnect(http
))
2493 cancel_job(http
, monitor
->uri
, monitor
->job_id
, monitor
->resource
,
2494 monitor
->user
, monitor
->version
);
2496 if (cupsLastError() > IPP_OK_CONFLICT
)
2497 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2502 * Cleanup and return...
2512 * 'new_request()' - Create a new print creation or validation request.
2515 static ipp_t
* /* O - Request data */
2517 ipp_op_t op
, /* I - IPP operation code */
2518 int version
, /* I - IPP version number */
2519 const char *uri
, /* I - printer-uri value */
2520 const char *user
, /* I - requesting-user-name value */
2521 const char *title
, /* I - job-name value */
2522 int num_options
, /* I - Number of options to send */
2523 cups_option_t
*options
, /* I - Options to send */
2524 const char *compression
, /* I - compression value or NULL */
2525 int copies
, /* I - copies value or 0 */
2526 const char *format
, /* I - document-format value or NULL */
2527 _ppd_cache_t
*pc
, /* I - PPD cache and mapping data */
2528 ppd_file_t
*ppd
, /* I - PPD file data */
2529 ipp_attribute_t
*media_col_sup
, /* I - media-col-supported values */
2530 ipp_attribute_t
*doc_handling_sup
, /* I - multiple-document-handling-supported values */
2531 ipp_attribute_t
*print_color_mode_sup
)
2532 /* I - Printer supports print-color-mode */
2534 int i
; /* Looping var */
2535 ipp_t
*request
; /* Request data */
2536 const char *keyword
; /* PWG keyword */
2537 _pwg_size_t
*size
; /* PWG media size */
2538 ipp_t
*media_col
, /* media-col value */
2539 *media_size
; /* media-size value */
2540 const char *media_source
, /* media-source value */
2541 *media_type
, /* media-type value */
2542 *collate_str
, /* multiple-document-handling value */
2543 *mandatory
; /* Mandatory attributes */
2544 ipp_tag_t group
; /* Current group */
2545 ipp_attribute_t
*attr
; /* Current attribute */
2546 const char *color_attr_name
; /* Supported color attribute */
2547 char buffer
[1024]; /* Value buffer */
2551 * Create the IPP request...
2554 request
= ippNewRequest(op
);
2555 ippSetVersion(request
, version
/ 10, version
% 10);
2557 fprintf(stderr
, "DEBUG: %s IPP/%d.%d\n",
2558 ippOpString(request
->request
.op
.operation_id
),
2559 request
->request
.op
.version
[0],
2560 request
->request
.op
.version
[1]);
2563 * Add standard attributes...
2566 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2568 fprintf(stderr
, "DEBUG: printer-uri=\"%s\"\n", uri
);
2572 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2573 "requesting-user-name", NULL
, user
);
2574 fprintf(stderr
, "DEBUG: requesting-user-name=\"%s\"\n", user
);
2577 if (title
&& *title
)
2579 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
,
2581 fprintf(stderr
, "DEBUG: job-name=\"%s\"\n", title
);
2584 if (format
&& op
!= IPP_CREATE_JOB
)
2586 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
2587 "document-format", NULL
, format
);
2588 fprintf(stderr
, "DEBUG: document-format=\"%s\"\n", format
);
2592 if (compression
&& op
!= IPP_OP_CREATE_JOB
&& op
!= IPP_OP_VALIDATE_JOB
)
2594 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2595 "compression", NULL
, compression
);
2596 fprintf(stderr
, "DEBUG: compression=\"%s\"\n", compression
);
2598 #endif /* HAVE_LIBZ */
2601 * Handle options on the command-line...
2604 if (num_options
> 0)
2608 int num_finishings
= 0, /* Number of finishing values */
2609 finishings
[10]; /* Finishing enum values */
2610 ppd_choice_t
*choice
; /* Marked choice */
2613 * Send standard IPP attributes...
2616 fputs("DEBUG: Adding standard IPP operation/job attributes.\n", stderr
);
2619 (keyword
= cupsGetOption("job-password", num_options
,
2622 ippAddOctetString(request
, IPP_TAG_OPERATION
, "job-password", keyword
, (int)strlen(keyword
));
2624 if ((keyword
= cupsGetOption("job-password-encryption", num_options
,
2628 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2629 "job-password-encryption", NULL
, keyword
);
2634 if ((keyword
= cupsGetOption("job-account-id", num_options
,
2636 keyword
= cupsGetOption("job-billing", num_options
, options
);
2639 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_NAME
, "job-account-id",
2643 if (pc
->accounting_user_id
)
2645 if ((keyword
= cupsGetOption("job-accounting-user-id", num_options
,
2650 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_NAME
,
2651 "job-accounting-user-id", NULL
, keyword
);
2654 for (mandatory
= (char *)cupsArrayFirst(pc
->mandatory
);
2656 mandatory
= (char *)cupsArrayNext(pc
->mandatory
))
2658 if (strcmp(mandatory
, "copies") &&
2659 strcmp(mandatory
, "destination-uris") &&
2660 strcmp(mandatory
, "finishings") &&
2661 strcmp(mandatory
, "job-account-id") &&
2662 strcmp(mandatory
, "job-accounting-user-id") &&
2663 strcmp(mandatory
, "job-password") &&
2664 strcmp(mandatory
, "job-password-encryption") &&
2665 strcmp(mandatory
, "media") &&
2666 strncmp(mandatory
, "media-col", 9) &&
2667 strcmp(mandatory
, "multiple-document-handling") &&
2668 strcmp(mandatory
, "output-bin") &&
2669 strcmp(mandatory
, "print-color-mode") &&
2670 strcmp(mandatory
, "print-quality") &&
2671 strcmp(mandatory
, "sides") &&
2672 (keyword
= cupsGetOption(mandatory
, num_options
, options
)) != NULL
)
2674 _ipp_option_t
*opt
= _ippFindOption(mandatory
);
2676 ipp_tag_t value_tag
= opt
? opt
->value_tag
: IPP_TAG_NAME
;
2681 case IPP_TAG_INTEGER
:
2683 ippAddInteger(request
, IPP_TAG_JOB
, value_tag
, mandatory
,
2686 case IPP_TAG_BOOLEAN
:
2687 ippAddBoolean(request
, IPP_TAG_JOB
, mandatory
,
2688 !_cups_strcasecmp(keyword
, "true"));
2690 case IPP_TAG_RANGE
:
2692 int lower
, upper
; /* Range */
2694 if (sscanf(keyword
, "%d-%d", &lower
, &upper
) != 2)
2695 lower
= upper
= atoi(keyword
);
2697 ippAddRange(request
, IPP_TAG_JOB
, mandatory
, lower
, upper
);
2700 case IPP_TAG_STRING
:
2701 ippAddOctetString(request
, IPP_TAG_JOB
, mandatory
, keyword
, (int)strlen(keyword
));
2704 if (!strcmp(mandatory
, "print-color-mode") && !strcmp(keyword
, "monochrome"))
2706 if (ippContainsString(print_color_mode_sup
, "auto-monochrome"))
2707 keyword
= "auto-monochrome";
2708 else if (ippContainsString(print_color_mode_sup
, "process-monochrome") && !ippContainsString(print_color_mode_sup
, "monochrome"))
2709 keyword
= "process-monochrome";
2712 ippAddString(request
, IPP_TAG_JOB
, value_tag
, mandatory
,
2719 if ((keyword
= cupsGetOption("PageSize", num_options
, options
)) == NULL
)
2720 keyword
= cupsGetOption("media", num_options
, options
);
2722 if ((size
= _ppdCacheGetSize(pc
, keyword
)) != NULL
)
2725 * Add a media-col value...
2728 media_size
= ippNew();
2729 ippAddInteger(media_size
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2730 "x-dimension", size
->width
);
2731 ippAddInteger(media_size
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2732 "y-dimension", size
->length
);
2734 media_col
= ippNew();
2735 ippAddCollection(media_col
, IPP_TAG_ZERO
, "media-size", media_size
);
2737 media_source
= _ppdCacheGetSource(pc
, cupsGetOption("InputSlot",
2740 media_type
= _ppdCacheGetType(pc
, cupsGetOption("MediaType",
2744 for (i
= 0; i
< media_col_sup
->num_values
; i
++)
2746 if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2747 "media-left-margin"))
2748 ippAddInteger(media_col
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2749 "media-left-margin", size
->left
);
2750 else if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2751 "media-bottom-margin"))
2752 ippAddInteger(media_col
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2753 "media-bottom-margin", size
->bottom
);
2754 else if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2755 "media-right-margin"))
2756 ippAddInteger(media_col
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2757 "media-right-margin", size
->right
);
2758 else if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2759 "media-top-margin"))
2760 ippAddInteger(media_col
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2761 "media-top-margin", size
->top
);
2762 else if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2763 "media-source") && media_source
)
2764 ippAddString(media_col
, IPP_TAG_ZERO
, IPP_TAG_KEYWORD
,
2765 "media-source", NULL
, media_source
);
2766 else if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2767 "media-type") && media_type
)
2768 ippAddString(media_col
, IPP_TAG_ZERO
, IPP_TAG_KEYWORD
,
2769 "media-type", NULL
, media_type
);
2772 ippAddCollection(request
, IPP_TAG_JOB
, "media-col", media_col
);
2775 if ((keyword
= cupsGetOption("output-bin", num_options
,
2778 if ((choice
= ppdFindMarkedChoice(ppd
, "OutputBin")) != NULL
)
2779 keyword
= _ppdCacheGetBin(pc
, choice
->choice
);
2783 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "output-bin",
2786 color_attr_name
= print_color_mode_sup
? "print-color-mode" : "output-mode";
2788 if ((keyword
= cupsGetOption("print-color-mode", num_options
,
2791 if ((choice
= ppdFindMarkedChoice(ppd
, "ColorModel")) != NULL
)
2793 if (!_cups_strcasecmp(choice
->choice
, "Gray"))
2794 keyword
= "monochrome";
2800 if (keyword
&& !strcmp(keyword
, "monochrome"))
2802 if (ippContainsString(print_color_mode_sup
, "auto-monochrome"))
2803 keyword
= "auto-monochrome";
2804 else if (ippContainsString(print_color_mode_sup
, "process-monochrome") && !ippContainsString(print_color_mode_sup
, "monochrome"))
2805 keyword
= "process-monochrome";
2809 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, color_attr_name
,
2812 if ((keyword
= cupsGetOption("print-quality", num_options
,
2814 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_ENUM
, "print-quality",
2816 else if ((choice
= ppdFindMarkedChoice(ppd
, "cupsPrintQuality")) != NULL
)
2818 if (!_cups_strcasecmp(choice
->choice
, "draft"))
2819 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_ENUM
, "print-quality",
2821 else if (!_cups_strcasecmp(choice
->choice
, "normal"))
2822 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_ENUM
, "print-quality",
2823 IPP_QUALITY_NORMAL
);
2824 else if (!_cups_strcasecmp(choice
->choice
, "high"))
2825 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_ENUM
, "print-quality",
2829 if ((keyword
= cupsGetOption("sides", num_options
, options
)) != NULL
)
2830 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "sides",
2832 else if (pc
->sides_option
&&
2833 (choice
= ppdFindMarkedChoice(ppd
, pc
->sides_option
)) != NULL
)
2835 if (!_cups_strcasecmp(choice
->choice
, pc
->sides_1sided
))
2836 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "sides",
2838 else if (!_cups_strcasecmp(choice
->choice
, pc
->sides_2sided_long
))
2839 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "sides",
2840 NULL
, "two-sided-long-edge");
2841 if (!_cups_strcasecmp(choice
->choice
, pc
->sides_2sided_short
))
2842 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "sides",
2843 NULL
, "two-sided-short-edge");
2846 if ((keyword
= cupsGetOption("multiple-document-handling",
2847 num_options
, options
)) != NULL
)
2849 if (strstr(keyword
, "uncollated"))
2854 else if ((keyword
= cupsGetOption("collate", num_options
,
2860 if (!_cups_strcasecmp(format
, "image/gif") ||
2861 !_cups_strcasecmp(format
, "image/jp2") ||
2862 !_cups_strcasecmp(format
, "image/jpeg") ||
2863 !_cups_strcasecmp(format
, "image/png") ||
2864 !_cups_strcasecmp(format
, "image/tiff") ||
2865 !_cups_strncasecmp(format
, "image/x-", 8))
2868 * Collation makes no sense for single page image formats...
2873 else if (!_cups_strncasecmp(format
, "image/", 6) ||
2874 !_cups_strcasecmp(format
, "application/vnd.cups-raster"))
2877 * Multi-page image formats will have copies applied by the upstream
2885 if (doc_handling_sup
)
2887 if (!_cups_strcasecmp(keyword
, "true"))
2888 collate_str
= "separate-documents-collated-copies";
2890 collate_str
= "separate-documents-uncollated-copies";
2892 for (i
= 0; i
< doc_handling_sup
->num_values
; i
++)
2893 if (!strcmp(doc_handling_sup
->values
[i
].string
.text
, collate_str
))
2895 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2896 "multiple-document-handling", NULL
, collate_str
);
2900 if (i
>= doc_handling_sup
->num_values
)
2905 * Map finishing options...
2908 num_finishings
= _ppdCacheGetFinishingValues(pc
, num_options
, options
,
2909 (int)(sizeof(finishings
) /
2910 sizeof(finishings
[0])),
2912 if (num_finishings
> 0)
2913 ippAddIntegers(request
, IPP_TAG_JOB
, IPP_TAG_ENUM
, "finishings",
2914 num_finishings
, finishings
);
2917 * Map FaxOut options...
2920 if ((keyword
= cupsGetOption("phone", num_options
, options
)) != NULL
)
2922 ipp_t
*destination
; /* destination collection */
2923 char phone
[1024], /* Phone number string */
2924 *ptr
, /* Pointer into string */
2925 tel_uri
[1024]; /* tel: URI */
2926 static const char * const allowed
= "0123456789#*-+.()";
2927 /* Allowed characters */
2929 destination
= ippNew();
2932 * Unescape and filter out spaces and other characters that are not
2933 * allowed in a tel: URI.
2936 _httpDecodeURI(phone
, keyword
, sizeof(phone
));
2937 for (ptr
= phone
; *ptr
;)
2939 if (!strchr(allowed
, *ptr
))
2940 _cups_strcpy(ptr
, ptr
+ 1);
2945 httpAssembleURI(HTTP_URI_CODING_ALL
, tel_uri
, sizeof(tel_uri
), "tel", NULL
, NULL
, 0, phone
);
2946 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_URI
, "destination-uri", NULL
, tel_uri
);
2948 if ((keyword
= cupsGetOption("faxPrefix", num_options
,
2949 options
)) != NULL
&& *keyword
)
2951 char predial
[1024]; /* Pre-dial string */
2953 _httpDecodeURI(predial
, keyword
, sizeof(predial
));
2954 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_TEXT
, "pre-dial-string", NULL
, predial
);
2957 ippAddCollection(request
, IPP_TAG_JOB
, "destination-uris", destination
);
2958 ippDelete(destination
);
2964 * When talking to another CUPS server, send all options...
2967 fputs("DEBUG: Adding all operation/job attributes.\n", stderr
);
2968 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_OPERATION
);
2969 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_JOB
);
2972 if (copies
> 1 && (!pc
|| copies
<= pc
->max_copies
))
2973 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies", copies
);
2976 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10,
2977 ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2978 for (group
= IPP_TAG_ZERO
, attr
= ippFirstAttribute(request
);
2980 attr
= ippNextAttribute(request
))
2982 const char *name
= ippGetName(attr
);
2986 group
= IPP_TAG_ZERO
;
2990 if (group
!= ippGetGroupTag(attr
))
2992 group
= ippGetGroupTag(attr
);
2993 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(group
));
2996 ippAttributeString(attr
, buffer
, sizeof(buffer
));
2997 fprintf(stderr
, "DEBUG: %s %s%s %s\n", name
,
2998 ippGetCount(attr
) > 1 ? "1setOf " : "",
2999 ippTagString(ippGetValueTag(attr
)), buffer
);
3002 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(IPP_TAG_END
));
3009 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
3012 static const char * /* O - Password */
3013 password_cb(const char *prompt
, /* I - Prompt (not used) */
3014 http_t
*http
, /* I - Connection */
3015 const char *method
, /* I - Request method (not used) */
3016 const char *resource
, /* I - Resource path (not used) */
3017 int *password_tries
) /* I - Password tries */
3019 char def_username
[HTTP_MAX_VALUE
]; /* Default username */
3022 fprintf(stderr
, "DEBUG: password_cb(prompt=\"%s\", http=%p, method=\"%s\", "
3023 "resource=\"%s\", password_tries=%p(%d)), password=%p\n",
3024 prompt
, http
, method
, resource
, password_tries
, *password_tries
,
3032 * Remember that we need to authenticate...
3035 auth_info_required
= "username,password";
3037 if (httpGetSubField(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "username",
3040 char quoted
[HTTP_MAX_VALUE
* 2 + 4];
3043 fprintf(stderr
, "ATTR: auth-info-default=%s,\n",
3044 quote_string(def_username
, quoted
, sizeof(quoted
)));
3047 if (password
&& *password
&& *password_tries
< 3)
3049 (*password_tries
) ++;
3051 cupsSetUser(username
);
3058 * Give up after 3 tries or if we don't have a password to begin with...
3067 * 'quote_string()' - Quote a string value.
3070 static const char * /* O - Quoted string */
3071 quote_string(const char *s
, /* I - String */
3072 char *q
, /* I - Quoted string buffer */
3073 size_t qsize
) /* I - Size of quoted string buffer */
3075 char *qptr
, /* Pointer into string buffer */
3076 *qend
; /* End of string buffer */
3080 qend
= q
+ qsize
- 5;
3091 while (*s
&& qptr
< qend
)
3093 if (*s
== '\\' || *s
== '\"' || *s
== '\'')
3095 if (qptr
< (qend
- 4))
3117 * 'report_attr()' - Report an IPP attribute value.
3121 report_attr(ipp_attribute_t
*attr
) /* I - Attribute */
3123 int i
; /* Looping var */
3124 char value
[1024], /* Value string */
3125 *valptr
; /* Pointer into value string */
3126 const char *cached
; /* Cached attribute */
3130 * Convert the attribute values into quoted strings...
3133 for (i
= 0, valptr
= value
;
3134 i
< attr
->num_values
&& valptr
< (value
+ sizeof(value
) - 10);
3140 switch (attr
->value_tag
)
3142 case IPP_TAG_INTEGER
:
3144 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), "%d", attr
->values
[i
].integer
);
3145 valptr
+= strlen(valptr
);
3150 case IPP_TAG_KEYWORD
:
3151 quote_string(attr
->values
[i
].string
.text
, valptr
, (size_t)(value
+ sizeof(value
) - valptr
));
3152 valptr
+= strlen(valptr
);
3157 * Unsupported value type...
3166 _cupsMutexLock(&report_mutex
);
3168 if ((cached
= cupsGetOption(attr
->name
, num_attr_cache
,
3169 attr_cache
)) == NULL
|| strcmp(cached
, value
))
3172 * Tell the scheduler about the new values...
3175 num_attr_cache
= cupsAddOption(attr
->name
, value
, num_attr_cache
,
3177 fprintf(stderr
, "ATTR: %s=%s\n", attr
->name
, value
);
3180 _cupsMutexUnlock(&report_mutex
);
3185 * 'report_printer_state()' - Report the printer state.
3189 report_printer_state(ipp_t
*ipp
) /* I - IPP response */
3191 ipp_attribute_t
*pa
, /* printer-alert */
3192 *pam
, /* printer-alert-message */
3193 *psm
, /* printer-state-message */
3194 *reasons
, /* printer-state-reasons */
3195 *marker
; /* marker-* attributes */
3196 char value
[1024], /* State/message string */
3197 *valptr
; /* Pointer into string */
3198 static int ipp_supplies
= -1;
3199 /* Report supply levels? */
3203 * Report alerts and messages...
3206 if ((pa
= ippFindAttribute(ipp
, "printer-alert", IPP_TAG_TEXT
)) != NULL
)
3209 if ((pam
= ippFindAttribute(ipp
, "printer-alert-message",
3210 IPP_TAG_TEXT
)) != NULL
)
3213 if ((psm
= ippFindAttribute(ipp
, "printer-state-message",
3214 IPP_TAG_TEXT
)) != NULL
)
3216 char *ptr
; /* Pointer into message */
3219 strlcpy(value
, "INFO: ", sizeof(value
));
3220 for (ptr
= psm
->values
[0].string
.text
, valptr
= value
+ 6;
3221 *ptr
&& valptr
< (value
+ sizeof(value
) - 6);
3224 if (*ptr
< ' ' && *ptr
> 0 && *ptr
!= '\t')
3227 * Substitute "<XX>" for the control character; sprintf is safe because
3228 * we always leave 6 chars free at the end...
3231 sprintf(valptr
, "<%02X>", *ptr
);
3241 fputs(value
, stderr
);
3245 * Now report printer-state-reasons, filtering out some of the reasons we never
3249 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
3250 IPP_TAG_KEYWORD
)) == NULL
)
3253 update_reasons(reasons
, NULL
);
3256 * Relay the current marker-* attribute values...
3259 if (ipp_supplies
< 0)
3261 ppd_file_t
*ppd
; /* PPD file */
3262 ppd_attr_t
*ppdattr
; /* Attribute in PPD file */
3264 if ((ppd
= ppdOpenFile(getenv("PPD"))) != NULL
&&
3265 (ppdattr
= ppdFindAttr(ppd
, "cupsIPPSupplies", NULL
)) != NULL
&&
3266 ppdattr
->value
&& _cups_strcasecmp(ppdattr
->value
, "true"))
3274 if (ipp_supplies
> 0)
3276 if ((marker
= ippFindAttribute(ipp
, "marker-colors", IPP_TAG_NAME
)) != NULL
)
3277 report_attr(marker
);
3278 if ((marker
= ippFindAttribute(ipp
, "marker-high-levels",
3279 IPP_TAG_INTEGER
)) != NULL
)
3280 report_attr(marker
);
3281 if ((marker
= ippFindAttribute(ipp
, "marker-levels",
3282 IPP_TAG_INTEGER
)) != NULL
)
3283 report_attr(marker
);
3284 if ((marker
= ippFindAttribute(ipp
, "marker-low-levels",
3285 IPP_TAG_INTEGER
)) != NULL
)
3286 report_attr(marker
);
3287 if ((marker
= ippFindAttribute(ipp
, "marker-message",
3288 IPP_TAG_TEXT
)) != NULL
)
3289 report_attr(marker
);
3290 if ((marker
= ippFindAttribute(ipp
, "marker-names", IPP_TAG_NAME
)) != NULL
)
3291 report_attr(marker
);
3292 if ((marker
= ippFindAttribute(ipp
, "marker-types",
3293 IPP_TAG_KEYWORD
)) != NULL
)
3294 report_attr(marker
);
3299 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3301 * 'run_as_user()' - Run the IPP backend as the printing user.
3303 * This function uses an XPC-based user agent to run the backend as the printing
3304 * user. We need to do this in order to have access to the user's Kerberos
3308 static int /* O - Exit status */
3309 run_as_user(char *argv
[], /* I - Command-line arguments */
3310 uid_t uid
, /* I - User ID */
3311 const char *device_uri
, /* I - Device URI */
3312 int fd
) /* I - File to print */
3314 const char *auth_negotiate
;/* AUTH_NEGOTIATE env var */
3315 xpc_connection_t conn
; /* Connection to XPC service */
3316 xpc_object_t request
; /* Request message dictionary */
3317 __block xpc_object_t response
; /* Response message dictionary */
3318 dispatch_semaphore_t sem
; /* Semaphore for waiting for response */
3319 int status
= CUPS_BACKEND_FAILED
;
3320 /* Status of request */
3323 fprintf(stderr
, "DEBUG: Running IPP backend as UID %d.\n", (int)uid
);
3326 * Connect to the user agent for the specified UID...
3329 conn
= xpc_connection_create_mach_service(kPMPrintUIToolAgent
,
3330 dispatch_get_global_queue(0, 0), 0);
3333 _cupsLangPrintFilter(stderr
, "ERROR",
3334 _("Unable to start backend process."));
3335 fputs("DEBUG: Unable to create connection to agent.\n", stderr
);
3339 xpc_connection_set_event_handler(conn
,
3340 ^(xpc_object_t event
)
3342 xpc_type_t messageType
= xpc_get_type(event
);
3344 if (messageType
== XPC_TYPE_ERROR
)
3346 if (event
== XPC_ERROR_CONNECTION_INTERRUPTED
)
3347 fprintf(stderr
, "DEBUG: Interrupted connection to service %s.\n",
3348 xpc_connection_get_name(conn
));
3349 else if (event
== XPC_ERROR_CONNECTION_INVALID
)
3350 fprintf(stderr
, "DEBUG: Connection invalid for service %s.\n",
3351 xpc_connection_get_name(conn
));
3353 fprintf(stderr
, "DEBUG: Unxpected error for service %s: %s\n",
3354 xpc_connection_get_name(conn
),
3355 xpc_dictionary_get_string(event
, XPC_ERROR_KEY_DESCRIPTION
));
3358 xpc_connection_set_target_uid(conn
, uid
);
3359 xpc_connection_resume(conn
);
3362 * Try starting the backend...
3365 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3366 xpc_dictionary_set_int64(request
, "command", kPMStartJob
);
3367 xpc_dictionary_set_string(request
, "device-uri", device_uri
);
3368 xpc_dictionary_set_string(request
, "job-id", argv
[1]);
3369 xpc_dictionary_set_string(request
, "user", argv
[2]);
3370 xpc_dictionary_set_string(request
, "title", argv
[3]);
3371 xpc_dictionary_set_string(request
, "copies", argv
[4]);
3372 xpc_dictionary_set_string(request
, "options", argv
[5]);
3373 xpc_dictionary_set_string(request
, "auth-info-required",
3374 getenv("AUTH_INFO_REQUIRED"));
3375 if ((auth_negotiate
= getenv("AUTH_NEGOTIATE")) != NULL
)
3376 xpc_dictionary_set_string(request
, "auth-negotiate", auth_negotiate
);
3377 xpc_dictionary_set_fd(request
, "stdin", fd
);
3378 xpc_dictionary_set_fd(request
, "stderr", 2);
3379 xpc_dictionary_set_fd(request
, "side-channel", CUPS_SC_FD
);
3381 sem
= dispatch_semaphore_create(0);
3384 xpc_connection_send_message_with_reply(conn
, request
,
3385 dispatch_get_global_queue(0,0),
3386 ^(xpc_object_t reply
)
3388 /* Save the response and wake up */
3389 if (xpc_get_type(reply
)
3390 == XPC_TYPE_DICTIONARY
)
3391 response
= xpc_retain(reply
);
3393 dispatch_semaphore_signal(sem
);
3396 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3397 xpc_release(request
);
3398 dispatch_release(sem
);
3402 child_pid
= (pid_t
)xpc_dictionary_get_int64(response
, "child-pid");
3404 xpc_release(response
);
3407 fprintf(stderr
, "DEBUG: Child PID=%d.\n", (int)child_pid
);
3410 _cupsLangPrintFilter(stderr
, "ERROR",
3411 _("Unable to start backend process."));
3412 fputs("DEBUG: No child PID.\n", stderr
);
3418 _cupsLangPrintFilter(stderr
, "ERROR",
3419 _("Unable to start backend process."));
3420 fputs("DEBUG: No reply from agent.\n", stderr
);
3425 * Then wait for the backend to finish...
3428 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3429 xpc_dictionary_set_int64(request
, "command", kPMWaitForJob
);
3430 xpc_dictionary_set_fd(request
, "stderr", 2);
3432 sem
= dispatch_semaphore_create(0);
3435 xpc_connection_send_message_with_reply(conn
, request
,
3436 dispatch_get_global_queue(0,0),
3437 ^(xpc_object_t reply
)
3439 /* Save the response and wake up */
3440 if (xpc_get_type(reply
)
3441 == XPC_TYPE_DICTIONARY
)
3442 response
= xpc_retain(reply
);
3444 dispatch_semaphore_signal(sem
);
3447 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3448 xpc_release(request
);
3449 dispatch_release(sem
);
3453 status
= (int)xpc_dictionary_get_int64(response
, "status");
3455 if (status
== SIGTERM
|| status
== SIGKILL
|| status
== SIGPIPE
)
3457 fprintf(stderr
, "DEBUG: Child terminated on signal %d.\n", status
);
3458 status
= CUPS_BACKEND_FAILED
;
3460 else if (WIFSIGNALED(status
))
3462 fprintf(stderr
, "DEBUG: Child crashed on signal %d.\n", status
);
3463 status
= CUPS_BACKEND_STOP
;
3465 else if (WIFEXITED(status
))
3467 status
= WEXITSTATUS(status
);
3468 fprintf(stderr
, "DEBUG: Child exited with status %d.\n", status
);
3471 xpc_release(response
);
3474 _cupsLangPrintFilter(stderr
, "ERROR",
3475 _("Unable to get backend exit status."));
3481 xpc_connection_cancel(conn
);
3487 #endif /* HAVE_GSSAPI && HAVE_XPC */
3491 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
3495 sigterm_handler(int sig
) /* I - Signal */
3497 (void)sig
; /* remove compiler warnings... */
3499 write(2, "DEBUG: Got SIGTERM.\n", 20);
3501 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3504 kill(child_pid
, sig
);
3507 #endif /* HAVE_GSSAPI && HAVE_XPC */
3512 * Flag that the job should be canceled...
3515 write(2, "DEBUG: job_canceled = 1.\n", 25);
3522 * The scheduler already tried to cancel us once, now just terminate
3523 * after removing our temp file!
3527 unlink(tmpfilename
);
3534 * 'timeout_cb()' - Handle HTTP timeouts.
3537 static int /* O - 1 to continue, 0 to cancel */
3538 timeout_cb(http_t
*http
, /* I - Connection to server (unused) */
3539 void *user_data
) /* I - User data (unused) */
3544 return (!job_canceled
);
3549 * 'update_reasons()' - Update the printer-state-reasons values.
3553 update_reasons(ipp_attribute_t
*attr
, /* I - printer-state-reasons or NULL */
3554 const char *s
) /* I - STATE: string or NULL */
3556 char op
; /* Add (+), remove (-), replace (\0) */
3557 cups_array_t
*new_reasons
; /* New reasons array */
3558 char *reason
, /* Current reason */
3559 add
[2048], /* Reasons added string */
3560 *addptr
, /* Pointer into add string */
3561 rem
[2048], /* Reasons removed string */
3562 *remptr
; /* Pointer into remove string */
3563 const char *addprefix
, /* Current add string prefix */
3564 *remprefix
; /* Current remove string prefix */
3567 fprintf(stderr
, "DEBUG: update_reasons(attr=%d(%s%s), s=\"%s\")\n",
3568 attr
? attr
->num_values
: 0, attr
? attr
->values
[0].string
.text
: "",
3569 attr
&& attr
->num_values
> 1 ? ",..." : "", s
? s
: "(null)");
3572 * Create an array of new reason keyword strings...
3577 int i
; /* Looping var */
3579 new_reasons
= cupsArrayNew((cups_array_func_t
)strcmp
, NULL
);
3582 for (i
= 0; i
< attr
->num_values
; i
++)
3584 reason
= attr
->values
[i
].string
.text
;
3586 if (strcmp(reason
, "none") &&
3587 strcmp(reason
, "none-report") &&
3588 strcmp(reason
, "paused") &&
3589 strncmp(reason
, "spool-area-full", 15) &&
3590 strcmp(reason
, "com.apple.print.recoverable-warning") &&
3591 strncmp(reason
, "cups-", 5))
3592 cupsArrayAdd(new_reasons
, reason
);
3597 if (*s
== '+' || *s
== '-')
3602 new_reasons
= _cupsArrayNewStrings(s
, ',');
3608 * Compute the changes...
3612 addprefix
= "STATE: +";
3615 remprefix
= "STATE: -";
3618 fprintf(stderr
, "DEBUG2: op='%c', new_reasons=%d, state_reasons=%d\n",
3619 op
? op
: ' ', cupsArrayCount(new_reasons
),
3620 cupsArrayCount(state_reasons
));
3622 _cupsMutexLock(&report_mutex
);
3630 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3632 reason
= (char *)cupsArrayNext(new_reasons
))
3634 if (!cupsArrayFind(state_reasons
, reason
))
3636 if (!strncmp(reason
, "cups-remote-", 12))
3639 * If we are setting cups-remote-xxx, remove all other cups-remote-xxx
3643 char *temp
; /* Current reason in state_reasons */
3645 cupsArraySave(state_reasons
);
3647 for (temp
= (char *)cupsArrayFirst(state_reasons
);
3649 temp
= (char *)cupsArrayNext(state_reasons
))
3650 if (!strncmp(temp
, "cups-remote-", 12))
3652 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, temp
);
3653 remptr
+= strlen(remptr
);
3656 cupsArrayRemove(state_reasons
, temp
);
3660 cupsArrayRestore(state_reasons
);
3663 cupsArrayAdd(state_reasons
, reason
);
3665 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3666 addptr
+= strlen(addptr
);
3677 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3679 reason
= (char *)cupsArrayNext(new_reasons
))
3681 if (cupsArrayFind(state_reasons
, reason
))
3683 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3684 remptr
+= strlen(remptr
);
3687 cupsArrayRemove(state_reasons
, reason
);
3694 * Replace reasons...
3697 for (reason
= (char *)cupsArrayFirst(state_reasons
);
3699 reason
= (char *)cupsArrayNext(state_reasons
))
3701 if (strncmp(reason
, "cups-", 5) && !cupsArrayFind(new_reasons
, reason
))
3703 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3704 remptr
+= strlen(remptr
);
3707 cupsArrayRemove(state_reasons
, reason
);
3711 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3713 reason
= (char *)cupsArrayNext(new_reasons
))
3715 if (!cupsArrayFind(state_reasons
, reason
))
3717 cupsArrayAdd(state_reasons
, reason
);
3719 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3720 addptr
+= strlen(addptr
);
3726 _cupsMutexUnlock(&report_mutex
);
3729 * Report changes and return...
3732 if (add
[0] && rem
[0])
3733 fprintf(stderr
, "%s\n%s\n", add
, rem
);
3735 fprintf(stderr
, "%s\n", add
);
3737 fprintf(stderr
, "%s\n", rem
);