Merge branch 'master' into master

Author: ckiee

.env.example

@@ -7,6 +7,13 @@ AUTOROLE=MSG_ID:ROLE_ID:EMOJI:AUTOREMOVE
 
 DATABASE_URL="localhost:5432/tsc-bot"
 
+# Role given to trusted members, not full moderators, but can use some commands which
+# are not given to all server members.
+TRUSTED_ROLE_ID=
+
+# Channel ID to direct users toward for an explanation of the help system.
+ASK_HELP_CHANNEL=
+
 ASK_CATEGORY=
 ONGOING_CATEGORY=
 DORMANT_CATEGORY=

src/env.ts

@@ -24,6 +24,9 @@ export const categories = {
 
 export const askCooldownRoleId = process.env.ASK_COOLDOWN_ROLE!;
 
+export const trustedRoleId = process.env.TRUSTED_ROLE_ID!;
+export const askHelpChannelId = process.env.ASK_HELP_CHANNEL!;
+
 export const channelNames = process.env.CHANNEL_NAMES!.split(',');
 export const dormantChannelTimeout = parseInt(
 	process.env.DORMANT_CHANNEL_TIMEOUT!,

src/modules/helpchan.ts

@@ -21,7 +21,9 @@ import {
 	channelNames,
 	dormantChannelTimeout,
 	dormantChannelLoop,
+	askHelpChannelId,
 } from '../env';
+import { isTrustedMember } from '../util/inhibitors';
 
 export class HelpChanModule extends Module {
 	constructor(client: CookiecordClient) {
@@ -103,13 +105,8 @@ export class HelpChanModule extends Module {
 
 		this.busyChannels.add(msg.channel.id);
 
-		const helpUser = new HelpUser();
-		helpUser.userId = msg.author.id;
-		helpUser.channelId = msg.channel.id;
-		await helpUser.save();
-
 		await msg.pin();
-		await msg.member.roles.add(askCooldownRoleId);
+		await this.addCooldown(msg.member, msg.channel);
 		await this.moveChannel(msg.channel, categories.ongoing);
 
 		await this.ensureAskChannels(msg.guild);
@@ -149,7 +146,7 @@ export class HelpChanModule extends Module {
 		}
 
 		const owner = await HelpUser.findOne({
-			where: { channelId: msg.channel.id },
+			channelId: msg.channel.id,
 		});
 
 		if (
@@ -219,7 +216,7 @@ export class HelpChanModule extends Module {
 		await Promise.all(pinned.map(msg => msg.unpin()));
 
 		const helpUser = await HelpUser.findOne({
-			where: { channelId: channel.id },
+			channelId: channel.id,
 		});
 		if (helpUser) {
 			const member = await channel.guild.members.fetch({
@@ -255,12 +252,19 @@ export class HelpChanModule extends Module {
 		}
 	}
 
-	@command()
-	async cooldown(msg: Message, @optional user?: GuildMember) {
-		console.log('Cooldown', msg.content);
-		if (!msg.guild) return;
+	private async addCooldown(member: GuildMember, channel: TextChannel) {
+		await member.roles.add(askCooldownRoleId);
+		const helpUser = new HelpUser();
+		helpUser.userId = member.user.id;
+		helpUser.channelId = channel.id;
+		await helpUser.save();
+	}
 
-		const guildTarget = await msg.guild.members.fetch(user ?? msg.author);
+	@command({ inhibitors: [CommonInhibitors.guildsOnly] })
+	async cooldown(msg: Message, @optional member?: GuildMember) {
+		const guildTarget = await msg.guild!.members.fetch(
+			member ?? msg.author,
+		);
 
 		if (!guildTarget) return;
 
@@ -272,19 +276,13 @@ export class HelpChanModule extends Module {
 		}
 
 		const helpUser = await HelpUser.findOne({
-			where: { userId: guildTarget.id },
+			userId: guildTarget.id,
 		});
 
 		if (helpUser) {
-			const channel = msg.guild.channels.resolve(helpUser.channelId);
-			// If we don't have a channel, just remove the cooldown. This should
-			// only happen if someone deletes a help channel.
-			if (channel) {
-				await msg.channel.send(
-					`${guildTarget.displayName} has an active help channel: ${channel.name}`,
-				);
-				return;
-			}
+			return msg.channel.send(
+				`${guildTarget.displayName} has an active help channel: <#${helpUser.channelId}>`,
+			);
 		}
 
 		await guildTarget.roles.remove(askCooldownRoleId);
@@ -293,6 +291,63 @@ export class HelpChanModule extends Module {
 		);
 	}
 
+	@command({ inhibitors: [isTrustedMember] })
+	async claim(msg: Message, member: GuildMember) {
+		const helpUser = await HelpUser.findOne({
+			userId: member.id,
+		});
+		if (helpUser) {
+			return msg.channel.send(
+				`${member.displayName} already has an open help channel: <#${helpUser.channelId}>`,
+			);
+		}
+
+		const channelMessages = await msg.channel.messages.fetch({ limit: 50 });
+		const questionMessages = channelMessages.filter(
+			questionMsg =>
+				questionMsg.author.id === member.id &&
+				questionMsg.id !== msg.id,
+		);
+
+		const msgContent = questionMessages
+			.array()
+			.slice(0, 10)
+			.map(msg => msg.content)
+			.reverse()
+			.join('\n')
+			.slice(0, 2000);
+
+		const claimedChannel = msg.guild!.channels.cache.find(
+			channel =>
+				channel.type === 'text' &&
+				channel.parentID == categories.ask &&
+				channel.name.startsWith(this.CHANNEL_PREFIX) &&
+				!this.busyChannels.has(channel.id),
+		) as TextChannel | undefined;
+
+		if (!claimedChannel) {
+			return msg.channel.send(
+				':warning: failed to claim a help channel, no available channel.',
+			);
+		}
+
+		this.busyChannels.add(claimedChannel.id);
+		const toPin = await claimedChannel.send(
+			new MessageEmbed()
+				.setAuthor(member.displayName, member.user.displayAvatarURL())
+				.setDescription(msgContent),
+		);
+		await toPin.pin();
+		await this.addCooldown(member, claimedChannel);
+		await this.moveChannel(claimedChannel, categories.ongoing);
+		await claimedChannel.send(
+			`${member.user} this channel has been claimed for your question. Please review <#${askHelpChannelId}> for how to get help.`,
+		);
+		await this.ensureAskChannels(msg.guild!);
+
+		this.busyChannels.delete(claimedChannel.id);
+	}
+
 	// Commands to fix race conditions
 	@command({
 		inhibitors: [CommonInhibitors.hasGuildPermission('MANAGE_MESSAGES')],

src/modules/rep.ts

@@ -19,8 +19,7 @@ export class RepModule extends Module {
 
 	MAX_REP = 3;
 
-	// all messages have to be fully lowercase
-	THANKS_REGEX = /(?:thanks|thx|cheers|thanx|ty|tks|tkx)\b/i;
+	THANKS_REGEX = /\b(?:thanks|thx|cheers|thanx|thnks|ty|tks|tkx)\b/i;
 
 	async getOrMakeUser(user: User) {
 		let ru = await RepUser.findOne(
@@ -158,6 +157,7 @@ export class RepModule extends Module {
 		description: 'See who has the most reputation',
 	})
 	async leaderboard(msg: Message) {
+		const topEmojis = [':first_place:', ':second_place:', ':third_place:'];
 		const data = ((await RepGive.createQueryBuilder('give')
 			.select(['give.to', 'COUNT(*)'])
 			.groupBy('give.to')
@@ -173,8 +173,10 @@ export class RepModule extends Module {
 			.setDescription(
 				data
 					.map(
-						x =>
-							`:white_small_square: **<@${x.id}>** with **${x.count}** points.`,
+						(x, index) =>
+							`${
+								topEmojis[index] || ':white_small_square:'
+							} **<@${x.id}>** with **${x.count}** points.`,
 					)
 					.join('\n'),
 			);

src/modules/twoslash.ts

@@ -105,7 +105,11 @@ export class TwoslashModule extends Module {
 					linkWithHats += ' '.repeat(spaceBefore);
 					linkWithHats += '^'.repeat(e.length || 0);
 				});
-				resultLines.push(linkWithHats);
+
+				if (linkWithHats.length > 0) {
+					resultLines.push('//' + linkWithHats.substr(2));
+				}
+
 				resultLines.push(...errors);
 			}
 

src/util/inhibitors.ts

@@ -0,0 +1,15 @@
+import { Inhibitor } from 'cookiecord';
+import { trustedRoleId } from '../env';
+
+export const isTrustedMember: Inhibitor = async (msg, client) => {
+	if (!msg.guild || !msg.member || msg.channel.type !== 'text') {
+		return ":warning: you can't use that command here.";
+	}
+
+	if (
+		!msg.member.roles.cache.has(trustedRoleId) &&
+		!msg.member.hasPermission('MANAGE_MESSAGES')
+	) {
+		return ":warning: you don't have permission to use that command.";
+	}
+};