1 files changed, 431 insertions, 0 deletions
diff --git a/lib/models/instance/Guild.ts b/lib/models/instance/Guild.ts
new file mode 100644
index 0000000..f258d48
--- /dev/null
+++ b/lib/models/instance/Guild.ts
@@ -0,0 +1,431 @@
+import { ChannelType, Constants, type Snowflake } from 'discord.js';
+import { type Sequelize } from 'sequelize';
+import { BadWordDetails } from '../../automod/AutomodShared.js';
+import { type BushClient } from '../../extensions/discord-akairo/BushClient.js';
+import { BaseModel } from '../BaseModel.js';
+const { DataTypes } = (await import('sequelize')).default;
+
+export interface GuildModel {
+	id: Snowflake;
+	prefix: string;
+	autoPublishChannels: Snowflake[];
+	blacklistedChannels: Snowflake[];
+	blacklistedUsers: Snowflake[];
+	welcomeChannel: Snowflake | null;
+	muteRole: Snowflake | null;
+	punishmentEnding: string | null;
+	disabledCommands: string[];
+	lockdownChannels: Snowflake[];
+	autoModPhases: BadWordDetails[];
+	enabledFeatures: GuildFeatures[];
+	joinRoles: Snowflake[];
+	logChannels: LogChannelDB;
+	bypassChannelBlacklist: Snowflake[];
+	noXpChannels: Snowflake[];
+	levelRoles: { [level: number]: Snowflake };
+	levelUpChannel: Snowflake | null;
+}
+
+export interface GuildModelCreationAttributes {
+	id: Snowflake;
+	prefix?: string;
+	autoPublishChannels?: Snowflake[];
+	blacklistedChannels?: Snowflake[];
+	blacklistedUsers?: Snowflake[];
+	welcomeChannel?: Snowflake;
+	muteRole?: Snowflake;
+	punishmentEnding?: string;
+	disabledCommands?: string[];
+	lockdownChannels?: Snowflake[];
+	autoModPhases?: BadWordDetails[];
+	enabledFeatures?: GuildFeatures[];
+	joinRoles?: Snowflake[];
+	logChannels?: LogChannelDB;
+	bypassChannelBlacklist?: Snowflake[];
+	noXpChannels?: Snowflake[];
+	levelRoles?: { [level: number]: Snowflake };
+	levelUpChannel?: Snowflake;
+}
+
+/**
+ * Settings for a guild.
+ */
+export class Guild extends BaseModel<GuildModel, GuildModelCreationAttributes> implements GuildModel {
+	/**
+	 * The ID of the guild
+	 */
+	public declare id: Snowflake;
+
+	/**
+	 * The bot's prefix for the guild
+	 */
+	public declare prefix: string;
+
+	/**
+	 * Channels that will have their messages automatically published
+	 */
+	public declare autoPublishChannels: Snowflake[];
+
+	/**
+	 * Channels where the bot won't respond in.
+	 */
+	public declare blacklistedChannels: Snowflake[];
+
+	/**
+	 * Users that the bot ignores in this guild
+	 */
+	public declare blacklistedUsers: Snowflake[];
+
+	/**
+	 * The channels where the welcome messages are sent
+	 */
+	public declare welcomeChannel: Snowflake | null;
+
+	/**
+	 * The role given out when muting someone
+	 */
+	public declare muteRole: Snowflake | null;
+
+	/**
+	 * The message that gets sent after someone gets a punishment dm
+	 */
+	public declare punishmentEnding: string | null;
+
+	/**
+	 * Guild specific disabled commands
+	 */
+	public declare disabledCommands: string[];
+
+	/**
+	 * Channels that should get locked down when the lockdown command gets used.
+	 */
+	public declare lockdownChannels: Snowflake[];
+
+	/**
+	 * Custom automod phases
+	 */
+	public declare autoModPhases: BadWordDetails[];
+
+	/**
+	 * The features enabled in a guild
+	 */
+	public declare enabledFeatures: GuildFeatures[];
+
+	/**
+	 * The roles to assign to a user if they are not assigned sticky roles
+	 */
+	public declare joinRoles: Snowflake[];
+
+	/**
+	 * The channels where logging messages will be sent.
+	 */
+	public declare logChannels: LogChannelDB;
+
+	/**
+	 * These users will be able to use commands in channels blacklisted
+	 */
+	public declare bypassChannelBlacklist: Snowflake[];
+
+	/**
+	 * Channels where users will not earn xp for leveling.
+	 */
+	public declare noXpChannels: Snowflake[];
+
+	/**
+	 * What roles get given to users when they reach certain levels.
+	 */
+	public declare levelRoles: { [level: number]: Snowflake };
+
+	/**
+	 * The channel to send level up messages in instead of last channel.
+	 */
+	public declare levelUpChannel: Snowflake | null;
+
+	/**
+	 * Initializes the model.
+	 * @param sequelize The sequelize instance.
+	 */
+	public static initModel(sequelize: Sequelize, client: BushClient): void {
+		Guild.init(
+			{
+				id: { type: DataTypes.STRING, primaryKey: true },
+				prefix: { type: DataTypes.TEXT, allowNull: false, defaultValue: client.config.prefix },
+				autoPublishChannels: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
+				blacklistedChannels: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
+				blacklistedUsers: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
+				welcomeChannel: { type: DataTypes.STRING, allowNull: true },
+				muteRole: { type: DataTypes.STRING, allowNull: true },
+				punishmentEnding: { type: DataTypes.TEXT, allowNull: true },
+				disabledCommands: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
+				lockdownChannels: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
+				autoModPhases: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
+				enabledFeatures: {
+					type: DataTypes.JSONB,
+					allowNull: false,
+					defaultValue: Object.keys(guildFeaturesObj).filter(
+						(key) => guildFeaturesObj[key as keyof typeof guildFeaturesObj].default
+					)
+				},
+				joinRoles: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
+				logChannels: { type: DataTypes.JSONB, allowNull: false, defaultValue: {} },
+				bypassChannelBlacklist: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
+				noXpChannels: { type: DataTypes.JSONB, allowNull: false, defaultValue: [] },
+				levelRoles: { type: DataTypes.JSONB, allowNull: false, defaultValue: {} },
+				levelUpChannel: { type: DataTypes.STRING, allowNull: true }
+			},
+			{ sequelize }
+		);
+	}
+}
+
+export type BaseGuildSetting = 'channel' | 'role' | 'user';
+export type GuildNoArraySetting = 'string' | 'custom' | BaseGuildSetting;
+export type GuildSettingType = GuildNoArraySetting | `${BaseGuildSetting}-array`;
+
+export interface GuildSetting {
+	name: string;
+	description: string;
+	type: GuildSettingType;
+	subType: ChannelType[] | undefined;
+	configurable: boolean;
+	replaceNullWith: () => string | null;
+}
+const asGuildSetting = <T>(et: { [K in keyof T]: PartialBy<GuildSetting, 'configurable' | 'subType' | 'replaceNullWith'> }) => {
+	for (const key in et) {
+		et[key].subType ??= undefined;
+		et[key].configurable ??= true;
+		et[key].replaceNullWith ??= () => null;
+	}
+	return et as { [K in keyof T]: GuildSetting };
+};
+
+const { default: config } = await import('../../../config/options.js');
+
+export const guildSettingsObj = asGuildSetting({
+	prefix: {
+		name: 'Prefix',
+		description: 'The phrase required to trigger text commands in this server.',
+		type: 'string',
+		replaceNullWith: () => config.prefix
+	},
+	autoPublishChannels: {
+		name: 'Auto Publish Channels',
+		description: 'Channels were every message is automatically published.',
+		type: 'channel-array',
+		subType: [ChannelType.GuildNews]
+	},
+	welcomeChannel: {
+		name: 'Welcome Channel',
+		description: 'The channel where the bot will send join and leave message.',
+		type: 'channel',
+		subType: [
+			ChannelType.GuildText,
+			ChannelType.GuildNews,
+			ChannelType.GuildNewsThread,
+			ChannelType.GuildPublicThread,
+			ChannelType.GuildPrivateThread
+		]
+	},
+	muteRole: {
+		name: 'Mute Role',
+		description: 'The role assigned when muting someone.',
+		type: 'role'
+	},
+	punishmentEnding: {
+		name: 'Punishment Ending',
+		description: 'The message after punishment information to a user in a dm.',
+		type: 'string'
+	},
+	lockdownChannels: {
+		name: 'Lockdown Channels',
+		description: 'Channels that are locked down when a mass lockdown is specified.',
+		type: 'channel-array',
+		subType: [ChannelType.GuildText]
+	},
+	joinRoles: {
+		name: 'Join Roles',
+		description: 'Roles assigned to users on join who do not have sticky role information.',
+		type: 'role-array'
+	},
+	bypassChannelBlacklist: {
+		name: 'Bypass Channel Blacklist',
+		description: 'These users will be able to use commands in channels blacklisted.',
+		type: 'user-array'
+	},
+	logChannels: {
+		name: 'Log Channels',
+		description: 'The channel were logs are sent.',
+		type: 'custom',
+		subType: [ChannelType.GuildText],
+		configurable: false
+	},
+	autoModPhases: {
+		name: 'Automod Phases',
+		description: 'Custom phrases to be detected by automod.',
+		type: 'custom',
+		configurable: false
+	},
+	noXpChannels: {
+		name: 'No Xp Channels',
+		description: 'Channels where users will not earn xp for leveling.',
+		type: 'channel-array',
+		subType: Constants.TextBasedChannelTypes.filter((type) => type !== ChannelType.DM)
+	},
+	levelRoles: {
+		name: 'Level Roles',
+		description: 'What roles get given to users when they reach certain levels.',
+		type: 'custom',
+		configurable: false
+	},
+	levelUpChannel: {
+		name: 'Level Up Channel',
+		description: 'The channel to send level up messages in instead of last channel.',
+		type: 'channel',
+		subType: Constants.TextBasedChannelTypes.filter((type) => type !== ChannelType.DM)
+	}
+});
+
+export type GuildSettings = keyof typeof guildSettingsObj;
+export const settingsArr = Object.keys(guildSettingsObj).filter(
+	(s) => guildSettingsObj[s as GuildSettings].configurable
+) as GuildSettings[];
+
+interface GuildFeature {
+	name: string;
+	description: string;
+	default: boolean;
+	hidden: boolean;
+}
+
+type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+const asGuildFeature = <T>(gf: { [K in keyof T]: PartialBy<GuildFeature, 'hidden' | 'default'> }): {
+	[K in keyof T]: GuildFeature;
+} => {
+	for (const key in gf) {
+		gf[key].hidden ??= false;
+		gf[key].default ??= false;
+	}
+	return gf as { [K in keyof T]: GuildFeature };
+};
+
+export const guildFeaturesObj = asGuildFeature({
+	automod: {
+		name: 'Automod',
+		description: 'Deletes offensive content as well as phishing links.'
+	},
+	excludeDefaultAutomod: {
+		name: 'Exclude Default Automod',
+		description: 'Opt out of using the default automod options.'
+	},
+	excludeAutomodScamLinks: {
+		name: 'Exclude Automod Scam Links',
+		description: 'Opt out of having automod delete scam links.'
+	},
+	delScamMentions: {
+		name: 'Delete Scam Mentions',
+		description: 'Deletes messages with @everyone and @here mentions that have common scam phrases.'
+	},
+	automodPresence: {
+		name: 'Automod Presence',
+		description: 'Logs presence changes that trigger automod.',
+		hidden: true
+	},
+	automodMembers: {
+		name: 'Automod Members',
+		description: "Logs members' usernames and nicknames changes if they match automod."
+	},
+	blacklistedFile: {
+		name: 'Blacklisted File',
+		description: 'Automatically deletes malicious files.'
+	},
+	autoPublish: {
+		name: 'Auto Publish',
+		description: 'Publishes messages in configured announcement channels.'
+	},
+	// todo implement a better auto thread system
+	autoThread: {
+		name: 'Auto Thread',
+		description: 'Creates a new thread for messages in configured channels.',
+		hidden: true
+	},
+	perspectiveApi: {
+		name: 'Perspective API',
+		description: 'Use the Perspective API to detect toxicity.',
+		hidden: true
+	},
+	boosterMessageReact: {
+		name: 'Booster Message React',
+		description: 'Reacts to booster messages with the boost emoji.'
+	},
+	leveling: {
+		name: 'Leveling',
+		description: "Tracks users' messages and assigns them xp."
+	},
+	sendLevelUpMessages: {
+		name: 'Send Level Up Messages',
+		description: 'Send a message when a user levels up.',
+		default: true
+	},
+	stickyRoles: {
+		name: 'Sticky Roles',
+		description: 'Restores past roles to a user when they rejoin.'
+	},
+	reporting: {
+		name: 'Reporting',
+		description: 'Allow users to make reports.'
+	},
+	modsCanPunishMods: {
+		name: 'Mods Can Punish Mods',
+		description: 'Allow moderators to punish other moderators.'
+	},
+	logManualPunishments: {
+		name: 'Log Manual Punishments',
+		description: "Adds manual punishment to the user's modlogs and the logging channels.",
+		default: true
+	},
+	punishmentAppeals: {
+		name: 'Punishment Appeals',
+		description: 'Allow users to appeal their punishments and send the appeal to the configured channel.',
+		hidden: true
+	},
+	highlight: {
+		name: 'Highlight',
+		description: 'Allows the highlight command to be used.',
+		default: true
+	}
+});
+
+export const guildLogsObj = {
+	automod: {
+		description: 'Sends a message in this channel every time automod is activated.',
+		configurable: true
+	},
+	moderation: {
+		description: 'Sends a message in this channel every time a moderation action is performed.',
+		configurable: true
+	},
+	report: {
+		description: 'Logs user reports.',
+		configurable: true
+	},
+	error: {
+		description: 'Logs errors that occur with the bot.',
+		configurable: true
+	},
+	appeals: {
+		description: 'Where punishment appeals are sent.',
+		configurable: false
+	}
+};
+
+export type GuildLogType = keyof typeof guildLogsObj;
+export const guildLogsArr = Object.keys(guildLogsObj).filter(
+	(s) => guildLogsObj[s as GuildLogType].configurable
+) as GuildLogType[];
+type LogChannelDB = { [x in keyof typeof guildLogsObj]?: Snowflake };
+
+export type GuildFeatures = keyof typeof guildFeaturesObj;
+export const guildFeaturesArr: GuildFeatures[] = Object.keys(guildFeaturesObj).filter(
+	(f) => !guildFeaturesObj[f as keyof typeof guildFeaturesObj].hidden
+) as GuildFeatures[];