1 /* movemail foo bar -- move file foo to file bar,
2 locking file foo the way /bin/mail respects.
4 Copyright (C) 1986, 1992-1994, 1996, 1999, 2001-2011
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 /* Important notice: defining MAIL_USE_FLOCK or MAIL_USE_LOCKF *will
24 cause loss of mail* if you do it on a system that does not normally
25 use flock as its way of interlocking access to inbox files. The
26 setting of MAIL_USE_FLOCK and MAIL_USE_LOCKF *must agree* with the
27 system's own conventions. It is not a choice that is up to you.
29 So, if your system uses lock files rather than flock, then the only way
30 you can get proper operation is to enable movemail to write lockfiles there.
31 This means you must either give that directory access modes
32 that permit everyone to write lockfiles in it, or you must make movemail
33 a setuid or setgid program. */
36 * Modified January, 1986 by Michael R. Gretzinger (Project Athena)
38 * Added POP (Post Office Protocol) service. When compiled -DMAIL_USE_POP
39 * movemail will accept input filename arguments of the form
40 * "po:username". This will cause movemail to open a connection to
41 * a pop server running on $MAILHOST (environment variable). Movemail
42 * must be setuid to root in order to work with POP.
44 * New module: popmail.c
46 * main - added code within #ifdef MAIL_USE_POP; added setuid (getuid ())
48 * New routines in movemail.c:
49 * get_errmsg - return pointer to system error message
51 * Modified August, 1993 by Jonathan Kamens (OpenVision Technologies)
53 * Move all of the POP code into a separate file, "pop.c".
54 * Use strerror instead of get_errmsg.
59 #include <sys/types.h>
88 #define wait(var) (*(var) = 0)
89 /* Unfortunately, Samba doesn't seem to properly lock Unix files even
90 though the locking call succeeds (and indeed blocks local access from
91 other NT programs). If you have direct file access using an NFS
92 client or something other than Samba, the locking call might work
93 properly - make sure it does before you enable this!
95 [18-Feb-97 andrewi] I now believe my comment above to be incorrect,
96 since it was based on a misunderstanding of how locking calls are
97 implemented and used on Unix. */
98 //#define DISABLE_DIRECT_ACCESS
101 #endif /* WINDOWSNT */
111 #include <sys/locking.h>
114 #ifdef MAIL_USE_LOCKF
115 #define MAIL_USE_SYSTEM_LOCK
118 #ifdef MAIL_USE_FLOCK
119 #define MAIL_USE_SYSTEM_LOCK
123 extern int lk_open (), lk_close ();
126 #if !defined (MAIL_USE_SYSTEM_LOCK) && !defined (MAIL_USE_MMDF) && \
127 (defined (HAVE_LIBMAIL) || defined (HAVE_LIBLOCKFILE)) && \
128 defined (HAVE_MAILLOCK_H)
129 #include <maillock.h>
130 /* We can't use maillock unless we know what directory system mail
133 #define MAIL_USE_MAILLOCK
134 static char *mail_spool_name (char *);
138 #ifndef HAVE_STRERROR
139 char *strerror (int);
142 static void fatal (const char *s1
, const char *s2
, const char *s3
) NO_RETURN
;
143 static void error (const char *s1
, const char *s2
, const char *s3
);
144 static void pfatal_with_name (char *name
) NO_RETURN
;
145 static void pfatal_and_delete (char *name
) NO_RETURN
;
146 static char *concat (const char *s1
, const char *s2
, const char *s3
);
147 static long *xmalloc (unsigned int size
);
149 static int popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
);
150 static int pop_retr (popserver server
, int msgno
, FILE *arg
);
151 static int mbx_write (char *line
, int len
, FILE *mbf
);
152 static int mbx_delimit_begin (FILE *mbf
);
153 static int mbx_delimit_end (FILE *mbf
);
156 /* Nonzero means this is name of a lock file to delete on fatal error. */
157 static char *delete_lockname
;
160 main (int argc
, char **argv
)
162 char *inname
, *outname
;
166 int c
, preserve_mail
= 0;
168 #ifndef MAIL_USE_SYSTEM_LOCK
173 size_t inname_dirlen
;
175 #endif /* not MAIL_USE_SYSTEM_LOCK */
177 #ifdef MAIL_USE_MAILLOCK
182 int pop_reverse_order
= 0;
184 #else /* ! MAIL_USE_POP */
186 #endif /* MAIL_USE_POP */
188 uid_t real_gid
= getgid();
189 uid_t priv_gid
= getegid();
192 /* Ensure all file i/o is in binary mode. */
198 while ((c
= getopt (argc
, argv
, ARGSTR
)) != EOF
)
203 pop_reverse_order
= 1;
216 (argc
- optind
< 2) || (argc
- optind
> 3)
223 fprintf (stderr
, "Usage: movemail [-p] [-r] inbox destfile%s\n",
226 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n", "");
231 inname
= argv
[optind
];
232 outname
= argv
[optind
+1];
239 fatal ("Destination file name is empty", 0, 0);
242 if (!strncmp (inname
, "po:", 3))
246 status
= popmail (inname
+ 3, outname
, preserve_mail
,
247 (argc
- optind
== 3) ? argv
[optind
+2] : NULL
,
252 if (setuid (getuid ()) < 0)
253 fatal ("Failed to drop privileges", 0, 0);
255 #endif /* MAIL_USE_POP */
257 #ifndef DISABLE_DIRECT_ACCESS
258 #ifndef MAIL_USE_MMDF
259 #ifndef MAIL_USE_SYSTEM_LOCK
260 #ifdef MAIL_USE_MAILLOCK
261 spool_name
= mail_spool_name (inname
);
271 #ifndef DIRECTORY_SEP
272 #define DIRECTORY_SEP '/'
274 #ifndef IS_DIRECTORY_SEP
275 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
278 /* Use a lock file named after our first argument with .lock appended:
279 If it exists, the mail file is locked. */
280 /* Note: this locking mechanism is *required* by the mailer
281 (on systems which use it) to prevent loss of mail.
283 On systems that use a lock file, extracting the mail without locking
284 WILL occasionally cause loss of mail due to timing errors!
286 So, if creation of the lock file fails
287 due to access permission on the mail spool directory,
288 you simply MUST change the permission
289 and/or make movemail a setgid program
290 so it can create lock files properly.
292 You might also wish to verify that your system is one
293 which uses lock files for this purpose. Some systems use other methods.
295 If your system uses the `flock' system call for mail locking,
296 define MAIL_USE_SYSTEM_LOCK in config.h or the s-*.h file
297 and recompile movemail. If the s- file for your system
298 should define MAIL_USE_SYSTEM_LOCK but does not, send a bug report
299 to bug-gnu-emacs@prep.ai.mit.edu so we can fix it. */
301 lockname
= concat (inname
, ".lock", "");
302 for (inname_dirlen
= strlen (inname
);
303 inname_dirlen
&& !IS_DIRECTORY_SEP (inname
[inname_dirlen
- 1]);
306 tempname
= (char *) xmalloc (inname_dirlen
+ sizeof "EXXXXXX");
310 /* Create the lock file, but not under the lock file name. */
311 /* Give up if cannot do that. */
313 memcpy (tempname
, inname
, inname_dirlen
);
314 strcpy (tempname
+ inname_dirlen
, "EXXXXXX");
316 desc
= mkstemp (tempname
);
324 desc
= open (tempname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
329 int mkstemp_errno
= errno
;
330 char *message
= (char *) xmalloc (strlen (tempname
) + 50);
331 sprintf (message
, "creating %s, which would become the lock file",
333 errno
= mkstemp_errno
;
334 pfatal_with_name (message
);
338 tem
= link (tempname
, lockname
);
341 if (tem
< 0 && errno
== EPERM
)
342 fatal ("Unable to create hard link between %s and %s",
351 /* If lock file is five minutes old, unlock it.
352 Five minutes should be good enough to cope with crashes
353 and wedgitude, and long enough to avoid being fooled
354 by time differences between machines. */
355 if (stat (lockname
, &st
) >= 0)
357 time_t now
= time (0);
358 if (st
.st_ctime
< now
- 300)
363 delete_lockname
= lockname
;
365 #endif /* not MAIL_USE_SYSTEM_LOCK */
366 #endif /* not MAIL_USE_MMDF */
372 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
379 if (setuid (getuid ()) < 0 || setregid (-1, real_gid
) < 0)
380 fatal ("Failed to drop privileges", 0, 0);
382 #ifndef MAIL_USE_MMDF
383 #ifdef MAIL_USE_SYSTEM_LOCK
384 indesc
= open (inname
, O_RDWR
);
385 #else /* if not MAIL_USE_SYSTEM_LOCK */
386 indesc
= open (inname
, O_RDONLY
);
387 #endif /* not MAIL_USE_SYSTEM_LOCK */
388 #else /* MAIL_USE_MMDF */
389 indesc
= lk_open (inname
, O_RDONLY
, 0, 0, 10);
390 #endif /* MAIL_USE_MMDF */
393 pfatal_with_name (inname
);
396 /* In case movemail is setuid to root, make sure the user can
397 read the output file. */
398 /* This is desirable for all systems
399 but I don't want to assume all have the umask system call */
400 umask (umask (0) & 0333);
401 #endif /* BSD_SYSTEM */
402 outdesc
= open (outname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
404 pfatal_with_name (outname
);
406 if (setregid (-1, priv_gid
) < 0)
407 fatal ("Failed to regain privileges", 0, 0);
409 /* This label exists so we can retry locking
410 after a delay, if it got EAGAIN or EBUSY. */
413 /* Try to lock it. */
414 #ifdef MAIL_USE_MAILLOCK
417 /* The "0 - " is to make it a negative number if maillock returns
419 status
= 0 - maillock (spool_name
, 1);
420 #ifdef HAVE_TOUCHLOCK
421 touched_lock
= time (0);
426 #endif /* MAIL_USE_MAILLOCK */
428 #ifdef MAIL_USE_SYSTEM_LOCK
429 #ifdef MAIL_USE_LOCKF
430 status
= lockf (indesc
, F_LOCK
, 0);
431 #else /* not MAIL_USE_LOCKF */
433 status
= locking (indesc
, LK_RLCK
, -1L);
435 status
= flock (indesc
, LOCK_EX
);
437 #endif /* not MAIL_USE_LOCKF */
438 #endif /* MAIL_USE_SYSTEM_LOCK */
441 /* If it fails, retry up to 5 times
442 for certain failure codes. */
445 if (++lockcount
<= 5)
463 pfatal_with_name (inname
);
471 nread
= read (indesc
, buf
, sizeof buf
);
473 pfatal_with_name (inname
);
474 if (nread
!= write (outdesc
, buf
, nread
))
476 int saved_errno
= errno
;
479 pfatal_with_name (outname
);
481 if (nread
< sizeof buf
)
483 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
486 time_t now
= time (0);
487 if (now
- touched_lock
> 60)
493 #endif /* MAIL_USE_MAILLOCK */
498 if (fsync (outdesc
) < 0)
499 pfatal_and_delete (outname
);
502 /* Prevent symlink attacks truncating other users' mailboxes */
503 if (setregid (-1, real_gid
) < 0)
504 fatal ("Failed to drop privileges", 0, 0);
506 /* Check to make sure no errors before we zap the inbox. */
507 if (close (outdesc
) != 0)
508 pfatal_and_delete (outname
);
510 #ifdef MAIL_USE_SYSTEM_LOCK
513 if (ftruncate (indesc
, 0L) != 0)
514 pfatal_with_name (inname
);
516 #endif /* MAIL_USE_SYSTEM_LOCK */
519 lk_close (indesc
, 0, 0, 0);
524 #ifndef MAIL_USE_SYSTEM_LOCK
527 /* Delete the input file; if we can't, at least get rid of its
529 #ifdef MAIL_UNLINK_SPOOL
530 /* This is generally bad to do, because it destroys the permissions
531 that were set on the file. Better to just empty the file. */
532 if (unlink (inname
) < 0 && errno
!= ENOENT
)
533 #endif /* MAIL_UNLINK_SPOOL */
534 creat (inname
, 0600);
536 #endif /* not MAIL_USE_SYSTEM_LOCK */
538 /* End of mailbox truncation */
539 if (setregid (-1, priv_gid
) < 0)
540 fatal ("Failed to regain privileges", 0, 0);
542 #ifdef MAIL_USE_MAILLOCK
543 /* This has to occur in the child, i.e., in the process that
544 acquired the lock! */
552 if (!WIFEXITED (wait_status
))
554 else if (WRETCODE (wait_status
) != 0)
555 exit (WRETCODE (wait_status
));
557 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
558 #ifdef MAIL_USE_MAILLOCK
560 #endif /* MAIL_USE_MAILLOCK */
562 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
564 #endif /* ! DISABLE_DIRECT_ACCESS */
569 #ifdef MAIL_USE_MAILLOCK
570 /* This function uses stat to confirm that the mail directory is
571 identical to the directory of the input file, rather than just
572 string-comparing the two paths, because one or both of them might
573 be symbolic links pointing to some other directory. */
575 mail_spool_name (char *inname
)
577 struct stat stat1
, stat2
;
581 if (! (fname
= strrchr (inname
, '/')))
586 if (stat (MAILDIR
, &stat1
) < 0)
589 indir
= (char *) xmalloc (fname
- inname
+ 1);
590 strncpy (indir
, inname
, fname
- inname
);
591 indir
[fname
-inname
] = '\0';
594 status
= stat (indir
, &stat2
);
601 if (stat1
.st_dev
== stat2
.st_dev
602 && stat1
.st_ino
== stat2
.st_ino
)
607 #endif /* MAIL_USE_MAILLOCK */
609 /* Print error message and exit. */
612 fatal (const char *s1
, const char *s2
, const char *s3
)
615 unlink (delete_lockname
);
620 /* Print error message. `s1' is printf control string, `s2' and `s3'
621 are args for it or null. */
624 error (const char *s1
, const char *s2
, const char *s3
)
626 fprintf (stderr
, "movemail: ");
628 fprintf (stderr
, s1
, s2
, s3
);
630 fprintf (stderr
, s1
, s2
);
632 fprintf (stderr
, "%s", s1
);
633 fprintf (stderr
, "\n");
637 pfatal_with_name (char *name
)
639 fatal ("%s for %s", strerror (errno
), name
);
643 pfatal_and_delete (char *name
)
645 char *s
= strerror (errno
);
647 fatal ("%s for %s", s
, name
);
650 /* Return a newly-allocated string whose contents concatenate those of s1, s2, s3. */
653 concat (const char *s1
, const char *s2
, const char *s3
)
655 size_t len1
= strlen (s1
), len2
= strlen (s2
), len3
= strlen (s3
);
656 char *result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
659 strcpy (result
+ len1
, s2
);
660 strcpy (result
+ len1
+ len2
, s3
);
661 *(result
+ len1
+ len2
+ len3
) = 0;
666 /* Like malloc but get fatal error if memory is exhausted. */
669 xmalloc (unsigned int size
)
671 long *result
= (long *) malloc (size
);
673 fatal ("virtual memory exhausted", 0, 0);
677 /* This is the guts of the interface to the Post Office Protocol. */
682 #include <sys/socket.h>
683 #include <netinet/in.h>
695 static char Errmsg
[200]; /* POP errors, at least, can exceed
696 the original length of 80. */
699 * The full valid syntax for a POP mailbox specification for movemail
700 * is "po:username:hostname". The ":hostname" is optional; if it is
701 * omitted, the MAILHOST environment variable will be consulted. Note
702 * that by the time popmail() is called the "po:" has been stripped
703 * off of the front of the mailbox name.
705 * If the mailbox is in the form "po:username:hostname", then it is
706 * modified by this function -- the second colon is replaced by a
709 * Return a value suitable for passing to `exit'.
713 popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
)
719 char *getenv (const char *);
721 int start
, end
, increment
;
722 char *user
, *hostname
;
725 if ((hostname
= strchr (mailbox
, ':')))
728 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
731 error ("Error connecting to POP server: %s", pop_error
, 0);
735 if (pop_stat (server
, &nmsgs
, &nbytes
))
737 error ("Error getting message count from POP server: %s", pop_error
, 0);
747 mbfi
= open (outfile
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
751 error ("Error in open: %s, %s", strerror (errno
), outfile
);
755 if (fchown (mbfi
, getuid (), -1) != 0)
757 int fchown_errno
= errno
;
759 if (fstat (mbfi
, &st
) != 0 || st
.st_uid
!= getuid ())
762 error ("Error in fchown: %s, %s", strerror (fchown_errno
), outfile
);
767 if ((mbf
= fdopen (mbfi
, "wb")) == NULL
)
770 error ("Error in fdopen: %s", strerror (errno
), 0);
789 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
791 mbx_delimit_begin (mbf
);
792 if (pop_retr (server
, i
, mbf
) != OK
)
794 error ("%s", Errmsg
, 0);
798 mbx_delimit_end (mbf
);
802 error ("Error in fflush: %s", strerror (errno
), 0);
809 /* On AFS, a call to write only modifies the file in the local
810 * workstation's AFS cache. The changes are not written to the server
811 * until a call to fsync or close is made. Users with AFS home
812 * directories have lost mail when over quota because these checks were
813 * not made in previous versions of movemail. */
816 if (fsync (mbfi
) < 0)
818 error ("Error in fsync: %s", strerror (errno
), 0);
823 if (close (mbfi
) == -1)
825 error ("Error in close: %s", strerror (errno
), 0);
830 for (i
= 1; i
<= nmsgs
; i
++)
832 if (pop_delete (server
, i
))
834 error ("Error from POP server: %s", pop_error
, 0);
840 if (pop_quit (server
))
842 error ("Error from POP server: %s", pop_error
, 0);
850 pop_retr (popserver server
, int msgno
, FILE *arg
)
855 if (pop_retrieve_first (server
, msgno
, &line
))
857 char *msg
= concat ("Error from POP server: ", pop_error
, "");
858 strncpy (Errmsg
, msg
, sizeof (Errmsg
));
859 Errmsg
[sizeof (Errmsg
)-1] = '\0';
864 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
869 if (mbx_write (line
, ret
, arg
) != OK
)
871 strcpy (Errmsg
, strerror (errno
));
879 char *msg
= concat ("Error from POP server: ", pop_error
, "");
880 strncpy (Errmsg
, msg
, sizeof (Errmsg
));
881 Errmsg
[sizeof (Errmsg
)-1] = '\0';
890 mbx_write (char *line
, int len
, FILE *mbf
)
892 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
893 /* Do this as a macro instead of using strcmp to save on execution time. */
894 # define IS_FROM_LINE(a) ((a[0] == 'F') \
899 if (IS_FROM_LINE (line
))
901 if (fputc ('>', mbf
) == EOF
)
905 if (line
[0] == '\037')
907 if (fputs ("^_", mbf
) == EOF
)
912 if (fwrite (line
, 1, len
, mbf
) != len
)
914 if (fputc (0x0a, mbf
) == EOF
)
920 mbx_delimit_begin (FILE *mbf
)
924 char fromline
[40] = "From movemail ";
927 ltime
= localtime (&now
);
929 strcat (fromline
, asctime (ltime
));
931 if (fputs (fromline
, mbf
) == EOF
)
937 mbx_delimit_end (FILE *mbf
)
939 if (putc ('\n', mbf
) == EOF
)
944 #endif /* MAIL_USE_POP */
946 #ifndef HAVE_STRERROR
951 extern char *sys_errlist
[];
954 if (errnum
>= 0 && errnum
< sys_nerr
)
955 return sys_errlist
[errnum
];
956 return (char *) "Unknown error";
959 #endif /* ! HAVE_STRERROR */
962 /* movemail.c ends here */