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>
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 #ifndef HAVE_STRERROR
137 char *strerror (int);
140 static void fatal (const char *s1
, const char *s2
, const char *s3
) NO_RETURN
;
141 static void error (const char *s1
, const char *s2
, const char *s3
);
142 static void pfatal_with_name (char *name
) NO_RETURN
;
143 static void pfatal_and_delete (char *name
) NO_RETURN
;
144 static char *concat (const char *s1
, const char *s2
, const char *s3
);
145 static long *xmalloc (unsigned int size
);
147 static int popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
);
148 static int pop_retr (popserver server
, int msgno
, FILE *arg
);
149 static int mbx_write (char *line
, int len
, FILE *mbf
);
150 static int mbx_delimit_begin (FILE *mbf
);
151 static int mbx_delimit_end (FILE *mbf
);
154 /* Nonzero means this is name of a lock file to delete on fatal error. */
155 static char *delete_lockname
;
158 main (int argc
, char **argv
)
160 char *inname
, *outname
;
164 int c
, preserve_mail
= 0;
166 #ifndef MAIL_USE_SYSTEM_LOCK
171 size_t inname_dirlen
;
173 #endif /* not MAIL_USE_SYSTEM_LOCK */
175 #ifdef MAIL_USE_MAILLOCK
180 int pop_reverse_order
= 0;
182 #else /* ! MAIL_USE_POP */
184 #endif /* MAIL_USE_POP */
186 uid_t real_gid
= getgid();
187 uid_t priv_gid
= getegid();
190 /* Ensure all file i/o is in binary mode. */
196 while ((c
= getopt (argc
, argv
, ARGSTR
)) != EOF
)
201 pop_reverse_order
= 1;
214 (argc
- optind
< 2) || (argc
- optind
> 3)
221 fprintf (stderr
, "Usage: movemail [-p] [-r] inbox destfile%s\n",
224 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n", "");
229 inname
= argv
[optind
];
230 outname
= argv
[optind
+1];
237 fatal ("Destination file name is empty", 0, 0);
240 if (!strncmp (inname
, "po:", 3))
244 status
= popmail (inname
+ 3, outname
, preserve_mail
,
245 (argc
- optind
== 3) ? argv
[optind
+2] : NULL
,
250 if (setuid (getuid ()) < 0)
251 fatal ("Failed to drop privileges", 0, 0);
253 #endif /* MAIL_USE_POP */
255 #ifndef DISABLE_DIRECT_ACCESS
256 #ifndef MAIL_USE_MMDF
257 #ifndef MAIL_USE_SYSTEM_LOCK
258 #ifdef MAIL_USE_MAILLOCK
259 spool_name
= mail_spool_name (inname
);
269 #ifndef DIRECTORY_SEP
270 #define DIRECTORY_SEP '/'
272 #ifndef IS_DIRECTORY_SEP
273 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
276 /* Use a lock file named after our first argument with .lock appended:
277 If it exists, the mail file is locked. */
278 /* Note: this locking mechanism is *required* by the mailer
279 (on systems which use it) to prevent loss of mail.
281 On systems that use a lock file, extracting the mail without locking
282 WILL occasionally cause loss of mail due to timing errors!
284 So, if creation of the lock file fails
285 due to access permission on the mail spool directory,
286 you simply MUST change the permission
287 and/or make movemail a setgid program
288 so it can create lock files properly.
290 You might also wish to verify that your system is one
291 which uses lock files for this purpose. Some systems use other methods.
293 If your system uses the `flock' system call for mail locking,
294 define MAIL_USE_SYSTEM_LOCK in config.h or the s-*.h file
295 and recompile movemail. If the s- file for your system
296 should define MAIL_USE_SYSTEM_LOCK but does not, send a bug report
297 to bug-gnu-emacs@prep.ai.mit.edu so we can fix it. */
299 lockname
= concat (inname
, ".lock", "");
300 for (inname_dirlen
= strlen (inname
);
301 inname_dirlen
&& !IS_DIRECTORY_SEP (inname
[inname_dirlen
- 1]);
304 tempname
= (char *) xmalloc (inname_dirlen
+ sizeof "EXXXXXX");
308 /* Create the lock file, but not under the lock file name. */
309 /* Give up if cannot do that. */
311 memcpy (tempname
, inname
, inname_dirlen
);
312 strcpy (tempname
+ inname_dirlen
, "EXXXXXX");
314 desc
= mkstemp (tempname
);
322 desc
= open (tempname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
327 int mkstemp_errno
= errno
;
328 char *message
= (char *) xmalloc (strlen (tempname
) + 50);
329 sprintf (message
, "creating %s, which would become the lock file",
331 errno
= mkstemp_errno
;
332 pfatal_with_name (message
);
336 tem
= link (tempname
, lockname
);
339 if (tem
< 0 && errno
== EPERM
)
340 fatal ("Unable to create hard link between %s and %s",
349 /* If lock file is five minutes old, unlock it.
350 Five minutes should be good enough to cope with crashes
351 and wedgitude, and long enough to avoid being fooled
352 by time differences between machines. */
353 if (stat (lockname
, &st
) >= 0)
355 time_t now
= time (0);
356 if (st
.st_ctime
< now
- 300)
361 delete_lockname
= lockname
;
363 #endif /* not MAIL_USE_SYSTEM_LOCK */
364 #endif /* not MAIL_USE_MMDF */
370 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
377 if (setuid (getuid ()) < 0 || setregid (-1, real_gid
) < 0)
378 fatal ("Failed to drop privileges", 0, 0);
380 #ifndef MAIL_USE_MMDF
381 #ifdef MAIL_USE_SYSTEM_LOCK
382 indesc
= open (inname
, O_RDWR
);
383 #else /* if not MAIL_USE_SYSTEM_LOCK */
384 indesc
= open (inname
, O_RDONLY
);
385 #endif /* not MAIL_USE_SYSTEM_LOCK */
386 #else /* MAIL_USE_MMDF */
387 indesc
= lk_open (inname
, O_RDONLY
, 0, 0, 10);
388 #endif /* MAIL_USE_MMDF */
391 pfatal_with_name (inname
);
394 /* In case movemail is setuid to root, make sure the user can
395 read the output file. */
396 /* This is desirable for all systems
397 but I don't want to assume all have the umask system call */
398 umask (umask (0) & 0333);
399 #endif /* BSD_SYSTEM */
400 outdesc
= open (outname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
402 pfatal_with_name (outname
);
404 if (setregid (-1, priv_gid
) < 0)
405 fatal ("Failed to regain privileges", 0, 0);
407 /* This label exists so we can retry locking
408 after a delay, if it got EAGAIN or EBUSY. */
411 /* Try to lock it. */
412 #ifdef MAIL_USE_MAILLOCK
415 /* The "0 - " is to make it a negative number if maillock returns
417 status
= 0 - maillock (spool_name
, 1);
418 #ifdef HAVE_TOUCHLOCK
419 touched_lock
= time (0);
424 #endif /* MAIL_USE_MAILLOCK */
426 #ifdef MAIL_USE_SYSTEM_LOCK
427 #ifdef MAIL_USE_LOCKF
428 status
= lockf (indesc
, F_LOCK
, 0);
429 #else /* not MAIL_USE_LOCKF */
431 status
= locking (indesc
, LK_RLCK
, -1L);
433 status
= flock (indesc
, LOCK_EX
);
435 #endif /* not MAIL_USE_LOCKF */
436 #endif /* MAIL_USE_SYSTEM_LOCK */
439 /* If it fails, retry up to 5 times
440 for certain failure codes. */
443 if (++lockcount
<= 5)
461 pfatal_with_name (inname
);
469 nread
= read (indesc
, buf
, sizeof buf
);
471 pfatal_with_name (inname
);
472 if (nread
!= write (outdesc
, buf
, nread
))
474 int saved_errno
= errno
;
477 pfatal_with_name (outname
);
479 if (nread
< sizeof buf
)
481 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
484 time_t now
= time (0);
485 if (now
- touched_lock
> 60)
491 #endif /* MAIL_USE_MAILLOCK */
496 if (fsync (outdesc
) < 0)
497 pfatal_and_delete (outname
);
500 /* Prevent symlink attacks truncating other users' mailboxes */
501 if (setregid (-1, real_gid
) < 0)
502 fatal ("Failed to drop privileges", 0, 0);
504 /* Check to make sure no errors before we zap the inbox. */
505 if (close (outdesc
) != 0)
506 pfatal_and_delete (outname
);
508 #ifdef MAIL_USE_SYSTEM_LOCK
511 if (ftruncate (indesc
, 0L) != 0)
512 pfatal_with_name (inname
);
514 #endif /* MAIL_USE_SYSTEM_LOCK */
517 lk_close (indesc
, 0, 0, 0);
522 #ifndef MAIL_USE_SYSTEM_LOCK
525 /* Delete the input file; if we can't, at least get rid of its
527 #ifdef MAIL_UNLINK_SPOOL
528 /* This is generally bad to do, because it destroys the permissions
529 that were set on the file. Better to just empty the file. */
530 if (unlink (inname
) < 0 && errno
!= ENOENT
)
531 #endif /* MAIL_UNLINK_SPOOL */
532 creat (inname
, 0600);
534 #endif /* not MAIL_USE_SYSTEM_LOCK */
536 /* End of mailbox truncation */
537 if (setregid (-1, priv_gid
) < 0)
538 fatal ("Failed to regain privileges", 0, 0);
540 #ifdef MAIL_USE_MAILLOCK
541 /* This has to occur in the child, i.e., in the process that
542 acquired the lock! */
550 if (!WIFEXITED (wait_status
))
552 else if (WRETCODE (wait_status
) != 0)
553 exit (WRETCODE (wait_status
));
555 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
556 #ifdef MAIL_USE_MAILLOCK
558 #endif /* MAIL_USE_MAILLOCK */
560 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
562 #endif /* ! DISABLE_DIRECT_ACCESS */
567 #ifdef MAIL_USE_MAILLOCK
568 /* This function uses stat to confirm that the mail directory is
569 identical to the directory of the input file, rather than just
570 string-comparing the two paths, because one or both of them might
571 be symbolic links pointing to some other directory. */
573 mail_spool_name (char *inname
)
575 struct stat stat1
, stat2
;
579 if (! (fname
= strrchr (inname
, '/')))
584 if (stat (MAILDIR
, &stat1
) < 0)
587 indir
= (char *) xmalloc (fname
- inname
+ 1);
588 strncpy (indir
, inname
, fname
- inname
);
589 indir
[fname
-inname
] = '\0';
592 status
= stat (indir
, &stat2
);
599 if (stat1
.st_dev
== stat2
.st_dev
600 && stat1
.st_ino
== stat2
.st_ino
)
605 #endif /* MAIL_USE_MAILLOCK */
607 /* Print error message and exit. */
610 fatal (const char *s1
, const char *s2
, const char *s3
)
613 unlink (delete_lockname
);
618 /* Print error message. `s1' is printf control string, `s2' and `s3'
619 are args for it or null. */
622 error (const char *s1
, const char *s2
, const char *s3
)
624 fprintf (stderr
, "movemail: ");
626 fprintf (stderr
, s1
, s2
, s3
);
628 fprintf (stderr
, s1
, s2
);
630 fprintf (stderr
, "%s", s1
);
631 fprintf (stderr
, "\n");
635 pfatal_with_name (char *name
)
637 fatal ("%s for %s", strerror (errno
), name
);
641 pfatal_and_delete (char *name
)
643 char *s
= strerror (errno
);
645 fatal ("%s for %s", s
, name
);
648 /* Return a newly-allocated string whose contents concatenate those of s1, s2, s3. */
651 concat (const char *s1
, const char *s2
, const char *s3
)
653 size_t len1
= strlen (s1
), len2
= strlen (s2
), len3
= strlen (s3
);
654 char *result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
657 strcpy (result
+ len1
, s2
);
658 strcpy (result
+ len1
+ len2
, s3
);
659 *(result
+ len1
+ len2
+ len3
) = 0;
664 /* Like malloc but get fatal error if memory is exhausted. */
667 xmalloc (unsigned int size
)
669 long *result
= (long *) malloc (size
);
671 fatal ("virtual memory exhausted", 0, 0);
675 /* This is the guts of the interface to the Post Office Protocol. */
680 #include <sys/socket.h>
681 #include <netinet/in.h>
693 static char Errmsg
[200]; /* POP errors, at least, can exceed
694 the original length of 80. */
697 * The full valid syntax for a POP mailbox specification for movemail
698 * is "po:username:hostname". The ":hostname" is optional; if it is
699 * omitted, the MAILHOST environment variable will be consulted. Note
700 * that by the time popmail() is called the "po:" has been stripped
701 * off of the front of the mailbox name.
703 * If the mailbox is in the form "po:username:hostname", then it is
704 * modified by this function -- the second colon is replaced by a
707 * Return a value suitable for passing to `exit'.
711 popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
)
717 char *getenv (const char *);
719 int start
, end
, increment
;
720 char *user
, *hostname
;
723 if ((hostname
= strchr (mailbox
, ':')))
726 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
729 error ("Error connecting to POP server: %s", pop_error
, 0);
733 if (pop_stat (server
, &nmsgs
, &nbytes
))
735 error ("Error getting message count from POP server: %s", pop_error
, 0);
745 mbfi
= open (outfile
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
749 error ("Error in open: %s, %s", strerror (errno
), outfile
);
753 if (fchown (mbfi
, getuid (), -1) != 0)
755 int fchown_errno
= errno
;
757 if (fstat (mbfi
, &st
) != 0 || st
.st_uid
!= getuid ())
760 error ("Error in fchown: %s, %s", strerror (fchown_errno
), outfile
);
765 if ((mbf
= fdopen (mbfi
, "wb")) == NULL
)
768 error ("Error in fdopen: %s", strerror (errno
), 0);
787 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
789 mbx_delimit_begin (mbf
);
790 if (pop_retr (server
, i
, mbf
) != OK
)
792 error ("%s", Errmsg
, 0);
796 mbx_delimit_end (mbf
);
800 error ("Error in fflush: %s", strerror (errno
), 0);
807 /* On AFS, a call to write only modifies the file in the local
808 * workstation's AFS cache. The changes are not written to the server
809 * until a call to fsync or close is made. Users with AFS home
810 * directories have lost mail when over quota because these checks were
811 * not made in previous versions of movemail. */
814 if (fsync (mbfi
) < 0)
816 error ("Error in fsync: %s", strerror (errno
), 0);
821 if (close (mbfi
) == -1)
823 error ("Error in close: %s", strerror (errno
), 0);
828 for (i
= 1; i
<= nmsgs
; i
++)
830 if (pop_delete (server
, i
))
832 error ("Error from POP server: %s", pop_error
, 0);
838 if (pop_quit (server
))
840 error ("Error from POP server: %s", pop_error
, 0);
848 pop_retr (popserver server
, int msgno
, FILE *arg
)
853 if (pop_retrieve_first (server
, msgno
, &line
))
855 char *msg
= concat ("Error from POP server: ", pop_error
, "");
856 strncpy (Errmsg
, msg
, sizeof (Errmsg
));
857 Errmsg
[sizeof (Errmsg
)-1] = '\0';
862 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
867 if (mbx_write (line
, ret
, arg
) != OK
)
869 strcpy (Errmsg
, strerror (errno
));
877 char *msg
= concat ("Error from POP server: ", pop_error
, "");
878 strncpy (Errmsg
, msg
, sizeof (Errmsg
));
879 Errmsg
[sizeof (Errmsg
)-1] = '\0';
888 mbx_write (char *line
, int len
, FILE *mbf
)
890 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
891 /* Do this as a macro instead of using strcmp to save on execution time. */
892 # define IS_FROM_LINE(a) ((a[0] == 'F') \
897 if (IS_FROM_LINE (line
))
899 if (fputc ('>', mbf
) == EOF
)
903 if (line
[0] == '\037')
905 if (fputs ("^_", mbf
) == EOF
)
910 if (fwrite (line
, 1, len
, mbf
) != len
)
912 if (fputc (0x0a, mbf
) == EOF
)
918 mbx_delimit_begin (FILE *mbf
)
922 char fromline
[40] = "From movemail ";
925 ltime
= localtime (&now
);
927 strcat (fromline
, asctime (ltime
));
929 if (fputs (fromline
, mbf
) == EOF
)
935 mbx_delimit_end (FILE *mbf
)
937 if (putc ('\n', mbf
) == EOF
)
942 #endif /* MAIL_USE_POP */
944 #ifndef HAVE_STRERROR
949 extern char *sys_errlist
[];
952 if (errnum
>= 0 && errnum
< sys_nerr
)
953 return sys_errlist
[errnum
];
954 return (char *) "Unknown error";
957 #endif /* ! HAVE_STRERROR */
960 /* movemail.c ends here */