ActiveRecord/Castle.ActiveRecord/Framework/Config/XmlConfigurationSource.cs

   1 // Copyright 2004-2008 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.ActiveRecord.Framework.Config
  16 {
  17         using System;
  18         using System.Collections;
  19         using System.Collections.Specialized;
  20         using System.Configuration;
  21         using System.IO;
  22         using System.Xml;
  23
  24         /// <summary>
  25         /// Source of configuration based on Xml
  26         /// source like files, streams or readers.
  27         /// </summary>
  28         public class XmlConfigurationSource : InPlaceConfigurationSource
  29         {
  30                 /// <summary>
  31                 /// Initializes a new instance of the <see cref="XmlConfigurationSource"/> class.
  32                 /// </summary>
  33                 protected XmlConfigurationSource()
  34                 {
  35                 }
  36
  37                 /// <summary>
  38                 /// Initializes a new instance of the <see cref="XmlConfigurationSource"/> class.
  39                 /// </summary>
  40                 /// <param name="xmlFileName">Name of the XML file.</param>
  41                 public XmlConfigurationSource(String xmlFileName)
  42                 {
  43                         XmlDocument doc = new XmlDocument();
  44                         doc.Load(xmlFileName);
  45                         PopulateSource(doc.DocumentElement);
  46                 }
  47
  48                 /// <summary>
  49                 /// Initializes a new instance of the <see cref="XmlConfigurationSource"/> class.
  50                 /// </summary>
  51                 /// <param name="stream">The stream.</param>
  52                 public XmlConfigurationSource(Stream stream)
  53                 {
  54                         XmlDocument doc = new XmlDocument();
  55                         doc.Load(stream);
  56                         PopulateSource(doc.DocumentElement);
  57                 }
  58
  59                 /// <summary>
  60                 /// Initializes a new instance of the <see cref="XmlConfigurationSource"/> class.
  61                 /// </summary>
  62                 /// <param name="reader">The reader.</param>
  63                 public XmlConfigurationSource(TextReader reader)
  64                 {
  65                         XmlDocument doc = new XmlDocument();
  66                         doc.Load(reader);
  67                         PopulateSource(doc.DocumentElement);
  68                 }
  69
  70                 /// <summary>
  71                 /// Populate this instance with values from the given XML node
  72                 /// </summary>
  73                 protected void PopulateSource(XmlNode section)
  74                 {
  75                         XmlAttribute isWebAtt = section.Attributes["isWeb"];
  76                         XmlAttribute threadInfoAtt = section.Attributes["threadinfotype"];
  77                         XmlAttribute isDebug = section.Attributes["isDebug"];
  78                         XmlAttribute lazyByDefault = section.Attributes["default-lazy"];
  79                         XmlAttribute pluralize = section.Attributes["pluralizeTableNames"];
  80                         XmlAttribute verifyModelsAgainstDBSchemaAtt = section.Attributes["verifyModelsAgainstDBSchema"];
  81
  82                         SetUpThreadInfoType(isWebAtt != null && "true" == isWebAtt.Value,
  83                                             threadInfoAtt != null ? threadInfoAtt.Value : String.Empty);
  84
  85                         XmlAttribute sessionfactoryholdertypeAtt =
  86                                 section.Attributes["sessionfactoryholdertype"];
  87
  88                         SetUpSessionFactoryHolderType(sessionfactoryholdertypeAtt != null
  89                                                         ?
  90                                                       sessionfactoryholdertypeAtt.Value
  91                                                         : String.Empty);
  92
  93                         XmlAttribute namingStrategyTypeAtt = section.Attributes["namingstrategytype"];
  94
  95                         SetUpNamingStrategyType(namingStrategyTypeAtt != null ? namingStrategyTypeAtt.Value : String.Empty);
  96
  97                         SetDebugFlag(ConvertBool(isDebug));
  98
  99                         SetIsLazyByDefault(ConvertBool(lazyByDefault));
 100
 101                         SetPluralizeTableNames(ConvertBool(pluralize));
 102
 103                         SetVerifyModelsAgainstDBSchema(verifyModelsAgainstDBSchemaAtt != null && verifyModelsAgainstDBSchemaAtt.Value == "true");
 104
 105                         PopulateConfigNodes(section);
 106                 }
 107
 108                 private void PopulateConfigNodes(XmlNode section)
 109                 {
 110                         const string Config_Node_Name = "config";
 111
 112                         foreach(XmlNode node in section.ChildNodes)
 113                         {
 114                                 if (node.NodeType != XmlNodeType.Element) continue;
 115
 116                                 if (!Config_Node_Name.Equals(node.Name))
 117                                 {
 118                                         String message = String.Format("Unexpected node. Expect '{0}' found '{1}'",
 119                                                                        Config_Node_Name, node.Name);
 120
 121                                         throw new ConfigurationErrorsException(message);
 122                                 }
 123
 124                                 Type targetType = typeof(ActiveRecordBase);
 125
 126                                 if (node.Attributes.Count != 0)
 127                                 {
 128                                         XmlAttribute typeNameAtt = node.Attributes["type"];
 129
 130                                         if (typeNameAtt == null)
 131                                         {
 132                                                 String message = String.Format("Invalid attribute at node '{0}'. " +
 133                                                                                "The only supported attribute is 'type'", Config_Node_Name);
 134
 135                                                 throw new ConfigurationErrorsException(message);
 136                                         }
 137
 138                                         String typeName = typeNameAtt.Value;
 139
 140                                         targetType = Type.GetType(typeName, false, false);
 141
 142                                         if (targetType == null)
 143                                         {
 144                                                 String message = String.Format("Could not obtain type from name '{0}'", typeName);
 145
 146                                                 throw new ConfigurationErrorsException(message);
 147                                         }
 148                                 }
 149
 150                                 Add(targetType, BuildProperties(node));
 151                         }
 152                 }
 153
 154                 /// <summary>
 155                 /// Builds the configuration properties.
 156                 /// </summary>
 157                 /// <param name="node">The node.</param>
 158                 /// <returns></returns>
 159                 protected IDictionary BuildProperties(XmlNode node)
 160                 {
 161                         HybridDictionary dict = new HybridDictionary();
 162
 163                         foreach(XmlNode addNode in node.SelectNodes("add"))
 164                         {
 165                                 XmlAttribute keyAtt = addNode.Attributes["key"];
 166                                 XmlAttribute valueAtt = addNode.Attributes["value"];
 167
 168                                 if (keyAtt == null || valueAtt == null)
 169                                 {
 170                                         String message = String.Format("For each 'add' element you must specify 'key' and 'value' attributes");
 171
 172                                         throw new ConfigurationErrorsException(message);
 173                                 }
 174                                 string value = valueAtt.Value;
 175
 176                                 dict.Add(keyAtt.Value, value);
 177                         }
 178
 179                         return dict;
 180                 }
 181
 182                 private static bool ConvertBool(XmlNode boolAttrib)
 183                 {
 184                         return boolAttrib != null && "true".Equals(boolAttrib.Value, StringComparison.OrdinalIgnoreCase);
 185                 }
 186         }
 187 }