X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fcore-utils.ts;h=9abc532d28741f94c9dec872de8734a32b0f1f41;hb=0bae66632a8767f3d5aca080af314bcab56e1889;hp=2ec7e6515fc82982e573d29e08438436b709e7e1;hpb=fdbda9e3d6564ec908733c7019305f6a3c363a9f;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/server/helpers/core-utils.ts b/server/helpers/core-utils.ts
index 2ec7e6515..9abc532d2 100644
--- a/server/helpers/core-utils.ts
+++ b/server/helpers/core-utils.ts
@@ -1,41 +1,260 @@
+/* eslint-disable no-useless-call */
+
 /*
-  Different from 'utils' because we don't not import other PeerTube modules.
+  Different from 'utils' because we don't import other PeerTube modules.
   Useful to avoid circular dependencies.
 */
 
-import { join } from 'path'
-import { pseudoRandomBytes } from 'crypto'
-import {
-  readdir,
-  readFile,
-  rename,
-  unlink,
-  writeFile,
-  access
-} from 'fs'
-import * as mkdirp from 'mkdirp'
-import * as bcrypt from 'bcrypt'
-import * as createTorrent from 'create-torrent'
-import * as rimraf from 'rimraf'
-import * as openssl from 'openssl-wrapper'
-import * as Promise from 'bluebird'
+import { exec, ExecOptions } from 'child_process'
+import { BinaryToTextEncoding, createHash, randomBytes } from 'crypto'
+import { truncate } from 'lodash'
+import { basename, extname, isAbsolute, join, resolve } from 'path'
+import * as pem from 'pem'
+import { pipeline } from 'stream'
+import { URL } from 'url'
+import { promisify } from 'util'
+
+const objectConverter = (oldObject: any, keyConverter: (e: string) => string, valueConverter: (e: any) => any) => {
+  if (!oldObject || typeof oldObject !== 'object') {
+    return valueConverter(oldObject)
+  }
+
+  if (Array.isArray(oldObject)) {
+    return oldObject.map(e => objectConverter(e, keyConverter, valueConverter))
+  }
+
+  const newObject = {}
+  Object.keys(oldObject).forEach(oldKey => {
+    const newKey = keyConverter(oldKey)
+    newObject[newKey] = objectConverter(oldObject[oldKey], keyConverter, valueConverter)
+  })
+
+  return newObject
+}
+
+function mapToJSON (map: Map<any, any>) {
+  const obj: any = {}
+
+  for (const [ k, v ] of map) {
+    obj[k] = v
+  }
+
+  return obj
+}
+
+// ---------------------------------------------------------------------------
+
+const timeTable = {
+  ms: 1,
+  second: 1000,
+  minute: 60000,
+  hour: 3600000,
+  day: 3600000 * 24,
+  week: 3600000 * 24 * 7,
+  month: 3600000 * 24 * 30
+}
+
+export function parseDurationToMs (duration: number | string): number {
+  if (duration === null) return null
+  if (typeof duration === 'number') return duration
+
+  if (typeof duration === 'string') {
+    const split = duration.match(/^([\d.,]+)\s?(\w+)$/)
+
+    if (split.length === 3) {
+      const len = parseFloat(split[1])
+      let unit = split[2].replace(/s$/i, '').toLowerCase()
+      if (unit === 'm') {
+        unit = 'ms'
+      }
+
+      return (len || 1) * (timeTable[unit] || 0)
+    }
+  }
+
+  throw new Error(`Duration ${duration} could not be properly parsed`)
+}
+
+export function parseBytes (value: string | number): number {
+  if (typeof value === 'number') return value
+
+  const tgm = /^(\d+)\s*TB\s*(\d+)\s*GB\s*(\d+)\s*MB$/
+  const tg = /^(\d+)\s*TB\s*(\d+)\s*GB$/
+  const tm = /^(\d+)\s*TB\s*(\d+)\s*MB$/
+  const gm = /^(\d+)\s*GB\s*(\d+)\s*MB$/
+  const t = /^(\d+)\s*TB$/
+  const g = /^(\d+)\s*GB$/
+  const m = /^(\d+)\s*MB$/
+  const b = /^(\d+)\s*B$/
+  let match
+
+  if (value.match(tgm)) {
+    match = value.match(tgm)
+    return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024 +
+      parseInt(match[2], 10) * 1024 * 1024 * 1024 +
+      parseInt(match[3], 10) * 1024 * 1024
+  } else if (value.match(tg)) {
+    match = value.match(tg)
+    return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024 +
+      parseInt(match[2], 10) * 1024 * 1024 * 1024
+  } else if (value.match(tm)) {
+    match = value.match(tm)
+    return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024 +
+      parseInt(match[2], 10) * 1024 * 1024
+  } else if (value.match(gm)) {
+    match = value.match(gm)
+    return parseInt(match[1], 10) * 1024 * 1024 * 1024 +
+      parseInt(match[2], 10) * 1024 * 1024
+  } else if (value.match(t)) {
+    match = value.match(t)
+    return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024
+  } else if (value.match(g)) {
+    match = value.match(g)
+    return parseInt(match[1], 10) * 1024 * 1024 * 1024
+  } else if (value.match(m)) {
+    match = value.match(m)
+    return parseInt(match[1], 10) * 1024 * 1024
+  } else if (value.match(b)) {
+    match = value.match(b)
+    return parseInt(match[1], 10) * 1024
+  } else {
+    return parseInt(value, 10)
+  }
+}
+
+// ---------------------------------------------------------------------------
+
+function sanitizeUrl (url: string) {
+  const urlObject = new URL(url)
+
+  if (urlObject.protocol === 'https:' && urlObject.port === '443') {
+    urlObject.port = ''
+  } else if (urlObject.protocol === 'http:' && urlObject.port === '80') {
+    urlObject.port = ''
+  }
+
+  return urlObject.href.replace(/\/$/, '')
+}
+
+// Don't import remote scheme from constants because we are in core utils
+function sanitizeHost (host: string, remoteScheme: string) {
+  const toRemove = remoteScheme === 'https' ? 443 : 80
+
+  return host.replace(new RegExp(`:${toRemove}$`), '')
+}
+
+// ---------------------------------------------------------------------------
 
 function isTestInstance () {
   return process.env.NODE_ENV === 'test'
 }
 
+function isProdInstance () {
+  return process.env.NODE_ENV === 'production'
+}
+
+function getAppNumber () {
+  return process.env.NODE_APP_INSTANCE
+}
+
+// ---------------------------------------------------------------------------
+
+let rootPath: string
+
 function root () {
+  if (rootPath) return rootPath
+
   // We are in /helpers/utils.js
-  const paths = [ __dirname, '..', '..' ]
+  rootPath = join(__dirname, '..', '..')
 
-  // We are under /dist directory
-  if (process.mainModule.filename.endsWith('.ts') === false) {
-    paths.push('..')
-  }
+  if (basename(rootPath) === 'dist') rootPath = resolve(rootPath, '..')
+
+  return rootPath
+}
+
+function buildPath (path: string) {
+  if (isAbsolute(path)) return path
 
-  return join.apply(null, paths)
+  return join(root(), path)
 }
 
+function getLowercaseExtension (filename: string) {
+  const ext = extname(filename) || ''
+
+  return ext.toLowerCase()
+}
+
+// ---------------------------------------------------------------------------
+
+// Consistent with .length, lodash truncate function is not
+function peertubeTruncate (str: string, options: { length: number, separator?: RegExp, omission?: string }) {
+  const truncatedStr = truncate(str, options)
+
+  // The truncated string is okay, we can return it
+  if (truncatedStr.length <= options.length) return truncatedStr
+
+  // Lodash takes into account all UTF characters, whereas String.prototype.length does not: some characters have a length of 2
+  // We always use the .length so we need to truncate more if needed
+  options.length -= truncatedStr.length - options.length
+  return truncate(str, options)
+}
+
+function pageToStartAndCount (page: number, itemsPerPage: number) {
+  const start = (page - 1) * itemsPerPage
+
+  return { start, count: itemsPerPage }
+}
+
+// ---------------------------------------------------------------------------
+
+type SemVersion = { major: number, minor: number, patch: number }
+function parseSemVersion (s: string) {
+  const parsed = s.match(/^v?(\d+)\.(\d+)\.(\d+)$/i)
+
+  return {
+    major: parseInt(parsed[1]),
+    minor: parseInt(parsed[2]),
+    patch: parseInt(parsed[3])
+  } as SemVersion
+}
+
+// ---------------------------------------------------------------------------
+
+function sha256 (str: string | Buffer, encoding: BinaryToTextEncoding = 'hex') {
+  return createHash('sha256').update(str).digest(encoding)
+}
+
+function sha1 (str: string | Buffer, encoding: BinaryToTextEncoding = 'hex') {
+  return createHash('sha1').update(str).digest(encoding)
+}
+
+// ---------------------------------------------------------------------------
+
+function execShell (command: string, options?: ExecOptions) {
+  return new Promise<{ err?: Error, stdout: string, stderr: string }>((res, rej) => {
+    exec(command, options, (err, stdout, stderr) => {
+      // eslint-disable-next-line prefer-promise-reject-errors
+      if (err) return rej({ err, stdout, stderr })
+
+      return res({ stdout, stderr })
+    })
+  })
+}
+
+// ---------------------------------------------------------------------------
+
+function isOdd (num: number) {
+  return (num % 2) !== 0
+}
+
+function toEven (num: number) {
+  if (isOdd(num)) return num + 1
+
+  return num
+}
+
+// ---------------------------------------------------------------------------
+
 function promisify0<A> (func: (cb: (err: any, result: A) => void) => void): () => Promise<A> {
   return function promisified (): Promise<A> {
     return new Promise<A>((resolve: (arg: A) => void, reject: (err: any) => void) => {
@@ -53,14 +272,6 @@ function promisify1<T, A> (func: (arg: T, cb: (err: any, result: A) => void) =>
   }
 }
 
-function promisify1WithVoid<T> (func: (arg: T, cb: (err: any) => void) => void): (arg: T) => Promise<void> {
-  return function promisified (arg: T): Promise<void> {
-    return new Promise<void>((resolve: () => void, reject: (err: any) => void) => {
-      func.apply(null, [ arg, (err: any) => err ? reject(err) : resolve() ])
-    })
-  }
-}
-
 function promisify2<T, U, A> (func: (arg1: T, arg2: U, cb: (err: any, result: A) => void) => void): (arg1: T, arg2: U) => Promise<A> {
   return function promisified (arg1: T, arg2: U): Promise<A> {
     return new Promise<A>((resolve: (arg: A) => void, reject: (err: any) => void) => {
@@ -69,51 +280,50 @@ function promisify2<T, U, A> (func: (arg1: T, arg2: U, cb: (err: any, result: A)
   }
 }
 
-function promisify2WithVoid<T, U> (func: (arg1: T, arg2: U, cb: (err: any) => void) => void): (arg1: T, arg2: U) => Promise<void> {
-  return function promisified (arg1: T, arg2: U): Promise<void> {
-    return new Promise<void>((resolve: () => void, reject: (err: any) => void) => {
-      func.apply(null, [ arg1, arg2, (err: any) => err ? reject(err) : resolve() ])
-    })
-  }
-}
-
-const readFilePromise = promisify2<string, string, string>(readFile)
-const readFileBufferPromise = promisify1<string, Buffer>(readFile)
-const unlinkPromise = promisify1WithVoid<string>(unlink)
-const renamePromise = promisify2WithVoid<string, string>(rename)
-const writeFilePromise = promisify2WithVoid<string, any>(writeFile)
-const readdirPromise = promisify1<string, string[]>(readdir)
-const mkdirpPromise = promisify1<string, string>(mkdirp)
-const pseudoRandomBytesPromise = promisify1<number, Buffer>(pseudoRandomBytes)
-const accessPromise = promisify1WithVoid<string|Buffer>(access)
-const opensslExecPromise = promisify2WithVoid<string, any>(openssl.exec)
-const bcryptComparePromise = promisify2<any, string, boolean>(bcrypt.compare)
-const bcryptGenSaltPromise = promisify1<number, string>(bcrypt.genSalt)
-const bcryptHashPromise = promisify2<any, string|number, string>(bcrypt.hash)
-const createTorrentPromise = promisify2<string, any, any>(createTorrent)
-const rimrafPromise = promisify1WithVoid<string>(rimraf)
+const randomBytesPromise = promisify1<number, Buffer>(randomBytes)
+const createPrivateKey = promisify1<number, { key: string }>(pem.createPrivateKey)
+const getPublicKey = promisify1<string, { publicKey: string }>(pem.getPublicKey)
+const execPromise2 = promisify2<string, any, string>(exec)
+const execPromise = promisify1<string, string>(exec)
+const pipelinePromise = promisify(pipeline)
 
 // ---------------------------------------------------------------------------
 
 export {
   isTestInstance,
+  isProdInstance,
+  getAppNumber,
+
+  objectConverter,
+  mapToJSON,
+
   root,
+  buildPath,
+  getLowercaseExtension,
+  sanitizeUrl,
+  sanitizeHost,
+
+  execShell,
+
+  pageToStartAndCount,
+  peertubeTruncate,
+
+  sha256,
+  sha1,
 
   promisify0,
   promisify1,
-  readdirPromise,
-  readFilePromise,
-  readFileBufferPromise,
-  unlinkPromise,
-  renamePromise,
-  writeFilePromise,
-  mkdirpPromise,
-  pseudoRandomBytesPromise,
-  accessPromise,
-  opensslExecPromise,
-  bcryptComparePromise,
-  bcryptGenSaltPromise,
-  bcryptHashPromise,
-  createTorrentPromise,
-  rimrafPromise
+  promisify2,
+
+  randomBytesPromise,
+  createPrivateKey,
+  getPublicKey,
+  execPromise2,
+  execPromise,
+  pipelinePromise,
+
+  parseSemVersion,
+
+  isOdd,
+  toEven
 }