tunnelView.ts 46.9 KB
Newer Older
A
Alex Ross 已提交
1 2 3 4 5 6 7 8
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import 'vs/css!./media/tunnelView';
import * as nls from 'vs/nls';
import * as dom from 'vs/base/browser/dom';
9
import { IViewDescriptor, IEditableData, IViewsService, IViewDescriptorService } from 'vs/workbench/common/views';
10
import { WorkbenchAsyncDataTree } from 'vs/platform/list/browser/listService';
A
Alex Ross 已提交
11
import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
12
import { IContextMenuService, IContextViewService } from 'vs/platform/contextview/browser/contextView';
A
Alex Ross 已提交
13 14 15 16
import { IContextKeyService, IContextKey, RawContextKey, ContextKeyExpr } from 'vs/platform/contextkey/common/contextkey';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { IOpenerService } from 'vs/platform/opener/common/opener';
A
Alex Ross 已提交
17
import { IQuickInputService, IQuickPickItem, QuickPickInput } from 'vs/platform/quickinput/common/quickInput';
A
Alex Ross 已提交
18 19 20
import { ICommandService, ICommandHandler, CommandsRegistry } from 'vs/platform/commands/common/commands';
import { Event, Emitter } from 'vs/base/common/event';
import { IListVirtualDelegate } from 'vs/base/browser/ui/list/list';
21
import { ITreeRenderer, ITreeNode, IAsyncDataSource, ITreeContextMenuEvent, ITreeMouseEvent } from 'vs/base/browser/ui/tree/tree';
A
Alex Ross 已提交
22
import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/common/environmentService';
23
import { Disposable, IDisposable, toDisposable, MutableDisposable, dispose, DisposableStore } from 'vs/base/common/lifecycle';
24
import { ActionBar } from 'vs/base/browser/ui/actionbar/actionbar';
A
Alex Ross 已提交
25
import { IconLabel } from 'vs/base/browser/ui/iconLabel/iconLabel';
J
João Moreno 已提交
26
import { ActionRunner, IAction } from 'vs/base/common/actions';
27 28
import { IMenuService, MenuId, IMenu, MenuRegistry, MenuItemAction, ILocalizedString, SubmenuItemAction } from 'vs/platform/actions/common/actions';
import { createAndFillInContextMenuActions, createAndFillInActionBarActions, MenuEntryActionViewItem, SubmenuEntryActionViewItem } from 'vs/platform/actions/browser/menuEntryActionViewItem';
A
Alex Ross 已提交
29
import { IRemoteExplorerService, TunnelModel, makeAddress, TunnelType, ITunnelItem, Tunnel, mapHasAddressLocalhostOrAllInterfaces, TUNNEL_VIEW_ID, parseAddress } from 'vs/workbench/services/remote/common/remoteExplorerService';
A
Alex Ross 已提交
30
import { IClipboardService } from 'vs/platform/clipboard/common/clipboardService';
31
import { INotificationService, Severity } from 'vs/platform/notification/common/notification';
32 33 34
import { InputBox, MessageType } from 'vs/base/browser/ui/inputbox/inputBox';
import { attachInputBoxStyler } from 'vs/platform/theme/common/styler';
import { once } from 'vs/base/common/functional';
35
import { KeyCode, KeyMod } from 'vs/base/common/keyCodes';
36 37
import { IThemeService } from 'vs/platform/theme/common/themeService';
import { IKeyboardEvent } from 'vs/base/browser/keyboardEvent';
S
SteVen Batten 已提交
38
import { ViewPane, IViewPaneOptions } from 'vs/workbench/browser/parts/views/viewPaneContainer';
A
Alex Ross 已提交
39
import { URI } from 'vs/base/common/uri';
A
Alex Ross 已提交
40
import { RemoteTunnel } from 'vs/platform/remote/common/tunnel';
S
Sandeep Somavarapu 已提交
41
import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors';
42
import { KeybindingsRegistry, KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry';
43
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
44
import { ActionViewItem } from 'vs/base/browser/ui/actionbar/actionViewItems';
45
import { Codicon } from 'vs/base/common/codicons';
A
Alex Ross 已提交
46 47

export const forwardedPortsViewEnabled = new RawContextKey<boolean>('forwardedPortsViewEnabled', false);
48
export const PORT_AUTO_FORWARD_SETTING = 'remote.autoForwardPorts';
A
Alex Ross 已提交
49 50 51 52 53 54 55 56 57 58 59 60 61 62

class TunnelTreeVirtualDelegate implements IListVirtualDelegate<ITunnelItem> {
	getHeight(element: ITunnelItem): number {
		return 22;
	}

	getTemplateId(element: ITunnelItem): string {
		return 'tunnelItemTemplate';
	}
}

export interface ITunnelViewModel {
	onForwardedPortsChanged: Event<void>;
	readonly forwarded: TunnelItem[];
A
Alex Ross 已提交
63
	readonly detected: TunnelItem[];
64
	readonly candidates: TunnelItem[];
65
	readonly input: TunnelItem;
A
Alex Ross 已提交
66
	groupsAndForwarded(): Promise<ITunnelGroup[]>;
A
Alex Ross 已提交
67 68 69 70 71 72
}

export class TunnelViewModel extends Disposable implements ITunnelViewModel {
	private _onForwardedPortsChanged: Emitter<void> = new Emitter();
	public onForwardedPortsChanged: Event<void> = this._onForwardedPortsChanged.event;
	private model: TunnelModel;
73
	private _input: TunnelItem;
74
	private _candidates: Map<string, { host: string, port: number, detail: string }> = new Map();
A
Alex Ross 已提交
75 76

	constructor(
77 78
		@IRemoteExplorerService private readonly remoteExplorerService: IRemoteExplorerService,
		@IConfigurationService private readonly configurationService: IConfigurationService) {
A
Alex Ross 已提交
79 80 81 82 83
		super();
		this.model = remoteExplorerService.tunnelModel;
		this._register(this.model.onForwardPort(() => this._onForwardedPortsChanged.fire()));
		this._register(this.model.onClosePort(() => this._onForwardedPortsChanged.fire()));
		this._register(this.model.onPortName(() => this._onForwardedPortsChanged.fire()));
84
		this._register(this.model.onCandidatesChanged(() => this._onForwardedPortsChanged.fire()));
85 86 87 88 89
		this._input = {
			label: nls.localize('remote.tunnelsView.add', "Forward a Port..."),
			tunnelType: TunnelType.Add,
			remoteHost: 'localhost',
			remotePort: 0,
90 91
			description: '',
			iconClasses: undefined
92
		};
A
Alex Ross 已提交
93 94
	}

A
Alex Ross 已提交
95 96
	async groupsAndForwarded(): Promise<ITunnelGroup[]> {
		const groups: (ITunnelGroup | TunnelItem)[] = [];
97 98
		this._candidates = new Map();
		(await this.model.candidates).forEach(candidate => {
A
Alex Ross 已提交
99
			this._candidates.set(makeAddress(candidate.host, candidate.port), candidate);
100
		});
101
		if ((this.model.forwarded.size > 0) || this.remoteExplorerService.getEditableData(undefined)) {
A
Alex Ross 已提交
102
			groups.push(...this.forwarded);
A
Alex Ross 已提交
103
		}
A
Alex Ross 已提交
104
		if (this.model.detected.size > 0) {
A
Alex Ross 已提交
105
			groups.push({
106
				label: nls.localize('remote.tunnelsView.detected', "Existing Tunnels"),
A
Alex Ross 已提交
107 108
				tunnelType: TunnelType.Detected,
				items: this.detected
A
Alex Ross 已提交
109 110
			});
		}
111 112 113 114 115 116 117 118 119
		if (!this.configurationService.getValue(PORT_AUTO_FORWARD_SETTING)) {
			const candidates = await this.candidates;
			if (candidates.length > 0) {
				groups.push({
					label: nls.localize('remote.tunnelsView.candidates', "Not Forwarded"),
					tunnelType: TunnelType.Candidate,
					items: candidates
				});
			}
A
Alex Ross 已提交
120
		}
121 122
		if (groups.length === 0) {
			groups.push(this._input);
123
		}
A
Alex Ross 已提交
124 125 126
		return groups;
	}

127
	private addProcessInfoFromCandidate(tunnelItem: ITunnelItem) {
A
Alex Ross 已提交
128
		const key = makeAddress(tunnelItem.remoteHost, tunnelItem.remotePort);
129 130 131 132 133
		if (this._candidates.has(key)) {
			tunnelItem.description = this._candidates.get(key)!.detail;
		}
	}

A
Alex Ross 已提交
134
	get forwarded(): TunnelItem[] {
135
		const forwarded = Array.from(this.model.forwarded.values()).map(tunnel => {
136 137 138
			const tunnelItem = TunnelItem.createFromTunnel(tunnel);
			this.addProcessInfoFromCandidate(tunnelItem);
			return tunnelItem;
A
Alex Ross 已提交
139 140 141 142 143 144
		}).sort((a: TunnelItem, b: TunnelItem) => {
			if (a.remotePort === b.remotePort) {
				return a.remoteHost < b.remoteHost ? -1 : 1;
			} else {
				return a.remotePort < b.remotePort ? -1 : 1;
			}
A
Alex Ross 已提交
145
		});
146 147 148 149
		if (this.remoteExplorerService.getEditableData(undefined)) {
			forwarded.push(this._input);
		}
		return forwarded;
A
Alex Ross 已提交
150 151
	}

A
Alex Ross 已提交
152 153
	get detected(): TunnelItem[] {
		return Array.from(this.model.detected.values()).map(tunnel => {
154 155 156
			const tunnelItem = TunnelItem.createFromTunnel(tunnel, TunnelType.Detected, false);
			this.addProcessInfoFromCandidate(tunnelItem);
			return tunnelItem;
A
Alex Ross 已提交
157 158 159
		});
	}

160 161 162
	get candidates(): TunnelItem[] {
		const candidates: TunnelItem[] = [];
		this._candidates.forEach(value => {
A
Alex Ross 已提交
163 164
			if (!mapHasAddressLocalhostOrAllInterfaces(this.model.forwarded, value.host, value.port) &&
				!mapHasAddressLocalhostOrAllInterfaces(this.model.detected, value.host, value.port)) {
165
				candidates.push(new TunnelItem(TunnelType.Candidate, value.host, value.port, undefined, undefined, false, undefined, value.detail));
166
			}
A
Alex Ross 已提交
167
		});
168
		return candidates;
A
Alex Ross 已提交
169 170
	}

171
	get input(): TunnelItem {
172 173 174
		return this._input;
	}

A
Alex Ross 已提交
175 176 177 178 179 180 181 182 183
	dispose() {
		super.dispose();
	}
}

interface ITunnelTemplateData {
	elementDisposable: IDisposable;
	container: HTMLElement;
	iconLabel: IconLabel;
184
	icon: HTMLElement;
A
Alex Ross 已提交
185 186 187 188 189 190 191
	actionBar: ActionBar;
}

class TunnelTreeRenderer extends Disposable implements ITreeRenderer<ITunnelGroup | ITunnelItem, ITunnelItem, ITunnelTemplateData> {
	static readonly ITEM_HEIGHT = 22;
	static readonly TREE_TEMPLATE_ID = 'tunnelItemTemplate';

A
Alex Ross 已提交
192
	private inputDone?: (success: boolean, finishEditing: boolean) => void;
A
Alex Ross 已提交
193 194 195 196 197 198
	private _actionRunner: ActionRunner | undefined;

	constructor(
		private readonly viewId: string,
		@IMenuService private readonly menuService: IMenuService,
		@IContextKeyService private readonly contextKeyService: IContextKeyService,
199 200 201 202
		@IInstantiationService private readonly instantiationService: IInstantiationService,
		@IContextViewService private readonly contextViewService: IContextViewService,
		@IThemeService private readonly themeService: IThemeService,
		@IRemoteExplorerService private readonly remoteExplorerService: IRemoteExplorerService
A
Alex Ross 已提交
203 204 205 206 207 208 209 210 211 212 213 214 215
	) {
		super();
	}

	set actionRunner(actionRunner: ActionRunner) {
		this._actionRunner = actionRunner;
	}

	get templateId(): string {
		return TunnelTreeRenderer.TREE_TEMPLATE_ID;
	}

	renderTemplate(container: HTMLElement): ITunnelTemplateData {
216
		container.classList.add('custom-view-tree-node-item');
217
		const icon = dom.append(container, dom.$('.custom-view-tree-node-item-icon'));
A
Alex Ross 已提交
218 219 220 221 222 223
		const iconLabel = new IconLabel(container, { supportHighlights: true });
		// dom.addClass(iconLabel.element, 'tunnel-view-label');
		const actionsContainer = dom.append(iconLabel.element, dom.$('.actions'));
		const actionBar = new ActionBar(actionsContainer, {
			actionViewItemProvider: (action: IAction) => {
				if (action instanceof MenuItemAction) {
224
					return this.instantiationService.createInstance(MenuEntryActionViewItem, action);
225 226
				} else if (action instanceof SubmenuItemAction) {
					return this.instantiationService.createInstance(SubmenuEntryActionViewItem, action);
A
Alex Ross 已提交
227 228 229 230 231 232
				}

				return undefined;
			}
		});

233
		return { icon, iconLabel, actionBar, container, elementDisposable: Disposable.None };
A
Alex Ross 已提交
234 235 236
	}

	private isTunnelItem(item: ITunnelGroup | ITunnelItem): item is ITunnelItem {
237
		return !!((<ITunnelItem>item).remotePort);
A
Alex Ross 已提交
238 239 240 241 242
	}

	renderElement(element: ITreeNode<ITunnelGroup | ITunnelItem, ITunnelGroup | ITunnelItem>, index: number, templateData: ITunnelTemplateData): void {
		templateData.elementDisposable.dispose();
		const node = element.element;
243

A
Alex Ross 已提交
244 245
		// reset
		templateData.actionBar.clear();
246 247 248
		templateData.icon.className = 'custom-view-tree-node-item-icon';
		templateData.icon.hidden = true;

A
Alex Ross 已提交
249
		let editableData: IEditableData | undefined;
A
Alex Ross 已提交
250
		if (this.isTunnelItem(node)) {
251
			editableData = this.remoteExplorerService.getEditableData(node);
252 253
			if (editableData) {
				templateData.iconLabel.element.style.display = 'none';
A
Alex Ross 已提交
254
				this.renderInputBox(templateData.container, editableData);
255 256 257
			} else {
				templateData.iconLabel.element.style.display = 'flex';
				this.renderTunnel(node, templateData);
A
Alex Ross 已提交
258
			}
259
		} else if ((node.tunnelType === TunnelType.Add) && (editableData = this.remoteExplorerService.getEditableData(undefined))) {
A
Alex Ross 已提交
260 261
			templateData.iconLabel.element.style.display = 'none';
			this.renderInputBox(templateData.container, editableData);
A
Alex Ross 已提交
262
		} else {
A
Alex Ross 已提交
263
			templateData.iconLabel.element.style.display = 'flex';
A
Alex Ross 已提交
264 265 266 267
			templateData.iconLabel.setLabel(node.label);
		}
	}

268
	private renderTunnel(node: ITunnelItem, templateData: ITunnelTemplateData) {
269 270
		const label = node.label + (node.description ? (' - ' + node.description) : '');
		templateData.iconLabel.setLabel(node.label, node.description, { title: label, extraClasses: ['tunnel-view-label'] });
271

272
		templateData.actionBar.context = node;
273
		const contextKeyService = this._register(this.contextKeyService.createScoped());
274 275 276
		contextKeyService.createKey('view', this.viewId);
		contextKeyService.createKey('tunnelType', node.tunnelType);
		contextKeyService.createKey('tunnelCloseable', node.closeable);
277 278 279
		const disposableStore = new DisposableStore();
		templateData.elementDisposable = disposableStore;
		const menu = disposableStore.add(this.menuService.createMenu(MenuId.TunnelInline, contextKeyService));
280
		const actions: IAction[] = [];
281
		disposableStore.add(createAndFillInActionBarActions(menu, { shouldForwardArgs: true }, actions));
282 283 284 285 286 287
		if (actions) {
			templateData.actionBar.push(actions, { icon: true, label: false });
			if (this._actionRunner) {
				templateData.actionBar.actionRunner = this._actionRunner;
			}
		}
288 289 290 291 292 293 294
		if (node.iconClasses) {
			templateData.icon.className = `custom-view-tree-node-item-icon ${node.iconClasses}`;
			templateData.icon.hidden = false;
		} else {
			templateData.icon.className = 'custom-view-tree-node-item-icon';
			templateData.icon.hidden = true;
		}
295 296
	}

A
Alex Ross 已提交
297
	private renderInputBox(container: HTMLElement, editableData: IEditableData): IDisposable {
A
Alex Ross 已提交
298 299 300 301 302
		// Required for FireFox. The blur event doesn't fire on FireFox when you just mash the "+" button to forward a port.
		if (this.inputDone) {
			this.inputDone(false, false);
			this.inputDone = undefined;
		}
303 304 305 306 307
		const value = editableData.startingValue || '';
		const inputBox = new InputBox(container, this.contextViewService, {
			ariaLabel: nls.localize('remote.tunnelsView.input', "Press Enter to confirm or Escape to cancel."),
			validationOptions: {
				validation: (value) => {
308 309
					const message = editableData.validationMessage(value);
					if (!message || message.severity !== Severity.Error) {
310 311 312 313
						return null;
					}

					return {
314
						content: message.content,
315 316 317 318 319 320 321 322 323 324 325
						formatContent: true,
						type: MessageType.ERROR
					};
				}
			},
			placeholder: editableData.placeholder || ''
		});
		const styler = attachInputBoxStyler(inputBox, this.themeService);

		inputBox.value = value;
		inputBox.focus();
326
		inputBox.select({ start: 0, end: editableData.startingValue ? editableData.startingValue.length : 0 });
327 328

		const done = once((success: boolean, finishEditing: boolean) => {
A
Alex Ross 已提交
329 330 331
			if (this.inputDone) {
				this.inputDone = undefined;
			}
332
			inputBox.element.style.display = 'none';
A
Alex Ross 已提交
333
			const inputValue = inputBox.value;
334 335
			dispose(toDispose);
			if (finishEditing) {
A
Alex Ross 已提交
336
				editableData.onFinish(inputValue, success);
337 338
			}
		});
A
Alex Ross 已提交
339
		this.inputDone = done;
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362

		const toDispose = [
			inputBox,
			dom.addStandardDisposableListener(inputBox.inputElement, dom.EventType.KEY_DOWN, (e: IKeyboardEvent) => {
				if (e.equals(KeyCode.Enter)) {
					if (inputBox.validate()) {
						done(true, true);
					}
				} else if (e.equals(KeyCode.Escape)) {
					done(false, true);
				}
			}),
			dom.addDisposableListener(inputBox.inputElement, dom.EventType.BLUR, () => {
				done(inputBox.isInputValid(), true);
			}),
			styler
		];

		return toDisposable(() => {
			done(false, false);
		});
	}

A
Alex Ross 已提交
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
	disposeElement(resource: ITreeNode<ITunnelGroup | ITunnelItem, ITunnelGroup | ITunnelItem>, index: number, templateData: ITunnelTemplateData): void {
		templateData.elementDisposable.dispose();
	}

	disposeTemplate(templateData: ITunnelTemplateData): void {
		templateData.actionBar.dispose();
		templateData.elementDisposable.dispose();
	}
}

class TunnelDataSource implements IAsyncDataSource<ITunnelViewModel, ITunnelItem | ITunnelGroup> {
	hasChildren(element: ITunnelViewModel | ITunnelItem | ITunnelGroup) {
		if (element instanceof TunnelViewModel) {
			return true;
		} else if (element instanceof TunnelItem) {
			return false;
		} else if ((<ITunnelGroup>element).items) {
			return true;
		}
		return false;
	}

385
	async getChildren(element: ITunnelViewModel | ITunnelItem | ITunnelGroup) {
A
Alex Ross 已提交
386
		if (element instanceof TunnelViewModel) {
A
Alex Ross 已提交
387
			return element.groupsAndForwarded();
A
Alex Ross 已提交
388 389 390 391 392 393 394 395 396 397 398 399
		} else if (element instanceof TunnelItem) {
			return [];
		} else if ((<ITunnelGroup>element).items) {
			return (<ITunnelGroup>element).items!;
		}
		return [];
	}
}

interface ITunnelGroup {
	tunnelType: TunnelType;
	label: string;
A
Alex Ross 已提交
400
	items?: ITunnelItem[] | Promise<ITunnelItem[]>;
A
Alex Ross 已提交
401 402 403
}

class TunnelItem implements ITunnelItem {
A
Alex Ross 已提交
404
	static createFromTunnel(tunnel: Tunnel, type: TunnelType = TunnelType.Forwarded, closeable?: boolean) {
405
		return new TunnelItem(type, tunnel.remoteHost, tunnel.remotePort, tunnel.localAddress, tunnel.localPort, closeable === undefined ? tunnel.closeable : closeable, tunnel.name, tunnel.description ?? tunnel.runningProcess, tunnel.source);
A
Alex Ross 已提交
406 407
	}

A
Alex Ross 已提交
408 409
	constructor(
		public tunnelType: TunnelType,
410 411
		public remoteHost: string,
		public remotePort: number,
A
Alex Ross 已提交
412
		public localAddress?: string,
413
		public localPort?: number,
A
Alex Ross 已提交
414 415 416
		public closeable?: boolean,
		public name?: string,
		private _description?: string,
417
		private source?: string
A
Alex Ross 已提交
418 419
	) { }
	get label(): string {
A
Alex Ross 已提交
420
		if (this.name) {
A
Alex Ross 已提交
421
			return nls.localize('remote.tunnelsView.forwardedPortLabel0', "{0}", this.name);
A
Alex Ross 已提交
422
		} else if (this.localAddress) {
A
Alex Ross 已提交
423
			return nls.localize('remote.tunnelsView.forwardedPortLabel1', "{0} \u2192 {1}", this.remotePort, TunnelItem.compactLongAddress(this.localAddress));
A
Alex Ross 已提交
424
		} else {
A
Alex Ross 已提交
425
			return nls.localize('remote.tunnelsView.forwardedPortLabel2', "{0}", this.remotePort);
A
Alex Ross 已提交
426 427 428
		}
	}

A
Alex Ross 已提交
429
	private static compactLongAddress(address: string): string {
430
		if (address.length < 16) {
A
Alex Ross 已提交
431 432
			return address;
		}
433
		let displayAddress: string = address;
434
		try {
435
			if (!address.startsWith('http')) {
A
Alex Ross 已提交
436
				address = `http://${address}`;
437 438 439 440 441 442 443 444 445
			}
			const url = new URL(address);
			if (url && url.host) {
				const lastDotIndex = url.host.lastIndexOf('.');
				const secondLastDotIndex = lastDotIndex !== -1 ? url.host.substring(0, lastDotIndex).lastIndexOf('.') : -1;
				if (secondLastDotIndex !== -1) {
					displayAddress = `${url.protocol}//...${url.host.substring(secondLastDotIndex + 1)}`;
				}
			}
446 447 448
		} catch (e) {
			// Address isn't a valid url and can't be compacted.
		}
449
		return displayAddress;
A
Alex Ross 已提交
450 451
	}

452 453 454 455
	set description(description: string | undefined) {
		this._description = description;
	}

A
Alex Ross 已提交
456
	get description(): string | undefined {
457 458 459 460 461 462
		const description: string[] = [];

		if (this.name && this.localAddress) {
			description.push(nls.localize('remote.tunnelsView.forwardedPortDescription0', "{0} \u2192 {1}", this.remotePort, TunnelItem.compactLongAddress(this.localAddress)));
		}

A
Alex Ross 已提交
463
		if (this._description) {
464 465 466 467 468 469 470 471 472
			description.push(this._description);
		}

		if (this.source) {
			description.push(this.source);
		}

		if (description.length > 0) {
			return description.join('  \u2022  ');
A
Alex Ross 已提交
473
		}
474

A
Alex Ross 已提交
475
		return undefined;
A
Alex Ross 已提交
476
	}
477 478 479 480

	get iconClasses(): string | undefined {
		return this.tunnelType === TunnelType.Detected || this.tunnelType === TunnelType.Forwarded ? Codicon.plug.classNames : undefined;
	}
A
Alex Ross 已提交
481 482 483 484
}

export const TunnelTypeContextKey = new RawContextKey<TunnelType>('tunnelType', TunnelType.Add);
export const TunnelCloseableContextKey = new RawContextKey<boolean>('tunnelCloseable', false);
485 486 487
const TunnelViewFocusContextKey = new RawContextKey<boolean>('tunnelViewFocus', false);
const TunnelViewSelectionKeyName = 'tunnelViewSelection';
const TunnelViewSelectionContextKey = new RawContextKey<ITunnelItem | undefined>(TunnelViewSelectionKeyName, undefined);
488
const PortChangableContextKey = new RawContextKey<boolean>('portChangable', false);
A
Alex Ross 已提交
489

M
Matt Bierner 已提交
490 491
class TunnelDataTree extends WorkbenchAsyncDataTree<any, any, any> { }

S
SteVen Batten 已提交
492
export class TunnelPanel extends ViewPane {
A
Alex Ross 已提交
493
	static readonly ID = TUNNEL_VIEW_ID;
A
Alex Ross 已提交
494
	static readonly TITLE = nls.localize('remote.tunnel', "Ports");
M
Matt Bierner 已提交
495
	private tree!: TunnelDataTree;
A
Alex Ross 已提交
496 497
	private tunnelTypeContext: IContextKey<TunnelType>;
	private tunnelCloseableContext: IContextKey<boolean>;
498 499
	private tunnelViewFocusContext: IContextKey<boolean>;
	private tunnelViewSelectionContext: IContextKey<ITunnelItem | undefined>;
500
	private portChangableContextKey: IContextKey<boolean>;
A
Alex Ross 已提交
501
	private isEditing: boolean = false;
A
Alex Ross 已提交
502 503 504 505 506
	private titleActions: IAction[] = [];
	private readonly titleActionsDisposable = this._register(new MutableDisposable());

	constructor(
		protected viewModel: ITunnelViewModel,
S
SteVen Batten 已提交
507
		options: IViewPaneOptions,
A
Alex Ross 已提交
508 509 510 511 512
		@IKeybindingService protected keybindingService: IKeybindingService,
		@IContextMenuService protected contextMenuService: IContextMenuService,
		@IContextKeyService protected contextKeyService: IContextKeyService,
		@IConfigurationService protected configurationService: IConfigurationService,
		@IInstantiationService protected readonly instantiationService: IInstantiationService,
513
		@IViewDescriptorService viewDescriptorService: IViewDescriptorService,
514
		@IOpenerService openerService: IOpenerService,
A
Alex Ross 已提交
515 516 517
		@IQuickInputService protected quickInputService: IQuickInputService,
		@ICommandService protected commandService: ICommandService,
		@IMenuService private readonly menuService: IMenuService,
518
		@IContextViewService private readonly contextViewService: IContextViewService,
519
		@IThemeService themeService: IThemeService,
520 521
		@IRemoteExplorerService private readonly remoteExplorerService: IRemoteExplorerService,
		@ITelemetryService telemetryService: ITelemetryService,
A
Alex Ross 已提交
522
	) {
523
		super(options, keybindingService, contextMenuService, configurationService, contextKeyService, viewDescriptorService, instantiationService, openerService, themeService, telemetryService);
A
Alex Ross 已提交
524 525
		this.tunnelTypeContext = TunnelTypeContextKey.bindTo(contextKeyService);
		this.tunnelCloseableContext = TunnelCloseableContextKey.bindTo(contextKeyService);
526 527
		this.tunnelViewFocusContext = TunnelViewFocusContextKey.bindTo(contextKeyService);
		this.tunnelViewSelectionContext = TunnelViewSelectionContextKey.bindTo(contextKeyService);
528
		this.portChangableContextKey = PortChangableContextKey.bindTo(contextKeyService);
A
Alex Ross 已提交
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548

		const scopedContextKeyService = this._register(this.contextKeyService.createScoped());
		scopedContextKeyService.createKey('view', TunnelPanel.ID);

		const titleMenu = this._register(this.menuService.createMenu(MenuId.TunnelTitle, scopedContextKeyService));
		const updateActions = () => {
			this.titleActions = [];
			this.titleActionsDisposable.value = createAndFillInActionBarActions(titleMenu, undefined, this.titleActions);
			this.updateActions();
		};

		this._register(titleMenu.onDidChange(updateActions));
		updateActions();

		this._register(toDisposable(() => {
			this.titleActions = [];
		}));
	}

	protected renderBody(container: HTMLElement): void {
J
Joao Moreno 已提交
549 550
		super.renderBody(container);

A
Alex Ross 已提交
551 552
		const panelContainer = dom.append(container, dom.$('.tree-explorer-viewlet-tree-view'));
		const treeContainer = dom.append(panelContainer, dom.$('.customview-tree'));
553
		treeContainer.classList.add('ports-view');
554
		treeContainer.classList.add('file-icon-themable-tree', 'show-file-icons');
A
Alex Ross 已提交
555

556
		const renderer = new TunnelTreeRenderer(TunnelPanel.ID, this.menuService, this.contextKeyService, this.instantiationService, this.contextViewService, this.themeService, this.remoteExplorerService);
M
Matt Bierner 已提交
557
		this.tree = this.instantiationService.createInstance(TunnelDataTree,
A
Alex Ross 已提交
558 559 560 561 562 563 564 565 566 567 568 569 570 571
			'RemoteTunnels',
			treeContainer,
			new TunnelTreeVirtualDelegate(),
			[renderer],
			new TunnelDataSource(),
			{
				collapseByDefault: (e: ITunnelItem | ITunnelGroup): boolean => {
					return false;
				},
				keyboardNavigationLabelProvider: {
					getKeyboardNavigationLabel: (item: ITunnelItem | ITunnelGroup) => {
						return item.label;
					}
				},
572 573 574 575 576 577 578 579 580 581 582 583
				multipleSelectionSupport: false,
				accessibilityProvider: {
					getAriaLabel: (item: ITunnelItem | ITunnelGroup) => {
						if (item instanceof TunnelItem) {
							if (item.localAddress) {
								return nls.localize('remote.tunnel.ariaLabelForwarded', "Remote port {0}:{1} forwarded to local address {2}", item.remoteHost, item.remotePort, item.localAddress);
							} else {
								return nls.localize('remote.tunnel.ariaLabelCandidate', "Remote port {0}:{1} not forwarded", item.remoteHost, item.remotePort);
							}
						} else {
							return item.label;
						}
I
isidor 已提交
584 585
					},
					getWidgetAriaLabel: () => nls.localize('tunnelView', "Tunnel View")
J
João Moreno 已提交
586
				}
A
Alex Ross 已提交
587 588 589 590 591 592
			}
		);
		const actionRunner: ActionRunner = new ActionRunner();
		renderer.actionRunner = actionRunner;

		this._register(this.tree.onContextMenu(e => this.onContextMenu(e, actionRunner)));
593
		this._register(this.tree.onMouseDblClick(e => this.onMouseDblClick(e)));
594 595 596
		this._register(this.tree.onDidChangeFocus(e => this.onFocusChanged(e.elements)));
		this._register(this.tree.onDidFocus(() => this.tunnelViewFocusContext.set(true)));
		this._register(this.tree.onDidBlur(() => this.tunnelViewFocusContext.set(false)));
A
Alex Ross 已提交
597 598 599

		this.tree.setInput(this.viewModel);
		this._register(this.viewModel.onForwardedPortsChanged(() => {
A
Alex Ross 已提交
600
			this._onDidChangeViewWelcomeState.fire();
A
Alex Ross 已提交
601 602 603
			this.tree.updateChildren(undefined, true);
		}));

604
		this._register(Event.debounce(this.tree.onDidOpen, (last, event) => event, 75, true)(e => {
605
			if (e.element && (e.element.tunnelType === TunnelType.Add)) {
606
				this.commandService.executeCommand(ForwardPortAction.INLINE_ID);
A
Alex Ross 已提交
607 608
			}
		}));
609 610

		this._register(this.remoteExplorerService.onDidChangeEditable(async e => {
A
Alex Ross 已提交
611 612
			this.isEditing = !!this.remoteExplorerService.getEditableData(e);
			this._onDidChangeViewWelcomeState.fire();
613

A
Alex Ross 已提交
614
			if (!this.isEditing) {
615
				treeContainer.classList.remove('highlight');
616 617 618 619
			}

			await this.tree.updateChildren(undefined, false);

A
Alex Ross 已提交
620
			if (this.isEditing) {
621
				treeContainer.classList.add('highlight');
A
Alex Ross 已提交
622 623 624 625
				if (!e) {
					// When we are in editing mode for a new forward, rather than updating an existing one we need to reveal the input box since it might be out of view.
					this.tree.reveal(this.viewModel.input);
				}
626 627 628 629
			} else {
				this.tree.domFocus();
			}
		}));
A
Alex Ross 已提交
630 631 632
	}

	private get contributedContextMenu(): IMenu {
633
		const contributedContextMenu = this._register(this.menuService.createMenu(MenuId.TunnelContext, this.tree.contextKeyService));
A
Alex Ross 已提交
634 635 636 637 638 639 640
		return contributedContextMenu;
	}

	getActions(): IAction[] {
		return this.titleActions;
	}

A
Alex Ross 已提交
641
	shouldShowWelcome(): boolean {
642 643
		return (this.viewModel.forwarded.length === 0) && (this.viewModel.candidates.length === 0) &&
			(this.viewModel.detected.length === 0) && !this.isEditing;
A
Alex Ross 已提交
644 645
	}

A
Alex Ross 已提交
646 647 648 649 650
	focus(): void {
		super.focus();
		this.tree.domFocus();
	}

651 652 653 654
	private onFocusChanged(elements: ITunnelItem[]) {
		const item = elements && elements.length ? elements[0] : undefined;
		if (item) {
			this.tunnelViewSelectionContext.set(item);
655
			this.tunnelTypeContext.set(item.tunnelType);
656
			this.tunnelCloseableContext.set(!!item.closeable);
657
			this.portChangableContextKey.set(!!item.localPort);
658
		} else {
659
			this.tunnelTypeContext.reset();
660 661
			this.tunnelViewSelectionContext.reset();
			this.tunnelCloseableContext.reset();
662
			this.portChangableContextKey.reset();
663 664 665
		}
	}

A
Alex Ross 已提交
666
	private onContextMenu(treeEvent: ITreeContextMenuEvent<ITunnelItem | ITunnelGroup>, actionRunner: ActionRunner): void {
667
		if ((treeEvent.element !== null) && !(treeEvent.element instanceof TunnelItem)) {
A
Alex Ross 已提交
668 669 670 671 672 673 674 675
			return;
		}
		const node: ITunnelItem | null = treeEvent.element;
		const event: UIEvent = treeEvent.browserEvent;

		event.preventDefault();
		event.stopPropagation();

676 677 678 679
		if (node) {
			this.tree!.setFocus([node]);
			this.tunnelTypeContext.set(node.tunnelType);
			this.tunnelCloseableContext.set(!!node.closeable);
680
			this.portChangableContextKey.set(!!node.localPort);
681 682
		} else {
			this.tunnelTypeContext.set(TunnelType.Add);
683
			this.tunnelCloseableContext.set(false);
684
			this.portChangableContextKey.set(false);
685
		}
A
Alex Ross 已提交
686 687

		const actions: IAction[] = [];
688
		this._register(createAndFillInContextMenuActions(this.contributedContextMenu, { shouldForwardArgs: true }, actions));
A
Alex Ross 已提交
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709

		this.contextMenuService.showContextMenu({
			getAnchor: () => treeEvent.anchor,
			getActions: () => actions,
			getActionViewItem: (action) => {
				const keybinding = this.keybindingService.lookupKeybinding(action.id);
				if (keybinding) {
					return new ActionViewItem(action, action, { label: true, keybinding: keybinding.getLabel() });
				}
				return undefined;
			},
			onHide: (wasCancelled?: boolean) => {
				if (wasCancelled) {
					this.tree!.domFocus();
				}
			},
			getActionsContext: () => node,
			actionRunner
		});
	}

710 711 712 713 714 715
	private onMouseDblClick(e: ITreeMouseEvent<ITunnelGroup | ITunnelItem | null>): void {
		if (!e.element) {
			this.commandService.executeCommand(ForwardPortAction.INLINE_ID);
		}
	}

A
Alex Ross 已提交
716
	protected layoutBody(height: number, width: number): void {
J
João Moreno 已提交
717
		super.layoutBody(height, width);
A
Alex Ross 已提交
718 719 720 721 722 723 724
		this.tree.layout(height, width);
	}
}

export class TunnelPanelDescriptor implements IViewDescriptor {
	readonly id = TunnelPanel.ID;
	readonly name = TunnelPanel.TITLE;
S
Sandeep Somavarapu 已提交
725
	readonly ctorDescriptor: SyncDescriptor<TunnelPanel>;
A
Alex Ross 已提交
726 727 728 729 730
	readonly canToggleVisibility = true;
	readonly hideByDefault = false;
	readonly workspace = true;
	readonly group = 'details@0';
	readonly remoteAuthority?: string | string[];
A
Alex Ross 已提交
731
	readonly canMoveView = true;
A
Alex Ross 已提交
732 733

	constructor(viewModel: ITunnelViewModel, environmentService: IWorkbenchEnvironmentService) {
S
Sandeep Somavarapu 已提交
734
		this.ctorDescriptor = new SyncDescriptor(TunnelPanel, [viewModel]);
735
		this.remoteAuthority = environmentService.remoteAuthority ? environmentService.remoteAuthority.split('+')[0] : undefined;
A
Alex Ross 已提交
736 737 738
	}
}

J
jeanp413 已提交
739 740 741 742 743 744 745 746 747 748 749
function validationMessage(validationString: string | null): { content: string, severity: Severity } | null {
	if (!validationString) {
		return null;
	}

	return {
		content: validationString,
		severity: Severity.Error
	};
}

750 751 752
namespace LabelTunnelAction {
	export const ID = 'remote.tunnel.label';
	export const LABEL = nls.localize('remote.tunnel.label', "Set Label");
A
Alex Ross 已提交
753 754 755

	export function handler(): ICommandHandler {
		return async (accessor, arg) => {
756 757
			const context = (arg !== undefined || arg instanceof TunnelItem) ? arg : accessor.get(IContextKeyService).getContextKeyValue(TunnelViewSelectionKeyName);
			if (context instanceof TunnelItem) {
A
Alex Ross 已提交
758
				const remoteExplorerService = accessor.get(IRemoteExplorerService);
759
				remoteExplorerService.setEditable(context, {
760
					onFinish: async (value, success) => {
761
						if (success) {
762
							remoteExplorerService.tunnelModel.name(context.remoteHost, context.remotePort, value);
763
						}
764
						remoteExplorerService.setEditable(context, null);
765 766
					},
					validationMessage: () => null,
767
					placeholder: nls.localize('remote.tunnelsView.labelPlaceholder', "Port label"),
768
					startingValue: context.name
769
				});
A
Alex Ross 已提交
770 771 772 773 774 775
			}
			return;
		};
	}
}

776 777 778
const invalidPortString: string = nls.localize('remote.tunnelsView.portNumberValid', "Forwarded port is invalid.");
const maxPortNumber: number = 65536;
const invalidPortNumberString: string = nls.localize('remote.tunnelsView.portNumberToHigh', "Port number must be \u2265 0 and < {0}.", maxPortNumber);
779

A
Alex Ross 已提交
780
export namespace ForwardPortAction {
781 782
	export const INLINE_ID = 'remote.tunnel.forwardInline';
	export const COMMANDPALETTE_ID = 'remote.tunnel.forwardCommandPalette';
783
	export const LABEL: ILocalizedString = { value: nls.localize('remote.tunnel.forward', "Forward a Port"), original: 'Forward a Port' };
784
	export const TREEITEM_LABEL = nls.localize('remote.tunnel.forwardItem', "Forward Port");
A
Alex Ross 已提交
785
	const forwardPrompt = nls.localize('remote.tunnel.forwardPrompt', "Port number or address (eg. 3000 or 10.10.10.10:2000).");
A
Alex Ross 已提交
786

A
Alex Ross 已提交
787
	function validateInput(value: string): string | null {
A
Alex Ross 已提交
788
		const parsed = parseAddress(value);
789
		if (!parsed) {
790
			return invalidPortString;
791 792
		} else if (parsed.port >= maxPortNumber) {
			return invalidPortNumberString;
A
Alex Ross 已提交
793 794 795 796
		}
		return null;
	}

A
Alex Ross 已提交
797 798
	function error(notificationService: INotificationService, tunnel: RemoteTunnel | void, host: string, port: number) {
		if (!tunnel) {
799
			notificationService.warn(nls.localize('remote.tunnel.forwardError', "Unable to forward {0}:{1}. The host may not be available or that remote port may already be forwarded", host, port));
A
Alex Ross 已提交
800 801 802
		}
	}

803
	export function inlineHandler(): ICommandHandler {
A
Alex Ross 已提交
804 805
		return async (accessor, arg) => {
			const remoteExplorerService = accessor.get(IRemoteExplorerService);
A
Alex Ross 已提交
806
			const notificationService = accessor.get(INotificationService);
A
Alex Ross 已提交
807
			if (arg instanceof TunnelItem) {
A
Alex Ross 已提交
808
				remoteExplorerService.forward({ host: arg.remoteHost, port: arg.remotePort }).then(tunnel => error(notificationService, tunnel, arg.remoteHost, arg.remotePort));
809 810
			} else {
				remoteExplorerService.setEditable(undefined, {
811
					onFinish: async (value, success) => {
812
						let parsed: { host: string, port: number } | undefined;
A
Alex Ross 已提交
813
						if (success && (parsed = parseAddress(value))) {
A
Alex Ross 已提交
814
							remoteExplorerService.forward({ host: parsed.host, port: parsed.port }).then(tunnel => error(notificationService, tunnel, parsed!.host, parsed!.port));
A
Alex Ross 已提交
815
						}
816
						remoteExplorerService.setEditable(undefined, null);
A
Alex Ross 已提交
817
					},
J
jeanp413 已提交
818
					validationMessage: (value) => validationMessage(validateInput(value)),
A
Alex Ross 已提交
819
					placeholder: forwardPrompt
A
Alex Ross 已提交
820
				});
821 822 823 824 825 826 827
			}
		};
	}

	export function commandPaletteHandler(): ICommandHandler {
		return async (accessor, arg) => {
			const remoteExplorerService = accessor.get(IRemoteExplorerService);
A
Alex Ross 已提交
828
			const notificationService = accessor.get(INotificationService);
829 830 831 832 833 834 835 836
			const viewsService = accessor.get(IViewsService);
			const quickInputService = accessor.get(IQuickInputService);
			await viewsService.openView(TunnelPanel.ID, true);
			const value = await quickInputService.input({
				prompt: forwardPrompt,
				validateInput: (value) => Promise.resolve(validateInput(value))
			});
			let parsed: { host: string, port: number } | undefined;
A
Alex Ross 已提交
837
			if (value && (parsed = parseAddress(value))) {
A
Alex Ross 已提交
838
				remoteExplorerService.forward({ host: parsed.host, port: parsed.port }).then(tunnel => error(notificationService, tunnel, parsed!.host, parsed!.port));
A
Alex Ross 已提交
839 840 841 842 843
			}
		};
	}
}

A
Alex Ross 已提交
844
interface QuickPickTunnel extends IQuickPickItem {
A
Alex Ross 已提交
845
	tunnel?: ITunnelItem
A
Alex Ross 已提交
846 847
}

A
Alex Ross 已提交
848 849 850 851 852 853 854 855
function makeTunnelPicks(tunnels: Tunnel[]): QuickPickInput<QuickPickTunnel>[] {
	const picks: QuickPickInput<QuickPickTunnel>[] = tunnels.map(forwarded => {
		const item = TunnelItem.createFromTunnel(forwarded);
		return {
			label: item.label,
			description: item.description,
			tunnel: item
		};
A
Alex Ross 已提交
856 857 858
	});
	if (picks.length === 0) {
		picks.push({
859
			label: nls.localize('remote.tunnel.closeNoPorts', "No ports currently forwarded. Try running the {0} command", ForwardPortAction.LABEL.value)
A
Alex Ross 已提交
860 861 862 863 864
		});
	}
	return picks;
}

A
Alex Ross 已提交
865
namespace ClosePortAction {
A
Alex Ross 已提交
866 867
	export const INLINE_ID = 'remote.tunnel.closeInline';
	export const COMMANDPALETTE_ID = 'remote.tunnel.closeCommandPalette';
868
	export const LABEL: ILocalizedString = { value: nls.localize('remote.tunnel.close', "Stop Forwarding Port"), original: 'Stop Forwarding Port' };
A
Alex Ross 已提交
869

A
Alex Ross 已提交
870
	export function inlineHandler(): ICommandHandler {
A
Alex Ross 已提交
871
		return async (accessor, arg) => {
872
			const context = (arg !== undefined || arg instanceof TunnelItem) ? arg : accessor.get(IContextKeyService).getContextKeyValue(TunnelViewSelectionKeyName);
873
			if (context instanceof TunnelItem) {
A
Alex Ross 已提交
874
				const remoteExplorerService = accessor.get(IRemoteExplorerService);
875
				await remoteExplorerService.close({ host: context.remoteHost, port: context.remotePort });
A
Alex Ross 已提交
876 877 878
			}
		};
	}
A
Alex Ross 已提交
879 880 881 882 883 884 885

	export function commandPaletteHandler(): ICommandHandler {
		return async (accessor) => {
			const quickInputService = accessor.get(IQuickInputService);
			const remoteExplorerService = accessor.get(IRemoteExplorerService);
			const commandService = accessor.get(ICommandService);

A
Alex Ross 已提交
886
			const picks: QuickPickInput<QuickPickTunnel>[] = makeTunnelPicks(Array.from(remoteExplorerService.tunnelModel.forwarded.values()).filter(tunnel => tunnel.closeable));
A
Alex Ross 已提交
887 888 889 890 891 892 893 894
			const result = await quickInputService.pick(picks, { placeHolder: nls.localize('remote.tunnel.closePlaceholder', "Choose a port to stop forwarding") });
			if (result && result.tunnel) {
				await remoteExplorerService.close({ host: result.tunnel.remoteHost, port: result.tunnel.remotePort });
			} else if (result) {
				await commandService.executeCommand(ForwardPortAction.COMMANDPALETTE_ID);
			}
		};
	}
A
Alex Ross 已提交
895 896
}

897
export namespace OpenPortInBrowserAction {
A
Alex Ross 已提交
898 899 900 901 902
	export const ID = 'remote.tunnel.open';
	export const LABEL = nls.localize('remote.tunnel.open', "Open in Browser");

	export function handler(): ICommandHandler {
		return async (accessor, arg) => {
A
Alex Ross 已提交
903
			let key: string | undefined;
A
Alex Ross 已提交
904
			if (arg instanceof TunnelItem) {
A
Alex Ross 已提交
905 906 907 908 909
				key = makeAddress(arg.remoteHost, arg.remotePort);
			} else if (arg.tunnelRemoteHost && arg.tunnelRemotePort) {
				key = makeAddress(arg.tunnelRemoteHost, arg.tunnelRemotePort);
			}
			if (key) {
A
Alex Ross 已提交
910 911
				const model = accessor.get(IRemoteExplorerService).tunnelModel;
				const openerService = accessor.get(IOpenerService);
912
				return run(model, openerService, key);
A
Alex Ross 已提交
913 914 915
			}
		};
	}
916 917 918 919 920

	export function run(model: TunnelModel, openerService: IOpenerService, key: string) {
		const tunnel = model.forwarded.get(key) || model.detected.get(key);
		let address: string | undefined;
		if (tunnel && tunnel.localAddress && (address = model.address(tunnel.remoteHost, tunnel.remotePort))) {
921
			if (!address.startsWith('http')) {
A
Alex Ross 已提交
922
				address = `http://${address}`;
923 924
			}
			return openerService.open(URI.parse(address));
925 926 927
		}
		return Promise.resolve();
	}
A
Alex Ross 已提交
928 929
}

A
Alex Ross 已提交
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
namespace OpenPortInBrowserCommandPaletteAction {
	export const ID = 'remote.tunnel.openCommandPalette';
	export const LABEL = nls.localize('remote.tunnel.openCommandPalette', "Open Port in Browser");

	interface QuickPickTunnel extends IQuickPickItem {
		tunnel?: TunnelItem;
	}

	export function handler(): ICommandHandler {
		return async (accessor, arg) => {
			const model = accessor.get(IRemoteExplorerService).tunnelModel;
			const quickPickService = accessor.get(IQuickInputService);
			const openerService = accessor.get(IOpenerService);
			const commandService = accessor.get(ICommandService);
			const options: QuickPickTunnel[] = [...model.forwarded, ...model.detected].map(value => {
				const tunnelItem = TunnelItem.createFromTunnel(value[1]);
				return {
					label: tunnelItem.label,
					description: tunnelItem.description,
					tunnel: tunnelItem
				};
			});
			if (options.length === 0) {
				options.push({
954 955 956 957 958
					label: nls.localize('remote.tunnel.openCommandPaletteNone', "No ports currently forwarded. Open the Ports view to get started.")
				});
			} else {
				options.push({
					label: nls.localize('remote.tunnel.openCommandPaletteView', "Open the Ports view...")
A
Alex Ross 已提交
959 960 961 962 963 964 965 966 967 968 969 970
				});
			}
			const picked = await quickPickService.pick<QuickPickTunnel>(options, { placeHolder: nls.localize('remote.tunnel.openCommandPalettePick', "Choose the port to open") });
			if (picked && picked.tunnel) {
				return OpenPortInBrowserAction.run(model, openerService, makeAddress(picked.tunnel.remoteHost, picked.tunnel.remotePort));
			} else if (picked) {
				return commandService.executeCommand(`${TUNNEL_VIEW_ID}.focus`);
			}
		};
	}
}

A
Alex Ross 已提交
971
namespace CopyAddressAction {
A
Alex Ross 已提交
972 973 974 975 976 977 978 979 980 981 982
	export const INLINE_ID = 'remote.tunnel.copyAddressInline';
	export const COMMANDPALETTE_ID = 'remote.tunnel.copyAddressCommandPalette';
	export const INLINE_LABEL = nls.localize('remote.tunnel.copyAddressInline', "Copy Address");
	export const COMMANDPALETTE_LABEL = nls.localize('remote.tunnel.copyAddressCommandPalette', "Copy Forwarded Port Address");

	async function copyAddress(remoteExplorerService: IRemoteExplorerService, clipboardService: IClipboardService, tunnelItem: ITunnelItem) {
		const address = remoteExplorerService.tunnelModel.address(tunnelItem.remoteHost, tunnelItem.remotePort);
		if (address) {
			await clipboardService.writeText(address.toString());
		}
	}
A
Alex Ross 已提交
983

A
Alex Ross 已提交
984
	export function inlineHandler(): ICommandHandler {
A
Alex Ross 已提交
985
		return async (accessor, arg) => {
986 987 988
			const context = (arg !== undefined || arg instanceof TunnelItem) ? arg : accessor.get(IContextKeyService).getContextKeyValue(TunnelViewSelectionKeyName);
			if (context instanceof TunnelItem) {
				return copyAddress(accessor.get(IRemoteExplorerService), accessor.get(IClipboardService), context);
A
Alex Ross 已提交
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
			}
		};
	}

	export function commandPaletteHandler(): ICommandHandler {
		return async (accessor, arg) => {
			const quickInputService = accessor.get(IQuickInputService);
			const remoteExplorerService = accessor.get(IRemoteExplorerService);
			const commandService = accessor.get(ICommandService);
			const clipboardService = accessor.get(IClipboardService);

			const tunnels = Array.from(remoteExplorerService.tunnelModel.forwarded.values()).concat(Array.from(remoteExplorerService.tunnelModel.detected.values()));
			const result = await quickInputService.pick(makeTunnelPicks(tunnels), { placeHolder: nls.localize('remote.tunnel.copyAddressPlaceholdter', "Choose a forwarded port") });
			if (result && result.tunnel) {
				await copyAddress(remoteExplorerService, clipboardService, result.tunnel);
			} else if (result) {
				await commandService.executeCommand(ForwardPortAction.COMMANDPALETTE_ID);
A
Alex Ross 已提交
1006 1007 1008 1009 1010
			}
		};
	}
}

1011 1012 1013 1014 1015 1016 1017
namespace ChangeLocalPortAction {
	export const ID = 'remote.tunnel.changeLocalPort';
	export const LABEL = nls.localize('remote.tunnel.changeLocalPort', "Change Local Port");

	function validateInput(value: string): string | null {
		if (!value.match(/^[0-9]+$/)) {
			return invalidPortString;
1018 1019
		} else if (Number(value) >= maxPortNumber) {
			return invalidPortNumberString;
1020 1021 1022 1023 1024 1025 1026
		}
		return null;
	}

	export function handler(): ICommandHandler {
		return async (accessor, arg) => {
			const remoteExplorerService = accessor.get(IRemoteExplorerService);
1027
			const notificationService = accessor.get(INotificationService);
1028 1029 1030 1031 1032 1033 1034
			const context = (arg !== undefined || arg instanceof TunnelItem) ? arg : accessor.get(IContextKeyService).getContextKeyValue(TunnelViewSelectionKeyName);
			if (context instanceof TunnelItem) {
				remoteExplorerService.setEditable(context, {
					onFinish: async (value, success) => {
						remoteExplorerService.setEditable(context, null);
						if (success) {
							await remoteExplorerService.close({ host: context.remoteHost, port: context.remotePort });
1035
							const numberValue = Number(value);
1036
							const newForward = await remoteExplorerService.forward({ host: context.remoteHost, port: context.remotePort }, numberValue, context.name);
1037
							if (newForward && newForward.tunnelLocalPort !== numberValue) {
1038
								notificationService.warn(nls.localize('remote.tunnel.changeLocalPortNumber', "The local port {0} is not available. Port number {1} has been used instead", value, newForward.tunnelLocalPort ?? newForward.localAddress));
1039
							}
1040 1041
						}
					},
J
jeanp413 已提交
1042
					validationMessage: (value) => validationMessage(validateInput(value)),
1043 1044 1045 1046 1047 1048 1049
					placeholder: nls.localize('remote.tunnelsView.changePort', "New local port")
				});
			}
		};
	}
}

1050 1051
const tunnelViewCommandsWeightBonus = 10; // give our commands a little bit more weight over other default list/tree commands

1052 1053
KeybindingsRegistry.registerCommandAndKeybindingRule({
	id: LabelTunnelAction.ID,
1054
	weight: KeybindingWeight.WorkbenchContrib + tunnelViewCommandsWeightBonus,
1055 1056 1057 1058 1059 1060 1061
	when: ContextKeyExpr.and(TunnelViewFocusContextKey, TunnelTypeContextKey.isEqualTo(TunnelType.Forwarded)),
	primary: KeyCode.F2,
	mac: {
		primary: KeyCode.Enter
	},
	handler: LabelTunnelAction.handler()
});
1062 1063
CommandsRegistry.registerCommand(ForwardPortAction.INLINE_ID, ForwardPortAction.inlineHandler());
CommandsRegistry.registerCommand(ForwardPortAction.COMMANDPALETTE_ID, ForwardPortAction.commandPaletteHandler());
1064 1065
KeybindingsRegistry.registerCommandAndKeybindingRule({
	id: ClosePortAction.INLINE_ID,
1066
	weight: KeybindingWeight.WorkbenchContrib + tunnelViewCommandsWeightBonus,
1067 1068 1069 1070 1071 1072 1073 1074
	when: ContextKeyExpr.and(TunnelCloseableContextKey, TunnelViewFocusContextKey),
	primary: KeyCode.Delete,
	mac: {
		primary: KeyMod.CtrlCmd | KeyCode.Backspace
	},
	handler: ClosePortAction.inlineHandler()
});

A
Alex Ross 已提交
1075
CommandsRegistry.registerCommand(ClosePortAction.COMMANDPALETTE_ID, ClosePortAction.commandPaletteHandler());
A
Alex Ross 已提交
1076
CommandsRegistry.registerCommand(OpenPortInBrowserAction.ID, OpenPortInBrowserAction.handler());
A
Alex Ross 已提交
1077
CommandsRegistry.registerCommand(OpenPortInBrowserCommandPaletteAction.ID, OpenPortInBrowserCommandPaletteAction.handler());
1078 1079
KeybindingsRegistry.registerCommandAndKeybindingRule({
	id: CopyAddressAction.INLINE_ID,
1080
	weight: KeybindingWeight.WorkbenchContrib + tunnelViewCommandsWeightBonus,
1081 1082 1083 1084
	when: ContextKeyExpr.or(ContextKeyExpr.and(TunnelViewFocusContextKey, TunnelTypeContextKey.isEqualTo(TunnelType.Forwarded)), ContextKeyExpr.and(TunnelViewFocusContextKey, TunnelTypeContextKey.isEqualTo(TunnelType.Detected))),
	primary: KeyMod.CtrlCmd | KeyCode.KEY_C,
	handler: CopyAddressAction.inlineHandler()
});
A
Alex Ross 已提交
1085
CommandsRegistry.registerCommand(CopyAddressAction.COMMANDPALETTE_ID, CopyAddressAction.commandPaletteHandler());
1086
CommandsRegistry.registerCommand(ChangeLocalPortAction.ID, ChangeLocalPortAction.handler());
A
Alex Ross 已提交
1087

A
Alex Ross 已提交
1088 1089 1090 1091 1092 1093 1094
MenuRegistry.appendMenuItem(MenuId.CommandPalette, ({
	command: {
		id: ClosePortAction.COMMANDPALETTE_ID,
		title: ClosePortAction.LABEL
	},
	when: forwardedPortsViewEnabled
}));
1095 1096
MenuRegistry.appendMenuItem(MenuId.CommandPalette, ({
	command: {
1097
		id: ForwardPortAction.COMMANDPALETTE_ID,
1098 1099 1100 1101
		title: ForwardPortAction.LABEL
	},
	when: forwardedPortsViewEnabled
}));
A
Alex Ross 已提交
1102 1103 1104 1105 1106 1107 1108
MenuRegistry.appendMenuItem(MenuId.CommandPalette, ({
	command: {
		id: CopyAddressAction.COMMANDPALETTE_ID,
		title: CopyAddressAction.COMMANDPALETTE_LABEL
	},
	when: forwardedPortsViewEnabled
}));
A
Alex Ross 已提交
1109 1110 1111 1112 1113 1114 1115
MenuRegistry.appendMenuItem(MenuId.CommandPalette, ({
	command: {
		id: OpenPortInBrowserCommandPaletteAction.ID,
		title: OpenPortInBrowserCommandPaletteAction.LABEL
	},
	when: forwardedPortsViewEnabled
}));
A
Alex Ross 已提交
1116 1117 1118 1119
MenuRegistry.appendMenuItem(MenuId.TunnelTitle, ({
	group: 'navigation',
	order: 0,
	command: {
A
Alex Ross 已提交
1120
		id: ForwardPortAction.INLINE_ID,
A
Alex Ross 已提交
1121
		title: ForwardPortAction.LABEL,
1122
		icon: Codicon.plus
A
Alex Ross 已提交
1123 1124 1125 1126 1127 1128
	}
}));
MenuRegistry.appendMenuItem(MenuId.TunnelContext, ({
	group: '0_manage',
	order: 0,
	command: {
A
Alex Ross 已提交
1129 1130
		id: CopyAddressAction.INLINE_ID,
		title: CopyAddressAction.INLINE_LABEL,
A
Alex Ross 已提交
1131
	},
A
Alex Ross 已提交
1132
	when: ContextKeyExpr.or(TunnelTypeContextKey.isEqualTo(TunnelType.Forwarded), TunnelTypeContextKey.isEqualTo(TunnelType.Detected))
A
Alex Ross 已提交
1133 1134 1135 1136 1137 1138 1139 1140
}));
MenuRegistry.appendMenuItem(MenuId.TunnelContext, ({
	group: '0_manage',
	order: 1,
	command: {
		id: OpenPortInBrowserAction.ID,
		title: OpenPortInBrowserAction.LABEL,
	},
A
Alex Ross 已提交
1141
	when: ContextKeyExpr.or(TunnelTypeContextKey.isEqualTo(TunnelType.Forwarded), TunnelTypeContextKey.isEqualTo(TunnelType.Detected))
A
Alex Ross 已提交
1142 1143 1144 1145 1146
}));
MenuRegistry.appendMenuItem(MenuId.TunnelContext, ({
	group: '0_manage',
	order: 2,
	command: {
1147 1148
		id: LabelTunnelAction.ID,
		title: LabelTunnelAction.LABEL,
A
Alex Ross 已提交
1149 1150 1151
	},
	when: TunnelTypeContextKey.isEqualTo(TunnelType.Forwarded)
}));
1152 1153 1154 1155 1156 1157 1158
MenuRegistry.appendMenuItem(MenuId.TunnelContext, ({
	group: '1_manage',
	order: 0,
	command: {
		id: ChangeLocalPortAction.ID,
		title: ChangeLocalPortAction.LABEL,
	},
1159
	when: ContextKeyExpr.and(TunnelTypeContextKey.isEqualTo(TunnelType.Forwarded), PortChangableContextKey)
1160
}));
A
Alex Ross 已提交
1161 1162 1163 1164
MenuRegistry.appendMenuItem(MenuId.TunnelContext, ({
	group: '0_manage',
	order: 1,
	command: {
1165
		id: ForwardPortAction.INLINE_ID,
1166
		title: ForwardPortAction.TREEITEM_LABEL,
A
Alex Ross 已提交
1167
	},
1168
	when: ContextKeyExpr.or(TunnelTypeContextKey.isEqualTo(TunnelType.Candidate), TunnelTypeContextKey.isEqualTo(TunnelType.Add))
A
Alex Ross 已提交
1169 1170
}));
MenuRegistry.appendMenuItem(MenuId.TunnelContext, ({
1171 1172
	group: '1_manage',
	order: 1,
A
Alex Ross 已提交
1173
	command: {
A
Alex Ross 已提交
1174
		id: ClosePortAction.INLINE_ID,
A
Alex Ross 已提交
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
		title: ClosePortAction.LABEL,
	},
	when: TunnelCloseableContextKey
}));

MenuRegistry.appendMenuItem(MenuId.TunnelInline, ({
	order: 0,
	command: {
		id: OpenPortInBrowserAction.ID,
		title: OpenPortInBrowserAction.LABEL,
1185
		icon: Codicon.globe
A
Alex Ross 已提交
1186
	},
A
Alex Ross 已提交
1187
	when: ContextKeyExpr.or(TunnelTypeContextKey.isEqualTo(TunnelType.Forwarded), TunnelTypeContextKey.isEqualTo(TunnelType.Detected))
A
Alex Ross 已提交
1188 1189 1190 1191
}));
MenuRegistry.appendMenuItem(MenuId.TunnelInline, ({
	order: 0,
	command: {
1192
		id: ForwardPortAction.INLINE_ID,
1193
		title: ForwardPortAction.TREEITEM_LABEL,
1194
		icon: Codicon.plus
A
Alex Ross 已提交
1195
	},
A
Alex Ross 已提交
1196
	when: TunnelTypeContextKey.isEqualTo(TunnelType.Candidate)
A
Alex Ross 已提交
1197 1198 1199 1200
}));
MenuRegistry.appendMenuItem(MenuId.TunnelInline, ({
	order: 2,
	command: {
A
Alex Ross 已提交
1201
		id: ClosePortAction.INLINE_ID,
A
Alex Ross 已提交
1202
		title: ClosePortAction.LABEL,
1203
		icon: Codicon.x
A
Alex Ross 已提交
1204 1205 1206
	},
	when: TunnelCloseableContextKey
}));