Mercurial > repos > IBDev-IBBoard.WarFoundry.API

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 // This file (WarFoundryXmlFactoryUtils.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2 //
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
3 // The file and the library/program it is in are licensed and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING for more information and the full license.
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
5 using System;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6 using System.IO;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
7 using System.Xml;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
8 using System.Xml.Schema;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
9 using IBBoard.WarFoundry.API.Objects;
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
10 using IBBoard.IO;
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
11 using IBBoard.Xml;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
12 using System.Reflection;
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
13
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
14 namespace IBBoard.WarFoundry.API.Factories.Xml
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15 {
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
16 /// <summary>
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
17 /// A collection of useful utility methods for loading WarFoundry data from XML files
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
18 /// </summary>
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
19 public class WarFoundryXmlFactoryUtils
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
20 {
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
21 public static readonly string NS_BASE = "http://ibboard.co.uk/warfoundry/";
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
22 private static XmlReaderSettings settings;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
23 private static XmlNamespaceManager nsManager;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
24
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
25 public static XmlNodeList SelectNodes(XmlNode element, string xpathQuery)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
26 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
27 return element.SelectNodes(xpathQuery, GetNamespaceManager());
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
28 }
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
29
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
30 public static XmlNode SelectSingleNode(XmlNode element, string xpathQuery)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
31 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
32 return element.SelectSingleNode(xpathQuery, GetNamespaceManager());
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
33 }
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
34
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
35 public static XmlElement SelectSingleElement(XmlNode element, string xpathQuery)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
36 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
37 XmlNode node = SelectSingleNode(element, xpathQuery);
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
38 return (node is XmlElement) ? (XmlElement)node : null;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
39 }
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
40
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
41 public static XmlNamespaceManager GetNamespaceManager()
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
42 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
43 if (nsManager == null)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
44 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
45 nsManager = new XmlNamespaceManager(new NameTable());
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
46 nsManager.AddNamespace("core", NS_BASE + "core");
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
47 nsManager.AddNamespace("cat", NS_BASE + "cats");
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
48 nsManager.AddNamespace("race", NS_BASE + "race");
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
49 nsManager.AddNamespace("system", NS_BASE + "system");
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
50 nsManager.AddNamespace("army", NS_BASE + "army");
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
51 }
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
52
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
53 return nsManager;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
54 }
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
55
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
56 /// <summary>
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
57 /// Lazy-getter for XML reader settings. May throw a <see cref="InvalidDataException"/> if there is a problem with the translation schema.
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
58 /// </summary>
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
59 /// <returns>
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
60 /// A <see cref="XmlReaderSettings"/> with the default values for validating the translation document against the translation schema
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
61 /// </returns>
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
62 public static XmlReaderSettings GetReaderSettings()
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
63 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
64 if (settings == null)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
65 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
66 settings = new XmlReaderSettings();
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
67 settings.ValidationType = ValidationType.Schema;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
68 //settings.ValidationFlags = XmlSchemaValidationFlags.ReportValidationWarnings;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
69 settings.ProhibitDtd = true;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
70 settings.ValidationEventHandler += new ValidationEventHandler(ValidationEventMethod);
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
71 XmlSchemaSet cache = new XmlSchemaSet();
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
72 string path = "IBBoard.WarFoundry.schemas.";
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
73 Assembly assm = Assembly.GetExecutingAssembly();
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
74 XmlTools.AddSchemaToSetFromResource(cache, NS_BASE + "core", assm, path + "warfoundry-core.xsd");
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
75 XmlTools.AddSchemaToSetFromResource(cache, NS_BASE + "cats", assm, path + "warfoundry-cats.xsd");
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
76 XmlTools.AddSchemaToSetFromResource(cache, NS_BASE + "race", assm, path + "race.xsd");
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
77 XmlTools.AddSchemaToSetFromResource(cache, NS_BASE + "system", assm, path + "system.xsd");
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
78 XmlTools.AddSchemaToSetFromResource(cache, NS_BASE + "army", assm, path + "army.xsd");
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
79 settings.Schemas.Add(cache);
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
80 settings.Schemas.CompilationSettings.EnableUpaCheck = false;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
81 }
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
82
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
83 return settings;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
84 }
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
85
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
86 private static void ValidationEventMethod(object sender, ValidationEventArgs e)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
87 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
88 if (e.Severity == XmlSeverityType.Error)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
89 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
90 throw new InvalidFileException("Problem validating against schema for WarFoundry data: " + e.Message, e.Exception);
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
91 } else
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
92 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
93 //TODO: Fire some kind of warning event
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
94 }
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
95 }
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
96
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
97 public static XmlDocument CreateXmlDocumentFromStream(Stream stream)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
98 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
99 XmlDocument doc = new XmlDocument();
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
100 XmlReader reader = XmlReader.Create(stream, GetReaderSettings());
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
101
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
102 try
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
103 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
104 doc.Load(reader);
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
105 }
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
106 //Don't catch XMLSchemaExceptions - let them get thrown out
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
107 finally
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
108 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
109 reader.Close();
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
110 }
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
111
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
112 return doc;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
113 }
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
114
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
115 public static bool CanCompleteLoading(IWarFoundryStagedLoadObject obj)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
116 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
117 bool canLoad = true;
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
118
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
119 if (obj.IsFullyLoaded)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
120 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
121 canLoad = false;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
122 } else if (obj.IsLoading)
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
123 {
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
124 canLoad = false;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
125 }
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
126
481
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
127 return canLoad;
81f32062c9fa Re #419: Remove assumptions of a file-based install
IBBoard <dev@ibboard.co.uk>
parents: 419
diff changeset
128 }
337
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
129 }
3c4a6403a88c * Fix capitalisation so that new files are in the namespace
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
130 }