config.c: retain leading whitespace before comments

Configurations loaded with the ast_config_load2() API and later written
out with ast_config_text_file_save2() will have any leading whitespace
stripped away.  The APIs should make reasonable efforts to maintain the
content and formatting of the configuration files.

This change retains any leading whitespace from comment lines that start
with a ";".

Resolves: https://github.com/asterisk/asterisk/issues/970

diff --git a/main/config.c b/main/config.c
index 251c33be19bb5a8f3c96deb3105b94c4bcedd6c9..7f5503d11112222d051bbc5cff98fe06f81beb52 100644 (file)
--- a/main/config.c
+++ b/main/config.c
@@ -2483,6 +2483,18 @@ static struct ast_config *config_text_file_load(const char *database, const char
                                                                if (!comment) {
                                                                        /* If ; is found, and we are not nested in a comment,
                                                                           we immediately stop all comment processing */
+                                                                       while ((comment_p > new_buf) && isspace(*(comment_p - 1))) {
+                                                                               /* To preserve comment formatting we want to include any
+                                                                                  whitespace before the ";" */
+                                                                               comment_p--;
+                                                                       }
+                                                                       if ((comment_p != new_buf) && (*comment_p == ' ') && (*(comment_p + 1) == ' ')) {
+                                                                               /* If the comment (w/whitespace) does not start in column 1
+                                                                                  then, when written out, the preceeding variable/value will
+                                                                                  be separated from the comment by two spaces. To preserve
+                                                                                  comment formatting we should also take this into account. */
+                                                                               comment_p += 2;
+                                                                       }
                                                                        if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS)) {
                                                                                CB_ADD(&lline_buffer, comment_p);
                                                                        }