Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 | 64x 64x 64x 64x 64x 64x 64x 64x 64x 64x 64x 64x 64x 64x 378x 378x 378x 265x 265x 265x 64x 873x 873x 873x 873x 873x 873x 873x 873x 873x 873x 873x 873x 873x 873x 873x 2031x 876x 1155x 1155x 1155x 1155x 1155x 1155x 45x 45x 45x 45x 3009x 3009x 3009x 3009x 1665x 1665x 3009x 3009x 3009x 9x 9x 9x 9716x 9716x 7973x 7973x 1743x 1743x 9716x 9716x 9716x 13572x 13572x 13570x 56x 2x 13515x 13515x 2066x 733x 11449x 11449x 75x 75x 75x 75x 75x 11374x 5x 5x 11369x 7588x 3x 872x 1800x 7041x 1x 22x 21x 21x 329x 329x 329x 328x 328x 3333x 3333x 3325x 3325x 3320x 229x 229x 229x 1x 1x 229x 723x 452x 271x 271x 271x 271x 271x 127x 127x 127x 144x 144x 229x 229x 229x 46x 229x 85x 85x 7x 7x 8x 8x 8x 7x 78x 85x 85x 84x 705x 930x 930x 930x 755x 755x 755x 755x 175x 266x 3x 3x 3x 3x 3x 3x 3x 3x 1683x 1683x 1683x 1683x 1683x 5x 4x 1678x 1679x 463x 7x 1672x 1261x 7x 1665x 1665x 1665x 1665x 1665x 1732x 1732x 1732x 545x 1197x 1158x 1158x 1156x 1156x 1156x 1148x 1148x 39x 1683x 873x 1732x 1665x 1665x 873x 1150x 1150x 1139x 1124x 1124x 1124x 1124x 1124x 1095x 1094x 1094x 1094x 1124x 873x 53x 2x 51x 50x 1x 49x 873x 5x 4x 4x 4x 4x 11x 11x 11x 11x 4x 873x 5x 5x 1x 1x 4x 4x 4x 4x 4x 4x 4x 4x 873x 10x 9x 9x 9x 9x 9x 9x 873x 89x 89x 89x 89x 89x 88x 88x 88x 88x 88x 873x 64x 64x 5x 5x 59x 59x 59x 59x 59x 59x 59x 6x 53x 53x 53x 53x 53x 873x 182x 182x 181x 180x 180x 178x 178x 176x 873x 1025x 1025x 1025x 1025x 1025x 1739x 1738x 1024x 1024x 1023x 708x 708x 708x 704x 704x 1019x 873x 22x 21x 17x 873x 35x 35x 8x 6x 27x 23x 19x 1601x 1601x 1601x 1601x 873x 1605x 1604x 1601x 1100x 1099x 1099x | import * as NodePath from 'path';
import { Node } from './Node';
import { Link } from './Link';
import { File } from './File';
import { Buffer } from '../internal/buffer';
import process from '../process';
import { constants } from '../constants';
import { ERRSTR, FLAGS, MODE } from '../node/constants';
import { pathToFilename, createError } from '../node/util';
import { dataToBuffer, filenameToSteps, isFd, resolve, validateFd } from './util';
import { DirectoryJSON, flattenJSON, NestedDirectoryJSON } from './json';
import type { PathLike } from '../node/types/misc';
import { ERROR_CODE } from './constants';
import { TFileId } from './types';
type TCallback<TData> = (error?: any, data?: TData) => void;
const { sep, relative, join, dirname } = NodePath.posix ? NodePath.posix : NodePath;
const {
O_RDONLY,
O_WRONLY,
O_RDWR,
O_CREAT,
O_EXCL,
O_TRUNC,
O_APPEND,
O_DIRECTORY,
O_SYMLINK,
F_OK,
COPYFILE_EXCL,
COPYFILE_FICLONE_FORCE,
} = constants;
/**
* Represents a filesystem superblock, which is the root of a virtual
* filesystem in Linux.
* @see https://lxr.linux.no/linux+v3.11.2/include/linux/fs.h#L1242
*/
export class Superblock {
static fromJSON(json: DirectoryJSON, cwd?: string): Superblock {
const vol = new Superblock();
vol.fromJSON(json, cwd);
return vol;
}
static fromNestedJSON(json: NestedDirectoryJSON, cwd?: string): Superblock {
const vol = new Superblock();
vol.fromNestedJSON(json, cwd);
return vol;
}
/**
* Global file descriptor counter. UNIX file descriptors start from 0 and go sequentially
* up, so here, in order not to conflict with them, we choose some big number and descrease
* the file descriptor of every new opened file.
* @type {number}
* @todo This should not be static, right?
*/
static fd: number = 0x7fffffff;
// Constructor function used to create new nodes.
// NodeClass: new (...args) => TNode = Node as new (...args) => TNode;
// Hard link to the root of this volume.
// root: Node = new (this.NodeClass)(null, '', true);
root: Link;
// I-node number counter.
ino: number = 0;
// A mapping for i-node numbers to i-nodes (`Node`);
inodes: { [ino: number]: Node } = {};
// List of released i-node numbers, for reuse.
releasedInos: number[] = [];
// A mapping for file descriptors to `File`s.
fds: { [fd: number]: File } = {};
// A list of reusable (opened and closed) file descriptors, that should be
// used first before creating a new file descriptor.
releasedFds: number[] = [];
// Max number of open files.
maxFiles = 10000;
// Current number of open files.
openFiles = 0;
constructor(props = {}) {
const root = this.createLink();
root.setNode(this.createNode(constants.S_IFDIR | 0o777));
const self = this; // tslint:disable-line no-this-assignment
root.setChild('.', root);
root.getNode().nlink++;
root.setChild('..', root);
root.getNode().nlink++;
this.root = root;
}
createLink(): Link;
createLink(parent: Link, name: string, isDirectory?: boolean, mode?: number): Link;
createLink(parent?: Link, name?: string, isDirectory: boolean = false, mode?: number): Link {
if (!parent) {
return new Link(this, void 0, '');
}
Iif (!name) {
throw new Error('createLink: name cannot be empty');
}
// If no explicit permission is provided, use defaults based on type
const finalPerm = mode ?? (isDirectory ? 0o777 : 0o666);
// To prevent making a breaking change, `mode` can also just be a permission number
// and the file type is set based on `isDirectory`
const hasFileType = mode && mode & constants.S_IFMT;
const modeType = hasFileType ? mode & constants.S_IFMT : isDirectory ? constants.S_IFDIR : constants.S_IFREG;
const finalMode = (finalPerm & ~constants.S_IFMT) | modeType;
return parent.createChild(name, this.createNode(finalMode));
}
deleteLink(link: Link): boolean {
const parent = link.parent;
if (parent) {
parent.deleteChild(link);
return true;
}
return false;
}
private newInoNumber(): number {
const releasedFd = this.releasedInos.pop();
Iif (releasedFd) return releasedFd;
else {
this.ino = (this.ino + 1) % 0xffffffff;
return this.ino;
}
}
private newFdNumber(): number {
const releasedFd = this.releasedFds.pop();
return typeof releasedFd === 'number' ? releasedFd : Superblock.fd--;
}
createNode(mode: number): Node {
const node = new Node(this.newInoNumber(), mode);
this.inodes[node.ino] = node;
return node;
}
deleteNode(node: Node) {
node.del();
delete this.inodes[node.ino];
this.releasedInos.push(node.ino);
}
walk(
steps: string[],
resolveSymlinks: boolean,
checkExistence: boolean,
checkAccess: boolean,
funcName?: string,
): Link | null;
walk(
filename: string,
resolveSymlinks: boolean,
checkExistence: boolean,
checkAccess: boolean,
funcName?: string,
): Link | null;
walk(
link: Link,
resolveSymlinks: boolean,
checkExistence: boolean,
checkAccess: boolean,
funcName?: string,
): Link | null;
walk(
stepsOrFilenameOrLink: string[] | string | Link,
resolveSymlinks: boolean,
checkExistence: boolean,
checkAccess: boolean,
funcName?: string,
): Link | null;
walk(
stepsOrFilenameOrLink: string[] | string | Link,
resolveSymlinks: boolean = false,
checkExistence: boolean = false,
checkAccess: boolean = false,
funcName?: string,
): Link | null {
let steps: string[];
let filename: string;
Iif (stepsOrFilenameOrLink instanceof Link) {
steps = stepsOrFilenameOrLink.steps;
filename = sep + steps.join(sep);
} else if (typeof stepsOrFilenameOrLink === 'string') {
steps = filenameToSteps(stepsOrFilenameOrLink);
filename = stepsOrFilenameOrLink;
} else {
steps = stepsOrFilenameOrLink;
filename = sep + steps.join(sep);
}
let curr: Link | null = this.root;
let i = 0;
while (i < steps.length) {
let node: Node = curr.getNode();
// Check access permissions if current link is a directory
if (node.isDirectory()) {
if (checkAccess && !node.canExecute()) {
throw createError(ERROR_CODE.EACCES, funcName, filename);
}
} else {
if (i < steps.length - 1) throw createError(ERROR_CODE.ENOTDIR, funcName, filename);
}
curr = curr.getChild(steps[i]) ?? null;
// Check existence of current link
if (!curr)
if (checkExistence) throw createError(ERROR_CODE.ENOENT, funcName, filename);
else return null;
node = curr?.getNode();
// Resolve symlink if we're resolving all symlinks OR if this is an intermediate path component
// This allows lstat to traverse through symlinks in intermediate directories while not resolving the final component
if (node.isSymlink() && (resolveSymlinks || i < steps.length - 1)) {
const resolvedPath = NodePath.isAbsolute(node.symlink)
? node.symlink
: join(NodePath.dirname(curr.getPath()), node.symlink); // Relative to symlink's parent
steps = filenameToSteps(resolvedPath).concat(steps.slice(i + 1));
curr = this.root;
i = 0;
continue;
}
// After resolving symlinks, check if it's not a directory and we still have more steps
// This handles the case where we try to traverse through a file
// Only do this check when we're doing filesystem operations (checkExistence = true)
if (checkExistence && !node.isDirectory() && i < steps.length - 1) {
// On Windows, use ENOENT for consistency with Node.js behavior
// On other platforms, use ENOTDIR which is more semantically correct
const errorCode = process.platform === 'win32' ? ERROR_CODE.ENOENT : ERROR_CODE.ENOTDIR;
throw createError(errorCode, funcName, filename);
}
i++;
}
return curr;
}
// Returns a `Link` (hard link) referenced by path "split" into steps.
getLink(steps: string[]): Link | null {
return this.walk(steps, false, false, false);
}
// Just link `getLink`, but throws a correct user error, if link to found.
getLinkOrThrow(filename: string, funcName?: string): Link {
return this.walk(filename, false, true, true, funcName)!;
}
// Just like `getLink`, but also dereference/resolves symbolic links.
getResolvedLink(filenameOrSteps: string | string[]): Link | null {
return this.walk(filenameOrSteps, true, false, false);
}
/**
* Just like `getLinkOrThrow`, but also dereference/resolves symbolic links.
*/
getResolvedLinkOrThrow(filename: string, funcName?: string): Link {
return this.walk(filename, true, true, true, funcName)!;
}
resolveSymlinks(link: Link): Link | null {
return this.getResolvedLink(link.steps.slice(1));
}
/**
* Just like `getLinkOrThrow`, but also verifies that the link is a directory.
*/
getLinkAsDirOrThrow(filename: string, funcName?: string): Link {
const link = this.getLinkOrThrow(filename, funcName)!;
Iif (!link.getNode().isDirectory()) throw createError(ERROR_CODE.ENOTDIR, funcName, filename);
return link;
}
// Get the immediate parent directory of the link.
getLinkParent(steps: string[]): Link | null {
return this.getLink(steps.slice(0, -1));
}
getLinkParentAsDirOrThrow(filenameOrSteps: string | string[], funcName?: string): Link {
const steps: string[] = (
filenameOrSteps instanceof Array ? filenameOrSteps : filenameToSteps(filenameOrSteps)
).slice(0, -1);
const filename: string = sep + steps.join(sep);
const link = this.getLinkOrThrow(filename, funcName);
Iif (!link.getNode().isDirectory()) throw createError(ERROR_CODE.ENOTDIR, funcName, filename);
return link;
}
getFileByFd(fd: number): File {
return this.fds[String(fd)];
}
getFileByFdOrThrow(fd: number, funcName?: string): File {
if (!isFd(fd)) throw TypeError(ERRSTR.FD);
const file = this.getFileByFd(fd);
if (!file) throw createError(ERROR_CODE.EBADF, funcName);
return file;
}
_toJSON(link = this.root, json = {}, path?: string, asBuffer?: boolean): DirectoryJSON<string | null> {
let isEmpty = true;
let children = link.children;
if (link.getNode().isFile()) {
children = new Map([[link.getName(), link.parent!.getChild(link.getName())]]);
link = link.parent!;
}
for (const name of children.keys()) {
if (name === '.' || name === '..') {
continue;
}
isEmpty = false;
const child = link.getChild(name);
Iif (!child) {
throw new Error('_toJSON: unexpected undefined');
}
const node = child.getNode();
if (node.isFile()) {
let filename = child.getPath();
Iif (path) filename = relative(path, filename);
json[filename] = asBuffer ? node.getBuffer() : node.getString();
} else if (node.isDirectory()) {
this._toJSON(child, json, path, asBuffer);
}
}
let dirPath = link.getPath();
Iif (path) dirPath = relative(path, dirPath);
if (dirPath && isEmpty) {
json[dirPath] = null;
}
return json;
}
toJSON(paths?: PathLike | PathLike[], json = {}, isRelative = false, asBuffer = false): DirectoryJSON<string | null> {
const links: Link[] = [];
if (paths) {
if (!Array.isArray(paths)) paths = [paths];
for (const path of paths) {
const filename = pathToFilename(path);
const link = this.getResolvedLink(filename);
if (!link) continue;
links.push(link);
}
} else {
links.push(this.root);
}
if (!links.length) return json;
for (const link of links) this._toJSON(link, json, isRelative ? link.getPath() : '', asBuffer);
return json;
}
// TODO: `cwd` should probably not invoke `process.cwd()`.
fromJSON(json: DirectoryJSON, cwd: string = process.cwd()) {
for (let filename in json) {
const data = json[filename];
filename = resolve(filename, cwd);
if (typeof data === 'string' || data instanceof Buffer) {
const dir = dirname(filename);
this.mkdirp(dir, MODE.DIR);
const buffer = dataToBuffer(data);
this.writeFile(filename, buffer, FLAGS.w, MODE.DEFAULT);
} else {
this.mkdirp(filename, MODE.DIR);
}
}
}
fromNestedJSON(json: NestedDirectoryJSON, cwd?: string) {
this.fromJSON(flattenJSON(json), cwd);
}
reset() {
this.ino = 0;
this.inodes = {};
this.releasedInos = [];
this.fds = {};
this.releasedFds = [];
this.openFiles = 0;
this.root = this.createLink();
this.root.setNode(this.createNode(constants.S_IFDIR | 0o777));
}
// Legacy interface
mountSync(mountpoint: string, json: DirectoryJSON) {
this.fromJSON(json, mountpoint);
}
openLink(link: Link, flagsNum: number, resolveSymlinks: boolean = true): File {
Iif (this.openFiles >= this.maxFiles) {
// Too many open files.
throw createError(ERROR_CODE.EMFILE, 'open', link.getPath());
}
// Resolve symlinks.
//
// @TODO: This should be superfluous. This method is only ever called by openFile(), which does its own symlink resolution
// prior to calling.
let realLink: Link | null = link;
if (resolveSymlinks) realLink = this.getResolvedLinkOrThrow(link.getPath(), 'open');
const node = realLink.getNode();
// Check whether node is a directory
if (node.isDirectory()) {
if ((flagsNum & (O_RDONLY | O_RDWR | O_WRONLY)) !== O_RDONLY)
throw createError(ERROR_CODE.EISDIR, 'open', link.getPath());
} else {
Iif (flagsNum & O_DIRECTORY) throw createError(ERROR_CODE.ENOTDIR, 'open', link.getPath());
}
// Check node permissions
// For read access: check if flags are O_RDONLY or O_RDWR (i.e., not only O_WRONLY)
if ((flagsNum & (O_RDONLY | O_RDWR | O_WRONLY)) !== O_WRONLY) {
if (!node.canRead()) {
throw createError(ERROR_CODE.EACCES, 'open', link.getPath());
}
}
// For write access: check if flags are O_WRONLY or O_RDWR
if (flagsNum & (O_WRONLY | O_RDWR)) {
if (!node.canWrite()) {
throw createError(ERROR_CODE.EACCES, 'open', link.getPath());
}
}
const file = new File(link, node, flagsNum, this.newFdNumber());
this.fds[file.fd] = file;
this.openFiles++;
if (flagsNum & O_TRUNC) file.truncate();
return file;
}
protected openFile(
filename: string,
flagsNum: number,
modeNum: number | undefined,
resolveSymlinks: boolean = true,
): File {
const steps = filenameToSteps(filename);
let link: Link | null;
try {
link = resolveSymlinks ? this.getResolvedLinkOrThrow(filename, 'open') : this.getLinkOrThrow(filename, 'open');
// Check if file already existed when trying to create it exclusively (O_CREAT and O_EXCL flags are set).
// This is an error, see https://pubs.opengroup.org/onlinepubs/009695399/functions/open.html:
// "If O_CREAT and O_EXCL are set, open() shall fail if the file exists."
if (link && flagsNum & O_CREAT && flagsNum & O_EXCL) throw createError(ERROR_CODE.EEXIST, 'open', filename);
} catch (err) {
// Try creating a new file, if it does not exist and O_CREAT flag is set.
// Note that this will still throw if the ENOENT came from one of the
// intermediate directories instead of the file itself.
if (err.code === ERROR_CODE.ENOENT && flagsNum & O_CREAT) {
const dirname: string = NodePath.dirname(filename);
const dirLink: Link = this.getResolvedLinkOrThrow(dirname);
const dirNode = dirLink.getNode();
// Check that the place we create the new file is actually a directory and that we are allowed to do so:
Iif (!dirNode.isDirectory()) throw createError(ERROR_CODE.ENOTDIR, 'open', filename);
if (!dirNode.canExecute() || !dirNode.canWrite()) throw createError(ERROR_CODE.EACCES, 'open', filename);
// This is a difference to the original implementation, which would simply not create a file unless modeNum was specified.
// However, current Node versions will default to 0o666.
modeNum ??= 0o666;
link = this.createLink(dirLink, steps[steps.length - 1], false, modeNum);
} else throw err;
}
if (link) return this.openLink(link, flagsNum, resolveSymlinks);
throw createError(ERROR_CODE.ENOENT, 'open', filename);
}
public readonly open = (
filename: string,
flagsNum: number,
modeNum: number,
resolveSymlinks: boolean = true,
): number => {
const file = this.openFile(filename, flagsNum, modeNum, resolveSymlinks);
Iif (!file) throw createError(ERROR_CODE.ENOENT, 'open', filename);
return file.fd;
};
public readonly writeFile = (id: TFileId, buf: Buffer, flagsNum: number, modeNum: number) => {
const isUserFd = typeof id === 'number';
let fd: number;
if (isUserFd) fd = id as number;
else fd = this.open(pathToFilename(id as PathLike), flagsNum, modeNum);
let offset = 0;
let length = buf.length;
let position = flagsNum & O_APPEND ? undefined : 0;
try {
while (length > 0) {
const written = this.write(fd, buf, offset, length, position);
offset += written;
length -= written;
if (position !== undefined) position += written;
}
} finally {
if (!isUserFd) this.close(fd);
}
};
public readonly read = (
fd: number,
buffer: Buffer | ArrayBufferView | DataView,
offset: number,
length: number,
position: number | null,
): number => {
if (buffer.byteLength < length) {
throw createError(ERROR_CODE.ERR_OUT_OF_RANGE, 'read', undefined, undefined, RangeError);
}
const file = this.getFileByFdOrThrow(fd);
if (file.node.isSymlink()) {
throw createError(ERROR_CODE.EPERM, 'read', file.link.getPath());
}
return file.read(
buffer,
Number(offset),
Number(length),
position === -1 || typeof position !== 'number' ? undefined : position,
);
};
public readonly readv = (fd: number, buffers: ArrayBufferView[], position: number | null): number => {
const file = this.getFileByFdOrThrow(fd);
let p = position ?? undefined;
Iif (p === -1) p = undefined;
let bytesRead = 0;
for (const buffer of buffers) {
const bytes = file.read(buffer, 0, buffer.byteLength, p);
p = undefined;
bytesRead += bytes;
if (bytes < buffer.byteLength) break;
}
return bytesRead;
};
public readonly link = (filename1: string, filename2: string) => {
let link1: Link;
try {
link1 = this.getLinkOrThrow(filename1, 'link');
} catch (err) {
if (err.code) err = createError(err.code, 'link', filename1, filename2);
throw err;
}
const dirname2 = NodePath.dirname(filename2);
let dir2: Link;
try {
dir2 = this.getLinkOrThrow(dirname2, 'link');
} catch (err) {
// Augment error with filename1
Iif (err.code) err = createError(err.code, 'link', filename1, filename2);
throw err;
}
const name = NodePath.basename(filename2);
Iif (dir2.getChild(name)) throw createError(ERROR_CODE.EEXIST, 'link', filename1, filename2);
const node = link1.getNode();
node.nlink++;
dir2.createChild(name, node);
};
public readonly unlink = (filename: string) => {
const link: Link = this.getLinkOrThrow(filename, 'unlink');
// TODO: Check if it is file, dir, other...
Iif (link.length) throw Error('Dir not empty...');
this.deleteLink(link);
const node = link.getNode();
node.nlink--;
// When all hard links to i-node are deleted, remove the i-node, too.
if (node.nlink <= 0) {
this.deleteNode(node);
}
};
public readonly symlink = (targetFilename: string, pathFilename: string): Link => {
const pathSteps = filenameToSteps(pathFilename);
// Check if directory exists, where we about to create a symlink.
let dirLink;
try {
dirLink = this.getLinkParentAsDirOrThrow(pathSteps);
} catch (err) {
// Catch error to populate with the correct fields - getLinkParentAsDirOrThrow won't be aware of the second path
Iif (err.code) err = createError(err.code, 'symlink', targetFilename, pathFilename);
throw err;
}
const name = pathSteps[pathSteps.length - 1];
// Check if new file already exists.
if (dirLink.getChild(name)) throw createError(ERROR_CODE.EEXIST, 'symlink', targetFilename, pathFilename);
// Check permissions on the path where we are creating the symlink.
// Note we're not checking permissions on the target path: It is not an error to create a symlink to a
// non-existent or inaccessible target
const node = dirLink.getNode();
Iif (!node.canExecute() || !node.canWrite())
throw createError(ERROR_CODE.EACCES, 'symlink', targetFilename, pathFilename);
// Create symlink.
const symlink: Link = dirLink.createChild(name);
symlink.getNode().makeSymlink(targetFilename);
return symlink;
};
public readonly rename = (oldPathFilename: string, newPathFilename: string) => {
let link: Link;
try {
link = this.getResolvedLinkOrThrow(oldPathFilename);
} catch (err) {
// Augment err with newPathFilename
if (err.code) err = createError(err.code, 'rename', oldPathFilename, newPathFilename);
throw err;
}
// TODO: Check if it is directory, if non-empty, we cannot move it, right?
// Check directory exists for the new location.
let newPathDirLink: Link;
try {
newPathDirLink = this.getLinkParentAsDirOrThrow(newPathFilename);
} catch (err) {
// Augment error with oldPathFilename
Iif (err.code) err = createError(err.code, 'rename', oldPathFilename, newPathFilename);
throw err;
}
// TODO: Also treat cases with directories and symbolic links.
// TODO: See: http://man7.org/linux/man-pages/man2/rename.2.html
// Remove hard link from old folder.
const oldLinkParent = link.parent;
Iif (!oldLinkParent) throw createError(ERROR_CODE.EINVAL, 'rename', oldPathFilename, newPathFilename);
// Check we have access and write permissions in both places
const oldParentNode: Node = oldLinkParent.getNode();
const newPathDirNode: Node = newPathDirLink.getNode();
if (
!oldParentNode.canExecute() ||
!oldParentNode.canWrite() ||
!newPathDirNode.canExecute() ||
!newPathDirNode.canWrite()
) {
throw createError(ERROR_CODE.EACCES, 'rename', oldPathFilename, newPathFilename);
}
oldLinkParent.deleteChild(link);
// Rename should overwrite the new path, if that exists.
const name = NodePath.basename(newPathFilename);
link.name = name;
link.steps = [...newPathDirLink.steps, name];
newPathDirLink.setChild(link.getName(), link);
};
public readonly mkdir = (filename: string, modeNum: number): void => {
const steps = filenameToSteps(filename);
// This will throw if user tries to create root dir `fs.mkdirSync('/')`.
if (!steps.length) throw createError(ERROR_CODE.EEXIST, 'mkdir', filename);
const dir = this.getLinkParentAsDirOrThrow(filename, 'mkdir');
// Check path already exists.
const name = steps[steps.length - 1];
if (dir.getChild(name)) throw createError(ERROR_CODE.EEXIST, 'mkdir', filename);
const node = dir.getNode();
if (!node.canWrite() || !node.canExecute()) throw createError(ERROR_CODE.EACCES, 'mkdir', filename);
dir.createChild(name, this.createNode(constants.S_IFDIR | modeNum));
};
/**
* Creates directory tree recursively.
*/
public readonly mkdirp = (filename: string, modeNum: number): string | undefined => {
let created = false;
const steps = filenameToSteps(filename);
let curr: Link | null = null;
let i = steps.length;
// Find the longest subpath of filename that still exists:
for (i = steps.length; i >= 0; i--) {
curr = this.getResolvedLink(steps.slice(0, i));
if (curr) break;
}
Iif (!curr) {
curr = this.root;
i = 0;
}
// curr is now the last directory that still exists.
// (If none of them existed, curr is the root.)
// Check access the lazy way:
curr = this.getResolvedLinkOrThrow(sep + steps.slice(0, i).join(sep), 'mkdir');
// Start creating directories:
for (i; i < steps.length; i++) {
const node = curr.getNode();
if (node.isDirectory()) {
// Check we have permissions
if (!node.canExecute() || !node.canWrite()) throw createError(ERROR_CODE.EACCES, 'mkdir', filename);
} else E{
throw createError(ERROR_CODE.ENOTDIR, 'mkdir', filename);
}
created = true;
curr = curr.createChild(steps[i], this.createNode(constants.S_IFDIR | modeNum));
}
return created ? filename : undefined;
};
public readonly rmdir = (filename: string, recursive: boolean = false) => {
const link = this.getLinkAsDirOrThrow(filename, 'rmdir');
if (link.length && !recursive) throw createError(ERROR_CODE.ENOTEMPTY, 'rmdir', filename);
this.deleteLink(link);
};
public readonly rm = (filename: string, force: boolean = false, recursive: boolean = false): void => {
// "stat" is used to match Node's native error message.
let link: Link;
try {
link = this.getResolvedLinkOrThrow(filename, 'stat');
} catch (err) {
// Silently ignore missing paths if force option is true
if (err.code === ERROR_CODE.ENOENT && force) return;
else throw err;
}
if (link.getNode().isDirectory() && !recursive) throw createError(ERROR_CODE.ERR_FS_EISDIR, 'rm', filename);
if (!link.parent?.getNode().canWrite()) throw createError(ERROR_CODE.EACCES, 'rm', filename);
this.deleteLink(link);
};
protected closeFile(file: File) {
Iif (!this.fds[file.fd]) return;
this.openFiles--;
delete this.fds[file.fd];
this.releasedFds.push(file.fd);
}
public readonly close = (fd: number) => {
validateFd(fd);
const file = this.getFileByFdOrThrow(fd, 'close');
this.closeFile(file);
};
write(fd: number, buf: Buffer, offset?: number, length?: number, position?: number | null): number {
const file = this.getFileByFdOrThrow(fd, 'write');
Iif (file.node.isSymlink()) {
throw createError(ERROR_CODE.EBADF, 'write', file.link.getPath());
}
return file.write(buf, offset, length, position === -1 || typeof position !== 'number' ? undefined : position);
}
}
|