]> diplodocus.org Git - nmh/blobdiff - uip/refile.c
Merge commit '8206fbf', due to my screwup of committing it on a detached
[nmh] / uip / refile.c
index 83e56395b6be6b3cdf0d3428366c8a6ba887c820..5d03d4d18569463807f9153ecdf760a5b0a3382e 100644 (file)
@@ -3,51 +3,39 @@
  * refile.c -- move or link message(s) from a source folder
  *          -- into one or more destination folders
  *
- * $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>
+#include <h/utils.h>
 #include <fcntl.h>
-#include <errno.h>
 
-/*
- * We allocate spaces for messages (msgs array)
- * this number of elements at a time.
- */
-#define MAXMSGS  256
-
-
-static struct swit switches[] = {
-#define        DRAFTSW          0
-    { "draft", 0 },
-#define        LINKSW           1
-    { "link", 0 },
-#define        NLINKSW          2
-    { "nolink", 0 },
-#define        PRESSW           3
-    { "preserve", 0 },
-#define        NPRESSW          4
-    { "nopreserve", 0 },
-#define UNLINKSW         5
-    { "unlink", 0 },
-#define NUNLINKSW        6
-    { "nounlink", 0 },
-#define        SRCSW            7
-    { "src +folder", 0 },
-#define        FILESW           8
-    { "file file", 0 },
-#define        RPROCSW          9
-    { "rmmproc program", 0 },
-#define        NRPRCSW         10
-    { "normmproc", 0 },
-#define VERSIONSW       11
-    { "version", 0 },
-#define        HELPSW          12
-    { "help", 4 },
-    { NULL, 0 }
-};
-
-extern int errno;
+#define REFILE_SWITCHES \
+    X("draft", 0, DRAFTSW) \
+    X("link", 0, LINKSW) \
+    X("nolink", 0, NLINKSW) \
+    X("preserve", 0, PRESSW) \
+    X("nopreserve", 0, NPRESSW) \
+    X("retainsequences", 0, RETAINSEQSSW) \
+    X("noretainsequences", 0, NRETAINSEQSSW) \
+    X("unlink", 0, UNLINKSW) \
+    X("nounlink", 0, NUNLINKSW) \
+    X("src +folder", 0, SRCSW) \
+    X("file file", 0, FILESW) \
+    X("rmmproc program", 0, RPROCSW) \
+    X("normmproc", 0, NRPRCSW) \
+    X("version", 0, VERSIONSW) \
+    X("help", 0, HELPSW) \
+
+#define X(sw, minchars, id) id,
+DEFINE_SWITCH_ENUM(REFILE);
+#undef X
+
+#define X(sw, minchars, id) { sw, minchars, id },
+DEFINE_SWITCH_ARRAY(REFILE, switches);
+#undef X
 
 static char maildir[BUFSIZ];
 
@@ -59,80 +47,74 @@ struct st_fold {
 /*
  * static prototypes
  */
-static void opnfolds (struct st_fold *, int);
+static void opnfolds (struct msgs *, struct st_fold *, int);
 static void clsfolds (struct st_fold *, int);
 static void remove_files (int, char **);
-static int m_file (char *, struct st_fold *, int, int);
+static int m_file (struct msgs *, char *, int, struct st_fold *, int, int, int);
+static void copy_seqs (struct msgs *, int, struct msgs *, int);
 
 
 int
 main (int argc, char **argv)
 {
-    int        linkf = 0, preserve = 0, filep = 0;
+    int linkf = 0, preserve = 0, retainseqs = 0, filep = 0;
     int foldp = 0, isdf = 0, unlink_msgs = 0;
-    int i, msgnum, nummsgs, maxmsgs;
+    int i, msgnum;
     char *cp, *folder = NULL, buf[BUFSIZ];
-    char **argp, **arguments, **msgs;
+    char **argp, **arguments;
     char *filevec[NFOLDERS + 2];
     char **files = &filevec[1];           /* leave room for remove_files:vec[0] */
     struct st_fold folders[NFOLDERS + 1];
+    struct msgs_array msgs = { 0, 0, NULL };
     struct msgs *mp;
 
-#ifdef LOCALE
-    setlocale(LC_ALL, "");
-#endif
-    invo_name = r1bindex (argv[0], '/');
-
-    /* read user profile/context */
-    context_read();
+    if (nmh_init(argv[0], 1)) { return 1; }
 
     arguments = getarguments (invo_name, argc, argv, 1);
     argp = arguments;
 
-    /*
-     * Allocate the initial space to record message
-     * names, ranges, and sequences.
-     */
-    nummsgs = 0;
-    maxmsgs = MAXMSGS;
-    if (!(msgs = (char **) malloc ((size_t) (maxmsgs * sizeof(*msgs)))))
-       adios (NULL, "unable to allocate storage");
-
     /*
      * Parse arguments
      */
     while ((cp = *argp++)) {
        if (*cp == '-') {
            switch (smatch (++cp, switches)) {
-           case AMBIGSW: 
+           case AMBIGSW:
                ambigsw (cp, switches);
                done (1);
-           case UNKWNSW: 
+           case UNKWNSW:
                adios (NULL, "-%s unknown\n", cp);
 
-           case HELPSW: 
+           case HELPSW:
                snprintf (buf, sizeof(buf), "%s [msgs] [switches] +folder ...",
                          invo_name);
                print_help (buf, switches, 1);
-               done (1);
+               done (0);
            case VERSIONSW:
                print_version(invo_name);
-               done (1);
+               done (0);
 
-           case LINKSW: 
+           case LINKSW:
                linkf++;
                continue;
-           case NLINKSW: 
+           case NLINKSW:
                linkf = 0;
                continue;
 
-           case PRESSW: 
+           case PRESSW:
                preserve++;
                continue;
-           case NPRESSW: 
+           case NPRESSW:
                preserve = 0;
                continue;
 
+           case RETAINSEQSSW:
+               retainseqs = 1;
+               continue;
+           case NRETAINSEQSSW:
+               retainseqs = 0;
+               continue;
+
            case UNLINKSW:
                unlink_msgs++;
                continue;
@@ -140,7 +122,7 @@ main (int argc, char **argv)
                unlink_msgs = 0;
                continue;
 
-           case SRCSW: 
+           case SRCSW:
                if (folder)
                    adios (NULL, "only one source folder at a time!");
                if (!(cp = *argp++) || *cp == '-')
@@ -154,7 +136,7 @@ main (int argc, char **argv)
                isdf = 0;
                files[filep++] = getcpy (m_draft (NULL, NULL, 1, &isdf));
                continue;
-           case FILESW: 
+           case FILESW:
                if (filep > NFOLDERS)
                    adios (NULL, "only %d files allowed!", NFOLDERS);
                if (!(cp = *argp++) || *cp == '-')
@@ -162,11 +144,11 @@ main (int argc, char **argv)
                files[filep++] = path (cp, TFILE);
                continue;
 
-           case RPROCSW: 
+           case RPROCSW:
                if (!(rmmproc = *argp++) || *rmmproc == '-')
                    adios (NULL, "missing argument to %s", argp[-2]);
                continue;
-           case NRPRCSW: 
+           case NRPRCSW:
                rmmproc = NULL;
                continue;
            }
@@ -175,20 +157,9 @@ main (int argc, char **argv)
            if (foldp > NFOLDERS)
                adios (NULL, "only %d folders allowed!", NFOLDERS);
            folders[foldp++].f_name =
-               path (cp + 1, *cp == '+' ? TFOLDER : TSUBCWF);
-       } else {
-           /*
-            * Check if we need to allocate more space
-            * for message names, ranges, and sequences.
-            */
-           if (nummsgs >= maxmsgs) {
-               maxmsgs += MAXMSGS;
-               if (!(msgs = (char **) realloc (msgs,
-                                               (size_t) (maxmsgs * sizeof(*msgs)))))
-                   adios (NULL, "unable to reallocate msgs storage");
-           }
-           msgs[nummsgs++] = cp;
-       }
+               pluspath (cp);
+       } else
+               app_msgarg(&msgs, cp);
     }
 
     if (!context_find ("path"))
@@ -196,20 +167,15 @@ main (int argc, char **argv)
     if (foldp == 0)
        adios (NULL, "no folder specified");
 
-#ifdef WHATNOW
-    if (!nummsgs && !foldp && !filep && (cp = getenv ("mhdraft")) && *cp)
-       files[filep++] = cp;
-#endif /* WHATNOW */
-
     /*
      * We are refiling a file to the folders
      */
     if (filep > 0) {
-       if (folder || nummsgs)
+       if (folder || msgs.size)
            adios (NULL, "use -file or some messages, not both");
-       opnfolds (folders, foldp);
+       opnfolds (NULL, folders, foldp);
        for (i = 0; i < filep; i++)
-           if (m_file (files[i], folders, foldp, preserve))
+           if (m_file (0, files[i], 0, folders, foldp, preserve, 0))
                done (1);
        /* If -nolink, then "remove" files */
        if (!linkf)
@@ -217,8 +183,8 @@ main (int argc, char **argv)
        done (0);
     }
 
-    if (!nummsgs)
-       msgs[nummsgs++] = "cur";
+    if (!msgs.size)
+       app_msgarg(&msgs, "cur");
     if (!folder)
        folder = getfolder (1);
     strncpy (maildir, m_maildir (folder), sizeof(maildir));
@@ -227,7 +193,7 @@ main (int argc, char **argv)
        adios (maildir, "unable to change directory to");
 
     /* read source folder and create message structure */
-    if (!(mp = folder_read (folder)))
+    if (!(mp = folder_read (folder, 1)))
        adios (NULL, "unable to read folder %s", folder);
 
     /* check for empty folder */
@@ -235,52 +201,68 @@ main (int argc, char **argv)
        adios (NULL, "no messages in %s", folder);
 
     /* parse the message range/sequence/name and set SELECTED */
-    for (msgnum = 0; msgnum < nummsgs; msgnum++)
-       if (!m_convert (mp, msgs[msgnum]))
+    for (msgnum = 0; msgnum < msgs.size; msgnum++)
+       if (!m_convert (mp, msgs.msgs[msgnum]))
            done (1);
     seq_setprev (mp);  /* set the previous-sequence */
 
     /* create folder structures for each destination folder */
-    opnfolds (folders, foldp);
+    opnfolds (mp, folders, foldp);
 
-    /* Link all the selected messages into destination folders */
+    /* Link all the selected messages into destination folders.
+     *
+     * This causes the add hook to be run for messages that are
+     * linked into another folder.  The refile hook is run for
+     * messages that are moved to another folder.
+     */
     for (msgnum = mp->lowsel; msgnum <= mp->hghsel; msgnum++) {
        if (is_selected (mp, msgnum)) {
            cp = getcpy (m_name (msgnum));
-           if (m_file (cp, folders, foldp, preserve))
+           if (m_file (mp, cp, retainseqs ? msgnum : 0, folders, foldp,
+                        preserve, !linkf))
                done (1);
            free (cp);
        }
     }
 
     /*
-     * This is a hack.  If we are using an external rmmproc,
-     * then save the current folder to the context file,
-     * so the external rmmproc will remove files from the correct
-     * directory.  This should be moved to folder_delmsgs().
+     * Update this now, since folder_delmsgs() will save the context
+     * but doesn't have access to the folder name.
      */
-    if (rmmproc) {
-       context_replace (pfolder, folder);
-       context_save ();
-       fflush (stdout);
-    }
 
-    /* If -nolink, then "remove" messages from source folder */
-    if (!linkf) {
-       folder_delmsgs (mp, unlink_msgs);
-    }
+    context_replace (pfolder, folder); /* update current folder   */
 
-    clsfolds (folders, foldp);
+    /*
+     * Adjust "cur" if necessary
+     */
 
     if (mp->hghsel != mp->curmsg
        && (mp->numsel != mp->nummsg || linkf))
        seq_setcur (mp, mp->hghsel);
-    seq_save (mp);     /* synchronize message sequences */
 
-    context_replace (pfolder, folder); /* update current folder   */
-    context_save ();                   /* save the context file   */
+    /*
+     * Close destination folders now; if we are using private sequences
+     * we need to have all of our calls to seq_save() complete before we
+     * call context_save().
+     */
+
+    clsfolds (folders, foldp);
+
+    /* If -nolink, then "remove" messages from source folder.
+     *
+     * Note that folder_delmsgs does not call the delete hook
+     * because the message has already been handled above.
+     */
+    if (!linkf) {
+       folder_delmsgs (mp, unlink_msgs, 1);
+    } else {
+       seq_save (mp);  /* synchronize message sequences */
+       context_save ();                        /* save the context file   */
+    }
+
     folder_free (mp);                  /* free folder structure   */
     done (0);
+    return 1;
 }
 
 
@@ -290,38 +272,41 @@ main (int argc, char **argv)
  */
 
 static void
-opnfolds (struct st_fold *folders, int nfolders)
+opnfolds (struct msgs *src_folder, struct st_fold *folders, int nfolders)
 {
-    register char *cp;
     char nmaildir[BUFSIZ];
     register struct st_fold *fp, *ep;
     register struct msgs *mp;
-    struct stat st;
 
     for (fp = folders, ep = folders + nfolders; fp < ep; fp++) {
-       chdir (m_maildir (""));
+       if (chdir (m_maildir ("")) < 0) {
+           advise (m_maildir (""), "chdir");
+       }
        strncpy (nmaildir, m_maildir (fp->f_name), sizeof(nmaildir));
 
-       if (stat (nmaildir, &st) == NOTOK) {
-           if (errno != ENOENT)
-               adios (nmaildir, "error on folder");
-           cp = concat ("Create folder \"", nmaildir, "\"? ", NULL);
-           if (!getanswer (cp))
-               done (1);
-           free (cp);
-           if (!makedir (nmaildir))
-               adios (NULL, "unable to create folder %s", nmaildir);
+       /*
+        * Null src_folder indicates that we are refiling a file to
+        * the folders, in which case we don't want to short-circuit
+        * fp->f_mp to any "source folder".
+        */
+       if (! src_folder  ||  strcmp (src_folder->foldpath, nmaildir)) {
+           create_folder (nmaildir, 0, done);
+
+           if (chdir (nmaildir) == NOTOK)
+               adios (nmaildir, "unable to change directory to");
+           if (!(mp = folder_read (fp->f_name, 1)))
+               adios (NULL, "unable to read folder %s", fp->f_name);
+           mp->curmsg = 0;
+
+           fp->f_mp = mp;
+       } else {
+           /* Source and destination folders are the same. */
+           fp->f_mp = src_folder;
        }
 
-       if (chdir (nmaildir) == NOTOK)
-           adios (nmaildir, "unable to change directory to");
-       if (!(mp = folder_read (fp->f_name)))
-           adios (NULL, "unable to read folder %s", fp->f_name);
-       mp->curmsg = 0;
-
-       fp->f_mp = mp;
-
-       chdir (maildir);
+       if (maildir[0] != '\0'  &&  chdir (maildir) < 0) {
+           advise (maildir, "chdir");
+       }
     }
 }
 
@@ -354,43 +339,80 @@ clsfolds (struct st_fold *folders, int nfolders)
 static void
 remove_files (int filep, char **files)
 {
-    int i;
-    char **vec;
+    int i, vecp;
+    char **vec, *program;
 
     /* If rmmproc is defined, we use that */
     if (rmmproc) {
-       vec = files++;          /* vec[0] = filevec[0] */
-       files[filep] = NULL;    /* NULL terminate list */
+       vec = argsplit(rmmproc, &program, &vecp);
+       files++;                /* Yes, we need to do this */
+       for (i = 0; i < filep; i++)
+               vec[vecp++] = files[i];
+       vec[vecp] = NULL;       /* NULL terminate list */
 
        fflush (stdout);
-       vec[0] = r1bindex (rmmproc, '/');
-       execvp (rmmproc, vec);
+       execvp (program, vec);
        adios (rmmproc, "unable to exec");
     }
 
     /* Else just unlink the files */
     files++;   /* advance past filevec[0] */
     for (i = 0; i < filep; i++) {
-       if (unlink (files[i]) == NOTOK)
+       if (m_unlink (files[i]) == NOTOK)
            admonish (files[i], "unable to unlink");
     }
 }
 
 
 /*
- * Link (or copy) the message into each of
- * the destination folders.
+ * Link (or copy) the message into each of the destination folders.
+ * If oldmsgnum is not 0, call copy_seqs().
  */
 
 static int
-m_file (char *msgfile, struct st_fold *folders, int nfolders, int preserve)
+m_file (struct msgs *mp, char *msgfile, int oldmsgnum,
+       struct st_fold *folders, int nfolders, int preserve, int refile)
 {
     int msgnum;
     struct st_fold *fp, *ep;
 
     for (fp = folders, ep = folders + nfolders; fp < ep; fp++) {
-       if ((msgnum = folder_addmsg (&fp->f_mp, msgfile, 1, 0, preserve)) == -1)
+       /*
+        * With same source and destination folder, don't indicate that
+        * the new message is selected so that 1) folder_delmsgs() doesn't
+        * delete it later and 2) it is not reflected in mp->hghsel, and
+        * therefore won't be assigned to be the current message.
+        */
+       if ((msgnum = folder_addmsg (&fp->f_mp, msgfile,
+                                    mp == fp->f_mp ? 0 : 1,
+                                    0, preserve, nfolders == 1 && refile,
+                                    maildir)) == -1)
            return 1;
+       if (oldmsgnum) copy_seqs (mp, oldmsgnum, fp->f_mp, msgnum);
     }
     return 0;
 }
+
+
+/*
+ * Copy sequence information for a refiled message to its
+ * new folder.  Skip the cur sequence.
+ */
+static void
+copy_seqs (struct msgs *oldmp, int oldmsgnum, struct msgs *newmp, int newmsgnum)
+{
+    char **seq;
+    size_t seqnum;
+
+    for (seq = svector_strs (oldmp->msgattrs), seqnum = 0;
+        *seq && seqnum < svector_size (oldmp->msgattrs);
+        ++seq, ++seqnum) {
+       if (strcmp (current, *seq)) {
+           assert ((int) seqnum == seq_getnum (oldmp, *seq));
+           if (in_sequence (oldmp, seqnum, oldmsgnum)) {
+               seq_addmsg (newmp, *seq, newmsgnum,
+                           is_seq_private (oldmp, seqnum) ? 0 : 1, 0);
+           }
+       }
+    }
+}