Files
gemini-cli/packages/cli/src/ui/components/messages/ToolConfirmationMessage.tsx
T

454 lines
14 KiB
TypeScript
Raw Normal View History

/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import type React from 'react';
2025-11-11 07:50:11 -08:00
import { useEffect, useState, useMemo } from 'react';
import { Box, Text } from 'ink';
2025-04-21 10:53:11 -04:00
import { DiffRenderer } from './DiffRenderer.js';
import { RenderInline } from '../../utils/InlineMarkdownRenderer.js';
import type {
2025-04-17 18:06:21 -04:00
ToolCallConfirmationDetails,
Config,
} from '@google/gemini-cli-core';
import {
IdeClient,
ToolConfirmationOutcome,
hasRedirection,
} from '@google/gemini-cli-core';
import type { RadioSelectItem } from '../shared/RadioButtonSelect.js';
import { RadioButtonSelect } from '../shared/RadioButtonSelect.js';
import { MaxSizedBox, MINIMUM_MAX_HEIGHT } from '../shared/MaxSizedBox.js';
import { useKeypress } from '../../hooks/useKeypress.js';
2025-09-10 10:57:07 -07:00
import { theme } from '../../semantic-colors.js';
import { useSettings } from '../../contexts/SettingsContext.js';
import {
REDIRECTION_WARNING_NOTE_LABEL,
REDIRECTION_WARNING_NOTE_TEXT,
REDIRECTION_WARNING_TIP_LABEL,
REDIRECTION_WARNING_TIP_TEXT,
} from '../../textConstants.js';
2025-04-15 21:41:08 -07:00
export interface ToolConfirmationMessageProps {
confirmationDetails: ToolCallConfirmationDetails;
config: Config;
2025-06-12 02:21:54 +01:00
isFocused?: boolean;
availableTerminalHeight?: number;
terminalWidth: number;
2025-04-15 21:41:08 -07:00
}
2025-04-18 19:09:41 -04:00
export const ToolConfirmationMessage: React.FC<
ToolConfirmationMessageProps
> = ({
confirmationDetails,
config,
isFocused = true,
availableTerminalHeight,
terminalWidth,
}) => {
2025-04-15 21:41:08 -07:00
const { onConfirm } = confirmationDetails;
const settings = useSettings();
const allowPermanentApproval =
settings.merged.security.enablePermanentToolApproval;
2025-11-11 07:50:11 -08:00
const [ideClient, setIdeClient] = useState<IdeClient | null>(null);
const [isDiffingEnabled, setIsDiffingEnabled] = useState(false);
useEffect(() => {
let isMounted = true;
if (config.getIdeMode()) {
const getIdeClient = async () => {
const client = await IdeClient.getInstance();
if (isMounted) {
setIdeClient(client);
setIsDiffingEnabled(client?.isDiffingEnabled() ?? false);
}
};
2025-12-05 16:12:49 -08:00
// eslint-disable-next-line @typescript-eslint/no-floating-promises
getIdeClient();
}
return () => {
isMounted = false;
};
}, [config]);
const handleConfirm = async (outcome: ToolConfirmationOutcome) => {
if (confirmationDetails.type === 'edit') {
if (config.getIdeMode() && isDiffingEnabled) {
const cliOutcome =
outcome === ToolConfirmationOutcome.Cancel ? 'rejected' : 'accepted';
await ideClient?.resolveDiffFromCli(
confirmationDetails.filePath,
cliOutcome,
);
}
}
2025-12-05 16:12:49 -08:00
// eslint-disable-next-line @typescript-eslint/no-floating-promises
onConfirm(outcome);
};
const isTrustedFolder = config.isTrustedFolder();
useKeypress(
(key) => {
if (!isFocused) return;
if (key.name === 'escape' || (key.ctrl && key.name === 'c')) {
2025-12-05 16:12:49 -08:00
// eslint-disable-next-line @typescript-eslint/no-floating-promises
handleConfirm(ToolConfirmationOutcome.Cancel);
}
},
{ isActive: isFocused },
);
2025-04-15 21:41:08 -07:00
const handleSelect = (item: ToolConfirmationOutcome) => handleConfirm(item);
2025-04-15 21:41:08 -07:00
2025-11-11 07:50:11 -08:00
const { question, bodyContent, options } = useMemo(() => {
let bodyContent: React.ReactNode | null = null;
let question = '';
const options: Array<RadioSelectItem<ToolConfirmationOutcome>> = [];
2025-11-11 07:50:11 -08:00
if (confirmationDetails.type === 'edit') {
if (!confirmationDetails.isModifying) {
question = `Apply this change?`;
options.push({
label: 'Allow once',
2025-11-11 07:50:11 -08:00
value: ToolConfirmationOutcome.ProceedOnce,
key: 'Allow once',
2025-11-11 07:50:11 -08:00
});
if (isTrustedFolder) {
options.push({
label: 'Allow for this session',
2025-11-11 07:50:11 -08:00
value: ToolConfirmationOutcome.ProceedAlways,
key: 'Allow for this session',
2025-11-11 07:50:11 -08:00
});
if (allowPermanentApproval) {
options.push({
label: 'Allow for all future sessions',
value: ToolConfirmationOutcome.ProceedAlwaysAndSave,
key: 'Allow for all future sessions',
});
}
2025-11-11 07:50:11 -08:00
}
if (!config.getIdeMode() || !isDiffingEnabled) {
options.push({
label: 'Modify with external editor',
value: ToolConfirmationOutcome.ModifyWithEditor,
key: 'Modify with external editor',
});
}
2025-04-15 21:41:08 -07:00
2025-11-11 07:50:11 -08:00
options.push({
label: 'No, suggest changes (esc)',
value: ToolConfirmationOutcome.Cancel,
key: 'No, suggest changes (esc)',
});
}
} else if (confirmationDetails.type === 'exec') {
2025-12-12 17:43:43 -08:00
const executionProps = confirmationDetails;
if (executionProps.commands && executionProps.commands.length > 1) {
question = `Allow execution of ${executionProps.commands.length} commands?`;
} else {
question = `Allow execution of: '${executionProps.rootCommand}'?`;
}
2025-11-11 07:50:11 -08:00
options.push({
label: 'Allow once',
2025-11-11 07:50:11 -08:00
value: ToolConfirmationOutcome.ProceedOnce,
key: 'Allow once',
2025-11-11 07:50:11 -08:00
});
if (isTrustedFolder) {
options.push({
label: `Allow for this session`,
2025-11-11 07:50:11 -08:00
value: ToolConfirmationOutcome.ProceedAlways,
key: `Allow for this session`,
2025-11-11 07:50:11 -08:00
});
if (allowPermanentApproval) {
options.push({
label: `Allow for all future sessions`,
value: ToolConfirmationOutcome.ProceedAlwaysAndSave,
key: `Allow for all future sessions`,
});
}
2025-11-11 07:50:11 -08:00
}
options.push({
label: 'No, suggest changes (esc)',
value: ToolConfirmationOutcome.Cancel,
key: 'No, suggest changes (esc)',
});
} else if (confirmationDetails.type === 'info') {
question = `Do you want to proceed?`;
options.push({
label: 'Allow once',
2025-11-11 07:50:11 -08:00
value: ToolConfirmationOutcome.ProceedOnce,
key: 'Allow once',
2025-11-11 07:50:11 -08:00
});
if (isTrustedFolder) {
options.push({
label: 'Allow for this session',
2025-11-11 07:50:11 -08:00
value: ToolConfirmationOutcome.ProceedAlways,
key: 'Allow for this session',
2025-11-11 07:50:11 -08:00
});
if (allowPermanentApproval) {
options.push({
label: 'Allow for all future sessions',
value: ToolConfirmationOutcome.ProceedAlwaysAndSave,
key: 'Allow for all future sessions',
});
}
2025-11-11 07:50:11 -08:00
}
options.push({
label: 'No, suggest changes (esc)',
value: ToolConfirmationOutcome.Cancel,
key: 'No, suggest changes (esc)',
});
} else {
// mcp tool confirmation
2025-12-12 17:43:43 -08:00
const mcpProps = confirmationDetails;
2025-11-11 07:50:11 -08:00
question = `Allow execution of MCP tool "${mcpProps.toolName}" from server "${mcpProps.serverName}"?`;
options.push({
label: 'Allow once',
2025-11-11 07:50:11 -08:00
value: ToolConfirmationOutcome.ProceedOnce,
key: 'Allow once',
2025-11-11 07:50:11 -08:00
});
if (isTrustedFolder) {
options.push({
label: 'Allow tool for this session',
value: ToolConfirmationOutcome.ProceedAlwaysTool,
key: 'Allow tool for this session',
2025-11-11 07:50:11 -08:00
});
options.push({
label: 'Allow all server tools for this session',
2025-11-11 07:50:11 -08:00
value: ToolConfirmationOutcome.ProceedAlwaysServer,
key: 'Allow all server tools for this session',
2025-11-11 07:50:11 -08:00
});
if (allowPermanentApproval) {
options.push({
label: 'Allow tool for all future sessions',
value: ToolConfirmationOutcome.ProceedAlwaysAndSave,
key: 'Allow tool for all future sessions',
});
}
2025-11-11 07:50:11 -08:00
}
options.push({
label: 'No, suggest changes (esc)',
value: ToolConfirmationOutcome.Cancel,
key: 'No, suggest changes (esc)',
});
}
2025-11-11 07:50:11 -08:00
function availableBodyContentHeight() {
if (options.length === 0) {
// Should not happen if we populated options correctly above for all types
// except when isModifying is true, but in that case we don't call this because we don't enter the if block for it.
return undefined;
}
if (availableTerminalHeight === undefined) {
return undefined;
}
// Calculate the vertical space (in lines) consumed by UI elements
// surrounding the main body content.
const PADDING_OUTER_Y = 2; // Main container has `padding={1}` (top & bottom).
const MARGIN_BODY_BOTTOM = 1; // margin on the body container.
const HEIGHT_QUESTION = 1; // The question text is one line.
const MARGIN_QUESTION_BOTTOM = 1; // Margin on the question container.
const HEIGHT_OPTIONS = options.length; // Each option in the radio select takes one line.
const surroundingElementsHeight =
PADDING_OUTER_Y +
MARGIN_BODY_BOTTOM +
HEIGHT_QUESTION +
MARGIN_QUESTION_BOTTOM +
HEIGHT_OPTIONS;
return Math.max(availableTerminalHeight - surroundingElementsHeight, 1);
}
2025-11-11 07:50:11 -08:00
if (confirmationDetails.type === 'edit') {
if (!confirmationDetails.isModifying) {
bodyContent = (
<DiffRenderer
diffContent={confirmationDetails.fileDiff}
filename={confirmationDetails.fileName}
availableTerminalHeight={availableBodyContentHeight()}
terminalWidth={terminalWidth}
/>
);
}
} else if (confirmationDetails.type === 'exec') {
2025-12-12 17:43:43 -08:00
const executionProps = confirmationDetails;
const commandsToDisplay =
executionProps.commands && executionProps.commands.length > 1
? executionProps.commands
: [executionProps.command];
const containsRedirection = commandsToDisplay.some((cmd) =>
hasRedirection(cmd),
);
2025-11-11 07:50:11 -08:00
let bodyContentHeight = availableBodyContentHeight();
let warnings: React.ReactNode = null;
2025-11-11 07:50:11 -08:00
if (bodyContentHeight !== undefined) {
bodyContentHeight -= 2; // Account for padding;
}
if (containsRedirection) {
// Calculate lines needed for Note and Tip
const safeWidth = Math.max(terminalWidth, 1);
const noteLength =
REDIRECTION_WARNING_NOTE_LABEL.length +
REDIRECTION_WARNING_NOTE_TEXT.length;
const tipLength =
REDIRECTION_WARNING_TIP_LABEL.length +
REDIRECTION_WARNING_TIP_TEXT.length;
const noteLines = Math.ceil(noteLength / safeWidth);
const tipLines = Math.ceil(tipLength / safeWidth);
const spacerLines = 1;
const warningHeight = noteLines + tipLines + spacerLines;
if (bodyContentHeight !== undefined) {
bodyContentHeight = Math.max(
bodyContentHeight - warningHeight,
MINIMUM_MAX_HEIGHT,
);
}
warnings = (
<>
<Box height={1} />
<Box>
<Text color={theme.text.primary}>
<Text bold>{REDIRECTION_WARNING_NOTE_LABEL}</Text>
{REDIRECTION_WARNING_NOTE_TEXT}
</Text>
</Box>
<Box>
<Text color={theme.border.default}>
<Text bold>{REDIRECTION_WARNING_TIP_LABEL}</Text>
{REDIRECTION_WARNING_TIP_TEXT}
</Text>
</Box>
</>
);
}
bodyContent = (
<Box flexDirection="column">
<MaxSizedBox
maxHeight={bodyContentHeight}
maxWidth={Math.max(terminalWidth, 1)}
>
<Box flexDirection="column">
{commandsToDisplay.map((cmd, idx) => (
<Text key={idx} color={theme.text.link}>
{cmd}
</Text>
))}
</Box>
</MaxSizedBox>
{warnings}
</Box>
2025-11-11 07:50:11 -08:00
);
} else if (confirmationDetails.type === 'info') {
const infoProps = confirmationDetails;
const displayUrls =
infoProps.urls &&
!(
infoProps.urls.length === 1 && infoProps.urls[0] === infoProps.prompt
);
bodyContent = (
<Box flexDirection="column">
2025-11-11 07:50:11 -08:00
<Text color={theme.text.link}>
<RenderInline
text={infoProps.prompt}
defaultColor={theme.text.link}
/>
</Text>
{displayUrls && infoProps.urls && infoProps.urls.length > 0 && (
<Box flexDirection="column" marginTop={1}>
<Text color={theme.text.primary}>URLs to fetch:</Text>
{infoProps.urls.map((url) => (
<Text key={url}>
{' '}
- <RenderInline text={url} />
</Text>
))}
</Box>
)}
</Box>
);
} else {
// mcp tool confirmation
2025-12-12 17:43:43 -08:00
const mcpProps = confirmationDetails;
2025-11-11 07:50:11 -08:00
bodyContent = (
<Box flexDirection="column">
2025-11-11 07:50:11 -08:00
<Text color={theme.text.link}>MCP Server: {mcpProps.serverName}</Text>
<Text color={theme.text.link}>Tool: {mcpProps.toolName}</Text>
</Box>
);
}
return { question, bodyContent, options };
}, [
confirmationDetails,
isTrustedFolder,
config,
isDiffingEnabled,
availableTerminalHeight,
terminalWidth,
allowPermanentApproval,
2025-11-11 07:50:11 -08:00
]);
if (confirmationDetails.type === 'edit') {
if (confirmationDetails.isModifying) {
return (
<Box
width={terminalWidth}
borderStyle="round"
2025-09-10 10:57:07 -07:00
borderColor={theme.border.default}
justifyContent="space-around"
paddingTop={1}
paddingBottom={1}
overflow="hidden"
>
2025-09-10 10:57:07 -07:00
<Text color={theme.text.primary}>Modify in progress: </Text>
<Text color={theme.status.success}>
Save and close external editor to continue
</Text>
</Box>
);
}
2025-04-15 21:41:08 -07:00
}
return (
2025-11-11 07:50:11 -08:00
<Box flexDirection="column" paddingTop={0} paddingBottom={1}>
2025-04-15 21:41:08 -07:00
{/* Body Content (Diff Renderer or Command Info) */}
{/* No separate context display here anymore for edits */}
<Box flexGrow={1} flexShrink={1} overflow="hidden" marginBottom={1}>
2025-04-17 18:06:21 -04:00
{bodyContent}
2025-04-15 21:41:08 -07:00
</Box>
{/* Confirmation Question */}
<Box marginBottom={1} flexShrink={0}>
2025-11-11 07:50:11 -08:00
<Text color={theme.text.primary}>{question}</Text>
2025-04-15 21:41:08 -07:00
</Box>
{/* Select Input for Options */}
<Box flexShrink={0}>
2025-06-12 02:21:54 +01:00
<RadioButtonSelect
items={options}
onSelect={handleSelect}
isFocused={isFocused}
/>
2025-04-15 21:41:08 -07:00
</Box>
</Box>
);
};