@theia/filesystem 1.48.1 → 1.48.2

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,539 +1,539 @@
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-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- /* eslint-disable @typescript-eslint/no-explicit-any */
18
-
19
- import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
20
- import URI from '@theia/core/lib/common/uri';
21
- import { CancellationTokenSource, CancellationToken, checkCancelled, cancelled, isCancelled } from '@theia/core/lib/common/cancellation';
22
- import { Deferred } from '@theia/core/lib/common/promise-util';
23
- import { MessageService } from '@theia/core/lib/common/message-service';
24
- import { Progress } from '@theia/core/lib/common/message-service-protocol';
25
- import { Endpoint } from '@theia/core/lib/browser/endpoint';
26
- import throttle = require('@theia/core/shared/lodash.throttle');
27
- import { HTTP_FILE_UPLOAD_PATH } from '../common/file-upload';
28
- import { Semaphore } from 'async-mutex';
29
- import { FileSystemPreferences } from './filesystem-preferences';
30
- import { FileService } from './file-service';
31
- import { ConfirmDialog, Dialog } from '@theia/core/lib/browser';
32
- import { nls } from '@theia/core/lib/common/nls';
33
-
34
- export const HTTP_UPLOAD_URL: string = new Endpoint({ path: HTTP_FILE_UPLOAD_PATH }).getRestUrl().toString(true);
35
-
36
- export type CustomDataTransfer = Iterable<readonly [string, CustomDataTransferItem]>;
37
-
38
- export interface CustomDataTransferItem {
39
- asFile(): {
40
- readonly id: string;
41
- readonly name: string;
42
- data(): Promise<Uint8Array>;
43
- } | undefined
44
- }
45
- export interface FileUploadParams {
46
- source?: DataTransfer | CustomDataTransfer
47
- progress?: FileUploadProgressParams
48
- onDidUpload?: (uri: string) => void;
49
- leaveInTemp?: boolean // dont move file out of the initial tmp directory
50
- }
51
- export interface FileUploadProgressParams {
52
- text: string
53
- }
54
-
55
- export interface FileUploadResult {
56
- uploaded: string[]
57
- }
58
-
59
- @injectable()
60
- export class FileUploadService {
61
-
62
- static TARGET = 'target';
63
- static UPLOAD = 'upload';
64
-
65
- protected uploadForm: FileUploadService.Form;
66
- protected deferredUpload?: Deferred<FileUploadResult>;
67
-
68
- @inject(MessageService)
69
- protected readonly messageService: MessageService;
70
-
71
- @inject(FileSystemPreferences)
72
- protected fileSystemPreferences: FileSystemPreferences;
73
-
74
- @inject(FileService)
75
- protected fileService: FileService;
76
-
77
- get maxConcurrentUploads(): number {
78
- const maxConcurrentUploads = this.fileSystemPreferences['files.maxConcurrentUploads'];
79
- return maxConcurrentUploads > 0 ? maxConcurrentUploads : Infinity;
80
- }
81
-
82
- @postConstruct()
83
- protected init(): void {
84
- this.uploadForm = this.createUploadForm();
85
- }
86
-
87
- protected createUploadForm(): FileUploadService.Form {
88
- const targetInput = document.createElement('input');
89
- targetInput.type = 'text';
90
- targetInput.spellcheck = false;
91
- targetInput.name = FileUploadService.TARGET;
92
- targetInput.classList.add('theia-input');
93
-
94
- const fileInput = document.createElement('input');
95
- fileInput.type = 'file';
96
- fileInput.classList.add('theia-input');
97
- fileInput.name = FileUploadService.UPLOAD;
98
- fileInput.multiple = true;
99
-
100
- const form = document.createElement('form');
101
- form.style.display = 'none';
102
- form.enctype = 'multipart/form-data';
103
- form.append(targetInput);
104
- form.append(fileInput);
105
-
106
- document.body.appendChild(form);
107
-
108
- fileInput.addEventListener('change', () => {
109
- if (this.deferredUpload && fileInput.value) {
110
- const source: FileUploadService.Source = new FormData(form);
111
- // clean up to allow upload to the same folder twice
112
- fileInput.value = '';
113
- const targetUri = new URI(<string>source.get(FileUploadService.TARGET));
114
- const { resolve, reject } = this.deferredUpload;
115
- this.deferredUpload = undefined;
116
- const { onDidUpload } = this.uploadForm;
117
- this.withProgress(
118
- (progress, token) => this.uploadAll(targetUri, { source, progress, token, onDidUpload }),
119
- this.uploadForm.progress
120
- ).then(resolve, reject);
121
- }
122
- });
123
- return { targetInput, fileInput };
124
- }
125
-
126
- async upload(targetUri: string | URI, params: FileUploadParams = {}): Promise<FileUploadResult> {
127
- const { source, onDidUpload, leaveInTemp } = params;
128
- if (source) {
129
- return this.withProgress(
130
- (progress, token) => this.uploadAll(
131
- typeof targetUri === 'string' ? new URI(targetUri) : targetUri,
132
- { source, progress, token, leaveInTemp, onDidUpload }
133
- ),
134
- params.progress,
135
- );
136
- }
137
- this.deferredUpload = new Deferred<FileUploadResult>();
138
- this.uploadForm.targetInput.value = String(targetUri);
139
- this.uploadForm.fileInput.click();
140
- this.uploadForm.progress = params.progress;
141
- this.uploadForm.onDidUpload = params.onDidUpload;
142
- return this.deferredUpload.promise;
143
- }
144
-
145
- protected getUploadUrl(): string {
146
- return HTTP_UPLOAD_URL;
147
- }
148
-
149
- protected async uploadAll(targetUri: URI, params: FileUploadService.UploadParams): Promise<FileUploadResult> {
150
- const responses: Promise<void>[] = [];
151
- const status = new Map<File, {
152
- total: number
153
- done: number
154
- uploaded?: boolean
155
- }>();
156
- const result: FileUploadResult = {
157
- uploaded: []
158
- };
159
- /**
160
- * When `false`: display the uploading progress.
161
- * When `true`: display the server-processing progress.
162
- */
163
- let waitingForResponses = false;
164
- const report = throttle(() => {
165
- if (waitingForResponses) {
166
- /** Number of files being processed. */
167
- const total = status.size;
168
- /** Number of files uploaded and processed. */
169
- let done = 0;
170
- for (const item of status.values()) {
171
- if (item.uploaded) {
172
- done += 1;
173
- }
174
- }
175
- params.progress.report({
176
- message: nls.localize('theia/filesystem/processedOutOf', 'Processed {0} out of {1}', done, total),
177
- work: { total, done }
178
- });
179
- } else {
180
- /** Total number of bytes being uploaded. */
181
- let total = 0;
182
- /** Current number of bytes uploaded. */
183
- let done = 0;
184
- for (const item of status.values()) {
185
- total += item.total;
186
- done += item.done;
187
- }
188
- params.progress.report({
189
- message: nls.localize('theia/filesystem/uploadedOutOf', 'Uploaded {0} out of {1}', result.uploaded.length, status.size),
190
- work: { total, done }
191
- });
192
- }
193
- }, 100);
194
- const uploads: Promise<void>[] = [];
195
- const uploadSemaphore = new Semaphore(this.maxConcurrentUploads);
196
- try {
197
- await this.index(targetUri, params.source, {
198
- token: params.token,
199
- progress: params.progress,
200
- accept: async item => {
201
- if (await this.fileService.exists(item.uri) && !await this.confirmOverwrite(item.uri)) {
202
- return;
203
- }
204
- // Track and initialize the file in the status map:
205
- status.set(item.file, { total: item.file.size, done: 0 });
206
- report();
207
- // Don't await here: the semaphore will organize the uploading tasks, not the async indexer.
208
- uploads.push(uploadSemaphore.runExclusive(async () => {
209
- checkCancelled(params.token);
210
- const { upload, response } = this.uploadFile(item.file, item.uri, params.token, params.leaveInTemp, (total, done) => {
211
- const entry = status.get(item.file);
212
- if (entry) {
213
- entry.total = total;
214
- entry.done = done;
215
- report();
216
- }
217
- });
218
- function onError(error: Error): void {
219
- status.delete(item.file);
220
- throw error;
221
- }
222
- responses.push(response
223
- .then(() => {
224
- checkCancelled(params.token);
225
- // Consider the file uploaded once the server sends OK back.
226
- result.uploaded.push(item.uri.toString(true));
227
- const entry = status.get(item.file);
228
- if (entry) {
229
- entry.uploaded = true;
230
- report();
231
- }
232
- })
233
- .catch(onError)
234
- );
235
- // Have the queue wait for the upload only.
236
- return upload
237
- .catch(onError);
238
- }));
239
- }
240
- });
241
- checkCancelled(params.token);
242
- await Promise.all(uploads);
243
- checkCancelled(params.token);
244
- waitingForResponses = true;
245
- report();
246
- await Promise.all(responses);
247
- } catch (error) {
248
- uploadSemaphore.cancel();
249
- if (!isCancelled(error)) {
250
- throw error;
251
- }
252
- }
253
- return result;
254
- }
255
-
256
- protected async confirmOverwrite(fileUri: URI): Promise<boolean> {
257
- const dialog = new ConfirmDialog({
258
- title: nls.localizeByDefault('Replace'),
259
- msg: nls.localizeByDefault("A file or folder with the name '{0}' already exists in the destination folder. Do you want to replace it?", fileUri.path.base),
260
- ok: nls.localizeByDefault('Replace'),
261
- cancel: Dialog.CANCEL
262
- });
263
- return !!await dialog.open();
264
- }
265
-
266
- protected uploadFile(
267
- file: File,
268
- targetUri: URI,
269
- token: CancellationToken,
270
- leaveInTemp: boolean | undefined,
271
- onProgress: (total: number, done: number) => void
272
- ): {
273
- /**
274
- * Promise that resolves once the uploading is finished.
275
- *
276
- * Rejects on network error.
277
- * Rejects if status is not OK (200).
278
- * Rejects if cancelled.
279
- */
280
- upload: Promise<void>
281
- /**
282
- * Promise that resolves after the uploading step, once the server answers back.
283
- *
284
- * Rejects on network error.
285
- * Rejects if status is not OK (200).
286
- * Rejects if cancelled.
287
- */
288
- response: Promise<void>
289
- } {
290
- const data = new FormData();
291
- data.set('uri', targetUri.toString(true));
292
- data.set('file', file);
293
- if (leaveInTemp) {
294
- data.set('leaveInTemp', 'true');
295
- }
296
- // TODO: Use Fetch API once it supports upload monitoring.
297
- const xhr = new XMLHttpRequest();
298
- token.onCancellationRequested(() => xhr.abort());
299
- const upload = new Promise<void>((resolve, reject) => {
300
- this.registerEvents(xhr.upload, unregister => ({
301
- progress: (event: ProgressEvent<XMLHttpRequestEventTarget>) => {
302
- if (event.total === event.loaded) {
303
- unregister();
304
- resolve();
305
- } else {
306
- onProgress(event.total, event.loaded);
307
- }
308
- },
309
- abort: () => {
310
- unregister();
311
- reject(cancelled());
312
- },
313
- error: () => {
314
- unregister();
315
- reject(new Error('POST upload error'));
316
- },
317
- // `load` fires once the response is received, not when the upload is finished.
318
- // `resolve` should be called earlier within `progress` but this is a safety catch.
319
- load: () => {
320
- unregister();
321
- if (xhr.status === 200) {
322
- resolve();
323
- } else {
324
- reject(new Error(`POST request failed: ${xhr.status} ${xhr.statusText}`));
325
- }
326
- },
327
- }));
328
- });
329
- const response = new Promise<void>((resolve, reject) => {
330
- this.registerEvents(xhr, unregister => ({
331
- abort: () => {
332
- unregister();
333
- reject(cancelled());
334
- },
335
- error: () => {
336
- unregister();
337
- reject(new Error('POST request error'));
338
- },
339
- load: () => {
340
- unregister();
341
- if (xhr.status === 200) {
342
- resolve();
343
- } else {
344
- reject(new Error(`POST request failed: ${xhr.status} ${xhr.statusText}`));
345
- }
346
- }
347
- }));
348
- });
349
- xhr.open('POST', this.getUploadUrl(), /* async: */ true);
350
- xhr.send(data);
351
- return {
352
- upload,
353
- response
354
- };
355
- }
356
-
357
- /**
358
- * Utility function to attach events and get a callback to unregister those.
359
- *
360
- * You may not call `unregister` in the same tick as `register` is invoked.
361
- */
362
- protected registerEvents(
363
- target: EventTarget,
364
- register: (unregister: () => void) => Record<string, EventListenerOrEventListenerObject>
365
- ): void {
366
- const events = register(() => {
367
- for (const [event, fn] of Object.entries(events)) {
368
- target.removeEventListener(event, fn);
369
- }
370
- });
371
- for (const [event, fn] of Object.entries(events)) {
372
- target.addEventListener(event, fn);
373
- }
374
- }
375
-
376
- protected async withProgress<T>(
377
- cb: (progress: Progress, token: CancellationToken) => Promise<T>,
378
- { text }: FileUploadProgressParams = { text: nls.localize('theia/filesystem/uploadFiles', 'Uploading Files') }
379
- ): Promise<T> {
380
- const cancellationSource = new CancellationTokenSource();
381
- const { token } = cancellationSource;
382
- const progress = await this.messageService.showProgress(
383
- { text, options: { cancelable: true } },
384
- () => cancellationSource.cancel()
385
- );
386
- try {
387
- return await cb(progress, token);
388
- } finally {
389
- progress.cancel();
390
- }
391
- }
392
-
393
- protected async index(targetUri: URI, source: FileUploadService.Source, context: FileUploadService.Context): Promise<void> {
394
- if (source instanceof FormData) {
395
- await this.indexFormData(targetUri, source, context);
396
- } else if (source instanceof DataTransfer) {
397
- await this.indexDataTransfer(targetUri, source, context);
398
- } else {
399
- await this.indexCustomDataTransfer(targetUri, source, context);
400
- }
401
- }
402
-
403
- protected async indexFormData(targetUri: URI, formData: FormData, context: FileUploadService.Context): Promise<void> {
404
- for (const entry of formData.getAll(FileUploadService.UPLOAD)) {
405
- if (entry instanceof File) {
406
- await this.indexFile(targetUri, entry, context);
407
- }
408
- }
409
- }
410
-
411
- protected async indexDataTransfer(targetUri: URI, dataTransfer: DataTransfer, context: FileUploadService.Context): Promise<void> {
412
- checkCancelled(context.token);
413
- if (dataTransfer.items) {
414
- await this.indexDataTransferItemList(targetUri, dataTransfer.items, context);
415
- } else {
416
- await this.indexFileList(targetUri, dataTransfer.files, context);
417
- }
418
- }
419
-
420
- protected async indexCustomDataTransfer(targetUri: URI, dataTransfer: CustomDataTransfer, context: FileUploadService.Context): Promise<void> {
421
- for (const [_, item] of dataTransfer) {
422
- const fileInfo = item.asFile();
423
- if (fileInfo) {
424
- await this.indexFile(targetUri, new File([await fileInfo.data()], fileInfo.id), context);
425
- }
426
- }
427
- }
428
-
429
- protected async indexFileList(targetUri: URI, files: FileList, context: FileUploadService.Context): Promise<void> {
430
- for (let i = 0; i < files.length; i++) {
431
- const file = files[i];
432
- if (file) {
433
- await this.indexFile(targetUri, file, context);
434
- }
435
- }
436
- }
437
-
438
- protected async indexFile(targetUri: URI, file: File, context: FileUploadService.Context): Promise<void> {
439
- await context.accept({
440
- uri: targetUri.resolve(file.name),
441
- file
442
- });
443
- }
444
-
445
- protected async indexDataTransferItemList(targetUri: URI, items: DataTransferItemList, context: FileUploadService.Context): Promise<void> {
446
- checkCancelled(context.token);
447
- const entries: WebKitEntry[] = [];
448
- for (let i = 0; i < items.length; i++) {
449
- const entry = items[i].webkitGetAsEntry() as WebKitEntry;
450
- entries.push(entry);
451
- }
452
- await this.indexEntries(targetUri, entries, context);
453
-
454
- }
455
-
456
- protected async indexEntry(targetUri: URI, entry: WebKitEntry | null, context: FileUploadService.Context): Promise<void> {
457
- checkCancelled(context.token);
458
- if (!entry) {
459
- return;
460
- }
461
- if (entry.isDirectory) {
462
- await this.indexDirectoryEntry(targetUri, entry as WebKitDirectoryEntry, context);
463
- } else {
464
- await this.indexFileEntry(targetUri, entry as WebKitFileEntry, context);
465
- }
466
- }
467
-
468
- /**
469
- * Read all entries within a folder by block of 100 files or folders until the
470
- * whole folder has been read.
471
- */
472
- protected async indexDirectoryEntry(targetUri: URI, entry: WebKitDirectoryEntry, context: FileUploadService.Context): Promise<void> {
473
- checkCancelled(context.token);
474
- const newTargetUri = targetUri.resolve(entry.name);
475
- return new Promise<void>(async (resolve, reject) => {
476
- const reader = entry.createReader();
477
- const getEntries = () => reader.readEntries(async results => {
478
- try {
479
- if (!context.token.isCancellationRequested && results && results.length) {
480
- await this.indexEntries(newTargetUri, results, context);
481
- getEntries(); // loop to read all getEntries
482
- } else {
483
- resolve();
484
- }
485
- } catch (e) {
486
- reject(e);
487
- }
488
- }, reject);
489
- getEntries();
490
- });
491
- }
492
-
493
- protected async indexEntries(targetUri: URI, entries: WebKitEntry[], context: FileUploadService.Context): Promise<void> {
494
- checkCancelled(context.token);
495
- for (let i = 0; i < entries.length; i++) {
496
- await this.indexEntry(targetUri, entries[i], context);
497
- }
498
- }
499
-
500
- protected async indexFileEntry(targetUri: URI, entry: WebKitFileEntry, context: FileUploadService.Context): Promise<void> {
501
- await new Promise<void>((resolve, reject) => {
502
- try {
503
- entry.file(
504
- file => this.indexFile(targetUri, file, context).then(resolve, reject),
505
- reject,
506
- );
507
- } catch (e) {
508
- reject(e);
509
- }
510
- });
511
- }
512
-
513
- }
514
-
515
- export namespace FileUploadService {
516
- export type Source = FormData | DataTransfer | CustomDataTransfer;
517
- export interface UploadEntry {
518
- file: File
519
- uri: URI
520
- }
521
- export interface Context {
522
- progress: Progress
523
- token: CancellationToken
524
- accept: (entry: UploadEntry) => Promise<void>
525
- }
526
- export interface Form {
527
- targetInput: HTMLInputElement
528
- fileInput: HTMLInputElement
529
- progress?: FileUploadProgressParams
530
- onDidUpload?: (uri: string) => void
531
- }
532
- export interface UploadParams {
533
- source: FileUploadService.Source,
534
- progress: Progress,
535
- token: CancellationToken,
536
- onDidUpload?: (uri: string) => void,
537
- leaveInTemp?: boolean
538
- }
539
- }
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-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ /* eslint-disable @typescript-eslint/no-explicit-any */
18
+
19
+ import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
20
+ import URI from '@theia/core/lib/common/uri';
21
+ import { CancellationTokenSource, CancellationToken, checkCancelled, cancelled, isCancelled } from '@theia/core/lib/common/cancellation';
22
+ import { Deferred } from '@theia/core/lib/common/promise-util';
23
+ import { MessageService } from '@theia/core/lib/common/message-service';
24
+ import { Progress } from '@theia/core/lib/common/message-service-protocol';
25
+ import { Endpoint } from '@theia/core/lib/browser/endpoint';
26
+ import throttle = require('@theia/core/shared/lodash.throttle');
27
+ import { HTTP_FILE_UPLOAD_PATH } from '../common/file-upload';
28
+ import { Semaphore } from 'async-mutex';
29
+ import { FileSystemPreferences } from './filesystem-preferences';
30
+ import { FileService } from './file-service';
31
+ import { ConfirmDialog, Dialog } from '@theia/core/lib/browser';
32
+ import { nls } from '@theia/core/lib/common/nls';
33
+
34
+ export const HTTP_UPLOAD_URL: string = new Endpoint({ path: HTTP_FILE_UPLOAD_PATH }).getRestUrl().toString(true);
35
+
36
+ export type CustomDataTransfer = Iterable<readonly [string, CustomDataTransferItem]>;
37
+
38
+ export interface CustomDataTransferItem {
39
+ asFile(): {
40
+ readonly id: string;
41
+ readonly name: string;
42
+ data(): Promise<Uint8Array>;
43
+ } | undefined
44
+ }
45
+ export interface FileUploadParams {
46
+ source?: DataTransfer | CustomDataTransfer
47
+ progress?: FileUploadProgressParams
48
+ onDidUpload?: (uri: string) => void;
49
+ leaveInTemp?: boolean // dont move file out of the initial tmp directory
50
+ }
51
+ export interface FileUploadProgressParams {
52
+ text: string
53
+ }
54
+
55
+ export interface FileUploadResult {
56
+ uploaded: string[]
57
+ }
58
+
59
+ @injectable()
60
+ export class FileUploadService {
61
+
62
+ static TARGET = 'target';
63
+ static UPLOAD = 'upload';
64
+
65
+ protected uploadForm: FileUploadService.Form;
66
+ protected deferredUpload?: Deferred<FileUploadResult>;
67
+
68
+ @inject(MessageService)
69
+ protected readonly messageService: MessageService;
70
+
71
+ @inject(FileSystemPreferences)
72
+ protected fileSystemPreferences: FileSystemPreferences;
73
+
74
+ @inject(FileService)
75
+ protected fileService: FileService;
76
+
77
+ get maxConcurrentUploads(): number {
78
+ const maxConcurrentUploads = this.fileSystemPreferences['files.maxConcurrentUploads'];
79
+ return maxConcurrentUploads > 0 ? maxConcurrentUploads : Infinity;
80
+ }
81
+
82
+ @postConstruct()
83
+ protected init(): void {
84
+ this.uploadForm = this.createUploadForm();
85
+ }
86
+
87
+ protected createUploadForm(): FileUploadService.Form {
88
+ const targetInput = document.createElement('input');
89
+ targetInput.type = 'text';
90
+ targetInput.spellcheck = false;
91
+ targetInput.name = FileUploadService.TARGET;
92
+ targetInput.classList.add('theia-input');
93
+
94
+ const fileInput = document.createElement('input');
95
+ fileInput.type = 'file';
96
+ fileInput.classList.add('theia-input');
97
+ fileInput.name = FileUploadService.UPLOAD;
98
+ fileInput.multiple = true;
99
+
100
+ const form = document.createElement('form');
101
+ form.style.display = 'none';
102
+ form.enctype = 'multipart/form-data';
103
+ form.append(targetInput);
104
+ form.append(fileInput);
105
+
106
+ document.body.appendChild(form);
107
+
108
+ fileInput.addEventListener('change', () => {
109
+ if (this.deferredUpload && fileInput.value) {
110
+ const source: FileUploadService.Source = new FormData(form);
111
+ // clean up to allow upload to the same folder twice
112
+ fileInput.value = '';
113
+ const targetUri = new URI(<string>source.get(FileUploadService.TARGET));
114
+ const { resolve, reject } = this.deferredUpload;
115
+ this.deferredUpload = undefined;
116
+ const { onDidUpload } = this.uploadForm;
117
+ this.withProgress(
118
+ (progress, token) => this.uploadAll(targetUri, { source, progress, token, onDidUpload }),
119
+ this.uploadForm.progress
120
+ ).then(resolve, reject);
121
+ }
122
+ });
123
+ return { targetInput, fileInput };
124
+ }
125
+
126
+ async upload(targetUri: string | URI, params: FileUploadParams = {}): Promise<FileUploadResult> {
127
+ const { source, onDidUpload, leaveInTemp } = params;
128
+ if (source) {
129
+ return this.withProgress(
130
+ (progress, token) => this.uploadAll(
131
+ typeof targetUri === 'string' ? new URI(targetUri) : targetUri,
132
+ { source, progress, token, leaveInTemp, onDidUpload }
133
+ ),
134
+ params.progress,
135
+ );
136
+ }
137
+ this.deferredUpload = new Deferred<FileUploadResult>();
138
+ this.uploadForm.targetInput.value = String(targetUri);
139
+ this.uploadForm.fileInput.click();
140
+ this.uploadForm.progress = params.progress;
141
+ this.uploadForm.onDidUpload = params.onDidUpload;
142
+ return this.deferredUpload.promise;
143
+ }
144
+
145
+ protected getUploadUrl(): string {
146
+ return HTTP_UPLOAD_URL;
147
+ }
148
+
149
+ protected async uploadAll(targetUri: URI, params: FileUploadService.UploadParams): Promise<FileUploadResult> {
150
+ const responses: Promise<void>[] = [];
151
+ const status = new Map<File, {
152
+ total: number
153
+ done: number
154
+ uploaded?: boolean
155
+ }>();
156
+ const result: FileUploadResult = {
157
+ uploaded: []
158
+ };
159
+ /**
160
+ * When `false`: display the uploading progress.
161
+ * When `true`: display the server-processing progress.
162
+ */
163
+ let waitingForResponses = false;
164
+ const report = throttle(() => {
165
+ if (waitingForResponses) {
166
+ /** Number of files being processed. */
167
+ const total = status.size;
168
+ /** Number of files uploaded and processed. */
169
+ let done = 0;
170
+ for (const item of status.values()) {
171
+ if (item.uploaded) {
172
+ done += 1;
173
+ }
174
+ }
175
+ params.progress.report({
176
+ message: nls.localize('theia/filesystem/processedOutOf', 'Processed {0} out of {1}', done, total),
177
+ work: { total, done }
178
+ });
179
+ } else {
180
+ /** Total number of bytes being uploaded. */
181
+ let total = 0;
182
+ /** Current number of bytes uploaded. */
183
+ let done = 0;
184
+ for (const item of status.values()) {
185
+ total += item.total;
186
+ done += item.done;
187
+ }
188
+ params.progress.report({
189
+ message: nls.localize('theia/filesystem/uploadedOutOf', 'Uploaded {0} out of {1}', result.uploaded.length, status.size),
190
+ work: { total, done }
191
+ });
192
+ }
193
+ }, 100);
194
+ const uploads: Promise<void>[] = [];
195
+ const uploadSemaphore = new Semaphore(this.maxConcurrentUploads);
196
+ try {
197
+ await this.index(targetUri, params.source, {
198
+ token: params.token,
199
+ progress: params.progress,
200
+ accept: async item => {
201
+ if (await this.fileService.exists(item.uri) && !await this.confirmOverwrite(item.uri)) {
202
+ return;
203
+ }
204
+ // Track and initialize the file in the status map:
205
+ status.set(item.file, { total: item.file.size, done: 0 });
206
+ report();
207
+ // Don't await here: the semaphore will organize the uploading tasks, not the async indexer.
208
+ uploads.push(uploadSemaphore.runExclusive(async () => {
209
+ checkCancelled(params.token);
210
+ const { upload, response } = this.uploadFile(item.file, item.uri, params.token, params.leaveInTemp, (total, done) => {
211
+ const entry = status.get(item.file);
212
+ if (entry) {
213
+ entry.total = total;
214
+ entry.done = done;
215
+ report();
216
+ }
217
+ });
218
+ function onError(error: Error): void {
219
+ status.delete(item.file);
220
+ throw error;
221
+ }
222
+ responses.push(response
223
+ .then(() => {
224
+ checkCancelled(params.token);
225
+ // Consider the file uploaded once the server sends OK back.
226
+ result.uploaded.push(item.uri.toString(true));
227
+ const entry = status.get(item.file);
228
+ if (entry) {
229
+ entry.uploaded = true;
230
+ report();
231
+ }
232
+ })
233
+ .catch(onError)
234
+ );
235
+ // Have the queue wait for the upload only.
236
+ return upload
237
+ .catch(onError);
238
+ }));
239
+ }
240
+ });
241
+ checkCancelled(params.token);
242
+ await Promise.all(uploads);
243
+ checkCancelled(params.token);
244
+ waitingForResponses = true;
245
+ report();
246
+ await Promise.all(responses);
247
+ } catch (error) {
248
+ uploadSemaphore.cancel();
249
+ if (!isCancelled(error)) {
250
+ throw error;
251
+ }
252
+ }
253
+ return result;
254
+ }
255
+
256
+ protected async confirmOverwrite(fileUri: URI): Promise<boolean> {
257
+ const dialog = new ConfirmDialog({
258
+ title: nls.localizeByDefault('Replace'),
259
+ msg: nls.localizeByDefault("A file or folder with the name '{0}' already exists in the destination folder. Do you want to replace it?", fileUri.path.base),
260
+ ok: nls.localizeByDefault('Replace'),
261
+ cancel: Dialog.CANCEL
262
+ });
263
+ return !!await dialog.open();
264
+ }
265
+
266
+ protected uploadFile(
267
+ file: File,
268
+ targetUri: URI,
269
+ token: CancellationToken,
270
+ leaveInTemp: boolean | undefined,
271
+ onProgress: (total: number, done: number) => void
272
+ ): {
273
+ /**
274
+ * Promise that resolves once the uploading is finished.
275
+ *
276
+ * Rejects on network error.
277
+ * Rejects if status is not OK (200).
278
+ * Rejects if cancelled.
279
+ */
280
+ upload: Promise<void>
281
+ /**
282
+ * Promise that resolves after the uploading step, once the server answers back.
283
+ *
284
+ * Rejects on network error.
285
+ * Rejects if status is not OK (200).
286
+ * Rejects if cancelled.
287
+ */
288
+ response: Promise<void>
289
+ } {
290
+ const data = new FormData();
291
+ data.set('uri', targetUri.toString(true));
292
+ data.set('file', file);
293
+ if (leaveInTemp) {
294
+ data.set('leaveInTemp', 'true');
295
+ }
296
+ // TODO: Use Fetch API once it supports upload monitoring.
297
+ const xhr = new XMLHttpRequest();
298
+ token.onCancellationRequested(() => xhr.abort());
299
+ const upload = new Promise<void>((resolve, reject) => {
300
+ this.registerEvents(xhr.upload, unregister => ({
301
+ progress: (event: ProgressEvent<XMLHttpRequestEventTarget>) => {
302
+ if (event.total === event.loaded) {
303
+ unregister();
304
+ resolve();
305
+ } else {
306
+ onProgress(event.total, event.loaded);
307
+ }
308
+ },
309
+ abort: () => {
310
+ unregister();
311
+ reject(cancelled());
312
+ },
313
+ error: () => {
314
+ unregister();
315
+ reject(new Error('POST upload error'));
316
+ },
317
+ // `load` fires once the response is received, not when the upload is finished.
318
+ // `resolve` should be called earlier within `progress` but this is a safety catch.
319
+ load: () => {
320
+ unregister();
321
+ if (xhr.status === 200) {
322
+ resolve();
323
+ } else {
324
+ reject(new Error(`POST request failed: ${xhr.status} ${xhr.statusText}`));
325
+ }
326
+ },
327
+ }));
328
+ });
329
+ const response = new Promise<void>((resolve, reject) => {
330
+ this.registerEvents(xhr, unregister => ({
331
+ abort: () => {
332
+ unregister();
333
+ reject(cancelled());
334
+ },
335
+ error: () => {
336
+ unregister();
337
+ reject(new Error('POST request error'));
338
+ },
339
+ load: () => {
340
+ unregister();
341
+ if (xhr.status === 200) {
342
+ resolve();
343
+ } else {
344
+ reject(new Error(`POST request failed: ${xhr.status} ${xhr.statusText}`));
345
+ }
346
+ }
347
+ }));
348
+ });
349
+ xhr.open('POST', this.getUploadUrl(), /* async: */ true);
350
+ xhr.send(data);
351
+ return {
352
+ upload,
353
+ response
354
+ };
355
+ }
356
+
357
+ /**
358
+ * Utility function to attach events and get a callback to unregister those.
359
+ *
360
+ * You may not call `unregister` in the same tick as `register` is invoked.
361
+ */
362
+ protected registerEvents(
363
+ target: EventTarget,
364
+ register: (unregister: () => void) => Record<string, EventListenerOrEventListenerObject>
365
+ ): void {
366
+ const events = register(() => {
367
+ for (const [event, fn] of Object.entries(events)) {
368
+ target.removeEventListener(event, fn);
369
+ }
370
+ });
371
+ for (const [event, fn] of Object.entries(events)) {
372
+ target.addEventListener(event, fn);
373
+ }
374
+ }
375
+
376
+ protected async withProgress<T>(
377
+ cb: (progress: Progress, token: CancellationToken) => Promise<T>,
378
+ { text }: FileUploadProgressParams = { text: nls.localize('theia/filesystem/uploadFiles', 'Uploading Files') }
379
+ ): Promise<T> {
380
+ const cancellationSource = new CancellationTokenSource();
381
+ const { token } = cancellationSource;
382
+ const progress = await this.messageService.showProgress(
383
+ { text, options: { cancelable: true } },
384
+ () => cancellationSource.cancel()
385
+ );
386
+ try {
387
+ return await cb(progress, token);
388
+ } finally {
389
+ progress.cancel();
390
+ }
391
+ }
392
+
393
+ protected async index(targetUri: URI, source: FileUploadService.Source, context: FileUploadService.Context): Promise<void> {
394
+ if (source instanceof FormData) {
395
+ await this.indexFormData(targetUri, source, context);
396
+ } else if (source instanceof DataTransfer) {
397
+ await this.indexDataTransfer(targetUri, source, context);
398
+ } else {
399
+ await this.indexCustomDataTransfer(targetUri, source, context);
400
+ }
401
+ }
402
+
403
+ protected async indexFormData(targetUri: URI, formData: FormData, context: FileUploadService.Context): Promise<void> {
404
+ for (const entry of formData.getAll(FileUploadService.UPLOAD)) {
405
+ if (entry instanceof File) {
406
+ await this.indexFile(targetUri, entry, context);
407
+ }
408
+ }
409
+ }
410
+
411
+ protected async indexDataTransfer(targetUri: URI, dataTransfer: DataTransfer, context: FileUploadService.Context): Promise<void> {
412
+ checkCancelled(context.token);
413
+ if (dataTransfer.items) {
414
+ await this.indexDataTransferItemList(targetUri, dataTransfer.items, context);
415
+ } else {
416
+ await this.indexFileList(targetUri, dataTransfer.files, context);
417
+ }
418
+ }
419
+
420
+ protected async indexCustomDataTransfer(targetUri: URI, dataTransfer: CustomDataTransfer, context: FileUploadService.Context): Promise<void> {
421
+ for (const [_, item] of dataTransfer) {
422
+ const fileInfo = item.asFile();
423
+ if (fileInfo) {
424
+ await this.indexFile(targetUri, new File([await fileInfo.data()], fileInfo.id), context);
425
+ }
426
+ }
427
+ }
428
+
429
+ protected async indexFileList(targetUri: URI, files: FileList, context: FileUploadService.Context): Promise<void> {
430
+ for (let i = 0; i < files.length; i++) {
431
+ const file = files[i];
432
+ if (file) {
433
+ await this.indexFile(targetUri, file, context);
434
+ }
435
+ }
436
+ }
437
+
438
+ protected async indexFile(targetUri: URI, file: File, context: FileUploadService.Context): Promise<void> {
439
+ await context.accept({
440
+ uri: targetUri.resolve(file.name),
441
+ file
442
+ });
443
+ }
444
+
445
+ protected async indexDataTransferItemList(targetUri: URI, items: DataTransferItemList, context: FileUploadService.Context): Promise<void> {
446
+ checkCancelled(context.token);
447
+ const entries: WebKitEntry[] = [];
448
+ for (let i = 0; i < items.length; i++) {
449
+ const entry = items[i].webkitGetAsEntry() as WebKitEntry;
450
+ entries.push(entry);
451
+ }
452
+ await this.indexEntries(targetUri, entries, context);
453
+
454
+ }
455
+
456
+ protected async indexEntry(targetUri: URI, entry: WebKitEntry | null, context: FileUploadService.Context): Promise<void> {
457
+ checkCancelled(context.token);
458
+ if (!entry) {
459
+ return;
460
+ }
461
+ if (entry.isDirectory) {
462
+ await this.indexDirectoryEntry(targetUri, entry as WebKitDirectoryEntry, context);
463
+ } else {
464
+ await this.indexFileEntry(targetUri, entry as WebKitFileEntry, context);
465
+ }
466
+ }
467
+
468
+ /**
469
+ * Read all entries within a folder by block of 100 files or folders until the
470
+ * whole folder has been read.
471
+ */
472
+ protected async indexDirectoryEntry(targetUri: URI, entry: WebKitDirectoryEntry, context: FileUploadService.Context): Promise<void> {
473
+ checkCancelled(context.token);
474
+ const newTargetUri = targetUri.resolve(entry.name);
475
+ return new Promise<void>(async (resolve, reject) => {
476
+ const reader = entry.createReader();
477
+ const getEntries = () => reader.readEntries(async results => {
478
+ try {
479
+ if (!context.token.isCancellationRequested && results && results.length) {
480
+ await this.indexEntries(newTargetUri, results, context);
481
+ getEntries(); // loop to read all getEntries
482
+ } else {
483
+ resolve();
484
+ }
485
+ } catch (e) {
486
+ reject(e);
487
+ }
488
+ }, reject);
489
+ getEntries();
490
+ });
491
+ }
492
+
493
+ protected async indexEntries(targetUri: URI, entries: WebKitEntry[], context: FileUploadService.Context): Promise<void> {
494
+ checkCancelled(context.token);
495
+ for (let i = 0; i < entries.length; i++) {
496
+ await this.indexEntry(targetUri, entries[i], context);
497
+ }
498
+ }
499
+
500
+ protected async indexFileEntry(targetUri: URI, entry: WebKitFileEntry, context: FileUploadService.Context): Promise<void> {
501
+ await new Promise<void>((resolve, reject) => {
502
+ try {
503
+ entry.file(
504
+ file => this.indexFile(targetUri, file, context).then(resolve, reject),
505
+ reject,
506
+ );
507
+ } catch (e) {
508
+ reject(e);
509
+ }
510
+ });
511
+ }
512
+
513
+ }
514
+
515
+ export namespace FileUploadService {
516
+ export type Source = FormData | DataTransfer | CustomDataTransfer;
517
+ export interface UploadEntry {
518
+ file: File
519
+ uri: URI
520
+ }
521
+ export interface Context {
522
+ progress: Progress
523
+ token: CancellationToken
524
+ accept: (entry: UploadEntry) => Promise<void>
525
+ }
526
+ export interface Form {
527
+ targetInput: HTMLInputElement
528
+ fileInput: HTMLInputElement
529
+ progress?: FileUploadProgressParams
530
+ onDidUpload?: (uri: string) => void
531
+ }
532
+ export interface UploadParams {
533
+ source: FileUploadService.Source,
534
+ progress: Progress,
535
+ token: CancellationToken,
536
+ onDidUpload?: (uri: string) => void,
537
+ leaveInTemp?: boolean
538
+ }
539
+ }