hfs 0.56.0 → 0.57.0-beta2

package/src/log.js

@@ -88,7 +88,7 @@ const logUA = (0, config_1.defineConfig)(misc_1.CFG.log_ua, false);
 const logSpam = (0, config_1.defineConfig)(misc_1.CFG.log_spam, false);
 const debounce = lodash_1.default.debounce(cb => cb(), 1000); // with this technique, i'll be able to debounce some code respecting the references in its closure
 const logMw = async (ctx, next) => {
-    const now = new Date();
+    const now = new Date(); // request start
     // do it now so it's available for returning plugins
     ctx.state.completed = Promise.race([(0, stream_1.once)(ctx.res, 'finish'), (0, stream_1.once)(ctx.res, 'close')]);
     await next();
@@ -140,8 +140,15 @@ const logMw = async (ctx, next) => {
         const user = (0, auth_1.getCurrentUsername)(ctx);
         const length = (_c = ctx.state.length) !== null && _c !== void 0 ? _c : ctx.length;
         const uri = ctx.originalUrl;
-        ctx.logExtra(ctx.state.includesLastByte && ctx.vfsNode && ctx.res.finished && { dl: 1 }
-            || ctx.state.uploadPath && { size: ctx.state.opTotal, ul: ctx.state.uploads });
+        const duration = (Date.now() - Number(now)) / 1000;
+        ctx.logExtra(ctx.vfsNode && {
+            speed: Math.round(length / duration),
+            ...ctx.state.includesLastByte && ctx.res.finished && { dl: 1 }
+        } || ctx.state.uploadPath && {
+            ul: ctx.state.uploads,
+            size: ctx.state.opTotal,
+            speed: Math.round((ctx.state.opTotal - (ctx.state.opOffset || 0)) / duration)
+        });
         if (conn === null || conn === void 0 ? void 0 : conn.country)
             ctx.logExtra({ country: conn.country });
         if (logUA.get())

package/src/middlewares.js

@@ -111,42 +111,26 @@ const prepareState = async (ctx, next) => {
     ctx.state.revProxyPath = ctx.get('x-forwarded-prefix');
     (0, connections_1.updateConnectionForCtx)(ctx);
     await next();
-    async function urlLogin() {
+    function urlLogin() {
         const { login } = ctx.query;
         if (!login)
             return;
         const [u, p] = (0, misc_1.splitAt)(':', String(login));
-        const a = await doLogin(u, p, 'url');
-        if (!a)
-            return;
         ctx.redirect(ctx.originalUrl.slice(0, -ctx.querystring.length - 1)); // redirect to hide credentials
-        return a;
+        return u && (0, auth_1.clearTextLogin)(ctx, u, p, 'url');
     }
     function getHttpAccount() {
-        var _a;
+        var _a, _b;
         const b64 = allowAuthorizationHeader.get() && ((_a = ctx.get('authorization')) === null || _a === void 0 ? void 0 : _a.split(' ')[1]);
         if (!b64)
             return;
         try {
             const [u, p] = atob(b64).split(':');
-            return doLogin(u, p || '', 'header');
-        }
-        catch (_b) { }
-    }
-    async function doLogin(u, p, via) {
-        var _a, _b;
-        if (!u || u === ((_a = ctx.session) === null || _a === void 0 ? void 0 : _a.username))
-            return; // providing credentials, but not needed
-        if ((_b = (await events_1.default.emitAsync('attemptingLogin', { ctx, username: u, via }))) === null || _b === void 0 ? void 0 : _b.isDefaultPrevented())
-            return;
-        const a = await (0, auth_1.srpCheck)(u, p);
-        if (a) {
-            await (0, auth_1.setLoggedIn)(ctx, a.username);
-            ctx.headers['x-username'] = a.username; // give an easier way to determine if the login was successful
+            if (!u || u === ((_b = ctx.session) === null || _b === void 0 ? void 0 : _b.username))
+                return; // providing credentials, but not needed
+            return (0, auth_1.clearTextLogin)(ctx, u, p || '', 'header');
         }
-        else if (u)
-            events_1.default.emit('failedLogin', ctx, { username: u, via });
-        return a;
+        catch (_c) { }
     }
 };
 exports.prepareState = prepareState;

package/src/misc.js

@@ -18,9 +18,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteNode = exports.createStreamLimiter = exports.apiAssertTypes = exports.AsapStream = exports.asyncGeneratorToReadable = exports.same = exports.makeNetMatcher = exports.netMatches = exports.isLocalHost = exports.pattern2filter = void 0;
+exports.createStreamLimiter = exports.apiAssertTypes = exports.AsapStream = exports.asyncGeneratorToReadable = exports.same = exports.makeNetMatcher = exports.netMatches = exports.isLocalHost = exports.pattern2filter = void 0;
 const path_1 = require("path");
-const assert_1 = __importDefault(require("assert"));
 __exportStar(require("./util-http"), exports);
 __exportStar(require("./util-files"), exports);
 __exportStar(require("./fileAttr"), exports);
@@ -32,10 +31,6 @@ const apiMiddleware_1 = require("./apiMiddleware");
 const const_1 = require("./const");
 const cross_1 = require("./cross");
 const net_1 = require("net");
-const vfs_1 = require("./vfs");
-const events_1 = __importDefault(require("./events"));
-const promises_1 = require("fs/promises");
-const comments_1 = require("./comments");
 const lodash_1 = __importDefault(require("lodash"));
 function pattern2filter(pattern) {
     const matcher = (0, cross_1.makeMatcher)(pattern.includes('*') ? pattern // if you specify *, we'll respect its position
@@ -48,9 +43,11 @@ function isLocalHost(c) {
     return ip && (0, cross_1.isIpLocalHost)(ip);
 }
 exports.isLocalHost = isLocalHost;
-// this will memory-leak over mask, so be careful with what you use this
+// this will memory-leak over mask, so be careful with what you use this. Object is 3x faster than _.memoize
 function netMatches(ip, mask, emptyMaskReturns = false) {
-    return lodash_1.default.memoize(makeNetMatcher, (a, b) => `${a}\t${b ? 1 : 0}`)(mask, emptyMaskReturns)(ip); // cache the matcher
+    var _a, _b;
+    const cache = (_a = netMatches).cache || (_a.cache = {});
+    return (cache[_b = mask + (emptyMaskReturns ? '1' : '0')] || (cache[_b] = makeNetMatcher(mask, emptyMaskReturns)))(ip); // cache the matcher
 }
 exports.netMatches = netMatches;
 function makeNetMatcher(mask, emptyMaskReturns = false) {
@@ -108,13 +105,7 @@ function parseAddress(s) {
     return new node_net_1.SocketAddress({ address: s, family: (0, net_1.isIPv6)(s) ? 'ipv6' : 'ipv4' });
 }
 function same(a, b) {
-    try {
-        assert_1.default.deepStrictEqual(a, b);
-        return true;
-    }
-    catch (_a) {
-        return false;
-    }
+    return lodash_1.default.isEqual(a, b);
 }
 exports.same = same;
 function asyncGeneratorToReadable(generator) {
@@ -175,23 +166,3 @@ function createStreamLimiter(limit) {
     });
 }
 exports.createStreamLimiter = createStreamLimiter;
-async function deleteNode(ctx, node, uri) {
-    var _a;
-    const { source } = node;
-    if (!source)
-        return const_1.HTTP_METHOD_NOT_ALLOWED;
-    if ((0, vfs_1.statusCodeForMissingPerm)(node, 'can_delete', ctx))
-        return ctx.status;
-    try {
-        if ((_a = (await events_1.default.emitAsync('deleting', { node, ctx }))) === null || _a === void 0 ? void 0 : _a.isDefaultPrevented())
-            return null; // stop
-        ctx.logExtra(null, { target: decodeURI(uri) });
-        await (0, promises_1.rm)(source, { recursive: true });
-        void (0, comments_1.setCommentFor)(source, '');
-        return true;
-    }
-    catch (e) {
-        return e;
-    }
-}
-exports.deleteNode = deleteNode;

package/src/perm.js

@@ -30,7 +30,8 @@ function expandUsername(who) {
 exports.expandUsername = expandUsername;
 // check if current username or any ancestor match the provided usernames
 function ctxBelongsTo(ctx, usernames) {
-    return (0, misc_1.getOrSet)(ctx.state, 'usernames', () => expandUsername((0, auth_1.getCurrentUsername)(ctx))) // cache ancestors' usernames inside context state
+    var _a;
+    return ((_a = ctx.state).usernames || (_a.usernames = expandUsername((0, auth_1.getCurrentUsername)(ctx)))) // cache ancestors' usernames inside context state
         .some((u) => usernames.includes(u));
 }
 exports.ctxBelongsTo = ctxBelongsTo;
@@ -181,7 +182,8 @@ function accountHasPassword(account) {
 }
 exports.accountHasPassword = accountHasPassword;
 function accountCanLogin(account) {
-    return accountHasPassword(account) && !allDisabled(account);
+    var _a;
+    return (accountHasPassword(account) || ((_a = account.plugin) === null || _a === void 0 ? void 0 : _a.auth)) && !allDisabled(account);
 }
 exports.accountCanLogin = accountCanLogin;
 function allDisabled(account) {
@@ -193,7 +195,7 @@ function allDisabled(account) {
             && account.belongs.map(u => getAccount(u, false)).every(a => a && allDisabled(a)));
 }
 function accountCanLoginAdmin(account) {
-    return accountCanLogin(account) && Boolean(getFromAccount(account, a => a.admin));
+    return accountCanLogin(account) && getFromAccount(account, a => a.admin) || false;
 }
 exports.accountCanLoginAdmin = accountCanLoginAdmin;
 async function changeSrpHelper(account, salt, verifier) {

package/src/plugins.js

@@ -133,14 +133,33 @@ function getPluginConfigFields(id) {
 exports.getPluginConfigFields = getPluginConfigFields;
 async function initPlugin(pl, morePassedToInit) {
     var _a;
+    const undoEvents = [];
+    const timeouts = [];
     const res = await ((_a = pl.init) === null || _a === void 0 ? void 0 : _a.call(pl, {
         Const,
         require,
         getConnections: connections_1.getConnections,
-        events: events_1.default,
+        // intercept all subscriptions, so to be able to undo them on unload
+        events: Object.create(events_1.default, (0, misc_1.objFromKeys)(['on', 'once', 'multi'], k => ({
+            value() {
+                const ret = events_1.default[k](...arguments);
+                undoEvents.push(ret);
+                return ret;
+            }
+        }))),
         log: console.log,
         setError(msg) { setError((morePassedToInit === null || morePassedToInit === void 0 ? void 0 : morePassedToInit.id) || 'server_code', msg); },
         getHfsConfig: config_1.getConfig,
+        setInterval() {
+            const ret = setInterval(...arguments);
+            timeouts.push(ret); // intervals can be canceled by clearTimeout (source: MDN)
+            return ret;
+        },
+        setTimeout() {
+            const ret = setTimeout(...arguments);
+            timeouts.push(ret);
+            return ret;
+        },
         customApiCall,
         notifyClient: frontEndApis_1.notifyClient,
         addBlock: block_1.addBlock,
@@ -152,6 +171,14 @@ async function initPlugin(pl, morePassedToInit) {
         ...morePassedToInit
     }));
     Object.assign(pl, typeof res === 'function' ? { unload: res } : res);
+    (0, misc_1.patchKey)(pl, 'unload', was => () => {
+        for (const x of timeouts)
+            clearTimeout(x);
+        for (const cb of undoEvents)
+            cb();
+        if (typeof was === 'function')
+            return was(...arguments);
+    });
     events_1.default.emit('pluginInitialized', pl);
     return pl;
 }
@@ -233,6 +260,7 @@ class Plugin {
         this.started = new Date();
         if (!data)
             throw 'invalid data';
+        this.log = [];
         this.data = data = { ...data }; // clone to make object modifiable. Objects coming from import are not.
         // some validation
         for (const k of ['frontend_css', 'frontend_js']) {
@@ -479,6 +507,7 @@ function watchPlugin(id, path) {
             await (0, promises_1.mkdir)(storageDir, { recursive: true });
             const openDbs = [];
             const subbedConfigs = [];
+            const pluginReady = (0, misc_1.pendingPromise)();
             await initPlugin(pluginData, {
                 id,
                 srcDir: __dirname,
@@ -493,6 +522,14 @@ function watchPlugin(id, path) {
                 },
                 log(...args) {
                     console.log('plugin', id + ':', ...args);
+                    pluginReady.then(() => {
+                        if (!plugin)
+                            return;
+                        plugin.log.unshift({ ts: new Date, msg: args.map(x => x && typeof x === 'object' ? JSON.stringify(x) : String(x)).join(' ') });
+                        plugin.log.length = Math.min(100, plugin.log.length); // truncate
+                        events_1.default.emit('pluginLog:' + id, plugin.log[0]);
+                        events_1.default.emit('pluginLog', id, plugin.log[0]);
+                    });
                 },
                 getConfig(cfgKey) {
                     var _a, _b, _c, _d;
@@ -536,6 +573,7 @@ function watchPlugin(id, path) {
                 await Promise.allSettled(openDbs.map(x => x.close()));
                 openDbs.length = 0;
             });
+            pluginReady.resolve();
             if (alreadyRunning)
                 events_1.default.emit('pluginUpdated', Object.assign(lodash_1.default.pick(plugin, 'started'), getPluginInfo(id)));
             else {
@@ -582,13 +620,14 @@ function setError(id, error) {
 }
 function deleteModule(id) {
     var _a;
+    var _b;
     const { cache } = require;
     // build reversed map of dependencies
     const requiredBy = { '.': ['.'] }; // don't touch main entry
     for (const k in cache)
         if (k !== id)
             for (const child of (0, misc_1.wantArray)((_a = cache[k]) === null || _a === void 0 ? void 0 : _a.children))
-                (0, misc_1.getOrSet)(requiredBy, child.id, () => []).push(k);
+                (requiredBy[_b = child.id] || (requiredBy[_b] = [])).push(k);
     const deleted = [];
     (function deleteCache(id) {
         const mod = cache[id];
@@ -603,7 +642,7 @@ function deleteModule(id) {
 }
 (0, first_1.onProcessExit)(() => Promise.allSettled(mapPlugins(pl => pl.unload())));
 function parsePluginSource(id, source) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
     const pl = { id };
     pl.description = (0, misc_1.tryJson)((_a = /exports.description *= *(".*")/.exec(source)) === null || _a === void 0 ? void 0 : _a[1]);
     pl.repo = (0, misc_1.tryJson)((_b = /exports.repo *= *(.*);? *$/m.exec(source)) === null || _b === void 0 ? void 0 : _b[1]);
@@ -611,8 +650,9 @@ function parsePluginSource(id, source) {
     pl.apiRequired = (_f = (0, misc_1.tryJson)((_e = /exports.apiRequired *= *([ \d.,[\]]+)/.exec(source)) === null || _e === void 0 ? void 0 : _e[1])) !== null && _f !== void 0 ? _f : undefined;
     pl.isTheme = (_h = (0, misc_1.tryJson)((_g = /exports.isTheme *= *(true|false|"light"|"dark")/.exec(source)) === null || _g === void 0 ? void 0 : _g[1])) !== null && _h !== void 0 ? _h : (id.endsWith('-theme') || undefined);
     pl.preview = (_k = (0, misc_1.tryJson)((_j = /exports.preview *= *(.+)/.exec(source)) === null || _j === void 0 ? void 0 : _j[1])) !== null && _k !== void 0 ? _k : undefined;
-    pl.depend = (_m = (0, misc_1.tryJson)((_l = /exports.depend *= *(\[.*])/m.exec(source)) === null || _l === void 0 ? void 0 : _l[1])) === null || _m === void 0 ? void 0 : _m.filter((x) => typeof x.repo === 'string' && x.version === undefined || typeof x.version === 'number'
+    pl.depend = (_m = (0, misc_1.tryJson)((_l = /exports.depend *= *(\[[\s\S]*?])/m.exec(source)) === null || _l === void 0 ? void 0 : _l[1])) === null || _m === void 0 ? void 0 : _m.filter((x) => typeof x.repo === 'string' && x.version === undefined || typeof x.version === 'number'
         || console.warn("plugin dependency discarded", x));
+    pl.changelog = (0, misc_1.tryJson)((_o = /exports.changelog *= *(\[[\s\S]*?])/m.exec(source)) === null || _o === void 0 ? void 0 : _o[1]);
     if (Array.isArray(pl.apiRequired) && (pl.apiRequired.length !== 2 || !pl.apiRequired.every(lodash_1.default.isFinite))) // validate [from,to] form
         pl.apiRequired = undefined;
     calculateBadApi(pl);

package/src/roots.js

@@ -42,9 +42,7 @@ const rootsMiddleware = (ctx, next) => (() => {
             return true; // true will avoid calling next
         }
     if (!root || root === '/')
-        return; // not transformation is required
-    if (root === '' || root === '/')
-        return;
+        return; // no transformation is required
     changeUriParams(v => (0, misc_1.join)(root, v));
     if (!params)
         ctx.path = (0, misc_1.join)(root, ctx.path);

package/src/serveGuiAndSharedFiles.js

@@ -20,6 +20,8 @@ const serveGuiFiles_1 = require("./serveGuiFiles");
 const koa_mount_1 = __importDefault(require("koa-mount"));
 const listen_1 = require("./listen");
 const misc_1 = require("./misc");
+const promises_1 = require("fs/promises");
+const comments_1 = require("./comments");
 const basicWeb_1 = require("./basicWeb");
 const icons_1 = require("./icons");
 const plugins_1 = require("./plugins");
@@ -28,7 +30,7 @@ const serveFrontendPrefixed = (0, koa_mount_1.default)(cross_const_1.FRONTEND_UR
 const serveAdminFiles = (0, serveGuiFiles_1.serveGuiFiles)(process.env.ADMIN_PROXY, cross_const_1.ADMIN_URI);
 const serveAdminPrefixed = (0, koa_mount_1.default)(cross_const_1.ADMIN_URI.slice(0, -1), serveAdminFiles);
 const serveGuiAndSharedFiles = async (ctx, next) => {
-    var _a;
+    var _a, _b;
     const { path } = ctx;
     // dynamic import on frontend|admin (used for non-https login) while developing (vite4) is not producing a relative path
     if (const_1.DEV && path.startsWith('/node_modules/')) {
@@ -108,16 +110,22 @@ const serveGuiAndSharedFiles = async (ctx, next) => {
         return;
     }
     if (ctx.method === 'DELETE') {
-        const res = await (0, misc_1.deleteNode)(ctx, node, ctx.path);
-        if (typeof res === 'number')
-            return ctx.status = res;
-        if (res instanceof Error) {
-            ctx.body = res.message || String(res);
+        const { source } = node;
+        if (!source)
+            return ctx.status = cross_const_1.HTTP_METHOD_NOT_ALLOWED;
+        if ((0, vfs_1.statusCodeForMissingPerm)(node, 'can_delete', ctx))
+            return;
+        try {
+            if ((_b = (await events_1.default.emitAsync('deleting', { node, ctx }))) === null || _b === void 0 ? void 0 : _b.isDefaultPrevented())
+                return ctx.status = cross_const_1.HTTP_FAILED_DEPENDENCY;
+            await (0, promises_1.rm)(source, { recursive: true });
+            void (0, comments_1.setCommentFor)(source, ''); // necessary only to clean a possible descript.ion or kvstorage
+            return ctx.status = cross_const_1.HTTP_OK;
+        }
+        catch (e) {
+            ctx.body = String(e);
             return ctx.status = cross_const_1.HTTP_SERVER_ERROR;
         }
-        if (res)
-            return ctx.status = cross_const_1.HTTP_OK;
-        return;
     }
     const { get } = ctx.query;
     if (node.default && path.endsWith('/') && !get) { // final/ needed on browser to make resource urls correctly with html pages
@@ -164,7 +172,7 @@ async function sendFolderList(node, ctx) {
         const { URL } = ctx;
         const base = prepend === undefined && listen_1.baseUrl.get()
             || URL.protocol + '//' + URL.host + ctx.state.revProxyPath;
-        prepend = base + ctx.originalUrl.split('?')[0];
+        prepend = base + (0, misc_1.pathEncode)(decodeURI(ctx.path)); // redo the encoding our way, keeping unicode chars unchanged
     }
     const walker = (0, vfs_1.walkNode)(node, { ctx, depth: depth === '*' ? Infinity : Number(depth) });
     ctx.body = (0, misc_1.asyncGeneratorToReadable)((0, misc_1.filterMapGenerator)(walker, async (el) => {

package/src/serveGuiFiles.js

@@ -24,10 +24,8 @@ const size1024 = (0, config_1.defineConfig)(misc_1.CFG.size_1024, false, x => mi
 const splitUploads = (0, config_1.defineConfig)(misc_1.CFG.split_uploads, 0);
 exports.logGui = (0, config_1.defineConfig)(misc_1.CFG.log_gui, false);
 lodash_1.default.each(misc_1.FRONTEND_OPTIONS, (v, k) => (0, config_1.defineConfig)(k, v)); // define default values
-// in case of dev env we have our static files within the 'dist' folder'
-const DEV_STATIC = process.env.DEV ? 'dist/' : '';
 function serveStatic(uri) {
-    const folder = uri.slice(2, -1); // we know folder is very similar to uri
+    const folder = (const_1.DEV ? 'dist/' : '') + uri.slice(2, -1); // we know folder is very similar to uri
     let cache = {};
     customHtml_1.customHtml.emitter.on('change', () => cache = {}); // reset cache at every change
     return async (ctx) => {
@@ -41,7 +39,7 @@ function serveStatic(uri) {
         if (ctx.method !== 'GET')
             return ctx.status = const_1.HTTP_METHOD_NOT_ALLOWED;
         const serveApp = shouldServeApp(ctx);
-        const fullPath = (0, path_1.join)(__dirname, '..', DEV_STATIC, folder, serveApp ? '/index.html' : ctx.path);
+        const fullPath = (0, path_1.join)(__dirname, '..', folder, serveApp ? '/index.html' : ctx.path);
         const content = await (0, misc_1.parseFileContent)(fullPath, raw => serveApp || !raw.length ? raw : adjustBundlerLinks(ctx, uri, raw))
             .catch(() => null);
         if (content === null)

package/src/throttler.js

@@ -26,6 +26,7 @@ maxKbpsPerIp.sub(v => {
 });
 const throttler = async (ctx, next) => {
     var _a;
+    var _b;
     await next();
     let { body } = ctx;
     const downloadTotal = ctx.response.length;
@@ -35,10 +36,10 @@ const throttler = async (ctx, next) => {
         return;
     // we wrap the stream also for unlimited connections to get speed and other features
     const noLimit = ((_a = ctx.state.account) === null || _a === void 0 ? void 0 : _a.ignore_limits) || (0, misc_1.isLocalHost)(ctx);
-    const ipGroup = (0, misc_1.getOrSet)(ip2group, noLimit ? '' : ctx.ip, () => ({
+    const ipGroup = ip2group[_b = noLimit ? '' : ctx.ip] || (ip2group[_b] = {
         count: 0,
         group: new ThrottledStream_1.ThrottleGroup(noLimit ? Infinity : maxKbpsPerIp.get(), noLimit ? undefined : mainThrottleGroup),
-    }));
+    });
     const conn = (0, connections_1.getConnection)(ctx);
     if (!conn)
         throw 'assert throttler connection';

package/src/update.js

@@ -125,7 +125,7 @@ async function update(tagOrUrl = '') {
         const asset = update.assets.find((x) => x.name.includes(assetSearch) && x.name.endsWith('.zip'))
             || update.assets.find((x) => x.name.endsWith(legacyAssetSearch));
         if (!asset)
-            throw "asset not found";
+            throw `asset not found: ${assetSearch}`;
         url = asset.browser_download_url;
     }
     if (url) {

package/src/upload.js

@@ -105,7 +105,7 @@ function uploadWriter(base, baseUri, path, ctx) {
             if (typeof free !== 'number' || isNaN(free))
                 throw '';
             if (fullSize > free - (min || 0))
-                return fail(const_1.HTTP_PAYLOAD_TOO_LARGE);
+                return fail(const_1.HTTP_INSUFFICIENT_STORAGE);
         }
         catch (e) { // warn, but let it through
             console.warn("can't check disk size:", e.message || String(e));

package/src/vfs.js

@@ -300,7 +300,7 @@ async function* walkNode(parent, { ctx, depth = Infinity, prefixPath = '', requi
                         const { path } = entry;
                         const isFolder = entry.isDirectory();
                         const name = prefixPath + (((_a = parent.rename) === null || _a === void 0 ? void 0 : _a[path]) || path);
-                        if (comments_1.descriptIon.get() && (0, path_1.basename)(name) === comments_1.DESCRIPT_ION)
+                        if ((0, comments_1.usingDescriptIon)() && (0, path_1.basename)(name) === comments_1.DESCRIPT_ION)
                             return;
                         if (taken === null || taken === void 0 ? void 0 : taken.has(normalizeFilename(name))) // taken by vfs node above
                             return false; // false just in case it's a folder

package/README.md

@@ -1,177 +0,0 @@
-# HFS: HTTP File Server (version 3)
-
-![logo and motto](hfs-logo-color-motto.svg)
-
-## Introduction
-
-Access via web your files directly from your disk.
-
-- You be the server, share files **fresh from your disk**, with **unlimited** space and bandwidth.
-- **Fast!** Try zipping 100GB, download starts immediately!
-- **Intelligent**. HFS tries to detect problems and suggest solutions.
-- Share **even a single file** with our *virtual file system*, even with a different name, all without touching the real file. Present things the way you want!
-- **Watch** all activities in real-time.
-- **Control bandwidth**, decide how much to give.
-- **No intermediaries**, give a huge file to your friend without waiting for it to be uploaded on a server first.
-
-This is a full rewrite of [the Delphi version](https://github.com/rejetto/hfs2).
-
-## How does it work
-
-- run HFS on your computer, administration page automatically shows up
-- select what files and folders you want to be accessible
-- access those files from a phone or another computer just using a browser
-- possibly create accounts and limit access to files
-
-## Features
-
-- https
-- easy certificate generation
-- unicode
-- virtual file system
-- mobile friendly
-- search
-- accounts
-- resumable downloads & uploads
-- download folders as zip archive
-- delete, move and rename files
-- simple website serving
-- plug-ins
-- real-time monitoring of connections
-- [show some files](https://github.com/rejetto/hfs/discussions/270)
-- speed throttler
-- geographic firewall
-- admin web interface
-- multi-language front-end
-- virtual hosting
-- anti-brute-force (plug-in)
-- [reverse-proxy support](https://github.com/rejetto/hfs/wiki/Reverse-proxy)
-- comments in file descript.ion
-- integrated media player
-- [customizable with html, css and javascript](https://github.com/rejetto/hfs/wiki/Customization)
-- dynamic-dns updater
-
-## Installation
-
-For service installation instructions, [see our wiki](https://github.com/rejetto/hfs/wiki/Service-installation).
-
-For Docker installation, [see dedicated repo](https://github.com/damienzonly/hfs-docker).
-
-NB: minimum Windows version required is 8.1 , Windows Server 2012 R2 (because of Node.js 18)
-
-1. go to https://github.com/rejetto/hfs/releases
-2. click on `Assets`
-3. **download** the right version for your system, unzip and launch `hfs` file. 
-   - Mac: if you get *"cannot be opened because it is from an unidentified developer"*,
-     you can hold `control` key while clicking, then click `open`.
-   - If you cannot find your system in the list, see next section [Other systems](#other-systems).
-4. the browser should automatically open on `localhost` address, so you can configure the rest in the Admin-panel.
-   - if a browser cannot be opened on the computer where you are installing HFS, 
-     you should enter this command in the HFS console: `create-admin <PASSWORD>`
-   - if you cannot access the console (like when you are running as a service), 
-       you can [edit the config file to add your admin account](config.md#accounts)
-   - if you don't want to use an editor you can create the file with this command: 
-     
-     `echo "create-admin: PASSWORD" > config.yaml` 
-
-If you access *Admin-panel* via localhost, by default HFS **won't** require you to login.
-If you don't like this behavior, disable it in the Admin-panel or enter this console command `config localhost_admin false`.
-
-### Other systems
-
-If your system is not Windows/Linux/Mac or you just don't want to run the binaries, you can try this alternative version:
-
-1. [install node.js](https://nodejs.org) version 18.20
-2. execute at command line `npx hfs@latest`
-
-The `@latest` part is optional, and ensures that you are always up to date.
-
-If this procedure fails, it may be that you are missing one of [these requirements](https://github.com/nodejs/node-gyp#installation).
-
-Configuration and other files will be stored in `%HOME%/.vfs`
-
-## Console commands
-
-If you have full access to HFS' console, you can enter commands. Start with `help` to have a full list.
-
-## Configuration
-
-For configuration please see [file config.md](config.md).
-
-### Where is it stored
-
-Configuration is stored in the file `config.yaml`, exception made for custom HTML which is stored in `custom.html`.
-
-These files are kept in the Current Working Directory (cwd), which is by default the same folder of `hfs.exe`
-if you are using this kind of distribution on Windows, or `USER_FOLDER/.hfs` on other systems.
-You can decide a different folder passing `--cwd SOME_FOLDER` parameter at command line.
-Any relative path provided is relative to the *cwd*.
-
-[Check details about config file format](config.md).
-
-## Internationalization
-
-It is possible to show the Front-end in other languages.
-Translation for some languages is already provided. If you find an error, consider reporting it
-or [editing the source file](https://github.com/rejetto/hfs/tree/main/src/langs). 
-
-In the Languages section of the Admin-panel you can install additional language files.
-
-If your language is missing, please consider [translating yourself](https://github.com/rejetto/hfs/wiki/Translation). 
-
-## Hidden features
-
-- Appending `#LOGIN` to address will bring up the login dialog
-- Appending ?lang=CODE to address will force a specific language
-- Right-click on toggle-all checkbox will invert each checkbox state
-- Appending `?login=USER:PASSWORD` will automatically log in the browser
-- Appending `?overwrite` on uploads, will override the dont_overwrite_uploading configuration, provided you also have delete permission
-- Appending `?search=PATTERN` will trigger search at start
-- Appending `?onlyFiles` or `?onlyFolders` will limit type of results
-- Appending `?autoplay=shuffle` will trigger show & play; `?autoplay` will not shuffle, but also will not start until the list is complete 
-- Right-click on "check for updates" will let you input a URL of a version to install
-- Shift+click on a file will show & play
-- Type the name of a file/folder to focus it, and ctrl+backspace to go to parent folder
-- `--consoleFile PATH` will output all stdout and stderr also to a file
-- env `DISABLE_UPDATE=1` (for containers)
-
-## Contribute
-
-There are several ways to contribute
-
-- [Report bugs](https://github.com/rejetto/hfs/issues/new?labels=bug&template=bug_report.md)
-
-  It's very important to report bugs, and if you are not so sure about it, don't worry, we'll discuss it.
-  If you find important security problems, please [contact us privately](mailto:a@rejetto.com) so that we can publish a fix before
-  the problem is disclosed, for the safety of other users.  
-
-- Use beta versions, and give feedback. 
-
-  While betas have more problems, you'll get more features and give a huge help to the project. 
-
-- [Translate to your language](https://github.com/rejetto/hfs/wiki/Translation).
-
-- [Suggest ideas](https://github.com/rejetto/hfs/discussions)
-
-  While the project should not become too complex, yours may be an idea for a plugin.
-
-- Write guides or make videos for other users. [We got a wiki](https://github.com/rejetto/hfs/wiki)! 
-
-- Submit your code
-
-  If you'd like to make a change yourself in the code, please first open an "issue" or "discussion" about it,
-  so we'll try to cooperate and understand what's the best path for it.
-
-- [Make a plugin](dev-plugins.md)
-
-  A plugin can change the look (a theme), and/or introduce a new functionality.
-
-## More
-
-- [APIs](https://github.com/rejetto/hfs/wiki/APIs)
-
-- [Build yourself](dev.md)
-
-- [License](https://github.com/rejetto/hfs/blob/master/LICENSE.txt)
-
-- Flag images are public-domain, downloaded from https://flagpedia.net