Renamed -version switch to -Version to remove the conflict with -verbose.
[mmh] / uip / anno.c
index 68d721a..7ede7e0 100644 (file)
@@ -5,71 +5,45 @@
 ** COPYRIGHT file in the root directory of the nmh distribution for
 ** complete copyright information.
 **
-** Three new options have been added: delete, list, and number.
-** Message header fields are used by the new MIME attachment code in
-** the send command.  Adding features to generalize the anno command
-** seemed to be a better approach than the creation of a new command
-** whose features would overlap with those of the anno command.
-**
-** The -delete option deletes header elements that match the -component
-** field name.  If -delete is used without the -text option, the first
-** header field whose field name matches the component name is deleted.
-** If the -delete is used with the -text option, and the -text argument
-** begins with a /, the first header field whose field name matches the
-** component name and whose field body matches the text is deleted.  If
-** the -text argument does not begin with a /, then the text is assumed
-** to be the last component of a path name, and the first header field
-** whose field name matches the component name and a field body whose
-** last path name component matches the text is deleted.  If the -delete
-** option is used with the new -number option described below, the nth
-** header field whose field name matches the component name is deleted.
-** No header fields are deleted if none of the above conditions are met.
-**
-** The -list option outputs the field bodies from each header field whose
-** field name matches the component name, one per line.  If no -text
-** option is specified, only the last path name component of each field
-** body is output.  The entire field body is output if the -text option
-** is used; the contents of the -text argument are ignored.  If the -list
-** option is used in conjuction with the new -number option described
-** below, each line is numbered starting with 1.  A tab separates the
-** number from the field body.
-**
-** The -number option works with both the -delete and -list options as
-** described above.  The -number option takes an optional argument.  A
-** value of 1 is assumed if this argument is absent.
+** Three new options have been added: delete, list, and number. Adding
+** features to generalize the anno command seemed to be a better approach
+** than the creation of a new command whose features would overlap with
+** those of the anno command.
 */
 
 #include <h/mh.h>
 #include <h/utils.h>
+#include <h/tws.h>
+#include <fcntl.h>
+#include <errno.h>
+#include <utime.h>
+
+static enum { MODE_ADD, MODE_DEL, MODE_LIST } mode = MODE_ADD;
 
 static struct swit switches[] = {
 #define COMPSW 0
        { "component field", 0 },
-#define INPLSW 1
-       { "inplace", 0 },
-#define NINPLSW 2
-       { "noinplace", 0 },
-#define DATESW 3
+#define DATESW 1
        { "date", 0 },
-#define NDATESW 4
+#define NDATESW 2
        { "nodate", 0 },
-#define TEXTSW 5
+#define TEXTSW 3
        { "text body", 0 },
-#define VERSIONSW 6
-       { "version", 0 },
-#define HELPSW 7
+#define VERSIONSW 4
+       { "Version", 0 },
+#define HELPSW 5
        { "help", 0 },
-#define LISTSW 8
+#define LISTSW 6
        { "list", 1 },
-#define DELETESW 9
+#define DELETESW 7
        { "delete", 2 },
-#define NUMBERSW 10
+#define NUMBERSW 8
        { "number", 2 },
-#define APPENDSW 11
+#define APPENDSW 9
        { "append", 1 },
-#define PRESERVESW 12
+#define PRESERVESW 10
        { "preserve", 1 },
-#define NOPRESERVESW 13
+#define NOPRESERVESW 11
        { "nopreserve", 3 },
        { NULL, 0 }
 };
@@ -78,30 +52,32 @@ static struct swit switches[] = {
 ** static prototypes
 */
 static void make_comp(unsigned char **);
+static int annotate(char *, unsigned char *, char *, int, int, int, int);
+static void annolist(char *, unsigned char *, int);
+static void dodel(int, unsigned char *, char *, FILE *, int);
+static void doadd(int, unsigned char *, char *, FILE *, int, int);
 
 
 int
 main(int argc, char **argv)
 {
-       int inplace = 1, datesw = 1;
+       int datesw = 1;
+       int preserve = 0;
        int msgnum;
        char *cp, *maildir;
        unsigned char *comp = NULL;
        char *text = NULL, *folder = NULL, buf[BUFSIZ];
+       char *file = NULL;
        char **argp, **arguments;
        struct msgs_array msgs = { 0, 0, NULL };
        struct msgs *mp;
        int append = 0;  /* append annotations instead of default prepend */
-       int delete = -2;  /* delete header element if set */
-       int list = 0;  /* list header elements if set */
        int number = 0; /* delete specific number of like elements if set */
 
 #ifdef LOCALE
        setlocale(LC_ALL, "");
 #endif
        invo_name = mhbasename(argv[0]);
-
-       /* read user profile/context */
        context_read();
 
        arguments = getarguments(invo_name, argc, argv, 1);
@@ -126,6 +102,14 @@ main(int argc, char **argv)
                                print_version(invo_name);
                                done(1);
 
+                       case DELETESW:  /* delete annotations */
+                               mode = MODE_DEL;
+                               continue;
+
+                       case LISTSW:  /* produce a listing */
+                               mode = MODE_LIST;
+                               continue;
+
                        case COMPSW:
                                if (comp)
                                        adios(NULL, "only one component at a time!");
@@ -134,20 +118,6 @@ main(int argc, char **argv)
                                                        argp[-2]);
                                continue;
 
-                       case DATESW:
-                               datesw++;
-                               continue;
-                       case NDATESW:
-                               datesw = 0;
-                               continue;
-
-                       case INPLSW:
-                               inplace++;
-                               continue;
-                       case NINPLSW:
-                               inplace = 0;
-                               continue;
-
                        case TEXTSW:
                                if (text)
                                        adios(NULL, "only one body at a time!");
@@ -156,44 +126,51 @@ main(int argc, char **argv)
                                                        argp[-2]);
                                continue;
 
-                       case DELETESW:  /* delete annotations */
-                               delete = 0;
-                               continue;
-
-                       case LISTSW:  /* produce a listing */
-                               list = 1;
-                               continue;
-
                        case NUMBERSW: /* number listing or delete by number */
-                               if (number != 0)
-                                       adios(NULL, "only one number at a time!");
-
-                               if (argp-arguments == argc-1 || **argp == '-')
+                               if (mode == MODE_ADD) {
+                                       adios(NULL, "-number switch must appear after -list or -delete, only.");
+                               }
+                               if (mode == MODE_LIST) {
                                        number = 1;
-
-                               else {
-                                               if (strcmp(*argp, "all") == 0)
-                                                       number = -1;
-
-                                               else if (!(number = atoi(*argp)))
-                                               adios(NULL, "missing argument to %s", argp[-2]);
-
+                                       continue;
+                               }
+                               /* MODE_DEL */
+                               if (number) {
+                                       adios(NULL, "only one number at a time!");
+                               }
+                               if (*argp && strcmp(*argp, "all")==0) {
+                                       number = -1;
                                        argp++;
+                                       continue;
                                }
+                               if (!*argp || !(number = atoi(*argp))) {
+                                       adios(NULL, "missing argument to %s",
+                                                       argp[-1]);
+                               }
+                               if (number < 0) {
+                                       adios(NULL, "invalid number (%d).",
+                                                       number);
+                               }
+                               argp++;
+                               continue;
 
-                               delete = number;
+                       case DATESW:
+                               datesw++;
+                               continue;
+                       case NDATESW:
+                               datesw = 0;
                                continue;
 
-                       case APPENDSW:  /* append annotations instead of default prepend */
+                       case APPENDSW:
                                append = 1;
                                continue;
 
-                       case PRESERVESW:  /* preserve access and modification times on annotated message */
-                               annopreserve(1);
+                       case PRESERVESW:
+                               preserve = 1;
                                continue;
 
-                       case NOPRESERVESW:  /* don't preserve access and modification times on annotated message (default) */
-                               annopreserve(0);
+                       case NOPRESERVESW:
+                               preserve = 0;
                                continue;
                        }
                }
@@ -202,8 +179,32 @@ main(int argc, char **argv)
                                adios(NULL, "only one folder at a time!");
                        else
                                folder = getcpy(expandfol(cp));
-               } else
+               } else if (*cp == '/' || *cp == '.') {
+                       if (file)
+                               adios(NULL, "only one file at a time!");
+                       file = cp;
+               } else {
                        app_msgarg(&msgs, cp);
+               }
+       }
+
+       if (file && (folder || msgs.size)) {
+               adios(NULL, "Don't intermix files and messages.");
+       }
+       if (!datesw && !text) {
+               adios(NULL, "-nodate without -text is a no-op.");
+       }
+       if (number && text) {
+               adios(NULL, "Don't combine -number with -text.");
+       }
+
+       if (file) {
+               if (mode == MODE_LIST)
+                       annolist(file, comp, number);
+               else
+                       annotate(file, comp, text, datesw, number,
+                                       append, preserve);
+               done(0);
        }
 
        if (!msgs.size)
@@ -228,23 +229,22 @@ main(int argc, char **argv)
                if (!m_convert(mp, msgs.msgs[msgnum]))
                        done(1);
 
-       make_comp(&comp);
-
        /* annotate all the SELECTED messages */
        for (msgnum = mp->lowsel; msgnum <= mp->hghsel; msgnum++) {
                if (is_selected(mp, msgnum)) {
-                       if (list)
-                               annolist(m_name(msgnum), comp, text, number);
+                       if (mode == MODE_LIST)
+                               annolist(m_name(msgnum), comp, number);
                        else
-                               annotate(m_name(msgnum), comp, text, inplace, datesw, delete, append);
+                               annotate(m_name(msgnum), comp, text, datesw,
+                                               number, append, preserve);
                }
        }
 
-       context_replace(curfolder, folder);  /* update current folder  */
-       seq_setcur(mp, mp->lowsel);  /* update current message */
-       seq_save(mp);  /* synchronize message sequences */
-       folder_free(mp);  /* free folder/message structure */
-       context_save();  /* save the context file */
+       context_replace(curfolder, folder);
+       seq_setcur(mp, mp->lowsel);
+       seq_save(mp);
+       folder_free(mp);
+       context_save();
        done(0);
        return 1;
 }
@@ -252,20 +252,21 @@ main(int argc, char **argv)
 static void
 make_comp(unsigned char **ap)
 {
-       register unsigned char *cp;
+       unsigned char *cp;
        char buffer[BUFSIZ];
 
-       if (*ap == NULL) {
+       if (!*ap) {
                printf("Enter component name: ");
                fflush(stdout);
 
-               if (fgets(buffer, sizeof buffer, stdin) == NULL)
+               if (!fgets(buffer, sizeof buffer, stdin)) {
                        done(1);
+               }
                *ap = trimcpy(buffer);
        }
 
        if ((cp = *ap + strlen(*ap) - 1) > *ap && *cp == ':')
-               *cp = 0;
+               *cp = '\0';
        if (strlen(*ap) == 0)
                adios(NULL, "null component name");
        if (**ap == '-')
@@ -277,3 +278,366 @@ make_comp(unsigned char **ap)
                if (!isalnum(*cp) && *cp != '-')
                        adios(NULL, "invalid component name %s", *ap);
 }
+
+
+/*
+**  Produce a listing of all header fields (annotations) whose field
+**  name matches comp.  Number the listing if number is set.
+*/
+static void
+annolist(char *file, unsigned char *comp, int number)
+{
+       int c;
+       int count = 1;  /* header field (annotation) counter */
+       char *cp;
+       char *field;
+       int field_size;
+       FILE *fp;
+       int length;
+       int n;  /* number of bytes written */
+
+       if ((fp = fopen(file, "r")) == NULL) {
+               adios(file, "unable to open");
+       }
+
+       /* We'll grow this buffer as needed. */
+       field = (char *)mh_xmalloc(field_size = 256);
+
+       make_comp(&comp);
+       length = strlen(comp); /* Convenience copy. */
+
+       do {
+               /*
+               ** Get a line from the input file, growing the field buffer
+               ** as needed.  We do this so that we can fit an entire line
+               ** in the buffer making it easy to do a string comparison
+               ** on both the field name and the field body which might be
+               ** a long path name.
+               */
+               for (n = 0, cp = field; (c = getc(fp)) != EOF; *cp++ = c) {
+                       if (c == '\n' && (c = getc(fp)) != ' ' && c != '\t') {
+                               ungetc(c, fp);
+                               c = '\n';
+                               break;
+                       }
+                       if (++n >= field_size - 1) {
+                               field = (char *)mh_xrealloc(field,
+                                               field_size += 256);
+                               cp = field + n - 1;
+                       }
+               }
+               *cp = '\0';
+
+               if (strncasecmp(field, comp, length)==0 &&
+                               field[length] == ':') {
+                       for (cp = field + length + 1;
+                                       *cp == ' ' || *cp == '\t'; cp++) {
+                               continue;
+                       }
+                       if (number) {
+                               printf("%d\t", count++);
+                       }
+                       printf("%s\n", cp);
+               }
+
+       } while (*field && *field != '-');
+
+       free(field);
+       fclose(fp);
+
+       return;
+}
+
+
+static int
+annotate(char *file, unsigned char *comp, char *text, int datesw,
+               int number, int append, int preserve)
+{
+       int fd;
+       struct utimbuf b;
+       int perms, tmpfd;
+       char tmpfil[BUFSIZ];
+       struct stat st;
+       FILE *tmp;
+
+       /* open and lock the file to be annotated */
+       if ((fd = lkopen(file, O_RDWR, 0)) == NOTOK) {
+               switch (errno) {
+               case ENOENT:
+                       break;
+               default:
+                       admonish(file, "unable to lock and open");
+                       break;
+               }
+               return 1;
+       }
+
+       if (stat(file, &st) == -1) {
+               advise("can't get access and modification times for %s", file);
+               preserve = 0;
+       }
+       b.actime = st.st_atime;
+       b.modtime = st.st_mtime;
+
+       perms = fstat(fd, &st) != NOTOK ?
+                       (int)(st.st_mode & 0777) : m_gmprot();
+
+       strncpy(tmpfil, m_mktemp2(file, "annotate", NULL, &tmp),
+                       sizeof(tmpfil));
+       chmod(tmpfil, perms);
+
+       make_comp(&comp);
+
+       if (mode == MODE_DEL) {
+               dodel(fd, comp, text, tmp, number);
+       }
+       if (mode == MODE_ADD) {
+               doadd(fd, comp, text, tmp, datesw, append);
+       }
+
+       cpydata(fd, fileno(tmp), file, tmpfil);
+       fclose(tmp);
+
+       if ((tmpfd = open(tmpfil, O_RDONLY)) == NOTOK) {
+               adios(tmpfil, "unable to open for re-reading");
+       }
+       lseek(fd, (off_t) 0, SEEK_SET);
+
+       /*
+       **  We're making the file shorter if we're deleting a header field
+       **  so the file has to be truncated or it will contain garbage.
+       */
+       if (mode == MODE_DEL && ftruncate(fd, 0) == -1) {
+               adios(tmpfil, "unable to truncate.");
+       }
+       cpydata(tmpfd, fd, tmpfil, file);
+       close(tmpfd);
+       unlink(tmpfil);
+
+       if (preserve && utime(file, &b) == -1) {
+               advise("can't set access and modification times for %s", file);
+       }
+       lkclose(fd, file);
+       return 0;
+}
+
+/*
+** We're trying to delete a header field (annotation).
+**
+** - If number is greater than zero,
+**   we're deleting the nth header field that matches
+**   the field (component) name.
+** - If number is zero and text is NULL,
+**   we're deleting the first field in which the field name
+**   matches the component name.
+** - If number is zero and text is set,
+**   we're deleting the first field in which both the field name
+**   matches the component name and the field body matches the text.
+** - If number is -1,
+**   we delete all matching fields.
+*/
+static void
+dodel(int fd, unsigned char *comp, char *text, FILE *tmp, int number)
+{
+       int length = strlen(comp);  /* convenience copy */
+       int count = 1;  /* Number of matching header line. */
+       int c, n;
+       char *cp;
+       char *field = NULL;
+       int field_size = 256;
+       FILE *fp;
+
+       /*
+       ** We're going to need to copy some of the message file to the
+       ** temporary file while examining the contents.  Convert the
+       ** message file descriptor to a file pointer since it's a lot
+       ** easier and more efficient to use stdio for this.  Also allocate
+       ** a buffer to hold the header components as they're read in.
+       ** This buffer is grown as needed later.
+       */
+       if ((fp = fdopen(fd, "r")) == NULL) {
+               adios(NULL, "unable to fdopen file.");
+       }
+       field = (char *)mh_xmalloc(field_size);
+
+       /*
+       **  Copy lines from the input file to the temporary file
+       **  until we either find the one that we're looking
+       **  for (which we don't copy) or we reach the end of
+       **  the headers.  Both a blank line and a line beginning
+       **  with a - terminate the headers so that we can handle
+       **  both drafts and RFC-2822 format messages.
+       */
+       do {
+               /*
+               ** Get a line from the input file, growing the
+               ** field buffer as needed.  We do this so that
+               ** we can fit an entire line in the buffer making
+               ** it easy to do a string comparison on both the
+               ** field name and the field body which might be
+               ** a long path name.
+               */
+               for (n=0, cp=field; (c=getc(fp)) != EOF; *cp++ = c) {
+                       if (c == '\n' && (c = getc(fp)) != ' ' &&
+                                       c != '\t') {
+                               ungetc(c, fp);
+                               c = '\n';
+                               break;
+                       }
+
+                       if (++n >= field_size - 1) {
+                               field = (char *) mh_xrealloc(field,
+                                               field_size *= 2);
+                               cp = field + n - 1;
+                       }
+               }
+               *cp = '\0';
+
+               if (strncasecmp(field, comp, length)==0 &&
+                               field[length] == ':') {
+                       /*
+                       ** This component matches and thus is a candidate.
+                       ** We delete the line by not copying it to the
+                       ** temporary file. Thus:
+                       ** - Break if we've found the one to delete.
+                       ** - Continue if this is one to delete, but
+                       **   there'll be further ones.
+                       */
+
+                       if (!number && !text) {
+                               /* this first one is it */
+                               break;
+                       }
+
+                       if (number == -1) {
+                               /* delete all of them */
+                               continue;
+                       } else if (number == count++) {
+                               /* delete this specific one */
+                               break;
+                       }
+
+                       if (text) {
+                               /* delete the first matching one */
+                               cp = field+length+1;
+                               while (*cp==' ' || *cp=='\t') {
+                                       cp++;  /* eat leading whitespace */
+                               }
+                               if (*text == '/' && strcmp(text, cp)==0) {
+                                       break;  /* full path matches */
+                               } else if (strcmp(text, mhbasename(cp))==0) {
+                                       break;  /* basename matches */
+                               }
+                       }
+                       /*
+                       ** Although the compoment name mached, it
+                       ** wasn't the right one.
+                       */
+               }
+
+               /* Copy it. */
+               if ((n = fputs(field, tmp)) == EOF ||
+                               (c=='\n' && fputc('\n', tmp)==EOF)) {
+                       adios(NULL, "unable to write temporary file.");
+               }
+
+       } while (*field && *field != '-');
+
+       free(field);
+
+       fflush(tmp);
+       fflush(fp); /* The underlying fd will be closed by lkclose() */
+
+       /*
+       ** We've been messing with the input file position.  Move the
+       ** input file descriptor to the current place in the file
+       ** because the stock data copying routine uses the descriptor,
+       ** not the pointer.
+       */
+       if (lseek(fd, (off_t)ftell(fp), SEEK_SET) == (off_t)-1) {
+               adios(NULL, "can't seek.");
+       }
+}
+
+
+static void
+doadd(int fd, unsigned char *comp, char *text, FILE *tmp, int datesw,
+               int append)
+{
+       char *cp, *sp;
+       int c;
+       FILE *fp = NULL;
+
+       if (append) {
+               /*
+               ** We're going to need to copy some of the message
+               ** file to the temporary file while examining the
+               ** contents.  Convert the message file descriptor to
+               ** a file pointer since it's a lot easier and more
+               ** efficient to use stdio for this.  Also allocate
+               ** a buffer to hold the header components as they're
+               ** read in.  This buffer is grown as needed later.
+               */
+               if ((fp = fdopen(fd, "r")) == NULL) {
+                       adios(NULL, "unable to fdopen file.");
+               }
+               /* Find the end of the headers. */
+               if ((c = getc(fp)) == '\n') {
+                       /* Special check for no headers is needed. */
+                       rewind(fp);
+               } else {
+                       /*
+                       ** Copy lines from the input file to the
+                       ** temporary file until we reach the end
+                       ** of the headers.
+                       */
+                       putc(c, tmp);
+                       while ((c = getc(fp)) != EOF) {
+                               putc(c, tmp);
+                               if (c == '\n') {
+                                       ungetc(c = getc(fp), fp);
+                                       if (c == '\n' || c == '-') {
+                                               break;
+                                       }
+                               }
+                       }
+               }
+       }
+
+       if (datesw) {
+               fprintf(tmp, "%s: %s\n", comp, dtimenow());
+       }
+       if ((cp = text)) {
+               /* Add body text header */
+               do {
+                       while (*cp == ' ' || *cp == '\t') {
+                               cp++;
+                       }
+                       sp = cp;
+                       while (*cp && *cp++ != '\n') {
+                               continue;
+                       }
+                       if (cp - sp) {
+                               fprintf(tmp, "%s: %*.*s", comp,
+                                       (int)(cp - sp),
+                                       (int)(cp - sp), sp);
+                       }
+               } while (*cp);
+               if (cp[-1] != '\n' && cp != text) {
+                       putc('\n', tmp);
+               }
+       }
+       fflush(tmp);
+
+       /*
+       ** We've been messing with the input file position.  Move the
+       ** input file descriptor to the current place in the file
+       ** because the stock data copying routine uses the descriptor,
+       ** not the pointer.
+       */
+       if (append) {
+               if (lseek(fd, (off_t)ftell(fp), SEEK_SET) == (off_t)-1) {
+                       adios(NULL, "can't seek.");
+               }
+       }
+}