2 * "$Id: pap.c 6087 2006-11-14 15:48:34Z mike $"
4 * © Copyright 2004 Apple Computer, Inc. All rights reserved.
6 * IMPORTANT: This Apple software is supplied to you by Apple Computer,
7 * Inc. ("Apple") in consideration of your agreement to the following
8 * terms, and your use, installation, modification or redistribution of
9 * this Apple software constitutes acceptance of these terms. If you do
10 * not agree with these terms, please do not use, install, modify or
11 * redistribute this Apple software.
13 * In consideration of your agreement to abide by the following terms, and
14 * subject to these terms, Apple grants you a personal, non-exclusive
15 * license, under AppleÕs copyrights in this original Apple software (the
16 * "Apple Software"), to use, reproduce, modify and redistribute the Apple
17 * Software, with or without modifications, in source and/or binary forms;
18 * provided that if you redistribute the Apple Software in its entirety and
19 * without modifications, you must retain this notice and the following
20 * text and disclaimers in all such redistributions of the Apple Software.
21 * Neither the name, trademarks, service marks or logos of Apple Computer,
22 * Inc. may be used to endorse or promote products derived from the Apple
23 * Software without specific prior written permission from Apple. Except
24 * as expressly stated in this notice, no other rights or licenses, express
25 * or implied, are granted by Apple herein, including but not limited to
26 * any patent rights that may be infringed by your derivative works or by
27 * other works in which the Apple Software may be incorporated.
29 * The Apple Software is provided by Apple on an "AS IS" basis. APPLE
30 * MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
31 * THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
32 * FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
33 * OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
35 * IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
36 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
39 * MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
40 * AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
41 * STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGE.
45 * This program implements the Printer Access Protocol (PAP) on top of AppleTalk
46 * Transaction Protocol (ATP). If it were to use the blocking pap functions of
47 * the AppleTalk library it would need seperate threads for reading, writing
52 * main() - Send a file to the specified Appletalk printer.
53 * listDevices() - List all LaserWriter printers in the local zone.
54 * printFile() - Print file.
55 * papOpen() - Open a pap session to a printer.
56 * papClose() - Close a pap session.
57 * papWrite() - Write bytes to a printer.
58 * papCloseResp() - Send a pap close response.
59 * papSendRequest() - Fomrat and send a pap packet.
60 * papCancelRequest() - Cancel a pending pap request.
61 * statusUpdate() - Print printer status to stderr.
62 * parseUri() - Extract the print name and zone from a uri.
63 * addPercentEscapes() - Encode a string with percent escapes.
64 * removePercentEscapes - Remove percent escape sequences from a string.
65 * nbptuple_compare() - Compare routine for qsort.
66 * okayToUseAppleTalk() - Returns true if AppleTalk is available and enabled.
67 * packet_name() - Returns packet name string.
68 * connectTimeout() - Returns the connect timeout preference value.
69 * signalHandler() - handle SIGINT to close the session before quiting.
82 #include <sys/fcntl.h>
83 #include <sys/param.h>
85 #include <sys/errno.h>
87 #include <netat/appletalk.h>
88 #include <netat/atp.h>
89 #include <netat/ddp.h>
90 #include <netat/nbp.h>
91 #include <netat/pap.h>
93 #include <cups/cups.h>
94 #include <cups/backend.h>
96 #include <libkern/OSByteOrder.h>
98 #ifdef HAVE_APPLETALK_AT_PROTO_H
99 # include <AppleTalk/at_proto.h>
101 /* These definitions come from at_proto.h... */
102 # define ZIP_DEF_INTERFACE NULL
103 enum { RUNNING
, NOTLOADED
, LOADED
, OTHERERROR
};
105 extern int atp_abort(int fd
, at_inet_t
*dest
, u_short tid
);
106 extern int atp_close(int fd
);
107 extern int atp_getreq(int fd
, at_inet_t
*src
, char *buf
, int *len
, int *userdata
,
108 int *xo
, u_short
*tid
, u_char
*bitmap
, int nowait
);
109 extern int atp_getresp(int fd
, u_short
*tid
, at_resp_t
*resp
);
110 extern int atp_look(int fd
);
111 extern int atp_open(at_socket
*sock
);
112 extern int atp_sendreq(int fd
, at_inet_t
*dest
, char *buf
, int len
,
113 int userdata
, int xo
, int xo_relt
, u_short
*tid
,
114 at_resp_t
*resp
, at_retry_t
*retry
, int nowait
);
115 extern int atp_sendrsp(int fd
, at_inet_t
*dest
, int xo
, u_short tid
,
117 extern int checkATStack();
118 extern int nbp_lookup(at_entity_t
*entity
, at_nbptuple_t
*buf
, int max
,
120 extern int nbp_make_entity(at_entity_t
*entity
, char *obj
, char *type
,
122 extern int zip_getmyzone(char *ifName
, at_nvestr_t
*zone
);
123 #endif /* HAVE_APPLETALK_AT_PROTO_H */
125 #include <CoreFoundation/CFURL.h>
126 #include <CoreFoundation/CFNumber.h>
127 #include <CoreFoundation/CFPreferences.h>
130 #define MAX_PRINTERS 500 /* Max number of printers we can lookup */
135 #define CONNID_OF(p) (((u_char *)&p)[0])
136 #define TYPE_OF(p) (((u_char *)&p)[1])
137 #define SEQUENCE_NUM(p) (((u_char *)&p)[2])
138 #define IS_PAP_EOF(p) (((u_char *)&p)[2])
146 int gSockfd
= 0; /* Socket descriptor */
147 at_inet_t gSessionAddr
= { 0 }; /* Address of the session responding socket */
148 u_char gConnID
= 0; /* PAP session connection id */
149 u_short gSendDataID
= 0; /* Transaction id of pending send-data request */
150 u_short gTickleID
= 0; /* Transaction id of outstanding tickle request*/
151 int gWaitEOF
= false; /* Option: wait for a remote's EOF */
152 int gStatusInterval
= 5; /* Option: 0=off else seconds between status requests*/
153 int gErrorlogged
= false; /* If an error was logged don't send any more INFO messages */
154 int gDebug
= 0; /* Option: emit debugging info */
156 /* Local functions */
157 static int listDevices(void);
158 static int printFile(char* name
, char* type
, char* zone
, int fdin
, int fdout
,
159 int fderr
, int copies
, int argc
);
160 static int papOpen(at_nbptuple_t
* tuple
, u_char
* connID
, int* fd
,
161 at_inet_t
* pap_to
, u_char
* flowQuantum
);
162 static int papClose();
163 static int papWrite(int sockfd
, at_inet_t
* dest
, u_short tid
, u_char connID
,
164 u_char flowQuantum
, char* data
, int len
, int eof
);
165 static int papCloseResp(int sockfd
, at_inet_t
* dest
, int xo
, u_short tid
,
167 static int papSendRequest(int sockfd
, at_inet_t
* dest
, u_char connID
,
168 int function
, u_char bitmap
, int xo
, int seqno
);
169 static int papCancelRequest(int sockfd
, u_short tid
);
170 static void statusUpdate(char* status
, u_char statusLen
);
171 static int parseUri(const char* argv0
, char* name
, char* type
, char* zone
);
172 static int addPercentEscapes(const char* src
, char* dst
, int dstMax
);
173 static int removePercentEscapes(const char* src
, char* dst
, int dstMax
);
174 static int nbptuple_compare(const void *p1
, const void *p2
);
175 static int okayToUseAppleTalk(void);
176 static const char *packet_name(u_char x
);
177 static int connectTimeout(void);
178 static void signalHandler(int sigraised
);
183 * @abstract Send a file to the specified AppleTalk PAP address.
185 * Usage: printer-uri job-id user title copies options [file]
187 * @param argc # of arguments
188 * @param argv array of arguments
190 * @result A non-zero return value for errors
192 int main (int argc
, const char * argv
[])
195 FILE *fp
; /* Print file */
196 int copies
; /* Number of copies to print */
197 char name
[NBP_NVE_STR_SIZE
+ 1]; /* +1 for a nul */
198 char type
[NBP_NVE_STR_SIZE
+ 1]; /* +1 for a nul */
199 char zone
[NBP_NVE_STR_SIZE
+ 1]; /* +1 for a nul */
201 /* Make sure status messages are not buffered... */
202 setbuf(stderr
, NULL
);
204 if (argc
== 1 || (argc
== 2 && strcmp(argv
[1], "-discover") == 0))
206 /* If listDevices() didn't find any devices or returns an error output a
207 * legacy style announcement.
210 if (listDevices() <= 0)
211 puts("network pap \"Unknown\" \"AppleTalk Printer Access Protocol (pap)\"");
216 if (argc
< 6 || argc
> 7)
218 fprintf(stderr
, "argc = %d\n", argc
);
219 for (err
= 0; err
< argc
; err
++) {
220 fprintf(stderr
, "%02d:%s\n", err
, argv
[err
]);
222 fprintf(stderr
, "Usage: pap job-id user title copies options [file]\n");
226 /* If we have 7 arguments, print the file named on the command-line.
227 * Otherwise, send stdin instead...
236 fprintf(stderr
, "DEBUG: opening print file \"%s\"\n", argv
[6]);
238 /* Try to open the print file... */
239 if ((fp
= fopen(argv
[6], "rb")) == NULL
)
241 fprintf(stderr
, "ERROR: unable to open print file \"%s\": %s\n", argv
[6], strerror(errno
));
245 copies
= atoi(argv
[4]);
248 /* Extract the device name and options from the URI... */
249 parseUri(cupsBackendDeviceURI((char **)argv
), name
, type
, zone
);
251 err
= printFile(name
, type
, zone
, fileno(fp
), STDOUT_FILENO
, STDERR_FILENO
, copies
, argc
);
256 /* Only clear the last status if there wasn't an error */
257 if (err
== noErr
&& !gErrorlogged
)
258 fprintf(stderr
, "INFO:\n");
265 * @function listDevices
266 * @abstract Print a list of all LaserWriter type devices registered in the default zone.
268 * @result A non-zero return value for errors
270 static int listDevices(void)
278 at_nbptuple_t buf
[MAX_PRINTERS
];
280 char name
[NBP_NVE_STR_SIZE
+1];
281 char encodedName
[(3 * NBP_NVE_STR_SIZE
) + 1];
282 char zone
[NBP_NVE_STR_SIZE
+1];
283 char encodedZone
[(3 * NBP_NVE_STR_SIZE
) + 1];
285 /* Make sure it's okay to use appletalk */
286 if (!okayToUseAppleTalk())
288 fprintf(stderr
, "ERROR: AppleTalk disabled in System Preferences\n");
289 return -1; /* Network is down */
292 if ((err
= zip_getmyzone(ZIP_DEF_INTERFACE
, &at_zone
)) != 0)
294 perror("ERROR: Unable to get default AppleTalk zone");
298 memcpy(zone
, at_zone
.str
, MIN(at_zone
.len
, sizeof(zone
)-1));
299 zone
[MIN(at_zone
.len
, sizeof(zone
)-1)] = '\0';
301 fprintf(stderr
, "INFO: Using default AppleTalk zone \"%s\"\n", zone
);
303 addPercentEscapes(zone
, encodedZone
, sizeof(encodedZone
));
305 /* Look up all the printers in our zone */
306 nbp_make_entity(&entity
, "=", "LaserWriter", zone
);
311 if ((numberFound
= nbp_lookup(&entity
, buf
, MAX_PRINTERS
, &retry
)) < 0)
313 perror("ERROR: Unable to lookup AppleTalk printers");
317 if (numberFound
>= MAX_PRINTERS
)
318 fprintf(stderr
, "WARNING: Adding only the first %d printers found", MAX_PRINTERS
);
320 /* Not required but sort them so they look nice */
321 qsort(buf
, numberFound
, sizeof(at_nbptuple_t
), nbptuple_compare
);
323 for (i
= 0; i
< numberFound
; i
++)
325 memcpy(name
, buf
[i
].enu_entity
.object
.str
, MIN(buf
[i
].enu_entity
.object
.len
, sizeof(name
)-1));
326 name
[MIN(buf
[i
].enu_entity
.object
.len
, sizeof(name
)-1)] = '\0';
328 if (addPercentEscapes(name
, encodedName
, sizeof(encodedName
)) == 0)
330 /* Each line is of the form: "class URI "make model" "info" */
331 char make_model
[128], /* Make and model */
335 if ((ptr
= strchr(name
, ' ')) != NULL
)
338 * If the printer name contains spaces, it is probably a make and
342 if (!strncmp(name
, "ET00", 4))
345 * Drop leading ethernet address info...
348 strlcpy(make_model
, ptr
+ 1, sizeof(make_model
));
351 strlcpy(make_model
, name
, sizeof(make_model
));
354 strcpy(make_model
, "Unknown");
356 printf("network pap://%s/%s/LaserWriter \"%s\" \"%s AppleTalk\"\n",
357 encodedZone
, encodedName
, make_model
, name
);
365 * @function printFile
366 * @abstract Open a PAP session and send the data from the input socket to the printer.
368 * @param name NBP name
369 * @param zone NBP zone
370 * @param type NBP type
371 * @param fdin File descriptor to read data from
372 * @param fdout File descriptor to write printer responses to
373 * @param fderr File descriptor to write printer status to
374 * @param copies # of copies to send (in case in the converter couldn't handle this for us).
375 * @param argc # of command line arguments.
377 * @result A non-zero return value for errors
379 static int printFile(char* name
, char* type
, char* zone
, int fdin
, int fdout
, int fderr
, int copies
, int argc
)
386 char fileBuffer
[4096]; /* File buffer */
387 int fileBufferNbytes
;
392 char sockBuffer
[4096 + 1]; /* Socket buffer with room for nul */
393 char atpReqBuf
[AT_PAP_DATA_SIZE
];
397 at_inet_t sendDataAddr
;
400 int userdata
, xo
, reqlen
;
405 struct timeval timeout
, *timeoutPtr
;
406 u_char flowQuantum
= 1;
407 u_short recvSequence
= 0;
412 connect_timeout
= -1,
417 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
418 struct sigaction action
; /* Actions for POSIX signals */
419 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
421 /* try to find our printer */
422 if ((err
= nbp_make_entity(&entity
, name
, type
, zone
)) != noErr
)
424 fprintf(stderr
, "ERROR: Unable to make AppleTalk address: %s\n", strerror(errno
));
429 * Remember when we started looking for the printer.
432 start_time
= time(NULL
);
438 fprintf(stderr
, "STATE: +connecting-to-device\n");
440 /* Loop forever trying to get an open session with the printer. */
443 /* Make sure it's okay to use appletalk */
444 if (okayToUseAppleTalk())
446 /* Clear this printer-state-reason in case we've set it */
447 fprintf(stderr
, "STATE: -apple-appletalk-disabled-warning\n");
449 /* Resolve the name into an address. Returns the number found or an error */
450 if ((err
= nbp_lookup(&entity
, &tuple
, 1, &retry
)) > 0)
453 fprintf(stderr
, "DEBUG: Found more than one printer with the name \"%s\"\n", name
);
457 fprintf(stderr
, "STATE: -apple-nbp-lookup-warning\n");
461 /* Open a connection to the device */
462 if ((err
= papOpen(&tuple
, &gConnID
, &gSockfd
, &gSessionAddr
, &flowQuantum
)) == 0)
465 fprintf(stderr
, "WARNING: Unable to open \"%s:%s\": %s\n", name
, zone
, strerror(err
));
469 /* It's not unusual to have to call nbp_lookup() twice before it's sucessful... */
470 if (++nbp_failures
> 2)
474 fprintf(stderr
, "STATE: +apple-nbp-lookup-warning\n");
475 fprintf(stderr
, "WARNING: Printer not responding\n");
481 fprintf(stderr
, "STATE: +apple-appletalk-disabled-warning\n");
482 fprintf(stderr
, "INFO: AppleTalk disabled in System Preferences.\n");
485 elasped_time
= time(NULL
) - start_time
;
487 if (connect_timeout
== -1)
488 connect_timeout
= connectTimeout();
490 if (connect_timeout
&& elasped_time
> connect_timeout
)
492 fprintf(stderr
, "ERROR: Printer not responding\n");
494 goto Exit
; /* Waiting too long... */
496 else if (elasped_time
< (30 * 60))
497 sleep_time
= 10; /* Waiting < 30 minutes */
498 else if (elasped_time
< (24 * 60 * 60))
499 sleep_time
= 30; /* Waiting < 24 hours */
501 sleep_time
= 60; /* Waiting > 24 hours */
503 fprintf(stderr
, "DEBUG: sleeping %d seconds...\n", (int)sleep_time
);
507 fprintf(stderr
, "STATE: -connecting-to-device\n");
510 * Now that we are connected to the printer ignore SIGTERM so that we
511 * can finish out any page data the driver sends (e.g. to eject the
512 * current page... if we are printing data from a file then catch the
513 * signal so we can send a PAP Close packet (otherwise you can't cancel
517 #ifdef HAVE_SIGSET /* Use System V signals over POSIX to avoid bugs */
518 sigset(SIGTERM
, (argc
< 7) ? SIG_IGN
: signalHandler
);
519 #elif defined(HAVE_SIGACTION)
520 memset(&action
, 0, sizeof(action
));
522 sigemptyset(&action
.sa_mask
);
523 action
.sa_handler
= (argc
< 7) ? SIG_IGN
: signalHandler
;
524 sigaction(SIGTERM
, &action
, NULL
);
526 signal(SIGTERM
, (argc
< 7) ? SIG_IGN
: signalHandler
);
529 /* Makes debugging easier; otherwise printer will be busy for several minutes */
530 signal(SIGINT
, signalHandler
);
533 #endif /* HAVE_SIGSET */
535 fprintf(stderr
, "INFO: Sending data\n");
537 sendDataAddr
= tuple
.enu_addr
;
539 /* Start the tickle packets and set a timeout alarm */
540 if ((err
= papSendRequest(gSockfd
, &gSessionAddr
, gConnID
, AT_PAP_TYPE_TICKLE
, 0, false, false)) < 0)
542 perror("ERROR: Unable to send PAP tickle request");
545 signal(SIGALRM
, signalHandler
);
548 /* Prime the pump with an initial send-data packet */
549 if ((err
= papSendRequest(gSockfd
, &gSessionAddr
, gConnID
, AT_PAP_TYPE_SEND_DATA
, 0xFF, true, true)) < 0)
551 perror("ERROR: Unable to send initial PAP send data request");
555 /* Set non-blocking mode on our data source descriptor */
556 val
= fcntl(fdin
, F_GETFL
, 0);
557 fcntl(fdin
, F_SETFL
, val
| O_NONBLOCK
);
559 fileBufferNbytes
= 0;
561 fileEOFRead
= fileEOFSent
= false;
562 maxfdp1
= MAX(fdin
, gSockfd
) + 1;
564 if (gStatusInterval
!= 0)
567 nextStatusTime
= time(NULL
) + gStatusInterval
;
568 timeoutPtr
= &timeout
;
576 /* Set up our descriptors for the select */
578 FD_SET(gSockfd
, &readSet
);
580 if (fileBufferNbytes
== 0 && fileEOFRead
== false)
581 FD_SET(fdin
, &readSet
);
583 /* Set the select timeout value based on the next status interval */
584 if (gStatusInterval
!= 0)
587 timeout
.tv_sec
= (nextStatusTime
> now
) ? nextStatusTime
- now
: 1;
590 /* Wait here for something interesting to happen */
591 if ((err
= select(maxfdp1
, &readSet
, 0, 0, timeoutPtr
)) < 0)
593 perror("ERROR: select");
597 if (err
== 0 || (gStatusInterval
!= 0 && time(NULL
) >= nextStatusTime
))
599 /* Time to send a status request */
600 if ((err
= papSendRequest(gSockfd
, &tuple
.enu_addr
, 0, AT_PAP_TYPE_SEND_STATUS
, 0x01, false, false)) < 0)
601 perror("WARNING: Unable to send PAP status request");
604 nextStatusTime
= time(NULL
) + gStatusInterval
;
607 /* Was there an event on the input stream? */
608 if (FD_ISSET(fdin
, &readSet
))
610 FD_CLR(fdin
, &readSet
);
612 assert(fileBufferNbytes
== 0);
613 fileBufferNbytes
= read(fdin
, fileBuffer
, MIN(sizeof(fileBuffer
), AT_PAP_DATA_SIZE
* flowQuantum
));
614 if (fileBufferNbytes
== 0)
617 if (fileEOFSent
== false && fileBufferNbytes
>= 0 && gSendDataID
!= 0)
619 fprintf(stderr
, "DEBUG: -> PAP_DATA %d bytes %s\n", fileBufferNbytes
, fileEOFRead
? "with EOF" : "");
620 papWrite(gSockfd
, &sendDataAddr
, gSendDataID
, gConnID
, flowQuantum
, fileBuffer
, fileBufferNbytes
, fileEOFRead
);
622 fileTbytes
+= fileBufferNbytes
;
623 if (argc
> 6 && !gErrorlogged
)
624 fprintf(stderr
, "DEBUG: Sending print file, %qd bytes\n", (off_t
)fileTbytes
);
626 fileBufferNbytes
= 0;
631 if (gWaitEOF
== false || fileTbytes
== 0)
640 /* Was there an event on the output stream? */
641 if (FD_ISSET(gSockfd
, &readSet
))
643 if ((rc
= atp_look(gSockfd
)) < 0)
645 perror("ERROR: Unable to look for PAP response");
651 /* It's an ATP response */
652 resp
.resp
[0].iov_base
= sockBuffer
;
653 resp
.resp
[0].iov_len
= sizeof(sockBuffer
) - 1;
656 if ((err
= atp_getresp(gSockfd
, &tid
, &resp
)) < 0)
658 perror("ERROR: Unable to get PAP response");
661 userdata
= resp
.userdata
[0];
665 /* It's an ATP request */
666 reqlen
= sizeof(atpReqBuf
);
667 if ((err
= atp_getreq(gSockfd
, &src
, atpReqBuf
, &reqlen
, &userdata
, &xo
, &tid
, &bitmap
, 0)) < 0)
669 perror("ERROR: Unable to get PAP request");
674 fprintf(stderr
, "DEBUG: <- %s\n", packet_name(TYPE_OF(userdata
)));
676 switch (TYPE_OF(userdata
))
678 case AT_PAP_TYPE_SEND_STS_REPLY
: /* Send-Status-Reply packet */
681 char *iov_base
= (char *)resp
.resp
[0].iov_base
;
682 statusUpdate(&iov_base
[5], iov_base
[4]);
686 case AT_PAP_TYPE_SEND_DATA
: /* Send-Data packet */
687 sendDataAddr
.socket
= src
.socket
;
689 recvSequence
= OSReadBigInt16(&SEQUENCE_NUM(userdata
), 0);
691 if ((fileBufferNbytes
> 0 || fileEOFRead
) && fileEOFSent
== false)
693 fprintf(stderr
, "DEBUG: -> PAP_DATA %d bytes %s\n", fileBufferNbytes
, fileEOFRead
? "with EOF" : "");
694 papWrite(gSockfd
, &sendDataAddr
, gSendDataID
, gConnID
, flowQuantum
, fileBuffer
, fileBufferNbytes
, fileEOFRead
);
696 fileTbytes
+= fileBufferNbytes
;
697 if (argc
> 6 && !gErrorlogged
)
698 fprintf(stderr
, "DEBUG: Sending print file, %qd bytes\n", (off_t
)fileTbytes
);
700 fileBufferNbytes
= 0;
705 if (gWaitEOF
== false)
714 case AT_PAP_TYPE_DATA
: /* Data packet */
715 for (len
=0, i
=0; i
< ATP_TRESP_MAX
; i
++)
717 if (resp
.bitmap
& (1 << i
))
718 len
+= resp
.resp
[i
].iov_len
;
721 fprintf(stderr
, "DEBUG: <- PAP_DATA %d bytes %s\n", len
, IS_PAP_EOF(userdata
) ? "with EOF" : "");
725 char *pLineBegin
, *pCommentEnd
, *pChar
;
730 cupsBackChannelWrite(sockBuffer
, len
, 1.0);
732 sockBuffer
[len
] = '\0'; /* We always reserve room for the nul so we can use strstr() below*/
733 pLineBegin
= sockBuffer
;
735 /* If there are PostScript status comments in the buffer log them.
737 * This logic shouldn't be in the backend but until we get backchannel
738 * data in CUPS 1.2 it has to live here.
740 while (pLineBegin
< sockBuffer
+ len
&&
741 (pLineBegin
= strstr(pLineBegin
, "%%[")) != NULL
&&
742 (pCommentEnd
= strstr(pLineBegin
, "]%%")) != NULL
)
744 pCommentEnd
+= 3; /* Skip past "]%%" */
745 *pCommentEnd
= '\0'; /* There's always room for the nul */
747 /* Strip the CRs & LFs before writing it to stderr */
748 for (pChar
= pLineBegin
; pChar
< pCommentEnd
; pChar
++)
749 if (*pChar
== '\r' || *pChar
== '\n')
752 if (strncasecmp(pLineBegin
, "%%[ Error:", 10) == 0)
754 /* logLevel should be "ERROR" here but this causes PrintCenter
755 * to pause the queue which in turn clears this error, which
756 * restarts the job. So the job ends up in an infinite loop with
757 * the queue being held/un-held. Just make it DEBUG for now until
758 * we fix notifications later.
763 else if (strncasecmp(pLineBegin
, "%%[ Flushing", 12) == 0)
768 if ((logstrlen
= snprintf(logstr
, sizeof(logstr
), "%s: %s\n", logLevel
, pLineBegin
)) >= sizeof(logstr
))
770 /* If the string was trucnated make sure it has a linefeed before the nul */
771 logstrlen
= sizeof(logstr
) - 1;
772 logstr
[logstrlen
- 1] = '\n';
775 write(fderr
, logstr
, logstrlen
);
777 pLineBegin
= pCommentEnd
+ 1;
781 if (IS_PAP_EOF(userdata
) != 0)
783 /* If this is EOF then were we expecting it? */
784 if (fileEOFSent
== true)
788 fprintf(stderr
, "WARNING: Printer sent unexpected EOF\n");
792 if ((err
= papSendRequest(gSockfd
, &gSessionAddr
, gConnID
, AT_PAP_TYPE_SEND_DATA
, 0xFF, true, true)) < 0)
794 fprintf(stderr
, "ERROR: Error %d sending PAPSendData resuest: %s\n", err
, strerror(errno
));
799 case AT_PAP_TYPE_TICKLE
: /* Tickle packet */
802 case AT_PAP_TYPE_CLOSE_CONN
: /* Close-Connection packet */
803 /* We shouldn't normally see this. */
804 papCloseResp(gSockfd
, &gSessionAddr
, xo
, tid
, gConnID
);
806 /* If this is EOF then were we expecting it? */
807 if (fileEOFSent
== true)
809 fprintf(stderr
, "WARNING: Printer sent unexpected EOF\n");
813 fprintf(stderr
, "ERROR: Printer sent unexpected EOF\n");
818 case AT_PAP_TYPE_OPEN_CONN
: /* Open-Connection packet */
819 case AT_PAP_TYPE_OPEN_CONN_REPLY
: /* Open-Connection-Reply packet */
820 case AT_PAP_TYPE_SEND_STATUS
: /* Send-Status packet */
821 case AT_PAP_TYPE_CLOSE_CONN_REPLY
: /* Close-Connection-Reply packet */
822 fprintf(stderr
, "WARNING: Unexpected PAP packet of type %d\n", TYPE_OF(userdata
));
826 fprintf(stderr
, "WARNING: Unknown PAP packet of type %d\n", TYPE_OF(userdata
));
830 if (CONNID_OF(userdata
) == gConnID
)
832 /* Reset tickle timer */
841 * Close the socket and return...
852 * @abstract Open a pap session to a printer.
854 * @param tuple nbp address of printer
855 * @param connID returned pap connection id
856 * @param fd returned socket descriptor
857 * @param sessionAddr returned session address
858 * @param flowQuantum returned flow quantum (usually 8)
860 * @result A non-zero return value for errors
862 static int papOpen(at_nbptuple_t
* tuple
, u_char
* connID
, int* fd
,
863 at_inet_t
* sessionAddr
, u_char
* flowQuantum
)
872 rdata
[ATP_DATA_SIZE
];
880 puserdata
= (u_char
*)&userdata
;
882 fprintf(stderr
, "INFO: Opening connection\n");
884 if ((*fd
= atp_open(&socketfd
)) < 0)
888 * Build the open connection request packet.
894 *connID
= (rand()&0xff) | 0x01;
895 puserdata
[0] = *connID
;
896 puserdata
[1] = AT_PAP_TYPE_OPEN_CONN
;
904 resp
.resp
[0].iov_base
= rdata
;
905 resp
.resp
[0].iov_len
= sizeof(rdata
);
912 waitTime
= time(NULL
) - tm
;
913 OSWriteBigInt16(&data
[2], 0, (u_short
)waitTime
);
915 fprintf(stderr
, "DEBUG: -> %s\n", packet_name(AT_PAP_TYPE_OPEN_CONN
));
917 if ((atp_err
= atp_sendreq(*fd
, &tuple
->enu_addr
, data
, 4, userdata
, 1, 0,
918 0, &resp
, &retry
, 0)) < 0)
920 statusUpdate("Destination unreachable", 23);
921 result
= EHOSTUNREACH
;
925 puserdata
= (u_char
*)&resp
.userdata
[0];
926 open_result
= OSReadBigInt16(&rdata
[2], 0);
928 fprintf(stderr
, "DEBUG: <- %s, status %d\n", packet_name(puserdata
[1]),
932 * Just for the sake of our sanity check the other fields in the packet
935 if (puserdata
[1] != AT_PAP_TYPE_OPEN_CONN_REPLY
||
936 (open_result
== 0 && (puserdata
[0] & 0xff) != *connID
))
942 statusUpdate(&rdata
[5], rdata
[4] & 0xff);
945 * if the connection established okay exit from the loop
948 if (open_result
== 0)
956 /* Update the session address
958 sessionAddr
->net
= tuple
->enu_addr
.net
;
959 sessionAddr
->node
= tuple
->enu_addr
.node
;
960 sessionAddr
->socket
= rdata
[0];
961 *flowQuantum
= rdata
[1];
976 * @abstract End a PAP session by canceling outstanding send-data & tickle
977 * transactions and sending a PAP close request.
979 * @result A non-zero return value for errors
981 static int papClose()
986 unsigned char rdata
[ATP_DATA_SIZE
];
988 u_char
*puserdata
= (u_char
*)&userdata
;
999 /* Cancel the pending send-data and tickle trnsactions
1003 tmpID
= gSendDataID
;
1005 papCancelRequest(fd
, tmpID
);
1012 papCancelRequest(fd
, tmpID
);
1015 /* This is a workaround for bug #2735145. The problem is papWrite()
1016 * returns before the ATP TRel arrives for it. If we send the pap close packet
1017 * before this release then the printer can drop the last data packets.
1018 * The effect on an Epson printer is the last page doesn't print, on HP it
1019 * doesn't close the pap session.
1021 if (gWaitEOF
== false)
1024 fprintf(stderr
, "DEBUG: -> %s\n", packet_name(AT_PAP_TYPE_CLOSE_CONN
));
1026 puserdata
[0] = gConnID
;
1027 puserdata
[1] = AT_PAP_TYPE_CLOSE_CONN
;
1035 resp
.resp
[0].iov_base
= rdata
;
1036 resp
.resp
[0].iov_len
= sizeof(rdata
);
1038 result
= atp_sendreq(fd
, &gSessionAddr
, 0, 0, userdata
, 1, 0, 0, &resp
, &retry
, 0);
1047 * @function papWrite
1048 * @abstract Write bytes to a printer.
1050 * @param sockfd socket descriptor
1051 * @param dest destination address
1052 * @param tid transaction id
1053 * @param connID connection id
1054 * @param flowQuantum returned flow quantum (usually 8)
1055 * @param data pointer to the data
1056 * @param len number of bytes to send
1057 * @param eof pap eof flag
1059 * @result A non-zero return value for errors
1061 static int papWrite(int sockfd
, at_inet_t
* dest
, u_short tid
, u_char connID
, u_char flowQuantum
, char* data
, int len
, int eof
)
1068 /* fprintf(stderr, "DEBUG: papWrite(%d%s) to %d,%d,%d; %d\n", len, eof ? " EOF":"", dest->net, dest->node, dest->socket, connID); */
1070 if (len
> AT_PAP_DATA_SIZE
* flowQuantum
)
1072 fprintf(stderr
, "DEBUG: papWrite() len of %d is too big!\n", len
);
1078 * Break up the outgoing data into a set of
1079 * response packets to reply to an incoming
1080 * PAP 'SENDDATA' request
1082 for (i
= 0; i
< flowQuantum
; i
++)
1084 resp
.userdata
[i
] = 0;
1085 puserdata
= (u_char
*)&resp
.userdata
[i
];
1087 puserdata
[PAP_CONNID
] = connID
;
1088 puserdata
[PAP_TYPE
] = AT_PAP_TYPE_DATA
;
1089 puserdata
[PAP_EOF
] = eof
? 1 : 0;
1091 resp
.resp
[i
].iov_base
= (caddr_t
)data
;
1094 data
+= AT_PAP_DATA_SIZE
;
1096 resp
.resp
[i
].iov_len
= MIN((int)len
, (int)AT_PAP_DATA_SIZE
);
1097 len
-= resp
.resp
[i
].iov_len
;
1101 resp
.bitmap
= (1 << (i
+ 1)) - 1;
1104 * Write out the data as a PAP 'DATA' response
1107 if ((result
= atp_sendrsp(sockfd
, dest
, true, tid
, &resp
)) < 0)
1109 fprintf(stderr
, "DEBUG: atp_sendrsp() returns %d, errno %d \"%s\"\n", result
, errno
, strerror(errno
));
1117 * @function papCloseResp
1118 * @abstract Send a pap close response in the rare case we receive a close connection request.
1120 * @param sockfd socket descriptor
1121 * @param dest destination address
1122 * @param tid transaction id
1123 * @param connID connection id
1125 * @result A non-zero return value for errors
1127 static int papCloseResp(int sockfd
, at_inet_t
* dest
, int xo
, u_short tid
, u_char connID
)
1133 resp
.userdata
[0] = 0;
1135 ((u_char
*)&resp
.userdata
[0])[PAP_CONNID
] = connID
;
1136 ((u_char
*)&resp
.userdata
[0])[PAP_TYPE
] = AT_PAP_TYPE_CLOSE_CONN_REPLY
;
1138 resp
.resp
[0].iov_base
= NULL
;
1139 resp
.resp
[0].iov_len
= 0;
1141 if ((result
= atp_sendrsp(sockfd
, dest
, xo
, tid
, &resp
)) < 0)
1143 fprintf(stderr
, "DEBUG: atp_sendrsp() returns %d, errno %d \"%s\"\n", result
, errno
, strerror(errno
));
1151 * @function papSendRequest
1152 * @abstract Send a pap close response in the rare case we receive a close connection request.
1154 * @param sockfd socket descriptor
1155 * @param dest destination address
1156 * @param function pap function
1157 * @param bitmap bitmap
1158 * @param xo exactly once
1159 * @param seqno sequence number
1161 * @result A non-zero return value for errors
1163 static int papSendRequest(int sockfd
, at_inet_t
* dest
, u_char connID
, int function
, u_char bitmap
, int xo
, int seqno
)
1169 u_char
*puserdata
= (u_char
*)&userdata
;
1172 static u_short pap_send_count
= 0;
1174 fprintf(stderr
, "DEBUG: -> %s\n", packet_name(function
));
1176 puserdata
[0] = connID
;
1177 puserdata
[1] = function
;
1178 resp
.bitmap
= bitmap
;
1179 retry
.interval
= 10;
1180 retry
.retries
= -1; /* was ATP_INFINITE_RETRIES */
1184 if (pap_send_count
== 0)
1187 OSWriteBigInt16(&puserdata
[2], 0, pap_send_count
);
1190 OSWriteBigInt16(&puserdata
[2], 0, 0);
1193 sigaddset(&sv
, SIGIO
);
1194 sigprocmask(SIG_SETMASK
, &sv
, &osv
);
1196 err
= atp_sendreq(sockfd
, dest
, 0, 0, userdata
, xo
, 0, &tid
, &resp
, &retry
, 1);
1198 sigprocmask(SIG_SETMASK
, &osv
, NULL
);
1205 * @function papCancelRequest
1206 * @abstract Cancel a pending pap request.
1208 * @param sockfd socket descriptor
1209 * @param tid transaction ID
1211 * @result A non-zero return value for errors
1213 int papCancelRequest(int sockfd
, u_short tid
)
1218 sigaddset(&sv
, SIGIO
);
1219 sigprocmask(SIG_SETMASK
, &sv
, &osv
);
1221 if (atp_abort(sockfd
, NULL
, tid
) < 0)
1223 sigprocmask(SIG_SETMASK
, &osv
, NULL
);
1226 sigprocmask(SIG_SETMASK
, &osv
, NULL
);
1234 * @function statusUpdate
1235 * @abstract Format and print a PAP status response to stderr.
1237 * @param status The status response string
1238 * @param statusLen The length of the status response string
1240 void statusUpdate(char* status
, u_char statusLen
)
1242 static char status_str
[255];
1243 static u_char last_statusLen
= 0xFF;
1245 /* Only send this if the status has changed */
1246 if (statusLen
!= last_statusLen
|| memcmp(status
, status_str
, statusLen
) != 0)
1248 if (statusLen
> sizeof(status_str
)-1)
1249 statusLen
= sizeof(status_str
)-1;
1250 last_statusLen
= statusLen
;
1251 memcpy(status_str
, status
, statusLen
);
1252 status_str
[(int)statusLen
] = '\0';
1255 * Make sure the status string is in the form of a PostScript comment.
1258 if (statusLen
> 3 && memcmp(status
, "%%[", 3) == 0)
1259 fprintf(stderr
, "INFO: %s\n", status_str
);
1261 fprintf(stderr
, "INFO: %%%%[ %s ]%%%%\n", status_str
);
1268 * @function parseUri
1269 * @abstract Parse a PAP URI into it's NBP components.
1271 * @param argv0 The PAP URI to parse
1272 * @param name NBP name
1273 * @param zone NBP zone
1274 * @param type NBP type
1276 * @result A non-zero return value for errors
1278 static int parseUri(const char* argv0
, char* name
, char* type
, char* zone
)
1280 char method
[255], /* Method in URI */
1281 hostname
[1024], /* Hostname */
1282 username
[255], /* Username info (not used) */
1283 resource
[1024], /* Resource info (device and options) */
1286 *options
, /* Pointer to options */
1287 optionName
[255], /* Name of option */
1288 value
[255], /* Value of option */
1289 *ptr
; /* Pointer into name or value */
1290 int port
; /* Port number (not used) */
1291 int statusInterval
; /* */
1294 * Extract the device name and options from the URI...
1296 method
[0] = username
[0] = hostname
[0] = resource
[0] = '\0';
1299 httpSeparateURI(HTTP_URI_CODING_NONE
, argv0
, method
, sizeof(method
),
1300 username
, sizeof(username
),
1301 hostname
, sizeof(hostname
), &port
,
1302 resource
, sizeof(resource
));
1305 * See if there are any options...
1307 if ((options
= strchr(resource
, '?')) != NULL
)
1310 * Yup, terminate the device name string and move to the first
1311 * character of the options...
1315 while (*options
!= '\0')
1320 for (ptr
= optionName
; *options
&& *options
!= '=' && *options
!= '+'; )
1321 *ptr
++ = *options
++;
1326 if (*options
== '=')
1334 for (ptr
= value
; *options
&& *options
!= '+';)
1335 *ptr
++ = *options
++;
1339 if (*options
== '+')
1342 else if (*options
== '+')
1348 * Process the option...
1350 if (strcasecmp(optionName
, "waiteof") == 0)
1355 if (strcasecmp(value
, "on") == 0 ||
1356 strcasecmp(value
, "yes") == 0 ||
1357 strcasecmp(value
, "true") == 0)
1361 else if (strcasecmp(value
, "off") == 0 ||
1362 strcasecmp(value
, "no") == 0 ||
1363 strcasecmp(value
, "false") == 0)
1369 fprintf(stderr
, "WARNING: Boolean expected for waiteof option \"%s\"\n", value
);
1372 else if (strcasecmp(optionName
, "status") == 0)
1374 statusInterval
= atoi(value
);
1375 if (value
[0] < '0' || value
[0] > '9' ||
1378 fprintf(stderr
, "WARNING: number expected for status option \"%s\"\n", value
);
1382 gStatusInterval
= statusInterval
;
1388 resourcePtr
= resource
;
1390 if (*resourcePtr
== '/')
1393 /* If the resource has a slash we assume the slash seperates the AppleTalk object
1394 * name from the AppleTalk type. If the slash is not present we assume the AppleTalk
1395 * type is LaserWriter.
1397 typePtr
= strchr(resourcePtr
, '/');
1398 if (typePtr
!= NULL
) {
1401 typePtr
= "LaserWriter";
1404 removePercentEscapes(hostname
, zone
, NBP_NVE_STR_SIZE
+ 1);
1405 removePercentEscapes(resourcePtr
, name
, NBP_NVE_STR_SIZE
+ 1);
1406 removePercentEscapes(typePtr
, type
, NBP_NVE_STR_SIZE
+ 1);
1413 * @function addPercentEscapes
1414 * @abstract Encode a string with percent escapes
1416 * @param src The source C string
1417 * @param dst Desination buffer
1418 * @param dstMax Size of desination buffer
1420 * @result A non-zero return value for errors
1422 static int addPercentEscapes(const char* src
, char* dst
, int dstMax
)
1425 char *dstEnd
= dst
+ dstMax
- 1; /* -1 to leave room for the NUL */
1431 if ((c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
1432 (c
>= '0' && c
<= '9') || (c
== '.' || c
== '-' || c
== '*' || c
== '_'))
1441 if (dst
>= dstEnd
- 2)
1444 snprintf(dst
, dstEnd
- dst
, "%%%02x", c
);
1455 * @function removePercentEscapes
1456 * @abstract Returns a string with any percent escape sequences replaced with their equivalent character
1458 * @param src Source buffer
1459 * @param srclen Number of bytes in source buffer
1460 * @param dst Desination buffer
1461 * @param dstMax Size of desination buffer
1463 * @result A non-zero return value for errors
1465 static int removePercentEscapes(const char* src
, char* dst
, int dstMax
)
1468 const char *dstEnd
= dst
+ dstMax
;
1470 while (*src
&& dst
< dstEnd
)
1476 sscanf(src
, "%02x", &c
);
1491 * @function nbptuple_compare
1492 * @abstract An NBP comparator for qsort.
1494 * @result p1<p2: -1, p1=p2: 0, p1>p2: 1
1496 int nbptuple_compare(const void *p1
, const void *p2
)
1499 int len
= MIN(((at_nbptuple_t
*)p1
)->enu_entity
.object
.len
,
1500 ((at_nbptuple_t
*)p2
)->enu_entity
.object
.len
);
1502 if ((result
= memcmp(((at_nbptuple_t
*)p1
)->enu_entity
.object
.str
, ((at_nbptuple_t
*)p2
)->enu_entity
.object
.str
, len
)) == 0)
1504 if (((at_nbptuple_t
*)p1
)->enu_entity
.object
.len
< ((at_nbptuple_t
*)p2
)->enu_entity
.object
.len
)
1506 else if (((at_nbptuple_t
*)p1
)->enu_entity
.object
.len
> ((at_nbptuple_t
*)p2
)->enu_entity
.object
.len
)
1516 * @function okayToUseAppleTalk
1517 * @abstract Returns true if AppleTalk is available and enabled.
1519 * @result non-zero if AppleTalk is enabled
1521 static int okayToUseAppleTalk()
1523 int atStatus
= checkATStack();
1525 /* I think the test should be:
1526 * return atStatus == RUNNING || atStatus == LOADED;
1527 * but when I disable AppleTalk from the network control panel and
1528 * reboot, AppleTalk shows up as loaded. The test empirically becomes
1531 return atStatus
== RUNNING
;
1536 * @function packet_name
1537 * @abstract Returns packet name string.
1541 static const char *packet_name(u_char x
)
1545 case AT_PAP_TYPE_OPEN_CONN
: return "PAP_OPEN_CONN";
1546 case AT_PAP_TYPE_OPEN_CONN_REPLY
: return "PAP_OPEN_CONN_REPLY";
1547 case AT_PAP_TYPE_SEND_DATA
: return "PAP_SEND_DATA";
1548 case AT_PAP_TYPE_DATA
: return "PAP_DATA";
1549 case AT_PAP_TYPE_TICKLE
: return "PAP_TICKLE";
1550 case AT_PAP_TYPE_CLOSE_CONN
: return "PAP_CLOSE_CONN";
1551 case AT_PAP_TYPE_CLOSE_CONN_REPLY
: return "PAP_CLOSE_CONN_REPLY";
1552 case AT_PAP_TYPE_SEND_STATUS
: return "PAP_SEND_STATUS";
1553 case AT_PAP_TYPE_SEND_STS_REPLY
: return "PAP_SEND_STS_REPLY";
1554 case AT_PAP_TYPE_READ_LW
: return "PAP_READ_LW";
1561 * @function connectTimeout
1562 * @abstract Returns the connect timeout preference value.
1564 static int connectTimeout()
1566 CFPropertyListRef value
;
1567 SInt32 connect_timeout
= (7 * 24 * 60 * 60); /* Default timeout is one week... */
1569 value
= CFPreferencesCopyValue(CFSTR("timeout"), CFSTR("com.apple.print.backends"),
1570 kCFPreferencesAnyUser
, kCFPreferencesCurrentHost
);
1573 if (CFGetTypeID(value
) == CFNumberGetTypeID())
1574 CFNumberGetValue(value
, kCFNumberSInt32Type
, &connect_timeout
);
1579 return connect_timeout
;
1584 * @function signalHandler
1585 * @abstract A signal handler so we can clean up the pap session before exiting.
1587 * @param sigraised The signal raised
1589 * @result Never returns
1591 static void signalHandler(int sigraised
)
1593 fprintf(stderr
, "ERROR: There was a timeout error while sending data to the printer\n");