Removed leading space from lines in mhbuild and rmm man pages
[mmh] / uip / burst.c
index 4f654fb..6316e13 100644 (file)
@@ -2,7 +2,9 @@
 /*
  * burst.c -- explode digests into individual messages
  *
- * $Id$
+ * This code is Copyright (c) 2002, by the authors of nmh.  See the
+ * COPYRIGHT file in the root directory of the nmh distribution for
+ * complete copyright information.
  */
 
 #include <h/mh.h>
@@ -27,20 +29,28 @@ static struct swit switches[] = {
     { NULL, 0 }
 };
 
-static char delim3[] = "-------";
-
 struct smsg {
-    long s_start;
-    long s_stop;
+    off_t s_start;
+    off_t s_stop;
 };
 
 /*
  * static prototypes
  */
 static int find_delim (int, struct smsg *);
-static void burst (struct msgs **, int, struct smsg *, int, int, int);
+static void burst (struct msgs **, int, struct smsg *, int, int, int, char *);
 static void cpybrst (FILE *, FILE *, char *, char *, int);
 
+/*
+ * A macro to check to see if we have reached a message delimiter
+ * (an encapsulation boundary, EB, in RFC 934 parlance).
+ *
+ * According to RFC 934, an EB is simply a line which starts with
+ * a "-" and is NOT followed by a space.  So even a single "-" on a line
+ * by itself would be an EB.
+ */
+
+#define CHECKDELIM(buffer) (buffer[0] == '-' && buffer[1] != ' ')
 
 int
 main (int argc, char **argv)
@@ -76,10 +86,10 @@ main (int argc, char **argv)
                snprintf (buf, sizeof(buf), "%s [+folder] [msgs] [switches]",
                        invo_name);
                print_help (buf, switches, 1);
-               done (1);
+               done (0);
            case VERSIONSW:
                print_version(invo_name);
-               done (1);
+               done (0);
 
            case INPLSW: 
                inplace++;
@@ -107,7 +117,7 @@ main (int argc, char **argv)
            if (folder)
                adios (NULL, "only one folder at a time!");
            else
-               folder = path (cp + 1, *cp == '+' ? TFOLDER : TSUBCWF);
+               folder = pluspath (cp);
        } else {
            msgs[msgp++] = cp;
        }
@@ -152,7 +162,7 @@ main (int argc, char **argv)
                if (verbosw)
                    printf ("%d message%s exploded from digest %d\n",
                            numburst, numburst > 1 ? "s" : "", msgnum);
-               burst (&mp, msgnum, smsgs, numburst, inplace, verbosw);
+               burst (&mp, msgnum, smsgs, numburst, inplace, verbosw, maildir);
            } else {
                if (numburst == 0) {
                    if (!quietsw)
@@ -185,7 +195,8 @@ main (int argc, char **argv)
     seq_save (mp);     /* synchronize message sequences */
     context_save ();   /* save the context file         */
     folder_free (mp);  /* free folder/message structure */
-    return done (0);
+    done (0);
+    return 1;
 }
 
 
@@ -197,38 +208,56 @@ main (int argc, char **argv)
 static int
 find_delim (int msgnum, struct smsg *smsgs)
 {
-    int ld3, wasdlm, msgp;
-    long pos;
+    int wasdlm = 0, msgp;
+    off_t pos;
     char c, *msgnam;
-    int cc;
     char buffer[BUFSIZ];
     FILE *in;
 
-    ld3 = strlen (delim3);
-
     if ((in = fopen (msgnam = m_name (msgnum), "r")) == NULL)
        adios (msgnam, "unable to read message");
 
     for (msgp = 0, pos = 0L; msgp <= MAXFOLDER;) {
+       /*
+        * We're either at the beginning of the whole message, or
+        * we're just past the delimiter of the last message.
+        * Swallow lines until we get to something that's not a newline
+        */
        while (fgets (buffer, sizeof(buffer), in) && buffer[0] == '\n')
            pos += (long) strlen (buffer);
        if (feof (in))
            break;
-       fseek (in, pos, SEEK_SET);
+
+       /*
+        * Reset to the beginning of the last non-blank line, and save our
+        * starting position.  This is where the encapsulated message
+        * starts.
+        */
+       fseeko (in, pos, SEEK_SET);
        smsgs[msgp].s_start = pos;
 
+       /*
+        * Read in lines until we get to a message delimiter.
+        *
+        * Previously we checked to make sure the preceeding line and
+        * next line was a newline.  That actually does not comply with
+        * RFC 934, so make sure we break on a message delimiter even
+        * if the previous character was NOT a newline.
+        */
        for (c = 0; fgets (buffer, sizeof(buffer), in); c = buffer[0]) {
-           if (strncmp (buffer, delim3, ld3) == 0
-                   && (msgp == 1 || c == '\n')
-                   && ((cc = peekc (in)) == '\n' || cc == EOF))
+           if ((wasdlm = CHECKDELIM(buffer)))
                break;
            else
                pos += (long) strlen (buffer);
        }
 
-       wasdlm = strncmp (buffer, delim3, ld3) == 0;
-       if (smsgs[msgp].s_start != pos)
+       /*
+        * Only count as a new message if we got the message delimiter.
+        * Swallow a blank line if it was right before the message delimiter.
+        */
+       if (smsgs[msgp].s_start != pos && wasdlm)
            smsgs[msgp++].s_stop = (c == '\n' && wasdlm) ? pos - 1 : pos;
+
        if (feof (in)) {
 #if 0
            if (wasdlm) {
@@ -242,7 +271,7 @@ find_delim (int msgnum, struct smsg *smsgs)
     }
 
     fclose (in);
-    return (msgp - 1);         /* toss "End of XXX Digest" */
+    return (msgp - 1);         /* return the number of messages burst */
 }
 
 
@@ -252,7 +281,7 @@ find_delim (int msgnum, struct smsg *smsgs)
 
 static void
 burst (struct msgs **mpp, int msgnum, struct smsg *smsgs, int numburst,
-       int inplace, int verbosw)
+       int inplace, int verbosw, char *maildir)
 {
     int i, j, mode;
     char *msgnam;
@@ -264,7 +293,8 @@ burst (struct msgs **mpp, int msgnum, struct smsg *smsgs, int numburst,
     if ((in = fopen (msgnam = m_name (msgnum), "r")) == NULL)
        adios (msgnam, "unable to read message");
 
-    mode = fstat (fileno(in), &st) != NOTOK ? (st.st_mode & 0777) : m_gmprot();
+    mode =
+      fstat (fileno(in), &st) != NOTOK ? (int) (st.st_mode & 0777) : m_gmprot();
     mp = *mpp;
 
     /*
@@ -292,6 +322,9 @@ burst (struct msgs **mpp, int msgnum, struct smsg *smsgs, int numburst,
      * If -inplace is given, renumber the messages after the
      * source message, to make room for each of the messages
      * contained within the digest.
+     *
+     * This is equivalent to refiling a message from the point
+     * of view of the external hooks.
      */
     if (inplace) {
        for (i = mp->hghmsg; j > msgnum; i--, j--) {
@@ -303,6 +336,11 @@ burst (struct msgs **mpp, int msgnum, struct smsg *smsgs, int numburst,
 
                if (rename (f2, f1) == NOTOK)
                    admonish (f1, "unable to rename %s to", f2);
+
+               (void)snprintf(f1, sizeof (f1), "%s/%d", maildir, i);
+               (void)snprintf(f2, sizeof (f2), "%s/%d", maildir, j);
+               ext_hook("ref-hook", f1, f2);
+
                copy_msg_flags (mp, i, j);
                clear_msg_flags (mp, j);
                mp->msgflags |= SEQMOD;
@@ -312,18 +350,35 @@ burst (struct msgs **mpp, int msgnum, struct smsg *smsgs, int numburst,
     
     unset_selected (mp, msgnum);
 
-    /* new hghmsg is hghmsg + numburst */
+    /* new hghmsg is hghmsg + numburst
+     *
+     * At this point, there is an array of numburst smsgs, each element of
+     * which contains the starting and stopping offsets (seeks) of the message
+     * in the digest.  The inplace flag is set if the original digest is replaced
+     * by a message containing the table of contents.  smsgs[0] is that table of
+     * contents.  Go through the message numbers in reverse order (high to low).
+     *
+     * Set f1 to the name of the destination message, f2 to the name of a scratch
+     * file.  Extract a message from the digest to the scratch file.  Move the
+     * original message to a backup file if the destination message number is the
+     * same as the number of the original message, which only happens if the
+     * inplace flag is set.  Then move the scratch file to the destination message.
+     *
+     * Moving the original message to the backup file is equivalent to deleting the
+     * message from the point of view of the external hooks.  And bursting each
+     * message is equivalent to adding a new message.
+     */
+
     i = inplace ? msgnum + numburst : mp->hghmsg;
     for (j = numburst; j >= (inplace ? 0 : 1); i--, j--) {
        strncpy (f1, m_name (i), sizeof(f1));
-       strncpy (f2, m_scratch ("", invo_name), sizeof(f2));
+       strncpy (f2, m_mktemp(invo_name, NULL, &out), sizeof(f2));
+
        if (verbosw && i != msgnum)
            printf ("message %d of digest %d becomes message %d\n", j, msgnum, i);
 
-       if ((out = fopen (f2, "w")) == NULL)
-           adios (f2, "unable to write message");
        chmod (f2, mode);
-       fseek (in, smsgs[j].s_start, SEEK_SET);
+       fseeko (in, smsgs[j].s_start, SEEK_SET);
        cpybrst (in, out, msgnam, f2,
                (int) (smsgs[j].s_stop - smsgs[j].s_start));
        fclose (out);
@@ -332,9 +387,16 @@ burst (struct msgs **mpp, int msgnum, struct smsg *smsgs, int numburst,
            strncpy (f3, m_backup (f1), sizeof(f3));
            if (rename (f1, f3) == NOTOK)
                admonish (f3, "unable to rename %s to", f1);
+
+           (void)snprintf(f3, sizeof (f3), "%s/%d", maildir, i);
+           ext_hook("del-hook", f3, (char *)0);
        }
        if (rename (f2, f1) == NOTOK)
            admonish (f1, "unable to rename %s to", f2);
+
+       (void)snprintf(f3, sizeof (f3), "%s/%d", maildir, i);
+       ext_hook("add-hook", f3, (char *)0);
+
        copy_msg_flags (mp, i, msgnum);
        mp->msgflags |= SEQMOD;
     }