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>
72 #include <unlocked-io.h>
88 #define waitpid(child, var, flags) (*(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 */
104 #include <sys/locking.h>
107 /* If your system uses the `flock' or `lockf' system call for mail locking,
108 define MAIL_USE_SYSTEM_LOCK. If your system type should always define
109 MAIL_USE_LOCKF or MAIL_USE_FLOCK but configure does not do this,
110 please make a bug report. */
112 #ifdef MAIL_USE_LOCKF
113 #define MAIL_USE_SYSTEM_LOCK
116 #ifdef MAIL_USE_FLOCK
117 #define MAIL_USE_SYSTEM_LOCK
120 #if (!defined MAIL_USE_SYSTEM_LOCK \
121 && (defined HAVE_LIBMAIL || defined HAVE_LIBLOCKFILE) \
122 && defined HAVE_MAILLOCK_H)
123 #include <maillock.h>
124 /* We can't use maillock unless we know what directory system mail
127 #define MAIL_USE_MAILLOCK
128 static char *mail_spool_name (char *);
132 static _Noreturn
void fatal (const char *s1
, const char *s2
, const char *s3
);
133 static void error (const char *s1
, const char *s2
, const char *s3
);
134 static _Noreturn
void pfatal_with_name (char *name
);
135 static _Noreturn
void pfatal_and_delete (char *name
);
137 static int popmail (char *, char *, bool, char *, bool);
138 static bool pop_retr (popserver
, int, FILE *);
139 static bool mbx_write (char *, int, FILE *);
140 static bool mbx_delimit_begin (FILE *);
141 static bool mbx_delimit_end (FILE *);
144 #if (defined MAIL_USE_MAILLOCK \
145 || (!defined DISABLE_DIRECT_ACCESS && !defined MAIL_USE_SYSTEM_LOCK))
146 /* Like malloc but get fatal error if memory is exhausted. */
149 xmalloc (size_t size
)
151 void *result
= malloc (size
);
153 fatal ("virtual memory exhausted", 0, 0);
158 /* Nonzero means this is name of a lock file to delete on fatal error. */
159 static char *delete_lockname
;
162 main (int argc
, char **argv
)
164 char *inname
, *outname
;
169 bool preserve_mail
= false;
171 #ifndef MAIL_USE_SYSTEM_LOCK
175 size_t inname_len
, inname_dirlen
;
177 #endif /* not MAIL_USE_SYSTEM_LOCK */
180 bool pop_reverse_order
= false;
182 #else /* ! MAIL_USE_POP */
184 #endif /* MAIL_USE_POP */
186 uid_t real_gid
= getgid ();
187 uid_t priv_gid
= getegid ();
191 while (0 <= (c
= getopt (argc
, argv
, ARGSTR
)))
196 pop_reverse_order
= true;
200 preserve_mail
= true;
209 (argc
- optind
< 2) || (argc
- optind
> 3)
216 fprintf (stderr
, "Usage: movemail [-p] [-r] inbox destfile%s\n",
219 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n", "");
224 inname
= argv
[optind
];
225 outname
= argv
[optind
+1];
228 fatal ("Destination file name is empty", 0, 0);
231 if (!strncmp (inname
, "po:", 3))
235 status
= popmail (inname
+ 3, outname
, preserve_mail
,
236 (argc
- optind
== 3) ? argv
[optind
+2] : NULL
,
241 if (setuid (getuid ()) < 0)
242 fatal ("Failed to drop privileges", 0, 0);
244 #endif /* MAIL_USE_POP */
246 #ifndef DISABLE_DIRECT_ACCESS
249 char *spool_name
= 0;
251 #ifdef MAIL_USE_MAILLOCK
252 spool_name
= mail_spool_name (inname
);
256 #ifndef MAIL_USE_SYSTEM_LOCK
257 /* Use a lock file named after our first argument with .lock appended:
258 If it exists, the mail file is locked. */
259 /* Note: this locking mechanism is *required* by the mailer
260 (on systems which use it) to prevent loss of mail.
262 On systems that use a lock file, extracting the mail without locking
263 WILL occasionally cause loss of mail due to timing errors!
265 So, if creation of the lock file fails due to access
266 permission on the mail spool directory, you simply MUST
267 change the permission and/or make movemail a setgid program
268 so it can create lock files properly.
270 You might also wish to verify that your system is one which
271 uses lock files for this purpose. Some systems use other methods. */
273 inname_len
= strlen (inname
);
274 lockname
= xmalloc (inname_len
+ sizeof ".lock");
275 strcpy (lockname
, inname
);
276 strcpy (lockname
+ inname_len
, ".lock");
277 for (inname_dirlen
= inname_len
;
278 inname_dirlen
&& !IS_DIRECTORY_SEP (inname
[inname_dirlen
- 1]);
281 tempname
= xmalloc (inname_dirlen
+ sizeof "EXXXXXX");
285 /* Create the lock file, but not under the lock file name. */
286 /* Give up if cannot do that. */
288 memcpy (tempname
, inname
, inname_dirlen
);
289 strcpy (tempname
+ inname_dirlen
, "EXXXXXX");
290 desc
= mkostemp (tempname
, O_BINARY
);
293 int mkostemp_errno
= errno
;
294 error ("error while creating what would become the lock file",
296 errno
= mkostemp_errno
;
297 pfatal_with_name (tempname
);
301 tem
= link (tempname
, lockname
);
303 if (tem
< 0 && errno
!= EEXIST
)
304 pfatal_with_name (lockname
);
311 /* If lock file is five minutes old, unlock it.
312 Five minutes should be good enough to cope with crashes
313 and wedgitude, and long enough to avoid being fooled
314 by time differences between machines. */
315 if (stat (lockname
, &st
) >= 0)
317 time_t now
= time (0);
318 if (st
.st_ctime
< now
- 300)
326 delete_lockname
= lockname
;
327 #endif /* not MAIL_USE_SYSTEM_LOCK */
331 signal (SIGCHLD
, SIG_DFL
);
334 pid_t child
= fork ();
336 fatal ("Error in fork; %s", strerror (errno
), 0);
342 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
346 if (setuid (getuid ()) < 0 || setregid (-1, real_gid
) < 0)
347 fatal ("Failed to drop privileges", 0, 0);
349 #ifdef MAIL_USE_SYSTEM_LOCK
350 indesc
= open (inname
, O_RDWR
| O_BINARY
);
351 #else /* if not MAIL_USE_SYSTEM_LOCK */
352 indesc
= open (inname
, O_RDONLY
| O_BINARY
);
353 #endif /* not MAIL_USE_SYSTEM_LOCK */
356 pfatal_with_name (inname
);
358 /* Make sure the user can read the output file. */
359 umask (umask (0) & 0377);
361 outdesc
= open (outname
, O_WRONLY
| O_BINARY
| O_CREAT
| O_EXCL
, 0666);
363 pfatal_with_name (outname
);
365 if (setregid (-1, priv_gid
) < 0)
366 fatal ("Failed to regain privileges", 0, 0);
368 /* This label exists so we can retry locking
369 after a delay, if it got EAGAIN or EBUSY. */
372 /* Try to lock it. */
373 #ifdef MAIL_USE_MAILLOCK
376 /* The "-" is to make it a negative number if maillock returns
378 status
= - maillock (spool_name
, 1);
379 #ifdef HAVE_TOUCHLOCK
380 touched_lock
= time (0);
385 #endif /* MAIL_USE_MAILLOCK */
387 #ifdef MAIL_USE_SYSTEM_LOCK
388 #ifdef MAIL_USE_LOCKF
389 status
= lockf (indesc
, F_LOCK
, 0);
390 #else /* not MAIL_USE_LOCKF */
392 status
= locking (indesc
, LK_RLCK
, -1L);
394 status
= flock (indesc
, LOCK_EX
);
396 #endif /* not MAIL_USE_LOCKF */
397 #endif /* MAIL_USE_SYSTEM_LOCK */
400 /* If it fails, retry up to 5 times
401 for certain failure codes. */
404 if (++lockcount
<= 5 && (errno
== EAGAIN
|| errno
== EBUSY
))
410 pfatal_with_name (inname
);
418 nread
= read (indesc
, buf
, sizeof buf
);
420 pfatal_with_name (inname
);
421 if (nread
!= write (outdesc
, buf
, nread
))
423 int saved_errno
= errno
;
426 pfatal_with_name (outname
);
428 if (nread
< sizeof buf
)
430 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
433 time_t now
= time (0);
434 if (now
- touched_lock
> 60)
440 #endif /* MAIL_USE_MAILLOCK */
444 if (fsync (outdesc
) != 0 && errno
!= EINVAL
)
445 pfatal_and_delete (outname
);
447 /* Prevent symlink attacks truncating other users' mailboxes */
448 if (setregid (-1, real_gid
) < 0)
449 fatal ("Failed to drop privileges", 0, 0);
451 /* Check to make sure no errors before we zap the inbox. */
452 if (close (outdesc
) != 0)
453 pfatal_and_delete (outname
);
455 #ifdef MAIL_USE_SYSTEM_LOCK
458 if (ftruncate (indesc
, 0) != 0)
459 pfatal_with_name (inname
);
461 #endif /* MAIL_USE_SYSTEM_LOCK */
465 #ifndef MAIL_USE_SYSTEM_LOCK
468 /* Delete the input file; if we can't, at least get rid of its
470 #ifdef MAIL_UNLINK_SPOOL
471 /* This is generally bad to do, because it destroys the permissions
472 that were set on the file. Better to just empty the file. */
473 if (unlink (inname
) < 0 && errno
!= ENOENT
)
474 #endif /* MAIL_UNLINK_SPOOL */
475 creat (inname
, 0600);
477 #endif /* not MAIL_USE_SYSTEM_LOCK */
479 /* End of mailbox truncation */
480 if (setregid (-1, priv_gid
) < 0)
481 fatal ("Failed to regain privileges", 0, 0);
483 #ifdef MAIL_USE_MAILLOCK
484 /* This has to occur in the child, i.e., in the process that
485 acquired the lock! */
492 if (waitpid (child
, &wait_status
, 0) < 0)
493 fatal ("Error in waitpid; %s", strerror (errno
), 0);
494 if (!WIFEXITED (wait_status
))
496 else if (WEXITSTATUS (wait_status
) != 0)
497 return WEXITSTATUS (wait_status
);
502 #endif /* ! DISABLE_DIRECT_ACCESS */
507 #ifdef MAIL_USE_MAILLOCK
508 /* This function uses stat to confirm that the mail directory is
509 identical to the directory of the input file, rather than just
510 string-comparing the two paths, because one or both of them might
511 be symbolic links pointing to some other directory. */
513 mail_spool_name (char *inname
)
515 struct stat stat1
, stat2
;
519 if (! (fname
= strrchr (inname
, '/')))
524 if (stat (MAILDIR
, &stat1
) < 0)
527 indir
= xmalloc (fname
- inname
+ 1);
528 memcpy (indir
, inname
, fname
- inname
);
529 indir
[fname
-inname
] = '\0';
532 status
= stat (indir
, &stat2
);
539 if (stat1
.st_dev
== stat2
.st_dev
540 && stat1
.st_ino
== stat2
.st_ino
)
545 #endif /* MAIL_USE_MAILLOCK */
547 /* Print error message and exit. */
550 fatal (const char *s1
, const char *s2
, const char *s3
)
553 unlink (delete_lockname
);
558 /* Print error message. `s1' is printf control string, `s2' and `s3'
559 are args for it or null. */
562 error (const char *s1
, const char *s2
, const char *s3
)
564 fprintf (stderr
, "movemail: ");
566 fprintf (stderr
, s1
, s2
, s3
);
568 fprintf (stderr
, s1
, s2
);
570 fprintf (stderr
, "%s", s1
);
571 fprintf (stderr
, "\n");
575 pfatal_with_name (char *name
)
577 fatal ("%s for %s", strerror (errno
), name
);
581 pfatal_and_delete (char *name
)
583 char *s
= strerror (errno
);
585 fatal ("%s for %s", s
, name
);
588 /* This is the guts of the interface to the Post Office Protocol. */
593 #include <sys/socket.h>
594 #include <netinet/in.h>
604 * The full valid syntax for a POP mailbox specification for movemail
605 * is "po:username:hostname". The ":hostname" is optional; if it is
606 * omitted, the MAILHOST environment variable will be consulted. Note
607 * that by the time popmail() is called the "po:" has been stripped
608 * off of the front of the mailbox name.
610 * If the mailbox is in the form "po:username:hostname", then it is
611 * modified by this function -- the second colon is replaced by a
614 * Return a value suitable for passing to `exit'.
618 popmail (char *mailbox
, char *outfile
, bool preserve
, char *password
,
626 int start
, end
, increment
;
627 char *user
, *hostname
;
630 if ((hostname
= strchr (mailbox
, ':')))
633 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
636 error ("Error connecting to POP server: %s", pop_error
, 0);
640 if (pop_stat (server
, &nmsgs
, &nbytes
))
642 error ("Error getting message count from POP server: %s", pop_error
, 0);
652 mbfi
= open (outfile
, O_WRONLY
| O_BINARY
| O_CREAT
| O_EXCL
, 0666);
656 error ("Error in open: %s, %s", strerror (errno
), outfile
);
660 if (fchown (mbfi
, getuid (), -1) != 0)
662 int fchown_errno
= errno
;
664 if (fstat (mbfi
, &st
) != 0 || st
.st_uid
!= getuid ())
667 error ("Error in fchown: %s, %s", strerror (fchown_errno
), outfile
);
672 mbf
= fdopen (mbfi
, "wb");
676 error ("Error in fdopen: %s", strerror (errno
), 0);
695 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
696 if (! (mbx_delimit_begin (mbf
)
697 && pop_retr (server
, i
, mbf
)
698 && mbx_delimit_end (mbf
)
699 && fflush (mbf
) == 0))
702 error ("Error in POP retrieving: %s", strerror (errno
), 0);
708 if (fsync (mbfi
) != 0 && errno
!= EINVAL
)
710 error ("Error in fsync: %s", strerror (errno
), 0);
715 if (fclose (mbf
) != 0)
717 error ("Error in fclose: %s", strerror (errno
), 0);
722 for (i
= 1; i
<= nmsgs
; i
++)
724 if (pop_delete (server
, i
))
726 error ("Error from POP server: %s", pop_error
, 0);
732 if (pop_quit (server
))
734 error ("Error from POP server: %s", pop_error
, 0);
742 pop_retr (popserver server
, int msgno
, FILE *arg
)
747 if (pop_retrieve_first (server
, msgno
, &line
))
749 error ("Error from POP server: %s", pop_error
, 0);
754 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
759 if (! mbx_write (line
, ret
, arg
))
761 int write_errno
= errno
;
770 error ("Error from POP server: %s", pop_error
, 0);
779 mbx_write (char *line
, int len
, FILE *mbf
)
781 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
782 /* Do this as a macro instead of using strcmp to save on execution time. */
783 # define IS_FROM_LINE(a) ((a[0] == 'F') \
788 if (IS_FROM_LINE (line
))
790 if (fputc ('>', mbf
) < 0)
794 if (line
[0] == '\037')
796 if (fputs ("^_", mbf
) < 0)
801 return fwrite (line
, 1, len
, mbf
) == len
&& 0 <= fputc ('\n', mbf
);
805 /* Work around MS-Windows lack of support for %e or %T with a
806 special-purpose strftime that assumes the exact format that
809 movemail_strftime (char *s
, size_t size
, char const *format
,
812 char fmt
[size
+ 6], *q
;
815 for (p
= format
, q
= &fmt
[0]; *p
; )
817 if (*p
== '%' && p
[1] == 'e')
823 else if (*p
== '%' && p
[1] == 'T')
825 memcpy (q
, "%H:%M:%S", 8);
829 else if (*p
== '%' && p
[1] == '%')
839 size_t n
= strftime (s
, size
, fmt
, tm
);
840 char *mday
= s
+ sizeof "From movemail Sun Jan " - 1;
846 # define strftime movemail_strftime
850 mbx_delimit_begin (FILE *mbf
)
852 time_t now
= time (NULL
);
853 struct tm
*ltime
= localtime (&now
);
858 if (! strftime (fromline
, sizeof fromline
,
859 "From movemail %a %b %e %T %Y\n", ltime
))
864 return 0 <= fputs (fromline
, mbf
);
868 mbx_delimit_end (FILE *mbf
)
870 return 0 <= putc ('\n', mbf
);
873 #endif /* MAIL_USE_POP */