thelounge-plugin-ntfy 1.0.0 → 1.2.0

package/README.md

@@ -18,6 +18,8 @@ This plugin introduces the `/ntfy` command, subcommands are:
 
 - `/ntfy start`: Start the ntfy listener for the network
 - `/ntfy stop`: Stop the ntfy listener for the network
+- `/ntfy status`: Show the ntfy listener status for this network
+- `/ntfy test`: Send a test notification
 - `/ntfy config`: Config commands
   - `/ntfy config set <setting_key> <setting_value>`: Set a configuration setting
   - `/ntfy config remove <setting_key>`: Set a configuration setting to null
@@ -39,6 +41,14 @@ To start/stop sending push notifications in the desired network, enter:
 /ntfy start/stop
 ```
 
+## Private Messages
+
+By default, you will only be notified when you are mentioned, **this includes messages sent privately to you**. If you want to be notified of all private messages, enter this command and start the notifier like usual:
+
+```
+/ntfy config set config.notify_on_private_messages true
+```
+
 ## License
 
 This plugin is licensed under [MIT](https://opensource.org/license/mit)

package/docker-compose.yml

@@ -8,3 +8,7 @@ services:
     restart: unless-stopped
     volumes:
       - $PWD/tl:/var/opt/thelounge
+      - $PWD/src:/var/opt/thelounge/packages/thelounge-plugin-ntfy/src
+      - $PWD/index.js:/var/opt/thelounge/packages/thelounge-plugin-ntfy/index.js
+      - $PWD/package.json:/var/opt/thelounge/packages/thelounge-plugin-ntfy/package.json
+      - $PWD/package-lock.json:/var/opt/thelounge/packages/thelounge-plugin-ntfy/package-lock.json

package/index.js

@@ -12,7 +12,7 @@ const {
 const globalActiveListeners = new Map();
 
 const ntfyCommand = {
-  input: (client, target, command, args) => {
+  input: async (client, target, command, args) => {
     const say = (message) => {
       client.sendMessage(message, target.chan);
     };
@@ -21,6 +21,10 @@ const ntfyCommand = {
       say(`${command} command help:`);
       say(`/${command} start - Start the ntfy listener for this network`);
       say(`/${command} stop - Stop the ntfy listener for this network`);
+      say(
+        `/${command} status - Show the ntfy listener status for this network`
+      );
+      say(`/${command} test - Send a test notification`);
       say(
         `/${command} config set <setting_key> <setting_value> - Set a configuration setting`
       );
@@ -105,6 +109,67 @@ const ntfyCommand = {
         break;
       }
 
+      case "status": {
+        const userListeners = globalActiveListeners.get(client.client.name);
+
+        if (
+          userListeners &&
+          typeof userListeners.has === "function" &&
+          userListeners.has(network.uuid)
+        ) {
+          say("ntfy listener is running for this network");
+        } else {
+          say("ntfy listener is not running for this network");
+        }
+
+        break;
+      }
+
+      case "test": {
+        const { NtfyClient, MessagePriority } = await import("ntfy");
+
+        const [userConfig, errors] = loadUserConfig(client.client.name);
+
+        if (errors.length > 0) {
+          say("Cannot test ntfy due to invalid configuration:");
+          for (const error of errors) {
+            say(`- ${error.instancePath} ${error.message}`);
+          }
+          return;
+        }
+
+        let ntfyAuth;
+
+        if (userConfig.ntfy.token) {
+          ntfyAuth = userConfig.ntfy.token;
+        } else if (userConfig.ntfy.username && userConfig.ntfy.password) {
+          ntfyAuth = {
+            username: userConfig.ntfy.username,
+            password: userConfig.ntfy.password,
+          };
+        }
+
+        const ntfyClient = new NtfyClient({
+          server: userConfig.ntfy.server,
+          topic: userConfig.ntfy.topic,
+          priority: MessagePriority.HIGH,
+          tags: ["speech_balloon"],
+          authorization: ntfyAuth,
+        });
+
+        try {
+          ntfyClient.publish({
+            title: `${network.name} #afakechannel: ntfy`,
+            message: `Hello, ${client.client.name}!`,
+          });
+          say(`Sent to ${userConfig.ntfy.server}/${userConfig.ntfy.topic}`);
+        } catch (error) {
+          say(`Failed to send test notification: ${error.message}`);
+        }
+
+        break;
+      }
+
       case "config": {
         const subsubcommand = subcommand.slice(1);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "thelounge-plugin-ntfy",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "A plugin for The Lounge that sends push notifications via ntfy when highlighted",
   "keywords": [
     "thelounge",

package/src/config.js

@@ -14,6 +14,9 @@ const DEFAULT_CONFIG = {
     password: null,
     token: null,
   },
+  config: {
+    notify_on_private_messages: false,
+  },
 };
 
 const ALLOWED_KEYS = new Set([
@@ -22,12 +25,15 @@ const ALLOWED_KEYS = new Set([
   "ntfy.username",
   "ntfy.password",
   "ntfy.token",
+  "config.notify_on_private_messages",
 ]);
 
+const BOOLEAN_KEYS = new Set(["config.notify_on_private_messages"]);
+
 const userConfigSchema = {
   type: "object",
   additionalProperties: false,
-  required: ["ntfy"],
+  required: ["ntfy", "config"],
   properties: {
     ntfy: {
       type: "object",
@@ -90,6 +96,17 @@ const userConfigSchema = {
         password: ["username"],
       },
     },
+    config: {
+      type: "object",
+      additionalProperties: false,
+      required: ["notify_on_private_messages"],
+      properties: {
+        notify_on_private_messages: {
+          type: "boolean",
+          default: false,
+        },
+      },
+    },
   },
 };
 
@@ -155,6 +172,24 @@ function saveUserSetting(username, settingKey, settingValue) {
       }
     }
 
+    if (settingValue && typeof settingValue !== "string") {
+      return `Error: expected value to be a string`;
+    }
+
+    if (BOOLEAN_KEYS.has(settingKey)) {
+      try {
+        settingValue = settingValue
+          ? JSON.parse(settingValue.toLowerCase())
+          : false;
+
+        if (typeof settingValue !== "boolean") {
+          return `Invalid value for ${settingKey}, expected a boolean`;
+        }
+      } catch {
+        return `Invalid value for ${settingKey}, expected a boolean`;
+      }
+    }
+
     curr[keys[keys.length - 1]] = settingValue;
 
     const userConfigPath = path.join(rootDir, "config", `${username}.json`);

package/src/handler.js

@@ -1,45 +1,88 @@
 "use strict";
 
 const { loadUserConfig } = require("./config.js");
+const { PluginLogger } = require("./logger.js");
 
 function createHandler(client, network) {
   return async (data) => {
+    // Ignore own messages
+    if (network.nick === data.nick) {
+      return;
+    }
+
     const highlightRegex = new RegExp(network.highlightRegex, "i");
     const message = data.message || "";
 
-    if (highlightRegex.test(message)) {
-      // Load config after each message to get latest settings
-      const [userConfig, errors] = loadUserConfig(client.client.name);
+    const mentioned = highlightRegex.test(message);
+    const isPM = data.target === network.nick;
+
+    let notify = false;
+    let userConfig;
+
+    if (mentioned) {
+      // Mentions always notify
+      notify = true;
+    } else if (isPM) {
+      // PMs notify only if enabled in config
+      const [uc, errors] = loadUserConfig(client.client.name);
 
       if (errors.length > 0) {
         return;
       }
 
-      let ntfyAuth;
+      userConfig = uc;
 
-      if (userConfig.ntfy.token) {
-        ntfyAuth = userConfig.ntfy.token;
-      } else if (userConfig.ntfy.username && userConfig.ntfy.password) {
-        ntfyAuth = {
-          username: userConfig.ntfy.username,
-          password: userConfig.ntfy.password,
-        };
+      if (userConfig.config.notify_on_private_messages) {
+        notify = true;
       }
+    }
+
+    if (notify) {
+      try {
+        // Avoid needlessly loading user config multiple times
+        if (!userConfig) {
+          const [uc, errors] = loadUserConfig(client.client.name);
 
-      const { NtfyClient, MessagePriority } = await import("ntfy");
+          if (errors.length > 0) {
+            return;
+          }
 
-      const ntfyClient = new NtfyClient({
-        server: userConfig.ntfy.server,
-        topic: userConfig.ntfy.topic,
-        priority: MessagePriority.HIGH,
-        tags: ["speech_balloon"],
-        authorization: ntfyAuth,
-      });
+          userConfig = uc;
+        }
 
-      ntfyClient.publish({
-        title: `${network.name} ${data.target}: ${data.nick}`,
-        message: message,
-      });
+        let ntfyAuth;
+
+        if (userConfig.ntfy.token) {
+          ntfyAuth = {
+            username: "",
+            password: userConfig.ntfy.token,
+          };
+        } else if (userConfig.ntfy.username && userConfig.ntfy.password) {
+          ntfyAuth = {
+            username: userConfig.ntfy.username,
+            password: userConfig.ntfy.password,
+          };
+        }
+
+        const { NtfyClient, MessagePriority } = await import("ntfy");
+
+        const ntfyClient = new NtfyClient({
+          server: userConfig.ntfy.server,
+          topic: userConfig.ntfy.topic,
+          priority: MessagePriority.HIGH,
+          tags: ["speech_balloon"],
+          authorization: ntfyAuth,
+        });
+
+        ntfyClient.publish({
+          title: isPM
+            ? `${network.name}: ${data.nick}`
+            : `${network.name} ${data.target}: ${data.nick}`,
+          message: message,
+        });
+      } catch (e) {
+        PluginLogger.error("Failed to send ntfy notification", e);
+      }
     }
   };
 }