Merge af9e958 into 9906eb5

arangodb · Sep 6, 2022 · a12a682 · a12a682
2 parents 9906eb5 + af9e958
commit a12a682
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 16 deletions.
diff --git a/include/velocypack/Options.h b/include/velocypack/Options.h
@@ -113,9 +113,12 @@ struct Options {
   bool checkAttributeUniqueness = false;
 
   // escape forward slashes when serializing VPack values into
-  // JSON with a Dumper
+  // JSON with a Dumper (requires escapeControl = true)
   bool escapeForwardSlashes = false;
 
+  // with a Dumper (creates \uxxxx sequences or displays '\n', '\r' or \'t')
+  bool escapeControl = true;
+
   // escape multi-byte Unicode characters when dumping them to JSON
   // with a Dumper (creates \uxxxx sequences)
   bool escapeUnicode = false;

diff --git a/src/Dumper.cpp b/src/Dumper.cpp
@@ -308,21 +308,28 @@ void Dumper::dumpString(char const* src, ValueLength len) {
       char esc = EscapeTable[c];
 
       if (esc) {
-        if (c != '/' || options->escapeForwardSlashes) {
-          // escape forward slashes only when requested
-          _sink->push_back('\\');
-        }
-        _sink->push_back(static_cast<char>(esc));
-
-        if (esc == 'u') {
-          uint16_t i1 = (((uint16_t)c) & 0xf0U) >> 4;
-          uint16_t i2 = (((uint16_t)c) & 0x0fU);
-
-          _sink->append("00", 2);
-          _sink->push_back(
-              static_cast<char>((i1 < 10) ? ('0' + i1) : ('A' + i1 - 10)));
-          _sink->push_back(
-              static_cast<char>((i2 < 10) ? ('0' + i2) : ('A' + i2 - 10)));
+        if (options->escapeControl) {
+          if (c != '/' || options->escapeForwardSlashes) {
+            // escape forward slashes only when requested
+            _sink->push_back('\\');
+          }
+          _sink->push_back(static_cast<char>(esc));
+          if (esc == 'u') {
+            uint16_t i1 = (((uint16_t)c) & 0xf0U) >> 4;
+            uint16_t i2 = (((uint16_t)c) & 0x0fU);
+
+            _sink->append("00", 2);
+            _sink->push_back(
+                static_cast<char>((i1 < 10) ? ('0' + i1) : ('A' + i1 - 10)));
+            _sink->push_back(
+                static_cast<char>((i2 < 10) ? ('0' + i2) : ('A' + i2 - 10)));
+          }
+        } else {
+          if (esc == '"' || esc == '/' || esc == '\\') {
+            _sink->push_back(static_cast<char>(esc));
+          } else {
+            _sink->push_back(' ');
+          }
         }
       } else {
         _sink->push_back(static_cast<char>(c));

diff --git a/tests/testsDumper.cpp b/tests/testsDumper.cpp
@@ -476,6 +476,26 @@ TEST(StringDumperTest, StringControlChars) {
             Dumper::toString(slice));
 }
 
+TEST(StringDumperTest, SuppressControlChars) {
+  Builder b;
+  b.add(Value("Before\nAfter\r\t\v\x01\x02/"));
+
+  Options options;
+  options.escapeControl = false;
+  ASSERT_EQ(std::string("\"Before After     /\""),
+            Dumper::toString(b.slice(), &options));
+}
+
+TEST(StringDumperTest, EscapeControlChars) {
+  Builder b;
+  b.add(Value("Before\nAfter\r\t\v\x01\x02"));
+
+  Options options;
+  options.escapeControl = true;
+  ASSERT_EQ(std::string("\"Before\\nAfter\\r\\t\\u000B\\u0001\\u0002\""),
+            Dumper::toString(b.slice(), &options));
+}
+
 TEST(StringDumperTest, StringUTF8) {
   Builder b;
   b.add(Value("mötör"));