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

[mandoc.git] / roff.c

diff --git a/roff.c b/roff.c
index 3363da158412a2e0381b0f6768163bf98022a374..dd2d926ce36d9919b98d81b041eeb4b5253e0d62 100644 (file)
--- a/roff.c
+++ b/roff.c
@@ -1,4 +1,4 @@
-/*     $Id: roff.c,v 1.96 2010/07/27 13:16:00 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>
 /*
  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>


@@ -45,6 +45,7 @@
 #endif
 
 enum   rofft {
 #endif
 
 enum   rofft {

+       ROFF_ad,

        ROFF_am,
        ROFF_ami,
        ROFF_am1,
        ROFF_am,
        ROFF_ami,
        ROFF_am1,


@@ -53,14 +54,18 @@ enum        rofft {
        ROFF_de1,
        ROFF_ds,
        ROFF_el,
        ROFF_de1,
        ROFF_ds,
        ROFF_el,

+       ROFF_hy,

        ROFF_ie,
        ROFF_if,
        ROFF_ig,
        ROFF_ie,
        ROFF_if,
        ROFF_ig,

+       ROFF_ne,
+       ROFF_nh,
+       ROFF_nr,

        ROFF_rm,
        ROFF_rm,

+       ROFF_so,

        ROFF_tr,
        ROFF_cblock,
        ROFF_tr,
        ROFF_cblock,

-       ROFF_ccond,
-       ROFF_nr,
+       ROFF_ccond, /* FIXME: remove this. */

        ROFF_MAX
 };
 
        ROFF_MAX
 };
 


@@ -130,12 +135,15 @@ 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 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_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() */
 
 
 /* See roff_hash_find() */
 


@@ -146,6 +154,7 @@ static      void             roff_setstr(struct roff *,
 static struct roffmac  *hash[HASHWIDTH];
 
 static struct roffmac   roffs[ROFF_MAX] = {
 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 },
        { "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 },


@@ -154,21 +163,25 @@ 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 },
        { "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 },
        { "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 },
        { ".", 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 *);
 static enum rofft       roff_hash_find(const char *);
 static void             roff_hash_init(void);
 static void             roffnode_cleanscope(struct roff *);
 };
 
 static void             roff_free1(struct roff *);
 static enum rofft       roff_hash_find(const char *);
 static void             roff_hash_init(void);
 static void             roffnode_cleanscope(struct roff *);

-static int              roffnode_push(struct roff *, 
+static void             roffnode_push(struct roff *, 

                                enum rofft, int, int);
 static void             roffnode_pop(struct roff *);
 static enum rofft       roff_parse(const char *, int *);
                                enum rofft, int, int);
 static void             roffnode_pop(struct roff *);
 static enum rofft       roff_parse(const char *, int *);


@@ -247,6 +260,7 @@ roffnode_pop(struct roff *r)
                if (r->rstackpos > -1)
                        r->rstackpos--;
 
                if (r->rstackpos > -1)
                        r->rstackpos--;
 

+       ROFF_DEBUG("roff: popping scope\n");

        r->last = r->last->parent;
        if (p->end)
                free(p->end);
        r->last = r->last->parent;
        if (p->end)
                free(p->end);


@@ -258,16 +272,12 @@ roffnode_pop(struct roff *r)
  * Push a roff node onto the instruction stack.  This must later be
  * removed with roffnode_pop().
  */
  * Push a roff node onto the instruction stack.  This must later be
  * removed with roffnode_pop().
  */

-static int
+static void

 roffnode_push(struct roff *r, enum rofft tok, int line, int col)
 {
        struct roffnode *p;
 
 roffnode_push(struct roff *r, enum rofft tok, int line, int col)
 {
        struct roffnode *p;
 

-       if (NULL == (p = calloc(1, sizeof(struct roffnode)))) {
-               (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL);
-               return(0);
-       }
-
+       p = mandoc_calloc(1, sizeof(struct roffnode));

        p->tok = tok;
        p->parent = r->last;
        p->line = line;
        p->tok = tok;
        p->parent = r->last;
        p->line = line;


@@ -275,7 +285,6 @@ roffnode_push(struct roff *r, enum rofft tok, int line, int col)
        p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY;
 
        r->last = p;
        p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY;
 
        r->last = p;

-       return(1);

 }
 
 
 }
 
 


@@ -307,15 +316,11 @@ roff_free(struct roff *r)
 
 
 struct roff *
 
 
 struct roff *

-roff_alloc(struct regset *regs, const mandocmsg msg, void *data)
+roff_alloc(struct regset *regs, void *data, const mandocmsg msg)

 {
        struct roff     *r;
 
 {
        struct roff     *r;
 

-       if (NULL == (r = calloc(1, sizeof(struct roff)))) {
-               (*msg)(MANDOCERR_MEM, data, 0, 0, NULL);
-               return(0);
-       }
-
+       r = mandoc_calloc(1, sizeof(struct roff));

        r->regs = regs;
        r->msg = msg;
        r->data = data;
        r->regs = regs;
        r->msg = msg;
        r->data = data;


@@ -434,8 +439,8 @@ roff_parseln(struct roff *r, int ln, char **bufp,
        if (r->last) {
                t = r->last->tok;
                assert(roffs[t].sub);
        if (r->last) {
                t = r->last->tok;
                assert(roffs[t].sub);

-               ROFF_DEBUG("roff: intercept scoped context: %s\n", 
-                               roffs[t].name);
+               ROFF_DEBUG("roff: intercept scoped context: %s, [%s]\n", 
+                               roffs[t].name, &(*bufp)[pos]);

                return((*roffs[t].sub)
                                (r, t, bufp, szp, 
                                 ln, pos, pos, offs));
                return((*roffs[t].sub)
                                (r, t, bufp, szp, 
                                 ln, pos, pos, offs));


@@ -650,8 +655,7 @@ roff_block(ROFF_ARGS)
                        pos++;
        }
 
                        pos++;
        }
 

-       if ( ! roffnode_push(r, tok, ln, ppos))
-               return(ROFF_ERR);
+       roffnode_push(r, tok, ln, ppos);

 
        if ('\0' == (*bufp)[pos])
                return(ROFF_IGN);
 
        if ('\0' == (*bufp)[pos])
                return(ROFF_IGN);


@@ -673,12 +677,7 @@ roff_block(ROFF_ARGS)
        if (1 == sz && '.' == (*bufp)[sv])
                return(ROFF_IGN);
 
        if (1 == sz && '.' == (*bufp)[sv])
                return(ROFF_IGN);
 

-       r->last->end = malloc(sz + 1);
-
-       if (NULL == r->last->end) {
-               (*r->msg)(MANDOCERR_MEM, r->data, ln, pos, NULL);
-               return(ROFF_ERR);
-       }
+       r->last->end = mandoc_malloc(sz + 1);

 
        memcpy(r->last->end, *bufp + sv, sz);
        r->last->end[(int)sz] = '\0';
 
        memcpy(r->last->end, *bufp + sv, sz);
        r->last->end[(int)sz] = '\0';


@@ -762,7 +761,6 @@ roff_cond_sub(ROFF_ARGS)
 {
        enum rofft       t;
        enum roffrule    rr;
 {
        enum rofft       t;
        enum roffrule    rr;

-       struct roffnode *l;

 
        ppos = pos;
        rr = r->last->rule;
 
        ppos = pos;
        rr = r->last->rule;


@@ -772,14 +770,15 @@ roff_cond_sub(ROFF_ARGS)
         * continue. 
         */
 
         * continue. 
         */
 

-       l = r->last;

        roffnode_cleanscope(r);
 
        roffnode_cleanscope(r);
 

-       if (l != r->last)
-               return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
-
-       if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
+       if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) {
+               if ('\\' == (*bufp)[pos] && '}' == (*bufp)[pos + 1])
+                       return(roff_ccond
+                               (r, ROFF_ccond, bufp, szp, 
+                                ln, pos, pos + 2, offs));

                return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
                return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);

+       }

 
        /*
         * A denied conditional must evaluate its children if and only
 
        /*
         * A denied conditional must evaluate its children if and only


@@ -811,6 +810,8 @@ roff_cond_text(ROFF_ARGS)
         * scope permits us to do so.
         */
 
         * scope permits us to do so.
         */
 

+       /* FIXME: use roff_ccond? */
+

        st = &(*bufp)[pos];
        if (NULL == (ep = strstr(st, "\\}"))) {
                roffnode_cleanscope(r);
        st = &(*bufp)[pos];
        if (NULL == (ep = strstr(st, "\\}"))) {
                roffnode_cleanscope(r);


@@ -849,15 +850,22 @@ roff_evalcond(const char *v, int *pos)
        return(ROFFRULE_DENY);
 }
 
        return(ROFFRULE_DENY);
 }
 

-

 /* ARGSUSED */
 static enum rofferr
 /* ARGSUSED */
 static enum rofferr

-roff_line(ROFF_ARGS)
+roff_line_ignore(ROFF_ARGS)

 {
 
        return(ROFF_IGN);
 }
 
 {
 
        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
 
 /* ARGSUSED */
 static enum rofferr


@@ -905,8 +913,7 @@ roff_cond(ROFF_ARGS)
                return(ROFF_ERR);
        }
 
                return(ROFF_ERR);
        }
 

-       if ( ! roffnode_push(r, tok, ln, ppos))
-               return(ROFF_ERR);
+       roffnode_push(r, tok, ln, ppos);

 
        r->last->rule = rule;
 
 
        r->last->rule = rule;
 


@@ -1050,6 +1057,51 @@ roff_nr(ROFF_ARGS)
        return(ROFF_IGN);
 }
 
        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)
+{
+       char            *namecopy, *sv;
+
+       /* 
+        * This isn't a nice simple mandoc_strdup() because we must
+        * handle roff's stupid double-escape rule. 
+        */
+       sv = namecopy = mandoc_malloc(strlen(name) + 1);
+       while (*name) {
+               if ('\\' == *name && '\\' == *(name + 1))
+                       name++;
+               *namecopy++ = *name++;
+       }
+
+       *namecopy = '\0';
+       return(sv);
+}
+

 
 static void
 roff_setstr(struct roff *r, const char *name, const char *string)
 
 static void
 roff_setstr(struct roff *r, const char *name, const char *string)


@@ -1070,8 +1122,9 @@ roff_setstr(struct roff *r, const char *name, const char *string)
        } else
                free(n->string);
 
        } else
                free(n->string);
 

-       ROFF_DEBUG("roff: new symbol: [%s] = [%s]\n", name, string);
-       n->string = string ? strdup(string) : NULL;
+       /* Don't use mandoc_strdup: clean out double-escapes. */
+       n->string = string ? roff_strdup(string) : NULL;
+       ROFF_DEBUG("roff: new symbol: [%s] = [%s]\n", name, n->string);

 }
 
 
 }
 
 


@@ -1081,7 +1134,7 @@ roff_getstrn(const struct roff *r, const char *name, size_t len)
        const struct roffstr *n;
 
        n = r->first_string;
        const struct roffstr *n;
 
        n = r->first_string;

-       while (n && (strncmp(name, n->name, len) || '\0' != n->name[len]))
+       while (n && (strncmp(name, n->name, len) || '\0' != n->name[(int)len]))

                n = n->next;
 
        return(n ? n->string : NULL);
                n = n->next;
 
        return(n ? n->string : NULL);