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 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>
81 #define DIRECTORY_SEP '/'
83 #ifndef IS_DIRECTORY_SEP
84 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
92 #define wait(var) (*(var) = 0)
93 /* Unfortunately, Samba doesn't seem to properly lock Unix files even
94 though the locking call succeeds (and indeed blocks local access from
95 other NT programs). If you have direct file access using an NFS
96 client or something other than Samba, the locking call might work
97 properly - make sure it does before you enable this!
99 [18-Feb-97 andrewi] I now believe my comment above to be incorrect,
100 since it was based on a misunderstanding of how locking calls are
101 implemented and used on Unix. */
102 //#define DISABLE_DIRECT_ACCESS
105 #endif /* WINDOWSNT */
115 #include <sys/locking.h>
118 #ifdef MAIL_USE_LOCKF
119 #define MAIL_USE_SYSTEM_LOCK
122 #ifdef MAIL_USE_FLOCK
123 #define MAIL_USE_SYSTEM_LOCK
127 extern int lk_open (), lk_close ();
130 #if !defined (MAIL_USE_SYSTEM_LOCK) && !defined (MAIL_USE_MMDF) && \
131 (defined (HAVE_LIBMAIL) || defined (HAVE_LIBLOCKFILE)) && \
132 defined (HAVE_MAILLOCK_H)
133 #include <maillock.h>
134 /* We can't use maillock unless we know what directory system mail
137 #define MAIL_USE_MAILLOCK
138 static char *mail_spool_name ();
147 extern char *index
__P ((const char *, int));
150 extern char *rindex
__P((const char *, int));
155 void pfatal_with_name ();
156 void pfatal_and_delete ();
162 int mbx_delimit_begin ();
163 int mbx_delimit_end ();
165 /* Nonzero means this is name of a lock file to delete on fatal error. */
166 char *delete_lockname
;
173 char *inname
, *outname
;
177 int c
, preserve_mail
= 0;
179 #ifndef MAIL_USE_SYSTEM_LOCK
186 #endif /* not MAIL_USE_SYSTEM_LOCK */
188 #ifdef MAIL_USE_MAILLOCK
193 int pop_reverse_order
= 0;
195 #else /* ! MAIL_USE_POP */
197 #endif /* MAIL_USE_POP */
200 /* Ensure all file i/o is in binary mode. */
206 while ((c
= getopt (argc
, argv
, ARGSTR
)) != EOF
)
211 pop_reverse_order
= 1;
224 (argc
- optind
< 2) || (argc
- optind
> 3)
231 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n",
234 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n", "");
239 inname
= argv
[optind
];
240 outname
= argv
[optind
+1];
247 fatal ("Destination file name is empty", 0, 0);
249 /* Check access to output file. */
250 if (access (outname
, F_OK
) == 0 && access (outname
, W_OK
) != 0)
251 pfatal_with_name (outname
);
253 /* Also check that outname's directory is writable to the real uid. */
255 char *buf
= (char *) xmalloc (strlen (outname
) + 1);
257 strcpy (buf
, outname
);
258 p
= buf
+ strlen (buf
);
259 while (p
> buf
&& !IS_DIRECTORY_SEP (p
[-1]))
263 if (access (buf
, W_OK
) != 0)
264 pfatal_with_name (buf
);
269 if (!strncmp (inname
, "po:", 3))
273 status
= popmail (inname
+ 3, outname
, preserve_mail
,
274 (argc
- optind
== 3) ? argv
[optind
+2] : NULL
,
280 #endif /* MAIL_USE_POP */
282 #ifndef DISABLE_DIRECT_ACCESS
284 /* Check access to input file. */
285 if (access (inname
, R_OK
| W_OK
) != 0)
286 pfatal_with_name (inname
);
288 #ifndef MAIL_USE_MMDF
289 #ifndef MAIL_USE_SYSTEM_LOCK
290 #ifdef MAIL_USE_MAILLOCK
291 spool_name
= mail_spool_name (inname
);
295 /* Use a lock file named after our first argument with .lock appended:
296 If it exists, the mail file is locked. */
297 /* Note: this locking mechanism is *required* by the mailer
298 (on systems which use it) to prevent loss of mail.
300 On systems that use a lock file, extracting the mail without locking
301 WILL occasionally cause loss of mail due to timing errors!
303 So, if creation of the lock file fails
304 due to access permission on the mail spool directory,
305 you simply MUST change the permission
306 and/or make movemail a setgid program
307 so it can create lock files properly.
309 You might also wish to verify that your system is one
310 which uses lock files for this purpose. Some systems use other methods.
312 If your system uses the `flock' system call for mail locking,
313 define MAIL_USE_SYSTEM_LOCK in config.h or the s-*.h file
314 and recompile movemail. If the s- file for your system
315 should define MAIL_USE_SYSTEM_LOCK but does not, send a bug report
316 to bug-gnu-emacs@prep.ai.mit.edu so we can fix it. */
318 lockname
= concat (inname
, ".lock", "");
319 tempname
= (char *) xmalloc (strlen (inname
) + strlen ("EXXXXXX") + 1);
320 strcpy (tempname
, inname
);
321 p
= tempname
+ strlen (tempname
);
322 while (p
!= tempname
&& !IS_DIRECTORY_SEP (p
[-1]))
325 strcpy (p
, "EXXXXXX");
331 /* Create the lock file, but not under the lock file name. */
332 /* Give up if cannot do that. */
333 desc
= open (tempname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
336 char *message
= (char *) xmalloc (strlen (tempname
) + 50);
337 sprintf (message
, "creating %s, which would become the lock file",
339 pfatal_with_name (message
);
343 tem
= link (tempname
, lockname
);
349 /* If lock file is five minutes old, unlock it.
350 Five minutes should be good enough to cope with crashes
351 and wedgitude, and long enough to avoid being fooled
352 by time differences between machines. */
353 if (stat (lockname
, &st
) >= 0)
356 if (st
.st_ctime
< now
- 300)
361 delete_lockname
= lockname
;
363 #endif /* not MAIL_USE_SYSTEM_LOCK */
364 #endif /* not MAIL_USE_MMDF */
370 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
371 long touched_lock
, now
;
376 #ifndef MAIL_USE_MMDF
377 #ifdef MAIL_USE_SYSTEM_LOCK
378 indesc
= open (inname
, O_RDWR
);
379 #else /* if not MAIL_USE_SYSTEM_LOCK */
380 indesc
= open (inname
, O_RDONLY
);
381 #endif /* not MAIL_USE_SYSTEM_LOCK */
382 #else /* MAIL_USE_MMDF */
383 indesc
= lk_open (inname
, O_RDONLY
, 0, 0, 10);
384 #endif /* MAIL_USE_MMDF */
387 pfatal_with_name (inname
);
390 /* In case movemail is setuid to root, make sure the user can
391 read the output file. */
392 /* This is desirable for all systems
393 but I don't want to assume all have the umask system call */
394 umask (umask (0) & 0333);
395 #endif /* BSD_SYSTEM */
396 outdesc
= open (outname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
398 pfatal_with_name (outname
);
400 /* This label exists so we can retry locking
401 after a delay, if it got EAGAIN or EBUSY. */
404 /* Try to lock it. */
405 #ifdef MAIL_USE_MAILLOCK
408 /* The "0 - " is to make it a negative number if maillock returns
410 status
= 0 - maillock (spool_name
, 1);
411 #ifdef HAVE_TOUCHLOCK
412 touched_lock
= time (0);
417 #endif /* MAIL_USE_MAILLOCK */
419 #ifdef MAIL_USE_SYSTEM_LOCK
420 #ifdef MAIL_USE_LOCKF
421 status
= lockf (indesc
, F_LOCK
, 0);
422 #else /* not MAIL_USE_LOCKF */
424 status
= locking (indesc
, LK_RLCK
, -1L);
426 status
= flock (indesc
, LOCK_EX
);
428 #endif /* not MAIL_USE_LOCKF */
429 #endif /* MAIL_USE_SYSTEM_LOCK */
432 /* If it fails, retry up to 5 times
433 for certain failure codes. */
436 if (++lockcount
<= 5)
454 pfatal_with_name (inname
);
462 nread
= read (indesc
, buf
, sizeof buf
);
464 pfatal_with_name (inname
);
465 if (nread
!= write (outdesc
, buf
, nread
))
467 int saved_errno
= errno
;
470 pfatal_with_name (outname
);
472 if (nread
< sizeof buf
)
474 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
478 if (now
- touched_lock
> 60)
484 #endif /* MAIL_USE_MAILLOCK */
489 if (fsync (outdesc
) < 0)
490 pfatal_and_delete (outname
);
493 /* Check to make sure no errors before we zap the inbox. */
494 if (close (outdesc
) != 0)
495 pfatal_and_delete (outname
);
497 #ifdef MAIL_USE_SYSTEM_LOCK
500 ftruncate (indesc
, 0L);
502 #endif /* MAIL_USE_SYSTEM_LOCK */
505 lk_close (indesc
, 0, 0, 0);
510 #ifndef MAIL_USE_SYSTEM_LOCK
513 /* Delete the input file; if we can't, at least get rid of its
515 #ifdef MAIL_UNLINK_SPOOL
516 /* This is generally bad to do, because it destroys the permissions
517 that were set on the file. Better to just empty the file. */
518 if (unlink (inname
) < 0 && errno
!= ENOENT
)
519 #endif /* MAIL_UNLINK_SPOOL */
520 creat (inname
, 0600);
522 #endif /* not MAIL_USE_SYSTEM_LOCK */
524 #ifdef MAIL_USE_MAILLOCK
525 /* This has to occur in the child, i.e., in the process that
526 acquired the lock! */
534 if (!WIFEXITED (status
))
536 else if (WRETCODE (status
) != 0)
537 exit (WRETCODE (status
));
539 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
540 #ifdef MAIL_USE_MAILLOCK
542 #endif /* MAIL_USE_MAILLOCK */
544 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
546 #endif /* ! DISABLE_DIRECT_ACCESS */
551 #ifdef MAIL_USE_MAILLOCK
552 /* This function uses stat to confirm that the mail directory is
553 identical to the directory of the input file, rather than just
554 string-comparing the two paths, because one or both of them might
555 be symbolic links pointing to some other directory. */
557 mail_spool_name (inname
)
560 struct stat stat1
, stat2
;
564 if (! (fname
= rindex (inname
, '/')))
569 if (stat (MAILDIR
, &stat1
) < 0)
572 indir
= (char *) xmalloc (fname
- inname
+ 1);
573 strncpy (indir
, inname
, fname
- inname
);
574 indir
[fname
-inname
] = '\0';
577 status
= stat (indir
, &stat2
);
584 if (stat1
.st_dev
== stat2
.st_dev
585 && stat1
.st_ino
== stat2
.st_ino
)
590 #endif /* MAIL_USE_MAILLOCK */
592 /* Print error message and exit. */
599 unlink (delete_lockname
);
604 /* Print error message. `s1' is printf control string, `s2' and `s3'
605 are args for it or null. */
611 fprintf (stderr
, "movemail: ");
613 fprintf (stderr
, s1
, s2
, s3
);
615 fprintf (stderr
, s1
, s2
);
617 fprintf (stderr
, s1
);
618 fprintf (stderr
, "\n");
622 pfatal_with_name (name
)
625 fatal ("%s for %s", strerror (errno
), name
);
629 pfatal_and_delete (name
)
632 char *s
= strerror (errno
);
634 fatal ("%s for %s", s
, name
);
637 /* Return a newly-allocated string whose contents concatenate those of s1, s2, s3. */
643 int len1
= strlen (s1
), len2
= strlen (s2
), len3
= strlen (s3
);
644 char *result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
647 strcpy (result
+ len1
, s2
);
648 strcpy (result
+ len1
+ len2
, s3
);
649 *(result
+ len1
+ len2
+ len3
) = 0;
654 /* Like malloc but get fatal error if memory is exhausted. */
660 long *result
= (long *) malloc (size
);
662 fatal ("virtual memory exhausted", 0, 0);
666 /* This is the guts of the interface to the Post Office Protocol. */
671 #include <sys/socket.h>
672 #include <netinet/in.h>
687 char ibuffer
[BUFSIZ
];
688 char obuffer
[BUFSIZ
];
689 char Errmsg
[200]; /* POP errors, at least, can exceed
690 the original length of 80. */
693 * The full valid syntax for a POP mailbox specification for movemail
694 * is "po:username:hostname". The ":hostname" is optional; if it is
695 * omitted, the MAILHOST environment variable will be consulted. Note
696 * that by the time popmail() is called the "po:" has been stripped
697 * off of the front of the mailbox name.
699 * If the mailbox is in the form "po:username:hostname", then it is
700 * modified by this function -- the second colon is replaced by a
703 * Return a value suitable for passing to `exit'.
707 popmail (mailbox
, outfile
, preserve
, password
, reverse_order
)
720 int start
, end
, increment
;
721 char *user
, *hostname
;
724 if ((hostname
= index(mailbox
, ':')))
727 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
730 error ("Error connecting to POP server: %s", pop_error
, 0);
734 if (pop_stat (server
, &nmsgs
, &nbytes
))
736 error ("Error getting message count from POP server: %s", pop_error
, 0);
746 mbfi
= open (outfile
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
750 error ("Error in open: %s, %s", strerror (errno
), outfile
);
753 fchown (mbfi
, getuid (), -1);
755 if ((mbf
= fdopen (mbfi
, "wb")) == NULL
)
758 error ("Error in fdopen: %s", strerror (errno
), 0);
777 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
779 mbx_delimit_begin (mbf
);
780 if (pop_retr (server
, i
, mbf
) != OK
)
782 error ("%s", Errmsg
, 0);
786 mbx_delimit_end (mbf
);
790 error ("Error in fflush: %s", strerror (errno
), 0);
797 /* On AFS, a call to write only modifies the file in the local
798 * workstation's AFS cache. The changes are not written to the server
799 * until a call to fsync or close is made. Users with AFS home
800 * directories have lost mail when over quota because these checks were
801 * not made in previous versions of movemail. */
804 if (fsync (mbfi
) < 0)
806 error ("Error in fsync: %s", strerror (errno
), 0);
811 if (close (mbfi
) == -1)
813 error ("Error in close: %s", strerror (errno
), 0);
818 for (i
= 1; i
<= nmsgs
; i
++)
820 if (pop_delete (server
, i
))
822 error ("Error from POP server: %s", pop_error
, 0);
828 if (pop_quit (server
))
830 error ("Error from POP server: %s", pop_error
, 0);
838 pop_retr (server
, msgno
, arg
)
843 extern char *strerror ();
847 if (pop_retrieve_first (server
, msgno
, &line
))
849 char *error
= concat ("Error from POP server: ", pop_error
, "");
850 strncpy (Errmsg
, error
, sizeof (Errmsg
));
851 Errmsg
[sizeof (Errmsg
)-1] = '\0';
856 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
861 if (mbx_write (line
, ret
, arg
) != OK
)
863 strcpy (Errmsg
, strerror (errno
));
871 char *error
= concat ("Error from POP server: ", pop_error
, "");
872 strncpy (Errmsg
, error
, sizeof (Errmsg
));
873 Errmsg
[sizeof (Errmsg
)-1] = '\0';
881 /* Do this as a macro instead of using strcmp to save on execution time. */
882 #define IS_FROM_LINE(a) ((a[0] == 'F') \
889 mbx_write (line
, len
, mbf
)
894 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
895 if (IS_FROM_LINE (line
))
897 if (fputc ('>', mbf
) == EOF
)
901 if (line
[0] == '\037')
903 if (fputs ("^_", mbf
) == EOF
)
908 if (fwrite (line
, 1, len
, mbf
) != len
)
910 if (fputc (0x0a, mbf
) == EOF
)
916 mbx_delimit_begin (mbf
)
919 if (fputs ("\f\n0, unseen,,\n", mbf
) == EOF
)
925 mbx_delimit_end (mbf
)
928 if (putc ('\037', mbf
) == EOF
)
933 #endif /* MAIL_USE_POP */
935 #ifndef HAVE_STRERROR
940 extern char *sys_errlist
[];
943 if (errnum
>= 0 && errnum
< sys_nerr
)
944 return sys_errlist
[errnum
];
945 return (char *) "Unknown error";
948 #endif /* ! HAVE_STRERROR */
950 /* arch-tag: 1c323112-41fe-4fe5-8de9-494de631f73f
951 (do not change this comment) */
953 /* movemail.c ends here */