History

Added support for GSF configuration files on Mono

ritchiecarroll committed 12 years ago

Commit 2bbd6cd1 parent ef6432e13 files · +615 −136Browse files

Showing the changes to Source/Libraries/GSF.Core/Configuration (4 of 13 files). Show all

Unified · Split

4 files
  1. Source/Libraries/GSF.Core/Configuration/CategorizedSettingsElement.cs +17 −0
  2. Source/Libraries/GSF.Core/Configuration/CategorizedSettingsElementCollection.cs +18 −6
  3. Source/Libraries/GSF.Core/Configuration/CategorizedSettingsSection.cs +174 −14
  4. Source/Libraries/GSF.Core/Configuration/ConfigurationFile.cs +49 −33
Source/Libraries/GSF.Core/Configuration/CategorizedSettingsElement.cs+17−0
@@ -170,6 +170,7 @@ namespace GSF.Configuration · 169 unmodified lines
170170 set
171171 {
172172 base["name"] = value;
173+ Modified = true;
173174 }
174175 }
175176
@@ -229,6 +230,8 @@ namespace GSF.Configuration · 53 unmodified lines
229230 else
230231 // Setting is user specific so update setting in user settings store.
231232 Category.Section.File.UserSettings.Write(Category.Name, Name, value);
233+
234+ Modified = true;
232235 }
233236 }
234237
@@ -250,6 +253,7 @@ namespace GSF.Configuration · 15 unmodified lines
250253 return;
251254
252255 base["description"] = value;
256+ Modified = true;
253257 }
254258 }
255259
@@ -271,6 +275,7 @@ namespace GSF.Configuration · 15 unmodified lines
271275 return;
272276
273277 base["encrypted"] = value;
278+ Modified = true;
274279 }
275280 }
276281
@@ -291,6 +296,16 @@ namespace GSF.Configuration · 14 unmodified lines
291296 return;
292297
293298 base["scope"] = value;
299+ Modified = true;
300+ }
301+ }
302+
303+ internal bool Modified
304+ {
305+ set
306+ {
307+ if ((object)m_category != null)
308+ m_category.Modified = value;
294309 }
295310 }
296311
@@ -311,6 +326,7 @@ namespace GSF.Configuration · 14 unmodified lines
311326 string decryptedValue = Value;
312327 m_cryptoKey = cryptoKey;
313328 Value = decryptedValue;
329+ Modified = true;
314330 }
315331 }
316332
@@ -357,6 +373,7 @@ namespace GSF.Configuration · 40 unmodified lines
357373 this.Encrypted = encrypted;
358374 this.Value = Common.TypeConvertToString(value, m_category.Section.File.Culture);
359375 this.Description = description;
376+ Modified = true;
360377 }
361378
362379 /// <summary>
Source/Libraries/GSF.Core/Configuration/CategorizedSettingsElementCollection.cs+18−6
@@ -111,6 +111,7 @@ namespace GSF.Configuration · 110 unmodified lines
111111 base.BaseRemoveAt(index);
112112
113113 base.BaseAdd(index, value);
114+ Modified = true;
114115 }
115116 }
116117
@@ -137,23 +138,29 @@ namespace GSF.Configuration · 20 unmodified lines
137138 {
138139 get
139140 {
141+ // Add setting since it's not there
140142 if (ensureExistance && (object)base.BaseGet(name) == null)
141− {
142− // Add setting since it's not there.
143143 Add(name, string.Empty);
144− }
145144
146145 CategorizedSettingsElement setting = (CategorizedSettingsElement)base.BaseGet(name);
146+
147+ // Set the crypto key for the setting
147148 if ((object)setting != null)
148− {
149− // Set the crypto key for the setting.
150149 setting.SetCryptoKey(m_cryptoKey);
151− }
152150
153151 return setting;
154152 }
155153 }
156154
155+ internal bool Modified
156+ {
157+ set
158+ {
159+ if ((object)m_section != null)
160+ m_section.Modified = value;
161+ }
162+ }
163+
157164 #endregion
158165
159166 #region [ Methods ]
@@ -242,6 +249,7 @@ namespace GSF.Configuration · 82 unmodified lines
242249 setting.Category = this;
243250 setting.SetCryptoKey(m_cryptoKey);
244251 base.BaseAdd(setting);
252+ Modified = true;
245253 }
246254 }
247255
@@ -252,6 +260,7 @@ namespace GSF.Configuration · 4 unmodified lines
252260 public void Remove(string name)
253261 {
254262 base.BaseRemove(name);
263+ Modified = true;
255264 }
256265
257266 /// <summary>
@@ -263,6 +272,7 @@ namespace GSF.Configuration · 5 unmodified lines
263272 if (base.BaseIndexOf(setting) >= 0)
264273 {
265274 Remove(setting.Name);
275+ Modified = true;
266276 }
267277 }
268278
@@ -273,6 +283,7 @@ namespace GSF.Configuration · 4 unmodified lines
273283 public void RemoveAt(int index)
274284 {
275285 base.BaseRemoveAt(index);
286+ Modified = true;
276287 }
277288
278289 /// <summary>
@@ -281,6 +292,7 @@ namespace GSF.Configuration · 2 unmodified lines
281292 public void Clear()
282293 {
283294 base.BaseClear();
295+ Modified = true;
284296 }
285297
286298 /// <summary>
Source/Libraries/GSF.Core/Configuration/CategorizedSettingsSection.cs+174−14
@@ -38,10 +38,14 @@ · 37 unmodified lines
3838 //******************************************************************************************************
3939
4040 using System;
41+using System.Collections.Generic;
4142 using System.Configuration;
4243 using System.IO;
44+using System.Text;
4345 using System.Xml;
46+using GSF.Collections;
4447 using GSF.IO;
48+using GSF.Xml;
4549
4650 namespace GSF.Configuration
4751 {
@@ -59,9 +63,19 @@ namespace GSF.Configuration · 11 unmodified lines
5963 // Fields
6064 private string m_cryptoKey;
6165 private ConfigurationFile m_file;
66+ private readonly Dictionary<string, CategorizedSettingsElementCollection> m_sections;
6267
6368 #endregion
6469
70+ /// <summary>
71+ /// Creates a new <see cref="CategorizedSettingsSection"/>.
72+ /// </summary>
73+ public CategorizedSettingsSection()
74+ {
75+ if (Common.IsMono)
76+ m_sections = new Dictionary<string, CategorizedSettingsElementCollection>();
77+ }
78+
6579 #region [ Properties ]
6680
6781 /// <summary>
@@ -99,18 +113,42 @@ namespace GSF.Configuration · 31 unmodified lines
99113 // Make the first letter of category name lower case, if not already.
100114 char[] nameChars = name.ToCharArray();
101115 nameChars[0] = char.ToLower(nameChars[0]);
116+
102117 // Do not allow spaces in the name so that underlying .Net configuration API does not break.
103118 name = (new string(nameChars)).RemoveWhiteSpace();
104− ConfigurationProperty configProperty = new ConfigurationProperty(name, typeof(CategorizedSettingsElementCollection));
105119
106− base.Properties.Add(configProperty);
120+ ConfigurationProperty configProperty = new ConfigurationProperty(name, typeof(CategorizedSettingsElementCollection));
107121 CategorizedSettingsElementCollection settingsCategory = null;
108− if ((object)base[configProperty] != null)
122+
123+ if ((object)m_sections == null)
109124 {
110− settingsCategory = (CategorizedSettingsElementCollection)base[configProperty];
111− settingsCategory.Name = name;
112− settingsCategory.Section = this;
113− settingsCategory.SetCryptoKey(m_cryptoKey);
125+ base.Properties.Add(configProperty);
126+
127+ if ((object)base[configProperty] != null)
128+ {
129+ settingsCategory = (CategorizedSettingsElementCollection)base[configProperty];
130+ settingsCategory.Name = name;
131+ settingsCategory.Section = this;
132+ settingsCategory.SetCryptoKey(m_cryptoKey);
133+ }
134+ }
135+ else
136+ {
137+ settingsCategory = m_sections.GetOrAdd(name, sectionName =>
138+ {
139+ base.Properties.Add(configProperty);
140+
141+ CategorizedSettingsElementCollection settings = new CategorizedSettingsElementCollection
142+ {
143+ Name = sectionName,
144+ Section = this,
145+ };
146+
147+ settings.SetCryptoKey(m_cryptoKey);
148+ Modified = true;
149+
150+ return settings;
151+ });
114152 }
115153
116154 return settingsCategory;
@@ -129,6 +167,15 @@ namespace GSF.Configuration · 12 unmodified lines
129167 }
130168 }
131169
170+ internal bool Modified
171+ {
172+ set
173+ {
174+ if ((object)m_sections != null && (object)m_file != null && value)
175+ m_file.m_forceSave = true;
176+ }
177+ }
178+
132179 #endregion
133180
134181 #region [ Methods ]
@@ -159,7 +206,10 @@ namespace GSF.Configuration · 24 unmodified lines
159206 }
160207
161208 // Remove category from property bag.
162− base.Properties.Remove(settingsCategory.Name);
209+ if ((object)m_sections == null)
210+ base.Properties.Remove(settingsCategory.Name);
211+ else
212+ m_sections.Remove(settingsCategory.Name);
163213 }
164214
165215 /// <summary>
@@ -181,19 +231,129 @@ namespace GSF.Configuration · 15 unmodified lines
181231 // when the category elements are being deserialized.
182232 if ((object)configSection.DocumentElement != null)
183233 {
184− XmlNodeList nodeList = configSection.DocumentElement.SelectNodes("*");
234+ XmlNodeList categories = configSection.DocumentElement.SelectNodes("*");
185235
186− if ((object)nodeList != null)
236+ if ((object)categories != null)
187237 {
188− foreach (XmlNode category in nodeList)
189− base.Properties.Add(new ConfigurationProperty(category.Name, typeof(CategorizedSettingsElementCollection)));
238+ foreach (XmlNode category in categories)
239+ {
240+ ConfigurationProperty configProperty = new ConfigurationProperty(category.Name, typeof(CategorizedSettingsElementCollection));
241+
242+ base.Properties.Add(configProperty);
243+
244+ if ((object)m_sections != null)
245+ {
246+ CategorizedSettingsElementCollection settingsCategory = new CategorizedSettingsElementCollection
247+ {
248+ Name = category.Name,
249+ Section = this,
250+ };
251+
252+ settingsCategory.SetCryptoKey(m_cryptoKey);
253+ m_sections.Add(category.Name, settingsCategory);
254+
255+ // Read all elements within this category section
256+ XmlNodeList elements = category.SelectNodes("*");
257+ SettingScope scope;
258+
259+ if ((object)elements != null)
260+ {
261+ foreach (XmlNode element in elements)
262+ {
263+ CategorizedSettingsElement categorySetting = new CategorizedSettingsElement(settingsCategory);
264+
265+ categorySetting.Name = element.GetAttributeValue("name");
266+ categorySetting.Value = element.GetAttributeValue("value");
267+ categorySetting.Description = element.GetAttributeValue("description") ?? "";
268+ categorySetting.Encrypted = element.GetAttributeValue("encrypted").ToNonNullNorWhiteSpace("false").ParseBoolean();
269+
270+ if (Enum.TryParse(element.GetAttributeValue("scope").ToNonNullNorWhiteSpace("Application"), out scope))
271+ categorySetting.Scope = scope;
272+ else
273+ categorySetting.Scope = SettingScope.Application;
274+
275+ settingsCategory.Add(categorySetting);
276+ }
277+ }
278+ }
279+ }
190280 }
191281 }
192282
193− configSectionStream.Seek(0, SeekOrigin.Begin);
283+ if ((object)m_sections == null)
284+ {
285+ configSectionStream.Seek(0, SeekOrigin.Begin);
286+ base.DeserializeSection(XmlReader.Create(configSectionStream));
287+ }
288+ }
289+ }
290+
291+ /// <summary>
292+ /// Creates an XML string containing an unmerged view of the <see cref="ConfigurationSection"/> object as a single section to write to a file.
293+ /// </summary>
294+ /// <returns>
295+ /// An XML string containing an unmerged view of the <see cref="ConfigurationSection"/> object.
296+ /// </returns>
297+ /// <param name="parentElement">The <see cref="ConfigurationElement"/> instance to use as the parent when performing the un-merge.</param>
298+ /// <param name="name">The name of the section to create.</param>
299+ /// <param name="saveMode">The <see cref="ConfigurationSaveMode"/> instance to use when writing to a string.</param>
300+ protected override string SerializeSection(ConfigurationElement parentElement, string name, ConfigurationSaveMode saveMode)
301+ {
302+ if ((object)m_sections != null)
303+ {
304+ const string tempRoot = "__tempRoot__";
305+
306+ using (BlockAllocatedMemoryStream stream = new BlockAllocatedMemoryStream())
307+ {
308+ XmlTextWriter writer = new XmlTextWriter(stream, Encoding.UTF8);
309+
310+ writer.Indentation = 2;
311+ writer.Formatting = Formatting.Indented;
312+
313+ // Add a temporary root so that indentation is at the desired level
314+ writer.WriteStartElement(tempRoot);
315+ writer.WriteStartElement(name);
194316
195− base.DeserializeSection(XmlReader.Create(configSectionStream));
317+ foreach (string section in m_sections.Keys)
318+ {
319+ CategorizedSettingsElementCollection categorySettings = this[section];
320+
321+ // Add category section
322+ writer.WriteStartElement(section);
323+
324+ // Write each category value
325+ foreach (CategorizedSettingsElement categorySetting in categorySettings)
326+ {
327+ // <add name="TestConfigParam" value="-1.0" description="Parameter description." encrypted="false" scope="User"/>
328+ writer.WriteStartElement("add");
329+
330+ writer.WriteAttributeString("name", categorySetting.Name);
331+ writer.WriteAttributeString("value", categorySetting.Value);
332+ writer.WriteAttributeString("description", categorySetting.Description ?? "");
333+ writer.WriteAttributeString("encrypted", categorySetting.Encrypted.ToString());
334+
335+ if (categorySetting.Scope == SettingScope.User)
336+ writer.WriteAttributeString("scope", categorySetting.Scope.ToString());
337+
338+ writer.WriteEndElement();
339+ }
340+
341+ writer.WriteEndElement();
342+ }
343+
344+ writer.WriteEndElement();
345+ writer.WriteEndElement();
346+
347+ writer.Flush();
348+
349+ string settings = Encoding.UTF8.GetString(stream.ToArray());
350+
351+ // Remove temporary root
352+ return settings.Replace(string.Format("<{0}>", tempRoot), "").Replace(string.Format("</{0}>", tempRoot), "");
353+ }
196354 }
355+
356+ return base.SerializeSection(parentElement, name, ConfigurationSaveMode.Full);
197357 }
198358
199359 #endregion
Source/Libraries/GSF.Core/Configuration/ConfigurationFile.cs+49−33
@@ -64,7 +64,6 @@ using System.Configuration; · 63 unmodified lines
6464 using System.Globalization;
6565 using System.IO;
6666 using System.Text;
67−using System.Threading;
6867 using System.Web.Configuration;
6968 using System.Web.Hosting;
7069 using System.Xml;
@@ -177,7 +176,6 @@ namespace GSF.Configuration · 106 unmodified lines
177176 #region [ Members ]
178177
179178 // Nested Types
180−
181179 internal class UserConfigurationFile
182180 {
183181 private readonly string m_fileName;
@@ -229,6 +227,7 @@ namespace GSF.Configuration · 45 unmodified lines
229227 public void Write(string category, string name, string value)
230228 {
231229 XmlNode node = GetSetting(category, name);
230+
232231 if ((object)node != null)
233232 {
234233 // Setting exists so update it.
@@ -242,18 +241,20 @@ namespace GSF.Configuration · 7 unmodified lines
242241 setting.SetAttributeValue("value", value);
243242 m_settings.GetXmlNode(category).AppendChild(setting);
244243 }
244+
245245 m_settingsModified = true;
246246 }
247247
248248 public string Read(string category, string name, string defaultValue)
249249 {
250250 XmlNode node = GetSetting(category, name);
251− if ((object)node != null)
252− // Setting exists so return its value.
251+
252+ // If setting exists, return its value
253+ if ((object)node != null && (object)node.Attributes != null)
253254 return node.Attributes["value"].Value;
254− else
255− // Setting doesn't exist so return the default.
256− return defaultValue;
255+
256+ // Setting doesn't exist so return the default
257+ return defaultValue;
257258 }
258259
259260 public XmlNode GetSetting(string category, string name)
@@ -272,7 +273,8 @@ namespace GSF.Configuration · 12 unmodified lines
272273 private System.Configuration.Configuration m_configuration;
273274 private UserConfigurationFile m_userConfiguration;
274275 private volatile ConfigurationSaveMode m_saveMode;
275− private LongSynchronizedOperation m_saveOperation;
276+ private readonly LongSynchronizedOperation m_saveOperation;
277+ internal bool m_forceSave;
276278
277279 #endregion
278280
@@ -288,7 +290,7 @@ namespace GSF.Configuration · 9 unmodified lines
288290
289291 m_configuration = GetConfiguration(configFilePath);
290292
291− if (m_configuration.HasFile)
293+ if (m_configuration.HasFile && File.Exists(m_configuration.FilePath))
292294 ValidateConfigurationFile(m_configuration.FilePath);
293295 else
294296 CreateConfigurationFile(m_configuration.FilePath);
@@ -364,7 +366,7 @@ namespace GSF.Configuration · 69 unmodified lines
364366 /// </summary>
365367 public void Save()
366368 {
367− Save(ConfigurationSaveMode.Modified);
369+ Save(m_forceSave ? ConfigurationSaveMode.Full : ConfigurationSaveMode.Modified);
368370 }
369371
370372 /// <summary>
@@ -373,8 +375,7 @@ namespace GSF.Configuration · 2 unmodified lines
373375 /// <param name="saveMode">One of the <see cref="ConfigurationSaveMode"/> values.</param>
374376 public void Save(ConfigurationSaveMode saveMode)
375377 {
376− if (m_saveMode == ConfigurationSaveMode.Minimal || saveMode == ConfigurationSaveMode.Full)
377− m_saveMode = saveMode;
378+ m_saveMode = saveMode;
378379
379380 // Since the static open method always returns the same instance for the same configuration files,
380381 // synchronizing the instance will sync all saves.
@@ -385,9 +386,10 @@ namespace GSF.Configuration · 4 unmodified lines
385386 {
386387 // Perform configuration save
387388 ConfigurationSaveMode saveMode = m_saveMode;
388− m_configuration.Save(saveMode);
389+ m_configuration.Save(saveMode, m_forceSave);
389390 m_userConfiguration.Save(saveMode == ConfigurationSaveMode.Full);
390391 m_saveMode = ConfigurationSaveMode.Minimal;
392+ m_forceSave = false;
391393 }
392394
393395 /// <summary>
@@ -436,7 +438,7 @@ namespace GSF.Configuration · 42 unmodified lines
436438 private System.Configuration.Configuration GetConfiguration(string configFilePath)
437439 {
438440 ApplicationType appType = Common.GetApplicationType();
439− System.Configuration.Configuration configuration = null;
441+ System.Configuration.Configuration configuration;
440442
441443 if ((object)configFilePath != null)
442444 {
@@ -475,13 +477,15 @@ namespace GSF.Configuration · 32 unmodified lines
475477 if (!string.IsNullOrEmpty(configFilePath))
476478 {
477479 XmlTextWriter configFileWriter = new XmlTextWriter(configFilePath, Encoding.UTF8);
478− configFileWriter.Indentation = 4;
480+ configFileWriter.Indentation = 2;
479481 configFileWriter.Formatting = Formatting.Indented;
482+
480483 // Populates the very basic information required in a config file.
481484 configFileWriter.WriteStartDocument();
482485 configFileWriter.WriteStartElement("configuration");
483486 configFileWriter.WriteEndElement();
484487 configFileWriter.WriteEndDocument();
488+
485489 // Closes the config file.
486490 configFileWriter.Close();
487491
@@ -505,32 +509,44 @@ namespace GSF.Configuration · 17 unmodified lines
505509 // Make sure that the config file has the necessary section information under <customSections />
506510 // that is required by the .Net configuration API to process our custom <categorizedSettings />
507511 // section. The configuration API will raise an exception if it doesn't find this section.
508− if (configFile.DocumentElement.SelectNodes("configSections").Count == 0)
512+ if ((object)configFile.DocumentElement != null)
509513 {
510− // Adds a <configSections> node, if one is not present.
511− configFile.DocumentElement.InsertBefore(configFile.CreateElement("configSections"), configFile.DocumentElement.FirstChild);
514+ XmlNodeList configSections = configFile.DocumentElement.SelectNodes("configSections");
512515
513− configFileModified = true;
514− }
515− XmlNode configSectionsNode = configFile.DocumentElement.SelectSingleNode("configSections");
516− if (configSectionsNode.SelectNodes("section[@name = \'" + CustomSectionName + "\']").Count == 0)
517− {
518− // Adds the <section> node that specifies the DLL that handles the <categorizedSettings> node in
519− // the config file, if one is not present.
520− XmlNode node = configFile.CreateElement("section");
521− node.SetAttributeValue("name", CustomSectionName);
522− node.SetAttributeValue("type", CustomSectionType);
523− configSectionsNode.AppendChild(node);
524−
525− configFileModified = true;
516+ if ((object)configSections != null && configSections.Count == 0)
517+ {
518+ // Add a <configSections> node, if one is not present.
519+ if ((object)configFile.DocumentElement != null)
520+ {
521+ // ReSharper disable once PossibleNullReferenceException
522+ configFile.DocumentElement.InsertBefore(configFile.CreateElement("configSections"), configFile.DocumentElement.FirstChild);
523+ configFileModified = true;
524+ }
525+ }
526+
527+ XmlNode configSectionsNode = configFile.DocumentElement.SelectSingleNode("configSections");
528+
529+ if ((object)configSectionsNode != null)
530+ {
531+ XmlNodeList section = configSectionsNode.SelectNodes("section[@name = \'" + CustomSectionName + "\']");
532+
533+ if ((object)section != null && section.Count == 0)
534+ {
535+ // Adds the <section> node that specifies the DLL that handles the <categorizedSettings> node in
536+ // the config file, if one is not present.
537+ XmlNode node = configFile.CreateElement("section");
538+ node.SetAttributeValue("name", CustomSectionName);
539+ node.SetAttributeValue("type", CustomSectionType);
540+ configSectionsNode.AppendChild(node);
541+ configFileModified = true;
542+ }
543+ }
526544 }
527545
528546 // 11/14/2006 - PCP: We'll save the config file only it was modified. This will prevent ASP.Net
529547 // web sites from restarting every time a configuration element is accessed.
530548 if (configFileModified)
531− {
532549 configFile.Save(configFilePath);
533− }
534550 }
535551 else
536552 {

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t