@theia/filesystem 1.45.1 → 1.46.0-next.72

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