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