feat: Containerize the application + Other features

.env.example

@@ -0,0 +1,23 @@
+# Copy this file to .env and fill in your values
+
+# Discord Configuration
+DISCORD_CLIENT_ID="your_discord_client_id"
+DISCORD_GUILD_ID="your_discord_guild_id"
+DISCORD_TOKEN="your_discord_bot_token"
+
+# PocketBase Configuration
+POCKETBASE_EMAIL="admin@example.com"
+POCKETBASE_PASSWORD="your_secure_password"
+
+# MySQL Configuration
+MYSQL_USER=test
+MYSQL_PASSWORD=pass
+MYSQL_ROOT_PASSWORD=test_pass
+
+# Note: Database connection details are automatically configured via Docker containers
+# The following variables are set automatically in docker-compose.yml:
+# - POCKETBASE_HOST=http://moderation-db:8080
+# - MYSQL_HOST=message-db
+# - MYSQL_PORT=3306
+#
+# Access the pocketbase admin panel at: http://localhost:8080/_/ (or your server ip) to setup your admin account

.gitignore

@@ -1,2 +1,7 @@
-.env
 pocketbase/*
+.env
+
+# Database data directories
+pocketbase-db/data/
+message-db/data/
+.DS_Store

Dockerfile

@@ -0,0 +1,32 @@
+FROM alpine:latest
+
+ARG PB_VERSION=0.20.3
+
+RUN apk add --no-cache \
+    unzip \
+    ca-certificates
+
+# download and unzip PocketBase
+ADD https://github.com/pocketbase/pocketbase/releases/download/v${PB_VERSION}/pocketbase_${PB_VERSION}_linux_amd64.zip /tmp/pb.zip
+RUN unzip /tmp/pb.zip -d /pb/
+
+# create data directory for databases
+RUN mkdir -p /pb/pb_data
+
+# copy startup script
+COPY start.sh /pb/start.sh
+RUN chmod +x /pb/start.sh
+
+# uncomment to copy the local pb_migrations dir into the image
+# COPY ./pb_migrations /pb/pb_migrations
+
+# uncomment to copy the local pb_hooks dir into the image
+# COPY ./pb_hooks /pb/pb_hooks
+
+EXPOSE 8080
+
+# create volume for persistent data storage
+VOLUME ["/pb/pb_data"]
+
+# start PocketBase with auto-admin setup
+CMD ["/pb/start.sh"]

README.md

@@ -4,3 +4,84 @@ Honkbot2 is the new discord bot for the UManitoba Computer Science Lounge writte
 
 Honkbot2 contains a wide variety of moderation and verification functionalities.
 To learn more read the [Moderation Handbook](https://umanitobacssa.ca/docs/discordModHandbook.pdf)
+
+## Quick Start
+
+1. **Clone the repository**
+   ```bash
+   git clone <repository-url>
+   cd honkbot2
+   ```
+
+2. **Set up environment variables**
+   ```bash
+   cp .env.example .env
+   # Edit .env with your Discord bot credentials
+   ```
+
+3. **Start the containers**
+   ```bash
+   docker compose up -d
+   ```
+   *See [Development Commands](#development-commands) for more options for log viewing and rebuilding containers*
+
+4. **Set up the pocketbase admin account**
+
+   Go to http://localhost:8080/_/ (or the ip of your remote server) and set up the account with the same credentials as your .env
+
+The bot will automatically build and start all docker containers, all database networking connections are configured through the created docker network, and it will also auto create the required databases for the first message sent in a discord server.
+
+## Environment Variables
+
+The following variables need to be set in your `.env` file:
+
+- `DISCORD_CLIENT_ID` - Your Discord application client ID
+- `DISCORD_GUILD_ID` - Your Discord server ID
+- `DISCORD_TOKEN` - Your Discord bot token
+- `POCKETBASE_EMAIL` - Email for PocketBase admin
+- `POCKETBASE_PASSWORD` - Password for PocketBase admin
+
+## Database Configuration
+
+The bot uses two databases that are automatically configured:
+
+### MySQL (Message Database)
+- **Host**: `message-db` (container name)
+- **Port**: `3306`
+- **User**: `test`
+- **Password**: `pass`
+
+### PocketBase (Moderation Database)
+- **Host**: `moderation-db:8080` (container name)
+- **Admin Panel**: http://localhost:8080/_/
+
+## Development Commands
+
+```bash
+# Start all services
+docker-compose up -d
+
+# View bot logs
+docker-compose logs honkbot
+
+# View PocketBase logs
+docker-compose logs pocketbase-db
+
+# View MySQL logs
+docker-compose logs mysql
+
+# Stop all services
+docker-compose down
+
+# Rebuild and restart
+docker-compose up --build -d
+```
+
+## Database Schema
+
+The MySQL database automatically creates the following tables per Discord server:
+
+- `messages` - Stores all user messages
+- `message_deleted` - Stores deleted messages for moderation
+- `message_edited` - Stores message edit history
+- `counters` - Stores user statistics (reactions, message counts, etc.)

bot/Dockerfile

@@ -0,0 +1,18 @@
+# Use the official Bun image
+# see all versions at https://hub.docker.com/r/oven/bun/tags
+FROM oven/bun:1
+WORKDIR /usr/src/app
+
+# Copy package files and install dependencies
+COPY package.json bun.lockb ./
+RUN bun install --frozen-lockfile
+
+# Copy all project files
+COPY . .
+
+# Set environment to production
+ENV NODE_ENV=production
+
+# Run the app
+USER bun
+ENTRYPOINT [ "bun", "run", "index.ts" ]

bot/data/Events.ts

@@ -3,12 +3,15 @@ export module Events {
         VerifyStudent = 'btn-verify-student',
         VerifyAlumni = 'btn-verify-alumni',
         VerifyInstructor = 'btn-verify-instructor',
+        ForceVerifyPending = 'btn-force-verify-pending',
+        SetPreferredName = 'set-preferred-name',
     };
 
     export enum Modal {
         VerifyStudentModal = 'modal-verify-student',
         VerifyAlumniModal = 'modal-verify-alumni',
-        VerifyInstructorModal = 'modal-verify-instructor'
+        VerifyInstructorModal = 'modal-verify-instructor',
+        PreferredNameModal = 'modal-preferred-name'
     };
 
 }

bot/data/Registry.ts

@@ -40,7 +40,13 @@ export function RegisterButtonHandler(id: Events.Button, handler: (interaction:
 }
 
 export function GetButtonHandler(id: string): ((interaction: ButtonInteraction) => void) | undefined {
-    return _buttonHandlers.get(id);
+    // Exact match
+    if (_buttonHandlers.has(id)) return _buttonHandlers.get(id);
+    // Prefix match for parameterized IDs
+    for (const key of _buttonHandlers.keys()) {
+        if (id.startsWith(key)) return _buttonHandlers.get(key);
+    }
+    return undefined;
 }
 
 export async function LoadAllModules() {
@@ -54,4 +60,16 @@ export async function LoadAllModules() {
             await module.hb_init();
         }
     }
+
+    // Also load template modules that might have handlers
+    const templatesModulePath = path.join(import.meta.dir, '../templates');
+    const templatesModuleFiles = fs.readdirSync(templatesModulePath, {recursive: true, encoding: 'utf-8'}).filter(file => file.endsWith('.ts'));
+    for (const file of templatesModuleFiles) {
+        const filePath = path.join(templatesModulePath, file);
+        const module = await import(filePath);
+        if (module.hb_init) {
+            // console.log(`Loading template module ${file}`);
+            await module.hb_init();
+        }
+    }
 }

bot/database/database.ts

@@ -118,13 +118,13 @@ export async function GetPendingVerification(id: string): Promise<PendingVerific
             .collection("pending_verifications")
             .getOne(id);
     } catch (error) {
-        console.warn(`Failed to fetch from pending_verifications: ${error}`);
+        console.warn(`WARN: Failed to fetch from pending_verifications: ${error}`);
         try {
             pendingVerification = await pb
                 .collection("pending_alumni_verifications")
                 .getOne(id);
         } catch (alumniError) {
-            console.error(`Failed to fetch from pending_alumni_verifications: ${alumniError}`);
+            console.error(`WARN: Failed to fetch from pending_alumni_verifications: ${alumniError}`);
         }
     }
 
@@ -353,4 +353,18 @@ export async function AddModMail(guild_id: string, target_user_id: string, issue
         incoming
     }
     return await pb.collection("mod_mail").create(data);
+}
+
+export async function GetAllVerifiedStudents(guild_id: string): Promise<VerifiedUser[]> {
+    const pb = await getPb();
+    const verifiedStudents: VerifiedUser[] = await pb
+        .collection("verified_users")
+        .getFullList({ filter: `guild_id = "${guild_id}" && type = "student"` });
+
+    return verifiedStudents;
+}
+
+export async function RemoveVerifiedUser(id: string): Promise<void> {
+    const pb = await getPb();
+    await pb.collection("verified_users").delete(id);
 }