WebHeaderCollection.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
  1. using System;
  2. using System.Collections;
  3. using System.Collections.Generic;
  4. using System.Collections.Specialized;
  5. using System.Net;
  6. using System.Runtime.InteropServices;
  7. using System.Runtime.Serialization;
  8. using System.Text;
  9. using MediaBrowser.Model.Services;
  10. using MediaBrowser.Model.Extensions;
  11. namespace SocketHttpListener.Net
  12. {
  13. [ComVisible(true)]
  14. public class WebHeaderCollection : QueryParamCollection
  15. {
  16. [Flags]
  17. internal enum HeaderInfo
  18. {
  19. Request = 1,
  20. Response = 1 << 1,
  21. MultiValue = 1 << 10
  22. }
  23. static readonly bool[] allowed_chars = {
  24. false, false, false, false, false, false, false, false, false, false, false, false, false, false,
  25. false, false, false, false, false, false, false, false, false, false, false, false, false, false,
  26. false, false, false, false, false, true, false, true, true, true, true, false, false, false, true,
  27. true, false, true, true, false, true, true, true, true, true, true, true, true, true, true, false,
  28. false, false, false, false, false, false, true, true, true, true, true, true, true, true, true,
  29. true, true, true, true, true, true, true, true, true, true, true, true, true, true, true, true, true,
  30. false, false, false, true, true, true, true, true, true, true, true, true, true, true, true, true,
  31. true, true, true, true, true, true, true, true, true, true, true, true, true, true, true, true,
  32. false, true, false
  33. };
  34. static readonly Dictionary<string, HeaderInfo> headers;
  35. HeaderInfo? headerRestriction;
  36. HeaderInfo? headerConsistency;
  37. static WebHeaderCollection()
  38. {
  39. headers = new Dictionary<string, HeaderInfo>(StringComparer.OrdinalIgnoreCase) {
  40. { "Allow", HeaderInfo.MultiValue },
  41. { "Accept", HeaderInfo.Request | HeaderInfo.MultiValue },
  42. { "Accept-Charset", HeaderInfo.MultiValue },
  43. { "Accept-Encoding", HeaderInfo.MultiValue },
  44. { "Accept-Language", HeaderInfo.MultiValue },
  45. { "Accept-Ranges", HeaderInfo.MultiValue },
  46. { "Age", HeaderInfo.Response },
  47. { "Authorization", HeaderInfo.MultiValue },
  48. { "Cache-Control", HeaderInfo.MultiValue },
  49. { "Cookie", HeaderInfo.MultiValue },
  50. { "Connection", HeaderInfo.Request | HeaderInfo.MultiValue },
  51. { "Content-Encoding", HeaderInfo.MultiValue },
  52. { "Content-Length", HeaderInfo.Request | HeaderInfo.Response },
  53. { "Content-Type", HeaderInfo.Request },
  54. { "Content-Language", HeaderInfo.MultiValue },
  55. { "Date", HeaderInfo.Request },
  56. { "Expect", HeaderInfo.Request | HeaderInfo.MultiValue},
  57. { "Host", HeaderInfo.Request },
  58. { "If-Match", HeaderInfo.MultiValue },
  59. { "If-Modified-Since", HeaderInfo.Request },
  60. { "If-None-Match", HeaderInfo.MultiValue },
  61. { "Keep-Alive", HeaderInfo.Response },
  62. { "Pragma", HeaderInfo.MultiValue },
  63. { "Proxy-Authenticate", HeaderInfo.MultiValue },
  64. { "Proxy-Authorization", HeaderInfo.MultiValue },
  65. { "Proxy-Connection", HeaderInfo.Request | HeaderInfo.MultiValue },
  66. { "Range", HeaderInfo.Request | HeaderInfo.MultiValue },
  67. { "Referer", HeaderInfo.Request },
  68. { "Set-Cookie", HeaderInfo.MultiValue },
  69. { "Set-Cookie2", HeaderInfo.MultiValue },
  70. { "Server", HeaderInfo.Response },
  71. { "TE", HeaderInfo.MultiValue },
  72. { "Trailer", HeaderInfo.MultiValue },
  73. { "Transfer-Encoding", HeaderInfo.Request | HeaderInfo.Response | HeaderInfo.MultiValue },
  74. { "Translate", HeaderInfo.Request | HeaderInfo.Response },
  75. { "Upgrade", HeaderInfo.MultiValue },
  76. { "User-Agent", HeaderInfo.Request },
  77. { "Vary", HeaderInfo.MultiValue },
  78. { "Via", HeaderInfo.MultiValue },
  79. { "Warning", HeaderInfo.MultiValue },
  80. { "WWW-Authenticate", HeaderInfo.Response | HeaderInfo. MultiValue },
  81. { "SecWebSocketAccept", HeaderInfo.Response },
  82. { "SecWebSocketExtensions", HeaderInfo.Request | HeaderInfo.Response | HeaderInfo. MultiValue },
  83. { "SecWebSocketKey", HeaderInfo.Request },
  84. { "Sec-WebSocket-Protocol", HeaderInfo.Request | HeaderInfo.Response | HeaderInfo. MultiValue },
  85. { "SecWebSocketVersion", HeaderInfo.Response | HeaderInfo. MultiValue }
  86. };
  87. }
  88. // Methods
  89. public void Add(string header)
  90. {
  91. if (header == null)
  92. throw new ArgumentNullException("header");
  93. int pos = header.IndexOf(':');
  94. if (pos == -1)
  95. throw new ArgumentException("no colon found", "header");
  96. this.Add(header.Substring(0, pos), header.Substring(pos + 1));
  97. }
  98. public override void Add(string name, string value)
  99. {
  100. if (name == null)
  101. throw new ArgumentNullException("name");
  102. ThrowIfRestricted(name);
  103. this.AddWithoutValidate(name, value);
  104. }
  105. protected void AddWithoutValidate(string headerName, string headerValue)
  106. {
  107. if (!IsHeaderName(headerName))
  108. throw new ArgumentException("invalid header name: " + headerName, "headerName");
  109. if (headerValue == null)
  110. headerValue = String.Empty;
  111. else
  112. headerValue = headerValue.Trim();
  113. if (!IsHeaderValue(headerValue))
  114. throw new ArgumentException("invalid header value: " + headerValue, "headerValue");
  115. AddValue(headerName, headerValue);
  116. }
  117. internal void AddValue(string headerName, string headerValue)
  118. {
  119. base.Add(headerName, headerValue);
  120. }
  121. internal List<string> GetValues_internal(string header, bool split)
  122. {
  123. if (header == null)
  124. throw new ArgumentNullException("header");
  125. var values = base.GetValues(header);
  126. if (values == null || values.Count == 0)
  127. return null;
  128. if (split && IsMultiValue(header))
  129. {
  130. List<string> separated = null;
  131. foreach (var value in values)
  132. {
  133. if (value.IndexOf(',') < 0)
  134. {
  135. if (separated != null)
  136. separated.Add(value);
  137. continue;
  138. }
  139. if (separated == null)
  140. {
  141. separated = new List<string>(values.Count + 1);
  142. foreach (var v in values)
  143. {
  144. if (v == value)
  145. break;
  146. separated.Add(v);
  147. }
  148. }
  149. var slices = value.Split(',');
  150. var slices_length = slices.Length;
  151. if (value[value.Length - 1] == ',')
  152. --slices_length;
  153. for (int i = 0; i < slices_length; ++i)
  154. {
  155. separated.Add(slices[i].Trim());
  156. }
  157. }
  158. if (separated != null)
  159. return separated;
  160. }
  161. return values;
  162. }
  163. public override List<string> GetValues(string header)
  164. {
  165. return GetValues_internal(header, true);
  166. }
  167. public override string[] GetValues(int index)
  168. {
  169. string[] values = base.GetValues(index);
  170. if (values == null || values.Length == 0)
  171. {
  172. return null;
  173. }
  174. return values;
  175. }
  176. public static bool IsRestricted(string headerName)
  177. {
  178. return IsRestricted(headerName, false);
  179. }
  180. public static bool IsRestricted(string headerName, bool response)
  181. {
  182. if (headerName == null)
  183. throw new ArgumentNullException("headerName");
  184. if (headerName.Length == 0)
  185. throw new ArgumentException("empty string", "headerName");
  186. if (!IsHeaderName(headerName))
  187. throw new ArgumentException("Invalid character in header");
  188. HeaderInfo info;
  189. if (!headers.TryGetValue(headerName, out info))
  190. return false;
  191. var flag = response ? HeaderInfo.Response : HeaderInfo.Request;
  192. return (info & flag) != 0;
  193. }
  194. public override void Set(string name, string value)
  195. {
  196. if (name == null)
  197. throw new ArgumentNullException("name");
  198. if (!IsHeaderName(name))
  199. throw new ArgumentException("invalid header name");
  200. if (value == null)
  201. value = String.Empty;
  202. else
  203. value = value.Trim();
  204. if (!IsHeaderValue(value))
  205. throw new ArgumentException("invalid header value");
  206. ThrowIfRestricted(name);
  207. base.Set(name, value);
  208. }
  209. internal string ToStringMultiValue()
  210. {
  211. StringBuilder sb = new StringBuilder();
  212. int count = base.Count;
  213. for (int i = 0; i < count; i++)
  214. {
  215. string key = GetKey(i);
  216. if (IsMultiValue(key))
  217. {
  218. foreach (string v in GetValues(i))
  219. {
  220. sb.Append(key)
  221. .Append(": ")
  222. .Append(v)
  223. .Append("\r\n");
  224. }
  225. }
  226. else
  227. {
  228. sb.Append(key)
  229. .Append(": ")
  230. .Append(Get(i))
  231. .Append("\r\n");
  232. }
  233. }
  234. return sb.Append("\r\n").ToString();
  235. }
  236. public override string ToString()
  237. {
  238. StringBuilder sb = new StringBuilder();
  239. int count = base.Count;
  240. for (int i = 0; i < count; i++)
  241. sb.Append(GetKey(i))
  242. .Append(": ")
  243. .Append(Get(i))
  244. .Append("\r\n");
  245. return sb.Append("\r\n").ToString();
  246. }
  247. // Internal Methods
  248. // With this we don't check for invalid characters in header. See bug #55994.
  249. internal void SetInternal(string header)
  250. {
  251. int pos = header.IndexOf(':');
  252. if (pos == -1)
  253. throw new ArgumentException("no colon found", "header");
  254. SetInternal(header.Substring(0, pos), header.Substring(pos + 1));
  255. }
  256. internal void SetInternal(string name, string value)
  257. {
  258. if (value == null)
  259. value = String.Empty;
  260. else
  261. value = value.Trim();
  262. if (!IsHeaderValue(value))
  263. throw new ArgumentException("invalid header value");
  264. if (IsMultiValue(name))
  265. {
  266. base.Add(name, value);
  267. }
  268. else
  269. {
  270. base.Remove(name);
  271. base.Set(name, value);
  272. }
  273. }
  274. // Private Methods
  275. public override int Remove(string name)
  276. {
  277. ThrowIfRestricted(name);
  278. return base.Remove(name);
  279. }
  280. protected void ThrowIfRestricted(string headerName)
  281. {
  282. if (!headerRestriction.HasValue)
  283. return;
  284. HeaderInfo info;
  285. if (!headers.TryGetValue(headerName, out info))
  286. return;
  287. if ((info & headerRestriction.Value) != 0)
  288. throw new ArgumentException("This header must be modified with the appropriate property.");
  289. }
  290. internal static bool IsMultiValue(string headerName)
  291. {
  292. if (headerName == null)
  293. return false;
  294. HeaderInfo info;
  295. return headers.TryGetValue(headerName, out info) && (info & HeaderInfo.MultiValue) != 0;
  296. }
  297. internal static bool IsHeaderValue(string value)
  298. {
  299. // TEXT any 8 bit value except CTL's (0-31 and 127)
  300. // but including \r\n space and \t
  301. // after a newline at least one space or \t must follow
  302. // certain header fields allow comments ()
  303. int len = value.Length;
  304. for (int i = 0; i < len; i++)
  305. {
  306. char c = value[i];
  307. if (c == 127)
  308. return false;
  309. if (c < 0x20 && (c != '\r' && c != '\n' && c != '\t'))
  310. return false;
  311. if (c == '\n' && ++i < len)
  312. {
  313. c = value[i];
  314. if (c != ' ' && c != '\t')
  315. return false;
  316. }
  317. }
  318. return true;
  319. }
  320. internal static bool IsHeaderName(string name)
  321. {
  322. if (name == null || name.Length == 0)
  323. return false;
  324. int len = name.Length;
  325. for (int i = 0; i < len; i++)
  326. {
  327. char c = name[i];
  328. if (c > 126 || !allowed_chars[c])
  329. return false;
  330. }
  331. return true;
  332. }
  333. }
  334. }