2 * "$Id: ipp.c 9759 2011-05-11 03:24:33Z mike $"
4 * IPP backend for CUPS.
6 * Copyright 2007-2012 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * "LICENSE" which should have been included with this file. If this
13 * file is missing or damaged, see the license at "http://www.cups.org/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * main() - Send a file to the printer or server.
20 * cancel_job() - Cancel a print job.
21 * check_printer_state() - Check the printer state.
22 * monitor_printer() - Monitor the printer state.
23 * new_request() - Create a new print creation or validation
25 * password_cb() - Disable the password prompt for
26 * cupsDoFileRequest().
27 * quote_string() - Quote a string value.
28 * report_attr() - Report an IPP attribute value.
29 * report_printer_state() - Report the printer state.
30 * run_as_user() - Run the IPP backend as the printing user.
31 * sigterm_handler() - Handle 'terminate' signals that stop the backend.
32 * timeout_cb() - Handle HTTP timeouts.
33 * update_reasons() - Update the printer-state-reasons values.
37 * Include necessary headers.
40 #include "backend-private.h"
41 #include <cups/array-private.h>
42 #include <sys/types.h>
45 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
47 # define kPMPrintUIToolAgent "com.apple.printuitool.agent"
48 # define kPMStartJob 100
49 # define kPMWaitForJob 101
50 # ifdef HAVE_XPC_PRIVATE_H
51 # include <xpc/private.h>
53 extern void xpc_connection_set_target_uid(xpc_connection_t connection
,
55 # endif /* HAVE_XPC_PRIVATE_H */
56 #endif /* HAVE_GSSAPI && HAVE_XPC */
60 * Bits for job-state-reasons we care about...
63 #define _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED 0x01
64 #define _CUPS_JSR_ACCOUNT_CLOSED 0x02
65 #define _CUPS_JSR_ACCOUNT_INFO_NEEDED 0x04
66 #define _CUPS_JSR_ACCOUNT_LIMIT_REACHED 0x08
67 #define _CUPS_JSR_JOB_PASSWORD_WAIT 0x10
68 #define _CUPS_JSR_JOB_RELEASE_WAIT 0x20
75 typedef struct _cups_monitor_s
/**** Monitoring data ****/
77 const char *uri
, /* Printer URI */
78 *hostname
, /* Hostname */
80 *resource
; /* Resource path */
81 int port
, /* Port number */
82 version
, /* IPP version */
83 job_id
, /* Job ID for submitted job */
84 job_reasons
, /* Job state reasons bits */
85 get_job_attrs
; /* Support Get-Job-Attributes? */
86 const char *job_name
; /* Job name for submitted job */
87 http_encryption_t encryption
; /* Use encryption? */
88 ipp_jstate_t job_state
; /* Current job state */
89 ipp_pstate_t printer_state
; /* Current printer state */
97 static const char *auth_info_required
;
98 /* New auth-info-required value */
99 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
100 static int child_pid
= 0; /* Child process ID */
101 #endif /* HAVE_GSSAPI && HAVE_XPC */
102 static const char * const jattrs
[] = /* Job attributes we want */
105 "job-impressions-completed",
106 "job-media-sheets-completed",
108 "job-originating-user-name",
112 static int job_canceled
= 0;
114 static char username
[256] = "",
115 /* Username for device URI */
117 /* Password for device URI */
118 static int password_tries
= 0;
120 static const char * const pattrs
[] = /* Printer attributes we want */
123 "compression-supported",
124 #endif /* HAVE_LIBZ */
127 "document-format-supported",
129 "marker-high-levels",
135 "media-col-supported",
136 "multiple-document-handling-supported",
137 "operations-supported",
139 "printer-alert-description",
140 "printer-is-accepting-jobs",
142 "printer-state-message",
143 "printer-state-reasons"
145 static const char * const remote_job_states
[] =
146 { /* Remote job state keywords */
147 "+cups-remote-pending",
148 "+cups-remote-pending-held",
149 "+cups-remote-processing",
150 "+cups-remote-stopped",
151 "+cups-remote-canceled",
152 "+cups-remote-aborted",
153 "+cups-remote-completed"
155 static _cups_mutex_t report_mutex
= _CUPS_MUTEX_INITIALIZER
;
156 /* Mutex to control access */
157 static int num_attr_cache
= 0;
158 /* Number of cached attributes */
159 static cups_option_t
*attr_cache
= NULL
;
160 /* Cached attributes */
161 static cups_array_t
*state_reasons
; /* Array of printe-state-reasons keywords */
162 static char tmpfilename
[1024] = "";
163 /* Temporary spool file name */
170 static void cancel_job(http_t
*http
, const char *uri
, int id
,
171 const char *resource
, const char *user
,
173 static ipp_pstate_t
check_printer_state(http_t
*http
, const char *uri
,
174 const char *resource
,
175 const char *user
, int version
);
176 static void *monitor_printer(_cups_monitor_t
*monitor
);
177 static ipp_t
*new_request(ipp_op_t op
, int version
, const char *uri
,
178 const char *user
, const char *title
,
179 int num_options
, cups_option_t
*options
,
180 const char *compression
, int copies
,
181 const char *format
, _ppd_cache_t
*pc
,
183 ipp_attribute_t
*media_col_sup
,
184 ipp_attribute_t
*doc_handling_sup
,
185 int print_color_mode
);
186 static const char *password_cb(const char *prompt
, http_t
*http
,
187 const char *method
, const char *resource
,
189 static const char *quote_string(const char *s
, char *q
, size_t qsize
);
190 static void report_attr(ipp_attribute_t
*attr
);
191 static void report_printer_state(ipp_t
*ipp
);
192 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
193 static int run_as_user(char *argv
[], uid_t uid
,
194 const char *device_uri
, int fd
);
195 #endif /* HAVE_GSSAPI && HAVE_XPC */
196 static void sigterm_handler(int sig
);
197 static int timeout_cb(http_t
*http
, void *user_data
);
198 static void update_reasons(ipp_attribute_t
*attr
, const char *s
);
202 * 'main()' - Send a file to the printer or server.
206 * printer-uri job-id user title copies options [file]
209 int /* O - Exit status */
210 main(int argc
, /* I - Number of command-line args */
211 char *argv
[]) /* I - Command-line arguments */
213 int i
; /* Looping var */
214 int send_options
; /* Send job options? */
215 int num_options
; /* Number of printer options */
216 cups_option_t
*options
; /* Printer options */
217 const char *device_uri
; /* Device URI */
218 char scheme
[255], /* Scheme in URI */
219 hostname
[1024], /* Hostname */
220 resource
[1024], /* Resource info (printer name) */
221 addrname
[256], /* Address name */
222 *optptr
, /* Pointer to URI options */
223 *name
, /* Name of option */
224 *value
, /* Value of option */
225 sep
; /* Separator character */
226 http_addrlist_t
*addrlist
; /* Address of printer */
227 int snmp_enabled
= 1; /* Is SNMP enabled? */
228 int snmp_fd
, /* SNMP socket */
229 start_count
, /* Page count via SNMP at start */
230 page_count
, /* Page count via SNMP */
231 have_supplies
; /* Printer supports supply levels? */
232 int num_files
; /* Number of files to print */
233 char **files
, /* Files to print */
234 *compatfile
= NULL
; /* Compatibility filename */
235 off_t compatsize
= 0; /* Size of compatibility file */
236 int port
; /* Port number (not used) */
237 char portname
[255]; /* Port name */
238 char uri
[HTTP_MAX_URI
]; /* Updated URI without user/pass */
239 char print_job_name
[1024]; /* Update job-name for Print-Job */
240 http_status_t http_status
; /* Status of HTTP request */
241 ipp_status_t ipp_status
; /* Status of IPP request */
242 http_t
*http
; /* HTTP connection */
243 ipp_t
*request
, /* IPP request */
244 *response
, /* IPP response */
245 *supported
; /* get-printer-attributes response */
246 time_t start_time
; /* Time of first connect */
247 int contimeout
; /* Connection timeout */
248 int delay
, /* Delay for retries */
249 prev_delay
; /* Previous delay */
250 const char *compression
; /* Compression mode */
251 int waitjob
, /* Wait for job complete? */
252 waitjob_tries
= 0, /* Number of times we've waited */
253 waitprinter
; /* Wait for printer ready? */
254 _cups_monitor_t monitor
; /* Monitoring data */
255 ipp_attribute_t
*job_id_attr
; /* job-id attribute */
256 int job_id
; /* job-id value */
257 ipp_attribute_t
*job_sheets
; /* job-media-sheets-completed */
258 ipp_attribute_t
*job_state
; /* job-state */
260 ipp_attribute_t
*compression_sup
; /* compression-supported */
261 #endif /* HAVE_LIBZ */
262 ipp_attribute_t
*copies_sup
; /* copies-supported */
263 ipp_attribute_t
*cups_version
; /* cups-version */
264 ipp_attribute_t
*format_sup
; /* document-format-supported */
265 ipp_attribute_t
*media_col_sup
; /* media-col-supported */
266 ipp_attribute_t
*operations_sup
; /* operations-supported */
267 ipp_attribute_t
*doc_handling_sup
; /* multiple-document-handling-supported */
268 ipp_attribute_t
*printer_state
; /* printer-state attribute */
269 ipp_attribute_t
*printer_accepting
; /* printer-is-accepting-jobs */
270 int create_job
= 0, /* Does printer support Create-Job? */
271 get_job_attrs
= 0, /* Does printer support Get-Job-Attributes? */
272 send_document
= 0, /* Does printer support Send-Document? */
273 validate_job
= 0, /* Does printer support Validate-Job? */
274 print_color_mode
= 0; /* Does printer support print-color-mode? */
275 int copies
, /* Number of copies for job */
276 copies_remaining
; /* Number of copies remaining */
277 const char *content_type
, /* CONTENT_TYPE environment variable */
278 *final_content_type
, /* FINAL_CONTENT_TYPE environment var */
279 *document_format
; /* document-format value */
280 int fd
; /* File descriptor */
281 off_t bytes
= 0; /* Bytes copied */
282 char buffer
[16384]; /* Copy buffer */
283 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
284 struct sigaction action
; /* Actions for POSIX signals */
285 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
286 int version
; /* IPP version */
287 ppd_file_t
*ppd
= NULL
; /* PPD file */
288 _ppd_cache_t
*pc
= NULL
; /* PPD cache and mapping data */
289 fd_set input
; /* Input set for select() */
293 * Make sure status messages are not buffered...
296 setbuf(stderr
, NULL
);
299 * Ignore SIGPIPE and catch SIGTERM signals...
303 sigset(SIGPIPE
, SIG_IGN
);
304 sigset(SIGTERM
, sigterm_handler
);
305 #elif defined(HAVE_SIGACTION)
306 memset(&action
, 0, sizeof(action
));
307 action
.sa_handler
= SIG_IGN
;
308 sigaction(SIGPIPE
, &action
, NULL
);
310 sigemptyset(&action
.sa_mask
);
311 sigaddset(&action
.sa_mask
, SIGTERM
);
312 action
.sa_handler
= sigterm_handler
;
313 sigaction(SIGTERM
, &action
, NULL
);
315 signal(SIGPIPE
, SIG_IGN
);
316 signal(SIGTERM
, sigterm_handler
);
317 #endif /* HAVE_SIGSET */
320 * Check command-line...
327 if ((s
= strrchr(argv
[0], '/')) != NULL
)
332 printf("network %s \"Unknown\" \"%s (%s)\"\n",
333 s
, _cupsLangString(cupsLangDefault(),
334 _("Internet Printing Protocol")), s
);
335 return (CUPS_BACKEND_OK
);
339 _cupsLangPrintf(stderr
,
340 _("Usage: %s job-id user title copies options [file]"),
342 return (CUPS_BACKEND_STOP
);
346 * Get the device URI...
349 while ((device_uri
= cupsBackendDeviceURI(argv
)) == NULL
)
351 _cupsLangPrintFilter(stderr
, "INFO", _("Unable to locate printer."));
354 if (getenv("CLASS") != NULL
)
355 return (CUPS_BACKEND_FAILED
);
358 if ((auth_info_required
= getenv("AUTH_INFO_REQUIRED")) == NULL
)
359 auth_info_required
= "none";
361 state_reasons
= _cupsArrayNewStrings(getenv("PRINTER_STATE_REASONS"), ',');
365 * For Kerberos, become the printing user (if we can) to get the credentials
369 if (!getuid() && (value
= getenv("AUTH_UID")) != NULL
)
371 uid_t uid
= (uid_t
)atoi(value
);
378 return (run_as_user(argv
, uid
, device_uri
, 0));
381 int status
= 0; /* Exit status */
383 for (i
= 6; i
< argc
&& !status
&& !job_canceled
; i
++)
385 if ((fd
= open(argv
[i
], O_RDONLY
)) >= 0)
387 status
= run_as_user(argv
, uid
, device_uri
, fd
);
392 _cupsLangPrintError("ERROR", _("Unable to open print file"));
393 status
= CUPS_BACKEND_FAILED
;
401 # else /* No XPC, just try to run as the user ID */
404 # endif /* HAVE_XPC */
406 #endif /* HAVE_GSSAPI */
409 * Get the (final) content type...
412 if ((content_type
= getenv("CONTENT_TYPE")) == NULL
)
413 content_type
= "application/octet-stream";
415 if ((final_content_type
= getenv("FINAL_CONTENT_TYPE")) == NULL
)
417 final_content_type
= content_type
;
419 if (!strncmp(final_content_type
, "printer/", 8))
420 final_content_type
= "application/vnd.cups-raw";
424 * Extract the hostname and printer name from the URI...
427 httpSeparateURI(HTTP_URI_CODING_ALL
, device_uri
, scheme
, sizeof(scheme
),
428 username
, sizeof(username
), hostname
, sizeof(hostname
), &port
,
429 resource
, sizeof(resource
));
432 port
= IPP_PORT
; /* Default to port 631 */
434 if (!strcmp(scheme
, "https"))
435 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
437 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
440 * See if there are any options...
447 contimeout
= 7 * 24 * 60 * 60;
449 if ((optptr
= strchr(resource
, '?')) != NULL
)
452 * Yup, terminate the device name string and move to the first
453 * character of the optptr...
459 * Then parse the optptr...
470 while (*optptr
&& *optptr
!= '=' && *optptr
!= '+' && *optptr
!= '&')
473 if ((sep
= *optptr
) != '\0')
484 while (*optptr
&& *optptr
!= '+' && *optptr
!= '&')
494 * Process the option...
497 if (!_cups_strcasecmp(name
, "waitjob"))
500 * Wait for job completion?
503 waitjob
= !_cups_strcasecmp(value
, "on") ||
504 !_cups_strcasecmp(value
, "yes") ||
505 !_cups_strcasecmp(value
, "true");
507 else if (!_cups_strcasecmp(name
, "waitprinter"))
510 * Wait for printer idle?
513 waitprinter
= !_cups_strcasecmp(value
, "on") ||
514 !_cups_strcasecmp(value
, "yes") ||
515 !_cups_strcasecmp(value
, "true");
517 else if (!_cups_strcasecmp(name
, "encryption"))
520 * Enable/disable encryption?
523 if (!_cups_strcasecmp(value
, "always"))
524 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
525 else if (!_cups_strcasecmp(value
, "required"))
526 cupsSetEncryption(HTTP_ENCRYPT_REQUIRED
);
527 else if (!_cups_strcasecmp(value
, "never"))
528 cupsSetEncryption(HTTP_ENCRYPT_NEVER
);
529 else if (!_cups_strcasecmp(value
, "ifrequested"))
530 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
533 _cupsLangPrintFilter(stderr
, "ERROR",
534 _("Unknown encryption option value: \"%s\"."),
538 else if (!_cups_strcasecmp(name
, "snmp"))
541 * Enable/disable SNMP stuff...
544 snmp_enabled
= !value
[0] || !_cups_strcasecmp(value
, "on") ||
545 _cups_strcasecmp(value
, "yes") ||
546 _cups_strcasecmp(value
, "true");
548 else if (!_cups_strcasecmp(name
, "version"))
550 if (!strcmp(value
, "1.0"))
552 else if (!strcmp(value
, "1.1"))
554 else if (!strcmp(value
, "2.0"))
556 else if (!strcmp(value
, "2.1"))
558 else if (!strcmp(value
, "2.2"))
562 _cupsLangPrintFilter(stderr
, "ERROR",
563 _("Unknown version option value: \"%s\"."),
568 else if (!_cups_strcasecmp(name
, "compression"))
570 if (!_cups_strcasecmp(value
, "true") || !_cups_strcasecmp(value
, "yes") ||
571 !_cups_strcasecmp(value
, "on") || !_cups_strcasecmp(value
, "gzip"))
572 compression
= "gzip";
573 else if (!_cups_strcasecmp(value
, "deflate"))
574 compression
= "deflate";
575 else if (!_cups_strcasecmp(value
, "false") ||
576 !_cups_strcasecmp(value
, "no") ||
577 !_cups_strcasecmp(value
, "off") ||
578 !_cups_strcasecmp(value
, "none"))
579 compression
= "none";
581 #endif /* HAVE_LIBZ */
582 else if (!_cups_strcasecmp(name
, "contimeout"))
585 * Set the connection timeout...
589 contimeout
= atoi(value
);
597 _cupsLangPrintFilter(stderr
, "ERROR",
598 _("Unknown option \"%s\" with value \"%s\"."),
605 * If we have 7 arguments, print the file named on the command-line.
606 * Otherwise, copy stdin to a temporary file and print the temporary
614 send_options
= !_cups_strcasecmp(final_content_type
, "application/pdf") ||
615 !_cups_strcasecmp(final_content_type
, "application/vnd.cups-pdf") ||
616 !_cups_strncasecmp(final_content_type
, "image/", 6);
618 fputs("DEBUG: Sending stdin for job...\n", stderr
);
623 * Point to the files on the command-line...
626 num_files
= argc
- 6;
630 fprintf(stderr
, "DEBUG: %d files to send in job...\n", num_files
);
634 * Set the authentication info, if any...
637 cupsSetPasswordCB2(password_cb
, NULL
);
642 * Use authentication information in the device URI...
645 if ((password
= strchr(username
, ':')) != NULL
)
648 cupsSetUser(username
);
653 * Try loading authentication information from the environment.
656 const char *ptr
= getenv("AUTH_USERNAME");
660 strlcpy(username
, ptr
, sizeof(username
));
664 password
= getenv("AUTH_PASSWORD");
668 * Try finding the remote server...
671 start_time
= time(NULL
);
673 sprintf(portname
, "%d", port
);
675 update_reasons(NULL
, "+connecting-to-device");
676 fprintf(stderr
, "DEBUG: Looking up \"%s\"...\n", hostname
);
678 while ((addrlist
= httpAddrGetList(hostname
, AF_UNSPEC
, portname
)) == NULL
)
680 _cupsLangPrintFilter(stderr
, "INFO",
681 _("Unable to locate printer \"%s\"."), hostname
);
684 if (getenv("CLASS") != NULL
)
686 update_reasons(NULL
, "-connecting-to-device");
687 return (CUPS_BACKEND_STOP
);
691 return (CUPS_BACKEND_OK
);
694 http
= _httpCreate(hostname
, port
, addrlist
, AF_UNSPEC
, cupsEncryption(), 1,
696 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
699 * See if the printer supports SNMP...
703 snmp_fd
= _cupsSNMPOpen(addrlist
->addr
.addr
.sa_family
);
708 have_supplies
= !backendSNMPSupplies(snmp_fd
, &(addrlist
->addr
),
711 have_supplies
= start_count
= 0;
714 * Wait for data from the filter...
719 if (!backendWaitLoop(snmp_fd
, &(addrlist
->addr
), 0, backendNetworkSideCB
))
720 return (CUPS_BACKEND_OK
);
721 else if ((bytes
= read(0, buffer
, sizeof(buffer
))) <= 0)
722 return (CUPS_BACKEND_OK
);
726 * Try connecting to the remote server...
729 delay
= _cupsNextDelay(0, &prev_delay
);
733 fprintf(stderr
, "DEBUG: Connecting to %s:%d\n", hostname
, port
);
734 _cupsLangPrintFilter(stderr
, "INFO", _("Connecting to printer."));
736 if (httpReconnect(http
))
738 int error
= errno
; /* Connection error */
740 if (http
->status
== HTTP_PKI_ERROR
)
741 update_reasons(NULL
, "+cups-certificate-error");
746 if (getenv("CLASS") != NULL
)
749 * If the CLASS environment variable is set, the job was submitted
750 * to a class and not to a specific queue. In this case, we want
751 * to abort immediately so that the job can be requeued on the next
752 * available printer in the class.
755 _cupsLangPrintFilter(stderr
, "INFO",
756 _("Unable to contact printer, queuing on next "
757 "printer in class."));
760 * Sleep 5 seconds to keep the job from requeuing too rapidly...
765 update_reasons(NULL
, "-connecting-to-device");
767 return (CUPS_BACKEND_FAILED
);
770 fprintf(stderr
, "DEBUG: Connection error: %s\n", strerror(errno
));
772 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
||
773 errno
== EHOSTUNREACH
)
775 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
777 _cupsLangPrintFilter(stderr
, "ERROR",
778 _("The printer is not responding."));
779 update_reasons(NULL
, "-connecting-to-device");
780 return (CUPS_BACKEND_FAILED
);
786 _cupsLangPrintFilter(stderr
, "WARNING",
787 _("The printer may not exist or "
788 "is unavailable at this time."));
792 _cupsLangPrintFilter(stderr
, "WARNING",
793 _("The printer is unreachable at this "
799 _cupsLangPrintFilter(stderr
, "WARNING",
800 _("The printer is in use."));
806 delay
= _cupsNextDelay(delay
, &prev_delay
);
810 _cupsLangPrintFilter(stderr
, "ERROR",
811 _("The printer is not responding."));
819 update_reasons(NULL
, "-cups-certificate-error");
821 while (http
->fd
< 0);
824 return (CUPS_BACKEND_OK
);
826 return (CUPS_BACKEND_FAILED
);
828 update_reasons(NULL
, "-connecting-to-device");
829 _cupsLangPrintFilter(stderr
, "INFO", _("Connected to printer."));
831 fprintf(stderr
, "DEBUG: Connected to %s:%d...\n",
832 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
833 httpAddrPort(http
->hostaddr
));
836 * Build a URI for the printer and fill the standard IPP attributes for
837 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
838 * might contain username:password information...
841 httpAssembleURI(HTTP_URI_CODING_ALL
, uri
, sizeof(uri
), scheme
, NULL
, hostname
,
845 * First validate the destination and see if the device supports multiple
850 compression_sup
= NULL
;
851 #endif /* HAVE_LIBZ */
855 media_col_sup
= NULL
;
857 operations_sup
= NULL
;
858 doc_handling_sup
= NULL
;
863 * Check for side-channel requests...
866 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
869 * Build the IPP request...
872 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
873 request
->request
.op
.version
[0] = version
/ 10;
874 request
->request
.op
.version
[1] = version
% 10;
876 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
879 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
880 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
887 fputs("DEBUG: Getting supported attributes...\n", stderr
);
889 if (http
->version
< HTTP_1_1
)
891 fprintf(stderr
, "DEBUG: Printer responded with HTTP version %d.%d.\n",
892 http
->version
/ 100, http
->version
% 100);
893 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
894 "cups-ipp-wrong-http-version");
897 supported
= cupsDoRequest(http
, request
, resource
);
898 ipp_status
= cupsLastError();
900 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
901 ippErrorString(ipp_status
), cupsLastErrorString());
903 if (ipp_status
<= IPP_OK_CONFLICT
)
907 fprintf(stderr
, "DEBUG: Get-Printer-Attributes returned %s.\n",
908 ippErrorString(ipp_status
));
910 if (ipp_status
== IPP_PRINTER_BUSY
||
911 ipp_status
== IPP_SERVICE_UNAVAILABLE
)
913 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
915 _cupsLangPrintFilter(stderr
, "ERROR",
916 _("The printer is not responding."));
917 return (CUPS_BACKEND_FAILED
);
920 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
922 report_printer_state(supported
);
926 delay
= _cupsNextDelay(delay
, &prev_delay
);
928 else if ((ipp_status
== IPP_BAD_REQUEST
||
929 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
> 10)
932 * Switch to IPP/1.1 or IPP/1.0...
937 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
939 "DEBUG: The printer does not support IPP/%d.%d, trying "
940 "IPP/1.1.\n", version
/ 10, version
% 10);
945 _cupsLangPrintFilter(stderr
, "INFO", _("Preparing to print."));
947 "DEBUG: The printer does not support IPP/%d.%d, trying "
948 "IPP/1.0.\n", version
/ 10, version
% 10);
954 else if (ipp_status
== IPP_NOT_FOUND
)
956 _cupsLangPrintFilter(stderr
, "ERROR",
957 _("The printer configuration is incorrect or the "
958 "printer no longer exists."));
960 ippDelete(supported
);
962 return (CUPS_BACKEND_STOP
);
964 else if (ipp_status
== IPP_FORBIDDEN
||
965 ipp_status
== IPP_AUTHENTICATION_CANCELED
)
967 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
968 /* WWW-Authenticate field value */
970 if (!strncmp(www_auth
, "Negotiate", 9))
971 auth_info_required
= "negotiate";
972 else if (www_auth
[0])
973 auth_info_required
= "username,password";
975 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
976 return (CUPS_BACKEND_AUTH_REQUIRED
);
978 else if (ipp_status
!= IPP_NOT_AUTHORIZED
)
980 _cupsLangPrintFilter(stderr
, "ERROR",
981 _("Unable to get printer status."));
987 ippDelete(supported
);
992 if (!getenv("CLASS"))
995 * Check printer-is-accepting-jobs = false and printer-state-reasons for the
996 * "spool-area-full" keyword...
1001 if ((printer_accepting
= ippFindAttribute(supported
,
1002 "printer-is-accepting-jobs",
1003 IPP_TAG_BOOLEAN
)) != NULL
&&
1004 !printer_accepting
->values
[0].boolean
)
1006 else if (!printer_accepting
)
1007 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1008 "cups-ipp-missing-printer-is-accepting-jobs");
1010 if ((printer_state
= ippFindAttribute(supported
,
1011 "printer-state-reasons",
1012 IPP_TAG_KEYWORD
)) == NULL
)
1014 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1015 "cups-ipp-missing-printer-state-reasons");
1019 for (i
= 0; i
< printer_state
->num_values
; i
++)
1021 if (!strcmp(printer_state
->values
[0].string
.text
,
1022 "spool-area-full") ||
1023 !strncmp(printer_state
->values
[0].string
.text
, "spool-area-full-",
1034 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1036 report_printer_state(supported
);
1040 delay
= _cupsNextDelay(delay
, &prev_delay
);
1042 ippDelete(supported
);
1049 * Check for supported attributes...
1053 if ((compression_sup
= ippFindAttribute(supported
, "compression-supported",
1054 IPP_TAG_KEYWORD
)) != NULL
)
1057 * Check whether the requested compression is supported and/or default to
1058 * compression if supported...
1061 if (compression
&& !ippContainsString(compression_sup
, compression
))
1063 fprintf(stderr
, "DEBUG: Printer does not support the requested "
1064 "compression value \"%s\".\n", compression
);
1067 else if (!compression
)
1069 if (ippContainsString(compression_sup
, "deflate"))
1070 compression
= "deflate";
1071 else if (ippContainsString(compression_sup
, "gzip"))
1072 compression
= "gzip";
1075 fprintf(stderr
, "DEBUG: Automatically using \"%s\" compression.\n",
1079 #endif /* HAVE_LIBZ */
1081 if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
1082 IPP_TAG_RANGE
)) != NULL
)
1085 * Has the "copies-supported" attribute - does it have an upper
1089 fprintf(stderr
, "DEBUG: copies-supported=%d-%d\n",
1090 copies_sup
->values
[0].range
.lower
,
1091 copies_sup
->values
[0].range
.upper
);
1093 if (copies_sup
->values
[0].range
.upper
<= 1)
1094 copies_sup
= NULL
; /* No */
1097 cups_version
= ippFindAttribute(supported
, "cups-version", IPP_TAG_TEXT
);
1099 if ((format_sup
= ippFindAttribute(supported
, "document-format-supported",
1100 IPP_TAG_MIMETYPE
)) != NULL
)
1102 fprintf(stderr
, "DEBUG: document-format-supported (%d values)\n",
1103 format_sup
->num_values
);
1104 for (i
= 0; i
< format_sup
->num_values
; i
++)
1105 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1106 format_sup
->values
[i
].string
.text
);
1109 if ((media_col_sup
= ippFindAttribute(supported
, "media-col-supported",
1110 IPP_TAG_KEYWORD
)) != NULL
)
1112 fprintf(stderr
, "DEBUG: media-col-supported (%d values)\n",
1113 media_col_sup
->num_values
);
1114 for (i
= 0; i
< media_col_sup
->num_values
; i
++)
1115 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
1116 media_col_sup
->values
[i
].string
.text
);
1119 print_color_mode
= ippFindAttribute(supported
,
1120 "print-color-mode-supported",
1121 IPP_TAG_KEYWORD
) != NULL
;
1123 if ((operations_sup
= ippFindAttribute(supported
, "operations-supported",
1124 IPP_TAG_ENUM
)) != NULL
)
1126 fprintf(stderr
, "DEBUG: operations-supported (%d values)\n",
1127 operations_sup
->num_values
);
1128 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1129 fprintf(stderr
, "DEBUG: [%d] = %s\n", i
,
1130 ippOpString(operations_sup
->values
[i
].integer
));
1132 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1133 if (operations_sup
->values
[i
].integer
== IPP_PRINT_JOB
)
1136 if (i
>= operations_sup
->num_values
)
1137 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1138 "cups-ipp-missing-print-job");
1140 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1141 if (operations_sup
->values
[i
].integer
== IPP_CANCEL_JOB
)
1144 if (i
>= operations_sup
->num_values
)
1145 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1146 "cups-ipp-missing-cancel-job");
1148 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1149 if (operations_sup
->values
[i
].integer
== IPP_GET_JOB_ATTRIBUTES
)
1152 if (i
>= operations_sup
->num_values
)
1153 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1154 "cups-ipp-missing-get-job-attributes");
1156 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1157 if (operations_sup
->values
[i
].integer
== IPP_GET_PRINTER_ATTRIBUTES
)
1160 if (i
>= operations_sup
->num_values
)
1161 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1162 "cups-ipp-missing-get-printer-attributes");
1164 for (i
= 0; i
< operations_sup
->num_values
; i
++)
1166 if (operations_sup
->values
[i
].integer
== IPP_VALIDATE_JOB
)
1168 else if (operations_sup
->values
[i
].integer
== IPP_CREATE_JOB
)
1170 else if (operations_sup
->values
[i
].integer
== IPP_SEND_DOCUMENT
)
1172 else if (operations_sup
->values
[i
].integer
== IPP_GET_JOB_ATTRIBUTES
)
1176 if (create_job
&& !send_document
)
1178 fputs("DEBUG: Printer supports Create-Job but not Send-Document.\n",
1182 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1183 "cups-ipp-missing-send-document");
1187 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1188 "cups-ipp-missing-validate-job");
1191 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1192 "cups-ipp-missing-operations-supported");
1194 doc_handling_sup
= ippFindAttribute(supported
,
1195 "multiple-document-handling-supported",
1198 report_printer_state(supported
);
1200 while (!job_canceled
&& ipp_status
> IPP_OK_CONFLICT
);
1203 return (CUPS_BACKEND_OK
);
1206 * See if the printer is accepting jobs and is not stopped; if either
1207 * condition is true and we are printing to a class, requeue the job...
1210 if (getenv("CLASS") != NULL
)
1212 printer_state
= ippFindAttribute(supported
, "printer-state",
1214 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
1217 if (printer_state
== NULL
||
1218 (printer_state
->values
[0].integer
> IPP_PRINTER_PROCESSING
&&
1220 printer_accepting
== NULL
||
1221 !printer_accepting
->values
[0].boolean
)
1224 * If the CLASS environment variable is set, the job was submitted
1225 * to a class and not to a specific queue. In this case, we want
1226 * to abort immediately so that the job can be requeued on the next
1227 * available printer in the class.
1230 _cupsLangPrintFilter(stderr
, "INFO",
1231 _("Unable to contact printer, queuing on next "
1232 "printer in class."));
1234 ippDelete(supported
);
1238 * Sleep 5 seconds to keep the job from requeuing too rapidly...
1243 return (CUPS_BACKEND_FAILED
);
1248 * See if the printer supports multiple copies...
1251 copies
= atoi(argv
[4]);
1253 if (copies_sup
|| argc
< 7)
1254 copies_remaining
= 1;
1256 copies_remaining
= copies
;
1259 * Prepare remaining printing options...
1266 num_options
= cupsParseOptions(argv
[5], 0, &options
);
1268 if (!cups_version
&& media_col_sup
)
1271 * Load the PPD file and generate PWG attribute mapping information...
1274 ppd
= ppdOpenFile(getenv("PPD"));
1275 pc
= _ppdCacheCreateWithPPD(ppd
);
1277 ppdMarkDefaults(ppd
);
1278 cupsMarkOptions(ppd
, num_options
, options
);
1284 document_format
= NULL
;
1286 if (format_sup
!= NULL
)
1288 for (i
= 0; i
< format_sup
->num_values
; i
++)
1289 if (!_cups_strcasecmp(final_content_type
,
1290 format_sup
->values
[i
].string
.text
))
1292 document_format
= final_content_type
;
1296 if (!document_format
)
1298 for (i
= 0; i
< format_sup
->num_values
; i
++)
1299 if (!_cups_strcasecmp("application/octet-stream",
1300 format_sup
->values
[i
].string
.text
))
1302 document_format
= "application/octet-stream";
1308 fprintf(stderr
, "DEBUG: final_content_type=\"%s\", document_format=\"%s\"\n",
1309 final_content_type
, document_format
? document_format
: "(null)");
1312 * If the printer does not support HTTP/1.1 (which IPP requires), copy stdin
1313 * to a temporary file so that we can do a HTTP/1.0 submission...
1315 * (I hate compatibility hacks!)
1318 if (http
->version
< HTTP_1_1
&& num_files
== 0)
1320 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
1322 perror("DEBUG: Unable to create temporary file");
1323 return (CUPS_BACKEND_FAILED
);
1326 _cupsLangPrintFilter(stderr
, "INFO", _("Copying print data."));
1328 if ((compatsize
= write(fd
, buffer
, bytes
)) < 0)
1330 perror("DEBUG: Unable to write temporary file");
1331 return (CUPS_BACKEND_FAILED
);
1334 if ((bytes
= backendRunLoop(-1, fd
, snmp_fd
, &(addrlist
->addr
), 0, 0,
1335 backendNetworkSideCB
)) < 0)
1336 return (CUPS_BACKEND_FAILED
);
1338 compatsize
+= bytes
;
1342 compatfile
= tmpfilename
;
1343 files
= &compatfile
;
1346 else if (http
->version
< HTTP_1_1
&& num_files
== 1)
1348 struct stat fileinfo
; /* File information */
1350 if (!stat(files
[0], &fileinfo
))
1351 compatsize
= fileinfo
.st_size
;
1355 * If the printer only claims to support IPP/1.0, or if the user specifically
1356 * included version=1.0 in the URI, then do not try to use Create-Job or
1357 * Send-Document. This is another dreaded compatibility hack, but unfortunately
1358 * there are enough broken printers out there that we need this for now...
1362 create_job
= send_document
= 0;
1365 * Start monitoring the printer in the background...
1369 monitor
.hostname
= hostname
;
1370 monitor
.user
= argv
[2];
1371 monitor
.resource
= resource
;
1372 monitor
.port
= port
;
1373 monitor
.version
= version
;
1375 monitor
.get_job_attrs
= get_job_attrs
;
1376 monitor
.encryption
= cupsEncryption();
1377 monitor
.job_state
= IPP_JOB_PENDING
;
1378 monitor
.printer_state
= IPP_PRINTER_IDLE
;
1382 monitor
.job_name
= argv
[3];
1386 snprintf(print_job_name
, sizeof(print_job_name
), "%s - %s", argv
[1],
1388 monitor
.job_name
= print_job_name
;
1391 _cupsThreadCreate((_cups_thread_func_t
)monitor_printer
, &monitor
);
1394 * Validate access to the printer...
1397 while (!job_canceled
&& validate_job
)
1399 request
= new_request(IPP_VALIDATE_JOB
, version
, uri
, argv
[2],
1400 monitor
.job_name
, num_options
, options
, compression
,
1401 copies_sup
? copies
: 1, document_format
, pc
, ppd
,
1402 media_col_sup
, doc_handling_sup
, print_color_mode
);
1404 ippDelete(cupsDoRequest(http
, request
, resource
));
1406 ipp_status
= cupsLastError();
1408 fprintf(stderr
, "DEBUG: Validate-Job: %s (%s)\n",
1409 ippErrorString(ipp_status
), cupsLastErrorString());
1414 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1415 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1417 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1420 else if (ipp_status
== IPP_STATUS_ERROR_DOCUMENT_FORMAT_NOT_SUPPORTED
||
1421 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1422 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1423 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1424 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1426 else if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1427 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1429 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1430 /* WWW-Authenticate field value */
1432 if (!strncmp(www_auth
, "Negotiate", 9))
1433 auth_info_required
= "negotiate";
1434 else if (www_auth
[0])
1435 auth_info_required
= "username,password";
1439 else if (ipp_status
== IPP_STATUS_ERROR_OPERATION_NOT_SUPPORTED
)
1442 * This is all too common...
1445 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1446 "cups-ipp-missing-validate-job");
1449 else if (ipp_status
< IPP_REDIRECTION_OTHER_SITE
||
1450 ipp_status
== IPP_BAD_REQUEST
)
1455 * Then issue the print-job request...
1460 while (!job_canceled
&& copies_remaining
> 0)
1463 * Check for side-channel requests...
1466 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1469 * Build the IPP job creation request...
1475 request
= new_request((num_files
> 1 || create_job
) ? IPP_CREATE_JOB
:
1477 version
, uri
, argv
[2], monitor
.job_name
, num_options
,
1478 options
, compression
, copies_sup
? copies
: 1,
1479 document_format
, pc
, ppd
, media_col_sup
,
1480 doc_handling_sup
, print_color_mode
);
1486 if (num_files
> 1 || create_job
)
1487 response
= cupsDoRequest(http
, request
, resource
);
1490 size_t length
= 0; /* Length of request */
1494 fputs("DEBUG: Sending file using HTTP/1.0 Content-Length...\n", stderr
);
1495 length
= ippLength(request
) + (size_t)compatsize
;
1498 fputs("DEBUG: Sending file using HTTP/1.1 chunking...\n", stderr
);
1500 http_status
= cupsSendRequest(http
, request
, resource
, length
);
1501 if (http_status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
)
1503 if (compression
&& strcmp(compression
, "none"))
1504 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1508 if ((fd
= open(files
[0], O_RDONLY
)) < 0)
1510 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1511 return (CUPS_BACKEND_FAILED
);
1517 http_status
= cupsWriteRequestData(http
, buffer
, bytes
);
1520 while (http_status
== HTTP_CONTINUE
&&
1521 (!job_canceled
|| compatsize
> 0))
1524 * Check for side-channel requests and more print data...
1529 FD_SET(snmp_fd
, &input
);
1531 while (select(fd
> snmp_fd
? fd
+ 1 : snmp_fd
+ 1, &input
, NULL
, NULL
,
1532 NULL
) <= 0 && !job_canceled
);
1534 if (FD_ISSET(snmp_fd
, &input
))
1535 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1537 if (FD_ISSET(fd
, &input
))
1539 if ((bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1541 fprintf(stderr
, "DEBUG: Read %d bytes...\n", (int)bytes
);
1543 if ((http_status
= cupsWriteRequestData(http
, buffer
, bytes
))
1547 else if (bytes
== 0 || (errno
!= EINTR
&& errno
!= EAGAIN
))
1552 if (http_status
== HTTP_ERROR
)
1553 fprintf(stderr
, "DEBUG: Error writing document data for "
1554 "Print-Job: %s\n", strerror(httpError(http
)));
1560 response
= cupsGetResponse(http
, resource
);
1564 ipp_status
= cupsLastError();
1566 fprintf(stderr
, "DEBUG: %s: %s (%s)\n",
1567 (num_files
> 1 || create_job
) ? "Create-Job" : "Print-Job",
1568 ippErrorString(ipp_status
), cupsLastErrorString());
1570 if (ipp_status
> IPP_OK_CONFLICT
)
1577 if (ipp_status
== IPP_STATUS_ERROR_SERVICE_UNAVAILABLE
||
1578 ipp_status
== IPP_STATUS_ERROR_NOT_POSSIBLE
||
1579 ipp_status
== IPP_STATUS_ERROR_BUSY
)
1581 _cupsLangPrintFilter(stderr
, "INFO", _("The printer is in use."));
1587 * We can't re-submit when we have no files to print, so exit
1588 * immediately with the right status code...
1594 else if (ipp_status
== IPP_STATUS_ERROR_JOB_CANCELED
||
1595 ipp_status
== IPP_STATUS_ERROR_NOT_AUTHORIZED
||
1596 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1597 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1598 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1599 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
1604 * Update auth-info-required as needed...
1607 _cupsLangPrintFilter(stderr
, "ERROR",
1608 _("Print job was not accepted."));
1610 if (ipp_status
== IPP_STATUS_ERROR_FORBIDDEN
||
1611 ipp_status
== IPP_STATUS_ERROR_CUPS_AUTHENTICATION_CANCELED
)
1613 const char *www_auth
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
1614 /* WWW-Authenticate field value */
1616 if (!strncmp(www_auth
, "Negotiate", 9))
1617 auth_info_required
= "negotiate";
1618 else if (www_auth
[0])
1619 auth_info_required
= "username,password";
1621 else if (ipp_status
== IPP_REQUEST_VALUE
)
1624 * Print file is too large, abort this job...
1635 * We can't re-submit when we have no files to print, so exit
1636 * immediately with the right status code...
1643 else if ((job_id_attr
= ippFindAttribute(response
, "job-id",
1644 IPP_TAG_INTEGER
)) == NULL
)
1646 fputs("DEBUG: Print job accepted - job ID unknown.\n", stderr
);
1647 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1648 "cups-ipp-missing-job-id");
1654 monitor
.job_id
= job_id
= job_id_attr
->values
[0].integer
;
1655 fprintf(stderr
, "DEBUG: Print job accepted - job ID %d.\n", job_id
);
1658 ippDelete(response
);
1663 if (job_id
&& (num_files
> 1 || create_job
))
1665 for (i
= 0; num_files
== 0 || i
< num_files
; i
++)
1668 * Check for side-channel requests...
1671 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1674 * Send the next file in the job...
1677 request
= ippNewRequest(IPP_SEND_DOCUMENT
);
1678 request
->request
.op
.version
[0] = version
/ 10;
1679 request
->request
.op
.version
[1] = version
% 10;
1681 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1684 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1688 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1689 "requesting-user-name", NULL
, argv
[2]);
1691 if ((i
+ 1) >= num_files
)
1692 ippAddBoolean(request
, IPP_TAG_OPERATION
, "last-document", 1);
1694 if (document_format
)
1695 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
1696 "document-format", NULL
, document_format
);
1699 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1700 "compression", NULL
, compression
);
1702 fprintf(stderr
, "DEBUG: Sending file %d using chunking...\n", i
+ 1);
1703 http_status
= cupsSendRequest(http
, request
, resource
, 0);
1704 if (http_status
== HTTP_CONTINUE
&& request
->state
== IPP_DATA
)
1706 if (compression
&& strcmp(compression
, "none"))
1707 httpSetField(http
, HTTP_FIELD_CONTENT_ENCODING
, compression
);
1712 http_status
= cupsWriteRequestData(http
, buffer
, bytes
);
1716 if ((fd
= open(files
[i
], O_RDONLY
)) < 0)
1718 _cupsLangPrintError("ERROR", _("Unable to open print file"));
1719 return (CUPS_BACKEND_FAILED
);
1728 while (!job_canceled
&& http_status
== HTTP_CONTINUE
&&
1729 (bytes
= read(fd
, buffer
, sizeof(buffer
))) > 0)
1731 if ((http_status
= cupsWriteRequestData(http
, buffer
, bytes
))
1737 * Check for side-channel requests...
1740 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1748 if (http_status
== HTTP_ERROR
)
1749 fprintf(stderr
, "DEBUG: Error writing document data for "
1750 "Send-Document: %s\n", strerror(httpError(http
)));
1752 ippDelete(cupsGetResponse(http
, resource
));
1755 fprintf(stderr
, "DEBUG: Send-Document: %s (%s)\n",
1756 ippErrorString(cupsLastError()), cupsLastErrorString());
1758 if (cupsLastError() > IPP_OK_CONFLICT
)
1760 ipp_status
= cupsLastError();
1762 _cupsLangPrintFilter(stderr
, "ERROR",
1763 _("Unable to add document to print job."));
1770 if (num_files
== 0 || fd
< 0)
1776 if (ipp_status
<= IPP_OK_CONFLICT
&& argc
> 6)
1778 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
1779 copies_remaining
--;
1781 else if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
1782 ipp_status
== IPP_NOT_POSSIBLE
||
1783 ipp_status
== IPP_PRINTER_BUSY
)
1788 * Need to reprocess the entire job; if we have a job ID, cancel the
1793 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1799 else if (ipp_status
== IPP_REQUEST_VALUE
||
1800 ipp_status
== IPP_ERROR_JOB_CANCELED
||
1801 ipp_status
== IPP_NOT_AUTHORIZED
||
1802 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
1803 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
1804 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
1805 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
||
1806 ipp_status
== IPP_INTERNAL_ERROR
)
1809 * Print file is too large, job was canceled, we need new
1810 * authentication data, or we had some sort of error...
1815 else if (ipp_status
== IPP_NOT_FOUND
)
1818 * Printer does not actually implement support for Create-Job/
1819 * Send-Document, so log the conformance issue and stop the printer.
1822 fputs("DEBUG: This printer claims to support Create-Job and "
1823 "Send-Document, but those operations failed.\n", stderr
);
1824 fputs("DEBUG: Add '?version=1.0' to the device URI to use legacy "
1825 "compatibility mode.\n", stderr
);
1826 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1827 "cups-ipp-missing-send-document");
1829 ipp_status
= IPP_INTERNAL_ERROR
; /* Force queue to stop */
1834 copies_remaining
--;
1837 * Wait for the job to complete...
1840 if (!job_id
|| !waitjob
|| !get_job_attrs
)
1843 _cupsLangPrintFilter(stderr
, "INFO", _("Waiting for job to complete."));
1845 for (delay
= _cupsNextDelay(0, &prev_delay
); !job_canceled
;)
1848 * Check for side-channel requests...
1851 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1854 * Build an IPP_GET_JOB_ATTRIBUTES request...
1857 request
= ippNewRequest(IPP_GET_JOB_ATTRIBUTES
);
1858 request
->request
.op
.version
[0] = version
/ 10;
1859 request
->request
.op
.version
[1] = version
% 10;
1861 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1864 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1868 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1869 "requesting-user-name", NULL
, argv
[2]);
1871 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1872 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
1879 httpReconnect(http
);
1880 response
= cupsDoRequest(http
, request
, resource
);
1881 ipp_status
= cupsLastError();
1883 if (ipp_status
== IPP_NOT_FOUND
|| ipp_status
== IPP_NOT_POSSIBLE
)
1886 * Job has gone away and/or the server has no job history...
1889 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1890 "cups-ipp-missing-job-history");
1891 ippDelete(response
);
1893 ipp_status
= IPP_OK
;
1897 fprintf(stderr
, "DEBUG: Get-Job-Attributes: %s (%s)\n",
1898 ippErrorString(ipp_status
), cupsLastErrorString());
1900 if (ipp_status
<= IPP_OK_CONFLICT
)
1904 if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
1905 ipp_status
!= IPP_PRINTER_BUSY
)
1907 ippDelete(response
);
1908 ipp_status
= IPP_OK
;
1911 else if (ipp_status
== IPP_INTERNAL_ERROR
)
1915 if (waitjob_tries
> 4)
1917 ippDelete(response
);
1918 ipp_status
= IPP_OK
;
1926 if ((job_state
= ippFindAttribute(response
, "job-state",
1927 IPP_TAG_ENUM
)) != NULL
)
1930 * Reflect the remote job state in the local queue...
1934 job_state
->values
[0].integer
>= IPP_JOB_PENDING
&&
1935 job_state
->values
[0].integer
<= IPP_JOB_COMPLETED
)
1936 update_reasons(NULL
,
1937 remote_job_states
[job_state
->values
[0].integer
-
1940 if ((job_sheets
= ippFindAttribute(response
,
1941 "job-media-sheets-completed",
1942 IPP_TAG_INTEGER
)) == NULL
)
1943 job_sheets
= ippFindAttribute(response
,
1944 "job-impressions-completed",
1948 fprintf(stderr
, "PAGE: total %d\n",
1949 job_sheets
->values
[0].integer
);
1952 * Stop polling if the job is finished or pending-held...
1955 if (job_state
->values
[0].integer
> IPP_JOB_STOPPED
)
1957 ippDelete(response
);
1961 else if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
1962 ipp_status
!= IPP_NOT_POSSIBLE
&&
1963 ipp_status
!= IPP_PRINTER_BUSY
)
1966 * If the printer does not return a job-state attribute, it does not
1967 * conform to the IPP specification - break out immediately and fail
1971 update_reasons(NULL
, "+cups-ipp-conformance-failure-report,"
1972 "cups-ipp-missing-job-state");
1973 ipp_status
= IPP_INTERNAL_ERROR
;
1978 ippDelete(response
);
1981 * Wait before polling again...
1986 delay
= _cupsNextDelay(delay
, &prev_delay
);
1991 * Cancel the job as needed...
1994 if (job_canceled
> 0 && job_id
> 0)
1995 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1998 * Check the printer state and report it if necessary...
2001 check_printer_state(http
, uri
, resource
, argv
[2], version
);
2004 * Collect the final page count as needed...
2007 if (have_supplies
&&
2008 !backendSNMPSupplies(snmp_fd
, http
->hostaddr
, &page_count
, NULL
) &&
2009 page_count
> start_count
)
2010 fprintf(stderr
, "PAGE: total %d\n", page_count
- start_count
);
2014 * See if we used Kerberos at all...
2018 auth_info_required
= "negotiate";
2019 #endif /* HAVE_GSSAPI */
2027 cupsFreeOptions(num_options
, options
);
2028 _ppdCacheDestroy(pc
);
2033 ippDelete(supported
);
2036 * Remove the temporary file(s) if necessary...
2040 unlink(tmpfilename
);
2043 * Return the queue status...
2046 if (ipp_status
== IPP_NOT_AUTHORIZED
|| ipp_status
== IPP_FORBIDDEN
||
2047 ipp_status
== IPP_AUTHENTICATION_CANCELED
||
2048 ipp_status
<= IPP_OK_CONFLICT
)
2049 fprintf(stderr
, "ATTR: auth-info-required=%s\n", auth_info_required
);
2051 if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
)
2052 fputs("JOBSTATE: account-info-needed\n", stderr
);
2053 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
)
2054 fputs("JOBSTATE: account-closed\n", stderr
);
2055 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
)
2056 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2057 else if (ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2058 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2060 if (ipp_status
== IPP_NOT_AUTHORIZED
|| ipp_status
== IPP_FORBIDDEN
||
2061 ipp_status
== IPP_AUTHENTICATION_CANCELED
||
2062 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_INFO_NEEDED
||
2063 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_CLOSED
||
2064 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_LIMIT_REACHED
||
2065 ipp_status
== IPP_STATUS_ERROR_CUPS_ACCOUNT_AUTHORIZATION_FAILED
)
2066 return (CUPS_BACKEND_AUTH_REQUIRED
);
2067 else if (ipp_status
== IPP_INTERNAL_ERROR
)
2068 return (CUPS_BACKEND_STOP
);
2069 else if (ipp_status
== IPP_CONFLICT
)
2070 return (CUPS_BACKEND_FAILED
);
2071 else if (ipp_status
== IPP_REQUEST_VALUE
||
2072 ipp_status
== IPP_DOCUMENT_FORMAT
|| job_canceled
< 0)
2074 if (ipp_status
== IPP_REQUEST_VALUE
)
2075 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job too large."));
2076 else if (ipp_status
== IPP_DOCUMENT_FORMAT
)
2077 _cupsLangPrintFilter(stderr
, "ERROR",
2078 _("Printer cannot print supplied content."));
2080 _cupsLangPrintFilter(stderr
, "ERROR", _("Print job canceled at printer."));
2082 return (CUPS_BACKEND_CANCEL
);
2084 else if (ipp_status
> IPP_OK_CONFLICT
&& ipp_status
!= IPP_ERROR_JOB_CANCELED
)
2085 return (CUPS_BACKEND_RETRY_CURRENT
);
2087 return (CUPS_BACKEND_OK
);
2092 * 'cancel_job()' - Cancel a print job.
2096 cancel_job(http_t
*http
, /* I - HTTP connection */
2097 const char *uri
, /* I - printer-uri */
2098 int id
, /* I - job-id */
2099 const char *resource
, /* I - Resource path */
2100 const char *user
, /* I - requesting-user-name */
2101 int version
) /* I - IPP version */
2103 ipp_t
*request
; /* Cancel-Job request */
2106 _cupsLangPrintFilter(stderr
, "INFO", _("Canceling print job."));
2108 request
= ippNewRequest(IPP_CANCEL_JOB
);
2109 request
->request
.op
.version
[0] = version
/ 10;
2110 request
->request
.op
.version
[1] = version
% 10;
2112 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2114 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
2116 if (user
&& user
[0])
2117 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2118 "requesting-user-name", NULL
, user
);
2124 ippDelete(cupsDoRequest(http
, request
, resource
));
2126 if (cupsLastError() > IPP_OK_CONFLICT
)
2127 _cupsLangPrintFilter(stderr
, "ERROR", _("Unable to cancel print job."));
2132 * 'check_printer_state()' - Check the printer state.
2135 static ipp_pstate_t
/* O - Current printer-state */
2136 check_printer_state(
2137 http_t
*http
, /* I - HTTP connection */
2138 const char *uri
, /* I - Printer URI */
2139 const char *resource
, /* I - Resource path */
2140 const char *user
, /* I - Username, if any */
2141 int version
) /* I - IPP version */
2143 ipp_t
*request
, /* IPP request */
2144 *response
; /* IPP response */
2145 ipp_attribute_t
*attr
; /* Attribute in response */
2146 ipp_pstate_t printer_state
= IPP_PRINTER_STOPPED
;
2147 /* Current printer-state */
2151 * Send a Get-Printer-Attributes request and log the results...
2154 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
2155 request
->request
.op
.version
[0] = version
/ 10;
2156 request
->request
.op
.version
[1] = version
% 10;
2158 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2161 if (user
&& user
[0])
2162 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2163 "requesting-user-name", NULL
, user
);
2165 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2166 "requested-attributes",
2167 (int)(sizeof(pattrs
) / sizeof(pattrs
[0])), NULL
, pattrs
);
2169 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
2171 report_printer_state(response
);
2173 if ((attr
= ippFindAttribute(response
, "printer-state",
2174 IPP_TAG_ENUM
)) != NULL
)
2175 printer_state
= (ipp_pstate_t
)attr
->values
[0].integer
;
2177 ippDelete(response
);
2180 fprintf(stderr
, "DEBUG: Get-Printer-Attributes: %s (%s)\n",
2181 ippErrorString(cupsLastError()), cupsLastErrorString());
2183 if (cupsLastError() <= IPP_OK_CONFLICT
)
2187 * Return the printer-state value...
2190 return (printer_state
);
2195 * 'monitor_printer()' - Monitor the printer state.
2198 static void * /* O - Thread exit code */
2200 _cups_monitor_t
*monitor
) /* I - Monitoring data */
2202 http_t
*http
; /* Connection to printer */
2203 ipp_t
*request
, /* IPP request */
2204 *response
; /* IPP response */
2205 ipp_attribute_t
*attr
; /* Attribute in response */
2206 int delay
, /* Current delay */
2207 prev_delay
; /* Previous delay */
2208 ipp_op_t job_op
; /* Operation to use */
2209 int job_id
; /* Job ID */
2210 const char *job_name
; /* Job name */
2211 ipp_jstate_t job_state
; /* Job state */
2212 const char *job_user
; /* Job originating user name */
2216 * Make a copy of the printer connection...
2219 http
= _httpCreate(monitor
->hostname
, monitor
->port
, NULL
, AF_UNSPEC
,
2220 monitor
->encryption
, 1, _HTTP_MODE_CLIENT
);
2221 httpSetTimeout(http
, 30.0, timeout_cb
, NULL
);
2223 cupsSetUser(username
);
2224 cupsSetPasswordCB2(password_cb
, NULL
);
2227 * Loop until the job is canceled, aborted, or completed.
2230 delay
= _cupsNextDelay(0, &prev_delay
);
2232 monitor
->job_reasons
= 0;
2234 while (monitor
->job_state
< IPP_JOB_CANCELED
&& !job_canceled
)
2237 * Reconnect to the printer...
2240 if (!httpReconnect(http
))
2243 * Connected, so check on the printer state...
2246 monitor
->printer_state
= check_printer_state(http
, monitor
->uri
,
2252 * Check the status of the job itself...
2255 job_op
= (monitor
->job_id
> 0 && monitor
->get_job_attrs
) ?
2256 IPP_GET_JOB_ATTRIBUTES
: IPP_GET_JOBS
;
2257 request
= ippNewRequest(job_op
);
2258 request
->request
.op
.version
[0] = monitor
->version
/ 10;
2259 request
->request
.op
.version
[1] = monitor
->version
% 10;
2261 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2262 NULL
, monitor
->uri
);
2263 if (job_op
== IPP_GET_JOB_ATTRIBUTES
)
2264 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
2267 if (monitor
->user
&& monitor
->user
[0])
2268 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2269 "requesting-user-name", NULL
, monitor
->user
);
2271 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2272 "requested-attributes",
2273 (int)(sizeof(jattrs
) / sizeof(jattrs
[0])), NULL
, jattrs
);
2279 response
= cupsDoRequest(http
, request
, monitor
->resource
);
2281 fprintf(stderr
, "DEBUG: (monitor) %s: %s (%s)\n", ippOpString(job_op
),
2282 ippErrorString(cupsLastError()), cupsLastErrorString());
2284 if (cupsLastError() <= IPP_OK_CONFLICT
)
2287 if (job_op
== IPP_GET_JOB_ATTRIBUTES
)
2289 if ((attr
= ippFindAttribute(response
, "job-state",
2290 IPP_TAG_ENUM
)) != NULL
)
2291 monitor
->job_state
= (ipp_jstate_t
)attr
->values
[0].integer
;
2293 monitor
->job_state
= IPP_JOB_COMPLETED
;
2297 for (attr
= response
->attrs
; attr
; attr
= attr
->next
)
2301 job_state
= IPP_JOB_PENDING
;
2304 while (attr
&& attr
->group_tag
!= IPP_TAG_JOB
)
2310 while (attr
&& attr
->group_tag
== IPP_TAG_JOB
)
2312 if (!strcmp(attr
->name
, "job-id") &&
2313 attr
->value_tag
== IPP_TAG_INTEGER
)
2314 job_id
= attr
->values
[0].integer
;
2315 else if (!strcmp(attr
->name
, "job-name") &&
2316 (attr
->value_tag
== IPP_TAG_NAME
||
2317 attr
->value_tag
== IPP_TAG_NAMELANG
))
2318 job_name
= attr
->values
[0].string
.text
;
2319 else if (!strcmp(attr
->name
, "job-state") &&
2320 attr
->value_tag
== IPP_TAG_ENUM
)
2321 job_state
= attr
->values
[0].integer
;
2322 else if (!strcmp(attr
->name
, "job-originating-user-name") &&
2323 (attr
->value_tag
== IPP_TAG_NAME
||
2324 attr
->value_tag
== IPP_TAG_NAMELANG
))
2325 job_user
= attr
->values
[0].string
.text
;
2330 if (job_id
> 0 && job_name
&& !strcmp(job_name
, monitor
->job_name
) &&
2331 job_user
&& monitor
->user
&& !strcmp(job_user
, monitor
->user
))
2333 monitor
->job_id
= job_id
;
2334 monitor
->job_state
= job_state
;
2343 if ((attr
= ippFindAttribute(response
, "job-state-reasons",
2344 IPP_TAG_KEYWORD
)) != NULL
)
2346 int i
, new_reasons
= 0; /* Looping var, new reasons */
2348 for (i
= 0; i
< attr
->num_values
; i
++)
2350 if (!strcmp(attr
->values
[i
].string
.text
,
2351 "account-authorization-failed"))
2352 new_reasons
|= _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
;
2353 else if (!strcmp(attr
->values
[i
].string
.text
, "account-closed"))
2354 new_reasons
|= _CUPS_JSR_ACCOUNT_CLOSED
;
2355 else if (!strcmp(attr
->values
[i
].string
.text
, "account-info-needed"))
2356 new_reasons
|= _CUPS_JSR_ACCOUNT_INFO_NEEDED
;
2357 else if (!strcmp(attr
->values
[i
].string
.text
,
2358 "account-limit-reached"))
2359 new_reasons
|= _CUPS_JSR_ACCOUNT_LIMIT_REACHED
;
2360 else if (!strcmp(attr
->values
[i
].string
.text
, "job-password-wait"))
2361 new_reasons
|= _CUPS_JSR_JOB_PASSWORD_WAIT
;
2362 else if (!strcmp(attr
->values
[i
].string
.text
, "job-release-wait"))
2363 new_reasons
|= _CUPS_JSR_JOB_RELEASE_WAIT
;
2366 if (new_reasons
!= monitor
->job_reasons
)
2368 if (new_reasons
& _CUPS_JSR_ACCOUNT_AUTHORIZATION_FAILED
)
2369 fputs("JOBSTATE: account-authorization-failed\n", stderr
);
2370 else if (new_reasons
& _CUPS_JSR_ACCOUNT_CLOSED
)
2371 fputs("JOBSTATE: account-closed\n", stderr
);
2372 else if (new_reasons
& _CUPS_JSR_ACCOUNT_INFO_NEEDED
)
2373 fputs("JOBSTATE: account-info-needed\n", stderr
);
2374 else if (new_reasons
& _CUPS_JSR_ACCOUNT_LIMIT_REACHED
)
2375 fputs("JOBSTATE: account-limit-reached\n", stderr
);
2376 else if (new_reasons
& _CUPS_JSR_JOB_PASSWORD_WAIT
)
2377 fputs("JOBSTATE: job-password-wait\n", stderr
);
2378 else if (new_reasons
& _CUPS_JSR_JOB_RELEASE_WAIT
)
2379 fputs("JOBSTATE: job-release-wait\n", stderr
);
2381 fputs("JOBSTATE: job-printing\n", stderr
);
2383 monitor
->job_reasons
= new_reasons
;
2387 ippDelete(response
);
2389 fprintf(stderr
, "DEBUG: (monitor) job-state=%s\n",
2390 ippEnumString("job-state", monitor
->job_state
));
2392 if (!job_canceled
&&
2393 (monitor
->job_state
== IPP_JOB_CANCELED
||
2394 monitor
->job_state
== IPP_JOB_ABORTED
))
2398 * Disconnect from the printer - we'll reconnect on the next poll...
2401 _httpDisconnect(http
);
2405 * Sleep for N seconds...
2410 delay
= _cupsNextDelay(delay
, &prev_delay
);
2414 * Cancel the job if necessary...
2417 if (job_canceled
> 0 && monitor
->job_id
> 0)
2418 if (!httpReconnect(http
))
2419 cancel_job(http
, monitor
->uri
, monitor
->job_id
, monitor
->resource
,
2420 monitor
->user
, monitor
->version
);
2423 * Cleanup and return...
2433 * 'new_request()' - Create a new print creation or validation request.
2436 static ipp_t
* /* O - Request data */
2438 ipp_op_t op
, /* I - IPP operation code */
2439 int version
, /* I - IPP version number */
2440 const char *uri
, /* I - printer-uri value */
2441 const char *user
, /* I - requesting-user-name value */
2442 const char *title
, /* I - job-name value */
2443 int num_options
, /* I - Number of options to send */
2444 cups_option_t
*options
, /* I - Options to send */
2445 const char *compression
, /* I - compression value or NULL */
2446 int copies
, /* I - copies value or 0 */
2447 const char *format
, /* I - document-format value or NULL */
2448 _ppd_cache_t
*pc
, /* I - PPD cache and mapping data */
2449 ppd_file_t
*ppd
, /* I - PPD file data */
2450 ipp_attribute_t
*media_col_sup
, /* I - media-col-supported values */
2451 ipp_attribute_t
*doc_handling_sup
, /* I - multiple-document-handling-supported values */
2452 int print_color_mode
) /* I - Printer supports print-color-mode */
2454 int i
; /* Looping var */
2455 ipp_t
*request
; /* Request data */
2456 const char *keyword
; /* PWG keyword */
2457 _pwg_size_t
*size
; /* PWG media size */
2458 ipp_t
*media_col
, /* media-col value */
2459 *media_size
; /* media-size value */
2460 const char *media_source
, /* media-source value */
2461 *media_type
, /* media-type value */
2462 *collate_str
, /* multiple-document-handling value */
2463 *mandatory
; /* Mandatory attributes */
2464 ipp_tag_t group
; /* Current group */
2465 ipp_attribute_t
*attr
; /* Current attribute */
2466 const char *color_attr_name
; /* Supported color attribute */
2467 char buffer
[1024]; /* Value buffer */
2471 * Create the IPP request...
2474 request
= ippNewRequest(op
);
2475 request
->request
.op
.version
[0] = version
/ 10;
2476 request
->request
.op
.version
[1] = version
% 10;
2478 fprintf(stderr
, "DEBUG: %s IPP/%d.%d\n",
2479 ippOpString(request
->request
.op
.operation_id
),
2480 request
->request
.op
.version
[0],
2481 request
->request
.op
.version
[1]);
2484 * Add standard attributes...
2487 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
2489 fprintf(stderr
, "DEBUG: printer-uri=\"%s\"\n", uri
);
2493 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
2494 "requesting-user-name", NULL
, user
);
2495 fprintf(stderr
, "DEBUG: requesting-user-name=\"%s\"\n", user
);
2498 if (title
&& *title
)
2500 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
,
2502 fprintf(stderr
, "DEBUG: job-name=\"%s\"\n", title
);
2505 if (format
&& op
!= IPP_CREATE_JOB
)
2507 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
2508 "document-format", NULL
, format
);
2509 fprintf(stderr
, "DEBUG: document-format=\"%s\"\n", format
);
2513 if (compression
&& op
!= IPP_OP_CREATE_JOB
&& op
!= IPP_OP_VALIDATE_JOB
)
2515 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2516 "compression", NULL
, compression
);
2517 fprintf(stderr
, "DEBUG: compression=\"%s\"\n", compression
);
2519 #endif /* HAVE_LIBZ */
2522 * Handle options on the command-line...
2525 if (num_options
> 0)
2529 int num_finishings
= 0, /* Number of finishing values */
2530 finishings
[10]; /* Finishing enum values */
2531 ppd_choice_t
*choice
; /* Marked choice */
2534 * Send standard IPP attributes...
2537 fputs("DEBUG: Adding standard IPP operation/job attributes.\n", stderr
);
2540 (keyword
= cupsGetOption("job-password", num_options
,
2543 ippAddOctetString(request
, IPP_TAG_OPERATION
, "job-password",
2544 keyword
, strlen(keyword
));
2546 if ((keyword
= cupsGetOption("job-password-encryption", num_options
,
2550 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
2551 "job-password-encryption", NULL
, keyword
);
2554 if (pc
->account_id
&&
2555 (keyword
= cupsGetOption("job-account-id", num_options
,
2557 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_NAME
, "job-account-id",
2560 if (pc
->account_id
&&
2561 (keyword
= cupsGetOption("job-accounting-user-id", num_options
,
2563 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_NAME
,
2564 "job-accounting-user-id", NULL
, keyword
);
2566 for (mandatory
= (char *)cupsArrayFirst(pc
->mandatory
);
2568 mandatory
= (char *)cupsArrayNext(pc
->mandatory
))
2570 if (strcmp(mandatory
, "copies") &&
2571 strcmp(mandatory
, "destination-uris") &&
2572 strcmp(mandatory
, "finishings") &&
2573 strcmp(mandatory
, "job-account-id") &&
2574 strcmp(mandatory
, "job-accounting-user-id") &&
2575 strcmp(mandatory
, "job-password") &&
2576 strcmp(mandatory
, "job-password-encryption") &&
2577 strcmp(mandatory
, "media") &&
2578 strncmp(mandatory
, "media-col", 9) &&
2579 strcmp(mandatory
, "multiple-document-handling") &&
2580 strcmp(mandatory
, "output-bin") &&
2581 strcmp(mandatory
, "print-color-mode") &&
2582 strcmp(mandatory
, "print-quality") &&
2583 strcmp(mandatory
, "sides") &&
2584 (keyword
= cupsGetOption(mandatory
, num_options
, options
)) != NULL
)
2586 _ipp_option_t
*opt
= _ippFindOption(mandatory
);
2588 ipp_tag_t value_tag
= opt
? opt
->value_tag
: IPP_TAG_NAME
;
2593 case IPP_TAG_INTEGER
:
2595 ippAddInteger(request
, IPP_TAG_JOB
, value_tag
, mandatory
,
2598 case IPP_TAG_BOOLEAN
:
2599 ippAddBoolean(request
, IPP_TAG_JOB
, mandatory
,
2600 !_cups_strcasecmp(keyword
, "true"));
2602 case IPP_TAG_RANGE
:
2604 int lower
, upper
; /* Range */
2606 if (sscanf(keyword
, "%d-%d", &lower
, &upper
) != 2)
2607 lower
= upper
= atoi(keyword
);
2609 ippAddRange(request
, IPP_TAG_JOB
, mandatory
, lower
, upper
);
2612 case IPP_TAG_STRING
:
2613 ippAddOctetString(request
, IPP_TAG_JOB
, mandatory
, keyword
,
2617 ippAddString(request
, IPP_TAG_JOB
, value_tag
, mandatory
,
2624 if ((keyword
= cupsGetOption("PageSize", num_options
, options
)) == NULL
)
2625 keyword
= cupsGetOption("media", num_options
, options
);
2627 if ((size
= _ppdCacheGetSize(pc
, keyword
)) != NULL
)
2630 * Add a media-col value...
2633 media_size
= ippNew();
2634 ippAddInteger(media_size
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2635 "x-dimension", size
->width
);
2636 ippAddInteger(media_size
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2637 "y-dimension", size
->length
);
2639 media_col
= ippNew();
2640 ippAddCollection(media_col
, IPP_TAG_ZERO
, "media-size", media_size
);
2642 media_source
= _ppdCacheGetSource(pc
, cupsGetOption("InputSlot",
2645 media_type
= _ppdCacheGetType(pc
, cupsGetOption("MediaType",
2649 for (i
= 0; i
< media_col_sup
->num_values
; i
++)
2651 if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2652 "media-left-margin"))
2653 ippAddInteger(media_col
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2654 "media-left-margin", size
->left
);
2655 else if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2656 "media-bottom-margin"))
2657 ippAddInteger(media_col
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2658 "media-bottom-margin", size
->bottom
);
2659 else if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2660 "media-right-margin"))
2661 ippAddInteger(media_col
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2662 "media-right-margin", size
->right
);
2663 else if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2664 "media-top-margin"))
2665 ippAddInteger(media_col
, IPP_TAG_ZERO
, IPP_TAG_INTEGER
,
2666 "media-top-margin", size
->top
);
2667 else if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2668 "media-source") && media_source
)
2669 ippAddString(media_col
, IPP_TAG_ZERO
, IPP_TAG_KEYWORD
,
2670 "media-source", NULL
, media_source
);
2671 else if (!strcmp(media_col_sup
->values
[i
].string
.text
,
2672 "media-type") && media_type
)
2673 ippAddString(media_col
, IPP_TAG_ZERO
, IPP_TAG_KEYWORD
,
2674 "media-type", NULL
, media_type
);
2677 ippAddCollection(request
, IPP_TAG_JOB
, "media-col", media_col
);
2680 if ((keyword
= cupsGetOption("output-bin", num_options
,
2683 if ((choice
= ppdFindMarkedChoice(ppd
, "OutputBin")) != NULL
)
2684 keyword
= _ppdCacheGetBin(pc
, choice
->choice
);
2688 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "output-bin",
2691 color_attr_name
= print_color_mode
? "print-color-mode" : "output-mode";
2693 if ((keyword
= cupsGetOption("print-color-mode", num_options
,
2695 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, color_attr_name
,
2697 else if ((choice
= ppdFindMarkedChoice(ppd
, "ColorModel")) != NULL
)
2699 if (!_cups_strcasecmp(choice
->choice
, "Gray"))
2700 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2701 color_attr_name
, NULL
, "monochrome");
2703 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2704 color_attr_name
, NULL
, "color");
2707 if ((keyword
= cupsGetOption("print-quality", num_options
,
2709 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_ENUM
, "print-quality",
2711 else if ((choice
= ppdFindMarkedChoice(ppd
, "cupsPrintQuality")) != NULL
)
2713 if (!_cups_strcasecmp(choice
->choice
, "draft"))
2714 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_ENUM
, "print-quality",
2716 else if (!_cups_strcasecmp(choice
->choice
, "normal"))
2717 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_ENUM
, "print-quality",
2718 IPP_QUALITY_NORMAL
);
2719 else if (!_cups_strcasecmp(choice
->choice
, "high"))
2720 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_ENUM
, "print-quality",
2724 if ((keyword
= cupsGetOption("sides", num_options
, options
)) != NULL
)
2725 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "sides",
2727 else if (pc
->sides_option
&&
2728 (choice
= ppdFindMarkedChoice(ppd
, pc
->sides_option
)) != NULL
)
2730 if (!_cups_strcasecmp(choice
->choice
, pc
->sides_1sided
))
2731 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "sides",
2733 else if (!_cups_strcasecmp(choice
->choice
, pc
->sides_2sided_long
))
2734 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "sides",
2735 NULL
, "two-sided-long-edge");
2736 if (!_cups_strcasecmp(choice
->choice
, pc
->sides_2sided_short
))
2737 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
, "sides",
2738 NULL
, "two-sided-short-edge");
2741 if ((keyword
= cupsGetOption("multiple-document-handling",
2742 num_options
, options
)) != NULL
)
2744 if (strstr(keyword
, "uncollated"))
2749 else if ((keyword
= cupsGetOption("collate", num_options
,
2755 if (!_cups_strcasecmp(format
, "image/gif") ||
2756 !_cups_strcasecmp(format
, "image/jp2") ||
2757 !_cups_strcasecmp(format
, "image/jpeg") ||
2758 !_cups_strcasecmp(format
, "image/png") ||
2759 !_cups_strcasecmp(format
, "image/tiff") ||
2760 !_cups_strncasecmp(format
, "image/x-", 8))
2763 * Collation makes no sense for single page image formats...
2768 else if (!_cups_strncasecmp(format
, "image/", 6) ||
2769 !_cups_strcasecmp(format
, "application/vnd.cups-raster"))
2772 * Multi-page image formats will have copies applied by the upstream
2780 if (doc_handling_sup
)
2782 if (!_cups_strcasecmp(keyword
, "true"))
2783 collate_str
= "separate-documents-collated-copies";
2785 collate_str
= "separate-documents-uncollated-copies";
2787 for (i
= 0; i
< doc_handling_sup
->num_values
; i
++)
2788 if (!strcmp(doc_handling_sup
->values
[i
].string
.text
, collate_str
))
2790 ippAddString(request
, IPP_TAG_JOB
, IPP_TAG_KEYWORD
,
2791 "multiple-document-handling", NULL
, collate_str
);
2795 if (i
>= doc_handling_sup
->num_values
)
2800 * Map finishing options...
2803 num_finishings
= _ppdCacheGetFinishingValues(pc
, num_options
, options
,
2804 (int)(sizeof(finishings
) /
2805 sizeof(finishings
[0])),
2807 if (num_finishings
> 0)
2808 ippAddIntegers(request
, IPP_TAG_JOB
, IPP_TAG_ENUM
, "finishings",
2809 num_finishings
, finishings
);
2812 * Map FaxOut options...
2815 if ((keyword
= cupsGetOption("phone", num_options
, options
)) != NULL
)
2817 ipp_t
*destination
; /* destination collection */
2818 char tel_uri
[1024]; /* tel: URI */
2820 destination
= ippNew();
2822 httpAssembleURI(HTTP_URI_CODING_ALL
, tel_uri
, sizeof(tel_uri
), "tel",
2823 NULL
, NULL
, 0, keyword
);
2824 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_URI
, "destination-uri",
2827 if ((keyword
= cupsGetOption("faxPrefix", num_options
,
2828 options
)) != NULL
&& *keyword
)
2829 ippAddString(destination
, IPP_TAG_JOB
, IPP_TAG_TEXT
,
2830 "pre-dial-string", NULL
, keyword
);
2832 ippAddCollection(request
, IPP_TAG_JOB
, "destination-uris", destination
);
2833 ippDelete(destination
);
2839 * When talking to another CUPS server, send all options...
2842 fputs("DEBUG: Adding all operation/job attributes.\n", stderr
);
2843 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_OPERATION
);
2844 cupsEncodeOptions2(request
, num_options
, options
, IPP_TAG_JOB
);
2847 if (copies
> 1 && (!pc
|| copies
<= pc
->max_copies
))
2848 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies", copies
);
2851 fprintf(stderr
, "DEBUG: IPP/%d.%d %s #%d\n", version
/ 10, version
% 10,
2852 ippOpString(ippGetOperation(request
)), ippGetRequestId(request
));
2853 for (group
= IPP_TAG_ZERO
, attr
= ippFirstAttribute(request
);
2855 attr
= ippNextAttribute(request
))
2857 const char *name
= ippGetName(attr
);
2861 group
= IPP_TAG_ZERO
;
2865 if (group
!= ippGetGroupTag(attr
))
2867 group
= ippGetGroupTag(attr
);
2868 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(group
));
2871 ippAttributeString(attr
, buffer
, sizeof(buffer
));
2872 fprintf(stderr
, "DEBUG: %s %s%s %s\n", name
,
2873 ippGetCount(attr
) > 1 ? "1setOf " : "",
2874 ippTagString(ippGetValueTag(attr
)), buffer
);
2877 fprintf(stderr
, "DEBUG: ---- %s ----\n", ippTagString(IPP_TAG_END
));
2884 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
2887 static const char * /* O - Password */
2888 password_cb(const char *prompt
, /* I - Prompt (not used) */
2889 http_t
*http
, /* I - Connection */
2890 const char *method
, /* I - Request method (not used) */
2891 const char *resource
, /* I - Resource path (not used) */
2892 void *user_data
) /* I - User data (not used) */
2894 char def_username
[HTTP_MAX_VALUE
]; /* Default username */
2897 fprintf(stderr
, "DEBUG: password_cb(prompt=\"%s\"), password=%p, "
2898 "password_tries=%d\n", prompt
, password
, password_tries
);
2906 * Remember that we need to authenticate...
2909 auth_info_required
= "username,password";
2911 if (httpGetSubField(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "username",
2914 char quoted
[HTTP_MAX_VALUE
* 2 + 4];
2917 fprintf(stderr
, "ATTR: auth-info-default=%s,\n",
2918 quote_string(def_username
, quoted
, sizeof(quoted
)));
2921 if (password
&& *password
&& password_tries
< 3)
2930 * Give up after 3 tries or if we don't have a password to begin with...
2939 * 'quote_string()' - Quote a string value.
2942 static const char * /* O - Quoted string */
2943 quote_string(const char *s
, /* I - String */
2944 char *q
, /* I - Quoted string buffer */
2945 size_t qsize
) /* I - Size of quoted string buffer */
2947 char *qptr
, /* Pointer into string buffer */
2948 *qend
; /* End of string buffer */
2952 qend
= q
+ qsize
- 5;
2963 while (*s
&& qptr
< qend
)
2965 if (*s
== '\\' || *s
== '\"' || *s
== '\'')
2989 * 'report_attr()' - Report an IPP attribute value.
2993 report_attr(ipp_attribute_t
*attr
) /* I - Attribute */
2995 int i
; /* Looping var */
2996 char value
[1024], /* Value string */
2997 *valptr
; /* Pointer into value string */
2998 const char *cached
; /* Cached attribute */
3002 * Convert the attribute values into quoted strings...
3005 for (i
= 0, valptr
= value
;
3006 i
< attr
->num_values
&& valptr
< (value
+ sizeof(value
) - 10);
3012 switch (attr
->value_tag
)
3014 case IPP_TAG_INTEGER
:
3016 snprintf(valptr
, sizeof(value
) - (valptr
- value
), "%d",
3017 attr
->values
[i
].integer
);
3018 valptr
+= strlen(valptr
);
3023 case IPP_TAG_KEYWORD
:
3024 quote_string(attr
->values
[i
].string
.text
, valptr
,
3025 value
+ sizeof(value
) - valptr
);
3026 valptr
+= strlen(valptr
);
3031 * Unsupported value type...
3040 _cupsMutexLock(&report_mutex
);
3042 if ((cached
= cupsGetOption(attr
->name
, num_attr_cache
,
3043 attr_cache
)) == NULL
|| strcmp(cached
, value
))
3046 * Tell the scheduler about the new values...
3049 num_attr_cache
= cupsAddOption(attr
->name
, value
, num_attr_cache
,
3051 fprintf(stderr
, "ATTR: %s=%s\n", attr
->name
, value
);
3054 _cupsMutexUnlock(&report_mutex
);
3059 * 'report_printer_state()' - Report the printer state.
3063 report_printer_state(ipp_t
*ipp
) /* I - IPP response */
3065 ipp_attribute_t
*pa
, /* printer-alert */
3066 *pam
, /* printer-alert-message */
3067 *psm
, /* printer-state-message */
3068 *reasons
, /* printer-state-reasons */
3069 *marker
; /* marker-* attributes */
3070 char value
[1024], /* State/message string */
3071 *valptr
; /* Pointer into string */
3072 static int ipp_supplies
= -1;
3073 /* Report supply levels? */
3077 * Report alerts and messages...
3080 if ((pa
= ippFindAttribute(ipp
, "printer-alert", IPP_TAG_TEXT
)) != NULL
)
3083 if ((pam
= ippFindAttribute(ipp
, "printer-alert-message",
3084 IPP_TAG_TEXT
)) != NULL
)
3087 if ((psm
= ippFindAttribute(ipp
, "printer-state-message",
3088 IPP_TAG_TEXT
)) != NULL
)
3090 char *ptr
; /* Pointer into message */
3093 strlcpy(value
, "INFO: ", sizeof(value
));
3094 for (ptr
= psm
->values
[0].string
.text
, valptr
= value
+ 6;
3095 *ptr
&& valptr
< (value
+ sizeof(value
) - 6);
3098 if (*ptr
< ' ' && *ptr
> 0 && *ptr
!= '\t')
3101 * Substitute "<XX>" for the control character; sprintf is safe because
3102 * we always leave 6 chars free at the end...
3105 sprintf(valptr
, "<%02X>", *ptr
);
3115 fputs(value
, stderr
);
3119 * Now report printer-state-reasons, filtering out some of the reasons we never
3123 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
3124 IPP_TAG_KEYWORD
)) == NULL
)
3127 update_reasons(reasons
, NULL
);
3130 * Relay the current marker-* attribute values...
3133 if (ipp_supplies
< 0)
3135 ppd_file_t
*ppd
; /* PPD file */
3136 ppd_attr_t
*ppdattr
; /* Attribute in PPD file */
3138 if ((ppd
= ppdOpenFile(getenv("PPD"))) != NULL
&&
3139 (ppdattr
= ppdFindAttr(ppd
, "cupsIPPSupplies", NULL
)) != NULL
&&
3140 ppdattr
->value
&& _cups_strcasecmp(ppdattr
->value
, "true"))
3148 if (ipp_supplies
> 0)
3150 if ((marker
= ippFindAttribute(ipp
, "marker-colors", IPP_TAG_NAME
)) != NULL
)
3151 report_attr(marker
);
3152 if ((marker
= ippFindAttribute(ipp
, "marker-high-levels",
3153 IPP_TAG_INTEGER
)) != NULL
)
3154 report_attr(marker
);
3155 if ((marker
= ippFindAttribute(ipp
, "marker-levels",
3156 IPP_TAG_INTEGER
)) != NULL
)
3157 report_attr(marker
);
3158 if ((marker
= ippFindAttribute(ipp
, "marker-low-levels",
3159 IPP_TAG_INTEGER
)) != NULL
)
3160 report_attr(marker
);
3161 if ((marker
= ippFindAttribute(ipp
, "marker-message",
3162 IPP_TAG_TEXT
)) != NULL
)
3163 report_attr(marker
);
3164 if ((marker
= ippFindAttribute(ipp
, "marker-names", IPP_TAG_NAME
)) != NULL
)
3165 report_attr(marker
);
3166 if ((marker
= ippFindAttribute(ipp
, "marker-types",
3167 IPP_TAG_KEYWORD
)) != NULL
)
3168 report_attr(marker
);
3173 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3175 * 'run_as_user()' - Run the IPP backend as the printing user.
3177 * This function uses an XPC-based user agent to run the backend as the printing
3178 * user. We need to do this in order to have access to the user's Kerberos
3182 static int /* O - Exit status */
3183 run_as_user(char *argv
[], /* I - Command-line arguments */
3184 uid_t uid
, /* I - User ID */
3185 const char *device_uri
, /* I - Device URI */
3186 int fd
) /* I - File to print */
3188 const char *auth_negotiate
;/* AUTH_NEGOTIATE env var */
3189 xpc_connection_t conn
; /* Connection to XPC service */
3190 xpc_object_t request
; /* Request message dictionary */
3191 __block xpc_object_t response
; /* Response message dictionary */
3192 dispatch_semaphore_t sem
; /* Semaphore for waiting for response */
3193 int status
= CUPS_BACKEND_FAILED
;
3194 /* Status of request */
3197 fprintf(stderr
, "DEBUG: Running IPP backend as UID %d.\n", (int)uid
);
3200 * Connect to the user agent for the specified UID...
3203 conn
= xpc_connection_create_mach_service(kPMPrintUIToolAgent
,
3204 dispatch_get_global_queue(0, 0), 0);
3207 _cupsLangPrintFilter(stderr
, "ERROR",
3208 _("Unable to start backend process."));
3209 fputs("DEBUG: Unable to create connection to agent.\n", stderr
);
3213 xpc_connection_set_event_handler(conn
,
3214 ^(xpc_object_t event
)
3216 xpc_type_t messageType
= xpc_get_type(event
);
3218 if (messageType
== XPC_TYPE_ERROR
)
3220 if (event
== XPC_ERROR_CONNECTION_INTERRUPTED
)
3221 fprintf(stderr
, "DEBUG: Interrupted connection to service %s.\n",
3222 xpc_connection_get_name(conn
));
3223 else if (event
== XPC_ERROR_CONNECTION_INVALID
)
3224 fprintf(stderr
, "DEBUG: Connection invalid for service %s.\n",
3225 xpc_connection_get_name(conn
));
3227 fprintf(stderr
, "DEBUG: Unxpected error for service %s: %s\n",
3228 xpc_connection_get_name(conn
),
3229 xpc_dictionary_get_string(event
, XPC_ERROR_KEY_DESCRIPTION
));
3232 xpc_connection_set_target_uid(conn
, uid
);
3233 xpc_connection_resume(conn
);
3236 * Try starting the backend...
3239 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3240 xpc_dictionary_set_int64(request
, "command", kPMStartJob
);
3241 xpc_dictionary_set_string(request
, "device-uri", device_uri
);
3242 xpc_dictionary_set_string(request
, "job-id", argv
[1]);
3243 xpc_dictionary_set_string(request
, "user", argv
[2]);
3244 xpc_dictionary_set_string(request
, "title", argv
[3]);
3245 xpc_dictionary_set_string(request
, "copies", argv
[4]);
3246 xpc_dictionary_set_string(request
, "options", argv
[5]);
3247 xpc_dictionary_set_string(request
, "auth-info-required",
3248 getenv("AUTH_INFO_REQUIRED"));
3249 if ((auth_negotiate
= getenv("AUTH_NEGOTIATE")) != NULL
)
3250 xpc_dictionary_set_string(request
, "auth-negotiate", auth_negotiate
);
3251 xpc_dictionary_set_fd(request
, "stdin", fd
);
3252 xpc_dictionary_set_fd(request
, "stderr", 2);
3253 xpc_dictionary_set_fd(request
, "side-channel", CUPS_SC_FD
);
3255 sem
= dispatch_semaphore_create(0);
3258 xpc_connection_send_message_with_reply(conn
, request
,
3259 dispatch_get_global_queue(0,0),
3260 ^(xpc_object_t reply
)
3262 /* Save the response and wake up */
3263 if (xpc_get_type(reply
)
3264 == XPC_TYPE_DICTIONARY
)
3265 response
= xpc_retain(reply
);
3267 dispatch_semaphore_signal(sem
);
3270 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3271 xpc_release(request
);
3272 dispatch_release(sem
);
3276 child_pid
= xpc_dictionary_get_int64(response
, "child-pid");
3278 xpc_release(response
);
3281 fprintf(stderr
, "DEBUG: Child PID=%d.\n", child_pid
);
3284 _cupsLangPrintFilter(stderr
, "ERROR",
3285 _("Unable to start backend process."));
3286 fputs("DEBUG: No child PID.\n", stderr
);
3292 _cupsLangPrintFilter(stderr
, "ERROR",
3293 _("Unable to start backend process."));
3294 fputs("DEBUG: No reply from agent.\n", stderr
);
3299 * Then wait for the backend to finish...
3302 request
= xpc_dictionary_create(NULL
, NULL
, 0);
3303 xpc_dictionary_set_int64(request
, "command", kPMWaitForJob
);
3304 xpc_dictionary_set_fd(request
, "stderr", 2);
3306 sem
= dispatch_semaphore_create(0);
3309 xpc_connection_send_message_with_reply(conn
, request
,
3310 dispatch_get_global_queue(0,0),
3311 ^(xpc_object_t reply
)
3313 /* Save the response and wake up */
3314 if (xpc_get_type(reply
)
3315 == XPC_TYPE_DICTIONARY
)
3316 response
= xpc_retain(reply
);
3318 dispatch_semaphore_signal(sem
);
3321 dispatch_semaphore_wait(sem
, DISPATCH_TIME_FOREVER
);
3322 xpc_release(request
);
3323 dispatch_release(sem
);
3327 status
= xpc_dictionary_get_int64(response
, "status");
3329 if (status
== SIGTERM
|| status
== SIGKILL
|| status
== SIGPIPE
)
3331 fprintf(stderr
, "DEBUG: Child terminated on signal %d.\n", status
);
3332 status
= CUPS_BACKEND_FAILED
;
3334 else if (WIFSIGNALED(status
))
3336 fprintf(stderr
, "DEBUG: Child crashed on signal %d.\n", status
);
3337 status
= CUPS_BACKEND_STOP
;
3339 else if (WIFEXITED(status
))
3341 status
= WEXITSTATUS(status
);
3342 fprintf(stderr
, "DEBUG: Child exited with status %d.\n", status
);
3345 xpc_release(response
);
3348 _cupsLangPrintFilter(stderr
, "ERROR",
3349 _("Unable to get backend exit status."));
3355 xpc_connection_suspend(conn
);
3356 xpc_connection_cancel(conn
);
3362 #endif /* HAVE_GSSAPI && HAVE_XPC */
3366 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
3370 sigterm_handler(int sig
) /* I - Signal */
3372 (void)sig
; /* remove compiler warnings... */
3374 write(2, "DEBUG: Got SIGTERM.\n", 20);
3376 #if defined(HAVE_GSSAPI) && defined(HAVE_XPC)
3379 kill(child_pid
, sig
);
3382 #endif /* HAVE_GSSAPI && HAVE_XPC */
3387 * Flag that the job should be canceled...
3390 write(2, "DEBUG: job_canceled = 1.\n", 25);
3397 * The scheduler already tried to cancel us once, now just terminate
3398 * after removing our temp file!
3402 unlink(tmpfilename
);
3409 * 'timeout_cb()' - Handle HTTP timeouts.
3412 static int /* O - 1 to continue, 0 to cancel */
3413 timeout_cb(http_t
*http
, /* I - Connection to server (unused) */
3414 void *user_data
) /* I - User data (unused) */
3419 return (!job_canceled
);
3424 * 'update_reasons()' - Update the printer-state-reasons values.
3428 update_reasons(ipp_attribute_t
*attr
, /* I - printer-state-reasons or NULL */
3429 const char *s
) /* I - STATE: string or NULL */
3431 char op
; /* Add (+), remove (-), replace (\0) */
3432 cups_array_t
*new_reasons
; /* New reasons array */
3433 char *reason
, /* Current reason */
3434 add
[2048], /* Reasons added string */
3435 *addptr
, /* Pointer into add string */
3436 rem
[2048], /* Reasons removed string */
3437 *remptr
; /* Pointer into remove string */
3438 const char *addprefix
, /* Current add string prefix */
3439 *remprefix
; /* Current remove string prefix */
3442 fprintf(stderr
, "DEBUG: update_reasons(attr=%d(%s%s), s=\"%s\")\n",
3443 attr
? attr
->num_values
: 0, attr
? attr
->values
[0].string
.text
: "",
3444 attr
&& attr
->num_values
> 1 ? ",..." : "", s
? s
: "(null)");
3447 * Create an array of new reason keyword strings...
3452 int i
; /* Looping var */
3454 new_reasons
= cupsArrayNew((cups_array_func_t
)strcmp
, NULL
);
3457 for (i
= 0; i
< attr
->num_values
; i
++)
3459 reason
= attr
->values
[i
].string
.text
;
3461 if (strcmp(reason
, "none") &&
3462 strcmp(reason
, "none-report") &&
3463 strcmp(reason
, "paused") &&
3464 strncmp(reason
, "spool-area-full", 15) &&
3465 strcmp(reason
, "com.apple.print.recoverable-warning") &&
3466 strncmp(reason
, "cups-", 5))
3467 cupsArrayAdd(new_reasons
, reason
);
3472 if (*s
== '+' || *s
== '-')
3477 new_reasons
= _cupsArrayNewStrings(s
, ',');
3483 * Compute the changes...
3487 addprefix
= "STATE: +";
3490 remprefix
= "STATE: -";
3493 fprintf(stderr
, "DEBUG2: op='%c', new_reasons=%d, state_reasons=%d\n",
3494 op
? op
: ' ', cupsArrayCount(new_reasons
),
3495 cupsArrayCount(state_reasons
));
3497 _cupsMutexLock(&report_mutex
);
3505 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3507 reason
= (char *)cupsArrayNext(new_reasons
))
3509 if (!cupsArrayFind(state_reasons
, reason
))
3511 if (!strncmp(reason
, "cups-remote-", 12))
3514 * If we are setting cups-remote-xxx, remove all other cups-remote-xxx
3518 char *temp
; /* Current reason in state_reasons */
3520 cupsArraySave(state_reasons
);
3522 for (temp
= (char *)cupsArrayFirst(state_reasons
);
3524 temp
= (char *)cupsArrayNext(state_reasons
))
3525 if (!strncmp(temp
, "cups-remote-", 12))
3527 snprintf(remptr
, sizeof(rem
) - (remptr
- rem
), "%s%s", remprefix
,
3529 remptr
+= strlen(remptr
);
3532 cupsArrayRemove(state_reasons
, temp
);
3536 cupsArrayRestore(state_reasons
);
3539 cupsArrayAdd(state_reasons
, reason
);
3541 snprintf(addptr
, sizeof(add
) - (addptr
- add
), "%s%s", addprefix
,
3543 addptr
+= strlen(addptr
);
3554 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3556 reason
= (char *)cupsArrayNext(new_reasons
))
3558 if (cupsArrayFind(state_reasons
, reason
))
3560 snprintf(remptr
, sizeof(rem
) - (remptr
- rem
), "%s%s", remprefix
,
3562 remptr
+= strlen(remptr
);
3565 cupsArrayRemove(state_reasons
, reason
);
3572 * Replace reasons...
3575 for (reason
= (char *)cupsArrayFirst(state_reasons
);
3577 reason
= (char *)cupsArrayNext(state_reasons
))
3579 if (strncmp(reason
, "cups-", 5) && !cupsArrayFind(new_reasons
, reason
))
3581 snprintf(remptr
, sizeof(rem
) - (remptr
- rem
), "%s%s", remprefix
,
3583 remptr
+= strlen(remptr
);
3586 cupsArrayRemove(state_reasons
, reason
);
3590 for (reason
= (char *)cupsArrayFirst(new_reasons
);
3592 reason
= (char *)cupsArrayNext(new_reasons
))
3594 if (!cupsArrayFind(state_reasons
, reason
))
3596 cupsArrayAdd(state_reasons
, reason
);
3598 snprintf(addptr
, sizeof(add
) - (addptr
- add
), "%s%s", addprefix
,
3600 addptr
+= strlen(addptr
);
3606 _cupsMutexUnlock(&report_mutex
);
3609 * Report changes and return...
3612 if (add
[0] && rem
[0])
3613 fprintf(stderr
, "%s\n%s\n", add
, rem
);
3615 fprintf(stderr
, "%s\n", add
);
3617 fprintf(stderr
, "%s\n", rem
);
3621 * End of "$Id: ipp.c 9759 2011-05-11 03:24:33Z mike $".