Obróbka ciągów do wstawienia do XElement

Question

Zbieramy wiele ciągów i wysyłamy je do naszych klientów w fragmentach xml. Łańcuchy te mogą zawierać dosłownie dowolną postać. Pojawił się błąd spowodowany przez serializację wystąpień XElement, które zawierają "złe" znaki. Oto przykład:

var message = new XElement("song"); 
char c = (char)0x1a; //sub 
var someData = string.Format("some{0}stuff", c); 
var attr = new XAttribute("someAttr", someData); 
message.Add(attr); 
string msgStr = message.ToString(SaveOptions.DisableFormatting); //exception here 

Kod powyżej wytwarza wyjątek przy wskazanym linią. Oto StackTrace:

 
'SUB', hexadecimal value 0x1A, is an invalid character. System.ArgumentException System.ArgumentException: '', hexadecimal value 0x1A, is an invalid character. 
    at System.Xml.XmlEncodedRawTextWriter.InvalidXmlChar(Int32 ch, Char* pDst, Boolean entitize) 
    at System.Xml.XmlEncodedRawTextWriter.WriteAttributeTextBlock(Char* pSrc, Char* pSrcEnd) 
    at System.Xml.XmlEncodedRawTextWriter.WriteString(String text) 
    at System.Xml.XmlWellFormedWriter.WriteString(String text) 
    at System.Xml.XmlWriter.WriteAttributeString(String prefix, String localName, String ns, String value) 
    at System.Xml.Linq.ElementWriter.WriteStartElement(XElement e) 
    at System.Xml.Linq.ElementWriter.WriteElement(XElement e) 
    at System.Xml.Linq.XElement.WriteTo(XmlWriter writer) 
    at System.Xml.Linq.XNode.GetXmlString(SaveOptions o) 

Podejrzewam, że nie jest to poprawne zachowanie i złe char należy uciekł do XML. Czy jest to pożądane, czy nie, jest pytanie, na które odpowiem później.

Więc oto pytanie:

Czy jest jakiś sposób leczenia sznurki tak, że ten błąd może nie wystąpić, czy mam po prostu rozebrać wszystkie znaki poniżej char 0x20 i krzyż palcami?

Answer 1

To właśnie używam w moim kodu:

static Lazy<Regex> ControlChars = new Lazy<Regex>(() => new Regex("[\x00-\x1f]", RegexOptions.Compiled)); 

    private static string FixData_Replace(Match match) 
    { 
     if ((match.Value.Equals("\t")) || (match.Value.Equals("\n")) || (match.Value.Equals("\r"))) 
      return match.Value; 

     return "&#" + ((int)match.Value[0]).ToString("X4") + ";"; 
    } 

    public static string Fix(object data, MatchEvaluator replacer = null) 
    { 
     if (data == null) return null; 
     string fixed_data; 
     if (replacer != null) fixed_data = ControlChars.Value.Replace(data.ToString(), replacer); 
     else fixed_data = ControlChars.Value.Replace(data.ToString(), FixData_Replace); 
     return fixed_data; 
    } 

Wszystkie znaki mieszkowe 0x20 (z wyjątkiem \ r \ n \ t) są zastępowane przez ich kody Unicode XML: 0x1F => "& # 001f" . Analizator składni XML powinien automatycznie cofnąć go do 0x1f podczas odczytu pliku. Po prostu użyj nowego XAttribute ("atrybut", Fix (yourString))

Działa dla zawartości XElement a prawdopodobnie powinien również działać dla XAttributes.

Answer 2

Nieco kopania z ILSpy wykazały, że można użyć pola XmlWriter/ReaderSettings.CheckCharacters do kontroli, czy wyjątek jest rzucony dla nieprawidłowych znaków. Pożyczanie od sposobu XNode.ToString i sposobu XDocument.Parse, mam wymyślić poniższych przykładach:

Aby stringify obiekt XLinq z nieprawidłowych (kontrola) znaków:

XDocument xdoc = XDocument.Parse("<root>foo</root>"); 
using (StringWriter stringWriter = new StringWriter()) 
{ 
    XmlWriterSettings xmlWriterSettings = new XmlWriterSettings { OmitXmlDeclaration = true, CheckCharacters = false }; 
    using (XmlWriter xmlWriter = XmlWriter.Create(stringWriter, xmlWriterSettings)) 
    { 
     xdoc.WriteTo(xmlWriter); 
    } 

    return stringWriter.ToString(); 
} 

Do analizowania Obiekt XLinq z nieprawidłowymi znakami:

XDocument xdoc; 
using (StringReader stringReader = new StringReader(text)) 
{ 
    XmlReaderSettings xmlReaderSettings = new XmlReaderSettings { CheckCharacters = false, DtdProcessing = DtdProcessing.Parse, MaxCharactersFromEntities = 10000000L, XmlResolver = null }; 
    using (XmlReader xmlReader = XmlReader.Create(stringReader, xmlReaderSettings)) 
    { 
     xdoc = XDocument.Load(xmlReader); 
    } 
}