parse.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  1. 'use strict';
  2. var utils = require('./utils');
  3. var has = Object.prototype.hasOwnProperty;
  4. var isArray = Array.isArray;
  5. var defaults = {
  6. allowDots: false,
  7. allowEmptyArrays: false,
  8. allowPrototypes: false,
  9. allowSparse: false,
  10. arrayLimit: 20,
  11. charset: 'utf-8',
  12. charsetSentinel: false,
  13. comma: false,
  14. decodeDotInKeys: false,
  15. decoder: utils.decode,
  16. delimiter: '&',
  17. depth: 5,
  18. duplicates: 'combine',
  19. ignoreQueryPrefix: false,
  20. interpretNumericEntities: false,
  21. parameterLimit: 1000,
  22. parseArrays: true,
  23. plainObjects: false,
  24. strictNullHandling: false
  25. };
  26. var interpretNumericEntities = function (str) {
  27. return str.replace(/&#(\d+);/g, function ($0, numberStr) {
  28. return String.fromCharCode(parseInt(numberStr, 10));
  29. });
  30. };
  31. var parseArrayValue = function (val, options) {
  32. if (val && typeof val === 'string' && options.comma && val.indexOf(',') > -1) {
  33. return val.split(',');
  34. }
  35. return val;
  36. };
  37. // This is what browsers will submit when the ✓ character occurs in an
  38. // application/x-www-form-urlencoded body and the encoding of the page containing
  39. // the form is iso-8859-1, or when the submitted form has an accept-charset
  40. // attribute of iso-8859-1. Presumably also with other charsets that do not contain
  41. // the ✓ character, such as us-ascii.
  42. var isoSentinel = 'utf8=%26%2310003%3B'; // encodeURIComponent('✓')
  43. // These are the percent-encoded utf-8 octets representing a checkmark, indicating that the request actually is utf-8 encoded.
  44. var charsetSentinel = 'utf8=%E2%9C%93'; // encodeURIComponent('✓')
  45. var parseValues = function parseQueryStringValues(str, options) {
  46. var obj = { __proto__: null };
  47. var cleanStr = options.ignoreQueryPrefix ? str.replace(/^\?/, '') : str;
  48. var limit = options.parameterLimit === Infinity ? undefined : options.parameterLimit;
  49. var parts = cleanStr.split(options.delimiter, limit);
  50. var skipIndex = -1; // Keep track of where the utf8 sentinel was found
  51. var i;
  52. var charset = options.charset;
  53. if (options.charsetSentinel) {
  54. for (i = 0; i < parts.length; ++i) {
  55. if (parts[i].indexOf('utf8=') === 0) {
  56. if (parts[i] === charsetSentinel) {
  57. charset = 'utf-8';
  58. } else if (parts[i] === isoSentinel) {
  59. charset = 'iso-8859-1';
  60. }
  61. skipIndex = i;
  62. i = parts.length; // The eslint settings do not allow break;
  63. }
  64. }
  65. }
  66. for (i = 0; i < parts.length; ++i) {
  67. if (i === skipIndex) {
  68. continue;
  69. }
  70. var part = parts[i];
  71. var bracketEqualsPos = part.indexOf(']=');
  72. var pos = bracketEqualsPos === -1 ? part.indexOf('=') : bracketEqualsPos + 1;
  73. var key, val;
  74. if (pos === -1) {
  75. key = options.decoder(part, defaults.decoder, charset, 'key');
  76. val = options.strictNullHandling ? null : '';
  77. } else {
  78. key = options.decoder(part.slice(0, pos), defaults.decoder, charset, 'key');
  79. val = utils.maybeMap(
  80. parseArrayValue(part.slice(pos + 1), options),
  81. function (encodedVal) {
  82. return options.decoder(encodedVal, defaults.decoder, charset, 'value');
  83. }
  84. );
  85. }
  86. if (val && options.interpretNumericEntities && charset === 'iso-8859-1') {
  87. val = interpretNumericEntities(val);
  88. }
  89. if (part.indexOf('[]=') > -1) {
  90. val = isArray(val) ? [val] : val;
  91. }
  92. var existing = has.call(obj, key);
  93. if (existing && options.duplicates === 'combine') {
  94. obj[key] = utils.combine(obj[key], val);
  95. } else if (!existing || options.duplicates === 'last') {
  96. obj[key] = val;
  97. }
  98. }
  99. return obj;
  100. };
  101. var parseObject = function (chain, val, options, valuesParsed) {
  102. var leaf = valuesParsed ? val : parseArrayValue(val, options);
  103. for (var i = chain.length - 1; i >= 0; --i) {
  104. var obj;
  105. var root = chain[i];
  106. if (root === '[]' && options.parseArrays) {
  107. obj = options.allowEmptyArrays && leaf === '' ? [] : [].concat(leaf);
  108. } else {
  109. obj = options.plainObjects ? Object.create(null) : {};
  110. var cleanRoot = root.charAt(0) === '[' && root.charAt(root.length - 1) === ']' ? root.slice(1, -1) : root;
  111. var decodedRoot = options.decodeDotInKeys ? cleanRoot.replace(/%2E/g, '.') : cleanRoot;
  112. var index = parseInt(decodedRoot, 10);
  113. if (!options.parseArrays && decodedRoot === '') {
  114. obj = { 0: leaf };
  115. } else if (
  116. !isNaN(index)
  117. && root !== decodedRoot
  118. && String(index) === decodedRoot
  119. && index >= 0
  120. && (options.parseArrays && index <= options.arrayLimit)
  121. ) {
  122. obj = [];
  123. obj[index] = leaf;
  124. } else if (decodedRoot !== '__proto__') {
  125. obj[decodedRoot] = leaf;
  126. }
  127. }
  128. leaf = obj;
  129. }
  130. return leaf;
  131. };
  132. var parseKeys = function parseQueryStringKeys(givenKey, val, options, valuesParsed) {
  133. if (!givenKey) {
  134. return;
  135. }
  136. // Transform dot notation to bracket notation
  137. var key = options.allowDots ? givenKey.replace(/\.([^.[]+)/g, '[$1]') : givenKey;
  138. // The regex chunks
  139. var brackets = /(\[[^[\]]*])/;
  140. var child = /(\[[^[\]]*])/g;
  141. // Get the parent
  142. var segment = options.depth > 0 && brackets.exec(key);
  143. var parent = segment ? key.slice(0, segment.index) : key;
  144. // Stash the parent if it exists
  145. var keys = [];
  146. if (parent) {
  147. // If we aren't using plain objects, optionally prefix keys that would overwrite object prototype properties
  148. if (!options.plainObjects && has.call(Object.prototype, parent)) {
  149. if (!options.allowPrototypes) {
  150. return;
  151. }
  152. }
  153. keys.push(parent);
  154. }
  155. // Loop through children appending to the array until we hit depth
  156. var i = 0;
  157. while (options.depth > 0 && (segment = child.exec(key)) !== null && i < options.depth) {
  158. i += 1;
  159. if (!options.plainObjects && has.call(Object.prototype, segment[1].slice(1, -1))) {
  160. if (!options.allowPrototypes) {
  161. return;
  162. }
  163. }
  164. keys.push(segment[1]);
  165. }
  166. // If there's a remainder, just add whatever is left
  167. if (segment) {
  168. keys.push('[' + key.slice(segment.index) + ']');
  169. }
  170. return parseObject(keys, val, options, valuesParsed);
  171. };
  172. var normalizeParseOptions = function normalizeParseOptions(opts) {
  173. if (!opts) {
  174. return defaults;
  175. }
  176. if (typeof opts.allowEmptyArrays !== 'undefined' && typeof opts.allowEmptyArrays !== 'boolean') {
  177. throw new TypeError('`allowEmptyArrays` option can only be `true` or `false`, when provided');
  178. }
  179. if (typeof opts.decodeDotInKeys !== 'undefined' && typeof opts.decodeDotInKeys !== 'boolean') {
  180. throw new TypeError('`decodeDotInKeys` option can only be `true` or `false`, when provided');
  181. }
  182. if (opts.decoder !== null && typeof opts.decoder !== 'undefined' && typeof opts.decoder !== 'function') {
  183. throw new TypeError('Decoder has to be a function.');
  184. }
  185. if (typeof opts.charset !== 'undefined' && opts.charset !== 'utf-8' && opts.charset !== 'iso-8859-1') {
  186. throw new TypeError('The charset option must be either utf-8, iso-8859-1, or undefined');
  187. }
  188. var charset = typeof opts.charset === 'undefined' ? defaults.charset : opts.charset;
  189. var duplicates = typeof opts.duplicates === 'undefined' ? defaults.duplicates : opts.duplicates;
  190. if (duplicates !== 'combine' && duplicates !== 'first' && duplicates !== 'last') {
  191. throw new TypeError('The duplicates option must be either combine, first, or last');
  192. }
  193. var allowDots = typeof opts.allowDots === 'undefined' ? opts.decodeDotInKeys === true ? true : defaults.allowDots : !!opts.allowDots;
  194. return {
  195. allowDots: allowDots,
  196. allowEmptyArrays: typeof opts.allowEmptyArrays === 'boolean' ? !!opts.allowEmptyArrays : defaults.allowEmptyArrays,
  197. allowPrototypes: typeof opts.allowPrototypes === 'boolean' ? opts.allowPrototypes : defaults.allowPrototypes,
  198. allowSparse: typeof opts.allowSparse === 'boolean' ? opts.allowSparse : defaults.allowSparse,
  199. arrayLimit: typeof opts.arrayLimit === 'number' ? opts.arrayLimit : defaults.arrayLimit,
  200. charset: charset,
  201. charsetSentinel: typeof opts.charsetSentinel === 'boolean' ? opts.charsetSentinel : defaults.charsetSentinel,
  202. comma: typeof opts.comma === 'boolean' ? opts.comma : defaults.comma,
  203. decodeDotInKeys: typeof opts.decodeDotInKeys === 'boolean' ? opts.decodeDotInKeys : defaults.decodeDotInKeys,
  204. decoder: typeof opts.decoder === 'function' ? opts.decoder : defaults.decoder,
  205. delimiter: typeof opts.delimiter === 'string' || utils.isRegExp(opts.delimiter) ? opts.delimiter : defaults.delimiter,
  206. // eslint-disable-next-line no-implicit-coercion, no-extra-parens
  207. depth: (typeof opts.depth === 'number' || opts.depth === false) ? +opts.depth : defaults.depth,
  208. duplicates: duplicates,
  209. ignoreQueryPrefix: opts.ignoreQueryPrefix === true,
  210. interpretNumericEntities: typeof opts.interpretNumericEntities === 'boolean' ? opts.interpretNumericEntities : defaults.interpretNumericEntities,
  211. parameterLimit: typeof opts.parameterLimit === 'number' ? opts.parameterLimit : defaults.parameterLimit,
  212. parseArrays: opts.parseArrays !== false,
  213. plainObjects: typeof opts.plainObjects === 'boolean' ? opts.plainObjects : defaults.plainObjects,
  214. strictNullHandling: typeof opts.strictNullHandling === 'boolean' ? opts.strictNullHandling : defaults.strictNullHandling
  215. };
  216. };
  217. module.exports = function (str, opts) {
  218. var options = normalizeParseOptions(opts);
  219. if (str === '' || str === null || typeof str === 'undefined') {
  220. return options.plainObjects ? Object.create(null) : {};
  221. }
  222. var tempObj = typeof str === 'string' ? parseValues(str, options) : str;
  223. var obj = options.plainObjects ? Object.create(null) : {};
  224. // Iterate over the keys and setup the new object
  225. var keys = Object.keys(tempObj);
  226. for (var i = 0; i < keys.length; ++i) {
  227. var key = keys[i];
  228. var newObj = parseKeys(key, tempObj[key], options, typeof str === 'string');
  229. obj = utils.merge(obj, newObj, options);
  230. }
  231. if (options.allowSparse === true) {
  232. return obj;
  233. }
  234. return utils.compact(obj);
  235. };