BlockKeywords: Add Regex Helper (#1087)
* BlockKeywords: Add Regex Helper * [autofix.ci] apply automated fixes * BlockKeywords: Fix regex quantifiers * BlockKeywords: Refactor & Fixes typo and deadcode * BlockKeywords: Optimize and fix some more bugs * refactor: Replace `any` with `unknown` in catch block Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * fix: Wrap `RegexHelper` component in `ErrorBoundary` Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * fix: Subscribe to settings state in `RegexHelper` Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * bruh * refactor: no `any` Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update index.tsx * Apply suggestion from @greptile-apps[bot] Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * styles --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Co-authored-by: thororen1234 <78185467+thororen1234@users.noreply.github.com>
This commit is contained in:
Kofhisho
GitHub
parent
feff7cda4d
commit
58af358549
3 changed files with 209 additions and 132 deletions
|
|
@ -1,132 +0,0 @@
|
|||
/*
|
||||
* Vencord, a Discord client mod
|
||||
* Copyright (c) 2024 Vendicated and contributors
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
|
||||
import { definePluginSettings } from "@api/Settings";
|
||||
import { EquicordDevs } from "@utils/constants";
|
||||
import definePlugin, { OptionType } from "@utils/types";
|
||||
import { Message } from "@vencord/discord-types";
|
||||
|
||||
let blockedKeywords: Array<RegExp>;
|
||||
|
||||
const settings = definePluginSettings({
|
||||
blockedWords: {
|
||||
type: OptionType.STRING,
|
||||
description: "Comma-seperated list of words to block",
|
||||
default: "",
|
||||
restartNeeded: true
|
||||
},
|
||||
useRegex: {
|
||||
type: OptionType.BOOLEAN,
|
||||
description: "Use each value as a regular expression when checking message content (advanced)",
|
||||
default: false,
|
||||
restartNeeded: true
|
||||
},
|
||||
caseSensitive: {
|
||||
type: OptionType.BOOLEAN,
|
||||
description: "Whether to use a case sensitive search or not",
|
||||
default: false,
|
||||
restartNeeded: true
|
||||
},
|
||||
ignoreBlockedMessages: {
|
||||
description: "Completely ignores (recent) new messages bar",
|
||||
type: OptionType.BOOLEAN,
|
||||
default: true,
|
||||
restartNeeded: true,
|
||||
},
|
||||
});
|
||||
|
||||
export function containsBlockedKeywords(message: Message) {
|
||||
if (!blockedKeywords) return false;
|
||||
|
||||
// can't use forEach because we need to return from inside the loop
|
||||
// message content loop
|
||||
for (let wordIndex = 0; wordIndex < blockedKeywords.length; wordIndex++) {
|
||||
if (blockedKeywords[wordIndex].test(message.content)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
// embed content loop (e.g. twitter embeds)
|
||||
for (let embedIndex = 0; embedIndex < message.embeds.length; embedIndex++) {
|
||||
const embed = message.embeds[embedIndex];
|
||||
for (let wordIndex = 0; wordIndex < blockedKeywords.length; wordIndex++) {
|
||||
// doing this because undefined strings get converted to the string "undefined" in regex tests
|
||||
// @ts-ignore
|
||||
const descriptionHasKeywords = embed.rawDescription != null && blockedKeywords[wordIndex].test(embed.rawDescription);
|
||||
// @ts-ignore
|
||||
const titleHasKeywords = embed.rawTitle != null && blockedKeywords[wordIndex].test(embed.rawTitle);
|
||||
if (descriptionHasKeywords || titleHasKeywords) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
export default definePlugin({
|
||||
name: "BlockKeywords",
|
||||
description: "Blocks messages containing specific user-defined keywords, as if the user sending them was blocked.",
|
||||
tags: ["Appearance", "Customisation", "Privacy"],
|
||||
authors: [EquicordDevs.catcraft],
|
||||
patches: [
|
||||
{
|
||||
find: "_channelMessages={}",
|
||||
predicate: () => settings.store.blockedWords !== "",
|
||||
replacement: {
|
||||
match: /static commit\((\i)\)\{/g,
|
||||
replace: "$&$1=$self.blockMessagesWithKeywords($1);"
|
||||
}
|
||||
},
|
||||
{
|
||||
find: '"MessageStore"',
|
||||
predicate: () => settings.store.ignoreBlockedMessages && settings.store.blockedWords !== "",
|
||||
replacement: [
|
||||
{
|
||||
match: /(?<=MESSAGE_CREATE:function\((\i)\){)/,
|
||||
replace: (_, props) => `if($self.containsBlockedKeywords(${props}.message))return;`
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
find: '"ReadStateStore"',
|
||||
predicate: () => settings.store.ignoreBlockedMessages && settings.store.blockedWords !== "",
|
||||
replacement: [
|
||||
{
|
||||
match: /(?<=MESSAGE_CREATE:function\((\i)\){)/,
|
||||
replace: (_, props) => `if($self.containsBlockedKeywords(${props}.message))return;`
|
||||
}
|
||||
]
|
||||
},
|
||||
],
|
||||
|
||||
settings,
|
||||
containsBlockedKeywords,
|
||||
|
||||
start() {
|
||||
const blockedWordsList: Array<string> = settings.store.blockedWords.split(",");
|
||||
const caseSensitiveFlag = settings.store.caseSensitive ? "" : "i";
|
||||
|
||||
if (!blockedWordsList) return;
|
||||
|
||||
if (settings.store.useRegex) {
|
||||
blockedKeywords = blockedWordsList.map(word => {
|
||||
return new RegExp(word, caseSensitiveFlag);
|
||||
});
|
||||
} else {
|
||||
blockedKeywords = blockedWordsList.map(word => {
|
||||
// escape regex chars in word https://stackoverflow.com/a/6969486
|
||||
return new RegExp(`\\b${word.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\b`, caseSensitiveFlag);
|
||||
});
|
||||
}
|
||||
},
|
||||
|
||||
blockMessagesWithKeywords(messageList: any) {
|
||||
return messageList.reset(messageList.map(
|
||||
message => message.set("blocked", message.blocked || this.containsBlockedKeywords(message))
|
||||
));
|
||||
}
|
||||
});
|
||||
193
src/equicordplugins/blockKeywords/index.tsx
Normal file
193
src/equicordplugins/blockKeywords/index.tsx
Normal file
|
|
@ -0,0 +1,193 @@
|
|||
/*
|
||||
* Vencord, a Discord client mod
|
||||
* Copyright (c) 2024 Vendicated and contributors
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
|
||||
import "./styles.css";
|
||||
|
||||
import { definePluginSettings } from "@api/Settings";
|
||||
import { Card } from "@components/Card";
|
||||
import { HeadingTertiary } from "@components/Heading";
|
||||
import { ErrorBoundary } from "@components/index";
|
||||
import { Margins } from "@components/margins";
|
||||
import { EquicordDevs } from "@utils/constants";
|
||||
import { classNameFactory } from "@utils/css";
|
||||
import { classes } from "@utils/misc";
|
||||
import definePlugin, { OptionType } from "@utils/types";
|
||||
import { Message } from "@vencord/discord-types";
|
||||
import { React, TextInput } from "@webpack/common";
|
||||
|
||||
let blockedKeywords: Array<RegExp>;
|
||||
const cl = classNameFactory("vc-block-keywords-");
|
||||
|
||||
function splitPatterns(input: string): string[] {
|
||||
return input
|
||||
.replace(/\[([^\]]*)\]/g, m => m.replace(/,/g, "\x00")) // protect commas in [...]
|
||||
.replace(/\{(\d+,?\d*|,\d+)\}/g, m => m.replace(",", "\x00")) // protect commas in {n,m}
|
||||
.split(",")
|
||||
.map(s => s.replace(/\x00/g, ",").trim())
|
||||
.filter(Boolean);
|
||||
}
|
||||
|
||||
function RegexHelper() {
|
||||
const [testInput, setTestInput] = React.useState("");
|
||||
const { blockedWords, caseSensitive, useRegex } = settings.use(["blockedWords", "caseSensitive", "useRegex"]);
|
||||
|
||||
const results = React.useMemo(() => {
|
||||
const caseSensitiveFlag = caseSensitive ? "" : "i";
|
||||
return splitPatterns(blockedWords)
|
||||
.map(pattern => {
|
||||
try {
|
||||
const regex = useRegex
|
||||
? new RegExp(pattern, caseSensitiveFlag)
|
||||
: new RegExp(`\\b${pattern.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\b`, caseSensitiveFlag);
|
||||
return { pattern, matches: regex.test(testInput) };
|
||||
} catch (e: unknown) {
|
||||
return { pattern, matches: false, error: e instanceof Error ? e.message : String(e) };
|
||||
}
|
||||
});
|
||||
}, [testInput, blockedWords, caseSensitive, useRegex]);
|
||||
|
||||
return (
|
||||
<Card className={cl("regex")}>
|
||||
<HeadingTertiary className={Margins.bottom8}>Regex Helper</HeadingTertiary>
|
||||
<TextInput
|
||||
type="text"
|
||||
placeholder="Input to test..."
|
||||
value={testInput}
|
||||
onChange={setTestInput}
|
||||
maxLength={null}
|
||||
/>
|
||||
{results.length === 0 ?
|
||||
<Card
|
||||
key="vc-no-patterns-regex"
|
||||
variant="warning"
|
||||
className={classes(cl("card"), Margins.top8)}
|
||||
>
|
||||
<code>No patterns configured</code>
|
||||
</Card> : (
|
||||
results.map(({ pattern, matches, error }, i) => (
|
||||
<Card
|
||||
key={`vc-pattern-card-${i}`}
|
||||
variant={error ? "danger" : matches ? "success" : "primary"}
|
||||
className={classes(cl("card"), Margins.top8)}
|
||||
>
|
||||
<code>{pattern}</code>
|
||||
{error && <span className={cl("error")}>{error}</span>}
|
||||
</Card>
|
||||
)))}
|
||||
</Card>
|
||||
);
|
||||
}
|
||||
|
||||
const settings = definePluginSettings({
|
||||
blockedWords: {
|
||||
type: OptionType.STRING,
|
||||
description: "Comma-separated list of words to block",
|
||||
default: "",
|
||||
restartNeeded: true
|
||||
},
|
||||
useRegex: {
|
||||
type: OptionType.BOOLEAN,
|
||||
description: "Use each value as a regular expression when checking message content (advanced)",
|
||||
default: false,
|
||||
restartNeeded: true
|
||||
},
|
||||
regexHelper: {
|
||||
type: OptionType.COMPONENT,
|
||||
description: "Test your regular expressions against a sample input",
|
||||
component: () => <ErrorBoundary noop><RegexHelper /></ErrorBoundary>,
|
||||
},
|
||||
caseSensitive: {
|
||||
type: OptionType.BOOLEAN,
|
||||
description: "Whether to use a case sensitive search or not",
|
||||
default: false,
|
||||
restartNeeded: true
|
||||
},
|
||||
ignoreBlockedMessages: {
|
||||
description: "Completely ignores (recent) new messages bar",
|
||||
type: OptionType.BOOLEAN,
|
||||
default: true,
|
||||
restartNeeded: true,
|
||||
},
|
||||
}, {
|
||||
regexHelper: {
|
||||
hidden() { return !this.store.useRegex; }
|
||||
}
|
||||
});
|
||||
|
||||
export function containsBlockedKeywords(message: Message) {
|
||||
if (!blockedKeywords) return false;
|
||||
|
||||
// test a nullable string against all keywords
|
||||
const testField = (text: string | null | undefined) => text != null && blockedKeywords.some(regex => regex.test(text));
|
||||
|
||||
return blockedKeywords.some(regex =>
|
||||
regex.test(message.content)) || message.embeds.some(embed =>
|
||||
testField(embed.rawDescription) || testField(embed.rawTitle));
|
||||
}
|
||||
|
||||
export default definePlugin({
|
||||
name: "BlockKeywords",
|
||||
description: "Blocks messages containing specific user-defined keywords, as if the user sending them was blocked.",
|
||||
tags: ["Appearance", "Customisation", "Privacy"],
|
||||
authors: [EquicordDevs.catcraft, EquicordDevs.secp192k1],
|
||||
patches: [
|
||||
{
|
||||
find: "_channelMessages={}",
|
||||
predicate: () => settings.store.blockedWords !== "",
|
||||
replacement: {
|
||||
match: /static commit\((\i)\)\{/g,
|
||||
replace: "$&$1=$self.blockMessagesWithKeywords($1);"
|
||||
}
|
||||
},
|
||||
{
|
||||
find: '"MessageStore"',
|
||||
predicate: () => settings.store.ignoreBlockedMessages && settings.store.blockedWords !== "",
|
||||
replacement: [
|
||||
{
|
||||
match: /(?<=MESSAGE_CREATE:function\((\i)\){)/,
|
||||
replace: (_, props) => `if($self.containsBlockedKeywords(${props}.message))return;`
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
find: '"ReadStateStore"',
|
||||
predicate: () => settings.store.ignoreBlockedMessages && settings.store.blockedWords !== "",
|
||||
replacement: [
|
||||
{
|
||||
match: /(?<=MESSAGE_CREATE:function\((\i)\){)/,
|
||||
replace: (_, props) => `if($self.containsBlockedKeywords(${props}.message))return;`
|
||||
}
|
||||
]
|
||||
},
|
||||
],
|
||||
|
||||
settings,
|
||||
containsBlockedKeywords,
|
||||
|
||||
start() {
|
||||
const blockedWordsList = splitPatterns(settings.store.blockedWords);
|
||||
const caseSensitiveFlag = settings.store.caseSensitive ? "" : "i";
|
||||
|
||||
if (blockedWordsList.length === 0) return;
|
||||
|
||||
if (settings.store.useRegex) {
|
||||
blockedKeywords = blockedWordsList.map(word => {
|
||||
return new RegExp(word, caseSensitiveFlag);
|
||||
});
|
||||
} else {
|
||||
blockedKeywords = blockedWordsList.map(word => {
|
||||
// escape regex chars in word https://stackoverflow.com/a/6969486
|
||||
return new RegExp(`\\b${word.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\b`, caseSensitiveFlag);
|
||||
});
|
||||
}
|
||||
},
|
||||
|
||||
blockMessagesWithKeywords(messageList) {
|
||||
return messageList.reset(messageList.map(
|
||||
message => message.set("blocked", message.blocked || this.containsBlockedKeywords(message))
|
||||
));
|
||||
}
|
||||
});
|
||||
16
src/equicordplugins/blockKeywords/styles.css
Normal file
16
src/equicordplugins/blockKeywords/styles.css
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
.vc-block-keywords-regex {
|
||||
padding: 0.75em
|
||||
}
|
||||
|
||||
.vc-block-keywords-card {
|
||||
padding: 0.4em 0.75em;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
}
|
||||
|
||||
.vc-block-keywords-error {
|
||||
font-size: 12px;
|
||||
margin-left: 1em;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
Loading…
Add table
Reference in a new issue