outputServices.ts 24.7 KB
Newer Older
E
Erich Gamma 已提交
1 2 3 4 5
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

6 7
import * as nls from 'vs/nls';
import * as paths from 'vs/base/common/paths';
8 9
import * as strings from 'vs/base/common/strings';
import * as extfs from 'vs/base/node/extfs';
10
import * as fs from 'fs';
J
Johannes Rieken 已提交
11 12
import { TPromise } from 'vs/base/common/winjs.base';
import Event, { Emitter } from 'vs/base/common/event';
13
import URI from 'vs/base/common/uri';
14
import { IDisposable, dispose, Disposable, toDisposable } from 'vs/base/common/lifecycle';
J
Johannes Rieken 已提交
15 16
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { IStorageService, StorageScope } from 'vs/platform/storage/common/storage';
17
import { Registry } from 'vs/platform/registry/common/platform';
J
Johannes Rieken 已提交
18
import { EditorOptions } from 'vs/workbench/common/editor';
19
import { IOutputChannelIdentifier, IOutputChannel, IOutputService, Extensions, OUTPUT_PANEL_ID, IOutputChannelRegistry, OUTPUT_SCHEME, OUTPUT_MIME, MAX_OUTPUT_LENGTH, LOG_SCHEME } from 'vs/workbench/parts/output/common/output';
J
Johannes Rieken 已提交
20 21 22 23 24
import { OutputPanel } from 'vs/workbench/parts/output/browser/outputPanel';
import { IPanelService } from 'vs/workbench/services/panel/common/panelService';
import { IModelService } from 'vs/editor/common/services/modelService';
import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace';
import { OutputLinkProvider } from 'vs/workbench/parts/output/common/outputLinkProvider';
25
import { ITextModelService, ITextModelContentProvider } from 'vs/editor/common/services/resolverService';
A
Alex Dima 已提交
26
import { ITextModel } from 'vs/editor/common/model';
27
import { IModeService } from 'vs/editor/common/services/modeService';
28
import { RunOnceScheduler, ThrottledDelayer } from 'vs/base/common/async';
29 30
import { EditOperation } from 'vs/editor/common/core/editOperation';
import { Position } from 'vs/editor/common/core/position';
31
import { IFileService } from 'vs/platform/files/common/files';
32 33
import { IPanel } from 'vs/workbench/common/panel';
import { ResourceEditorInput } from 'vs/workbench/common/editor/resourceEditorInput';
34 35 36
import { IEnvironmentService } from 'vs/platform/environment/common/environment';
import { RotatingLogger } from 'spdlog';
import { toLocalISOString } from 'vs/base/common/date';
37
import { IWindowService } from 'vs/platform/windows/common/windows';
38 39 40
import { ILogService } from 'vs/platform/log/common/log';
import { binarySearch } from 'vs/base/common/arrays';
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
41
import { Schemas } from 'vs/base/common/network';
S
Sandeep Somavarapu 已提交
42
import { ILifecycleService } from 'vs/platform/lifecycle/common/lifecycle';
43 44

const OUTPUT_ACTIVE_CHANNEL_KEY = 'output.activechannel';
E
Erich Gamma 已提交
45

46
let watchingOutputDir = false;
47
let callbacks: ((eventType: string, fileName: string) => void)[] = [];
48 49 50
function watchOutputDirectory(outputDir: string, logService: ILogService, onChange: (eventType: string, fileName: string) => void): IDisposable {
	callbacks.push(onChange);
	if (!watchingOutputDir) {
51 52 53 54 55 56 57 58 59 60 61
		const watcher = extfs.watch(outputDir, (eventType, fileName) => {
			for (const callback of callbacks) {
				callback(eventType, fileName);
			}
		}, (error: string) => {
			logService.error(error);
		});
		watchingOutputDir = true;
		return toDisposable(() => {
			callbacks = [];
			if (watcher) {
62 63
				watcher.removeAllListeners();
				watcher.close();
64 65
			}
		});
66
	}
67
	return toDisposable(() => { });
68 69
}

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
const fileWatchers: Map<string, any[]> = new Map<string, any[]>();
function watchFile(file: string, callback: () => void): IDisposable {

	const onFileChange = (file: string) => {
		for (const callback of fileWatchers.get(file)) {
			callback();
		}
	};

	let callbacks = fileWatchers.get(file);
	if (!callbacks) {
		callbacks = [];
		fileWatchers.set(file, callbacks);
		fs.watchFile(file, { interval: 1000 }, (current, previous) => {
			if ((previous && !current) || (!previous && !current)) {
				onFileChange(file);
				return;
			}
			if (previous && current && previous.mtime !== current.mtime) {
				onFileChange(file);
				return;
			}
		});
	}
	callbacks.push(callback);
	return toDisposable(() => {
		let allCallbacks = fileWatchers.get(file);
		allCallbacks.splice(allCallbacks.indexOf(callback), 1);
		if (!allCallbacks.length) {
			fs.unwatchFile(file);
			fileWatchers.delete(file);
		}
	});
}

function unWatchAllFiles(): void {
	fileWatchers.forEach((value, file) => fs.unwatchFile(file));
	fileWatchers.clear();
}
109

110
interface OutputChannel extends IOutputChannel {
S
Sandeep Somavarapu 已提交
111
	readonly file: URI;
112
	readonly onDidAppendedContent: Event<void>;
S
Sandeep Somavarapu 已提交
113
	readonly onDispose: Event<void>;
A
Alex Dima 已提交
114
	loadModel(): TPromise<ITextModel>;
115
}
116

117
abstract class AbstractFileOutputChannel extends Disposable {
118 119

	scrollLock: boolean = false;
120

121 122 123
	protected _onDidAppendedContent: Emitter<void> = new Emitter<void>();
	readonly onDidAppendedContent: Event<void> = this._onDidAppendedContent.event;

124 125 126
	protected _onDispose: Emitter<void> = new Emitter<void>();
	readonly onDispose: Event<void> = this._onDispose.event;

127
	protected modelUpdater: RunOnceScheduler;
A
Alex Dima 已提交
128
	protected model: ITextModel;
S
Sandeep Somavarapu 已提交
129
	readonly file: URI;
S
Sandeep Somavarapu 已提交
130

S
Sandeep Somavarapu 已提交
131
	protected startOffset: number = 0;
132
	protected endOffset: number = 0;
133 134

	constructor(
135
		protected readonly outputChannelIdentifier: IOutputChannelIdentifier,
136
		private readonly modelUri: URI,
137
		protected fileService: IFileService,
138 139
		protected modelService: IModelService,
		protected modeService: IModeService,
140 141
	) {
		super();
142
		this.file = this.outputChannelIdentifier.file;
143
		this.modelUpdater = new RunOnceScheduler(() => this.updateModel(), 300);
144
		this._register(toDisposable(() => this.modelUpdater.cancel()));
145 146 147 148 149 150 151 152 153 154
	}

	get id(): string {
		return this.outputChannelIdentifier.id;
	}

	get label(): string {
		return this.outputChannelIdentifier.label;
	}

155
	clear(): void {
156 157 158
		if (this.modelUpdater.isScheduled()) {
			this.modelUpdater.cancel();
		}
159 160
		if (this.model) {
			this.model.setValue('');
161
		}
162
		this.startOffset = this.endOffset;
163 164
	}

S
Sandeep Somavarapu 已提交
165
	protected createModel(content: string): ITextModel {
166
		if (this.model) {
S
Sandeep Somavarapu 已提交
167 168 169 170 171 172 173 174 175 176
			this.model.setValue(content);
		} else {
			this.model = this.modelService.createModel(content, this.modeService.getOrCreateMode(OUTPUT_MIME), this.modelUri);
			this.onModelCreated(this.model);
			const disposables: IDisposable[] = [];
			disposables.push(this.model.onWillDispose(() => {
				this.onModelWillDispose(this.model);
				this.model = null;
				dispose(disposables);
			}));
177
		}
S
Sandeep Somavarapu 已提交
178
		return this.model;
179 180 181 182 183 184 185
	}

	appendToModel(content: string): void {
		if (this.model && content) {
			const lastLine = this.model.getLineCount();
			const lastLineMaxColumn = this.model.getLineMaxColumn(lastLine);
			this.model.applyEdits([EditOperation.insert(new Position(lastLine, lastLineMaxColumn), content)]);
186
			this._onDidAppendedContent.fire();
187
		}
188 189
	}

A
Alex Dima 已提交
190 191
	protected onModelCreated(model: ITextModel) { }
	protected onModelWillDispose(model: ITextModel) { }
192 193 194 195 196
	protected updateModel() { }

	dispose(): void {
		this._onDispose.fire();
		super.dispose();
197
	}
198 199
}

200 201 202 203
/**
 * An output channel that stores appended messages in a backup file.
 */
class OutputChannelBackedByFile extends AbstractFileOutputChannel implements OutputChannel {
204

205 206 207
	private outputWriter: RotatingLogger;
	private appendedMessage = '';
	private loadingFromFileInProgress: boolean = false;
208
	private resettingDelayer: ThrottledDelayer<void>;
209
	private readonly rotatingFilePath: string;
210 211 212

	constructor(
		outputChannelIdentifier: IOutputChannelIdentifier,
213
		outputDir: string,
214
		modelUri: URI,
215 216 217
		@IFileService fileService: IFileService,
		@IModelService modelService: IModelService,
		@IModeService modeService: IModeService,
218
		@ILogService logService: ILogService
219
	) {
220
		super({ ...outputChannelIdentifier, file: URI.file(paths.join(outputDir, `${outputChannelIdentifier.id}.log`)) }, modelUri, fileService, modelService, modeService);
221

222
		// Use one rotating file to check for main file reset
223
		this.outputWriter = new RotatingLogger(this.id, this.file.fsPath, 1024 * 1024 * 30, 1);
224
		this.outputWriter.clearFormatters();
225
		this.rotatingFilePath = `${outputChannelIdentifier.id}.1.log`;
226
		this._register(watchOutputDirectory(paths.dirname(this.file.fsPath), logService, (eventType, file) => this.onFileChangedInOutputDirector(eventType, file)));
227 228

		this.resettingDelayer = new ThrottledDelayer<void>(50);
229 230 231
	}

	append(message: string): void {
S
Sandeep Somavarapu 已提交
232 233
		// update end offset always as message is read
		this.endOffset = this.endOffset + new Buffer(message).byteLength;
234 235 236
		if (this.loadingFromFileInProgress) {
			this.appendedMessage += message;
		} else {
237
			this.write(message);
238 239 240 241 242 243 244 245 246 247 248 249 250 251
			if (this.model) {
				this.appendedMessage += message;
				if (!this.modelUpdater.isScheduled()) {
					this.modelUpdater.schedule();
				}
			}
		}
	}

	clear(): void {
		super.clear();
		this.appendedMessage = '';
	}

A
Alex Dima 已提交
252
	loadModel(): TPromise<ITextModel> {
S
Sandeep Somavarapu 已提交
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
		this.loadingFromFileInProgress = true;
		if (this.modelUpdater.isScheduled()) {
			this.modelUpdater.cancel();
		}
		this.appendedMessage = '';
		return this.loadFile()
			.then(content => {
				if (this.endOffset !== this.startOffset + new Buffer(content).byteLength) {
					// Queue content is not written into the file
					// Flush it and load file again
					this.flush();
					return this.loadFile();
				}
				return content;
			})
			.then(content => {
				if (this.appendedMessage) {
					this.write(this.appendedMessage);
					this.appendedMessage = '';
				}
				this.loadingFromFileInProgress = false;
				return this.createModel(content);
275
			});
276 277
	}

S
Sandeep Somavarapu 已提交
278 279 280 281 282
	private resetModel(): TPromise<void> {
		this.startOffset = 0;
		this.endOffset = 0;
		if (this.model) {
			return this.loadModel() as TPromise;
283
		}
S
Sandeep Somavarapu 已提交
284
		return TPromise.as(null);
285 286
	}

S
Sandeep Somavarapu 已提交
287 288 289
	private loadFile(): TPromise<string> {
		return this.fileService.resolveContent(this.file, { position: this.startOffset })
			.then(content => this.appendedMessage ? content.value + this.appendedMessage : content.value);
290 291
	}

S
Sandeep Somavarapu 已提交
292 293
	protected updateModel(): void {
		if (this.model && this.appendedMessage) {
294 295 296
			this.appendToModel(this.appendedMessage);
			this.appendedMessage = '';
		}
297 298
	}

299
	private onFileChangedInOutputDirector(eventType: string, fileName: string): void {
300
		// Check if rotating file has changed. It changes only when the main file exceeds its limit.
301
		if (this.rotatingFilePath === fileName) {
302
			this.resettingDelayer.trigger(() => this.resetModel());
303
		}
304
	}
305 306 307 308 309 310

	private write(content: string): void {
		this.outputWriter.critical(content);
	}

	private flush(): void {
S
Sandeep Somavarapu 已提交
311
		this.outputWriter.flush();
312
	}
313 314
}

315 316 317 318
class OutputFileListener extends Disposable {

	private _onDidChange: Emitter<void> = new Emitter<void>();
	readonly onDidContentChange: Event<void> = this._onDidChange.event;
319

320
	private watching: boolean = false;
321 322 323 324 325 326 327 328 329
	private disposables: IDisposable[] = [];

	constructor(
		private readonly file: URI,
	) {
		super();
	}

	watch(): void {
330 331 332 333
		if (!this.watching) {
			this.disposables.push(watchFile(this.file.fsPath, () => this._onDidChange.fire()));
			this.watching = true;
		}
334 335 336
	}

	unwatch(): void {
337 338 339 340
		if (this.watching) {
			this.disposables = dispose(this.disposables);
			this.watching = false;
		}
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
	}

	dispose(): void {
		this.unwatch();
		super.dispose();
	}
}

/**
 * An output channel driven by a file and does not support appending messages.
 */
class FileOutputChannel extends AbstractFileOutputChannel implements OutputChannel {

	private readonly fileHandler: OutputFileListener;

	private updateInProgress: boolean = false;
357 358 359

	constructor(
		outputChannelIdentifier: IOutputChannelIdentifier,
360
		modelUri: URI,
361 362
		@IFileService fileService: IFileService,
		@IModelService modelService: IModelService,
363 364
		@IModeService modeService: IModeService,
		@ILogService logService: ILogService,
365
	) {
366
		super(outputChannelIdentifier, modelUri, fileService, modelService, modeService);
367

368
		this.fileHandler = this._register(new OutputFileListener(this.file));
369 370
		this._register(this.fileHandler.onDidContentChange(() => this.onDidContentChange()));
		this._register(toDisposable(() => this.fileHandler.unwatch()));
371 372
	}

S
Sandeep Somavarapu 已提交
373 374 375 376 377 378 379 380
	loadModel(): TPromise<ITextModel> {
		return this.fileService.resolveContent(this.file, { position: this.startOffset })
			.then(content => {
				this.endOffset = this.startOffset + new Buffer(content.value).byteLength;
				return this.createModel(content.value);
			});
	}

381
	append(message: string): void {
382 383 384 385 386 387 388
		throw new Error('Not supported');
	}

	protected updateModel(): void {
		if (this.model) {
			this.fileService.resolveContent(this.file, { position: this.endOffset })
				.then(content => {
S
Sandeep Somavarapu 已提交
389 390 391 392
					if (content.value) {
						this.endOffset = this.endOffset + new Buffer(content.value).byteLength;
						this.appendToModel(content.value);
					}
393 394 395 396
					this.updateInProgress = false;
				}, () => this.updateInProgress = false);
		} else {
			this.updateInProgress = false;
397 398 399
		}
	}

A
Alex Dima 已提交
400
	protected onModelCreated(model: ITextModel): void {
401
		this.fileHandler.watch();
402 403
	}

A
Alex Dima 已提交
404
	protected onModelWillDispose(model: ITextModel): void {
405
		this.fileHandler.unwatch();
406 407
	}

408 409 410 411
	private onDidContentChange(): void {
		if (!this.updateInProgress) {
			this.updateInProgress = true;
			this.modelUpdater.schedule();
412 413 414 415
		}
	}
}

416
export class OutputService extends Disposable implements IOutputService, ITextModelContentProvider {
417

418 419 420
	public _serviceBrand: any;

	private channels: Map<string, OutputChannel> = new Map<string, OutputChannel>();
S
Sandeep Somavarapu 已提交
421 422
	private activeChannelIdInStorage: string;
	private activeChannel: IOutputChannel;
423
	private readonly outputDir: string;
424 425 426 427 428

	private _onActiveOutputChannel: Emitter<string> = new Emitter<string>();
	readonly onActiveOutputChannel: Event<string> = this._onActiveOutputChannel.event;

	private _outputPanel: OutputPanel;
429 430

	constructor(
431 432 433 434 435
		@IStorageService private storageService: IStorageService,
		@IInstantiationService private instantiationService: IInstantiationService,
		@IPanelService private panelService: IPanelService,
		@IWorkspaceContextService contextService: IWorkspaceContextService,
		@ITextModelService textModelResolverService: ITextModelService,
436 437 438
		@IEnvironmentService environmentService: IEnvironmentService,
		@IWindowService windowService: IWindowService,
		@ITelemetryService private telemetryService: ITelemetryService,
S
Sandeep Somavarapu 已提交
439 440
		@ILogService private logService: ILogService,
		@ILifecycleService private lifecycleService: ILifecycleService,
441
	) {
442
		super();
S
Sandeep Somavarapu 已提交
443 444
		this.activeChannelIdInStorage = this.storageService.get(OUTPUT_ACTIVE_CHANNEL_KEY, StorageScope.WORKSPACE, null);
		this.outputDir = paths.join(environmentService.logsPath, `output_${windowService.getCurrentWindowId()}_${toLocalISOString(new Date()).replace(/-|:|\.\d+Z$/g, '')}`);
445 446 447

		// Register as text model content provider for output
		textModelResolverService.registerTextModelContentProvider(OUTPUT_SCHEME, this);
S
Sandeep Somavarapu 已提交
448 449 450 451 452 453 454 455
		instantiationService.createInstance(OutputLinkProvider);

		// Create output channels for already registered channels
		const registry = Registry.as<IOutputChannelRegistry>(Extensions.OutputChannels);
		for (const channelIdentifier of registry.getChannels()) {
			this.onDidRegisterChannel(channelIdentifier.id);
		}
		this._register(registry.onDidRegisterChannel(this.onDidRegisterChannel, this));
456 457 458

		panelService.onDidPanelOpen(this.onDidPanelOpen, this);
		panelService.onDidPanelClose(this.onDidPanelClose, this);
459

460
		this._register(toDisposable(() => unWatchAllFiles()));
S
Sandeep Somavarapu 已提交
461 462 463 464 465 466 467 468

		// Set active channel to first channel if not set
		if (!this.activeChannel) {
			const channels = this.getChannels();
			this.activeChannel = channels && channels.length > 0 ? this.getChannel(channels[0].id) : null;
		}

		this.lifecycleService.onShutdown(() => this.onShutdown());
469 470
	}

A
Alex Dima 已提交
471
	provideTextContent(resource: URI): TPromise<ITextModel> {
472
		const channel = <OutputChannel>this.getChannel(resource.fsPath);
473 474 475 476
		if (channel) {
			return channel.loadModel();
		}
		return TPromise.as(null);
477 478 479
	}

	showChannel(id: string, preserveFocus?: boolean): TPromise<void> {
S
Sandeep Somavarapu 已提交
480 481
		const channel = this.getChannel(id);
		if (!channel || this.isChannelShown(channel)) {
482 483 484
			return TPromise.as(null);
		}

S
Sandeep Somavarapu 已提交
485
		this.activeChannel = channel;
486
		let promise = TPromise.as(null);
S
Sandeep Somavarapu 已提交
487
		if (this.isPanelShown()) {
S
Sandeep Somavarapu 已提交
488
			this.doShowChannel(channel, preserveFocus);
489 490
		} else {
			promise = this.panelService.openPanel(OUTPUT_PANEL_ID) as TPromise;
491
		}
492
		return promise.then(() => this._onActiveOutputChannel.fire(id));
493 494
	}

495 496 497 498 499 500
	getChannel(id: string): IOutputChannel {
		return this.channels.get(id);
	}

	getChannels(): IOutputChannelIdentifier[] {
		return Registry.as<IOutputChannelRegistry>(Extensions.OutputChannels).getChannels();
501 502
	}

503
	getActiveChannel(): IOutputChannel {
S
Sandeep Somavarapu 已提交
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
		return this.activeChannel;
	}

	private onDidRegisterChannel(channelId: string): void {
		const channel = this.createChannel(channelId);
		this.channels.set(channelId, channel);
		if (this.activeChannelIdInStorage === channelId) {
			this.activeChannel = channel;
			this.onDidPanelOpen(this.panelService.getActivePanel());
		}
	}

	private onDidPanelOpen(panel: IPanel): void {
		if (panel && panel.getId() === OUTPUT_PANEL_ID) {
			this._outputPanel = <OutputPanel>this.panelService.getActivePanel();
			if (this.activeChannel) {
				this.doShowChannel(this.activeChannel, true);
			}
		}
	}

	private onDidPanelClose(panel: IPanel): void {
		if (this._outputPanel && panel.getId() === OUTPUT_PANEL_ID) {
			this._outputPanel.clearInput();
		}
529
	}
530

531
	private createChannel(id: string): OutputChannel {
532
		const channelDisposables: IDisposable[] = [];
533
		const channel = this.instantiateChannel(id);
534 535 536
		channel.onDidAppendedContent(() => {
			if (!channel.scrollLock) {
				const panel = this.panelService.getActivePanel();
S
Sandeep Somavarapu 已提交
537
				if (panel && panel.getId() === OUTPUT_PANEL_ID && this.isChannelShown(channel)) {
538 539 540 541
					(<OutputPanel>panel).revealLastLine();
				}
			}
		}, channelDisposables);
542 543
		channel.onDispose(() => {
			Registry.as<IOutputChannelRegistry>(Extensions.OutputChannels).removeChannel(id);
S
Sandeep Somavarapu 已提交
544
			if (this.activeChannel === channel) {
545
				const channels = this.getChannels();
S
Sandeep Somavarapu 已提交
546 547 548
				if (this.isPanelShown() && channels.length) {
					this.doShowChannel(this.getChannel(channels[0].id), true);
					this._onActiveOutputChannel.fire(channels[0].id);
549 550 551 552 553 554 555 556 557 558 559 560
				} else {
					this._onActiveOutputChannel.fire(void 0);
				}
			}
			dispose(channelDisposables);
		}, channelDisposables);

		return channel;
	}

	private instantiateChannel(id: string): OutputChannel {
		const channelData = Registry.as<IOutputChannelRegistry>(Extensions.OutputChannels).getChannel(id);
S
Sandeep Somavarapu 已提交
561 562 563 564 565
		if (!channelData) {
			this.logService.error(`Channel '${id}' is not registered yet`);
			throw new Error(`Channel '${id}' is not registered yet`);
		}

566
		const uri = URI.from({ scheme: OUTPUT_SCHEME, path: id });
567
		if (channelData && channelData.file) {
568
			return this.instantiationService.createInstance(FileOutputChannel, channelData, uri);
569
		}
570
		try {
571
			return this.instantiationService.createInstance(OutputChannelBackedByFile, { id, label: channelData ? channelData.label : '' }, this.outputDir, uri);
572 573 574 575 576
		} catch (e) {
			this.logService.error(e);
			this.telemetryService.publicLog('output.used.bufferedChannel');
			return this.instantiationService.createInstance(BufferredOutputChannel, { id, label: channelData ? channelData.label : '' });
		}
577
	}
578

S
Sandeep Somavarapu 已提交
579
	private doShowChannel(channel: IOutputChannel, preserveFocus: boolean): void {
580
		if (this._outputPanel) {
S
Sandeep Somavarapu 已提交
581
			this._outputPanel.setInput(this.createInput(channel), EditorOptions.create({ preserveFocus: preserveFocus }));
582 583 584 585 586 587
			if (!preserveFocus) {
				this._outputPanel.focus();
			}
		}
	}

S
Sandeep Somavarapu 已提交
588
	private isChannelShown(channel: IOutputChannel): boolean {
S
Sandeep Somavarapu 已提交
589 590 591 592
		return this.isPanelShown() && this.activeChannel === channel;
	}

	private isPanelShown(): boolean {
S
Sandeep Somavarapu 已提交
593
		const panel = this.panelService.getActivePanel();
S
Sandeep Somavarapu 已提交
594
		return panel && panel.getId() === OUTPUT_PANEL_ID;
S
Sandeep Somavarapu 已提交
595 596 597 598 599 600 601 602 603 604 605 606
	}

	private createInput(channel: IOutputChannel): ResourceEditorInput {
		const resource = URI.from({ scheme: OUTPUT_SCHEME, path: channel.id });
		return this.instantiationService.createInstance(ResourceEditorInput, nls.localize('output', "{0} - Output", channel.label), nls.localize('channel', "Output channel for '{0}'", channel.label), resource);
	}

	onShutdown(): void {
		if (this.activeChannel) {
			this.storageService.store(OUTPUT_ACTIVE_CHANNEL_KEY, this.activeChannel.id, StorageScope.WORKSPACE);
		}
		this.dispose();
607
	}
608 609
}

610 611 612 613 614
export class LogContentProvider {

	private channels: Map<string, OutputChannel> = new Map<string, OutputChannel>();

	constructor(
615
		@IInstantiationService private instantiationService: IInstantiationService
616 617 618
	) {
	}

A
Alex Dima 已提交
619
	provideTextContent(resource: URI): TPromise<ITextModel> {
620 621 622 623 624 625 626 627 628 629 630 631 632
		if (resource.scheme === LOG_SCHEME) {
			let channel = this.getChannel(resource);
			if (channel) {
				return channel.loadModel();
			}
		}
		return TPromise.as(null);
	}

	private getChannel(resource: URI): OutputChannel {
		const id = resource.path;
		let channel = this.channels.get(id);
		if (!channel) {
633
			const channelDisposables: IDisposable[] = [];
634 635 636 637 638 639 640 641
			channel = this.instantiationService.createInstance(FileOutputChannel, { id, label: '', file: resource.with({ scheme: Schemas.file }) }, resource);
			channel.onDispose(() => dispose(channelDisposables), channelDisposables);
			this.channels.set(id, channel);
		}
		return channel;
	}
}

642 643 644 645 646
// Remove this channel when there are no issues using Output channel backed by file
class BufferredOutputChannel extends Disposable implements OutputChannel {

	readonly id: string;
	readonly label: string;
S
Sandeep Somavarapu 已提交
647
	readonly file: URI = null;
648 649
	scrollLock: boolean = false;

650 651 652
	protected _onDidAppendedContent: Emitter<void> = new Emitter<void>();
	readonly onDidAppendedContent: Event<void> = this._onDidAppendedContent.event;

653 654 655 656
	private _onDispose: Emitter<void> = new Emitter<void>();
	readonly onDispose: Event<void> = this._onDispose.event;

	private modelUpdater: RunOnceScheduler;
A
Alex Dima 已提交
657
	private model: ITextModel;
658 659 660 661 662 663
	private readonly bufferredContent: BufferedContent;
	private lastReadId: number = void 0;

	constructor(
		protected readonly outputChannelIdentifier: IOutputChannelIdentifier,
		@IModelService private modelService: IModelService,
664
		@IModeService private modeService: IModeService
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
	) {
		super();

		this.id = outputChannelIdentifier.id;
		this.label = outputChannelIdentifier.label;

		this.modelUpdater = new RunOnceScheduler(() => this.updateModel(), 300);
		this._register(toDisposable(() => this.modelUpdater.cancel()));

		this.bufferredContent = new BufferedContent();
		this._register(toDisposable(() => this.bufferredContent.clear()));
	}

	append(output: string) {
		this.bufferredContent.append(output);
		if (!this.modelUpdater.isScheduled()) {
			this.modelUpdater.schedule();
		}
	}

	clear(): void {
		if (this.modelUpdater.isScheduled()) {
			this.modelUpdater.cancel();
		}
		if (this.model) {
			this.model.setValue('');
		}
		this.bufferredContent.clear();
		this.lastReadId = void 0;
	}

A
Alex Dima 已提交
696
	loadModel(): TPromise<ITextModel> {
697 698 699 700 701 702 703 704 705 706
		const { value, id } = this.bufferredContent.getDelta(this.lastReadId);
		if (this.model) {
			this.model.setValue(value);
		} else {
			this.model = this.createModel(value);
		}
		this.lastReadId = id;
		return TPromise.as(this.model);
	}

A
Alex Dima 已提交
707
	private createModel(content: string): ITextModel {
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
		const model = this.modelService.createModel(content, this.modeService.getOrCreateMode(OUTPUT_MIME), URI.from({ scheme: OUTPUT_SCHEME, path: this.id }));
		const disposables: IDisposable[] = [];
		disposables.push(model.onWillDispose(() => {
			this.model = null;
			dispose(disposables);
		}));
		return model;
	}

	private updateModel(): void {
		if (this.model) {
			const { value, id } = this.bufferredContent.getDelta(this.lastReadId);
			this.lastReadId = id;
			const lastLine = this.model.getLineCount();
			const lastLineMaxColumn = this.model.getLineMaxColumn(lastLine);
			this.model.applyEdits([EditOperation.insert(new Position(lastLine, lastLineMaxColumn), value)]);
724
			this._onDidAppendedContent.fire();
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
		}
	}

	dispose(): void {
		this._onDispose.fire();
		super.dispose();
	}
}

class BufferedContent {

	private data: string[] = [];
	private dataIds: number[] = [];
	private idPool = 0;
	private length = 0;

	public append(content: string): void {
		this.data.push(content);
		this.dataIds.push(++this.idPool);
		this.length += content.length;
		this.trim();
	}

	public clear(): void {
		this.data.length = 0;
		this.dataIds.length = 0;
		this.length = 0;
	}

	private trim(): void {
		if (this.length < MAX_OUTPUT_LENGTH * 1.2) {
			return;
		}

		while (this.length > MAX_OUTPUT_LENGTH) {
			this.dataIds.shift();
			const removed = this.data.shift();
			this.length -= removed.length;
		}
	}

	public getDelta(previousId?: number): { value: string, id: number } {
		let idx = -1;
		if (previousId !== void 0) {
			idx = binarySearch(this.dataIds, previousId, (a, b) => a - b);
		}

		const id = this.idPool;
		if (idx >= 0) {
			const value = strings.removeAnsiEscapeCodes(this.data.slice(idx + 1).join(''));
			return { value, id };
		} else {
			const value = strings.removeAnsiEscapeCodes(this.data.join(''));
			return { value, id };
		}
	}
781
}