Merge pull request CloudBotIRC#182 from linuxdaemon/gonzobot+nick-validity

Move nick validity checks out of various plugins and in to the core

Author: edwardslabs

cloudbot/client.py

@@ -122,6 +122,14 @@ def part(self, channel):
         """
         raise NotImplementedError
 
+    def is_nick_valid(self, nick):
+        """
+        Determines if a nick is valid for this connection
+        :param nick: The nick to check
+        :return: True if it is valid, otherwise false
+        """
+        raise NotImplementedError
+
     @property
     def connected(self):
         raise NotImplementedError

cloudbot/clients/irc.py

@@ -16,6 +16,8 @@
 irc_netmask_re = re.compile(r"([^!@]*)!([^@]*)@(.*)")
 irc_param_re = re.compile(r"(?:^|(?<= ))(:.*|[^ ]+)")
 
+irc_nick_re = re.compile(r'[A-Za-z0-9^{\}\[\]\-`_|\\]')
+
 irc_bad_chars = ''.join([chr(x) for x in list(range(0, 1)) + list(range(4, 32)) + list(range(127, 160))])
 irc_clean_re = re.compile('[{}]'.format(re.escape(irc_bad_chars)))
 
@@ -225,6 +227,9 @@ def _send(self, line):
     def connected(self):
         return self._connected
 
+    def is_nick_valid(self, nick):
+        return bool(irc_nick_re.fullmatch(nick))
+
 
 class _IrcProtocol(asyncio.Protocol):
     """

cloudbot/event.py

@@ -324,6 +324,14 @@ def async_call(self, func, *args, **kwargs):
         result = yield from self.loop.run_in_executor(executor, part)
         return result
 
+    def is_nick_valid(self, nick):
+        """
+        Returns whether a nick is valid for a given connection
+        :param nick: The nick to check
+        :return: Whether or not it is valid
+        """
+        return self.conn.is_nick_valid(nick)
+
     if sys.version_info < (3, 7, 0):
         # noinspection PyCompatibility
         @asyncio.coroutine

plugins/admin_bot.py

@@ -298,14 +298,15 @@ def cycle(text, conn, chan, notice):
 
 @asyncio.coroutine
 @hook.command(permissions=["botcontrol"])
-def nick(text, conn, notice):
+def nick(text, conn, notice, is_nick_valid):
     """<nick> - changes my nickname to <nick>
     :type text: str
     :type conn: cloudbot.client.Client
     """
-    if not re.match("^[a-z0-9_|.-\]\[]*$", text.lower()):
+    if not is_nick_valid(text):
         notice("Invalid username '{}'".format(text))
         return
+
     notice("Attempting to change nick to '{}'...".format(text))
     conn.set_nick(text)
 

plugins/attacks.py

@@ -1,23 +1,13 @@
+import asyncio
 import codecs
 import json
 import os
 import random
-import asyncio
 import re
 
 from cloudbot import hook
 from cloudbot.util import textgen
 
-nick_re = re.compile("^[A-Za-z0-9_|.\-\]\[\{\}]*$", re.I)
-
-
-def is_valid(target):
-    """ Checks if a string is a valid IRC nick. """
-    if nick_re.match(target):
-        return True
-    else:
-        return False
-
 
 def is_self(conn, target):
     """ Checks if a string is "****self" or contains conn.name. """
@@ -64,11 +54,11 @@ def load_attacks(bot):
 
 @asyncio.coroutine
 @hook.command
-def lart(text, conn, nick, action):
+def lart(text, conn, nick, action, is_nick_valid):
     """<user> - LARTs <user>"""
     target = text.strip()
 
-    if not is_valid(target):
+    if not is_nick_valid(target):
         return "I can't lart that."
 
     if is_self(conn, target):
@@ -83,11 +73,11 @@ def lart(text, conn, nick, action):
 
 @asyncio.coroutine
 @hook.command("flirt", "sexup", "jackmeoff")
-def flirt(text, conn, nick, message):
+def flirt(text, conn, nick, message, is_nick_valid):
     """<user> - flirts with <user>"""
     target = text.strip()
 
-    if not is_valid(target):
+    if not is_nick_valid(target):
         return "I can't flirt with that."
 
     if is_self(conn, target):
@@ -99,11 +89,11 @@ def flirt(text, conn, nick, message):
 
 @asyncio.coroutine
 @hook.command("kill", "end")
-def kill(text, conn, nick, action):
+def kill(text, conn, nick, action, is_nick_valid):
     """<user> - kills <user>"""
     target = text.strip()
 
-    if not is_valid(target):
+    if not is_nick_valid(target):
         return "I can't attack that."
 
     if is_self(conn, target):
@@ -118,11 +108,11 @@ def kill(text, conn, nick, action):
 
 @asyncio.coroutine
 @hook.command
-def slap(text, action, nick, conn):
+def slap(text, action, nick, conn, is_nick_valid):
     """<user> -- Makes the bot slap <user>."""
     target = text.strip()
 
-    if not is_valid(target):
+    if not is_nick_valid(target):
         return "I can't slap that."
 
     if is_self(conn, target):
@@ -140,11 +130,11 @@ def slap(text, action, nick, conn):
 
 @asyncio.coroutine
 @hook.command
-def compliment(text, action, nick, conn):
+def compliment(text, action, nick, conn, is_nick_valid):
     """<user> -- Makes the bot compliment <user>."""
     target = text.strip()
 
-    if not is_valid(target):
+    if not is_nick_valid(target):
         return "I can't compliment that."
 
     if is_self(conn, target):
@@ -159,20 +149,21 @@ def compliment(text, action, nick, conn):
     # act out the message
     action(generator.generate_string())
 
+
 @hook.command(autohelp=False)
-def strax(text, conn, message, nick):
+def strax(text, conn, message, nick, is_nick_valid):
     """Strax quote."""
 
     if text:
         target = text.strip()
-        if not is_valid(target):
-           return "I can't do that."
+        if not is_nick_valid(target):
+            return "I can't do that."
 
         if is_self(conn, target):
-           # user is trying to make the bot attack itself!
-           target = nick
+            # user is trying to make the bot attack itself!
+            target = nick
         variables = {
-           "user": target
+            "user": target
         }
 
         generator = textgen.TextGenerator(strax["target_template"], strax["parts"], variables=variables)
@@ -182,24 +173,26 @@ def strax(text, conn, message, nick):
     # Become Strax
     message(generator.generate_string())
 
+
 @hook.command(autohelp=False)
 def nk(chan, message):
     """outputs a random North Korea propoganda slogan"""
-    index = random.randint(0,len(north_korea)-1)
+    index = random.randint(0, len(north_korea) - 1)
     slogan = north_korea[index]
     message(slogan, chan)
 
+
 @asyncio.coroutine
 @hook.command()
-def insult(text, conn, nick, notice, message):
+def insult(text, conn, nick, notice, message, is_nick_valid):
     """<user> - insults <user>
     :type text: str
     :type conn: cloudbot.client.Client
     :type nick: str
     """
     target = text.strip()
 
-    if " " in target:
+    if not is_nick_valid(target):
         notice("Invalid username!")
         return
 
@@ -209,20 +202,22 @@ def insult(text, conn, nick, notice, message):
 
     message("{}, {}".format(target, random.choice(insults)))
 
+
 @asyncio.coroutine
 @hook.command("present", "gift")
-def present(text, conn, nick, action):
+def present(text, conn, nick, action, is_nick_valid):
     """<user> - gives gift to <user>"""
     target = text.strip()
 
-    if not is_valid(target):
+    if not is_nick_valid(target):
         return "I can't gift that."
 
     if is_self(conn, target):
-        #user is trying to make the bot gift itself!
+        # user is trying to make the bot gift itself!
         target = nick
+
     variables = {
-       "user": target
+        "user": target
     }
 
     generator = textgen.TextGenerator(presents["templates"], presents["parts"], variables=variables)

plugins/foods.py

@@ -51,14 +51,6 @@
 basic_food_data = defaultdict(dict)
 
 
-def is_valid(target):
-    """ Checks if a string is a valid IRC nick. """
-    if nick_re.match(target):
-        return True
-    else:
-        return False
-
-
 def load_template_data(bot, filename, data_dict):
     data_dict.clear()
     food_dir = os.path.join(bot.data_dir, "food")
@@ -95,8 +87,8 @@ def make_cmd_list(value):
 
 
 def basic_food(food):
-    def func(text, action):
-        if not is_valid(text):
+    def func(text, action, is_nick_valid):
+        if not is_nick_valid(text):
             return "I can't give {} to that user.".format(food.unitname)
 
         action(basic_format(text, basic_food_data[food.name]))

plugins/jokes.py

@@ -100,12 +100,11 @@ def boobies(text):
 
 
 @hook.command("awesome", "iscool", "cool")
-def awesome(text):
+def awesome(text, is_nick_valid):
     """- Prints a webpage to show <nick> how awesome they are."""
-    nick_re = re.compile("^[A-Za-z0-9_|.\-\]\[]*$", re.I)
     link = 'http://is-awesome.cool/{}'
     nick = text.split(' ')[0]
-    if nick_re.match(nick):
+    if is_nick_valid(nick):
         return "{}: I am blown away by your recent awesome action(s). Please read \x02{}\x02".format(
             nick, link.format(nick)
         )