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-2014 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
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/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>
84 #define wait(var) (*(var) = 0)
85 /* Unfortunately, Samba doesn't seem to properly lock Unix files even
86 though the locking call succeeds (and indeed blocks local access from
87 other NT programs). If you have direct file access using an NFS
88 client or something other than Samba, the locking call might work
89 properly - make sure it does before you enable this!
91 [18-Feb-97 andrewi] I now believe my comment above to be incorrect,
92 since it was based on a misunderstanding of how locking calls are
93 implemented and used on Unix. */
94 //#define DISABLE_DIRECT_ACCESS
97 #endif /* WINDOWSNT */
100 #include <sys/locking.h>
103 /* If your system uses the `flock' or `lockf' system call for mail locking,
104 define MAIL_USE_SYSTEM_LOCK. If your system type should always define
105 MAIL_USE_LOCKF or MAIL_USE_FLOCK but configure does not do this,
106 please make a bug report. */
108 #ifdef MAIL_USE_LOCKF
109 #define MAIL_USE_SYSTEM_LOCK
112 #ifdef MAIL_USE_FLOCK
113 #define MAIL_USE_SYSTEM_LOCK
117 extern int lk_open (), lk_close ();
120 #if !defined (MAIL_USE_SYSTEM_LOCK) && !defined (MAIL_USE_MMDF) && \
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 *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
);
138 static int pop_retr (popserver server
, int msgno
, FILE *arg
);
139 static int mbx_write (char *line
, int len
, FILE *mbf
);
140 static int mbx_delimit_begin (FILE *mbf
);
141 static int mbx_delimit_end (FILE *mbf
);
144 #if (defined MAIL_USE_MAILLOCK \
145 || (!defined DISABLE_DIRECT_ACCESS && !defined MAIL_USE_MMDF \
146 && !defined MAIL_USE_SYSTEM_LOCK))
147 /* Like malloc but get fatal error if memory is exhausted. */
150 xmalloc (size_t size
)
152 void *result
= malloc (size
);
154 fatal ("virtual memory exhausted", 0, 0);
159 /* Nonzero means this is name of a lock file to delete on fatal error. */
160 static char *delete_lockname
;
163 main (int argc
, char **argv
)
165 char *inname
, *outname
;
169 int c
, preserve_mail
= 0;
171 #ifndef MAIL_USE_SYSTEM_LOCK
176 size_t inname_len
, inname_dirlen
;
178 #endif /* not MAIL_USE_SYSTEM_LOCK */
180 #ifdef MAIL_USE_MAILLOCK
185 int pop_reverse_order
= 0;
187 #else /* ! MAIL_USE_POP */
189 #endif /* MAIL_USE_POP */
191 uid_t real_gid
= getgid ();
192 uid_t priv_gid
= getegid ();
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 /* Use a lock file named after our first argument with .lock appended:
270 If it exists, the mail file is locked. */
271 /* Note: this locking mechanism is *required* by the mailer
272 (on systems which use it) to prevent loss of mail.
274 On systems that use a lock file, extracting the mail without locking
275 WILL occasionally cause loss of mail due to timing errors!
277 So, if creation of the lock file fails due to access
278 permission on the mail spool directory, you simply MUST
279 change the permission and/or make movemail a setgid program
280 so it can create lock files properly.
282 You might also wish to verify that your system is one which
283 uses lock files for this purpose. Some systems use other methods. */
285 inname_len
= strlen (inname
);
286 lockname
= xmalloc (inname_len
+ sizeof ".lock");
287 strcpy (lockname
, inname
);
288 strcpy (lockname
+ inname_len
, ".lock");
289 for (inname_dirlen
= inname_len
;
290 inname_dirlen
&& !IS_DIRECTORY_SEP (inname
[inname_dirlen
- 1]);
293 tempname
= xmalloc (inname_dirlen
+ sizeof "EXXXXXX");
297 /* Create the lock file, but not under the lock file name. */
298 /* Give up if cannot do that. */
300 memcpy (tempname
, inname
, inname_dirlen
);
301 strcpy (tempname
+ inname_dirlen
, "EXXXXXX");
302 desc
= mkostemp (tempname
, O_BINARY
);
305 int mkostemp_errno
= errno
;
306 error ("error while creating what would become the lock file",
308 errno
= mkostemp_errno
;
309 pfatal_with_name (tempname
);
313 tem
= link (tempname
, lockname
);
315 if (tem
< 0 && errno
!= EEXIST
)
316 pfatal_with_name (lockname
);
323 /* If lock file is five minutes old, unlock it.
324 Five minutes should be good enough to cope with crashes
325 and wedgitude, and long enough to avoid being fooled
326 by time differences between machines. */
327 if (stat (lockname
, &st
) >= 0)
329 time_t now
= time (0);
330 if (st
.st_ctime
< now
- 300)
335 delete_lockname
= lockname
;
337 #endif /* not MAIL_USE_SYSTEM_LOCK */
338 #endif /* not MAIL_USE_MMDF */
344 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
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
| O_BINARY
);
357 #else /* if not MAIL_USE_SYSTEM_LOCK */
358 indesc
= open (inname
, O_RDONLY
| O_BINARY
);
359 #endif /* not MAIL_USE_SYSTEM_LOCK */
360 #else /* MAIL_USE_MMDF */
361 indesc
= lk_open (inname
, O_RDONLY
| O_BINARY
, 0, 0, 10);
362 #endif /* MAIL_USE_MMDF */
365 pfatal_with_name (inname
);
367 /* Make sure the user can read the output file. */
368 umask (umask (0) & 0377);
370 outdesc
= open (outname
, O_WRONLY
| O_BINARY
| O_CREAT
| O_EXCL
, 0666);
372 pfatal_with_name (outname
);
374 if (setregid (-1, priv_gid
) < 0)
375 fatal ("Failed to regain privileges", 0, 0);
377 /* This label exists so we can retry locking
378 after a delay, if it got EAGAIN or EBUSY. */
381 /* Try to lock it. */
382 #ifdef MAIL_USE_MAILLOCK
385 /* The "0 - " is to make it a negative number if maillock returns
387 status
= 0 - maillock (spool_name
, 1);
388 #ifdef HAVE_TOUCHLOCK
389 touched_lock
= time (0);
394 #endif /* MAIL_USE_MAILLOCK */
396 #ifdef MAIL_USE_SYSTEM_LOCK
397 #ifdef MAIL_USE_LOCKF
398 status
= lockf (indesc
, F_LOCK
, 0);
399 #else /* not MAIL_USE_LOCKF */
401 status
= locking (indesc
, LK_RLCK
, -1L);
403 status
= flock (indesc
, LOCK_EX
);
405 #endif /* not MAIL_USE_LOCKF */
406 #endif /* MAIL_USE_SYSTEM_LOCK */
409 /* If it fails, retry up to 5 times
410 for certain failure codes. */
413 if (++lockcount
<= 5 && (errno
== EAGAIN
|| errno
== EBUSY
))
419 pfatal_with_name (inname
);
427 nread
= read (indesc
, buf
, sizeof buf
);
429 pfatal_with_name (inname
);
430 if (nread
!= write (outdesc
, buf
, nread
))
432 int saved_errno
= errno
;
435 pfatal_with_name (outname
);
437 if (nread
< sizeof buf
)
439 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
442 time_t now
= time (0);
443 if (now
- touched_lock
> 60)
449 #endif /* MAIL_USE_MAILLOCK */
453 if (fsync (outdesc
) != 0 && errno
!= EINVAL
)
454 pfatal_and_delete (outname
);
456 /* Prevent symlink attacks truncating other users' mailboxes */
457 if (setregid (-1, real_gid
) < 0)
458 fatal ("Failed to drop privileges", 0, 0);
460 /* Check to make sure no errors before we zap the inbox. */
461 if (close (outdesc
) != 0)
462 pfatal_and_delete (outname
);
464 #ifdef MAIL_USE_SYSTEM_LOCK
467 if (ftruncate (indesc
, 0L) != 0)
468 pfatal_with_name (inname
);
470 #endif /* MAIL_USE_SYSTEM_LOCK */
473 lk_close (indesc
, 0, 0, 0);
478 #ifndef MAIL_USE_SYSTEM_LOCK
481 /* Delete the input file; if we can't, at least get rid of its
483 #ifdef MAIL_UNLINK_SPOOL
484 /* This is generally bad to do, because it destroys the permissions
485 that were set on the file. Better to just empty the file. */
486 if (unlink (inname
) < 0 && errno
!= ENOENT
)
487 #endif /* MAIL_UNLINK_SPOOL */
488 creat (inname
, 0600);
490 #endif /* not MAIL_USE_SYSTEM_LOCK */
492 /* End of mailbox truncation */
493 if (setregid (-1, priv_gid
) < 0)
494 fatal ("Failed to regain privileges", 0, 0);
496 #ifdef MAIL_USE_MAILLOCK
497 /* This has to occur in the child, i.e., in the process that
498 acquired the lock! */
506 if (!WIFEXITED (wait_status
))
508 else if (WEXITSTATUS (wait_status
) != 0)
509 exit (WEXITSTATUS (wait_status
));
511 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
512 #ifdef MAIL_USE_MAILLOCK
514 #endif /* MAIL_USE_MAILLOCK */
516 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
518 #endif /* ! DISABLE_DIRECT_ACCESS */
523 #ifdef MAIL_USE_MAILLOCK
524 /* This function uses stat to confirm that the mail directory is
525 identical to the directory of the input file, rather than just
526 string-comparing the two paths, because one or both of them might
527 be symbolic links pointing to some other directory. */
529 mail_spool_name (char *inname
)
531 struct stat stat1
, stat2
;
535 if (! (fname
= strrchr (inname
, '/')))
540 if (stat (MAILDIR
, &stat1
) < 0)
543 indir
= xmalloc (fname
- inname
+ 1);
544 memcpy (indir
, inname
, fname
- inname
);
545 indir
[fname
-inname
] = '\0';
548 status
= stat (indir
, &stat2
);
555 if (stat1
.st_dev
== stat2
.st_dev
556 && stat1
.st_ino
== stat2
.st_ino
)
561 #endif /* MAIL_USE_MAILLOCK */
563 /* Print error message and exit. */
566 fatal (const char *s1
, const char *s2
, const char *s3
)
569 unlink (delete_lockname
);
574 /* Print error message. `s1' is printf control string, `s2' and `s3'
575 are args for it or null. */
578 error (const char *s1
, const char *s2
, const char *s3
)
580 fprintf (stderr
, "movemail: ");
582 fprintf (stderr
, s1
, s2
, s3
);
584 fprintf (stderr
, s1
, s2
);
586 fprintf (stderr
, "%s", s1
);
587 fprintf (stderr
, "\n");
591 pfatal_with_name (char *name
)
593 fatal ("%s for %s", strerror (errno
), name
);
597 pfatal_and_delete (char *name
)
599 char *s
= strerror (errno
);
601 fatal ("%s for %s", s
, name
);
604 /* This is the guts of the interface to the Post Office Protocol. */
609 #include <sys/socket.h>
610 #include <netinet/in.h>
622 static char Errmsg
[200]; /* POP errors, at least, can exceed
623 the original length of 80. */
626 * The full valid syntax for a POP mailbox specification for movemail
627 * is "po:username:hostname". The ":hostname" is optional; if it is
628 * omitted, the MAILHOST environment variable will be consulted. Note
629 * that by the time popmail() is called the "po:" has been stripped
630 * off of the front of the mailbox name.
632 * If the mailbox is in the form "po:username:hostname", then it is
633 * modified by this function -- the second colon is replaced by a
636 * Return a value suitable for passing to `exit'.
640 popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
)
647 int start
, end
, increment
;
648 char *user
, *hostname
;
651 if ((hostname
= strchr (mailbox
, ':')))
654 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
657 error ("Error connecting to POP server: %s", pop_error
, 0);
661 if (pop_stat (server
, &nmsgs
, &nbytes
))
663 error ("Error getting message count from POP server: %s", pop_error
, 0);
673 mbfi
= open (outfile
, O_WRONLY
| O_BINARY
| O_CREAT
| O_EXCL
, 0666);
677 error ("Error in open: %s, %s", strerror (errno
), outfile
);
681 if (fchown (mbfi
, getuid (), -1) != 0)
683 int fchown_errno
= errno
;
685 if (fstat (mbfi
, &st
) != 0 || st
.st_uid
!= getuid ())
688 error ("Error in fchown: %s, %s", strerror (fchown_errno
), outfile
);
693 if ((mbf
= fdopen (mbfi
, "wb")) == NULL
)
696 error ("Error in fdopen: %s", strerror (errno
), 0);
715 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
717 if (mbx_delimit_begin (mbf
) != OK
718 || pop_retr (server
, i
, mbf
) != OK
)
720 error ("%s", Errmsg
, 0);
724 mbx_delimit_end (mbf
);
728 error ("Error in fflush: %s", strerror (errno
), 0);
735 if (fsync (mbfi
) != 0 && errno
!= EINVAL
)
737 error ("Error in fsync: %s", strerror (errno
), 0);
742 if (close (mbfi
) != 0)
744 error ("Error in close: %s", strerror (errno
), 0);
749 for (i
= 1; i
<= nmsgs
; i
++)
751 if (pop_delete (server
, i
))
753 error ("Error from POP server: %s", pop_error
, 0);
759 if (pop_quit (server
))
761 error ("Error from POP server: %s", pop_error
, 0);
769 pop_retr (popserver server
, int msgno
, FILE *arg
)
774 if (pop_retrieve_first (server
, msgno
, &line
))
776 snprintf (Errmsg
, sizeof Errmsg
, "Error from POP server: %s", pop_error
);
780 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
785 if (mbx_write (line
, ret
, arg
) != OK
)
787 strcpy (Errmsg
, strerror (errno
));
795 snprintf (Errmsg
, sizeof Errmsg
, "Error from POP server: %s", pop_error
);
803 mbx_write (char *line
, int len
, FILE *mbf
)
805 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
806 /* Do this as a macro instead of using strcmp to save on execution time. */
807 # define IS_FROM_LINE(a) ((a[0] == 'F') \
812 if (IS_FROM_LINE (line
))
814 if (fputc ('>', mbf
) == EOF
)
818 if (line
[0] == '\037')
820 if (fputs ("^_", mbf
) == EOF
)
825 if (fwrite (line
, 1, len
, mbf
) != len
)
827 if (fputc (0x0a, mbf
) == EOF
)
833 mbx_delimit_begin (FILE *mbf
)
835 time_t now
= time (NULL
);
836 struct tm
*ltime
= localtime (&now
);
841 if (! strftime (fromline
, sizeof fromline
,
842 "From movemail %a %b %e %T %Y\n", ltime
))
844 if (fputs (fromline
, mbf
) == EOF
)
850 mbx_delimit_end (FILE *mbf
)
852 if (putc ('\n', mbf
) == EOF
)
857 #endif /* MAIL_USE_POP */