Merge branch 'master' into extracted-group-monitor

server/model/maintenance.js

@@ -239,19 +239,7 @@ class Maintenance extends BeanModel {
                     this.beanMeta.status = "under-maintenance";
                     clearTimeout(this.beanMeta.durationTimeout);
 
-                    // Check if duration is still in the window. If not, use the duration from the current time to the end of the window
-                    let duration;
-
-                    if (customDuration > 0) {
-                        duration = customDuration;
-                    } else if (this.end_date) {
-                        let d = dayjs(this.end_date).diff(dayjs(), "second");
-                        if (d < this.duration) {
-                            duration = d * 1000;
-                        }
-                    } else {
-                        duration = this.duration * 1000;
-                    }
+                    let duration = this.inferDuration(customDuration);
 
                     UptimeKumaServer.getInstance().sendMaintenanceListByUserID(this.user_id);
 
@@ -263,9 +251,21 @@ class Maintenance extends BeanModel {
                 };
 
                 // Create Cron
-                this.beanMeta.job = new Cron(this.cron, {
-                    timezone: await this.getTimezone(),
-                }, startEvent);
+                if (this.strategy === "recurring-interval") {
+                    // For recurring-interval, Croner needs to have interval and startAt
+                    const startDate = dayjs(this.startDate);
+                    const [ hour, minute ] = this.startTime.split(":");
+                    const startDateTime = startDate.hour(hour).minute(minute);
+                    this.beanMeta.job = new Cron(this.cron, {
+                        timezone: await this.getTimezone(),
+                        interval: this.interval_day * 24 * 60 * 60,
+                        startAt: startDateTime.toISOString(),
+                    }, startEvent);
+                } else {
+                    this.beanMeta.job = new Cron(this.cron, {
+                        timezone: await this.getTimezone(),
+                    }, startEvent);
+                }
 
                 // Continue if the maintenance is still in the window
                 let runningTimeslot = this.getRunningTimeslot();
@@ -311,6 +311,24 @@ class Maintenance extends BeanModel {
         }
     }
 
+    /**
+     * Calculate the maintenance duration
+     * @param {number} customDuration - The custom duration in milliseconds.
+     * @returns {number} The inferred duration in milliseconds.
+     */
+    inferDuration(customDuration) {
+        // Check if duration is still in the window. If not, use the duration from the current time to the end of the window
+        if (customDuration > 0) {
+            return customDuration;
+        } else if (this.end_date) {
+            let d = dayjs(this.end_date).diff(dayjs(), "second");
+            if (d < this.duration) {
+                return d * 1000;
+            }
+        }
+        return this.duration * 1000;
+    }
+
     /**
      * Stop the maintenance
      * @returns {void}
@@ -395,10 +413,8 @@ class Maintenance extends BeanModel {
         } else if (!this.strategy.startsWith("recurring-")) {
             this.cron = "";
         } else if (this.strategy === "recurring-interval") {
-            let array = this.start_time.split(":");
-            let hour = parseInt(array[0]);
-            let minute = parseInt(array[1]);
-            this.cron = minute + " " + hour + " */" + this.interval_day + " * *";
+            // For intervals, the pattern is calculated in the run function as the interval-option is set
+            this.cron = "* * * * *";
             this.duration = this.calcDuration();
             log.debug("maintenance", "Cron: " + this.cron);
             log.debug("maintenance", "Duration: " + this.duration);

server/model/monitor.js

@@ -2,7 +2,7 @@ const dayjs = require("dayjs");
 const axios = require("axios");
 const { Prometheus } = require("../prometheus");
 const { log, UP, DOWN, PENDING, MAINTENANCE, flipStatus, MAX_INTERVAL_SECOND, MIN_INTERVAL_SECOND,
-    SQL_DATETIME_FORMAT
+    SQL_DATETIME_FORMAT, evaluateJsonQuery
 } = require("../../src/util");
 const { tcping, ping, checkCertificate, checkStatusCode, getTotalClientInRoom, setting, mssqlQuery, postgresQuery, mysqlQuery, setSetting, httpNtlm, radius, grpcQuery,
     redisPingAsync, kafkaProducerAsync, getOidcTokenClientCredentials, rootCertificatesFingerprints, axiosAbortSignal
@@ -17,7 +17,6 @@ const apicache = require("../modules/apicache");
 const { UptimeKumaServer } = require("../uptime-kuma-server");
 const { DockerHost } = require("../docker");
 const Gamedig = require("gamedig");
-const jsonata = require("jsonata");
 const jwt = require("jsonwebtoken");
 const crypto = require("crypto");
 const { UptimeCalculator } = require("../uptime-calculator");
@@ -72,23 +71,12 @@ class Monitor extends BeanModel {
 
     /**
      * Return an object that ready to parse to JSON
+     * @param {object} preloadData to prevent n+1 problems, we query the data in a batch outside of this function
      * @param {boolean} includeSensitiveData Include sensitive data in
      * JSON
-     * @returns {Promise<object>} Object ready to parse
+     * @returns {object} Object ready to parse
      */
-    async toJSON(includeSensitiveData = true) {
-
-        let notificationIDList = {};
-
-        let list = await R.find("monitor_notification", " monitor_id = ? ", [
-            this.id,
-        ]);
-
-        for (let bean of list) {
-            notificationIDList[bean.notification_id] = true;
-        }
-
-        const tags = await this.getTags();
+    toJSON(preloadData = {}, includeSensitiveData = true) {
 
         let screenshot = null;
 
@@ -96,7 +84,7 @@ class Monitor extends BeanModel {
             screenshot = "/screenshots/" + jwt.sign(this.id, UptimeKumaServer.getInstance().jwtSecret) + ".png";
         }
 
-        const path = await this.getPath();
+        const path = preloadData.paths.get(this.id) || [];
         const pathName = path.join(" / ");
 
         let data = {
@@ -106,15 +94,15 @@ class Monitor extends BeanModel {
             path,
             pathName,
             parent: this.parent,
-            childrenIDs: await Monitor.getAllChildrenIDs(this.id),
+            childrenIDs: preloadData.childrenIDs.get(this.id) || [],
             url: this.url,
             method: this.method,
             hostname: this.hostname,
             port: this.port,
             maxretries: this.maxretries,
             weight: this.weight,
-            active: await this.isActive(),
-            forceInactive: !await Monitor.isParentActive(this.id),
+            active: preloadData.activeStatus.get(this.id),
+            forceInactive: preloadData.forceInactive.get(this.id),
             type: this.type,
             timeout: this.timeout,
             interval: this.interval,
@@ -134,9 +122,9 @@ class Monitor extends BeanModel {
             docker_container: this.docker_container,
             docker_host: this.docker_host,
             proxyId: this.proxy_id,
-            notificationIDList,
-            tags: tags,
-            maintenance: await Monitor.isUnderMaintenance(this.id),
+            notificationIDList: preloadData.notifications.get(this.id) || {},
+            tags: preloadData.tags.get(this.id) || [],
+            maintenance: preloadData.maintenanceStatus.get(this.id),
             mqttTopic: this.mqttTopic,
             mqttSuccessMessage: this.mqttSuccessMessage,
             mqttCheckType: this.mqttCheckType,
@@ -160,7 +148,12 @@ class Monitor extends BeanModel {
             kafkaProducerAllowAutoTopicCreation: this.getKafkaProducerAllowAutoTopicCreation(),
             kafkaProducerMessage: this.kafkaProducerMessage,
             screenshot,
+            cacheBust: this.getCacheBust(),
             remote_browser: this.remote_browser,
+            snmpOid: this.snmpOid,
+            jsonPathOperator: this.jsonPathOperator,
+            snmpVersion: this.snmpVersion,
+            conditions: JSON.parse(this.conditions),
         };
 
         if (includeSensitiveData) {
@@ -197,16 +190,6 @@ class Monitor extends BeanModel {
         return data;
     }
 
-    /**
-     * Checks if the monitor is active based on itself and its parents
-     * @returns {Promise<boolean>} Is the monitor active?
-     */
-    async isActive() {
-        const parentActive = await Monitor.isParentActive(this.id);
-
-        return (this.active === 1) && parentActive;
-    }
-
     /**
      * Get all tags applied to this monitor
      * @returns {Promise<LooseObject<any>[]>} List of tags on the
@@ -293,6 +276,14 @@ class Monitor extends BeanModel {
         return Boolean(this.grpcEnableTls);
     }
 
+    /**
+     * Parse to boolean
+     * @returns {boolean} if cachebusting is enabled
+     */
+    getCacheBust() {
+        return Boolean(this.cacheBust);
+    }
+
     /**
      * Get accepted status codes
      * @returns {object} Accepted status codes
@@ -465,6 +456,14 @@ class Monitor extends BeanModel {
                         options.data = bodyValue;
                     }
 
+                    if (this.cacheBust) {
+                        const randomFloatString = Math.random().toString(36);
+                        const cacheBust = randomFloatString.substring(2);
+                        options.params = {
+                            uptime_kuma_cachebuster: cacheBust,
+                        };
+                    }
+
                     if (this.proxy_id) {
                         const proxy = await R.load("proxy", this.proxy_id);
 
@@ -565,25 +564,15 @@ class Monitor extends BeanModel {
                     } else if (this.type === "json-query") {
                         let data = res.data;
 
-                        // convert data to object
-                        if (typeof data === "string" && res.headers["content-type"] !== "application/json") {
-                            try {
-                                data = JSON.parse(data);
-                            } catch (_) {
-                                // Failed to parse as JSON, just process it as a string
-                            }
-                        }
+                        const { status, response } = await evaluateJsonQuery(data, this.jsonPath, this.jsonPathOperator, this.expectedValue);
 
-                        let expression = jsonata(this.jsonPath);
-
-                        let result = await expression.evaluate(data);
-
-                        if (result.toString() === this.expectedValue) {
-                            bean.msg += ", expected value is found";
+                        if (status) {
                             bean.status = UP;
+                            bean.msg = `JSON query passes (comparing ${response} ${this.jsonPathOperator} ${this.expectedValue})`;
                         } else {
-                            throw new Error(bean.msg + ", but value is not equal to expected value, value was: [" + result + "]");
+                            throw new Error(`JSON query does not pass (comparing ${response} ${this.jsonPathOperator} ${this.expectedValue})`);
                         }
+
                     }
 
                 } else if (this.type === "port") {
@@ -1153,6 +1142,18 @@ class Monitor extends BeanModel {
         return checkCertificateResult;
     }
 
+    /**
+     * Checks if the monitor is active based on itself and its parents
+     * @param {number} monitorID ID of monitor to send
+     * @param {boolean} active is active
+     * @returns {Promise<boolean>} Is the monitor active?
+     */
+    static async isActive(monitorID, active) {
+        const parentActive = await Monitor.isParentActive(monitorID);
+
+        return (active === 1) && parentActive;
+    }
+
     /**
      * Send statistics to clients
      * @param {Server} io Socket server instance
@@ -1289,7 +1290,10 @@ class Monitor extends BeanModel {
             for (let notification of notificationList) {
                 try {
                     const heartbeatJSON = bean.toJSON();
-
+                    const monitorData = [{ id: monitor.id,
+                        active: monitor.active
+                    }];
+                    const preloadData = await Monitor.preparePreloadData(monitorData);
                     // Prevent if the msg is undefined, notifications such as Discord cannot send out.
                     if (!heartbeatJSON["msg"]) {
                         heartbeatJSON["msg"] = "N/A";
@@ -1300,7 +1304,7 @@ class Monitor extends BeanModel {
                     heartbeatJSON["timezoneOffset"] = UptimeKumaServer.getInstance().getTimezoneOffset();
                     heartbeatJSON["localDateTime"] = dayjs.utc(heartbeatJSON["time"]).tz(heartbeatJSON["timezone"]).format(SQL_DATETIME_FORMAT);
 
-                    await Notification.send(JSON.parse(notification.config), msg, await monitor.toJSON(false), heartbeatJSON);
+                    await Notification.send(JSON.parse(notification.config), msg, monitor.toJSON(preloadData, false), heartbeatJSON);
                 } catch (e) {
                     log.error("monitor", "Cannot send notification to " + notification.name);
                     log.error("monitor", e);
@@ -1462,6 +1466,111 @@ class Monitor extends BeanModel {
         }
     }
 
+    /**
+     * Gets monitor notification of multiple monitor
+     * @param {Array} monitorIDs IDs of monitor to get
+     * @returns {Promise<LooseObject<any>>} object
+     */
+    static async getMonitorNotification(monitorIDs) {
+        return await R.getAll(`
+            SELECT monitor_notification.monitor_id, monitor_notification.notification_id
+            FROM monitor_notification
+            WHERE monitor_notification.monitor_id IN (?)
+        `, [
+            monitorIDs,
+        ]);
+    }
+
+    /**
+     * Gets monitor tags of multiple monitor
+     * @param {Array} monitorIDs IDs of monitor to get
+     * @returns {Promise<LooseObject<any>>} object
+     */
+    static async getMonitorTag(monitorIDs) {
+        return await R.getAll(`
+            SELECT monitor_tag.monitor_id, tag.name, tag.color
+            FROM monitor_tag
+            JOIN tag ON monitor_tag.tag_id = tag.id
+            WHERE monitor_tag.monitor_id IN (?)
+        `, [
+            monitorIDs,
+        ]);
+    }
+
+    /**
+     * prepare preloaded data for efficient access
+     * @param {Array} monitorData IDs & active field of monitor to get
+     * @returns {Promise<LooseObject<any>>} object
+     */
+    static async preparePreloadData(monitorData) {
+
+        const notificationsMap = new Map();
+        const tagsMap = new Map();
+        const maintenanceStatusMap = new Map();
+        const childrenIDsMap = new Map();
+        const activeStatusMap = new Map();
+        const forceInactiveMap = new Map();
+        const pathsMap = new Map();
+
+        if (monitorData.length > 0) {
+            const monitorIDs = monitorData.map(monitor => monitor.id);
+            const notifications = await Monitor.getMonitorNotification(monitorIDs);
+            const tags = await Monitor.getMonitorTag(monitorIDs);
+            const maintenanceStatuses = await Promise.all(monitorData.map(monitor => Monitor.isUnderMaintenance(monitor.id)));
+            const childrenIDs = await Promise.all(monitorData.map(monitor => Monitor.getAllChildrenIDs(monitor.id)));
+            const activeStatuses = await Promise.all(monitorData.map(monitor => Monitor.isActive(monitor.id, monitor.active)));
+            const forceInactiveStatuses = await Promise.all(monitorData.map(monitor => Monitor.isParentActive(monitor.id)));
+            const paths = await Promise.all(monitorData.map(monitor => Monitor.getAllPath(monitor.id, monitor.name)));
+
+            notifications.forEach(row => {
+                if (!notificationsMap.has(row.monitor_id)) {
+                    notificationsMap.set(row.monitor_id, {});
+                }
+                notificationsMap.get(row.monitor_id)[row.notification_id] = true;
+            });
+
+            tags.forEach(row => {
+                if (!tagsMap.has(row.monitor_id)) {
+                    tagsMap.set(row.monitor_id, []);
+                }
+                tagsMap.get(row.monitor_id).push({
+                    name: row.name,
+                    color: row.color
+                });
+            });
+
+            monitorData.forEach((monitor, index) => {
+                maintenanceStatusMap.set(monitor.id, maintenanceStatuses[index]);
+            });
+
+            monitorData.forEach((monitor, index) => {
+                childrenIDsMap.set(monitor.id, childrenIDs[index]);
+            });
+
+            monitorData.forEach((monitor, index) => {
+                activeStatusMap.set(monitor.id, activeStatuses[index]);
+            });
+
+            monitorData.forEach((monitor, index) => {
+                forceInactiveMap.set(monitor.id, !forceInactiveStatuses[index]);
+            });
+
+            monitorData.forEach((monitor, index) => {
+                pathsMap.set(monitor.id, paths[index]);
+            });
+        }
+
+        return {
+            notifications: notificationsMap,
+            tags: tagsMap,
+            maintenanceStatus: maintenanceStatusMap,
+            childrenIDs: childrenIDsMap,
+            activeStatus: activeStatusMap,
+            forceInactive: forceInactiveMap,
+            paths: pathsMap,
+        };
+    }
+
     /**
      * Gets Parent of the monitor
      * @param {number} monitorID ID of monitor to get
@@ -1494,16 +1603,18 @@ class Monitor extends BeanModel {
 
     /**
      * Gets the full path
+     * @param {number} monitorID ID of the monitor to get
+     * @param {string} name of the monitor to get
      * @returns {Promise<string[]>} Full path (includes groups and the name) of the monitor
      */
-    async getPath() {
-        const path = [ this.name ];
+    static async getAllPath(monitorID, name) {
+        const path = [ name ];
 
         if (this.parent === null) {
             return path;
         }
 
-        let parent = await Monitor.getParent(this.id);
+        let parent = await Monitor.getParent(monitorID);
         while (parent !== null) {
             path.unshift(parent.name);
             parent = await Monitor.getParent(parent.id);

server/model/status_page.js

@@ -4,6 +4,11 @@ const cheerio = require("cheerio");
 const { UptimeKumaServer } = require("../uptime-kuma-server");
 const jsesc = require("jsesc");
 const googleAnalytics = require("../google-analytics");
+const { marked } = require("marked");
+const { Feed } = require("feed");
+const config = require("../config");
+
+const { STATUS_PAGE_ALL_DOWN, STATUS_PAGE_ALL_UP, STATUS_PAGE_MAINTENANCE, STATUS_PAGE_PARTIAL_DOWN, UP, MAINTENANCE, DOWN } = require("../../src/util");
 
 class StatusPage extends BeanModel {
 
@@ -13,6 +18,24 @@ class StatusPage extends BeanModel {
      */
     static domainMappingList = { };
 
+    /**
+     * Handle responses to RSS pages
+     * @param {Response} response Response object
+     * @param {string} slug Status page slug
+     * @returns {Promise<void>}
+     */
+    static async handleStatusPageRSSResponse(response, slug) {
+        let statusPage = await R.findOne("status_page", " slug = ? ", [
+            slug
+        ]);
+
+        if (statusPage) {
+            response.send(await StatusPage.renderRSS(statusPage, slug));
+        } else {
+            response.status(404).send(UptimeKumaServer.getInstance().indexHTML);
+        }
+    }
+
     /**
      * Handle responses to status page
      * @param {Response} response Response object
@@ -38,6 +61,38 @@ class StatusPage extends BeanModel {
         }
     }
 
+    /**
+     * SSR for RSS feed
+     * @param {statusPage} statusPage object
+     * @param {slug} slug from router
+     * @returns {Promise<string>} the rendered html
+     */
+    static async renderRSS(statusPage, slug) {
+        const { heartbeats, statusDescription } = await StatusPage.getRSSPageData(statusPage);
+
+        let proto = config.isSSL ? "https" : "http";
+        let host = `${proto}://${config.hostname || "localhost"}:${config.port}/status/${slug}`;
+
+        const feed = new Feed({
+            title: "uptime kuma rss feed",
+            description: `current status: ${statusDescription}`,
+            link: host,
+            language: "en", // optional, used only in RSS 2.0, possible values: http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes
+            updated: new Date(), // optional, default = today
+        });
+
+        heartbeats.forEach(heartbeat => {
+            feed.addItem({
+                title: `${heartbeat.name} is down`,
+                description: `${heartbeat.name} has been down since ${heartbeat.time}`,
+                id: heartbeat.monitorID,
+                date: new Date(heartbeat.time),
+            });
+        });
+
+        return feed.rss2();
+    }
+
     /**
      * SSR for status pages
      * @param {string} indexHTML HTML page to render
@@ -46,7 +101,11 @@ class StatusPage extends BeanModel {
      */
     static async renderHTML(indexHTML, statusPage) {
         const $ = cheerio.load(indexHTML);
-        const description155 = statusPage.description?.substring(0, 155) ?? "";
+
+        const description155 = marked(statusPage.description ?? "")
+            .replace(/<[^>]+>/gm, "")
+            .trim()
+            .substring(0, 155);
 
         $("title").text(statusPage.title);
         $("meta[name=description]").attr("content", description155);
@@ -93,6 +152,109 @@ class StatusPage extends BeanModel {
         return $.root().html();
     }
 
+    /**
+     * @param {heartbeats} heartbeats from getRSSPageData
+     * @returns {number} status_page constant from util.ts
+     */
+    static overallStatus(heartbeats) {
+        if (heartbeats.length === 0) {
+            return -1;
+        }
+
+        let status = STATUS_PAGE_ALL_UP;
+        let hasUp = false;
+
+        for (let beat of heartbeats) {
+            if (beat.status === MAINTENANCE) {
+                return STATUS_PAGE_MAINTENANCE;
+            } else if (beat.status === UP) {
+                hasUp = true;
+            } else {
+                status = STATUS_PAGE_PARTIAL_DOWN;
+            }
+        }
+
+        if (! hasUp) {
+            status = STATUS_PAGE_ALL_DOWN;
+        }
+
+        return status;
+    }
+
+    /**
+     * @param {number} status from overallStatus
+     * @returns {string} description
+     */
+    static getStatusDescription(status) {
+        if (status === -1) {
+            return "No Services";
+        }
+
+        if (status === STATUS_PAGE_ALL_UP) {
+            return "All Systems Operational";
+        }
+
+        if (status === STATUS_PAGE_PARTIAL_DOWN) {
+            return "Partially Degraded Service";
+        }
+
+        if (status === STATUS_PAGE_ALL_DOWN) {
+            return "Degraded Service";
+        }
+
+        // TODO: show the real maintenance information: title, description, time
+        if (status === MAINTENANCE) {
+            return "Under maintenance";
+        }
+
+        return "?";
+    }
+
+    /**
+     * Get all data required for RSS
+     * @param {StatusPage} statusPage Status page to get data for
+     * @returns {object} Status page data
+     */
+    static async getRSSPageData(statusPage) {
+        // get all heartbeats that correspond to this statusPage
+        const config = await statusPage.toPublicJSON();
+
+        // Public Group List
+        const showTags = !!statusPage.show_tags;
+
+        const list = await R.find("group", " public = 1 AND status_page_id = ? ORDER BY weight ", [
+            statusPage.id
+        ]);
+
+        let heartbeats = [];
+
+        for (let groupBean of list) {
+            let monitorGroup = await groupBean.toPublicJSON(showTags, config?.showCertificateExpiry);
+            for (const monitor of monitorGroup.monitorList) {
+                const heartbeat = await R.findOne("heartbeat", "monitor_id = ? ORDER BY time DESC", [ monitor.id ]);
+                if (heartbeat) {
+                    heartbeats.push({
+                        ...monitor,
+                        status: heartbeat.status,
+                        time: heartbeat.time
+                    });
+                }
+            }
+        }
+
+        // calculate RSS feed description
+        let status = StatusPage.overallStatus(heartbeats);
+        let statusDescription = StatusPage.getStatusDescription(status);
+
+        // keep only DOWN heartbeats in the RSS feed
+        heartbeats = heartbeats.filter(heartbeat => heartbeat.status === DOWN);
+
+        return {
+            heartbeats,
+            statusDescription
+        };
+    }
+
     /**
      * Get all status page data in one call
      * @param {StatusPage} statusPage Status page to get data for