1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
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
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
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
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
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
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { URI } from 'vs/base/common/uri';
import { Event, Emitter } from 'vs/base/common/event';
import { ResourceMap } from 'vs/base/common/map';
import { equals } from 'vs/base/common/objects';
import { Disposable, DisposableStore } from 'vs/base/common/lifecycle';
import { Queue, Barrier, runWhenIdle, Promises } from 'vs/base/common/async';
import { IJSONContributionRegistry, Extensions as JSONExtensions } from 'vs/platform/jsonschemas/common/jsonContributionRegistry';
import { IWorkspaceContextService, Workspace as BaseWorkspace, WorkbenchState, IWorkspaceFolder, IWorkspaceFoldersChangeEvent, WorkspaceFolder, toWorkspaceFolder, isWorkspaceFolder, IWorkspaceFoldersWillChangeEvent, IEmptyWorkspaceIdentifier, ISingleFolderWorkspaceIdentifier, isSingleFolderWorkspaceIdentifier, isWorkspaceIdentifier, IWorkspaceIdentifier, IAnyWorkspaceIdentifier } from 'vs/platform/workspace/common/workspace';
import { ConfigurationModel, ConfigurationChangeEvent, AllKeysConfigurationChangeEvent, mergeChanges } from 'vs/platform/configuration/common/configurationModels';
import { IConfigurationChangeEvent, ConfigurationTarget, IConfigurationOverrides, isConfigurationOverrides, IConfigurationData, IConfigurationValue, IConfigurationChange, ConfigurationTargetToString, IConfigurationUpdateOverrides, isConfigurationUpdateOverrides, IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { IPolicyConfiguration, NullPolicyConfiguration, PolicyConfiguration } from 'vs/platform/configuration/common/configurations';
import { Configuration } from 'vs/workbench/services/configuration/common/configurationModels';
import { FOLDER_CONFIG_FOLDER_NAME, defaultSettingsSchemaId, userSettingsSchemaId, workspaceSettingsSchemaId, folderSettingsSchemaId, IConfigurationCache, machineSettingsSchemaId, LOCAL_MACHINE_SCOPES, IWorkbenchConfigurationService, RestrictedSettings, PROFILE_SCOPES, LOCAL_MACHINE_PROFILE_SCOPES, profileSettingsSchemaId } from 'vs/workbench/services/configuration/common/configuration';
import { Registry } from 'vs/platform/registry/common/platform';
import { IConfigurationRegistry, Extensions, allSettings, windowSettings, resourceSettings, applicationSettings, machineSettings, machineOverridableSettings, ConfigurationScope, IConfigurationPropertySchema, keyFromOverrideIdentifiers, OVERRIDE_PROPERTY_PATTERN, resourceLanguageSettingsSchemaId, configurationDefaultsSchemaId } from 'vs/platform/configuration/common/configurationRegistry';
import { IStoredWorkspaceFolder, isStoredWorkspaceFolder, IWorkspaceFolderCreationData, useSlashForPath, getStoredWorkspaceFolder, toWorkspaceFolders } from 'vs/platform/workspaces/common/workspaces';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { ConfigurationEditingService, EditableConfigurationTarget } from 'vs/workbench/services/configuration/common/configurationEditingService';
import { WorkspaceConfiguration, FolderConfiguration, RemoteUserConfiguration, UserConfiguration, DefaultConfiguration } from 'vs/workbench/services/configuration/browser/configuration';
import { JSONEditingService } from 'vs/workbench/services/configuration/common/jsonEditingService';
import { IJSONSchema, IJSONSchemaMap } from 'vs/base/common/jsonSchema';
import { mark } from 'vs/base/common/performance';
import { IRemoteAgentService } from 'vs/workbench/services/remote/common/remoteAgentService';
import { FileOperationError, FileOperationResult, IFileService } from 'vs/platform/files/common/files';
import { IWorkbenchEnvironmentService } from 'vs/workbench/services/environment/common/environmentService';
import { IWorkbenchContribution, IWorkbenchContributionsRegistry, Extensions as WorkbenchExtensions } from 'vs/workbench/common/contributions';
import { LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle';
import { ILogService } from 'vs/platform/log/common/log';
import { toErrorMessage } from 'vs/base/common/errorMessage';
import { IUriIdentityService } from 'vs/platform/uriIdentity/common/uriIdentity';
import { IWorkspaceTrustManagementService } from 'vs/platform/workspace/common/workspaceTrust';
import { delta, distinct } from 'vs/base/common/arrays';
import { IStringDictionary } from 'vs/base/common/collections';
import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions';
import { IWorkbenchAssignmentService } from 'vs/workbench/services/assignment/common/assignmentService';
import { isUndefined } from 'vs/base/common/types';
import { localize } from 'vs/nls';
import { DidChangeUserDataProfileEvent, IUserDataProfileService } from 'vs/workbench/services/userDataProfile/common/userDataProfile';
import { IPolicyService, NullPolicyService } from 'vs/platform/policy/common/policy';
import { IUserDataProfile, IUserDataProfilesService } from 'vs/platform/userDataProfile/common/userDataProfile';
import { updateIgnoredSettings } from 'vs/platform/userDataSync/common/settingsMerge';
import { VSBuffer } from 'vs/base/common/buffer';
function getLocalUserConfigurationScopes(userDataProfile: IUserDataProfile, hasRemote: boolean): ConfigurationScope[] | undefined {
return userDataProfile.isDefault
? hasRemote ? LOCAL_MACHINE_SCOPES : undefined
: hasRemote ? LOCAL_MACHINE_PROFILE_SCOPES : PROFILE_SCOPES;
}
class Workspace extends BaseWorkspace {
initialized: boolean = false;
}
export class WorkspaceService extends Disposable implements IWorkbenchConfigurationService, IWorkspaceContextService {
public _serviceBrand: undefined;
private workspace!: Workspace;
private initRemoteUserConfigurationBarrier: Barrier;
private completeWorkspaceBarrier: Barrier;
private readonly configurationCache: IConfigurationCache;
private _configuration: Configuration;
private initialized: boolean = false;
private readonly defaultConfiguration: DefaultConfiguration;
private readonly policyConfiguration: IPolicyConfiguration;
private applicationConfiguration: UserConfiguration | null = null;
private readonly applicationConfigurationDisposables: DisposableStore;
private readonly localUserConfiguration: UserConfiguration;
private readonly remoteUserConfiguration: RemoteUserConfiguration | null = null;
private readonly workspaceConfiguration: WorkspaceConfiguration;
private cachedFolderConfigs: ResourceMap<FolderConfiguration>;
private readonly workspaceEditingQueue: Queue<void>;
private readonly _onDidChangeConfiguration: Emitter<IConfigurationChangeEvent> = this._register(new Emitter<IConfigurationChangeEvent>());
public readonly onDidChangeConfiguration: Event<IConfigurationChangeEvent> = this._onDidChangeConfiguration.event;
protected readonly _onWillChangeWorkspaceFolders: Emitter<IWorkspaceFoldersWillChangeEvent> = this._register(new Emitter<IWorkspaceFoldersWillChangeEvent>());
public readonly onWillChangeWorkspaceFolders: Event<IWorkspaceFoldersWillChangeEvent> = this._onWillChangeWorkspaceFolders.event;
private readonly _onDidChangeWorkspaceFolders: Emitter<IWorkspaceFoldersChangeEvent> = this._register(new Emitter<IWorkspaceFoldersChangeEvent>());
public readonly onDidChangeWorkspaceFolders: Event<IWorkspaceFoldersChangeEvent> = this._onDidChangeWorkspaceFolders.event;
private readonly _onDidChangeWorkspaceName: Emitter<void> = this._register(new Emitter<void>());
public readonly onDidChangeWorkspaceName: Event<void> = this._onDidChangeWorkspaceName.event;
private readonly _onDidChangeWorkbenchState: Emitter<WorkbenchState> = this._register(new Emitter<WorkbenchState>());
public readonly onDidChangeWorkbenchState: Event<WorkbenchState> = this._onDidChangeWorkbenchState.event;
private isWorkspaceTrusted: boolean = true;
private _restrictedSettings: RestrictedSettings = { default: [] };
get restrictedSettings() { return this._restrictedSettings; }
private readonly _onDidChangeRestrictedSettings = this._register(new Emitter<RestrictedSettings>());
public readonly onDidChangeRestrictedSettings = this._onDidChangeRestrictedSettings.event;
private readonly configurationRegistry: IConfigurationRegistry;
// TODO@sandeep debt with cyclic dependencies
private configurationEditingService!: ConfigurationEditingService;
private jsonEditingService!: JSONEditingService;
private cyclicDependencyReady!: Function;
private cyclicDependency = new Promise<void>(resolve => this.cyclicDependencyReady = resolve);
constructor(
{ remoteAuthority, configurationCache }: { remoteAuthority?: string; configurationCache: IConfigurationCache },
environmentService: IWorkbenchEnvironmentService,
private readonly userDataProfileService: IUserDataProfileService,
private readonly userDataProfilesService: IUserDataProfilesService,
private readonly fileService: IFileService,
remoteAgentService: IRemoteAgentService,
private readonly uriIdentityService: IUriIdentityService,
private readonly logService: ILogService,
policyService: IPolicyService
) {
super();
this.configurationRegistry = Registry.as<IConfigurationRegistry>(Extensions.Configuration);
this.initRemoteUserConfigurationBarrier = new Barrier();
this.completeWorkspaceBarrier = new Barrier();
this.defaultConfiguration = this._register(new DefaultConfiguration(configurationCache, environmentService));
this.policyConfiguration = policyService instanceof NullPolicyService ? new NullPolicyConfiguration() : this._register(new PolicyConfiguration(this.defaultConfiguration, policyService, logService));
this.configurationCache = configurationCache;
this._configuration = new Configuration(this.defaultConfiguration.configurationModel, this.policyConfiguration.configurationModel, new ConfigurationModel(), new ConfigurationModel(), new ConfigurationModel(), new ConfigurationModel(), new ResourceMap(), new ConfigurationModel(), new ResourceMap<ConfigurationModel>(), this.workspace);
this.applicationConfigurationDisposables = this._register(new DisposableStore());
this.createApplicationConfiguration();
this.localUserConfiguration = this._register(new UserConfiguration(userDataProfileService.currentProfile.settingsResource, userDataProfileService.currentProfile.tasksResource, getLocalUserConfigurationScopes(userDataProfileService.currentProfile, !!remoteAuthority), fileService, uriIdentityService, logService));
this.cachedFolderConfigs = new ResourceMap<FolderConfiguration>();
this._register(this.localUserConfiguration.onDidChangeConfiguration(userConfiguration => this.onLocalUserConfigurationChanged(userConfiguration)));
if (remoteAuthority) {
const remoteUserConfiguration = this.remoteUserConfiguration = this._register(new RemoteUserConfiguration(remoteAuthority, configurationCache, fileService, uriIdentityService, remoteAgentService));
this._register(remoteUserConfiguration.onDidInitialize(remoteUserConfigurationModel => {
this._register(remoteUserConfiguration.onDidChangeConfiguration(remoteUserConfigurationModel => this.onRemoteUserConfigurationChanged(remoteUserConfigurationModel)));
this.onRemoteUserConfigurationChanged(remoteUserConfigurationModel);
this.initRemoteUserConfigurationBarrier.open();
}));
} else {
this.initRemoteUserConfigurationBarrier.open();
}
this.workspaceConfiguration = this._register(new WorkspaceConfiguration(configurationCache, fileService, uriIdentityService, logService));
this._register(this.workspaceConfiguration.onDidUpdateConfiguration(fromCache => {
this.onWorkspaceConfigurationChanged(fromCache).then(() => {
this.workspace.initialized = this.workspaceConfiguration.initialized;
this.checkAndMarkWorkspaceComplete(fromCache);
});
}));
this._register(this.defaultConfiguration.onDidChangeConfiguration(({ properties, defaults }) => this.onDefaultConfigurationChanged(defaults, properties)));
this._register(this.policyConfiguration.onDidChangeConfiguration(configurationModel => this.onPolicyConfigurationChanged(configurationModel)));
this._register(userDataProfileService.onDidChangeCurrentProfile(e => this.onUserDataProfileChanged(e)));
this.workspaceEditingQueue = new Queue<void>();
}
private createApplicationConfiguration(): void {
this.applicationConfigurationDisposables.clear();
if (this.userDataProfileService.currentProfile.isDefault) {
this.applicationConfiguration = null;
} else {
this.applicationConfiguration = this.applicationConfigurationDisposables.add(this._register(new UserConfiguration(this.userDataProfilesService.defaultProfile.settingsResource, undefined, [ConfigurationScope.APPLICATION], this.fileService, this.uriIdentityService, this.logService)));
this.applicationConfigurationDisposables.add(this.applicationConfiguration.onDidChangeConfiguration(configurationModel => this.onApplicationConfigurationChanged(configurationModel)));
}
}
// Workspace Context Service Impl
public async getCompleteWorkspace(): Promise<Workspace> {
await this.completeWorkspaceBarrier.wait();
return this.getWorkspace();
}
public getWorkspace(): Workspace {
return this.workspace;
}
public getWorkbenchState(): WorkbenchState {
// Workspace has configuration file
if (this.workspace.configuration) {
return WorkbenchState.WORKSPACE;
}
// Folder has single root
if (this.workspace.folders.length === 1) {
return WorkbenchState.FOLDER;
}
// Empty
return WorkbenchState.EMPTY;
}
public getWorkspaceFolder(resource: URI): IWorkspaceFolder | null {
return this.workspace.getFolder(resource);
}
public addFolders(foldersToAdd: IWorkspaceFolderCreationData[], index?: number): Promise<void> {
return this.updateFolders(foldersToAdd, [], index);
}
public removeFolders(foldersToRemove: URI[]): Promise<void> {
return this.updateFolders([], foldersToRemove);
}
public async updateFolders(foldersToAdd: IWorkspaceFolderCreationData[], foldersToRemove: URI[], index?: number): Promise<void> {
await this.cyclicDependency;
return this.workspaceEditingQueue.queue(() => this.doUpdateFolders(foldersToAdd, foldersToRemove, index));
}
public isInsideWorkspace(resource: URI): boolean {
return !!this.getWorkspaceFolder(resource);
}
public isCurrentWorkspace(workspaceIdOrFolder: IWorkspaceIdentifier | ISingleFolderWorkspaceIdentifier | URI): boolean {
switch (this.getWorkbenchState()) {
case WorkbenchState.FOLDER: {
let folderUri: URI | undefined = undefined;
if (URI.isUri(workspaceIdOrFolder)) {
folderUri = workspaceIdOrFolder;
} else if (isSingleFolderWorkspaceIdentifier(workspaceIdOrFolder)) {
folderUri = workspaceIdOrFolder.uri;
}
return URI.isUri(folderUri) && this.uriIdentityService.extUri.isEqual(folderUri, this.workspace.folders[0].uri);
}
case WorkbenchState.WORKSPACE:
return isWorkspaceIdentifier(workspaceIdOrFolder) && this.workspace.id === workspaceIdOrFolder.id;
}
return false;
}
private async doUpdateFolders(foldersToAdd: IWorkspaceFolderCreationData[], foldersToRemove: URI[], index?: number): Promise<void> {
if (this.getWorkbenchState() !== WorkbenchState.WORKSPACE) {
return Promise.resolve(undefined); // we need a workspace to begin with
}
if (foldersToAdd.length + foldersToRemove.length === 0) {
return Promise.resolve(undefined); // nothing to do
}
let foldersHaveChanged = false;
// Remove first (if any)
let currentWorkspaceFolders = this.getWorkspace().folders;
let newStoredFolders: IStoredWorkspaceFolder[] = currentWorkspaceFolders.map(f => f.raw).filter((folder, index): folder is IStoredWorkspaceFolder => {
if (!isStoredWorkspaceFolder(folder)) {
return true; // keep entries which are unrelated
}
return !this.contains(foldersToRemove, currentWorkspaceFolders[index].uri); // keep entries which are unrelated
});
const slashForPath = useSlashForPath(newStoredFolders);
foldersHaveChanged = currentWorkspaceFolders.length !== newStoredFolders.length;
// Add afterwards (if any)
if (foldersToAdd.length) {
// Recompute current workspace folders if we have folders to add
const workspaceConfigPath = this.getWorkspace().configuration!;
const workspaceConfigFolder = this.uriIdentityService.extUri.dirname(workspaceConfigPath);
currentWorkspaceFolders = toWorkspaceFolders(newStoredFolders, workspaceConfigPath, this.uriIdentityService.extUri);
const currentWorkspaceFolderUris = currentWorkspaceFolders.map(folder => folder.uri);
const storedFoldersToAdd: IStoredWorkspaceFolder[] = [];
for (const folderToAdd of foldersToAdd) {
const folderURI = folderToAdd.uri;
if (this.contains(currentWorkspaceFolderUris, folderURI)) {
continue; // already existing
}
try {
const result = await this.fileService.stat(folderURI);
if (!result.isDirectory) {
continue;
}
} catch (e) { /* Ignore */ }
storedFoldersToAdd.push(getStoredWorkspaceFolder(folderURI, false, folderToAdd.name, workspaceConfigFolder, slashForPath, this.uriIdentityService.extUri));
}
// Apply to array of newStoredFolders
if (storedFoldersToAdd.length > 0) {
foldersHaveChanged = true;
if (typeof index === 'number' && index >= 0 && index < newStoredFolders.length) {
newStoredFolders = newStoredFolders.slice(0);
newStoredFolders.splice(index, 0, ...storedFoldersToAdd);
} else {
newStoredFolders = [...newStoredFolders, ...storedFoldersToAdd];
}
}
}
// Set folders if we recorded a change
if (foldersHaveChanged) {
return this.setFolders(newStoredFolders);
}
return Promise.resolve(undefined);
}
private async setFolders(folders: IStoredWorkspaceFolder[]): Promise<void> {
await this.cyclicDependency;
await this.workspaceConfiguration.setFolders(folders, this.jsonEditingService);
return this.onWorkspaceConfigurationChanged(false);
}
private contains(resources: URI[], toCheck: URI): boolean {
return resources.some(resource => this.uriIdentityService.extUri.isEqual(resource, toCheck));
}
// Workspace Configuration Service Impl
getConfigurationData(): IConfigurationData {
return this._configuration.toData();
}
getValue<T>(): T;
getValue<T>(section: string): T;
getValue<T>(overrides: IConfigurationOverrides): T;
getValue<T>(section: string, overrides: IConfigurationOverrides): T;
getValue(arg1?: any, arg2?: any): any {
const section = typeof arg1 === 'string' ? arg1 : undefined;
const overrides = isConfigurationOverrides(arg1) ? arg1 : isConfigurationOverrides(arg2) ? arg2 : undefined;
return this._configuration.getValue(section, overrides);
}
updateValue(key: string, value: any): Promise<void>;
updateValue(key: string, value: any, overrides: IConfigurationOverrides | IConfigurationUpdateOverrides): Promise<void>;
updateValue(key: string, value: any, target: ConfigurationTarget): Promise<void>;
updateValue(key: string, value: any, overrides: IConfigurationOverrides | IConfigurationUpdateOverrides, target: ConfigurationTarget, donotNotifyError?: boolean): Promise<void>;
async updateValue(key: string, value: any, arg3?: any, arg4?: any, donotNotifyError?: any): Promise<void> {
await this.cyclicDependency;
const overrides: IConfigurationUpdateOverrides | undefined = isConfigurationUpdateOverrides(arg3) ? arg3
: isConfigurationOverrides(arg3) ? { resource: arg3.resource, overrideIdentifiers: arg3.overrideIdentifier ? [arg3.overrideIdentifier] : undefined } : undefined;
const target: ConfigurationTarget | undefined = overrides ? arg4 : arg3;
const targets: ConfigurationTarget[] = target ? [target] : [];
if (overrides?.overrideIdentifiers) {
overrides.overrideIdentifiers = distinct(overrides.overrideIdentifiers);
overrides.overrideIdentifiers = overrides.overrideIdentifiers.length ? overrides.overrideIdentifiers : undefined;
}
if (!targets.length) {
if (overrides?.overrideIdentifiers && overrides.overrideIdentifiers.length > 1) {
throw new Error('Configuration Target is required while updating the value for multiple override identifiers');
}
const inspect = this.inspect(key, { resource: overrides?.resource, overrideIdentifier: overrides?.overrideIdentifiers ? overrides.overrideIdentifiers[0] : undefined });
targets.push(...this.deriveConfigurationTargets(key, value, inspect));
// Remove the setting, if the value is same as default value and is updated only in user target
if (equals(value, inspect.defaultValue) && targets.length === 1 && (targets[0] === ConfigurationTarget.USER || targets[0] === ConfigurationTarget.USER_LOCAL)) {
value = undefined;
}
}
await Promises.settled(targets.map(target => this.writeConfigurationValue(key, value, target, overrides, donotNotifyError)));
}
async reloadConfiguration(target?: ConfigurationTarget | IWorkspaceFolder): Promise<void> {
if (target === undefined) {
this.reloadDefaultConfiguration();
const application = await this.reloadApplicationConfiguration(true);
const { local, remote } = await this.reloadUserConfiguration();
await this.reloadWorkspaceConfiguration();
await this.loadConfiguration(application, local, remote);
return;
}
if (isWorkspaceFolder(target)) {
await this.reloadWorkspaceFolderConfiguration(target);
return;
}
switch (target) {
case ConfigurationTarget.DEFAULT:
this.reloadDefaultConfiguration();
return;
case ConfigurationTarget.USER: {
const { local, remote } = await this.reloadUserConfiguration();
await this.loadConfiguration(this._configuration.applicationConfiguration, local, remote);
return;
}
case ConfigurationTarget.USER_LOCAL:
await this.reloadLocalUserConfiguration();
return;
case ConfigurationTarget.USER_REMOTE:
await this.reloadRemoteUserConfiguration();
return;
case ConfigurationTarget.WORKSPACE:
case ConfigurationTarget.WORKSPACE_FOLDER:
await this.reloadWorkspaceConfiguration();
return;
}
}
inspect<T>(key: string, overrides?: IConfigurationOverrides): IConfigurationValue<T> {
return this._configuration.inspect<T>(key, overrides);
}
keys(): {
default: string[];
user: string[];
workspace: string[];
workspaceFolder: string[];
} {
return this._configuration.keys();
}
public async whenRemoteConfigurationLoaded(): Promise<void> {
await this.initRemoteUserConfigurationBarrier.wait();
}
/**
* At present, all workspaces (empty, single-folder, multi-root) in local and remote
* can be initialized without requiring extension host except following case:
*
* A multi root workspace with .code-workspace file that has to be resolved by an extension.
* Because of readonly `rootPath` property in extension API we have to resolve multi root workspace
* before extension host starts so that `rootPath` can be set to first folder.
*
* This restriction is lifted partially for web in `MainThreadWorkspace`.
* In web, we start extension host with empty `rootPath` in this case.
*
* Related root path issue discussion is being tracked here - https://github.com/microsoft/vscode/issues/69335
*/
async initialize(arg: IAnyWorkspaceIdentifier): Promise<void> {
mark('code/willInitWorkspaceService');
const workspace = await this.createWorkspace(arg);
await this.updateWorkspaceAndInitializeConfiguration(workspace);
this.checkAndMarkWorkspaceComplete(false);
mark('code/didInitWorkspaceService');
}
updateWorkspaceTrust(trusted: boolean): void {
if (this.isWorkspaceTrusted !== trusted) {
this.isWorkspaceTrusted = trusted;
const data = this._configuration.toData();
const folderConfigurationModels: (ConfigurationModel | undefined)[] = [];
for (const folder of this.workspace.folders) {
const folderConfiguration = this.cachedFolderConfigs.get(folder.uri);
let configurationModel: ConfigurationModel | undefined;
if (folderConfiguration) {
configurationModel = folderConfiguration.updateWorkspaceTrust(this.isWorkspaceTrusted);
this._configuration.updateFolderConfiguration(folder.uri, configurationModel);
}
folderConfigurationModels.push(configurationModel);
}
if (this.getWorkbenchState() === WorkbenchState.FOLDER) {
if (folderConfigurationModels[0]) {
this._configuration.updateWorkspaceConfiguration(folderConfigurationModels[0]);
}
} else {
this._configuration.updateWorkspaceConfiguration(this.workspaceConfiguration.updateWorkspaceTrust(this.isWorkspaceTrusted));
}
this.updateRestrictedSettings();
let keys: string[] = [];
if (this.restrictedSettings.userLocal) {
keys.push(...this.restrictedSettings.userLocal);
}
if (this.restrictedSettings.userRemote) {
keys.push(...this.restrictedSettings.userRemote);
}
if (this.restrictedSettings.workspace) {
keys.push(...this.restrictedSettings.workspace);
}
this.restrictedSettings.workspaceFolder?.forEach((value) => keys.push(...value));
keys = distinct(keys);
if (keys.length) {
this.triggerConfigurationChange({ keys, overrides: [] }, { data, workspace: this.workspace }, ConfigurationTarget.WORKSPACE);
}
}
}
acquireInstantiationService(instantiationService: IInstantiationService): void {
this.configurationEditingService = instantiationService.createInstance(ConfigurationEditingService);
this.jsonEditingService = instantiationService.createInstance(JSONEditingService);
if (this.cyclicDependencyReady) {
this.cyclicDependencyReady();
} else {
this.cyclicDependency = Promise.resolve(undefined);
}
}
private async createWorkspace(arg: IAnyWorkspaceIdentifier): Promise<Workspace> {
if (isWorkspaceIdentifier(arg)) {
return this.createMultiFolderWorkspace(arg);
}
if (isSingleFolderWorkspaceIdentifier(arg)) {
return this.createSingleFolderWorkspace(arg);
}
return this.createEmptyWorkspace(arg);
}
private async createMultiFolderWorkspace(workspaceIdentifier: IWorkspaceIdentifier): Promise<Workspace> {
await this.workspaceConfiguration.initialize({ id: workspaceIdentifier.id, configPath: workspaceIdentifier.configPath }, this.isWorkspaceTrusted);
const workspaceConfigPath = workspaceIdentifier.configPath;
const workspaceFolders = toWorkspaceFolders(this.workspaceConfiguration.getFolders(), workspaceConfigPath, this.uriIdentityService.extUri);
const workspaceId = workspaceIdentifier.id;
const workspace = new Workspace(workspaceId, workspaceFolders, this.workspaceConfiguration.isTransient(), workspaceConfigPath, uri => this.uriIdentityService.extUri.ignorePathCasing(uri));
workspace.initialized = this.workspaceConfiguration.initialized;
return workspace;
}
private createSingleFolderWorkspace(singleFolderWorkspaceIdentifier: ISingleFolderWorkspaceIdentifier): Workspace {
const workspace = new Workspace(singleFolderWorkspaceIdentifier.id, [toWorkspaceFolder(singleFolderWorkspaceIdentifier.uri)], false, null, uri => this.uriIdentityService.extUri.ignorePathCasing(uri));
workspace.initialized = true;
return workspace;
}
private createEmptyWorkspace(emptyWorkspaceIdentifier: IEmptyWorkspaceIdentifier): Promise<Workspace> {
const workspace = new Workspace(emptyWorkspaceIdentifier.id, [], false, null, uri => this.uriIdentityService.extUri.ignorePathCasing(uri));
workspace.initialized = true;
return Promise.resolve(workspace);
}
private checkAndMarkWorkspaceComplete(fromCache: boolean): void {
if (!this.completeWorkspaceBarrier.isOpen() && this.workspace.initialized) {
this.completeWorkspaceBarrier.open();
this.validateWorkspaceFoldersAndReload(fromCache);
}
}
private async updateWorkspaceAndInitializeConfiguration(workspace: Workspace): Promise<void> {
const hasWorkspaceBefore = !!this.workspace;
let previousState: WorkbenchState | undefined;
let previousWorkspacePath: string | undefined;
let previousFolders: WorkspaceFolder[] = [];
if (hasWorkspaceBefore) {
previousState = this.getWorkbenchState();
previousWorkspacePath = this.workspace.configuration ? this.workspace.configuration.fsPath : undefined;
previousFolders = this.workspace.folders;
this.workspace.update(workspace);
} else {
this.workspace = workspace;
}
await this.initializeConfiguration();
// Trigger changes after configuration initialization so that configuration is up to date.
if (hasWorkspaceBefore) {
const newState = this.getWorkbenchState();
if (previousState && newState !== previousState) {
this._onDidChangeWorkbenchState.fire(newState);
}
const newWorkspacePath = this.workspace.configuration ? this.workspace.configuration.fsPath : undefined;
if (previousWorkspacePath && newWorkspacePath !== previousWorkspacePath || newState !== previousState) {
this._onDidChangeWorkspaceName.fire();
}
const folderChanges = this.compareFolders(previousFolders, this.workspace.folders);
if (folderChanges && (folderChanges.added.length || folderChanges.removed.length || folderChanges.changed.length)) {
await this.handleWillChangeWorkspaceFolders(folderChanges, false);
this._onDidChangeWorkspaceFolders.fire(folderChanges);
}
}
if (!this.localUserConfiguration.hasTasksLoaded) {
// Reload local user configuration again to load user tasks
this._register(runWhenIdle(() => this.reloadLocalUserConfiguration(), 5000));
}
}
private compareFolders(currentFolders: IWorkspaceFolder[], newFolders: IWorkspaceFolder[]): IWorkspaceFoldersChangeEvent {
const result: IWorkspaceFoldersChangeEvent = { added: [], removed: [], changed: [] };
result.added = newFolders.filter(newFolder => !currentFolders.some(currentFolder => newFolder.uri.toString() === currentFolder.uri.toString()));
for (let currentIndex = 0; currentIndex < currentFolders.length; currentIndex++) {
const currentFolder = currentFolders[currentIndex];
let newIndex = 0;
for (newIndex = 0; newIndex < newFolders.length && currentFolder.uri.toString() !== newFolders[newIndex].uri.toString(); newIndex++) { }
if (newIndex < newFolders.length) {
if (currentIndex !== newIndex || currentFolder.name !== newFolders[newIndex].name) {
result.changed.push(currentFolder);
}
} else {
result.removed.push(currentFolder);
}
}
return result;
}
private async initializeConfiguration(): Promise<void> {
await this.defaultConfiguration.initialize();
const [, application, user] = await Promise.all([
this.policyConfiguration.initialize(),
this.initializeApplicationConfiguration(),
(async () => {
mark('code/willInitUserConfiguration');
const result = await this.initializeUserConfiguration();
mark('code/didInitUserConfiguration');
return result;
})()
]);
mark('code/willInitWorkspaceConfiguration');
await this.loadConfiguration(application, user.local, user.remote);
mark('code/didInitWorkspaceConfiguration');
}
private async initializeApplicationConfiguration(): Promise<ConfigurationModel> {
return this.applicationConfiguration ? this.applicationConfiguration.initialize() : Promise.resolve(new ConfigurationModel());
}
private async initializeUserConfiguration(): Promise<{ local: ConfigurationModel; remote: ConfigurationModel }> {
const [local, remote] = await Promise.all([this.localUserConfiguration.initialize(), this.remoteUserConfiguration ? this.remoteUserConfiguration.initialize() : Promise.resolve(new ConfigurationModel())]);
return { local, remote };
}
private reloadDefaultConfiguration(): void {
this.onDefaultConfigurationChanged(this.defaultConfiguration.reload());
}
private async reloadApplicationConfiguration(donotTrigger?: boolean): Promise<ConfigurationModel> {
if (!this.applicationConfiguration) {
return new ConfigurationModel();
}
const model = await this.applicationConfiguration.reload();
if (!donotTrigger) {
this.onApplicationConfigurationChanged(model);
}
return model;
}
private async reloadUserConfiguration(): Promise<{ local: ConfigurationModel; remote: ConfigurationModel }> {
const [local, remote] = await Promise.all([this.reloadLocalUserConfiguration(true), this.reloadRemoteUserConfiguration(true)]);
return { local, remote };
}
async reloadLocalUserConfiguration(donotTrigger?: boolean): Promise<ConfigurationModel> {
const model = await this.localUserConfiguration.reload();
if (!donotTrigger) {
this.onLocalUserConfigurationChanged(model);
}
return model;
}
private async reloadRemoteUserConfiguration(donotTrigger?: boolean): Promise<ConfigurationModel> {
if (this.remoteUserConfiguration) {
const model = await this.remoteUserConfiguration.reload();
if (!donotTrigger) {
this.onRemoteUserConfigurationChanged(model);
}
return model;
}
return new ConfigurationModel();
}
private async reloadWorkspaceConfiguration(): Promise<void> {
const workbenchState = this.getWorkbenchState();
if (workbenchState === WorkbenchState.FOLDER) {
return this.onWorkspaceFolderConfigurationChanged(this.workspace.folders[0]);
}
if (workbenchState === WorkbenchState.WORKSPACE) {
return this.workspaceConfiguration.reload().then(() => this.onWorkspaceConfigurationChanged(false));
}
}
private reloadWorkspaceFolderConfiguration(folder: IWorkspaceFolder): Promise<void> {
return this.onWorkspaceFolderConfigurationChanged(folder);
}
private async loadConfiguration(applicationConfigurationModel: ConfigurationModel, userConfigurationModel: ConfigurationModel, remoteUserConfigurationModel: ConfigurationModel): Promise<void> {
// reset caches
this.cachedFolderConfigs = new ResourceMap<FolderConfiguration>();
const folders = this.workspace.folders;
const folderConfigurations = await this.loadFolderConfigurations(folders);
const workspaceConfiguration = this.getWorkspaceConfigurationModel(folderConfigurations);
const folderConfigurationModels = new ResourceMap<ConfigurationModel>();
folderConfigurations.forEach((folderConfiguration, index) => folderConfigurationModels.set(folders[index].uri, folderConfiguration));
const currentConfiguration = this._configuration;
this._configuration = new Configuration(this.defaultConfiguration.configurationModel, this.policyConfiguration.configurationModel, applicationConfigurationModel, userConfigurationModel, remoteUserConfigurationModel, workspaceConfiguration, folderConfigurationModels, new ConfigurationModel(), new ResourceMap<ConfigurationModel>(), this.workspace);
if (this.initialized) {
const change = this._configuration.compare(currentConfiguration);
this.triggerConfigurationChange(change, { data: currentConfiguration.toData(), workspace: this.workspace }, ConfigurationTarget.WORKSPACE);
} else {
this._onDidChangeConfiguration.fire(new AllKeysConfigurationChangeEvent(this._configuration, this.workspace, ConfigurationTarget.WORKSPACE, this.getTargetConfiguration(ConfigurationTarget.WORKSPACE)));
this.initialized = true;
}
this.updateRestrictedSettings();
}
private getWorkspaceConfigurationModel(folderConfigurations: ConfigurationModel[]): ConfigurationModel {
switch (this.getWorkbenchState()) {
case WorkbenchState.FOLDER:
return folderConfigurations[0];
case WorkbenchState.WORKSPACE:
return this.workspaceConfiguration.getConfiguration();
default:
return new ConfigurationModel();
}
}
private onUserDataProfileChanged(e: DidChangeUserDataProfileEvent): void {
e.join((async () => {
if (e.preserveData) {
await Promise.all([
this.copyProfileSettings(e.previous.settingsResource, e.profile.settingsResource),
this.fileService.copy(e.previous.tasksResource, e.profile.tasksResource)
]);
}
const promises: Promise<ConfigurationModel>[] = [];
promises.push(this.localUserConfiguration.reset(e.profile.settingsResource, e.profile.tasksResource, getLocalUserConfigurationScopes(e.profile, !!this.remoteUserConfiguration)));
if (e.previous.isDefault !== e.profile.isDefault) {
this.createApplicationConfiguration();
if (this.applicationConfiguration) {
promises.push(this.reloadApplicationConfiguration(true));
}
}
const [localUser, application] = await Promise.all(promises);
await this.loadConfiguration(application ?? this._configuration.applicationConfiguration, localUser, this._configuration.remoteUserConfiguration);
})());
}
private async copyProfileSettings(from: URI, to: URI): Promise<void> {
let fromContent: string | undefined;
try {
fromContent = (await this.fileService.readFile(from)).value.toString();
} catch (error) {
if ((<FileOperationError>error).fileOperationResult !== FileOperationResult.FILE_NOT_FOUND) {
throw error;
}
}
if (!fromContent) {
return;
}
const allSettings = Registry.as<IConfigurationRegistry>(Extensions.Configuration).getConfigurationProperties();
const applicationSettings = Object.keys(allSettings).filter(key => allSettings[key]?.scope === ConfigurationScope.APPLICATION);
const toContent = updateIgnoredSettings(fromContent, '{}', applicationSettings, {});
await this.fileService.writeFile(to, VSBuffer.fromString(toContent));
}
private onDefaultConfigurationChanged(configurationModel: ConfigurationModel, properties?: string[]): void {
if (this.workspace) {
const previousData = this._configuration.toData();
const change = this._configuration.compareAndUpdateDefaultConfiguration(configurationModel, properties);
if (this.remoteUserConfiguration) {
this._configuration.updateLocalUserConfiguration(this.localUserConfiguration.reparse());
this._configuration.updateRemoteUserConfiguration(this.remoteUserConfiguration.reparse());
}
if (this.getWorkbenchState() === WorkbenchState.FOLDER) {
const folderConfiguration = this.cachedFolderConfigs.get(this.workspace.folders[0].uri);
if (folderConfiguration) {
this._configuration.updateWorkspaceConfiguration(folderConfiguration.reparse());
this._configuration.updateFolderConfiguration(this.workspace.folders[0].uri, folderConfiguration.reparse());
}
} else {
this._configuration.updateWorkspaceConfiguration(this.workspaceConfiguration.reparseWorkspaceSettings());
for (const folder of this.workspace.folders) {
const folderConfiguration = this.cachedFolderConfigs.get(folder.uri);
if (folderConfiguration) {
this._configuration.updateFolderConfiguration(folder.uri, folderConfiguration.reparse());
}
}
}
this.triggerConfigurationChange(change, { data: previousData, workspace: this.workspace }, ConfigurationTarget.DEFAULT);
this.updateRestrictedSettings();
}
}
private onPolicyConfigurationChanged(policyConfiguration: ConfigurationModel): void {
const previous = { data: this._configuration.toData(), workspace: this.workspace };
const change = this._configuration.compareAndUpdatePolicyConfiguration(policyConfiguration);
this.triggerConfigurationChange(change, previous, ConfigurationTarget.DEFAULT);
}
private onApplicationConfigurationChanged(applicationConfiguration: ConfigurationModel): void {
const previous = { data: this._configuration.toData(), workspace: this.workspace };
const change = this._configuration.compareAndUpdateApplicationConfiguration(applicationConfiguration);
this.triggerConfigurationChange(change, previous, ConfigurationTarget.USER);
}
private onLocalUserConfigurationChanged(userConfiguration: ConfigurationModel): void {
const previous = { data: this._configuration.toData(), workspace: this.workspace };
const change = this._configuration.compareAndUpdateLocalUserConfiguration(userConfiguration);
this.triggerConfigurationChange(change, previous, ConfigurationTarget.USER);
}
private onRemoteUserConfigurationChanged(userConfiguration: ConfigurationModel): void {
const previous = { data: this._configuration.toData(), workspace: this.workspace };
const change = this._configuration.compareAndUpdateRemoteUserConfiguration(userConfiguration);
this.triggerConfigurationChange(change, previous, ConfigurationTarget.USER);
}
private async onWorkspaceConfigurationChanged(fromCache: boolean): Promise<void> {
if (this.workspace && this.workspace.configuration) {
let newFolders = toWorkspaceFolders(this.workspaceConfiguration.getFolders(), this.workspace.configuration, this.uriIdentityService.extUri);
// Validate only if workspace is initialized
if (this.workspace.initialized) {
const { added, removed, changed } = this.compareFolders(this.workspace.folders, newFolders);
/* If changed validate new folders */
if (added.length || removed.length || changed.length) {
newFolders = await this.toValidWorkspaceFolders(newFolders);
}
/* Otherwise use existing */
else {
newFolders = this.workspace.folders;
}
}
await this.updateWorkspaceConfiguration(newFolders, this.workspaceConfiguration.getConfiguration(), fromCache);
}
}
private updateRestrictedSettings(): void {
const changed: string[] = [];
const allProperties = this.configurationRegistry.getConfigurationProperties();
const defaultRestrictedSettings: string[] = Object.keys(allProperties).filter(key => allProperties[key].restricted).sort((a, b) => a.localeCompare(b));
const defaultDelta = delta(defaultRestrictedSettings, this._restrictedSettings.default, (a, b) => a.localeCompare(b));
changed.push(...defaultDelta.added, ...defaultDelta.removed);
const application = (this.applicationConfiguration?.getRestrictedSettings() || []).sort((a, b) => a.localeCompare(b));
const applicationDelta = delta(application, this._restrictedSettings.application || [], (a, b) => a.localeCompare(b));
changed.push(...applicationDelta.added, ...applicationDelta.removed);
const userLocal = this.localUserConfiguration.getRestrictedSettings().sort((a, b) => a.localeCompare(b));
const userLocalDelta = delta(userLocal, this._restrictedSettings.userLocal || [], (a, b) => a.localeCompare(b));
changed.push(...userLocalDelta.added, ...userLocalDelta.removed);
const userRemote = (this.remoteUserConfiguration?.getRestrictedSettings() || []).sort((a, b) => a.localeCompare(b));
const userRemoteDelta = delta(userRemote, this._restrictedSettings.userRemote || [], (a, b) => a.localeCompare(b));
changed.push(...userRemoteDelta.added, ...userRemoteDelta.removed);
const workspaceFolderMap = new ResourceMap<ReadonlyArray<string>>();
for (const workspaceFolder of this.workspace.folders) {
const cachedFolderConfig = this.cachedFolderConfigs.get(workspaceFolder.uri);
const folderRestrictedSettings = (cachedFolderConfig?.getRestrictedSettings() || []).sort((a, b) => a.localeCompare(b));
if (folderRestrictedSettings.length) {
workspaceFolderMap.set(workspaceFolder.uri, folderRestrictedSettings);
}
const previous = this._restrictedSettings.workspaceFolder?.get(workspaceFolder.uri) || [];
const workspaceFolderDelta = delta(folderRestrictedSettings, previous, (a, b) => a.localeCompare(b));
changed.push(...workspaceFolderDelta.added, ...workspaceFolderDelta.removed);
}
const workspace = this.getWorkbenchState() === WorkbenchState.WORKSPACE ? this.workspaceConfiguration.getRestrictedSettings().sort((a, b) => a.localeCompare(b))
: this.workspace.folders[0] ? (workspaceFolderMap.get(this.workspace.folders[0].uri) || []) : [];
const workspaceDelta = delta(workspace, this._restrictedSettings.workspace || [], (a, b) => a.localeCompare(b));
changed.push(...workspaceDelta.added, ...workspaceDelta.removed);
if (changed.length) {
this._restrictedSettings = {
default: defaultRestrictedSettings,
application: application.length ? application : undefined,
userLocal: userLocal.length ? userLocal : undefined,
userRemote: userRemote.length ? userRemote : undefined,
workspace: workspace.length ? workspace : undefined,
workspaceFolder: workspaceFolderMap.size ? workspaceFolderMap : undefined,
};
this._onDidChangeRestrictedSettings.fire(this.restrictedSettings);
}
}
private async updateWorkspaceConfiguration(workspaceFolders: WorkspaceFolder[], configuration: ConfigurationModel, fromCache: boolean): Promise<void> {
const previous = { data: this._configuration.toData(), workspace: this.workspace };
const change = this._configuration.compareAndUpdateWorkspaceConfiguration(configuration);
const changes = this.compareFolders(this.workspace.folders, workspaceFolders);
if (changes.added.length || changes.removed.length || changes.changed.length) {
this.workspace.folders = workspaceFolders;
const change = await this.onFoldersChanged();
await this.handleWillChangeWorkspaceFolders(changes, fromCache);
this.triggerConfigurationChange(change, previous, ConfigurationTarget.WORKSPACE_FOLDER);
this._onDidChangeWorkspaceFolders.fire(changes);
} else {
this.triggerConfigurationChange(change, previous, ConfigurationTarget.WORKSPACE);
}
this.updateRestrictedSettings();
}
private async handleWillChangeWorkspaceFolders(changes: IWorkspaceFoldersChangeEvent, fromCache: boolean): Promise<void> {
const joiners: Promise<void>[] = [];
this._onWillChangeWorkspaceFolders.fire({
join(updateWorkspaceTrustStatePromise) {
joiners.push(updateWorkspaceTrustStatePromise);
},
changes,
fromCache
});
try { await Promises.settled(joiners); } catch (error) { /* Ignore */ }
}
private async onWorkspaceFolderConfigurationChanged(folder: IWorkspaceFolder): Promise<void> {
const [folderConfiguration] = await this.loadFolderConfigurations([folder]);
const previous = { data: this._configuration.toData(), workspace: this.workspace };
const folderConfiguraitonChange = this._configuration.compareAndUpdateFolderConfiguration(folder.uri, folderConfiguration);
if (this.getWorkbenchState() === WorkbenchState.FOLDER) {
const workspaceConfigurationChange = this._configuration.compareAndUpdateWorkspaceConfiguration(folderConfiguration);
this.triggerConfigurationChange(mergeChanges(folderConfiguraitonChange, workspaceConfigurationChange), previous, ConfigurationTarget.WORKSPACE);
} else {
this.triggerConfigurationChange(folderConfiguraitonChange, previous, ConfigurationTarget.WORKSPACE_FOLDER);
}
this.updateRestrictedSettings();
}
private async onFoldersChanged(): Promise<IConfigurationChange> {
const changes: IConfigurationChange[] = [];
// Remove the configurations of deleted folders
for (const key of this.cachedFolderConfigs.keys()) {
if (!this.workspace.folders.filter(folder => folder.uri.toString() === key.toString())[0]) {
const folderConfiguration = this.cachedFolderConfigs.get(key);
folderConfiguration!.dispose();
this.cachedFolderConfigs.delete(key);
changes.push(this._configuration.compareAndDeleteFolderConfiguration(key));
}
}
const toInitialize = this.workspace.folders.filter(folder => !this.cachedFolderConfigs.has(folder.uri));
if (toInitialize.length) {
const folderConfigurations = await this.loadFolderConfigurations(toInitialize);
folderConfigurations.forEach((folderConfiguration, index) => {
changes.push(this._configuration.compareAndUpdateFolderConfiguration(toInitialize[index].uri, folderConfiguration));
});
}
return mergeChanges(...changes);
}
private loadFolderConfigurations(folders: IWorkspaceFolder[]): Promise<ConfigurationModel[]> {
return Promise.all([...folders.map(folder => {
let folderConfiguration = this.cachedFolderConfigs.get(folder.uri);
if (!folderConfiguration) {
folderConfiguration = new FolderConfiguration(!this.initialized, folder, FOLDER_CONFIG_FOLDER_NAME, this.getWorkbenchState(), this.isWorkspaceTrusted, this.fileService, this.uriIdentityService, this.logService, this.configurationCache);
this._register(folderConfiguration.onDidChange(() => this.onWorkspaceFolderConfigurationChanged(folder)));
this.cachedFolderConfigs.set(folder.uri, this._register(folderConfiguration));
}
return folderConfiguration.loadConfiguration();
})]);
}
private async validateWorkspaceFoldersAndReload(fromCache: boolean): Promise<void> {
const validWorkspaceFolders = await this.toValidWorkspaceFolders(this.workspace.folders);
const { removed } = this.compareFolders(this.workspace.folders, validWorkspaceFolders);
if (removed.length) {
await this.updateWorkspaceConfiguration(validWorkspaceFolders, this.workspaceConfiguration.getConfiguration(), fromCache);
}
}
// Filter out workspace folders which are files (not directories)
// Workspace folders those cannot be resolved are not filtered because they are handled by the Explorer.
private async toValidWorkspaceFolders(workspaceFolders: WorkspaceFolder[]): Promise<WorkspaceFolder[]> {
const validWorkspaceFolders: WorkspaceFolder[] = [];
for (const workspaceFolder of workspaceFolders) {
try {
const result = await this.fileService.stat(workspaceFolder.uri);
if (!result.isDirectory) {
continue;
}
} catch (e) {
this.logService.warn(`Ignoring the error while validating workspace folder ${workspaceFolder.uri.toString()} - ${toErrorMessage(e)}`);
}
validWorkspaceFolders.push(workspaceFolder);
}
return validWorkspaceFolders;
}
private async writeConfigurationValue(key: string, value: any, target: ConfigurationTarget, overrides: IConfigurationUpdateOverrides | undefined, donotNotifyError: boolean): Promise<void> {
if (target === ConfigurationTarget.DEFAULT) {
throw new Error('Invalid configuration target');
}
if (target === ConfigurationTarget.MEMORY) {
const previous = { data: this._configuration.toData(), workspace: this.workspace };
this._configuration.updateValue(key, value, overrides);
this.triggerConfigurationChange({ keys: overrides?.overrideIdentifiers?.length ? [keyFromOverrideIdentifiers(overrides.overrideIdentifiers), key] : [key], overrides: overrides?.overrideIdentifiers?.length ? overrides.overrideIdentifiers.map(overrideIdentifier => ([overrideIdentifier, [key]])) : [] }, previous, target);
return;
}
const editableConfigurationTarget = this.toEditableConfigurationTarget(target, key);
if (!editableConfigurationTarget) {
throw new Error('Invalid configuration target');
}
if (editableConfigurationTarget === EditableConfigurationTarget.USER_REMOTE && !this.remoteUserConfiguration) {
throw new Error('Invalid configuration target');
}
await this.configurationEditingService.writeConfiguration(editableConfigurationTarget, { key, value }, { scopes: overrides, donotNotifyError });
switch (editableConfigurationTarget) {
case EditableConfigurationTarget.USER_LOCAL:
if (this.applicationConfiguration && this.configurationRegistry.getConfigurationProperties()[key].scope === ConfigurationScope.APPLICATION) {
await this.reloadApplicationConfiguration();
} else {
await this.reloadLocalUserConfiguration();
}
return;
case EditableConfigurationTarget.USER_REMOTE:
return this.reloadRemoteUserConfiguration().then(() => undefined);
case EditableConfigurationTarget.WORKSPACE:
return this.reloadWorkspaceConfiguration();
case EditableConfigurationTarget.WORKSPACE_FOLDER: {
const workspaceFolder = overrides && overrides.resource ? this.workspace.getFolder(overrides.resource) : null;
if (workspaceFolder) {
return this.reloadWorkspaceFolderConfiguration(workspaceFolder);
}
}
}
}
private deriveConfigurationTargets(key: string, value: any, inspect: IConfigurationValue<any>): ConfigurationTarget[] {
if (equals(value, inspect.value)) {
return [];
}
const definedTargets: ConfigurationTarget[] = [];
if (inspect.workspaceFolderValue !== undefined) {
definedTargets.push(ConfigurationTarget.WORKSPACE_FOLDER);
}
if (inspect.workspaceValue !== undefined) {
definedTargets.push(ConfigurationTarget.WORKSPACE);
}
if (inspect.userRemoteValue !== undefined) {
definedTargets.push(ConfigurationTarget.USER_REMOTE);
}
if (inspect.userLocalValue !== undefined) {
definedTargets.push(ConfigurationTarget.USER_LOCAL);
}
if (value === undefined) {
// Remove the setting in all defined targets
return definedTargets;
}
return [definedTargets[0] || ConfigurationTarget.USER];
}
private triggerConfigurationChange(change: IConfigurationChange, previous: { data: IConfigurationData; workspace?: Workspace } | undefined, target: ConfigurationTarget): void {
if (change.keys.length) {
if (target !== ConfigurationTarget.DEFAULT) {
this.logService.debug(`Configuration keys changed in ${ConfigurationTargetToString(target)} target`, ...change.keys);
}
const configurationChangeEvent = new ConfigurationChangeEvent(change, previous, this._configuration, this.workspace);
configurationChangeEvent.source = target;
configurationChangeEvent.sourceConfig = this.getTargetConfiguration(target);
this._onDidChangeConfiguration.fire(configurationChangeEvent);
}
}
private getTargetConfiguration(target: ConfigurationTarget): any {
switch (target) {
case ConfigurationTarget.DEFAULT:
return this._configuration.defaults.contents;
case ConfigurationTarget.USER:
return this._configuration.userConfiguration.contents;
case ConfigurationTarget.WORKSPACE:
return this._configuration.workspaceConfiguration.contents;
}
return {};
}
private toEditableConfigurationTarget(target: ConfigurationTarget, key: string): EditableConfigurationTarget | null {
if (target === ConfigurationTarget.USER) {
if (this.remoteUserConfiguration) {
const scope = this.configurationRegistry.getConfigurationProperties()[key]?.scope;
if (scope === ConfigurationScope.MACHINE || scope === ConfigurationScope.MACHINE_OVERRIDABLE) {
return EditableConfigurationTarget.USER_REMOTE;
}
if (this.inspect(key).userRemoteValue !== undefined) {
return EditableConfigurationTarget.USER_REMOTE;
}
}
return EditableConfigurationTarget.USER_LOCAL;
}
if (target === ConfigurationTarget.USER_LOCAL) {
return EditableConfigurationTarget.USER_LOCAL;
}
if (target === ConfigurationTarget.USER_REMOTE) {
return EditableConfigurationTarget.USER_REMOTE;
}
if (target === ConfigurationTarget.WORKSPACE) {
return EditableConfigurationTarget.WORKSPACE;
}
if (target === ConfigurationTarget.WORKSPACE_FOLDER) {
return EditableConfigurationTarget.WORKSPACE_FOLDER;
}
return null;
}
}
class RegisterConfigurationSchemasContribution extends Disposable implements IWorkbenchContribution {
constructor(
@IWorkspaceContextService private readonly workspaceContextService: IWorkspaceContextService,
@IWorkbenchEnvironmentService private readonly environmentService: IWorkbenchEnvironmentService,
@IWorkspaceTrustManagementService private readonly workspaceTrustManagementService: IWorkspaceTrustManagementService,
) {
super();
this.registerConfigurationSchemas();
const configurationRegistry = Registry.as<IConfigurationRegistry>(Extensions.Configuration);
this._register(configurationRegistry.onDidUpdateConfiguration(e => this.registerConfigurationSchemas()));
this._register(configurationRegistry.onDidSchemaChange(e => this.registerConfigurationSchemas()));
this._register(workspaceTrustManagementService.onDidChangeTrust(() => this.registerConfigurationSchemas()));
}
private registerConfigurationSchemas(): void {
const jsonRegistry = Registry.as<IJSONContributionRegistry>(JSONExtensions.JSONContribution);
const allSettingsSchema: IJSONSchema = {
properties: allSettings.properties,
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
};
const userSettingsSchema: IJSONSchema = this.environmentService.remoteAuthority ?
{
properties: {
...applicationSettings.properties,
...windowSettings.properties,
...resourceSettings.properties
},
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
}
: allSettingsSchema;
const profileSettingsSchema: IJSONSchema = {
properties: {
...machineSettings.properties,
...machineOverridableSettings.properties,
...windowSettings.properties,
...resourceSettings.properties
},
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
};
const machineSettingsSchema: IJSONSchema = {
properties: {
...machineSettings.properties,
...machineOverridableSettings.properties,
...windowSettings.properties,
...resourceSettings.properties
},
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
};
const workspaceSettingsSchema: IJSONSchema = {
properties: {
...this.checkAndFilterPropertiesRequiringTrust(machineOverridableSettings.properties),
...this.checkAndFilterPropertiesRequiringTrust(windowSettings.properties),
...this.checkAndFilterPropertiesRequiringTrust(resourceSettings.properties)
},
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
};
jsonRegistry.registerSchema(defaultSettingsSchemaId, {
properties: Object.keys(allSettings.properties).reduce<IJSONSchemaMap>((result, key) => {
result[key] = {
...allSettings.properties[key],
deprecationMessage: undefined
};
return result;
}, {}),
patternProperties: Object.keys(allSettings.patternProperties).reduce<IJSONSchemaMap>((result, key) => {
result[key] = {
...allSettings.patternProperties[key],
deprecationMessage: undefined
};
return result;
}, {}),
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
});
jsonRegistry.registerSchema(userSettingsSchemaId, userSettingsSchema);
jsonRegistry.registerSchema(profileSettingsSchemaId, profileSettingsSchema);
jsonRegistry.registerSchema(machineSettingsSchemaId, machineSettingsSchema);
if (WorkbenchState.WORKSPACE === this.workspaceContextService.getWorkbenchState()) {
const folderSettingsSchema: IJSONSchema = {
properties: {
...this.checkAndFilterPropertiesRequiringTrust(machineOverridableSettings.properties),
...this.checkAndFilterPropertiesRequiringTrust(resourceSettings.properties)
},
patternProperties: allSettings.patternProperties,
additionalProperties: true,
allowTrailingCommas: true,
allowComments: true
};
jsonRegistry.registerSchema(workspaceSettingsSchemaId, workspaceSettingsSchema);
jsonRegistry.registerSchema(folderSettingsSchemaId, folderSettingsSchema);
} else {
jsonRegistry.registerSchema(workspaceSettingsSchemaId, workspaceSettingsSchema);
jsonRegistry.registerSchema(folderSettingsSchemaId, workspaceSettingsSchema);
}
jsonRegistry.registerSchema(configurationDefaultsSchemaId, {
type: 'object',
description: localize('configurationDefaults.description', 'Contribute defaults for configurations'),
properties: {
...machineOverridableSettings.properties,
...windowSettings.properties,
...resourceSettings.properties
},
patternProperties: {
[OVERRIDE_PROPERTY_PATTERN]: {
type: 'object',
default: {},
$ref: resourceLanguageSettingsSchemaId,
}
},
additionalProperties: false
});
}
private checkAndFilterPropertiesRequiringTrust(properties: IStringDictionary<IConfigurationPropertySchema>): IStringDictionary<IConfigurationPropertySchema> {
if (this.workspaceTrustManagementService.isWorkspaceTrusted()) {
return properties;
}
const result: IStringDictionary<IConfigurationPropertySchema> = {};
Object.entries(properties).forEach(([key, value]) => {
if (!value.restricted) {
result[key] = value;
}
});
return result;
}
}
class ResetConfigurationDefaultsOverridesCache extends Disposable implements IWorkbenchContribution {
constructor(
@IConfigurationService configurationService: IConfigurationService,
@IExtensionService extensionService: IExtensionService,
) {
super();
extensionService.whenInstalledExtensionsRegistered().then(() => configurationService.reloadConfiguration(ConfigurationTarget.DEFAULT));
}
}
class UpdateExperimentalSettingsDefaults extends Disposable implements IWorkbenchContribution {
private readonly processedExperimentalSettings = new Set<string>();
private readonly configurationRegistry = Registry.as<IConfigurationRegistry>(Extensions.Configuration);
constructor(
@IWorkbenchAssignmentService private readonly workbenchAssignmentService: IWorkbenchAssignmentService
) {
super();
this.processExperimentalSettings(Object.keys(this.configurationRegistry.getConfigurationProperties()));
this._register(this.configurationRegistry.onDidUpdateConfiguration(({ properties }) => this.processExperimentalSettings(properties)));
}
private async processExperimentalSettings(properties: string[]): Promise<void> {
const overrides: IStringDictionary<any> = {};
const allProperties = this.configurationRegistry.getConfigurationProperties();
for (const property of properties) {
const schema = allProperties[property];
if (!schema?.tags?.includes('experimental')) {
continue;
}
if (this.processedExperimentalSettings.has(property)) {
continue;
}
this.processedExperimentalSettings.add(property);
try {
const value = await this.workbenchAssignmentService.getTreatment(`config.${property}`);
if (!isUndefined(value) && !equals(value, schema.default)) {
overrides[property] = value;
}
} catch (error) {/*ignore */ }
}
if (Object.keys(overrides).length) {
this.configurationRegistry.registerDefaultConfigurations([{ overrides, source: localize('experimental', "Experiments") }]);
}
}
}
const workbenchContributionsRegistry = Registry.as<IWorkbenchContributionsRegistry>(WorkbenchExtensions.Workbench);
workbenchContributionsRegistry.registerWorkbenchContribution(RegisterConfigurationSchemasContribution, LifecyclePhase.Restored);
workbenchContributionsRegistry.registerWorkbenchContribution(ResetConfigurationDefaultsOverridesCache, LifecyclePhase.Eventually);
workbenchContributionsRegistry.registerWorkbenchContribution(UpdateExperimentalSettingsDefaults, LifecyclePhase.Restored);
|