mcs/class/System/System.Configuration/Configuration.cs

   1 //
   2 // System.Configuration.ConfigurationLocation.cs
   3 //
   4 // Authors:
   5 //      Duncan Mak (duncan@ximian.com)
   6 //  Lluis Sanchez Gual (lluis@novell.com)
   7 //
   8 // Permission is hereby granted, free of charge, to any person obtaining
   9 // a copy of this software and associated documentation files (the
  10 // "Software"), to deal in the Software without restriction, including
  11 // without limitation the rights to use, copy, modify, merge, publish,
  12 // distribute, sublicense, and/or sell copies of the Software, and to
  13 // permit persons to whom the Software is furnished to do so, subject to
  14 // the following conditions:
  15 //
  16 // The above copyright notice and this permission notice shall be
  17 // included in all copies or substantial portions of the Software.
  18 //
  19 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  20 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  21 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  22 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  23 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  24 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  25 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26 //
  27 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  28 //
  29 #if NET_2_0 && XML_DEP
  30 using System;
  31 using System.Collections;
  32 using System.Collections.Specialized;
  33 using System.Xml;
  34 using System.IO;
  35
  36 namespace System.Configuration {
  37
  38         public sealed class Configuration
  39         {
  40                 Configuration parent;
  41                 Hashtable elementData = new Hashtable ();
  42                 string fileName;
  43                 ConfigurationSectionGroup rootSectionGroup;
  44                 ConfigurationLocationCollection locations;
  45                 SectionGroupInfo rootGroup;
  46
  47                 internal Configuration (): this (null, null)
  48                 {
  49                 }
  50
  51                 internal Configuration (string file): this (file, null)
  52                 {
  53                 }
  54
  55                 internal Configuration (Configuration parent): this (null, parent)
  56                 {
  57                 }
  58
  59                 internal Configuration (string file, Configuration parent)
  60                 {
  61                         fileName = file;
  62                         this.parent = parent;
  63                         if (parent != null)
  64                                 rootGroup = parent.rootGroup;
  65                         else {
  66                                 rootGroup = new SectionGroupInfo ();
  67                                 rootGroup.FileName = file;
  68                         }
  69
  70                         if (file != null) Load (file);
  71                 }
  72
  73                 internal Configuration Parent {
  74                         get { return parent; }
  75                 }
  76
  77                 internal string FileName {
  78                         get { return fileName; }
  79                 }
  80
  81                 public AppSettingsSection AppSettings {
  82                         get { return Sections ["appSettings"] as AppSettingsSection; }
  83                 }
  84
  85                 [MonoTODO]
  86                 public PathLevel ConfigurationPathLevel {
  87                         get { throw new NotImplementedException (); }
  88                 }
  89
  90                 [MonoTODO]
  91                 public ConnectionStringsSection ConnectionStrings {
  92                         get { throw new NotImplementedException (); }
  93                 }
  94
  95                 [MonoTODO]
  96                 public string FilePath {
  97                         get { throw new NotImplementedException (); }
  98                 }
  99
 100                 [MonoTODO]
 101                 public bool HasFile {
 102                         get { throw new NotImplementedException (); }
 103                 }
 104
 105                 public ConfigurationLocationCollection Locations {
 106                         get {
 107                                 if (locations == null) locations = new ConfigurationLocationCollection ();
 108                                 return locations;
 109                         }
 110                 }
 111
 112                 [MonoTODO]
 113                 public string Path {
 114                         get { throw new NotImplementedException (); }
 115                 }
 116
 117                 public ConfigurationSectionGroup RootSectionGroup {
 118                         get {
 119                                 if (rootSectionGroup == null) {
 120                                         rootSectionGroup = new ConfigurationSectionGroup ();
 121                                         rootSectionGroup.Initialize (this, rootGroup);
 122                                 }
 123                                 return rootSectionGroup;
 124                         }
 125                 }
 126
 127                 public ConfigurationSectionGroupCollection SectionGroups {
 128                         get { return RootSectionGroup.SectionGroups; }
 129                 }
 130
 131                 public ConfigurationSectionCollection Sections {
 132                         get { return RootSectionGroup.Sections; }
 133                 }
 134
 135                 public static Configuration GetExeConfiguration (string path, ConfigurationUserLevel level)
 136                 {
 137                         return new Configuration (path + ".config", GetMachineConfiguration ());
 138                 }
 139
 140                 public static Configuration GetMachineConfiguration ()
 141                 {
 142                         return GetMachineConfiguration (System.Runtime.InteropServices.RuntimeEnvironment.SystemConfigurationFile);
 143                 }
 144
 145                 public static Configuration GetMachineConfiguration (string path)
 146                 {
 147                         return new Configuration (path);
 148                 }
 149
 150                 [MonoTODO]
 151                 public static Configuration GetMachineConfiguration (string path, string server)
 152                 {
 153                         throw new NotImplementedException ();
 154                 }
 155
 156                 [MonoTODO]
 157                 public static Configuration GetMachineConfiguration (
 158                                                 string path, string server, IntPtr user_token)
 159                 {
 160                         throw new NotImplementedException ();
 161                 }
 162
 163                 [MonoTODO]
 164                 public static Configuration GetMachineConfiguration (
 165                                                 string path, string server, string username, string password)
 166                 {
 167                         throw new NotImplementedException ();
 168                 }
 169
 170                 [MonoTODO]
 171                 public static Configuration GetWebConfiguration ()
 172                 {
 173                         throw new NotImplementedException ();
 174                 }
 175
 176                 [MonoTODO]
 177                 public static Configuration GetWebConfiguration (string path)
 178                 {
 179                         return new Configuration (path, GetMachineConfiguration ());
 180                 }
 181
 182                 [MonoTODO]
 183                 public static Configuration GetWebConfiguration (string path, string site)
 184                 {
 185                         throw new NotImplementedException ();
 186                 }
 187
 188                 [MonoTODO]
 189                 public static Configuration GetWebConfiguration (string path, string site, string subpath)
 190                 {
 191                         throw new NotImplementedException ();
 192                 }
 193
 194                 [MonoTODO]
 195                 public static Configuration GetWebConfiguration (
 196                                                 string path, string site, string subpath, string server)
 197                 {
 198                         throw new NotImplementedException ();
 199                 }
 200
 201                 [MonoTODO]
 202                 public static Configuration GetWebConfiguration (
 203                                                 string path, string site, string subpath, string server, IntPtr user_token)
 204                 {
 205                         throw new NotImplementedException ();
 206                 }
 207
 208                 [MonoTODO]
 209                 public static Configuration GetWebConfiguration (
 210                                                 string path, string site, string subpath, string server, string username, string password)
 211                 {
 212                         throw new NotImplementedException ();
 213                 }
 214
 215                 internal ConfigurationSection GetSectionInstance (SectionInfo config, bool createDefaultInstance)
 216                 {
 217                         object data = elementData [config];
 218                         ConfigurationSection sec = data as ConfigurationSection;
 219                         if (sec != null || !createDefaultInstance) return sec;
 220
 221                         object secObj = config.CreateInstance () as ConfigurationSection;
 222                         if (!(secObj is ConfigurationSection))
 223                                 sec = new RuntimeOnlySection ();
 224                         else {
 225                                 sec = (ConfigurationSection) secObj;
 226                         }
 227
 228                         ConfigurationSection parentSection = parent != null ? parent.GetSectionInstance (config, true) : null;
 229                         sec.RawXml = data as string;
 230                         sec.SetPath (config.XPath);
 231                         sec.Reset (parentSection, this);
 232
 233                         if (data != null) {
 234                                 XmlTextReader r = new XmlTextReader (new StringReader (data as string));
 235                                 sec.ReadXml (r, this);
 236                                 r.Close ();
 237                         }
 238
 239                         elementData [config] = sec;
 240                         return sec;
 241                 }
 242
 243                 internal ConfigurationSectionGroup GetSectionGroupInstance (SectionGroupInfo group)
 244                 {
 245                         ConfigurationSectionGroup gr = group.CreateInstance () as ConfigurationSectionGroup;
 246                         if (gr != null) gr.Initialize (this, group);
 247                         return gr;
 248                 }
 249
 250                 internal void SetConfigurationSection (SectionInfo config, ConfigurationSection sec)
 251                 {
 252                         elementData [config] = sec;
 253                 }
 254
 255                 internal void SetSectionXml (SectionInfo config, string data)
 256                 {
 257                         elementData [config] = data;
 258                 }
 259
 260                 internal string GetSectionXml (SectionInfo config)
 261                 {
 262                         return elementData [config] as string;
 263                 }
 264
 265                 internal void CreateSection (SectionGroupInfo group, string name, ConfigurationSection sec)
 266                 {
 267                         if (group.HasChild (name)) throw new ConfigurationException ("Cannot add a ConfigurationSection. A section or section group already exists with the name '" + name + "'");
 268                         if (sec.TypeName == null) sec.TypeName = sec.GetType ().AssemblyQualifiedName;
 269                         sec.SetName (name);
 270
 271                         SectionInfo section = new SectionInfo (name, sec.TypeName, sec.AllowLocation, sec.AllowDefinition);
 272                         section.FileName = FileName;
 273                         group.AddChild (section);
 274                         elementData [section] = sec;
 275                         sec.SetPath (section.XPath);
 276                 }
 277
 278                 internal void CreateSectionGroup (SectionGroupInfo parentGroup, string name, ConfigurationSectionGroup sec)
 279                 {
 280                         if (parentGroup.HasChild (name)) throw new ConfigurationException ("Cannot add a ConfigurationSectionGroup. A section or section group already exists with the name '" + name + "'");
 281                         if (sec.TypeName == null) sec.TypeName = sec.GetType ().AssemblyQualifiedName;
 282                         sec.SetName (name);
 283
 284                         SectionGroupInfo section = new SectionGroupInfo (name, sec.TypeName);
 285                         section.FileName = FileName;
 286                         parentGroup.AddChild (section);
 287                         elementData [section] = sec;
 288                 }
 289
 290                 internal void RemoveConfigInfo (ConfigInfo config)
 291                 {
 292                         elementData.Remove (config);
 293                 }
 294
 295                 public void Update ()
 296                 {
 297                         Update (ConfigurationUpdateMode.Modified, false);
 298                 }
 299
 300                 public void Update (ConfigurationUpdateMode mode)
 301                 {
 302                         Update (mode, false);
 303                 }
 304
 305                 [MonoTODO ("Detect if file has changed")]
 306                 public void Update (ConfigurationUpdateMode mode, bool forceUpdateAll)
 307                 {
 308                         XmlTextWriter tw = new XmlTextWriter (new StreamWriter (fileName));
 309                         tw.Formatting = Formatting.Indented;
 310                         try {
 311                                 tw.WriteStartElement ("configuration");
 312                                 if (rootGroup.HasConfigContent (this)) {
 313                                         rootGroup.WriteConfig (this, tw, mode);
 314                                 }
 315                                 rootGroup.WriteRootData (tw, this, mode);
 316                                 tw.WriteEndElement ();
 317                         }
 318                         finally {
 319                                 tw.Close ();
 320                         }
 321                 }
 322
 323                 internal bool Load (string fileName)
 324                 {
 325                         this.fileName = fileName;
 326                         if (!File.Exists (fileName))
 327                                 throw new ConfigurationException ("File '" + fileName + "' not found");
 328 #if (XML_DEP)
 329                         XmlTextReader reader = null;
 330
 331                         try {
 332                                 FileStream fs = new FileStream (fileName, FileMode.Open, FileAccess.Read);
 333                                 reader = new XmlTextReader (fs);
 334                                 ReadConfigFile (reader, fileName);
 335 /*                      } catch (ConfigurationException) {
 336                                 throw;
 337                         } catch (Exception e) {
 338                                 throw new ConfigurationException ("Error reading " + fileName, e);
 339 */                      } finally {
 340                                 if (reader != null)
 341                                         reader.Close();
 342                         }
 343 #endif
 344                         return true;
 345                 }
 346
 347 #if (XML_DEP)
 348
 349                 internal void ReadConfigFile (XmlTextReader reader, string fileName)
 350                 {
 351                         reader.MoveToContent ();
 352                         if (reader.NodeType != XmlNodeType.Element || reader.Name != "configuration")
 353                                 ThrowException ("Configuration file does not have a valid root element", reader);
 354
 355                         if (reader.HasAttributes)
 356                                 ThrowException ("Unrecognized attribute in root element", reader);
 357
 358                         if (reader.IsEmptyElement) {
 359                                 reader.Skip ();
 360                                 return;
 361                         }
 362
 363                         reader.ReadStartElement ();
 364                         reader.MoveToContent ();
 365
 366                         if (reader.LocalName == "configSections") {
 367                                 if (reader.HasAttributes)
 368                                         ThrowException ("Unrecognized attribute in <configSections>.", reader);
 369
 370                                 rootGroup.ReadConfig (this, reader);
 371                         }
 372
 373                         rootGroup.ReadRootData (reader, this);
 374                 }
 375
 376 #endif
 377
 378                 private void ThrowException (string text, XmlTextReader reader)
 379                 {
 380                         throw new ConfigurationException (text, fileName, reader.LineNumber);
 381                 }
 382         }
 383 }
 384
 385 #endif