src/common/header.c

#ifndef lint
static const char       RCSid[] = "$Id: header.c,v 2.21 2003/07/30 10:11:06 schorsch Exp $";
#endif
/*
 *  header.c - routines for reading and writing information headers.
 *
 *  Externals declared in resolu.h
 *
 *  newheader(t,fp)     start new information header identified by string t
 *  isheadid(s)         returns true if s is a header id line
 *  headidval(r,s)      copy header identifier value in s to r
 *  dateval(t,s)        get capture date value
 *  isdate(s)           returns true if s is a date line
 *  fputdate(t,fp)      put out the given capture date and time
 *  fputnow(fp)         put out the current date and time
 *  printargs(ac,av,fp) print an argument list to fp, followed by '\n'
 *  isformat(s)         returns true if s is of the form "FORMAT=*"
 *  formatval(r,s)      copy the format value in s to r
 *  fputformat(s,fp)    write "FORMAT=%s" to fp
 *  getheader(fp,f,p)   read header from fp, calling f(s,p) on each line
 *  globmatch(pat, str) check for glob match of str against pat
 *  checkheader(i,p,o)  check header format from i against p and copy to o
 *
 *  To copy header from input to output, use getheader(fin, fputs, fout)
 */

#include "copyright.h"

#include  <time.h>
#include  <ctype.h>

#include  "rtio.h"
#include  "resolu.h"

#define  MAXLINE        512

char  HDRSTR[] = "#?";          /* information header magic number */

char  FMTSTR[] = "FORMAT=";     /* format identifier */

char  TMSTR[] = "CAPDATE=";     /* capture date identifier */

static gethfunc mycheck;


extern void
newheader(              /* identifying line of information header */
        char  *s,
        register FILE  *fp
)
{
        fputs(HDRSTR, fp);
        fputs(s, fp);
        putc('\n', fp);
}


extern int
headidval(                      /* get header id (return true if is id) */
        register char  *r,
        register char   *s
)
{
        register char  *cp = HDRSTR;

        while (*cp) if (*cp++ != *s++) return(0);
        if (r == NULL) return(1);
        while (*s && !isspace(*s)) *r++ = *s++;
        *r = '\0';
        return(1);
}


extern int
isheadid(                       /* check to see if line is header id */
        char  *s
)
{
        return(headidval(NULL, s));
}


extern int
dateval(                /* get capture date value */
        time_t  *tloc,
        char    *s
)
{
        struct tm       tms;
        register char  *cp = TMSTR;

        while (*cp) if (*cp++ != *s++) return(0);
        while (isspace(*s)) s++;
        if (!*s) return(0);
        if (sscanf(s, "%d:%d:%d %d:%d:%d",
                        &tms.tm_year, &tms.tm_mon, &tms.tm_mday,
                        &tms.tm_hour, &tms.tm_min, &tms.tm_sec) != 6)
                return(0);
        if (tloc == NULL)
                return(1);
        tms.tm_mon--;
        tms.tm_year -= 1900;
        tms.tm_isdst = -1;      /* ask mktime() to figure out DST */
        *tloc = mktime(&tms);
        return(1);
}


extern int
isdate(                 /* is the given line a capture date? */
        char *s
)
{
        return(dateval(NULL, s));
}


extern void
fputdate(               /* write out the given time value */
        time_t  tv,
        FILE    *fp
)
{
        struct tm       *tm = localtime(&tv);
        if (tm == NULL)
                return;
        fprintf(fp, "%s %04d:%02d:%02d %02d:%02d:%02d\n", TMSTR,
                        tm->tm_year+1900, tm->tm_mon+1, tm->tm_mday,
                        tm->tm_hour, tm->tm_min, tm->tm_sec);
}


extern void
fputnow(                        /* write out the current time */
        FILE    *fp
)
{
        time_t  tv;
        time(&tv);
        fputdate(tv, fp);
}


extern void
printargs(              /* print arguments to a file */
        int  ac,
        char  **av,
        FILE  *fp
)
{
        while (ac-- > 0) {
                fputword(*av++, fp);
                fputc(ac ? ' ' : '\n', fp);
        }
}


extern int
formatval(                      /* get format value (return true if format) */
        register char  *r,
        register char  *s
)
{
        register char  *cp = FMTSTR;

        while (*cp) if (*cp++ != *s++) return(0);
        while (isspace(*s)) s++;
        if (!*s) return(0);
        if (r == NULL) return(1);
        do
                *r++ = *s++;
        while(*s && !isspace(*s));
        *r = '\0';
        return(1);
}


extern int
isformat(                       /* is line a format line? */
        char  *s
)
{
        return(formatval(NULL, s));
}


extern void
fputformat(             /* put out a format value */
        char  *s,
        FILE  *fp
)
{
        fputs(FMTSTR, fp);
        fputs(s, fp);
        putc('\n', fp);
}


extern int
getheader(              /* get header from file */
        FILE  *fp,
        gethfunc *f,
        void  *p
)
{
        char  buf[MAXLINE];

        for ( ; ; ) {
                buf[MAXLINE-2] = '\n';
                if (fgets(buf, MAXLINE, fp) == NULL)
                        return(-1);
                if (buf[0] == '\n')
                        return(0);
#ifdef MSDOS
                if (buf[0] == '\r' && buf[1] == '\n')
                        return(0);
#endif
                if (buf[MAXLINE-2] != '\n') {
                        ungetc(buf[MAXLINE-2], fp);     /* prevent false end */
                        buf[MAXLINE-2] = '\0';
                }
                if (f != NULL && (*f)(buf, p) < 0)
                        return(-1);
        }
}


struct check {
        FILE    *fp;
        char    fs[64];
};


static int
mycheck(                        /* check a header line for format info. */
        char  *s,
        void  *cp
)
{
        if (!formatval(((struct check*)cp)->fs, s)
                        && ((struct check*)cp)->fp != NULL) {
                fputs(s, ((struct check*)cp)->fp);
        }
        return(0);
}


extern int
globmatch(                      /* check for match of s against pattern p */
        register char   *p,
        register char   *s
)
{
        int     setmatch;

        do {
                switch (*p) {
                case '?':                       /* match any character */
                        if (!*s++)
                                return(0);
                        break;
                case '*':                       /* match any string */
                        while (p[1] == '*') p++;
                        do
                                if ( (p[1]=='?' || p[1]==*s) &&
                                                globmatch(p+1,s) )
                                        return(1);
                        while (*s++);
                        return(0);
                case '[':                       /* character set */
                        setmatch = *s == *++p;
                        if (!*p)
                                return(0);
                        while (*++p != ']') {
                                if (!*p)
                                        return(0);
                                if (*p == '-') {
                                        setmatch += p[-1] <= *s && *s <= p[1];
                                        if (!*++p)
                                                break;
                                } else
                                        setmatch += *p == *s;
                        }
                        if (!setmatch)
                                return(0);
                        s++;
                        break;
                case '\\':                      /* literal next */
                        p++;
                /* fall through */
                default:                        /* normal character */
                        if (*p != *s)
                                return(0);
                        s++;
                        break;
                }
        } while (*p++);
        return(1);
}


/*
 * Checkheader(fin,fmt,fout) returns a value of 1 if the input format
 * matches the specification in fmt, 0 if no input format was found,
 * and -1 if the input format does not match or there is an
 * error reading the header.  If fmt is empty, then -1 is returned
 * if any input format is found (or there is an error), and 0 otherwise.
 * If fmt contains any '*' or '?' characters, then checkheader
 * does wildcard expansion and copies a matching result into fmt.
 * Be sure that fmt is big enough to hold the match in such cases,
 * and that it is not a static, read-only string!
 * The input header (minus any format lines) is copied to fout
 * if fout is not NULL.
 */

extern int
checkheader(
        FILE  *fin,
        char  *fmt,
        FILE  *fout
)
{
        struct check    cdat;
        register char   *cp;

        cdat.fp = fout;
        cdat.fs[0] = '\0';
        if (getheader(fin, mycheck, &cdat) < 0)
                return(-1);
        if (!cdat.fs[0])
                return(0);
        for (cp = fmt; *cp; cp++)               /* check for globbing */
                if ((*cp == '?') | (*cp == '*')) {
                        if (globmatch(fmt, cdat.fs)) {
                                strcpy(fmt, cdat.fs);
                                return(1);
                        } else
                                return(-1);
                }
        return(strcmp(fmt, cdat.fs) ? -1 : 1);  /* literal match */
}
Revision:	2.22
Committed:	Fri Jan 2 11:35:17 2004 UTC (20 years, 3 months ago) by schorsch
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rad3R6, rad3R6P1
Changes since 2.21:	+81 -62 lines
Log Message:	Fixed typing/prototype of getheader() and its callback.
#	User	Rev	Content
1	greg	1.1	#ifndef lint
2	schorsch	2.22	static const char RCSid[] = "$Id: header.c,v 2.21 2003/07/30 10:11:06 schorsch Exp $";
3	greg	1.1	#endif
4			/*
5			* header.c - routines for reading and writing information headers.
6			*
7	greg	2.11	* Externals declared in resolu.h
8	greg	1.3	*
9	greg	2.4	* newheader(t,fp) start new information header identified by string t
10			* isheadid(s) returns true if s is a header id line
11			* headidval(r,s) copy header identifier value in s to r
12	greg	2.11	* dateval(t,s) get capture date value
13			* isdate(s) returns true if s is a date line
14			* fputdate(t,fp) put out the given capture date and time
15			* fputnow(fp) put out the current date and time
16	greg	2.3	* printargs(ac,av,fp) print an argument list to fp, followed by '\n'
17	greg	1.3	* isformat(s) returns true if s is of the form "FORMAT=*"
18			* formatval(r,s) copy the format value in s to r
19			* fputformat(s,fp) write "FORMAT=%s" to fp
20			* getheader(fp,f,p) read header from fp, calling f(s,p) on each line
21	greg	2.6	* globmatch(pat, str) check for glob match of str against pat
22	greg	1.3	* checkheader(i,p,o) check header format from i against p and copy to o
23			*
24			* To copy header from input to output, use getheader(fin, fputs, fout)
25	greg	1.1	*/
26
27	greg	2.12	#include "copyright.h"
28	greg	2.11
29			#include <time.h>
30	greg	1.3	#include <ctype.h>
31	schorsch	2.17
32	greg	2.18	#include "rtio.h"
33			#include "resolu.h"
34	schorsch	2.14
35	greg	2.3	#define MAXLINE 512
36	greg	2.2
37	greg	2.4	char HDRSTR[] = "#?"; /* information header magic number */
38	greg	1.2
39	greg	2.4	char FMTSTR[] = "FORMAT="; /* format identifier */
40	greg	1.2
41	greg	2.11	char TMSTR[] = "CAPDATE="; /* capture date identifier */
42	greg	2.16
43	schorsch	2.22	static gethfunc mycheck;
44	greg	2.4
45	greg	2.11
46	schorsch	2.22	extern void
47			newheader( /* identifying line of information header */
48			char *s,
49			register FILE *fp
50			)
51	greg	2.4	{
52			fputs(HDRSTR, fp);
53			fputs(s, fp);
54			putc('\n', fp);
55			}
56
57
58	schorsch	2.22	extern int
59			headidval( /* get header id (return true if is id) */
60			register char *r,
61			register char *s
62			)
63	greg	2.4	{
64			register char *cp = HDRSTR;
65
66			while (cp) if (cp++ != *s++) return(0);
67			if (r == NULL) return(1);
68	gregl	2.9	while (s && !isspace(s)) r++ = s++;
69	greg	2.4	*r = '\0';
70			return(1);
71			}
72
73
74	schorsch	2.22	extern int
75			isheadid( /* check to see if line is header id */
76			char *s
77			)
78	greg	2.4	{
79			return(headidval(NULL, s));
80			}
81
82
83	schorsch	2.22	extern int
84			dateval( /* get capture date value */
85			time_t *tloc,
86			char *s
87			)
88	greg	2.11	{
89			struct tm tms;
90			register char *cp = TMSTR;
91
92			while (cp) if (cp++ != *s++) return(0);
93			while (isspace(*s)) s++;
94			if (!*s) return(0);
95			if (sscanf(s, "%d:%d:%d %d:%d:%d",
96			&tms.tm_year, &tms.tm_mon, &tms.tm_mday,
97			&tms.tm_hour, &tms.tm_min, &tms.tm_sec) != 6)
98			return(0);
99			if (tloc == NULL)
100			return(1);
101			tms.tm_mon--;
102			tms.tm_year -= 1900;
103			tms.tm_isdst = -1; /* ask mktime() to figure out DST */
104			*tloc = mktime(&tms);
105			return(1);
106			}
107
108
109	schorsch	2.22	extern int
110			isdate( /* is the given line a capture date? */
111			char *s
112			)
113	greg	2.11	{
114			return(dateval(NULL, s));
115			}
116
117
118	schorsch	2.22	extern void
119			fputdate( /* write out the given time value */
120			time_t tv,
121			FILE *fp
122			)
123	greg	2.11	{
124			struct tm *tm = localtime(&tv);
125			if (tm == NULL)
126			return;
127			fprintf(fp, "%s %04d:%02d:%02d %02d:%02d:%02d\n", TMSTR,
128			tm->tm_year+1900, tm->tm_mon+1, tm->tm_mday,
129			tm->tm_hour, tm->tm_min, tm->tm_sec);
130			}
131
132
133	schorsch	2.22	extern void
134			fputnow( /* write out the current time */
135			FILE *fp
136			)
137	greg	2.11	{
138			time_t tv;
139			time(&tv);
140			fputdate(tv, fp);
141			}
142
143
144	schorsch	2.22	extern void
145			printargs( /* print arguments to a file */
146			int ac,
147			char **av,
148			FILE *fp
149			)
150	greg	1.1	{
151			while (ac-- > 0) {
152	greg	2.11	fputword(*av++, fp);
153			fputc(ac ? ' ' : '\n', fp);
154	greg	1.1	}
155			}
156
157
158	schorsch	2.22	extern int
159			formatval( /* get format value (return true if format) */
160			register char *r,
161			register char *s
162			)
163	greg	1.2	{
164	greg	2.4	register char *cp = FMTSTR;
165
166			while (cp) if (cp++ != *s++) return(0);
167	greg	1.3	while (isspace(*s)) s++;
168	greg	2.4	if (!*s) return(0);
169			if (r == NULL) return(1);
170	greg	2.5	do
171			r++ = s++;
172			while(s && !isspace(s));
173	greg	1.2	*r = '\0';
174	greg	2.4	return(1);
175	greg	1.2	}
176
177
178	schorsch	2.22	extern int
179			isformat( /* is line a format line? */
180			char *s
181			)
182	greg	2.4	{
183			return(formatval(NULL, s));
184			}
185
186
187	schorsch	2.22	extern void
188			fputformat( /* put out a format value */
189			char *s,
190			FILE *fp
191			)
192	greg	1.2	{
193			fputs(FMTSTR, fp);
194			fputs(s, fp);
195			putc('\n', fp);
196			}
197
198
199	schorsch	2.22	extern int
200			getheader( /* get header from file */
201			FILE *fp,
202			gethfunc *f,
203			void *p
204			)
205	greg	1.1	{
206			char buf[MAXLINE];
207
208			for ( ; ; ) {
209			buf[MAXLINE-2] = '\n';
210	greg	2.3	if (fgets(buf, MAXLINE, fp) == NULL)
211	greg	1.1	return(-1);
212			if (buf[0] == '\n')
213			return(0);
214	greg	2.3	#ifdef MSDOS
215			if (buf[0] == '\r' && buf[1] == '\n')
216			return(0);
217			#endif
218	greg	1.1	if (buf[MAXLINE-2] != '\n') {
219			ungetc(buf[MAXLINE-2], fp); /* prevent false end */
220			buf[MAXLINE-2] = '\0';
221			}
222	gwlarson	2.10	if (f != NULL && (*f)(buf, p) < 0)
223			return(-1);
224	greg	1.1	}
225			}
226
227
228	greg	1.2	struct check {
229			FILE *fp;
230	greg	1.3	char fs[64];
231	greg	1.2	};
232	greg	1.1
233	greg	1.2
234	greg	2.11	static int
235	schorsch	2.22	mycheck( /* check a header line for format info. */
236			char *s,
237			void *cp
238			)
239			{
240			if (!formatval(((struct check*)cp)->fs, s)
241			&& ((struct check*)cp)->fp != NULL) {
242			fputs(s, ((struct check*)cp)->fp);
243			}
244	greg	2.11	return(0);
245	greg	1.1	}
246
247
248	schorsch	2.22	extern int
249			globmatch( /* check for match of s against pattern p */
250			register char *p,
251			register char *s
252			)
253	greg	1.3	{
254	greg	2.11	int setmatch;
255	greg	1.3
256			do {
257			switch (*p) {
258			case '?': /* match any character */
259			if (!*s++)
260			return(0);
261			break;
262			case '': / match any string */
263			while (p[1] == '*') p++;
264			do
265	greg	2.6	if ( (p[1]=='?' \|\| p[1]==*s) &&
266			globmatch(p+1,s) )
267	greg	1.3	return(1);
268			while (*s++);
269			return(0);
270	greg	2.11	case '[': /* character set */
271			setmatch = s == ++p;
272			if (!*p)
273			return(0);
274			while (*++p != ']') {
275			if (!*p)
276			return(0);
277			if (*p == '-') {
278			setmatch += p[-1] <= s && s <= p[1];
279			if (!*++p)
280			break;
281			} else
282			setmatch += p == s;
283			}
284			if (!setmatch)
285			return(0);
286			s++;
287			break;
288	greg	1.3	case '\\': /* literal next */
289			p++;
290			/* fall through */
291			default: /* normal character */
292			if (p != s)
293			return(0);
294			s++;
295			break;
296			}
297			} while (*p++);
298			return(1);
299			}
300
301
302			/*
303			* Checkheader(fin,fmt,fout) returns a value of 1 if the input format
304			* matches the specification in fmt, 0 if no input format was found,
305			* and -1 if the input format does not match or there is an
306	greg	1.4	* error reading the header. If fmt is empty, then -1 is returned
307	greg	1.3	* if any input format is found (or there is an error), and 0 otherwise.
308			* If fmt contains any '*' or '?' characters, then checkheader
309			* does wildcard expansion and copies a matching result into fmt.
310	greg	2.7	* Be sure that fmt is big enough to hold the match in such cases,
311			* and that it is not a static, read-only string!
312	greg	1.3	* The input header (minus any format lines) is copied to fout
313			* if fout is not NULL.
314			*/
315
316	schorsch	2.22	extern int
317			checkheader(
318			FILE *fin,
319			char *fmt,
320			FILE *fout
321			)
322	greg	1.1	{
323	greg	1.2	struct check cdat;
324	greg	2.7	register char *cp;
325	greg	1.2
326			cdat.fp = fout;
327			cdat.fs[0] = '\0';
328	schorsch	2.22	if (getheader(fin, mycheck, &cdat) < 0)
329	greg	1.3	return(-1);
330	greg	2.6	if (!cdat.fs[0])
331			return(0);
332	greg	2.7	for (cp = fmt; cp; cp++) / check for globbing */
333	schorsch	2.20	if ((cp == '?') \| (cp == '*')) {
334	greg	2.7	if (globmatch(fmt, cdat.fs)) {
335			strcpy(fmt, cdat.fs);
336			return(1);
337			} else
338			return(-1);
339	schorsch	2.19	}
340	greg	2.7	return(strcmp(fmt, cdat.fs) ? -1 : 1); /* literal match */
341	greg	1.1	}