Implement files.dialog.homePath setting (fix microsoft#115730) (microsoft#182908)

* Implement `workbench.fileDialog.homePath` setting (fix microsoft#115730)

* Make it work with TestResolver remote

* Rename setting to `files.dialog.homePath`

* Add `preferredHome` to `IFileDialogService` so SimpleFileDialog can use it

* Improve setting description following feedback from @alexr00

* Ignore home override when doing ~ replacement

* Stop preferredHome falling back to user-local setting when working remote

* Eliminate preferredHome hack

Author: gjsjohnmurray

src/vs/platform/dialogs/common/dialogs.ts

@@ -546,6 +546,13 @@ export interface IFileDialogService {
 	 */
 	pickFileToSave(defaultUri: URI, availableFileSystems?: string[]): Promise<URI | undefined>;
 
+	/**
+	 * The preferred folder path to open the dialog at.
+	 * @param schemeFilter The scheme of the file path. If no filter given, the scheme of the current window is used.
+	 * Falls back to user home in the absence of a setting.
+	 */
+	preferredHome(schemeFilter?: string): Promise<URI>;
+
 	/**
 	 * Shows a save file dialog and returns the chosen file URI.
 	 */

src/vs/workbench/contrib/files/browser/files.contribution.ts

@@ -323,6 +323,11 @@ configurationRegistry.registerConfiguration({
 			'default': 'askUser',
 			'scope': ConfigurationScope.LANGUAGE_OVERRIDABLE
 		},
+		'files.dialog.homePath': {
+			'type': 'string',
+			'description': nls.localize('fileDialogHomePath', "Default path for file dialogs, overriding user's home path. Only used in the absence of a context-specific path, such as most recently opened file or folder."),
+			'scope': ConfigurationScope.MACHINE
+		},
 		'files.simpleDialog.enable': {
 			'type': 'boolean',
 			'description': nls.localize('files.simpleDialog.enable', "Enables the simple file dialog for opening and saving files and folders. The simple file dialog replaces the system file dialog when enabled."),

src/vs/workbench/services/dialogs/browser/abstractFileDialogService.ts

@@ -69,7 +69,7 @@ export abstract class AbstractFileDialogService implements IFileDialogService {
 		}
 
 		if (!candidate) {
-			candidate = await this.pathService.userHome({ preferLocal: schemeFilter === Schemas.file });
+			candidate = await this.preferredHome(schemeFilter);
 		}
 
 		return candidate;
@@ -86,12 +86,25 @@ export abstract class AbstractFileDialogService implements IFileDialogService {
 		}
 
 		if (!candidate) {
-			return this.pathService.userHome({ preferLocal: schemeFilter === Schemas.file });
+			return this.preferredHome(schemeFilter);
 		}
 
 		return resources.dirname(candidate);
 	}
 
+	async preferredHome(schemeFilter = this.getSchemeFilterForWindow()): Promise<URI> {
+		// Seek a user-local or user-remote machine-scoped override path string depending on whether caller wants a local or a remote home
+		const inspectedValue = this.configurationService.inspect<string>('files.dialog.homePath');
+		const dialogHomePath = schemeFilter === Schemas.file ? inspectedValue.userLocalValue : inspectedValue.userRemoteValue;
+		const userHomePromise = this.pathService.userHome({ preferLocal: schemeFilter === Schemas.file });
+		if (!dialogHomePath) {
+			return userHomePromise;
+		}
+
+		const resource = await this.pathService.fileURI(dialogHomePath);
+		return resources.toLocalResource(resource, this.environmentService.remoteAuthority, this.pathService.defaultUriScheme);
+	}
+
 	async defaultWorkspacePath(schemeFilter = this.getSchemeFilterForWindow()): Promise<URI> {
 		let defaultWorkspacePath: URI | undefined;
 

src/vs/workbench/services/dialogs/browser/simpleFileDialog.ts

@@ -121,6 +121,7 @@ export class SimpleFileDialog implements ISimpleFileDialog {
 	private autoCompletePathSegment: string = '';
 	private activeItem: FileQuickPickItem | undefined;
 	private userHome!: URI;
+	private trueHome!: URI;
 	private isWindows: boolean = false;
 	private badPath: string | undefined;
 	private remoteAgentEnvironment: IRemoteAgentEnvironment | null | undefined;
@@ -167,6 +168,7 @@ export class SimpleFileDialog implements ISimpleFileDialog {
 	public async showOpenDialog(options: IOpenDialogOptions = {}): Promise<URI | undefined> {
 		this.scheme = this.getScheme(options.availableFileSystems, options.defaultUri);
 		this.userHome = await this.getUserHome();
+		this.trueHome = await this.getUserHome(true);
 		const newOptions = this.getOptions(options);
 		if (!newOptions) {
 			return Promise.resolve(undefined);
@@ -178,6 +180,7 @@ export class SimpleFileDialog implements ISimpleFileDialog {
 	public async showSaveDialog(options: ISaveDialogOptions): Promise<URI | undefined> {
 		this.scheme = this.getScheme(options.availableFileSystems, options.defaultUri);
 		this.userHome = await this.getUserHome();
+		this.trueHome = await this.getUserHome(true);
 		this.requiresTrailing = true;
 		const newOptions = this.getOptions(options, true);
 		if (!newOptions) {
@@ -248,8 +251,10 @@ export class SimpleFileDialog implements ISimpleFileDialog {
 		return this.remoteAgentEnvironment;
 	}
 
-	protected getUserHome(): Promise<URI> {
-		return this.pathService.userHome({ preferLocal: this.scheme === Schemas.file });
+	protected getUserHome(trueHome = false): Promise<URI> {
+		return trueHome
+			? this.pathService.userHome({ preferLocal: this.scheme === Schemas.file })
+			: this.fileDialogService.preferredHome(this.scheme);
 	}
 
 	private async pickResource(isSave: boolean = false): Promise<URI | undefined> {
@@ -552,7 +557,7 @@ export class SimpleFileDialog implements ISimpleFileDialog {
 	}
 
 	private tildaReplace(value: string): URI {
-		const home = this.userHome;
+		const home = this.trueHome;
 		if ((value.length > 0) && (value[0] === '~')) {
 			return resources.joinPath(home, value.substring(1));
 		}

src/vs/workbench/test/browser/workbenchTestServices.ts

@@ -561,6 +561,7 @@ export class TestFileDialogService implements IFileDialogService {
 	async defaultFilePath(_schemeFilter?: string): Promise<URI> { return this.pathService.userHome(); }
 	async defaultFolderPath(_schemeFilter?: string): Promise<URI> { return this.pathService.userHome(); }
 	async defaultWorkspacePath(_schemeFilter?: string): Promise<URI> { return this.pathService.userHome(); }
+	async preferredHome(_schemeFilter?: string): Promise<URI> { return this.pathService.userHome(); }
 	pickFileFolderAndOpen(_options: IPickAndOpenOptions): Promise<any> { return Promise.resolve(0); }
 	pickFileAndOpen(_options: IPickAndOpenOptions): Promise<any> { return Promise.resolve(0); }
 	pickFolderAndOpen(_options: IPickAndOpenOptions): Promise<any> { return Promise.resolve(0); }