PeerTube/server/helpers/core-utils.ts

330 lines
9.3 KiB
TypeScript
Raw Normal View History

2020-01-31 16:56:52 +01:00
/* eslint-disable no-useless-call */
2017-06-11 15:19:43 +02:00
/*
2020-02-05 14:50:16 +01:00
Different from 'utils' because we don't import other PeerTube modules.
2017-06-11 15:19:43 +02:00
Useful to avoid circular dependencies.
*/
2021-02-03 09:33:05 +01:00
import { exec, ExecOptions } from 'child_process'
import { BinaryToTextEncoding, createHash, randomBytes } from 'crypto'
import { truncate } from 'lodash'
import { basename, extname, isAbsolute, join, resolve } from 'path'
2017-11-09 17:51:58 +01:00
import * as pem from 'pem'
2021-03-08 14:24:11 +01:00
import { pipeline } from 'stream'
import { URL } from 'url'
2021-03-08 14:24:11 +01:00
import { promisify } from 'util'
2019-01-09 15:14:29 +01:00
const objectConverter = (oldObject: any, keyConverter: (e: string) => string, valueConverter: (e: any) => any) => {
if (!oldObject || typeof oldObject !== 'object') {
return valueConverter(oldObject)
}
if (Array.isArray(oldObject)) {
2019-01-09 15:14:29 +01:00
return oldObject.map(e => objectConverter(e, keyConverter, valueConverter))
}
const newObject = {}
Object.keys(oldObject).forEach(oldKey => {
const newKey = keyConverter(oldKey)
2020-01-31 16:56:52 +01:00
newObject[newKey] = objectConverter(oldObject[oldKey], keyConverter, valueConverter)
2019-01-09 15:14:29 +01:00
})
return newObject
}
function mapToJSON (map: Map<any, any>) {
const obj: any = {}
for (const [ k, v ] of map) {
obj[k] = v
}
return obj
}
// ---------------------------------------------------------------------------
2018-08-14 15:28:30 +02:00
const timeTable = {
2020-01-31 16:56:52 +01:00
ms: 1,
second: 1000,
minute: 60000,
hour: 3600000,
day: 3600000 * 24,
week: 3600000 * 24 * 7,
month: 3600000 * 24 * 30
2018-08-14 15:28:30 +02:00
}
export function parseDurationToMs (duration: number | string): number {
2020-09-25 16:19:35 +02:00
if (duration === null) return null
2018-08-14 15:28:30 +02:00
if (typeof duration === 'number') return duration
if (typeof duration === 'string') {
2020-01-31 16:56:52 +01:00
const split = duration.match(/^([\d.,]+)\s?(\w+)$/)
2018-08-14 15:28:30 +02:00
if (split.length === 3) {
const len = parseFloat(split[1])
2020-01-31 16:56:52 +01:00
let unit = split[2].replace(/s$/i, '').toLowerCase()
2018-08-14 15:28:30 +02:00
if (unit === 'm') {
unit = 'ms'
}
return (len || 1) * (timeTable[unit] || 0)
}
}
2019-04-08 11:13:49 +02:00
throw new Error(`Duration ${duration} could not be properly parsed`)
2018-08-14 15:28:30 +02:00
}
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)
2020-01-31 16:56:52 +01:00
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)
2020-01-31 16:56:52 +01:00
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)
2020-01-31 16:56:52 +01:00
return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024 +
parseInt(match[2], 10) * 1024 * 1024
} else if (value.match(gm)) {
match = value.match(gm)
2020-01-31 16:56:52 +01:00
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) {
2017-12-21 10:16:20 +01:00
const toRemove = remoteScheme === 'https' ? 443 : 80
return host.replace(new RegExp(`:${toRemove}$`), '')
}
2017-06-11 15:19:43 +02:00
// ---------------------------------------------------------------------------
2017-06-11 15:19:43 +02:00
function isTestInstance () {
return process.env.NODE_ENV === 'test'
}
function isProdInstance () {
return process.env.NODE_ENV === 'production'
}
2019-06-13 11:09:38 +02:00
function getAppNumber () {
return process.env.NODE_APP_INSTANCE
}
// ---------------------------------------------------------------------------
2019-07-19 10:37:35 +02:00
let rootPath: string
2020-01-31 16:56:52 +01:00
2017-06-11 15:19:43 +02:00
function root () {
2019-07-19 10:37:35 +02:00
if (rootPath) return rootPath
2017-09-07 15:27:35 +02:00
// We are in /helpers/utils.js
2019-07-19 10:37:35 +02:00
rootPath = join(__dirname, '..', '..')
2017-09-07 15:27:35 +02:00
2019-07-19 10:37:35 +02:00
if (basename(rootPath) === 'dist') rootPath = resolve(rootPath, '..')
2017-09-07 15:27:35 +02:00
2019-07-19 10:37:35 +02:00
return rootPath
2017-06-11 15:19:43 +02:00
}
function buildPath (path: string) {
if (isAbsolute(path)) return path
2017-11-09 17:51:58 +01:00
return join(root(), path)
2017-11-09 17:51:58 +01:00
}
function getLowercaseExtension (filename: string) {
const ext = extname(filename) || ''
return ext.toLowerCase()
}
// ---------------------------------------------------------------------------
2018-01-16 08:46:44 +01:00
2018-03-28 11:00:02 +02:00
// Consistent with .length, lodash truncate function is not
function peertubeTruncate (str: string, options: { length: number, separator?: RegExp, omission?: string }) {
2018-03-28 11:00:02 +02:00
const truncatedStr = truncate(str, options)
// The truncated string is okay, we can return it
if (truncatedStr.length <= options.length) return truncatedStr
2018-03-28 11:00:02 +02:00
// 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
2018-03-28 11:00:02 +02:00
return truncate(str, options)
}
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
}
// ---------------------------------------------------------------------------
2021-02-03 09:33:05 +01:00
function sha256 (str: string | Buffer, encoding: BinaryToTextEncoding = 'hex') {
2018-10-10 08:51:58 +02:00
return createHash('sha256').update(str).digest(encoding)
2018-08-07 09:54:36 +02:00
}
2021-02-03 09:33:05 +01:00
function sha1 (str: string | Buffer, encoding: BinaryToTextEncoding = 'hex') {
2019-01-29 08:37:25 +01:00
return createHash('sha1').update(str).digest(encoding)
}
// ---------------------------------------------------------------------------
2019-07-05 15:28:49 +02:00
function execShell (command: string, options?: ExecOptions) {
return new Promise<{ err?: Error, stdout: string, stderr: string }>((res, rej) => {
exec(command, options, (err, stdout, stderr) => {
2020-01-31 16:56:52 +01:00
// eslint-disable-next-line prefer-promise-reject-errors
2019-07-05 15:28:49 +02:00
if (err) return rej({ err, stdout, stderr })
return res({ stdout, stderr })
})
})
}
// ---------------------------------------------------------------------------
function isOdd (num: number) {
return (num % 2) !== 0
}
function toEven (num: number) {
2021-06-08 13:08:34 +02:00
if (isOdd(num)) return num + 1
return num
}
// ---------------------------------------------------------------------------
function promisify0<A> (func: (cb: (err: any, result: A) => void) => void): () => Promise<A> {
return function promisified (): Promise<A> {
return new Promise<A>((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<T, A> (func: (arg: T, cb: (err: any, result: A) => void) => void): (arg: T) => Promise<A> {
return function promisified (arg: T): Promise<A> {
return new Promise<A>((resolve: (arg: A) => void, reject: (err: any) => void) => {
func.apply(null, [ arg, (err: any, res: A) => err ? reject(err) : resolve(res) ])
})
}
}
function promisify2<T, U, A> (func: (arg1: T, arg2: U, cb: (err: any, result: A) => void) => void): (arg1: T, arg2: U) => Promise<A> {
return function promisified (arg1: T, arg2: U): Promise<A> {
return new Promise<A>((resolve: (arg: A) => void, reject: (err: any) => void) => {
func.apply(null, [ arg1, arg2, (err: any, res: A) => err ? reject(err) : resolve(res) ])
})
}
}
2020-01-31 16:56:52 +01:00
const randomBytesPromise = promisify1<number, Buffer>(randomBytes)
2017-11-09 17:51:58 +01:00
const createPrivateKey = promisify1<number, { key: string }>(pem.createPrivateKey)
const getPublicKey = promisify1<string, { publicKey: string }>(pem.getPublicKey)
2018-10-03 14:35:35 +02:00
const execPromise2 = promisify2<string, any, string>(exec)
const execPromise = promisify1<string, string>(exec)
2021-03-08 14:24:11 +01:00
const pipelinePromise = promisify(pipeline)
2017-06-11 15:19:43 +02:00
// ---------------------------------------------------------------------------
export {
isTestInstance,
isProdInstance,
2019-06-13 11:09:38 +02:00
getAppNumber,
2019-01-09 15:14:29 +01:00
objectConverter,
mapToJSON,
root,
buildPath,
getLowercaseExtension,
sanitizeUrl,
sanitizeHost,
2019-07-05 15:28:49 +02:00
execShell,
pageToStartAndCount,
2018-03-28 11:00:02 +02:00
peertubeTruncate,
2019-01-29 08:37:25 +01:00
2018-08-07 09:54:36 +02:00
sha256,
2019-01-29 08:37:25 +01:00
sha1,
promisify0,
promisify1,
promisify2,
2017-11-09 17:51:58 +01:00
2020-01-31 16:56:52 +01:00
randomBytesPromise,
2017-11-09 17:51:58 +01:00
createPrivateKey,
getPublicKey,
2018-10-03 14:35:35 +02:00
execPromise2,
2021-03-08 14:24:11 +01:00
execPromise,
2021-03-11 09:51:08 +01:00
pipelinePromise,
parseSemVersion,
isOdd,
toEven
2017-06-11 15:19:43 +02:00
}