Files
Netcatty/components/terminal/hooks/useTerminalFilePaste.ts
T
1d10d1679e fix(terminal): opt-in broadcast without password protection during interactive prompts (#3491)
* fix(#3488): automated AI fix

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* fix: address Codex review on PR #3491

* test: verify broadcast password prompts on Windows desktop

* test: run desktop SSH check only in Windows job

* fix: preserve sensitive peer input across compose wake

* fix: retain compose history when sensitive peer receives nothing

* fix: protect compose history during sensitive fallback writes

---------

Co-authored-by: netcatty-bot <308658023+netcatty-bot@users.noreply.github.com>
Co-authored-by: bincxz <16399091+binaricat@users.noreply.github.com>
2026-09-30 00:38:50 +08:00

150 lines
6.0 KiB
TypeScript

import type { Terminal as XTerm } from "@xterm/xterm";
import type React from "react";
import { useEffect } from "react";
import { requestMultilinePasteConfirm } from "../../../application/state/multilinePasteConfirmStore";
import { netcattyBridge } from "../../../infrastructure/services/netcattyBridge";
import { logger } from "../../../lib/logger";
import type { TerminalSession } from "../../../types";
import type { RemoteClipboardImageUploadResult } from "../clipboardImagePaste";
import type { MultilinePasteConfirmGate } from "../terminalClipboardPaste";
import { handleTerminalClipboardPaste } from "../terminalClipboardPaste";
interface UseTerminalFilePasteOptions {
isLocalConnection: boolean;
status: TerminalSession["status"];
termRef: React.MutableRefObject<XTerm | null>;
sessionRef: React.MutableRefObject<string | null>;
terminalBackend: {
writeToSession: (sessionId: string, data: string, options?: { automated?: boolean; sensitive?: boolean }) => void;
};
isSensitiveInput?: () => boolean;
scrollOnPasteRef?: React.RefObject<boolean>;
/** Live #3488 bypass probe; forwarded to the multiline-confirm gate. */
broadcastPasswordBypassRef?: React.RefObject<boolean | undefined>;
onPasteData?: (data: string, options?: { lineDelayMs?: number; sensitive?: boolean }) => boolean | void;
scrollToBottomAfterProgrammaticInput: (data: string) => void;
containerRef: React.RefObject<HTMLDivElement | null>;
/** Remote sessions only: auto-upload a clipboard image on paste. */
autoUploadClipboardImage?: boolean;
/** Multi-line paste confirmation gate (#3398); undefined keeps confirm off. */
multilinePasteConfirmRef?: React.RefObject<Omit<MultilinePasteConfirmGate, "requestConfirm"> | undefined>;
getRemoteCwd?: () => Promise<string | null | undefined>;
onClipboardImageUploadResult?: (result: RemoteClipboardImageUploadResult) => void;
}
export function useTerminalFilePaste({
isLocalConnection,
status,
termRef,
sessionRef,
terminalBackend,
isSensitiveInput,
scrollOnPasteRef,
broadcastPasswordBypassRef,
onPasteData,
scrollToBottomAfterProgrammaticInput,
containerRef,
autoUploadClipboardImage = false,
multilinePasteConfirmRef,
getRemoteCwd,
onClipboardImageUploadResult,
}: UseTerminalFilePasteOptions) {
useEffect(() => {
const container = containerRef.current;
if (!container) return;
const handlePaste = (event: ClipboardEvent) => {
if (status !== "connected") return;
const bridge = netcattyBridge.get();
const wantsImageUpload =
autoUploadClipboardImage && !isLocalConnection && !!bridge?.readClipboardImage;
const canHandleLocalPaste =
isLocalConnection && !!(bridge?.readClipboardFiles || bridge?.hasClipboardImage);
// The multi-line paste confirmation (#3398) must also intercept plain
// remote keyboard pastes; otherwise xterm's default handler would send
// the lines without the safety dialog when neither image upload nor
// local file handling applies.
const shouldInterceptPaste =
wantsImageUpload
|| canHandleLocalPaste
|| !!multilinePasteConfirmRef?.current?.enabled;
if (!shouldInterceptPaste) return;
// ⚡ Must call preventDefault SYNCHRONOUSLY — the event lifecycle
// is synchronous; calling it after an await is too late and the
// browser will have already performed the default paste action.
event.preventDefault();
event.stopPropagation();
// Capture the pasted text synchronously: navigator.clipboard.readText()
// can be rejected (permissions / platform quirks) even though the event
// already carries the text, so prefer it and only fall back to the
// async clipboard API when the event has no text data.
const eventText = event.clipboardData?.getData("text/plain") ?? "";
void (async () => {
try {
const term = termRef.current;
if (!term) return;
await handleTerminalClipboardPaste({
bridge,
autoUploadClipboardImage: wantsImageUpload,
clipboardImageBridge: bridge ?? undefined,
confirmMultilinePaste: multilinePasteConfirmRef?.current
? { ...multilinePasteConfirmRef.current, requestConfirm: requestMultilinePasteConfirm }
: undefined,
// The confirm dialog can outlive the captured session (disconnect
// / auto-reconnect), so revalidate against the live session ref
// like the context-menu and shortcut callers do.
getCurrentSessionId: () => sessionRef.current,
getRemoteCwd,
isLocalConnection,
isSensitiveInput,
// Forward the #3488 bypass probe so a paste confirmed at a
// sensitive prompt still fans out to broadcast peers, matching
// the context-menu and shortcut paste paths.
broadcastPasswordBypass: () => broadcastPasswordBypassRef?.current === true,
onClipboardImageUploadResult,
readClipboardText: async () => {
if (eventText) return eventText;
return navigator.clipboard.readText();
},
scrollOnPaste: scrollOnPasteRef?.current ?? false,
onPasteData,
sessionId: sessionRef.current,
terminalBackend,
term,
scrollToBottomAfterProgrammaticInput,
});
} catch (error) {
logger.error("Failed to handle file paste", error);
}
})();
};
container.addEventListener("paste", handlePaste, true);
return () => {
container.removeEventListener("paste", handlePaste, true);
};
}, [
autoUploadClipboardImage,
broadcastPasswordBypassRef,
containerRef,
multilinePasteConfirmRef,
getRemoteCwd,
isLocalConnection,
isSensitiveInput,
onClipboardImageUploadResult,
onPasteData,
scrollOnPasteRef,
scrollToBottomAfterProgrammaticInput,
sessionRef,
status,
terminalBackend,
termRef,
]);
}