server/helpers/utils.ts

   1 import { remove } from 'fs-extra'
   2 import { Instance as ParseTorrent } from 'parse-torrent'
   3 import { join } from 'path'
   4 import { ResultList } from '../../shared'
   5 import { CONFIG } from '../initializers/config'
   6 import { execPromise, execPromise2, randomBytesPromise, sha256 } from './core-utils'
   7 import { logger } from './logger'
   8
   9 function deleteFileAndCatch (path: string) {
  10   remove(path)
  11     .catch(err => logger.error('Cannot delete the file %s asynchronously.', path, { err }))
  12 }
  13
  14 async function generateRandomString (size: number) {
  15   const raw = await randomBytesPromise(size)
  16
  17   return raw.toString('hex')
  18 }
  19
  20 interface FormattableToJSON<U, V> {
  21   toFormattedJSON (args?: U): V
  22 }
  23
  24 function getFormattedObjects<U, V, T extends FormattableToJSON<U, V>> (objects: T[], objectsTotal: number, formattedArg?: U) {
  25   const formattedObjects = objects.map(o => o.toFormattedJSON(formattedArg))
  26
  27   return {
  28     total: objectsTotal,
  29     data: formattedObjects
  30   } as ResultList<V>
  31 }
  32
  33 function generateVideoImportTmpPath (target: string | ParseTorrent, extension = '.mp4') {
  34   const id = typeof target === 'string'
  35     ? target
  36     : target.infoHash
  37
  38   const hash = sha256(id)
  39   return join(CONFIG.STORAGE.TMP_DIR, `${hash}-import${extension}`)
  40 }
  41
  42 function getSecureTorrentName (originalName: string) {
  43   return sha256(originalName) + '.torrent'
  44 }
  45
  46 async function getServerCommit () {
  47   try {
  48     const tag = await execPromise2(
  49       '[ ! -d .git ] || git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null || true',
  50       { stdio: [ 0, 1, 2 ] }
  51     )
  52
  53     if (tag) return tag.replace(/^v/, '')
  54   } catch (err) {
  55     logger.debug('Cannot get version from git tags.', { err })
  56   }
  57
  58   try {
  59     const version = await execPromise('[ ! -d .git ] || git rev-parse --short HEAD')
  60
  61     if (version) return version.toString().trim()
  62   } catch (err) {
  63     logger.debug('Cannot get version from git HEAD.', { err })
  64   }
  65
  66   return ''
  67 }
  68
  69 /**
  70  * From a filename like "ede4cba5-742b-46fa-a388-9a6eb3a3aeb3.mp4", returns
  71  * only the "ede4cba5-742b-46fa-a388-9a6eb3a3aeb3" part. If the filename does
  72  * not contain a UUID, returns null.
  73  */
  74 function getUUIDFromFilename (filename: string) {
  75   const regex = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
  76   const result = filename.match(regex)
  77
  78   if (!result || Array.isArray(result) === false) return null
  79
  80   return result[0]
  81 }
  82
  83 // ---------------------------------------------------------------------------
  84
  85 export {
  86   deleteFileAndCatch,
  87   generateRandomString,
  88   getFormattedObjects,
  89   getSecureTorrentName,
  90   getServerCommit,
  91   generateVideoImportTmpPath,
  92   getUUIDFromFilename
  93 }