95693fb58e
See #1103.
875 lines
33 KiB
TypeScript
875 lines
33 KiB
TypeScript
import * as crypto from "crypto";
|
|
import * as fs from "fs";
|
|
import * as http from "http";
|
|
import * as https from "https";
|
|
import * as net from "net";
|
|
import * as path from "path";
|
|
import * as querystring from "querystring";
|
|
import { Readable } from "stream";
|
|
import * as tls from "tls";
|
|
import * as url from "url";
|
|
import * as util from "util";
|
|
import { Emitter } from "vs/base/common/event";
|
|
import { sanitizeFilePath } from "vs/base/common/extpath";
|
|
import { Schemas } from "vs/base/common/network";
|
|
import { URI, UriComponents } from "vs/base/common/uri";
|
|
import { generateUuid } from "vs/base/common/uuid";
|
|
import { getMachineId } from 'vs/base/node/id';
|
|
import { NLSConfiguration } from "vs/base/node/languagePacks";
|
|
import { mkdirp, rimraf } from "vs/base/node/pfs";
|
|
import { ClientConnectionEvent, IPCServer } from "vs/base/parts/ipc/common/ipc";
|
|
import { createChannelReceiver } from "vs/base/parts/ipc/node/ipc";
|
|
import { LogsDataCleaner } from "vs/code/electron-browser/sharedProcess/contrib/logsDataCleaner";
|
|
import { IConfigurationService } from "vs/platform/configuration/common/configuration";
|
|
import { ConfigurationService } from "vs/platform/configuration/node/configurationService";
|
|
import { ExtensionHostDebugBroadcastChannel } from "vs/platform/debug/common/extensionHostDebugIpc";
|
|
import { IEnvironmentService, ParsedArgs } from "vs/platform/environment/common/environment";
|
|
import { EnvironmentService } from "vs/platform/environment/node/environmentService";
|
|
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";
|
|
import { ExtensionManagementService } from "vs/platform/extensionManagement/node/extensionManagementService";
|
|
import { IFileService } from "vs/platform/files/common/files";
|
|
import { FileService } from "vs/platform/files/common/fileService";
|
|
import { DiskFileSystemProvider } from "vs/platform/files/node/diskFileSystemProvider";
|
|
import { SyncDescriptor } from "vs/platform/instantiation/common/descriptors";
|
|
import { InstantiationService } from "vs/platform/instantiation/common/instantiationService";
|
|
import { ServiceCollection } from "vs/platform/instantiation/common/serviceCollection";
|
|
import { ILocalizationsService } from "vs/platform/localizations/common/localizations";
|
|
import { LocalizationsService } from "vs/platform/localizations/node/localizations";
|
|
import { getLogLevel, ILogService } from "vs/platform/log/common/log";
|
|
import { LoggerChannel } from "vs/platform/log/common/logIpc";
|
|
import { SpdLogService } from "vs/platform/log/node/spdlogService";
|
|
import product from 'vs/platform/product/common/product';
|
|
import { IProductService } from "vs/platform/product/common/productService";
|
|
import { ConnectionType, ConnectionTypeRequest } from "vs/platform/remote/common/remoteAgentConnection";
|
|
import { REMOTE_FILE_SYSTEM_CHANNEL_NAME } from "vs/platform/remote/common/remoteAgentFileSystemChannel";
|
|
import { IRequestService } from "vs/platform/request/common/request";
|
|
import { RequestChannel } from "vs/platform/request/common/requestIpc";
|
|
import { RequestService } from "vs/platform/request/node/requestService";
|
|
import ErrorTelemetry from "vs/platform/telemetry/browser/errorTelemetry";
|
|
import { ITelemetryService } from "vs/platform/telemetry/common/telemetry";
|
|
import { ITelemetryServiceConfig, TelemetryService } from "vs/platform/telemetry/common/telemetryService";
|
|
import { combinedAppender, LogAppender, NullTelemetryService } from "vs/platform/telemetry/common/telemetryUtils";
|
|
import { AppInsightsAppender } from "vs/platform/telemetry/node/appInsightsAppender";
|
|
import { resolveCommonProperties } from "vs/platform/telemetry/node/commonProperties";
|
|
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";
|
|
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";
|
|
import { RemoteExtensionLogFileName } from "vs/workbench/services/remote/common/remoteAgentService";
|
|
import { IWorkbenchConstructionOptions } from "vs/workbench/workbench.web.api";
|
|
|
|
const tarFs = localRequire<typeof import("tar-fs")>("tar-fs/index");
|
|
|
|
export enum HttpCode {
|
|
Ok = 200,
|
|
Redirect = 302,
|
|
NotFound = 404,
|
|
BadRequest = 400,
|
|
Unauthorized = 401,
|
|
LargePayload = 413,
|
|
ServerError = 500,
|
|
}
|
|
|
|
export interface Options {
|
|
WORKBENCH_WEB_CONFIGURATION: IWorkbenchConstructionOptions & { folderUri?: UriComponents, workspaceUri?: UriComponents };
|
|
REMOTE_USER_DATA_URI: UriComponents | URI;
|
|
PRODUCT_CONFIGURATION: Partial<IProductService>;
|
|
NLS_CONFIGURATION: NLSConfiguration;
|
|
}
|
|
|
|
export interface Response {
|
|
cache?: boolean;
|
|
code?: number;
|
|
content?: string | Buffer;
|
|
filePath?: string;
|
|
headers?: http.OutgoingHttpHeaders;
|
|
mime?: string;
|
|
redirect?: string;
|
|
stream?: Readable;
|
|
}
|
|
|
|
export interface LoginPayload {
|
|
password?: string;
|
|
}
|
|
|
|
export class HttpError extends Error {
|
|
public constructor(message: string, public readonly code: number) {
|
|
super(message);
|
|
// @ts-ignore
|
|
this.name = this.constructor.name;
|
|
Error.captureStackTrace(this, this.constructor);
|
|
}
|
|
}
|
|
|
|
export interface ServerOptions {
|
|
readonly auth: AuthType;
|
|
readonly basePath?: string;
|
|
readonly connectionToken?: string;
|
|
readonly cert?: string;
|
|
readonly certKey?: string;
|
|
readonly folderUri?: string;
|
|
readonly host?: string;
|
|
readonly password?: string;
|
|
readonly port?: number;
|
|
readonly socket?: string;
|
|
}
|
|
|
|
export abstract class Server {
|
|
protected readonly server: http.Server | https.Server;
|
|
protected rootPath = path.resolve(__dirname, "../../../../..");
|
|
protected serverRoot = path.join(this.rootPath, "/out/vs/server/src");
|
|
protected readonly allowedRequestPaths: string[] = [this.rootPath];
|
|
private listenPromise: Promise<string> | undefined;
|
|
public readonly protocol: "http" | "https";
|
|
public readonly options: ServerOptions;
|
|
|
|
public constructor(options: ServerOptions) {
|
|
this.options = {
|
|
host: options.auth === "password" && options.cert ? "0.0.0.0" : "localhost",
|
|
...options,
|
|
basePath: options.basePath ? options.basePath.replace(/\/+$/, "") : "",
|
|
};
|
|
this.protocol = this.options.cert ? "https" : "http";
|
|
if (this.protocol === "https") {
|
|
const httpolyglot = localRequire<typeof import("httpolyglot")>("httpolyglot/lib/index");
|
|
this.server = httpolyglot.createServer({
|
|
cert: this.options.cert && fs.readFileSync(this.options.cert),
|
|
key: this.options.certKey && fs.readFileSync(this.options.certKey),
|
|
}, this.onRequest);
|
|
} else {
|
|
this.server = http.createServer(this.onRequest);
|
|
}
|
|
}
|
|
|
|
public listen(): Promise<string> {
|
|
if (!this.listenPromise) {
|
|
this.listenPromise = new Promise((resolve, reject) => {
|
|
this.server.on("error", reject);
|
|
this.server.on("upgrade", this.onUpgrade);
|
|
const onListen = () => resolve(this.address());
|
|
if (this.options.socket) {
|
|
this.server.listen(this.options.socket, onListen);
|
|
} else {
|
|
this.server.listen(this.options.port, this.options.host, onListen);
|
|
}
|
|
});
|
|
}
|
|
return this.listenPromise;
|
|
}
|
|
|
|
/**
|
|
* The *local* address of the server.
|
|
*/
|
|
public address(): string {
|
|
const address = this.server.address();
|
|
const endpoint = typeof address !== "string"
|
|
? (address.address === "::" ? "localhost" : address.address) + ":" + address.port
|
|
: address;
|
|
return `${this.protocol}://${endpoint}`;
|
|
}
|
|
|
|
protected abstract handleWebSocket(
|
|
socket: net.Socket,
|
|
parsedUrl: url.UrlWithParsedQuery
|
|
): Promise<void>;
|
|
|
|
protected abstract handleRequest(
|
|
base: string,
|
|
requestPath: string,
|
|
parsedUrl: url.UrlWithParsedQuery,
|
|
request: http.IncomingMessage,
|
|
): Promise<Response>;
|
|
|
|
protected async getResource(...parts: string[]): Promise<Response> {
|
|
const filePath = this.ensureAuthorizedFilePath(...parts);
|
|
return { content: await util.promisify(fs.readFile)(filePath), filePath };
|
|
}
|
|
|
|
protected async getTarredResource(...parts: string[]): Promise<Response> {
|
|
const filePath = this.ensureAuthorizedFilePath(...parts);
|
|
return { stream: tarFs.pack(filePath), filePath, mime: "application/tar", cache: true };
|
|
}
|
|
|
|
protected ensureAuthorizedFilePath(...parts: string[]): string {
|
|
const filePath = path.join(...parts);
|
|
if (!this.isAllowedRequestPath(filePath)) {
|
|
throw new HttpError("Unauthorized", HttpCode.Unauthorized);
|
|
}
|
|
return filePath;
|
|
}
|
|
|
|
protected withBase(request: http.IncomingMessage, path: string): string {
|
|
const split = request.url ? request.url.split("?", 2) : [];
|
|
return `${this.protocol}://${request.headers.host}${this.options.basePath}${path}${split.length === 2 ? `?${split[1]}` : ""}`;
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
private onRequest = async (request: http.IncomingMessage, response: http.ServerResponse): Promise<void> => {
|
|
try {
|
|
const parsedUrl = request.url ? url.parse(request.url, true) : { query: {}};
|
|
const payload = await this.preHandleRequest(request, parsedUrl);
|
|
response.writeHead(payload.redirect ? HttpCode.Redirect : payload.code || HttpCode.Ok, {
|
|
"Content-Type": payload.mime || getMediaMime(payload.filePath),
|
|
...(payload.redirect ? { Location: this.withBase(request, payload.redirect) } : {}),
|
|
...(request.headers["service-worker"] ? { "Service-Worker-Allowed": this.options.basePath || "/" } : {}),
|
|
...(payload.cache ? { "Cache-Control": "public, max-age=31536000" } : {}),
|
|
...payload.headers,
|
|
});
|
|
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);
|
|
}
|
|
} 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);
|
|
}
|
|
}
|
|
|
|
private async preHandleRequest(request: http.IncomingMessage, parsedUrl: url.UrlWithParsedQuery): Promise<Response> {
|
|
const secure = (request.connection as tls.TLSSocket).encrypted;
|
|
if (this.options.cert && !secure) {
|
|
return { redirect: request.url };
|
|
}
|
|
|
|
const fullPath = decodeURIComponent(parsedUrl.pathname || "/");
|
|
const match = fullPath.match(/^(\/?[^/]*)(.*)$/);
|
|
let [/* ignore */, base, requestPath] = match
|
|
? match.map((p) => p.replace(/\/+$/, ""))
|
|
: ["", "", ""];
|
|
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 = "/";
|
|
}
|
|
base = path.normalize(base);
|
|
requestPath = path.normalize(requestPath || "/index.html");
|
|
|
|
if (base !== "/login" || this.options.auth !== "password" || requestPath !== "/index.html") {
|
|
this.ensureGet(request);
|
|
}
|
|
|
|
// 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.
|
|
if (/^\/static-/.test(base)) {
|
|
base = "/static";
|
|
}
|
|
|
|
switch (base) {
|
|
case "/":
|
|
switch (requestPath) {
|
|
case "/favicon.ico":
|
|
case "/manifest.json":
|
|
const response = await this.getResource(this.serverRoot, "media", requestPath);
|
|
response.cache = true;
|
|
return response;
|
|
}
|
|
if (!this.authenticate(request)) {
|
|
return { redirect: "/login" };
|
|
}
|
|
break;
|
|
case "/static":
|
|
const response = await this.getResource(this.rootPath, requestPath);
|
|
response.cache = true;
|
|
return response;
|
|
case "/login":
|
|
if (this.options.auth !== "password" || requestPath !== "/index.html") {
|
|
throw new HttpError("Not found", HttpCode.NotFound);
|
|
}
|
|
return this.tryLogin(request);
|
|
default:
|
|
if (!this.authenticate(request)) {
|
|
throw new HttpError("Unauthorized", HttpCode.Unauthorized);
|
|
}
|
|
break;
|
|
}
|
|
|
|
return this.handleRequest(base, requestPath, parsedUrl, request);
|
|
}
|
|
|
|
private onUpgrade = async (request: http.IncomingMessage, socket: net.Socket): Promise<void> => {
|
|
try {
|
|
await this.preHandleWebSocket(request, socket);
|
|
} catch (error) {
|
|
socket.destroy();
|
|
console.error(error.message);
|
|
}
|
|
}
|
|
|
|
private preHandleWebSocket(request: http.IncomingMessage, socket: net.Socket): Promise<void> {
|
|
socket.on("error", () => socket.destroy());
|
|
socket.on("end", () => socket.destroy());
|
|
|
|
this.ensureGet(request);
|
|
if (!this.authenticate(request)) {
|
|
throw new HttpError("Unauthorized", HttpCode.Unauthorized);
|
|
} else if (!request.headers.upgrade || request.headers.upgrade.toLowerCase() !== "websocket") {
|
|
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);
|
|
}
|
|
|
|
private async tryLogin(request: http.IncomingMessage): Promise<Response> {
|
|
if (this.authenticate(request) && (request.method === "GET" || request.method === "POST")) {
|
|
return { redirect: "/" };
|
|
}
|
|
if (request.method === "POST") {
|
|
const data = await this.getData<LoginPayload>(request);
|
|
if (this.authenticate(request, data)) {
|
|
return {
|
|
redirect: "/",
|
|
headers: { "Set-Cookie": `password=${data.password}` }
|
|
};
|
|
}
|
|
console.error("Failed login attempt", JSON.stringify({
|
|
xForwardedFor: request.headers["x-forwarded-for"],
|
|
remoteAddress: request.connection.remoteAddress,
|
|
userAgent: request.headers["user-agent"],
|
|
timestamp: Math.floor(new Date().getTime() / 1000),
|
|
}));
|
|
return this.getLogin("Invalid password", data);
|
|
}
|
|
this.ensureGet(request);
|
|
return this.getLogin();
|
|
}
|
|
|
|
private async getLogin(error: string = "", payload?: LoginPayload): Promise<Response> {
|
|
const filePath = path.join(this.serverRoot, "browser/login.html");
|
|
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 || ""}"`);
|
|
return { content, filePath };
|
|
}
|
|
|
|
private ensureGet(request: http.IncomingMessage): void {
|
|
if (request.method !== "GET") {
|
|
throw new HttpError(`Unsupported method ${request.method}`, HttpCode.BadRequest);
|
|
}
|
|
}
|
|
|
|
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) {
|
|
onError(new HttpError("Payload is too large", HttpCode.LargePayload));
|
|
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 {
|
|
if (this.options.auth !== "password") {
|
|
return true;
|
|
}
|
|
const safeCompare = localRequire<typeof import("safe-compare")>("safe-compare/index");
|
|
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;
|
|
}
|
|
}
|
|
|
|
interface StartPath {
|
|
path?: string[] | string;
|
|
workspace?: boolean;
|
|
}
|
|
|
|
interface Settings {
|
|
lastVisited?: StartPath;
|
|
}
|
|
|
|
export class MainServer extends Server {
|
|
public readonly _onDidClientConnect = new Emitter<ClientConnectionEvent>();
|
|
public readonly onDidClientConnect = this._onDidClientConnect.event;
|
|
private readonly ipc = new IPCServer(this.onDidClientConnect);
|
|
|
|
private readonly maxExtraOfflineConnections = 0;
|
|
private readonly connections = new Map<ConnectionType, Map<string, Connection>>();
|
|
|
|
private readonly services = new ServiceCollection();
|
|
private readonly servicesPromise: Promise<void>;
|
|
|
|
public readonly _onProxyConnect = new Emitter<net.Socket>();
|
|
private proxyPipe = path.join(tmpdir, "tls-proxy");
|
|
private _proxyServer?: Promise<net.Server>;
|
|
private readonly proxyTimeout = 5000;
|
|
|
|
private settings: Settings = {};
|
|
|
|
public constructor(options: ServerOptions, args: ParsedArgs) {
|
|
super(options);
|
|
this.servicesPromise = this.initializeServices(args);
|
|
}
|
|
|
|
public async listen(): Promise<string> {
|
|
const environment = (this.services.get(IEnvironmentService) as EnvironmentService);
|
|
const [address] = await Promise.all<string>([
|
|
super.listen(), ...[
|
|
environment.extensionsPath,
|
|
].map((p) => mkdirp(p).then(() => p)),
|
|
]);
|
|
return address;
|
|
}
|
|
|
|
protected async handleWebSocket(socket: net.Socket, parsedUrl: url.UrlWithParsedQuery): Promise<void> {
|
|
if (!parsedUrl.query.reconnectionToken) {
|
|
throw new Error("Reconnection token is missing from query parameters");
|
|
}
|
|
const protocol = new Protocol(await this.createProxy(socket), {
|
|
reconnectionToken: <string>parsedUrl.query.reconnectionToken,
|
|
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();
|
|
}
|
|
}
|
|
|
|
protected async handleRequest(
|
|
base: string,
|
|
requestPath: string,
|
|
parsedUrl: url.UrlWithParsedQuery,
|
|
request: http.IncomingMessage,
|
|
): Promise<Response> {
|
|
switch (base) {
|
|
case "/": return this.getRoot(request, parsedUrl);
|
|
case "/resource":
|
|
case "/vscode-remote-resource":
|
|
if (typeof parsedUrl.query.path === "string") {
|
|
return this.getResource(parsedUrl.query.path);
|
|
}
|
|
break;
|
|
case "/tar":
|
|
if (typeof parsedUrl.query.path === "string") {
|
|
return this.getTarredResource(parsedUrl.query.path);
|
|
}
|
|
break;
|
|
case "/webview":
|
|
if (/^\/vscode-resource/.test(requestPath)) {
|
|
return this.getResource(requestPath.replace(/^\/vscode-resource(\/file)?/, ""));
|
|
}
|
|
return this.getResource(
|
|
this.rootPath,
|
|
"out/vs/workbench/contrib/webview/browser/pre",
|
|
requestPath
|
|
);
|
|
}
|
|
throw new HttpError("Not found", HttpCode.NotFound);
|
|
}
|
|
|
|
private async getRoot(request: http.IncomingMessage, parsedUrl: url.UrlWithParsedQuery): Promise<Response> {
|
|
const filePath = path.join(this.serverRoot, "browser/workbench.html");
|
|
let [content, startPath] = await Promise.all([
|
|
util.promisify(fs.readFile)(filePath, "utf8"),
|
|
this.getFirstValidPath([
|
|
{ path: parsedUrl.query.workspace, workspace: true },
|
|
{ path: parsedUrl.query.folder },
|
|
(await this.readSettings()).lastVisited,
|
|
{ path: this.options.folderUri }
|
|
]),
|
|
this.servicesPromise,
|
|
]);
|
|
|
|
if (startPath) {
|
|
this.writeSettings({
|
|
lastVisited: {
|
|
path: startPath.uri.fsPath,
|
|
workspace: startPath.workspace
|
|
},
|
|
});
|
|
}
|
|
|
|
const logger = this.services.get(ILogService) as ILogService;
|
|
logger.info("request.url", `"${request.url}"`);
|
|
|
|
const remoteAuthority = request.headers.host as string;
|
|
const transformer = getUriTransformer(remoteAuthority);
|
|
|
|
const environment = this.services.get(IEnvironmentService) as IEnvironmentService;
|
|
const options: Options = {
|
|
WORKBENCH_WEB_CONFIGURATION: {
|
|
workspaceUri: startPath && startPath.workspace ? transformer.transformOutgoing(startPath.uri) : undefined,
|
|
folderUri: startPath && !startPath.workspace ? transformer.transformOutgoing(startPath.uri) : undefined,
|
|
remoteAuthority,
|
|
logLevel: getLogLevel(environment),
|
|
},
|
|
REMOTE_USER_DATA_URI: transformer.transformOutgoing(URI.file(environment.userDataPath)),
|
|
PRODUCT_CONFIGURATION: {
|
|
extensionsGallery: product.extensionsGallery,
|
|
},
|
|
NLS_CONFIGURATION: await getNlsConfiguration(environment.args.locale || await getLocaleFromConfig(environment.userDataPath), environment.userDataPath),
|
|
};
|
|
|
|
content = content.replace(/{{COMMIT}}/g, product.commit || "");
|
|
for (const key in options) {
|
|
content = content.replace(`"{{${key}}}"`, `'${JSON.stringify(options[key as keyof Options])}'`);
|
|
}
|
|
|
|
return { content, filePath };
|
|
}
|
|
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
private async connect(message: ConnectionTypeRequest, protocol: Protocol): Promise<void> {
|
|
if (product.commit && message.commit !== product.commit) {
|
|
throw new Error(`Version mismatch (${message.commit} instead of ${product.commit})`);
|
|
}
|
|
|
|
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)!;
|
|
|
|
const ok = async () => {
|
|
return message.desiredConnectionType === ConnectionType.ExtensionHost
|
|
? { debugPort: await this.getDebugPort() }
|
|
: { type: "ok" };
|
|
};
|
|
|
|
const token = protocol.options.reconnectionToken;
|
|
if (protocol.options.reconnection && connections.has(token)) {
|
|
protocol.sendMessage(await ok());
|
|
const buffer = protocol.readEntireBuffer();
|
|
protocol.dispose();
|
|
return connections.get(token)!.reconnect(protocol.getSocket(), buffer);
|
|
} else if (protocol.options.reconnection || connections.has(token)) {
|
|
throw new Error(protocol.options.reconnection
|
|
? "Unrecognized reconnection token"
|
|
: "Duplicate reconnection token"
|
|
);
|
|
}
|
|
|
|
protocol.sendMessage(await ok());
|
|
|
|
let connection: Connection;
|
|
if (message.desiredConnectionType === ConnectionType.Management) {
|
|
connection = new ManagementConnection(protocol, token);
|
|
this._onDidClientConnect.fire({
|
|
protocol, onDidClientDisconnect: connection.onClose,
|
|
});
|
|
// 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.
|
|
(this.services.get(INodeProxyService) as NodeProxyService)._onUp.fire();
|
|
connection.onClose(() => (this.services.get(INodeProxyService) as NodeProxyService)._onDown.fire());
|
|
} else {
|
|
const buffer = protocol.readEntireBuffer();
|
|
connection = new ExtensionHostConnection(
|
|
message.args ? message.args.language : "en",
|
|
protocol, buffer, token,
|
|
this.services.get(ILogService) as ILogService,
|
|
this.services.get(IEnvironmentService) as IEnvironmentService,
|
|
);
|
|
}
|
|
connections.set(token, connection);
|
|
connection.onClose(() => connections.delete(token));
|
|
this.disposeOldOfflineConnections(connections);
|
|
break;
|
|
case ConnectionType.Tunnel: return protocol.tunnel();
|
|
default: throw new Error("Unrecognized connection type");
|
|
}
|
|
}
|
|
|
|
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();
|
|
}
|
|
}
|
|
|
|
private async initializeServices(args: ParsedArgs): Promise<void> {
|
|
const environmentService = new EnvironmentService(args, process.execPath);
|
|
const logService = new SpdLogService(RemoteExtensionLogFileName, environmentService.logsPath, getLogLevel(environmentService));
|
|
const fileService = new FileService(logService);
|
|
fileService.registerProvider(Schemas.file, new DiskFileSystemProvider(logService));
|
|
|
|
this.allowedRequestPaths.push(
|
|
path.join(environmentService.userDataPath, "clp"), // Language packs.
|
|
environmentService.extensionsPath,
|
|
environmentService.builtinExtensionsPath,
|
|
...environmentService.extraExtensionPaths,
|
|
...environmentService.extraBuiltinExtensionPaths,
|
|
);
|
|
|
|
this.ipc.registerChannel("logger", new LoggerChannel(logService));
|
|
this.ipc.registerChannel(ExtensionHostDebugBroadcastChannel.ChannelName, new ExtensionHostDebugBroadcastChannel());
|
|
|
|
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));
|
|
this.services.set(IFileService, fileService);
|
|
this.services.set(IProductService, { _serviceBrand: undefined, ...product });
|
|
this.services.set(IExtensionGalleryService, new SyncDescriptor(ExtensionGalleryService));
|
|
this.services.set(IExtensionManagementService, new SyncDescriptor(ExtensionManagementService));
|
|
|
|
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(
|
|
product.commit, product.codeServerVersion, await getMachineId(),
|
|
[], environmentService.installSourcePath, "code-server",
|
|
),
|
|
piiPaths: this.allowedRequestPaths,
|
|
} as ITelemetryServiceConfig]));
|
|
} else {
|
|
this.services.set(ITelemetryService, NullTelemetryService);
|
|
}
|
|
|
|
await new Promise((resolve) => {
|
|
const instantiationService = new InstantiationService(this.services);
|
|
this.services.set(ILocalizationsService, instantiationService.createInstance(LocalizationsService));
|
|
this.services.set(INodeProxyService, instantiationService.createInstance(NodeProxyService));
|
|
|
|
instantiationService.invokeFunction(() => {
|
|
instantiationService.createInstance(LogsDataCleaner);
|
|
const telemetryService = this.services.get(ITelemetryService) as ITelemetryService;
|
|
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));
|
|
resolve(new ErrorTelemetry(telemetryService));
|
|
});
|
|
});
|
|
}
|
|
|
|
/**
|
|
* TODO: implement.
|
|
*/
|
|
private async getDebugPort(): Promise<number | undefined> {
|
|
return undefined;
|
|
}
|
|
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
}
|
|
}
|