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