IRC bridge: Do not append "_zulip" to the specified nickname.

Author: rht

zulip/integrations/bridge_with_irc/README.md

@@ -3,7 +3,7 @@
 ## Usage
 
 ```
-./irc-mirror.py --irc-server=IRC_SERVER --channel=<CHANNEL> --nick-prefix=<NICK> --stream=<STREAM> [optional args]
+./irc-mirror.py --irc-server=IRC_SERVER --channel=<CHANNEL> --nickname=<NICK> --stream=<STREAM> [optional args]
 ```
 
 `--stream` is a Zulip stream.  
@@ -14,12 +14,10 @@ IMPORTANT: Make sure the bot is subscribed to the relevant Zulip stream!!
 
 Specify your Zulip API credentials and server in a ~/.zuliprc file or using the options.
 
-IMPORTANT: Note that "_zulip" will be automatically appended to the IRC nick provided, so make sure that your actual registered nick ends with "_zulip".
-
 ## Example
 
 ```
-./irc-mirror.py --irc-server=irc.freenode.net --channel='#python-mypy' --nick-prefix=irc_mirror \
+./irc-mirror.py --irc-server=irc.freenode.net --channel='#python-mypy' --nickname=irc_mirror \
 --stream='test here' --topic='#mypy' \
 --site="https://chat.zulip.org" --user=<bot-email> \
 --api-key=<bot-api-key>

zulip/integrations/bridge_with_irc/irc-mirror.py

@@ -9,26 +9,24 @@
 import sys
 import traceback
 
-usage = """./irc-mirror.py --irc-server=IRC_SERVER --channel=<CHANNEL> --nick-prefix=<NICK> --stream=<STREAM> [optional args]
+usage = """./irc-mirror.py --irc-server=IRC_SERVER --channel=<CHANNEL> --nickname=<NICK> --stream=<STREAM> [optional args]
 
 Example:
 
-./irc-mirror.py --irc-server=127.0.0.1 --channel='#test' --nick-prefix=username --stream='test' --topic='#mypy'
+./irc-mirror.py --irc-server=irc.freenode.net --channel='#test' --nickname=username --stream='test' --topic='#mypy'
 
 --stream is a Zulip stream.
 --topic is a Zulip topic, is optionally specified, defaults to "IRC".
 --nickserv-pw is a password for the nickserv, is optionally specified.
 
 Specify your Zulip API credentials and server in a ~/.zuliprc file or using the options.
-
-Note that "_zulip" will be automatically appended to the IRC nick provided
 """
 
 if __name__ == "__main__":
     parser = zulip.add_default_arguments(argparse.ArgumentParser(usage=usage), allow_provisioning=True)
     parser.add_argument('--irc-server', default=None)
     parser.add_argument('--port', default=6667)
-    parser.add_argument('--nick-prefix', default=None)
+    parser.add_argument('--nickname', default=None)
     parser.add_argument('--channel', default=None)
     parser.add_argument('--stream', default="general")
     parser.add_argument('--topic', default="IRC")
@@ -46,10 +44,10 @@
               "{} --provision".format(sys.argv[0]))
         sys.exit(1)
 
-    if options.irc_server is None or options.nick_prefix is None or options.channel is None:
+    if options.irc_server is None or options.nickname is None or options.channel is None:
         parser.error("Missing required argument")
 
-    nickname = options.nick_prefix + "_zulip"
+    nickname = options.nickname
     bot = IRCBot(zulip_client, options.stream, options.topic, options.channel,
                  nickname, options.irc_server, options.nickserv_pw, options.port)
     bot.start()

zulip/integrations/bridge_with_irc/irc_mirror_backend.py

@@ -15,6 +15,7 @@ def __init__(self, zulip_client: Any, stream: str, topic: str, channel: irc.bot.
         self.zulip_client = zulip_client
         self.stream = stream
         self.topic = topic
+        self.nickname = nickname
         self.IRC_DOMAIN = server
         self.nickserv_password = nickserv_password
         # Make sure the bot is subscribed to the stream
@@ -84,7 +85,7 @@ def forward_to_irc(msg: Dict[str, Any]) -> None:
     def on_privmsg(self, c: ServerConnection, e: Event) -> None:
         content = e.arguments[0]
         sender = self.zulip_sender(e.source)
-        if sender.endswith("_zulip@" + self.IRC_DOMAIN):
+        if sender == (self.nickname + "@" + self.IRC_DOMAIN):
             return
 
         # Forward the PM to Zulip
@@ -98,7 +99,7 @@ def on_privmsg(self, c: ServerConnection, e: Event) -> None:
     def on_pubmsg(self, c: ServerConnection, e: Event) -> None:
         content = e.arguments[0]
         sender = self.zulip_sender(e.source)
-        if sender.endswith("_zulip@" + self.IRC_DOMAIN):
+        if sender == (self.nickname + "@" + self.IRC_DOMAIN):
             return
 
         # Forward the stream message to Zulip