server/helpers/core-utils.ts

   1 /*
   2   Different from 'utils' because we don't not import other PeerTube modules.
   3   Useful to avoid circular dependencies.
   4 */
   5
   6 import { join } from 'path'
   7 import { pseudoRandomBytes } from 'crypto'
   8 import {
   9   readdir,
  10   readFile,
  11   rename,
  12   unlink,
  13   writeFile,
  14   access
  15 } from 'fs'
  16 import * as mkdirp from 'mkdirp'
  17 import * as bcrypt from 'bcrypt'
  18 import * as createTorrent from 'create-torrent'
  19 import * as rimraf from 'rimraf'
  20 import * as openssl from 'openssl-wrapper'
  21 import * as Promise from 'bluebird'
  22
  23 function isTestInstance () {
  24   return process.env.NODE_ENV === 'test'
  25 }
  26
  27 function root () {
  28   // We are in /dist/helpers/utils.js
  29   return join(__dirname, '..', '..', '..')
  30 }
  31
  32 function promisify0<A> (func: (cb: (err: any, result: A) => void) => void): () => Promise<A> {
  33   return function promisified (): Promise<A> {
  34     return new Promise<A>((resolve: (arg: A) => void, reject: (err: any) => void) => {
  35       func.apply(null, [ (err: any, res: A) => err ? reject(err) : resolve(res) ])
  36     })
  37   }
  38 }
  39
  40 // Thanks to https://gist.github.com/kumasento/617daa7e46f13ecdd9b2
  41 function promisify1<T, A> (func: (arg: T, cb: (err: any, result: A) => void) => void): (arg: T) => Promise<A> {
  42   return function promisified (arg: T): Promise<A> {
  43     return new Promise<A>((resolve: (arg: A) => void, reject: (err: any) => void) => {
  44       func.apply(null, [ arg, (err: any, res: A) => err ? reject(err) : resolve(res) ])
  45     })
  46   }
  47 }
  48
  49 function promisify1WithVoid<T> (func: (arg: T, cb: (err: any) => void) => void): (arg: T) => Promise<void> {
  50   return function promisified (arg: T): Promise<void> {
  51     return new Promise<void>((resolve: () => void, reject: (err: any) => void) => {
  52       func.apply(null, [ arg, (err: any) => err ? reject(err) : resolve() ])
  53     })
  54   }
  55 }
  56
  57 function promisify2<T, U, A> (func: (arg1: T, arg2: U, cb: (err: any, result: A) => void) => void): (arg1: T, arg2: U) => Promise<A> {
  58   return function promisified (arg1: T, arg2: U): Promise<A> {
  59     return new Promise<A>((resolve: (arg: A) => void, reject: (err: any) => void) => {
  60       func.apply(null, [ arg1, arg2, (err: any, res: A) => err ? reject(err) : resolve(res) ])
  61     })
  62   }
  63 }
  64
  65 function promisify2WithVoid<T, U> (func: (arg1: T, arg2: U, cb: (err: any) => void) => void): (arg1: T, arg2: U) => Promise<void> {
  66   return function promisified (arg1: T, arg2: U): Promise<void> {
  67     return new Promise<void>((resolve: () => void, reject: (err: any) => void) => {
  68       func.apply(null, [ arg1, arg2, (err: any) => err ? reject(err) : resolve() ])
  69     })
  70   }
  71 }
  72
  73 const readFilePromise = promisify2<string, string, string>(readFile)
  74 const readFileBufferPromise = promisify1<string, Buffer>(readFile)
  75 const unlinkPromise = promisify1WithVoid<string>(unlink)
  76 const renamePromise = promisify2WithVoid<string, string>(rename)
  77 const writeFilePromise = promisify2WithVoid<string, any>(writeFile)
  78 const readdirPromise = promisify1<string, string[]>(readdir)
  79 const mkdirpPromise = promisify1<string, string>(mkdirp)
  80 const pseudoRandomBytesPromise = promisify1<number, Buffer>(pseudoRandomBytes)
  81 const accessPromise = promisify1WithVoid<string|Buffer>(access)
  82 const opensslExecPromise = promisify2WithVoid<string, any>(openssl.exec)
  83 const bcryptComparePromise = promisify2<any, string, boolean>(bcrypt.compare)
  84 const bcryptGenSaltPromise = promisify1<number, string>(bcrypt.genSalt)
  85 const bcryptHashPromise = promisify2<any, string|number, string>(bcrypt.hash)
  86 const createTorrentPromise = promisify2<string, any, any>(createTorrent)
  87 const rimrafPromise = promisify1WithVoid<string>(rimraf)
  88
  89 // ---------------------------------------------------------------------------
  90
  91 export {
  92   isTestInstance,
  93   root,
  94
  95   promisify0,
  96   promisify1,
  97   readdirPromise,
  98   readFilePromise,
  99   readFileBufferPromise,
 100   unlinkPromise,
 101   renamePromise,
 102   writeFilePromise,
 103   mkdirpPromise,
 104   pseudoRandomBytesPromise,
 105   accessPromise,
 106   opensslExecPromise,
 107   bcryptComparePromise,
 108   bcryptGenSaltPromise,
 109   bcryptHashPromise,
 110   createTorrentPromise,
 111   rimrafPromise
 112 }