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 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, or (at your option)
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; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
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.
58 #define NO_SHORTNAMES /* Tell config not to load remap.h */
60 #include <sys/types.h>
83 #define DIRECTORY_SEP '/'
85 #ifndef IS_DIRECTORY_SEP
86 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
94 #define wait(var) (*(var) = 0)
95 /* Unfortunately, Samba doesn't seem to properly lock Unix files even
96 though the locking call succeeds (and indeed blocks local access from
97 other NT programs). If you have direct file access using an NFS
98 client or something other than Samba, the locking call might work
99 properly - make sure it does before you enable this!
101 [18-Feb-97 andrewi] I now believe my comment above to be incorrect,
102 since it was based on a misunderstanding of how locking calls are
103 implemented and used on Unix. */
104 //#define DISABLE_DIRECT_ACCESS
107 #endif /* WINDOWSNT */
116 #if defined (XENIX) || defined (WINDOWSNT)
117 #include <sys/locking.h>
120 #ifdef MAIL_USE_LOCKF
121 #define MAIL_USE_SYSTEM_LOCK
124 #ifdef MAIL_USE_FLOCK
125 #define MAIL_USE_SYSTEM_LOCK
129 extern int lk_open (), lk_close ();
132 #if !defined (MAIL_USE_SYSTEM_LOCK) && !defined (MAIL_USE_MMDF) && \
133 (defined (HAVE_LIBMAIL) || defined (HAVE_LIBLOCKFILE)) && \
134 defined (HAVE_MAILLOCK_H)
135 #include <maillock.h>
136 /* We can't use maillock unless we know what directory system mail
139 #define MAIL_USE_MAILLOCK
140 static char *mail_spool_name ();
149 extern char *index
__P ((const char *, int));
152 extern char *rindex
__P((const char *, int));
157 void pfatal_with_name ();
158 void pfatal_and_delete ();
164 int mbx_delimit_begin ();
165 int mbx_delimit_end ();
167 /* Nonzero means this is name of a lock file to delete on fatal error. */
168 char *delete_lockname
;
175 char *inname
, *outname
;
179 int c
, preserve_mail
= 0;
181 #ifndef MAIL_USE_SYSTEM_LOCK
188 #endif /* not MAIL_USE_SYSTEM_LOCK */
190 #ifdef MAIL_USE_MAILLOCK
195 int pop_reverse_order
= 0;
197 #else /* ! MAIL_USE_POP */
199 #endif /* MAIL_USE_POP */
202 /* Ensure all file i/o is in binary mode. */
208 while ((c
= getopt (argc
, argv
, ARGSTR
)) != EOF
)
213 pop_reverse_order
= 1;
226 (argc
- optind
< 2) || (argc
- optind
> 3)
233 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n",
236 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n", "");
241 inname
= argv
[optind
];
242 outname
= argv
[optind
+1];
249 fatal ("Destination file name is empty", 0, 0);
251 /* Check access to output file. */
252 if (access (outname
, F_OK
) == 0 && access (outname
, W_OK
) != 0)
253 pfatal_with_name (outname
);
255 /* Also check that outname's directory is writable to the real uid. */
257 char *buf
= (char *) xmalloc (strlen (outname
) + 1);
259 strcpy (buf
, outname
);
260 p
= buf
+ strlen (buf
);
261 while (p
> buf
&& !IS_DIRECTORY_SEP (p
[-1]))
265 if (access (buf
, W_OK
) != 0)
266 pfatal_with_name (buf
);
271 if (!strncmp (inname
, "po:", 3))
275 status
= popmail (inname
+ 3, outname
, preserve_mail
,
276 (argc
- optind
== 3) ? argv
[optind
+2] : NULL
,
282 #endif /* MAIL_USE_POP */
284 #ifndef DISABLE_DIRECT_ACCESS
286 /* Check access to input file. */
287 if (access (inname
, R_OK
| W_OK
) != 0)
288 pfatal_with_name (inname
);
290 #ifndef MAIL_USE_MMDF
291 #ifndef MAIL_USE_SYSTEM_LOCK
292 #ifdef MAIL_USE_MAILLOCK
293 spool_name
= mail_spool_name (inname
);
297 /* Use a lock file named after our first argument with .lock appended:
298 If it exists, the mail file is locked. */
299 /* Note: this locking mechanism is *required* by the mailer
300 (on systems which use it) to prevent loss of mail.
302 On systems that use a lock file, extracting the mail without locking
303 WILL occasionally cause loss of mail due to timing errors!
305 So, if creation of the lock file fails
306 due to access permission on the mail spool directory,
307 you simply MUST change the permission
308 and/or make movemail a setgid program
309 so it can create lock files properly.
311 You might also wish to verify that your system is one
312 which uses lock files for this purpose. Some systems use other methods.
314 If your system uses the `flock' system call for mail locking,
315 define MAIL_USE_SYSTEM_LOCK in config.h or the s-*.h file
316 and recompile movemail. If the s- file for your system
317 should define MAIL_USE_SYSTEM_LOCK but does not, send a bug report
318 to bug-gnu-emacs@prep.ai.mit.edu so we can fix it. */
320 lockname
= concat (inname
, ".lock", "");
321 tempname
= (char *) xmalloc (strlen (inname
) + strlen ("EXXXXXX") + 1);
322 strcpy (tempname
, inname
);
323 p
= tempname
+ strlen (tempname
);
324 while (p
!= tempname
&& !IS_DIRECTORY_SEP (p
[-1]))
327 strcpy (p
, "EXXXXXX");
333 /* Create the lock file, but not under the lock file name. */
334 /* Give up if cannot do that. */
335 desc
= open (tempname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
338 char *message
= (char *) xmalloc (strlen (tempname
) + 50);
339 sprintf (message
, "creating %s, which would become the lock file",
341 pfatal_with_name (message
);
345 tem
= link (tempname
, lockname
);
351 /* If lock file is five minutes old, unlock it.
352 Five minutes should be good enough to cope with crashes
353 and wedgitude, and long enough to avoid being fooled
354 by time differences between machines. */
355 if (stat (lockname
, &st
) >= 0)
358 if (st
.st_ctime
< now
- 300)
363 delete_lockname
= lockname
;
365 #endif /* not MAIL_USE_SYSTEM_LOCK */
366 #endif /* not MAIL_USE_MMDF */
372 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
373 long touched_lock
, now
;
378 #ifndef MAIL_USE_MMDF
379 #ifdef MAIL_USE_SYSTEM_LOCK
380 indesc
= open (inname
, O_RDWR
);
381 #else /* if not MAIL_USE_SYSTEM_LOCK */
382 indesc
= open (inname
, O_RDONLY
);
383 #endif /* not MAIL_USE_SYSTEM_LOCK */
384 #else /* MAIL_USE_MMDF */
385 indesc
= lk_open (inname
, O_RDONLY
, 0, 0, 10);
386 #endif /* MAIL_USE_MMDF */
389 pfatal_with_name (inname
);
391 #if defined (BSD_SYSTEM) || defined (XENIX)
392 /* In case movemail is setuid to root, make sure the user can
393 read the output file. */
394 /* This is desirable for all systems
395 but I don't want to assume all have the umask system call */
396 umask (umask (0) & 0333);
397 #endif /* BSD_SYSTEM || XENIX */
398 outdesc
= open (outname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
400 pfatal_with_name (outname
);
402 /* This label exists so we can retry locking
403 after a delay, if it got EAGAIN or EBUSY. */
406 /* Try to lock it. */
407 #ifdef MAIL_USE_MAILLOCK
410 /* The "0 - " is to make it a negative number if maillock returns
412 status
= 0 - maillock (spool_name
, 1);
413 #ifdef HAVE_TOUCHLOCK
414 touched_lock
= time (0);
419 #endif /* MAIL_USE_MAILLOCK */
421 #ifdef MAIL_USE_SYSTEM_LOCK
422 #ifdef MAIL_USE_LOCKF
423 status
= lockf (indesc
, F_LOCK
, 0);
424 #else /* not MAIL_USE_LOCKF */
426 status
= locking (indesc
, LK_RLCK
, 0L);
429 status
= locking (indesc
, LK_RLCK
, -1L);
431 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)
484 if (now
- touched_lock
> 60)
490 #endif /* MAIL_USE_MAILLOCK */
495 if (fsync (outdesc
) < 0)
496 pfatal_and_delete (outname
);
499 /* Check to make sure no errors before we zap the inbox. */
500 if (close (outdesc
) != 0)
501 pfatal_and_delete (outname
);
503 #ifdef MAIL_USE_SYSTEM_LOCK
506 ftruncate (indesc
, 0L);
508 #endif /* MAIL_USE_SYSTEM_LOCK */
511 lk_close (indesc
, 0, 0, 0);
516 #ifndef MAIL_USE_SYSTEM_LOCK
519 /* Delete the input file; if we can't, at least get rid of its
521 #ifdef MAIL_UNLINK_SPOOL
522 /* This is generally bad to do, because it destroys the permissions
523 that were set on the file. Better to just empty the file. */
524 if (unlink (inname
) < 0 && errno
!= ENOENT
)
525 #endif /* MAIL_UNLINK_SPOOL */
526 creat (inname
, 0600);
528 #endif /* not MAIL_USE_SYSTEM_LOCK */
530 #ifdef MAIL_USE_MAILLOCK
531 /* This has to occur in the child, i.e., in the process that
532 acquired the lock! */
540 if (!WIFEXITED (status
))
542 else if (WRETCODE (status
) != 0)
543 exit (WRETCODE (status
));
545 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
546 #ifdef MAIL_USE_MAILLOCK
548 #endif /* MAIL_USE_MAILLOCK */
550 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
552 #endif /* ! DISABLE_DIRECT_ACCESS */
557 #ifdef MAIL_USE_MAILLOCK
558 /* This function uses stat to confirm that the mail directory is
559 identical to the directory of the input file, rather than just
560 string-comparing the two paths, because one or both of them might
561 be symbolic links pointing to some other directory. */
563 mail_spool_name (inname
)
566 struct stat stat1
, stat2
;
570 if (! (fname
= rindex (inname
, '/')))
575 if (stat (MAILDIR
, &stat1
) < 0)
578 indir
= (char *) xmalloc (fname
- inname
+ 1);
579 strncpy (indir
, inname
, fname
- inname
);
580 indir
[fname
-inname
] = '\0';
583 status
= stat (indir
, &stat2
);
590 if (stat1
.st_dev
== stat2
.st_dev
591 && stat1
.st_ino
== stat2
.st_ino
)
596 #endif /* MAIL_USE_MAILLOCK */
598 /* Print error message and exit. */
605 unlink (delete_lockname
);
610 /* Print error message. `s1' is printf control string, `s2' and `s3'
611 are args for it or null. */
617 fprintf (stderr
, "movemail: ");
619 fprintf (stderr
, s1
, s2
, s3
);
621 fprintf (stderr
, s1
, s2
);
623 fprintf (stderr
, s1
);
624 fprintf (stderr
, "\n");
628 pfatal_with_name (name
)
631 fatal ("%s for %s", strerror (errno
), name
);
635 pfatal_and_delete (name
)
638 char *s
= strerror (errno
);
640 fatal ("%s for %s", s
, name
);
643 /* Return a newly-allocated string whose contents concatenate those of s1, s2, s3. */
649 int len1
= strlen (s1
), len2
= strlen (s2
), len3
= strlen (s3
);
650 char *result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
653 strcpy (result
+ len1
, s2
);
654 strcpy (result
+ len1
+ len2
, s3
);
655 *(result
+ len1
+ len2
+ len3
) = 0;
660 /* Like malloc but get fatal error if memory is exhausted. */
666 long *result
= (long *) malloc (size
);
668 fatal ("virtual memory exhausted", 0, 0);
672 /* This is the guts of the interface to the Post Office Protocol. */
677 #include <sys/socket.h>
678 #include <netinet/in.h>
693 char ibuffer
[BUFSIZ
];
694 char obuffer
[BUFSIZ
];
695 char Errmsg
[200]; /* POP errors, at least, can exceed
696 the original length of 80. */
699 * The full legal syntax for a POP mailbox specification for movemail
700 * is "po:username:hostname". The ":hostname" is optional; if it is
701 * omitted, the MAILHOST environment variable will be consulted. Note
702 * that by the time popmail() is called the "po:" has been stripped
703 * off of the front of the mailbox name.
705 * If the mailbox is in the form "po:username:hostname", then it is
706 * modified by this function -- the second colon is replaced by a
709 * Return a value suitable for passing to `exit'.
713 popmail (mailbox
, outfile
, preserve
, password
, reverse_order
)
726 int start
, end
, increment
;
727 char *user
, *hostname
;
730 if ((hostname
= index(mailbox
, ':')))
733 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
736 error ("Error connecting to POP server: %s", pop_error
, 0);
740 if (pop_stat (server
, &nmsgs
, &nbytes
))
742 error ("Error getting message count from POP server: %s", pop_error
, 0);
752 mbfi
= open (outfile
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
756 error ("Error in open: %s, %s", strerror (errno
), outfile
);
759 fchown (mbfi
, getuid (), -1);
761 if ((mbf
= fdopen (mbfi
, "wb")) == NULL
)
764 error ("Error in fdopen: %s", strerror (errno
), 0);
783 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
785 mbx_delimit_begin (mbf
);
786 if (pop_retr (server
, i
, mbf
) != OK
)
788 error ("%s", Errmsg
, 0);
792 mbx_delimit_end (mbf
);
796 error ("Error in fflush: %s", strerror (errno
), 0);
803 /* On AFS, a call to write only modifies the file in the local
804 * workstation's AFS cache. The changes are not written to the server
805 * until a call to fsync or close is made. Users with AFS home
806 * directories have lost mail when over quota because these checks were
807 * not made in previous versions of movemail. */
810 if (fsync (mbfi
) < 0)
812 error ("Error in fsync: %s", strerror (errno
), 0);
817 if (close (mbfi
) == -1)
819 error ("Error in close: %s", strerror (errno
), 0);
824 for (i
= 1; i
<= nmsgs
; i
++)
826 if (pop_delete (server
, i
))
828 error ("Error from POP server: %s", pop_error
, 0);
834 if (pop_quit (server
))
836 error ("Error from POP server: %s", pop_error
, 0);
844 pop_retr (server
, msgno
, arg
)
849 extern char *strerror ();
853 if (pop_retrieve_first (server
, msgno
, &line
))
855 char *error
= concat ("Error from POP server: ", pop_error
, "");
856 strncpy (Errmsg
, error
, sizeof (Errmsg
));
857 Errmsg
[sizeof (Errmsg
)-1] = '\0';
862 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
867 if (mbx_write (line
, ret
, arg
) != OK
)
869 strcpy (Errmsg
, strerror (errno
));
877 char *error
= concat ("Error from POP server: ", pop_error
, "");
878 strncpy (Errmsg
, error
, sizeof (Errmsg
));
879 Errmsg
[sizeof (Errmsg
)-1] = '\0';
887 /* Do this as a macro instead of using strcmp to save on execution time. */
888 #define IS_FROM_LINE(a) ((a[0] == 'F') \
895 mbx_write (line
, len
, mbf
)
900 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
901 if (IS_FROM_LINE (line
))
903 if (fputc ('>', mbf
) == EOF
)
907 if (line
[0] == '\037')
909 if (fputs ("^_", mbf
) == EOF
)
914 if (fwrite (line
, 1, len
, mbf
) != len
)
916 if (fputc (0x0a, mbf
) == EOF
)
922 mbx_delimit_begin (mbf
)
925 if (fputs ("\f\n0, unseen,,\n", mbf
) == EOF
)
931 mbx_delimit_end (mbf
)
934 if (putc ('\037', mbf
) == EOF
)
939 #endif /* MAIL_USE_POP */
941 #ifndef HAVE_STRERROR
946 extern char *sys_errlist
[];
949 if (errnum
>= 0 && errnum
< sys_nerr
)
950 return sys_errlist
[errnum
];
951 return (char *) "Unknown error";
954 #endif /* ! HAVE_STRERROR */
956 /* arch-tag: 1c323112-41fe-4fe5-8de9-494de631f73f
957 (do not change this comment) */
959 /* movemail.c ends here */