AxiosHeaders.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474
  1. 'use strict';
  2. import utils from '../utils.js';
  3. import parseHeaders from '../helpers/parseHeaders.js';
  4. import { sanitizeHeaderValue } from '../helpers/sanitizeHeaderValue.js';
  5. const $internals = Symbol('internals');
  6. function normalizeHeader(header) {
  7. return header && String(header).trim().toLowerCase();
  8. }
  9. function normalizeValue(value) {
  10. if (value === false || value == null) {
  11. return value;
  12. }
  13. return utils.isArray(value) ? value.map(normalizeValue) : sanitizeHeaderValue(String(value));
  14. }
  15. function parseTokens(str) {
  16. const tokens = Object.create(null);
  17. const tokensRE = /([^\s,;=]+)\s*(?:=\s*([^,;]+))?/g;
  18. let match;
  19. while ((match = tokensRE.exec(str))) {
  20. tokens[match[1]] = match[2];
  21. }
  22. return tokens;
  23. }
  24. const parameterNameRE = /^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$/;
  25. function trimOWS(value) {
  26. let start = 0;
  27. let end = value.length;
  28. while (start < end) {
  29. const code = value.charCodeAt(start);
  30. if (code !== 0x09 && code !== 0x20) {
  31. break;
  32. }
  33. start += 1;
  34. }
  35. while (end > start) {
  36. const code = value.charCodeAt(end - 1);
  37. if (code !== 0x09 && code !== 0x20) {
  38. break;
  39. }
  40. end -= 1;
  41. }
  42. return start === 0 && end === value.length ? value : value.slice(start, end);
  43. }
  44. function decodeQuotedString(value) {
  45. const last = value.length - 1;
  46. if (last < 1 || value.charCodeAt(0) !== 0x22 || value.charCodeAt(last) !== 0x22) {
  47. return value;
  48. }
  49. let decoded = '';
  50. for (let i = 1; i < last; i++) {
  51. const code = value.charCodeAt(i);
  52. if (code === 0x22) {
  53. return value;
  54. }
  55. if (code === 0x5c) {
  56. i += 1;
  57. if (i >= last) {
  58. return value;
  59. }
  60. }
  61. decoded += value[i];
  62. }
  63. return decoded;
  64. }
  65. function parseParameters(value) {
  66. const parameters = Object.create(null);
  67. const str = String(value);
  68. let start = 0;
  69. let quoted = false;
  70. let escaped = false;
  71. function parseParameter(end) {
  72. const part = trimOWS(str.slice(start, end));
  73. const equals = part.indexOf('=');
  74. if (equals < 1) {
  75. return;
  76. }
  77. const name = trimOWS(part.slice(0, equals));
  78. if (!parameterNameRE.test(name)) {
  79. return;
  80. }
  81. const normalizedName = name.toLowerCase();
  82. if (
  83. normalizedName === '__proto__' ||
  84. normalizedName === 'constructor' ||
  85. normalizedName === 'prototype'
  86. ) {
  87. return;
  88. }
  89. const parameterValue = trimOWS(part.slice(equals + 1));
  90. parameters[normalizedName] = decodeQuotedString(parameterValue);
  91. }
  92. for (let i = 0; i < str.length; i++) {
  93. const code = str.charCodeAt(i);
  94. if (quoted) {
  95. if (escaped) {
  96. escaped = false;
  97. } else if (code === 0x5c) {
  98. escaped = true;
  99. } else if (code === 0x22) {
  100. quoted = false;
  101. }
  102. } else if (code === 0x22) {
  103. quoted = true;
  104. } else if (code === 0x2c || code === 0x3b) {
  105. parseParameter(i);
  106. start = i + 1;
  107. }
  108. }
  109. parseParameter(str.length);
  110. return parameters;
  111. }
  112. const isValidHeaderName = (str) => /^[-_a-zA-Z0-9^`|~,!#$%&'*+.]+$/.test(str.trim());
  113. function matchHeaderValue(context, value, header, filter, isHeaderNameFilter) {
  114. if (utils.isFunction(filter)) {
  115. return filter.call(this, value, header);
  116. }
  117. if (isHeaderNameFilter) {
  118. value = header;
  119. }
  120. if (!utils.isString(value)) return;
  121. if (utils.isString(filter)) {
  122. return value.indexOf(filter) !== -1;
  123. }
  124. if (utils.isRegExp(filter)) {
  125. return filter.test(value);
  126. }
  127. }
  128. function formatHeader(header) {
  129. return header
  130. .trim()
  131. .toLowerCase()
  132. .replace(/([a-z\d])(\w*)/g, (w, char, str) => {
  133. return char.toUpperCase() + str;
  134. });
  135. }
  136. function buildAccessors(obj, header) {
  137. const accessorName = utils.toCamelCase(' ' + header);
  138. ['get', 'set', 'has'].forEach((methodName) => {
  139. Object.defineProperty(obj, methodName + accessorName, {
  140. // Null-proto descriptor so a polluted Object.prototype.get cannot turn
  141. // this data descriptor into an accessor descriptor on the way in.
  142. __proto__: null,
  143. value: function (arg1, arg2, arg3) {
  144. return this[methodName].call(this, header, arg1, arg2, arg3);
  145. },
  146. configurable: true,
  147. });
  148. });
  149. }
  150. class AxiosHeaders {
  151. constructor(headers) {
  152. headers && this.set(headers);
  153. }
  154. set(header, valueOrRewrite, rewrite) {
  155. const self = this;
  156. function setHeader(_value, _header, _rewrite) {
  157. const lHeader = normalizeHeader(_header);
  158. if (!lHeader) {
  159. return;
  160. }
  161. const key = utils.findKey(self, lHeader);
  162. if (
  163. !key ||
  164. self[key] === undefined ||
  165. _rewrite === true ||
  166. (_rewrite === undefined && self[key] !== false)
  167. ) {
  168. self[key || _header] = normalizeValue(_value);
  169. }
  170. }
  171. const setHeaders = (headers, _rewrite) =>
  172. utils.forEach(headers, (_value, _header) => setHeader(_value, _header, _rewrite));
  173. if (utils.isPlainObject(header) || header instanceof this.constructor) {
  174. setHeaders(header, valueOrRewrite);
  175. } else if (utils.isString(header) && (header = header.trim()) && !isValidHeaderName(header)) {
  176. setHeaders(parseHeaders(header), valueOrRewrite);
  177. } else if (utils.isObject(header) && utils.isSafeIterable(header)) {
  178. let obj = Object.create(null),
  179. dest,
  180. key;
  181. for (const entry of header) {
  182. if (!utils.isArray(entry)) {
  183. throw new TypeError('Object iterator must return a key-value pair');
  184. }
  185. key = entry[0];
  186. if (utils.hasOwnProp(obj, key)) {
  187. dest = obj[key];
  188. obj[key] = utils.isArray(dest) ? [...dest, entry[1]] : [dest, entry[1]];
  189. } else {
  190. obj[key] = entry[1];
  191. }
  192. }
  193. setHeaders(obj, valueOrRewrite);
  194. } else {
  195. header != null && setHeader(valueOrRewrite, header, rewrite);
  196. }
  197. return this;
  198. }
  199. get(header, parser) {
  200. header = normalizeHeader(header);
  201. if (header) {
  202. const key = utils.findKey(this, header);
  203. if (key) {
  204. const value = this[key];
  205. if (!parser) {
  206. return value;
  207. }
  208. if (parser === true) {
  209. return parseTokens(value);
  210. }
  211. if (utils.isFunction(parser)) {
  212. return parser.call(this, value, key);
  213. }
  214. if (utils.isRegExp(parser)) {
  215. return parser.exec(value);
  216. }
  217. throw new TypeError('parser must be boolean|regexp|function');
  218. }
  219. }
  220. }
  221. has(header, matcher) {
  222. header = normalizeHeader(header);
  223. if (header) {
  224. const key = utils.findKey(this, header);
  225. return !!(
  226. key &&
  227. this[key] !== undefined &&
  228. (!matcher || matchHeaderValue(this, this[key], key, matcher))
  229. );
  230. }
  231. return false;
  232. }
  233. delete(header, matcher) {
  234. const self = this;
  235. let deleted = false;
  236. function deleteHeader(_header) {
  237. _header = normalizeHeader(_header);
  238. if (_header) {
  239. const key = utils.findKey(self, _header);
  240. if (key && (!matcher || matchHeaderValue(self, self[key], key, matcher))) {
  241. delete self[key];
  242. deleted = true;
  243. }
  244. }
  245. }
  246. if (utils.isArray(header)) {
  247. header.forEach(deleteHeader);
  248. } else {
  249. deleteHeader(header);
  250. }
  251. return deleted;
  252. }
  253. clear(matcher) {
  254. const keys = Object.keys(this);
  255. let i = keys.length;
  256. let deleted = false;
  257. while (i--) {
  258. const key = keys[i];
  259. if (!matcher || matchHeaderValue(this, this[key], key, matcher, true)) {
  260. delete this[key];
  261. deleted = true;
  262. }
  263. }
  264. return deleted;
  265. }
  266. normalize(format) {
  267. const self = this;
  268. const headers = {};
  269. utils.forEach(this, (value, header) => {
  270. const key = utils.findKey(headers, header);
  271. if (key) {
  272. self[key] = normalizeValue(value);
  273. delete self[header];
  274. return;
  275. }
  276. const normalized = format ? formatHeader(header) : String(header).trim();
  277. if (normalized !== header) {
  278. delete self[header];
  279. }
  280. self[normalized] = normalizeValue(value);
  281. headers[normalized] = true;
  282. });
  283. return this;
  284. }
  285. concat(...targets) {
  286. return this.constructor.concat(this, ...targets);
  287. }
  288. toJSON(asStrings) {
  289. const obj = Object.create(null);
  290. utils.forEach(this, (value, header) => {
  291. value != null &&
  292. value !== false &&
  293. (obj[header] = asStrings && utils.isArray(value) ? value.join(', ') : value);
  294. });
  295. return obj;
  296. }
  297. [Symbol.iterator]() {
  298. return Object.entries(this.toJSON())[Symbol.iterator]();
  299. }
  300. toString() {
  301. return Object.entries(this.toJSON())
  302. .map(([header, value]) => header + ': ' + value)
  303. .join('\n');
  304. }
  305. getSetCookie() {
  306. const value = this.get('set-cookie');
  307. return utils.isArray(value) ? value : value == null || value === false ? [] : [value];
  308. }
  309. get [Symbol.toStringTag]() {
  310. return 'AxiosHeaders';
  311. }
  312. static from(thing) {
  313. return thing instanceof this ? thing : new this(thing);
  314. }
  315. static parseParameters(value) {
  316. return parseParameters(value);
  317. }
  318. static concat(first, ...targets) {
  319. const computed = new this(first);
  320. targets.forEach((target) => computed.set(target));
  321. return computed;
  322. }
  323. static accessor(header) {
  324. const internals =
  325. (this[$internals] =
  326. this[$internals] =
  327. {
  328. accessors: {},
  329. });
  330. const accessors = internals.accessors;
  331. const prototype = this.prototype;
  332. function defineAccessor(_header) {
  333. const lHeader = normalizeHeader(_header);
  334. if (!accessors[lHeader]) {
  335. buildAccessors(prototype, _header);
  336. accessors[lHeader] = true;
  337. }
  338. }
  339. utils.isArray(header) ? header.forEach(defineAccessor) : defineAccessor(header);
  340. return this;
  341. }
  342. }
  343. AxiosHeaders.accessor([
  344. 'Content-Type',
  345. 'Content-Length',
  346. 'Accept',
  347. 'Accept-Encoding',
  348. 'User-Agent',
  349. 'Authorization',
  350. ]);
  351. // reserved names hotfix
  352. utils.reduceDescriptors(AxiosHeaders.prototype, ({ value }, key) => {
  353. let mapped = key[0].toUpperCase() + key.slice(1); // map `set` => `Set`
  354. return {
  355. get: () => value,
  356. set(headerValue) {
  357. this[mapped] = headerValue;
  358. },
  359. };
  360. });
  361. utils.freezeMethods(AxiosHeaders);
  362. export default AxiosHeaders;