index.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433
  1. 'use strict';
  2. // Load modules
  3. const Hoek = require('hoek');
  4. // Declare internals
  5. const internals = {
  6. STATUS_CODES: Object.setPrototypeOf({
  7. '100': 'Continue',
  8. '101': 'Switching Protocols',
  9. '102': 'Processing',
  10. '200': 'OK',
  11. '201': 'Created',
  12. '202': 'Accepted',
  13. '203': 'Non-Authoritative Information',
  14. '204': 'No Content',
  15. '205': 'Reset Content',
  16. '206': 'Partial Content',
  17. '207': 'Multi-Status',
  18. '300': 'Multiple Choices',
  19. '301': 'Moved Permanently',
  20. '302': 'Moved Temporarily',
  21. '303': 'See Other',
  22. '304': 'Not Modified',
  23. '305': 'Use Proxy',
  24. '307': 'Temporary Redirect',
  25. '400': 'Bad Request',
  26. '401': 'Unauthorized',
  27. '402': 'Payment Required',
  28. '403': 'Forbidden',
  29. '404': 'Not Found',
  30. '405': 'Method Not Allowed',
  31. '406': 'Not Acceptable',
  32. '407': 'Proxy Authentication Required',
  33. '408': 'Request Time-out',
  34. '409': 'Conflict',
  35. '410': 'Gone',
  36. '411': 'Length Required',
  37. '412': 'Precondition Failed',
  38. '413': 'Request Entity Too Large',
  39. '414': 'Request-URI Too Large',
  40. '415': 'Unsupported Media Type',
  41. '416': 'Requested Range Not Satisfiable',
  42. '417': 'Expectation Failed',
  43. '418': 'I\'m a teapot',
  44. '422': 'Unprocessable Entity',
  45. '423': 'Locked',
  46. '424': 'Failed Dependency',
  47. '425': 'Unordered Collection',
  48. '426': 'Upgrade Required',
  49. '428': 'Precondition Required',
  50. '429': 'Too Many Requests',
  51. '431': 'Request Header Fields Too Large',
  52. '451': 'Unavailable For Legal Reasons',
  53. '500': 'Internal Server Error',
  54. '501': 'Not Implemented',
  55. '502': 'Bad Gateway',
  56. '503': 'Service Unavailable',
  57. '504': 'Gateway Time-out',
  58. '505': 'HTTP Version Not Supported',
  59. '506': 'Variant Also Negotiates',
  60. '507': 'Insufficient Storage',
  61. '509': 'Bandwidth Limit Exceeded',
  62. '510': 'Not Extended',
  63. '511': 'Network Authentication Required'
  64. }, null)
  65. };
  66. exports.wrap = function (error, statusCode, message) {
  67. Hoek.assert(error instanceof Error, 'Cannot wrap non-Error object');
  68. Hoek.assert(!error.isBoom || (!statusCode && !message), 'Cannot provide statusCode or message with boom error');
  69. return (error.isBoom ? error : internals.initialize(error, statusCode || 500, message));
  70. };
  71. exports.create = function (statusCode, message, data) {
  72. return internals.create(statusCode, message, data, exports.create);
  73. };
  74. internals.create = function (statusCode, message, data, ctor) {
  75. if (message instanceof Error) {
  76. if (data) {
  77. message.data = data;
  78. }
  79. return exports.wrap(message, statusCode);
  80. }
  81. const error = new Error(message ? message : undefined); // Avoids settings null message
  82. Error.captureStackTrace(error, ctor); // Filter the stack to our external API
  83. error.data = data || null;
  84. internals.initialize(error, statusCode);
  85. return error;
  86. };
  87. internals.initialize = function (error, statusCode, message) {
  88. const numberCode = parseInt(statusCode, 10);
  89. Hoek.assert(!isNaN(numberCode) && numberCode >= 400, 'First argument must be a number (400+):', statusCode);
  90. error.isBoom = true;
  91. error.isServer = numberCode >= 500;
  92. if (!error.hasOwnProperty('data')) {
  93. error.data = null;
  94. }
  95. error.output = {
  96. statusCode: numberCode,
  97. payload: {},
  98. headers: {}
  99. };
  100. error.reformat = internals.reformat;
  101. error.reformat();
  102. if (!message &&
  103. !error.message) {
  104. message = error.output.payload.error;
  105. }
  106. if (message) {
  107. error.message = (message + (error.message ? ': ' + error.message : ''));
  108. }
  109. return error;
  110. };
  111. internals.reformat = function () {
  112. this.output.payload.statusCode = this.output.statusCode;
  113. this.output.payload.error = internals.STATUS_CODES[this.output.statusCode] || 'Unknown';
  114. if (this.output.statusCode === 500) {
  115. this.output.payload.message = 'An internal server error occurred'; // Hide actual error from user
  116. }
  117. else if (this.message) {
  118. this.output.payload.message = this.message;
  119. }
  120. };
  121. // 4xx Client Errors
  122. exports.badRequest = function (message, data) {
  123. return internals.create(400, message, data, exports.badRequest);
  124. };
  125. exports.unauthorized = function (message, scheme, attributes) { // Or function (message, wwwAuthenticate[])
  126. const err = internals.create(401, message, undefined, exports.unauthorized);
  127. if (!scheme) {
  128. return err;
  129. }
  130. let wwwAuthenticate = '';
  131. if (typeof scheme === 'string') {
  132. // function (message, scheme, attributes)
  133. wwwAuthenticate = scheme;
  134. if (attributes || message) {
  135. err.output.payload.attributes = {};
  136. }
  137. if (attributes) {
  138. if (typeof attributes === 'string') {
  139. wwwAuthenticate = wwwAuthenticate + ' ' + Hoek.escapeHeaderAttribute(attributes);
  140. err.output.payload.attributes = attributes;
  141. }
  142. else {
  143. const names = Object.keys(attributes);
  144. for (let i = 0; i < names.length; ++i) {
  145. const name = names[i];
  146. if (i) {
  147. wwwAuthenticate = wwwAuthenticate + ',';
  148. }
  149. let value = attributes[name];
  150. if (value === null ||
  151. value === undefined) { // Value can be zero
  152. value = '';
  153. }
  154. wwwAuthenticate = wwwAuthenticate + ' ' + name + '="' + Hoek.escapeHeaderAttribute(value.toString()) + '"';
  155. err.output.payload.attributes[name] = value;
  156. }
  157. }
  158. }
  159. if (message) {
  160. if (attributes) {
  161. wwwAuthenticate = wwwAuthenticate + ',';
  162. }
  163. wwwAuthenticate = wwwAuthenticate + ' error="' + Hoek.escapeHeaderAttribute(message) + '"';
  164. err.output.payload.attributes.error = message;
  165. }
  166. else {
  167. err.isMissing = true;
  168. }
  169. }
  170. else {
  171. // function (message, wwwAuthenticate[])
  172. const wwwArray = scheme;
  173. for (let i = 0; i < wwwArray.length; ++i) {
  174. if (i) {
  175. wwwAuthenticate = wwwAuthenticate + ', ';
  176. }
  177. wwwAuthenticate = wwwAuthenticate + wwwArray[i];
  178. }
  179. }
  180. err.output.headers['WWW-Authenticate'] = wwwAuthenticate;
  181. return err;
  182. };
  183. exports.paymentRequired = function (message, data) {
  184. return internals.create(402, message, data, exports.paymentRequired);
  185. };
  186. exports.forbidden = function (message, data) {
  187. return internals.create(403, message, data, exports.forbidden);
  188. };
  189. exports.notFound = function (message, data) {
  190. return internals.create(404, message, data, exports.notFound);
  191. };
  192. exports.methodNotAllowed = function (message, data, allow) {
  193. const err = internals.create(405, message, data, exports.methodNotAllowed);
  194. if (typeof allow === 'string') {
  195. allow = [allow];
  196. }
  197. if (Array.isArray(allow)) {
  198. err.output.headers.Allow = allow.join(', ');
  199. }
  200. return err;
  201. };
  202. exports.notAcceptable = function (message, data) {
  203. return internals.create(406, message, data, exports.notAcceptable);
  204. };
  205. exports.proxyAuthRequired = function (message, data) {
  206. return internals.create(407, message, data, exports.proxyAuthRequired);
  207. };
  208. exports.clientTimeout = function (message, data) {
  209. return internals.create(408, message, data, exports.clientTimeout);
  210. };
  211. exports.conflict = function (message, data) {
  212. return internals.create(409, message, data, exports.conflict);
  213. };
  214. exports.resourceGone = function (message, data) {
  215. return internals.create(410, message, data, exports.resourceGone);
  216. };
  217. exports.lengthRequired = function (message, data) {
  218. return internals.create(411, message, data, exports.lengthRequired);
  219. };
  220. exports.preconditionFailed = function (message, data) {
  221. return internals.create(412, message, data, exports.preconditionFailed);
  222. };
  223. exports.entityTooLarge = function (message, data) {
  224. return internals.create(413, message, data, exports.entityTooLarge);
  225. };
  226. exports.uriTooLong = function (message, data) {
  227. return internals.create(414, message, data, exports.uriTooLong);
  228. };
  229. exports.unsupportedMediaType = function (message, data) {
  230. return internals.create(415, message, data, exports.unsupportedMediaType);
  231. };
  232. exports.rangeNotSatisfiable = function (message, data) {
  233. return internals.create(416, message, data, exports.rangeNotSatisfiable);
  234. };
  235. exports.expectationFailed = function (message, data) {
  236. return internals.create(417, message, data, exports.expectationFailed);
  237. };
  238. exports.teapot = function (message, data) {
  239. return internals.create(418, message, data, exports.teapot);
  240. };
  241. exports.badData = function (message, data) {
  242. return internals.create(422, message, data, exports.badData);
  243. };
  244. exports.locked = function (message, data) {
  245. return internals.create(423, message, data, exports.locked);
  246. };
  247. exports.preconditionRequired = function (message, data) {
  248. return internals.create(428, message, data, exports.preconditionRequired);
  249. };
  250. exports.tooManyRequests = function (message, data) {
  251. return internals.create(429, message, data, exports.tooManyRequests);
  252. };
  253. exports.illegal = function (message, data) {
  254. return internals.create(451, message, data, exports.illegal);
  255. };
  256. // 5xx Server Errors
  257. exports.internal = function (message, data, statusCode) {
  258. return internals.serverError(message, data, statusCode, exports.internal);
  259. };
  260. internals.serverError = function (message, data, statusCode, ctor) {
  261. let error;
  262. if (data instanceof Error) {
  263. error = exports.wrap(data, statusCode, message);
  264. }
  265. else {
  266. error = internals.create(statusCode || 500, message, undefined, ctor);
  267. error.data = data;
  268. }
  269. return error;
  270. };
  271. exports.notImplemented = function (message, data) {
  272. return internals.serverError(message, data, 501, exports.notImplemented);
  273. };
  274. exports.badGateway = function (message, data) {
  275. return internals.serverError(message, data, 502, exports.badGateway);
  276. };
  277. exports.serverUnavailable = function (message, data) {
  278. return internals.serverError(message, data, 503, exports.serverUnavailable);
  279. };
  280. exports.gatewayTimeout = function (message, data) {
  281. return internals.serverError(message, data, 504, exports.gatewayTimeout);
  282. };
  283. exports.badImplementation = function (message, data) {
  284. const err = internals.serverError(message, data, 500, exports.badImplementation);
  285. err.isDeveloperError = true;
  286. return err;
  287. };