2 * "$Id: ipp.c 6911 2007-09-04 20:35:08Z 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 #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 */
143 "document-format-supported",
144 "printer-is-accepting-jobs",
146 "printer-state-message",
147 "printer-state-reasons",
149 static const char * const jattrs
[] =
150 { /* Job attributes we want */
151 "job-media-sheets-completed",
157 * Make sure status messages are not buffered...
160 setbuf(stderr
, NULL
);
163 * Ignore SIGPIPE and catch SIGTERM signals...
167 sigset(SIGPIPE
, SIG_IGN
);
168 sigset(SIGTERM
, sigterm_handler
);
169 #elif defined(HAVE_SIGACTION)
170 memset(&action
, 0, sizeof(action
));
171 action
.sa_handler
= SIG_IGN
;
172 sigaction(SIGPIPE
, &action
, NULL
);
174 sigemptyset(&action
.sa_mask
);
175 sigaddset(&action
.sa_mask
, SIGTERM
);
176 action
.sa_handler
= sigterm_handler
;
177 sigaction(SIGTERM
, &action
, NULL
);
179 signal(SIGPIPE
, SIG_IGN
);
180 signal(SIGTERM
, sigterm_handler
);
181 #endif /* HAVE_SIGSET */
184 * Check command-line...
191 if ((s
= strrchr(argv
[0], '/')) != NULL
)
196 printf("network %s \"Unknown\" \"Internet Printing Protocol (%s)\"\n",
198 return (CUPS_BACKEND_OK
);
202 _cupsLangPrintf(stderr
,
203 _("Usage: %s job-id user title copies options [file]\n"),
205 return (CUPS_BACKEND_STOP
);
209 * Get the (final) content type...
212 if ((content_type
= getenv("FINAL_CONTENT_TYPE")) == NULL
)
213 if ((content_type
= getenv("CONTENT_TYPE")) == NULL
)
214 content_type
= "application/octet-stream";
216 if (!strncmp(content_type
, "printer/", 8))
217 content_type
= "application/vnd.cups-raw";
220 * Extract the hostname and printer name from the URI...
223 if (httpSeparateURI(HTTP_URI_CODING_ALL
, cupsBackendDeviceURI(argv
),
224 method
, sizeof(method
), username
, sizeof(username
),
225 hostname
, sizeof(hostname
), &port
,
226 resource
, sizeof(resource
)) < HTTP_URI_OK
)
228 _cupsLangPuts(stderr
,
229 _("ERROR: Missing device URI on command-line and no "
230 "DEVICE_URI environment variable!\n"));
231 return (CUPS_BACKEND_STOP
);
234 if (!strcmp(method
, "https"))
235 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
237 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
240 * See if there are any options...
247 contimeout
= 7 * 24 * 60 * 60;
249 if ((optptr
= strchr(resource
, '?')) != NULL
)
252 * Yup, terminate the device name string and move to the first
253 * character of the optptr...
259 * Then parse the optptr...
270 while (*optptr
&& *optptr
!= '=' && *optptr
!= '+' && *optptr
!= '&')
273 if ((sep
= *optptr
) != '\0')
284 while (*optptr
&& *optptr
!= '+' && *optptr
!= '&')
294 * Process the option...
297 if (!strcasecmp(name
, "waitjob"))
300 * Wait for job completion?
303 waitjob
= !strcasecmp(value
, "on") ||
304 !strcasecmp(value
, "yes") ||
305 !strcasecmp(value
, "true");
307 else if (!strcasecmp(name
, "waitprinter"))
310 * Wait for printer idle?
313 waitprinter
= !strcasecmp(value
, "on") ||
314 !strcasecmp(value
, "yes") ||
315 !strcasecmp(value
, "true");
317 else if (!strcasecmp(name
, "encryption"))
320 * Enable/disable encryption?
323 if (!strcasecmp(value
, "always"))
324 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
325 else if (!strcasecmp(value
, "required"))
326 cupsSetEncryption(HTTP_ENCRYPT_REQUIRED
);
327 else if (!strcasecmp(value
, "never"))
328 cupsSetEncryption(HTTP_ENCRYPT_NEVER
);
329 else if (!strcasecmp(value
, "ifrequested"))
330 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
333 _cupsLangPrintf(stderr
,
334 _("ERROR: Unknown encryption option value \"%s\"!\n"),
338 else if (!strcasecmp(name
, "version"))
340 if (!strcmp(value
, "1.0"))
342 else if (!strcmp(value
, "1.1"))
346 _cupsLangPrintf(stderr
,
347 _("ERROR: Unknown version option value \"%s\"!\n"),
352 else if (!strcasecmp(name
, "compression"))
354 compression
= !strcasecmp(value
, "true") ||
355 !strcasecmp(value
, "yes") ||
356 !strcasecmp(value
, "on") ||
357 !strcasecmp(value
, "gzip");
359 #endif /* HAVE_LIBZ */
360 else if (!strcasecmp(name
, "contimeout"))
363 * Set the connection timeout...
367 contimeout
= atoi(value
);
375 _cupsLangPrintf(stderr
,
376 _("ERROR: Unknown option \"%s\" with value \"%s\"!\n"),
383 * If we have 7 arguments, print the file named on the command-line.
384 * Otherwise, copy stdin to a temporary file and print the temporary
391 * Copy stdin to a temporary file...
394 int fd
; /* File descriptor */
395 cups_file_t
*fp
; /* Temporary file */
396 char buffer
[8192]; /* Buffer for copying */
397 int bytes
; /* Number of bytes read */
400 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
402 perror("ERROR: unable to create temporary file");
403 return (CUPS_BACKEND_FAILED
);
406 if ((fp
= cupsFileOpenFd(fd
, compression
? "w9" : "w")) == NULL
)
408 perror("ERROR: unable to open temporary file");
411 return (CUPS_BACKEND_FAILED
);
414 while ((bytes
= fread(buffer
, 1, sizeof(buffer
), stdin
)) > 0)
415 if (cupsFileWrite(fp
, buffer
, bytes
) < bytes
)
417 perror("ERROR: unable to write to temporary file");
420 return (CUPS_BACKEND_FAILED
);
426 * Point to the single file from stdin...
429 filename
= tmpfilename
;
438 * Point to the files on the command-line...
441 num_files
= argc
- 6;
444 send_options
= strncasecmp(content_type
, "application/vnd.cups-", 21) != 0;
448 compress_files(num_files
, files
);
449 #endif /* HAVE_LIBZ */
452 fprintf(stderr
, "DEBUG: %d files to send in job...\n", num_files
);
455 * Set the authentication info, if any...
458 cupsSetPasswordCB(password_cb
);
463 * Use authenticaion information in the device URI...
466 if ((password
= strchr(username
, ':')) != NULL
)
469 cupsSetUser(username
);
474 * Try loading authentication information from the environment.
477 const char *ptr
= getenv("AUTH_USERNAME");
482 password
= getenv("AUTH_PASSWORD");
486 * Try connecting to the remote server...
491 start_time
= time(NULL
);
493 fputs("STATE: +connecting-to-device\n", stderr
);
497 _cupsLangPrintf(stderr
, _("INFO: Connecting to %s on port %d...\n"),
500 if ((http
= httpConnectEncrypt(hostname
, port
, cupsEncryption())) == NULL
)
505 if (getenv("CLASS") != NULL
)
508 * If the CLASS environment variable is set, the job was submitted
509 * to a class and not to a specific queue. In this case, we want
510 * to abort immediately so that the job can be requeued on the next
511 * available printer in the class.
514 _cupsLangPuts(stderr
,
515 _("INFO: Unable to contact printer, queuing on next "
516 "printer in class...\n"));
518 if (argc
== 6 || strcmp(filename
, argv
[6]))
522 * Sleep 5 seconds to keep the job from requeuing too rapidly...
527 return (CUPS_BACKEND_FAILED
);
530 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
||
531 errno
== EHOSTUNREACH
)
533 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
535 _cupsLangPuts(stderr
, _("ERROR: Printer not responding!\n"));
536 return (CUPS_BACKEND_FAILED
);
541 _cupsLangPrintf(stderr
,
542 _("WARNING: recoverable: Network host \'%s\' is busy; "
543 "will retry in %d seconds...\n"),
553 _cupsLangPrintf(stderr
, _("ERROR: Unable to locate printer \'%s\'!\n"),
555 return (CUPS_BACKEND_STOP
);
561 fprintf(stderr
, "DEBUG: Connection error: %s\n", strerror(errno
));
562 _cupsLangPuts(stderr
,
563 _("ERROR: recoverable: Unable to connect to printer; will "
564 "retry in 30 seconds...\n"));
572 while (http
== NULL
);
576 if (argc
== 6 || strcmp(filename
, argv
[6]))
579 return (CUPS_BACKEND_FAILED
);
582 fputs("STATE: -connecting-to-device\n", stderr
);
583 _cupsLangPrintf(stderr
, _("INFO: Connected to %s...\n"), hostname
);
586 if (http
->hostaddr
->addr
.sa_family
== AF_INET6
)
587 fprintf(stderr
, "DEBUG: Connected to [%s]:%d (IPv6)...\n",
588 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
589 ntohs(http
->hostaddr
->ipv6
.sin6_port
));
591 #endif /* AF_INET6 */
592 if (http
->hostaddr
->addr
.sa_family
== AF_INET
)
593 fprintf(stderr
, "DEBUG: Connected to %s:%d (IPv4)...\n",
594 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
595 ntohs(http
->hostaddr
->ipv4
.sin_port
));
598 * Build a URI for the printer and fill the standard IPP attributes for
599 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
600 * might contain username:password information...
603 snprintf(uri
, sizeof(uri
), "%s://%s:%d%s", method
, hostname
, port
, resource
);
606 * First validate the destination and see if the device supports multiple
607 * copies. We have to do this because some IPP servers (e.g. HP JetDirect)
608 * don't support the copies attribute...
618 * Build the IPP request...
621 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
622 request
->request
.op
.version
[1] = version
;
624 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
627 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
628 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
635 fputs("DEBUG: Getting supported attributes...\n", stderr
);
637 if ((supported
= cupsDoRequest(http
, request
, resource
)) == NULL
)
638 ipp_status
= cupsLastError();
640 ipp_status
= supported
->request
.status
.status_code
;
642 if (ipp_status
> IPP_OK_CONFLICT
)
644 if (ipp_status
== IPP_PRINTER_BUSY
||
645 ipp_status
== IPP_SERVICE_UNAVAILABLE
)
647 if (contimeout
&& (time(NULL
) - start_time
) > contimeout
)
649 _cupsLangPuts(stderr
, _("ERROR: Printer not responding!\n"));
650 return (CUPS_BACKEND_FAILED
);
655 _cupsLangPrintf(stderr
,
656 _("WARNING: recoverable: Network host \'%s\' is busy; "
657 "will retry in %d seconds...\n"),
660 report_printer_state(supported
, 0);
667 else if ((ipp_status
== IPP_BAD_REQUEST
||
668 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
== 1)
671 * Switch to IPP/1.0...
674 _cupsLangPuts(stderr
,
675 _("INFO: Printer does not support IPP/1.1, trying "
680 else if (ipp_status
== IPP_NOT_FOUND
)
682 _cupsLangPuts(stderr
, _("ERROR: Destination printer does not exist!\n"));
685 ippDelete(supported
);
687 return (CUPS_BACKEND_STOP
);
691 _cupsLangPrintf(stderr
,
692 _("ERROR: Unable to get printer status (%s)!\n"),
693 cupsLastErrorString());
698 ippDelete(supported
);
702 else if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
703 IPP_TAG_RANGE
)) != NULL
)
706 * Has the "copies-supported" attribute - does it have an upper
710 if (copies_sup
->values
[0].range
.upper
<= 1)
711 copies_sup
= NULL
; /* No */
714 format_sup
= ippFindAttribute(supported
, "document-format-supported",
719 fprintf(stderr
, "DEBUG: document-format-supported (%d values)\n",
720 format_sup
->num_values
);
721 for (i
= 0; i
< format_sup
->num_values
; i
++)
722 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
723 format_sup
->values
[i
].string
.text
);
726 report_printer_state(supported
, 0);
728 while (ipp_status
> IPP_OK_CONFLICT
);
731 * See if the printer is accepting jobs and is not stopped; if either
732 * condition is true and we are printing to a class, requeue the job...
735 if (getenv("CLASS") != NULL
)
737 printer_state
= ippFindAttribute(supported
, "printer-state",
739 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
742 if (printer_state
== NULL
||
743 (printer_state
->values
[0].integer
> IPP_PRINTER_PROCESSING
&&
745 printer_accepting
== NULL
||
746 !printer_accepting
->values
[0].boolean
)
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 _cupsLangPuts(stderr
,
756 _("INFO: Unable to contact printer, queuing on next "
757 "printer in class...\n"));
759 ippDelete(supported
);
762 if (argc
== 6 || strcmp(filename
, argv
[6]))
766 * Sleep 5 seconds to keep the job from requeuing too rapidly...
771 return (CUPS_BACKEND_FAILED
);
778 * If we've shown a recoverable error make sure the printer proxies
779 * have a chance to see the recovered message. Not pretty but
780 * necessary for now...
783 fputs("INFO: recovered: \n", stderr
);
788 * See if the printer supports multiple copies...
791 copies
= atoi(argv
[4]);
793 if (copies_sup
|| argc
< 7)
795 copies_remaining
= 1;
801 copies_remaining
= copies
;
804 * Then issue the print-job request...
809 while (copies_remaining
> 0)
812 * Build the IPP request...
819 request
= ippNewRequest(IPP_CREATE_JOB
);
821 request
= ippNewRequest(IPP_PRINT_JOB
);
823 request
->request
.op
.version
[1] = version
;
825 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
828 fprintf(stderr
, "DEBUG: printer-uri = \"%s\"\n", uri
);
831 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
832 "requesting-user-name", NULL
, argv
[2]);
834 fprintf(stderr
, "DEBUG: requesting-user-name = \"%s\"\n", argv
[2]);
837 * Only add a "job-name" attribute if the remote server supports
838 * copy generation - some IPP implementations like HP's don't seem
839 * to like UTF-8 job names (STR #1837)...
842 if (argv
[3][0] && copies_sup
)
843 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
,
846 fprintf(stderr
, "DEBUG: job-name = \"%s\"\n", argv
[3]);
850 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
851 "compression", NULL
, "gzip");
852 #endif /* HAVE_LIBZ */
855 * Handle options on the command-line...
859 num_options
= cupsParseOptions(argv
[5], 0, &options
);
862 if (content_type
!= NULL
&&
863 !strcasecmp(content_type
, "application/pictwps") && num_files
== 1)
865 if (format_sup
!= NULL
)
867 for (i
= 0; i
< format_sup
->num_values
; i
++)
868 if (!strcasecmp(content_type
, format_sup
->values
[i
].string
.text
))
872 if (format_sup
== NULL
|| i
>= format_sup
->num_values
)
875 * Remote doesn't support "application/pictwps" (i.e. it's not MacOS X)
876 * so convert the document to PostScript...
879 if (run_pictwps_filter(argv
, filename
))
880 return (CUPS_BACKEND_FAILED
);
882 filename
= pstmpname
;
885 * Change the MIME type to application/postscript and change the
886 * number of copies to 1...
889 content_type
= "application/postscript";
891 copies_remaining
= 1;
895 #endif /* __APPLE__ */
897 if (content_type
!= NULL
&& format_sup
!= NULL
)
899 for (i
= 0; i
< format_sup
->num_values
; i
++)
900 if (!strcasecmp(content_type
, format_sup
->values
[i
].string
.text
))
903 if (i
< format_sup
->num_values
)
904 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
905 "document-format", NULL
, content_type
);
908 if (copies_sup
&& version
> 0 && send_options
)
911 * Only send options if the destination printer supports the copies
912 * attribute and IPP/1.1. This is a hack for the HP and Lexmark
913 * implementations of IPP, which do not accept extension attributes
914 * and incorrectly report a client-error-bad-request error instead of
915 * the successful-ok-unsupported-attributes status. In short, at least
916 * some HP and Lexmark implementations of IPP are non-compliant.
919 cupsEncodeOptions(request
, num_options
, options
);
921 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies",
925 cupsFreeOptions(num_options
, options
);
928 * If copies aren't supported, then we are likely dealing with an HP
929 * JetDirect. The HP IPP implementation seems to close the connection
930 * after every request - that is, it does *not* implement HTTP Keep-
931 * Alive, which is REQUIRED by HTTP/1.1...
942 response
= cupsDoRequest(http
, request
, resource
);
944 response
= cupsDoFileRequest(http
, request
, resource
, files
[0]);
946 ipp_status
= cupsLastError();
948 if (ipp_status
> IPP_OK_CONFLICT
)
955 if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
956 ipp_status
== IPP_PRINTER_BUSY
)
958 _cupsLangPuts(stderr
,
959 _("INFO: Printer busy; will retry in 10 seconds...\n"));
962 else if ((ipp_status
== IPP_BAD_REQUEST
||
963 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
== 1)
966 * Switch to IPP/1.0...
969 _cupsLangPuts(stderr
,
970 _("INFO: Printer does not support IPP/1.1, trying "
976 _cupsLangPrintf(stderr
, _("ERROR: Print file was not accepted (%s)!\n"),
977 cupsLastErrorString());
979 else if ((job_id_attr
= ippFindAttribute(response
, "job-id",
980 IPP_TAG_INTEGER
)) == NULL
)
982 _cupsLangPuts(stderr
,
983 _("NOTICE: Print file accepted - job ID unknown.\n"));
988 job_id
= job_id_attr
->values
[0].integer
;
989 _cupsLangPrintf(stderr
, _("NOTICE: Print file accepted - job ID %d.\n"),
998 if (job_id
&& num_files
> 1)
1000 for (i
= 0; i
< num_files
; i
++)
1002 request
= ippNewRequest(IPP_SEND_DOCUMENT
);
1004 request
->request
.op
.version
[1] = version
;
1006 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1009 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1013 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1014 "requesting-user-name", NULL
, argv
[2]);
1016 if ((i
+ 1) == num_files
)
1017 ippAddBoolean(request
, IPP_TAG_OPERATION
, "last-document", 1);
1019 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
1020 "document-format", NULL
, content_type
);
1022 ippDelete(cupsDoFileRequest(http
, request
, resource
, files
[i
]));
1024 if (cupsLastError() > IPP_OK_CONFLICT
)
1026 ipp_status
= cupsLastError();
1028 _cupsLangPrintf(stderr
,
1029 _("ERROR: Unable to add file %d to job: %s\n"),
1030 job_id
, cupsLastErrorString());
1036 if (ipp_status
<= IPP_OK_CONFLICT
&& argc
> 6)
1038 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
1039 copies_remaining
--;
1041 else if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
1042 ipp_status
== IPP_PRINTER_BUSY
)
1045 copies_remaining
--;
1048 * Wait for the job to complete...
1051 if (!job_id
|| !waitjob
)
1054 _cupsLangPuts(stderr
, _("INFO: Waiting for job to complete...\n"));
1056 for (; !job_cancelled
;)
1059 * Build an IPP_GET_JOB_ATTRIBUTES request...
1062 request
= ippNewRequest(IPP_GET_JOB_ATTRIBUTES
);
1063 request
->request
.op
.version
[1] = version
;
1065 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1068 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1072 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1073 "requesting-user-name", NULL
, argv
[2]);
1075 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1076 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
1084 httpReconnect(http
);
1086 response
= cupsDoRequest(http
, request
, resource
);
1087 ipp_status
= cupsLastError();
1089 if (ipp_status
== IPP_NOT_FOUND
)
1092 * Job has gone away and/or the server has no job history...
1095 ippDelete(response
);
1097 ipp_status
= IPP_OK
;
1101 if (ipp_status
> IPP_OK_CONFLICT
)
1103 if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
1104 ipp_status
!= IPP_PRINTER_BUSY
)
1106 ippDelete(response
);
1108 _cupsLangPrintf(stderr
,
1109 _("ERROR: Unable to get job %d attributes (%s)!\n"),
1110 job_id
, cupsLastErrorString());
1117 if ((job_state
= ippFindAttribute(response
, "job-state",
1118 IPP_TAG_ENUM
)) != NULL
)
1121 * Stop polling if the job is finished or pending-held...
1124 if (job_state
->values
[0].integer
> IPP_JOB_STOPPED
)
1126 if ((job_sheets
= ippFindAttribute(response
,
1127 "job-media-sheets-completed",
1128 IPP_TAG_INTEGER
)) != NULL
)
1129 fprintf(stderr
, "PAGE: total %d\n",
1130 job_sheets
->values
[0].integer
);
1132 ippDelete(response
);
1138 ippDelete(response
);
1141 * Check the printer state and report it if necessary...
1144 check_printer_state(http
, uri
, resource
, argv
[2], version
, job_id
);
1147 * Wait 10 seconds before polling again...
1155 * Cancel the job as needed...
1158 if (job_cancelled
&& job_id
)
1159 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1162 * Check the printer state and report it if necessary...
1165 check_printer_state(http
, uri
, resource
, argv
[2], version
, job_id
);
1173 ippDelete(supported
);
1176 * Remove the temporary file(s) if necessary...
1180 unlink(tmpfilename
);
1185 for (i
= 0; i
< num_files
; i
++)
1188 #endif /* HAVE_LIBZ */
1193 #endif /* __APPLE__ */
1196 * Return the queue status...
1199 if (ipp_status
== IPP_NOT_AUTHORIZED
)
1202 * Authorization failures here mean that we need Kerberos. Username +
1203 * password authentication is handled in the password_cb function.
1206 fputs("ATTR: auth-info-required=negotiate\n", stderr
);
1207 return (CUPS_BACKEND_AUTH_REQUIRED
);
1209 else if (ipp_status
> IPP_OK_CONFLICT
)
1210 return (CUPS_BACKEND_FAILED
);
1212 return (CUPS_BACKEND_OK
);
1217 * 'cancel_job()' - Cancel a print job.
1221 cancel_job(http_t
*http
, /* I - HTTP connection */
1222 const char *uri
, /* I - printer-uri */
1223 int id
, /* I - job-id */
1224 const char *resource
, /* I - Resource path */
1225 const char *user
, /* I - requesting-user-name */
1226 int version
) /* I - IPP version */
1228 ipp_t
*request
; /* Cancel-Job request */
1231 _cupsLangPuts(stderr
, _("INFO: Canceling print job...\n"));
1233 request
= ippNewRequest(IPP_CANCEL_JOB
);
1234 request
->request
.op
.version
[1] = version
;
1236 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1238 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
1240 if (user
&& user
[0])
1241 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1242 "requesting-user-name", NULL
, user
);
1248 ippDelete(cupsDoRequest(http
, request
, resource
));
1250 if (cupsLastError() > IPP_OK_CONFLICT
)
1251 _cupsLangPrintf(stderr
, _("ERROR: Unable to cancel job %d: %s\n"), id
,
1252 cupsLastErrorString());
1257 * 'check_printer_state()' - Check the printer state...
1261 check_printer_state(
1262 http_t
*http
, /* I - HTTP connection */
1263 const char *uri
, /* I - Printer URI */
1264 const char *resource
, /* I - Resource path */
1265 const char *user
, /* I - Username, if any */
1266 int version
, /* I - IPP version */
1267 int job_id
) /* I - Current job ID */
1269 ipp_t
*request
, /* IPP request */
1270 *response
; /* IPP response */
1271 static const char * const attrs
[] = /* Attributes we want */
1273 "printer-state-message",
1274 "printer-state-reasons"
1279 * Check on the printer state...
1282 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
1283 request
->request
.op
.version
[1] = version
;
1285 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1288 if (user
&& user
[0])
1289 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1290 "requesting-user-name", NULL
, user
);
1292 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1293 "requested-attributes",
1294 (int)(sizeof(attrs
) / sizeof(attrs
[0])), NULL
, attrs
);
1300 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
1302 report_printer_state(response
, job_id
);
1303 ippDelete(response
);
1310 * 'compress_files()' - Compress print files...
1314 compress_files(int num_files
, /* I - Number of files */
1315 char **files
) /* I - Files */
1317 int i
, /* Looping var */
1318 fd
; /* Temporary file descriptor */
1319 ssize_t bytes
; /* Bytes read/written */
1320 size_t total
; /* Total bytes read */
1321 cups_file_t
*in
, /* Input file */
1322 *out
; /* Output file */
1323 struct stat outinfo
; /* Output file information */
1324 char filename
[1024], /* Temporary filename */
1325 buffer
[32768]; /* Copy buffer */
1328 fprintf(stderr
, "DEBUG: Compressing %d job files...\n", num_files
);
1329 for (i
= 0; i
< num_files
; i
++)
1331 if ((fd
= cupsTempFd(filename
, sizeof(filename
))) < 0)
1333 _cupsLangPrintf(stderr
,
1334 _("ERROR: Unable to create temporary compressed print "
1335 "file: %s\n"), strerror(errno
));
1336 exit(CUPS_BACKEND_FAILED
);
1339 if ((out
= cupsFileOpenFd(fd
, "w9")) == NULL
)
1341 _cupsLangPrintf(stderr
,
1342 _("ERROR: Unable to open temporary compressed print "
1343 "file: %s\n"), strerror(errno
));
1344 exit(CUPS_BACKEND_FAILED
);
1347 if ((in
= cupsFileOpen(files
[i
], "r")) == NULL
)
1349 _cupsLangPrintf(stderr
,
1350 _("ERROR: Unable to open print file \"%s\": %s\n"),
1351 files
[i
], strerror(errno
));
1353 exit(CUPS_BACKEND_FAILED
);
1357 while ((bytes
= cupsFileRead(in
, buffer
, sizeof(buffer
))) > 0)
1358 if (cupsFileWrite(out
, buffer
, bytes
) < bytes
)
1360 _cupsLangPrintf(stderr
,
1361 _("ERROR: Unable to write %d bytes to \"%s\": %s\n"),
1362 (int)bytes
, filename
, strerror(errno
));
1365 exit(CUPS_BACKEND_FAILED
);
1373 files
[i
] = strdup(filename
);
1375 if (!stat(filename
, &outinfo
))
1377 "DEBUG: File %d compressed to %.1f%% of original size, "
1378 CUPS_LLFMT
" bytes...\n",
1379 i
+ 1, 100.0 * outinfo
.st_size
/ total
,
1380 CUPS_LLCAST outinfo
.st_size
);
1383 #endif /* HAVE_LIBZ */
1387 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
1390 static const char * /* O - Password */
1391 password_cb(const char *prompt
) /* I - Prompt (not used) */
1395 if (password
&& password_tries
< 3)
1404 * If there is no password set in the device URI, return the
1405 * "authentication required" exit code...
1409 unlink(tmpfilename
);
1414 #endif /* __APPLE__ */
1416 fputs("ATTR: auth-info-required=username,password\n", stderr
);
1418 exit(CUPS_BACKEND_AUTH_REQUIRED
);
1420 return (NULL
); /* Eliminate compiler warning */
1426 * 'report_printer_state()' - Report the printer state.
1429 static int /* O - Number of reasons shown */
1430 report_printer_state(ipp_t
*ipp
, /* I - IPP response */
1431 int job_id
) /* I - Current job ID */
1433 int i
; /* Looping var */
1434 int count
; /* Count of reasons shown... */
1435 ipp_attribute_t
*psm
, /* pritner-state-message */
1436 *reasons
; /* printer-state-reasons */
1437 const char *reason
; /* Current reason */
1438 const char *message
; /* Message to show */
1439 char unknown
[1024]; /* Unknown message string */
1440 const char *prefix
; /* Prefix for STATE: line */
1441 char state
[1024]; /* State string */
1442 cups_lang_t
*language
; /* Current localization */
1445 if ((psm
= ippFindAttribute(ipp
, "printer-state-message",
1446 IPP_TAG_TEXT
)) != NULL
)
1447 fprintf(stderr
, "INFO: %s\n", psm
->values
[0].string
.text
);
1449 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
1450 IPP_TAG_KEYWORD
)) == NULL
)
1455 language
= cupsLangDefault();
1457 for (i
= 0, count
= 0; i
< reasons
->num_values
; i
++)
1459 reason
= reasons
->values
[i
].string
.text
;
1461 if (job_id
== 0 || strcmp(reason
, "paused"))
1463 strlcat(state
, prefix
, sizeof(state
));
1464 strlcat(state
, reason
, sizeof(state
));
1471 if (!strncmp(reason
, "media-needed", 12))
1472 message
= _("Media tray needs to be filled.");
1473 else if (!strncmp(reason
, "media-jam", 9))
1474 message
= _("Media jam!");
1475 else if (!strncmp(reason
, "moving-to-paused", 16) ||
1476 !strncmp(reason
, "paused", 6) ||
1477 !strncmp(reason
, "shutdown", 8))
1478 message
= _("Printer off-line.");
1479 else if (!strncmp(reason
, "toner-low", 9))
1480 message
= _("Toner low.");
1481 else if (!strncmp(reason
, "toner-empty", 11))
1482 message
= _("Out of toner!");
1483 else if (!strncmp(reason
, "cover-open", 10))
1484 message
= _("Cover open.");
1485 else if (!strncmp(reason
, "interlock-open", 14))
1486 message
= _("Interlock open.");
1487 else if (!strncmp(reason
, "door-open", 9))
1488 message
= _("Door open.");
1489 else if (!strncmp(reason
, "input-tray-missing", 18))
1490 message
= _("Media tray missing!");
1491 else if (!strncmp(reason
, "media-low", 9))
1492 message
= _("Media tray almost empty.");
1493 else if (!strncmp(reason
, "media-empty", 11))
1494 message
= _("Media tray empty!");
1495 else if (!strncmp(reason
, "output-tray-missing", 19))
1496 message
= _("Output tray missing!");
1497 else if (!strncmp(reason
, "output-area-almost-full", 23))
1498 message
= _("Output bin almost full.");
1499 else if (!strncmp(reason
, "output-area-full", 16))
1500 message
= _("Output bin full!");
1501 else if (!strncmp(reason
, "marker-supply-low", 17))
1502 message
= _("Ink/toner almost empty.");
1503 else if (!strncmp(reason
, "marker-supply-empty", 19))
1504 message
= _("Ink/toner empty!");
1505 else if (!strncmp(reason
, "marker-waste-almost-full", 24))
1506 message
= _("Ink/toner waste bin almost full.");
1507 else if (!strncmp(reason
, "marker-waste-full", 17))
1508 message
= _("Ink/toner waste bin full!");
1509 else if (!strncmp(reason
, "fuser-over-temp", 15))
1510 message
= _("Fuser temperature high!");
1511 else if (!strncmp(reason
, "fuser-under-temp", 16))
1512 message
= _("Fuser temperature low!");
1513 else if (!strncmp(reason
, "opc-near-eol", 12))
1514 message
= _("OPC almost at end-of-life.");
1515 else if (!strncmp(reason
, "opc-life-over", 13))
1516 message
= _("OPC at end-of-life!");
1517 else if (!strncmp(reason
, "developer-low", 13))
1518 message
= _("Developer almost empty.");
1519 else if (!strncmp(reason
, "developer-empty", 15))
1520 message
= _("Developer empty!");
1521 else if (strstr(reason
, "error") != NULL
)
1525 snprintf(unknown
, sizeof(unknown
), _("Unknown printer error (%s)!"),
1532 if (strstr(reasons
->values
[i
].string
.text
, "error"))
1533 fprintf(stderr
, "ERROR: %s\n", _cupsLangString(language
, message
));
1534 else if (strstr(reasons
->values
[i
].string
.text
, "warning"))
1535 fprintf(stderr
, "WARNING: %s\n", _cupsLangString(language
, message
));
1537 fprintf(stderr
, "INFO: %s\n", _cupsLangString(language
, message
));
1541 fprintf(stderr
, "%s\n", state
);
1549 * 'run_pictwps_filter()' - Convert PICT files to PostScript when printing
1552 * This step is required because the PICT format is not documented and
1553 * subject to change, so developing a filter for other OS's is infeasible.
1554 * Also, fonts required by the PICT file need to be embedded on the
1555 * client side (which has the fonts), so we run the filter to get a
1556 * PostScript file for printing...
1559 static int /* O - Exit status of filter */
1560 run_pictwps_filter(char **argv
, /* I - Command-line arguments */
1561 const char *filename
)/* I - Filename */
1563 struct stat fileinfo
; /* Print file information */
1564 const char *ppdfile
; /* PPD file for destination printer */
1565 int pid
; /* Child process ID */
1566 int fd
; /* Temporary file descriptor */
1567 int status
; /* Exit status of filter */
1568 const char *printer
; /* PRINTER env var */
1569 static char ppdenv
[1024]; /* PPD environment variable */
1573 * First get the PPD file for the printer...
1576 printer
= getenv("PRINTER");
1579 _cupsLangPuts(stderr
,
1580 _("ERROR: PRINTER environment variable not defined!\n"));
1584 if ((ppdfile
= cupsGetPPD(printer
)) == NULL
)
1586 _cupsLangPrintf(stderr
,
1587 _("ERROR: Unable to get PPD file for printer \"%s\" - "
1588 "%s.\n"), printer
, cupsLastErrorString());
1592 snprintf(ppdenv
, sizeof(ppdenv
), "PPD=%s", ppdfile
);
1597 * Then create a temporary file for printing...
1600 if ((fd
= cupsTempFd(pstmpname
, sizeof(pstmpname
))) < 0)
1602 _cupsLangPrintf(stderr
, _("ERROR: Unable to create temporary file - %s.\n"),
1610 * Get the owner of the spool file - it is owned by the user we want to run
1615 stat(argv
[6], &fileinfo
);
1619 * Use the OSX defaults, as an up-stream filter created the PICT
1623 fileinfo
.st_uid
= 1;
1624 fileinfo
.st_gid
= 80;
1628 chown(ppdfile
, fileinfo
.st_uid
, fileinfo
.st_gid
);
1630 fchown(fd
, fileinfo
.st_uid
, fileinfo
.st_gid
);
1633 * Finally, run the filter to convert the file...
1636 if ((pid
= fork()) == 0)
1639 * Child process for pictwpstops... Redirect output of pictwpstops to a
1650 * Change to an unpriviledged user...
1653 setgid(fileinfo
.st_gid
);
1654 setuid(fileinfo
.st_uid
);
1657 execlp("pictwpstops", printer
, argv
[1], argv
[2], argv
[3], argv
[4], argv
[5],
1659 _cupsLangPrintf(stderr
, _("ERROR: Unable to exec pictwpstops: %s\n"),
1672 _cupsLangPrintf(stderr
, _("ERROR: Unable to fork pictwpstops: %s\n"),
1681 * Now wait for the filter to complete...
1684 if (wait(&status
) < 0)
1686 _cupsLangPrintf(stderr
, _("ERROR: Unable to wait for pictwpstops: %s\n"),
1703 _cupsLangPrintf(stderr
, _("ERROR: pictwpstops exited with status %d!\n"),
1706 _cupsLangPrintf(stderr
, _("ERROR: pictwpstops exited on signal %d!\n"),
1714 * Return with no errors..
1719 #endif /* __APPLE__ */
1723 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
1727 sigterm_handler(int sig
) /* I - Signal */
1729 (void)sig
; /* remove compiler warnings... */
1734 * Flag that the job should be cancelled...
1742 * The scheduler already tried to cancel us once, now just terminate
1743 * after removing our temp files!
1747 unlink(tmpfilename
);
1752 #endif /* __APPLE__ */
1759 * End of "$Id: ipp.c 6911 2007-09-04 20:35:08Z mike $".