@theia/plugin-ext 1.34.1 → 1.34.3

package/src/main/browser/webview/webview-environment.ts

@@ -1,83 +1,83 @@
-// *****************************************************************************
-// Copyright (C) 2019 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 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
-import { Endpoint } from '@theia/core/lib/browser/endpoint';
-import { Deferred } from '@theia/core/lib/common/promise-util';
-import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
-import URI from '@theia/core/lib/common/uri';
-import { WebviewExternalEndpoint } from '../../common/webview-protocol';
-import { environment } from '@theia/core/shared/@theia/application-package/lib/environment';
-
-@injectable()
-export class WebviewEnvironment {
-
-    protected _hostPatternPromise: Promise<string>;
-
-    protected readonly externalEndpointHost = new Deferred<string>();
-
-    @inject(EnvVariablesServer)
-    protected readonly environments: EnvVariablesServer;
-
-    @postConstruct()
-    protected async init(): Promise<void> {
-        this._hostPatternPromise = this.getHostPattern();
-        try {
-            const endpointPattern = await this.hostPatternPromise;
-            const { host } = new Endpoint();
-            this.externalEndpointHost.resolve(endpointPattern.replace('{{hostname}}', host));
-        } catch (e) {
-            this.externalEndpointHost.reject(e);
-        }
-    }
-
-    get hostPatternPromise(): Promise<string> {
-        return this._hostPatternPromise;
-    }
-
-    async externalEndpointUrl(): Promise<URI> {
-        const host = await this.externalEndpointHost.promise;
-        return new Endpoint({
-            host,
-            path: '/webview'
-        }).getRestUrl();
-    }
-
-    async externalEndpoint(): Promise<string> {
-        return (await this.externalEndpointUrl()).toString(true);
-    }
-
-    async resourceRoot(host: string): Promise<string> {
-        if (host === 'frontend') {
-            return (await this.externalEndpointUrl()).withPath('{{path}}').toString(true);
-        }
-
-        // Make sure we preserve the scheme of the resource but convert it into a normal path segment
-        // The scheme is important as we need to know if we are requesting a local or a remote resource.
-        return (await this.externalEndpointUrl()).resolve('theia-resource/{{scheme}}//{{authority}}/{{path}}').toString(true);
-    }
-
-    async cspSource(): Promise<string> {
-        return (await this.externalEndpointUrl()).withPath('').withQuery('').withFragment('').toString(true).replace('{{uuid}}', '*');
-    }
-
-    protected async getHostPattern(): Promise<string> {
-        return environment.electron.is()
-            ? WebviewExternalEndpoint.defaultPattern
-            : this.environments.getValue(WebviewExternalEndpoint.pattern)
-                .then(variable => variable?.value || WebviewExternalEndpoint.defaultPattern);
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2019 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 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
+import { Endpoint } from '@theia/core/lib/browser/endpoint';
+import { Deferred } from '@theia/core/lib/common/promise-util';
+import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
+import URI from '@theia/core/lib/common/uri';
+import { WebviewExternalEndpoint } from '../../common/webview-protocol';
+import { environment } from '@theia/core/shared/@theia/application-package/lib/environment';
+
+@injectable()
+export class WebviewEnvironment {
+
+    protected _hostPatternPromise: Promise<string>;
+
+    protected readonly externalEndpointHost = new Deferred<string>();
+
+    @inject(EnvVariablesServer)
+    protected readonly environments: EnvVariablesServer;
+
+    @postConstruct()
+    protected async init(): Promise<void> {
+        this._hostPatternPromise = this.getHostPattern();
+        try {
+            const endpointPattern = await this.hostPatternPromise;
+            const { host } = new Endpoint();
+            this.externalEndpointHost.resolve(endpointPattern.replace('{{hostname}}', host));
+        } catch (e) {
+            this.externalEndpointHost.reject(e);
+        }
+    }
+
+    get hostPatternPromise(): Promise<string> {
+        return this._hostPatternPromise;
+    }
+
+    async externalEndpointUrl(): Promise<URI> {
+        const host = await this.externalEndpointHost.promise;
+        return new Endpoint({
+            host,
+            path: '/webview'
+        }).getRestUrl();
+    }
+
+    async externalEndpoint(): Promise<string> {
+        return (await this.externalEndpointUrl()).toString(true);
+    }
+
+    async resourceRoot(host: string): Promise<string> {
+        if (host === 'frontend') {
+            return (await this.externalEndpointUrl()).withPath('{{path}}').toString(true);
+        }
+
+        // Make sure we preserve the scheme of the resource but convert it into a normal path segment
+        // The scheme is important as we need to know if we are requesting a local or a remote resource.
+        return (await this.externalEndpointUrl()).resolve('theia-resource/{{scheme}}//{{authority}}/{{path}}').toString(true);
+    }
+
+    async cspSource(): Promise<string> {
+        return (await this.externalEndpointUrl()).withPath('').withQuery('').withFragment('').toString(true).replace('{{uuid}}', '*');
+    }
+
+    protected async getHostPattern(): Promise<string> {
+        return environment.electron.is()
+            ? WebviewExternalEndpoint.defaultPattern
+            : this.environments.getValue(WebviewExternalEndpoint.pattern)
+                .then(variable => variable?.value || WebviewExternalEndpoint.defaultPattern);
+    }
+}

package/src/main/browser/webview/webview-frontend-security-warnings.ts

@@ -1,59 +1,59 @@
-// *****************************************************************************
-// Copyright (C) 2021 Ericsson 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 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { MessageService } from '@theia/core';
-import { Dialog, FrontendApplicationContribution } from '@theia/core/lib/browser';
-import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
-import { nls } from '@theia/core/lib/common/nls';
-import { WindowService } from '@theia/core/lib/browser/window/window-service';
-import { inject, injectable } from '@theia/core/shared/inversify';
-import { WebviewExternalEndpoint } from '../../common/webview-protocol';
-import { WebviewEnvironment } from './webview-environment';
-
-@injectable()
-export class WebviewFrontendSecurityWarnings implements FrontendApplicationContribution {
-
-    @inject(WindowService)
-    protected windowService: WindowService;
-
-    @inject(MessageService)
-    protected messageService: MessageService;
-
-    @inject(WebviewEnvironment)
-    protected webviewEnvironment: WebviewEnvironment;
-
-    initialize(): void {
-        this.checkHostPattern();
-    }
-
-    protected async checkHostPattern(): Promise<void> {
-        if (FrontendApplicationConfigProvider.get()['warnOnPotentiallyInsecureHostPattern'] === false) {
-            return;
-        }
-        const hostPattern = await this.webviewEnvironment.hostPatternPromise;
-        if (hostPattern !== WebviewExternalEndpoint.defaultPattern) {
-            const goToReadme = nls.localize('theia/webview/goToReadme', 'Go To README');
-            const message = nls.localize('theia/webview/messageWarning', '\
-            The {0} endpoint\'s host pattern has been changed to `{1}`; changing the pattern can lead to security vulnerabilities. \
-            See `{2}` for more information.', 'webview', hostPattern, '@theia/plugin-ext/README.md');
-            this.messageService.warn(message, Dialog.OK, goToReadme).then(action => {
-                if (action === goToReadme) {
-                    this.windowService.openNewWindow('https://www.npmjs.com/package/@theia/plugin-ext', { external: true });
-                }
-            });
-        }
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2021 Ericsson 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 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { MessageService } from '@theia/core';
+import { Dialog, FrontendApplicationContribution } from '@theia/core/lib/browser';
+import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
+import { nls } from '@theia/core/lib/common/nls';
+import { WindowService } from '@theia/core/lib/browser/window/window-service';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { WebviewExternalEndpoint } from '../../common/webview-protocol';
+import { WebviewEnvironment } from './webview-environment';
+
+@injectable()
+export class WebviewFrontendSecurityWarnings implements FrontendApplicationContribution {
+
+    @inject(WindowService)
+    protected windowService: WindowService;
+
+    @inject(MessageService)
+    protected messageService: MessageService;
+
+    @inject(WebviewEnvironment)
+    protected webviewEnvironment: WebviewEnvironment;
+
+    initialize(): void {
+        this.checkHostPattern();
+    }
+
+    protected async checkHostPattern(): Promise<void> {
+        if (FrontendApplicationConfigProvider.get()['warnOnPotentiallyInsecureHostPattern'] === false) {
+            return;
+        }
+        const hostPattern = await this.webviewEnvironment.hostPatternPromise;
+        if (hostPattern !== WebviewExternalEndpoint.defaultPattern) {
+            const goToReadme = nls.localize('theia/webview/goToReadme', 'Go To README');
+            const message = nls.localize('theia/webview/messageWarning', '\
+            The {0} endpoint\'s host pattern has been changed to `{1}`; changing the pattern can lead to security vulnerabilities. \
+            See `{2}` for more information.', 'webview', hostPattern, '@theia/plugin-ext/README.md');
+            this.messageService.warn(message, Dialog.OK, goToReadme).then(action => {
+                if (action === goToReadme) {
+                    this.windowService.openNewWindow('https://www.npmjs.com/package/@theia/plugin-ext', { external: true });
+                }
+            });
+        }
+    }
+}

package/src/main/browser/webview/webview-preferences.ts

@@ -1,72 +1,72 @@
-// *****************************************************************************
-// Copyright (C) 2019 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 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { interfaces } from '@theia/core/shared/inversify';
-import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
-import {
-    createPreferenceProxy,
-    PreferenceProxy,
-    PreferenceService,
-    PreferenceContribution,
-    PreferenceSchema
-} from '@theia/core/lib/browser/preferences';
-import { nls } from '@theia/core/lib/common/nls';
-
-const frontendConfig = FrontendApplicationConfigProvider.get();
-
-export const WebviewConfigSchema: PreferenceSchema = {
-    type: 'object',
-    properties: {
-        'webview.trace': {
-            type: 'string',
-            enum: ['off', 'on', 'verbose'],
-            description: nls.localize('theia/plugin-ext/webviewTrace', 'Controls communication tracing with webviews.'),
-            default: 'off'
-        }
-    }
-};
-
-if (frontendConfig.securityWarnings) {
-    WebviewConfigSchema.properties['webview.warnIfUnsecure'] = {
-        scope: 'application',
-        type: 'boolean',
-        description: nls.localize('theia/plugin-ext/webviewWarnIfUnsecure', 'Warns users that webviews are currently deployed unsecurely.'),
-        default: true,
-    };
-}
-
-export interface WebviewConfiguration {
-    'webview.trace': 'off' | 'on' | 'verbose'
-    'webview.warnIfUnsecure'?: boolean
-}
-
-export const WebviewPreferenceContribution = Symbol('WebviewPreferenceContribution');
-export const WebviewPreferences = Symbol('WebviewPreferences');
-export type WebviewPreferences = PreferenceProxy<WebviewConfiguration>;
-
-export function createWebviewPreferences(preferences: PreferenceService, schema: PreferenceSchema = WebviewConfigSchema): WebviewPreferences {
-    return createPreferenceProxy(preferences, schema);
-}
-
-export function bindWebviewPreferences(bind: interfaces.Bind): void {
-    bind(WebviewPreferences).toDynamicValue(ctx => {
-        const preferences = ctx.container.get<PreferenceService>(PreferenceService);
-        const contribution = ctx.container.get<PreferenceContribution>(WebviewPreferenceContribution);
-        return createWebviewPreferences(preferences, contribution.schema);
-    }).inSingletonScope();
-    bind(WebviewPreferenceContribution).toConstantValue({ schema: WebviewConfigSchema });
-    bind(PreferenceContribution).toService(WebviewPreferenceContribution);
-}
+// *****************************************************************************
+// Copyright (C) 2019 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 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { interfaces } from '@theia/core/shared/inversify';
+import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
+import {
+    createPreferenceProxy,
+    PreferenceProxy,
+    PreferenceService,
+    PreferenceContribution,
+    PreferenceSchema
+} from '@theia/core/lib/browser/preferences';
+import { nls } from '@theia/core/lib/common/nls';
+
+const frontendConfig = FrontendApplicationConfigProvider.get();
+
+export const WebviewConfigSchema: PreferenceSchema = {
+    type: 'object',
+    properties: {
+        'webview.trace': {
+            type: 'string',
+            enum: ['off', 'on', 'verbose'],
+            description: nls.localize('theia/plugin-ext/webviewTrace', 'Controls communication tracing with webviews.'),
+            default: 'off'
+        }
+    }
+};
+
+if (frontendConfig.securityWarnings) {
+    WebviewConfigSchema.properties['webview.warnIfUnsecure'] = {
+        scope: 'application',
+        type: 'boolean',
+        description: nls.localize('theia/plugin-ext/webviewWarnIfUnsecure', 'Warns users that webviews are currently deployed unsecurely.'),
+        default: true,
+    };
+}
+
+export interface WebviewConfiguration {
+    'webview.trace': 'off' | 'on' | 'verbose'
+    'webview.warnIfUnsecure'?: boolean
+}
+
+export const WebviewPreferenceContribution = Symbol('WebviewPreferenceContribution');
+export const WebviewPreferences = Symbol('WebviewPreferences');
+export type WebviewPreferences = PreferenceProxy<WebviewConfiguration>;
+
+export function createWebviewPreferences(preferences: PreferenceService, schema: PreferenceSchema = WebviewConfigSchema): WebviewPreferences {
+    return createPreferenceProxy(preferences, schema);
+}
+
+export function bindWebviewPreferences(bind: interfaces.Bind): void {
+    bind(WebviewPreferences).toDynamicValue(ctx => {
+        const preferences = ctx.container.get<PreferenceService>(PreferenceService);
+        const contribution = ctx.container.get<PreferenceContribution>(WebviewPreferenceContribution);
+        return createWebviewPreferences(preferences, contribution.schema);
+    }).inSingletonScope();
+    bind(WebviewPreferenceContribution).toConstantValue({ schema: WebviewConfigSchema });
+    bind(PreferenceContribution).toService(WebviewPreferenceContribution);
+}

package/src/main/browser/webview/webview-resource-cache.ts

@@ -1,88 +1,88 @@
-// *****************************************************************************
-// Copyright (C) 2019 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 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { injectable } from '@theia/core/shared/inversify';
-import { Deferred } from '@theia/core/lib/common/promise-util';
-import { MaybePromise } from '@theia/core/lib/common/types';
-
-export interface WebviewResourceResponse {
-    eTag: string | undefined,
-    body(): MaybePromise<Uint8Array>
-}
-
-/**
- * Browser based cache of webview resources across all instances.
- */
-@injectable()
-export class WebviewResourceCache {
-
-    protected readonly cache = new Deferred<Cache | undefined>();
-
-    constructor() {
-        this.resolveCache();
-    }
-
-    protected async resolveCache(): Promise<void> {
-        try {
-            this.cache.resolve(await caches.open('webview:v1'));
-        } catch (e) {
-            console.error('Failed to enable webview caching: ', e);
-            this.cache.resolve(undefined);
-        }
-    }
-
-    async match(url: string): Promise<WebviewResourceResponse | undefined> {
-        const cache = await this.cache.promise;
-        if (!cache) {
-            return undefined;
-        }
-        const response = await cache.match(url);
-        if (!response) {
-            return undefined;
-        }
-        return {
-            eTag: response.headers.get('ETag') || undefined,
-            body: async () => {
-                const buffer = await response.arrayBuffer();
-                return new Uint8Array(buffer);
-            }
-        };
-    }
-
-    async delete(url: string): Promise<boolean> {
-        const cache = await this.cache.promise;
-        if (!cache) {
-            return false;
-        }
-        return cache.delete(url);
-    }
-
-    async put(url: string, response: WebviewResourceResponse): Promise<void> {
-        if (!response.eTag) {
-            return;
-        }
-        const cache = await this.cache.promise;
-        if (!cache) {
-            return;
-        }
-        const body = await response.body();
-        await cache.put(url, new Response(body, {
-            status: 200,
-            headers: { 'ETag': response.eTag }
-        }));
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2019 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 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable } from '@theia/core/shared/inversify';
+import { Deferred } from '@theia/core/lib/common/promise-util';
+import { MaybePromise } from '@theia/core/lib/common/types';
+
+export interface WebviewResourceResponse {
+    eTag: string | undefined,
+    body(): MaybePromise<Uint8Array>
+}
+
+/**
+ * Browser based cache of webview resources across all instances.
+ */
+@injectable()
+export class WebviewResourceCache {
+
+    protected readonly cache = new Deferred<Cache | undefined>();
+
+    constructor() {
+        this.resolveCache();
+    }
+
+    protected async resolveCache(): Promise<void> {
+        try {
+            this.cache.resolve(await caches.open('webview:v1'));
+        } catch (e) {
+            console.error('Failed to enable webview caching: ', e);
+            this.cache.resolve(undefined);
+        }
+    }
+
+    async match(url: string): Promise<WebviewResourceResponse | undefined> {
+        const cache = await this.cache.promise;
+        if (!cache) {
+            return undefined;
+        }
+        const response = await cache.match(url);
+        if (!response) {
+            return undefined;
+        }
+        return {
+            eTag: response.headers.get('ETag') || undefined,
+            body: async () => {
+                const buffer = await response.arrayBuffer();
+                return new Uint8Array(buffer);
+            }
+        };
+    }
+
+    async delete(url: string): Promise<boolean> {
+        const cache = await this.cache.promise;
+        if (!cache) {
+            return false;
+        }
+        return cache.delete(url);
+    }
+
+    async put(url: string, response: WebviewResourceResponse): Promise<void> {
+        if (!response.eTag) {
+            return;
+        }
+        const cache = await this.cache.promise;
+        if (!cache) {
+            return;
+        }
+        const body = await response.body();
+        await cache.put(url, new Response(body, {
+            status: 200,
+            headers: { 'ETag': response.eTag }
+        }));
+    }
+
+}