pockethost/src/services/FtpService/index.ts

import {
  MOTHERSHIP_INTERNAL_URL,
  PH_FTP_PASV_IP,
  PH_FTP_PASV_PORT_MAX,
  PH_FTP_PASV_PORT_MIN,
  PH_FTP_PORT,
  SSL_CERT,
  SSL_KEY,
} from '$constants'
import { LoggerService, mkSingleton } from '$shared'
import { exitHook, mergeConfig } from '$util'
import { readFileSync } from 'fs'
import { FtpSrv } from 'ftp-srv'
import pocketbaseEs from 'pocketbase'
import { PhFs } from './PhFs'

export type FtpConfig = { mothershipUrl: string }

export enum FolderNames {
  PbData = 'pb_data',
  PbPublic = 'pb_public',
  PbMigrations = 'pb_migrations',
  PbHooks = 'pb_hooks',
}

export const MAINTENANCE_ONLY_FOLDER_NAMES: FolderNames[] = [FolderNames.PbData]

export const INSTANCE_ROOT_FOLDER_NAMES: FolderNames[] = [
  FolderNames.PbData,
  FolderNames.PbPublic,
  FolderNames.PbMigrations,
  FolderNames.PbHooks,
]

export function isInstanceRootFolder(name: string): name is FolderNames {
  return INSTANCE_ROOT_FOLDER_NAMES.includes(name as FolderNames)
}

export const ftpService = mkSingleton((config: Partial<FtpConfig> = {}) => {
  const { mothershipUrl } = mergeConfig(
    {
      mothershipUrl: MOTHERSHIP_INTERNAL_URL(),
    },
    config,
  )
  const tls = {
    key: readFileSync(SSL_KEY()),
    cert: readFileSync(SSL_CERT()),
  }
  const _ftpServiceLogger = LoggerService().create('FtpService')
  const { dbg, info } = _ftpServiceLogger

  const ftpServer = new FtpSrv({
    url: 'ftp://0.0.0.0:' + PH_FTP_PORT(),
    anonymous: false,
    log: _ftpServiceLogger.create(`ftpServer`),
    tls,
    pasv_url: PH_FTP_PASV_IP(),
    pasv_max: PH_FTP_PASV_PORT_MAX(),
    pasv_min: PH_FTP_PASV_PORT_MIN(),
  })

  ftpServer.on(
    'login',
    async ({ connection, username, password }, resolve, reject) => {
      dbg(`Got a connection`)
      dbg(`Finding ${mothershipUrl}`)
      const client = new pocketbaseEs(mothershipUrl)
      try {
        await client.collection('users').authWithPassword(username, password)
        dbg(`Logged in`)
        const fs = new PhFs(connection, client, _ftpServiceLogger)
        resolve({ fs })
      } catch (e) {
        reject(new Error(`Invalid username or password`))
        return
      }
    },
  )

  ftpServer.listen().then(() => {
    dbg('Ftp server started...')
  })

  exitHook(() => {
    dbg(`Closing FTP server`)
    ftpServer.close()
  })

  return {}
})