@theia/filesystem 1.34.3 → 1.34.4

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 (216) hide show
  1. package/LICENSE +641 -641
  2. package/README.md +30 -30
  3. package/lib/browser/breadcrumbs/filepath-breadcrumb.d.ts +15 -15
  4. package/lib/browser/breadcrumbs/filepath-breadcrumb.js +41 -41
  5. package/lib/browser/breadcrumbs/filepath-breadcrumbs-container.d.ts +13 -13
  6. package/lib/browser/breadcrumbs/filepath-breadcrumbs-container.js +78 -78
  7. package/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.d.ts +27 -27
  8. package/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.js +126 -126
  9. package/lib/browser/download/file-download-command-contribution.d.ts +18 -18
  10. package/lib/browser/download/file-download-command-contribution.js +83 -83
  11. package/lib/browser/download/file-download-frontend-module.d.ts +3 -3
  12. package/lib/browser/download/file-download-frontend-module.js +25 -25
  13. package/lib/browser/download/file-download-service.d.ts +28 -28
  14. package/lib/browser/download/file-download-service.js +175 -175
  15. package/lib/browser/file-dialog/file-dialog-container.d.ts +5 -5
  16. package/lib/browser/file-dialog/file-dialog-container.js +52 -52
  17. package/lib/browser/file-dialog/file-dialog-model.d.ts +25 -25
  18. package/lib/browser/file-dialog/file-dialog-model.js +108 -108
  19. package/lib/browser/file-dialog/file-dialog-module.d.ts +3 -3
  20. package/lib/browser/file-dialog/file-dialog-module.js +37 -37
  21. package/lib/browser/file-dialog/file-dialog-service.d.ts +32 -32
  22. package/lib/browser/file-dialog/file-dialog-service.js +107 -107
  23. package/lib/browser/file-dialog/file-dialog-tree-filters-renderer.d.ts +39 -39
  24. package/lib/browser/file-dialog/file-dialog-tree-filters-renderer.js +92 -92
  25. package/lib/browser/file-dialog/file-dialog-tree.d.ts +22 -22
  26. package/lib/browser/file-dialog/file-dialog-tree.js +71 -71
  27. package/lib/browser/file-dialog/file-dialog-widget.d.ts +15 -15
  28. package/lib/browser/file-dialog/file-dialog-widget.js +86 -86
  29. package/lib/browser/file-dialog/file-dialog.d.ts +126 -126
  30. package/lib/browser/file-dialog/file-dialog.js +355 -355
  31. package/lib/browser/file-dialog/index.d.ts +4 -4
  32. package/lib/browser/file-dialog/index.js +31 -31
  33. package/lib/browser/file-resource.d.ts +63 -63
  34. package/lib/browser/file-resource.js +352 -352
  35. package/lib/browser/file-selection.d.ts +14 -14
  36. package/lib/browser/file-selection.js +36 -36
  37. package/lib/browser/file-service.d.ts +412 -412
  38. package/lib/browser/file-service.js +1330 -1330
  39. package/lib/browser/file-tree/file-tree-container.d.ts +3 -3
  40. package/lib/browser/file-tree/file-tree-container.js +35 -35
  41. package/lib/browser/file-tree/file-tree-decorator-adapter.d.ts +30 -30
  42. package/lib/browser/file-tree/file-tree-decorator-adapter.js +174 -174
  43. package/lib/browser/file-tree/file-tree-label-provider.d.ts +12 -12
  44. package/lib/browser/file-tree/file-tree-label-provider.js +62 -62
  45. package/lib/browser/file-tree/file-tree-model.d.ts +37 -37
  46. package/lib/browser/file-tree/file-tree-model.js +225 -225
  47. package/lib/browser/file-tree/file-tree-widget.d.ts +44 -44
  48. package/lib/browser/file-tree/file-tree-widget.js +315 -315
  49. package/lib/browser/file-tree/file-tree.d.ts +46 -46
  50. package/lib/browser/file-tree/file-tree.js +184 -184
  51. package/lib/browser/file-tree/index.d.ts +6 -6
  52. package/lib/browser/file-tree/index.js +33 -33
  53. package/lib/browser/file-upload-service.d.ts +98 -98
  54. package/lib/browser/file-upload-service.js +428 -428
  55. package/lib/browser/filesystem-frontend-contribution.d.ts +63 -63
  56. package/lib/browser/filesystem-frontend-contribution.js +324 -324
  57. package/lib/browser/filesystem-frontend-module.d.ts +5 -5
  58. package/lib/browser/filesystem-frontend-module.js +64 -64
  59. package/lib/browser/filesystem-preferences.d.ts +29 -29
  60. package/lib/browser/filesystem-preferences.js +108 -108
  61. package/lib/browser/filesystem-save-resource-service.d.ts +29 -29
  62. package/lib/browser/filesystem-save-resource-service.js +142 -142
  63. package/lib/browser/filesystem-watcher-error-handler.d.ts +10 -10
  64. package/lib/browser/filesystem-watcher-error-handler.js +69 -69
  65. package/lib/browser/index.d.ts +5 -5
  66. package/lib/browser/index.js +32 -32
  67. package/lib/browser/location/index.d.ts +2 -2
  68. package/lib/browser/location/index.js +29 -29
  69. package/lib/browser/location/location-renderer.d.ts +99 -99
  70. package/lib/browser/location/location-renderer.js +351 -351
  71. package/lib/browser/location/location-service.d.ts +5 -5
  72. package/lib/browser/location/location-service.js +17 -17
  73. package/lib/browser/remote-file-service-contribution.d.ts +6 -6
  74. package/lib/browser/remote-file-service-contribution.js +47 -47
  75. package/lib/common/delegating-file-system-provider.d.ts +76 -76
  76. package/lib/common/delegating-file-system-provider.js +168 -168
  77. package/lib/common/download/file-download-data.d.ts +6 -6
  78. package/lib/common/download/file-download-data.js +26 -26
  79. package/lib/common/file-upload.d.ts +1 -1
  80. package/lib/common/file-upload.js +19 -19
  81. package/lib/common/files.d.ts +651 -651
  82. package/lib/common/files.js +347 -347
  83. package/lib/common/files.spec.d.ts +1 -1
  84. package/lib/common/files.spec.js +51 -51
  85. package/lib/common/filesystem-utils.d.ts +14 -14
  86. package/lib/common/filesystem-utils.js +63 -63
  87. package/lib/common/filesystem-utils.spec.d.ts +1 -1
  88. package/lib/common/filesystem-utils.spec.js +378 -378
  89. package/lib/common/filesystem-watcher-protocol.d.ts +71 -71
  90. package/lib/common/filesystem-watcher-protocol.js +20 -20
  91. package/lib/common/filesystem.d.ts +22 -22
  92. package/lib/common/filesystem.js +42 -42
  93. package/lib/common/index.d.ts +2 -2
  94. package/lib/common/index.js +29 -29
  95. package/lib/common/io.d.ts +19 -19
  96. package/lib/common/io.js +110 -110
  97. package/lib/common/remote-file-system-provider.d.ts +164 -164
  98. package/lib/common/remote-file-system-provider.js +413 -413
  99. package/lib/electron-browser/file-dialog/electron-file-dialog-module.d.ts +3 -3
  100. package/lib/electron-browser/file-dialog/electron-file-dialog-module.js +24 -24
  101. package/lib/electron-browser/file-dialog/electron-file-dialog-service.d.ts +58 -58
  102. package/lib/electron-browser/file-dialog/electron-file-dialog-service.js +194 -194
  103. package/lib/node/disk-file-system-provider.d.ts +72 -72
  104. package/lib/node/disk-file-system-provider.js +783 -783
  105. package/lib/node/download/directory-archiver.d.ts +9 -9
  106. package/lib/node/download/directory-archiver.js +132 -132
  107. package/lib/node/download/directory-archiver.spec.d.ts +1 -1
  108. package/lib/node/download/directory-archiver.spec.js +97 -97
  109. package/lib/node/download/file-download-backend-module.d.ts +3 -3
  110. package/lib/node/download/file-download-backend-module.js +32 -32
  111. package/lib/node/download/file-download-cache.d.ts +21 -21
  112. package/lib/node/download/file-download-cache.js +90 -90
  113. package/lib/node/download/file-download-endpoint.d.ts +11 -11
  114. package/lib/node/download/file-download-endpoint.js +75 -75
  115. package/lib/node/download/file-download-handler.d.ts +50 -50
  116. package/lib/node/download/file-download-handler.js +315 -315
  117. package/lib/node/download/test/mock-directory-archiver.d.ts +7 -7
  118. package/lib/node/download/test/mock-directory-archiver.js +29 -29
  119. package/lib/node/file-change-collection.d.ts +22 -22
  120. package/lib/node/file-change-collection.js +77 -77
  121. package/lib/node/file-change-collection.spec.d.ts +1 -1
  122. package/lib/node/file-change-collection.spec.js +90 -90
  123. package/lib/node/filesystem-backend-module.d.ts +26 -26
  124. package/lib/node/filesystem-backend-module.js +120 -120
  125. package/lib/node/filesystem-watcher-client.d.ts +23 -23
  126. package/lib/node/filesystem-watcher-client.js +83 -83
  127. package/lib/node/filesystem-watcher-dispatcher.d.ts +23 -23
  128. package/lib/node/filesystem-watcher-dispatcher.js +85 -85
  129. package/lib/node/node-file-upload-service.d.ts +15 -15
  130. package/lib/node/node-file-upload-service.js +76 -76
  131. package/lib/node/nsfw-watcher/index.d.ts +3 -3
  132. package/lib/node/nsfw-watcher/index.js +39 -39
  133. package/lib/node/nsfw-watcher/nsfw-filesystem-service.d.ts +191 -191
  134. package/lib/node/nsfw-watcher/nsfw-filesystem-service.js +389 -389
  135. package/lib/node/nsfw-watcher/nsfw-filesystem-watcher.spec.d.ts +1 -1
  136. package/lib/node/nsfw-watcher/nsfw-filesystem-watcher.spec.js +151 -151
  137. package/lib/node/nsfw-watcher/nsfw-options.d.ts +6 -6
  138. package/lib/node/nsfw-watcher/nsfw-options.js +22 -22
  139. package/package.json +4 -4
  140. package/src/browser/breadcrumbs/filepath-breadcrumb.ts +43 -43
  141. package/src/browser/breadcrumbs/filepath-breadcrumbs-container.ts +65 -65
  142. package/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts +129 -129
  143. package/src/browser/download/file-download-command-contribution.ts +83 -83
  144. package/src/browser/download/file-download-frontend-module.ts +25 -25
  145. package/src/browser/download/file-download-service.ts +179 -179
  146. package/src/browser/file-dialog/file-dialog-container.ts +67 -67
  147. package/src/browser/file-dialog/file-dialog-model.ts +96 -96
  148. package/src/browser/file-dialog/file-dialog-module.ts +36 -36
  149. package/src/browser/file-dialog/file-dialog-service.ts +97 -97
  150. package/src/browser/file-dialog/file-dialog-tree-filters-renderer.tsx +100 -100
  151. package/src/browser/file-dialog/file-dialog-tree.ts +71 -71
  152. package/src/browser/file-dialog/file-dialog-widget.ts +75 -75
  153. package/src/browser/file-dialog/file-dialog.ts +428 -428
  154. package/src/browser/file-dialog/index.ts +20 -20
  155. package/src/browser/file-resource.ts +361 -361
  156. package/src/browser/file-selection.ts +44 -44
  157. package/src/browser/file-service.ts +1814 -1814
  158. package/src/browser/file-tree/file-tree-container.ts +36 -36
  159. package/src/browser/file-tree/file-tree-decorator-adapter.ts +159 -159
  160. package/src/browser/file-tree/file-tree-label-provider.ts +53 -53
  161. package/src/browser/file-tree/file-tree-model.ts +212 -212
  162. package/src/browser/file-tree/file-tree-widget.tsx +327 -327
  163. package/src/browser/file-tree/file-tree.ts +183 -183
  164. package/src/browser/file-tree/index.ts +22 -22
  165. package/src/browser/file-upload-service.ts +513 -513
  166. package/src/browser/filesystem-frontend-contribution.ts +338 -338
  167. package/src/browser/filesystem-frontend-module.ts +77 -77
  168. package/src/browser/filesystem-preferences.ts +138 -138
  169. package/src/browser/filesystem-save-resource-service.ts +124 -124
  170. package/src/browser/filesystem-watcher-error-handler.ts +60 -60
  171. package/src/browser/index.ts +21 -21
  172. package/src/browser/location/index.ts +18 -18
  173. package/src/browser/location/location-renderer.tsx +400 -400
  174. package/src/browser/location/location-service.ts +22 -22
  175. package/src/browser/remote-file-service-contribution.ts +38 -38
  176. package/src/browser/style/file-dialog.css +204 -204
  177. package/src/browser/style/file-icons.css +64 -64
  178. package/src/browser/style/filepath-breadcrumbs.css +20 -20
  179. package/src/browser/style/index.css +36 -36
  180. package/src/common/delegating-file-system-provider.ts +226 -226
  181. package/src/common/download/README.md +30 -30
  182. package/src/common/download/file-download-data.ts +27 -27
  183. package/src/common/file-upload.ts +17 -17
  184. package/src/common/files.spec.ts +51 -51
  185. package/src/common/files.ts +983 -983
  186. package/src/common/filesystem-utils.spec.ts +411 -411
  187. package/src/common/filesystem-utils.ts +64 -64
  188. package/src/common/filesystem-watcher-protocol.ts +96 -96
  189. package/src/common/filesystem.ts +43 -43
  190. package/src/common/index.ts +18 -18
  191. package/src/common/io.ts +150 -150
  192. package/src/common/remote-file-system-provider.ts +511 -511
  193. package/src/electron-browser/file-dialog/electron-file-dialog-module.ts +24 -24
  194. package/src/electron-browser/file-dialog/electron-file-dialog-service.ts +229 -229
  195. package/src/node/disk-file-system-provider.ts +908 -908
  196. package/src/node/download/directory-archiver.spec.ts +104 -104
  197. package/src/node/download/directory-archiver.ts +126 -126
  198. package/src/node/download/file-download-backend-module.ts +32 -32
  199. package/src/node/download/file-download-cache.ts +88 -88
  200. package/src/node/download/file-download-endpoint.ts +63 -63
  201. package/src/node/download/file-download-handler.ts +304 -304
  202. package/src/node/download/test/mock-directory-archiver.ts +30 -30
  203. package/src/node/file-change-collection.spec.ts +110 -110
  204. package/src/node/file-change-collection.ts +78 -78
  205. package/src/node/filesystem-backend-module.ts +140 -140
  206. package/src/node/filesystem-watcher-client.ts +72 -72
  207. package/src/node/filesystem-watcher-dispatcher.ts +82 -82
  208. package/src/node/node-file-upload-service.ts +73 -73
  209. package/src/node/nsfw-watcher/index.ts +45 -45
  210. package/src/node/nsfw-watcher/nsfw-filesystem-service.ts +476 -476
  211. package/src/node/nsfw-watcher/nsfw-filesystem-watcher.spec.ts +182 -182
  212. package/src/node/nsfw-watcher/nsfw-options.ts +23 -23
  213. package/src/typings/dom.webkit.d.ts +77 -77
  214. package/src/typings/mv/index.d.ts +21 -21
  215. package/src/typings/nsfw/index.d.ts +18 -18
  216. package/src/typings/trash/index.d.ts +20 -20
@@ -1,20 +1,20 @@
1
- /********************************************************************************
2
- * Copyright (C) 2019 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 WITH Classpath-exception-2.0
15
- ********************************************************************************/
16
-
17
- .theia-FilepathBreadcrumbFileTree {
18
- height: auto;
19
- max-height: 200px;
20
- }
1
+ /********************************************************************************
2
+ * Copyright (C) 2019 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 WITH Classpath-exception-2.0
15
+ ********************************************************************************/
16
+
17
+ .theia-FilepathBreadcrumbFileTree {
18
+ height: auto;
19
+ max-height: 200px;
20
+ }
@@ -1,36 +1,36 @@
1
- /********************************************************************************
2
- * Copyright (C) 2017 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 WITH Classpath-exception-2.0
15
- ********************************************************************************/
16
-
17
- @import './file-dialog.css';
18
- @import './file-icons.css';
19
- @import './filepath-breadcrumbs.css';
20
-
21
- .theia-file-tree-drag-image {
22
- position: absolute;
23
- /*
24
- make sure you don't see it flashing
25
- */
26
- top: -1000px;
27
- font-size: var(--theia-ui-font-size1);
28
- display: inline-block;
29
- padding: 1px calc(var(--theia-ui-padding)*2);
30
- border-radius: 10px;
31
-
32
- background: var(--theia-list-activeSelectionBackground);
33
- color: var(--theia-list-activeSelectionForeground);
34
- outline: 1px solid var(--theia-contrastActiveBorder);
35
- outline-offset: -1px;
36
- }
1
+ /********************************************************************************
2
+ * Copyright (C) 2017 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 WITH Classpath-exception-2.0
15
+ ********************************************************************************/
16
+
17
+ @import './file-dialog.css';
18
+ @import './file-icons.css';
19
+ @import './filepath-breadcrumbs.css';
20
+
21
+ .theia-file-tree-drag-image {
22
+ position: absolute;
23
+ /*
24
+ make sure you don't see it flashing
25
+ */
26
+ top: -1000px;
27
+ font-size: var(--theia-ui-font-size1);
28
+ display: inline-block;
29
+ padding: 1px calc(var(--theia-ui-padding)*2);
30
+ border-radius: 10px;
31
+
32
+ background: var(--theia-list-activeSelectionBackground);
33
+ color: var(--theia-list-activeSelectionForeground);
34
+ outline: 1px solid var(--theia-contrastActiveBorder);
35
+ outline-offset: -1px;
36
+ }
@@ -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 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 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)