3 * annosbr.c -- prepend annotation to messages
7 * This code is Copyright (c) 2002, by the authors of nmh. See the
8 * COPYRIGHT file in the root directory of the nmh distribution for
9 * complete copyright information.
22 static int annosbr (int, char *, char *, char *, int, int, int, int);
26 annotate (char *file, char *comp, char *text, int inplace, int datesw, int delete, int append)
30 /* open and lock the file to be annotated */
31 if ((fd = lkopen (file, O_RDWR, 0)) == NOTOK) {
37 admonish (file, "unable to lock and open");
43 i = annosbr (fd, file, comp, text, inplace, datesw, delete, append);
49 * Produce a listing of all header fields (annotations) whose field name matches
50 * comp. Number the listing if number is set. Treate the field bodies as path
51 * names and just output the last component unless text is non-NULL. We don't
52 * care what text is set to.
56 annolist(char *file, char *comp, char *text, int number)
58 int c; /* current character */
59 int count; /* header field (annotation) counter */
60 char *cp; /* miscellaneous character pointer */
61 char *field; /* buffer for header field */
62 int field_size; /* size of field buffer */
63 FILE *fp; /* file pointer made from locked file descriptor */
64 int length; /* length of field name */
65 int n; /* number of bytes written */
66 char *sp; /* another miscellaneous character pointer */
68 if ((fp = fopen(file, "r")) == (FILE *)0)
69 adios(file, "unable to open");
72 * Allocate a buffer to hold the header components as they're read in.
73 * This buffer might need to be quite large, so we grow it as needed.
76 if ((field = (char *)malloc(field_size = 256)) == (char *)0)
77 adios(NULL, "can't allocate field buffer.");
80 * Get the length of the field name since we use it often.
83 length = strlen(comp);
89 * Get a line from the input file, growing the field buffer as needed. We do this
90 * so that we can fit an entire line in the buffer making it easy to do a string
91 * comparison on both the field name and the field body which might be a long path
95 for (n = 0, cp = field; (c = getc(fp)) != EOF; *cp++ = c) {
96 if (c == '\n' && (c = getc(fp)) != ' ' && c != '\t') {
102 if (++n >= field_size - 1) {
103 if ((field = (char *)realloc((void *)field, field_size += 256)) == (char *)0)
104 adios(NULL, "can't grow field buffer.");
111 * NUL-terminate the field..
116 if (strncasecmp(field, comp, length) == 0 && field[length] == ':') {
117 for (cp = field + length + 1; *cp == ' ' || *cp == '\t'; cp++)
121 (void)printf("%d\t", ++count);
123 if (text == (char *)0 && (sp = strrchr(cp, '/')) != (char *)0)
126 (void)printf("%s\n", cp);
129 } while (*field != '\0' && *field != '-');
144 annosbr (int fd, char *file, char *comp, char *text, int inplace, int datesw, int delete, int append)
148 char buffer[BUFSIZ], tmpfil[BUFSIZ];
151 int c; /* current character */
152 int count; /* header field (annotation) counter */
153 char *field; /* buffer for header field */
154 int field_size; /* size of field buffer */
155 FILE *fp; /* file pointer made from locked file descriptor */
156 int length; /* length of field name */
157 int n; /* number of bytes written */
159 mode = fstat (fd, &st) != NOTOK ? (st.st_mode & 0777) : m_gmprot ();
161 strncpy (tmpfil, m_scratch (file, "annotate"), sizeof(tmpfil));
163 if ((tmp = fopen (tmpfil, "w")) == NULL) {
164 admonish (tmpfil, "unable to create");
167 chmod (tmpfil, mode);
170 * We're going to need to copy some of the message file to the temporary
171 * file while examining the contents. Convert the message file descriptor
172 * to a file pointer since it's a lot easier and more efficient to use
173 * stdio for this. Also allocate a buffer to hold the header components
174 * as they're read in. This buffer is grown as needed later.
177 if (delete >= 0 || append != 0) {
178 if ((fp = fdopen(fd, "r")) == (FILE *)0)
179 adios(NULL, "unable to fdopen file.");
181 if ((field = (char *)malloc(field_size = 256)) == (char *)0)
182 adios(NULL, "can't allocate field buffer.");
186 * We're trying to delete a header field (annotation )if the delete flag is
187 * non-negative. A value greater than zero means that we're deleting the
188 * nth header field that matches the field (component) name. A value of
189 * zero means that we're deleting the first field in which both the field
190 * name matches the component name and the field body matches the text.
191 * The text is matched in its entirety if it begins with a slash; otherwise
192 * the text is matched against whatever portion of the field body follows
193 * the last slash. This allows matching of both absolute and relative path
194 * names. This is because this functionality was added to support attachments.
195 * It might be worth having a separate flag to indicate path name matching to
196 * make it more general.
201 * Get the length of the field name since we use it often.
204 length = strlen(comp);
207 * Initialize the field counter. This is only used if we're deleting by
214 * Copy lines from the input file to the temporary file until we either find the one
215 * that we're looking for (which we don't copy) or we reach the end of the headers.
216 * Both a blank line and a line beginning with a - terminate the headers so that we
217 * can handle both drafts and RFC-2822 format messages.
222 * Get a line from the input file, growing the field buffer as needed. We do this
223 * so that we can fit an entire line in the buffer making it easy to do a string
224 * comparison on both the field name and the field body which might be a long path
228 for (n = 0, cp = field; (c = getc(fp)) != EOF; *cp++ = c) {
229 if (c == '\n' && (c = getc(fp)) != ' ' && c != '\t') {
235 if (++n >= field_size - 1) {
236 if ((field = (char *)realloc((void *)field, field_size *= 2)) == (char *)0)
237 adios(NULL, "can't grow field buffer.");
244 * NUL-terminate the field..
250 * Check for a match on the field name. We delete the line by not copying it to the
253 * o The delete flag is 0, meaning that we're going to delete the first matching
254 * field, and the text is NULL meaning that we don't care about the field body.
256 * o The delete flag is 0, meaning that we're going to delete the first matching
257 * field, and the text begins with a / meaning that we're looking for a full
258 * path name, and the text matches the field body.
260 * o The delete flag is 0, meaning that we're going to delete the first matching
261 * field, the text does not begin with a / meaning that we're looking for the
262 * last path name component, and the last path name component matches the text.
264 * o The delete flag is non-zero meaning that we're going to delete the nth field
265 * with a matching field name, and this is the nth matching field name.
268 if (strncasecmp(field, comp, length) == 0 && field[length] == ':') {
270 if (text == (char *)0)
273 for (cp = field + length + 1; *cp == ' ' || *cp == '\t'; cp++)
277 if (strcmp(cp, text) == 0)
281 if ((sp = strrchr(cp, '/')) != (char *)0)
284 if (strcmp(cp, text) == 0)
289 else if (++count == delete)
294 * This line wasn't a match so copy it to the temporary file.
297 if ((n = fputs(field, tmp)) == EOF || (c == '\n' && fputc('\n', tmp) == EOF))
298 adios(NULL, "unable to write temporary file.");
300 } while (*field != '\0' && *field != '-');
303 * Get rid of the field buffer because we're done with it.
311 * Find the end of the headers before adding the annotations if we're
312 * appending instead of the default prepending.
317 * Copy lines from the input file to the temporary file until we
318 * reach the end of the headers.
321 while ((c = getc(fp)) != EOF) {
325 (void)ungetc(c = getc(fp), fp);
327 if (c == '\n' || c == '-')
334 fprintf (tmp, "%s: %s\n", comp, dtimenow (0));
337 while (*cp == ' ' || *cp == '\t')
340 while (*cp && *cp++ != '\n')
343 fprintf (tmp, "%s: %*.*s", comp, cp - sp, cp - sp, sp);
345 if (cp[-1] != '\n' && cp != text)
353 * We've been messing with the input file position. Move the input file
354 * descriptor to the current place in the file because the stock data
355 * copying routine uses the descriptor, not the pointer.
358 if (append || delete >= 0) {
359 if (lseek(fd, (off_t)ftell(fp), SEEK_SET) == (off_t)-1)
360 adios(NULL, "can't seek.");
363 cpydata (fd, fileno (tmp), file, tmpfil);
367 if ((tmpfd = open (tmpfil, O_RDONLY)) == NOTOK)
368 adios (tmpfil, "unable to open for re-reading");
370 lseek (fd, (off_t) 0, SEEK_SET);
373 * We're making the file shorter if we're deleting a header field
374 * so the file has to be truncated or it will contain garbage.
377 if (delete >= 0 && ftruncate(fd, 0) == -1)
378 adios(tmpfil, "unable to truncate.");
380 cpydata (tmpfd, fd, tmpfil, file);
384 strncpy (buffer, m_backup (file), sizeof(buffer));
385 if (rename (file, buffer) == NOTOK) {
387 case ENOENT: /* unlinked early - no annotations */
392 admonish (buffer, "unable to rename %s to", file);
397 if (rename (tmpfil, file) == NOTOK) {
398 admonish (file, "unable to rename %s to", tmpfil);
404 * Close the delete file so that we don't run out of file pointers if
405 * we're doing piles of files. Note that this will make the close() in
406 * lkclose() fail, but that failure is ignored so it's not a problem.