Allow setting frame pixel sizes from frame parameters (Bug#21415)
[emacs.git] / lib-src / movemail.c
blob84c8ce24286f6255a26a5795e13759c90b3aa72b
1 /* movemail foo bar -- move file foo to file bar,
2 locking file foo the way /bin/mail respects.
4 Copyright (C) 1986, 1992-1994, 1996, 1999, 2001-2015 Free Software
5 Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
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/lockf 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
45 * Modified routines:
46 * main - added code within #ifdef MAIL_USE_POP; added setuid (getuid ())
47 * after POP code.
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 #include <config.h>
59 #include <sys/types.h>
60 #include <sys/stat.h>
61 #include <sys/file.h>
62 #include <stdbool.h>
63 #include <stdio.h>
64 #include <errno.h>
65 #include <time.h>
67 #include <getopt.h>
68 #include <unistd.h>
69 #include <fcntl.h>
70 #include <signal.h>
71 #include <string.h>
72 #include "syswait.h"
73 #ifdef MAIL_USE_POP
74 #include "pop.h"
75 #endif
77 #ifdef MSDOS
78 #undef access
79 #endif /* MSDOS */
81 #ifdef WINDOWSNT
82 #include "ntlib.h"
83 #undef access
84 #undef unlink
85 #define fork() 0
86 #define waitpid(child, var, flags) (*(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 #include <fcntl.h>
99 #endif /* WINDOWSNT */
101 #ifdef WINDOWSNT
102 #include <sys/locking.h>
103 #endif
105 /* If your system uses the `flock' or `lockf' system call for mail locking,
106 define MAIL_USE_SYSTEM_LOCK. If your system type should always define
107 MAIL_USE_LOCKF or MAIL_USE_FLOCK but configure does not do this,
108 please make a bug report. */
110 #ifdef MAIL_USE_LOCKF
111 #define MAIL_USE_SYSTEM_LOCK
112 #endif
114 #ifdef MAIL_USE_FLOCK
115 #define MAIL_USE_SYSTEM_LOCK
116 #endif
118 #if (!defined MAIL_USE_SYSTEM_LOCK \
119 && (defined HAVE_LIBMAIL || defined HAVE_LIBLOCKFILE) \
120 && defined HAVE_MAILLOCK_H)
121 #include <maillock.h>
122 /* We can't use maillock unless we know what directory system mail
123 files appear in. */
124 #ifdef MAILDIR
125 #define MAIL_USE_MAILLOCK
126 static char *mail_spool_name (char *);
127 #endif
128 #endif
130 static _Noreturn void fatal (const char *s1, const char *s2, const char *s3);
131 static void error (const char *s1, const char *s2, const char *s3);
132 static _Noreturn void pfatal_with_name (char *name);
133 static _Noreturn void pfatal_and_delete (char *name);
134 #ifdef MAIL_USE_POP
135 static int popmail (char *, char *, bool, char *, bool);
136 static bool pop_retr (popserver, int, FILE *);
137 static bool mbx_write (char *, int, FILE *);
138 static bool mbx_delimit_begin (FILE *);
139 static bool mbx_delimit_end (FILE *);
140 #endif
142 #if (defined MAIL_USE_MAILLOCK \
143 || (!defined DISABLE_DIRECT_ACCESS && !defined MAIL_USE_SYSTEM_LOCK))
144 /* Like malloc but get fatal error if memory is exhausted. */
146 static void *
147 xmalloc (size_t size)
149 void *result = malloc (size);
150 if (!result)
151 fatal ("virtual memory exhausted", 0, 0);
152 return result;
154 #endif
156 /* Nonzero means this is name of a lock file to delete on fatal error. */
157 static char *delete_lockname;
160 main (int argc, char **argv)
162 char *inname, *outname;
163 int indesc, outdesc;
164 ssize_t nread;
165 int wait_status;
166 int c;
167 bool preserve_mail = false;
169 #ifndef MAIL_USE_SYSTEM_LOCK
170 struct stat st;
171 int tem;
172 char *tempname;
173 size_t inname_len, inname_dirlen;
174 int desc;
175 #endif /* not MAIL_USE_SYSTEM_LOCK */
177 #ifdef MAIL_USE_POP
178 bool pop_reverse_order = false;
179 # define ARGSTR "pr"
180 #else /* ! MAIL_USE_POP */
181 # define ARGSTR "p"
182 #endif /* MAIL_USE_POP */
184 uid_t real_gid = getgid ();
185 uid_t priv_gid = getegid ();
187 delete_lockname = 0;
189 while (0 <= (c = getopt (argc, argv, ARGSTR)))
191 switch (c) {
192 #ifdef MAIL_USE_POP
193 case 'r':
194 pop_reverse_order = true;
195 break;
196 #endif
197 case 'p':
198 preserve_mail = true;
199 break;
200 default:
201 return EXIT_FAILURE;
205 if (
206 #ifdef MAIL_USE_POP
207 (argc - optind < 2) || (argc - optind > 3)
208 #else
209 (argc - optind != 2)
210 #endif
213 #ifdef MAIL_USE_POP
214 fprintf (stderr, "Usage: movemail [-p] [-r] inbox destfile%s\n",
215 " [POP-password]");
216 #else
217 fprintf (stderr, "Usage: movemail [-p] inbox destfile%s\n", "");
218 #endif
219 return EXIT_FAILURE;
222 inname = argv[optind];
223 outname = argv[optind+1];
225 if (*outname == 0)
226 fatal ("Destination file name is empty", 0, 0);
228 #ifdef MAIL_USE_POP
229 if (!strncmp (inname, "po:", 3))
231 int status;
233 status = popmail (inname + 3, outname, preserve_mail,
234 (argc - optind == 3) ? argv[optind+2] : NULL,
235 pop_reverse_order);
236 return status;
239 if (setuid (getuid ()) < 0)
240 fatal ("Failed to drop privileges", 0, 0);
242 #endif /* MAIL_USE_POP */
244 #ifndef DISABLE_DIRECT_ACCESS
246 char *lockname = 0;
247 char *spool_name = 0;
249 #ifdef MAIL_USE_MAILLOCK
250 spool_name = mail_spool_name (inname);
251 #endif
252 if (! spool_name)
254 #ifndef MAIL_USE_SYSTEM_LOCK
255 /* Use a lock file named after our first argument with .lock appended:
256 If it exists, the mail file is locked. */
257 /* Note: this locking mechanism is *required* by the mailer
258 (on systems which use it) to prevent loss of mail.
260 On systems that use a lock file, extracting the mail without locking
261 WILL occasionally cause loss of mail due to timing errors!
263 So, if creation of the lock file fails due to access
264 permission on the mail spool directory, you simply MUST
265 change the permission and/or make movemail a setgid program
266 so it can create lock files properly.
268 You might also wish to verify that your system is one which
269 uses lock files for this purpose. Some systems use other methods. */
271 inname_len = strlen (inname);
272 lockname = xmalloc (inname_len + sizeof ".lock");
273 strcpy (lockname, inname);
274 strcpy (lockname + inname_len, ".lock");
275 for (inname_dirlen = inname_len;
276 inname_dirlen && !IS_DIRECTORY_SEP (inname[inname_dirlen - 1]);
277 inname_dirlen--)
278 continue;
279 tempname = xmalloc (inname_dirlen + sizeof "EXXXXXX");
281 while (true)
283 /* Create the lock file, but not under the lock file name. */
284 /* Give up if cannot do that. */
286 memcpy (tempname, inname, inname_dirlen);
287 strcpy (tempname + inname_dirlen, "EXXXXXX");
288 desc = mkostemp (tempname, O_BINARY);
289 if (desc < 0)
291 int mkostemp_errno = errno;
292 error ("error while creating what would become the lock file",
293 0, 0);
294 errno = mkostemp_errno;
295 pfatal_with_name (tempname);
297 close (desc);
299 tem = link (tempname, lockname);
301 if (tem < 0 && errno != EEXIST)
302 pfatal_with_name (lockname);
304 unlink (tempname);
305 if (tem >= 0)
306 break;
307 sleep (1);
309 /* If lock file is five minutes old, unlock it.
310 Five minutes should be good enough to cope with crashes
311 and wedgitude, and long enough to avoid being fooled
312 by time differences between machines. */
313 if (stat (lockname, &st) >= 0)
315 time_t now = time (0);
316 if (st.st_ctime < now - 300)
318 unlink (lockname);
319 lockname = 0;
324 delete_lockname = lockname;
325 #endif /* not MAIL_USE_SYSTEM_LOCK */
328 #ifdef SIGCHLD
329 signal (SIGCHLD, SIG_DFL);
330 #endif
332 pid_t child = fork ();
333 if (child < 0)
334 fatal ("Error in fork; %s", strerror (errno), 0);
336 if (child == 0)
338 int lockcount = 0;
339 int status = 0;
340 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
341 time_t touched_lock IF_LINT (= 0);
342 #endif
344 if (setuid (getuid ()) < 0 || setregid (-1, real_gid) < 0)
345 fatal ("Failed to drop privileges", 0, 0);
347 #ifdef MAIL_USE_SYSTEM_LOCK
348 indesc = open (inname, O_RDWR | O_BINARY);
349 #else /* if not MAIL_USE_SYSTEM_LOCK */
350 indesc = open (inname, O_RDONLY | O_BINARY);
351 #endif /* not MAIL_USE_SYSTEM_LOCK */
353 if (indesc < 0)
354 pfatal_with_name (inname);
356 /* Make sure the user can read the output file. */
357 umask (umask (0) & 0377);
359 outdesc = open (outname, O_WRONLY | O_BINARY | O_CREAT | O_EXCL, 0666);
360 if (outdesc < 0)
361 pfatal_with_name (outname);
363 if (setregid (-1, priv_gid) < 0)
364 fatal ("Failed to regain privileges", 0, 0);
366 /* This label exists so we can retry locking
367 after a delay, if it got EAGAIN or EBUSY. */
368 retry_lock:
370 /* Try to lock it. */
371 #ifdef MAIL_USE_MAILLOCK
372 if (spool_name)
374 /* The "-" is to make it a negative number if maillock returns
375 non-zero. */
376 status = - maillock (spool_name, 1);
377 #ifdef HAVE_TOUCHLOCK
378 touched_lock = time (0);
379 #endif
380 lockcount = 5;
382 else
383 #endif /* MAIL_USE_MAILLOCK */
385 #ifdef MAIL_USE_SYSTEM_LOCK
386 #ifdef MAIL_USE_LOCKF
387 status = lockf (indesc, F_LOCK, 0);
388 #else /* not MAIL_USE_LOCKF */
389 #ifdef WINDOWSNT
390 status = locking (indesc, LK_RLCK, -1L);
391 #else
392 status = flock (indesc, LOCK_EX);
393 #endif
394 #endif /* not MAIL_USE_LOCKF */
395 #endif /* MAIL_USE_SYSTEM_LOCK */
398 /* If it fails, retry up to 5 times
399 for certain failure codes. */
400 if (status < 0)
402 if (++lockcount <= 5 && (errno == EAGAIN || errno == EBUSY))
404 sleep (1);
405 goto retry_lock;
408 pfatal_with_name (inname);
412 char buf[1024];
414 while (true)
416 nread = read (indesc, buf, sizeof buf);
417 if (nread < 0)
418 pfatal_with_name (inname);
419 if (nread != write (outdesc, buf, nread))
421 int saved_errno = errno;
422 unlink (outname);
423 errno = saved_errno;
424 pfatal_with_name (outname);
426 if (nread < sizeof buf)
427 break;
428 #if defined (MAIL_USE_MAILLOCK) && defined (HAVE_TOUCHLOCK)
429 if (spool_name)
431 time_t now = time (0);
432 if (now - touched_lock > 60)
434 touchlock ();
435 touched_lock = now;
438 #endif /* MAIL_USE_MAILLOCK */
442 if (fsync (outdesc) != 0 && errno != EINVAL)
443 pfatal_and_delete (outname);
445 /* Prevent symlink attacks truncating other users' mailboxes */
446 if (setregid (-1, real_gid) < 0)
447 fatal ("Failed to drop privileges", 0, 0);
449 /* Check to make sure no errors before we zap the inbox. */
450 if (close (outdesc) != 0)
451 pfatal_and_delete (outname);
453 #ifdef MAIL_USE_SYSTEM_LOCK
454 if (! preserve_mail)
456 if (ftruncate (indesc, 0) != 0)
457 pfatal_with_name (inname);
459 #endif /* MAIL_USE_SYSTEM_LOCK */
461 close (indesc);
463 #ifndef MAIL_USE_SYSTEM_LOCK
464 if (! preserve_mail)
466 /* Delete the input file; if we can't, at least get rid of its
467 contents. */
468 #ifdef MAIL_UNLINK_SPOOL
469 /* This is generally bad to do, because it destroys the permissions
470 that were set on the file. Better to just empty the file. */
471 if (unlink (inname) < 0 && errno != ENOENT)
472 #endif /* MAIL_UNLINK_SPOOL */
473 creat (inname, 0600);
475 #endif /* not MAIL_USE_SYSTEM_LOCK */
477 /* End of mailbox truncation */
478 if (setregid (-1, priv_gid) < 0)
479 fatal ("Failed to regain privileges", 0, 0);
481 #ifdef MAIL_USE_MAILLOCK
482 /* This has to occur in the child, i.e., in the process that
483 acquired the lock! */
484 if (spool_name)
485 mailunlock ();
486 #endif
487 return EXIT_SUCCESS;
490 if (waitpid (child, &wait_status, 0) < 0)
491 fatal ("Error in waitpid; %s", strerror (errno), 0);
492 if (!WIFEXITED (wait_status))
493 return EXIT_FAILURE;
494 else if (WEXITSTATUS (wait_status) != 0)
495 return WEXITSTATUS (wait_status);
497 if (lockname)
498 unlink (lockname);
500 #endif /* ! DISABLE_DIRECT_ACCESS */
502 return EXIT_SUCCESS;
505 #ifdef MAIL_USE_MAILLOCK
506 /* This function uses stat to confirm that the mail directory is
507 identical to the directory of the input file, rather than just
508 string-comparing the two paths, because one or both of them might
509 be symbolic links pointing to some other directory. */
510 static char *
511 mail_spool_name (char *inname)
513 struct stat stat1, stat2;
514 char *indir, *fname;
515 int status;
517 if (! (fname = strrchr (inname, '/')))
518 return NULL;
520 fname++;
522 if (stat (MAILDIR, &stat1) < 0)
523 return NULL;
525 indir = xmalloc (fname - inname + 1);
526 memcpy (indir, inname, fname - inname);
527 indir[fname-inname] = '\0';
530 status = stat (indir, &stat2);
532 free (indir);
534 if (status < 0)
535 return NULL;
537 if (stat1.st_dev == stat2.st_dev
538 && stat1.st_ino == stat2.st_ino)
539 return fname;
541 return NULL;
543 #endif /* MAIL_USE_MAILLOCK */
545 /* Print error message and exit. */
547 static void
548 fatal (const char *s1, const char *s2, const char *s3)
550 if (delete_lockname)
551 unlink (delete_lockname);
552 error (s1, s2, s3);
553 exit (EXIT_FAILURE);
556 /* Print error message. `s1' is printf control string, `s2' and `s3'
557 are args for it or null. */
559 static void
560 error (const char *s1, const char *s2, const char *s3)
562 fprintf (stderr, "movemail: ");
563 if (s3)
564 fprintf (stderr, s1, s2, s3);
565 else if (s2)
566 fprintf (stderr, s1, s2);
567 else
568 fprintf (stderr, "%s", s1);
569 fprintf (stderr, "\n");
572 static void
573 pfatal_with_name (char *name)
575 fatal ("%s for %s", strerror (errno), name);
578 static void
579 pfatal_and_delete (char *name)
581 char *s = strerror (errno);
582 unlink (name);
583 fatal ("%s for %s", s, name);
586 /* This is the guts of the interface to the Post Office Protocol. */
588 #ifdef MAIL_USE_POP
590 #ifndef WINDOWSNT
591 #include <sys/socket.h>
592 #include <netinet/in.h>
593 #include <netdb.h>
594 #else
595 #undef _WINSOCKAPI_
596 #include <winsock.h>
597 #endif
598 #include <pwd.h>
599 #include <string.h>
602 * The full valid syntax for a POP mailbox specification for movemail
603 * is "po:username:hostname". The ":hostname" is optional; if it is
604 * omitted, the MAILHOST environment variable will be consulted. Note
605 * that by the time popmail() is called the "po:" has been stripped
606 * off of the front of the mailbox name.
608 * If the mailbox is in the form "po:username:hostname", then it is
609 * modified by this function -- the second colon is replaced by a
610 * null.
612 * Return a value suitable for passing to `exit'.
615 static int
616 popmail (char *mailbox, char *outfile, bool preserve, char *password,
617 bool reverse_order)
619 int nmsgs, nbytes;
620 int i;
621 int mbfi;
622 FILE *mbf;
623 popserver server;
624 int start, end, increment;
625 char *user, *hostname;
627 user = mailbox;
628 if ((hostname = strchr (mailbox, ':')))
629 *hostname++ = '\0';
631 server = pop_open (hostname, user, password, POP_NO_GETPASS);
632 if (! server)
634 error ("Error connecting to POP server: %s", pop_error, 0);
635 return EXIT_FAILURE;
638 if (pop_stat (server, &nmsgs, &nbytes))
640 error ("Error getting message count from POP server: %s", pop_error, 0);
641 return EXIT_FAILURE;
644 if (!nmsgs)
646 pop_close (server);
647 return EXIT_SUCCESS;
650 mbfi = open (outfile, O_WRONLY | O_BINARY | O_CREAT | O_EXCL, 0666);
651 if (mbfi < 0)
653 pop_close (server);
654 error ("Error in open: %s, %s", strerror (errno), outfile);
655 return EXIT_FAILURE;
658 if (fchown (mbfi, getuid (), -1) != 0)
660 int fchown_errno = errno;
661 struct stat st;
662 if (fstat (mbfi, &st) != 0 || st.st_uid != getuid ())
664 pop_close (server);
665 error ("Error in fchown: %s, %s", strerror (fchown_errno), outfile);
666 return EXIT_FAILURE;
670 mbf = fdopen (mbfi, "wb");
671 if (!mbf)
673 pop_close (server);
674 error ("Error in fdopen: %s", strerror (errno), 0);
675 close (mbfi);
676 unlink (outfile);
677 return EXIT_FAILURE;
680 if (reverse_order)
682 start = nmsgs;
683 end = 1;
684 increment = -1;
686 else
688 start = 1;
689 end = nmsgs;
690 increment = 1;
693 for (i = start; i * increment <= end * increment; i += increment)
694 if (! (mbx_delimit_begin (mbf)
695 && pop_retr (server, i, mbf)
696 && mbx_delimit_end (mbf)
697 && fflush (mbf) == 0))
699 if (errno)
700 error ("Error in POP retrieving: %s", strerror (errno), 0);
701 pop_close (server);
702 fclose (mbf);
703 return EXIT_FAILURE;
706 if (fsync (mbfi) != 0 && errno != EINVAL)
708 error ("Error in fsync: %s", strerror (errno), 0);
709 fclose (mbf);
710 return EXIT_FAILURE;
713 if (fclose (mbf) != 0)
715 error ("Error in fclose: %s", strerror (errno), 0);
716 return EXIT_FAILURE;
719 if (! preserve)
720 for (i = 1; i <= nmsgs; i++)
722 if (pop_delete (server, i))
724 error ("Error from POP server: %s", pop_error, 0);
725 pop_close (server);
726 return EXIT_FAILURE;
730 if (pop_quit (server))
732 error ("Error from POP server: %s", pop_error, 0);
733 return EXIT_FAILURE;
736 return EXIT_SUCCESS;
739 static bool
740 pop_retr (popserver server, int msgno, FILE *arg)
742 char *line;
743 int ret;
745 if (pop_retrieve_first (server, msgno, &line))
747 error ("Error from POP server: %s", pop_error, 0);
748 errno = 0;
749 return false;
752 while ((ret = pop_retrieve_next (server, &line)) >= 0)
754 if (! line)
755 break;
757 if (! mbx_write (line, ret, arg))
759 int write_errno = errno;
760 pop_close (server);
761 errno = write_errno;
762 return false;
766 if (ret)
768 error ("Error from POP server: %s", pop_error, 0);
769 errno = 0;
770 return false;
773 return true;
776 static bool
777 mbx_write (char *line, int len, FILE *mbf)
779 #ifdef MOVEMAIL_QUOTE_POP_FROM_LINES
780 /* Do this as a macro instead of using strcmp to save on execution time. */
781 # define IS_FROM_LINE(a) ((a[0] == 'F') \
782 && (a[1] == 'r') \
783 && (a[2] == 'o') \
784 && (a[3] == 'm') \
785 && (a[4] == ' '))
786 if (IS_FROM_LINE (line))
788 if (fputc ('>', mbf) < 0)
789 return false;
791 #endif
792 if (line[0] == '\037')
794 if (fputs ("^_", mbf) < 0)
795 return false;
796 line++;
797 len--;
799 return fwrite (line, 1, len, mbf) == len && 0 <= fputc ('\n', mbf);
802 static bool
803 mbx_delimit_begin (FILE *mbf)
805 time_t now = time (NULL);
806 struct tm *ltime = localtime (&now);
807 if (!ltime)
808 return false;
810 char fromline[100];
811 if (! strftime (fromline, sizeof fromline,
812 "From movemail %a %b %e %T %Y\n", ltime))
814 errno = EOVERFLOW;
815 return false;
817 return 0 <= fputs (fromline, mbf);
820 static bool
821 mbx_delimit_end (FILE *mbf)
823 return 0 <= putc ('\n', mbf);
826 #endif /* MAIL_USE_POP */