cogs/serverlog.py
# Copyright 2019 Allan Galarza
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import datetime as dt
import logging
from enum import Enum
from typing import Any, List, Optional
import discord
from discord.ext import commands
from nabbot import NabBot
from .utils import get_region_string, get_user_avatar, CogUtils
from .utils.database import DbChar
from .utils.tibia import NabChar, get_voc_abb_and_emoji
log = logging.getLogger("nabbot")
COLOUR_CHAR_REGISTERED = discord.Colour.dark_teal()
COLOUR_CHAR_UNREGISTERED = discord.Colour.dark_magenta()
COLOUR_CHAR_RENAME = discord.Colour.blurple()
COLOUR_CHAR_TRANSFERRED = discord.Colour.greyple()
COLOUR_MEMBER_JOINED = discord.Colour.green()
COLOUR_MEMBER_JOINED_BOT = discord.Colour.dark_green()
COLOUR_MEMBER_UPDATE = discord.Colour.blue()
COLOUR_MEMBER_KICK = discord.Colour.red()
COLOUR_MEMBER_REMOVE = discord.Colour(0xffff00) # yellow
COLOUR_MEMBER_BAN = discord.Colour.dark_red()
COLOUR_MEMBER_UNBAN = discord.Colour.orange()
COLOUR_EMOJI_UPDATE = discord.Colour.dark_orange()
COLOUR_GUILD_UPDATE = discord.Colour.purple()
COLOUR_WATCHLIST_DELETE = discord.Colour.dark_gold()
COLOUR_AUTOROLE_DELETE = discord.Colour.dark_gold()
COLOUR_JOINABLEROLE_DELETE = discord.Colour.dark_gold()
class ChangeType(Enum):
OWNER = "owner"
GUILD = "guild"
WORLD = "world"
NAME = "name"
class ServerLog(commands.Cog, CogUtils):
def __init__(self, bot: NabBot):
self.bot = bot
def cog_unload(self):
log.info(f"{self.tag} Unloading cog")
# region Custom Events
@commands.Cog.listener()
async def on_characters_registered(self, user: discord.User, added: List[NabChar], updated: List[DbChar],
author: discord.User = None):
"""Called when a user registers new characters
Announces the new characters in the server log of the relevant servers."""
user_guilds = self.bot.get_user_guilds(user.id)
embed = discord.Embed(colour=COLOUR_CHAR_REGISTERED)
embed.set_author(name=f"{user.name}#{user.discriminator}", icon_url=get_user_avatar(user))
for char in added:
await self.add_character_history(char.id, ChangeType.OWNER, 0, user.id, author)
for char in updated:
await self.add_character_history(char.id, ChangeType.OWNER, char.user_id, user.id, author)
if author:
embed.set_footer(text=f"{author.name}#{author.discriminator}", icon_url=get_user_avatar(author))
for guild in user_guilds:
world = self.bot.tracked_worlds.get(guild.id)
_added = [c for c in added if c.world == world]
_updated = [c for c in updated if c.world == world]
if not _added and not _updated:
continue
description = f"{user.mention} registered the following characters:"
for char in _added:
tibia_guild = char.guild_name or "No guild"
voc = get_voc_abb_and_emoji(char.vocation)
description += f"\n‣ {char.name} - Level {char.level} {voc} - **{tibia_guild}**"
for char in _updated:
voc = get_voc_abb_and_emoji(char.vocation)
tibia_guild = char.guild or "No guild"
description += f"\n‣ {char.name} - Level {abs(char.level)} {voc} - **{tibia_guild}** (Reassigned)"
embed.description = description
await self.bot.send_log_message(guild, embed=embed)
@commands.Cog.listener()
async def on_character_unregistered(self, user: discord.user, char: DbChar, author: discord.User = None):
"""Called when a user unregisters a character.
Announces the unregistered in the server log of the relevant servers."""
user_guilds = self.bot.get_user_guilds(user.id)
embed = discord.Embed(colour=COLOUR_CHAR_UNREGISTERED)
embed.set_author(name=f"{user.name}#{user.discriminator}", icon_url=get_user_avatar(user))
voc = get_voc_abb_and_emoji(char.vocation)
tibia_guild = char.guild or "No guild"
await self.add_character_history(char.id, ChangeType.OWNER, user.id, 0)
if author is not None:
embed.set_footer(text=f"{author.name}#{author.discriminator}", icon_url=get_user_avatar(author))
for guild in user_guilds:
world = self.bot.tracked_worlds.get(guild.id)
if char.world != world:
continue
embed.description = f"{user.mention} unregistered:" \
f"\n‣ {char.name} - Level {abs(char.level)} {voc} - **{tibia_guild}**"
await self.bot.send_log_message(guild, embed=embed)
@commands.Cog.listener()
async def on_character_rename(self, char: NabChar, old_name: str):
"""Called when a character is renamed.
Announces it in the server log of the relevant servers."""
user_id = char.owner_id
new_name = char.name
user_guilds = self.bot.get_user_guilds(user_id)
await self.add_character_history(char.id, ChangeType.NAME, old_name, char.name)
for guild in user_guilds:
if self.bot.tracked_worlds.get(guild.id) != char.world:
continue
member = guild.get_member(user_id)
if member is None:
continue
embed = discord.Embed(colour=COLOUR_CHAR_RENAME,
description=f"A character of {member.mention} changed name.\n"
f"‣ **{old_name}** -> **{new_name}**")
embed.set_author(name=f"{member.name}#{member.discriminator}", icon_url=get_user_avatar(member))
await self.bot.send_log_message(guild, embed=embed)
@commands.Cog.listener()
async def on_character_transferred(self, char: NabChar, old_world: str):
"""Called when a character switches world.
Announces it in the server log of the relevant servers, i.e. servers tracking the former or new world."""
user_id = char.owner_id
user_guilds = self.bot.get_user_guilds(user_id)
voc = get_voc_abb_and_emoji(char.vocation)
await self.add_character_history(char.id, ChangeType.WORLD, old_world, char.world)
for guild in user_guilds:
tracked_world = self.bot.tracked_worlds.get(guild.id)
if not(char.world == tracked_world or old_world == tracked_world):
continue
member = guild.get_member(user_id)
if member is None:
continue
embed = discord.Embed(colour=COLOUR_CHAR_TRANSFERRED,
description=f"A character of {member.mention} transferred:\n"
f"‣ **{char.name}** - Level {char.level} {voc} - "
f"{old_world} -> {char.world}")
embed.set_author(name=f"{member.name}#{member.discriminator}", icon_url=get_user_avatar(member))
await self.bot.send_log_message(guild, embed=embed)
@commands.Cog.listener()
async def on_character_guild_change(self, char: NabChar, old_guild: str):
"""Called when a character is renamed.
Adds an entry to the character's history."""
await self.add_character_history(char.id, ChangeType.GUILD, old_guild, char.guild_name)
@commands.Cog.listener()
async def on_role_auto_deleted(self, role: discord.Role):
embed = discord.Embed(title="Automatic role deleted", colour=COLOUR_AUTOROLE_DELETE,
description=f"Automatic role **{role.name}** deleted.")
entry = await self.get_audit_entry(role.guild, discord.AuditLogAction.role_delete, role)
if entry:
embed.set_footer(text=f"{entry.user.name}#{entry.user.discriminator}", icon_url=get_user_avatar(entry.user))
await self.bot.send_log_message(role.guild, embed=embed)
@commands.Cog.listener()
async def on_role_joinable_deleted(self, role: discord.Role):
embed = discord.Embed(title="Group deleted", colour=COLOUR_JOINABLEROLE_DELETE,
description=f"Joinable role **{role.name}** deleted.")
entry = await self.get_audit_entry(role.guild, discord.AuditLogAction.role_delete, role)
if entry and entry.user.id != self.bot.user.id:
embed.set_footer(text=f"{entry.user.name}#{entry.user.discriminator}", icon_url=get_user_avatar(entry.user))
await self.bot.send_log_message(role.guild, embed=embed)
@commands.Cog.listener()
async def on_watchlist_deleted(self, channel: discord.TextChannel, count: int):
"""Called when a watchlist channel is deleted.
Announces it in the server log.
If the bot has permission to see the audit log, it will also show the user that deleted it."""
embed = discord.Embed(title="Watchlist channel deleted", colour=COLOUR_WATCHLIST_DELETE,
description=f"Channel `#{channel.name}` was deleted. **{count}** entries were deleted.")
entry = await self.get_audit_entry(channel.guild, discord.AuditLogAction.channel_delete, channel)
if entry:
embed.set_footer(text=f"{entry.user.name}#{entry.user.discriminator}", icon_url=get_user_avatar(entry.user))
await self.bot.send_log_message(channel.guild, embed=embed)
# endregion
# region Discord Events
@commands.Cog.listener()
async def on_guild_emojis_update(self, guild: discord.Guild, before: List[discord.Emoji],
after: List[discord.Emoji]):
"""Called every time an emoji is created, deleted or updated."""
def emoji_repr(_emoji: discord.Emoji):
fix = ":" if _emoji.require_colons else ""
return f"{fix}{_emoji.name}{fix}"
embed = discord.Embed(colour=COLOUR_EMOJI_UPDATE)
emoji: discord.Emoji = None
# Emoji deleted
if len(before) > len(after):
emoji = discord.utils.find(lambda e: e not in after, before)
if emoji is None:
return
embed.set_author(name=f"{emoji_repr(emoji)} (ID: {emoji.id})", icon_url=emoji.url)
embed.description = f"Emoji deleted."
action = discord.AuditLogAction.emoji_delete
# Emoji added
elif len(after) > len(before):
emoji = discord.utils.find(lambda e: e not in before, after)
if emoji is None:
return
embed.set_author(name=f"{emoji_repr(emoji)} (ID: {emoji.id})", icon_url=emoji.url)
embed.description = f"Emoji added."
action = discord.AuditLogAction.emoji_create
else:
old_name = ""
for new_emoji in after:
for old_emoji in before:
if new_emoji == old_emoji and new_emoji.name != old_emoji.name:
old_name = old_emoji.name
emoji = new_emoji
break
if emoji is None:
return
embed.set_author(name=f"{emoji_repr(emoji)} (ID: {emoji.id})", icon_url=emoji.url)
embed.description = f"Emoji renamed from `{old_name}` to `{emoji.name}`"
action = discord.AuditLogAction.emoji_update
if emoji:
entry = await self.get_audit_entry(guild, action, emoji)
if entry:
embed.set_footer(text="{0.name}#{0.discriminator}".format(entry.user),
icon_url=get_user_avatar(entry.user))
await self.bot.send_log_message(guild, embed=embed)
@commands.Cog.listener()
async def on_guild_update(self, before: discord.Guild, after: discord.Guild):
"""Called every time a guild is updated"""
embed = discord.Embed(colour=COLOUR_GUILD_UPDATE)
embed.set_author(name=after.name, icon_url=after.icon_url)
changes = True
if before.name != after.name:
embed.description = f"Name changed from **{before.name}** to **{after.name}**"
elif before.region != after.region:
embed.description = "Region changed from **{0}** to **{1}**".format(get_region_string(before.region),
get_region_string(after.region))
elif before.icon_url != after.icon_url:
embed.description = "Icon changed"
embed.set_thumbnail(url=after.icon_url)
elif before.owner_id != after.owner_id:
embed.description = f"Ownership transferred to {after.owner.mention}"
else:
changes = False
if changes:
entry = await self.get_audit_entry(after, discord.AuditLogAction.guild_update)
if entry:
icon_url = get_user_avatar(entry.user)
embed.set_footer(text=f"{entry.user.name}#{entry.user.discriminator}", icon_url=icon_url)
await self.bot.send_log_message(after, embed=embed)
@commands.Cog.listener()
async def on_member_ban(self, guild: discord.Guild, user: discord.User):
"""Called when a member is banned from a guild."""
embed = discord.Embed(description="Banned", colour=COLOUR_MEMBER_BAN)
embed.set_author(name="{0.name}#{0.discriminator}".format(user), icon_url=get_user_avatar(user))
# If bot can see audit log, we can get more details of the ban
entry = await self.get_audit_entry(guild, discord.AuditLogAction.ban, user)
if entry:
embed.set_footer(text="{0.name}#{0.discriminator}".format(entry.user),
icon_url=get_user_avatar(entry.user))
if entry.reason:
embed.description += f"\n**Reason:** {entry.reason}"
await self.bot.send_log_message(guild, embed=embed)
@commands.Cog.listener()
async def on_member_join(self, member: discord.Member):
""" Called when a member joins a guild (server) the bot is in."""
embed = discord.Embed(description=f"{member.mention} joined.", colour=COLOUR_MEMBER_JOINED,
timestamp=member.created_at)
embed.set_author(name=f"{member.name}#{member.discriminator} (ID: {member.id})",
icon_url=get_user_avatar(member))
embed.set_footer(text="Discord user since")
if member.bot:
embed.colour = COLOUR_MEMBER_JOINED_BOT
embed.description = f"Bot {member.mention} added."
return await self.bot.send_log_message(member.guild, embed=embed)
world = self.bot.tracked_worlds.get(member.guild.id)
# If server is not tracking worlds, we don't check the database
if world is None:
return await self.bot.send_log_message(member.guild, embed=embed)
# Check if user already has characters registered and announce them on log_channel
# This could be because he rejoined the server or is in another server tracking the same worlds
rows = await self.bot.pool.fetch("""SELECT name, vocation, abs(level) as level, guild FROM "character"
WHERE user_id = $1 AND world = $2 ORDER BY level DESC""", member.id, world)
if rows:
self.bot.dispatch("character_change", member.id)
characters = ""
for c in rows:
voc = get_voc_abb_and_emoji(c["vocation"])
guild = c["guild"] or "No guild"
characters += f"\n\u2023 {c['name']} - Level {c['level']} {voc} - **{guild}**"
embed.add_field(name="Registered characters", value=characters)
await self.bot.send_log_message(member.guild, embed=embed)
@commands.Cog.listener()
async def on_member_remove(self, member: discord.Member):
"""Called when a member leaves or is kicked from a guild."""
bot_member: discord.Member = member.guild.me
embed = discord.Embed(description="Left the server or was kicked", colour=COLOUR_MEMBER_REMOVE)
embed.set_author(name=f"{member.name}#{member.discriminator} (ID: {member.id})",
icon_url=get_user_avatar(member))
tracked_world = self.bot.tracked_worlds.get(member.guild.id)
rows = await self.bot.pool.fetch("""SELECT name, vocation, abs(level) as level, guild FROM "character"
WHERE user_id = $1 AND world = $2""", member.id, tracked_world)
registered_chars = "\nRegistered characters:" if rows else ""
for char in rows:
voc = get_voc_abb_and_emoji(char["vocation"])
tibia_guild = dict(char).get("guild", "No guild")
registered_chars += f"\n‣ {char['name']} - Level {char['level']} {voc} - **{tibia_guild}** (Reassigned)"
# If bot can see audit log, he can see if it was a kick or member left on it's own
if bot_member.guild_permissions.view_audit_log:
entry = await self.get_audit_entry(member.guild, discord.AuditLogAction.kick, member)
if entry:
embed.description = "Kicked"
embed.set_footer(text=f"{entry.user.name}#{entry.user.discriminator}",
icon_url=get_user_avatar(entry.user))
embed.colour = COLOUR_MEMBER_KICK
if entry.reason:
embed.description += f"\n**Reason:** {entry.reason}"
embed.description += registered_chars
await self.bot.send_log_message(member.guild, embed=embed)
return
embed.description = "Left the server"
await self.bot.send_log_message(member.guild, embed=embed)
return
# Otherwise, we are not certain
await self.bot.send_log_message(member.guild, embed=embed)
@commands.Cog.listener()
async def on_member_update(self, before: discord.Member, after: discord.Member):
"""Called every time a member is updated"""
if before.nick != after.nick:
embed = discord.Embed(description=f"{after.mention}: ", colour=COLOUR_MEMBER_UPDATE)
embed.set_author(name=f"{after.name}#{after.discriminator} (ID: {after.id})",
icon_url=get_user_avatar(after))
if before.nick is None:
embed.description += f"Nickname set to **{after.nick}**"
elif after.nick is None:
embed.description += f"Nickname **{before.nick}** deleted"
else:
embed.description += f"Nickname changed from **{before.nick}** to **{after.nick}**"
entry = await self.get_audit_entry(after.guild, discord.AuditLogAction.member_update, after)
if entry and entry.user.id != after.id:
icon_url = get_user_avatar(entry.user)
embed.set_footer(text=f"{entry.user.name}#{entry.user.discriminator}", icon_url=icon_url)
await self.bot.send_log_message(after.guild, embed=embed)
@commands.Cog.listener()
async def on_member_unban(self, guild: discord.Guild, user: discord.User):
"""Called when a member is unbanned from a guild"""
embed = discord.Embed(description="Unbanned", colour=COLOUR_MEMBER_UNBAN)
embed.set_author(name="{0.name}#{0.discriminator} (ID {0.id})".format(user), icon_url=get_user_avatar(user))
entry = await self.get_audit_entry(guild, discord.AuditLogAction.unban, user)
if entry:
embed.set_footer(text="{0.name}#{0.discriminator}".format(entry.user),
icon_url=get_user_avatar(entry.user))
await self.bot.send_log_message(guild, embed=embed)
# endregion
@staticmethod
async def get_audit_entry(guild: discord.Guild, action: discord.AuditLogAction,
target: Any = None) -> Optional[discord.AuditLogEntry]:
"""Gets an audit log entry of the specified action type.
The type of the action depends on the action.
:param guild: The guild where the audit log will be checked.
:param action: The action to filter.
:param target: The target to filter.
:return: The first matching audit log entry if found.
"""
if not guild.me.guild_permissions.view_audit_log:
return
now = dt.datetime.utcnow()
after = now - dt.timedelta(0, 5)
async for entry in guild.audit_logs(limit=10, oldest_first=False, action=action, after=after):
if abs((entry.created_at - now)) >= dt.timedelta(seconds=5):
break
if target is not None and entry.target.id == target.id:
return entry
async def add_character_history(self, char_id: int, change_type: ChangeType, before, after, author=None):
"""Adds a character history entry to the database.
:param char_id: The affected character's id.
:param change_type: The type of change.
:param before: The previous value.
:param after: The new value.
:param author: The user that caused this change.
"""
author_id = author.id if author else None
await self.bot.pool.execute("""INSERT INTO character_history(character_id, change_type, before, after, user_id)
values($1, $2, $3, $4, $5)""",
char_id, change_type.value, before, after, author_id)
def setup(bot):
bot.add_cog(ServerLog(bot))