@theia/filesystem 1.45.0 → 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
|
@@ -1,406 +1,406 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
// *****************************************************************************
|
|
3
|
-
// Copyright (C) 2017-2018 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
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
exports.NsfwFileSystemWatcherService = exports.NsfwWatcher = exports.WatcherDisposal = exports.NsfwFileSystemWatcherServerOptions = void 0;
|
|
19
|
-
const nsfw = require("@theia/core/shared/nsfw");
|
|
20
|
-
const path = require("path");
|
|
21
|
-
const fs_1 = require("fs");
|
|
22
|
-
const minimatch_1 = require("minimatch");
|
|
23
|
-
const file_uri_1 = require("@theia/core/lib/
|
|
24
|
-
const file_change_collection_1 = require("../file-change-collection");
|
|
25
|
-
const promise_util_1 = require("@theia/core/lib/common/promise-util");
|
|
26
|
-
exports.NsfwFileSystemWatcherServerOptions = Symbol('NsfwFileSystemWatcherServerOptions');
|
|
27
|
-
/**
|
|
28
|
-
* This is a flag value passed around upon disposal.
|
|
29
|
-
*/
|
|
30
|
-
exports.WatcherDisposal = Symbol('WatcherDisposal');
|
|
31
|
-
/**
|
|
32
|
-
* Because URIs can be watched by different clients, we'll track
|
|
33
|
-
* how many are listening for a given URI.
|
|
34
|
-
*
|
|
35
|
-
* This component wraps the whole start/stop process given some
|
|
36
|
-
* reference count.
|
|
37
|
-
*
|
|
38
|
-
* Once there are no more references the handle
|
|
39
|
-
* will wait for some time before destroying its resources.
|
|
40
|
-
*/
|
|
41
|
-
class NsfwWatcher {
|
|
42
|
-
constructor(
|
|
43
|
-
/** Initial reference to this handle. */
|
|
44
|
-
initialClientId,
|
|
45
|
-
/** Filesystem path to be watched. */
|
|
46
|
-
fsPath,
|
|
47
|
-
/** Watcher-specific options */
|
|
48
|
-
watcherOptions,
|
|
49
|
-
/** Logging and Nsfw options */
|
|
50
|
-
nsfwFileSystemWatchServerOptions,
|
|
51
|
-
/** The client to forward events to. */
|
|
52
|
-
fileSystemWatcherClient,
|
|
53
|
-
/** Amount of time in ms to wait once this handle is not referenced anymore. */
|
|
54
|
-
deferredDisposalTimeout = 10000) {
|
|
55
|
-
this.fsPath = fsPath;
|
|
56
|
-
this.watcherOptions = watcherOptions;
|
|
57
|
-
this.nsfwFileSystemWatchServerOptions = nsfwFileSystemWatchServerOptions;
|
|
58
|
-
this.fileSystemWatcherClient = fileSystemWatcherClient;
|
|
59
|
-
this.deferredDisposalTimeout = deferredDisposalTimeout;
|
|
60
|
-
this.disposed = false;
|
|
61
|
-
/**
|
|
62
|
-
* Used for debugging to keep track of the watchers.
|
|
63
|
-
*/
|
|
64
|
-
this.debugId = NsfwWatcher.debugIdSequence++;
|
|
65
|
-
/**
|
|
66
|
-
* This deferred only rejects with `WatcherDisposal` and never resolves.
|
|
67
|
-
*/
|
|
68
|
-
this.deferredDisposalDeferred = new promise_util_1.Deferred();
|
|
69
|
-
/**
|
|
70
|
-
* We count each reference made to this watcher, per client.
|
|
71
|
-
*
|
|
72
|
-
* We do this to know where to send events via the network.
|
|
73
|
-
*
|
|
74
|
-
* An entry should be removed when its value hits zero.
|
|
75
|
-
*/
|
|
76
|
-
this.refsPerClient = new Map();
|
|
77
|
-
/**
|
|
78
|
-
* Ensures that events are processed in the order they are emitted,
|
|
79
|
-
* despite being processed async.
|
|
80
|
-
*/
|
|
81
|
-
this.nsfwEventProcessingQueue = Promise.resolve();
|
|
82
|
-
/**
|
|
83
|
-
* Resolves once this handle disposed itself and its resources. Never throws.
|
|
84
|
-
*/
|
|
85
|
-
this.whenDisposed = this.deferredDisposalDeferred.promise.catch(() => undefined);
|
|
86
|
-
this.refsPerClient.set(initialClientId, { value: 1 });
|
|
87
|
-
this.whenStarted = this.start().then(() => true, error => {
|
|
88
|
-
if (error === exports.WatcherDisposal) {
|
|
89
|
-
return false;
|
|
90
|
-
}
|
|
91
|
-
this._dispose();
|
|
92
|
-
this.fireError();
|
|
93
|
-
throw error;
|
|
94
|
-
});
|
|
95
|
-
this.debug('NEW', `initialClientId=${initialClientId}`);
|
|
96
|
-
}
|
|
97
|
-
addRef(clientId) {
|
|
98
|
-
let refs = this.refsPerClient.get(clientId);
|
|
99
|
-
if (typeof refs === 'undefined') {
|
|
100
|
-
this.refsPerClient.set(clientId, refs = { value: 1 });
|
|
101
|
-
}
|
|
102
|
-
else {
|
|
103
|
-
refs.value += 1;
|
|
104
|
-
}
|
|
105
|
-
const totalRefs = this.getTotalReferences();
|
|
106
|
-
// If it was zero before, 1 means we were revived:
|
|
107
|
-
const revived = totalRefs === 1;
|
|
108
|
-
if (revived) {
|
|
109
|
-
this.onRefsRevive();
|
|
110
|
-
}
|
|
111
|
-
this.debug('REF++', `clientId=${clientId}, clientRefs=${refs.value}, totalRefs=${totalRefs}. revived=${revived}`);
|
|
112
|
-
}
|
|
113
|
-
removeRef(clientId) {
|
|
114
|
-
const refs = this.refsPerClient.get(clientId);
|
|
115
|
-
if (typeof refs === 'undefined') {
|
|
116
|
-
this.info('WARN REF--', `removed one too many reference: clientId=${clientId}`);
|
|
117
|
-
return;
|
|
118
|
-
}
|
|
119
|
-
refs.value -= 1;
|
|
120
|
-
// We must remove the key from `this.clientReferences` because
|
|
121
|
-
// we list active clients by reading the keys of this map.
|
|
122
|
-
if (refs.value === 0) {
|
|
123
|
-
this.refsPerClient.delete(clientId);
|
|
124
|
-
}
|
|
125
|
-
const totalRefs = this.getTotalReferences();
|
|
126
|
-
const dead = totalRefs === 0;
|
|
127
|
-
if (dead) {
|
|
128
|
-
this.onRefsReachZero();
|
|
129
|
-
}
|
|
130
|
-
this.debug('REF--', `clientId=${clientId}, clientRefs=${refs.value}, totalRefs=${totalRefs}, dead=${dead}`);
|
|
131
|
-
}
|
|
132
|
-
/**
|
|
133
|
-
* All clients with at least one active reference.
|
|
134
|
-
*/
|
|
135
|
-
getClientIds() {
|
|
136
|
-
return Array.from(this.refsPerClient.keys());
|
|
137
|
-
}
|
|
138
|
-
/**
|
|
139
|
-
* Add the references for each client together.
|
|
140
|
-
*/
|
|
141
|
-
getTotalReferences() {
|
|
142
|
-
let total = 0;
|
|
143
|
-
for (const refs of this.refsPerClient.values()) {
|
|
144
|
-
total += refs.value;
|
|
145
|
-
}
|
|
146
|
-
return total;
|
|
147
|
-
}
|
|
148
|
-
/**
|
|
149
|
-
* Returns true if at least one client listens to this handle.
|
|
150
|
-
*/
|
|
151
|
-
isInUse() {
|
|
152
|
-
return this.refsPerClient.size > 0;
|
|
153
|
-
}
|
|
154
|
-
/**
|
|
155
|
-
* @throws with {@link WatcherDisposal} if this instance is disposed.
|
|
156
|
-
*/
|
|
157
|
-
assertNotDisposed() {
|
|
158
|
-
if (this.disposed) {
|
|
159
|
-
throw exports.WatcherDisposal;
|
|
160
|
-
}
|
|
161
|
-
}
|
|
162
|
-
/**
|
|
163
|
-
* When starting a watcher, we'll first check and wait for the path to exists
|
|
164
|
-
* before running an NSFW watcher.
|
|
165
|
-
*/
|
|
166
|
-
async start() {
|
|
167
|
-
while (await fs_1.promises.stat(this.fsPath).then(() => false, () => true)) {
|
|
168
|
-
await (0, promise_util_1.timeout)(500);
|
|
169
|
-
this.assertNotDisposed();
|
|
170
|
-
}
|
|
171
|
-
this.assertNotDisposed();
|
|
172
|
-
const watcher = await this.createNsfw();
|
|
173
|
-
this.assertNotDisposed();
|
|
174
|
-
await watcher.start();
|
|
175
|
-
this.debug('STARTED', `disposed=${this.disposed}`);
|
|
176
|
-
// The watcher could be disposed while it was starting, make sure to check for this:
|
|
177
|
-
if (this.disposed) {
|
|
178
|
-
await this.stopNsfw(watcher);
|
|
179
|
-
throw exports.WatcherDisposal;
|
|
180
|
-
}
|
|
181
|
-
this.nsfw = watcher;
|
|
182
|
-
}
|
|
183
|
-
/**
|
|
184
|
-
* Given a started nsfw instance, gracefully shut it down.
|
|
185
|
-
*/
|
|
186
|
-
async stopNsfw(watcher) {
|
|
187
|
-
await watcher.stop()
|
|
188
|
-
.then(() => 'success=true', error => error)
|
|
189
|
-
.then(status => this.debug('STOPPED', status));
|
|
190
|
-
}
|
|
191
|
-
async createNsfw() {
|
|
192
|
-
const fsPath = await fs_1.promises.realpath(this.fsPath);
|
|
193
|
-
return nsfw(fsPath, events => this.handleNsfwEvents(events), {
|
|
194
|
-
...this.nsfwFileSystemWatchServerOptions.nsfwOptions,
|
|
195
|
-
// The errorCallback is called whenever NSFW crashes *while* watching.
|
|
196
|
-
// See https://github.com/atom/github/issues/342
|
|
197
|
-
errorCallback: error => {
|
|
198
|
-
console.error(`NSFW service error on "${fsPath}":`, error);
|
|
199
|
-
this._dispose();
|
|
200
|
-
this.fireError();
|
|
201
|
-
// Make sure to call user's error handling code:
|
|
202
|
-
if (this.nsfwFileSystemWatchServerOptions.nsfwOptions.errorCallback) {
|
|
203
|
-
this.nsfwFileSystemWatchServerOptions.nsfwOptions.errorCallback(error);
|
|
204
|
-
}
|
|
205
|
-
},
|
|
206
|
-
});
|
|
207
|
-
}
|
|
208
|
-
handleNsfwEvents(events) {
|
|
209
|
-
// Only process events if someone is listening.
|
|
210
|
-
if (this.isInUse()) {
|
|
211
|
-
// This callback is async, but nsfw won't wait for it to finish before firing the next one.
|
|
212
|
-
// We will use a lock/queue to make sure everything is processed in the order it arrives.
|
|
213
|
-
this.nsfwEventProcessingQueue = this.nsfwEventProcessingQueue.then(async () => {
|
|
214
|
-
const fileChangeCollection = new file_change_collection_1.FileChangeCollection();
|
|
215
|
-
await Promise.all(events.map(async (event) => {
|
|
216
|
-
if (event.action === 3 /* RENAMED */) {
|
|
217
|
-
const [oldPath, newPath] = await Promise.all([
|
|
218
|
-
this.resolveEventPath(event.directory, event.oldFile),
|
|
219
|
-
this.resolveEventPath(event.newDirectory, event.newFile),
|
|
220
|
-
]);
|
|
221
|
-
this.pushFileChange(fileChangeCollection, 2 /* DELETED */, oldPath);
|
|
222
|
-
this.pushFileChange(fileChangeCollection, 1 /* ADDED */, newPath);
|
|
223
|
-
}
|
|
224
|
-
else {
|
|
225
|
-
const filePath = await this.resolveEventPath(event.directory, event.file);
|
|
226
|
-
if (event.action === 0 /* CREATED */) {
|
|
227
|
-
this.pushFileChange(fileChangeCollection, 1 /* ADDED */, filePath);
|
|
228
|
-
}
|
|
229
|
-
else if (event.action === 1 /* DELETED */) {
|
|
230
|
-
this.pushFileChange(fileChangeCollection, 2 /* DELETED */, filePath);
|
|
231
|
-
}
|
|
232
|
-
else if (event.action === 2 /* MODIFIED */) {
|
|
233
|
-
this.pushFileChange(fileChangeCollection, 0 /* UPDATED */, filePath);
|
|
234
|
-
}
|
|
235
|
-
}
|
|
236
|
-
}));
|
|
237
|
-
const changes = fileChangeCollection.values();
|
|
238
|
-
// If all changes are part of the ignored files, the collection will be empty.
|
|
239
|
-
if (changes.length > 0) {
|
|
240
|
-
this.fileSystemWatcherClient.onDidFilesChanged({
|
|
241
|
-
clients: this.getClientIds(),
|
|
242
|
-
changes,
|
|
243
|
-
});
|
|
244
|
-
}
|
|
245
|
-
}, console.error);
|
|
246
|
-
}
|
|
247
|
-
}
|
|
248
|
-
async resolveEventPath(directory, file) {
|
|
249
|
-
// nsfw already resolves symlinks, the paths should be clean already:
|
|
250
|
-
return path.resolve(directory, file);
|
|
251
|
-
}
|
|
252
|
-
pushFileChange(changes, type, filePath) {
|
|
253
|
-
if (!this.isIgnored(filePath)) {
|
|
254
|
-
const uri = file_uri_1.FileUri.create(filePath).toString();
|
|
255
|
-
changes.push({ type, uri });
|
|
256
|
-
}
|
|
257
|
-
}
|
|
258
|
-
fireError() {
|
|
259
|
-
this.fileSystemWatcherClient.onError({
|
|
260
|
-
clients: this.getClientIds(),
|
|
261
|
-
uri: this.fsPath,
|
|
262
|
-
});
|
|
263
|
-
}
|
|
264
|
-
/**
|
|
265
|
-
* When references hit zero, we'll schedule disposal for a bit later.
|
|
266
|
-
*
|
|
267
|
-
* This allows new references to reuse this watcher instead of creating a new one.
|
|
268
|
-
*
|
|
269
|
-
* e.g. A frontend disconnects for a few milliseconds before reconnecting again.
|
|
270
|
-
*/
|
|
271
|
-
onRefsReachZero() {
|
|
272
|
-
this.deferredDisposalTimer = setTimeout(() => this._dispose(), this.deferredDisposalTimeout);
|
|
273
|
-
}
|
|
274
|
-
/**
|
|
275
|
-
* If we get new references after hitting zero, let's unschedule our disposal and keep watching.
|
|
276
|
-
*/
|
|
277
|
-
onRefsRevive() {
|
|
278
|
-
if (this.deferredDisposalTimer) {
|
|
279
|
-
clearTimeout(this.deferredDisposalTimer);
|
|
280
|
-
this.deferredDisposalTimer = undefined;
|
|
281
|
-
}
|
|
282
|
-
}
|
|
283
|
-
isIgnored(filePath) {
|
|
284
|
-
return this.watcherOptions.ignored.length > 0
|
|
285
|
-
&& this.watcherOptions.ignored.some(m => m.match(filePath));
|
|
286
|
-
}
|
|
287
|
-
/**
|
|
288
|
-
* Internal disposal mechanism.
|
|
289
|
-
*/
|
|
290
|
-
async _dispose() {
|
|
291
|
-
if (!this.disposed) {
|
|
292
|
-
this.disposed = true;
|
|
293
|
-
this.deferredDisposalDeferred.reject(exports.WatcherDisposal);
|
|
294
|
-
if (this.nsfw) {
|
|
295
|
-
this.stopNsfw(this.nsfw);
|
|
296
|
-
this.nsfw = undefined;
|
|
297
|
-
}
|
|
298
|
-
this.debug('DISPOSED');
|
|
299
|
-
}
|
|
300
|
-
}
|
|
301
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
302
|
-
info(prefix, ...params) {
|
|
303
|
-
this.nsfwFileSystemWatchServerOptions.info(`${prefix} NsfwWatcher(${this.debugId} at "${this.fsPath}"):`, ...params);
|
|
304
|
-
}
|
|
305
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
306
|
-
debug(prefix, ...params) {
|
|
307
|
-
if (this.nsfwFileSystemWatchServerOptions.verbose) {
|
|
308
|
-
this.info(prefix, ...params);
|
|
309
|
-
}
|
|
310
|
-
}
|
|
311
|
-
}
|
|
312
|
-
exports.NsfwWatcher = NsfwWatcher;
|
|
313
|
-
NsfwWatcher.debugIdSequence = 0;
|
|
314
|
-
class NsfwFileSystemWatcherService {
|
|
315
|
-
constructor(options) {
|
|
316
|
-
this.watcherId = 0;
|
|
317
|
-
this.watchers = new Map();
|
|
318
|
-
this.watcherHandles = new Map();
|
|
319
|
-
/**
|
|
320
|
-
* `this.client` is undefined until someone sets it.
|
|
321
|
-
*/
|
|
322
|
-
this.maybeClient = {
|
|
323
|
-
onDidFilesChanged: event => { var _a; return (_a = this.client) === null || _a === void 0 ? void 0 : _a.onDidFilesChanged(event); },
|
|
324
|
-
onError: event => { var _a; return (_a = this.client) === null || _a === void 0 ? void 0 : _a.onError(event); },
|
|
325
|
-
};
|
|
326
|
-
this.options = {
|
|
327
|
-
nsfwOptions: {},
|
|
328
|
-
verbose: false,
|
|
329
|
-
info: (message, ...args) => console.info(message, ...args),
|
|
330
|
-
error: (message, ...args) => console.error(message, ...args),
|
|
331
|
-
...options
|
|
332
|
-
};
|
|
333
|
-
}
|
|
334
|
-
setClient(client) {
|
|
335
|
-
this.client = client;
|
|
336
|
-
}
|
|
337
|
-
/**
|
|
338
|
-
* A specific client requests us to watch a given `uri` according to some `options`.
|
|
339
|
-
*
|
|
340
|
-
* We internally re-use all the same `(uri, options)` pairs.
|
|
341
|
-
*/
|
|
342
|
-
async watchFileChanges(clientId, uri, options) {
|
|
343
|
-
const resolvedOptions = this.resolveWatchOptions(options);
|
|
344
|
-
const watcherKey = this.getWatcherKey(uri, resolvedOptions);
|
|
345
|
-
let watcher = this.watchers.get(watcherKey);
|
|
346
|
-
if (watcher === undefined) {
|
|
347
|
-
const fsPath = file_uri_1.FileUri.fsPath(uri);
|
|
348
|
-
watcher = this.createWatcher(clientId, fsPath, resolvedOptions);
|
|
349
|
-
watcher.whenDisposed.then(() => this.watchers.delete(watcherKey));
|
|
350
|
-
this.watchers.set(watcherKey, watcher);
|
|
351
|
-
}
|
|
352
|
-
else {
|
|
353
|
-
watcher.addRef(clientId);
|
|
354
|
-
}
|
|
355
|
-
const watcherId = this.watcherId++;
|
|
356
|
-
this.watcherHandles.set(watcherId, { clientId, watcher });
|
|
357
|
-
watcher.whenDisposed.then(() => this.watcherHandles.delete(watcherId));
|
|
358
|
-
return watcherId;
|
|
359
|
-
}
|
|
360
|
-
createWatcher(clientId, fsPath, options) {
|
|
361
|
-
const watcherOptions = {
|
|
362
|
-
ignored: options.ignored
|
|
363
|
-
.map(pattern => new minimatch_1.Minimatch(pattern, { dot: true })),
|
|
364
|
-
};
|
|
365
|
-
return new NsfwWatcher(clientId, fsPath, watcherOptions, this.options, this.maybeClient);
|
|
366
|
-
}
|
|
367
|
-
async unwatchFileChanges(watcherId) {
|
|
368
|
-
const handle = this.watcherHandles.get(watcherId);
|
|
369
|
-
if (handle === undefined) {
|
|
370
|
-
console.warn(`tried to de-allocate a disposed watcher: watcherId=${watcherId}`);
|
|
371
|
-
}
|
|
372
|
-
else {
|
|
373
|
-
this.watcherHandles.delete(watcherId);
|
|
374
|
-
handle.watcher.removeRef(handle.clientId);
|
|
375
|
-
}
|
|
376
|
-
}
|
|
377
|
-
/**
|
|
378
|
-
* Given some `URI` and some `WatchOptions`, generate a unique key.
|
|
379
|
-
*/
|
|
380
|
-
getWatcherKey(uri, options) {
|
|
381
|
-
return [
|
|
382
|
-
uri,
|
|
383
|
-
options.ignored.slice(0).sort().join() // use a **sorted copy** of `ignored` as part of the key
|
|
384
|
-
].join();
|
|
385
|
-
}
|
|
386
|
-
/**
|
|
387
|
-
* Return fully qualified options.
|
|
388
|
-
*/
|
|
389
|
-
resolveWatchOptions(options) {
|
|
390
|
-
return {
|
|
391
|
-
ignored: [],
|
|
392
|
-
...options,
|
|
393
|
-
};
|
|
394
|
-
}
|
|
395
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
396
|
-
debug(message, ...params) {
|
|
397
|
-
if (this.options.verbose) {
|
|
398
|
-
this.options.info(message, ...params);
|
|
399
|
-
}
|
|
400
|
-
}
|
|
401
|
-
dispose() {
|
|
402
|
-
// Singletons shouldn't be disposed...
|
|
403
|
-
}
|
|
404
|
-
}
|
|
405
|
-
exports.NsfwFileSystemWatcherService = NsfwFileSystemWatcherService;
|
|
1
|
+
"use strict";
|
|
2
|
+
// *****************************************************************************
|
|
3
|
+
// Copyright (C) 2017-2018 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
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
exports.NsfwFileSystemWatcherService = exports.NsfwWatcher = exports.WatcherDisposal = exports.NsfwFileSystemWatcherServerOptions = void 0;
|
|
19
|
+
const nsfw = require("@theia/core/shared/nsfw");
|
|
20
|
+
const path = require("path");
|
|
21
|
+
const fs_1 = require("fs");
|
|
22
|
+
const minimatch_1 = require("minimatch");
|
|
23
|
+
const file_uri_1 = require("@theia/core/lib/common/file-uri");
|
|
24
|
+
const file_change_collection_1 = require("../file-change-collection");
|
|
25
|
+
const promise_util_1 = require("@theia/core/lib/common/promise-util");
|
|
26
|
+
exports.NsfwFileSystemWatcherServerOptions = Symbol('NsfwFileSystemWatcherServerOptions');
|
|
27
|
+
/**
|
|
28
|
+
* This is a flag value passed around upon disposal.
|
|
29
|
+
*/
|
|
30
|
+
exports.WatcherDisposal = Symbol('WatcherDisposal');
|
|
31
|
+
/**
|
|
32
|
+
* Because URIs can be watched by different clients, we'll track
|
|
33
|
+
* how many are listening for a given URI.
|
|
34
|
+
*
|
|
35
|
+
* This component wraps the whole start/stop process given some
|
|
36
|
+
* reference count.
|
|
37
|
+
*
|
|
38
|
+
* Once there are no more references the handle
|
|
39
|
+
* will wait for some time before destroying its resources.
|
|
40
|
+
*/
|
|
41
|
+
class NsfwWatcher {
|
|
42
|
+
constructor(
|
|
43
|
+
/** Initial reference to this handle. */
|
|
44
|
+
initialClientId,
|
|
45
|
+
/** Filesystem path to be watched. */
|
|
46
|
+
fsPath,
|
|
47
|
+
/** Watcher-specific options */
|
|
48
|
+
watcherOptions,
|
|
49
|
+
/** Logging and Nsfw options */
|
|
50
|
+
nsfwFileSystemWatchServerOptions,
|
|
51
|
+
/** The client to forward events to. */
|
|
52
|
+
fileSystemWatcherClient,
|
|
53
|
+
/** Amount of time in ms to wait once this handle is not referenced anymore. */
|
|
54
|
+
deferredDisposalTimeout = 10000) {
|
|
55
|
+
this.fsPath = fsPath;
|
|
56
|
+
this.watcherOptions = watcherOptions;
|
|
57
|
+
this.nsfwFileSystemWatchServerOptions = nsfwFileSystemWatchServerOptions;
|
|
58
|
+
this.fileSystemWatcherClient = fileSystemWatcherClient;
|
|
59
|
+
this.deferredDisposalTimeout = deferredDisposalTimeout;
|
|
60
|
+
this.disposed = false;
|
|
61
|
+
/**
|
|
62
|
+
* Used for debugging to keep track of the watchers.
|
|
63
|
+
*/
|
|
64
|
+
this.debugId = NsfwWatcher.debugIdSequence++;
|
|
65
|
+
/**
|
|
66
|
+
* This deferred only rejects with `WatcherDisposal` and never resolves.
|
|
67
|
+
*/
|
|
68
|
+
this.deferredDisposalDeferred = new promise_util_1.Deferred();
|
|
69
|
+
/**
|
|
70
|
+
* We count each reference made to this watcher, per client.
|
|
71
|
+
*
|
|
72
|
+
* We do this to know where to send events via the network.
|
|
73
|
+
*
|
|
74
|
+
* An entry should be removed when its value hits zero.
|
|
75
|
+
*/
|
|
76
|
+
this.refsPerClient = new Map();
|
|
77
|
+
/**
|
|
78
|
+
* Ensures that events are processed in the order they are emitted,
|
|
79
|
+
* despite being processed async.
|
|
80
|
+
*/
|
|
81
|
+
this.nsfwEventProcessingQueue = Promise.resolve();
|
|
82
|
+
/**
|
|
83
|
+
* Resolves once this handle disposed itself and its resources. Never throws.
|
|
84
|
+
*/
|
|
85
|
+
this.whenDisposed = this.deferredDisposalDeferred.promise.catch(() => undefined);
|
|
86
|
+
this.refsPerClient.set(initialClientId, { value: 1 });
|
|
87
|
+
this.whenStarted = this.start().then(() => true, error => {
|
|
88
|
+
if (error === exports.WatcherDisposal) {
|
|
89
|
+
return false;
|
|
90
|
+
}
|
|
91
|
+
this._dispose();
|
|
92
|
+
this.fireError();
|
|
93
|
+
throw error;
|
|
94
|
+
});
|
|
95
|
+
this.debug('NEW', `initialClientId=${initialClientId}`);
|
|
96
|
+
}
|
|
97
|
+
addRef(clientId) {
|
|
98
|
+
let refs = this.refsPerClient.get(clientId);
|
|
99
|
+
if (typeof refs === 'undefined') {
|
|
100
|
+
this.refsPerClient.set(clientId, refs = { value: 1 });
|
|
101
|
+
}
|
|
102
|
+
else {
|
|
103
|
+
refs.value += 1;
|
|
104
|
+
}
|
|
105
|
+
const totalRefs = this.getTotalReferences();
|
|
106
|
+
// If it was zero before, 1 means we were revived:
|
|
107
|
+
const revived = totalRefs === 1;
|
|
108
|
+
if (revived) {
|
|
109
|
+
this.onRefsRevive();
|
|
110
|
+
}
|
|
111
|
+
this.debug('REF++', `clientId=${clientId}, clientRefs=${refs.value}, totalRefs=${totalRefs}. revived=${revived}`);
|
|
112
|
+
}
|
|
113
|
+
removeRef(clientId) {
|
|
114
|
+
const refs = this.refsPerClient.get(clientId);
|
|
115
|
+
if (typeof refs === 'undefined') {
|
|
116
|
+
this.info('WARN REF--', `removed one too many reference: clientId=${clientId}`);
|
|
117
|
+
return;
|
|
118
|
+
}
|
|
119
|
+
refs.value -= 1;
|
|
120
|
+
// We must remove the key from `this.clientReferences` because
|
|
121
|
+
// we list active clients by reading the keys of this map.
|
|
122
|
+
if (refs.value === 0) {
|
|
123
|
+
this.refsPerClient.delete(clientId);
|
|
124
|
+
}
|
|
125
|
+
const totalRefs = this.getTotalReferences();
|
|
126
|
+
const dead = totalRefs === 0;
|
|
127
|
+
if (dead) {
|
|
128
|
+
this.onRefsReachZero();
|
|
129
|
+
}
|
|
130
|
+
this.debug('REF--', `clientId=${clientId}, clientRefs=${refs.value}, totalRefs=${totalRefs}, dead=${dead}`);
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* All clients with at least one active reference.
|
|
134
|
+
*/
|
|
135
|
+
getClientIds() {
|
|
136
|
+
return Array.from(this.refsPerClient.keys());
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Add the references for each client together.
|
|
140
|
+
*/
|
|
141
|
+
getTotalReferences() {
|
|
142
|
+
let total = 0;
|
|
143
|
+
for (const refs of this.refsPerClient.values()) {
|
|
144
|
+
total += refs.value;
|
|
145
|
+
}
|
|
146
|
+
return total;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Returns true if at least one client listens to this handle.
|
|
150
|
+
*/
|
|
151
|
+
isInUse() {
|
|
152
|
+
return this.refsPerClient.size > 0;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* @throws with {@link WatcherDisposal} if this instance is disposed.
|
|
156
|
+
*/
|
|
157
|
+
assertNotDisposed() {
|
|
158
|
+
if (this.disposed) {
|
|
159
|
+
throw exports.WatcherDisposal;
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* When starting a watcher, we'll first check and wait for the path to exists
|
|
164
|
+
* before running an NSFW watcher.
|
|
165
|
+
*/
|
|
166
|
+
async start() {
|
|
167
|
+
while (await fs_1.promises.stat(this.fsPath).then(() => false, () => true)) {
|
|
168
|
+
await (0, promise_util_1.timeout)(500);
|
|
169
|
+
this.assertNotDisposed();
|
|
170
|
+
}
|
|
171
|
+
this.assertNotDisposed();
|
|
172
|
+
const watcher = await this.createNsfw();
|
|
173
|
+
this.assertNotDisposed();
|
|
174
|
+
await watcher.start();
|
|
175
|
+
this.debug('STARTED', `disposed=${this.disposed}`);
|
|
176
|
+
// The watcher could be disposed while it was starting, make sure to check for this:
|
|
177
|
+
if (this.disposed) {
|
|
178
|
+
await this.stopNsfw(watcher);
|
|
179
|
+
throw exports.WatcherDisposal;
|
|
180
|
+
}
|
|
181
|
+
this.nsfw = watcher;
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Given a started nsfw instance, gracefully shut it down.
|
|
185
|
+
*/
|
|
186
|
+
async stopNsfw(watcher) {
|
|
187
|
+
await watcher.stop()
|
|
188
|
+
.then(() => 'success=true', error => error)
|
|
189
|
+
.then(status => this.debug('STOPPED', status));
|
|
190
|
+
}
|
|
191
|
+
async createNsfw() {
|
|
192
|
+
const fsPath = await fs_1.promises.realpath(this.fsPath);
|
|
193
|
+
return nsfw(fsPath, events => this.handleNsfwEvents(events), {
|
|
194
|
+
...this.nsfwFileSystemWatchServerOptions.nsfwOptions,
|
|
195
|
+
// The errorCallback is called whenever NSFW crashes *while* watching.
|
|
196
|
+
// See https://github.com/atom/github/issues/342
|
|
197
|
+
errorCallback: error => {
|
|
198
|
+
console.error(`NSFW service error on "${fsPath}":`, error);
|
|
199
|
+
this._dispose();
|
|
200
|
+
this.fireError();
|
|
201
|
+
// Make sure to call user's error handling code:
|
|
202
|
+
if (this.nsfwFileSystemWatchServerOptions.nsfwOptions.errorCallback) {
|
|
203
|
+
this.nsfwFileSystemWatchServerOptions.nsfwOptions.errorCallback(error);
|
|
204
|
+
}
|
|
205
|
+
},
|
|
206
|
+
});
|
|
207
|
+
}
|
|
208
|
+
handleNsfwEvents(events) {
|
|
209
|
+
// Only process events if someone is listening.
|
|
210
|
+
if (this.isInUse()) {
|
|
211
|
+
// This callback is async, but nsfw won't wait for it to finish before firing the next one.
|
|
212
|
+
// We will use a lock/queue to make sure everything is processed in the order it arrives.
|
|
213
|
+
this.nsfwEventProcessingQueue = this.nsfwEventProcessingQueue.then(async () => {
|
|
214
|
+
const fileChangeCollection = new file_change_collection_1.FileChangeCollection();
|
|
215
|
+
await Promise.all(events.map(async (event) => {
|
|
216
|
+
if (event.action === 3 /* RENAMED */) {
|
|
217
|
+
const [oldPath, newPath] = await Promise.all([
|
|
218
|
+
this.resolveEventPath(event.directory, event.oldFile),
|
|
219
|
+
this.resolveEventPath(event.newDirectory, event.newFile),
|
|
220
|
+
]);
|
|
221
|
+
this.pushFileChange(fileChangeCollection, 2 /* DELETED */, oldPath);
|
|
222
|
+
this.pushFileChange(fileChangeCollection, 1 /* ADDED */, newPath);
|
|
223
|
+
}
|
|
224
|
+
else {
|
|
225
|
+
const filePath = await this.resolveEventPath(event.directory, event.file);
|
|
226
|
+
if (event.action === 0 /* CREATED */) {
|
|
227
|
+
this.pushFileChange(fileChangeCollection, 1 /* ADDED */, filePath);
|
|
228
|
+
}
|
|
229
|
+
else if (event.action === 1 /* DELETED */) {
|
|
230
|
+
this.pushFileChange(fileChangeCollection, 2 /* DELETED */, filePath);
|
|
231
|
+
}
|
|
232
|
+
else if (event.action === 2 /* MODIFIED */) {
|
|
233
|
+
this.pushFileChange(fileChangeCollection, 0 /* UPDATED */, filePath);
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
}));
|
|
237
|
+
const changes = fileChangeCollection.values();
|
|
238
|
+
// If all changes are part of the ignored files, the collection will be empty.
|
|
239
|
+
if (changes.length > 0) {
|
|
240
|
+
this.fileSystemWatcherClient.onDidFilesChanged({
|
|
241
|
+
clients: this.getClientIds(),
|
|
242
|
+
changes,
|
|
243
|
+
});
|
|
244
|
+
}
|
|
245
|
+
}, console.error);
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
async resolveEventPath(directory, file) {
|
|
249
|
+
// nsfw already resolves symlinks, the paths should be clean already:
|
|
250
|
+
return path.resolve(directory, file);
|
|
251
|
+
}
|
|
252
|
+
pushFileChange(changes, type, filePath) {
|
|
253
|
+
if (!this.isIgnored(filePath)) {
|
|
254
|
+
const uri = file_uri_1.FileUri.create(filePath).toString();
|
|
255
|
+
changes.push({ type, uri });
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
fireError() {
|
|
259
|
+
this.fileSystemWatcherClient.onError({
|
|
260
|
+
clients: this.getClientIds(),
|
|
261
|
+
uri: this.fsPath,
|
|
262
|
+
});
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* When references hit zero, we'll schedule disposal for a bit later.
|
|
266
|
+
*
|
|
267
|
+
* This allows new references to reuse this watcher instead of creating a new one.
|
|
268
|
+
*
|
|
269
|
+
* e.g. A frontend disconnects for a few milliseconds before reconnecting again.
|
|
270
|
+
*/
|
|
271
|
+
onRefsReachZero() {
|
|
272
|
+
this.deferredDisposalTimer = setTimeout(() => this._dispose(), this.deferredDisposalTimeout);
|
|
273
|
+
}
|
|
274
|
+
/**
|
|
275
|
+
* If we get new references after hitting zero, let's unschedule our disposal and keep watching.
|
|
276
|
+
*/
|
|
277
|
+
onRefsRevive() {
|
|
278
|
+
if (this.deferredDisposalTimer) {
|
|
279
|
+
clearTimeout(this.deferredDisposalTimer);
|
|
280
|
+
this.deferredDisposalTimer = undefined;
|
|
281
|
+
}
|
|
282
|
+
}
|
|
283
|
+
isIgnored(filePath) {
|
|
284
|
+
return this.watcherOptions.ignored.length > 0
|
|
285
|
+
&& this.watcherOptions.ignored.some(m => m.match(filePath));
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* Internal disposal mechanism.
|
|
289
|
+
*/
|
|
290
|
+
async _dispose() {
|
|
291
|
+
if (!this.disposed) {
|
|
292
|
+
this.disposed = true;
|
|
293
|
+
this.deferredDisposalDeferred.reject(exports.WatcherDisposal);
|
|
294
|
+
if (this.nsfw) {
|
|
295
|
+
this.stopNsfw(this.nsfw);
|
|
296
|
+
this.nsfw = undefined;
|
|
297
|
+
}
|
|
298
|
+
this.debug('DISPOSED');
|
|
299
|
+
}
|
|
300
|
+
}
|
|
301
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
302
|
+
info(prefix, ...params) {
|
|
303
|
+
this.nsfwFileSystemWatchServerOptions.info(`${prefix} NsfwWatcher(${this.debugId} at "${this.fsPath}"):`, ...params);
|
|
304
|
+
}
|
|
305
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
306
|
+
debug(prefix, ...params) {
|
|
307
|
+
if (this.nsfwFileSystemWatchServerOptions.verbose) {
|
|
308
|
+
this.info(prefix, ...params);
|
|
309
|
+
}
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
exports.NsfwWatcher = NsfwWatcher;
|
|
313
|
+
NsfwWatcher.debugIdSequence = 0;
|
|
314
|
+
class NsfwFileSystemWatcherService {
|
|
315
|
+
constructor(options) {
|
|
316
|
+
this.watcherId = 0;
|
|
317
|
+
this.watchers = new Map();
|
|
318
|
+
this.watcherHandles = new Map();
|
|
319
|
+
/**
|
|
320
|
+
* `this.client` is undefined until someone sets it.
|
|
321
|
+
*/
|
|
322
|
+
this.maybeClient = {
|
|
323
|
+
onDidFilesChanged: event => { var _a; return (_a = this.client) === null || _a === void 0 ? void 0 : _a.onDidFilesChanged(event); },
|
|
324
|
+
onError: event => { var _a; return (_a = this.client) === null || _a === void 0 ? void 0 : _a.onError(event); },
|
|
325
|
+
};
|
|
326
|
+
this.options = {
|
|
327
|
+
nsfwOptions: {},
|
|
328
|
+
verbose: false,
|
|
329
|
+
info: (message, ...args) => console.info(message, ...args),
|
|
330
|
+
error: (message, ...args) => console.error(message, ...args),
|
|
331
|
+
...options
|
|
332
|
+
};
|
|
333
|
+
}
|
|
334
|
+
setClient(client) {
|
|
335
|
+
this.client = client;
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* A specific client requests us to watch a given `uri` according to some `options`.
|
|
339
|
+
*
|
|
340
|
+
* We internally re-use all the same `(uri, options)` pairs.
|
|
341
|
+
*/
|
|
342
|
+
async watchFileChanges(clientId, uri, options) {
|
|
343
|
+
const resolvedOptions = this.resolveWatchOptions(options);
|
|
344
|
+
const watcherKey = this.getWatcherKey(uri, resolvedOptions);
|
|
345
|
+
let watcher = this.watchers.get(watcherKey);
|
|
346
|
+
if (watcher === undefined) {
|
|
347
|
+
const fsPath = file_uri_1.FileUri.fsPath(uri);
|
|
348
|
+
watcher = this.createWatcher(clientId, fsPath, resolvedOptions);
|
|
349
|
+
watcher.whenDisposed.then(() => this.watchers.delete(watcherKey));
|
|
350
|
+
this.watchers.set(watcherKey, watcher);
|
|
351
|
+
}
|
|
352
|
+
else {
|
|
353
|
+
watcher.addRef(clientId);
|
|
354
|
+
}
|
|
355
|
+
const watcherId = this.watcherId++;
|
|
356
|
+
this.watcherHandles.set(watcherId, { clientId, watcher });
|
|
357
|
+
watcher.whenDisposed.then(() => this.watcherHandles.delete(watcherId));
|
|
358
|
+
return watcherId;
|
|
359
|
+
}
|
|
360
|
+
createWatcher(clientId, fsPath, options) {
|
|
361
|
+
const watcherOptions = {
|
|
362
|
+
ignored: options.ignored
|
|
363
|
+
.map(pattern => new minimatch_1.Minimatch(pattern, { dot: true })),
|
|
364
|
+
};
|
|
365
|
+
return new NsfwWatcher(clientId, fsPath, watcherOptions, this.options, this.maybeClient);
|
|
366
|
+
}
|
|
367
|
+
async unwatchFileChanges(watcherId) {
|
|
368
|
+
const handle = this.watcherHandles.get(watcherId);
|
|
369
|
+
if (handle === undefined) {
|
|
370
|
+
console.warn(`tried to de-allocate a disposed watcher: watcherId=${watcherId}`);
|
|
371
|
+
}
|
|
372
|
+
else {
|
|
373
|
+
this.watcherHandles.delete(watcherId);
|
|
374
|
+
handle.watcher.removeRef(handle.clientId);
|
|
375
|
+
}
|
|
376
|
+
}
|
|
377
|
+
/**
|
|
378
|
+
* Given some `URI` and some `WatchOptions`, generate a unique key.
|
|
379
|
+
*/
|
|
380
|
+
getWatcherKey(uri, options) {
|
|
381
|
+
return [
|
|
382
|
+
uri,
|
|
383
|
+
options.ignored.slice(0).sort().join() // use a **sorted copy** of `ignored` as part of the key
|
|
384
|
+
].join();
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* Return fully qualified options.
|
|
388
|
+
*/
|
|
389
|
+
resolveWatchOptions(options) {
|
|
390
|
+
return {
|
|
391
|
+
ignored: [],
|
|
392
|
+
...options,
|
|
393
|
+
};
|
|
394
|
+
}
|
|
395
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
396
|
+
debug(message, ...params) {
|
|
397
|
+
if (this.options.verbose) {
|
|
398
|
+
this.options.info(message, ...params);
|
|
399
|
+
}
|
|
400
|
+
}
|
|
401
|
+
dispose() {
|
|
402
|
+
// Singletons shouldn't be disposed...
|
|
403
|
+
}
|
|
404
|
+
}
|
|
405
|
+
exports.NsfwFileSystemWatcherService = NsfwFileSystemWatcherService;
|
|
406
406
|
//# sourceMappingURL=nsfw-filesystem-service.js.map
|