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-2017 Free Software
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 (at
12 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/lockf 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 waitpid(child, var, flags) (*(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 */
102 #include <sys/locking.h>
105 /* If your system uses the `flock' or `lockf' system call for mail locking,
106 define MAIL_USE_SYSTEM_LOCK. If your system type should always define
107 MAIL_USE_LOCKF or MAIL_USE_FLOCK but configure does not do this,
108 please make a bug report. */
110 #ifdef MAIL_USE_LOCKF
111 #define MAIL_USE_SYSTEM_LOCK
114 #ifdef MAIL_USE_FLOCK
115 #define MAIL_USE_SYSTEM_LOCK
118 #if (!defined MAIL_USE_SYSTEM_LOCK \
119 && (defined HAVE_LIBMAIL || defined HAVE_LIBLOCKFILE) \
120 && defined HAVE_MAILLOCK_H)
121 #include <maillock.h>
122 /* We can't use maillock unless we know what directory system mail
125 #define MAIL_USE_MAILLOCK
126 static char *mail_spool_name (char *);
130 static _Noreturn
void fatal (const char *s1
, const char *s2
, const char *s3
);
131 static void error (const char *s1
, const char *s2
, const char *s3
);
132 static _Noreturn
void pfatal_with_name (char *name
);
133 static _Noreturn
void pfatal_and_delete (char *name
);
135 static int popmail (char *, char *, bool, char *, bool);
136 static bool pop_retr (popserver
, int, FILE *);
137 static bool mbx_write (char *, int, FILE *);
138 static bool mbx_delimit_begin (FILE *);
139 static bool mbx_delimit_end (FILE *);
142 #if (defined MAIL_USE_MAILLOCK \
143 || (!defined DISABLE_DIRECT_ACCESS && !defined MAIL_USE_SYSTEM_LOCK))
144 /* Like malloc but get fatal error if memory is exhausted. */
147 xmalloc (size_t size
)
149 void *result
= malloc (size
);
151 fatal ("virtual memory exhausted", 0, 0);
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
;
167 bool preserve_mail
= false;
169 #ifndef MAIL_USE_SYSTEM_LOCK
173 size_t inname_len
, inname_dirlen
;
175 #endif /* not MAIL_USE_SYSTEM_LOCK */
178 bool pop_reverse_order
= false;
180 #else /* ! MAIL_USE_POP */
182 #endif /* MAIL_USE_POP */
184 uid_t real_gid
= getgid ();
185 uid_t priv_gid
= getegid ();
189 while (0 <= (c
= getopt (argc
, argv
, ARGSTR
)))
194 pop_reverse_order
= true;
198 preserve_mail
= true;
207 (argc
- optind
< 2) || (argc
- optind
> 3)
214 fprintf (stderr
, "Usage: movemail [-p] [-r] inbox destfile%s\n",
217 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n", "");
222 inname
= argv
[optind
];
223 outname
= argv
[optind
+1];
226 fatal ("Destination file name is empty", 0, 0);
229 if (!strncmp (inname
, "po:", 3))
233 status
= popmail (inname
+ 3, outname
, preserve_mail
,
234 (argc
- optind
== 3) ? argv
[optind
+2] : NULL
,
239 if (setuid (getuid ()) < 0)
240 fatal ("Failed to drop privileges", 0, 0);
242 #endif /* MAIL_USE_POP */
244 #ifndef DISABLE_DIRECT_ACCESS
247 char *spool_name
= 0;
249 #ifdef MAIL_USE_MAILLOCK
250 spool_name
= mail_spool_name (inname
);
254 #ifndef MAIL_USE_SYSTEM_LOCK
255 /* Use a lock file named after our first argument with .lock appended:
256 If it exists, the mail file is locked. */
257 /* Note: this locking mechanism is *required* by the mailer
258 (on systems which use it) to prevent loss of mail.
260 On systems that use a lock file, extracting the mail without locking
261 WILL occasionally cause loss of mail due to timing errors!
263 So, if creation of the lock file fails due to access
264 permission on the mail spool directory, you simply MUST
265 change the permission and/or make movemail a setgid program
266 so it can create lock files properly.
268 You might also wish to verify that your system is one which
269 uses lock files for this purpose. Some systems use other methods. */
271 inname_len
= strlen (inname
);
272 lockname
= xmalloc (inname_len
+ sizeof ".lock");
273 strcpy (lockname
, inname
);
274 strcpy (lockname
+ inname_len
, ".lock");
275 for (inname_dirlen
= inname_len
;
276 inname_dirlen
&& !IS_DIRECTORY_SEP (inname
[inname_dirlen
- 1]);
279 tempname
= xmalloc (inname_dirlen
+ sizeof "EXXXXXX");
283 /* Create the lock file, but not under the lock file name. */
284 /* Give up if cannot do that. */
286 memcpy (tempname
, inname
, inname_dirlen
);
287 strcpy (tempname
+ inname_dirlen
, "EXXXXXX");
288 desc
= mkostemp (tempname
, O_BINARY
);
291 int mkostemp_errno
= errno
;
292 error ("error while creating what would become the lock file",
294 errno
= mkostemp_errno
;
295 pfatal_with_name (tempname
);
299 tem
= link (tempname
, lockname
);
301 if (tem
< 0 && errno
!= EEXIST
)
302 pfatal_with_name (lockname
);
309 /* If lock file is five minutes old, unlock it.
310 Five minutes should be good enough to cope with crashes
311 and wedgitude, and long enough to avoid being fooled
312 by time differences between machines. */
313 if (stat (lockname
, &st
) >= 0)
315 time_t now
= time (0);
316 if (st
.st_ctime
< now
- 300)
324 delete_lockname
= lockname
;
325 #endif /* not MAIL_USE_SYSTEM_LOCK */
329 signal (SIGCHLD
, SIG_DFL
);
332 pid_t child
= fork ();
334 fatal ("Error in fork; %s", strerror (errno
), 0);
340 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
344 if (setuid (getuid ()) < 0 || setregid (-1, real_gid
) < 0)
345 fatal ("Failed to drop privileges", 0, 0);
347 #ifdef MAIL_USE_SYSTEM_LOCK
348 indesc
= open (inname
, O_RDWR
| O_BINARY
);
349 #else /* if not MAIL_USE_SYSTEM_LOCK */
350 indesc
= open (inname
, O_RDONLY
| O_BINARY
);
351 #endif /* not MAIL_USE_SYSTEM_LOCK */
354 pfatal_with_name (inname
);
356 /* Make sure the user can read the output file. */
357 umask (umask (0) & 0377);
359 outdesc
= open (outname
, O_WRONLY
| O_BINARY
| O_CREAT
| O_EXCL
, 0666);
361 pfatal_with_name (outname
);
363 if (setregid (-1, priv_gid
) < 0)
364 fatal ("Failed to regain privileges", 0, 0);
366 /* This label exists so we can retry locking
367 after a delay, if it got EAGAIN or EBUSY. */
370 /* Try to lock it. */
371 #ifdef MAIL_USE_MAILLOCK
374 /* The "-" is to make it a negative number if maillock returns
376 status
= - maillock (spool_name
, 1);
377 #ifdef HAVE_TOUCHLOCK
378 touched_lock
= time (0);
383 #endif /* MAIL_USE_MAILLOCK */
385 #ifdef MAIL_USE_SYSTEM_LOCK
386 #ifdef MAIL_USE_LOCKF
387 status
= lockf (indesc
, F_LOCK
, 0);
388 #else /* not MAIL_USE_LOCKF */
390 status
= locking (indesc
, LK_RLCK
, -1L);
392 status
= flock (indesc
, LOCK_EX
);
394 #endif /* not MAIL_USE_LOCKF */
395 #endif /* MAIL_USE_SYSTEM_LOCK */
398 /* If it fails, retry up to 5 times
399 for certain failure codes. */
402 if (++lockcount
<= 5 && (errno
== EAGAIN
|| errno
== EBUSY
))
408 pfatal_with_name (inname
);
416 nread
= read (indesc
, buf
, sizeof buf
);
418 pfatal_with_name (inname
);
419 if (nread
!= write (outdesc
, buf
, nread
))
421 int saved_errno
= errno
;
424 pfatal_with_name (outname
);
426 if (nread
< sizeof buf
)
428 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
431 time_t now
= time (0);
432 if (now
- touched_lock
> 60)
438 #endif /* MAIL_USE_MAILLOCK */
442 if (fsync (outdesc
) != 0 && errno
!= EINVAL
)
443 pfatal_and_delete (outname
);
445 /* Prevent symlink attacks truncating other users' mailboxes */
446 if (setregid (-1, real_gid
) < 0)
447 fatal ("Failed to drop privileges", 0, 0);
449 /* Check to make sure no errors before we zap the inbox. */
450 if (close (outdesc
) != 0)
451 pfatal_and_delete (outname
);
453 #ifdef MAIL_USE_SYSTEM_LOCK
456 if (ftruncate (indesc
, 0) != 0)
457 pfatal_with_name (inname
);
459 #endif /* MAIL_USE_SYSTEM_LOCK */
463 #ifndef MAIL_USE_SYSTEM_LOCK
466 /* Delete the input file; if we can't, at least get rid of its
468 #ifdef MAIL_UNLINK_SPOOL
469 /* This is generally bad to do, because it destroys the permissions
470 that were set on the file. Better to just empty the file. */
471 if (unlink (inname
) < 0 && errno
!= ENOENT
)
472 #endif /* MAIL_UNLINK_SPOOL */
473 creat (inname
, 0600);
475 #endif /* not MAIL_USE_SYSTEM_LOCK */
477 /* End of mailbox truncation */
478 if (setregid (-1, priv_gid
) < 0)
479 fatal ("Failed to regain privileges", 0, 0);
481 #ifdef MAIL_USE_MAILLOCK
482 /* This has to occur in the child, i.e., in the process that
483 acquired the lock! */
490 if (waitpid (child
, &wait_status
, 0) < 0)
491 fatal ("Error in waitpid; %s", strerror (errno
), 0);
492 if (!WIFEXITED (wait_status
))
494 else if (WEXITSTATUS (wait_status
) != 0)
495 return WEXITSTATUS (wait_status
);
500 #endif /* ! DISABLE_DIRECT_ACCESS */
505 #ifdef MAIL_USE_MAILLOCK
506 /* This function uses stat to confirm that the mail directory is
507 identical to the directory of the input file, rather than just
508 string-comparing the two paths, because one or both of them might
509 be symbolic links pointing to some other directory. */
511 mail_spool_name (char *inname
)
513 struct stat stat1
, stat2
;
517 if (! (fname
= strrchr (inname
, '/')))
522 if (stat (MAILDIR
, &stat1
) < 0)
525 indir
= xmalloc (fname
- inname
+ 1);
526 memcpy (indir
, inname
, fname
- inname
);
527 indir
[fname
-inname
] = '\0';
530 status
= stat (indir
, &stat2
);
537 if (stat1
.st_dev
== stat2
.st_dev
538 && stat1
.st_ino
== stat2
.st_ino
)
543 #endif /* MAIL_USE_MAILLOCK */
545 /* Print error message and exit. */
548 fatal (const char *s1
, const char *s2
, const char *s3
)
551 unlink (delete_lockname
);
556 /* Print error message. `s1' is printf control string, `s2' and `s3'
557 are args for it or null. */
560 error (const char *s1
, const char *s2
, const char *s3
)
562 fprintf (stderr
, "movemail: ");
564 fprintf (stderr
, s1
, s2
, s3
);
566 fprintf (stderr
, s1
, s2
);
568 fprintf (stderr
, "%s", s1
);
569 fprintf (stderr
, "\n");
573 pfatal_with_name (char *name
)
575 fatal ("%s for %s", strerror (errno
), name
);
579 pfatal_and_delete (char *name
)
581 char *s
= strerror (errno
);
583 fatal ("%s for %s", s
, name
);
586 /* This is the guts of the interface to the Post Office Protocol. */
591 #include <sys/socket.h>
592 #include <netinet/in.h>
602 * The full valid syntax for a POP mailbox specification for movemail
603 * is "po:username:hostname". The ":hostname" is optional; if it is
604 * omitted, the MAILHOST environment variable will be consulted. Note
605 * that by the time popmail() is called the "po:" has been stripped
606 * off of the front of the mailbox name.
608 * If the mailbox is in the form "po:username:hostname", then it is
609 * modified by this function -- the second colon is replaced by a
612 * Return a value suitable for passing to `exit'.
616 popmail (char *mailbox
, char *outfile
, bool preserve
, char *password
,
624 int start
, end
, increment
;
625 char *user
, *hostname
;
628 if ((hostname
= strchr (mailbox
, ':')))
631 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
634 error ("Error connecting to POP server: %s", pop_error
, 0);
638 if (pop_stat (server
, &nmsgs
, &nbytes
))
640 error ("Error getting message count from POP server: %s", pop_error
, 0);
650 mbfi
= open (outfile
, O_WRONLY
| O_BINARY
| O_CREAT
| O_EXCL
, 0666);
654 error ("Error in open: %s, %s", strerror (errno
), outfile
);
658 if (fchown (mbfi
, getuid (), -1) != 0)
660 int fchown_errno
= errno
;
662 if (fstat (mbfi
, &st
) != 0 || st
.st_uid
!= getuid ())
665 error ("Error in fchown: %s, %s", strerror (fchown_errno
), outfile
);
670 mbf
= fdopen (mbfi
, "wb");
674 error ("Error in fdopen: %s", strerror (errno
), 0);
693 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
694 if (! (mbx_delimit_begin (mbf
)
695 && pop_retr (server
, i
, mbf
)
696 && mbx_delimit_end (mbf
)
697 && fflush (mbf
) == 0))
700 error ("Error in POP retrieving: %s", strerror (errno
), 0);
706 if (fsync (mbfi
) != 0 && errno
!= EINVAL
)
708 error ("Error in fsync: %s", strerror (errno
), 0);
713 if (fclose (mbf
) != 0)
715 error ("Error in fclose: %s", strerror (errno
), 0);
720 for (i
= 1; i
<= nmsgs
; i
++)
722 if (pop_delete (server
, i
))
724 error ("Error from POP server: %s", pop_error
, 0);
730 if (pop_quit (server
))
732 error ("Error from POP server: %s", pop_error
, 0);
740 pop_retr (popserver server
, int msgno
, FILE *arg
)
745 if (pop_retrieve_first (server
, msgno
, &line
))
747 error ("Error from POP server: %s", pop_error
, 0);
752 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
757 if (! mbx_write (line
, ret
, arg
))
759 int write_errno
= errno
;
768 error ("Error from POP server: %s", pop_error
, 0);
777 mbx_write (char *line
, int len
, FILE *mbf
)
779 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
780 /* Do this as a macro instead of using strcmp to save on execution time. */
781 # define IS_FROM_LINE(a) ((a[0] == 'F') \
786 if (IS_FROM_LINE (line
))
788 if (fputc ('>', mbf
) < 0)
792 if (line
[0] == '\037')
794 if (fputs ("^_", mbf
) < 0)
799 return fwrite (line
, 1, len
, mbf
) == len
&& 0 <= fputc ('\n', mbf
);
803 /* Work around MS-Windows lack of support for %e or %T with a
804 special-purpose strftime that assumes the exact format that
807 movemail_strftime (char *s
, size_t size
, char const *format
,
810 char fmt
[size
+ 6], *q
;
813 for (p
= format
, q
= &fmt
[0]; *p
; )
815 if (*p
== '%' && p
[1] == 'e')
821 else if (*p
== '%' && p
[1] == 'T')
823 memcpy (q
, "%H:%M:%S", 8);
827 else if (*p
== '%' && p
[1] == '%')
837 size_t n
= strftime (s
, size
, fmt
, tm
);
838 char *mday
= s
+ sizeof "From movemail Sun Jan " - 1;
844 # define strftime movemail_strftime
848 mbx_delimit_begin (FILE *mbf
)
850 time_t now
= time (NULL
);
851 struct tm
*ltime
= localtime (&now
);
856 if (! strftime (fromline
, sizeof fromline
,
857 "From movemail %a %b %e %T %Y\n", ltime
))
862 return 0 <= fputs (fromline
, mbf
);
866 mbx_delimit_end (FILE *mbf
)
868 return 0 <= putc ('\n', mbf
);
871 #endif /* MAIL_USE_POP */