+/* 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 { createHash, HexBase64Latin1Encoding, pseudoRandomBytes } from 'crypto'
-import { isAbsolute, join } from 'path'
-import * as pem from 'pem'
-import { URL } from 'url'
+import { exec, ExecOptions } from 'child_process'
+import { ED25519KeyPairOptions, generateKeyPair, randomBytes, RSAKeyPairOptions, scrypt } from 'crypto'
import { truncate } from 'lodash'
-import { exec } from 'child_process'
-import { isArray } from './custom-validators/misc'
+import { pipeline } from 'stream'
+import { URL } from 'url'
+import { promisify } from 'util'
+import { promisify1, promisify2, promisify3 } from '@shared/core-utils'
const objectConverter = (oldObject: any, keyConverter: (e: string) => string, valueConverter: (e: any) => any) => {
if (!oldObject || typeof oldObject !== 'object') {
return valueConverter(oldObject)
}
- if (isArray(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)
+ 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
+ ms: 1,
+ second: 1000,
+ minute: 60000,
+ hour: 3600000,
+ day: 3600000 * 24,
+ week: 3600000 * 24 * 7,
+ month: 3600000 * 24 * 30
}
-export function parseDuration (duration: number | string): number {
+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+)$/)
+ const split = duration.match(/^([\d.,]+)\s?(\w+)$/)
if (split.length === 3) {
const len = parseFloat(split[1])
- let unit = split[2].replace(/s$/i,'').toLowerCase()
+ let unit = split[2].replace(/s$/i, '').toLowerCase()
if (unit === 'm') {
unit = 'ms'
}
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)) {
+ return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024 +
+ parseInt(match[2], 10) * 1024 * 1024 * 1024 +
+ parseInt(match[3], 10) * 1024 * 1024
+ }
+
+ 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)) {
+ return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024 +
+ parseInt(match[2], 10) * 1024 * 1024 * 1024
+ }
+
+ 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)) {
+ return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024 +
+ parseInt(match[2], 10) * 1024 * 1024
+ }
+
+ 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)) {
+ return parseInt(match[1], 10) * 1024 * 1024 * 1024 +
+ parseInt(match[2], 10) * 1024 * 1024
+ }
+
+ 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 isDevInstance () {
+ return process.env.NODE_ENV === 'dev'
}
-function root () {
- // We are in /helpers/utils.js
- const paths = [ __dirname, '..', '..' ]
-
- // We are under /dist directory
- if (process.mainModule && process.mainModule.filename.endsWith('.ts') === false) {
- paths.push('..')
- }
-
- return join.apply(null, paths)
+function isTestOrDevInstance () {
+ return isTestInstance() || isDevInstance()
}
-// Thanks: https://stackoverflow.com/a/12034334
-function escapeHTML (stringParam) {
- if (!stringParam) return ''
-
- const entityMap = {
- '&': '&',
- '<': '<',
- '>': '>',
- '"': '"',
- '\'': ''',
- '/': '/',
- '`': '`',
- '=': '='
- }
-
- return String(stringParam).replace(/[&<>"'`=\/]/g, s => entityMap[s])
+function isProdInstance () {
+ return process.env.NODE_ENV === 'production'
}
-function pageToStartAndCount (page: number, itemsPerPage: number) {
- const start = (page - 1) * itemsPerPage
-
- return { start, count: itemsPerPage }
+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, maxLength: number) {
- const options = {
- length: maxLength
- }
+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 <= maxLength) return truncatedStr
+ 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 - maxLength
+ options.length -= truncatedStr.length - options.length
return truncate(str, options)
}
-function sha256 (str: string | Buffer, encoding: HexBase64Latin1Encoding = 'hex') {
- return createHash('sha256').update(str).digest(encoding)
-}
+function pageToStartAndCount (page: number, itemsPerPage: number) {
+ const start = (page - 1) * itemsPerPage
-function sha1 (str: string | Buffer, encoding: HexBase64Latin1Encoding = 'hex') {
- return createHash('sha1').update(str).digest(encoding)
+ return { start, count: itemsPerPage }
}
-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) => {
- func.apply(null, [ (err: any, res: A) => err ? reject(err) : resolve(res) ])
- })
- }
-}
+// ---------------------------------------------------------------------------
-// Thanks to https://gist.github.com/kumasento/617daa7e46f13ecdd9b2
-function promisify1<T, A> (func: (arg: T, cb: (err: any, result: A) => void) => void): (arg: T) => Promise<A> {
- return function promisified (arg: T): Promise<A> {
- return new Promise<A>((resolve: (arg: A) => void, reject: (err: any) => void) => {
- func.apply(null, [ arg, (err: any, res: A) => err ? reject(err) : resolve(res) ])
- })
- }
+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 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 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 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) => {
- func.apply(null, [ arg1, arg2, (err: any, res: A) => err ? reject(err) : resolve(res) ])
+// ---------------------------------------------------------------------------
+
+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 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() ])
+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 })
})
- }
+ })
}
-const pseudoRandomBytesPromise = promisify1<number, Buffer>(pseudoRandomBytes)
-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 randomBytesPromise = promisify1<number, Buffer>(randomBytes)
+const scryptPromise = promisify3<string, string, number, Buffer>(scrypt)
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,
+
+ pageToStartAndCount,
peertubeTruncate,
- sha256,
- sha1,
+ scryptPromise,
- promisify0,
- promisify1,
+ randomBytesPromise,
+
+ generateRSAKeyPairPromise,
+ generateED25519KeyPairPromise,
- pseudoRandomBytesPromise,
- createPrivateKey,
- getPublicKey,
- bcryptComparePromise,
- bcryptGenSaltPromise,
- bcryptHashPromise,
- createTorrentPromise,
execPromise2,
- execPromise
+ execPromise,
+ pipelinePromise,
+
+ parseSemVersion
}
projects / github / Chocobozzz / PeerTube.git / blobdiff