X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fcore-utils.ts;h=73bd994c17c7618a69db3eb65de751681f8ff6aa;hb=d7ce9dca613d96889baa0c93063806268f68cce5;hp=65f18d6442ac34da6d8719e15a15cc18dfc838cb;hpb=23e27dd53599be65b2dc2968448ce155a00a96c9;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/core-utils.ts b/server/helpers/core-utils.ts index 65f18d644..73bd994c1 100644 --- a/server/helpers/core-utils.ts +++ b/server/helpers/core-utils.ts @@ -1,17 +1,143 @@ +/* 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 { isAbsolute, join } from 'path' -import * as pem from 'pem' -import * as rimraf from 'rimraf' +import { exec, ExecOptions } from 'child_process' +import { ED25519KeyPairOptions, generateKeyPair, randomBytes, RSAKeyPairOptions, scrypt } from 'crypto' +import { truncate } from 'lodash' +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) { + 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 (!isNaN(+duration)) 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 + 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 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: 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 + } + + if (value.match(tg)) { + match = value.match(tg) + 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 + } + + if (value.match(gm)) { + match = value.match(gm) + 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 + } + + if (value.match(g)) { + match = value.match(g) + return parseInt(match[1], 10) * 1024 * 1024 * 1024 + } + + if (value.match(m)) { + match = value.match(m) + return parseInt(match[1], 10) * 1024 * 1024 + } + + if (value.match(b)) { + match = value.match(b) + return parseInt(match[1], 10) * 1024 + } + + return parseInt(value, 10) +} + +// --------------------------------------------------------------------------- function sanitizeUrl (url: string) { const urlObject = new URL(url) @@ -32,38 +158,41 @@ function sanitizeHost (host: string, remoteScheme: string) { return host.replace(new RegExp(`:${toRemove}$`), '') } +// --------------------------------------------------------------------------- + function isTestInstance () { return process.env.NODE_ENV === 'test' } -function root () { - // We are in /helpers/utils.js - const paths = [ __dirname, '..', '..' ] +function isDevInstance () { + return process.env.NODE_ENV === 'dev' +} - // We are under /dist directory - if (process.mainModule.filename.endsWith('.ts') === false) { - paths.push('..') - } +function isTestOrDevInstance () { + return isTestInstance() || isDevInstance() +} - return join.apply(null, paths) +function isProdInstance () { + return process.env.NODE_ENV === 'production' } -// Thanks: https://stackoverflow.com/a/12034334 -function escapeHTML (stringParam) { - if (!stringParam) return '' +function getAppNumber () { + return process.env.NODE_APP_INSTANCE || '' +} - const entityMap = { - '&': '&', - '<': '<', - '>': '>', - '"': '"', - "'": ''', - '/': '/', - '`': '`', - '=': '=' - } +// --------------------------------------------------------------------------- - return String(stringParam).replace(/[&<>"'`=\/]/g, s => entityMap[s]) +// 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) { @@ -72,12 +201,91 @@ function pageToStartAndCount (page: number, itemsPerPage: number) { return { start, count: itemsPerPage } } -function buildPath (path: string) { - if (isAbsolute(path)) return path +// --------------------------------------------------------------------------- + +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) => { + // eslint-disable-next-line prefer-promise-reject-errors + if (err) return rej({ err, stdout, stderr }) + + return res({ stdout, stderr }) + }) + }) +} + +// --------------------------------------------------------------------------- - return join(root(), path) +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 (func: (cb: (err: any, result: A) => void) => void): () => Promise { return function promisified (): Promise { return new Promise((resolve: (arg: A) => void, reject: (err: any) => void) => { @@ -95,14 +303,6 @@ function promisify1 (func: (arg: T, cb: (err: any, result: A) => void) => } } -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) => { @@ -111,57 +311,57 @@ function promisify2 (func: (arg1: T, arg2: U, cb: (err: any, result: A) } } -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() ]) +// eslint-disable-next-line max-len +function promisify3 (func: (arg1: T, arg2: U, arg3: V, cb: (err: any, result: A) => void) => void): (arg1: T, arg2: U, arg3: V) => Promise { + return function promisified (arg1: T, arg2: U, arg3: V): Promise { + return new Promise((resolve: (arg: A) => void, reject: (err: any) => void) => { + func.apply(null, [ arg1, arg2, arg3, (err: any, res: A) => err ? reject(err) : resolve(res) ]) }) } } -const readFileBufferPromise = promisify1(readFile) -const unlinkPromise = promisify1WithVoid(unlink) -const renamePromise = promisify2WithVoid(rename) -const writeFilePromise = promisify2WithVoid(writeFile) -const readdirPromise = promisify1(readdir) -const mkdirpPromise = promisify1(mkdirp) -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 rimrafPromise = promisify1WithVoid(rimraf) -const statPromise = promisify1(stat) +const randomBytesPromise = promisify1(randomBytes) +const scryptPromise = promisify3(scrypt) +const execPromise2 = promisify2(exec) +const execPromise = promisify1(exec) +const pipelinePromise = promisify(pipeline) // --------------------------------------------------------------------------- export { isTestInstance, - root, - escapeHTML, - pageToStartAndCount, + isTestOrDevInstance, + isProdInstance, + getAppNumber, + + objectConverter, + mapToJSON, + sanitizeUrl, sanitizeHost, - buildPath, + + execShell, + + pageToStartAndCount, + peertubeTruncate, promisify0, promisify1, + promisify2, + + scryptPromise, + + randomBytesPromise, + + generateRSAKeyPairPromise, + generateED25519KeyPairPromise, + + execPromise2, + execPromise, + pipelinePromise, + + parseSemVersion, - readdirPromise, - readFileBufferPromise, - unlinkPromise, - renamePromise, - writeFilePromise, - mkdirpPromise, - pseudoRandomBytesPromise, - createPrivateKey, - getPublicKey, - bcryptComparePromise, - bcryptGenSaltPromise, - bcryptHashPromise, - createTorrentPromise, - rimrafPromise, - statPromise + isOdd, + toEven }