vvvfs 0.1.2 → 0.1.3

package/README.md

@@ -42,10 +42,12 @@ const vvvfs = new VVVFS("vvvfs", {
 (async function () {
     await vvvfs.reset(); // 重置文件系统
     await vvvfs.init("UserName"); // 初始化文件系统
-    await vvvfs.watch("/home/user/Desktop/test.txt", (type) => {
+    vvvfs.watch("/home/user/Desktop/test.txt", (type) => {
         console.log(type); // 打印文件操作的类型
         return true; // 返回true或false，表示是否取消该操作
     });
+    await vvvfs.lock("/home/user/Desktop/test.txt"); // 锁定文件，防止其他代码访问该文件
+    await vvvfs.unlock("/home/user/Desktop/test.txt"); // 解锁文件
     await vvvfs.createDir("/home/user/Desktop"); // 创建目录，返回true和false
     await vvvfs.writeText("/home/user/Desktop/test.txt", "Hello World!"); // 写入文本文件，写入文件还包括write(path: string, content: Blob)和writeJson(path: string, content: Record<string, any>)方法，返回true和false
     await vvvfs.appendText("/home/user/Desktop/test.txt", "Hello World!"); // 追加文本文件，返回true和false
@@ -84,6 +86,9 @@ const vvvfs = new VVVFS("vvvfs", {
 
 ## 更新日志
 
+### 0.1.3
+- 新增 `lock` 和 `unlock` 方法，可以锁定文件，防止其他代码访问该文件
+
 ### 0.1.2
 
 - 新增 `readChunk` 和 `readChunkText` 方法，用于读取文件块

package/index.html

@@ -17,13 +17,14 @@
                 await vvvfs.reset();
                 await vvvfs.init("IFTC");
                 console.log(vvvfs);
-                await vvvfs.watch("/test.txt", (type) => {
+                vvvfs.watch("/test.txt", (type) => {
                     console.log(type);
                     // return true;
                 });
                 console.log("创建文件", await vvvfs.createFile("/test.txt"));
                 console.log("写入文件", await vvvfs.writeText("/test.txt", "Hello World"));
                 console.log("追加文件", await vvvfs.appendText("/test.txt", " - Appended"));
+                // await vvvfs.lock("/test.txt");
                 console.log("文件是否存在", await vvvfs.exists("/test.txt"));
                 console.log("文件是否存在", await vvvfs.exists("/test2.txt"));
                 console.log("读取文件", await vvvfs.readText("/test.txt"));

package/index.ts

@@ -246,8 +246,23 @@ class VVVFSFile {
     async search(query: string) {
         return await this._vvvfs.search(this._path, query);
     }
-    async watch(handler: (type: string) => Promise<boolean>) {
-        return await this._vvvfs.watch(this._path, handler);
+    /**
+     * 监听文件
+     */
+    watch(handler: (type: string) => Promise<boolean>) {
+        return this._vvvfs.watch(this._path, handler);
+    }
+    /**
+     * 锁定文件
+     */
+    async lock() {
+        return await this._vvvfs.lock(this._path);
+    }
+    /**
+     * 解锁文件
+     */
+    async unlock() {
+        return await this._vvvfs.unlock(this._path);
     }
 }
 
@@ -268,6 +283,10 @@ class VVVFS {
      * 虚拟文件系统监听器
      */
     #watchers: Record<string, Array<(type: string) => Promise<boolean>>> = {};
+    /**
+     * 锁定的文件
+     */
+    #lockedFiles: Record<string, boolean> = {};
     /**
      * 创建虚拟文件系统
      * @param name 虚拟文件系统名称
@@ -575,6 +594,13 @@ class VVVFS {
                     }
                 }
             }
+            if (this.#lockedFiles[targetPath]) {
+                console.warn("文件已被锁定");
+                if (this.options.throwError) {
+                    throw new VVVFSError("Write", "文件已被锁定");
+                }
+                return false;
+            }
             if (!(await this.exists(targetPath))) {
                 const success = await this.createFile(targetPath);
                 if (!success) {
@@ -673,6 +699,13 @@ class VVVFS {
                     }
                 }
             }
+            if (this.#lockedFiles[targetPath]) {
+                console.warn("文件已被锁定");
+                if (this.options.throwError) {
+                    throw new VVVFSError("Append", "文件已被锁定");
+                }
+                return false;
+            }
             const existingFile = await this.read(targetPath);
             if (existingFile) {
                 const blob = new Blob([existingFile, content], {
@@ -724,6 +757,13 @@ class VVVFS {
                     }
                 }
             }
+            if (this.#lockedFiles[targetPath]) {
+                console.warn("文件已被锁定");
+                if (this.options.throwError) {
+                    throw new VVVFSError("Read", "文件已被锁定");
+                }
+                return null;
+            }
             if (!(await this.exists(targetPath))) {
                 console.warn("文件不存在");
                 if (this.options.throwError) {
@@ -812,6 +852,13 @@ class VVVFS {
                     }
                 }
             }
+            if (this.#lockedFiles[targetPath]) {
+                console.warn("文件已被锁定");
+                if (this.options.throwError) {
+                    throw new VVVFSError("Read", "文件已被锁定");
+                }
+                return null;
+            }
             if (!(await this.exists(targetPath))) {
                 console.warn("文件不存在");
                 if (this.options.throwError) {
@@ -901,6 +948,13 @@ class VVVFS {
                     }
                 }
             }
+            if (this.#lockedFiles[targetPath]) {
+                console.warn("文件已被锁定");
+                if (this.options.throwError) {
+                    throw new VVVFSError("List", "文件已被锁定");
+                }
+                return [];
+            }
             if (!(await this.exists(targetPath))) {
                 console.warn("路径不存在");
                 if (this.options.throwError) {
@@ -945,6 +999,13 @@ class VVVFS {
                     }
                 }
             }
+            if (this.#lockedFiles[sourcePath]) {
+                console.warn("文件已被锁定");
+                if (this.options.throwError) {
+                    throw new VVVFSError("Rename", "文件已被锁定");
+                }
+                return false;
+            }
             if (!(await this.exists(sourcePath))) {
                 console.warn("文件不存在");
                 if (this.options.throwError) {
@@ -1014,6 +1075,13 @@ class VVVFS {
                     }
                 }
             }
+            if (this.#lockedFiles[targetPath]) {
+                console.warn("文件已被锁定");
+                if (this.options.throwError) {
+                    throw new VVVFSError("Delete", "文件已被锁定");
+                }
+                return false;
+            }
             if (!(await this.exists(targetPath))) {
                 console.warn("文件不存在");
                 if (this.options.throwError) {
@@ -1070,6 +1138,13 @@ class VVVFS {
                     }
                 }
             }
+            if (this.#lockedFiles[sourcePath]) {
+                console.warn("文件已被锁定");
+                if (this.options.throwError) {
+                    throw new VVVFSError("Move", "文件已被锁定");
+                }
+                return false;
+            }
             if (sourcePath === destinationPath) {
                 return true;
             }
@@ -1147,6 +1222,13 @@ class VVVFS {
                     }
                 }
             }
+            if (this.#lockedFiles[sourcePath]) {
+                console.warn("文件已被锁定");
+                if (this.options.throwError) {
+                    throw new VVVFSError("Copy", "文件已被锁定");
+                }
+                return false;
+            }
             if (await this.exists(destinationPath)) {
                 console.warn("目标文件已存在");
                 if (this.options.throwError) {
@@ -1250,14 +1332,69 @@ class VVVFS {
             return null;
         }
     }
-    async watch(path: string, handler: (type: string) => Promise<boolean>) {
+    /**
+     * 监听文件
+     * @param path 文件路径
+     * @param handler 监听器
+     */
+    watch(path: string, handler: (type: string) => Promise<boolean>) {
         path = joinPath(path);
         if (!this.#watchers[path]) {
             this.#watchers[path] = [];
         }
         this.#watchers[path].push(handler);
     }
+    /**
+     * 锁定文件
+     * @param path 文件路径
+     */
+    async lock(path: string) {
+        path = joinPath(path);
+        if (!(await this.exists(path))) {
+            console.warn("文件不存在");
+            if (this.options.throwError) {
+                throw new VVVFSError("Lock", "文件不存在");
+            }
+            return false;
+        }
+        if (this.#lockedFiles[path]) {
+            console.warn("文件已被锁定");
+            if (this.options.throwError) {
+                throw new VVVFSError("Lock", "文件已被锁定");
+            }
+            return false;
+        }
+        this.#lockedFiles[path] = true;
+        return true;
+    }
+    /**
+     * 解锁文件
+     * @param path 文件路径
+     */
+    async unlock(path: string) {
+        path = joinPath(path);
+        if (!(await this.exists(path))) {
+            console.warn("文件不存在");
+            if (this.options.throwError) {
+                throw new VVVFSError("Unlock", "文件不存在");
+            }
+            return false;
+        }
+        if (!this.#lockedFiles[path]) {
+            console.warn("文件未被锁定");
+            if (this.options.throwError) {
+                throw new VVVFSError("Unlock", "文件未被锁定");
+            }
+            return false;
+        }
+        delete this.#lockedFiles[path];
+        return true;
+    }
 }
+/**
+ * 解析路径
+ * @param path 路径
+ */
 function parsePath(path: string) {
     path = joinPath(path);
     const oldParts = path.split("/");
@@ -1271,6 +1408,11 @@ function parsePath(path: string) {
     if (joinPath(parent, name).length > 4096) throw new VVVFSError("ParsePath", "文件路径过长");
     return { name, parent };
 }
+
+/**
+ * 合并路径
+ * @param paths 路径
+ */
 function joinPath(...paths: string[]) {
     const segments = paths.map((p) => String(p)).filter((p) => p.length > 0);
     if (segments.length === 0) return ".";
@@ -1302,4 +1444,10 @@ Object.defineProperty(VVVFS, "version", {
     enumerable: true,
     configurable: false,
 });
+Object.defineProperty(VVVFS, "author", {
+    value: "IFTC",
+    writable: false,
+    enumerable: true,
+    configurable: false,
+});
 (globalThis as any).VVVFS = VVVFS;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vvvfs",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "一个使用IndexDB实现的虚拟文件系统",
   "keywords": [
     "Virtual",