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 error ("error while creating what would become the lock file",
330 errno
= mkstemp_errno
;
331 pfatal_with_name (tempname
);
335 tem
= link (tempname
, lockname
);
338 if (tem
< 0 && errno
== EPERM
)
339 fatal ("Unable to create hard link between %s and %s",
348 /* If lock file is five minutes old, unlock it.
349 Five minutes should be good enough to cope with crashes
350 and wedgitude, and long enough to avoid being fooled
351 by time differences between machines. */
352 if (stat (lockname
, &st
) >= 0)
354 time_t now
= time (0);
355 if (st
.st_ctime
< now
- 300)
360 delete_lockname
= lockname
;
362 #endif /* not MAIL_USE_SYSTEM_LOCK */
363 #endif /* not MAIL_USE_MMDF */
369 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
376 if (setuid (getuid ()) < 0 || setregid (-1, real_gid
) < 0)
377 fatal ("Failed to drop privileges", 0, 0);
379 #ifndef MAIL_USE_MMDF
380 #ifdef MAIL_USE_SYSTEM_LOCK
381 indesc
= open (inname
, O_RDWR
);
382 #else /* if not MAIL_USE_SYSTEM_LOCK */
383 indesc
= open (inname
, O_RDONLY
);
384 #endif /* not MAIL_USE_SYSTEM_LOCK */
385 #else /* MAIL_USE_MMDF */
386 indesc
= lk_open (inname
, O_RDONLY
, 0, 0, 10);
387 #endif /* MAIL_USE_MMDF */
390 pfatal_with_name (inname
);
393 /* In case movemail is setuid to root, make sure the user can
394 read the output file. */
395 /* This is desirable for all systems
396 but I don't want to assume all have the umask system call */
397 umask (umask (0) & 0333);
398 #endif /* BSD_SYSTEM */
399 outdesc
= open (outname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
401 pfatal_with_name (outname
);
403 if (setregid (-1, priv_gid
) < 0)
404 fatal ("Failed to regain privileges", 0, 0);
406 /* This label exists so we can retry locking
407 after a delay, if it got EAGAIN or EBUSY. */
410 /* Try to lock it. */
411 #ifdef MAIL_USE_MAILLOCK
414 /* The "0 - " is to make it a negative number if maillock returns
416 status
= 0 - maillock (spool_name
, 1);
417 #ifdef HAVE_TOUCHLOCK
418 touched_lock
= time (0);
423 #endif /* MAIL_USE_MAILLOCK */
425 #ifdef MAIL_USE_SYSTEM_LOCK
426 #ifdef MAIL_USE_LOCKF
427 status
= lockf (indesc
, F_LOCK
, 0);
428 #else /* not MAIL_USE_LOCKF */
430 status
= locking (indesc
, LK_RLCK
, -1L);
432 status
= flock (indesc
, LOCK_EX
);
434 #endif /* not MAIL_USE_LOCKF */
435 #endif /* MAIL_USE_SYSTEM_LOCK */
438 /* If it fails, retry up to 5 times
439 for certain failure codes. */
442 if (++lockcount
<= 5)
460 pfatal_with_name (inname
);
468 nread
= read (indesc
, buf
, sizeof buf
);
470 pfatal_with_name (inname
);
471 if (nread
!= write (outdesc
, buf
, nread
))
473 int saved_errno
= errno
;
476 pfatal_with_name (outname
);
478 if (nread
< sizeof buf
)
480 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
483 time_t now
= time (0);
484 if (now
- touched_lock
> 60)
490 #endif /* MAIL_USE_MAILLOCK */
495 if (fsync (outdesc
) < 0)
496 pfatal_and_delete (outname
);
499 /* Prevent symlink attacks truncating other users' mailboxes */
500 if (setregid (-1, real_gid
) < 0)
501 fatal ("Failed to drop privileges", 0, 0);
503 /* Check to make sure no errors before we zap the inbox. */
504 if (close (outdesc
) != 0)
505 pfatal_and_delete (outname
);
507 #ifdef MAIL_USE_SYSTEM_LOCK
510 if (ftruncate (indesc
, 0L) != 0)
511 pfatal_with_name (inname
);
513 #endif /* MAIL_USE_SYSTEM_LOCK */
516 lk_close (indesc
, 0, 0, 0);
521 #ifndef MAIL_USE_SYSTEM_LOCK
524 /* Delete the input file; if we can't, at least get rid of its
526 #ifdef MAIL_UNLINK_SPOOL
527 /* This is generally bad to do, because it destroys the permissions
528 that were set on the file. Better to just empty the file. */
529 if (unlink (inname
) < 0 && errno
!= ENOENT
)
530 #endif /* MAIL_UNLINK_SPOOL */
531 creat (inname
, 0600);
533 #endif /* not MAIL_USE_SYSTEM_LOCK */
535 /* End of mailbox truncation */
536 if (setregid (-1, priv_gid
) < 0)
537 fatal ("Failed to regain privileges", 0, 0);
539 #ifdef MAIL_USE_MAILLOCK
540 /* This has to occur in the child, i.e., in the process that
541 acquired the lock! */
549 if (!WIFEXITED (wait_status
))
551 else if (WRETCODE (wait_status
) != 0)
552 exit (WRETCODE (wait_status
));
554 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
555 #ifdef MAIL_USE_MAILLOCK
557 #endif /* MAIL_USE_MAILLOCK */
559 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
561 #endif /* ! DISABLE_DIRECT_ACCESS */
566 #ifdef MAIL_USE_MAILLOCK
567 /* This function uses stat to confirm that the mail directory is
568 identical to the directory of the input file, rather than just
569 string-comparing the two paths, because one or both of them might
570 be symbolic links pointing to some other directory. */
572 mail_spool_name (char *inname
)
574 struct stat stat1
, stat2
;
578 if (! (fname
= strrchr (inname
, '/')))
583 if (stat (MAILDIR
, &stat1
) < 0)
586 indir
= (char *) xmalloc (fname
- inname
+ 1);
587 strncpy (indir
, inname
, fname
- inname
);
588 indir
[fname
-inname
] = '\0';
591 status
= stat (indir
, &stat2
);
598 if (stat1
.st_dev
== stat2
.st_dev
599 && stat1
.st_ino
== stat2
.st_ino
)
604 #endif /* MAIL_USE_MAILLOCK */
606 /* Print error message and exit. */
609 fatal (const char *s1
, const char *s2
, const char *s3
)
612 unlink (delete_lockname
);
617 /* Print error message. `s1' is printf control string, `s2' and `s3'
618 are args for it or null. */
621 error (const char *s1
, const char *s2
, const char *s3
)
623 fprintf (stderr
, "movemail: ");
625 fprintf (stderr
, s1
, s2
, s3
);
627 fprintf (stderr
, s1
, s2
);
629 fprintf (stderr
, "%s", s1
);
630 fprintf (stderr
, "\n");
634 pfatal_with_name (char *name
)
636 fatal ("%s for %s", strerror (errno
), name
);
640 pfatal_and_delete (char *name
)
642 char *s
= strerror (errno
);
644 fatal ("%s for %s", s
, name
);
647 /* Return a newly-allocated string whose contents concatenate those of s1, s2, s3. */
650 concat (const char *s1
, const char *s2
, const char *s3
)
652 size_t len1
= strlen (s1
), len2
= strlen (s2
), len3
= strlen (s3
);
653 char *result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
656 strcpy (result
+ len1
, s2
);
657 strcpy (result
+ len1
+ len2
, s3
);
658 *(result
+ len1
+ len2
+ len3
) = 0;
663 /* Like malloc but get fatal error if memory is exhausted. */
666 xmalloc (unsigned int size
)
668 long *result
= (long *) malloc (size
);
670 fatal ("virtual memory exhausted", 0, 0);
674 /* This is the guts of the interface to the Post Office Protocol. */
679 #include <sys/socket.h>
680 #include <netinet/in.h>
692 static char Errmsg
[200]; /* POP errors, at least, can exceed
693 the original length of 80. */
696 * The full valid syntax for a POP mailbox specification for movemail
697 * is "po:username:hostname". The ":hostname" is optional; if it is
698 * omitted, the MAILHOST environment variable will be consulted. Note
699 * that by the time popmail() is called the "po:" has been stripped
700 * off of the front of the mailbox name.
702 * If the mailbox is in the form "po:username:hostname", then it is
703 * modified by this function -- the second colon is replaced by a
706 * Return a value suitable for passing to `exit'.
710 popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
)
716 char *getenv (const char *);
718 int start
, end
, increment
;
719 char *user
, *hostname
;
722 if ((hostname
= strchr (mailbox
, ':')))
725 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
728 error ("Error connecting to POP server: %s", pop_error
, 0);
732 if (pop_stat (server
, &nmsgs
, &nbytes
))
734 error ("Error getting message count from POP server: %s", pop_error
, 0);
744 mbfi
= open (outfile
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
748 error ("Error in open: %s, %s", strerror (errno
), outfile
);
752 if (fchown (mbfi
, getuid (), -1) != 0)
754 int fchown_errno
= errno
;
756 if (fstat (mbfi
, &st
) != 0 || st
.st_uid
!= getuid ())
759 error ("Error in fchown: %s, %s", strerror (fchown_errno
), outfile
);
764 if ((mbf
= fdopen (mbfi
, "wb")) == NULL
)
767 error ("Error in fdopen: %s", strerror (errno
), 0);
786 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
788 mbx_delimit_begin (mbf
);
789 if (pop_retr (server
, i
, mbf
) != OK
)
791 error ("%s", Errmsg
, 0);
795 mbx_delimit_end (mbf
);
799 error ("Error in fflush: %s", strerror (errno
), 0);
806 /* On AFS, a call to write only modifies the file in the local
807 * workstation's AFS cache. The changes are not written to the server
808 * until a call to fsync or close is made. Users with AFS home
809 * directories have lost mail when over quota because these checks were
810 * not made in previous versions of movemail. */
813 if (fsync (mbfi
) < 0)
815 error ("Error in fsync: %s", strerror (errno
), 0);
820 if (close (mbfi
) == -1)
822 error ("Error in close: %s", strerror (errno
), 0);
827 for (i
= 1; i
<= nmsgs
; i
++)
829 if (pop_delete (server
, i
))
831 error ("Error from POP server: %s", pop_error
, 0);
837 if (pop_quit (server
))
839 error ("Error from POP server: %s", pop_error
, 0);
847 pop_retr (popserver server
, int msgno
, FILE *arg
)
852 if (pop_retrieve_first (server
, msgno
, &line
))
854 char *msg
= concat ("Error from POP server: ", pop_error
, "");
855 strncpy (Errmsg
, msg
, sizeof (Errmsg
));
856 Errmsg
[sizeof (Errmsg
)-1] = '\0';
861 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
866 if (mbx_write (line
, ret
, arg
) != OK
)
868 strcpy (Errmsg
, strerror (errno
));
876 char *msg
= concat ("Error from POP server: ", pop_error
, "");
877 strncpy (Errmsg
, msg
, sizeof (Errmsg
));
878 Errmsg
[sizeof (Errmsg
)-1] = '\0';
887 mbx_write (char *line
, int len
, FILE *mbf
)
889 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
890 /* Do this as a macro instead of using strcmp to save on execution time. */
891 # define IS_FROM_LINE(a) ((a[0] == 'F') \
896 if (IS_FROM_LINE (line
))
898 if (fputc ('>', mbf
) == EOF
)
902 if (line
[0] == '\037')
904 if (fputs ("^_", mbf
) == EOF
)
909 if (fwrite (line
, 1, len
, mbf
) != len
)
911 if (fputc (0x0a, mbf
) == EOF
)
917 mbx_delimit_begin (FILE *mbf
)
921 char fromline
[40] = "From movemail ";
924 ltime
= localtime (&now
);
926 strcat (fromline
, asctime (ltime
));
928 if (fputs (fromline
, mbf
) == EOF
)
934 mbx_delimit_end (FILE *mbf
)
936 if (putc ('\n', mbf
) == EOF
)
941 #endif /* MAIL_USE_POP */
943 #ifndef HAVE_STRERROR
948 extern char *sys_errlist
[];
951 if (errnum
>= 0 && errnum
< sys_nerr
)
952 return sys_errlist
[errnum
];
953 return (char *) "Unknown error";
956 #endif /* ! HAVE_STRERROR */
959 /* movemail.c ends here */