lp.h revision 79739
1/* 2 * Copyright (c) 1983, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * From: @(#)lp.h 8.2 (Berkeley) 4/28/95 34 * $FreeBSD: head/usr.sbin/lpr/common_source/lp.h 79739 2001-07-15 00:09:46Z gad $ 35 */ 36 37#include <sys/queue.h> 38#include <time.h> 39#include <netdb.h> 40 41/* 42 * All this information used to be in global static variables shared 43 * mysteriously by various parts of the lpr/lpd suite. 44 * This structure attempts to centralize all these declarations in the 45 * hope that they can later be made more dynamic. 46 */ 47enum lpd_filters { LPF_CIFPLOT, LPF_DVI, LPF_GRAPH, LPF_INPUT, 48 LPF_DITROFF, LPF_OUTPUT, LPF_FORTRAN, LPF_TROFF, 49 LPF_RASTER, LPF_COUNT }; 50/* NB: there is a table in common.c giving the mapping from capability names */ 51 52struct printer { 53 char *printer; /* printer name */ 54 int remote; /* true if RM points to a remote host */ 55 int rp_matches_local; /* true if rp has same name as us */ 56 int tof; /* true if we are at top-of-form */ 57 /* ------------------------------------------------------ */ 58 char *acct_file; /* AF: accounting file */ 59 long baud_rate; /* BR: baud rate if lp is a tty */ 60 char *filters[LPF_COUNT]; /* CF, DF, GF, IF, NF, OF, RF, TF, VF */ 61 long conn_timeout; /* CT: TCP connection timeout */ 62 long daemon_user; /* DU: daemon user id -- XXX belongs ???? */ 63 char *form_feed; /* FF: form feed */ 64 long header_last; /* HL: print header last */ 65 char *log_file; /* LF: log file */ 66 char *lock_file; /* LO: lock file */ 67 char *lp; /* LP: device name or network address */ 68 long max_copies; /* MC: maximum number of copies allowed */ 69 long max_blocks; /* MX: maximum number of blocks to copy */ 70 long price100; /* PC: price per 100 units of output */ 71 long page_length; /* PL: page length */ 72 long page_width; /* PW: page width */ 73 long page_pwidth; /* PX: page width in pixels */ 74 long page_plength; /* PY: page length in pixels */ 75 char *restrict_grp; /* RG: restricted group */ 76 char *remote_host; /* RM: remote machine name */ 77 char *remote_queue; /* RP: remote printer name */ 78 long restricted; /* RS: restricted to those with local accts */ 79 long rw; /* RW: open LP for reading and writing */ 80 long short_banner; /* SB: short banner */ 81 long no_copies; /* SC: suppress multiple copies */ 82 char *spool_dir; /* SD: spool directory */ 83 long no_formfeed; /* SF: suppress FF on each print job */ 84 long no_header; /* SH: suppress header page */ 85 char *stat_recv; /* SR: statistics file, receiving jobs */ 86 char *stat_send; /* SS: statistics file, sending jobs */ 87 char *status_file; /* ST: status file name */ 88 char *trailer; /* TR: trailer string send when Q empties */ 89 char *mode_set; /* MS: mode set, a la stty */ 90 91 /* variables used by trstat*() to keep statistics on file transfers */ 92#define JOBNUM_SIZE 8 93 char jobnum[JOBNUM_SIZE]; 94 long jobdfnum; /* current datafile number within job */ 95 struct timespec tr_start, tr_done; 96#define TIMESTR_SIZE 40 /* holds result from LPD_TIMESTAMP_PATTERN */ 97 char tr_timestr[TIMESTR_SIZE]; 98#define DIFFTIME_TS(endTS,startTS) \ 99 ((double)(endTS.tv_sec - startTS.tv_sec) \ 100 + (endTS.tv_nsec - startTS.tv_nsec) * 1.0e-9) 101}; 102 103/* 104 * Lists of user names and job numbers, for the benefit of the structs 105 * defined below. We use TAILQs so that requests don't get mysteriously 106 * reversed in process. 107 */ 108struct req_user { 109 TAILQ_ENTRY(req_user) ru_link; /* macro glue */ 110 char ru_uname[1]; /* name of user */ 111}; 112TAILQ_HEAD(req_user_head, req_user); 113 114struct req_file { 115 TAILQ_ENTRY(req_file) rf_link; /* macro glue */ 116 char rf_type; /* type (lowercase cf file letter) of file */ 117 char *rf_prettyname; /* user-visible name of file */ 118 char rf_fname[1]; /* name of file */ 119}; 120TAILQ_HEAD(req_file_head, req_file); 121 122struct req_jobid { 123 TAILQ_ENTRY(req_jobid) rj_link; /* macro glue */ 124 int rj_job; /* job number */ 125}; 126TAILQ_HEAD(req_jobid_head, req_jobid); 127 128/* 129 * Encapsulate all the information relevant to a request in the 130 * lpr/lpd protocol. 131 */ 132enum req_type { REQ_START, REQ_RECVJOB, REQ_LIST, REQ_DELETE }; 133 134struct request { 135 enum req_type type; /* what sort of request is this? */ 136 struct printer prtr; /* which printer is it for? */ 137 int remote; /* did request arrive over network? */ 138 char *logname; /* login name of requesting user */ 139 char *authname; /* authenticated identity of requesting user */ 140 char *prettyname; /* ``pretty'' name of requesting user */ 141 int privileged; /* was the request from a privileged user? */ 142 void *authinfo; /* authentication information */ 143 int authentic; /* was the request securely authenticated? */ 144 145 /* Information for queries and deletes... */ 146 int nusers; /* length of following list... */ 147 struct req_user_head users; /* list of users to query/delete */ 148 int njobids; /* length of following list... */ 149 struct req_jobid_head jobids; /* list of jobids to query/delete */ 150}; 151 152/* 153 * Global definitions for the line printer system. 154 */ 155extern char line[BUFSIZ]; 156extern const char *progname; /* program name (lpr, lpq, etc) */ 157 158 /* 159 * 'local_host' is the name of the machine that lpd (lpr, whatever) 160 * is actually running on. 161 * 162 * 'from_host' will point to the 'host' variable when receiving a job 163 * from a user on the same host, or "somewhere else" when receiving a 164 * job from a remote host. If 'from_host != local_host', then 'from_ip' 165 * is the character representation of the IP address of from_host (note 166 * that string could be an IPv6 address). 167 * 168 * Also note that when 'from_host' is not pointing at 'local_host', the 169 * string it is pointing at may be as long as NI_MAXHOST (which is very 170 * likely to be much longer than MAXHOSTNAMELEN). 171 */ 172extern char local_host[MAXHOSTNAMELEN]; 173extern const char *from_host; /* client's machine name */ 174extern const char *from_ip; /* client machine's IP address */ 175 176extern int requ[]; /* job number of spool entries */ 177extern int requests; /* # of spool requests */ 178extern char *user[]; /* users to process */ 179extern int users; /* # of users in user array */ 180extern char *person; /* name of person doing lprm */ 181extern u_char family; /* address family */ 182 183/* 184 * Structure used for building a sorted list of control files. 185 */ 186struct jobqueue { 187 time_t job_time; /* last-mod time of cf-file */ 188 char job_cfname[MAXNAMLEN+1]; /* control file name */ 189}; 190 191/* lpr/lpd generates readable timestamps for logfiles, etc. Have all those 192 * timestamps be in the same format wrt strftime(). This is ISO 8601 format, 193 * with the addition of an easy-readable day-of-the-week field. Note that 194 * '%T' = '%H:%M:%S', and that '%z' is not available on all platforms. 195 */ 196#define LPD_TIMESTAMP_PATTERN "%Y-%m-%dT%T%z %a" 197 198/* 199 * Codes to indicate which statistic records trstat_write should write. 200 */ 201typedef enum { TR_SENDING, TR_RECVING, TR_PRINTING } tr_sendrecv; 202 203/* 204 * Error codes for our mini printcap library. 205 */ 206#define PCAPERR_TCLOOP (-3) 207#define PCAPERR_OSERR (-2) 208#define PCAPERR_NOTFOUND (-1) 209#define PCAPERR_SUCCESS 0 210#define PCAPERR_TCOPEN 1 211 212/* 213 * File modes for the various status files maintained by lpd. 214 */ 215#define LOCK_FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH) 216#define LFM_PRINT_DIS (S_IXUSR) 217#define LFM_QUEUE_DIS (S_IXGRP) 218#define LFM_RESET_QUE (S_IXOTH) 219 220#define STAT_FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH) 221#define LOG_FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH) 222#define TEMP_FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH) 223 224/* 225 * Command codes used in the protocol. 226 */ 227#define CMD_CHECK_QUE '\1' 228#define CMD_TAKE_THIS '\2' 229#define CMD_SHOWQ_SHORT '\3' 230#define CMD_SHOWQ_LONG '\4' 231#define CMD_RMJOB '\5' 232 233#include <sys/cdefs.h> 234 235__BEGIN_DECLS 236struct dirent; 237 238void blankfill(int _tocol); 239char *checkremote(struct printer *_pp); 240int chk(char *_file); 241void closeallfds(int _start); 242void delay(int _millisec); 243void displayq(struct printer *_pp, int _format); 244void dump(const char *_nfile, const char *_datafile, int _copies); 245void fatal(const struct printer *_pp, const char *_msg, ...) 246 __printflike(2, 3); 247int firstprinter(struct printer *_pp, int *_error); 248void free_printer(struct printer *_pp); 249void free_request(struct request *_rp); 250int getline(FILE *_cfp); 251int getport(const struct printer *_pp, const char *_rhost, int _rport); 252int getprintcap(const char *_printer, struct printer *_pp); 253int getq(const struct printer *_pp, struct jobqueue *(*_namelist[])); 254void header(void); 255void inform(const struct printer *_pp, char *_cf); 256void init_printer(struct printer *_pp); 257void init_request(struct request *_rp); 258int inlist(char *_uname, char *_cfile); 259int iscf(struct dirent *_d); 260int isowner(char *_owner, char *_file); 261void ldump(const char *_nfile, const char *_datafile, int _copies); 262void lastprinter(void); 263int lockchk(struct printer *_pp, char *_slockf); 264char *lock_file_name(const struct printer *_pp, char *_buf, size_t _len); 265void lpd_gettime(struct timespec *_tsp, char *_strp, int _strsize); 266int nextprinter(struct printer *_pp, int *_error); 267const 268char *pcaperr(int _error); 269void prank(int _n); 270void process(const struct printer *_pp, char *_file); 271void rmjob(const char *_printer); 272void rmremote(const struct printer *_pp); 273void setprintcap(char *_newfile); 274void show(const char *_nfile, const char *_datafile, int _copies); 275int startdaemon(const struct printer *_pp); 276char *status_file_name(const struct printer *_pp, char *_buf, 277 size_t _len); 278void trstat_init(struct printer *_pp, const char *_fname, int _filenum); 279void trstat_write(struct printer *_pp, tr_sendrecv _sendrecv, 280 size_t _bytecnt, const char *_userid, const char *_otherhost, 281 const char *_orighost); 282ssize_t writel(int _strm, ...); 283__END_DECLS 284