Reformated comments and long lines
[mmh] / uip / inc.c
1 /*
2 ** inc.c -- incorporate messages from a maildrop into a folder
3 **
4 ** This code is Copyright (c) 2002, by the authors of nmh.  See the
5 ** COPYRIGHT file in the root directory of the nmh distribution for
6 ** complete copyright information.
7 */
8
9 #ifdef MAILGROUP
10 /*
11 ** Revised: Sat Apr 14 17:08:17 PDT 1990 (marvit@hplabs)
12 ** Added hpux hacks to set and reset gid to be "mail" as needed. The reset
13 ** is necessary so inc'ed mail is the group of the inc'er, rather than
14 ** "mail". We setgid to egid only when [un]locking the mail file. This
15 ** is also a major security precaution which will not be explained here.
16 **
17 ** Fri Feb  7 16:04:57 PST 1992  John Romine <bug-mh@ics.uci.edu>
18 **   NB: I'm not 100% sure that this setgid stuff is secure even now.
19 **
20 ** See the *GROUPPRIVS() macros later. I'm reasonably happy with the setgid
21 ** attribute. Running setuid root is probably not a terribly good idea, though.
22 **       -- Peter Maydell <pmaydell@chiark.greenend.org.uk>, 04/1998
23 **
24 ** Peter Maydell's patch slightly modified for nmh 0.28-pre2.
25 ** Ruud de Rooij <ruud@debian.org>  Wed, 22 Jul 1998 13:24:22 +0200
26 */
27 #endif
28
29 #include <h/mh.h>
30 #include <h/utils.h>
31 #include <fcntl.h>
32
33 #include <h/fmt_scan.h>
34 #include <h/scansbr.h>
35 #include <h/signals.h>
36 #include <h/tws.h>
37 #include <h/mts.h>
38 #include <errno.h>
39 #include <signal.h>
40
41 static struct swit switches[] = {
42 #define AUDSW  0
43         { "audit audit-file", 0 },
44 #define NAUDSW  1
45         { "noaudit", 0 },
46 #define CHGSW  2
47         { "changecur", 0 },
48 #define NCHGSW  3
49         { "nochangecur", 0 },
50 #define FILESW  4
51         { "file name", 0 },
52 #define FORMSW  5
53         { "form formatfile", 0 },
54 #define FMTSW  6
55         { "format string", 5 },
56 #define SILSW  7
57         { "silent", 0 },
58 #define NSILSW  8
59         { "nosilent", 0 },
60 #define TRNCSW  9
61         { "truncate", 0 },
62 #define NTRNCSW  10
63         { "notruncate", 0 },
64 #define WIDTHSW  11
65         { "width columns", 0 },
66 #define VERSIONSW  12
67         { "version", 0 },
68 #define HELPSW  13
69         { "help", 0 },
70 };
71
72 /*
73 ** This is an attempt to simplify things by putting all the
74 ** privilege ops into macros.
75 ** *GROUPPRIVS() is related to handling the setgid MAIL property,
76 ** and only applies if MAILGROUP is defined.
77 ** Basically, SAVEGROUPPRIVS() is called right at the top of main()
78 ** to initialise things, and then DROPGROUPPRIVS() and GETGROUPPRIVS()
79 ** do the obvious thing. TRYDROPGROUPPRIVS() has to be safe to call
80 ** before DROPUSERPRIVS() is called [this is needed because setgid()
81 ** sets both effective and real uids if euid is root.]
82 **
83 ** There's probably a better implementation if we're allowed to use
84 ** BSD-style setreuid() rather than using POSIX saved-ids.
85 ** Anyway, if you're euid root it's a bit pointless to drop the group
86 ** permissions...
87 **
88 ** I'm pretty happy that the security is good provided we aren't setuid root.
89 ** The only things we trust with group=mail privilege are lkfopen()
90 ** and lkfclose().
91 */
92
93 /*
94 ** For setting and returning to "mail" gid
95 */
96 #ifdef MAILGROUP
97 static int return_gid;
98 /*
99 ** easy case; we're not setuid root, so can drop group privs immediately.
100 */
101 #define TRYDROPGROUPPRIVS() DROPGROUPPRIVS()
102 #define DROPGROUPPRIVS() setgid(getgid())
103 #define GETGROUPPRIVS() setgid(return_gid)
104 #define SAVEGROUPPRIVS() return_gid = getegid()
105 #else
106 /* define *GROUPPRIVS() as null; this avoids having lots of "#ifdef MAILGROUP"s */
107 #define TRYDROPGROUPPRIVS()
108 #define DROPGROUPPRIVS()
109 #define GETGROUPPRIVS()
110 #define SAVEGROUPPRIVS()
111 #endif /* not MAILGROUP */
112
113 /*
114 ** these variables have to be globals so that done() can correctly clean
115 ** up the lockfile
116 */
117 static int locked = 0;
118 static char *newmail;
119 static FILE *in;
120
121 /*
122 ** prototypes
123 */
124 char *map_name(char *);
125
126 static void inc_done(int) NORETURN;
127
128
129 int
130 main (int argc, char **argv)
131 {
132         int chgflag = 1, trnflag = 1;
133         int noisy = 1, width = 0;
134         int hghnum = 0, msgnum = 0;
135         int incerr = 0;  /*
136                         ** <0 if inc hits an error which means it should
137                         ** not truncate mailspool
138                         */
139         char *cp, *maildir = NULL, *folder = NULL;
140         char *format = NULL, *form = NULL;
141         char *audfile = NULL, *from = NULL;
142         char buf[BUFSIZ], **argp, *nfs, **arguments;
143         struct msgs *mp = NULL;
144         struct stat st, s1;
145         FILE *aud = NULL;
146         char b[MAXPATHLEN + 1];
147         /* copy of mail directory because the static gets overwritten */
148         char *maildir_copy = NULL;
149
150 #ifdef MHE
151         FILE *mhe = NULL;
152 #endif
153
154         done=inc_done;
155
156 /*
157 ** absolutely the first thing we do is save our privileges,
158 ** and drop them if we can.
159 */
160         SAVEGROUPPRIVS();
161         TRYDROPGROUPPRIVS();
162
163 #ifdef LOCALE
164         setlocale(LC_ALL, "");
165 #endif
166         invo_name = r1bindex (argv[0], '/');
167
168         /* read user profile/context */
169         context_read();
170
171         mts_init (invo_name);
172         arguments = getarguments (invo_name, argc, argv, 1);
173         argp = arguments;
174
175         while ((cp = *argp++)) {
176                 if (*cp == '-') {
177                         switch (smatch (++cp, switches)) {
178                         case AMBIGSW:
179                                 ambigsw (cp, switches);
180                                 done (1);
181                         case UNKWNSW:
182                                 adios (NULL, "-%s unknown", cp);
183
184                         case HELPSW:
185                                 snprintf (buf, sizeof(buf), "%s [+folder] [switches]", invo_name);
186                                 print_help (buf, switches, 1);
187                                 done (1);
188                         case VERSIONSW:
189                                 print_version(invo_name);
190                                 done (1);
191
192                         case AUDSW:
193                                 if (!(cp = *argp++) || *cp == '-')
194                                         adios (NULL, "missing argument to %s", argp[-2]);
195                                 audfile = getcpy (m_maildir (cp));
196                                 continue;
197                         case NAUDSW:
198                                 audfile = NULL;
199                                 continue;
200
201                         case CHGSW:
202                                 chgflag++;
203                                 continue;
204                         case NCHGSW:
205                                 chgflag = 0;
206                                 continue;
207
208                         /*
209                         ** The flag `trnflag' has the value:
210                         **
211                         ** 2 if -truncate is given
212                         ** 1 by default (truncating is default)
213                         ** 0 if -notruncate is given
214                         */
215                         case TRNCSW:
216                                 trnflag = 2;
217                                 continue;
218                         case NTRNCSW:
219                                 trnflag = 0;
220                                 continue;
221
222                         case FILESW:
223                                 if (!(cp = *argp++) || *cp == '-')
224                                         adios (NULL, "missing argument to %s", argp[-2]);
225                                 from = path (cp, TFILE);
226
227                                 /*
228                                 ** If the truncate file is in default state,
229                                 ** change to not truncate.
230                                 */
231                                 if (trnflag == 1)
232                                         trnflag = 0;
233                                 continue;
234
235                         case SILSW:
236                                 noisy = 0;
237                                 continue;
238                         case NSILSW:
239                                 noisy++;
240                                 continue;
241
242                         case FORMSW:
243                                 if (!(form = *argp++) || *form == '-')
244                                         adios (NULL, "missing argument to %s", argp[-2]);
245                                 format = NULL;
246                                 continue;
247                         case FMTSW:
248                                 if (!(format = *argp++) || *format == '-')
249                                         adios (NULL, "missing argument to %s", argp[-2]);
250                                 form = NULL;
251                                 continue;
252
253                         case WIDTHSW:
254                                 if (!(cp = *argp++) || *cp == '-')
255                                         adios (NULL, "missing argument to %s", argp[-2]);
256                                 width = atoi (cp);
257                                 continue;
258                         }
259                 }
260                 if (*cp == '+' || *cp == '@') {
261                         if (folder)
262                                 adios (NULL, "only one folder at a time!");
263                         else
264                                 folder = pluspath (cp);
265                 } else {
266                         adios (NULL, "usage: %s [+folder] [switches]", invo_name);
267                 }
268         }
269
270         /*
271         ** NOTE: above this point you should use TRYDROPGROUPPRIVS(),
272         ** not DROPGROUPPRIVS().
273         */
274         /* guarantee dropping group priveleges; we might not have done so earlier */
275         DROPGROUPPRIVS();
276
277         /*
278         ** We will get the mail from a file
279         ** (typically the standard maildrop)
280         */
281         if (from)
282                 newmail = from;
283         else if ((newmail = getenv ("MAILDROP")) && *newmail)
284                 newmail = m_mailpath (newmail);
285         else if ((newmail = context_find ("maildrop")) && *newmail)
286                 newmail = m_mailpath (newmail);
287         else {
288                 newmail = concat (MAILDIR, "/", MAILFIL, NULL);
289         }
290         if (stat (newmail, &s1) == NOTOK || s1.st_size == 0)
291                 adios (NULL, "no mail to incorporate");
292
293         if ((cp = strdup(newmail)) == (char *)0)
294                 adios (NULL, "error allocating memory to copy newmail");
295
296         newmail = cp;
297
298         if (!context_find ("path"))
299                 free (path ("./", TFOLDER));
300         if (!folder)
301                 folder = getfolder (0);
302         maildir = m_maildir (folder);
303
304         if ((maildir_copy = strdup(maildir)) == (char *)0)
305                 adios (maildir, "error allocating memory to copy maildir");
306
307         if (!folder_exists(maildir)) {
308                 /*
309                 ** If the folder doesn't exist, and we're given the -silent
310                 ** flag, just fail.
311                 */
312                 if (noisy)
313                         create_folder(maildir, 0, done);
314                 else
315                         done (1);
316         }
317
318         if (chdir (maildir) == NOTOK)
319                 adios (maildir, "unable to change directory to");
320
321         /* read folder and create message structure */
322         if (!(mp = folder_read (folder)))
323                 adios (NULL, "unable to read folder %s", folder);
324
325         if (access (newmail, W_OK) != NOTOK) {
326                 locked++;
327                 if (trnflag) {
328                         SIGNAL (SIGHUP, SIG_IGN);
329                         SIGNAL (SIGINT, SIG_IGN);
330                         SIGNAL (SIGQUIT, SIG_IGN);
331                         SIGNAL (SIGTERM, SIG_IGN);
332                 }
333
334                 GETGROUPPRIVS();  /* Reset gid to lock mail file */
335                 in = lkfopen (newmail, "r");
336                 DROPGROUPPRIVS();
337                 if (in == NULL)
338                         adios (NULL, "unable to lock and fopen %s", newmail);
339                 fstat (fileno(in), &s1);
340         } else {
341                 trnflag = 0;
342                 if ((in = fopen (newmail, "r")) == NULL)
343                         adios (newmail, "unable to read");
344         }
345
346         /* This shouldn't be necessary but it can't hurt. */
347         DROPGROUPPRIVS();
348
349         if (audfile) {
350                 int i;
351                 if ((i = stat (audfile, &st)) == NOTOK)
352                         advise (NULL, "Creating Receive-Audit: %s", audfile);
353                 if ((aud = fopen (audfile, "a")) == NULL)
354                         adios (audfile, "unable to append to");
355                 else if (i == NOTOK)
356                         chmod (audfile, m_gmprot ());
357
358                 fprintf (aud, from ? "<<inc>> %s  -ms %s\n" : "<<inc>> %s\n",
359                          dtimenow (0), from);
360         }
361
362 #ifdef MHE
363         if (context_find ("mhe")) {
364                 int i;
365                 cp = concat (maildir, "/++", NULL);
366                 i = stat (cp, &st);
367                 if ((mhe = fopen (cp, "a")) == NULL)
368                         admonish (cp, "unable to append to");
369                 else
370                         if (i == NOTOK)
371                                 chmod (cp, m_gmprot ());
372                 free (cp);
373         }
374 #endif /* MHE */
375
376         /* Get new format string */
377         nfs = new_fs (form, format, FORMAT);
378
379         if (noisy) {
380                 printf ("Incorporating new mail into %s...\n\n", folder);
381                 fflush (stdout);
382         }
383
384         /*
385         ** Get the mail from file (usually mail spool)
386         */
387         m_unknown (in);  /* the MAGIC invocation... */
388         hghnum = msgnum = mp->hghmsg;
389         for (;;) {
390                 /*
391                 ** Check if we need to allocate more space for message status.
392                 ** If so, then add space for an additional 100 messages.
393                 */
394                 if (msgnum >= mp->hghoff
395                         && !(mp = folder_realloc (mp, mp->lowoff, mp->hghoff + 100))) {
396                         advise (NULL, "unable to allocate folder storage");
397                         incerr = NOTOK;
398                         break;
399                 }
400
401                 /* create scanline for new message */
402                 switch (incerr = scan (in, msgnum + 1, msgnum + 1, nfs, width,
403                         msgnum == hghnum && chgflag, 1, NULL, 0L, noisy)) {
404                 case SCNFAT:
405                 case SCNEOF:
406                         break;
407
408                 case SCNERR:
409                         if (aud)
410                                 fputs ("inc aborted!\n", aud);
411                         /* doesn't clean up locks! */
412                         advise (NULL, "aborted!");
413                         break;
414
415                 case SCNNUM:
416                         advise (NULL, "BUG in %s, number out of range", invo_name);
417                         break;
418
419                 default:
420                         advise (NULL, "BUG in %s, scan() botch (%d)", invo_name, incerr);
421                         break;
422
423                 case SCNMSG:
424                 case SCNENC:
425                         /*
426                         **  Run the external program hook on the message.
427                         */
428
429                         (void)snprintf(b, sizeof (b), "%s/%d", maildir_copy, msgnum + 1);
430                         (void)ext_hook("add-hook", b, (char *)0);
431
432                         if (aud)
433                                 fputs (scanl, aud);
434 #ifdef MHE
435                         if (mhe)
436                                 fputs (scanl, mhe);
437 #endif /* MHE */
438                         if (noisy)
439                                 fflush (stdout);
440                         msgnum++;
441                         mp->hghmsg++;
442                         mp->nummsg++;
443                         if (mp->lowmsg == 0)
444                                 mp->lowmsg = 1;
445                         clear_msg_flags (mp, msgnum);
446                         set_exists (mp, msgnum);
447                         set_unseen (mp, msgnum);
448                         mp->msgflags |= SEQMOD;
449                         continue;
450                 }
451                 /*
452                 ** If we get here there was some sort of error from scan(),
453                 ** so stop processing anything more from the spool.
454                 */
455                 break;
456         }
457
458         if (incerr < 0) {  /* error */
459                 if (locked) {
460                         GETGROUPPRIVS();  /* Be sure we can unlock mail file */
461                         (void) lkfclose (in, newmail); in = NULL;
462                         DROPGROUPPRIVS();  /*
463                                         ** And then return us to normal
464                                         ** privileges
465                                         */
466                 } else {
467                         fclose (in); in = NULL;
468                 }
469                 adios (NULL, "failed");
470         }
471
472         if (aud)
473                 fclose (aud);
474
475 #ifdef MHE
476         if (mhe)
477                 fclose (mhe);
478 #endif /* MHE */
479
480         if (noisy)
481                 fflush (stdout);
482
483         /*
484         ** truncate file we are incorporating from
485         */
486         if (trnflag) {
487                 if (stat (newmail, &st) != NOTOK && s1.st_mtime != st.st_mtime)
488                         advise (NULL, "new messages have arrived!\007");
489                 else {
490                         int newfd;
491                         if ((newfd = creat (newmail, 0600)) != NOTOK)
492                                 close (newfd);
493                         else
494                                 admonish (newmail, "error zero'ing");
495                         unlink(map_name(newmail));
496                 }
497         } else if (noisy) {
498                 printf ("%s not zero'd\n", newmail);
499         }
500
501         if (msgnum == hghnum) {
502                 admonish (NULL, "no messages incorporated");
503         } else {
504                 context_replace (pfolder, folder);  /* update current folder */
505                 if (chgflag)
506                         mp->curmsg = hghnum + 1;
507                 mp->hghmsg = msgnum;
508                 if (mp->lowmsg == 0)
509                         mp->lowmsg = 1;
510                 if (chgflag)  /* sigh... */
511                         seq_setcur (mp, mp->curmsg);
512         }
513
514         /*
515         ** unlock the mail spool
516         */
517         if (locked) {
518                 GETGROUPPRIVS();  /* Be sure we can unlock mail file */
519                 (void) lkfclose (in, newmail); in = NULL;
520                 DROPGROUPPRIVS();  /* And then return us to normal privileges */
521         } else {
522                 fclose (in); in = NULL;
523         }
524
525         seq_setunseen (mp, 0);  /* set the Unseen-Sequence */
526         seq_save (mp);  /* synchronize sequences   */
527         context_save ();  /* save the context file   */
528         done (0);
529         return 1;
530 }
531
532 static void
533 inc_done (int status)
534 {
535         if (locked) {
536                 GETGROUPPRIVS();
537                 lkfclose(in, newmail);
538                 DROPGROUPPRIVS();
539         }
540         exit (status);
541 }