discordban.py

#
# DiscordB3 (www.namelessnoobs.com)
# Copyright (C) 2016 st0rm
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

#Credits 
#Fenix the orginal author of the irc b3 bot which this plugin is based on.
#Mordecaii from iG for his lovely discordPush fuction <3.
#ItsDizzy from aD for the embedded message and some cleanups.

__author__ = "Fenix, st0rm, Mordecaii, ItsDizzy"
__version__ = "1.2"

import b3
import b3.plugin
import b3.events
import datetime
import urllib2
import json

from b3.functions import minutesStr


class DiscordbanPlugin(b3.plugin.Plugin):

    ####################################################################################################################
    #                                                                                                                  #
    #   PLUGIN INIT                                                                                                    #
    #                                                                                                                  #
    ####################################################################################################################

    def __init__(self, console, config=None):
        """
        Build the plugin object.
        :param console: The parser instance.
        :param config: The plugin configuration object instance.
        """
        b3.plugin.Plugin.__init__(self, console, config)
        self.adminPlugin = self.console.getPlugin("admin")
        if not self.adminPlugin:
            raise AttributeError("could not start without admin plugin")

    def onLoadConfig(self):
        """
        Load plugin configuration.
        """
        self._discordWebhookUrl = self.config.get("authentication","webhookUrl")
        self._serverName = self.config.get("authentication","hostname")

    def onStartup(self):
        """
        Initialize plugin settings.
        """

        # register necessary events
        self.registerEvent(self.console.getEventID("EVT_CLIENT_BAN"), self.onBan)
        self.registerEvent(self.console.getEventID("EVT_CLIENT_BAN_TEMP"), self.onBan)
        self.registerEvent(self.console.getEventID("EVT_CLIENT_KICK"), self.onKick)

        # notice plugin started
        self.debug("plugin started")

    ####################################################################################################################
    #                                                                                                                  #
    #   EVENTS                                                                                                         #
    #                                                                                                                  #
    ####################################################################################################################

    def onBan(self, event):
        """
        Perform operations when EVT_CLIENT_BAN or EVT_CLIENT_BAN_TEMP is received.
        :param event: An EVT_CLIENT_BAN or and EVT_CLIENT_BAN_TEMP event.
        """
        admin = event.data["admin"]
        client = event.client
        reason = event.data["reason"]

        admin_name = ""
        if admin == None:
            admin_name = "B3"
        else:
            admin_name = admin.name
            
        embed = {
            "title": "B3 Ban",
            "description": "**%s** Banned **%s**" % (admin_name, client.name),
            "timestamp": datetime.datetime.now().isoformat(),
            "color": 15466496,
            "fields": [
                {
                    "name": "Server",
                    "value": self._serverName,
                    "inline": False
                }
            ]
        }

        if reason:
            # if there is a reason attached to the ban, append it to the notice
            embed["fields"].append({
                "name": "Reason",
                "value": self.console.stripColors(reason),
                "inline": True
            })

        duration = 'permanent'
        if 'duration' in event.data:
            # if there is a duration convert it
            duration = minutesStr(event.data['duration'])

        # append the duration to the ban notice
        embed["fields"].append({"name": "Duration", "value": duration, "inline": True})

        self.discordEmbeddedPush(embed)

    def onKick(self, event):
        """
        Perform operations when EVT_CLIENT_KICK is received.
        :param event: An EVT_CLIENT_KICK event.
        """
        admin = event.data["admin"]
        client = event.client
        reason = event.data["reason"]
		
        admin_name = ""
        if admin == None:
            admin_name = "B3"
        else:
            admin_name = admin.name

        embed = {
            "title": "B3 Kick",
            "description": "**%s** Kicked **%s**" % (admin_name, client.name),
            "timestamp": datetime.datetime.now().isoformat(),
            "color": 15466496,
            "fields": [
                {
                    "name": "Server",
                    "value": self._serverName,
                    "inline": False
                }
            ]
        }

        if reason:
            # if there is a reason attached to the ban, append it to the notice
            embed["fields"].append({
                "name": "Reason",
                "value": self.console.stripColors(reason),
                "inline": True
            })

        self.discordEmbeddedPush(embed)

    def discordEmbeddedPush(self, embed):
        """
        Send embedded message to discord bot huehue
        """
        data = json.dumps({"embeds": [embed]})
        req = urllib2.Request(self._discordWebhookUrl, data, {
            "Content-Type": "application/json",
            "User-Agent": "B3DiscordbanPlugin/1.1" #Is that a real User-Agent? Nope but who cares.
        })

        # Final magic happens here, we will never get an error ofcourse ;)
        try:
            urllib2.urlopen(req)
        except urllib2.HTTPError as ex:
            self.debug("Cannot push data to Discord. is your webhook url right?")
            self.debug("Data: %s\nCode: %s\nRead: %s" % (data, ex.code, ex.read()))