2 * "$Id: ipp.c 6318 2007-03-06 04:36:55Z mike $"
4 * IPP backend for the Common UNIX Printing System (CUPS).
6 * Copyright 1997-2006 by Easy Software Products, all rights reserved.
8 * These coded instructions, statements, and computer programs are the
9 * property of Easy Software Products and are protected by Federal
10 * copyright law. Distribution and use rights are outlined in the file
11 * "LICENSE" which should have been included with this file. If this
12 * file is missing or damaged please contact Easy Software Products
15 * Attn: CUPS Licensing Information
16 * Easy Software Products
17 * 44141 Airport View Drive, Suite 204
18 * Hollywood, Maryland 20636 USA
20 * Voice: (301) 373-9600
21 * EMail: cups-info@cups.org
22 * WWW: http://www.cups.org
24 * This file is subject to the Apple OS-Developed Software exception.
28 * main() - Send a file to the printer or server.
29 * cancel_job() - Cancel a print job.
30 * check_printer_state() - Check the printer state...
31 * compress_files() - Compress print files...
32 * password_cb() - Disable the password prompt for
33 * cupsDoFileRequest().
34 * report_printer_state() - Report the printer state.
35 * run_pictwps_filter() - Convert PICT files to PostScript when printing
37 * sigterm_handler() - Handle 'terminate' signals that stop the backend.
41 * Include necessary headers.
44 #include <cups/http-private.h>
48 #include <sys/types.h>
50 #include <cups/backend.h>
51 #include <cups/cups.h>
52 #include <cups/language.h>
53 #include <cups/string.h>
61 static char *password
= NULL
; /* Password for device URI */
63 static char pstmpname
[1024] = ""; /* Temporary PostScript file name */
64 #endif /* __APPLE__ */
65 static char tmpfilename
[1024] = ""; /* Temporary spool file name */
66 static int job_cancelled
= 0; /* Job cancelled? */
73 static void cancel_job(http_t
*http
, const char *uri
, int id
,
74 const char *resource
, const char *user
, int version
);
75 static void check_printer_state(http_t
*http
, const char *uri
,
76 const char *resource
, const char *user
,
79 static void compress_files(int num_files
, char **files
);
80 #endif /* HAVE_LIBZ */
81 static const char *password_cb(const char *);
82 static int report_printer_state(ipp_t
*ipp
);
85 static int run_pictwps_filter(char **argv
, const char *filename
);
86 #endif /* __APPLE__ */
87 static void sigterm_handler(int sig
);
91 * 'main()' - Send a file to the printer or server.
95 * printer-uri job-id user title copies options [file]
98 int /* O - Exit status */
99 main(int argc
, /* I - Number of command-line args */
100 char *argv
[]) /* I - Command-line arguments */
102 int i
; /* Looping var */
103 int num_options
; /* Number of printer options */
104 cups_option_t
*options
; /* Printer options */
105 char method
[255], /* Method in URI */
106 hostname
[1024], /* Hostname */
107 username
[255], /* Username info */
108 resource
[1024], /* Resource info (printer name) */
109 addrname
[256], /* Address name */
110 *optptr
, /* Pointer to URI options */
111 name
[255], /* Name of option */
112 value
[255], /* Value of option */
113 *ptr
; /* Pointer into name or value */
114 int num_files
; /* Number of files to print */
115 char **files
, /* Files to print */
116 *filename
; /* Pointer to single filename */
117 int port
; /* Port number (not used) */
118 char uri
[HTTP_MAX_URI
]; /* Updated URI without user/pass */
119 ipp_status_t ipp_status
; /* Status of IPP request */
120 http_t
*http
; /* HTTP connection */
121 ipp_t
*request
, /* IPP request */
122 *response
, /* IPP response */
123 *supported
; /* get-printer-attributes response */
124 int compression
, /* Do compression of the job data? */
125 waitjob
, /* Wait for job complete? */
126 waitprinter
; /* Wait for printer ready? */
127 ipp_attribute_t
*job_id_attr
; /* job-id attribute */
128 int job_id
; /* job-id value */
129 ipp_attribute_t
*job_sheets
; /* job-media-sheets-completed */
130 ipp_attribute_t
*job_state
; /* job-state */
131 ipp_attribute_t
*copies_sup
; /* copies-supported */
132 ipp_attribute_t
*format_sup
; /* document-format-supported */
133 ipp_attribute_t
*printer_state
; /* printer-state attribute */
134 ipp_attribute_t
*printer_accepting
; /* printer-is-accepting-jobs */
135 int copies
, /* Number of copies for job */
136 copies_remaining
; /* Number of copies remaining */
137 const char *content_type
; /* CONTENT_TYPE environment variable */
138 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
139 struct sigaction action
; /* Actions for POSIX signals */
140 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
141 int version
; /* IPP version */
142 static const char * const pattrs
[] =
143 { /* Printer attributes we want */
145 "document-format-supported",
146 "printer-is-accepting-jobs",
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
);
204 "Usage: %s job-id user title copies options [file ... fileN]\n",
206 return (CUPS_BACKEND_STOP
);
210 * Get the (final) content type...
213 if ((content_type
= getenv("FINAL_CONTENT_TYPE")) == NULL
)
214 if ((content_type
= getenv("CONTENT_TYPE")) == NULL
)
215 content_type
= "application/octet-stream";
217 if (!strncmp(content_type
, "printer/", 8))
218 content_type
= "application/vnd.cups-raw";
221 * Extract the hostname and printer name from the URI...
224 if (httpSeparateURI(HTTP_URI_CODING_ALL
, cupsBackendDeviceURI(argv
),
225 method
, sizeof(method
), username
, sizeof(username
),
226 hostname
, sizeof(hostname
), &port
,
227 resource
, sizeof(resource
)) < HTTP_URI_OK
)
229 fputs("ERROR: Missing device URI on command-line and no DEVICE_URI "
230 "environment variable!\n", stderr
);
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...
248 if ((optptr
= strchr(resource
, '?')) != NULL
)
251 * Yup, terminate the device name string and move to the first
252 * character of the optptr...
258 * Then parse the optptr...
267 for (ptr
= name
; *optptr
&& *optptr
!= '=';)
268 if (ptr
< (name
+ sizeof(name
) - 1))
280 for (ptr
= value
; *optptr
&& *optptr
!= '+' && *optptr
!= '&';)
281 if (ptr
< (value
+ sizeof(value
) - 1))
285 if (*optptr
== '+' || *optptr
== '&')
292 * Process the option...
295 if (!strcasecmp(name
, "waitjob"))
298 * Wait for job completion?
301 waitjob
= !strcasecmp(value
, "on") ||
302 !strcasecmp(value
, "yes") ||
303 !strcasecmp(value
, "true");
305 else if (!strcasecmp(name
, "waitprinter"))
308 * Wait for printer idle?
311 waitprinter
= !strcasecmp(value
, "on") ||
312 !strcasecmp(value
, "yes") ||
313 !strcasecmp(value
, "true");
315 else if (!strcasecmp(name
, "encryption"))
318 * Enable/disable encryption?
321 if (!strcasecmp(value
, "always"))
322 cupsSetEncryption(HTTP_ENCRYPT_ALWAYS
);
323 else if (!strcasecmp(value
, "required"))
324 cupsSetEncryption(HTTP_ENCRYPT_REQUIRED
);
325 else if (!strcasecmp(value
, "never"))
326 cupsSetEncryption(HTTP_ENCRYPT_NEVER
);
327 else if (!strcasecmp(value
, "ifrequested"))
328 cupsSetEncryption(HTTP_ENCRYPT_IF_REQUESTED
);
331 fprintf(stderr
, "ERROR: Unknown encryption option value \"%s\"!\n",
335 else if (!strcasecmp(name
, "version"))
337 if (!strcmp(value
, "1.0"))
339 else if (!strcmp(value
, "1.1"))
343 fprintf(stderr
, "ERROR: Unknown version option value \"%s\"!\n",
348 else if (!strcasecmp(name
, "compression"))
350 compression
= !strcasecmp(value
, "true") ||
351 !strcasecmp(value
, "yes") ||
352 !strcasecmp(value
, "on") ||
353 !strcasecmp(value
, "gzip");
355 #endif /* HAVE_LIBZ */
362 fprintf(stderr
, "ERROR: Unknown option \"%s\" with value \"%s\"!\n",
369 * If we have 7 arguments, print the file named on the command-line.
370 * Otherwise, copy stdin to a temporary file and print the temporary
377 * Copy stdin to a temporary file...
380 int fd
; /* File descriptor */
381 cups_file_t
*fp
; /* Temporary file */
382 char buffer
[8192]; /* Buffer for copying */
383 int bytes
; /* Number of bytes read */
386 if ((fd
= cupsTempFd(tmpfilename
, sizeof(tmpfilename
))) < 0)
388 perror("ERROR: unable to create temporary file");
389 return (CUPS_BACKEND_FAILED
);
392 if ((fp
= cupsFileOpenFd(fd
, compression
? "w9" : "w")) == NULL
)
394 perror("ERROR: unable to open temporary file");
397 return (CUPS_BACKEND_FAILED
);
400 while ((bytes
= fread(buffer
, 1, sizeof(buffer
), stdin
)) > 0)
401 if (cupsFileWrite(fp
, buffer
, bytes
) < bytes
)
403 perror("ERROR: unable to write to temporary file");
406 return (CUPS_BACKEND_FAILED
);
412 * Point to the single file from stdin...
415 filename
= tmpfilename
;
422 * Point to the files on the command-line...
425 num_files
= argc
- 6;
430 compress_files(num_files
, files
);
431 #endif /* HAVE_LIBZ */
434 fprintf(stderr
, "DEBUG: %d files to send in job...\n", num_files
);
437 * Set the authentication info, if any...
440 cupsSetPasswordCB(password_cb
);
445 * Use authenticaion information in the device URI...
448 if ((password
= strchr(username
, ':')) != NULL
)
451 cupsSetUser(username
);
456 * Try loading authentication information from the a##### file.
459 const char *request_root
; /* CUPS_REQUESTROOT env var */
460 char afilename
[1024], /* a##### filename */
461 aline
[2048]; /* Line from file */
462 FILE *fp
; /* File pointer */
465 if ((request_root
= getenv("CUPS_REQUESTROOT")) != NULL
)
468 * Try opening authentication cache file...
471 snprintf(afilename
, sizeof(afilename
), "%s/a%05d", request_root
,
473 if ((fp
= fopen(afilename
, "r")) != NULL
)
479 if (fgets(aline
, sizeof(aline
), fp
))
485 i
= sizeof(username
);
486 httpDecode64_2(username
, &i
, aline
);
492 if (fgets(aline
, sizeof(aline
), fp
))
498 i
= sizeof(password
);
499 httpDecode64_2(password
, &i
, aline
);
513 * Try connecting to the remote server...
516 fputs("STATE: +connecting-to-device\n", stderr
);
520 fprintf(stderr
, "INFO: Connecting to %s on port %d...\n", hostname
, port
);
522 if ((http
= httpConnectEncrypt(hostname
, port
, cupsEncryption())) == NULL
)
524 if (getenv("CLASS") != NULL
)
527 * If the CLASS environment variable is set, the job was submitted
528 * to a class and not to a specific queue. In this case, we want
529 * to abort immediately so that the job can be requeued on the next
530 * available printer in the class.
534 "INFO: Unable to connect to %s, queuing on next printer in "
538 if (argc
== 6 || strcmp(filename
, argv
[6]))
542 * Sleep 5 seconds to keep the job from requeuing too rapidly...
547 return (CUPS_BACKEND_FAILED
);
550 if (errno
== ECONNREFUSED
|| errno
== EHOSTDOWN
||
551 errno
== EHOSTUNREACH
)
554 "INFO: Network host \'%s\' is busy; will retry in 30 "
561 fprintf(stderr
, "INFO: Unable to lookup host \'%s\' - %s\n",
562 hostname
, hstrerror(h_errno
));
567 perror("ERROR: Unable to connect to IPP host");
572 while (http
== NULL
);
574 fputs("STATE: -connecting-to-device\n", stderr
);
575 fprintf(stderr
, "INFO: Connected to %s...\n", hostname
);
578 if (http
->hostaddr
->addr
.sa_family
== AF_INET6
)
579 fprintf(stderr
, "DEBUG: Connected to [%s]:%d (IPv6)...\n",
580 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
581 ntohs(http
->hostaddr
->ipv6
.sin6_port
));
583 #endif /* AF_INET6 */
584 if (http
->hostaddr
->addr
.sa_family
== AF_INET
)
585 fprintf(stderr
, "DEBUG: Connected to %s:%d (IPv4)...\n",
586 httpAddrString(http
->hostaddr
, addrname
, sizeof(addrname
)),
587 ntohs(http
->hostaddr
->ipv4
.sin_port
));
590 * Build a URI for the printer and fill the standard IPP attributes for
591 * an IPP_PRINT_FILE request. We can't use the URI in argv[0] because it
592 * might contain username:password information...
595 snprintf(uri
, sizeof(uri
), "%s://%s:%d%s", method
, hostname
, port
, resource
);
598 * First validate the destination and see if the device supports multiple
599 * copies. We have to do this because some IPP servers (e.g. HP JetDirect)
600 * don't support the copies attribute...
610 * Build the IPP request...
613 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
614 request
->request
.op
.version
[1] = version
;
616 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
619 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
620 "requested-attributes", sizeof(pattrs
) / sizeof(pattrs
[0]),
627 fputs("DEBUG: Getting supported attributes...\n", stderr
);
629 if ((supported
= cupsDoRequest(http
, request
, resource
)) == NULL
)
630 ipp_status
= cupsLastError();
632 ipp_status
= supported
->request
.status
.status_code
;
634 if (ipp_status
> IPP_OK_CONFLICT
)
636 if (ipp_status
== IPP_PRINTER_BUSY
||
637 ipp_status
== IPP_SERVICE_UNAVAILABLE
)
639 fputs("INFO: Printer busy; will retry in 10 seconds...\n", stderr
);
640 report_printer_state(supported
);
643 else if ((ipp_status
== IPP_BAD_REQUEST
||
644 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
== 1)
647 * Switch to IPP/1.0...
650 fputs("INFO: Printer does not support IPP/1.1, trying IPP/1.0...\n",
655 else if (ipp_status
== IPP_NOT_FOUND
)
657 fputs("ERROR: Destination printer does not exist!\n", stderr
);
660 ippDelete(supported
);
662 return (CUPS_BACKEND_STOP
);
666 fprintf(stderr
, "ERROR: Unable to get printer status (%s)!\n",
667 ippErrorString(ipp_status
));
672 ippDelete(supported
);
676 else if ((copies_sup
= ippFindAttribute(supported
, "copies-supported",
677 IPP_TAG_RANGE
)) != NULL
)
680 * Has the "copies-supported" attribute - does it have an upper
684 if (copies_sup
->values
[0].range
.upper
<= 1)
685 copies_sup
= NULL
; /* No */
688 format_sup
= ippFindAttribute(supported
, "document-format-supported",
693 fprintf(stderr
, "DEBUG: document-format-supported (%d values)\n",
694 format_sup
->num_values
);
695 for (i
= 0; i
< format_sup
->num_values
; i
++)
696 fprintf(stderr
, "DEBUG: [%d] = \"%s\"\n", i
,
697 format_sup
->values
[i
].string
.text
);
700 report_printer_state(supported
);
702 while (ipp_status
> IPP_OK_CONFLICT
);
705 * See if the printer is accepting jobs and is not stopped; if either
706 * condition is true and we are printing to a class, requeue the job...
709 if (getenv("CLASS") != NULL
)
711 printer_state
= ippFindAttribute(supported
, "printer-state",
713 printer_accepting
= ippFindAttribute(supported
, "printer-is-accepting-jobs",
716 if (printer_state
== NULL
||
717 (printer_state
->values
[0].integer
> IPP_PRINTER_PROCESSING
&&
719 printer_accepting
== NULL
||
720 !printer_accepting
->values
[0].boolean
)
723 * If the CLASS environment variable is set, the job was submitted
724 * to a class and not to a specific queue. In this case, we want
725 * to abort immediately so that the job can be requeued on the next
726 * available printer in the class.
730 "INFO: Unable to queue job on %s, queuing on next printer in "
734 ippDelete(supported
);
737 if (argc
== 6 || strcmp(filename
, argv
[6]))
741 * Sleep 5 seconds to keep the job from requeuing too rapidly...
746 return (CUPS_BACKEND_FAILED
);
751 * See if the printer supports multiple copies...
754 copies
= atoi(argv
[4]);
756 if (copies_sup
|| argc
< 7)
758 copies_remaining
= 1;
764 copies_remaining
= copies
;
767 * Then issue the print-job request...
772 while (copies_remaining
> 0)
775 * Build the IPP request...
782 request
= ippNewRequest(IPP_CREATE_JOB
);
784 request
= ippNewRequest(IPP_PRINT_JOB
);
786 request
->request
.op
.version
[1] = version
;
788 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
791 fprintf(stderr
, "DEBUG: printer-uri = \"%s\"\n", uri
);
794 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
795 "requesting-user-name", NULL
, argv
[2]);
797 fprintf(stderr
, "DEBUG: requesting-user-name = \"%s\"\n", argv
[2]);
800 * Only add a "job-name" attribute if the remote server supports
801 * copy generation - some IPP implementations like HP's don't seem
802 * to like UTF-8 job names (STR #1837)...
805 if (argv
[3][0] && copies_sup
)
806 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
, "job-name", NULL
,
809 fprintf(stderr
, "DEBUG: job-name = \"%s\"\n", argv
[3]);
813 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
814 "compression", NULL
, "gzip");
815 #endif /* HAVE_LIBZ */
818 * Handle options on the command-line...
822 num_options
= cupsParseOptions(argv
[5], 0, &options
);
825 if (content_type
!= NULL
&&
826 !strcasecmp(content_type
, "application/pictwps") && num_files
== 1)
828 if (format_sup
!= NULL
)
830 for (i
= 0; i
< format_sup
->num_values
; i
++)
831 if (!strcasecmp(content_type
, format_sup
->values
[i
].string
.text
))
835 if (format_sup
== NULL
|| i
>= format_sup
->num_values
)
838 * Remote doesn't support "application/pictwps" (i.e. it's not MacOS X)
839 * so convert the document to PostScript...
842 if (run_pictwps_filter(argv
, filename
))
843 return (CUPS_BACKEND_FAILED
);
845 filename
= pstmpname
;
848 * Change the MIME type to application/postscript and change the
849 * number of copies to 1...
852 content_type
= "application/postscript";
854 copies_remaining
= 1;
857 #endif /* __APPLE__ */
859 if (content_type
!= NULL
&& format_sup
!= NULL
)
861 for (i
= 0; i
< format_sup
->num_values
; i
++)
862 if (!strcasecmp(content_type
, format_sup
->values
[i
].string
.text
))
865 if (i
< format_sup
->num_values
)
866 num_options
= cupsAddOption("document-format", content_type
,
867 num_options
, &options
);
870 if (copies_sup
&& version
> 0)
873 * Only send options if the destination printer supports the copies
874 * attribute and IPP/1.1. This is a hack for the HP and Lexmark
875 * implementations of IPP, which do not accept extension attributes
876 * and incorrectly report a client-error-bad-request error instead of
877 * the successful-ok-unsupported-attributes status. In short, at least
878 * some HP and Lexmark implementations of IPP are non-compliant.
881 cupsEncodeOptions(request
, num_options
, options
);
883 ippAddInteger(request
, IPP_TAG_JOB
, IPP_TAG_INTEGER
, "copies",
887 cupsFreeOptions(num_options
, options
);
890 * If copies aren't supported, then we are likely dealing with an HP
891 * JetDirect. The HP IPP implementation seems to close the connection
892 * after every request - that is, it does *not* implement HTTP Keep-
893 * Alive, which is REQUIRED by HTTP/1.1...
904 response
= cupsDoRequest(http
, request
, resource
);
906 response
= cupsDoFileRequest(http
, request
, resource
, files
[0]);
908 ipp_status
= cupsLastError();
910 if (ipp_status
> IPP_OK_CONFLICT
)
917 if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
918 ipp_status
== IPP_PRINTER_BUSY
)
920 fputs("INFO: Printer is busy; retrying print job...\n", stderr
);
923 else if ((ipp_status
== IPP_BAD_REQUEST
||
924 ipp_status
== IPP_VERSION_NOT_SUPPORTED
) && version
== 1)
927 * Switch to IPP/1.0...
930 fputs("INFO: Printer does not support IPP/1.1, trying IPP/1.0...\n",
936 fprintf(stderr
, "ERROR: Print file was not accepted (%s)!\n",
937 cupsLastErrorString());
939 else if ((job_id_attr
= ippFindAttribute(response
, "job-id",
940 IPP_TAG_INTEGER
)) == NULL
)
942 fputs("NOTICE: Print file accepted - job ID unknown.\n", stderr
);
947 job_id
= job_id_attr
->values
[0].integer
;
948 fprintf(stderr
, "NOTICE: Print file accepted - job ID %d.\n", job_id
);
956 if (job_id
&& num_files
> 1)
958 for (i
= 0; i
< num_files
; i
++)
960 request
= ippNewRequest(IPP_SEND_DOCUMENT
);
962 request
->request
.op
.version
[1] = version
;
964 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
967 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
971 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
972 "requesting-user-name", NULL
, argv
[2]);
974 if ((i
+ 1) == num_files
)
975 ippAddBoolean(request
, IPP_TAG_OPERATION
, "last-document", 1);
977 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_MIMETYPE
,
978 "document-format", NULL
, content_type
);
980 ippDelete(cupsDoFileRequest(http
, request
, resource
, files
[i
]));
982 if (cupsLastError() > IPP_OK_CONFLICT
)
984 ipp_status
= cupsLastError();
986 fprintf(stderr
, "ERROR: Unable to add file %d to job: %s\n",
987 job_id
, cupsLastErrorString());
993 if (ipp_status
<= IPP_OK_CONFLICT
&& argc
> 6)
995 fprintf(stderr
, "PAGE: 1 %d\n", copies_sup
? atoi(argv
[4]) : 1);
998 else if (ipp_status
== IPP_SERVICE_UNAVAILABLE
||
999 ipp_status
== IPP_PRINTER_BUSY
)
1002 copies_remaining
--;
1005 * Wait for the job to complete...
1008 if (!job_id
|| !waitjob
)
1011 fputs("INFO: Waiting for job to complete...\n", stderr
);
1013 for (; !job_cancelled
;)
1016 * Build an IPP_GET_JOB_ATTRIBUTES request...
1019 request
= ippNewRequest(IPP_GET_JOB_ATTRIBUTES
);
1020 request
->request
.op
.version
[1] = version
;
1022 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1025 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id",
1029 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1030 "requesting-user-name", NULL
, argv
[2]);
1032 ippAddStrings(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1033 "requested-attributes", sizeof(jattrs
) / sizeof(jattrs
[0]),
1041 httpReconnect(http
);
1043 response
= cupsDoRequest(http
, request
, resource
);
1044 ipp_status
= cupsLastError();
1046 if (ipp_status
== IPP_NOT_FOUND
)
1049 * Job has gone away and/or the server has no job history...
1052 ippDelete(response
);
1054 ipp_status
= IPP_OK
;
1058 if (ipp_status
> IPP_OK_CONFLICT
)
1060 if (ipp_status
!= IPP_SERVICE_UNAVAILABLE
&&
1061 ipp_status
!= IPP_PRINTER_BUSY
)
1063 ippDelete(response
);
1065 fprintf(stderr
, "ERROR: Unable to get job %d attributes (%s)!\n",
1066 job_id
, ippErrorString(ipp_status
));
1073 if ((job_state
= ippFindAttribute(response
, "job-state",
1074 IPP_TAG_ENUM
)) != NULL
)
1077 * Stop polling if the job is finished or pending-held...
1080 if (job_state
->values
[0].integer
> IPP_JOB_PROCESSING
||
1081 job_state
->values
[0].integer
== IPP_JOB_HELD
)
1083 if ((job_sheets
= ippFindAttribute(response
,
1084 "job-media-sheets-completed",
1085 IPP_TAG_INTEGER
)) != NULL
)
1086 fprintf(stderr
, "PAGE: total %d\n",
1087 job_sheets
->values
[0].integer
);
1089 ippDelete(response
);
1095 ippDelete(response
);
1098 * Check the printer state and report it if necessary...
1101 check_printer_state(http
, uri
, resource
, argv
[2], version
);
1104 * Wait 10 seconds before polling again...
1112 * Cancel the job as needed...
1115 if (job_cancelled
&& job_id
)
1116 cancel_job(http
, uri
, job_id
, resource
, argv
[2], version
);
1119 * Check the printer state and report it if necessary...
1122 check_printer_state(http
, uri
, resource
, argv
[2], version
);
1130 ippDelete(supported
);
1133 * Remove the temporary file(s) if necessary...
1137 unlink(tmpfilename
);
1142 for (i
= 0; i
< num_files
; i
++)
1145 #endif /* HAVE_LIBZ */
1150 #endif /* __APPLE__ */
1153 * Return the queue status...
1156 return (ipp_status
> IPP_OK_CONFLICT
? CUPS_BACKEND_FAILED
: CUPS_BACKEND_OK
);
1161 * 'cancel_job()' - Cancel a print job.
1165 cancel_job(http_t
*http
, /* I - HTTP connection */
1166 const char *uri
, /* I - printer-uri */
1167 int id
, /* I - job-id */
1168 const char *resource
, /* I - Resource path */
1169 const char *user
, /* I - requesting-user-name */
1170 int version
) /* I - IPP version */
1172 ipp_t
*request
; /* Cancel-Job request */
1175 fputs("INFO: Cancelling print job...\n", stderr
);
1177 request
= ippNewRequest(IPP_CANCEL_JOB
);
1178 request
->request
.op
.version
[1] = version
;
1180 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1182 ippAddInteger(request
, IPP_TAG_OPERATION
, IPP_TAG_INTEGER
, "job-id", id
);
1184 if (user
&& user
[0])
1185 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1186 "requesting-user-name", NULL
, user
);
1192 ippDelete(cupsDoRequest(http
, request
, resource
));
1194 if (cupsLastError() > IPP_OK_CONFLICT
)
1195 fprintf(stderr
, "ERROR: Unable to cancel job %d: %s\n", id
,
1196 cupsLastErrorString());
1201 * 'check_printer_state()' - Check the printer state...
1205 check_printer_state(
1206 http_t
*http
, /* I - HTTP connection */
1207 const char *uri
, /* I - Printer URI */
1208 const char *resource
, /* I - Resource path */
1209 const char *user
, /* I - Username, if any */
1210 int version
) /* I - IPP version */
1212 ipp_t
*request
, /* IPP request */
1213 *response
; /* IPP response */
1217 * Check on the printer state...
1220 request
= ippNewRequest(IPP_GET_PRINTER_ATTRIBUTES
);
1221 request
->request
.op
.version
[1] = version
;
1223 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_URI
, "printer-uri",
1226 if (user
&& user
[0])
1227 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_NAME
,
1228 "requesting-user-name", NULL
, user
);
1230 ippAddString(request
, IPP_TAG_OPERATION
, IPP_TAG_KEYWORD
,
1231 "requested-attributes", NULL
, "printer-state-reasons");
1237 if ((response
= cupsDoRequest(http
, request
, resource
)) != NULL
)
1239 report_printer_state(response
);
1240 ippDelete(response
);
1247 * 'compress_files()' - Compress print files...
1251 compress_files(int num_files
, /* I - Number of files */
1252 char **files
) /* I - Files */
1254 int i
, /* Looping var */
1255 fd
; /* Temporary file descriptor */
1256 ssize_t bytes
; /* Bytes read/written */
1257 size_t total
; /* Total bytes read */
1258 cups_file_t
*in
, /* Input file */
1259 *out
; /* Output file */
1260 struct stat outinfo
; /* Output file information */
1261 char filename
[1024], /* Temporary filename */
1262 buffer
[32768]; /* Copy buffer */
1265 fprintf(stderr
, "DEBUG: Compressing %d job files...\n", num_files
);
1266 for (i
= 0; i
< num_files
; i
++)
1268 if ((fd
= cupsTempFd(filename
, sizeof(filename
))) < 0)
1270 perror("ERROR: Unable to create temporary compressed print file");
1271 exit(CUPS_BACKEND_FAILED
);
1274 if ((out
= cupsFileOpenFd(fd
, "w9")) == NULL
)
1276 perror("ERROR: Unable to open temporary compressed print file");
1277 exit(CUPS_BACKEND_FAILED
);
1280 if ((in
= cupsFileOpen(files
[i
], "r")) == NULL
)
1282 fprintf(stderr
, "ERROR: Unable to open print file \"%s\": %s\n",
1283 files
[i
], strerror(errno
));
1285 exit(CUPS_BACKEND_FAILED
);
1289 while ((bytes
= cupsFileRead(in
, buffer
, sizeof(buffer
))) > 0)
1290 if (cupsFileWrite(out
, buffer
, bytes
) < bytes
)
1292 fprintf(stderr
, "ERROR: Unable to write " CUPS_LLFMT
" bytes to \"%s\": %s\n",
1293 CUPS_LLCAST bytes
, filename
, strerror(errno
));
1296 exit(CUPS_BACKEND_FAILED
);
1304 files
[i
] = strdup(filename
);
1306 if (!stat(filename
, &outinfo
))
1308 "DEBUG: File %d compressed to %.1f%% of original size, "
1309 CUPS_LLFMT
" bytes...\n",
1310 i
+ 1, 100.0 * outinfo
.st_size
/ total
,
1311 CUPS_LLCAST outinfo
.st_size
);
1314 #endif /* HAVE_LIBZ */
1318 * 'password_cb()' - Disable the password prompt for cupsDoFileRequest().
1321 static const char * /* O - Password */
1322 password_cb(const char *prompt
) /* I - Prompt (not used) */
1331 * If there is no password set in the device URI, return the
1332 * "authentication required" exit code...
1336 unlink(tmpfilename
);
1341 #endif /* __APPLE__ */
1343 fputs("ATTR: auth-info-required=username,password\n", stderr
);
1345 exit(CUPS_BACKEND_AUTH_REQUIRED
);
1347 return (NULL
); /* Eliminate compiler warning */
1353 * 'report_printer_state()' - Report the printer state.
1356 static int /* O - Number of reasons shown */
1357 report_printer_state(ipp_t
*ipp
) /* I - IPP response */
1359 int i
; /* Looping var */
1360 int count
; /* Count of reasons shown... */
1361 ipp_attribute_t
*reasons
; /* printer-state-reasons */
1362 const char *reason
; /* Current reason */
1363 const char *message
; /* Message to show */
1364 char unknown
[1024]; /* Unknown message string */
1365 const char *prefix
; /* Prefix for STATE: line */
1366 char state
[1024]; /* State string */
1369 if ((reasons
= ippFindAttribute(ipp
, "printer-state-reasons",
1370 IPP_TAG_KEYWORD
)) == NULL
)
1376 for (i
= 0, count
= 0; i
< reasons
->num_values
; i
++)
1378 reason
= reasons
->values
[i
].string
.text
;
1380 strlcat(state
, prefix
, sizeof(state
));
1381 strlcat(state
, reason
, sizeof(state
));
1386 if (!strncmp(reason
, "media-needed", 12))
1387 message
= "Media tray needs to be filled.";
1388 else if (!strncmp(reason
, "media-jam", 9))
1389 message
= "Media jam!";
1390 else if (!strncmp(reason
, "moving-to-paused", 16) ||
1391 !strncmp(reason
, "paused", 6) ||
1392 !strncmp(reason
, "shutdown", 8))
1393 message
= "Printer off-line.";
1394 else if (!strncmp(reason
, "toner-low", 9))
1395 message
= "Toner low.";
1396 else if (!strncmp(reason
, "toner-empty", 11))
1397 message
= "Out of toner!";
1398 else if (!strncmp(reason
, "cover-open", 10))
1399 message
= "Cover open.";
1400 else if (!strncmp(reason
, "interlock-open", 14))
1401 message
= "Interlock open.";
1402 else if (!strncmp(reason
, "door-open", 9))
1403 message
= "Door open.";
1404 else if (!strncmp(reason
, "input-tray-missing", 18))
1405 message
= "Media tray missing!";
1406 else if (!strncmp(reason
, "media-low", 9))
1407 message
= "Media tray almost empty.";
1408 else if (!strncmp(reason
, "media-empty", 11))
1409 message
= "Media tray empty!";
1410 else if (!strncmp(reason
, "output-tray-missing", 19))
1411 message
= "Output tray missing!";
1412 else if (!strncmp(reason
, "output-area-almost-full", 23))
1413 message
= "Output bin almost full.";
1414 else if (!strncmp(reason
, "output-area-full", 16))
1415 message
= "Output bin full!";
1416 else if (!strncmp(reason
, "marker-supply-low", 17))
1417 message
= "Ink/toner almost empty.";
1418 else if (!strncmp(reason
, "marker-supply-empty", 19))
1419 message
= "Ink/toner empty!";
1420 else if (!strncmp(reason
, "marker-waste-almost-full", 24))
1421 message
= "Ink/toner waste bin almost full.";
1422 else if (!strncmp(reason
, "marker-waste-full", 17))
1423 message
= "Ink/toner waste bin full!";
1424 else if (!strncmp(reason
, "fuser-over-temp", 15))
1425 message
= "Fuser temperature high!";
1426 else if (!strncmp(reason
, "fuser-under-temp", 16))
1427 message
= "Fuser temperature low!";
1428 else if (!strncmp(reason
, "opc-near-eol", 12))
1429 message
= "OPC almost at end-of-life.";
1430 else if (!strncmp(reason
, "opc-life-over", 13))
1431 message
= "OPC at end-of-life!";
1432 else if (!strncmp(reason
, "developer-low", 13))
1433 message
= "Developer almost empty.";
1434 else if (!strncmp(reason
, "developer-empty", 15))
1435 message
= "Developer empty!";
1436 else if (strstr(reason
, "error") != NULL
)
1440 snprintf(unknown
, sizeof(unknown
), "Unknown printer error (%s)!",
1447 if (strstr(reasons
->values
[i
].string
.text
, "error"))
1448 fprintf(stderr
, "ERROR: %s\n", message
);
1449 else if (strstr(reasons
->values
[i
].string
.text
, "warning"))
1450 fprintf(stderr
, "WARNING: %s\n", message
);
1452 fprintf(stderr
, "INFO: %s\n", message
);
1456 fprintf(stderr
, "%s\n", state
);
1464 * 'run_pictwps_filter()' - Convert PICT files to PostScript when printing
1467 * This step is required because the PICT format is not documented and
1468 * subject to change, so developing a filter for other OS's is infeasible.
1469 * Also, fonts required by the PICT file need to be embedded on the
1470 * client side (which has the fonts), so we run the filter to get a
1471 * PostScript file for printing...
1474 static int /* O - Exit status of filter */
1475 run_pictwps_filter(char **argv
, /* I - Command-line arguments */
1476 const char *filename
)/* I - Filename */
1478 struct stat fileinfo
; /* Print file information */
1479 const char *ppdfile
; /* PPD file for destination printer */
1480 int pid
; /* Child process ID */
1481 int fd
; /* Temporary file descriptor */
1482 int status
; /* Exit status of filter */
1483 const char *printer
; /* PRINTER env var */
1484 static char ppdenv
[1024]; /* PPD environment variable */
1488 * First get the PPD file for the printer...
1491 printer
= getenv("PRINTER");
1494 fputs("ERROR: PRINTER environment variable not defined!\n", stderr
);
1498 if ((ppdfile
= cupsGetPPD(printer
)) == NULL
)
1500 fprintf(stderr
, "ERROR: Unable to get PPD file for printer \"%s\" - %s.\n",
1501 printer
, ippErrorString(cupsLastError()));
1506 snprintf(ppdenv
, sizeof(ppdenv
), "PPD=%s", ppdfile
);
1511 * Then create a temporary file for printing...
1514 if ((fd
= cupsTempFd(pstmpname
, sizeof(pstmpname
))) < 0)
1516 fprintf(stderr
, "ERROR: Unable to create temporary file - %s.\n",
1524 * Get the owner of the spool file - it is owned by the user we want to run
1529 stat(argv
[6], &fileinfo
);
1533 * Use the OSX defaults, as an up-stream filter created the PICT
1537 fileinfo
.st_uid
= 1;
1538 fileinfo
.st_gid
= 80;
1542 chown(ppdfile
, fileinfo
.st_uid
, fileinfo
.st_gid
);
1544 fchown(fd
, fileinfo
.st_uid
, fileinfo
.st_gid
);
1547 * Finally, run the filter to convert the file...
1550 if ((pid
= fork()) == 0)
1553 * Child process for pictwpstops... Redirect output of pictwpstops to a
1564 * Change to an unpriviledged user...
1567 setgid(fileinfo
.st_gid
);
1568 setuid(fileinfo
.st_uid
);
1571 execlp("pictwpstops", printer
, argv
[1], argv
[2], argv
[3], argv
[4], argv
[5],
1573 perror("ERROR: Unable to exec pictwpstops");
1585 perror("ERROR: Unable to fork pictwpstops");
1593 * Now wait for the filter to complete...
1596 if (wait(&status
) < 0)
1598 perror("ERROR: Unable to wait for pictwpstops");
1614 fprintf(stderr
, "ERROR: pictwpstops exited with status %d!\n",
1617 fprintf(stderr
, "ERROR: pictwpstops exited on signal %d!\n",
1625 * Return with no errors..
1630 #endif /* __APPLE__ */
1634 * 'sigterm_handler()' - Handle 'terminate' signals that stop the backend.
1638 sigterm_handler(int sig
) /* I - Signal */
1640 (void)sig
; /* remove compiler warnings... */
1645 * Flag that the job should be cancelled...
1653 * The scheduler already tried to cancel us once, now just terminate
1654 * after removing our temp files!
1658 unlink(tmpfilename
);
1663 #endif /* __APPLE__ */
1670 * End of "$Id: ipp.c 6318 2007-03-06 04:36:55Z mike $".