kura/src/AbstractDirectoryEntry.ts

The FileSystem API abstraction library.

import { AbstractAccessor } from "./AbstractAccessor";
import { AbstractEntry } from "./AbstractEntry";
import { DefaultDirectoryReader } from "./DefaultDirectoryReader";
import {
  InvalidModificationError,
  NotFoundError,
  PathExistsError,
} from "./FileError";
import {
  DirectoryEntry,
  DirectoryEntryCallback,
  DirectoryReader,
  EntriesCallback,
  Entry,
  EntryCallback,
  ErrorCallback,
  FileEntry,
  FileEntryCallback,
  Flags,
  VoidCallback,
} from "./filesystem";
import {
  DEFAULT_BLOB_PROPS,
  DIR_SEPARATOR,
  INDEX_DIR_PATH,
} from "./FileSystemConstants";
import { FileSystemObject } from "./FileSystemObject";
import { FileSystemParams } from "./FileSystemParams";
import {
  createFileSystemObject,
  onError,
  resolveToFullPath,
} from "./FileSystemUtil";

export abstract class AbstractDirectoryEntry<T extends AbstractAccessor>
  extends AbstractEntry<T>
  implements DirectoryEntry
{
  public isDirectory = true;
  public isFile = false;

  constructor(params: FileSystemParams<T>) {
    super(params);
  }

  public copyTo(
    parent: DirectoryEntry,
    newName?: string | undefined,
    successCallback?: EntryCallback | undefined,
    errorCallback?: ErrorCallback | undefined
  ): void {
    if (!this.canCopy(parent, newName, errorCallback)) {
      return;
    }

    parent.getDirectory(
      newName || this.name,
      { create: true },
      (dirEntry) => {
        const reader = this.createReader();
        reader.readEntries((entries) => {
          const promises: Promise<Entry>[] = [];
          for (const entry of entries) {
            promises.push(
              new Promise<Entry>((resolve, reject) => {
                entry.copyTo(dirEntry, entry.name, resolve, reject);
              })
            );
          }
          Promise.all(promises)
            .then(() => {
              successCallback(dirEntry);
            })
            .catch((errors) => {
              onError(errors, errorCallback);
            });
        }, errorCallback);
      },
      errorCallback
    );
  }

  public createReader(): DirectoryReader {
    return new DefaultDirectoryReader(this);
  }

  public async delete() {
    const accessor = this.params.accessor;
    if (await this.hasChild()) {
      throw new InvalidModificationError(
        this.filesystem.name,
        this.fullPath,
        `${this.fullPath} is not empty`
      );
    }

    await accessor.remove(this.params);
  }

  public getDirectory(
    path: string,
    options?: Flags | undefined,
    successCallback?: DirectoryEntryCallback | undefined,
    errorCallback?: ErrorCallback | undefined
  ): void {
    const fullPath = resolveToFullPath(this.fullPath, path);
    if (fullPath === DIR_SEPARATOR) {
      successCallback(this.filesystem.root);
      return;
    }

    if (!options) {
      options = {};
    }
    if (!successCallback) {
      successCallback = () => {
        // noop
      };
    }

    this.params.accessor
      .getObject(fullPath, false)
      .then((obj) => {
        if (obj.size != null) {
          onError(
            new PathExistsError(
              this.filesystem.name,
              fullPath,
              `${fullPath} is not a directory`
            ),
            errorCallback
          );
          return;
        }

        if (options.create) {
          if (options.exclusive) {
            onError(
              new PathExistsError(fullPath, `${fullPath} already exists`),
              errorCallback
            );
            return;
          }
        }
        successCallback(this.toDirectoryEntry(obj));
      })
      .catch((err) => {
        if (err instanceof NotFoundError) {
          if (options.create) {
            this.registerObject(fullPath, false)
              .then((newObj) => {
                successCallback(this.toDirectoryEntry(newObj));
              })
              .catch((err) => {
                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                onError(err, errorCallback);
              });
          } else {
            onError(err, errorCallback);
          }
        } else {
          onError(err, errorCallback);
        }
      });
  }

  public getFile(
    path: string,
    options?: Flags,
    successCallback?: FileEntryCallback,
    errorCallback?: ErrorCallback
  ): void {
    const fullPath = resolveToFullPath(this.fullPath, path);

    if (!options) {
      options = {};
    }
    if (!successCallback) {
      successCallback = () => {
        // noop
      };
    }

    this.params.accessor
      .getObject(fullPath, true)
      .then((obj) => {
        if (obj.size == null) {
          onError(
            new PathExistsError(
              this.filesystem.name,
              fullPath,
              `${fullPath} is not a file`
            ),
            errorCallback
          );
          return;
        }
        if (options.create) {
          if (options.exclusive) {
            onError(
              new PathExistsError(
                this.filesystem.name,
                fullPath,
                `${fullPath} already exists`
              ),
              errorCallback
            );
            return;
          }
        }
        successCallback(this.toFileEntry(obj));
      })
      .catch((err) => {
        if (err instanceof NotFoundError) {
          if (options.create) {
            this.registerObject(fullPath, true)
              .then((newObj) => {
                successCallback(this.toFileEntry(newObj));
              })
              .catch((err) => {
                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                errorCallback(err);
              });
          } else {
            errorCallback(err);
          }
        } else {
          onError(err, errorCallback);
        }
      });
  }

  public list(
    successCallback: EntriesCallback,
    errorCallback?: ErrorCallback
  ): void {
    this.params.accessor
      .getObjects(this.fullPath)
      .then((objects) => {
        successCallback(this.createEntries(objects));
      })
      .catch((err) => {
        onError(err, errorCallback);
      });
  }

  public moveTo(
    parent: DirectoryEntry,
    newName?: string | undefined,
    successCallback?: EntryCallback | undefined,
    errorCallback?: ErrorCallback | undefined
  ): void {
    if (!this.canCopy(parent, newName, errorCallback)) {
      return;
    }

    parent.getDirectory(
      newName || this.name,
      { create: true },
      (dirEntry) => {
        const reader = this.createReader();
        reader.readEntries((entries) => {
          const promises: Promise<Entry>[] = [];
          for (const entry of entries) {
            promises.push(
              new Promise<Entry>((resolve, reject) => {
                entry.moveTo(dirEntry, entry.name, resolve, reject);
              })
            );
          }
          Promise.all(promises)
            .then(() => {
              successCallback(dirEntry);
            })
            .catch((errors) => {
              onError(errors, errorCallback);
            });
        }, errorCallback);
      },
      errorCallback
    );
  }

  public remove(
    successCallback: VoidCallback,
    errorCallback?: ErrorCallback | undefined
  ): void {
    this.hasChild()
      .then((result) => {
        if (result) {
          onError(
            new InvalidModificationError(
              this.filesystem.name,
              this.fullPath,
              `${this.fullPath} is not empty`
            ),
            errorCallback
          );
          return;
        }

        this.params.accessor
          .remove(this.params)
          .then(() => {
            successCallback();
          })
          .catch((err) => {
            onError(err, errorCallback);
          });
      })
      .catch((err) => {
        onError(err, errorCallback);
      });
  }

  public removeRecursively(
    successCallback: VoidCallback,
    errorCallback?: ErrorCallback | undefined
  ): void {
    this.params.accessor
      .removeRecursively(this.params)
      .then(() => {
        successCallback();
      })
      .catch((err) => {
        onError(err, errorCallback);
      });
  }

  protected createEntries(objects: FileSystemObject[]) {
    const entries: AbstractEntry<T>[] = [];
    for (const obj of objects) {
      if (obj.fullPath.startsWith(INDEX_DIR_PATH)) {
        continue;
      }
      entries.push(this.createEntry(obj));
    }
    return entries;
  }

  protected async hasChild(): Promise<boolean> {
    const objects = await this.params.accessor.getObjects(this.fullPath);
    return 0 < objects.length;
  }

  protected async registerObject(fullPath: string, isFile: boolean) {
    const accessor = this.params.accessor;
    const obj = createFileSystemObject(fullPath, isFile);
    if (isFile) {
      await accessor.putObject(obj, new Blob([], DEFAULT_BLOB_PROPS));
    } else {
      await accessor.putObject(obj);
    }
    return obj;
  }

  protected abstract createEntry(obj: FileSystemObject): AbstractEntry<T>;
  protected abstract toFileEntry(obj: FileSystemObject): FileEntry;
}