ham/ghbot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Modernize role management system with slash commands and role IDs

Browse Source 
- Convert role management from prefix to slash commands (/role add/remove/list)
- Update database schema to store role IDs as JSON arrays instead of regex patterns
- Add /config roles command for administrators to manage allowed roles
- Simplify database schema by reusing allowed_roles_for_request field as JSON
- Add database reset script (pnpm reset-db) for easy testing and migration
- Update config format to only support array format (no backward compatibility)

Role Management Features:
- /role add <role> - Self-assign roles with dropdown selection
- /role remove <role> - Remove roles with dropdown selection
- /role list - Show available self-assignable roles
- /config roles add/remove/list/clear - Administrator role management

Technical Improvements:
- Role ID based matching (more reliable than name-based regex)
- Type-safe role selection with Discord's native role picker
- Permission hierarchy validation
- Rich embed responses with proper error handling
- Ephemeral responses for clean chat experience

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Chris Ham
2025-08-16 18:07:07 -07:00
parent 18350ee878
commit 61a376cfbb
5 changed files with 535 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

299
src/services/databaseService.js
View File

@@ -1,15 +1,15 @@
const Database = require('better-sqlite3');
const path = require('path');
const Database = require("better-sqlite3");
const path = require("path");
class DatabaseService {
constructor() {
// Store database in data directory
const dbPath = path.join(__dirname, '..', '..', 'data', 'ghbot.db');
const dbPath = path.join(__dirname, "..", "..", "data", "ghbot.db");
this.db = new Database(dbPath);
// Enable WAL mode for better concurrent access
this.db.pragma('journal_mode = WAL');
this.db.pragma("journal_mode = WAL");
this.initializeTables();
}
@@ -29,7 +29,7 @@ class DatabaseService {
sfx_volume REAL DEFAULT 0.5,
enable_fun_facts BOOLEAN DEFAULT true,
enable_ham_facts BOOLEAN DEFAULT true,
allowed_roles_for_request TEXT,
allowed_roles_for_request TEXT DEFAULT '[]',
is_active BOOLEAN DEFAULT true,
created_at DATETIME DEFAULT CURRENT_TIMESTAMP,
updated_at DATETIME DEFAULT CURRENT_TIMESTAMP,
@@ -73,11 +73,11 @@ class DatabaseService {
('blacklisted_users', '[]')
`);
console.log('Database tables initialized');
console.log("Database tables initialized");
// Prepare statements after tables are created
this.prepareStatements();
// Run migrations after statements are prepared
this.runMigrations();
}
@@ -87,10 +87,14 @@ class DatabaseService {
*/
runMigrations() {
// Check if we need to seed from config file
const guildCount = this.db.prepare('SELECT COUNT(*) as count FROM guilds').get().count;
const guildCount = this.db
.prepare("SELECT COUNT(*) as count FROM guilds")
.get().count;
if (guildCount === 0) {
console.log('No guilds found in database, checking for config file to seed...');
console.log(
"No guilds found in database, checking for config file to seed..."
);
this.seedFromConfigFile();
}
}
@@ -100,94 +104,119 @@ class DatabaseService {
*/
seedFromConfigFile() {
try {
const fs = require('fs');
const path = require('path');
const configPath = path.join(__dirname, '..', '..', 'config.json');
const fs = require("fs");
const path = require("path");
const configPath = path.join(__dirname, "..", "..", "config.json");
if (!fs.existsSync(configPath)) {
console.log('No config.json file found, skipping seed');
console.log("No config.json file found, skipping seed");
return;
}
const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
const config = JSON.parse(fs.readFileSync(configPath, "utf-8"));
if (!config.discord?.guilds) {
console.log('No guilds found in config.json, skipping seed');
console.log("No guilds found in config.json, skipping seed");
return;
}
// Handle both array and object formats for backward compatibility
const guilds = Array.isArray(config.discord.guilds)
? config.discord.guilds
: Object.values(config.discord.guilds);
// Expect guilds to be an array
const guilds = config.discord.guilds;
if (!Array.isArray(guilds)) {
console.log("Config guilds must be an array format, skipping seed");
return;
}
let seededCount = 0;
for (const guild of guilds) {
if (!guild.id) {
console.warn('Skipping guild with missing ID:', guild);
console.warn("Skipping guild with missing ID:", guild);
continue;
}
// Convert old config format to new format
// Convert config format to database format
const guildConfig = {
id: guild.id,
name: guild.internalName || guild.name || 'Unknown Guild',
internalName: guild.internalName || guild.name || 'Unknown Guild',
prefix: guild.prefix || '!',
name: guild.internalName || guild.name || "Unknown Guild",
internalName: guild.internalName || guild.name || "Unknown Guild",
prefix: guild.prefix || "!",
enableSfx: guild.enableSfx !== false,
allowedSfxChannels: guild.allowedSfxChannels || null,
sfxVolume: guild.sfxVolume || 0.5,
enableFunFacts: guild.enableFunFacts !== false,
enableHamFacts: guild.enableHamFacts !== false,
allowedRolesForRequest: guild.allowedRolesForRequest || null,
allowedRolesForRequest: Array.isArray(guild.allowedRolesForRequest)
? guild.allowedRolesForRequest.filter(
(id) => id && id.trim() !== ""
)
: [],
};
// Insert guild configuration
this.upsertGuildConfig(guildConfig);
// Insert scheduled events if they exist
if (guild.scheduledEvents && Array.isArray(guild.scheduledEvents)) {
for (const event of guild.scheduledEvents) {
if (event.id && event.schedule) {
try {
console.log(`Importing scheduled event: ${event.id} for guild ${guild.id}`);
console.log(
`Importing scheduled event: ${event.id} for guild ${guild.id}`
);
this.addScheduledEvent(guild.id, event);
} catch (error) {
console.warn(`Skipping scheduled event ${event.id} for guild ${guild.id}:`, error.message);
console.warn('Event object:', JSON.stringify(event, null, 2));
console.warn(
`Skipping scheduled event ${event.id} for guild ${guild.id}:`,
error.message
);
console.warn("Event object:", JSON.stringify(event, null, 2));
}
}
}
}
seededCount++;
}
console.log(`✅ Successfully seeded database with ${seededCount} guild(s) from config.json`);
console.log(
`✅ Successfully seeded database with ${seededCount} guild(s) from config.json`
);
// Update bot configuration in database from file config
if (config.botName) {
this.setBotConfig('bot_name', config.botName);
this.setBotConfig("bot_name", config.botName);
}
if (config.debug !== undefined) {
this.setBotConfig('debug', config.debug.toString());
this.setBotConfig("debug", config.debug.toString());
}
if (config.discord?.adminUserId) {
this.setBotConfig('admin_user_id', config.discord.adminUserId);
this.setBotConfig("admin_user_id", config.discord.adminUserId);
}
if (config.discord?.activities && Array.isArray(config.discord.activities)) {
this.setBotConfig('activities', JSON.stringify(config.discord.activities));
if (
config.discord?.activities &&
Array.isArray(config.discord.activities)
) {
this.setBotConfig(
"activities",
JSON.stringify(config.discord.activities)
);
}
if (config.discord?.blacklistedUsers && Array.isArray(config.discord.blacklistedUsers)) {
this.setBotConfig('blacklisted_users', JSON.stringify(config.discord.blacklistedUsers));
if (
config.discord?.blacklistedUsers &&
Array.isArray(config.discord.blacklistedUsers)
) {
this.setBotConfig(
"blacklisted_users",
JSON.stringify(config.discord.blacklistedUsers)
);
}
console.log('✅ Bot configuration updated from config.json');
console.log("✅ Bot configuration updated from config.json");
} catch (error) {
console.error('Error seeding database from config file:', error);
console.error("Error seeding database from config file:", error);
}
}
@@ -197,13 +226,17 @@ class DatabaseService {
prepareStatements() {
this.statements = {
// Guild operations
getGuild: this.db.prepare('SELECT * FROM guilds WHERE id = ? AND is_active = true'),
getAllGuilds: this.db.prepare('SELECT * FROM guilds WHERE is_active = true'),
getGuild: this.db.prepare(
"SELECT * FROM guilds WHERE id = ? AND is_active = true"
),
getAllGuilds: this.db.prepare(
"SELECT * FROM guilds WHERE is_active = true"
),
insertGuild: this.db.prepare(`
INSERT OR REPLACE INTO guilds
(id, name, internal_name, prefix, enable_sfx, allowed_sfx_channels, sfx_volume,
enable_fun_facts, enable_ham_facts, allowed_roles_for_request, is_active, updated_at, removed_at)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, true, CURRENT_TIMESTAMP, NULL)
enable_fun_facts, enable_ham_facts, allowed_roles_for_request)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
`),
updateGuild: this.db.prepare(`
UPDATE guilds SET
@@ -220,19 +253,25 @@ class DatabaseService {
UPDATE guilds SET is_active = true, removed_at = NULL, updated_at = CURRENT_TIMESTAMP
WHERE id = ?
`),
hardDeleteGuild: this.db.prepare('DELETE FROM guilds WHERE id = ?'),
hardDeleteGuild: this.db.prepare("DELETE FROM guilds WHERE id = ?"),
// Scheduled events
getScheduledEvents: this.db.prepare('SELECT * FROM scheduled_events WHERE guild_id = ? AND enabled = true'),
getScheduledEvents: this.db.prepare(
"SELECT * FROM scheduled_events WHERE guild_id = ? AND enabled = true"
),
insertScheduledEvent: this.db.prepare(`
INSERT OR REPLACE INTO scheduled_events
(guild_id, event_id, schedule, channel_id, message, ping_role_id, enabled)
VALUES (?, ?, ?, ?, ?, ?, ?)
`),
deleteScheduledEvent: this.db.prepare('DELETE FROM scheduled_events WHERE guild_id = ? AND event_id = ?'),
deleteScheduledEvent: this.db.prepare(
"DELETE FROM scheduled_events WHERE guild_id = ? AND event_id = ?"
),
// Bot config
getBotConfig: this.db.prepare('SELECT value FROM bot_config WHERE key = ?'),
getBotConfig: this.db.prepare(
"SELECT value FROM bot_config WHERE key = ?"
),
setBotConfig: this.db.prepare(`
INSERT OR REPLACE INTO bot_config (key, value, updated_at)
VALUES (?, ?, CURRENT_TIMESTAMP)
@@ -242,7 +281,7 @@ class DatabaseService {
/**
* Get guild configuration
* @param {string} guildId
* @param {string} guildId
* @returns {Object|null}
*/
getGuildConfig(guildId) {
@@ -259,7 +298,9 @@ class DatabaseService {
sfxVolume: guild.sfx_volume,
enableFunFacts: Boolean(guild.enable_fun_facts),
enableHamFacts: Boolean(guild.enable_ham_facts),
allowedRolesForRequest: guild.allowed_roles_for_request,
allowedRolesForRequest: this.parseRoleIds(
guild.allowed_roles_for_request
),
};
}
@@ -269,7 +310,7 @@ class DatabaseService {
*/
getAllGuildConfigs() {
const guilds = this.statements.getAllGuilds.all();
return guilds.map(guild => ({
return guilds.map((guild) => ({
id: guild.id,
name: guild.name,
internalName: guild.internal_name,
@@ -285,13 +326,15 @@ class DatabaseService {
/**
* Add or update guild configuration
* @param {Object} guildConfig
* @param {Object} guildConfig
* @param {boolean} isReactivation - Whether this is reactivating an existing guild
*/
upsertGuildConfig(guildConfig, isReactivation = false) {
if (isReactivation) {
// Check if guild exists but is inactive
const existingGuild = this.db.prepare('SELECT * FROM guilds WHERE id = ?').get(guildConfig.id);
const existingGuild = this.db
.prepare("SELECT * FROM guilds WHERE id = ?")
.get(guildConfig.id);
if (existingGuild && !existingGuild.is_active) {
// Reactivate existing guild and update its info
this.statements.reactivateGuild.run(guildConfig.id);
@@ -308,7 +351,9 @@ class DatabaseService {
existingGuild.allowed_roles_for_request,
guildConfig.id
);
console.log(`Guild reactivated with existing configuration: ${guildConfig.name} (${guildConfig.id})`);
console.log(
`Guild reactivated with existing configuration: ${guildConfig.name} (${guildConfig.id})`
);
return;
}
}
@@ -318,21 +363,23 @@ class DatabaseService {
guildConfig.id,
guildConfig.name,
guildConfig.internalName || guildConfig.name,
guildConfig.prefix || '!',
guildConfig.prefix || "!",
guildConfig.enableSfx !== false ? 1 : 0,
guildConfig.allowedSfxChannels || null,
guildConfig.sfxVolume || 0.5,
guildConfig.enableFunFacts !== false ? 1 : 0,
guildConfig.enableHamFacts !== false ? 1 : 0,
guildConfig.allowedRolesForRequest || null
JSON.stringify(guildConfig.allowedRolesForRequest || [])
);
console.log(
`Guild configuration saved: ${guildConfig.name} (${guildConfig.id})`
);
console.log(`Guild configuration saved: ${guildConfig.name} (${guildConfig.id})`);
}
/**
* Soft delete guild configuration (can be restored)
* @param {string} guildId
* @param {string} guildId
*/
softDeleteGuildConfig(guildId) {
const result = this.statements.softDeleteGuild.run(guildId);
@@ -344,7 +391,7 @@ class DatabaseService {
/**
* Hard delete guild configuration (permanent)
* @param {string} guildId
* @param {string} guildId
*/
hardDeleteGuildConfig(guildId) {
const result = this.statements.hardDeleteGuild.run(guildId);
@@ -356,11 +403,13 @@ class DatabaseService {
/**
* Check if guild exists (including inactive)
* @param {string} guildId
* @param {string} guildId
* @returns {Object|null}
*/
getGuildConfigIncludingInactive(guildId) {
const guild = this.db.prepare('SELECT * FROM guilds WHERE id = ?').get(guildId);
const guild = this.db
.prepare("SELECT * FROM guilds WHERE id = ?")
.get(guildId);
if (!guild) return null;
return {
@@ -381,22 +430,22 @@ class DatabaseService {
/**
* Get scheduled events for a guild
* @param {string} guildId
* @param {string} guildId
* @returns {Array}
*/
getScheduledEvents(guildId) {
const events = this.statements.getScheduledEvents.all(guildId);
// Parse schedule strings back to objects/strings for node-schedule
return events.map(event => ({
return events.map((event) => ({
...event,
schedule: this.parseSchedule(event.schedule)
schedule: this.parseSchedule(event.schedule),
}));
}
/**
* Parse schedule string back to object or cron string
* @param {string} scheduleString
* @param {string} scheduleString
* @returns {Object|string}
*/
parseSchedule(scheduleString) {
@@ -411,14 +460,15 @@ class DatabaseService {
/**
* Add scheduled event
* @param {string} guildId
* @param {Object} event
* @param {string} guildId
* @param {Object} event
*/
addScheduledEvent(guildId, event) {
// Store schedule as JSON string to preserve object format and timezone
const scheduleString = typeof event.schedule === 'string'
? event.schedule
: JSON.stringify(event.schedule);
const scheduleString =
typeof event.schedule === "string"
? event.schedule
: JSON.stringify(event.schedule);
this.statements.insertScheduledEvent.run(
guildId,
@@ -433,8 +483,8 @@ class DatabaseService {
/**
* Remove scheduled event
* @param {string} guildId
* @param {string} eventId
* @param {string} guildId
* @param {string} eventId
*/
removeScheduledEvent(guildId, eventId) {
this.statements.deleteScheduledEvent.run(guildId, eventId);
@@ -442,7 +492,7 @@ class DatabaseService {
/**
* Get bot configuration value
* @param {string} key
* @param {string} key
* @returns {string|null}
*/
getBotConfig(key) {
@@ -452,8 +502,8 @@ class DatabaseService {
/**
* Set bot configuration value
* @param {string} key
* @param {string} value
* @param {string} key
* @param {string} value
*/
setBotConfig(key, value) {
this.statements.setBotConfig.run(key, value);
@@ -464,11 +514,13 @@ class DatabaseService {
* @returns {Object}
*/
getBotConfiguration() {
const botName = this.getBotConfig('bot_name') || 'GHBot';
const debug = this.getBotConfig('debug') === 'true';
const adminUserId = this.getBotConfig('admin_user_id') || '';
const activities = JSON.parse(this.getBotConfig('activities') || '[]');
const blacklistedUsers = JSON.parse(this.getBotConfig('blacklisted_users') || '[]');
const botName = this.getBotConfig("bot_name") || "GHBot";
const debug = this.getBotConfig("debug") === "true";
const adminUserId = this.getBotConfig("admin_user_id") || "";
const activities = JSON.parse(this.getBotConfig("activities") || "[]");
const blacklistedUsers = JSON.parse(
this.getBotConfig("blacklisted_users") || "[]"
);
return {
botName,
@@ -479,6 +531,67 @@ class DatabaseService {
};
}
/**
* Parse role IDs from JSON string
* @param {string} roleIdsJson
* @returns {Array<string>}
*/
parseRoleIds(roleIdsJson) {
try {
return JSON.parse(roleIdsJson || "[]");
} catch {
return [];
}
}
/**
* Get allowed role IDs for a guild
* @param {string} guildId
* @returns {Array<string>}
*/
getAllowedRoleIds(guildId) {
const guild = this.statements.getGuild.get(guildId);
return guild ? this.parseRoleIds(guild.allowed_roles_for_request) : [];
}
/**
* Add a role ID to the allowed list
* @param {string} guildId
* @param {string} roleId
*/
addAllowedRole(guildId, roleId) {
const currentRoles = this.getAllowedRoleIds(guildId);
if (!currentRoles.includes(roleId)) {
currentRoles.push(roleId);
this.updateAllowedRoleIds(guildId, currentRoles);
}
}
/**
* Remove a role ID from the allowed list
* @param {string} guildId
* @param {string} roleId
*/
removeAllowedRole(guildId, roleId) {
const currentRoles = this.getAllowedRoleIds(guildId);
const updatedRoles = currentRoles.filter((id) => id !== roleId);
if (updatedRoles.length !== currentRoles.length) {
this.updateAllowedRoleIds(guildId, updatedRoles);
}
}
/**
* Update allowed role IDs for a guild
* @param {string} guildId
* @param {Array<string>} roleIds
*/
updateAllowedRoleIds(guildId, roleIds) {
const updateStmt = this.db.prepare(
"UPDATE guilds SET allowed_roles_for_request = ?, updated_at = CURRENT_TIMESTAMP WHERE id = ? AND is_active = true"
);
updateStmt.run(JSON.stringify(roleIds), guildId);
}
/**
* Close database connection
*/
@@ -489,4 +602,4 @@ class DatabaseService {
}
}
module.exports = new DatabaseService();
module.exports = new DatabaseService();