From 5bfba0a411301e62651d74e5074cb2e709869399 Mon Sep 17 00:00:00 2001
From: James Lu <GLolol@overdrivenetworks.com>
Date: Sun, 10 Jul 2016 23:32:04 -0700
Subject: [PATCH] relay: make default nick tagging and separator global options
 (#116)

---
 example-conf.yml | 14 ++++++++++----
 plugins/relay.py | 44 ++++++++++++++++++++++++++++++++------------
 2 files changed, 42 insertions(+), 16 deletions(-)

diff --git a/example-conf.yml b/example-conf.yml
index fc60a30..aec21ac 100644
--- a/example-conf.yml
+++ b/example-conf.yml
@@ -104,10 +104,6 @@ servers:
         # not set.
         pingfreq: 90
 
-        # Separator character (used by relay). Making this include anything other
-        # than letters, numbers, or /|_`-[]^ will void your support.
-        separator: "/"
-
         # If enabled, this opts this network out of relay IP sharing. i.e. this network
         # will not have its users' IPs sent across the relay, and it will not see any
         # IPs of other networks' users.
@@ -400,6 +396,16 @@ relay:
     # Defaults to False.
     show_netsplits: false
 
+    # Sets the default Relay separator. Defaults to / if not specified. The "separator"
+    # option in server blocks override this if specified.
+    separator: "/"
+
+    # Determines whether all nicks will be tagged by default, instead of only when a
+    # nick collision happens. It is HIGHLY RECOMMENDED you enable this, unless you're
+    # absolutely sure NO ONE will be using the same nick on 2 or more networks in your
+    # relay. Leaving this off will make their lives very miserable. You have been warned!
+    tag_nicks: true
+
 games:
     # Sets the nick of the Games service, if you're using it.
     nick: Games
diff --git a/plugins/relay.py b/plugins/relay.py
index 88e07f3..e48e3ac 100644
--- a/plugins/relay.py
+++ b/plugins/relay.py
@@ -92,10 +92,23 @@ def die(sourceirc):
 
 allowed_chars = string.digits + string.ascii_letters + '/^|\\-_[]`'
 fallback_separator = '|'
-def normalizeNick(irc, netname, nick, separator=None, uid=''):
-    """Creates a normalized nickname for the given nick suitable for
-    introduction to a remote network (as a relay client)."""
-    separator = separator or irc.serverdata.get('separator') or "/"
+def normalizeNick(irc, netname, nick, times_tagged=0, uid=''):
+    """
+    Creates a normalized nickname for the given nick suitable for introduction to a remote network
+    (as a relay client).
+
+    UID is optional for checking regular nick changes, to make sure that the sender doesn't get
+    marked as nick-colliding with itself.
+    """
+
+    # Get the nick/net separator
+    separator = irc.serverdata.get('separator') or \
+        conf.conf.get('relay', {}).get('separator') or "/"
+
+    # Figure out whether we tag nicks by default or not.
+    if times_tagged == 0 and conf.conf.get('relay', {}).get('tag_nicks'):
+        times_tagged = 1
+
     log.debug('(%s) relay.normalizeNick: using %r as separator.', irc.name, separator)
     orig_nick = nick
     protoname = irc.protoname
@@ -118,15 +131,21 @@ def normalizeNick(irc, netname, nick, separator=None, uid=''):
         # Nicks starting with - are likewise not valid.
         nick = '_' + nick
 
-    suffix = separator + netname
-    nick = nick[:maxnicklen]
-    # Maximum allowed length of a nickname, minus the obligatory /network tag.
-    allowedlength = maxnicklen - len(suffix)
+    # Maximum allowed length that relay nicks may have, minus the /network tag if used.
+    allowedlength = maxnicklen
+
+    # Track how many times the given nick has been tagged. If this is 0, no tag is used.
+    # If this is 1, a /network tag is added. Otherwise, keep adding one character to the
+    # separator: GLolol -> GLolol/net1 -> GLolol//net1 -> ...
+    if times_tagged >= 1:
+        suffix = "%s%s%s" % (separator[0]*times_tagged, separator[1:], netname)
+        allowedlength -= len(suffix)
 
     # If a nick is too long, the real nick portion will be cut off, but the
     # /network suffix MUST remain the same.
     nick = nick[:allowedlength]
-    nick += suffix
+    if times_tagged >= 1:
+        nick += suffix
 
     # Loop over every character in the nick, making sure that it only contains valid
     # characters.
@@ -146,9 +165,10 @@ def normalizeNick(irc, netname, nick, separator=None, uid=''):
     # even though there would be no collision because the old and new nicks are from
     # the same client.
     while irc.nickToUid(nick) and irc.nickToUid(nick) != uid:
-        new_sep = separator + separator[-1]
-        log.debug('(%s) relay.normalizeNick: nick %r is in use; using %r as new_sep.', irc.name, nick, new_sep)
-        nick = normalizeNick(irc, netname, orig_nick, separator=new_sep)
+        times_tagged += 1
+        log.debug('(%s) relay.normalizeNick: nick %r is in use; incrementing times tagged to %s.',
+                  irc.name, nick, times_tagged)
+        nick = normalizeNick(irc, netname, orig_nick, times_tagged=times_tagged, uid=uid)
 
     finalLength = len(nick)
     assert finalLength <= maxnicklen, "Normalized nick %r went over max " \