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