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

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 (90) hide show
  1. package/README.md +30 -30
  2. package/package.json +3 -3
  3. package/src/browser/breadcrumbs/filepath-breadcrumb.ts +43 -43
  4. package/src/browser/breadcrumbs/filepath-breadcrumbs-container.ts +65 -65
  5. package/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts +129 -129
  6. package/src/browser/download/file-download-command-contribution.ts +83 -83
  7. package/src/browser/download/file-download-frontend-module.ts +25 -25
  8. package/src/browser/download/file-download-service.ts +179 -179
  9. package/src/browser/file-dialog/file-dialog-container.ts +67 -67
  10. package/src/browser/file-dialog/file-dialog-hidden-files-renderer.tsx +59 -59
  11. package/src/browser/file-dialog/file-dialog-model.ts +96 -96
  12. package/src/browser/file-dialog/file-dialog-module.ts +44 -44
  13. package/src/browser/file-dialog/file-dialog-service.ts +99 -99
  14. package/src/browser/file-dialog/file-dialog-tree-filters-renderer.tsx +100 -100
  15. package/src/browser/file-dialog/file-dialog-tree.ts +89 -89
  16. package/src/browser/file-dialog/file-dialog-widget.ts +75 -75
  17. package/src/browser/file-dialog/file-dialog.ts +434 -434
  18. package/src/browser/file-dialog/index.ts +20 -20
  19. package/src/browser/file-resource.spec.ts +255 -255
  20. package/src/browser/file-resource.ts +402 -402
  21. package/src/browser/file-selection.ts +44 -44
  22. package/src/browser/file-service.ts +1845 -1845
  23. package/src/browser/file-tree/file-tree-container.ts +36 -36
  24. package/src/browser/file-tree/file-tree-decorator-adapter.ts +159 -159
  25. package/src/browser/file-tree/file-tree-label-provider.ts +53 -53
  26. package/src/browser/file-tree/file-tree-model.ts +212 -212
  27. package/src/browser/file-tree/file-tree-widget.tsx +327 -327
  28. package/src/browser/file-tree/file-tree.ts +183 -183
  29. package/src/browser/file-tree/index.ts +22 -22
  30. package/src/browser/file-upload-service.ts +547 -547
  31. package/src/browser/filesystem-frontend-contribution.ts +396 -396
  32. package/src/browser/filesystem-frontend-module.ts +77 -77
  33. package/src/browser/filesystem-preferences.ts +139 -139
  34. package/src/browser/filesystem-saveable-service.ts +138 -138
  35. package/src/browser/filesystem-watcher-error-handler.ts +60 -60
  36. package/src/browser/index.ts +21 -21
  37. package/src/browser/location/index.ts +18 -18
  38. package/src/browser/location/location-renderer.tsx +406 -406
  39. package/src/browser/location/location-service.ts +22 -22
  40. package/src/browser/remote-file-service-contribution.ts +38 -38
  41. package/src/browser/style/file-dialog.css +208 -208
  42. package/src/browser/style/file-icons.css +64 -64
  43. package/src/browser/style/filepath-breadcrumbs.css +20 -20
  44. package/src/browser/style/index.css +36 -36
  45. package/src/browser-only/browser-only-filesystem-frontend-module.ts +38 -38
  46. package/src/browser-only/browser-only-filesystem-provider-server.ts +32 -32
  47. package/src/browser-only/browserfs-filesystem-initialization.ts +61 -61
  48. package/src/browser-only/browserfs-filesystem-provider.ts +462 -462
  49. package/src/common/delegating-file-system-provider.ts +226 -226
  50. package/src/common/download/README.md +30 -30
  51. package/src/common/download/file-download-data.ts +27 -27
  52. package/src/common/file-upload.ts +17 -17
  53. package/src/common/files.spec.ts +51 -51
  54. package/src/common/files.ts +997 -997
  55. package/src/common/filesystem-utils.spec.ts +411 -411
  56. package/src/common/filesystem-utils.ts +64 -64
  57. package/src/common/filesystem-watcher-protocol.ts +96 -96
  58. package/src/common/filesystem.ts +43 -43
  59. package/src/common/index.ts +18 -18
  60. package/src/common/io.ts +150 -150
  61. package/src/common/remote-file-system-provider.ts +549 -549
  62. package/src/electron-browser/file-dialog/electron-file-dialog-module.ts +24 -24
  63. package/src/electron-browser/file-dialog/electron-file-dialog-service.ts +165 -165
  64. package/src/electron-browser/preload.ts +31 -31
  65. package/src/electron-common/electron-api.ts +55 -55
  66. package/src/electron-main/electron-api-main.ts +78 -78
  67. package/src/electron-main/electron-main-module.ts +23 -23
  68. package/src/node/disk-file-system-provider.spec.ts +142 -142
  69. package/src/node/disk-file-system-provider.ts +915 -915
  70. package/src/node/download/directory-archiver.spec.ts +104 -104
  71. package/src/node/download/directory-archiver.ts +126 -126
  72. package/src/node/download/file-download-backend-module.ts +32 -32
  73. package/src/node/download/file-download-cache.ts +88 -88
  74. package/src/node/download/file-download-endpoint.ts +63 -63
  75. package/src/node/download/file-download-handler.ts +304 -304
  76. package/src/node/download/test/mock-directory-archiver.ts +30 -30
  77. package/src/node/file-change-collection.spec.ts +110 -110
  78. package/src/node/file-change-collection.ts +78 -78
  79. package/src/node/filesystem-backend-module.ts +140 -140
  80. package/src/node/filesystem-watcher-client.ts +72 -72
  81. package/src/node/filesystem-watcher-dispatcher.ts +82 -82
  82. package/src/node/node-file-upload-service.ts +80 -80
  83. package/src/node/nsfw-watcher/index.ts +45 -45
  84. package/src/node/nsfw-watcher/nsfw-filesystem-service.ts +481 -481
  85. package/src/node/nsfw-watcher/nsfw-filesystem-watcher.spec.ts +182 -182
  86. package/src/node/nsfw-watcher/nsfw-options.ts +23 -23
  87. package/src/typings/dom.webkit.d.ts +77 -77
  88. package/src/typings/mv/index.d.ts +21 -21
  89. package/src/typings/nsfw/index.d.ts +18 -18
  90. package/src/typings/trash/index.d.ts +20 -20
@@ -1,434 +1,434 @@
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 { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
18
- import { Message } from '@theia/core/shared/@phosphor/messaging';
19
- import { Disposable, MaybeArray, nls } from '@theia/core/lib/common';
20
- import { AbstractDialog, DialogProps, setEnabled, createIconButton, Widget, codiconArray, Key, LabelProvider } from '@theia/core/lib/browser';
21
- import { FileStatNode } from '../file-tree';
22
- import { LocationListRenderer, LocationListRendererFactory } from '../location';
23
- import { FileDialogModel } from './file-dialog-model';
24
- import { FileDialogWidget } from './file-dialog-widget';
25
- import { FileDialogTreeFiltersRenderer, FileDialogTreeFilters, FileDialogTreeFiltersRendererFactory } from './file-dialog-tree-filters-renderer';
26
- import URI from '@theia/core/lib/common/uri';
27
- import { Panel } from '@theia/core/shared/@phosphor/widgets';
28
- import * as DOMPurify from '@theia/core/shared/dompurify';
29
- import { FileDialogHiddenFilesToggleRenderer, HiddenFilesToggleRendererFactory } from './file-dialog-hidden-files-renderer';
30
-
31
- export const OpenFileDialogFactory = Symbol('OpenFileDialogFactory');
32
- export interface OpenFileDialogFactory {
33
- (props: OpenFileDialogProps): OpenFileDialog;
34
- }
35
-
36
- export const SaveFileDialogFactory = Symbol('SaveFileDialogFactory');
37
- export interface SaveFileDialogFactory {
38
- (props: SaveFileDialogProps): SaveFileDialog;
39
- }
40
-
41
- export const SAVE_DIALOG_CLASS = 'theia-SaveFileDialog';
42
-
43
- export const NAVIGATION_PANEL_CLASS = 'theia-NavigationPanel';
44
- export const NAVIGATION_BACK_CLASS = 'theia-NavigationBack';
45
- export const NAVIGATION_FORWARD_CLASS = 'theia-NavigationForward';
46
- export const NAVIGATION_HOME_CLASS = 'theia-NavigationHome';
47
- export const NAVIGATION_UP_CLASS = 'theia-NavigationUp';
48
- export const NAVIGATION_LOCATION_LIST_PANEL_CLASS = 'theia-LocationListPanel';
49
-
50
- export const FILTERS_PANEL_CLASS = 'theia-FiltersPanel';
51
- export const FILTERS_LABEL_CLASS = 'theia-FiltersLabel';
52
- export const FILTERS_LIST_PANEL_CLASS = 'theia-FiltersListPanel';
53
-
54
- export const FILENAME_PANEL_CLASS = 'theia-FileNamePanel';
55
- export const FILENAME_LABEL_CLASS = 'theia-FileNameLabel';
56
- export const FILENAME_TEXTFIELD_CLASS = 'theia-FileNameTextField';
57
-
58
- export const CONTROL_PANEL_CLASS = 'theia-ControlPanel';
59
- export const TOOLBAR_ITEM_TRANSFORM_TIMEOUT = 100;
60
-
61
- export class FileDialogProps extends DialogProps {
62
-
63
- /**
64
- * A set of file filters that are used by the dialog. Each entry is a human readable label,
65
- * like "TypeScript", and an array of extensions, e.g.
66
- * ```ts
67
- * {
68
- * 'Images': ['png', 'jpg']
69
- * 'TypeScript': ['ts', 'tsx']
70
- * }
71
- * ```
72
- */
73
- filters?: FileDialogTreeFilters;
74
-
75
- /**
76
- * Determines if the dialog window should be modal.
77
- * Defaults to `true`.
78
- */
79
- modal?: boolean;
80
-
81
- }
82
-
83
- @injectable()
84
- export class OpenFileDialogProps extends FileDialogProps {
85
-
86
- /**
87
- * A human-readable string for the accept button.
88
- */
89
- openLabel?: string;
90
-
91
- /**
92
- * Allow to select files, defaults to `true`.
93
- */
94
- canSelectFiles?: boolean;
95
-
96
- /**
97
- * Allow to select folders, defaults to `false`.
98
- */
99
- canSelectFolders?: boolean;
100
-
101
- /**
102
- * Allow to select many files or folders.
103
- */
104
- canSelectMany?: boolean;
105
-
106
- }
107
-
108
- @injectable()
109
- export class SaveFileDialogProps extends FileDialogProps {
110
-
111
- /**
112
- * A human-readable string for the accept button.
113
- */
114
- saveLabel?: string;
115
-
116
- /**
117
- * A human-readable value for the input.
118
- */
119
- inputValue?: string;
120
-
121
- }
122
-
123
- export abstract class FileDialog<T> extends AbstractDialog<T> {
124
-
125
- protected back: HTMLSpanElement;
126
- protected forward: HTMLSpanElement;
127
- protected home: HTMLSpanElement;
128
- protected up: HTMLSpanElement;
129
- protected locationListRenderer: LocationListRenderer;
130
- protected treeFiltersRenderer: FileDialogTreeFiltersRenderer | undefined;
131
- protected hiddenFilesToggleRenderer: FileDialogHiddenFilesToggleRenderer;
132
- protected treePanel: Panel;
133
-
134
- @inject(FileDialogWidget) readonly widget: FileDialogWidget;
135
- @inject(LocationListRendererFactory) readonly locationListFactory: LocationListRendererFactory;
136
- @inject(FileDialogTreeFiltersRendererFactory) readonly treeFiltersFactory: FileDialogTreeFiltersRendererFactory;
137
- @inject(HiddenFilesToggleRendererFactory) readonly hiddenFilesToggleFactory: HiddenFilesToggleRendererFactory;
138
-
139
- constructor(
140
- @inject(FileDialogProps) override readonly props: FileDialogProps
141
- ) {
142
- super(props);
143
- }
144
-
145
- @postConstruct()
146
- init(): void {
147
- this.treePanel = new Panel();
148
- this.treePanel.addWidget(this.widget);
149
- this.toDispose.push(this.treePanel);
150
- this.toDispose.push(this.model.onChanged(() => this.update()));
151
- this.toDispose.push(this.model.onDidOpenFile(() => this.accept()));
152
- this.toDispose.push(this.model.onSelectionChanged(() => this.update()));
153
-
154
- const navigationPanel = document.createElement('div');
155
- navigationPanel.classList.add(NAVIGATION_PANEL_CLASS);
156
- this.contentNode.appendChild(navigationPanel);
157
-
158
- navigationPanel.appendChild(this.back = createIconButton(...codiconArray('chevron-left', true)));
159
- this.back.classList.add(NAVIGATION_BACK_CLASS);
160
- this.back.title = nls.localize('theia/filesystem/dialog/navigateBack', 'Navigate Back');
161
-
162
- navigationPanel.appendChild(this.forward = createIconButton(...codiconArray('chevron-right', true)));
163
- this.forward.classList.add(NAVIGATION_FORWARD_CLASS);
164
- this.forward.title = nls.localize('theia/filesystem/dialog/navigateForward', 'Navigate Forward');
165
-
166
- navigationPanel.appendChild(this.home = createIconButton(...codiconArray('home', true)));
167
- this.home.classList.add(NAVIGATION_HOME_CLASS);
168
- this.home.title = nls.localize('theia/filesystem/dialog/initialLocation', 'Go To Initial Location');
169
-
170
- navigationPanel.appendChild(this.up = createIconButton(...codiconArray('arrow-up', true)));
171
- this.up.classList.add(NAVIGATION_UP_CLASS);
172
- this.up.title = nls.localize('theia/filesystem/dialog/navigateUp', 'Navigate Up One Directory');
173
-
174
- const locationListRendererHost = document.createElement('div');
175
- this.locationListRenderer = this.locationListFactory({ model: this.model, host: locationListRendererHost });
176
- this.toDispose.push(this.locationListRenderer);
177
- this.locationListRenderer.host.classList.add(NAVIGATION_LOCATION_LIST_PANEL_CLASS);
178
- navigationPanel.appendChild(this.locationListRenderer.host);
179
-
180
- this.hiddenFilesToggleRenderer = this.hiddenFilesToggleFactory(this.widget.model.tree);
181
- this.contentNode.appendChild(this.hiddenFilesToggleRenderer.host);
182
-
183
- if (this.props.filters) {
184
- this.treeFiltersRenderer = this.treeFiltersFactory({ suppliedFilters: this.props.filters, fileDialogTree: this.widget.model.tree });
185
- const filters = Object.keys(this.props.filters);
186
- if (filters.length) {
187
- this.widget.model.tree.setFilter(this.props.filters[filters[0]]);
188
- }
189
- }
190
- }
191
-
192
- get model(): FileDialogModel {
193
- return this.widget.model;
194
- }
195
-
196
- protected override onUpdateRequest(msg: Message): void {
197
- super.onUpdateRequest(msg);
198
- setEnabled(this.back, this.model.canNavigateBackward());
199
- setEnabled(this.forward, this.model.canNavigateForward());
200
- setEnabled(this.home, !!this.model.initialLocation
201
- && !!this.model.location
202
- && this.model.initialLocation.toString() !== this.model.location.toString());
203
- setEnabled(this.up, this.model.canNavigateUpward());
204
- this.locationListRenderer.render();
205
-
206
- if (this.treeFiltersRenderer) {
207
- this.treeFiltersRenderer.render();
208
- }
209
-
210
- this.widget.update();
211
- }
212
-
213
- protected override handleEnter(event: KeyboardEvent): boolean | void {
214
- if (event.target instanceof HTMLTextAreaElement || this.targetIsDirectoryInput(event.target) || this.targetIsInputToggle(event.target)) {
215
- return false;
216
- }
217
- this.accept();
218
- }
219
-
220
- protected override handleEscape(event: KeyboardEvent): boolean | void {
221
- if (event.target instanceof HTMLTextAreaElement || this.targetIsDirectoryInput(event.target)) {
222
- return false;
223
- }
224
- this.close();
225
- }
226
-
227
- protected targetIsDirectoryInput(target: EventTarget | null): boolean {
228
- return target instanceof HTMLInputElement && target.classList.contains(LocationListRenderer.Styles.LOCATION_TEXT_INPUT_CLASS);
229
- }
230
-
231
- protected targetIsInputToggle(target: EventTarget | null): boolean {
232
- return target instanceof HTMLSpanElement && target.classList.contains(LocationListRenderer.Styles.LOCATION_INPUT_TOGGLE_CLASS);
233
- }
234
-
235
- protected appendFiltersPanel(): void {
236
- if (this.treeFiltersRenderer) {
237
- const filtersPanel = document.createElement('div');
238
- filtersPanel.classList.add(FILTERS_PANEL_CLASS);
239
- this.contentNode.appendChild(filtersPanel);
240
-
241
- const titlePanel = document.createElement('div');
242
- titlePanel.innerHTML = DOMPurify.sanitize(nls.localize('theia/filesystem/format', 'Format:'));
243
- titlePanel.classList.add(FILTERS_LABEL_CLASS);
244
- filtersPanel.appendChild(titlePanel);
245
-
246
- this.treeFiltersRenderer.host.classList.add(FILTERS_LIST_PANEL_CLASS);
247
- filtersPanel.appendChild(this.treeFiltersRenderer.host);
248
- }
249
- }
250
-
251
- protected override onAfterAttach(msg: Message): void {
252
- Widget.attach(this.treePanel, this.contentNode);
253
- this.toDisposeOnDetach.push(Disposable.create(() => {
254
- Widget.detach(this.treePanel);
255
- this.locationListRenderer.dispose();
256
- if (this.treeFiltersRenderer) {
257
- this.treeFiltersRenderer.dispose();
258
- }
259
- }));
260
-
261
- this.appendFiltersPanel();
262
-
263
- this.appendCloseButton(nls.localizeByDefault('Cancel'));
264
- this.appendAcceptButton(this.getAcceptButtonLabel());
265
-
266
- this.addKeyListener(this.back, Key.ENTER, () => {
267
- this.addTransformEffectToIcon(this.back);
268
- this.model.navigateBackward();
269
- }, 'click');
270
-
271
- this.addKeyListener(this.forward, Key.ENTER, () => {
272
- this.addTransformEffectToIcon(this.forward);
273
- this.model.navigateForward();
274
- }, 'click');
275
- this.addKeyListener(this.home, Key.ENTER, () => {
276
- this.addTransformEffectToIcon(this.home);
277
- if (this.model.initialLocation) {
278
- this.model.location = this.model.initialLocation;
279
- }
280
- }, 'click');
281
- this.addKeyListener(this.up, Key.ENTER, () => {
282
- this.addTransformEffectToIcon(this.up);
283
- if (this.model.location) {
284
- this.model.location = this.model.location.parent;
285
- }
286
- }, 'click');
287
- super.onAfterAttach(msg);
288
- }
289
-
290
- protected addTransformEffectToIcon(element: HTMLSpanElement): void {
291
- const icon = element.getElementsByTagName('i')[0];
292
- icon.classList.add('active');
293
- setTimeout(() => icon.classList.remove('active'), TOOLBAR_ITEM_TRANSFORM_TIMEOUT);
294
- }
295
-
296
- protected abstract getAcceptButtonLabel(): string;
297
-
298
- protected override onActivateRequest(msg: Message): void {
299
- this.widget.activate();
300
- }
301
-
302
- }
303
-
304
- @injectable()
305
- export class OpenFileDialog extends FileDialog<MaybeArray<FileStatNode>> {
306
-
307
- constructor(@inject(OpenFileDialogProps) override readonly props: OpenFileDialogProps) {
308
- super(props);
309
- }
310
-
311
- @postConstruct()
312
- override init(): void {
313
- super.init();
314
- const { props } = this;
315
- if (props.canSelectFiles !== undefined) {
316
- this.widget.disableFileSelection = !props.canSelectFiles;
317
- }
318
- }
319
-
320
- protected getAcceptButtonLabel(): string {
321
- return this.props.openLabel ? this.props.openLabel : nls.localizeByDefault('Open');
322
- }
323
-
324
- protected override isValid(value: MaybeArray<FileStatNode>): string {
325
- if (value && !this.props.canSelectMany && value instanceof Array) {
326
- return nls.localize('theia/filesystem/dialog/multipleItemMessage', 'You can select only one item');
327
- }
328
- return '';
329
- }
330
-
331
- get value(): MaybeArray<FileStatNode> {
332
- if (this.widget.model.selectedFileStatNodes.length === 1) {
333
- return this.widget.model.selectedFileStatNodes[0];
334
- } else {
335
- return this.widget.model.selectedFileStatNodes;
336
- }
337
- }
338
-
339
- protected override async accept(): Promise<void> {
340
- const selection = this.value;
341
- if (!this.props.canSelectFolders
342
- && !Array.isArray(selection)
343
- && selection.fileStat.isDirectory) {
344
- this.widget.model.openNode(selection);
345
- return;
346
- }
347
- super.accept();
348
- }
349
- }
350
-
351
- @injectable()
352
- export class SaveFileDialog extends FileDialog<URI | undefined> {
353
-
354
- protected fileNameField: HTMLInputElement | undefined;
355
-
356
- @inject(LabelProvider)
357
- protected readonly labelProvider: LabelProvider;
358
-
359
- constructor(@inject(SaveFileDialogProps) override readonly props: SaveFileDialogProps) {
360
- super(props);
361
- }
362
-
363
- @postConstruct()
364
- override init(): void {
365
- super.init();
366
- const { widget } = this;
367
- widget.addClass(SAVE_DIALOG_CLASS);
368
- }
369
-
370
- protected getAcceptButtonLabel(): string {
371
- return this.props.saveLabel ? this.props.saveLabel : nls.localizeByDefault('Save');
372
- }
373
-
374
- protected override onUpdateRequest(msg: Message): void {
375
- // Update file name field when changing a selection
376
- if (this.fileNameField) {
377
- if (this.widget.model.selectedFileStatNodes.length === 1) {
378
- const node = this.widget.model.selectedFileStatNodes[0];
379
- if (!node.fileStat.isDirectory) {
380
- this.fileNameField.value = this.labelProvider.getName(node);
381
- }
382
- } else {
383
- this.fileNameField.value = '';
384
- }
385
- }
386
-
387
- // Continue updating the dialog
388
- super.onUpdateRequest(msg);
389
- }
390
-
391
- protected override isValid(value: URI | undefined): string | boolean {
392
- if (this.fileNameField && this.fileNameField.value) {
393
- return '';
394
- }
395
- return false;
396
- }
397
-
398
- get value(): URI | undefined {
399
- if (this.fileNameField && this.widget.model.selectedFileStatNodes.length === 1) {
400
- const node = this.widget.model.selectedFileStatNodes[0];
401
-
402
- if (node.fileStat.isDirectory) {
403
- return node.uri.resolve(this.fileNameField.value);
404
- }
405
-
406
- return node.uri.parent.resolve(this.fileNameField.value);
407
- }
408
-
409
- return undefined;
410
- }
411
-
412
- protected override onAfterAttach(msg: Message): void {
413
- super.onAfterAttach(msg);
414
-
415
- const fileNamePanel = document.createElement('div');
416
- fileNamePanel.classList.add(FILENAME_PANEL_CLASS);
417
- this.contentNode.appendChild(fileNamePanel);
418
-
419
- const titlePanel = document.createElement('div');
420
- titlePanel.innerHTML = DOMPurify.sanitize(nls.localize('theia/filesystem/dialog/name', 'Name:'));
421
- titlePanel.classList.add(FILENAME_LABEL_CLASS);
422
- fileNamePanel.appendChild(titlePanel);
423
-
424
- this.fileNameField = document.createElement('input');
425
- this.fileNameField.type = 'text';
426
- this.fileNameField.spellcheck = false;
427
- this.fileNameField.classList.add('theia-input', FILENAME_TEXTFIELD_CLASS);
428
- this.fileNameField.value = this.props.inputValue || '';
429
- fileNamePanel.appendChild(this.fileNameField);
430
-
431
- this.fileNameField.onkeyup = () => this.validate();
432
- }
433
-
434
- }
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 { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
18
+ import { Message } from '@theia/core/shared/@phosphor/messaging';
19
+ import { Disposable, MaybeArray, nls } from '@theia/core/lib/common';
20
+ import { AbstractDialog, DialogProps, setEnabled, createIconButton, Widget, codiconArray, Key, LabelProvider } from '@theia/core/lib/browser';
21
+ import { FileStatNode } from '../file-tree';
22
+ import { LocationListRenderer, LocationListRendererFactory } from '../location';
23
+ import { FileDialogModel } from './file-dialog-model';
24
+ import { FileDialogWidget } from './file-dialog-widget';
25
+ import { FileDialogTreeFiltersRenderer, FileDialogTreeFilters, FileDialogTreeFiltersRendererFactory } from './file-dialog-tree-filters-renderer';
26
+ import URI from '@theia/core/lib/common/uri';
27
+ import { Panel } from '@theia/core/shared/@phosphor/widgets';
28
+ import * as DOMPurify from '@theia/core/shared/dompurify';
29
+ import { FileDialogHiddenFilesToggleRenderer, HiddenFilesToggleRendererFactory } from './file-dialog-hidden-files-renderer';
30
+
31
+ export const OpenFileDialogFactory = Symbol('OpenFileDialogFactory');
32
+ export interface OpenFileDialogFactory {
33
+ (props: OpenFileDialogProps): OpenFileDialog;
34
+ }
35
+
36
+ export const SaveFileDialogFactory = Symbol('SaveFileDialogFactory');
37
+ export interface SaveFileDialogFactory {
38
+ (props: SaveFileDialogProps): SaveFileDialog;
39
+ }
40
+
41
+ export const SAVE_DIALOG_CLASS = 'theia-SaveFileDialog';
42
+
43
+ export const NAVIGATION_PANEL_CLASS = 'theia-NavigationPanel';
44
+ export const NAVIGATION_BACK_CLASS = 'theia-NavigationBack';
45
+ export const NAVIGATION_FORWARD_CLASS = 'theia-NavigationForward';
46
+ export const NAVIGATION_HOME_CLASS = 'theia-NavigationHome';
47
+ export const NAVIGATION_UP_CLASS = 'theia-NavigationUp';
48
+ export const NAVIGATION_LOCATION_LIST_PANEL_CLASS = 'theia-LocationListPanel';
49
+
50
+ export const FILTERS_PANEL_CLASS = 'theia-FiltersPanel';
51
+ export const FILTERS_LABEL_CLASS = 'theia-FiltersLabel';
52
+ export const FILTERS_LIST_PANEL_CLASS = 'theia-FiltersListPanel';
53
+
54
+ export const FILENAME_PANEL_CLASS = 'theia-FileNamePanel';
55
+ export const FILENAME_LABEL_CLASS = 'theia-FileNameLabel';
56
+ export const FILENAME_TEXTFIELD_CLASS = 'theia-FileNameTextField';
57
+
58
+ export const CONTROL_PANEL_CLASS = 'theia-ControlPanel';
59
+ export const TOOLBAR_ITEM_TRANSFORM_TIMEOUT = 100;
60
+
61
+ export class FileDialogProps extends DialogProps {
62
+
63
+ /**
64
+ * A set of file filters that are used by the dialog. Each entry is a human readable label,
65
+ * like "TypeScript", and an array of extensions, e.g.
66
+ * ```ts
67
+ * {
68
+ * 'Images': ['png', 'jpg']
69
+ * 'TypeScript': ['ts', 'tsx']
70
+ * }
71
+ * ```
72
+ */
73
+ filters?: FileDialogTreeFilters;
74
+
75
+ /**
76
+ * Determines if the dialog window should be modal.
77
+ * Defaults to `true`.
78
+ */
79
+ modal?: boolean;
80
+
81
+ }
82
+
83
+ @injectable()
84
+ export class OpenFileDialogProps extends FileDialogProps {
85
+
86
+ /**
87
+ * A human-readable string for the accept button.
88
+ */
89
+ openLabel?: string;
90
+
91
+ /**
92
+ * Allow to select files, defaults to `true`.
93
+ */
94
+ canSelectFiles?: boolean;
95
+
96
+ /**
97
+ * Allow to select folders, defaults to `false`.
98
+ */
99
+ canSelectFolders?: boolean;
100
+
101
+ /**
102
+ * Allow to select many files or folders.
103
+ */
104
+ canSelectMany?: boolean;
105
+
106
+ }
107
+
108
+ @injectable()
109
+ export class SaveFileDialogProps extends FileDialogProps {
110
+
111
+ /**
112
+ * A human-readable string for the accept button.
113
+ */
114
+ saveLabel?: string;
115
+
116
+ /**
117
+ * A human-readable value for the input.
118
+ */
119
+ inputValue?: string;
120
+
121
+ }
122
+
123
+ export abstract class FileDialog<T> extends AbstractDialog<T> {
124
+
125
+ protected back: HTMLSpanElement;
126
+ protected forward: HTMLSpanElement;
127
+ protected home: HTMLSpanElement;
128
+ protected up: HTMLSpanElement;
129
+ protected locationListRenderer: LocationListRenderer;
130
+ protected treeFiltersRenderer: FileDialogTreeFiltersRenderer | undefined;
131
+ protected hiddenFilesToggleRenderer: FileDialogHiddenFilesToggleRenderer;
132
+ protected treePanel: Panel;
133
+
134
+ @inject(FileDialogWidget) readonly widget: FileDialogWidget;
135
+ @inject(LocationListRendererFactory) readonly locationListFactory: LocationListRendererFactory;
136
+ @inject(FileDialogTreeFiltersRendererFactory) readonly treeFiltersFactory: FileDialogTreeFiltersRendererFactory;
137
+ @inject(HiddenFilesToggleRendererFactory) readonly hiddenFilesToggleFactory: HiddenFilesToggleRendererFactory;
138
+
139
+ constructor(
140
+ @inject(FileDialogProps) override readonly props: FileDialogProps
141
+ ) {
142
+ super(props);
143
+ }
144
+
145
+ @postConstruct()
146
+ init(): void {
147
+ this.treePanel = new Panel();
148
+ this.treePanel.addWidget(this.widget);
149
+ this.toDispose.push(this.treePanel);
150
+ this.toDispose.push(this.model.onChanged(() => this.update()));
151
+ this.toDispose.push(this.model.onDidOpenFile(() => this.accept()));
152
+ this.toDispose.push(this.model.onSelectionChanged(() => this.update()));
153
+
154
+ const navigationPanel = document.createElement('div');
155
+ navigationPanel.classList.add(NAVIGATION_PANEL_CLASS);
156
+ this.contentNode.appendChild(navigationPanel);
157
+
158
+ navigationPanel.appendChild(this.back = createIconButton(...codiconArray('chevron-left', true)));
159
+ this.back.classList.add(NAVIGATION_BACK_CLASS);
160
+ this.back.title = nls.localize('theia/filesystem/dialog/navigateBack', 'Navigate Back');
161
+
162
+ navigationPanel.appendChild(this.forward = createIconButton(...codiconArray('chevron-right', true)));
163
+ this.forward.classList.add(NAVIGATION_FORWARD_CLASS);
164
+ this.forward.title = nls.localize('theia/filesystem/dialog/navigateForward', 'Navigate Forward');
165
+
166
+ navigationPanel.appendChild(this.home = createIconButton(...codiconArray('home', true)));
167
+ this.home.classList.add(NAVIGATION_HOME_CLASS);
168
+ this.home.title = nls.localize('theia/filesystem/dialog/initialLocation', 'Go To Initial Location');
169
+
170
+ navigationPanel.appendChild(this.up = createIconButton(...codiconArray('arrow-up', true)));
171
+ this.up.classList.add(NAVIGATION_UP_CLASS);
172
+ this.up.title = nls.localize('theia/filesystem/dialog/navigateUp', 'Navigate Up One Directory');
173
+
174
+ const locationListRendererHost = document.createElement('div');
175
+ this.locationListRenderer = this.locationListFactory({ model: this.model, host: locationListRendererHost });
176
+ this.toDispose.push(this.locationListRenderer);
177
+ this.locationListRenderer.host.classList.add(NAVIGATION_LOCATION_LIST_PANEL_CLASS);
178
+ navigationPanel.appendChild(this.locationListRenderer.host);
179
+
180
+ this.hiddenFilesToggleRenderer = this.hiddenFilesToggleFactory(this.widget.model.tree);
181
+ this.contentNode.appendChild(this.hiddenFilesToggleRenderer.host);
182
+
183
+ if (this.props.filters) {
184
+ this.treeFiltersRenderer = this.treeFiltersFactory({ suppliedFilters: this.props.filters, fileDialogTree: this.widget.model.tree });
185
+ const filters = Object.keys(this.props.filters);
186
+ if (filters.length) {
187
+ this.widget.model.tree.setFilter(this.props.filters[filters[0]]);
188
+ }
189
+ }
190
+ }
191
+
192
+ get model(): FileDialogModel {
193
+ return this.widget.model;
194
+ }
195
+
196
+ protected override onUpdateRequest(msg: Message): void {
197
+ super.onUpdateRequest(msg);
198
+ setEnabled(this.back, this.model.canNavigateBackward());
199
+ setEnabled(this.forward, this.model.canNavigateForward());
200
+ setEnabled(this.home, !!this.model.initialLocation
201
+ && !!this.model.location
202
+ && this.model.initialLocation.toString() !== this.model.location.toString());
203
+ setEnabled(this.up, this.model.canNavigateUpward());
204
+ this.locationListRenderer.render();
205
+
206
+ if (this.treeFiltersRenderer) {
207
+ this.treeFiltersRenderer.render();
208
+ }
209
+
210
+ this.widget.update();
211
+ }
212
+
213
+ protected override handleEnter(event: KeyboardEvent): boolean | void {
214
+ if (event.target instanceof HTMLTextAreaElement || this.targetIsDirectoryInput(event.target) || this.targetIsInputToggle(event.target)) {
215
+ return false;
216
+ }
217
+ this.accept();
218
+ }
219
+
220
+ protected override handleEscape(event: KeyboardEvent): boolean | void {
221
+ if (event.target instanceof HTMLTextAreaElement || this.targetIsDirectoryInput(event.target)) {
222
+ return false;
223
+ }
224
+ this.close();
225
+ }
226
+
227
+ protected targetIsDirectoryInput(target: EventTarget | null): boolean {
228
+ return target instanceof HTMLInputElement && target.classList.contains(LocationListRenderer.Styles.LOCATION_TEXT_INPUT_CLASS);
229
+ }
230
+
231
+ protected targetIsInputToggle(target: EventTarget | null): boolean {
232
+ return target instanceof HTMLSpanElement && target.classList.contains(LocationListRenderer.Styles.LOCATION_INPUT_TOGGLE_CLASS);
233
+ }
234
+
235
+ protected appendFiltersPanel(): void {
236
+ if (this.treeFiltersRenderer) {
237
+ const filtersPanel = document.createElement('div');
238
+ filtersPanel.classList.add(FILTERS_PANEL_CLASS);
239
+ this.contentNode.appendChild(filtersPanel);
240
+
241
+ const titlePanel = document.createElement('div');
242
+ titlePanel.innerHTML = DOMPurify.sanitize(nls.localize('theia/filesystem/format', 'Format:'));
243
+ titlePanel.classList.add(FILTERS_LABEL_CLASS);
244
+ filtersPanel.appendChild(titlePanel);
245
+
246
+ this.treeFiltersRenderer.host.classList.add(FILTERS_LIST_PANEL_CLASS);
247
+ filtersPanel.appendChild(this.treeFiltersRenderer.host);
248
+ }
249
+ }
250
+
251
+ protected override onAfterAttach(msg: Message): void {
252
+ Widget.attach(this.treePanel, this.contentNode);
253
+ this.toDisposeOnDetach.push(Disposable.create(() => {
254
+ Widget.detach(this.treePanel);
255
+ this.locationListRenderer.dispose();
256
+ if (this.treeFiltersRenderer) {
257
+ this.treeFiltersRenderer.dispose();
258
+ }
259
+ }));
260
+
261
+ this.appendFiltersPanel();
262
+
263
+ this.appendCloseButton(nls.localizeByDefault('Cancel'));
264
+ this.appendAcceptButton(this.getAcceptButtonLabel());
265
+
266
+ this.addKeyListener(this.back, Key.ENTER, () => {
267
+ this.addTransformEffectToIcon(this.back);
268
+ this.model.navigateBackward();
269
+ }, 'click');
270
+
271
+ this.addKeyListener(this.forward, Key.ENTER, () => {
272
+ this.addTransformEffectToIcon(this.forward);
273
+ this.model.navigateForward();
274
+ }, 'click');
275
+ this.addKeyListener(this.home, Key.ENTER, () => {
276
+ this.addTransformEffectToIcon(this.home);
277
+ if (this.model.initialLocation) {
278
+ this.model.location = this.model.initialLocation;
279
+ }
280
+ }, 'click');
281
+ this.addKeyListener(this.up, Key.ENTER, () => {
282
+ this.addTransformEffectToIcon(this.up);
283
+ if (this.model.location) {
284
+ this.model.location = this.model.location.parent;
285
+ }
286
+ }, 'click');
287
+ super.onAfterAttach(msg);
288
+ }
289
+
290
+ protected addTransformEffectToIcon(element: HTMLSpanElement): void {
291
+ const icon = element.getElementsByTagName('i')[0];
292
+ icon.classList.add('active');
293
+ setTimeout(() => icon.classList.remove('active'), TOOLBAR_ITEM_TRANSFORM_TIMEOUT);
294
+ }
295
+
296
+ protected abstract getAcceptButtonLabel(): string;
297
+
298
+ protected override onActivateRequest(msg: Message): void {
299
+ this.widget.activate();
300
+ }
301
+
302
+ }
303
+
304
+ @injectable()
305
+ export class OpenFileDialog extends FileDialog<MaybeArray<FileStatNode>> {
306
+
307
+ constructor(@inject(OpenFileDialogProps) override readonly props: OpenFileDialogProps) {
308
+ super(props);
309
+ }
310
+
311
+ @postConstruct()
312
+ override init(): void {
313
+ super.init();
314
+ const { props } = this;
315
+ if (props.canSelectFiles !== undefined) {
316
+ this.widget.disableFileSelection = !props.canSelectFiles;
317
+ }
318
+ }
319
+
320
+ protected getAcceptButtonLabel(): string {
321
+ return this.props.openLabel ? this.props.openLabel : nls.localizeByDefault('Open');
322
+ }
323
+
324
+ protected override isValid(value: MaybeArray<FileStatNode>): string {
325
+ if (value && !this.props.canSelectMany && value instanceof Array) {
326
+ return nls.localize('theia/filesystem/dialog/multipleItemMessage', 'You can select only one item');
327
+ }
328
+ return '';
329
+ }
330
+
331
+ get value(): MaybeArray<FileStatNode> {
332
+ if (this.widget.model.selectedFileStatNodes.length === 1) {
333
+ return this.widget.model.selectedFileStatNodes[0];
334
+ } else {
335
+ return this.widget.model.selectedFileStatNodes;
336
+ }
337
+ }
338
+
339
+ protected override async accept(): Promise<void> {
340
+ const selection = this.value;
341
+ if (!this.props.canSelectFolders
342
+ && !Array.isArray(selection)
343
+ && selection.fileStat.isDirectory) {
344
+ this.widget.model.openNode(selection);
345
+ return;
346
+ }
347
+ super.accept();
348
+ }
349
+ }
350
+
351
+ @injectable()
352
+ export class SaveFileDialog extends FileDialog<URI | undefined> {
353
+
354
+ protected fileNameField: HTMLInputElement | undefined;
355
+
356
+ @inject(LabelProvider)
357
+ protected readonly labelProvider: LabelProvider;
358
+
359
+ constructor(@inject(SaveFileDialogProps) override readonly props: SaveFileDialogProps) {
360
+ super(props);
361
+ }
362
+
363
+ @postConstruct()
364
+ override init(): void {
365
+ super.init();
366
+ const { widget } = this;
367
+ widget.addClass(SAVE_DIALOG_CLASS);
368
+ }
369
+
370
+ protected getAcceptButtonLabel(): string {
371
+ return this.props.saveLabel ? this.props.saveLabel : nls.localizeByDefault('Save');
372
+ }
373
+
374
+ protected override onUpdateRequest(msg: Message): void {
375
+ // Update file name field when changing a selection
376
+ if (this.fileNameField) {
377
+ if (this.widget.model.selectedFileStatNodes.length === 1) {
378
+ const node = this.widget.model.selectedFileStatNodes[0];
379
+ if (!node.fileStat.isDirectory) {
380
+ this.fileNameField.value = this.labelProvider.getName(node);
381
+ }
382
+ } else {
383
+ this.fileNameField.value = '';
384
+ }
385
+ }
386
+
387
+ // Continue updating the dialog
388
+ super.onUpdateRequest(msg);
389
+ }
390
+
391
+ protected override isValid(value: URI | undefined): string | boolean {
392
+ if (this.fileNameField && this.fileNameField.value) {
393
+ return '';
394
+ }
395
+ return false;
396
+ }
397
+
398
+ get value(): URI | undefined {
399
+ if (this.fileNameField && this.widget.model.selectedFileStatNodes.length === 1) {
400
+ const node = this.widget.model.selectedFileStatNodes[0];
401
+
402
+ if (node.fileStat.isDirectory) {
403
+ return node.uri.resolve(this.fileNameField.value);
404
+ }
405
+
406
+ return node.uri.parent.resolve(this.fileNameField.value);
407
+ }
408
+
409
+ return undefined;
410
+ }
411
+
412
+ protected override onAfterAttach(msg: Message): void {
413
+ super.onAfterAttach(msg);
414
+
415
+ const fileNamePanel = document.createElement('div');
416
+ fileNamePanel.classList.add(FILENAME_PANEL_CLASS);
417
+ this.contentNode.appendChild(fileNamePanel);
418
+
419
+ const titlePanel = document.createElement('div');
420
+ titlePanel.innerHTML = DOMPurify.sanitize(nls.localize('theia/filesystem/dialog/name', 'Name:'));
421
+ titlePanel.classList.add(FILENAME_LABEL_CLASS);
422
+ fileNamePanel.appendChild(titlePanel);
423
+
424
+ this.fileNameField = document.createElement('input');
425
+ this.fileNameField.type = 'text';
426
+ this.fileNameField.spellcheck = false;
427
+ this.fileNameField.classList.add('theia-input', FILENAME_TEXTFIELD_CLASS);
428
+ this.fileNameField.value = this.props.inputValue || '';
429
+ fileNamePanel.appendChild(this.fileNameField);
430
+
431
+ this.fileNameField.onkeyup = () => this.validate();
432
+ }
433
+
434
+ }