Fixes #2449 Allow more permissive Xml serialization and deserialization (#2450)

Author: rwmcintosh

src/OSPSuite.Core/Serialization/Exchange/SimulationPersistor.cs

@@ -32,7 +32,8 @@ public void Save(SimulationTransfer simulationTransfer, string fileName)
          {
             var serializer = _xmlSerializerRepository.SerializerFor(simulationTransfer);
             var element = serializer.Serialize(simulationTransfer, serializationContext);
-            element.Save(fileName);
+
+            element.PermissiveSave(fileName);
          }
       }
 

src/OSPSuite.Core/Serialization/XElementExtensions.cs

@@ -15,5 +15,10 @@ public static int GetPKMLVersion(this XElement element)
 
          return versionString.ConvertedTo<int>();
       }
+
+      public static void PermissiveSave(this XElement element, string fileName)
+      {
+         XElementSerializer.PermissiveSave(element, fileName);
+      }
    }
 }

src/OSPSuite.Core/Serialization/XElementSerializer.cs

@@ -0,0 +1,40 @@
+using System.IO;
+using System.Xml;
+using System.Xml.Linq;
+
+namespace OSPSuite.Core.Serialization
+{
+   public static class XElementSerializer
+   {
+      /// <summary>
+      /// Saves XElement to <paramref name="fileName"/> allowing illegal characters to be escaped and saved
+      /// </summary>
+      public static void PermissiveSave(XElement element, string fileName)
+      {
+         using (var xmlWriter = XmlWriter.Create(fileName, new XmlWriterSettings
+                {
+                   CheckCharacters = false,
+                   Indent = true
+                }))
+         {
+            element.Save(xmlWriter);
+         }
+      }
+
+      public static XElement PermissiveLoad(Stream stream)
+      {
+         using (var xmlReader = XmlReader.Create(stream, new XmlReaderSettings { CheckCharacters = false }))
+         {
+            return XElement.Load(xmlReader);
+         }
+      }
+
+      public static XElement PermissiveLoad(string fileName)
+      {
+         using (var xmlReader = XmlReader.Create(fileName, new XmlReaderSettings { CheckCharacters = false }))
+         {
+            return XElement.Load(xmlReader);
+         }
+      }
+   }
+}

src/OSPSuite.Core/Serialization/Xml/AbstractPersistor.cs

@@ -27,7 +27,7 @@ public virtual void Save(T objectToSerialize, string fileName)
          {
             var serializer = _serializerRepository.SerializerFor(objectToSerialize);
             var xel = serializer.Serialize(objectToSerialize, serializationContext);
-            xel.Save(fileName);
+            xel.PermissiveSave(fileName);
          }
       }
 
@@ -36,7 +36,7 @@ public virtual void Load(T objectToLoad, string fileName)
          using (var serializationContext = SerializationTransaction.Create(_container))
          {
             var serializer = _serializerRepository.SerializerFor(objectToLoad);
-            var element = XElement.Load(fileName);
+            var element = XElementSerializer.PermissiveLoad(fileName);
             serializer.Deserialize(objectToLoad, element, serializationContext);
          }
       }

src/OSPSuite.Core/Serialization/Xml/DataPersistor.cs

@@ -43,15 +43,15 @@ public virtual void Save<T>(T obj, string fileName)
          using (var serializationContext = SerializationTransaction.Create(_container))
          {
             var xel = Serialize(obj, serializationContext);
-            xel.Save(fileName);
+            xel.PermissiveSave(fileName);
          }
       }
 
       public virtual T Load<T>(string fileName, IDimensionFactory dimensionFactory = null, IEnumerable<DataRepository> dataRepositories = null)
       {
          using (var serializationContext = SerializationTransaction.Create(_container, dimensionFactory, dataRepositories: dataRepositories))
          {
-            var xel = XElement.Load(fileName);
+            var xel = XElementSerializer.PermissiveLoad(fileName);
             return Deserialize<T>(xel, serializationContext);
          }
       }

src/OSPSuite.Core/Serialization/Xml/GroupRepositoryPersistor.cs

@@ -23,7 +23,7 @@ public override void Load(IGroupRepository groupRepository, string fileName)
          using (var serializationContext = SerializationTransaction.Create(_container, withIdRepository: new WithIdRepository()))
          {
             var serializer = _serializerRepository.SerializerFor(groupRepository);
-            var element = XElement.Load(fileName);
+            var element = XElementSerializer.PermissiveLoad(fileName);
             serializer.Deserialize(groupRepository, element, serializationContext);
          }
 

src/OSPSuite.Core/Serialization/Xml/PKMLPersistor.cs

@@ -62,7 +62,7 @@ public void SaveToPKML<T>(T entityToSerialize, string fileName)
          {
             var xElement = serializeModelPart(entityToSerialize, serializationContext);
             xElement.AddAttribute(Constants.Serialization.Attribute.VERSION, Constants.PKML_VERSION.ToString());
-            xElement.Save(fileName);
+            xElement.PermissiveSave(fileName);
          }
       }
 
@@ -81,7 +81,7 @@ public T Load<T>(string pkmlFileFullPath,
                    withIdRepository ?? new WithIdRepository(),
                    cloneManagerForModel ?? _cloneManagerForModel))
          {
-            var element = XElement.Load(pkmlFileFullPath);
+            var element = XElementSerializer.PermissiveLoad(pkmlFileFullPath);
             version = element.GetPKMLVersion();
 
             convertXml(element, version);

src/OSPSuite.Core/Serialization/Xml/PKParameterRepositoryLoader.cs

@@ -32,7 +32,7 @@ public void Load(IPKParameterRepository pkParameterMetaDataRepository, string fi
          using (var serializationContext = SerializationTransaction.Create(_container, _dimensionFactory))
          {
             var serializer = _modelingXmlSerializerRepository.SerializerFor(pkParameterMetaDataRepository);
-            var xel = XElement.Load(fileName);
+            var xel = XElementSerializer.PermissiveLoad(fileName);
             serializer.Deserialize(pkParameterMetaDataRepository, xel, serializationContext);
          }
       }

src/OSPSuite.Core/Services/ChartTemplatePersistor.cs

@@ -102,7 +102,7 @@ public CurveChartTemplate DeserializeFromFile(string fileFullPath)
       {
          try
          {
-            return Deserialize(XElement.Load(fileFullPath));
+            return Deserialize(XElementSerializer.PermissiveLoad(fileFullPath));
          }
          catch (XmlException)
          {
@@ -164,7 +164,7 @@ public void SerializeToFileBasedOn(CurveChart chart, string fileFullPath)
       private void saveTemplateToFile(XElement element, string fileFullPath)
       {
          element.AddAttribute(Constants.Serialization.Attribute.VERSION, PKMLVersion.CURRENT);
-         element.Save(fileFullPath);
+         element.PermissiveSave(fileFullPath);
       }
    }
 }

tests/OSPSuite.Core.IntegrationTests/SimulationPersistorSpecs.cs

@@ -1,11 +1,11 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Text;
 using OSPSuite.BDDHelper;
 using OSPSuite.BDDHelper.Extensions;
 using OSPSuite.Core.Domain;
 using OSPSuite.Core.Domain.Data;
-using OSPSuite.Core.Helpers;
 using OSPSuite.Core.Serialization.Exchange;
 using OSPSuite.Core.Serialization.Xml;
 using OSPSuite.Core.Serializers;
@@ -37,12 +37,30 @@ public override void Cleanup()
       }
    }
 
+   internal class When_serializing_and_deserializing_an_entity_with_illegal_xml_characters : concern_for_SimulationPersistor
+   {
+      [Observation]
+      public void should_return_a_simulation_transfer_containing_a_valid_simulation()
+      {
+         var x1 = new SimulationTransfer { Simulation = _simulation };
+         var illegalXmlString = Encoding.ASCII.GetString(Encoding.ASCII.GetBytes("F1").Concat(new byte[] { 0x1F }).ToArray());
+         x1.Favorites.Add(illegalXmlString);
+
+         _simulationPersistor.Save(x1, _filePath);
+         File.Exists(_filePath).ShouldBeTrue();
+         var deserializationObjectBaseRepository = IoC.Resolve<IWithIdRepository>();
+
+         var x2 = _simulationPersistor.Load(_filePath, deserializationObjectBaseRepository);
+         x2.Favorites.First().ShouldBeEqualTo(illegalXmlString);
+      }
+   }
+
    internal class When_deserializing_a_valid_simulation_file_containing_some_licenses : concern_for_SimulationPersistor
    {
       [Observation]
       public void should_return_a_simulation_transfer_containing_a_valid_simulation()
       {
-         var x1 = new SimulationTransfer {Simulation = _simulation};
+         var x1 = new SimulationTransfer { Simulation = _simulation };
          x1.Favorites.Add("F1");
          x1.Favorites.Add("F2");
          _simulationPersistor.Save(x1, _filePath);
@@ -90,12 +108,12 @@ protected override void Context()
             WeightedObservedData = new WeightedObservedData(_obsData),
             OutputSelection = new SimulationQuantitySelection(_simulation, new QuantitySelection("A|B|C", QuantityType.Complex))
          };
-         _outputMappings = new OutputMappings {_outputMapping};
+         _outputMappings = new OutputMappings { _outputMapping };
 
-         _simulationTransfer =   new SimulationTransfer
+         _simulationTransfer = new SimulationTransfer
          {
             Simulation = _simulation,
-            AllObservedData = new List<DataRepository>{ _obsData },
+            AllObservedData = new List<DataRepository> { _obsData },
             OutputMappings = _outputMappings
          };
       }