mirror of
https://github.com/ZeppelinBot/Zeppelin.git
synced 2025-05-10 20:35:02 +00:00
Remove unported plugins from the repository
This commit is contained in:
Dragory
parent
9f059f33af
commit
951c27374f
39 changed files with 19 additions and 14323 deletions
File diff suppressed because it is too large
Load diff
|
|
@ -1,101 +0,0 @@
|
|||
import { ZeppelinPluginInfo, trimPluginDescription } from "../ZeppelinPluginClass";
|
||||
|
||||
export const pluginInfo: PluginInfo = {
|
||||
prettyName: "Automod",
|
||||
description: trimPluginDescription(`
|
||||
Allows specifying automated actions in response to triggers. Example use cases include word filtering and spam prevention.
|
||||
`),
|
||||
configurationGuide: trimPluginDescription(`
|
||||
The automod plugin is very customizable. For a full list of available triggers, actions, and their options, see Config schema at the bottom of this page.
|
||||
|
||||
### Simple word filter
|
||||
Removes any messages that contain the word 'banana' and sends a warning to the user.
|
||||
Moderators (level >= 50) are ignored by the filter based on the override.
|
||||
|
||||
~~~yml
|
||||
automod:
|
||||
config:
|
||||
rules:
|
||||
my_filter:
|
||||
triggers:
|
||||
- match_words:
|
||||
words: ['banana']
|
||||
case_sensitive: false
|
||||
only_full_words: true
|
||||
actions:
|
||||
clean: true
|
||||
warn:
|
||||
reason: 'Do not talk about bananas!'
|
||||
overrides:
|
||||
- level: '>=50'
|
||||
config:
|
||||
rules:
|
||||
my_filter:
|
||||
enabled: false
|
||||
~~~
|
||||
|
||||
### Spam detection
|
||||
This example includes 2 filters:
|
||||
|
||||
- The first one is triggered if a user sends 5 messages within 10 seconds OR 3 attachments within 60 seconds.
|
||||
The messages are deleted and the user is muted for 5 minutes.
|
||||
- The second filter is triggered if a user sends more than 2 emoji within 5 seconds.
|
||||
The messages are deleted but the user is not muted.
|
||||
|
||||
Moderators are ignored by both filters based on the override.
|
||||
|
||||
~~~yml
|
||||
automod:
|
||||
config:
|
||||
rules:
|
||||
my_spam_filter:
|
||||
triggers:
|
||||
- message_spam:
|
||||
amount: 5
|
||||
within: 10s
|
||||
- attachment_spam:
|
||||
amount: 3
|
||||
within: 60s
|
||||
actions:
|
||||
clean: true
|
||||
mute:
|
||||
duration: 5m
|
||||
reason: 'Auto-muted for spam'
|
||||
my_second_filter:
|
||||
triggers:
|
||||
- message_spam:
|
||||
amount: 5
|
||||
within: 10s
|
||||
actions:
|
||||
clean: true
|
||||
overrides:
|
||||
- level: '>=50'
|
||||
config:
|
||||
rules:
|
||||
my_spam_filter:
|
||||
enabled: false
|
||||
my_second_filter:
|
||||
enabled: false
|
||||
~~~
|
||||
|
||||
### Custom status alerts
|
||||
This example sends an alert any time a user with a matching custom status sends a message.
|
||||
|
||||
~~~yml
|
||||
automod:
|
||||
config:
|
||||
rules:
|
||||
bad_custom_statuses:
|
||||
triggers:
|
||||
- match_words:
|
||||
words: ['banana']
|
||||
match_custom_status: true
|
||||
actions:
|
||||
alert:
|
||||
channel: "473087035574321152"
|
||||
text: |-
|
||||
Bad custom status on user <@!{user.id}>:
|
||||
{matchSummary}
|
||||
~~~
|
||||
`),
|
||||
};
|
||||
|
|
@ -1,336 +0,0 @@
|
|||
import * as t from "io-ts";
|
||||
import { TSafeRegex } from "../../validatorUtils";
|
||||
import { tDelayString, tMessageContent, tNullable } from "../../utils";
|
||||
|
||||
export enum RecentActionType {
|
||||
Message = 1,
|
||||
Mention,
|
||||
Link,
|
||||
Attachment,
|
||||
Emoji,
|
||||
Line,
|
||||
Character,
|
||||
VoiceChannelMove,
|
||||
MemberJoin,
|
||||
}
|
||||
|
||||
export interface BaseRecentAction {
|
||||
identifier: string;
|
||||
timestamp: number;
|
||||
count: number;
|
||||
actioned?: boolean;
|
||||
}
|
||||
|
||||
export type TextRecentAction = BaseRecentAction & {
|
||||
type:
|
||||
| RecentActionType.Message
|
||||
| RecentActionType.Mention
|
||||
| RecentActionType.Link
|
||||
| RecentActionType.Attachment
|
||||
| RecentActionType.Emoji
|
||||
| RecentActionType.Line
|
||||
| RecentActionType.Character;
|
||||
messageInfo: MessageInfo;
|
||||
};
|
||||
|
||||
export type OtherRecentAction = BaseRecentAction & {
|
||||
type: RecentActionType.VoiceChannelMove | RecentActionType.MemberJoin;
|
||||
userId: string;
|
||||
};
|
||||
|
||||
export type RecentAction = (TextRecentAction | OtherRecentAction) & { expiresAt: number };
|
||||
|
||||
export interface RecentSpam {
|
||||
archiveId: string;
|
||||
actionedUsers: Set<string>;
|
||||
expiresAt: number;
|
||||
}
|
||||
|
||||
export type MessageInfo = { channelId: string; messageId: string; userId: string };
|
||||
|
||||
export type TextTriggerWithMultipleMatchTypes = {
|
||||
match_messages: boolean;
|
||||
match_embeds: boolean;
|
||||
match_visible_names: boolean;
|
||||
match_usernames: boolean;
|
||||
match_nicknames: boolean;
|
||||
match_custom_status: boolean;
|
||||
};
|
||||
|
||||
export interface TriggerMatchResult {
|
||||
trigger: string;
|
||||
type: string;
|
||||
}
|
||||
|
||||
export interface MessageTextTriggerMatchResult<T = any> extends TriggerMatchResult {
|
||||
type: "message" | "embed";
|
||||
str: string;
|
||||
userId: string;
|
||||
messageInfo: MessageInfo;
|
||||
matchedValue: T;
|
||||
}
|
||||
|
||||
export interface OtherTextTriggerMatchResult<T = any> extends TriggerMatchResult {
|
||||
type: "username" | "nickname" | "visiblename" | "customstatus";
|
||||
str: string;
|
||||
userId: string;
|
||||
matchedValue: T;
|
||||
}
|
||||
|
||||
export type TextTriggerMatchResult<T = any> = MessageTextTriggerMatchResult<T> | OtherTextTriggerMatchResult<T>;
|
||||
|
||||
export interface TextSpamTriggerMatchResult extends TriggerMatchResult {
|
||||
type: "textspam";
|
||||
actionType: RecentActionType;
|
||||
recentActions: TextRecentAction[];
|
||||
|
||||
// Rule that specified the criteria used for matching the spam
|
||||
rule: TRule;
|
||||
|
||||
// The identifier used to match the recentActions above.
|
||||
// If not null, this should match the identifier of each of the recentActions above.
|
||||
identifier: string;
|
||||
}
|
||||
|
||||
export interface OtherSpamTriggerMatchResult extends TriggerMatchResult {
|
||||
type: "otherspam";
|
||||
actionType: RecentActionType;
|
||||
recentActions: OtherRecentAction[];
|
||||
|
||||
// Rule that specified the criteria used for matching the spam
|
||||
rule: TRule;
|
||||
|
||||
// The identifier used to match the recentActions above.
|
||||
// If not null, this should match the identifier of each of the recentActions above.
|
||||
identifier: string;
|
||||
}
|
||||
|
||||
export interface OtherTriggerMatchResult extends TriggerMatchResult {
|
||||
type: "other";
|
||||
userId: string;
|
||||
}
|
||||
|
||||
export type AnyTriggerMatchResult =
|
||||
| TextTriggerMatchResult
|
||||
| OtherTriggerMatchResult
|
||||
| TextSpamTriggerMatchResult
|
||||
| OtherSpamTriggerMatchResult;
|
||||
|
||||
export type AnySpamTriggerMatchResult = TextSpamTriggerMatchResult | OtherSpamTriggerMatchResult;
|
||||
|
||||
/**
|
||||
* TRIGGERS
|
||||
*/
|
||||
|
||||
export const MatchWordsTrigger = t.type({
|
||||
words: t.array(t.string),
|
||||
case_sensitive: t.boolean,
|
||||
only_full_words: t.boolean,
|
||||
normalize: t.boolean,
|
||||
loose_matching: t.boolean,
|
||||
loose_matching_threshold: t.number,
|
||||
match_messages: t.boolean,
|
||||
match_embeds: t.boolean,
|
||||
match_visible_names: t.boolean,
|
||||
match_usernames: t.boolean,
|
||||
match_nicknames: t.boolean,
|
||||
match_custom_status: t.boolean,
|
||||
});
|
||||
export type TMatchWordsTrigger = t.TypeOf<typeof MatchWordsTrigger>;
|
||||
|
||||
export const MatchRegexTrigger = t.type({
|
||||
patterns: t.array(TSafeRegex),
|
||||
case_sensitive: t.boolean,
|
||||
normalize: t.boolean,
|
||||
match_messages: t.boolean,
|
||||
match_embeds: t.boolean,
|
||||
match_visible_names: t.boolean,
|
||||
match_usernames: t.boolean,
|
||||
match_nicknames: t.boolean,
|
||||
match_custom_status: t.boolean,
|
||||
});
|
||||
export type TMatchRegexTrigger = t.TypeOf<typeof MatchRegexTrigger>;
|
||||
|
||||
export const MatchInvitesTrigger = t.type({
|
||||
include_guilds: tNullable(t.array(t.string)),
|
||||
exclude_guilds: tNullable(t.array(t.string)),
|
||||
include_invite_codes: tNullable(t.array(t.string)),
|
||||
exclude_invite_codes: tNullable(t.array(t.string)),
|
||||
allow_group_dm_invites: t.boolean,
|
||||
match_messages: t.boolean,
|
||||
match_embeds: t.boolean,
|
||||
match_visible_names: t.boolean,
|
||||
match_usernames: t.boolean,
|
||||
match_nicknames: t.boolean,
|
||||
match_custom_status: t.boolean,
|
||||
});
|
||||
export type TMatchInvitesTrigger = t.TypeOf<typeof MatchInvitesTrigger>;
|
||||
|
||||
export const MatchLinksTrigger = t.type({
|
||||
include_domains: tNullable(t.array(t.string)),
|
||||
exclude_domains: tNullable(t.array(t.string)),
|
||||
include_subdomains: t.boolean,
|
||||
include_words: tNullable(t.array(t.string)),
|
||||
exclude_words: tNullable(t.array(t.string)),
|
||||
include_regex: tNullable(t.array(TSafeRegex)),
|
||||
exclude_regex: tNullable(t.array(TSafeRegex)),
|
||||
only_real_links: t.boolean,
|
||||
match_messages: t.boolean,
|
||||
match_embeds: t.boolean,
|
||||
match_visible_names: t.boolean,
|
||||
match_usernames: t.boolean,
|
||||
match_nicknames: t.boolean,
|
||||
match_custom_status: t.boolean,
|
||||
});
|
||||
export type TMatchLinksTrigger = t.TypeOf<typeof MatchLinksTrigger>;
|
||||
|
||||
export const MatchAttachmentTypeTrigger = t.type({
|
||||
filetype_blacklist: t.array(t.string),
|
||||
blacklist_enabled: t.boolean,
|
||||
filetype_whitelist: t.array(t.string),
|
||||
whitelist_enabled: t.boolean,
|
||||
});
|
||||
export type TMatchAttachmentTypeTrigger = t.TypeOf<typeof MatchAttachmentTypeTrigger>;
|
||||
|
||||
export const BaseSpamTrigger = t.type({
|
||||
amount: t.number,
|
||||
within: t.string,
|
||||
});
|
||||
export type TBaseSpamTrigger = t.TypeOf<typeof BaseSpamTrigger>;
|
||||
|
||||
export const BaseTextSpamTrigger = t.intersection([
|
||||
BaseSpamTrigger,
|
||||
t.type({
|
||||
per_channel: t.boolean,
|
||||
}),
|
||||
]);
|
||||
export type TBaseTextSpamTrigger = t.TypeOf<typeof BaseTextSpamTrigger>;
|
||||
|
||||
export const MessageSpamTrigger = BaseTextSpamTrigger;
|
||||
export type TMessageSpamTrigger = t.TypeOf<typeof MessageSpamTrigger>;
|
||||
export const MentionSpamTrigger = BaseTextSpamTrigger;
|
||||
export type TMentionSpamTrigger = t.TypeOf<typeof MentionSpamTrigger>;
|
||||
export const LinkSpamTrigger = BaseTextSpamTrigger;
|
||||
export type TLinkSpamTrigger = t.TypeOf<typeof LinkSpamTrigger>;
|
||||
export const AttachmentSpamTrigger = BaseTextSpamTrigger;
|
||||
export type TAttachmentSpamTrigger = t.TypeOf<typeof AttachmentSpamTrigger>;
|
||||
export const EmojiSpamTrigger = BaseTextSpamTrigger;
|
||||
export type TEmojiSpamTrigger = t.TypeOf<typeof EmojiSpamTrigger>;
|
||||
export const LineSpamTrigger = BaseTextSpamTrigger;
|
||||
export type TLineSpamTrigger = t.TypeOf<typeof LineSpamTrigger>;
|
||||
export const CharacterSpamTrigger = BaseTextSpamTrigger;
|
||||
export type TCharacterSpamTrigger = t.TypeOf<typeof CharacterSpamTrigger>;
|
||||
export const VoiceMoveSpamTrigger = BaseSpamTrigger;
|
||||
export type TVoiceMoveSpamTrigger = t.TypeOf<typeof VoiceMoveSpamTrigger>;
|
||||
|
||||
export const MemberJoinTrigger = t.type({
|
||||
only_new: t.boolean,
|
||||
new_threshold: tDelayString,
|
||||
});
|
||||
export type TMemberJoinTrigger = t.TypeOf<typeof MemberJoinTrigger>;
|
||||
|
||||
export const MemberJoinSpamTrigger = BaseSpamTrigger;
|
||||
export type TMemberJoinSpamTrigger = t.TypeOf<typeof MemberJoinTrigger>;
|
||||
|
||||
/**
|
||||
* ACTIONS
|
||||
*/
|
||||
|
||||
export const CleanAction = t.boolean;
|
||||
|
||||
export const WarnAction = t.type({
|
||||
reason: tNullable(t.string),
|
||||
notify: tNullable(t.string),
|
||||
notifyChannel: tNullable(t.string),
|
||||
});
|
||||
|
||||
export const MuteAction = t.type({
|
||||
reason: tNullable(t.string),
|
||||
duration: tNullable(tDelayString),
|
||||
notify: tNullable(t.string),
|
||||
notifyChannel: tNullable(t.string),
|
||||
});
|
||||
|
||||
export const KickAction = t.type({
|
||||
reason: tNullable(t.string),
|
||||
notify: tNullable(t.string),
|
||||
notifyChannel: tNullable(t.string),
|
||||
});
|
||||
|
||||
export const BanAction = t.type({
|
||||
reason: tNullable(t.string),
|
||||
notify: tNullable(t.string),
|
||||
notifyChannel: tNullable(t.string),
|
||||
deleteMessageDays: tNullable(t.number),
|
||||
});
|
||||
|
||||
export const AlertAction = t.type({
|
||||
channel: t.string,
|
||||
text: t.string,
|
||||
});
|
||||
|
||||
export const ChangeNicknameAction = t.type({
|
||||
name: t.string,
|
||||
});
|
||||
|
||||
export const LogAction = t.boolean;
|
||||
|
||||
export const AddRolesAction = t.array(t.string);
|
||||
export const RemoveRolesAction = t.array(t.string);
|
||||
|
||||
export const SetAntiraidLevelAction = t.string;
|
||||
|
||||
export const ReplyAction = t.union([
|
||||
t.string,
|
||||
t.type({
|
||||
text: tMessageContent,
|
||||
auto_delete: tNullable(t.union([t.string, t.number])),
|
||||
}),
|
||||
]);
|
||||
|
||||
/**
|
||||
* RULES
|
||||
*/
|
||||
|
||||
export const Rule = t.type({
|
||||
enabled: t.boolean,
|
||||
name: t.string,
|
||||
presets: tNullable(t.array(t.string)),
|
||||
affects_bots: t.boolean,
|
||||
triggers: t.array(
|
||||
t.type({
|
||||
match_words: tNullable(MatchWordsTrigger),
|
||||
match_regex: tNullable(MatchRegexTrigger),
|
||||
match_invites: tNullable(MatchInvitesTrigger),
|
||||
match_links: tNullable(MatchLinksTrigger),
|
||||
match_attachment_type: tNullable(MatchAttachmentTypeTrigger),
|
||||
message_spam: tNullable(MessageSpamTrigger),
|
||||
mention_spam: tNullable(MentionSpamTrigger),
|
||||
link_spam: tNullable(LinkSpamTrigger),
|
||||
attachment_spam: tNullable(AttachmentSpamTrigger),
|
||||
emoji_spam: tNullable(EmojiSpamTrigger),
|
||||
line_spam: tNullable(LineSpamTrigger),
|
||||
character_spam: tNullable(CharacterSpamTrigger),
|
||||
member_join: tNullable(MemberJoinTrigger),
|
||||
member_join_spam: tNullable(MemberJoinSpamTrigger),
|
||||
// voice_move_spam: tNullable(VoiceMoveSpamTrigger), // TODO
|
||||
// TODO: Duplicates trigger
|
||||
}),
|
||||
),
|
||||
actions: t.type({
|
||||
clean: tNullable(CleanAction),
|
||||
warn: tNullable(WarnAction),
|
||||
mute: tNullable(MuteAction),
|
||||
kick: tNullable(KickAction),
|
||||
ban: tNullable(BanAction),
|
||||
alert: tNullable(AlertAction),
|
||||
change_nickname: tNullable(ChangeNicknameAction),
|
||||
log: tNullable(LogAction),
|
||||
add_roles: tNullable(AddRolesAction),
|
||||
remove_roles: tNullable(RemoveRolesAction),
|
||||
set_antiraid_level: tNullable(SetAntiraidLevelAction),
|
||||
reply: tNullable(ReplyAction),
|
||||
}),
|
||||
cooldown: tNullable(t.string),
|
||||
});
|
||||
export type TRule = t.TypeOf<typeof Rule>;
|
||||
Loading…
Add table
Add a link
Reference in a new issue