* movemail.c:
[bpt/emacs.git] / lib-src / movemail.c
index 866f0b0..daf8c61 100644 (file)
@@ -1,12 +1,13 @@
 /* movemail foo bar -- move file foo to file bar,
    locking file foo the way /bin/mail respects.
-   Copyright (C) 1986, 1992, 1993, 1994, 1996 Free Software Foundation, Inc.
+   Copyright (C) 1986, 1992, 1993, 1994, 1996, 1999, 2001, 2002, 2003, 2004,
+                 2005, 2006, 2007, 2008  Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
 GNU Emacs is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2, or (at your option)
+the Free Software Foundation; either version 3, or (at your option)
 any later version.
 
 GNU Emacs is distributed in the hope that it will be useful,
@@ -16,8 +17,8 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with GNU Emacs; see the file COPYING.  If not, write to
-the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.  */
+the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA.  */
 
 /* Important notice: defining MAIL_USE_FLOCK or MAIL_USE_LOCKF *will
    cause loss of mail* if you do it on a system that does not normally
@@ -39,11 +40,11 @@ Boston, MA 02111-1307, USA.  */
  * "po:username".  This will cause movemail to open a connection to
  * a pop server running on $MAILHOST (environment variable).  Movemail
  * must be setuid to root in order to work with POP.
- * 
+ *
  * New module: popmail.c
  * Modified routines:
  *     main - added code within #ifdef MAIL_USE_POP; added setuid (getuid ())
- *             after POP code. 
+ *             after POP code.
  * New routines in movemail.c:
  *     get_errmsg - return pointer to system error message
  *
@@ -55,14 +56,21 @@ Boston, MA 02111-1307, USA.  */
  */
 
 #define NO_SHORTNAMES   /* Tell config not to load remap.h */
-#include <../src/config.h>
+#include <config.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <sys/file.h>
 #include <stdio.h>
 #include <errno.h>
-#include <../src/syswait.h>
+
 #include <getopt.h>
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+#ifdef HAVE_FCNTL_H
+#include <fcntl.h>
+#endif
+#include "syswait.h"
 #ifdef MAIL_USE_POP
 #include "pop.h"
 #endif
@@ -79,32 +87,31 @@ Boston, MA 02111-1307, USA.  */
 #endif
 
 #ifdef WINDOWSNT
+#include "ntlib.h"
 #undef access
 #undef unlink
 #define fork() 0
-#define sys_wait(var) (*(var) = 0)
+#define wait(var) (*(var) = 0)
 /* Unfortunately, Samba doesn't seem to properly lock Unix files even
    though the locking call succeeds (and indeed blocks local access from
    other NT programs).  If you have direct file access using an NFS
    client or something other than Samba, the locking call might work
-   properly - make sure it does before you enable this! */
-#define DISABLE_DIRECT_ACCESS
-#endif /* WINDOWSNT */
+   properly - make sure it does before you enable this!
+
+   [18-Feb-97 andrewi] I now believe my comment above to be incorrect,
+   since it was based on a misunderstanding of how locking calls are
+   implemented and used on Unix.  */
+//#define DISABLE_DIRECT_ACCESS
 
-#ifdef USG
 #include <fcntl.h>
-#include <unistd.h>
+#endif /* WINDOWSNT */
+
 #ifndef F_OK
 #define F_OK 0
 #define X_OK 1
 #define W_OK 2
 #define R_OK 4
 #endif
-#endif /* USG */
-
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
-#endif
 
 #if defined (XENIX) || defined (WINDOWSNT)
 #include <sys/locking.h>
@@ -123,7 +130,8 @@ extern int lk_open (), lk_close ();
 #endif
 
 #if !defined (MAIL_USE_SYSTEM_LOCK) && !defined (MAIL_USE_MMDF) && \
-       defined (HAVE_LIBMAIL) && defined (HAVE_MAILLOCK_H)
+       (defined (HAVE_LIBMAIL) || defined (HAVE_LIBLOCKFILE)) && \
+        defined (HAVE_MAILLOCK_H)
 #include <maillock.h>
 /* We can't use maillock unless we know what directory system mail
    files appear in. */
@@ -133,17 +141,16 @@ static char *mail_spool_name ();
 #endif
 #endif
 
-/* Cancel substitutions made by config.h for Emacs.  */
-#undef open
-#undef read
-#undef write
-#undef close
-
 #ifndef errno
 extern int errno;
 #endif
 char *strerror ();
-extern char *rindex ();
+#ifdef HAVE_INDEX
+extern char *index __P ((const char *, int));
+#endif
+#ifdef HAVE_RINDEX
+extern char *rindex __P((const char *, int));
+#endif
 
 void fatal ();
 void error ();
@@ -184,16 +191,33 @@ main (argc, argv)
   char *spool_name;
 #endif
 
+#ifdef MAIL_USE_POP
+  int pop_reverse_order = 0;
+# define ARGSTR "pr"
+#else /* ! MAIL_USE_POP */
+# define ARGSTR "p"
+#endif /* MAIL_USE_POP */
+
+#ifdef WINDOWSNT
+  /* Ensure all file i/o is in binary mode. */
+  _fmode = _O_BINARY;
+#endif
+
   delete_lockname = 0;
 
-  while ((c = getopt (argc, argv, "p")) != EOF)
+  while ((c = getopt (argc, argv, ARGSTR)) != EOF)
     {
       switch (c) {
+#ifdef MAIL_USE_POP
+      case 'r':
+       pop_reverse_order = 1;
+       break;
+#endif
       case 'p':
        preserve_mail++;
        break;
       default:
-       exit(1);
+       exit (EXIT_FAILURE);
       }
     }
 
@@ -205,14 +229,13 @@ main (argc, argv)
 #endif
       )
     {
-      fprintf (stderr, "Usage: movemail [-p] inbox destfile%s\n",
 #ifdef MAIL_USE_POP
-              " [POP-password]"
+      fprintf (stderr, "Usage: movemail [-p] inbox destfile%s\n",
+              " [POP-password]");
 #else
-              ""
+      fprintf (stderr, "Usage: movemail [-p] inbox destfile%s\n", "");
 #endif
-              );
-      exit (1);
+      exit (EXIT_FAILURE);
     }
 
   inname = argv[optind];
@@ -223,7 +246,7 @@ main (argc, argv)
 #endif
 
   if (*outname == 0)
-    fatal ("Destination file name is empty", 0);
+    fatal ("Destination file name is empty", 0, 0);
 
   /* Check access to output file.  */
   if (access (outname, F_OK) == 0 && access (outname, W_OK) != 0)
@@ -250,7 +273,8 @@ main (argc, argv)
       int status;
 
       status = popmail (inname + 3, outname, preserve_mail,
-                       (argc - optind == 3) ? argv[optind+2] : NULL);
+                       (argc - optind == 3) ? argv[optind+2] : NULL,
+                       pop_reverse_order);
       exit (status);
     }
 
@@ -312,7 +336,7 @@ main (argc, argv)
          if (desc < 0)
            {
              char *message = (char *) xmalloc (strlen (tempname) + 50);
-             sprintf (message, "%s--see source file lib-src/movemail.c",
+             sprintf (message, "creating %s, which would become the lock file",
                       tempname);
              pfatal_with_name (message);
            }
@@ -435,13 +459,15 @@ main (argc, argv)
 
          pfatal_with_name (inname);
        }
-  
+
       {
        char buf[1024];
 
        while (1)
          {
            nread = read (indesc, buf, sizeof buf);
+           if (nread < 0)
+             pfatal_with_name (inname);
            if (nread != write (outdesc, buf, nread))
              {
                int saved_errno = errno;
@@ -477,14 +503,8 @@ main (argc, argv)
 #ifdef MAIL_USE_SYSTEM_LOCK
       if (! preserve_mail)
        {
-#if defined (STRIDE) || defined (XENIX) || defined (WINDOWSNT)
-         /* Stride, xenix have file locking, but no ftruncate.
-            This mess will do. */
-         close (open (inname, O_CREAT | O_TRUNC | O_RDWR, 0666));
-#else
          ftruncate (indesc, 0L);
        }
-#endif /* STRIDE or XENIX */
 #endif /* MAIL_USE_SYSTEM_LOCK */
 
 #ifdef MAIL_USE_MMDF
@@ -513,12 +533,12 @@ main (argc, argv)
       if (spool_name)
        mailunlock ();
 #endif
-      exit (0);
+      exit (EXIT_SUCCESS);
     }
 
   wait (&status);
   if (!WIFEXITED (status))
-    exit (1);
+    exit (EXIT_FAILURE);
   else if (WRETCODE (status) != 0)
     exit (WRETCODE (status));
 
@@ -531,7 +551,7 @@ main (argc, argv)
 
 #endif /* ! DISABLE_DIRECT_ACCESS */
 
-  return 0;
+  return EXIT_SUCCESS;
 }
 
 #ifdef MAIL_USE_MAILLOCK
@@ -578,23 +598,29 @@ mail_spool_name (inname)
 /* Print error message and exit.  */
 
 void
-fatal (s1, s2)
-     char *s1, *s2;
+fatal (s1, s2, s3)
+     char *s1, *s2, *s3;
 {
   if (delete_lockname)
     unlink (delete_lockname);
-  error (s1, s2);
-  exit (1);
+  error (s1, s2, s3);
+  exit (EXIT_FAILURE);
 }
 
-/* Print error message.  `s1' is printf control string, `s2' is arg for it. */
+/* Print error message.  `s1' is printf control string, `s2' and `s3'
+   are args for it or null. */
 
 void
 error (s1, s2, s3)
      char *s1, *s2, *s3;
 {
   fprintf (stderr, "movemail: ");
-  fprintf (stderr, s1, s2, s3);
+  if (s3)
+    fprintf (stderr, s1, s2, s3);
+  else if (s2)
+    fprintf (stderr, s1, s2);
+  else
+    fprintf (stderr, s1);
   fprintf (stderr, "\n");
 }
 
@@ -602,17 +628,16 @@ void
 pfatal_with_name (name)
      char *name;
 {
-  char *s = concat ("", strerror (errno), " for %s");
-  fatal (s, name);
+  fatal ("%s for %s", strerror (errno), name);
 }
 
 void
 pfatal_and_delete (name)
      char *name;
 {
-  char *s = concat ("", strerror (errno), " for %s");
+  char *s = strerror (errno);
   unlink (name);
-  fatal (s, name);
+  fatal ("%s for %s", s, name);
 }
 
 /* Return a newly-allocated string whose contents concatenate those of s1, s2, s3.  */
@@ -640,7 +665,7 @@ xmalloc (size)
 {
   long *result = (long *) malloc (size);
   if (!result)
-    fatal ("virtual memory exhausted", 0);
+    fatal ("virtual memory exhausted", 0, 0);
   return result;
 }
 \f
@@ -667,13 +692,30 @@ FILE *sfi;
 FILE *sfo;
 char ibuffer[BUFSIZ];
 char obuffer[BUFSIZ];
-char Errmsg[80];
+char Errmsg[200];              /* POP errors, at least, can exceed
+                                  the original length of 80.  */
 
-popmail (user, outfile, preserve, password)
-     char *user;
+/*
+ * The full legal syntax for a POP mailbox specification for movemail
+ * is "po:username:hostname".  The ":hostname" is optional; if it is
+ * omitted, the MAILHOST environment variable will be consulted.  Note
+ * that by the time popmail() is called the "po:" has been stripped
+ * off of the front of the mailbox name.
+ *
+ * If the mailbox is in the form "po:username:hostname", then it is
+ * modified by this function -- the second colon is replaced by a
+ * null.
+ *
+ * Return a value suitable for passing to `exit'.
+ */
+
+int
+popmail (mailbox, outfile, preserve, password, reverse_order)
+     char *mailbox;
      char *outfile;
      int preserve;
      char *password;
+     int reverse_order;
 {
   int nmsgs, nbytes;
   register int i;
@@ -681,24 +723,30 @@ popmail (user, outfile, preserve, password)
   FILE *mbf;
   char *getenv ();
   popserver server;
+  int start, end, increment;
+  char *user, *hostname;
+
+  user = mailbox;
+  if ((hostname = index(mailbox, ':')))
+    *hostname++ = '\0';
 
-  server = pop_open (0, user, password, POP_NO_GETPASS);
+  server = pop_open (hostname, user, password, POP_NO_GETPASS);
   if (! server)
     {
-      error (pop_error);
-      return (1);
+      error ("Error connecting to POP server: %s", pop_error, 0);
+      return EXIT_FAILURE;
     }
 
   if (pop_stat (server, &nmsgs, &nbytes))
     {
-      error (pop_error);
-      return (1);
+      error ("Error getting message count from POP server: %s", pop_error, 0);
+      return EXIT_FAILURE;
     }
 
   if (!nmsgs)
     {
       pop_close (server);
-      return (0);
+      return EXIT_SUCCESS;
     }
 
   mbfi = open (outfile, O_WRONLY | O_CREAT | O_EXCL, 0666);
@@ -706,36 +754,49 @@ popmail (user, outfile, preserve, password)
     {
       pop_close (server);
       error ("Error in open: %s, %s", strerror (errno), outfile);
-      return (1);
+      return EXIT_FAILURE;
     }
   fchown (mbfi, getuid (), -1);
 
   if ((mbf = fdopen (mbfi, "wb")) == NULL)
     {
       pop_close (server);
-      error ("Error in fdopen: %s", strerror (errno));
+      error ("Error in fdopen: %s", strerror (errno), 0);
       close (mbfi);
       unlink (outfile);
-      return (1);
+      return EXIT_FAILURE;
     }
 
-  for (i = 1; i <= nmsgs; i++)
+  if (reverse_order)
+    {
+      start = nmsgs;
+      end = 1;
+      increment = -1;
+    }
+  else
+    {
+      start = 1;
+      end = nmsgs;
+      increment = 1;
+    }
+
+  for (i = start; i * increment <= end * increment; i += increment)
     {
       mbx_delimit_begin (mbf);
       if (pop_retr (server, i, mbf) != OK)
        {
-         error (Errmsg);
+         error ("%s", Errmsg, 0);
          close (mbfi);
-         return (1);
+         return EXIT_FAILURE;
        }
       mbx_delimit_end (mbf);
       fflush (mbf);
       if (ferror (mbf))
        {
-         error ("Error in fflush: %s", strerror (errno));
+         error ("Error in fflush: %s", strerror (errno), 0);
          pop_close (server);
          close (mbfi);
-         return (1);
+         return EXIT_FAILURE;
        }
     }
 
@@ -748,15 +809,15 @@ popmail (user, outfile, preserve, password)
 #ifdef BSD_SYSTEM
   if (fsync (mbfi) < 0)
     {
-      error ("Error in fsync: %s", strerror (errno));
-      return (1);
+      error ("Error in fsync: %s", strerror (errno), 0);
+      return EXIT_FAILURE;
     }
 #endif
 
   if (close (mbfi) == -1)
     {
-      error ("Error in close: %s", strerror (errno));
-      return (1);
+      error ("Error in close: %s", strerror (errno), 0);
+      return EXIT_FAILURE;
     }
 
   if (! preserve)
@@ -764,24 +825,25 @@ popmail (user, outfile, preserve, password)
       {
        if (pop_delete (server, i))
          {
-           error (pop_error);
+           error ("Error from POP server: %s", pop_error, 0);
            pop_close (server);
-           return (1);
+           return EXIT_FAILURE;
          }
       }
 
   if (pop_quit (server))
     {
-      error (pop_error);
-      return (1);
+      error ("Error from POP server: %s", pop_error, 0);
+      return EXIT_FAILURE;
     }
-    
-  return (0);
+
+  return EXIT_SUCCESS;
 }
 
 int
 pop_retr (server, msgno, arg)
      popserver server;
+     int msgno;
      FILE *arg;
 {
   extern char *strerror ();
@@ -790,17 +852,19 @@ pop_retr (server, msgno, arg)
 
   if (pop_retrieve_first (server, msgno, &line))
     {
-      strncpy (Errmsg, pop_error, sizeof (Errmsg));
+      char *error = concat ("Error from POP server: ", pop_error, "");
+      strncpy (Errmsg, error, sizeof (Errmsg));
       Errmsg[sizeof (Errmsg)-1] = '\0';
+      free(error);
       return (NOTOK);
     }
 
-  while (! (ret = pop_retrieve_next (server, &line)))
+  while ((ret = pop_retrieve_next (server, &line)) >= 0)
     {
       if (! line)
        break;
 
-      if (mbx_write (line, arg) != OK)
+      if (mbx_write (line, ret, arg) != OK)
        {
          strcpy (Errmsg, strerror (errno));
          pop_close (server);
@@ -810,8 +874,10 @@ pop_retr (server, msgno, arg)
 
   if (ret)
     {
-      strncpy (Errmsg, pop_error, sizeof (Errmsg));
+      char *error = concat ("Error from POP server: ", pop_error, "");
+      strncpy (Errmsg, error, sizeof (Errmsg));
       Errmsg[sizeof (Errmsg)-1] = '\0';
+      free(error);
       return (NOTOK);
     }
 
@@ -826,16 +892,26 @@ pop_retr (server, msgno, arg)
                         && (a[4] == ' '))
 
 int
-mbx_write (line, mbf)
+mbx_write (line, len, mbf)
      char *line;
+     int len;
      FILE *mbf;
 {
+#ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
   if (IS_FROM_LINE (line))
     {
       if (fputc ('>', mbf) == EOF)
        return (NOTOK);
     }
-  if (fputs (line, mbf) == EOF) 
+#endif
+  if (line[0] == '\037')
+    {
+      if (fputs ("^_", mbf) == EOF)
+       return (NOTOK);
+      line++;
+      len--;
+    }
+  if (fwrite (line, 1, len, mbf) != len)
     return (NOTOK);
   if (fputc (0x0a, mbf) == EOF)
     return (NOTOK);
@@ -851,6 +927,7 @@ mbx_delimit_begin (mbf)
   return (OK);
 }
 
+int
 mbx_delimit_end (mbf)
      FILE *mbf;
 {
@@ -875,3 +952,8 @@ strerror (errnum)
 }
 
 #endif /* ! HAVE_STRERROR */
+
+/* arch-tag: 1c323112-41fe-4fe5-8de9-494de631f73f
+   (do not change this comment) */
+
+/* movemail.c ends here */