Merge branch 'master' into feature/add-support-for-method-body-and-headers

server/model/monitor.js

@@ -300,54 +300,13 @@ class Monitor extends BeanModel {
 
             let beatInterval = this.interval;
 
-            // * ? -> ANY STATUS = important [isFirstBeat]
-            // UP -> PENDING = not important
-            // * UP -> DOWN = important
-            // UP -> UP = not important
-            // PENDING -> PENDING = not important
-            // * PENDING -> DOWN = important
-            // PENDING -> UP = not important
-            // DOWN -> PENDING = this case not exists
-            // DOWN -> DOWN = not important
-            // * DOWN -> UP = important
-            let isImportant = isFirstBeat ||
-                (previousBeat.status === UP && bean.status === DOWN) ||
-                (previousBeat.status === DOWN && bean.status === UP) ||
-                (previousBeat.status === PENDING && bean.status === DOWN);
+            let isImportant = Monitor.isImportantBeat(isFirstBeat, previousBeat.status, bean.status);
 
             // Mark as important if status changed, ignore pending pings,
             // Don't notify if disrupted changes to up
             if (isImportant) {
                 bean.important = true;
-
-                // Send only if the first beat is DOWN
-                if (!isFirstBeat || bean.status === DOWN) {
-                    let notificationList = await R.getAll("SELECT notification.* FROM notification, monitor_notification WHERE monitor_id = ? AND monitor_notification.notification_id = notification.id ", [
-                        this.id,
-                    ]);
-
-                    let text;
-                    if (bean.status === UP) {
-                        text = "✅ Up";
-                    } else {
-                        text = "🔴 Down";
-                    }
-
-                    let msg = `[${this.name}] [${text}] ${bean.msg}`;
-
-                    for (let notification of notificationList) {
-                        try {
-                            await Notification.send(JSON.parse(notification.config), msg, await this.toJSON(), bean.toJSON());
-                        } catch (e) {
-                            console.error("Cannot send notification to " + notification.name);
-                            console.log(e);
-                        }
-                    }
-
-                    // Clear Status Page Cache
-                    apicache.clear();
-                }
-
+                await Monitor.sendNotification(isFirstBeat, this, bean);
             } else {
                 bean.important = false;
             }
@@ -554,6 +513,53 @@ class Monitor extends BeanModel {
         io.to(userID).emit("uptime", monitorID, duration, uptime);
     }
 
+    static isImportantBeat(isFirstBeat, previousBeatStatus, currentBeatStatus) {
+        // * ? -> ANY STATUS = important [isFirstBeat]
+        // UP -> PENDING = not important
+        // * UP -> DOWN = important
+        // UP -> UP = not important
+        // PENDING -> PENDING = not important
+        // * PENDING -> DOWN = important
+        // PENDING -> UP = not important
+        // DOWN -> PENDING = this case not exists
+        // DOWN -> DOWN = not important
+        // * DOWN -> UP = important
+        let isImportant = isFirstBeat ||
+            (previousBeatStatus === UP && currentBeatStatus === DOWN) ||
+            (previousBeatStatus === DOWN && currentBeatStatus === UP) ||
+            (previousBeatStatus === PENDING && currentBeatStatus === DOWN);
+        return isImportant;
+    }
+
+    static async sendNotification(isFirstBeat, monitor, bean) {
+        if (!isFirstBeat || bean.status === DOWN) {
+            let notificationList = await R.getAll("SELECT notification.* FROM notification, monitor_notification WHERE monitor_id = ? AND monitor_notification.notification_id = notification.id ", [
+                monitor.id,
+            ]);
+
+            let text;
+            if (bean.status === UP) {
+                text = "✅ Up";
+            } else {
+                text = "🔴 Down";
+            }
+
+            let msg = `[${monitor.name}] [${text}] ${bean.msg}`;
+
+            for (let notification of notificationList) {
+                try {
+                    await Notification.send(JSON.parse(notification.config), msg, await monitor.toJSON(), bean.toJSON());
+                } catch (e) {
+                    console.error("Cannot send notification to " + notification.name);
+                    console.log(e);
+                }
+            }
+
+            // Clear Status Page Cache
+            apicache.clear();
+        }
+    }
+
 }
 
 module.exports = Monitor;

server/notification-providers/aliyun-sms.js

@@ -0,0 +1,108 @@
+const NotificationProvider = require("./notification-provider");
+const { DOWN, UP } = require("../../src/util");
+const { default: axios } = require("axios");
+const Crypto = require("crypto");
+const qs = require("qs");
+
+class AliyunSMS extends NotificationProvider {
+    name = "AliyunSMS";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+
+        try {
+            if (heartbeatJSON != null) {
+                let msgBody = JSON.stringify({
+                    name: monitorJSON["name"],
+                    time: heartbeatJSON["time"],
+                    status: this.statusToString(heartbeatJSON["status"]),
+                    msg: heartbeatJSON["msg"],
+                });
+                if (this.sendSms(notification, msgBody)) {
+                    return okMsg;
+                }
+            } else {
+                let msgBody = JSON.stringify({
+                    name: "",
+                    time: "",
+                    status: "",
+                    msg: msg,
+                });
+                if (this.sendSms(notification, msgBody)) {
+                    return okMsg;
+                }
+            }
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+
+    async sendSms(notification, msgbody) {
+        let params = {
+            PhoneNumbers: notification.phonenumber,
+            TemplateCode: notification.templateCode,
+            SignName: notification.signName,
+            TemplateParam: msgbody,
+            AccessKeyId: notification.accessKeyId,
+            Format: "JSON",
+            SignatureMethod: "HMAC-SHA1",
+            SignatureVersion: "1.0",
+            SignatureNonce: Math.random().toString(),
+            Timestamp: new Date().toISOString(),
+            Action: "SendSms",
+            Version: "2017-05-25",
+        };
+
+        params.Signature = this.sign(params, notification.secretAccessKey);
+        let config = {
+            method: "POST",
+            url: "http://dysmsapi.aliyuncs.com/",
+            headers: {
+                "Content-Type": "application/x-www-form-urlencoded",
+            },
+            data: qs.stringify(params),
+        };
+
+        let result = await axios(config);
+        if (result.data.Message == "OK") {
+            return true;
+        }
+        return false;
+    }
+
+    /** Aliyun request sign */
+    sign(param, AccessKeySecret) {
+        let param2 = {};
+        let data = [];
+
+        let oa = Object.keys(param).sort();
+
+        for (let i = 0; i < oa.length; i++) {
+            let key = oa[i];
+            param2[key] = param[key];
+        }
+
+        for (let key in param2) {
+            data.push(`${encodeURIComponent(key)}=${encodeURIComponent(param2[key])}`);
+        }
+
+        let StringToSign = `POST&${encodeURIComponent("/")}&${encodeURIComponent(data.join("&"))}`;
+        return Crypto
+            .createHmac("sha1", `${AccessKeySecret}&`)
+            .update(Buffer.from(StringToSign))
+            .digest("base64");
+    }
+
+    statusToString(status) {
+        switch (status) {
+            case DOWN:
+                return "DOWN";
+            case UP:
+                return "UP";
+            default:
+                return status;
+        }
+    }
+}
+
+module.exports = AliyunSMS;

server/notification-providers/dingding.js

@@ -0,0 +1,79 @@
+const NotificationProvider = require("./notification-provider");
+const { DOWN, UP } = require("../../src/util");
+const { default: axios } = require("axios");
+const Crypto = require("crypto");
+
+class DingDing extends NotificationProvider {
+    name = "DingDing";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+
+        try {
+            if (heartbeatJSON != null) {
+                let params = {
+                    msgtype: "markdown",
+                    markdown: {
+                        title: monitorJSON["name"],
+                        text: `## [${this.statusToString(heartbeatJSON["status"])}] \n > ${heartbeatJSON["msg"]}  \n > Time(UTC):${heartbeatJSON["time"]}`,
+                    }
+                };
+                if (this.sendToDingDing(notification, params)) {
+                    return okMsg;
+                }
+            } else {
+                let params = {
+                    msgtype: "text",
+                    text: {
+                        content: msg
+                    }
+                };
+                if (this.sendToDingDing(notification, params)) {
+                    return okMsg;
+                }
+            }
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+
+    async sendToDingDing(notification, params) {
+        let timestamp = Date.now();
+
+        let config = {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            url: `${notification.webHookUrl}&timestamp=${timestamp}&sign=${encodeURIComponent(this.sign(timestamp, notification.secretKey))}`,
+            data: JSON.stringify(params),
+        };
+
+        let result = await axios(config);
+        if (result.data.errmsg == "ok") {
+            return true;
+        }
+        return false;
+    }
+
+    /** DingDing sign */
+    sign(timestamp, secretKey) {
+        return Crypto
+            .createHmac("sha256", Buffer.from(secretKey, "utf8"))
+            .update(Buffer.from(`${timestamp}\n${secretKey}`, "utf8"))
+            .digest("base64");
+    }
+
+    statusToString(status) {
+        switch (status) {
+            case DOWN:
+                return "DOWN";
+            case UP:
+                return "UP";
+            default:
+                return status;
+        }
+    }
+}
+
+module.exports = DingDing;

server/notification-providers/feishu.js

@@ -0,0 +1,83 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+const { DOWN, UP } = require("../../src/util");
+
+class Feishu extends NotificationProvider {
+    name = "Feishu";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+        let feishuWebHookUrl = notification.feishuWebHookUrl;
+
+        try {
+            if (heartbeatJSON == null) {
+                let testdata = {
+                    msg_type: "text",
+                    content: {
+                        text: msg,
+                    },
+                };
+                await axios.post(feishuWebHookUrl, testdata);
+                return okMsg;
+            }
+
+            if (heartbeatJSON["status"] == DOWN) {
+                let downdata = {
+                    msg_type: "post",
+                    content: {
+                        post: {
+                            zh_cn: {
+                                title: "UptimeKuma Alert: " + monitorJSON["name"],
+                                content: [
+                                    [
+                                        {
+                                            tag: "text",
+                                            text:
+                                                "[Down] " +
+                                                heartbeatJSON["msg"] +
+                                                "\nTime (UTC): " +
+                                                heartbeatJSON["time"],
+                                        },
+                                    ],
+                                ],
+                            },
+                        },
+                    },
+                };
+                await axios.post(feishuWebHookUrl, downdata);
+                return okMsg;
+            }
+
+            if (heartbeatJSON["status"] == UP) {
+                let updata = {
+                    msg_type: "post",
+                    content: {
+                        post: {
+                            zh_cn: {
+                                title: "UptimeKuma Alert: " + monitorJSON["name"],
+                                content: [
+                                    [
+                                        {
+                                            tag: "text",
+                                            text:
+                                                "[Up] " +
+                                                heartbeatJSON["msg"] +
+                                                "\nTime (UTC): " +
+                                                heartbeatJSON["time"],
+                                        },
+                                    ],
+                                ],
+                            },
+                        },
+                    },
+                };
+                await axios.post(feishuWebHookUrl, updata);
+                return okMsg;
+            }
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = Feishu;

server/notification.js

@@ -18,6 +18,9 @@ const SMTP = require("./notification-providers/smtp");
 const Teams = require("./notification-providers/teams");
 const Telegram = require("./notification-providers/telegram");
 const Webhook = require("./notification-providers/webhook");
+const Feishu = require("./notification-providers/feishu");
+const AliyunSms = require("./notification-providers/aliyun-sms");
+const DingDing = require("./notification-providers/dingding");
 
 class Notification {
 
@@ -30,11 +33,14 @@ class Notification {
 
         const list = [
             new Apprise(),
+            new AliyunSms(),
+            new DingDing(),
             new Discord(),
             new Teams(),
             new Gotify(),
             new Line(),
             new LunaSea(),
+            new Feishu(),
             new Mattermost(),
             new Matrix(),
             new Octopush(),

server/ping-lite.js

@@ -4,10 +4,7 @@ const net = require("net");
 const spawn = require("child_process").spawn;
 const events = require("events");
 const fs = require("fs");
-const WIN = /^win/.test(process.platform);
-const LIN = /^linux/.test(process.platform);
-const MAC = /^darwin/.test(process.platform);
-const FBSD = /^freebsd/.test(process.platform);
+const util = require("./util-server");
 
 module.exports = Ping;
 
@@ -23,12 +20,12 @@ function Ping(host, options) {
 
     const timeout = 10;
 
-    if (WIN) {
+    if (util.WIN) {
         this._bin = "c:/windows/system32/ping.exe";
         this._args = (options.args) ? options.args : [ "-n", "1", "-w", timeout * 1000, host ];
         this._regmatch = /[><=]([0-9.]+?)ms/;
 
-    } else if (LIN) {
+    } else if (util.LIN) {
         this._bin = "/bin/ping";
 
         const defaultArgs = [ "-n", "-w", timeout, "-c", "1", host ];
@@ -40,7 +37,7 @@ function Ping(host, options) {
         this._args = (options.args) ? options.args : defaultArgs;
         this._regmatch = /=([0-9.]+?) ms/;
 
-    } else if (MAC) {
+    } else if (util.MAC) {
 
         if (net.isIPv6(host) || options.ipv6) {
             this._bin = "/sbin/ping6";
@@ -51,7 +48,7 @@ function Ping(host, options) {
         this._args = (options.args) ? options.args : [ "-n", "-t", timeout, "-c", "1", host ];
         this._regmatch = /=([0-9.]+?) ms/;
 
-    } else if (FBSD) {
+    } else if (util.FBSD) {
         this._bin = "/sbin/ping";
 
         const defaultArgs = [ "-n", "-t", timeout, "-c", "1", host ];
@@ -101,6 +98,9 @@ Ping.prototype.send = function (callback) {
     });
 
     this._ping.stdout.on("data", function (data) { // log stdout
+        if (util.WIN) {
+            data = convertOutput(data);
+        }
         this._stdout = (this._stdout || "") + data;
     });
 
@@ -112,6 +112,9 @@ Ping.prototype.send = function (callback) {
     });
 
     this._ping.stderr.on("data", function (data) { // log stderr
+        if (util.WIN) {
+            data = convertOutput(data);
+        }
         this._stderr = (this._stderr || "") + data;
     });
 
@@ -157,3 +160,19 @@ Ping.prototype.start = function (callback) {
 Ping.prototype.stop = function () {
     clearInterval(this._i);
 };
+
+/**
+ * Try to convert to UTF-8 for Windows, as the ping's output on Windows is not UTF-8 and could be in other languages
+ * Thank @pemassi
+ * https://github.com/louislam/uptime-kuma/issues/570#issuecomment-941984094
+ * @param data
+ * @returns {string}
+ */
+function convertOutput(data) {
+    if (util.WIN) {
+        if (data) {
+            return util.convertToUTF8(data);
+        }
+    }
+    return data;
+}

server/routers/api-router.js

@@ -5,7 +5,7 @@ const server = require("../server");
 const apicache = require("../modules/apicache");
 const Monitor = require("../model/monitor");
 const dayjs = require("dayjs");
-const { UP } = require("../../src/util");
+const { UP, flipStatus, debug } = require("../../src/util");
 let router = express.Router();
 
 let cache = apicache.middleware;
@@ -18,9 +18,10 @@ router.get("/api/entry-page", async (_, response) => {
 
 router.get("/api/push/:pushToken", async (request, response) => {
     try {
+
         let pushToken = request.params.pushToken;
         let msg = request.query.msg || "OK";
-        let ping = request.query.ping;
+        let ping = request.query.ping || null;
 
         let monitor = await R.findOne("monitor", " push_token = ? AND active = 1 ", [
             pushToken
@@ -30,12 +31,40 @@ router.get("/api/push/:pushToken", async (request, response) => {
             throw new Error("Monitor not found or not active.");
         }
 
+        const previousHeartbeat = await R.getRow(`
+            SELECT status, time FROM heartbeat
+            WHERE id = (select MAX(id) from heartbeat where monitor_id = ?)
+        `, [
+            monitor.id
+        ]);
+
+        let status = UP;
+        if (monitor.isUpsideDown()) {
+            status = flipStatus(status);
+        }
+
+        let isFirstBeat = true;
+        let previousStatus = status;
+        let duration = 0;
+
         let bean = R.dispense("heartbeat");
-        bean.monitor_id = monitor.id;
         bean.time = R.isoDateTime(dayjs.utc());
-        bean.status = UP;
+
+        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;
         bean.msg = msg;
         bean.ping = ping;
+        bean.duration = duration;
 
         await R.store(bean);
 
@@ -45,6 +74,11 @@ router.get("/api/push/:pushToken", async (request, response) => {
         response.json({
             ok: true,
         });
+
+        if (bean.important) {
+            await Monitor.sendNotification(isFirstBeat, monitor, bean);
+        }
+
     } catch (e) {
         response.json({
             ok: false,

server/server.js

@@ -43,7 +43,7 @@ console.log("Importing this project modules");
 debug("Importing Monitor");
 const Monitor = require("./model/monitor");
 debug("Importing Settings");
-const { getSettings, setSettings, setting, initJWTSecret, checkLogin, startUnitTest } = require("./util-server");
+const { getSettings, setSettings, setting, initJWTSecret, checkLogin, startUnitTest, FBSD } = require("./util-server");
 
 debug("Importing Notification");
 const { Notification } = require("./notification");
@@ -61,12 +61,22 @@ console.info("Version: " + checkVersion.version);
 
 // If host is omitted, the server will accept connections on the unspecified IPv6 address (::) when IPv6 is available and the unspecified IPv4 address (0.0.0.0) otherwise.
 // Dual-stack support for (::)
-const hostname = process.env.HOST || args.host;
-const port = parseInt(process.env.PORT || args.port || 3001);
+let hostname = process.env.UPTIME_KUMA_HOST || args.host;
+
+// Also read HOST if not FreeBSD, as HOST is a system environment variable in FreeBSD
+if (!hostname && !FBSD) {
+    hostname = process.env.HOST;
+}
+
+if (hostname) {
+    console.log("Custom hostname: " + hostname);
+}
+
+const port = parseInt(process.env.UPTIME_KUMA_PORT || process.env.PORT || args.port || 3001);
 
 // SSL
-const sslKey = process.env.SSL_KEY || args["ssl-key"] || undefined;
-const sslCert = process.env.SSL_CERT || args["ssl-cert"] || undefined;
+const sslKey = process.env.UPTIME_KUMA_SSL_KEY || process.env.SSL_KEY || args["ssl-key"] || undefined;
+const sslCert = process.env.UPTIME_KUMA_SSL_CERT || process.env.SSL_CERT || args["ssl-cert"] || undefined;
 
 /**
  * Run unit test after the server is ready

server/util-server.js

@@ -6,6 +6,14 @@ const passwordHash = require("./password-hash");
 const dayjs = require("dayjs");
 const { Resolver } = require("dns");
 const child_process = require("child_process");
+const iconv = require("iconv-lite");
+const chardet = require("chardet");
+
+// From ping-lite
+exports.WIN = /^win/.test(process.platform);
+exports.LIN = /^linux/.test(process.platform);
+exports.MAC = /^darwin/.test(process.platform);
+exports.FBSD = /^freebsd/.test(process.platform);
 
 /**
  * Init or reset JWT secret
@@ -312,3 +320,14 @@ exports.startUnitTest = async () => {
         process.exit(code);
     });
 };
+
+/**
+ * @param body : Buffer
+ * @returns {string}
+ */
+exports.convertToUTF8 = (body) => {
+    const guessEncoding = chardet.detect(body);
+    debug("Guess Encoding: " + guessEncoding);
+    const str = iconv.decode(body, guessEncoding);
+    return str.toString();
+};