diff API/Factories/Xml/WarFoundryXmlFactoryUtils.cs @ 481:81f32062c9fa

Re #419: Remove assumptions of a file-based install * Convert schemas to resources and load them from there * Remove use of "data" folder relative to exe location from default "Hacks" (GTK/WinForms GUIs can re-add it locally)
author IBBoard <dev@ibboard.co.uk>
date Mon, 25 Jun 2012 21:04:02 +0100
parents 71fceea2725b
children
line wrap: on
line diff
--- a/API/Factories/Xml/WarFoundryXmlFactoryUtils.cs	Wed May 23 21:00:33 2012 +0100
+++ b/API/Factories/Xml/WarFoundryXmlFactoryUtils.cs	Mon Jun 25 21:04:02 2012 +0100
@@ -8,142 +8,123 @@
 using System.Xml.Schema;
 using IBBoard.WarFoundry.API.Objects;
 using IBBoard.IO;
+using IBBoard.Xml;
+using System.Reflection;
 
 namespace IBBoard.WarFoundry.API.Factories.Xml
 {
-	/// <summary>
-	/// A collection of useful utility methods for loading WarFoundry data from XML files
-	/// </summary>
-	public class WarFoundryXmlFactoryUtils
-	{
-		public static readonly string NS_BASE = "http://ibboard.co.uk/warfoundry/";
-		private static XmlReaderSettings settings;
-		private static XmlNamespaceManager nsManager;
-		
-		public static XmlNodeList SelectNodes(XmlNode element, string xpathQuery)
-		{
-			return element.SelectNodes(xpathQuery, GetNamespaceManager());
-		}
-		
-		public static XmlNode SelectSingleNode(XmlNode element, string xpathQuery)
-		{
-			return element.SelectSingleNode(xpathQuery, GetNamespaceManager());
-		}
-		
-		public static XmlElement SelectSingleElement(XmlNode element, string xpathQuery)
-		{
-			XmlNode node = SelectSingleNode(element, xpathQuery);
-			return (node is XmlElement) ? (XmlElement) node : null;
-		}
-				
-		public static XmlNamespaceManager GetNamespaceManager()
-		{
-			if (nsManager == null)
-			{
-				nsManager = new XmlNamespaceManager(new NameTable());
-				nsManager.AddNamespace("core", NS_BASE + "core");
-				nsManager.AddNamespace("cat", NS_BASE + "cats");
-				nsManager.AddNamespace("race", NS_BASE + "race");
-				nsManager.AddNamespace("system", NS_BASE + "system");
-				nsManager.AddNamespace("army", NS_BASE + "army");
-			}
-			
-			return nsManager;
-		}
-		
 		/// <summary>
-		/// Lazy-getter for XML reader settings. May throw a <see cref="InvalidDataException"/> if there is a problem with the translation schema.
+		/// A collection of useful utility methods for loading WarFoundry data from XML files
 		/// </summary>
-		/// <returns>
-		/// A <see cref="XmlReaderSettings"/> with the default values for validating the translation document against the translation schema
-		/// </returns>
-		public static XmlReaderSettings GetReaderSettings()
+		public class WarFoundryXmlFactoryUtils
 		{
-			if (settings == null)
-			{
-				settings = new XmlReaderSettings();
-				settings.ValidationType = ValidationType.Schema;
-				//settings.ValidationFlags = XmlSchemaValidationFlags.ReportValidationWarnings;
-				settings.ProhibitDtd = true;
-				settings.ValidationEventHandler+= new ValidationEventHandler(ValidationEventMethod);
-				XmlSchemaSet cache = new XmlSchemaSet();
-				string path =  Path.Combine(IBBoard.Constants.ExecutablePath, "schemas");
-				AddSchemaToCache(cache, NS_BASE + "core", Path.Combine(path, "warfoundry-core.xsd"));
-				AddSchemaToCache(cache, NS_BASE + "cats", Path.Combine(path, "warfoundry-cats.xsd"));
-				AddSchemaToCache(cache, NS_BASE + "race", Path.Combine(path, "race.xsd"));
-				AddSchemaToCache(cache, NS_BASE + "system", Path.Combine(path, "system.xsd"));
-				AddSchemaToCache(cache, NS_BASE + "army", Path.Combine(path, "army.xsd"));
-				settings.Schemas.Add(cache);
-				settings.Schemas.CompilationSettings.EnableUpaCheck = false;
-			}
+				public static readonly string NS_BASE = "http://ibboard.co.uk/warfoundry/";
+				private static XmlReaderSettings settings;
+				private static XmlNamespaceManager nsManager;
+		
+				public static XmlNodeList SelectNodes(XmlNode element, string xpathQuery)
+				{
+						return element.SelectNodes(xpathQuery, GetNamespaceManager());
+				}
+		
+				public static XmlNode SelectSingleNode(XmlNode element, string xpathQuery)
+				{
+						return element.SelectSingleNode(xpathQuery, GetNamespaceManager());
+				}
+		
+				public static XmlElement SelectSingleElement(XmlNode element, string xpathQuery)
+				{
+						XmlNode node = SelectSingleNode(element, xpathQuery);
+						return (node is XmlElement) ? (XmlElement)node : null;
+				}
+				
+				public static XmlNamespaceManager GetNamespaceManager()
+				{
+						if (nsManager == null)
+						{
+								nsManager = new XmlNamespaceManager(new NameTable());
+								nsManager.AddNamespace("core", NS_BASE + "core");
+								nsManager.AddNamespace("cat", NS_BASE + "cats");
+								nsManager.AddNamespace("race", NS_BASE + "race");
+								nsManager.AddNamespace("system", NS_BASE + "system");
+								nsManager.AddNamespace("army", NS_BASE + "army");
+						}
 			
-			return settings;
-		}
+						return nsManager;
+				}
 		
-		private static void ValidationEventMethod(object sender, ValidationEventArgs e)
-		{
-			if (e.Severity == XmlSeverityType.Error)
-			{
-				throw new InvalidFileException("Problem validating against schema for WarFoundry data: " + e.Message, e.Exception);
-			}
-			else
-			{
-				//TODO: Fire some kind of warning event
-			}
-		}
+				/// <summary>
+				/// Lazy-getter for XML reader settings. May throw a <see cref="InvalidDataException"/> if there is a problem with the translation schema.
+				/// </summary>
+				/// <returns>
+				/// A <see cref="XmlReaderSettings"/> with the default values for validating the translation document against the translation schema
+				/// </returns>
+				public static XmlReaderSettings GetReaderSettings()
+				{
+						if (settings == null)
+						{
+								settings = new XmlReaderSettings();
+								settings.ValidationType = ValidationType.Schema;
+								//settings.ValidationFlags = XmlSchemaValidationFlags.ReportValidationWarnings;
+								settings.ProhibitDtd = true;
+								settings.ValidationEventHandler += new ValidationEventHandler(ValidationEventMethod);
+								XmlSchemaSet cache = new XmlSchemaSet();
+								string path = "IBBoard.WarFoundry.schemas.";
+								Assembly assm = Assembly.GetExecutingAssembly();
+								XmlTools.AddSchemaToSetFromResource(cache, NS_BASE + "core", assm, path + "warfoundry-core.xsd");
+								XmlTools.AddSchemaToSetFromResource(cache, NS_BASE + "cats", assm, path + "warfoundry-cats.xsd");
+								XmlTools.AddSchemaToSetFromResource(cache, NS_BASE + "race", assm, path + "race.xsd");
+								XmlTools.AddSchemaToSetFromResource(cache, NS_BASE + "system", assm, path + "system.xsd");
+								XmlTools.AddSchemaToSetFromResource(cache, NS_BASE + "army", assm, path + "army.xsd");
+								settings.Schemas.Add(cache);
+								settings.Schemas.CompilationSettings.EnableUpaCheck = false;
+						}
+			
+						return settings;
+				}
 		
-		private static void AddSchemaToCache(XmlSchemaSet cache, string xmlNamespace, string schemaLocation)
-		{
-			try
-			{
-				cache.Add(xmlNamespace, schemaLocation);
-			}
-			catch (IOException)
-			{
-				//TODO: Warn on schema failure
-			}
-			catch (XmlSchemaException)
-			{
-				//TODO: Warn on schema failure
-			}
-			catch (XmlException)
-			{
-				//TODO: Warn on schema failure
-			}
-		}
+				private static void ValidationEventMethod(object sender, ValidationEventArgs e)
+				{
+						if (e.Severity == XmlSeverityType.Error)
+						{
+								throw new InvalidFileException("Problem validating against schema for WarFoundry data: " + e.Message, e.Exception);
+						} else
+						{
+								//TODO: Fire some kind of warning event
+						}
+				}
 		
-		public static XmlDocument CreateXmlDocumentFromStream(Stream stream)
-		{
-			XmlDocument doc = new XmlDocument();
-			XmlReader reader = XmlReader.Create(stream, GetReaderSettings());
+				public static XmlDocument CreateXmlDocumentFromStream(Stream stream)
+				{
+						XmlDocument doc = new XmlDocument();
+						XmlReader reader = XmlReader.Create(stream, GetReaderSettings());
 			
-			try
-			{
-				doc.Load(reader);
-			}
+						try
+						{
+								doc.Load(reader);
+						}
 			//Don't catch XMLSchemaExceptions - let them get thrown out
 			finally
-			{
-				reader.Close();
-			}
+						{
+								reader.Close();
+						}
 
-			return doc;
-		}
+						return doc;
+				}
 		
-		public static bool CanCompleteLoading(IWarFoundryStagedLoadObject obj)
-		{
-			bool canLoad = true;			
+				public static bool CanCompleteLoading(IWarFoundryStagedLoadObject obj)
+				{
+						bool canLoad = true;			
 			
-			if (obj.IsFullyLoaded)
-			{
-				canLoad = false;
-			}
-			else if (obj.IsLoading)
-			{
-				canLoad = false;
-			}
+						if (obj.IsFullyLoaded)
+						{
+								canLoad = false;
+						} else if (obj.IsLoading)
+						{
+								canLoad = false;
+						}
 			
-			return canLoad;
+						return canLoad;
+				}
 		}
-	}
 }