@theia/filesystem 1.47.1 → 1.48.1

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 (249) 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.d.ts.map +1 -1
  40. package/lib/browser/file-service.js +1366 -1366
  41. package/lib/browser/file-service.js.map +1 -1
  42. package/lib/browser/file-tree/file-tree-container.d.ts +3 -3
  43. package/lib/browser/file-tree/file-tree-container.js +35 -35
  44. package/lib/browser/file-tree/file-tree-decorator-adapter.d.ts +30 -30
  45. package/lib/browser/file-tree/file-tree-decorator-adapter.js +169 -169
  46. package/lib/browser/file-tree/file-tree-label-provider.d.ts +12 -12
  47. package/lib/browser/file-tree/file-tree-label-provider.js +54 -54
  48. package/lib/browser/file-tree/file-tree-model.d.ts +37 -37
  49. package/lib/browser/file-tree/file-tree-model.js +217 -217
  50. package/lib/browser/file-tree/file-tree-widget.d.ts +44 -44
  51. package/lib/browser/file-tree/file-tree-widget.js +317 -317
  52. package/lib/browser/file-tree/file-tree.d.ts +46 -46
  53. package/lib/browser/file-tree/file-tree.js +176 -176
  54. package/lib/browser/file-tree/index.d.ts +6 -6
  55. package/lib/browser/file-tree/index.js +24 -24
  56. package/lib/browser/file-upload-service.d.ts +109 -109
  57. package/lib/browser/file-upload-service.js +434 -434
  58. package/lib/browser/filesystem-frontend-contribution.d.ts +74 -63
  59. package/lib/browser/filesystem-frontend-contribution.d.ts.map +1 -1
  60. package/lib/browser/filesystem-frontend-contribution.js +356 -319
  61. package/lib/browser/filesystem-frontend-contribution.js.map +1 -1
  62. package/lib/browser/filesystem-frontend-module.d.ts +5 -5
  63. package/lib/browser/filesystem-frontend-module.js +64 -64
  64. package/lib/browser/filesystem-preferences.d.ts +29 -29
  65. package/lib/browser/filesystem-preferences.js +110 -110
  66. package/lib/browser/filesystem-save-resource-service.d.ts +29 -29
  67. package/lib/browser/filesystem-save-resource-service.js +135 -135
  68. package/lib/browser/filesystem-watcher-error-handler.d.ts +10 -10
  69. package/lib/browser/filesystem-watcher-error-handler.js +61 -61
  70. package/lib/browser/index.d.ts +5 -5
  71. package/lib/browser/index.js +23 -23
  72. package/lib/browser/location/index.d.ts +2 -2
  73. package/lib/browser/location/index.js +20 -20
  74. package/lib/browser/location/location-renderer.d.ts +100 -100
  75. package/lib/browser/location/location-renderer.js +343 -343
  76. package/lib/browser/location/location-service.d.ts +5 -5
  77. package/lib/browser/location/location-service.js +17 -17
  78. package/lib/browser/remote-file-service-contribution.d.ts +6 -6
  79. package/lib/browser/remote-file-service-contribution.js +39 -39
  80. package/lib/browser-only/browser-only-filesystem-frontend-module.d.ts +3 -3
  81. package/lib/browser-only/browser-only-filesystem-frontend-module.js +40 -40
  82. package/lib/browser-only/browser-only-filesystem-provider-server.d.ts +11 -11
  83. package/lib/browser-only/browser-only-filesystem-provider-server.js +39 -39
  84. package/lib/browser-only/browserfs-filesystem-initialization.d.ts +12 -12
  85. package/lib/browser-only/browserfs-filesystem-initialization.js +54 -54
  86. package/lib/browser-only/browserfs-filesystem-provider.d.ts +45 -45
  87. package/lib/browser-only/browserfs-filesystem-provider.js +439 -439
  88. package/lib/common/delegating-file-system-provider.d.ts +76 -76
  89. package/lib/common/delegating-file-system-provider.js +168 -168
  90. package/lib/common/download/file-download-data.d.ts +6 -6
  91. package/lib/common/download/file-download-data.js +26 -26
  92. package/lib/common/file-upload.d.ts +1 -1
  93. package/lib/common/file-upload.js +19 -19
  94. package/lib/common/files.d.ts +659 -659
  95. package/lib/common/files.js +355 -355
  96. package/lib/common/files.spec.d.ts +1 -1
  97. package/lib/common/files.spec.js +51 -51
  98. package/lib/common/filesystem-utils.d.ts +14 -14
  99. package/lib/common/filesystem-utils.js +63 -63
  100. package/lib/common/filesystem-utils.spec.d.ts +1 -1
  101. package/lib/common/filesystem-utils.spec.js +378 -378
  102. package/lib/common/filesystem-watcher-protocol.d.ts +71 -71
  103. package/lib/common/filesystem-watcher-protocol.js +20 -20
  104. package/lib/common/filesystem.d.ts +22 -22
  105. package/lib/common/filesystem.js +42 -42
  106. package/lib/common/index.d.ts +2 -2
  107. package/lib/common/index.js +20 -20
  108. package/lib/common/io.d.ts +19 -19
  109. package/lib/common/io.js +110 -110
  110. package/lib/common/remote-file-system-provider.d.ts +173 -173
  111. package/lib/common/remote-file-system-provider.js +435 -435
  112. package/lib/electron-browser/file-dialog/electron-file-dialog-module.d.ts +3 -3
  113. package/lib/electron-browser/file-dialog/electron-file-dialog-module.js +24 -24
  114. package/lib/electron-browser/file-dialog/electron-file-dialog-service.d.ts +19 -19
  115. package/lib/electron-browser/file-dialog/electron-file-dialog-service.js +148 -148
  116. package/lib/electron-browser/preload.d.ts +1 -1
  117. package/lib/electron-browser/preload.js +30 -30
  118. package/lib/electron-common/electron-api.d.ts +34 -34
  119. package/lib/electron-common/electron-api.js +20 -20
  120. package/lib/electron-main/electron-api-main.d.ts +5 -5
  121. package/lib/electron-main/electron-api-main.js +73 -73
  122. package/lib/electron-main/electron-main-module.d.ts +3 -3
  123. package/lib/electron-main/electron-main-module.js +24 -24
  124. package/lib/node/disk-file-system-provider.d.ts +72 -72
  125. package/lib/node/disk-file-system-provider.js +787 -787
  126. package/lib/node/disk-file-system-provider.spec.d.ts +1 -1
  127. package/lib/node/disk-file-system-provider.spec.js +122 -122
  128. package/lib/node/download/directory-archiver.d.ts +9 -9
  129. package/lib/node/download/directory-archiver.js +127 -127
  130. package/lib/node/download/directory-archiver.spec.d.ts +1 -1
  131. package/lib/node/download/directory-archiver.spec.js +97 -97
  132. package/lib/node/download/file-download-backend-module.d.ts +3 -3
  133. package/lib/node/download/file-download-backend-module.js +32 -32
  134. package/lib/node/download/file-download-cache.d.ts +21 -21
  135. package/lib/node/download/file-download-cache.js +82 -82
  136. package/lib/node/download/file-download-endpoint.d.ts +11 -11
  137. package/lib/node/download/file-download-endpoint.js +67 -67
  138. package/lib/node/download/file-download-handler.d.ts +50 -50
  139. package/lib/node/download/file-download-handler.js +307 -307
  140. package/lib/node/download/test/mock-directory-archiver.d.ts +7 -7
  141. package/lib/node/download/test/mock-directory-archiver.js +29 -29
  142. package/lib/node/file-change-collection.d.ts +22 -22
  143. package/lib/node/file-change-collection.js +77 -77
  144. package/lib/node/file-change-collection.spec.d.ts +1 -1
  145. package/lib/node/file-change-collection.spec.js +90 -90
  146. package/lib/node/filesystem-backend-module.d.ts +26 -26
  147. package/lib/node/filesystem-backend-module.js +120 -120
  148. package/lib/node/filesystem-watcher-client.d.ts +23 -23
  149. package/lib/node/filesystem-watcher-client.js +75 -75
  150. package/lib/node/filesystem-watcher-dispatcher.d.ts +23 -23
  151. package/lib/node/filesystem-watcher-dispatcher.js +80 -80
  152. package/lib/node/node-file-upload-service.d.ts +16 -16
  153. package/lib/node/node-file-upload-service.js +79 -79
  154. package/lib/node/nsfw-watcher/index.d.ts +3 -3
  155. package/lib/node/nsfw-watcher/index.js +39 -39
  156. package/lib/node/nsfw-watcher/nsfw-filesystem-service.d.ts +191 -191
  157. package/lib/node/nsfw-watcher/nsfw-filesystem-service.js +405 -405
  158. package/lib/node/nsfw-watcher/nsfw-filesystem-watcher.spec.d.ts +1 -1
  159. package/lib/node/nsfw-watcher/nsfw-filesystem-watcher.spec.js +151 -151
  160. package/lib/node/nsfw-watcher/nsfw-options.d.ts +6 -6
  161. package/lib/node/nsfw-watcher/nsfw-options.js +22 -22
  162. package/package.json +4 -4
  163. package/src/browser/breadcrumbs/filepath-breadcrumb.ts +43 -43
  164. package/src/browser/breadcrumbs/filepath-breadcrumbs-container.ts +65 -65
  165. package/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts +129 -129
  166. package/src/browser/download/file-download-command-contribution.ts +83 -83
  167. package/src/browser/download/file-download-frontend-module.ts +25 -25
  168. package/src/browser/download/file-download-service.ts +179 -179
  169. package/src/browser/file-dialog/file-dialog-container.ts +67 -67
  170. package/src/browser/file-dialog/file-dialog-hidden-files-renderer.tsx +59 -59
  171. package/src/browser/file-dialog/file-dialog-model.ts +96 -96
  172. package/src/browser/file-dialog/file-dialog-module.ts +44 -44
  173. package/src/browser/file-dialog/file-dialog-service.ts +99 -99
  174. package/src/browser/file-dialog/file-dialog-tree-filters-renderer.tsx +100 -100
  175. package/src/browser/file-dialog/file-dialog-tree.ts +89 -89
  176. package/src/browser/file-dialog/file-dialog-widget.ts +75 -75
  177. package/src/browser/file-dialog/file-dialog.ts +434 -434
  178. package/src/browser/file-dialog/index.ts +20 -20
  179. package/src/browser/file-resource.ts +390 -390
  180. package/src/browser/file-selection.ts +44 -44
  181. package/src/browser/file-service.ts +1841 -1841
  182. package/src/browser/file-tree/file-tree-container.ts +36 -36
  183. package/src/browser/file-tree/file-tree-decorator-adapter.ts +159 -159
  184. package/src/browser/file-tree/file-tree-label-provider.ts +53 -53
  185. package/src/browser/file-tree/file-tree-model.ts +212 -212
  186. package/src/browser/file-tree/file-tree-widget.tsx +327 -327
  187. package/src/browser/file-tree/file-tree.ts +183 -183
  188. package/src/browser/file-tree/index.ts +22 -22
  189. package/src/browser/file-upload-service.ts +539 -539
  190. package/src/browser/filesystem-frontend-contribution.ts +381 -338
  191. package/src/browser/filesystem-frontend-module.ts +77 -77
  192. package/src/browser/filesystem-preferences.ts +139 -139
  193. package/src/browser/filesystem-save-resource-service.ts +125 -125
  194. package/src/browser/filesystem-watcher-error-handler.ts +60 -60
  195. package/src/browser/index.ts +21 -21
  196. package/src/browser/location/index.ts +18 -18
  197. package/src/browser/location/location-renderer.tsx +404 -404
  198. package/src/browser/location/location-service.ts +22 -22
  199. package/src/browser/remote-file-service-contribution.ts +38 -38
  200. package/src/browser/style/file-dialog.css +208 -208
  201. package/src/browser/style/file-icons.css +64 -64
  202. package/src/browser/style/filepath-breadcrumbs.css +20 -20
  203. package/src/browser/style/index.css +36 -36
  204. package/src/browser-only/browser-only-filesystem-frontend-module.ts +38 -38
  205. package/src/browser-only/browser-only-filesystem-provider-server.ts +32 -32
  206. package/src/browser-only/browserfs-filesystem-initialization.ts +61 -61
  207. package/src/browser-only/browserfs-filesystem-provider.ts +462 -462
  208. package/src/common/delegating-file-system-provider.ts +226 -226
  209. package/src/common/download/README.md +30 -30
  210. package/src/common/download/file-download-data.ts +27 -27
  211. package/src/common/file-upload.ts +17 -17
  212. package/src/common/files.spec.ts +51 -51
  213. package/src/common/files.ts +996 -996
  214. package/src/common/filesystem-utils.spec.ts +411 -411
  215. package/src/common/filesystem-utils.ts +64 -64
  216. package/src/common/filesystem-watcher-protocol.ts +96 -96
  217. package/src/common/filesystem.ts +43 -43
  218. package/src/common/index.ts +18 -18
  219. package/src/common/io.ts +150 -150
  220. package/src/common/remote-file-system-provider.ts +549 -549
  221. package/src/electron-browser/file-dialog/electron-file-dialog-module.ts +24 -24
  222. package/src/electron-browser/file-dialog/electron-file-dialog-service.ts +165 -165
  223. package/src/electron-browser/preload.ts +31 -31
  224. package/src/electron-common/electron-api.ts +55 -55
  225. package/src/electron-main/electron-api-main.ts +78 -78
  226. package/src/electron-main/electron-main-module.ts +23 -23
  227. package/src/node/disk-file-system-provider.spec.ts +142 -142
  228. package/src/node/disk-file-system-provider.ts +915 -915
  229. package/src/node/download/directory-archiver.spec.ts +104 -104
  230. package/src/node/download/directory-archiver.ts +126 -126
  231. package/src/node/download/file-download-backend-module.ts +32 -32
  232. package/src/node/download/file-download-cache.ts +88 -88
  233. package/src/node/download/file-download-endpoint.ts +63 -63
  234. package/src/node/download/file-download-handler.ts +304 -304
  235. package/src/node/download/test/mock-directory-archiver.ts +30 -30
  236. package/src/node/file-change-collection.spec.ts +110 -110
  237. package/src/node/file-change-collection.ts +78 -78
  238. package/src/node/filesystem-backend-module.ts +140 -140
  239. package/src/node/filesystem-watcher-client.ts +72 -72
  240. package/src/node/filesystem-watcher-dispatcher.ts +82 -82
  241. package/src/node/node-file-upload-service.ts +80 -80
  242. package/src/node/nsfw-watcher/index.ts +45 -45
  243. package/src/node/nsfw-watcher/nsfw-filesystem-service.ts +481 -481
  244. package/src/node/nsfw-watcher/nsfw-filesystem-watcher.spec.ts +182 -182
  245. package/src/node/nsfw-watcher/nsfw-options.ts +23 -23
  246. package/src/typings/dom.webkit.d.ts +77 -77
  247. package/src/typings/mv/index.d.ts +21 -21
  248. package/src/typings/nsfw/index.d.ts +18 -18
  249. package/src/typings/trash/index.d.ts +20 -20
@@ -1,304 +1,304 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2018 TypeFox and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import * as os from 'os';
18
- import * as fs from '@theia/core/shared/fs-extra';
19
- import * as path from 'path';
20
- import { generateUuid } from '@theia/core/lib/common/uuid';
21
- import { Request, Response } from '@theia/core/shared/express';
22
- import { inject, injectable } from '@theia/core/shared/inversify';
23
- import { OK, BAD_REQUEST, METHOD_NOT_ALLOWED, NOT_FOUND, INTERNAL_SERVER_ERROR, REQUESTED_RANGE_NOT_SATISFIABLE, PARTIAL_CONTENT } from 'http-status-codes';
24
- import URI from '@theia/core/lib/common/uri';
25
- import { isEmpty } from '@theia/core/lib/common/objects';
26
- import { ILogger } from '@theia/core/lib/common/logger';
27
- import { FileUri } from '@theia/core/lib/common/file-uri';
28
- import { DirectoryArchiver } from './directory-archiver';
29
- import { FileDownloadData } from '../../common/download/file-download-data';
30
- import { FileDownloadCache, DownloadStorageItem } from './file-download-cache';
31
-
32
- interface PrepareDownloadOptions {
33
- filePath: string;
34
- downloadId: string;
35
- remove: boolean;
36
- root?: string;
37
- }
38
-
39
- @injectable()
40
- export abstract class FileDownloadHandler {
41
-
42
- @inject(ILogger)
43
- protected readonly logger: ILogger;
44
-
45
- @inject(DirectoryArchiver)
46
- protected readonly directoryArchiver: DirectoryArchiver;
47
-
48
- @inject(FileDownloadCache)
49
- protected readonly fileDownloadCache: FileDownloadCache;
50
-
51
- public abstract handle(request: Request, response: Response): Promise<void>;
52
-
53
- /**
54
- * Prepares the file and the link for download
55
- */
56
- protected async prepareDownload(request: Request, response: Response, options: PrepareDownloadOptions): Promise<void> {
57
- const name = path.basename(options.filePath);
58
- try {
59
- await fs.access(options.filePath, fs.constants.R_OK);
60
- const stat = await fs.stat(options.filePath);
61
- this.fileDownloadCache.addDownload(options.downloadId, { file: options.filePath, remove: options.remove, size: stat.size, root: options.root });
62
- // do not send filePath but instead use the downloadId
63
- const data = { name, id: options.downloadId };
64
- response.status(OK).send(data).end();
65
- } catch (e) {
66
- this.handleError(response, e, INTERNAL_SERVER_ERROR);
67
- }
68
- }
69
-
70
- protected async download(request: Request, response: Response, downloadInfo: DownloadStorageItem, id: string): Promise<void> {
71
- const filePath = downloadInfo.file;
72
- const statSize = downloadInfo.size;
73
- // this sets the content-disposition and content-type automatically
74
- response.attachment(filePath);
75
- try {
76
- await fs.access(filePath, fs.constants.R_OK);
77
- response.setHeader('Accept-Ranges', 'bytes');
78
- // parse range header and combine multiple ranges
79
- const range = this.parseRangeHeader(request.headers['range'], statSize);
80
- if (!range) {
81
- response.setHeader('Content-Length', statSize);
82
- this.streamDownload(OK, response, fs.createReadStream(filePath), id);
83
- } else {
84
- const rangeStart = range.start;
85
- const rangeEnd = range.end;
86
- if (rangeStart >= statSize || rangeEnd >= statSize) {
87
- response.setHeader('Content-Range', `bytes */${statSize}`);
88
- // Return the 416 'Requested Range Not Satisfiable'.
89
- response.status(REQUESTED_RANGE_NOT_SATISFIABLE).end();
90
- return;
91
- }
92
- response.setHeader('Content-Range', `bytes ${rangeStart}-${rangeEnd}/${statSize}`);
93
- response.setHeader('Content-Length', rangeStart === rangeEnd ? 0 : (rangeEnd - rangeStart + 1));
94
- response.setHeader('Cache-Control', 'no-cache');
95
- this.streamDownload(PARTIAL_CONTENT, response, fs.createReadStream(filePath, { start: rangeStart, end: rangeEnd }), id);
96
- }
97
- } catch (e) {
98
- this.fileDownloadCache.deleteDownload(id);
99
- this.handleError(response, e, INTERNAL_SERVER_ERROR);
100
- }
101
- }
102
- /**
103
- * Streams the file and pipe it to the Response to avoid any OOM issues
104
- */
105
- protected streamDownload(status: number, response: Response, stream: fs.ReadStream, id: string): void {
106
- response.status(status);
107
- stream.on('error', error => {
108
- this.fileDownloadCache.deleteDownload(id);
109
- this.handleError(response, error, INTERNAL_SERVER_ERROR);
110
- });
111
- response.on('error', error => {
112
- this.fileDownloadCache.deleteDownload(id);
113
- this.handleError(response, error, INTERNAL_SERVER_ERROR);
114
- });
115
- response.on('close', () => {
116
- stream.destroy();
117
- });
118
- stream.pipe(response);
119
- }
120
- protected parseRangeHeader(range: string | string[] | undefined, statSize: number): { start: number, end: number } | undefined {
121
- if (!range || range.length === 0 || Array.isArray(range)) {
122
- return;
123
- }
124
- const index = range.indexOf('=');
125
- if (index === -1) {
126
- return;
127
- }
128
- const rangeType = range.slice(0, index);
129
- if (rangeType !== 'bytes') {
130
- return;
131
- }
132
- const [start, end] = range.slice(index + 1).split('-').map(r => parseInt(r, 10));
133
- return {
134
- start: isNaN(start) ? 0 : start,
135
- end: (isNaN(end) || end > statSize - 1) ? (statSize - 1) : end
136
- };
137
- }
138
- protected async archive(inputPath: string, outputPath: string = path.join(os.tmpdir(), generateUuid()), entries?: string[]): Promise<string> {
139
- await this.directoryArchiver.archive(inputPath, outputPath, entries);
140
- return outputPath;
141
- }
142
-
143
- protected async createTempDir(downloadId: string = generateUuid()): Promise<string> {
144
- const outputPath = path.join(os.tmpdir(), downloadId);
145
- await fs.mkdir(outputPath);
146
- return outputPath;
147
- }
148
-
149
- protected async handleError(response: Response, reason: string | Error, status: number = INTERNAL_SERVER_ERROR): Promise<void> {
150
- this.logger.error(reason);
151
- response.status(status).send('Unable to download file.').end();
152
- }
153
-
154
- }
155
-
156
- export namespace FileDownloadHandler {
157
- export const SINGLE: symbol = Symbol('single');
158
- export const MULTI: symbol = Symbol('multi');
159
- export const DOWNLOAD_LINK: symbol = Symbol('download');
160
- }
161
-
162
- @injectable()
163
- export class DownloadLinkHandler extends FileDownloadHandler {
164
-
165
- async handle(request: Request, response: Response): Promise<void> {
166
- const { method, query } = request;
167
- if (method !== 'GET' && method !== 'HEAD') {
168
- this.handleError(response, `Unexpected HTTP method. Expected GET got '${method}' instead.`, METHOD_NOT_ALLOWED);
169
- return;
170
- }
171
- if (query === undefined || query.id === undefined || typeof query.id !== 'string') {
172
- this.handleError(response, `Cannot access the 'id' query from the request. The query was: ${JSON.stringify(query)}.`, BAD_REQUEST);
173
- return;
174
- }
175
- const cancelDownload = query.cancel;
176
- const downloadInfo = this.fileDownloadCache.getDownload(query.id);
177
- if (!downloadInfo) {
178
- this.handleError(response, `Cannot find the file from the request. The query was: ${JSON.stringify(query)}.`, NOT_FOUND);
179
- return;
180
- }
181
- // allow head request to determine the content length for parallel downloaders
182
- if (method === 'HEAD') {
183
- response.setHeader('Content-Length', downloadInfo.size);
184
- response.status(OK).end();
185
- return;
186
- }
187
- if (!cancelDownload) {
188
- this.download(request, response, downloadInfo, query.id);
189
- } else {
190
- this.logger.info('Download', query.id, 'has been cancelled');
191
- this.fileDownloadCache.deleteDownload(query.id);
192
- }
193
- }
194
- }
195
-
196
- @injectable()
197
- export class SingleFileDownloadHandler extends FileDownloadHandler {
198
-
199
- async handle(request: Request, response: Response): Promise<void> {
200
- const { method, body, query } = request;
201
- if (method !== 'GET') {
202
- this.handleError(response, `Unexpected HTTP method. Expected GET got '${method}' instead.`, METHOD_NOT_ALLOWED);
203
- return;
204
- }
205
- if (body !== undefined && !isEmpty(body)) {
206
- this.handleError(response, `The request body must either undefined or empty when downloading a single file. The body was: ${JSON.stringify(body)}.`, BAD_REQUEST);
207
- return;
208
- }
209
- if (query === undefined || query.uri === undefined || typeof query.uri !== 'string') {
210
- this.handleError(response, `Cannot access the 'uri' query from the request. The query was: ${JSON.stringify(query)}.`, BAD_REQUEST);
211
- return;
212
- }
213
- const uri = new URI(query.uri).toString(true);
214
- const filePath = FileUri.fsPath(uri);
215
-
216
- let stat: fs.Stats;
217
- try {
218
- stat = await fs.stat(filePath);
219
- } catch {
220
- this.handleError(response, `The file does not exist. URI: ${uri}.`, NOT_FOUND);
221
- return;
222
- }
223
- try {
224
- const downloadId = generateUuid();
225
- const options: PrepareDownloadOptions = { filePath, downloadId, remove: false };
226
- if (!stat.isDirectory()) {
227
- await this.prepareDownload(request, response, options);
228
- } else {
229
- const outputRootPath = await this.createTempDir(downloadId);
230
- const outputPath = path.join(outputRootPath, `${path.basename(filePath)}.tar`);
231
- await this.archive(filePath, outputPath);
232
- options.filePath = outputPath;
233
- options.remove = true;
234
- options.root = outputRootPath;
235
- await this.prepareDownload(request, response, options);
236
- }
237
- } catch (e) {
238
- this.handleError(response, e, INTERNAL_SERVER_ERROR);
239
- }
240
- }
241
-
242
- }
243
-
244
- @injectable()
245
- export class MultiFileDownloadHandler extends FileDownloadHandler {
246
-
247
- async handle(request: Request, response: Response): Promise<void> {
248
- const { method, body } = request;
249
- if (method !== 'PUT') {
250
- this.handleError(response, `Unexpected HTTP method. Expected PUT got '${method}' instead.`, METHOD_NOT_ALLOWED);
251
- return;
252
- }
253
- if (body === undefined) {
254
- this.handleError(response, 'The request body must be defined when downloading multiple files.', BAD_REQUEST);
255
- return;
256
- }
257
- if (!FileDownloadData.is(body)) {
258
- this.handleError(response, `Unexpected body format. Cannot extract the URIs from the request body. Body was: ${JSON.stringify(body)}.`, BAD_REQUEST);
259
- return;
260
- }
261
- if (body.uris.length === 0) {
262
- this.handleError(response, `Insufficient body format. No URIs were defined by the request body. Body was: ${JSON.stringify(body)}.`, BAD_REQUEST);
263
- return;
264
- }
265
- for (const uri of body.uris) {
266
- try {
267
- await fs.access(FileUri.fsPath(uri));
268
- } catch {
269
- this.handleError(response, `The file does not exist. URI: ${uri}.`, NOT_FOUND);
270
- return;
271
- }
272
- }
273
- try {
274
- const downloadId = generateUuid();
275
- const outputRootPath = await this.createTempDir(downloadId);
276
- const distinctUris = Array.from(new Set(body.uris.map(uri => new URI(uri))));
277
- const tarPaths = [];
278
- // We should have one key in the map per FS drive.
279
- for (const [rootUri, uris] of (await this.directoryArchiver.findCommonParents(distinctUris)).entries()) {
280
- const rootPath = FileUri.fsPath(rootUri);
281
- const entries = uris.map(FileUri.fsPath).map(p => path.relative(rootPath, p));
282
- const outputPath = path.join(outputRootPath, `${path.basename(rootPath)}.tar`);
283
- await this.archive(rootPath, outputPath, entries);
284
- tarPaths.push(outputPath);
285
- }
286
- const options: PrepareDownloadOptions = { filePath: '', downloadId, remove: true, root: outputRootPath };
287
- if (tarPaths.length === 1) {
288
- // tslint:disable-next-line:whitespace
289
- const [outputPath,] = tarPaths;
290
- options.filePath = outputPath;
291
- await this.prepareDownload(request, response, options);
292
- } else {
293
- // We need to tar the tars.
294
- const outputPath = path.join(outputRootPath, `theia-archive-${Date.now()}.tar`);
295
- options.filePath = outputPath;
296
- await this.archive(outputRootPath, outputPath, tarPaths.map(p => path.relative(outputRootPath, p)));
297
- await this.prepareDownload(request, response, options);
298
- }
299
- } catch (e) {
300
- this.handleError(response, e, INTERNAL_SERVER_ERROR);
301
- }
302
- }
303
-
304
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2018 TypeFox and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import * as os from 'os';
18
+ import * as fs from '@theia/core/shared/fs-extra';
19
+ import * as path from 'path';
20
+ import { generateUuid } from '@theia/core/lib/common/uuid';
21
+ import { Request, Response } from '@theia/core/shared/express';
22
+ import { inject, injectable } from '@theia/core/shared/inversify';
23
+ import { OK, BAD_REQUEST, METHOD_NOT_ALLOWED, NOT_FOUND, INTERNAL_SERVER_ERROR, REQUESTED_RANGE_NOT_SATISFIABLE, PARTIAL_CONTENT } from 'http-status-codes';
24
+ import URI from '@theia/core/lib/common/uri';
25
+ import { isEmpty } from '@theia/core/lib/common/objects';
26
+ import { ILogger } from '@theia/core/lib/common/logger';
27
+ import { FileUri } from '@theia/core/lib/common/file-uri';
28
+ import { DirectoryArchiver } from './directory-archiver';
29
+ import { FileDownloadData } from '../../common/download/file-download-data';
30
+ import { FileDownloadCache, DownloadStorageItem } from './file-download-cache';
31
+
32
+ interface PrepareDownloadOptions {
33
+ filePath: string;
34
+ downloadId: string;
35
+ remove: boolean;
36
+ root?: string;
37
+ }
38
+
39
+ @injectable()
40
+ export abstract class FileDownloadHandler {
41
+
42
+ @inject(ILogger)
43
+ protected readonly logger: ILogger;
44
+
45
+ @inject(DirectoryArchiver)
46
+ protected readonly directoryArchiver: DirectoryArchiver;
47
+
48
+ @inject(FileDownloadCache)
49
+ protected readonly fileDownloadCache: FileDownloadCache;
50
+
51
+ public abstract handle(request: Request, response: Response): Promise<void>;
52
+
53
+ /**
54
+ * Prepares the file and the link for download
55
+ */
56
+ protected async prepareDownload(request: Request, response: Response, options: PrepareDownloadOptions): Promise<void> {
57
+ const name = path.basename(options.filePath);
58
+ try {
59
+ await fs.access(options.filePath, fs.constants.R_OK);
60
+ const stat = await fs.stat(options.filePath);
61
+ this.fileDownloadCache.addDownload(options.downloadId, { file: options.filePath, remove: options.remove, size: stat.size, root: options.root });
62
+ // do not send filePath but instead use the downloadId
63
+ const data = { name, id: options.downloadId };
64
+ response.status(OK).send(data).end();
65
+ } catch (e) {
66
+ this.handleError(response, e, INTERNAL_SERVER_ERROR);
67
+ }
68
+ }
69
+
70
+ protected async download(request: Request, response: Response, downloadInfo: DownloadStorageItem, id: string): Promise<void> {
71
+ const filePath = downloadInfo.file;
72
+ const statSize = downloadInfo.size;
73
+ // this sets the content-disposition and content-type automatically
74
+ response.attachment(filePath);
75
+ try {
76
+ await fs.access(filePath, fs.constants.R_OK);
77
+ response.setHeader('Accept-Ranges', 'bytes');
78
+ // parse range header and combine multiple ranges
79
+ const range = this.parseRangeHeader(request.headers['range'], statSize);
80
+ if (!range) {
81
+ response.setHeader('Content-Length', statSize);
82
+ this.streamDownload(OK, response, fs.createReadStream(filePath), id);
83
+ } else {
84
+ const rangeStart = range.start;
85
+ const rangeEnd = range.end;
86
+ if (rangeStart >= statSize || rangeEnd >= statSize) {
87
+ response.setHeader('Content-Range', `bytes */${statSize}`);
88
+ // Return the 416 'Requested Range Not Satisfiable'.
89
+ response.status(REQUESTED_RANGE_NOT_SATISFIABLE).end();
90
+ return;
91
+ }
92
+ response.setHeader('Content-Range', `bytes ${rangeStart}-${rangeEnd}/${statSize}`);
93
+ response.setHeader('Content-Length', rangeStart === rangeEnd ? 0 : (rangeEnd - rangeStart + 1));
94
+ response.setHeader('Cache-Control', 'no-cache');
95
+ this.streamDownload(PARTIAL_CONTENT, response, fs.createReadStream(filePath, { start: rangeStart, end: rangeEnd }), id);
96
+ }
97
+ } catch (e) {
98
+ this.fileDownloadCache.deleteDownload(id);
99
+ this.handleError(response, e, INTERNAL_SERVER_ERROR);
100
+ }
101
+ }
102
+ /**
103
+ * Streams the file and pipe it to the Response to avoid any OOM issues
104
+ */
105
+ protected streamDownload(status: number, response: Response, stream: fs.ReadStream, id: string): void {
106
+ response.status(status);
107
+ stream.on('error', error => {
108
+ this.fileDownloadCache.deleteDownload(id);
109
+ this.handleError(response, error, INTERNAL_SERVER_ERROR);
110
+ });
111
+ response.on('error', error => {
112
+ this.fileDownloadCache.deleteDownload(id);
113
+ this.handleError(response, error, INTERNAL_SERVER_ERROR);
114
+ });
115
+ response.on('close', () => {
116
+ stream.destroy();
117
+ });
118
+ stream.pipe(response);
119
+ }
120
+ protected parseRangeHeader(range: string | string[] | undefined, statSize: number): { start: number, end: number } | undefined {
121
+ if (!range || range.length === 0 || Array.isArray(range)) {
122
+ return;
123
+ }
124
+ const index = range.indexOf('=');
125
+ if (index === -1) {
126
+ return;
127
+ }
128
+ const rangeType = range.slice(0, index);
129
+ if (rangeType !== 'bytes') {
130
+ return;
131
+ }
132
+ const [start, end] = range.slice(index + 1).split('-').map(r => parseInt(r, 10));
133
+ return {
134
+ start: isNaN(start) ? 0 : start,
135
+ end: (isNaN(end) || end > statSize - 1) ? (statSize - 1) : end
136
+ };
137
+ }
138
+ protected async archive(inputPath: string, outputPath: string = path.join(os.tmpdir(), generateUuid()), entries?: string[]): Promise<string> {
139
+ await this.directoryArchiver.archive(inputPath, outputPath, entries);
140
+ return outputPath;
141
+ }
142
+
143
+ protected async createTempDir(downloadId: string = generateUuid()): Promise<string> {
144
+ const outputPath = path.join(os.tmpdir(), downloadId);
145
+ await fs.mkdir(outputPath);
146
+ return outputPath;
147
+ }
148
+
149
+ protected async handleError(response: Response, reason: string | Error, status: number = INTERNAL_SERVER_ERROR): Promise<void> {
150
+ this.logger.error(reason);
151
+ response.status(status).send('Unable to download file.').end();
152
+ }
153
+
154
+ }
155
+
156
+ export namespace FileDownloadHandler {
157
+ export const SINGLE: symbol = Symbol('single');
158
+ export const MULTI: symbol = Symbol('multi');
159
+ export const DOWNLOAD_LINK: symbol = Symbol('download');
160
+ }
161
+
162
+ @injectable()
163
+ export class DownloadLinkHandler extends FileDownloadHandler {
164
+
165
+ async handle(request: Request, response: Response): Promise<void> {
166
+ const { method, query } = request;
167
+ if (method !== 'GET' && method !== 'HEAD') {
168
+ this.handleError(response, `Unexpected HTTP method. Expected GET got '${method}' instead.`, METHOD_NOT_ALLOWED);
169
+ return;
170
+ }
171
+ if (query === undefined || query.id === undefined || typeof query.id !== 'string') {
172
+ this.handleError(response, `Cannot access the 'id' query from the request. The query was: ${JSON.stringify(query)}.`, BAD_REQUEST);
173
+ return;
174
+ }
175
+ const cancelDownload = query.cancel;
176
+ const downloadInfo = this.fileDownloadCache.getDownload(query.id);
177
+ if (!downloadInfo) {
178
+ this.handleError(response, `Cannot find the file from the request. The query was: ${JSON.stringify(query)}.`, NOT_FOUND);
179
+ return;
180
+ }
181
+ // allow head request to determine the content length for parallel downloaders
182
+ if (method === 'HEAD') {
183
+ response.setHeader('Content-Length', downloadInfo.size);
184
+ response.status(OK).end();
185
+ return;
186
+ }
187
+ if (!cancelDownload) {
188
+ this.download(request, response, downloadInfo, query.id);
189
+ } else {
190
+ this.logger.info('Download', query.id, 'has been cancelled');
191
+ this.fileDownloadCache.deleteDownload(query.id);
192
+ }
193
+ }
194
+ }
195
+
196
+ @injectable()
197
+ export class SingleFileDownloadHandler extends FileDownloadHandler {
198
+
199
+ async handle(request: Request, response: Response): Promise<void> {
200
+ const { method, body, query } = request;
201
+ if (method !== 'GET') {
202
+ this.handleError(response, `Unexpected HTTP method. Expected GET got '${method}' instead.`, METHOD_NOT_ALLOWED);
203
+ return;
204
+ }
205
+ if (body !== undefined && !isEmpty(body)) {
206
+ this.handleError(response, `The request body must either undefined or empty when downloading a single file. The body was: ${JSON.stringify(body)}.`, BAD_REQUEST);
207
+ return;
208
+ }
209
+ if (query === undefined || query.uri === undefined || typeof query.uri !== 'string') {
210
+ this.handleError(response, `Cannot access the 'uri' query from the request. The query was: ${JSON.stringify(query)}.`, BAD_REQUEST);
211
+ return;
212
+ }
213
+ const uri = new URI(query.uri).toString(true);
214
+ const filePath = FileUri.fsPath(uri);
215
+
216
+ let stat: fs.Stats;
217
+ try {
218
+ stat = await fs.stat(filePath);
219
+ } catch {
220
+ this.handleError(response, `The file does not exist. URI: ${uri}.`, NOT_FOUND);
221
+ return;
222
+ }
223
+ try {
224
+ const downloadId = generateUuid();
225
+ const options: PrepareDownloadOptions = { filePath, downloadId, remove: false };
226
+ if (!stat.isDirectory()) {
227
+ await this.prepareDownload(request, response, options);
228
+ } else {
229
+ const outputRootPath = await this.createTempDir(downloadId);
230
+ const outputPath = path.join(outputRootPath, `${path.basename(filePath)}.tar`);
231
+ await this.archive(filePath, outputPath);
232
+ options.filePath = outputPath;
233
+ options.remove = true;
234
+ options.root = outputRootPath;
235
+ await this.prepareDownload(request, response, options);
236
+ }
237
+ } catch (e) {
238
+ this.handleError(response, e, INTERNAL_SERVER_ERROR);
239
+ }
240
+ }
241
+
242
+ }
243
+
244
+ @injectable()
245
+ export class MultiFileDownloadHandler extends FileDownloadHandler {
246
+
247
+ async handle(request: Request, response: Response): Promise<void> {
248
+ const { method, body } = request;
249
+ if (method !== 'PUT') {
250
+ this.handleError(response, `Unexpected HTTP method. Expected PUT got '${method}' instead.`, METHOD_NOT_ALLOWED);
251
+ return;
252
+ }
253
+ if (body === undefined) {
254
+ this.handleError(response, 'The request body must be defined when downloading multiple files.', BAD_REQUEST);
255
+ return;
256
+ }
257
+ if (!FileDownloadData.is(body)) {
258
+ this.handleError(response, `Unexpected body format. Cannot extract the URIs from the request body. Body was: ${JSON.stringify(body)}.`, BAD_REQUEST);
259
+ return;
260
+ }
261
+ if (body.uris.length === 0) {
262
+ this.handleError(response, `Insufficient body format. No URIs were defined by the request body. Body was: ${JSON.stringify(body)}.`, BAD_REQUEST);
263
+ return;
264
+ }
265
+ for (const uri of body.uris) {
266
+ try {
267
+ await fs.access(FileUri.fsPath(uri));
268
+ } catch {
269
+ this.handleError(response, `The file does not exist. URI: ${uri}.`, NOT_FOUND);
270
+ return;
271
+ }
272
+ }
273
+ try {
274
+ const downloadId = generateUuid();
275
+ const outputRootPath = await this.createTempDir(downloadId);
276
+ const distinctUris = Array.from(new Set(body.uris.map(uri => new URI(uri))));
277
+ const tarPaths = [];
278
+ // We should have one key in the map per FS drive.
279
+ for (const [rootUri, uris] of (await this.directoryArchiver.findCommonParents(distinctUris)).entries()) {
280
+ const rootPath = FileUri.fsPath(rootUri);
281
+ const entries = uris.map(FileUri.fsPath).map(p => path.relative(rootPath, p));
282
+ const outputPath = path.join(outputRootPath, `${path.basename(rootPath)}.tar`);
283
+ await this.archive(rootPath, outputPath, entries);
284
+ tarPaths.push(outputPath);
285
+ }
286
+ const options: PrepareDownloadOptions = { filePath: '', downloadId, remove: true, root: outputRootPath };
287
+ if (tarPaths.length === 1) {
288
+ // tslint:disable-next-line:whitespace
289
+ const [outputPath,] = tarPaths;
290
+ options.filePath = outputPath;
291
+ await this.prepareDownload(request, response, options);
292
+ } else {
293
+ // We need to tar the tars.
294
+ const outputPath = path.join(outputRootPath, `theia-archive-${Date.now()}.tar`);
295
+ options.filePath = outputPath;
296
+ await this.archive(outputRootPath, outputPath, tarPaths.map(p => path.relative(outputRootPath, p)));
297
+ await this.prepareDownload(request, response, options);
298
+ }
299
+ } catch (e) {
300
+ this.handleError(response, e, INTERNAL_SERVER_ERROR);
301
+ }
302
+ }
303
+
304
+ }