1 /* $Id: man_validate.c,v 1.57 2012/11/17 00:25:20 schwarze Exp $ */ 2 /* 3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4 * Copyright (c) 2010, 2012 Ingo Schwarze <schwarze@openbsd.org> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 #include <sys/types.h> 19 20 #include <assert.h> 21 #include <ctype.h> 22 #include <errno.h> 23 #include <limits.h> 24 #include <stdarg.h> 25 #include <stdlib.h> 26 #include <string.h> 27 #include <time.h> 28 29 #include "man.h" 30 #include "mandoc.h" 31 #include "libman.h" 32 #include "libmandoc.h" 33 34 #define CHKARGS struct man *man, struct man_node *n 35 36 typedef int (*v_check)(CHKARGS); 37 38 struct man_valid { 39 v_check *pres; 40 v_check *posts; 41 }; 42 43 static int check_eq0(CHKARGS); 44 static int check_eq2(CHKARGS); 45 static int check_le1(CHKARGS); 46 static int check_ge2(CHKARGS); 47 static int check_le5(CHKARGS); 48 static int check_par(CHKARGS); 49 static int check_part(CHKARGS); 50 static int check_root(CHKARGS); 51 static void check_text(CHKARGS); 52 53 static int post_AT(CHKARGS); 54 static int post_IP(CHKARGS); 55 static int post_vs(CHKARGS); 56 static int post_fi(CHKARGS); 57 static int post_ft(CHKARGS); 58 static int post_nf(CHKARGS); 59 static int post_sec(CHKARGS); 60 static int post_TH(CHKARGS); 61 static int post_UC(CHKARGS); 62 static int pre_sec(CHKARGS); 63 64 static v_check posts_at[] = { post_AT, NULL }; 65 static v_check posts_br[] = { post_vs, check_eq0, NULL }; 66 static v_check posts_eq0[] = { check_eq0, NULL }; 67 static v_check posts_eq2[] = { check_eq2, NULL }; 68 static v_check posts_fi[] = { check_eq0, post_fi, NULL }; 69 static v_check posts_ft[] = { post_ft, NULL }; 70 static v_check posts_ip[] = { post_IP, NULL }; 71 static v_check posts_le1[] = { check_le1, NULL }; 72 static v_check posts_nf[] = { check_eq0, post_nf, NULL }; 73 static v_check posts_par[] = { check_par, NULL }; 74 static v_check posts_part[] = { check_part, NULL }; 75 static v_check posts_sec[] = { post_sec, NULL }; 76 static v_check posts_sp[] = { post_vs, check_le1, NULL }; 77 static v_check posts_th[] = { check_ge2, check_le5, post_TH, NULL }; 78 static v_check posts_uc[] = { post_UC, NULL }; 79 static v_check pres_sec[] = { pre_sec, NULL }; 80 81 static const struct man_valid man_valids[MAN_MAX] = { 82 { NULL, posts_br }, /* br */ 83 { NULL, posts_th }, /* TH */ 84 { pres_sec, posts_sec }, /* SH */ 85 { pres_sec, posts_sec }, /* SS */ 86 { NULL, NULL }, /* TP */ 87 { NULL, posts_par }, /* LP */ 88 { NULL, posts_par }, /* PP */ 89 { NULL, posts_par }, /* P */ 90 { NULL, posts_ip }, /* IP */ 91 { NULL, NULL }, /* HP */ 92 { NULL, NULL }, /* SM */ 93 { NULL, NULL }, /* SB */ 94 { NULL, NULL }, /* BI */ 95 { NULL, NULL }, /* IB */ 96 { NULL, NULL }, /* BR */ 97 { NULL, NULL }, /* RB */ 98 { NULL, NULL }, /* R */ 99 { NULL, NULL }, /* B */ 100 { NULL, NULL }, /* I */ 101 { NULL, NULL }, /* IR */ 102 { NULL, NULL }, /* RI */ 103 { NULL, posts_eq0 }, /* na */ 104 { NULL, posts_sp }, /* sp */ 105 { NULL, posts_nf }, /* nf */ 106 { NULL, posts_fi }, /* fi */ 107 { NULL, NULL }, /* RE */ 108 { NULL, posts_part }, /* RS */ 109 { NULL, NULL }, /* DT */ 110 { NULL, posts_uc }, /* UC */ 111 { NULL, posts_le1 }, /* PD */ 112 { NULL, posts_at }, /* AT */ 113 { NULL, NULL }, /* in */ 114 { NULL, posts_ft }, /* ft */ 115 { NULL, posts_eq2 }, /* OP */ 116 { NULL, posts_nf }, /* EX */ 117 { NULL, posts_fi }, /* EE */ 118 }; 119 120 121 int 122 man_valid_pre(struct man *man, struct man_node *n) 123 { 124 v_check *cp; 125 126 switch (n->type) { 127 case (MAN_TEXT): 128 /* FALLTHROUGH */ 129 case (MAN_ROOT): 130 /* FALLTHROUGH */ 131 case (MAN_EQN): 132 /* FALLTHROUGH */ 133 case (MAN_TBL): 134 return(1); 135 default: 136 break; 137 } 138 139 if (NULL == (cp = man_valids[n->tok].pres)) 140 return(1); 141 for ( ; *cp; cp++) 142 if ( ! (*cp)(man, n)) 143 return(0); 144 return(1); 145 } 146 147 148 int 149 man_valid_post(struct man *man) 150 { 151 v_check *cp; 152 153 if (MAN_VALID & man->last->flags) 154 return(1); 155 man->last->flags |= MAN_VALID; 156 157 switch (man->last->type) { 158 case (MAN_TEXT): 159 check_text(man, man->last); 160 return(1); 161 case (MAN_ROOT): 162 return(check_root(man, man->last)); 163 case (MAN_EQN): 164 /* FALLTHROUGH */ 165 case (MAN_TBL): 166 return(1); 167 default: 168 break; 169 } 170 171 if (NULL == (cp = man_valids[man->last->tok].posts)) 172 return(1); 173 for ( ; *cp; cp++) 174 if ( ! (*cp)(man, man->last)) 175 return(0); 176 177 return(1); 178 } 179 180 181 static int 182 check_root(CHKARGS) 183 { 184 185 if (MAN_BLINE & man->flags) 186 man_nmsg(man, n, MANDOCERR_SCOPEEXIT); 187 else if (MAN_ELINE & man->flags) 188 man_nmsg(man, n, MANDOCERR_SCOPEEXIT); 189 190 man->flags &= ~MAN_BLINE; 191 man->flags &= ~MAN_ELINE; 192 193 if (NULL == man->first->child) { 194 man_nmsg(man, n, MANDOCERR_NODOCBODY); 195 return(0); 196 } else if (NULL == man->meta.title) { 197 man_nmsg(man, n, MANDOCERR_NOTITLE); 198 199 /* 200 * If a title hasn't been set, do so now (by 201 * implication, date and section also aren't set). 202 */ 203 204 man->meta.title = mandoc_strdup("unknown"); 205 man->meta.msec = mandoc_strdup("1"); 206 man->meta.date = mandoc_normdate 207 (man->parse, NULL, n->line, n->pos); 208 } 209 210 return(1); 211 } 212 213 static void 214 check_text(CHKARGS) 215 { 216 char *cp, *p; 217 218 if (MAN_LITERAL & man->flags) 219 return; 220 221 cp = n->string; 222 for (p = cp; NULL != (p = strchr(p, '\t')); p++) 223 man_pmsg(man, n->line, (int)(p - cp), MANDOCERR_BADTAB); 224 } 225 226 #define INEQ_DEFINE(x, ineq, name) \ 227 static int \ 228 check_##name(CHKARGS) \ 229 { \ 230 if (n->nchild ineq (x)) \ 231 return(1); \ 232 mandoc_vmsg(MANDOCERR_ARGCOUNT, man->parse, n->line, n->pos, \ 233 "line arguments %s %d (have %d)", \ 234 #ineq, (x), n->nchild); \ 235 return(1); \ 236 } 237 238 INEQ_DEFINE(0, ==, eq0) 239 INEQ_DEFINE(2, ==, eq2) 240 INEQ_DEFINE(1, <=, le1) 241 INEQ_DEFINE(2, >=, ge2) 242 INEQ_DEFINE(5, <=, le5) 243 244 static int 245 post_ft(CHKARGS) 246 { 247 char *cp; 248 int ok; 249 250 if (0 == n->nchild) 251 return(1); 252 253 ok = 0; 254 cp = n->child->string; 255 switch (*cp) { 256 case ('1'): 257 /* FALLTHROUGH */ 258 case ('2'): 259 /* FALLTHROUGH */ 260 case ('3'): 261 /* FALLTHROUGH */ 262 case ('4'): 263 /* FALLTHROUGH */ 264 case ('I'): 265 /* FALLTHROUGH */ 266 case ('P'): 267 /* FALLTHROUGH */ 268 case ('R'): 269 if ('\0' == cp[1]) 270 ok = 1; 271 break; 272 case ('B'): 273 if ('\0' == cp[1] || ('I' == cp[1] && '\0' == cp[2])) 274 ok = 1; 275 break; 276 case ('C'): 277 if ('W' == cp[1] && '\0' == cp[2]) 278 ok = 1; 279 break; 280 default: 281 break; 282 } 283 284 if (0 == ok) { 285 mandoc_vmsg 286 (MANDOCERR_BADFONT, man->parse, 287 n->line, n->pos, "%s", cp); 288 *cp = '\0'; 289 } 290 291 if (1 < n->nchild) 292 mandoc_vmsg 293 (MANDOCERR_ARGCOUNT, man->parse, n->line, 294 n->pos, "want one child (have %d)", 295 n->nchild); 296 297 return(1); 298 } 299 300 static int 301 pre_sec(CHKARGS) 302 { 303 304 if (MAN_BLOCK == n->type) 305 man->flags &= ~MAN_LITERAL; 306 return(1); 307 } 308 309 static int 310 post_sec(CHKARGS) 311 { 312 313 if ( ! (MAN_HEAD == n->type && 0 == n->nchild)) 314 return(1); 315 316 man_nmsg(man, n, MANDOCERR_SYNTARGCOUNT); 317 return(0); 318 } 319 320 static int 321 check_part(CHKARGS) 322 { 323 324 if (MAN_BODY == n->type && 0 == n->nchild) 325 mandoc_msg(MANDOCERR_ARGCWARN, man->parse, n->line, 326 n->pos, "want children (have none)"); 327 328 return(1); 329 } 330 331 332 static int 333 check_par(CHKARGS) 334 { 335 336 switch (n->type) { 337 case (MAN_BLOCK): 338 if (0 == n->body->nchild) 339 man_node_delete(man, n); 340 break; 341 case (MAN_BODY): 342 if (0 == n->nchild) 343 man_nmsg(man, n, MANDOCERR_IGNPAR); 344 break; 345 case (MAN_HEAD): 346 if (n->nchild) 347 man_nmsg(man, n, MANDOCERR_ARGSLOST); 348 break; 349 default: 350 break; 351 } 352 353 return(1); 354 } 355 356 static int 357 post_IP(CHKARGS) 358 { 359 360 switch (n->type) { 361 case (MAN_BLOCK): 362 if (0 == n->head->nchild && 0 == n->body->nchild) 363 man_node_delete(man, n); 364 break; 365 case (MAN_BODY): 366 if (0 == n->parent->head->nchild && 0 == n->nchild) 367 man_nmsg(man, n, MANDOCERR_IGNPAR); 368 break; 369 default: 370 break; 371 } 372 return(1); 373 } 374 375 static int 376 post_TH(CHKARGS) 377 { 378 const char *p; 379 int line, pos; 380 381 free(man->meta.title); 382 free(man->meta.vol); 383 free(man->meta.source); 384 free(man->meta.msec); 385 free(man->meta.date); 386 387 line = n->line; 388 pos = n->pos; 389 man->meta.title = man->meta.vol = man->meta.date = 390 man->meta.msec = man->meta.source = NULL; 391 392 /* ->TITLE<- MSEC DATE SOURCE VOL */ 393 394 n = n->child; 395 if (n && n->string) { 396 for (p = n->string; '\0' != *p; p++) { 397 /* Only warn about this once... */ 398 if (isalpha((unsigned char)*p) && 399 ! isupper((unsigned char)*p)) { 400 man_nmsg(man, n, MANDOCERR_UPPERCASE); 401 break; 402 } 403 } 404 man->meta.title = mandoc_strdup(n->string); 405 } else 406 man->meta.title = mandoc_strdup(""); 407 408 /* TITLE ->MSEC<- DATE SOURCE VOL */ 409 410 if (n) 411 n = n->next; 412 if (n && n->string) 413 man->meta.msec = mandoc_strdup(n->string); 414 else 415 man->meta.msec = mandoc_strdup(""); 416 417 /* TITLE MSEC ->DATE<- SOURCE VOL */ 418 419 if (n) 420 n = n->next; 421 if (n && n->string && '\0' != n->string[0]) { 422 pos = n->pos; 423 man->meta.date = mandoc_normdate 424 (man->parse, n->string, line, pos); 425 } else 426 man->meta.date = mandoc_strdup(""); 427 428 /* TITLE MSEC DATE ->SOURCE<- VOL */ 429 430 if (n && (n = n->next)) 431 man->meta.source = mandoc_strdup(n->string); 432 433 /* TITLE MSEC DATE SOURCE ->VOL<- */ 434 /* If missing, use the default VOL name for MSEC. */ 435 436 if (n && (n = n->next)) 437 man->meta.vol = mandoc_strdup(n->string); 438 else if ('\0' != man->meta.msec[0] && 439 (NULL != (p = mandoc_a2msec(man->meta.msec)))) 440 man->meta.vol = mandoc_strdup(p); 441 442 /* 443 * Remove the `TH' node after we've processed it for our 444 * meta-data. 445 */ 446 man_node_delete(man, man->last); 447 return(1); 448 } 449 450 static int 451 post_nf(CHKARGS) 452 { 453 454 if (MAN_LITERAL & man->flags) 455 man_nmsg(man, n, MANDOCERR_SCOPEREP); 456 457 man->flags |= MAN_LITERAL; 458 return(1); 459 } 460 461 static int 462 post_fi(CHKARGS) 463 { 464 465 if ( ! (MAN_LITERAL & man->flags)) 466 man_nmsg(man, n, MANDOCERR_WNOSCOPE); 467 468 man->flags &= ~MAN_LITERAL; 469 return(1); 470 } 471 472 static int 473 post_UC(CHKARGS) 474 { 475 static const char * const bsd_versions[] = { 476 "3rd Berkeley Distribution", 477 "4th Berkeley Distribution", 478 "4.2 Berkeley Distribution", 479 "4.3 Berkeley Distribution", 480 "4.4 Berkeley Distribution", 481 }; 482 483 const char *p, *s; 484 485 n = n->child; 486 487 if (NULL == n || MAN_TEXT != n->type) 488 p = bsd_versions[0]; 489 else { 490 s = n->string; 491 if (0 == strcmp(s, "3")) 492 p = bsd_versions[0]; 493 else if (0 == strcmp(s, "4")) 494 p = bsd_versions[1]; 495 else if (0 == strcmp(s, "5")) 496 p = bsd_versions[2]; 497 else if (0 == strcmp(s, "6")) 498 p = bsd_versions[3]; 499 else if (0 == strcmp(s, "7")) 500 p = bsd_versions[4]; 501 else 502 p = bsd_versions[0]; 503 } 504 505 free(man->meta.source); 506 man->meta.source = mandoc_strdup(p); 507 return(1); 508 } 509 510 static int 511 post_AT(CHKARGS) 512 { 513 static const char * const unix_versions[] = { 514 "7th Edition", 515 "System III", 516 "System V", 517 "System V Release 2", 518 }; 519 520 const char *p, *s; 521 struct man_node *nn; 522 523 n = n->child; 524 525 if (NULL == n || MAN_TEXT != n->type) 526 p = unix_versions[0]; 527 else { 528 s = n->string; 529 if (0 == strcmp(s, "3")) 530 p = unix_versions[0]; 531 else if (0 == strcmp(s, "4")) 532 p = unix_versions[1]; 533 else if (0 == strcmp(s, "5")) { 534 nn = n->next; 535 if (nn && MAN_TEXT == nn->type && nn->string[0]) 536 p = unix_versions[3]; 537 else 538 p = unix_versions[2]; 539 } else 540 p = unix_versions[0]; 541 } 542 543 free(man->meta.source); 544 man->meta.source = mandoc_strdup(p); 545 return(1); 546 } 547 548 static int 549 post_vs(CHKARGS) 550 { 551 552 if (NULL != n->prev) 553 return(1); 554 555 switch (n->parent->tok) { 556 case (MAN_SH): 557 /* FALLTHROUGH */ 558 case (MAN_SS): 559 man_nmsg(man, n, MANDOCERR_IGNPAR); 560 /* FALLTHROUGH */ 561 case (MAN_MAX): 562 /* 563 * Don't warn about this because it occurs in pod2man 564 * and would cause considerable (unfixable) warnage. 565 */ 566 man_node_delete(man, n); 567 break; 568 default: 569 break; 570 } 571 572 return(1); 573 } 574