Merge pull request #322 from anirbanmu/ignore-users-both-ways

Add the ability to ignore IRC/Discord users by nickname

README.md

@@ -90,6 +90,10 @@ First you need to create a Discord bot user, which you can do by following the i
     // with one of these characters (commands):
     "commandCharacters": ["!", "."],
     "ircStatusNotices": true // Enables notifications in Discord when people join/part in the relevant IRC channel
+    "ignoreUsers": {
+      "irc": ["irc_nick1", "irc_nick2"] // Ignore specified IRC nicks and do not send their messages to Discord.
+      "discord": ["discord_nick1", "discord_nick2"] // Ignore specified Discord nicks and do not send their messages to IRC.
+    }
   }
 ]
 ```

lib/bot.js

@@ -37,6 +37,11 @@ class Bot {
     this.ircStatusNotices = options.ircStatusNotices;
     this.announceSelfJoin = options.announceSelfJoin;
 
+    // Nicks to ignore
+    this.ignoreUsers = options.ignoreUsers || {};
+    this.ignoreUsers.irc = this.ignoreUsers.irc || [];
+    this.ignoreUsers.discord = this.ignoreUsers.discord || [];
+
     // "{$keyName}" => "variableValue"
     // author/nickname: nickname of the user who sent the message
     // discordChannel: Discord channel (e.g. #general)
@@ -263,6 +268,14 @@ class Bot {
     return this.commandCharacters.some(prefix => message.startsWith(prefix));
   }
 
+  ignoredIrcUser(user) {
+    return this.ignoreUsers.irc.some(i => i.toLowerCase() === user.toLowerCase());
+  }
+
+  ignoredDiscordUser(user) {
+    return this.ignoreUsers.discord.some(i => i.toLowerCase() === user.toLowerCase());
+  }
+
   static substitutePattern(message, patternMapping) {
     return message.replace(patternMatch, (match, varName) => patternMapping[varName] || match);
   }
@@ -272,6 +285,11 @@ class Bot {
     // Ignore messages sent by the bot itself:
     if (author.id === this.discord.user.id) return;
 
+    // Do not send to IRC if this user is on the ignore list.
+    if (this.ignoredDiscordUser(author.username)) {
+      return;
+    }
+
     const channelName = `#${message.channel.name}`;
     const ircChannel = this.channelMapping[message.channel.id] ||
                                            this.channelMapping[channelName];
@@ -351,6 +369,11 @@ class Bot {
     const discordChannel = this.findDiscordChannel(channel);
     if (!discordChannel) return;
 
+    // Do not send to Discord if this user is on the ignore list.
+    if (this.ignoredIrcUser(author)) {
+      return;
+    }
+
     // Convert text formatting (bold, italics, underscore)
     const withFormat = formatFromIRCToDiscord(text);
 

test/bot.test.js

@@ -831,4 +831,29 @@ describe('Bot', function () {
     this.sendStub.should.have.been.calledOnce;
     this.sendStub.getCall(0).args.should.deep.equal([msg]);
   });
+
+  it('should not send messages to Discord if IRC user is ignored',
+    function () {
+      this.bot.sendToDiscord('irc_ignored_user', '#irc', 'message');
+      this.sendStub.should.not.have.been.called;
+    });
+
+  it('should not send messages to IRC if Discord user is ignored',
+    function () {
+      const message = {
+        content: 'text',
+        mentions: { users: [] },
+        channel: {
+          name: 'discord'
+        },
+        author: {
+          username: 'discord_ignored_user',
+          id: 'some id'
+        },
+        guild: this.guild
+      };
+
+      this.bot.sendToIRC(message);
+      ClientStub.prototype.say.should.not.have.been.called;
+    });
 });

test/fixtures/single-test-config.json

@@ -11,5 +11,9 @@
     "#discord": "#irc channelKey",
     "#notinchannel": "#otherIRC",
     "1234": "#channelforid"
+  },
+  "ignoreUsers": {
+    "irc": ["irc_ignored_user"],
+    "discord": ["discord_ignored_user"]
   }
 }