Add opt-out/opt-in commands

Allows users to be globally ignored by the bot.

src/commands/_index.ts

@@ -14,6 +14,8 @@ import { roll } from './roll.ts';
 import { handleMentions } from './handleMentions.ts';
 import { audit } from './audit.ts';
 import { heatmap } from './heatmap.ts';
+import { optOut } from './optOut.ts';
+import { optIn } from './optIn.ts';
 
 export default {
 	ping,
@@ -32,4 +34,6 @@ export default {
 	handleMentions,
 	audit,
 	heatmap,
+	optOut,
+	optIn,
 };

src/commands/help.ts

@@ -76,6 +76,16 @@ export const help = (message: DiscordenoMessage) => {
 					value: 'Heatmap of when the roll command is run the most',
 					inline: true,
 				},
+				{
+					name: `\`${config.prefix}opt-out\` or \`${config.prefix}ignore-me\``,
+					value: 'Adds you to an ignore list so the bot will never respond to you',
+					inline: true,
+				},
+				{
+					name: `\`${config.prefix}opt-in\``,
+					value: 'Removes you from the ignore list',
+					inline: true,
+				},
 				{
 					name: `\`${config.prefix}xdydzracsq!${config.postfix}\` ...`,
 					value:

src/commands/info.ts

@@ -1,3 +1,4 @@
+import config from '../../config.ts';
 import { dbClient, queries } from '../db.ts';
 import {
 	// Discordeno deps
@@ -8,16 +9,16 @@ import utils from '../utils.ts';
 
 export const info = (message: DiscordenoMessage) => {
 	// Light telemetry to see how many times a command is being run
-	dbClient.execute(queries.callIncCnt('info')).catch((e) => utils.commonLoggers.dbError('info.ts:14', 'call sproc INC_CNT on', e));
+	dbClient.execute(queries.callIncCnt('info')).catch((e) => utils.commonLoggers.dbError('info.ts:12', 'call sproc INC_CNT on', e));
 
 	message.send({
 		embeds: [{
 			color: infoColor2,
-			title: 'The Artificer, a Discord bot that specializing in rolling dice and calculating math',
-			description: `The Artificer is developed by Ean AKA Burn_E99.
+			title: `${config.name}, a Discord bot that specializing in rolling dice and calculating math`,
+			description: `${config.name} is developed by Ean AKA Burn_E99.
 Additional information can be found on my website [here](https://discord.burne99.com/TheArtificer/).
 Want to check out my source code?  Check it out [here](https://github.com/Burn-E99/TheArtificer).
 Need help with this bot?  Join my support server [here](https://discord.gg/peHASXMZYv).`,
 		}],
-	}).catch((e: Error) => utils.commonLoggers.messageSendError('info.ts:27', message, e));
+	}).catch((e: Error) => utils.commonLoggers.messageSendError('info.ts:23', message, e));
 };

src/commands/optIn.ts

@@ -0,0 +1,39 @@
+import config from '../../config.ts';
+import { dbClient, ignoreList, queries } from '../db.ts';
+import {
+	// Discordeno deps
+	DiscordenoMessage,
+} from '../../deps.ts';
+import { successColor, failColor } from '../commandUtils.ts';
+import utils from '../utils.ts';
+
+export const optIn = async (message: DiscordenoMessage) => {
+	// Light telemetry to see how many times a command is being run
+	dbClient.execute(queries.callIncCnt('opt-out')).catch((e) => utils.commonLoggers.dbError('optIn.ts:11', 'call sproc INC_CNT on', e));
+
+	try {
+		const idIdx = ignoreList.indexOf(message.authorId);
+		if (idIdx !== -1) {
+			ignoreList.splice(idIdx, 1);
+			await dbClient.execute('DELETE FROM ignore_list WHERE userid = ?', [message.authorId]);
+		}
+
+		message.reply({
+			embeds: [{
+				color: successColor,
+				title: `${config.name} will now respond to you again.`,
+				description: `If you want ${config.name} to ignore to you again, please run the following command:
+
+\`${config.prefix}opt-out\``,
+			}],
+		}).catch((e: Error) => utils.commonLoggers.messageSendError('optIn.ts:27', message, e));
+	} catch (err) {
+		message.reply({
+			embeds: [{
+				color: failColor,
+				title: 'Opt-In failed',
+				description: 'Please try the command again.  If the issue persists, please join the support server, linked in my About Me section.',
+			}],
+		}).catch((e: Error) => utils.commonLoggers.messageSendError('optIn.ts:27', message, e));
+	}
+};

src/commands/optOut.ts

@@ -0,0 +1,36 @@
+import config from '../../config.ts';
+import { dbClient, ignoreList, queries } from '../db.ts';
+import {
+	// Discordeno deps
+	DiscordenoMessage,
+} from '../../deps.ts';
+import { successColor, failColor } from '../commandUtils.ts';
+import utils from '../utils.ts';
+
+export const optOut = async (message: DiscordenoMessage) => {
+	// Light telemetry to see how many times a command is being run
+	dbClient.execute(queries.callIncCnt('opt-out')).catch((e) => utils.commonLoggers.dbError('optOut.ts:11', 'call sproc INC_CNT on', e));
+
+	try {
+		ignoreList.push(message.authorId);
+		await dbClient.execute('INSERT INTO ignore_list(userid) values(?)', [message.authorId]);
+
+		message.reply({
+			embeds: [{
+				color: successColor,
+				title: `${config.name} will no longer respond to you.`,
+				description: `If you want ${config.name} to respond to you again, please run the following command:
+
+\`${config.prefix}opt-in\``,
+			}],
+		}).catch((e: Error) => utils.commonLoggers.messageSendError('optOut.ts:25', message, e));
+	} catch (err) {
+		message.reply({
+			embeds: [{
+				color: failColor,
+				title: 'Opt-Out failed',
+				description: `Please try the command again.  If the issue persists, please report this using the \`${config.prefix}report opt-out failed\` command.`,
+			}],
+		}).catch((e: Error) => utils.commonLoggers.messageSendError('optOut.ts:33', message, e));
+	}
+};

src/db.ts

@@ -2,6 +2,10 @@ import config from '../config.ts';
 import { Client } from '../deps.ts';
 import { LOCALMODE } from '../flags.ts';
 
+type UserIdObj = {
+	userid: bigint;
+};
+
 export const dbClient = await new Client().connect({
 	hostname: LOCALMODE ? config.db.localhost : config.db.host,
 	port: config.db.port,
@@ -10,6 +14,13 @@ export const dbClient = await new Client().connect({
 	password: config.db.password,
 });
 
+// List of userIds who have requested that the bot ignore them
+export const ignoreList: Array<bigint> = [];
+const dbIgnoreList = await dbClient.query("SELECT * FROM ignore_list");
+dbIgnoreList.forEach((userIdObj: UserIdObj) => {
+	ignoreList.push(userIdObj.userid);
+});
+
 export const weekDays = ['sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday'];
 
 export const queries = {