index.js 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. /*!
  2. * vary
  3. * Copyright(c) 2014-2015 Douglas Christopher Wilson
  4. * MIT Licensed
  5. */
  6. 'use strict';
  7. /**
  8. * Module exports.
  9. */
  10. module.exports = vary;
  11. module.exports.append = append;
  12. /**
  13. * RegExp to match field-name in RFC 7230 sec 3.2
  14. *
  15. * field-name = token
  16. * token = 1*tchar
  17. * tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*"
  18. * / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
  19. * / DIGIT / ALPHA
  20. * ; any VCHAR, except delimiters
  21. */
  22. var fieldNameRegExp = /^[!#$%&'\*\+\-\.\^_`\|~0-9A-Za-z]+$/
  23. /**
  24. * Append a field to a vary header.
  25. *
  26. * @param {String} header
  27. * @param {String|Array} field
  28. * @return {String}
  29. * @api public
  30. */
  31. function append(header, field) {
  32. if (typeof header !== 'string') {
  33. throw new TypeError('header argument is required');
  34. }
  35. if (!field) {
  36. throw new TypeError('field argument is required');
  37. }
  38. // get fields array
  39. var fields = !Array.isArray(field)
  40. ? parse(String(field))
  41. : field;
  42. // assert on invalid field names
  43. for (var i = 0; i < fields.length; i++) {
  44. if (!fieldNameRegExp.test(fields[i])) {
  45. throw new TypeError('field argument contains an invalid header name');
  46. }
  47. }
  48. // existing, unspecified vary
  49. if (header === '*') {
  50. return header;
  51. }
  52. // enumerate current values
  53. var val = header;
  54. var vals = parse(header.toLowerCase());
  55. // unspecified vary
  56. if (fields.indexOf('*') !== -1 || vals.indexOf('*') !== -1) {
  57. return '*';
  58. }
  59. for (var i = 0; i < fields.length; i++) {
  60. var fld = fields[i].toLowerCase();
  61. // append value (case-preserving)
  62. if (vals.indexOf(fld) === -1) {
  63. vals.push(fld);
  64. val = val
  65. ? val + ', ' + fields[i]
  66. : fields[i];
  67. }
  68. }
  69. return val;
  70. }
  71. /**
  72. * Parse a vary header into an array.
  73. *
  74. * @param {String} header
  75. * @return {Array}
  76. * @api private
  77. */
  78. function parse(header) {
  79. return header.trim().split(/ *, */);
  80. }
  81. /**
  82. * Mark that a request is varied on a header field.
  83. *
  84. * @param {Object} res
  85. * @param {String|Array} field
  86. * @api public
  87. */
  88. function vary(res, field) {
  89. if (!res || !res.getHeader || !res.setHeader) {
  90. // quack quack
  91. throw new TypeError('res argument is required');
  92. }
  93. // get existing header
  94. var val = res.getHeader('Vary') || ''
  95. var header = Array.isArray(val)
  96. ? val.join(', ')
  97. : String(val);
  98. // set new header
  99. if ((val = append(header, field))) {
  100. res.setHeader('Vary', val);
  101. }
  102. }