Added function GetEscapedXPathStringForAttributeValue() to prevent crash due to invalid xpath query strings.

Author: NileshGhodekar

ChangeLog.md

@@ -2,14 +2,21 @@
 
 All notable changes to MIMConfigDocumenter project will be documented in this file. The "Unreleased" section at the top is for keeping track of important changes that might make it to upcoming releases.
 
+------------
+### Version 1.18.0921.0
+
+#### Fixed
+
+* Service Config report generation may crash if the config value resulted in invalid XPath query string.
+
 ------------
 
 ### Version 1.18.0824.0
 
 #### Fixed
 
 * Performance improvements. The configuration report should get generated much more quickly now.
-* Fixed an issue where a configuration setting did not rendor correctly if it had html markup characters.
+* Fixed an issue where a configuration setting did not render correctly if it had html mark-up characters.
 
 ------------
 

src/MIMConfigDocumenter/Documenter.cs

@@ -20,6 +20,7 @@ namespace MIMConfigDocumenter
     using System.IO;
     using System.Linq;
     using System.Reflection;
+    using System.Text;
     using System.Web.UI;
     using System.Xml;
     using System.Xml.Linq;
@@ -439,6 +440,41 @@ public static string GetAttributeType(string syntax)
             }
         }
 
+        /// <summary>
+        /// Gets the escaped XPath string for querying an attribute value.
+        /// </summary>
+        /// <param name="input">The input string</param>
+        /// <returns>An equivalent XPath string with single and double quotes characters are properly escaped.</returns>
+        public static string GetEscapedXPathStringForAttributeValue(string input)
+        {
+            if (input == null)
+            {
+                return input;
+            }
+
+            // If input has no ' then enclose it in a '
+            if (!input.Contains(HtmlTextWriter.SingleQuoteChar))
+            {
+                return string.Format("{0}{1}{0}", HtmlTextWriter.SingleQuoteChar, input);
+            }
+
+            // If input has no " then enclose it in a "
+            if (!input.Contains(HtmlTextWriter.DoubleQuoteChar))
+            {
+                return string.Format("{0}{1}{0}", HtmlTextWriter.DoubleQuoteChar, input);
+            }
+
+            // If input has both " and ' in it then use concat function
+            var parts = input.Split(new char[] { HtmlTextWriter.DoubleQuoteChar }, StringSplitOptions.None);
+            var sb = new StringBuilder("concat(");
+            foreach (var part in parts)
+            {
+                sb.AppendFormat("{0}{1}{0},'{0}',", HtmlTextWriter.DoubleQuoteChar, part);
+            }
+
+            return sb.ToString().TrimEnd(',') + ")";
+        }
+
         /// <summary>
         /// Gets the metaverse configuration report.
         /// </summary>

src/MIMConfigDocumenter/ServiceCommonDocumenter.cs

@@ -525,7 +525,7 @@ protected bool TestAttributeValueChange(string attributeName, string attributeVa
         protected bool TestAttributeValueChange(string attributeName, string attributeValue, DataRowState attributeOperation, string locale)
         {
             var operation = attributeOperation == DataRowState.Modified ? "Replace" : attributeOperation == DataRowState.Added ? "Add" : attributeOperation == DataRowState.Deleted ? "Delete" : "Unknown";
-            return this.CurrentChangeObject.XPathSelectElement("Changes/ImportChange[AttributeName = '" + attributeName + "' and AttributeValue = '" + attributeValue + "' and Operation = '" + operation + (locale != ServiceCommonDocumenter.InvariantLocale ? "' and Locale = '" + locale : string.Empty + "']")) != null;
+            return this.CurrentChangeObject.XPathSelectElement("Changes/ImportChange[AttributeName = '" + attributeName + "' and AttributeValue = " + Documenter.GetEscapedXPathStringForAttributeValue(attributeValue) + " and Operation = '" + operation + (locale != ServiceCommonDocumenter.InvariantLocale ? "' and Locale = '" + locale : string.Empty + "']")) != null;
         }
 
         /// <summary>
@@ -714,6 +714,13 @@ protected AttributeChange GetAttributeChange(string attributeName)
 
                 return attributeChange;
             }
+            catch (XPathException e)
+            {
+                var errorMsg = e.Message + "Attribute Name : '" + attributeName + "'. " + e.StackTrace;
+                Logger.Instance.WriteError(errorMsg);
+
+                return new AttributeChange(attributeName);
+            }
             finally
             {
                 Logger.Instance.WriteMethodExit("Attribute Name : '{0}'", attributeName);

src/VersionInfo.cs

@@ -22,7 +22,7 @@ internal static class VersionInfo
         ///      Build Number (MMDD)
         ///      Revision (if any on the same day)
         /// </summary>
-        internal const string Version = "1.18.0824.0";
+        internal const string Version = "1.18.0921.0";
 
         /// <summary>
         /// File Version information for the assembly consists of the following four values:
@@ -31,6 +31,6 @@ internal static class VersionInfo
         ///      Build Number (MMDD)
         ///      Revision (if any on the same day)
         /// </summary>
-        internal const string FileVersion = "1.18.0824.0";
+        internal const string FileVersion = "1.18.0921.0";
     }
 }