xref: /freebsd/usr.sbin/lpr/common_source/printcap.c (revision ae83180158c4c937f170e31eff311b18c0286a93)
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 *_bp);
64 static int	 capdb_getaltlog(char *_bp, const char *_shrt,
65 		    const char *_lng);
66 static int	 capdb_getaltnum(char *_bp, const char *_shrt,
67 		    const char *_lng, long _dflt, long *_result);
68 static int	 capdb_getaltstr(char *_bp, const char *_shrt,
69 		    const char *lng, const char *_dflt, char **_result);
70 static int	 getprintcap_int(char *_bp, struct printer *_pp);
71 
72 /*
73  * Change the name of the printcap file.  Used by chkprintcap(8),
74  * but could be used by other members of the suite with appropriate
75  * security measures.
76  */
77 void
78 setprintcap(char *newfile)
79 {
80 	printcapdb[0] = newfile;
81 }
82 
83 /*
84  * Read the printcap database for printer `printer' into the
85  * struct printer pointed by `pp'.  Return values are as for
86  * cgetent(3): -1 means we could not find what we wanted, -2
87  * means a system error occurred (and errno is set), -3 if a
88  * reference (`tc=') loop was detected, and 0 means success.
89  *
90  * Copied from lpr; should add additional capabilities as they
91  * are required by the other programs in the suite so that
92  * printcap-reading is consistent across the entire family.
93  */
94 int
95 getprintcap(const char *printer, struct printer *pp)
96 {
97 	int status;
98 	char *XXX;
99 	char *bp;
100 
101 	/*
102 	 * A bug in the declaration of cgetent(3) means that we have
103 	 * to hide the constness of its third argument.
104 	 */
105 	XXX = (char *)printer;
106 	if ((status = cgetent(&bp, printcapdb, XXX)) < 0)
107 		return status;
108 	status = getprintcap_int(bp, pp);
109 	free(bp);
110 	return status;
111 }
112 
113 /*
114  * Map the status values returned by cgetfirst/cgetnext into those
115  * used by cgetent, returning truth if there are more records to
116  * examine.  This points out what is arguably a bug in the cget*
117  * interface (or at least a nasty wart).
118  */
119 static int
120 firstnextmap(int *status)
121 {
122 	switch (*status) {
123 	case 0:
124 		return 0;
125 	case 1:
126 		*status = 0;
127 		return 1;
128 	case 2:
129 		*status = 1;
130 		return 1;
131 	case -1:
132 		*status = -2;
133 		return 0;
134 	case -2:
135 		*status = -3;
136 		return 1;
137 	default:
138 		return 0;
139 	}
140 }
141 
142 /*
143  * Scan through the database of printers using cgetfirst/cgetnext.
144  * Return false of error or end-of-database; else true.
145  */
146 int
147 firstprinter(struct printer *pp, int *error)
148 {
149 	int status;
150 	char *bp;
151 
152 	init_printer(pp);
153 	status = cgetfirst(&bp, printcapdb);
154 	if (firstnextmap(&status) == 0) {
155 		if (error)
156 			*error = status;
157 		return 0;
158 	}
159 	if (error)
160 		*error = status;
161 	status = getprintcap_int(bp, pp);
162 	free(bp);
163 	if (error && status)
164 		*error = status;
165 	return 1;
166 }
167 
168 int
169 nextprinter(struct printer *pp, int *error)
170 {
171 	int status;
172 	char *bp;
173 
174 	free_printer(pp);
175 	status = cgetnext(&bp, printcapdb);
176 	if (firstnextmap(&status) == 0) {
177 		if (error)
178 			*error = status;
179 		return 0;
180 	}
181 	if (error)
182 		*error = status;
183 	status = getprintcap_int(bp, pp);
184 	free(bp);
185 	if (error && status)
186 		*error = status;
187 	return 1;
188 }
189 
190 void
191 lastprinter(void)
192 {
193 	cgetclose();
194 }
195 
196 /*
197  * This must match the order of declaration of enum filter in lp.h.
198  */
199 static const char *filters[] = {
200 	"cf", "df", "gf", "if", "nf", "of", "rf", "tf", "vf"
201 };
202 
203 static const char *longfilters[] = {
204 	"filt.cifplot", "filt.dvi", "filt.plot", "filt.input", "filt.ditroff",
205 	"filt.output", "filt.fortran", "filt.troff", "filt.raster"
206 };
207 
208 /*
209  * Internal routine for both getprintcap() and nextprinter().
210  * Actually parse the printcap entry using cget* functions.
211  * Also attempt to figure out the canonical name of the printer
212  * and store a malloced copy of it in pp->printer.
213  */
214 static int
215 getprintcap_int(char *bp, 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, "sr", "stat.recv", 0, &pp->stat_recv));
255 	CHK(capdb_getaltstr(bp, "ss", "stat.send", 0, &pp->stat_send));
256 	CHK(capdb_getaltstr(bp, "st", "spool.status", DEFSTAT,
257 			    &pp->status_file));
258 	CHK(capdb_getaltstr(bp, "tr", "job.trailer", 0, &pp->trailer));
259 
260 	pp->resend_copies = capdb_getaltlog(bp, "rc", "remote.resend_copies");
261 	pp->restricted = capdb_getaltlog(bp, "rs", "daemon.restricted");
262 	pp->short_banner = capdb_getaltlog(bp, "sb", "banner.short");
263 	pp->no_copies = capdb_getaltlog(bp, "sc", "job.no_copies");
264 	pp->no_formfeed = capdb_getaltlog(bp, "sf", "job.no_formfeed");
265 	pp->no_header = capdb_getaltlog(bp, "sh", "banner.disable");
266 	pp->header_last = capdb_getaltlog(bp, "hl", "banner.last");
267 	pp->rw = capdb_getaltlog(bp, "rw", "tty.rw");
268 	pp->tof = !capdb_getaltlog(bp, "fo", "job.topofform");
269 
270 	/*
271 	 * Decide if the remote printer name matches the local printer name.
272 	 * If no name is given then we assume they mean them to match.
273 	 * If a name is given see if the rp_name is one of the names for
274 	 * this printer.
275 	 */
276 	pp->rp_matches_local = 1;
277 	CHK((error = capdb_getaltstr(bp, "rp", "remote.queue", 0, &rp_name)));
278 	if (error != PCAPERR_NOTFOUND && rp_name != NULL) {
279 		if (cgetmatch(bp,rp_name) != 0)
280 			pp->rp_matches_local = 0;
281 		free(rp_name);
282 	}
283 
284 	/*
285 	 * Filters:
286 	 */
287 	for (filt = 0; filt < LPF_COUNT; filt++) {
288 		CHK(capdb_getaltstr(bp, filters[filt], longfilters[filt], 0,
289 				    &pp->filters[filt]));
290 	}
291 
292 	return 0;
293 }
294 
295 /*
296  * Decode the error codes returned by cgetent() using the names we
297  * made up for them from "lp.h".
298  * This would have been much better done with Common Error, >sigh<.
299  * Perhaps this can be fixed in the next incarnation of cget*.
300  */
301 const char *
302 pcaperr(int error)
303 {
304 	switch(error) {
305 	case PCAPERR_TCOPEN:
306 		return "unresolved tc= expansion";
307 	case PCAPERR_SUCCESS:
308 		return "no error";
309 	case PCAPERR_NOTFOUND:
310 		return "printer not found";
311 	case PCAPERR_OSERR:
312 		return strerror(errno);
313 	case PCAPERR_TCLOOP:
314 		return "loop detected in tc= expansion";
315 	default:
316 		return "unknown printcap error";
317 	}
318 }
319 
320 /*
321  * Initialize a `struct printer' to contain values harmless to
322  * the other routines in liblpr.
323  */
324 void
325 init_printer(struct printer *pp)
326 {
327 	static struct printer zero;
328 	*pp = zero;
329 }
330 
331 /*
332  * Free the dynamically-allocated strings in a `struct printer'.
333  * Idempotent.
334  */
335 void
336 free_printer(struct printer *pp)
337 {
338 	enum lpd_filters filt;
339 #define	cfree(x)	do { if (x) free(x); } while(0)
340 	cfree(pp->printer);
341 	cfree(pp->acct_file);
342 	for (filt = 0; filt < LPF_COUNT; filt++)
343 		cfree(pp->filters[filt]);
344 	cfree(pp->form_feed);
345 	cfree(pp->log_file);
346 	cfree(pp->lock_file);
347 	cfree(pp->lp);
348 	cfree(pp->restrict_grp);
349 	cfree(pp->remote_host);
350 	cfree(pp->remote_queue);
351 	cfree(pp->spool_dir);
352 	cfree(pp->stat_recv);
353 	cfree(pp->stat_send);
354 	cfree(pp->status_file);
355 	cfree(pp->trailer);
356 	cfree(pp->mode_set);
357 
358 	init_printer(pp);
359 }
360 
361 
362 /*
363  * The following routines are part of what would be a sensible library
364  * interface to capability databases.  Maybe someday this will become
365  * the default.
366  */
367 
368 /*
369  * It provides similar functionality to cgetstr(),
370  * except that it provides for both a long and a short
371  * capability name and allows for a default to be specified.
372  */
373 static int
374 capdb_getaltstr(char *bp, const char *shrt, const char *lng,
375     const char *dflt, char **result)
376 {
377 	int status;
378 
379 	status = cgetstr(bp, (char *)/*XXX*/lng, result);
380 	if (status >= 0 || status == PCAPERR_OSERR)
381 		return status;
382 	status = cgetstr(bp, (char *)/*XXX*/shrt, result);
383 	if (status >= 0 || status == PCAPERR_OSERR)
384 		return status;
385 	if (dflt) {
386 		*result = strdup(dflt);
387 		if (*result == 0)
388 			return PCAPERR_OSERR;
389 		return strlen(*result);
390 	}
391 	return PCAPERR_NOTFOUND;
392 }
393 
394 /*
395  * The same, only for integers.
396  */
397 static int
398 capdb_getaltnum(char *bp, const char *shrt, const char *lng, long dflt,
399     long *result)
400 {
401 	int status;
402 
403 	status = cgetnum(bp, (char *)/*XXX*/lng, result);
404 	if (status >= 0)
405 		return status;
406 	status = cgetnum(bp, (char *)/*XXX*/shrt, result);
407 	if (status >= 0)
408 		return status;
409 	*result = dflt;
410 	return 0;
411 }
412 
413 /*
414  * Likewise for logical values.  There's no need for a default parameter
415  * because the default is always false.
416  */
417 static int
418 capdb_getaltlog(char *bp, const char *shrt, const char *lng)
419 {
420 	if (cgetcap(bp, (char *)/*XXX*/lng, ':'))
421 		return 1;
422 	if (cgetcap(bp, (char *)/*XXX*/shrt, ':'))
423 		return 1;
424 	return 0;
425 }
426 
427 /*
428  * Also should be a part of a better cget* library.
429  * Given a capdb entry, attempt to figure out what its canonical name
430  * is, and return a malloced copy of it.  The canonical name is
431  * considered to be the first one listed.
432  */
433 static char *
434 capdb_canonical_name(const char *bp)
435 {
436 	char *retval;
437 	const char *nameend;
438 
439 	nameend = strpbrk(bp, "|:");
440 	if (nameend == 0)
441 		nameend = bp + 1;
442 	if ((retval = malloc(nameend - bp + 1)) != 0) {
443 		retval[0] = '\0';
444 		strncat(retval, bp, nameend - bp);
445 	}
446 	return retval;
447 }
448 
449 
450