@zenfs/core 0.11.2 → 0.12.0

package/src/backends/Index.ts

@@ -1,504 +0,0 @@
-import { ErrnoError, Errno } from '../error.js';
-import type { Cred } from '../cred.js';
-import { basename, dirname, join } from '../emulation/path.js';
-import { NoSyncFile, flagToMode, isWriteable } from '../file.js';
-import { FileSystem, Readonly } from '../filesystem.js';
-import { FileType, Stats } from '../stats.js';
-
-/**
- * @internal
- */
-export type ListingTree = { [key: string]: ListingTree | null };
-
-/**
- * @internal
- */
-export interface ListingQueueNode<TData> {
-	pwd: string;
-	tree: ListingTree;
-	parent: IndexDirInode<TData>;
-}
-
-/**
- * A simple class for storing a filesystem index. Assumes that all paths passed
- * to it are *absolute* paths.
- *
- * Can be used as a partial or a full index, although care must be taken if used
- * for the former purpose, especially when directories are concerned.
- *
- * @internal
- */
-export class FileIndex<TData> {
-	/**
-	 * Static method for constructing indices from a JSON listing.
-	 * @param listing Directory listing generated by tools
-	 * @return A new FileIndex object.
-	 */
-	public static FromListing<T>(listing: ListingTree): FileIndex<T> {
-		const index = new FileIndex<T>();
-		// Add a root DirNode.
-		const rootInode = new IndexDirInode<T>();
-		index._index.set('/', rootInode);
-		const queue: ListingQueueNode<T | Stats>[] = [{ pwd: '', tree: listing, parent: rootInode }];
-		while (queue.length > 0) {
-			let inode: IndexFileInode<Stats> | IndexDirInode<T>;
-			const { tree, pwd, parent } = queue.pop()!;
-			for (const node in tree) {
-				if (!Object.hasOwn(tree, node)) {
-					continue;
-				}
-				const children = tree[node];
-
-				if (children) {
-					const path = pwd + '/' + node;
-					inode = new IndexDirInode<T>();
-					index._index.set(path, inode);
-					queue.push({ pwd: path, tree: children, parent: inode });
-				} else {
-					// This inode doesn't have correct size information, noted with -1.
-					inode = new IndexFileInode<Stats>(new Stats({ mode: FileType.FILE | 0o555 }));
-				}
-				if (!parent) {
-					continue;
-				}
-				parent._listing.set(node, inode);
-			}
-		}
-		return index;
-	}
-
-	// Maps directory paths to directory inodes, which contain files.
-	protected _index: Map<string, IndexDirInode<TData>> = new Map();
-
-	/**
-	 * Constructs a new FileIndex.
-	 */
-	constructor() {
-		// _index is a single-level key,value store that maps *directory* paths to
-		// DirInodes. File information is only contained in DirInodes themselves.
-		// Create the root directory.
-		this.add('/', new IndexDirInode());
-	}
-
-	public files(): IndexFileInode<TData>[] {
-		const files: IndexFileInode<TData>[] = [];
-
-		for (const dir of this._index.values()) {
-			for (const file of dir.listing) {
-				const item = dir.get(file);
-				if (!item) {
-					continue;
-				}
-				if (!item.isFile()) {
-					continue;
-				}
-
-				files.push(item);
-			}
-		}
-		return files;
-	}
-
-	/**
-	 * Adds the given absolute path to the index if it is not already in the index.
-	 * Creates any needed parent directories.
-	 * @param path The path to add to the index.
-	 * @param inode The inode for the
-	 *   path to add.
-	 * @return 'True' if it was added or already exists, 'false' if there
-	 *   was an issue adding it (e.g. item in path is a file, item exists but is
-	 *   different).
-	 * @todo If adding fails and implicitly creates directories, we do not clean up
-	 *   the new empty directories.
-	 */
-	public add(path: string, inode: IndexInode<TData>): boolean {
-		if (!inode) {
-			throw new ErrnoError(Errno.EINVAL, 'Inode must be specified', path, 'FileIndex.add');
-		}
-		if (!path.startsWith('/')) {
-			throw new ErrnoError(Errno.EINVAL, 'Path not absolute', path, 'FileIndex.add');
-		}
-
-		// Check if it already exists.
-		if (this._index.has(path)) {
-			return this._index.get(path) === inode;
-		}
-
-		const dirpath = dirname(path);
-
-		const hasParent = this._index.has(dirpath);
-
-		const parent = hasParent ? this._index.get(dirpath)! : new IndexDirInode<TData>();
-
-		// Try to add to its parent directory first.
-		if (!hasParent && path != '/') {
-			if (!this.add(dirpath, parent)) {
-				return false;
-			}
-		}
-
-		// Add to parent.
-		if (path != '/' && !parent.add(basename(path), inode)) {
-			return false;
-		}
-
-		// If a directory, add to the index.
-		if (inode.isDirectory()) {
-			this._index.set(path, inode);
-		}
-		return true;
-	}
-
-	/**
-	 * Adds the given absolute path to the index if it is not already in the index.
-	 * The path is added without special treatment (no joining of adjacent separators, etc).
-	 * Creates any needed parent directories.
-	 * @param path The path to add to the index.
-	 * @param inode The inode for the path to add.
-	 * @return 'True' if it was added or already exists, 'false' if there
-	 *   was an issue adding it (e.g. item in path is a file, item exists but is
-	 *   different).
-	 * @todo If adding fails and implicitly creates directories, we do not clean up the new empty directories.
-	 */
-	public addFast(path: string, inode: IndexInode<TData>): boolean {
-		const parentPath = dirname(path);
-		const itemName = basename(path);
-
-		// Try to add to its parent directory first.
-		let parent = this._index.get(parentPath);
-		if (!parent) {
-			// Create parent.
-			parent = new IndexDirInode<TData>();
-			this.addFast(parentPath, parent);
-		}
-
-		if (!parent.add(itemName, inode)) {
-			return false;
-		}
-
-		// If adding a directory, add to the index as well.
-		if (inode.isDirectory()) {
-			this._index.set(path, <IndexDirInode<TData>>inode);
-		}
-		return true;
-	}
-
-	/**
-	 * Removes the given path. Can be a file or a directory.
-	 * @return The removed item,
-	 *   or null if it did not exist.
-	 */
-	public remove(path: string): IndexInode<TData> | void {
-		const dirpath = dirname(path);
-
-		// Try to remove it from its parent directory first.
-		const parent = this._index.get(dirpath);
-		if (!parent) {
-			return;
-		}
-		// Remove from parent.
-		const inode = parent.remove(basename(path));
-		if (!inode) {
-			return;
-		}
-
-		if (!inode.isDirectory()) {
-			return inode;
-		}
-		// If a directory, remove from the index, and remove children.
-		const children = inode.listing;
-		for (const child of children) {
-			this.remove(join(path, child));
-		}
-
-		// Remove the directory from the index, unless it's the root.
-		if (path != '/') {
-			this._index.delete(path);
-		}
-	}
-
-	/**
-	 * Retrieves the directory listing of the given path.
-	 * @return An array of files in the given path, or 'null' if it does not exist.
-	 */
-	public ls(path: string): string[] | void {
-		return this._index.get(path)?.listing;
-	}
-
-	/**
-	 * Returns the inode of the given item.
-	 * @return Returns null if the item does not exist.
-	 */
-	public get(path: string): IndexInode<TData> | void | null {
-		const dirpath = dirname(path);
-
-		// Retrieve from its parent directory.
-		const parent = this._index.get(dirpath);
-		// Root case
-		if (dirpath == path) {
-			return parent;
-		}
-		return parent?.get(basename(path));
-	}
-}
-
-/**
- * Generic interface for file/directory inodes.
- * Note that Stats objects are what we use for file inodes.
- */
-export abstract class IndexInode<TData> {
-	constructor(public data?: TData) {}
-	/**
-	 * Whether this inode is for a file
-	 */
-	abstract isFile(): this is IndexFileInode<TData>;
-	/**
-	 * Whether this inode is for a directory
-	 */
-	abstract isDirectory(): this is IndexDirInode<TData>;
-
-	abstract toStats(): Stats;
-}
-
-/**
- * Inode for a file. Stores an arbitrary (filesystem-specific) data payload.
- */
-export class IndexFileInode<TData> extends IndexInode<TData> {
-	public isFile() {
-		return true;
-	}
-	public isDirectory() {
-		return false;
-	}
-
-	public toStats(): Stats {
-		return new Stats({ mode: FileType.FILE | 0o666, size: 4096 });
-	}
-}
-
-/**
- * Inode for a directory. Currently only contains the directory listing.
- */
-export class IndexDirInode<TData> extends IndexInode<TData> {
-	/**
-	 * @internal
-	 */
-	_listing: Map<string, IndexInode<TData>> = new Map();
-
-	public isFile(): boolean {
-		return false;
-	}
-
-	public isDirectory(): boolean {
-		return true;
-	}
-
-	/**
-	 * Return a Stats object for this inode.
-	 * @todo Should probably remove this at some point. This isn't the responsibility of the FileIndex.
-	 */
-	public get stats(): Stats {
-		return new Stats({ mode: FileType.DIRECTORY | 0o555, size: 4096 });
-	}
-	/**
-	 * Alias of getStats()
-	 * @todo Remove this at some point. This isn't the responsibility of the FileIndex.
-	 */
-	public toStats(): Stats {
-		return this.stats;
-	}
-	/**
-	 * Returns the directory listing for this directory. Paths in the directory are
-	 * relative to the directory's path.
-	 * @return The directory listing for this directory.
-	 */
-	public get listing(): string[] {
-		return [...this._listing.keys()];
-	}
-
-	/**
-	 * Returns the inode for the indicated item, or null if it does not exist.
-	 * @param path Name of item in this directory.
-	 */
-	public get(path: string): IndexInode<TData> | void {
-		return this._listing.get(path);
-	}
-	/**
-	 * Add the given item to the directory listing. Note that the given inode is
-	 * not copied, and will be mutated by the DirInode if it is a DirInode.
-	 * @param path Item name to add to the directory listing.
-	 * @param inode The inode for the
-	 *   item to add to the directory inode.
-	 * @return True if it was added, false if it already existed.
-	 */
-	public add(path: string, inode: IndexInode<TData>): boolean {
-		if (this._listing.has(path)) {
-			return false;
-		}
-		this._listing.set(path, inode);
-		return true;
-	}
-	/**
-	 * Removes the given item from the directory listing.
-	 * @param path Name of item to remove from the directory listing.
-	 * @return Returns the item
-	 *   removed, or null if the item did not exist.
-	 */
-	public remove(path: string): IndexInode<TData> | void {
-		const item = this._listing.get(path);
-		if (!item) {
-			return;
-		}
-		this._listing.delete(path);
-		return item;
-	}
-}
-
-export abstract class IndexFS<TData> extends Readonly(FileSystem) {
-	protected _index: FileIndex<TData>;
-
-	constructor(index: ListingTree) {
-		super();
-		this._index = FileIndex.FromListing<TData>(index);
-	}
-
-	public async stat(path: string): Promise<Stats> {
-		const inode = this._index.get(path);
-		if (!inode) {
-			throw ErrnoError.With('ENOENT', path, 'stat');
-		}
-
-		if (inode.isDirectory()) {
-			return inode.stats;
-		}
-
-		if (inode.isFile()) {
-			return this.statFileInode(inode, path);
-		}
-
-		throw new ErrnoError(Errno.EINVAL, 'Invalid inode.');
-	}
-
-	public statSync(path: string): Stats {
-		const inode = this._index.get(path);
-		if (!inode) {
-			throw ErrnoError.With('ENOENT', path, 'stat');
-		}
-
-		if (inode.isDirectory()) {
-			return inode.stats;
-		}
-
-		if (inode.isFile()) {
-			return this.statFileInodeSync(inode, path);
-		}
-
-		throw new ErrnoError(Errno.EINVAL, 'Invalid inode.');
-	}
-
-	public async openFile(path: string, flag: string, cred: Cred): Promise<NoSyncFile<this>> {
-		if (isWriteable(flag)) {
-			// You can't write to files on this file system.
-			throw new ErrnoError(Errno.EPERM, path);
-		}
-
-		// Check if the path exists, and is a file.
-		const inode = this._index.get(path);
-
-		if (!inode) {
-			throw ErrnoError.With('ENOENT', path, 'openFile');
-		}
-
-		if (!inode.toStats().hasAccess(flagToMode(flag), cred)) {
-			throw ErrnoError.With('EACCES', path, 'openFile');
-		}
-
-		if (inode.isDirectory()) {
-			const stats = inode.stats;
-			return new NoSyncFile(this, path, flag, stats, stats.fileData);
-		}
-
-		return this.openFileInode(inode, path, flag);
-	}
-
-	public openFileSync(path: string, flag: string, cred: Cred): NoSyncFile<this> {
-		if (isWriteable(flag)) {
-			// You can't write to files on this file system.
-			throw new ErrnoError(Errno.EPERM, path);
-		}
-
-		// Check if the path exists, and is a file.
-		const inode = this._index.get(path);
-
-		if (!inode) {
-			throw ErrnoError.With('ENOENT', path, 'openFile');
-		}
-
-		if (!inode.toStats().hasAccess(flagToMode(flag), cred)) {
-			throw ErrnoError.With('EACCES', path, 'openFile');
-		}
-
-		if (inode.isDirectory()) {
-			const stats = inode.stats;
-			return new NoSyncFile(this, path, flag, stats, stats.fileData);
-		}
-
-		return this.openFileInodeSync(inode, path, flag);
-	}
-
-	public async readdir(path: string): Promise<string[]> {
-		// Check if it exists.
-		const inode = this._index.get(path);
-		if (!inode) {
-			throw ErrnoError.With('ENOENT', path, 'readdir');
-		}
-
-		if (inode.isDirectory()) {
-			return inode.listing;
-		}
-
-		throw ErrnoError.With('ENOTDIR', path, 'readdir');
-	}
-
-	public readdirSync(path: string): string[] {
-		// Check if it exists.
-		const inode = this._index.get(path);
-		if (!inode) {
-			throw ErrnoError.With('ENOENT', path, 'readdir');
-		}
-
-		if (inode.isDirectory()) {
-			return inode.listing;
-		}
-
-		throw ErrnoError.With('ENOTDIR', path, 'readdir');
-	}
-
-	protected abstract statFileInode(inode: IndexFileInode<TData>, path: string): Promise<Stats>;
-
-	protected abstract statFileInodeSync(inode: IndexFileInode<TData>, path: string): Stats;
-
-	protected abstract openFileInode(inode: IndexFileInode<TData>, path: string, flag: string): Promise<NoSyncFile<this>>;
-
-	protected abstract openFileInodeSync(inode: IndexFileInode<TData>, path: string, flag: string): NoSyncFile<this>;
-}
-
-export abstract class SyncIndexFS<TData> extends IndexFS<TData> {
-	protected async statFileInode(inode: IndexFileInode<TData>, path: string): Promise<Stats> {
-		return this.statFileInodeSync(inode, path);
-	}
-
-	protected async openFileInode(inode: IndexFileInode<TData>, path: string, flag: string): Promise<NoSyncFile<this>> {
-		return this.openFileInodeSync(inode, path, flag);
-	}
-}
-
-export abstract class AsyncIndexFS<TData> extends IndexFS<TData> {
-	protected statFileInodeSync(inode: IndexFileInode<TData>, path: string): Stats {
-		throw ErrnoError.With('ENOSYS', path, 'AsyncIndexFS.statFileInodeSync');
-	}
-
-	protected openFileInodeSync(inode: IndexFileInode<TData>, path: string, flag: string): NoSyncFile<this> {
-		throw ErrnoError.With('ENOSYS', path, 'AsyncIndexFS.openFileInodeSync');
-	}
-}