Merge pull request #184 from TotallyNotRobots/update-config

Add missing default config keys

Author: linuxdaemon

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add Python 3.8 to testing matrix
 - Add support for channel keys (#95)
 - Officially support channel keys across the whole bot
+- Add missing default config keys
 ### Changed
 - Refactor tests to remove dependency on mock library
 - Change link_announcer.py to only warn on connection errors

cloudbot/bot.py

@@ -18,11 +18,11 @@
 from cloudbot import clients
 from cloudbot.client import Client
 from cloudbot.config import Config
-from cloudbot.event import Event, CommandEvent, RegexEvent, EventType
+from cloudbot.event import CommandEvent, Event, EventType, RegexEvent
 from cloudbot.hook import Action
 from cloudbot.plugin import PluginManager
-from cloudbot.reloader import PluginReloader, ConfigReloader
-from cloudbot.util import database, formatting, async_util
+from cloudbot.reloader import ConfigReloader, PluginReloader
+from cloudbot.util import async_util, database, formatting
 from cloudbot.util.mapping import KeyFoldDict
 
 logger = logging.getLogger("cloudbot")
@@ -58,28 +58,34 @@ def clean_name(n):
     :type n: str
     :rtype: str
     """
-    return re.sub('[^A-Za-z0-9_]+', '', n.replace(" ", "_"))
+    return re.sub("[^A-Za-z0-9_]+", "", n.replace(" ", "_"))
 
 
 def get_cmd_regex(event):
     conn = event.conn
     is_pm = event.chan.lower() == event.nick.lower()
-    command_prefix = re.escape(conn.config.get('command_prefix', '.'))
+    command_prefix = re.escape(conn.config.get("command_prefix", "."))
     conn_nick = re.escape(event.conn.nick)
     cmd_re = re.compile(
         r"""
         ^
         # Prefix or nick
         (?:
-            (?P<prefix>[""" + command_prefix + r"""])""" + ('?' if is_pm else '') + r"""
+            (?P<prefix>["""
+        + command_prefix
+        + r"""])"""
+        + ("?" if is_pm else "")
+        + r"""
             |
-            """ + conn_nick + r"""[,;:]+\s+
+            """
+        + conn_nick
+        + r"""[,;:]+\s+
         )
         (?P<command>\w+)  # Command
         (?:$|\s+)
         (?P<text>.*)     # Text
         """,
-        re.IGNORECASE | re.VERBOSE
+        re.IGNORECASE | re.VERBOSE,
     )
     return cmd_re
 
@@ -126,7 +132,7 @@ def __init__(self, loop=asyncio.get_event_loop()):
         self.memory = collections.defaultdict()
 
         # declare and create data folder
-        self.data_dir = os.path.abspath('data')
+        self.data_dir = os.path.abspath("data")
         if not os.path.exists(self.data_dir):
             logger.debug("Data folder not found, creating.")
             os.mkdir(self.data_dir)
@@ -141,11 +147,15 @@ def __init__(self, loop=asyncio.get_event_loop()):
         self.config_reloading_enabled = reloading_conf.get("config_reloading", True)
 
         # this doesn't REALLY need to be here but it's nice
-        self.user_agent = self.config.get('user_agent', 'CloudBot/3.0 - CloudBot Refresh '
-                                                        '<https://github.com/CloudBotIRC/CloudBot/>')
+        self.repo_link = self.config.get(
+            "repo_link", "https://github.com/TotallyNotRobots/CloudBot/"
+        )
+        self.user_agent = self.config.get(
+            "user_agent", "CloudBot/3.0 - CloudBot Refresh <{repo_link}>"
+        ).format(repo_link=self.repo_link)
 
         # setup db
-        db_path = self.config.get('database', 'sqlite:///cloudbot.db')
+        db_path = self.config.get("database", "sqlite:///cloudbot.db")
         self.db_engine = create_engine(db_path)
         self.db_factory = sessionmaker(bind=self.db_engine)
         self.db_session = scoped_session(self.db_factory)
@@ -201,15 +211,14 @@ def register_client(self, name, cls):
 
     def create_connections(self):
         """ Create a BotConnection for all the networks defined in the config """
-        for config in self.config['connections']:
+        for config in self.config["connections"]:
             # strip all spaces and capitalization from the connection name
-            name = clean_name(config['name'])
-            nick = config['nick']
+            name = clean_name(config["name"])
+            nick = config["nick"]
             _type = config.get("type", "irc")
 
             self.connections[name] = self.get_client(_type)(
-                self, _type, name, nick, config=config,
-                channels=config['channels']
+                self, _type, name, nick, config=config, channels=config["channels"]
             )
             logger.debug("[%s] Created connection.", name)
 
@@ -283,7 +292,9 @@ async def _init_routine(self):
             conn.active = True
 
         # Connect to servers
-        await asyncio.gather(*[conn.try_connect() for conn in self.connections.values()], loop=self.loop)
+        await asyncio.gather(
+            *[conn.try_connect() for conn in self.connections.values()], loop=self.loop
+        )
         logger.debug("Connections created.")
 
         # Run a manual garbage collection cycle, to clean up any unused objects created during initialization
@@ -294,7 +305,7 @@ def load_clients(self):
         Load all clients from the "clients" directory
         """
         scanner = Scanner(bot=self)
-        scanner.scan(clients, categories=['cloudbot.client'])
+        scanner.scan(clients, categories=["cloudbot.client"])
 
     async def process(self, event):
         """
@@ -331,7 +342,9 @@ def add_hook(hook, _event, _run_before=False):
         for raw_hook in self.plugin_manager.catch_all_triggers:
             # run catch-all coroutine hooks before all others - TODO: Make this a plugin argument
             run_before = not raw_hook.threaded
-            if not add_hook(raw_hook, Event(hook=raw_hook, base_event=event), _run_before=run_before):
+            if not add_hook(
+                raw_hook, Event(hook=raw_hook, base_event=event), _run_before=run_before
+            ):
                 # The hook has an action of Action.HALT* so stop adding new tasks
                 break
 
@@ -355,12 +368,16 @@ def add_hook(hook, _event, _run_before=False):
             cmd_match = get_cmd_regex(event).match(event.content)
 
             if cmd_match:
-                command_prefix = event.conn.config.get('command_prefix', '.')
-                prefix = cmd_match.group('prefix') or command_prefix[0]
-                command = cmd_match.group('command').lower()
-                text = cmd_match.group('text').strip()
+                command_prefix = event.conn.config.get("command_prefix", ".")
+                prefix = cmd_match.group("prefix") or command_prefix[0]
+                command = cmd_match.group("command").lower()
+                text = cmd_match.group("text").strip()
                 cmd_event = partial(
-                    CommandEvent, text=text, triggered_command=command, base_event=event, cmd_prefix=prefix
+                    CommandEvent,
+                    text=text,
+                    triggered_command=command,
+                    base_event=event,
+                    cmd_prefix=prefix,
                 )
                 if command in self.plugin_manager.commands:
                     command_hook = self.plugin_manager.commands[command]
@@ -380,7 +397,9 @@ def add_hook(hook, _event, _run_before=False):
                             command_event = cmd_event(hook=command_hook)
                             add_hook(command_hook, command_event)
                         else:
-                            commands = sorted(command for command, plugin in potential_matches)
+                            commands = sorted(
+                                command for command, plugin in potential_matches
+                            )
                             txt_list = formatting.get_text_list(commands)
                             event.notice("Possible matches: {}".format(txt_list))
 
@@ -397,7 +416,9 @@ def add_hook(hook, _event, _run_before=False):
                 regex_match = regex.search(event.content)
                 if regex_match:
                     regex_matched = True
-                    regex_event = RegexEvent(hook=regex_hook, match=regex_match, base_event=event)
+                    regex_event = RegexEvent(
+                        hook=regex_hook, match=regex_match, base_event=event
+                    )
                     if not add_hook(regex_hook, regex_event):
                         # The hook has an action of Action.HALT* so stop adding new tasks
                         break

config.default.json

@@ -3,27 +3,39 @@
         {
             "name": "esper",
             "type": "irc",
+            "auto_rejoin": false,
+            "invite_join": true,
+            "join_throttle": 0.4,
+            "require_registered_channels": false,
             "connection": {
                 "server": "irc.esper.net",
                 "port": 6667,
                 "ssl": false,
                 "ignore_cert": true,
                 "password": "",
                 "timeout": 300,
-                "client_cert": "cloudbot.pem"
+                "client_cert": "cloudbot.pem",
+                "bind_addr": "",
+                "bind_port": 0
             },
             "ping_settings": {
                 "interval": 60,
                 "warn": 120,
                 "timeout": 300
             },
+            "user_agent": "CloudBot/3.0 - CloudBot Refresh <https://github.com/TotallyNotRobots/CloudBot/>",
+            "reply_ping": true,
             "nick": "MyCloudBot",
             "user": "cloudbot",
+            "realname": "CloudBot - https://git.io/CloudBot",
             "avoid_notices": false,
             "channels": [
                 "#cloudbot",
                 "#cloudbot2"
             ],
+            "mode": null,
+            "oper_user": null,
+            "oper_pw": null,
             "log_channel": "#MyAdminChannel",
             "disabled_commands": [],
             "acls": {},
@@ -40,6 +52,12 @@
                 "nickserv_name": "nickserv",
                 "nickserv_command": "IDENTIFY"
             },
+            "keep_alive": false,
+            "strip_newlines": true,
+            "max_line_length": 510,
+            "encoding": "utf-8",
+            "encoding_errors": "replace",
+            "strip_cmd_chars": "!.@;$",
             "ratelimit": {
                 "max_tokens": 17.5,
                 "restore_rate": 2.5,
@@ -110,9 +128,11 @@
         "cleverbot": "",
         "brewerydb": "",
         "alphavantage": "",
-        "coinmarketcap": ""
+        "coinmarketcap": "",
+        "giphy": ""
     },
     "database": "sqlite:///cloudbot.db",
+    "location_bias_cc": null,
     "plugin_loading": {
         "use_whitelist": false,
         "blacklist": [

plugins/core/core_connect.py

@@ -13,8 +13,13 @@ def conn_nick(conn):
 
 
 @hook.connect(priority=20, clients="irc")
-def conn_user(conn):
+def conn_user(conn, bot):
     conn.cmd(
-        "USER", conn.config.get('user', 'cloudbot'), "3", "*",
-        conn.config.get('realname', 'CloudBot - https://git.io/CloudBot')
+        "USER",
+        conn.config.get("user", "cloudbot"),
+        "3",
+        "*",
+        conn.config.get("realname", "CloudBot - {repo_link}").format(
+            repo_link=bot.repo_link
+        ),
     )

plugins/github.py

@@ -1,41 +1,62 @@
+import re
+
 import requests
 
 from cloudbot import hook
-from cloudbot.util import web, formatting
+from cloudbot.util import formatting, web
+
+shortcuts = {}
+url_re = re.compile(r"(?:https?://github\.com/)?(?P<owner>[^/]+)/(?P<repo>[^/]+)")
+
+
+def parse_url(url):
+    """
+    >>> parse_url("https://github.com/TotallyNotRobots/CloudBot/")
+    ('TotallyNotRobots', 'CloudBot')
+    >>> parse_url("TotallyNotRobots/CloudBot/")
+    ('TotallyNotRobots', 'CloudBot')
+    >>> parse_url("TotallyNotRobots/CloudBot")
+    ('TotallyNotRobots', 'CloudBot')
+    """
+    match = url_re.match(url)
+    return match.group("owner"), match.group("repo")
+
 
-shortcuts = {
-    'cloudbot': 'CloudBotIRC/CloudBot'
-}
+@hook.on_start()
+def load_shortcuts(bot):
+    shortcuts["cloudbot"] = parse_url(bot.repo_link)
 
 
 @hook.command("ghissue", "issue")
 def issue_cmd(text):
     """<username|repo> [number] - gets issue [number]'s summary, or the open issue count if no issue is specified"""
     args = text.split()
-    repo = args[0] if args[0] not in shortcuts else shortcuts[args[0]]
+    owner, repo = parse_url(args[0] if args[0] not in shortcuts else shortcuts[args[0]])
     issue = args[1] if len(args) > 1 else None
 
     if issue:
-        r = requests.get('https://api.github.com/repos/{}/issues/{}'.format(repo, issue))
+        r = requests.get(
+            "https://api.github.com/repos/{}/{}/issues/{}".format(owner, repo, issue)
+        )
         r.raise_for_status()
         j = r.json()
 
-        url = web.try_shorten(j['html_url'], service='git.io')
-        number = j['number']
-        title = j['title']
-        summary = formatting.truncate(j['body'].split('\n')[0], 25)
-        if j['state'] == 'open':
-            state = '\x033\x02Opened\x02\x0f by {}'.format(j['user']['login'])
+        url = web.try_shorten(j["html_url"], service="git.io")
+        number = j["number"]
+        title = j["title"]
+        summary = formatting.truncate(j["body"].split("\n")[0], 25)
+        if j["state"] == "open":
+            state = "\x033\x02Opened\x02\x0f by {}".format(j["user"]["login"])
         else:
-            state = '\x034\x02Closed\x02\x0f by {}'.format(j['closed_by']['login'])
+            state = "\x034\x02Closed\x02\x0f by {}".format(j["closed_by"]["login"])
 
-        return 'Issue #{} ({}): {} | {}: {}'.format(number, state, url, title, summary)
-    r = requests.get('https://api.github.com/repos/{}/issues'.format(repo))
+        return "Issue #{} ({}): {} | {}: {}".format(number, state, url, title, summary)
+    r = requests.get("https://api.github.com/repos/{}/{}/issues".format(owner, repo))
     r.raise_for_status()
     j = r.json()
 
     count = len(j)
     if count == 0:
-        return 'Repository has no open issues.'
+        return "Repository has no open issues."
 
-    return 'Repository has {} open issues.'.format(count)
+    return "Repository has {} open issues.".format(count)