2 * IPP backend for CUPS.
4 * Copyright © 2007-2019 by Apple Inc.
5 * Copyright © 1997-2007 by Easy Software Products, all rights reserved.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more
12 * Include necessary headers.
15 #include "backend-private.h"
16 #include <cups/ppd-private.h>
17 #include <cups/array-private.h>
18 #include <sys/types.h>
21 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
23 # define kPMPrintUIToolAgent "com.apple.printuitool.agent"
24 # define kPMStartJob 100
25 # define kPMWaitForJob 101
26 extern void xpc_connection_set_target_uid(xpc_connection_t connection
,
28 #endif /* HAVE_GSSAPI && HAVE_XPC */
32 * Bits for job-state-reasons we care about...
35 #define _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED 0x01
36 #define _CUPS_JSR_ACCOUNT_CLOSED 0x02
37 #define _CUPS_JSR_ACCOUNT_INFO_NEEDED 0x04
38 #define _CUPS_JSR_ACCOUNT_LIMIT_REACHED 0x08
39 #define _CUPS_JSR_JOB_PASSWORD_WAIT 0x10
40 #define _CUPS_JSR_JOB_RELEASE_WAIT 0x20
41 #define _CUPS_JSR_DOCUMENT_FORMAT_ERROR 0x40
42 #define _CUPS_JSR_DOCUMENT_UNPRINTABLE 0x80
49 typedef struct _cups_monitor_s
/**** Monitoring data ****/
51 const char *uri
, /* Printer URI */
52 *hostname
, /* Hostname */
54 *resource
; /* Resource path */
55 int port
, /* Port number */
56 version
, /* IPP version */
57 job_id
, /* Job ID for submitted job */
58 job_reasons
, /* Job state reasons bits */
59 create_job
, /* Support Create-Job? */
60 get_job_attrs
; /* Support Get-Job-Attributes? */
61 const char *job_name
; /* Job name for submitted job */
62 http_encryption_t encryption
; /* Use encryption? */
63 ipp_jstate_t job_state
; /* Current job state */
64 ipp_pstate_t printer_state
; /* Current printer state */
65 int retryable
; /* Is this a job that should be retried? */
73 static const char *auth_info_required
;
74 /* New auth-info-required value */
75 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
76 static pid_t child_pid
= 0; /* Child process ID */
77 #endif /* HAVE_GSSAPI && HAVE_XPC */
78 static const char * const jattrs
[] = /* Job attributes we want */
81 "job-impressions-completed",
82 "job-media-sheets-completed",
84 "job-originating-user-name",
88 static int job_canceled
= 0,
91 /* Credentials supplied in URI? */
92 static char username
[256] = "",
93 /* Username for device URI */
95 /* Password for device URI */
96 static const char * const pattrs
[] = /* Printer attributes we want */
99 "compression-supported",
100 #endif /* HAVE_LIBZ */
103 "document-format-supported",
104 "job-password-encryption-supported",
106 "marker-high-levels",
112 "media-col-supported",
113 "multiple-document-handling-supported",
114 "operations-supported",
115 "print-color-mode-supported",
117 "printer-alert-description",
118 "printer-is-accepting-jobs",
119 "printer-mandatory-job-attributes",
121 "printer-state-message",
122 "printer-state-reasons"
124 static const char * const remote_job_states
[] =
125 { /* Remote job state keywords */
126 "+cups-remote-pending",
127 "+cups-remote-pending-held",
128 "+cups-remote-processing",
129 "+cups-remote-stopped",
130 "+cups-remote-canceled",
131 "+cups-remote-aborted",
132 "+cups-remote-completed"
134 static _cups_mutex_t report_mutex
= _CUPS_MUTEX_INITIALIZER
;
135 /* Mutex to control access */
136 static int num_attr_cache
= 0;
137 /* Number of cached attributes */
138 static cups_option_t
*attr_cache
= NULL
;
139 /* Cached attributes */
140 static cups_array_t
*state_reasons
; /* Array of printe-state-reasons keywords */
141 static char tmpfilename
[1024] = "";
142 /* Temporary spool file name */
143 static char mandatory_attrs
[1024] = "";
144 /* cupsMandatory value */
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 debug_attributes(ipp_t
*ipp
);
158 static void *monitor_printer(_cups_monitor_t
*monitor
);
159 static ipp_t
*new_request(ipp_op_t op
, int version
, const char *uri
,
160 const char *user
, const char *title
,
161 int num_options
, cups_option_t
*options
,
162 const char *compression
, int copies
,
163 const char *format
, _ppd_cache_t
*pc
,
165 ipp_attribute_t
*media_col_sup
,
166 ipp_attribute_t
*doc_handling_sup
,
167 ipp_attribute_t
*print_color_mode_sup
);
168 static const char *password_cb(const char *prompt
, http_t
*http
,
169 const char *method
, const char *resource
,
171 static const char *quote_string(const char *s
, char *q
, size_t qsize
);
172 static void report_attr(ipp_attribute_t
*attr
);
173 static void report_printer_state(ipp_t
*ipp
);
174 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
175 static int run_as_user(char *argv
[], uid_t uid
,
176 const char *device_uri
, int fd
);
177 #endif /* HAVE_GSSAPI && HAVE_XPC */
178 static void sigterm_handler(int sig
);
179 static int timeout_cb(http_t
*http
, void *user_data
);
180 static void update_reasons(ipp_attribute_t
*attr
, const char *s
);
184 * 'main()' - Send a file to the printer or server.
188 * printer-uri job-id user title copies options [file]
191 int /* O - Exit status */
192 main(int argc
, /* I - Number of command-line args */
193 char *argv
[]) /* I - Command-line arguments */
195 int i
; /* Looping var */
196 int send_options
; /* Send job options? */
197 int num_options
; /* Number of printer options */
198 cups_option_t
*options
; /* Printer options */
199 const char *device_uri
; /* Device URI */
200 char scheme
[255], /* Scheme in URI */
201 hostname
[1024], /* Hostname */
202 resource
[1024], /* Resource info (printer name) */
203 addrname
[256], /* Address name */
204 *optptr
, /* Pointer to URI options */
205 *name
, /* Name of option */
206 *value
, /* Value of option */
207 sep
; /* Separator character */
208 int password_tries
= 0; /* Password tries */
209 http_addrlist_t
*addrlist
; /* Address of printer */
210 int snmp_enabled
= 1; /* Is SNMP enabled? */
211 int snmp_fd
, /* SNMP socket */
212 start_count
, /* Page count via SNMP at start */
213 page_count
, /* Page count via SNMP */
214 have_supplies
; /* Printer supports supply levels? */
215 int num_files
; /* Number of files to print */
216 char **files
, /* Files to print */
217 *compatfile
= NULL
; /* Compatibility filename */
218 off_t compatsize
= 0; /* Size of compatibility file */
219 int port
; /* Port number (not used) */
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
*encryption_sup
; /* job-password-encryption-supported */
247 ipp_attribute_t
*format_sup
; /* document-format-supported */
248 ipp_attribute_t
*job_auth
; /* job-authorization-uri */
249 ipp_attribute_t
*media_col_sup
; /* media-col-supported */
250 ipp_attribute_t
*operations_sup
; /* operations-supported */
251 ipp_attribute_t
*doc_handling_sup
; /* multiple-document-handling-supported */
252 ipp_attribute_t
*printer_state
; /* printer-state attribute */
253 ipp_attribute_t
*printer_accepting
; /* printer-is-accepting-jobs */
254 ipp_attribute_t
*print_color_mode_sup
;/* Does printer support print-color-mode? */
255 int create_job
= 0, /* Does printer support Create-Job? */
256 get_job_attrs
= 0, /* Does printer support Get-Job-Attributes? */
257 send_document
= 0, /* Does printer support Send-Document? */
258 validate_job
= 0, /* Does printer support Validate-Job? */
259 copies
, /* Number of copies for job */
260 copies_remaining
; /* Number of copies remaining */
261 const char *content_type
, /* CONTENT_TYPE environment variable */
262 *final_content_type
, /* FINAL_CONTENT_TYPE environment var */
263 *document_format
; /* document-format value */
264 int fd
; /* File descriptor */
265 off_t bytes
= 0; /* Bytes copied */
266 char buffer
[16384]; /* Copy buffer */
267 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
268 struct sigaction action
; /* Actions for POSIX signals */
269 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
270 int version
; /* IPP version */
271 ppd_file_t
*ppd
= NULL
; /* PPD file */
272 _ppd_cache_t
*pc
= NULL
; /* PPD cache and mapping data */
273 fd_set input
; /* Input set for select() */
277 * Make sure status messages are not buffered...
280 setbuf(stderr
, NULL
);
283 * Ignore SIGPIPE and catch SIGTERM signals...
287 sigset(SIGPIPE
, SIG_IGN
);
288 sigset(SIGTERM
, sigterm_handler
);
289 #elif defined(HAVE_SIGACTION)
290 memset(&action
, 0, sizeof(action
));
291 action
.sa_handler
= SIG_IGN
;
292 sigaction(SIGPIPE
, &action
, NULL
);
294 sigemptyset(&action
.sa_mask
);
295 sigaddset(&action
.sa_mask
, SIGTERM
);
296 action
.sa_handler
= sigterm_handler
;
297 sigaction(SIGTERM
, &action
, NULL
);
299 signal(SIGPIPE
, SIG_IGN
);
300 signal(SIGTERM
, sigterm_handler
);
301 #endif /* HAVE_SIGSET */
304 * Check command-line...
311 if ((s
= strrchr(argv
[0], '/')) != NULL
)
316 printf("network %s \"Unknown\" \"%s (%s)\"\n",
317 s
, _cupsLangString(cupsLangDefault(),
318 _("Internet Printing Protocol")), s
);
319 return (CUPS_BACKEND_OK
);
323 _cupsLangPrintf(stderr
,
324 _("Usage: %s job-id user title copies options [file]"),
326 return (CUPS_BACKEND_STOP
);
330 * Get the device URI...
333 while ((device_uri
= cupsBackendDeviceURI(argv
)) == NULL
)
335 _cupsLangPrintFilter(stderr
, "INFO", _("Unable to locate printer."));
338 if (getenv("CLASS") != NULL
)
339 return (CUPS_BACKEND_FAILED
);
342 if ((auth_info_required
= getenv("AUTH_INFO_REQUIRED")) == NULL
)
343 auth_info_required
= "none";
345 state_reasons
= _cupsArrayNewStrings(getenv("PRINTER_STATE_REASONS"), ',');
349 * For Kerberos, become the printing user (if we can) to get the credentials
353 if (!getuid() && (value
= getenv("AUTH_UID")) != NULL
)
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_ENCRYPTION_ALWAYS
);
421 cupsSetEncryption(HTTP_ENCRYPTION_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_ENCRYPTION_ALWAYS
);
509 else if (!_cups_strcasecmp(value
, "required"))
510 cupsSetEncryption(HTTP_ENCRYPTION_REQUIRED
);
511 else if (!_cups_strcasecmp(value
, "never"))
512 cupsSetEncryption(HTTP_ENCRYPTION_NEVER
);
513 else if (!_cups_strcasecmp(value
, "ifrequested"))
514 cupsSetEncryption(HTTP_ENCRYPTION_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
);
638 * Try loading authentication information from the environment.
641 const char *ptr
= getenv("AUTH_USERNAME");
645 strlcpy(username
, ptr
, sizeof(username
));
649 password
= getenv("AUTH_PASSWORD");
653 * Try finding the remote server...
656 start_time
= time(NULL
);
658 addrlist
= backendLookup(hostname
, port
, &job_canceled
);
660 http
= httpConnect2(hostname
, port
, addrlist
, AF_UNSPEC
, cupsEncryption(), 1,
662 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
665 * See if the printer supports SNMP...
669 snmp_fd
= _cupsSNMPOpen(addrlist
->addr
.addr
.sa_family
);
674 have_supplies
= !backendSNMPSupplies(snmp_fd
, &(addrlist
->addr
),
677 have_supplies
= start_count
= 0;
680 * Wait for data from the filter...
685 if (!backendWaitLoop(snmp_fd
, &(addrlist
->addr
), 0, backendNetworkSideCB
))
686 return (CUPS_BACKEND_OK
);
687 else if ((bytes
= read(0, buffer
, sizeof(buffer
))) <= 0)
688 return (CUPS_BACKEND_OK
);
692 * Try connecting to the remote server...
695 delay
= _cupsNextDelay(0, &prev_delay
);
699 fprintf(stderr
, "DEBUG: Connecting to %s:%d\n", hostname
, port
);
700 _cupsLangPrintFilter(stderr
, "INFO", _("Connecting to printer."));
702 if (httpReconnect2(http
, 30000, NULL
))
704 int error
= errno
; /* Connection error */
706 if (http
->status
== HTTP_STATUS_CUPS_PKI_ERROR
)
707 update_reasons(NULL
, "+cups-certificate-error");
712 if (getenv("CLASS") != NULL
)
715 * If the CLASS environment variable is set, the job was submitted
716 * to a class and not to a specific queue. In this case, we want
717 * to abort immediately so that the job can be requeued on the next
718 * available printer in the class.
721 _cupsLangPrintFilter(stderr
, "INFO",
722 _("Unable to contact printer, queuing on next "
723 "printer in class."));
726 * Sleep 5 seconds to keep the job from requeuing too rapidly...
731 update_reasons(NULL
, "-connecting-to-device");
733 return (CUPS_BACKEND_FAILED
);
736 fprintf(stderr
, "DEBUG: Connection error: %s\n", strerror(errno
));
738 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
|| errno
== EHOSTUNREACH
|| errno
== ETIMEDOUT
|| errno
== ENOTCONN
)
740 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
742 _cupsLangPrintFilter(stderr
, "ERROR",
743 _("The printer is not responding."));
744 update_reasons(NULL
, "-connecting-to-device");
745 return (CUPS_BACKEND_FAILED
);
751 _cupsLangPrintFilter(stderr
, "WARNING",
752 _("The printer may not exist or "
753 "is unavailable at this time."));
758 _cupsLangPrintFilter(stderr
, "WARNING",
759 _("The printer is unreachable at this "
764 _cupsLangPrintFilter(stderr
, "WARNING",
765 _("The printer is in use."));
769 sleep((unsigned)delay
);
771 delay
= _cupsNextDelay(delay
, &prev_delay
);
775 _cupsLangPrintFilter(stderr
, "ERROR",
776 _("The printer is not responding."));
784 update_reasons(NULL
, "-cups-certificate-error");
786 while (http
->fd
< 0);
789 return (CUPS_BACKEND_OK
);
791 return (CUPS_BACKEND_FAILED
);
793 if (httpIsEncrypted(http
))
796 * Validate TLS credentials...
799 cups_array_t
*creds
; /* TLS credentials */
800 cups_array_t
*lcreds
= NULL
; /* Loaded credentials */
801 http_trust_t trust
; /* Trust level */
802 char credinfo
[1024], /* Information on credentials */
803 lcredinfo
[1024];/* Information on saved credentials */
804 static const char * const trusts
[] = { NULL
, "+cups-pki-invalid", "+cups-pki-changed", "+cups-pki-expired", NULL
, "+cups-pki-unknown" };
806 static const char * const trust_msgs
[] =
808 "Credentials are OK/trusted",
809 "Credentials are invalid",
810 "Credentials have changed",
811 "Credentials are expired",
812 "Credentials have been renewed",
813 "Credentials are unknown/new"
816 fputs("DEBUG: Connection is encrypted.\n", stderr
);
818 if (!httpCopyCredentials(http
, &creds
))
820 trust
= httpCredentialsGetTrust(creds
, hostname
);
821 httpCredentialsString(creds
, credinfo
, sizeof(credinfo
));
823 fprintf(stderr
, "DEBUG: %s (%s)\n", trust_msgs
[trust
], cupsLastErrorString());
824 fprintf(stderr
, "DEBUG: Printer credentials: %s\n", credinfo
);
826 if (!httpLoadCredentials(NULL
, &lcreds
, hostname
))
828 httpCredentialsString(lcreds
, lcredinfo
, sizeof(lcredinfo
));
829 fprintf(stderr
, "DEBUG: Stored credentials: %s\n", lcredinfo
);
832 fputs("DEBUG: No stored credentials.\n", stderr
);
834 update_reasons(NULL
, "-cups-pki-invalid,cups-pki-changed,cups-pki-expired,cups-pki-unknown");
837 update_reasons(NULL
, trusts
[trust
]);
838 return (CUPS_BACKEND_STOP
);
844 * Could not load the credentials, let's save the ones we have so we
845 * can detect changes...
848 httpSaveCredentials(NULL
, creds
, hostname
);
851 httpFreeCredentials(lcreds
);
852 httpFreeCredentials(creds
);
856 fputs("DEBUG: No printer credentials.\n", stderr
);
858 update_reasons(NULL
, "cups-pki-unknown");
859 return (CUPS_BACKEND_STOP
);
863 update_reasons(NULL
, "-connecting-to-device");
864 _cupsLangPrintFilter(stderr
, "INFO", _("Connected to printer."));
866 fprintf(stderr
, "DEBUG: Connected to %s:%d...\n",
867 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
868 httpAddrPort(http
->hostaddr
));
871 * Build a URI for the printer and fill the standard IPP attributes for
872 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
873 * might contain username:password information...
876 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), scheme
, NULL
, hostname
,
880 * First validate the destination and see if the device supports multiple
885 compression_sup
= NULL
;
886 #endif /* HAVE_LIBZ */
889 encryption_sup
= NULL
;
891 media_col_sup
= NULL
;
893 operations_sup
= NULL
;
894 doc_handling_sup
= NULL
;
895 print_color_mode_sup
= NULL
;
900 * Check for side-channel requests...
903 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
906 * Build the IPP request...
909 request
= ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES
);
910 ippSetVersion(request
, version
/ 10, version
% 10);
911 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
914 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
915 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
922 fputs("DEBUG: Getting supported attributes...\n", stderr
);
924 if (http
->version
< HTTP_VERSION_1_1
)
926 fprintf(stderr
, "DEBUG: Printer responded with HTTP version %d.%d.\n",
927 http
->version
/ 100, http
->version
% 100);
928 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
929 "cups-ipp-wrong-http-version");
932 supported
= cupsDoRequest(http
, request
, resource
);
933 ipp_status
= cupsLastError();
935 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
936 ippErrorString(ipp_status
), cupsLastErrorString());
938 if (ipp_status
<= IPP_STATUS_OK_CONFLICTING
)
942 fprintf(stderr
, "DEBUG: Get-Printer-Attributes returned %s.\n",
943 ippErrorString(ipp_status
));
945 if (ipp_status
== IPP_STATUS_ERROR_BUSY
||
946 ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
)
948 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
950 _cupsLangPrintFilter(stderr
, "ERROR",
951 _("The printer is not responding."));
952 return (CUPS_BACKEND_FAILED
);
955 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
957 report_printer_state(supported
);
959 sleep((unsigned)delay
);
961 delay
= _cupsNextDelay(delay
, &prev_delay
);
963 else if ((ipp_status
== IPP_STATUS_ERROR_BAD_REQUEST
||
964 ipp_status
== IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED
) && version
> 10)
967 * Switch to IPP/1.1 or IPP/1.0...
972 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
974 "DEBUG: The printer does not support IPP/%d.%d, trying "
975 "IPP/1.1.\n", version
/ 10, version
% 10);
980 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
982 "DEBUG: The printer does not support IPP/%d.%d, trying "
983 "IPP/1.0.\n", version
/ 10, version
% 10);
987 httpReconnect2(http
, 30000, NULL
);
989 else if (ipp_status
== IPP_STATUS_ERROR_NOT_FOUND
)
991 _cupsLangPrintFilter(stderr
, "ERROR",
992 _("The printer configuration is incorrect or the "
993 "printer no longer exists."));
995 ippDelete(supported
);
997 return (CUPS_BACKEND_STOP
);
999 else if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1000 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1002 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1003 /* WWW-Authenticate field value */
1005 if (!strncmp(www_auth
, "Negotiate", 9))
1006 auth_info_required
= "negotiate";
1007 else if (www_auth
[0])
1008 auth_info_required
= "username,password";
1010 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
1011 return (CUPS_BACKEND_AUTH_REQUIRED
);
1013 else if (ipp_status
!= IPP_STATUS_ERROR_NOT_AUTHORIZED
)
1015 _cupsLangPrintFilter(stderr
, "ERROR",
1016 _("Unable to get printer status."));
1019 httpReconnect2(http
, 30000, NULL
);
1022 ippDelete(supported
);
1027 if (!getenv("CLASS"))
1030 * Check printer-is-accepting-jobs = false and printer-state-reasons for the
1031 * "spool-area-full" keyword...
1036 if ((printer_accepting
= ippFindAttribute(supported
,
1037 "printer-is-accepting-jobs",
1038 IPP_TAG_BOOLEAN
)) != NULL
&&
1039 !printer_accepting
->values
[0].boolean
)
1041 else if (!printer_accepting
)
1042 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1043 "cups-ipp-missing-printer-is-accepting-jobs");
1045 if ((printer_state
= ippFindAttribute(supported
,
1046 "printer-state-reasons",
1047 IPP_TAG_KEYWORD
)) == NULL
)
1049 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1050 "cups-ipp-missing-printer-state-reasons");
1054 for (i
= 0; i
< printer_state
->num_values
; i
++)
1056 if (!strcmp(printer_state
->values
[0].string
.text
,
1057 "spool-area-full") ||
1058 !strncmp(printer_state
->values
[0].string
.text
, "spool-area-full-",
1069 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1071 report_printer_state(supported
);
1073 sleep((unsigned)delay
);
1075 delay
= _cupsNextDelay(delay
, &prev_delay
);
1077 ippDelete(supported
);
1079 ipp_status
= IPP_STATUS_ERROR_BUSY
;
1085 * Check for supported attributes...
1089 if ((compression_sup
= ippFindAttribute(supported
, "compression-supported",
1090 IPP_TAG_KEYWORD
)) != NULL
)
1093 * Check whether the requested compression is supported and/or default to
1094 * compression if supported...
1097 if (compression
&& !ippContainsString(compression_sup
, compression
))
1099 fprintf(stderr
, "DEBUG: Printer does not support the requested "
1100 "compression value \"%s\".\n", compression
);
1103 else if (!compression
&& (!strcmp(final_content_type
, "image/pwg-raster") || !strcmp(final_content_type
, "image/urf")))
1105 if (ippContainsString(compression_sup
, "gzip"))
1106 compression
= "gzip";
1107 else if (ippContainsString(compression_sup
, "deflate"))
1108 compression
= "deflate";
1111 fprintf(stderr
, "DEBUG: Automatically using \"%s\" compression.\n",
1115 #endif /* HAVE_LIBZ */
1117 if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
1118 IPP_TAG_RANGE
)) != NULL
)
1121 * Has the "copies-supported" attribute - does it have an upper
1125 fprintf(stderr
, "DEBUG: copies-supported=%d-%d\n",
1126 copies_sup
->values
[0].range
.lower
,
1127 copies_sup
->values
[0].range
.upper
);
1129 if (copies_sup
->values
[0].range
.upper
<= 1)
1130 copies_sup
= NULL
; /* No */
1133 if ((cups_version
= ippFindAttribute(supported
, "cups-version", IPP_TAG_TEXT
)) != NULL
)
1135 const char *val
= ippGetString(cups_version
, 0, NULL
);
1137 fprintf(stderr
, "DEBUG: cups-version = \"%s\"\n", val
);
1138 if (!strcmp(val
, "cups-version"))
1139 cups_version
= NULL
; /* Bogus cups-version value returned by buggy printers! */
1142 encryption_sup
= ippFindAttribute(supported
, "job-password-encryption-supported", IPP_TAG_KEYWORD
);
1144 if ((format_sup
= ippFindAttribute(supported
, "document-format-supported",
1145 IPP_TAG_MIMETYPE
)) != NULL
)
1147 fprintf(stderr
, "DEBUG: document-format-supported (%d values)\n",
1148 format_sup
->num_values
);
1149 for (i
= 0; i
< format_sup
->num_values
; i
++)
1150 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1151 format_sup
->values
[i
].string
.text
);
1154 if ((media_col_sup
= ippFindAttribute(supported
, "media-col-supported",
1155 IPP_TAG_KEYWORD
)) != NULL
)
1157 fprintf(stderr
, "DEBUG: media-col-supported (%d values)\n",
1158 media_col_sup
->num_values
);
1159 for (i
= 0; i
< media_col_sup
->num_values
; i
++)
1160 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1161 media_col_sup
->values
[i
].string
.text
);
1164 print_color_mode_sup
= ippFindAttribute(supported
, "print-color-mode-supported", IPP_TAG_KEYWORD
);
1166 if ((operations_sup
= ippFindAttribute(supported
, "operations-supported",
1167 IPP_TAG_ENUM
)) != NULL
)
1169 fprintf(stderr
, "DEBUG: operations-supported (%d values)\n",
1170 operations_sup
->num_values
);
1171 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1172 fprintf(stderr
, "DEBUG: [%d] = %s\n", i
,
1173 ippOpString(operations_sup
->values
[i
].integer
));
1175 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1176 if (operations_sup
->values
[i
].integer
== IPP_OP_PRINT_JOB
)
1179 if (i
>= operations_sup
->num_values
)
1180 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1181 "cups-ipp-missing-print-job");
1183 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1184 if (operations_sup
->values
[i
].integer
== IPP_OP_CANCEL_JOB
)
1187 if (i
>= operations_sup
->num_values
)
1188 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1189 "cups-ipp-missing-cancel-job");
1191 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1192 if (operations_sup
->values
[i
].integer
== IPP_OP_GET_JOB_ATTRIBUTES
)
1195 if (i
>= operations_sup
->num_values
)
1196 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1197 "cups-ipp-missing-get-job-attributes");
1199 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1200 if (operations_sup
->values
[i
].integer
== IPP_OP_GET_PRINTER_ATTRIBUTES
)
1203 if (i
>= operations_sup
->num_values
)
1204 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1205 "cups-ipp-missing-get-printer-attributes");
1207 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1209 if (operations_sup
->values
[i
].integer
== IPP_OP_VALIDATE_JOB
)
1211 else if (operations_sup
->values
[i
].integer
== IPP_OP_CREATE_JOB
)
1213 else if (operations_sup
->values
[i
].integer
== IPP_OP_SEND_DOCUMENT
)
1215 else if (operations_sup
->values
[i
].integer
== IPP_OP_GET_JOB_ATTRIBUTES
)
1219 if (create_job
&& !send_document
)
1221 fputs("DEBUG: Printer supports Create-Job but not Send-Document.\n",
1225 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1226 "cups-ipp-missing-send-document");
1230 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1231 "cups-ipp-missing-validate-job");
1234 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1235 "cups-ipp-missing-operations-supported");
1237 doc_handling_sup
= ippFindAttribute(supported
,
1238 "multiple-document-handling-supported",
1241 report_printer_state(supported
);
1243 while (!job_canceled
&& ipp_status
> IPP_STATUS_OK_CONFLICTING
);
1246 return (CUPS_BACKEND_OK
);
1249 * See if the printer is accepting jobs and is not stopped; if either
1250 * condition is true and we are printing to a class, requeue the job...
1253 if (getenv("CLASS") != NULL
)
1255 printer_state
= ippFindAttribute(supported
, "printer-state",
1257 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
1260 if (printer_state
== NULL
||
1261 (printer_state
->values
[0].integer
> IPP_PSTATE_PROCESSING
&&
1263 printer_accepting
== NULL
||
1264 !printer_accepting
->values
[0].boolean
)
1267 * If the CLASS environment variable is set, the job was submitted
1268 * to a class and not to a specific queue. In this case, we want
1269 * to abort immediately so that the job can be requeued on the next
1270 * available printer in the class.
1273 _cupsLangPrintFilter(stderr
, "INFO",
1274 _("Unable to contact printer, queuing on next "
1275 "printer in class."));
1277 ippDelete(supported
);
1281 * Sleep 5 seconds to keep the job from requeuing too rapidly...
1286 return (CUPS_BACKEND_FAILED
);
1291 * See if the printer supports multiple copies...
1294 copies
= atoi(argv
[4]);
1296 if (copies_sup
|| argc
< 7)
1297 copies_remaining
= 1;
1299 copies_remaining
= copies
;
1302 * Prepare remaining printing options...
1309 num_options
= cupsParseOptions(argv
[5], 0, &options
);
1311 if (!cups_version
&& media_col_sup
)
1314 * Load the PPD file and generate PWG attribute mapping information...
1317 ppd_attr_t
*mandatory
; /* cupsMandatory value */
1319 ppd
= ppdOpenFile(getenv("PPD"));
1320 pc
= _ppdCacheCreateWithPPD(ppd
);
1322 ppdMarkDefaults(ppd
);
1323 cupsMarkOptions(ppd
, num_options
, options
);
1325 if ((mandatory
= ppdFindAttr(ppd
, "cupsMandatory", NULL
)) != NULL
)
1326 strlcpy(mandatory_attrs
, mandatory
->value
, sizeof(mandatory_attrs
));
1330 * Validate job-password/-encryption...
1333 if (cupsGetOption("job-password", num_options
, options
))
1335 const char *keyword
; /* job-password-encryption value */
1336 static const char * const hashes
[] =
1337 { /* List of supported hash algorithms, in order of preference */
1348 if ((keyword
= cupsGetOption("job-password-encryption", num_options
, options
)) == NULL
|| !ippContainsString(encryption_sup
, keyword
))
1351 * Either no job-password-encryption or the value isn't supported by
1355 for (i
= 0; i
< (int)(sizeof(hashes
) / sizeof(hashes
[0])); i
++)
1356 if (ippContainsString(encryption_sup
, hashes
[i
]))
1359 if (i
< (int)(sizeof(hashes
) / sizeof(hashes
[0])))
1360 num_options
= cupsAddOption("job-password-encryption", hashes
[i
], num_options
, &options
);
1367 document_format
= NULL
;
1369 if (format_sup
!= NULL
)
1371 if (ippContainsString(format_sup
, final_content_type
))
1372 document_format
= final_content_type
;
1373 else if (ippContainsString(format_sup
, "application/octet-stream"))
1374 document_format
= "application/octet-stream";
1377 fprintf(stderr
, "DEBUG: final_content_type=\"%s\", document_format=\"%s\"\n",
1378 final_content_type
, document_format
? document_format
: "(null)");
1381 * If the printer does not support HTTP/1.1 (which IPP requires), copy stdin
1382 * to a temporary file so that we can do a HTTP/1.0 submission...
1384 * (I hate compatibility hacks!)
1387 if (http
->version
< HTTP_VERSION_1_1
&& num_files
== 0)
1389 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
1391 perror("DEBUG: Unable to create temporary file");
1392 return (CUPS_BACKEND_FAILED
);
1395 _cupsLangPrintFilter(stderr
, "INFO", _("Copying print data."));
1397 if ((compatsize
= write(fd
, buffer
, (size_t)bytes
)) < 0)
1399 perror("DEBUG: Unable to write temporary file");
1400 return (CUPS_BACKEND_FAILED
);
1403 if ((bytes
= backendRunLoop(-1, fd
, snmp_fd
, &(addrlist
->addr
), 0, 0,
1404 backendNetworkSideCB
)) < 0)
1405 return (CUPS_BACKEND_FAILED
);
1407 compatsize
+= bytes
;
1411 compatfile
= tmpfilename
;
1412 files
= &compatfile
;
1415 else if (http
->version
< HTTP_VERSION_1_1
&& num_files
== 1)
1417 struct stat fileinfo
; /* File information */
1419 if (!stat(files
[0], &fileinfo
))
1420 compatsize
= fileinfo
.st_size
;
1424 * If the printer only claims to support IPP/1.0, or if the user specifically
1425 * included version=1.0 in the URI, then do not try to use Create-Job or
1426 * Send-Document. This is another dreaded compatibility hack, but
1427 * unfortunately there are enough broken printers out there that we need
1432 create_job
= send_document
= 0;
1435 * Start monitoring the printer in the background...
1439 monitor
.hostname
= hostname
;
1440 monitor
.user
= argv
[2];
1441 monitor
.resource
= resource
;
1442 monitor
.port
= port
;
1443 monitor
.version
= version
;
1445 monitor
.create_job
= create_job
;
1446 monitor
.get_job_attrs
= get_job_attrs
;
1447 monitor
.encryption
= cupsEncryption();
1448 monitor
.job_state
= IPP_JSTATE_PENDING
;
1449 monitor
.printer_state
= IPP_PSTATE_IDLE
;
1450 monitor
.retryable
= argc
== 6 && document_format
&& strcmp(document_format
, "image/pwg-raster") && strcmp(document_format
, "image/urf");
1452 fprintf(stderr
, "DEBUG: retryable=%d\n", monitor
.retryable
);
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_OP_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());
1484 debug_attributes(response
);
1486 if ((job_auth
= ippFindAttribute(response
, "job-authorization-uri",
1487 IPP_TAG_URI
)) != NULL
)
1488 num_options
= cupsAddOption("job-authorization-uri",
1489 ippGetString(job_auth
, 0, NULL
), num_options
,
1492 if (ipp_status
== IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED
|| ipp_status
== IPP_STATUS_OK_CONFLICTING
)
1495 * One or more options are not supported...
1498 ipp_attribute_t
*attr
; /* Unsupported attribute */
1500 if ((attr
= ippFindAttribute(response
, "sides", IPP_TAG_ZERO
)) != NULL
)
1503 * The sides value is not supported, revert to one-sided as needed...
1506 const char *sides
= cupsGetOption("sides", num_options
, options
);
1508 if (!sides
|| !strncmp(sides
, "two-sided-", 10))
1510 fputs("DEBUG: Unable to do two-sided printing, setting sides to 'one-sided'.\n", stderr
);
1511 num_options
= cupsAddOption("sides", "one-sided", num_options
, &options
);
1516 ippDelete(response
);
1521 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1522 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1524 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1527 else if (ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
||
1528 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1529 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1530 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1531 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1532 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1534 else if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1535 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1536 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1538 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1539 /* WWW-Authenticate field value */
1541 if (!strncmp(www_auth
, "Negotiate", 9))
1542 auth_info_required
= "negotiate";
1543 else if (www_auth
[0])
1544 auth_info_required
= "username,password";
1548 else if (ipp_status
== IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
)
1551 * This is all too common...
1554 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1555 "cups-ipp-missing-validate-job");
1558 else if (ipp_status
< IPP_STATUS_REDIRECTION_OTHER_SITE
||
1559 ipp_status
== IPP_STATUS_ERROR_BAD_REQUEST
)
1561 else if (job_auth
== NULL
&& ipp_status
> IPP_STATUS_ERROR_BAD_REQUEST
)
1566 * Then issue the print-job request...
1571 while (!job_canceled
&& copies_remaining
> 0)
1574 * Check for side-channel requests...
1577 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1580 * Build the IPP job creation request...
1586 request
= new_request((num_files
> 1 || create_job
) ? IPP_OP_CREATE_JOB
:
1588 version
, uri
, argv
[2], monitor
.job_name
, num_options
,
1589 options
, compression
, copies_sup
? copies
: 1,
1590 document_format
, pc
, ppd
, media_col_sup
,
1591 doc_handling_sup
, print_color_mode_sup
);
1597 if (num_files
> 1 || create_job
)
1598 response
= cupsDoRequest(http
, request
, resource
);
1601 size_t length
= 0; /* Length of request */
1605 fputs("DEBUG: Sending file using HTTP/1.0 Content-Length...\n", stderr
);
1606 length
= ippLength(request
) + (size_t)compatsize
;
1609 fputs("DEBUG: Sending file using HTTP/1.1 chunking...\n", stderr
);
1611 http_status
= cupsSendRequest(http
, request
, resource
, length
);
1612 if (http_status
== HTTP_STATUS_CONTINUE
&& request
->state
== IPP_STATE_DATA
)
1614 if (compression
&& strcmp(compression
, "none"))
1615 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1619 if ((fd
= open(files
[0], O_RDONLY
)) < 0)
1621 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1622 return (CUPS_BACKEND_FAILED
);
1628 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1631 while (http_status
== HTTP_STATUS_CONTINUE
&&
1632 (!job_canceled
|| compatsize
> 0))
1635 * Check for side-channel requests and more print data...
1640 FD_SET(snmp_fd
, &input
);
1641 FD_SET(CUPS_SC_FD
, &input
);
1643 while (select(fd
> snmp_fd
? fd
+ 1 : snmp_fd
+ 1, &input
, NULL
, NULL
,
1644 NULL
) <= 0 && !job_canceled
);
1646 if (FD_ISSET(snmp_fd
, &input
))
1647 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1649 if (FD_ISSET(fd
, &input
))
1651 if ((bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1653 fprintf(stderr
, "DEBUG: Read %d bytes...\n", (int)bytes
);
1655 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1656 != HTTP_STATUS_CONTINUE
)
1659 else if (bytes
== 0 || (errno
!= EINTR
&& errno
!= EAGAIN
))
1664 if (http_status
== HTTP_STATUS_ERROR
)
1665 fprintf(stderr
, "DEBUG: Error writing document data for "
1666 "Print-Job: %s\n", strerror(httpError(http
)));
1672 response
= cupsGetResponse(http
, resource
);
1676 ipp_status
= cupsLastError();
1678 fprintf(stderr
, "DEBUG: %s: %s (%s)\n",
1679 (num_files
> 1 || create_job
) ? "Create-Job" : "Print-Job",
1680 ippErrorString(ipp_status
), cupsLastErrorString());
1681 debug_attributes(response
);
1683 if (ipp_status
> IPP_STATUS_OK_CONFLICTING
)
1690 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1691 ipp_status
== IPP_STATUS_ERROR_NOT_POSSIBLE
||
1692 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1694 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1700 * We can't re-submit when we have no files to print, so exit
1701 * immediately with the right status code...
1707 else if (ipp_status
== IPP_STATUS_ERROR_JOB_CANCELED
||
1708 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1709 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1710 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1711 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1712 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1713 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1718 * Update auth-info-required as needed...
1721 _cupsLangPrintFilter(stderr
, "ERROR",
1722 _("Print job was not accepted."));
1724 if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1725 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1727 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1728 /* WWW-Authenticate field value */
1730 if (!strncmp(www_auth
, "Negotiate", 9))
1731 auth_info_required
= "negotiate";
1732 else if (www_auth
[0])
1733 auth_info_required
= "username,password";
1735 else if (ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
)
1738 * Print file is too large, abort this job...
1749 * We can't re-submit when we have no files to print, so exit
1750 * immediately with the right status code...
1757 else if ((job_id_attr
= ippFindAttribute(response
, "job-id",
1758 IPP_TAG_INTEGER
)) == NULL
)
1760 fputs("DEBUG: Print job accepted - job ID unknown.\n", stderr
);
1761 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1762 "cups-ipp-missing-job-id");
1768 monitor
.job_id
= job_id
= job_id_attr
->values
[0].integer
;
1769 fprintf(stderr
, "DEBUG: Print job accepted - job ID %d.\n", job_id
);
1772 ippDelete(response
);
1777 if (job_id
&& (num_files
> 1 || create_job
))
1779 for (i
= 0; num_files
== 0 || i
< num_files
; i
++)
1782 * Check for side-channel requests...
1785 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1788 * Send the next file in the job...
1791 request
= ippNewRequest(IPP_OP_SEND_DOCUMENT
);
1792 ippSetVersion(request
, version
/ 10, version
% 10);
1794 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1797 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1801 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1802 "requesting-user-name", NULL
, argv
[2]);
1804 ippAddBoolean(request
, IPP_TAG_OPERATION
, "last-document",
1805 (i
+ 1) >= num_files
);
1807 if (document_format
)
1808 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
1809 "document-format", NULL
, document_format
);
1812 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1813 "compression", NULL
, compression
);
1815 fprintf(stderr
, "DEBUG: Sending file %d using chunking...\n", i
+ 1);
1816 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
1817 debug_attributes(request
);
1819 http_status
= cupsSendRequest(http
, request
, resource
, 0);
1820 if (http_status
== HTTP_STATUS_CONTINUE
&& request
->state
== IPP_STATE_DATA
)
1822 if (compression
&& strcmp(compression
, "none"))
1823 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1828 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1832 if ((fd
= open(files
[i
], O_RDONLY
)) < 0)
1834 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1835 return (CUPS_BACKEND_FAILED
);
1844 while (!job_canceled
&& http_status
== HTTP_STATUS_CONTINUE
&&
1845 (bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1847 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1848 != HTTP_STATUS_CONTINUE
)
1853 * Check for side-channel requests...
1856 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1864 if (http_status
== HTTP_STATUS_ERROR
)
1865 fprintf(stderr
, "DEBUG: Error writing document data for "
1866 "Send-Document: %s\n", strerror(httpError(http
)));
1868 response
= cupsGetResponse(http
, resource
);
1871 fprintf(stderr
, "DEBUG: Send-Document: %s (%s)\n", ippErrorString(cupsLastError()), cupsLastErrorString());
1872 debug_attributes(response
);
1874 if (cupsLastError() > IPP_STATUS_OK_CONFLICTING
&& !job_canceled
)
1876 ipp_attribute_t
*reasons
= ippFindAttribute(response
, "job-state-reasons", IPP_TAG_KEYWORD
);
1877 /* job-state-reasons values */
1879 ipp_status
= cupsLastError();
1881 if (ippContainsString(reasons
, "document-format-error"))
1882 ipp_status
= IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
;
1883 else if (ippContainsString(reasons
, "document-unprintable"))
1884 ipp_status
= IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
;
1886 ippDelete(response
);
1887 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to add document to print job."));
1892 ippDelete(response
);
1896 if (num_files
== 0 || fd
< 0)
1905 if (ipp_status
<= IPP_STATUS_OK_CONFLICTING
&& argc
> 6)
1907 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
1908 copies_remaining
--;
1910 else if ((ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
|| ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_ERROR
|| ipp_status
== IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
) &&
1912 document_format
&& strcmp(document_format
, "image/pwg-raster") && strcmp(document_format
, "image/urf"))
1915 * Need to reprocess the job as raster...
1918 fputs("JOBSTATE: cups-retry-as-raster\n", stderr
);
1920 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1924 else if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1925 ipp_status
== IPP_STATUS_ERROR_NOT_POSSIBLE
||
1926 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1931 * Need to reprocess the entire job; if we have a job ID, cancel the
1936 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1942 else if (ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
||
1943 ipp_status
== IPP_STATUS_ERROR_JOB_CANCELED
||
1944 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1945 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1946 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1947 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1948 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
||
1949 ipp_status
== IPP_STATUS_ERROR_INTERNAL
)
1952 * Print file is too large, job was canceled, we need new
1953 * authentication data, or we had some sort of error...
1958 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
)
1961 * Server is configured incorrectly; the policy for Create-Job and
1962 * Send-Document has to be the same (auth or no auth, encryption or
1963 * no encryption). Force the queue to stop since printing will never
1967 fputs("DEBUG: The server or printer is configured incorrectly.\n",
1969 fputs("DEBUG: The policy for Create-Job and Send-Document must have the "
1970 "same authentication and encryption requirements.\n", stderr
);
1972 ipp_status
= IPP_STATUS_ERROR_INTERNAL
;
1975 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1979 else if (ipp_status
== IPP_STATUS_ERROR_NOT_FOUND
)
1982 * Printer does not actually implement support for Create-Job/
1983 * Send-Document, so log the conformance issue and stop the printer.
1986 fputs("DEBUG: This printer claims to support Create-Job and "
1987 "Send-Document, but those operations failed.\n", stderr
);
1988 fputs("DEBUG: Add '?version=1.0' to the device URI to use legacy "
1989 "compatibility mode.\n", stderr
);
1990 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1991 "cups-ipp-missing-send-document");
1993 ipp_status
= IPP_STATUS_ERROR_INTERNAL
; /* Force queue to stop */
1998 copies_remaining
--;
2001 * Wait for the job to complete...
2004 if (!job_id
|| !waitjob
|| !get_job_attrs
)
2007 fputs("STATE: +cups-waiting-for-job-completed\n", stderr
);
2009 _cupsLangPrintFilter(stderr
, "INFO", _("Waiting for job to complete."));
2011 for (delay
= _cupsNextDelay(0, &prev_delay
); !job_canceled
;)
2014 * Check for side-channel requests...
2017 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
2020 * Check printer state...
2023 check_printer_state(http
, uri
, resource
, argv
[2], version
);
2025 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING
)
2029 * Build an IPP_OP_GET_JOB_ATTRIBUTES request...
2032 request
= ippNewRequest(IPP_OP_GET_JOB_ATTRIBUTES
);
2033 ippSetVersion(request
, version
/ 10, version
% 10);
2035 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2038 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2042 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2043 "requesting-user-name", NULL
, argv
[2]);
2045 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2046 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
2049 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2050 debug_attributes(request
);
2056 httpReconnect2(http
, 30000, NULL
);
2057 response
= cupsDoRequest(http
, request
, resource
);
2058 ipp_status
= cupsLastError();
2060 if (ipp_status
== IPP_STATUS_ERROR_NOT_FOUND
|| ipp_status
== IPP_STATUS_ERROR_NOT_POSSIBLE
)
2063 * Job has gone away and/or the server has no job history...
2066 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2067 "cups-ipp-missing-job-history");
2068 ippDelete(response
);
2070 ipp_status
= IPP_STATUS_OK
;
2074 fprintf(stderr
, "DEBUG: Get-Job-Attributes: %s (%s)\n",
2075 ippErrorString(ipp_status
), cupsLastErrorString());
2076 debug_attributes(response
);
2078 if (ipp_status
<= IPP_STATUS_OK_CONFLICTING
)
2082 if (ipp_status
!= IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
&&
2083 ipp_status
!= IPP_STATUS_ERROR_BUSY
)
2085 ippDelete(response
);
2086 ipp_status
= IPP_STATUS_OK
;
2089 else if (ipp_status
== IPP_STATUS_ERROR_INTERNAL
)
2093 if (waitjob_tries
> 4)
2095 ippDelete(response
);
2096 ipp_status
= IPP_STATUS_OK
;
2104 if ((job_state
= ippFindAttribute(response
, "job-state",
2105 IPP_TAG_ENUM
)) != NULL
)
2108 * Reflect the remote job state in the local queue...
2112 job_state
->values
[0].integer
>= IPP_JSTATE_PENDING
&&
2113 job_state
->values
[0].integer
<= IPP_JSTATE_COMPLETED
)
2114 update_reasons(NULL
,
2115 remote_job_states
[job_state
->values
[0].integer
-
2116 IPP_JSTATE_PENDING
]);
2118 if ((job_sheets
= ippFindAttribute(response
, "job-impressions-completed", IPP_TAG_INTEGER
)) == NULL
)
2119 job_sheets
= ippFindAttribute(response
, "job-media-sheets-completed", IPP_TAG_INTEGER
);
2122 fprintf(stderr
, "PAGE: total %d\n",
2123 job_sheets
->values
[0].integer
);
2126 * Stop polling if the job is finished or pending-held...
2129 if (job_state
->values
[0].integer
> IPP_JSTATE_STOPPED
|| job_state
->values
[0].integer
== IPP_JSTATE_HELD
)
2131 ippDelete(response
);
2135 else if (ipp_status
!= IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
&&
2136 ipp_status
!= IPP_STATUS_ERROR_NOT_POSSIBLE
&&
2137 ipp_status
!= IPP_STATUS_ERROR_BUSY
)
2140 * If the printer does not return a job-state attribute, it does not
2141 * conform to the IPP specification - break out immediately and fail
2145 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2146 "cups-ipp-missing-job-state");
2147 ipp_status
= IPP_STATUS_ERROR_INTERNAL
;
2152 ippDelete(response
);
2155 * Wait before polling again...
2158 sleep((unsigned)delay
);
2160 delay
= _cupsNextDelay(delay
, &prev_delay
);
2165 * Cancel the job as needed...
2168 if (job_canceled
> 0 && job_id
> 0)
2170 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
2172 if (cupsLastError() > IPP_STATUS_OK_CONFLICTING
)
2173 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2177 * Check the printer state and report it if necessary...
2180 check_printer_state(http
, uri
, resource
, argv
[2], version
);
2182 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING
)
2186 * Collect the final page count as needed...
2189 if (have_supplies
&&
2190 !backendSNMPSupplies(snmp_fd
, &(http
->addrlist
->addr
), &page_count
,
2192 page_count
> start_count
)
2193 fprintf(stderr
, "PAGE: total %d\n", page_count
- start_count
);
2197 * See if we used Kerberos at all...
2201 auth_info_required
= "negotiate";
2202 #endif /* HAVE_GSSAPI */
2210 cupsFreeOptions(num_options
, options
);
2211 _ppdCacheDestroy(pc
);
2216 ippDelete(supported
);
2219 * Remove the temporary file(s) if necessary...
2223 unlink(tmpfilename
);
2226 * Return the queue status...
2229 if (ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
|| ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
2230 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
||
2231 ipp_status
<= IPP_STATUS_OK_CONFLICTING
)
2232 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
2234 if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
)
2235 fputs("JOBSTATE: account-info-needed\n", stderr
);
2236 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
)
2237 fputs("JOBSTATE: account-closed\n", stderr
);
2238 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
)
2239 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2240 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2241 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2244 return (CUPS_BACKEND_OK
);
2245 else if (ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
|| ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
|| ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
2246 return (CUPS_BACKEND_AUTH_REQUIRED
);
2247 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
2248 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
2249 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
2250 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2251 return (CUPS_BACKEND_HOLD
);
2252 else if (ipp_status
== IPP_STATUS_ERROR_INTERNAL
)
2253 return (CUPS_BACKEND_STOP
);
2254 else if (ipp_status
== IPP_STATUS_ERROR_CONFLICTING
|| ipp_status
== IPP_STATUS_ERROR_REQUEST_ENTITY
|| ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
)
2255 return (CUPS_BACKEND_FAILED
);
2256 else if (ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
||
2257 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
2258 ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
|| job_canceled
< 0)
2260 if (ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
)
2261 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job too large."));
2262 else if (ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
)
2263 _cupsLangPrintFilter(stderr
, "ERROR",
2264 _("Printer cannot print supplied content."));
2265 else if (ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
)
2266 _cupsLangPrintFilter(stderr
, "ERROR",
2267 _("Printer cannot print with supplied options."));
2269 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job canceled at printer."));
2271 return (CUPS_BACKEND_CANCEL
);
2273 else if (ipp_status
> IPP_STATUS_OK_CONFLICTING
&& ipp_status
!= IPP_STATUS_ERROR_JOB_CANCELED
)
2274 return (CUPS_BACKEND_RETRY_CURRENT
);
2276 return (CUPS_BACKEND_OK
);
2281 * 'cancel_job()' - Cancel a print job.
2285 cancel_job(http_t
*http
, /* I - HTTP connection */
2286 const char *uri
, /* I - printer-uri */
2287 int id
, /* I - job-id */
2288 const char *resource
, /* I - Resource path */
2289 const char *user
, /* I - requesting-user-name */
2290 int version
) /* I - IPP version */
2292 ipp_t
*request
; /* Cancel-Job request */
2295 _cupsLangPrintFilter(stderr
, "INFO", _("Canceling print job."));
2297 request
= ippNewRequest(IPP_OP_CANCEL_JOB
);
2298 ippSetVersion(request
, version
/ 10, version
% 10);
2300 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2302 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
2304 if (user
&& user
[0])
2305 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2306 "requesting-user-name", NULL
, user
);
2312 ippDelete(cupsDoRequest(http
, request
, resource
));
2317 * 'check_printer_state()' - Check the printer state.
2320 static ipp_pstate_t
/* O - Current printer-state */
2321 check_printer_state(
2322 http_t
*http
, /* I - HTTP connection */
2323 const char *uri
, /* I - Printer URI */
2324 const char *resource
, /* I - Resource path */
2325 const char *user
, /* I - Username, if any */
2326 int version
) /* I - IPP version */
2328 ipp_t
*request
, /* IPP request */
2329 *response
; /* IPP response */
2330 ipp_attribute_t
*attr
; /* Attribute in response */
2331 ipp_pstate_t printer_state
= IPP_PSTATE_STOPPED
;
2332 /* Current printer-state */
2336 * Send a Get-Printer-Attributes request and log the results...
2339 request
= ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES
);
2340 ippSetVersion(request
, version
/ 10, version
% 10);
2342 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2345 if (user
&& user
[0])
2346 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2347 "requesting-user-name", NULL
, user
);
2349 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2350 "requested-attributes",
2351 (int)(sizeof(pattrs
) / sizeof(pattrs
[0])), NULL
, pattrs
);
2353 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2354 debug_attributes(request
);
2356 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
2358 report_printer_state(response
);
2360 if ((attr
= ippFindAttribute(response
, "printer-state",
2361 IPP_TAG_ENUM
)) != NULL
)
2362 printer_state
= (ipp_pstate_t
)attr
->values
[0].integer
;
2365 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
2366 ippErrorString(cupsLastError()), cupsLastErrorString());
2367 debug_attributes(response
);
2368 ippDelete(response
);
2371 * Return the printer-state value...
2374 return (printer_state
);
2379 * 'debug_attributes()' - Print out the request or response attributes as DEBUG
2384 debug_attributes(ipp_t
*ipp
) /* I - Request or response message */
2386 ipp_tag_t group
; /* Current group */
2387 ipp_attribute_t
*attr
; /* Current attribute */
2388 char buffer
[1024]; /* Value buffer */
2391 for (group
= IPP_TAG_ZERO
, attr
= ippFirstAttribute(ipp
);
2393 attr
= ippNextAttribute(ipp
))
2395 const char *name
= ippGetName(attr
);
2399 group
= IPP_TAG_ZERO
;
2403 if (group
!= ippGetGroupTag(attr
))
2405 group
= ippGetGroupTag(attr
);
2406 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(group
));
2409 if (!strcmp(name
, "job-password"))
2410 strlcpy(buffer
, "---", sizeof(buffer
));
2412 ippAttributeString(attr
, buffer
, sizeof(buffer
));
2414 fprintf(stderr
, "DEBUG: %s %s%s %s\n", name
,
2415 ippGetCount(attr
) > 1 ? "1setOf " : "",
2416 ippTagString(ippGetValueTag(attr
)), buffer
);
2419 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(IPP_TAG_END
));
2424 * 'monitor_printer()' - Monitor the printer state.
2427 static void * /* O - Thread exit code */
2429 _cups_monitor_t
*monitor
) /* I - Monitoring data */
2431 http_t
*http
; /* Connection to printer */
2432 ipp_t
*request
, /* IPP request */
2433 *response
; /* IPP response */
2434 ipp_attribute_t
*attr
; /* Attribute in response */
2435 int delay
, /* Current delay */
2436 prev_delay
; /* Previous delay */
2437 ipp_op_t job_op
; /* Operation to use */
2438 int job_id
; /* Job ID */
2439 const char *job_name
; /* Job name */
2440 ipp_jstate_t job_state
; /* Job state */
2441 const char *job_user
; /* Job originating user name */
2442 int password_tries
= 0; /* Password tries */
2446 * Make a copy of the printer connection...
2449 http
= httpConnect2(monitor
->hostname
, monitor
->port
, NULL
, AF_UNSPEC
,
2450 monitor
->encryption
, 1, 0, NULL
);
2451 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
2453 cupsSetUser(username
);
2455 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
2458 * Loop until the job is canceled, aborted, or completed.
2461 delay
= _cupsNextDelay(0, &prev_delay
);
2463 monitor
->job_reasons
= 0;
2465 while (monitor
->job_state
< IPP_JSTATE_CANCELED
&& !job_canceled
)
2468 * Reconnect to the printer as needed...
2471 if (httpGetFd(http
) < 0)
2472 httpReconnect2(http
, 30000, NULL
);
2474 if (httpGetFd(http
) >= 0)
2477 * Connected, so check on the printer state...
2480 monitor
->printer_state
= check_printer_state(http
, monitor
->uri
,
2484 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING
)
2487 if (monitor
->job_id
== 0 && monitor
->create_job
)
2490 * No job-id yet, so continue...
2497 * Check the status of the job itself...
2500 job_op
= (monitor
->job_id
> 0 && monitor
->get_job_attrs
) ?
2501 IPP_OP_GET_JOB_ATTRIBUTES
: IPP_OP_GET_JOBS
;
2502 request
= ippNewRequest(job_op
);
2503 ippSetVersion(request
, monitor
->version
/ 10, monitor
->version
% 10);
2505 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2506 NULL
, monitor
->uri
);
2507 if (job_op
== IPP_OP_GET_JOB_ATTRIBUTES
)
2508 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2511 if (monitor
->user
&& monitor
->user
[0])
2512 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2513 "requesting-user-name", NULL
, monitor
->user
);
2515 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2516 "requested-attributes",
2517 (int)(sizeof(jattrs
) / sizeof(jattrs
[0])), NULL
, jattrs
);
2523 response
= cupsDoRequest(http
, request
, monitor
->resource
);
2525 fprintf(stderr
, "DEBUG: (monitor) %s: %s (%s)\n", ippOpString(job_op
),
2526 ippErrorString(cupsLastError()), cupsLastErrorString());
2528 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING
)
2531 if (job_op
== IPP_OP_GET_JOB_ATTRIBUTES
)
2533 if ((attr
= ippFindAttribute(response
, "job-state",
2534 IPP_TAG_ENUM
)) != NULL
)
2535 monitor
->job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2537 monitor
->job_state
= IPP_JSTATE_COMPLETED
;
2541 for (attr
= response
->attrs
; attr
; attr
= attr
->next
)
2545 job_state
= IPP_JSTATE_PENDING
;
2548 while (attr
&& attr
->group_tag
!= IPP_TAG_JOB
)
2554 while (attr
&& attr
->group_tag
== IPP_TAG_JOB
)
2556 if (!strcmp(attr
->name
, "job-id") &&
2557 attr
->value_tag
== IPP_TAG_INTEGER
)
2558 job_id
= attr
->values
[0].integer
;
2559 else if (!strcmp(attr
->name
, "job-name") &&
2560 (attr
->value_tag
== IPP_TAG_NAME
||
2561 attr
->value_tag
== IPP_TAG_NAMELANG
))
2562 job_name
= attr
->values
[0].string
.text
;
2563 else if (!strcmp(attr
->name
, "job-state") &&
2564 attr
->value_tag
== IPP_TAG_ENUM
)
2565 job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2566 else if (!strcmp(attr
->name
, "job-originating-user-name") &&
2567 (attr
->value_tag
== IPP_TAG_NAME
||
2568 attr
->value_tag
== IPP_TAG_NAMELANG
))
2569 job_user
= attr
->values
[0].string
.text
;
2574 if (job_id
> 0 && job_name
&& !strcmp(job_name
, monitor
->job_name
) &&
2575 job_user
&& monitor
->user
&& !strcmp(job_user
, monitor
->user
))
2577 monitor
->job_id
= job_id
;
2578 monitor
->job_state
= job_state
;
2587 fprintf(stderr
, "DEBUG: (monitor) job-state = %s\n", ippEnumString("job-state", (int)monitor
->job_state
));
2589 if (!job_canceled
&&
2590 (monitor
->job_state
== IPP_JSTATE_CANCELED
||
2591 monitor
->job_state
== IPP_JSTATE_ABORTED
))
2594 fprintf(stderr
, "DEBUG: (monitor) job_canceled = -1\n");
2597 if ((attr
= ippFindAttribute(response
, "job-state-reasons",
2598 IPP_TAG_KEYWORD
)) != NULL
)
2600 int i
, new_reasons
= 0; /* Looping var, new reasons */
2602 for (i
= 0; i
< attr
->num_values
; i
++)
2604 if (!strcmp(attr
->values
[i
].string
.text
, "account-authorization-failed"))
2605 new_reasons
|= _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
;
2606 else if (!strcmp(attr
->values
[i
].string
.text
, "account-closed"))
2607 new_reasons
|= _CUPS_JSR_ACCOUNT_CLOSED
;
2608 else if (!strcmp(attr
->values
[i
].string
.text
, "account-info-needed"))
2609 new_reasons
|= _CUPS_JSR_ACCOUNT_INFO_NEEDED
;
2610 else if (!strcmp(attr
->values
[i
].string
.text
, "account-limit-reached"))
2611 new_reasons
|= _CUPS_JSR_ACCOUNT_LIMIT_REACHED
;
2612 else if (!strcmp(attr
->values
[i
].string
.text
, "job-password-wait"))
2613 new_reasons
|= _CUPS_JSR_JOB_PASSWORD_WAIT
;
2614 else if (!strcmp(attr
->values
[i
].string
.text
, "job-release-wait"))
2615 new_reasons
|= _CUPS_JSR_JOB_RELEASE_WAIT
;
2616 else if (!strcmp(attr
->values
[i
].string
.text
, "document-format-error"))
2617 new_reasons
|= _CUPS_JSR_DOCUMENT_FORMAT_ERROR
;
2618 else if (!strcmp(attr
->values
[i
].string
.text
, "document-unprintable"))
2619 new_reasons
|= _CUPS_JSR_DOCUMENT_UNPRINTABLE
;
2621 if (!job_canceled
&& (!strncmp(attr
->values
[i
].string
.text
, "job-canceled-", 13) || !strcmp(attr
->values
[i
].string
.text
, "aborted-by-system")))
2625 if (new_reasons
!= monitor
->job_reasons
)
2627 if (new_reasons
& _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
)
2628 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2629 else if (new_reasons
& _CUPS_JSR_ACCOUNT_CLOSED
)
2630 fputs("JOBSTATE: account-closed\n", stderr
);
2631 else if (new_reasons
& _CUPS_JSR_ACCOUNT_INFO_NEEDED
)
2632 fputs("JOBSTATE: account-info-needed\n", stderr
);
2633 else if (new_reasons
& _CUPS_JSR_ACCOUNT_LIMIT_REACHED
)
2634 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2635 else if (new_reasons
& _CUPS_JSR_JOB_PASSWORD_WAIT
)
2636 fputs("JOBSTATE: job-password-wait\n", stderr
);
2637 else if (new_reasons
& _CUPS_JSR_JOB_RELEASE_WAIT
)
2638 fputs("JOBSTATE: job-release-wait\n", stderr
);
2639 else if (new_reasons
& (_CUPS_JSR_DOCUMENT_FORMAT_ERROR
| _CUPS_JSR_DOCUMENT_UNPRINTABLE
))
2641 if (monitor
->retryable
)
2644 * Can't print this, so retry as raster...
2648 fputs("JOBSTATE: cups-retry-as-raster\n", stderr
);
2650 else if (new_reasons
& _CUPS_JSR_DOCUMENT_FORMAT_ERROR
)
2652 fputs("JOBSTATE: document-format-error\n", stderr
);
2656 fputs("JOBSTATE: document-unprintable\n", stderr
);
2660 fputs("JOBSTATE: job-printing\n", stderr
);
2662 monitor
->job_reasons
= new_reasons
;
2666 ippDelete(response
);
2668 fprintf(stderr
, "DEBUG: (monitor) job-state = %s\n", ippEnumString("job-state", (int)monitor
->job_state
));
2670 if (!job_canceled
&&
2671 (monitor
->job_state
== IPP_JSTATE_CANCELED
||
2672 monitor
->job_state
== IPP_JSTATE_ABORTED
))
2677 * Sleep for N seconds...
2682 sleep((unsigned)delay
);
2684 delay
= _cupsNextDelay(delay
, &prev_delay
);
2688 * Cancel the job if necessary...
2691 if (job_canceled
> 0 && monitor
->job_id
> 0)
2693 if (httpGetFd(http
) < 0)
2694 httpReconnect2(http
, 30000, NULL
);
2696 if (httpGetFd(http
) >= 0)
2698 cancel_job(http
, monitor
->uri
, monitor
->job_id
, monitor
->resource
,
2699 monitor
->user
, monitor
->version
);
2701 if (cupsLastError() > IPP_STATUS_OK_CONFLICTING
)
2703 fprintf(stderr
, "DEBUG: (monitor) cancel_job() = %s\n", cupsLastErrorString());
2704 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2710 * Cleanup and return...
2720 * 'new_request()' - Create a new print creation or validation request.
2723 static ipp_t
* /* O - Request data */
2725 ipp_op_t op
, /* I - IPP operation code */
2726 int version
, /* I - IPP version number */
2727 const char *uri
, /* I - printer-uri value */
2728 const char *user
, /* I - requesting-user-name value */
2729 const char *title
, /* I - job-name value */
2730 int num_options
, /* I - Number of options to send */
2731 cups_option_t
*options
, /* I - Options to send */
2732 const char *compression
, /* I - compression value or NULL */
2733 int copies
, /* I - copies value or 0 */
2734 const char *format
, /* I - document-format value or NULL */
2735 _ppd_cache_t
*pc
, /* I - PPD cache and mapping data */
2736 ppd_file_t
*ppd
, /* I - PPD file data */
2737 ipp_attribute_t
*media_col_sup
, /* I - media-col-supported values */
2738 ipp_attribute_t
*doc_handling_sup
, /* I - multiple-document-handling-supported values */
2739 ipp_attribute_t
*print_color_mode_sup
)
2740 /* I - Printer supports print-color-mode */
2742 ipp_t
*request
; /* Request data */
2743 const char *keyword
; /* PWG keyword */
2747 * Create the IPP request...
2750 request
= ippNewRequest(op
);
2751 ippSetVersion(request
, version
/ 10, version
% 10);
2753 fprintf(stderr
, "DEBUG: %s IPP/%d.%d\n",
2754 ippOpString(request
->request
.op
.operation_id
),
2755 request
->request
.op
.version
[0],
2756 request
->request
.op
.version
[1]);
2759 * Add standard attributes...
2762 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
2763 fprintf(stderr
, "DEBUG: printer-uri=\"%s\"\n", uri
);
2767 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "requesting-user-name", NULL
, user
);
2768 fprintf(stderr
, "DEBUG: requesting-user-name=\"%s\"\n", user
);
2771 if (title
&& *title
)
2773 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
, title
);
2774 fprintf(stderr
, "DEBUG: job-name=\"%s\"\n", title
);
2777 if (format
&& op
!= IPP_OP_CREATE_JOB
)
2779 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, format
);
2780 fprintf(stderr
, "DEBUG: document-format=\"%s\"\n", format
);
2784 if (compression
&& op
!= IPP_OP_CREATE_JOB
&& op
!= IPP_OP_VALIDATE_JOB
)
2786 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "compression", NULL
, compression
);
2787 fprintf(stderr
, "DEBUG: compression=\"%s\"\n", compression
);
2789 #endif /* HAVE_LIBZ */
2792 * Handle options on the command-line...
2795 if (num_options
> 0)
2800 * Send standard IPP attributes...
2803 fputs("DEBUG: Adding standard IPP operation/job attributes.\n", stderr
);
2805 copies
= _cupsConvertOptions(request
, ppd
, pc
, media_col_sup
, doc_handling_sup
, print_color_mode_sup
, user
, format
, copies
, num_options
, options
);
2808 * Map FaxOut options...
2811 if ((keyword
= cupsGetOption("phone", num_options
, options
)) != NULL
)
2813 ipp_t
*destination
; /* destination collection */
2814 char phone
[1024], /* Phone number string */
2815 *ptr
, /* Pointer into string */
2816 tel_uri
[1024]; /* tel: URI */
2817 static const char * const allowed
= "0123456789#*-+.()pw";
2818 /* Allowed characters */
2820 destination
= ippNew();
2823 * Unescape and filter out spaces and other characters that are not
2824 * allowed in a tel: URI.
2827 _httpDecodeURI(phone
, keyword
, sizeof(phone
));
2828 for (ptr
= phone
; *ptr
;)
2832 else if (!strchr(allowed
, *ptr
))
2833 _cups_strcpy(ptr
, ptr
+ 1);
2838 httpAssembleURI(HTTP_URI_CODING_ALL
, tel_uri
, sizeof(tel_uri
), "tel", NULL
, NULL
, 0, phone
);
2839 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_URI
, "destination-uri", NULL
, tel_uri
);
2841 if ((keyword
= cupsGetOption("faxPrefix", num_options
,
2842 options
)) != NULL
&& *keyword
)
2844 char predial
[1024]; /* Pre-dial string */
2846 _httpDecodeURI(predial
, keyword
, sizeof(predial
));
2847 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_TEXT
, "pre-dial-string", NULL
, predial
);
2850 ippAddCollection(request
, IPP_TAG_JOB
, "destination-uris", destination
);
2851 ippDelete(destination
);
2857 * When talking to another CUPS server, send all options...
2860 fputs("DEBUG: Adding all operation/job attributes.\n", stderr
);
2861 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_OPERATION
);
2862 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_JOB
);
2865 if (copies
> 1 && (!pc
|| copies
<= pc
->max_copies
))
2866 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies", copies
);
2869 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2870 debug_attributes(request
);
2877 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
2880 static const char * /* O - Password */
2881 password_cb(const char *prompt
, /* I - Prompt (not used) */
2882 http_t
*http
, /* I - Connection */
2883 const char *method
, /* I - Request method (not used) */
2884 const char *resource
, /* I - Resource path (not used) */
2885 int *password_tries
) /* I - Password tries */
2887 char def_username
[HTTP_MAX_VALUE
]; /* Default username */
2890 fprintf(stderr
, "DEBUG: password_cb(prompt=\"%s\", http=%p, method=\"%s\", "
2891 "resource=\"%s\", password_tries=%p(%d)), password=%p\n",
2892 prompt
, http
, method
, resource
, password_tries
, *password_tries
,
2899 if (!uri_credentials
)
2902 * Remember that we need to authenticate...
2905 auth_info_required
= "username,password";
2907 if (httpGetSubField(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "username",
2910 char quoted
[HTTP_MAX_VALUE
* 2 + 4];
2913 fprintf(stderr
, "ATTR: auth-info-default=%s,\n",
2914 quote_string(def_username
, quoted
, sizeof(quoted
)));
2918 if (password
&& *password
&& *password_tries
< 3)
2920 (*password_tries
) ++;
2922 cupsSetUser(username
);
2929 * Give up after 3 tries or if we don't have a password to begin with...
2938 * 'quote_string()' - Quote a string value.
2941 static const char * /* O - Quoted string */
2942 quote_string(const char *s
, /* I - String */
2943 char *q
, /* I - Quoted string buffer */
2944 size_t qsize
) /* I - Size of quoted string buffer */
2946 char *qptr
, /* Pointer into string buffer */
2947 *qend
; /* End of string buffer */
2951 qend
= q
+ qsize
- 5;
2962 while (*s
&& qptr
< qend
)
2964 if (*s
== '\\' || *s
== '\"' || *s
== '\'')
2966 if (qptr
< (qend
- 4))
2988 * 'report_attr()' - Report an IPP attribute value.
2992 report_attr(ipp_attribute_t
*attr
) /* I - Attribute */
2994 int i
; /* Looping var */
2995 char value
[1024], /* Value string */
2996 *valptr
; /* Pointer into value string */
2997 const char *cached
; /* Cached attribute */
3001 * Convert the attribute values into quoted strings...
3004 for (i
= 0, valptr
= value
;
3005 i
< attr
->num_values
&& valptr
< (value
+ sizeof(value
) - 10);
3011 switch (attr
->value_tag
)
3013 case IPP_TAG_INTEGER
:
3015 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), "%d", attr
->values
[i
].integer
);
3016 valptr
+= strlen(valptr
);
3021 case IPP_TAG_KEYWORD
:
3022 quote_string(attr
->values
[i
].string
.text
, valptr
, (size_t)(value
+ sizeof(value
) - valptr
));
3023 valptr
+= strlen(valptr
);
3028 * Unsupported value type...
3037 _cupsMutexLock(&report_mutex
);
3039 if ((cached
= cupsGetOption(attr
->name
, num_attr_cache
,
3040 attr_cache
)) == NULL
|| strcmp(cached
, value
))
3043 * Tell the scheduler about the new values...
3046 num_attr_cache
= cupsAddOption(attr
->name
, value
, num_attr_cache
,
3048 fprintf(stderr
, "ATTR: %s=%s\n", attr
->name
, value
);
3051 _cupsMutexUnlock(&report_mutex
);
3056 * 'report_printer_state()' - Report the printer state.
3060 report_printer_state(ipp_t
*ipp
) /* I - IPP response */
3062 ipp_attribute_t
*pa
, /* printer-alert */
3063 *pam
, /* printer-alert-message */
3064 *pmja
, /* printer-mandatory-job-attributes */
3065 *psm
, /* printer-state-message */
3066 *reasons
, /* printer-state-reasons */
3067 *marker
; /* marker-* attributes */
3068 char value
[1024], /* State/message string */
3069 *valptr
; /* Pointer into string */
3070 static int ipp_supplies
= -1;
3071 /* Report supply levels? */
3075 * Report alerts and messages...
3078 if ((pa
= ippFindAttribute(ipp
, "printer-alert", IPP_TAG_TEXT
)) != NULL
)
3081 if ((pam
= ippFindAttribute(ipp
, "printer-alert-message",
3082 IPP_TAG_TEXT
)) != NULL
)
3085 if ((pmja
= ippFindAttribute(ipp
, "printer-mandatory-job-attributes", IPP_TAG_KEYWORD
)) != NULL
)
3087 int i
, /* Looping var */
3088 count
= ippGetCount(pmja
); /* Number of values */
3090 for (i
= 0, valptr
= value
; i
< count
; i
++, valptr
+= strlen(valptr
))
3093 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), " %s", ippGetString(pmja
, i
, NULL
));
3095 strlcpy(value
, ippGetString(pmja
, i
, NULL
), sizeof(value
));
3098 if (strcmp(value
, mandatory_attrs
))
3100 strlcpy(mandatory_attrs
, value
, sizeof(mandatory_attrs
));
3101 fprintf(stderr
, "PPD: cupsMandatory=\"%s\"\n", value
);
3105 if ((psm
= ippFindAttribute(ipp
, "printer-state-message",
3106 IPP_TAG_TEXT
)) != NULL
)
3108 char *ptr
; /* Pointer into message */
3111 strlcpy(value
, "INFO: ", sizeof(value
));
3112 for (ptr
= psm
->values
[0].string
.text
, valptr
= value
+ 6;
3113 *ptr
&& valptr
< (value
+ sizeof(value
) - 6);
3116 if (*ptr
< ' ' && *ptr
> 0 && *ptr
!= '\t')
3119 * Substitute "<XX>" for the control character; sprintf is safe because
3120 * we always leave 6 chars free at the end...
3123 sprintf(valptr
, "<%02X>", *ptr
);
3133 fputs(value
, stderr
);
3137 * Now report printer-state-reasons, filtering out some of the reasons we never
3141 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
3142 IPP_TAG_KEYWORD
)) == NULL
)
3145 update_reasons(reasons
, NULL
);
3148 * Relay the current marker-* attribute values...
3151 if (ipp_supplies
< 0)
3153 ppd_file_t
*ppd
; /* PPD file */
3154 ppd_attr_t
*ppdattr
; /* Attribute in PPD file */
3156 if ((ppd
= ppdOpenFile(getenv("PPD"))) != NULL
&&
3157 (ppdattr
= ppdFindAttr(ppd
, "cupsIPPSupplies", NULL
)) != NULL
&&
3158 ppdattr
->value
&& _cups_strcasecmp(ppdattr
->value
, "true"))
3166 if (ipp_supplies
> 0)
3168 if ((marker
= ippFindAttribute(ipp
, "marker-colors", IPP_TAG_NAME
)) != NULL
)
3169 report_attr(marker
);
3170 if ((marker
= ippFindAttribute(ipp
, "marker-high-levels",
3171 IPP_TAG_INTEGER
)) != NULL
)
3172 report_attr(marker
);
3173 if ((marker
= ippFindAttribute(ipp
, "marker-levels",
3174 IPP_TAG_INTEGER
)) != NULL
)
3175 report_attr(marker
);
3176 if ((marker
= ippFindAttribute(ipp
, "marker-low-levels",
3177 IPP_TAG_INTEGER
)) != NULL
)
3178 report_attr(marker
);
3179 if ((marker
= ippFindAttribute(ipp
, "marker-message",
3180 IPP_TAG_TEXT
)) != NULL
)
3181 report_attr(marker
);
3182 if ((marker
= ippFindAttribute(ipp
, "marker-names", IPP_TAG_NAME
)) != NULL
)
3183 report_attr(marker
);
3184 if ((marker
= ippFindAttribute(ipp
, "marker-types",
3185 IPP_TAG_KEYWORD
)) != NULL
)
3186 report_attr(marker
);
3191 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3193 * 'run_as_user()' - Run the IPP backend as the printing user.
3195 * This function uses an XPC-based user agent to run the backend as the printing
3196 * user. We need to do this in order to have access to the user's Kerberos
3200 static int /* O - Exit status */
3201 run_as_user(char *argv
[], /* I - Command-line arguments */
3202 uid_t uid
, /* I - User ID */
3203 const char *device_uri
, /* I - Device URI */
3204 int fd
) /* I - File to print */
3206 const char *auth_negotiate
;/* AUTH_NEGOTIATE env var */
3207 xpc_connection_t conn
; /* Connection to XPC service */
3208 xpc_object_t request
; /* Request message dictionary */
3209 __block xpc_object_t response
; /* Response message dictionary */
3210 dispatch_semaphore_t sem
; /* Semaphore for waiting for response */
3211 int status
= CUPS_BACKEND_FAILED
;
3212 /* Status of request */
3215 fprintf(stderr
, "DEBUG: Running IPP backend as UID %d.\n", (int)uid
);
3218 * Connect to the user agent for the specified UID...
3221 conn
= xpc_connection_create_mach_service(kPMPrintUIToolAgent
,
3222 dispatch_get_global_queue(0, 0), 0);
3225 _cupsLangPrintFilter(stderr
, "ERROR",
3226 _("Unable to start backend process."));
3227 fputs("DEBUG: Unable to create connection to agent.\n", stderr
);
3231 xpc_connection_set_event_handler(conn
,
3232 ^(xpc_object_t event
)
3234 xpc_type_t messageType
= xpc_get_type(event
);
3236 if (messageType
== XPC_TYPE_ERROR
)
3238 if (event
== XPC_ERROR_CONNECTION_INTERRUPTED
)
3239 fprintf(stderr
, "DEBUG: Interrupted connection to service %s.\n",
3240 xpc_connection_get_name(conn
));
3241 else if (event
== XPC_ERROR_CONNECTION_INVALID
)
3242 fprintf(stderr
, "DEBUG: Connection invalid for service %s.\n",
3243 xpc_connection_get_name(conn
));
3245 fprintf(stderr
, "DEBUG: Unxpected error for service %s: %s\n",
3246 xpc_connection_get_name(conn
),
3247 xpc_dictionary_get_string(event
, XPC_ERROR_KEY_DESCRIPTION
));
3250 xpc_connection_set_target_uid(conn
, uid
);
3251 xpc_connection_resume(conn
);
3254 * Try starting the backend...
3257 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3258 xpc_dictionary_set_int64(request
, "command", kPMStartJob
);
3259 xpc_dictionary_set_string(request
, "device-uri", device_uri
);
3260 xpc_dictionary_set_string(request
, "job-id", argv
[1]);
3261 xpc_dictionary_set_string(request
, "user", argv
[2]);
3262 xpc_dictionary_set_string(request
, "title", argv
[3]);
3263 xpc_dictionary_set_string(request
, "copies", argv
[4]);
3264 xpc_dictionary_set_string(request
, "options", argv
[5]);
3265 xpc_dictionary_set_string(request
, "auth-info-required",
3266 getenv("AUTH_INFO_REQUIRED"));
3267 if ((auth_negotiate
= getenv("AUTH_NEGOTIATE")) != NULL
)
3268 xpc_dictionary_set_string(request
, "auth-negotiate", auth_negotiate
);
3269 xpc_dictionary_set_fd(request
, "stdin", fd
);
3270 xpc_dictionary_set_fd(request
, "stderr", 2);
3271 xpc_dictionary_set_fd(request
, "side-channel", CUPS_SC_FD
);
3273 sem
= dispatch_semaphore_create(0);
3276 xpc_connection_send_message_with_reply(conn
, request
,
3277 dispatch_get_global_queue(0,0),
3278 ^(xpc_object_t reply
)
3280 /* Save the response and wake up */
3281 if (xpc_get_type(reply
)
3282 == XPC_TYPE_DICTIONARY
)
3283 response
= xpc_retain(reply
);
3285 dispatch_semaphore_signal(sem
);
3288 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3289 xpc_release(request
);
3290 dispatch_release(sem
);
3294 child_pid
= (pid_t
)xpc_dictionary_get_int64(response
, "child-pid");
3296 xpc_release(response
);
3299 fprintf(stderr
, "DEBUG: Child PID=%d.\n", (int)child_pid
);
3302 _cupsLangPrintFilter(stderr
, "ERROR",
3303 _("Unable to start backend process."));
3304 fputs("DEBUG: No child PID.\n", stderr
);
3310 _cupsLangPrintFilter(stderr
, "ERROR",
3311 _("Unable to start backend process."));
3312 fputs("DEBUG: No reply from agent.\n", stderr
);
3317 * Then wait for the backend to finish...
3320 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3321 xpc_dictionary_set_int64(request
, "command", kPMWaitForJob
);
3322 xpc_dictionary_set_fd(request
, "stderr", 2);
3324 sem
= dispatch_semaphore_create(0);
3327 xpc_connection_send_message_with_reply(conn
, request
,
3328 dispatch_get_global_queue(0,0),
3329 ^(xpc_object_t reply
)
3331 /* Save the response and wake up */
3332 if (xpc_get_type(reply
)
3333 == XPC_TYPE_DICTIONARY
)
3334 response
= xpc_retain(reply
);
3336 dispatch_semaphore_signal(sem
);
3339 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3340 xpc_release(request
);
3341 dispatch_release(sem
);
3345 status
= (int)xpc_dictionary_get_int64(response
, "status");
3347 if (status
== SIGTERM
|| status
== SIGKILL
|| status
== SIGPIPE
)
3349 fprintf(stderr
, "DEBUG: Child terminated on signal %d.\n", status
);
3350 status
= CUPS_BACKEND_FAILED
;
3352 else if (WIFSIGNALED(status
))
3354 fprintf(stderr
, "DEBUG: Child crashed on signal %d.\n", status
);
3355 status
= CUPS_BACKEND_STOP
;
3357 else if (WIFEXITED(status
))
3359 status
= WEXITSTATUS(status
);
3360 fprintf(stderr
, "DEBUG: Child exited with status %d.\n", status
);
3363 xpc_release(response
);
3366 _cupsLangPrintFilter(stderr
, "ERROR",
3367 _("Unable to get backend exit status."));
3373 xpc_connection_cancel(conn
);
3379 #endif /* HAVE_GSSAPI && HAVE_XPC */
3383 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
3387 sigterm_handler(int sig
) /* I - Signal */
3389 (void)sig
; /* remove compiler warnings... */
3391 write(2, "DEBUG: Got SIGTERM.\n", 20);
3393 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3396 kill(child_pid
, sig
);
3399 #endif /* HAVE_GSSAPI && HAVE_XPC */
3404 * Flag that the job should be canceled...
3407 write(2, "DEBUG: sigterm_handler: job_canceled = 1.\n", 25);
3414 * The scheduler already tried to cancel us once, now just terminate
3415 * after removing our temp file!
3419 unlink(tmpfilename
);
3426 * 'timeout_cb()' - Handle HTTP timeouts.
3429 static int /* O - 1 to continue, 0 to cancel */
3430 timeout_cb(http_t
*http
, /* I - Connection to server (unused) */
3431 void *user_data
) /* I - User data (unused) */
3436 return (!job_canceled
);
3441 * 'update_reasons()' - Update the printer-state-reasons values.
3445 update_reasons(ipp_attribute_t
*attr
, /* I - printer-state-reasons or NULL */
3446 const char *s
) /* I - STATE: string or NULL */
3448 char op
; /* Add (+), remove (-), replace (\0) */
3449 cups_array_t
*new_reasons
; /* New reasons array */
3450 char *reason
, /* Current reason */
3451 add
[2048], /* Reasons added string */
3452 *addptr
, /* Pointer into add string */
3453 rem
[2048], /* Reasons removed string */
3454 *remptr
; /* Pointer into remove string */
3455 const char *addprefix
, /* Current add string prefix */
3456 *remprefix
; /* Current remove string prefix */
3459 fprintf(stderr
, "DEBUG: update_reasons(attr=%d(%s%s), s=\"%s\")\n",
3460 attr
? attr
->num_values
: 0, attr
? attr
->values
[0].string
.text
: "",
3461 attr
&& attr
->num_values
> 1 ? ",..." : "", s
? s
: "(null)");
3464 * Create an array of new reason keyword strings...
3469 int i
; /* Looping var */
3471 new_reasons
= cupsArrayNew((cups_array_func_t
)strcmp
, NULL
);
3474 for (i
= 0; i
< attr
->num_values
; i
++)
3476 reason
= attr
->values
[i
].string
.text
;
3478 if (strcmp(reason
, "none") &&
3479 strcmp(reason
, "none-report") &&
3480 strcmp(reason
, "paused") &&
3481 strncmp(reason
, "spool-area-full", 15) &&
3482 strcmp(reason
, "com.apple.print.recoverable-warning") &&
3483 strncmp(reason
, "cups-", 5))
3484 cupsArrayAdd(new_reasons
, reason
);
3489 if (*s
== '+' || *s
== '-')
3494 new_reasons
= _cupsArrayNewStrings(s
, ',');
3500 * Compute the changes...
3504 addprefix
= "STATE: +";
3507 remprefix
= "STATE: -";
3510 fprintf(stderr
, "DEBUG2: op='%c', new_reasons=%d, state_reasons=%d\n",
3511 op
? op
: ' ', cupsArrayCount(new_reasons
),
3512 cupsArrayCount(state_reasons
));
3514 _cupsMutexLock(&report_mutex
);
3522 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3524 reason
= (char *)cupsArrayNext(new_reasons
))
3526 if (!cupsArrayFind(state_reasons
, reason
))
3528 if (!strncmp(reason
, "cups-remote-", 12))
3531 * If we are setting cups-remote-xxx, remove all other cups-remote-xxx
3535 char *temp
; /* Current reason in state_reasons */
3537 cupsArraySave(state_reasons
);
3539 for (temp
= (char *)cupsArrayFirst(state_reasons
);
3541 temp
= (char *)cupsArrayNext(state_reasons
))
3542 if (!strncmp(temp
, "cups-remote-", 12))
3544 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, temp
);
3545 remptr
+= strlen(remptr
);
3548 cupsArrayRemove(state_reasons
, temp
);
3552 cupsArrayRestore(state_reasons
);
3555 cupsArrayAdd(state_reasons
, reason
);
3557 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3558 addptr
+= strlen(addptr
);
3569 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3571 reason
= (char *)cupsArrayNext(new_reasons
))
3573 if (cupsArrayFind(state_reasons
, reason
))
3575 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3576 remptr
+= strlen(remptr
);
3579 cupsArrayRemove(state_reasons
, reason
);
3586 * Replace reasons...
3589 for (reason
= (char *)cupsArrayFirst(state_reasons
);
3591 reason
= (char *)cupsArrayNext(state_reasons
))
3593 if (strncmp(reason
, "cups-", 5) && !cupsArrayFind(new_reasons
, reason
))
3595 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3596 remptr
+= strlen(remptr
);
3599 cupsArrayRemove(state_reasons
, reason
);
3603 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3605 reason
= (char *)cupsArrayNext(new_reasons
))
3607 if (!cupsArrayFind(state_reasons
, reason
))
3609 cupsArrayAdd(state_reasons
, reason
);
3611 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3612 addptr
+= strlen(addptr
);
3618 cupsArrayDelete(new_reasons
);
3620 _cupsMutexUnlock(&report_mutex
);
3623 * Report changes and return...
3626 if (add
[0] && rem
[0])
3627 fprintf(stderr
, "%s\n%s\n", add
, rem
);
3629 fprintf(stderr
, "%s\n", add
);
3631 fprintf(stderr
, "%s\n", rem
);