Annotation of src/usr.bin/sendbug/sendbug.c, Revision 1.41
1.41 ! ray 1: /* $OpenBSD: sendbug.c,v 1.40 2007/04/07 00:24:59 ray Exp $ */
1.1 ray 2:
3: /*
4: * Written by Ray Lai <ray@cyth.net>.
5: * Public domain.
6: */
7:
8: #include <sys/types.h>
9: #include <sys/mman.h>
10: #include <sys/param.h>
11: #include <sys/stat.h>
12: #include <sys/sysctl.h>
13: #include <sys/wait.h>
14:
1.13 ray 15: #include <ctype.h>
1.1 ray 16: #include <err.h>
17: #include <errno.h>
18: #include <fcntl.h>
19: #include <limits.h>
20: #include <paths.h>
21: #include <pwd.h>
1.15 deraadt 22: #include <signal.h>
1.1 ray 23: #include <stdio.h>
24: #include <stdlib.h>
25: #include <string.h>
26: #include <unistd.h>
27:
28: #include "atomicio.h"
29:
1.35 ray 30: #define _PATH_DMESG "/var/run/dmesg.boot"
31:
1.39 ray 32: int checkfile(const char *);
1.36 ray 33: void dmesg(FILE *);
1.21 deraadt 34: int editit(char *);
35: void init(void);
1.40 ray 36: int matchline(const char *, const char *, size_t);
1.21 deraadt 37: int prompt(void);
1.32 ray 38: int send_file(const char *, int);
1.21 deraadt 39: int sendmail(const char *);
40: void template(FILE *);
1.1 ray 41:
42: const char *categories = "system user library documentation ports kernel "
43: "alpha amd64 arm i386 m68k m88k mips ppc sgi sparc sparc64 vax";
1.11 deraadt 44: char *version = "4.2";
45:
46: struct passwd *pw;
1.14 deraadt 47: char os[BUFSIZ], rel[BUFSIZ], mach[BUFSIZ], details[BUFSIZ];
1.21 deraadt 48: char *fullname, *tmppath;
1.12 tedu 49: int wantcleanup;
1.11 deraadt 50:
1.12 tedu 51: __dead void
1.3 deraadt 52: usage(void)
53: {
1.41 ! ray 54: extern char *__progname;
! 55:
! 56: fprintf(stderr, "usage: %s [-DLPV]\n", __progname);
1.12 tedu 57: exit(1);
58: }
59:
60: void
61: cleanup()
62: {
63: if (wantcleanup && tmppath && unlink(tmppath) == -1)
64: warn("unlink");
1.3 deraadt 65: }
66:
1.12 tedu 67:
1.1 ray 68: int
69: main(int argc, char *argv[])
70: {
1.35 ray 71: int ch, c, Dflag = 0, fd, ret = 1;
1.15 deraadt 72: const char *tmpdir;
1.19 deraadt 73: struct stat sb;
1.15 deraadt 74: char *pr_form;
1.1 ray 75: time_t mtime;
1.2 deraadt 76: FILE *fp;
1.3 deraadt 77:
1.35 ray 78: while ((ch = getopt(argc, argv, "DLPV")) != -1)
1.3 deraadt 79: switch (ch) {
1.35 ray 80: case 'D':
81: Dflag = 1;
82: break;
1.3 deraadt 83: case 'L':
84: printf("Known categories:\n");
85: printf("%s\n\n", categories);
86: exit(0);
87: case 'P':
1.12 tedu 88: init();
1.3 deraadt 89: template(stdout);
90: exit(0);
1.5 deraadt 91: case 'V':
92: printf("%s\n", version);
93: exit(0);
1.3 deraadt 94: default:
95: usage();
1.7 deraadt 96: }
1.35 ray 97: argc -= optind;
98: argv += optind;
1.7 deraadt 99:
1.37 ray 100: if (argc > 0)
1.3 deraadt 101: usage();
1.1 ray 102:
103: if ((tmpdir = getenv("TMPDIR")) == NULL || tmpdir[0] == '\0')
104: tmpdir = _PATH_TMP;
1.9 ray 105: if (asprintf(&tmppath, "%s%sp.XXXXXXXXXX", tmpdir,
1.19 deraadt 106: tmpdir[strlen(tmpdir) - 1] == '/' ? "" : "/") == -1)
1.12 tedu 107: err(1, "asprintf");
1.1 ray 108: if ((fd = mkstemp(tmppath)) == -1)
109: err(1, "mkstemp");
1.12 tedu 110: wantcleanup = 1;
111: atexit(cleanup);
1.19 deraadt 112: if ((fp = fdopen(fd, "w+")) == NULL)
1.12 tedu 113: err(1, "fdopen");
1.1 ray 114:
1.12 tedu 115: init();
1.1 ray 116:
1.10 deraadt 117: pr_form = getenv("PR_FORM");
118: if (pr_form) {
119: char buf[BUFSIZ];
120: size_t len;
121: FILE *frfp;
122:
123: frfp = fopen(pr_form, "r");
124: if (frfp == NULL) {
1.41 ! ray 125: warn("can't seem to read your template file "
! 126: "(`%s'), ignoring PR_FORM", pr_form);
1.10 deraadt 127: template(fp);
128: } else {
129: while (!feof(frfp)) {
130: len = fread(buf, 1, sizeof buf, frfp);
131: if (len == 0)
132: break;
133: if (fwrite(buf, 1, len, fp) != len)
134: break;
135: }
136: fclose(frfp);
137: }
1.35 ray 138: } else {
1.10 deraadt 139: template(fp);
1.36 ray 140: if (!Dflag)
141: dmesg(fp);
1.35 ray 142: }
1.1 ray 143:
1.19 deraadt 144: if (fflush(fp) == EOF || fstat(fd, &sb) == -1 || fclose(fp) == EOF)
1.12 tedu 145: err(1, "error creating template");
1.1 ray 146: mtime = sb.st_mtime;
147:
148: edit:
1.28 ray 149: if (editit(tmppath) == -1 && errno != ECHILD)
150: err(1, "error running editor");
1.1 ray 151:
1.19 deraadt 152: if (stat(tmppath, &sb) == -1)
1.12 tedu 153: err(1, "stat");
1.19 deraadt 154: if (mtime == sb.st_mtime)
1.12 tedu 155: errx(1, "report unchanged, nothing sent");
1.1 ray 156:
157: prompt:
1.39 ray 158: if (!checkfile(tmppath))
159: fprintf(stderr, "fields are blank, must be filled in\n");
1.1 ray 160: c = prompt();
161: switch (c) {
1.5 deraadt 162: case 'a':
163: case EOF:
1.12 tedu 164: wantcleanup = 0;
165: errx(1, "unsent report in %s", tmppath);
1.1 ray 166: case 'e':
167: goto edit;
168: case 's':
169: if (sendmail(tmppath) == -1)
170: goto quit;
171: break;
172: default:
173: goto prompt;
174: }
175:
176: ret = 0;
1.12 tedu 177: quit:
1.1 ray 178: return (ret);
1.36 ray 179: }
180:
181: void
182: dmesg(FILE *fp)
183: {
184: char buf[BUFSIZ];
185: FILE *dfp;
186: off_t offset = -1;
187:
188: dfp = fopen(_PATH_DMESG, "r");
189: if (dfp == NULL) {
190: warn("can't read dmesg");
191: return;
192: }
193:
194: fputs("\n"
195: "<dmesg is attached.>\n"
196: "<Feel free to delete or use the -D flag if it contains "
197: "sensitive information.>\n", fp);
198: /* Find last line starting with "OpenBSD". */
199: for (;;) {
200: off_t o;
201:
202: o = ftello(dfp);
203: if (fgets(buf, sizeof(buf), dfp) == NULL)
204: break;
205: if (!strncmp("OpenBSD ", buf, sizeof("OpenBSD ") - 1))
206: offset = o;
207: }
208: if (offset != -1) {
209: size_t len;
210:
211: clearerr(dfp);
212: fseeko(dfp, offset, SEEK_SET);
213: while (offset != -1 && !feof(dfp)) {
214: len = fread(buf, 1, sizeof buf, dfp);
215: if (len == 0)
216: break;
217: if (fwrite(buf, 1, len, fp) != len)
218: break;
219: }
220: }
221: fclose(dfp);
1.1 ray 222: }
223:
1.15 deraadt 224: int
1.38 ray 225: editit(char *pathname)
1.15 deraadt 226: {
1.19 deraadt 227: char *argp[] = {"sh", "-c", NULL, NULL}, *ed, *p;
1.25 ray 228: sig_t sighup, sigint, sigquit;
1.15 deraadt 229: pid_t pid, xpid;
1.21 deraadt 230: int st;
1.15 deraadt 231:
1.26 ray 232: ed = getenv("VISUAL");
233: if (ed == NULL || ed[0] == '\0')
234: ed = getenv("EDITOR");
235: if (ed == NULL || ed[0] == '\0')
1.15 deraadt 236: ed = _PATH_VI;
1.38 ray 237: if (asprintf(&p, "%s %s", ed, pathname) == -1)
1.18 ray 238: return (-1);
1.15 deraadt 239: argp[2] = p;
240:
241: top:
1.25 ray 242: sighup = signal(SIGHUP, SIG_IGN);
243: sigint = signal(SIGINT, SIG_IGN);
244: sigquit = signal(SIGQUIT, SIG_IGN);
1.23 ray 245: if ((pid = fork()) == -1) {
1.16 ray 246: int saved_errno = errno;
247:
1.25 ray 248: (void)signal(SIGHUP, sighup);
249: (void)signal(SIGINT, sigint);
250: (void)signal(SIGQUIT, sigquit);
1.16 ray 251: if (saved_errno == EAGAIN) {
1.15 deraadt 252: sleep(1);
253: goto top;
254: }
1.27 ray 255: free(p);
1.24 ray 256: errno = saved_errno;
1.18 ray 257: return (-1);
1.15 deraadt 258: }
259: if (pid == 0) {
260: execv(_PATH_BSHELL, argp);
261: _exit(127);
262: }
263: free(p);
264: for (;;) {
1.30 ray 265: xpid = waitpid(pid, &st, WUNTRACED);
1.21 deraadt 266: if (xpid == -1) {
1.27 ray 267: if (errno != EINTR)
1.21 deraadt 268: return (-1);
269: } else if (WIFSTOPPED(st))
270: raise(WSTOPSIG(st));
1.29 ray 271: else
1.15 deraadt 272: break;
273: }
1.25 ray 274: (void)signal(SIGHUP, sighup);
275: (void)signal(SIGINT, sigint);
276: (void)signal(SIGQUIT, sigquit);
1.27 ray 277: if (!WIFEXITED(st) || WEXITSTATUS(st) != 0) {
278: errno = ECHILD;
1.18 ray 279: return (-1);
1.27 ray 280: }
1.18 ray 281: return (0);
1.15 deraadt 282: }
1.12 tedu 283:
1.1 ray 284: int
285: prompt(void)
286: {
287: int c, ret;
288:
289: fpurge(stdin);
290: fprintf(stderr, "a)bort, e)dit, or s)end: ");
291: fflush(stderr);
292: ret = getchar();
293: if (ret == EOF || ret == '\n')
294: return (ret);
295: do {
296: c = getchar();
297: } while (c != EOF && c != '\n');
298: return (ret);
299: }
300:
301: int
1.38 ray 302: sendmail(const char *pathname)
1.1 ray 303: {
304: int filedes[2];
305:
306: if (pipe(filedes) == -1) {
1.38 ray 307: warn("pipe: unsent report in %s", pathname);
1.1 ray 308: return (-1);
309: }
310: switch (fork()) {
311: case -1:
312: warn("fork error: unsent report in %s",
1.38 ray 313: pathname);
1.1 ray 314: return (-1);
315: case 0:
316: close(filedes[1]);
317: if (dup2(filedes[0], STDIN_FILENO) == -1) {
318: warn("dup2 error: unsent report in %s",
1.38 ray 319: pathname);
1.1 ray 320: return (-1);
321: }
322: close(filedes[0]);
323: execl("/usr/sbin/sendmail", "sendmail",
1.2 deraadt 324: "-oi", "-t", (void *)NULL);
1.1 ray 325: warn("sendmail error: unsent report in %s",
1.38 ray 326: pathname);
1.1 ray 327: return (-1);
328: default:
329: close(filedes[0]);
330: /* Pipe into sendmail. */
1.38 ray 331: if (send_file(pathname, filedes[1]) == -1) {
1.1 ray 332: warn("send_file error: unsent report in %s",
1.38 ray 333: pathname);
1.1 ray 334: return (-1);
335: }
336: close(filedes[1]);
337: wait(NULL);
338: break;
339: }
340: return (0);
341: }
342:
1.12 tedu 343: void
1.1 ray 344: init(void)
345: {
1.33 ray 346: size_t amp, len, gecoslen, namelen;
1.1 ray 347: int sysname[2];
1.33 ray 348: char ch, *cp;
1.1 ray 349:
1.19 deraadt 350: if ((pw = getpwuid(getuid())) == NULL)
1.12 tedu 351: err(1, "getpwuid");
1.13 ray 352: namelen = strlen(pw->pw_name);
1.1 ray 353:
1.31 moritz 354: /* Count number of '&'. */
1.33 ray 355: for (amp = 0, cp = pw->pw_gecos; *cp && *cp != ','; ++cp)
356: if (*cp == '&')
1.31 moritz 357: ++amp;
1.33 ray 358:
359: /* Truncate gecos to full name. */
360: gecoslen = cp - pw->pw_gecos;
361: pw->pw_gecos[gecoslen] = '\0';
362:
1.31 moritz 363: /* Expanded str = orig str - '&' chars + concatenated logins. */
1.33 ray 364: len = gecoslen - amp + (amp * namelen) + 1;
365: if ((fullname = malloc(len)) == NULL)
1.12 tedu 366: err(1, "malloc");
1.19 deraadt 367:
1.33 ray 368: /* Upper case first char of login. */
369: ch = pw->pw_name[0];
370: pw->pw_name[0] = toupper((unsigned char)pw->pw_name[0]);
371:
372: cp = pw->pw_gecos;
373: fullname[0] = '\0';
374: while (cp != NULL) {
375: char *token;
376:
377: token = strsep(&cp, "&");
378: if (token != pw->pw_gecos &&
379: strlcat(fullname, pw->pw_name, len) >= len)
380: errx(1, "truncated string");
381: if (strlcat(fullname, token, len) >= len)
382: errx(1, "truncated string");
1.13 ray 383: }
1.33 ray 384: /* Restore case of first char of login. */
385: pw->pw_name[0] = ch;
1.1 ray 386:
387: sysname[0] = CTL_KERN;
388: sysname[1] = KERN_OSTYPE;
389: len = sizeof(os) - 1;
1.19 deraadt 390: if (sysctl(sysname, 2, &os, &len, NULL, 0) == -1)
1.12 tedu 391: err(1, "sysctl");
1.1 ray 392:
393: sysname[0] = CTL_KERN;
394: sysname[1] = KERN_OSRELEASE;
395: len = sizeof(rel) - 1;
1.19 deraadt 396: if (sysctl(sysname, 2, &rel, &len, NULL, 0) == -1)
1.12 tedu 397: err(1, "sysctl");
1.1 ray 398:
1.14 deraadt 399: sysname[0] = CTL_KERN;
400: sysname[1] = KERN_VERSION;
401: len = sizeof(details) - 1;
1.19 deraadt 402: if (sysctl(sysname, 2, &details, &len, NULL, 0) == -1)
1.14 deraadt 403: err(1, "sysctl");
404:
405: cp = strchr(details, '\n');
406: if (cp) {
407: cp++;
408: if (*cp)
409: *cp++ = '\t';
410: if (*cp)
411: *cp++ = '\t';
412: if (*cp)
413: *cp++ = '\t';
414: }
415:
1.1 ray 416: sysname[0] = CTL_HW;
417: sysname[1] = HW_MACHINE;
418: len = sizeof(mach) - 1;
1.19 deraadt 419: if (sysctl(sysname, 2, &mach, &len, NULL, 0) == -1)
1.12 tedu 420: err(1, "sysctl");
1.1 ray 421: }
422:
423: int
424: send_file(const char *file, int dst)
425: {
1.2 deraadt 426: int blank = 0;
427: size_t len;
428: char *buf;
1.1 ray 429: FILE *fp;
430:
431: if ((fp = fopen(file, "r")) == NULL)
432: return (-1);
433: while ((buf = fgetln(fp, &len))) {
434: /* Skip lines starting with "SENDBUG". */
435: if (len >= sizeof("SENDBUG") - 1 &&
436: memcmp(buf, "SENDBUG", sizeof("SENDBUG") - 1) == 0)
437: continue;
438: if (len == 1 && buf[0] == '\n')
439: blank = 1;
440: /* Skip comments, but only if we encountered a blank line. */
441: while (len) {
1.14 deraadt 442: char *sp = NULL, *ep = NULL;
1.1 ray 443: size_t copylen;
444:
445: if (blank && (sp = memchr(buf, '<', len)) != NULL)
446: ep = memchr(sp, '>', len - (sp - buf + 1));
447: /* Length of string before comment. */
1.4 ray 448: if (ep)
449: copylen = sp - buf;
450: else
451: copylen = len;
1.1 ray 452: if (atomicio(vwrite, dst, buf, copylen) != copylen) {
453: int saved_errno = errno;
454:
455: fclose(fp);
456: errno = saved_errno;
457: return (-1);
458: }
459: if (!ep)
460: break;
461: /* Skip comment. */
462: len -= ep - buf + 1;
463: buf = ep + 1;
464: }
465: }
466: fclose(fp);
467: return (0);
1.39 ray 468: }
469:
470: /*
471: * Does line start with `s' and end with non-comment and non-whitespace?
1.40 ray 472: * Note: Does not treat `line' as a C string.
1.39 ray 473: */
474: int
1.40 ray 475: matchline(const char *s, const char *line, size_t linelen)
1.39 ray 476: {
477: size_t slen;
478: int comment;
479:
480: slen = strlen(s);
481: /* Is line shorter than string? */
482: if (linelen <= slen)
483: return (0);
484: /* Does line start with string? */
485: if (memcmp(line, s, slen) != 0)
486: return (0);
487: /* Does line contain anything but comments and whitespace? */
488: line += slen;
489: linelen -= slen;
490: comment = 0;
491: while (linelen) {
492: if (comment) {
493: if (*line == '>')
494: comment = 0;
495: } else if (*line == '<')
496: comment = 1;
1.40 ray 497: else if (!isspace((unsigned char)*line))
1.39 ray 498: return (1);
499: ++line;
500: --linelen;
501: }
502: return (0);
503: }
504:
505: /*
506: * Are all required fields filled out?
507: */
508: int
509: checkfile(const char *pathname)
510: {
511: FILE *fp;
512: size_t len;
513: int category, class, priority, release, severity, synopsis;
514: char *buf;
515:
516: if ((fp = fopen(pathname, "r")) == NULL) {
517: warn("%s", pathname);
518: return (0);
519: }
520: category = class = priority = release = severity = synopsis = 0;
521: while ((buf = fgetln(fp, &len))) {
522: if (matchline(">Category:", buf, len))
523: category = 1;
524: else if (matchline(">Class:", buf, len))
525: class = 1;
526: else if (matchline(">Priority:", buf, len))
527: priority = 1;
528: else if (matchline(">Release:", buf, len))
529: release = 1;
530: else if (matchline(">Severity:", buf, len))
531: severity = 1;
532: else if (matchline(">Synopsis:", buf, len))
533: synopsis = 1;
534: }
535: fclose(fp);
536: return (category && class && priority && release && severity &&
537: synopsis);
1.1 ray 538: }
539:
540: void
541: template(FILE *fp)
542: {
543: fprintf(fp, "SENDBUG: -*- sendbug -*-\n");
1.19 deraadt 544: fprintf(fp, "SENDBUG: Lines starting with `SENDBUG' will"
545: " be removed automatically, as\n");
546: fprintf(fp, "SENDBUG: will all comments (text enclosed in `<' and `>').\n");
1.1 ray 547: fprintf(fp, "SENDBUG:\n");
548: fprintf(fp, "SENDBUG: Choose from the following categories:\n");
549: fprintf(fp, "SENDBUG:\n");
550: fprintf(fp, "SENDBUG: %s\n", categories);
551: fprintf(fp, "SENDBUG:\n");
552: fprintf(fp, "SENDBUG:\n");
553: fprintf(fp, "To: %s\n", "gnats@openbsd.org");
554: fprintf(fp, "Subject: \n");
555: fprintf(fp, "From: %s\n", pw->pw_name);
1.34 ray 556: fprintf(fp, "Cc: %s\n", pw->pw_name);
1.1 ray 557: fprintf(fp, "Reply-To: %s\n", pw->pw_name);
1.5 deraadt 558: fprintf(fp, "X-sendbug-version: %s\n", version);
1.1 ray 559: fprintf(fp, "\n");
560: fprintf(fp, "\n");
561: fprintf(fp, ">Submitter-Id:\tnet\n");
562: fprintf(fp, ">Originator:\t%s\n", fullname);
563: fprintf(fp, ">Organization:\n");
564: fprintf(fp, "net\n");
565: fprintf(fp, ">Synopsis:\t<synopsis of the problem (one line)>\n");
1.19 deraadt 566: fprintf(fp, ">Severity:\t"
567: "<[ non-critical | serious | critical ] (one line)>\n");
1.1 ray 568: fprintf(fp, ">Priority:\t<[ low | medium | high ] (one line)>\n");
569: fprintf(fp, ">Category:\t<PR category (one line)>\n");
1.19 deraadt 570: fprintf(fp, ">Class:\t\t"
571: "<[ sw-bug | doc-bug | change-request | support ] (one line)>\n");
1.1 ray 572: fprintf(fp, ">Release:\t<release number or tag (one line)>\n");
573: fprintf(fp, ">Environment:\n");
574: fprintf(fp, "\t<machine, os, target, libraries (multiple lines)>\n");
575: fprintf(fp, "\tSystem : %s %s\n", os, rel);
1.14 deraadt 576: fprintf(fp, "\tDetails : %s\n", details);
1.1 ray 577: fprintf(fp, "\tArchitecture: %s.%s\n", os, mach);
578: fprintf(fp, "\tMachine : %s\n", mach);
579: fprintf(fp, ">Description:\n");
580: fprintf(fp, "\t<precise description of the problem (multiple lines)>\n");
581: fprintf(fp, ">How-To-Repeat:\n");
1.19 deraadt 582: fprintf(fp, "\t<code/input/activities to reproduce the problem"
583: " (multiple lines)>\n");
1.1 ray 584: fprintf(fp, ">Fix:\n");
1.19 deraadt 585: fprintf(fp, "\t<how to correct or work around the problem,"
586: " if known (multiple lines)>\n");
1.1 ray 587: }