@theia/remote 1.45.1 → 1.46.0-next.72

package/src/electron-browser/remote-registry-contribution.ts

@@ -1,70 +1,70 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { Command, CommandHandler, Emitter, Event } from '@theia/core';
-import { inject, injectable } from '@theia/core/shared/inversify';
-import { WindowService } from '@theia/core/lib/browser/window/window-service';
-import { WindowSearchParams } from '@theia/core/lib/common/window';
-
-export const RemoteRegistryContribution = Symbol('RemoteRegistryContribution');
-
-export interface RemoteRegistryContribution {
-    registerRemoteCommands(registry: RemoteRegistry): void;
-}
-
-@injectable()
-export abstract class AbstractRemoteRegistryContribution implements RemoteRegistryContribution {
-
-    @inject(WindowService)
-    protected readonly windowService: WindowService;
-
-    abstract registerRemoteCommands(registry: RemoteRegistry): void;
-
-    protected openRemote(port: string, newWindow: boolean): void {
-        const searchParams = new URLSearchParams(location.search);
-        const localPort = searchParams.get('localPort') || searchParams.get('port');
-        const options: WindowSearchParams = {
-            port
-        };
-        if (localPort) {
-            options.localPort = localPort;
-        }
-        if (newWindow) {
-            this.windowService.openNewDefaultWindow(options);
-        } else {
-            this.windowService.reload(options);
-        }
-    }
-}
-
-export class RemoteRegistry {
-
-    protected _commands: Command[] = [];
-    protected onDidRegisterCommandEmitter = new Emitter<[Command, CommandHandler | undefined]>();
-
-    get commands(): readonly Command[] {
-        return this._commands;
-    }
-
-    get onDidRegisterCommand(): Event<[Command, CommandHandler | undefined]> {
-        return this.onDidRegisterCommandEmitter.event;
-    }
-
-    registerCommand(command: Command, handler?: CommandHandler): void {
-        this.onDidRegisterCommandEmitter.fire([command, handler]);
-        this._commands.push(command);
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { Command, CommandHandler, Emitter, Event } from '@theia/core';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { WindowService } from '@theia/core/lib/browser/window/window-service';
+import { WindowSearchParams } from '@theia/core/lib/common/window';
+
+export const RemoteRegistryContribution = Symbol('RemoteRegistryContribution');
+
+export interface RemoteRegistryContribution {
+    registerRemoteCommands(registry: RemoteRegistry): void;
+}
+
+@injectable()
+export abstract class AbstractRemoteRegistryContribution implements RemoteRegistryContribution {
+
+    @inject(WindowService)
+    protected readonly windowService: WindowService;
+
+    abstract registerRemoteCommands(registry: RemoteRegistry): void;
+
+    protected openRemote(port: string, newWindow: boolean): void {
+        const searchParams = new URLSearchParams(location.search);
+        const localPort = searchParams.get('localPort') || searchParams.get('port');
+        const options: WindowSearchParams = {
+            port
+        };
+        if (localPort) {
+            options.localPort = localPort;
+        }
+        if (newWindow) {
+            this.windowService.openNewDefaultWindow(options);
+        } else {
+            this.windowService.reload(options);
+        }
+    }
+}
+
+export class RemoteRegistry {
+
+    protected _commands: Command[] = [];
+    protected onDidRegisterCommandEmitter = new Emitter<[Command, CommandHandler | undefined]>();
+
+    get commands(): readonly Command[] {
+        return this._commands;
+    }
+
+    get onDidRegisterCommand(): Event<[Command, CommandHandler | undefined]> {
+        return this.onDidRegisterCommandEmitter.event;
+    }
+
+    registerCommand(command: Command, handler?: CommandHandler): void {
+        this.onDidRegisterCommandEmitter.fire([command, handler]);
+        this._commands.push(command);
+    }
+}

package/src/electron-browser/remote-service.ts

@@ -1,31 +1,31 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { injectable } from '@theia/core/shared/inversify';
-
-@injectable()
-export class RemoteService {
-
-    protected _connected: boolean;
-
-    isConnected(): boolean {
-        return this._connected;
-    }
-
-    setConnected(value: boolean): void {
-        this._connected = value;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable } from '@theia/core/shared/inversify';
+
+@injectable()
+export class RemoteService {
+
+    protected _connected: boolean;
+
+    isConnected(): boolean {
+        return this._connected;
+    }
+
+    setConnected(value: boolean): void {
+        this._connected = value;
+    }
+}

package/src/electron-browser/remote-ssh-contribution.ts

@@ -1,102 +1,102 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { Command, MessageService, nls, QuickInputService } from '@theia/core';
-import { inject, injectable } from '@theia/core/shared/inversify';
-import { RemoteSSHConnectionProvider } from '../electron-common/remote-ssh-connection-provider';
-import { AbstractRemoteRegistryContribution, RemoteRegistry } from './remote-registry-contribution';
-import { RemotePreferences } from './remote-preferences';
-
-export namespace RemoteSSHCommands {
-    export const CONNECT: Command = Command.toLocalizedCommand({
-        id: 'remote.ssh.connect',
-        category: 'SSH',
-        label: 'Connect to Host...',
-    }, 'theia/remoteSSH/connect');
-    export const CONNECT_CURRENT_WINDOW: Command = Command.toLocalizedCommand({
-        id: 'remote.ssh.connectCurrentWindow',
-        category: 'SSH',
-        label: 'Connect Current Window to Host...',
-    }, 'theia/remoteSSH/connect');
-}
-
-@injectable()
-export class RemoteSSHContribution extends AbstractRemoteRegistryContribution {
-
-    @inject(QuickInputService)
-    protected readonly quickInputService: QuickInputService;
-
-    @inject(RemoteSSHConnectionProvider)
-    protected readonly sshConnectionProvider: RemoteSSHConnectionProvider;
-
-    @inject(MessageService)
-    protected readonly messageService: MessageService;
-
-    @inject(RemotePreferences)
-    protected readonly remotePreferences: RemotePreferences;
-
-    registerRemoteCommands(registry: RemoteRegistry): void {
-        registry.registerCommand(RemoteSSHCommands.CONNECT, {
-            execute: () => this.connect(true)
-        });
-        registry.registerCommand(RemoteSSHCommands.CONNECT_CURRENT_WINDOW, {
-            execute: () => this.connect(false)
-        });
-    }
-
-    async connect(newWindow: boolean): Promise<void> {
-        let host: string | undefined;
-        let user: string | undefined;
-        host = await this.quickInputService.input({
-            title: nls.localize('theia/remote/enterHost', 'Enter SSH host name'),
-            placeHolder: nls.localize('theia/remote/hostPlaceHolder', 'E.g. hello@example.com')
-        });
-        if (!host) {
-            this.messageService.error(nls.localize('theia/remote/needsHost', 'Please enter a host name.'));
-            return;
-        }
-        if (host.includes('@')) {
-            const split = host.split('@');
-            user = split[0];
-            host = split[1];
-        }
-        if (!user) {
-            user = await this.quickInputService.input({
-                title: nls.localize('theia/remote/enterUser', 'Enter SSH user name'),
-                placeHolder: nls.localize('theia/remote/userPlaceHolder', 'E.g. hello')
-            });
-        }
-        if (!user) {
-            this.messageService.error(nls.localize('theia/remote/needsUser', 'Please enter a user name.'));
-            return;
-        }
-
-        try {
-            const remotePort = await this.sendSSHConnect(host!, user!);
-            this.openRemote(remotePort, newWindow);
-        } catch (err) {
-            this.messageService.error(`${nls.localize('theia/remote/sshFailure', 'Could not open SSH connection to remote.')} ${err.message ?? String(err)}`);
-        }
-    }
-
-    async sendSSHConnect(host: string, user: string): Promise<string> {
-        return this.sshConnectionProvider.establishConnection({
-            host,
-            user,
-            nodeDownloadTemplate: this.remotePreferences['remote.nodeDownloadTemplate']
-        });
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { Command, MessageService, nls, QuickInputService } from '@theia/core';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { RemoteSSHConnectionProvider } from '../electron-common/remote-ssh-connection-provider';
+import { AbstractRemoteRegistryContribution, RemoteRegistry } from './remote-registry-contribution';
+import { RemotePreferences } from './remote-preferences';
+
+export namespace RemoteSSHCommands {
+    export const CONNECT: Command = Command.toLocalizedCommand({
+        id: 'remote.ssh.connect',
+        category: 'SSH',
+        label: 'Connect to Host...',
+    }, 'theia/remoteSSH/connect');
+    export const CONNECT_CURRENT_WINDOW: Command = Command.toLocalizedCommand({
+        id: 'remote.ssh.connectCurrentWindow',
+        category: 'SSH',
+        label: 'Connect Current Window to Host...',
+    }, 'theia/remoteSSH/connect');
+}
+
+@injectable()
+export class RemoteSSHContribution extends AbstractRemoteRegistryContribution {
+
+    @inject(QuickInputService)
+    protected readonly quickInputService: QuickInputService;
+
+    @inject(RemoteSSHConnectionProvider)
+    protected readonly sshConnectionProvider: RemoteSSHConnectionProvider;
+
+    @inject(MessageService)
+    protected readonly messageService: MessageService;
+
+    @inject(RemotePreferences)
+    protected readonly remotePreferences: RemotePreferences;
+
+    registerRemoteCommands(registry: RemoteRegistry): void {
+        registry.registerCommand(RemoteSSHCommands.CONNECT, {
+            execute: () => this.connect(true)
+        });
+        registry.registerCommand(RemoteSSHCommands.CONNECT_CURRENT_WINDOW, {
+            execute: () => this.connect(false)
+        });
+    }
+
+    async connect(newWindow: boolean): Promise<void> {
+        let host: string | undefined;
+        let user: string | undefined;
+        host = await this.quickInputService.input({
+            title: nls.localize('theia/remote/enterHost', 'Enter SSH host name'),
+            placeHolder: nls.localize('theia/remote/hostPlaceHolder', 'E.g. hello@example.com')
+        });
+        if (!host) {
+            this.messageService.error(nls.localize('theia/remote/needsHost', 'Please enter a host name.'));
+            return;
+        }
+        if (host.includes('@')) {
+            const split = host.split('@');
+            user = split[0];
+            host = split[1];
+        }
+        if (!user) {
+            user = await this.quickInputService.input({
+                title: nls.localize('theia/remote/enterUser', 'Enter SSH user name'),
+                placeHolder: nls.localize('theia/remote/userPlaceHolder', 'E.g. hello')
+            });
+        }
+        if (!user) {
+            this.messageService.error(nls.localize('theia/remote/needsUser', 'Please enter a user name.'));
+            return;
+        }
+
+        try {
+            const remotePort = await this.sendSSHConnect(host!, user!);
+            this.openRemote(remotePort, newWindow);
+        } catch (err) {
+            this.messageService.error(`${nls.localize('theia/remote/sshFailure', 'Could not open SSH connection to remote.')} ${err.message ?? String(err)}`);
+        }
+    }
+
+    async sendSSHConnect(host: string, user: string): Promise<string> {
+        return this.sshConnectionProvider.establishConnection({
+            host,
+            user,
+            nodeDownloadTemplate: this.remotePreferences['remote.nodeDownloadTemplate']
+        });
+    }
+}

package/src/electron-common/remote-ssh-connection-provider.ts

@@ -1,29 +1,29 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-export const RemoteSSHConnectionProviderPath = '/remote/ssh';
-
-export const RemoteSSHConnectionProvider = Symbol('RemoteSSHConnectionProvider');
-
-export interface RemoteSSHConnectionProviderOptions {
-    user: string;
-    host: string;
-    nodeDownloadTemplate?: string;
-}
-
-export interface RemoteSSHConnectionProvider {
-    establishConnection(options: RemoteSSHConnectionProviderOptions): Promise<string>;
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+export const RemoteSSHConnectionProviderPath = '/remote/ssh';
+
+export const RemoteSSHConnectionProvider = Symbol('RemoteSSHConnectionProvider');
+
+export interface RemoteSSHConnectionProviderOptions {
+    user: string;
+    host: string;
+    nodeDownloadTemplate?: string;
+}
+
+export interface RemoteSSHConnectionProvider {
+    establishConnection(options: RemoteSSHConnectionProviderOptions): Promise<string>;
+}

package/src/electron-common/remote-status-service.ts

@@ -1,35 +1,35 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-export type RemoteStatus = RemoteConnectedStatus | RemoteDisconnectedStatus;
-
-export interface RemoteDisconnectedStatus {
-    alive: false;
-}
-
-export interface RemoteConnectedStatus {
-    alive: true;
-    type: string;
-    name: string;
-}
-
-export const RemoteStatusServicePath = '/remote/status';
-
-export const RemoteStatusService = Symbol('RemoteStatusService');
-
-export interface RemoteStatusService {
-    getStatus(localPort: number): Promise<RemoteStatus>
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+export type RemoteStatus = RemoteConnectedStatus | RemoteDisconnectedStatus;
+
+export interface RemoteDisconnectedStatus {
+    alive: false;
+}
+
+export interface RemoteConnectedStatus {
+    alive: true;
+    type: string;
+    name: string;
+}
+
+export const RemoteStatusServicePath = '/remote/status';
+
+export const RemoteStatusService = Symbol('RemoteStatusService');
+
+export interface RemoteStatusService {
+    getStatus(localPort: number): Promise<RemoteStatus>
+}

package/src/electron-node/backend-remote-service-impl.ts

@@ -1,45 +1,45 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { CliContribution } from '@theia/core/lib/node';
-import { injectable } from '@theia/core/shared/inversify';
-import { Arguments, Argv } from '@theia/core/shared/yargs';
-import { BackendRemoteService } from '@theia/core/lib/node/backend-remote-service';
-
-export const REMOTE_START = 'remote';
-
-@injectable()
-export class BackendRemoteServiceImpl extends BackendRemoteService implements CliContribution {
-
-    protected isRemote: boolean = false;
-
-    configure(conf: Argv): void {
-        conf.option(REMOTE_START, {
-            description: 'Starts the server as an endpoint for a remote connection (i.e. through SSH)',
-            type: 'boolean',
-            default: false
-        });
-    }
-
-    setArguments(args: Arguments): void {
-        this.isRemote = Boolean(args[REMOTE_START]);
-    }
-
-    override isRemoteServer(): boolean {
-        return this.isRemote;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { CliContribution } from '@theia/core/lib/node';
+import { injectable } from '@theia/core/shared/inversify';
+import { Arguments, Argv } from '@theia/core/shared/yargs';
+import { BackendRemoteService } from '@theia/core/lib/node/backend-remote-service';
+
+export const REMOTE_START = 'remote';
+
+@injectable()
+export class BackendRemoteServiceImpl extends BackendRemoteService implements CliContribution {
+
+    protected isRemote: boolean = false;
+
+    configure(conf: Argv): void {
+        conf.option(REMOTE_START, {
+            description: 'Starts the server as an endpoint for a remote connection (i.e. through SSH)',
+            type: 'boolean',
+            default: false
+        });
+    }
+
+    setArguments(args: Arguments): void {
+        this.isRemote = Boolean(args[REMOTE_START]);
+    }
+
+    override isRemoteServer(): boolean {
+        return this.isRemote;
+    }
+
+}