/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ 'use strict'; import * as vscode from 'vscode'; import * as cp from 'child_process'; import * as os from 'os'; import * as platform from 'vs/base/common/platform'; import * as terminalEnvironment from 'vs/workbench/parts/terminal/node/terminalEnvironment'; import Uri from 'vs/base/common/uri'; import { Event, Emitter } from 'vs/base/common/event'; import { ExtHostTerminalServiceShape, MainContext, MainThreadTerminalServiceShape, IMainContext, ShellLaunchConfigDto } from 'vs/workbench/api/node/extHost.protocol'; import { IMessageFromTerminalProcess } from 'vs/workbench/parts/terminal/node/terminal'; import { ExtHostConfiguration } from 'vs/workbench/api/node/extHostConfiguration'; import { ILogService } from 'vs/platform/log/common/log'; import { EXT_HOST_CREATION_DELAY } from 'vs/workbench/parts/terminal/common/terminal'; const RENDERER_NO_PROCESS_ID = -1; export class BaseExtHostTerminal { public _id: number; protected _idPromise: Promise; private _idPromiseComplete: (value: number) => any; private _disposed: boolean = false; private _queuedRequests: ApiRequest[] = []; constructor( protected _proxy: MainThreadTerminalServiceShape, id?: number ) { this._idPromise = new Promise(c => { if (id !== undefined) { this._id = id; c(id); } else { this._idPromiseComplete = c; } }); } public dispose(): void { if (!this._disposed) { this._disposed = true; this._queueApiRequest(this._proxy.$dispose, []); } } protected _checkDisposed() { if (this._disposed) { throw new Error('Terminal has already been disposed'); } } protected _queueApiRequest(callback: (...args: any[]) => void, args: any[]): void { const request: ApiRequest = new ApiRequest(callback, args); if (!this._id) { this._queuedRequests.push(request); return; } request.run(this._proxy, this._id); } public _runQueuedRequests(id: number): void { this._id = id; this._idPromiseComplete(id); this._queuedRequests.forEach((r) => { r.run(this._proxy, this._id); }); this._queuedRequests.length = 0; } } export class ExtHostTerminal extends BaseExtHostTerminal implements vscode.Terminal { private _pidPromise: Promise; private _pidPromiseComplete: (value: number) => any; private readonly _onData: Emitter = new Emitter(); public get onDidWriteData(): Event { // Tell the main side to start sending data if it's not already this._proxy.$registerOnDataListener(this._id); return this._onData && this._onData.event; } constructor( proxy: MainThreadTerminalServiceShape, private _name: string, id?: number, pid?: number ) { super(proxy, id); this._pidPromise = new Promise(c => { if (pid === RENDERER_NO_PROCESS_ID) { c(undefined); } else { this._pidPromiseComplete = c; } }); } public create( shellPath?: string, shellArgs?: string[], cwd?: string, env?: { [key: string]: string }, waitOnExit?: boolean ): void { this._proxy.$createTerminal(this._name, shellPath, shellArgs, cwd, env, waitOnExit).then((id) => { this._runQueuedRequests(id); }); } public get name(): string { return this._name; } public get processId(): Thenable { return this._pidPromise; } public sendText(text: string, addNewLine: boolean = true): void { this._checkDisposed(); this._queueApiRequest(this._proxy.$sendText, [text, addNewLine]); } public show(preserveFocus: boolean): void { this._checkDisposed(); this._queueApiRequest(this._proxy.$show, [preserveFocus]); } public hide(): void { this._checkDisposed(); this._queueApiRequest(this._proxy.$hide, []); } public _setProcessId(processId: number): void { // The event may fire 2 times when the panel is restored if (this._pidPromiseComplete) { this._pidPromiseComplete(processId); this._pidPromiseComplete = null; } } public _fireOnData(data: string): void { this._onData.fire(data); } } export class ExtHostTerminalRenderer extends BaseExtHostTerminal implements vscode.TerminalRenderer { public get name(): string { return this._name; } public set name(newName: string) { this._name = newName; this._checkDisposed(); this._queueApiRequest(this._proxy.$terminalRendererSetName, [this._name]); } private readonly _onInput: Emitter = new Emitter(); public get onDidAcceptInput(): Event { this._checkDisposed(); this._queueApiRequest(this._proxy.$terminalRendererRegisterOnInputListener, [this._id]); // Tell the main side to start sending data if it's not already // this._proxy.$terminalRendererRegisterOnDataListener(this._id); return this._onInput && this._onInput.event; } private _dimensions: vscode.TerminalDimensions | undefined; public get dimensions(): vscode.TerminalDimensions { return this._dimensions; } public set dimensions(dimensions: vscode.TerminalDimensions) { this._checkDisposed(); this._dimensions = dimensions; this._queueApiRequest(this._proxy.$terminalRendererSetDimensions, [dimensions]); } private _maximumDimensions: vscode.TerminalDimensions; public get maximumDimensions(): vscode.TerminalDimensions { if (!this._maximumDimensions) { return undefined; } return { rows: this._maximumDimensions.rows, columns: this._maximumDimensions.columns }; } private readonly _onDidChangeMaximumDimensions: Emitter = new Emitter(); public get onDidChangeMaximumDimensions(): Event { return this._onDidChangeMaximumDimensions && this._onDidChangeMaximumDimensions.event; } public get terminal(): ExtHostTerminal { return this._terminal; } constructor( proxy: MainThreadTerminalServiceShape, private _name: string, private _terminal: ExtHostTerminal ) { super(proxy); this._proxy.$createTerminalRenderer(this._name).then(id => { this._runQueuedRequests(id); (this._terminal)._runQueuedRequests(id); }); } public write(data: string): void { this._checkDisposed(); this._queueApiRequest(this._proxy.$terminalRendererWrite, [data]); } public _fireOnInput(data: string): void { this._onInput.fire(data); } public _setMaximumDimensions(columns: number, rows: number): void { this._maximumDimensions = { columns, rows }; this._onDidChangeMaximumDimensions.fire(this.maximumDimensions); } } export class ExtHostTerminalService implements ExtHostTerminalServiceShape { private _proxy: MainThreadTerminalServiceShape; private _activeTerminal: ExtHostTerminal; private _terminals: ExtHostTerminal[] = []; private _terminalProcesses: { [id: number]: cp.ChildProcess } = {}; private _terminalRenderers: ExtHostTerminalRenderer[] = []; public get activeTerminal(): ExtHostTerminal { return this._activeTerminal; } public get terminals(): ExtHostTerminal[] { return this._terminals; } private readonly _onDidCloseTerminal: Emitter = new Emitter(); public get onDidCloseTerminal(): Event { return this._onDidCloseTerminal && this._onDidCloseTerminal.event; } private readonly _onDidOpenTerminal: Emitter = new Emitter(); public get onDidOpenTerminal(): Event { return this._onDidOpenTerminal && this._onDidOpenTerminal.event; } private readonly _onDidChangeActiveTerminal: Emitter = new Emitter(); public get onDidChangeActiveTerminal(): Event { return this._onDidChangeActiveTerminal && this._onDidChangeActiveTerminal.event; } constructor( mainContext: IMainContext, private _extHostConfiguration: ExtHostConfiguration, private _logService: ILogService ) { this._proxy = mainContext.getProxy(MainContext.MainThreadTerminalService); } public createTerminal(name?: string, shellPath?: string, shellArgs?: string[]): vscode.Terminal { const terminal = new ExtHostTerminal(this._proxy, name); terminal.create(shellPath, shellArgs); this._terminals.push(terminal); return terminal; } public createTerminalFromOptions(options: vscode.TerminalOptions): vscode.Terminal { const terminal = new ExtHostTerminal(this._proxy, options.name); terminal.create(options.shellPath, options.shellArgs, options.cwd, options.env /*, options.waitOnExit*/); this._terminals.push(terminal); return terminal; } public createTerminalRenderer(name: string): vscode.TerminalRenderer { const terminal = new ExtHostTerminal(this._proxy, name); terminal._setProcessId(undefined); this._terminals.push(terminal); const renderer = new ExtHostTerminalRenderer(this._proxy, name, terminal); this._terminalRenderers.push(renderer); return renderer; } public $acceptActiveTerminalChanged(id: number | null): void { const original = this._activeTerminal; if (id === null) { this._activeTerminal = undefined; } else { const terminal = this._getTerminalById(id); if (terminal) { this._activeTerminal = terminal; } } if (original !== this._activeTerminal) { this._onDidChangeActiveTerminal.fire(this._activeTerminal); } } public $acceptTerminalProcessData(id: number, data: string): void { const terminal = this._getTerminalById(id); if (terminal) { terminal._fireOnData(data); } } public $acceptTerminalRendererDimensions(id: number, cols: number, rows: number): void { const renderer = this._getTerminalRendererById(id); if (renderer) { renderer._setMaximumDimensions(cols, rows); } } public $acceptTerminalRendererInput(id: number, data: string): void { const renderer = this._getTerminalRendererById(id); if (renderer) { renderer._fireOnInput(data); } } public $acceptTerminalClosed(id: number): void { const index = this._getTerminalObjectIndexById(this.terminals, id); if (index === null) { return; } const terminal = this._terminals.splice(index, 1)[0]; this._onDidCloseTerminal.fire(terminal); } public $acceptTerminalOpened(id: number, name: string): void { const index = this._getTerminalObjectIndexById(this._terminals, id); if (index !== null) { // The terminal has already been created (via createTerminal*), only fire the event this._onDidOpenTerminal.fire(this.terminals[index]); return; } const renderer = this._getTerminalRendererById(id); const terminal = new ExtHostTerminal(this._proxy, name, id, renderer ? RENDERER_NO_PROCESS_ID : undefined); this._terminals.push(terminal); this._onDidOpenTerminal.fire(terminal); } public $acceptTerminalProcessId(id: number, processId: number): void { let terminal = this._getTerminalById(id); if (terminal) { terminal._setProcessId(processId); } else { // Retry one more time in case the terminal has not yet been initialized. setTimeout(() => { terminal = this._getTerminalById(id); if (terminal) { terminal._setProcessId(processId); } }, EXT_HOST_CREATION_DELAY); } } public $createProcess(id: number, shellLaunchConfig: ShellLaunchConfigDto, cols: number, rows: number): void { // TODO: This function duplicates a lot of TerminalProcessManager.createProcess, ideally // they would be merged into a single implementation. const terminalConfig = this._extHostConfiguration.getConfiguration('terminal.integrated'); const locale = terminalConfig.get('setLocaleVariables') ? platform.locale : undefined; if (!shellLaunchConfig.executable) { // TODO: This duplicates some of TerminalConfigHelper.mergeDefaultShellPathAndArgs and should be merged // this._configHelper.mergeDefaultShellPathAndArgs(shellLaunchConfig); const platformKey = platform.isWindows ? 'windows' : platform.isMacintosh ? 'osx' : 'linux'; const shellConfigValue: string = terminalConfig.get(`shell.${platformKey}`); const shellArgsConfigValue: string = terminalConfig.get(`shellArgs.${platformKey}`); shellLaunchConfig.executable = shellConfigValue; shellLaunchConfig.args = shellArgsConfigValue; } // TODO: Base the cwd on the last active workspace root // const lastActiveWorkspaceRootUri = this._historyService.getLastActiveWorkspaceRoot('file'); // this.initialCwd = terminalEnvironment.getCwd(shellLaunchConfig, lastActiveWorkspaceRootUri, this._configHelper); const initialCwd = os.homedir(); // TODO: Pull in and resolve config settings // // Resolve env vars from config and shell // const lastActiveWorkspaceRoot = this._workspaceContextService.getWorkspaceFolder(lastActiveWorkspaceRootUri); // const platformKey = platform.isWindows ? 'windows' : (platform.isMacintosh ? 'osx' : 'linux'); // const envFromConfig = terminalEnvironment.resolveConfigurationVariables(this._configurationResolverService, { ...this._configHelper.config.env[platformKey] }, lastActiveWorkspaceRoot); // const envFromShell = terminalEnvironment.resolveConfigurationVariables(this._configurationResolverService, { ...shellLaunchConfig.env }, lastActiveWorkspaceRoot); // shellLaunchConfig.env = envFromShell; // Merge process env with the env from config const parentEnv = { ...process.env }; // terminalEnvironment.mergeEnvironments(parentEnv, envFromConfig); // Continue env initialization, merging in the env from the launch // config and adding keys that are needed to create the process const env = terminalEnvironment.createTerminalEnv(parentEnv, shellLaunchConfig, initialCwd, locale, cols, rows); const cwd = Uri.parse(require.toUrl('../../parts/terminal/node')).fsPath; const options = { env, cwd, execArgv: [] }; // Fork the process and listen for messages this._logService.debug(`Terminal process launching on ext host`, options); this._terminalProcesses[id] = cp.fork(Uri.parse(require.toUrl('bootstrap')).fsPath, ['--type=terminal'], options); this._terminalProcesses[id].on('message', (message: IMessageFromTerminalProcess) => { switch (message.type) { case 'pid': this._proxy.$sendProcessPid(id, message.content); break; case 'title': this._proxy.$sendProcessTitle(id, message.content); break; case 'data': this._proxy.$sendProcessData(id, message.content); break; } }); this._terminalProcesses[id].on('exit', (exitCode) => this._onProcessExit(id, exitCode)); } public $acceptProcessInput(id: number, data: string): void { if (this._terminalProcesses[id].connected) { this._terminalProcesses[id].send({ event: 'input', data }); } } public $acceptProcessResize(id: number, cols: number, rows: number): void { if (this._terminalProcesses[id].connected) { try { this._terminalProcesses[id].send({ event: 'resize', cols, rows }); } catch (error) { // We tried to write to a closed pipe / channel. if (error.code !== 'EPIPE' && error.code !== 'ERR_IPC_CHANNEL_CLOSED') { throw (error); } } } } public $acceptProcessShutdown(id: number): void { if (this._terminalProcesses[id].connected) { this._terminalProcesses[id].send({ event: 'shutdown' }); } } private _onProcessExit(id: number, exitCode: number): void { // Remove listeners const process = this._terminalProcesses[id]; process.removeAllListeners('message'); process.removeAllListeners('exit'); // Remove process reference delete this._terminalProcesses[id]; // Send exit event to main side this._proxy.$sendProcessExit(id, exitCode); } private _getTerminalByIdEventually(id: number, retries: number = 5): Promise { return new Promise(c => { if (retries === 0) { c(undefined); return; } const terminal = this._getTerminalById(id); if (terminal) { c(terminal); } else { // This should only be needed immediately after createTerminalRenderer is called as // the ExtHostTerminal has not yet been iniitalized setTimeout(() => { c(this._getTerminalByIdEventually(id, retries - 1)); }, 200); } }); } private _getTerminalById(id: number): ExtHostTerminal { return this._getTerminalObjectById(this._terminals, id); } private _getTerminalRendererById(id: number): ExtHostTerminalRenderer { return this._getTerminalObjectById(this._terminalRenderers, id); } private _getTerminalObjectById(array: T[], id: number): T { const index = this._getTerminalObjectIndexById(array, id); return index !== null ? array[index] : null; } private _getTerminalObjectIndexById(array: T[], id: number): number { let index: number = null; array.some((item, i) => { const thisId = item._id; if (thisId === id) { index = i; return true; } return false; }); return index; } } class ApiRequest { private _callback: (...args: any[]) => void; private _args: any[]; constructor(callback: (...args: any[]) => void, args: any[]) { this._callback = callback; this._args = args; } public run(proxy: MainThreadTerminalServiceShape, id: number) { this._callback.apply(proxy, [id].concat(this._args)); } }