@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,179 +1,179 @@
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 { inject, injectable } from '@theia/core/shared/inversify';
18
- import URI from '@theia/core/lib/common/uri';
19
- import { ILogger } from '@theia/core/lib/common/logger';
20
- import { Endpoint } from '@theia/core/lib/browser/endpoint';
21
- import { FileDownloadData } from '../../common/download/file-download-data';
22
- import { MessageService } from '@theia/core/lib/common/message-service';
23
- import { addClipboardListener } from '@theia/core/lib/browser/widgets';
24
- import { nls } from '@theia/core';
25
-
26
- @injectable()
27
- export class FileDownloadService {
28
-
29
- protected anchor: HTMLAnchorElement | undefined;
30
- protected downloadCounter: number = 0;
31
-
32
- @inject(ILogger)
33
- protected readonly logger: ILogger;
34
-
35
- @inject(MessageService)
36
- protected readonly messageService: MessageService;
37
-
38
- protected handleCopy(event: ClipboardEvent, downloadUrl: string): void {
39
- if (downloadUrl && event.clipboardData) {
40
- event.clipboardData.setData('text/plain', downloadUrl);
41
- event.preventDefault();
42
- this.messageService.info(nls.localize('theia/filesystem/copiedToClipboard', 'Copied the download link to the clipboard.'));
43
- }
44
- }
45
-
46
- async cancelDownload(id: string): Promise<void> {
47
- await fetch(`${this.endpoint()}/download/?id=${id}&cancel=true`);
48
- }
49
-
50
- async download(uris: URI[], options?: FileDownloadService.DownloadOptions): Promise<void> {
51
- let cancel = false;
52
- if (uris.length === 0) {
53
- return;
54
- }
55
- const copyLink = options && options.copyLink ? true : false;
56
- try {
57
- const text: string = copyLink ?
58
- nls.localize('theia/filesystem/prepareDownloadLink', 'Preparing download link...') :
59
- nls.localize('theia/filesystem/prepareDownload', 'Preparing download...');
60
- const [progress, result] = await Promise.all([
61
- this.messageService.showProgress({
62
- text: text,
63
- options: { cancelable: true }
64
- }, () => { cancel = true; }),
65
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
66
- new Promise<{ response: Response, jsonResponse: any }>(async resolve => {
67
- const resp = await fetch(this.request(uris));
68
- const jsonResp = await resp.json();
69
- resolve({ response: resp, jsonResponse: jsonResp });
70
- })
71
- ]);
72
- const { response, jsonResponse } = result;
73
- if (cancel) {
74
- this.cancelDownload(jsonResponse.id);
75
- return;
76
- }
77
- const { status, statusText } = response;
78
- if (status === 200) {
79
- progress.cancel();
80
- const downloadUrl = `${this.endpoint()}/download/?id=${jsonResponse.id}`;
81
- if (copyLink) {
82
- if (document.documentElement) {
83
- const toDispose = addClipboardListener(document.documentElement, 'copy', e => {
84
- toDispose.dispose();
85
- this.handleCopy(e, downloadUrl);
86
- });
87
- document.execCommand('copy');
88
- }
89
- } else {
90
- this.forceDownload(jsonResponse.id, decodeURIComponent(jsonResponse.name));
91
- }
92
- } else {
93
- throw new Error(`Received unexpected status code: ${status}. [${statusText}]`);
94
- }
95
- } catch (e) {
96
- this.logger.error(`Error occurred when downloading: ${uris.map(u => u.toString(true))}.`, e);
97
- }
98
- }
99
-
100
- protected async forceDownload(id: string, title: string): Promise<void> {
101
- let url: string | undefined;
102
- try {
103
- if (this.anchor === undefined) {
104
- this.anchor = document.createElement('a');
105
- }
106
- const endpoint = this.endpoint();
107
- url = `${endpoint}/download/?id=${id}`;
108
- this.anchor.href = url;
109
- this.anchor.style.display = 'none';
110
- this.anchor.download = title;
111
- document.body.appendChild(this.anchor);
112
- this.anchor.click();
113
- } finally {
114
- // make sure anchor is removed from parent
115
- if (this.anchor && this.anchor.parentNode) {
116
- this.anchor.parentNode.removeChild(this.anchor);
117
- }
118
- if (url) {
119
- URL.revokeObjectURL(url);
120
- }
121
- }
122
- }
123
-
124
- protected request(uris: URI[]): Request {
125
- const url = this.url(uris);
126
- const init = this.requestInit(uris);
127
- return new Request(url, init);
128
- }
129
-
130
- protected requestInit(uris: URI[]): RequestInit {
131
- if (uris.length === 1) {
132
- return {
133
- body: undefined,
134
- method: 'GET'
135
- };
136
- }
137
- return {
138
- method: 'PUT',
139
- body: JSON.stringify(this.body(uris)),
140
- headers: new Headers({ 'Content-Type': 'application/json' }),
141
- };
142
- }
143
-
144
- protected body(uris: URI[]): FileDownloadData {
145
- return {
146
- uris: uris.map(u => u.toString(true))
147
- };
148
- }
149
-
150
- protected url(uris: URI[]): string {
151
- const endpoint = this.endpoint();
152
- if (uris.length === 1) {
153
- // tslint:disable-next-line:whitespace
154
- const [uri,] = uris;
155
- return `${endpoint}/?uri=${uri.toString()}`;
156
- }
157
- return endpoint;
158
-
159
- }
160
-
161
- protected endpoint(): string {
162
- const url = this.filesUrl();
163
- return url.endsWith('/') ? url.slice(0, -1) : url;
164
- }
165
-
166
- protected filesUrl(): string {
167
- return new Endpoint({ path: 'files' }).getRestUrl().toString();
168
- }
169
-
170
- }
171
-
172
- export namespace FileDownloadService {
173
- export interface DownloadOptions {
174
- /**
175
- * `true` if the download link has to be copied to the clipboard. This will not trigger the actual download. Defaults to `false`.
176
- */
177
- readonly copyLink?: boolean;
178
- }
179
- }
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 { inject, injectable } from '@theia/core/shared/inversify';
18
+ import URI from '@theia/core/lib/common/uri';
19
+ import { ILogger } from '@theia/core/lib/common/logger';
20
+ import { Endpoint } from '@theia/core/lib/browser/endpoint';
21
+ import { FileDownloadData } from '../../common/download/file-download-data';
22
+ import { MessageService } from '@theia/core/lib/common/message-service';
23
+ import { addClipboardListener } from '@theia/core/lib/browser/widgets';
24
+ import { nls } from '@theia/core';
25
+
26
+ @injectable()
27
+ export class FileDownloadService {
28
+
29
+ protected anchor: HTMLAnchorElement | undefined;
30
+ protected downloadCounter: number = 0;
31
+
32
+ @inject(ILogger)
33
+ protected readonly logger: ILogger;
34
+
35
+ @inject(MessageService)
36
+ protected readonly messageService: MessageService;
37
+
38
+ protected handleCopy(event: ClipboardEvent, downloadUrl: string): void {
39
+ if (downloadUrl && event.clipboardData) {
40
+ event.clipboardData.setData('text/plain', downloadUrl);
41
+ event.preventDefault();
42
+ this.messageService.info(nls.localize('theia/filesystem/copiedToClipboard', 'Copied the download link to the clipboard.'));
43
+ }
44
+ }
45
+
46
+ async cancelDownload(id: string): Promise<void> {
47
+ await fetch(`${this.endpoint()}/download/?id=${id}&cancel=true`);
48
+ }
49
+
50
+ async download(uris: URI[], options?: FileDownloadService.DownloadOptions): Promise<void> {
51
+ let cancel = false;
52
+ if (uris.length === 0) {
53
+ return;
54
+ }
55
+ const copyLink = options && options.copyLink ? true : false;
56
+ try {
57
+ const text: string = copyLink ?
58
+ nls.localize('theia/filesystem/prepareDownloadLink', 'Preparing download link...') :
59
+ nls.localize('theia/filesystem/prepareDownload', 'Preparing download...');
60
+ const [progress, result] = await Promise.all([
61
+ this.messageService.showProgress({
62
+ text: text,
63
+ options: { cancelable: true }
64
+ }, () => { cancel = true; }),
65
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
66
+ new Promise<{ response: Response, jsonResponse: any }>(async resolve => {
67
+ const resp = await fetch(this.request(uris));
68
+ const jsonResp = await resp.json();
69
+ resolve({ response: resp, jsonResponse: jsonResp });
70
+ })
71
+ ]);
72
+ const { response, jsonResponse } = result;
73
+ if (cancel) {
74
+ this.cancelDownload(jsonResponse.id);
75
+ return;
76
+ }
77
+ const { status, statusText } = response;
78
+ if (status === 200) {
79
+ progress.cancel();
80
+ const downloadUrl = `${this.endpoint()}/download/?id=${jsonResponse.id}`;
81
+ if (copyLink) {
82
+ if (document.documentElement) {
83
+ const toDispose = addClipboardListener(document.documentElement, 'copy', e => {
84
+ toDispose.dispose();
85
+ this.handleCopy(e, downloadUrl);
86
+ });
87
+ document.execCommand('copy');
88
+ }
89
+ } else {
90
+ this.forceDownload(jsonResponse.id, decodeURIComponent(jsonResponse.name));
91
+ }
92
+ } else {
93
+ throw new Error(`Received unexpected status code: ${status}. [${statusText}]`);
94
+ }
95
+ } catch (e) {
96
+ this.logger.error(`Error occurred when downloading: ${uris.map(u => u.toString(true))}.`, e);
97
+ }
98
+ }
99
+
100
+ protected async forceDownload(id: string, title: string): Promise<void> {
101
+ let url: string | undefined;
102
+ try {
103
+ if (this.anchor === undefined) {
104
+ this.anchor = document.createElement('a');
105
+ }
106
+ const endpoint = this.endpoint();
107
+ url = `${endpoint}/download/?id=${id}`;
108
+ this.anchor.href = url;
109
+ this.anchor.style.display = 'none';
110
+ this.anchor.download = title;
111
+ document.body.appendChild(this.anchor);
112
+ this.anchor.click();
113
+ } finally {
114
+ // make sure anchor is removed from parent
115
+ if (this.anchor && this.anchor.parentNode) {
116
+ this.anchor.parentNode.removeChild(this.anchor);
117
+ }
118
+ if (url) {
119
+ URL.revokeObjectURL(url);
120
+ }
121
+ }
122
+ }
123
+
124
+ protected request(uris: URI[]): Request {
125
+ const url = this.url(uris);
126
+ const init = this.requestInit(uris);
127
+ return new Request(url, init);
128
+ }
129
+
130
+ protected requestInit(uris: URI[]): RequestInit {
131
+ if (uris.length === 1) {
132
+ return {
133
+ body: undefined,
134
+ method: 'GET'
135
+ };
136
+ }
137
+ return {
138
+ method: 'PUT',
139
+ body: JSON.stringify(this.body(uris)),
140
+ headers: new Headers({ 'Content-Type': 'application/json' }),
141
+ };
142
+ }
143
+
144
+ protected body(uris: URI[]): FileDownloadData {
145
+ return {
146
+ uris: uris.map(u => u.toString(true))
147
+ };
148
+ }
149
+
150
+ protected url(uris: URI[]): string {
151
+ const endpoint = this.endpoint();
152
+ if (uris.length === 1) {
153
+ // tslint:disable-next-line:whitespace
154
+ const [uri,] = uris;
155
+ return `${endpoint}/?uri=${uri.toString()}`;
156
+ }
157
+ return endpoint;
158
+
159
+ }
160
+
161
+ protected endpoint(): string {
162
+ const url = this.filesUrl();
163
+ return url.endsWith('/') ? url.slice(0, -1) : url;
164
+ }
165
+
166
+ protected filesUrl(): string {
167
+ return new Endpoint({ path: 'files' }).getRestUrl().toString();
168
+ }
169
+
170
+ }
171
+
172
+ export namespace FileDownloadService {
173
+ export interface DownloadOptions {
174
+ /**
175
+ * `true` if the download link has to be copied to the clipboard. This will not trigger the actual download. Defaults to `false`.
176
+ */
177
+ readonly copyLink?: boolean;
178
+ }
179
+ }
@@ -1,67 +1,67 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2017 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 { interfaces, Container } from '@theia/core/shared/inversify';
18
- import { Tree, TreeModel, TreeProps, defaultTreeProps } from '@theia/core/lib/browser';
19
- import { createFileTreeContainer, FileTreeModel, FileTreeWidget } from '../file-tree';
20
- import { OpenFileDialog, OpenFileDialogProps, SaveFileDialog, SaveFileDialogProps } from './file-dialog';
21
- import { FileDialogModel } from './file-dialog-model';
22
- import { FileDialogWidget } from './file-dialog-widget';
23
- import { FileDialogTree } from './file-dialog-tree';
24
-
25
- export function createFileDialogContainer(parent: interfaces.Container): Container {
26
- const child = createFileTreeContainer(parent);
27
-
28
- child.unbind(FileTreeModel);
29
- child.bind(FileDialogModel).toSelf();
30
- child.rebind(TreeModel).toService(FileDialogModel);
31
-
32
- child.unbind(FileTreeWidget);
33
- child.bind(FileDialogWidget).toSelf();
34
-
35
- child.bind(FileDialogTree).toSelf();
36
- child.rebind(Tree).toService(FileDialogTree);
37
-
38
- return child;
39
- }
40
-
41
- export function createOpenFileDialogContainer(parent: interfaces.Container, props: OpenFileDialogProps): Container {
42
- const container = createFileDialogContainer(parent);
43
- container.rebind(TreeProps).toConstantValue({
44
- ...defaultTreeProps,
45
- multiSelect: props.canSelectMany,
46
- search: true
47
- });
48
-
49
- container.bind(OpenFileDialogProps).toConstantValue(props);
50
- container.bind(OpenFileDialog).toSelf();
51
-
52
- return container;
53
- }
54
-
55
- export function createSaveFileDialogContainer(parent: interfaces.Container, props: SaveFileDialogProps): Container {
56
- const container = createFileDialogContainer(parent);
57
- container.rebind(TreeProps).toConstantValue({
58
- ...defaultTreeProps,
59
- multiSelect: false,
60
- search: true
61
- });
62
-
63
- container.bind(SaveFileDialogProps).toConstantValue(props);
64
- container.bind(SaveFileDialog).toSelf();
65
-
66
- return container;
67
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2017 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 { interfaces, Container } from '@theia/core/shared/inversify';
18
+ import { Tree, TreeModel, TreeProps, defaultTreeProps } from '@theia/core/lib/browser';
19
+ import { createFileTreeContainer, FileTreeModel, FileTreeWidget } from '../file-tree';
20
+ import { OpenFileDialog, OpenFileDialogProps, SaveFileDialog, SaveFileDialogProps } from './file-dialog';
21
+ import { FileDialogModel } from './file-dialog-model';
22
+ import { FileDialogWidget } from './file-dialog-widget';
23
+ import { FileDialogTree } from './file-dialog-tree';
24
+
25
+ export function createFileDialogContainer(parent: interfaces.Container): Container {
26
+ const child = createFileTreeContainer(parent);
27
+
28
+ child.unbind(FileTreeModel);
29
+ child.bind(FileDialogModel).toSelf();
30
+ child.rebind(TreeModel).toService(FileDialogModel);
31
+
32
+ child.unbind(FileTreeWidget);
33
+ child.bind(FileDialogWidget).toSelf();
34
+
35
+ child.bind(FileDialogTree).toSelf();
36
+ child.rebind(Tree).toService(FileDialogTree);
37
+
38
+ return child;
39
+ }
40
+
41
+ export function createOpenFileDialogContainer(parent: interfaces.Container, props: OpenFileDialogProps): Container {
42
+ const container = createFileDialogContainer(parent);
43
+ container.rebind(TreeProps).toConstantValue({
44
+ ...defaultTreeProps,
45
+ multiSelect: props.canSelectMany,
46
+ search: true
47
+ });
48
+
49
+ container.bind(OpenFileDialogProps).toConstantValue(props);
50
+ container.bind(OpenFileDialog).toSelf();
51
+
52
+ return container;
53
+ }
54
+
55
+ export function createSaveFileDialogContainer(parent: interfaces.Container, props: SaveFileDialogProps): Container {
56
+ const container = createFileDialogContainer(parent);
57
+ container.rebind(TreeProps).toConstantValue({
58
+ ...defaultTreeProps,
59
+ multiSelect: false,
60
+ search: true
61
+ });
62
+
63
+ container.bind(SaveFileDialogProps).toConstantValue(props);
64
+ container.bind(SaveFileDialog).toSelf();
65
+
66
+ return container;
67
+ }
@@ -1,59 +1,59 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2023 Ericsson and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { nls } from '@theia/core';
18
- import { ReactRenderer } from '@theia/core/lib/browser';
19
- import { inject, postConstruct } from '@theia/core/shared/inversify';
20
- import * as React from '@theia/core/shared/react';
21
- import { FileDialogTree } from './file-dialog-tree';
22
-
23
- const TOGGLE_HIDDEN_PANEL_CLASS = 'theia-ToggleHiddenPanel';
24
- const TOGGLE_HIDDEN_CONTAINER_CLASS = 'theia-ToggleHiddenInputContainer';
25
- const CHECKBOX_CLASS = 'theia-ToggleHiddenInputCheckbox';
26
-
27
- export const HiddenFilesToggleRendererFactory = Symbol('HiddenFilesToggleRendererFactory');
28
- export interface HiddenFilesToggleRendererFactory {
29
- (fileDialogTree: FileDialogTree): FileDialogHiddenFilesToggleRenderer;
30
- }
31
- export class FileDialogHiddenFilesToggleRenderer extends ReactRenderer {
32
- @inject(FileDialogTree) fileDialogTree: FileDialogTree;
33
-
34
- @postConstruct()
35
- protected init(): void {
36
- this.host.classList.add(TOGGLE_HIDDEN_PANEL_CLASS);
37
- this.render();
38
- }
39
-
40
- protected readonly handleCheckboxChanged = (e: React.ChangeEvent<HTMLInputElement>): void => this.onCheckboxChanged(e);
41
- protected override doRender(): React.ReactNode {
42
- return (
43
- <div className={TOGGLE_HIDDEN_CONTAINER_CLASS}>
44
- {nls.localize('theia/fileDialog/showHidden', 'Show hidden files')}
45
- <input
46
- type='checkbox'
47
- className={CHECKBOX_CLASS}
48
- onChange={this.handleCheckboxChanged}
49
- />
50
- </div>
51
- );
52
- }
53
-
54
- protected onCheckboxChanged(e: React.ChangeEvent<HTMLInputElement>): void {
55
- const { checked } = e.target;
56
- this.fileDialogTree.showHidden = checked;
57
- e.stopPropagation();
58
- }
59
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2023 Ericsson and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { nls } from '@theia/core';
18
+ import { ReactRenderer } from '@theia/core/lib/browser';
19
+ import { inject, postConstruct } from '@theia/core/shared/inversify';
20
+ import * as React from '@theia/core/shared/react';
21
+ import { FileDialogTree } from './file-dialog-tree';
22
+
23
+ const TOGGLE_HIDDEN_PANEL_CLASS = 'theia-ToggleHiddenPanel';
24
+ const TOGGLE_HIDDEN_CONTAINER_CLASS = 'theia-ToggleHiddenInputContainer';
25
+ const CHECKBOX_CLASS = 'theia-ToggleHiddenInputCheckbox';
26
+
27
+ export const HiddenFilesToggleRendererFactory = Symbol('HiddenFilesToggleRendererFactory');
28
+ export interface HiddenFilesToggleRendererFactory {
29
+ (fileDialogTree: FileDialogTree): FileDialogHiddenFilesToggleRenderer;
30
+ }
31
+ export class FileDialogHiddenFilesToggleRenderer extends ReactRenderer {
32
+ @inject(FileDialogTree) fileDialogTree: FileDialogTree;
33
+
34
+ @postConstruct()
35
+ protected init(): void {
36
+ this.host.classList.add(TOGGLE_HIDDEN_PANEL_CLASS);
37
+ this.render();
38
+ }
39
+
40
+ protected readonly handleCheckboxChanged = (e: React.ChangeEvent<HTMLInputElement>): void => this.onCheckboxChanged(e);
41
+ protected override doRender(): React.ReactNode {
42
+ return (
43
+ <div className={TOGGLE_HIDDEN_CONTAINER_CLASS}>
44
+ {nls.localize('theia/fileDialog/showHidden', 'Show hidden files')}
45
+ <input
46
+ type='checkbox'
47
+ className={CHECKBOX_CLASS}
48
+ onChange={this.handleCheckboxChanged}
49
+ />
50
+ </div>
51
+ );
52
+ }
53
+
54
+ protected onCheckboxChanged(e: React.ChangeEvent<HTMLInputElement>): void {
55
+ const { checked } = e.target;
56
+ this.fileDialogTree.showHidden = checked;
57
+ e.stopPropagation();
58
+ }
59
+ }