Make bot suitable for multiple servers #67
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,4 +3,5 @@ | |
| /node_modules/ | ||
| yarn-error.log | ||
| /build/ | ||
| settings.json | ||
| settings.db | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,6 +16,7 @@ | |
| "dependencies": { | ||
| "discord.js": "^14.11.0", | ||
| "dotenv": "^16.0.0", | ||
| "express": "^4.18.1", | ||
| "sqlite3": "^5.1.2" | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,9 @@ import { | |
| ThreadChannel, | ||
| ThreadMember, | ||
| TextBasedChannel, | ||
| Guild, | ||
| NonThreadGuildBasedChannel, | ||
| DMChannel, | ||
| GatewayIntentBits, | ||
| BaseMessageOptions, | ||
| } from 'discord.js'; | ||
|
|
@@ -16,13 +19,15 @@ import RoleChannelManager from './roles/RoleChannelManager'; | |
| import Settings from './Settings'; | ||
| import DMManager from './twitch/DMManager'; | ||
| import FeatureChecker from './FeatureChecker'; | ||
| import GuildSettings from './settings/GuildSettings'; | ||
| import Common from './common'; | ||
| import { EmbedBuilder } from '@discordjs/builders'; | ||
|
|
||
| /** | ||
| * The discord client handler and initializer of the bot | ||
| */ | ||
| export default class DiscordClient { | ||
| public static _client: Client = new Client({ | ||
| intents: [ | ||
| GatewayIntentBits.Guilds, | ||
| GatewayIntentBits.GuildMessages, | ||
|
|
@@ -31,44 +36,121 @@ export default class DiscordClient { | |
| ], | ||
| }); | ||
|
|
||
| public static _safeGuilds: Guild[] = []; | ||
|
|
||
| constructor() { | ||
| DiscordClient._client.on('ready', this.onReady.bind(this)); | ||
| DiscordClient._client.on('threadCreate', this.onThreadCreate); | ||
| DiscordClient._client.on('guildCreate', this.onGuildJoin.bind(this)); | ||
| DiscordClient._client.on('channelCreate', this.onChannelCreate.bind(this)); | ||
| DiscordClient._client.on('channelDelete', this.onChannelDelete.bind(this)); | ||
| DiscordClient._client.on('channelUpdate', this.onChannelUpdate.bind(this)); | ||
| } | ||
|
|
||
| /** | ||
| * Logs the discord client into the discord api and starts the handlers | ||
| */ | ||
| login(): void { | ||
| DiscordClient._client.login(process.env.DISCORD_TOKEN).catch(console.error); | ||
| } | ||
|
|
||
| /** | ||
| * Fires when the Discord bot is ready | ||
| */ | ||
| private async onReady(): Promise<void> { | ||
| await new FeatureChecker().check(); | ||
| new MessageHandler(); | ||
| new ReactionHandler(); | ||
| if (this.twitchEnabled()) this.startTwitch(); | ||
| this.joinAllThreads(); | ||
| new TalkingChannel(); | ||
| if (!DiscordClient._client.application?.owner) | ||
| await DiscordClient._client.application?.fetch().catch(console.error); | ||
| MessageHandler.addCommands(); | ||
| for (const guild of DiscordClient._safeGuilds) { | ||
| const mgr: RoleChannelManager = Common.getRoleChannelManager(guild); | ||
| if (await this.rolesEnabled(guild.id)) mgr.run(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Sets the bot up to be ready for a guild | ||
| * @param guild The guild the bot joined | ||
| */ | ||
| private async onGuildJoin(guild: Guild): Promise<void> { | ||
| new FeatureChecker().checkGuild(guild); | ||
| if (this.twitchEnabled()) new LiveChannel(guild); | ||
| const mgr: RoleChannelManager = Common.getRoleChannelManager(guild); | ||
| if (await this.rolesEnabled(guild.id)) mgr.run(); | ||
| } | ||
|
|
||
| /** | ||
| * Checks if the created channel is a roles channel and retries executing the RolesChannelManager | ||
| * @param channel The channel that was created | ||
| */ | ||
| private async onChannelCreate( | ||
| channel: NonThreadGuildBasedChannel | ||
| ): Promise<void> { | ||
| if ( | ||
| channel.name === 'roles' && | ||
| (await this.rolesEnabled(channel.guildId)) | ||
| ) { | ||
| const mgr: RoleChannelManager = Common.getRoleChannelManager( | ||
| channel.guild | ||
| ); | ||
| if (mgr._channel === undefined) mgr.run(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Fires whenever a channel gets deleted | ||
| * @param channel The deleted channel | ||
| */ | ||
| private async onChannelDelete( | ||
| channel: DMChannel | NonThreadGuildBasedChannel | ||
| ): Promise<void> { | ||
| if (!channel.isDMBased()) | ||
| Common.getRoleChannelManager(channel.guild).onChannelDelete(channel); | ||
| } | ||
|
|
||
| /** | ||
| * Fires whenever there is a channel update (e. g. renaming) | ||
| * @param oldChannel The old channel | ||
| * @param newChannel The new channel | ||
| */ | ||
| private async onChannelUpdate( | ||
| oldChannel: DMChannel | NonThreadGuildBasedChannel, | ||
| newChannel: DMChannel | NonThreadGuildBasedChannel | ||
| ): Promise<void> { | ||
| if (!oldChannel.isDMBased() && !newChannel.isDMBased()) | ||
| Common.getRoleChannelManager(oldChannel.guild).onChannelUpdate( | ||
| oldChannel, | ||
| newChannel | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Checks if the bot has been set up correctly to use Twitch | ||
| * @returns Whether Twitch is ready to be used | ||
| */ | ||
| private twitchEnabled(): boolean { | ||
| return Settings.settings['twitch-id'] !== '' && !!process.env.TWITCH_TOKEN; | ||
| } | ||
|
|
||
| /** | ||
| * Checks if specified guild has roles enabled | ||
| * @param guildId The guild id to check | ||
| * @returns Whether roles are enabled in the guild | ||
| */ | ||
| private async rolesEnabled(guildId: string): Promise<boolean> { | ||
| return (await GuildSettings.settings(guildId)).roles.length !== 0; | ||
| } | ||
|
|
||
| /** | ||
| * Joins all threads to be available there | ||
| */ | ||
| private joinAllThreads(): void { | ||
| for (const guild of DiscordClient._safeGuilds) | ||
| for (const threadChannel of ( | ||
| guild.channels.cache.filter( | ||
| (channel: GuildChannel | ThreadChannel): boolean => | ||
|
|
@@ -86,7 +168,7 @@ export default class DiscordClient { | |
| * Starts doing stuff with Twitch for the #live channel and DM notification handling | ||
| */ | ||
| private startTwitch(): void { | ||
| for (const guild of DiscordClient._safeGuilds) new LiveChannel(guild); | ||
| new DMManager(); | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,8 @@ | ||
| import { Guild } from 'discord.js'; | ||
| import DiscordClient from './DiscordClient'; | ||
| import Settings from './Settings'; | ||
| import GuildSettings from './settings/GuildSettings'; | ||
| import { GuildInfo } from './settings/SettingsDB'; | ||
|
|
||
| /** | ||
| * Checks what features are enabled in the settings | ||
|
|
@@ -14,22 +18,17 @@ export default class FeatureChecker { | |
| */ | ||
| #crash: boolean = false; | ||
|
|
||
| public async check() { | ||
| if (Settings.settings.logging === 'verbose') | ||
| this.status('Logging set to verbose'); | ||
| for (const guild of DiscordClient._client.guilds.cache.toJSON()) | ||
| await this.checkGuild(guild); | ||
|
|
||
| if (Settings.settings['twitch-id']) | ||
| if (process.env.TWITCH_TOKEN) this.status('Twitch enabled'); | ||
| else this.warning('No Twitch token provided'); | ||
| else if (process.env.TWITCH_TOKEN) this.warning('No Twitch ID provided'); | ||
| else this.status('Twitch disabled'); | ||
| if ( | ||
| process.argv[ | ||
| process.argv.findIndex((value: string): boolean => value === '-r') + 1 | ||
|
|
@@ -42,6 +41,42 @@ export default class FeatureChecker { | |
| if (this.#crash) process.exit(1); | ||
| } | ||
|
|
||
| public async checkGuild(guild: Guild): Promise<void> { | ||
| const guildInfo: string = `for guild ${guild.id} (${guild.name})`; | ||
| let error: boolean = false; | ||
| try { | ||
| const info: GuildInfo = await GuildSettings.settings(guild.id); | ||
| if (info.permissionRoles.length === 0) | ||
| this.status(`No permitted roles set for ${guildInfo}`); | ||
| if (info.roles.length === 0) this.status(`Roles disabled ${guildInfo}`); | ||
| else this.status(`Roles enabled ${guildInfo}`); | ||
| if (info.roles.length > 25) { | ||
| error = true; | ||
| this.error( | ||
| `Currently, only a maximum of 25 roles is allowed. Guild ${guild.id} (${guild.name}) has more than 25 roles. If you need more, file an issue at https://github.com/TrojanerHD/TrojanerBot/issues/new`, | ||
| false | ||
| ); | ||
| } | ||
| } catch (e: unknown) { | ||
| error = true; | ||
| this.error( | ||
| `Could not load information ${guildInfo} with reason ${e}`, | ||
| false | ||
| ); | ||
| } finally { | ||
| if (!error) { | ||
| DiscordClient._safeGuilds.push(guild); | ||
|
There was a problem hiding this comment. Check if safe guilds doesn't already have this guild to make this function safe when re-executing |
||
| if (!GuildSettings.settings(guild.id)) | ||
| await GuildSettings.saveSettings(guild, { | ||
| permissionRoles: [], | ||
| roles: [], | ||
| streamers: [], | ||
| refreshToken: '', | ||
| }).catch(console.error); | ||
| } else this.warning(`Limited features due to problems ${guildInfo}`); | ||
|
There was a problem hiding this comment. Remove a guild from the safe guilds if there was a problem to make this function safe when re-executing |
||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Appends a warning to the log output | ||
| * @param message The warning message to append | ||
|
|
@@ -63,9 +98,10 @@ export default class FeatureChecker { | |
| /** | ||
| * Appends an error to the log output and will crash the bot | ||
| * @param message The error message to append | ||
| * @param crash Whether to crash the bot | ||
| */ | ||
| private error(message: string, crash: boolean = true): void { | ||
| this.#message += `Error: ${message}\n`; | ||
| if (!this.#crash) this.#crash = crash; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,8 +9,9 @@ import { | |
| import DiscordClient from './DiscordClient'; | ||
| import assignRoles from './roles/assignRoles'; | ||
| import MessageHandler from './messages/MessageHandler'; | ||
| import { RolesField } from './settings/SettingsDB'; | ||
| import { ActionRowBuilder, ButtonBuilder } from '@discordjs/builders'; | ||
| import GuildSettings from './settings/GuildSettings'; | ||
|
|
||
| /** | ||
| * Handles reactions (button presses, slash-commands) | ||
|
|
@@ -26,14 +27,16 @@ export default class ReactionHandler { | |
| * Fires whenever an interaction has been made | ||
| * @param interaction The interaction that has happened | ||
| */ | ||
| private async onReaction(interaction: Interaction): Promise<void> { | ||
| // Checks whether the interaction was a button | ||
| if (interaction.isButton()) { | ||
| // If the id of the button is a role name, the interaction's origin is from the role picker | ||
| const settingsRole: RolesField | undefined = interaction.guildId | ||
| ? (await GuildSettings.settings(interaction.guildId)).roles.find( | ||
| (role: RolesField): boolean => | ||
| role.name.toLowerCase() === interaction.customId | ||
| ) | ||
| : undefined; | ||
| if (settingsRole !== undefined) { | ||
| // Hack to not reply with anything | ||
| interaction.reply({}).catch((reason: any): void => { | ||
|
|
@@ -62,7 +65,8 @@ export default class ReactionHandler { | |
| interaction | ||
| .reply({ | ||
| content: 'Select your roles', | ||
| components: await this.generateRoleSelectorComponent( | ||
| interaction.guildId, | ||
| interaction.member as GuildMember | null | ||
| ), | ||
| ephemeral: true, | ||
|
|
@@ -81,19 +85,24 @@ export default class ReactionHandler { | |
|
|
||
| /** | ||
| * Generates a role selector component with all selectable roles | ||
| * @param guild The guild the role selector is being generated for | ||
| * @param member The guild member the selector is created for | ||
TrojanerHD marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * @returns A message action row array containing all selectable roles | ||
| */ | ||
| private async generateRoleSelectorComponent( | ||
| guild: string | null, | ||
| member: GuildMember | null | ||
| ): Promise<ActionRowBuilder<ButtonBuilder>[]> { | ||
| const messageActionRows: ActionRowBuilder<ButtonBuilder>[] = []; | ||
| if (guild === null) return []; | ||
|
|
||
| const roles: RolesField[] = (await GuildSettings.settings(guild)).roles; | ||
| // Every row can contain up to five roles | ||
| for (let i = 0; i < roles.length / 5; i++) { | ||
| // Add the current five roles as component | ||
| const currentMessageActionRow: ActionRowBuilder<ButtonBuilder> = | ||
| new ActionRowBuilder<ButtonBuilder>().addComponents( | ||
| roles.slice(i * 5, i * 5 + 5).map( | ||
| // Map the roles stored in settings | ||
| (role: RolesField): ButtonBuilder => | ||
| new ButtonBuilder() | ||
|
|
@@ -127,7 +136,8 @@ export default class ReactionHandler { | |
| interaction | ||
| .editReply({ | ||
| content: 'Select your roles', | ||
| components: await this.generateRoleSelectorComponent( | ||
| interaction.guildId, | ||
| interaction.member as GuildMember | null | ||
| ), | ||
| }) | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.