Merge branch 'gonzobot' into gonzobot+fix-badwords

Author: linuxdaemon

.travis.yml

@@ -11,7 +11,6 @@ install:
   - "pip install -r ./travis/requirements.txt"
 
 script:
-  - "python ./travis/test_json.py"
   - "git diff --diff-filter=d --name-only ${TRAVIS_COMMIT_RANGE} | grep -i '\\.py$' | xargs -r pylint --rcfile=travis/pylintrc"
   - "py.test . -v --cov . --cov-report term-missing"
 

CONTRIBUTING.md

@@ -22,12 +22,12 @@ The following guidelines for contribution should be followed if you want to subm
 
 * You need a [GitHub account](https://github.com/signup/free)
 * Submit an [issue ticket](https://github.com/ClouDev/CloudBot/issues) for your issue if there is no one yet.
-  * Try to describe the issue and include steps to reproduce if it's a bug.
+    * Try to describe the issue and include steps to reproduce if it's a bug.
 * If you are able and want to fix this, fork the repository on GitHub
 
 ## Make Changes
 
-* In your forked repository, create a topic branch for your upcoming patch. (optional) 
+* In your forked repository, create a topic branch for your upcoming patch. (optional)
 * Make sure you stick to the coding style that is used already.
 * Make use of the [`.editorconfig`](http://editorconfig.org/) file.
 * Make commits that make sense and describe them properly.
@@ -38,7 +38,7 @@ The following guidelines for contribution should be followed if you want to subm
 
 * Push your changes to a topic branch in your fork of the repository.
 * Open a pull request to the original repository and choose the `python3.4` branch.
-	_Advanced users may use [`hub`](https://github.com/defunkt/hub#git-pull-request) gem for that._
+    _Advanced users may use [`hub`](https://github.com/defunkt/hub#git-pull-request) gem for that._
 * If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But _please do not close the issue yourself_.
 _Notice: You can [turn your previously filed issues into a pull-request here](http://issue2pr.herokuapp.com/)._
 

cloudbot/__init__.py

@@ -12,7 +12,8 @@
 
 __version__ = "1.0.9"
 
-__all__ = ["clients", "util", "bot", "client", "config", "event", "hook", "permissions", "plugin", "reloader", "logging_dir"]
+__all__ = ["clients", "util", "bot", "client", "config", "event", "hook", "permissions", "plugin", "reloader",
+           "logging_dir"]
 
 
 def _setup():
@@ -23,6 +24,8 @@ def _setup():
     else:
         logging_config = {}
 
+    file_log = logging_config.get("file_log", False)
+
     global logging_dir
     logging_dir = os.path.join(os.path.abspath(os.path.curdir), "logs")
 
@@ -49,25 +52,29 @@ def _setup():
                 "formatter": "brief",
                 "level": "INFO",
                 "stream": "ext://sys.stdout"
-            },
-            "file": {
-                "class": "logging.handlers.RotatingFileHandler",
-                "maxBytes": 1000000,
-                "backupCount": 5,
-                "formatter": "full",
-                "level": "INFO",
-                "encoding": "utf-8",
-                "filename": os.path.join(logging_dir, "bot.log")
             }
         },
         "loggers": {
             "cloudbot": {
                 "level": "DEBUG",
-                "handlers": ["console", "file"]
+                "handlers": ["console"]
             }
         }
     }
 
+    if file_log:
+        dict_config["handlers"]["file"] = {
+            "class": "logging.handlers.RotatingFileHandler",
+            "maxBytes": 1000000,
+            "backupCount": 5,
+            "formatter": "full",
+            "level": "INFO",
+            "encoding": "utf-8",
+            "filename": os.path.join(logging_dir, "bot.log")
+        }
+
+        dict_config["loggers"]["cloudbot"]["handlers"].append("file")
+
     if logging_config.get("console_debug", False):
         dict_config["handlers"]["console"]["level"] = "DEBUG"
         dict_config["loggers"]["asyncio"] = {
@@ -89,4 +96,5 @@ def _setup():
 
     logging.config.dictConfig(dict_config)
 
+
 _setup()

cloudbot/__main__.py

@@ -41,6 +41,7 @@ def main():
     # define closure for signal handling
     # The handler is called with two arguments: the signal number and the current stack frame
     # These parameters should NOT be removed
+    # noinspection PyUnusedLocal
     def exit_gracefully(signum, frame):
         nonlocal stopped_while_restarting
         if not _bot:

cloudbot/bot.py

@@ -13,7 +13,7 @@
 from sqlalchemy.schema import MetaData
 from watchdog.observers import Observer
 
-from cloudbot.client import Client
+from cloudbot.client import Client, CLIENTS
 from cloudbot.clients.irc import IrcClient, irc_clean
 from cloudbot.config import Config
 from cloudbot.event import Event, CommandEvent, RegexEvent, EventType
@@ -27,6 +27,7 @@
 
     web_installed = True
 except ImportError:
+    WebInterface = None
     web_installed = False
 
 logger = logging.getLogger("cloudbot")
@@ -44,7 +45,7 @@ class CloudBot:
     """
     :type start_time: float
     :type running: bool
-    :type connections: list[Client | IrcClient]
+    :type connections: dict[str, Client]
     :type data_dir: bytes
     :type config: core.config.Config
     :type plugin_manager: PluginManager
@@ -150,15 +151,9 @@ def create_connections(self):
             # strip all spaces and capitalization from the connection name
             name = clean_name(config['name'])
             nick = config['nick']
-            server = config['connection']['server']
-            port = config['connection'].get('port', 6667)
-            local_bind = (config['connection'].get('bind_addr', False), config['connection'].get('bind_port', 0))
-            if local_bind[0] is False:
-                local_bind = False
-
-            self.connections[name] = IrcClient(self, name, nick, config=config, channels=config['channels'],
-                                               server=server, port=port, use_ssl=config['connection'].get('ssl', False),
-                                               local_bind=local_bind)
+            _type = config.get("type", "irc")
+
+            self.connections[name] = CLIENTS[_type](self, name, nick, config=config, channels=config['channels'])
             logger.debug("[{}] Created connection.".format(name))
 
     @asyncio.coroutine
@@ -245,6 +240,9 @@ def add_hook(hook, _event, _run_before=False):
             if halted:
                 return False
 
+            if hook.clients and _event.conn.type not in hook.clients:
+                return True
+
             coro = self.plugin_manager.launch(hook, _event)
             if _run_before:
                 run_before_tasks.append(coro)

cloudbot/client.py

@@ -7,6 +7,17 @@
 
 logger = logging.getLogger("cloudbot")
 
+CLIENTS = {}
+
+
+def client(_type):
+    def _decorate(cls):
+        CLIENTS[_type] = cls
+        cls._type = _type
+        return cls
+
+    return lambda cls: _decorate(cls)
+
 
 class Client:
     """
@@ -22,6 +33,8 @@ class Client:
     :type permissions: PermissionManager
     """
 
+    _type = None
+
     def __init__(self, bot, name, nick, *, channels=None, config=None):
         """
         :type bot: cloudbot.bot.CloudBot
@@ -155,3 +168,7 @@ def is_nick_valid(self, nick):
     @property
     def connected(self):
         raise NotImplementedError
+
+    @property
+    def type(self):
+        return self._type

cloudbot/clients/irc.py

@@ -7,18 +7,13 @@
 from functools import partial
 from ssl import SSLContext
 
-from cloudbot.client import Client
+from cloudbot.client import Client, client
 from cloudbot.event import Event, EventType, IrcOutEvent
 from cloudbot.util import async_util
 from cloudbot.util.parsers.irc import Message
 
 logger = logging.getLogger("cloudbot")
 
-irc_prefix_re = re.compile(r":([^ ]*) ([^ ]*) (.*)")
-irc_noprefix_re = re.compile(r"([^ ]*) (.*)")
-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))])
@@ -50,6 +45,7 @@ def decode(bytestring):
     return bytestring.decode('utf-8', errors='ignore')
 
 
+@client("irc")
 class IrcClient(Client):
     """
     An implementation of Client for IRC.
@@ -60,27 +56,26 @@ class IrcClient(Client):
     :type _ignore_cert_errors: bool
     """
 
-    def __init__(self, bot, name, nick, *, channels=None, config=None,
-                 server, port=6667, use_ssl=False, ignore_cert_errors=True, timeout=300, local_bind=False):
+    def __init__(self, bot, name, nick, *, channels=None, config=None):
         """
         :type bot: cloudbot.bot.CloudBot
         :type name: str
         :type nick: str
         :type channels: list[str]
         :type config: dict[str, unknown]
-        :type server: str
-        :type port: int
-        :type use_ssl: bool
-        :type ignore_cert_errors: bool
-        :type timeout: int
         """
         super().__init__(bot, name, nick, channels=channels, config=config)
 
-        self.use_ssl = use_ssl
-        self._ignore_cert_errors = ignore_cert_errors
-        self._timeout = timeout
-        self.server = server
-        self.port = port
+        self.use_ssl = config['connection'].get('ssl', False)
+        self._ignore_cert_errors = config['connection']['ignore_cert']
+        self._timeout = config['connection'].get('timeout', 300)
+        self.server = config['connection']['server']
+        self.port = config['connection'].get('port', 6667)
+
+        local_bind = (config['connection'].get('bind_addr', False), config['connection'].get('bind_port', 0))
+        if local_bind[0] is False:
+            local_bind = False
+
         self.local_bind = local_bind
         # create SSL context
         if self.use_ssl:
@@ -109,16 +104,15 @@ def describe_server(self):
 
     @asyncio.coroutine
     def try_connect(self):
-        timeout = self.config["connection"].get("timeout", 30)
         while True:
             try:
-                yield from self.connect(timeout)
+                yield from self.connect(self._timeout)
             except (asyncio.TimeoutError, OSError):
                 logger.exception("[%s] Error occurred while connecting", self.name)
             else:
                 break
 
-            yield from asyncio.sleep(random.randrange(timeout))
+            yield from asyncio.sleep(random.randrange(self._timeout))
 
     @asyncio.coroutine
     def connect(self, timeout=None):
@@ -153,6 +147,7 @@ def connect(self, timeout=None):
         tasks = [
             self.bot.plugin_manager.launch(hook, Event(bot=self.bot, conn=self, hook=hook))
             for hook in self.bot.plugin_manager.connect_hooks
+            if not hook.clients or self.type in hook.clients
         ]
         # TODO stop connecting if a connect hook fails?
         yield from asyncio.gather(*tasks)
@@ -177,7 +172,6 @@ def close(self):
 
     def message(self, target, *messages):
         for text in messages:
-            text = "".join(text.splitlines())
             self.cmd("PRIVMSG", target, text)
 
     def admin_log(self, text, console=True):
@@ -189,11 +183,9 @@ def admin_log(self, text, console=True):
             logger.info("[%s|admin] %s", self.name, text)
 
     def action(self, target, text):
-        text = "".join(text.splitlines())
         self.ctcp(target, "ACTION", text)
 
     def notice(self, target, text):
-        text = "".join(text.splitlines())
         self.cmd("NOTICE", target, text)
 
     def set_nick(self, nick):
@@ -239,22 +231,23 @@ def cmd(self, command, *params):
         else:
             self.send(command)
 
-    def send(self, line):
+    def send(self, line, log=True):
         """
         Sends a raw IRC line
         :type line: str
+        :type log: bool
         """
         if not self._connected:
             raise ValueError("Client must be connected to irc server to use send")
-        self.loop.call_soon_threadsafe(self._send, line)
+        self.loop.call_soon_threadsafe(self._send, line, log)
 
-    def _send(self, line):
+    def _send(self, line, log=True):
         """
         Sends a raw IRC line unchecked. Doesn't do connected check, and is *not* threadsafe
         :type line: str
+        :type log: bool
         """
-        logger.info("[{}] >> {}".format(self.name, line))
-        async_util.wrap_future(self._protocol.send(line), loop=self.loop)
+        async_util.wrap_future(self._protocol.send(line, log=log), loop=self.loop)
 
     @property
     def connected(self):
@@ -321,7 +314,7 @@ def eof_received(self):
         return True
 
     @asyncio.coroutine
-    def send(self, line):
+    def send(self, line, log=True):
         # make sure we are connected before sending
         if not self._connected:
             yield from self._connected_future
@@ -357,6 +350,9 @@ def send(self, line):
             # the line must be encoded before we send it, one of the sieves didn't encode it, fall back to the default
             line = line.encode("utf-8", "replace")
 
+        if log:
+            logger.info("[{}|out] >> {!r}".format(self.conn.name, line))
+
         self._transport.write(line)
 
     def data_received(self, data):
@@ -381,7 +377,7 @@ def data_received(self, data):
             # Reply to pings immediately
 
             if command == "PING":
-                async_util.wrap_future(self.send("PONG " + command_params[-1]), loop=self.loop)
+                self.conn.send("PONG " + command_params[-1], log=False)
 
             # Parse the command and params
 

cloudbot/hook.py

@@ -318,7 +318,7 @@ def sieve(param=None, **kwargs):
     """
 
     def _sieve_hook(func):
-        assert len(inspect.getfullargspec(func).args) == 3, \
+        assert len(inspect.signature(func).parameters) == 3, \
             "Sieve plugin has incorrect argument count. Needs params: bot, input, plugin"
 
         hook = _get_hook(func, "sieve")

cloudbot/permissions.py

@@ -1,5 +1,5 @@
-from fnmatch import fnmatch
 import logging
+from fnmatch import fnmatch
 
 logger = logging.getLogger("cloudbot")
 

cloudbot/plugin.py

@@ -730,6 +730,13 @@ def __init__(self, _type, plugin, func_hook):
         self.action = func_hook.kwargs.pop("action", Action.CONTINUE)
         self.priority = func_hook.kwargs.pop("priority", Priority.NORMAL)
 
+        clients = func_hook.kwargs.pop("clients", [])
+
+        if isinstance(clients, str):
+            clients = [clients]
+
+        self.clients = clients
+
         if func_hook.kwargs:
             # we should have popped all the args, so warn if there are any left
             logger.warning("Ignoring extra args {} from {}".format(func_hook.kwargs, self.description))