BUG/MEDIUM: cli: some err/warn msg dumps add LR into CSV output on stat's CLI
The initial purpose of CSV stats through CLI was to make it easely
parsable by scripts. But in some specific cases some error or warning
messages strings containing LF were dumped into cells of this CSV.
This made some parsing failure on several tools. In addition, if a
warning or message contains to successive LF, they will be dumped
directly but double LFs tag the end of the response on CLI and the
client may consider a truncated response.
This patch extends the 'csv_enc_append' and 'csv_enc' functions used
to format quoted string content according to RFC with an additionnal
parameter to convert multi-lines strings to one line: CRs are skipped,
and LFs are replaced with spaces. In addition and optionally, it is
also possible to remove resulting trailing spaces.
The call of this function to fill strings into stat's CSV output is
updated to force this conversion.
This patch should be backported on all supported branches (issue was
already present in v2.0)
(cherry picked from commit ef02dba7bcf4cf41aaf08fa5cabc8dd2d7537f63)
Signed-off-by: Willy Tarreau <w@1wt.eu>
(cherry picked from commit 5ed535046cdc83ecd4dedec4bda95f2fe268ebd9)
Signed-off-by: Willy Tarreau <w@1wt.eu>
diff --git a/src/tools.c b/src/tools.c
index fa56748..f211bac 100644
--- a/src/tools.c
+++ b/src/tools.c
@@ -2023,11 +2023,19 @@
* It is useful if the escaped string is used between double quotes in the
* format.
*
- * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
+ * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, 0, &trash));
*
* If <quote> is 1, the converter puts the quotes only if any reserved character
* is present. If <quote> is 2, the converter always puts the quotes.
*
+ * If <oneline> is not 0, CRs are skipped and LFs are replaced by spaces.
+ * This re-format multi-lines strings to only one line. The purpose is to
+ * allow a line by line parsing but also to keep the output compliant with
+ * the CLI witch uses LF to defines the end of the response.
+ *
+ * If <oneline> is 2, In addition to previous action, the trailing spaces are
+ * removed.
+ *
* <output> is a struct buffer used for storing the output string.
*
* The function returns the converted string on its output. If an error
@@ -2042,7 +2050,7 @@
* the chunk. Please use csv_enc() instead if you want to replace the output
* chunk.
*/
-const char *csv_enc_append(const char *str, int quote, struct buffer *output)
+const char *csv_enc_append(const char *str, int quote, int oneline, struct buffer *output)
{
char *end = output->area + output->size;
char *out = output->area + output->data;
@@ -2058,6 +2066,19 @@
*ptr++ = '"';
while (*str && ptr < end - 2) { /* -2 for reserving space for <"> and \0. */
+ if (oneline) {
+ if (*str == '\n' ) {
+ /* replace LF by a space */
+ *ptr++ = ' ';
+ str++;
+ continue;
+ }
+ else if (*str == '\r' ) {
+ /* skip CR */
+ str++;
+ continue;
+ }
+ }
*ptr = *str;
if (*str == '"') {
ptr++;
@@ -2071,6 +2092,12 @@
str++;
}
+ if (oneline == 2) {
+ /* remove trailing spaces */
+ while (ptr > out && *(ptr - 1) == ' ')
+ ptr--;
+ }
+
if (quote)
*ptr++ = '"';