2 // System.Configuration.SectionGroupInfo.cs
5 // Lluis Sanchez (lluis@novell.com)
7 // Permission is hereby granted, free of charge, to any person obtaining
8 // a copy of this software and associated documentation files (the
9 // "Software"), to deal in the Software without restriction, including
10 // without limitation the rights to use, copy, modify, merge, publish,
11 // distribute, sublicense, and/or sell copies of the Software, and to
12 // permit persons to whom the Software is furnished to do so, subject to
13 // the following conditions:
15 // The above copyright notice and this permission notice shall be
16 // included in all copies or substantial portions of the Software.
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
30 using System.Collections;
31 using System.Collections.Specialized;
36 namespace System.Configuration
38 internal class SectionGroupInfo: ConfigInfo
40 ConfigInfoCollection sections;
41 ConfigInfoCollection groups;
42 static ConfigInfoCollection emptyList = new ConfigInfoCollection ();
44 public SectionGroupInfo ()
46 Type = typeof (ConfigurationSectionGroup);
49 public SectionGroupInfo (string groupName, string typeName)
55 public void AddChild (ConfigInfo data)
58 if (data is SectionInfo) {
59 if (sections == null) sections = new ConfigInfoCollection ();
60 sections [data.Name] = data;
63 if (groups == null) groups = new ConfigInfoCollection ();
64 groups [data.Name] = data;
70 if (sections != null) sections.Clear ();
71 if (groups != null) groups.Clear ();
74 public bool HasChild (string name)
76 if (sections != null && sections [name] != null) return true;
77 return (groups != null && groups [name] != null);
80 public void RemoveChild (string name)
83 sections.Remove (name);
88 public SectionInfo GetChildSection (string name)
91 return sections [name] as SectionInfo;
96 public SectionGroupInfo GetChildGroup (string name)
99 return groups [name] as SectionGroupInfo;
104 public ConfigInfoCollection Sections
106 get { if (sections == null) return emptyList; else return sections; }
109 public ConfigInfoCollection Groups
111 get { if (groups == null) return emptyList; else return groups; }
114 public override bool HasDataContent (Configuration config)
116 foreach (ConfigInfoCollection col in new object[] {Sections, Groups}) {
117 foreach (string key in col) {
118 ConfigInfo cinfo = col [key];
119 if (cinfo.HasDataContent (config))
126 public override bool HasConfigContent (Configuration cfg)
128 if (StreamName == cfg.FileName) return true;
129 foreach (ConfigInfoCollection col in new object[] {Sections, Groups}) {
130 foreach (string key in col) {
131 ConfigInfo cinfo = col [key];
132 if (cinfo.HasConfigContent (cfg))
139 public override void ReadConfig (Configuration cfg, string streamName, XmlTextReader reader)
141 StreamName = streamName;
142 ConfigHost = cfg.ConfigHost;
144 if (reader.LocalName != "configSections")
146 while (reader.MoveToNextAttribute ()) {
147 if (reader.Name == "name")
149 else if (reader.Name == "type") {
150 TypeName = reader.Value;
154 ThrowException ("Unrecognized attribute", reader);
158 ThrowException ("sectionGroup must have a 'name' attribute", reader);
160 if (Name == "location")
161 ThrowException ("location is a reserved section name", reader);
164 if (TypeName == null)
165 TypeName = "System.Configuration.ConfigurationSectionGroup";
167 if (reader.IsEmptyElement) {
172 reader.ReadStartElement ();
173 reader.MoveToContent ();
175 while (reader.NodeType != XmlNodeType.EndElement)
177 if (reader.NodeType != XmlNodeType.Element) {
182 string name = reader.LocalName;
183 ConfigInfo cinfo = null;
185 if (name == "remove") {
186 ReadRemoveSection (reader);
190 if (name == "clear") {
191 if (reader.HasAttributes)
192 ThrowException ("Unrecognized attribute.", reader);
199 if (name == "section")
200 cinfo = new SectionInfo ();
201 else if (name == "sectionGroup")
202 cinfo = new SectionGroupInfo ();
204 ThrowException ("Unrecognized element: " + reader.Name, reader);
206 cinfo.ReadConfig (cfg, streamName, reader);
207 ConfigInfo actInfo = Groups [cinfo.Name];
208 if (actInfo == null) actInfo = Sections [cinfo.Name];
210 if (actInfo != null) {
211 if (actInfo.GetType () != cinfo.GetType ())
212 ThrowException ("A section or section group named '" + cinfo.Name + "' already exists", reader);
213 // Make sure that this section is saved in this configuration file:
214 actInfo.StreamName = streamName;
220 reader.ReadEndElement ();
223 public override void WriteConfig (Configuration cfg, XmlWriter writer, ConfigurationSaveMode mode)
226 writer.WriteStartElement ("sectionGroup");
227 writer.WriteAttributeString ("name", Name);
228 if (TypeName != null && TypeName != "" && TypeName != "System.Configuration.ConfigurationSectionGroup")
229 writer.WriteAttributeString ("type", TypeName);
232 writer.WriteStartElement ("configSections");
234 foreach (ConfigInfoCollection col in new object[] {Sections, Groups}) {
235 foreach (string key in col) {
236 ConfigInfo cinfo = col [key];
237 if (cinfo.HasConfigContent (cfg))
238 cinfo.WriteConfig (cfg, writer, mode);
242 writer.WriteEndElement ();
245 private void ReadRemoveSection (XmlTextReader reader)
247 if (!reader.MoveToNextAttribute () || reader.Name != "name")
248 ThrowException ("Unrecognized attribute.", reader);
250 string removeValue = reader.Value;
251 if (removeValue == null || removeValue.Length == 0)
252 ThrowException ("Empty name to remove", reader);
254 reader.MoveToElement ();
256 if (!HasChild (removeValue))
257 ThrowException ("No factory for " + removeValue, reader);
259 RemoveChild (removeValue);
263 public void ReadRootData (XmlTextReader reader, Configuration config, bool overrideAllowed)
265 reader.MoveToContent ();
266 ReadContent (reader, config, overrideAllowed);
269 public override void ReadData (Configuration config, XmlTextReader reader, bool overrideAllowed)
271 reader.MoveToContent ();
272 reader.ReadStartElement ();
273 ReadContent (reader, config, overrideAllowed);
274 reader.MoveToContent ();
275 reader.ReadEndElement ();
278 void ReadContent (XmlTextReader reader, Configuration config, bool overrideAllowed)
280 StringBuilder spacing = new StringBuilder ();
281 while (reader.NodeType != XmlNodeType.EndElement) {
282 if (reader.NodeType != XmlNodeType.Element) {
283 if (reader.NodeType == XmlNodeType.Whitespace)
284 spacing.Append (reader.Value);
289 if (reader.LocalName == "location")
292 ThrowException ("<location> elements are only allowed in <configuration> elements.", reader);
294 string allowOverrideAttr = reader.GetAttribute ("allowOverride");
295 bool allowOverride = allowOverrideAttr == null || allowOverrideAttr.Length == 0 || bool.Parse (allowOverrideAttr);
296 string path = reader.GetAttribute ("path");
297 if (path != null && path.Length > 0) {
298 string xml = reader.ReadOuterXml ();
299 string[] pathList = path.Split (',');
300 foreach (string p in pathList) {
301 ConfigurationLocation loc = new ConfigurationLocation (p.Trim (), xml, config, allowOverride);
302 config.Locations.Add (loc);
305 ReadData (config, reader, allowOverride);
310 ConfigInfo data = (sections != null) ? (ConfigInfo) sections [reader.LocalName] : (ConfigInfo) null;
311 if (data == null) data = (groups != null) ? (ConfigInfo) groups [reader.LocalName] : (ConfigInfo) null;
314 data.ReadData (config, reader, overrideAllowed);
316 ThrowException ("Unrecognized configuration section <" + reader.LocalName + ">", reader);
320 public void WriteRootData (XmlWriter writer, Configuration config, ConfigurationSaveMode mode)
322 WriteContent (writer, config, mode, false);
325 public override void WriteData (Configuration config, XmlWriter writer, ConfigurationSaveMode mode)
327 writer.WriteStartElement (Name);
328 WriteContent (writer, config, mode, true);
329 writer.WriteEndElement ();
332 public void WriteContent (XmlWriter writer, Configuration config, ConfigurationSaveMode mode, bool writeElem)
334 foreach (ConfigInfoCollection col in new object[] {Sections, Groups}) {
335 foreach (string key in col) {
336 ConfigInfo cinfo = col [key];
337 if (cinfo.HasDataContent (config))
338 cinfo.WriteData (config, writer, mode);
344 internal class ConfigInfoCollection : NameObjectCollectionBase
346 public ICollection AllKeys
351 public ConfigInfo this [string name]
353 get { return (ConfigInfo) BaseGet (name); }
354 set { BaseSet (name, value); }
357 public ConfigInfo this [int index]
359 get { return (ConfigInfo) BaseGet (index); }
360 set { BaseSet (index, value); }
363 public void Add (string name, ConfigInfo config)
365 BaseAdd (name, config);
373 public string GetKey (int index)
375 return BaseGetKey (index);
378 public void Remove (string name)
383 public void RemoveAt (int index)
385 BaseRemoveAt (index);