Add string sanitization to property description

include/openspace/properties/property.h

@@ -465,7 +465,7 @@ public:
      *
      * \return The metadata information text for the property
      */
-    virtual std::string generateMetaDataJsonDescription() const;
+    std::string generateMetaDataJsonDescription() const;
 
     /**
      * Creates the information that is specific to each subclass of Property%s. If a
@@ -530,6 +530,9 @@ private:
 #endif
 };
 
+/// This function sanitizes an incoming string for JSON control characters
+std::string sanitizeString(const std::string& str);
+
 } // namespace openspace::properties
 
 #endif // __OPENSPACE_CORE___PROPERTY___H__

modules/server/src/jsonconverters.cpp

@@ -33,10 +33,22 @@ using json = nlohmann::json;
 
 namespace openspace::properties {
 
+namespace {
+
+
+
+} // namespace 
+
 void to_json(json& j, const Property& p) {
+    std::string description = p.generateBaseJsonDescription();
+    json desc = json::parse(description);
+
+    std::string value = p.jsonValue();
+    json val = json::parse(value);
+
     j = {
-        { "Description", json::parse(p.generateBaseJsonDescription()) },
-        { "Value", json::parse(p.jsonValue()) }
+        { "Description", desc },
+        { "Value", val }
     };
     j["Description"]["description"] = p.description();
 }

src/properties/optionproperty.cpp

@@ -132,7 +132,12 @@ std::string OptionProperty::generateAdditionalJsonDescription() const {
         "{ \"" + OptionsKey + "\": [";
     for (size_t i = 0; i < _options.size(); ++i) {
         const Option& o = _options[i];
-        result += "{\"" + std::to_string(o.value) + "\": \"" + o.description + "\"}";
+        std::string v = std::to_string(o.value);
+        std::string vSan = sanitizeString(v);
+        std::string d = o.description;
+        std::string dSan = sanitizeString(d);
+
+        result += "{\"" + vSan + "\": \"" + dSan+ "\"}";
         if (i != _options.size() - 1) {
             result += ",";
         }

src/properties/property.cpp

@@ -38,6 +38,7 @@ namespace {
     constexpr const char* MetaDataKeyReadOnly = "isReadOnly";
 
     constexpr const char* _metaDataKeyViewPrefix = "view.";
+
 } // namespace
 
 namespace openspace::properties {
@@ -56,6 +57,43 @@ const char* Property::JsonValueKey = "Value";
 const char* Property::MetaDataKey = "MetaData";
 const char* Property::AdditionalDataKey = "AdditionalData";
 
+
+
+std::string sanitizeString(const std::string& s) {
+    std::string result;
+
+    for (const char& c : s) {
+        switch (c) {
+            case '"':
+                result += "\\\"";
+                break;
+            case '\\':
+                result += "\\\\";
+                break;
+            case '\b':
+                result += "\\b";
+                break;
+            case '\f':
+                result += "\\f";
+                break;
+            case '\n':
+                result += "\\n";
+                break;
+            case '\r':
+                result += "\\r";
+                break;
+            case '\t':
+                result += "\\t";
+                break;
+            default:
+                result += c;
+        }
+    }
+
+    return result;
+}
+
+
 #ifdef _DEBUG
 uint64_t Property::Identifier = 0;
 #endif
@@ -275,15 +313,21 @@ void Property::notifyDeleteListeners() {
 }
 
 std::string Property::generateBaseJsonDescription() const {
+    std::string cName = className();
+    std::string cNameSan = sanitizeString(cName);
+    std::string identifier = fullyQualifiedIdentifier();
+    std::string identifierSan = sanitizeString(identifier);
+    std::string gName = guiName();
+    std::string gNameSan = sanitizeString(gName);
+    std::string metaData = generateMetaDataJsonDescription();
+    std::string description = generateAdditionalJsonDescription();
+
     return
-        "{ \"" + std::string(TypeKey) + "\": \"" + className() + "\", " +
-        "\"" + std::string(IdentifierKey) + "\": \"" +
-            fullyQualifiedIdentifier() + "\", " +
-        "\"" + std::string(NameKey) + "\": \"" + guiName() + "\", " +
-        "\"" + std::string(MetaDataKey) + "\": " +
-            generateMetaDataJsonDescription() + ", " +
-        "\"" + std::string(AdditionalDataKey) + "\": " +
-            generateAdditionalJsonDescription() + " }";
+        "{ \"" + std::string(TypeKey) + "\": \"" + cNameSan + "\", " +
+        "\"" + std::string(IdentifierKey) + "\": \"" + identifierSan + "\", " +
+        "\"" + std::string(NameKey) + "\": \"" + gNameSan + "\", " +
+        "\"" + std::string(MetaDataKey) + "\": " + metaData + ", " +
+        "\"" + std::string(AdditionalDataKey) + "\": " + description + " }";
 }
 
 std::string Property::generateMetaDataJsonDescription() const {
@@ -302,9 +346,12 @@ std::string Property::generateMetaDataJsonDescription() const {
         isReadOnly = _metaData.value<bool>(MetaDataKeyReadOnly);
     }
 
+    std::string gIdent = groupIdentifier();
+    std::string gIdentSan = sanitizeString(gIdent);
+
     std::string result = "{ ";
     result +=
-        "\"" + std::string(MetaDataKeyGroup) + "\": \"" + groupIdentifier() + "\", ";
+        "\"" + std::string(MetaDataKeyGroup) + "\": \"" + gIdentSan + "\", ";
     result +=
         "\"" + std::string(MetaDataKeyVisibility) + "\": \"" + vis + "\", ";
     result +=

src/properties/selectionproperty.cpp

@@ -159,8 +159,13 @@ std::string SelectionProperty::generateAdditionalJsonDescription() const {
     std::string result = "{ \"" + OptionsKey + "\": [";
     for (size_t i = 0; i < _options.size(); ++i) {
         const Option& o = _options[i];
+        std::string v = std::to_string(o.value);
+        std::string vSan = sanitizeString(v);
+        std::string d = o.description;
+        std::string dSan = sanitizeString(d);
+
         result += "{";
-        result +=  "\"" + std::to_string(o.value) + "\": \"" + o.description + "\"";
+        result +=  "\"" + vSan + "\": \"" + dSan + "\"";
         result += "}";
         if (i != _options.size() - 1) {
             result += ",";