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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { URI as uri } from 'vs/base/common/uri';
import * as nls from 'vs/nls';
import * as Types from 'vs/base/common/types';
import { Schemas } from 'vs/base/common/network';
import { SideBySideEditor, EditorResourceAccessor } from 'vs/workbench/common/editor';
import { IStringDictionary, forEach, fromMap } from 'vs/base/common/collections';
import { IConfigurationService, IConfigurationOverrides, ConfigurationTarget } from 'vs/platform/configuration/common/configuration';
import { ICommandService } from 'vs/platform/commands/common/commands';
import { IWorkspaceFolder, IWorkspaceContextService, WorkbenchState } from 'vs/platform/workspace/common/workspace';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
import { AbstractVariableResolverService } from 'vs/workbench/services/configurationResolver/common/variableResolver';
import { ICodeEditor, isCodeEditor, isDiffEditor } from 'vs/editor/browser/editorBrowser';
import { IQuickInputService, IInputOptions, IQuickPickItem, IPickOptions } from 'vs/platform/quickinput/common/quickInput';
import { ConfiguredInput } from 'vs/workbench/services/configurationResolver/common/configurationResolver';
import { IProcessEnvironment } from 'vs/base/common/platform';
import { ILabelService } from 'vs/platform/label/common/label';
import { IPathService } from 'vs/workbench/services/path/common/pathService';
import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions';
export abstract class BaseConfigurationResolverService extends AbstractVariableResolverService {
static readonly INPUT_OR_COMMAND_VARIABLES_PATTERN = /\${((input|command):(.*?))}/g;
constructor(
context: {
getAppRoot: () => string | undefined;
getExecPath: () => string | undefined;
},
envVariablesPromise: Promise<IProcessEnvironment>,
editorService: IEditorService,
private readonly configurationService: IConfigurationService,
private readonly commandService: ICommandService,
private readonly workspaceContextService: IWorkspaceContextService,
private readonly quickInputService: IQuickInputService,
private readonly labelService: ILabelService,
private readonly pathService: IPathService,
extensionService: IExtensionService,
) {
super({
getFolderUri: (folderName: string): uri | undefined => {
const folder = workspaceContextService.getWorkspace().folders.filter(f => f.name === folderName).pop();
return folder ? folder.uri : undefined;
},
getWorkspaceFolderCount: (): number => {
return workspaceContextService.getWorkspace().folders.length;
},
getConfigurationValue: (folderUri: uri | undefined, suffix: string): string | undefined => {
return configurationService.getValue<string>(suffix, folderUri ? { resource: folderUri } : {});
},
getAppRoot: (): string | undefined => {
return context.getAppRoot();
},
getExecPath: (): string | undefined => {
return context.getExecPath();
},
getFilePath: (): string | undefined => {
const fileResource = EditorResourceAccessor.getOriginalUri(editorService.activeEditor, {
supportSideBySide: SideBySideEditor.PRIMARY,
filterByScheme: [Schemas.file, Schemas.vscodeUserData, this.pathService.defaultUriScheme]
});
if (!fileResource) {
return undefined;
}
return this.labelService.getUriLabel(fileResource, { noPrefix: true });
},
getWorkspaceFolderPathForFile: (): string | undefined => {
const fileResource = EditorResourceAccessor.getOriginalUri(editorService.activeEditor, {
supportSideBySide: SideBySideEditor.PRIMARY,
filterByScheme: [Schemas.file, Schemas.vscodeUserData, this.pathService.defaultUriScheme]
});
if (!fileResource) {
return undefined;
}
const wsFolder = workspaceContextService.getWorkspaceFolder(fileResource);
if (!wsFolder) {
return undefined;
}
return this.labelService.getUriLabel(wsFolder.uri, { noPrefix: true });
},
getSelectedText: (): string | undefined => {
const activeTextEditorControl = editorService.activeTextEditorControl;
let activeControl: ICodeEditor | null = null;
if (isCodeEditor(activeTextEditorControl)) {
activeControl = activeTextEditorControl;
} else if (isDiffEditor(activeTextEditorControl)) {
const original = activeTextEditorControl.getOriginalEditor();
const modified = activeTextEditorControl.getModifiedEditor();
activeControl = original.hasWidgetFocus() ? original : modified;
}
const activeModel = activeControl?.getModel();
const activeSelection = activeControl?.getSelection();
if (activeModel && activeSelection) {
return activeModel.getValueInRange(activeSelection);
}
return undefined;
},
getLineNumber: (): string | undefined => {
const activeTextEditorControl = editorService.activeTextEditorControl;
if (isCodeEditor(activeTextEditorControl)) {
const selection = activeTextEditorControl.getSelection();
if (selection) {
const lineNumber = selection.positionLineNumber;
return String(lineNumber);
}
}
return undefined;
},
getExtension: id => {
return extensionService.getExtension(id);
},
}, labelService, pathService.userHome().then(home => home.path), envVariablesPromise);
}
public override async resolveWithInteractionReplace(folder: IWorkspaceFolder | undefined, config: any, section?: string, variables?: IStringDictionary<string>, target?: ConfigurationTarget): Promise<any> {
// resolve any non-interactive variables and any contributed variables
config = await this.resolveAnyAsync(folder, config);
// resolve input variables in the order in which they are encountered
return this.resolveWithInteraction(folder, config, section, variables, target).then(mapping => {
// finally substitute evaluated command variables (if there are any)
if (!mapping) {
return null;
} else if (mapping.size > 0) {
return this.resolveAnyAsync(folder, config, fromMap(mapping));
} else {
return config;
}
});
}
public override async resolveWithInteraction(folder: IWorkspaceFolder | undefined, config: any, section?: string, variables?: IStringDictionary<string>, target?: ConfigurationTarget): Promise<Map<string, string> | undefined> {
// resolve any non-interactive variables and any contributed variables
const resolved = await this.resolveAnyMap(folder, config);
config = resolved.newConfig;
const allVariableMapping: Map<string, string> = resolved.resolvedVariables;
// resolve input and command variables in the order in which they are encountered
return this.resolveWithInputAndCommands(folder, config, variables, section, target).then(inputOrCommandMapping => {
if (this.updateMapping(inputOrCommandMapping, allVariableMapping)) {
return allVariableMapping;
}
return undefined;
});
}
/**
* Add all items from newMapping to fullMapping. Returns false if newMapping is undefined.
*/
private updateMapping(newMapping: IStringDictionary<string> | undefined, fullMapping: Map<string, string>): boolean {
if (!newMapping) {
return false;
}
forEach(newMapping, (entry) => {
fullMapping.set(entry.key, entry.value);
});
return true;
}
/**
* Finds and executes all input and command variables in the given configuration and returns their values as a dictionary.
* Please note: this method does not substitute the input or command variables (so the configuration is not modified).
* The returned dictionary can be passed to "resolvePlatform" for the actual substitution.
* See #6569.
*
* @param variableToCommandMap Aliases for commands
*/
private async resolveWithInputAndCommands(folder: IWorkspaceFolder | undefined, configuration: any, variableToCommandMap?: IStringDictionary<string>, section?: string, target?: ConfigurationTarget): Promise<IStringDictionary<string> | undefined> {
if (!configuration) {
return Promise.resolve(undefined);
}
// get all "inputs"
let inputs: ConfiguredInput[] = [];
if (this.workspaceContextService.getWorkbenchState() !== WorkbenchState.EMPTY && section) {
const overrides: IConfigurationOverrides = folder ? { resource: folder.uri } : {};
let result = this.configurationService.inspect(section, overrides);
if (result && (result.userValue || result.workspaceValue || result.workspaceFolderValue)) {
switch (target) {
case ConfigurationTarget.USER: inputs = (<any>result.userValue)?.inputs; break;
case ConfigurationTarget.WORKSPACE: inputs = (<any>result.workspaceValue)?.inputs; break;
default: inputs = (<any>result.workspaceFolderValue)?.inputs;
}
} else {
const valueResult = this.configurationService.getValue<any>(section, overrides);
if (valueResult) {
inputs = valueResult.inputs;
}
}
}
// extract and dedupe all "input" and "command" variables and preserve their order in an array
const variables: string[] = [];
this.findVariables(configuration, variables);
const variableValues: IStringDictionary<string> = Object.create(null);
for (const variable of variables) {
const [type, name] = variable.split(':', 2);
let result: string | undefined;
switch (type) {
case 'input':
result = await this.showUserInput(name, inputs);
break;
case 'command': {
// use the name as a command ID #12735
const commandId = (variableToCommandMap ? variableToCommandMap[name] : undefined) || name;
result = await this.commandService.executeCommand(commandId, configuration);
if (typeof result !== 'string' && !Types.isUndefinedOrNull(result)) {
throw new Error(nls.localize('commandVariable.noStringType', "Cannot substitute command variable '{0}' because command did not return a result of type string.", commandId));
}
break;
}
default:
// Try to resolve it as a contributed variable
if (this._contributedVariables.has(variable)) {
result = await this._contributedVariables.get(variable)!();
}
}
if (typeof result === 'string') {
variableValues[variable] = result;
} else {
return undefined;
}
}
return variableValues;
}
/**
* Recursively finds all command or input variables in object and pushes them into variables.
* @param object object is searched for variables.
* @param variables All found variables are returned in variables.
*/
private findVariables(object: any, variables: string[]) {
if (typeof object === 'string') {
let matches;
while ((matches = BaseConfigurationResolverService.INPUT_OR_COMMAND_VARIABLES_PATTERN.exec(object)) !== null) {
if (matches.length === 4) {
const command = matches[1];
if (variables.indexOf(command) < 0) {
variables.push(command);
}
}
}
this._contributedVariables.forEach((value, contributed: string) => {
if ((variables.indexOf(contributed) < 0) && (object.indexOf('${' + contributed + '}') >= 0)) {
variables.push(contributed);
}
});
} else if (Types.isArray(object)) {
object.forEach(value => {
this.findVariables(value, variables);
});
} else if (object) {
Object.keys(object).forEach(key => {
const value = object[key];
this.findVariables(value, variables);
});
}
}
/**
* Takes the provided input info and shows the quick pick so the user can provide the value for the input
* @param variable Name of the input variable.
* @param inputInfos Information about each possible input variable.
*/
private showUserInput(variable: string, inputInfos: ConfiguredInput[]): Promise<string | undefined> {
if (!inputInfos) {
return Promise.reject(new Error(nls.localize('inputVariable.noInputSection', "Variable '{0}' must be defined in an '{1}' section of the debug or task configuration.", variable, 'input')));
}
// find info for the given input variable
const info = inputInfos.filter(item => item.id === variable).pop();
if (info) {
const missingAttribute = (attrName: string) => {
throw new Error(nls.localize('inputVariable.missingAttribute', "Input variable '{0}' is of type '{1}' and must include '{2}'.", variable, info.type, attrName));
};
switch (info.type) {
case 'promptString': {
if (!Types.isString(info.description)) {
missingAttribute('description');
}
const inputOptions: IInputOptions = { prompt: info.description, ignoreFocusLost: true };
if (info.default) {
inputOptions.value = info.default;
}
if (info.password) {
inputOptions.password = info.password;
}
return this.quickInputService.input(inputOptions).then(resolvedInput => {
return resolvedInput;
});
}
case 'pickString': {
if (!Types.isString(info.description)) {
missingAttribute('description');
}
if (Types.isArray(info.options)) {
info.options.forEach(pickOption => {
if (!Types.isString(pickOption) && !Types.isString(pickOption.value)) {
missingAttribute('value');
}
});
} else {
missingAttribute('options');
}
interface PickStringItem extends IQuickPickItem {
value: string;
}
const picks = new Array<PickStringItem>();
info.options.forEach(pickOption => {
const value = Types.isString(pickOption) ? pickOption : pickOption.value;
const label = Types.isString(pickOption) ? undefined : pickOption.label;
// If there is no label defined, use value as label
const item: PickStringItem = {
label: label ? `${label}: ${value}` : value,
value: value
};
if (value === info.default) {
item.description = nls.localize('inputVariable.defaultInputValue', "(Default)");
picks.unshift(item);
} else {
picks.push(item);
}
});
const pickOptions: IPickOptions<PickStringItem> = { placeHolder: info.description, matchOnDetail: true, ignoreFocusLost: true };
return this.quickInputService.pick(picks, pickOptions, undefined).then(resolvedInput => {
if (resolvedInput) {
return resolvedInput.value;
}
return undefined;
});
}
case 'command': {
if (!Types.isString(info.command)) {
missingAttribute('command');
}
return this.commandService.executeCommand<string>(info.command, info.args).then(result => {
if (typeof result === 'string' || Types.isUndefinedOrNull(result)) {
return result;
}
throw new Error(nls.localize('inputVariable.command.noStringType', "Cannot substitute input variable '{0}' because command '{1}' did not return a result of type string.", variable, info.command));
});
}
default:
throw new Error(nls.localize('inputVariable.unknownType', "Input variable '{0}' can only be of type 'promptString', 'pickString', or 'command'.", variable));
}
}
return Promise.reject(new Error(nls.localize('inputVariable.undefinedVariable', "Undefined input variable '{0}' encountered. Remove or define '{0}' to continue.", variable)));
}
}
|