1 /* $OpenBSD: sendbug.c,v 1.27 2007/03/26 06:40:01 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 sig_t sighup, sigint, sigquit; 170 pid_t pid, xpid; 171 int st; 172 173 ed = getenv("VISUAL"); 174 if (ed == NULL || ed[0] == '\0') 175 ed = getenv("EDITOR"); 176 if (ed == NULL || ed[0] == '\0') 177 ed = _PATH_VI; 178 if (asprintf(&p, "%s %s", ed, tmpfile) == -1) 179 return (-1); 180 argp[2] = p; 181 182 top: 183 sighup = signal(SIGHUP, SIG_IGN); 184 sigint = signal(SIGINT, SIG_IGN); 185 sigquit = signal(SIGQUIT, SIG_IGN); 186 if ((pid = fork()) == -1) { 187 int saved_errno = errno; 188 189 (void)signal(SIGHUP, sighup); 190 (void)signal(SIGINT, sigint); 191 (void)signal(SIGQUIT, sigquit); 192 if (saved_errno == EAGAIN) { 193 sleep(1); 194 goto top; 195 } 196 free(p); 197 errno = saved_errno; 198 return (-1); 199 } 200 if (pid == 0) { 201 execv(_PATH_BSHELL, argp); 202 _exit(127); 203 } 204 free(p); 205 for (;;) { 206 xpid = waitpid(pid, (int *)&st, WUNTRACED); 207 if (xpid == -1) { 208 if (errno != EINTR) 209 return (-1); 210 } else if (WIFSTOPPED(st)) 211 raise(WSTOPSIG(st)); 212 else if (WIFEXITED(st)) 213 break; 214 } 215 (void)signal(SIGHUP, sighup); 216 (void)signal(SIGINT, sigint); 217 (void)signal(SIGQUIT, sigquit); 218 if (!WIFEXITED(st) || WEXITSTATUS(st) != 0) { 219 errno = ECHILD; 220 return (-1); 221 } 222 return (0); 223 } 224 225 int 226 prompt(void) 227 { 228 int c, ret; 229 230 fpurge(stdin); 231 fprintf(stderr, "a)bort, e)dit, or s)end: "); 232 fflush(stderr); 233 ret = getchar(); 234 if (ret == EOF || ret == '\n') 235 return (ret); 236 do { 237 c = getchar(); 238 } while (c != EOF && c != '\n'); 239 return (ret); 240 } 241 242 int 243 sendmail(const char *tmppath) 244 { 245 int filedes[2]; 246 247 if (pipe(filedes) == -1) { 248 warn("pipe: unsent report in %s", tmppath); 249 return (-1); 250 } 251 switch (fork()) { 252 case -1: 253 warn("fork error: unsent report in %s", 254 tmppath); 255 return (-1); 256 case 0: 257 close(filedes[1]); 258 if (dup2(filedes[0], STDIN_FILENO) == -1) { 259 warn("dup2 error: unsent report in %s", 260 tmppath); 261 return (-1); 262 } 263 close(filedes[0]); 264 execl("/usr/sbin/sendmail", "sendmail", 265 "-oi", "-t", (void *)NULL); 266 warn("sendmail error: unsent report in %s", 267 tmppath); 268 return (-1); 269 default: 270 close(filedes[0]); 271 /* Pipe into sendmail. */ 272 if (send_file(tmppath, filedes[1]) == -1) { 273 warn("send_file error: unsent report in %s", 274 tmppath); 275 return (-1); 276 } 277 close(filedes[1]); 278 wait(NULL); 279 break; 280 } 281 return (0); 282 } 283 284 void 285 init(void) 286 { 287 size_t len = 0, namelen; 288 const char *src; 289 int sysname[2]; 290 char *dst, *cp; 291 292 if ((pw = getpwuid(getuid())) == NULL) 293 err(1, "getpwuid"); 294 namelen = strlen(pw->pw_name); 295 296 /* Add length of expanded '&', minus existing '&'. */ 297 src = pw->pw_gecos; 298 src += strcspn(src, ",&"); 299 while (*src == '&') { 300 len += namelen - 1; 301 /* Look for next '&', skipping the one we just found. */ 302 src += 1 + strcspn(src, ",&"); 303 } 304 /* Add full name length, including all those '&' we skipped. */ 305 len += src - pw->pw_gecos; 306 if ((fullname = malloc(len + 1)) == NULL) 307 err(1, "malloc"); 308 309 dst = fullname; 310 src = pw->pw_gecos; 311 while (*src != ',' && *src != '\0') { 312 /* Copy text up to ',' or '&' and skip. */ 313 len = strcspn(src, ",&"); 314 memcpy(dst, src, len); 315 dst += len; 316 src += len; 317 /* Replace '&' with login. */ 318 if (*src == '&') { 319 memcpy(dst, pw->pw_name, namelen); 320 *dst = toupper((unsigned char)*dst); 321 dst += namelen; 322 ++src; 323 } 324 } 325 *dst = '\0'; 326 327 sysname[0] = CTL_KERN; 328 sysname[1] = KERN_OSTYPE; 329 len = sizeof(os) - 1; 330 if (sysctl(sysname, 2, &os, &len, NULL, 0) == -1) 331 err(1, "sysctl"); 332 333 sysname[0] = CTL_KERN; 334 sysname[1] = KERN_OSRELEASE; 335 len = sizeof(rel) - 1; 336 if (sysctl(sysname, 2, &rel, &len, NULL, 0) == -1) 337 err(1, "sysctl"); 338 339 sysname[0] = CTL_KERN; 340 sysname[1] = KERN_VERSION; 341 len = sizeof(details) - 1; 342 if (sysctl(sysname, 2, &details, &len, NULL, 0) == -1) 343 err(1, "sysctl"); 344 345 cp = strchr(details, '\n'); 346 if (cp) { 347 cp++; 348 if (*cp) 349 *cp++ = '\t'; 350 if (*cp) 351 *cp++ = '\t'; 352 if (*cp) 353 *cp++ = '\t'; 354 } 355 356 sysname[0] = CTL_HW; 357 sysname[1] = HW_MACHINE; 358 len = sizeof(mach) - 1; 359 if (sysctl(sysname, 2, &mach, &len, NULL, 0) == -1) 360 err(1, "sysctl"); 361 } 362 363 int 364 send_file(const char *file, int dst) 365 { 366 int blank = 0; 367 size_t len; 368 char *buf; 369 FILE *fp; 370 371 if ((fp = fopen(file, "r")) == NULL) 372 return (-1); 373 while ((buf = fgetln(fp, &len))) { 374 /* Skip lines starting with "SENDBUG". */ 375 if (len >= sizeof("SENDBUG") - 1 && 376 memcmp(buf, "SENDBUG", sizeof("SENDBUG") - 1) == 0) 377 continue; 378 if (len == 1 && buf[0] == '\n') 379 blank = 1; 380 /* Skip comments, but only if we encountered a blank line. */ 381 while (len) { 382 char *sp = NULL, *ep = NULL; 383 size_t copylen; 384 385 if (blank && (sp = memchr(buf, '<', len)) != NULL) 386 ep = memchr(sp, '>', len - (sp - buf + 1)); 387 /* Length of string before comment. */ 388 if (ep) 389 copylen = sp - buf; 390 else 391 copylen = len; 392 if (atomicio(vwrite, dst, buf, copylen) != copylen) { 393 int saved_errno = errno; 394 395 fclose(fp); 396 errno = saved_errno; 397 return (-1); 398 } 399 if (!ep) 400 break; 401 /* Skip comment. */ 402 len -= ep - buf + 1; 403 buf = ep + 1; 404 } 405 } 406 fclose(fp); 407 return (0); 408 } 409 410 void 411 template(FILE *fp) 412 { 413 fprintf(fp, "SENDBUG: -*- sendbug -*-\n"); 414 fprintf(fp, "SENDBUG: Lines starting with `SENDBUG' will" 415 " be removed automatically, as\n"); 416 fprintf(fp, "SENDBUG: will all comments (text enclosed in `<' and `>').\n"); 417 fprintf(fp, "SENDBUG:\n"); 418 fprintf(fp, "SENDBUG: Choose from the following categories:\n"); 419 fprintf(fp, "SENDBUG:\n"); 420 fprintf(fp, "SENDBUG: %s\n", categories); 421 fprintf(fp, "SENDBUG:\n"); 422 fprintf(fp, "SENDBUG:\n"); 423 fprintf(fp, "To: %s\n", "gnats@openbsd.org"); 424 fprintf(fp, "Subject: \n"); 425 fprintf(fp, "From: %s\n", pw->pw_name); 426 fprintf(fp, "Cc: \n"); 427 fprintf(fp, "Reply-To: %s\n", pw->pw_name); 428 fprintf(fp, "X-sendbug-version: %s\n", version); 429 fprintf(fp, "\n"); 430 fprintf(fp, "\n"); 431 fprintf(fp, ">Submitter-Id:\tnet\n"); 432 fprintf(fp, ">Originator:\t%s\n", fullname); 433 fprintf(fp, ">Organization:\n"); 434 fprintf(fp, "net\n"); 435 fprintf(fp, ">Synopsis:\t<synopsis of the problem (one line)>\n"); 436 fprintf(fp, ">Severity:\t" 437 "<[ non-critical | serious | critical ] (one line)>\n"); 438 fprintf(fp, ">Priority:\t<[ low | medium | high ] (one line)>\n"); 439 fprintf(fp, ">Category:\t<PR category (one line)>\n"); 440 fprintf(fp, ">Class:\t\t" 441 "<[ sw-bug | doc-bug | change-request | support ] (one line)>\n"); 442 fprintf(fp, ">Release:\t<release number or tag (one line)>\n"); 443 fprintf(fp, ">Environment:\n"); 444 fprintf(fp, "\t<machine, os, target, libraries (multiple lines)>\n"); 445 fprintf(fp, "\tSystem : %s %s\n", os, rel); 446 fprintf(fp, "\tDetails : %s\n", details); 447 fprintf(fp, "\tArchitecture: %s.%s\n", os, mach); 448 fprintf(fp, "\tMachine : %s\n", mach); 449 fprintf(fp, ">Description:\n"); 450 fprintf(fp, "\t<precise description of the problem (multiple lines)>\n"); 451 fprintf(fp, ">How-To-Repeat:\n"); 452 fprintf(fp, "\t<code/input/activities to reproduce the problem" 453 " (multiple lines)>\n"); 454 fprintf(fp, ">Fix:\n"); 455 fprintf(fp, "\t<how to correct or work around the problem," 456 " if known (multiple lines)>\n"); 457 } 458