[or-cvs] [tor/master 2/6] Allow comments for multi-line torrc options

[nickm at torproject.org]

Author: Sebastian Hahn <sebastian at torproject.org>
Date: Sat, 11 Sep 2010 01:25:48 +0200
Subject: Allow comments for multi-line torrc options
Commit: a05ef55b66684d3355b213f8df366c23d0128eca

---
 src/common/util.c     |   21 +++++++++++++++------
 src/or/circuitbuild.c |    3 ++-
 src/or/relay.c        |    1 +
 src/test/test_util.c  |   12 ++++++++++++
 4 files changed, 30 insertions(+), 7 deletions(-)

diff --git a/src/common/util.c b/src/common/util.c
index 6b9455d..e47ac78 100644
--- a/src/common/util.c
+++ b/src/common/util.c
@@ -2309,9 +2309,10 @@ parse_config_line_from_str(const char *line, char **key_out, char **value_out)
     return line;
   }
 
-  /* Skip until the next space. */
+  /* Skip until the next space or \ followed by newline. */
   key = line;
-  while (*line && !TOR_ISSPACE(*line) && *line != '#')
+  while (*line && !TOR_ISSPACE(*line) && *line != '#' &&
+         ! (line[0] == '\\' && line[1] == '\n'))
     ++line;
   *key_out = tor_strndup(key, line-key);
 
@@ -2322,7 +2323,7 @@ parse_config_line_from_str(const char *line, char **key_out, char **value_out)
   val = line;
 
   /* Find the end of the line. */
-  if (*line == '\"') {
+  if (*line == '\"') { // XXX No continuation here
     if (!(line = unescape_string(line, value_out, NULL)))
        return NULL;
     while (*line == ' ' || *line == '\t')
@@ -2330,10 +2331,14 @@ parse_config_line_from_str(const char *line, char **key_out, char **value_out)
     if (*line && *line != '#' && *line != '\n')
       return NULL;
   } else {
-    while (*line && *line != '\n' && *line != '#') {
+    while (*line && *line != '\n' && (*line != '#' || continuation)) {
       if (*line == '\\' && line[1] == '\n') {
         continuation = 1;
         ++line;
+      } else if (*line == '#') {
+        do {
+          ++line;
+        } while (*line && *line != '\n');
       }
       ++line;
     }
@@ -2352,7 +2357,12 @@ parse_config_line_from_str(const char *line, char **key_out, char **value_out)
       char *v_out, *v_in;
       v_out = v_in = *value_out;
       while (*v_in) {
-        if (v_in[0] == '\\' && v_in[1] == '\n') {
+        if (*v_in == '#') {
+          do {
+            ++v_in;
+          } while (*v_in && *v_in != '\n');
+          ++v_in;
+        } else if (v_in[0] == '\\' && v_in[1] == '\n') {
           v_in += 2;
         } else {
           *v_out++ = *v_in++;
@@ -2360,7 +2370,6 @@ parse_config_line_from_str(const char *line, char **key_out, char **value_out)
       }
       *v_out = '\0';
     }
-
   }
 
   if (*line == '#') {
diff --git a/src/or/circuitbuild.c b/src/or/circuitbuild.c
index 5567b24..ef1bab3 100644
--- a/src/or/circuitbuild.c
+++ b/src/or/circuitbuild.c
@@ -1752,7 +1752,8 @@ circuit_deliver_create_cell(circuit_t *circ, uint8_t cell_type,
   cell.circ_id = circ->n_circ_id;
 
   memcpy(cell.payload, payload, ONIONSKIN_CHALLENGE_LEN);
-  append_cell_to_circuit_queue(circ, circ->n_conn, &cell, CELL_DIRECTION_OUT, 0);
+  append_cell_to_circuit_queue(circ, circ->n_conn, &cell,
+                               CELL_DIRECTION_OUT, 0);
 
   if (CIRCUIT_IS_ORIGIN(circ)) {
     /* mark it so it gets better rate limiting treatment. */
diff --git a/src/or/relay.c b/src/or/relay.c
index 0d51ea4..0b0b706 100644
--- a/src/or/relay.c
+++ b/src/or/relay.c
@@ -2446,3 +2446,4 @@ circuit_queue_streams_are_blocked(circuit_t *circ)
     return circ->streams_blocked_on_p_conn;
   }
 }
+
diff --git a/src/test/test_util.c b/src/test/test_util.c
index 84bb5a6..49823fd 100644
--- a/src/test/test_util.c
+++ b/src/test/test_util.c
@@ -103,6 +103,8 @@ test_util_config_line(void)
           "k9 a line that\\\n spans two lines.\n\n"
           "k10 more than\\\n one contin\\\nuation\n"
           "k11  \\\ncontinuation at the start\n"
+          "k12 line with a\\\n#comment\n embedded\n"
+          "k13\\\ncontinuation at the very start\n"
           , sizeof(buf));
   str = buf;
 
@@ -180,6 +182,16 @@ test_util_config_line(void)
   test_streq(v, "continuation at the start");
   tor_free(k); tor_free(v);
 
+  str = parse_config_line_from_str(str, &k, &v);
+  test_streq(k, "k12");
+  test_streq(v, "line with a embedded");
+  tor_free(k); tor_free(v);
+
+  str = parse_config_line_from_str(str, &k, &v);
+  test_streq(k, "k13");
+  test_streq(v, "continuation at the very start");
+  tor_free(k); tor_free(v);
+
   test_streq(str, "");
 
  done:
-- 
1.7.1