Merge branch 'gonzobot' into gonzobot+fix-readme

Author: linuxdaemon

.travis.yml

@@ -12,7 +12,7 @@ install:
 
 script:
   - "python ./travis/test_json.py"
-  - "git diff --diff-filter=d --name-only ${TRAVIS_COMMIT_RANGE} | xargs pylint --rcfile=travis/pylintrc"
+  - "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"
 
 after_success:

cloudbot/__init__.py

@@ -12,7 +12,7 @@
 
 __version__ = "1.0.9"
 
-__all__ = ["util", "bot", "connection", "config", "permissions", "plugin", "event", "hook", "log_dir"]
+__all__ = ["clients", "util", "bot", "client", "config", "event", "hook", "permissions", "plugin", "reloader", "logging_dir"]
 
 
 def _setup():

cloudbot/bot.py

@@ -221,7 +221,7 @@ def _init_routine(self):
         self.observer.start()
 
         # Connect to servers
-        yield from asyncio.gather(*[conn.connect() for conn in self.connections.values()], loop=self.loop)
+        yield from asyncio.gather(*[conn.try_connect() for conn in self.connections.values()], loop=self.loop)
 
         # Activate web interface.
         if self.config.get("web", {}).get("enabled", False) and web_installed:

cloudbot/client.py

@@ -1,6 +1,7 @@
 import asyncio
 import collections
 import logging
+import random
 
 from cloudbot.permissions import PermissionManager
 
@@ -59,7 +60,20 @@ def describe_server(self):
         raise NotImplementedError
 
     @asyncio.coroutine
-    def connect(self):
+    def try_connect(self):
+        timeout = 30
+        while True:
+            try:
+                yield from self.connect(timeout)
+            except Exception:
+                logger.exception("[%s] Error occurred while connecting.")
+            else:
+                break
+
+            yield from asyncio.sleep(random.randrange(timeout))
+
+    @asyncio.coroutine
+    def connect(self, timeout=None):
         """
         Connects to the server, or reconnects if already connected.
         """

cloudbot/clients/irc.py

@@ -1,5 +1,6 @@
 import asyncio
 import logging
+import random
 import re
 import ssl
 from _ssl import PROTOCOL_SSLv23
@@ -106,7 +107,20 @@ def describe_server(self):
             return "{}:{}".format(self.server, self.port)
 
     @asyncio.coroutine
-    def connect(self):
+    def try_connect(self):
+        timeout = self.config["connection"].get("timeout", 30)
+        while True:
+            try:
+                yield from self.connect(timeout)
+            except (asyncio.TimeoutError, OSError):
+                logger.exception("[%s] Error occurred while connecting", self.name)
+            else:
+                break
+
+            yield from asyncio.sleep(random.randrange(timeout))
+
+    @asyncio.coroutine
+    def connect(self, timeout=None):
         """
         Connects to the IRC server, or reconnects if already connected.
         """
@@ -125,8 +139,15 @@ def connect(self):
         optional_params = {}
         if self.local_bind:
             optional_params["local_addr"] = self.local_bind
-        self._transport, self._protocol = yield from self.loop.create_connection(
-            lambda: _IrcProtocol(self), host=self.server, port=self.port, ssl=self.ssl_context, **optional_params)
+
+        coro = self.loop.create_connection(
+            lambda: _IrcProtocol(self), host=self.server, port=self.port, ssl=self.ssl_context, **optional_params
+        )
+
+        if timeout is not None:
+            coro = asyncio.wait_for(coro, timeout)
+
+        self._transport, self._protocol = yield from coro
 
         tasks = [
             self.bot.plugin_manager.launch(hook, Event(bot=self.bot, conn=self, hook=hook))

cloudbot/config.py

@@ -3,11 +3,12 @@
 import os
 import sys
 import time
+from collections import OrderedDict
 
 logger = logging.getLogger("cloudbot")
 
 
-class Config(dict):
+class Config(OrderedDict):
     """
     :type filename: str
     :type path: str
@@ -41,8 +42,10 @@ def load_config(self):
             sys.exit()
 
         with open(self.path) as f:
-            self.update(json.load(f))
-            logger.debug("Config loaded from file.")
+            data = json.load(f, object_pairs_hook=OrderedDict)
+
+        self.update(data)
+        logger.debug("Config loaded from file.")
 
         # reload permissions
         if self.bot.connections:
@@ -51,5 +54,7 @@ def load_config(self):
 
     def save_config(self):
         """saves the contents of the config dict to the config file"""
-        json.dump(self, open(self.path, 'w'), sort_keys=True, indent=4)
+        with open(self.path, 'w') as f:
+            json.dump(self, f, indent=4)
+
         logger.info("Config saved to file.")

cloudbot/util/formatting.py

@@ -44,7 +44,7 @@
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 """
-
+import copy
 import re
 import html.entities
 
@@ -318,3 +318,20 @@ def get_text_list(list_, last_word='or'):
         # Translators: This string is used as a separator between list elements
         ', '.join([i for i in list_][:-1]),
         last_word, list_[-1])
+
+
+def gen_markdown_table(headers, rows):
+    """
+    Generates a Markdown formatted table from the data
+    """
+    rows = copy.copy(rows)
+    rows.insert(0, headers)
+    rotated = zip(*reversed(rows))
+
+    sizes = tuple(map(lambda l: max(max(map(len, l)), 3), rotated))
+    rows.insert(1, tuple(('-' * size) for size in sizes))
+    lines = [
+        "| {} |".format(' | '.join(cell.ljust(sizes[i]) for i, cell in enumerate(row)))
+        for row in rows
+    ]
+    return '\n'.join(lines)

plugins/admin_channel.py

@@ -1,95 +1,126 @@
 from cloudbot import hook
 
 
+def check_for_chan_mode(char, conn):
+    serv_info = conn.memory["server_info"]
+    modes = serv_info.get("channel_modes", "")
+    return bool(char in modes)
+
+
 def mode_cmd(mode, text, text_inp, chan, conn, notice, nick, admin_log):
     """ generic mode setting function """
+    if not check_for_chan_mode(mode[1], conn):
+        return False
+
     split = text_inp.split(" ")
     if split[0].startswith("#"):
         channel = split[0]
         target = split[1]
-        notice("Attempting to {} {} in {}...".format(text, target, channel))
-        admin_log("{} used {} to set {} on {} in {}.".format(nick, text, mode, target, channel))
-        conn.send("MODE {} {} {}".format(channel, mode, target))
     else:
         channel = chan
         target = split[0]
-        notice("Attempting to {} {} in {}...".format(text, target, channel))
-        admin_log("{} used {} to set {} on {} in {}.".format(nick, text, mode, target, channel))
-        conn.send("MODE {} {} {}".format(channel, mode, target))
+
+    notice("Attempting to {} {} in {}...".format(text, target, channel))
+    admin_log("{} used {} to set {} on {} in {}.".format(nick, text, mode, target, channel))
+    conn.send("MODE {} {} {}".format(channel, mode, target))
+
+    return True
 
 
 def mode_cmd_no_target(mode, text, text_inp, chan, conn, notice, nick, admin_log):
     """ generic mode setting function without a target"""
+    if not check_for_chan_mode(mode[1], conn):
+        return False
+
     split = text_inp.split(" ")
     if split[0].startswith("#"):
         channel = split[0]
-        notice("Attempting to {} {}...".format(text, channel))
-        admin_log("{} used {} to set {} in {}.".format(nick, text, mode, channel))
-        conn.send("MODE {} {}".format(channel, mode))
     else:
         channel = chan
-        notice("Attempting to {} {}...".format(text, channel))
-        admin_log("{} used {} to set {} in {}.".format(nick, text, mode, channel))
-        conn.send("MODE {} {}".format(channel, mode))
 
+    notice("Attempting to {} {}...".format(text, channel))
+    admin_log("{} used {} to set {} in {}.".format(nick, text, mode, channel))
+    conn.send("MODE {} {}".format(channel, mode))
+    return True
 
-@hook.command(permissions=["op_ban", "op"])
+
+def do_extban(char, text, text_inp, chan, conn, notice, nick, admin_log, adding=True):
+    serv_info = conn.memory["server_info"]
+    if char not in serv_info.get("extbans", ""):
+        return False
+
+    extban_pfx = serv_info["extban_prefix"]
+
+    split = text_inp.split(" ")
+    if split[0].startswith("#"):
+        channel = split[0]
+        target = split[1]
+        text_inp = "{} {}{}:{}".format(channel, extban_pfx, char, target)
+    else:
+        target = split[0]
+        text_inp = "{}{}:{}".format(extban_pfx, char, target)
+
+    mode_cmd("+b" if adding else "-b", text, text_inp, chan, conn, notice, nick, admin_log)
+    return True
+
+
+@hook.command(permissions=["op_ban", "op", "chanop"])
 def ban(text, conn, chan, notice, nick, admin_log):
     """[channel] <user> - bans <user> in [channel], or in the caller's channel if no channel is specified"""
     mode_cmd("+b", "ban", text, chan, conn, notice, nick, admin_log)
 
 
-@hook.command(permissions=["op_ban", "op"])
+@hook.command(permissions=["op_ban", "op", "chanop"])
 def unban(text, conn, chan, notice, nick, admin_log):
     """[channel] <user> - unbans <user> in [channel], or in the caller's channel if no channel is specified"""
     mode_cmd("-b", "unban", text, chan, conn, notice, nick, admin_log)
 
 
-@hook.command(permissions=["op_quiet", "op"])
+@hook.command(permissions=["op_quiet", "op", "chanop"])
 def quiet(text, conn, chan, notice, nick, admin_log):
     """[channel] <user> - quiets <user> in [channel], or in the caller's channel if no channel is specified"""
-    if conn.name == "snoonet":
-        out = "mode {} +b m:{}".format(chan, text)
-        conn.send(out)
+    if mode_cmd("+q", "quiet", text, chan, conn, notice, nick, admin_log):
         return
-    mode_cmd("+q", "quiet", text, chan, conn, notice, nick, admin_log)
+
+    if not do_extban('m', "quiet", text, chan, conn, notice, nick, admin_log, True):
+        notice("Unable to set +q or a mute extban on this network.")
 
 
-@hook.command(permissions=["op_quiet", "op"])
+@hook.command(permissions=["op_quiet", "op", "chanop"])
 def unquiet(text, conn, chan, notice, nick, admin_log):
     """[channel] <user> - unquiets <user> in [channel], or in the caller's channel if no channel is specified"""
-    if conn.name == "snoonet":
-        out = "mode {} -b m:{}".format(chan, text)
-        conn.send(out)
+    if mode_cmd("-q", "unquiet", text, chan, conn, notice, nick, admin_log):
         return
-    mode_cmd("-q", "unquiet", text, chan, conn, notice, nick, admin_log)
 
+    if not do_extban('m', "unquiet", text, chan, conn, notice, nick, admin_log, False):
+        notice("Unable to unset +q or a mute extban on this network.")
 
-@hook.command(permissions=["op_voice", "op"])
+
+@hook.command(permissions=["op_voice", "op", "chanop"])
 def voice(text, conn, chan, notice, nick, admin_log):
     """[channel] <user> - voices <user> in [channel], or in the caller's channel if no channel is specified"""
     mode_cmd("+v", "voice", text, chan, conn, notice, nick, admin_log)
 
 
-@hook.command(permissions=["op_voice", "op"])
+@hook.command(permissions=["op_voice", "op", "chanop"])
 def devoice(text, conn, chan, notice, nick, admin_log):
     """[channel] <user> - devoices <user> in [channel], or in the caller's channel if no channel is specified"""
     mode_cmd("-v", "devoice", text, chan, conn, notice, nick, admin_log)
 
 
-@hook.command(permissions=["op_op", "op"])
+@hook.command(permissions=["op_op", "op", "chanop"])
 def op(text, conn, chan, notice, nick, admin_log):
     """[channel] <user> - ops <user> in [channel], or in the caller's channel if no channel is specified"""
     mode_cmd("+o", "op", text, chan, conn, notice, nick, admin_log)
 
 
-@hook.command(permissions=["op_op", "op"])
+@hook.command(permissions=["op_op", "op", "chanop"])
 def deop(text, conn, chan, notice, nick, admin_log):
     """[channel] <user> - deops <user> in [channel], or in the caller's channel if no channel is specified"""
     mode_cmd("-o", "deop", text, chan, conn, notice, nick, admin_log)
 
 
-@hook.command(permissions=["op_topic", "op"])
+@hook.command(permissions=["op_topic", "op", "chanop"])
 def topic(text, conn, chan, nick, admin_log):
     """[channel] <topic> - changes the topic to <topic> in [channel], or in the caller's channel
      if no channel is specified"""
@@ -104,7 +135,7 @@ def topic(text, conn, chan, nick, admin_log):
     conn.send("TOPIC {} :{}".format(chan, msg))
 
 
-@hook.command(permissions=["op_kick", "op"])
+@hook.command(permissions=["op_kick", "op", "chanop"])
 def kick(text, chan, conn, notice, nick, admin_log):
     """[channel] <user> - kicks <user> from [channel], or from the caller's channel if no channel is specified"""
     split = text.split(" ")
@@ -114,7 +145,7 @@ def kick(text, chan, conn, notice, nick, admin_log):
         target = split[1]
         if len(split) > 2:
             reason = " ".join(split[2:])
-            out = "KICK {} {}: {}".format(channel, target, reason)
+            out = "KICK {} {} :{}".format(channel, target, reason)
         else:
             out = "KICK {} {}".format(channel, target)
     else:
@@ -131,7 +162,7 @@ def kick(text, chan, conn, notice, nick, admin_log):
     conn.send(out)
 
 
-@hook.command(permissions=["op_rem", "op"])
+@hook.command(permissions=["op_rem", "op", "chanop"])
 def remove(text, chan, conn, nick, admin_log):
     """<user> - force removes <user> from the caller's channel."""
     split = text.split(" ")
@@ -145,25 +176,25 @@ def remove(text, chan, conn, nick, admin_log):
     conn.send(out)
 
 
-@hook.command(permissions=["op_mute", "op"], autohelp=False)
+@hook.command(permissions=["op_mute", "op", "chanop"], autohelp=False)
 def mute(text, conn, chan, notice, nick, admin_log):
     """[channel] - mutes [channel], or in the caller's channel if no channel is specified"""
     mode_cmd_no_target("+m", "mute", text, chan, conn, notice, nick, admin_log)
 
 
-@hook.command(permissions=["op_mute", "op"], autohelp=False)
+@hook.command(permissions=["op_mute", "op", "chanop"], autohelp=False)
 def unmute(text, conn, chan, notice, nick, admin_log):
     """[channel] - unmutes [channel], or in the caller's channel if no channel is specified"""
     mode_cmd_no_target("-m", "unmute", text, chan, conn, notice, nick, admin_log)
 
 
-@hook.command(permissions=["op_lock", "op"], autohelp=False)
+@hook.command(permissions=["op_lock", "op", "chanop"], autohelp=False)
 def lock(text, conn, chan, notice, nick, admin_log):
     """[channel] - locks [channel], or in the caller's channel if no channel is specified"""
     mode_cmd_no_target("+i", "lock", text, chan, conn, notice, nick, admin_log)
 
 
-@hook.command(permissions=["op_lock", "op"], autohelp=False)
+@hook.command(permissions=["op_lock", "op", "chanop"], autohelp=False)
 def unlock(text, conn, chan, notice, nick, admin_log):
     """[channel] - unlocks [channel], or in the caller's channel if no channel is specified"""
     mode_cmd_no_target("-i", "unlock", text, chan, conn, notice, nick, admin_log)