Removed the space between function names and the opening parenthesis.
[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",
225                                                         argp[-2]);
226                                 from = path(cp, TFILE);
227
228                                 /*
229                                 ** If the truncate file is in default state,
230                                 ** change to not truncate.
231                                 */
232                                 if (trnflag == 1)
233                                         trnflag = 0;
234                                 continue;
235
236                         case SILSW:
237                                 noisy = 0;
238                                 continue;
239                         case NSILSW:
240                                 noisy++;
241                                 continue;
242
243                         case FORMSW:
244                                 if (!(form = *argp++) || *form == '-')
245                                         adios(NULL, "missing argument to %s",
246                                                         argp[-2]);
247                                 format = NULL;
248                                 continue;
249                         case FMTSW:
250                                 if (!(format = *argp++) || *format == '-')
251                                         adios(NULL, "missing argument to %s",
252                                                         argp[-2]);
253                                 form = NULL;
254                                 continue;
255
256                         case WIDTHSW:
257                                 if (!(cp = *argp++) || *cp == '-')
258                                         adios(NULL, "missing argument to %s",
259                                                         argp[-2]);
260                                 width = atoi(cp);
261                                 continue;
262                         }
263                 }
264                 if (*cp == '+' || *cp == '@') {
265                         if (folder)
266                                 adios(NULL, "only one folder at a time!");
267                         else
268                                 folder = pluspath(cp);
269                 } else {
270                         adios(NULL, "usage: %s [+folder] [switches]",
271                                         invo_name);
272                 }
273         }
274
275         /*
276         ** NOTE: above this point you should use TRYDROPGROUPPRIVS(),
277         ** not DROPGROUPPRIVS().
278         */
279         /* guarantee dropping group priveleges; we might not have done so earlier */
280         DROPGROUPPRIVS();
281
282         /*
283         ** We will get the mail from a file
284         ** (typically the standard maildrop)
285         */
286         if (from)
287                 newmail = from;
288         else if ((newmail = getenv("MAILDROP")) && *newmail)
289                 newmail = m_mailpath(newmail);
290         else if ((newmail = context_find("maildrop")) && *newmail)
291                 newmail = m_mailpath(newmail);
292         else {
293                 newmail = concat(MAILDIR, "/", MAILFIL, NULL);
294         }
295         if (stat(newmail, &s1) == NOTOK || s1.st_size == 0)
296                 adios(NULL, "no mail to incorporate");
297
298         if ((cp = strdup(newmail)) == (char *)0)
299                 adios(NULL, "error allocating memory to copy newmail");
300
301         newmail = cp;
302
303         if (!context_find("path"))
304                 free(path("./", TFOLDER));
305         if (!folder)
306                 folder = getfolder(0);
307         maildir = m_maildir(folder);
308
309         if ((maildir_copy = strdup(maildir)) == (char *)0)
310                 adios(maildir, "error allocating memory to copy maildir");
311
312         if (!folder_exists(maildir)) {
313                 /*
314                 ** If the folder doesn't exist, and we're given the -silent
315                 ** flag, just fail.
316                 */
317                 if (noisy)
318                         create_folder(maildir, 0, done);
319                 else
320                         done(1);
321         }
322
323         if (chdir(maildir) == NOTOK)
324                 adios(maildir, "unable to change directory to");
325
326         /* read folder and create message structure */
327         if (!(mp = folder_read(folder)))
328                 adios(NULL, "unable to read folder %s", folder);
329
330         if (access(newmail, W_OK) != NOTOK) {
331                 locked++;
332                 if (trnflag) {
333                         SIGNAL(SIGHUP, SIG_IGN);
334                         SIGNAL(SIGINT, SIG_IGN);
335                         SIGNAL(SIGQUIT, SIG_IGN);
336                         SIGNAL(SIGTERM, SIG_IGN);
337                 }
338
339                 GETGROUPPRIVS();  /* Reset gid to lock mail file */
340                 in = lkfopen(newmail, "r");
341                 DROPGROUPPRIVS();
342                 if (in == NULL)
343                         adios(NULL, "unable to lock and fopen %s", newmail);
344                 fstat(fileno(in), &s1);
345         } else {
346                 trnflag = 0;
347                 if ((in = fopen(newmail, "r")) == NULL)
348                         adios(newmail, "unable to read");
349         }
350
351         /* This shouldn't be necessary but it can't hurt. */
352         DROPGROUPPRIVS();
353
354         if (audfile) {
355                 int i;
356                 if ((i = stat(audfile, &st)) == NOTOK)
357                         advise(NULL, "Creating Receive-Audit: %s", audfile);
358                 if ((aud = fopen(audfile, "a")) == NULL)
359                         adios(audfile, "unable to append to");
360                 else if (i == NOTOK)
361                         chmod(audfile, m_gmprot());
362
363                 fprintf(aud, from ? "<<inc>> %s  -ms %s\n" : "<<inc>> %s\n",
364                          dtimenow(0), from);
365         }
366
367 #ifdef MHE
368         if (context_find("mhe")) {
369                 int i;
370                 cp = concat(maildir, "/++", NULL);
371                 i = stat(cp, &st);
372                 if ((mhe = fopen(cp, "a")) == NULL)
373                         admonish(cp, "unable to append to");
374                 else
375                         if (i == NOTOK)
376                                 chmod(cp, m_gmprot());
377                 free(cp);
378         }
379 #endif /* MHE */
380
381         /* Get new format string */
382         nfs = new_fs(form, format, FORMAT);
383
384         if (noisy) {
385                 printf("Incorporating new mail into %s...\n\n", folder);
386                 fflush(stdout);
387         }
388
389         /*
390         ** Get the mail from file (usually mail spool)
391         */
392         m_unknown(in);  /* the MAGIC invocation... */
393         hghnum = msgnum = mp->hghmsg;
394         for (;;) {
395                 /*
396                 ** Check if we need to allocate more space for message status.
397                 ** If so, then add space for an additional 100 messages.
398                 */
399                 if (msgnum >= mp->hghoff && !(mp = folder_realloc(mp, mp->lowoff, mp->hghoff + 100))) {
400                         advise(NULL, "unable to allocate folder storage");
401                         incerr = NOTOK;
402                         break;
403                 }
404
405                 /* create scanline for new message */
406                 switch (incerr = scan(in, msgnum + 1, msgnum + 1, nfs, width,
407                         msgnum == hghnum && chgflag, 1, NULL, 0L, noisy)) {
408                 case SCNFAT:
409                 case SCNEOF:
410                         break;
411
412                 case SCNERR:
413                         if (aud)
414                                 fputs("inc aborted!\n", aud);
415                         /* doesn't clean up locks! */
416                         advise(NULL, "aborted!");
417                         break;
418
419                 case SCNNUM:
420                         advise(NULL, "BUG in %s, number out of range",
421                                         invo_name);
422                         break;
423
424                 default:
425                         advise(NULL, "BUG in %s, scan() botch (%d)",
426                                         invo_name, incerr);
427                         break;
428
429                 case SCNMSG:
430                 case SCNENC:
431                         /*
432                         **  Run the external program hook on the message.
433                         */
434
435                         snprintf(b, sizeof (b), "%s/%d", maildir_copy,
436                                         msgnum + 1);
437                         ext_hook("add-hook", b, (char *)0);
438
439                         if (aud)
440                                 fputs(scanl, aud);
441 #ifdef MHE
442                         if (mhe)
443                                 fputs(scanl, mhe);
444 #endif /* MHE */
445                         if (noisy)
446                                 fflush(stdout);
447                         msgnum++;
448                         mp->hghmsg++;
449                         mp->nummsg++;
450                         if (mp->lowmsg == 0)
451                                 mp->lowmsg = 1;
452                         clear_msg_flags(mp, msgnum);
453                         set_exists(mp, msgnum);
454                         set_unseen(mp, msgnum);
455                         mp->msgflags |= SEQMOD;
456                         continue;
457                 }
458                 /*
459                 ** If we get here there was some sort of error from scan(),
460                 ** so stop processing anything more from the spool.
461                 */
462                 break;
463         }
464
465         if (incerr < 0) {  /* error */
466                 if (locked) {
467                         GETGROUPPRIVS();  /* Be sure we can unlock mail file */
468                         (void) lkfclose(in, newmail); in = NULL;
469                         DROPGROUPPRIVS();  /*
470                                         ** And then return us to normal
471                                         ** privileges
472                                         */
473                 } else {
474                         fclose(in); in = NULL;
475                 }
476                 adios(NULL, "failed");
477         }
478
479         if (aud)
480                 fclose(aud);
481
482 #ifdef MHE
483         if (mhe)
484                 fclose(mhe);
485 #endif /* MHE */
486
487         if (noisy)
488                 fflush(stdout);
489
490         /*
491         ** truncate file we are incorporating from
492         */
493         if (trnflag) {
494                 if (stat(newmail, &st) != NOTOK && s1.st_mtime != st.st_mtime)
495                         advise(NULL, "new messages have arrived!\007");
496                 else {
497                         int newfd;
498                         if ((newfd = creat(newmail, 0600)) != NOTOK)
499                                 close(newfd);
500                         else
501                                 admonish(newmail, "error zero'ing");
502                         unlink(map_name(newmail));
503                 }
504         } else if (noisy) {
505                 printf("%s not zero'd\n", newmail);
506         }
507
508         if (msgnum == hghnum) {
509                 admonish(NULL, "no messages incorporated");
510         } else {
511                 context_replace(pfolder, folder);  /* update current folder */
512                 if (chgflag)
513                         mp->curmsg = hghnum + 1;
514                 mp->hghmsg = msgnum;
515                 if (mp->lowmsg == 0)
516                         mp->lowmsg = 1;
517                 if (chgflag)  /* sigh... */
518                         seq_setcur(mp, mp->curmsg);
519         }
520
521         /*
522         ** unlock the mail spool
523         */
524         if (locked) {
525                 GETGROUPPRIVS();  /* Be sure we can unlock mail file */
526                 (void) lkfclose(in, newmail); in = NULL;
527                 DROPGROUPPRIVS();  /* And then return us to normal privileges */
528         } else {
529                 fclose(in); in = NULL;
530         }
531
532         seq_setunseen(mp, 0);  /* set the Unseen-Sequence */
533         seq_save(mp);  /* synchronize sequences   */
534         context_save();  /* save the context file   */
535         done(0);
536         return 1;
537 }
538
539 static void
540 inc_done(int status)
541 {
542         if (locked) {
543                 GETGROUPPRIVS();
544                 lkfclose(in, newmail);
545                 DROPGROUPPRIVS();
546         }
547         exit(status);
548 }