Mercurial > repos > IBBoard.WarFoundry.API
annotate api/Factories/Xml/WarFoundryXmlFactoryUtils.cs @ 258:3b395ab8784d
Re #270: Add multiple categories to API
* Make Race cache new units against each category
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Wed, 19 May 2010 19:23:29 +0000 |
parents | bbd86698240a |
children | 3f14a792fd41 |
rev | line source |
---|---|
52 | 1 // This file (WarFoundryXmlFactoryUtils.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard |
2 // | |
104
2f3cafb69799
Re #121: Migrate to AGPL license
IBBoard <dev@ibboard.co.uk>
parents:
52
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. |
52 | 4 |
5 using System; | |
6 using System.IO; | |
7 using System.Xml; | |
8 using System.Xml.Schema; | |
9 using IBBoard.WarFoundry.API.Objects; | |
218 | 10 using IBBoard.IO; |
52 | 11 |
12 namespace IBBoard.WarFoundry.API.Factories.Xml | |
13 { | |
14 /// <summary> | |
15 /// A collection of useful utility methods for loading WarFoundry data from XML files | |
16 /// </summary> | |
17 public class WarFoundryXmlFactoryUtils | |
18 { | |
146
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
19 public static readonly string NS_BASE = "http://ibboard.co.uk/warfoundry/"; |
52 | 20 private static XmlReaderSettings settings; |
21 private static XmlNamespaceManager nsManager; | |
22 | |
23 public static XmlNodeList SelectNodes(XmlNode element, string xpathQuery) | |
24 { | |
25 return element.SelectNodes(xpathQuery, GetNamespaceManager()); | |
26 } | |
27 | |
28 public static XmlNode SelectSingleNode(XmlNode element, string xpathQuery) | |
29 { | |
30 return element.SelectSingleNode(xpathQuery, GetNamespaceManager()); | |
31 } | |
32 | |
33 public static XmlElement SelectSingleElement(XmlNode element, string xpathQuery) | |
34 { | |
35 XmlNode node = SelectSingleNode(element, xpathQuery); | |
36 return (node is XmlElement) ? (XmlElement) node : null; | |
37 } | |
38 | |
39 public static XmlNamespaceManager GetNamespaceManager() | |
40 { | |
41 if (nsManager == null) | |
42 { | |
43 nsManager = new XmlNamespaceManager(new NameTable()); | |
146
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
44 nsManager.AddNamespace("core", NS_BASE + "core"); |
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
45 nsManager.AddNamespace("cat", NS_BASE + "cats"); |
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
46 nsManager.AddNamespace("race", NS_BASE + "race"); |
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
47 nsManager.AddNamespace("system", NS_BASE + "system"); |
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
48 nsManager.AddNamespace("army", NS_BASE + "army"); |
52 | 49 } |
50 | |
51 return nsManager; | |
52 } | |
53 | |
54 /// <summary> | |
55 /// Lazy-getter for XML reader settings. May throw a <see cref="InvalidDataException"/> if there is a problem with the translation schema. | |
56 /// </summary> | |
57 /// <returns> | |
58 /// A <see cref="XmlReaderSettings"/> with the default values for validating the translation document against the translation schema | |
59 /// </returns> | |
60 public static XmlReaderSettings GetReaderSettings() | |
61 { | |
62 if (settings == null) | |
63 { | |
64 settings = new XmlReaderSettings(); | |
65 settings.ValidationType = ValidationType.Schema; | |
66 settings.ValidationFlags = XmlSchemaValidationFlags.ReportValidationWarnings; | |
67 settings.ProhibitDtd = true; | |
68 settings.ValidationEventHandler+= new ValidationEventHandler(ValidationEventMethod); | |
69 XmlSchemaSet cache = new XmlSchemaSet(); | |
224
f097888efcfe
Fixes #233: "unitPoints" attribute is badly named
IBBoard <dev@ibboard.co.uk>
parents:
218
diff
changeset
|
70 string path = IBBoard.Constants.ExecutablePath + "/schemas/"; |
146
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
71 AddSchemaToCache(cache, NS_BASE + "core", path + "warfoundry-core.xsd"); |
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
72 AddSchemaToCache(cache, NS_BASE + "cats", path + "warfoundry-cats.xsd"); |
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
73 AddSchemaToCache(cache, NS_BASE + "race", path + "race.xsd"); |
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
74 AddSchemaToCache(cache, NS_BASE + "system", path + "system.xsd"); |
0b32cc40d82f
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
104
diff
changeset
|
75 AddSchemaToCache(cache, NS_BASE + "army", path + "army.xsd"); |
52 | 76 settings.Schemas.Add(cache); |
245
bbd86698240a
Re #152: Test and fix extensibility of current schemas
IBBoard <dev@ibboard.co.uk>
parents:
224
diff
changeset
|
77 settings.Schemas.CompilationSettings.EnableUpaCheck = false; |
52 | 78 } |
79 | |
80 return settings; | |
81 } | |
82 | |
83 private static void ValidationEventMethod(object sender, ValidationEventArgs e) | |
84 { | |
217
89e26d51afc2
Fixes #226: "NullReferenceException" for a unitID
IBBoard <dev@ibboard.co.uk>
parents:
179
diff
changeset
|
85 throw new InvalidFileException("Problem validating against schema for WarFoundry data: " + e.Message, e.Exception); |
52 | 86 } |
87 | |
88 private static void AddSchemaToCache(XmlSchemaSet cache, string xmlNamespace, string schemaLocation) | |
89 { | |
90 try | |
91 { | |
92 cache.Add(xmlNamespace, schemaLocation); | |
93 } | |
94 catch (IOException ex) | |
95 { | |
179
c1caf467dd40
Re #193: Unhandled exception in dictionary?
IBBoard <dev@ibboard.co.uk>
parents:
146
diff
changeset
|
96 //TODO: Warn on schema failure |
52 | 97 } |
98 catch (XmlSchemaException ex) | |
99 { | |
179
c1caf467dd40
Re #193: Unhandled exception in dictionary?
IBBoard <dev@ibboard.co.uk>
parents:
146
diff
changeset
|
100 //TODO: Warn on schema failure |
52 | 101 } |
102 catch (XmlException ex) | |
103 { | |
179
c1caf467dd40
Re #193: Unhandled exception in dictionary?
IBBoard <dev@ibboard.co.uk>
parents:
146
diff
changeset
|
104 //TODO: Warn on schema failure |
52 | 105 } |
106 } | |
107 | |
108 public static XmlDocument CreateXmlDocumentFromStream(Stream stream) | |
109 { | |
110 XmlDocument doc = new XmlDocument(); | |
111 XmlReader reader = XmlReader.Create(stream, GetReaderSettings()); | |
112 | |
113 try | |
114 { | |
115 doc.Load(reader); | |
116 } | |
117 //Don't catch XMLSchemaExceptions - let them get thrown out | |
118 finally | |
119 { | |
120 reader.Close(); | |
121 } | |
122 | |
123 return doc; | |
124 } | |
125 | |
126 public static bool CanCompleteLoading(IWarFoundryStagedLoadObject obj) | |
127 { | |
128 bool canLoad = true; | |
129 | |
130 if (obj.IsFullyLoaded) | |
131 { | |
132 canLoad = false; | |
133 } | |
134 else if (obj.IsLoading) | |
135 { | |
136 canLoad = false; | |
137 } | |
138 | |
139 return canLoad; | |
140 } | |
141 } | |
142 } |