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-2012
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>
86 #define wait(var) (*(var) = 0)
87 /* Unfortunately, Samba doesn't seem to properly lock Unix files even
88 though the locking call succeeds (and indeed blocks local access from
89 other NT programs). If you have direct file access using an NFS
90 client or something other than Samba, the locking call might work
91 properly - make sure it does before you enable this!
93 [18-Feb-97 andrewi] I now believe my comment above to be incorrect,
94 since it was based on a misunderstanding of how locking calls are
95 implemented and used on Unix. */
96 //#define DISABLE_DIRECT_ACCESS
99 #endif /* WINDOWSNT */
109 #include <sys/locking.h>
112 #ifdef MAIL_USE_LOCKF
113 #define MAIL_USE_SYSTEM_LOCK
116 #ifdef MAIL_USE_FLOCK
117 #define MAIL_USE_SYSTEM_LOCK
121 extern int lk_open (), lk_close ();
124 #if !defined (MAIL_USE_SYSTEM_LOCK) && !defined (MAIL_USE_MMDF) && \
125 (defined (HAVE_LIBMAIL) || defined (HAVE_LIBLOCKFILE)) && \
126 defined (HAVE_MAILLOCK_H)
127 #include <maillock.h>
128 /* We can't use maillock unless we know what directory system mail
131 #define MAIL_USE_MAILLOCK
132 static char *mail_spool_name (char *);
136 static _Noreturn
void fatal (const char *s1
, const char *s2
, const char *s3
);
137 static void error (const char *s1
, const char *s2
, const char *s3
);
138 static _Noreturn
void pfatal_with_name (char *name
);
139 static _Noreturn
void pfatal_and_delete (char *name
);
141 static int popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
);
142 static int pop_retr (popserver server
, int msgno
, FILE *arg
);
143 static int mbx_write (char *line
, int len
, FILE *mbf
);
144 static int mbx_delimit_begin (FILE *mbf
);
145 static int mbx_delimit_end (FILE *mbf
);
148 #if (defined MAIL_USE_MAILLOCK \
149 || (!defined DISABLE_DIRECT_ACCESS && !defined MAIL_USE_MMDF \
150 && !defined MAIL_USE_SYSTEM_LOCK))
151 /* Like malloc but get fatal error if memory is exhausted. */
154 xmalloc (size_t size
)
156 void *result
= malloc (size
);
158 fatal ("virtual memory exhausted", 0, 0);
163 /* Nonzero means this is name of a lock file to delete on fatal error. */
164 static char *delete_lockname
;
167 main (int argc
, char **argv
)
169 char *inname
, *outname
;
173 int c
, preserve_mail
= 0;
175 #ifndef MAIL_USE_SYSTEM_LOCK
180 size_t inname_len
, inname_dirlen
;
182 #endif /* not MAIL_USE_SYSTEM_LOCK */
184 #ifdef MAIL_USE_MAILLOCK
189 int pop_reverse_order
= 0;
191 #else /* ! MAIL_USE_POP */
193 #endif /* MAIL_USE_POP */
195 uid_t real_gid
= getgid ();
196 uid_t priv_gid
= getegid ();
199 /* Ensure all file i/o is in binary mode. */
205 while ((c
= getopt (argc
, argv
, ARGSTR
)) != EOF
)
210 pop_reverse_order
= 1;
223 (argc
- optind
< 2) || (argc
- optind
> 3)
230 fprintf (stderr
, "Usage: movemail [-p] [-r] inbox destfile%s\n",
233 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n", "");
238 inname
= argv
[optind
];
239 outname
= argv
[optind
+1];
246 fatal ("Destination file name is empty", 0, 0);
249 if (!strncmp (inname
, "po:", 3))
253 status
= popmail (inname
+ 3, outname
, preserve_mail
,
254 (argc
- optind
== 3) ? argv
[optind
+2] : NULL
,
259 if (setuid (getuid ()) < 0)
260 fatal ("Failed to drop privileges", 0, 0);
262 #endif /* MAIL_USE_POP */
264 #ifndef DISABLE_DIRECT_ACCESS
265 #ifndef MAIL_USE_MMDF
266 #ifndef MAIL_USE_SYSTEM_LOCK
267 #ifdef MAIL_USE_MAILLOCK
268 spool_name
= mail_spool_name (inname
);
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 due to access
287 permission on the mail spool directory, you simply MUST
288 change the permission and/or make movemail a setgid program
289 so it can create lock files properly.
291 You might also wish to verify that your system is one which
292 uses lock files for this purpose. Some systems use other methods.
294 If your system uses the `flock' system call for mail locking,
295 define MAIL_USE_SYSTEM_LOCK in config.h and recompile movemail.
296 If your system type should always define MAIL_USE_SYSTEM_LOCK
297 but does not, send a bug report to bug-gnu-emacs@gnu.org so we
298 can change the default in configure. */
300 inname_len
= strlen (inname
);
301 lockname
= xmalloc (inname_len
+ sizeof ".lock");
302 strcpy (lockname
, inname
);
303 strcpy (lockname
+ inname_len
, ".lock");
304 for (inname_dirlen
= inname_len
;
305 inname_dirlen
&& !IS_DIRECTORY_SEP (inname
[inname_dirlen
- 1]);
308 tempname
= xmalloc (inname_dirlen
+ sizeof "EXXXXXX");
312 /* Create the lock file, but not under the lock file name. */
313 /* Give up if cannot do that. */
315 memcpy (tempname
, inname
, inname_dirlen
);
316 strcpy (tempname
+ inname_dirlen
, "EXXXXXX");
318 desc
= mkstemp (tempname
);
326 desc
= open (tempname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
331 int mkstemp_errno
= errno
;
332 error ("error while creating what would become the lock file",
334 errno
= mkstemp_errno
;
335 pfatal_with_name (tempname
);
339 tem
= link (tempname
, lockname
);
342 if (tem
< 0 && errno
== EPERM
)
343 fatal ("Unable to create hard link between %s and %s",
352 /* If lock file is five minutes old, unlock it.
353 Five minutes should be good enough to cope with crashes
354 and wedgitude, and long enough to avoid being fooled
355 by time differences between machines. */
356 if (stat (lockname
, &st
) >= 0)
358 time_t now
= time (0);
359 if (st
.st_ctime
< now
- 300)
364 delete_lockname
= lockname
;
366 #endif /* not MAIL_USE_SYSTEM_LOCK */
367 #endif /* not MAIL_USE_MMDF */
373 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
380 if (setuid (getuid ()) < 0 || setregid (-1, real_gid
) < 0)
381 fatal ("Failed to drop privileges", 0, 0);
383 #ifndef MAIL_USE_MMDF
384 #ifdef MAIL_USE_SYSTEM_LOCK
385 indesc
= open (inname
, O_RDWR
);
386 #else /* if not MAIL_USE_SYSTEM_LOCK */
387 indesc
= open (inname
, O_RDONLY
);
388 #endif /* not MAIL_USE_SYSTEM_LOCK */
389 #else /* MAIL_USE_MMDF */
390 indesc
= lk_open (inname
, O_RDONLY
, 0, 0, 10);
391 #endif /* MAIL_USE_MMDF */
394 pfatal_with_name (inname
);
397 /* In case movemail is setuid to root, make sure the user can
398 read the output file. */
399 /* This is desirable for all systems
400 but I don't want to assume all have the umask system call */
401 umask (umask (0) & 0333);
402 #endif /* BSD_SYSTEM */
403 outdesc
= open (outname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
405 pfatal_with_name (outname
);
407 if (setregid (-1, priv_gid
) < 0)
408 fatal ("Failed to regain privileges", 0, 0);
410 /* This label exists so we can retry locking
411 after a delay, if it got EAGAIN or EBUSY. */
414 /* Try to lock it. */
415 #ifdef MAIL_USE_MAILLOCK
418 /* The "0 - " is to make it a negative number if maillock returns
420 status
= 0 - maillock (spool_name
, 1);
421 #ifdef HAVE_TOUCHLOCK
422 touched_lock
= time (0);
427 #endif /* MAIL_USE_MAILLOCK */
429 #ifdef MAIL_USE_SYSTEM_LOCK
430 #ifdef MAIL_USE_LOCKF
431 status
= lockf (indesc
, F_LOCK
, 0);
432 #else /* not MAIL_USE_LOCKF */
434 status
= locking (indesc
, LK_RLCK
, -1L);
436 status
= flock (indesc
, LOCK_EX
);
438 #endif /* not MAIL_USE_LOCKF */
439 #endif /* MAIL_USE_SYSTEM_LOCK */
442 /* If it fails, retry up to 5 times
443 for certain failure codes. */
446 if (++lockcount
<= 5)
464 pfatal_with_name (inname
);
472 nread
= read (indesc
, buf
, sizeof buf
);
474 pfatal_with_name (inname
);
475 if (nread
!= write (outdesc
, buf
, nread
))
477 int saved_errno
= errno
;
480 pfatal_with_name (outname
);
482 if (nread
< sizeof buf
)
484 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
487 time_t now
= time (0);
488 if (now
- touched_lock
> 60)
494 #endif /* MAIL_USE_MAILLOCK */
499 if (fsync (outdesc
) < 0)
500 pfatal_and_delete (outname
);
503 /* Prevent symlink attacks truncating other users' mailboxes */
504 if (setregid (-1, real_gid
) < 0)
505 fatal ("Failed to drop privileges", 0, 0);
507 /* Check to make sure no errors before we zap the inbox. */
508 if (close (outdesc
) != 0)
509 pfatal_and_delete (outname
);
511 #ifdef MAIL_USE_SYSTEM_LOCK
514 if (ftruncate (indesc
, 0L) != 0)
515 pfatal_with_name (inname
);
517 #endif /* MAIL_USE_SYSTEM_LOCK */
520 lk_close (indesc
, 0, 0, 0);
525 #ifndef MAIL_USE_SYSTEM_LOCK
528 /* Delete the input file; if we can't, at least get rid of its
530 #ifdef MAIL_UNLINK_SPOOL
531 /* This is generally bad to do, because it destroys the permissions
532 that were set on the file. Better to just empty the file. */
533 if (unlink (inname
) < 0 && errno
!= ENOENT
)
534 #endif /* MAIL_UNLINK_SPOOL */
535 creat (inname
, 0600);
537 #endif /* not MAIL_USE_SYSTEM_LOCK */
539 /* End of mailbox truncation */
540 if (setregid (-1, priv_gid
) < 0)
541 fatal ("Failed to regain privileges", 0, 0);
543 #ifdef MAIL_USE_MAILLOCK
544 /* This has to occur in the child, i.e., in the process that
545 acquired the lock! */
553 if (!WIFEXITED (wait_status
))
555 else if (WEXITSTATUS (wait_status
) != 0)
556 exit (WEXITSTATUS (wait_status
));
558 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
559 #ifdef MAIL_USE_MAILLOCK
561 #endif /* MAIL_USE_MAILLOCK */
563 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
565 #endif /* ! DISABLE_DIRECT_ACCESS */
570 #ifdef MAIL_USE_MAILLOCK
571 /* This function uses stat to confirm that the mail directory is
572 identical to the directory of the input file, rather than just
573 string-comparing the two paths, because one or both of them might
574 be symbolic links pointing to some other directory. */
576 mail_spool_name (char *inname
)
578 struct stat stat1
, stat2
;
582 if (! (fname
= strrchr (inname
, '/')))
587 if (stat (MAILDIR
, &stat1
) < 0)
590 indir
= xmalloc (fname
- inname
+ 1);
591 memcpy (indir
, inname
, fname
- inname
);
592 indir
[fname
-inname
] = '\0';
595 status
= stat (indir
, &stat2
);
602 if (stat1
.st_dev
== stat2
.st_dev
603 && stat1
.st_ino
== stat2
.st_ino
)
608 #endif /* MAIL_USE_MAILLOCK */
610 /* Print error message and exit. */
613 fatal (const char *s1
, const char *s2
, const char *s3
)
616 unlink (delete_lockname
);
621 /* Print error message. `s1' is printf control string, `s2' and `s3'
622 are args for it or null. */
625 error (const char *s1
, const char *s2
, const char *s3
)
627 fprintf (stderr
, "movemail: ");
629 fprintf (stderr
, s1
, s2
, s3
);
631 fprintf (stderr
, s1
, s2
);
633 fprintf (stderr
, "%s", s1
);
634 fprintf (stderr
, "\n");
638 pfatal_with_name (char *name
)
640 fatal ("%s for %s", strerror (errno
), name
);
644 pfatal_and_delete (char *name
)
646 char *s
= strerror (errno
);
648 fatal ("%s for %s", s
, name
);
651 /* This is the guts of the interface to the Post Office Protocol. */
656 #include <sys/socket.h>
657 #include <netinet/in.h>
669 static char Errmsg
[200]; /* POP errors, at least, can exceed
670 the original length of 80. */
673 * The full valid syntax for a POP mailbox specification for movemail
674 * is "po:username:hostname". The ":hostname" is optional; if it is
675 * omitted, the MAILHOST environment variable will be consulted. Note
676 * that by the time popmail() is called the "po:" has been stripped
677 * off of the front of the mailbox name.
679 * If the mailbox is in the form "po:username:hostname", then it is
680 * modified by this function -- the second colon is replaced by a
683 * Return a value suitable for passing to `exit'.
687 popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
)
693 char *getenv (const char *);
695 int start
, end
, increment
;
696 char *user
, *hostname
;
699 if ((hostname
= strchr (mailbox
, ':')))
702 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
705 error ("Error connecting to POP server: %s", pop_error
, 0);
709 if (pop_stat (server
, &nmsgs
, &nbytes
))
711 error ("Error getting message count from POP server: %s", pop_error
, 0);
721 mbfi
= open (outfile
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
725 error ("Error in open: %s, %s", strerror (errno
), outfile
);
729 if (fchown (mbfi
, getuid (), -1) != 0)
731 int fchown_errno
= errno
;
733 if (fstat (mbfi
, &st
) != 0 || st
.st_uid
!= getuid ())
736 error ("Error in fchown: %s, %s", strerror (fchown_errno
), outfile
);
741 if ((mbf
= fdopen (mbfi
, "wb")) == NULL
)
744 error ("Error in fdopen: %s", strerror (errno
), 0);
763 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
765 mbx_delimit_begin (mbf
);
766 if (pop_retr (server
, i
, mbf
) != OK
)
768 error ("%s", Errmsg
, 0);
772 mbx_delimit_end (mbf
);
776 error ("Error in fflush: %s", strerror (errno
), 0);
783 /* On AFS, a call to write only modifies the file in the local
784 * workstation's AFS cache. The changes are not written to the server
785 * until a call to fsync or close is made. Users with AFS home
786 * directories have lost mail when over quota because these checks were
787 * not made in previous versions of movemail. */
790 if (fsync (mbfi
) < 0)
792 error ("Error in fsync: %s", strerror (errno
), 0);
797 if (close (mbfi
) == -1)
799 error ("Error in close: %s", strerror (errno
), 0);
804 for (i
= 1; i
<= nmsgs
; i
++)
806 if (pop_delete (server
, i
))
808 error ("Error from POP server: %s", pop_error
, 0);
814 if (pop_quit (server
))
816 error ("Error from POP server: %s", pop_error
, 0);
824 pop_retr (popserver server
, int msgno
, FILE *arg
)
829 if (pop_retrieve_first (server
, msgno
, &line
))
831 snprintf (Errmsg
, sizeof Errmsg
, "Error from POP server: %s", pop_error
);
835 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
840 if (mbx_write (line
, ret
, arg
) != OK
)
842 strcpy (Errmsg
, strerror (errno
));
850 snprintf (Errmsg
, sizeof Errmsg
, "Error from POP server: %s", pop_error
);
858 mbx_write (char *line
, int len
, FILE *mbf
)
860 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
861 /* Do this as a macro instead of using strcmp to save on execution time. */
862 # define IS_FROM_LINE(a) ((a[0] == 'F') \
867 if (IS_FROM_LINE (line
))
869 if (fputc ('>', mbf
) == EOF
)
873 if (line
[0] == '\037')
875 if (fputs ("^_", mbf
) == EOF
)
880 if (fwrite (line
, 1, len
, mbf
) != len
)
882 if (fputc (0x0a, mbf
) == EOF
)
888 mbx_delimit_begin (FILE *mbf
)
892 char fromline
[40] = "From movemail ";
895 ltime
= localtime (&now
);
897 strcat (fromline
, asctime (ltime
));
899 if (fputs (fromline
, mbf
) == EOF
)
905 mbx_delimit_end (FILE *mbf
)
907 if (putc ('\n', mbf
) == EOF
)
912 #endif /* MAIL_USE_POP */