@theia/filesystem 1.34.3 → 1.34.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (216) hide show
  1. package/LICENSE +641 -641
  2. package/README.md +30 -30
  3. package/lib/browser/breadcrumbs/filepath-breadcrumb.d.ts +15 -15
  4. package/lib/browser/breadcrumbs/filepath-breadcrumb.js +41 -41
  5. package/lib/browser/breadcrumbs/filepath-breadcrumbs-container.d.ts +13 -13
  6. package/lib/browser/breadcrumbs/filepath-breadcrumbs-container.js +78 -78
  7. package/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.d.ts +27 -27
  8. package/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.js +126 -126
  9. package/lib/browser/download/file-download-command-contribution.d.ts +18 -18
  10. package/lib/browser/download/file-download-command-contribution.js +83 -83
  11. package/lib/browser/download/file-download-frontend-module.d.ts +3 -3
  12. package/lib/browser/download/file-download-frontend-module.js +25 -25
  13. package/lib/browser/download/file-download-service.d.ts +28 -28
  14. package/lib/browser/download/file-download-service.js +175 -175
  15. package/lib/browser/file-dialog/file-dialog-container.d.ts +5 -5
  16. package/lib/browser/file-dialog/file-dialog-container.js +52 -52
  17. package/lib/browser/file-dialog/file-dialog-model.d.ts +25 -25
  18. package/lib/browser/file-dialog/file-dialog-model.js +108 -108
  19. package/lib/browser/file-dialog/file-dialog-module.d.ts +3 -3
  20. package/lib/browser/file-dialog/file-dialog-module.js +37 -37
  21. package/lib/browser/file-dialog/file-dialog-service.d.ts +32 -32
  22. package/lib/browser/file-dialog/file-dialog-service.js +107 -107
  23. package/lib/browser/file-dialog/file-dialog-tree-filters-renderer.d.ts +39 -39
  24. package/lib/browser/file-dialog/file-dialog-tree-filters-renderer.js +92 -92
  25. package/lib/browser/file-dialog/file-dialog-tree.d.ts +22 -22
  26. package/lib/browser/file-dialog/file-dialog-tree.js +71 -71
  27. package/lib/browser/file-dialog/file-dialog-widget.d.ts +15 -15
  28. package/lib/browser/file-dialog/file-dialog-widget.js +86 -86
  29. package/lib/browser/file-dialog/file-dialog.d.ts +126 -126
  30. package/lib/browser/file-dialog/file-dialog.js +355 -355
  31. package/lib/browser/file-dialog/index.d.ts +4 -4
  32. package/lib/browser/file-dialog/index.js +31 -31
  33. package/lib/browser/file-resource.d.ts +63 -63
  34. package/lib/browser/file-resource.js +352 -352
  35. package/lib/browser/file-selection.d.ts +14 -14
  36. package/lib/browser/file-selection.js +36 -36
  37. package/lib/browser/file-service.d.ts +412 -412
  38. package/lib/browser/file-service.js +1330 -1330
  39. package/lib/browser/file-tree/file-tree-container.d.ts +3 -3
  40. package/lib/browser/file-tree/file-tree-container.js +35 -35
  41. package/lib/browser/file-tree/file-tree-decorator-adapter.d.ts +30 -30
  42. package/lib/browser/file-tree/file-tree-decorator-adapter.js +174 -174
  43. package/lib/browser/file-tree/file-tree-label-provider.d.ts +12 -12
  44. package/lib/browser/file-tree/file-tree-label-provider.js +62 -62
  45. package/lib/browser/file-tree/file-tree-model.d.ts +37 -37
  46. package/lib/browser/file-tree/file-tree-model.js +225 -225
  47. package/lib/browser/file-tree/file-tree-widget.d.ts +44 -44
  48. package/lib/browser/file-tree/file-tree-widget.js +315 -315
  49. package/lib/browser/file-tree/file-tree.d.ts +46 -46
  50. package/lib/browser/file-tree/file-tree.js +184 -184
  51. package/lib/browser/file-tree/index.d.ts +6 -6
  52. package/lib/browser/file-tree/index.js +33 -33
  53. package/lib/browser/file-upload-service.d.ts +98 -98
  54. package/lib/browser/file-upload-service.js +428 -428
  55. package/lib/browser/filesystem-frontend-contribution.d.ts +63 -63
  56. package/lib/browser/filesystem-frontend-contribution.js +324 -324
  57. package/lib/browser/filesystem-frontend-module.d.ts +5 -5
  58. package/lib/browser/filesystem-frontend-module.js +64 -64
  59. package/lib/browser/filesystem-preferences.d.ts +29 -29
  60. package/lib/browser/filesystem-preferences.js +108 -108
  61. package/lib/browser/filesystem-save-resource-service.d.ts +29 -29
  62. package/lib/browser/filesystem-save-resource-service.js +142 -142
  63. package/lib/browser/filesystem-watcher-error-handler.d.ts +10 -10
  64. package/lib/browser/filesystem-watcher-error-handler.js +69 -69
  65. package/lib/browser/index.d.ts +5 -5
  66. package/lib/browser/index.js +32 -32
  67. package/lib/browser/location/index.d.ts +2 -2
  68. package/lib/browser/location/index.js +29 -29
  69. package/lib/browser/location/location-renderer.d.ts +99 -99
  70. package/lib/browser/location/location-renderer.js +351 -351
  71. package/lib/browser/location/location-service.d.ts +5 -5
  72. package/lib/browser/location/location-service.js +17 -17
  73. package/lib/browser/remote-file-service-contribution.d.ts +6 -6
  74. package/lib/browser/remote-file-service-contribution.js +47 -47
  75. package/lib/common/delegating-file-system-provider.d.ts +76 -76
  76. package/lib/common/delegating-file-system-provider.js +168 -168
  77. package/lib/common/download/file-download-data.d.ts +6 -6
  78. package/lib/common/download/file-download-data.js +26 -26
  79. package/lib/common/file-upload.d.ts +1 -1
  80. package/lib/common/file-upload.js +19 -19
  81. package/lib/common/files.d.ts +651 -651
  82. package/lib/common/files.js +347 -347
  83. package/lib/common/files.spec.d.ts +1 -1
  84. package/lib/common/files.spec.js +51 -51
  85. package/lib/common/filesystem-utils.d.ts +14 -14
  86. package/lib/common/filesystem-utils.js +63 -63
  87. package/lib/common/filesystem-utils.spec.d.ts +1 -1
  88. package/lib/common/filesystem-utils.spec.js +378 -378
  89. package/lib/common/filesystem-watcher-protocol.d.ts +71 -71
  90. package/lib/common/filesystem-watcher-protocol.js +20 -20
  91. package/lib/common/filesystem.d.ts +22 -22
  92. package/lib/common/filesystem.js +42 -42
  93. package/lib/common/index.d.ts +2 -2
  94. package/lib/common/index.js +29 -29
  95. package/lib/common/io.d.ts +19 -19
  96. package/lib/common/io.js +110 -110
  97. package/lib/common/remote-file-system-provider.d.ts +164 -164
  98. package/lib/common/remote-file-system-provider.js +413 -413
  99. package/lib/electron-browser/file-dialog/electron-file-dialog-module.d.ts +3 -3
  100. package/lib/electron-browser/file-dialog/electron-file-dialog-module.js +24 -24
  101. package/lib/electron-browser/file-dialog/electron-file-dialog-service.d.ts +58 -58
  102. package/lib/electron-browser/file-dialog/electron-file-dialog-service.js +194 -194
  103. package/lib/node/disk-file-system-provider.d.ts +72 -72
  104. package/lib/node/disk-file-system-provider.js +783 -783
  105. package/lib/node/download/directory-archiver.d.ts +9 -9
  106. package/lib/node/download/directory-archiver.js +132 -132
  107. package/lib/node/download/directory-archiver.spec.d.ts +1 -1
  108. package/lib/node/download/directory-archiver.spec.js +97 -97
  109. package/lib/node/download/file-download-backend-module.d.ts +3 -3
  110. package/lib/node/download/file-download-backend-module.js +32 -32
  111. package/lib/node/download/file-download-cache.d.ts +21 -21
  112. package/lib/node/download/file-download-cache.js +90 -90
  113. package/lib/node/download/file-download-endpoint.d.ts +11 -11
  114. package/lib/node/download/file-download-endpoint.js +75 -75
  115. package/lib/node/download/file-download-handler.d.ts +50 -50
  116. package/lib/node/download/file-download-handler.js +315 -315
  117. package/lib/node/download/test/mock-directory-archiver.d.ts +7 -7
  118. package/lib/node/download/test/mock-directory-archiver.js +29 -29
  119. package/lib/node/file-change-collection.d.ts +22 -22
  120. package/lib/node/file-change-collection.js +77 -77
  121. package/lib/node/file-change-collection.spec.d.ts +1 -1
  122. package/lib/node/file-change-collection.spec.js +90 -90
  123. package/lib/node/filesystem-backend-module.d.ts +26 -26
  124. package/lib/node/filesystem-backend-module.js +120 -120
  125. package/lib/node/filesystem-watcher-client.d.ts +23 -23
  126. package/lib/node/filesystem-watcher-client.js +83 -83
  127. package/lib/node/filesystem-watcher-dispatcher.d.ts +23 -23
  128. package/lib/node/filesystem-watcher-dispatcher.js +85 -85
  129. package/lib/node/node-file-upload-service.d.ts +15 -15
  130. package/lib/node/node-file-upload-service.js +76 -76
  131. package/lib/node/nsfw-watcher/index.d.ts +3 -3
  132. package/lib/node/nsfw-watcher/index.js +39 -39
  133. package/lib/node/nsfw-watcher/nsfw-filesystem-service.d.ts +191 -191
  134. package/lib/node/nsfw-watcher/nsfw-filesystem-service.js +389 -389
  135. package/lib/node/nsfw-watcher/nsfw-filesystem-watcher.spec.d.ts +1 -1
  136. package/lib/node/nsfw-watcher/nsfw-filesystem-watcher.spec.js +151 -151
  137. package/lib/node/nsfw-watcher/nsfw-options.d.ts +6 -6
  138. package/lib/node/nsfw-watcher/nsfw-options.js +22 -22
  139. package/package.json +4 -4
  140. package/src/browser/breadcrumbs/filepath-breadcrumb.ts +43 -43
  141. package/src/browser/breadcrumbs/filepath-breadcrumbs-container.ts +65 -65
  142. package/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts +129 -129
  143. package/src/browser/download/file-download-command-contribution.ts +83 -83
  144. package/src/browser/download/file-download-frontend-module.ts +25 -25
  145. package/src/browser/download/file-download-service.ts +179 -179
  146. package/src/browser/file-dialog/file-dialog-container.ts +67 -67
  147. package/src/browser/file-dialog/file-dialog-model.ts +96 -96
  148. package/src/browser/file-dialog/file-dialog-module.ts +36 -36
  149. package/src/browser/file-dialog/file-dialog-service.ts +97 -97
  150. package/src/browser/file-dialog/file-dialog-tree-filters-renderer.tsx +100 -100
  151. package/src/browser/file-dialog/file-dialog-tree.ts +71 -71
  152. package/src/browser/file-dialog/file-dialog-widget.ts +75 -75
  153. package/src/browser/file-dialog/file-dialog.ts +428 -428
  154. package/src/browser/file-dialog/index.ts +20 -20
  155. package/src/browser/file-resource.ts +361 -361
  156. package/src/browser/file-selection.ts +44 -44
  157. package/src/browser/file-service.ts +1814 -1814
  158. package/src/browser/file-tree/file-tree-container.ts +36 -36
  159. package/src/browser/file-tree/file-tree-decorator-adapter.ts +159 -159
  160. package/src/browser/file-tree/file-tree-label-provider.ts +53 -53
  161. package/src/browser/file-tree/file-tree-model.ts +212 -212
  162. package/src/browser/file-tree/file-tree-widget.tsx +327 -327
  163. package/src/browser/file-tree/file-tree.ts +183 -183
  164. package/src/browser/file-tree/index.ts +22 -22
  165. package/src/browser/file-upload-service.ts +513 -513
  166. package/src/browser/filesystem-frontend-contribution.ts +338 -338
  167. package/src/browser/filesystem-frontend-module.ts +77 -77
  168. package/src/browser/filesystem-preferences.ts +138 -138
  169. package/src/browser/filesystem-save-resource-service.ts +124 -124
  170. package/src/browser/filesystem-watcher-error-handler.ts +60 -60
  171. package/src/browser/index.ts +21 -21
  172. package/src/browser/location/index.ts +18 -18
  173. package/src/browser/location/location-renderer.tsx +400 -400
  174. package/src/browser/location/location-service.ts +22 -22
  175. package/src/browser/remote-file-service-contribution.ts +38 -38
  176. package/src/browser/style/file-dialog.css +204 -204
  177. package/src/browser/style/file-icons.css +64 -64
  178. package/src/browser/style/filepath-breadcrumbs.css +20 -20
  179. package/src/browser/style/index.css +36 -36
  180. package/src/common/delegating-file-system-provider.ts +226 -226
  181. package/src/common/download/README.md +30 -30
  182. package/src/common/download/file-download-data.ts +27 -27
  183. package/src/common/file-upload.ts +17 -17
  184. package/src/common/files.spec.ts +51 -51
  185. package/src/common/files.ts +983 -983
  186. package/src/common/filesystem-utils.spec.ts +411 -411
  187. package/src/common/filesystem-utils.ts +64 -64
  188. package/src/common/filesystem-watcher-protocol.ts +96 -96
  189. package/src/common/filesystem.ts +43 -43
  190. package/src/common/index.ts +18 -18
  191. package/src/common/io.ts +150 -150
  192. package/src/common/remote-file-system-provider.ts +511 -511
  193. package/src/electron-browser/file-dialog/electron-file-dialog-module.ts +24 -24
  194. package/src/electron-browser/file-dialog/electron-file-dialog-service.ts +229 -229
  195. package/src/node/disk-file-system-provider.ts +908 -908
  196. package/src/node/download/directory-archiver.spec.ts +104 -104
  197. package/src/node/download/directory-archiver.ts +126 -126
  198. package/src/node/download/file-download-backend-module.ts +32 -32
  199. package/src/node/download/file-download-cache.ts +88 -88
  200. package/src/node/download/file-download-endpoint.ts +63 -63
  201. package/src/node/download/file-download-handler.ts +304 -304
  202. package/src/node/download/test/mock-directory-archiver.ts +30 -30
  203. package/src/node/file-change-collection.spec.ts +110 -110
  204. package/src/node/file-change-collection.ts +78 -78
  205. package/src/node/filesystem-backend-module.ts +140 -140
  206. package/src/node/filesystem-watcher-client.ts +72 -72
  207. package/src/node/filesystem-watcher-dispatcher.ts +82 -82
  208. package/src/node/node-file-upload-service.ts +73 -73
  209. package/src/node/nsfw-watcher/index.ts +45 -45
  210. package/src/node/nsfw-watcher/nsfw-filesystem-service.ts +476 -476
  211. package/src/node/nsfw-watcher/nsfw-filesystem-watcher.spec.ts +182 -182
  212. package/src/node/nsfw-watcher/nsfw-options.ts +23 -23
  213. package/src/typings/dom.webkit.d.ts +77 -77
  214. package/src/typings/mv/index.d.ts +21 -21
  215. package/src/typings/nsfw/index.d.ts +18 -18
  216. package/src/typings/trash/index.d.ts +20 -20
@@ -1,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 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 { v4 } from '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/node/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(), v4()), entries?: string[]): Promise<string> {
139
- await this.directoryArchiver.archive(inputPath, outputPath, entries);
140
- return outputPath;
141
- }
142
-
143
- protected async createTempDir(downloadId: string = v4()): 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 = v4();
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 = v4();
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 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 { v4 } from '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/node/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(), v4()), entries?: string[]): Promise<string> {
139
+ await this.directoryArchiver.archive(inputPath, outputPath, entries);
140
+ return outputPath;
141
+ }
142
+
143
+ protected async createTempDir(downloadId: string = v4()): 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 = v4();
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 = v4();
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
+ }