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 time_t waittime
; /* Wait time for held jobs */
237 _cups_monitor_t monitor
; /* Monitoring data */
238 ipp_attribute_t
*job_id_attr
; /* job-id attribute */
239 int job_id
; /* job-id value */
240 ipp_attribute_t
*job_sheets
; /* job-media-sheets-completed */
241 ipp_attribute_t
*job_state
; /* job-state */
243 ipp_attribute_t
*compression_sup
; /* compression-supported */
244 #endif /* HAVE_LIBZ */
245 ipp_attribute_t
*copies_sup
; /* copies-supported */
246 ipp_attribute_t
*cups_version
; /* cups-version */
247 ipp_attribute_t
*encryption_sup
; /* job-password-encryption-supported */
248 ipp_attribute_t
*format_sup
; /* document-format-supported */
249 ipp_attribute_t
*job_auth
; /* job-authorization-uri */
250 ipp_attribute_t
*media_col_sup
; /* media-col-supported */
251 ipp_attribute_t
*operations_sup
; /* operations-supported */
252 ipp_attribute_t
*doc_handling_sup
; /* multiple-document-handling-supported */
253 ipp_attribute_t
*printer_state
; /* printer-state attribute */
254 ipp_attribute_t
*printer_accepting
; /* printer-is-accepting-jobs */
255 ipp_attribute_t
*print_color_mode_sup
;/* Does printer support print-color-mode? */
256 int create_job
= 0, /* Does printer support Create-Job? */
257 get_job_attrs
= 0, /* Does printer support Get-Job-Attributes? */
258 send_document
= 0, /* Does printer support Send-Document? */
259 validate_job
= 0, /* Does printer support Validate-Job? */
260 copies
, /* Number of copies for job */
261 copies_remaining
; /* Number of copies remaining */
262 const char *content_type
, /* CONTENT_TYPE environment variable */
263 *final_content_type
, /* FINAL_CONTENT_TYPE environment var */
264 *document_format
; /* document-format value */
265 int fd
; /* File descriptor */
266 off_t bytes
= 0; /* Bytes copied */
267 char buffer
[16384]; /* Copy buffer */
268 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
269 struct sigaction action
; /* Actions for POSIX signals */
270 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
271 int version
; /* IPP version */
272 ppd_file_t
*ppd
= NULL
; /* PPD file */
273 _ppd_cache_t
*pc
= NULL
; /* PPD cache and mapping data */
274 fd_set input
; /* Input set for select() */
278 * Make sure status messages are not buffered...
281 setbuf(stderr
, NULL
);
284 * Ignore SIGPIPE and catch SIGTERM signals...
288 sigset(SIGPIPE
, SIG_IGN
);
289 sigset(SIGTERM
, sigterm_handler
);
290 #elif defined(HAVE_SIGACTION)
291 memset(&action
, 0, sizeof(action
));
292 action
.sa_handler
= SIG_IGN
;
293 sigaction(SIGPIPE
, &action
, NULL
);
295 sigemptyset(&action
.sa_mask
);
296 sigaddset(&action
.sa_mask
, SIGTERM
);
297 action
.sa_handler
= sigterm_handler
;
298 sigaction(SIGTERM
, &action
, NULL
);
300 signal(SIGPIPE
, SIG_IGN
);
301 signal(SIGTERM
, sigterm_handler
);
302 #endif /* HAVE_SIGSET */
305 * Check command-line...
312 if ((s
= strrchr(argv
[0], '/')) != NULL
)
317 printf("network %s \"Unknown\" \"%s (%s)\"\n",
318 s
, _cupsLangString(cupsLangDefault(),
319 _("Internet Printing Protocol")), s
);
320 return (CUPS_BACKEND_OK
);
324 _cupsLangPrintf(stderr
,
325 _("Usage: %s job-id user title copies options [file]"),
327 return (CUPS_BACKEND_STOP
);
331 * Get the device URI...
334 while ((device_uri
= cupsBackendDeviceURI(argv
)) == NULL
)
336 _cupsLangPrintFilter(stderr
, "INFO", _("Unable to locate printer."));
339 if (getenv("CLASS") != NULL
)
340 return (CUPS_BACKEND_FAILED
);
343 if ((auth_info_required
= getenv("AUTH_INFO_REQUIRED")) == NULL
)
344 auth_info_required
= "none";
346 state_reasons
= _cupsArrayNewStrings(getenv("PRINTER_STATE_REASONS"), ',');
350 * For Kerberos, become the printing user (if we can) to get the credentials
354 if (!getuid() && (value
= getenv("AUTH_UID")) != NULL
)
356 uid_t uid
= (uid_t
)atoi(value
);
363 return (run_as_user(argv
, uid
, device_uri
, 0));
366 int status
= 0; /* Exit status */
368 for (i
= 6; i
< argc
&& !status
&& !job_canceled
; i
++)
370 if ((fd
= open(argv
[i
], O_RDONLY
)) >= 0)
372 status
= run_as_user(argv
, uid
, device_uri
, fd
);
377 _cupsLangPrintError("ERROR", _("Unable to open print file"));
378 status
= CUPS_BACKEND_FAILED
;
386 # else /* No XPC, just try to run as the user ID */
389 # endif /* HAVE_XPC */
391 #endif /* HAVE_GSSAPI */
394 * Get the (final) content type...
397 if ((content_type
= getenv("CONTENT_TYPE")) == NULL
)
398 content_type
= "application/octet-stream";
400 if ((final_content_type
= getenv("FINAL_CONTENT_TYPE")) == NULL
)
402 final_content_type
= content_type
;
404 if (!strncmp(final_content_type
, "printer/", 8))
405 final_content_type
= "application/vnd.cups-raw";
409 * Extract the hostname and printer name from the URI...
412 httpSeparateURI(HTTP_URI_CODING_ALL
, device_uri
, scheme
, sizeof(scheme
),
413 username
, sizeof(username
), hostname
, sizeof(hostname
), &port
,
414 resource
, sizeof(resource
));
417 port
= IPP_PORT
; /* Default to port 631 */
419 if (!strcmp(scheme
, "https") || !strcmp(scheme
, "ipps"))
420 cupsSetEncryption(HTTP_ENCRYPTION_ALWAYS
);
422 cupsSetEncryption(HTTP_ENCRYPTION_IF_REQUESTED
);
425 * See if there are any options...
432 contimeout
= 7 * 24 * 60 * 60;
434 if ((optptr
= strchr(resource
, '?')) != NULL
)
437 * Yup, terminate the device name string and move to the first
438 * character of the optptr...
444 * Then parse the optptr...
455 while (*optptr
&& *optptr
!= '=' && *optptr
!= '+' && *optptr
!= '&')
458 if ((sep
= *optptr
) != '\0')
469 while (*optptr
&& *optptr
!= '+' && *optptr
!= '&')
479 * Process the option...
482 if (!_cups_strcasecmp(name
, "waitjob"))
485 * Wait for job completion?
488 waitjob
= !_cups_strcasecmp(value
, "on") ||
489 !_cups_strcasecmp(value
, "yes") ||
490 !_cups_strcasecmp(value
, "true");
492 else if (!_cups_strcasecmp(name
, "waitprinter"))
495 * Wait for printer idle?
498 waitprinter
= !_cups_strcasecmp(value
, "on") ||
499 !_cups_strcasecmp(value
, "yes") ||
500 !_cups_strcasecmp(value
, "true");
502 else if (!_cups_strcasecmp(name
, "encryption"))
505 * Enable/disable encryption?
508 if (!_cups_strcasecmp(value
, "always"))
509 cupsSetEncryption(HTTP_ENCRYPTION_ALWAYS
);
510 else if (!_cups_strcasecmp(value
, "required"))
511 cupsSetEncryption(HTTP_ENCRYPTION_REQUIRED
);
512 else if (!_cups_strcasecmp(value
, "never"))
513 cupsSetEncryption(HTTP_ENCRYPTION_NEVER
);
514 else if (!_cups_strcasecmp(value
, "ifrequested"))
515 cupsSetEncryption(HTTP_ENCRYPTION_IF_REQUESTED
);
518 _cupsLangPrintFilter(stderr
, "ERROR",
519 _("Unknown encryption option value: \"%s\"."),
523 else if (!_cups_strcasecmp(name
, "snmp"))
526 * Enable/disable SNMP stuff...
529 snmp_enabled
= !value
[0] || !_cups_strcasecmp(value
, "on") ||
530 !_cups_strcasecmp(value
, "yes") ||
531 !_cups_strcasecmp(value
, "true");
533 else if (!_cups_strcasecmp(name
, "version"))
535 if (!strcmp(value
, "1.0"))
537 else if (!strcmp(value
, "1.1"))
539 else if (!strcmp(value
, "2.0"))
541 else if (!strcmp(value
, "2.1"))
543 else if (!strcmp(value
, "2.2"))
547 _cupsLangPrintFilter(stderr
, "ERROR",
548 _("Unknown version option value: \"%s\"."),
553 else if (!_cups_strcasecmp(name
, "compression"))
555 if (!_cups_strcasecmp(value
, "true") || !_cups_strcasecmp(value
, "yes") ||
556 !_cups_strcasecmp(value
, "on") || !_cups_strcasecmp(value
, "gzip"))
557 compression
= "gzip";
558 else if (!_cups_strcasecmp(value
, "deflate"))
559 compression
= "deflate";
560 else if (!_cups_strcasecmp(value
, "false") ||
561 !_cups_strcasecmp(value
, "no") ||
562 !_cups_strcasecmp(value
, "off") ||
563 !_cups_strcasecmp(value
, "none"))
564 compression
= "none";
566 #endif /* HAVE_LIBZ */
567 else if (!_cups_strcasecmp(name
, "contimeout"))
570 * Set the connection timeout...
574 contimeout
= atoi(value
);
582 _cupsLangPrintFilter(stderr
, "ERROR",
583 _("Unknown option \"%s\" with value \"%s\"."),
590 * If we have 7 arguments, print the file named on the command-line.
591 * Otherwise, copy stdin to a temporary file and print the temporary
599 send_options
= !_cups_strcasecmp(final_content_type
, "application/pdf") ||
600 !_cups_strcasecmp(final_content_type
, "application/vnd.cups-pdf") ||
601 !_cups_strncasecmp(final_content_type
, "image/", 6);
603 fputs("DEBUG: Sending stdin for job...\n", stderr
);
608 * Point to the files on the command-line...
611 num_files
= argc
- 6;
615 fprintf(stderr
, "DEBUG: %d files to send in job...\n", num_files
);
619 * Set the authentication info, if any...
622 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
627 * Use authentication information in the device URI...
630 if ((password
= strchr(username
, ':')) != NULL
)
633 cupsSetUser(username
);
639 * Try loading authentication information from the environment.
642 const char *ptr
= getenv("AUTH_USERNAME");
646 strlcpy(username
, ptr
, sizeof(username
));
650 password
= getenv("AUTH_PASSWORD");
654 * Try finding the remote server...
657 start_time
= time(NULL
);
659 addrlist
= backendLookup(hostname
, port
, &job_canceled
);
661 http
= httpConnect2(hostname
, port
, addrlist
, AF_UNSPEC
, cupsEncryption(), 1,
663 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
666 * See if the printer supports SNMP...
670 snmp_fd
= _cupsSNMPOpen(addrlist
->addr
.addr
.sa_family
);
675 have_supplies
= !backendSNMPSupplies(snmp_fd
, &(addrlist
->addr
),
678 have_supplies
= start_count
= 0;
681 * Wait for data from the filter...
686 if (!backendWaitLoop(snmp_fd
, &(addrlist
->addr
), 0, backendNetworkSideCB
))
687 return (CUPS_BACKEND_OK
);
688 else if ((bytes
= read(0, buffer
, sizeof(buffer
))) <= 0)
689 return (CUPS_BACKEND_OK
);
693 * Try connecting to the remote server...
696 delay
= _cupsNextDelay(0, &prev_delay
);
700 fprintf(stderr
, "DEBUG: Connecting to %s:%d\n", hostname
, port
);
701 _cupsLangPrintFilter(stderr
, "INFO", _("Connecting to printer."));
703 if (httpReconnect2(http
, 30000, NULL
))
705 int error
= errno
; /* Connection error */
707 if (http
->status
== HTTP_STATUS_CUPS_PKI_ERROR
)
708 update_reasons(NULL
, "+cups-certificate-error");
713 if (getenv("CLASS") != NULL
)
716 * If the CLASS environment variable is set, the job was submitted
717 * to a class and not to a specific queue. In this case, we want
718 * to abort immediately so that the job can be requeued on the next
719 * available printer in the class.
722 _cupsLangPrintFilter(stderr
, "INFO",
723 _("Unable to contact printer, queuing on next "
724 "printer in class."));
727 * Sleep 5 seconds to keep the job from requeuing too rapidly...
732 update_reasons(NULL
, "-connecting-to-device");
734 return (CUPS_BACKEND_FAILED
);
737 fprintf(stderr
, "DEBUG: Connection error: %s\n", strerror(errno
));
739 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
|| errno
== EHOSTUNREACH
|| errno
== ETIMEDOUT
|| errno
== ENOTCONN
)
741 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
743 _cupsLangPrintFilter(stderr
, "ERROR",
744 _("The printer is not responding."));
745 update_reasons(NULL
, "-connecting-to-device");
746 return (CUPS_BACKEND_FAILED
);
752 _cupsLangPrintFilter(stderr
, "WARNING",
753 _("The printer may not exist or "
754 "is unavailable at this time."));
759 _cupsLangPrintFilter(stderr
, "WARNING",
760 _("The printer is unreachable at this "
765 _cupsLangPrintFilter(stderr
, "WARNING",
766 _("The printer is in use."));
770 sleep((unsigned)delay
);
772 delay
= _cupsNextDelay(delay
, &prev_delay
);
776 _cupsLangPrintFilter(stderr
, "ERROR",
777 _("The printer is not responding."));
785 update_reasons(NULL
, "-cups-certificate-error");
787 while (http
->fd
< 0);
790 return (CUPS_BACKEND_OK
);
792 return (CUPS_BACKEND_FAILED
);
794 if (httpIsEncrypted(http
))
797 * Validate TLS credentials...
800 cups_array_t
*creds
; /* TLS credentials */
801 cups_array_t
*lcreds
= NULL
; /* Loaded credentials */
802 http_trust_t trust
; /* Trust level */
803 char credinfo
[1024], /* Information on credentials */
804 lcredinfo
[1024];/* Information on saved credentials */
805 static const char * const trusts
[] = { NULL
, "+cups-pki-invalid", "+cups-pki-changed", "+cups-pki-expired", NULL
, "+cups-pki-unknown" };
807 static const char * const trust_msgs
[] =
809 "Credentials are OK/trusted",
810 "Credentials are invalid",
811 "Credentials have changed",
812 "Credentials are expired",
813 "Credentials have been renewed",
814 "Credentials are unknown/new"
817 fputs("DEBUG: Connection is encrypted.\n", stderr
);
819 if (!httpCopyCredentials(http
, &creds
))
821 trust
= httpCredentialsGetTrust(creds
, hostname
);
822 httpCredentialsString(creds
, credinfo
, sizeof(credinfo
));
824 fprintf(stderr
, "DEBUG: %s (%s)\n", trust_msgs
[trust
], cupsLastErrorString());
825 fprintf(stderr
, "DEBUG: Printer credentials: %s\n", credinfo
);
827 if (!httpLoadCredentials(NULL
, &lcreds
, hostname
))
829 httpCredentialsString(lcreds
, lcredinfo
, sizeof(lcredinfo
));
830 fprintf(stderr
, "DEBUG: Stored credentials: %s\n", lcredinfo
);
833 fputs("DEBUG: No stored credentials.\n", stderr
);
835 update_reasons(NULL
, "-cups-pki-invalid,cups-pki-changed,cups-pki-expired,cups-pki-unknown");
838 update_reasons(NULL
, trusts
[trust
]);
839 return (CUPS_BACKEND_STOP
);
845 * Could not load the credentials, let's save the ones we have so we
846 * can detect changes...
849 httpSaveCredentials(NULL
, creds
, hostname
);
852 httpFreeCredentials(lcreds
);
853 httpFreeCredentials(creds
);
857 fputs("DEBUG: No printer credentials.\n", stderr
);
859 update_reasons(NULL
, "cups-pki-unknown");
860 return (CUPS_BACKEND_STOP
);
864 update_reasons(NULL
, "-connecting-to-device");
865 _cupsLangPrintFilter(stderr
, "INFO", _("Connected to printer."));
867 fprintf(stderr
, "DEBUG: Connected to %s:%d...\n",
868 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
869 httpAddrPort(http
->hostaddr
));
872 * Build a URI for the printer and fill the standard IPP attributes for
873 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
874 * might contain username:password information...
877 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), scheme
, NULL
, hostname
,
881 * First validate the destination and see if the device supports multiple
886 compression_sup
= NULL
;
887 #endif /* HAVE_LIBZ */
890 encryption_sup
= NULL
;
892 media_col_sup
= NULL
;
894 operations_sup
= NULL
;
895 doc_handling_sup
= NULL
;
896 print_color_mode_sup
= NULL
;
901 * Check for side-channel requests...
904 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
907 * Build the IPP request...
910 request
= ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES
);
911 ippSetVersion(request
, version
/ 10, version
% 10);
912 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
915 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
916 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
923 fputs("DEBUG: Getting supported attributes...\n", stderr
);
925 if (http
->version
< HTTP_VERSION_1_1
)
927 fprintf(stderr
, "DEBUG: Printer responded with HTTP version %d.%d.\n",
928 http
->version
/ 100, http
->version
% 100);
929 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
930 "cups-ipp-wrong-http-version");
933 supported
= cupsDoRequest(http
, request
, resource
);
934 ipp_status
= cupsLastError();
936 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
937 ippErrorString(ipp_status
), cupsLastErrorString());
939 if (ipp_status
<= IPP_STATUS_OK_CONFLICTING
)
943 fprintf(stderr
, "DEBUG: Get-Printer-Attributes returned %s.\n",
944 ippErrorString(ipp_status
));
946 if (ipp_status
== IPP_STATUS_ERROR_BUSY
||
947 ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
)
949 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
951 _cupsLangPrintFilter(stderr
, "ERROR",
952 _("The printer is not responding."));
953 return (CUPS_BACKEND_FAILED
);
956 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
958 report_printer_state(supported
);
960 sleep((unsigned)delay
);
962 delay
= _cupsNextDelay(delay
, &prev_delay
);
964 else if ((ipp_status
== IPP_STATUS_ERROR_BAD_REQUEST
||
965 ipp_status
== IPP_STATUS_ERROR_VERSION_NOT_SUPPORTED
) && version
> 10)
968 * Switch to IPP/1.1 or IPP/1.0...
973 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
975 "DEBUG: The printer does not support IPP/%d.%d, trying "
976 "IPP/1.1.\n", version
/ 10, version
% 10);
981 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
983 "DEBUG: The printer does not support IPP/%d.%d, trying "
984 "IPP/1.0.\n", version
/ 10, version
% 10);
988 httpReconnect2(http
, 30000, NULL
);
990 else if (ipp_status
== IPP_STATUS_ERROR_NOT_FOUND
)
992 _cupsLangPrintFilter(stderr
, "ERROR",
993 _("The printer configuration is incorrect or the "
994 "printer no longer exists."));
996 ippDelete(supported
);
998 return (CUPS_BACKEND_STOP
);
1000 else if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1001 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1003 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1004 /* WWW-Authenticate field value */
1006 if (!strncmp(www_auth
, "Negotiate", 9))
1007 auth_info_required
= "negotiate";
1008 else if (www_auth
[0])
1009 auth_info_required
= "username,password";
1011 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
1012 return (CUPS_BACKEND_AUTH_REQUIRED
);
1014 else if (ipp_status
!= IPP_STATUS_ERROR_NOT_AUTHORIZED
)
1016 _cupsLangPrintFilter(stderr
, "ERROR",
1017 _("Unable to get printer status."));
1020 httpReconnect2(http
, 30000, NULL
);
1023 ippDelete(supported
);
1028 if (!getenv("CLASS"))
1031 * Check printer-is-accepting-jobs = false and printer-state-reasons for the
1032 * "spool-area-full" keyword...
1037 if ((printer_accepting
= ippFindAttribute(supported
,
1038 "printer-is-accepting-jobs",
1039 IPP_TAG_BOOLEAN
)) != NULL
&&
1040 !printer_accepting
->values
[0].boolean
)
1042 else if (!printer_accepting
)
1043 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1044 "cups-ipp-missing-printer-is-accepting-jobs");
1046 if ((printer_state
= ippFindAttribute(supported
,
1047 "printer-state-reasons",
1048 IPP_TAG_KEYWORD
)) == NULL
)
1050 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1051 "cups-ipp-missing-printer-state-reasons");
1055 for (i
= 0; i
< printer_state
->num_values
; i
++)
1057 if (!strcmp(printer_state
->values
[0].string
.text
,
1058 "spool-area-full") ||
1059 !strncmp(printer_state
->values
[0].string
.text
, "spool-area-full-",
1070 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1072 report_printer_state(supported
);
1074 sleep((unsigned)delay
);
1076 delay
= _cupsNextDelay(delay
, &prev_delay
);
1078 ippDelete(supported
);
1080 ipp_status
= IPP_STATUS_ERROR_BUSY
;
1086 * Check for supported attributes...
1090 if ((compression_sup
= ippFindAttribute(supported
, "compression-supported",
1091 IPP_TAG_KEYWORD
)) != NULL
)
1094 * Check whether the requested compression is supported and/or default to
1095 * compression if supported...
1098 if (compression
&& !ippContainsString(compression_sup
, compression
))
1100 fprintf(stderr
, "DEBUG: Printer does not support the requested "
1101 "compression value \"%s\".\n", compression
);
1104 else if (!compression
&& (!strcmp(final_content_type
, "image/pwg-raster") || !strcmp(final_content_type
, "image/urf")))
1106 if (ippContainsString(compression_sup
, "gzip"))
1107 compression
= "gzip";
1108 else if (ippContainsString(compression_sup
, "deflate"))
1109 compression
= "deflate";
1112 fprintf(stderr
, "DEBUG: Automatically using \"%s\" compression.\n",
1116 #endif /* HAVE_LIBZ */
1118 if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
1119 IPP_TAG_RANGE
)) != NULL
)
1122 * Has the "copies-supported" attribute - does it have an upper
1126 fprintf(stderr
, "DEBUG: copies-supported=%d-%d\n",
1127 copies_sup
->values
[0].range
.lower
,
1128 copies_sup
->values
[0].range
.upper
);
1130 if (copies_sup
->values
[0].range
.upper
<= 1)
1131 copies_sup
= NULL
; /* No */
1134 if ((cups_version
= ippFindAttribute(supported
, "cups-version", IPP_TAG_TEXT
)) != NULL
)
1136 const char *val
= ippGetString(cups_version
, 0, NULL
);
1138 fprintf(stderr
, "DEBUG: cups-version = \"%s\"\n", val
);
1139 if (!strcmp(val
, "cups-version"))
1140 cups_version
= NULL
; /* Bogus cups-version value returned by buggy printers! */
1143 encryption_sup
= ippFindAttribute(supported
, "job-password-encryption-supported", IPP_TAG_KEYWORD
);
1145 if ((format_sup
= ippFindAttribute(supported
, "document-format-supported",
1146 IPP_TAG_MIMETYPE
)) != NULL
)
1148 fprintf(stderr
, "DEBUG: document-format-supported (%d values)\n",
1149 format_sup
->num_values
);
1150 for (i
= 0; i
< format_sup
->num_values
; i
++)
1151 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1152 format_sup
->values
[i
].string
.text
);
1155 if ((media_col_sup
= ippFindAttribute(supported
, "media-col-supported",
1156 IPP_TAG_KEYWORD
)) != NULL
)
1158 fprintf(stderr
, "DEBUG: media-col-supported (%d values)\n",
1159 media_col_sup
->num_values
);
1160 for (i
= 0; i
< media_col_sup
->num_values
; i
++)
1161 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1162 media_col_sup
->values
[i
].string
.text
);
1165 print_color_mode_sup
= ippFindAttribute(supported
, "print-color-mode-supported", IPP_TAG_KEYWORD
);
1167 if ((operations_sup
= ippFindAttribute(supported
, "operations-supported",
1168 IPP_TAG_ENUM
)) != NULL
)
1170 fprintf(stderr
, "DEBUG: operations-supported (%d values)\n",
1171 operations_sup
->num_values
);
1172 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1173 fprintf(stderr
, "DEBUG: [%d] = %s\n", i
,
1174 ippOpString(operations_sup
->values
[i
].integer
));
1176 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1177 if (operations_sup
->values
[i
].integer
== IPP_OP_PRINT_JOB
)
1180 if (i
>= operations_sup
->num_values
)
1181 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1182 "cups-ipp-missing-print-job");
1184 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1185 if (operations_sup
->values
[i
].integer
== IPP_OP_CANCEL_JOB
)
1188 if (i
>= operations_sup
->num_values
)
1189 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1190 "cups-ipp-missing-cancel-job");
1192 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1193 if (operations_sup
->values
[i
].integer
== IPP_OP_GET_JOB_ATTRIBUTES
)
1196 if (i
>= operations_sup
->num_values
)
1197 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1198 "cups-ipp-missing-get-job-attributes");
1200 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1201 if (operations_sup
->values
[i
].integer
== IPP_OP_GET_PRINTER_ATTRIBUTES
)
1204 if (i
>= operations_sup
->num_values
)
1205 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1206 "cups-ipp-missing-get-printer-attributes");
1208 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1210 if (operations_sup
->values
[i
].integer
== IPP_OP_VALIDATE_JOB
)
1212 else if (operations_sup
->values
[i
].integer
== IPP_OP_CREATE_JOB
)
1214 else if (operations_sup
->values
[i
].integer
== IPP_OP_SEND_DOCUMENT
)
1216 else if (operations_sup
->values
[i
].integer
== IPP_OP_GET_JOB_ATTRIBUTES
)
1220 if (create_job
&& !send_document
)
1222 fputs("DEBUG: Printer supports Create-Job but not Send-Document.\n",
1226 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1227 "cups-ipp-missing-send-document");
1231 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1232 "cups-ipp-missing-validate-job");
1235 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1236 "cups-ipp-missing-operations-supported");
1238 doc_handling_sup
= ippFindAttribute(supported
,
1239 "multiple-document-handling-supported",
1242 report_printer_state(supported
);
1244 while (!job_canceled
&& ipp_status
> IPP_STATUS_OK_CONFLICTING
);
1247 return (CUPS_BACKEND_OK
);
1250 * See if the printer is accepting jobs and is not stopped; if either
1251 * condition is true and we are printing to a class, requeue the job...
1254 if (getenv("CLASS") != NULL
)
1256 printer_state
= ippFindAttribute(supported
, "printer-state",
1258 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
1261 if (printer_state
== NULL
||
1262 (printer_state
->values
[0].integer
> IPP_PSTATE_PROCESSING
&&
1264 printer_accepting
== NULL
||
1265 !printer_accepting
->values
[0].boolean
)
1268 * If the CLASS environment variable is set, the job was submitted
1269 * to a class and not to a specific queue. In this case, we want
1270 * to abort immediately so that the job can be requeued on the next
1271 * available printer in the class.
1274 _cupsLangPrintFilter(stderr
, "INFO",
1275 _("Unable to contact printer, queuing on next "
1276 "printer in class."));
1278 ippDelete(supported
);
1282 * Sleep 5 seconds to keep the job from requeuing too rapidly...
1287 return (CUPS_BACKEND_FAILED
);
1292 * See if the printer supports multiple copies...
1295 copies
= atoi(argv
[4]);
1297 if (copies_sup
|| argc
< 7)
1298 copies_remaining
= 1;
1300 copies_remaining
= copies
;
1303 * Prepare remaining printing options...
1310 num_options
= cupsParseOptions(argv
[5], 0, &options
);
1312 if (!cups_version
&& media_col_sup
)
1315 * Load the PPD file and generate PWG attribute mapping information...
1318 ppd_attr_t
*mandatory
; /* cupsMandatory value */
1320 ppd
= ppdOpenFile(getenv("PPD"));
1321 pc
= _ppdCacheCreateWithPPD(ppd
);
1323 ppdMarkDefaults(ppd
);
1324 cupsMarkOptions(ppd
, num_options
, options
);
1326 if ((mandatory
= ppdFindAttr(ppd
, "cupsMandatory", NULL
)) != NULL
)
1327 strlcpy(mandatory_attrs
, mandatory
->value
, sizeof(mandatory_attrs
));
1331 * Validate job-password/-encryption...
1334 if (cupsGetOption("job-password", num_options
, options
))
1336 const char *keyword
; /* job-password-encryption value */
1337 static const char * const hashes
[] =
1338 { /* List of supported hash algorithms, in order of preference */
1349 if ((keyword
= cupsGetOption("job-password-encryption", num_options
, options
)) == NULL
|| !ippContainsString(encryption_sup
, keyword
))
1352 * Either no job-password-encryption or the value isn't supported by
1356 for (i
= 0; i
< (int)(sizeof(hashes
) / sizeof(hashes
[0])); i
++)
1357 if (ippContainsString(encryption_sup
, hashes
[i
]))
1360 if (i
< (int)(sizeof(hashes
) / sizeof(hashes
[0])))
1361 num_options
= cupsAddOption("job-password-encryption", hashes
[i
], num_options
, &options
);
1368 document_format
= NULL
;
1370 if (format_sup
!= NULL
)
1372 if (ippContainsString(format_sup
, final_content_type
))
1373 document_format
= final_content_type
;
1374 else if (ippContainsString(format_sup
, "application/octet-stream"))
1375 document_format
= "application/octet-stream";
1378 fprintf(stderr
, "DEBUG: final_content_type=\"%s\", document_format=\"%s\"\n",
1379 final_content_type
, document_format
? document_format
: "(null)");
1382 * If the printer does not support HTTP/1.1 (which IPP requires), copy stdin
1383 * to a temporary file so that we can do a HTTP/1.0 submission...
1385 * (I hate compatibility hacks!)
1388 if (http
->version
< HTTP_VERSION_1_1
&& num_files
== 0)
1390 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
1392 perror("DEBUG: Unable to create temporary file");
1393 return (CUPS_BACKEND_FAILED
);
1396 _cupsLangPrintFilter(stderr
, "INFO", _("Copying print data."));
1398 if ((compatsize
= write(fd
, buffer
, (size_t)bytes
)) < 0)
1400 perror("DEBUG: Unable to write temporary file");
1401 return (CUPS_BACKEND_FAILED
);
1404 if ((bytes
= backendRunLoop(-1, fd
, snmp_fd
, &(addrlist
->addr
), 0, 0,
1405 backendNetworkSideCB
)) < 0)
1406 return (CUPS_BACKEND_FAILED
);
1408 compatsize
+= bytes
;
1412 compatfile
= tmpfilename
;
1413 files
= &compatfile
;
1416 else if (http
->version
< HTTP_VERSION_1_1
&& num_files
== 1)
1418 struct stat fileinfo
; /* File information */
1420 if (!stat(files
[0], &fileinfo
))
1421 compatsize
= fileinfo
.st_size
;
1425 * If the printer only claims to support IPP/1.0, or if the user specifically
1426 * included version=1.0 in the URI, then do not try to use Create-Job or
1427 * Send-Document. This is another dreaded compatibility hack, but
1428 * unfortunately there are enough broken printers out there that we need
1433 create_job
= send_document
= 0;
1436 * Start monitoring the printer in the background...
1440 monitor
.hostname
= hostname
;
1441 monitor
.user
= argv
[2];
1442 monitor
.resource
= resource
;
1443 monitor
.port
= port
;
1444 monitor
.version
= version
;
1446 monitor
.create_job
= create_job
;
1447 monitor
.get_job_attrs
= get_job_attrs
;
1448 monitor
.encryption
= cupsEncryption();
1449 monitor
.job_state
= IPP_JSTATE_PENDING
;
1450 monitor
.printer_state
= IPP_PSTATE_IDLE
;
1451 monitor
.retryable
= argc
== 6 && document_format
&& strcmp(document_format
, "image/pwg-raster") && strcmp(document_format
, "image/urf");
1455 monitor
.job_name
= argv
[3];
1459 snprintf(print_job_name
, sizeof(print_job_name
), "%s - %s", argv
[1],
1461 monitor
.job_name
= print_job_name
;
1464 _cupsThreadCreate((_cups_thread_func_t
)monitor_printer
, &monitor
);
1467 * Validate access to the printer...
1470 while (!job_canceled
&& validate_job
)
1472 request
= new_request(IPP_OP_VALIDATE_JOB
, version
, uri
, argv
[2],
1473 monitor
.job_name
, num_options
, options
, compression
,
1474 copies_sup
? copies
: 1, document_format
, pc
, ppd
,
1475 media_col_sup
, doc_handling_sup
, print_color_mode_sup
);
1477 response
= cupsDoRequest(http
, request
, resource
);
1479 ipp_status
= cupsLastError();
1481 fprintf(stderr
, "DEBUG: Validate-Job: %s (%s)\n",
1482 ippErrorString(ipp_status
), cupsLastErrorString());
1483 debug_attributes(response
);
1485 if ((job_auth
= ippFindAttribute(response
, "job-authorization-uri",
1486 IPP_TAG_URI
)) != NULL
)
1487 num_options
= cupsAddOption("job-authorization-uri",
1488 ippGetString(job_auth
, 0, NULL
), num_options
,
1491 if (ipp_status
== IPP_STATUS_OK_IGNORED_OR_SUBSTITUTED
|| ipp_status
== IPP_STATUS_OK_CONFLICTING
)
1494 * One or more options are not supported...
1497 ipp_attribute_t
*attr
; /* Unsupported attribute */
1499 if ((attr
= ippFindAttribute(response
, "sides", IPP_TAG_ZERO
)) != NULL
)
1502 * The sides value is not supported, revert to one-sided as needed...
1505 const char *sides
= cupsGetOption("sides", num_options
, options
);
1507 if (!sides
|| !strncmp(sides
, "two-sided-", 10))
1509 fputs("DEBUG: Unable to do two-sided printing, setting sides to 'one-sided'.\n", stderr
);
1510 num_options
= cupsAddOption("sides", "one-sided", num_options
, &options
);
1515 ippDelete(response
);
1520 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1521 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1523 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1526 else if (ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
||
1527 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1528 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1529 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1530 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1531 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1533 else if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1534 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1535 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1537 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1538 /* WWW-Authenticate field value */
1540 if (!strncmp(www_auth
, "Negotiate", 9))
1541 auth_info_required
= "negotiate";
1542 else if (www_auth
[0])
1543 auth_info_required
= "username,password";
1547 else if (ipp_status
== IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
)
1550 * This is all too common...
1553 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1554 "cups-ipp-missing-validate-job");
1557 else if (ipp_status
< IPP_STATUS_REDIRECTION_OTHER_SITE
||
1558 ipp_status
== IPP_STATUS_ERROR_BAD_REQUEST
)
1560 else if (job_auth
== NULL
&& ipp_status
> IPP_STATUS_ERROR_BAD_REQUEST
)
1565 * Then issue the print-job request...
1570 while (!job_canceled
&& copies_remaining
> 0)
1573 * Check for side-channel requests...
1576 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1579 * Build the IPP job creation request...
1585 request
= new_request((num_files
> 1 || create_job
) ? IPP_OP_CREATE_JOB
:
1587 version
, uri
, argv
[2], monitor
.job_name
, num_options
,
1588 options
, compression
, copies_sup
? copies
: 1,
1589 document_format
, pc
, ppd
, media_col_sup
,
1590 doc_handling_sup
, print_color_mode_sup
);
1596 if (num_files
> 1 || create_job
)
1597 response
= cupsDoRequest(http
, request
, resource
);
1600 size_t length
= 0; /* Length of request */
1604 fputs("DEBUG: Sending file using HTTP/1.0 Content-Length...\n", stderr
);
1605 length
= ippLength(request
) + (size_t)compatsize
;
1608 fputs("DEBUG: Sending file using HTTP/1.1 chunking...\n", stderr
);
1610 http_status
= cupsSendRequest(http
, request
, resource
, length
);
1611 if (http_status
== HTTP_STATUS_CONTINUE
&& request
->state
== IPP_STATE_DATA
)
1613 if (compression
&& strcmp(compression
, "none"))
1614 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1618 if ((fd
= open(files
[0], O_RDONLY
)) < 0)
1620 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1621 return (CUPS_BACKEND_FAILED
);
1627 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1630 while (http_status
== HTTP_STATUS_CONTINUE
&&
1631 (!job_canceled
|| compatsize
> 0))
1634 * Check for side-channel requests and more print data...
1639 FD_SET(snmp_fd
, &input
);
1640 FD_SET(CUPS_SC_FD
, &input
);
1642 while (select(fd
> snmp_fd
? fd
+ 1 : snmp_fd
+ 1, &input
, NULL
, NULL
,
1643 NULL
) <= 0 && !job_canceled
);
1645 if (FD_ISSET(snmp_fd
, &input
))
1646 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1648 if (FD_ISSET(fd
, &input
))
1650 if ((bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1652 fprintf(stderr
, "DEBUG: Read %d bytes...\n", (int)bytes
);
1654 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1655 != HTTP_STATUS_CONTINUE
)
1658 else if (bytes
== 0 || (errno
!= EINTR
&& errno
!= EAGAIN
))
1663 if (http_status
== HTTP_STATUS_ERROR
)
1664 fprintf(stderr
, "DEBUG: Error writing document data for "
1665 "Print-Job: %s\n", strerror(httpError(http
)));
1671 response
= cupsGetResponse(http
, resource
);
1675 ipp_status
= cupsLastError();
1677 fprintf(stderr
, "DEBUG: %s: %s (%s)\n",
1678 (num_files
> 1 || create_job
) ? "Create-Job" : "Print-Job",
1679 ippErrorString(ipp_status
), cupsLastErrorString());
1680 debug_attributes(response
);
1682 if (ipp_status
> IPP_STATUS_OK_CONFLICTING
)
1689 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1690 ipp_status
== IPP_STATUS_ERROR_NOT_POSSIBLE
||
1691 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1693 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1699 * We can't re-submit when we have no files to print, so exit
1700 * immediately with the right status code...
1706 else if (ipp_status
== IPP_STATUS_ERROR_JOB_CANCELED
||
1707 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1708 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
1709 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1710 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1711 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1712 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1717 * Update auth-info-required as needed...
1720 _cupsLangPrintFilter(stderr
, "ERROR",
1721 _("Print job was not accepted."));
1723 if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1724 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1726 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1727 /* WWW-Authenticate field value */
1729 if (!strncmp(www_auth
, "Negotiate", 9))
1730 auth_info_required
= "negotiate";
1731 else if (www_auth
[0])
1732 auth_info_required
= "username,password";
1734 else if (ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
)
1737 * Print file is too large, abort this job...
1748 * We can't re-submit when we have no files to print, so exit
1749 * immediately with the right status code...
1756 else if ((job_id_attr
= ippFindAttribute(response
, "job-id",
1757 IPP_TAG_INTEGER
)) == NULL
)
1759 fputs("DEBUG: Print job accepted - job ID unknown.\n", stderr
);
1760 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1761 "cups-ipp-missing-job-id");
1767 monitor
.job_id
= job_id
= job_id_attr
->values
[0].integer
;
1768 fprintf(stderr
, "DEBUG: Print job accepted - job ID %d.\n", job_id
);
1771 ippDelete(response
);
1776 if (job_id
&& (num_files
> 1 || create_job
))
1778 for (i
= 0; num_files
== 0 || i
< num_files
; i
++)
1781 * Check for side-channel requests...
1784 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1787 * Send the next file in the job...
1790 request
= ippNewRequest(IPP_OP_SEND_DOCUMENT
);
1791 ippSetVersion(request
, version
/ 10, version
% 10);
1793 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1796 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1800 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1801 "requesting-user-name", NULL
, argv
[2]);
1803 ippAddBoolean(request
, IPP_TAG_OPERATION
, "last-document",
1804 (i
+ 1) >= num_files
);
1806 if (document_format
)
1807 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
1808 "document-format", NULL
, document_format
);
1811 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1812 "compression", NULL
, compression
);
1814 fprintf(stderr
, "DEBUG: Sending file %d using chunking...\n", i
+ 1);
1815 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
1816 debug_attributes(request
);
1818 http_status
= cupsSendRequest(http
, request
, resource
, 0);
1819 if (http_status
== HTTP_STATUS_CONTINUE
&& request
->state
== IPP_STATE_DATA
)
1821 if (compression
&& strcmp(compression
, "none"))
1822 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1827 http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
);
1831 if ((fd
= open(files
[i
], O_RDONLY
)) < 0)
1833 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1834 return (CUPS_BACKEND_FAILED
);
1843 while (!job_canceled
&& http_status
== HTTP_STATUS_CONTINUE
&&
1844 (bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1846 if ((http_status
= cupsWriteRequestData(http
, buffer
, (size_t)bytes
))
1847 != HTTP_STATUS_CONTINUE
)
1852 * Check for side-channel requests...
1855 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1863 if (http_status
== HTTP_STATUS_ERROR
)
1864 fprintf(stderr
, "DEBUG: Error writing document data for "
1865 "Send-Document: %s\n", strerror(httpError(http
)));
1867 response
= cupsGetResponse(http
, resource
);
1870 fprintf(stderr
, "DEBUG: Send-Document: %s (%s)\n",
1871 ippErrorString(cupsLastError()), cupsLastErrorString());
1872 debug_attributes(response
);
1873 ippDelete(response
);
1875 if (cupsLastError() > IPP_STATUS_OK_CONFLICTING
&& !job_canceled
)
1877 ipp_status
= cupsLastError();
1879 _cupsLangPrintFilter(stderr
, "ERROR",
1880 _("Unable to add document to print job."));
1887 if (num_files
== 0 || fd
< 0)
1896 if (ipp_status
<= IPP_STATUS_OK_CONFLICTING
&& argc
> 6)
1898 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
1899 copies_remaining
--;
1901 else if ((ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
|| ipp_status
== IPP_STATUS_ERROR_DOCUMENT_UNPRINTABLE
) &&
1903 document_format
&& strcmp(document_format
, "image/pwg-raster") && strcmp(document_format
, "image/urf"))
1906 * Need to reprocess the job as raster...
1909 fputs("JOBSTATE: cups-retry-as-raster\n", stderr
);
1911 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1915 else if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1916 ipp_status
== IPP_STATUS_ERROR_NOT_POSSIBLE
||
1917 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1922 * Need to reprocess the entire job; if we have a job ID, cancel the
1927 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1933 else if (ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
||
1934 ipp_status
== IPP_STATUS_ERROR_JOB_CANCELED
||
1935 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1936 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1937 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1938 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1939 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
||
1940 ipp_status
== IPP_STATUS_ERROR_INTERNAL
)
1943 * Print file is too large, job was canceled, we need new
1944 * authentication data, or we had some sort of error...
1949 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_UPGRADE_REQUIRED
)
1952 * Server is configured incorrectly; the policy for Create-Job and
1953 * Send-Document has to be the same (auth or no auth, encryption or
1954 * no encryption). Force the queue to stop since printing will never
1958 fputs("DEBUG: The server or printer is configured incorrectly.\n",
1960 fputs("DEBUG: The policy for Create-Job and Send-Document must have the "
1961 "same authentication and encryption requirements.\n", stderr
);
1963 ipp_status
= IPP_STATUS_ERROR_INTERNAL
;
1966 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1970 else if (ipp_status
== IPP_STATUS_ERROR_NOT_FOUND
)
1973 * Printer does not actually implement support for Create-Job/
1974 * Send-Document, so log the conformance issue and stop the printer.
1977 fputs("DEBUG: This printer claims to support Create-Job and "
1978 "Send-Document, but those operations failed.\n", stderr
);
1979 fputs("DEBUG: Add '?version=1.0' to the device URI to use legacy "
1980 "compatibility mode.\n", stderr
);
1981 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1982 "cups-ipp-missing-send-document");
1984 ipp_status
= IPP_STATUS_ERROR_INTERNAL
; /* Force queue to stop */
1989 copies_remaining
--;
1992 * Wait for the job to complete...
1995 if (!job_id
|| !waitjob
|| !get_job_attrs
)
1998 fputs("STATE: +cups-waiting-for-job-completed\n", stderr
);
2000 _cupsLangPrintFilter(stderr
, "INFO", _("Waiting for job to complete."));
2002 for (delay
= _cupsNextDelay(0, &prev_delay
), waittime
= time(NULL
) + 30; !job_canceled
;)
2005 * Check for side-channel requests...
2008 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
2011 * Check printer state...
2014 check_printer_state(http
, uri
, resource
, argv
[2], version
);
2016 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING
)
2020 * Build an IPP_OP_GET_JOB_ATTRIBUTES request...
2023 request
= ippNewRequest(IPP_OP_GET_JOB_ATTRIBUTES
);
2024 ippSetVersion(request
, version
/ 10, version
% 10);
2026 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2029 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2033 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2034 "requesting-user-name", NULL
, argv
[2]);
2036 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2037 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
2040 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2041 debug_attributes(request
);
2047 httpReconnect2(http
, 30000, NULL
);
2048 response
= cupsDoRequest(http
, request
, resource
);
2049 ipp_status
= cupsLastError();
2051 if (ipp_status
== IPP_STATUS_ERROR_NOT_FOUND
|| ipp_status
== IPP_STATUS_ERROR_NOT_POSSIBLE
)
2054 * Job has gone away and/or the server has no job history...
2057 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2058 "cups-ipp-missing-job-history");
2059 ippDelete(response
);
2061 ipp_status
= IPP_STATUS_OK
;
2065 fprintf(stderr
, "DEBUG: Get-Job-Attributes: %s (%s)\n",
2066 ippErrorString(ipp_status
), cupsLastErrorString());
2067 debug_attributes(response
);
2069 if (ipp_status
<= IPP_STATUS_OK_CONFLICTING
)
2073 if (ipp_status
!= IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
&&
2074 ipp_status
!= IPP_STATUS_ERROR_BUSY
)
2076 ippDelete(response
);
2077 ipp_status
= IPP_STATUS_OK
;
2080 else if (ipp_status
== IPP_STATUS_ERROR_INTERNAL
)
2084 if (waitjob_tries
> 4)
2086 ippDelete(response
);
2087 ipp_status
= IPP_STATUS_OK
;
2095 if ((job_state
= ippFindAttribute(response
, "job-state",
2096 IPP_TAG_ENUM
)) != NULL
)
2099 * Reflect the remote job state in the local queue...
2103 job_state
->values
[0].integer
>= IPP_JSTATE_PENDING
&&
2104 job_state
->values
[0].integer
<= IPP_JSTATE_COMPLETED
)
2105 update_reasons(NULL
,
2106 remote_job_states
[job_state
->values
[0].integer
-
2107 IPP_JSTATE_PENDING
]);
2109 if ((job_sheets
= ippFindAttribute(response
, "job-impressions-completed", IPP_TAG_INTEGER
)) == NULL
)
2110 job_sheets
= ippFindAttribute(response
, "job-media-sheets-completed", IPP_TAG_INTEGER
);
2113 fprintf(stderr
, "PAGE: total %d\n",
2114 job_sheets
->values
[0].integer
);
2117 * Stop polling if the job is finished or pending-held for 30 seconds...
2120 if (job_state
->values
[0].integer
> IPP_JSTATE_STOPPED
||
2121 (job_state
->values
[0].integer
== IPP_JSTATE_HELD
&& time(NULL
) > waittime
))
2123 ippDelete(response
);
2127 else if (ipp_status
!= IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
&&
2128 ipp_status
!= IPP_STATUS_ERROR_NOT_POSSIBLE
&&
2129 ipp_status
!= IPP_STATUS_ERROR_BUSY
)
2132 * If the printer does not return a job-state attribute, it does not
2133 * conform to the IPP specification - break out immediately and fail
2137 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
2138 "cups-ipp-missing-job-state");
2139 ipp_status
= IPP_STATUS_ERROR_INTERNAL
;
2144 ippDelete(response
);
2147 * Wait before polling again...
2150 sleep((unsigned)delay
);
2152 delay
= _cupsNextDelay(delay
, &prev_delay
);
2157 * Cancel the job as needed...
2160 if (job_canceled
> 0 && job_id
> 0)
2162 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
2164 if (cupsLastError() > IPP_STATUS_OK_CONFLICTING
)
2165 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2169 * Check the printer state and report it if necessary...
2172 check_printer_state(http
, uri
, resource
, argv
[2], version
);
2174 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING
)
2178 * Collect the final page count as needed...
2181 if (have_supplies
&&
2182 !backendSNMPSupplies(snmp_fd
, &(http
->addrlist
->addr
), &page_count
,
2184 page_count
> start_count
)
2185 fprintf(stderr
, "PAGE: total %d\n", page_count
- start_count
);
2189 * See if we used Kerberos at all...
2193 auth_info_required
= "negotiate";
2194 #endif /* HAVE_GSSAPI */
2202 cupsFreeOptions(num_options
, options
);
2203 _ppdCacheDestroy(pc
);
2208 ippDelete(supported
);
2211 * Remove the temporary file(s) if necessary...
2215 unlink(tmpfilename
);
2218 * Return the queue status...
2221 if (ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
|| ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
2222 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
||
2223 ipp_status
<= IPP_STATUS_OK_CONFLICTING
)
2224 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
2226 if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
)
2227 fputs("JOBSTATE: account-info-needed\n", stderr
);
2228 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
)
2229 fputs("JOBSTATE: account-closed\n", stderr
);
2230 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
)
2231 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2232 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2233 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2236 return (CUPS_BACKEND_OK
);
2237 else if (ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
|| ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
|| ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
2238 return (CUPS_BACKEND_AUTH_REQUIRED
);
2239 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
2240 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
2241 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
2242 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2243 return (CUPS_BACKEND_HOLD
);
2244 else if (ipp_status
== IPP_STATUS_ERROR_INTERNAL
)
2245 return (CUPS_BACKEND_STOP
);
2246 else if (ipp_status
== IPP_STATUS_ERROR_CONFLICTING
|| ipp_status
== IPP_STATUS_ERROR_REQUEST_ENTITY
|| ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
)
2247 return (CUPS_BACKEND_FAILED
);
2248 else if (ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
||
2249 ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
||
2250 ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
|| job_canceled
< 0)
2252 if (ipp_status
== IPP_STATUS_ERROR_REQUEST_VALUE
)
2253 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job too large."));
2254 else if (ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
)
2255 _cupsLangPrintFilter(stderr
, "ERROR",
2256 _("Printer cannot print supplied content."));
2257 else if (ipp_status
== IPP_STATUS_ERROR_ATTRIBUTES_OR_VALUES
)
2258 _cupsLangPrintFilter(stderr
, "ERROR",
2259 _("Printer cannot print with supplied options."));
2261 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job canceled at printer."));
2263 return (CUPS_BACKEND_CANCEL
);
2265 else if (ipp_status
> IPP_STATUS_OK_CONFLICTING
&& ipp_status
!= IPP_STATUS_ERROR_JOB_CANCELED
)
2266 return (CUPS_BACKEND_RETRY_CURRENT
);
2268 return (CUPS_BACKEND_OK
);
2273 * 'cancel_job()' - Cancel a print job.
2277 cancel_job(http_t
*http
, /* I - HTTP connection */
2278 const char *uri
, /* I - printer-uri */
2279 int id
, /* I - job-id */
2280 const char *resource
, /* I - Resource path */
2281 const char *user
, /* I - requesting-user-name */
2282 int version
) /* I - IPP version */
2284 ipp_t
*request
; /* Cancel-Job request */
2287 _cupsLangPrintFilter(stderr
, "INFO", _("Canceling print job."));
2289 request
= ippNewRequest(IPP_OP_CANCEL_JOB
);
2290 ippSetVersion(request
, version
/ 10, version
% 10);
2292 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2294 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
2296 if (user
&& user
[0])
2297 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2298 "requesting-user-name", NULL
, user
);
2304 ippDelete(cupsDoRequest(http
, request
, resource
));
2309 * 'check_printer_state()' - Check the printer state.
2312 static ipp_pstate_t
/* O - Current printer-state */
2313 check_printer_state(
2314 http_t
*http
, /* I - HTTP connection */
2315 const char *uri
, /* I - Printer URI */
2316 const char *resource
, /* I - Resource path */
2317 const char *user
, /* I - Username, if any */
2318 int version
) /* I - IPP version */
2320 ipp_t
*request
, /* IPP request */
2321 *response
; /* IPP response */
2322 ipp_attribute_t
*attr
; /* Attribute in response */
2323 ipp_pstate_t printer_state
= IPP_PSTATE_STOPPED
;
2324 /* Current printer-state */
2328 * Send a Get-Printer-Attributes request and log the results...
2331 request
= ippNewRequest(IPP_OP_GET_PRINTER_ATTRIBUTES
);
2332 ippSetVersion(request
, version
/ 10, version
% 10);
2334 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2337 if (user
&& user
[0])
2338 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2339 "requesting-user-name", NULL
, user
);
2341 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2342 "requested-attributes",
2343 (int)(sizeof(pattrs
) / sizeof(pattrs
[0])), NULL
, pattrs
);
2345 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2346 debug_attributes(request
);
2348 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
2350 report_printer_state(response
);
2352 if ((attr
= ippFindAttribute(response
, "printer-state",
2353 IPP_TAG_ENUM
)) != NULL
)
2354 printer_state
= (ipp_pstate_t
)attr
->values
[0].integer
;
2357 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
2358 ippErrorString(cupsLastError()), cupsLastErrorString());
2359 debug_attributes(response
);
2360 ippDelete(response
);
2363 * Return the printer-state value...
2366 return (printer_state
);
2371 * 'debug_attributes()' - Print out the request or response attributes as DEBUG
2376 debug_attributes(ipp_t
*ipp
) /* I - Request or response message */
2378 ipp_tag_t group
; /* Current group */
2379 ipp_attribute_t
*attr
; /* Current attribute */
2380 char buffer
[1024]; /* Value buffer */
2383 for (group
= IPP_TAG_ZERO
, attr
= ippFirstAttribute(ipp
);
2385 attr
= ippNextAttribute(ipp
))
2387 const char *name
= ippGetName(attr
);
2391 group
= IPP_TAG_ZERO
;
2395 if (group
!= ippGetGroupTag(attr
))
2397 group
= ippGetGroupTag(attr
);
2398 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(group
));
2401 if (!strcmp(name
, "job-password"))
2402 strlcpy(buffer
, "---", sizeof(buffer
));
2404 ippAttributeString(attr
, buffer
, sizeof(buffer
));
2406 fprintf(stderr
, "DEBUG: %s %s%s %s\n", name
,
2407 ippGetCount(attr
) > 1 ? "1setOf " : "",
2408 ippTagString(ippGetValueTag(attr
)), buffer
);
2411 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(IPP_TAG_END
));
2416 * 'monitor_printer()' - Monitor the printer state.
2419 static void * /* O - Thread exit code */
2421 _cups_monitor_t
*monitor
) /* I - Monitoring data */
2423 http_t
*http
; /* Connection to printer */
2424 ipp_t
*request
, /* IPP request */
2425 *response
; /* IPP response */
2426 ipp_attribute_t
*attr
; /* Attribute in response */
2427 int delay
, /* Current delay */
2428 prev_delay
; /* Previous delay */
2429 ipp_op_t job_op
; /* Operation to use */
2430 int job_id
; /* Job ID */
2431 const char *job_name
; /* Job name */
2432 ipp_jstate_t job_state
; /* Job state */
2433 const char *job_user
; /* Job originating user name */
2434 int password_tries
= 0; /* Password tries */
2438 * Make a copy of the printer connection...
2441 http
= httpConnect2(monitor
->hostname
, monitor
->port
, NULL
, AF_UNSPEC
,
2442 monitor
->encryption
, 1, 0, NULL
);
2443 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
2445 cupsSetUser(username
);
2447 cupsSetPasswordCB2((cups_password_cb2_t
)password_cb
, &password_tries
);
2450 * Loop until the job is canceled, aborted, or completed.
2453 delay
= _cupsNextDelay(0, &prev_delay
);
2455 monitor
->job_reasons
= 0;
2457 while (monitor
->job_state
< IPP_JSTATE_CANCELED
&& !job_canceled
)
2460 * Reconnect to the printer as needed...
2463 if (httpGetFd(http
) < 0)
2464 httpReconnect2(http
, 30000, NULL
);
2466 if (httpGetFd(http
) >= 0)
2469 * Connected, so check on the printer state...
2472 monitor
->printer_state
= check_printer_state(http
, monitor
->uri
,
2476 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING
)
2479 if (monitor
->job_id
== 0 && monitor
->create_job
)
2482 * No job-id yet, so continue...
2489 * Check the status of the job itself...
2492 job_op
= (monitor
->job_id
> 0 && monitor
->get_job_attrs
) ?
2493 IPP_OP_GET_JOB_ATTRIBUTES
: IPP_OP_GET_JOBS
;
2494 request
= ippNewRequest(job_op
);
2495 ippSetVersion(request
, monitor
->version
/ 10, monitor
->version
% 10);
2497 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2498 NULL
, monitor
->uri
);
2499 if (job_op
== IPP_OP_GET_JOB_ATTRIBUTES
)
2500 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2503 if (monitor
->user
&& monitor
->user
[0])
2504 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2505 "requesting-user-name", NULL
, monitor
->user
);
2507 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2508 "requested-attributes",
2509 (int)(sizeof(jattrs
) / sizeof(jattrs
[0])), NULL
, jattrs
);
2515 response
= cupsDoRequest(http
, request
, monitor
->resource
);
2517 fprintf(stderr
, "DEBUG: (monitor) %s: %s (%s)\n", ippOpString(job_op
),
2518 ippErrorString(cupsLastError()), cupsLastErrorString());
2520 if (cupsLastError() <= IPP_STATUS_OK_CONFLICTING
)
2523 if (job_op
== IPP_OP_GET_JOB_ATTRIBUTES
)
2525 if ((attr
= ippFindAttribute(response
, "job-state",
2526 IPP_TAG_ENUM
)) != NULL
)
2527 monitor
->job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2529 monitor
->job_state
= IPP_JSTATE_COMPLETED
;
2533 for (attr
= response
->attrs
; attr
; attr
= attr
->next
)
2537 job_state
= IPP_JSTATE_PENDING
;
2540 while (attr
&& attr
->group_tag
!= IPP_TAG_JOB
)
2546 while (attr
&& attr
->group_tag
== IPP_TAG_JOB
)
2548 if (!strcmp(attr
->name
, "job-id") &&
2549 attr
->value_tag
== IPP_TAG_INTEGER
)
2550 job_id
= attr
->values
[0].integer
;
2551 else if (!strcmp(attr
->name
, "job-name") &&
2552 (attr
->value_tag
== IPP_TAG_NAME
||
2553 attr
->value_tag
== IPP_TAG_NAMELANG
))
2554 job_name
= attr
->values
[0].string
.text
;
2555 else if (!strcmp(attr
->name
, "job-state") &&
2556 attr
->value_tag
== IPP_TAG_ENUM
)
2557 job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2558 else if (!strcmp(attr
->name
, "job-originating-user-name") &&
2559 (attr
->value_tag
== IPP_TAG_NAME
||
2560 attr
->value_tag
== IPP_TAG_NAMELANG
))
2561 job_user
= attr
->values
[0].string
.text
;
2566 if (job_id
> 0 && job_name
&& !strcmp(job_name
, monitor
->job_name
) &&
2567 job_user
&& monitor
->user
&& !strcmp(job_user
, monitor
->user
))
2569 monitor
->job_id
= job_id
;
2570 monitor
->job_state
= job_state
;
2579 fprintf(stderr
, "DEBUG: (monitor) job-state = %s\n", ippEnumString("job-state", (int)monitor
->job_state
));
2581 if (!job_canceled
&&
2582 (monitor
->job_state
== IPP_JSTATE_CANCELED
||
2583 monitor
->job_state
== IPP_JSTATE_ABORTED
))
2586 fprintf(stderr
, "DEBUG: (monitor) job_canceled = -1\n");
2589 if ((attr
= ippFindAttribute(response
, "job-state-reasons",
2590 IPP_TAG_KEYWORD
)) != NULL
)
2592 int i
, new_reasons
= 0; /* Looping var, new reasons */
2594 for (i
= 0; i
< attr
->num_values
; i
++)
2596 if (!strcmp(attr
->values
[i
].string
.text
, "account-authorization-failed"))
2597 new_reasons
|= _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
;
2598 else if (!strcmp(attr
->values
[i
].string
.text
, "account-closed"))
2599 new_reasons
|= _CUPS_JSR_ACCOUNT_CLOSED
;
2600 else if (!strcmp(attr
->values
[i
].string
.text
, "account-info-needed"))
2601 new_reasons
|= _CUPS_JSR_ACCOUNT_INFO_NEEDED
;
2602 else if (!strcmp(attr
->values
[i
].string
.text
, "account-limit-reached"))
2603 new_reasons
|= _CUPS_JSR_ACCOUNT_LIMIT_REACHED
;
2604 else if (!strcmp(attr
->values
[i
].string
.text
, "job-password-wait"))
2605 new_reasons
|= _CUPS_JSR_JOB_PASSWORD_WAIT
;
2606 else if (!strcmp(attr
->values
[i
].string
.text
, "job-release-wait"))
2607 new_reasons
|= _CUPS_JSR_JOB_RELEASE_WAIT
;
2608 else if (!strcmp(attr
->values
[i
].string
.text
, "document-format-error"))
2609 new_reasons
|= _CUPS_JSR_DOCUMENT_FORMAT_ERROR
;
2610 else if (!strcmp(attr
->values
[i
].string
.text
, "document-unprintable"))
2611 new_reasons
|= _CUPS_JSR_DOCUMENT_UNPRINTABLE
;
2613 if (!job_canceled
&& (!strncmp(attr
->values
[i
].string
.text
, "job-canceled-", 13) || !strcmp(attr
->values
[i
].string
.text
, "aborted-by-system")))
2617 if (new_reasons
!= monitor
->job_reasons
)
2619 if (new_reasons
& _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
)
2620 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2621 else if (new_reasons
& _CUPS_JSR_ACCOUNT_CLOSED
)
2622 fputs("JOBSTATE: account-closed\n", stderr
);
2623 else if (new_reasons
& _CUPS_JSR_ACCOUNT_INFO_NEEDED
)
2624 fputs("JOBSTATE: account-info-needed\n", stderr
);
2625 else if (new_reasons
& _CUPS_JSR_ACCOUNT_LIMIT_REACHED
)
2626 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2627 else if (new_reasons
& _CUPS_JSR_JOB_PASSWORD_WAIT
)
2628 fputs("JOBSTATE: job-password-wait\n", stderr
);
2629 else if (new_reasons
& _CUPS_JSR_JOB_RELEASE_WAIT
)
2630 fputs("JOBSTATE: job-release-wait\n", stderr
);
2631 else if (new_reasons
& (_CUPS_JSR_DOCUMENT_FORMAT_ERROR
| _CUPS_JSR_DOCUMENT_UNPRINTABLE
))
2633 if (monitor
->retryable
)
2636 * Can't print this, so retry as raster...
2640 fputs("JOBSTATE: cups-retry-as-raster\n", stderr
);
2642 else if (new_reasons
& _CUPS_JSR_DOCUMENT_FORMAT_ERROR
)
2644 fputs("JOBSTATE: document-format-error\n", stderr
);
2648 fputs("JOBSTATE: document-unprintable\n", stderr
);
2652 fputs("JOBSTATE: job-printing\n", stderr
);
2654 monitor
->job_reasons
= new_reasons
;
2658 ippDelete(response
);
2660 fprintf(stderr
, "DEBUG: (monitor) job-state = %s\n", ippEnumString("job-state", (int)monitor
->job_state
));
2662 if (!job_canceled
&&
2663 (monitor
->job_state
== IPP_JSTATE_CANCELED
||
2664 monitor
->job_state
== IPP_JSTATE_ABORTED
))
2669 * Sleep for N seconds...
2674 sleep((unsigned)delay
);
2676 delay
= _cupsNextDelay(delay
, &prev_delay
);
2680 * Cancel the job if necessary...
2683 if (job_canceled
> 0 && monitor
->job_id
> 0)
2685 if (httpGetFd(http
) < 0)
2686 httpReconnect2(http
, 30000, NULL
);
2688 if (httpGetFd(http
) >= 0)
2690 cancel_job(http
, monitor
->uri
, monitor
->job_id
, monitor
->resource
,
2691 monitor
->user
, monitor
->version
);
2693 if (cupsLastError() > IPP_STATUS_OK_CONFLICTING
)
2695 fprintf(stderr
, "DEBUG: (monitor) cancel_job() = %s\n", cupsLastErrorString());
2696 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2702 * Cleanup and return...
2712 * 'new_request()' - Create a new print creation or validation request.
2715 static ipp_t
* /* O - Request data */
2717 ipp_op_t op
, /* I - IPP operation code */
2718 int version
, /* I - IPP version number */
2719 const char *uri
, /* I - printer-uri value */
2720 const char *user
, /* I - requesting-user-name value */
2721 const char *title
, /* I - job-name value */
2722 int num_options
, /* I - Number of options to send */
2723 cups_option_t
*options
, /* I - Options to send */
2724 const char *compression
, /* I - compression value or NULL */
2725 int copies
, /* I - copies value or 0 */
2726 const char *format
, /* I - document-format value or NULL */
2727 _ppd_cache_t
*pc
, /* I - PPD cache and mapping data */
2728 ppd_file_t
*ppd
, /* I - PPD file data */
2729 ipp_attribute_t
*media_col_sup
, /* I - media-col-supported values */
2730 ipp_attribute_t
*doc_handling_sup
, /* I - multiple-document-handling-supported values */
2731 ipp_attribute_t
*print_color_mode_sup
)
2732 /* I - Printer supports print-color-mode */
2734 ipp_t
*request
; /* Request data */
2735 const char *keyword
; /* PWG keyword */
2739 * Create the IPP request...
2742 request
= ippNewRequest(op
);
2743 ippSetVersion(request
, version
/ 10, version
% 10);
2745 fprintf(stderr
, "DEBUG: %s IPP/%d.%d\n",
2746 ippOpString(request
->request
.op
.operation_id
),
2747 request
->request
.op
.version
[0],
2748 request
->request
.op
.version
[1]);
2751 * Add standard attributes...
2754 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri", NULL
, uri
);
2755 fprintf(stderr
, "DEBUG: printer-uri=\"%s\"\n", uri
);
2759 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "requesting-user-name", NULL
, user
);
2760 fprintf(stderr
, "DEBUG: requesting-user-name=\"%s\"\n", user
);
2763 if (title
&& *title
)
2765 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
, title
);
2766 fprintf(stderr
, "DEBUG: job-name=\"%s\"\n", title
);
2769 if (format
&& op
!= IPP_OP_CREATE_JOB
)
2771 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
, "document-format", NULL
, format
);
2772 fprintf(stderr
, "DEBUG: document-format=\"%s\"\n", format
);
2776 if (compression
&& op
!= IPP_OP_CREATE_JOB
&& op
!= IPP_OP_VALIDATE_JOB
)
2778 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
, "compression", NULL
, compression
);
2779 fprintf(stderr
, "DEBUG: compression=\"%s\"\n", compression
);
2781 #endif /* HAVE_LIBZ */
2784 * Handle options on the command-line...
2787 if (num_options
> 0)
2792 * Send standard IPP attributes...
2795 fputs("DEBUG: Adding standard IPP operation/job attributes.\n", stderr
);
2797 copies
= _cupsConvertOptions(request
, ppd
, pc
, media_col_sup
, doc_handling_sup
, print_color_mode_sup
, user
, format
, copies
, num_options
, options
);
2800 * Map FaxOut options...
2803 if ((keyword
= cupsGetOption("phone", num_options
, options
)) != NULL
)
2805 ipp_t
*destination
; /* destination collection */
2806 char phone
[1024], /* Phone number string */
2807 *ptr
, /* Pointer into string */
2808 tel_uri
[1024]; /* tel: URI */
2809 static const char * const allowed
= "0123456789#*-+.()pw";
2810 /* Allowed characters */
2812 destination
= ippNew();
2815 * Unescape and filter out spaces and other characters that are not
2816 * allowed in a tel: URI.
2819 _httpDecodeURI(phone
, keyword
, sizeof(phone
));
2820 for (ptr
= phone
; *ptr
;)
2824 else if (!strchr(allowed
, *ptr
))
2825 _cups_strcpy(ptr
, ptr
+ 1);
2830 httpAssembleURI(HTTP_URI_CODING_ALL
, tel_uri
, sizeof(tel_uri
), "tel", NULL
, NULL
, 0, phone
);
2831 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_URI
, "destination-uri", NULL
, tel_uri
);
2833 if ((keyword
= cupsGetOption("faxPrefix", num_options
,
2834 options
)) != NULL
&& *keyword
)
2836 char predial
[1024]; /* Pre-dial string */
2838 _httpDecodeURI(predial
, keyword
, sizeof(predial
));
2839 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_TEXT
, "pre-dial-string", NULL
, predial
);
2842 ippAddCollection(request
, IPP_TAG_JOB
, "destination-uris", destination
);
2843 ippDelete(destination
);
2849 * When talking to another CUPS server, send all options...
2852 fputs("DEBUG: Adding all operation/job attributes.\n", stderr
);
2853 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_OPERATION
);
2854 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_JOB
);
2857 if (copies
> 1 && (!pc
|| copies
<= pc
->max_copies
))
2858 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies", copies
);
2861 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10, ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2862 debug_attributes(request
);
2869 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
2872 static const char * /* O - Password */
2873 password_cb(const char *prompt
, /* I - Prompt (not used) */
2874 http_t
*http
, /* I - Connection */
2875 const char *method
, /* I - Request method (not used) */
2876 const char *resource
, /* I - Resource path (not used) */
2877 int *password_tries
) /* I - Password tries */
2879 char def_username
[HTTP_MAX_VALUE
]; /* Default username */
2882 fprintf(stderr
, "DEBUG: password_cb(prompt=\"%s\", http=%p, method=\"%s\", "
2883 "resource=\"%s\", password_tries=%p(%d)), password=%p\n",
2884 prompt
, http
, method
, resource
, password_tries
, *password_tries
,
2891 if (!uri_credentials
)
2894 * Remember that we need to authenticate...
2897 auth_info_required
= "username,password";
2899 if (httpGetSubField(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "username",
2902 char quoted
[HTTP_MAX_VALUE
* 2 + 4];
2905 fprintf(stderr
, "ATTR: auth-info-default=%s,\n",
2906 quote_string(def_username
, quoted
, sizeof(quoted
)));
2910 if (password
&& *password
&& *password_tries
< 3)
2912 (*password_tries
) ++;
2914 cupsSetUser(username
);
2921 * Give up after 3 tries or if we don't have a password to begin with...
2930 * 'quote_string()' - Quote a string value.
2933 static const char * /* O - Quoted string */
2934 quote_string(const char *s
, /* I - String */
2935 char *q
, /* I - Quoted string buffer */
2936 size_t qsize
) /* I - Size of quoted string buffer */
2938 char *qptr
, /* Pointer into string buffer */
2939 *qend
; /* End of string buffer */
2943 qend
= q
+ qsize
- 5;
2954 while (*s
&& qptr
< qend
)
2956 if (*s
== '\\' || *s
== '\"' || *s
== '\'')
2958 if (qptr
< (qend
- 4))
2980 * 'report_attr()' - Report an IPP attribute value.
2984 report_attr(ipp_attribute_t
*attr
) /* I - Attribute */
2986 int i
; /* Looping var */
2987 char value
[1024], /* Value string */
2988 *valptr
; /* Pointer into value string */
2989 const char *cached
; /* Cached attribute */
2993 * Convert the attribute values into quoted strings...
2996 for (i
= 0, valptr
= value
;
2997 i
< attr
->num_values
&& valptr
< (value
+ sizeof(value
) - 10);
3003 switch (attr
->value_tag
)
3005 case IPP_TAG_INTEGER
:
3007 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), "%d", attr
->values
[i
].integer
);
3008 valptr
+= strlen(valptr
);
3013 case IPP_TAG_KEYWORD
:
3014 quote_string(attr
->values
[i
].string
.text
, valptr
, (size_t)(value
+ sizeof(value
) - valptr
));
3015 valptr
+= strlen(valptr
);
3020 * Unsupported value type...
3029 _cupsMutexLock(&report_mutex
);
3031 if ((cached
= cupsGetOption(attr
->name
, num_attr_cache
,
3032 attr_cache
)) == NULL
|| strcmp(cached
, value
))
3035 * Tell the scheduler about the new values...
3038 num_attr_cache
= cupsAddOption(attr
->name
, value
, num_attr_cache
,
3040 fprintf(stderr
, "ATTR: %s=%s\n", attr
->name
, value
);
3043 _cupsMutexUnlock(&report_mutex
);
3048 * 'report_printer_state()' - Report the printer state.
3052 report_printer_state(ipp_t
*ipp
) /* I - IPP response */
3054 ipp_attribute_t
*pa
, /* printer-alert */
3055 *pam
, /* printer-alert-message */
3056 *pmja
, /* printer-mandatory-job-attributes */
3057 *psm
, /* printer-state-message */
3058 *reasons
, /* printer-state-reasons */
3059 *marker
; /* marker-* attributes */
3060 char value
[1024], /* State/message string */
3061 *valptr
; /* Pointer into string */
3062 static int ipp_supplies
= -1;
3063 /* Report supply levels? */
3067 * Report alerts and messages...
3070 if ((pa
= ippFindAttribute(ipp
, "printer-alert", IPP_TAG_TEXT
)) != NULL
)
3073 if ((pam
= ippFindAttribute(ipp
, "printer-alert-message",
3074 IPP_TAG_TEXT
)) != NULL
)
3077 if ((pmja
= ippFindAttribute(ipp
, "printer-mandatory-job-attributes", IPP_TAG_KEYWORD
)) != NULL
)
3079 int i
, /* Looping var */
3080 count
= ippGetCount(pmja
); /* Number of values */
3082 for (i
= 0, valptr
= value
; i
< count
; i
++, valptr
+= strlen(valptr
))
3085 snprintf(valptr
, sizeof(value
) - (size_t)(valptr
- value
), " %s", ippGetString(pmja
, i
, NULL
));
3087 strlcpy(value
, ippGetString(pmja
, i
, NULL
), sizeof(value
));
3090 if (strcmp(value
, mandatory_attrs
))
3092 strlcpy(mandatory_attrs
, value
, sizeof(mandatory_attrs
));
3093 fprintf(stderr
, "PPD: cupsMandatory=\"%s\"\n", value
);
3097 if ((psm
= ippFindAttribute(ipp
, "printer-state-message",
3098 IPP_TAG_TEXT
)) != NULL
)
3100 char *ptr
; /* Pointer into message */
3103 strlcpy(value
, "INFO: ", sizeof(value
));
3104 for (ptr
= psm
->values
[0].string
.text
, valptr
= value
+ 6;
3105 *ptr
&& valptr
< (value
+ sizeof(value
) - 6);
3108 if (*ptr
< ' ' && *ptr
> 0 && *ptr
!= '\t')
3111 * Substitute "<XX>" for the control character; sprintf is safe because
3112 * we always leave 6 chars free at the end...
3115 sprintf(valptr
, "<%02X>", *ptr
);
3125 fputs(value
, stderr
);
3129 * Now report printer-state-reasons, filtering out some of the reasons we never
3133 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
3134 IPP_TAG_KEYWORD
)) == NULL
)
3137 update_reasons(reasons
, NULL
);
3140 * Relay the current marker-* attribute values...
3143 if (ipp_supplies
< 0)
3145 ppd_file_t
*ppd
; /* PPD file */
3146 ppd_attr_t
*ppdattr
; /* Attribute in PPD file */
3148 if ((ppd
= ppdOpenFile(getenv("PPD"))) != NULL
&&
3149 (ppdattr
= ppdFindAttr(ppd
, "cupsIPPSupplies", NULL
)) != NULL
&&
3150 ppdattr
->value
&& _cups_strcasecmp(ppdattr
->value
, "true"))
3158 if (ipp_supplies
> 0)
3160 if ((marker
= ippFindAttribute(ipp
, "marker-colors", IPP_TAG_NAME
)) != NULL
)
3161 report_attr(marker
);
3162 if ((marker
= ippFindAttribute(ipp
, "marker-high-levels",
3163 IPP_TAG_INTEGER
)) != NULL
)
3164 report_attr(marker
);
3165 if ((marker
= ippFindAttribute(ipp
, "marker-levels",
3166 IPP_TAG_INTEGER
)) != NULL
)
3167 report_attr(marker
);
3168 if ((marker
= ippFindAttribute(ipp
, "marker-low-levels",
3169 IPP_TAG_INTEGER
)) != NULL
)
3170 report_attr(marker
);
3171 if ((marker
= ippFindAttribute(ipp
, "marker-message",
3172 IPP_TAG_TEXT
)) != NULL
)
3173 report_attr(marker
);
3174 if ((marker
= ippFindAttribute(ipp
, "marker-names", IPP_TAG_NAME
)) != NULL
)
3175 report_attr(marker
);
3176 if ((marker
= ippFindAttribute(ipp
, "marker-types",
3177 IPP_TAG_KEYWORD
)) != NULL
)
3178 report_attr(marker
);
3183 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3185 * 'run_as_user()' - Run the IPP backend as the printing user.
3187 * This function uses an XPC-based user agent to run the backend as the printing
3188 * user. We need to do this in order to have access to the user's Kerberos
3192 static int /* O - Exit status */
3193 run_as_user(char *argv
[], /* I - Command-line arguments */
3194 uid_t uid
, /* I - User ID */
3195 const char *device_uri
, /* I - Device URI */
3196 int fd
) /* I - File to print */
3198 const char *auth_negotiate
;/* AUTH_NEGOTIATE env var */
3199 xpc_connection_t conn
; /* Connection to XPC service */
3200 xpc_object_t request
; /* Request message dictionary */
3201 __block xpc_object_t response
; /* Response message dictionary */
3202 dispatch_semaphore_t sem
; /* Semaphore for waiting for response */
3203 int status
= CUPS_BACKEND_FAILED
;
3204 /* Status of request */
3207 fprintf(stderr
, "DEBUG: Running IPP backend as UID %d.\n", (int)uid
);
3210 * Connect to the user agent for the specified UID...
3213 conn
= xpc_connection_create_mach_service(kPMPrintUIToolAgent
,
3214 dispatch_get_global_queue(0, 0), 0);
3217 _cupsLangPrintFilter(stderr
, "ERROR",
3218 _("Unable to start backend process."));
3219 fputs("DEBUG: Unable to create connection to agent.\n", stderr
);
3223 xpc_connection_set_event_handler(conn
,
3224 ^(xpc_object_t event
)
3226 xpc_type_t messageType
= xpc_get_type(event
);
3228 if (messageType
== XPC_TYPE_ERROR
)
3230 if (event
== XPC_ERROR_CONNECTION_INTERRUPTED
)
3231 fprintf(stderr
, "DEBUG: Interrupted connection to service %s.\n",
3232 xpc_connection_get_name(conn
));
3233 else if (event
== XPC_ERROR_CONNECTION_INVALID
)
3234 fprintf(stderr
, "DEBUG: Connection invalid for service %s.\n",
3235 xpc_connection_get_name(conn
));
3237 fprintf(stderr
, "DEBUG: Unxpected error for service %s: %s\n",
3238 xpc_connection_get_name(conn
),
3239 xpc_dictionary_get_string(event
, XPC_ERROR_KEY_DESCRIPTION
));
3242 xpc_connection_set_target_uid(conn
, uid
);
3243 xpc_connection_resume(conn
);
3246 * Try starting the backend...
3249 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3250 xpc_dictionary_set_int64(request
, "command", kPMStartJob
);
3251 xpc_dictionary_set_string(request
, "device-uri", device_uri
);
3252 xpc_dictionary_set_string(request
, "job-id", argv
[1]);
3253 xpc_dictionary_set_string(request
, "user", argv
[2]);
3254 xpc_dictionary_set_string(request
, "title", argv
[3]);
3255 xpc_dictionary_set_string(request
, "copies", argv
[4]);
3256 xpc_dictionary_set_string(request
, "options", argv
[5]);
3257 xpc_dictionary_set_string(request
, "auth-info-required",
3258 getenv("AUTH_INFO_REQUIRED"));
3259 if ((auth_negotiate
= getenv("AUTH_NEGOTIATE")) != NULL
)
3260 xpc_dictionary_set_string(request
, "auth-negotiate", auth_negotiate
);
3261 xpc_dictionary_set_fd(request
, "stdin", fd
);
3262 xpc_dictionary_set_fd(request
, "stderr", 2);
3263 xpc_dictionary_set_fd(request
, "side-channel", CUPS_SC_FD
);
3265 sem
= dispatch_semaphore_create(0);
3268 xpc_connection_send_message_with_reply(conn
, request
,
3269 dispatch_get_global_queue(0,0),
3270 ^(xpc_object_t reply
)
3272 /* Save the response and wake up */
3273 if (xpc_get_type(reply
)
3274 == XPC_TYPE_DICTIONARY
)
3275 response
= xpc_retain(reply
);
3277 dispatch_semaphore_signal(sem
);
3280 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3281 xpc_release(request
);
3282 dispatch_release(sem
);
3286 child_pid
= (pid_t
)xpc_dictionary_get_int64(response
, "child-pid");
3288 xpc_release(response
);
3291 fprintf(stderr
, "DEBUG: Child PID=%d.\n", (int)child_pid
);
3294 _cupsLangPrintFilter(stderr
, "ERROR",
3295 _("Unable to start backend process."));
3296 fputs("DEBUG: No child PID.\n", stderr
);
3302 _cupsLangPrintFilter(stderr
, "ERROR",
3303 _("Unable to start backend process."));
3304 fputs("DEBUG: No reply from agent.\n", stderr
);
3309 * Then wait for the backend to finish...
3312 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3313 xpc_dictionary_set_int64(request
, "command", kPMWaitForJob
);
3314 xpc_dictionary_set_fd(request
, "stderr", 2);
3316 sem
= dispatch_semaphore_create(0);
3319 xpc_connection_send_message_with_reply(conn
, request
,
3320 dispatch_get_global_queue(0,0),
3321 ^(xpc_object_t reply
)
3323 /* Save the response and wake up */
3324 if (xpc_get_type(reply
)
3325 == XPC_TYPE_DICTIONARY
)
3326 response
= xpc_retain(reply
);
3328 dispatch_semaphore_signal(sem
);
3331 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3332 xpc_release(request
);
3333 dispatch_release(sem
);
3337 status
= (int)xpc_dictionary_get_int64(response
, "status");
3339 if (status
== SIGTERM
|| status
== SIGKILL
|| status
== SIGPIPE
)
3341 fprintf(stderr
, "DEBUG: Child terminated on signal %d.\n", status
);
3342 status
= CUPS_BACKEND_FAILED
;
3344 else if (WIFSIGNALED(status
))
3346 fprintf(stderr
, "DEBUG: Child crashed on signal %d.\n", status
);
3347 status
= CUPS_BACKEND_STOP
;
3349 else if (WIFEXITED(status
))
3351 status
= WEXITSTATUS(status
);
3352 fprintf(stderr
, "DEBUG: Child exited with status %d.\n", status
);
3355 xpc_release(response
);
3358 _cupsLangPrintFilter(stderr
, "ERROR",
3359 _("Unable to get backend exit status."));
3365 xpc_connection_cancel(conn
);
3371 #endif /* HAVE_GSSAPI && HAVE_XPC */
3375 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
3379 sigterm_handler(int sig
) /* I - Signal */
3381 (void)sig
; /* remove compiler warnings... */
3383 write(2, "DEBUG: Got SIGTERM.\n", 20);
3385 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3388 kill(child_pid
, sig
);
3391 #endif /* HAVE_GSSAPI && HAVE_XPC */
3396 * Flag that the job should be canceled...
3399 write(2, "DEBUG: sigterm_handler: job_canceled = 1.\n", 25);
3406 * The scheduler already tried to cancel us once, now just terminate
3407 * after removing our temp file!
3411 unlink(tmpfilename
);
3418 * 'timeout_cb()' - Handle HTTP timeouts.
3421 static int /* O - 1 to continue, 0 to cancel */
3422 timeout_cb(http_t
*http
, /* I - Connection to server (unused) */
3423 void *user_data
) /* I - User data (unused) */
3428 return (!job_canceled
);
3433 * 'update_reasons()' - Update the printer-state-reasons values.
3437 update_reasons(ipp_attribute_t
*attr
, /* I - printer-state-reasons or NULL */
3438 const char *s
) /* I - STATE: string or NULL */
3440 char op
; /* Add (+), remove (-), replace (\0) */
3441 cups_array_t
*new_reasons
; /* New reasons array */
3442 char *reason
, /* Current reason */
3443 add
[2048], /* Reasons added string */
3444 *addptr
, /* Pointer into add string */
3445 rem
[2048], /* Reasons removed string */
3446 *remptr
; /* Pointer into remove string */
3447 const char *addprefix
, /* Current add string prefix */
3448 *remprefix
; /* Current remove string prefix */
3451 fprintf(stderr
, "DEBUG: update_reasons(attr=%d(%s%s), s=\"%s\")\n",
3452 attr
? attr
->num_values
: 0, attr
? attr
->values
[0].string
.text
: "",
3453 attr
&& attr
->num_values
> 1 ? ",..." : "", s
? s
: "(null)");
3456 * Create an array of new reason keyword strings...
3461 int i
; /* Looping var */
3463 new_reasons
= cupsArrayNew((cups_array_func_t
)strcmp
, NULL
);
3466 for (i
= 0; i
< attr
->num_values
; i
++)
3468 reason
= attr
->values
[i
].string
.text
;
3470 if (strcmp(reason
, "none") &&
3471 strcmp(reason
, "none-report") &&
3472 strcmp(reason
, "paused") &&
3473 strncmp(reason
, "spool-area-full", 15) &&
3474 strcmp(reason
, "com.apple.print.recoverable-warning") &&
3475 strncmp(reason
, "cups-", 5))
3476 cupsArrayAdd(new_reasons
, reason
);
3481 if (*s
== '+' || *s
== '-')
3486 new_reasons
= _cupsArrayNewStrings(s
, ',');
3492 * Compute the changes...
3496 addprefix
= "STATE: +";
3499 remprefix
= "STATE: -";
3502 fprintf(stderr
, "DEBUG2: op='%c', new_reasons=%d, state_reasons=%d\n",
3503 op
? op
: ' ', cupsArrayCount(new_reasons
),
3504 cupsArrayCount(state_reasons
));
3506 _cupsMutexLock(&report_mutex
);
3514 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3516 reason
= (char *)cupsArrayNext(new_reasons
))
3518 if (!cupsArrayFind(state_reasons
, reason
))
3520 if (!strncmp(reason
, "cups-remote-", 12))
3523 * If we are setting cups-remote-xxx, remove all other cups-remote-xxx
3527 char *temp
; /* Current reason in state_reasons */
3529 cupsArraySave(state_reasons
);
3531 for (temp
= (char *)cupsArrayFirst(state_reasons
);
3533 temp
= (char *)cupsArrayNext(state_reasons
))
3534 if (!strncmp(temp
, "cups-remote-", 12))
3536 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, temp
);
3537 remptr
+= strlen(remptr
);
3540 cupsArrayRemove(state_reasons
, temp
);
3544 cupsArrayRestore(state_reasons
);
3547 cupsArrayAdd(state_reasons
, reason
);
3549 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3550 addptr
+= strlen(addptr
);
3561 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3563 reason
= (char *)cupsArrayNext(new_reasons
))
3565 if (cupsArrayFind(state_reasons
, reason
))
3567 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3568 remptr
+= strlen(remptr
);
3571 cupsArrayRemove(state_reasons
, reason
);
3578 * Replace reasons...
3581 for (reason
= (char *)cupsArrayFirst(state_reasons
);
3583 reason
= (char *)cupsArrayNext(state_reasons
))
3585 if (strncmp(reason
, "cups-", 5) && !cupsArrayFind(new_reasons
, reason
))
3587 snprintf(remptr
, sizeof(rem
) - (size_t)(remptr
- rem
), "%s%s", remprefix
, reason
);
3588 remptr
+= strlen(remptr
);
3591 cupsArrayRemove(state_reasons
, reason
);
3595 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3597 reason
= (char *)cupsArrayNext(new_reasons
))
3599 if (!cupsArrayFind(state_reasons
, reason
))
3601 cupsArrayAdd(state_reasons
, reason
);
3603 snprintf(addptr
, sizeof(add
) - (size_t)(addptr
- add
), "%s%s", addprefix
, reason
);
3604 addptr
+= strlen(addptr
);
3610 cupsArrayDelete(new_reasons
);
3612 _cupsMutexUnlock(&report_mutex
);
3615 * Report changes and return...
3618 if (add
[0] && rem
[0])
3619 fprintf(stderr
, "%s\n%s\n", add
, rem
);
3621 fprintf(stderr
, "%s\n", add
);
3623 fprintf(stderr
, "%s\n", rem
);