From 07049b3d25cbc397dd39c71d32422bfd7c39d814 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Fri, 10 Sep 2010 09:19:10 -0400 Subject: Support mutli-line torrc options via the usual backslash syntax --- changes/torrc_continuation | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 changes/torrc_continuation (limited to 'changes') diff --git a/changes/torrc_continuation b/changes/torrc_continuation new file mode 100644 index 0000000000..f40e970c04 --- /dev/null +++ b/changes/torrc_continuation @@ -0,0 +1,5 @@ + o Minor features: + - Support line continuations in torrc. If a line ends with a + single backslash character, the newline is ignored, and the + configuration value is treated as continuing on the next line. + -- cgit v1.2.3-54-g00ecf From 1dab6cf4cbb35e27dd1d13f7deeb3e25f7dfcd5c Mon Sep 17 00:00:00 2001 From: Sebastian Hahn Date: Sat, 11 Sep 2010 01:41:33 +0200 Subject: Document multiline options in the manpage --- changes/torrc_continuation | 1 + doc/tor.1.txt | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) (limited to 'changes') diff --git a/changes/torrc_continuation b/changes/torrc_continuation index f40e970c04..f63937e42a 100644 --- a/changes/torrc_continuation +++ b/changes/torrc_continuation @@ -2,4 +2,5 @@ - Support line continuations in torrc. If a line ends with a single backslash character, the newline is ignored, and the configuration value is treated as continuing on the next line. + Implements bug 1929. diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 3b7e30bdfb..8c581c407c 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -65,7 +65,10 @@ Other options can be specified either on the command-line (--option value), or in the configuration file (option value or option "value"). Options are case-insensitive. C-style escaped characters are allowed inside quoted values. Options on the command line take precedence over - options found in the configuration file. + options found in the configuration file, except indicated otherwise. To + split one configuration entry into multiple lines, use a single \ before + the end of the line. Comments can be used in such multiline entries, but + they must start at the beginning of a line. **BandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**:: A token bucket limits the average incoming bandwidth usage on this node to -- cgit v1.2.3-54-g00ecf From 0a0cc4599fd743d124d6ee90671c7c8e205b86e8 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Thu, 23 Sep 2010 22:58:04 -0400 Subject: Tweak continuation-and-comment logic I think there was a read-off-the-end-of-the-buffer bug that I fixed. At least I added some good comments, I hope. --- changes/torrc_continuation | 2 +- src/common/util.c | 46 ++++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 43 insertions(+), 5 deletions(-) (limited to 'changes') diff --git a/changes/torrc_continuation b/changes/torrc_continuation index f63937e42a..5b6e086e6f 100644 --- a/changes/torrc_continuation +++ b/changes/torrc_continuation @@ -2,5 +2,5 @@ - Support line continuations in torrc. If a line ends with a single backslash character, the newline is ignored, and the configuration value is treated as continuing on the next line. - Implements bug 1929. + Resolves bug 1929. diff --git a/src/common/util.c b/src/common/util.c index e47ac78d35..904fd82239 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -2284,6 +2284,36 @@ unescape_string(const char *s, char **result, size_t *size_out) const char * parse_config_line_from_str(const char *line, char **key_out, char **value_out) { + /* I believe the file format here is supposed to be: + FILE = (EMPTYLINE | LINE)* + + EMPTYLINE = SPACE* NL | COMMENT NL + SPACE = ' ' | '\r' | '\t' + COMMENT = '#' NOT-NL* + NOT-NL = Any character except '\n' + NL = '\n' + + LINE = SPACE* KEY SPACE* VALUES NL + KEY = KEYCHAR+ + KEYCHAR = Any character except ' ', '\r', '\n', '\t', '#', "\" + + VALUES = QUOTEDVALUE | NORMALVALUE + QUOTEDVALUE = QUOTE QVITEM* QUOTE EOLSPACE? + QUOTE = '"' + QVCHAR = KEYCHAR | ESC ('n' | 't' | 'r' | '"' | ESC |'\'' | OCTAL | HEX) + ESC = "\\" + OCTAL = ODIGIT (ODIGIT ODIGIT?)? + HEX = ('x' | 'X') HEXDIGIT HEXDIGIT + ODIGIT = '0' .. '7' + HEXDIGIT = '0'..'9' | 'a' .. 'f' | 'A' .. 'F' + EOLSPACE = SPACE* COMMENT? + + NORMALVALUE = (VALCHAR | ESC ESC_IGNORE | CONTINUATION)* EOLSPACE? + VALCHAR = Any character except ESC, '#', and '\n' + ESC_IGNORE = Any character except '#' or '\n' + CONTINUATION = ESC NL ( COMMENT NL )* + */ + const char *key, *val, *cp; int continuation = 0; @@ -2323,7 +2353,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 == '\"') { // XXX No continuation here + if (*line == '\"') { // XXX No continuation handling is done here if (!(line = unescape_string(line, value_out, NULL))) return NULL; while (*line == ' ' || *line == '\t') @@ -2331,27 +2361,34 @@ parse_config_line_from_str(const char *line, char **key_out, char **value_out) if (*line && *line != '#' && *line != '\n') return NULL; } else { + /* Look for the end of the line. */ while (*line && *line != '\n' && (*line != '#' || continuation)) { if (*line == '\\' && line[1] == '\n') { continuation = 1; - ++line; + line += 2; } else if (*line == '#') { do { ++line; } while (*line && *line != '\n'); + if (*line == '\n') + ++line; + } else { + ++line; } - ++line; } + if (*line == '\n') { cp = line++; } else { cp = line; } + /* Now back cp up to be the last nonspace character */ while (cp>val && TOR_ISSPACE(*(cp-1))) --cp; tor_assert(cp >= val); + /* Now copy out and decode the value. */ *value_out = tor_strndup(val, cp-val); if (continuation) { char *v_out, *v_in; @@ -2361,7 +2398,8 @@ parse_config_line_from_str(const char *line, char **key_out, char **value_out) do { ++v_in; } while (*v_in && *v_in != '\n'); - ++v_in; + if (*v_in == '\n') + ++v_in; } else if (v_in[0] == '\\' && v_in[1] == '\n') { v_in += 2; } else { -- cgit v1.2.3-54-g00ecf