thelounge-plugin-ntfy 1.3.0 → 1.4.0

package/README.md

@@ -24,8 +24,10 @@ This plugin introduces the `/ntfy` command, subcommands are:
 - `/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
+  - `/ntfy config set <setting_key> <setting_value>`: Set a global configuration setting
+  - `/ntfy config remove <setting_key>`: Set a global configuration setting to null
+  - `/ntfy config network set <setting_key> <setting_value>`: Set a per-network setting for this network
+  - `/ntfy config network remove <setting_key>`: Remove per-network setting for this network
   - `/ntfy config print`: Print the current configuration with warnings if any
 
 ## Setup
@@ -46,12 +48,14 @@ To start/stop sending push notifications in the desired network, enter:
 
 ## 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:
+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 on a specific network, enter this command while connected to that network and start the notifier like usual:
 
 ```
-/ntfy config set config.notify_on_private_messages true
+/ntfy config network set config.notify_on_private_messages true
 ```
 
+This setting is per-network, so you can enable it for some networks and disable it for others.
+
 ## License
 
 This plugin is licensed under [MIT](https://opensource.org/license/mit)

package/index.js

@@ -6,6 +6,8 @@ const {
   setRootDir,
   loadUserConfig,
   saveUserSetting,
+  saveNetworkSetting,
+  PER_NETWORK_KEYS,
 } = require("./src/config.js");
 
 // user -> Map<network.uuid -> handler and client>
@@ -26,10 +28,16 @@ const ntfyCommand = {
       );
       say(`/${command} test - Send a test notification`);
       say(
-        `/${command} config set <setting_key> <setting_value> - Set a configuration setting`,
+        `/${command} config set <setting_key> <setting_value> - Set a global configuration setting`,
       );
       say(
-        `/${command} config remove <setting_key> - Set configuration setting to null`,
+        `/${command} config remove <setting_key> - Set global configuration setting to null`,
+      );
+      say(
+        `/${command} config network set <setting_key> <setting_value> - Set a per-network setting for this network`,
+      );
+      say(
+        `/${command} config network remove <setting_key> - Remove per-network setting for this network`,
       );
       say(
         `/${command} config print - Print the current configuration with warnings if any`,
@@ -229,13 +237,26 @@ const ntfyCommand = {
             const [userConfig, errors] = loadUserConfig(client.client.name);
 
             const sensitiveKeys = new Set(["ntfy.password", "ntfy.token"]);
+            const perNetworkKeys = new Set([
+              "config.notify_on_private_messages",
+            ]);
 
             const printConfig = (obj, parentKey = "") => {
               for (const key in obj) {
                 const value = obj[key];
                 const fullKey = parentKey ? `${parentKey}.${key}` : key;
 
-                if (typeof value === "object" && value !== null) {
+                if (perNetworkKeys.has(fullKey)) {
+                  // Special handling for per-network settings
+                  if (typeof value === "object" && value !== null) {
+                    const networkValue = value[network.uuid];
+                    say(
+                      `${fullKey}=${networkValue !== undefined ? networkValue : "(not set for this network)"}`,
+                    );
+                  } else {
+                    say(`${fullKey}=(not set for this network)`);
+                  }
+                } else if (typeof value === "object" && value !== null) {
                   printConfig(value, fullKey);
                 } else if (sensitiveKeys.has(fullKey) && value) {
                   say(`${fullKey}=********`);
@@ -268,6 +289,78 @@ const ntfyCommand = {
             break;
           }
 
+          case "network": {
+            const networkArgs = subsubcommand.slice(1);
+
+            if (networkArgs.length === 0) {
+              helpMessage();
+              return;
+            }
+
+            if (typeof networkArgs[0] !== "string") {
+              helpMessage();
+              return;
+            }
+
+            switch (networkArgs[0].toLowerCase()) {
+              case "set": {
+                const setArgs = networkArgs.slice(1);
+
+                if (setArgs.length < 2) {
+                  say("Usage: /ntfy config network set <setting_key> <value>");
+                  say(
+                    `Available per-network settings: ${Array.from(PER_NETWORK_KEYS).join(", ")}`,
+                  );
+                  return;
+                }
+
+                const settingKey = setArgs[0];
+                const settingValue = setArgs.slice(1).join(" ");
+                const response = saveNetworkSetting(
+                  client.client.name,
+                  settingKey,
+                  network.uuid,
+                  settingValue,
+                );
+
+                say(response);
+
+                break;
+              }
+
+              case "remove": {
+                const removeArgs = networkArgs.slice(1);
+
+                if (removeArgs.length < 1) {
+                  say("Usage: /ntfy config network remove <setting_key>");
+                  say(
+                    `Available per-network settings: ${Array.from(PER_NETWORK_KEYS).join(", ")}`,
+                  );
+                  return;
+                }
+
+                const settingKey = removeArgs[0];
+                const response = saveNetworkSetting(
+                  client.client.name,
+                  settingKey,
+                  network.uuid,
+                  null,
+                );
+
+                say(response);
+
+                break;
+              }
+
+              default: {
+                helpMessage();
+                break;
+              }
+            }
+
+            break;
+          }
+
           default: {
             helpMessage();
             break;

package/package.json

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

package/src/config.js

@@ -21,20 +21,21 @@ const DEFAULT_CONFIG = {
     token: null,
   },
   config: {
-    notify_on_private_messages: false,
+    notify_on_private_messages: {}, // Per-network: { "network-uuid": true/false }
   },
 };
 
-const ALLOWED_KEYS = new Set([
+const GLOBAL_KEYS = new Set([
   "ntfy.server",
   "ntfy.topic",
   "ntfy.username",
   "ntfy.password",
   "ntfy.token",
-  "config.notify_on_private_messages",
 ]);
+const GLOBAL_BOOLEAN_KEYS = new Set([]);
 
-const BOOLEAN_KEYS = new Set(["config.notify_on_private_messages"]);
+const PER_NETWORK_KEYS = new Set(["config.notify_on_private_messages"]);
+const PER_NETWORK_BOOLEAN_KEYS = new Set(["config.notify_on_private_messages"]);
 
 const SENSITIVE_KEYS = new Set(["ntfy.password", "ntfy.token"]);
 
@@ -110,8 +111,9 @@ const userConfigSchema = {
       required: ["notify_on_private_messages"],
       properties: {
         notify_on_private_messages: {
-          type: "boolean",
-          default: false,
+          type: "object",
+          additionalProperties: { type: ["boolean", "string"] },
+          default: {},
         },
       },
     },
@@ -227,7 +229,7 @@ function saveUserSetting(username, settingKey, settingValue) {
     throw new Error("Root directory is not set");
   }
 
-  if (ALLOWED_KEYS.has(settingKey)) {
+  if (GLOBAL_KEYS.has(settingKey)) {
     let userConfig = loadUserConfig(username)[0];
 
     const keys = settingKey.split(".");
@@ -245,7 +247,7 @@ function saveUserSetting(username, settingKey, settingValue) {
       return `Error: expected value to be a string`;
     }
 
-    if (BOOLEAN_KEYS.has(settingKey)) {
+    if (GLOBAL_BOOLEAN_KEYS.has(settingKey)) {
       try {
         settingValue = settingValue
           ? JSON.parse(settingValue.toLowerCase())
@@ -276,12 +278,103 @@ function saveUserSetting(username, settingKey, settingValue) {
   }
 
   return `Invalid setting ${settingKey}, allowed settings are: ${Array.from(
-    ALLOWED_KEYS,
+    GLOBAL_KEYS,
   ).join(", ")}`;
 }
 
+function saveNetworkSetting(username, settingKey, networkUuid, settingValue) {
+  if (!rootDir) {
+    throw new Error("Root directory is not set");
+  }
+
+  if (!PER_NETWORK_KEYS.has(settingKey)) {
+    return `Invalid per-network setting ${settingKey}, allowed settings are: ${Array.from(
+      PER_NETWORK_KEYS,
+    ).join(", ")}`;
+  }
+
+  let userConfig = loadUserConfig(username)[0];
+
+  const keys = settingKey.split(".");
+
+  let curr = userConfig;
+
+  for (let i = 0; i < keys.length - 1; i++) {
+    const key = keys[i];
+    if (key in curr) {
+      curr = curr[key];
+    }
+  }
+
+  const finalKey = keys[keys.length - 1];
+
+  if (!curr[finalKey] || typeof curr[finalKey] !== "object") {
+    curr[finalKey] = {};
+  }
+
+  if (settingValue === null) {
+    delete curr[finalKey][networkUuid];
+  } else if (PER_NETWORK_BOOLEAN_KEYS.has(settingKey)) {
+    try {
+      const boolValue = JSON.parse(settingValue.toLowerCase());
+
+      if (typeof boolValue !== "boolean") {
+        return `Invalid value for ${settingKey}, expected a boolean`;
+      }
+
+      curr[finalKey][networkUuid] = boolValue;
+    } catch {
+      return `Invalid value for ${settingKey}, expected a boolean (true/false)`;
+    }
+  } else {
+    curr[finalKey][networkUuid] = settingValue;
+  }
+
+  const configToSave = encryptSensitiveFields(userConfig);
+
+  const userConfigPath = path.join(rootDir, "config", `${username}.json`);
+
+  fs.mkdirSync(path.dirname(userConfigPath), { recursive: true });
+  fs.writeFileSync(
+    userConfigPath,
+    JSON.stringify(configToSave, null, 2),
+    "utf-8",
+  );
+
+  return "Success";
+}
+
+function getNetworkSetting(
+  userConfig,
+  settingKey,
+  networkUuid,
+  defaultValue = false,
+) {
+  const keys = settingKey.split(".");
+
+  let curr = userConfig;
+
+  for (const key of keys) {
+    if (curr && typeof curr === "object" && key in curr) {
+      curr = curr[key];
+    } else {
+      return defaultValue;
+    }
+  }
+
+  if (curr && typeof curr === "object" && networkUuid in curr) {
+    return curr[networkUuid];
+  }
+
+  return defaultValue;
+}
+
 module.exports = {
   setRootDir,
   loadUserConfig,
   saveUserSetting,
+  saveNetworkSetting,
+  getNetworkSetting,
+  PER_NETWORK_KEYS,
+  PER_NETWORK_BOOLEAN_KEYS,
 };

package/src/handler.js

@@ -1,6 +1,6 @@
 "use strict";
 
-const { loadUserConfig } = require("./config.js");
+const { loadUserConfig, getNetworkSetting } = require("./config.js");
 const { PluginLogger } = require("./logger.js");
 
 function createHandler(client, network) {
@@ -23,7 +23,7 @@ function createHandler(client, network) {
       // Mentions always notify
       notify = true;
     } else if (isPM) {
-      // PMs notify only if enabled in config
+      // PMs notify only if enabled in config for this network
       const [uc, errors] = loadUserConfig(client.client.name);
 
       if (errors.length > 0) {
@@ -32,7 +32,14 @@ function createHandler(client, network) {
 
       userConfig = uc;
 
-      if (userConfig.config.notify_on_private_messages) {
+      const notifyOnPMs = getNetworkSetting(
+        userConfig,
+        "config.notify_on_private_messages",
+        network.uuid,
+        false,
+      );
+
+      if (notifyOnPMs) {
         notify = true;
       }
     }