Merge OpenBSD's `so' handling (plus some documentation). Great work to

[mandoc.git] / roff.c

diff --git a/roff.c b/roff.c
index 7467fe0e11c29305693c5fff6d51a86dbd363647..dd2d926ce36d9919b98d81b041eeb4b5253e0d62 100644 (file)
--- a/roff.c
+++ b/roff.c
@@ -1,4 +1,4 @@
-/*     $Id: roff.c,v 1.102 2010/09/04 20:18:53 kristaps Exp $ */
+/*     $Id: roff.c,v 1.105 2010/12/01 16:54:25 kristaps Exp $ */
 /*
  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
@@ -45,6 +45,7 @@
 #endif
 
 enum   rofft {
+       ROFF_ad,
        ROFF_am,
        ROFF_ami,
        ROFF_am1,
@@ -53,14 +54,18 @@ enum        rofft {
        ROFF_de1,
        ROFF_ds,
        ROFF_el,
+       ROFF_hy,
        ROFF_ie,
        ROFF_if,
        ROFF_ig,
+       ROFF_ne,
+       ROFF_nh,
+       ROFF_nr,
        ROFF_rm,
+       ROFF_so,
        ROFF_tr,
        ROFF_cblock,
        ROFF_ccond, /* FIXME: remove this. */
-       ROFF_nr,
        ROFF_MAX
 };
 
@@ -130,12 +135,14 @@ static    enum roffrule    roff_evalcond(const char *, int *);
 static void             roff_freestr(struct roff *);
 static const char      *roff_getstrn(const struct roff *, 
                                const char *, size_t);
-static enum rofferr     roff_line(ROFF_ARGS);
+static enum rofferr     roff_line_ignore(ROFF_ARGS);
+static enum rofferr     roff_line_error(ROFF_ARGS);
 static enum rofferr     roff_nr(ROFF_ARGS);
 static int              roff_res(struct roff *, 
                                char **, size_t *, int);
 static void             roff_setstr(struct roff *,
                                const char *, const char *);
+static enum rofferr     roff_so(ROFF_ARGS);
 static char            *roff_strdup(const char *);
 
 /* See roff_hash_find() */
@@ -147,6 +154,7 @@ static      char            *roff_strdup(const char *);
 static struct roffmac  *hash[HASHWIDTH];
 
 static struct roffmac   roffs[ROFF_MAX] = {
+       { "ad", roff_line_ignore, NULL, NULL, 0, NULL },
        { "am", roff_block, roff_block_text, roff_block_sub, 0, NULL },
        { "ami", roff_block, roff_block_text, roff_block_sub, 0, NULL },
        { "am1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
@@ -155,14 +163,18 @@ static    struct roffmac   roffs[ROFF_MAX] = {
        { "de1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
        { "ds", roff_ds, NULL, NULL, 0, NULL },
        { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
+       { "hy", roff_line_ignore, NULL, NULL, 0, NULL },
        { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
        { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
        { "ig", roff_block, roff_block_text, roff_block_sub, 0, NULL },
-       { "rm", roff_line, NULL, NULL, 0, NULL },
-       { "tr", roff_line, NULL, NULL, 0, NULL },
+       { "ne", roff_line_ignore, NULL, NULL, 0, NULL },
+       { "nh", roff_line_ignore, NULL, NULL, 0, NULL },
+       { "nr", roff_nr, NULL, NULL, 0, NULL },
+       { "rm", roff_line_error, NULL, NULL, 0, NULL },
+       { "so", roff_so, NULL, NULL, 0, NULL },
+       { "tr", roff_line_ignore, NULL, NULL, 0, NULL },
        { ".", roff_cblock, NULL, NULL, 0, NULL },
        { "\\}", roff_ccond, NULL, NULL, 0, NULL },
-       { "nr", roff_nr, NULL, NULL, 0, NULL },
 };
 
 static void             roff_free1(struct roff *);
@@ -838,15 +850,22 @@ roff_evalcond(const char *v, int *pos)
        return(ROFFRULE_DENY);
 }
 
-
 /* ARGSUSED */
 static enum rofferr
-roff_line(ROFF_ARGS)
+roff_line_ignore(ROFF_ARGS)
 {
 
        return(ROFF_IGN);
 }
 
+/* ARGSUSED */
+static enum rofferr
+roff_line_error(ROFF_ARGS)
+{
+
+       (*r->msg)(MANDOCERR_REQUEST, r->data, ln, ppos, roffs[tok].name);
+       return(ROFF_IGN);
+}
 
 /* ARGSUSED */
 static enum rofferr
@@ -1038,6 +1057,30 @@ roff_nr(ROFF_ARGS)
        return(ROFF_IGN);
 }
 
+/* ARGSUSED */
+static enum rofferr
+roff_so(ROFF_ARGS)
+{
+       char *name;
+
+       (*r->msg)(MANDOCERR_SO, r->data, ln, ppos, NULL);
+
+       /*
+        * Handle `so'.  Be EXTREMELY careful, as we shouldn't be
+        * opening anything that's not in our cwd or anything beneath
+        * it.  Thus, explicitly disallow traversing up the file-system
+        * or using absolute paths.
+        */
+
+       name = *bufp + pos;
+       if ('/' == *name || strstr(name, "../") || strstr(name, "/..")) {
+               (*r->msg)(MANDOCERR_SOPATH, r->data, ln, pos, NULL);
+               return(ROFF_ERR);
+       }
+
+       *offs = pos;
+       return(ROFF_SO);
+}
 
 static char *
 roff_strdup(const char *name)