Removed unused functions, updated CHANGELOG, removed unused include i…

…n unit test
arangodb · mchacki · Sep 30, 2021 · Sep 18, 2021 · Sep 20, 2021 · Sep 20, 2021
commit 4cc1e64ff62b3d74b1975452ee48b74962d5ca39
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,6 +1,32 @@
 devel
 -----
 
+* feature/escape-unicode-control-chars: the server now has two flags for retaining or escaping control and unicode 
+characters in the log. The flag `log.escape` is deprecated and, instead, 
+the new flags `--log.escape-control-chars` and `log.escape-unicode-chars` 
+should be used. 
+
+- `--log.escape-control-chars`: this flag applies to the control characters, which have hex code below `\x20`, and also the character DEL, with hex code of `\x7f`. When its value is set to false, the control 
+character will be retained, and its actual value will be displayed when it 
+is a visible character, or a space ` ` character will be displayed if it is 
+not a visible character. The same will happen to `DEL` character (code `\xF7`), 
+even though it is not a control character, because it is not visible. For example, 
+control characer `\n` is visible, so a `\n` will be displayed in the log, and 
+control character `BEL` is not visible, so a space ` ` would be displayed.
+When its value is set to true, the hex code for the character is displayed, for 
+example, `BEL` character would be displayed as its hex code, `\x07`.
+	The default value for this flag is `true` for compatibility with 
+previous versions.
+
+- `--log.escape-unicode-chars`: when its value is set to false, the unicode character
+will be retained, and its actual value will be displayed. For example, `犬` will 
+be displayed as `犬`. When its value is set to true, the character is escaped, and 
+the hex code for the character is displayed. For example, `犬` would be displayed 
+as its hex code, `\u72AC`. 
+	The default value for this flag is set to `false` for compatibility with 
+previous versions.
+
+
 * APM-60: optionally allow special characters and Unicode characters in
   database names.
 

diff --git a/lib/Basics/tri-strings.cpp b/lib/Basics/tri-strings.cpp
@@ -303,68 +303,6 @@ char* TRI_SHA256String(char const* source, size_t sourceLen, size_t* dstLen) {
   return (char*)dst;
 }
 
-////////////////////////////////////////////////////////////////////////////////
-/// @brief escapes special characters using C escapes
-/// the target buffer must have been allocated already and big enough to hold
-/// the result of at most (4 * inLength) + 2 bytes!
-////////////////////////////////////////////////////////////////////////////////
-
-char* TRI_EscapeControlsCString(char const* in, size_t inLength, char* out,
-                                size_t* outLength, bool appendNewline) {
-  if (out == nullptr) {
-    return nullptr;
-  }
-
-  char* qtr = out;
-  char const* ptr;
-  char const* end;
-
-  for (ptr = in, end = ptr + inLength; ptr < end; ptr++, qtr++) {
-    uint8_t n;
-
-    switch (*ptr) {
-      case '\n':
-        *qtr++ = '\\';
-        *qtr = 'n';
-        break;
-
-      case '\r':
-        *qtr++ = '\\';
-        *qtr = 'r';
-        break;
-
-      case '\t':
-        *qtr++ = '\\';
-        *qtr = 't';
-        break;
-
-      default:
-        n = (uint8_t)(*ptr);
-
-        if (n < 32) {
-          uint8_t n1 = n >> 4;
-          uint8_t n2 = n & 0x0F;
-
-          *qtr++ = '\\';
-          *qtr++ = 'x';
-          *qtr++ = (n1 < 10) ? ('0' + n1) : ('A' + n1 - 10);
-          *qtr = (n2 < 10) ? ('0' + n2) : ('A' + n2 - 10);
-        } else {
-          *qtr = *ptr;
-        }
-
-        break;
-    }
-  }
-
-  if (appendNewline) {
-    *qtr++ = '\n';
-  }
-
-  *qtr = '\0';
-  *outLength = static_cast<size_t>(qtr - out);
-  return out;
-}
 
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief unescapes unicode escape sequences

diff --git a/lib/Basics/tri-strings.h b/lib/Basics/tri-strings.h
@@ -109,24 +109,6 @@ void TRI_FreeString(char*) noexcept;
 
 char* TRI_SHA256String(char const* source, size_t sourceLen, size_t* dstLen);
 
-////////////////////////////////////////////////////////////////////////////////
-/// @brief returns the maximum result length for an escaped string
-/// (4 * inLength) + 2 bytes!
-////////////////////////////////////////////////////////////////////////////////
-
-constexpr size_t TRI_MaxLengthEscapeControlsCString(size_t inLength) {
-  return (4 * inLength) + 2;  // for newline and 0 byte
-}
-
-////////////////////////////////////////////////////////////////////////////////
-/// @brief escapes special characters using C escapes
-/// the target buffer must have been allocated already and big enough to hold
-/// the result of at most (4 * inLength) + 2 bytes!
-////////////////////////////////////////////////////////////////////////////////
-
-char* TRI_EscapeControlsCString(char const* in, size_t inLength, char* out,
-                                size_t* outLength, bool appendNewline);
-
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief unescapes unicode escape sequences
 ///

diff --git a/tests/Logger/EscaperTest.cpp b/tests/Logger/EscaperTest.cpp
@@ -28,7 +28,6 @@
 
 #include "Logger/Escaper.h"
 
-#include "Logger/LogMacros.h"
 
 #include <string.h>
 #include <string>