Class StorageSubsystem

common/src/system_storage.ts:4–115

import path from "path";

export default class StorageSubsystem {
  public static readonly DATA_PATH = path.normalize(path.join(process.cwd(), "data"));
  public static readonly INDEX_PATH = path.normalize(path.join(process.cwd(), "data", "index"));

  private checkFileName(name: string) {
    if (!name) return false;
    const blackList = ["\\", "/", ".."];
    for (const ch of blackList) {
      if (name.includes(ch)) return false;
    }
    return true;
  }

  public writeFile(name: string, data: string) {
    const targetPath = path.normalize(path.join(StorageSubsystem.DATA_PATH, name));
    fs.writeFileSync(targetPath, data, { encoding: "utf-8" });
  }

  public readFile(name: string) {
    const targetPath = path.normalize(path.join(StorageSubsystem.DATA_PATH, name));
    return fs.readFileSync(targetPath, { encoding: "utf-8" });
  }

  public readDir(dirName: string) {
    const targetPath = path.normalize(path.join(StorageSubsystem.DATA_PATH, dirName));
    if (!fs.existsSync(targetPath)) return [];
    const files = fs.readdirSync(targetPath).map((v) => path.normalize(path.join(dirName, v)));
    return files;
  }

  public deleteFile(name: string) {
    const targetPath = path.normalize(path.join(StorageSubsystem.DATA_PATH, name));
    fs.removeSync(targetPath);
  }

  public fileExists(name: string) {
    const targetPath = path.normalize(path.join(StorageSubsystem.DATA_PATH, name));
    return fs.existsSync(targetPath);
  }

  // Stored in local file based on class definition and identifier
  public store(category: string, uuid: string, object: any) {
    const dirPath = path.join(StorageSubsystem.DATA_PATH, category);
    if (!fs.existsSync(dirPath)) fs.mkdirsSync(dirPath);
    if (!this.checkFileName(uuid))
      throw new Error(`UUID ${uuid} does not conform to specification`);
    const filePath = path.join(dirPath, `${uuid}.json`);
    const data = JSON.stringify(object, null, 4);
    fs.writeFileSync(filePath, data, { encoding: "utf-8" });
  }

  // deep copy of the primitive type with the copy target as the prototype
  protected defineAttr(target: any, object: any): any {
    for (const v of Object.keys(target)) {
      const objectValue = object[v];
      if (objectValue === undefined) continue;
      if (objectValue instanceof Array) {
        target[v] = objectValue;