thelounge-plugin-ntfy 1.4.0 → 1.6.0

package/README.md

@@ -19,9 +19,9 @@ Restart The Lounge after installation
 
 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 start [all]`: Start the ntfy listener for the network or all networks if 'all' is specified
+- `/ntfy stop [all]`: Stop the ntfy listener for the network or all networks if 'all' is specified
+- `/ntfy status [all]`: Show the ntfy listener status for this network or all networks if 'all' is specified
 - `/ntfy test`: Send a test notification
 - `/ntfy config`: Config commands
   - `/ntfy config set <setting_key> <setting_value>`: Set a global configuration setting

package/index.js

@@ -21,10 +21,14 @@ const ntfyCommand = {
 
     const helpMessage = () => {
       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`,
+        `/${command} start [all] - Start the ntfy listener for this network or all networks if 'all' is specified`,
+      );
+      say(
+        `/${command} stop [all] - Stop the ntfy listener for this network or all networks if 'all' is specified`,
+      );
+      say(
+        `/${command} status [all] - Show the ntfy listener status for this network or all networks if 'all' is specified`,
       );
       say(`/${command} test - Send a test notification`);
       say(
@@ -59,82 +63,221 @@ const ntfyCommand = {
 
     switch (subcommand[0].toLowerCase()) {
       case "start": {
+        let all = false;
         const [_, errors] = loadUserConfig(client.client.name);
+        const subsubcommand = subcommand.slice(1);
+
+        if (
+          typeof subsubcommand[0] === "string" &&
+          subsubcommand.length > 0 &&
+          subsubcommand[0].toLowerCase() === "all"
+        ) {
+          all = true;
+        }
 
         if (errors.length > 0) {
-          say("Cannot start ntfy listener due to invalid configuration:");
+          say(
+            `Cannot start ntfy listener${all ? "s" : ""} due to invalid configuration:`,
+          );
+
           for (const error of errors) {
             say(`- ${error.instancePath} ${error.message}`);
           }
+
           return;
         }
 
         const userListeners = globalActiveListeners.get(client.client.name);
 
-        if (
-          userListeners &&
-          typeof userListeners.has === "function" &&
-          userListeners.has(network.uuid)
-        ) {
-          say("ntfy listener is already running for this network");
-          return;
-        }
+        if (all) {
+          const networks = client.client.networks;
+          let started = 0;
+          let skipped = 0;
+
+          for (const net of networks) {
+            if (
+              userListeners &&
+              typeof userListeners.has === "function" &&
+              userListeners.has(net.uuid)
+            ) {
+              skipped++;
+              continue;
+            }
+
+            const handler = createHandler(client, net);
+            net.irc.on("privmsg", handler);
+
+            if (!userListeners) {
+              const map = new Map();
+              map.set(net.uuid, { handler: handler, client: client });
+              globalActiveListeners.set(client.client.name, map);
+            } else {
+              userListeners.set(net.uuid, {
+                handler: handler,
+                client: client,
+              });
+            }
 
-        const handler = createHandler(client, network);
-        network.irc.on("privmsg", handler);
+            started++;
+          }
 
-        if (!userListeners) {
-          const map = new Map();
-          map.set(network.uuid, { handler: handler, client: client });
-          globalActiveListeners.set(client.client.name, map);
+          if (started === 0 && skipped === 0) {
+            say("No networks available to start ntfy listeners");
+            return;
+          }
+          if (started > 0) {
+            say(
+              `Started ntfy listener${started !== 1 ? "s" : ""} for ${started} network${started !== 1 ? "s" : ""}`,
+            );
+          }
+          if (skipped > 0) {
+            say(
+              `Skipped ${skipped} network${skipped !== 1 ? "s" : ""} because ntfy listener is already running`,
+            );
+          }
         } else {
-          userListeners.set(network.uuid, { handler: handler, client: client });
-        }
+          if (
+            userListeners &&
+            typeof userListeners.has === "function" &&
+            userListeners.has(network.uuid)
+          ) {
+            say("ntfy listener is already running for this network");
+            return;
+          }
+
+          const handler = createHandler(client, network);
+          network.irc.on("privmsg", handler);
+
+          if (!userListeners) {
+            const map = new Map();
+            map.set(network.uuid, { handler: handler, client: client });
+            globalActiveListeners.set(client.client.name, map);
+          } else {
+            userListeners.set(network.uuid, {
+              handler: handler,
+              client: client,
+            });
+          }
 
-        say("ntfy listener started for this network");
+          say("ntfy listener started for this network");
+        }
 
         break;
       }
 
       case "stop": {
-        const userListeners = globalActiveListeners.get(client.client.name);
+        let all = false;
+        const subsubcommand = subcommand.slice(1);
 
         if (
-          !userListeners ||
-          typeof userListeners.has !== "function" ||
-          !userListeners.has(network.uuid)
+          typeof subsubcommand[0] === "string" &&
+          subsubcommand.length > 0 &&
+          subsubcommand[0].toLowerCase() === "all"
         ) {
-          say("ntfy listener is not running for this network");
-          return;
+          all = true;
         }
 
-        const { handler } = userListeners.get(network.uuid);
-        network.irc.removeListener("privmsg", handler);
-        userListeners.delete(network.uuid);
+        const userListeners = globalActiveListeners.get(client.client.name);
+
+        if (all) {
+          const networks = client.client.networks;
+          let stopped = 0;
+          let skipped = 0;
+
+          for (const net of networks) {
+            if (
+              !userListeners ||
+              typeof userListeners.has !== "function" ||
+              !userListeners.has(net.uuid)
+            ) {
+              skipped++;
+              continue;
+            }
+
+            const { handler } = userListeners.get(net.uuid);
+            net.irc.removeListener("privmsg", handler);
+            userListeners.delete(net.uuid);
+            stopped++;
+          }
+
+          if (stopped === 0 && skipped === 0) {
+            say("No networks available to stop ntfy listeners");
+            return;
+          }
+          if (stopped > 0) {
+            say(
+              `Stopped ntfy listener${stopped !== 1 ? "s" : ""} for ${stopped} network${stopped !== 1 ? "s" : ""}`,
+            );
+          }
+          if (skipped > 0) {
+            say(
+              `Skipped ${skipped} network${skipped !== 1 ? "s" : ""} because ntfy listener was not running`,
+            );
+          }
+        } else {
+          if (
+            !userListeners ||
+            typeof userListeners.has !== "function" ||
+            !userListeners.has(network.uuid)
+          ) {
+            say("ntfy listener is not running for this network");
+            return;
+          }
+
+          const { handler } = userListeners.get(network.uuid);
+          network.irc.removeListener("privmsg", handler);
+          userListeners.delete(network.uuid);
 
-        say("ntfy listener stopped for this network");
+          say("ntfy listener stopped for this network");
+        }
 
         break;
       }
 
       case "status": {
-        const userListeners = globalActiveListeners.get(client.client.name);
+        let all = false;
+        const subsubcommand = subcommand.slice(1);
 
         if (
-          userListeners &&
-          typeof userListeners.has === "function" &&
-          userListeners.has(network.uuid)
+          typeof subsubcommand[0] === "string" &&
+          subsubcommand.length > 0 &&
+          subsubcommand[0].toLowerCase() === "all"
         ) {
-          say("ntfy listener is running for this network");
+          all = true;
+        }
+
+        const userListeners = globalActiveListeners.get(client.client.name);
+
+        if (all) {
+          const networks = client.client.networks;
+          for (const net of networks) {
+            if (
+              userListeners &&
+              typeof userListeners.has === "function" &&
+              userListeners.has(net.uuid)
+            ) {
+              say(`${net.name}: running`);
+            } else {
+              say(`${net.name}: not running`);
+            }
+          }
         } else {
-          say("ntfy listener is not running for this network");
+          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 { NtfyClient } = await import("ntfy");
 
         const [userConfig, errors] = loadUserConfig(client.client.name);
 
@@ -160,7 +303,7 @@ const ntfyCommand = {
         const ntfyClient = new NtfyClient({
           server: userConfig.ntfy.server,
           topic: userConfig.ntfy.topic,
-          priority: MessagePriority.HIGH,
+          priority: userConfig.ntfy.priority,
           tags: ["speech_balloon"],
           authorization: ntfyAuth,
         });

package/package.json

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

package/src/config.js

@@ -19,6 +19,7 @@ const DEFAULT_CONFIG = {
     username: null,
     password: null,
     token: null,
+    priority: 3,
   },
   config: {
     notify_on_private_messages: {}, // Per-network: { "network-uuid": true/false }
@@ -31,8 +32,10 @@ const GLOBAL_KEYS = new Set([
   "ntfy.username",
   "ntfy.password",
   "ntfy.token",
+  "ntfy.priority",
 ]);
 const GLOBAL_BOOLEAN_KEYS = new Set([]);
+const GLOBAL_NUMERIC_KEYS = new Set(["ntfy.priority"]);
 
 const PER_NETWORK_KEYS = new Set(["config.notify_on_private_messages"]);
 const PER_NETWORK_BOOLEAN_KEYS = new Set(["config.notify_on_private_messages"]);
@@ -67,6 +70,13 @@ const userConfigSchema = {
           nullable: true,
           errorMessage: "Invalid ntfy token, must start with 'tk_'",
         },
+        priority: {
+          type: "integer",
+          minimum: 1,
+          maximum: 5,
+          default: 3,
+          errorMessage: "Priority must be an integer between 1 and 5",
+        },
       },
       allOf: [
         {
@@ -112,7 +122,7 @@ const userConfigSchema = {
       properties: {
         notify_on_private_messages: {
           type: "object",
-          additionalProperties: { type: ["boolean", "string"] },
+          additionalProperties: { type: "boolean" },
           default: {},
         },
       },
@@ -261,6 +271,18 @@ function saveUserSetting(username, settingKey, settingValue) {
       }
     }
 
+    if (GLOBAL_NUMERIC_KEYS.has(settingKey)) {
+      try {
+        settingValue = settingValue ? Number(settingValue) : NaN;
+
+        if (isNaN(settingValue) || typeof settingValue !== "number") {
+          return `Invalid value for ${settingKey}, expected a number`;
+        }
+      } catch {
+        return `Invalid value for ${settingKey}, expected a number`;
+      }
+    }
+
     curr[keys[keys.length - 1]] = settingValue;
 
     const configToSave = encryptSensitiveFields(userConfig);

package/src/handler.js

@@ -10,17 +10,27 @@ function createHandler(client, network) {
       return;
     }
 
+    const isPM = data.target === network.nick;
+
+    const channel = isPM
+      ? network.channels.find((chan) => chan.name === data.nick)
+      : network.channels.find((chan) => chan.name === data.target);
+
+    if (channel.muted) {
+      // Ignore messages in muted channels
+      return;
+    }
+
     const highlightRegex = new RegExp(network.highlightRegex, "i");
     const message = data.message || "";
 
     const mentioned = highlightRegex.test(message);
-    const isPM = data.target === network.nick;
 
     let notify = false;
     let userConfig;
 
-    if (mentioned) {
-      // Mentions always notify
+    if (mentioned && !isPM) {
+      // Mentions always notify in channels
       notify = true;
     } else if (isPM) {
       // PMs notify only if enabled in config for this network
@@ -71,12 +81,12 @@ function createHandler(client, network) {
           };
         }
 
-        const { NtfyClient, MessagePriority } = await import("ntfy");
+        const { NtfyClient } = await import("ntfy");
 
         const ntfyClient = new NtfyClient({
           server: userConfig.ntfy.server,
           topic: userConfig.ntfy.topic,
-          priority: MessagePriority.HIGH,
+          priority: userConfig.ntfy.priority,
           tags: ["speech_balloon"],
           authorization: ntfyAuth,
         });