1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
7 |
|
8 |
|
9 |
|
10 | 'use strict'
|
11 |
|
12 |
|
13 |
|
14 |
|
15 |
|
16 |
|
17 | module.exports = morgan
|
18 | module.exports.compile = compile
|
19 | module.exports.format = format
|
20 | module.exports.token = token
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 | var auth = require('basic-auth')
|
28 | var debug = require('debug')('morgan')
|
29 | var deprecate = require('depd')('morgan')
|
30 | var onFinished = require('on-finished')
|
31 | var onHeaders = require('on-headers')
|
32 |
|
33 |
|
34 |
|
35 |
|
36 |
|
37 |
|
38 | var CLF_MONTH = [
|
39 | 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
|
40 | 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
|
41 | ]
|
42 |
|
43 |
|
44 |
|
45 |
|
46 |
|
47 |
|
48 | var DEFAULT_BUFFER_DURATION = 1000
|
49 |
|
50 |
|
51 |
|
52 |
|
53 |
|
54 |
|
55 |
|
56 |
|
57 |
|
58 |
|
59 | function morgan (format, options) {
|
60 | var fmt = format
|
61 | var opts = options || {}
|
62 |
|
63 | if (format && typeof format === 'object') {
|
64 | opts = format
|
65 | fmt = opts.format || 'default'
|
66 |
|
67 |
|
68 | deprecate('morgan(options): use morgan(' + (typeof fmt === 'string' ? JSON.stringify(fmt) : 'format') + ', options) instead')
|
69 | }
|
70 |
|
71 | if (fmt === undefined) {
|
72 | deprecate('undefined format: specify a format')
|
73 | }
|
74 |
|
75 |
|
76 | var immediate = opts.immediate
|
77 |
|
78 |
|
79 | var skip = opts.skip || false
|
80 |
|
81 |
|
82 | var formatLine = typeof fmt !== 'function'
|
83 | ? getFormatFunction(fmt)
|
84 | : fmt
|
85 |
|
86 |
|
87 | var buffer = opts.buffer
|
88 | var stream = opts.stream || process.stdout
|
89 |
|
90 |
|
91 | if (buffer) {
|
92 | deprecate('buffer option')
|
93 |
|
94 |
|
95 | var interval = typeof buffer !== 'number'
|
96 | ? DEFAULT_BUFFER_DURATION
|
97 | : buffer
|
98 |
|
99 |
|
100 | stream = createBufferStream(stream, interval)
|
101 | }
|
102 |
|
103 | return function logger (req, res, next) {
|
104 |
|
105 | req._startAt = undefined
|
106 | req._startTime = undefined
|
107 | req._remoteAddress = getip(req)
|
108 |
|
109 |
|
110 | res._startAt = undefined
|
111 | res._startTime = undefined
|
112 |
|
113 |
|
114 | recordStartTime.call(req)
|
115 |
|
116 | function logRequest () {
|
117 | if (skip !== false && skip(req, res)) {
|
118 | debug('skip request')
|
119 | return
|
120 | }
|
121 |
|
122 | var line = formatLine(morgan, req, res)
|
123 |
|
124 | if (line == null) {
|
125 | debug('skip line')
|
126 | return
|
127 | }
|
128 |
|
129 | debug('log request')
|
130 | stream.write(line + '\n')
|
131 | };
|
132 |
|
133 | if (immediate) {
|
134 |
|
135 | logRequest()
|
136 | } else {
|
137 |
|
138 | onHeaders(res, recordStartTime)
|
139 |
|
140 |
|
141 | onFinished(res, logRequest)
|
142 | }
|
143 |
|
144 | next()
|
145 | }
|
146 | }
|
147 |
|
148 |
|
149 |
|
150 |
|
151 |
|
152 | morgan.format('combined', ':remote-addr - :remote-user [:date[clf]] ":method :url HTTP/:http-version" :status :res[content-length] ":referrer" ":user-agent"')
|
153 |
|
154 |
|
155 |
|
156 |
|
157 |
|
158 | morgan.format('common', ':remote-addr - :remote-user [:date[clf]] ":method :url HTTP/:http-version" :status :res[content-length]')
|
159 |
|
160 |
|
161 |
|
162 |
|
163 |
|
164 | morgan.format('default', ':remote-addr - :remote-user [:date] ":method :url HTTP/:http-version" :status :res[content-length] ":referrer" ":user-agent"')
|
165 | deprecate.property(morgan, 'default', 'default format: use combined format')
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 | morgan.format('short', ':remote-addr :remote-user :method :url HTTP/:http-version :status :res[content-length] - :response-time ms')
|
172 |
|
173 |
|
174 |
|
175 |
|
176 |
|
177 | morgan.format('tiny', ':method :url :status :res[content-length] - :response-time ms')
|
178 |
|
179 |
|
180 |
|
181 |
|
182 |
|
183 | morgan.format('dev', function developmentFormatLine (tokens, req, res) {
|
184 |
|
185 | var status = res._header
|
186 | ? res.statusCode
|
187 | : undefined
|
188 |
|
189 |
|
190 | var color = status >= 500 ? 31
|
191 | : status >= 400 ? 33
|
192 | : status >= 300 ? 36
|
193 | : status >= 200 ? 32
|
194 | : 0
|
195 |
|
196 |
|
197 | var fn = developmentFormatLine[color]
|
198 |
|
199 | if (!fn) {
|
200 |
|
201 | fn = developmentFormatLine[color] = compile('\x1b[0m:method :url \x1b[' +
|
202 | color + 'm:status \x1b[0m:response-time ms - :res[content-length]\x1b[0m')
|
203 | }
|
204 |
|
205 | return fn(tokens, req, res)
|
206 | })
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 | morgan.token('url', function getUrlToken (req) {
|
213 | return req.originalUrl || req.url
|
214 | })
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 | morgan.token('method', function getMethodToken (req) {
|
221 | return req.method
|
222 | })
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 | morgan.token('response-time', function getResponseTimeToken (req, res, digits) {
|
229 | if (!req._startAt || !res._startAt) {
|
230 |
|
231 | return
|
232 | }
|
233 |
|
234 |
|
235 | var ms = (res._startAt[0] - req._startAt[0]) * 1e3 +
|
236 | (res._startAt[1] - req._startAt[1]) * 1e-6
|
237 |
|
238 |
|
239 | return ms.toFixed(digits === undefined ? 3 : digits)
|
240 | })
|
241 |
|
242 |
|
243 |
|
244 |
|
245 |
|
246 | morgan.token('date', function getDateToken (req, res, format) {
|
247 | var date = new Date()
|
248 |
|
249 | switch (format || 'web') {
|
250 | case 'clf':
|
251 | return clfdate(date)
|
252 | case 'iso':
|
253 | return date.toISOString()
|
254 | case 'web':
|
255 | return date.toUTCString()
|
256 | }
|
257 | })
|
258 |
|
259 |
|
260 |
|
261 |
|
262 |
|
263 | morgan.token('status', function getStatusToken (req, res) {
|
264 | return res._header
|
265 | ? String(res.statusCode)
|
266 | : undefined
|
267 | })
|
268 |
|
269 |
|
270 |
|
271 |
|
272 |
|
273 | morgan.token('referrer', function getReferrerToken (req) {
|
274 | return req.headers['referer'] || req.headers['referrer']
|
275 | })
|
276 |
|
277 |
|
278 |
|
279 |
|
280 |
|
281 | morgan.token('remote-addr', getip)
|
282 |
|
283 |
|
284 |
|
285 |
|
286 |
|
287 | morgan.token('remote-user', function getRemoteUserToken (req) {
|
288 |
|
289 | var credentials = auth(req)
|
290 |
|
291 |
|
292 | return credentials
|
293 | ? credentials.name
|
294 | : undefined
|
295 | })
|
296 |
|
297 |
|
298 |
|
299 |
|
300 |
|
301 | morgan.token('http-version', function getHttpVersionToken (req) {
|
302 | return req.httpVersionMajor + '.' + req.httpVersionMinor
|
303 | })
|
304 |
|
305 |
|
306 |
|
307 |
|
308 |
|
309 | morgan.token('user-agent', function getUserAgentToken (req) {
|
310 | return req.headers['user-agent']
|
311 | })
|
312 |
|
313 |
|
314 |
|
315 |
|
316 |
|
317 | morgan.token('req', function getRequestToken (req, res, field) {
|
318 |
|
319 | var header = req.headers[field.toLowerCase()]
|
320 |
|
321 | return Array.isArray(header)
|
322 | ? header.join(', ')
|
323 | : header
|
324 | })
|
325 |
|
326 |
|
327 |
|
328 |
|
329 |
|
330 | morgan.token('res', function getResponseHeader (req, res, field) {
|
331 | if (!res._header) {
|
332 | return undefined
|
333 | }
|
334 |
|
335 |
|
336 | var header = res.getHeader(field)
|
337 |
|
338 | return Array.isArray(header)
|
339 | ? header.join(', ')
|
340 | : header
|
341 | })
|
342 |
|
343 |
|
344 |
|
345 |
|
346 |
|
347 |
|
348 |
|
349 |
|
350 |
|
351 | function clfdate (dateTime) {
|
352 | var date = dateTime.getUTCDate()
|
353 | var hour = dateTime.getUTCHours()
|
354 | var mins = dateTime.getUTCMinutes()
|
355 | var secs = dateTime.getUTCSeconds()
|
356 | var year = dateTime.getUTCFullYear()
|
357 |
|
358 | var month = CLF_MONTH[dateTime.getUTCMonth()]
|
359 |
|
360 | return pad2(date) + '/' + month + '/' + year +
|
361 | ':' + pad2(hour) + ':' + pad2(mins) + ':' + pad2(secs) +
|
362 | ' +0000'
|
363 | }
|
364 |
|
365 |
|
366 |
|
367 |
|
368 |
|
369 |
|
370 |
|
371 |
|
372 |
|
373 | function compile (format) {
|
374 | if (typeof format !== 'string') {
|
375 | throw new TypeError('argument format must be a string')
|
376 | }
|
377 |
|
378 | var fmt = format.replace(/"/g, '\\"')
|
379 | var js = ' "use strict"\n return "' + fmt.replace(/:([-\w]{2,})(?:\[([^\]]+)\])?/g, function (_, name, arg) {
|
380 | var tokenArguments = 'req, res'
|
381 | var tokenFunction = 'tokens[' + String(JSON.stringify(name)) + ']'
|
382 |
|
383 | if (arg !== undefined) {
|
384 | tokenArguments += ', ' + String(JSON.stringify(arg))
|
385 | }
|
386 |
|
387 | return '" +\n (' + tokenFunction + '(' + tokenArguments + ') || "-") + "'
|
388 | }) + '"'
|
389 |
|
390 |
|
391 | return new Function('tokens, req, res', js)
|
392 | }
|
393 |
|
394 |
|
395 |
|
396 |
|
397 |
|
398 |
|
399 |
|
400 |
|
401 |
|
402 | function createBufferStream (stream, interval) {
|
403 | var buf = []
|
404 | var timer = null
|
405 |
|
406 |
|
407 | function flush () {
|
408 | timer = null
|
409 | stream.write(buf.join(''))
|
410 | buf.length = 0
|
411 | }
|
412 |
|
413 |
|
414 | function write (str) {
|
415 | if (timer === null) {
|
416 | timer = setTimeout(flush, interval)
|
417 | }
|
418 |
|
419 | buf.push(str)
|
420 | }
|
421 |
|
422 |
|
423 | return { write: write }
|
424 | }
|
425 |
|
426 |
|
427 |
|
428 |
|
429 |
|
430 |
|
431 |
|
432 |
|
433 |
|
434 | function format (name, fmt) {
|
435 | morgan[name] = fmt
|
436 | return this
|
437 | }
|
438 |
|
439 |
|
440 |
|
441 |
|
442 |
|
443 |
|
444 |
|
445 |
|
446 |
|
447 | function getFormatFunction (name) {
|
448 |
|
449 | var fmt = morgan[name] || name || morgan.default
|
450 |
|
451 |
|
452 | return typeof fmt !== 'function'
|
453 | ? compile(fmt)
|
454 | : fmt
|
455 | }
|
456 |
|
457 |
|
458 |
|
459 |
|
460 |
|
461 |
|
462 |
|
463 |
|
464 |
|
465 | function getip (req) {
|
466 | return req.ip ||
|
467 | req._remoteAddress ||
|
468 | (req.connection && req.connection.remoteAddress) ||
|
469 | undefined
|
470 | }
|
471 |
|
472 |
|
473 |
|
474 |
|
475 |
|
476 |
|
477 |
|
478 |
|
479 |
|
480 | function pad2 (num) {
|
481 | var str = String(num)
|
482 |
|
483 | return (str.length === 1 ? '0' : '') + str
|
484 | }
|
485 |
|
486 |
|
487 |
|
488 |
|
489 |
|
490 |
|
491 | function recordStartTime () {
|
492 | this._startAt = process.hrtime()
|
493 | this._startTime = new Date()
|
494 | }
|
495 |
|
496 |
|
497 |
|
498 |
|
499 |
|
500 |
|
501 |
|
502 |
|
503 |
|
504 |
|
505 | function token (name, fn) {
|
506 | morgan[name] = fn
|
507 | return this
|
508 | }
|