Expand PMF_FN_* macros.
[netbsd-mini2440.git] / usr.bin / mail / support.c
blobdd5e172e3ccd616c84043421e8591560461f913a
1 /* $NetBSD: support.c,v 1.21 2008/04/24 01:27:07 christos Exp $ */
3 /*
4 * Copyright (c) 1980, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
32 #include <sys/cdefs.h>
33 #ifndef lint
34 #if 0
35 static char sccsid[] = "@(#)aux.c 8.1 (Berkeley) 6/6/93";
36 #else
37 __RCSID("$NetBSD: support.c,v 1.21 2008/04/24 01:27:07 christos Exp $");
38 #endif
39 #endif /* not lint */
41 #include <stdarg.h>
42 #include <util.h>
44 #include "rcv.h"
45 #include "extern.h"
46 #include "mime.h"
47 #include "thread.h"
50 * Mail -- a mail program
52 * Auxiliary functions.
57 * Return a pointer to a dynamic copy of the argument.
59 PUBLIC char *
60 savestr(const char *str)
62 char *new;
63 size_t size = strlen(str) + 1;
65 if ((new = salloc(size)) != NULL)
66 (void)memmove(new, str, size);
67 return new;
71 * Make a copy of new argument incorporating old one.
73 static char *
74 save2str(char *str, char *old)
76 char *new;
77 size_t newsize = strlen(str) + 1;
78 size_t oldsize = old ? strlen(old) + 1 : 0;
80 if ((new = salloc(newsize + oldsize)) != NULL) {
81 if (oldsize) {
82 (void)memmove(new, old, oldsize);
83 new[oldsize - 1] = ' ';
85 (void)memmove(new + oldsize, str, newsize);
87 return new;
91 * Like asprintf(), but with result salloc-ed rather than malloc-ed.
93 PUBLIC int
94 sasprintf(char **ret, const char *format, ...)
96 int rval;
97 char *p;
98 va_list args;
100 va_start(args, format);
101 rval = evasprintf(&p, format, args);
102 *ret = savestr(p);
103 free(p);
104 va_end(args);
105 return rval;
108 struct set_m_flag_args_s {
109 int and_bits;
110 int xor_bits;
112 static int
113 set_m_flag_core(struct message *mp, void *v)
115 struct set_m_flag_args_s *args;
116 args = v;
117 mp->m_flag &= args->and_bits;
118 mp->m_flag ^= args->xor_bits;
119 return 0;
122 PUBLIC struct message *
123 set_m_flag(int msgnum, int and_bits, int xor_bits)
125 struct message *mp;
126 struct set_m_flag_args_s args;
127 mp = get_message(msgnum);
128 args.and_bits = and_bits;
129 args.xor_bits = xor_bits;
130 (void)thread_recursion(mp, set_m_flag_core, &args);
131 return mp;
135 * Touch the named message by setting its MTOUCH flag.
136 * Touched messages have the effect of not being sent
137 * back to the system mailbox on exit.
139 PUBLIC void
140 touch(struct message *mp)
143 mp->m_flag |= MTOUCH;
144 if ((mp->m_flag & MREAD) == 0)
145 mp->m_flag |= MREAD|MSTATUS;
149 * Test to see if the passed file name is a directory.
150 * Return true if it is.
152 PUBLIC int
153 isdir(const char name[])
155 struct stat sbuf;
157 if (stat(name, &sbuf) < 0)
158 return 0;
159 return S_ISDIR(sbuf.st_mode);
163 * Count the number of arguments in the given string raw list.
165 PUBLIC int
166 argcount(char **argv)
168 char **ap;
170 for (ap = argv; *ap++ != NULL; /*EMPTY*/)
171 continue;
172 return (int)(ap - argv - 1);
176 * Check whether the passed line is a header line of
177 * the desired breed. Return the field body, or NULL.
179 static char*
180 ishfield(const char linebuf[], char *colon, const char field[])
182 char *cp = colon;
184 *cp = 0;
185 if (strcasecmp(linebuf, field) != 0) {
186 *cp = ':';
187 return NULL;
189 *cp = ':';
190 for (cp++; is_WSP(*cp); cp++)
191 continue;
192 return cp;
196 * Return the next header field found in the given message.
197 * Return >= 0 if something found, < 0 elsewise.
198 * "colon" is set to point to the colon in the header.
199 * Must deal with \ continuations & other such fraud.
201 * WARNING - do not call this outside hfield() or decoding will not
202 * get done.
204 static int
205 gethfield(FILE *f, char linebuf[], int rem, char **colon)
207 char line2[LINESIZE];
208 char *cp, *cp2;
209 int c;
211 for (;;) {
212 if (--rem < 0)
213 return -1;
214 if ((c = readline(f, linebuf, LINESIZE, 0)) <= 0)
215 return -1;
216 for (cp = linebuf;
217 isprint((unsigned char)*cp) && *cp != ' ' && *cp != ':';
218 cp++)
219 continue;
220 if (*cp != ':' || cp == linebuf)
221 continue;
223 * I guess we got a headline.
224 * Handle wraparounding
226 *colon = cp;
227 cp = linebuf + c;
228 for (;;) {
229 while (--cp >= linebuf && is_WSP(*cp))
230 continue;
231 cp++;
232 if (rem <= 0)
233 break;
234 (void)ungetc(c = getc(f), f);
235 if (!is_WSP(c))
236 break;
237 if ((c = readline(f, line2, LINESIZE, 0)) < 0)
238 break;
239 rem--;
240 cp2 = skip_WSP(line2);
241 c -= (int)(cp2 - line2);
242 if (cp + c >= linebuf + LINESIZE - 2)
243 break;
244 *cp++ = ' ';
245 (void)memmove(cp, cp2, (size_t)c);
246 cp += c;
248 *cp = 0;
249 return rem;
251 /* NOTREACHED */
255 * Return the desired header line from the passed message
256 * pointer (or NULL if the desired header field is not available).
258 PUBLIC char *
259 hfield(const char field[], const struct message *mp)
261 FILE *ibuf;
262 char linebuf[LINESIZE];
263 int lc;
264 char *headerfield;
265 char *colon, *oldhfield = NULL;
266 #ifdef MIME_SUPPORT
267 int decode;
269 decode = value(ENAME_MIME_DECODE_MSG) &&
270 value(ENAME_MIME_DECODE_HDR);
271 #endif
273 ibuf = setinput(mp);
274 if ((lc = (int)(mp->m_lines - 1)) < 0)
275 return NULL;
276 if (readline(ibuf, linebuf, LINESIZE, 0) < 0)
277 return NULL;
278 while (lc > 0) {
279 if ((lc = gethfield(ibuf, linebuf, lc, &colon)) < 0)
280 return oldhfield;
281 #ifdef MIME_SUPPORT
282 if ((headerfield = ishfield(linebuf, colon, field)) != NULL) {
283 char linebuf2[LINESIZE];
284 if (decode)
285 headerfield = mime_decode_hfield(linebuf2,
286 sizeof(linebuf2), linebuf, headerfield);
287 oldhfield = save2str(headerfield, oldhfield);
289 #else
290 if ((headerfield = ishfield(linebuf, colon, field)) != NULL)
291 oldhfield = save2str(headerfield, oldhfield);
292 #endif
294 return oldhfield;
298 * Copy a string, lowercasing it as we go.
300 PUBLIC void
301 istrcpy(char *dest, const char *src)
304 do {
305 *dest++ = tolower((unsigned char)*src);
306 } while (*src++ != 0);
310 * The following code deals with input stacking to do source
311 * commands. All but the current file pointer are saved on
312 * the stack.
315 static int ssp; /* Top of file stack */
316 static struct sstack {
317 FILE *s_file; /* File we were in. */
318 int s_cond; /* Saved state of conditionals */
319 #ifdef NEW_CONDITIONAL
320 struct cond_stack_s *s_cond_stack; /* Saved conditional stack */
321 #endif
322 int s_loading; /* Loading .mailrc, etc. */
323 } sstack[NOFILE];
326 * Pushdown current input file and switch to a new one.
327 * Set the global flag "sourcing" so that others will realize
328 * that they are no longer reading from a tty (in all probability).
330 PUBLIC int
331 source(void *v)
333 char **arglist = v;
334 FILE *fi;
335 const char *cp;
337 if ((cp = expand(*arglist)) == NULL)
338 return 1;
339 if ((fi = Fopen(cp, "r")) == NULL) {
340 warn("%s", cp);
341 return 1;
343 if (ssp >= NOFILE - 1) {
344 (void)printf("Too much \"sourcing\" going on.\n");
345 (void)Fclose(fi);
346 return 1;
348 sstack[ssp].s_file = input;
349 sstack[ssp].s_cond = cond;
350 #ifdef NEW_CONDITIONAL
351 sstack[ssp].s_cond_stack = cond_stack;
352 #endif
353 sstack[ssp].s_loading = loading;
354 ssp++;
355 loading = 0;
356 cond = CNONE;
357 input = fi;
358 sourcing++;
359 return 0;
363 * Pop the current input back to the previous level.
364 * Update the "sourcing" flag as appropriate.
366 PUBLIC int
367 unstack(void)
369 if (ssp <= 0) {
370 (void)printf("\"Source\" stack over-pop.\n");
371 sourcing = 0;
372 return 1;
374 (void)Fclose(input);
375 if (cond != CNONE || cond_stack != NULL)
376 (void)printf("Unmatched \"if\"\n");
377 ssp--;
378 input = sstack[ssp].s_file;
379 cond = sstack[ssp].s_cond;
380 #ifdef NEW_CONDITIONAL
381 cond_stack = sstack[ssp].s_cond_stack;
382 #endif
383 loading = sstack[ssp].s_loading;
384 if (ssp == 0)
385 sourcing = loading;
386 return 0;
390 * Touch the indicated file.
391 * This is nifty for the shell.
393 PUBLIC void
394 alter(char *name)
396 struct stat sb;
397 struct timeval tv[2];
399 if (stat(name, &sb))
400 return;
401 (void)gettimeofday(&tv[0], NULL);
402 tv[0].tv_sec++;
403 TIMESPEC_TO_TIMEVAL(&tv[1], &sb.st_mtimespec);
404 (void)utimes(name, tv);
408 * Examine the passed line buffer and
409 * return true if it is all blanks and tabs.
411 PUBLIC int
412 blankline(char linebuf[])
414 char *cp;
416 for (cp = linebuf; *cp; cp++)
417 if (!is_WSP(*cp))
418 return 0;
419 return 1;
423 * Start of a "comment".
424 * Ignore it.
426 static char *
427 skip_comment(char *cp)
429 int nesting = 1;
431 for (/*EMPTY*/; nesting > 0 && *cp; cp++) {
432 switch (*cp) {
433 case '\\':
434 if (cp[1])
435 cp++;
436 break;
437 case '(':
438 nesting++;
439 break;
440 case ')':
441 nesting--;
442 break;
445 return cp;
449 * Skin an arpa net address according to the RFC 822 interpretation
450 * of "host-phrase."
452 PUBLIC char *
453 skin(char *name)
455 int c;
456 char *cp, *cp2;
457 char *bufend;
458 int gotlt, lastsp;
459 char nbuf[LINESIZE];
461 if (name == NULL)
462 return NULL;
463 if (strchr(name, '(') == NULL && strchr(name, '<') == NULL
464 && strchr(name, ' ') == NULL)
465 return name;
466 gotlt = 0;
467 lastsp = 0;
468 bufend = nbuf;
469 for (cp = name, cp2 = bufend; (c = *cp++) != '\0'; /*EMPTY*/) {
470 switch (c) {
471 case '(':
472 cp = skip_comment(cp);
473 lastsp = 0;
474 break;
476 case '"':
478 * Start of a "quoted-string".
479 * Copy it in its entirety.
481 while ((c = *cp) != '\0') {
482 cp++;
483 if (c == '"')
484 break;
485 if (c != '\\')
486 *cp2++ = c;
487 else if ((c = *cp) != '\0') {
488 *cp2++ = c;
489 cp++;
492 lastsp = 0;
493 break;
495 case ' ':
496 if (cp[0] == 'a' && cp[1] == 't' && cp[2] == ' ')
497 cp += 3, *cp2++ = '@';
498 else
499 if (cp[0] == '@' && cp[1] == ' ')
500 cp += 2, *cp2++ = '@';
501 else
502 lastsp = 1;
503 break;
505 case '<':
506 cp2 = bufend;
507 gotlt++;
508 lastsp = 0;
509 break;
511 case '>':
512 if (gotlt) {
513 gotlt = 0;
514 while ((c = *cp) && c != ',') {
515 cp++;
516 if (c == '(')
517 cp = skip_comment(cp);
518 else if (c == '"')
519 while ((c = *cp) != '\0') {
520 cp++;
521 if (c == '"')
522 break;
523 if (c == '\\' && *cp)
524 cp++;
527 lastsp = 0;
528 break;
530 /* FALLTHROUGH */
532 default:
533 if (lastsp) {
534 lastsp = 0;
535 *cp2++ = ' ';
537 *cp2++ = c;
538 if (c == ',' && !gotlt) {
539 *cp2++ = ' ';
540 for (/*EMPTY*/; *cp == ' '; cp++)
541 continue;
542 lastsp = 0;
543 bufend = cp2;
547 *cp2 = 0;
549 return savestr(nbuf);
553 * Fetch the sender's name from the passed message.
554 * Reptype can be
555 * 0 -- get sender's name for display purposes
556 * 1 -- get sender's name for reply
557 * 2 -- get sender's name for Reply
559 static char *
560 name1(struct message *mp, int reptype)
562 char namebuf[LINESIZE];
563 char linebuf[LINESIZE];
564 char *cp, *cp2;
565 FILE *ibuf;
566 int firstrun = 1;
568 if ((cp = hfield("from", mp)) != NULL)
569 return cp;
570 if (reptype == 0 && (cp = hfield("sender", mp)) != NULL)
571 return cp;
572 ibuf = setinput(mp);
573 namebuf[0] = '\0';
574 if (readline(ibuf, linebuf, LINESIZE, 0) < 0)
575 return savestr(namebuf);
576 newname:
577 for (cp = linebuf; *cp && *cp != ' '; cp++)
578 continue;
579 cp = skip_WSP(cp);
580 for (cp2 = &namebuf[strlen(namebuf)];
581 *cp && !is_WSP(*cp) && cp2 < namebuf + LINESIZE - 1;
582 /*EMPTY*/)
583 *cp2++ = *cp++;
584 *cp2 = '\0';
585 if (readline(ibuf, linebuf, LINESIZE, 0) < 0)
586 return savestr(namebuf);
587 if ((cp = strchr(linebuf, 'F')) == NULL)
588 return savestr(namebuf);
589 if (strncmp(cp, "From", 4) != 0)
590 return savestr(namebuf);
591 while ((cp = strchr(cp, 'r')) != NULL) {
592 if (strncmp(cp, "remote", 6) == 0) {
593 if ((cp = strchr(cp, 'f')) == NULL)
594 break;
595 if (strncmp(cp, "from", 4) != 0)
596 break;
597 if ((cp = strchr(cp, ' ')) == NULL)
598 break;
599 cp++;
600 if (firstrun) {
601 cp2 = namebuf;
602 firstrun = 0;
603 } else
604 cp2 = strrchr(namebuf, '!') + 1;
605 while (*cp && cp2 < namebuf + LINESIZE - 1)
606 *cp2++ = *cp++;
607 if (cp2 < namebuf + LINESIZE - 1)
608 *cp2++ = '!';
609 *cp2 = '\0';
610 if (cp2 < namebuf + LINESIZE - 1)
611 goto newname;
612 else
613 break;
615 cp++;
617 return savestr(namebuf);
621 * Count the occurrences of c in str
623 static int
624 charcount(char *str, int c)
626 char *cp;
627 int i;
629 for (i = 0, cp = str; *cp; cp++)
630 if (*cp == c)
631 i++;
632 return i;
636 * Get sender's name from this message. If the message has
637 * a bunch of arpanet stuff in it, we may have to skin the name
638 * before returning it.
640 PUBLIC char *
641 nameof(struct message *mp, int reptype)
643 char *cp, *cp2;
645 cp = skin(name1(mp, reptype));
646 if (reptype != 0 || charcount(cp, '!') < 2)
647 return cp;
648 cp2 = strrchr(cp, '!');
649 cp2--;
650 while (cp2 > cp && *cp2 != '!')
651 cp2--;
652 if (*cp2 == '!')
653 return cp2 + 1;
654 return cp;
658 * Copy s1 to s2, return pointer to null in s2.
660 PUBLIC char *
661 copy(char *s1, char *s2)
664 while ((*s2++ = *s1++) != '\0')
665 continue;
666 return s2 - 1;
670 * The core routine to check the ignore table for a field.
671 * Note: realfield should be lower-cased!
673 PUBLIC int
674 member(char *realfield, struct ignoretab *table)
676 struct ignore *igp;
678 for (igp = table->i_head[hash(realfield)]; igp != 0; igp = igp->i_link)
679 if (*igp->i_field == *realfield &&
680 equal(igp->i_field, realfield))
681 return 1;
682 return 0;
686 * See if the given header field is supposed to be ignored.
688 PUBLIC int
689 isign(const char *field, struct ignoretab ignoretabs[2])
691 char realfld[LINESIZE];
693 if (ignoretabs == ignoreall)
694 return 1;
696 * Lower-case the string, so that "Status" and "status"
697 * will hash to the same place.
699 istrcpy(realfld, field);
700 if (ignoretabs[1].i_count > 0)
701 return !member(realfld, ignoretabs + 1);
702 else
703 return member(realfld, ignoretabs);
706 PUBLIC void
707 add_ignore(const char *name, struct ignoretab *tab)
709 char field[LINESIZE];
710 int h;
711 struct ignore *igp;
713 istrcpy(field, name);
714 if (member(field, tab))
715 return;
716 h = hash(field);
717 igp = ecalloc(1, sizeof(struct ignore));
718 igp->i_field = ecalloc(strlen(field) + 1, sizeof(char));
719 (void)strcpy(igp->i_field, field);
720 igp->i_link = tab->i_head[h];
721 tab->i_head[h] = igp;
722 tab->i_count++;
726 * Write a file to stdout, skipping comment lines.
728 PUBLIC void
729 cathelp(const char *fname)
731 char *line;
732 FILE *f;
733 size_t len;
735 if ((f = Fopen(fname, "r")) == NULL) {
736 warn(fname);
737 return;
739 while ((line = fgetln(f, &len)) != NULL) {
740 if (*line == '#')
741 continue;
742 if (fwrite(line, 1, len, stdout) != len)
743 break;
745 (void)Fclose(f);
746 return;