usr.sbin/lpr/common_source/printcap.c

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