@theia/filesystem 1.53.0-next.55 → 1.53.0-next.64

package/src/browser/download/file-download-command-contribution.ts

@@ -1,83 +1,83 @@
-// *****************************************************************************
-// Copyright (C) 2018 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 { inject, injectable } from '@theia/core/shared/inversify';
-import URI from '@theia/core/lib/common/uri';
-import { isChrome } from '@theia/core/lib/browser/browser';
-import { environment } from '@theia/core/shared/@theia/application-package/lib/environment';
-import { SelectionService } from '@theia/core/lib/common/selection-service';
-import { Command, CommandContribution, CommandRegistry } from '@theia/core/lib/common/command';
-import { UriAwareCommandHandler } from '@theia/core/lib/common/uri-command-handler';
-import { FileDownloadService } from './file-download-service';
-import { CommonCommands } from '@theia/core/lib/browser';
-
-@injectable()
-export class FileDownloadCommandContribution implements CommandContribution {
-
-    @inject(FileDownloadService)
-    protected readonly downloadService: FileDownloadService;
-
-    @inject(SelectionService)
-    protected readonly selectionService: SelectionService;
-
-    registerCommands(registry: CommandRegistry): void {
-        registry.registerCommand(
-            FileDownloadCommands.DOWNLOAD,
-            UriAwareCommandHandler.MultiSelect(this.selectionService, {
-                execute: uris => this.executeDownload(uris),
-                isEnabled: uris => this.isDownloadEnabled(uris),
-                isVisible: uris => this.isDownloadVisible(uris),
-            })
-        );
-        registry.registerCommand(
-            FileDownloadCommands.COPY_DOWNLOAD_LINK,
-            UriAwareCommandHandler.MultiSelect(this.selectionService, {
-                execute: uris => this.executeDownload(uris, { copyLink: true }),
-                isEnabled: uris => isChrome && this.isDownloadEnabled(uris),
-                isVisible: uris => isChrome && this.isDownloadVisible(uris),
-            })
-        );
-    }
-
-    protected async executeDownload(uris: URI[], options?: { copyLink?: boolean }): Promise<void> {
-        this.downloadService.download(uris, options);
-    }
-
-    protected isDownloadEnabled(uris: URI[]): boolean {
-        return !environment.electron.is() && uris.length > 0 && uris.every(u => u.scheme === 'file');
-    }
-
-    protected isDownloadVisible(uris: URI[]): boolean {
-        return this.isDownloadEnabled(uris);
-    }
-
-}
-
-export namespace FileDownloadCommands {
-
-    export const DOWNLOAD = Command.toDefaultLocalizedCommand({
-        id: 'file.download',
-        category: CommonCommands.FILE_CATEGORY,
-        label: 'Download'
-    });
-
-    export const COPY_DOWNLOAD_LINK = Command.toLocalizedCommand({
-        id: 'file.copyDownloadLink',
-        category: CommonCommands.FILE_CATEGORY,
-        label: 'Copy Download Link'
-    }, 'theia/filesystem/copyDownloadLink', CommonCommands.FILE_CATEGORY_KEY);
-
-}
+// *****************************************************************************
+// Copyright (C) 2018 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 { inject, injectable } from '@theia/core/shared/inversify';
+import URI from '@theia/core/lib/common/uri';
+import { isChrome } from '@theia/core/lib/browser/browser';
+import { environment } from '@theia/core/shared/@theia/application-package/lib/environment';
+import { SelectionService } from '@theia/core/lib/common/selection-service';
+import { Command, CommandContribution, CommandRegistry } from '@theia/core/lib/common/command';
+import { UriAwareCommandHandler } from '@theia/core/lib/common/uri-command-handler';
+import { FileDownloadService } from './file-download-service';
+import { CommonCommands } from '@theia/core/lib/browser';
+
+@injectable()
+export class FileDownloadCommandContribution implements CommandContribution {
+
+    @inject(FileDownloadService)
+    protected readonly downloadService: FileDownloadService;
+
+    @inject(SelectionService)
+    protected readonly selectionService: SelectionService;
+
+    registerCommands(registry: CommandRegistry): void {
+        registry.registerCommand(
+            FileDownloadCommands.DOWNLOAD,
+            UriAwareCommandHandler.MultiSelect(this.selectionService, {
+                execute: uris => this.executeDownload(uris),
+                isEnabled: uris => this.isDownloadEnabled(uris),
+                isVisible: uris => this.isDownloadVisible(uris),
+            })
+        );
+        registry.registerCommand(
+            FileDownloadCommands.COPY_DOWNLOAD_LINK,
+            UriAwareCommandHandler.MultiSelect(this.selectionService, {
+                execute: uris => this.executeDownload(uris, { copyLink: true }),
+                isEnabled: uris => isChrome && this.isDownloadEnabled(uris),
+                isVisible: uris => isChrome && this.isDownloadVisible(uris),
+            })
+        );
+    }
+
+    protected async executeDownload(uris: URI[], options?: { copyLink?: boolean }): Promise<void> {
+        this.downloadService.download(uris, options);
+    }
+
+    protected isDownloadEnabled(uris: URI[]): boolean {
+        return !environment.electron.is() && uris.length > 0 && uris.every(u => u.scheme === 'file');
+    }
+
+    protected isDownloadVisible(uris: URI[]): boolean {
+        return this.isDownloadEnabled(uris);
+    }
+
+}
+
+export namespace FileDownloadCommands {
+
+    export const DOWNLOAD = Command.toDefaultLocalizedCommand({
+        id: 'file.download',
+        category: CommonCommands.FILE_CATEGORY,
+        label: 'Download'
+    });
+
+    export const COPY_DOWNLOAD_LINK = Command.toLocalizedCommand({
+        id: 'file.copyDownloadLink',
+        category: CommonCommands.FILE_CATEGORY,
+        label: 'Copy Download Link'
+    }, 'theia/filesystem/copyDownloadLink', CommonCommands.FILE_CATEGORY_KEY);
+
+}

package/src/browser/download/file-download-frontend-module.ts

@@ -1,25 +1,25 @@
-// *****************************************************************************
-// Copyright (C) 2018 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 { ContainerModule } from '@theia/core/shared/inversify';
-import { CommandContribution } from '@theia/core/lib/common/command';
-import { FileDownloadService } from './file-download-service';
-import { FileDownloadCommandContribution } from './file-download-command-contribution';
-
-export default new ContainerModule(bind => {
-    bind(FileDownloadService).toSelf().inSingletonScope();
-    bind(CommandContribution).to(FileDownloadCommandContribution).inSingletonScope();
-});
+// *****************************************************************************
+// Copyright (C) 2018 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 { ContainerModule } from '@theia/core/shared/inversify';
+import { CommandContribution } from '@theia/core/lib/common/command';
+import { FileDownloadService } from './file-download-service';
+import { FileDownloadCommandContribution } from './file-download-command-contribution';
+
+export default new ContainerModule(bind => {
+    bind(FileDownloadService).toSelf().inSingletonScope();
+    bind(CommandContribution).to(FileDownloadCommandContribution).inSingletonScope();
+});

package/src/browser/download/file-download-service.ts

@@ -1,179 +1,179 @@
-// *****************************************************************************
-// Copyright (C) 2018 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 { inject, injectable } from '@theia/core/shared/inversify';
-import URI from '@theia/core/lib/common/uri';
-import { ILogger } from '@theia/core/lib/common/logger';
-import { Endpoint } from '@theia/core/lib/browser/endpoint';
-import { FileDownloadData } from '../../common/download/file-download-data';
-import { MessageService } from '@theia/core/lib/common/message-service';
-import { addClipboardListener } from '@theia/core/lib/browser/widgets';
-import { nls } from '@theia/core';
-
-@injectable()
-export class FileDownloadService {
-
-    protected anchor: HTMLAnchorElement | undefined;
-    protected downloadCounter: number = 0;
-
-    @inject(ILogger)
-    protected readonly logger: ILogger;
-
-    @inject(MessageService)
-    protected readonly messageService: MessageService;
-
-    protected handleCopy(event: ClipboardEvent, downloadUrl: string): void {
-        if (downloadUrl && event.clipboardData) {
-            event.clipboardData.setData('text/plain', downloadUrl);
-            event.preventDefault();
-            this.messageService.info(nls.localize('theia/filesystem/copiedToClipboard', 'Copied the download link to the clipboard.'));
-        }
-    }
-
-    async cancelDownload(id: string): Promise<void> {
-        await fetch(`${this.endpoint()}/download/?id=${id}&cancel=true`);
-    }
-
-    async download(uris: URI[], options?: FileDownloadService.DownloadOptions): Promise<void> {
-        let cancel = false;
-        if (uris.length === 0) {
-            return;
-        }
-        const copyLink = options && options.copyLink ? true : false;
-        try {
-            const text: string = copyLink ?
-                nls.localize('theia/filesystem/prepareDownloadLink', 'Preparing download link...') :
-                nls.localize('theia/filesystem/prepareDownload', 'Preparing download...');
-            const [progress, result] = await Promise.all([
-                this.messageService.showProgress({
-                    text: text,
-                    options: { cancelable: true }
-                }, () => { cancel = true; }),
-                // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                new Promise<{ response: Response, jsonResponse: any }>(async resolve => {
-                    const resp = await fetch(this.request(uris));
-                    const jsonResp = await resp.json();
-                    resolve({ response: resp, jsonResponse: jsonResp });
-                })
-            ]);
-            const { response, jsonResponse } = result;
-            if (cancel) {
-                this.cancelDownload(jsonResponse.id);
-                return;
-            }
-            const { status, statusText } = response;
-            if (status === 200) {
-                progress.cancel();
-                const downloadUrl = `${this.endpoint()}/download/?id=${jsonResponse.id}`;
-                if (copyLink) {
-                    if (document.documentElement) {
-                        const toDispose = addClipboardListener(document.documentElement, 'copy', e => {
-                            toDispose.dispose();
-                            this.handleCopy(e, downloadUrl);
-                        });
-                        document.execCommand('copy');
-                    }
-                } else {
-                    this.forceDownload(jsonResponse.id, decodeURIComponent(jsonResponse.name));
-                }
-            } else {
-                throw new Error(`Received unexpected status code: ${status}. [${statusText}]`);
-            }
-        } catch (e) {
-            this.logger.error(`Error occurred when downloading: ${uris.map(u => u.toString(true))}.`, e);
-        }
-    }
-
-    protected async forceDownload(id: string, title: string): Promise<void> {
-        let url: string | undefined;
-        try {
-            if (this.anchor === undefined) {
-                this.anchor = document.createElement('a');
-            }
-            const endpoint = this.endpoint();
-            url = `${endpoint}/download/?id=${id}`;
-            this.anchor.href = url;
-            this.anchor.style.display = 'none';
-            this.anchor.download = title;
-            document.body.appendChild(this.anchor);
-            this.anchor.click();
-        } finally {
-            // make sure anchor is removed from parent
-            if (this.anchor && this.anchor.parentNode) {
-                this.anchor.parentNode.removeChild(this.anchor);
-            }
-            if (url) {
-                URL.revokeObjectURL(url);
-            }
-        }
-    }
-
-    protected request(uris: URI[]): Request {
-        const url = this.url(uris);
-        const init = this.requestInit(uris);
-        return new Request(url, init);
-    }
-
-    protected requestInit(uris: URI[]): RequestInit {
-        if (uris.length === 1) {
-            return {
-                body: undefined,
-                method: 'GET'
-            };
-        }
-        return {
-            method: 'PUT',
-            body: JSON.stringify(this.body(uris)),
-            headers: new Headers({ 'Content-Type': 'application/json' }),
-        };
-    }
-
-    protected body(uris: URI[]): FileDownloadData {
-        return {
-            uris: uris.map(u => u.toString(true))
-        };
-    }
-
-    protected url(uris: URI[]): string {
-        const endpoint = this.endpoint();
-        if (uris.length === 1) {
-            // tslint:disable-next-line:whitespace
-            const [uri,] = uris;
-            return `${endpoint}/?uri=${uri.toString()}`;
-        }
-        return endpoint;
-
-    }
-
-    protected endpoint(): string {
-        const url = this.filesUrl();
-        return url.endsWith('/') ? url.slice(0, -1) : url;
-    }
-
-    protected filesUrl(): string {
-        return new Endpoint({ path: 'files' }).getRestUrl().toString();
-    }
-
-}
-
-export namespace FileDownloadService {
-    export interface DownloadOptions {
-        /**
-         * `true` if the download link has to be copied to the clipboard. This will not trigger the actual download. Defaults to `false`.
-         */
-        readonly copyLink?: boolean;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 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 { inject, injectable } from '@theia/core/shared/inversify';
+import URI from '@theia/core/lib/common/uri';
+import { ILogger } from '@theia/core/lib/common/logger';
+import { Endpoint } from '@theia/core/lib/browser/endpoint';
+import { FileDownloadData } from '../../common/download/file-download-data';
+import { MessageService } from '@theia/core/lib/common/message-service';
+import { addClipboardListener } from '@theia/core/lib/browser/widgets';
+import { nls } from '@theia/core';
+
+@injectable()
+export class FileDownloadService {
+
+    protected anchor: HTMLAnchorElement | undefined;
+    protected downloadCounter: number = 0;
+
+    @inject(ILogger)
+    protected readonly logger: ILogger;
+
+    @inject(MessageService)
+    protected readonly messageService: MessageService;
+
+    protected handleCopy(event: ClipboardEvent, downloadUrl: string): void {
+        if (downloadUrl && event.clipboardData) {
+            event.clipboardData.setData('text/plain', downloadUrl);
+            event.preventDefault();
+            this.messageService.info(nls.localize('theia/filesystem/copiedToClipboard', 'Copied the download link to the clipboard.'));
+        }
+    }
+
+    async cancelDownload(id: string): Promise<void> {
+        await fetch(`${this.endpoint()}/download/?id=${id}&cancel=true`);
+    }
+
+    async download(uris: URI[], options?: FileDownloadService.DownloadOptions): Promise<void> {
+        let cancel = false;
+        if (uris.length === 0) {
+            return;
+        }
+        const copyLink = options && options.copyLink ? true : false;
+        try {
+            const text: string = copyLink ?
+                nls.localize('theia/filesystem/prepareDownloadLink', 'Preparing download link...') :
+                nls.localize('theia/filesystem/prepareDownload', 'Preparing download...');
+            const [progress, result] = await Promise.all([
+                this.messageService.showProgress({
+                    text: text,
+                    options: { cancelable: true }
+                }, () => { cancel = true; }),
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                new Promise<{ response: Response, jsonResponse: any }>(async resolve => {
+                    const resp = await fetch(this.request(uris));
+                    const jsonResp = await resp.json();
+                    resolve({ response: resp, jsonResponse: jsonResp });
+                })
+            ]);
+            const { response, jsonResponse } = result;
+            if (cancel) {
+                this.cancelDownload(jsonResponse.id);
+                return;
+            }
+            const { status, statusText } = response;
+            if (status === 200) {
+                progress.cancel();
+                const downloadUrl = `${this.endpoint()}/download/?id=${jsonResponse.id}`;
+                if (copyLink) {
+                    if (document.documentElement) {
+                        const toDispose = addClipboardListener(document.documentElement, 'copy', e => {
+                            toDispose.dispose();
+                            this.handleCopy(e, downloadUrl);
+                        });
+                        document.execCommand('copy');
+                    }
+                } else {
+                    this.forceDownload(jsonResponse.id, decodeURIComponent(jsonResponse.name));
+                }
+            } else {
+                throw new Error(`Received unexpected status code: ${status}. [${statusText}]`);
+            }
+        } catch (e) {
+            this.logger.error(`Error occurred when downloading: ${uris.map(u => u.toString(true))}.`, e);
+        }
+    }
+
+    protected async forceDownload(id: string, title: string): Promise<void> {
+        let url: string | undefined;
+        try {
+            if (this.anchor === undefined) {
+                this.anchor = document.createElement('a');
+            }
+            const endpoint = this.endpoint();
+            url = `${endpoint}/download/?id=${id}`;
+            this.anchor.href = url;
+            this.anchor.style.display = 'none';
+            this.anchor.download = title;
+            document.body.appendChild(this.anchor);
+            this.anchor.click();
+        } finally {
+            // make sure anchor is removed from parent
+            if (this.anchor && this.anchor.parentNode) {
+                this.anchor.parentNode.removeChild(this.anchor);
+            }
+            if (url) {
+                URL.revokeObjectURL(url);
+            }
+        }
+    }
+
+    protected request(uris: URI[]): Request {
+        const url = this.url(uris);
+        const init = this.requestInit(uris);
+        return new Request(url, init);
+    }
+
+    protected requestInit(uris: URI[]): RequestInit {
+        if (uris.length === 1) {
+            return {
+                body: undefined,
+                method: 'GET'
+            };
+        }
+        return {
+            method: 'PUT',
+            body: JSON.stringify(this.body(uris)),
+            headers: new Headers({ 'Content-Type': 'application/json' }),
+        };
+    }
+
+    protected body(uris: URI[]): FileDownloadData {
+        return {
+            uris: uris.map(u => u.toString(true))
+        };
+    }
+
+    protected url(uris: URI[]): string {
+        const endpoint = this.endpoint();
+        if (uris.length === 1) {
+            // tslint:disable-next-line:whitespace
+            const [uri,] = uris;
+            return `${endpoint}/?uri=${uri.toString()}`;
+        }
+        return endpoint;
+
+    }
+
+    protected endpoint(): string {
+        const url = this.filesUrl();
+        return url.endsWith('/') ? url.slice(0, -1) : url;
+    }
+
+    protected filesUrl(): string {
+        return new Endpoint({ path: 'files' }).getRestUrl().toString();
+    }
+
+}
+
+export namespace FileDownloadService {
+    export interface DownloadOptions {
+        /**
+         * `true` if the download link has to be copied to the clipboard. This will not trigger the actual download. Defaults to `false`.
+         */
+        readonly copyLink?: boolean;
+    }
+}