-
Notifications
You must be signed in to change notification settings - Fork 5
/
extension.ts
201 lines (179 loc) · 7.38 KB
/
extension.ts
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
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
*--------------------------------------------------------------------------------------------*/
import * as vscode from 'vscode';
import * as os from 'os';
import * as path from 'path';
import * as fs from 'fs';
import * as cp from 'child_process';
import { promisify } from 'util';
import * as nls from 'vscode-nls';
import { Experiment, Command, getTelemetry, Dialog } from './telemetry';
const localize = nls.loadMessageBundle();
export enum ExtensionId {
remoteWSL = 'ms-vscode-remote.remote-wsl',
remoteWSLRecommender = 'ms-vscode-remote.remote-wsl-recommender'
}
enum ContextKey {
openWSLFolder = 'remote-wsl-recommender.openWSLFolder.available',
gettingStarted = 'remote-wsl-recommender.gettingStarted.available'
}
enum CommandId {
openWSLFolder = 'remote-wsl-recommender.openWSLFolder',
gettingStarted = 'remote-wsl-recommender.gettingStarted'
}
const WIN10_1903 = { label: 'Windows 10, May 2019 Update, version 1903', build: 18362 };
//const WIN10_2004 = { label: 'Windows 10, May 2020 Update, version 2004', build: 19041 };
const WSL_DOC_URL = 'https://code.visualstudio.com/docs/remote/wsl';
export async function activate(context: vscode.ExtensionContext) {
if (process.platform !== 'win32' || getWindowsBuildNumber() < WIN10_1903.build || vscode.env.remoteName) {
return;
}
const telemetry = getTelemetry(context);
async function addFeature(experiment: Experiment, contextKey: ContextKey, initFeature: () => vscode.Disposable) {
let featureDisposable: vscode.Disposable | undefined = undefined;
const isFeatureEnabled = async () => {
return !vscode.extensions.getExtension(ExtensionId.remoteWSL) && await telemetry.isExperimentEnabled(experiment);
};
let isEnabled = false;
const featureEnablementChanged = async () => {
const newIsEnabled = await isFeatureEnabled();
if (isEnabled !== newIsEnabled) {
isEnabled = newIsEnabled;
vscode.commands.executeCommand('setContext', contextKey, isEnabled);
if (isEnabled) {
featureDisposable = initFeature();
} else if (featureDisposable) {
featureDisposable.dispose();
featureDisposable = undefined;
}
}
};
await featureEnablementChanged();
context.subscriptions.push(vscode.extensions.onDidChange(featureEnablementChanged));
context.subscriptions.push(telemetry.onDidChange(featureEnablementChanged));
context.subscriptions.push({ dispose: () => featureDisposable?.dispose() });
}
addFeature(Experiment.openWSLFolder, ContextKey.openWSLFolder, () => {
return vscode.commands.registerCommand(CommandId.openWSLFolder, async () => {
telemetry.reportCommand(Command.openWSLFolder);
const isWSLInstalled = await checkIfWSLInstalled();
if (isWSLInstalled !== true) {
telemetry.reportDialog(Dialog.wslNotInstalled, 'show');
const installWSL = 'Install Now';
const learnMore = 'Learn More';
const buttons = hasWSLInstall() ? [installWSL, learnMore] : [learnMore];
const response = await vscode.window.showErrorMessage(localize('installWSL', 'The Windows Subsystem for Linux (WSL) must be installed to complete the action. WSL lets you run a GNU/Linux environment directly on Windows without the overhead of a traditional virtual machine. VS Code, through the Remote-WSL extension, can then open folders and run commands, extensions, and the terminal in WSL.'), ...buttons);
if (response === learnMore) {
telemetry.reportDialog(Dialog.wslNotInstalled, 'open');
await vscode.env.openExternal(vscode.Uri.parse('https://aka.ms/vscode-remote/wsl/install-wsl'));
} else if (response === installWSL) {
telemetry.reportDialog(Dialog.wslNotInstalled, 'install');
startWSLInstall();
} else {
telemetry.reportDialog(Dialog.wslNotInstalled, 'close');
}
} else {
telemetry.reportDialog(Dialog.wslRemoteNotInstalled, 'show');
const showExtension = localize('showExtensionButton', 'Show Extension');
const res = await vscode.window.showInformationMessage(localize('installRemoteWSLDescription', 'The \'Remote - WSL\' extension is required to complete the action. The extension allows to open a window where commands, extensions and the terminal run in the Linux subsystem.'), showExtension);
if (res === showExtension) {
telemetry.reportDialog(Dialog.wslRemoteNotInstalled, 'open');
await vscode.commands.executeCommand('workbench.extensions.action.showExtensionsWithIds', [ExtensionId.remoteWSL]);
} else {
telemetry.reportDialog(Dialog.wslRemoteNotInstalled, 'close');
}
}
// Start-Process wsl.exe -- -Verb runAs
});
});
addFeature(Experiment.openWSLDocumentation, ContextKey.gettingStarted, () => {
return vscode.commands.registerCommand(CommandId.gettingStarted, async () => {
telemetry.reportCommand(Command.openWSLDocumentation);
return vscode.env.openExternal(vscode.Uri.parse(WSL_DOC_URL));
});
});
}
// this method is called when your extension is deactivated
export function deactivate() { }
export async function checkIfWSLInstalled(): Promise<true | string> {
if (getWindowsBuildNumber() >= 22000) {
const wslExePath = getWSLExecutablePath();
if (wslExePath) {
if (!await fileExists(wslExePath)) {
return `'${wslExePath}' not found`;
}
return new Promise<true | string>(s => {
cp.execFile(wslExePath, ['--status'], (err) => {
if (err) {
s('--status exits with error');
} else {
s(true);
}
});
});
} else {
return `Environment variable 'SystemRoot' not defined`;
}
} else {
const dllPath = getLxssManagerDllPath();
if (dllPath) {
if (await fileExists(dllPath)) {
return true;
} else {
return `'${dllPath}' not found`;
}
} else {
return `Environment variable 'SystemRoot' not defined`;
}
}
}
function hasWSLInstall() {
return getWindowsBuildNumber() >= 20262;
}
function getLxssManagerDllPath(): string | undefined {
const is32ProcessOn64Windows = process.env.hasOwnProperty('PROCESSOR_ARCHITEW6432');
const systemRoot = process.env['SystemRoot'];
if (systemRoot) {
return path.join(systemRoot, is32ProcessOn64Windows ? 'Sysnative' : 'System32', 'lxss', 'LxssManager.dll');
}
return undefined;
}
function getWSLExecutablePath(): string | undefined {
const is32ProcessOn64Windows = process.env.hasOwnProperty('PROCESSOR_ARCHITEW6432');
const systemRoot = process.env['SystemRoot'];
if (systemRoot) {
return path.join(systemRoot, is32ProcessOn64Windows ? 'Sysnative' : 'System32', 'wsl.exe');
}
return undefined;
}
function startWSLInstall() {
const command = [];
command.push('powershell.exe');
command.push('Start-Process');
command.push('-FilePath', 'cmd');
command.push('-ArgumentList', `'/c "${getWSLExecutablePath()} --install & pause"'`);
command.push('-Verb', 'RunAs');
cp.exec(command.join(' '), { encoding: 'utf-8' }, (error, stdout, stderr) => {
if (error) {
console.log(error);
}
console.log(stdout);
console.error(stderr);
});
}
async function fileExists(location: string) {
return promisify(fs.exists)(location);
}
let windowsBuildNumber: number | undefined;
function getWindowsBuildNumber(): number {
if (typeof windowsBuildNumber !== 'number') {
const osVersion = (/(\d+)\.(\d+)\.(\d+)/g).exec(os.release());
if (osVersion && osVersion.length === 4) {
windowsBuildNumber = parseInt(osVersion[3]);
} else {
windowsBuildNumber = 0;
}
}
return windowsBuildNumber;
}