AxiosHeaders.js 8.2 KB

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