X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fcore-utils.ts;h=b93868c1235913078bf2bd139153306e57bcebcd;hb=2539932e16129992a2c0889b4ff527c265a8e2c7;hp=64818d036ef095a185c8efb8ab52dc74630cbcb3;hpb=8d2be0ed7bb87283a1ec98609df6b82d83db706a;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/core-utils.ts b/server/helpers/core-utils.ts index 64818d036..b93868c12 100644 --- a/server/helpers/core-utils.ts +++ b/server/helpers/core-utils.ts @@ -1,15 +1,18 @@ +/* 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 createTorrent from 'create-torrent' -import { createHash, HexBase64Latin1Encoding, pseudoRandomBytes } from 'crypto' -import { isAbsolute, join } from 'path' +import { exec, ExecOptions } from 'child_process' +import { BinaryToTextEncoding, createHash, randomBytes } 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 { truncate } from 'lodash' -import { exec, ExecOptions } from 'child_process' +import { promisify } from 'util' const objectConverter = (oldObject: any, keyConverter: (e: string) => string, valueConverter: (e: any) => any) => { if (!oldObject || typeof oldObject !== 'object') { @@ -23,31 +26,32 @@ const objectConverter = (oldObject: any, keyConverter: (e: string) => string, va 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 } 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 parseDurationToMs (duration: number | string): number { + if (duration === null) return null if (typeof duration === 'number') 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' } @@ -74,21 +78,21 @@ export function parseBytes (value: string | number): number { 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 + 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 + 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 + 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 + 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 @@ -137,34 +141,17 @@ function getAppNumber () { return process.env.NODE_APP_INSTANCE } -function root () { - // We are in /helpers/utils.js - const paths = [ __dirname, '..', '..' ] +let rootPath: string - // We are under /dist directory - if (process.mainModule && process.mainModule.filename.endsWith('.ts') === false) { - paths.push('..') - } +function root () { + if (rootPath) return rootPath - return join.apply(null, paths) -} + // We are in /helpers/utils.js + rootPath = join(__dirname, '..', '..') -// Thanks: https://stackoverflow.com/a/12034334 -function escapeHTML (stringParam) { - if (!stringParam) return '' - - const entityMap = { - '&': '&', - '<': '<', - '>': '>', - '"': '"', - '\'': ''', - '/': '/', - '`': '`', - '=': '=' - } + if (basename(rootPath) === 'dist') rootPath = resolve(rootPath, '..') - return String(stringParam).replace(/[&<>"'`=\/]/g, s => entityMap[s]) + return rootPath } function pageToStartAndCount (page: number, itemsPerPage: number) { @@ -173,6 +160,16 @@ function pageToStartAndCount (page: number, itemsPerPage: number) { return { start, count: itemsPerPage } } +function mapToJSON (map: Map) { + const obj: any = {} + + for (const [ k, v ] of map) { + obj[k] = v + } + + return obj +} + function buildPath (path: string) { if (isAbsolute(path)) return path @@ -180,32 +177,30 @@ function buildPath (path: string) { } // 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') { +function sha256 (str: string | Buffer, encoding: BinaryToTextEncoding = 'hex') { return createHash('sha256').update(str).digest(encoding) } -function sha1 (str: string | Buffer, encoding: HexBase64Latin1Encoding = 'hex') { +function sha1 (str: string | Buffer, encoding: BinaryToTextEncoding = 'hex') { return createHash('sha1').update(str).digest(encoding) } 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 }) @@ -230,14 +225,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) => { @@ -246,20 +233,23 @@ 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() ]) - }) - } +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 } -const pseudoRandomBytesPromise = promisify1(pseudoRandomBytes) +const randomBytesPromise = promisify1(randomBytes) const createPrivateKey = promisify1(pem.createPrivateKey) const getPublicKey = promisify1(pem.getPublicKey) -const createTorrentPromise = promisify2(createTorrent) const execPromise2 = promisify2(exec) const execPromise = promisify1(exec) +const pipelinePromise = promisify(pipeline) // --------------------------------------------------------------------------- @@ -270,7 +260,6 @@ export { objectConverter, root, - escapeHTML, pageToStartAndCount, sanitizeUrl, sanitizeHost, @@ -280,15 +269,18 @@ export { sha256, sha1, + mapToJSON, promisify0, promisify1, promisify2, - pseudoRandomBytesPromise, + randomBytesPromise, createPrivateKey, getPublicKey, - createTorrentPromise, execPromise2, - execPromise + execPromise, + pipelinePromise, + + parseSemVersion }