1N/A * The contents of this file are subject to the terms of the 1N/A * Common Development and Distribution License, Version 1.0 only 1N/A * (the "License"). You may not use this file except in compliance 1N/A * See the License for the specific language governing permissions 1N/A * and limitations under the License. 1N/A * When distributing Covered Code, include this CDDL HEADER in each 1N/A * If applicable, add the following below this CDDL HEADER, with the 1N/A * fields enclosed by brackets "[]" replaced with your own identifying 1N/A * information: Portions Copyright [yyyy] [name of copyright owner] 1N/A * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 1N/A * Use is subject to license terms. 1N/A/* Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */ 1N/A/* All Rights Reserved */ 1N/A#
pragma ident "%Z%%M% %I% %E% SMI" 1N/A * postio - RS-232 serial interface for PostScript printers 1N/A * A simple program that manages input and output for PostScript printers. Much 1N/A * has been added and changed from early versions of the program, but the basic 1N/A * philosophy is still the same. Don't send real data until we're certain we've 1N/A * connected to a PostScript printer that's in the idle state and try to hold 1N/A * the connection until the job is completely done. It's more work than you 1N/A * might expect is necessary, but should provide a reasonably reliable spooler 1N/A * interface that can return error indications to the caller via the program's 1N/A * I've added code that will let you split the program into separate read/write 1N/A * processes. Although it's not the default it should be useful if you have a 1N/A * file that will be returning useful data from the printer. The two process 1N/A * stuff was laid down on top of the single process code and both methods still 1N/A * work. The implementation isn't as good as it could be, but didn't require 1N/A * many changes to the original program (despite the fact that there are now 1N/A * many differences). 1N/A * By default the program still runs as a single process. The -R2 option forces 1N/A * separate read and write processes after the intial connection is made. If you 1N/A * want that as the default initialize splitme (below) to TRUE. In addition the 1N/A * -t option that's used to force stuff not recognized as status reports to 1N/A * stdout also tries to run as two processes (by setting splitme to TRUE). It 1N/A * will only work if the required code (ie. resetline() in ifdef.c) has been 1N/A * implemented for your Unix system. I've only tested the System V code. 1N/A * Code needed to support interactive mode has also been added, although again 1N/A * it's not as efficient as it could be. It depends on the system dependent 1N/A * procedures resetline() and setupstdin() (file ifdef.c) and for now is only 1N/A * guaranteed to work on System V. Can be requested using the -i option. * Quiet mode (-q option) is also new, but was needed for some printers * connected to RADIAN. If you're running in quiet mode no status requests will * be sent to the printer while files are being transmitted (ie. in send()). * The program expects to receive printer status lines that look like, * %%[ status: idle; source: serial 25 ]%% * %%[ status: waiting; source: serial 25 ]%% * %%[ status: initializing; source: serial 25 ]%% * %%[ status: busy; source: serial 25 ]%% * %%[ status: printing; source: serial 25 ]%% * %%[ status: PrinterError: out of paper; source: serial 25 ]%% * %%[ status: PrinterError: no paper tray; source: serial 25 ]%% * although this list isn't complete. Sending a '\024' (control T) character * forces the return of a status report. PostScript errors detected on the * printer result in the immediate transmission of special error messages that * %%[ Error: undefined; OffendingCommand: xxx ]%% * %%[ Flushing: rest of job (to end-of-file) will be ignored ]%% * although we only use the Error and Flushing keywords. Finally conditions, * like being out of paper, result in other messages being sent back from the * printer over the communications line. Typical PrinterError messages look * %%[ PrinterError: out of paper; source: serial 25 ]%% * %%[ PrinterError: paper jam; source: serial 25 ]%% * although we only use the PrinterError keyword rather than trying to recognize * all possible printer errors. * The implications of using one process and only flow controlling data going to * the printer are obvious. Job transmission should be reliable, but there can * be data loss in stuff sent back from the printer. Usually that only caused * problems with jobs designed to run on the printer and return useful data * back over the communications line. If that's the kind of job you're sending * call postio with the -t option. That should force the program to split into * separate read and write processes and everything not bracketed by "%%[ " * and " ]%%" strings goes to stdout. In otherwords the data you're expecting * should be separated from the status stuff that goes to the log file (or * stderr). The -R2 option does almost the same thing (ie. separate read and * write processes), but everything that comes back from the printer goes to * the log file (stderr by default) and you'll have to separate your data from * A typical command line might be, * postio -l /dev/tty01 -b 9600 -L log file1 file2 * where -l selects the line, -b sets the baud rate, and -L selects the printer * log file. Since there's no default line, at least not right now, you'll * always need to use the -l option, and if you don't choose a log file stderr * will be used. If you have a program that will be returning data the command * postio -t -l/dev/tty01 -b9600 -Llog file >results * Status stuff goes to file log while the data you're expecting back from the * printer gets put in file results. #
include "ifdef.h" /* conditional compilation stuff */#
include "gen.h" /* general purpose definitions */#
include "postio.h" /* some special definitions */static char **
argv;
/* global so everyone can use them */ static char *
prog_name =
"";
/* really just for error messages */ static int x_stat = 0;
/* program exit status */ static int debug =
OFF;
/* debug flag */ static int ignore =
OFF;
/* what's done for FATAL errors */ static int quiet =
FALSE;
/* no status queries in send if TRUE */ static int splitme =
FALSE;
/* into READ & WRITE procs if TRUE */ static int otherpid = -
1;
/* who gets signals if greater than 1 */ static char *
mesgptr =
NULL;
/* printer msg starts here in mesg[] */ static int tostdout =
FALSE;
/* non-status stuff goes to stdout? */ char *
line =
NULL;
/* printer is on this tty line */ int stopbits =
1;
/* number of stop bits */ int head = 0;
/* block[head] is the next character */ int tail = 0;
/* one past the last byte in block[] */ char *
endmesg =
NULL;
/* end for readline() in mesg[] */ int ttyi = 0;
/* input */ int ttyo =
2;
/* and output file descriptors */ static void send(
int,
char *);
static int Write(
int,
char *,
int);
static char *
find(
char *,
char *);
void error(
int,
char *, ...);
/* from ifdef.c for serial interfaces */ * A simple program that manages input and output for PostScript printers. * Can run as a single process or as separate read/write processes. What's * done depends on the value assigned to splitme when split() is called. int nop(
int fd) {
return(0); }
/* is this a serial or parallel port? */ options();
/* get command line options */ start();
/* make sure the printer is ready */ done();
/* wait until the printer is finished */ cleanup();
/* make sure the write process stops */ return (
x_stat);
/* everything probably went OK */ * Makes sure we handle interrupts. The proper way to kill the program, if * necessary, is to do a kill -15. That forces a call to interrupt(), which in * turn tries to reset the printer and then exits with a non-zero status. If the * program is running as two processes, sending SIGTERM to either the parent or * child should clean things up. * Reads and processes the command line options. The -R2, -t, and -i options all * force separate read and write processes by eventually setting splitme to TRUE * (check initialize()). The -S option is not recommended and should only be int ch;
/* return value from getopt() */ char *
optnames =
"b:il:qs:tB:L:P:R:SDI";
extern char *
optarg;
/* used by getopt() */ case 'b':
/* baud rate string */ case 'i':
/* interactive mode */ case 'l':
/* printer line */ case 'q':
/* no status queries - for RADIAN? */ case 's':
/* use 2 stop bits - for UNISON? */ case 't':
/* non-status stuff goes to stdout */ case 'B':
/* set the job buffer size */ case 'L':
/* printer log file */ case 'P':
/* initial PostScript code */ case 'R':
/* run as one or two processes */ case 'S':
/* slow and kludged up vers. of send */ case 'D':
/* debug flag */ case 'I':
/* ignore FATAL errors */ case '?':
/* don't understand the option */ default:
/* don't know what to do for ch */ argc -=
optind;
/* get ready for non-option args */ * Called from options() to convert a baud rate string into an appropriate * termio value. *rate is looked up in baudtable[] and if it's found, the * corresponding value is returned to the caller. getbaud(
char *
rate)
/* string representing the baud rate */ int i;
/* for looking through baudtable[] */ * Initialization, a few checks, and a call to setupline() (file ifdef.c) to * open and configure the communications line. Settings for interactive mode * always take precedence. The setupstdin() call with an argument of 0 saves * the current terminal settings if interactive mode has been requested - * otherwise nothing's done. Unbuffering stdout (via the setbuf() call) isn't * really needed on System V since it's flushed whenever terminal input is * requested. It's more efficient if we buffer the stdout (on System V) but * safer (for other versions of Unix) if we include the setbuf() call. if (
line ==
NULL)
/* kludge for lp - they use -t option */ if (
blocksize >
1024)
/* don't send too much all at once */ error(
FATAL,
"a printer line must be supplied - use the -l option");
setupline();
/* configure the communications line */ setupstdin(0);
/* save current stdin term settings */ * Tries to put the printer in the IDLE state before anything important is sent. * Run as a single process no matter what has been assigned to splitme. Separate * read and write processes, if requested, will be created after we're done logit(
"printer startup\n");
* The HP LJ3 starts in waiting mode and needs the EOF to move * from waiting to idle. To see what would happen, code was added * to send the INTR on waiting and later changed to INTR/EOF. * The INTR by itself had no effect. The INTR/EOF put the * the printer in a busy status loop from which the only * recovery was to reset the printer. Until further testing * testing is done, do not send an INTR to a HPLJ3 in waiting * state. WAITING moved to a separate case to eliminate the * The HP LJ3 seems to process INTR at later times. All the * longwaits are increaased to reduce the number of INTRs sent. error(
FATAL,
"Disconnected - printer may be offline");
* The ENDJOB case has been removed. The HP LJ3 echoes all EOFs * sent so the ENDJOB has no real meaning. * If splitme is TRUE we fork a process, make the parent handle reading, and let * the child take care of writing. resetline() (file ifdef.c) contains all the * system dependent code needed to reset the communications line for separate * read and write processes. For now it's expected to return TRUE or FALSE and * that value controls whether we try the fork. I've only tested the two process * stuff for System V. Other versions of resetline() may just be dummy * procedures that always return FALSE. If the fork() failed previous versions * continued as a single process, although the implementation wasn't quite * right, but I've now decided to quit. The main reason is a Datakit channel * may be configured to flow control data in both directions, and if we run * postio over that channel as a single process we likely will end up in "can't create two process - check resetline()");
"running as a single process - check resetline()");
* Makes sure all the non-option command line arguments are processed. If there * aren't any arguments left when we get here we'll send stdin. Input files are * only read and sent to the printer if canwrite is TRUE. Checking it here means * we won't have to do it in send(). If interactive mode is TRUE we'll stay here * forever sending stdin when we run out of files - exit with a break. Actually * the loop is bogus and used at most once when we're in interactive mode * because stdin is in a pseudo raw mode and the read() in readblock() should * never see the end of file. int fd_in;
/* next input file */ do /* loop is for interactive mode */ * Sends file *name to the printer. There's nothing left here that depends on * sending and receiving status reports, although it can be reassuring to know * the printer is responding and processing our job. Only the writer gets here * in the two process implementation, and in that case split() has reset * nostatus to WRITEPROCESS and that's what getstatus() always returns. For * now we accept the IDLE state and ENDOFJOB as legitimate and ignore the error(
FATAL,
"Disconnected - printer may be offline");
* Tries to stay connected to the printer until we're reasonably sure the job is * complete. It's the only way we can recover error messages or data generated * by the PostScript program and returned over the communication line. Actually * doing it correctly for all possible PostScript jobs is more difficult that it * might seem. For example if we've sent several jobs, each with their own EOF * mark, then waiting for ENDOFJOB won't guarantee all the jobs have completed. * Even waiting for IDLE isn't good enough. Checking for the WAITING state after * all the files have been sent and then sending an EOF may be the best * approach, but even that won't work all the time - we could miss it or might * not get there. Even sending our own special PostScript job after all the * input files has it's own different set of problems, but probably could work * (perhaps by printing a fake status message or just not timing out). Anyway * it's probably not worth the trouble so for now we'll quit if writedone is * TRUE and we get ENDOFJOB or IDLE. * If we're running separate read and write processes the reader gets here after * after split() while the writer goes to send() and only gets here after all * the input files have been transmitted. When they're both here the writer * sends the reader signal joinsig and that forces writedone to TRUE in the * reader. At that point the reader can begin looking for an indication of the * end of the job. The writer hangs around until the reader kills it (usually * in cleanup()) sending occasional status requests. int sleeptime =
15;
/* for 'out of paper' etc. */ logit(
"waiting for end of job\n");
* For the HP LJ3 INTR sent while in the waiting state have * either had no effect or put the printer into a unrecoverable * loop. Further testing may reveal this to not be the case * but for now, remove the send INTR. * ENDOFJOB case removed here. The HP LJ 3 echoes all EOFs sent so * the ENDOFJOB case is meaningless. * During print data transmission, the HP LJ3 stays in * status busy. So give it a rest. error(
FATAL,
"Disconnected - printer may be offline");
* These cases are ignored without a EOF being sent * Only needed if we're running separate read and write processes. Makes sure * the write process is killed after the read process has successfully finished * with all the jobs. sendsignal() returns a -1 if there's nobody to signal so * things work when we're running a single process. * Fills the input buffer with the next block, provided we're all done with the * last one. Blocks from fd_in are stored in array block[]. head is the index * of the next byte in block[] that's supposed to go to the printer. tail points * one past the last byte in the current block. head is adjusted in writeblock() * after each successful write, while head and tail are reset here each time * a new block is read. Returns the number of bytes left in the current block. * Read errors cause the program to abort. The fake status message that's put * out in quiet mode is only so you can look at the log file and know * something's happening - take it out if you want. if (
head >=
tail) {
/* done with the last block */ * Called from send() when it's OK to send the next block to the printer. head * is adjusted after the write, and the number of bytes that were successfully * written is returned to the caller. int count;
/* bytes successfully written */ * Looks for things coming back from the printer on the communications line, * parses complete lines retrieved by readline(), and returns an integer * representation of the current printer status to the caller. If nothing was * available a status request (control T) is sent to the printer and nostatus * is returned to the caller (provided quiet isn't TRUE). Interactive mode * either never returns from readline() or returns FALSE. getstatus(
int t)
/* sleep time after sending '\024' */ * Parsing the lines that readline() stores in mesg[] is messy, and what's done * here isn't completely correct nor as fast as it could be. The general format * of lines that come back from the printer (assuming no data loss) is: * str%%[ key: val; key: val; key: val ]%%\n * where str can be most anything not containing a newline and printer reports * (eg. status or error messages) are bracketed by "%%[ " and " ]%%" strings and * end with a newline. Usually we'll have the string or printer report but not * both. For most jobs the leading string will be empty, but could be anything * generated on a printer and returned over the communications line using the * PostScript print operator. I'll assume PostScript jobs are well behaved and * never bracket their messages with "%%[ " and " ]%%" strings that delimit * status or error messages. * Printer reports consist of one or more key/val pairs, and what we're * interested in (status or error indications) may not be the first pair in the * list. In addition we'll sometimes want the value associated with a keyword * (eg. when key = status) and other times we'll want the keyword (eg. when * key = Error or Flushing). The last pair isn't terminated by a semicolon and * a value string often contains many space separated words and it can even * include colons in meaningful places. I've also decided to continue * converting things to lower case before doing the lookup in status[]. The * isupper() test is for Berkeley systems. char *e;
/* end of printer message in mesg[] */ char *p;
/* for converting to lower case etc. */ int i;
/* where *key was found in status[] */ sbuf[e-
mesgptr-
4] =
'\0';
/* ignore the trailing " ]%%" */ for (; *
key ==
' ';
key++);
/* skip leading space */ for (p =
key; *p; p++)
/* conv to lower case */ if (*p ==
':' || *p ==
',') {
}
else if (
strcmp(
mesg,
"CONVERSATION ENDED.\n") == 0)
* Looks for *str1 in string *str2. Returns a pointer to the start of the * substring if it's found or to the end of string str2 otherwise. char *
s1, *
s2;
/* can't change str1 or str2 too fast */ * Reads characters from the input line until nothing's left. Don't do * anything if we're currently running separate read and write processes. * Sends signal sig to the other process if we're running as separate read and * write processes. Returns the result of the kill if there's someone else to * signal or -1 if we're running alone. * Caught a signal - all except joinsig cause the program to quit. joinsig is * the signal sent by the writer to the reader after all the jobs have been * transmitted. Used to tell the read process when it can start looking for * Simple routine that's used to write a message to the log file. * Called when we've run into some kind of program error. First *mesg is * printed. If kind is FATAL and we're not ignoring errors the program * will be terminated. If mesg is NULL or *mesg is the NULL string nothing * Makes sure everything is properly cleaned up if there's a signal or FATAL * error that should cause the program to terminate. The sleep by the write * process is to help give the reset sequence a chance to reach the printer * before we break the connection - primarily for printers connected to Datakit. * There's a very slight chance the reset sequence that's sent to the printer * could get us stuck here. Simplest solution is don't bother to send it - * everything works without it. Flushing ttyo would be better, but means yet * another system dependent procedure in ifdef.c! I'll leave things be for now. alarm(0);
/* prevents sleep() loop on V9 systems */ * Used to replace sleep() calls. Only needed if we're running the program as * a read and write process and don't want to have the read process sleep. Most * sleeps are in the code because of the non-blocking read used by the single * process implementation. Probably should be a macro. * Used to replace some of the read() calls. Only needed if we're running * separate read and write processes. Should only be used to replace read calls * on ttyi. Always returns 0 to the caller if the process doesn't have its * READ flag set. Probably should be a macro. * Used to replace some of the write() calls. Again only needed if we're running * separate read and write processes. Should only be used to replace write calls * on ttyo. Always returns n to the caller if the process doesn't have its WRITE * flag set. Should also probably be a macro.