mcs/class/referencesource/System.Data/System/Data/Common/DbProviderFactoriesConfigurationHandler.cs

   1 //------------------------------------------------------------------------------
   2 // <copyright file="DbProviderFactoriesConfigurationHandler.cs" company="Microsoft">
   3 //      Copyright (c) Microsoft Corporation.  All rights reserved.
   4 // </copyright>
   5 // <owner current="true" primary="true">Microsoft</owner>
   6 // <owner current="true" primary="false">Microsoft</owner>
   7 //------------------------------------------------------------------------------
   8
   9 namespace System.Data.Common {
  10
  11     using System;
  12     using System.Collections;
  13     using System.Configuration;
  14     using System.Data;
  15     using System.Diagnostics;
  16     using System.Globalization;
  17     using System.Xml;
  18
  19     // VSTFDevDiv # 624213: System.Data.Common.DbProviderFactories.GetFactoryClasses() still gets OracleClient provider in ClientSku environment.
  20     // NOTES: As part of this bug fix, the decision was taken to make it consistent and to remove all the framework
  21     //      providers from the list in the machine.config file. The DbProviderFactories section of the machine.config will contain only
  22     //      custom providers names and details.
  23     internal enum DbProvidersIndex : int
  24     {
  25         Odbc = 0,
  26         OleDb,
  27         OracleClient,
  28         SqlClient,
  29         DbProvidersIndexCount // As enums are 0-based index, the DbProvidersIndexCount will hold the maximum count of the enum objects;
  30     }
  31
  32     internal class DbProviderFactoryConfigSection
  33     {
  34         Type factType;
  35         string name;
  36         string invariantName;
  37         string description;
  38         string assemblyQualifiedName;
  39
  40         public DbProviderFactoryConfigSection(Type FactoryType, string FactoryName, string FactoryDescription)
  41         {
  42             try
  43             {
  44                 factType = FactoryType;
  45                 name = FactoryName;
  46                 invariantName = factType.Namespace.ToString();
  47                 description = FactoryDescription;
  48                 assemblyQualifiedName = factType.AssemblyQualifiedName.ToString();
  49             }
  50             catch
  51             {
  52                 factType = null;
  53                 name = string.Empty;
  54                 invariantName = string.Empty;
  55                 description = string.Empty;
  56                 assemblyQualifiedName = string.Empty;
  57             }
  58         }
  59
  60         public DbProviderFactoryConfigSection(string FactoryName, string FactoryInvariantName, string FactoryDescription, string FactoryAssemblyQualifiedName)
  61         {
  62             factType = null;
  63             name = FactoryName;
  64             invariantName = FactoryInvariantName;
  65             description = FactoryDescription;
  66             assemblyQualifiedName = FactoryAssemblyQualifiedName;
  67         }
  68
  69         public bool IsNull()
  70         {
  71             if ((factType == null) && (invariantName == string.Empty))
  72                 return true;
  73             else
  74                 return false;
  75         }
  76
  77         public string Name
  78         {
  79             get { return name; }
  80         }
  81
  82         public string InvariantName
  83         {
  84             get { return invariantName; }
  85         }
  86
  87         public string Description
  88         {
  89             get { return description; }
  90         }
  91
  92         public string AssemblyQualifiedName
  93         {
  94             get { return assemblyQualifiedName; }
  95         }
  96     }
  97
  98     // <configSections>
  99     //     <section name="system.data" type="System.Data.Common.DbProviderFactoriesConfigurationHandler, System.Data, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%ECMA_PUBLICKEY%" />
 100     // </configSections>
 101     // <system.data>
 102     //     <DbProviderFactories>
 103     //         <add name="Odbc Data Provider"         invariant="System.Data.Odbc"         support="1BF" description=".Net Framework Data Provider for Odbc"      type="System.Data.Odbc.OdbcFactory, System.Data, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%ECMA_PUBLICKEY%"/>
 104     //         <add name="OleDb Data Provider"        invariant="System.Data.OleDb"        support="1BF" description=".Net Framework Data Provider for OleDb"     type="System.Data.OleDb.OleDbFactory, System.Data, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%ECMA_PUBLICKEY%"/>
 105     //         <add name="OracleClient Data Provider" invariant="System.Data.OracleClient" support="1AF" description=".Net Framework Data Provider for Oracle"    type="System.Data.OracleClient.OracleFactory, System.Data.OracleClient, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%ECMA_PUBLICKEY%"/>
 106     //         <add name="SqlClient Data Provider"    invariant="System.Data.SqlClient"    support="1FF" description=".Net Framework Data Provider for SqlServer" type="System.Data.SqlClient.SqlClientFactory, System.Data, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%ECMA_PUBLICKEY%"/>
 107     //     </DbProviderFactories>
 108     // </system.data>
 109     // this class is delayed created, use ConfigurationSettings.GetSection("system.data") to obtain
 110     public class DbProviderFactoriesConfigurationHandler : IConfigurationSectionHandler { // V1.2.3300
 111         internal const string sectionName = "system.data";
 112         internal const string providerGroup = "DbProviderFactories";
 113
 114         // NOTES: Framework-Based DbProviderFactories Details
 115         internal const string odbcProviderName = "Odbc Data Provider";
 116         internal const string odbcProviderDescription = ".Net Framework Data Provider for Odbc";
 117
 118         internal const string oledbProviderName = "OleDb Data Provider";
 119         internal const string oledbProviderDescription = ".Net Framework Data Provider for OleDb";
 120
 121         internal const string oracleclientProviderName = "OracleClient Data Provider";
 122         internal const string oracleclientProviderNamespace = "System.Data.OracleClient";
 123         internal const string oracleclientProviderDescription = ".Net Framework Data Provider for Oracle";
 124
 125         internal const string sqlclientProviderName = "SqlClient Data Provider";
 126         internal const string sqlclientProviderDescription = ".Net Framework Data Provider for SqlServer";
 127
 128         internal const string sqlclientPartialAssemblyQualifiedName = "System.Data.SqlClient.SqlClientFactory, System.Data,";
 129         internal const string oracleclientPartialAssemblyQualifiedName = "System.Data.OracleClient.OracleClientFactory, System.Data.OracleClient,";
 130
 131         public DbProviderFactoriesConfigurationHandler() { // V1.2.3300
 132         }
 133
 134         virtual public object Create(object parent, object configContext, XmlNode section) { // V1.2.3300
 135 #if DEBUG
 136             try {
 137 #endif
 138                 return CreateStatic(parent, configContext, section);
 139 #if DEBUG
 140             }
 141             catch(Exception e) {
 142                 ADP.TraceExceptionWithoutRethrow(e); // it will be rethrown
 143                 throw;
 144             }
 145 #endif
 146         }
 147
 148         static internal object CreateStatic(object parent, object configContext, XmlNode section) {
 149             object config = parent;
 150             if (null != section) {
 151                 config = HandlerBase.CloneParent(parent as DataSet, false);
 152                 bool foundFactories = false;
 153
 154                 HandlerBase.CheckForUnrecognizedAttributes(section);
 155                 foreach (XmlNode child in section.ChildNodes) {
 156                     if (HandlerBase.IsIgnorableAlsoCheckForNonElement(child)) {
 157                         continue;
 158                     }
 159                     string sectionGroup = child.Name;
 160                     switch(sectionGroup) {
 161                     case DbProviderFactoriesConfigurationHandler.providerGroup:
 162                         if (foundFactories) {
 163                             throw ADP.ConfigSectionsUnique(DbProviderFactoriesConfigurationHandler.providerGroup);
 164                         }
 165                         foundFactories = true;
 166                         HandleProviders(config as DataSet, configContext, child, sectionGroup);
 167                         break;
 168                     default:
 169                         throw ADP.ConfigUnrecognizedElement(child);
 170                     }
 171                 }
 172             }
 173             return config;
 174         }
 175
 176         // sectionName - i.e. "providerconfiguration"
 177         private static void HandleProviders(DataSet config, object configContext, XmlNode section, string sectionName) {
 178             DataTableCollection tables = config.Tables;
 179             DataTable dataTable = tables[sectionName];
 180             bool tableExisted = (null != dataTable);
 181             dataTable = DbProviderDictionarySectionHandler.CreateStatic(dataTable, configContext, section);
 182             if (!tableExisted) {
 183                 tables.Add(dataTable);
 184             }
 185         }
 186
 187         // based off of DictionarySectionHandler
 188         private static class DbProviderDictionarySectionHandler/* : IConfigurationSectionHandler*/ {
 189             /*
 190             internal DbProviderDictionarySectionHandler() {
 191             }
 192
 193             public object Create(Object parent, Object context, XmlNode section) {
 194                 return CreateStatic(parent, context, section);
 195             }
 196             */
 197
 198             static internal DataTable CreateStatic(DataTable config, Object context, XmlNode section) {
 199                 if (null != section) {
 200                     HandlerBase.CheckForUnrecognizedAttributes(section);
 201
 202                     if (null == config) {
 203                         config = DbProviderFactoriesConfigurationHandler.CreateProviderDataTable();
 204                     }
 205                     // else already copied via DataSet.Copy
 206
 207                     foreach (XmlNode child in section.ChildNodes) {
 208                         if (HandlerBase.IsIgnorableAlsoCheckForNonElement(child)) {
 209                             continue;
 210                         }
 211                         switch(child.Name) {
 212                         case "add":
 213                             HandleAdd(child, config);
 214                             break;
 215                         case "remove":
 216                             HandleRemove(child, config);
 217                             break;
 218                         case "clear":
 219                             HandleClear(child, config);
 220                             break;
 221                         default:
 222                             throw ADP.ConfigUnrecognizedElement(child);
 223                         }
 224                     }
 225                     config.AcceptChanges();
 226                 }
 227                 return config;
 228             }
 229             static private void HandleAdd(XmlNode child, DataTable config) {
 230                 HandlerBase.CheckForChildNodes(child);
 231                 DataRow values = config.NewRow();
 232                 values[0] = HandlerBase.RemoveAttribute(child, "name", true, false);
 233                 values[1] = HandlerBase.RemoveAttribute(child, "description", true, false);
 234                 values[2] = HandlerBase.RemoveAttribute(child, "invariant", true, false);
 235                 values[3] = HandlerBase.RemoveAttribute(child, "type", true, false);
 236
 237                 // because beta shipped recognizing "support=hex#", need to give
 238                 // more time for other providers to remove it from the .config files
 239                 HandlerBase.RemoveAttribute(child, "support", false, false);
 240
 241                 HandlerBase.CheckForUnrecognizedAttributes(child);
 242                 config.Rows.Add(values);
 243             }
 244             static private void HandleRemove(XmlNode child, DataTable config) {
 245                 HandlerBase.CheckForChildNodes(child);
 246                 String invr = HandlerBase.RemoveAttribute(child, "invariant", true, false);
 247                 HandlerBase.CheckForUnrecognizedAttributes(child);
 248                 DataRow row = config.Rows.Find(invr);
 249                 if (null != row) { // ignore invariants that don't exist
 250                     row.Delete();
 251                 }
 252             }
 253             static private void HandleClear(XmlNode child, DataTable config) {
 254                 HandlerBase.CheckForChildNodes(child);
 255                 HandlerBase.CheckForUnrecognizedAttributes(child);
 256                 config.Clear();
 257             }
 258         }
 259
 260         internal static DataTable CreateProviderDataTable() {
 261             DataColumn frme = new DataColumn("Name", typeof(string));
 262             frme.ReadOnly = true;
 263             DataColumn desc = new DataColumn("Description", typeof(string));
 264             desc.ReadOnly = true;
 265             DataColumn invr = new DataColumn("InvariantName", typeof(string));
 266             invr.ReadOnly = true;
 267             DataColumn qual = new DataColumn("AssemblyQualifiedName", typeof(string));
 268             qual.ReadOnly = true;
 269
 270             DataColumn[] primaryKey = new DataColumn[] { invr };
 271             DataColumn[] columns = new DataColumn[] {frme, desc, invr, qual };
 272             DataTable table = new DataTable(DbProviderFactoriesConfigurationHandler.providerGroup);
 273             table.Locale = CultureInfo.InvariantCulture;
 274             table.Columns.AddRange(columns);
 275             table.PrimaryKey = primaryKey;
 276             return table;
 277         }
 278     }
 279 }
 280