1 /* movemail foo bar -- move file foo to file bar,
2 locking file foo the way /bin/mail respects.
3 Copyright (C) 1986, 1992, 1993, 1994, 1996, 1999, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 /* Important notice: defining MAIL_USE_FLOCK or MAIL_USE_LOCKF *will
23 cause loss of mail* if you do it on a system that does not normally
24 use flock as its way of interlocking access to inbox files. The
25 setting of MAIL_USE_FLOCK and MAIL_USE_LOCKF *must agree* with the
26 system's own conventions. It is not a choice that is up to you.
28 So, if your system uses lock files rather than flock, then the only way
29 you can get proper operation is to enable movemail to write lockfiles there.
30 This means you must either give that directory access modes
31 that permit everyone to write lockfiles in it, or you must make movemail
32 a setuid or setgid program. */
35 * Modified January, 1986 by Michael R. Gretzinger (Project Athena)
37 * Added POP (Post Office Protocol) service. When compiled -DMAIL_USE_POP
38 * movemail will accept input filename arguments of the form
39 * "po:username". This will cause movemail to open a connection to
40 * a pop server running on $MAILHOST (environment variable). Movemail
41 * must be setuid to root in order to work with POP.
43 * New module: popmail.c
45 * main - added code within #ifdef MAIL_USE_POP; added setuid (getuid ())
47 * New routines in movemail.c:
48 * get_errmsg - return pointer to system error message
50 * Modified August, 1993 by Jonathan Kamens (OpenVision Technologies)
52 * Move all of the POP code into a separate file, "pop.c".
53 * Use strerror instead of get_errmsg.
58 #include <sys/types.h>
85 #define DIRECTORY_SEP '/'
87 #ifndef IS_DIRECTORY_SEP
88 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
96 #define wait(var) (*(var) = 0)
97 /* Unfortunately, Samba doesn't seem to properly lock Unix files even
98 though the locking call succeeds (and indeed blocks local access from
99 other NT programs). If you have direct file access using an NFS
100 client or something other than Samba, the locking call might work
101 properly - make sure it does before you enable this!
103 [18-Feb-97 andrewi] I now believe my comment above to be incorrect,
104 since it was based on a misunderstanding of how locking calls are
105 implemented and used on Unix. */
106 //#define DISABLE_DIRECT_ACCESS
109 #endif /* WINDOWSNT */
119 #include <sys/locking.h>
122 #ifdef MAIL_USE_LOCKF
123 #define MAIL_USE_SYSTEM_LOCK
126 #ifdef MAIL_USE_FLOCK
127 #define MAIL_USE_SYSTEM_LOCK
131 extern int lk_open (), lk_close ();
134 #if !defined (MAIL_USE_SYSTEM_LOCK) && !defined (MAIL_USE_MMDF) && \
135 (defined (HAVE_LIBMAIL) || defined (HAVE_LIBLOCKFILE)) && \
136 defined (HAVE_MAILLOCK_H)
137 #include <maillock.h>
138 /* We can't use maillock unless we know what directory system mail
141 #define MAIL_USE_MAILLOCK
142 static char *mail_spool_name ();
146 #ifndef HAVE_STRERROR
147 char *strerror (int);
150 extern char *index (const char *, int);
153 extern char *rindex (const char *, int);
156 static void fatal (char *s1
, char *s2
, char *s3
);
157 static void error (char *s1
, char *s2
, char *s3
);
158 static void pfatal_with_name (char *name
);
159 static void pfatal_and_delete (char *name
);
160 static char *concat (char *s1
, char *s2
, char *s3
);
161 static long *xmalloc (unsigned int size
);
163 static int popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
);
164 static int pop_retr (popserver server
, int msgno
, FILE *arg
);
165 static int mbx_write (char *line
, int len
, FILE *mbf
);
166 static int mbx_delimit_begin (FILE *mbf
);
167 static int mbx_delimit_end (FILE *mbf
);
170 /* Nonzero means this is name of a lock file to delete on fatal error. */
171 char *delete_lockname
;
174 main (int argc
, char **argv
)
176 char *inname
, *outname
;
180 int c
, preserve_mail
= 0;
182 #ifndef MAIL_USE_SYSTEM_LOCK
189 #endif /* not MAIL_USE_SYSTEM_LOCK */
191 #ifdef MAIL_USE_MAILLOCK
196 int pop_reverse_order
= 0;
198 #else /* ! MAIL_USE_POP */
200 #endif /* MAIL_USE_POP */
202 uid_t real_gid
= getgid();
203 uid_t priv_gid
= getegid();
206 /* Ensure all file i/o is in binary mode. */
212 while ((c
= getopt (argc
, argv
, ARGSTR
)) != EOF
)
217 pop_reverse_order
= 1;
230 (argc
- optind
< 2) || (argc
- optind
> 3)
237 fprintf (stderr
, "Usage: movemail [-p] [-r] inbox destfile%s\n",
240 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n", "");
245 inname
= argv
[optind
];
246 outname
= argv
[optind
+1];
253 fatal ("Destination file name is empty", 0, 0);
256 if (!strncmp (inname
, "po:", 3))
260 status
= popmail (inname
+ 3, outname
, preserve_mail
,
261 (argc
- optind
== 3) ? argv
[optind
+2] : NULL
,
266 if (setuid (getuid ()) < 0)
267 fatal ("Failed to drop privileges", 0, 0);
269 #endif /* MAIL_USE_POP */
271 #ifndef DISABLE_DIRECT_ACCESS
272 #ifndef MAIL_USE_MMDF
273 #ifndef MAIL_USE_SYSTEM_LOCK
274 #ifdef MAIL_USE_MAILLOCK
275 spool_name
= mail_spool_name (inname
);
279 /* Use a lock file named after our first argument with .lock appended:
280 If it exists, the mail file is locked. */
281 /* Note: this locking mechanism is *required* by the mailer
282 (on systems which use it) to prevent loss of mail.
284 On systems that use a lock file, extracting the mail without locking
285 WILL occasionally cause loss of mail due to timing errors!
287 So, if creation of the lock file fails
288 due to access permission on the mail spool directory,
289 you simply MUST change the permission
290 and/or make movemail a setgid program
291 so it can create lock files properly.
293 You might also wish to verify that your system is one
294 which uses lock files for this purpose. Some systems use other methods.
296 If your system uses the `flock' system call for mail locking,
297 define MAIL_USE_SYSTEM_LOCK in config.h or the s-*.h file
298 and recompile movemail. If the s- file for your system
299 should define MAIL_USE_SYSTEM_LOCK but does not, send a bug report
300 to bug-gnu-emacs@prep.ai.mit.edu so we can fix it. */
302 lockname
= concat (inname
, ".lock", "");
303 tempname
= (char *) xmalloc (strlen (inname
) + strlen ("EXXXXXX") + 1);
304 strcpy (tempname
, inname
);
305 p
= tempname
+ strlen (tempname
);
306 while (p
!= tempname
&& !IS_DIRECTORY_SEP (p
[-1]))
309 strcpy (p
, "EXXXXXX");
315 /* Create the lock file, but not under the lock file name. */
316 /* Give up if cannot do that. */
317 desc
= open (tempname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
320 char *message
= (char *) xmalloc (strlen (tempname
) + 50);
321 sprintf (message
, "creating %s, which would become the lock file",
323 pfatal_with_name (message
);
327 tem
= link (tempname
, lockname
);
330 if (tem
< 0 && errno
== EPERM
)
331 fatal ("Unable to create hard link between %s and %s",
340 /* If lock file is five minutes old, unlock it.
341 Five minutes should be good enough to cope with crashes
342 and wedgitude, and long enough to avoid being fooled
343 by time differences between machines. */
344 if (stat (lockname
, &st
) >= 0)
347 if (st
.st_ctime
< now
- 300)
352 delete_lockname
= lockname
;
354 #endif /* not MAIL_USE_SYSTEM_LOCK */
355 #endif /* not MAIL_USE_MMDF */
361 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
362 time_t touched_lock
, now
;
365 if (setuid (getuid ()) < 0 || setegid (real_gid
) < 0)
366 fatal ("Failed to drop privileges", 0, 0);
368 #ifndef MAIL_USE_MMDF
369 #ifdef MAIL_USE_SYSTEM_LOCK
370 indesc
= open (inname
, O_RDWR
);
371 #else /* if not MAIL_USE_SYSTEM_LOCK */
372 indesc
= open (inname
, O_RDONLY
);
373 #endif /* not MAIL_USE_SYSTEM_LOCK */
374 #else /* MAIL_USE_MMDF */
375 indesc
= lk_open (inname
, O_RDONLY
, 0, 0, 10);
376 #endif /* MAIL_USE_MMDF */
379 pfatal_with_name (inname
);
382 /* In case movemail is setuid to root, make sure the user can
383 read the output file. */
384 /* This is desirable for all systems
385 but I don't want to assume all have the umask system call */
386 umask (umask (0) & 0333);
387 #endif /* BSD_SYSTEM */
388 outdesc
= open (outname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
390 pfatal_with_name (outname
);
392 if (setegid (priv_gid
) < 0)
393 fatal ("Failed to regain privileges", 0, 0);
395 /* This label exists so we can retry locking
396 after a delay, if it got EAGAIN or EBUSY. */
399 /* Try to lock it. */
400 #ifdef MAIL_USE_MAILLOCK
403 /* The "0 - " is to make it a negative number if maillock returns
405 status
= 0 - maillock (spool_name
, 1);
406 #ifdef HAVE_TOUCHLOCK
407 touched_lock
= time (0);
412 #endif /* MAIL_USE_MAILLOCK */
414 #ifdef MAIL_USE_SYSTEM_LOCK
415 #ifdef MAIL_USE_LOCKF
416 status
= lockf (indesc
, F_LOCK
, 0);
417 #else /* not MAIL_USE_LOCKF */
419 status
= locking (indesc
, LK_RLCK
, -1L);
421 status
= flock (indesc
, LOCK_EX
);
423 #endif /* not MAIL_USE_LOCKF */
424 #endif /* MAIL_USE_SYSTEM_LOCK */
427 /* If it fails, retry up to 5 times
428 for certain failure codes. */
431 if (++lockcount
<= 5)
449 pfatal_with_name (inname
);
457 nread
= read (indesc
, buf
, sizeof buf
);
459 pfatal_with_name (inname
);
460 if (nread
!= write (outdesc
, buf
, nread
))
462 int saved_errno
= errno
;
465 pfatal_with_name (outname
);
467 if (nread
< sizeof buf
)
469 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
473 if (now
- touched_lock
> 60)
479 #endif /* MAIL_USE_MAILLOCK */
484 if (fsync (outdesc
) < 0)
485 pfatal_and_delete (outname
);
488 /* Prevent symlink attacks truncating other users' mailboxes */
489 if (setegid (real_gid
) < 0)
490 fatal ("Failed to drop privileges", 0, 0);
492 /* Check to make sure no errors before we zap the inbox. */
493 if (close (outdesc
) != 0)
494 pfatal_and_delete (outname
);
496 #ifdef MAIL_USE_SYSTEM_LOCK
499 ftruncate (indesc
, 0L);
501 #endif /* MAIL_USE_SYSTEM_LOCK */
504 lk_close (indesc
, 0, 0, 0);
509 #ifndef MAIL_USE_SYSTEM_LOCK
512 /* Delete the input file; if we can't, at least get rid of its
514 #ifdef MAIL_UNLINK_SPOOL
515 /* This is generally bad to do, because it destroys the permissions
516 that were set on the file. Better to just empty the file. */
517 if (unlink (inname
) < 0 && errno
!= ENOENT
)
518 #endif /* MAIL_UNLINK_SPOOL */
519 creat (inname
, 0600);
521 #endif /* not MAIL_USE_SYSTEM_LOCK */
523 /* End of mailbox truncation */
524 if (setegid (priv_gid
) < 0)
525 fatal ("Failed to regain privileges", 0, 0);
527 #ifdef MAIL_USE_MAILLOCK
528 /* This has to occur in the child, i.e., in the process that
529 acquired the lock! */
537 if (!WIFEXITED (status
))
539 else if (WRETCODE (status
) != 0)
540 exit (WRETCODE (status
));
542 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
543 #ifdef MAIL_USE_MAILLOCK
545 #endif /* MAIL_USE_MAILLOCK */
547 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
549 #endif /* ! DISABLE_DIRECT_ACCESS */
554 #ifdef MAIL_USE_MAILLOCK
555 /* This function uses stat to confirm that the mail directory is
556 identical to the directory of the input file, rather than just
557 string-comparing the two paths, because one or both of them might
558 be symbolic links pointing to some other directory. */
560 mail_spool_name (inname
)
563 struct stat stat1
, stat2
;
567 if (! (fname
= rindex (inname
, '/')))
572 if (stat (MAILDIR
, &stat1
) < 0)
575 indir
= (char *) xmalloc (fname
- inname
+ 1);
576 strncpy (indir
, inname
, fname
- inname
);
577 indir
[fname
-inname
] = '\0';
580 status
= stat (indir
, &stat2
);
587 if (stat1
.st_dev
== stat2
.st_dev
588 && stat1
.st_ino
== stat2
.st_ino
)
593 #endif /* MAIL_USE_MAILLOCK */
595 /* Print error message and exit. */
598 fatal (char *s1
, char *s2
, char *s3
)
601 unlink (delete_lockname
);
606 /* Print error message. `s1' is printf control string, `s2' and `s3'
607 are args for it or null. */
610 error (char *s1
, char *s2
, char *s3
)
612 fprintf (stderr
, "movemail: ");
614 fprintf (stderr
, s1
, s2
, s3
);
616 fprintf (stderr
, s1
, s2
);
618 fprintf (stderr
, "%s", s1
);
619 fprintf (stderr
, "\n");
623 pfatal_with_name (char *name
)
625 fatal ("%s for %s", strerror (errno
), name
);
629 pfatal_and_delete (char *name
)
631 char *s
= strerror (errno
);
633 fatal ("%s for %s", s
, name
);
636 /* Return a newly-allocated string whose contents concatenate those of s1, s2, s3. */
639 concat (char *s1
, char *s2
, char *s3
)
641 int len1
= strlen (s1
), len2
= strlen (s2
), len3
= strlen (s3
);
642 char *result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
645 strcpy (result
+ len1
, s2
);
646 strcpy (result
+ len1
+ len2
, s3
);
647 *(result
+ len1
+ len2
+ len3
) = 0;
652 /* Like malloc but get fatal error if memory is exhausted. */
655 xmalloc (unsigned int size
)
657 long *result
= (long *) malloc (size
);
659 fatal ("virtual memory exhausted", 0, 0);
663 /* This is the guts of the interface to the Post Office Protocol. */
668 #include <sys/socket.h>
669 #include <netinet/in.h>
685 char ibuffer
[BUFSIZ
];
686 char obuffer
[BUFSIZ
];
687 char Errmsg
[200]; /* POP errors, at least, can exceed
688 the original length of 80. */
691 * The full valid syntax for a POP mailbox specification for movemail
692 * is "po:username:hostname". The ":hostname" is optional; if it is
693 * omitted, the MAILHOST environment variable will be consulted. Note
694 * that by the time popmail() is called the "po:" has been stripped
695 * off of the front of the mailbox name.
697 * If the mailbox is in the form "po:username:hostname", then it is
698 * modified by this function -- the second colon is replaced by a
701 * Return a value suitable for passing to `exit'.
705 popmail (char *mailbox
, char *outfile
, int preserve
, char *password
, int reverse_order
)
711 char *getenv (const char *);
713 int start
, end
, increment
;
714 char *user
, *hostname
;
717 if ((hostname
= index(mailbox
, ':')))
720 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
723 error ("Error connecting to POP server: %s", pop_error
, 0);
727 if (pop_stat (server
, &nmsgs
, &nbytes
))
729 error ("Error getting message count from POP server: %s", pop_error
, 0);
739 mbfi
= open (outfile
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
743 error ("Error in open: %s, %s", strerror (errno
), outfile
);
746 fchown (mbfi
, getuid (), -1);
748 if ((mbf
= fdopen (mbfi
, "wb")) == NULL
)
751 error ("Error in fdopen: %s", strerror (errno
), 0);
770 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
772 mbx_delimit_begin (mbf
);
773 if (pop_retr (server
, i
, mbf
) != OK
)
775 error ("%s", Errmsg
, 0);
779 mbx_delimit_end (mbf
);
783 error ("Error in fflush: %s", strerror (errno
), 0);
790 /* On AFS, a call to write only modifies the file in the local
791 * workstation's AFS cache. The changes are not written to the server
792 * until a call to fsync or close is made. Users with AFS home
793 * directories have lost mail when over quota because these checks were
794 * not made in previous versions of movemail. */
797 if (fsync (mbfi
) < 0)
799 error ("Error in fsync: %s", strerror (errno
), 0);
804 if (close (mbfi
) == -1)
806 error ("Error in close: %s", strerror (errno
), 0);
811 for (i
= 1; i
<= nmsgs
; i
++)
813 if (pop_delete (server
, i
))
815 error ("Error from POP server: %s", pop_error
, 0);
821 if (pop_quit (server
))
823 error ("Error from POP server: %s", pop_error
, 0);
831 pop_retr (popserver server
, int msgno
, FILE *arg
)
836 if (pop_retrieve_first (server
, msgno
, &line
))
838 char *error
= concat ("Error from POP server: ", pop_error
, "");
839 strncpy (Errmsg
, error
, sizeof (Errmsg
));
840 Errmsg
[sizeof (Errmsg
)-1] = '\0';
845 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
850 if (mbx_write (line
, ret
, arg
) != OK
)
852 strcpy (Errmsg
, strerror (errno
));
860 char *error
= concat ("Error from POP server: ", pop_error
, "");
861 strncpy (Errmsg
, error
, sizeof (Errmsg
));
862 Errmsg
[sizeof (Errmsg
)-1] = '\0';
870 /* Do this as a macro instead of using strcmp to save on execution time. */
871 #define IS_FROM_LINE(a) ((a[0] == 'F') \
878 mbx_write (char *line
, int len
, FILE *mbf
)
880 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
881 if (IS_FROM_LINE (line
))
883 if (fputc ('>', mbf
) == EOF
)
887 if (line
[0] == '\037')
889 if (fputs ("^_", mbf
) == EOF
)
894 if (fwrite (line
, 1, len
, mbf
) != len
)
896 if (fputc (0x0a, mbf
) == EOF
)
902 mbx_delimit_begin (FILE *mbf
)
906 char fromline
[40] = "From movemail ";
909 ltime
= localtime (&now
);
911 strcat (fromline
, asctime (ltime
));
913 if (fputs (fromline
, mbf
) == EOF
)
919 mbx_delimit_end (FILE *mbf
)
921 if (putc ('\n', mbf
) == EOF
)
926 #endif /* MAIL_USE_POP */
928 #ifndef HAVE_STRERROR
933 extern char *sys_errlist
[];
936 if (errnum
>= 0 && errnum
< sys_nerr
)
937 return sys_errlist
[errnum
];
938 return (char *) "Unknown error";
941 #endif /* ! HAVE_STRERROR */
943 /* arch-tag: 1c323112-41fe-4fe5-8de9-494de631f73f
944 (do not change this comment) */
946 /* movemail.c ends here */