hfs 0.44.0 → 0.45.0-alpha3

package/src/log.js

@@ -34,7 +34,6 @@ const fs_1 = require("fs");
 const util = __importStar(require("util"));
 const promises_1 = require("fs/promises");
 const const_1 = require("./const");
-const events_1 = __importDefault(require("./events"));
 const lodash_1 = __importDefault(require("lodash"));
 const util_files_1 = require("./util-files");
 const perm_1 = require("./perm");
@@ -62,8 +61,8 @@ class Logger {
         this.reopen();
     }
     reopen() {
-        return this.stream = (0, fs_1.createWriteStream)(this.path, { flags: 'a' })
-            .on('error', () => this.stream = undefined);
+        var _a;
+        return this.stream = (_a = (0, util_files_1.createFileWithPath)(this.path, { flags: 'a' })) === null || _a === void 0 ? void 0 : _a.on('error', () => this.stream = undefined);
     }
 }
 // we'll have names same as config keys. These are used also by the get_log api.
@@ -122,7 +121,6 @@ function log() {
             const date = a[2] + '/' + a[1] + '/' + a[3] + ':' + a[4] + ' ' + ((_b = a[5]) === null || _b === void 0 ? void 0 : _b.slice(3));
             const user = (0, perm_1.getCurrentUsername)(ctx);
             const length = (_c = ctx.state.length) !== null && _c !== void 0 ? _c : ctx.length;
-            events_1.default.emit(logger.name, Object.assign(lodash_1.default.pick(ctx, ['ip', 'method', 'status']), { length, user, ts: now, uri: ctx.path }));
             debounce(() => // once in a while we check if the file is still good (not deleted, etc), or we'll reopen it
              (0, promises_1.stat)(logger.path).catch(() => logger.reopen())); // async = smoother but we may lose some entries
             stream.write(util.format(format, ctx.ip, user || '-', date, ctx.method, ctx.path, ctx.req.httpVersion, ctx.status, (_d = length === null || length === void 0 ? void 0 : length.toString()) !== null && _d !== void 0 ? _d : '-'));

package/src/middlewares.js

@@ -132,9 +132,20 @@ const serveGuiAndSharedFiles = async (ctx, next) => {
     }
     ctx.set({ server: 'HFS ' + const_1.BUILD_TIMESTAMP });
     return ctx.query.get === 'zip' ? (0, zip_1.zipStreamFromFolder)(node, ctx)
-        : serveFrontendFiles(ctx, next);
+        : ctx.query.get === 'list' ? sendFolderList(node, ctx)
+            : serveFrontendFiles(ctx, next);
 };
 exports.serveGuiAndSharedFiles = serveGuiAndSharedFiles;
+async function sendFolderList(node, ctx) {
+    const { depth = 0, folders } = ctx.query;
+    ctx.type = 'text';
+    const walker = (0, vfs_1.walkNode)(node, ctx, depth === '*' ? Infinity : Number(depth) + 1);
+    ctx.body = (0, misc_1.asyncGeneratorToReadable)((0, misc_1.filterMapGenerator)(walker, async (el) => {
+        const isFolder = await (0, vfs_1.nodeIsDirectory)(el);
+        return !folders && isFolder ? undefined
+            : el.name + (isFolder ? '/' : '') + '\n';
+    }));
+}
 let proxyDetected;
 const someSecurity = async (ctx, next) => {
     ctx.request.ip = (0, connections_1.normalizeIp)(ctx.ip);

package/src/misc.js

@@ -181,8 +181,15 @@ function isLocalHost(c) {
 exports.isLocalHost = isLocalHost;
 function makeNetMatcher(mask, emptyMaskReturns = false) {
     return !mask ? () => emptyMaskReturns
-        : mask.includes('/') ? (ip) => cidr_tools_1.default.contains(mask, ip)
-            : makeMatcher(mask);
+        : !mask.includes('/') ? makeMatcher(mask)
+            : (() => {
+                var _a;
+                const all = mask.split('|');
+                const neg = ((_a = all[0]) === null || _a === void 0 ? void 0 : _a[0]) === '!';
+                if (neg)
+                    all[0] = all[0].slice(1);
+                return (ip) => neg !== all.some(x => cidr_tools_1.default.contains(x, ip));
+            })();
 }
 exports.makeNetMatcher = makeNetMatcher;
 function makeMatcher(mask, emptyMaskReturns = false) {

package/src/plugins.js

@@ -41,6 +41,7 @@ const promises_1 = require("fs/promises");
 const fs_1 = require("fs");
 const connections_1 = require("./connections");
 const path_1 = require("path");
+const customHtml_1 = require("./customHtml");
 exports.PATH = 'plugins';
 exports.DISABLING_POSTFIX = '-disabled';
 const plugins = {};
@@ -297,8 +298,12 @@ function loadPlugin(id, path) {
                 },
                 getHfsConfig: config_1.getConfig,
             }));
-            Object.assign(data, res);
-            const plugin = new Plugin(id, (0, path_1.dirname)(module), data, unwatch);
+            const folder = (0, path_1.dirname)(module);
+            Object.assign(data, res, {
+                customHtml: (0, customHtml_1.newCustomHtmlState)()
+            });
+            const customHtmlWatcher = (0, customHtml_1.watchLoadCustomHtml)(data.customHtml, folder);
+            const plugin = new Plugin(id, folder, data, lodash_1.default.flow(unwatch, customHtmlWatcher.unwatch));
             if (alreadyRunning)
                 events_1.default.emit('pluginUpdated', Object.assign(lodash_1.default.pick(plugin, 'started'), getPluginInfo(id)));
             else {

package/src/serveGuiFiles.js

@@ -37,7 +37,7 @@ const apiMiddleware_1 = require("./apiMiddleware");
 const path_1 = require("path");
 const misc_1 = require("./misc");
 const adminApis_1 = require("./adminApis");
-const valtio_1 = require("valtio");
+const vanilla_1 = require("valtio/vanilla");
 const customHtml_1 = require("./customHtml");
 const lodash_1 = __importDefault(require("lodash"));
 const config_1 = require("./config");
@@ -47,7 +47,7 @@ const DEV_STATIC = process.env.DEV ? 'dist/' : '';
 function serveStatic(uri) {
     const folder = uri.slice(2, -1); // we know folder is very similar to uri
     let cache = {};
-    (0, valtio_1.subscribe)(customHtml_1.customHtmlState, () => cache = {}); // reset cache at every change
+    (0, vanilla_1.subscribe)(customHtml_1.customHtmlState, () => cache = {}); // reset cache at every change
     return async (ctx) => {
         if (ctx.method === 'OPTIONS') {
             ctx.status = const_1.HTTP_NO_CONTENT;
@@ -129,14 +129,14 @@ async function treatIndex(ctx, filesUri, body) {
                 ${lodash_1.default.map(plugins, (configs, pluginName) => lodash_1.default.map(configs, (v, k) => `--${pluginName}-${k}: ${serializeCss(v)};`).join('\n')).join('')}
             }
             </style>
-            ${!isFrontend ? '' : (0, plugins_1.mapPlugins)((plug, k) => {
+            ${!isFrontend ? '' : (0, plugins_1.mapPlugins)((plug, id) => {
         var _a;
-        return (_a = plug.frontend_css) === null || _a === void 0 ? void 0 : _a.map(f => `<link rel='stylesheet' type='text/css' href='${pub + k + '/' + f}' plugin=${JSON.stringify(k)}/>`);
+        return (_a = plug.frontend_css) === null || _a === void 0 ? void 0 : _a.map(f => `<link rel='stylesheet' type='text/css' href='${f.includes('//') ? f : pub + id + '/' + f}' plugin=${JSON.stringify(id)}/>`);
     })
         .flat().filter(Boolean).join('\n')}
-            ${!isFrontend ? '' : (0, plugins_1.mapPlugins)((plug, k) => {
+            ${!isFrontend ? '' : (0, plugins_1.mapPlugins)((plug, id) => {
         var _a;
-        return (_a = plug.frontend_js) === null || _a === void 0 ? void 0 : _a.map(f => `<script defer plugin=${JSON.stringify(k)} src='${pub + k + '/' + f}'></script>`);
+        return (_a = plug.frontend_js) === null || _a === void 0 ? void 0 : _a.map(f => `<script defer plugin=${JSON.stringify(id)} src='${f.includes('//') ? f : pub + id + '/' + f}'></script>`);
     })
         .flat().filter(Boolean).join('\n')}
         `);

package/src/update.js

@@ -1,7 +1,10 @@
 "use strict";
 // This file is part of HFS - Copyright 2021-2023, Massimo Melina <a@rejetto.com> - License https://www.gnu.org/licenses/gpl-3.0.txt
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.update = exports.getUpdate = void 0;
+exports.update = exports.updateSupported = exports.localUpdateAvailable = exports.getUpdate = void 0;
 const github_1 = require("./github");
 const const_1 = require("./const");
 const path_1 = require("path");
@@ -10,6 +13,7 @@ const misc_1 = require("./misc");
 const fs_1 = require("fs");
 const plugins_1 = require("./plugins");
 const promises_1 = require("fs/promises");
+const open_1 = __importDefault(require("open"));
 async function getUpdate() {
     const [latest] = await (0, github_1.getRepoInfo)(const_1.HFS_REPO + '/releases?per_page=1');
     if (latest.name === const_1.VERSION)
@@ -17,25 +21,38 @@ async function getUpdate() {
     return latest;
 }
 exports.getUpdate = getUpdate;
+const LOCAL_UPDATE = 'hfs-update.zip'; // update from file takes precedence over net
+function localUpdateAvailable() {
+    return (0, promises_1.access)(LOCAL_UPDATE).then(() => true, () => false);
+}
+exports.localUpdateAvailable = localUpdateAvailable;
+function updateSupported() {
+    return const_1.IS_BINARY;
+}
+exports.updateSupported = updateSupported;
 async function update() {
-    if (!const_1.IS_BINARY)
+    if (!updateSupported())
         throw "only binary versions are supported for now";
-    const update = await getUpdate();
-    const assetSearch = { win32: 'windows', darwin: 'mac', linux: 'linux' }[process.platform];
-    if (!assetSearch)
-        throw "this feature doesn't support your platform: " + process.platform;
-    const asset = update.assets.find((x) => x.name.endsWith('.zip') && x.name.includes(assetSearch));
-    if (!asset)
-        throw "asset not found";
-    const url = asset.browser_download_url;
-    console.log("downloading", url);
+    let updateSource = await localUpdateAvailable() && (0, fs_1.createReadStream)(LOCAL_UPDATE);
+    if (!updateSource) {
+        const update = await getUpdate();
+        const assetSearch = { win32: 'windows', darwin: 'mac', linux: 'linux' }[process.platform];
+        if (!assetSearch)
+            throw "this feature doesn't support your platform: " + process.platform;
+        const asset = update.assets.find((x) => x.name.endsWith('.zip') && x.name.includes(assetSearch));
+        if (!asset)
+            throw "asset not found";
+        const url = asset.browser_download_url;
+        console.log("downloading", url);
+        updateSource = await (0, misc_1.httpsStream)(url);
+    }
     const bin = process.execPath;
     const binPath = (0, path_1.dirname)(bin);
     const binFile = (0, path_1.basename)(bin);
     const newBinFile = 'new-' + binFile;
     plugins_1.pluginsWatcher.pause();
     try {
-        await (0, misc_1.unzip)(await (0, misc_1.httpsStream)(url), path => (0, path_1.join)(binPath, path === binFile ? newBinFile : path));
+        await (0, misc_1.unzip)(updateSource, path => (0, path_1.join)(binPath, path === binFile ? newBinFile : path));
         const newBin = (0, path_1.join)(binPath, newBinFile);
         if (!const_1.IS_WINDOWS) {
             const { mode } = await (0, promises_1.stat)(bin);
@@ -51,19 +68,29 @@ async function update() {
             catch (_a) { }
             (0, fs_1.renameSync)(bin, oldBin);
             console.log("launching new version in background", newBinFile);
-            (0, child_process_1.spawn)(newBin, ['--updating', binFile], { detached: true, shell: true })
-                .on('error', console.error);
+            launch(newBin, ['--updating', binFile], { sync: true }); // sync necessary to work on mac by double-click
         });
         console.log('quitting');
-        process.exit();
+        setTimeout(() => process.exit()); // give time to return (and caller to complete, eg: rest api to reply)
     }
     catch (_a) {
         plugins_1.pluginsWatcher.unpause();
     }
 }
 exports.update = update;
+function launch(cmd, pars = [], options) {
+    return ((options === null || options === void 0 ? void 0 : options.sync) ? child_process_1.spawnSync : child_process_1.spawn)(cmd, pars, { detached: true, shell: true, stdio: [0, 1, 2], ...options });
+}
 if (const_1.argv.updating) { // we were launched with a temporary name, restore original name to avoid breaking references
     const bin = process.execPath;
-    (0, fs_1.renameSync)(bin, (0, path_1.join)((0, path_1.dirname)(bin), const_1.argv.updating));
-    console.log("renamed binary file to", const_1.argv.updating);
+    const dest = (0, path_1.join)((0, path_1.dirname)(bin), const_1.argv.updating);
+    (0, fs_1.renameSync)(bin, dest);
+    // have to relaunch with new name, or otherwise next update will fail with EBUSY on hfs.exe
+    console.log("renamed binary file to", const_1.argv.updating, "and restarting");
+    // be sure to test launching both double-clicking and in a terminal
+    if (const_1.IS_WINDOWS) // this method on Mac works only once, and without console
+        (0, misc_1.onProcessExit)(() => launch(dest, ['--updated'])); // launch+sync here would cause old process to stay open, locking ports
+    else
+        (0, open_1.default)(dest).then();
+    process.exit();
 }

package/src/util-files.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidFileName = exports.prepareFolder = exports.unzip = exports.dirStream = exports.adjustStaticPathForGlob = exports.isWindowsDrive = exports.dirTraversal = exports.watchDir = exports.readFileBusy = exports.isFile = exports.isDirectory = void 0;
+exports.isValidFileName = exports.createFileWithPath = exports.prepareFolder = exports.unzip = exports.dirStream = exports.adjustStaticPathForGlob = exports.isWindowsDrive = exports.dirTraversal = exports.watchDir = exports.readFileBusy = exports.isDirectory = void 0;
 const promises_1 = __importDefault(require("fs/promises"));
 const misc_1 = require("./misc");
 const fs_1 = require("fs");
@@ -24,15 +24,6 @@ async function isDirectory(path) {
     }
 }
 exports.isDirectory = isDirectory;
-async function isFile(path) {
-    try {
-        return (await promises_1.default.stat(path)).isFile();
-    }
-    catch (_a) {
-        return false;
-    }
-}
-exports.isFile = isFile;
 async function readFileBusy(path) {
     return promises_1.default.readFile(path, 'utf8').catch(e => {
         if ((e === null || e === void 0 ? void 0 : e.code) !== 'EBUSY')
@@ -154,6 +145,18 @@ async function prepareFolder(path, dirnameIt = true) {
     }
 }
 exports.prepareFolder = prepareFolder;
+function createFileWithPath(path, options) {
+    const folder = (0, path_1.dirname)(path);
+    if (!isWindowsDrive(folder))
+        try {
+            (0, fs_1.mkdirSync)(folder, { recursive: true });
+        }
+        catch (_a) {
+            return;
+        }
+    return (0, fs_1.createWriteStream)(path, options);
+}
+exports.createFileWithPath = createFileWithPath;
 function isValidFileName(name) {
     return !/^\.\.?$|[/:*?"<>|\\]/.test(name);
 }

package/src/vfs.js

@@ -26,17 +26,20 @@ exports.defaultPerms = {
 exports.PERM_KEYS = (0, misc_1.typedKeys)(exports.defaultPerms);
 exports.MIME_AUTO = 'auto';
 function inheritFromParent(parent, child) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     for (const k of (0, misc_1.typedKeys)(exports.defaultPerms)) {
-        const v = parent[k];
+        let dueParent = parent;
+        while (((_a = dueParent === null || dueParent === void 0 ? void 0 : dueParent.propagate) === null || _a === void 0 ? void 0 : _a[k]) === false)
+            dueParent = dueParent.parent;
+        const v = dueParent === null || dueParent === void 0 ? void 0 : dueParent[k];
         if (v !== undefined) // small optimization: don't expand the object
-            (_a = child[k]) !== null && _a !== void 0 ? _a : (child[k] = v);
+            (_b = child[k]) !== null && _b !== void 0 ? _b : (child[k] = v);
     }
     if (typeof parent.mime === 'object' && typeof child.mime === 'object')
         lodash_1.default.defaults(child.mime, parent.mime);
     else
-        (_b = child.mime) !== null && _b !== void 0 ? _b : (child.mime = parent.mime);
-    (_c = child.accept) !== null && _c !== void 0 ? _c : (child.accept = parent.accept);
+        (_c = child.mime) !== null && _c !== void 0 ? _c : (child.mime = parent.mime);
+    (_d = child.accept) !== null && _d !== void 0 ? _d : (child.accept = parent.accept);
     return child;
 }
 function isSameFilenameAs(name) {
@@ -45,7 +48,9 @@ function isSameFilenameAs(name) {
 }
 exports.isSameFilenameAs = isSameFilenameAs;
 function applyParentToChild(child, parent, name) {
+    var _a;
     const ret = {
+        isFolder: ((_a = child === null || child === void 0 ? void 0 : child.children) === null || _a === void 0 ? void 0 : _a.length) ? true : undefined,
         ...child,
         original: child,
         isTemp: true,
@@ -76,9 +81,9 @@ async function urlToNode(url, ctx, parent = exports.vfs, getRest) {
     // does the tree node have a child that goes by this name?
     const child = (_a = parent.children) === null || _a === void 0 ? void 0 : _a.find(isSameFilenameAs(name));
     if (!child && !parent.source)
-        return; // on tree or on disk
+        return; // on tree or on disk, or it doesn't exist
     const ret = applyParentToChild(child, parent, name);
-    if (child) // yes
+    if (child)
         return urlToNode(rest, ctx, ret, getRest);
     let onDisk = name;
     if (parent.rename) { // reverse the mapping
@@ -96,8 +101,9 @@ async function urlToNode(url, ctx, parent = exports.vfs, getRest) {
         return urlToNode(rest, ctx, ret, getRest);
     if (ret.source)
         try {
-            await promises_1.default.stat(ret.source);
-        } // check existence
+            const st = await promises_1.default.stat(ret.source); // check existence
+            ret.isFolder = st.isDirectory();
+        }
         catch (_b) {
             if (!getRest)
                 return;
@@ -130,7 +136,15 @@ function getNodeName(node) {
 }
 exports.getNodeName = getNodeName;
 async function nodeIsDirectory(node) {
-    return Boolean(!node.source || await (0, misc_1.isDirectory)(node.source));
+    var _a;
+    if (node.isFolder !== undefined)
+        return node.isFolder;
+    const isFolder = Boolean(((_a = node.children) === null || _a === void 0 ? void 0 : _a.length) || !node.source || await (0, misc_1.isDirectory)(node.source));
+    if (node.isTemp)
+        node.isFolder = isFolder;
+    else
+        (0, misc_1.setHidden)(node, { isFolder }); // don't make it to the storage
+    return isFolder;
 }
 exports.nodeIsDirectory = nodeIsDirectory;
 function hasPermission(node, perm, ctx) {
@@ -201,7 +215,7 @@ async function* walkNode(parent, ctx, depth = 0, prefixPath = '', requiredPerm)
         const map = new Map();
         map.set(lastDir, parent);
         // it's important to keep using dirStream in deep-mode, as it is manyfold faster (it parallelizes)
-        for await (const [path, isDir] of (0, misc_1.dirStream)(source, depth)) {
+        for await (const [path, isFolder] of (0, misc_1.dirStream)(source, depth)) {
             if (ctx === null || ctx === void 0 ? void 0 : ctx.req.aborted)
                 return;
             const name = prefixPath + (((_a = parent.rename) === null || _a === void 0 ? void 0 : _a[path]) || path);
@@ -214,12 +228,13 @@ async function* walkNode(parent, ctx, depth = 0, prefixPath = '', requiredPerm)
             }
             const item = {
                 name,
+                isFolder,
                 source: (0, path_1.join)(source, path),
                 rename: renameUnderPath(parent.rename, path),
             };
             if (!canSee(item))
                 continue;
-            if (isDir)
+            if (isFolder)
                 map.set(name, item);
             yield item;
         }

package/src/watchLoad.js

@@ -7,9 +7,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.watchLoad = void 0;
 const fs_1 = require("fs");
 const promises_1 = __importDefault(require("fs/promises"));
-const yaml_1 = __importDefault(require("yaml"));
 const misc_1 = require("./misc");
-function watchLoad(path, parser, { failedOnFirstAttempt } = {}) {
+function watchLoad(path, parser, { failedOnFirstAttempt, immediateFirst } = {}) {
     let doing = false;
     let watcher;
     const debounced = (0, misc_1.debounceAsync)(load, 500, { maxWait: 1000 });
@@ -32,6 +31,8 @@ function watchLoad(path, parser, { failedOnFirstAttempt } = {}) {
                     debounced().then();
             });
             debounced().catch(x => x);
+            if (immediateFirst)
+                debounced.flush().then();
         }
         catch (e) {
             retry = setTimeout(install, 3000); // manual watching until watch is successful
@@ -60,8 +61,7 @@ function watchLoad(path, parser, { failedOnFirstAttempt } = {}) {
             console.debug('loaded', path);
             uninstall();
             install(); // reinstall, as the original file could have been renamed. We watch by the name.
-            const decoded = path.endsWith('.yaml') ? yaml_1.default.parse(text) : text;
-            await parser(decoded);
+            await parser(text);
         }
         finally {
             doing = false;