+/* 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 * as bcrypt from 'bcrypt'
-import * as createTorrent from 'create-torrent'
-import { pseudoRandomBytes } from 'crypto'
-import { readdir, readFile, rename, stat, Stats, unlink, writeFile } from 'fs'
-import * as mkdirp from 'mkdirp'
-import { join } from 'path'
+import { exec, ExecOptions } from 'child_process'
+import { BinaryToTextEncoding, createHash, randomBytes } from 'crypto'
+import { truncate } from 'lodash'
+import { basename, isAbsolute, join, resolve } from 'path'
import * as pem from 'pem'
-import * as rimraf from 'rimraf'
+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
+}
+
+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 join.apply(null, paths)
+ return rootPath
}
// Thanks: https://stackoverflow.com/a/12034334
function escapeHTML (stringParam) {
+ if (!stringParam) return ''
+
const entityMap = {
'&': '&',
'<': '<',
'>': '>',
'"': '"',
- "'": ''',
+ '\'': ''',
'/': '/',
'`': '`',
'=': '='
}
- return String(stringParam).replace(/[&<>"'`=\/]/g, s => entityMap[s])
+ return String(stringParam).replace(/[&<>"'`=/]/g, s => entityMap[s])
}
function pageToStartAndCount (page: number, itemsPerPage: number) {
return { start, count: itemsPerPage }
}
+function mapToJSON (map: Map<any, any>) {
+ const obj: any = {}
+
+ for (const [ k, v ] of map) {
+ obj[k] = v
+ }
+
+ return obj
+}
+
+function buildPath (path: string) {
+ if (isAbsolute(path)) return path
+
+ return join(root(), path)
+}
+
+// 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 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 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) => {
}
}
-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) => {
}
}
-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() ])
- })
- }
+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
}
-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 randomBytesPromise = promisify1<number, Buffer>(randomBytes)
const createPrivateKey = promisify1<number, { key: string }>(pem.createPrivateKey)
const getPublicKey = promisify1<string, { publicKey: string }>(pem.getPublicKey)
-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 statPromise = promisify1<string, Stats>(stat)
+const execPromise2 = promisify2<string, any, string>(exec)
+const execPromise = promisify1<string, string>(exec)
+const pipelinePromise = promisify(pipeline)
// ---------------------------------------------------------------------------
export {
isTestInstance,
+ isProdInstance,
+ getAppNumber,
+
+ objectConverter,
root,
escapeHTML,
pageToStartAndCount,
+ sanitizeUrl,
+ sanitizeHost,
+ buildPath,
+ execShell,
+ peertubeTruncate,
+
+ sha256,
+ sha1,
+ mapToJSON,
promisify0,
promisify1,
+ promisify2,
- readdirPromise,
- readFileBufferPromise,
- unlinkPromise,
- renamePromise,
- writeFilePromise,
- mkdirpPromise,
- pseudoRandomBytesPromise,
+ randomBytesPromise,
createPrivateKey,
getPublicKey,
- bcryptComparePromise,
- bcryptGenSaltPromise,
- bcryptHashPromise,
- createTorrentPromise,
- rimrafPromise,
- statPromise
+ execPromise2,
+ execPromise,
+ pipelinePromise,
+
+ parseSemVersion
}