Compare commits

..

No commits in common. "main" and "1.0.0-beta.2" have entirely different histories.

31 changed files with 606 additions and 1734 deletions

3
.npmrc
View File

@ -1,3 +0,0 @@
@astrogd:registry=https://git.astrogd.cloud/api/packages/packages/npm/
@internal:registry=https://git.astrogd.cloud/api/packages/internal/npm/
//git.astrogd.cloud/api/packages/internal/npm/:_authToken=${NPM_TOKEN}

View File

@ -1,43 +0,0 @@
# Changelog
This file is used to list changes made to this software.
_Current development release: 1.1.1_
## V1.1.1 [2023-09-16]
### Updates
- Updated packages to latest versions
### Bugfixes
- Fixed a bug where the bot would crash on startup if the database connection establishment took too long
### Other
- Renamed db service in docker compose file from database to db
## V1.1.0 [2022-11-29]
### Features
- If a channel gets deleted and the responsible user has been detected, a message will be sent to that user informing him of the deletion
## V1.0.0 [2022-11-29]
### Features
- /info
- /logchannel
- /blocklist get
- /blocklist add
- /blocklist remove
- /preservesettings
- /showblocklist
- /showsettings
- Data will be deleted by default when the bot leaves the server
- Server admins can change the behaviour of the bot when it leaves the server to keep the data persistent
- Scans for blocked words in channel names and deletes the channel if found
- Gets the user creating or renaming a channel to a blocked word
- When settings are changed or channels are deleted, notifications to a logchannel can be enabled
- CLI to change settings and get information during runtime by attaching to the apps docker container
- API for automated uptime checks to prevent the bot from going offline unnoticed
- Bot notifies admins via /showsettings when it lacks permissions needed for its functionality

View File

@ -1,53 +1,28 @@
# eu.astrogd.white-leopard
A Discord bot that checks Discord channel names for banned words and prevents renaming of them
## Commands
### /logchanel [channel?] `Permission: MANAGE_GUILD`
### /logchanel [channel?]
Sets the channel where the bot will log if a channel meets the banned word criteria. If channel is omitted, the log channel will be disabled.
### /blocklist `Permission: MANAGE_GUILD`
### /blocklist
#### /blocklist get
Returns the global and server specific banned word list and returns it (Same behaviour as /showblocklist)
Gets the global and server specific banned word list and returns it
#### /blocklist add [word]
Adds the word to the server specific blocklist
#### /blocklist remove [word]
Removes the word from the server specific blocklist
### /info `Permission: EVERYONE`
### /info
Returns general information about the bot and the servers stats
### /preservesettings `Permission: ADMINISTRATOR`
Changes the behaviour when the bot leaves the server.
Options are:
- Keep settings persistent even if the bot leaves
- Delete setting when the bot leaves the server [default]
### /showblocklist `Permission: MANAGE_CHANNELS`
Returns the global and server specific banned word list and returns it
### /showsettings `Permission: MANAGE_GUILD`
Returns the current settings for the server
## Environment variables
| Name | Description | Required | Example |
| :--------------- | :------------------------------------------------------------------------------ | :------: | :------------------ |
| TOKEN | Discord bot token to log into the API with | ▶️/🚀 | NzYzMDP3MzE1Mzky... |
| DB_HOST | Hostname of the database | ▶️ | 127.0.0.1 |
| DB_HOST | Hostname of the database | ▶️ | 127.0.0.1:3546 |
| DB_USERNAME | Username of the database | ▶️ | root |
| DB_PASSWORD | Password of the database | ▶️ | abc123 |
| DB_DATABASE | Database name | ▶️ | white-leopard |
@ -55,7 +30,6 @@ Returns the current settings for the server
| DEPLOY_TOKEN | Production Discord bot token to log into the API with | 🚀 | NzYzMDP3MzE1Mzky... |
| DEPLOY_CLIENT_ID | Production Client ID of the Discord appication associated with the deploy token | 🚀 | 763035392692274 |
### Icon explanation
### Icon explanation:
- ▶️ = Required in runtime
- 🚀 = Required during CI/CD
- 🚀 = Required during CI/CD

View File

@ -8,16 +8,15 @@ services:
tty: true
stdin_open: true
depends_on:
- db
- database
restart: unless-stopped
environment:
- TOKEN=$TOKEN
- DB_HOST=db
- DB_HOST=database
- DB_USERNAME=$DB_USERNAME
- DB_PASSWORD=$DB_PASSWORD
- DB_DATABASE=$DB_DATABASE
- MONITOR_URL=$MONITOR_URL
db:
database:
image: postgres:latest
restart: unless-stopped
ports:

1447
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,27 +1,21 @@
{
"name": "eu.astrogd.white-leopard",
"version": "1.2.0",
"version": "1.0.0-beta.2",
"description": "A Discord bot that checks channel names for blacklisted words and reverts the changes if necessary",
"main": "build/index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"build": "tsc && shx cp package-lock.json build/package-lock.json",
"start:rebuild": "npm run build && node --enable-source-maps .",
"version:dev": "npm version prerelease --preid dev --no-commit-hooks --no-git-tag-version",
"version:patch": "npm version prepatch --preid dev --no-commit-hooks --no-git-tag-version",
"version:minor": "npm version preminor --preid dev --no-commit-hooks --no-git-tag-version",
"version:major": "npm version premajor --preid dev --no-commit-hooks --no-git-tag-version",
"version:release": "npm version patch --no-commit-hooks --no-git-tag-version",
"deploy-commands:dev": "ts-node ci/devDeploy.ts",
"deploy-commands:prod": "ts-node ci/deploy.ts",
"deploy:dev": "npm run build && npm run deploy-commands:dev && docker compose build && docker compose up -d",
"deploy:prod": "rimraf build && npm run build && npm run deploy-commands:prod && docker build -t astrogd/white-leopard:latest . && docker push astrogd/white-leopard:latest",
"start": "npm run build && npm run deploy-commands:dev && docker-compose up -d db && node --enable-source-maps .",
"migration:create": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate -d src/data/dataSource.migration.ts -p src/data/migrations/data",
"migration:run": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:run -d src/data/dataSource.migration.ts",
"migration:revert": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:revert -d src/data/dataSource.migration.ts",
"migration:show": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:show -d src/data/dataSource.migration.ts",
"migration:check": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate --check -d src/data/dataSource.migration.ts src/data/migrations/data"
"start": "npm run build && npm run deploy-commands:dev && docker-compose up --no-start && docker compose start database && node --enable-source-maps .",
"migration:create": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate -d src/data/dataSource.ts -p src/data/migrations/data",
"migration:run": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:run -d src/data/dataSource.ts",
"migration:revert": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:revert -d src/data/dataSource.ts",
"migration:show": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:show -d src/data/dataSource.ts",
"migration:check": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate --check -d src/data/dataSource.ts src/data/migrations/data"
},
"repository": {
"type": "git",
@ -35,19 +29,18 @@
"homepage": "https://github.com/r-Overwatch2/eu.astrogd.white-leopard#readme",
"devDependencies": {
"@types/express": "^4.17.14",
"@types/fs-extra": "^11.0.2",
"@types/node": "^18.17.17",
"rimraf": "^5.0.1",
"@types/fs-extra": "^9.0.13",
"@types/node": "^18.11.9",
"rimraf": "^3.0.2",
"shx": "^0.3.4",
"ts-node": "^10.9.1",
"typescript": "^5.2.2"
"typescript": "^4.9.3"
},
"dependencies": {
"@astrogd/eu.astrogd.uptime-kuma-push-monitor": "^1.0.0-dev.3",
"discord.js": "^14.13.0",
"discord.js": "^14.6.0",
"dotenv": "^16.0.3",
"express": "^4.18.2",
"fs-extra": "^11.0.0",
"fs-extra": "^10.1.0",
"moment": "^2.29.4",
"pg": "^8.8.0",
"typeorm": "^0.3.10"

View File

@ -1,4 +1,5 @@
import { getGuildSetting } from "../tools/data";
import { getGuildSetting, isPremiumActive } from "../tools/data";
import moment from "moment";
import { Badword, database, GuildSetting } from "../data";
import { Console } from "console";
@ -12,6 +13,7 @@ export default async function execute(args: string[]) {
case "info": {
if (!args[1]) return printHelp();
const settings = await getGuildSetting(args[1]);
const isPremium = isPremiumActive(settings.isPremiumUntil);
const wordCount = await database.getRepository(Badword).count({
where: {
guildID: args[1]
@ -19,12 +21,35 @@ export default async function execute(args: string[]) {
});
console.log(`Guild ${args[1]}:
- Preserve Settings: ${settings.preserveDataOnGuildLeave ? "ENABLED" : "DISABLED"}
- Premium: ${isPremium ? `ACTIVE for ${moment(settings.isPremiumUntil).fromNow(true)}` : "INACTIVE"}
- Logchannel: ${settings.notificationChannelID ? `ENABLED (${settings.notificationChannelID})` : "DISABLED"}
- blocked Words: ${wordCount}`);
break;
}
case "setpremium": {
if (!args[1] || !args[2]) return printHelp();
const settings = await getGuildSetting(args[1]);
if (args[2].toLowerCase() === "null") {
settings.isPremiumUntil = null;
await database.getRepository(GuildSetting).save(settings);
console.log("Premium status removed for guild " + args[1]);
break;
}
const date = new Date(args[2]);
if (isNaN(Number(date))) return printHelp();
const now = new Date();
if (now > date) return console.log("Date lies in the past");
settings.isPremiumUntil = date;
await database.getRepository(GuildSetting).save(settings);
console.log(`Premium status for guild ${args[1]} is now active for ${moment(date).fromNow(true)}`);
break;
}
case "words": {
if (!args[1] || !args[2]) return printWordHelp();
@ -99,21 +124,6 @@ export default async function execute(args: string[]) {
break;
}
case "delete": {
if (!args[1]) return printHelp();
await database.getRepository(GuildSetting).delete({
id: args[1]
});
await database.getRepository(Badword).delete({
guildID: args[1]
});
console.log(`Deleted all data for guild ${args[1]}`);
break;
}
default: {
printHelp();
break;
@ -126,8 +136,8 @@ function printHelp() {
console.log(`Usage "guild":
guild info [GUILDID]
guild words [get|add|remove|clear]
guild delete [GUILDID]`);
guild setPremium [GUILDID] [YYYY-MM-DD or NULL]
guild words [get|add|remove|clear]`);
}
function printWordHelp() {

View File

@ -1,25 +1,10 @@
import { runCleanup } from "../service";
import client from "./index";
import { initPromise } from "../data/dataSource";
import pushMonitor from "@astrogd/eu.astrogd.uptime-kuma-push-monitor";
const token = process.env["TOKEN"];
if (!token) throw new ReferenceError("TOKEN environment variable is missing");
async function run() {
console.log("Establishing database connection");
await initPromise;
console.log("Connection established\nAuthenticating with Discord API");
client.login(token);
}
client.login(token);
client.on("ready", async () => {
client.on("ready", () => {
console.log(`Connected to Discord API. Bot account is ${client.user?.tag} (${client.user?.id})`);
if (process.env["MONITOR_URL"]) pushMonitor.register(process.env["MONITOR_URL"], 120);
pushMonitor.enableShutdownNotifications();
pushMonitor.setPerformanceHandler(() => client.ws.ping);
runCleanup();
});
run();
});

View File

@ -1,11 +1,10 @@
import { ChatInputCommandInteraction, PermissionFlagsBits, SlashCommandBuilder } from "discord.js";
import { database, Badword } from "../data";
import { IsNull } from "typeorm";
import { getGuildSetting } from "../tools/data";
import { getGuildSetting, isPremiumActive } from "../tools/data";
import getDefaultEmbed, { getFailedEmbed, getSuccessEmbed } from "../tools/defaultEmbeds";
import { getGuildChannel } from "../tools/discord";
import { Color, Emoji } from "../tools/design";
import { execute as showBlocklistRunner } from "./showblocklist";
const builder = new SlashCommandBuilder();
builder.setName("blocklist");
@ -46,12 +45,30 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
if (!interaction.guildId) throw new Error("Command was executed in DM context");
const settings = await getGuildSetting(interaction.guildId);
const isPremium = isPremiumActive(settings.isPremiumUntil);
const logChannel = settings.notificationChannelID ? await getGuildChannel(interaction.guildId, settings.notificationChannelID) : null;
switch (interaction.options.getSubcommand(true)) {
case "get": {
await showBlocklistRunner(interaction);
const guildBadWords = await database.getRepository(Badword).find({
select: {
value: true
},
where: {
guildID: interaction.guildId
}
});
const globalBadWords = await database.getRepository(Badword).find({
where: {
guildID: IsNull()
}
});
interaction.reply({
content: `\`\`\`Global bad word list\`\`\`\n||${globalBadWords.map((word) => word.value).reduce((prev, next) => prev + ", " + next, "").slice(2)} ||\n\`\`\`Local server bad word list (${guildBadWords.length}/${isPremium ? 100 : 10})\`\`\`\n||${guildBadWords.map((word) => word.value).reduce((prev, next) => prev + ", " + next, "").slice(2)} ||`,
ephemeral: true
}).catch();
break;
}
@ -62,14 +79,14 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
}
});
const limit = 100;
const limit = isPremium ? 100 : 10;
if (count >= limit) {
const embed = getFailedEmbed();
embed.setDescription(`You reached the word limit for your guild. Please delete a word before adding a new one`);
interaction.reply({
embeds: [embed],
ephemeral: true
}).catch(() => {});
}).catch();
return;
}
@ -88,7 +105,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
interaction.reply({
embeds: [embed],
ephemeral: true
}).catch(() => {});
}).catch();
return;
}
@ -116,7 +133,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
if (logChannel && logChannel.isTextBased()) {
logChannel.send({
embeds: [logMessage]
}).catch(() => {});
}).catch();
}
break;
}
@ -137,7 +154,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
interaction.reply({
embeds: [embed],
ephemeral: true
}).catch(() => {});
}).catch();
return;
}
@ -150,7 +167,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
interaction.reply({
embeds: [embed],
ephemeral: true
}).catch(() => {});
}).catch();
const logMessage = getDefaultEmbed();
logMessage.setTitle(`${Emoji.SETTINGS} Word removed`);
@ -163,7 +180,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
if (logChannel && logChannel.isTextBased()) {
logChannel.send({
embeds: [logMessage]
}).catch(() => {});
}).catch();
}
break;
}

View File

@ -1,19 +1,8 @@
import * as notification from "./logchannel";
import * as notification from "./notification";
import * as blocklist from "./blocklist";
import * as info from "./info";
import * as preserveSettings from "./preserveSettings";
import * as showBlocklist from "./showblocklist";
import * as showSettings from "./showSettings";
const commands = [];
commands.push(notification);
commands.push(blocklist);
commands.push(info);
commands.push(preserveSettings);
commands.push(showBlocklist);
commands.push(showSettings);
const array = commands.map((command) => command.builder.toJSON());
const array = [notification.builder.toJSON(), blocklist.builder.toJSON(), info.builder.toJSON()];
export {
array

View File

@ -1,10 +1,7 @@
import { ChatInputCommandInteraction, Collection, Events, SlashCommandBuilder } from "discord.js";
import * as notification from "./logchannel";
import * as notification from "./notification";
import * as blocklist from "./blocklist";
import * as info from "./info";
import * as preserveSettings from "./preserveSettings";
import * as showBlocklist from "./showblocklist";
import * as showSettings from "./showSettings";
import client from "../client";
import getDefaultEmbed from "../tools/defaultEmbeds";
@ -12,9 +9,6 @@ const commands = new Collection<string, { builder: SlashCommandBuilder, execute:
commands.set(notification.builder.name, notification);
commands.set(blocklist.builder.name, blocklist);
commands.set(info.builder.name, info);
commands.set(preserveSettings.builder.name, preserveSettings);
commands.set(showBlocklist.builder.name, showBlocklist);
commands.set(showSettings.builder.name, showSettings);
client.on(Events.InteractionCreate, async (interaction) => {
if (!interaction.isChatInputCommand()) return;
@ -44,6 +38,6 @@ client.on(Events.InteractionCreate, async (interaction) => {
await interaction.reply({
embeds: [embed],
ephemeral: true
}).catch(() => {});
}).catch();
}
});

View File

@ -1,6 +1,7 @@
import { ChatInputCommandInteraction, SlashCommandBuilder } from "discord.js";
import { IsNull } from "typeorm";
import { Badword, database } from "../data";
import { getGuildSetting, isPremiumActive } from "../tools/data";
import getDefaultEmbed from "../tools/defaultEmbeds";
import pack from "../../package.json";
import { Color, Emoji } from "../tools/design";
@ -13,6 +14,8 @@ builder.setDMPermission(false);
async function execute(interaction: ChatInputCommandInteraction): Promise<void> {
if (!interaction.inGuild()) throw new Error("Command was executed outside guild context");
const settings = await getGuildSetting(interaction.guildId);
const isPremium = isPremiumActive(settings.isPremiumUntil);
const globalBlockedWordsCount = await database.getRepository(Badword).count({
where: {
guildID: IsNull()
@ -27,13 +30,17 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
const embed = getDefaultEmbed();
embed.setTitle(`${Emoji.SECURITY_CHALLENGE} Channel filter V${pack.version} by AstroGD®`);
embed.setDescription(`Codename eu.astrogd.white-leopard`);
embed.setColor(Color.INFORMING_BLUE);
embed.setColor(isPremium ? Color.PREMIUM_ORANGE : Color.INFORMING_BLUE);
embed.addFields({
name: "What does this bot do?",
value: "This bot checks for blocked words contained in channel names and reverts the changes if found."
},{
name: "Author",
value: `This bot was created by AstroGD#0001 ${Emoji.ASTROGD} mainly for the official r/Overwatch2 Subreddit Discord server`
},{
name: "Server status",
value: `${isPremium ? Emoji.PREMIUM : Emoji.SWITCH_OFF} Premium features are ${isPremium ? "enabled" : "disabled"} on this server`,
inline: true
},{
name: "Global word count",
value: globalBlockedWordsCount.toString(),
@ -50,7 +57,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
interaction.reply({
embeds: [embed],
ephemeral: true
}).catch(() => {});
}).catch();
}
export {

View File

@ -1,15 +1,15 @@
import { SlashCommandBuilder, PermissionFlagsBits, ChannelType, ChatInputCommandInteraction, NewsChannel, TextBasedChannel, CategoryChannel, StageChannel, TextChannel, PrivateThreadChannel, PublicThreadChannel, VoiceChannel, APIInteractionDataResolvedChannel, ForumChannel } from "discord.js";
import getDefaultEmbed, { getFailedEmbed, getSuccessEmbed } from "../tools/defaultEmbeds";
import getDefaultEmbed, { getSuccessEmbed } from "../tools/defaultEmbeds";
import { database, GuildSetting } from "../data";
import { getGuildSetting } from "../tools/data";
import { getGuildChannel, getChannelPermission } from "../tools/discord";
import { getGuildChannel } from "../tools/discord";
import { Emoji } from "../tools/design";
const builder = new SlashCommandBuilder();
builder.setName("logchannel");
builder.setDescription("Configures the log channel");
builder.setDMPermission(false);
builder.setDefaultMemberPermissions(PermissionFlagsBits.ManageGuild);
builder.setDefaultMemberPermissions(PermissionFlagsBits.ManageChannels);
builder.addChannelOption((option) => {
option.addChannelTypes(ChannelType.GuildText, ChannelType.GuildAnnouncement);
option.setName("channel");
@ -20,7 +20,7 @@ builder.addChannelOption((option) => {
async function resetNotificationChannel(guildSetting: GuildSetting, interaction: ChatInputCommandInteraction): Promise<void> {
const logChannel = guildSetting.notificationChannelID ? await getGuildChannel(guildSetting.id, guildSetting.notificationChannelID) : null;
guildSetting.notificationChannelID = null;
await database.getRepository(GuildSetting).save(guildSetting);
@ -31,11 +31,11 @@ async function resetNotificationChannel(guildSetting: GuildSetting, interaction:
name: "This action was performed by",
value: `${interaction.user.tag} (${interaction.user.id})`
});
if (logChannel && logChannel.isTextBased()) {
logChannel.send({
embeds: [logEmbed]
}).catch(() => {});
}).catch();
}
const embed = getSuccessEmbed();
@ -43,7 +43,7 @@ async function resetNotificationChannel(guildSetting: GuildSetting, interaction:
interaction.reply({
embeds: [embed],
ephemeral: true
}).catch(() => {});
}).catch();
}
const execute = async (interaction: ChatInputCommandInteraction) => {
@ -55,20 +55,6 @@ const execute = async (interaction: ChatInputCommandInteraction) => {
if (!optionVal) return await resetNotificationChannel(guildSetting, interaction);
const channel = getTextBasedChannel(optionVal);
if (channel.isDMBased()) return;
const permissions = await getChannelPermission(channel);
if (!permissions || !permissions.has(PermissionFlagsBits.ViewChannel) || !permissions.has(PermissionFlagsBits.SendMessages)) {
const embed = getFailedEmbed();
embed.setDescription(`Bot doesn't have permission to view and/or write in channel <#${channel.id}>`);
interaction.reply({
embeds: [ embed ],
ephemeral: true
}).catch(() => {});
return;
}
if (guildSetting.notificationChannelID) {
const oldLogChannel = await getGuildChannel(guildSetting.id, guildSetting.notificationChannelID);
const embed = getDefaultEmbed();
@ -82,7 +68,7 @@ const execute = async (interaction: ChatInputCommandInteraction) => {
if (oldLogChannel && oldLogChannel.isTextBased()) {
oldLogChannel.send({
embeds: [embed]
}).catch(() => {});
}).catch();
}
}
@ -98,16 +84,16 @@ const execute = async (interaction: ChatInputCommandInteraction) => {
});
channel.send({
embeds: [embed]
}).catch(() => {});
embeds: [ embed ]
}).catch();
const reply = getSuccessEmbed();
reply.setDescription(`Log channel was set to <#${channel.id}>`);
interaction.reply({
embeds: [reply],
embeds: [ reply ],
ephemeral: true
}).catch(() => {});
}).catch();
return;
}

View File

@ -1,66 +0,0 @@
import { SlashCommandBuilder, ChatInputCommandInteraction, PermissionFlagsBits } from "discord.js";
import { database, GuildSetting } from "../data";
import { getGuildSetting } from "../tools/data";
import getDefaultEmbed, { getSuccessEmbed } from "../tools/defaultEmbeds";
import { Emoji } from "../tools/design";
import { getGuildChannel } from "../tools/discord";
const builder = new SlashCommandBuilder();
builder.setName("preservesettings");
builder.setDescription("Sets if the bot should save the server settings and blocklist if it leaves the server or delete it");
builder.addStringOption((option) => {
option.addChoices({
name: "Keep data when bot leaves the server",
value: "keep"
}, {
name: "Delete data when bot leaves the server",
value: "delete"
});
option.setName("behaviour");
option.setDescription("How the bot behaves when leaving the server");
option.setRequired(true);
return option;
});
builder.setDMPermission(false);
builder.setDefaultMemberPermissions(PermissionFlagsBits.Administrator);
async function execute(interaction: ChatInputCommandInteraction): Promise<void> {
if (!interaction.inGuild()) throw new Error("Command was executed outside guild context");
const settings = await getGuildSetting(interaction.guildId);
const option = interaction.options.getString("behaviour", true).toLowerCase();
if (option !== "keep" && option !== "delete") throw new TypeError(`option "behaviour" expected to be of type "keep" | "delete" but was "${option}"`);
settings.preserveDataOnGuildLeave = option === "keep";
await database.getRepository(GuildSetting).save(settings);
const embed = getSuccessEmbed();
embed.setDescription(`Preserve settings on server leave is now ${settings.preserveDataOnGuildLeave ? "ENABLED" : "DISABLED"}`);
interaction.reply({
embeds: [embed],
ephemeral: true
}).catch(() => {});
if (!settings.notificationChannelID) return;
const logChannel = await getGuildChannel(interaction.guildId, settings.notificationChannelID);
if (!logChannel || !logChannel.isTextBased()) return;
const logEmbed = getDefaultEmbed();
logEmbed.setTitle(`${Emoji.SETTINGS} Settings changed`);
logEmbed.setDescription(`Preserve settings on server leave is now ${settings.preserveDataOnGuildLeave ? "ENABLED" : "DISABLED"}`);
logEmbed.addFields({
name: "This action was performed by",
value: `${interaction.user.tag} (${interaction.user.id})`
});
logChannel.send({
embeds: [logEmbed]
}).catch(() => {});
}
export {
builder,
execute
}

View File

@ -1,110 +0,0 @@
import { ChatInputCommandInteraction, Guild, PermissionFlagsBits, SlashCommandBuilder } from "discord.js";
import client from "../client";
import { Badword, database } from "../data";
import { getGuildSetting } from "../tools/data";
import getDefaultEmbed from "../tools/defaultEmbeds";
import { Color, Emoji } from "../tools/design";
import { getGuildChannel, getChannelPermission } from "../tools/discord";
const builder = new SlashCommandBuilder();
builder.setName("showsettings");
builder.setDescription("Show the current settings of this guild");
builder.setDMPermission(false);
builder.setDefaultMemberPermissions(PermissionFlagsBits.ManageGuild);
async function execute(interaction: ChatInputCommandInteraction): Promise<void> {
if (!interaction.inGuild()) throw new Error("Interaction was performed outside guild context");
const guild = await new Promise<null | Guild>((resolve) => {
client.guilds.fetch(interaction.guildId).catch(() => {resolve(null)}).then((guild) => {resolve(guild || null)});
});
if (!guild) throw new Error("Guild is unavailable");
const settings = await getGuildSetting(interaction.guildId);
const wordCount = await database.getRepository(Badword).count({
where: {
guildID: interaction.guildId
}
});
const logChannel = settings.notificationChannelID ? await getGuildChannel(interaction.guildId, settings.notificationChannelID) : null;
const embed = getDefaultEmbed();
embed.setTitle(`Settings from guild ${interaction.guild?.name || ""} (${interaction.guildId})`);
embed.setDescription("Thanks for using this bot");
embed.setColor(Color.INFORMING_BLUE);
embed.addFields({
name: "Logchannel",
value: settings.notificationChannelID ? `<#${settings.notificationChannelID}>` : "Not configured",
inline: true
}, {
name: "Words in Blocklist",
value: `${wordCount}/100`,
inline: true
}, {
name: `Preserve data on server leave is ${settings.preserveDataOnGuildLeave ? "active" : "inactive"}`,
value: settings.preserveDataOnGuildLeave ? "Your settings will be saved even if the bot gets kicked" : "Your settings will be deleted as soon as the bot leaves this server"
}, {
name: `${Emoji.WAVING} Found a bug? Want to request a feature? Say hello?`,
value: "Join the support server at https://go.astrogd.eu/discord"
});
const embeds = [];
embeds.push(embed);
const invalidLogChannelEmbed = getDefaultEmbed();
invalidLogChannelEmbed.setColor(Color.WARNING_YELLOW);
invalidLogChannelEmbed.setTitle(`${Emoji.CHAT_DENY} Logchannel is misconfigured!`);
invalidLogChannelEmbed.setDescription("The bot is unable to read and/or write in the configured logChannel. Please adjust your permissions.");
const missingPermissionEmbed = getDefaultEmbed();
missingPermissionEmbed.setColor(Color.WARNING_YELLOW);
missingPermissionEmbed.setTitle(`${Emoji.CHAT_DENY} Bot is missing permissions to function properly!`);
missingPermissionEmbed.setDescription("Without these missing Permissions, the bot won't work properly and might lead to unexpected behavior");
if (logChannel && logChannel.isTextBased()) {
const permissions = await getChannelPermission(logChannel);
if (!permissions || !permissions.has(PermissionFlagsBits.ViewChannel) || !permissions.has(PermissionFlagsBits.SendMessages)) {
embeds.push(invalidLogChannelEmbed);
}
}
if ((!logChannel || !logChannel.isTextBased()) && settings.notificationChannelID) {
embeds.push(invalidLogChannelEmbed);
}
const member = await guild.members.fetchMe();
if (!member.permissions.has(PermissionFlagsBits.ViewAuditLog)) {
missingPermissionEmbed.addFields({
name: "View Audit Logs",
value: "With this permission the bot can determine who created or updated a channel with a blocked word"
});
}
if (!member.permissions.has(PermissionFlagsBits.ViewChannel)) {
missingPermissionEmbed.addFields({
name: "View Channels",
value: "If the bot can't see a channel, it won't be able to detect blocked words in it"
});
}
if (!member.permissions.has(PermissionFlagsBits.ManageChannels)) {
missingPermissionEmbed.addFields({
name: "Manage Channels",
value: "If the bot can't delete a channel, it can't protect your server from channels with blocked words"
});
}
if (missingPermissionEmbed.data.fields?.length || 0 > 0) embeds.push(missingPermissionEmbed);
interaction.reply({
embeds: embeds,
ephemeral: true
}).catch(() => {});
}
export {
builder,
execute
}

View File

@ -1,37 +0,0 @@
import { ChatInputCommandInteraction, PermissionFlagsBits, SlashCommandBuilder } from "discord.js";
import { IsNull } from "typeorm";
import { Badword, database } from "../data";
const builder = new SlashCommandBuilder();
builder.setName("showblocklist");
builder.setDescription("Shows the blocklist of this server");
builder.setDMPermission(false);
builder.setDefaultMemberPermissions(PermissionFlagsBits.ManageChannels);
async function execute(interaction: ChatInputCommandInteraction): Promise<void> {
if (!interaction.inGuild()) throw new Error("Command was executed outside guild context");
const guildBadWords = await database.getRepository(Badword).find({
select: {
value: true
},
where: {
guildID: interaction.guildId
}
});
const globalBadWords = await database.getRepository(Badword).find({
where: {
guildID: IsNull()
}
});
interaction.reply({
content: `\`\`\`Global bad word list\`\`\`\n||${globalBadWords.map((word) => word.value).reduce((prev, next) => prev + ", " + next, "").slice(2)} ||\n\`\`\`Local server bad word list (${guildBadWords.length}/100)\`\`\`\n||${guildBadWords.map((word) => word.value).reduce((prev, next) => prev + ", " + next, "").slice(2)} ||`,
ephemeral: true
}).catch(() => {});
}
export {
builder,
execute
}

View File

@ -1,3 +0,0 @@
import dataSource from "./dataSource";
export default dataSource;

View File

@ -28,9 +28,6 @@ const dataSource = new DataSource({
migrationsTransactionMode: "each"
});
const initPromise = dataSource.initialize();
dataSource.initialize();
export default dataSource;
export {
initPromise
}
export default dataSource;

View File

@ -1,19 +0,0 @@
import { MigrationInterface, QueryRunner } from "typeorm";
export class data1669392941776 implements MigrationInterface {
name = 'data1669392941776'
public async up(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(`
ALTER TABLE "guild_setting"
ADD "preserveDataOnGuildLeave" boolean NOT NULL DEFAULT false
`);
}
public async down(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(`
ALTER TABLE "guild_setting" DROP COLUMN "preserveDataOnGuildLeave"
`);
}
}

View File

@ -1,19 +0,0 @@
import { MigrationInterface, QueryRunner } from "typeorm";
export class data1669686263307 implements MigrationInterface {
name = 'data1669686263307'
public async up(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(`
ALTER TABLE "guild_setting" DROP COLUMN "isPremiumUntil"
`);
}
public async down(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(`
ALTER TABLE "guild_setting"
ADD "isPremiumUntil" TIMESTAMP
`);
}
}

View File

@ -8,6 +8,6 @@ export class GuildSetting {
@Column("varchar", { nullable: true, default: null })
notificationChannelID!: string | null;
@Column("boolean", { default: false })
preserveDataOnGuildLeave!: boolean
@Column("timestamp", { nullable: true, default: null })
isPremiumUntil!: Date | null;
}

View File

@ -1,116 +0,0 @@
import client from "../client";
import { AuditLogEvent, Events, GuildAuditLogsEntry, PermissionFlagsBits, User } from "discord.js";
import { getGuildSetting } from "../tools/data";
import { Badword, database } from "../data";
import { IsNull } from "typeorm";
import getDefaultEmbed, { getFailedEmbed, getUserReportEmbed } from "../tools/defaultEmbeds";
import { getGuildChannel } from "../tools/discord";
import { Color, Emoji } from "../tools/design";
client.on(Events.ChannelCreate, async (newChannel) => {
if (newChannel.isDMBased()) return;
const name = newChannel.name.toLowerCase();
const guild = newChannel.guild;
const settings = await getGuildSetting(guild.id);
const globalBlocklist = await database.getRepository(Badword).find({
where: {
guildID: IsNull()
}
});
const localBlocklist = await database.getRepository(Badword).find({
where: {
guildID: guild.id
}
});
const blocklist = [...globalBlocklist, ...localBlocklist];
let found: string | null = null;
for (let i = 0; i < blocklist.length; i++) {
const word = blocklist[i];
if (!word) continue;
if (!name.includes(word.value)) continue;
found = word.value;
break;
}
if (found === null) return;
let responsibleUser: User | null;
try {
const clientMember = await guild.members.fetchMe();
const canSeeAuditLog = clientMember.permissions.has(PermissionFlagsBits.ViewAuditLog);
const auditLogs = canSeeAuditLog ? await guild.fetchAuditLogs({
type: AuditLogEvent.ChannelCreate,
limit: 50
}) : undefined;
const change = auditLogs?.entries.filter((entry) => {
if (entry.target.id !== newChannel.id) return false;
return entry.changes.filter((change) => {
return change.key === "name" && change.new === newChannel.name;
}).length > 0;
}).reduce<null | GuildAuditLogsEntry<AuditLogEvent.ChannelCreate, "Create", "Channel", AuditLogEvent.ChannelCreate>>((unknown, curr) => {
if (!unknown) return curr;
const prev = unknown as GuildAuditLogsEntry<AuditLogEvent.ChannelCreate, "Create", "Channel", AuditLogEvent.ChannelCreate>
return curr.createdTimestamp > prev.createdTimestamp ? curr : prev;
}, null);
responsibleUser = change?.executor || null;
} catch (error) {
responsibleUser = null;
}
const logChannel = settings.notificationChannelID ? await getGuildChannel(guild.id, settings.notificationChannelID) : null;
try {
if (!newChannel.deletable) throw new Error("Missing permissions to delete channel");
await newChannel.delete("[Automated] Detected blocked word in channel name");
} catch (error) {
if (!logChannel || !logChannel.isTextBased()) return;
const embed = getFailedEmbed();
embed.setDescription(`Couldn't delete <#${newChannel.id}> (${newChannel.id}): ${error instanceof Error ? error.message : error}`);
embed.addFields({
name: "Detected banned word:",
value: `||${found}||`
}, {
name: "Channel created by:",
value: responsibleUser ? `${responsibleUser.tag} (${responsibleUser.id})` : "`Couldn't detect responsible user :(`"
});
logChannel.send({
embeds: [embed]
}).catch(() => {});
return;
}
if (responsibleUser) {
const embed = getUserReportEmbed(guild.name, newChannel.name);
responsibleUser.send({
embeds: [embed]
}).catch(() => {});
}
if (!logChannel || !logChannel.isTextBased()) return;
const embed = getDefaultEmbed();
embed.setTitle(`${Emoji.SECURITY_CHALLENGE_FAILED} Blocked word detected`);
embed.setDescription(`||#${newChannel.name}|| (${newChannel.id}) has been deleted because its name contained a blocked word.`);
embed.setColor(Color.WARNING_YELLOW);
embed.addFields({
name: "Detected banned word:",
value: `||${found}||`,
inline: true
}, {
name: "Channel created by:",
value: responsibleUser ? `${responsibleUser.tag} (${responsibleUser.id})` : "`Couldn't detect responsible user :(`"
});
logChannel.send({
embeds: [embed]
}).catch(() => {});
});

View File

@ -1,18 +1,20 @@
import client from "../client";
import { AuditLogEvent, Events, GuildAuditLogsEntry, PermissionFlagsBits, User } from "discord.js";
import { getGuildSetting } from "../tools/data";
import { Events } from "discord.js";
import { getGuildSetting, isPremiumActive } from "../tools/data";
import { Badword, database } from "../data";
import { IsNull } from "typeorm";
import getDefaultEmbed, { getFailedEmbed, getUserReportEmbed } from "../tools/defaultEmbeds";
import getDefaultEmbed, { getFailedEmbed } from "../tools/defaultEmbeds";
import { getGuildChannel } from "../tools/discord";
import { Color, Emoji } from "../tools/design";
client.on(Events.ChannelUpdate, async (oldChannel, newChannel) => {
if (oldChannel.isDMBased() || newChannel.isDMBased()) return;
const name = newChannel.name.toLowerCase();
if (name === "censored") return;
const guild = oldChannel.guild;
const settings = await getGuildSetting(guild.id);
const isPremium = isPremiumActive(settings.isPremiumUntil);
const globalBlocklist = await database.getRepository(Badword).find({
where: {
@ -27,7 +29,7 @@ client.on(Events.ChannelUpdate, async (oldChannel, newChannel) => {
const blocklist = [...globalBlocklist, ...localBlocklist];
let found: string | null = null;
for (let i = 0; i < blocklist.length; i++) {
const word = blocklist[i];
if (!word) continue;
@ -39,78 +41,45 @@ client.on(Events.ChannelUpdate, async (oldChannel, newChannel) => {
if (found === null) return;
let responsibleUser: User | null;
try {
const clientMember = await guild.members.fetchMe();
const canSeeAuditLog = clientMember.permissions.has(PermissionFlagsBits.ViewAuditLog);
const auditLogs = canSeeAuditLog ? await guild.fetchAuditLogs({
type: AuditLogEvent.ChannelUpdate,
limit: 50
}) : undefined;
const change = auditLogs?.entries.filter((entry) => {
if (entry.target.id !== newChannel.id) return false;
return entry.changes.filter((change) => {
return change.key === "name" && change.new === newChannel.name;
}).length > 0;
}).reduce<null | GuildAuditLogsEntry<AuditLogEvent.ChannelUpdate, "Update", "Channel", AuditLogEvent.ChannelUpdate>>((unknown, curr) => {
if (!unknown) return curr;
const prev = unknown as GuildAuditLogsEntry<AuditLogEvent.ChannelUpdate, "Update", "Channel", AuditLogEvent.ChannelUpdate>
return curr.createdTimestamp > prev.createdTimestamp ? curr : prev;
}, null);
responsibleUser = change?.executor || null;
} catch (error) {
responsibleUser = null;
}
const logChannel = settings.notificationChannelID ? await getGuildChannel(guild.id, settings.notificationChannelID) : null;
try {
if (!newChannel.deletable) throw new Error("Missing permissions to delete channel");
await newChannel.delete("[Automated] Detected blocked word in channel name");
await newChannel.setName("CENSORED", `[Automated] Detected blocked word in channel name. Name has been censored`);
} catch (error) {
if (!logChannel || !logChannel.isTextBased()) return;
const embed = getFailedEmbed();
embed.setDescription(`Couldn't delete <#${newChannel.id}> (${newChannel.id}): ${error instanceof Error ? error.message : error}`);
embed.addFields({
embed.setDescription(`Couldn't censor <#${newChannel.id}> (${newChannel.id}): ${error instanceof Error ? error.message : error}`);
if (isPremium) embed.addFields({
name: "Detected banned word:",
value: `||${found}||`
}, {
name: "Channel renamed by:",
value: responsibleUser ? `${responsibleUser.tag} (${responsibleUser.id})` : "`Couldn't detect responsible user :(`"
},{
name: "Old channel name:",
value: `||${name}||`,
inline: true
});
logChannel.send({
embeds: [embed]
}).catch(() => {});
}).catch();
return;
}
if (responsibleUser) {
const embed = getUserReportEmbed(guild.name, newChannel.name);
responsibleUser.send({
embeds: [embed]
}).catch(() => {});
}
if (!logChannel || !logChannel.isTextBased()) return;
const embed = getDefaultEmbed();
embed.setTitle(`${Emoji.SECURITY_CHALLENGE_FAILED} Blocked word detected`);
embed.setDescription(`||#${newChannel.name}|| (${newChannel.id}) has been deleted because its name contained a blocked word.`);
embed.setDescription(`<#${newChannel.id}> (${newChannel.id}) has been renamed because its name contained a blocked word.`);
embed.setColor(Color.WARNING_YELLOW);
embed.addFields({
if (isPremium) embed.addFields({
name: "Detected banned word:",
value: `||${found}||`,
inline: true
}, {
name: "Channel renamed by:",
value: responsibleUser ? `${responsibleUser.tag} (${responsibleUser.id})` : "`Couldn't detect responsible user :(`"
},{
name: "Old channel name:",
value: `||${name}||`,
inline: true
});
logChannel.send({
embeds: [embed]
}).catch(() => {});
}).catch();
});

View File

@ -1,17 +0,0 @@
import client from "../client";
import { Events } from "discord.js";
import { getGuildSetting } from "../tools/data";
import { Badword, database, GuildSetting } from "../data";
client.on(Events.GuildDelete, async (guild) => {
const settings = await getGuildSetting(guild.id);
if (settings.preserveDataOnGuildLeave) return;
await database.getRepository(GuildSetting).delete({
id: guild.id
});
await database.getRepository(Badword).delete({
guildID: guild.id
});
});

View File

@ -1,3 +1 @@
import "./channelUpdate";
import "./guildDelete";
import "./channelCreate";
import "./channelUpdate";

View File

@ -1,39 +0,0 @@
import { Badword, database, GuildSetting } from "../data";
import client from "../client";
import { DiscordAPIError } from "discord.js";
export default async function execute(): Promise<void> {
const guilds = await database.getRepository(GuildSetting).find({
where: {
preserveDataOnGuildLeave: false
}
});
for (const guild of guilds) {
try {
await client.guilds.fetch(guild.id);
} catch (error) {
if (!(error instanceof DiscordAPIError)) {
console.error(`service.cleanup failed: ${error}`);
return;
}
const id = guild.id;
// 5001 = Missing access
if (error.code.toString() !== "50001") {
console.warn(`Guild ${guild.id} is unavailable but not because of error 5001:\n${error}`);
continue;
}
await database.getRepository(Badword).delete({
guildID: guild.id
});
await database.getRepository(GuildSetting).remove(guild);
console.log(`Removed data for guild ${id}`);
}
}
console.log("Cleanup completed");
}

View File

@ -1,5 +1 @@
import runCleanup from "./cleanup";
export {
runCleanup
}
import "./uptime";

19
src/service/uptime.ts Normal file
View File

@ -0,0 +1,19 @@
import express from "express";
import pack from "../../package.json";
import startupTime from "../tools/startupTime";
const app = express();
app.get("/", (_req, res) => {
res.status(200).json({
running: true,
version: pack.version,
runningSince: startupTime.toISOString()
});
});
app.all("*", (_req, res) => {
res.status(404).end();
});
app.listen(80);

View File

@ -10,9 +10,17 @@ export async function getGuildSetting(guildID: string): Promise<GuildSetting> {
if (!guildSetting) {
guildSetting = new GuildSetting();
guildSetting.id = guildID;
guildSetting.isPremiumUntil = null;
guildSetting.notificationChannelID = null;
guildSetting.preserveDataOnGuildLeave = false;
}
return guildSetting;
}
export function isPremiumActive(timestamp: Date | null): boolean {
if (timestamp === null) return false;
const now = Number(new Date());
const activeUntil = Number(timestamp);
return now < activeUntil;
}

View File

@ -8,7 +8,7 @@ import { Color, Emoji } from "./design";
export default function getDefaultEmbed(): EmbedBuilder {
const embed = new EmbedBuilder();
embed.setFooter({
text: `Channel filter V${pack.version}`,
text: `Channel filter V${pack.version} by AstroGD®`,
iconURL: client.user?.avatarURL() || undefined,
});
embed.setTimestamp(new Date());
@ -28,16 +28,5 @@ export function getFailedEmbed(): EmbedBuilder {
const embed = getDefaultEmbed();
embed.setTitle(`${Emoji.CHAT_DENY} Failed`);
embed.setColor(Color.STOPSIGN_RED);
return embed;
}
export function getUserReportEmbed(guildName: string, channelName: string): EmbedBuilder {
const embed = getDefaultEmbed();
embed.setColor(Color.STOPSIGN_RED);
embed.setTitle(`${Emoji.SECURITY_CHALLENGE_FAILED} A channel you modified has been deleted`);
embed.setDescription(`Hey there ${Emoji.WAVING}
Your channel (#${channelName}) on the "${guildName}" server contained a blacklisted word and was deleted automatically.
Please make sure to keep channel names friendly for everyone!`);
return embed;
}

View File

@ -1,25 +1,10 @@
import { GuildBasedChannel, GuildTextBasedChannel, PermissionsBitField } from "discord.js";
import { GuildBasedChannel } from "discord.js";
import client from "../client";
export async function getGuildChannel(guildID: string, channelID: string): Promise<GuildBasedChannel | null> {
try {
const guild = await client.guilds.fetch(guildID);
if (!guild) return null;
const guild = await client.guilds.fetch(guildID);
if (!guild) return null;
const channel = await guild.channels.fetch(channelID);
return channel;
} catch (_error) {
return null;
}
}
export async function getChannelPermission(channel: GuildTextBasedChannel): Promise<Readonly<PermissionsBitField> | null> {
try {
const guildMember = await channel.guild.members.fetchMe();
if (!guildMember) return null;
return channel.permissionsFor(guildMember);
} catch (error) {
return null;
}
const channel = await guild.channels.fetch(channelID);
return channel;
}