server/helpers/utils.ts

   1 import { ResultList } from '../../shared'
   2 import { execPromise, execPromise2, randomBytesPromise, sha256 } from './core-utils'
   3 import { logger } from './logger'
   4 import { join } from 'path'
   5 import { Instance as ParseTorrent } from 'parse-torrent'
   6 import { remove } from 'fs-extra'
   7 import { CONFIG } from '../initializers/config'
   8 import { isVideoFileExtnameValid } from './custom-validators/videos'
   9
  10 function deleteFileAsync (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, extensionArg?: string) {
  35   const id = typeof target === 'string'
  36     ? target
  37     : target.infoHash
  38
  39   let extension = '.mp4'
  40   if (extensionArg && isVideoFileExtnameValid(extensionArg)) {
  41     extension = extensionArg
  42   }
  43
  44   const hash = sha256(id)
  45   return join(CONFIG.STORAGE.TMP_DIR, `${hash}-import${extension}`)
  46 }
  47
  48 function getSecureTorrentName (originalName: string) {
  49   return sha256(originalName) + '.torrent'
  50 }
  51
  52 async function getServerCommit () {
  53   try {
  54     const tag = await execPromise2(
  55       '[ ! -d .git ] || git name-rev --name-only --tags --no-undefined HEAD 2>/dev/null || true',
  56       { stdio: [ 0, 1, 2 ] }
  57     )
  58
  59     if (tag) return tag.replace(/^v/, '')
  60   } catch (err) {
  61     logger.debug('Cannot get version from git tags.', { err })
  62   }
  63
  64   try {
  65     const version = await execPromise('[ ! -d .git ] || git rev-parse --short HEAD')
  66
  67     if (version) return version.toString().trim()
  68   } catch (err) {
  69     logger.debug('Cannot get version from git HEAD.', { err })
  70   }
  71
  72   return ''
  73 }
  74
  75 /**
  76  * From a filename like "ede4cba5-742b-46fa-a388-9a6eb3a3aeb3.mp4", returns
  77  * only the "ede4cba5-742b-46fa-a388-9a6eb3a3aeb3" part. If the filename does
  78  * not contain a UUID, returns null.
  79  */
  80 function getUUIDFromFilename (filename: string) {
  81   const regex = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
  82   const result = filename.match(regex)
  83
  84   if (!result || Array.isArray(result) === false) return null
  85
  86   return result[0]
  87 }
  88
  89 // ---------------------------------------------------------------------------
  90
  91 export {
  92   deleteFileAsync,
  93   generateRandomString,
  94   getFormattedObjects,
  95   getSecureTorrentName,
  96   getServerCommit,
  97   generateVideoImportTmpPath,
  98   getUUIDFromFilename
  99 }