*/
import { exec, ExecOptions } from 'child_process'
-import { BinaryToTextEncoding, createHash, randomBytes } from 'crypto'
+import { ED25519KeyPairOptions, generateKeyPair, randomBytes, RSAKeyPairOptions } from 'crypto'
import { truncate } from 'lodash'
-import { basename, 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 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,
export function parseDurationToMs (duration: number | string): number {
if (duration === null) return null
if (typeof duration === 'number') return duration
+ if (!isNaN(+duration)) return +duration
if (typeof duration === 'string') {
const split = duration.match(/^([\d.,]+)\s?(\w+)$/)
export function parseBytes (value: string | number): number {
if (typeof value === 'number') return value
+ if (!isNaN(+value)) 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 g = /^(\d+)\s*GB$/
const m = /^(\d+)\s*MB$/
const b = /^(\d+)\s*B$/
- let match
+
+ let match: RegExpMatchArray
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)) {
+ }
+
+ 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)) {
+ }
+
+ 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)) {
+ }
+
+ 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)) {
+ }
+
+ if (value.match(t)) {
match = value.match(t)
return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024
- } else if (value.match(g)) {
+ }
+
+ if (value.match(g)) {
match = value.match(g)
return parseInt(match[1], 10) * 1024 * 1024 * 1024
- } else if (value.match(m)) {
+ }
+
+ if (value.match(m)) {
match = value.match(m)
return parseInt(match[1], 10) * 1024 * 1024
- } else if (value.match(b)) {
+ }
+
+ if (value.match(b)) {
match = value.match(b)
return parseInt(match[1], 10) * 1024
- } else {
- return parseInt(value, 10)
}
+
+ return parseInt(value, 10)
}
+// ---------------------------------------------------------------------------
+
function sanitizeUrl (url: string) {
const urlObject = new URL(url)
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
- rootPath = join(__dirname, '..', '..')
-
- if (basename(rootPath) === 'dist') rootPath = resolve(rootPath, '..')
-
- return rootPath
+function isDevInstance () {
+ return process.env.NODE_ENV === 'dev'
}
-// Thanks: https://stackoverflow.com/a/12034334
-function escapeHTML (stringParam) {
- if (!stringParam) return ''
-
- const entityMap = {
- '&': '&',
- '<': '<',
- '>': '>',
- '"': '"',
- '\'': ''',
- '/': '/',
- '`': '`',
- '=': '='
- }
-
- return String(stringParam).replace(/[&<>"'`=/]/g, s => entityMap[s])
+function isTestOrDevInstance () {
+ return isTestInstance() || isDevInstance()
}
-function pageToStartAndCount (page: number, itemsPerPage: number) {
- const start = (page - 1) * itemsPerPage
-
- return { start, count: itemsPerPage }
+function isProdInstance () {
+ return process.env.NODE_ENV === 'production'
}
-function mapToJSON (map: Map<any, any>) {
- const obj: any = {}
-
- for (const [ k, v ] of map) {
- obj[k] = v
- }
-
- return obj
+function getAppNumber () {
+ return process.env.NODE_APP_INSTANCE || ''
}
-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 }) {
return truncate(str, options)
}
-function sha256 (str: string | Buffer, encoding: BinaryToTextEncoding = 'hex') {
- return createHash('sha256').update(str).digest(encoding)
+function pageToStartAndCount (page: number, itemsPerPage: number) {
+ const start = (page - 1) * itemsPerPage
+
+ return { start, count: itemsPerPage }
}
-function sha1 (str: string | Buffer, encoding: BinaryToTextEncoding = 'hex') {
- return createHash('sha1').update(str).digest(encoding)
+// ---------------------------------------------------------------------------
+
+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 execShell (command: string, options?: ExecOptions) {
return new Promise<{ err?: Error, stdout: string, stderr: string }>((res, rej) => {
exec(command, options, (err, stdout, stderr) => {
})
}
+// ---------------------------------------------------------------------------
+
+function isOdd (num: number) {
+ return (num % 2) !== 0
+}
+
+function toEven (num: number) {
+ if (isOdd(num)) return num + 1
+
+ return num
+}
+
+// ---------------------------------------------------------------------------
+
+function generateRSAKeyPairPromise (size: number) {
+ return new Promise<{ publicKey: string, privateKey: string }>((res, rej) => {
+ const options: RSAKeyPairOptions<'pem', 'pem'> = {
+ modulusLength: size,
+ publicKeyEncoding: {
+ type: 'spki',
+ format: 'pem'
+ },
+ privateKeyEncoding: {
+ type: 'pkcs1',
+ format: 'pem'
+ }
+ }
+
+ generateKeyPair('rsa', options, (err, publicKey, privateKey) => {
+ if (err) return rej(err)
+
+ return res({ publicKey, privateKey })
+ })
+ })
+}
+
+function generateED25519KeyPairPromise () {
+ return new Promise<{ publicKey: string, privateKey: string }>((res, rej) => {
+ const options: ED25519KeyPairOptions<'pem', 'pem'> = {
+ publicKeyEncoding: {
+ type: 'spki',
+ format: 'pem'
+ },
+ privateKeyEncoding: {
+ type: 'pkcs8',
+ format: 'pem'
+ }
+ }
+
+ generateKeyPair('ed25519', options, (err, publicKey, privateKey) => {
+ if (err) return rej(err)
+
+ return res({ publicKey, privateKey })
+ })
+ })
+}
+
+// ---------------------------------------------------------------------------
+
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) => {
}
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,
+ isTestOrDevInstance,
isProdInstance,
getAppNumber,
objectConverter,
- root,
- escapeHTML,
- pageToStartAndCount,
+ mapToJSON,
+
sanitizeUrl,
sanitizeHost,
- buildPath,
+
execShell,
- peertubeTruncate,
- sha256,
- sha1,
- mapToJSON,
+ pageToStartAndCount,
+ peertubeTruncate,
promisify0,
promisify1,
promisify2,
randomBytesPromise,
- createPrivateKey,
- getPublicKey,
+
+ generateRSAKeyPairPromise,
+ generateED25519KeyPairPromise,
+
execPromise2,
- execPromise
+ execPromise,
+ pipelinePromise,
+
+ parseSemVersion,
+
+ isOdd,
+ toEven
}