server.ts 32.9 KB
Newer Older
A
Asher 已提交
1
import * as crypto from "crypto";
A
Asher 已提交
2 3
import * as fs from "fs";
import * as http from "http";
A
Asher 已提交
4
import * as https from "https";
A
Asher 已提交
5 6
import * as net from "net";
import * as path from "path";
A
Asher 已提交
7
import * as querystring from "querystring";
A
Asher 已提交
8
import { Readable } from "stream";
A
Asher 已提交
9
import * as tls from "tls";
A
Asher 已提交
10
import * as url from "url";
A
Asher 已提交
11
import * as util from "util";
A
Asher 已提交
12
import { Emitter } from "vs/base/common/event";
A
Asher 已提交
13
import { sanitizeFilePath } from "vs/base/common/extpath";
A
Asher 已提交
14 15
import { Schemas } from "vs/base/common/network";
import { URI, UriComponents } from "vs/base/common/uri";
A
Asher 已提交
16
import { generateUuid } from "vs/base/common/uuid";
A
Asher 已提交
17
import { getMachineId } from 'vs/base/node/id';
A
Asher 已提交
18
import { NLSConfiguration } from "vs/base/node/languagePacks";
A
Asher 已提交
19
import { mkdirp, rimraf } from "vs/base/node/pfs";
A
Asher 已提交
20 21
import { ClientConnectionEvent, IPCServer } from "vs/base/parts/ipc/common/ipc";
import { createChannelReceiver } from "vs/base/parts/ipc/node/ipc";
A
Asher 已提交
22
import { LogsDataCleaner } from "vs/code/electron-browser/sharedProcess/contrib/logsDataCleaner";
A
Asher 已提交
23 24
import { IConfigurationService } from "vs/platform/configuration/common/configuration";
import { ConfigurationService } from "vs/platform/configuration/node/configurationService";
A
Asher 已提交
25
import { ExtensionHostDebugBroadcastChannel } from "vs/platform/debug/common/extensionHostDebugIpc";
A
Asher 已提交
26
import { IEnvironmentService, ParsedArgs } from "vs/platform/environment/common/environment";
A
Asher 已提交
27
import { EnvironmentService } from "vs/platform/environment/node/environmentService";
A
Asher 已提交
28 29 30
import { ExtensionGalleryService } from "vs/platform/extensionManagement/common/extensionGalleryService";
import { IExtensionGalleryService, IExtensionManagementService } from "vs/platform/extensionManagement/common/extensionManagement";
import { ExtensionManagementChannel } from "vs/platform/extensionManagement/common/extensionManagementIpc";
A
Asher 已提交
31
import { ExtensionManagementService } from "vs/platform/extensionManagement/node/extensionManagementService";
A
Asher 已提交
32 33 34
import { IFileService } from "vs/platform/files/common/files";
import { FileService } from "vs/platform/files/common/fileService";
import { DiskFileSystemProvider } from "vs/platform/files/node/diskFileSystemProvider";
A
Asher 已提交
35
import { SyncDescriptor } from "vs/platform/instantiation/common/descriptors";
A
Asher 已提交
36
import { InstantiationService } from "vs/platform/instantiation/common/instantiationService";
A
Asher 已提交
37
import { ServiceCollection } from "vs/platform/instantiation/common/serviceCollection";
A
Asher 已提交
38 39
import { ILocalizationsService } from "vs/platform/localizations/common/localizations";
import { LocalizationsService } from "vs/platform/localizations/node/localizations";
40
import { getLogLevel, ILogService } from "vs/platform/log/common/log";
A
Asher 已提交
41
import { LoggerChannel } from "vs/platform/log/common/logIpc";
A
Asher 已提交
42
import { SpdLogService } from "vs/platform/log/node/spdlogService";
A
Asher 已提交
43 44
import product from 'vs/platform/product/common/product';
import { IProductService } from "vs/platform/product/common/productService";
45
import { ConnectionType, ConnectionTypeRequest } from "vs/platform/remote/common/remoteAgentConnection";
A
Asher 已提交
46
import { REMOTE_FILE_SYSTEM_CHANNEL_NAME } from "vs/platform/remote/common/remoteAgentFileSystemChannel";
A
Asher 已提交
47 48
import { IRequestService } from "vs/platform/request/common/request";
import { RequestChannel } from "vs/platform/request/common/requestIpc";
A
Asher 已提交
49
import { RequestService } from "vs/platform/request/node/requestService";
A
Asher 已提交
50
import ErrorTelemetry from "vs/platform/telemetry/browser/errorTelemetry";
A
Asher 已提交
51
import { ITelemetryService } from "vs/platform/telemetry/common/telemetry";
A
Asher 已提交
52 53
import { ITelemetryServiceConfig, TelemetryService } from "vs/platform/telemetry/common/telemetryService";
import { combinedAppender, LogAppender, NullTelemetryService } from "vs/platform/telemetry/common/telemetryUtils";
A
Asher 已提交
54 55
import { AppInsightsAppender } from "vs/platform/telemetry/node/appInsightsAppender";
import { resolveCommonProperties } from "vs/platform/telemetry/node/commonProperties";
A
Asher 已提交
56 57 58
import { UpdateChannel } from "vs/platform/update/electron-main/updateIpc";
import { INodeProxyService, NodeProxyChannel } from "vs/server/src/common/nodeProxy";
import { TelemetryChannel } from "vs/server/src/common/telemetry";
59 60 61 62 63 64 65
import { ExtensionEnvironmentChannel, FileProviderChannel, NodeProxyService } from "vs/server/src/node/channel";
import { Connection, ExtensionHostConnection, ManagementConnection } from "vs/server/src/node/connection";
import { TelemetryClient } from "vs/server/src/node/insights";
import { getLocaleFromConfig, getNlsConfiguration } from "vs/server/src/node/nls";
import { Protocol } from "vs/server/src/node/protocol";
import { UpdateService } from "vs/server/src/node/update";
import { AuthType, getMediaMime, getUriTransformer, localRequire, tmpdir } from "vs/server/src/node/util";
A
Asher 已提交
66 67
import { RemoteExtensionLogFileName } from "vs/workbench/services/remote/common/remoteAgentService";
import { IWorkbenchConstructionOptions } from "vs/workbench/workbench.web.api";
A
Asher 已提交
68

A
Asher 已提交
69 70
const tarFs = localRequire<typeof import("tar-fs")>("tar-fs/index");

A
Asher 已提交
71
export enum HttpCode {
A
Asher 已提交
72
	Ok = 200,
A
Asher 已提交
73
	Redirect = 302,
A
Asher 已提交
74 75
	NotFound = 404,
	BadRequest = 400,
A
Asher 已提交
76 77 78
	Unauthorized = 401,
	LargePayload = 413,
	ServerError = 500,
A
Asher 已提交
79 80
}

A
Asher 已提交
81
export interface Options {
A
Asher 已提交
82
	WORKBENCH_WEB_CONFIGURATION: IWorkbenchConstructionOptions & { folderUri?: UriComponents, workspaceUri?: UriComponents };
A
Asher 已提交
83
	REMOTE_USER_DATA_URI: UriComponents | URI;
A
Asher 已提交
84
	PRODUCT_CONFIGURATION: Partial<IProductService>;
A
Asher 已提交
85
	NLS_CONFIGURATION: NLSConfiguration;
A
Asher 已提交
86 87
}

88
export interface Response {
A
Asher 已提交
89
	cache?: boolean;
90
	code?: number;
A
Asher 已提交
91 92 93
	content?: string | Buffer;
	filePath?: string;
	headers?: http.OutgoingHttpHeaders;
A
Asher 已提交
94
	mime?: string;
A
Asher 已提交
95
	redirect?: string;
A
Asher 已提交
96
	stream?: Readable;
A
Asher 已提交
97 98 99 100
}

export interface LoginPayload {
	password?: string;
101 102
}

A
Asher 已提交
103
export class HttpError extends Error {
A
Asher 已提交
104 105 106 107 108 109 110 111
	public constructor(message: string, public readonly code: number) {
		super(message);
		// @ts-ignore
		this.name = this.constructor.name;
		Error.captureStackTrace(this, this.constructor);
	}
}

A
Asher 已提交
112
export interface ServerOptions {
A
Asher 已提交
113
	readonly auth: AuthType;
A
Asher 已提交
114
	readonly basePath?: string;
A
Asher 已提交
115
	readonly connectionToken?: string;
A
Asher 已提交
116 117
	readonly cert?: string;
	readonly certKey?: string;
118
	readonly folderUri?: string;
A
Asher 已提交
119 120 121 122
	readonly host?: string;
	readonly password?: string;
	readonly port?: number;
	readonly socket?: string;
A
Asher 已提交
123 124
}

A
Asher 已提交
125
export abstract class Server {
A
Asher 已提交
126
	protected readonly server: http.Server | https.Server;
127
	protected rootPath = path.resolve(__dirname, "../../../../..");
A
Asher 已提交
128 129
	protected serverRoot = path.join(this.rootPath, "/out/vs/server/src");
	protected readonly allowedRequestPaths: string[] = [this.rootPath];
A
Asher 已提交
130
	private listenPromise: Promise<string> | undefined;
A
Asher 已提交
131
	public readonly protocol: "http" | "https";
A
Asher 已提交
132 133 134 135
	public readonly options: ServerOptions;

	public constructor(options: ServerOptions) {
		this.options = {
A
Asher 已提交
136
			host: options.auth === "password" && options.cert ? "0.0.0.0" : "localhost",
A
Asher 已提交
137
			...options,
A
Asher 已提交
138
			basePath: options.basePath ? options.basePath.replace(/\/+$/, "") : "",
A
Asher 已提交
139 140 141
		};
		this.protocol = this.options.cert ? "https" : "http";
		if (this.protocol === "https") {
142
			const httpolyglot = localRequire<typeof import("httpolyglot")>("httpolyglot/lib/index");
A
Asher 已提交
143
			this.server = httpolyglot.createServer({
A
Asher 已提交
144 145
				cert: this.options.cert && fs.readFileSync(this.options.cert),
				key: this.options.certKey && fs.readFileSync(this.options.certKey),
A
Asher 已提交
146 147 148 149
			}, this.onRequest);
		} else {
			this.server = http.createServer(this.onRequest);
		}
A
Asher 已提交
150 151
	}

A
Asher 已提交
152 153 154 155
	public listen(): Promise<string> {
		if (!this.listenPromise) {
			this.listenPromise = new Promise((resolve, reject) => {
				this.server.on("error", reject);
A
Asher 已提交
156
				this.server.on("upgrade", this.onUpgrade);
A
Asher 已提交
157
				const onListen = () => resolve(this.address());
A
Asher 已提交
158 159 160 161 162
				if (this.options.socket) {
					this.server.listen(this.options.socket, onListen);
				} else {
					this.server.listen(this.options.port, this.options.host, onListen);
				}
A
Asher 已提交
163 164 165
			});
		}
		return this.listenPromise;
A
Asher 已提交
166 167
	}

A
Asher 已提交
168
	/**
A
Asher 已提交
169
	 * The *local* address of the server.
A
Asher 已提交
170
	 */
A
Asher 已提交
171
	public address(): string {
A
Asher 已提交
172 173
		const address = this.server.address();
		const endpoint = typeof address !== "string"
A
Asher 已提交
174
			? (address.address === "::" ? "localhost" : address.address) + ":" + address.port
A
Asher 已提交
175
			: address;
A
Asher 已提交
176
		return `${this.protocol}://${endpoint}`;
A
Asher 已提交
177 178
	}

A
Asher 已提交
179 180 181 182 183
	protected abstract handleWebSocket(
		socket: net.Socket,
		parsedUrl: url.UrlWithParsedQuery
	): Promise<void>;

A
Asher 已提交
184 185 186 187 188 189 190
	protected abstract handleRequest(
		base: string,
		requestPath: string,
		parsedUrl: url.UrlWithParsedQuery,
		request: http.IncomingMessage,
	): Promise<Response>;

A
Asher 已提交
191
	protected async getResource(...parts: string[]): Promise<Response> {
A
Asher 已提交
192 193 194 195
		const filePath = this.ensureAuthorizedFilePath(...parts);
		return { content: await util.promisify(fs.readFile)(filePath), filePath };
	}

196 197 198 199 200
	protected async getAnyResource(...parts: string[]): Promise<Response> {
		const filePath = path.join(...parts);
		return { content: await util.promisify(fs.readFile)(filePath), filePath };
	}

A
Asher 已提交
201 202
	protected async getTarredResource(...parts: string[]): Promise<Response> {
		const filePath = this.ensureAuthorizedFilePath(...parts);
A
Asher 已提交
203
		return { stream: tarFs.pack(filePath), filePath, mime: "application/tar", cache: true };
A
Asher 已提交
204 205 206
	}

	protected ensureAuthorizedFilePath(...parts: string[]): string {
A
Asher 已提交
207
		const filePath = path.join(...parts);
A
Asher 已提交
208 209 210
		if (!this.isAllowedRequestPath(filePath)) {
			throw new HttpError("Unauthorized", HttpCode.Unauthorized);
		}
A
Asher 已提交
211
		return filePath;
A
Asher 已提交
212
	}
A
Asher 已提交
213

A
Asher 已提交
214
	protected withBase(request: http.IncomingMessage, path: string): string {
215 216
		const split = request.url ? request.url.split("?", 2) : [];
		return `${this.protocol}://${request.headers.host}${this.options.basePath}${path}${split.length === 2 ? `?${split[1]}` : ""}`;
A
Asher 已提交
217 218
	}

A
Asher 已提交
219 220 221 222 223 224 225 226 227
	private isAllowedRequestPath(path: string): boolean {
		for (let i = 0; i < this.allowedRequestPaths.length; ++i) {
			if (path.indexOf(this.allowedRequestPaths[i]) === 0) {
				return true;
			}
		}
		return false;
	}

A
Asher 已提交
228
	private onRequest = async (request: http.IncomingMessage, response: http.ServerResponse): Promise<void> => {
A
Asher 已提交
229
		try {
A
Asher 已提交
230 231
			const parsedUrl = request.url ? url.parse(request.url, true) : { query: {}};
			const payload = await this.preHandleRequest(request, parsedUrl);
A
Asher 已提交
232
			response.writeHead(payload.redirect ? HttpCode.Redirect : payload.code || HttpCode.Ok, {
A
Asher 已提交
233
				"Content-Type": payload.mime || getMediaMime(payload.filePath),
A
Asher 已提交
234
				...(payload.redirect ? { Location: this.withBase(request, payload.redirect) } : {}),
235
				...(request.headers["service-worker"] ? { "Service-Worker-Allowed": this.options.basePath || "/" } : {}),
A
Asher 已提交
236
				...(payload.cache ? { "Cache-Control": "public, max-age=31536000" } : {}),
A
Asher 已提交
237 238
				...payload.headers,
			});
A
Asher 已提交
239 240 241 242 243 244 245 246 247
			if (payload.stream) {
				payload.stream.on("error", (error: NodeJS.ErrnoException) => {
					response.writeHead(error.code === "ENOENT" ? HttpCode.NotFound : HttpCode.ServerError);
					response.end(error.message);
				});
				payload.stream.pipe(response);
			} else {
				response.end(payload.content);
			}
A
Asher 已提交
248 249 250 251 252 253 254 255 256
		} catch (error) {
			if (error.code === "ENOENT" || error.code === "EISDIR") {
				error = new HttpError("Not found", HttpCode.NotFound);
			}
			response.writeHead(typeof error.code === "number" ? error.code : HttpCode.ServerError);
			response.end(error.message);
		}
	}

A
Asher 已提交
257
	private async preHandleRequest(request: http.IncomingMessage, parsedUrl: url.UrlWithParsedQuery): Promise<Response> {
A
Asher 已提交
258
		const secure = (request.connection as tls.TLSSocket).encrypted;
A
Asher 已提交
259
		if (this.options.cert && !secure) {
A
Asher 已提交
260
			return { redirect: request.url };
A
Asher 已提交
261 262
		}

A
Asher 已提交
263 264
		const fullPath = decodeURIComponent(parsedUrl.pathname || "/");
		const match = fullPath.match(/^(\/?[^/]*)(.*)$/);
265
		let [/* ignore */, base, requestPath] = match
A
Asher 已提交
266
			? match.map((p) => p.replace(/\/+$/, ""))
A
Asher 已提交
267 268 269 270 271 272 273
			: ["", "", ""];
		if (base.indexOf(".") !== -1) { // Assume it's a file at the root.
			requestPath = base;
			base = "/";
		} else if (base === "") { // Happens if it's a plain `domain.com`.
			base = "/";
		}
A
Asher 已提交
274
		base = path.normalize(base);
A
Asher 已提交
275
		requestPath = path.normalize(requestPath || "/index.html");
A
Asher 已提交
276

A
Asher 已提交
277
		if (base !== "/login" || this.options.auth !== "password" || requestPath !== "/index.html") {
A
Asher 已提交
278 279 280
			this.ensureGet(request);
		}

A
Asher 已提交
281 282 283 284 285
		// Allow for a versioned static endpoint. This lets us cache every static
		// resource underneath the path based on the version without any work and
		// without adding query parameters which have their own issues.
		// REVIEW: Discuss whether this is the best option; this is sort of a quick
		// hack almost to get caching in the meantime but it does work pretty well.
A
Asher 已提交
286
		if (/^\/static-/.test(base)) {
A
Asher 已提交
287 288 289
			base = "/static";
		}

A
Asher 已提交
290 291
		switch (base) {
			case "/":
A
Asher 已提交
292 293 294
				switch (requestPath) {
					case "/favicon.ico":
					case "/manifest.json":
A
Asher 已提交
295 296 297
						const response = await this.getResource(this.serverRoot, "media", requestPath);
						response.cache = true;
						return response;
A
Asher 已提交
298 299
				}
				if (!this.authenticate(request)) {
A
Asher 已提交
300
					return { redirect: "/login" };
A
Asher 已提交
301 302
				}
				break;
A
Asher 已提交
303
			case "/static":
A
Asher 已提交
304 305 306
				const response = await this.getResource(this.rootPath, requestPath);
				response.cache = true;
				return response;
A
Asher 已提交
307
			case "/login":
A
Asher 已提交
308
				if (this.options.auth !== "password" || requestPath !== "/index.html") {
A
Asher 已提交
309 310
					throw new HttpError("Not found", HttpCode.NotFound);
				}
A
Asher 已提交
311
				return this.tryLogin(request);
A
Asher 已提交
312 313
			default:
				if (!this.authenticate(request)) {
A
Asher 已提交
314
					throw new HttpError("Unauthorized", HttpCode.Unauthorized);
A
Asher 已提交
315 316 317
				}
				break;
		}
A
Asher 已提交
318

A
Asher 已提交
319 320
		return this.handleRequest(base, requestPath, parsedUrl, request);
	}
A
Asher 已提交
321

A
Asher 已提交
322 323 324 325 326
	private onUpgrade = async (request: http.IncomingMessage, socket: net.Socket): Promise<void> => {
		try {
			await this.preHandleWebSocket(request, socket);
		} catch (error) {
			socket.destroy();
A
Asher 已提交
327
			console.error(error.message);
A
Asher 已提交
328 329 330 331 332 333 334
		}
	}

	private preHandleWebSocket(request: http.IncomingMessage, socket: net.Socket): Promise<void> {
		socket.on("error", () => socket.destroy());
		socket.on("end", () => socket.destroy());

A
Asher 已提交
335
		this.ensureGet(request);
A
Asher 已提交
336 337
		if (!this.authenticate(request)) {
			throw new HttpError("Unauthorized", HttpCode.Unauthorized);
338
		} else if (!request.headers.upgrade || request.headers.upgrade.toLowerCase() !== "websocket") {
A
Asher 已提交
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
			throw new Error("HTTP/1.1 400 Bad Request");
		}

		// This magic value is specified by the websocket spec.
		const magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
		const reply = crypto.createHash("sha1")
			.update(<string>request.headers["sec-websocket-key"] + magic)
			.digest("base64");
		socket.write([
			"HTTP/1.1 101 Switching Protocols",
			"Upgrade: websocket",
			"Connection: Upgrade",
			`Sec-WebSocket-Accept: ${reply}`,
		].join("\r\n") + "\r\n\r\n");

		const parsedUrl = request.url ? url.parse(request.url, true) : { query: {}};
		return this.handleWebSocket(socket, parsedUrl);
	}

A
Asher 已提交
358
	private async tryLogin(request: http.IncomingMessage): Promise<Response> {
A
Asher 已提交
359
		if (this.authenticate(request) && (request.method === "GET" || request.method === "POST")) {
A
Asher 已提交
360
			return { redirect: "/" };
A
Asher 已提交
361 362 363 364 365
		}
		if (request.method === "POST") {
			const data = await this.getData<LoginPayload>(request);
			if (this.authenticate(request, data)) {
				return {
A
Asher 已提交
366
					redirect: "/",
A
Asher 已提交
367
					headers: { "Set-Cookie": `password=${data.password}` }
A
Asher 已提交
368
				};
A
Asher 已提交
369
			}
A
Asher 已提交
370 371 372
			console.error("Failed login attempt", JSON.stringify({
				xForwardedFor: request.headers["x-forwarded-for"],
				remoteAddress: request.connection.remoteAddress,
A
Asher 已提交
373 374
				userAgent: request.headers["user-agent"],
				timestamp: Math.floor(new Date().getTime() / 1000),
A
Asher 已提交
375 376
			}));
			return this.getLogin("Invalid password", data);
A
Asher 已提交
377
		}
A
Asher 已提交
378 379
		this.ensureGet(request);
		return this.getLogin();
A
Asher 已提交
380 381
	}

A
Asher 已提交
382
	private async getLogin(error: string = "", payload?: LoginPayload): Promise<Response> {
A
Asher 已提交
383
		const filePath = path.join(this.serverRoot, "browser/login.html");
A
Asher 已提交
384 385 386 387
		const content = (await util.promisify(fs.readFile)(filePath, "utf8"))
			.replace("{{ERROR}}", error)
			.replace("display:none", error ? "display:block" : "display:none")
			.replace('value=""', `value="${payload && payload.password || ""}"`);
A
Asher 已提交
388 389 390 391 392
		return { content, filePath };
	}

	private ensureGet(request: http.IncomingMessage): void {
		if (request.method !== "GET") {
A
Asher 已提交
393
			throw new HttpError(`Unsupported method ${request.method}`, HttpCode.BadRequest);
A
Asher 已提交
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
		}
	}

	private getData<T extends object>(request: http.IncomingMessage): Promise<T> {
		return request.method === "POST"
			? new Promise<T>((resolve, reject) => {
				let body = "";
				const onEnd = (): void => {
					off();
					resolve(querystring.parse(body) as T);
				};
				const onError = (error: Error): void => {
					off();
					reject(error);
				};
				const onData = (d: Buffer): void => {
					body += d;
					if (body.length > 1e6) {
A
Asher 已提交
412
						onError(new HttpError("Payload is too large", HttpCode.LargePayload));
A
Asher 已提交
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
						request.connection.destroy();
					}
				};
				const off = (): void => {
					request.off("error", onError);
					request.off("data", onError);
					request.off("end", onEnd);
				};
				request.on("error", onError);
				request.on("data", onData);
				request.on("end", onEnd);
			})
			: Promise.resolve({} as T);
	}

	private authenticate(request: http.IncomingMessage, payload?: LoginPayload): boolean {
A
Asher 已提交
429
		if (this.options.auth !== "password") {
A
Asher 已提交
430 431
			return true;
		}
432
		const safeCompare = localRequire<typeof import("safe-compare")>("safe-compare/index");
A
Asher 已提交
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
		if (typeof payload === "undefined") {
			payload = this.parseCookies<LoginPayload>(request);
		}
		return !!this.options.password && safeCompare(payload.password || "", this.options.password);
	}

	private parseCookies<T extends object>(request: http.IncomingMessage): T {
		const cookies: { [key: string]: string } = {};
		if (request.headers.cookie) {
			request.headers.cookie.split(";").forEach((keyValue) => {
				const [key, value] = keyValue.split("=", 2);
				cookies[key.trim()] = decodeURI(value);
			});
		}
		return cookies as T;
A
Asher 已提交
448
	}
A
Asher 已提交
449 450
}

A
Asher 已提交
451 452 453 454 455 456 457 458 459
interface StartPath {
	path?: string[] | string;
	workspace?: boolean;
}

interface Settings {
	lastVisited?: StartPath;
}

A
Asher 已提交
460 461 462 463 464
export class MainServer extends Server {
	public readonly _onDidClientConnect = new Emitter<ClientConnectionEvent>();
	public readonly onDidClientConnect = this._onDidClientConnect.event;
	private readonly ipc = new IPCServer(this.onDidClientConnect);

465
	private readonly maxExtraOfflineConnections = 0;
A
Asher 已提交
466 467 468
	private readonly connections = new Map<ConnectionType, Map<string, Connection>>();

	private readonly services = new ServiceCollection();
A
Asher 已提交
469
	private readonly servicesPromise: Promise<void>;
A
Asher 已提交
470

A
Asher 已提交
471 472 473 474 475
	public readonly _onProxyConnect = new Emitter<net.Socket>();
	private proxyPipe = path.join(tmpdir, "tls-proxy");
	private _proxyServer?: Promise<net.Server>;
	private readonly proxyTimeout = 5000;

A
Asher 已提交
476 477
	private settings: Settings = {};

A
Asher 已提交
478
	public constructor(options: ServerOptions, args: ParsedArgs) {
A
Asher 已提交
479
		super(options);
A
Asher 已提交
480
		this.servicesPromise = this.initializeServices(args);
A
Asher 已提交
481
	}
A
Asher 已提交
482

A
Asher 已提交
483 484
	public async listen(): Promise<string> {
		const environment = (this.services.get(IEnvironmentService) as EnvironmentService);
A
Asher 已提交
485 486 487 488
		const [address] = await Promise.all<string>([
			super.listen(), ...[
				environment.extensionsPath,
			].map((p) => mkdirp(p).then(() => p)),
A
Asher 已提交
489 490 491 492
		]);
		return address;
	}

A
Asher 已提交
493
	protected async handleWebSocket(socket: net.Socket, parsedUrl: url.UrlWithParsedQuery): Promise<void> {
A
Asher 已提交
494 495 496
		if (!parsedUrl.query.reconnectionToken) {
			throw new Error("Reconnection token is missing from query parameters");
		}
A
Asher 已提交
497
		const protocol = new Protocol(await this.createProxy(socket), {
A
Asher 已提交
498
			reconnectionToken: <string>parsedUrl.query.reconnectionToken,
A
Asher 已提交
499 500 501 502 503 504 505 506 507 508 509 510
			reconnection: parsedUrl.query.reconnection === "true",
			skipWebSocketFrames: parsedUrl.query.skipWebSocketFrames === "true",
		});
		try {
			await this.connect(await protocol.handshake(), protocol);
		} catch (error) {
			protocol.sendMessage({ type: "error", reason: error.message });
			protocol.dispose();
			protocol.getSocket().dispose();
		}
	}

A
Asher 已提交
511
	protected async handleRequest(
512
		base: string,
A
Asher 已提交
513
		requestPath: string,
A
Asher 已提交
514 515
		parsedUrl: url.UrlWithParsedQuery,
		request: http.IncomingMessage,
516 517
	): Promise<Response> {
		switch (base) {
A
Asher 已提交
518
			case "/": return this.getRoot(request, parsedUrl);
A
Asher 已提交
519 520 521 522
			case "/resource":
			case "/vscode-remote-resource":
				if (typeof parsedUrl.query.path === "string") {
					return this.getResource(parsedUrl.query.path);
523
				}
A
Asher 已提交
524
				break;
A
Asher 已提交
525 526 527 528 529
			case "/tar":
				if (typeof parsedUrl.query.path === "string") {
					return this.getTarredResource(parsedUrl.query.path);
				}
				break;
A
Asher 已提交
530
			case "/webview":
A
Asher 已提交
531
				if (/^\/vscode-resource/.test(requestPath)) {
532
					return this.getAnyResource(requestPath.replace(/^\/vscode-resource(\/file)?/, ""));
533
				}
A
Asher 已提交
534 535 536 537 538
				return this.getResource(
					this.rootPath,
					"out/vs/workbench/contrib/webview/browser/pre",
					requestPath
				);
539
		}
A
Asher 已提交
540
		throw new HttpError("Not found", HttpCode.NotFound);
541
	}
A
Asher 已提交
542

543
	private async getRoot(request: http.IncomingMessage, parsedUrl: url.UrlWithParsedQuery): Promise<Response> {
A
Asher 已提交
544
		const filePath = path.join(this.serverRoot, "browser/workbench.html");
A
Asher 已提交
545
		let [content, startPath] = await Promise.all([
A
Asher 已提交
546
			util.promisify(fs.readFile)(filePath, "utf8"),
A
Asher 已提交
547 548 549 550 551 552
			this.getFirstValidPath([
				{ path: parsedUrl.query.workspace, workspace: true },
				{ path: parsedUrl.query.folder },
				(await this.readSettings()).lastVisited,
				{ path: this.options.folderUri }
			]),
A
Asher 已提交
553 554
			this.servicesPromise,
		]);
A
Asher 已提交
555

A
Asher 已提交
556 557 558 559 560 561 562 563 564
		if (startPath) {
			this.writeSettings({
				lastVisited: {
					path: startPath.uri.fsPath,
					workspace: startPath.workspace
				},
			});
		}

565 566
		const logger = this.services.get(ILogService) as ILogService;
		logger.info("request.url", `"${request.url}"`);
A
Asher 已提交
567

A
Asher 已提交
568 569
		const remoteAuthority = request.headers.host as string;
		const transformer = getUriTransformer(remoteAuthority);
A
Asher 已提交
570 571

		const environment = this.services.get(IEnvironmentService) as IEnvironmentService;
572
		const options: Options = {
A
Asher 已提交
573
			WORKBENCH_WEB_CONFIGURATION: {
A
Asher 已提交
574 575
				workspaceUri: startPath && startPath.workspace ? transformer.transformOutgoing(startPath.uri) : undefined,
				folderUri: startPath && !startPath.workspace ? transformer.transformOutgoing(startPath.uri) : undefined,
576
				remoteAuthority,
A
Asher 已提交
577 578 579 580 581
				logLevel: getLogLevel(environment),
			},
			REMOTE_USER_DATA_URI: transformer.transformOutgoing(URI.file(environment.userDataPath)),
			PRODUCT_CONFIGURATION: {
				extensionsGallery: product.extensionsGallery,
582
			},
A
Asher 已提交
583
			NLS_CONFIGURATION: await getNlsConfiguration(environment.args.locale || await getLocaleFromConfig(environment.userDataPath), environment.userDataPath),
584 585
		};

A
Asher 已提交
586
		content = content.replace(/{{COMMIT}}/g, product.commit || "");
A
Asher 已提交
587 588 589
		for (const key in options) {
			content = content.replace(`"{{${key}}}"`, `'${JSON.stringify(options[key as keyof Options])}'`);
		}
590

A
Asher 已提交
591
		return { content, filePath };
A
Asher 已提交
592 593
	}

A
Asher 已提交
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
	/**
	 * Choose the first valid path.
	 */
	private async getFirstValidPath(startPaths: Array<StartPath | undefined>): Promise<{ uri: URI, workspace?: boolean} | undefined> {
		const logger = this.services.get(ILogService) as ILogService;
		const cwd = process.env.VSCODE_CWD || process.cwd();
		for (let i = 0; i < startPaths.length; ++i) {
			const startPath = startPaths[i];
			if (!startPath) {
				continue;
			}
			const paths = typeof startPath.path === "string" ? [startPath.path] : (startPath.path || []);
			for (let j = 0; j < paths.length; ++j) {
				const uri = URI.file(sanitizeFilePath(paths[j], cwd));
				try {
					const stat = await util.promisify(fs.stat)(uri.fsPath);
					// Workspace must be a file.
					if (!!startPath.workspace !== stat.isDirectory()) {
						return { uri, workspace: startPath.workspace };
					}
				} catch (error) {
					logger.warn(error.message);
				}
			}
		}
		return undefined;
	}

622
	private async connect(message: ConnectionTypeRequest, protocol: Protocol): Promise<void> {
A
Asher 已提交
623 624 625 626
		if (product.commit && message.commit !== product.commit) {
			throw new Error(`Version mismatch (${message.commit} instead of ${product.commit})`);
		}

627 628 629 630 631 632 633 634
		switch (message.desiredConnectionType) {
			case ConnectionType.ExtensionHost:
			case ConnectionType.Management:
				if (!this.connections.has(message.desiredConnectionType)) {
					this.connections.set(message.desiredConnectionType, new Map());
				}
				const connections = this.connections.get(message.desiredConnectionType)!;

A
Asher 已提交
635 636 637 638 639 640 641
				const ok = async () => {
					return message.desiredConnectionType === ConnectionType.ExtensionHost
						? { debugPort: await this.getDebugPort() }
						: { type: "ok" };
				};

				const token = protocol.options.reconnectionToken;
642
				if (protocol.options.reconnection && connections.has(token)) {
A
Asher 已提交
643
					protocol.sendMessage(await ok());
644 645
					const buffer = protocol.readEntireBuffer();
					protocol.dispose();
A
Asher 已提交
646
					return connections.get(token)!.reconnect(protocol.getSocket(), buffer);
A
Asher 已提交
647
				} else if (protocol.options.reconnection || connections.has(token)) {
648 649 650 651 652 653
					throw new Error(protocol.options.reconnection
						? "Unrecognized reconnection token"
						: "Duplicate reconnection token"
					);
				}

A
Asher 已提交
654
				protocol.sendMessage(await ok());
655 656 657

				let connection: Connection;
				if (message.desiredConnectionType === ConnectionType.Management) {
658
					connection = new ManagementConnection(protocol, token);
659
					this._onDidClientConnect.fire({
A
Asher 已提交
660
						protocol, onDidClientDisconnect: connection.onClose,
661
					});
A
Asher 已提交
662 663 664
					// TODO: Need a way to match clients with a connection. For now
					// dispose everything which only works because no extensions currently
					// utilize long-running proxies.
A
Asher 已提交
665 666
					(this.services.get(INodeProxyService) as NodeProxyService)._onUp.fire();
					connection.onClose(() => (this.services.get(INodeProxyService) as NodeProxyService)._onDown.fire());
667
				} else {
A
Asher 已提交
668
					const buffer = protocol.readEntireBuffer();
A
Asher 已提交
669
					connection = new ExtensionHostConnection(
A
Asher 已提交
670
						message.args ? message.args.language : "en",
671
						protocol, buffer, token,
A
Asher 已提交
672 673
						this.services.get(ILogService) as ILogService,
						this.services.get(IEnvironmentService) as IEnvironmentService,
A
Asher 已提交
674
					);
675
				}
A
Asher 已提交
676 677
				connections.set(token, connection);
				connection.onClose(() => connections.delete(token));
678
				this.disposeOldOfflineConnections(connections);
679 680 681 682 683 684
				break;
			case ConnectionType.Tunnel: return protocol.tunnel();
			default: throw new Error("Unrecognized connection type");
		}
	}

685 686 687 688 689 690
	private disposeOldOfflineConnections(connections: Map<string, Connection>): void {
		const offline = Array.from(connections.values())
			.filter((connection) => typeof connection.offline !== "undefined");
		for (let i = 0, max = offline.length - this.maxExtraOfflineConnections; i < max; ++i) {
			offline[i].dispose();
		}
691 692
	}

A
Asher 已提交
693 694 695
	private async initializeServices(args: ParsedArgs): Promise<void> {
		const environmentService = new EnvironmentService(args, process.execPath);
		const logService = new SpdLogService(RemoteExtensionLogFileName, environmentService.logsPath, getLogLevel(environmentService));
A
Asher 已提交
696 697 698
		const fileService = new FileService(logService);
		fileService.registerProvider(Schemas.file, new DiskFileSystemProvider(logService));

A
Asher 已提交
699 700 701 702 703 704 705 706
		this.allowedRequestPaths.push(
			path.join(environmentService.userDataPath, "clp"), // Language packs.
			environmentService.extensionsPath,
			environmentService.builtinExtensionsPath,
			...environmentService.extraExtensionPaths,
			...environmentService.extraBuiltinExtensionPaths,
		);

A
Asher 已提交
707
		this.ipc.registerChannel("logger", new LoggerChannel(logService));
A
Asher 已提交
708
		this.ipc.registerChannel(ExtensionHostDebugBroadcastChannel.ChannelName, new ExtensionHostDebugBroadcastChannel());
A
Asher 已提交
709 710 711 712 713

		this.services.set(ILogService, logService);
		this.services.set(IEnvironmentService, environmentService);
		this.services.set(IConfigurationService, new SyncDescriptor(ConfigurationService, [environmentService.machineSettingsResource]));
		this.services.set(IRequestService, new SyncDescriptor(RequestService));
A
Asher 已提交
714
		this.services.set(IFileService, fileService);
A
Asher 已提交
715
		this.services.set(IProductService, { _serviceBrand: undefined, ...product });
A
Asher 已提交
716
		this.services.set(IExtensionGalleryService, new SyncDescriptor(ExtensionGalleryService));
A
Asher 已提交
717 718
		this.services.set(IExtensionManagementService, new SyncDescriptor(ExtensionManagementService));

A
Asher 已提交
719 720 721 722 723 724 725
		if (!environmentService.args["disable-telemetry"]) {
			this.services.set(ITelemetryService, new SyncDescriptor(TelemetryService, [{
				appender: combinedAppender(
					new AppInsightsAppender("code-server", null, () => new TelemetryClient(), logService),
					new LogAppender(logService),
				),
				commonProperties: resolveCommonProperties(
A
Asher 已提交
726
					product.commit, product.codeServerVersion, await getMachineId(),
A
Asher 已提交
727
					[], environmentService.installSourcePath, "code-server",
A
Asher 已提交
728
				),
A
Asher 已提交
729
				piiPaths: this.allowedRequestPaths,
A
Asher 已提交
730 731 732 733 734
			} as ITelemetryServiceConfig]));
		} else {
			this.services.set(ITelemetryService, NullTelemetryService);
		}

A
Asher 已提交
735 736
		await new Promise((resolve) => {
			const instantiationService = new InstantiationService(this.services);
A
Asher 已提交
737 738 739
			this.services.set(ILocalizationsService, instantiationService.createInstance(LocalizationsService));
			this.services.set(INodeProxyService, instantiationService.createInstance(NodeProxyService));

A
Asher 已提交
740 741
			instantiationService.invokeFunction(() => {
				instantiationService.createInstance(LogsDataCleaner);
A
Asher 已提交
742
				const telemetryService = this.services.get(ITelemetryService) as ITelemetryService;
A
Asher 已提交
743 744 745 746 747 748 749 750 751 752 753 754 755
				this.ipc.registerChannel("extensions", new ExtensionManagementChannel(
					this.services.get(IExtensionManagementService) as IExtensionManagementService,
					(context) => getUriTransformer(context.remoteAuthority),
				));
				this.ipc.registerChannel("remoteextensionsenvironment", new ExtensionEnvironmentChannel(
					environmentService, logService, telemetryService, this.options.connectionToken || "",
				));
				this.ipc.registerChannel("request", new RequestChannel(this.services.get(IRequestService) as IRequestService));
				this.ipc.registerChannel("telemetry", new TelemetryChannel(telemetryService));
				this.ipc.registerChannel("nodeProxy", new NodeProxyChannel(this.services.get(INodeProxyService) as INodeProxyService));
				this.ipc.registerChannel("localizations", createChannelReceiver(this.services.get(ILocalizationsService) as ILocalizationsService));
				this.ipc.registerChannel("update", new UpdateChannel(instantiationService.createInstance(UpdateService)));
				this.ipc.registerChannel(REMOTE_FILE_SYSTEM_CHANNEL_NAME, new FileProviderChannel(environmentService, logService));
A
Asher 已提交
756
				resolve(new ErrorTelemetry(telemetryService));
A
Asher 已提交
757 758 759 760
			});
		});
	}

761 762 763 764 765 766
	/**
	 * TODO: implement.
	 */
	private async getDebugPort(): Promise<number | undefined> {
		return undefined;
	}
A
Asher 已提交
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

	/**
	 * Since we can't pass TLS sockets to children, use this to proxy the socket
	 * and pass a non-TLS socket.
	 */
	private createProxy = async (socket: net.Socket): Promise<net.Socket> => {
		if (!(socket instanceof tls.TLSSocket)) {
			return socket;
		}

		await this.startProxyServer();

		return new Promise((resolve, reject) => {
			const timeout = setTimeout(() => {
				listener.dispose();
				socket.destroy();
				proxy.destroy();
				reject(new Error("TLS socket proxy timed out"));
			}, this.proxyTimeout);

			const listener = this._onProxyConnect.event((connection) => {
				connection.once("data", (data) => {
					if (!socket.destroyed && !proxy.destroyed && data.toString() === id) {
						clearTimeout(timeout);
						listener.dispose();
						[[proxy, socket], [socket, proxy]].forEach(([a, b]) => {
							a.pipe(b);
							a.on("error", () => b.destroy());
							a.on("close", () => b.destroy());
							a.on("end", () => b.end());
						});
						resolve(connection);
					}
				});
			});

			const id = generateUuid();
			const proxy = net.connect(this.proxyPipe);
			proxy.once("connect", () => proxy.write(id));
		});
	}

	private async startProxyServer(): Promise<net.Server> {
		if (!this._proxyServer) {
			this._proxyServer = new Promise(async (resolve) => {
				this.proxyPipe = await this.findFreeSocketPath(this.proxyPipe);
				await mkdirp(tmpdir);
				await rimraf(this.proxyPipe);
				const proxyServer = net.createServer((p) => this._onProxyConnect.fire(p));
				proxyServer.once("listening", resolve);
				proxyServer.listen(this.proxyPipe);
			});
		}
		return this._proxyServer;
	}

	private async findFreeSocketPath(basePath: string, maxTries: number = 100): Promise<string> {
		const canConnect = (path: string): Promise<boolean> => {
			return new Promise((resolve) => {
				const socket = net.connect(path);
				socket.once("error", () => resolve(false));
				socket.once("connect", () => {
					socket.destroy();
					resolve(true);
				});
			});
		};

		let i = 0;
		let path = basePath;
		while (await canConnect(path) && i < maxTries) {
			path = `${basePath}-${++i}`;
		}
		return path;
	}
A
Asher 已提交
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

	/**
	 * Return the file path for Coder settings.
	 */
	private get settingsPath(): string {
		const environment = this.services.get(IEnvironmentService) as IEnvironmentService;
		return path.join(environment.userDataPath, "coder.json");
	}

	/**
	 * Read settings from the file. On a failure return last known settings and
	 * log a warning.
	 *
	 */
	private async readSettings(): Promise<Settings> {
		try {
			const raw = (await util.promisify(fs.readFile)(this.settingsPath, "utf8")).trim();
			this.settings = raw ? JSON.parse(raw) : {};
		} catch (error) {
			if (error.code !== "ENOENT") {
				(this.services.get(ILogService) as ILogService).warn(error.message);
			}
		}
		return this.settings;
	}

	/**
	 * Write settings combined with current settings. On failure log a warning.
	 */
	private async writeSettings(newSettings: Partial<Settings>): Promise<void> {
		this.settings = { ...this.settings, ...newSettings };
		try {
			await util.promisify(fs.writeFile)(this.settingsPath, JSON.stringify(this.settings));
		} catch (error) {
			(this.services.get(ILogService) as ILogService).warn(error.message);
		}
	}
A
Asher 已提交
879
}