├── .gitignore ├── src ├── extensions │ ├── index.ts │ ├── GuildMember.ts │ └── Guild.ts ├── database │ └── index.ts ├── structures │ ├── index.ts │ ├── Command.ts │ ├── Client.ts │ ├── ActionManager.ts │ └── Snapshot.ts ├── events │ ├── guildCreate.ts │ ├── index.ts │ ├── roleCreate.ts │ ├── guildUpdate.ts │ ├── ready.ts │ ├── guildMemberUpdate.ts │ ├── guildMemberAdd.ts │ ├── interactionCreate.ts │ ├── roleUpdate.ts │ ├── channelUpdate.ts │ └── messageCreate.ts ├── config.ts ├── commands │ ├── index.ts │ ├── uptime.ts │ ├── invite.ts │ ├── ping.ts │ ├── settings │ │ ├── index.ts │ │ ├── show.ts │ │ ├── toggle.ts │ │ └── set.ts │ ├── unmute.ts │ ├── ban.ts │ ├── kick.ts │ ├── about.ts │ ├── mute.ts │ └── clear.ts ├── utils.ts ├── Constants.ts └── index.ts ├── env.example ├── .github └── workflows │ └── typecheck.yml ├── package.json ├── tsconfig.json ├── @types └── index.d.ts ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | *-lock.* 4 | test.* 5 | .env -------------------------------------------------------------------------------- /src/extensions/index.ts: -------------------------------------------------------------------------------- 1 | import './Guild' 2 | import './GuildMember' -------------------------------------------------------------------------------- /src/database/index.ts: -------------------------------------------------------------------------------- 1 | import Redis from 'ioredis' 2 | import config from '../config' 3 | 4 | export default new Redis(config.redis) -------------------------------------------------------------------------------- /src/structures/index.ts: -------------------------------------------------------------------------------- 1 | export * from './ActionManager' 2 | export * from './Client' 3 | export * from './Command' 4 | export * from './Snapshot' -------------------------------------------------------------------------------- /env.example: -------------------------------------------------------------------------------- 1 | # Put your discord token here (required) 2 | DISCORD_TOKEN=secret-token 3 | 4 | 5 | # Put your redis database url (required) 6 | REDIS_URI=redis://... -------------------------------------------------------------------------------- /src/events/guildCreate.ts: -------------------------------------------------------------------------------- 1 | import type { Guild } from 'discord.js' 2 | 3 | export const guildCreate = async (guild: Guild) => { 4 | await guild.setup() 5 | } -------------------------------------------------------------------------------- /src/config.ts: -------------------------------------------------------------------------------- 1 | import 'dotenv/config' 2 | 3 | const config = { 4 | token: process.env.DISCORD_TOKEN!, 5 | redis: process.env.REDIS_URI! 6 | } 7 | 8 | export default config -------------------------------------------------------------------------------- /src/commands/index.ts: -------------------------------------------------------------------------------- 1 | export * from './about' 2 | export * from './ban' 3 | export * from './clear' 4 | export * from './invite' 5 | export * from './kick' 6 | export * from './mute' 7 | export * from './ping' 8 | export * from './settings' 9 | export * from './unmute' 10 | export * from './uptime' -------------------------------------------------------------------------------- /.github/workflows/typecheck.yml: -------------------------------------------------------------------------------- 1 | name: Typecheck Files 2 | 3 | on: [push, pull_request] 4 | jobs: 5 | typecheck: 6 | runs-on: ubuntu-latest 7 | steps: 8 | - uses: actions/checkout@v2 9 | - uses: actions/setup-node@v1 10 | with: 11 | node-version: 16.x 12 | - run: npm install 13 | - run: npm test 14 | -------------------------------------------------------------------------------- /src/events/index.ts: -------------------------------------------------------------------------------- 1 | export * from './channelUpdate' 2 | export * from './guildCreate' 3 | export * from './guildMemberAdd' 4 | export * from './guildMemberUpdate' 5 | export * from './guildUpdate' 6 | export * from './interactionCreate' 7 | export * from './messageCreate' 8 | export * from './ready' 9 | export * from './roleCreate' 10 | export * from './roleUpdate' -------------------------------------------------------------------------------- /src/commands/uptime.ts: -------------------------------------------------------------------------------- 1 | import type { Command, CTX } from '../structures' 2 | import ms from 'ms' 3 | 4 | export class Uptime implements Command { 5 | name = 'uptime' 6 | description = 'Shows bot uptime' 7 | async run(ctx: CTX): Promise { 8 | const uptime = ms(ctx.client.uptime!, { long: true }) 9 | await ctx.reply({ content: `Uptime: **${uptime}**`, ephemeral: true }) 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /src/commands/invite.ts: -------------------------------------------------------------------------------- 1 | import type { CTX, Command } from '../structures' 2 | 3 | export class InviteCommand implements Command { 4 | name = 'invite' 5 | description = 'An invite to add me to your server' 6 | run(ctx: CTX) { 7 | const link = ctx.client.generateInvite({ 8 | scopes: ['bot', 'applications.commands'], 9 | permissions: ['ADMINISTRATOR'] 10 | }) 11 | return ctx.reply(`[**Invite me!**](${link})`) 12 | } 13 | } -------------------------------------------------------------------------------- /src/extensions/GuildMember.ts: -------------------------------------------------------------------------------- 1 | import { GuildMember } from 'discord.js' 2 | 3 | GuildMember.prototype.dm = async function (content: string, times = 1) { 4 | if (!this.guild.settings.privateAlerts) return false 5 | 6 | const channel = await this.createDM(false).catch(() => null) 7 | 8 | if (!channel) return false 9 | 10 | let i = 0 11 | 12 | while (i++ < times) try { 13 | await channel.send(content) 14 | } catch { 15 | return false 16 | } 17 | 18 | return true 19 | } -------------------------------------------------------------------------------- /src/events/roleCreate.ts: -------------------------------------------------------------------------------- 1 | import type { Role } from 'discord.js' 2 | import { BAD_PERMISSIONS } from '../Constants' 3 | 4 | export const roleCreate = async (role: Role): Promise => { 5 | if (!role.guild.active) return 6 | if (!role.permissions.any(BAD_PERMISSIONS) || role.managed) return 7 | 8 | const executor = await role.guild.fetchExecutor('ROLE_CREATE', role.id) 9 | 10 | if (executor && !role.guild.isPunishable(executor.id)) return 11 | 12 | await role.delete('Detected creation of role with bad permissions') 13 | } 14 | -------------------------------------------------------------------------------- /src/commands/ping.ts: -------------------------------------------------------------------------------- 1 | import type { CTX, Command } from '../structures' 2 | import { SnowflakeUtil } from 'discord.js' 3 | 4 | export class Ping implements Command { 5 | name = 'ping' 6 | description = 'Pong?' 7 | async run(ctx: CTX): Promise { 8 | const msg = await ctx.reply({ content: '**Ping...**', fetchReply: true, ephemeral: true }) 9 | const ping = Math.abs((SnowflakeUtil.timestampFrom(msg.id) - ctx.createdTimestamp) - ctx.client.ws.ping) 10 | await ctx.editReply(`Pong: \`${ping}ms\``) 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /src/structures/Command.ts: -------------------------------------------------------------------------------- 1 | import { ChatInputApplicationCommandData, ApplicationCommandSubCommandData, CommandInteraction, PermissionResolvable } from 'discord.js' 2 | 3 | 4 | export interface Command extends ChatInputApplicationCommandData { 5 | permissions?: PermissionResolvable 6 | run(ctx: CommandInteraction): Awaited 7 | } 8 | 9 | export interface SubCommand extends ApplicationCommandSubCommandData { 10 | run(ctx: CommandInteraction): Awaited 11 | } 12 | 13 | export class CommandError { 14 | constructor(public message: string) {} 15 | } 16 | 17 | export type CTX = CommandInteraction<'cached'> -------------------------------------------------------------------------------- /src/commands/settings/index.ts: -------------------------------------------------------------------------------- 1 | import { CTX, Command } from '../../structures' 2 | import { SettingsSetCommand } from './set' 3 | import { SettingsShowCommand } from './show' 4 | import { SettingsToggleCommand } from './toggle' 5 | 6 | export class SettingsCommand implements Command { 7 | name = 'settings' 8 | description = 'Guild Settings' 9 | options = [new SettingsShowCommand(), new SettingsSetCommand(), new SettingsToggleCommand()] 10 | permissions = ['ADMINISTRATOR'] as const 11 | run(ctx: CTX) { 12 | const name = ctx.options.getSubcommand(true) 13 | const cmd = this.options.find(c => c.name === name) 14 | return cmd?.run(ctx) 15 | } 16 | } -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gabriel-bot", 3 | "description": "The Best Protection Discord Bot Ever", 4 | "version": "1.0.0", 5 | "private": true, 6 | "main": "dist/index.js", 7 | "scripts": { 8 | "build": "tsc", 9 | "start": "node --experimental-specifier-resolution=node dist/index.js", 10 | "test": "tsc --noEmit && echo 'All specs passed validation. You are ready to push!'" 11 | }, 12 | "type": "module", 13 | "dependencies": { 14 | "discord.js": "^13.7.0", 15 | "dotenv": "^16.0.0", 16 | "ioredis": "^5.0.5", 17 | "ms": "^3.0.0-beta.2" 18 | }, 19 | "devDependencies": { 20 | "typescript": "^4.6.3" 21 | }, 22 | "license": "AGPL-3.0", 23 | "engines": { 24 | "node": ">=16.9" 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/commands/unmute.ts: -------------------------------------------------------------------------------- 1 | import { CTX, Command, CommandError } from '../structures' 2 | 3 | export class UnmuteCommand implements Command { 4 | name = 'unmute' 5 | description = 'Unmutes a user' 6 | options = [{ 7 | name: 'user', 8 | type: 'USER' as const, 9 | description: 'Targeted user', 10 | required: true 11 | }] 12 | permissions = ['MUTE_MEMBERS'] as const 13 | async run(ctx: CTX) { 14 | const member = ctx.options.getMember('user', true) 15 | 16 | if (member.communicationDisabledUntilTimestamp < Date.now()) throw new CommandError(`**${member.user.tag}** isn't muted`) 17 | 18 | await member.disableCommunicationUntil(null) 19 | 20 | return ctx.reply(`${member} has been unmuted.`) 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /src/structures/Client.ts: -------------------------------------------------------------------------------- 1 | import { Client as DiscordClient, Collection } from 'discord.js' 2 | import { Command } from '.' 3 | 4 | import * as commands from '../commands' 5 | import * as events from '../events' 6 | 7 | export class Client extends DiscordClient { 8 | readonly commands = new Collection() 9 | 10 | loadEvents(): number { 11 | let i = 0 12 | for (const args of Object.entries(events)) super.on(...args) && i++ 13 | return i 14 | } 15 | 16 | loadCommands(): number { 17 | for (const Command of Object.values(commands)) { 18 | const command = new Command() 19 | this.commands.set(command.name, command) 20 | } 21 | 22 | return this.commands.size 23 | } 24 | } 25 | 26 | export { Intents } from 'discord.js' 27 | -------------------------------------------------------------------------------- /src/events/guildUpdate.ts: -------------------------------------------------------------------------------- 1 | import type { Guild } from 'discord.js' 2 | import { inviteRegExp } from '../utils' 3 | 4 | export const guildUpdate = async (oldGuild: Guild, guild: Guild): Promise => { 5 | if (!guild.active) return 6 | 7 | if (guild.defaultMessageNotifications === 'ALL_MESSAGES') { 8 | await guild.setDefaultMessageNotifications('ONLY_MENTIONS', 'All Messages cannot be enabled').catch(() => null) 9 | } 10 | 11 | if (guild.name === oldGuild.name || !inviteRegExp.test(guild.name)) return 12 | 13 | const executor = await guild.fetchExecutor('GUILD_UPDATE') 14 | 15 | if (executor && !guild.isPunishable(executor.id)) return 16 | 17 | await guild.setName(oldGuild.name, `(${executor?.tag ?? 'Unknown#0000'}): This name cantinas an invite`) 18 | 19 | if (executor) await guild.punish(executor.id) 20 | } 21 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ 4 | "module": "esnext", /* Specify what module code is generated. */ 5 | "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ 6 | "resolveJsonModule": true, /* Enable importing .json files */ 7 | "outDir": "dist", /* Specify an output folder for all emitted files. */ 8 | "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */ 9 | "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ 10 | "skipLibCheck": true /* Skip type checking all .d.ts files. */ 11 | } 12 | } -------------------------------------------------------------------------------- /src/events/ready.ts: -------------------------------------------------------------------------------- 1 | import type { Client } from 'discord.js' 2 | import { Snapshot } from '../structures/Snapshot' 3 | import ms from 'ms' 4 | 5 | export const ready = async (client: Client): Promise => { 6 | console.log('Connected') 7 | console.log(client.user.tag) 8 | 9 | await client.application.commands.set(client.commands.toJSON()) 10 | 11 | console.log('Deployed the commands.') 12 | 13 | const promises: Promise[] = [] 14 | 15 | for (const guild of client.guilds.cache.values()) promises.push(guild.setup()) 16 | 17 | await Promise.all(promises) 18 | 19 | setInterval(() => client.guilds.cache.each((guild) => { 20 | if (guild.active && guild.settings.snapshots.enabled) guild.snapshot = new Snapshot(guild) 21 | }), ms('1 hour')) 22 | 23 | console.log('Everything fine...') 24 | } 25 | -------------------------------------------------------------------------------- /src/utils.ts: -------------------------------------------------------------------------------- 1 | import { PermissionOverwrites, Permissions, PermissionString } from 'discord.js' 2 | 3 | export const inviteRegExp = /(https?:\/\/)?(www\.)?(disco|discord(app)?)\.(com|gg|io|li|me|net|org)(\/invite)?\/[a-z0-9-.]+/i 4 | 5 | export const overwriteToPermissions = (overwrite: PermissionOverwrites): Record => { 6 | const permissions = >{} 7 | 8 | for (const flag of Object.keys(Permissions.FLAGS) as PermissionString[]) { 9 | if (overwrite.allow.bitfield & Permissions.FLAGS[flag]) { 10 | permissions[flag] = true 11 | } else if (overwrite.deny.bitfield & Permissions.FLAGS[flag]) { 12 | permissions[flag] = false 13 | } 14 | } 15 | 16 | return permissions 17 | } 18 | 19 | export const createChoices = (arr: string[]) => arr.map(x => ({ name: x, value: x })) -------------------------------------------------------------------------------- /src/events/guildMemberUpdate.ts: -------------------------------------------------------------------------------- 1 | import type { GuildMember } from 'discord.js' 2 | import { BAD_PERMISSIONS } from '../Constants' 3 | 4 | export const guildMemberUpdate = async (oldMember: GuildMember, member: GuildMember): Promise => { 5 | if (!member.guild.active) return 6 | if (!member.guild.isPunishable(member.id)) return 7 | if (member.roles.cache.size <= oldMember.roles.cache.size) return 8 | 9 | const oldRoles = oldMember.roles.cache 10 | const badRoles = member.roles.cache.filter((role) => !oldRoles.has(role.id) && role.permissions.any(BAD_PERMISSIONS)) 11 | 12 | if (badRoles.size === 0) return 13 | 14 | const executor = await member.guild.fetchExecutor('MEMBER_ROLE_UPDATE', member.id) 15 | 16 | if (executor && (executor.id === member.id || !member.guild.isPunishable(executor.id))) { 17 | return 18 | } 19 | 20 | const reason = `(${executor?.tag ?? 'Unknown#0000'}): You can't assign roles with bad permissions` 21 | 22 | await member.roles.remove(badRoles, reason) 23 | } 24 | -------------------------------------------------------------------------------- /src/commands/ban.ts: -------------------------------------------------------------------------------- 1 | import { CTX, Command, CommandError } from '../structures' 2 | 3 | export class BanCommand implements Command { 4 | name = 'ban' 5 | description = 'Bans a user' 6 | options = [{ 7 | name: 'user', 8 | type: 'USER' as const, 9 | description: 'Targeted user', 10 | required: true 11 | }, { 12 | name: 'reason', 13 | type: 'STRING' as const, 14 | description: 'Specify the reason', 15 | required: false 16 | }] 17 | permissions = ['BAN_MEMBERS'] as const 18 | async run(ctx: CTX) { 19 | const user = ctx.options.getUser('user', true) 20 | const reason = ctx.options.getString('reason') || 'No reason' 21 | 22 | if (user.id === ctx.user.id) throw new CommandError('You can\'t ban yourself') 23 | if (user.id === ctx.client.user.id) throw new CommandError('You can\'t ban me') 24 | 25 | await ctx.guild.members.ban(user, { reason }) 26 | 27 | return ctx.reply(`**${user.tag}** has been banned for **${reason}**`) 28 | } 29 | } -------------------------------------------------------------------------------- /src/commands/kick.ts: -------------------------------------------------------------------------------- 1 | import { CTX, Command, CommandError } from '../structures' 2 | 3 | export class KickCommand implements Command { 4 | name = 'kick' 5 | description = 'Kicks a user' 6 | options = [{ 7 | name: 'user', 8 | type: 'USER' as const, 9 | description: 'Targeted user', 10 | required: true 11 | }, { 12 | name: 'reason', 13 | type: 'STRING' as const, 14 | description: 'Specify the reason', 15 | required: false 16 | }] 17 | permissions = ['KICK_MEMBERS'] as const 18 | async run(ctx: CTX) { 19 | const member = ctx.options.getMember('user', true) 20 | const reason = ctx.options.getString('reason') || 'No reason' 21 | 22 | if (member.id === ctx.user.id) throw new CommandError('You can\'t kick yourself') 23 | if (member.id === ctx.client.user.id) throw new CommandError('You can\'t kick me') 24 | 25 | await member.kick(reason) 26 | 27 | return ctx.reply(`**${member.user.tag}** has been kicked for **${reason}**`) 28 | } 29 | } -------------------------------------------------------------------------------- /src/commands/settings/show.ts: -------------------------------------------------------------------------------- 1 | import type { CTX, SubCommand } from '../../structures' 2 | import { MessageEmbed } from 'discord.js' 3 | import ms from 'ms' 4 | 5 | 6 | export class SettingsShowCommand implements SubCommand { 7 | name = 'show' 8 | type = 'SUB_COMMAND' as const 9 | description = 'Show current settings' 10 | run(ctx: CTX) { 11 | const { privateAlerts, limits, ignoredIds, snapshots } = ctx.guild.settings 12 | const embed = new MessageEmbed().setTitle('Server Settings').setColor('#2f3136') 13 | 14 | embed 15 | .addField('Limits:', [ 16 | `Create **${limits.create.max}** / **${ms(limits.create.time)}**`, 17 | `Update **${limits.update.max}** / **${ms(limits.update.time)}**`, 18 | `Delete **${limits.delete.max}** / **${ms(limits.delete.time)}**` 19 | ].join('\n'), true) 20 | .addField('Private Alerts:', privateAlerts ? '**Enabled**' : '**Disabled**', true) 21 | .addField('Snapshots:', snapshots.enabled ? '**Enabled**' : '**Disabled**', true) 22 | .addField('Trusted Users:', ignoredIds.map(id => `<@${id}>`).join(', ') || 'None') 23 | 24 | return ctx.reply({ embeds: [embed] }) 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/events/guildMemberAdd.ts: -------------------------------------------------------------------------------- 1 | import { UserFlags, GuildMember } from 'discord.js' 2 | import { BAD_PERMISSIONS } from '../Constants' 3 | 4 | export const guildMemberAdd = async (member: GuildMember): Promise => { 5 | if (!member.guild.active) return 6 | if (!member.user.bot || !member.guild.isPunishable(member.user.id)) return 7 | 8 | const executor = await member.guild.fetchExecutor('BOT_ADD', member.id) 9 | 10 | if (executor && !member.guild.isPunishable(executor.id)) { 11 | member.guild.owner?.dm(`**${executor.tag}** Added: **${member.user.tag}**`) 12 | } 13 | 14 | if (executor) { 15 | const flags = await member.user.fetchFlags(false), botRole = member.roles.botRole 16 | 17 | // Verified bots can pass the test but without permissions 18 | if (botRole && flags.has(UserFlags.FLAGS.VERIFIED_BOT)) { 19 | await botRole.setPermissions(botRole.permissions.remove(BAD_PERMISSIONS)) 20 | member.guild.owner?.dm(`**${executor.tag}** Added: **${member.user.tag}**`) 21 | } else { 22 | await member.kick(`(${executor.tag}): Ask the owners to add this bot` ) 23 | } 24 | } else { 25 | await member.kick("Couldn't find who invited this bot...") 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/events/interactionCreate.ts: -------------------------------------------------------------------------------- 1 | import { Interaction, DiscordAPIError } from 'discord.js' 2 | import { CommandError } from '../structures' 3 | 4 | const ERROR_EMOJI = '⚠️ ' 5 | 6 | export const interactionCreate = async (ctx: Interaction) => { 7 | if (!ctx.isCommand() || !ctx.inGuild()) return 8 | if (!ctx.guild!.active) return 9 | 10 | const command = ctx.client.commands.get(ctx.commandName) 11 | 12 | if (!command) return 13 | 14 | if (command.permissions && !ctx.memberPermissions.has(command.permissions)) return ctx.reply({ 15 | content: 'You don\'t have the required permissions.', 16 | ephemeral: true 17 | }) 18 | 19 | try { 20 | await command.run(ctx) 21 | } catch (err) { 22 | const say = (content: string) => (ctx.replied || ctx.deferred) ? 23 | ctx.editReply(ERROR_EMOJI + content) : 24 | ctx.reply({ content: ERROR_EMOJI + content, ephemeral: true }) 25 | 26 | if (err instanceof CommandError) { 27 | await say(err.message) 28 | } else if (err instanceof DiscordAPIError && err.code === 50013) { 29 | await say(`Sorry, I'm missing permissions to do that`) 30 | } else { 31 | console.error(err) 32 | await say('An error has occurred') 33 | } 34 | } 35 | } -------------------------------------------------------------------------------- /src/commands/settings/toggle.ts: -------------------------------------------------------------------------------- 1 | import type { CTX, SubCommand } from '../../structures' 2 | import db from '../../database' 3 | 4 | const FLAGS = { 5 | 'Private Alerts': 'privateAlerts', 6 | 'Snapshots': 'snapshots.enabled' 7 | } 8 | 9 | function toggle(obj: any, path: string) { 10 | let parent = obj, value = obj, lastKey = path 11 | for (const key of path.split('.')) (parent = value, value = parent[key], lastKey = key) 12 | return parent[lastKey] = !value 13 | } 14 | 15 | export class SettingsToggleCommand implements SubCommand { 16 | name = 'toggle' 17 | type = 'SUB_COMMAND' as const 18 | description = 'Toggle specific setting' 19 | options = [{ 20 | name: 'flag', 21 | type: 'STRING' as const, 22 | description: 'The flag you want to toggle', 23 | choices: Object.entries(FLAGS).map(([name, value]) => ({ name, value })), 24 | required: true 25 | }] 26 | 27 | async run(ctx: CTX) { 28 | const flag = ctx.options.getString('flag', true) 29 | const flagName = this.options[0].choices.find(c => c.value === flag).name 30 | const status = toggle(ctx.guild.settings, flag) 31 | 32 | await db.set(ctx.guildId, JSON.stringify(ctx.guild.settings)) 33 | 34 | return ctx.reply(`**${flagName}** has been **${status ? 'Enabled' : 'Disabled'}**`) 35 | } 36 | } -------------------------------------------------------------------------------- /src/events/roleUpdate.ts: -------------------------------------------------------------------------------- 1 | import type { Role } from 'discord.js' 2 | import { BAD_PERMISSIONS } from '../Constants' 3 | 4 | export const roleUpdate = async (oldRole: Role, role: Role): Promise => { 5 | if (!role.guild.active) return 6 | 7 | const isMine = role.tags?.botId === role.client.user!.id || role.guild.roles.highest.id === role.id 8 | 9 | if (isMine) return role.guild.setup() 10 | 11 | if (role.permissions.equals(oldRole.permissions)) return 12 | if (role.tags?.botId && !role.guild.isPunishable(role.tags.botId)) return 13 | 14 | if (!role.permissions.any(BAD_PERMISSIONS)) return 15 | 16 | const isEveryone = role.id === role.guild.id 17 | const newPermissions = role.permissions.remove(BAD_PERMISSIONS) 18 | 19 | if (isEveryone) { 20 | await role.setPermissions(newPermissions, '@everyone cannot have bad permissions') 21 | } 22 | 23 | const executor = await role.guild.fetchExecutor('ROLE_UPDATE', role.id) 24 | 25 | if (executor && !role.guild.isPunishable(executor.id)) return 26 | 27 | if (isEveryone) { 28 | role.guild.owner?.dm(`**${executor?.tag ?? 'Unknown#0000'}** GIVING @everyone BAD PERMISSIONS!!`) 29 | if (executor) await role.guild.punish(executor.id) 30 | } else { 31 | await role.setPermissions(newPermissions, `(${executor?.tag ?? 'Unknown#0000'}): You can't add bad permissions to this role`) 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/commands/about.ts: -------------------------------------------------------------------------------- 1 | import type { CTX, Command } from '../structures' 2 | import { MessageEmbed, MessageActionRow, MessageButton } from 'discord.js' 3 | 4 | 5 | export class AboutCommand implements Command { 6 | name = 'about' 7 | description = 'Show information about the bot' 8 | run(ctx: CTX) { 9 | const embed = new MessageEmbed().setColor('#2f3136'), row = new MessageActionRow() 10 | 11 | const button = () => new MessageButton().setStyle('LINK') 12 | 13 | embed 14 | .setTitle('The story behind me!') 15 | .setThumbnail(ctx.client.user.displayAvatarURL()) 16 | .setDescription('The ultimate all-in-one protection discord bot you\'ll ever need, really') 17 | 18 | embed.addField('The name?', `**Gabriel** (Arabic: **جبريل** romanized: *Jibrīl*) is is venerated as one of the primary archangels and as the Angel of Revelation in Islam. [More info...](https://en.wikipedia.org/wiki/Gabriel)`) 19 | 20 | const inviteLink = ctx.client.generateInvite({ 21 | scopes: ['bot', 'applications.commands'], 22 | permissions: ['ADMINISTRATOR'] 23 | }) 24 | 25 | row.addComponents( 26 | button().setURL('https://ko-fi.com/abdulrahman1s').setLabel('Donation').setEmoji('❤️'), 27 | button().setURL('https://github.com/abdulrahman1s/Gabriel-bot').setLabel('Source Code').setEmoji('💻'), 28 | button().setURL(inviteLink).setLabel('Invite').setEmoji('🔗') 29 | ) 30 | 31 | return ctx.reply({ embeds: [embed], components: [row] }) 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/commands/mute.ts: -------------------------------------------------------------------------------- 1 | import { CTX, Command, CommandError } from '../structures' 2 | import ms, { StringValue } from 'ms' 3 | 4 | export class MuteCommand implements Command { 5 | name = 'mute' 6 | description = 'Mutes a user' 7 | options = [{ 8 | name: 'user', 9 | type: 'USER' as const, 10 | description: 'Targeted user', 11 | required: true 12 | }, { 13 | name: 'duration', 14 | type: 'STRING' as const, 15 | description: 'Mute duration (default: 30 minute)', 16 | required: false 17 | }, { 18 | name: 'reason', 19 | type: 'STRING' as const, 20 | description: 'Specify the reason', 21 | required: false 22 | }] 23 | permissions = ['MUTE_MEMBERS'] as const 24 | 25 | async run(ctx: CTX) { 26 | const member = ctx.options.getMember('user', true) 27 | const reason = ctx.options.getString('reason') || 'No reason' 28 | const duration = ms((ctx.options.getString('duration') || '30 minute') as StringValue) 29 | 30 | if (member.id === ctx.client.user.id) throw new CommandError('You can\'t mute me') 31 | if (member.id === ctx.user.id) throw new CommandError('You can\'t mute yourself') 32 | if (isNaN(duration)) throw new CommandError('Invalid duration input') 33 | 34 | await member.disableCommunicationUntil(Date.now() + duration, reason) 35 | 36 | const formattedDuration = ms(duration, { long: true }) 37 | 38 | return ctx.reply(`${member} has been muted until **${formattedDuration}** for ${reason}.`) 39 | } 40 | } -------------------------------------------------------------------------------- /src/Constants.ts: -------------------------------------------------------------------------------- 1 | import { Permissions } from 'discord.js' 2 | import { GuildSettings } from '../@types' 3 | import ms from 'ms' 4 | 5 | export const BAD_PERMISSIONS = [ 6 | Permissions.FLAGS.ADMINISTRATOR, 7 | Permissions.FLAGS.MANAGE_CHANNELS, 8 | Permissions.FLAGS.MANAGE_GUILD, 9 | Permissions.FLAGS.MANAGE_MESSAGES, 10 | Permissions.FLAGS.MANAGE_NICKNAMES, 11 | Permissions.FLAGS.MANAGE_ROLES, 12 | Permissions.FLAGS.MANAGE_WEBHOOKS, 13 | Permissions.FLAGS.BAN_MEMBERS, 14 | Permissions.FLAGS.KICK_MEMBERS, 15 | Permissions.FLAGS.MENTION_EVERYONE, 16 | Permissions.FLAGS.MUTE_MEMBERS 17 | ] 18 | 19 | export const BAD_PERMISSIONS_STRING = new Permissions(BAD_PERMISSIONS).toArray() 20 | 21 | 22 | export const DEFAULT_GUILD_SETTINGS: GuildSettings = { 23 | privateAlerts: true, 24 | ignoredIds: [], 25 | limits: { 26 | global: { 27 | max: 15, 28 | time: ms('1 minute') 29 | }, 30 | create: { 31 | max: 3, 32 | time: ms('5 minutes') 33 | }, 34 | update: { 35 | max: 5, 36 | time: ms('5 minutes') 37 | }, 38 | delete: { 39 | max: 3, 40 | time: ms('3 minutes') 41 | }, 42 | messages: { 43 | hook: { 44 | max: 3, 45 | time: ms('5 seconds') 46 | }, 47 | user: { 48 | max: 30, 49 | time: ms('30 seconds') 50 | } 51 | } 52 | }, 53 | snapshots: { 54 | enabled: false 55 | } 56 | } -------------------------------------------------------------------------------- /@types/index.d.ts: -------------------------------------------------------------------------------- 1 | import { Collection, GuildAuditLogsActionType } from 'discord.js' 2 | import { ActionManager, Command, Snapshot } from '../src/structures' 3 | 4 | declare module 'discord.js' { 5 | interface Client { 6 | readonly commands: Collection 7 | loadEvents(): number 8 | loadCommands(): number 9 | } 10 | 11 | interface Guild { 12 | readonly actions: ActionManager 13 | readonly running: Set<'GLOBAL' | string> 14 | readonly owner: GuildMember | null 15 | snapshot: Snapshot 16 | active: boolean 17 | settings: GuildSettings 18 | isPunishable(targetId: string): boolean 19 | setup(): Promise 20 | punish(targetId: string): Promise 21 | check(type: keyof GuildAuditLogsActions, targetId?: string): Promise 22 | fetchEntry(type: keyof GuildAuditLogsActions, targetId?: string, isRetry?: boolean): Promise | null> 23 | fetchExecutor(...args: Parameters): Promise 24 | } 25 | 26 | interface GuildMember { 27 | dm(content: string, times?: number): Promise 28 | } 29 | } 30 | 31 | type LimitValue = { max: number, time: number } 32 | 33 | interface GuildSettings { 34 | privateAlerts: boolean 35 | ignoredIds: string[] 36 | limits: { 37 | global: LimitValue 38 | create: LimitValue 39 | update: LimitValue 40 | delete: LimitValue 41 | messages: { 42 | hook: LimitValue 43 | user: LimitValue 44 | } 45 | } 46 | snapshots: { 47 | enabled: boolean 48 | } 49 | } -------------------------------------------------------------------------------- /src/commands/settings/set.ts: -------------------------------------------------------------------------------- 1 | import { CommandError, CTX, SubCommand } from '../../structures' 2 | import { createChoices } from '../../utils' 3 | import ms, { StringValue } from 'ms' 4 | import db from '../../database' 5 | 6 | 7 | export class SettingsSetCommand implements SubCommand { 8 | name = 'set' 9 | type = 'SUB_COMMAND' as const 10 | description = 'Configure bot limits' 11 | options = [{ 12 | name: 'type', 13 | type: 'STRING' as const, 14 | description: 'Type of limit you want to configure', 15 | required: true, 16 | choices: createChoices(['create', 'update', 'delete']) 17 | }, { 18 | name: 'max', 19 | type: 'INTEGER' as const, 20 | description: 'Maximum tries to execute this limit', 21 | required: true 22 | }, { 23 | name: 'time', 24 | type: 'STRING' as const, 25 | description: 'The required time the tries can live for (ex: 5 minute)', 26 | required: true 27 | }] 28 | 29 | async run(ctx: CTX) { 30 | const type = ctx.options.getString('type', true) as 'create' | 'delete' | 'update' 31 | const max = ctx.options.getInteger('max', true) 32 | const time = ms(ctx.options.getString('time', true) as StringValue) 33 | 34 | if (max > 30 || max <= 0) throw new CommandError('Maximum tries must be lower than `30` and greater than `0`.') 35 | if (isNaN(time)) throw new CommandError('Invalid time input') 36 | 37 | ctx.guild.settings.limits[type] = { max, time } 38 | 39 | await db.set(ctx.guildId, JSON.stringify(ctx.guild.settings)) 40 | 41 | return ctx.reply(`Settings has been updated successfully`) 42 | } 43 | } -------------------------------------------------------------------------------- /src/structures/ActionManager.ts: -------------------------------------------------------------------------------- 1 | import { LimitedCollection, GuildAuditLogsActionType, GuildAuditLogsEntry, Guild, Collection } from 'discord.js' 2 | 3 | export type ActionType = Lowercase> 4 | 5 | export class Action { 6 | id: string 7 | executorId: string 8 | timestamp: number 9 | type: GuildAuditLogsActionType 10 | constructor(opts: GuildAuditLogsEntry) { 11 | this.id = opts.id 12 | this.executorId = opts.executor!.id 13 | this.timestamp = opts.createdTimestamp 14 | this.type = opts.actionType 15 | } 16 | } 17 | 18 | 19 | export class ActionManager extends LimitedCollection { 20 | static cache = new Collection() 21 | static get(guild: Guild): ActionManager { 22 | return this.cache.ensure(guild.id, () => new ActionManager(guild)) 23 | } 24 | 25 | constructor(public readonly guild: Guild) { 26 | super({ maxSize: 100 }) 27 | } 28 | 29 | scan(action: Action): boolean { 30 | super.set(action.id, action) 31 | 32 | const limit = this.guild.settings.limits[action.type.toLowerCase() as ActionType] 33 | const now = Date.now() 34 | 35 | return super.filter((a) => a.executorId === action.executorId && a.type === action.type && now - a.timestamp <= limit.time).size >= limit.max 36 | } 37 | 38 | globalScan(type: Action['type']) { 39 | const { time, max } = this.guild.settings.limits.global 40 | const now = Date.now() 41 | const actions = super.filter((a) => a.type === type && now - a.timestamp <= time) 42 | return { 43 | actions, 44 | redAlert: actions.size >= max 45 | } 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import './extensions' 2 | import { createServer } from 'http' 3 | import { Client, Intents } from './structures' 4 | import config from './config' 5 | 6 | createServer((_, res) => { 7 | res.end('Pong') 8 | }).listen(process.env.PORT ?? 8080) 9 | 10 | 11 | const client = new Client({ 12 | intents: [ 13 | Intents.FLAGS.GUILDS, 14 | Intents.FLAGS.GUILD_MESSAGES, 15 | Intents.FLAGS.GUILD_MEMBERS, 16 | Intents.FLAGS.GUILD_BANS, 17 | Intents.FLAGS.GUILD_WEBHOOKS 18 | ], 19 | restTimeOffset: 0, 20 | ws: { 21 | properties: { 22 | $browser: 'Discord iOS' 23 | } 24 | } 25 | }) 26 | 27 | console.log(`Loaded a total of ${client.loadEvents()} events.`) 28 | console.log(`Loaded a total of ${client.loadCommands()} commands.`) 29 | 30 | 31 | client 32 | .on('channelUpdate', (channel) => { 33 | if (channel.type !== 'DM') channel.guild.check('CHANNEL_UPDATE', channel.id) 34 | }) 35 | .on('channelDelete', (channel) => { 36 | if (channel.type !== 'DM') channel.guild.check('CHANNEL_DELETE', channel.id) 37 | }) 38 | .on('channelCreate', (channel) => channel.guild.check('CHANNEL_CREATE', channel.id)) 39 | .on('guildBanAdd', (ban) => ban.guild.check('MEMBER_BAN_ADD')) 40 | .on('roleCreate', (role) => role.guild.check('ROLE_CREATE', role.id)) 41 | .on('roleDelete', (role) => role.guild.check('ROLE_DELETE', role.id)) 42 | .on('roleUpdate', (role) => role.guild.check('ROLE_UPDATE', role.id)) 43 | .on('guildMemberRemove', (member) => member.guild.check('MEMBER_KICK', member.id)) 44 | .on('webhookUpdate', (channel) => channel.guild.check('WEBHOOK_UPDATE')) 45 | 46 | 47 | void client.login(config.token) 48 | 49 | process 50 | .on('uncaughtException', (err) => console.error(err)) 51 | .on('unhandledRejection', (err) => console.error(err)) 52 | .on('warning', (err) => console.warn(err)) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

Gabriel Bot (The Best Protection Bot)

2 |

The ultimate all-in-one protection discord bot you'll ever need, really

3 | 4 | ### 📖 Overview 5 | This bot will protect your server in any case. (I mean it)
6 | That's mean? *No Spammers, No Raiders, No Joke*. 7 | 8 | 9 | ### ✨ Features 10 | - Moderation Commands 11 | - Snapshots (Fix the broken things made by the hacker, something like Going back in time 🪄) 12 | - Look up for bad changes in... 13 | - Server Settings (name, notification mode) 14 | - Role Permissions 15 | - Channel Overwrites 16 | - Auto kick un-verified bots 17 | - An Excellent Punishment 18 | - Mute the hacker for 6 hours 19 | - Remove All roles from him 20 | - Cleanup Channels he has overwrites in 21 | - Smart Spam Detector (This feature will work only with webhooks and admins) 22 | - Red Alert Mode (Runs when the server being under attack by multiple hackers at the same time) 23 | - Sets Server verification level to **Highest** 24 | - Bans all the suspected users 25 | - Cleanup Server Roles (permissions) 26 | - Cleanup Server Channels (overwrites) 27 | 28 | 29 | ### ☁ Self-hosted & Installation 30 | I recommend you to use my instance since it's 99.9% uptime and free to use. [invite link](https://discord.com/api/oauth2/authorize?client_id=978012328958255164&permissions=8&scope=bot%20applications.commands)
31 | Otherwise, More information can be found in our [wiki](https://github.com/abdulrahman1s/Gabriel-bot/wiki/Self-hosted). 32 | 33 | ### 🤔 The name? 34 | **Gabriel** (**جبريل** romanized: *Jibrīl*) is is venerated as one of the primary archangels and as the Angel of Revelation in Islam. [More info...](https://en.wikipedia.org/wiki/Gabriel) 35 | 36 | ### 🙌 Contribute 37 | Good changes are always welcoming. 😁 38 | 1. Fork the repo 39 | 2. Made your changes 40 | 3. Open a pull request 41 | 42 | ### ❔ FAQs 43 | [here](https://github.com/abdulrahman1s/Gabriel-bot/wiki/FAQs) 44 | 45 | #### ✍ License 46 | Refer to the [LICENSE](LICENSE) file. 47 | -------------------------------------------------------------------------------- /src/commands/clear.ts: -------------------------------------------------------------------------------- 1 | import { CTX, Command, CommandError } from '../structures' 2 | import { setTimeout as sleep } from 'timers/promises' 3 | import { createChoices, inviteRegExp } from '../utils' 4 | 5 | export class ClearCommand implements Command { 6 | name = 'clear' 7 | description = 'Clears chat messages' 8 | options = [{ 9 | name: 'count', 10 | type: 'INTEGER' as const, 11 | description: 'Number of messages you want to delete (default: 50)', 12 | required: false 13 | }, { 14 | name: 'filter', 15 | type: 'STRING' as const, 16 | description: 'filter messages based on it\'s content', 17 | choices: createChoices(['attachments', 'embeds', 'invites', 'bots', 'humans', 'links']), 18 | required: false 19 | }] 20 | async run(ctx: CTX) { 21 | const count = ctx.options.getInteger('count') ?? 50 22 | const filter = ctx.options.getString('filter') 23 | 24 | if (count > 100 || count <= 0) throw new CommandError('Number of messages must be lower than `100` and greater than `0`.') 25 | 26 | let messages = await ctx.channel.messages.fetch({ limit: count }) 27 | 28 | switch (filter) { 29 | case 'bots': messages = messages.filter(m => m.author.bot); break 30 | case 'humans': messages = messages.filter(m => !m.author.bot); break 31 | case 'embeds': messages = messages.filter(m => m.embeds.length > 0); break 32 | case 'attachments': messages = messages.filter(m => m.attachments.size > 0); break 33 | case 'invites': messages = messages.filter(m => inviteRegExp.test(m.content)); break 34 | case 'links': messages = messages.filter(m => /https?:\/\//i.test(m.content)); break 35 | default: break 36 | } 37 | 38 | const deletedMessages = await ctx.channel.bulkDelete(messages) 39 | const msg = await ctx.reply({ content: `**${deletedMessages.size}** of messages has been deleted`, fetchReply: true }) 40 | 41 | return sleep(3000).then(() => msg.delete()) 42 | } 43 | } -------------------------------------------------------------------------------- /src/events/channelUpdate.ts: -------------------------------------------------------------------------------- 1 | import type { DMChannel, NonThreadGuildBasedChannel } from 'discord.js' 2 | import { BAD_PERMISSIONS, BAD_PERMISSIONS_STRING } from '../Constants' 3 | import { overwriteToPermissions } from '../utils' 4 | 5 | 6 | export const channelUpdate = async ( 7 | oldChannel: DMChannel | NonThreadGuildBasedChannel, 8 | channel: DMChannel | NonThreadGuildBasedChannel 9 | ): Promise => { 10 | if (channel.type === 'DM' || oldChannel.type === 'DM') return 11 | if (!channel.guild.active) return 12 | 13 | const oldOverwrites = oldChannel.permissionOverwrites.cache 14 | 15 | const addedOverwrites = channel.permissionOverwrites.cache.filter(({ id, allow }) => { 16 | return !oldOverwrites.has(id) && channel.guild.isPunishable(id) && allow.any(BAD_PERMISSIONS) 17 | }) 18 | 19 | const updatedOverwrites = channel.permissionOverwrites.cache.filter(({ id, allow }) => { 20 | const oldOverwrite = oldOverwrites.get(id) 21 | if (!oldOverwrite || allow.equals(oldOverwrite.allow)) return false 22 | return channel.guild.isPunishable(id) && allow.remove(oldOverwrite.allow).any(BAD_PERMISSIONS) 23 | }) 24 | 25 | const auditType = addedOverwrites.size 26 | ? 'CHANNEL_OVERWRITE_CREATE' 27 | : updatedOverwrites.size 28 | ? 'CHANNEL_OVERWRITE_UPDATE' 29 | : null 30 | 31 | if (!auditType) return 32 | 33 | const executor = await channel.guild.fetchExecutor(auditType, channel.id) 34 | 35 | if (executor && !channel.guild.isPunishable(executor.id)) { 36 | return 37 | } 38 | 39 | const promises: Promise[] = [] 40 | 41 | for (const overwrite of addedOverwrites.values()) { 42 | promises.push(overwrite.delete(`(${executor?.tag ?? 'Unknown#0000'}): Detected Bad Permissions!`)) 43 | } 44 | 45 | for (const overwrite of updatedOverwrites.values()) { 46 | const permissions = overwriteToPermissions(overwrite) 47 | 48 | for (const flag of BAD_PERMISSIONS_STRING) { 49 | if (permissions[flag]) permissions[flag] = false 50 | } 51 | 52 | promises.push(overwrite.edit(permissions, `(${executor?.tag ?? 'Unknown#0000'}): Detected Bad Permissions!`)) 53 | } 54 | 55 | await Promise.allSettled(promises) 56 | } 57 | -------------------------------------------------------------------------------- /src/events/messageCreate.ts: -------------------------------------------------------------------------------- 1 | import { Message, LimitedCollection, GuildTextBasedChannel } from 'discord.js' 2 | import { BAD_PERMISSIONS } from '../Constants' 3 | import { setTimeout as sleep } from 'timers/promises' 4 | 5 | const spam = new LimitedCollection({ maxSize: 100 }) 6 | const TIMEOUT_BEFORE_DELETE = 1000 7 | 8 | const cleanup = async (channel: GuildTextBasedChannel, filterFn: (m: Message) => boolean) => { 9 | await sleep(TIMEOUT_BEFORE_DELETE) 10 | await channel.bulkDelete(channel.messages.cache.filter(filterFn)) 11 | } 12 | 13 | const handleSpam = async (msg: Message) => { 14 | if (msg.channel.isThread()) return 15 | 16 | const id = msg.author.id 17 | const timestamps = spam.ensure(id, () => []) 18 | 19 | timestamps.push(msg.createdTimestamp) 20 | 21 | const { max, time } = msg.guild.settings.limits.messages.user 22 | const now = Date.now() 23 | const isSpamming = timestamps.filter((stamp) => now - stamp <= time).length >= max 24 | 25 | if (!isSpamming) return 26 | 27 | msg.guild.running.add(id) 28 | 29 | spam.delete(id) 30 | 31 | try { 32 | await msg.guild.punish(id) 33 | 34 | await cleanup(msg.channel, m => m.author.id === id) 35 | 36 | if (msg.channel.type === 'GUILD_TEXT') await msg.channel.setRateLimitPerUser(5) 37 | } catch { 38 | /* Ignore */ 39 | } finally { 40 | msg.guild.running.delete(id) 41 | } 42 | } 43 | 44 | const handleWebhookSpam = async (msg: Message) => { 45 | const id = msg.webhookId! 46 | 47 | const timestamps = spam.ensure(id, () => []) 48 | 49 | timestamps.push(msg.createdTimestamp) 50 | 51 | const { max, time } = msg.guild.settings.limits.messages.hook 52 | 53 | const now = Date.now() 54 | const isSpamming = timestamps.filter((stamp) => now - stamp <= time).length >= max 55 | 56 | if (!isSpamming && !msg.mentions.everyone) return 57 | 58 | msg.guild.running.add(id) 59 | 60 | spam.delete(id) 61 | 62 | try { 63 | const hook = await msg.fetchWebhook() 64 | 65 | await hook.delete() 66 | 67 | await cleanup(msg.channel, m => m.webhookId === id) 68 | } catch { 69 | /* Ignore */ 70 | } finally { 71 | msg.guild.running.delete(id) 72 | } 73 | } 74 | 75 | export const messageCreate = async (message: Message): Promise => { 76 | if (!message.inGuild()) return 77 | if (!message.guild.active) return 78 | if (message.guild.running.has(message.webhookId || message.author.id)) return 79 | if (message.webhookId) return handleWebhookSpam(message) 80 | const member = message.member || await message.guild.members.fetch(message.author.id) 81 | if (message.guild.isPunishable(message.author.id) && member.permissions.any(BAD_PERMISSIONS)) return handleSpam(message) 82 | } 83 | -------------------------------------------------------------------------------- /src/structures/Snapshot.ts: -------------------------------------------------------------------------------- 1 | import { Collection, Guild, GuildChannelTypes, GuildEditData, OverwriteData } from 'discord.js' 2 | 3 | namespace Snapshot { 4 | export interface Role { 5 | name: string 6 | color: number 7 | permissions: bigint 8 | hoist: boolean 9 | mentionable: boolean 10 | } 11 | 12 | export interface Emoji { 13 | name: string 14 | url: string 15 | } 16 | 17 | export interface Channel { 18 | name: string 19 | type: GuildChannelTypes 20 | position: number 21 | overwrites: OverwriteData[] 22 | parent?: string 23 | children: Collection)> 24 | } 25 | } 26 | 27 | 28 | 29 | 30 | export class Snapshot { 31 | name!: string 32 | icon: string | null = null 33 | banner: string | null = null 34 | description: string | null = null 35 | readonly roles = new Collection() 36 | readonly channels = new Collection() 37 | readonly emojis = new Collection() 38 | readonly createdTimestamp = Date.now() 39 | 40 | constructor(guild: Guild) { 41 | this.name = guild.name 42 | this.description = guild.description 43 | this.banner = guild.bannerURL() 44 | this.icon = guild.iconURL({ dynamic: true }) 45 | 46 | for (const [id, c] of guild.channels.cache) { 47 | if (c.isThread()) continue 48 | 49 | const channel: Snapshot.Channel = { 50 | name: c.name, 51 | type: c.type, 52 | position: c.position, 53 | overwrites: c.permissionOverwrites.cache.toJSON(), 54 | children: c.type === 'GUILD_CATEGORY' ? c.children.mapValues((child) => { 55 | return { 56 | name: child.name, 57 | type: child.type, 58 | position: child.position, 59 | overwrites: child.permissionOverwrites.cache.toJSON(), 60 | parent: c.id 61 | } 62 | }) : new Collection(), 63 | parent: c.parentId || void 0 64 | } 65 | 66 | this.channels.set(id, channel) 67 | } 68 | 69 | for (const [id, r] of guild.roles.cache.sort((a, b) => b.position - a.position)) { 70 | if (r.id === guild.id || r.managed) continue 71 | 72 | const role: Snapshot.Role = { 73 | name: r.name, 74 | color: r.color, 75 | permissions: r.permissions.bitfield, 76 | hoist: r.hoist, 77 | mentionable: r.mentionable 78 | } 79 | 80 | this.roles.set(id, role) 81 | } 82 | 83 | for (const [id, e] of guild.emojis.cache) { 84 | const emoji: Snapshot.Emoji = { 85 | name: e.name!, 86 | url: e.url 87 | } 88 | 89 | this.emojis.set(id, emoji) 90 | } 91 | } 92 | 93 | static async restore(guild: Guild): Promise { 94 | const shot = guild.snapshot 95 | 96 | if (!shot) return 97 | 98 | const promises: Promise[] = [] 99 | const editGuildOptions: GuildEditData = {} 100 | 101 | if (shot.name !== guild.name) editGuildOptions.name = shot.name 102 | if (shot.description !== guild.description) editGuildOptions.description = shot.description 103 | if (shot.icon !== guild.iconURL({ dynamic: true })) editGuildOptions.icon = shot.icon 104 | if (shot.banner !== guild.bannerURL()) editGuildOptions.banner = shot.banner 105 | 106 | // will be ignored if the object empty 107 | for (const _ in editGuildOptions) { 108 | promises.push(guild.edit(editGuildOptions)) 109 | break 110 | } 111 | 112 | const addedChannels = guild.channels.cache.filter((c) => !shot.channels.has(c.id)) 113 | const removedChannels = shot.channels.filter((_, id) => !guild.channels.cache.has(id)) 114 | const removedCategories = removedChannels.filter(c => c.type === 'GUILD_CATEGORY') 115 | const otherRemovedChannels = removedChannels.filter((c, id) => { 116 | return c.type !== 'GUILD_CATEGORY' && !removedCategories.some(cat => cat.children.has(id)) 117 | }) 118 | 119 | for (const c of addedChannels.values()) promises.push(c.delete()) 120 | for (const c of removedCategories.values()) promises.push(guild.channels.create(c.name, c).then(parent => { 121 | const nestedPromises: Promise[] = [] 122 | 123 | for (const child of c.children.values()) { 124 | nestedPromises.push(guild.channels.create(child.name, { ...child, parent: parent.id })) 125 | } 126 | 127 | return Promise.all(nestedPromises) 128 | })) 129 | 130 | for (const c of otherRemovedChannels.values()) promises.push(guild.channels.create(c.name, c)) 131 | 132 | const addedEmojis = guild.emojis.cache.filter((e) => !shot.emojis.has(e.id)) 133 | const removedEmojis = shot.emojis.filter((_, id) => !guild.emojis.cache.has(id)) 134 | 135 | for (const e of addedEmojis.values()) promises.push(e.delete()) 136 | for (const e of removedEmojis.values()) promises.push(guild.emojis.create(e.url, e.name)) 137 | 138 | const addedRoles = guild.roles.cache.filter((r) => !shot.roles.has(r.id)) 139 | const removedRoles = shot.roles.filter((_, id) => !guild.roles.cache.has(id)) 140 | 141 | for (const r of addedRoles.values()) promises.push(r.delete()) 142 | for (const r of removedRoles.values()) promises.push(guild.roles.create(r)) 143 | 144 | await Promise.allSettled(promises) 145 | 146 | guild.snapshot = new Snapshot(guild) 147 | } 148 | } 149 | -------------------------------------------------------------------------------- /src/extensions/Guild.ts: -------------------------------------------------------------------------------- 1 | import { Guild, GuildAuditLogsActions, GuildAuditLogsEntry, Role, TextChannel, Permissions } from 'discord.js' 2 | import { BAD_PERMISSIONS, DEFAULT_GUILD_SETTINGS } from '../Constants' 3 | import { ActionManager, Action, Snapshot } from '../structures' 4 | import { setTimeout as sleep } from 'timers/promises' 5 | import db from '../database' 6 | import ms from 'ms' 7 | 8 | 9 | const THREE_MINUTES = ms('3m') 10 | 11 | Guild.prototype.fetchEntry = async function ( 12 | type: keyof GuildAuditLogsActions, 13 | targetId?: string, 14 | retry = false 15 | ): Promise | null> { 16 | const entry = await this.fetchAuditLogs({ type, limit: 5 }).then(({ entries }) => { 17 | if (targetId) { 18 | return entries.find((e) => (e.target as { id?: string })?.id === targetId) 19 | } 20 | return entries.first() 21 | }).catch(() => null) 22 | 23 | if (!entry && !retry) { 24 | await sleep(1000) 25 | return this.fetchEntry(type, targetId, true) 26 | } 27 | 28 | if (!entry?.executor || Date.now() - entry.createdTimestamp > 5000) return null 29 | 30 | return entry as GuildAuditLogsEntry<'ALL'> 31 | } 32 | 33 | Guild.prototype.fetchExecutor = async function (...args: Parameters) { 34 | const { executor = null } = (await this.fetchEntry(...args)) ?? {} 35 | return executor 36 | } 37 | 38 | Guild.prototype.punish = async function (userId: string) { 39 | const promises: Promise[] = [] 40 | const roles: Role[] = [] 41 | const botRole = this.roles.botRoleFor(userId) 42 | 43 | if (botRole) { 44 | roles.push(botRole) 45 | promises.push(botRole.setPermissions(botRole.permissions.remove(BAD_PERMISSIONS))) 46 | } 47 | 48 | promises.push(this.members.edit(userId, { roles })) 49 | 50 | for (const channel of this.channels.cache.values()) { 51 | if (channel.isThread()) continue 52 | for (const [id, overwrite] of channel.permissionOverwrites.cache) { 53 | if (id === userId && overwrite.allow.any(BAD_PERMISSIONS)) promises.push(overwrite.delete()) 54 | } 55 | } 56 | 57 | await Promise.allSettled(promises) 58 | 59 | await this.members.edit(userId, { communicationDisabledUntil: Date.now() + ms('6h') }).catch(() => null) 60 | } 61 | 62 | Guild.prototype.check = async function (type: keyof GuildAuditLogsActions, targetId?: string) { 63 | if (!this.active) return 64 | 65 | const entry = await this.fetchEntry(type, targetId), user = entry?.executor 66 | 67 | if (!user || user.id == this.ownerId) return 68 | 69 | const local = async () => { 70 | while (this.running.has(user.id)) await sleep(50) 71 | 72 | const action = new Action(entry) 73 | 74 | if (!this.actions.scan(action)) return false 75 | // Keep in mind. Global Checking will not forgive this 76 | if (!this.isPunishable(action.executorId)) return false 77 | 78 | this.owner?.dm(`${user.tag} (ID: ${user.id}) has executed the limit of \`${action.type}\`.`) 79 | 80 | this.running.add(user.id) 81 | 82 | try { 83 | await this.punish(user.id) 84 | } catch (e) { 85 | console.error(e) 86 | } finally { 87 | this.running.delete(user.id) 88 | } 89 | 90 | if (this.settings.snapshots.enabled) await Snapshot.restore(this) 91 | 92 | return true 93 | } 94 | 95 | const global = async () => { 96 | if (this.running.has('GLOBAL')) return 97 | 98 | const result = this.actions.globalScan(entry.actionType) 99 | 100 | if (!result.redAlert) return 101 | 102 | this.running.add('GLOBAL') 103 | 104 | this.owner?.dm(`**------------ RED ALERT -------------**\nThe server **${this.name}** is under attack by multiple hackers..`, 3) 105 | 106 | const promises: Promise[] = [] 107 | 108 | for (const a of result.actions.values()) promises.push(this.bans.create(a.executorId)) 109 | 110 | for (const channel of this.channels.cache.values()) { 111 | if (channel.isThread()) continue 112 | for (const overwrite of channel.permissionOverwrites.cache.values()) if (overwrite.allow.any(BAD_PERMISSIONS)) { 113 | promises.push(overwrite.delete()) 114 | } 115 | } 116 | 117 | for (const role of this.roles.cache.values()) if (role.permissions.any(BAD_PERMISSIONS)) { 118 | promises.push(role.setPermissions(role.permissions.remove(BAD_PERMISSIONS))) 119 | } 120 | 121 | 122 | if (this.verificationLevel !== 'VERY_HIGH') { 123 | promises.push(this.setVerificationLevel('VERY_HIGH')) 124 | } 125 | 126 | await Promise.allSettled(promises) 127 | 128 | this.running.delete('GLOBAL') 129 | 130 | if (this.settings.snapshots.enabled) await Snapshot.restore(this) 131 | } 132 | 133 | await local().then(global) 134 | } 135 | 136 | 137 | Guild.prototype.setup = async function () { 138 | this.active = false 139 | 140 | const me = this.me || await this.members.fetch(this.client.user!.id) 141 | 142 | await this.members.fetch(this.ownerId) 143 | 144 | const power = () => me.roles.highest.id === this.roles.highest.id && me.roles.highest.permissions.has(Permissions.FLAGS.ADMINISTRATOR) 145 | const setup = async () => { 146 | const settings = await db.get(this.id).catch(() => null) 147 | if (settings) this.settings = JSON.parse(settings) 148 | this.active = true 149 | this.snapshot = new Snapshot(this) 150 | } 151 | 152 | if (power()) { 153 | await setup() 154 | } else { 155 | const channel = this.channels.cache.find(c => c.type === 'GUILD_TEXT' && c.permissionsFor(me).has(Permissions.FLAGS.SEND_MESSAGES)) as TextChannel 156 | const msg = await channel?.send(`Hey <@${this.ownerId}>... \nI must have the highest role in the server with admin permissions to work properly\nYou have 3 minutes to do the requirements otherwise I'll just leave`) 157 | const startedAt = Date.now() 158 | const interval = setInterval(async () => { 159 | if (power()) { 160 | await setup() 161 | msg?.delete().catch(() => null) 162 | clearInterval(interval) 163 | } else if (Date.now() - startedAt >= THREE_MINUTES) { 164 | this.leave().catch(() => null) 165 | clearInterval(interval) 166 | } 167 | }, 1000).ref() 168 | } 169 | } 170 | 171 | Guild.prototype.isPunishable = function (targetId: string) { 172 | if (targetId === this.ownerId) return false 173 | if (targetId === this.client.user!.id) return false 174 | return !this.settings.ignoredIds.includes(targetId) 175 | } 176 | 177 | 178 | Object.defineProperties(Guild.prototype, { 179 | active: { 180 | value: false, 181 | writable: true, 182 | enumerable: true 183 | }, 184 | running: { 185 | value: new Set() 186 | }, 187 | actions: { 188 | get() { 189 | return ActionManager.get(this) 190 | } 191 | }, 192 | owner: { 193 | get() { 194 | return this.members.cache.get(this.ownerId) 195 | } 196 | }, 197 | settings: { 198 | value: DEFAULT_GUILD_SETTINGS, 199 | writable: true, 200 | enumerable: true 201 | } 202 | }) 203 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------