@theia/filesystem 1.53.0-next.4 → 1.53.0-next.55

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 (102) hide show
  1. package/README.md +30 -30
  2. package/lib/browser/file-resource.d.ts +2 -0
  3. package/lib/browser/file-resource.d.ts.map +1 -1
  4. package/lib/browser/file-resource.js +11 -0
  5. package/lib/browser/file-resource.js.map +1 -1
  6. package/lib/browser/file-resource.spec.d.ts +2 -0
  7. package/lib/browser/file-resource.spec.d.ts.map +1 -0
  8. package/lib/browser/file-resource.spec.js +191 -0
  9. package/lib/browser/file-resource.spec.js.map +1 -0
  10. package/lib/browser/file-service.d.ts +1 -0
  11. package/lib/browser/file-service.d.ts.map +1 -1
  12. package/lib/browser/file-service.js +3 -0
  13. package/lib/browser/file-service.js.map +1 -1
  14. package/package.json +4 -4
  15. package/src/browser/breadcrumbs/filepath-breadcrumb.ts +43 -43
  16. package/src/browser/breadcrumbs/filepath-breadcrumbs-container.ts +65 -65
  17. package/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts +129 -129
  18. package/src/browser/download/file-download-command-contribution.ts +83 -83
  19. package/src/browser/download/file-download-frontend-module.ts +25 -25
  20. package/src/browser/download/file-download-service.ts +179 -179
  21. package/src/browser/file-dialog/file-dialog-container.ts +67 -67
  22. package/src/browser/file-dialog/file-dialog-hidden-files-renderer.tsx +59 -59
  23. package/src/browser/file-dialog/file-dialog-model.ts +96 -96
  24. package/src/browser/file-dialog/file-dialog-module.ts +44 -44
  25. package/src/browser/file-dialog/file-dialog-service.ts +99 -99
  26. package/src/browser/file-dialog/file-dialog-tree-filters-renderer.tsx +100 -100
  27. package/src/browser/file-dialog/file-dialog-tree.ts +89 -89
  28. package/src/browser/file-dialog/file-dialog-widget.ts +75 -75
  29. package/src/browser/file-dialog/file-dialog.ts +434 -434
  30. package/src/browser/file-dialog/index.ts +20 -20
  31. package/src/browser/file-resource.spec.ts +255 -0
  32. package/src/browser/file-resource.ts +402 -390
  33. package/src/browser/file-selection.ts +44 -44
  34. package/src/browser/file-service.ts +1845 -1841
  35. package/src/browser/file-tree/file-tree-container.ts +36 -36
  36. package/src/browser/file-tree/file-tree-decorator-adapter.ts +159 -159
  37. package/src/browser/file-tree/file-tree-label-provider.ts +53 -53
  38. package/src/browser/file-tree/file-tree-model.ts +212 -212
  39. package/src/browser/file-tree/file-tree-widget.tsx +327 -327
  40. package/src/browser/file-tree/file-tree.ts +183 -183
  41. package/src/browser/file-tree/index.ts +22 -22
  42. package/src/browser/file-upload-service.ts +547 -547
  43. package/src/browser/filesystem-frontend-contribution.ts +396 -396
  44. package/src/browser/filesystem-frontend-module.ts +77 -77
  45. package/src/browser/filesystem-preferences.ts +139 -139
  46. package/src/browser/filesystem-saveable-service.ts +138 -138
  47. package/src/browser/filesystem-watcher-error-handler.ts +60 -60
  48. package/src/browser/index.ts +21 -21
  49. package/src/browser/location/index.ts +18 -18
  50. package/src/browser/location/location-renderer.tsx +406 -406
  51. package/src/browser/location/location-service.ts +22 -22
  52. package/src/browser/remote-file-service-contribution.ts +38 -38
  53. package/src/browser/style/file-dialog.css +208 -208
  54. package/src/browser/style/file-icons.css +64 -64
  55. package/src/browser/style/filepath-breadcrumbs.css +20 -20
  56. package/src/browser/style/index.css +36 -36
  57. package/src/browser-only/browser-only-filesystem-frontend-module.ts +38 -38
  58. package/src/browser-only/browser-only-filesystem-provider-server.ts +32 -32
  59. package/src/browser-only/browserfs-filesystem-initialization.ts +61 -61
  60. package/src/browser-only/browserfs-filesystem-provider.ts +462 -462
  61. package/src/common/delegating-file-system-provider.ts +226 -226
  62. package/src/common/download/README.md +30 -30
  63. package/src/common/download/file-download-data.ts +27 -27
  64. package/src/common/file-upload.ts +17 -17
  65. package/src/common/files.spec.ts +51 -51
  66. package/src/common/files.ts +997 -997
  67. package/src/common/filesystem-utils.spec.ts +411 -411
  68. package/src/common/filesystem-utils.ts +64 -64
  69. package/src/common/filesystem-watcher-protocol.ts +96 -96
  70. package/src/common/filesystem.ts +43 -43
  71. package/src/common/index.ts +18 -18
  72. package/src/common/io.ts +150 -150
  73. package/src/common/remote-file-system-provider.ts +549 -549
  74. package/src/electron-browser/file-dialog/electron-file-dialog-module.ts +24 -24
  75. package/src/electron-browser/file-dialog/electron-file-dialog-service.ts +165 -165
  76. package/src/electron-browser/preload.ts +31 -31
  77. package/src/electron-common/electron-api.ts +55 -55
  78. package/src/electron-main/electron-api-main.ts +78 -78
  79. package/src/electron-main/electron-main-module.ts +23 -23
  80. package/src/node/disk-file-system-provider.spec.ts +142 -142
  81. package/src/node/disk-file-system-provider.ts +915 -915
  82. package/src/node/download/directory-archiver.spec.ts +104 -104
  83. package/src/node/download/directory-archiver.ts +126 -126
  84. package/src/node/download/file-download-backend-module.ts +32 -32
  85. package/src/node/download/file-download-cache.ts +88 -88
  86. package/src/node/download/file-download-endpoint.ts +63 -63
  87. package/src/node/download/file-download-handler.ts +304 -304
  88. package/src/node/download/test/mock-directory-archiver.ts +30 -30
  89. package/src/node/file-change-collection.spec.ts +110 -110
  90. package/src/node/file-change-collection.ts +78 -78
  91. package/src/node/filesystem-backend-module.ts +140 -140
  92. package/src/node/filesystem-watcher-client.ts +72 -72
  93. package/src/node/filesystem-watcher-dispatcher.ts +82 -82
  94. package/src/node/node-file-upload-service.ts +80 -80
  95. package/src/node/nsfw-watcher/index.ts +45 -45
  96. package/src/node/nsfw-watcher/nsfw-filesystem-service.ts +481 -481
  97. package/src/node/nsfw-watcher/nsfw-filesystem-watcher.spec.ts +182 -182
  98. package/src/node/nsfw-watcher/nsfw-options.ts +23 -23
  99. package/src/typings/dom.webkit.d.ts +77 -77
  100. package/src/typings/mv/index.d.ts +21 -21
  101. package/src/typings/nsfw/index.d.ts +18 -18
  102. package/src/typings/trash/index.d.ts +20 -20
@@ -1,390 +1,402 @@
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 { injectable, inject } from '@theia/core/shared/inversify';
18
- import { Resource, ResourceVersion, ResourceResolver, ResourceError, ResourceSaveOptions } from '@theia/core/lib/common/resource';
19
- import { DisposableCollection } from '@theia/core/lib/common/disposable';
20
- import { Emitter, Event } from '@theia/core/lib/common/event';
21
- import { Readable, ReadableStream } from '@theia/core/lib/common/stream';
22
- import URI from '@theia/core/lib/common/uri';
23
- import { FileOperation, FileOperationError, FileOperationResult, ETAG_DISABLED, FileSystemProviderCapabilities, FileReadStreamOptions, BinarySize } from '../common/files';
24
- import { FileService, TextFileOperationError, TextFileOperationResult } from './file-service';
25
- import { ConfirmDialog, Dialog } from '@theia/core/lib/browser/dialogs';
26
- import { LabelProvider } from '@theia/core/lib/browser/label-provider';
27
- import { GENERAL_MAX_FILE_SIZE_MB } from './filesystem-preferences';
28
- import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
29
- import { nls } from '@theia/core';
30
- import { MarkdownString } from '@theia/core/lib/common/markdown-rendering';
31
-
32
- export interface FileResourceVersion extends ResourceVersion {
33
- readonly encoding: string;
34
- readonly mtime: number;
35
- readonly etag: string;
36
- }
37
- export namespace FileResourceVersion {
38
- export function is(version: ResourceVersion | undefined): version is FileResourceVersion {
39
- return !!version && 'encoding' in version && 'mtime' in version && 'etag' in version;
40
- }
41
- }
42
-
43
- export interface FileResourceOptions {
44
- readOnly: boolean | MarkdownString
45
- shouldOverwrite: () => Promise<boolean>
46
- shouldOpenAsText: (error: string) => Promise<boolean>
47
- }
48
-
49
- export class FileResource implements Resource {
50
-
51
- protected acceptTextOnly = true;
52
- protected limits: FileReadStreamOptions['limits'];
53
-
54
- protected readonly toDispose = new DisposableCollection();
55
- protected readonly onDidChangeContentsEmitter = new Emitter<void>();
56
- readonly onDidChangeContents: Event<void> = this.onDidChangeContentsEmitter.event;
57
-
58
- protected readonly onDidChangeReadOnlyEmitter = new Emitter<boolean | MarkdownString>();
59
- readonly onDidChangeReadOnly: Event<boolean | MarkdownString> = this.onDidChangeReadOnlyEmitter.event;
60
-
61
- protected _version: FileResourceVersion | undefined;
62
- get version(): FileResourceVersion | undefined {
63
- return this._version;
64
- }
65
- get encoding(): string | undefined {
66
- return this._version?.encoding;
67
- }
68
- get readOnly(): boolean | MarkdownString {
69
- return this.options.readOnly;
70
- }
71
-
72
- constructor(
73
- readonly uri: URI,
74
- protected readonly fileService: FileService,
75
- protected readonly options: FileResourceOptions
76
- ) {
77
- this.toDispose.push(this.onDidChangeContentsEmitter);
78
- this.toDispose.push(this.onDidChangeReadOnlyEmitter);
79
- this.toDispose.push(this.fileService.onDidFilesChange(event => {
80
- if (event.contains(this.uri)) {
81
- this.sync();
82
- }
83
- }));
84
- this.toDispose.push(this.fileService.onDidRunOperation(e => {
85
- if ((e.isOperation(FileOperation.DELETE) || e.isOperation(FileOperation.MOVE)) && e.resource.isEqualOrParent(this.uri)) {
86
- this.sync();
87
- }
88
- }));
89
- try {
90
- this.toDispose.push(this.fileService.watch(this.uri));
91
- } catch (e) {
92
- console.error(e);
93
- }
94
- this.updateSavingContentChanges();
95
- this.toDispose.push(this.fileService.onDidChangeFileSystemProviderCapabilities(async e => {
96
- if (e.scheme === this.uri.scheme) {
97
- this.updateReadOnly();
98
- }
99
- }));
100
- this.toDispose.push(this.fileService.onDidChangeFileSystemProviderReadOnlyMessage(async e => {
101
- if (e.scheme === this.uri.scheme) {
102
- this.updateReadOnly();
103
- }
104
- }));
105
- }
106
-
107
- protected async updateReadOnly(): Promise<void> {
108
- const oldReadOnly = this.options.readOnly;
109
- const readOnlyMessage = this.fileService.getReadOnlyMessage(this.uri);
110
- if (readOnlyMessage) {
111
- this.options.readOnly = readOnlyMessage;
112
- } else {
113
- this.options.readOnly = this.fileService.hasCapability(this.uri, FileSystemProviderCapabilities.Readonly);
114
- }
115
- if (this.options.readOnly !== oldReadOnly) {
116
- this.updateSavingContentChanges();
117
- this.onDidChangeReadOnlyEmitter.fire(this.options.readOnly);
118
- }
119
- }
120
-
121
- dispose(): void {
122
- this.toDispose.dispose();
123
- }
124
-
125
- async readContents(options?: { encoding?: string }): Promise<string> {
126
- try {
127
- const encoding = options?.encoding || this.version?.encoding;
128
- const stat = await this.fileService.read(this.uri, {
129
- encoding,
130
- etag: ETAG_DISABLED,
131
- acceptTextOnly: this.acceptTextOnly,
132
- limits: this.limits
133
- });
134
- this._version = {
135
- encoding: stat.encoding,
136
- etag: stat.etag,
137
- mtime: stat.mtime
138
- };
139
- return stat.value;
140
- } catch (e) {
141
- if (e instanceof TextFileOperationError && e.textFileOperationResult === TextFileOperationResult.FILE_IS_BINARY) {
142
- if (await this.shouldOpenAsText(nls.localize('theia/filesystem/fileResource/binaryTitle', 'The file is either binary or uses an unsupported text encoding.'))) {
143
- this.acceptTextOnly = false;
144
- return this.readContents(options);
145
- }
146
- } else if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_TOO_LARGE) {
147
- const stat = await this.fileService.resolve(this.uri, { resolveMetadata: true });
148
- const maxFileSize = GENERAL_MAX_FILE_SIZE_MB * 1024 * 1024;
149
- if (this.limits?.size !== maxFileSize && await this.shouldOpenAsText(nls.localize(
150
- 'theia/filesystem/fileResource/largeFileTitle', 'The file is too large ({0}).', BinarySize.formatSize(stat.size)))) {
151
- this.limits = {
152
- size: maxFileSize
153
- };
154
- return this.readContents(options);
155
- }
156
- } else if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_NOT_FOUND) {
157
- this._version = undefined;
158
- const { message, stack } = e;
159
- throw ResourceError.NotFound({
160
- message, stack,
161
- data: {
162
- uri: this.uri
163
- }
164
- });
165
- }
166
- throw e;
167
- }
168
- }
169
-
170
- async readStream(options?: { encoding?: string }): Promise<ReadableStream<string>> {
171
- try {
172
- const encoding = options?.encoding || this.version?.encoding;
173
- const stat = await this.fileService.readStream(this.uri, {
174
- encoding,
175
- etag: ETAG_DISABLED,
176
- acceptTextOnly: this.acceptTextOnly,
177
- limits: this.limits
178
- });
179
- this._version = {
180
- encoding: stat.encoding,
181
- etag: stat.etag,
182
- mtime: stat.mtime
183
- };
184
- return stat.value;
185
- } catch (e) {
186
- if (e instanceof TextFileOperationError && e.textFileOperationResult === TextFileOperationResult.FILE_IS_BINARY) {
187
- if (await this.shouldOpenAsText(nls.localize('theia/filesystem/fileResource/binaryTitle', 'The file is either binary or uses an unsupported text encoding.'))) {
188
- this.acceptTextOnly = false;
189
- return this.readStream(options);
190
- }
191
- } else if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_TOO_LARGE) {
192
- const stat = await this.fileService.resolve(this.uri, { resolveMetadata: true });
193
- const maxFileSize = GENERAL_MAX_FILE_SIZE_MB * 1024 * 1024;
194
- if (this.limits?.size !== maxFileSize && await this.shouldOpenAsText(nls.localize(
195
- 'theia/filesystem/fileResource/largeFileTitle', 'The file is too large ({0}).', BinarySize.formatSize(stat.size)))) {
196
- this.limits = {
197
- size: maxFileSize
198
- };
199
- return this.readStream(options);
200
- }
201
- } else if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_NOT_FOUND) {
202
- this._version = undefined;
203
- const { message, stack } = e;
204
- throw ResourceError.NotFound({
205
- message, stack,
206
- data: {
207
- uri: this.uri
208
- }
209
- });
210
- }
211
- throw e;
212
- }
213
- }
214
-
215
- protected doWrite = async (content: string | Readable<string>, options?: ResourceSaveOptions): Promise<void> => {
216
- const version = options?.version || this._version;
217
- const current = FileResourceVersion.is(version) ? version : undefined;
218
- const etag = current?.etag;
219
- try {
220
- const stat = await this.fileService.write(this.uri, content, {
221
- encoding: options?.encoding,
222
- overwriteEncoding: options?.overwriteEncoding,
223
- etag,
224
- mtime: current?.mtime
225
- });
226
- this._version = {
227
- etag: stat.etag,
228
- mtime: stat.mtime,
229
- encoding: stat.encoding
230
- };
231
- } catch (e) {
232
- if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_MODIFIED_SINCE) {
233
- if (etag !== ETAG_DISABLED && await this.shouldOverwrite()) {
234
- return this.doWrite(content, { ...options, version: { stat: { ...current, etag: ETAG_DISABLED } } });
235
- }
236
- const { message, stack } = e;
237
- throw ResourceError.OutOfSync({ message, stack, data: { uri: this.uri } });
238
- }
239
- throw e;
240
- }
241
- };
242
-
243
- saveStream?: Resource['saveStream'];
244
- saveContents?: Resource['saveContents'];
245
- saveContentChanges?: Resource['saveContentChanges'];
246
- protected updateSavingContentChanges(): void {
247
- if (this.readOnly) {
248
- delete this.saveContentChanges;
249
- delete this.saveContents;
250
- delete this.saveStream;
251
- } else {
252
- this.saveContents = this.doWrite;
253
- this.saveStream = this.doWrite;
254
- if (this.fileService.hasCapability(this.uri, FileSystemProviderCapabilities.Update)) {
255
- this.saveContentChanges = this.doSaveContentChanges;
256
- }
257
- }
258
- }
259
- protected doSaveContentChanges: Resource['saveContentChanges'] = async (changes, options) => {
260
- const version = options?.version || this._version;
261
- const current = FileResourceVersion.is(version) ? version : undefined;
262
- if (!current) {
263
- throw ResourceError.NotFound({ message: 'has not been read yet', data: { uri: this.uri } });
264
- }
265
- const etag = current?.etag;
266
- try {
267
- const stat = await this.fileService.update(this.uri, changes, {
268
- readEncoding: current.encoding,
269
- encoding: options?.encoding,
270
- overwriteEncoding: options?.overwriteEncoding,
271
- etag,
272
- mtime: current?.mtime
273
- });
274
- this._version = {
275
- etag: stat.etag,
276
- mtime: stat.mtime,
277
- encoding: stat.encoding
278
- };
279
- } catch (e) {
280
- if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_NOT_FOUND) {
281
- const { message, stack } = e;
282
- throw ResourceError.NotFound({ message, stack, data: { uri: this.uri } });
283
- }
284
- if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_MODIFIED_SINCE) {
285
- const { message, stack } = e;
286
- throw ResourceError.OutOfSync({ message, stack, data: { uri: this.uri } });
287
- }
288
- throw e;
289
- }
290
- };
291
-
292
- async guessEncoding(): Promise<string> {
293
- // TODO limit size
294
- const content = await this.fileService.read(this.uri, { autoGuessEncoding: true });
295
- return content.encoding;
296
- }
297
-
298
- protected async sync(): Promise<void> {
299
- if (await this.isInSync()) {
300
- return;
301
- }
302
- this.onDidChangeContentsEmitter.fire(undefined);
303
- }
304
- protected async isInSync(): Promise<boolean> {
305
- try {
306
- const stat = await this.fileService.resolve(this.uri, { resolveMetadata: true });
307
- return !!this.version && this.version.mtime >= stat.mtime;
308
- } catch {
309
- return !this.version;
310
- }
311
- }
312
-
313
- protected async shouldOverwrite(): Promise<boolean> {
314
- return this.options.shouldOverwrite();
315
- }
316
-
317
- protected async shouldOpenAsText(error: string): Promise<boolean> {
318
- return this.options.shouldOpenAsText(error);
319
- }
320
-
321
- }
322
-
323
- @injectable()
324
- export class FileResourceResolver implements ResourceResolver {
325
-
326
- @inject(FileService)
327
- protected readonly fileService: FileService;
328
-
329
- @inject(LabelProvider)
330
- protected readonly labelProvider: LabelProvider;
331
-
332
- @inject(FrontendApplicationStateService)
333
- protected readonly applicationState: FrontendApplicationStateService;
334
-
335
- async resolve(uri: URI): Promise<FileResource> {
336
- let stat;
337
- try {
338
- stat = await this.fileService.resolve(uri);
339
- } catch (e) {
340
- if (!(e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_NOT_FOUND)) {
341
- throw e;
342
- }
343
- }
344
- if (stat && stat.isDirectory) {
345
- throw new Error('The given uri is a directory: ' + this.labelProvider.getLongName(uri));
346
- }
347
-
348
- const readOnlyMessage = this.fileService.getReadOnlyMessage(uri);
349
- const isFileSystemReadOnly = this.fileService.hasCapability(uri, FileSystemProviderCapabilities.Readonly);
350
- const readOnly = readOnlyMessage ?? (isFileSystemReadOnly ? isFileSystemReadOnly : (stat?.isReadonly ?? false));
351
-
352
- return new FileResource(uri, this.fileService, {
353
- readOnly: readOnly,
354
- shouldOverwrite: () => this.shouldOverwrite(uri),
355
- shouldOpenAsText: error => this.shouldOpenAsText(uri, error)
356
- });
357
- }
358
-
359
- protected async shouldOverwrite(uri: URI): Promise<boolean> {
360
- const dialog = new ConfirmDialog({
361
- title: nls.localize('theia/filesystem/fileResource/overwriteTitle', "The file '{0}' has been changed on the file system.", this.labelProvider.getName(uri)),
362
- msg: nls.localize('theia/fileSystem/fileResource/overWriteBody',
363
- "Do you want to overwrite the changes made to '{0}' on the file system?", this.labelProvider.getLongName(uri)),
364
- ok: Dialog.YES,
365
- cancel: Dialog.NO,
366
- });
367
- return !!await dialog.open();
368
- }
369
-
370
- protected async shouldOpenAsText(uri: URI, error: string): Promise<boolean> {
371
- switch (this.applicationState.state) {
372
- case 'init':
373
- case 'started_contributions':
374
- case 'attached_shell':
375
- return true; // We're restoring state - assume that we should open files that were previously open.
376
- default: {
377
- const dialog = new ConfirmDialog({
378
- title: error,
379
- msg: nls.localize('theia/filesystem/fileResource/binaryFileQuery',
380
- "Opening it might take some time and might make the IDE unresponsive. Do you want to open '{0}' anyway?", this.labelProvider.getLongName(uri)
381
- ),
382
- ok: Dialog.YES,
383
- cancel: Dialog.NO,
384
- });
385
- return !!await dialog.open();
386
- }
387
- }
388
- }
389
-
390
- }
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 { injectable, inject } from '@theia/core/shared/inversify';
18
+ import { Resource, ResourceVersion, ResourceResolver, ResourceError, ResourceSaveOptions } from '@theia/core/lib/common/resource';
19
+ import { DisposableCollection } from '@theia/core/lib/common/disposable';
20
+ import { Emitter, Event } from '@theia/core/lib/common/event';
21
+ import { Readable, ReadableStream } from '@theia/core/lib/common/stream';
22
+ import URI from '@theia/core/lib/common/uri';
23
+ import { FileOperation, FileOperationError, FileOperationResult, ETAG_DISABLED, FileSystemProviderCapabilities, FileReadStreamOptions, BinarySize } from '../common/files';
24
+ import { FileService, TextFileOperationError, TextFileOperationResult } from './file-service';
25
+ import { ConfirmDialog, Dialog } from '@theia/core/lib/browser/dialogs';
26
+ import { LabelProvider } from '@theia/core/lib/browser/label-provider';
27
+ import { GENERAL_MAX_FILE_SIZE_MB } from './filesystem-preferences';
28
+ import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
29
+ import { nls } from '@theia/core';
30
+ import { MarkdownString } from '@theia/core/lib/common/markdown-rendering';
31
+ import { Mutex } from 'async-mutex';
32
+
33
+ export interface FileResourceVersion extends ResourceVersion {
34
+ readonly encoding: string;
35
+ readonly mtime: number;
36
+ readonly etag: string;
37
+ }
38
+ export namespace FileResourceVersion {
39
+ export function is(version: ResourceVersion | undefined): version is FileResourceVersion {
40
+ return !!version && 'encoding' in version && 'mtime' in version && 'etag' in version;
41
+ }
42
+ }
43
+
44
+ export interface FileResourceOptions {
45
+ readOnly: boolean | MarkdownString
46
+ shouldOverwrite: () => Promise<boolean>
47
+ shouldOpenAsText: (error: string) => Promise<boolean>
48
+ }
49
+
50
+ export class FileResource implements Resource {
51
+
52
+ protected acceptTextOnly = true;
53
+ protected limits: FileReadStreamOptions['limits'];
54
+
55
+ protected readonly toDispose = new DisposableCollection();
56
+ protected readonly onDidChangeContentsEmitter = new Emitter<void>();
57
+ readonly onDidChangeContents: Event<void> = this.onDidChangeContentsEmitter.event;
58
+
59
+ protected readonly onDidChangeReadOnlyEmitter = new Emitter<boolean | MarkdownString>();
60
+ readonly onDidChangeReadOnly: Event<boolean | MarkdownString> = this.onDidChangeReadOnlyEmitter.event;
61
+
62
+ protected _version: FileResourceVersion | undefined;
63
+ get version(): FileResourceVersion | undefined {
64
+ return this._version;
65
+ }
66
+ get encoding(): string | undefined {
67
+ return this._version?.encoding;
68
+ }
69
+ get readOnly(): boolean | MarkdownString {
70
+ return this.options.readOnly;
71
+ }
72
+
73
+ protected writingLock = new Mutex();
74
+
75
+ constructor(
76
+ readonly uri: URI,
77
+ protected readonly fileService: FileService,
78
+ protected readonly options: FileResourceOptions
79
+ ) {
80
+ this.toDispose.push(this.onDidChangeContentsEmitter);
81
+ this.toDispose.push(this.onDidChangeReadOnlyEmitter);
82
+ this.toDispose.push(this.fileService.onDidFilesChange(event => {
83
+ if (event.contains(this.uri)) {
84
+ this.sync();
85
+ }
86
+ }));
87
+ this.toDispose.push(this.fileService.onDidRunOperation(e => {
88
+ if ((e.isOperation(FileOperation.DELETE) || e.isOperation(FileOperation.MOVE)) && e.resource.isEqualOrParent(this.uri)) {
89
+ this.sync();
90
+ }
91
+ }));
92
+ try {
93
+ this.toDispose.push(this.fileService.watch(this.uri));
94
+ } catch (e) {
95
+ console.error(e);
96
+ }
97
+ this.updateSavingContentChanges();
98
+ this.toDispose.push(this.fileService.onDidChangeFileSystemProviderCapabilities(async e => {
99
+ if (e.scheme === this.uri.scheme) {
100
+ this.updateReadOnly();
101
+ }
102
+ }));
103
+ this.toDispose.push(this.fileService.onDidChangeFileSystemProviderReadOnlyMessage(async e => {
104
+ if (e.scheme === this.uri.scheme) {
105
+ this.updateReadOnly();
106
+ }
107
+ }));
108
+ }
109
+
110
+ protected async updateReadOnly(): Promise<void> {
111
+ const oldReadOnly = this.options.readOnly;
112
+ const readOnlyMessage = this.fileService.getReadOnlyMessage(this.uri);
113
+ if (readOnlyMessage) {
114
+ this.options.readOnly = readOnlyMessage;
115
+ } else {
116
+ this.options.readOnly = this.fileService.hasCapability(this.uri, FileSystemProviderCapabilities.Readonly);
117
+ }
118
+ if (this.options.readOnly !== oldReadOnly) {
119
+ this.updateSavingContentChanges();
120
+ this.onDidChangeReadOnlyEmitter.fire(this.options.readOnly);
121
+ }
122
+ }
123
+
124
+ dispose(): void {
125
+ this.toDispose.dispose();
126
+ }
127
+
128
+ async readContents(options?: { encoding?: string }): Promise<string> {
129
+ try {
130
+ const encoding = options?.encoding || this.version?.encoding;
131
+ const stat = await this.fileService.read(this.uri, {
132
+ encoding,
133
+ etag: ETAG_DISABLED,
134
+ acceptTextOnly: this.acceptTextOnly,
135
+ limits: this.limits
136
+ });
137
+ this._version = {
138
+ encoding: stat.encoding,
139
+ etag: stat.etag,
140
+ mtime: stat.mtime
141
+ };
142
+ return stat.value;
143
+ } catch (e) {
144
+ if (e instanceof TextFileOperationError && e.textFileOperationResult === TextFileOperationResult.FILE_IS_BINARY) {
145
+ if (await this.shouldOpenAsText(nls.localize('theia/filesystem/fileResource/binaryTitle', 'The file is either binary or uses an unsupported text encoding.'))) {
146
+ this.acceptTextOnly = false;
147
+ return this.readContents(options);
148
+ }
149
+ } else if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_TOO_LARGE) {
150
+ const stat = await this.fileService.resolve(this.uri, { resolveMetadata: true });
151
+ const maxFileSize = GENERAL_MAX_FILE_SIZE_MB * 1024 * 1024;
152
+ if (this.limits?.size !== maxFileSize && await this.shouldOpenAsText(nls.localize(
153
+ 'theia/filesystem/fileResource/largeFileTitle', 'The file is too large ({0}).', BinarySize.formatSize(stat.size)))) {
154
+ this.limits = {
155
+ size: maxFileSize
156
+ };
157
+ return this.readContents(options);
158
+ }
159
+ } else if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_NOT_FOUND) {
160
+ this._version = undefined;
161
+ const { message, stack } = e;
162
+ throw ResourceError.NotFound({
163
+ message, stack,
164
+ data: {
165
+ uri: this.uri
166
+ }
167
+ });
168
+ }
169
+ throw e;
170
+ }
171
+ }
172
+
173
+ async readStream(options?: { encoding?: string }): Promise<ReadableStream<string>> {
174
+ try {
175
+ const encoding = options?.encoding || this.version?.encoding;
176
+ const stat = await this.fileService.readStream(this.uri, {
177
+ encoding,
178
+ etag: ETAG_DISABLED,
179
+ acceptTextOnly: this.acceptTextOnly,
180
+ limits: this.limits
181
+ });
182
+ this._version = {
183
+ encoding: stat.encoding,
184
+ etag: stat.etag,
185
+ mtime: stat.mtime
186
+ };
187
+ return stat.value;
188
+ } catch (e) {
189
+ if (e instanceof TextFileOperationError && e.textFileOperationResult === TextFileOperationResult.FILE_IS_BINARY) {
190
+ if (await this.shouldOpenAsText(nls.localize('theia/filesystem/fileResource/binaryTitle', 'The file is either binary or uses an unsupported text encoding.'))) {
191
+ this.acceptTextOnly = false;
192
+ return this.readStream(options);
193
+ }
194
+ } else if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_TOO_LARGE) {
195
+ const stat = await this.fileService.resolve(this.uri, { resolveMetadata: true });
196
+ const maxFileSize = GENERAL_MAX_FILE_SIZE_MB * 1024 * 1024;
197
+ if (this.limits?.size !== maxFileSize && await this.shouldOpenAsText(nls.localize(
198
+ 'theia/filesystem/fileResource/largeFileTitle', 'The file is too large ({0}).', BinarySize.formatSize(stat.size)))) {
199
+ this.limits = {
200
+ size: maxFileSize
201
+ };
202
+ return this.readStream(options);
203
+ }
204
+ } else if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_NOT_FOUND) {
205
+ this._version = undefined;
206
+ const { message, stack } = e;
207
+ throw ResourceError.NotFound({
208
+ message, stack,
209
+ data: {
210
+ uri: this.uri
211
+ }
212
+ });
213
+ }
214
+ throw e;
215
+ }
216
+ }
217
+
218
+ protected doWrite = async (content: string | Readable<string>, options?: ResourceSaveOptions): Promise<void> => {
219
+ const version = options?.version || this._version;
220
+ const current = FileResourceVersion.is(version) ? version : undefined;
221
+ const etag = current?.etag;
222
+ const releaseLock = await this.writingLock.acquire();
223
+
224
+ try {
225
+ const stat = await this.fileService.write(this.uri, content, {
226
+ encoding: options?.encoding,
227
+ overwriteEncoding: options?.overwriteEncoding,
228
+ etag,
229
+ mtime: current?.mtime
230
+ });
231
+ this._version = {
232
+ etag: stat.etag,
233
+ mtime: stat.mtime,
234
+ encoding: stat.encoding
235
+ };
236
+ } catch (e) {
237
+ if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_MODIFIED_SINCE) {
238
+ if (etag !== ETAG_DISABLED && await this.shouldOverwrite()) {
239
+ return this.doWrite(content, { ...options, version: { stat: { ...current, etag: ETAG_DISABLED } } });
240
+ }
241
+ const { message, stack } = e;
242
+ throw ResourceError.OutOfSync({ message, stack, data: { uri: this.uri } });
243
+ }
244
+ throw e;
245
+ } finally {
246
+ releaseLock();
247
+ }
248
+ };
249
+
250
+ saveStream?: Resource['saveStream'];
251
+ saveContents?: Resource['saveContents'];
252
+ saveContentChanges?: Resource['saveContentChanges'];
253
+ protected updateSavingContentChanges(): void {
254
+ if (this.readOnly) {
255
+ delete this.saveContentChanges;
256
+ delete this.saveContents;
257
+ delete this.saveStream;
258
+ } else {
259
+ this.saveContents = this.doWrite;
260
+ this.saveStream = this.doWrite;
261
+ if (this.fileService.hasCapability(this.uri, FileSystemProviderCapabilities.Update)) {
262
+ this.saveContentChanges = this.doSaveContentChanges;
263
+ }
264
+ }
265
+ }
266
+ protected doSaveContentChanges: Resource['saveContentChanges'] = async (changes, options) => {
267
+ const version = options?.version || this._version;
268
+ const current = FileResourceVersion.is(version) ? version : undefined;
269
+ if (!current) {
270
+ throw ResourceError.NotFound({ message: 'has not been read yet', data: { uri: this.uri } });
271
+ }
272
+ const etag = current?.etag;
273
+ const releaseLock = await this.writingLock.acquire();
274
+
275
+ try {
276
+ const stat = await this.fileService.update(this.uri, changes, {
277
+ readEncoding: current.encoding,
278
+ encoding: options?.encoding,
279
+ overwriteEncoding: options?.overwriteEncoding,
280
+ etag,
281
+ mtime: current?.mtime
282
+ });
283
+ this._version = {
284
+ etag: stat.etag,
285
+ mtime: stat.mtime,
286
+ encoding: stat.encoding
287
+ };
288
+ } catch (e) {
289
+ if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_NOT_FOUND) {
290
+ const { message, stack } = e;
291
+ throw ResourceError.NotFound({ message, stack, data: { uri: this.uri } });
292
+ }
293
+ if (e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_MODIFIED_SINCE) {
294
+ const { message, stack } = e;
295
+ throw ResourceError.OutOfSync({ message, stack, data: { uri: this.uri } });
296
+ }
297
+ throw e;
298
+ } finally {
299
+ releaseLock();
300
+ }
301
+ };
302
+
303
+ async guessEncoding(): Promise<string> {
304
+ // TODO limit size
305
+ const content = await this.fileService.read(this.uri, { autoGuessEncoding: true });
306
+ return content.encoding;
307
+ }
308
+
309
+ protected async sync(): Promise<void> {
310
+ if (await this.isInSync()) {
311
+ return;
312
+ }
313
+ this.onDidChangeContentsEmitter.fire(undefined);
314
+ }
315
+ protected async isInSync(): Promise<boolean> {
316
+ try {
317
+ await this.writingLock.waitForUnlock();
318
+ const stat = await this.fileService.resolve(this.uri, { resolveMetadata: true });
319
+ return !!this.version && this.version.mtime >= stat.mtime;
320
+ } catch {
321
+ return !this.version;
322
+ }
323
+ }
324
+
325
+ protected async shouldOverwrite(): Promise<boolean> {
326
+ return this.options.shouldOverwrite();
327
+ }
328
+
329
+ protected async shouldOpenAsText(error: string): Promise<boolean> {
330
+ return this.options.shouldOpenAsText(error);
331
+ }
332
+
333
+ }
334
+
335
+ @injectable()
336
+ export class FileResourceResolver implements ResourceResolver {
337
+
338
+ @inject(FileService)
339
+ protected readonly fileService: FileService;
340
+
341
+ @inject(LabelProvider)
342
+ protected readonly labelProvider: LabelProvider;
343
+
344
+ @inject(FrontendApplicationStateService)
345
+ protected readonly applicationState: FrontendApplicationStateService;
346
+
347
+ async resolve(uri: URI): Promise<FileResource> {
348
+ let stat;
349
+ try {
350
+ stat = await this.fileService.resolve(uri);
351
+ } catch (e) {
352
+ if (!(e instanceof FileOperationError && e.fileOperationResult === FileOperationResult.FILE_NOT_FOUND)) {
353
+ throw e;
354
+ }
355
+ }
356
+ if (stat && stat.isDirectory) {
357
+ throw new Error('The given uri is a directory: ' + this.labelProvider.getLongName(uri));
358
+ }
359
+
360
+ const readOnlyMessage = this.fileService.getReadOnlyMessage(uri);
361
+ const isFileSystemReadOnly = this.fileService.hasCapability(uri, FileSystemProviderCapabilities.Readonly);
362
+ const readOnly = readOnlyMessage ?? (isFileSystemReadOnly ? isFileSystemReadOnly : (stat?.isReadonly ?? false));
363
+
364
+ return new FileResource(uri, this.fileService, {
365
+ readOnly: readOnly,
366
+ shouldOverwrite: () => this.shouldOverwrite(uri),
367
+ shouldOpenAsText: error => this.shouldOpenAsText(uri, error)
368
+ });
369
+ }
370
+
371
+ protected async shouldOverwrite(uri: URI): Promise<boolean> {
372
+ const dialog = new ConfirmDialog({
373
+ title: nls.localize('theia/filesystem/fileResource/overwriteTitle', "The file '{0}' has been changed on the file system.", this.labelProvider.getName(uri)),
374
+ msg: nls.localize('theia/fileSystem/fileResource/overWriteBody',
375
+ "Do you want to overwrite the changes made to '{0}' on the file system?", this.labelProvider.getLongName(uri)),
376
+ ok: Dialog.YES,
377
+ cancel: Dialog.NO,
378
+ });
379
+ return !!await dialog.open();
380
+ }
381
+
382
+ protected async shouldOpenAsText(uri: URI, error: string): Promise<boolean> {
383
+ switch (this.applicationState.state) {
384
+ case 'init':
385
+ case 'started_contributions':
386
+ case 'attached_shell':
387
+ return true; // We're restoring state - assume that we should open files that were previously open.
388
+ default: {
389
+ const dialog = new ConfirmDialog({
390
+ title: error,
391
+ msg: nls.localize('theia/filesystem/fileResource/binaryFileQuery',
392
+ "Opening it might take some time and might make the IDE unresponsive. Do you want to open '{0}' anyway?", this.labelProvider.getLongName(uri)
393
+ ),
394
+ ok: Dialog.YES,
395
+ cancel: Dialog.NO,
396
+ });
397
+ return !!await dialog.open();
398
+ }
399
+ }
400
+ }
401
+
402
+ }