1*86d7f5d3SJohn Marino /*
2*86d7f5d3SJohn Marino * ------+---------+---------+---------+---------+---------+---------+---------*
3*86d7f5d3SJohn Marino * Copyright (c) 2001 - Garance Alistair Drosehn <gad@FreeBSD.org>.
4*86d7f5d3SJohn Marino * All rights reserved.
5*86d7f5d3SJohn Marino *
6*86d7f5d3SJohn Marino * Redistribution and use in source and binary forms, with or without
7*86d7f5d3SJohn Marino * modification, are permitted provided that the following conditions
8*86d7f5d3SJohn Marino * are met:
9*86d7f5d3SJohn Marino * 1. Redistributions of source code must retain the above copyright
10*86d7f5d3SJohn Marino * notice, this list of conditions and the following disclaimer.
11*86d7f5d3SJohn Marino * 2. Redistributions in binary form must reproduce the above copyright
12*86d7f5d3SJohn Marino * notice, this list of conditions and the following disclaimer in the
13*86d7f5d3SJohn Marino * documentation and/or other materials provided with the distribution.
14*86d7f5d3SJohn Marino *
15*86d7f5d3SJohn Marino * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16*86d7f5d3SJohn Marino * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17*86d7f5d3SJohn Marino * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18*86d7f5d3SJohn Marino * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19*86d7f5d3SJohn Marino * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20*86d7f5d3SJohn Marino * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21*86d7f5d3SJohn Marino * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22*86d7f5d3SJohn Marino * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23*86d7f5d3SJohn Marino * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24*86d7f5d3SJohn Marino * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25*86d7f5d3SJohn Marino * SUCH DAMAGE.
26*86d7f5d3SJohn Marino *
27*86d7f5d3SJohn Marino * The views and conclusions contained in the software and documentation
28*86d7f5d3SJohn Marino * are those of the authors and should not be interpreted as representing
29*86d7f5d3SJohn Marino * official policies, either expressed or implied, of the FreeBSD Project.
30*86d7f5d3SJohn Marino *
31*86d7f5d3SJohn Marino * ------+---------+---------+---------+---------+---------+---------+---------*
32*86d7f5d3SJohn Marino *
33*86d7f5d3SJohn Marino * $FreeBSD: src/usr.sbin/lpr/chkprintcap/skimprintcap.c,v 1.1.2.2 2002/06/19 01:53:48 gad Exp $
34*86d7f5d3SJohn Marino * $DragonFly: src/usr.sbin/lpr/chkprintcap/skimprintcap.c,v 1.2 2003/06/17 04:29:55 dillon Exp $
35*86d7f5d3SJohn Marino */
36*86d7f5d3SJohn Marino
37*86d7f5d3SJohn Marino #include <sys/types.h>
38*86d7f5d3SJohn Marino
39*86d7f5d3SJohn Marino #include <ctype.h>
40*86d7f5d3SJohn Marino #include <err.h>
41*86d7f5d3SJohn Marino #include <errno.h>
42*86d7f5d3SJohn Marino #include <grp.h>
43*86d7f5d3SJohn Marino #include <stdio.h>
44*86d7f5d3SJohn Marino #include <string.h>
45*86d7f5d3SJohn Marino #include <stdlib.h>
46*86d7f5d3SJohn Marino #include <unistd.h>
47*86d7f5d3SJohn Marino
48*86d7f5d3SJohn Marino #include <sys/param.h> /* needed for lp.h but not used here */
49*86d7f5d3SJohn Marino #include <dirent.h> /* ditto */
50*86d7f5d3SJohn Marino #include "lp.h"
51*86d7f5d3SJohn Marino #include "lp.local.h"
52*86d7f5d3SJohn Marino #include "skimprintcap.h"
53*86d7f5d3SJohn Marino
54*86d7f5d3SJohn Marino /*
55*86d7f5d3SJohn Marino * Save the canonical queue name of the entry that is currently being
56*86d7f5d3SJohn Marino * scanned, in case a warning message is printed for the current queue.
57*86d7f5d3SJohn Marino * Only the first 'QENTRY_MAXLEN' characters will be saved, since this
58*86d7f5d3SJohn Marino * is only for warning messages. The variable includes space for the
59*86d7f5d3SJohn Marino * string " (entry " and a trailing ")", when the scanner is in the
60*86d7f5d3SJohn Marino * middle of an entry. When the scanner is not in a specific entry,
61*86d7f5d3SJohn Marino * the variable will be the a null string.
62*86d7f5d3SJohn Marino */
63*86d7f5d3SJohn Marino #define QENTRY_MAXLEN 30
64*86d7f5d3SJohn Marino #define QENTRY_PREFIX " (entry "
65*86d7f5d3SJohn Marino static char skim_entryname[sizeof(QENTRY_PREFIX) + QENTRY_MAXLEN + 2];
66*86d7f5d3SJohn Marino
67*86d7f5d3SJohn Marino /*
68*86d7f5d3SJohn Marino * isgraph is defined to work on an 'int', in the range 0 to 255, plus EOF.
69*86d7f5d3SJohn Marino * Define a wrapper which can take 'char', either signed or unsigned.
70*86d7f5d3SJohn Marino */
71*86d7f5d3SJohn Marino #define isgraphch(Anychar) isgraph(((int) Anychar) & 255)
72*86d7f5d3SJohn Marino
73*86d7f5d3SJohn Marino struct skiminfo *
skim_printcap(const char * pcap_fname,int verbosity)74*86d7f5d3SJohn Marino skim_printcap(const char *pcap_fname, int verbosity)
75*86d7f5d3SJohn Marino {
76*86d7f5d3SJohn Marino struct skiminfo *skinf;
77*86d7f5d3SJohn Marino char buff[BUFSIZ];
78*86d7f5d3SJohn Marino char *ch, *curline, *endfield, *lastchar;
79*86d7f5d3SJohn Marino FILE *pc_file;
80*86d7f5d3SJohn Marino int missing_nl;
81*86d7f5d3SJohn Marino enum {NO_CONTINUE, WILL_CONTINUE, BAD_CONTINUE} is_cont, had_cont;
82*86d7f5d3SJohn Marino enum {CMNT_LINE, ENTRY_LINE, TAB_LINE, TABERR_LINE} is_type, had_type;
83*86d7f5d3SJohn Marino
84*86d7f5d3SJohn Marino skinf = malloc(sizeof(struct skiminfo));
85*86d7f5d3SJohn Marino memset(skinf, 0, sizeof(struct skiminfo));
86*86d7f5d3SJohn Marino
87*86d7f5d3SJohn Marino pc_file = fopen(pcap_fname, "r");
88*86d7f5d3SJohn Marino if (pc_file == NULL) {
89*86d7f5d3SJohn Marino warn("fopen(%s)", pcap_fname);
90*86d7f5d3SJohn Marino skinf->fatalerr++;
91*86d7f5d3SJohn Marino return (skinf); /* fatal error */
92*86d7f5d3SJohn Marino }
93*86d7f5d3SJohn Marino
94*86d7f5d3SJohn Marino skim_entryname[0] = '0';
95*86d7f5d3SJohn Marino
96*86d7f5d3SJohn Marino is_cont = NO_CONTINUE;
97*86d7f5d3SJohn Marino is_type = CMNT_LINE;
98*86d7f5d3SJohn Marino errno = 0;
99*86d7f5d3SJohn Marino curline = fgets(buff, sizeof(buff), pc_file);
100*86d7f5d3SJohn Marino while (curline != NULL) {
101*86d7f5d3SJohn Marino skinf->lines++;
102*86d7f5d3SJohn Marino
103*86d7f5d3SJohn Marino /* Check for the expected newline char, and remove it */
104*86d7f5d3SJohn Marino missing_nl = 0;
105*86d7f5d3SJohn Marino lastchar = strchr(curline, '\n');
106*86d7f5d3SJohn Marino if (lastchar != NULL)
107*86d7f5d3SJohn Marino *lastchar = '\0';
108*86d7f5d3SJohn Marino else {
109*86d7f5d3SJohn Marino lastchar = strchr(curline, '\0');
110*86d7f5d3SJohn Marino missing_nl = 1;
111*86d7f5d3SJohn Marino }
112*86d7f5d3SJohn Marino if (curline < lastchar)
113*86d7f5d3SJohn Marino lastchar--;
114*86d7f5d3SJohn Marino
115*86d7f5d3SJohn Marino /*
116*86d7f5d3SJohn Marino * Check for `\' (continuation-character) at end of line.
117*86d7f5d3SJohn Marino * If there is none, then trim off spaces and check again.
118*86d7f5d3SJohn Marino * This would be a bad line because it looks like it is
119*86d7f5d3SJohn Marino * continued, but it will not be treated that way.
120*86d7f5d3SJohn Marino */
121*86d7f5d3SJohn Marino had_cont = is_cont;
122*86d7f5d3SJohn Marino is_cont = NO_CONTINUE;
123*86d7f5d3SJohn Marino if (*lastchar == '\\') {
124*86d7f5d3SJohn Marino is_cont = WILL_CONTINUE;
125*86d7f5d3SJohn Marino lastchar--;
126*86d7f5d3SJohn Marino } else {
127*86d7f5d3SJohn Marino while ((curline < lastchar) && !isgraphch(*lastchar))
128*86d7f5d3SJohn Marino lastchar--;
129*86d7f5d3SJohn Marino if (*lastchar == '\\')
130*86d7f5d3SJohn Marino is_cont = BAD_CONTINUE;
131*86d7f5d3SJohn Marino }
132*86d7f5d3SJohn Marino
133*86d7f5d3SJohn Marino had_type = is_type;
134*86d7f5d3SJohn Marino is_type = CMNT_LINE;
135*86d7f5d3SJohn Marino switch (*curline) {
136*86d7f5d3SJohn Marino case '\0': /* treat zero-length line as comment */
137*86d7f5d3SJohn Marino case '#':
138*86d7f5d3SJohn Marino skinf->comments++;
139*86d7f5d3SJohn Marino break;
140*86d7f5d3SJohn Marino case ' ':
141*86d7f5d3SJohn Marino case '\t':
142*86d7f5d3SJohn Marino is_type = TAB_LINE;
143*86d7f5d3SJohn Marino break;
144*86d7f5d3SJohn Marino default:
145*86d7f5d3SJohn Marino is_type = ENTRY_LINE;
146*86d7f5d3SJohn Marino skinf->entries++;
147*86d7f5d3SJohn Marino
148*86d7f5d3SJohn Marino /* pick up the queue name, to use in warning messages */
149*86d7f5d3SJohn Marino ch = curline;
150*86d7f5d3SJohn Marino while ((ch <= lastchar) && (*ch != ':') && (*ch != '|'))
151*86d7f5d3SJohn Marino ch++;
152*86d7f5d3SJohn Marino ch--; /* last char of queue name */
153*86d7f5d3SJohn Marino strcpy(skim_entryname, QENTRY_PREFIX);
154*86d7f5d3SJohn Marino if ((ch - curline) > QENTRY_MAXLEN) {
155*86d7f5d3SJohn Marino strncat(skim_entryname, curline, QENTRY_MAXLEN
156*86d7f5d3SJohn Marino - 1);
157*86d7f5d3SJohn Marino strcat(skim_entryname, "+");
158*86d7f5d3SJohn Marino } else {
159*86d7f5d3SJohn Marino strncat(skim_entryname, curline, (ch - curline
160*86d7f5d3SJohn Marino + 1));
161*86d7f5d3SJohn Marino }
162*86d7f5d3SJohn Marino strlcat(skim_entryname, ")", sizeof(skim_entryname));
163*86d7f5d3SJohn Marino break;
164*86d7f5d3SJohn Marino }
165*86d7f5d3SJohn Marino
166*86d7f5d3SJohn Marino /*
167*86d7f5d3SJohn Marino * Check to see if the previous line was a bad contination
168*86d7f5d3SJohn Marino * line. The check is delayed until now so a warning message
169*86d7f5d3SJohn Marino * is not printed when a "bad continuation" is on a comment
170*86d7f5d3SJohn Marino * line, and it just "continues" into another comment line.
171*86d7f5d3SJohn Marino */
172*86d7f5d3SJohn Marino if (had_cont == BAD_CONTINUE) {
173*86d7f5d3SJohn Marino if ((had_type != CMNT_LINE) || (is_type != CMNT_LINE) ||
174*86d7f5d3SJohn Marino (verbosity > 1)) {
175*86d7f5d3SJohn Marino skinf->warnings++;
176*86d7f5d3SJohn Marino warnx("Warning: blanks after trailing '\\',"
177*86d7f5d3SJohn Marino " at line %d%s", skinf->lines - 1,
178*86d7f5d3SJohn Marino skim_entryname);
179*86d7f5d3SJohn Marino }
180*86d7f5d3SJohn Marino }
181*86d7f5d3SJohn Marino
182*86d7f5d3SJohn Marino /* If we are no longer in an entry, then forget the name */
183*86d7f5d3SJohn Marino if ((had_cont != WILL_CONTINUE) && (is_type != ENTRY_LINE)) {
184*86d7f5d3SJohn Marino skim_entryname[0] = '\0';
185*86d7f5d3SJohn Marino }
186*86d7f5d3SJohn Marino
187*86d7f5d3SJohn Marino /*
188*86d7f5d3SJohn Marino * Print out warning for missing newline, done down here
189*86d7f5d3SJohn Marino * so we are sure to have the right entry-name for it.
190*86d7f5d3SJohn Marino */
191*86d7f5d3SJohn Marino if (missing_nl) {
192*86d7f5d3SJohn Marino skinf->warnings++;
193*86d7f5d3SJohn Marino warnx("Warning: No newline at end of line %d%s",
194*86d7f5d3SJohn Marino skinf->lines, skim_entryname);
195*86d7f5d3SJohn Marino }
196*86d7f5d3SJohn Marino
197*86d7f5d3SJohn Marino /*
198*86d7f5d3SJohn Marino * Check for start-of-entry lines which do not include a
199*86d7f5d3SJohn Marino * ":" character (to indicate the end of the name field).
200*86d7f5d3SJohn Marino * This can cause standard printcap processing to ignore
201*86d7f5d3SJohn Marino * ALL of the following lines.
202*86d7f5d3SJohn Marino * XXXXX - May need to allow for the list-of-names to
203*86d7f5d3SJohn Marino * continue on to the following line...
204*86d7f5d3SJohn Marino */
205*86d7f5d3SJohn Marino if (is_type == ENTRY_LINE) {
206*86d7f5d3SJohn Marino endfield = strchr(curline, ':');
207*86d7f5d3SJohn Marino if (endfield == NULL) {
208*86d7f5d3SJohn Marino skinf->warnings++;
209*86d7f5d3SJohn Marino warnx("Warning: No ':' to terminate name-field"
210*86d7f5d3SJohn Marino " at line %d%s", skinf->lines,
211*86d7f5d3SJohn Marino skim_entryname);
212*86d7f5d3SJohn Marino }
213*86d7f5d3SJohn Marino }
214*86d7f5d3SJohn Marino
215*86d7f5d3SJohn Marino /*
216*86d7f5d3SJohn Marino * Now check for cases where this line is (or is-not) a
217*86d7f5d3SJohn Marino * continuation of the previous line, and a person skimming
218*86d7f5d3SJohn Marino * the file would assume it is not (or is) a continuation.
219*86d7f5d3SJohn Marino */
220*86d7f5d3SJohn Marino switch (had_cont) {
221*86d7f5d3SJohn Marino case NO_CONTINUE:
222*86d7f5d3SJohn Marino case BAD_CONTINUE:
223*86d7f5d3SJohn Marino if (is_type == TAB_LINE) {
224*86d7f5d3SJohn Marino skinf->warnings++;
225*86d7f5d3SJohn Marino warnx("Warning: values-line after line with"
226*86d7f5d3SJohn Marino " NO trailing '\\', at line %d%s",
227*86d7f5d3SJohn Marino skinf->lines, skim_entryname);
228*86d7f5d3SJohn Marino }
229*86d7f5d3SJohn Marino break;
230*86d7f5d3SJohn Marino
231*86d7f5d3SJohn Marino case WILL_CONTINUE:
232*86d7f5d3SJohn Marino if (is_type == ENTRY_LINE) {
233*86d7f5d3SJohn Marino skinf->warnings++;
234*86d7f5d3SJohn Marino warnx("Warning: new entry starts after line"
235*86d7f5d3SJohn Marino " with trailing '\\', at line %d%s",
236*86d7f5d3SJohn Marino skinf->lines, skim_entryname);
237*86d7f5d3SJohn Marino }
238*86d7f5d3SJohn Marino break;
239*86d7f5d3SJohn Marino }
240*86d7f5d3SJohn Marino
241*86d7f5d3SJohn Marino /* get another line from printcap and repeat loop */
242*86d7f5d3SJohn Marino curline = fgets(buff, sizeof(buff), pc_file);
243*86d7f5d3SJohn Marino }
244*86d7f5d3SJohn Marino
245*86d7f5d3SJohn Marino if (errno != 0) {
246*86d7f5d3SJohn Marino warn("fgets(%s)", pcap_fname);
247*86d7f5d3SJohn Marino skinf->fatalerr++; /* fatal error */
248*86d7f5d3SJohn Marino }
249*86d7f5d3SJohn Marino
250*86d7f5d3SJohn Marino if (skinf->warnings > 0)
251*86d7f5d3SJohn Marino warnx("%4d warnings from skimming %s", skinf->warnings,
252*86d7f5d3SJohn Marino pcap_fname);
253*86d7f5d3SJohn Marino
254*86d7f5d3SJohn Marino if (verbosity)
255*86d7f5d3SJohn Marino warnx("%4d lines (%d comments), %d entries for %s",
256*86d7f5d3SJohn Marino skinf->lines, skinf->comments, skinf->entries, pcap_fname);
257*86d7f5d3SJohn Marino
258*86d7f5d3SJohn Marino fclose(pc_file);
259*86d7f5d3SJohn Marino return (skinf);
260*86d7f5d3SJohn Marino }
261