// Copyright (c) Umbraco.
// See LICENSE for more details.
using System.Text;
using System.Xml;
using System.Xml.Linq;
using Umbraco.Cms.Core;
namespace Umbraco.Extensions;
///
/// Extension methods for xml objects
///
public static class XmlExtensions
{
public static bool HasAttribute(this XmlAttributeCollection attributes, string attributeName) =>
attributes.Cast().Any(x => x.Name == attributeName);
///
/// Converts from an XDocument to an XmlDocument
///
///
///
public static XmlDocument ToXmlDocument(this XDocument xDocument)
{
var xmlDocument = new XmlDocument();
using (XmlReader xmlReader = xDocument.CreateReader())
{
xmlDocument.Load(xmlReader);
}
return xmlDocument;
}
///
/// Converts from an XmlDocument to an XDocument
///
///
///
public static XDocument ToXDocument(this XmlDocument xmlDocument)
{
using (var nodeReader = new XmlNodeReader(xmlDocument))
{
nodeReader.MoveToContent();
return XDocument.Load(nodeReader);
}
}
/////
///// Converts from an XElement to an XmlElement
/////
/////
/////
public static XmlNode? ToXmlElement(this XContainer xElement)
{
var xmlDocument = new XmlDocument();
using (XmlReader xmlReader = xElement.CreateReader())
{
xmlDocument.Load(xmlReader);
}
return xmlDocument.DocumentElement;
}
///
/// Converts from an XmlElement to an XElement
///
///
///
public static XElement ToXElement(this XmlNode xmlElement)
{
using (var nodeReader = new XmlNodeReader(xmlElement))
{
nodeReader.MoveToContent();
return XElement.Load(nodeReader);
}
}
public static T? RequiredAttributeValue(this XElement xml, string attributeName)
{
if (xml == null)
{
throw new ArgumentNullException(nameof(xml));
}
if (xml.HasAttributes == false)
{
throw new InvalidOperationException($"{attributeName} not found in xml");
}
XAttribute? attribute = xml.Attribute(attributeName);
if (attribute is null)
{
throw new InvalidOperationException($"{attributeName} not found in xml");
}
Attempt result = attribute.Value.TryConvertTo();
if (result.Success)
{
return result.Result;
}
throw new InvalidOperationException($"{attribute.Value} attribute value cannot be converted to {typeof(T)}");
}
public static T? AttributeValue(this XElement xml, string attributeName)
{
if (xml == null)
{
throw new ArgumentNullException("xml");
}
XAttribute? xmlAttribute = xml.Attribute(attributeName);
if (xmlAttribute == null)
{
return default;
}
Attempt result = xmlAttribute.Value.TryConvertTo();
if (result.Success)
{
return result.Result;
}
return default;
}
public static T? AttributeValue(this XmlNode xml, string attributeName)
{
if (xml == null)
{
throw new ArgumentNullException("xml");
}
if (xml.Attributes == null)
{
return default;
}
XmlAttribute? xmlAttribute = xml.Attributes[attributeName];
if (xmlAttribute == null)
{
return default;
}
Attempt result = xmlAttribute.Value.TryConvertTo();
if (result.Success)
{
return result.Result;
}
return default;
}
public static XElement? GetXElement(this XmlNode node)
{
var xDoc = new XDocument();
using (XmlWriter xmlWriter = xDoc.CreateWriter())
{
node.WriteTo(xmlWriter);
}
return xDoc.Root;
}
public static XmlNode? GetXmlNode(this XContainer element)
{
using (XmlReader xmlReader = element.CreateReader())
{
var xmlDoc = new XmlDocument();
xmlDoc.Load(xmlReader);
return xmlDoc.DocumentElement;
}
}
public static XmlNode? GetXmlNode(this XContainer element, XmlDocument xmlDoc)
{
XmlNode? node = element.GetXmlNode();
if (node is not null)
{
return xmlDoc.ImportNode(node, true);
}
return null;
}
// this exists because
// new XElement("root", "a\nb").Value is "a\nb" but
// .ToString(SaveOptions.*) is "a\r\nb" and cannot figure out how to get rid of "\r"
// and when saving data we want nothing to change
// this method will produce a string that respects the \r and \n in the data value
public static string ToDataString(this XElement xml)
{
var settings = new XmlWriterSettings
{
OmitXmlDeclaration = true,
NewLineHandling = NewLineHandling.None,
Indent = false,
};
var output = new StringBuilder();
using (var writer = XmlWriter.Create(output, settings))
{
xml.WriteTo(writer);
}
return output.ToString();
}
}