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: src/usr.sbin/lpr/common_source/lp.h,v 1.9.2.12 2002/07/14 23:56:40 gad Exp $ 35 * $DragonFly: src/usr.sbin/lpr/common_source/lp.h,v 1.3 2005/08/08 18:58:56 joerg Exp $ 36 */ 37 38 #include <sys/queue.h> 39 #include <limits.h> 40 #include <time.h> 41 #include <netdb.h> 42 43 /* 44 * All this information used to be in global static variables shared 45 * mysteriously by various parts of the lpr/lpd suite. 46 * This structure attempts to centralize all these declarations in the 47 * hope that they can later be made more dynamic. 48 */ 49 enum lpd_filters { LPF_CIFPLOT, LPF_DVI, LPF_GRAPH, LPF_INPUT, 50 LPF_DITROFF, LPF_OUTPUT, LPF_FORTRAN, LPF_TROFF, 51 LPF_RASTER, LPF_COUNT }; 52 /* NB: there is a table in common.c giving the mapping from capability names */ 53 54 struct printer { 55 char *printer; /* printer name */ 56 int remote; /* true if RM points to a remote host */ 57 int rp_matches_local; /* true if rp has same name as us */ 58 int tof; /* true if we are at top-of-form */ 59 /* ------------------------------------------------------ */ 60 char *acct_file; /* AF: accounting file */ 61 long baud_rate; /* BR: baud rate if lp is a tty */ 62 char *filters[LPF_COUNT]; /* CF, DF, GF, IF, NF, OF, RF, TF, VF */ 63 long conn_timeout; /* CT: TCP connection timeout */ 64 long daemon_user; /* DU: daemon user id -- XXX belongs ???? */ 65 char *form_feed; /* FF: form feed */ 66 long header_last; /* HL: print header last */ 67 char *log_file; /* LF: log file */ 68 char *lock_file; /* LO: lock file */ 69 char *lp; /* LP: device name or network address */ 70 long max_copies; /* MC: maximum number of copies allowed */ 71 long max_blocks; /* MX: maximum number of blocks to copy */ 72 long price100; /* PC: price per 100 units of output */ 73 long page_length; /* PL: page length */ 74 long page_width; /* PW: page width */ 75 long page_pwidth; /* PX: page width in pixels */ 76 long page_plength; /* PY: page length in pixels */ 77 long resend_copies; /* RC: resend copies to remote host */ 78 char *restrict_grp; /* RG: restricted group */ 79 char *remote_host; /* RM: remote machine name */ 80 char *remote_queue; /* RP: remote printer name */ 81 long restricted; /* RS: restricted to those with local accts */ 82 long rw; /* RW: open LP for reading and writing */ 83 long short_banner; /* SB: short banner */ 84 long no_copies; /* SC: suppress multiple copies */ 85 char *spool_dir; /* SD: spool directory */ 86 long no_formfeed; /* SF: suppress FF on each print job */ 87 long no_header; /* SH: suppress header page */ 88 char *stat_recv; /* SR: statistics file, receiving jobs */ 89 char *stat_send; /* SS: statistics file, sending jobs */ 90 char *status_file; /* ST: status file name */ 91 char *trailer; /* TR: trailer string send when Q empties */ 92 char *mode_set; /* MS: mode set, a la stty */ 93 94 /* variables used by trstat*() to keep statistics on file transfers */ 95 #define JOBNUM_SIZE 8 96 char jobnum[JOBNUM_SIZE]; 97 long jobdfnum; /* current datafile number within job */ 98 struct timespec tr_start, tr_done; 99 #define TIMESTR_SIZE 40 /* holds result from LPD_TIMESTAMP_PATTERN */ 100 char tr_timestr[TIMESTR_SIZE]; 101 #define DIFFTIME_TS(endTS,startTS) \ 102 ((double)(endTS.tv_sec - startTS.tv_sec) \ 103 + (endTS.tv_nsec - startTS.tv_nsec) * 1.0e-9) 104 }; 105 106 /* 107 * Lists of user names and job numbers, for the benefit of the structs 108 * defined below. We use TAILQs so that requests don't get mysteriously 109 * reversed in process. 110 */ 111 struct req_user { 112 TAILQ_ENTRY(req_user) ru_link; /* macro glue */ 113 char ru_uname[1]; /* name of user */ 114 }; 115 TAILQ_HEAD(req_user_head, req_user); 116 117 struct req_file { 118 TAILQ_ENTRY(req_file) rf_link; /* macro glue */ 119 char rf_type; /* type (lowercase cf file letter) of file */ 120 char *rf_prettyname; /* user-visible name of file */ 121 char rf_fname[1]; /* name of file */ 122 }; 123 TAILQ_HEAD(req_file_head, req_file); 124 125 struct req_jobid { 126 TAILQ_ENTRY(req_jobid) rj_link; /* macro glue */ 127 int rj_job; /* job number */ 128 }; 129 TAILQ_HEAD(req_jobid_head, req_jobid); 130 131 /* 132 * Encapsulate all the information relevant to a request in the 133 * lpr/lpd protocol. 134 */ 135 enum req_type { REQ_START, REQ_RECVJOB, REQ_LIST, REQ_DELETE }; 136 137 struct request { 138 enum req_type type; /* what sort of request is this? */ 139 struct printer prtr; /* which printer is it for? */ 140 int remote; /* did request arrive over network? */ 141 char *logname; /* login name of requesting user */ 142 char *authname; /* authenticated identity of requesting user */ 143 char *prettyname; /* ``pretty'' name of requesting user */ 144 int privileged; /* was the request from a privileged user? */ 145 void *authinfo; /* authentication information */ 146 int authentic; /* was the request securely authenticated? */ 147 148 /* Information for queries and deletes... */ 149 int nusers; /* length of following list... */ 150 struct req_user_head users; /* list of users to query/delete */ 151 int njobids; /* length of following list... */ 152 struct req_jobid_head jobids; /* list of jobids to query/delete */ 153 }; 154 155 /* 156 * Global definitions for the line printer system. 157 */ 158 extern char line[BUFSIZ]; 159 extern const char *progname; /* program name (lpr, lpq, etc) */ 160 161 /* 162 * 'local_host' is the name of the machine that lpd (lpr, whatever) 163 * is actually running on. 164 * 165 * 'from_host' will point to the 'host' variable when receiving a job 166 * from a user on the same host, or "somewhere else" when receiving a 167 * job from a remote host. If 'from_host != local_host', then 'from_ip' 168 * is the character representation of the IP address of from_host (note 169 * that string could be an IPv6 address). 170 * 171 * Also note that when 'from_host' is not pointing at 'local_host', the 172 * string it is pointing at may be as long as NI_MAXHOST (which is very 173 * likely to be much longer than MAXHOSTNAMELEN). 174 */ 175 extern char local_host[MAXHOSTNAMELEN]; 176 extern const char *from_host; /* client's machine name */ 177 extern const char *from_ip; /* client machine's IP address */ 178 179 extern int requ[]; /* job number of spool entries */ 180 extern int requests; /* # of spool requests */ 181 extern char *user[]; /* users to process */ 182 extern int users; /* # of users in user array */ 183 extern char *person; /* name of person doing lprm */ 184 extern u_char family; /* address family */ 185 186 /* 187 * Structure used for building a sorted list of control files. 188 * The job_processed value can be used by callers of getq(), to keep 189 * track of whatever processing they are doing. 190 */ 191 struct jobqueue { 192 time_t job_time; /* last-mod time of cf-file */ 193 int job_matched; /* used by match_jobspec() */ 194 int job_processed; /* set to zero by getq() */ 195 char job_cfname[NAME_MAX+1]; /* control file name */ 196 }; 197 198 /* lpr/lpd generates readable timestamps for logfiles, etc. Have all those 199 * timestamps be in the same format wrt strftime(). This is ISO 8601 format, 200 * with the addition of an easy-readable day-of-the-week field. Note that 201 * '%T' = '%H:%M:%S', and that '%z' is not available on all platforms. 202 */ 203 #define LPD_TIMESTAMP_PATTERN "%Y-%m-%dT%T%z %a" 204 205 /* 206 * Codes to indicate which statistic records trstat_write should write. 207 */ 208 typedef enum { TR_SENDING, TR_RECVING, TR_PRINTING } tr_sendrecv; 209 210 /* 211 * Error codes for our mini printcap library. 212 */ 213 #define PCAPERR_TCLOOP (-3) 214 #define PCAPERR_OSERR (-2) 215 #define PCAPERR_NOTFOUND (-1) 216 #define PCAPERR_SUCCESS 0 217 #define PCAPERR_TCOPEN 1 218 219 /* 220 * File modes for the various status files maintained by lpd. 221 */ 222 #define LOCK_FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH) 223 #define LFM_PRINT_DIS (S_IXUSR) 224 #define LFM_QUEUE_DIS (S_IXGRP) 225 #define LFM_RESET_QUE (S_IXOTH) 226 227 #define STAT_FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH) 228 #define LOG_FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH) 229 #define TEMP_FILE_MODE (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH) 230 231 /* 232 * Bit-flags for set_qstate() actions, followed by the return values. 233 */ 234 #define SQS_DISABLEQ 0x01 /* Disable the queuing of new jobs */ 235 #define SQS_STOPP 0x02 /* Stop the printing of jobs */ 236 #define SQS_ENABLEQ 0x10 /* Enable the queuing of new jobs */ 237 #define SQS_STARTP 0x20 /* Start the printing of jobs */ 238 #define SQS_QCHANGED 0x80 /* The queue has changed (new jobs, etc) */ 239 240 #define SQS_PARMERR -9 /* Invalid parameters from caller */ 241 #define SQS_CREFAIL -3 /* File did not exist, and create failed */ 242 #define SQS_CHGFAIL -2 /* File exists, but unable to change state */ 243 #define SQS_STATFAIL -1 /* Unable to stat() the lock file */ 244 #define SQS_CHGOK 1 /* File existed, and the state was changed */ 245 #define SQS_CREOK 2 /* File did not exist, but was created OK */ 246 #define SQS_SKIPCREOK 3 /* File did not exist, and there was */ 247 /* no need to create it */ 248 249 /* 250 * Command codes used in the protocol. 251 */ 252 #define CMD_CHECK_QUE '\1' 253 #define CMD_TAKE_THIS '\2' 254 #define CMD_SHOWQ_SHORT '\3' 255 #define CMD_SHOWQ_LONG '\4' 256 #define CMD_RMJOB '\5' 257 258 #include <sys/cdefs.h> 259 260 __BEGIN_DECLS 261 struct dirent; 262 263 void blankfill(int _tocol); 264 char *checkremote(struct printer *_pp); 265 int chk(char *_file); 266 void closeallfds(int _start); 267 void delay(int _millisec); 268 void displayq(struct printer *_pp, int _format); 269 void dump(const char *_nfile, const char *_datafile, int _copies); 270 void fatal(const struct printer *_pp, const char *_msg, ...) 271 __printflike(2, 3); 272 int firstprinter(struct printer *_pp, int *_error); 273 void free_printer(struct printer *_pp); 274 void free_request(struct request *_rp); 275 int getline(FILE *_cfp); 276 int getport(const struct printer *_pp, const char *_rhost, int _rport); 277 int getprintcap(const char *_printer, struct printer *_pp); 278 int getq(const struct printer *_pp, struct jobqueue *(*_namelist[])); 279 void header(void); 280 void inform(const struct printer *_pp, char *_cf); 281 void init_printer(struct printer *_pp); 282 void init_request(struct request *_rp); 283 int inlist(char *_uname, char *_cfile); 284 int iscf(struct dirent *_d); 285 int isowner(char *_owner, char *_file); 286 void ldump(const char *_nfile, const char *_datafile, int _copies); 287 void lastprinter(void); 288 int lockchk(struct printer *_pp, char *_slockf); 289 char *lock_file_name(const struct printer *_pp, char *_buf, size_t _len); 290 void lpd_gettime(struct timespec *_tsp, char *_strp, size_t _strsize); 291 int nextprinter(struct printer *_pp, int *_error); 292 const 293 char *pcaperr(int _error); 294 void prank(int _n); 295 void process(const struct printer *_pp, char *_file); 296 void rmjob(const char *_printer); 297 void rmremote(const struct printer *_pp); 298 void setprintcap(char *_newfile); 299 int set_qstate(int _action, const char *_lfname); 300 void show(const char *_nfile, const char *_datafile, int _copies); 301 int startdaemon(const struct printer *_pp); 302 char *status_file_name(const struct printer *_pp, char *_buf, 303 size_t _len); 304 void trstat_init(struct printer *_pp, const char *_fname, int _filenum); 305 void trstat_write(struct printer *_pp, tr_sendrecv _sendrecv, 306 size_t _bytecnt, const char *_userid, const char *_otherhost, 307 const char *_orighost); 308 ssize_t writel(int _strm, ...); 309 __END_DECLS 310