Class File

constructor

• new File(o: FileCfg): File

  Constructor

  Parameters

  • o: FileCfg

    {object}

  Returns File

filename

Optionalid

isDirectory

location

mime_sub

mime_super

min_role_read

s3_store

size_kb

uploaded_at

Optionaluser_id

Staticfixed_user

Staticsandbox_dir

absolutePath

• get absolutePath(): string

  Returns string

current_folder

• get current_folder(): string

  Get current folder

  Returns string

field_value

• get field_value(): string

  Returns string

mimetype

• get mimetype(): string

  MIME type of the file

  Returns string

path_to_serve

• get path_to_serve(): string

  Get path to serve

  Returns string

delete

• delete(
      unlinker?: (arg0: File) => Promise<void>,
  ): Promise<void | { error: string }>

  Delete file

  Parameters

  • Optionalunlinker: (arg0: File) => Promise<void>

  Returns Promise<void | { error: string }>

get_contents

• get_contents(
      encoding?: "ascii" | "utf8" | "base64" | "base64url" | "hex",
  ): Promise<string | Buffer<ArrayBufferLike>>

  Parameters

  • Optionalencoding: "ascii" | "utf8" | "base64" | "base64url" | "hex"

  Returns Promise<string | Buffer<ArrayBufferLike>>

is_symlink

• is_symlink(): Promise<boolean>

  Returns Promise<boolean>

move_to_dir

• move_to_dir(newFolder: string): Promise<void>

  Move file to other folder

  Parameters

  • newFolder: string

    target folder for file

  Returns Promise<void>

overwrite_contents

• overwrite_contents(
      contents: string | ArrayBuffer | Buffer<ArrayBufferLike>,
  ): Promise<void>

  Parameters

  • contents: string | ArrayBuffer | Buffer<ArrayBufferLike>

  Returns Promise<void>

rename

• rename(filenameIn: string): Promise<void>

  Rename file

  Parameters

  • filenameIn: string

    target file name

  Returns Promise<void>

set_role

• set_role(min_role_read: number): Promise<void>

  Set Min Role to read for file

  Parameters

  • min_role_read: number

    target Role for file to read

  Returns Promise<void>

set_user

• set_user(user_id: number): Promise<void>

  Set user for file

  Parameters

  • user_id: number

    target user_id

  Returns Promise<void>

StaticabsPathToServePath

• absPathToServePath(absPath: string | number): string

  Parameters

  • absPath: string | number

  Returns string

StaticallDirectories

• allDirectories(ignoreCache?: boolean): Promise<File[]>

  get all directories in the root folder (tenant root dir for multi-tenant)

  Parameters

  • OptionalignoreCache: boolean

    if a cache exists, ignore it

  Returns Promise<File[]>

StaticbuildDirCache

• buildDirCache(): Promise<void>

  Returns Promise<void>

Staticcheck_sandbox

• check_sandbox(p: string): string

  If a sandbox directory is configured on this (sub)class (via File.subClass({ sandbox_dir })), ensure that the given absolute path lies inside the sandbox directory (or is the sandbox directory itself). This is used to confine untrusted code to a directory tree: any File method that touches the filesystem routes the path it is about to access through this guard. Throws if the path escapes the sandbox.

  Symlinks are resolved (on the longest existing prefix of the path) so that a symlink inside the sandbox cannot be used to read or write outside of it.

  When no sandbox_dir is set this is a no-op and returns the path unchanged.

  Parameters

  • p: string

    absolute filesystem path that is about to be accessed

  Returns string

  the resolved path

Staticcreate

• create(f: FileCfg): Promise<File>

  Create file

  Parameters

  • f: FileCfg

  Returns Promise<File>

StaticdestroyDirCache

• destroyDirCache(): void

  Returns void

Staticensure_file_store

• ensure_file_store(tenant_name?: string): Promise<void>

  Ensure that file_store path is physically exists in file system. In reality just recursively creates full absolute path to db.connectObj.file_store.

  Parameters

  • Optionaltenant_name: string

  Returns Promise<void>

StaticfieldValueFromRelative

• fieldValueFromRelative(relPath?: string): string

  Parameters

  • OptionalrelPath: string

  Returns string

Staticfind

• find(where?: Where, selectopts?: SelectOptions): Promise<File[]>

  Select list of file descriptors

  Parameters

  • Optionalwhere: Where
  • selectopts: SelectOptions = {}

  Returns Promise<File[]>

StaticfindOne

• findOne(where: string | Where): Promise<File | null>

  Select one file descriptor

  Parameters

  • where: string | Where

  Returns Promise<File | null>

Staticfrom_contents

• from_contents(
      name: string,
      mimetype: string,
      contents: string | ArrayBuffer | Buffer<ArrayBufferLike>,
      user_id: number,
      min_role_read?: number,
      folder?: string,
  ): Promise<File>

  Create new file

  Parameters

  • name: string
  • mimetype: string
  • contents: string | ArrayBuffer | Buffer<ArrayBufferLike>
  • user_id: number
  • min_role_read: number = 1
  • folder: string = "/"

  Returns Promise<File>

Staticfrom_file_on_disk

• from_file_on_disk(name: string, absoluteFolder: string): Promise<File>

  Parameters

  • name: string
  • absoluteFolder: string

  Returns Promise<File>

Staticfrom_req_files

• from_req_files(
      file: {
          mimetype: string;
          mv: Function;
          name: string;
          s3object?: boolean;
          size: number;
      },
      user_id: number | undefined,
      min_role_read?: number,
      folder?: string,
  ): Promise<File>

  Create new file

  Parameters

  • file: {
        mimetype: string;
        mv: Function;
        name: string;
        s3object?: boolean;
        size: number;
    }
  • user_id: number | undefined
  • min_role_read: number = 1
  • folder: string = "/"

  Returns Promise<File>

Staticget_new_path

• get_new_path(suggest?: string, renameIfExisting?: boolean): string

  Get absolute path to new file in db.connectObj.file_store.

  Parameters

  • Optionalsuggest: string

    path to file inside file store. If undefined that autogenerated uudv4 is used.

  • OptionalrenameIfExisting: boolean

  Returns string

  • path to file

StaticgetDirCache

• getDirCache(): File[] | "building" | null

  Returns File[] | "building" | null

StaticisAbsoluteURL

• isAbsoluteURL(value?: string): boolean

  Parameters

  • Optionalvalue: string

  Returns boolean

StaticnameToMimeType

• nameToMimeType(filepath: string): string | false

  Parameters

  • filepath: string

  Returns string | false

Staticnew_folder

• new_folder(name: string, inFolder?: string): Promise<void>

  Create new folder

  Parameters

  • name: string
  • inFolder: string = ""

  Returns Promise<void>

Staticnormalise

• normalise(fpath: string): string

  Parameters

  • fpath: string

  Returns string

Staticnormalise_in_base

• normalise_in_base(
      trusted_base: string,
      ...unsafe_paths: string[],
  ): string | null

  Parameters

  • trusted_base: string
  • ...unsafe_paths: string[]

  Returns string | null

StaticnormalizeFieldValueInput

• normalizeFieldValueInput(value?: string): string

  Parameters

  • Optionalvalue: string

  Returns string

StaticpathToServeUrl

• pathToServeUrl(
      value?: string,
      opts?: {
          download?: boolean;
          filename?: string;
          preferDirect?: boolean;
          targetPrefix?: string;
      },
  ): string

  Parameters

  • Optionalvalue: string
  • opts: {
        download?: boolean;
        filename?: string;
        preferDirect?: boolean;
        targetPrefix?: string;
    } = {}

  Returns string

StaticreallyBuildDirCache

• reallyBuildDirCache(): Promise<void>

  Returns Promise<void>

StaticrelativePathFromFieldValue

• relativePathFromFieldValue(value?: string): string | null

  Parameters

  • Optionalvalue: string

  Returns string | null

StaticrootFolder

• rootFolder(): Promise<File>

  Returns Promise<File>

Staticset_xattr_of_existing_file

• set_xattr_of_existing_file(
      name: string,
      absoluteFolder: string,
      user: User,
  ): Promise<void>

  Parameters

  • name: string
  • absoluteFolder: string
  • user: User

  Returns Promise<void>

StaticsubClass

• subClass(__namedParameters?: { sandbox_dir?: string; user?: User }): typeof File

  Parameters

  • __namedParameters: { sandbox_dir?: string; user?: User } = {}

  Returns typeof File

StaticsubClassIfTenant

• subClassIfTenant(): typeof File

  Returns typeof File

Staticupdate

• update(id: number, row: Row): Promise<void>

  Update File descriptor

  Parameters

  • id: number

    primary key

  • row: Row

    row data

  Returns Promise<void>

  no returns

Staticupdate_table_references

• update_table_references(from: string, to: string): Promise<void>

  Parameters

  • from: string
  • to: string

  Returns Promise<void>

Staticupload

• upload(file: { blob: Blob; fileObj: any }): Promise<any>

  This is a mobile-app function, it uploads a file to the saltcorn server.

  Parameters

  • file: { blob: Blob; fileObj: any }

    file to upload

  Returns Promise<any>

  JSON response from POST 'file/upload'