5 var contentDisposition = require('content-disposition');
6 var deprecate = require('depd')('express');
7 var mime = require('send').mime;
8 var basename = require('path').basename;
9 var etag = require('etag');
10 var proxyaddr = require('proxy-addr');
11 var qs = require('qs');
12 var querystring = require('querystring');
13 var typer = require('media-typer');
16 * Return strong ETag for `body`.
18 * @param {String|Buffer} body
19 * @param {String} [encoding]
24 exports.etag = function (body, encoding) {
25 var buf = !Buffer.isBuffer(body)
26 ? new Buffer(body, encoding)
29 return etag(buf, {weak: false});
33 * Return weak ETag for `body`.
35 * @param {String|Buffer} body
36 * @param {String} [encoding]
41 exports.wetag = function wetag(body, encoding){
42 var buf = !Buffer.isBuffer(body)
43 ? new Buffer(body, encoding)
46 return etag(buf, {weak: true});
50 * Check if `path` looks absolute.
52 * @param {String} path
57 exports.isAbsolute = function(path){
58 if ('/' == path[0]) return true;
59 if (':' == path[1] && '\\' == path[2]) return true;
60 if ('\\\\' == path.substring(0, 2)) return true; // Microsoft Azure absolute path
64 * Flatten the given `arr`.
71 exports.flatten = function(arr, ret){
74 for (var i = 0; i < len; ++i) {
75 if (Array.isArray(arr[i])) {
76 exports.flatten(arr[i], ret);
85 * Normalize the given `type`, for example "html" becomes "text/html".
87 * @param {String} type
92 exports.normalizeType = function(type){
93 return ~type.indexOf('/')
95 : { value: mime.lookup(type), params: {} };
99 * Normalize `types`, for example "html" becomes "text/html".
101 * @param {Array} types
106 exports.normalizeTypes = function(types){
109 for (var i = 0; i < types.length; ++i) {
110 ret.push(exports.normalizeType(types[i]));
117 * Generate Content-Disposition header appropriate for the filename.
118 * non-ascii filenames are urlencoded and a filename* parameter is added
120 * @param {String} filename
125 exports.contentDisposition = deprecate.function(contentDisposition,
126 'utils.contentDisposition: use content-disposition npm module instead');
129 * Parse accept params `str` returning an
130 * object with `.value`, `.quality` and `.params`.
131 * also includes `.originalIndex` for stable sorting
133 * @param {String} str
138 function acceptParams(str, index) {
139 var parts = str.split(/ *; */);
140 var ret = { value: parts[0], quality: 1, params: {}, originalIndex: index };
142 for (var i = 1; i < parts.length; ++i) {
143 var pms = parts[i].split(/ *= */);
145 ret.quality = parseFloat(pms[1]);
147 ret.params[pms[0]] = pms[1];
155 * Compile "etag" value to function.
157 * @param {Boolean|String|Function} val
162 exports.compileETag = function(val) {
165 if (typeof val === 'function') {
182 throw new TypeError('unknown value for etag function: ' + val);
189 * Compile "query parser" value to function.
191 * @param {String|Function} val
196 exports.compileQueryParser = function compileQueryParser(val) {
199 if (typeof val === 'function') {
205 fn = querystring.parse;
214 fn = querystring.parse;
217 throw new TypeError('unknown value for query parser function: ' + val);
224 * Compile "proxy trust" value to function.
226 * @param {Boolean|String|Number|Array|Function} val
231 exports.compileTrust = function(val) {
232 if (typeof val === 'function') return val;
235 // Support plain true/false
236 return function(){ return true };
239 if (typeof val === 'number') {
240 // Support trusting hop count
241 return function(a, i){ return i < val };
244 if (typeof val === 'string') {
245 // Support comma-separated values
246 val = val.split(/ *, */);
249 return proxyaddr.compile(val || []);
253 * Set the charset in a given Content-Type string.
255 * @param {String} type
256 * @param {String} charset
261 exports.setCharset = function(type, charset){
262 if (!type || !charset) return type;
265 var parsed = typer.parse(type);
268 parsed.parameters.charset = charset;
271 return typer.format(parsed);
275 * Return new empty object.
281 function newObject() {