]>
Commit | Line | Data |
---|---|---|
1 | import * as express from 'express' | |
2 | import { UserRight } from '../../../../shared/models/users' | |
3 | import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../../middlewares' | |
4 | import { mtimeSortFilesDesc } from '../../../../shared/core-utils/logs/logs' | |
5 | import { readdir, readFile } from 'fs-extra' | |
6 | import { AUDIT_LOG_FILENAME, MAX_LOGS_OUTPUT_CHARACTERS, LOG_FILENAME } from '../../../initializers/constants' | |
7 | import { join } from 'path' | |
8 | import { getAuditLogsValidator, getLogsValidator } from '../../../middlewares/validators/logs' | |
9 | import { LogLevel } from '../../../../shared/models/server/log-level.type' | |
10 | import { CONFIG } from '../../../initializers/config' | |
11 | import { logger } from '@server/helpers/logger' | |
12 | ||
13 | const logsRouter = express.Router() | |
14 | ||
15 | logsRouter.get('/logs', | |
16 | authenticate, | |
17 | ensureUserHasRight(UserRight.MANAGE_LOGS), | |
18 | getLogsValidator, | |
19 | asyncMiddleware(getLogs) | |
20 | ) | |
21 | ||
22 | logsRouter.get('/audit-logs', | |
23 | authenticate, | |
24 | ensureUserHasRight(UserRight.MANAGE_LOGS), | |
25 | getAuditLogsValidator, | |
26 | asyncMiddleware(getAuditLogs) | |
27 | ) | |
28 | ||
29 | // --------------------------------------------------------------------------- | |
30 | ||
31 | export { | |
32 | logsRouter | |
33 | } | |
34 | ||
35 | // --------------------------------------------------------------------------- | |
36 | ||
37 | const auditLogNameFilter = generateLogNameFilter(AUDIT_LOG_FILENAME) | |
38 | async function getAuditLogs (req: express.Request, res: express.Response) { | |
39 | const output = await generateOutput({ | |
40 | startDateQuery: req.query.startDate, | |
41 | endDateQuery: req.query.endDate, | |
42 | level: 'audit', | |
43 | nameFilter: auditLogNameFilter | |
44 | }) | |
45 | ||
46 | return res.json(output).end() | |
47 | } | |
48 | ||
49 | const logNameFilter = generateLogNameFilter(LOG_FILENAME) | |
50 | async function getLogs (req: express.Request, res: express.Response) { | |
51 | const output = await generateOutput({ | |
52 | startDateQuery: req.query.startDate, | |
53 | endDateQuery: req.query.endDate, | |
54 | level: req.query.level || 'info', | |
55 | nameFilter: logNameFilter | |
56 | }) | |
57 | ||
58 | return res.json(output).end() | |
59 | } | |
60 | ||
61 | async function generateOutput (options: { | |
62 | startDateQuery: string, | |
63 | endDateQuery?: string, | |
64 | level: LogLevel, | |
65 | nameFilter: RegExp | |
66 | }) { | |
67 | const { startDateQuery, level, nameFilter } = options | |
68 | ||
69 | const logFiles = await readdir(CONFIG.STORAGE.LOG_DIR) | |
70 | const sortedLogFiles = await mtimeSortFilesDesc(logFiles, CONFIG.STORAGE.LOG_DIR) | |
71 | let currentSize = 0 | |
72 | ||
73 | const startDate = new Date(startDateQuery) | |
74 | const endDate = options.endDateQuery ? new Date(options.endDateQuery) : new Date() | |
75 | ||
76 | let output: string[] = [] | |
77 | ||
78 | for (const meta of sortedLogFiles) { | |
79 | if (nameFilter.exec(meta.file) === null) continue | |
80 | ||
81 | const path = join(CONFIG.STORAGE.LOG_DIR, meta.file) | |
82 | logger.debug('Opening %s to fetch logs.', path) | |
83 | ||
84 | const result = await getOutputFromFile(path, startDate, endDate, level, currentSize) | |
85 | if (!result.output) break | |
86 | ||
87 | output = result.output.concat(output) | |
88 | currentSize = result.currentSize | |
89 | ||
90 | if (currentSize > MAX_LOGS_OUTPUT_CHARACTERS || (result.logTime && result.logTime < startDate.getTime())) break | |
91 | } | |
92 | ||
93 | return output | |
94 | } | |
95 | ||
96 | async function getOutputFromFile (path: string, startDate: Date, endDate: Date, level: LogLevel, currentSize: number) { | |
97 | const startTime = startDate.getTime() | |
98 | const endTime = endDate.getTime() | |
99 | let logTime: number | |
100 | ||
101 | const logsLevel: { [ id in LogLevel ]: number } = { | |
102 | audit: -1, | |
103 | debug: 0, | |
104 | info: 1, | |
105 | warn: 2, | |
106 | error: 3 | |
107 | } | |
108 | ||
109 | const content = await readFile(path) | |
110 | const lines = content.toString().split('\n') | |
111 | const output: any[] = [] | |
112 | ||
113 | for (let i = lines.length - 1; i >= 0; i--) { | |
114 | const line = lines[ i ] | |
115 | let log: any | |
116 | ||
117 | try { | |
118 | log = JSON.parse(line) | |
119 | } catch { | |
120 | // Maybe there a multiple \n at the end of the file | |
121 | continue | |
122 | } | |
123 | ||
124 | logTime = new Date(log.timestamp).getTime() | |
125 | if (logTime >= startTime && logTime <= endTime && logsLevel[ log.level ] >= logsLevel[ level ]) { | |
126 | output.push(log) | |
127 | ||
128 | currentSize += line.length | |
129 | ||
130 | if (currentSize > MAX_LOGS_OUTPUT_CHARACTERS) break | |
131 | } else if (logTime < startTime) { | |
132 | break | |
133 | } | |
134 | } | |
135 | ||
136 | return { currentSize, output: output.reverse(), logTime } | |
137 | } | |
138 | ||
139 | function generateLogNameFilter (baseName: string) { | |
140 | return new RegExp('^' + baseName.replace(/\.log$/, '') + '\\d*.log$') | |
141 | } |