add escape function

Author: wraymo

components/core/src/clp_s/indexer/IndexManager.cpp

@@ -53,6 +53,53 @@ void IndexManager::update_metadata(std::string const& archive_dir, std::string c
     }
 }
 
+std::string IndexManager::escape_key_name(std::string_view const key_name) {
+    std::string escaped_key_name;
+    escaped_key_name.reserve(key_name.size());
+    for (auto c : key_name) {
+        switch (c) {
+            case '\"':
+                escaped_key_name += "\\\"";
+                break;
+            case '\\':
+                escaped_key_name += "\\\\";
+                break;
+            case '\n':
+                escaped_key_name += "\\n";
+                break;
+            case '\t':
+                escaped_key_name += "\\t";
+                break;
+            case '\r':
+                escaped_key_name += "\\r";
+                break;
+            case '\b':
+                escaped_key_name += "\\b";
+                break;
+            case '\f':
+                escaped_key_name += "\\f";
+                break;
+            case '.':
+                escaped_key_name += "\\.";
+                break;
+            default:
+                if (std::isprint(c)) {
+                    escaped_key_name += c;
+                } else {
+                    char buffer[7];
+                    std::snprintf(
+                            buffer,
+                            sizeof(buffer),
+                            "\\u00%02x",
+                            static_cast<unsigned char>(c)
+                    );
+                    escaped_key_name += buffer;
+                }
+        }
+    }
+    return escaped_key_name;
+}
+
 std::vector<std::pair<std::string, clp_s::NodeType>> IndexManager::traverse_schema_tree(
         std::shared_ptr<SchemaTree> const& schema_tree
 ) {
@@ -73,18 +120,18 @@ std::vector<std::pair<std::string, clp_s::NodeType>> IndexManager::traverse_sche
         }
     }
 
-    while (!s.empty()) {
+    while (false == s.empty()) {
         auto [node_id, path_length] = s.top();
         s.pop();
 
-        auto& node = schema_tree->get_node(node_id);
+        auto const& node = schema_tree->get_node(node_id);
         auto& children_ids = node.get_children_ids();
         auto node_type = node.get_type();
         path_buffer.resize(path_length);
         if (false == path_buffer.empty()) {
             path_buffer += ".";
         }
-        path_buffer += node.get_key_name();
+        path_buffer += escape_key_name(node.get_key_name());
         if (children_ids.empty() && clp_s::NodeType::Object != node_type
             && clp_s::NodeType::Unknown != node_type)
         {

components/core/src/clp_s/indexer/IndexManager.hpp

@@ -1,5 +1,5 @@
-#ifndef CLP_S_INDEXER_TABLEMETADATAMANAGER_HPP
-#define CLP_S_INDEXER_TABLEMETADATAMANAGER_HPP
+#ifndef CLP_S_INDEXER_INDEXMANAGER_HPP
+#define CLP_S_INDEXER_INDEXMANAGER_HPP
 
 #include "../../clp/GlobalMetadataDBConfig.hpp"
 #include "../ArchiveReader.hpp"
@@ -47,6 +47,13 @@ class IndexManager {
     void update_metadata(std::string const& archive_dir, std::string const& archive_id);
 
 private:
+    /**
+     * Escapes a key name
+     * @param key_name
+     * @return the escaped key name
+     */
+    static std::string escape_key_name(std::string_view const key_name);
+
     /**
      * Traverses the schema tree and returns a list of path names and their types
      * @param schema_tree
@@ -60,4 +67,4 @@ class IndexManager {
     OutputType m_output_type{OutputType::Database};
 };
 }  // namespace clp_s::indexer
-#endif  // CLP_S_INDEXER_TABLEMETADATAMANAGER_HPP
+#endif  // CLP_S_INDEXER_INDEXMANAGER_HPP

components/core/src/clp_s/indexer/MySQLIndexStorage.hpp

@@ -1,5 +1,5 @@
-#ifndef CLP_S_INDEXER_MYSQLTABLEMETADATADB_HPP
-#define CLP_S_INDEXER_MYSQLTABLEMETADATADB_HPP
+#ifndef CLP_S_INDEXER_MYSQLINDEXSTORAGE_HPP
+#define CLP_S_INDEXER_MYSQLINDEXSTORAGE_HPP
 
 #include "../../clp/MySQLDB.hpp"
 #include "../../clp/MySQLPreparedStatement.hpp"
@@ -89,4 +89,4 @@ class MySQLIndexStorage {
 };
 }  // namespace clp_s::indexer
 
-#endif  // CLP_S_INDEXER_MYSQLTABLEMETADATADB_HPP
+#endif  // CLP_S_INDEXER_MYSQLINDEXSTORAGE_HPP

components/core/src/clp_s/indexer/indexer.cpp

@@ -41,4 +41,5 @@ int main(int argc, char const* argv[]) {
         SPDLOG_ERROR("Failed to update metadata: {}", e.what());
         return 1;
     }
+    return 0;
 }