1 import * as express from 'express'
2 import { readdir, readFile } from 'fs-extra'
3 import { join } from 'path'
4 import { logger, mtimeSortFilesDesc } from '@server/helpers/logger'
5 import { LogLevel } from '../../../../shared/models/server/log-level.type'
6 import { UserRight } from '../../../../shared/models/users'
7 import { CONFIG } from '../../../initializers/config'
8 import { AUDIT_LOG_FILENAME, LOG_FILENAME, MAX_LOGS_OUTPUT_CHARACTERS } from '../../../initializers/constants'
9 import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../../middlewares'
10 import { getAuditLogsValidator, getLogsValidator } from '../../../middlewares/validators/logs'
12 const logsRouter = express.Router()
14 logsRouter.get('/logs',
16 ensureUserHasRight(UserRight.MANAGE_LOGS),
18 asyncMiddleware(getLogs)
21 logsRouter.get('/audit-logs',
23 ensureUserHasRight(UserRight.MANAGE_LOGS),
24 getAuditLogsValidator,
25 asyncMiddleware(getAuditLogs)
28 // ---------------------------------------------------------------------------
34 // ---------------------------------------------------------------------------
36 const auditLogNameFilter = generateLogNameFilter(AUDIT_LOG_FILENAME)
37 async function getAuditLogs (req: express.Request, res: express.Response) {
38 const output = await generateOutput({
39 startDateQuery: req.query.startDate,
40 endDateQuery: req.query.endDate,
42 nameFilter: auditLogNameFilter
45 return res.json(output).end()
48 const logNameFilter = generateLogNameFilter(LOG_FILENAME)
49 async function getLogs (req: express.Request, res: express.Response) {
50 const output = await generateOutput({
51 startDateQuery: req.query.startDate,
52 endDateQuery: req.query.endDate,
53 level: req.query.level || 'info',
54 nameFilter: logNameFilter
57 return res.json(output).end()
60 async function generateOutput (options: {
61 startDateQuery: string
66 const { startDateQuery, level, nameFilter } = options
68 const logFiles = await readdir(CONFIG.STORAGE.LOG_DIR)
69 const sortedLogFiles = await mtimeSortFilesDesc(logFiles, CONFIG.STORAGE.LOG_DIR)
72 const startDate = new Date(startDateQuery)
73 const endDate = options.endDateQuery ? new Date(options.endDateQuery) : new Date()
75 let output: string[] = []
77 for (const meta of sortedLogFiles) {
78 if (nameFilter.exec(meta.file) === null) continue
80 const path = join(CONFIG.STORAGE.LOG_DIR, meta.file)
81 logger.debug('Opening %s to fetch logs.', path)
83 const result = await getOutputFromFile(path, startDate, endDate, level, currentSize)
84 if (!result.output) break
86 output = result.output.concat(output)
87 currentSize = result.currentSize
89 if (currentSize > MAX_LOGS_OUTPUT_CHARACTERS || (result.logTime && result.logTime < startDate.getTime())) break
95 async function getOutputFromFile (path: string, startDate: Date, endDate: Date, level: LogLevel, currentSize: number) {
96 const startTime = startDate.getTime()
97 const endTime = endDate.getTime()
100 const logsLevel: { [ id in LogLevel ]: number } = {
108 const content = await readFile(path)
109 const lines = content.toString().split('\n')
110 const output: any[] = []
112 for (let i = lines.length - 1; i >= 0; i--) {
113 const line = lines[i]
117 log = JSON.parse(line)
119 // Maybe there a multiple \n at the end of the file
123 logTime = new Date(log.timestamp).getTime()
124 if (logTime >= startTime && logTime <= endTime && logsLevel[log.level] >= logsLevel[level]) {
127 currentSize += line.length
129 if (currentSize > MAX_LOGS_OUTPUT_CHARACTERS) break
130 } else if (logTime < startTime) {
135 return { currentSize, output: output.reverse(), logTime }
138 function generateLogNameFilter (baseName: string) {
139 return new RegExp('^' + baseName.replace(/\.log$/, '') + '\\d*.log$')