@zenfs/core 0.9.2 → 0.9.3

package/src/emulation/constants.ts

@@ -0,0 +1,176 @@
+/*
+FS Constants
+See https://nodejs.org/api/fs.html#file-access-constants
+
+Note: Many of these are pulled from
+https://github.com/torvalds/linux/blob/master/include/uapi/linux/stat.h
+*/
+
+// File Access Constants
+
+/** File is visible to the calling process. */
+export const F_OK = 0;
+
+/** File can be read by the calling process. */
+export const R_OK = 4;
+
+/** File can be written by the calling process. */
+export const W_OK = 2;
+
+/** File can be executed by the calling process. */
+export const X_OK = 1;
+
+// File Copy Constants
+
+/** Constant for fs.copyFile. Flag indicating the destination file should not be overwritten if it already exists. */
+export const COPYFILE_EXCL = 1;
+
+/**
+ * Constant for fs.copyFile. Copy operation will attempt to create a copy-on-write reflink.
+ * If the underlying platform does not support copy-on-write, then a fallback copy mechanism is used.
+ */
+export const COPYFILE_FICLONE = 2;
+
+/**
+ * Constant for fs.copyFile. Copy operation will attempt to create a copy-on-write reflink.
+ * If the underlying platform does not support copy-on-write, then the operation will fail with an error.
+ */
+export const COPYFILE_FICLONE_FORCE = 4;
+
+// File Open Constants
+
+/** Flag indicating to open a file for read-only access. */
+export const O_RDONLY = 0;
+
+/** Flag indicating to open a file for write-only access. */
+export const O_WRONLY = 1;
+
+/** Flag indicating to open a file for read-write access. */
+export const O_RDWR = 2;
+
+/** Flag indicating to create the file if it does not already exist. */
+export const O_CREAT = 0x40; // bit 6
+
+/** Flag indicating that opening a file should fail if the O_CREAT flag is set and the file already exists. */
+export const O_EXCL = 0x80; // bit 7
+
+/**
+ * Flag indicating that if path identifies a terminal device,
+ * opening the path shall not cause that terminal to become the controlling terminal for the process
+ * (if the process does not already have one).
+ */
+export const O_NOCTTY = 0x100; // bit 8
+
+/** Flag indicating that if the file exists and is a regular file, and the file is opened successfully for write access, its length shall be truncated to zero. */
+export const O_TRUNC = 0x200; // bit 9
+
+/** Flag indicating that data will be appended to the end of the file. */
+export const O_APPEND = 0x400; // bit 10
+
+/** Flag indicating that the open should fail if the path is not a directory. */
+export const O_DIRECTORY = 0x10000; // bit 16
+
+/**
+ * constant for fs.open().
+ * Flag indicating reading accesses to the file system will no longer result in
+ * an update to the atime information associated with the file.
+ * This flag is available on Linux operating systems only.
+ */
+export const O_NOATIME = 0x40000; // bit 18
+
+/** Flag indicating that the open should fail if the path is a symbolic link. */
+export const O_NOFOLLOW = 0x20000; // bit 17
+
+/** Flag indicating that the file is opened for synchronous I/O. */
+export const O_SYNC = 0x101000; // bit 20 and bit 12
+
+/** Flag indicating that the file is opened for synchronous I/O with write operations waiting for data integrity. */
+export const O_DSYNC = 0x1000; // bit 12
+
+/** Flag indicating to open the symbolic link itself rather than the resource it is pointing to. */
+export const O_SYMLINK = 0x8000; // bit 15
+
+/** When set, an attempt will be made to minimize caching effects of file I/O. */
+export const O_DIRECT = 0x4000; // bit 14
+
+/** Flag indicating to open the file in nonblocking mode when possible. */
+export const O_NONBLOCK = 0x800; // bit 11
+
+// File Type Constants
+
+/** Bit mask used to extract the file type from mode. */
+export const S_IFMT = 0xf000;
+
+/** File type constant for a socket. */
+export const S_IFSOCK = 0xc000;
+
+/** File type constant for a symbolic link. */
+export const S_IFLNK = 0xa000;
+
+/** File type constant for a regular file. */
+export const S_IFREG = 0x8000;
+
+/** File type constant for a block-oriented device file. */
+export const S_IFBLK = 0x6000;
+
+/** File type constant for a directory. */
+export const S_IFDIR = 0x4000;
+
+/** File type constant for a character-oriented device file. */
+export const S_IFCHR = 0x2000;
+
+/** File type constant for a FIFO/pipe. */
+export const S_IFIFO = 0x1000;
+
+/** Set user id */
+export const S_ISUID = 0o4000;
+
+/** Set group id */
+export const S_ISGID = 0o2000;
+
+/** Sticky bit */
+export const S_ISVTX = 0o1000;
+
+// File Mode Constants
+
+/** File mode indicating readable, writable and executable by owner. */
+export const S_IRWXU = 0o700;
+
+/** File mode indicating readable by owner. */
+export const S_IRUSR = 0o400;
+
+/** File mode indicating writable by owner. */
+export const S_IWUSR = 0o200;
+
+/** File mode indicating executable by owner. */
+export const S_IXUSR = 0o100;
+
+/** File mode indicating readable, writable and executable by group. */
+export const S_IRWXG = 0o70;
+
+/** File mode indicating readable by group. */
+export const S_IRGRP = 0o40;
+
+/** File mode indicating writable by group. */
+export const S_IWGRP = 0o20;
+
+/** File mode indicating executable by group. */
+export const S_IXGRP = 0o10;
+
+/** File mode indicating readable, writable and executable by others. */
+export const S_IRWXO = 7;
+
+/** File mode indicating readable by others. */
+export const S_IROTH = 4;
+
+/** File mode indicating writable by others. */
+export const S_IWOTH = 2;
+
+/** File mode indicating executable by others. */
+export const S_IXOTH = 1;
+
+/**
+ * When set, a memory file mapping is used to access the file.
+ * This flag is ignored since a unix-like FS is emulated
+ */
+export const UV_FS_O_FILEMAP = 0;

package/src/emulation/dir.ts

@@ -0,0 +1,139 @@
+import type { Dirent as _Dirent, Dir as _Dir } from 'fs';
+import type { Callback } from '../utils.js';
+import type { Stats } from '../stats.js';
+import { readdir } from './promises.js';
+import { ApiError, ErrorCode } from '../ApiError.js';
+import { readdirSync } from './sync.js';
+import { basename } from './path.js';
+
+export class Dirent implements _Dirent {
+	public get name(): string {
+		return basename(this.path);
+	}
+
+	constructor(
+		public path: string,
+		protected stats: Stats
+	) {}
+
+	isFile(): boolean {
+		return this.stats.isFile();
+	}
+	isDirectory(): boolean {
+		return this.stats.isDirectory();
+	}
+	isBlockDevice(): boolean {
+		return this.stats.isBlockDevice();
+	}
+	isCharacterDevice(): boolean {
+		return this.stats.isCharacterDevice();
+	}
+	isSymbolicLink(): boolean {
+		return this.stats.isSymbolicLink();
+	}
+	isFIFO(): boolean {
+		return this.stats.isFIFO();
+	}
+	isSocket(): boolean {
+		return this.stats.isSocket();
+	}
+}
+
+/**
+ * A class representing a directory stream.
+ */
+export class Dir implements _Dir {
+	protected closed = false;
+
+	protected checkClosed(): void {
+		if (this.closed) {
+			throw new ApiError(ErrorCode.EBADF, 'Can not use closed Dir');
+		}
+	}
+
+	protected _entries: Dirent[];
+
+	constructor(public readonly path: string) {}
+
+	/**
+	 * Asynchronously close the directory's underlying resource handle.
+	 * Subsequent reads will result in errors.
+	 */
+	close(): Promise<void>;
+	close(cb: Callback): void;
+	close(cb?: Callback): void | Promise<void> {
+		this.closed = true;
+		if (!cb) {
+			return Promise.resolve();
+		}
+		cb();
+	}
+
+	/**
+	 * Synchronously close the directory's underlying resource handle.
+	 * Subsequent reads will result in errors.
+	 */
+	closeSync(): void {
+		this.closed = true;
+	}
+
+	protected async _read(): Promise<Dirent | null> {
+		if (!this._entries) {
+			this._entries = await readdir(this.path, { withFileTypes: true });
+		}
+		if (this._entries.length == 0) {
+			return null;
+		}
+		return this._entries.shift();
+	}
+
+	/**
+	 * Asynchronously read the next directory entry via `readdir(3)` as an `Dirent`.
+	 * After the read is completed, a value is returned that will be resolved with an `Dirent`, or `null` if there are no more directory entries to read.
+	 * Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms.
+	 */
+	read(): Promise<Dirent | null>;
+	read(cb: Callback<[Dirent | null]>): void;
+	read(cb?: Callback<[Dirent | null]>): void | Promise<Dirent | null> {
+		if (!cb) {
+			return this._read();
+		}
+
+		this._read().then(value => cb(null, value));
+	}
+
+	/**
+	 * Synchronously read the next directory entry via `readdir(3)` as a `Dirent`.
+	 * If there are no more directory entries to read, null will be returned.
+	 * Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms.
+	 */
+	readSync(): Dirent | null {
+		if (!this._entries) {
+			this._entries = readdirSync(this.path, { withFileTypes: true });
+		}
+		if (this._entries.length == 0) {
+			return null;
+		}
+		return this._entries.shift();
+	}
+
+	/**
+	 * Asynchronously iterates over the directory via `readdir(3)` until all entries have been read.
+	 */
+	[Symbol.asyncIterator](): AsyncIterableIterator<Dirent> {
+		const _this = this;
+
+		return {
+			[Symbol.asyncIterator]: this[Symbol.asyncIterator],
+			async next(): Promise<IteratorResult<Dirent>> {
+				const value = await _this._read();
+				if (value != null) {
+					return { done: false, value };
+				}
+
+				await _this.close();
+				return { done: true, value: undefined };
+			},
+		};
+	}
+}

package/src/emulation/index.ts

@@ -0,0 +1,8 @@
+export * from './async.js';
+export * from './sync.js';
+export * as promises from './promises.js';
+export * as constants from './constants.js';
+export * from './streams.js';
+export * from './dir.js';
+export { mountMapping, mounts, mount, umount } from './shared.js';
+export { Stats, BigIntStats, StatsFs } from '../stats.js';