src/common/header.c

#ifndef lint
static const char       RCSid[] = "$Id: header.c,v 2.35 2019/07/19 17:37:56 greg Exp $";
#endif
/*
 *  header.c - routines for reading and writing information headers.
 *
 *  Externals declared in rtio.h
 *
 *  newheader(t,fp)     start new information header identified by string t
 *  headidval(r,s)      copy header identifier value in s to r
 *  dateval(t,s)        get capture date value as UTC
 *  gmtval(t,s)         get GMT as UTC
 *  fputdate(t,fp)      put out the given UTC
 *  fputnow(fp)         put out the current date and time
 *  printargs(ac,av,fp) print an argument list to fp, followed by '\n'
 *  formatval(r,s)      copy the format value in s to r
 *  fputformat(s,fp)    write "FORMAT=%s" to fp
 *  nativebigendian()   are we native on big-endian machine?
 *  isbigendian(s)      header line matches "BigEndian=1" (-1 if irrelevant)
 *  fputendian(fp)      write native endianness in BigEndian= line
 *  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  <ctype.h>

#include  "tiff.h"      /* for int32 */
#include  "rtio.h"
#include  "resolu.h"

#define  MAXLINE        2048

extern time_t           timegm(struct tm *tm);

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

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

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

const char  BIGEND[] = "BigEndian=";    /* big-endian variable */

static gethfunc mycheck;


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


int
headidval(                      /* get header id (return true if is id) */
        char  *r,
        const char      *s
)
{
        const 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);
}


int
dateval(                /* convert capture date line to UTC */
        time_t  *tloc,
        const char      *s
)
{
        struct tm       tms;
        const 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);
}


int
gmtval(                 /* convert GMT date line to UTC */
        time_t  *tloc,
        const char      *s
)
{
        struct tm       tms;
        const char      *cp = GMTSTR;

        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;
        *tloc = timegm(&tms);
        return(1);
}


void
fputdate(               /* write out the given time value (local & GMT) */
        time_t  tv,
        FILE    *fp
)
{
        struct tm       *tms;

        tms = localtime(&tv);
        if (tms != NULL)
                fprintf(fp, "%s %04d:%02d:%02d %02d:%02d:%02d\n", TMSTR,
                                tms->tm_year+1900, tms->tm_mon+1, tms->tm_mday,
                                tms->tm_hour, tms->tm_min, tms->tm_sec);
        tms = gmtime(&tv);
        if (tms != NULL)
                fprintf(fp, "%s %04d:%02d:%02d %02d:%02d:%02d\n", GMTSTR,
                                tms->tm_year+1900, tms->tm_mon+1, tms->tm_mday,
                                tms->tm_hour, tms->tm_min, tms->tm_sec);
}


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


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


int
formatval(                      /* get format value (return true if format) */
        char  fmt[MAXFMTLEN],
        const char  *s
)
{
        const char  *cp = FMTSTR;
        char  *r = fmt;

        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-fmt < MAXFMTLEN-1);
        *r = '\0';
        return(1);
}


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


int
nativebigendian()       /* are we native on a big-endian machine? */
{
        union { int32 i; char c[4]; } u;

        u.i = 1;

        return(u.c[0] == 0);
}


int
isbigendian(            /* header line says "BigEndian=1" (-1 if irrelevant) */
        const char *s
)
{
        const char      *be = BIGEND;

        while (*s & (*be != '=') && *s++ == *be)
                ++be;
        if (*be != '=')
                return(-1);     /* irrelevant */
        while (isspace(*s))
                s++;
        if (*s++ != '=')
                return(-1);
        while (isspace(*s))
                s++;
        return(*s == '1');
}


void
fputendian(             /* write native endianness in BigEndian= line */
        FILE *fp
)
{
        fputs(BIGEND, fp);
        if (nativebigendian())
                fputs("1\n", fp);
        else
                fputs("0\n", fp);
}


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

        if (!isprint(firstc))
                return(-1);                             /* messed up */
        ungetc(firstc, fp);
        for ( ; ; ) {
                int     rval = 0;
                buf[MAXLINE-2] = '\n';
                if (fgets(buf, MAXLINE, fp) == NULL)
                        return(-1);
                if (buf[buf[0]=='\r'] == '\n')          /* end of header? */
                        return(rtotal);
                if (buf[MAXLINE-2] != '\n') {
                        ungetc(buf[MAXLINE-2], fp);     /* prevent false end */
                        buf[MAXLINE-2] = '\0';
                }
                if (f != NULL && (rval = (*f)(buf, p)) < 0)
                        return(-1);
                rtotal += rval;
        }
}


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


static int
mycheck(                        /* check a header line for format info. */
        char  *s,
        void  *cp
)
{
        struct check    *scp = (struct check *)cp;

        if (!formatval(scp->fs, s) && scp->fp != NULL)
                fputs(s, scp->fp);

        return(0);
}


int
globmatch(                      /* check for match of s against pattern p */
        const char      *p,
        const 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.
 */

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