1 /* movemail foo bar -- move file foo to file bar,
2 locking file foo the way /bin/mail respects.
3 Copyright (C) 1986, 92, 93, 94, 96, 1999 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
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.
57 #define NO_SHORTNAMES /* Tell config not to load remap.h */
58 #include <../src/config.h>
59 #include <sys/types.h>
64 #include <../src/syswait.h>
75 #define DIRECTORY_SEP '/'
77 #ifndef IS_DIRECTORY_SEP
78 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
86 #define wait(var) (*(var) = 0)
87 /* Unfortunately, Samba doesn't seem to properly lock Unix files even
88 though the locking call succeeds (and indeed blocks local access from
89 other NT programs). If you have direct file access using an NFS
90 client or something other than Samba, the locking call might work
91 properly - make sure it does before you enable this!
93 [18-Feb-97 andrewi] I now believe my comment above to be incorrect,
94 since it was based on a misunderstanding of how locking calls are
95 implemented and used on Unix. */
96 //#define DISABLE_DIRECT_ACCESS
98 /* Ensure all file i/o is in binary mode. */
100 int _fmode
= _O_BINARY
;
101 #endif /* WINDOWSNT */
118 #if defined (XENIX) || defined (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_MAILLOCK_H)
136 #include <maillock.h>
137 /* We can't use maillock unless we know what directory system mail
140 #define MAIL_USE_MAILLOCK
141 static char *mail_spool_name ();
149 extern char *rindex ();
153 void pfatal_with_name ();
154 void pfatal_and_delete ();
160 int mbx_delimit_begin ();
161 int mbx_delimit_end ();
163 /* Nonzero means this is name of a lock file to delete on fatal error. */
164 char *delete_lockname
;
171 char *inname
, *outname
;
175 int c
, preserve_mail
= 0;
177 #ifndef MAIL_USE_SYSTEM_LOCK
184 #endif /* not MAIL_USE_SYSTEM_LOCK */
186 #ifdef MAIL_USE_MAILLOCK
191 int pop_reverse_order
= 0;
193 #else /* ! MAIL_USE_POP */
195 #endif /* MAIL_USE_POP */
199 while ((c
= getopt (argc
, argv
, ARGSTR
)) != EOF
)
204 pop_reverse_order
= 1;
217 (argc
- optind
< 2) || (argc
- optind
> 3)
223 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n",
233 inname
= argv
[optind
];
234 outname
= argv
[optind
+1];
241 fatal ("Destination file name is empty", 0);
243 /* Check access to output file. */
244 if (access (outname
, F_OK
) == 0 && access (outname
, W_OK
) != 0)
245 pfatal_with_name (outname
);
247 /* Also check that outname's directory is writable to the real uid. */
249 char *buf
= (char *) xmalloc (strlen (outname
) + 1);
251 strcpy (buf
, outname
);
252 p
= buf
+ strlen (buf
);
253 while (p
> buf
&& !IS_DIRECTORY_SEP (p
[-1]))
257 if (access (buf
, W_OK
) != 0)
258 pfatal_with_name (buf
);
263 if (!strncmp (inname
, "po:", 3))
267 status
= popmail (inname
+ 3, outname
, preserve_mail
,
268 (argc
- optind
== 3) ? argv
[optind
+2] : NULL
,
274 #endif /* MAIL_USE_POP */
276 #ifndef DISABLE_DIRECT_ACCESS
278 /* Check access to input file. */
279 if (access (inname
, R_OK
| W_OK
) != 0)
280 pfatal_with_name (inname
);
282 #ifndef MAIL_USE_MMDF
283 #ifndef MAIL_USE_SYSTEM_LOCK
284 #ifdef MAIL_USE_MAILLOCK
285 spool_name
= mail_spool_name (inname
);
289 /* Use a lock file named after our first argument with .lock appended:
290 If it exists, the mail file is locked. */
291 /* Note: this locking mechanism is *required* by the mailer
292 (on systems which use it) to prevent loss of mail.
294 On systems that use a lock file, extracting the mail without locking
295 WILL occasionally cause loss of mail due to timing errors!
297 So, if creation of the lock file fails
298 due to access permission on the mail spool directory,
299 you simply MUST change the permission
300 and/or make movemail a setgid program
301 so it can create lock files properly.
303 You might also wish to verify that your system is one
304 which uses lock files for this purpose. Some systems use other methods.
306 If your system uses the `flock' system call for mail locking,
307 define MAIL_USE_SYSTEM_LOCK in config.h or the s-*.h file
308 and recompile movemail. If the s- file for your system
309 should define MAIL_USE_SYSTEM_LOCK but does not, send a bug report
310 to bug-gnu-emacs@prep.ai.mit.edu so we can fix it. */
312 lockname
= concat (inname
, ".lock", "");
313 tempname
= (char *) xmalloc (strlen (inname
) + strlen ("EXXXXXX") + 1);
314 strcpy (tempname
, inname
);
315 p
= tempname
+ strlen (tempname
);
316 while (p
!= tempname
&& !IS_DIRECTORY_SEP (p
[-1]))
319 strcpy (p
, "EXXXXXX");
325 /* Create the lock file, but not under the lock file name. */
326 /* Give up if cannot do that. */
327 desc
= open (tempname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
330 char *message
= (char *) xmalloc (strlen (tempname
) + 50);
331 sprintf (message
, "creating %s, which would become the lock file",
333 pfatal_with_name (message
);
337 tem
= link (tempname
, lockname
);
343 /* If lock file is five minutes old, unlock it.
344 Five minutes should be good enough to cope with crashes
345 and wedgitude, and long enough to avoid being fooled
346 by time differences between machines. */
347 if (stat (lockname
, &st
) >= 0)
350 if (st
.st_ctime
< now
- 300)
355 delete_lockname
= lockname
;
357 #endif /* not MAIL_USE_SYSTEM_LOCK */
358 #endif /* not MAIL_USE_MMDF */
364 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
365 long touched_lock
, now
;
370 #ifndef MAIL_USE_MMDF
371 #ifdef MAIL_USE_SYSTEM_LOCK
372 indesc
= open (inname
, O_RDWR
);
373 #else /* if not MAIL_USE_SYSTEM_LOCK */
374 indesc
= open (inname
, O_RDONLY
);
375 #endif /* not MAIL_USE_SYSTEM_LOCK */
376 #else /* MAIL_USE_MMDF */
377 indesc
= lk_open (inname
, O_RDONLY
, 0, 0, 10);
378 #endif /* MAIL_USE_MMDF */
381 pfatal_with_name (inname
);
383 #if defined (BSD_SYSTEM) || defined (XENIX)
384 /* In case movemail is setuid to root, make sure the user can
385 read the output file. */
386 /* This is desirable for all systems
387 but I don't want to assume all have the umask system call */
388 umask (umask (0) & 0333);
389 #endif /* BSD_SYSTEM || XENIX */
390 outdesc
= open (outname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
392 pfatal_with_name (outname
);
394 /* This label exists so we can retry locking
395 after a delay, if it got EAGAIN or EBUSY. */
398 /* Try to lock it. */
399 #ifdef MAIL_USE_MAILLOCK
402 /* The "0 - " is to make it a negative number if maillock returns
404 status
= 0 - maillock (spool_name
, 1);
405 #ifdef HAVE_TOUCHLOCK
406 touched_lock
= time (0);
411 #endif /* MAIL_USE_MAILLOCK */
413 #ifdef MAIL_USE_SYSTEM_LOCK
414 #ifdef MAIL_USE_LOCKF
415 status
= lockf (indesc
, F_LOCK
, 0);
416 #else /* not MAIL_USE_LOCKF */
418 status
= locking (indesc
, LK_RLCK
, 0L);
421 status
= locking (indesc
, LK_RLCK
, -1L);
423 status
= flock (indesc
, LOCK_EX
);
426 #endif /* not MAIL_USE_LOCKF */
427 #endif /* MAIL_USE_SYSTEM_LOCK */
430 /* If it fails, retry up to 5 times
431 for certain failure codes. */
434 if (++lockcount
<= 5)
452 pfatal_with_name (inname
);
460 nread
= read (indesc
, buf
, sizeof buf
);
461 if (nread
!= write (outdesc
, buf
, nread
))
463 int saved_errno
= errno
;
466 pfatal_with_name (outname
);
468 if (nread
< sizeof buf
)
470 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
474 if (now
- touched_lock
> 60)
480 #endif /* MAIL_USE_MAILLOCK */
485 if (fsync (outdesc
) < 0)
486 pfatal_and_delete (outname
);
489 /* Check to make sure no errors before we zap the inbox. */
490 if (close (outdesc
) != 0)
491 pfatal_and_delete (outname
);
493 #ifdef MAIL_USE_SYSTEM_LOCK
496 #if defined (STRIDE) || defined (XENIX)
497 /* Stride, xenix have file locking, but no ftruncate.
498 This mess will do. */
499 close (open (inname
, O_CREAT
| O_TRUNC
| O_RDWR
, 0666));
501 ftruncate (indesc
, 0L);
502 #endif /* STRIDE or XENIX */
504 #endif /* MAIL_USE_SYSTEM_LOCK */
507 lk_close (indesc
, 0, 0, 0);
512 #ifndef MAIL_USE_SYSTEM_LOCK
515 /* Delete the input file; if we can't, at least get rid of its
517 #ifdef MAIL_UNLINK_SPOOL
518 /* This is generally bad to do, because it destroys the permissions
519 that were set on the file. Better to just empty the file. */
520 if (unlink (inname
) < 0 && errno
!= ENOENT
)
521 #endif /* MAIL_UNLINK_SPOOL */
522 creat (inname
, 0600);
524 #endif /* not MAIL_USE_SYSTEM_LOCK */
526 #ifdef MAIL_USE_MAILLOCK
527 /* This has to occur in the child, i.e., in the process that
528 acquired the lock! */
536 if (!WIFEXITED (status
))
538 else if (WRETCODE (status
) != 0)
539 exit (WRETCODE (status
));
541 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
542 #ifdef MAIL_USE_MAILLOCK
544 #endif /* MAIL_USE_MAILLOCK */
546 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
548 #endif /* ! DISABLE_DIRECT_ACCESS */
553 #ifdef MAIL_USE_MAILLOCK
554 /* This function uses stat to confirm that the mail directory is
555 identical to the directory of the input file, rather than just
556 string-comparing the two paths, because one or both of them might
557 be symbolic links pointing to some other directory. */
559 mail_spool_name (inname
)
562 struct stat stat1
, stat2
;
566 if (! (fname
= rindex (inname
, '/')))
571 if (stat (MAILDIR
, &stat1
) < 0)
574 indir
= (char *) xmalloc (fname
- inname
+ 1);
575 strncpy (indir
, inname
, fname
- inname
);
576 indir
[fname
-inname
] = '\0';
579 status
= stat (indir
, &stat2
);
586 if (stat1
.st_dev
== stat2
.st_dev
587 && stat1
.st_ino
== stat2
.st_ino
)
592 #endif /* MAIL_USE_MAILLOCK */
594 /* Print error message and exit. */
601 unlink (delete_lockname
);
606 /* Print error message. `s1' is printf control string, `s2' is arg for it. */
612 fprintf (stderr
, "movemail: ");
613 fprintf (stderr
, s1
, s2
, s3
);
614 fprintf (stderr
, "\n");
618 pfatal_with_name (name
)
621 char *s
= concat ("", strerror (errno
), " for %s");
626 pfatal_and_delete (name
)
629 char *s
= concat ("", strerror (errno
), " for %s");
634 /* Return a newly-allocated string whose contents concatenate those of s1, s2, s3. */
640 int len1
= strlen (s1
), len2
= strlen (s2
), len3
= strlen (s3
);
641 char *result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
644 strcpy (result
+ len1
, s2
);
645 strcpy (result
+ len1
+ len2
, s3
);
646 *(result
+ len1
+ len2
+ len3
) = 0;
651 /* Like malloc but get fatal error if memory is exhausted. */
657 long *result
= (long *) malloc (size
);
659 fatal ("virtual memory exhausted", 0);
663 /* This is the guts of the interface to the Post Office Protocol. */
668 #include <sys/socket.h>
669 #include <netinet/in.h>
684 char ibuffer
[BUFSIZ
];
685 char obuffer
[BUFSIZ
];
689 * The full legal syntax for a POP mailbox specification for movemail
690 * is "po:username:hostname". The ":hostname" is optional; if it is
691 * omitted, the MAILHOST environment variable will be consulted. Note
692 * that by the time popmail() is called the "po:" has been stripped
693 * off of the front of the mailbox name.
695 * If the mailbox is in the form "po:username:hostname", then it is
696 * modified by this function -- the second colon is replaced by a
700 popmail (mailbox
, outfile
, preserve
, password
, reverse_order
)
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
);
727 if (pop_stat (server
, &nmsgs
, &nbytes
))
729 error ("Error getting message count from POP server: %s", pop_error
);
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
));
770 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
772 mbx_delimit_begin (mbf
);
773 if (pop_retr (server
, i
, mbf
) != OK
)
779 mbx_delimit_end (mbf
);
783 error ("Error in fflush: %s", strerror (errno
));
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
));
804 if (close (mbfi
) == -1)
806 error ("Error in close: %s", strerror (errno
));
811 for (i
= 1; i
<= nmsgs
; i
++)
813 if (pop_delete (server
, i
))
815 error ("Error from POP server: %s", pop_error
);
821 if (pop_quit (server
))
823 error ("Error from POP server: %s", pop_error
);
831 pop_retr (server
, msgno
, arg
)
835 extern char *strerror ();
839 if (pop_retrieve_first (server
, msgno
, &line
))
841 char *error
= concat ("Error from POP server: ", pop_error
, "");
842 strncpy (Errmsg
, error
, sizeof (Errmsg
));
843 Errmsg
[sizeof (Errmsg
)-1] = '\0';
848 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
853 if (mbx_write (line
, ret
, arg
) != OK
)
855 strcpy (Errmsg
, strerror (errno
));
863 char *error
= concat ("Error from POP server: ", pop_error
, "");
864 strncpy (Errmsg
, error
, sizeof (Errmsg
));
865 Errmsg
[sizeof (Errmsg
)-1] = '\0';
873 /* Do this as a macro instead of using strcmp to save on execution time. */
874 #define IS_FROM_LINE(a) ((a[0] == 'F') \
881 mbx_write (line
, len
, mbf
)
886 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
887 if (IS_FROM_LINE (line
))
889 if (fputc ('>', mbf
) == EOF
)
893 if (line
[0] == '\037')
895 if (fputs ("^_", mbf
) == EOF
)
900 if (fwrite (line
, 1, len
, mbf
) != len
)
902 if (fputc (0x0a, mbf
) == EOF
)
908 mbx_delimit_begin (mbf
)
911 if (fputs ("\f\n0, unseen,,\n", mbf
) == EOF
)
916 mbx_delimit_end (mbf
)
919 if (putc ('\037', mbf
) == EOF
)
924 #endif /* MAIL_USE_POP */
926 #ifndef HAVE_STRERROR
931 extern char *sys_errlist
[];
934 if (errnum
>= 0 && errnum
< sys_nerr
)
935 return sys_errlist
[errnum
];
936 return (char *) "Unknown error";
939 #endif /* ! HAVE_STRERROR */