development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-09-13 21:55:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

File name validation fix in picker

Browse source
This commit is contained in:
Alex Ross 2019-04-25 15:50:27 +02:00
parent 487f095ec0
commit 9ad8bf662f
1 changed files with 29 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
src/vs/workbench/services/dialogs/browser/remoteFileDialog.ts
View file

@ -9,7 +9,7 @@ import * as objects from 'vs/base/common/objects';
import { IFileService, IFileStat, FileKind } from 'vs/platform/files/common/files'; import { IFileService, IFileStat, FileKind } from 'vs/platform/files/common/files';
import { IQuickInputService, IQuickPickItem, IQuickPick } from 'vs/platform/quickinput/common/quickInput'; import { IQuickInputService, IQuickPickItem, IQuickPick } from 'vs/platform/quickinput/common/quickInput';
import { URI } from 'vs/base/common/uri'; import { URI } from 'vs/base/common/uri';
import { isWindows } from 'vs/base/common/platform'; import { isWindows, OperatingSystem } from 'vs/base/common/platform';
import { ISaveDialogOptions, IOpenDialogOptions, IFileDialogService } from 'vs/platform/dialogs/common/dialogs'; import { ISaveDialogOptions, IOpenDialogOptions, IFileDialogService } from 'vs/platform/dialogs/common/dialogs';
import { REMOTE_HOST_SCHEME } from 'vs/platform/remote/common/remoteHosts'; import { REMOTE_HOST_SCHEME } from 'vs/platform/remote/common/remoteHosts';
import { ILabelService } from 'vs/platform/label/common/label'; import { ILabelService } from 'vs/platform/label/common/label';
@ -26,6 +26,7 @@ import { RemoteFileDialogContext } from 'vs/workbench/common/contextkeys';
import { equalsIgnoreCase, format } from 'vs/base/common/strings'; import { equalsIgnoreCase, format } from 'vs/base/common/strings';
import { OpenLocalFileAction, OpenLocalFileFolderAction, OpenLocalFolderAction } from 'vs/workbench/browser/actions/workspaceActions'; import { OpenLocalFileAction, OpenLocalFileFolderAction, OpenLocalFolderAction } from 'vs/workbench/browser/actions/workspaceActions';
import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding'; import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
import { IRemoteAgentEnvironment } from 'vs/platform/remote/common/remoteAgentEnvironment';
interface FileQuickPickItem extends IQuickPickItem { interface FileQuickPickItem extends IQuickPickItem {
uri: URI; uri: URI;
@ -40,7 +41,8 @@ enum UpdateResult {
} }
// Reference: https://en.wikipedia.org/wiki/Filename // Reference: https://en.wikipedia.org/wiki/Filename
const INVALID_FILE_CHARS = isWindows ? /[\\/:\*\?"<>\|]/g : /[\\/]/g; const WINDOWS_INVALID_FILE_CHARS = /[\\/:\*\?"<>\|]/g;
const UNIX_INVALID_FILE_CHARS = /[\\/]/g;
const WINDOWS_FORBIDDEN_NAMES = /^(con|prn|aux|clock\$|nul|lpt[0-9]|com[0-9])$/i; const WINDOWS_FORBIDDEN_NAMES = /^(con|prn|aux|clock\$|nul|lpt[0-9]|com[0-9])$/i;
export class RemoteFileDialog { export class RemoteFileDialog {
@ -60,6 +62,7 @@ export class RemoteFileDialog {
private activeItem: FileQuickPickItem; private activeItem: FileQuickPickItem;
private userHome: URI; private userHome: URI;
private badPath: string | undefined; private badPath: string | undefined;
private remoteAgentEnvironment: IRemoteAgentEnvironment | null;
constructor( constructor(
@IFileService private readonly fileService: IFileService, @IFileService private readonly fileService: IFileService,
@ -136,9 +139,16 @@ export class RemoteFileDialog {
return defaultUri ? defaultUri.scheme : (available ? available[0] : Schemas.file); return defaultUri ? defaultUri.scheme : (available ? available[0] : Schemas.file);
} }
private async getRemoteAgentEnvironment(): Promise<IRemoteAgentEnvironment | null> {
if (this.remoteAgentEnvironment === undefined) {
this.remoteAgentEnvironment = await this.remoteAgentService.getEnvironment();
}
return this.remoteAgentEnvironment;
}
private async getUserHome(): Promise<URI> { private async getUserHome(): Promise<URI> {
if (this.scheme !== Schemas.file) { if (this.scheme !== Schemas.file) {
const env = await this.remoteAgentService.getEnvironment(); const env = await this.getRemoteAgentEnvironment();
if (env) { if (env) {
return env.userHome; return env.userHome;
} }
@ -585,7 +595,7 @@ export class RemoteFileDialog {
// Show a yes/no prompt // Show a yes/no prompt
const message = nls.localize('remoteFileDialog.validateExisting', '{0} already exists. Are you sure you want to overwrite it?', resources.basename(uri)); const message = nls.localize('remoteFileDialog.validateExisting', '{0} already exists. Are you sure you want to overwrite it?', resources.basename(uri));
return this.yesNoPrompt(uri, message); return this.yesNoPrompt(uri, message);
} else if (!this.isValidBaseName(resources.basename(uri))) { } else if (!(await this.isValidBaseName(resources.basename(uri)))) {
// Filename not allowed // Filename not allowed
this.filePickBox.validationMessage = nls.localize('remoteFileDialog.validateBadFilename', 'Please enter a valid file name.'); this.filePickBox.validationMessage = nls.localize('remoteFileDialog.validateBadFilename', 'Please enter a valid file name.');
return Promise.resolve(false); return Promise.resolve(false);
@ -664,17 +674,28 @@ export class RemoteFileDialog {
} }
} }
private isValidBaseName(name: string): boolean { private async isWindowsOS(): Promise<boolean> {
let isWindowsOS = isWindows;
const env = await this.getRemoteAgentEnvironment();
if (env) {
isWindowsOS = env.os === OperatingSystem.Windows;
}
return isWindowsOS;
}
private async isValidBaseName(name: string): Promise<boolean> {
if (!name || name.length === 0 || /^\s+$/.test(name)) { if (!name || name.length === 0 || /^\s+$/.test(name)) {
return false; // require a name that is not just whitespace return false; // require a name that is not just whitespace
} }
const isWindowsOS = await this.isWindowsOS();
const INVALID_FILE_CHARS = isWindowsOS ? WINDOWS_INVALID_FILE_CHARS : UNIX_INVALID_FILE_CHARS;
INVALID_FILE_CHARS.lastIndex = 0; // the holy grail of software development INVALID_FILE_CHARS.lastIndex = 0; // the holy grail of software development
if (INVALID_FILE_CHARS.test(name)) { if (INVALID_FILE_CHARS.test(name)) {
return false; // check for certain invalid file characters return false; // check for certain invalid file characters
} }
if (isWindows && WINDOWS_FORBIDDEN_NAMES.test(name)) { if (isWindowsOS && WINDOWS_FORBIDDEN_NAMES.test(name)) {
return false; // check for certain invalid file names return false; // check for certain invalid file names
} }
@ -682,11 +703,11 @@ export class RemoteFileDialog {
return false; // check for reserved values return false; // check for reserved values
} }
if (isWindows && name[name.length - 1] === '.') { if (isWindowsOS && name[name.length - 1] === '.') {
return false; // Windows: file cannot end with a "." return false; // Windows: file cannot end with a "."
} }
if (isWindows && name.length !== name.trim().length) { if (isWindowsOS && name.length !== name.trim().length) {
return false; // Windows: file cannot end with a whitespace return false; // Windows: file cannot end with a whitespace
} }