mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-03-16 09:01:17 -07:00
Fix drag and drop escaping (#18965)
This commit is contained in:
Tommaso Sciortino
committed by
GitHub
GitHub
parent
00f73b73bc
commit
d82f66973f
@@ -4,7 +4,7 @@
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
import { describe, it, expect, beforeAll, afterAll, vi } from 'vitest';
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import * as fs from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import { pathToFileURL } from 'node:url';
|
||||
@@ -24,131 +24,118 @@ vi.mock('node:fs', async (importOriginal) => {
|
||||
};
|
||||
});
|
||||
|
||||
const mockPlatform = (platform: string) => {
|
||||
vi.stubGlobal(
|
||||
'process',
|
||||
Object.create(process, {
|
||||
platform: {
|
||||
get: () => platform,
|
||||
},
|
||||
}),
|
||||
);
|
||||
};
|
||||
|
||||
describe('escapePath', () => {
|
||||
it.each([
|
||||
['spaces', 'my file.txt', 'my\\ file.txt'],
|
||||
['tabs', 'file\twith\ttabs.txt', 'file\\\twith\\\ttabs.txt'],
|
||||
['parentheses', 'file(1).txt', 'file\\(1\\).txt'],
|
||||
['square brackets', 'file[backup].txt', 'file\\[backup\\].txt'],
|
||||
['curly braces', 'file{temp}.txt', 'file\\{temp\\}.txt'],
|
||||
['semicolons', 'file;name.txt', 'file\\;name.txt'],
|
||||
['ampersands', 'file&name.txt', 'file\\&name.txt'],
|
||||
['pipes', 'file|name.txt', 'file\\|name.txt'],
|
||||
['asterisks', 'file*.txt', 'file\\*.txt'],
|
||||
['question marks', 'file?.txt', 'file\\?.txt'],
|
||||
['dollar signs', 'file$name.txt', 'file\\$name.txt'],
|
||||
['backticks', 'file`name.txt', 'file\\`name.txt'],
|
||||
['single quotes', "file'name.txt", "file\\'name.txt"],
|
||||
['double quotes', 'file"name.txt', 'file\\"name.txt'],
|
||||
['hash symbols', 'file#name.txt', 'file\\#name.txt'],
|
||||
['exclamation marks', 'file!name.txt', 'file\\!name.txt'],
|
||||
[
|
||||
'tildes',
|
||||
'file~name.txt',
|
||||
process.platform === 'win32' ? 'file~name.txt' : 'file\\~name.txt',
|
||||
],
|
||||
[
|
||||
'less than and greater than signs',
|
||||
'file<name>.txt',
|
||||
'file\\<name\\>.txt',
|
||||
],
|
||||
])('should escape %s', (_, input, expected) => {
|
||||
expect(escapePath(input)).toBe(expected);
|
||||
afterEach(() => vi.unstubAllGlobals());
|
||||
|
||||
describe('in posix', () => {
|
||||
beforeEach(() => mockPlatform('linux'));
|
||||
|
||||
it.each([
|
||||
['spaces', 'my file.txt', 'my\\ file.txt'],
|
||||
['tabs', 'file\twith\ttabs.txt', 'file\\\twith\\\ttabs.txt'],
|
||||
['parentheses', 'file(1).txt', 'file\\(1\\).txt'],
|
||||
['square brackets', 'file[backup].txt', 'file\\[backup\\].txt'],
|
||||
['curly braces', 'file{temp}.txt', 'file\\{temp\\}.txt'],
|
||||
['semicolons', 'file;name.txt', 'file\\;name.txt'],
|
||||
['ampersands', 'file&name.txt', 'file\\&name.txt'],
|
||||
['pipes', 'file|name.txt', 'file\\|name.txt'],
|
||||
['asterisks', 'file*.txt', 'file\\*.txt'],
|
||||
['question marks', 'file?.txt', 'file\\?.txt'],
|
||||
['dollar signs', 'file$name.txt', 'file\\$name.txt'],
|
||||
['backticks', 'file`name.txt', 'file\\`name.txt'],
|
||||
['single quotes', "file'name.txt", "file\\'name.txt"],
|
||||
['double quotes', 'file"name.txt', 'file\\"name.txt'],
|
||||
['hash symbols', 'file#name.txt', 'file\\#name.txt'],
|
||||
['exclamation marks', 'file!name.txt', 'file\\!name.txt'],
|
||||
['tildes', 'file~name.txt', 'file\\~name.txt'],
|
||||
[
|
||||
'less than and greater than signs',
|
||||
'file<name>.txt',
|
||||
'file\\<name\\>.txt',
|
||||
],
|
||||
[
|
||||
'multiple special characters',
|
||||
'my file (backup) [v1.2].txt',
|
||||
'my\\ file\\ \\(backup\\)\\ \\[v1.2\\].txt',
|
||||
],
|
||||
['normal file', 'normalfile.txt', 'normalfile.txt'],
|
||||
['normal path', 'path/to/normalfile.txt', 'path/to/normalfile.txt'],
|
||||
[
|
||||
'real world example 1',
|
||||
'My Documents/Project (2024)/file [backup].txt',
|
||||
'My\\ Documents/Project\\ \\(2024\\)/file\\ \\[backup\\].txt',
|
||||
],
|
||||
[
|
||||
'real world example 2',
|
||||
'file with $special &chars!.txt',
|
||||
'file\\ with\\ \\$special\\ \\&chars\\!.txt',
|
||||
],
|
||||
['empty string', '', ''],
|
||||
[
|
||||
'all special chars',
|
||||
' ()[]{};&|*?$`\'"#!<>',
|
||||
'\\ \\(\\)\\[\\]\\{\\}\\;\\&\\|\\*\\?\\$\\`\\\'\\"\\#\\!\\<\\>',
|
||||
],
|
||||
])('should escape %s', (_, input, expected) => {
|
||||
expect(escapePath(input)).toBe(expected);
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle multiple special characters', () => {
|
||||
expect(escapePath('my file (backup) [v1.2].txt')).toBe(
|
||||
'my\\ file\\ \\(backup\\)\\ \\[v1.2\\].txt',
|
||||
);
|
||||
});
|
||||
describe('in windows', () => {
|
||||
beforeEach(() => mockPlatform('win32'));
|
||||
|
||||
it('should not double-escape already escaped characters', () => {
|
||||
expect(escapePath('my\\ file.txt')).toBe('my\\ file.txt');
|
||||
expect(escapePath('file\\(name\\).txt')).toBe('file\\(name\\).txt');
|
||||
});
|
||||
|
||||
it('should handle escaped backslashes correctly', () => {
|
||||
// Double backslash (escaped backslash) followed by space should escape the space
|
||||
expect(escapePath('path\\\\ file.txt')).toBe('path\\\\\\ file.txt');
|
||||
// Triple backslash (escaped backslash + escaping backslash) followed by space should not double-escape
|
||||
expect(escapePath('path\\\\\\ file.txt')).toBe('path\\\\\\ file.txt');
|
||||
// Quadruple backslash (two escaped backslashes) followed by space should escape the space
|
||||
expect(escapePath('path\\\\\\\\ file.txt')).toBe('path\\\\\\\\\\ file.txt');
|
||||
});
|
||||
|
||||
it('should handle complex escaped backslash scenarios', () => {
|
||||
// Escaped backslash before special character that needs escaping
|
||||
expect(escapePath('file\\\\(test).txt')).toBe('file\\\\\\(test\\).txt');
|
||||
// Multiple escaped backslashes
|
||||
expect(escapePath('path\\\\\\\\with space.txt')).toBe(
|
||||
'path\\\\\\\\with\\ space.txt',
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle paths without special characters', () => {
|
||||
expect(escapePath('normalfile.txt')).toBe('normalfile.txt');
|
||||
expect(escapePath('path/to/normalfile.txt')).toBe('path/to/normalfile.txt');
|
||||
});
|
||||
|
||||
it('should handle complex real-world examples', () => {
|
||||
expect(escapePath('My Documents/Project (2024)/file [backup].txt')).toBe(
|
||||
'My\\ Documents/Project\\ \\(2024\\)/file\\ \\[backup\\].txt',
|
||||
);
|
||||
expect(escapePath('file with $special &chars!.txt')).toBe(
|
||||
'file\\ with\\ \\$special\\ \\&chars\\!.txt',
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle empty strings', () => {
|
||||
expect(escapePath('')).toBe('');
|
||||
});
|
||||
|
||||
it('should handle paths with multiple special characters', () => {
|
||||
expect(escapePath(' ()[]{};&|*?$`\'"#!<>')).toBe(
|
||||
'\\ \\(\\)\\[\\]\\{\\}\\;\\&\\|\\*\\?\\$\\`\\\'\\"\\#\\!\\<\\>',
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle tildes based on platform', () => {
|
||||
const expected = process.platform === 'win32' ? '~' : '\\~';
|
||||
expect(escapePath('~')).toBe(expected);
|
||||
it.each([
|
||||
[
|
||||
'spaces',
|
||||
'C:\\path with spaces\\file.txt',
|
||||
'"C:\\path with spaces\\file.txt"',
|
||||
],
|
||||
['parentheses', 'file(1).txt', '"file(1).txt"'],
|
||||
['special chars', 'file&name.txt', '"file&name.txt"'],
|
||||
['caret', 'file^name.txt', '"file^name.txt"'],
|
||||
['normal path', 'C:\\path\\to\\file.txt', 'C:\\path\\to\\file.txt'],
|
||||
])('should escape %s', (_, input, expected) => {
|
||||
expect(escapePath(input)).toBe(expected);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('unescapePath', () => {
|
||||
it.each([
|
||||
['spaces', 'my\\ file.txt', 'my file.txt'],
|
||||
['tabs', 'file\\\twith\\\ttabs.txt', 'file\twith\ttabs.txt'],
|
||||
['parentheses', 'file\\(1\\).txt', 'file(1).txt'],
|
||||
['square brackets', 'file\\[backup\\].txt', 'file[backup].txt'],
|
||||
['curly braces', 'file\\{temp\\}.txt', 'file{temp}.txt'],
|
||||
])('should unescape %s', (_, input, expected) => {
|
||||
expect(unescapePath(input)).toBe(expected);
|
||||
});
|
||||
afterEach(() => vi.unstubAllGlobals());
|
||||
|
||||
it('should unescape multiple special characters', () => {
|
||||
expect(unescapePath('my\\ file\\ \\(backup\\)\\ \\[v1.2\\].txt')).toBe(
|
||||
'my file (backup) [v1.2].txt',
|
||||
);
|
||||
});
|
||||
describe('in posix', () => {
|
||||
beforeEach(() => mockPlatform('linux'));
|
||||
|
||||
it('should handle paths without escaped characters', () => {
|
||||
expect(unescapePath('normalfile.txt')).toBe('normalfile.txt');
|
||||
expect(unescapePath('path/to/normalfile.txt')).toBe(
|
||||
'path/to/normalfile.txt',
|
||||
);
|
||||
});
|
||||
it.each([
|
||||
['spaces', 'my\\ file.txt', 'my file.txt'],
|
||||
['tabs', 'file\\\twith\\\ttabs.txt', 'file\twith\ttabs.txt'],
|
||||
['parentheses', 'file\\(1\\).txt', 'file(1).txt'],
|
||||
['square brackets', 'file\\[backup\\].txt', 'file[backup].txt'],
|
||||
['curly braces', 'file\\{temp\\}.txt', 'file{temp}.txt'],
|
||||
[
|
||||
'multiple special characters',
|
||||
'my\\ file\\ \\(backup\\)\\ \\[v1.2\\].txt',
|
||||
'my file (backup) [v1.2].txt',
|
||||
],
|
||||
['normal file', 'normalfile.txt', 'normalfile.txt'],
|
||||
['normal path', 'path/to/normalfile.txt', 'path/to/normalfile.txt'],
|
||||
['empty string', '', ''],
|
||||
])('should unescape %s', (_, input, expected) => {
|
||||
expect(unescapePath(input)).toBe(expected);
|
||||
});
|
||||
|
||||
it('should handle all special characters but tilda', () => {
|
||||
expect(
|
||||
unescapePath(
|
||||
'\\ \\(\\)\\[\\]\\{\\}\\;\\&\\|\\*\\?\\$\\`\\\'\\"\\#\\!\\<\\>',
|
||||
),
|
||||
).toBe(' ()[]{};&|*?$`\'"#!<>');
|
||||
});
|
||||
|
||||
it('should be the inverse of escapePath', () => {
|
||||
const testCases = [
|
||||
it.each([
|
||||
'my file.txt',
|
||||
'file(1).txt',
|
||||
'file[backup].txt',
|
||||
@@ -156,29 +143,35 @@ describe('unescapePath', () => {
|
||||
'file with $special &chars!.txt',
|
||||
' ()[]{};&|*?$`\'"#!~<>',
|
||||
'file\twith\ttabs.txt',
|
||||
];
|
||||
|
||||
testCases.forEach((testCase) => {
|
||||
expect(unescapePath(escapePath(testCase))).toBe(testCase);
|
||||
])('should unescape escaped %s', (input) => {
|
||||
expect(unescapePath(escapePath(input))).toBe(input);
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle empty strings', () => {
|
||||
expect(unescapePath('')).toBe('');
|
||||
});
|
||||
describe('in windows', () => {
|
||||
beforeEach(() => mockPlatform('win32'));
|
||||
|
||||
it('should not affect backslashes not followed by special characters', () => {
|
||||
expect(unescapePath('file\\name.txt')).toBe('file\\name.txt');
|
||||
expect(unescapePath('path\\to\\file.txt')).toBe('path\\to\\file.txt');
|
||||
});
|
||||
it.each([
|
||||
[
|
||||
'quoted path',
|
||||
'"C:\\path with spaces\\file.txt"',
|
||||
'C:\\path with spaces\\file.txt',
|
||||
],
|
||||
['unquoted path', 'C:\\path\\to\\file.txt', 'C:\\path\\to\\file.txt'],
|
||||
['partially quoted', '"C:\\path', '"C:\\path'],
|
||||
['empty string', '', ''],
|
||||
])('should unescape %s', (_, input, expected) => {
|
||||
expect(unescapePath(input)).toBe(expected);
|
||||
});
|
||||
|
||||
it('should handle escaped backslashes in unescaping', () => {
|
||||
// Should correctly unescape when there are escaped backslashes
|
||||
expect(unescapePath('path\\\\\\ file.txt')).toBe('path\\\\ file.txt');
|
||||
expect(unescapePath('path\\\\\\\\\\ file.txt')).toBe(
|
||||
'path\\\\\\\\ file.txt',
|
||||
);
|
||||
expect(unescapePath('file\\\\\\(test\\).txt')).toBe('file\\\\(test).txt');
|
||||
it.each([
|
||||
'C:\\path\\to\\file.txt',
|
||||
'C:\\path with spaces\\file.txt',
|
||||
'file(1).txt',
|
||||
'file&name.txt',
|
||||
])('should unescape escaped %s', (input) => {
|
||||
expect(unescapePath(escapePath(input))).toBe(input);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -222,19 +215,9 @@ describe('isSubpath', () => {
|
||||
});
|
||||
|
||||
describe('isSubpath on Windows', () => {
|
||||
const originalPlatform = process.platform;
|
||||
afterEach(() => vi.unstubAllGlobals());
|
||||
|
||||
beforeAll(() => {
|
||||
Object.defineProperty(process, 'platform', {
|
||||
value: 'win32',
|
||||
});
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
Object.defineProperty(process, 'platform', {
|
||||
value: originalPlatform,
|
||||
});
|
||||
});
|
||||
beforeEach(() => mockPlatform('win32'));
|
||||
|
||||
it('should return true for a direct subpath on Windows', () => {
|
||||
expect(isSubpath('C:\\Users\\Test', 'C:\\Users\\Test\\file.txt')).toBe(
|
||||
|
||||
@@ -6,7 +6,6 @@
|
||||
|
||||
import path from 'node:path';
|
||||
import os from 'node:os';
|
||||
import process from 'node:process';
|
||||
import * as crypto from 'node:crypto';
|
||||
import * as fs from 'node:fs';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
@@ -14,15 +13,6 @@ import { fileURLToPath } from 'node:url';
|
||||
export const GEMINI_DIR = '.gemini';
|
||||
export const GOOGLE_ACCOUNTS_FILENAME = 'google_accounts.json';
|
||||
|
||||
/**
|
||||
* Special characters that need to be escaped in file paths for shell compatibility.
|
||||
* Note that windows doesn't escape tilda.
|
||||
*/
|
||||
export const SHELL_SPECIAL_CHARS =
|
||||
process.platform === 'win32'
|
||||
? /[ \t()[\]{};|*?$`'"#&<>!]/
|
||||
: /[ \t()[\]{};|*?$`'"#&<>!~]/;
|
||||
|
||||
/**
|
||||
* Returns the home directory.
|
||||
* If GEMINI_CLI_HOME environment variable is set, it returns its value.
|
||||
@@ -280,43 +270,43 @@ export function makeRelative(
|
||||
}
|
||||
|
||||
/**
|
||||
* Escapes special characters in a file path like macOS terminal does.
|
||||
* Escapes: spaces, parentheses, brackets, braces, semicolons, ampersands, pipes,
|
||||
* asterisks, question marks, dollar signs, backticks, quotes, hash, and other shell metacharacters.
|
||||
* Escape paths for at-commands.
|
||||
*
|
||||
* - Windows: double quoted if they contain special chars, otherwise bare
|
||||
* - POSIX: backslash-escaped
|
||||
*/
|
||||
export function escapePath(filePath: string): string {
|
||||
let result = '';
|
||||
for (let i = 0; i < filePath.length; i++) {
|
||||
const char = filePath[i];
|
||||
|
||||
// Count consecutive backslashes before this character
|
||||
let backslashCount = 0;
|
||||
for (let j = i - 1; j >= 0 && filePath[j] === '\\'; j--) {
|
||||
backslashCount++;
|
||||
}
|
||||
|
||||
// Character is already escaped if there's an odd number of backslashes before it
|
||||
const isAlreadyEscaped = backslashCount % 2 === 1;
|
||||
|
||||
// Only escape if not already escaped
|
||||
if (!isAlreadyEscaped && SHELL_SPECIAL_CHARS.test(char)) {
|
||||
result += '\\' + char;
|
||||
} else {
|
||||
result += char;
|
||||
if (process.platform === 'win32') {
|
||||
// Windows: Double quote if it contains space or special chars
|
||||
if (/[\s()[\]{};|&^$!@%`'~]/.test(filePath)) {
|
||||
return `"${filePath}"`;
|
||||
}
|
||||
return filePath;
|
||||
} else {
|
||||
// POSIX: Backslash escape
|
||||
return filePath.replace(/([ \t()[\]{};|*?$`'"#&<>!~\\])/g, '\\$1');
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unescapes special characters in a file path.
|
||||
* Removes backslash escaping from shell metacharacters.
|
||||
* Unescapes paths for at-commands.
|
||||
*
|
||||
* - Windows: double quoted if they contain special chars, otherwise bare
|
||||
* - POSIX: backslash-escaped
|
||||
*/
|
||||
export function unescapePath(filePath: string): string {
|
||||
return filePath.replace(
|
||||
new RegExp(`\\\\([${SHELL_SPECIAL_CHARS.source.slice(1, -1)}])`, 'g'),
|
||||
'$1',
|
||||
);
|
||||
if (process.platform === 'win32') {
|
||||
if (
|
||||
filePath.length >= 2 &&
|
||||
filePath.startsWith('"') &&
|
||||
filePath.endsWith('"')
|
||||
) {
|
||||
return filePath.slice(1, -1);
|
||||
}
|
||||
return filePath;
|
||||
} else {
|
||||
return filePath.replace(/\\(.)/g, '$1');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -345,7 +335,7 @@ export function normalizePath(p: string): string {
|
||||
* @returns True if childPath is a subpath of parentPath, false otherwise.
|
||||
*/
|
||||
export function isSubpath(parentPath: string, childPath: string): boolean {
|
||||
const isWindows = os.platform() === 'win32';
|
||||
const isWindows = process.platform === 'win32';
|
||||
const pathModule = isWindows ? path.win32 : path;
|
||||
|
||||
// On Windows, path.relative is case-insensitive. On POSIX, it's case-sensitive.
|
||||
|
||||
Reference in New Issue
Block a user