add logging channel as optional item

Author: zefanjajobse

alembic/env.py

@@ -8,7 +8,7 @@
 # add db items to autogenerate the migrations
 from config import load_config
 from database import connection
-from database.dto import users, kd_roles  # noqa: F401
+from database.dto import users, kd_roles, server_settings  # noqa: F401
 
 # this is the Alembic Config object, which provides
 # access to the values within the .ini file in use.

alembic/versions/b8035ea3f1d4_add_settings_table.py

@@ -0,0 +1,39 @@
+"""add settings table
+
+Revision ID: b8035ea3f1d4
+Revises: 3c93bb5d292f
+Create Date: 2026-03-13 08:38:09.061353
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = 'b8035ea3f1d4'
+down_revision: Union[str, Sequence[str], None] = '3c93bb5d292f'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('server_settings',
+    sa.Column('server_id', sa.BigInteger(), nullable=False),
+    sa.Column('log_channel_id', sa.BigInteger(), nullable=True),
+    sa.Column('server_name', sa.String(), nullable=False),
+    sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=False),
+    sa.Column('updated_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=False),
+    sa.PrimaryKeyConstraint('server_id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('server_settings')
+    # ### end Alembic commands ###

bot.py

@@ -13,6 +13,7 @@
 from logger import setup_logger
 
 from utils.kd_roles import get_all_kd_roles
+from utils.server_settings import add_guild, has_guild
 from utils.user_servers import fetch_user_servers
 
 env_config = load_config()
@@ -35,8 +36,15 @@ async def setup_hook(self):
         await self.db.init_db()
         self.remove_command("help")
         await self.load_cogs()
-        logger.info("bot started")
+        logger.info("Adding all servers of the bot to the db")
         self.update_kdr.start()
+        async with self.db.create_session() as session:
+            async for guild in self.fetch_guilds():
+                if not await has_guild(session, guild.id):
+                    await add_guild(session, guild, {})
+                    logger.info(f'Added guild "{guild.name}"')
+
+        logger.info("Bot started")
 
     async def load_cogs(self):
         for file in os.listdir(os.path.dirname(__file__) + "/cogs"):
@@ -47,7 +55,7 @@ async def load_cogs(self):
 
     @tasks.loop(hours=12)
     async def update_kdr(self):
-        logger.info("updating KDR roles...")
+        logger.info("Updating KDR roles...")
         from utils.role_management import RoleManagement  # against circular import
 
         async with self.db.create_session() as session:
@@ -79,6 +87,14 @@ async def update_kdr(self):
 bot = KDRBot(command_prefix="!", intents=intents)
 
 
+@bot.event
+async def on_guild_join(guild: discord.Guild):
+    async with bot.db.create_session() as session:
+        if not await has_guild(session, guild.id):
+            await add_guild(session, guild, {})
+            logger.info(f'Added guild "{guild.name}"')
+
+
 @bot.event
 async def on_command_error(ctx, error):
     """dont give a error if a command doesn't exist"""

cogs/admin.py

@@ -1,22 +1,21 @@
 """User management"""
 
 import logging
-import os
-import sys
-
 import discord
 from discord import Role, app_commands
 from discord.ext import commands
-from sqlalchemy import select, func, and_
+from sqlalchemy import insert, select, func, and_
 from sqlalchemy.exc import IntegrityError
 
 from bot import KDRBot
 from database.dto.kd_roles import KDRole
+from database.dto.server_settings import ServerSetting
 from database.dto.users import User
 from database.error_handling import is_unique_violation
 from utils.kd_roles import get_kd_roles
 from utils.register import register
 from utils.role_management import RoleManagement
+from utils.server_settings import add_guild, update_guild
 
 
 class RegisterModal(discord.ui.Modal, title="Register your EA account"):
@@ -222,6 +221,32 @@ async def generate_register(self, interaction: discord.Interaction) -> None:
             embed=embed, view=RegisterView(self.bot)
         )
 
+    logging_group = app_commands.Group(
+        name="log", description="Manage the logging", parent=group
+    )
+
+    @logging_group.command(
+        name="channel",
+        description="Set the channel to log new registration attempts to",
+    )
+    @app_commands.guild_only()
+    @app_commands.default_permissions(administrator=True)
+    @app_commands.checks.has_permissions(administrator=True)
+    async def set_log_channel(
+        self, interaction: discord.Interaction, channel: discord.TextChannel
+    ) -> None:
+        """Set the channel to log new registration attempts to"""
+        await interaction.response.defer()
+        if interaction.guild is None:
+            return  # is already set to guild_only
+        async with self.bot.db.create_session() as session:
+            await update_guild(
+                session, interaction.guild, {"log_channel_id": channel.id}
+            )
+        await interaction.followup.send(
+            f'Set the logging channel to "{channel.name}"', ephemeral=True
+        )
+
 
 async def setup(bot: KDRBot) -> None:
     """Setup the cog within discord.py lib"""

database/dto/server_settings.py

@@ -0,0 +1,18 @@
+import datetime
+from typing import Optional
+from sqlalchemy import BigInteger, DateTime, func
+from sqlalchemy.orm import Mapped, mapped_column
+from database.connection import Base
+
+
+class ServerSetting(Base):
+    __tablename__ = "server_settings"
+    server_id: Mapped[int] = mapped_column(BigInteger, primary_key=True)
+    log_channel_id: Mapped[Optional[int]] = mapped_column(BigInteger)
+    server_name: Mapped[str]
+    created_at: Mapped[datetime.datetime] = mapped_column(
+        DateTime(timezone=True), server_default=func.now()
+    )
+    updated_at: Mapped[datetime.datetime] = mapped_column(
+        DateTime(timezone=True), server_default=func.now(), onupdate=func.now()
+    )

poetry.lock

@@ -14,7 +14,8 @@ dependencies = [
     "aiosqlite (>=0.22.1,<0.23.0)",
     "asyncpg (>=0.31.0,<0.32.0)",
     "pydantic (>=2.12.5,<3.0.0)",
-    "environs (>=14.6.0,<15.0.0)"
+    "environs (>=14.6.0,<15.0.0)",
+    "psycopg2 (>=2.9.11,<3.0.0)"
 ]
 
 

pyproject.toml

@@ -5,19 +5,34 @@
 from database.error_handling import is_unique_violation
 from utils.kd_roles import get_kd_roles
 from utils.role_management import RoleManagement
+from utils.server_settings import send_log
 
 
 async def register(bot: KDRBot, interaction: discord.Interaction, username: str):
     async with bot.db.create_session() as session:
         players = await bot.gametools_api.find_player(interaction, username)
         if len(players) <= 0:
-            await interaction.followup.send("User not found", ephemeral=True)
+            msg = "User not found"
+            await interaction.followup.send(msg, ephemeral=True)
+            await send_log(
+                bot,
+                session,
+                interaction.guild_id,
+                f'{interaction.user.mention} just tried to register with EA ID: "{username}", {msg}',
+            )
             return
         found_player = players[0]
 
         stats = await bot.gametools_api.get_stats(found_player)
         if len(players) <= 0:
-            await interaction.followup.send("No stats found for user", ephemeral=True)
+            msg = "No stats found for user"
+            await interaction.followup.send(msg, ephemeral=True)
+            await send_log(
+                bot,
+                session,
+                interaction.guild_id,
+                f'{interaction.user.mention} just tried to register with EA ID: "{username}", {msg}',
+            )
             return
 
         stat = stats[0]
@@ -30,12 +45,25 @@ async def register(bot: KDRBot, interaction: discord.Interaction, username: str)
         try:
             session.add(found_player)
             await session.commit()
+            await send_log(
+                bot,
+                session,
+                interaction.guild_id,
+                f'{interaction.user.mention} just registered with EA ID: "{username}"',
+            )
         except IntegrityError as ex:
+            await session.rollback()
             if is_unique_violation(ex):
                 await interaction.followup.send(
                     "You are already registered within this discord!",
                     ephemeral=True,
                 )
+                await send_log(
+                    bot,
+                    session,
+                    interaction.guild_id,
+                    f'{interaction.user.mention} just tried to register with EA ID: "{username}", but is already registered',
+                )
                 return
 
         await interaction.followup.send("Registered", ephemeral=True)

utils/register.py

@@ -0,0 +1,64 @@
+from typing import Optional
+
+import discord
+from sqlalchemy import select, update
+from sqlalchemy.dialects.postgresql import insert
+from sqlalchemy.exc import IntegrityError
+from sqlalchemy.ext.asyncio import AsyncSession
+from database.dto.server_settings import ServerSetting
+
+
+async def add_guild(session: AsyncSession, guild: discord.Guild, changes: dict) -> None:
+    data = dict(server_id=guild.id, server_name=guild.name)
+    data.update(changes)
+    stmt = insert(ServerSetting).values(data)
+    do_update_stmt = stmt.on_conflict_do_update(
+        index_elements=[ServerSetting.server_id],
+        set_=dict((k, v) for (k, v) in data.items() if k != "created_at"),
+    )
+
+    try:
+        await session.execute(do_update_stmt)
+        await session.commit()
+    except IntegrityError:
+        pass
+
+
+async def update_guild(session: AsyncSession, guild: discord.Guild, changes: dict):
+    if not await has_guild(session, guild.id):
+        await add_guild(session, guild, changes)
+        return
+
+    stmt = (
+        update(ServerSetting).where(ServerSetting.server_id == guild.id).values(changes)
+    )
+    await session.execute(stmt)
+    await session.commit()
+
+
+async def get_guild(session: AsyncSession, server_id: int) -> Optional[ServerSetting]:
+    stmt = select(ServerSetting).filter(ServerSetting.server_id == server_id).limit(1)
+    result = await session.execute(stmt)
+    return result.scalar_one_or_none()
+
+
+async def has_guild(session: AsyncSession, server_id: int) -> bool | None:
+    exists_criteria = (
+        select(ServerSetting.server_id)
+        .filter(ServerSetting.server_id == server_id)
+        .exists()
+    )
+    stmt = select(exists_criteria)
+    return await session.scalar(stmt)
+
+
+async def send_log(bot, session: AsyncSession, server_id: int | None, message: str):
+    if server_id is None:
+        return
+    settings = await get_guild(session, server_id)
+    if settings is None or settings.log_channel_id is None:
+        return
+
+    channel = bot.get_channel(settings.log_channel_id)
+    if isinstance(channel, discord.TextChannel):
+        await channel.send(message)