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 ();
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
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
);
265 /* Use a lock file named after our first argument with .lock appended:
266 If it exists, the mail file is locked. */
267 /* Note: this locking mechanism is *required* by the mailer
268 (on systems which use it) to prevent loss of mail.
270 On systems that use a lock file, extracting the mail without locking
271 WILL occasionally cause loss of mail due to timing errors!
273 So, if creation of the lock file fails
274 due to access permission on the mail spool directory,
275 you simply MUST change the permission
276 and/or make movemail a setgid program
277 so it can create lock files properly.
279 You might also wish to verify that your system is one
280 which uses lock files for this purpose. Some systems use other methods.
282 If your system uses the `flock' system call for mail locking,
283 define MAIL_USE_SYSTEM_LOCK in config.h or the s-*.h file
284 and recompile movemail. If the s- file for your system
285 should define MAIL_USE_SYSTEM_LOCK but does not, send a bug report
286 to bug-gnu-emacs@prep.ai.mit.edu so we can fix it. */
288 lockname
= concat (inname
, ".lock", "");
289 tempname
= (char *) xmalloc (strlen (inname
) + strlen ("EXXXXXX") + 1);
290 strcpy (tempname
, inname
);
291 p
= tempname
+ strlen (tempname
);
292 while (p
!= tempname
&& !IS_DIRECTORY_SEP (p
[-1]))
295 strcpy (p
, "EXXXXXX");
301 /* Create the lock file, but not under the lock file name. */
302 /* Give up if cannot do that. */
303 desc
= open (tempname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
306 char *message
= (char *) xmalloc (strlen (tempname
) + 50);
307 sprintf (message
, "creating %s, which would become the lock file",
309 pfatal_with_name (message
);
313 tem
= link (tempname
, lockname
);
316 if (tem
< 0 && errno
== EPERM
)
317 fatal ("Unable to create hard link between %s and %s",
326 /* If lock file is five minutes old, unlock it.
327 Five minutes should be good enough to cope with crashes
328 and wedgitude, and long enough to avoid being fooled
329 by time differences between machines. */
330 if (stat (lockname
, &st
) >= 0)
333 if (st
.st_ctime
< now
- 300)
338 delete_lockname
= lockname
;
340 #endif /* not MAIL_USE_SYSTEM_LOCK */
341 #endif /* not MAIL_USE_MMDF */
347 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
348 time_t touched_lock
, now
;
351 if (setuid (getuid ()) < 0 || setregid (-1, real_gid
) < 0)
352 fatal ("Failed to drop privileges", 0, 0);
354 #ifndef MAIL_USE_MMDF
355 #ifdef MAIL_USE_SYSTEM_LOCK
356 indesc
= open (inname
, O_RDWR
);
357 #else /* if not MAIL_USE_SYSTEM_LOCK */
358 indesc
= open (inname
, O_RDONLY
);
359 #endif /* not MAIL_USE_SYSTEM_LOCK */
360 #else /* MAIL_USE_MMDF */
361 indesc
= lk_open (inname
, O_RDONLY
, 0, 0, 10);
362 #endif /* MAIL_USE_MMDF */
365 pfatal_with_name (inname
);
368 /* In case movemail is setuid to root, make sure the user can
369 read the output file. */
370 /* This is desirable for all systems
371 but I don't want to assume all have the umask system call */
372 umask (umask (0) & 0333);
373 #endif /* BSD_SYSTEM */
374 outdesc
= open (outname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
376 pfatal_with_name (outname
);
378 if (setregid (-1, priv_gid
) < 0)
379 fatal ("Failed to regain privileges", 0, 0);
381 /* This label exists so we can retry locking
382 after a delay, if it got EAGAIN or EBUSY. */
385 /* Try to lock it. */
386 #ifdef MAIL_USE_MAILLOCK
389 /* The "0 - " is to make it a negative number if maillock returns
391 status
= 0 - maillock (spool_name
, 1);
392 #ifdef HAVE_TOUCHLOCK
393 touched_lock
= time (0);
398 #endif /* MAIL_USE_MAILLOCK */
400 #ifdef MAIL_USE_SYSTEM_LOCK
401 #ifdef MAIL_USE_LOCKF
402 status
= lockf (indesc
, F_LOCK
, 0);
403 #else /* not MAIL_USE_LOCKF */
405 status
= locking (indesc
, LK_RLCK
, -1L);
407 status
= flock (indesc
, LOCK_EX
);
409 #endif /* not MAIL_USE_LOCKF */
410 #endif /* MAIL_USE_SYSTEM_LOCK */
413 /* If it fails, retry up to 5 times
414 for certain failure codes. */
417 if (++lockcount
<= 5)
435 pfatal_with_name (inname
);
443 nread
= read (indesc
, buf
, sizeof buf
);
445 pfatal_with_name (inname
);
446 if (nread
!= write (outdesc
, buf
, nread
))
448 int saved_errno
= errno
;
451 pfatal_with_name (outname
);
453 if (nread
< sizeof buf
)
455 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
459 if (now
- touched_lock
> 60)
465 #endif /* MAIL_USE_MAILLOCK */
470 if (fsync (outdesc
) < 0)
471 pfatal_and_delete (outname
);
474 /* Prevent symlink attacks truncating other users' mailboxes */
475 if (setregid (-1, real_gid
) < 0)
476 fatal ("Failed to drop privileges", 0, 0);
478 /* Check to make sure no errors before we zap the inbox. */
479 if (close (outdesc
) != 0)
480 pfatal_and_delete (outname
);
482 #ifdef MAIL_USE_SYSTEM_LOCK
485 if (ftruncate (indesc
, 0L) != 0)
486 pfatal_with_name (inname
);
488 #endif /* MAIL_USE_SYSTEM_LOCK */
491 lk_close (indesc
, 0, 0, 0);
496 #ifndef MAIL_USE_SYSTEM_LOCK
499 /* Delete the input file; if we can't, at least get rid of its
501 #ifdef MAIL_UNLINK_SPOOL
502 /* This is generally bad to do, because it destroys the permissions
503 that were set on the file. Better to just empty the file. */
504 if (unlink (inname
) < 0 && errno
!= ENOENT
)
505 #endif /* MAIL_UNLINK_SPOOL */
506 creat (inname
, 0600);
508 #endif /* not MAIL_USE_SYSTEM_LOCK */
510 /* End of mailbox truncation */
511 if (setregid (-1, priv_gid
) < 0)
512 fatal ("Failed to regain privileges", 0, 0);
514 #ifdef MAIL_USE_MAILLOCK
515 /* This has to occur in the child, i.e., in the process that
516 acquired the lock! */
524 if (!WIFEXITED (wait_status
))
526 else if (WRETCODE (wait_status
) != 0)
527 exit (WRETCODE (wait_status
));
529 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
530 #ifdef MAIL_USE_MAILLOCK
532 #endif /* MAIL_USE_MAILLOCK */
534 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
536 #endif /* ! DISABLE_DIRECT_ACCESS */
541 #ifdef MAIL_USE_MAILLOCK
542 /* This function uses stat to confirm that the mail directory is
543 identical to the directory of the input file, rather than just
544 string-comparing the two paths, because one or both of them might
545 be symbolic links pointing to some other directory. */
547 mail_spool_name (char *inname
)
549 struct stat stat1
, stat2
;
553 if (! (fname
= strrchr (inname
, '/')))
558 if (stat (MAILDIR
, &stat1
) < 0)
561 indir
= (char *) xmalloc (fname
- inname
+ 1);
562 strncpy (indir
, inname
, fname
- inname
);
563 indir
[fname
-inname
] = '\0';
566 status
= stat (indir
, &stat2
);
573 if (stat1
.st_dev
== stat2
.st_dev
574 && stat1
.st_ino
== stat2
.st_ino
)
579 #endif /* MAIL_USE_MAILLOCK */
581 /* Print error message and exit. */
584 fatal (const char *s1
, const char *s2
, const char *s3
)
587 unlink (delete_lockname
);
592 /* Print error message. `s1' is printf control string, `s2' and `s3'
593 are args for it or null. */
596 error (const char *s1
, const char *s2
, const char *s3
)
598 fprintf (stderr
, "movemail: ");
600 fprintf (stderr
, s1
, s2
, s3
);
602 fprintf (stderr
, s1
, s2
);
604 fprintf (stderr
, "%s", s1
);
605 fprintf (stderr
, "\n");
609 pfatal_with_name (char *name
)
611 fatal ("%s for %s", strerror (errno
), name
);
615 pfatal_and_delete (char *name
)
617 char *s
= strerror (errno
);
619 fatal ("%s for %s", s
, name
);
622 /* Return a newly-allocated string whose contents concatenate those of s1, s2, s3. */
625 concat (const char *s1
, const char *s2
, const char *s3
)
627 size_t len1
= strlen (s1
), len2
= strlen (s2
), len3
= strlen (s3
);
628 char *result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
631 strcpy (result
+ len1
, s2
);
632 strcpy (result
+ len1
+ len2
, s3
);
633 *(result
+ len1
+ len2
+ len3
) = 0;
638 /* Like malloc but get fatal error if memory is exhausted. */
641 xmalloc (unsigned int size
)
643 long *result
= (long *) malloc (size
);
645 fatal ("virtual memory exhausted", 0, 0);
649 /* This is the guts of the interface to the Post Office Protocol. */
654 #include <sys/socket.h>
655 #include <netinet/in.h>
667 static char Errmsg
[200]; /* POP errors, at least, can exceed
668 the original length of 80. */
671 * The full valid syntax for a POP mailbox specification for movemail
672 * is "po:username:hostname". The ":hostname" is optional; if it is
673 * omitted, the MAILHOST environment variable will be consulted. Note
674 * that by the time popmail() is called the "po:" has been stripped
675 * off of the front of the mailbox name.
677 * If the mailbox is in the form "po:username:hostname", then it is
678 * modified by this function -- the second colon is replaced by a
681 * Return a value suitable for passing to `exit'.
685 popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
)
691 char *getenv (const char *);
693 int start
, end
, increment
;
694 char *user
, *hostname
;
697 if ((hostname
= strchr (mailbox
, ':')))
700 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
703 error ("Error connecting to POP server: %s", pop_error
, 0);
707 if (pop_stat (server
, &nmsgs
, &nbytes
))
709 error ("Error getting message count from POP server: %s", pop_error
, 0);
719 mbfi
= open (outfile
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
723 error ("Error in open: %s, %s", strerror (errno
), outfile
);
726 fchown (mbfi
, getuid (), -1);
728 if ((mbf
= fdopen (mbfi
, "wb")) == NULL
)
731 error ("Error in fdopen: %s", strerror (errno
), 0);
750 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
752 mbx_delimit_begin (mbf
);
753 if (pop_retr (server
, i
, mbf
) != OK
)
755 error ("%s", Errmsg
, 0);
759 mbx_delimit_end (mbf
);
763 error ("Error in fflush: %s", strerror (errno
), 0);
770 /* On AFS, a call to write only modifies the file in the local
771 * workstation's AFS cache. The changes are not written to the server
772 * until a call to fsync or close is made. Users with AFS home
773 * directories have lost mail when over quota because these checks were
774 * not made in previous versions of movemail. */
777 if (fsync (mbfi
) < 0)
779 error ("Error in fsync: %s", strerror (errno
), 0);
784 if (close (mbfi
) == -1)
786 error ("Error in close: %s", strerror (errno
), 0);
791 for (i
= 1; i
<= nmsgs
; i
++)
793 if (pop_delete (server
, i
))
795 error ("Error from POP server: %s", pop_error
, 0);
801 if (pop_quit (server
))
803 error ("Error from POP server: %s", pop_error
, 0);
811 pop_retr (popserver server
, int msgno
, FILE *arg
)
816 if (pop_retrieve_first (server
, msgno
, &line
))
818 char *msg
= concat ("Error from POP server: ", pop_error
, "");
819 strncpy (Errmsg
, msg
, sizeof (Errmsg
));
820 Errmsg
[sizeof (Errmsg
)-1] = '\0';
825 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
830 if (mbx_write (line
, ret
, arg
) != OK
)
832 strcpy (Errmsg
, strerror (errno
));
840 char *msg
= concat ("Error from POP server: ", pop_error
, "");
841 strncpy (Errmsg
, msg
, sizeof (Errmsg
));
842 Errmsg
[sizeof (Errmsg
)-1] = '\0';
851 mbx_write (char *line
, int len
, FILE *mbf
)
853 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
854 if (IS_FROM_LINE (line
))
856 if (fputc ('>', mbf
) == EOF
)
860 if (line
[0] == '\037')
862 if (fputs ("^_", mbf
) == EOF
)
867 if (fwrite (line
, 1, len
, mbf
) != len
)
869 if (fputc (0x0a, mbf
) == EOF
)
875 mbx_delimit_begin (FILE *mbf
)
879 char fromline
[40] = "From movemail ";
882 ltime
= localtime (&now
);
884 strcat (fromline
, asctime (ltime
));
886 if (fputs (fromline
, mbf
) == EOF
)
892 mbx_delimit_end (FILE *mbf
)
894 if (putc ('\n', mbf
) == EOF
)
899 #endif /* MAIL_USE_POP */
901 #ifndef HAVE_STRERROR
906 extern char *sys_errlist
[];
909 if (errnum
>= 0 && errnum
< sys_nerr
)
910 return sys_errlist
[errnum
];
911 return (char *) "Unknown error";
914 #endif /* ! HAVE_STRERROR */
917 /* movemail.c ends here */