PeerTube/server/core/helpers/core-utils.ts

299 lines
8.1 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.
*/
import { promisify1, promisify2, promisify3 } from '@peertube/peertube-core-utils'
2021-02-03 09:33:05 +01:00
import { exec, ExecOptions } from 'child_process'
2022-10-10 11:12:23 +02:00
import { ED25519KeyPairOptions, generateKeyPair, randomBytes, RSAKeyPairOptions, scrypt } from 'crypto'
import truncate from 'lodash-es/truncate.js'
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
2022-06-14 08:47:26 +02:00
if (!isNaN(+duration)) return +duration
2018-08-14 15:28:30 +02:00
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
2022-06-14 08:47:26 +02:00
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$/
2022-06-14 08:47:26 +02:00
let match: RegExpMatchArray
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
2022-06-14 08:47:26 +02:00
}
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
2022-06-14 08:47:26 +02:00
}
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
2022-06-14 08:47:26 +02:00
}
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
2022-06-14 08:47:26 +02:00
}
if (value.match(t)) {
match = value.match(t)
return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024
2022-06-14 08:47:26 +02:00
}
if (value.match(g)) {
match = value.match(g)
return parseInt(match[1], 10) * 1024 * 1024 * 1024
2022-06-14 08:47:26 +02:00
}
if (value.match(m)) {
match = value.match(m)
return parseInt(match[1], 10) * 1024 * 1024
2022-06-14 08:47:26 +02:00
}
if (value.match(b)) {
match = value.match(b)
return parseInt(match[1], 10) * 1024
}
2022-06-14 08:47:26 +02:00
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
// ---------------------------------------------------------------------------
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 }
2023-08-03 00:22:36 +02:00
/**
* Parses a semantic version string into its separate components.
* Fairly lax, and allows for missing or additional segments in the string.
*
* @param s String to parse semantic version from.
* @returns Major, minor, and patch version, or null if string does not follow semantic version conventions.
*/
function parseSemVersion (s: string) {
2023-08-03 00:22:36 +02:00
const parsed = s.match(/v?(\d+)\.(\d+)(?:\.(\d+))?/i)
if (!parsed) return null
return {
major: parseInt(parsed[1]),
minor: parseInt(parsed[2]),
2023-08-03 00:22:36 +02:00
patch: parsed[3] ? parseInt(parsed[3]) : 0
} as SemVersion
}
// ---------------------------------------------------------------------------
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 })
})
})
}
// ---------------------------------------------------------------------------
2022-07-12 10:54:21 +02:00
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 })
})
})
}
// ---------------------------------------------------------------------------
2020-01-31 16:56:52 +01:00
const randomBytesPromise = promisify1<number, Buffer>(randomBytes)
2022-10-10 11:12:23 +02:00
const scryptPromise = promisify3<string, string, number, Buffer>(scrypt)
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 {
2019-01-09 15:14:29 +01:00
objectConverter,
mapToJSON,
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
2022-10-10 11:12:23 +02:00
scryptPromise,
2020-01-31 16:56:52 +01:00
randomBytesPromise,
2022-07-12 10:54:21 +02:00
generateRSAKeyPairPromise,
generateED25519KeyPairPromise,
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
2017-06-11 15:19:43 +02:00
}