Moves a bunch of the xml/xpath classes/interfaces and remvoes unused code of XmlHelper
This commit is contained in:
Shannon
@@ -5,7 +5,7 @@ namespace Umbraco.Core.Xml.XPath
|
||||
/// <summary>
|
||||
/// Represents a content that can be navigated via XPath.
|
||||
/// </summary>
|
||||
interface INavigableContent
|
||||
public interface INavigableContent
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the unique identifier of the navigable content.
|
||||
@@ -8,7 +8,7 @@ namespace Umbraco.Core.Xml.XPath
|
||||
/// <summary>
|
||||
/// Represents the type of a content that can be navigated via XPath.
|
||||
/// </summary>
|
||||
interface INavigableContentType
|
||||
public interface INavigableContentType
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the name of the content type.
|
||||
@@ -9,7 +9,7 @@ namespace Umbraco.Core.Xml.XPath
|
||||
/// Represents the type of a field of a content that can be navigated via XPath.
|
||||
/// </summary>
|
||||
/// <remarks>A field can be an attribute or a property.</remarks>
|
||||
interface INavigableFieldType
|
||||
public interface INavigableFieldType
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the name of the field type.
|
||||
@@ -8,7 +8,7 @@ namespace Umbraco.Core.Xml.XPath
|
||||
/// <summary>
|
||||
/// Represents a source of content that can be navigated via XPath.
|
||||
/// </summary>
|
||||
interface INavigableSource
|
||||
public interface INavigableSource
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets a content identified by its unique identifier.
|
||||
@@ -10,7 +10,7 @@ namespace Umbraco.Core.Xml.XPath
|
||||
/// <summary>
|
||||
/// Provides a cursor model for navigating {macro /} as if it were XML.
|
||||
/// </summary>
|
||||
class MacroNavigator : XPathNavigator
|
||||
public class MacroNavigator : XPathNavigator
|
||||
{
|
||||
private readonly XmlNameTable _nameTable;
|
||||
private readonly MacroRoot _macro;
|
||||
@@ -55,7 +55,7 @@ namespace Umbraco.Core.Xml.XPath
|
||||
private int _tabs;
|
||||
private readonly int _uid = GetUid();
|
||||
private static int _uidg;
|
||||
private readonly static object Uidl = new object();
|
||||
private static readonly object Uidl = new object();
|
||||
private static int GetUid()
|
||||
{
|
||||
lock (Uidl)
|
||||
@@ -25,7 +25,7 @@ namespace Umbraco.Core.Xml.XPath
|
||||
/// <summary>
|
||||
/// Provides a cursor model for navigating Umbraco data as if it were XML.
|
||||
/// </summary>
|
||||
class NavigableNavigator : XPathNavigator
|
||||
public class NavigableNavigator : XPathNavigator
|
||||
{
|
||||
// "The XmlNameTable stores atomized strings of any local name, namespace URI,
|
||||
// and prefix used by the XPathNavigator. This means that when the same Name is
|
||||
@@ -1089,7 +1089,7 @@ namespace Umbraco.Core.Xml.XPath
|
||||
#region State management
|
||||
|
||||
// the possible state positions
|
||||
internal enum StatePosition
|
||||
public enum StatePosition
|
||||
{
|
||||
Root,
|
||||
Element,
|
||||
@@ -1101,10 +1101,10 @@ namespace Umbraco.Core.Xml.XPath
|
||||
|
||||
// gets the state
|
||||
// for unit tests only
|
||||
internal State InternalState => _state;
|
||||
public State InternalState => _state;
|
||||
|
||||
// represents the XPathNavigator state
|
||||
internal class State
|
||||
public class State
|
||||
{
|
||||
public StatePosition Position { get; set; }
|
||||
|
||||
221
src/Umbraco.Abstractions/Xml/XmlHelper.cs
Normal file
221
src/Umbraco.Abstractions/Xml/XmlHelper.cs
Normal file
@@ -0,0 +1,221 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Text.RegularExpressions;
|
||||
using System.Xml;
|
||||
using System.Xml.XPath;
|
||||
using Umbraco.Core.Exceptions;
|
||||
|
||||
namespace Umbraco.Core.Xml
|
||||
{
|
||||
/// <summary>
|
||||
/// The XmlHelper class contains general helper methods for working with xml in umbraco.
|
||||
/// </summary>
|
||||
public class XmlHelper
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether a specified string contains only xml whitespace characters.
|
||||
/// </summary>
|
||||
/// <param name="s">The string.</param>
|
||||
/// <returns><c>true</c> if the string contains only xml whitespace characters.</returns>
|
||||
/// <remarks>As per XML 1.1 specs, space, \t, \r and \n.</remarks>
|
||||
public static bool IsXmlWhitespace(string s)
|
||||
{
|
||||
// as per xml 1.1 specs - anything else is significant whitespace
|
||||
s = s.Trim(' ', '\t', '\r', '\n');
|
||||
return s.Length == 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a new <c>XPathDocument</c> from an xml string.
|
||||
/// </summary>
|
||||
/// <param name="xml">The xml string.</param>
|
||||
/// <returns>An <c>XPathDocument</c> created from the xml string.</returns>
|
||||
public static XPathDocument CreateXPathDocument(string xml)
|
||||
{
|
||||
return new XPathDocument(new XmlTextReader(new StringReader(xml)));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Tries to create a new <c>XPathDocument</c> from an xml string.
|
||||
/// </summary>
|
||||
/// <param name="xml">The xml string.</param>
|
||||
/// <param name="doc">The XPath document.</param>
|
||||
/// <returns>A value indicating whether it has been possible to create the document.</returns>
|
||||
public static bool TryCreateXPathDocument(string xml, out XPathDocument doc)
|
||||
{
|
||||
try
|
||||
{
|
||||
doc = CreateXPathDocument(xml);
|
||||
return true;
|
||||
}
|
||||
catch (Exception)
|
||||
{
|
||||
doc = null;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Tries to create a new <c>XPathDocument</c> from a property value.
|
||||
/// </summary>
|
||||
/// <param name="value">The value of the property.</param>
|
||||
/// <param name="doc">The XPath document.</param>
|
||||
/// <returns>A value indicating whether it has been possible to create the document.</returns>
|
||||
/// <remarks>The value can be anything... Performance-wise, this is bad.</remarks>
|
||||
public static bool TryCreateXPathDocumentFromPropertyValue(object value, out XPathDocument doc)
|
||||
{
|
||||
// DynamicNode.ConvertPropertyValueByDataType first cleans the value by calling
|
||||
// XmlHelper.StripDashesInElementOrAttributeName - this is because the XML is
|
||||
// to be returned as a DynamicXml and element names such as "value-item" are
|
||||
// invalid and must be converted to "valueitem". But we don't have that sort of
|
||||
// problem here - and we don't need to bother with dashes nor dots, etc.
|
||||
|
||||
doc = null;
|
||||
var xml = value as string;
|
||||
if (xml == null) return false; // no a string
|
||||
if (CouldItBeXml(xml) == false) return false; // string does not look like it's xml
|
||||
if (IsXmlWhitespace(xml)) return false; // string is whitespace, xml-wise
|
||||
if (TryCreateXPathDocument(xml, out doc) == false) return false; // string can't be parsed into xml
|
||||
|
||||
var nav = doc.CreateNavigator();
|
||||
if (nav.MoveToFirstChild())
|
||||
{
|
||||
//SD: This used to do this but the razor macros and the entire razor macros section is gone, it was all legacy, it seems this method isn't even
|
||||
// used apart from for tests so don't think this matters. In any case, we no longer check for this!
|
||||
|
||||
//var name = nav.LocalName; // must not match an excluded tag
|
||||
//if (UmbracoConfig.For.UmbracoSettings().Scripting.NotDynamicXmlDocumentElements.All(x => x.Element.InvariantEquals(name) == false)) return true;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
doc = null;
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Sorts the children of a parentNode.
|
||||
/// </summary>
|
||||
/// <param name="parentNode">The parent node.</param>
|
||||
/// <param name="childNodesXPath">An XPath expression to select children of <paramref name="parentNode"/> to sort.</param>
|
||||
/// <param name="orderBy">A function returning the value to order the nodes by.</param>
|
||||
public static void SortNodes(
|
||||
XmlNode parentNode,
|
||||
string childNodesXPath,
|
||||
Func<XmlNode, int> orderBy)
|
||||
{
|
||||
var sortedChildNodes = parentNode.SelectNodes(childNodesXPath).Cast<XmlNode>()
|
||||
.OrderBy(orderBy)
|
||||
.ToArray();
|
||||
|
||||
// append child nodes to last position, in sort-order
|
||||
// so all child nodes will go after the property nodes
|
||||
foreach (var node in sortedChildNodes)
|
||||
parentNode.AppendChild(node); // moves the node to the last position
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Sorts a single child node of a parentNode.
|
||||
/// </summary>
|
||||
/// <param name="parentNode">The parent node.</param>
|
||||
/// <param name="childNodesXPath">An XPath expression to select children of <paramref name="parentNode"/> to sort.</param>
|
||||
/// <param name="node">The child node to sort.</param>
|
||||
/// <param name="orderBy">A function returning the value to order the nodes by.</param>
|
||||
/// <returns>A value indicating whether sorting was needed.</returns>
|
||||
/// <remarks>Assuming all nodes but <paramref name="node"/> are sorted, this will move the node to
|
||||
/// the right position without moving all the nodes (as SortNodes would do) - should improve perfs.</remarks>
|
||||
public static bool SortNode(
|
||||
XmlNode parentNode,
|
||||
string childNodesXPath,
|
||||
XmlNode node,
|
||||
Func<XmlNode, int> orderBy)
|
||||
{
|
||||
var nodeSortOrder = orderBy(node);
|
||||
var childNodesAndOrder = parentNode.SelectNodes(childNodesXPath).Cast<XmlNode>()
|
||||
.Select(x => Tuple.Create(x, orderBy(x))).ToArray();
|
||||
|
||||
// only one node = node is in the right place already, obviously
|
||||
if (childNodesAndOrder.Length == 1) return false;
|
||||
|
||||
// find the first node with a sortOrder > node.sortOrder
|
||||
var i = 0;
|
||||
while (i < childNodesAndOrder.Length && childNodesAndOrder[i].Item2 <= nodeSortOrder)
|
||||
i++;
|
||||
|
||||
// if one was found
|
||||
if (i < childNodesAndOrder.Length)
|
||||
{
|
||||
// and node is just before, we're done already
|
||||
// else we need to move it right before the node that was found
|
||||
if (i == 0 || childNodesAndOrder[i - 1].Item1 != node)
|
||||
{
|
||||
parentNode.InsertBefore(node, childNodesAndOrder[i].Item1);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
else // i == childNodesAndOrder.Length && childNodesAndOrder.Length > 1
|
||||
{
|
||||
// and node is the last one, we're done already
|
||||
// else we need to append it as the last one
|
||||
// (and i > 1, see above)
|
||||
if (childNodesAndOrder[i - 1].Item1 != node)
|
||||
{
|
||||
parentNode.AppendChild(node);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Gets the value of a XmlNode
|
||||
/// </summary>
|
||||
/// <param name="n">The XmlNode.</param>
|
||||
/// <returns>the value as a string</returns>
|
||||
public static string GetNodeValue(XmlNode n)
|
||||
{
|
||||
var value = string.Empty;
|
||||
if (n == null || n.FirstChild == null)
|
||||
return value;
|
||||
value = n.FirstChild.Value ?? n.InnerXml;
|
||||
return value.Replace("<!--CDATAOPENTAG-->", "<![CDATA[").Replace("<!--CDATACLOSETAG-->", "]]>");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determines whether the specified string appears to be XML.
|
||||
/// </summary>
|
||||
/// <param name="xml">The XML string.</param>
|
||||
/// <returns>
|
||||
/// <c>true</c> if the specified string appears to be XML; otherwise, <c>false</c>.
|
||||
/// </returns>
|
||||
public static bool CouldItBeXml(string xml)
|
||||
{
|
||||
if (string.IsNullOrEmpty(xml)) return false;
|
||||
|
||||
xml = xml.Trim();
|
||||
return xml.StartsWith("<") && xml.EndsWith(">") && xml.Contains('/');
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Return a dictionary of attributes found for a string based tag
|
||||
/// </summary>
|
||||
/// <param name="tag"></param>
|
||||
/// <returns></returns>
|
||||
public static Dictionary<string, string> GetAttributesFromElement(string tag)
|
||||
{
|
||||
var m =
|
||||
Regex.Matches(tag, "(?<attributeName>\\S*)=\"(?<attributeValue>[^\"]*)\"",
|
||||
RegexOptions.IgnoreCase | RegexOptions.IgnorePatternWhitespace);
|
||||
// fix for issue 14862: return lowercase attributes for case insensitive matching
|
||||
var d = m.Cast<Match>().ToDictionary(attributeSet => attributeSet.Groups["attributeName"].Value.ToString().ToLower(), attributeSet => attributeSet.Groups["attributeValue"].Value.ToString());
|
||||
return d;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1169,18 +1169,9 @@
|
||||
<Compile Include="XmlExtensions.cs" />
|
||||
<Compile Include="Xml\DynamicContext.cs" />
|
||||
<Compile Include="Xml\UmbracoXPathPathSyntaxParser.cs" />
|
||||
<Compile Include="Xml\XmlHelper.cs" />
|
||||
<Compile Include="Xml\XmlNamespaces.cs" />
|
||||
<Compile Include="Xml\XmlNodeListFactory.cs" />
|
||||
<Compile Include="Xml\XPathNavigatorExtensions.cs" />
|
||||
<Compile Include="Xml\XPathVariable.cs" />
|
||||
<Compile Include="Xml\XPath\INavigableContent.cs" />
|
||||
<Compile Include="Xml\XPath\INavigableContentType.cs" />
|
||||
<Compile Include="Xml\XPath\INavigableFieldType.cs" />
|
||||
<Compile Include="Xml\XPath\INavigableSource.cs" />
|
||||
<Compile Include="Xml\XPath\MacroNavigator.cs" />
|
||||
<Compile Include="Xml\XPath\NavigableNavigator.cs" />
|
||||
<Compile Include="Xml\XPath\RenamedRootNavigator.cs" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<None Include="FileResources\BlockingWeb.config" />
|
||||
@@ -1194,5 +1185,6 @@
|
||||
<Name>Umbraco.Abstractions</Name>
|
||||
</ProjectReference>
|
||||
</ItemGroup>
|
||||
<ItemGroup />
|
||||
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
|
||||
</Project>
|
||||
@@ -1,430 +0,0 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Text.RegularExpressions;
|
||||
using System.Xml;
|
||||
using System.Xml.Linq;
|
||||
using System.Xml.XPath;
|
||||
using Umbraco.Core.Composing;
|
||||
using Umbraco.Core.Exceptions;
|
||||
using Umbraco.Core.IO;
|
||||
|
||||
namespace Umbraco.Core.Xml
|
||||
{
|
||||
/// <summary>
|
||||
/// The XmlHelper class contains general helper methods for working with xml in umbraco.
|
||||
/// </summary>
|
||||
public class XmlHelper
|
||||
{
|
||||
/// <summary>
|
||||
/// Creates or sets an attribute on the XmlNode if an Attributes collection is available
|
||||
/// </summary>
|
||||
/// <param name="xml"></param>
|
||||
/// <param name="n"></param>
|
||||
/// <param name="name"></param>
|
||||
/// <param name="value"></param>
|
||||
public static void SetAttribute(XmlDocument xml, XmlNode n, string name, string value)
|
||||
{
|
||||
if (xml == null) throw new ArgumentNullException("xml");
|
||||
if (n == null) throw new ArgumentNullException("n");
|
||||
if (string.IsNullOrWhiteSpace(name)) throw new ArgumentNullOrEmptyException(nameof(name));
|
||||
|
||||
if (n.Attributes == null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
if (n.Attributes[name] == null)
|
||||
{
|
||||
var a = xml.CreateAttribute(name);
|
||||
a.Value = value;
|
||||
n.Attributes.Append(a);
|
||||
}
|
||||
else
|
||||
{
|
||||
n.Attributes[name].Value = value;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether a specified string contains only xml whitespace characters.
|
||||
/// </summary>
|
||||
/// <param name="s">The string.</param>
|
||||
/// <returns><c>true</c> if the string contains only xml whitespace characters.</returns>
|
||||
/// <remarks>As per XML 1.1 specs, space, \t, \r and \n.</remarks>
|
||||
public static bool IsXmlWhitespace(string s)
|
||||
{
|
||||
// as per xml 1.1 specs - anything else is significant whitespace
|
||||
s = s.Trim(' ', '\t', '\r', '\n');
|
||||
return s.Length == 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a new <c>XPathDocument</c> from an xml string.
|
||||
/// </summary>
|
||||
/// <param name="xml">The xml string.</param>
|
||||
/// <returns>An <c>XPathDocument</c> created from the xml string.</returns>
|
||||
public static XPathDocument CreateXPathDocument(string xml)
|
||||
{
|
||||
return new XPathDocument(new XmlTextReader(new StringReader(xml)));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Tries to create a new <c>XPathDocument</c> from an xml string.
|
||||
/// </summary>
|
||||
/// <param name="xml">The xml string.</param>
|
||||
/// <param name="doc">The XPath document.</param>
|
||||
/// <returns>A value indicating whether it has been possible to create the document.</returns>
|
||||
public static bool TryCreateXPathDocument(string xml, out XPathDocument doc)
|
||||
{
|
||||
try
|
||||
{
|
||||
doc = CreateXPathDocument(xml);
|
||||
return true;
|
||||
}
|
||||
catch (Exception)
|
||||
{
|
||||
doc = null;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Tries to create a new <c>XPathDocument</c> from a property value.
|
||||
/// </summary>
|
||||
/// <param name="value">The value of the property.</param>
|
||||
/// <param name="doc">The XPath document.</param>
|
||||
/// <returns>A value indicating whether it has been possible to create the document.</returns>
|
||||
/// <remarks>The value can be anything... Performance-wise, this is bad.</remarks>
|
||||
public static bool TryCreateXPathDocumentFromPropertyValue(object value, out XPathDocument doc)
|
||||
{
|
||||
// DynamicNode.ConvertPropertyValueByDataType first cleans the value by calling
|
||||
// XmlHelper.StripDashesInElementOrAttributeName - this is because the XML is
|
||||
// to be returned as a DynamicXml and element names such as "value-item" are
|
||||
// invalid and must be converted to "valueitem". But we don't have that sort of
|
||||
// problem here - and we don't need to bother with dashes nor dots, etc.
|
||||
|
||||
doc = null;
|
||||
var xml = value as string;
|
||||
if (xml == null) return false; // no a string
|
||||
if (CouldItBeXml(xml) == false) return false; // string does not look like it's xml
|
||||
if (IsXmlWhitespace(xml)) return false; // string is whitespace, xml-wise
|
||||
if (TryCreateXPathDocument(xml, out doc) == false) return false; // string can't be parsed into xml
|
||||
|
||||
var nav = doc.CreateNavigator();
|
||||
if (nav.MoveToFirstChild())
|
||||
{
|
||||
//SD: This used to do this but the razor macros and the entire razor macros section is gone, it was all legacy, it seems this method isn't even
|
||||
// used apart from for tests so don't think this matters. In any case, we no longer check for this!
|
||||
|
||||
//var name = nav.LocalName; // must not match an excluded tag
|
||||
//if (UmbracoConfig.For.UmbracoSettings().Scripting.NotDynamicXmlDocumentElements.All(x => x.Element.InvariantEquals(name) == false)) return true;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
doc = null;
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Sorts the children of a parentNode.
|
||||
/// </summary>
|
||||
/// <param name="parentNode">The parent node.</param>
|
||||
/// <param name="childNodesXPath">An XPath expression to select children of <paramref name="parentNode"/> to sort.</param>
|
||||
/// <param name="orderBy">A function returning the value to order the nodes by.</param>
|
||||
internal static void SortNodes(
|
||||
XmlNode parentNode,
|
||||
string childNodesXPath,
|
||||
Func<XmlNode, int> orderBy)
|
||||
{
|
||||
var sortedChildNodes = parentNode.SelectNodes(childNodesXPath).Cast<XmlNode>()
|
||||
.OrderBy(orderBy)
|
||||
.ToArray();
|
||||
|
||||
// append child nodes to last position, in sort-order
|
||||
// so all child nodes will go after the property nodes
|
||||
foreach (var node in sortedChildNodes)
|
||||
parentNode.AppendChild(node); // moves the node to the last position
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Sorts a single child node of a parentNode.
|
||||
/// </summary>
|
||||
/// <param name="parentNode">The parent node.</param>
|
||||
/// <param name="childNodesXPath">An XPath expression to select children of <paramref name="parentNode"/> to sort.</param>
|
||||
/// <param name="node">The child node to sort.</param>
|
||||
/// <param name="orderBy">A function returning the value to order the nodes by.</param>
|
||||
/// <returns>A value indicating whether sorting was needed.</returns>
|
||||
/// <remarks>Assuming all nodes but <paramref name="node"/> are sorted, this will move the node to
|
||||
/// the right position without moving all the nodes (as SortNodes would do) - should improve perfs.</remarks>
|
||||
internal static bool SortNode(
|
||||
XmlNode parentNode,
|
||||
string childNodesXPath,
|
||||
XmlNode node,
|
||||
Func<XmlNode, int> orderBy)
|
||||
{
|
||||
var nodeSortOrder = orderBy(node);
|
||||
var childNodesAndOrder = parentNode.SelectNodes(childNodesXPath).Cast<XmlNode>()
|
||||
.Select(x => Tuple.Create(x, orderBy(x))).ToArray();
|
||||
|
||||
// only one node = node is in the right place already, obviously
|
||||
if (childNodesAndOrder.Length == 1) return false;
|
||||
|
||||
// find the first node with a sortOrder > node.sortOrder
|
||||
var i = 0;
|
||||
while (i < childNodesAndOrder.Length && childNodesAndOrder[i].Item2 <= nodeSortOrder)
|
||||
i++;
|
||||
|
||||
// if one was found
|
||||
if (i < childNodesAndOrder.Length)
|
||||
{
|
||||
// and node is just before, we're done already
|
||||
// else we need to move it right before the node that was found
|
||||
if (i == 0 || childNodesAndOrder[i - 1].Item1 != node)
|
||||
{
|
||||
parentNode.InsertBefore(node, childNodesAndOrder[i].Item1);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
else // i == childNodesAndOrder.Length && childNodesAndOrder.Length > 1
|
||||
{
|
||||
// and node is the last one, we're done already
|
||||
// else we need to append it as the last one
|
||||
// (and i > 1, see above)
|
||||
if (childNodesAndOrder[i - 1].Item1 != node)
|
||||
{
|
||||
parentNode.AppendChild(node);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Opens a file as a XmlDocument.
|
||||
/// </summary>
|
||||
/// <param name="filePath">The relative file path. ie. /config/umbraco.config</param>
|
||||
/// <returns>Returns a XmlDocument class</returns>
|
||||
public static XmlDocument OpenAsXmlDocument(string filePath)
|
||||
{
|
||||
using (var reader = new XmlTextReader(Current.IOHelper.MapPath(filePath)) {WhitespaceHandling = WhitespaceHandling.All})
|
||||
{
|
||||
var xmlDoc = new XmlDocument();
|
||||
//Load the file into the XmlDocument
|
||||
xmlDoc.Load(reader);
|
||||
|
||||
return xmlDoc;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// creates a XmlAttribute with the specified name and value
|
||||
/// </summary>
|
||||
/// <param name="xd">The xmldocument.</param>
|
||||
/// <param name="name">The name of the attribute.</param>
|
||||
/// <param name="value">The value of the attribute.</param>
|
||||
/// <returns>a XmlAttribute</returns>
|
||||
public static XmlAttribute AddAttribute(XmlDocument xd, string name, string value)
|
||||
{
|
||||
if (xd == null) throw new ArgumentNullException("xd");
|
||||
if (string.IsNullOrEmpty(name)) throw new ArgumentNullOrEmptyException(nameof(name));
|
||||
|
||||
var temp = xd.CreateAttribute(name);
|
||||
temp.Value = value;
|
||||
return temp;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a text XmlNode with the specified name and value
|
||||
/// </summary>
|
||||
/// <param name="xd">The xmldocument.</param>
|
||||
/// <param name="name">The node name.</param>
|
||||
/// <param name="value">The node value.</param>
|
||||
/// <returns>a XmlNode</returns>
|
||||
public static XmlNode AddTextNode(XmlDocument xd, string name, string value)
|
||||
{
|
||||
if (xd == null) throw new ArgumentNullException("xd");
|
||||
if (string.IsNullOrWhiteSpace(name)) throw new ArgumentNullOrEmptyException(nameof(name));
|
||||
|
||||
var temp = xd.CreateNode(XmlNodeType.Element, name, "");
|
||||
temp.AppendChild(xd.CreateTextNode(value));
|
||||
return temp;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets or Creates a text XmlNode with the specified name and value
|
||||
/// </summary>
|
||||
/// <param name="xd">The xmldocument.</param>
|
||||
/// <param name="parent">The node to set or create the child text node on</param>
|
||||
/// <param name="name">The node name.</param>
|
||||
/// <param name="value">The node value.</param>
|
||||
/// <returns>a XmlNode</returns>
|
||||
public static XmlNode SetTextNode(XmlDocument xd, XmlNode parent, string name, string value)
|
||||
{
|
||||
if (xd == null) throw new ArgumentNullException("xd");
|
||||
if (parent == null) throw new ArgumentNullException("parent");
|
||||
if (string.IsNullOrWhiteSpace(name)) throw new ArgumentNullOrEmptyException(nameof(name));
|
||||
|
||||
var child = parent.SelectSingleNode(name);
|
||||
if (child != null)
|
||||
{
|
||||
child.InnerText = value;
|
||||
return child;
|
||||
}
|
||||
return AddTextNode(xd, name, value);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets or creates an Xml node from its inner Xml.
|
||||
/// </summary>
|
||||
/// <param name="xd">The xmldocument.</param>
|
||||
/// <param name="parent">The node to set or create the child text node on</param>
|
||||
/// <param name="name">The node name.</param>
|
||||
/// <param name="value">The node inner Xml.</param>
|
||||
/// <returns>a XmlNode</returns>
|
||||
public static XmlNode SetInnerXmlNode(XmlDocument xd, XmlNode parent, string name, string value)
|
||||
{
|
||||
if (xd == null) throw new ArgumentNullException(nameof(xd));
|
||||
if (parent == null) throw new ArgumentNullException(nameof(parent));
|
||||
if (string.IsNullOrWhiteSpace(name)) throw new ArgumentException("Value cannot be null or whitespace.", nameof(name));
|
||||
|
||||
var child = parent.SelectSingleNode(name) ?? xd.CreateNode(XmlNodeType.Element, name, "");
|
||||
child.InnerXml = value;
|
||||
return child;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a cdata XmlNode with the specified name and value
|
||||
/// </summary>
|
||||
/// <param name="xd">The xmldocument.</param>
|
||||
/// <param name="name">The node name.</param>
|
||||
/// <param name="value">The node value.</param>
|
||||
/// <returns>A XmlNode</returns>
|
||||
public static XmlNode AddCDataNode(XmlDocument xd, string name, string value)
|
||||
{
|
||||
if (xd == null) throw new ArgumentNullException("xd");
|
||||
if (string.IsNullOrWhiteSpace(name)) throw new ArgumentNullOrEmptyException(nameof(name));
|
||||
|
||||
var temp = xd.CreateNode(XmlNodeType.Element, name, "");
|
||||
temp.AppendChild(xd.CreateCDataSection(value));
|
||||
return temp;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets or Creates a cdata XmlNode with the specified name and value
|
||||
/// </summary>
|
||||
/// <param name="xd">The xmldocument.</param>
|
||||
/// <param name="parent">The node to set or create the child text node on</param>
|
||||
/// <param name="name">The node name.</param>
|
||||
/// <param name="value">The node value.</param>
|
||||
/// <returns>a XmlNode</returns>
|
||||
public static XmlNode SetCDataNode(XmlDocument xd, XmlNode parent, string name, string value)
|
||||
{
|
||||
if (xd == null) throw new ArgumentNullException("xd");
|
||||
if (parent == null) throw new ArgumentNullException("parent");
|
||||
if (string.IsNullOrWhiteSpace(name)) throw new ArgumentNullOrEmptyException(nameof(name));
|
||||
|
||||
var child = parent.SelectSingleNode(name);
|
||||
if (child != null)
|
||||
{
|
||||
child.InnerXml = "<![CDATA[" + value + "]]>"; ;
|
||||
return child;
|
||||
}
|
||||
return AddCDataNode(xd, name, value);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the value of a XmlNode
|
||||
/// </summary>
|
||||
/// <param name="n">The XmlNode.</param>
|
||||
/// <returns>the value as a string</returns>
|
||||
internal static string GetNodeValue(XmlNode n)
|
||||
{
|
||||
var value = string.Empty;
|
||||
if (n == null || n.FirstChild == null)
|
||||
return value;
|
||||
value = n.FirstChild.Value ?? n.InnerXml;
|
||||
return value.Replace("<!--CDATAOPENTAG-->", "<![CDATA[").Replace("<!--CDATACLOSETAG-->", "]]>");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determines whether the specified string appears to be XML.
|
||||
/// </summary>
|
||||
/// <param name="xml">The XML string.</param>
|
||||
/// <returns>
|
||||
/// <c>true</c> if the specified string appears to be XML; otherwise, <c>false</c>.
|
||||
/// </returns>
|
||||
public static bool CouldItBeXml(string xml)
|
||||
{
|
||||
if (string.IsNullOrEmpty(xml)) return false;
|
||||
|
||||
xml = xml.Trim();
|
||||
return xml.StartsWith("<") && xml.EndsWith(">") && xml.Contains('/');
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Splits the specified delimited string into an XML document.
|
||||
/// </summary>
|
||||
/// <param name="data">The data.</param>
|
||||
/// <param name="separator">The separator.</param>
|
||||
/// <param name="rootName">Name of the root.</param>
|
||||
/// <param name="elementName">Name of the element.</param>
|
||||
/// <returns>Returns an <c>System.Xml.XmlDocument</c> representation of the delimited string data.</returns>
|
||||
internal static XmlDocument Split(string data, string[] separator, string rootName, string elementName)
|
||||
{
|
||||
return Split(new XmlDocument(), data, separator, rootName, elementName);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Splits the specified delimited string into an XML document.
|
||||
/// </summary>
|
||||
/// <param name="xml">The XML document.</param>
|
||||
/// <param name="data">The delimited string data.</param>
|
||||
/// <param name="separator">The separator.</param>
|
||||
/// <param name="rootName">Name of the root node.</param>
|
||||
/// <param name="elementName">Name of the element node.</param>
|
||||
/// <returns>Returns an <c>System.Xml.XmlDocument</c> representation of the delimited string data.</returns>
|
||||
internal static XmlDocument Split(XmlDocument xml, string data, string[] separator, string rootName, string elementName)
|
||||
{
|
||||
// load new XML document.
|
||||
xml.LoadXml(string.Concat("<", rootName, "/>"));
|
||||
|
||||
// get the data-value, check it isn't empty.
|
||||
if (!string.IsNullOrEmpty(data))
|
||||
{
|
||||
// explode the values into an array
|
||||
var values = data.Split(separator, StringSplitOptions.None);
|
||||
|
||||
// loop through the array items.
|
||||
foreach (string value in values)
|
||||
{
|
||||
// add each value to the XML document.
|
||||
var xn = XmlHelper.AddTextNode(xml, elementName, value);
|
||||
xml.DocumentElement.AppendChild(xn);
|
||||
}
|
||||
}
|
||||
|
||||
// return the XML node.
|
||||
return xml;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Return a dictionary of attributes found for a string based tag
|
||||
/// </summary>
|
||||
/// <param name="tag"></param>
|
||||
/// <returns></returns>
|
||||
internal static Dictionary<string, string> GetAttributesFromElement(string tag)
|
||||
{
|
||||
var m =
|
||||
Regex.Matches(tag, "(?<attributeName>\\S*)=\"(?<attributeValue>[^\"]*)\"",
|
||||
RegexOptions.IgnoreCase | RegexOptions.IgnorePatternWhitespace);
|
||||
// fix for issue 14862: return lowercase attributes for case insensitive matching
|
||||
var d = m.Cast<Match>().ToDictionary(attributeSet => attributeSet.Groups["attributeName"].Value.ToString().ToLower(), attributeSet => attributeSet.Groups["attributeValue"].Value.ToString());
|
||||
return d;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user