@theia/filesystem 1.48.1 → 1.48.3

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 (245) hide show
  1. package/README.md +30 -30
  2. package/lib/browser/breadcrumbs/filepath-breadcrumb.d.ts +15 -15
  3. package/lib/browser/breadcrumbs/filepath-breadcrumb.js +41 -41
  4. package/lib/browser/breadcrumbs/filepath-breadcrumbs-container.d.ts +13 -13
  5. package/lib/browser/breadcrumbs/filepath-breadcrumbs-container.js +70 -70
  6. package/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.d.ts +27 -27
  7. package/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.js +118 -118
  8. package/lib/browser/download/file-download-command-contribution.d.ts +18 -18
  9. package/lib/browser/download/file-download-command-contribution.js +75 -75
  10. package/lib/browser/download/file-download-frontend-module.d.ts +3 -3
  11. package/lib/browser/download/file-download-frontend-module.js +25 -25
  12. package/lib/browser/download/file-download-service.d.ts +28 -28
  13. package/lib/browser/download/file-download-service.js +167 -167
  14. package/lib/browser/file-dialog/file-dialog-container.d.ts +5 -5
  15. package/lib/browser/file-dialog/file-dialog-container.js +60 -60
  16. package/lib/browser/file-dialog/file-dialog-hidden-files-renderer.d.ts +15 -15
  17. package/lib/browser/file-dialog/file-dialog-hidden-files-renderer.js +59 -59
  18. package/lib/browser/file-dialog/file-dialog-model.d.ts +25 -25
  19. package/lib/browser/file-dialog/file-dialog-model.js +100 -100
  20. package/lib/browser/file-dialog/file-dialog-module.d.ts +3 -3
  21. package/lib/browser/file-dialog/file-dialog-module.js +45 -45
  22. package/lib/browser/file-dialog/file-dialog-service.d.ts +32 -32
  23. package/lib/browser/file-dialog/file-dialog-service.js +101 -101
  24. package/lib/browser/file-dialog/file-dialog-tree-filters-renderer.d.ts +39 -39
  25. package/lib/browser/file-dialog/file-dialog-tree-filters-renderer.js +81 -81
  26. package/lib/browser/file-dialog/file-dialog-tree.d.ts +26 -26
  27. package/lib/browser/file-dialog/file-dialog-tree.js +83 -83
  28. package/lib/browser/file-dialog/file-dialog-widget.d.ts +15 -15
  29. package/lib/browser/file-dialog/file-dialog-widget.js +75 -75
  30. package/lib/browser/file-dialog/file-dialog.d.ts +129 -129
  31. package/lib/browser/file-dialog/file-dialog.js +351 -351
  32. package/lib/browser/file-dialog/index.d.ts +4 -4
  33. package/lib/browser/file-dialog/index.js +22 -22
  34. package/lib/browser/file-resource.d.ts +67 -67
  35. package/lib/browser/file-resource.js +369 -369
  36. package/lib/browser/file-selection.d.ts +14 -14
  37. package/lib/browser/file-selection.js +36 -36
  38. package/lib/browser/file-service.d.ts +425 -425
  39. package/lib/browser/file-service.js +1366 -1366
  40. package/lib/browser/file-tree/file-tree-container.d.ts +3 -3
  41. package/lib/browser/file-tree/file-tree-container.js +35 -35
  42. package/lib/browser/file-tree/file-tree-decorator-adapter.d.ts +30 -30
  43. package/lib/browser/file-tree/file-tree-decorator-adapter.js +169 -169
  44. package/lib/browser/file-tree/file-tree-label-provider.d.ts +12 -12
  45. package/lib/browser/file-tree/file-tree-label-provider.js +54 -54
  46. package/lib/browser/file-tree/file-tree-model.d.ts +37 -37
  47. package/lib/browser/file-tree/file-tree-model.js +217 -217
  48. package/lib/browser/file-tree/file-tree-widget.d.ts +44 -44
  49. package/lib/browser/file-tree/file-tree-widget.js +317 -317
  50. package/lib/browser/file-tree/file-tree.d.ts +46 -46
  51. package/lib/browser/file-tree/file-tree.js +176 -176
  52. package/lib/browser/file-tree/index.d.ts +6 -6
  53. package/lib/browser/file-tree/index.js +24 -24
  54. package/lib/browser/file-upload-service.d.ts +109 -109
  55. package/lib/browser/file-upload-service.js +434 -434
  56. package/lib/browser/filesystem-frontend-contribution.d.ts +74 -74
  57. package/lib/browser/filesystem-frontend-contribution.js +356 -356
  58. package/lib/browser/filesystem-frontend-module.d.ts +5 -5
  59. package/lib/browser/filesystem-frontend-module.js +64 -64
  60. package/lib/browser/filesystem-preferences.d.ts +29 -29
  61. package/lib/browser/filesystem-preferences.js +110 -110
  62. package/lib/browser/filesystem-save-resource-service.d.ts +29 -29
  63. package/lib/browser/filesystem-save-resource-service.js +135 -135
  64. package/lib/browser/filesystem-watcher-error-handler.d.ts +10 -10
  65. package/lib/browser/filesystem-watcher-error-handler.js +61 -61
  66. package/lib/browser/index.d.ts +5 -5
  67. package/lib/browser/index.js +23 -23
  68. package/lib/browser/location/index.d.ts +2 -2
  69. package/lib/browser/location/index.js +20 -20
  70. package/lib/browser/location/location-renderer.d.ts +100 -100
  71. package/lib/browser/location/location-renderer.js +343 -343
  72. package/lib/browser/location/location-service.d.ts +5 -5
  73. package/lib/browser/location/location-service.js +17 -17
  74. package/lib/browser/remote-file-service-contribution.d.ts +6 -6
  75. package/lib/browser/remote-file-service-contribution.js +39 -39
  76. package/lib/browser-only/browser-only-filesystem-frontend-module.d.ts +3 -3
  77. package/lib/browser-only/browser-only-filesystem-frontend-module.js +40 -40
  78. package/lib/browser-only/browser-only-filesystem-provider-server.d.ts +11 -11
  79. package/lib/browser-only/browser-only-filesystem-provider-server.js +39 -39
  80. package/lib/browser-only/browserfs-filesystem-initialization.d.ts +12 -12
  81. package/lib/browser-only/browserfs-filesystem-initialization.js +54 -54
  82. package/lib/browser-only/browserfs-filesystem-provider.d.ts +45 -45
  83. package/lib/browser-only/browserfs-filesystem-provider.js +439 -439
  84. package/lib/common/delegating-file-system-provider.d.ts +76 -76
  85. package/lib/common/delegating-file-system-provider.js +168 -168
  86. package/lib/common/download/file-download-data.d.ts +6 -6
  87. package/lib/common/download/file-download-data.js +26 -26
  88. package/lib/common/file-upload.d.ts +1 -1
  89. package/lib/common/file-upload.js +19 -19
  90. package/lib/common/files.d.ts +659 -659
  91. package/lib/common/files.js +355 -355
  92. package/lib/common/files.spec.d.ts +1 -1
  93. package/lib/common/files.spec.js +51 -51
  94. package/lib/common/filesystem-utils.d.ts +14 -14
  95. package/lib/common/filesystem-utils.js +63 -63
  96. package/lib/common/filesystem-utils.spec.d.ts +1 -1
  97. package/lib/common/filesystem-utils.spec.js +378 -378
  98. package/lib/common/filesystem-watcher-protocol.d.ts +71 -71
  99. package/lib/common/filesystem-watcher-protocol.js +20 -20
  100. package/lib/common/filesystem.d.ts +22 -22
  101. package/lib/common/filesystem.js +42 -42
  102. package/lib/common/index.d.ts +2 -2
  103. package/lib/common/index.js +20 -20
  104. package/lib/common/io.d.ts +19 -19
  105. package/lib/common/io.js +110 -110
  106. package/lib/common/remote-file-system-provider.d.ts +173 -173
  107. package/lib/common/remote-file-system-provider.js +435 -435
  108. package/lib/electron-browser/file-dialog/electron-file-dialog-module.d.ts +3 -3
  109. package/lib/electron-browser/file-dialog/electron-file-dialog-module.js +24 -24
  110. package/lib/electron-browser/file-dialog/electron-file-dialog-service.d.ts +19 -19
  111. package/lib/electron-browser/file-dialog/electron-file-dialog-service.js +148 -148
  112. package/lib/electron-browser/preload.d.ts +1 -1
  113. package/lib/electron-browser/preload.js +30 -30
  114. package/lib/electron-common/electron-api.d.ts +34 -34
  115. package/lib/electron-common/electron-api.js +20 -20
  116. package/lib/electron-main/electron-api-main.d.ts +5 -5
  117. package/lib/electron-main/electron-api-main.js +73 -73
  118. package/lib/electron-main/electron-main-module.d.ts +3 -3
  119. package/lib/electron-main/electron-main-module.js +24 -24
  120. package/lib/node/disk-file-system-provider.d.ts +72 -72
  121. package/lib/node/disk-file-system-provider.js +787 -787
  122. package/lib/node/disk-file-system-provider.spec.d.ts +1 -1
  123. package/lib/node/disk-file-system-provider.spec.js +122 -122
  124. package/lib/node/download/directory-archiver.d.ts +9 -9
  125. package/lib/node/download/directory-archiver.js +127 -127
  126. package/lib/node/download/directory-archiver.spec.d.ts +1 -1
  127. package/lib/node/download/directory-archiver.spec.js +97 -97
  128. package/lib/node/download/file-download-backend-module.d.ts +3 -3
  129. package/lib/node/download/file-download-backend-module.js +32 -32
  130. package/lib/node/download/file-download-cache.d.ts +21 -21
  131. package/lib/node/download/file-download-cache.js +82 -82
  132. package/lib/node/download/file-download-endpoint.d.ts +11 -11
  133. package/lib/node/download/file-download-endpoint.js +67 -67
  134. package/lib/node/download/file-download-handler.d.ts +50 -50
  135. package/lib/node/download/file-download-handler.js +307 -307
  136. package/lib/node/download/test/mock-directory-archiver.d.ts +7 -7
  137. package/lib/node/download/test/mock-directory-archiver.js +29 -29
  138. package/lib/node/file-change-collection.d.ts +22 -22
  139. package/lib/node/file-change-collection.js +77 -77
  140. package/lib/node/file-change-collection.spec.d.ts +1 -1
  141. package/lib/node/file-change-collection.spec.js +90 -90
  142. package/lib/node/filesystem-backend-module.d.ts +26 -26
  143. package/lib/node/filesystem-backend-module.js +120 -120
  144. package/lib/node/filesystem-watcher-client.d.ts +23 -23
  145. package/lib/node/filesystem-watcher-client.js +75 -75
  146. package/lib/node/filesystem-watcher-dispatcher.d.ts +23 -23
  147. package/lib/node/filesystem-watcher-dispatcher.js +80 -80
  148. package/lib/node/node-file-upload-service.d.ts +16 -16
  149. package/lib/node/node-file-upload-service.js +79 -79
  150. package/lib/node/nsfw-watcher/index.d.ts +3 -3
  151. package/lib/node/nsfw-watcher/index.js +39 -39
  152. package/lib/node/nsfw-watcher/nsfw-filesystem-service.d.ts +191 -191
  153. package/lib/node/nsfw-watcher/nsfw-filesystem-service.js +405 -405
  154. package/lib/node/nsfw-watcher/nsfw-filesystem-watcher.spec.d.ts +1 -1
  155. package/lib/node/nsfw-watcher/nsfw-filesystem-watcher.spec.js +151 -151
  156. package/lib/node/nsfw-watcher/nsfw-options.d.ts +6 -6
  157. package/lib/node/nsfw-watcher/nsfw-options.js +22 -22
  158. package/package.json +4 -4
  159. package/src/browser/breadcrumbs/filepath-breadcrumb.ts +43 -43
  160. package/src/browser/breadcrumbs/filepath-breadcrumbs-container.ts +65 -65
  161. package/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts +129 -129
  162. package/src/browser/download/file-download-command-contribution.ts +83 -83
  163. package/src/browser/download/file-download-frontend-module.ts +25 -25
  164. package/src/browser/download/file-download-service.ts +179 -179
  165. package/src/browser/file-dialog/file-dialog-container.ts +67 -67
  166. package/src/browser/file-dialog/file-dialog-hidden-files-renderer.tsx +59 -59
  167. package/src/browser/file-dialog/file-dialog-model.ts +96 -96
  168. package/src/browser/file-dialog/file-dialog-module.ts +44 -44
  169. package/src/browser/file-dialog/file-dialog-service.ts +99 -99
  170. package/src/browser/file-dialog/file-dialog-tree-filters-renderer.tsx +100 -100
  171. package/src/browser/file-dialog/file-dialog-tree.ts +89 -89
  172. package/src/browser/file-dialog/file-dialog-widget.ts +75 -75
  173. package/src/browser/file-dialog/file-dialog.ts +434 -434
  174. package/src/browser/file-dialog/index.ts +20 -20
  175. package/src/browser/file-resource.ts +390 -390
  176. package/src/browser/file-selection.ts +44 -44
  177. package/src/browser/file-service.ts +1841 -1841
  178. package/src/browser/file-tree/file-tree-container.ts +36 -36
  179. package/src/browser/file-tree/file-tree-decorator-adapter.ts +159 -159
  180. package/src/browser/file-tree/file-tree-label-provider.ts +53 -53
  181. package/src/browser/file-tree/file-tree-model.ts +212 -212
  182. package/src/browser/file-tree/file-tree-widget.tsx +327 -327
  183. package/src/browser/file-tree/file-tree.ts +183 -183
  184. package/src/browser/file-tree/index.ts +22 -22
  185. package/src/browser/file-upload-service.ts +539 -539
  186. package/src/browser/filesystem-frontend-contribution.ts +381 -381
  187. package/src/browser/filesystem-frontend-module.ts +77 -77
  188. package/src/browser/filesystem-preferences.ts +139 -139
  189. package/src/browser/filesystem-save-resource-service.ts +125 -125
  190. package/src/browser/filesystem-watcher-error-handler.ts +60 -60
  191. package/src/browser/index.ts +21 -21
  192. package/src/browser/location/index.ts +18 -18
  193. package/src/browser/location/location-renderer.tsx +404 -404
  194. package/src/browser/location/location-service.ts +22 -22
  195. package/src/browser/remote-file-service-contribution.ts +38 -38
  196. package/src/browser/style/file-dialog.css +208 -208
  197. package/src/browser/style/file-icons.css +64 -64
  198. package/src/browser/style/filepath-breadcrumbs.css +20 -20
  199. package/src/browser/style/index.css +36 -36
  200. package/src/browser-only/browser-only-filesystem-frontend-module.ts +38 -38
  201. package/src/browser-only/browser-only-filesystem-provider-server.ts +32 -32
  202. package/src/browser-only/browserfs-filesystem-initialization.ts +61 -61
  203. package/src/browser-only/browserfs-filesystem-provider.ts +462 -462
  204. package/src/common/delegating-file-system-provider.ts +226 -226
  205. package/src/common/download/README.md +30 -30
  206. package/src/common/download/file-download-data.ts +27 -27
  207. package/src/common/file-upload.ts +17 -17
  208. package/src/common/files.spec.ts +51 -51
  209. package/src/common/files.ts +996 -996
  210. package/src/common/filesystem-utils.spec.ts +411 -411
  211. package/src/common/filesystem-utils.ts +64 -64
  212. package/src/common/filesystem-watcher-protocol.ts +96 -96
  213. package/src/common/filesystem.ts +43 -43
  214. package/src/common/index.ts +18 -18
  215. package/src/common/io.ts +150 -150
  216. package/src/common/remote-file-system-provider.ts +549 -549
  217. package/src/electron-browser/file-dialog/electron-file-dialog-module.ts +24 -24
  218. package/src/electron-browser/file-dialog/electron-file-dialog-service.ts +165 -165
  219. package/src/electron-browser/preload.ts +31 -31
  220. package/src/electron-common/electron-api.ts +55 -55
  221. package/src/electron-main/electron-api-main.ts +78 -78
  222. package/src/electron-main/electron-main-module.ts +23 -23
  223. package/src/node/disk-file-system-provider.spec.ts +142 -142
  224. package/src/node/disk-file-system-provider.ts +915 -915
  225. package/src/node/download/directory-archiver.spec.ts +104 -104
  226. package/src/node/download/directory-archiver.ts +126 -126
  227. package/src/node/download/file-download-backend-module.ts +32 -32
  228. package/src/node/download/file-download-cache.ts +88 -88
  229. package/src/node/download/file-download-endpoint.ts +63 -63
  230. package/src/node/download/file-download-handler.ts +304 -304
  231. package/src/node/download/test/mock-directory-archiver.ts +30 -30
  232. package/src/node/file-change-collection.spec.ts +110 -110
  233. package/src/node/file-change-collection.ts +78 -78
  234. package/src/node/filesystem-backend-module.ts +140 -140
  235. package/src/node/filesystem-watcher-client.ts +72 -72
  236. package/src/node/filesystem-watcher-dispatcher.ts +82 -82
  237. package/src/node/node-file-upload-service.ts +80 -80
  238. package/src/node/nsfw-watcher/index.ts +45 -45
  239. package/src/node/nsfw-watcher/nsfw-filesystem-service.ts +481 -481
  240. package/src/node/nsfw-watcher/nsfw-filesystem-watcher.spec.ts +182 -182
  241. package/src/node/nsfw-watcher/nsfw-options.ts +23 -23
  242. package/src/typings/dom.webkit.d.ts +77 -77
  243. package/src/typings/mv/index.d.ts +21 -21
  244. package/src/typings/nsfw/index.d.ts +18 -18
  245. 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';