/* Different from 'utils' because we don't not 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 { truncate } from 'lodash' import { exec } from 'child_process' import { isArray } from './custom-validators/misc' const objectConverter = (oldObject: any, keyConverter: (e: string) => string, valueConverter: (e: any) => any) => { if (!oldObject || typeof oldObject !== 'object') { return valueConverter(oldObject) } if (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 parseDuration (duration: number | string): number { 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 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) } // Thanks: https://stackoverflow.com/a/12034334 function escapeHTML (stringParam) { if (!stringParam) return '' const entityMap = { '&': '&', '<': '<', '>': '>', '"': '"', '\'': ''', '/': '/', '`': '`', '=': '=' } return String(stringParam).replace(/[&<>"'`=\/]/g, s => entityMap[s]) } function pageToStartAndCount (page: number, itemsPerPage: number) { const start = (page - 1) * itemsPerPage return { start, count: itemsPerPage } } 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 } const truncatedStr = truncate(str, options) // The truncated string is okay, we can return it if (truncatedStr.length <= maxLength) 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 return truncate(str, options) } function sha256 (str: string | Buffer, encoding: HexBase64Latin1Encoding = 'hex') { return createHash('sha256').update(str).digest(encoding) } function sha1 (str: string | Buffer, encoding: HexBase64Latin1Encoding = 'hex') { return createHash('sha1').update(str).digest(encoding) } function promisify0 (func: (cb: (err: any, result: A) => void) => void): () => Promise { return function promisified (): Promise { return new Promise((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 (func: (arg: T, cb: (err: any, result: A) => void) => void): (arg: T) => Promise { return function promisified (arg: T): Promise { return new Promise((resolve: (arg: A) => void, reject: (err: any) => void) => { func.apply(null, [ arg, (err: any, res: A) => err ? reject(err) : resolve(res) ]) }) } } function promisify1WithVoid (func: (arg: T, cb: (err: any) => void) => void): (arg: T) => Promise { return function promisified (arg: T): Promise { return new Promise((resolve: () => void, reject: (err: any) => void) => { func.apply(null, [ arg, (err: any) => err ? reject(err) : resolve() ]) }) } } function promisify2 (func: (arg1: T, arg2: U, cb: (err: any, result: A) => void) => void): (arg1: T, arg2: U) => Promise { return function promisified (arg1: T, arg2: U): Promise { return new Promise((resolve: (arg: A) => void, reject: (err: any) => void) => { func.apply(null, [ arg1, arg2, (err: any, res: A) => err ? reject(err) : resolve(res) ]) }) } } function promisify2WithVoid (func: (arg1: T, arg2: U, cb: (err: any) => void) => void): (arg1: T, arg2: U) => Promise { return function promisified (arg1: T, arg2: U): Promise { return new Promise((resolve: () => void, reject: (err: any) => void) => { func.apply(null, [ arg1, arg2, (err: any) => err ? reject(err) : resolve() ]) }) } } const pseudoRandomBytesPromise = promisify1(pseudoRandomBytes) const createPrivateKey = promisify1(pem.createPrivateKey) const getPublicKey = promisify1(pem.getPublicKey) const bcryptComparePromise = promisify2(bcrypt.compare) const bcryptGenSaltPromise = promisify1(bcrypt.genSalt) const bcryptHashPromise = promisify2(bcrypt.hash) const createTorrentPromise = promisify2(createTorrent) const execPromise2 = promisify2(exec) const execPromise = promisify1(exec) // --------------------------------------------------------------------------- export { isTestInstance, isProdInstance, objectConverter, root, escapeHTML, pageToStartAndCount, sanitizeUrl, sanitizeHost, buildPath, peertubeTruncate, sha256, sha1, promisify0, promisify1, pseudoRandomBytesPromise, createPrivateKey, getPublicKey, bcryptComparePromise, bcryptGenSaltPromise, bcryptHashPromise, createTorrentPromise, execPromise2, execPromise }