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