xref: /openbsd-src/usr.bin/sendbug/sendbug.c (revision fac5405ad691b9524618a81296fd81153bf20e9d)
1 /*	$OpenBSD: sendbug.c,v 1.24 2007/03/26 05:39:51 ray Exp $	*/
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 
15 #include <ctype.h>
16 #include <err.h>
17 #include <errno.h>
18 #include <fcntl.h>
19 #include <limits.h>
20 #include <paths.h>
21 #include <pwd.h>
22 #include <signal.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <unistd.h>
27 
28 #include "atomicio.h"
29 
30 int	editit(char *);
31 void	init(void);
32 int	prompt(void);
33 int	send_file(const char *, int dst);
34 int	sendmail(const char *);
35 void	template(FILE *);
36 
37 const char *categories = "system user library documentation ports kernel "
38     "alpha amd64 arm i386 m68k m88k mips ppc sgi sparc sparc64 vax";
39 char *version = "4.2";
40 
41 struct passwd *pw;
42 char os[BUFSIZ], rel[BUFSIZ], mach[BUFSIZ], details[BUFSIZ];
43 char *fullname, *tmppath;
44 int wantcleanup;
45 
46 __dead void
47 usage(void)
48 {
49 	fprintf(stderr, "usage: sendbug [-LPV]\n");
50 	exit(1);
51 }
52 
53 void
54 cleanup()
55 {
56 	if (wantcleanup && tmppath && unlink(tmppath) == -1)
57 		warn("unlink");
58 }
59 
60 
61 int
62 main(int argc, char *argv[])
63 {
64 	int ch, c, fd, ret = 1;
65 	const char *tmpdir;
66 	struct stat sb;
67 	char *pr_form;
68 	time_t mtime;
69 	FILE *fp;
70 
71 	while ((ch = getopt(argc, argv, "LPV")) != -1)
72 		switch (ch) {
73 		case 'L':
74 			printf("Known categories:\n");
75 			printf("%s\n\n", categories);
76 			exit(0);
77 		case 'P':
78 			init();
79 			template(stdout);
80 			exit(0);
81 		case 'V':
82 			printf("%s\n", version);
83 			exit(0);
84 		default:
85 			usage();
86 		}
87 
88 	if (argc > 1) {
89 		usage();
90 	}
91 
92 	if ((tmpdir = getenv("TMPDIR")) == NULL || tmpdir[0] == '\0')
93 		tmpdir = _PATH_TMP;
94 	if (asprintf(&tmppath, "%s%sp.XXXXXXXXXX", tmpdir,
95 	    tmpdir[strlen(tmpdir) - 1] == '/' ? "" : "/") == -1)
96 		err(1, "asprintf");
97 	if ((fd = mkstemp(tmppath)) == -1)
98 		err(1, "mkstemp");
99 	wantcleanup = 1;
100 	atexit(cleanup);
101 	if ((fp = fdopen(fd, "w+")) == NULL)
102 		err(1, "fdopen");
103 
104 	init();
105 
106 	pr_form = getenv("PR_FORM");
107 	if (pr_form) {
108 		char buf[BUFSIZ];
109 		size_t len;
110 		FILE *frfp;
111 
112 		frfp = fopen(pr_form, "r");
113 		if (frfp == NULL) {
114 			fprintf(stderr, "sendbug: can't seem to read your"
115 			    " template file (`%s'), ignoring PR_FORM\n",
116 			    pr_form);
117 			template(fp);
118 		} else {
119 			while (!feof(frfp)) {
120 				len = fread(buf, 1, sizeof buf, frfp);
121 				if (len == 0)
122 					break;
123 				if (fwrite(buf, 1, len, fp) != len)
124 					break;
125 			}
126 			fclose(frfp);
127 		}
128 	} else
129 		template(fp);
130 
131 	if (fflush(fp) == EOF || fstat(fd, &sb) == -1 || fclose(fp) == EOF)
132 		err(1, "error creating template");
133 	mtime = sb.st_mtime;
134 
135  edit:
136 	editit(tmppath);
137 
138 	if (stat(tmppath, &sb) == -1)
139 		err(1, "stat");
140 	if (mtime == sb.st_mtime)
141 		errx(1, "report unchanged, nothing sent");
142 
143  prompt:
144 	c = prompt();
145 	switch (c) {
146 	case 'a':
147 	case EOF:
148 		wantcleanup = 0;
149 		errx(1, "unsent report in %s", tmppath);
150 	case 'e':
151 		goto edit;
152 	case 's':
153 		if (sendmail(tmppath) == -1)
154 			goto quit;
155 		break;
156 	default:
157 		goto prompt;
158 	}
159 
160 	ret = 0;
161 quit:
162 	return (ret);
163 }
164 
165 int
166 editit(char *tmpfile)
167 {
168 	char *argp[] = {"sh", "-c", NULL, NULL}, *ed, *p;
169 	pid_t pid, xpid;
170 	int st;
171 
172 	if ((ed = getenv("EDITOR")) == (char *)0)
173 		ed = _PATH_VI;
174 	if (asprintf(&p, "%s %s", ed, tmpfile) == -1)
175 		return (-1);
176 	argp[2] = p;
177 
178  top:
179 	(void)signal(SIGHUP, SIG_IGN);
180 	(void)signal(SIGINT, SIG_IGN);
181 	(void)signal(SIGQUIT, SIG_IGN);
182 	if ((pid = fork()) == -1) {
183 		int saved_errno = errno;
184 
185 		(void)signal(SIGHUP, SIG_DFL);
186 		(void)signal(SIGINT, SIG_DFL);
187 		(void)signal(SIGQUIT, SIG_DFL);
188 		if (saved_errno == EAGAIN) {
189 			sleep(1);
190 			goto top;
191 		}
192 		errno = saved_errno;
193 		perror("fork");
194 		free(p);
195 		return (-1);
196 	}
197 	if (pid == 0) {
198 		execv(_PATH_BSHELL, argp);
199 		_exit(127);
200 	}
201 	free(p);
202 	for (;;) {
203 		xpid = waitpid(pid, (int *)&st, WUNTRACED);
204 		if (xpid == -1) {
205 			if (errno != EINTR) {
206 				warn("waidpid");
207 				return (-1);
208 			}
209 		} else if (WIFSTOPPED(st))
210 			raise(WSTOPSIG(st));
211 		else if (WIFEXITED(st))
212 			break;
213 	}
214 	(void)signal(SIGHUP, SIG_DFL);
215 	(void)signal(SIGINT, SIG_DFL);
216 	(void)signal(SIGQUIT, SIG_DFL);
217 	if (!WIFEXITED(st) || WEXITSTATUS(st) != 0)
218 		return (-1);
219 	return (0);
220 }
221 
222 int
223 prompt(void)
224 {
225 	int c, ret;
226 
227 	fpurge(stdin);
228 	fprintf(stderr, "a)bort, e)dit, or s)end: ");
229 	fflush(stderr);
230 	ret = getchar();
231 	if (ret == EOF || ret == '\n')
232 		return (ret);
233 	do {
234 		c = getchar();
235 	} while (c != EOF && c != '\n');
236 	return (ret);
237 }
238 
239 int
240 sendmail(const char *tmppath)
241 {
242 	int filedes[2];
243 
244 	if (pipe(filedes) == -1) {
245 		warn("pipe: unsent report in %s", tmppath);
246 		return (-1);
247 	}
248 	switch (fork()) {
249 	case -1:
250 		warn("fork error: unsent report in %s",
251 		    tmppath);
252 		return (-1);
253 	case 0:
254 		close(filedes[1]);
255 		if (dup2(filedes[0], STDIN_FILENO) == -1) {
256 			warn("dup2 error: unsent report in %s",
257 			    tmppath);
258 			return (-1);
259 		}
260 		close(filedes[0]);
261 		execl("/usr/sbin/sendmail", "sendmail",
262 		    "-oi", "-t", (void *)NULL);
263 		warn("sendmail error: unsent report in %s",
264 		    tmppath);
265 		return (-1);
266 	default:
267 		close(filedes[0]);
268 		/* Pipe into sendmail. */
269 		if (send_file(tmppath, filedes[1]) == -1) {
270 			warn("send_file error: unsent report in %s",
271 			    tmppath);
272 			return (-1);
273 		}
274 		close(filedes[1]);
275 		wait(NULL);
276 		break;
277 	}
278 	return (0);
279 }
280 
281 void
282 init(void)
283 {
284 	size_t len = 0, namelen;
285 	const char *src;
286 	int sysname[2];
287 	char *dst, *cp;
288 
289 	if ((pw = getpwuid(getuid())) == NULL)
290 		err(1, "getpwuid");
291 	namelen = strlen(pw->pw_name);
292 
293 	/* Add length of expanded '&', minus existing '&'. */
294 	src = pw->pw_gecos;
295 	src += strcspn(src, ",&");
296 	while (*src == '&') {
297 		len += namelen - 1;
298 		/* Look for next '&', skipping the one we just found. */
299 		src += 1 + strcspn(src, ",&");
300 	}
301 	/* Add full name length, including all those '&' we skipped. */
302 	len += src - pw->pw_gecos;
303 	if ((fullname = malloc(len + 1)) == NULL)
304 		err(1, "malloc");
305 
306 	dst = fullname;
307 	src = pw->pw_gecos;
308 	while (*src != ',' && *src != '\0') {
309 		/* Copy text up to ',' or '&' and skip. */
310 		len = strcspn(src, ",&");
311 		memcpy(dst, src, len);
312 		dst += len;
313 		src += len;
314 		/* Replace '&' with login. */
315 		if (*src == '&') {
316 			memcpy(dst, pw->pw_name, namelen);
317 			*dst = toupper((unsigned char)*dst);
318 			dst += namelen;
319 			++src;
320 		}
321 	}
322 	*dst = '\0';
323 
324 	sysname[0] = CTL_KERN;
325 	sysname[1] = KERN_OSTYPE;
326 	len = sizeof(os) - 1;
327 	if (sysctl(sysname, 2, &os, &len, NULL, 0) == -1)
328 		err(1, "sysctl");
329 
330 	sysname[0] = CTL_KERN;
331 	sysname[1] = KERN_OSRELEASE;
332 	len = sizeof(rel) - 1;
333 	if (sysctl(sysname, 2, &rel, &len, NULL, 0) == -1)
334 		err(1, "sysctl");
335 
336 	sysname[0] = CTL_KERN;
337 	sysname[1] = KERN_VERSION;
338 	len = sizeof(details) - 1;
339 	if (sysctl(sysname, 2, &details, &len, NULL, 0) == -1)
340 		err(1, "sysctl");
341 
342 	cp = strchr(details, '\n');
343 	if (cp) {
344 		cp++;
345 		if (*cp)
346 			*cp++ = '\t';
347 		if (*cp)
348 			*cp++ = '\t';
349 		if (*cp)
350 			*cp++ = '\t';
351 	}
352 
353 	sysname[0] = CTL_HW;
354 	sysname[1] = HW_MACHINE;
355 	len = sizeof(mach) - 1;
356 	if (sysctl(sysname, 2, &mach, &len, NULL, 0) == -1)
357 		err(1, "sysctl");
358 }
359 
360 int
361 send_file(const char *file, int dst)
362 {
363 	int blank = 0;
364 	size_t len;
365 	char *buf;
366 	FILE *fp;
367 
368 	if ((fp = fopen(file, "r")) == NULL)
369 		return (-1);
370 	while ((buf = fgetln(fp, &len))) {
371 		/* Skip lines starting with "SENDBUG". */
372 		if (len >= sizeof("SENDBUG") - 1 &&
373 		    memcmp(buf, "SENDBUG", sizeof("SENDBUG") - 1) == 0)
374 			continue;
375 		if (len == 1 && buf[0] == '\n')
376 			blank = 1;
377 		/* Skip comments, but only if we encountered a blank line. */
378 		while (len) {
379 			char *sp = NULL, *ep = NULL;
380 			size_t copylen;
381 
382 			if (blank && (sp = memchr(buf, '<', len)) != NULL)
383 				ep = memchr(sp, '>', len - (sp - buf + 1));
384 			/* Length of string before comment. */
385 			if (ep)
386 				copylen = sp - buf;
387 			else
388 				copylen = len;
389 			if (atomicio(vwrite, dst, buf, copylen) != copylen) {
390 				int saved_errno = errno;
391 
392 				fclose(fp);
393 				errno = saved_errno;
394 				return (-1);
395 			}
396 			if (!ep)
397 				break;
398 			/* Skip comment. */
399 			len -= ep - buf + 1;
400 			buf = ep + 1;
401 		}
402 	}
403 	fclose(fp);
404 	return (0);
405 }
406 
407 void
408 template(FILE *fp)
409 {
410 	fprintf(fp, "SENDBUG: -*- sendbug -*-\n");
411 	fprintf(fp, "SENDBUG: Lines starting with `SENDBUG' will"
412 	    " be removed automatically, as\n");
413 	fprintf(fp, "SENDBUG: will all comments (text enclosed in `<' and `>').\n");
414 	fprintf(fp, "SENDBUG:\n");
415 	fprintf(fp, "SENDBUG: Choose from the following categories:\n");
416 	fprintf(fp, "SENDBUG:\n");
417 	fprintf(fp, "SENDBUG: %s\n", categories);
418 	fprintf(fp, "SENDBUG:\n");
419 	fprintf(fp, "SENDBUG:\n");
420 	fprintf(fp, "To: %s\n", "gnats@openbsd.org");
421 	fprintf(fp, "Subject: \n");
422 	fprintf(fp, "From: %s\n", pw->pw_name);
423 	fprintf(fp, "Cc: \n");
424 	fprintf(fp, "Reply-To: %s\n", pw->pw_name);
425 	fprintf(fp, "X-sendbug-version: %s\n", version);
426 	fprintf(fp, "\n");
427 	fprintf(fp, "\n");
428 	fprintf(fp, ">Submitter-Id:\tnet\n");
429 	fprintf(fp, ">Originator:\t%s\n", fullname);
430 	fprintf(fp, ">Organization:\n");
431 	fprintf(fp, "net\n");
432 	fprintf(fp, ">Synopsis:\t<synopsis of the problem (one line)>\n");
433 	fprintf(fp, ">Severity:\t"
434 	    "<[ non-critical | serious | critical ] (one line)>\n");
435 	fprintf(fp, ">Priority:\t<[ low | medium | high ] (one line)>\n");
436 	fprintf(fp, ">Category:\t<PR category (one line)>\n");
437 	fprintf(fp, ">Class:\t\t"
438 	    "<[ sw-bug | doc-bug | change-request | support ] (one line)>\n");
439 	fprintf(fp, ">Release:\t<release number or tag (one line)>\n");
440 	fprintf(fp, ">Environment:\n");
441 	fprintf(fp, "\t<machine, os, target, libraries (multiple lines)>\n");
442 	fprintf(fp, "\tSystem      : %s %s\n", os, rel);
443 	fprintf(fp, "\tDetails     : %s\n", details);
444 	fprintf(fp, "\tArchitecture: %s.%s\n", os, mach);
445 	fprintf(fp, "\tMachine     : %s\n", mach);
446 	fprintf(fp, ">Description:\n");
447 	fprintf(fp, "\t<precise description of the problem (multiple lines)>\n");
448 	fprintf(fp, ">How-To-Repeat:\n");
449 	fprintf(fp, "\t<code/input/activities to reproduce the problem"
450 	    " (multiple lines)>\n");
451 	fprintf(fp, ">Fix:\n");
452 	fprintf(fp, "\t<how to correct or work around the problem,"
453 	    " if known (multiple lines)>\n");
454 }
455