Compare commits

...

79 Commits

Author SHA1 Message Date
b485b5d420 Merge pull request 'dev' (#26) from dev into main
Reviewed-on: #26
2023-09-16 15:39:32 +02:00
1c50e818b0 Merge pull request 'feature/uptime-kuma-heartbeat' (#25) from feature/uptime-kuma-heartbeat into dev
Reviewed-on: #25
2023-09-16 15:38:58 +02:00
8cb74a1291
Bump version 2023-09-16 15:35:30 +02:00
4bf782cddf
Add version scripts 2023-09-16 15:34:34 +02:00
c6a4577872
Implement push monitoring 2023-09-16 15:33:16 +02:00
3594c2ea8c Merge pull request 'hotfix/db-race' (#23) from hotfix/db-race into dev
Reviewed-on: #23
2023-09-16 11:20:08 +02:00
538d039c5c Merge branch 'dev' into hotfix/db-race 2023-09-16 11:19:12 +02:00
da1996f2ff Merge pull request 'Fix db race condition' (#20) from hotfix/db-race into main
Reviewed-on: #20
2023-09-16 11:14:33 +02:00
d5b75b12c8
Fix db race condition
- Fixed a bug where the bot would crash if the db connection took too long
- Updated packages to latest version
- Bumped version to 1.1.1
2023-09-16 11:12:43 +02:00
Lukas | AstroGD
a71dbecf8c
Merge pull request #19 from r-Overwatch2/main 2022-11-29 21:38:32 +01:00
Lukas | AstroGD
f528d107da
Merge pull request #18 from r-Overwatch2/release/1.1.0 2022-11-29 21:37:08 +01:00
9510116a37
Update lockfile 2022-11-29 21:36:18 +01:00
b8508a4a82
Adjust changelog 2022-11-29 21:34:02 +01:00
ccf2fd9361
Bump version number 2022-11-29 21:33:13 +01:00
cb4bddf983
Bump version number 2022-11-29 21:00:36 +01:00
b1b087e32c
Update reportEmbed wording 2022-11-29 21:00:09 +01:00
451b414fba
Bump version number 2022-11-29 20:55:03 +01:00
Lukas | AstroGD
b53c08a553
Merge pull request #17 from r-Overwatch2/feature/16-send-dm-to-user-that-used-blocked-word-in-channel
closes https://github.com/r-Overwatch2/eu.astrogd.white-leopard/issues/16
2022-11-29 19:40:29 +01:00
f34e06d31f
Format Readme 2022-11-29 19:38:18 +01:00
173438395e
Update env variable documentation 2022-11-29 19:30:25 +01:00
59429ea548
Removed unused import 2022-11-29 19:26:28 +01:00
dbb64baae3
Send message to user when their channel gets deleted 2022-11-29 19:22:11 +01:00
eccb379b51 Update user report embed 2022-11-29 19:21:00 +01:00
cb5516246f
Add user report Embed 2022-11-29 19:05:24 +01:00
Lukas | AstroGD
63c67f4992
Merge pull request #15 from r-Overwatch2/main 2022-11-29 03:22:52 +01:00
Lukas | AstroGD
b24cc4eba8
Merge pull request #14 from r-Overwatch2/release/1.0.0 2022-11-29 03:21:56 +01:00
4466c138ab
Update changelog 2022-11-29 03:20:59 +01:00
44e5cc8c91
Bump fs-extra to @^11 2022-11-29 03:20:48 +01:00
fc9f1c7c4c
Update packages 2022-11-29 03:19:07 +01:00
6be983b217
Bump version number 2022-11-29 03:13:51 +01:00
Lukas | AstroGD
781d2e547e
Merge pull request #13 from r-Overwatch2/feature/12-show-warning-if-logchannel-is-unreachable
closes https://github.com/r-Overwatch2/eu.astrogd.white-leopard/issues/12
2022-11-29 03:07:01 +01:00
ddf28c1612
Show missing permissions when using /showsettings 2022-11-29 03:04:29 +01:00
5fb9ad1e12
Push data model changes 2022-11-29 02:44:54 +01:00
bfabd62674
Detect blocked words on channel creation 2022-11-29 02:40:55 +01:00
5eb56efb79
Fetch target user from audit log 2022-11-29 02:36:46 +01:00
1c6c79dacf
Simplify fetching client member 2022-11-29 02:25:08 +01:00
f4b7685f94
Remove unused import 2022-11-29 01:58:08 +01:00
c3b0a4316b
[BREAKING] Switch from rename channel to delete channel
Reason: rate limits by Discord suck :(
2022-11-29 01:57:34 +01:00
ee9039c239
Remove premium features 2022-11-29 01:56:51 +01:00
361326c31e
Fix: Add empty function to catch clauses 2022-11-29 00:23:19 +01:00
f7c878854b
Warn if logchannel is misconfigured 2022-11-29 00:22:50 +01:00
a8cd924e18
Check for Logchannel permissions before accepting it 2022-11-29 00:22:33 +01:00
3a6641be86
Add start:rebuild script 2022-11-29 00:15:28 +01:00
c9df84b255
Fix crash when getting a channel that doesn't exist 2022-11-29 00:06:57 +01:00
0d69cf3e7b
Add channel permission getter 2022-11-29 00:05:04 +01:00
730151e34b
Update packages 2022-11-29 00:03:19 +01:00
Lukas | AstroGD
d4457e89ce
Merge pull request #11 from r-Overwatch2/release/1.0.0-beta.3
Release/1.0.0 beta.3
2022-11-25 19:52:25 +01:00
Lukas | AstroGD
11845cae42
Merge pull request #10 from r-Overwatch2/release/1.0.0-beta.3
Release/1.0.0 beta.3
2022-11-25 19:49:57 +01:00
d853fa55d3
Add changelog 2022-11-25 19:47:52 +01:00
88834703ef
Bump version number 2022-11-25 19:47:41 +01:00
Lukas | AstroGD
9cbb7799e9
Merge pull request #9 from r-Overwatch2/feature/6-add-a-way-to-view-current-settings
Feature/6 add a way to view current settings
2022-11-25 19:37:49 +01:00
005b9bd69c
Update embed color for /showsettings 2022-11-25 19:30:57 +01:00
21812157f8
/showsettings 2022-11-25 19:28:05 +01:00
52a349c1b9
Bump version number 2022-11-25 18:56:47 +01:00
Lukas | AstroGD
6242c09e4b
Merge pull request #8 from r-Overwatch2/feature/5-rework-default-permissions-for-slash-commands
Feature/5 rework default permissions for slash commands
2022-11-25 18:55:36 +01:00
24d39d471e
/showblocklist 2022-11-25 18:53:03 +01:00
545bda9bee
Document default permissions 2022-11-25 18:41:34 +01:00
966625bac4
Change logchannel default permission 2022-11-25 18:41:15 +01:00
Lukas | AstroGD
cc50a0a089
Merge pull request #7 from r-Overwatch2/feature/4-add-data-delete-on-guild-remove
Feature/4 add data delete on guild remove
2022-11-25 18:31:44 +01:00
27f625155e
Update readme 2022-11-25 18:30:48 +01:00
8b72326419
Cleanup on bot start 2022-11-25 18:28:42 +01:00
d9c81ef3f2
Delete data on guild delete 2022-11-25 17:51:37 +01:00
71b401dbee
Update cli guild info command 2022-11-25 17:46:39 +01:00
fda6166483
/preservesettings command 2022-11-25 17:44:21 +01:00
df2548dba6
Bump version number 2022-11-25 17:41:57 +01:00
ca29f047e9
Add data model changes 2022-11-25 17:16:10 +01:00
7a5d7f46b6
cli command guild delete
closes #3
2022-11-25 16:55:27 +01:00
0c9000a48c
Reduce branding 2022-11-25 16:20:12 +01:00
Lukas | AstroGD
fb2e3c4f11
Merge pull request #2 from r-Overwatch2/dev
Version 1.0.0-beta.2
2022-11-24 23:30:25 +01:00
657a58f3a5
Start api service on bot start 2022-11-24 23:06:28 +01:00
f695f0162f
bump version number 2022-11-24 23:04:46 +01:00
4fef4e8045
servercount cli command 2022-11-24 23:03:51 +01:00
df8d186139
expose api ports 2022-11-24 22:59:23 +01:00
f7727c3542
uptime monitor endpoint 2022-11-24 22:58:27 +01:00
7be72df267
Add settings emojis 2022-11-24 22:52:29 +01:00
Lukas | AstroGD
c8ed870fec
Merge pull request #1 from r-Overwatch2/dev
V1.0.0-beta.1
2022-11-24 21:29:42 +01:00
f8d029431f
Beta release 2022-11-24 21:25:41 +01:00
cd60d7dabc
cli support 2022-11-24 20:15:36 +01:00
62aa05031f
Update README 2022-11-24 18:07:29 +01:00
36 changed files with 2600 additions and 469 deletions

3
.npmrc Normal file
View File

@ -0,0 +1,3 @@
@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}

43
Changelog.md Normal file
View File

@ -0,0 +1,43 @@
# 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

@ -10,4 +10,5 @@ ENV NODE_ENV=production
COPY --from=builder node_modules ./node_modules COPY --from=builder node_modules ./node_modules
COPY build/ . COPY build/ .
VOLUME [ "/usr/src/app/data" ] VOLUME [ "/usr/src/app/data" ]
EXPOSE 80
CMD ["node", "--enable-source-maps", "index.js"] CMD ["node", "--enable-source-maps", "index.js"]

View File

@ -1,30 +1,61 @@
# eu.astrogd.white-leopard # eu.astrogd.white-leopard
A Discord bot that checks Discord channel names for banned words and prevents renaming of them A Discord bot that checks Discord channel names for banned words and prevents renaming of them
## Commands ## Commands
### /logchanel [channel?]
### /logchanel [channel?] `Permission: MANAGE_GUILD`
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. 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 ### /blocklist `Permission: MANAGE_GUILD`
#### /blocklist get #### /blocklist get
Gets the global and server specific banned word list and returns it
Returns the global and server specific banned word list and returns it (Same behaviour as /showblocklist)
#### /blocklist add [word] #### /blocklist add [word]
Adds the word to the server specific blocklist Adds the word to the server specific blocklist
#### /blocklist remove [word] #### /blocklist remove [word]
Removes the word from the server specific blocklist Removes the word from the server specific blocklist
## Environment variables ### /info `Permission: EVERYONE`
| Name | Description | Required | Example |
| :---------- | :------------------------------------------------------------ | :------: | :------------------ | Returns general information about the bot and the servers stats
| TOKEN | Discord bot token to log into the API with | ▶️/🚀 | NzYzMDP3MzE1Mzky... |
| DB_HOST | Hostname of the database | ▶️ | 127.0.0.1:3546 | ### /preservesettings `Permission: ADMINISTRATOR`
| DB_USERNAME | Username of the database | ▶️ | root |
| DB_PASSWORD | Password of the database | ▶️ | abc123 | Changes the behaviour when the bot leaves the server.
| DB_DATABASE | Database name | ▶️ | white-leopard | Options are:
| CLIENT_ID | Client ID of the Discord appication associated with the token | 🚀 | 763035392692274 |
- 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_USERNAME | Username of the database | ▶️ | root |
| DB_PASSWORD | Password of the database | ▶️ | abc123 |
| DB_DATABASE | Database name | ▶️ | white-leopard |
| CLIENT_ID | Client ID of the Discord appication associated with the token | 🚀 | 763035392692274 |
| 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 in runtime
- 🚀 = Required during CI/CD - 🚀 = Required during CI/CD

View File

@ -4,8 +4,8 @@ import dotenv from "dotenv";
dotenv.config({ path: path.join(__dirname, "../.env") }); dotenv.config({ path: path.join(__dirname, "../.env") });
// Environment checking // Environment checking
const TOKEN = process.env["TOKEN"]; const TOKEN = process.env["DEPLOY_TOKEN"];
const CLIENT_ID = process.env["CLIENT_ID"]; const CLIENT_ID = process.env["DEPLOY_CLIENT_ID"];
if (!TOKEN) throw new ReferenceError("Environment variable TOKEN is missing"); if (!TOKEN) throw new ReferenceError("Environment variable TOKEN is missing");
if (!CLIENT_ID) throw new ReferenceError("Environment variable CLIENT_ID is missing"); if (!CLIENT_ID) throw new ReferenceError("Environment variable CLIENT_ID is missing");

View File

@ -1,18 +1,23 @@
version: "2" version: "3.9"
services: services:
app: app:
image: astrogd/white-leopard:dev image: astrogd/white-leopard:dev
build: ./ build: ./
ports:
- 80:80
tty: true
stdin_open: true
depends_on: depends_on:
- database - db
restart: unless-stopped restart: unless-stopped
environment: environment:
- TOKEN=$TOKEN - TOKEN=$TOKEN
- DB_HOST=database - DB_HOST=db
- DB_USERNAME=$DB_USERNAME - DB_USERNAME=$DB_USERNAME
- DB_PASSWORD=$DB_PASSWORD - DB_PASSWORD=$DB_PASSWORD
- DB_DATABASE=$DB_DATABASE - DB_DATABASE=$DB_DATABASE
database: - MONITOR_URL=$MONITOR_URL
db:
image: postgres:latest image: postgres:latest
restart: unless-stopped restart: unless-stopped
ports: ports:

View File

@ -4,9 +4,12 @@ import swapConsole from "./src/tools/consoleSwapper";
config(); config();
swapConsole(); swapConsole();
import "./src/tools/startupTime";
import "./src/client/init"; import "./src/client/init";
import "./src/commands"; import "./src/commands";
import "./src/events"; import "./src/events";
import "./src/cli";
import "./src/service";
import client from "./src/client"; import client from "./src/client";
function shutdown() { function shutdown() {
@ -16,4 +19,5 @@ function shutdown() {
} }
process.on("SIGINT", shutdown); process.on("SIGINT", shutdown);
process.on("SIGHUP", shutdown); process.on("SIGHUP", shutdown);
process.on("SIGTERM", shutdown);

1897
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

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

80
src/cli/global.ts Normal file
View File

@ -0,0 +1,80 @@
import { IsNull } from "typeorm";
import { Badword, database } from "../data";
import { Console } from "console";
const console = new Console(process.stdout);
export default async function execute(args: string[]) {
const command = args[0];
if (!command) return printHelp();
switch (command.toLowerCase()) {
case "get": {
const globalWords = await database.getRepository(Badword).find({
where: {
guildID: IsNull()
}
});
console.log(`Global blocked words:\n\n${globalWords.map(w => w.value).reduce((c, n) => c + ", " + n, "").slice(2)}`);
break;
}
case "add": {
const word = args[1]?.toLowerCase();
if (!word) return printHelp();
if (await database.getRepository(Badword).count({
where: {
value: word,
guildID: IsNull()
}
}) > 0) return console.log(`${word} is already in the blocklist`);
const entity = new Badword();
entity.value = word;
await database.getRepository(Badword).save(entity);
console.log(`${word} has been added to the global block list`);
break;
}
case "remove": {
const word = args[1]?.toLowerCase();
if (!word) return printHelp();
await database.getRepository(Badword).delete({
value: word,
guildID: IsNull()
});
console.log(`Removed ${word} from the global block list`);
break;
}
case "count": {
const count = await database.getRepository(Badword).count({
where: {
guildID: IsNull()
}
});
console.log(`There are ${count} globally blocked words`);
break;
}
default: {
printHelp();
break;
}
}
}
function printHelp() {
console.log(`Usage "global":
global get
global add [WORD]
global remove [WORD]
global count`);
}

140
src/cli/guild.ts Normal file
View File

@ -0,0 +1,140 @@
import { getGuildSetting } from "../tools/data";
import { Badword, database, GuildSetting } from "../data";
import { Console } from "console";
const console = new Console(process.stdout);
export default async function execute(args: string[]) {
const command = args[0];
if (!command) return printHelp();
switch (command.toLowerCase()) {
case "info": {
if (!args[1]) return printHelp();
const settings = await getGuildSetting(args[1]);
const wordCount = await database.getRepository(Badword).count({
where: {
guildID: args[1]
}
});
console.log(`Guild ${args[1]}:
- Preserve Settings: ${settings.preserveDataOnGuildLeave ? "ENABLED" : "DISABLED"}
- Logchannel: ${settings.notificationChannelID ? `ENABLED (${settings.notificationChannelID})` : "DISABLED"}
- blocked Words: ${wordCount}`);
break;
}
case "words": {
if (!args[1] || !args[2]) return printWordHelp();
const badWords = await database.getRepository(Badword).find({
where: {
guildID: args[2]
}
});
switch (args[1].toLowerCase()) {
case "get": {
console.log(`Bad words for ${args[2]}:\n\n${badWords.map((badWord) => badWord.value).reduce((prev, next) => prev + ", " + next, "").slice(2)}`);
break;
}
case "add": {
if (!args[3]) {
printWordHelp();
break;
}
if (badWords.filter(w => w.value === args[3]!.toLowerCase()).length > 0) {
console.log("Word already exists");
break;
}
const badWord = new Badword();
badWord.guildID = args[2];
badWord.value = args[3].toLowerCase();
await database.getRepository(Badword).save(badWord);
console.log(`${args[3].toLowerCase()} added to guild ${args[2]}`);
break;
}
case "remove": {
if (!args[3]) {
printWordHelp();
break;
}
const badWord = badWords.find((w) => w.value === args[3]?.toLowerCase());
if (!badWord) {
console.log(`${args[3].toLowerCase()} is not in blocklist of guild ${args[2]}`);
break;
}
await database.getRepository(Badword).delete({
id: badWord.id
});
console.log(`${badWord.value} deleted for guild ${args[2]}`);
break;
}
case "clear": {
await database.getRepository(Badword).delete({
guildID: args[2]
});
console.log(`Deleted ${badWords.length} entries`);
break;
}
default: {
printHelp();
break;
}
}
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;
}
}
}
function printHelp() {
console.log(`Usage "guild":
guild info [GUILDID]
guild words [get|add|remove|clear]
guild delete [GUILDID]`);
}
function printWordHelp() {
console.log(`Usage "guild words":
guild words get [GUILDID]
guild words add [GUILDID] [WORD]
guild words remove [GUILDID] [WORD]
guild words clear [GUILDID]`);
}

75
src/cli/index.ts Normal file
View File

@ -0,0 +1,75 @@
import * as readline from "node:readline/promises";
import { stdin as input, stdout as output } from "node:process";
import pack from "../../package.json";
import { Console } from "node:console";
import moment from "moment";
import startupTime from "../tools/startupTime";
import client from "../client";
import guild from "./guild";
import global from "./global";
const console = new Console(process.stdout);
const rl = readline.createInterface(input, output);
rl.on("line", async (msg) => {
const [command, ...args] = msg.split(" ");
if (!command) return;
switch (command.toLowerCase()) {
case "version": {
console.log(`Channel filter V${pack.version} by AstroGD®`);
break;
}
case "uptime": {
console.log(`Application is running for ${moment(startupTime).fromNow(true)}`);
break;
}
case "clear": {
console.clear();
break;
}
case "guild": {
await guild(args);
break;
}
case "help": {
printHelp();
break;
}
case "global": {
await global(args);
break;
}
case "servercount": {
console.log(`This bot is on ${client.guilds.cache.size} guilds`);
break;
}
default: {
console.log(`Unknown command. Try "help" for help`);
break;
}
}
rl.prompt();
});
function printHelp() {
console.log(`Commands:
version
uptime
guild
global
help
servercount
clear`);
}

View File

@ -1,10 +1,25 @@
import { runCleanup } from "../service";
import client from "./index"; import client from "./index";
import { initPromise } from "../data/dataSource";
import pushMonitor from "@astrogd/eu.astrogd.uptime-kuma-push-monitor";
const token = process.env["TOKEN"]; const token = process.env["TOKEN"];
if (!token) throw new ReferenceError("TOKEN environment variable is missing"); if (!token) throw new ReferenceError("TOKEN environment variable is missing");
client.login(token); async function run() {
console.log("Establishing database connection");
await initPromise;
console.log("Connection established\nAuthenticating with Discord API");
client.login(token);
}
client.on("ready", () => { client.on("ready", async () => {
console.log(`Connected to Discord API. Bot account is ${client.user?.tag} (${client.user?.id})`); 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,10 +1,11 @@
import { ChatInputCommandInteraction, PermissionFlagsBits, SlashCommandBuilder } from "discord.js"; import { ChatInputCommandInteraction, PermissionFlagsBits, SlashCommandBuilder } from "discord.js";
import { database, Badword } from "../data"; import { database, Badword } from "../data";
import { IsNull } from "typeorm"; import { IsNull } from "typeorm";
import { getGuildSetting, isPremiumActive } from "../tools/data"; import { getGuildSetting } from "../tools/data";
import getDefaultEmbed, { getFailedEmbed, getSuccessEmbed } from "../tools/defaultEmbeds"; import getDefaultEmbed, { getFailedEmbed, getSuccessEmbed } from "../tools/defaultEmbeds";
import { getGuildChannel } from "../tools/discord"; import { getGuildChannel } from "../tools/discord";
import { Color, Emoji } from "../tools/design"; import { Color, Emoji } from "../tools/design";
import { execute as showBlocklistRunner } from "./showblocklist";
const builder = new SlashCommandBuilder(); const builder = new SlashCommandBuilder();
builder.setName("blocklist"); builder.setName("blocklist");
@ -45,30 +46,12 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
if (!interaction.guildId) throw new Error("Command was executed in DM context"); if (!interaction.guildId) throw new Error("Command was executed in DM context");
const settings = await getGuildSetting(interaction.guildId); const settings = await getGuildSetting(interaction.guildId);
const isPremium = isPremiumActive(settings.isPremiumUntil);
const logChannel = settings.notificationChannelID ? await getGuildChannel(interaction.guildId, settings.notificationChannelID) : null; const logChannel = settings.notificationChannelID ? await getGuildChannel(interaction.guildId, settings.notificationChannelID) : null;
switch (interaction.options.getSubcommand(true)) { switch (interaction.options.getSubcommand(true)) {
case "get": { case "get": {
const guildBadWords = await database.getRepository(Badword).find({ await showBlocklistRunner(interaction);
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; break;
} }
@ -79,14 +62,14 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
} }
}); });
const limit = isPremium ? 100 : 10; const limit = 100;
if (count >= limit) { if (count >= limit) {
const embed = getFailedEmbed(); const embed = getFailedEmbed();
embed.setDescription(`You reached the word limit for your guild. Please delete a word before adding a new one`); embed.setDescription(`You reached the word limit for your guild. Please delete a word before adding a new one`);
interaction.reply({ interaction.reply({
embeds: [embed], embeds: [embed],
ephemeral: true ephemeral: true
}).catch(); }).catch(() => {});
return; return;
} }
@ -105,7 +88,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
interaction.reply({ interaction.reply({
embeds: [embed], embeds: [embed],
ephemeral: true ephemeral: true
}).catch(); }).catch(() => {});
return; return;
} }
@ -133,7 +116,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
if (logChannel && logChannel.isTextBased()) { if (logChannel && logChannel.isTextBased()) {
logChannel.send({ logChannel.send({
embeds: [logMessage] embeds: [logMessage]
}).catch(); }).catch(() => {});
} }
break; break;
} }
@ -154,7 +137,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
interaction.reply({ interaction.reply({
embeds: [embed], embeds: [embed],
ephemeral: true ephemeral: true
}).catch(); }).catch(() => {});
return; return;
} }
@ -167,7 +150,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
interaction.reply({ interaction.reply({
embeds: [embed], embeds: [embed],
ephemeral: true ephemeral: true
}).catch(); }).catch(() => {});
const logMessage = getDefaultEmbed(); const logMessage = getDefaultEmbed();
logMessage.setTitle(`${Emoji.SETTINGS} Word removed`); logMessage.setTitle(`${Emoji.SETTINGS} Word removed`);
@ -180,7 +163,7 @@ async function execute(interaction: ChatInputCommandInteraction): Promise<void>
if (logChannel && logChannel.isTextBased()) { if (logChannel && logChannel.isTextBased()) {
logChannel.send({ logChannel.send({
embeds: [logMessage] embeds: [logMessage]
}).catch(); }).catch(() => {});
} }
break; break;
} }

View File

@ -1,8 +1,19 @@
import * as notification from "./notification"; import * as notification from "./logchannel";
import * as blocklist from "./blocklist"; import * as blocklist from "./blocklist";
import * as info from "./info"; import * as info from "./info";
import * as preserveSettings from "./preserveSettings";
import * as showBlocklist from "./showblocklist";
import * as showSettings from "./showSettings";
const array = [notification.builder.toJSON(), blocklist.builder.toJSON(), info.builder.toJSON()]; 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());
export { export {
array array

View File

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

View File

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

View File

@ -1,14 +1,15 @@
import { SlashCommandBuilder, PermissionFlagsBits, ChannelType, ChatInputCommandInteraction, NewsChannel, TextBasedChannel, CategoryChannel, StageChannel, TextChannel, PrivateThreadChannel, PublicThreadChannel, VoiceChannel, APIInteractionDataResolvedChannel, ForumChannel } from "discord.js"; import { SlashCommandBuilder, PermissionFlagsBits, ChannelType, ChatInputCommandInteraction, NewsChannel, TextBasedChannel, CategoryChannel, StageChannel, TextChannel, PrivateThreadChannel, PublicThreadChannel, VoiceChannel, APIInteractionDataResolvedChannel, ForumChannel } from "discord.js";
import getDefaultEmbed, { getSuccessEmbed } from "../tools/defaultEmbeds"; import getDefaultEmbed, { getFailedEmbed, getSuccessEmbed } from "../tools/defaultEmbeds";
import { database, GuildSetting } from "../data"; import { database, GuildSetting } from "../data";
import { getGuildSetting } from "../tools/data"; import { getGuildSetting } from "../tools/data";
import { getGuildChannel } from "../tools/discord"; import { getGuildChannel, getChannelPermission } from "../tools/discord";
import { Emoji } from "../tools/design";
const builder = new SlashCommandBuilder(); const builder = new SlashCommandBuilder();
builder.setName("logchannel"); builder.setName("logchannel");
builder.setDescription("Configures the log channel"); builder.setDescription("Configures the log channel");
builder.setDMPermission(false); builder.setDMPermission(false);
builder.setDefaultMemberPermissions(PermissionFlagsBits.ManageChannels); builder.setDefaultMemberPermissions(PermissionFlagsBits.ManageGuild);
builder.addChannelOption((option) => { builder.addChannelOption((option) => {
option.addChannelTypes(ChannelType.GuildText, ChannelType.GuildAnnouncement); option.addChannelTypes(ChannelType.GuildText, ChannelType.GuildAnnouncement);
option.setName("channel"); option.setName("channel");
@ -19,7 +20,7 @@ builder.addChannelOption((option) => {
async function resetNotificationChannel(guildSetting: GuildSetting, interaction: ChatInputCommandInteraction): Promise<void> { async function resetNotificationChannel(guildSetting: GuildSetting, interaction: ChatInputCommandInteraction): Promise<void> {
const logChannel = guildSetting.notificationChannelID ? await getGuildChannel(guildSetting.id, guildSetting.notificationChannelID) : null; const logChannel = guildSetting.notificationChannelID ? await getGuildChannel(guildSetting.id, guildSetting.notificationChannelID) : null;
guildSetting.notificationChannelID = null; guildSetting.notificationChannelID = null;
await database.getRepository(GuildSetting).save(guildSetting); await database.getRepository(GuildSetting).save(guildSetting);
@ -30,11 +31,11 @@ async function resetNotificationChannel(guildSetting: GuildSetting, interaction:
name: "This action was performed by", name: "This action was performed by",
value: `${interaction.user.tag} (${interaction.user.id})` value: `${interaction.user.tag} (${interaction.user.id})`
}); });
if (logChannel && logChannel.isTextBased()) { if (logChannel && logChannel.isTextBased()) {
logChannel.send({ logChannel.send({
embeds: [logEmbed] embeds: [logEmbed]
}).catch(); }).catch(() => {});
} }
const embed = getSuccessEmbed(); const embed = getSuccessEmbed();
@ -42,7 +43,7 @@ async function resetNotificationChannel(guildSetting: GuildSetting, interaction:
interaction.reply({ interaction.reply({
embeds: [embed], embeds: [embed],
ephemeral: true ephemeral: true
}).catch(); }).catch(() => {});
} }
const execute = async (interaction: ChatInputCommandInteraction) => { const execute = async (interaction: ChatInputCommandInteraction) => {
@ -54,10 +55,24 @@ const execute = async (interaction: ChatInputCommandInteraction) => {
if (!optionVal) return await resetNotificationChannel(guildSetting, interaction); if (!optionVal) return await resetNotificationChannel(guildSetting, interaction);
const channel = getTextBasedChannel(optionVal); 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) { if (guildSetting.notificationChannelID) {
const oldLogChannel = await getGuildChannel(guildSetting.id, guildSetting.notificationChannelID); const oldLogChannel = await getGuildChannel(guildSetting.id, guildSetting.notificationChannelID);
const embed = getDefaultEmbed(); const embed = getDefaultEmbed();
embed.setTitle("Settings changed"); embed.setTitle(`${Emoji.SETTINGS} Settings changed`);
embed.setDescription(`Log channel has been switched to <#${channel.id}>`); embed.setDescription(`Log channel has been switched to <#${channel.id}>`);
embed.addFields({ embed.addFields({
name: "This action was performed by", name: "This action was performed by",
@ -67,7 +82,7 @@ const execute = async (interaction: ChatInputCommandInteraction) => {
if (oldLogChannel && oldLogChannel.isTextBased()) { if (oldLogChannel && oldLogChannel.isTextBased()) {
oldLogChannel.send({ oldLogChannel.send({
embeds: [embed] embeds: [embed]
}).catch(); }).catch(() => {});
} }
} }
@ -75,7 +90,7 @@ const execute = async (interaction: ChatInputCommandInteraction) => {
await database.getRepository(GuildSetting).save(guildSetting); await database.getRepository(GuildSetting).save(guildSetting);
const embed = getDefaultEmbed(); const embed = getDefaultEmbed();
embed.setTitle("Settings changed"); embed.setTitle(`${Emoji.SETTINGS} Settings changed`);
embed.setDescription("This channel has been set as the log channel"); embed.setDescription("This channel has been set as the log channel");
embed.addFields({ embed.addFields({
name: "This action was performed by", name: "This action was performed by",
@ -83,16 +98,16 @@ const execute = async (interaction: ChatInputCommandInteraction) => {
}); });
channel.send({ channel.send({
embeds: [ embed ] embeds: [embed]
}).catch(); }).catch(() => {});
const reply = getSuccessEmbed(); const reply = getSuccessEmbed();
reply.setDescription(`Log channel was set to <#${channel.id}>`); reply.setDescription(`Log channel was set to <#${channel.id}>`);
interaction.reply({ interaction.reply({
embeds: [ reply ], embeds: [reply],
ephemeral: true ephemeral: true
}).catch(); }).catch(() => {});
return; return;
} }

View File

@ -0,0 +1,66 @@
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

@ -0,0 +1,110 @@
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

@ -0,0 +1,37 @@
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

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

View File

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

View File

@ -0,0 +1,19 @@
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

@ -0,0 +1,19 @@
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 }) @Column("varchar", { nullable: true, default: null })
notificationChannelID!: string | null; notificationChannelID!: string | null;
@Column("timestamp", { nullable: true, default: null }) @Column("boolean", { default: false })
isPremiumUntil!: Date | null; preserveDataOnGuildLeave!: boolean
} }

116
src/events/channelCreate.ts Normal file
View File

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

17
src/events/guildDelete.ts Normal file
View File

@ -0,0 +1,17 @@
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 +1,3 @@
import "./channelUpdate"; import "./channelUpdate";
import "./guildDelete";
import "./channelCreate";

39
src/service/cleanup.ts Normal file
View File

@ -0,0 +1,39 @@
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");
}

5
src/service/index.ts Normal file
View File

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

View File

@ -10,17 +10,9 @@ export async function getGuildSetting(guildID: string): Promise<GuildSetting> {
if (!guildSetting) { if (!guildSetting) {
guildSetting = new GuildSetting(); guildSetting = new GuildSetting();
guildSetting.id = guildID; guildSetting.id = guildID;
guildSetting.isPremiumUntil = null;
guildSetting.notificationChannelID = null; guildSetting.notificationChannelID = null;
guildSetting.preserveDataOnGuildLeave = false;
} }
return guildSetting; 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 { export default function getDefaultEmbed(): EmbedBuilder {
const embed = new EmbedBuilder(); const embed = new EmbedBuilder();
embed.setFooter({ embed.setFooter({
text: `Channel filter V${pack.version} by AstroGD®`, text: `Channel filter V${pack.version}`,
iconURL: client.user?.avatarURL() || undefined, iconURL: client.user?.avatarURL() || undefined,
}); });
embed.setTimestamp(new Date()); embed.setTimestamp(new Date());
@ -28,5 +28,16 @@ export function getFailedEmbed(): EmbedBuilder {
const embed = getDefaultEmbed(); const embed = getDefaultEmbed();
embed.setTitle(`${Emoji.CHAT_DENY} Failed`); embed.setTitle(`${Emoji.CHAT_DENY} Failed`);
embed.setColor(Color.STOPSIGN_RED); 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; return embed;
} }

View File

@ -1,10 +1,25 @@
import { GuildBasedChannel } from "discord.js"; import { GuildBasedChannel, GuildTextBasedChannel, PermissionsBitField } from "discord.js";
import client from "../client"; import client from "../client";
export async function getGuildChannel(guildID: string, channelID: string): Promise<GuildBasedChannel | null> { export async function getGuildChannel(guildID: string, channelID: string): Promise<GuildBasedChannel | null> {
const guild = await client.guilds.fetch(guildID); try {
if (!guild) return null; const guild = await client.guilds.fetch(guildID);
if (!guild) return null;
const channel = await guild.channels.fetch(channelID); const channel = await guild.channels.fetch(channelID);
return channel; 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;
}
} }

3
src/tools/startupTime.ts Normal file
View File

@ -0,0 +1,3 @@
const startupTime = new Date();
export default startupTime;