We need you! We're working hard on the next version of Developer Fusion - Let us know what you think we should be up to!

The Labs \ Source Viewer \ SSCLI \ System.Configuration \ BaseConfigurationRecord

SSCLI
  1. //------------------------------------------------------------------------------
  2. // <copyright file="BaseConfigurationRecord.cs" company="Microsoft">
  3. //
  4. // Copyright (c) 2006 Microsoft Corporation. All rights reserved.
  5. //
  6. // The use and distribution terms for this software are contained in the file
  7. // named license.txt, which can be found in the root of this distribution.
  8. // By using this software in any fashion, you are agreeing to be bound by the
  9. // terms of this license.
  10. //
  11. // You must not remove this notice, or any other, from this software.
  12. //
  13. // </copyright>
  14. //------------------------------------------------------------------------------
  16. namespace System.Configuration
  17. {
  18.     using System.Configuration.Internal;
  19.     using System.Collections;
  20.     using System.Collections.Generic;
  21.     using System.Collections.Specialized;
  22.     using System.Configuration;
  23.     using System.Globalization;
  24.     using System.IO;
  25.     using System.Reflection;
  26.     using System.Runtime.InteropServices;
  27.     using System.Security.Permissions;
  28.     using System.Security;
  29.     using System.Text;
  30.     using System.Xml;
  31.    
  32.     //
  33.     // This object represents the configuration for a request path, and is cached per-path.
  34.     //
  35.     internal abstract class BaseConfigurationRecord : IInternalConfigRecord
  36.     {
  37.         protected const string NL = "\r\n";
  38.         protected const string KEYWORD_TRUE = "true";
  39.         protected const string KEYWORD_FALSE = "false";
  40.         protected const string KEYWORD_CONFIGURATION = "configuration";
  41.         protected const string KEYWORD_CONFIGURATION_NAMESPACE = "http://schemas.microsoft.com/.NetConfiguration/v2.0";
  42.         protected const string KEYWORD_CONFIGSECTIONS = "configSections";
  43.         protected const string KEYWORD_SECTION = "section";
  44.         protected const string KEYWORD_SECTION_NAME = "name";
  45.         protected const string KEYWORD_SECTION_TYPE = "type";
  46.         protected const string KEYWORD_SECTION_ALLOWLOCATION = "allowLocation";
  47.         protected const string KEYWORD_SECTION_ALLOWDEFINITION = "allowDefinition";
  48.         protected const string KEYWORD_SECTION_ALLOWDEFINITION_EVERYWHERE = "Everywhere";
  49.         protected const string KEYWORD_SECTION_ALLOWDEFINITION_MACHINEONLY = "MachineOnly";
  50.         protected const string KEYWORD_SECTION_ALLOWDEFINITION_MACHINETOAPPLICATION = "MachineToApplication";
  51.         protected const string KEYWORD_SECTION_ALLOWDEFINITION_MACHINETOWEBROOT = "MachineToWebRoot";
  52.         protected const string KEYWORD_SECTION_ALLOWEXEDEFINITION = "allowExeDefinition";
  53.         protected const string KEYWORD_SECTION_ALLOWEXEDEFINITION_MACHTOROAMING = "MachineToRoamingUser";
  54.         protected const string KEYWORD_SECTION_ALLOWEXEDEFINITION_MACHTOLOCAL = "MachineToLocalUser";
  55.         protected const string KEYWORD_SECTION_RESTARTONEXTERNALCHANGES = "restartOnExternalChanges";
  56.         protected const string KEYWORD_SECTION_REQUIREPERMISSION = "requirePermission";
  57.         protected const string KEYWORD_SECTIONGROUP = "sectionGroup";
  58.         protected const string KEYWORD_SECTIONGROUP_NAME = "name";
  59.         protected const string KEYWORD_SECTIONGROUP_TYPE = "type";
  60.         protected const string KEYWORD_REMOVE = "remove";
  61.         protected const string KEYWORD_CLEAR = "clear";
  62.         protected const string KEYWORD_LOCATION = "location";
  63.         protected const string KEYWORD_LOCATION_PATH = "path";
  64.         protected const string KEYWORD_LOCATION_ALLOWOVERRIDE = "allowOverride";
  65.         protected const string KEYWORD_LOCATION_INHERITINCHILDAPPLICATIONS = "inheritInChildApplications";
  66.         protected const string KEYWORD_CONFIGSOURCE = "configSource";
  67.         protected const string KEYWORD_XMLNS = "xmlns";
  68.         internal const string KEYWORD_PROTECTION_PROVIDER = "configProtectionProvider";
  69.        
  70.         protected const string FORMAT_NEWCONFIGFILE = "<?xml version=\"1.0\" encoding=\"{0}\"?>\r\n";
  71.         protected const string FORMAT_CONFIGURATION = "<configuration>\r\n";
  72.         protected const string FORMAT_CONFIGURATION_NAMESPACE = "<configuration xmlns=\"{0}\">\r\n";
  73.         protected const string FORMAT_CONFIGURATION_ENDELEMENT = "</configuration>";
  74.        
  75.         protected const string FORMAT_LOCATION_NOPATH = "<location allowOverride=\"{0}\" inheritInChildApplications=\"{1}\">\r\n";
  76.         protected const string FORMAT_LOCATION_PATH = "<location path=\"{2}\" allowOverride=\"{0}\" inheritInChildApplications=\"{1}\">\r\n";
  77.         protected const string FORMAT_LOCATION_ENDELEMENT = "</location>";
  78.        
  79.         protected const string FORMAT_SECTION_CONFIGSOURCE = "<{0} configSource=\"{1}\" />";
  80.         protected const string FORMAT_CONFIGSOURCE_FILE = "<?xml version=\"1.0\" encoding=\"{0}\"?>\r\n";
  81.        
  82.         protected const string FORMAT_SECTIONGROUP_ENDELEMENT = "</sectionGroup>";
  83.        
  84.         // Class flags should only be used with the ClassFlags property.
  85.         protected const int ClassSupportsChangeNotifications = 1;
  86.         protected const int ClassSupportsRefresh = 2;
  87.         protected const int ClassSupportsImpersonation = 4;
  88.         protected const int ClassSupportsRestrictedPermissions = 8;
  89.         protected const int ClassSupportsKeepInputs = 16;
  90.         protected const int ClassSupportsDelayedInit = 32;
  91.         protected const int ClassIgnoreLocalErrors = 64;
  92.        
  93.         // Flags to use with the _flags field.
  94.         protected const int ProtectedDataInitialized = 1;
  95.         protected const int Closed = 2;
  96.         protected const int PrefetchAll = 8;
  97.         protected const int IsAboveApplication = 32;
  98.         private const int ContextEvaluated = 128;
  99.         private const int IsLocationListResolved = 256;
  100.         protected const int NamespacePresentInFile = 512;
  101.        
  102.        
  103.         private const int RestrictedPermissionsResolved = 2048;
  104.        
  105.         protected const int IsTrusted = 8192;
  106.        
  107.         protected const int SupportsChangeNotifications = 65536;
  108.         protected const int SupportsRefresh = 131072;
  109.         protected const int SupportsPath = 262144;
  110.         protected const int SupportsKeepInputs = 524288;
  111.         protected const int SupportsLocation = 1048576;
  112.        
  113.         // Flags for Mgmt Configuration Record
  114.         protected const int ForceLocationWritten = 16777216;
  115.         protected const int SuggestLocationRemoval = 33554432;
  116.         protected const int NamespacePresentCurrent = 67108864;
  117.        
  118.         internal const char ConfigPathSeparatorChar = '/';
  119.         internal const string ConfigPathSeparatorString = "/";
  120.         static internal readonly char[] ConfigPathSeparatorParams = new char[] {ConfigPathSeparatorChar};
  121.        
  122.         private static ConfigurationPermission s_unrestrictedConfigPermission;
  123.         // cached ConfigurationPermission
  124.         protected SafeBitVector32 _flags;
  125.         // state
  126.         protected BaseConfigurationRecord _parent;
  127.         // parent record
  128.         protected Hashtable _children;
  129.         // configName -> record
  130.         protected InternalConfigRoot _configRoot;
  131.         // root of configuration
  132.         protected string _configName;
  133.         // the last part of the config path
  134.         protected string _configPath;
  135.         // the full config path
  136.         protected string _locationSubPath;
  137.         // subPath for the config record when editing a location configuration
  138.         private ConfigRecordStreamInfo _configStreamInfo;
  139.         // stream info for the config record
  140.         private object _configContext;
  141.         // Context for config level
  142.         private ProtectedConfigurationSection _protectedConfig;
  143.         // section containing the encryption providers
  144.         private PermissionSet _restrictedPermissions;
  145.         // cached restricted permission set
  146.         private ConfigurationSchemaErrors _initErrors;
  147.         // errors encountered during the parse of the configuration file
  148.         private BaseConfigurationRecord _initDelayedRoot;
  149.         // root of delayed initialization
  150.         // Records information about <configSections> present in this web.config file.
  151.         // config key -> FactoryRecord
  152.         protected Hashtable _factoryRecords;
  153.        
  154.         // Records information about sections that apply to this path,
  155.         // which may be found in this web.config file, in a parent through
  156.         // inheritance, or in a parent through <location>
  157.         // config key -> SectionRecord
  158.         protected Hashtable _sectionRecords;
  159.        
  160.         // Records information about sections in a <location> directive
  161.         // that do not apply to this configPath (sections where path != ".")
  162.         protected ArrayList _locationSections;
  163.        
  164.        
  165.         internal BaseConfigurationRecord()
  166.         {
  167.             // not strictly necessary, but compiler spits out a warning without this initiailization
  168.             _flags = new SafeBitVector32();
  169.         }
  170.        
  171.         // Class flags
  172.         protected abstract SimpleBitVector32 ClassFlags {
  173.             get;
  174.         }
  175.        
  176.         // Create the factory that will evaluate configuration
  177.         protected abstract object CreateSectionFactory(FactoryRecord factoryRecord);
  178.        
  179.         // Create the configuration object
  180.         protected abstract object CreateSection(bool inputIsTrusted, FactoryRecord factoryRecord, SectionRecord sectionRecord, object parentConfig, ConfigXmlReader reader);
  181.        
  182.         // Use the parent result in creating the child
  183.         protected abstract object UseParentResult(string configKey, object parentResult, SectionRecord sectionRecord);
  184.        
  185.         // Return the runtime object from GetSection
  186.         protected abstract object GetRuntimeObject(object result);
  187.        
  188.         //
  189.         // IInternalConfigRecord methods
  190.         //
  191.        
  192.         public string ConfigPath {
  193.             get { return _configPath; }
  194.         }
  195.        
  196.         public string StreamName {
  197.             get { return ConfigStreamInfo.StreamName; }
  198.         }
  199.        
  200.         public bool HasInitErrors {
  201.             get { return _initErrors.HasErrors(ClassFlags[ClassIgnoreLocalErrors]); }
  202.         }
  203.        
  204.         public void ThrowIfInitErrors()
  205.         {
  206.             ThrowIfParseErrors(_initErrors);
  207.         }
  208.        
  209.         public object GetSection(string configKey)
  210.         {
  211.             #if DBG
  212.             // On debug builds, the config system depends on system.diagnostics,
  213.             // so we must always return a valid result and never throw.
  214.             if (configKey == "system.diagnostics" && !ClassFlags[ClassIgnoreLocalErrors]) {
  215.                 return GetSection(configKey, true, true);
  216.             }
  217.             else {
  218.                 return GetSection(configKey, false, true);
  219.             }
  220.             #else
  221.            
  222.             return GetSection(configKey, false, true);
  223.             #endif
  224.         }
  225.        
  226.         public object GetLkgSection(string configKey)
  227.         {
  228.             return GetSection(configKey, true, true);
  229.         }
  230.        
  231.         public void RefreshSection(string configKey)
  232.         {
  233.             _configRoot.ClearResult(this, configKey, true);
  234.         }
  235.        
  236.         public void Remove()
  237.         {
  238.             _configRoot.RemoveConfigRecord(this);
  239.         }
  240.        
  241.         //
  242.         // end of IInternalConfigRecord methods
  243.         //
  244.        
  245.         internal bool HasStream {
  246.             get { return ConfigStreamInfo.HasStream; }
  247.         }
  248.        
  249.         // Determine which sections should be prefetched during the first scan.
  250.         private bool ShouldPrefetchRawXml(FactoryRecord factoryRecord)
  251.         {
  252.             if (_flags[PrefetchAll])
  253.                 return true;
  254.            
  255.             switch (factoryRecord.ConfigKey) {
  256.                 case BaseConfigurationRecord.RESERVED_SECTION_PROTECTED_CONFIGURATION:
  257.                 case "system.diagnostics":
  258.                 case "appSettings":
  259.                 case "connectionStrings":
  260.                     return true;
  261.             }
  262.            
  263.             return Host.PrefetchSection(factoryRecord.Group, factoryRecord.Name);
  264.         }
  265.        
  266.         protected IDisposable Impersonate()
  267.         {
  268.             IDisposable context = null;
  269.             if (ClassFlags[ClassSupportsImpersonation]) {
  270.                 context = Host.Impersonate();
  271.             }
  272.            
  273.             if (context == null) {
  274.                 context = EmptyImpersonationContext.GetStaticInstance();
  275.             }
  276.            
  277.             return context;
  278.         }
  279.        
  280.         internal PermissionSet GetRestrictedPermissions()
  281.         {
  282.             if (!_flags[RestrictedPermissionsResolved]) {
  283.                 PermissionSet restrictedPermissions;
  284.                 bool isHostReady;
  285.                
  286.                 Host.GetRestrictedPermissions(this, out restrictedPermissions, out isHostReady);
  287.                 if (isHostReady) {
  288.                     _restrictedPermissions = restrictedPermissions;
  289.                     _flags[RestrictedPermissionsResolved] = true;
  290.                 }
  291.             }
  292.            
  293.             return _restrictedPermissions;
  294.         }
  295.        
  296.         internal void Init(IInternalConfigRoot configRoot, BaseConfigurationRecord parent, string configPath, string locationSubPath)
  297.         {
  298.            
  299.             _initErrors = new ConfigurationSchemaErrors();
  300.            
  301.             //
  302.             // try/catch here is only for unexpected exceptions due to errors in
  303.             // our own code, as we always want the configuration record to be
  304.             // usable
  305.             //
  306.             try {
  307.                 _configRoot = (InternalConfigRoot)configRoot;
  308.                 _parent = parent;
  309.                 _configPath = configPath;
  310.                 _locationSubPath = locationSubPath;
  311.                 _configName = ConfigPathUtility.GetName(configPath);
  312.                
  313.                 if (IsLocationConfig) {
  314.                     _configStreamInfo = _parent.ConfigStreamInfo;
  315.                 }
  316.                 else {
  317.                 &nb