4 * IPP backend for the Common UNIX Printing System (CUPS).
6 * Copyright 2007-2009 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 * compress_files() - Compress print files...
23 * password_cb() - Disable the password prompt for
24 * cupsDoFileRequest().
25 * report_attr() - Report an IPP attribute value.
26 * report_printer_state() - Report the printer state.
27 * run_pictwps_filter() - Convert PICT files to PostScript when printing
29 * sigterm_handler() - Handle 'terminate' signals that stop the backend.
33 * Include necessary headers.
36 #include <cups/http-private.h>
37 #include "backend-private.h"
38 #include <sys/types.h>
46 static char *password
= NULL
; /* Password for device URI */
47 static int password_tries
= 0; /* Password tries */
49 static char pstmpname
[1024] = ""; /* Temporary PostScript file name */
50 #endif /* __APPLE__ */
51 static char tmpfilename
[1024] = ""; /* Temporary spool file name */
52 static int job_cancelled
= 0; /* Job cancelled? */
59 static void cancel_job(http_t
*http
, const char *uri
, int id
,
60 const char *resource
, const char *user
, int version
);
61 static void check_printer_state(http_t
*http
, const char *uri
,
62 const char *resource
, const char *user
,
63 int version
, int job_id
);
65 static void compress_files(int num_files
, char **files
);
66 #endif /* HAVE_LIBZ */
67 static const char *password_cb(const char *);
68 static void report_attr(ipp_attribute_t
*attr
);
69 static int report_printer_state(ipp_t
*ipp
, int job_id
);
72 static int run_pictwps_filter(char **argv
, const char *filename
);
73 #endif /* __APPLE__ */
74 static void sigterm_handler(int sig
);
78 * 'main()' - Send a file to the printer or server.
82 * printer-uri job-id user title copies options [file]
85 int /* O - Exit status */
86 main(int argc
, /* I - Number of command-line args */
87 char *argv
[]) /* I - Command-line arguments */
89 int i
; /* Looping var */
90 int send_options
; /* Send job options? */
91 int num_options
; /* Number of printer options */
92 cups_option_t
*options
; /* Printer options */
93 const char *device_uri
; /* Device URI */
94 char scheme
[255], /* Scheme in URI */
95 hostname
[1024], /* Hostname */
96 username
[255], /* Username info */
97 resource
[1024], /* Resource info (printer name) */
98 addrname
[256], /* Address name */
99 *optptr
, /* Pointer to URI options */
100 *name
, /* Name of option */
101 *value
, /* Value of option */
102 sep
; /* Separator character */
103 int snmp_fd
, /* SNMP socket */
104 start_count
, /* Page count via SNMP at start */
105 page_count
, /* Page count via SNMP */
106 have_supplies
; /* Printer supports supply levels? */
107 int num_files
; /* Number of files to print */
108 char **files
, /* Files to print */
109 *filename
; /* Pointer to single filename */
110 int port
; /* Port number (not used) */
111 char uri
[HTTP_MAX_URI
]; /* Updated URI without user/pass */
112 ipp_status_t ipp_status
; /* Status of IPP request */
113 http_t
*http
; /* HTTP connection */
114 ipp_t
*request
, /* IPP request */
115 *response
, /* IPP response */
116 *supported
; /* get-printer-attributes response */
117 time_t start_time
; /* Time of first connect */
118 int recoverable
; /* Recoverable error shown? */
119 int contimeout
; /* Connection timeout */
120 int delay
; /* Delay for retries... */
121 int compression
, /* Do compression of the job data? */
122 waitjob
, /* Wait for job complete? */
123 waitprinter
; /* Wait for printer ready? */
124 ipp_attribute_t
*job_id_attr
; /* job-id attribute */
125 int job_id
; /* job-id value */
126 ipp_attribute_t
*job_sheets
; /* job-media-sheets-completed */
127 ipp_attribute_t
*job_state
; /* job-state */
128 ipp_attribute_t
*copies_sup
; /* copies-supported */
129 ipp_attribute_t
*format_sup
; /* document-format-supported */
130 ipp_attribute_t
*printer_state
; /* printer-state attribute */
131 ipp_attribute_t
*printer_accepting
; /* printer-is-accepting-jobs */
132 int copies
, /* Number of copies for job */
133 copies_remaining
; /* Number of copies remaining */
134 const char *content_type
, /* CONTENT_TYPE environment variable */
135 *final_content_type
; /* FINAL_CONTENT_TYPE environment var */
136 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
137 struct sigaction action
; /* Actions for POSIX signals */
138 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
139 int version
; /* IPP version */
140 static const char * const pattrs
[] =
141 { /* Printer attributes we want */
142 "com.apple.print.recoverable-message",
144 "document-format-supported",
146 "marker-high-levels",
152 "printer-is-accepting-jobs",
154 "printer-state-message",
155 "printer-state-reasons",
157 static const char * const jattrs
[] =
158 { /* Job attributes we want */
159 "job-media-sheets-completed",
165 * Make sure status messages are not buffered...
168 setbuf(stderr
, NULL
);
171 * Ignore SIGPIPE and catch SIGTERM signals...
175 sigset(SIGPIPE
, SIG_IGN
);
176 sigset(SIGTERM
, sigterm_handler
);
177 #elif defined(HAVE_SIGACTION)
178 memset(&action
, 0, sizeof(action
));
179 action
.sa_handler
= SIG_IGN
;
180 sigaction(SIGPIPE
, &action
, NULL
);
182 sigemptyset(&action
.sa_mask
);
183 sigaddset(&action
.sa_mask
, SIGTERM
);
184 action
.sa_handler
= sigterm_handler
;
185 sigaction(SIGTERM
, &action
, NULL
);
187 signal(SIGPIPE
, SIG_IGN
);
188 signal(SIGTERM
, sigterm_handler
);
189 #endif /* HAVE_SIGSET */
192 * Check command-line...
199 if ((s
= strrchr(argv
[0], '/')) != NULL
)
204 printf("network %s \"Unknown\" \"%s (%s)\"\n",
205 s
, _cupsLangString(cupsLangDefault(),
206 _("Internet Printing Protocol")), s
);
207 return (CUPS_BACKEND_OK
);
211 _cupsLangPrintf(stderr
,
212 _("Usage: %s job-id user title copies options [file]\n"),
214 return (CUPS_BACKEND_STOP
);
218 * Get the (final) content type...
221 if ((content_type
= getenv("CONTENT_TYPE")) == NULL
)
222 content_type
= "application/octet-stream";
224 if ((final_content_type
= getenv("FINAL_CONTENT_TYPE")) == NULL
)
226 final_content_type
= content_type
;
228 if (!strncmp(final_content_type
, "printer/", 8))
229 final_content_type
= "application/vnd.cups-raw";
233 * Extract the hostname and printer name from the URI...
236 if ((device_uri
= cupsBackendDeviceURI(argv
)) == NULL
)
237 return (CUPS_BACKEND_FAILED
);
239 httpSeparateURI(HTTP_URI_CODING_ALL
, device_uri
, scheme
, sizeof(scheme
),
240 username
, sizeof(username
), hostname
, sizeof(hostname
), &port
,
241 resource
, sizeof(resource
));
244 port
= IPP_PORT
; /* Default to port 631 */
246 if (!strcmp(scheme
, "https"))
247 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
249 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
252 * See if there are any options...
259 contimeout
= 7 * 24 * 60 * 60;
261 if ((optptr
= strchr(resource
, '?')) != NULL
)
264 * Yup, terminate the device name string and move to the first
265 * character of the optptr...
271 * Then parse the optptr...
282 while (*optptr
&& *optptr
!= '=' && *optptr
!= '+' && *optptr
!= '&')
285 if ((sep
= *optptr
) != '\0')
296 while (*optptr
&& *optptr
!= '+' && *optptr
!= '&')
306 * Process the option...
309 if (!strcasecmp(name
, "waitjob"))
312 * Wait for job completion?
315 waitjob
= !strcasecmp(value
, "on") ||
316 !strcasecmp(value
, "yes") ||
317 !strcasecmp(value
, "true");
319 else if (!strcasecmp(name
, "waitprinter"))
322 * Wait for printer idle?
325 waitprinter
= !strcasecmp(value
, "on") ||
326 !strcasecmp(value
, "yes") ||
327 !strcasecmp(value
, "true");
329 else if (!strcasecmp(name
, "encryption"))
332 * Enable/disable encryption?
335 if (!strcasecmp(value
, "always"))
336 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
337 else if (!strcasecmp(value
, "required"))
338 cupsSetEncryption(HTTP_ENCRYPT_REQUIRED
);
339 else if (!strcasecmp(value
, "never"))
340 cupsSetEncryption(HTTP_ENCRYPT_NEVER
);
341 else if (!strcasecmp(value
, "ifrequested"))
342 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
345 _cupsLangPrintf(stderr
,
346 _("ERROR: Unknown encryption option value \"%s\"!\n"),
350 else if (!strcasecmp(name
, "version"))
352 if (!strcmp(value
, "1.0"))
354 else if (!strcmp(value
, "1.1"))
356 else if (!strcmp(value
, "2.0"))
358 else if (!strcmp(value
, "2.1"))
362 _cupsLangPrintf(stderr
,
363 _("ERROR: Unknown version option value \"%s\"!\n"),
368 else if (!strcasecmp(name
, "compression"))
370 compression
= !strcasecmp(value
, "true") ||
371 !strcasecmp(value
, "yes") ||
372 !strcasecmp(value
, "on") ||
373 !strcasecmp(value
, "gzip");
375 #endif /* HAVE_LIBZ */
376 else if (!strcasecmp(name
, "contimeout"))
379 * Set the connection timeout...
383 contimeout
= atoi(value
);
391 _cupsLangPrintf(stderr
,
392 _("ERROR: Unknown option \"%s\" with value \"%s\"!\n"),
399 * If we have 7 arguments, print the file named on the command-line.
400 * Otherwise, copy stdin to a temporary file and print the temporary
407 * Copy stdin to a temporary file...
410 int fd
; /* File descriptor */
411 http_addrlist_t
*addrlist
; /* Address list */
412 char buffer
[8192]; /* Buffer for copying */
413 int bytes
; /* Number of bytes read */
414 off_t tbytes
; /* Total bytes copied */
417 fputs("STATE: +connecting-to-device\n", stderr
);
418 fprintf(stderr
, "DEBUG: Looking up \"%s\"...\n", hostname
);
420 if ((addrlist
= httpAddrGetList(hostname
, AF_UNSPEC
, "1")) == NULL
)
422 _cupsLangPrintf(stderr
, _("ERROR: Unable to locate printer \'%s\'!\n"),
424 return (CUPS_BACKEND_STOP
);
427 snmp_fd
= _cupsSNMPOpen(addrlist
->addr
.addr
.sa_family
);
429 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
431 _cupsLangPrintError(_("ERROR: Unable to create temporary file"));
432 return (CUPS_BACKEND_FAILED
);
435 _cupsLangPuts(stderr
, _("INFO: Copying print data...\n"));
439 while ((bytes
= fread(buffer
, 1, sizeof(buffer
), stdin
)) > 0)
441 if (write(fd
, buffer
, bytes
) < bytes
)
443 _cupsLangPrintError(_("ERROR: Unable to write to temporary file"));
446 return (CUPS_BACKEND_FAILED
);
452 backendCheckSideChannel(snmp_fd
, &(addrlist
->addr
));
456 _cupsSNMPClose(snmp_fd
);
458 httpAddrFreeList(addrlist
);
463 * Don't try printing files less than 2 bytes...
468 _cupsLangPuts(stderr
, _("ERROR: Empty print file!\n"));
470 return (CUPS_BACKEND_FAILED
);
474 * Point to the single file from stdin...
477 filename
= tmpfilename
;
485 * Point to the files on the command-line...
488 num_files
= argc
- 6;
494 compress_files(num_files
, files
);
495 #endif /* HAVE_LIBZ */
498 fprintf(stderr
, "DEBUG: %d files to send in job...\n", num_files
);
501 * Set the authentication info, if any...
504 cupsSetPasswordCB(password_cb
);
509 * Use authenticaion information in the device URI...
512 if ((password
= strchr(username
, ':')) != NULL
)
515 cupsSetUser(username
);
520 * Try loading authentication information from the environment.
523 const char *ptr
= getenv("AUTH_USERNAME");
528 password
= getenv("AUTH_PASSWORD");
532 * Try connecting to the remote server...
537 start_time
= time(NULL
);
539 fputs("STATE: +connecting-to-device\n", stderr
);
543 fprintf(stderr
, "DEBUG: Connecting to %s:%d\n", hostname
, port
);
544 _cupsLangPuts(stderr
, _("INFO: Connecting to printer...\n"));
546 if ((http
= httpConnectEncrypt(hostname
, port
, cupsEncryption())) == NULL
)
551 if (getenv("CLASS") != NULL
)
554 * If the CLASS environment variable is set, the job was submitted
555 * to a class and not to a specific queue. In this case, we want
556 * to abort immediately so that the job can be requeued on the next
557 * available printer in the class.
560 _cupsLangPuts(stderr
,
561 _("INFO: Unable to contact printer, queuing on next "
562 "printer in class...\n"));
568 * Sleep 5 seconds to keep the job from requeuing too rapidly...
573 return (CUPS_BACKEND_FAILED
);
576 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
||
577 errno
== EHOSTUNREACH
)
579 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
581 _cupsLangPuts(stderr
, _("ERROR: Printer not responding!\n"));
582 return (CUPS_BACKEND_FAILED
);
587 _cupsLangPrintf(stderr
,
588 _("WARNING: recoverable: Network host \'%s\' is busy; "
589 "will retry in %d seconds...\n"),
599 _cupsLangPrintf(stderr
, _("ERROR: Unable to locate printer \'%s\'!\n"),
601 return (CUPS_BACKEND_STOP
);
607 fprintf(stderr
, "DEBUG: Connection error: %s\n", strerror(errno
));
608 _cupsLangPuts(stderr
,
609 _("ERROR: recoverable: Unable to connect to printer; will "
610 "retry in 30 seconds...\n"));
618 while (http
== NULL
);
620 if (job_cancelled
|| !http
)
625 return (CUPS_BACKEND_FAILED
);
628 fputs("STATE: -connecting-to-device\n", stderr
);
629 _cupsLangPuts(stderr
, _("INFO: Connected to printer...\n"));
632 if (http
->hostaddr
->addr
.sa_family
== AF_INET6
)
633 fprintf(stderr
, "DEBUG: Connected to [%s]:%d (IPv6)...\n",
634 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
635 ntohs(http
->hostaddr
->ipv6
.sin6_port
));
637 #endif /* AF_INET6 */
638 if (http
->hostaddr
->addr
.sa_family
== AF_INET
)
639 fprintf(stderr
, "DEBUG: Connected to %s:%d (IPv4)...\n",
640 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
641 ntohs(http
->hostaddr
->ipv4
.sin_port
));
644 * See if the printer supports SNMP...
647 if ((snmp_fd
= _cupsSNMPOpen(http
->hostaddr
->addr
.sa_family
)) >= 0)
648 have_supplies
= !backendSNMPSupplies(snmp_fd
, http
->hostaddr
, &start_count
,
651 have_supplies
= start_count
= 0;
654 * Build a URI for the printer and fill the standard IPP attributes for
655 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
656 * might contain username:password information...
659 snprintf(uri
, sizeof(uri
), "%s://%s:%d%s", method
, hostname
, port
, resource
);
662 * First validate the destination and see if the device supports multiple
663 * copies. We have to do this because some IPP servers (e.g. HP JetDirect)
664 * don't support the copies attribute...
674 * Check for side-channel requests...
677 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
680 * Build the IPP request...
683 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
684 request
->request
.op
.version
[0] = version
/ 10;
685 request
->request
.op
.version
[1] = version
% 10;
687 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
690 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
691 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
698 fputs("DEBUG: Getting supported attributes...\n", stderr
);
700 if (http
->version
< HTTP_1_1
)
703 if ((supported
= cupsDoRequest(http
, request
, resource
)) == NULL
)
704 ipp_status
= cupsLastError();
706 ipp_status
= supported
->request
.status
.status_code
;
708 if (ipp_status
> IPP_OK_CONFLICT
)
710 if (ipp_status
== IPP_PRINTER_BUSY
||
711 ipp_status
== IPP_SERVICE_UNAVAILABLE
)
713 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
715 _cupsLangPuts(stderr
, _("ERROR: Printer not responding!\n"));
716 return (CUPS_BACKEND_FAILED
);
721 _cupsLangPrintf(stderr
,
722 _("WARNING: recoverable: Network host \'%s\' is busy; "
723 "will retry in %d seconds...\n"),
726 report_printer_state(supported
, 0);
733 else if ((ipp_status
== IPP_BAD_REQUEST
||
734 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
> 10)
737 * Switch to IPP/1.0...
740 _cupsLangPrintf(stderr
,
741 _("INFO: Printer does not support IPP/%d.%d, trying "
742 "IPP/1.0...\n"), version
/ 10, version
% 10);
746 else if (ipp_status
== IPP_NOT_FOUND
)
748 _cupsLangPuts(stderr
, _("ERROR: Destination printer does not exist!\n"));
751 ippDelete(supported
);
753 return (CUPS_BACKEND_STOP
);
757 _cupsLangPrintf(stderr
,
758 _("ERROR: Unable to get printer status (%s)!\n"),
759 cupsLastErrorString());
764 ippDelete(supported
);
768 else if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
769 IPP_TAG_RANGE
)) != NULL
)
772 * Has the "copies-supported" attribute - does it have an upper
776 if (copies_sup
->values
[0].range
.upper
<= 1)
777 copies_sup
= NULL
; /* No */
780 format_sup
= ippFindAttribute(supported
, "document-format-supported",
785 fprintf(stderr
, "DEBUG: document-format-supported (%d values)\n",
786 format_sup
->num_values
);
787 for (i
= 0; i
< format_sup
->num_values
; i
++)
788 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
789 format_sup
->values
[i
].string
.text
);
792 report_printer_state(supported
, 0);
794 while (ipp_status
> IPP_OK_CONFLICT
);
797 * See if the printer is accepting jobs and is not stopped; if either
798 * condition is true and we are printing to a class, requeue the job...
801 if (getenv("CLASS") != NULL
)
803 printer_state
= ippFindAttribute(supported
, "printer-state",
805 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
808 if (printer_state
== NULL
||
809 (printer_state
->values
[0].integer
> IPP_PRINTER_PROCESSING
&&
811 printer_accepting
== NULL
||
812 !printer_accepting
->values
[0].boolean
)
815 * If the CLASS environment variable is set, the job was submitted
816 * to a class and not to a specific queue. In this case, we want
817 * to abort immediately so that the job can be requeued on the next
818 * available printer in the class.
821 _cupsLangPuts(stderr
,
822 _("INFO: Unable to contact printer, queuing on next "
823 "printer in class...\n"));
825 ippDelete(supported
);
832 * Sleep 5 seconds to keep the job from requeuing too rapidly...
837 return (CUPS_BACKEND_FAILED
);
844 * If we've shown a recoverable error make sure the printer proxies
845 * have a chance to see the recovered message. Not pretty but
846 * necessary for now...
849 fputs("INFO: recovered: \n", stderr
);
854 * See if the printer supports multiple copies...
857 copies
= atoi(argv
[4]);
859 if (copies_sup
|| argc
< 7)
861 copies_remaining
= 1;
867 copies_remaining
= copies
;
870 * Then issue the print-job request...
875 while (copies_remaining
> 0)
878 * Check for side-channel requests...
881 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
884 * Build the IPP request...
891 request
= ippNewRequest(IPP_CREATE_JOB
);
893 request
= ippNewRequest(IPP_PRINT_JOB
);
895 request
->request
.op
.version
[0] = version
/ 10;
896 request
->request
.op
.version
[1] = version
% 10;
898 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
901 fprintf(stderr
, "DEBUG: printer-uri = \"%s\"\n", uri
);
904 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
905 "requesting-user-name", NULL
, argv
[2]);
907 fprintf(stderr
, "DEBUG: requesting-user-name = \"%s\"\n", argv
[2]);
910 * Only add a "job-name" attribute if the remote server supports
911 * copy generation - some IPP implementations like HP's don't seem
912 * to like UTF-8 job names (STR #1837)...
915 if (argv
[3][0] && copies_sup
)
916 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
,
919 fprintf(stderr
, "DEBUG: job-name = \"%s\"\n", argv
[3]);
923 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
924 "compression", NULL
, "gzip");
925 #endif /* HAVE_LIBZ */
928 * Handle options on the command-line...
932 num_options
= cupsParseOptions(argv
[5], 0, &options
);
935 if (!strcasecmp(final_content_type
, "application/pictwps") &&
938 if (format_sup
!= NULL
)
940 for (i
= 0; i
< format_sup
->num_values
; i
++)
941 if (!strcasecmp(final_content_type
, format_sup
->values
[i
].string
.text
))
945 if (format_sup
== NULL
|| i
>= format_sup
->num_values
)
948 * Remote doesn't support "application/pictwps" (i.e. it's not MacOS X)
949 * so convert the document to PostScript...
952 if (run_pictwps_filter(argv
, files
[0]))
960 return (CUPS_BACKEND_FAILED
);
963 files
[0] = pstmpname
;
966 * Change the MIME type to application/postscript and change the
967 * number of copies to 1...
970 final_content_type
= "application/postscript";
972 copies_remaining
= 1;
976 #endif /* __APPLE__ */
978 if (format_sup
!= NULL
)
980 for (i
= 0; i
< format_sup
->num_values
; i
++)
981 if (!strcasecmp(final_content_type
, format_sup
->values
[i
].string
.text
))
984 if (i
< format_sup
->num_values
)
985 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
986 "document-format", NULL
, final_content_type
);
989 if (copies_sup
&& version
> 10 && send_options
)
992 * Only send options if the destination printer supports the copies
993 * attribute and IPP/1.1. This is a hack for the HP and Lexmark
994 * implementations of IPP, which do not accept extension attributes
995 * and incorrectly report a client-error-bad-request error instead of
996 * the successful-ok-unsupported-attributes status. In short, at least
997 * some HP and Lexmark implementations of IPP are non-compliant.
1000 cupsEncodeOptions(request
, num_options
, options
);
1002 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies",
1006 cupsFreeOptions(num_options
, options
);
1009 * If copies aren't supported, then we are likely dealing with an HP
1010 * JetDirect. The HP IPP implementation seems to close the connection
1011 * after every request - that is, it does *not* implement HTTP Keep-
1012 * Alive, which is REQUIRED by HTTP/1.1...
1016 httpReconnect(http
);
1022 if (http
->version
< HTTP_1_1
)
1023 httpReconnect(http
);
1026 response
= cupsDoRequest(http
, request
, resource
);
1028 response
= cupsDoFileRequest(http
, request
, resource
, files
[0]);
1030 ipp_status
= cupsLastError();
1032 if (ipp_status
> IPP_OK_CONFLICT
)
1039 if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
1040 ipp_status
== IPP_PRINTER_BUSY
)
1042 _cupsLangPuts(stderr
,
1043 _("INFO: Printer busy; will retry in 10 seconds...\n"));
1046 else if ((ipp_status
== IPP_BAD_REQUEST
||
1047 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
> 10)
1050 * Switch to IPP/1.0...
1053 _cupsLangPrintf(stderr
,
1054 _("INFO: Printer does not support IPP/%d.%d, trying "
1055 "IPP/1.0...\n"), version
/ 10, version
% 10);
1057 httpReconnect(http
);
1062 * Update auth-info-required as needed...
1065 _cupsLangPrintf(stderr
, _("ERROR: Print file was not accepted (%s)!\n"),
1066 cupsLastErrorString());
1068 if (ipp_status
== IPP_NOT_AUTHORIZED
)
1070 fprintf(stderr
, "DEBUG: WWW-Authenticate=\"%s\"\n",
1071 httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
));
1073 if (!strncmp(httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
),
1075 fputs("ATTR: auth-info-required=negotiate\n", stderr
);
1077 fputs("ATTR: auth-info-required=username,password\n", stderr
);
1081 else if ((job_id_attr
= ippFindAttribute(response
, "job-id",
1082 IPP_TAG_INTEGER
)) == NULL
)
1084 _cupsLangPuts(stderr
,
1085 _("NOTICE: Print file accepted - job ID unknown.\n"));
1090 job_id
= job_id_attr
->values
[0].integer
;
1091 _cupsLangPrintf(stderr
, _("NOTICE: Print file accepted - job ID %d.\n"),
1095 ippDelete(response
);
1100 if (job_id
&& num_files
> 1)
1102 for (i
= 0; i
< num_files
; i
++)
1105 * Check for side-channel requests...
1108 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1111 * Send the next file in the job...
1114 request
= ippNewRequest(IPP_SEND_DOCUMENT
);
1115 request
->request
.op
.version
[0] = version
/ 10;
1116 request
->request
.op
.version
[1] = version
% 10;
1118 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1121 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1125 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1126 "requesting-user-name", NULL
, argv
[2]);
1128 if ((i
+ 1) == num_files
)
1129 ippAddBoolean(request
, IPP_TAG_OPERATION
, "last-document", 1);
1131 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
1132 "document-format", NULL
, content_type
);
1134 if (http
->version
< HTTP_1_1
)
1135 httpReconnect(http
);
1137 ippDelete(cupsDoFileRequest(http
, request
, resource
, files
[i
]));
1139 if (cupsLastError() > IPP_OK_CONFLICT
)
1141 ipp_status
= cupsLastError();
1143 _cupsLangPrintf(stderr
,
1144 _("ERROR: Unable to add file %d to job: %s\n"),
1145 job_id
, cupsLastErrorString());
1151 if (ipp_status
<= IPP_OK_CONFLICT
&& argc
> 6)
1153 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
1154 copies_remaining
--;
1156 else if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
1157 ipp_status
== IPP_PRINTER_BUSY
)
1160 copies_remaining
--;
1163 * Wait for the job to complete...
1166 if (!job_id
|| !waitjob
)
1169 _cupsLangPuts(stderr
, _("INFO: Waiting for job to complete...\n"));
1171 for (delay
= 1; !job_cancelled
;)
1174 * Check for side-channel requests...
1177 backendCheckSideChannel(snmp_fd
, http
->hostaddr
);
1180 * Build an IPP_GET_JOB_ATTRIBUTES request...
1183 request
= ippNewRequest(IPP_GET_JOB_ATTRIBUTES
);
1184 request
->request
.op
.version
[0] = version
/ 10;
1185 request
->request
.op
.version
[1] = version
% 10;
1187 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1190 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1194 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1195 "requesting-user-name", NULL
, argv
[2]);
1197 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1198 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
1205 if (!copies_sup
|| http
->version
< HTTP_1_1
)
1206 httpReconnect(http
);
1208 response
= cupsDoRequest(http
, request
, resource
);
1209 ipp_status
= cupsLastError();
1211 if (ipp_status
== IPP_NOT_FOUND
)
1214 * Job has gone away and/or the server has no job history...
1217 ippDelete(response
);
1219 ipp_status
= IPP_OK
;
1223 if (ipp_status
> IPP_OK_CONFLICT
)
1225 if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
1226 ipp_status
!= IPP_PRINTER_BUSY
)
1228 ippDelete(response
);
1230 _cupsLangPrintf(stderr
,
1231 _("ERROR: Unable to get job %d attributes (%s)!\n"),
1232 job_id
, cupsLastErrorString());
1239 if ((job_state
= ippFindAttribute(response
, "job-state",
1240 IPP_TAG_ENUM
)) != NULL
)
1243 * Stop polling if the job is finished or pending-held...
1246 if (job_state
->values
[0].integer
> IPP_JOB_STOPPED
)
1248 if ((job_sheets
= ippFindAttribute(response
,
1249 "job-media-sheets-completed",
1250 IPP_TAG_INTEGER
)) != NULL
)
1251 fprintf(stderr
, "PAGE: total %d\n",
1252 job_sheets
->values
[0].integer
);
1254 ippDelete(response
);
1260 ippDelete(response
);
1263 * Check the printer state and report it if necessary...
1266 check_printer_state(http
, uri
, resource
, argv
[2], version
, job_id
);
1269 * Wait 1-10 seconds before polling again...
1281 * Cancel the job as needed...
1284 if (job_cancelled
&& job_id
)
1285 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1288 * Check the printer state and report it if necessary...
1291 check_printer_state(http
, uri
, resource
, argv
[2], version
, job_id
);
1294 * Collect the final page count as needed...
1297 if (have_supplies
&&
1298 !backendSNMPSupplies(snmp_fd
, http
->hostaddr
, &page_count
, NULL
) &&
1299 page_count
> start_count
)
1300 fprintf(stderr
, "PAGE: total %d\n", page_count
- start_count
);
1308 ippDelete(supported
);
1311 * Remove the temporary file(s) if necessary...
1315 unlink(tmpfilename
);
1320 for (i
= 0; i
< num_files
; i
++)
1323 #endif /* HAVE_LIBZ */
1328 #endif /* __APPLE__ */
1331 * Return the queue status...
1334 if (ipp_status
== IPP_NOT_AUTHORIZED
)
1335 return (CUPS_BACKEND_AUTH_REQUIRED
);
1336 else if (ipp_status
> IPP_OK_CONFLICT
)
1337 return (CUPS_BACKEND_FAILED
);
1339 return (CUPS_BACKEND_OK
);
1344 * 'cancel_job()' - Cancel a print job.
1348 cancel_job(http_t
*http
, /* I - HTTP connection */
1349 const char *uri
, /* I - printer-uri */
1350 int id
, /* I - job-id */
1351 const char *resource
, /* I - Resource path */
1352 const char *user
, /* I - requesting-user-name */
1353 int version
) /* I - IPP version */
1355 ipp_t
*request
; /* Cancel-Job request */
1358 _cupsLangPuts(stderr
, _("INFO: Canceling print job...\n"));
1360 request
= ippNewRequest(IPP_CANCEL_JOB
);
1361 request
->request
.op
.version
[0] = version
/ 10;
1362 request
->request
.op
.version
[1] = version
% 10;
1364 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1366 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
1368 if (user
&& user
[0])
1369 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1370 "requesting-user-name", NULL
, user
);
1376 if (http
->version
< HTTP_1_1
)
1377 httpReconnect(http
);
1379 ippDelete(cupsDoRequest(http
, request
, resource
));
1381 if (cupsLastError() > IPP_OK_CONFLICT
)
1382 _cupsLangPrintf(stderr
, _("ERROR: Unable to cancel job %d: %s\n"), id
,
1383 cupsLastErrorString());
1388 * 'check_printer_state()' - Check the printer state...
1392 check_printer_state(
1393 http_t
*http
, /* I - HTTP connection */
1394 const char *uri
, /* I - Printer URI */
1395 const char *resource
, /* I - Resource path */
1396 const char *user
, /* I - Username, if any */
1397 int version
, /* I - IPP version */
1398 int job_id
) /* I - Current job ID */
1400 ipp_t
*request
, /* IPP request */
1401 *response
; /* IPP response */
1402 static const char * const attrs
[] = /* Attributes we want */
1404 "com.apple.print.recoverable-message",
1410 "printer-state-message",
1411 "printer-state-reasons"
1416 * Check on the printer state...
1419 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
1420 request
->request
.op
.version
[0] = version
/ 10;
1421 request
->request
.op
.version
[1] = version
% 10;
1423 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1426 if (user
&& user
[0])
1427 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1428 "requesting-user-name", NULL
, user
);
1430 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1431 "requested-attributes",
1432 (int)(sizeof(attrs
) / sizeof(attrs
[0])), NULL
, attrs
);
1438 if (http
->version
< HTTP_1_1
)
1439 httpReconnect(http
);
1441 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
1443 report_printer_state(response
, job_id
);
1444 ippDelete(response
);
1451 * 'compress_files()' - Compress print files...
1455 compress_files(int num_files
, /* I - Number of files */
1456 char **files
) /* I - Files */
1458 int i
, /* Looping var */
1459 fd
; /* Temporary file descriptor */
1460 ssize_t bytes
; /* Bytes read/written */
1461 size_t total
; /* Total bytes read */
1462 cups_file_t
*in
, /* Input file */
1463 *out
; /* Output file */
1464 struct stat outinfo
; /* Output file information */
1465 char filename
[1024], /* Temporary filename */
1466 buffer
[32768]; /* Copy buffer */
1469 fprintf(stderr
, "DEBUG: Compressing %d job files...\n", num_files
);
1470 for (i
= 0; i
< num_files
; i
++)
1472 if ((fd
= cupsTempFd(filename
, sizeof(filename
))) < 0)
1474 _cupsLangPrintf(stderr
,
1475 _("ERROR: Unable to create temporary compressed print "
1476 "file: %s\n"), strerror(errno
));
1477 exit(CUPS_BACKEND_FAILED
);
1480 if ((out
= cupsFileOpenFd(fd
, "w9")) == NULL
)
1482 _cupsLangPrintf(stderr
,
1483 _("ERROR: Unable to open temporary compressed print "
1484 "file: %s\n"), strerror(errno
));
1485 exit(CUPS_BACKEND_FAILED
);
1488 if ((in
= cupsFileOpen(files
[i
], "r")) == NULL
)
1490 _cupsLangPrintf(stderr
,
1491 _("ERROR: Unable to open print file \"%s\": %s\n"),
1492 files
[i
], strerror(errno
));
1494 exit(CUPS_BACKEND_FAILED
);
1498 while ((bytes
= cupsFileRead(in
, buffer
, sizeof(buffer
))) > 0)
1499 if (cupsFileWrite(out
, buffer
, bytes
) < bytes
)
1501 _cupsLangPrintf(stderr
,
1502 _("ERROR: Unable to write %d bytes to \"%s\": %s\n"),
1503 (int)bytes
, filename
, strerror(errno
));
1506 exit(CUPS_BACKEND_FAILED
);
1514 files
[i
] = strdup(filename
);
1516 if (!stat(filename
, &outinfo
))
1518 "DEBUG: File %d compressed to %.1f%% of original size, "
1519 CUPS_LLFMT
" bytes...\n",
1520 i
+ 1, 100.0 * outinfo
.st_size
/ total
,
1521 CUPS_LLCAST outinfo
.st_size
);
1524 #endif /* HAVE_LIBZ */
1528 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
1531 static const char * /* O - Password */
1532 password_cb(const char *prompt
) /* I - Prompt (not used) */
1536 if (password
&& *password
&& password_tries
< 3)
1545 * If there is no password set in the device URI, return the
1546 * "authentication required" exit code...
1550 unlink(tmpfilename
);
1555 #endif /* __APPLE__ */
1557 fputs("ATTR: auth-info-required=username,password\n", stderr
);
1559 exit(CUPS_BACKEND_AUTH_REQUIRED
);
1561 return (NULL
); /* Eliminate compiler warning */
1567 * 'report_attr()' - Report an IPP attribute value.
1571 report_attr(ipp_attribute_t
*attr
) /* I - Attribute */
1573 int i
; /* Looping var */
1574 char value
[1024], /* Value string */
1575 *valptr
, /* Pointer into value string */
1576 *attrptr
; /* Pointer into attribute value */
1580 * Convert the attribute values into quoted strings...
1583 for (i
= 0, valptr
= value
;
1584 i
< attr
->num_values
&& valptr
< (value
+ sizeof(value
) - 10);
1590 switch (attr
->value_tag
)
1592 case IPP_TAG_INTEGER
:
1594 snprintf(valptr
, sizeof(value
) - (valptr
- value
), "%d",
1595 attr
->values
[i
].integer
);
1596 valptr
+= strlen(valptr
);
1601 case IPP_TAG_KEYWORD
:
1603 for (attrptr
= attr
->values
[i
].string
.text
;
1604 *attrptr
&& valptr
< (value
+ sizeof(value
) - 10);
1607 if (*attrptr
== '\\' || *attrptr
== '\"')
1610 *valptr
++ = *attrptr
;
1617 * Unsupported value type...
1627 * Tell the scheduler about the new values...
1630 fprintf(stderr
, "ATTR: %s=%s\n", attr
->name
, value
);
1635 * 'report_printer_state()' - Report the printer state.
1638 static int /* O - Number of reasons shown */
1639 report_printer_state(ipp_t
*ipp
, /* I - IPP response */
1640 int job_id
) /* I - Current job ID */
1642 int i
; /* Looping var */
1643 int count
; /* Count of reasons shown... */
1644 ipp_attribute_t
*caprm
, /* com.apple.print.recoverable-message */
1645 *psm
, /* printer-state-message */
1646 *reasons
, /* printer-state-reasons */
1647 *marker
; /* marker-* attributes */
1648 const char *reason
; /* Current reason */
1649 const char *prefix
; /* Prefix for STATE: line */
1650 char state
[1024]; /* State string */
1651 int saw_caprw
; /* Saw com.apple.print.recoverable-warning state */
1654 if ((psm
= ippFindAttribute(ipp
, "printer-state-message",
1655 IPP_TAG_TEXT
)) != NULL
)
1656 fprintf(stderr
, "INFO: %s\n", psm
->values
[0].string
.text
);
1658 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
1659 IPP_TAG_KEYWORD
)) == NULL
)
1666 for (i
= 0, count
= 0; i
< reasons
->num_values
; i
++)
1668 reason
= reasons
->values
[i
].string
.text
;
1670 if (!strcmp(reason
, "com.apple.print.recoverable-warning"))
1672 else if (strcmp(reason
, "paused"))
1674 strlcat(state
, prefix
, sizeof(state
));
1675 strlcat(state
, reason
, sizeof(state
));
1682 fprintf(stderr
, "%s\n", state
);
1685 * Relay com.apple.print.recoverable-message...
1688 if ((caprm
= ippFindAttribute(ipp
, "com.apple.print.recoverable-message",
1689 IPP_TAG_TEXT
)) != NULL
)
1690 fprintf(stderr
, "WARNING: %s: %s\n",
1691 saw_caprw
? "recoverable" : "recovered",
1692 caprm
->values
[0].string
.text
);
1695 * Relay the current marker-* attribute values...
1698 if ((marker
= ippFindAttribute(ipp
, "marker-colors", IPP_TAG_NAME
)) != NULL
)
1699 report_attr(marker
);
1700 if ((marker
= ippFindAttribute(ipp
, "marker-high-levels",
1701 IPP_TAG_INTEGER
)) != NULL
)
1702 report_attr(marker
);
1703 if ((marker
= ippFindAttribute(ipp
, "marker-levels",
1704 IPP_TAG_INTEGER
)) != NULL
)
1705 report_attr(marker
);
1706 if ((marker
= ippFindAttribute(ipp
, "marker-low-levels",
1707 IPP_TAG_INTEGER
)) != NULL
)
1708 report_attr(marker
);
1709 if ((marker
= ippFindAttribute(ipp
, "marker-message", IPP_TAG_TEXT
)) != NULL
)
1710 report_attr(marker
);
1711 if ((marker
= ippFindAttribute(ipp
, "marker-names", IPP_TAG_NAME
)) != NULL
)
1712 report_attr(marker
);
1713 if ((marker
= ippFindAttribute(ipp
, "marker-types", IPP_TAG_KEYWORD
)) != NULL
)
1714 report_attr(marker
);
1722 * 'run_pictwps_filter()' - Convert PICT files to PostScript when printing
1725 * This step is required because the PICT format is not documented and
1726 * subject to change, so developing a filter for other OS's is infeasible.
1727 * Also, fonts required by the PICT file need to be embedded on the
1728 * client side (which has the fonts), so we run the filter to get a
1729 * PostScript file for printing...
1732 static int /* O - Exit status of filter */
1733 run_pictwps_filter(char **argv
, /* I - Command-line arguments */
1734 const char *filename
)/* I - Filename */
1736 struct stat fileinfo
; /* Print file information */
1737 const char *ppdfile
; /* PPD file for destination printer */
1738 int pid
; /* Child process ID */
1739 int fd
; /* Temporary file descriptor */
1740 int status
; /* Exit status of filter */
1741 const char *printer
; /* PRINTER env var */
1742 static char ppdenv
[1024]; /* PPD environment variable */
1746 * First get the PPD file for the printer...
1749 printer
= getenv("PRINTER");
1752 _cupsLangPuts(stderr
,
1753 _("ERROR: PRINTER environment variable not defined!\n"));
1757 if ((ppdfile
= cupsGetPPD(printer
)) == NULL
)
1759 _cupsLangPrintf(stderr
,
1760 _("ERROR: Unable to get PPD file for printer \"%s\" - "
1761 "%s.\n"), printer
, cupsLastErrorString());
1765 snprintf(ppdenv
, sizeof(ppdenv
), "PPD=%s", ppdfile
);
1770 * Then create a temporary file for printing...
1773 if ((fd
= cupsTempFd(pstmpname
, sizeof(pstmpname
))) < 0)
1775 _cupsLangPrintError(_("ERROR: Unable to create temporary file"));
1782 * Get the owner of the spool file - it is owned by the user we want to run
1787 stat(argv
[6], &fileinfo
);
1791 * Use the OSX defaults, as an up-stream filter created the PICT
1795 fileinfo
.st_uid
= 1;
1796 fileinfo
.st_gid
= 80;
1800 chown(ppdfile
, fileinfo
.st_uid
, fileinfo
.st_gid
);
1802 fchown(fd
, fileinfo
.st_uid
, fileinfo
.st_gid
);
1805 * Finally, run the filter to convert the file...
1808 if ((pid
= fork()) == 0)
1811 * Child process for pictwpstops... Redirect output of pictwpstops to a
1821 * Change to an unpriviledged user...
1824 setgid(fileinfo
.st_gid
);
1825 setuid(fileinfo
.st_uid
);
1828 execlp("pictwpstops", printer
, argv
[1], argv
[2], argv
[3], argv
[4], argv
[5],
1830 _cupsLangPrintf(stderr
, _("ERROR: Unable to exec pictwpstops: %s\n"),
1843 _cupsLangPrintf(stderr
, _("ERROR: Unable to fork pictwpstops: %s\n"),
1851 * Now wait for the filter to complete...
1854 if (wait(&status
) < 0)
1856 _cupsLangPrintf(stderr
, _("ERROR: Unable to wait for pictwpstops: %s\n"),
1872 _cupsLangPrintf(stderr
, _("ERROR: pictwpstops exited with status %d!\n"),
1875 _cupsLangPrintf(stderr
, _("ERROR: pictwpstops exited on signal %d!\n"),
1882 * Return with no errors..
1887 #endif /* __APPLE__ */
1891 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
1895 sigterm_handler(int sig
) /* I - Signal */
1897 (void)sig
; /* remove compiler warnings... */
1902 * Flag that the job should be cancelled...
1910 * The scheduler already tried to cancel us once, now just terminate
1911 * after removing our temp files!
1915 unlink(tmpfilename
);
1920 #endif /* __APPLE__ */