Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use remote file dialog for database and server properties dialogs #24390

Merged
merged 16 commits into from
Sep 13, 2023
Merged
16 changes: 10 additions & 6 deletions extensions/mssql/src/objectManagement/ui/attachDatabaseDialog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,20 @@ export class AttachDatabaseDialog extends ObjectManagementDialogBase<Database, D
const buttonContainer = this.addButtonsForTable(this._databasesTable, addButton, removeButton);

this._nameField = this.createInputBox(async newValue => {
let selectedRow = this._databasesTable.selectedRows[0];
let dbFile = this._databasesToAttach[selectedRow];
dbFile.databaseName = newValue;
if (this._databasesTable.selectedRows?.length > 0) {
let selectedRow = this._databasesTable.selectedRows[0];
let dbFile = this._databasesToAttach[selectedRow];
dbFile.databaseName = newValue;
}
}, {});
this._nameContainer = this.createLabelInputContainer(loc.AttachAsText, this._nameField);

this._ownerDropdown = this.createDropdown(loc.OwnerText, async newValue => {
let selectedRow = this._databasesTable.selectedRows[0];
let dbFile = this._databasesToAttach[selectedRow];
dbFile.owner = newValue;
if (this._databasesTable.selectedRows?.length > 0) {
let selectedRow = this._databasesTable.selectedRows[0];
let dbFile = this._databasesToAttach[selectedRow];
dbFile.owner = newValue;
}
}, this.viewInfo.loginNames.options, this.viewInfo.loginNames.options[this.viewInfo.loginNames.defaultValueIndex]);
this._ownerContainer = this.createLabelInputContainer(loc.OwnerText, this._ownerDropdown);

Expand Down
5 changes: 3 additions & 2 deletions extensions/mssql/src/objectManagement/ui/databaseDialog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -740,8 +740,9 @@ export class DatabaseDialog extends ObjectManagementDialogBase<Database, Databas
defaultFileGrowthInMb: defaultFileGrowthInMb,
defaultFileGrowthInPercent: defaultFileGrowthInPercent,
defaultMaxFileSizeLimitedToInMb: defaultMaxFileSizeLimitedToInMb
}
});
},
connectionUri: this.options.connectionUri
}, this.objectManagementService);
await dialog.open();
return await dialog.waitForClose();
}
Expand Down
28 changes: 9 additions & 19 deletions extensions/mssql/src/objectManagement/ui/databaseFileDialog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
*--------------------------------------------------------------------------------------------*/

import * as azdata from 'azdata';
import * as vscode from 'vscode';
import * as path from 'path';
import { DefaultInputWidth, DialogBase } from '../../ui/dialogBase';
import * as localizedConstants from '../localizedConstants';
import { DatabaseFile, DatabaseViewInfo, FileGrowthType } from '../interfaces';
import { isUndefinedOrNull } from '../../types';
import { deepClone } from '../../util/objects';
import { IObjectManagementService } from 'mssql';

export interface NewDatabaseFileDialogOptions {
title: string;
Expand All @@ -27,6 +27,7 @@ export interface NewDatabaseFileDialogOptions {
defaultFileGrowthInMb: number,
defaultMaxFileSizeLimitedToInMb: number
};
connectionUri: string;
}

const fileSizeInputMaxValueInMbForDataType = 16776192; // Row type supports up to 16 TB (SSMS allows =~ 15.99TB)
Expand Down Expand Up @@ -58,7 +59,7 @@ export class DatabaseFileDialog extends DialogBase<DatabaseFile> {
private originalFileName: string;
private isEditingFile: boolean;

constructor(private readonly options: NewDatabaseFileDialogOptions) {
constructor(private readonly options: NewDatabaseFileDialogOptions, private readonly objectManagementService: IObjectManagementService) {
super(options.title, 'DatabaseFileDialog');
}

Expand Down Expand Up @@ -292,23 +293,12 @@ export class DatabaseFileDialog extends DialogBase<DatabaseFile> {
* Creates a file browser and sets the path to the filePath
*/
private async createFileBrowser(): Promise<void> {
let fileUris = await vscode.window.showOpenDialog(
{
canSelectFiles: false,
canSelectFolders: true,
canSelectMany: false,
defaultUri: vscode.Uri.file(this.options.databaseFile.path),
openLabel: localizedConstants.SelectText
}
);

if (!fileUris || fileUris.length === 0) {
return;
let dataFolder = await this.objectManagementService.getDataFolder(this.options.connectionUri);
let filePath = await azdata.window.openServerFileBrowserDialog(this.options.connectionUri, dataFolder, [{ label: localizedConstants.allFiles, filters: ['*'] }], true);
if (filePath?.length > 0) {
this.filePathTextBox.value = filePath;
this.result.path = filePath;
}

let fileUri = fileUris[0];
this.filePathTextBox.value = fileUri.fsPath;
this.result.path = fileUri.fsPath;
}

/**
Expand All @@ -328,7 +318,7 @@ export class DatabaseFileDialog extends DialogBase<DatabaseFile> {
if (selectedOption === localizedConstants.LogFiletype) {
fileGroupDdOptions = [localizedConstants.FileGroupForLogTypeText];
fileGroupDdValue = localizedConstants.FileGroupForLogTypeText;
fileSizeInputMaxValue = fileSizeInputMaxValueInMbForLogType
fileSizeInputMaxValue = fileSizeInputMaxValueInMbForLogType;
}
// File Stream
else if (selectedOption === localizedConstants.FilestreamFileType) {
Expand Down
17 changes: 2 additions & 15 deletions extensions/mssql/src/objectManagement/ui/serverPropertiesDialog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -652,21 +652,8 @@ export class ServerPropertiesDialog extends ObjectManagementDialogBase<Server, S
}

public async selectFolder(location: string): Promise<string | undefined> {
const allFilesFilter = localizedConstants.allFiles;
let filter: any = {};
filter[allFilesFilter] = '*';
let uris = await vscode.window.showOpenDialog({
filters: filter,
canSelectFiles: false,
canSelectMany: false,
canSelectFolders: true,
defaultUri: vscode.Uri.file(location),
openLabel: localizedConstants.labelSelectFolder
});
if (uris && uris.length > 0) {
return uris[0].fsPath;
}
return undefined;
let dataFolder = await this.objectManagementService.getDataFolder(this.options.connectionUri);
return await azdata.window.openServerFileBrowserDialog(this.options.connectionUri, dataFolder, [{ label: localizedConstants.allFiles, filters: ['*'] }], true);
}

private initializeAdvancedSection(): void {
Expand Down
2 changes: 1 addition & 1 deletion src/sql/azdata.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2273,7 +2273,7 @@ declare module 'azdata' {
// File browser interfaces -----------------------------------------------------------------------

export interface FileBrowserProvider extends DataProvider {
openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean): Thenable<boolean>;
openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean, showFoldersOnly?: boolean): Thenable<boolean>;
corivera marked this conversation as resolved.
Show resolved Hide resolved
/**
* Registers a handler for FileBrowserOpened events.
*
Expand Down
3 changes: 2 additions & 1 deletion src/sql/azdata.proposed.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2068,9 +2068,10 @@ declare module 'azdata' {
* @param connectionUri The URI of the connection to the target server
* @param targetPath The file path on the server machine to open by default in the dialog
* @param fileFilters The filters used to limit which files are displayed in the file browser
* @param showFoldersOnly Optional argument to specify whether the browser should only show folders
* @returns The path of the file chosen from the dialog, and undefined if the dialog is closed without selecting anything.
*/
export function openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: FileFilters[]): Thenable<string | undefined>;
export function openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: FileFilters[], showFoldersOnly?: boolean): Thenable<string | undefined>;
}

export interface TableComponent {
Expand Down
4 changes: 2 additions & 2 deletions src/sql/workbench/api/browser/mainThreadDataProtocol.ts
Original file line number Diff line number Diff line change
Expand Up @@ -338,8 +338,8 @@ export class MainThreadDataProtocol extends Disposable implements MainThreadData
public $registerFileBrowserProvider(providerId: string, handle: number): Promise<any> {
const self = this;
this._fileBrowserService.registerProvider(providerId, <azdata.FileBrowserProvider>{
openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean): Thenable<boolean> {
return self._proxy.$openFileBrowser(handle, ownerUri, expandPath, fileFilters, changeFilter);
openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean, showFoldersOnly?: boolean): Thenable<boolean> {
return self._proxy.$openFileBrowser(handle, ownerUri, expandPath, fileFilters, changeFilter, showFoldersOnly);
},
expandFolderNode(ownerUri: string, expandPath: string): Thenable<boolean> {
return self._proxy.$expandFolderNode(handle, ownerUri, expandPath);
Expand Down
4 changes: 2 additions & 2 deletions src/sql/workbench/api/browser/mainThreadWindow.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ export class MainThreadWindow extends Disposable implements MainThreadWindowShap
super();
}

public async $openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: azdata.window.FileFilters[]): Promise<string | undefined> {
public async $openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: azdata.window.FileFilters[], showFoldersOnly?: boolean): Promise<string | undefined> {
let completion = new Promise<string | undefined>((resolve, reject) => {
try {
const handleOnClosed = (path: string | undefined) => {
resolve(path);
};
this._fileBrowserDialogService.showDialog(connectionUri, targetPath, fileFilters, '', true, handleOnClosed);
this._fileBrowserDialogService.showDialog(connectionUri, targetPath, fileFilters, '', true, handleOnClosed, showFoldersOnly);
} catch (error) {
reject(error);
}
Expand Down
4 changes: 2 additions & 2 deletions src/sql/workbench/api/common/extHostDataProtocol.ts
Original file line number Diff line number Diff line change
Expand Up @@ -632,8 +632,8 @@ export class ExtHostDataProtocol extends ExtHostDataProtocolShape {
/**
* Open a file browser
*/
public override $openFileBrowser(handle: number, ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean): Thenable<boolean> {
return this._resolveProvider<azdata.FileBrowserProvider>(handle).openFileBrowser(ownerUri, expandPath, fileFilters, changeFilter);
public override $openFileBrowser(handle: number, ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean, showFoldersOnly?: boolean): Thenable<boolean> {
return this._resolveProvider<azdata.FileBrowserProvider>(handle).openFileBrowser(ownerUri, expandPath, fileFilters, changeFilter, showFoldersOnly);
}

/**
Expand Down
4 changes: 2 additions & 2 deletions src/sql/workbench/api/common/extHostWindow.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export class ExtHostWindow implements ExtHostWindowShape {
this._proxy = _mainContext.getProxy(SqlMainContext.MainThreadWindow);
}

$openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: azdata.window.FileFilters[]): Promise<string | undefined> {
return this._proxy.$openServerFileBrowserDialog(connectionUri, targetPath, fileFilters);
$openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: azdata.window.FileFilters[], showFoldersOnly?: boolean): Promise<string | undefined> {
return this._proxy.$openServerFileBrowserDialog(connectionUri, targetPath, fileFilters, showFoldersOnly);
}
}
4 changes: 2 additions & 2 deletions src/sql/workbench/api/common/sqlExtHost.api.impl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -488,8 +488,8 @@ export function createAdsApiFactory(accessor: ServicesAccessor): IAdsExtensionAp
openCustomErrorDialog(options: sqlExtHostTypes.IErrorDialogOptions): Thenable<string | undefined> {
return extHostModelViewDialog.openCustomErrorDialog(options);
},
openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: azdata.window.FileFilters[]): Thenable<string | undefined> {
return extHostWindow.$openServerFileBrowserDialog(connectionUri, targetPath, fileFilters);
openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: azdata.window.FileFilters[], showFoldersOnly?: boolean): Thenable<string | undefined> {
return extHostWindow.$openServerFileBrowserDialog(connectionUri, targetPath, fileFilters, showFoldersOnly);
}
};

Expand Down
6 changes: 3 additions & 3 deletions src/sql/workbench/api/common/sqlExtHost.protocol.ts
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ export abstract class ExtHostDataProtocolShape {
/**
* Open a file browser
*/
$openFileBrowser(handle: number, ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean): Thenable<boolean> { throw ni(); }
$openFileBrowser(handle: number, ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean, showFoldersOnly?: boolean): Thenable<boolean> { throw ni(); }


/**
Expand Down Expand Up @@ -833,7 +833,7 @@ export interface ExtHostWorkspaceShape {
}

export interface ExtHostWindowShape {
$openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: azdata.window.FileFilters[]): Promise<string | undefined>;
$openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: azdata.window.FileFilters[], showFoldersOnly?: boolean): Promise<string | undefined>;
}

export interface MainThreadWorkspaceShape {
Expand All @@ -843,7 +843,7 @@ export interface MainThreadWorkspaceShape {
}

export interface MainThreadWindowShape {
$openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: azdata.window.FileFilters[]): Promise<string | undefined>;
$openServerFileBrowserDialog(connectionUri: string, targetPath: string, fileFilters: azdata.window.FileFilters[], showFoldersOnly?: boolean): Promise<string | undefined>;
}

export interface MainThreadBackgroundTaskManagementShape extends IDisposable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ export class FileBrowserDialog extends Modal {
private _body: HTMLElement;
private _filePathInputBox: InputBox;
private _fileFilterSelectBox: SelectBox;
private _fileFilterRow: HTMLElement;
private _originalFilterDisplay: string;
private _okButton: Button;
private _onOk = new Emitter<string>();
public onOk: Event<string> = this._onOk.event;
Expand Down Expand Up @@ -99,6 +101,8 @@ export class FileBrowserDialog extends Modal {
this._fileFilterSelectBox.setAriaLabel(filterLabel);
let filterBuilder = DialogHelper.appendRow(tableContainer, filterLabel, 'file-input-label', 'file-input-box');
DialogHelper.appendInputSelectBox(filterBuilder, this._fileFilterSelectBox);
this._fileFilterRow = tableContainer.childNodes[1] as HTMLElement;
this._originalFilterDisplay = this._fileFilterRow.style.display;

this._okButton = this.addFooterButton(localize('fileBrowser.ok', "OK"), () => this.ok());
this._okButton.enabled = false;
Expand All @@ -112,10 +116,17 @@ export class FileBrowserDialog extends Modal {
expandPath: string,
fileFilters: [{ label: string, filters: string[] }],
fileValidationServiceType: string,
showFoldersOnly?: boolean
): void {
this._viewModel.initialize(ownerUri, expandPath, fileFilters, fileValidationServiceType);
this._viewModel.initialize(ownerUri, expandPath, fileFilters, fileValidationServiceType, showFoldersOnly);
this._viewModel.openFileBrowser(0, false).catch(err => onUnexpectedError(err));
this._fileFilterSelectBox.setOptions(this._viewModel.formattedFileFilters, 0);
if (showFoldersOnly) {
this._fileFilterSelectBox.setOptions([]);
this._fileFilterRow.style.display = 'none';
} else {
this._fileFilterSelectBox.setOptions(this._viewModel.formattedFileFilters, 0);
this._fileFilterRow.style.display = this._originalFilterDisplay;
}
this._filePathInputBox.value = expandPath;
this._isFolderSelected = true;
this.enableOkButton();
Expand All @@ -129,7 +140,7 @@ export class FileBrowserDialog extends Modal {

/* enter key */
protected override onAccept() {
if (this._okButton.enabled === true) {
if (this._okButton.enabled) {
this.ok();
}
}
Expand All @@ -140,7 +151,7 @@ export class FileBrowserDialog extends Modal {
}

private enableOkButton() {
if (strings.isFalsyOrWhitespace(this._selectedFilePath) || this._isFolderSelected === true) {
if (strings.isFalsyOrWhitespace(this._selectedFilePath) || (this._isFolderSelected && !this._viewModel.showFoldersOnly)) {
this._okButton.enabled = false;
} else {
this._okButton.enabled = true;
Expand Down Expand Up @@ -215,9 +226,11 @@ export class FileBrowserDialog extends Modal {
}

private registerListeners(): void {
this._register(this._fileFilterSelectBox.onDidSelect(selectData => {
this.onFilterSelectChanged(selectData.index).catch(err => onUnexpectedError(err));
}));
if (this._fileFilterSelectBox) {
this._register(this._fileFilterSelectBox.onDidSelect(selectData => {
this.onFilterSelectChanged(selectData.index).catch(err => onUnexpectedError(err));
}));
}
this._register(this._filePathInputBox.onDidChange(e => {
this.onFilePathChange(e);
}));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ export class FileBrowserDialogController implements IFileBrowserDialogController
fileFilters: [{ label: string, filters: string[] }],
fileValidationServiceType: string,
isWide: boolean,
handleOnClosed: (path: string | undefined) => void
handleOnClosed: (path: string | undefined) => void,
showFoldersOnly?: boolean
): void {
if (!this._fileBrowserDialog) {
this._fileBrowserDialog = this._instantiationService.createInstance(FileBrowserDialog, localize('filebrowser.selectFile', "Select a file"));
Expand All @@ -44,6 +45,6 @@ export class FileBrowserDialogController implements IFileBrowserDialogController
this._fileBrowserDialog = undefined;
});

this._fileBrowserDialog.open(ownerUri, expandPath, fileFilters, fileValidationServiceType);
this._fileBrowserDialog.open(ownerUri, expandPath, fileFilters, fileValidationServiceType, showFoldersOnly);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@
padding-left: 12px;
padding-right: 12px;
box-sizing: border-box;
display: flex;
flex-flow: column;
}

.file-browser-dialog .tree-view {
height: calc(100% - 90px);
flex: 1 1 auto;
}

.file-table-content {
Expand All @@ -21,8 +23,8 @@

.file-browser-dialog .option-section {
padding-top: 10px;
height: 90px;
box-sizing: border-box;
flex: 0 1 auto;
}

.file-input-label {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ export interface IFileBrowserDialogController {
fileFilters: { label: string, filters: string[] }[],
fileValidationServiceType: string,
isWide: boolean,
handleOnOk: (path: string | undefined) => void): void;
handleOnOk: (path: string | undefined) => void,
showFoldersOnly?: boolean): void;
}
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ export class FileBrowserService implements IFileBrowserService {
return this._onPathValidate.event;
}

public openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean): Promise<boolean> {
public openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean, showFoldersOnly?: boolean): Promise<boolean> {
return new Promise<boolean>((resolve, reject) => {
const provider = this.getProvider(ownerUri);
if (provider) {
provider.openFileBrowser(ownerUri, expandPath, fileFilters, changeFilter).then(result => {
provider.openFileBrowser(ownerUri, expandPath, fileFilters, changeFilter, showFoldersOnly).then(result => {
resolve(result);
}, error => {
reject(error);
Expand Down
Loading