LimitMiddleClickPaste: Expand plugin functionality. (#782)
* Expand plugin functionality. * Refactor. * Fix type. * Narrow CSS. * Fix CSS. * Simplify. * Fix bugs. * Fix migration. * Minor fixes.
This commit is contained in:
Etorix
GitHub
parent
566ef6cb97
commit
c050bbf58c
2 changed files with 150 additions and 129 deletions
|
|
@ -1,129 +0,0 @@
|
|||
/*
|
||||
* Vencord, a Discord client mod
|
||||
* Copyright (c) 2025 Vendicated and contributors
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
|
||||
import { definePluginSettings } from "@api/Settings";
|
||||
import { EquicordDevs } from "@utils/index";
|
||||
import definePlugin, { OptionType } from "@utils/types";
|
||||
|
||||
const MIDDLE_CLICK = 1;
|
||||
|
||||
let lastMiddleClickUp = 0;
|
||||
|
||||
const settings = definePluginSettings({
|
||||
scope: {
|
||||
type: OptionType.SELECT,
|
||||
description: "Situations in which to prevent middle click from pasting.",
|
||||
options: [
|
||||
{
|
||||
label: "Always Prevent Middle Click Pasting",
|
||||
value: "always",
|
||||
default: true
|
||||
},
|
||||
{
|
||||
label: "Only Prevent When Text Area Not Focused",
|
||||
value: "focus"
|
||||
},
|
||||
]
|
||||
},
|
||||
threshold: {
|
||||
type: OptionType.NUMBER,
|
||||
description: "Milliseconds until pasting is enabled again after a middle click.",
|
||||
default: 100,
|
||||
onChange(newValue) { if (newValue < 1) { settings.store.threshold = 1; } },
|
||||
},
|
||||
preventLinkOpen: {
|
||||
type: OptionType.BOOLEAN,
|
||||
description: "Prevent middle-click on links from opening new tabs while preserving autoscroll.",
|
||||
default: false,
|
||||
onChange(newValue) {
|
||||
if (newValue) {
|
||||
document.addEventListener("auxclick", handleAuxClick, true);
|
||||
} else {
|
||||
document.removeEventListener("auxclick", handleAuxClick, true);
|
||||
}
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
function shouldBlockLink(e: MouseEvent): boolean {
|
||||
if (e.button !== MIDDLE_CLICK) return false;
|
||||
|
||||
const target = e.target as HTMLElement | null;
|
||||
if (!target?.closest) return false;
|
||||
|
||||
const a = target.closest("a[href]") as HTMLAnchorElement | null;
|
||||
if (!a) return false;
|
||||
|
||||
const href = a.getAttribute("href");
|
||||
return !!href && href !== "#";
|
||||
}
|
||||
|
||||
function handleAuxClick(e: MouseEvent) {
|
||||
if (!shouldBlockLink(e)) return;
|
||||
e.preventDefault();
|
||||
e.stopPropagation();
|
||||
}
|
||||
|
||||
export default definePlugin({
|
||||
name: "LimitMiddleClickPaste",
|
||||
description: "Prevent middle click pasting either always or just when a text area is not focused.",
|
||||
authors: [EquicordDevs.Etorix, EquicordDevs.korzi],
|
||||
settings,
|
||||
|
||||
isPastingDisabled(isInput: boolean) {
|
||||
const pasteBlocked = Date.now() - lastMiddleClickUp < Math.max(settings.store.threshold, 1);
|
||||
const { scope } = settings.store;
|
||||
|
||||
if (!pasteBlocked) return false;
|
||||
if (scope === "always") return true;
|
||||
if (scope === "focus" && !isInput) return true;
|
||||
|
||||
return false;
|
||||
},
|
||||
|
||||
onMouseUp: (e: MouseEvent) => {
|
||||
if (e.button === MIDDLE_CLICK) lastMiddleClickUp = Date.now();
|
||||
},
|
||||
|
||||
start() {
|
||||
document.addEventListener("mouseup", this.onMouseUp);
|
||||
if (settings.store.preventLinkOpen) {
|
||||
document.addEventListener("auxclick", handleAuxClick, true);
|
||||
}
|
||||
},
|
||||
|
||||
stop() {
|
||||
document.removeEventListener("mouseup", this.onMouseUp);
|
||||
document.removeEventListener("auxclick", handleAuxClick, true);
|
||||
},
|
||||
|
||||
patches: [
|
||||
{
|
||||
// Detects paste events triggered by the "browser" outside of input fields.
|
||||
find: "document.addEventListener(\"paste\",",
|
||||
replacement: {
|
||||
match: /(?<=paste",(\i)=>{)/,
|
||||
replace: "if($1.target.tagName===\"BUTTON\"||$self.isPastingDisabled(false)){$1.preventDefault?.();$1.stopPropagation?.();return;};"
|
||||
}
|
||||
},
|
||||
{
|
||||
// Detects paste events triggered inside of Discord's text input.
|
||||
find: ",origin:\"clipboard\"});",
|
||||
replacement: {
|
||||
match: /(?<=handlePaste=(\i)=>{)(?=let)/,
|
||||
replace: "if($self.isPastingDisabled(true)){$1.preventDefault?.();$1.stopPropagation?.();return;}"
|
||||
}
|
||||
},
|
||||
{
|
||||
// Detects paste events triggered inside of Discord's search box.
|
||||
find: "props.handlePastedText&&",
|
||||
replacement: {
|
||||
match: /(?<=clipboardData\);)/,
|
||||
replace: "if($self.isPastingDisabled(true)){arguments[1].preventDefault?.();arguments[1].stopPropagation?.();return;};"
|
||||
}
|
||||
},
|
||||
],
|
||||
});
|
||||
150
src/equicordplugins/middleClickTweaks/index.ts
Normal file
150
src/equicordplugins/middleClickTweaks/index.ts
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
/*
|
||||
* Vencord, a Discord client mod
|
||||
* Copyright (c) 2025 Vendicated and contributors
|
||||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
*/
|
||||
|
||||
import { definePluginSettings, SettingsStore } from "@api/Settings";
|
||||
import { EquicordDevs } from "@utils/index";
|
||||
import definePlugin, { OptionType } from "@utils/types";
|
||||
|
||||
const MIDDLE_CLICK = 1;
|
||||
let lastMiddleClickUp = 0;
|
||||
|
||||
function updateListeners(refresh: boolean = true) {
|
||||
document.removeEventListener("mouseup", handleMouseUp, true);
|
||||
document.removeEventListener("auxclick", handleAuxClick, true);
|
||||
|
||||
if (refresh) {
|
||||
document.addEventListener("mouseup", handleMouseUp, true);
|
||||
document.addEventListener("auxclick", handleAuxClick, true);
|
||||
}
|
||||
}
|
||||
|
||||
function handleAuxClick(event: MouseEvent) {
|
||||
if (event.button !== MIDDLE_CLICK) return false;
|
||||
|
||||
const { openScope } = settings.store;
|
||||
|
||||
const target = event.target as HTMLElement | null;
|
||||
const anchor = target?.closest("a[href]") as HTMLAnchorElement | null;
|
||||
const media = target?.closest("a[href][data-role='img'], a[href][data-role='video']") as HTMLAnchorElement | null;
|
||||
const role = anchor?.dataset.role ?? "";
|
||||
|
||||
const isMedia = !!media;
|
||||
const isLink = !isMedia && !!anchor?.href && anchor.getAttribute("href") !== "#" && !["img", "video", "button"].includes(role);
|
||||
|
||||
if (isLink && ["links", "both"].includes(openScope)) {
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
} else if (isMedia && ["media", "both"].includes(openScope)) {
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
}
|
||||
}
|
||||
|
||||
function handleMouseUp(event: MouseEvent) {
|
||||
if (event.button === MIDDLE_CLICK) lastMiddleClickUp = Date.now();
|
||||
}
|
||||
|
||||
const settings = definePluginSettings({
|
||||
openScope: {
|
||||
type: OptionType.SELECT,
|
||||
description: "Prevent middle clicking on these content types from opening them.",
|
||||
options: [
|
||||
{ label: "Links", value: "links" },
|
||||
{ label: "Media", value: "media" },
|
||||
{ label: "Links & Media", value: "both" },
|
||||
{ label: "None", value: "none", default: true },
|
||||
],
|
||||
onChange(newValue) { updateListeners(newValue !== "none"); }
|
||||
},
|
||||
pasteScope: {
|
||||
type: OptionType.SELECT,
|
||||
description: "Prevent middle click from pasting during these situations.",
|
||||
options: [
|
||||
{ label: "Always Prevent Middle Click Pasting", value: "always", default: true },
|
||||
{ label: "Only Prevent When Text Area Not Focused", value: "focus" },
|
||||
]
|
||||
},
|
||||
pasteThreshold: {
|
||||
type: OptionType.NUMBER,
|
||||
description: "Milliseconds until pasting is enabled again after a middle click.",
|
||||
default: 100,
|
||||
onChange(newValue) { if (newValue < 1) { settings.store.pasteThreshold = 1; } }
|
||||
}
|
||||
});
|
||||
|
||||
function migrate() {
|
||||
const { plugins } = SettingsStore.plain;
|
||||
const oldPlugin = plugins?.LimitMiddleClickPaste;
|
||||
|
||||
if (!oldPlugin) return;
|
||||
|
||||
const newPlugin = plugins.MiddleClickTweaks ??= { enabled: false };
|
||||
const { scope, threshold, preventLinkOpen } = oldPlugin;
|
||||
|
||||
if (scope) newPlugin.pasteScope = scope;
|
||||
if (threshold) newPlugin.pasteThreshold = threshold;
|
||||
if (preventLinkOpen) newPlugin.openScope = "both";
|
||||
if (oldPlugin.enabled) newPlugin.enabled = true;
|
||||
|
||||
delete plugins.LimitMiddleClickPaste;
|
||||
SettingsStore.markAsChanged();
|
||||
}
|
||||
|
||||
migrate();
|
||||
|
||||
export default definePlugin({
|
||||
name: "MiddleClickTweaks",
|
||||
description: "Various middle click tweaks, such as with pasting and link opening.",
|
||||
authors: [EquicordDevs.Etorix, EquicordDevs.korzi],
|
||||
settings,
|
||||
|
||||
tags: ["LimitMiddleClickPaste"],
|
||||
|
||||
isPastingDisabled(isInput: boolean) {
|
||||
const pasteBlocked = Date.now() - lastMiddleClickUp < Math.max(settings.store.pasteThreshold, 1);
|
||||
const { pasteScope } = settings.store;
|
||||
|
||||
if (!pasteBlocked) return false;
|
||||
if (pasteScope === "always") return true;
|
||||
if (pasteScope === "focus" && !isInput) return true;
|
||||
|
||||
return false;
|
||||
},
|
||||
|
||||
start() {
|
||||
migrate();
|
||||
updateListeners();
|
||||
},
|
||||
|
||||
stop() { updateListeners(false); },
|
||||
|
||||
patches: [
|
||||
{
|
||||
// Detects paste events triggered by the "browser" outside of input fields.
|
||||
find: "document.addEventListener(\"paste\",",
|
||||
replacement: {
|
||||
match: /(?<=paste",(\i)=>{)/,
|
||||
replace: "if($1.target.tagName===\"BUTTON\"||$self.isPastingDisabled(false)){$1.preventDefault?.();$1.stopPropagation?.();return;};"
|
||||
}
|
||||
},
|
||||
{
|
||||
// Detects paste events triggered inside of Discord's text input.
|
||||
find: ",origin:\"clipboard\"});",
|
||||
replacement: {
|
||||
match: /(?<=handlePaste=(\i)=>{)(?=let)/,
|
||||
replace: "if($self.isPastingDisabled(true)){$1.preventDefault?.();$1.stopPropagation?.();return;}"
|
||||
}
|
||||
},
|
||||
{
|
||||
// Detects paste events triggered inside of Discord's search box.
|
||||
find: "props.handlePastedText&&",
|
||||
replacement: {
|
||||
match: /(?<=clipboardData\);)/,
|
||||
replace: "if($self.isPastingDisabled(true)){arguments[1].preventDefault?.();arguments[1].stopPropagation?.();return;};"
|
||||
}
|
||||
},
|
||||
],
|
||||
});
|
||||
Loading…
Add table
Reference in a new issue