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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/README.md +30 -30
  2. package/package.json +3 -3
  3. package/src/browser/breadcrumbs/filepath-breadcrumb.ts +43 -43
  4. package/src/browser/breadcrumbs/filepath-breadcrumbs-container.ts +65 -65
  5. package/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts +129 -129
  6. package/src/browser/download/file-download-command-contribution.ts +83 -83
  7. package/src/browser/download/file-download-frontend-module.ts +25 -25
  8. package/src/browser/download/file-download-service.ts +179 -179
  9. package/src/browser/file-dialog/file-dialog-container.ts +67 -67
  10. package/src/browser/file-dialog/file-dialog-hidden-files-renderer.tsx +59 -59
  11. package/src/browser/file-dialog/file-dialog-model.ts +96 -96
  12. package/src/browser/file-dialog/file-dialog-module.ts +44 -44
  13. package/src/browser/file-dialog/file-dialog-service.ts +99 -99
  14. package/src/browser/file-dialog/file-dialog-tree-filters-renderer.tsx +100 -100
  15. package/src/browser/file-dialog/file-dialog-tree.ts +89 -89
  16. package/src/browser/file-dialog/file-dialog-widget.ts +75 -75
  17. package/src/browser/file-dialog/file-dialog.ts +434 -434
  18. package/src/browser/file-dialog/index.ts +20 -20
  19. package/src/browser/file-resource.spec.ts +255 -255
  20. package/src/browser/file-resource.ts +402 -402
  21. package/src/browser/file-selection.ts +44 -44
  22. package/src/browser/file-service.ts +1845 -1845
  23. package/src/browser/file-tree/file-tree-container.ts +36 -36
  24. package/src/browser/file-tree/file-tree-decorator-adapter.ts +159 -159
  25. package/src/browser/file-tree/file-tree-label-provider.ts +53 -53
  26. package/src/browser/file-tree/file-tree-model.ts +212 -212
  27. package/src/browser/file-tree/file-tree-widget.tsx +327 -327
  28. package/src/browser/file-tree/file-tree.ts +183 -183
  29. package/src/browser/file-tree/index.ts +22 -22
  30. package/src/browser/file-upload-service.ts +547 -547
  31. package/src/browser/filesystem-frontend-contribution.ts +396 -396
  32. package/src/browser/filesystem-frontend-module.ts +77 -77
  33. package/src/browser/filesystem-preferences.ts +139 -139
  34. package/src/browser/filesystem-saveable-service.ts +138 -138
  35. package/src/browser/filesystem-watcher-error-handler.ts +60 -60
  36. package/src/browser/index.ts +21 -21
  37. package/src/browser/location/index.ts +18 -18
  38. package/src/browser/location/location-renderer.tsx +406 -406
  39. package/src/browser/location/location-service.ts +22 -22
  40. package/src/browser/remote-file-service-contribution.ts +38 -38
  41. package/src/browser/style/file-dialog.css +208 -208
  42. package/src/browser/style/file-icons.css +64 -64
  43. package/src/browser/style/filepath-breadcrumbs.css +20 -20
  44. package/src/browser/style/index.css +36 -36
  45. package/src/browser-only/browser-only-filesystem-frontend-module.ts +38 -38
  46. package/src/browser-only/browser-only-filesystem-provider-server.ts +32 -32
  47. package/src/browser-only/browserfs-filesystem-initialization.ts +61 -61
  48. package/src/browser-only/browserfs-filesystem-provider.ts +462 -462
  49. package/src/common/delegating-file-system-provider.ts +226 -226
  50. package/src/common/download/README.md +30 -30
  51. package/src/common/download/file-download-data.ts +27 -27
  52. package/src/common/file-upload.ts +17 -17
  53. package/src/common/files.spec.ts +51 -51
  54. package/src/common/files.ts +997 -997
  55. package/src/common/filesystem-utils.spec.ts +411 -411
  56. package/src/common/filesystem-utils.ts +64 -64
  57. package/src/common/filesystem-watcher-protocol.ts +96 -96
  58. package/src/common/filesystem.ts +43 -43
  59. package/src/common/index.ts +18 -18
  60. package/src/common/io.ts +150 -150
  61. package/src/common/remote-file-system-provider.ts +549 -549
  62. package/src/electron-browser/file-dialog/electron-file-dialog-module.ts +24 -24
  63. package/src/electron-browser/file-dialog/electron-file-dialog-service.ts +165 -165
  64. package/src/electron-browser/preload.ts +31 -31
  65. package/src/electron-common/electron-api.ts +55 -55
  66. package/src/electron-main/electron-api-main.ts +78 -78
  67. package/src/electron-main/electron-main-module.ts +23 -23
  68. package/src/node/disk-file-system-provider.spec.ts +142 -142
  69. package/src/node/disk-file-system-provider.ts +915 -915
  70. package/src/node/download/directory-archiver.spec.ts +104 -104
  71. package/src/node/download/directory-archiver.ts +126 -126
  72. package/src/node/download/file-download-backend-module.ts +32 -32
  73. package/src/node/download/file-download-cache.ts +88 -88
  74. package/src/node/download/file-download-endpoint.ts +63 -63
  75. package/src/node/download/file-download-handler.ts +304 -304
  76. package/src/node/download/test/mock-directory-archiver.ts +30 -30
  77. package/src/node/file-change-collection.spec.ts +110 -110
  78. package/src/node/file-change-collection.ts +78 -78
  79. package/src/node/filesystem-backend-module.ts +140 -140
  80. package/src/node/filesystem-watcher-client.ts +72 -72
  81. package/src/node/filesystem-watcher-dispatcher.ts +82 -82
  82. package/src/node/node-file-upload-service.ts +80 -80
  83. package/src/node/nsfw-watcher/index.ts +45 -45
  84. package/src/node/nsfw-watcher/nsfw-filesystem-service.ts +481 -481
  85. package/src/node/nsfw-watcher/nsfw-filesystem-watcher.spec.ts +182 -182
  86. package/src/node/nsfw-watcher/nsfw-options.ts +23 -23
  87. package/src/typings/dom.webkit.d.ts +77 -77
  88. package/src/typings/mv/index.d.ts +21 -21
  89. package/src/typings/nsfw/index.d.ts +18 -18
  90. package/src/typings/trash/index.d.ts +20 -20
@@ -1,226 +1,226 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2020 TypeFox and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import URI from '@theia/core/lib/common/uri';
18
- import { Event, Emitter, CancellationToken } from '@theia/core/lib/common';
19
- import { Disposable, DisposableCollection } from '@theia/core/lib/common/disposable';
20
- import {
21
- FileSystemProvider, FileSystemProviderCapabilities, WatchOptions, FileDeleteOptions, FileOverwriteOptions, FileWriteOptions, FileOpenOptions, FileChange, Stat, FileType,
22
- hasReadWriteCapability, hasFileFolderCopyCapability, hasOpenReadWriteCloseCapability, hasAccessCapability, FileUpdateOptions, hasUpdateCapability, FileUpdateResult,
23
- FileReadStreamOptions,
24
- hasFileReadStreamCapability
25
- } from './files';
26
- import type { TextDocumentContentChangeEvent } from '@theia/core/shared/vscode-languageserver-protocol';
27
- import { ReadableStreamEvents } from '@theia/core/lib/common/stream';
28
-
29
- export class DelegatingFileSystemProvider implements Required<FileSystemProvider>, Disposable {
30
-
31
- private readonly onDidChangeFileEmitter = new Emitter<readonly FileChange[]>();
32
- readonly onDidChangeFile = this.onDidChangeFileEmitter.event;
33
-
34
- private readonly onFileWatchErrorEmitter = new Emitter<void>();
35
- readonly onFileWatchError = this.onFileWatchErrorEmitter.event;
36
-
37
- constructor(
38
- protected readonly delegate: FileSystemProvider,
39
- protected readonly options: DelegatingFileSystemProvider.Options,
40
- protected readonly toDispose = new DisposableCollection()
41
- ) {
42
- this.toDispose.push(this.onDidChangeFileEmitter);
43
- this.toDispose.push(delegate.onDidChangeFile(changes => this.handleFileChanges(changes)));
44
- this.toDispose.push(this.onFileWatchErrorEmitter);
45
- this.toDispose.push(delegate.onFileWatchError(changes => this.onFileWatchErrorEmitter.fire()));
46
- }
47
-
48
- dispose(): void {
49
- this.toDispose.dispose();
50
- }
51
-
52
- get capabilities(): FileSystemProviderCapabilities {
53
- return this.delegate.capabilities;
54
- }
55
-
56
- get onDidChangeCapabilities(): Event<void> {
57
- return this.delegate.onDidChangeCapabilities;
58
- }
59
-
60
- watch(resource: URI, opts: WatchOptions): Disposable {
61
- return this.delegate.watch(this.toUnderlyingResource(resource), opts);
62
- }
63
-
64
- stat(resource: URI): Promise<Stat> {
65
- return this.delegate.stat(this.toUnderlyingResource(resource));
66
- }
67
-
68
- access(resource: URI, mode?: number): Promise<void> {
69
- if (hasAccessCapability(this.delegate)) {
70
- return this.delegate.access(this.toUnderlyingResource(resource), mode);
71
- }
72
- throw new Error('not supported');
73
- }
74
-
75
- fsPath(resource: URI): Promise<string> {
76
- if (hasAccessCapability(this.delegate)) {
77
- return this.delegate.fsPath(this.toUnderlyingResource(resource));
78
- }
79
- throw new Error('not supported');
80
- }
81
-
82
- mkdir(resource: URI): Promise<void> {
83
- return this.delegate.mkdir(this.toUnderlyingResource(resource));
84
- }
85
-
86
- rename(from: URI, to: URI, opts: FileOverwriteOptions): Promise<void> {
87
- return this.delegate.rename(this.toUnderlyingResource(from), this.toUnderlyingResource(to), opts);
88
- }
89
-
90
- copy(from: URI, to: URI, opts: FileOverwriteOptions): Promise<void> {
91
- if (hasFileFolderCopyCapability(this.delegate)) {
92
- return this.delegate.copy(this.toUnderlyingResource(from), this.toUnderlyingResource(to), opts);
93
- }
94
- throw new Error('not supported');
95
- }
96
-
97
- readFile(resource: URI): Promise<Uint8Array> {
98
- if (hasReadWriteCapability(this.delegate)) {
99
- return this.delegate.readFile(this.toUnderlyingResource(resource));
100
- }
101
- throw new Error('not supported');
102
- }
103
-
104
- readFileStream(resource: URI, opts: FileReadStreamOptions, token: CancellationToken): ReadableStreamEvents<Uint8Array> {
105
- if (hasFileReadStreamCapability(this.delegate)) {
106
- return this.delegate.readFileStream(this.toUnderlyingResource(resource), opts, token);
107
- }
108
- throw new Error('not supported');
109
- }
110
-
111
- readdir(resource: URI): Promise<[string, FileType][]> {
112
- return this.delegate.readdir(this.toUnderlyingResource(resource));
113
- }
114
-
115
- writeFile(resource: URI, content: Uint8Array, opts: FileWriteOptions): Promise<void> {
116
- if (hasReadWriteCapability(this.delegate)) {
117
- return this.delegate.writeFile(this.toUnderlyingResource(resource), content, opts);
118
- }
119
- throw new Error('not supported');
120
- }
121
-
122
- open(resource: URI, opts: FileOpenOptions): Promise<number> {
123
- if (hasOpenReadWriteCloseCapability(this.delegate)) {
124
- return this.delegate.open(this.toUnderlyingResource(resource), opts);
125
- }
126
- throw new Error('not supported');
127
- }
128
-
129
- close(fd: number): Promise<void> {
130
- if (hasOpenReadWriteCloseCapability(this.delegate)) {
131
- return this.delegate.close(fd);
132
- }
133
- throw new Error('not supported');
134
- }
135
-
136
- read(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number> {
137
- if (hasOpenReadWriteCloseCapability(this.delegate)) {
138
- return this.delegate.read(fd, pos, data, offset, length);
139
- }
140
- throw new Error('not supported');
141
- }
142
-
143
- write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number> {
144
- if (hasOpenReadWriteCloseCapability(this.delegate)) {
145
- return this.delegate.write(fd, pos, data, offset, length);
146
- }
147
- throw new Error('not supported');
148
- }
149
-
150
- delete(resource: URI, opts: FileDeleteOptions): Promise<void> {
151
- return this.delegate.delete(this.toUnderlyingResource(resource), opts);
152
- }
153
-
154
- updateFile(resource: URI, changes: TextDocumentContentChangeEvent[], opts: FileUpdateOptions): Promise<FileUpdateResult> {
155
- if (hasUpdateCapability(this.delegate)) {
156
- return this.delegate.updateFile(resource, changes, opts);
157
- }
158
- throw new Error('not supported');
159
- }
160
-
161
- protected handleFileChanges(changes: readonly FileChange[]): void {
162
- const delegatingChanges: FileChange[] = [];
163
- for (const change of changes) {
164
- const delegatingResource = this.fromUnderlyingResource(change.resource);
165
- if (delegatingResource) {
166
- delegatingChanges.push({
167
- resource: delegatingResource,
168
- type: change.type
169
- });
170
- }
171
- }
172
- if (delegatingChanges.length) {
173
- this.onDidChangeFileEmitter.fire(delegatingChanges);
174
- }
175
- }
176
-
177
- /**
178
- * Converts to an underlying fs provider resource format.
179
- *
180
- * For example converting `user-storage` resources to `file` resources under a user home:
181
- * user-storage:/user/settings.json => file://home/.theia/settings.json
182
- */
183
- toUnderlyingResource(resource: URI): URI {
184
- const underlying = this.options.uriConverter.to(resource);
185
- if (!underlying) {
186
- throw new Error('invalid resource: ' + resource.toString());
187
- }
188
- return underlying;
189
- }
190
-
191
- /**
192
- * Converts from an underlying fs provider resource format.
193
- *
194
- * For example converting `file` resources under a user home to `user-storage` resource:
195
- * - file://home/.theia/settings.json => user-storage:/user/settings.json
196
- * - file://documents/some-document.txt => undefined
197
- */
198
- fromUnderlyingResource(resource: URI): URI | undefined {
199
- return this.options.uriConverter.from(resource);
200
- }
201
-
202
- }
203
- export namespace DelegatingFileSystemProvider {
204
- export interface Options {
205
- uriConverter: URIConverter
206
- }
207
- export interface URIConverter {
208
- /**
209
- * Converts to an underlying fs provider resource format.
210
- * Returns undefined if the given resource is not valid resource.
211
- *
212
- * For example converting `user-storage` resources to `file` resources under a user home:
213
- * user-storage:/user/settings.json => file://home/.theia/settings.json
214
- * user-storage:/settings.json => undefined
215
- */
216
- to(resource: URI): URI | undefined;
217
- /**
218
- * Converts from an underlying fs provider resource format.
219
- *
220
- * For example converting `file` resources under a user home to `user-storage` resource:
221
- * - file://home/.theia/settings.json => user-storage:/settings.json
222
- * - file://documents/some-document.txt => undefined
223
- */
224
- from(resource: URI): URI | undefined;
225
- }
226
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2020 TypeFox and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import URI from '@theia/core/lib/common/uri';
18
+ import { Event, Emitter, CancellationToken } from '@theia/core/lib/common';
19
+ import { Disposable, DisposableCollection } from '@theia/core/lib/common/disposable';
20
+ import {
21
+ FileSystemProvider, FileSystemProviderCapabilities, WatchOptions, FileDeleteOptions, FileOverwriteOptions, FileWriteOptions, FileOpenOptions, FileChange, Stat, FileType,
22
+ hasReadWriteCapability, hasFileFolderCopyCapability, hasOpenReadWriteCloseCapability, hasAccessCapability, FileUpdateOptions, hasUpdateCapability, FileUpdateResult,
23
+ FileReadStreamOptions,
24
+ hasFileReadStreamCapability
25
+ } from './files';
26
+ import type { TextDocumentContentChangeEvent } from '@theia/core/shared/vscode-languageserver-protocol';
27
+ import { ReadableStreamEvents } from '@theia/core/lib/common/stream';
28
+
29
+ export class DelegatingFileSystemProvider implements Required<FileSystemProvider>, Disposable {
30
+
31
+ private readonly onDidChangeFileEmitter = new Emitter<readonly FileChange[]>();
32
+ readonly onDidChangeFile = this.onDidChangeFileEmitter.event;
33
+
34
+ private readonly onFileWatchErrorEmitter = new Emitter<void>();
35
+ readonly onFileWatchError = this.onFileWatchErrorEmitter.event;
36
+
37
+ constructor(
38
+ protected readonly delegate: FileSystemProvider,
39
+ protected readonly options: DelegatingFileSystemProvider.Options,
40
+ protected readonly toDispose = new DisposableCollection()
41
+ ) {
42
+ this.toDispose.push(this.onDidChangeFileEmitter);
43
+ this.toDispose.push(delegate.onDidChangeFile(changes => this.handleFileChanges(changes)));
44
+ this.toDispose.push(this.onFileWatchErrorEmitter);
45
+ this.toDispose.push(delegate.onFileWatchError(changes => this.onFileWatchErrorEmitter.fire()));
46
+ }
47
+
48
+ dispose(): void {
49
+ this.toDispose.dispose();
50
+ }
51
+
52
+ get capabilities(): FileSystemProviderCapabilities {
53
+ return this.delegate.capabilities;
54
+ }
55
+
56
+ get onDidChangeCapabilities(): Event<void> {
57
+ return this.delegate.onDidChangeCapabilities;
58
+ }
59
+
60
+ watch(resource: URI, opts: WatchOptions): Disposable {
61
+ return this.delegate.watch(this.toUnderlyingResource(resource), opts);
62
+ }
63
+
64
+ stat(resource: URI): Promise<Stat> {
65
+ return this.delegate.stat(this.toUnderlyingResource(resource));
66
+ }
67
+
68
+ access(resource: URI, mode?: number): Promise<void> {
69
+ if (hasAccessCapability(this.delegate)) {
70
+ return this.delegate.access(this.toUnderlyingResource(resource), mode);
71
+ }
72
+ throw new Error('not supported');
73
+ }
74
+
75
+ fsPath(resource: URI): Promise<string> {
76
+ if (hasAccessCapability(this.delegate)) {
77
+ return this.delegate.fsPath(this.toUnderlyingResource(resource));
78
+ }
79
+ throw new Error('not supported');
80
+ }
81
+
82
+ mkdir(resource: URI): Promise<void> {
83
+ return this.delegate.mkdir(this.toUnderlyingResource(resource));
84
+ }
85
+
86
+ rename(from: URI, to: URI, opts: FileOverwriteOptions): Promise<void> {
87
+ return this.delegate.rename(this.toUnderlyingResource(from), this.toUnderlyingResource(to), opts);
88
+ }
89
+
90
+ copy(from: URI, to: URI, opts: FileOverwriteOptions): Promise<void> {
91
+ if (hasFileFolderCopyCapability(this.delegate)) {
92
+ return this.delegate.copy(this.toUnderlyingResource(from), this.toUnderlyingResource(to), opts);
93
+ }
94
+ throw new Error('not supported');
95
+ }
96
+
97
+ readFile(resource: URI): Promise<Uint8Array> {
98
+ if (hasReadWriteCapability(this.delegate)) {
99
+ return this.delegate.readFile(this.toUnderlyingResource(resource));
100
+ }
101
+ throw new Error('not supported');
102
+ }
103
+
104
+ readFileStream(resource: URI, opts: FileReadStreamOptions, token: CancellationToken): ReadableStreamEvents<Uint8Array> {
105
+ if (hasFileReadStreamCapability(this.delegate)) {
106
+ return this.delegate.readFileStream(this.toUnderlyingResource(resource), opts, token);
107
+ }
108
+ throw new Error('not supported');
109
+ }
110
+
111
+ readdir(resource: URI): Promise<[string, FileType][]> {
112
+ return this.delegate.readdir(this.toUnderlyingResource(resource));
113
+ }
114
+
115
+ writeFile(resource: URI, content: Uint8Array, opts: FileWriteOptions): Promise<void> {
116
+ if (hasReadWriteCapability(this.delegate)) {
117
+ return this.delegate.writeFile(this.toUnderlyingResource(resource), content, opts);
118
+ }
119
+ throw new Error('not supported');
120
+ }
121
+
122
+ open(resource: URI, opts: FileOpenOptions): Promise<number> {
123
+ if (hasOpenReadWriteCloseCapability(this.delegate)) {
124
+ return this.delegate.open(this.toUnderlyingResource(resource), opts);
125
+ }
126
+ throw new Error('not supported');
127
+ }
128
+
129
+ close(fd: number): Promise<void> {
130
+ if (hasOpenReadWriteCloseCapability(this.delegate)) {
131
+ return this.delegate.close(fd);
132
+ }
133
+ throw new Error('not supported');
134
+ }
135
+
136
+ read(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number> {
137
+ if (hasOpenReadWriteCloseCapability(this.delegate)) {
138
+ return this.delegate.read(fd, pos, data, offset, length);
139
+ }
140
+ throw new Error('not supported');
141
+ }
142
+
143
+ write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number> {
144
+ if (hasOpenReadWriteCloseCapability(this.delegate)) {
145
+ return this.delegate.write(fd, pos, data, offset, length);
146
+ }
147
+ throw new Error('not supported');
148
+ }
149
+
150
+ delete(resource: URI, opts: FileDeleteOptions): Promise<void> {
151
+ return this.delegate.delete(this.toUnderlyingResource(resource), opts);
152
+ }
153
+
154
+ updateFile(resource: URI, changes: TextDocumentContentChangeEvent[], opts: FileUpdateOptions): Promise<FileUpdateResult> {
155
+ if (hasUpdateCapability(this.delegate)) {
156
+ return this.delegate.updateFile(resource, changes, opts);
157
+ }
158
+ throw new Error('not supported');
159
+ }
160
+
161
+ protected handleFileChanges(changes: readonly FileChange[]): void {
162
+ const delegatingChanges: FileChange[] = [];
163
+ for (const change of changes) {
164
+ const delegatingResource = this.fromUnderlyingResource(change.resource);
165
+ if (delegatingResource) {
166
+ delegatingChanges.push({
167
+ resource: delegatingResource,
168
+ type: change.type
169
+ });
170
+ }
171
+ }
172
+ if (delegatingChanges.length) {
173
+ this.onDidChangeFileEmitter.fire(delegatingChanges);
174
+ }
175
+ }
176
+
177
+ /**
178
+ * Converts to an underlying fs provider resource format.
179
+ *
180
+ * For example converting `user-storage` resources to `file` resources under a user home:
181
+ * user-storage:/user/settings.json => file://home/.theia/settings.json
182
+ */
183
+ toUnderlyingResource(resource: URI): URI {
184
+ const underlying = this.options.uriConverter.to(resource);
185
+ if (!underlying) {
186
+ throw new Error('invalid resource: ' + resource.toString());
187
+ }
188
+ return underlying;
189
+ }
190
+
191
+ /**
192
+ * Converts from an underlying fs provider resource format.
193
+ *
194
+ * For example converting `file` resources under a user home to `user-storage` resource:
195
+ * - file://home/.theia/settings.json => user-storage:/user/settings.json
196
+ * - file://documents/some-document.txt => undefined
197
+ */
198
+ fromUnderlyingResource(resource: URI): URI | undefined {
199
+ return this.options.uriConverter.from(resource);
200
+ }
201
+
202
+ }
203
+ export namespace DelegatingFileSystemProvider {
204
+ export interface Options {
205
+ uriConverter: URIConverter
206
+ }
207
+ export interface URIConverter {
208
+ /**
209
+ * Converts to an underlying fs provider resource format.
210
+ * Returns undefined if the given resource is not valid resource.
211
+ *
212
+ * For example converting `user-storage` resources to `file` resources under a user home:
213
+ * user-storage:/user/settings.json => file://home/.theia/settings.json
214
+ * user-storage:/settings.json => undefined
215
+ */
216
+ to(resource: URI): URI | undefined;
217
+ /**
218
+ * Converts from an underlying fs provider resource format.
219
+ *
220
+ * For example converting `file` resources under a user home to `user-storage` resource:
221
+ * - file://home/.theia/settings.json => user-storage:/settings.json
222
+ * - file://documents/some-document.txt => undefined
223
+ */
224
+ from(resource: URI): URI | undefined;
225
+ }
226
+ }
@@ -1,31 +1,31 @@
1
- # Theia - File Download
2
-
3
- Provides the file download contribution to the `Files` navigator.
4
-
5
- Supports single and multi file downloads.
6
- 1. A single file will be downloaded as is.
7
- 2. Folders will be downloaded az tar archives.
8
- 3. When downloading multiple files, the name of the closest common parent directory will be used for the archive.
9
- 4. When downloading multiple files from multiple disks (for instance: `C:\` and `D:\` on Windows), then we apply rule `3.` per disks and we tar the tars.
10
-
11
- ### REST API
12
-
13
- - To download a single file or folder use the following endpoint: `GET /files/?uri=/encoded/file/uri/to/the/resource`.
14
- - Example: `curl -X GET http://localhost:3000/files/?uri=file:///Users/akos.kitta/git/theia/package.json`.
15
-
16
- - To download multiple files (from the same folder) use the `PUT /files/` endpoint with the `application/json` content type header and the following body format:
17
- ```json
18
- {
19
- "uri": [
20
- "/encoded/file/uri/to/the/resource",
21
- "/another/encoded/file/uri/to/the/resource"
22
- ]
23
- }
24
- ```
25
- ```
26
- curl -X PUT -H "Content-Type: application/json" -d '{ "uris": ["file:///Users/akos.kitta/git/theia/package.json", "file:///Users/akos.kitta/git/theia/README.md"] }' http://localhost:3000/files/
27
- ```
28
-
29
- ## License
30
- - [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
1
+ # Theia - File Download
2
+
3
+ Provides the file download contribution to the `Files` navigator.
4
+
5
+ Supports single and multi file downloads.
6
+ 1. A single file will be downloaded as is.
7
+ 2. Folders will be downloaded az tar archives.
8
+ 3. When downloading multiple files, the name of the closest common parent directory will be used for the archive.
9
+ 4. When downloading multiple files from multiple disks (for instance: `C:\` and `D:\` on Windows), then we apply rule `3.` per disks and we tar the tars.
10
+
11
+ ### REST API
12
+
13
+ - To download a single file or folder use the following endpoint: `GET /files/?uri=/encoded/file/uri/to/the/resource`.
14
+ - Example: `curl -X GET http://localhost:3000/files/?uri=file:///Users/akos.kitta/git/theia/package.json`.
15
+
16
+ - To download multiple files (from the same folder) use the `PUT /files/` endpoint with the `application/json` content type header and the following body format:
17
+ ```json
18
+ {
19
+ "uri": [
20
+ "/encoded/file/uri/to/the/resource",
21
+ "/another/encoded/file/uri/to/the/resource"
22
+ ]
23
+ }
24
+ ```
25
+ ```
26
+ curl -X PUT -H "Content-Type: application/json" -d '{ "uris": ["file:///Users/akos.kitta/git/theia/package.json", "file:///Users/akos.kitta/git/theia/README.md"] }' http://localhost:3000/files/
27
+ ```
28
+
29
+ ## License
30
+ - [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
31
31
  - [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
@@ -1,27 +1,27 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2018 TypeFox and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { isObject } from '@theia/core/lib/common';
18
-
19
- export interface FileDownloadData {
20
- readonly uris: string[];
21
- }
22
-
23
- export namespace FileDownloadData {
24
- export function is(arg: unknown): arg is FileDownloadData {
25
- return isObject(arg) && 'uris' in arg;
26
- }
27
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2018 TypeFox and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { isObject } from '@theia/core/lib/common';
18
+
19
+ export interface FileDownloadData {
20
+ readonly uris: string[];
21
+ }
22
+
23
+ export namespace FileDownloadData {
24
+ export function is(arg: unknown): arg is FileDownloadData {
25
+ return isObject(arg) && 'uris' in arg;
26
+ }
27
+ }
@@ -1,17 +1,17 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2021 Ericsson and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- export const HTTP_FILE_UPLOAD_PATH = '/file-upload';
1
+ // *****************************************************************************
2
+ // Copyright (C) 2021 Ericsson and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ export const HTTP_FILE_UPLOAD_PATH = '/file-upload';