X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fcore-utils.ts;h=2cbf0f8fe5eabf19df83ef29a3206063db99a57a;hb=4c6757f2fd2111e51e51e1b0d8f21f3b5e16ff40;hp=38b6f63f88668db4a9a9f9767cf8b5f16523919b;hpb=b4055e1c23eeefb0c8a85a77f312b2827d98f483;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/core-utils.ts b/server/helpers/core-utils.ts index 38b6f63f8..2cbf0f8fe 100644 --- a/server/helpers/core-utils.ts +++ b/server/helpers/core-utils.ts @@ -1,14 +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 { 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, ExecOptions } from 'child_process' +import { BinaryToTextEncoding, createHash, randomBytes } from 'crypto' +import { truncate } from 'lodash' +import { basename, extname, isAbsolute, join, resolve } from 'path' +import { createPrivateKey as createPrivateKey_1, getPublicKey as getPublicKey_1 } from 'pem' +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') { @@ -22,31 +26,44 @@ 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 } +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 + 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' } @@ -73,21 +90,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 @@ -105,6 +122,8 @@ export function parseBytes (value: string | number): number { } } +// --------------------------------------------------------------------------- + function sanitizeUrl (url: string) { const urlObject = new URL(url) @@ -124,6 +143,8 @@ function sanitizeHost (host: string, remoteScheme: string) { return host.replace(new RegExp(`:${toRemove}$`), '') } +// --------------------------------------------------------------------------- + function isTestInstance () { return process.env.NODE_ENV === 'test' } @@ -136,40 +157,20 @@ function getAppNumber () { return process.env.NODE_APP_INSTANCE } -function root () { - // We are in /helpers/utils.js - const paths = [ __dirname, '..', '..' ] - - // We are under /dist directory - if (process.mainModule && process.mainModule.filename.endsWith('_mocha') === false) { - paths.push('..') - } +// --------------------------------------------------------------------------- - return join.apply(null, paths) -} +let rootPath: string -// Thanks: https://stackoverflow.com/a/12034334 -function escapeHTML (stringParam) { - if (!stringParam) return '' - - const entityMap = { - '&': '&', - '<': '<', - '>': '>', - '"': '"', - '\'': ''', - '/': '/', - '`': '`', - '=': '=' - } +function root () { + if (rootPath) return rootPath - return String(stringParam).replace(/[&<>"'`=\/]/g, s => entityMap[s]) -} + rootPath = __dirname -function pageToStartAndCount (page: number, itemsPerPage: number) { - const start = (page - 1) * itemsPerPage + if (basename(rootPath) === 'helpers') rootPath = resolve(rootPath, '..') + if (basename(rootPath) === 'server') rootPath = resolve(rootPath, '..') + if (basename(rootPath) === 'dist') rootPath = resolve(rootPath, '..') - return { start, count: itemsPerPage } + return rootPath } function buildPath (path: string) { @@ -178,33 +179,62 @@ function buildPath (path: string) { return join(root(), path) } +function getLowercaseExtension (filename: string) { + const ext = extname(filename) || '' + + return ext.toLowerCase() +} + +// --------------------------------------------------------------------------- + // 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 pageToStartAndCount (page: number, itemsPerPage: number) { + const start = (page - 1) * itemsPerPage + + return { start, count: itemsPerPage } +} + +// --------------------------------------------------------------------------- + +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 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 }) @@ -212,6 +242,20 @@ function execShell (command: string, options?: ExecOptions) { }) } +// --------------------------------------------------------------------------- + +function isOdd (num: number) { + return (num % 2) !== 0 +} + +function toEven (num: number) { + if (isOdd(num)) return num + 1 + + return num +} + +// --------------------------------------------------------------------------- + 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) => { @@ -229,14 +273,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) => { @@ -245,19 +281,12 @@ 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() ]) - }) - } -} - -const pseudoRandomBytesPromise = promisify1(pseudoRandomBytes) -const createPrivateKey = promisify1(pem.createPrivateKey) -const getPublicKey = promisify1(pem.getPublicKey) +const randomBytesPromise = promisify1(randomBytes) +const createPrivateKey = promisify1(createPrivateKey_1) +const getPublicKey = promisify1(getPublicKey_1) const execPromise2 = promisify2(exec) const execPromise = promisify1(exec) +const pipelinePromise = promisify(pipeline) // --------------------------------------------------------------------------- @@ -267,13 +296,17 @@ export { getAppNumber, objectConverter, + mapToJSON, + root, - escapeHTML, - pageToStartAndCount, + buildPath, + getLowercaseExtension, sanitizeUrl, sanitizeHost, - buildPath, + execShell, + + pageToStartAndCount, peertubeTruncate, sha256, @@ -283,9 +316,15 @@ export { promisify1, promisify2, - pseudoRandomBytesPromise, + randomBytesPromise, createPrivateKey, getPublicKey, execPromise2, - execPromise + execPromise, + pipelinePromise, + + parseSemVersion, + + isOdd, + toEven }