preferencesService.ts 30.5 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
S
Sandeep Somavarapu 已提交
5

6 7 8
import { Emitter } from 'vs/base/common/event';
import { parse } from 'vs/base/common/json';
import { Disposable } from 'vs/base/common/lifecycle';
9
import * as network from 'vs/base/common/network';
10 11 12 13 14 15 16 17 18 19
import { assign } from 'vs/base/common/objects';
import * as strings from 'vs/base/common/strings';
import { URI } from 'vs/base/common/uri';
import { getCodeEditor, ICodeEditor } from 'vs/editor/browser/editorBrowser';
import { EditOperation } from 'vs/editor/common/core/editOperation';
import { IPosition, Position } from 'vs/editor/common/core/position';
import { ITextModel } from 'vs/editor/common/model';
import { IModelService } from 'vs/editor/common/services/modelService';
import { IModeService } from 'vs/editor/common/services/modeService';
import { ITextModelService } from 'vs/editor/common/services/resolverService';
20
import * as nls from 'vs/nls';
21
import { ConfigurationTarget, IConfigurationService } from 'vs/platform/configuration/common/configuration';
B
Benjamin Pasero 已提交
22
import { IEditorOptions } from 'vs/platform/editor/common/editor';
S
Sandeep Somavarapu 已提交
23
import { IEnvironmentService } from 'vs/platform/environment/common/environment';
B
Benjamin Pasero 已提交
24
import { FileOperationError, FileOperationResult } from 'vs/platform/files/common/files';
25
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
26
import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
27
import { ILabelService } from 'vs/platform/label/common/label';
28
import { INotificationService } from 'vs/platform/notification/common/notification';
29 30 31 32
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
import { IWorkspaceContextService, WorkbenchState } from 'vs/platform/workspace/common/workspace';
import { EditorInput, IEditor } from 'vs/workbench/common/editor';
import { IJSONEditingService } from 'vs/workbench/services/configuration/common/jsonEditing';
B
Benjamin Pasero 已提交
33
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
34
import { GroupDirection, IEditorGroup, IEditorGroupsService } from 'vs/workbench/services/editor/common/editorGroupsService';
35
import { DEFAULT_SETTINGS_EDITOR_SETTING, FOLDER_SETTINGS_PATH, getSettingsTargetName, IPreferencesEditorModel, IPreferencesService, ISetting, ISettingsEditorOptions, SettingsEditorOptions, USE_SPLIT_JSON_SETTING } from 'vs/workbench/services/preferences/common/preferences';
36
import { DefaultPreferencesEditorInput, KeybindingsEditorInput, PreferencesEditorInput, SettingsEditor2Input } from 'vs/workbench/services/preferences/common/preferencesEditorInput';
S
Sandeep Somavarapu 已提交
37
import { defaultKeybindingsContents, DefaultKeybindingsEditorModel, DefaultSettings, DefaultSettingsEditorModel, Settings2EditorModel, SettingsEditorModel, WorkspaceConfigurationEditorModel, DefaultRawSettingsEditorModel } from 'vs/workbench/services/preferences/common/preferencesModels';
38
import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
39
import { IRemoteAgentService } from 'vs/workbench/services/remote/common/remoteAgentService';
40
import { ITextFileService } from 'vs/workbench/services/textfile/common/textfiles';
41

S
Sandeep Somavarapu 已提交
42 43
const emptyEditableSettingsContent = '{\n}';

44
export class PreferencesService extends Disposable implements IPreferencesService {
45 46

	_serviceBrand: any;
47

48
	private lastOpenedSettingsInput: PreferencesEditorInput | null = null;
49

50
	private readonly _onDispose = this._register(new Emitter<void>());
51

S
Sandeep Somavarapu 已提交
52 53 54 55 56 57
	private _defaultUserSettingsUriCounter = 0;
	private _defaultUserSettingsContentModel: DefaultSettings;
	private _defaultWorkspaceSettingsUriCounter = 0;
	private _defaultWorkspaceSettingsContentModel: DefaultSettings;
	private _defaultFolderSettingsUriCounter = 0;
	private _defaultFolderSettingsContentModel: DefaultSettings;
R
Rob Lourens 已提交
58

59
	constructor(
60 61
		@IEditorService private readonly editorService: IEditorService,
		@IEditorGroupsService private readonly editorGroupService: IEditorGroupsService,
62
		@ITextFileService private readonly textFileService: ITextFileService,
63
		@IConfigurationService private readonly configurationService: IConfigurationService,
64 65 66
		@INotificationService private readonly notificationService: INotificationService,
		@IWorkspaceContextService private readonly contextService: IWorkspaceContextService,
		@IInstantiationService private readonly instantiationService: IInstantiationService,
S
Sandeep Somavarapu 已提交
67
		@IEnvironmentService private readonly environmentService: IEnvironmentService,
68 69
		@ITelemetryService private readonly telemetryService: ITelemetryService,
		@ITextModelService private readonly textModelResolverService: ITextModelService,
70
		@IKeybindingService keybindingService: IKeybindingService,
71 72 73
		@IModelService private readonly modelService: IModelService,
		@IJSONEditingService private readonly jsonEditingService: IJSONEditingService,
		@IModeService private readonly modeService: IModeService,
74 75
		@ILabelService private readonly labelService: ILabelService,
		@IRemoteAgentService private readonly remoteAgentService: IRemoteAgentService
76 77
	) {
		super();
78 79
		// The default keybindings.json updates based on keyboard layouts, so here we make sure
		// if a model has been given out we update it accordingly.
80
		this._register(keybindingService.onDidUpdateKeybindings(() => {
81 82 83 84 85
			const model = modelService.getModel(this.defaultKeybindingsResource);
			if (!model) {
				// model has not been given out => nothing to do
				return;
			}
86
			modelService.updateModel(model, defaultKeybindingsContents(keybindingService));
87
		}));
88 89
	}

S
Sandeep Somavarapu 已提交
90
	readonly defaultKeybindingsResource = URI.from({ scheme: network.Schemas.vscode, authority: 'defaultsettings', path: '/keybindings.json' });
S
Sandeep Somavarapu 已提交
91
	private readonly defaultSettingsRawResource = URI.from({ scheme: network.Schemas.vscode, authority: 'defaultsettings', path: '/defaultSettings.json' });
92

93
	get userSettingsResource(): URI {
S
Sandeep Somavarapu 已提交
94
		return this.getEditableSettingsURI(ConfigurationTarget.USER)!;
95 96
	}

S
Sandeep Somavarapu 已提交
97
	get workspaceSettingsResource(): URI | null {
98 99 100
		return this.getEditableSettingsURI(ConfigurationTarget.WORKSPACE);
	}

101 102 103 104
	get settingsEditor2Input(): SettingsEditor2Input {
		return this.instantiationService.createInstance(SettingsEditor2Input);
	}

S
Sandeep Somavarapu 已提交
105
	getFolderSettingsResource(resource: URI): URI | null {
106
		return this.getEditableSettingsURI(ConfigurationTarget.WORKSPACE_FOLDER, resource);
S
Sandeep Somavarapu 已提交
107 108
	}

S
Sandeep Somavarapu 已提交
109
	resolveModel(uri: URI): Promise<ITextModel | null> {
S
Sandeep Somavarapu 已提交
110
		if (this.isDefaultSettingsResource(uri)) {
S
Sandeep Somavarapu 已提交
111

S
Sandeep Somavarapu 已提交
112
			const target = this.getConfigurationTargetFromDefaultSettingsResource(uri);
A
Alex Dima 已提交
113 114
			const languageSelection = this.modeService.create('jsonc');
			const model = this._register(this.modelService.createModel('', languageSelection, uri));
S
Sandeep Somavarapu 已提交
115

116
			let defaultSettings: DefaultSettings | undefined;
S
Sandeep Somavarapu 已提交
117 118 119 120 121 122 123
			this.configurationService.onDidChangeConfiguration(e => {
				if (e.source === ConfigurationTarget.DEFAULT) {
					const model = this.modelService.getModel(uri);
					if (!model) {
						// model has not been given out => nothing to do
						return;
					}
S
Sandeep Somavarapu 已提交
124
					defaultSettings = this.getDefaultSettings(target);
125
					this.modelService.updateModel(model, defaultSettings.getContent(true));
126
					defaultSettings._onDidChange.fire();
S
Sandeep Somavarapu 已提交
127 128 129 130 131
				}
			});

			// Check if Default settings is already created and updated in above promise
			if (!defaultSettings) {
S
Sandeep Somavarapu 已提交
132
				defaultSettings = this.getDefaultSettings(target);
133
				this.modelService.updateModel(model, defaultSettings.getContent(true));
S
Sandeep Somavarapu 已提交
134 135
			}

R
Rob Lourens 已提交
136
			return Promise.resolve(model);
137 138
		}

S
Sandeep Somavarapu 已提交
139
		if (this.defaultSettingsRawResource.toString() === uri.toString()) {
R
Rob Lourens 已提交
140
			const defaultRawSettingsEditorModel = this.instantiationService.createInstance(DefaultRawSettingsEditorModel, this.getDefaultSettings(ConfigurationTarget.USER_LOCAL));
A
Alex Dima 已提交
141
			const languageSelection = this.modeService.create('jsonc');
S
Sandeep Somavarapu 已提交
142
			const model = this._register(this.modelService.createModel(defaultRawSettingsEditorModel.content, languageSelection, uri));
R
Rob Lourens 已提交
143
			return Promise.resolve(model);
S
Sandeep Somavarapu 已提交
144 145
		}

146
		if (this.defaultKeybindingsResource.toString() === uri.toString()) {
S
Sandeep Somavarapu 已提交
147
			const defaultKeybindingsEditorModel = this.instantiationService.createInstance(DefaultKeybindingsEditorModel, uri);
A
Alex Dima 已提交
148 149
			const languageSelection = this.modeService.create('jsonc');
			const model = this._register(this.modelService.createModel(defaultKeybindingsEditorModel.content, languageSelection, uri));
R
Rob Lourens 已提交
150
			return Promise.resolve(model);
151 152
		}

R
Rob Lourens 已提交
153
		return Promise.resolve(null);
154 155
	}

J
Johannes Rieken 已提交
156
	createPreferencesEditorModel(uri: URI): Promise<IPreferencesEditorModel<any>> {
S
Sandeep Somavarapu 已提交
157
		if (this.isDefaultSettingsResource(uri)) {
158
			return this.createDefaultSettingsEditorModel(uri);
159 160
		}

S
Sandeep Somavarapu 已提交
161
		if (this.userSettingsResource.toString() === uri.toString()) {
R
Rob Lourens 已提交
162
			return this.createEditableSettingsEditorModel(ConfigurationTarget.USER_LOCAL, uri);
163
		}
164

S
Sandeep Somavarapu 已提交
165
		const workspaceSettingsUri = this.getEditableSettingsURI(ConfigurationTarget.WORKSPACE);
166
		if (workspaceSettingsUri && workspaceSettingsUri.toString() === uri.toString()) {
167
			return this.createEditableSettingsEditorModel(ConfigurationTarget.WORKSPACE, workspaceSettingsUri);
168
		}
169

170
		if (this.contextService.getWorkbenchState() === WorkbenchState.WORKSPACE) {
171
			return this.createEditableSettingsEditorModel(ConfigurationTarget.WORKSPACE_FOLDER, uri);
172
		}
173

S
Sandeep Somavarapu 已提交
174
		return Promise.reject(`unknown resource: ${uri.toString()}`);
175 176
	}

177
	openRawDefaultSettings(): Promise<IEditor | null> {
B
Benjamin Pasero 已提交
178
		return this.editorService.openEditor({ resource: this.defaultSettingsRawResource });
S
Sandeep Somavarapu 已提交
179 180
	}

181
	openRawUserSettings(): Promise<IEditor | null> {
182
		return this.editorService.openEditor({ resource: this.userSettingsResource });
S
Sandeep Somavarapu 已提交
183 184
	}

P
Peng Lyu 已提交
185
	openSettings(jsonEditor: boolean | undefined, query: string | undefined): Promise<IEditor | null> {
186 187 188 189
		jsonEditor = typeof jsonEditor === 'undefined' ?
			this.configurationService.getValue('workbench.settings.editor') === 'json' :
			jsonEditor;

190
		if (!jsonEditor) {
P
Peng Lyu 已提交
191
			return this.openSettings2({ query: query });
192 193
		}

194
		const editorInput = this.getActiveSettingsEditorInput() || this.lastOpenedSettingsInput;
S
Sandeep Somavarapu 已提交
195
		const resource = editorInput ? editorInput.master.getResource()! : this.userSettingsResource;
S
Sandeep Somavarapu 已提交
196
		const target = this.getConfigurationTargetFromSettingsResource(resource);
P
Peng Lyu 已提交
197
		return this.openOrSwitchSettings(target, resource, { query: query });
S
Sandeep Somavarapu 已提交
198 199
	}

P
Peng Lyu 已提交
200
	private openSettings2(options?: ISettingsEditorOptions): Promise<IEditor> {
201
		const input = this.settingsEditor2Input;
P
Peng Lyu 已提交
202
		return this.editorGroupService.activeGroup.openEditor(input, options)
S
Sandeep Somavarapu 已提交
203
			.then(() => this.editorGroupService.activeGroup.activeControl!);
204 205
	}

206
	openGlobalSettings(jsonEditor?: boolean, options?: ISettingsEditorOptions, group?: IEditorGroup): Promise<IEditor | null> {
207 208 209 210
		jsonEditor = typeof jsonEditor === 'undefined' ?
			this.configurationService.getValue('workbench.settings.editor') === 'json' :
			jsonEditor;

211
		return jsonEditor ?
R
Rob Lourens 已提交
212 213
			this.openOrSwitchSettings(ConfigurationTarget.USER_LOCAL, this.userSettingsResource, options, group) :
			this.openOrSwitchSettings2(ConfigurationTarget.USER_LOCAL, undefined, options, group);
R
Rob Lourens 已提交
214 215
	}

216
	async openRemoteSettings(): Promise<IEditor | null> {
R
Rob Lourens 已提交
217 218 219 220
		const environment = await this.remoteAgentService.getEnvironment();
		if (environment) {
			await this.createIfNotExists(environment.settingsPath, emptyEditableSettingsContent);
			return this.editorService.openEditor({ resource: environment.settingsPath, options: { pinned: true, revealIfOpened: true } });
221 222 223 224
		}
		return null;
	}

225
	openWorkspaceSettings(jsonEditor?: boolean, options?: ISettingsEditorOptions, group?: IEditorGroup): Promise<IEditor | null> {
226 227 228 229
		jsonEditor = typeof jsonEditor === 'undefined' ?
			this.configurationService.getValue('workbench.settings.editor') === 'json' :
			jsonEditor;

S
Sandeep Somavarapu 已提交
230
		if (!this.workspaceSettingsResource) {
231
			this.notificationService.info(nls.localize('openFolderFirst', "Open a folder first to create workspace settings"));
S
Sandeep Somavarapu 已提交
232
			return Promise.reject(null);
233
		}
234 235 236

		return jsonEditor ?
			this.openOrSwitchSettings(ConfigurationTarget.WORKSPACE, this.workspaceSettingsResource, options, group) :
237
			this.openOrSwitchSettings2(ConfigurationTarget.WORKSPACE, undefined, options, group);
238 239
	}

240
	openFolderSettings(folder: URI, jsonEditor?: boolean, options?: ISettingsEditorOptions, group?: IEditorGroup): Promise<IEditor | null> {
241 242 243
		jsonEditor = typeof jsonEditor === 'undefined' ?
			this.configurationService.getValue('workbench.settings.editor') === 'json' :
			jsonEditor;
S
Sandeep Somavarapu 已提交
244 245 246 247 248 249 250 251
		const folderSettingsUri = this.getEditableSettingsURI(ConfigurationTarget.WORKSPACE_FOLDER, folder);
		if (jsonEditor) {
			if (folderSettingsUri) {
				return this.openOrSwitchSettings(ConfigurationTarget.WORKSPACE_FOLDER, folderSettingsUri, options, group);
			}
			return Promise.reject(`Invalid folder URI - ${folder.toString()}`);
		}
		return this.openOrSwitchSettings2(ConfigurationTarget.WORKSPACE_FOLDER, folder, options, group);
252 253
	}

J
Johannes Rieken 已提交
254
	switchSettings(target: ConfigurationTarget, resource: URI, jsonEditor?: boolean): Promise<void> {
255
		if (!jsonEditor) {
S
Sandeep Somavarapu 已提交
256
			return this.doOpenSettings2(target, resource).then(() => undefined);
257 258
		}

B
Benjamin Pasero 已提交
259 260
		const activeControl = this.editorService.activeControl;
		if (activeControl && activeControl.input instanceof PreferencesEditorInput) {
S
Sandeep Somavarapu 已提交
261
			return this.doSwitchSettings(target, resource, activeControl.input, activeControl.group).then(() => undefined);
262
		} else {
S
Sandeep Somavarapu 已提交
263
			return this.doOpenSettings(target, resource).then(() => undefined);
264
		}
265 266
	}

J
Johannes Rieken 已提交
267
	openGlobalKeybindingSettings(textual: boolean): Promise<void> {
268 269 270 271
		type OpenKeybindingsClassification = {
			textual: { classification: 'SystemMetaData', purpose: 'FeatureInsight', isMeasurement: true };
		};
		this.telemetryService.publicLog2<{ textual: boolean }, OpenKeybindingsClassification>('openKeybindings', { textual });
S
Sandeep Somavarapu 已提交
272
		if (textual) {
273
			const emptyContents = '// ' + nls.localize('emptyKeybindingsHeader', "Place your key bindings in this file to override the defaults") + '\n[\n]';
S
Sandeep Somavarapu 已提交
274
			const editableKeybindings = this.environmentService.keybindingsResource;
N
Nilesh 已提交
275
			const openDefaultKeybindings = !!this.configurationService.getValue('workbench.settings.openDefaultKeybindings');
S
Sandeep Somavarapu 已提交
276 277

			// Create as needed and open in editor
S
Sandeep Somavarapu 已提交
278 279
			return this.createIfNotExists(editableKeybindings, emptyContents).then(() => {
				if (openDefaultKeybindings) {
N
Nilesh 已提交
280 281
					const activeEditorGroup = this.editorGroupService.activeGroup;
					const sideEditorGroup = this.editorGroupService.addGroup(activeEditorGroup.id, GroupDirection.RIGHT);
R
Rob Lourens 已提交
282
					return Promise.all([
S
Sandeep Somavarapu 已提交
283 284
						this.editorService.openEditor({ resource: this.defaultKeybindingsResource, options: { pinned: true, preserveFocus: true, revealIfOpened: true }, label: nls.localize('defaultKeybindings', "Default Keybindings"), description: '' }),
						this.editorService.openEditor({ resource: editableKeybindings, options: { pinned: true, revealIfOpened: true } }, sideEditorGroup.id)
R
Rob Lourens 已提交
285
					]).then(editors => undefined);
S
Sandeep Somavarapu 已提交
286
				} else {
R
Rob Lourens 已提交
287
					return this.editorService.openEditor({ resource: editableKeybindings, options: { pinned: true, revealIfOpened: true } }).then(() => undefined);
S
Sandeep Somavarapu 已提交
288
				}
S
Sandeep Somavarapu 已提交
289 290
			});
		}
291

S
Sandeep Somavarapu 已提交
292
		return this.editorService.openEditor(this.instantiationService.createInstance(KeybindingsEditorInput), { pinned: true, revealIfOpened: true }).then(() => undefined);
293 294
	}

295
	openDefaultKeybindingsFile(): Promise<IEditor | null> {
296
		return this.editorService.openEditor({ resource: this.defaultKeybindingsResource, label: nls.localize('defaultKeybindings', "Default Keybindings") });
N
Nilesh 已提交
297 298
	}

299
	configureSettingsForLanguage(language: string): void {
300
		this.openGlobalSettings(true)
S
Sandeep Somavarapu 已提交
301 302
			.then(editor => this.createPreferencesEditorModel(this.userSettingsResource)
				.then((settingsModel: IPreferencesEditorModel<ISetting>) => {
303
					const codeEditor = editor ? getCodeEditor(editor.getControl()) : null;
S
Sandeep Somavarapu 已提交
304
					if (codeEditor) {
S
Sandeep Somavarapu 已提交
305
						this.addLanguageOverrideEntry(language, settingsModel, codeEditor)
S
Sandeep Somavarapu 已提交
306
							.then(position => {
S
Sandeep Somavarapu 已提交
307
								if (codeEditor && position) {
S
Sandeep Somavarapu 已提交
308
									codeEditor.setPosition(position);
309
									codeEditor.revealLine(position.lineNumber);
S
Sandeep Somavarapu 已提交
310 311 312 313 314
									codeEditor.focus();
								}
							});
					}
				}));
315 316
	}

317
	private openOrSwitchSettings(configurationTarget: ConfigurationTarget, resource: URI, options?: ISettingsEditorOptions, group: IEditorGroup = this.editorGroupService.activeGroup): Promise<IEditor | null> {
B
Benjamin Pasero 已提交
318
		const editorInput = this.getActiveSettingsEditorInput(group);
S
Sandeep Somavarapu 已提交
319 320 321 322 323
		if (editorInput) {
			const editorInputResource = editorInput.master.getResource();
			if (editorInputResource && editorInputResource.fsPath !== resource.fsPath) {
				return this.doSwitchSettings(configurationTarget, resource, editorInput, group, options);
			}
324
		}
B
Benjamin Pasero 已提交
325
		return this.doOpenSettings(configurationTarget, resource, options, group);
326 327
	}

328
	private openOrSwitchSettings2(configurationTarget: ConfigurationTarget, folderUri?: URI, options?: ISettingsEditorOptions, group: IEditorGroup = this.editorGroupService.activeGroup): Promise<IEditor | null> {
329
		return this.doOpenSettings2(configurationTarget, folderUri, options, group);
330 331
	}

332
	private doOpenSettings(configurationTarget: ConfigurationTarget, resource: URI, options?: ISettingsEditorOptions, group?: IEditorGroup): Promise<IEditor | null> {
333 334 335 336 337
		const openSplitJSON = !!this.configurationService.getValue(USE_SPLIT_JSON_SETTING);
		if (openSplitJSON) {
			return this.doOpenSplitJSON(configurationTarget, resource, options, group);
		}

S
Sandeep Somavarapu 已提交
338
		const openDefaultSettings = !!this.configurationService.getValue(DEFAULT_SETTINGS_EDITOR_SETTING);
339

340
		return this.getOrCreateEditableSettingsEditorInput(configurationTarget, resource)
341
			.then(editableSettingsEditorInput => {
342 343 344
				if (!options) {
					options = { pinned: true };
				} else {
345
					options = assign(options, { pinned: true });
346 347
				}

348
				if (openDefaultSettings) {
349 350 351 352 353
					const activeEditorGroup = this.editorGroupService.activeGroup;
					const sideEditorGroup = this.editorGroupService.addGroup(activeEditorGroup.id, GroupDirection.RIGHT);
					return Promise.all([
						this.editorService.openEditor({ resource: this.defaultSettingsRawResource, options: { pinned: true, preserveFocus: true, revealIfOpened: true }, label: nls.localize('defaultSettings', "Default Settings"), description: '' }),
						this.editorService.openEditor(editableSettingsEditorInput, { pinned: true, revealIfOpened: true }, sideEditorGroup.id)
S
Sandeep Somavarapu 已提交
354
					]).then(([defaultEditor, editor]) => editor);
355 356
				} else {
					return this.editorService.openEditor(editableSettingsEditorInput, SettingsEditorOptions.create(options), group);
357
				}
358
			});
359 360
	}

361
	private doOpenSplitJSON(configurationTarget: ConfigurationTarget, resource: URI, options?: ISettingsEditorOptions, group?: IEditorGroup): Promise<IEditor | null> {
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
		return this.getOrCreateEditableSettingsEditorInput(configurationTarget, resource)
			.then(editableSettingsEditorInput => {
				if (!options) {
					options = { pinned: true };
				} else {
					options = assign(options, { pinned: true });
				}

				const defaultPreferencesEditorInput = this.instantiationService.createInstance(DefaultPreferencesEditorInput, this.getDefaultSettingsResource(configurationTarget));
				const preferencesEditorInput = new PreferencesEditorInput(this.getPreferencesEditorInputName(configurationTarget, resource), editableSettingsEditorInput.getDescription(), defaultPreferencesEditorInput, <EditorInput>editableSettingsEditorInput);
				this.lastOpenedSettingsInput = preferencesEditorInput;
				return this.editorService.openEditor(preferencesEditorInput, SettingsEditorOptions.create(options), group);
			});
	}

377
	public createSettings2EditorModel(): Settings2EditorModel {
R
Rob Lourens 已提交
378
		return this.instantiationService.createInstance(Settings2EditorModel, this.getDefaultSettings(ConfigurationTarget.USER_LOCAL));
379 380
	}

381
	private doOpenSettings2(target: ConfigurationTarget, folderUri: URI | undefined, options?: IEditorOptions, group?: IEditorGroup): Promise<IEditor | null> {
382 383 384 385 386 387 388 389
		const input = this.settingsEditor2Input;
		const settingsOptions: ISettingsEditorOptions = {
			...options,
			target,
			folderUri
		};

		return this.editorService.openEditor(input, SettingsEditorOptions.create(settingsOptions), group);
390 391
	}

J
Johannes Rieken 已提交
392
	private doSwitchSettings(target: ConfigurationTarget, resource: URI, input: PreferencesEditorInput, group: IEditorGroup, options?: ISettingsEditorOptions): Promise<IEditor> {
S
Sandeep Somavarapu 已提交
393 394 395 396 397
		const settingsURI = this.getEditableSettingsURI(target, resource);
		if (!settingsURI) {
			return Promise.reject(`Invalid settings URI - ${resource.toString()}`);
		}
		return this.getOrCreateEditableSettingsEditorInput(target, settingsURI)
398
			.then(toInput => {
B
Benjamin Pasero 已提交
399 400 401 402 403
				return group.openEditor(input).then(() => {
					const replaceWith = new PreferencesEditorInput(this.getPreferencesEditorInputName(target, resource), toInput.getDescription(), this.instantiationService.createInstance(DefaultPreferencesEditorInput, this.getDefaultSettingsResource(target)), toInput);

					return group.replaceEditors([{
						editor: input,
404
						replacement: replaceWith,
S
Sandeep Somavarapu 已提交
405
						options: options ? SettingsEditorOptions.create(options) : undefined
B
Benjamin Pasero 已提交
406 407
					}]).then(() => {
						this.lastOpenedSettingsInput = replaceWith;
S
Sandeep Somavarapu 已提交
408
						return group.activeControl!;
B
Benjamin Pasero 已提交
409
					});
410 411 412 413
				});
			});
	}

414
	private getActiveSettingsEditorInput(group: IEditorGroup = this.editorGroupService.activeGroup): PreferencesEditorInput {
B
Benjamin Pasero 已提交
415
		return <PreferencesEditorInput>group.editors.filter(e => e instanceof PreferencesEditorInput)[0];
416 417
	}

S
Sandeep Somavarapu 已提交
418 419
	private getConfigurationTargetFromSettingsResource(resource: URI): ConfigurationTarget {
		if (this.userSettingsResource.toString() === resource.toString()) {
R
Rob Lourens 已提交
420
			return ConfigurationTarget.USER_LOCAL;
S
Sandeep Somavarapu 已提交
421 422 423 424 425 426 427 428 429 430 431 432
		}

		const workspaceSettingsResource = this.workspaceSettingsResource;
		if (workspaceSettingsResource && workspaceSettingsResource.toString() === resource.toString()) {
			return ConfigurationTarget.WORKSPACE;
		}

		const folder = this.contextService.getWorkspaceFolder(resource);
		if (folder) {
			return ConfigurationTarget.WORKSPACE_FOLDER;
		}

R
Rob Lourens 已提交
433
		return ConfigurationTarget.USER_LOCAL;
S
Sandeep Somavarapu 已提交
434 435
	}

S
Sandeep Somavarapu 已提交
436
	private getConfigurationTargetFromDefaultSettingsResource(uri: URI) {
R
Rob Lourens 已提交
437 438 439 440 441
		return this.isDefaultWorkspaceSettingsResource(uri) ?
			ConfigurationTarget.WORKSPACE :
			this.isDefaultFolderSettingsResource(uri) ?
				ConfigurationTarget.WORKSPACE_FOLDER :
				ConfigurationTarget.USER_LOCAL;
S
Sandeep Somavarapu 已提交
442 443
	}

R
Rob Lourens 已提交
444
	private isDefaultSettingsResource(uri: URI): boolean {
S
Sandeep Somavarapu 已提交
445 446 447 448
		return this.isDefaultUserSettingsResource(uri) || this.isDefaultWorkspaceSettingsResource(uri) || this.isDefaultFolderSettingsResource(uri);
	}

	private isDefaultUserSettingsResource(uri: URI): boolean {
449
		return uri.authority === 'defaultsettings' && uri.scheme === network.Schemas.vscode && !!uri.path.match(/\/(\d+\/)?settings\.json$/);
R
Rob Lourens 已提交
450 451
	}

S
Sandeep Somavarapu 已提交
452 453 454 455 456
	private isDefaultWorkspaceSettingsResource(uri: URI): boolean {
		return uri.authority === 'defaultsettings' && uri.scheme === network.Schemas.vscode && !!uri.path.match(/\/(\d+\/)?workspaceSettings\.json$/);
	}

	private isDefaultFolderSettingsResource(uri: URI): boolean {
457
		return uri.authority === 'defaultsettings' && uri.scheme === network.Schemas.vscode && !!uri.path.match(/\/(\d+\/)?resourceSettings\.json$/);
R
Rob Lourens 已提交
458 459
	}

S
Sandeep Somavarapu 已提交
460
	private getDefaultSettingsResource(configurationTarget: ConfigurationTarget): URI {
S
Sandeep Somavarapu 已提交
461 462 463 464 465
		switch (configurationTarget) {
			case ConfigurationTarget.WORKSPACE:
				return URI.from({ scheme: network.Schemas.vscode, authority: 'defaultsettings', path: `/${this._defaultWorkspaceSettingsUriCounter++}/workspaceSettings.json` });
			case ConfigurationTarget.WORKSPACE_FOLDER:
				return URI.from({ scheme: network.Schemas.vscode, authority: 'defaultsettings', path: `/${this._defaultFolderSettingsUriCounter++}/resourceSettings.json` });
S
Sandeep Somavarapu 已提交
466
		}
S
Sandeep Somavarapu 已提交
467
		return URI.from({ scheme: network.Schemas.vscode, authority: 'defaultsettings', path: `/${this._defaultUserSettingsUriCounter++}/settings.json` });
S
Sandeep Somavarapu 已提交
468 469
	}

470 471
	private getPreferencesEditorInputName(target: ConfigurationTarget, resource: URI): string {
		const name = getSettingsTargetName(target, resource, this.contextService);
472
		return target === ConfigurationTarget.WORKSPACE_FOLDER ? nls.localize('folderSettingsName', "{0} (Folder Settings)", name) : name;
473 474
	}

J
Johannes Rieken 已提交
475
	private getOrCreateEditableSettingsEditorInput(target: ConfigurationTarget, resource: URI): Promise<EditorInput> {
476 477
		return this.createSettingsIfNotExists(target, resource)
			.then(() => <EditorInput>this.editorService.createInput({ resource }));
478 479
	}

J
Johannes Rieken 已提交
480
	private createEditableSettingsEditorModel(configurationTarget: ConfigurationTarget, resource: URI): Promise<SettingsEditorModel> {
481
		const settingsUri = this.getEditableSettingsURI(configurationTarget, resource);
482
		if (settingsUri) {
S
Sandeep Somavarapu 已提交
483 484 485 486
			const workspace = this.contextService.getWorkspace();
			if (workspace.configuration && workspace.configuration.toString() === settingsUri.toString()) {
				return this.textModelResolverService.createModelReference(settingsUri)
					.then(reference => this.instantiationService.createInstance(WorkspaceConfigurationEditorModel, reference, configurationTarget));
487
			}
488
			return this.textModelResolverService.createModelReference(settingsUri)
S
Sandeep Somavarapu 已提交
489
				.then(reference => this.instantiationService.createInstance(SettingsEditorModel, reference, configurationTarget));
490
		}
S
Sandeep Somavarapu 已提交
491
		return Promise.reject(`unknown target: ${configurationTarget} and resource: ${resource.toString()}`);
492 493
	}

J
Johannes Rieken 已提交
494
	private createDefaultSettingsEditorModel(defaultSettingsUri: URI): Promise<DefaultSettingsEditorModel> {
495 496
		return this.textModelResolverService.createModelReference(defaultSettingsUri)
			.then(reference => {
S
Sandeep Somavarapu 已提交
497 498
				const target = this.getConfigurationTargetFromDefaultSettingsResource(defaultSettingsUri);
				return this.instantiationService.createInstance(DefaultSettingsEditorModel, defaultSettingsUri, reference, this.getDefaultSettings(target));
499 500 501
			});
	}

S
Sandeep Somavarapu 已提交
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
	private getDefaultSettings(target: ConfigurationTarget): DefaultSettings {
		if (target === ConfigurationTarget.WORKSPACE) {
			if (!this._defaultWorkspaceSettingsContentModel) {
				this._defaultWorkspaceSettingsContentModel = new DefaultSettings(this.getMostCommonlyUsedSettings(), target);
			}
			return this._defaultWorkspaceSettingsContentModel;
		}
		if (target === ConfigurationTarget.WORKSPACE_FOLDER) {
			if (!this._defaultFolderSettingsContentModel) {
				this._defaultFolderSettingsContentModel = new DefaultSettings(this.getMostCommonlyUsedSettings(), target);
			}
			return this._defaultFolderSettingsContentModel;
		}
		if (!this._defaultUserSettingsContentModel) {
			this._defaultUserSettingsContentModel = new DefaultSettings(this.getMostCommonlyUsedSettings(), target);
517
		}
S
Sandeep Somavarapu 已提交
518
		return this._defaultUserSettingsContentModel;
519 520
	}

S
Sandeep Somavarapu 已提交
521
	private getEditableSettingsURI(configurationTarget: ConfigurationTarget, resource?: URI): URI | null {
522 523
		switch (configurationTarget) {
			case ConfigurationTarget.USER:
R
Rob Lourens 已提交
524
			case ConfigurationTarget.USER_LOCAL:
S
Sandeep Somavarapu 已提交
525
				return this.environmentService.settingsResource;
R
Rob Lourens 已提交
526
			case ConfigurationTarget.USER_REMOTE:
S
Sandeep Somavarapu 已提交
527
				return this.environmentService.settingsResource;
528
			case ConfigurationTarget.WORKSPACE:
529
				if (this.contextService.getWorkbenchState() === WorkbenchState.EMPTY) {
530 531
					return null;
				}
532
				const workspace = this.contextService.getWorkspace();
533
				return workspace.configuration || workspace.folders[0].toResource(FOLDER_SETTINGS_PATH);
534
			case ConfigurationTarget.WORKSPACE_FOLDER:
S
Sandeep Somavarapu 已提交
535 536 537 538
				if (resource) {
					const folder = this.contextService.getWorkspaceFolder(resource);
					return folder ? folder.toResource(FOLDER_SETTINGS_PATH) : null;
				}
539
		}
540
		return null;
541 542
	}

J
Johannes Rieken 已提交
543
	private createSettingsIfNotExists(target: ConfigurationTarget, resource: URI): Promise<void> {
544
		if (this.contextService.getWorkbenchState() === WorkbenchState.WORKSPACE && target === ConfigurationTarget.WORKSPACE) {
R
Rob Lourens 已提交
545 546
			const workspaceConfig = this.contextService.getWorkspace().configuration;
			if (!workspaceConfig) {
R
Rob Lourens 已提交
547
				return Promise.resolve(undefined);
R
Rob Lourens 已提交
548 549
			}

B
Benjamin Pasero 已提交
550
			return this.textFileService.read(workspaceConfig)
S
Sandeep Somavarapu 已提交
551 552
				.then(content => {
					if (Object.keys(parse(content.value)).indexOf('settings') === -1) {
R
Rob Lourens 已提交
553
						return this.jsonEditingService.write(resource, { key: 'settings', value: {} }, true).then(undefined, () => { });
S
Sandeep Somavarapu 已提交
554
					}
S
Sandeep Somavarapu 已提交
555
					return undefined;
S
Sandeep Somavarapu 已提交
556
				});
557
		}
S
Sandeep Somavarapu 已提交
558
		return this.createIfNotExists(resource, emptyEditableSettingsContent).then(() => { });
559 560
	}

J
Johannes Rieken 已提交
561
	private createIfNotExists(resource: URI, contents: string): Promise<any> {
B
Benjamin Pasero 已提交
562
		return this.textFileService.read(resource, { acceptTextOnly: true }).then(undefined, error => {
563
			if ((<FileOperationError>error).fileOperationResult === FileOperationResult.FILE_NOT_FOUND) {
B
Benjamin Pasero 已提交
564
				return this.textFileService.write(resource, contents).then(undefined, error => {
R
Rob Lourens 已提交
565
					return Promise.reject(new Error(nls.localize('fail.createSettings', "Unable to create '{0}' ({1}).", this.labelService.getUriLabel(resource, { relative: true }), error)));
566 567 568
				});
			}

R
Rob Lourens 已提交
569
			return Promise.reject(error);
570 571 572
		});
	}

573 574
	private getMostCommonlyUsedSettings(): string[] {
		return [
S
Sandeep Somavarapu 已提交
575
			'files.autoSave',
576
			'editor.fontSize',
S
Sandeep Somavarapu 已提交
577 578 579
			'editor.fontFamily',
			'editor.tabSize',
			'editor.renderWhitespace',
S
Sandeep Somavarapu 已提交
580
			'editor.cursorStyle',
581
			'editor.multiCursorModifier',
S
Sandeep Somavarapu 已提交
582
			'editor.insertSpaces',
583
			'editor.wordWrap',
584
			'files.exclude',
S
Sandeep Somavarapu 已提交
585
			'files.associations'
586
		];
S
Sandeep Somavarapu 已提交
587
	}
588

S
Sandeep Somavarapu 已提交
589
	private addLanguageOverrideEntry(language: string, settingsModel: IPreferencesEditorModel<ISetting>, codeEditor: ICodeEditor): Promise<IPosition | null> {
S
Sandeep Somavarapu 已提交
590 591 592
		const languageKey = `[${language}]`;
		let setting = settingsModel.getPreference(languageKey);
		const model = codeEditor.getModel();
S
Sandeep Somavarapu 已提交
593 594 595 596 597 598 599 600 601
		if (model) {
			const configuration = this.configurationService.getValue<{ editor: { tabSize: number; insertSpaces: boolean } }>();
			const eol = model.getEOL();
			if (setting) {
				if (setting.overrides && setting.overrides.length) {
					const lastSetting = setting.overrides[setting.overrides.length - 1];
					return Promise.resolve({ lineNumber: lastSetting.valueRange.endLineNumber, column: model.getLineMaxColumn(lastSetting.valueRange.endLineNumber) });
				}
				return Promise.resolve({ lineNumber: setting.valueRange.startLineNumber, column: setting.valueRange.startColumn + 1 });
S
Sandeep Somavarapu 已提交
602
			}
S
Sandeep Somavarapu 已提交
603 604 605 606 607 608 609 610 611 612 613 614 615
			return this.configurationService.updateValue(languageKey, {}, ConfigurationTarget.USER)
				.then(() => {
					setting = settingsModel.getPreference(languageKey);
					if (setting) {
						let content = eol + this.spaces(2, configuration.editor) + eol + this.spaces(1, configuration.editor);
						let editOperation = EditOperation.insert(new Position(setting.valueRange.endLineNumber, setting.valueRange.endColumn - 1), content);
						model.pushEditOperations([], [editOperation], () => []);
						let lineNumber = setting.valueRange.endLineNumber + 1;
						settingsModel.dispose();
						return { lineNumber, column: model.getLineMaxColumn(lineNumber) };
					}
					return null;
				});
S
Sandeep Somavarapu 已提交
616
		}
S
Sandeep Somavarapu 已提交
617
		return Promise.resolve(null);
618 619
	}

A
Alex Dima 已提交
620
	private spaces(count: number, { tabSize, insertSpaces }: { tabSize: number; insertSpaces: boolean }): string {
621 622 623
		return insertSpaces ? strings.repeat(' ', tabSize * count) : strings.repeat('\t', count);
	}

624
	public dispose(): void {
625
		this._onDispose.fire();
626 627
		super.dispose();
	}
628
}
629

S
Sandeep Somavarapu 已提交
630
registerSingleton(IPreferencesService, PreferencesService);