xref: /freebsd/usr.sbin/lpr/common_source/printcap.c (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1 /*
2  * Copyright (c) 1983, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  * 	From: @(#)common.c	8.5 (Berkeley) 4/28/95
39  */
40 
41 #ifndef lint
42 static const char rcsid[] =
43   "$FreeBSD$";
44 #endif /* not lint */
45 
46 #include <errno.h>
47 #include <stdio.h>
48 #include <stdlib.h>
49 #include <string.h>
50 #include <unistd.h>
51 
52 #include <sys/param.h>		/* required for lp.h, but not used here */
53 #include <sys/dirent.h>		/* ditto */
54 #include "lp.h"
55 #include "lp.local.h"
56 #include "pathnames.h"
57 
58 /*
59  * Routines and data used in processing the printcap file.
60  */
61 static 	char *printcapdb[2] = { _PATH_PRINTCAP, 0 }; /* list for cget* */
62 
63 static	char *capdb_canonical_name(const char *);
64 static	int capdb_getaltlog(char *, const char *, const char *);
65 static	int capdb_getaltnum(char *, const char *, const char *, long, long *);
66 static	int capdb_getaltstr(char *, const char *, const char *, const char *,
67 			    char **);
68 static	int getprintcap_int(char *bp, struct printer *pp);
69 
70 /*
71  * Change the name of the printcap file.  Used by chkprintcap(8),
72  * but could be used by other members of the suite with appropriate
73  * security measures.
74  */
75 void
76 setprintcap(char *newfile)
77 {
78 	printcapdb[0] = newfile;
79 }
80 
81 /*
82  * Read the printcap database for printer `printer' into the
83  * struct printer pointed by `pp'.  Return values are as for
84  * cgetent(3): -1 means we could not find what we wanted, -2
85  * means a system error occurred (and errno is set), -3 if a
86  * reference (`tc=') loop was detected, and 0 means success.
87  *
88  * Copied from lpr; should add additional capabilities as they
89  * are required by the other programs in the suite so that
90  * printcap-reading is consistent across the entire family.
91  */
92 int
93 getprintcap(const char *printer, struct printer *pp)
94 {
95 	int status;
96 	char *XXX;
97 	char *bp;
98 
99 	/*
100 	 * A bug in the declaration of cgetent(3) means that we have
101 	 * to hide the constness of its third argument.
102 	 */
103 	XXX = (char *)printer;
104 	if ((status = cgetent(&bp, printcapdb, XXX)) < 0)
105 		return status;
106 	status = getprintcap_int(bp, pp);
107 	free(bp);
108 	return status;
109 }
110 
111 /*
112  * Map the status values returned by cgetfirst/cgetnext into those
113  * used by cgetent, returning truth if there are more records to
114  * examine.  This points out what is arguably a bug in the cget*
115  * interface (or at least a nasty wart).
116  */
117 static int
118 firstnextmap(int *status)
119 {
120 	switch (*status) {
121 	case 0:
122 		return 0;
123 	case 1:
124 		*status = 0;
125 		return 1;
126 	case 2:
127 		*status = 1;
128 		return 1;
129 	case -1:
130 		*status = -2;
131 		return 0;
132 	case -2:
133 		*status = -3;
134 		return 1;
135 	default:
136 		return 0;
137 	}
138 }
139 
140 /*
141  * Scan through the database of printers using cgetfirst/cgetnext.
142  * Return false of error or end-of-database; else true.
143  */
144 int
145 firstprinter(struct printer *pp, int *error)
146 {
147 	int status;
148 	char *bp;
149 
150 	init_printer(pp);
151 	status = cgetfirst(&bp, printcapdb);
152 	if (firstnextmap(&status) == 0) {
153 		if (error)
154 			*error = status;
155 		return 0;
156 	}
157 	if (error)
158 		*error = status;
159 	status = getprintcap_int(bp, pp);
160 	free(bp);
161 	if (error && status)
162 		*error = status;
163 	return 1;
164 }
165 
166 int
167 nextprinter(struct printer *pp, int *error)
168 {
169 	int status;
170 	char *bp;
171 
172 	free_printer(pp);
173 	status = cgetnext(&bp, printcapdb);
174 	if (firstnextmap(&status) == 0) {
175 		if (error)
176 			*error = status;
177 		return 0;
178 	}
179 	if (error)
180 		*error = status;
181 	status = getprintcap_int(bp, pp);
182 	free(bp);
183 	if (error && status)
184 		*error = status;
185 	return 1;
186 }
187 
188 void
189 lastprinter(void)
190 {
191 	cgetclose();
192 }
193 
194 /*
195  * This must match the order of declaration of enum filter in lp.h.
196  */
197 static const char *filters[] = {
198 	"cf", "df", "gf", "if", "nf", "of", "rf", "tf", "vf"
199 };
200 
201 static const char *longfilters[] = {
202 	"filt.cifplot", "filt.dvi", "filt.plot", "filt.input", "filt.ditroff",
203 	"filt.output", "filt.fortran", "filt.troff", "filt.raster"
204 };
205 
206 /*
207  * Internal routine for both getprintcap() and nextprinter().
208  * Actually parse the printcap entry using cget* functions.
209  * Also attempt to figure out the canonical name of the printer
210  * and store a malloced copy of it in pp->printer.
211  */
212 static int
213 getprintcap_int(bp, pp)
214 	char *bp;
215 	struct printer *pp;
216 {
217 	enum lpd_filters filt;
218 	char *rp_name;
219 	int error;
220 
221 	if ((pp->printer = capdb_canonical_name(bp)) == 0)
222 		return PCAPERR_OSERR;
223 
224 #define CHK(x) do {if ((x) == PCAPERR_OSERR) return PCAPERR_OSERR;}while(0)
225 	CHK(capdb_getaltstr(bp, "af", "acct.file", 0, &pp->acct_file));
226 	CHK(capdb_getaltnum(bp, "br", "tty.rate", 0, &pp->baud_rate));
227 	CHK(capdb_getaltnum(bp, "ct", "remote.timeout", DEFTIMEOUT,
228 			    &pp->conn_timeout));
229 	CHK(capdb_getaltnum(bp, "du", "daemon.user", DEFUID,
230 			    &pp->daemon_user));
231 	CHK(capdb_getaltstr(bp, "ff", "job.formfeed", DEFFF, &pp->form_feed));
232 	CHK(capdb_getaltstr(bp, "lf", "spool.log", _PATH_CONSOLE,
233 			    &pp->log_file));
234 	CHK(capdb_getaltstr(bp, "lo", "spool.lock", DEFLOCK, &pp->lock_file));
235 	CHK(capdb_getaltstr(bp, "lp", "tty.device", _PATH_DEFDEVLP, &pp->lp));
236 	CHK(capdb_getaltnum(bp, "mc", "max.copies", DEFMAXCOPIES,
237 			    &pp->max_copies));
238 	CHK(capdb_getaltstr(bp, "ms", "tty.mode", 0, &pp->mode_set));
239 	CHK(capdb_getaltnum(bp, "mx", "max.blocks", DEFMX, &pp->max_blocks));
240 	CHK(capdb_getaltnum(bp, "pc", "acct.price", 0, &pp->price100));
241 	CHK(capdb_getaltnum(bp, "pl", "page.length", DEFLENGTH,
242 			    &pp->page_length));
243 	CHK(capdb_getaltnum(bp, "pw", "page.width", DEFWIDTH,
244 			    &pp->page_width));
245 	CHK(capdb_getaltnum(bp, "px", "page.pwidth", 0, &pp->page_pwidth));
246 	CHK(capdb_getaltnum(bp, "py", "page.plength", 0, &pp->page_plength));
247 	CHK(capdb_getaltstr(bp, "rg", "daemon.restrictgrp", 0,
248 			    &pp->restrict_grp));
249 	CHK(capdb_getaltstr(bp, "rm", "remote.host", 0, &pp->remote_host));
250 	CHK(capdb_getaltstr(bp, "rp", "remote.queue", DEFLP,
251 			    &pp->remote_queue));
252 	CHK(capdb_getaltstr(bp, "sd", "spool.dir", _PATH_DEFSPOOL,
253 			    &pp->spool_dir));
254 	CHK(capdb_getaltstr(bp, "st", "spool.status", DEFSTAT,
255 			    &pp->status_file));
256 	CHK(capdb_getaltstr(bp, "tr", "job.trailer", 0, &pp->trailer));
257 
258 	pp->restricted = capdb_getaltlog(bp, "rs", "daemon.restricted");
259 	pp->short_banner = capdb_getaltlog(bp, "sb", "banner.short");
260 	pp->no_copies = capdb_getaltlog(bp, "sc", "job.no_copies");
261 	pp->no_formfeed = capdb_getaltlog(bp, "sf", "job.no_formfeed");
262 	pp->no_header = capdb_getaltlog(bp, "sh", "banner.disable");
263 	pp->header_last = capdb_getaltlog(bp, "hl", "banner.last");
264 	pp->rw = capdb_getaltlog(bp, "rw", "tty.rw");
265 	pp->tof = !capdb_getaltlog(bp, "fo", "job.topofform");
266 
267 	/*
268 	 * Decide if the remote printer name matches the local printer name.
269 	 * If no name is given then we assume they mean them to match.
270 	 * If a name is given see if the rp_name is one of the names for
271 	 * this printer.
272 	 */
273 	pp->rp_matches_local = 1;
274 	CHK((error = capdb_getaltstr(bp, "rp", "remote.queue", 0, &rp_name)));
275 	if (error != PCAPERR_NOTFOUND && rp_name != NULL) {
276 		if (cgetmatch(bp,rp_name) != 0)
277 			pp->rp_matches_local = 0;
278 		free(rp_name);
279 	}
280 
281 	/*
282 	 * Filters:
283 	 */
284 	for (filt = 0; filt < LPF_COUNT; filt++) {
285 		CHK(capdb_getaltstr(bp, filters[filt], longfilters[filt], 0,
286 				    &pp->filters[filt]));
287 	}
288 
289 	return 0;
290 }
291 
292 /*
293  * Decode the error codes returned by cgetent() using the names we
294  * made up for them from "lp.h".
295  * This would have been much better done with Common Error, >sigh<.
296  * Perhaps this can be fixed in the next incarnation of cget*.
297  */
298 const char *
299 pcaperr(int error)
300 {
301 	switch(error) {
302 	case PCAPERR_TCOPEN:
303 		return "unresolved tc= expansion";
304 	case PCAPERR_SUCCESS:
305 		return "no error";
306 	case PCAPERR_NOTFOUND:
307 		return "printer not found";
308 	case PCAPERR_OSERR:
309 		return strerror(errno);
310 	case PCAPERR_TCLOOP:
311 		return "loop detected in tc= expansion";
312 	default:
313 		return "unknown printcap error";
314 	}
315 }
316 
317 /*
318  * Initialize a `struct printer' to contain values harmless to
319  * the other routines in liblpr.
320  */
321 void
322 init_printer(struct printer *pp)
323 {
324 	static struct printer zero;
325 	*pp = zero;
326 }
327 
328 /*
329  * Free the dynamically-allocated strings in a `struct printer'.
330  * Idempotent.
331  */
332 void
333 free_printer(struct printer *pp)
334 {
335 	enum lpd_filters filt;
336 #define	cfree(x)	do { if (x) free(x); } while(0)
337 	cfree(pp->printer);
338 	cfree(pp->acct_file);
339 	for (filt = 0; filt < LPF_COUNT; filt++)
340 		cfree(pp->filters[filt]);
341 	cfree(pp->form_feed);
342 	cfree(pp->log_file);
343 	cfree(pp->lock_file);
344 	cfree(pp->lp);
345 	cfree(pp->restrict_grp);
346 	cfree(pp->remote_host);
347 	cfree(pp->remote_queue);
348 	cfree(pp->spool_dir);
349 	cfree(pp->status_file);
350 	cfree(pp->trailer);
351 	cfree(pp->mode_set);
352 
353 	init_printer(pp);
354 }
355 
356 
357 /*
358  * The following routines are part of what would be a sensible library
359  * interface to capability databases.  Maybe someday this will become
360  * the default.
361  */
362 
363 /*
364  * It provides similar functionality to cgetstr(),
365  * except that it provides for both a long and a short
366  * capability name and allows for a default to be specified.
367  */
368 static int
369 capdb_getaltstr(char *bp, const char *shrt, const char *lng,
370 		const char *dflt, char **result)
371 {
372 	int status;
373 
374 	status = cgetstr(bp, (char *)/*XXX*/lng, result);
375 	if (status >= 0 || status == PCAPERR_OSERR)
376 		return status;
377 	status = cgetstr(bp, (char *)/*XXX*/shrt, result);
378 	if (status >= 0 || status == PCAPERR_OSERR)
379 		return status;
380 	if (dflt) {
381 		*result = strdup(dflt);
382 		if (*result == 0)
383 			return PCAPERR_OSERR;
384 		return strlen(*result);
385 	}
386 	return PCAPERR_NOTFOUND;
387 }
388 
389 /*
390  * The same, only for integers.
391  */
392 static int
393 capdb_getaltnum(char *bp, const char *shrt, const char *lng, long dflt,
394 		long *result)
395 {
396 	int status;
397 
398 	status = cgetnum(bp, (char *)/*XXX*/lng, result);
399 	if (status >= 0)
400 		return status;
401 	status = cgetnum(bp, (char *)/*XXX*/shrt, result);
402 	if (status >= 0)
403 		return status;
404 	*result = dflt;
405 	return 0;
406 }
407 
408 /*
409  * Likewise for logical values.  There's no need for a default parameter
410  * because the default is always false.
411  */
412 static int
413 capdb_getaltlog(char *bp, const char *shrt, const char *lng)
414 {
415 	if (cgetcap(bp, (char *)/*XXX*/lng, ':'))
416 		return 1;
417 	if (cgetcap(bp, (char *)/*XXX*/shrt, ':'))
418 		return 1;
419 	return 0;
420 }
421 
422 /*
423  * Also should be a part of a better cget* library.
424  * Given a capdb entry, attempt to figure out what its canonical name
425  * is, and return a malloced copy of it.  The canonical name is
426  * considered to be the first one listed.
427  */
428 static char *
429 capdb_canonical_name(const char *bp)
430 {
431 	char *retval;
432 	const char *nameend;
433 
434 	nameend = strpbrk(bp, "|:");
435 	if (nameend == 0)
436 		nameend = bp + 1;
437 	if ((retval = malloc(nameend - bp + 1)) != 0) {
438 		retval[0] = '\0';
439 		strncat(retval, bp, nameend - bp);
440 	}
441 	return retval;
442 }
443 
444 
445