1 /* eslint-disable no-useless-call */
4 Different from 'utils' because we don't import other PeerTube modules.
5 Useful to avoid circular dependencies.
8 import { exec, ExecOptions } from 'child_process'
9 import { ED25519KeyPairOptions, generateKeyPair, randomBytes, RSAKeyPairOptions, scrypt } from 'crypto'
10 import { truncate } from 'lodash'
11 import { pipeline } from 'stream'
12 import { URL } from 'url'
13 import { promisify } from 'util'
14 import { promisify1, promisify2, promisify3 } from '@shared/core-utils'
16 const objectConverter = (oldObject: any, keyConverter: (e: string) => string, valueConverter: (e: any) => any) => {
17 if (!oldObject || typeof oldObject !== 'object') {
18 return valueConverter(oldObject)
21 if (Array.isArray(oldObject)) {
22 return oldObject.map(e => objectConverter(e, keyConverter, valueConverter))
26 Object.keys(oldObject).forEach(oldKey => {
27 const newKey = keyConverter(oldKey)
28 newObject[newKey] = objectConverter(oldObject[oldKey], keyConverter, valueConverter)
34 function mapToJSON (map: Map<any, any>) {
37 for (const [ k, v ] of map) {
44 // ---------------------------------------------------------------------------
52 week: 3600000 * 24 * 7,
53 month: 3600000 * 24 * 30
56 export function parseDurationToMs (duration: number | string): number {
57 if (duration === null) return null
58 if (typeof duration === 'number') return duration
59 if (!isNaN(+duration)) return +duration
61 if (typeof duration === 'string') {
62 const split = duration.match(/^([\d.,]+)\s?(\w+)$/)
64 if (split.length === 3) {
65 const len = parseFloat(split[1])
66 let unit = split[2].replace(/s$/i, '').toLowerCase()
71 return (len || 1) * (timeTable[unit] || 0)
75 throw new Error(`Duration ${duration} could not be properly parsed`)
78 export function parseBytes (value: string | number): number {
79 if (typeof value === 'number') return value
80 if (!isNaN(+value)) return +value
82 const tgm = /^(\d+)\s*TB\s*(\d+)\s*GB\s*(\d+)\s*MB$/
83 const tg = /^(\d+)\s*TB\s*(\d+)\s*GB$/
84 const tm = /^(\d+)\s*TB\s*(\d+)\s*MB$/
85 const gm = /^(\d+)\s*GB\s*(\d+)\s*MB$/
86 const t = /^(\d+)\s*TB$/
87 const g = /^(\d+)\s*GB$/
88 const m = /^(\d+)\s*MB$/
89 const b = /^(\d+)\s*B$/
91 let match: RegExpMatchArray
93 if (value.match(tgm)) {
94 match = value.match(tgm)
95 return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024 +
96 parseInt(match[2], 10) * 1024 * 1024 * 1024 +
97 parseInt(match[3], 10) * 1024 * 1024
100 if (value.match(tg)) {
101 match = value.match(tg)
102 return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024 +
103 parseInt(match[2], 10) * 1024 * 1024 * 1024
106 if (value.match(tm)) {
107 match = value.match(tm)
108 return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024 +
109 parseInt(match[2], 10) * 1024 * 1024
112 if (value.match(gm)) {
113 match = value.match(gm)
114 return parseInt(match[1], 10) * 1024 * 1024 * 1024 +
115 parseInt(match[2], 10) * 1024 * 1024
118 if (value.match(t)) {
119 match = value.match(t)
120 return parseInt(match[1], 10) * 1024 * 1024 * 1024 * 1024
123 if (value.match(g)) {
124 match = value.match(g)
125 return parseInt(match[1], 10) * 1024 * 1024 * 1024
128 if (value.match(m)) {
129 match = value.match(m)
130 return parseInt(match[1], 10) * 1024 * 1024
133 if (value.match(b)) {
134 match = value.match(b)
135 return parseInt(match[1], 10) * 1024
138 return parseInt(value, 10)
141 // ---------------------------------------------------------------------------
143 function sanitizeUrl (url: string) {
144 const urlObject = new URL(url)
146 if (urlObject.protocol === 'https:' && urlObject.port === '443') {
148 } else if (urlObject.protocol === 'http:' && urlObject.port === '80') {
152 return urlObject.href.replace(/\/$/, '')
155 // Don't import remote scheme from constants because we are in core utils
156 function sanitizeHost (host: string, remoteScheme: string) {
157 const toRemove = remoteScheme === 'https' ? 443 : 80
159 return host.replace(new RegExp(`:${toRemove}$`), '')
162 // ---------------------------------------------------------------------------
164 function isTestInstance () {
165 return process.env.NODE_ENV === 'test'
168 function isDevInstance () {
169 return process.env.NODE_ENV === 'dev'
172 function isTestOrDevInstance () {
173 return isTestInstance() || isDevInstance()
176 function isProdInstance () {
177 return process.env.NODE_ENV === 'production'
180 function getAppNumber () {
181 return process.env.NODE_APP_INSTANCE || ''
184 // ---------------------------------------------------------------------------
186 // Consistent with .length, lodash truncate function is not
187 function peertubeTruncate (str: string, options: { length: number, separator?: RegExp, omission?: string }) {
188 const truncatedStr = truncate(str, options)
190 // The truncated string is okay, we can return it
191 if (truncatedStr.length <= options.length) return truncatedStr
193 // Lodash takes into account all UTF characters, whereas String.prototype.length does not: some characters have a length of 2
194 // We always use the .length so we need to truncate more if needed
195 options.length -= truncatedStr.length - options.length
196 return truncate(str, options)
199 function pageToStartAndCount (page: number, itemsPerPage: number) {
200 const start = (page - 1) * itemsPerPage
202 return { start, count: itemsPerPage }
205 // ---------------------------------------------------------------------------
207 type SemVersion = { major: number, minor: number, patch: number }
208 function parseSemVersion (s: string) {
209 const parsed = s.match(/^v?(\d+)\.(\d+)\.(\d+)$/i)
212 major: parseInt(parsed[1]),
213 minor: parseInt(parsed[2]),
214 patch: parseInt(parsed[3])
218 // ---------------------------------------------------------------------------
220 function execShell (command: string, options?: ExecOptions) {
221 return new Promise<{ err?: Error, stdout: string, stderr: string }>((res, rej) => {
222 exec(command, options, (err, stdout, stderr) => {
223 // eslint-disable-next-line prefer-promise-reject-errors
224 if (err) return rej({ err, stdout, stderr })
226 return res({ stdout, stderr })
231 // ---------------------------------------------------------------------------
233 function generateRSAKeyPairPromise (size: number) {
234 return new Promise<{ publicKey: string, privateKey: string }>((res, rej) => {
235 const options: RSAKeyPairOptions<'pem', 'pem'> = {
241 privateKeyEncoding: {
247 generateKeyPair('rsa', options, (err, publicKey, privateKey) => {
248 if (err) return rej(err)
250 return res({ publicKey, privateKey })
255 function generateED25519KeyPairPromise () {
256 return new Promise<{ publicKey: string, privateKey: string }>((res, rej) => {
257 const options: ED25519KeyPairOptions<'pem', 'pem'> = {
262 privateKeyEncoding: {
268 generateKeyPair('ed25519', options, (err, publicKey, privateKey) => {
269 if (err) return rej(err)
271 return res({ publicKey, privateKey })
276 // ---------------------------------------------------------------------------
278 const randomBytesPromise = promisify1<number, Buffer>(randomBytes)
279 const scryptPromise = promisify3<string, string, number, Buffer>(scrypt)
280 const execPromise2 = promisify2<string, any, string>(exec)
281 const execPromise = promisify1<string, string>(exec)
282 const pipelinePromise = promisify(pipeline)
284 // ---------------------------------------------------------------------------
307 generateRSAKeyPairPromise,
308 generateED25519KeyPairPromise,