[LTP] [PATCH v2 1/1] docparse: Escape backslash, tab and double quote in JSON

[LTP] [PATCH v2 1/1] docparse: Escape backslash, tab and double quote in JSON

[Petr Vorel]

From: Cyril Hrubis <chrubis@suse.cz>

Avoid quoting new line as it's usually expected formatting,
e.g. in .options field.

Tested-by: Petr Vorel <pvorel@suse.cz>
Signed-off-by: Cyril Hrubis <chrubis@suse.cz>
[ pvorel: keep \n ]
Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
Hi,

I kept \n, it's usually expected formatting in .options:

* \n kept:
p: p_opt -p port Rhost port (mandatory)

r: r_opt -r x Rhost IP (mandatory)

-g, -r IP parameter can contain more IP, separated by CHR2STR ( IP_ADDR_DELIM )

* \n replaced:
p: p_opt -p port Rhost port (mandatory)

r: r_opt -r x Rhost IP (mandatory)\n\n-g, -r IP parameter can contain more IP, separated by CHR2STR ( IP_ADDR_DELIM )

Kind regards,
Petr

 docparse/data_storage.h | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/docparse/data_storage.h b/docparse/data_storage.h
index ef420c08f..5afeba42c 100644
--- a/docparse/data_storage.h
+++ b/docparse/data_storage.h
@@ -256,6 +256,39 @@ static inline void data_fprintf(FILE *f, unsigned int padd, const char *fmt, ...
 	va_end(va);
 }
 
+
+static inline void data_fprintf_esc(FILE *f, unsigned int padd, const char *str)
+{
+	while (padd-- > 0)
+		fputc(' ', f);
+
+	fputc('"', f);
+
+	while (*str) {
+		switch (*str) {
+		case '\\':
+			/* keep \n, it's usually expected formatting in .options */
+			if (*(str+1) == 'n')
+				putc(*str, f);
+			else
+				fputs("\\\\", f);
+			break;
+		case '"':
+			fputs("\\\"", f);
+			break;
+		case '\t':
+			fputs("\\t", f);
+			break;
+		default:
+			putc(*str, f);
+			break;
+		}
+		str++;
+	}
+
+	fputc('"', f);
+}
+
 static inline void data_to_json_(struct data_node *self, FILE *f, unsigned int padd, int do_padd)
 {
 	unsigned int i;
@@ -263,7 +296,7 @@ static inline void data_to_json_(struct data_node *self, FILE *f, unsigned int p
 	switch (self->type) {
 	case DATA_STRING:
 		padd = do_padd ? padd : 0;
-		data_fprintf(f, padd, "\"%s\"", self->string.val);
+		data_fprintf_esc(f, padd, self->string.val);
 	break;
 	case DATA_HASH:
 		for (i = 0; i < self->hash.elems_used; i++) {
-- 
2.31.1

[LTP] [PATCH v2 1/1] docparse: Escape backslash, tab and double quote in JSON

[Cyril Hrubis]

Hi!
> Avoid quoting new line as it's usually expected formatting,
> e.g. in .options field.

Hmm, looking at the cases that have \n in option strings it looks like a
messy hack rather than anything else...

I guess that a proper fix would be an ability to group the options, i.e.
make the .options an array of arrays so that the structures would look like:


	.options = (struct tst_option_group[]) {
		{.title = "Server", .options = (struct tst_option) {
			{"l", &foo, "Foo option help"},
			{}
		},
		...
		{}
	}


But that is something that is completely out of scope for this patch...

-- 
Cyril Hrubis
chrubis@suse.cz