uptime-kuma/server/routers/api-router.js

303 lines
8.2 KiB
JavaScript
Raw Normal View History

2021-09-14 06:55:45 +00:00
let express = require("express");
2022-01-03 14:48:52 +00:00
const { allowDevAllOrigin, getSettings, setting, percentageToColor } = require("../util-server");
2021-09-14 06:55:45 +00:00
const { R } = require("redbean-node");
2021-09-15 12:40:26 +00:00
const server = require("../server");
const apicache = require("../modules/apicache");
2021-09-22 07:10:08 +00:00
const Monitor = require("../model/monitor");
2021-09-30 16:09:43 +00:00
const dayjs = require("dayjs");
const { UP, flipStatus, debug } = require("../../src/util");
2022-01-03 14:48:52 +00:00
const { makeBadge } = require("badge-maker");
2021-09-14 06:55:45 +00:00
let router = express.Router();
let cache = apicache.middleware;
2021-09-30 16:09:43 +00:00
let io = server.io;
2021-09-15 12:40:26 +00:00
router.get("/api/entry-page", async (_, response) => {
allowDevAllOrigin(response);
response.json(server.entryPage);
});
2021-09-30 16:09:43 +00:00
router.get("/api/push/:pushToken", async (request, response) => {
try {
2021-09-30 16:09:43 +00:00
let pushToken = request.params.pushToken;
let msg = request.query.msg || "OK";
let ping = request.query.ping || null;
2021-09-30 16:09:43 +00:00
let monitor = await R.findOne("monitor", " push_token = ? AND active = 1 ", [
pushToken
]);
if (! monitor) {
throw new Error("Monitor not found or not active.");
}
2021-12-08 06:59:59 +00:00
const previousHeartbeat = await Monitor.getPreviousHeartbeat(monitor.id);
let status = UP;
if (monitor.isUpsideDown()) {
status = flipStatus(status);
}
let isFirstBeat = true;
let previousStatus = status;
let duration = 0;
2021-09-30 16:09:43 +00:00
let bean = R.dispense("heartbeat");
bean.time = R.isoDateTime(dayjs.utc());
if (previousHeartbeat) {
isFirstBeat = false;
previousStatus = previousHeartbeat.status;
duration = dayjs(bean.time).diff(dayjs(previousHeartbeat.time), "second");
}
debug("PreviousStatus: " + previousStatus);
debug("Current Status: " + status);
bean.important = Monitor.isImportantBeat(isFirstBeat, previousStatus, status);
bean.monitor_id = monitor.id;
bean.status = status;
2021-09-30 16:09:43 +00:00
bean.msg = msg;
2021-10-01 08:43:11 +00:00
bean.ping = ping;
bean.duration = duration;
2021-09-30 16:26:27 +00:00
2021-09-30 16:09:43 +00:00
await R.store(bean);
io.to(monitor.user_id).emit("heartbeat", bean.toJSON());
Monitor.sendStats(io, monitor.id, monitor.user_id);
response.json({
ok: true,
});
if (bean.important) {
await Monitor.sendNotification(isFirstBeat, monitor, bean);
}
2021-09-30 16:09:43 +00:00
} catch (e) {
response.json({
ok: false,
msg: e.message
});
}
});
2021-09-14 06:55:45 +00:00
// Status Page Config
router.get("/api/status-page/config", async (_request, response) => {
allowDevAllOrigin(response);
2021-09-15 06:34:30 +00:00
2021-09-20 12:44:07 +00:00
let config = await getSettings("statusPage");
2021-09-14 06:55:45 +00:00
if (! config.statusPageTheme) {
config.statusPageTheme = "light";
}
2021-09-15 06:34:30 +00:00
if (! config.statusPagePublished) {
config.statusPagePublished = true;
}
2021-10-29 05:19:24 +00:00
if (! config.statusPageTags) {
config.statusPageTags = false;
2021-10-29 05:19:24 +00:00
}
2021-09-14 15:27:11 +00:00
if (! config.title) {
config.title = "Uptime Kuma";
}
2021-09-14 06:55:45 +00:00
response.json(config);
});
2021-09-15 06:34:30 +00:00
// Status Page - Get the current Incident
// Can fetch only if published
router.get("/api/status-page/incident", async (_, response) => {
allowDevAllOrigin(response);
try {
await checkPublished();
let incident = await R.findOne("incident", " pin = 1 AND active = 1");
if (incident) {
incident = incident.toPublicJSON();
}
2021-09-16 14:48:28 +00:00
response.json({
ok: true,
incident,
});
2021-09-15 06:34:30 +00:00
} catch (error) {
send403(response, error.message);
}
});
2021-09-14 06:55:45 +00:00
// Status Page - Monitor List
2021-09-15 06:34:30 +00:00
// Can fetch only if published
router.get("/api/status-page/monitor-list", cache("5 minutes"), async (_request, response) => {
2021-09-14 06:55:45 +00:00
allowDevAllOrigin(response);
2021-09-15 06:34:30 +00:00
try {
await checkPublished();
const publicGroupList = [];
const tagsVisible = (await getSettings("statusPage")).statusPageTags;
const list = await R.find("group", " public = 1 ORDER BY weight ");
for (let groupBean of list) {
let monitorGroup = await groupBean.toPublicJSON();
if (tagsVisible) {
monitorGroup.monitorList = await Promise.all(monitorGroup.monitorList.map(async (monitor) => {
2021-10-29 05:19:24 +00:00
// Includes tags as an array in response, allows for tags to be displayed on public status page
const tags = await R.getAll(
`SELECT monitor_tag.monitor_id, monitor_tag.value, tag.name, tag.color
FROM monitor_tag
JOIN tag
ON monitor_tag.tag_id = tag.id
WHERE monitor_tag.monitor_id = ?`, [monitor.id]
2021-12-08 06:59:59 +00:00
);
2021-12-08 07:04:18 +00:00
return {
...monitor,
tags: tags
};
}));
2021-10-29 05:19:24 +00:00
}
2021-10-28 02:07:19 +00:00
publicGroupList.push(monitorGroup);
2021-09-15 06:34:30 +00:00
}
response.json(publicGroupList);
2021-09-14 06:55:45 +00:00
2021-09-15 06:34:30 +00:00
} catch (error) {
send403(response, error.message);
}
2021-09-14 06:55:45 +00:00
});
// Status Page Polling Data
2021-09-15 06:34:30 +00:00
// Can fetch only if published
router.get("/api/status-page/heartbeat", cache("5 minutes"), async (_request, response) => {
2021-09-14 06:55:45 +00:00
allowDevAllOrigin(response);
2021-09-23 10:45:30 +00:00
2021-09-15 06:34:30 +00:00
try {
await checkPublished();
2021-09-14 06:55:45 +00:00
let heartbeatList = {};
2021-09-22 07:10:08 +00:00
let uptimeList = {};
let monitorIDList = await R.getCol(`
SELECT monitor_group.monitor_id FROM monitor_group, \`group\`
WHERE monitor_group.group_id = \`group\`.id
AND public = 1
`);
for (let monitorID of monitorIDList) {
let list = await R.getAll(`
SELECT * FROM heartbeat
WHERE monitor_id = ?
ORDER BY time DESC
2021-09-22 07:10:08 +00:00
LIMIT 50
`, [
monitorID,
]);
list = R.convertToBeans("heartbeat", list);
heartbeatList[monitorID] = list.reverse().map(row => row.toPublicJSON());
2021-09-22 07:10:08 +00:00
const type = 24;
uptimeList[`${monitorID}_${type}`] = await Monitor.calcUptime(type, monitorID);
2021-09-15 06:34:30 +00:00
}
response.json({
heartbeatList,
2021-09-22 07:10:08 +00:00
uptimeList
2021-09-15 06:34:30 +00:00
});
2021-09-14 06:55:45 +00:00
2021-09-15 06:34:30 +00:00
} catch (error) {
send403(response, error.message);
}
2021-09-14 06:55:45 +00:00
});
2022-01-03 14:48:52 +00:00
router.get("/api/badge/:id/:type", cache("5 minutes"), async (request, response) => {
allowDevAllOrigin(response);
const {
label,
labelPrefix,
labelSuffix = "h",
prefix,
suffix,
} = request.query;
try {
await checkPublished();
const requestedMonitorId = parseInt(request.params.id, 10);
const requestedType = parseInt(request.params.type, 10) ?? 24;
let publicMonitor = await R.getRow(`
SELECT monitor_group.monitor_id FROM monitor_group, \`group\`
WHERE monitor_group.group_id = \`group\`.id
AND monitor_group.monitor_id = ?
AND public = 1
`,
[requestedMonitorId]
);
const badgeValues = {};
if (!publicMonitor) {
badgeValues.message = "N/A";
badgeValues.color = "#CCCCCC";
} else {
const uptime = await Monitor.calcUptime(
requestedType,
requestedMonitorId
);
badgeValues.color = percentageToColor(uptime);
badgeValues.label = [labelPrefix, label ?? requestedType, labelSuffix]
.filter((part) => part ?? part !== "")
.join("");
badgeValues.message = [prefix, `${uptime * 100} %`, suffix]
.filter((part) => part ?? part !== "")
.join("");
}
const svg = makeBadge(badgeValues);
response.type("image/svg+xml");
response.send(svg);
} catch (error) {
send403(response, error.message);
}
}
);
2021-09-15 06:34:30 +00:00
async function checkPublished() {
if (! await isPublished()) {
throw new Error("The status page is not published");
}
}
2021-09-15 10:28:48 +00:00
/**
* Default is published
* @returns {Promise<boolean>}
*/
2021-09-15 06:34:30 +00:00
async function isPublished() {
2021-09-15 10:28:48 +00:00
const value = await setting("statusPagePublished");
if (value === null) {
return true;
}
return value;
2021-09-15 06:34:30 +00:00
}
function send403(res, msg = "") {
res.status(403).json({
"status": "fail",
"msg": msg,
});
2021-09-15 06:34:30 +00:00
}
2021-09-14 06:55:45 +00:00
module.exports = router;