X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fcore-utils.ts;h=242c49e896090249c3e1d6cda61a5e05ba2cd519;hb=ce1b5ba78c35cfd4df123cab49aef1d14ca0f9b7;hp=b1f5d9610ba28d6e4cbf996cf0000fbd4d1835c1;hpb=c2777c1dfe688c8fab1ef2fed50e360100fa9198;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/core-utils.ts b/server/helpers/core-utils.ts index b1f5d9610..242c49e89 100644 --- a/server/helpers/core-utils.ts +++ b/server/helpers/core-utils.ts @@ -5,12 +5,13 @@ Useful to avoid circular dependencies. */ -import { createHash, HexBase64Latin1Encoding, randomBytes } from 'crypto' -import { basename, isAbsolute, join, resolve } from 'path' -import * as pem from 'pem' -import { URL } from 'url' -import { truncate } from 'lodash' 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' +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') { @@ -30,6 +31,18 @@ const objectConverter = (oldObject: any, keyConverter: (e: string) => string, va 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, @@ -41,7 +54,9 @@ const timeTable = { } 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+)$/) @@ -62,6 +77,7 @@ export function parseDurationToMs (duration: number | string): number { 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$/ @@ -71,42 +87,59 @@ export function parseBytes (value: string | number): number { 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) @@ -126,60 +159,29 @@ function sanitizeHost (host: string, remoteScheme: string) { 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 +function isDevInstance () { + return process.env.NODE_ENV === 'dev' } -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 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, options: { length: number, separator?: RegExp, omission?: string }) { @@ -194,14 +196,27 @@ function peertubeTruncate (str: string, options: { length: number, separator?: R 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 + + return { start, count: itemsPerPage } } -function sha1 (str: string | Buffer, encoding: HexBase64Latin1Encoding = '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) => { @@ -213,64 +228,88 @@ function execShell (command: string, options?: ExecOptions) { }) } -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) ]) - }) - } -} +// --------------------------------------------------------------------------- + +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) -// 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) ]) + return res({ publicKey, privateKey }) }) - } + }) } -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 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 randomBytesPromise = promisify1(randomBytes) -const createPrivateKey = promisify1(pem.createPrivateKey) -const getPublicKey = promisify1(pem.getPublicKey) +const scryptPromise = promisify3(scrypt) const execPromise2 = promisify2(exec) const execPromise = promisify1(exec) +const pipelinePromise = promisify(pipeline) // --------------------------------------------------------------------------- export { isTestInstance, + isTestOrDevInstance, isProdInstance, getAppNumber, objectConverter, - root, - escapeHTML, - pageToStartAndCount, + mapToJSON, + sanitizeUrl, sanitizeHost, - buildPath, + execShell, - peertubeTruncate, - sha256, - sha1, + pageToStartAndCount, + peertubeTruncate, - promisify0, - promisify1, - promisify2, + scryptPromise, randomBytesPromise, - createPrivateKey, - getPublicKey, + + generateRSAKeyPairPromise, + generateED25519KeyPairPromise, + execPromise2, - execPromise + execPromise, + pipelinePromise, + + parseSemVersion }