@theia/filesystem 1.45.1 → 1.46.0-next.72
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.
- package/README.md +30 -30
- package/lib/browser/breadcrumbs/filepath-breadcrumb.d.ts +15 -15
- package/lib/browser/breadcrumbs/filepath-breadcrumb.js +41 -41
- package/lib/browser/breadcrumbs/filepath-breadcrumbs-container.d.ts +13 -13
- package/lib/browser/breadcrumbs/filepath-breadcrumbs-container.js +81 -81
- package/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.d.ts +27 -27
- package/lib/browser/breadcrumbs/filepath-breadcrumbs-contribution.js +126 -126
- package/lib/browser/download/file-download-command-contribution.d.ts +18 -18
- package/lib/browser/download/file-download-command-contribution.js +83 -83
- package/lib/browser/download/file-download-frontend-module.d.ts +3 -3
- package/lib/browser/download/file-download-frontend-module.js +25 -25
- package/lib/browser/download/file-download-service.d.ts +28 -28
- package/lib/browser/download/file-download-service.js +175 -175
- package/lib/browser/file-dialog/file-dialog-container.d.ts +5 -5
- package/lib/browser/file-dialog/file-dialog-container.js +60 -60
- package/lib/browser/file-dialog/file-dialog-hidden-files-renderer.d.ts +15 -15
- package/lib/browser/file-dialog/file-dialog-hidden-files-renderer.js +67 -67
- package/lib/browser/file-dialog/file-dialog-model.d.ts +25 -25
- package/lib/browser/file-dialog/file-dialog-model.js +108 -108
- package/lib/browser/file-dialog/file-dialog-module.d.ts +3 -3
- package/lib/browser/file-dialog/file-dialog-module.js +45 -45
- package/lib/browser/file-dialog/file-dialog-service.d.ts +32 -32
- package/lib/browser/file-dialog/file-dialog-service.js +109 -109
- package/lib/browser/file-dialog/file-dialog-tree-filters-renderer.d.ts +39 -39
- package/lib/browser/file-dialog/file-dialog-tree-filters-renderer.js +92 -92
- package/lib/browser/file-dialog/file-dialog-tree.d.ts +26 -26
- package/lib/browser/file-dialog/file-dialog-tree.js +88 -88
- package/lib/browser/file-dialog/file-dialog-widget.d.ts +15 -15
- package/lib/browser/file-dialog/file-dialog-widget.js +86 -86
- package/lib/browser/file-dialog/file-dialog.d.ts +129 -129
- package/lib/browser/file-dialog/file-dialog.js +362 -362
- package/lib/browser/file-dialog/index.d.ts +4 -4
- package/lib/browser/file-dialog/index.js +31 -31
- package/lib/browser/file-resource.d.ts +66 -63
- package/lib/browser/file-resource.d.ts.map +1 -1
- package/lib/browser/file-resource.js +362 -352
- package/lib/browser/file-resource.js.map +1 -1
- package/lib/browser/file-selection.d.ts +14 -14
- package/lib/browser/file-selection.js +36 -36
- package/lib/browser/file-service.d.ts +413 -412
- package/lib/browser/file-service.d.ts.map +1 -1
- package/lib/browser/file-service.js +1362 -1360
- package/lib/browser/file-service.js.map +1 -1
- package/lib/browser/file-tree/file-tree-container.d.ts +3 -3
- package/lib/browser/file-tree/file-tree-container.js +35 -35
- package/lib/browser/file-tree/file-tree-decorator-adapter.d.ts +30 -30
- package/lib/browser/file-tree/file-tree-decorator-adapter.js +177 -177
- package/lib/browser/file-tree/file-tree-label-provider.d.ts +12 -12
- package/lib/browser/file-tree/file-tree-label-provider.js +62 -62
- package/lib/browser/file-tree/file-tree-model.d.ts +37 -37
- package/lib/browser/file-tree/file-tree-model.js +225 -225
- package/lib/browser/file-tree/file-tree-widget.d.ts +44 -44
- package/lib/browser/file-tree/file-tree-widget.js +328 -328
- package/lib/browser/file-tree/file-tree.d.ts +46 -46
- package/lib/browser/file-tree/file-tree.js +184 -184
- package/lib/browser/file-tree/index.d.ts +6 -6
- package/lib/browser/file-tree/index.js +33 -33
- package/lib/browser/file-upload-service.d.ts +109 -111
- package/lib/browser/file-upload-service.d.ts.map +1 -1
- package/lib/browser/file-upload-service.js +442 -442
- package/lib/browser/file-upload-service.js.map +1 -1
- package/lib/browser/filesystem-frontend-contribution.d.ts +63 -63
- package/lib/browser/filesystem-frontend-contribution.js +327 -327
- package/lib/browser/filesystem-frontend-module.d.ts +5 -5
- package/lib/browser/filesystem-frontend-module.js +64 -64
- package/lib/browser/filesystem-preferences.d.ts +29 -29
- package/lib/browser/filesystem-preferences.js +110 -110
- package/lib/browser/filesystem-save-resource-service.d.ts +29 -29
- package/lib/browser/filesystem-save-resource-service.d.ts.map +1 -1
- package/lib/browser/filesystem-save-resource-service.js +143 -142
- package/lib/browser/filesystem-save-resource-service.js.map +1 -1
- package/lib/browser/filesystem-watcher-error-handler.d.ts +10 -10
- package/lib/browser/filesystem-watcher-error-handler.js +69 -69
- package/lib/browser/index.d.ts +5 -5
- package/lib/browser/index.js +32 -32
- package/lib/browser/location/index.d.ts +2 -2
- package/lib/browser/location/index.js +29 -29
- package/lib/browser/location/location-renderer.d.ts +100 -100
- package/lib/browser/location/location-renderer.js +354 -354
- package/lib/browser/location/location-service.d.ts +5 -5
- package/lib/browser/location/location-service.js +17 -17
- package/lib/browser/remote-file-service-contribution.d.ts +6 -6
- package/lib/browser/remote-file-service-contribution.js +47 -47
- package/lib/browser-only/browser-only-filesystem-frontend-module.d.ts +4 -0
- package/lib/browser-only/browser-only-filesystem-frontend-module.d.ts.map +1 -0
- package/lib/browser-only/browser-only-filesystem-frontend-module.js +41 -0
- package/lib/browser-only/browser-only-filesystem-frontend-module.js.map +1 -0
- package/lib/browser-only/browser-only-filesystem-provider-server.d.ts +12 -0
- package/lib/browser-only/browser-only-filesystem-provider-server.d.ts.map +1 -0
- package/lib/browser-only/browser-only-filesystem-provider-server.js +45 -0
- package/lib/browser-only/browser-only-filesystem-provider-server.js.map +1 -0
- package/lib/browser-only/browserfs-filesystem-initialization.d.ts +13 -0
- package/lib/browser-only/browserfs-filesystem-initialization.d.ts.map +1 -0
- package/lib/browser-only/browserfs-filesystem-initialization.js +60 -0
- package/lib/browser-only/browserfs-filesystem-initialization.js.map +1 -0
- package/lib/browser-only/browserfs-filesystem-provider.d.ts +46 -0
- package/lib/browser-only/browserfs-filesystem-provider.d.ts.map +1 -0
- package/lib/browser-only/browserfs-filesystem-provider.js +451 -0
- package/lib/browser-only/browserfs-filesystem-provider.js.map +1 -0
- package/lib/common/delegating-file-system-provider.d.ts +76 -76
- package/lib/common/delegating-file-system-provider.js +168 -168
- package/lib/common/download/file-download-data.d.ts +6 -6
- package/lib/common/download/file-download-data.js +26 -26
- package/lib/common/file-upload.d.ts +1 -1
- package/lib/common/file-upload.js +19 -19
- package/lib/common/files.d.ts +651 -651
- package/lib/common/files.js +347 -347
- package/lib/common/files.spec.d.ts +1 -1
- package/lib/common/files.spec.js +51 -51
- package/lib/common/filesystem-utils.d.ts +14 -14
- package/lib/common/filesystem-utils.js +63 -63
- package/lib/common/filesystem-utils.spec.d.ts +1 -1
- package/lib/common/filesystem-utils.spec.js +378 -378
- package/lib/common/filesystem-watcher-protocol.d.ts +71 -71
- package/lib/common/filesystem-watcher-protocol.js +20 -20
- package/lib/common/filesystem.d.ts +22 -22
- package/lib/common/filesystem.js +42 -42
- package/lib/common/index.d.ts +2 -2
- package/lib/common/index.js +29 -29
- package/lib/common/io.d.ts +19 -19
- package/lib/common/io.js +110 -110
- package/lib/common/remote-file-system-provider.d.ts +164 -164
- package/lib/common/remote-file-system-provider.js +413 -413
- package/lib/electron-browser/file-dialog/electron-file-dialog-module.d.ts +3 -3
- package/lib/electron-browser/file-dialog/electron-file-dialog-module.js +24 -24
- package/lib/electron-browser/file-dialog/electron-file-dialog-service.d.ts +19 -19
- package/lib/electron-browser/file-dialog/electron-file-dialog-service.js +156 -156
- package/lib/electron-browser/file-dialog/electron-file-dialog-service.js.map +1 -1
- package/lib/electron-browser/preload.d.ts +1 -1
- package/lib/electron-browser/preload.js +30 -30
- package/lib/electron-common/electron-api.d.ts +34 -34
- package/lib/electron-common/electron-api.js +20 -20
- package/lib/electron-main/electron-api-main.d.ts +5 -5
- package/lib/electron-main/electron-api-main.js +78 -78
- package/lib/electron-main/electron-main-module.d.ts +3 -3
- package/lib/electron-main/electron-main-module.js +24 -24
- package/lib/node/disk-file-system-provider.d.ts +72 -72
- package/lib/node/disk-file-system-provider.d.ts.map +1 -1
- package/lib/node/disk-file-system-provider.js +795 -789
- package/lib/node/disk-file-system-provider.js.map +1 -1
- package/lib/node/disk-file-system-provider.spec.d.ts +1 -1
- package/lib/node/disk-file-system-provider.spec.js +122 -91
- package/lib/node/disk-file-system-provider.spec.js.map +1 -1
- package/lib/node/download/directory-archiver.d.ts +9 -9
- package/lib/node/download/directory-archiver.js +132 -132
- package/lib/node/download/directory-archiver.js.map +1 -1
- package/lib/node/download/directory-archiver.spec.d.ts +1 -1
- package/lib/node/download/directory-archiver.spec.js +97 -97
- package/lib/node/download/directory-archiver.spec.js.map +1 -1
- package/lib/node/download/file-download-backend-module.d.ts +3 -3
- package/lib/node/download/file-download-backend-module.js +32 -32
- package/lib/node/download/file-download-cache.d.ts +21 -21
- package/lib/node/download/file-download-cache.js +90 -90
- package/lib/node/download/file-download-endpoint.d.ts +11 -11
- package/lib/node/download/file-download-endpoint.js +75 -75
- package/lib/node/download/file-download-endpoint.js.map +1 -1
- package/lib/node/download/file-download-handler.d.ts +50 -50
- package/lib/node/download/file-download-handler.d.ts.map +1 -1
- package/lib/node/download/file-download-handler.js +315 -315
- package/lib/node/download/file-download-handler.js.map +1 -1
- package/lib/node/download/test/mock-directory-archiver.d.ts +7 -7
- package/lib/node/download/test/mock-directory-archiver.js +29 -29
- package/lib/node/file-change-collection.d.ts +22 -22
- package/lib/node/file-change-collection.js +77 -77
- package/lib/node/file-change-collection.spec.d.ts +1 -1
- package/lib/node/file-change-collection.spec.js +90 -90
- package/lib/node/file-change-collection.spec.js.map +1 -1
- package/lib/node/filesystem-backend-module.d.ts +26 -26
- package/lib/node/filesystem-backend-module.js +120 -120
- package/lib/node/filesystem-watcher-client.d.ts +23 -23
- package/lib/node/filesystem-watcher-client.js +83 -83
- package/lib/node/filesystem-watcher-dispatcher.d.ts +23 -23
- package/lib/node/filesystem-watcher-dispatcher.js +85 -85
- package/lib/node/node-file-upload-service.d.ts +16 -16
- package/lib/node/node-file-upload-service.js +84 -84
- package/lib/node/nsfw-watcher/index.d.ts +3 -3
- package/lib/node/nsfw-watcher/index.js +39 -39
- package/lib/node/nsfw-watcher/nsfw-filesystem-service.d.ts +191 -191
- package/lib/node/nsfw-watcher/nsfw-filesystem-service.js +405 -405
- package/lib/node/nsfw-watcher/nsfw-filesystem-service.js.map +1 -1
- package/lib/node/nsfw-watcher/nsfw-filesystem-watcher.spec.d.ts +1 -1
- package/lib/node/nsfw-watcher/nsfw-filesystem-watcher.spec.js +151 -151
- package/lib/node/nsfw-watcher/nsfw-options.d.ts +6 -6
- package/lib/node/nsfw-watcher/nsfw-options.js +22 -22
- package/package.json +8 -6
- package/src/browser/breadcrumbs/filepath-breadcrumb.ts +43 -43
- package/src/browser/breadcrumbs/filepath-breadcrumbs-container.ts +65 -65
- package/src/browser/breadcrumbs/filepath-breadcrumbs-contribution.ts +129 -129
- package/src/browser/download/file-download-command-contribution.ts +83 -83
- package/src/browser/download/file-download-frontend-module.ts +25 -25
- package/src/browser/download/file-download-service.ts +179 -179
- package/src/browser/file-dialog/file-dialog-container.ts +67 -67
- package/src/browser/file-dialog/file-dialog-hidden-files-renderer.tsx +59 -59
- package/src/browser/file-dialog/file-dialog-model.ts +96 -96
- package/src/browser/file-dialog/file-dialog-module.ts +44 -44
- package/src/browser/file-dialog/file-dialog-service.ts +99 -99
- package/src/browser/file-dialog/file-dialog-tree-filters-renderer.tsx +100 -100
- package/src/browser/file-dialog/file-dialog-tree.ts +89 -89
- package/src/browser/file-dialog/file-dialog-widget.ts +75 -75
- package/src/browser/file-dialog/file-dialog.ts +434 -434
- package/src/browser/file-dialog/index.ts +20 -20
- package/src/browser/file-resource.ts +373 -361
- package/src/browser/file-selection.ts +44 -44
- package/src/browser/file-service.ts +1817 -1814
- package/src/browser/file-tree/file-tree-container.ts +36 -36
- package/src/browser/file-tree/file-tree-decorator-adapter.ts +159 -159
- package/src/browser/file-tree/file-tree-label-provider.ts +53 -53
- package/src/browser/file-tree/file-tree-model.ts +212 -212
- package/src/browser/file-tree/file-tree-widget.tsx +327 -327
- package/src/browser/file-tree/file-tree.ts +183 -183
- package/src/browser/file-tree/index.ts +22 -22
- package/src/browser/file-upload-service.ts +539 -541
- package/src/browser/filesystem-frontend-contribution.ts +338 -338
- package/src/browser/filesystem-frontend-module.ts +77 -77
- package/src/browser/filesystem-preferences.ts +139 -139
- package/src/browser/filesystem-save-resource-service.ts +125 -124
- package/src/browser/filesystem-watcher-error-handler.ts +60 -60
- package/src/browser/index.ts +21 -21
- package/src/browser/location/index.ts +18 -18
- package/src/browser/location/location-renderer.tsx +404 -404
- package/src/browser/location/location-service.ts +22 -22
- package/src/browser/remote-file-service-contribution.ts +38 -38
- package/src/browser/style/file-dialog.css +208 -208
- package/src/browser/style/file-icons.css +64 -64
- package/src/browser/style/filepath-breadcrumbs.css +20 -20
- package/src/browser/style/index.css +36 -36
- package/src/browser-only/browser-only-filesystem-frontend-module.ts +38 -0
- package/src/browser-only/browser-only-filesystem-provider-server.ts +32 -0
- package/src/browser-only/browserfs-filesystem-initialization.ts +61 -0
- package/src/browser-only/browserfs-filesystem-provider.ts +462 -0
- package/src/common/delegating-file-system-provider.ts +226 -226
- package/src/common/download/README.md +30 -30
- package/src/common/download/file-download-data.ts +27 -27
- package/src/common/file-upload.ts +17 -17
- package/src/common/files.spec.ts +51 -51
- package/src/common/files.ts +983 -983
- package/src/common/filesystem-utils.spec.ts +411 -411
- package/src/common/filesystem-utils.ts +64 -64
- package/src/common/filesystem-watcher-protocol.ts +96 -96
- package/src/common/filesystem.ts +43 -43
- package/src/common/index.ts +18 -18
- package/src/common/io.ts +150 -150
- package/src/common/remote-file-system-provider.ts +511 -511
- package/src/electron-browser/file-dialog/electron-file-dialog-module.ts +24 -24
- package/src/electron-browser/file-dialog/electron-file-dialog-service.ts +165 -165
- package/src/electron-browser/preload.ts +31 -31
- package/src/electron-common/electron-api.ts +55 -55
- package/src/electron-main/electron-api-main.ts +78 -78
- package/src/electron-main/electron-main-module.ts +23 -23
- package/src/node/disk-file-system-provider.spec.ts +142 -109
- package/src/node/disk-file-system-provider.ts +915 -910
- package/src/node/download/directory-archiver.spec.ts +104 -104
- package/src/node/download/directory-archiver.ts +126 -126
- package/src/node/download/file-download-backend-module.ts +32 -32
- package/src/node/download/file-download-cache.ts +88 -88
- package/src/node/download/file-download-endpoint.ts +63 -63
- package/src/node/download/file-download-handler.ts +304 -304
- package/src/node/download/test/mock-directory-archiver.ts +30 -30
- package/src/node/file-change-collection.spec.ts +110 -110
- package/src/node/file-change-collection.ts +78 -78
- package/src/node/filesystem-backend-module.ts +140 -140
- package/src/node/filesystem-watcher-client.ts +72 -72
- package/src/node/filesystem-watcher-dispatcher.ts +82 -82
- package/src/node/node-file-upload-service.ts +80 -80
- package/src/node/nsfw-watcher/index.ts +45 -45
- package/src/node/nsfw-watcher/nsfw-filesystem-service.ts +481 -481
- package/src/node/nsfw-watcher/nsfw-filesystem-watcher.spec.ts +182 -182
- package/src/node/nsfw-watcher/nsfw-options.ts +23 -23
- package/src/typings/dom.webkit.d.ts +77 -77
- package/src/typings/mv/index.d.ts +21 -21
- package/src/typings/nsfw/index.d.ts +18 -18
- package/src/typings/trash/index.d.ts +20 -20
package/lib/common/io.js
CHANGED
|
@@ -1,111 +1,111 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
// *****************************************************************************
|
|
3
|
-
// Copyright (C) 2020 TypeFox and others.
|
|
4
|
-
//
|
|
5
|
-
// This program and the accompanying materials are made available under the
|
|
6
|
-
// terms of the Eclipse Public License v. 2.0 which is available at
|
|
7
|
-
// http://www.eclipse.org/legal/epl-2.0.
|
|
8
|
-
//
|
|
9
|
-
// This Source Code may also be made available under the following Secondary
|
|
10
|
-
// Licenses when the conditions for such availability set forth in the Eclipse
|
|
11
|
-
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
|
|
12
|
-
// with the GNU Classpath Exception which is available at
|
|
13
|
-
// https://www.gnu.org/software/classpath/license.html.
|
|
14
|
-
//
|
|
15
|
-
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
|
|
16
|
-
// *****************************************************************************
|
|
17
|
-
/*---------------------------------------------------------------------------------------------
|
|
18
|
-
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
19
|
-
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
20
|
-
*--------------------------------------------------------------------------------------------*/
|
|
21
|
-
// based on https://github.com/microsoft/vscode/blob/04c36be045a94fee58e5f8992d3e3fd980294a84/src/vs/platform/files/common/io.ts
|
|
22
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
23
|
-
exports.readFileIntoStream = void 0;
|
|
24
|
-
const buffer_1 = require("@theia/core/lib/common//buffer");
|
|
25
|
-
const cancellation_1 = require("@theia/core/lib/common/cancellation");
|
|
26
|
-
const files_1 = require("./files");
|
|
27
|
-
/**
|
|
28
|
-
* A helper to read a file from a provider with open/read/close capability into a stream.
|
|
29
|
-
*/
|
|
30
|
-
async function readFileIntoStream(provider, resource, target, transformer, options, token) {
|
|
31
|
-
let error = undefined;
|
|
32
|
-
try {
|
|
33
|
-
await doReadFileIntoStream(provider, resource, target, transformer, options, token);
|
|
34
|
-
}
|
|
35
|
-
catch (err) {
|
|
36
|
-
error = err;
|
|
37
|
-
}
|
|
38
|
-
finally {
|
|
39
|
-
if (error && options.errorTransformer) {
|
|
40
|
-
error = options.errorTransformer(error);
|
|
41
|
-
}
|
|
42
|
-
target.end(error);
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
exports.readFileIntoStream = readFileIntoStream;
|
|
46
|
-
async function doReadFileIntoStream(provider, resource, target, transformer, options, token) {
|
|
47
|
-
// Check for cancellation
|
|
48
|
-
throwIfCancelled(token);
|
|
49
|
-
// open handle through provider
|
|
50
|
-
const handle = await provider.open(resource, { create: false });
|
|
51
|
-
// Check for cancellation
|
|
52
|
-
throwIfCancelled(token);
|
|
53
|
-
try {
|
|
54
|
-
let totalBytesRead = 0;
|
|
55
|
-
let bytesRead = 0;
|
|
56
|
-
let allowedRemainingBytes = (options && typeof options.length === 'number') ? options.length : undefined;
|
|
57
|
-
let buffer = buffer_1.BinaryBuffer.alloc(Math.min(options.bufferSize, typeof allowedRemainingBytes === 'number' ? allowedRemainingBytes : options.bufferSize));
|
|
58
|
-
let posInFile = options && typeof options.position === 'number' ? options.position : 0;
|
|
59
|
-
let posInBuffer = 0;
|
|
60
|
-
do {
|
|
61
|
-
// read from source (handle) at current position (pos) into buffer (buffer) at
|
|
62
|
-
// buffer position (posInBuffer) up to the size of the buffer (buffer.byteLength).
|
|
63
|
-
bytesRead = await provider.read(handle, posInFile, buffer.buffer, posInBuffer, buffer.byteLength - posInBuffer);
|
|
64
|
-
posInFile += bytesRead;
|
|
65
|
-
posInBuffer += bytesRead;
|
|
66
|
-
totalBytesRead += bytesRead;
|
|
67
|
-
if (typeof allowedRemainingBytes === 'number') {
|
|
68
|
-
allowedRemainingBytes -= bytesRead;
|
|
69
|
-
}
|
|
70
|
-
// when buffer full, create a new one and emit it through stream
|
|
71
|
-
if (posInBuffer === buffer.byteLength) {
|
|
72
|
-
await target.write(transformer(buffer));
|
|
73
|
-
buffer = buffer_1.BinaryBuffer.alloc(Math.min(options.bufferSize, typeof allowedRemainingBytes === 'number' ? allowedRemainingBytes : options.bufferSize));
|
|
74
|
-
posInBuffer = 0;
|
|
75
|
-
}
|
|
76
|
-
} while (bytesRead > 0 && (typeof allowedRemainingBytes !== 'number' || allowedRemainingBytes > 0) && throwIfCancelled(token) && throwIfTooLarge(totalBytesRead, options));
|
|
77
|
-
// wrap up with last buffer (also respect maxBytes if provided)
|
|
78
|
-
if (posInBuffer > 0) {
|
|
79
|
-
let lastChunkLength = posInBuffer;
|
|
80
|
-
if (typeof allowedRemainingBytes === 'number') {
|
|
81
|
-
lastChunkLength = Math.min(posInBuffer, allowedRemainingBytes);
|
|
82
|
-
}
|
|
83
|
-
target.write(transformer(buffer.slice(0, lastChunkLength)));
|
|
84
|
-
}
|
|
85
|
-
}
|
|
86
|
-
catch (error) {
|
|
87
|
-
throw (0, files_1.ensureFileSystemProviderError)(error);
|
|
88
|
-
}
|
|
89
|
-
finally {
|
|
90
|
-
await provider.close(handle);
|
|
91
|
-
}
|
|
92
|
-
}
|
|
93
|
-
function throwIfCancelled(token) {
|
|
94
|
-
if (token.isCancellationRequested) {
|
|
95
|
-
throw (0, cancellation_1.cancelled)();
|
|
96
|
-
}
|
|
97
|
-
return true;
|
|
98
|
-
}
|
|
99
|
-
function throwIfTooLarge(totalBytesRead, options) {
|
|
100
|
-
// Return early if file is too large to load and we have configured limits
|
|
101
|
-
if (options === null || options === void 0 ? void 0 : options.limits) {
|
|
102
|
-
if (typeof options.limits.memory === 'number' && totalBytesRead > options.limits.memory) {
|
|
103
|
-
throw (0, files_1.createFileSystemProviderError)('To open a file of this size, you need to restart and allow it to use more memory', files_1.FileSystemProviderErrorCode.FileExceedsMemoryLimit);
|
|
104
|
-
}
|
|
105
|
-
if (typeof options.limits.size === 'number' && totalBytesRead > options.limits.size) {
|
|
106
|
-
throw (0, files_1.createFileSystemProviderError)('File is too large to open', files_1.FileSystemProviderErrorCode.FileTooLarge);
|
|
107
|
-
}
|
|
108
|
-
}
|
|
109
|
-
return true;
|
|
110
|
-
}
|
|
1
|
+
"use strict";
|
|
2
|
+
// *****************************************************************************
|
|
3
|
+
// Copyright (C) 2020 TypeFox and others.
|
|
4
|
+
//
|
|
5
|
+
// This program and the accompanying materials are made available under the
|
|
6
|
+
// terms of the Eclipse Public License v. 2.0 which is available at
|
|
7
|
+
// http://www.eclipse.org/legal/epl-2.0.
|
|
8
|
+
//
|
|
9
|
+
// This Source Code may also be made available under the following Secondary
|
|
10
|
+
// Licenses when the conditions for such availability set forth in the Eclipse
|
|
11
|
+
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
|
|
12
|
+
// with the GNU Classpath Exception which is available at
|
|
13
|
+
// https://www.gnu.org/software/classpath/license.html.
|
|
14
|
+
//
|
|
15
|
+
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
|
|
16
|
+
// *****************************************************************************
|
|
17
|
+
/*---------------------------------------------------------------------------------------------
|
|
18
|
+
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
19
|
+
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
20
|
+
*--------------------------------------------------------------------------------------------*/
|
|
21
|
+
// based on https://github.com/microsoft/vscode/blob/04c36be045a94fee58e5f8992d3e3fd980294a84/src/vs/platform/files/common/io.ts
|
|
22
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
23
|
+
exports.readFileIntoStream = void 0;
|
|
24
|
+
const buffer_1 = require("@theia/core/lib/common//buffer");
|
|
25
|
+
const cancellation_1 = require("@theia/core/lib/common/cancellation");
|
|
26
|
+
const files_1 = require("./files");
|
|
27
|
+
/**
|
|
28
|
+
* A helper to read a file from a provider with open/read/close capability into a stream.
|
|
29
|
+
*/
|
|
30
|
+
async function readFileIntoStream(provider, resource, target, transformer, options, token) {
|
|
31
|
+
let error = undefined;
|
|
32
|
+
try {
|
|
33
|
+
await doReadFileIntoStream(provider, resource, target, transformer, options, token);
|
|
34
|
+
}
|
|
35
|
+
catch (err) {
|
|
36
|
+
error = err;
|
|
37
|
+
}
|
|
38
|
+
finally {
|
|
39
|
+
if (error && options.errorTransformer) {
|
|
40
|
+
error = options.errorTransformer(error);
|
|
41
|
+
}
|
|
42
|
+
target.end(error);
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
exports.readFileIntoStream = readFileIntoStream;
|
|
46
|
+
async function doReadFileIntoStream(provider, resource, target, transformer, options, token) {
|
|
47
|
+
// Check for cancellation
|
|
48
|
+
throwIfCancelled(token);
|
|
49
|
+
// open handle through provider
|
|
50
|
+
const handle = await provider.open(resource, { create: false });
|
|
51
|
+
// Check for cancellation
|
|
52
|
+
throwIfCancelled(token);
|
|
53
|
+
try {
|
|
54
|
+
let totalBytesRead = 0;
|
|
55
|
+
let bytesRead = 0;
|
|
56
|
+
let allowedRemainingBytes = (options && typeof options.length === 'number') ? options.length : undefined;
|
|
57
|
+
let buffer = buffer_1.BinaryBuffer.alloc(Math.min(options.bufferSize, typeof allowedRemainingBytes === 'number' ? allowedRemainingBytes : options.bufferSize));
|
|
58
|
+
let posInFile = options && typeof options.position === 'number' ? options.position : 0;
|
|
59
|
+
let posInBuffer = 0;
|
|
60
|
+
do {
|
|
61
|
+
// read from source (handle) at current position (pos) into buffer (buffer) at
|
|
62
|
+
// buffer position (posInBuffer) up to the size of the buffer (buffer.byteLength).
|
|
63
|
+
bytesRead = await provider.read(handle, posInFile, buffer.buffer, posInBuffer, buffer.byteLength - posInBuffer);
|
|
64
|
+
posInFile += bytesRead;
|
|
65
|
+
posInBuffer += bytesRead;
|
|
66
|
+
totalBytesRead += bytesRead;
|
|
67
|
+
if (typeof allowedRemainingBytes === 'number') {
|
|
68
|
+
allowedRemainingBytes -= bytesRead;
|
|
69
|
+
}
|
|
70
|
+
// when buffer full, create a new one and emit it through stream
|
|
71
|
+
if (posInBuffer === buffer.byteLength) {
|
|
72
|
+
await target.write(transformer(buffer));
|
|
73
|
+
buffer = buffer_1.BinaryBuffer.alloc(Math.min(options.bufferSize, typeof allowedRemainingBytes === 'number' ? allowedRemainingBytes : options.bufferSize));
|
|
74
|
+
posInBuffer = 0;
|
|
75
|
+
}
|
|
76
|
+
} while (bytesRead > 0 && (typeof allowedRemainingBytes !== 'number' || allowedRemainingBytes > 0) && throwIfCancelled(token) && throwIfTooLarge(totalBytesRead, options));
|
|
77
|
+
// wrap up with last buffer (also respect maxBytes if provided)
|
|
78
|
+
if (posInBuffer > 0) {
|
|
79
|
+
let lastChunkLength = posInBuffer;
|
|
80
|
+
if (typeof allowedRemainingBytes === 'number') {
|
|
81
|
+
lastChunkLength = Math.min(posInBuffer, allowedRemainingBytes);
|
|
82
|
+
}
|
|
83
|
+
target.write(transformer(buffer.slice(0, lastChunkLength)));
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
catch (error) {
|
|
87
|
+
throw (0, files_1.ensureFileSystemProviderError)(error);
|
|
88
|
+
}
|
|
89
|
+
finally {
|
|
90
|
+
await provider.close(handle);
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
function throwIfCancelled(token) {
|
|
94
|
+
if (token.isCancellationRequested) {
|
|
95
|
+
throw (0, cancellation_1.cancelled)();
|
|
96
|
+
}
|
|
97
|
+
return true;
|
|
98
|
+
}
|
|
99
|
+
function throwIfTooLarge(totalBytesRead, options) {
|
|
100
|
+
// Return early if file is too large to load and we have configured limits
|
|
101
|
+
if (options === null || options === void 0 ? void 0 : options.limits) {
|
|
102
|
+
if (typeof options.limits.memory === 'number' && totalBytesRead > options.limits.memory) {
|
|
103
|
+
throw (0, files_1.createFileSystemProviderError)('To open a file of this size, you need to restart and allow it to use more memory', files_1.FileSystemProviderErrorCode.FileExceedsMemoryLimit);
|
|
104
|
+
}
|
|
105
|
+
if (typeof options.limits.size === 'number' && totalBytesRead > options.limits.size) {
|
|
106
|
+
throw (0, files_1.createFileSystemProviderError)('File is too large to open', files_1.FileSystemProviderErrorCode.FileTooLarge);
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
return true;
|
|
110
|
+
}
|
|
111
111
|
//# sourceMappingURL=io.js.map
|
|
@@ -1,165 +1,165 @@
|
|
|
1
|
-
import URI from '@theia/core/lib/common/uri';
|
|
2
|
-
import { Disposable, DisposableCollection } from '@theia/core/lib/common/disposable';
|
|
3
|
-
import { FileWriteOptions, FileOpenOptions, FileChangeType, FileSystemProviderCapabilities, FileChange, Stat, FileOverwriteOptions, WatchOptions, FileType, FileSystemProvider, FileDeleteOptions, FileSystemProviderErrorCode, FileUpdateOptions, FileUpdateResult, FileReadStreamOptions } from './files';
|
|
4
|
-
import { RpcServer, RpcProxy, RpcProxyFactory } from '@theia/core/lib/common/messaging/proxy-factory';
|
|
5
|
-
import { ApplicationError } from '@theia/core/lib/common/application-error';
|
|
6
|
-
import { Deferred } from '@theia/core/lib/common/promise-util';
|
|
7
|
-
import type { TextDocumentContentChangeEvent } from '@theia/core/shared/vscode-languageserver-protocol';
|
|
8
|
-
import { ReadableStreamEvents } from '@theia/core/lib/common/stream';
|
|
9
|
-
import { CancellationToken } from '@theia/core/lib/common/cancellation';
|
|
10
|
-
export declare const remoteFileSystemPath = "/services/remote-filesystem";
|
|
11
|
-
export declare const RemoteFileSystemServer: unique symbol;
|
|
12
|
-
export interface RemoteFileSystemServer extends RpcServer<RemoteFileSystemClient> {
|
|
13
|
-
getCapabilities(): Promise<FileSystemProviderCapabilities>;
|
|
14
|
-
stat(resource: string): Promise<Stat>;
|
|
15
|
-
access(resource: string, mode?: number): Promise<void>;
|
|
16
|
-
fsPath(resource: string): Promise<string>;
|
|
17
|
-
open(resource: string, opts: FileOpenOptions): Promise<number>;
|
|
18
|
-
close(fd: number): Promise<void>;
|
|
19
|
-
read(fd: number, pos: number, length: number): Promise<{
|
|
20
|
-
bytes: Uint8Array;
|
|
21
|
-
bytesRead: number;
|
|
22
|
-
}>;
|
|
23
|
-
readFileStream(resource: string, opts: FileReadStreamOptions, token: CancellationToken): Promise<number>;
|
|
24
|
-
readFile(resource: string): Promise<Uint8Array>;
|
|
25
|
-
write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
|
|
26
|
-
writeFile(resource: string, content: Uint8Array, opts: FileWriteOptions): Promise<void>;
|
|
27
|
-
delete(resource: string, opts: FileDeleteOptions): Promise<void>;
|
|
28
|
-
mkdir(resource: string): Promise<void>;
|
|
29
|
-
readdir(resource: string): Promise<[string, FileType][]>;
|
|
30
|
-
rename(source: string, target: string, opts: FileOverwriteOptions): Promise<void>;
|
|
31
|
-
copy(source: string, target: string, opts: FileOverwriteOptions): Promise<void>;
|
|
32
|
-
watch(watcher: number, resource: string, opts: WatchOptions): Promise<void>;
|
|
33
|
-
unwatch(watcher: number): Promise<void>;
|
|
34
|
-
updateFile(resource: string, changes: TextDocumentContentChangeEvent[], opts: FileUpdateOptions): Promise<FileUpdateResult>;
|
|
35
|
-
}
|
|
36
|
-
export interface RemoteFileChange {
|
|
37
|
-
readonly type: FileChangeType;
|
|
38
|
-
readonly resource: string;
|
|
39
|
-
}
|
|
40
|
-
export interface RemoteFileStreamError extends Error {
|
|
41
|
-
code?: FileSystemProviderErrorCode;
|
|
42
|
-
}
|
|
43
|
-
export interface RemoteFileSystemClient {
|
|
44
|
-
notifyDidChangeFile(event: {
|
|
45
|
-
changes: RemoteFileChange[];
|
|
46
|
-
}): void;
|
|
47
|
-
notifyFileWatchError(): void;
|
|
48
|
-
notifyDidChangeCapabilities(capabilities: FileSystemProviderCapabilities): void;
|
|
49
|
-
onFileStreamData(handle: number, data: Uint8Array): void;
|
|
50
|
-
onFileStreamEnd(handle: number, error: RemoteFileStreamError | undefined): void;
|
|
51
|
-
}
|
|
52
|
-
export declare const RemoteFileSystemProviderError: ApplicationError.Constructor<-33005, {
|
|
53
|
-
code: FileSystemProviderErrorCode;
|
|
54
|
-
name: string;
|
|
55
|
-
}>;
|
|
56
|
-
export declare class RemoteFileSystemProxyFactory<T extends object> extends RpcProxyFactory<T> {
|
|
57
|
-
protected serializeError(e: any): any;
|
|
58
|
-
protected deserializeError(capturedError: Error, e: any): any;
|
|
59
|
-
}
|
|
60
|
-
/**
|
|
61
|
-
* Frontend component.
|
|
62
|
-
*
|
|
63
|
-
* Wraps the remote filesystem provider living on the backend.
|
|
64
|
-
*/
|
|
65
|
-
export declare class RemoteFileSystemProvider implements Required<FileSystemProvider>, Disposable {
|
|
66
|
-
private readonly onDidChangeFileEmitter;
|
|
67
|
-
readonly onDidChangeFile: import("@theia/core/lib/common/event").Event<readonly FileChange[]>;
|
|
68
|
-
private readonly onFileWatchErrorEmitter;
|
|
69
|
-
readonly onFileWatchError: import("@theia/core/lib/common/event").Event<void>;
|
|
70
|
-
private readonly onDidChangeCapabilitiesEmitter;
|
|
71
|
-
readonly onDidChangeCapabilities: import("@theia/core/lib/common/event").Event<void>;
|
|
72
|
-
private readonly onFileStreamDataEmitter;
|
|
73
|
-
private readonly onFileStreamData;
|
|
74
|
-
private readonly onFileStreamEndEmitter;
|
|
75
|
-
private readonly onFileStreamEnd;
|
|
76
|
-
protected readonly toDispose: DisposableCollection;
|
|
77
|
-
protected watcherSequence: number;
|
|
78
|
-
/**
|
|
79
|
-
* We'll track the currently allocated watchers, in order to re-allocate them
|
|
80
|
-
* with the same options once we reconnect to the backend after a disconnection.
|
|
81
|
-
*/
|
|
82
|
-
protected readonly watchOptions: Map<number, {
|
|
83
|
-
uri: string;
|
|
84
|
-
options: WatchOptions;
|
|
85
|
-
}>;
|
|
86
|
-
private _capabilities;
|
|
87
|
-
get capabilities(): FileSystemProviderCapabilities;
|
|
88
|
-
protected readonly readyDeferred: Deferred<void>;
|
|
89
|
-
readonly ready: Promise<void>;
|
|
90
|
-
/**
|
|
91
|
-
* Wrapped remote filesystem.
|
|
92
|
-
*/
|
|
93
|
-
protected readonly server: RpcProxy<RemoteFileSystemServer>;
|
|
94
|
-
protected init(): void;
|
|
95
|
-
dispose(): void;
|
|
96
|
-
protected setCapabilities(capabilities: FileSystemProviderCapabilities): void;
|
|
97
|
-
stat(resource: URI): Promise<Stat>;
|
|
98
|
-
access(resource: URI, mode?: number): Promise<void>;
|
|
99
|
-
fsPath(resource: URI): Promise<string>;
|
|
100
|
-
open(resource: URI, opts: FileOpenOptions): Promise<number>;
|
|
101
|
-
close(fd: number): Promise<void>;
|
|
102
|
-
read(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
|
|
103
|
-
readFile(resource: URI): Promise<Uint8Array>;
|
|
104
|
-
readFileStream(resource: URI, opts: FileReadStreamOptions, token: CancellationToken): ReadableStreamEvents<Uint8Array>;
|
|
105
|
-
write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
|
|
106
|
-
writeFile(resource: URI, content: Uint8Array, opts: FileWriteOptions): Promise<void>;
|
|
107
|
-
delete(resource: URI, opts: FileDeleteOptions): Promise<void>;
|
|
108
|
-
mkdir(resource: URI): Promise<void>;
|
|
109
|
-
readdir(resource: URI): Promise<[string, FileType][]>;
|
|
110
|
-
rename(resource: URI, target: URI, opts: FileOverwriteOptions): Promise<void>;
|
|
111
|
-
copy(resource: URI, target: URI, opts: FileOverwriteOptions): Promise<void>;
|
|
112
|
-
updateFile(resource: URI, changes: TextDocumentContentChangeEvent[], opts: FileUpdateOptions): Promise<FileUpdateResult>;
|
|
113
|
-
watch(resource: URI, options: WatchOptions): Disposable;
|
|
114
|
-
/**
|
|
115
|
-
* When a frontend disconnects (e.g. bad connection) the backend resources will be cleared.
|
|
116
|
-
*
|
|
117
|
-
* This means that we need to re-allocate the watchers when a frontend reconnects.
|
|
118
|
-
*/
|
|
119
|
-
protected reconnect(): void;
|
|
120
|
-
}
|
|
121
|
-
/**
|
|
122
|
-
* Backend component.
|
|
123
|
-
*
|
|
124
|
-
* JSON-RPC server exposing a wrapped file system provider remotely.
|
|
125
|
-
*/
|
|
126
|
-
export declare class FileSystemProviderServer implements RemoteFileSystemServer {
|
|
127
|
-
private readonly BUFFER_SIZE;
|
|
128
|
-
/**
|
|
129
|
-
* Mapping of `watcherId` to a disposable watcher handle.
|
|
130
|
-
*/
|
|
131
|
-
protected watchers: Map<number, Disposable>;
|
|
132
|
-
protected readonly toDispose: DisposableCollection;
|
|
133
|
-
dispose(): void;
|
|
134
|
-
protected client: RemoteFileSystemClient | undefined;
|
|
135
|
-
setClient(client: RemoteFileSystemClient | undefined): void;
|
|
136
|
-
/**
|
|
137
|
-
* Wrapped file system provider.
|
|
138
|
-
*/
|
|
139
|
-
protected readonly provider: FileSystemProvider & Partial<Disposable>;
|
|
140
|
-
protected init(): void;
|
|
141
|
-
getCapabilities(): Promise<FileSystemProviderCapabilities>;
|
|
142
|
-
stat(resource: string): Promise<Stat>;
|
|
143
|
-
access(resource: string, mode?: number): Promise<void>;
|
|
144
|
-
fsPath(resource: string): Promise<string>;
|
|
145
|
-
open(resource: string, opts: FileOpenOptions): Promise<number>;
|
|
146
|
-
close(fd: number): Promise<void>;
|
|
147
|
-
read(fd: number, pos: number, length: number): Promise<{
|
|
148
|
-
bytes: Uint8Array;
|
|
149
|
-
bytesRead: number;
|
|
150
|
-
}>;
|
|
151
|
-
write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
|
|
152
|
-
readFile(resource: string): Promise<Uint8Array>;
|
|
153
|
-
writeFile(resource: string, content: Uint8Array, opts: FileWriteOptions): Promise<void>;
|
|
154
|
-
delete(resource: string, opts: FileDeleteOptions): Promise<void>;
|
|
155
|
-
mkdir(resource: string): Promise<void>;
|
|
156
|
-
readdir(resource: string): Promise<[string, FileType][]>;
|
|
157
|
-
rename(source: string, target: string, opts: FileOverwriteOptions): Promise<void>;
|
|
158
|
-
copy(source: string, target: string, opts: FileOverwriteOptions): Promise<void>;
|
|
159
|
-
updateFile(resource: string, changes: TextDocumentContentChangeEvent[], opts: FileUpdateOptions): Promise<FileUpdateResult>;
|
|
160
|
-
watch(requestedWatcherId: number, resource: string, opts: WatchOptions): Promise<void>;
|
|
161
|
-
unwatch(watcherId: number): Promise<void>;
|
|
162
|
-
protected readFileStreamSeq: number;
|
|
163
|
-
readFileStream(resource: string, opts: FileReadStreamOptions, token: CancellationToken): Promise<number>;
|
|
164
|
-
}
|
|
1
|
+
import URI from '@theia/core/lib/common/uri';
|
|
2
|
+
import { Disposable, DisposableCollection } from '@theia/core/lib/common/disposable';
|
|
3
|
+
import { FileWriteOptions, FileOpenOptions, FileChangeType, FileSystemProviderCapabilities, FileChange, Stat, FileOverwriteOptions, WatchOptions, FileType, FileSystemProvider, FileDeleteOptions, FileSystemProviderErrorCode, FileUpdateOptions, FileUpdateResult, FileReadStreamOptions } from './files';
|
|
4
|
+
import { RpcServer, RpcProxy, RpcProxyFactory } from '@theia/core/lib/common/messaging/proxy-factory';
|
|
5
|
+
import { ApplicationError } from '@theia/core/lib/common/application-error';
|
|
6
|
+
import { Deferred } from '@theia/core/lib/common/promise-util';
|
|
7
|
+
import type { TextDocumentContentChangeEvent } from '@theia/core/shared/vscode-languageserver-protocol';
|
|
8
|
+
import { ReadableStreamEvents } from '@theia/core/lib/common/stream';
|
|
9
|
+
import { CancellationToken } from '@theia/core/lib/common/cancellation';
|
|
10
|
+
export declare const remoteFileSystemPath = "/services/remote-filesystem";
|
|
11
|
+
export declare const RemoteFileSystemServer: unique symbol;
|
|
12
|
+
export interface RemoteFileSystemServer extends RpcServer<RemoteFileSystemClient> {
|
|
13
|
+
getCapabilities(): Promise<FileSystemProviderCapabilities>;
|
|
14
|
+
stat(resource: string): Promise<Stat>;
|
|
15
|
+
access(resource: string, mode?: number): Promise<void>;
|
|
16
|
+
fsPath(resource: string): Promise<string>;
|
|
17
|
+
open(resource: string, opts: FileOpenOptions): Promise<number>;
|
|
18
|
+
close(fd: number): Promise<void>;
|
|
19
|
+
read(fd: number, pos: number, length: number): Promise<{
|
|
20
|
+
bytes: Uint8Array;
|
|
21
|
+
bytesRead: number;
|
|
22
|
+
}>;
|
|
23
|
+
readFileStream(resource: string, opts: FileReadStreamOptions, token: CancellationToken): Promise<number>;
|
|
24
|
+
readFile(resource: string): Promise<Uint8Array>;
|
|
25
|
+
write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
|
|
26
|
+
writeFile(resource: string, content: Uint8Array, opts: FileWriteOptions): Promise<void>;
|
|
27
|
+
delete(resource: string, opts: FileDeleteOptions): Promise<void>;
|
|
28
|
+
mkdir(resource: string): Promise<void>;
|
|
29
|
+
readdir(resource: string): Promise<[string, FileType][]>;
|
|
30
|
+
rename(source: string, target: string, opts: FileOverwriteOptions): Promise<void>;
|
|
31
|
+
copy(source: string, target: string, opts: FileOverwriteOptions): Promise<void>;
|
|
32
|
+
watch(watcher: number, resource: string, opts: WatchOptions): Promise<void>;
|
|
33
|
+
unwatch(watcher: number): Promise<void>;
|
|
34
|
+
updateFile(resource: string, changes: TextDocumentContentChangeEvent[], opts: FileUpdateOptions): Promise<FileUpdateResult>;
|
|
35
|
+
}
|
|
36
|
+
export interface RemoteFileChange {
|
|
37
|
+
readonly type: FileChangeType;
|
|
38
|
+
readonly resource: string;
|
|
39
|
+
}
|
|
40
|
+
export interface RemoteFileStreamError extends Error {
|
|
41
|
+
code?: FileSystemProviderErrorCode;
|
|
42
|
+
}
|
|
43
|
+
export interface RemoteFileSystemClient {
|
|
44
|
+
notifyDidChangeFile(event: {
|
|
45
|
+
changes: RemoteFileChange[];
|
|
46
|
+
}): void;
|
|
47
|
+
notifyFileWatchError(): void;
|
|
48
|
+
notifyDidChangeCapabilities(capabilities: FileSystemProviderCapabilities): void;
|
|
49
|
+
onFileStreamData(handle: number, data: Uint8Array): void;
|
|
50
|
+
onFileStreamEnd(handle: number, error: RemoteFileStreamError | undefined): void;
|
|
51
|
+
}
|
|
52
|
+
export declare const RemoteFileSystemProviderError: ApplicationError.Constructor<-33005, {
|
|
53
|
+
code: FileSystemProviderErrorCode;
|
|
54
|
+
name: string;
|
|
55
|
+
}>;
|
|
56
|
+
export declare class RemoteFileSystemProxyFactory<T extends object> extends RpcProxyFactory<T> {
|
|
57
|
+
protected serializeError(e: any): any;
|
|
58
|
+
protected deserializeError(capturedError: Error, e: any): any;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Frontend component.
|
|
62
|
+
*
|
|
63
|
+
* Wraps the remote filesystem provider living on the backend.
|
|
64
|
+
*/
|
|
65
|
+
export declare class RemoteFileSystemProvider implements Required<FileSystemProvider>, Disposable {
|
|
66
|
+
private readonly onDidChangeFileEmitter;
|
|
67
|
+
readonly onDidChangeFile: import("@theia/core/lib/common/event").Event<readonly FileChange[]>;
|
|
68
|
+
private readonly onFileWatchErrorEmitter;
|
|
69
|
+
readonly onFileWatchError: import("@theia/core/lib/common/event").Event<void>;
|
|
70
|
+
private readonly onDidChangeCapabilitiesEmitter;
|
|
71
|
+
readonly onDidChangeCapabilities: import("@theia/core/lib/common/event").Event<void>;
|
|
72
|
+
private readonly onFileStreamDataEmitter;
|
|
73
|
+
private readonly onFileStreamData;
|
|
74
|
+
private readonly onFileStreamEndEmitter;
|
|
75
|
+
private readonly onFileStreamEnd;
|
|
76
|
+
protected readonly toDispose: DisposableCollection;
|
|
77
|
+
protected watcherSequence: number;
|
|
78
|
+
/**
|
|
79
|
+
* We'll track the currently allocated watchers, in order to re-allocate them
|
|
80
|
+
* with the same options once we reconnect to the backend after a disconnection.
|
|
81
|
+
*/
|
|
82
|
+
protected readonly watchOptions: Map<number, {
|
|
83
|
+
uri: string;
|
|
84
|
+
options: WatchOptions;
|
|
85
|
+
}>;
|
|
86
|
+
private _capabilities;
|
|
87
|
+
get capabilities(): FileSystemProviderCapabilities;
|
|
88
|
+
protected readonly readyDeferred: Deferred<void>;
|
|
89
|
+
readonly ready: Promise<void>;
|
|
90
|
+
/**
|
|
91
|
+
* Wrapped remote filesystem.
|
|
92
|
+
*/
|
|
93
|
+
protected readonly server: RpcProxy<RemoteFileSystemServer>;
|
|
94
|
+
protected init(): void;
|
|
95
|
+
dispose(): void;
|
|
96
|
+
protected setCapabilities(capabilities: FileSystemProviderCapabilities): void;
|
|
97
|
+
stat(resource: URI): Promise<Stat>;
|
|
98
|
+
access(resource: URI, mode?: number): Promise<void>;
|
|
99
|
+
fsPath(resource: URI): Promise<string>;
|
|
100
|
+
open(resource: URI, opts: FileOpenOptions): Promise<number>;
|
|
101
|
+
close(fd: number): Promise<void>;
|
|
102
|
+
read(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
|
|
103
|
+
readFile(resource: URI): Promise<Uint8Array>;
|
|
104
|
+
readFileStream(resource: URI, opts: FileReadStreamOptions, token: CancellationToken): ReadableStreamEvents<Uint8Array>;
|
|
105
|
+
write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
|
|
106
|
+
writeFile(resource: URI, content: Uint8Array, opts: FileWriteOptions): Promise<void>;
|
|
107
|
+
delete(resource: URI, opts: FileDeleteOptions): Promise<void>;
|
|
108
|
+
mkdir(resource: URI): Promise<void>;
|
|
109
|
+
readdir(resource: URI): Promise<[string, FileType][]>;
|
|
110
|
+
rename(resource: URI, target: URI, opts: FileOverwriteOptions): Promise<void>;
|
|
111
|
+
copy(resource: URI, target: URI, opts: FileOverwriteOptions): Promise<void>;
|
|
112
|
+
updateFile(resource: URI, changes: TextDocumentContentChangeEvent[], opts: FileUpdateOptions): Promise<FileUpdateResult>;
|
|
113
|
+
watch(resource: URI, options: WatchOptions): Disposable;
|
|
114
|
+
/**
|
|
115
|
+
* When a frontend disconnects (e.g. bad connection) the backend resources will be cleared.
|
|
116
|
+
*
|
|
117
|
+
* This means that we need to re-allocate the watchers when a frontend reconnects.
|
|
118
|
+
*/
|
|
119
|
+
protected reconnect(): void;
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Backend component.
|
|
123
|
+
*
|
|
124
|
+
* JSON-RPC server exposing a wrapped file system provider remotely.
|
|
125
|
+
*/
|
|
126
|
+
export declare class FileSystemProviderServer implements RemoteFileSystemServer {
|
|
127
|
+
private readonly BUFFER_SIZE;
|
|
128
|
+
/**
|
|
129
|
+
* Mapping of `watcherId` to a disposable watcher handle.
|
|
130
|
+
*/
|
|
131
|
+
protected watchers: Map<number, Disposable>;
|
|
132
|
+
protected readonly toDispose: DisposableCollection;
|
|
133
|
+
dispose(): void;
|
|
134
|
+
protected client: RemoteFileSystemClient | undefined;
|
|
135
|
+
setClient(client: RemoteFileSystemClient | undefined): void;
|
|
136
|
+
/**
|
|
137
|
+
* Wrapped file system provider.
|
|
138
|
+
*/
|
|
139
|
+
protected readonly provider: FileSystemProvider & Partial<Disposable>;
|
|
140
|
+
protected init(): void;
|
|
141
|
+
getCapabilities(): Promise<FileSystemProviderCapabilities>;
|
|
142
|
+
stat(resource: string): Promise<Stat>;
|
|
143
|
+
access(resource: string, mode?: number): Promise<void>;
|
|
144
|
+
fsPath(resource: string): Promise<string>;
|
|
145
|
+
open(resource: string, opts: FileOpenOptions): Promise<number>;
|
|
146
|
+
close(fd: number): Promise<void>;
|
|
147
|
+
read(fd: number, pos: number, length: number): Promise<{
|
|
148
|
+
bytes: Uint8Array;
|
|
149
|
+
bytesRead: number;
|
|
150
|
+
}>;
|
|
151
|
+
write(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise<number>;
|
|
152
|
+
readFile(resource: string): Promise<Uint8Array>;
|
|
153
|
+
writeFile(resource: string, content: Uint8Array, opts: FileWriteOptions): Promise<void>;
|
|
154
|
+
delete(resource: string, opts: FileDeleteOptions): Promise<void>;
|
|
155
|
+
mkdir(resource: string): Promise<void>;
|
|
156
|
+
readdir(resource: string): Promise<[string, FileType][]>;
|
|
157
|
+
rename(source: string, target: string, opts: FileOverwriteOptions): Promise<void>;
|
|
158
|
+
copy(source: string, target: string, opts: FileOverwriteOptions): Promise<void>;
|
|
159
|
+
updateFile(resource: string, changes: TextDocumentContentChangeEvent[], opts: FileUpdateOptions): Promise<FileUpdateResult>;
|
|
160
|
+
watch(requestedWatcherId: number, resource: string, opts: WatchOptions): Promise<void>;
|
|
161
|
+
unwatch(watcherId: number): Promise<void>;
|
|
162
|
+
protected readFileStreamSeq: number;
|
|
163
|
+
readFileStream(resource: string, opts: FileReadStreamOptions, token: CancellationToken): Promise<number>;
|
|
164
|
+
}
|
|
165
165
|
//# sourceMappingURL=remote-file-system-provider.d.ts.map
|