2 * SPDX-License-Identifier: BSD-4-Clause
4 * Copyright (c) 1983, 1993
5 * The Regents of the University of California. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the University of
23 * California, Berkeley and its contributors.
24 * 4. Neither the name of the University nor the names of its contributors
25 * may be used to endorse or promote products derived from this software
26 * without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 static char sccsid[] = "@(#)printcap.c 8.2 (Berkeley) 4/28/95";
47 #include "lp.cdefs.h" /* A cross-platform version of <sys/cdefs.h> */
48 __FBSDID("$FreeBSD$");
56 #include <sys/param.h> /* required for lp.h, but not used here */
57 #include <sys/dirent.h> /* ditto */
60 #include "pathnames.h"
63 * Routines and data used in processing the printcap file.
65 static char *printcapdb[2] = { _PATH_PRINTCAP, 0 }; /* list for cget* */
67 static char *capdb_canonical_name(const char *_bp);
68 static int capdb_getaltlog(char *_bp, const char *_shrt,
70 static int capdb_getaltnum(char *_bp, const char *_shrt,
71 const char *_lng, long _dflt, long *_result);
72 static int capdb_getaltstr(char *_bp, const char *_shrt,
73 const char *lng, const char *_dflt, char **_result);
74 static int getprintcap_int(char *_bp, struct printer *_pp);
77 * Change the name of the printcap file. Used by chkprintcap(8),
78 * but could be used by other members of the suite with appropriate
82 setprintcap(char *newfile)
84 printcapdb[0] = newfile;
88 * Read the printcap database for printer `printer' into the
89 * struct printer pointed by `pp'. Return values are as for
90 * cgetent(3): -1 means we could not find what we wanted, -2
91 * means a system error occurred (and errno is set), -3 if a
92 * reference (`tc=') loop was detected, and 0 means success.
94 * Copied from lpr; should add additional capabilities as they
95 * are required by the other programs in the suite so that
96 * printcap-reading is consistent across the entire family.
99 getprintcap(const char *printer, struct printer *pp)
106 * A bug in the declaration of cgetent(3) means that we have
107 * to hide the constness of its third argument.
109 XXX = (char *)printer;
110 if ((status = cgetent(&bp, printcapdb, XXX)) < 0)
112 status = getprintcap_int(bp, pp);
118 * Map the status values returned by cgetfirst/cgetnext into those
119 * used by cgetent, returning truth if there are more records to
120 * examine. This points out what is arguably a bug in the cget*
121 * interface (or at least a nasty wart).
124 firstnextmap(int *status)
147 * Scan through the database of printers using cgetfirst/cgetnext.
148 * Return false of error or end-of-database; else true.
151 firstprinter(struct printer *pp, int *error)
157 status = cgetfirst(&bp, printcapdb);
158 if (firstnextmap(&status) == 0) {
165 status = getprintcap_int(bp, pp);
173 nextprinter(struct printer *pp, int *error)
179 status = cgetnext(&bp, printcapdb);
180 if (firstnextmap(&status) == 0) {
187 status = getprintcap_int(bp, pp);
201 * This must match the order of declaration of enum filter in lp.h.
203 static const char *filters[] = {
204 "cf", "df", "gf", "if", "nf", "of", "rf", "tf", "vf"
207 static const char *longfilters[] = {
208 "filt.cifplot", "filt.dvi", "filt.plot", "filt.input", "filt.ditroff",
209 "filt.output", "filt.fortran", "filt.troff", "filt.raster"
213 * Internal routine for both getprintcap() and nextprinter().
214 * Actually parse the printcap entry using cget* functions.
215 * Also attempt to figure out the canonical name of the printer
216 * and store a malloced copy of it in pp->printer.
219 getprintcap_int(char *bp, struct printer *pp)
221 enum lpd_filters filt;
225 if ((pp->printer = capdb_canonical_name(bp)) == NULL)
226 return PCAPERR_OSERR;
228 #define CHK(x) do {if ((x) == PCAPERR_OSERR) return PCAPERR_OSERR;}while(0)
229 CHK(capdb_getaltstr(bp, "af", "acct.file", 0, &pp->acct_file));
230 CHK(capdb_getaltnum(bp, "br", "tty.rate", 0, &pp->baud_rate));
231 CHK(capdb_getaltnum(bp, "ct", "remote.timeout", DEFTIMEOUT,
233 CHK(capdb_getaltnum(bp, "du", "daemon.user", DEFUID,
235 CHK(capdb_getaltstr(bp, "ff", "job.formfeed", DEFFF, &pp->form_feed));
236 CHK(capdb_getaltstr(bp, "lf", "spool.log", _PATH_CONSOLE,
238 CHK(capdb_getaltstr(bp, "lo", "spool.lock", DEFLOCK, &pp->lock_file));
239 CHK(capdb_getaltstr(bp, "lp", "tty.device", _PATH_DEFDEVLP, &pp->lp));
240 CHK(capdb_getaltnum(bp, "mc", "max.copies", DEFMAXCOPIES,
242 CHK(capdb_getaltstr(bp, "ms", "tty.mode", 0, &pp->mode_set));
243 CHK(capdb_getaltnum(bp, "mx", "max.blocks", DEFMX, &pp->max_blocks));
244 CHK(capdb_getaltnum(bp, "pc", "acct.price", 0, &pp->price100));
245 CHK(capdb_getaltnum(bp, "pl", "page.length", DEFLENGTH,
247 CHK(capdb_getaltnum(bp, "pw", "page.width", DEFWIDTH,
249 CHK(capdb_getaltnum(bp, "px", "page.pwidth", 0, &pp->page_pwidth));
250 CHK(capdb_getaltnum(bp, "py", "page.plength", 0, &pp->page_plength));
251 CHK(capdb_getaltstr(bp, "rg", "daemon.restrictgrp", 0,
253 CHK(capdb_getaltstr(bp, "rm", "remote.host", 0, &pp->remote_host));
254 CHK(capdb_getaltstr(bp, "rp", "remote.queue", DEFLP,
256 CHK(capdb_getaltstr(bp, "sd", "spool.dir", _PATH_DEFSPOOL,
258 CHK(capdb_getaltstr(bp, "sr", "stat.recv", 0, &pp->stat_recv));
259 CHK(capdb_getaltstr(bp, "ss", "stat.send", 0, &pp->stat_send));
260 CHK(capdb_getaltstr(bp, "st", "spool.status", DEFSTAT,
262 CHK(capdb_getaltstr(bp, "tr", "job.trailer", 0, &pp->trailer));
264 pp->resend_copies = capdb_getaltlog(bp, "rc", "remote.resend_copies");
265 pp->restricted = capdb_getaltlog(bp, "rs", "daemon.restricted");
266 pp->short_banner = capdb_getaltlog(bp, "sb", "banner.short");
267 pp->no_copies = capdb_getaltlog(bp, "sc", "job.no_copies");
268 pp->no_formfeed = capdb_getaltlog(bp, "sf", "job.no_formfeed");
269 pp->no_header = capdb_getaltlog(bp, "sh", "banner.disable");
270 pp->header_last = capdb_getaltlog(bp, "hl", "banner.last");
271 pp->rw = capdb_getaltlog(bp, "rw", "tty.rw");
272 pp->tof = !capdb_getaltlog(bp, "fo", "job.topofform");
275 * Decide if the remote printer name matches the local printer name.
276 * If no name is given then we assume they mean them to match.
277 * If a name is given see if the rp_name is one of the names for
280 pp->rp_matches_local = 1;
281 CHK((error = capdb_getaltstr(bp, "rp", "remote.queue", 0, &rp_name)));
282 if (error != PCAPERR_NOTFOUND && rp_name != NULL) {
283 if (cgetmatch(bp,rp_name) != 0)
284 pp->rp_matches_local = 0;
291 for (filt = 0; filt < LPF_COUNT; filt++) {
292 CHK(capdb_getaltstr(bp, filters[filt], longfilters[filt], 0,
293 &pp->filters[filt]));
300 * Decode the error codes returned by cgetent() using the names we
301 * made up for them from "lp.h".
302 * This would have been much better done with Common Error, >sigh<.
303 * Perhaps this can be fixed in the next incarnation of cget*.
310 return "unresolved tc= expansion";
311 case PCAPERR_SUCCESS:
313 case PCAPERR_NOTFOUND:
314 return "printer not found";
316 return strerror(errno);
318 return "loop detected in tc= expansion";
320 return "unknown printcap error";
325 * Initialize a `struct printer' to contain values harmless to
326 * the other routines in liblpr.
329 init_printer(struct printer *pp)
331 static struct printer zero;
336 * Free the dynamically-allocated strings in a `struct printer'.
340 free_printer(struct printer *pp)
342 enum lpd_filters filt;
343 #define cfree(x) do { if (x) free(x); } while(0)
345 cfree(pp->acct_file);
346 for (filt = 0; filt < LPF_COUNT; filt++)
347 cfree(pp->filters[filt]);
348 cfree(pp->form_feed);
350 cfree(pp->lock_file);
352 cfree(pp->restrict_grp);
353 cfree(pp->remote_host);
354 cfree(pp->remote_queue);
355 cfree(pp->spool_dir);
356 cfree(pp->stat_recv);
357 cfree(pp->stat_send);
358 cfree(pp->status_file);
367 * The following routines are part of what would be a sensible library
368 * interface to capability databases. Maybe someday this will become
373 * It provides similar functionality to cgetstr(),
374 * except that it provides for both a long and a short
375 * capability name and allows for a default to be specified.
378 capdb_getaltstr(char *bp, const char *shrt, const char *lng,
379 const char *dflt, char **result)
383 status = cgetstr(bp, (char *)/*XXX*/lng, result);
384 if (status >= 0 || status == PCAPERR_OSERR)
386 status = cgetstr(bp, (char *)/*XXX*/shrt, result);
387 if (status >= 0 || status == PCAPERR_OSERR)
390 *result = strdup(dflt);
392 return PCAPERR_OSERR;
393 return strlen(*result);
395 return PCAPERR_NOTFOUND;
399 * The same, only for integers.
402 capdb_getaltnum(char *bp, const char *shrt, const char *lng, long dflt,
407 status = cgetnum(bp, (char *)/*XXX*/lng, result);
410 status = cgetnum(bp, (char *)/*XXX*/shrt, result);
418 * Likewise for logical values. There's no need for a default parameter
419 * because the default is always false.
422 capdb_getaltlog(char *bp, const char *shrt, const char *lng)
424 if (cgetcap(bp, (char *)/*XXX*/lng, ':'))
426 if (cgetcap(bp, (char *)/*XXX*/shrt, ':'))
432 * Also should be a part of a better cget* library.
433 * Given a capdb entry, attempt to figure out what its canonical name
434 * is, and return a malloced copy of it. The canonical name is
435 * considered to be the first one listed.
438 capdb_canonical_name(const char *bp)
443 nameend = strpbrk(bp, "|:");
446 if ((retval = malloc(nameend - bp + 1)) != NULL) {
448 strncat(retval, bp, nameend - bp);