Skip to content

Better support for empty elements in manifest. #7302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bdukes merged 4 commits into from
Jun 3, 2026
+770 −83
Merged

Better support for empty elements in manifest. #7302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
daac6b0
Support both self-closing <element/> and empty <element></element>.
dimarobert May 29, 2026
d1b11b0
Add ReadXml tests for DesktopModuleInfo and RoleGroupInfo
bdukes May 29, 2026
6e7d375
Support empty nodes with whitespace
bdukes May 29, 2026
ef2c087
Add tests for data read after self-closing element
bdukes Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions DNN Platform/Library/Common/Utilities/XmlUtils.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -787,6 +787,22 @@ public static partial XmlDocument GetXMLContent(string contentUrl)
return functionReturnValue;
}

public static bool TryReadEndElement(XmlReader reader)
{
while (reader.NodeType == XmlNodeType.Whitespace)
{
reader.Read();
}

if (reader.NodeType == XmlNodeType.EndElement)
{
reader.ReadEndElement();
return true;
}

return false;
}

/// <summary>Creates an <see cref="XPathExpression"/> with variable arguments.</summary>
/// <param name="xpath">The XPath expression that includes variables, e.g. <c>//root/data[@name=$resourceKeyName]/value</c>.</param>
/// <param name="arguments">A collection of variable names and values.</param>
Expand Down
174 changes: 91 additions & 83 deletions DNN Platform/Library/Entities/Modules/DesktopModuleInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,82 +266,81 @@ public void ReadXml(XmlReader reader)
continue;
}

if (reader.NodeType == XmlNodeType.Element && reader.Name == "moduleDefinitions" && !reader.IsEmptyElement)
switch (reader)
{
this.ReadModuleDefinitions(reader);
}
else if (reader.NodeType == XmlNodeType.Element && reader.Name == "supportedFeatures" && !reader.IsEmptyElement)
{
this.ReadSupportedFeatures(reader);
}
else if (reader.NodeType == XmlNodeType.Element && reader.Name == "shareable" && !reader.IsEmptyElement)
{
this.ReadModuleSharing(reader);
}
else if (reader.NodeType == XmlNodeType.Element && reader.Name == "page" && !reader.IsEmptyElement)
{
this.ReadPageInfo(reader);
}
else
{
switch (reader.Name)
{
case "desktopModule":
break;
case "moduleName":
this.ModuleName = reader.ReadElementContentAsString();
break;
case "friendlyName":
this.FriendlyName = reader.ReadElementContentAsString();
break;
case "description":
this.Description = reader.ReadElementContentAsString();
break;
case "foldername":
this.FolderName = reader.ReadElementContentAsString();
break;
case "businessControllerClass":
this.BusinessControllerClass = reader.ReadElementContentAsString();
break;
case "codeSubDirectory":
this.CodeSubDirectory = reader.ReadElementContentAsString();
break;
case "page":
this.ReadPageInfo(reader);

if (this.Page.HasAdminPage())
{
this.AdminPage = this.Page.Name;
}

if (this.Page.HasHostPage())
{
this.HostPage = this.Page.Name;
}

break;
case "isAdmin":
if (bool.TryParse(reader.ReadElementContentAsString(), out var isAdmin))
{
this.IsAdmin = isAdmin;
}

break;
case "isPremium":
if (bool.TryParse(reader.ReadElementContentAsString(), out var isPremium))
{
this.IsPremium = isPremium;
}

break;
default:
if (reader.NodeType == XmlNodeType.Element && !string.IsNullOrEmpty(reader.Name))
{
reader.ReadElementContentAsString();
}
case { NodeType: XmlNodeType.Element, Name: "moduleDefinitions", IsEmptyElement: false, }:
this.ReadModuleDefinitions(reader);
break;
case { NodeType: XmlNodeType.Element, Name: "supportedFeatures", IsEmptyElement: false, }:
this.ReadSupportedFeatures(reader);
break;
case { NodeType: XmlNodeType.Element, Name: "shareable", IsEmptyElement: false, }:
this.ReadModuleSharing(reader);
break;
case { NodeType: XmlNodeType.Element, Name: "page", IsEmptyElement: false, }:
this.ReadPageInfo(reader);
break;
default:
switch (reader.Name)
{
case "desktopModule":
break;
case "moduleName":
this.ModuleName = reader.ReadElementContentAsString();
break;
case "friendlyName":
this.FriendlyName = reader.ReadElementContentAsString();
break;
case "description":
this.Description = reader.ReadElementContentAsString();
break;
case "foldername":
this.FolderName = reader.ReadElementContentAsString();
break;
case "businessControllerClass":
this.BusinessControllerClass = reader.ReadElementContentAsString();
break;
case "codeSubDirectory":
this.CodeSubDirectory = reader.ReadElementContentAsString();
break;
case "page":
this.ReadPageInfo(reader);

if (this.Page.HasAdminPage())
{
this.AdminPage = this.Page.Name;
}

if (this.Page.HasHostPage())
{
this.HostPage = this.Page.Name;
}

break;
case "isAdmin":
if (bool.TryParse(reader.ReadElementContentAsString(), out var isAdmin))
{
this.IsAdmin = isAdmin;
}

break;
case "isPremium":
if (bool.TryParse(reader.ReadElementContentAsString(), out var isPremium))
{
this.IsPremium = isPremium;
}

break;
default:
if (reader.NodeType == XmlNodeType.Element && !string.IsNullOrEmpty(reader.Name))
{
reader.ReadElementContentAsString();
}

break;
}

break;
}
break;
}
}
}
Expand All @@ -350,7 +349,7 @@ public void ReadXml(XmlReader reader)
/// <param name="writer">The XmlWriter to use.</param>
public void WriteXml(XmlWriter writer)
{
// Write start of main elemenst
// Write start of main elements
writer.WriteStartElement("desktopModule");

// write out properties
Expand Down Expand Up @@ -389,10 +388,7 @@ public void WriteXml(XmlWriter writer)
writer.WriteEndElement();

// Write admin/host page info.
if (this.Page != null)
{
this.Page.WriteXml(writer);
}
this.Page?.WriteXml(writer);

// Module sharing
if (this.Shareable != ModuleSharing.Unknown)
Expand Down Expand Up @@ -432,7 +428,7 @@ public void WriteXml(XmlWriter writer)
private void ClearFeature(DesktopModuleSupportedFeature feature)
{
// And with the 1's complement of Feature to Clear the Feature flag
this.SupportedFeatures = this.SupportedFeatures & ~((int)feature);
this.SupportedFeatures &= ~(int)feature;
}

/// <summary>Gets a Feature from the Features.</summary>
Expand Down Expand Up @@ -468,8 +464,14 @@ private void UpdateFeature(DesktopModuleSupportedFeature feature, bool isSet)
/// <param name="reader">The XmlReader to use.</param>
private void ReadSupportedFeatures(XmlReader reader)
{
this.SupportedFeatures = 0;
reader.ReadStartElement("supportedFeatures");

if (XmlUtils.TryReadEndElement(reader))
{
return;
}

this.SupportedFeatures = 0;
do
{
if (reader.HasAttributes)
Expand Down Expand Up @@ -523,14 +525,20 @@ private void ReadModuleSharing(XmlReader reader)
private void ReadModuleDefinitions(XmlReader reader)
{
reader.ReadStartElement("moduleDefinitions");

if (XmlUtils.TryReadEndElement(reader))
{
return;
}

do
{
reader.ReadStartElement("moduleDefinition");

// Create new ModuleDefinition object
var moduleDefinition = new ModuleDefinitionInfo();

// Load it from the Xml
// Load it from the XML
moduleDefinition.ReadXml(reader);

// Add to the collection
Expand All @@ -543,7 +551,7 @@ private void ReadPageInfo(XmlReader reader)
{
this.Page = new PageInfo();

// Load it from the Xml
// Load it from the XML
this.Page.ReadXml(reader.ReadSubtree());

if (this.Page.HasAdminPage())
Expand Down
6 changes: 6 additions & 0 deletions DNN Platform/Library/Security/Roles/RoleGroupInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,12 @@ private void GetRoles()
private void ReadRoles(XmlReader reader)
{
reader.ReadStartElement("roles");

if (XmlUtils.TryReadEndElement(reader))
{
return;
}

this.roles = new Dictionary<string, RoleInfo>();
do
{
Expand Down
Loading
Loading