Merge remote-tracking branch 'upstream/master' into add-xml-support-to-http-monitors

# Conflicts:
#	server/database.js

db/patch-user-username-case-insensitive.sql

@@ -0,0 +1,47 @@
+CREATE TABLE [temp_user](
+  [id] INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+  [username] VARCHAR(255) NOT NULL UNIQUE COLLATE NOCASE,
+  [password] VARCHAR(255),
+  [active] BOOLEAN NOT NULL DEFAULT 1,
+  [timezone] VARCHAR(150),
+  twofa_secret VARCHAR(64),
+  twofa_status BOOLEAN default 0 NOT NULL,
+  twofa_last_token VARCHAR(6)
+);
+
+INSERT INTO [temp_user] SELECT
+[id],
+[username],
+[password],
+[active],
+[timezone],
+twofa_secret,
+twofa_status,
+twofa_last_token
+ FROM user;
+
+DROP TABLE user;
+
+CREATE TABLE [user](
+  [id] INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+  [username] VARCHAR(255) NOT NULL UNIQUE COLLATE NOCASE,
+  [password] VARCHAR(255),
+  [active] BOOLEAN NOT NULL DEFAULT 1,
+  [timezone] VARCHAR(150),
+  twofa_secret VARCHAR(64),
+  twofa_status BOOLEAN default 0 NOT NULL,
+  twofa_last_token VARCHAR(6)
+);
+
+INSERT INTO [user] SELECT
+[id],
+[username],
+[password],
+[active],
+[timezone],
+twofa_secret,
+twofa_status,
+twofa_last_token
+ FROM [temp_user];
+
+DROP TABLE [temp_user];

server/auth.js

@@ -15,7 +15,7 @@ exports.login = async function (username, password) {
         return null;
     }
 
-    let user = await R.findOne("user", " username = ? AND active = 1 ", [
+    let user = await R.findOne("user", " username = ? AND active = 1", [
         username,
     ]);
 

server/database.js

@@ -66,6 +66,7 @@ class Database {
         "patch-add-radius-monitor.sql": true,
         "patch-monitor-add-resend-interval.sql": true,
         "patch-maintenance-table2.sql": true,
+        "patch-user-username-case-insensitive.sql": { parents: [ "patch-2fa-invalidate-used-token.sql", "patch-2fa.sql" ] }
         "patch-http-monitor-add-body-encoding.sql": true,
     };
 

server/model/monitor.js

@@ -561,7 +561,7 @@ class Monitor extends BeanModel {
                     log.debug("monitor:", `gRPC response: ${JSON.stringify(response)}`);
                     let responseData = response.data;
                     if (responseData.length > 50) {
-                        responseData = response.substring(0, 47) + "...";
+                        responseData = responseData.toString().substring(0, 47) + "...";
                     }
                     if (response.code !== 1) {
                         bean.status = DOWN;
@@ -1103,7 +1103,7 @@ class Monitor extends BeanModel {
                     // Prevent if the msg is undefined, notifications such as Discord cannot send out.
                     const heartbeatJSON = bean.toJSON();
                     if (!heartbeatJSON["msg"]) {
-                        heartbeatJSON["msg"] = "";
+                        heartbeatJSON["msg"] = "N/A";
                     }
 
                     await Notification.send(JSON.parse(notification.config), msg, await monitor.toJSON(false), heartbeatJSON);

server/notification-providers/discord.js

@@ -91,7 +91,7 @@ class Discord extends NotificationProvider {
                             },
                             {
                                 name: monitorJSON["type"] === "push" ? "Service Type" : "Service URL",
-                                value: monitorJSON["type"] === "push" ? "Heartbeat" : address.startsWith("http") ? "[Visit Service](" + address + ")" : address,
+                                value: monitorJSON["type"] === "push" ? "Heartbeat" : address,
                             },
                             {
                                 name: "Time (UTC)",

server/notification-providers/kook.js

@@ -0,0 +1,31 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+
+class Kook extends NotificationProvider {
+
+    name = "Kook";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+        let url = "https://www.kookapp.cn/api/v3/message/create";
+        let data = {
+            target_id: notification.kookGuildID,
+            content: msg,
+        };
+        let config = {
+            headers: {
+                "Authorization": "Bot " + notification.kookBotToken,
+                "Content-Type": "application/json",
+            },
+        };
+        try {
+            await axios.post(url, data, config);
+            return okMsg;
+
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = Kook;

server/notification-providers/zoho-cliq.js

@@ -0,0 +1,116 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+const { DOWN, UP } = require("../../src/util");
+
+class ZohoCliq extends NotificationProvider {
+
+    name = "ZohoCliq";
+
+    /**
+     * Generate the message to send
+     * @param {const} status The status constant
+     * @param {string} monitorName Name of monitor
+     * @returns {string}
+     */
+    _statusMessageFactory = (status, monitorName) => {
+        if (status === DOWN) {
+            return `🔴 Application [${monitorName}] went down\n`;
+        } else if (status === UP) {
+            return `✅ Application [${monitorName}] is back online\n`;
+        }
+        return "Notification\n";
+    };
+
+    /**
+     * Send the notification
+     * @param {string} webhookUrl URL to send the request to
+     * @param {Array} payload Payload generated by _notificationPayloadFactory
+     */
+    _sendNotification = async (webhookUrl, payload) => {
+        await axios.post(webhookUrl, { text: payload.join("\n") });
+    };
+
+    /**
+     * Generate payload for notification
+     * @param {const} status The status of the monitor
+     * @param {string} monitorMessage Message to send
+     * @param {string} monitorName Name of monitor affected
+     * @param {string} monitorUrl URL of monitor affected
+     * @returns {Array}
+     */
+    _notificationPayloadFactory = ({
+        status,
+        monitorMessage,
+        monitorName,
+        monitorUrl,
+    }) => {
+        const payload = [];
+        payload.push("### Uptime Kuma\n");
+        payload.push(this._statusMessageFactory(status, monitorName));
+        payload.push(`*Description:* ${monitorMessage}`);
+
+        if (monitorName) {
+            payload.push(`*Monitor:* ${monitorName}`);
+        }
+
+        if (monitorUrl && monitorUrl !== "https://") {
+            payload.push(`*URL:* [${monitorUrl}](${monitorUrl})`);
+        }
+
+        return payload;
+    };
+
+    /**
+     * Send a general notification
+     * @param {string} webhookUrl URL to send request to
+     * @param {string} msg Message to send
+     * @returns {Promise<void>}
+     */
+    _handleGeneralNotification = (webhookUrl, msg) => {
+        const payload = this._notificationPayloadFactory({
+            monitorMessage: msg
+        });
+
+        return this._sendNotification(webhookUrl, payload);
+    };
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+
+        try {
+            if (heartbeatJSON == null) {
+                await this._handleGeneralNotification(notification.webhookUrl, msg);
+                return okMsg;
+            }
+
+            let url;
+            switch (monitorJSON["type"]) {
+                case "http":
+                case "keywork":
+                    url = monitorJSON["url"];
+                    break;
+                case "docker":
+                    url = monitorJSON["docker_host"];
+                    break;
+                default:
+                    url = monitorJSON["hostname"];
+                    break;
+            }
+
+            const payload = this._notificationPayloadFactory({
+                monitorMessage: heartbeatJSON.msg,
+                monitorName: monitorJSON.name,
+                monitorUrl: url,
+                status: heartbeatJSON.status
+            });
+
+            await this._sendNotification(notification.webhookUrl, payload);
+            return okMsg;
+
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = ZohoCliq;

server/notification.js

@@ -14,6 +14,7 @@ const GoogleChat = require("./notification-providers/google-chat");
 const Gorush = require("./notification-providers/gorush");
 const Gotify = require("./notification-providers/gotify");
 const HomeAssistant = require("./notification-providers/home-assistant");
+const Kook = require("./notification-providers/kook");
 const Line = require("./notification-providers/line");
 const LineNotify = require("./notification-providers/linenotify");
 const LunaSea = require("./notification-providers/lunasea");
@@ -44,6 +45,7 @@ const WeCom = require("./notification-providers/wecom");
 const GoAlert = require("./notification-providers/goalert");
 const SMSManager = require("./notification-providers/smsmanager");
 const ServerChan = require("./notification-providers/serverchan");
+const ZohoCliq = require("./notification-providers/zoho-cliq");
 
 class Notification {
 
@@ -70,6 +72,7 @@ class Notification {
             new Gorush(),
             new Gotify(),
             new HomeAssistant(),
+            new Kook(),
             new Line(),
             new LineNotify(),
             new LunaSea(),
@@ -100,6 +103,7 @@ class Notification {
             new Webhook(),
             new WeCom(),
             new GoAlert(),
+            new ZohoCliq()
         ];
 
         for (let item of list) {

server/server.js

@@ -714,6 +714,7 @@ let needSetup = false;
                 bean.authDomain = monitor.authDomain;
                 bean.grpcUrl = monitor.grpcUrl;
                 bean.grpcProtobuf = monitor.grpcProtobuf;
+                bean.grpcServiceName = monitor.grpcServiceName;
                 bean.grpcMethod = monitor.grpcMethod;
                 bean.grpcBody = monitor.grpcBody;
                 bean.grpcMetadata = monitor.grpcMetadata;

server/util-server.js

@@ -778,6 +778,7 @@ module.exports.grpcQuery = async (options) => {
             cb);
     }, false, false);
     return new Promise((resolve, _) => {
+        try {
             return grpcService[`${grpcMethod}`](JSON.parse(grpcBody), function (err, response) {
                 const responseData = JSON.stringify(response);
                 if (err) {
@@ -787,7 +788,7 @@ module.exports.grpcQuery = async (options) => {
                         data: ""
                     });
                 } else {
-                log.debug("monitor:", `gRPC response: ${response}`);
+                    log.debug("monitor:", `gRPC response: ${JSON.stringify(response)}`);
                     return resolve({
                         code: 1,
                         errorMessage: "",
@@ -795,5 +796,13 @@ module.exports.grpcQuery = async (options) => {
                     });
                 }
             });
+        } catch (err) {
+            return resolve({
+                code: -1,
+                errorMessage: `Error ${err}. Please review your gRPC configuration option. The service name must not include package name value, and the method name must follow camelCase format`,
+                data: ""
+            });
+        }
+
     });
 };

src/components/notifications/Kook.vue

@@ -0,0 +1,36 @@
+<template>
+    <div class="mb-3">
+        <label for="kook-bot-token" class="form-label">{{ $t("Bot Token") }}</label>
+        <HiddenInput id="kook-bot-token" v-model="$parent.notification.kookBotToken" :required="true" autocomplete="new-password"></HiddenInput>
+        <i18n-t tag="div" keypath="wayToGetKookBotToken" class="form-text">
+            <a href="https://developer.kookapp.cn/bot" target="_blank">https://developer.kookapp.cn/bot</a>
+        </i18n-t>
+    </div>
+
+    <div class="mb-3">
+        <label for="kook-guild-id" class="form-label">{{ $t("Guild ID") }}</label>
+
+        <div class="input-group mb-3">
+            <input id="kook-guild-id" v-model="$parent.notification.kookGuildID" type="text" class="form-control" required>
+        </div>
+
+        <div class="form-text">
+            <p style="margin-top: 8px;">
+                {{ $t("wayToGetKookGuildID") }}
+            </p>
+        </div>
+    </div>
+
+    <i18n-t tag="p" keypath="More info on:" style="margin-top: 8px;">
+        <a href="https://developer.kookapp.cn" target="_blank">https://developer.kookapp.cn</a>
+    </i18n-t>
+</template>
+
+<script>
+import HiddenInput from "../HiddenInput.vue";
+export default {
+    components: {
+        HiddenInput,
+    }
+};
+</script>

src/components/notifications/ZohoCliq.vue

@@ -0,0 +1,18 @@
+<template>
+    <div class="mb-3">
+        <label for="zcliq-webhookurl" class="form-label">{{ $t("Webhook URL") }}</label>
+        <input
+            id="zcliq-webhookurl"
+            v-model="$parent.notification.webhookUrl"
+            type="text"
+            class="form-control"
+            required
+        />
+        <i18n-t tag="div" keypath="wayToGetZohoCliqURL" class="form-text">
+            <a
+                href="https://www.zoho.com/cliq/help/platform/webhook-tokens.html"
+                target="_blank"
+            >{{ $t("here") }}</a>
+        </i18n-t>
+    </div>
+</template>

src/components/notifications/index.js

@@ -12,6 +12,7 @@ import GoogleChat from "./GoogleChat.vue";
 import Gorush from "./Gorush.vue";
 import Gotify from "./Gotify.vue";
 import HomeAssistant from "./HomeAssistant.vue";
+import Kook from "./Kook.vue";
 import Line from "./Line.vue";
 import LineNotify from "./LineNotify.vue";
 import LunaSea from "./LunaSea.vue";
@@ -42,6 +43,7 @@ import Telegram from "./Telegram.vue";
 import Webhook from "./Webhook.vue";
 import WeCom from "./WeCom.vue";
 import GoAlert from "./GoAlert.vue";
+import ZohoCliq from "./ZohoCliq.vue";
 
 /**
  * Manage all notification form.
@@ -63,6 +65,7 @@ const NotificationFormList = {
     "gorush": Gorush,
     "gotify": Gotify,
     "HomeAssistant": HomeAssistant,
+    "Kook": Kook,
     "line": Line,
     "LineNotify": LineNotify,
     "lunasea": LunaSea,
@@ -93,6 +96,7 @@ const NotificationFormList = {
     "WeCom": WeCom,
     "GoAlert": GoAlert,
     "ServerChan": ServerChan,
+    "ZohoCliq": ZohoCliq
 };
 
 export default NotificationFormList;

src/languages/el-GR.js

@@ -194,6 +194,7 @@ export default {
     here: "εδώ",
     Required: "Απαιτείται",
     telegram: "Telegram",
+    "ZohoCliq": "ZohoCliq",
     "Bot Token": "Διακριτικό Bot",
     wayToGetTelegramToken: "Μπορείτε να πάρετε ένα διακριτικό από {0}.",
     "Chat ID": "Chat ID",
@@ -224,6 +225,7 @@ export default {
     teams: "Microsoft Teams",
     "Webhook URL": "Webhook URL",
     wayToGetTeamsURL: "Μπορείτε να μάθετε πώς να δημιουργείτε μια διεύθυνση URL webhook {0}.",
+    wayToGetZohoCliqURL: "Μπορείτε να μάθετε πώς να δημιουργείτε μια διεύθυνση URL webhook {0}.",
     signal: "Signal",
     Number: "Αριθμός",
     Recipients: "Αποδέκτες",

src/languages/en.js

@@ -209,6 +209,7 @@ export default {
     here: "here",
     Required: "Required",
     telegram: "Telegram",
+    "ZohoCliq": "ZohoCliq",
     "Bot Token": "Bot Token",
     wayToGetTelegramToken: "You can get a token from {0}.",
     "Chat ID": "Chat ID",
@@ -241,6 +242,7 @@ export default {
     teams: "Microsoft Teams",
     "Webhook URL": "Webhook URL",
     wayToGetTeamsURL: "You can learn how to create a webhook URL {0}.",
+    wayToGetZohoCliqURL: "You can learn how to create a webhook URL {0}.",
     signal: "Signal",
     Number: "Number",
     Recipients: "Recipients",
@@ -270,6 +272,10 @@ export default {
     apprise: "Apprise (Support 50+ Notification services)",
     GoogleChat: "Google Chat (Google Workspace only)",
     pushbullet: "Pushbullet",
+    Kook: "Kook",
+    wayToGetKookBotToken: "Create application and get your bot token at {0}",
+    wayToGetKookGuildID: "Switch on 'Developer Mode' in Kook setting, and right click the guild to get its ID",
+    "Guild ID": "Guild ID",
     line: "Line Messenger",
     mattermost: "Mattermost",
     "User Key": "User Key",

src/languages/eu.js

@@ -191,6 +191,7 @@ export default {
     here: "Hemen",
     Required: "Beharrezkoa",
     telegram: "Telegram",
+    "ZohoCliq": "ZohoCliq",
     "Bot Token": "Bot Tokena",
     wayToGetTelegramToken: "You can get a token from {0}.",
     "Chat ID": "Txat IDa",
@@ -221,6 +222,7 @@ export default {
     teams: "Microsoft Teams",
     "Webhook URL": "Webhook URL",
     wayToGetTeamsURL: "You can learn how to create a webhook URL {0}.",
+    wayToGetZohoCliqURL: "You can learn how to create a webhook URL {0}.",
     signal: "Signal",
     Number: "Zenbakia",
     Recipients: "Recipients",

src/languages/zh-CN.js

@@ -250,6 +250,10 @@ export default {
     apprise: "Apprise (支持 50+ 种通知服务)",
     GoogleChat: "Google Chat（仅 Google Workspace）",
     pushbullet: "Pushbullet",
+    Kook: "Kook",
+    wayToGetKookBotToken: "在 {0} 创建应用并获取机器人 Token",
+    wayToGetKookGuildID: "在Kook设置中打开 ‘开发者模式’，然后右键频道可获取其 ID",
+    "Guild ID": "频道 ID",
     line: "Line Messenger",
     mattermost: "Mattermost",
     "User Key": "User Key",