2 * "$Id: ipp.c 7018 2007-10-10 22:14:03Z mike $"
4 * IPP backend for the Common UNIX Printing System (CUPS).
6 * Copyright 2007 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_printer_state() - Report the printer state.
26 * run_pictwps_filter() - Convert PICT files to PostScript when printing
28 * sigterm_handler() - Handle 'terminate' signals that stop the backend.
32 * Include necessary headers.
35 #include <cups/http-private.h>
39 #include <sys/types.h>
41 #include <cups/backend.h>
42 #include <cups/cups.h>
43 #include <cups/language.h>
44 #include <cups/i18n.h>
45 #include <cups/string.h>
53 static char *password
= NULL
; /* Password for device URI */
54 static int password_tries
= 0; /* Password tries */
56 static char pstmpname
[1024] = ""; /* Temporary PostScript file name */
57 #endif /* __APPLE__ */
58 static char tmpfilename
[1024] = ""; /* Temporary spool file name */
59 static int job_cancelled
= 0; /* Job cancelled? */
66 static void cancel_job(http_t
*http
, const char *uri
, int id
,
67 const char *resource
, const char *user
, int version
);
68 static void check_printer_state(http_t
*http
, const char *uri
,
69 const char *resource
, const char *user
,
70 int version
, int job_id
);
72 static void compress_files(int num_files
, char **files
);
73 #endif /* HAVE_LIBZ */
74 static const char *password_cb(const char *);
75 static int report_printer_state(ipp_t
*ipp
, int job_id
);
78 static int run_pictwps_filter(char **argv
, const char *filename
);
79 #endif /* __APPLE__ */
80 static void sigterm_handler(int sig
);
84 * 'main()' - Send a file to the printer or server.
88 * printer-uri job-id user title copies options [file]
91 int /* O - Exit status */
92 main(int argc
, /* I - Number of command-line args */
93 char *argv
[]) /* I - Command-line arguments */
95 int i
; /* Looping var */
96 int send_options
; /* Send job options? */
97 int num_options
; /* Number of printer options */
98 cups_option_t
*options
; /* Printer options */
99 char method
[255], /* Method in URI */
100 hostname
[1024], /* Hostname */
101 username
[255], /* Username info */
102 resource
[1024], /* Resource info (printer name) */
103 addrname
[256], /* Address name */
104 *optptr
, /* Pointer to URI options */
105 *name
, /* Name of option */
106 *value
, /* Value of option */
107 sep
; /* Separator character */
108 int num_files
; /* Number of files to print */
109 char **files
, /* Files to print */
110 *filename
; /* Pointer to single filename */
111 int port
; /* Port number (not used) */
112 char uri
[HTTP_MAX_URI
]; /* Updated URI without user/pass */
113 ipp_status_t ipp_status
; /* Status of IPP request */
114 http_t
*http
; /* HTTP connection */
115 ipp_t
*request
, /* IPP request */
116 *response
, /* IPP response */
117 *supported
; /* get-printer-attributes response */
118 time_t start_time
; /* Time of first connect */
119 int recoverable
; /* Recoverable error shown? */
120 int contimeout
; /* Connection timeout */
121 int delay
; /* Delay for retries... */
122 int compression
, /* Do compression of the job data? */
123 waitjob
, /* Wait for job complete? */
124 waitprinter
; /* Wait for printer ready? */
125 ipp_attribute_t
*job_id_attr
; /* job-id attribute */
126 int job_id
; /* job-id value */
127 ipp_attribute_t
*job_sheets
; /* job-media-sheets-completed */
128 ipp_attribute_t
*job_state
; /* job-state */
129 ipp_attribute_t
*copies_sup
; /* copies-supported */
130 ipp_attribute_t
*format_sup
; /* document-format-supported */
131 ipp_attribute_t
*printer_state
; /* printer-state attribute */
132 ipp_attribute_t
*printer_accepting
; /* printer-is-accepting-jobs */
133 int copies
, /* Number of copies for job */
134 copies_remaining
; /* Number of copies remaining */
135 const char *content_type
, /* CONTENT_TYPE environment variable */
136 *final_content_type
; /* FINAL_CONTENT_TYPE environment var */
137 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
138 struct sigaction action
; /* Actions for POSIX signals */
139 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
140 int version
; /* IPP version */
141 static const char * const pattrs
[] =
142 { /* Printer attributes we want */
144 "document-format-supported",
145 "printer-is-accepting-jobs",
147 "printer-state-message",
148 "printer-state-reasons",
150 static const char * const jattrs
[] =
151 { /* Job attributes we want */
152 "job-media-sheets-completed",
158 * Make sure status messages are not buffered...
161 setbuf(stderr
, NULL
);
164 * Ignore SIGPIPE and catch SIGTERM signals...
168 sigset(SIGPIPE
, SIG_IGN
);
169 sigset(SIGTERM
, sigterm_handler
);
170 #elif defined(HAVE_SIGACTION)
171 memset(&action
, 0, sizeof(action
));
172 action
.sa_handler
= SIG_IGN
;
173 sigaction(SIGPIPE
, &action
, NULL
);
175 sigemptyset(&action
.sa_mask
);
176 sigaddset(&action
.sa_mask
, SIGTERM
);
177 action
.sa_handler
= sigterm_handler
;
178 sigaction(SIGTERM
, &action
, NULL
);
180 signal(SIGPIPE
, SIG_IGN
);
181 signal(SIGTERM
, sigterm_handler
);
182 #endif /* HAVE_SIGSET */
185 * Check command-line...
192 if ((s
= strrchr(argv
[0], '/')) != NULL
)
197 printf("network %s \"Unknown\" \"Internet Printing Protocol (%s)\"\n",
199 return (CUPS_BACKEND_OK
);
203 _cupsLangPrintf(stderr
,
204 _("Usage: %s job-id user title copies options [file]\n"),
206 return (CUPS_BACKEND_STOP
);
210 * Get the (final) content type...
213 if ((content_type
= getenv("CONTENT_TYPE")) == NULL
)
214 content_type
= "application/octet-stream";
216 if ((final_content_type
= getenv("FINAL_CONTENT_TYPE")) == NULL
)
218 final_content_type
= content_type
;
220 if (!strncmp(final_content_type
, "printer/", 8))
221 final_content_type
= "application/vnd.cups-raw";
225 * Extract the hostname and printer name from the URI...
228 if (httpSeparateURI(HTTP_URI_CODING_ALL
, cupsBackendDeviceURI(argv
),
229 method
, sizeof(method
), username
, sizeof(username
),
230 hostname
, sizeof(hostname
), &port
,
231 resource
, sizeof(resource
)) < HTTP_URI_OK
)
233 _cupsLangPuts(stderr
,
234 _("ERROR: Missing device URI on command-line and no "
235 "DEVICE_URI environment variable!\n"));
236 return (CUPS_BACKEND_STOP
);
240 port
= IPP_PORT
; /* Default to port 631 */
242 if (!strcmp(method
, "https"))
243 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
245 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
248 * See if there are any options...
255 contimeout
= 7 * 24 * 60 * 60;
257 if ((optptr
= strchr(resource
, '?')) != NULL
)
260 * Yup, terminate the device name string and move to the first
261 * character of the optptr...
267 * Then parse the optptr...
278 while (*optptr
&& *optptr
!= '=' && *optptr
!= '+' && *optptr
!= '&')
281 if ((sep
= *optptr
) != '\0')
292 while (*optptr
&& *optptr
!= '+' && *optptr
!= '&')
302 * Process the option...
305 if (!strcasecmp(name
, "waitjob"))
308 * Wait for job completion?
311 waitjob
= !strcasecmp(value
, "on") ||
312 !strcasecmp(value
, "yes") ||
313 !strcasecmp(value
, "true");
315 else if (!strcasecmp(name
, "waitprinter"))
318 * Wait for printer idle?
321 waitprinter
= !strcasecmp(value
, "on") ||
322 !strcasecmp(value
, "yes") ||
323 !strcasecmp(value
, "true");
325 else if (!strcasecmp(name
, "encryption"))
328 * Enable/disable encryption?
331 if (!strcasecmp(value
, "always"))
332 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
333 else if (!strcasecmp(value
, "required"))
334 cupsSetEncryption(HTTP_ENCRYPT_REQUIRED
);
335 else if (!strcasecmp(value
, "never"))
336 cupsSetEncryption(HTTP_ENCRYPT_NEVER
);
337 else if (!strcasecmp(value
, "ifrequested"))
338 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
341 _cupsLangPrintf(stderr
,
342 _("ERROR: Unknown encryption option value \"%s\"!\n"),
346 else if (!strcasecmp(name
, "version"))
348 if (!strcmp(value
, "1.0"))
350 else if (!strcmp(value
, "1.1"))
354 _cupsLangPrintf(stderr
,
355 _("ERROR: Unknown version option value \"%s\"!\n"),
360 else if (!strcasecmp(name
, "compression"))
362 compression
= !strcasecmp(value
, "true") ||
363 !strcasecmp(value
, "yes") ||
364 !strcasecmp(value
, "on") ||
365 !strcasecmp(value
, "gzip");
367 #endif /* HAVE_LIBZ */
368 else if (!strcasecmp(name
, "contimeout"))
371 * Set the connection timeout...
375 contimeout
= atoi(value
);
383 _cupsLangPrintf(stderr
,
384 _("ERROR: Unknown option \"%s\" with value \"%s\"!\n"),
391 * If we have 7 arguments, print the file named on the command-line.
392 * Otherwise, copy stdin to a temporary file and print the temporary
399 * Copy stdin to a temporary file...
402 int fd
; /* File descriptor */
403 cups_file_t
*fp
; /* Temporary file */
404 char buffer
[8192]; /* Buffer for copying */
405 int bytes
; /* Number of bytes read */
408 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
410 perror("ERROR: unable to create temporary file");
411 return (CUPS_BACKEND_FAILED
);
414 if ((fp
= cupsFileOpenFd(fd
, compression
? "w9" : "w")) == NULL
)
416 perror("ERROR: unable to open temporary file");
419 return (CUPS_BACKEND_FAILED
);
422 while ((bytes
= fread(buffer
, 1, sizeof(buffer
), stdin
)) > 0)
423 if (cupsFileWrite(fp
, buffer
, bytes
) < bytes
)
425 perror("ERROR: unable to write to temporary file");
428 return (CUPS_BACKEND_FAILED
);
434 * Point to the single file from stdin...
437 filename
= tmpfilename
;
445 * Point to the files on the command-line...
448 num_files
= argc
- 6;
454 compress_files(num_files
, files
);
455 #endif /* HAVE_LIBZ */
458 fprintf(stderr
, "DEBUG: %d files to send in job...\n", num_files
);
461 * Set the authentication info, if any...
464 cupsSetPasswordCB(password_cb
);
469 * Use authenticaion information in the device URI...
472 if ((password
= strchr(username
, ':')) != NULL
)
475 cupsSetUser(username
);
480 * Try loading authentication information from the environment.
483 const char *ptr
= getenv("AUTH_USERNAME");
488 password
= getenv("AUTH_PASSWORD");
492 * Try connecting to the remote server...
497 start_time
= time(NULL
);
499 fputs("STATE: +connecting-to-device\n", stderr
);
503 _cupsLangPrintf(stderr
, _("INFO: Connecting to %s on port %d...\n"),
506 if ((http
= httpConnectEncrypt(hostname
, port
, cupsEncryption())) == NULL
)
511 if (getenv("CLASS") != NULL
)
514 * If the CLASS environment variable is set, the job was submitted
515 * to a class and not to a specific queue. In this case, we want
516 * to abort immediately so that the job can be requeued on the next
517 * available printer in the class.
520 _cupsLangPuts(stderr
,
521 _("INFO: Unable to contact printer, queuing on next "
522 "printer in class...\n"));
524 if (argc
== 6 || strcmp(filename
, argv
[6]))
528 * Sleep 5 seconds to keep the job from requeuing too rapidly...
533 return (CUPS_BACKEND_FAILED
);
536 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
||
537 errno
== EHOSTUNREACH
)
539 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
541 _cupsLangPuts(stderr
, _("ERROR: Printer not responding!\n"));
542 return (CUPS_BACKEND_FAILED
);
547 _cupsLangPrintf(stderr
,
548 _("WARNING: recoverable: Network host \'%s\' is busy; "
549 "will retry in %d seconds...\n"),
559 _cupsLangPrintf(stderr
, _("ERROR: Unable to locate printer \'%s\'!\n"),
561 return (CUPS_BACKEND_STOP
);
567 fprintf(stderr
, "DEBUG: Connection error: %s\n", strerror(errno
));
568 _cupsLangPuts(stderr
,
569 _("ERROR: recoverable: Unable to connect to printer; will "
570 "retry in 30 seconds...\n"));
578 while (http
== NULL
);
582 if (argc
== 6 || strcmp(filename
, argv
[6]))
585 return (CUPS_BACKEND_FAILED
);
588 fputs("STATE: -connecting-to-device\n", stderr
);
589 _cupsLangPrintf(stderr
, _("INFO: Connected to %s...\n"), hostname
);
592 if (http
->hostaddr
->addr
.sa_family
== AF_INET6
)
593 fprintf(stderr
, "DEBUG: Connected to [%s]:%d (IPv6)...\n",
594 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
595 ntohs(http
->hostaddr
->ipv6
.sin6_port
));
597 #endif /* AF_INET6 */
598 if (http
->hostaddr
->addr
.sa_family
== AF_INET
)
599 fprintf(stderr
, "DEBUG: Connected to %s:%d (IPv4)...\n",
600 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
601 ntohs(http
->hostaddr
->ipv4
.sin_port
));
604 * Build a URI for the printer and fill the standard IPP attributes for
605 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
606 * might contain username:password information...
609 snprintf(uri
, sizeof(uri
), "%s://%s:%d%s", method
, hostname
, port
, resource
);
612 * First validate the destination and see if the device supports multiple
613 * copies. We have to do this because some IPP servers (e.g. HP JetDirect)
614 * don't support the copies attribute...
624 * Build the IPP request...
627 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
628 request
->request
.op
.version
[1] = version
;
630 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
633 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
634 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
641 fputs("DEBUG: Getting supported attributes...\n", stderr
);
643 if ((supported
= cupsDoRequest(http
, request
, resource
)) == NULL
)
644 ipp_status
= cupsLastError();
646 ipp_status
= supported
->request
.status
.status_code
;
648 if (ipp_status
> IPP_OK_CONFLICT
)
650 if (ipp_status
== IPP_PRINTER_BUSY
||
651 ipp_status
== IPP_SERVICE_UNAVAILABLE
)
653 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
655 _cupsLangPuts(stderr
, _("ERROR: Printer not responding!\n"));
656 return (CUPS_BACKEND_FAILED
);
661 _cupsLangPrintf(stderr
,
662 _("WARNING: recoverable: Network host \'%s\' is busy; "
663 "will retry in %d seconds...\n"),
666 report_printer_state(supported
, 0);
673 else if ((ipp_status
== IPP_BAD_REQUEST
||
674 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
== 1)
677 * Switch to IPP/1.0...
680 _cupsLangPuts(stderr
,
681 _("INFO: Printer does not support IPP/1.1, trying "
686 else if (ipp_status
== IPP_NOT_FOUND
)
688 _cupsLangPuts(stderr
, _("ERROR: Destination printer does not exist!\n"));
691 ippDelete(supported
);
693 return (CUPS_BACKEND_STOP
);
697 _cupsLangPrintf(stderr
,
698 _("ERROR: Unable to get printer status (%s)!\n"),
699 cupsLastErrorString());
704 ippDelete(supported
);
708 else if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
709 IPP_TAG_RANGE
)) != NULL
)
712 * Has the "copies-supported" attribute - does it have an upper
716 if (copies_sup
->values
[0].range
.upper
<= 1)
717 copies_sup
= NULL
; /* No */
720 format_sup
= ippFindAttribute(supported
, "document-format-supported",
725 fprintf(stderr
, "DEBUG: document-format-supported (%d values)\n",
726 format_sup
->num_values
);
727 for (i
= 0; i
< format_sup
->num_values
; i
++)
728 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
729 format_sup
->values
[i
].string
.text
);
732 report_printer_state(supported
, 0);
734 while (ipp_status
> IPP_OK_CONFLICT
);
737 * See if the printer is accepting jobs and is not stopped; if either
738 * condition is true and we are printing to a class, requeue the job...
741 if (getenv("CLASS") != NULL
)
743 printer_state
= ippFindAttribute(supported
, "printer-state",
745 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
748 if (printer_state
== NULL
||
749 (printer_state
->values
[0].integer
> IPP_PRINTER_PROCESSING
&&
751 printer_accepting
== NULL
||
752 !printer_accepting
->values
[0].boolean
)
755 * If the CLASS environment variable is set, the job was submitted
756 * to a class and not to a specific queue. In this case, we want
757 * to abort immediately so that the job can be requeued on the next
758 * available printer in the class.
761 _cupsLangPuts(stderr
,
762 _("INFO: Unable to contact printer, queuing on next "
763 "printer in class...\n"));
765 ippDelete(supported
);
768 if (argc
== 6 || strcmp(filename
, argv
[6]))
772 * Sleep 5 seconds to keep the job from requeuing too rapidly...
777 return (CUPS_BACKEND_FAILED
);
784 * If we've shown a recoverable error make sure the printer proxies
785 * have a chance to see the recovered message. Not pretty but
786 * necessary for now...
789 fputs("INFO: recovered: \n", stderr
);
794 * See if the printer supports multiple copies...
797 copies
= atoi(argv
[4]);
799 if (copies_sup
|| argc
< 7)
801 copies_remaining
= 1;
807 copies_remaining
= copies
;
810 * Then issue the print-job request...
815 while (copies_remaining
> 0)
818 * Build the IPP request...
825 request
= ippNewRequest(IPP_CREATE_JOB
);
827 request
= ippNewRequest(IPP_PRINT_JOB
);
829 request
->request
.op
.version
[1] = version
;
831 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
834 fprintf(stderr
, "DEBUG: printer-uri = \"%s\"\n", uri
);
837 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
838 "requesting-user-name", NULL
, argv
[2]);
840 fprintf(stderr
, "DEBUG: requesting-user-name = \"%s\"\n", argv
[2]);
843 * Only add a "job-name" attribute if the remote server supports
844 * copy generation - some IPP implementations like HP's don't seem
845 * to like UTF-8 job names (STR #1837)...
848 if (argv
[3][0] && copies_sup
)
849 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
,
852 fprintf(stderr
, "DEBUG: job-name = \"%s\"\n", argv
[3]);
856 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
857 "compression", NULL
, "gzip");
858 #endif /* HAVE_LIBZ */
861 * Handle options on the command-line...
865 num_options
= cupsParseOptions(argv
[5], 0, &options
);
868 if (!strcasecmp(content_type
, "application/pictwps") && num_files
== 1)
870 if (format_sup
!= NULL
)
872 for (i
= 0; i
< format_sup
->num_values
; i
++)
873 if (!strcasecmp(content_type
, format_sup
->values
[i
].string
.text
))
877 if (format_sup
== NULL
|| i
>= format_sup
->num_values
)
880 * Remote doesn't support "application/pictwps" (i.e. it's not MacOS X)
881 * so convert the document to PostScript...
884 if (run_pictwps_filter(argv
, filename
))
885 return (CUPS_BACKEND_FAILED
);
887 filename
= pstmpname
;
890 * Change the MIME type to application/postscript and change the
891 * number of copies to 1...
894 final_content_type
= "application/postscript";
896 copies_remaining
= 1;
900 #endif /* __APPLE__ */
902 if (format_sup
!= NULL
)
904 for (i
= 0; i
< format_sup
->num_values
; i
++)
905 if (!strcasecmp(final_content_type
, format_sup
->values
[i
].string
.text
))
908 if (i
< format_sup
->num_values
)
909 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
910 "document-format", NULL
, final_content_type
);
913 if (copies_sup
&& version
> 0 && send_options
)
916 * Only send options if the destination printer supports the copies
917 * attribute and IPP/1.1. This is a hack for the HP and Lexmark
918 * implementations of IPP, which do not accept extension attributes
919 * and incorrectly report a client-error-bad-request error instead of
920 * the successful-ok-unsupported-attributes status. In short, at least
921 * some HP and Lexmark implementations of IPP are non-compliant.
924 cupsEncodeOptions(request
, num_options
, options
);
926 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies",
930 cupsFreeOptions(num_options
, options
);
933 * If copies aren't supported, then we are likely dealing with an HP
934 * JetDirect. The HP IPP implementation seems to close the connection
935 * after every request - that is, it does *not* implement HTTP Keep-
936 * Alive, which is REQUIRED by HTTP/1.1...
947 response
= cupsDoRequest(http
, request
, resource
);
949 response
= cupsDoFileRequest(http
, request
, resource
, files
[0]);
951 ipp_status
= cupsLastError();
953 if (ipp_status
> IPP_OK_CONFLICT
)
960 if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
961 ipp_status
== IPP_PRINTER_BUSY
)
963 _cupsLangPuts(stderr
,
964 _("INFO: Printer busy; will retry in 10 seconds...\n"));
967 else if ((ipp_status
== IPP_BAD_REQUEST
||
968 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
== 1)
971 * Switch to IPP/1.0...
974 _cupsLangPuts(stderr
,
975 _("INFO: Printer does not support IPP/1.1, trying "
981 _cupsLangPrintf(stderr
, _("ERROR: Print file was not accepted (%s)!\n"),
982 cupsLastErrorString());
984 else if ((job_id_attr
= ippFindAttribute(response
, "job-id",
985 IPP_TAG_INTEGER
)) == NULL
)
987 _cupsLangPuts(stderr
,
988 _("NOTICE: Print file accepted - job ID unknown.\n"));
993 job_id
= job_id_attr
->values
[0].integer
;
994 _cupsLangPrintf(stderr
, _("NOTICE: Print file accepted - job ID %d.\n"),
1003 if (job_id
&& num_files
> 1)
1005 for (i
= 0; i
< num_files
; i
++)
1007 request
= ippNewRequest(IPP_SEND_DOCUMENT
);
1009 request
->request
.op
.version
[1] = version
;
1011 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1014 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1018 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1019 "requesting-user-name", NULL
, argv
[2]);
1021 if ((i
+ 1) == num_files
)
1022 ippAddBoolean(request
, IPP_TAG_OPERATION
, "last-document", 1);
1024 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
1025 "document-format", NULL
, content_type
);
1027 ippDelete(cupsDoFileRequest(http
, request
, resource
, files
[i
]));
1029 if (cupsLastError() > IPP_OK_CONFLICT
)
1031 ipp_status
= cupsLastError();
1033 _cupsLangPrintf(stderr
,
1034 _("ERROR: Unable to add file %d to job: %s\n"),
1035 job_id
, cupsLastErrorString());
1041 if (ipp_status
<= IPP_OK_CONFLICT
&& argc
> 6)
1043 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
1044 copies_remaining
--;
1046 else if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
1047 ipp_status
== IPP_PRINTER_BUSY
)
1050 copies_remaining
--;
1053 * Wait for the job to complete...
1056 if (!job_id
|| !waitjob
)
1059 _cupsLangPuts(stderr
, _("INFO: Waiting for job to complete...\n"));
1061 for (delay
= 1; !job_cancelled
;)
1064 * Build an IPP_GET_JOB_ATTRIBUTES request...
1067 request
= ippNewRequest(IPP_GET_JOB_ATTRIBUTES
);
1068 request
->request
.op
.version
[1] = version
;
1070 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1073 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1077 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1078 "requesting-user-name", NULL
, argv
[2]);
1080 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1081 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
1089 httpReconnect(http
);
1091 response
= cupsDoRequest(http
, request
, resource
);
1092 ipp_status
= cupsLastError();
1094 if (ipp_status
== IPP_NOT_FOUND
)
1097 * Job has gone away and/or the server has no job history...
1100 ippDelete(response
);
1102 ipp_status
= IPP_OK
;
1106 if (ipp_status
> IPP_OK_CONFLICT
)
1108 if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
1109 ipp_status
!= IPP_PRINTER_BUSY
)
1111 ippDelete(response
);
1113 _cupsLangPrintf(stderr
,
1114 _("ERROR: Unable to get job %d attributes (%s)!\n"),
1115 job_id
, cupsLastErrorString());
1122 if ((job_state
= ippFindAttribute(response
, "job-state",
1123 IPP_TAG_ENUM
)) != NULL
)
1126 * Stop polling if the job is finished or pending-held...
1129 if (job_state
->values
[0].integer
> IPP_JOB_STOPPED
)
1131 if ((job_sheets
= ippFindAttribute(response
,
1132 "job-media-sheets-completed",
1133 IPP_TAG_INTEGER
)) != NULL
)
1134 fprintf(stderr
, "PAGE: total %d\n",
1135 job_sheets
->values
[0].integer
);
1137 ippDelete(response
);
1143 ippDelete(response
);
1146 * Check the printer state and report it if necessary...
1149 check_printer_state(http
, uri
, resource
, argv
[2], version
, job_id
);
1152 * Wait 1-10 seconds before polling again...
1164 * Cancel the job as needed...
1167 if (job_cancelled
&& job_id
)
1168 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1171 * Check the printer state and report it if necessary...
1174 check_printer_state(http
, uri
, resource
, argv
[2], version
, job_id
);
1182 ippDelete(supported
);
1185 * Remove the temporary file(s) if necessary...
1189 unlink(tmpfilename
);
1194 for (i
= 0; i
< num_files
; i
++)
1197 #endif /* HAVE_LIBZ */
1202 #endif /* __APPLE__ */
1205 * Return the queue status...
1208 if (ipp_status
== IPP_NOT_AUTHORIZED
)
1211 * Authorization failures here mean that we need Kerberos. Username +
1212 * password authentication is handled in the password_cb function.
1215 fputs("ATTR: auth-info-required=negotiate\n", stderr
);
1216 return (CUPS_BACKEND_AUTH_REQUIRED
);
1218 else if (ipp_status
> IPP_OK_CONFLICT
)
1219 return (CUPS_BACKEND_FAILED
);
1221 return (CUPS_BACKEND_OK
);
1226 * 'cancel_job()' - Cancel a print job.
1230 cancel_job(http_t
*http
, /* I - HTTP connection */
1231 const char *uri
, /* I - printer-uri */
1232 int id
, /* I - job-id */
1233 const char *resource
, /* I - Resource path */
1234 const char *user
, /* I - requesting-user-name */
1235 int version
) /* I - IPP version */
1237 ipp_t
*request
; /* Cancel-Job request */
1240 _cupsLangPuts(stderr
, _("INFO: Canceling print job...\n"));
1242 request
= ippNewRequest(IPP_CANCEL_JOB
);
1243 request
->request
.op
.version
[1] = version
;
1245 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1247 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
1249 if (user
&& user
[0])
1250 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1251 "requesting-user-name", NULL
, user
);
1257 ippDelete(cupsDoRequest(http
, request
, resource
));
1259 if (cupsLastError() > IPP_OK_CONFLICT
)
1260 _cupsLangPrintf(stderr
, _("ERROR: Unable to cancel job %d: %s\n"), id
,
1261 cupsLastErrorString());
1266 * 'check_printer_state()' - Check the printer state...
1270 check_printer_state(
1271 http_t
*http
, /* I - HTTP connection */
1272 const char *uri
, /* I - Printer URI */
1273 const char *resource
, /* I - Resource path */
1274 const char *user
, /* I - Username, if any */
1275 int version
, /* I - IPP version */
1276 int job_id
) /* I - Current job ID */
1278 ipp_t
*request
, /* IPP request */
1279 *response
; /* IPP response */
1280 static const char * const attrs
[] = /* Attributes we want */
1282 "printer-state-message",
1283 "printer-state-reasons"
1288 * Check on the printer state...
1291 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
1292 request
->request
.op
.version
[1] = version
;
1294 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1297 if (user
&& user
[0])
1298 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1299 "requesting-user-name", NULL
, user
);
1301 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1302 "requested-attributes",
1303 (int)(sizeof(attrs
) / sizeof(attrs
[0])), NULL
, attrs
);
1309 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
1311 report_printer_state(response
, job_id
);
1312 ippDelete(response
);
1319 * 'compress_files()' - Compress print files...
1323 compress_files(int num_files
, /* I - Number of files */
1324 char **files
) /* I - Files */
1326 int i
, /* Looping var */
1327 fd
; /* Temporary file descriptor */
1328 ssize_t bytes
; /* Bytes read/written */
1329 size_t total
; /* Total bytes read */
1330 cups_file_t
*in
, /* Input file */
1331 *out
; /* Output file */
1332 struct stat outinfo
; /* Output file information */
1333 char filename
[1024], /* Temporary filename */
1334 buffer
[32768]; /* Copy buffer */
1337 fprintf(stderr
, "DEBUG: Compressing %d job files...\n", num_files
);
1338 for (i
= 0; i
< num_files
; i
++)
1340 if ((fd
= cupsTempFd(filename
, sizeof(filename
))) < 0)
1342 _cupsLangPrintf(stderr
,
1343 _("ERROR: Unable to create temporary compressed print "
1344 "file: %s\n"), strerror(errno
));
1345 exit(CUPS_BACKEND_FAILED
);
1348 if ((out
= cupsFileOpenFd(fd
, "w9")) == NULL
)
1350 _cupsLangPrintf(stderr
,
1351 _("ERROR: Unable to open temporary compressed print "
1352 "file: %s\n"), strerror(errno
));
1353 exit(CUPS_BACKEND_FAILED
);
1356 if ((in
= cupsFileOpen(files
[i
], "r")) == NULL
)
1358 _cupsLangPrintf(stderr
,
1359 _("ERROR: Unable to open print file \"%s\": %s\n"),
1360 files
[i
], strerror(errno
));
1362 exit(CUPS_BACKEND_FAILED
);
1366 while ((bytes
= cupsFileRead(in
, buffer
, sizeof(buffer
))) > 0)
1367 if (cupsFileWrite(out
, buffer
, bytes
) < bytes
)
1369 _cupsLangPrintf(stderr
,
1370 _("ERROR: Unable to write %d bytes to \"%s\": %s\n"),
1371 (int)bytes
, filename
, strerror(errno
));
1374 exit(CUPS_BACKEND_FAILED
);
1382 files
[i
] = strdup(filename
);
1384 if (!stat(filename
, &outinfo
))
1386 "DEBUG: File %d compressed to %.1f%% of original size, "
1387 CUPS_LLFMT
" bytes...\n",
1388 i
+ 1, 100.0 * outinfo
.st_size
/ total
,
1389 CUPS_LLCAST outinfo
.st_size
);
1392 #endif /* HAVE_LIBZ */
1396 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
1399 static const char * /* O - Password */
1400 password_cb(const char *prompt
) /* I - Prompt (not used) */
1404 if (password
&& password_tries
< 3)
1413 * If there is no password set in the device URI, return the
1414 * "authentication required" exit code...
1418 unlink(tmpfilename
);
1423 #endif /* __APPLE__ */
1425 fputs("ATTR: auth-info-required=username,password\n", stderr
);
1427 exit(CUPS_BACKEND_AUTH_REQUIRED
);
1429 return (NULL
); /* Eliminate compiler warning */
1435 * 'report_printer_state()' - Report the printer state.
1438 static int /* O - Number of reasons shown */
1439 report_printer_state(ipp_t
*ipp
, /* I - IPP response */
1440 int job_id
) /* I - Current job ID */
1442 int i
; /* Looping var */
1443 int count
; /* Count of reasons shown... */
1444 ipp_attribute_t
*psm
, /* pritner-state-message */
1445 *reasons
; /* printer-state-reasons */
1446 const char *reason
; /* Current reason */
1447 const char *message
; /* Message to show */
1448 char unknown
[1024]; /* Unknown message string */
1449 const char *prefix
; /* Prefix for STATE: line */
1450 char state
[1024]; /* State string */
1451 cups_lang_t
*language
; /* Current localization */
1454 if ((psm
= ippFindAttribute(ipp
, "printer-state-message",
1455 IPP_TAG_TEXT
)) != NULL
)
1456 fprintf(stderr
, "INFO: %s\n", psm
->values
[0].string
.text
);
1458 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
1459 IPP_TAG_KEYWORD
)) == NULL
)
1464 language
= cupsLangDefault();
1466 for (i
= 0, count
= 0; i
< reasons
->num_values
; i
++)
1468 reason
= reasons
->values
[i
].string
.text
;
1470 if (job_id
== 0 || strcmp(reason
, "paused"))
1472 strlcat(state
, prefix
, sizeof(state
));
1473 strlcat(state
, reason
, sizeof(state
));
1480 if (!strncmp(reason
, "media-needed", 12))
1481 message
= _("Media tray needs to be filled.");
1482 else if (!strncmp(reason
, "media-jam", 9))
1483 message
= _("Media jam!");
1484 else if (!strncmp(reason
, "moving-to-paused", 16) ||
1485 !strncmp(reason
, "paused", 6) ||
1486 !strncmp(reason
, "shutdown", 8))
1487 message
= _("Printer off-line.");
1488 else if (!strncmp(reason
, "toner-low", 9))
1489 message
= _("Toner low.");
1490 else if (!strncmp(reason
, "toner-empty", 11))
1491 message
= _("Out of toner!");
1492 else if (!strncmp(reason
, "cover-open", 10))
1493 message
= _("Cover open.");
1494 else if (!strncmp(reason
, "interlock-open", 14))
1495 message
= _("Interlock open.");
1496 else if (!strncmp(reason
, "door-open", 9))
1497 message
= _("Door open.");
1498 else if (!strncmp(reason
, "input-tray-missing", 18))
1499 message
= _("Media tray missing!");
1500 else if (!strncmp(reason
, "media-low", 9))
1501 message
= _("Media tray almost empty.");
1502 else if (!strncmp(reason
, "media-empty", 11))
1503 message
= _("Media tray empty!");
1504 else if (!strncmp(reason
, "output-tray-missing", 19))
1505 message
= _("Output tray missing!");
1506 else if (!strncmp(reason
, "output-area-almost-full", 23))
1507 message
= _("Output bin almost full.");
1508 else if (!strncmp(reason
, "output-area-full", 16))
1509 message
= _("Output bin full!");
1510 else if (!strncmp(reason
, "marker-supply-low", 17))
1511 message
= _("Ink/toner almost empty.");
1512 else if (!strncmp(reason
, "marker-supply-empty", 19))
1513 message
= _("Ink/toner empty!");
1514 else if (!strncmp(reason
, "marker-waste-almost-full", 24))
1515 message
= _("Ink/toner waste bin almost full.");
1516 else if (!strncmp(reason
, "marker-waste-full", 17))
1517 message
= _("Ink/toner waste bin full!");
1518 else if (!strncmp(reason
, "fuser-over-temp", 15))
1519 message
= _("Fuser temperature high!");
1520 else if (!strncmp(reason
, "fuser-under-temp", 16))
1521 message
= _("Fuser temperature low!");
1522 else if (!strncmp(reason
, "opc-near-eol", 12))
1523 message
= _("OPC almost at end-of-life.");
1524 else if (!strncmp(reason
, "opc-life-over", 13))
1525 message
= _("OPC at end-of-life!");
1526 else if (!strncmp(reason
, "developer-low", 13))
1527 message
= _("Developer almost empty.");
1528 else if (!strncmp(reason
, "developer-empty", 15))
1529 message
= _("Developer empty!");
1530 else if (strstr(reason
, "error") != NULL
)
1534 snprintf(unknown
, sizeof(unknown
), _("Unknown printer error (%s)!"),
1541 if (strstr(reasons
->values
[i
].string
.text
, "error"))
1542 fprintf(stderr
, "ERROR: %s\n", _cupsLangString(language
, message
));
1543 else if (strstr(reasons
->values
[i
].string
.text
, "warning"))
1544 fprintf(stderr
, "WARNING: %s\n", _cupsLangString(language
, message
));
1546 fprintf(stderr
, "INFO: %s\n", _cupsLangString(language
, message
));
1550 fprintf(stderr
, "%s\n", state
);
1558 * 'run_pictwps_filter()' - Convert PICT files to PostScript when printing
1561 * This step is required because the PICT format is not documented and
1562 * subject to change, so developing a filter for other OS's is infeasible.
1563 * Also, fonts required by the PICT file need to be embedded on the
1564 * client side (which has the fonts), so we run the filter to get a
1565 * PostScript file for printing...
1568 static int /* O - Exit status of filter */
1569 run_pictwps_filter(char **argv
, /* I - Command-line arguments */
1570 const char *filename
)/* I - Filename */
1572 struct stat fileinfo
; /* Print file information */
1573 const char *ppdfile
; /* PPD file for destination printer */
1574 int pid
; /* Child process ID */
1575 int fd
; /* Temporary file descriptor */
1576 int status
; /* Exit status of filter */
1577 const char *printer
; /* PRINTER env var */
1578 static char ppdenv
[1024]; /* PPD environment variable */
1582 * First get the PPD file for the printer...
1585 printer
= getenv("PRINTER");
1588 _cupsLangPuts(stderr
,
1589 _("ERROR: PRINTER environment variable not defined!\n"));
1593 if ((ppdfile
= cupsGetPPD(printer
)) == NULL
)
1595 _cupsLangPrintf(stderr
,
1596 _("ERROR: Unable to get PPD file for printer \"%s\" - "
1597 "%s.\n"), printer
, cupsLastErrorString());
1601 snprintf(ppdenv
, sizeof(ppdenv
), "PPD=%s", ppdfile
);
1606 * Then create a temporary file for printing...
1609 if ((fd
= cupsTempFd(pstmpname
, sizeof(pstmpname
))) < 0)
1611 _cupsLangPrintf(stderr
, _("ERROR: Unable to create temporary file - %s.\n"),
1619 * Get the owner of the spool file - it is owned by the user we want to run
1624 stat(argv
[6], &fileinfo
);
1628 * Use the OSX defaults, as an up-stream filter created the PICT
1632 fileinfo
.st_uid
= 1;
1633 fileinfo
.st_gid
= 80;
1637 chown(ppdfile
, fileinfo
.st_uid
, fileinfo
.st_gid
);
1639 fchown(fd
, fileinfo
.st_uid
, fileinfo
.st_gid
);
1642 * Finally, run the filter to convert the file...
1645 if ((pid
= fork()) == 0)
1648 * Child process for pictwpstops... Redirect output of pictwpstops to a
1659 * Change to an unpriviledged user...
1662 setgid(fileinfo
.st_gid
);
1663 setuid(fileinfo
.st_uid
);
1666 execlp("pictwpstops", printer
, argv
[1], argv
[2], argv
[3], argv
[4], argv
[5],
1668 _cupsLangPrintf(stderr
, _("ERROR: Unable to exec pictwpstops: %s\n"),
1681 _cupsLangPrintf(stderr
, _("ERROR: Unable to fork pictwpstops: %s\n"),
1690 * Now wait for the filter to complete...
1693 if (wait(&status
) < 0)
1695 _cupsLangPrintf(stderr
, _("ERROR: Unable to wait for pictwpstops: %s\n"),
1712 _cupsLangPrintf(stderr
, _("ERROR: pictwpstops exited with status %d!\n"),
1715 _cupsLangPrintf(stderr
, _("ERROR: pictwpstops exited on signal %d!\n"),
1723 * Return with no errors..
1728 #endif /* __APPLE__ */
1732 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
1736 sigterm_handler(int sig
) /* I - Signal */
1738 (void)sig
; /* remove compiler warnings... */
1743 * Flag that the job should be cancelled...
1751 * The scheduler already tried to cancel us once, now just terminate
1752 * after removing our temp files!
1756 unlink(tmpfilename
);
1761 #endif /* __APPLE__ */
1768 * End of "$Id: ipp.c 7018 2007-10-10 22:14:03Z mike $".