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 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>
82 #define DIRECTORY_SEP '/'
84 #ifndef IS_DIRECTORY_SEP
85 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
93 #define wait(var) (*(var) = 0)
94 /* Unfortunately, Samba doesn't seem to properly lock Unix files even
95 though the locking call succeeds (and indeed blocks local access from
96 other NT programs). If you have direct file access using an NFS
97 client or something other than Samba, the locking call might work
98 properly - make sure it does before you enable this!
100 [18-Feb-97 andrewi] I now believe my comment above to be incorrect,
101 since it was based on a misunderstanding of how locking calls are
102 implemented and used on Unix. */
103 //#define DISABLE_DIRECT_ACCESS
106 #endif /* WINDOWSNT */
116 #include <sys/locking.h>
119 #ifdef MAIL_USE_LOCKF
120 #define MAIL_USE_SYSTEM_LOCK
123 #ifdef MAIL_USE_FLOCK
124 #define MAIL_USE_SYSTEM_LOCK
128 extern int lk_open (), lk_close ();
131 #if !defined (MAIL_USE_SYSTEM_LOCK) && !defined (MAIL_USE_MMDF) && \
132 (defined (HAVE_LIBMAIL) || defined (HAVE_LIBLOCKFILE)) && \
133 defined (HAVE_MAILLOCK_H)
134 #include <maillock.h>
135 /* We can't use maillock unless we know what directory system mail
138 #define MAIL_USE_MAILLOCK
139 static char *mail_spool_name ();
148 extern char *index
__P ((const char *, int));
151 extern char *rindex
__P((const char *, int));
156 void pfatal_with_name ();
157 void pfatal_and_delete ();
163 int mbx_delimit_begin ();
164 int mbx_delimit_end ();
166 /* Nonzero means this is name of a lock file to delete on fatal error. */
167 char *delete_lockname
;
174 char *inname
, *outname
;
178 int c
, preserve_mail
= 0;
180 #ifndef MAIL_USE_SYSTEM_LOCK
187 #endif /* not MAIL_USE_SYSTEM_LOCK */
189 #ifdef MAIL_USE_MAILLOCK
194 int pop_reverse_order
= 0;
196 #else /* ! MAIL_USE_POP */
198 #endif /* MAIL_USE_POP */
201 /* Ensure all file i/o is in binary mode. */
207 while ((c
= getopt (argc
, argv
, ARGSTR
)) != EOF
)
212 pop_reverse_order
= 1;
225 (argc
- optind
< 2) || (argc
- optind
> 3)
232 fprintf (stderr
, "Usage: movemail [-p] [-r] inbox destfile%s\n",
235 fprintf (stderr
, "Usage: movemail [-p] inbox destfile%s\n", "");
240 inname
= argv
[optind
];
241 outname
= argv
[optind
+1];
248 fatal ("Destination file name is empty", 0, 0);
250 /* Check access to output file. */
251 if (access (outname
, F_OK
) == 0 && access (outname
, W_OK
) != 0)
252 pfatal_with_name (outname
);
254 /* Also check that outname's directory is writable to the real uid. */
256 char *buf
= (char *) xmalloc (strlen (outname
) + 1);
258 strcpy (buf
, outname
);
259 p
= buf
+ strlen (buf
);
260 while (p
> buf
&& !IS_DIRECTORY_SEP (p
[-1]))
264 if (access (buf
, W_OK
) != 0)
265 pfatal_with_name (buf
);
270 if (!strncmp (inname
, "po:", 3))
274 status
= popmail (inname
+ 3, outname
, preserve_mail
,
275 (argc
- optind
== 3) ? argv
[optind
+2] : NULL
,
281 #endif /* MAIL_USE_POP */
283 #ifndef DISABLE_DIRECT_ACCESS
285 /* Check access to input file. */
286 if (access (inname
, R_OK
| W_OK
) != 0)
287 pfatal_with_name (inname
);
289 #ifndef MAIL_USE_MMDF
290 #ifndef MAIL_USE_SYSTEM_LOCK
291 #ifdef MAIL_USE_MAILLOCK
292 spool_name
= mail_spool_name (inname
);
296 /* Use a lock file named after our first argument with .lock appended:
297 If it exists, the mail file is locked. */
298 /* Note: this locking mechanism is *required* by the mailer
299 (on systems which use it) to prevent loss of mail.
301 On systems that use a lock file, extracting the mail without locking
302 WILL occasionally cause loss of mail due to timing errors!
304 So, if creation of the lock file fails
305 due to access permission on the mail spool directory,
306 you simply MUST change the permission
307 and/or make movemail a setgid program
308 so it can create lock files properly.
310 You might also wish to verify that your system is one
311 which uses lock files for this purpose. Some systems use other methods.
313 If your system uses the `flock' system call for mail locking,
314 define MAIL_USE_SYSTEM_LOCK in config.h or the s-*.h file
315 and recompile movemail. If the s- file for your system
316 should define MAIL_USE_SYSTEM_LOCK but does not, send a bug report
317 to bug-gnu-emacs@prep.ai.mit.edu so we can fix it. */
319 lockname
= concat (inname
, ".lock", "");
320 tempname
= (char *) xmalloc (strlen (inname
) + strlen ("EXXXXXX") + 1);
321 strcpy (tempname
, inname
);
322 p
= tempname
+ strlen (tempname
);
323 while (p
!= tempname
&& !IS_DIRECTORY_SEP (p
[-1]))
326 strcpy (p
, "EXXXXXX");
332 /* Create the lock file, but not under the lock file name. */
333 /* Give up if cannot do that. */
334 desc
= open (tempname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
337 char *message
= (char *) xmalloc (strlen (tempname
) + 50);
338 sprintf (message
, "creating %s, which would become the lock file",
340 pfatal_with_name (message
);
344 tem
= link (tempname
, lockname
);
347 if (tem
< 0 && errno
== EPERM
)
348 fatal ("Unable to create hard link between %s and %s",
357 /* If lock file is five minutes old, unlock it.
358 Five minutes should be good enough to cope with crashes
359 and wedgitude, and long enough to avoid being fooled
360 by time differences between machines. */
361 if (stat (lockname
, &st
) >= 0)
364 if (st
.st_ctime
< now
- 300)
369 delete_lockname
= lockname
;
371 #endif /* not MAIL_USE_SYSTEM_LOCK */
372 #endif /* not MAIL_USE_MMDF */
378 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
379 time_t touched_lock
, now
;
384 #ifndef MAIL_USE_MMDF
385 #ifdef MAIL_USE_SYSTEM_LOCK
386 indesc
= open (inname
, O_RDWR
);
387 #else /* if not MAIL_USE_SYSTEM_LOCK */
388 indesc
= open (inname
, O_RDONLY
);
389 #endif /* not MAIL_USE_SYSTEM_LOCK */
390 #else /* MAIL_USE_MMDF */
391 indesc
= lk_open (inname
, O_RDONLY
, 0, 0, 10);
392 #endif /* MAIL_USE_MMDF */
395 pfatal_with_name (inname
);
398 /* In case movemail is setuid to root, make sure the user can
399 read the output file. */
400 /* This is desirable for all systems
401 but I don't want to assume all have the umask system call */
402 umask (umask (0) & 0333);
403 #endif /* BSD_SYSTEM */
404 outdesc
= open (outname
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
406 pfatal_with_name (outname
);
408 /* This label exists so we can retry locking
409 after a delay, if it got EAGAIN or EBUSY. */
412 /* Try to lock it. */
413 #ifdef MAIL_USE_MAILLOCK
416 /* The "0 - " is to make it a negative number if maillock returns
418 status
= 0 - maillock (spool_name
, 1);
419 #ifdef HAVE_TOUCHLOCK
420 touched_lock
= time (0);
425 #endif /* MAIL_USE_MAILLOCK */
427 #ifdef MAIL_USE_SYSTEM_LOCK
428 #ifdef MAIL_USE_LOCKF
429 status
= lockf (indesc
, F_LOCK
, 0);
430 #else /* not MAIL_USE_LOCKF */
432 status
= locking (indesc
, LK_RLCK
, -1L);
434 status
= flock (indesc
, LOCK_EX
);
436 #endif /* not MAIL_USE_LOCKF */
437 #endif /* MAIL_USE_SYSTEM_LOCK */
440 /* If it fails, retry up to 5 times
441 for certain failure codes. */
444 if (++lockcount
<= 5)
462 pfatal_with_name (inname
);
470 nread
= read (indesc
, buf
, sizeof buf
);
472 pfatal_with_name (inname
);
473 if (nread
!= write (outdesc
, buf
, nread
))
475 int saved_errno
= errno
;
478 pfatal_with_name (outname
);
480 if (nread
< sizeof buf
)
482 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
486 if (now
- touched_lock
> 60)
492 #endif /* MAIL_USE_MAILLOCK */
497 if (fsync (outdesc
) < 0)
498 pfatal_and_delete (outname
);
501 /* Check to make sure no errors before we zap the inbox. */
502 if (close (outdesc
) != 0)
503 pfatal_and_delete (outname
);
505 #ifdef MAIL_USE_SYSTEM_LOCK
508 ftruncate (indesc
, 0L);
510 #endif /* MAIL_USE_SYSTEM_LOCK */
513 lk_close (indesc
, 0, 0, 0);
518 #ifndef MAIL_USE_SYSTEM_LOCK
521 /* Delete the input file; if we can't, at least get rid of its
523 #ifdef MAIL_UNLINK_SPOOL
524 /* This is generally bad to do, because it destroys the permissions
525 that were set on the file. Better to just empty the file. */
526 if (unlink (inname
) < 0 && errno
!= ENOENT
)
527 #endif /* MAIL_UNLINK_SPOOL */
528 creat (inname
, 0600);
530 #endif /* not MAIL_USE_SYSTEM_LOCK */
532 #ifdef MAIL_USE_MAILLOCK
533 /* This has to occur in the child, i.e., in the process that
534 acquired the lock! */
542 if (!WIFEXITED (status
))
544 else if (WRETCODE (status
) != 0)
545 exit (WRETCODE (status
));
547 #if !defined (MAIL_USE_MMDF) && !defined (MAIL_USE_SYSTEM_LOCK)
548 #ifdef MAIL_USE_MAILLOCK
550 #endif /* MAIL_USE_MAILLOCK */
552 #endif /* not MAIL_USE_MMDF and not MAIL_USE_SYSTEM_LOCK */
554 #endif /* ! DISABLE_DIRECT_ACCESS */
559 #ifdef MAIL_USE_MAILLOCK
560 /* This function uses stat to confirm that the mail directory is
561 identical to the directory of the input file, rather than just
562 string-comparing the two paths, because one or both of them might
563 be symbolic links pointing to some other directory. */
565 mail_spool_name (inname
)
568 struct stat stat1
, stat2
;
572 if (! (fname
= rindex (inname
, '/')))
577 if (stat (MAILDIR
, &stat1
) < 0)
580 indir
= (char *) xmalloc (fname
- inname
+ 1);
581 strncpy (indir
, inname
, fname
- inname
);
582 indir
[fname
-inname
] = '\0';
585 status
= stat (indir
, &stat2
);
592 if (stat1
.st_dev
== stat2
.st_dev
593 && stat1
.st_ino
== stat2
.st_ino
)
598 #endif /* MAIL_USE_MAILLOCK */
600 /* Print error message and exit. */
607 unlink (delete_lockname
);
612 /* Print error message. `s1' is printf control string, `s2' and `s3'
613 are args for it or null. */
619 fprintf (stderr
, "movemail: ");
621 fprintf (stderr
, s1
, s2
, s3
);
623 fprintf (stderr
, s1
, s2
);
625 fprintf (stderr
, s1
);
626 fprintf (stderr
, "\n");
630 pfatal_with_name (name
)
633 fatal ("%s for %s", strerror (errno
), name
);
637 pfatal_and_delete (name
)
640 char *s
= strerror (errno
);
642 fatal ("%s for %s", s
, name
);
645 /* Return a newly-allocated string whose contents concatenate those of s1, s2, s3. */
651 int len1
= strlen (s1
), len2
= strlen (s2
), len3
= strlen (s3
);
652 char *result
= (char *) xmalloc (len1
+ len2
+ len3
+ 1);
655 strcpy (result
+ len1
, s2
);
656 strcpy (result
+ len1
+ len2
, s3
);
657 *(result
+ len1
+ len2
+ len3
) = 0;
662 /* Like malloc but get fatal error if memory is exhausted. */
668 long *result
= (long *) malloc (size
);
670 fatal ("virtual memory exhausted", 0, 0);
674 /* This is the guts of the interface to the Post Office Protocol. */
679 #include <sys/socket.h>
680 #include <netinet/in.h>
696 char ibuffer
[BUFSIZ
];
697 char obuffer
[BUFSIZ
];
698 char Errmsg
[200]; /* POP errors, at least, can exceed
699 the original length of 80. */
702 * The full valid syntax for a POP mailbox specification for movemail
703 * is "po:username:hostname". The ":hostname" is optional; if it is
704 * omitted, the MAILHOST environment variable will be consulted. Note
705 * that by the time popmail() is called the "po:" has been stripped
706 * off of the front of the mailbox name.
708 * If the mailbox is in the form "po:username:hostname", then it is
709 * modified by this function -- the second colon is replaced by a
712 * Return a value suitable for passing to `exit'.
716 popmail (mailbox
, outfile
, preserve
, password
, reverse_order
)
729 int start
, end
, increment
;
730 char *user
, *hostname
;
733 if ((hostname
= index(mailbox
, ':')))
736 server
= pop_open (hostname
, user
, password
, POP_NO_GETPASS
);
739 error ("Error connecting to POP server: %s", pop_error
, 0);
743 if (pop_stat (server
, &nmsgs
, &nbytes
))
745 error ("Error getting message count from POP server: %s", pop_error
, 0);
755 mbfi
= open (outfile
, O_WRONLY
| O_CREAT
| O_EXCL
, 0666);
759 error ("Error in open: %s, %s", strerror (errno
), outfile
);
762 fchown (mbfi
, getuid (), -1);
764 if ((mbf
= fdopen (mbfi
, "wb")) == NULL
)
767 error ("Error in fdopen: %s", strerror (errno
), 0);
786 for (i
= start
; i
* increment
<= end
* increment
; i
+= increment
)
788 mbx_delimit_begin (mbf
);
789 if (pop_retr (server
, i
, mbf
) != OK
)
791 error ("%s", Errmsg
, 0);
795 mbx_delimit_end (mbf
);
799 error ("Error in fflush: %s", strerror (errno
), 0);
806 /* On AFS, a call to write only modifies the file in the local
807 * workstation's AFS cache. The changes are not written to the server
808 * until a call to fsync or close is made. Users with AFS home
809 * directories have lost mail when over quota because these checks were
810 * not made in previous versions of movemail. */
813 if (fsync (mbfi
) < 0)
815 error ("Error in fsync: %s", strerror (errno
), 0);
820 if (close (mbfi
) == -1)
822 error ("Error in close: %s", strerror (errno
), 0);
827 for (i
= 1; i
<= nmsgs
; i
++)
829 if (pop_delete (server
, i
))
831 error ("Error from POP server: %s", pop_error
, 0);
837 if (pop_quit (server
))
839 error ("Error from POP server: %s", pop_error
, 0);
847 pop_retr (server
, msgno
, arg
)
852 extern char *strerror ();
856 if (pop_retrieve_first (server
, msgno
, &line
))
858 char *error
= concat ("Error from POP server: ", pop_error
, "");
859 strncpy (Errmsg
, error
, sizeof (Errmsg
));
860 Errmsg
[sizeof (Errmsg
)-1] = '\0';
865 while ((ret
= pop_retrieve_next (server
, &line
)) >= 0)
870 if (mbx_write (line
, ret
, arg
) != OK
)
872 strcpy (Errmsg
, strerror (errno
));
880 char *error
= concat ("Error from POP server: ", pop_error
, "");
881 strncpy (Errmsg
, error
, sizeof (Errmsg
));
882 Errmsg
[sizeof (Errmsg
)-1] = '\0';
890 /* Do this as a macro instead of using strcmp to save on execution time. */
891 #define IS_FROM_LINE(a) ((a[0] == 'F') \
898 mbx_write (line
, len
, mbf
)
903 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
904 if (IS_FROM_LINE (line
))
906 if (fputc ('>', mbf
) == EOF
)
910 if (line
[0] == '\037')
912 if (fputs ("^_", mbf
) == EOF
)
917 if (fwrite (line
, 1, len
, mbf
) != len
)
919 if (fputc (0x0a, mbf
) == EOF
)
925 mbx_delimit_begin (mbf
)
930 char fromline
[40] = "From movemail ";
933 ltime
= localtime (&now
);
935 strcat (fromline
, asctime (ltime
));
937 if (fputs (fromline
, mbf
) == EOF
)
943 mbx_delimit_end (mbf
)
946 if (putc ('\n', mbf
) == EOF
)
951 #endif /* MAIL_USE_POP */
953 #ifndef HAVE_STRERROR
958 extern char *sys_errlist
[];
961 if (errnum
>= 0 && errnum
< sys_nerr
)
962 return sys_errlist
[errnum
];
963 return (char *) "Unknown error";
966 #endif /* ! HAVE_STRERROR */
968 /* arch-tag: 1c323112-41fe-4fe5-8de9-494de631f73f
969 (do not change this comment) */
971 /* movemail.c ends here */