Merge develop withmaster

docs/bot.conf.example

@@ -94,3 +94,6 @@ bitly-api-key            =
 
 # https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line
 github-token             =
+
+# https://ipinfo.io/account/token
+ipinfo-token             =

docs/help/config.md

@@ -2,7 +2,7 @@
 
 * Move `docs/bot.conf.example` to `~/.bitbot/bot.conf` and fill in the config options you care about. Ones blank or removed will disable relevant functionality.
 * Run `./bitbotd -a` to add a server.
-* Run `./bitbotd` to start the bot.
+* Run `./bitbotd` to start the bot or `./bitbotd -c /path/to/bot.conf` for non-standard config location (outside of `~/.bitbot`).
 * Run `./bitbotctl command master-password` to get the master admin password (needed to add regular admin accounts)
 * Join `#bitbot` on a server with the bot (or invite it to another channel)
 * `/msg <bot> register <password here>` to register your nickname with the bot
@@ -14,6 +14,9 @@
 
 Generate a TLS keypair and point `bot.conf`'s `tls-key` to the private key and `tls-certificate` to the public key.
 
+Below is an OpenSSL command example that will create a `bitbot-cert.pem` and `bitbot-key.pem` with `10y` validity (self-signed):
+> openssl req -x509 -nodes -sha512 -newkey rsa:4096 -keyout bitbot-key.pem -out bitbot-cert.pem -days 3650 -subj "/CN=YourBotNick"
+
 ### Configure SASL
 
 Configure the bot to use SASL to authenticate (usually used for `NickServ` identification)

docs/help/rest_api.md

@@ -15,7 +15,7 @@ Either set up a reverse proxy (with persisted Host header) with your favourite H
 #### Apache2
 * Run `$ a2enmod ssl proxy proxy_http` as root
 * Copy example config file from [/docs/rest_api/apache2](/docs/rest_api/apache2) to `/etc/apache2/sites-enabled/`
-* Edit `ServerName`, `SSLCertificateFile and `SSLCertificateKeyFile`
+* Edit `ServerName`, `SSLCertificateFile` and `SSLCertificateKeyFile`
 * `$ service apache2 restart` as root
 
 #### Lighttpd

docs/rest_api/apache2

@@ -15,6 +15,6 @@ Listen 5000
 
     ProxyRequests off
     ProxyPass / http://[::1]:5001/
-    ProxyPassReverse / http://[::1]:5001
+    ProxyPassReverse / http://[::1]:5001/
     ProxyPreserveHost on
 </VirtualHost>

docs/rest_api/nginx

@@ -8,7 +8,7 @@ server {
 
     location / {
         proxy_pass http://[::1]:5001;
-        proxy_set_header Host $host:$port;
+        proxy_set_header Host $host:$server_port;
         proxy_set_header X-Forwarded-For $remote_addr;
     }
 }

docs/systemd/bitbot_user.service

@@ -10,6 +10,8 @@
 # which can be disabled with: systemctl --user disable systemd-tmpfiles-clean.timer
 #
 # After placing this script in the correct location, and with bitbot stopped, type:
+# systemcl --user daemon-reload
+# Afert that start bitbot with:
 # systemctl --user enable bitbot_user.service --now
 # This will enable the systemd script and launch bitbot
 

modules/ban_enforce.py

@@ -4,6 +4,8 @@
 
 @utils.export("channelset", utils.BoolSetting("ban-enforce",
     "Whether or not to parse new bans and kick who they affect"))
+@utils.export("channelset", utils.IntSetting("ban-enforce-max",
+    "Do not enforce ban if the ban effects more than this many users. Default is half of total channel users."))
 class Module(ModuleManager.BaseModule):
     @utils.hook("received.mode.channel")
     def on_mode(self, event):
@@ -14,14 +16,21 @@ def on_mode(self, event):
                 if mode[0] == "+" and mode[1] == "b":
                     bans.append(arg)
 
+            affected = 0
+            defaultmax = len(event["channel"].users) // 2
+            realmax = event["channel"].get_setting("ban-enforce-max", defaultmax)
+
             if bans:
                 umasks = {u.hostmask(): u for u in event["channel"].users}
                 for ban in bans:
                     mask = utils.irc.hostmask_parse(ban)
                     matches = list(utils.irc.hostmask_match_many(
                         umasks.keys(), mask))
                     for match in matches:
+                        affected = affected + 1
                         kicks.add(umasks[match])
             if kicks:
+                if affected > realmax:
+                    return
                 nicks = [u.nickname for u in kicks]
                 event["channel"].send_kicks(sorted(nicks), REASON)

modules/channel_op.py

@@ -83,7 +83,7 @@ def unmode(self, timer):
                 channel = server.channels.get(channel_name)
 
                 args = timer.kwargs.get("args", [timer.kwargs.get("arg", None)])
-                if args:
+                if any(args):
                     channel.send_modes(args, False)
                 else:
                     channel.send_mode(timer.kwargs["mode"], False)
@@ -238,7 +238,7 @@ def cmute(self, event):
 
         if event["spec"][1]:
             self.timers.add_persistent("unmode", event["spec"][1],
-                channel=event["spec"][0].id, mode="m")
+                channel=event["spec"][0].id, mode="-m")
     @utils.hook("received.command.cunmute")
     @utils.kwarg("require_mode", "o")
     @utils.kwarg("require_access", "high,cmute")

modules/dnsbl/__init__.py

@@ -43,14 +43,22 @@ def _check_lists(self, lists, address):
         failed = []
         for list in lists:
             record = self._check_list(list.hostname, address)
-            if not record == None:
-                reason = list.process(record) or "unknown"
+            if record is not None:
+                a_record, txt_record = record
+                reason = list.process(a_record, txt_record) or "unknown"
                 failed.append((list.hostname, reason))
         return failed
 
     def _check_list(self, list, address):
         list_address = "%s.%s" % (address, list)
         try:
-            return dns.resolver.query(list_address, "A")[0].to_text()
+            a_record = dns.resolver.resolve(list_address, "A")[0].to_text()
         except dns.resolver.NXDOMAIN:
             return None
+
+        try:
+            txt_record = dns.resolver.resolve(list_address, "TXT")[0].to_text()
+        except:
+            txt_record = None
+
+        return (a_record, txt_record)

modules/dnsbl/lists.py

@@ -5,53 +5,62 @@ def __init__(self, hostname=None):
         if not hostname == None:
             self.hostname = hostname
 
-    def process(self, result: str):
-        return result
+    def process(self, a_record, txt_record):
+        out = a_record
+        if txt_record is not None:
+            out += f" - {txt_record}"
+        return out
 
 class ZenSpamhaus(DNSBL):
     hostname = "zen.spamhaus.org"
-    def process(self, result):
-        result = result.rsplit(".", 1)[1]
+    def process(self, a_record, txt_record):
+        result = a_record.rsplit(".", 1)[1]
         if result in ["2", "3", "9"]:
-            return "spam"
+            desc = "spam"
         elif result in ["4", "5", "6", "7"]:
-            return "exploits"
+            desc = "exploits"
+        else:
+            desc = "unknown"
+        return f"{result} - {desc}"
+
 class EFNetRBL(DNSBL):
     hostname = "rbl.efnetrbl.org"
-    def process(self, result):
-        result = result.rsplit(".", 1)[1]
+    def process(self, a_record, txt_record):
+        result = a_record.rsplit(".", 1)[1]
         if result == "1":
-            return "proxy"
+            desc = "proxy"
         elif result in ["2", "3"]:
-            return "spamtap"
+            desc = "spamtap"
         elif result == "4":
-            return "tor"
+            desc = "tor"
         elif result == "5":
-            return "flooding"
+            desc = "flooding"
+        return f"{result} - {desc}"
 
 class DroneBL(DNSBL):
     hostname = "dnsbl.dronebl.org"
-    def process(self, result):
-        result = result.rsplit(".", 1)[1]
-        if result in ["8", "9", "10", "11", "14"]:
-            return "proxy"
-        elif result in ["3", "6", "7"]:
-            return "flooding"
-        elif result in ["12", "13", "15", "16"]:
-            return "exploits"
 
 class AbuseAtCBL(DNSBL):
     hostname = "cbl.abuseat.org"
-    def process(self, result):
-        result = result.rsplit(".", 1)[1]
+    def process(self, a_record, txt_record):
+        result = a_record.rsplit(".", 1)[1]
         if result == "2":
-            return "abuse"
+            desc = "abuse"
+        else:
+            desc = "unknown"
+        return f"{result} - {desc}"
+
+class TorExitDan(DNSBL):
+    hostname = "torexit.dan.me.uk"
+    def process(self, a_record, txt_record):
+        return "tor exit"
 
 DEFAULT_LISTS = [
     ZenSpamhaus(),
     EFNetRBL(),
     DroneBL(),
-    AbuseAtCBL()
+    AbuseAtCBL(),
+    TorExitDan()
 ]
 
 def default_lists():

modules/ducks.py

@@ -98,6 +98,10 @@ def _no_duck(self, channel, user, stderr):
     @utils.kwarg("help", "Befriend a duck")
     @utils.spec("!-channelonly")
     def befriend(self, event):
+        if not event["target"].get_setting("ducks-enabled", False):
+            return event["stderr"].write(
+                "Ducks are not enabled in this channel"
+            )
         if event["target"].duck_active:
             action = self._duck_action(event["target"], event["user"],
                 "befriended", "ducks-befriended")
@@ -109,6 +113,10 @@ def befriend(self, event):
     @utils.kwarg("help", "Trap a duck")
     @utils.spec("!-channelonly")
     def trap(self, event):
+        if not event["target"].get_setting("ducks-enabled", False):
+            return event["stderr"].write(
+                "Ducks are not enabled in this channel"
+            )
         if event["target"].duck_active:
             action = self._duck_action(event["target"], event["user"],
                 "trapped", "ducks-shot")

modules/git_webhooks/__init__.py

@@ -31,7 +31,7 @@ class Module(ModuleManager.BaseModule):
     _name = "Webhooks"
 
     def on_load(self):
-        self._github = github.GitHub(self.log)
+        self._github = github.GitHub(self.log, self.exports)
         self._gitea = gitea.Gitea()
         self._gitlab = gitlab.GitLab()
 
@@ -135,17 +135,17 @@ def _webhook(self, webhook_type, webhook_name, handler, payload_str,
                 for output, url in outputs:
                     output = "(%s) %s" % (
                         utils.irc.color(source, colors.COLOR_REPO), output)
+
+                    if channel.get_setting("git-prevent-highlight", False):
+                        output = self._prevent_highlight(server, channel,
+                            output)
 
                     if url:
                         if channel.get_setting("git-shorten-urls", False):
                             url = self.exports.get("shorturl")(server, url,
                                 context=channel) or url
                         output = "%s - %s" % (output, url)
 
-                    if channel.get_setting("git-prevent-highlight", False):
-                        output = self._prevent_highlight(server, channel,
-                            output)
-
                     hide_prefix = channel.get_setting("git-hide-prefix", False)
                     self.events.on("send.stdout").call(target=channel,
                         module_name=webhook_name, server=server, message=output,
@@ -228,6 +228,9 @@ def github_webhook(self, event):
             if existing_hook:
                 raise utils.EventError("There's already a hook for %s" %
                     hook_name)
+            if hook_name == None:
+                command = "%s%s" % (event["command_prefix"], event["command"])
+                raise utils.EventError("Not enough arguments (Usage: %s add <hook>)" % command)
 
             all_hooks[hook_name] = {
                 "events": DEFAULT_EVENT_CATEGORIES.copy(),