xshell 1.0.49 → 1.0.51

package/file.d.ts

@@ -21,7 +21,7 @@ export declare function fexists(fp: string, { print }?: {
     - flags: `'r'`
     - options?:
         - mode?: `'0o666'` Sets the file mode (permission and sticky bits) if the file is created. */
-export declare function fopen(fp: string, flags: string | number, { mode, print }?: {
+export declare function fopen(fp: string, flags?: string | number, { mode, print }?: {
     mode?: fs.Mode;
     print?: boolean;
 }): Promise<fsp.FileHandle & {
@@ -91,6 +91,8 @@ export declare function flist(fpd: string, options?: FListOptions & {
 }): Promise<FStats[]>;
 export declare function flist(fpd: string, options?: FListOptions): Promise<string[]>;
 export declare function fstat(fp: string): Promise<FStats>;
+export declare function flstat(fp: string): Promise<FStats>;
+export declare function ffstat(handle: fsp.FileHandle): Promise<fs.BigIntStats>;
 /** 删除文件或文件夹  delete files or folders
     - fp: 文件或文件夹的完整路径  The full path to the file or folder
     - options?:
@@ -155,6 +157,11 @@ export declare function flink(fp_real: string, fp_link: string, { junction, prin
     junction?: boolean;
     print?: boolean;
 }): Promise<void>;
+export declare let fwatchers: Record<string, fs.FSWatcher>;
+/** 跟踪文本文件追加的内容，类似 tail -f */
+export declare function ftail(fp: string, handler: (lines: string[]) => void | Promise<void>, { print }?: {
+    print?: boolean;
+}): Promise<fs.FSWatcher>;
 /** 打开一个文件并搜索替换某个 pattern */
 export declare function freplace(fp: string, pattern: string | RegExp, replacement: string, { print }?: {
     print?: boolean;

package/file.js

@@ -3,7 +3,7 @@ import { isUint8Array } from 'util/types';
 import { path } from './path.js';
 import { t } from './i18n/instance.js';
 import { to_json } from './prototype.js';
-import { assert } from './utils.js';
+import { assert, Lock } from './utils.js';
 export const encodings = ['utf-8', 'gb18030', 'shift-jis', 'utf-16le'];
 /** fp 所指向的 文件/ 文件夹 是否存在
     Does the file/folder pointed to by fp exist?  */
@@ -22,7 +22,7 @@ export function fexists(fp, { print = true } = {}) {
     - flags: `'r'`
     - options?:
         - mode?: `'0o666'` Sets the file mode (permission and sticky bits) if the file is created. */
-export async function fopen(fp, flags, { mode, print } = {}) {
+export async function fopen(fp, flags = 'r', { mode, print } = {}) {
     if (print)
         console.log(t('打开文件'), fp);
     return Object.assign(await fsp.open(fp, flags, mode), { fp, flags, mode });
@@ -163,6 +163,22 @@ export async function fstat(fp) {
     stat.fp = fp;
     return stat;
 }
+export async function flstat(fp) {
+    assert(path.isAbsolute(fp), t("flstat: 参数 fp: '{{fp}}' 必须是绝对路径", { fp }));
+    let stat = await fsp.lstat(fp, { bigint: true });
+    stat.fp = fp;
+    return stat;
+}
+export async function ffstat(handle) {
+    return new Promise((resolve, reject) => {
+        fs.fstat(handle.fd, { bigint: true }, (error, stats) => {
+            if (error)
+                reject(error);
+            else
+                resolve(stats);
+        });
+    });
+}
 /** 删除文件或文件夹  delete files or folders
     - fp: 文件或文件夹的完整路径  The full path to the file or folder
     - options?:
@@ -294,6 +310,54 @@ export async function flink(fp_real, fp_link, { junction = false, print = true }
     else
         fsp.symlink(fp_real, fp_link, is_fpd_real ? 'dir' : 'file');
 }
+export let fwatchers = {};
+/** 跟踪文本文件追加的内容，类似 tail -f */
+export async function ftail(fp, handler, { print = true } = {}) {
+    fwatchers[fp]?.close();
+    const { size } = await fstat(fp);
+    let pointer = Number(size);
+    let lock = new Lock(await fopen(fp));
+    let fbuf = new Uint8Array(2 ** 20);
+    let strbuf = '';
+    let decoder = new TextDecoder();
+    if (print)
+        console.log('开始跟踪追加内容', fp);
+    const { default: throttle } = await import('lodash/throttle.js');
+    const onchange_throttled = throttle(async () => {
+        if (lock.locked)
+            return;
+        await lock.request(async (handle) => {
+            const { bytesRead } = await handle.read(fbuf, 0, fbuf.length, pointer);
+            pointer += bytesRead;
+            const chunk = decoder.decode(fbuf.subarray(0, bytesRead), { stream: true });
+            let lines = [];
+            let j = 0;
+            for (let i = 0; (i = chunk.indexOf('\n', j)) >= 0;) {
+                let line = chunk.slice(j, i);
+                if (strbuf) {
+                    line = strbuf + line;
+                    strbuf = '';
+                }
+                j = i + 1;
+                lines.push(line);
+            }
+            strbuf = chunk.slice(j);
+            await handler(lines);
+        });
+    }, 250);
+    let watcher = fs.watch(fp, event => {
+        if (event === 'change')
+            onchange_throttled();
+        else {
+            console.error(`被监听的文件 ${fp.quote()} 出现了 rename 事件，结束 ftail`);
+            watcher.close();
+        }
+    });
+    watcher.on('error', error => {
+        console.error(error);
+    });
+    return fwatchers[fp] = watcher;
+}
 /** 打开一个文件并搜索替换某个 pattern */
 export async function freplace(fp, pattern, replacement, { print = true } = {}) {
     await fwrite(fp, (await fread(fp, { print }))

package/i18n/dict.json

@@ -343,5 +343,8 @@
     },
     "xshell 启动成功，正在监听: http://localhost:8421": {
         "en": "xshell started successfully and is listening: http://localhost:8421"
+    },
+    "flstat: 参数 fp: '{{fp}}' 必须是绝对路径": {
+        "en": "flstat: parameter fp: '{{fp}}' must be an absolute path"
     }
 }

package/net.js

@@ -87,7 +87,9 @@ export async function request(url, { method, queries, headers: _headers, body, t
     // --- headers, http/2 开始都用小写的 headers
     let headers = new Headers({
         'accept-language': 'zh-CN,zh;q=0.9,en-US;q=0.8,en;q=0.7,ja-JP;q=0.6,ja;q=0.5',
-        'user-agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36',
+        'user-agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36',
+        'sec-ch-ua-platform': '"Windows"',
+        'sec-ch-ua-platform-version': '"15.0.0"',
     });
     if (body !== undefined)
         headers.set('content-type', type);
@@ -541,7 +543,7 @@ export class Remote {
         作为 websocket 连接接收方，必传 websocket 参数
         发送或连接出错时自动清理 message.id 对应的 handler */
     async send(message, websocket) {
-        assert(!message.data || message.data.every(arg => arg !== undefined), 'message.data 数组中不能有 undefined 的项, 因为 json 序列化后会变为 null');
+        assert(!message.data || message.data.every(arg => arg !== undefined), t('message.data 数组中不能有 undefined 的项, 因为 json 序列化后会变为 null'));
         if (this.print)
             console.log('remote.send:', message);
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xshell",
-  "version": "1.0.49",
+  "version": "1.0.51",
   "type": "module",
   "main": "./index.js",
   "bin": {
@@ -16,7 +16,7 @@
     "interactive programming"
   ],
   "engines": {
-    "node": ">=20.5.0",
+    "node": ">=20.5.1",
     "vscode": ">=1.79.0"
   },
   "author": "ShenHongFei <shen.hongfei@outlook.com> (https://github.com/ShenHongFei)",
@@ -77,7 +77,7 @@
     "strip-ansi": "^7.1.0",
     "through2": "^4.0.2",
     "tough-cookie": "^4.1.3",
-    "tslib": "^2.6.1",
+    "tslib": "^2.6.2",
     "typescript": "^5.1.6",
     "ua-parser-js": "2.0.0-alpha.2",
     "undici": "^5.23.0",
@@ -97,18 +97,18 @@
     "@types/koa-compress": "^4.0.3",
     "@types/lodash": "^4.14.197",
     "@types/mime-types": "^2.1.1",
-    "@types/node": "^20.4.10",
+    "@types/node": "^20.5.1",
     "@types/react": "^18.2.20",
     "@types/through2": "^2.0.38",
     "@types/tough-cookie": "^4.0.2",
     "@types/ua-parser-js": "^0.7.36",
     "@types/vinyl-fs": "^3.0.2",
     "@types/vscode": "^1.81.0",
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "@typescript-eslint/parser": "^6.3.0",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "@typescript-eslint/parser": "^6.4.0",
     "eslint": "^8.47.0",
-    "eslint-plugin-react": "^7.33.1",
-    "eslint-plugin-xlint": "^1.0.6"
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-xlint": "^1.0.7"
   },
   "scripts": {
     "start": "node --title=xshell --inspect=0.0.0.0:8420 ./xshell.js",

package/server.d.ts

@@ -68,10 +68,7 @@ export declare class Server {
     format_ua(headers: IncomingHttpHeaders | IncomingHttp2Headers): string;
     proxy(ctx: Context, url: string | URL, headers_?: Record<string, string>): Promise<void>;
     static filter_response_headers(headers: Headers): {};
-    try_send(ctx: Context, fp: string, { root, log_404, }: {
-        root: string;
-        log_404?: boolean;
-    }): Promise<boolean>;
+    try_send(ctx: Context, fpd_root: string, fp: string, log_404: boolean): Promise<boolean>;
     /** 将 body 设置为 fp 所指文件的 ReadStream
         检查 fp 是否合法，设置对应的 content-type，支持缓存，支持分块下载
         - ctx: Koa.Context

package/server.js

@@ -308,27 +308,25 @@ export class Server {
                 headers_[key] = value;
         return headers_;
     }
-    async try_send(ctx, fp, { root, log_404, }) {
+    async try_send(ctx, fpd_root, fp, log_404) {
         const { request: { _path, path, method }, response, } = ctx;
-        if (!(typeof response.body === 'undefined') || response.status !== 404)
+        if (response.body !== undefined || response.status !== 404)
             return true;
         if (method !== 'HEAD' && method !== 'GET')
             return false;
-        function _log_404() {
-            let s = `${' '.repeat(11)}    ${method.toLowerCase()} 404: ${path}`;
-            if (_path !== path)
-                s += ` ${_path.bracket()}`;
-            console.log(s.red);
-        }
         try {
-            await this.fsend(ctx, fp, { root });
+            await this.fsend(ctx, fp, { root: fpd_root });
             return true;
         }
         catch (error) {
             if (error.status !== 404)
                 throw error;
-            if (log_404)
-                _log_404();
+            if (log_404) {
+                let s = `${' '.repeat(11)}    ${method.toLowerCase()} 404: ${path}`;
+                if (_path !== path)
+                    s += ` ${_path.bracket()}`;
+                console.log(s.red);
+            }
             return false;
         }
     }

package/utils.browser.d.ts

@@ -51,6 +51,8 @@ export declare class Lock<TResource = void> {
 export declare function pause(milliseconds?: number): Promise<void>;
 /** 字符串字典序比较 */
 export declare function strcmp(l: string, r: string): 0 | 1 | -1;
+export declare function get<TReturn = any>(obj: any, keypath: string): TReturn;
+export declare function invoke<TReturn = any>(obj: any, funcpath: string, args: any[]): TReturn;
 /** 拼接 TypedArrays 生成一个完整的 Uint8Array */
 export declare function concat(arrays: ArrayBufferView[]): Uint8Array;
 /** 时间间隔 (milliseconds) 格式化 */

package/utils.browser.js

@@ -126,6 +126,19 @@ export function strcmp(l, r) {
         return -1;
     return 1;
 }
+export function get(obj, keypath) {
+    let obj_ = obj;
+    for (const key of keypath.split('.'))
+        obj_ = obj_[key];
+    return obj_;
+}
+export function invoke(obj, funcpath, args) {
+    const paths = funcpath.split('.');
+    let obj_ = obj;
+    for (let i = 0; i < paths.length - 1; i++)
+        obj_ = obj_[paths[i]];
+    return obj_[paths.at(-1)].call(obj_, ...args);
+}
 /** 拼接 TypedArrays 生成一个完整的 Uint8Array */
 export function concat(arrays) {
     let length = 0;

package/utils.d.ts

@@ -22,6 +22,8 @@ export declare function unique<T>(iterable: T[] | Iterable<T>, selector?: string
 export declare function sort_keys<T>(obj: T): T;
 /** 字符串字典序比较 */
 export declare function strcmp(l: string, r: string): 0 | 1 | -1;
+export declare function get<TReturn = any>(obj: any, keypath: string): TReturn;
+export declare function invoke<TReturn = any>(obj: any, funcpath: string, args: any[]): TReturn;
 /** 拼接 TypedArrays 生成一个完整的 Uint8Array */
 export declare function concat(arrays: ArrayBufferView[]): Uint8Array;
 export declare function typed_array_to_buffer(view: ArrayBufferView): Buffer;

package/utils.js

@@ -86,6 +86,19 @@ export function strcmp(l, r) {
         return -1;
     return 1;
 }
+export function get(obj, keypath) {
+    let obj_ = obj;
+    for (const key of keypath.split('.'))
+        obj_ = obj_[key];
+    return obj_;
+}
+export function invoke(obj, funcpath, args) {
+    const paths = funcpath.split('.');
+    let obj_ = obj;
+    for (let i = 0; i < paths.length - 1; i++)
+        obj_ = obj_[paths[i]];
+    return obj_[paths.at(-1)].call(obj_, ...args);
+}
 /** 拼接 TypedArrays 生成一个完整的 Uint8Array */
 export function concat(arrays) {
     let length = 0;
@@ -405,8 +418,8 @@ export async function stream_to_buffer(stream) {
 export async function* stream_to_lines(stream) {
     let buf = '';
     for await (const chunk of stream) {
-        let i = 0, j = 0;
-        for (; (i = chunk.indexOf('\n', j)) >= 0;) {
+        let j = 0;
+        for (let i = 0; (i = chunk.indexOf('\n', j)) >= 0;) {
             let line = chunk.slice(j, i);
             if (buf) {
                 line = buf + line;