class/System.Web.Mvc/System.Web.Mvc/ValueProviderDictionary.cs

   1 /* ****************************************************************************
   2  *
   3  * Copyright (c) Microsoft Corporation. All rights reserved.
   4  *
   5  * This software is subject to the Microsoft Public License (Ms-PL).
   6  * A copy of the license can be found in the license.htm file included
   7  * in this distribution.
   8  *
   9  * You must not remove this notice, or any other, from this software.
  10  *
  11  * ***************************************************************************/
  12
  13 namespace System.Web.Mvc {
  14     using System;
  15     using System.Collections;
  16     using System.Collections.Generic;
  17     using System.Collections.Specialized;
  18     using System.Diagnostics.CodeAnalysis;
  19     using System.Globalization;
  20     using System.Web.Routing;
  21
  22     public class ValueProviderDictionary : IDictionary<string, ValueProviderResult> {
  23
  24         private readonly Dictionary<string, ValueProviderResult> _dictionary = new Dictionary<string, ValueProviderResult>(StringComparer.OrdinalIgnoreCase);
  25
  26         public ValueProviderDictionary(ControllerContext controllerContext) {
  27             ControllerContext = controllerContext;
  28             if (controllerContext != null) {
  29                 PopulateDictionary();
  30             }
  31         }
  32
  33         public ControllerContext ControllerContext {
  34             get;
  35             private set;
  36         }
  37
  38         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
  39         public int Count {
  40             get {
  41                 return ((ICollection<KeyValuePair<string, ValueProviderResult>>)Dictionary).Count;
  42             }
  43         }
  44
  45         internal Dictionary<string, ValueProviderResult> Dictionary {
  46             get {
  47                 return _dictionary;
  48             }
  49         }
  50
  51         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
  52         public bool IsReadOnly {
  53             get {
  54                 return ((ICollection<KeyValuePair<string, ValueProviderResult>>)Dictionary).IsReadOnly;
  55             }
  56         }
  57
  58         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
  59         public ICollection<string> Keys {
  60             get {
  61                 return Dictionary.Keys;
  62             }
  63         }
  64
  65         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
  66         public ValueProviderResult this[string key] {
  67             get {
  68                 ValueProviderResult result;
  69                 Dictionary.TryGetValue(key, out result);
  70                 return result;
  71             }
  72             set {
  73                 Dictionary[key] = value;
  74             }
  75         }
  76
  77         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
  78         public ICollection<ValueProviderResult> Values {
  79             get {
  80                 return Dictionary.Values;
  81             }
  82         }
  83
  84         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
  85         public void Add(KeyValuePair<string, ValueProviderResult> item) {
  86             ((ICollection<KeyValuePair<string, ValueProviderResult>>)Dictionary).Add(item);
  87         }
  88
  89         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
  90         public void Add(string key, ValueProviderResult value) {
  91             Dictionary.Add(key, value);
  92         }
  93
  94         private void AddToDictionaryIfNotPresent(string key, ValueProviderResult result) {
  95             if (!String.IsNullOrEmpty(key)) {
  96                 if (!Dictionary.ContainsKey(key)) {
  97                     Dictionary.Add(key, result);
  98                 }
  99             }
 100         }
 101
 102         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
 103         public void Clear() {
 104             ((ICollection<KeyValuePair<string, ValueProviderResult>>)Dictionary).Clear();
 105         }
 106
 107         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
 108         public bool Contains(KeyValuePair<string, ValueProviderResult> item) {
 109             return ((ICollection<KeyValuePair<string, ValueProviderResult>>)Dictionary).Contains(item);
 110         }
 111
 112         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
 113         public bool ContainsKey(string key) {
 114             return Dictionary.ContainsKey(key);
 115         }
 116
 117         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
 118         public void CopyTo(KeyValuePair<string, ValueProviderResult>[] array, int arrayIndex) {
 119             ((ICollection<KeyValuePair<string, ValueProviderResult>>)Dictionary).CopyTo(array, arrayIndex);
 120         }
 121
 122         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
 123         public IEnumerator<KeyValuePair<string, ValueProviderResult>> GetEnumerator() {
 124             return ((IEnumerable<KeyValuePair<string, ValueProviderResult>>)Dictionary).GetEnumerator();
 125         }
 126
 127         private void PopulateDictionary() {
 128             CultureInfo currentCulture = CultureInfo.CurrentCulture;
 129             CultureInfo invariantCulture = CultureInfo.InvariantCulture;
 130
 131             // We use this order of precedence to populate the dictionary:
 132             // 1. Request form submission (should be culture-aware)
 133             // 2. Values from the RouteData (could be from the typed-in URL or from the route's default values)
 134             // 3. URI query string
 135
 136             NameValueCollection form = ControllerContext.HttpContext.Request.Form;
 137             if (form != null) {
 138                 string[] keys = form.AllKeys;
 139                 foreach (string key in keys) {
 140                     string[] rawValue = form.GetValues(key);
 141                     string attemptedValue = form[key];
 142                     ValueProviderResult result = new ValueProviderResult(rawValue, attemptedValue, currentCulture);
 143                     AddToDictionaryIfNotPresent(key, result);
 144                 }
 145             }
 146
 147             RouteValueDictionary routeValues = ControllerContext.RouteData.Values;
 148             if (routeValues != null) {
 149                 foreach (var kvp in routeValues) {
 150                     string key = kvp.Key;
 151                     object rawValue = kvp.Value;
 152                     string attemptedValue = Convert.ToString(rawValue, invariantCulture);
 153                     ValueProviderResult result = new ValueProviderResult(rawValue, attemptedValue, invariantCulture);
 154                     AddToDictionaryIfNotPresent(key, result);
 155                 }
 156             }
 157
 158             NameValueCollection queryString = ControllerContext.HttpContext.Request.QueryString;
 159             if (queryString != null) {
 160                 string[] keys = queryString.AllKeys;
 161                 foreach (string key in keys) {
 162                     string[] rawValue = queryString.GetValues(key);
 163                     string attemptedValue = queryString[key];
 164                     ValueProviderResult result = new ValueProviderResult(rawValue, attemptedValue, invariantCulture);
 165                     AddToDictionaryIfNotPresent(key, result);
 166                 }
 167             }
 168         }
 169
 170         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
 171         public bool Remove(KeyValuePair<string, ValueProviderResult> item) {
 172             return ((ICollection<KeyValuePair<string, ValueProviderResult>>)Dictionary).Remove(item);
 173         }
 174
 175         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
 176         public bool Remove(string key) {
 177             return Dictionary.Remove(key);
 178         }
 179
 180         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
 181         public bool TryGetValue(string key, out ValueProviderResult value) {
 182             return Dictionary.TryGetValue(key, out value);
 183         }
 184
 185         #region IEnumerable Members
 186         [SuppressMessage("Microsoft.Security", "CA2123:OverrideLinkDemandsShouldBeIdenticalToBase")]
 187         IEnumerator IEnumerable.GetEnumerator() {
 188             return ((IEnumerable)Dictionary).GetEnumerator();
 189         }
 190         #endregion
 191
 192     }
 193 }