2017-06-11 15:19:43 +02:00
|
|
|
/*
|
|
|
|
Different from 'utils' because we don't not import other PeerTube modules.
|
|
|
|
Useful to avoid circular dependencies.
|
|
|
|
*/
|
|
|
|
|
2017-07-05 13:26:25 +02:00
|
|
|
import * as bcrypt from 'bcrypt'
|
|
|
|
import * as createTorrent from 'create-torrent'
|
2017-11-23 17:53:38 +01:00
|
|
|
import { pseudoRandomBytes } from 'crypto'
|
2018-06-02 21:39:41 +02:00
|
|
|
import { copyFile, readdir, readFile, rename, stat, Stats, unlink, writeFile } from 'fs'
|
2017-11-23 17:53:38 +01:00
|
|
|
import * as mkdirp from 'mkdirp'
|
2018-01-16 08:46:44 +01:00
|
|
|
import { isAbsolute, join } from 'path'
|
2017-11-09 17:51:58 +01:00
|
|
|
import * as pem from 'pem'
|
2017-11-23 17:53:38 +01:00
|
|
|
import * as rimraf from 'rimraf'
|
2017-12-21 09:56:59 +01:00
|
|
|
import { URL } from 'url'
|
2018-03-28 11:00:02 +02:00
|
|
|
import { truncate } from 'lodash'
|
2017-12-21 09:56:59 +01:00
|
|
|
|
|
|
|
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
|
2017-12-21 09:56:59 +01:00
|
|
|
|
|
|
|
return host.replace(new RegExp(`:${toRemove}$`), '')
|
|
|
|
}
|
2017-06-11 15:19:43 +02:00
|
|
|
|
|
|
|
function isTestInstance () {
|
|
|
|
return process.env.NODE_ENV === 'test'
|
|
|
|
}
|
|
|
|
|
|
|
|
function root () {
|
2017-09-07 15:27:35 +02:00
|
|
|
// We are in /helpers/utils.js
|
|
|
|
const paths = [ __dirname, '..', '..' ]
|
|
|
|
|
|
|
|
// We are under /dist directory
|
2018-07-25 22:01:25 +02:00
|
|
|
if (process.mainModule && process.mainModule.filename.endsWith('.ts') === false) {
|
2017-09-07 15:27:35 +02:00
|
|
|
paths.push('..')
|
|
|
|
}
|
|
|
|
|
|
|
|
return join.apply(null, paths)
|
2017-06-11 15:19:43 +02:00
|
|
|
}
|
|
|
|
|
2017-10-17 16:53:10 +02:00
|
|
|
// Thanks: https://stackoverflow.com/a/12034334
|
|
|
|
function escapeHTML (stringParam) {
|
2018-01-19 13:58:13 +01:00
|
|
|
if (!stringParam) return ''
|
|
|
|
|
2017-10-17 16:53:10 +02:00
|
|
|
const entityMap = {
|
|
|
|
'&': '&',
|
|
|
|
'<': '<',
|
|
|
|
'>': '>',
|
|
|
|
'"': '"',
|
|
|
|
"'": ''',
|
|
|
|
'/': '/',
|
|
|
|
'`': '`',
|
|
|
|
'=': '='
|
|
|
|
}
|
|
|
|
|
|
|
|
return String(stringParam).replace(/[&<>"'`=\/]/g, s => entityMap[s])
|
|
|
|
}
|
|
|
|
|
2017-11-09 17:51:58 +01:00
|
|
|
function pageToStartAndCount (page: number, itemsPerPage: number) {
|
|
|
|
const start = (page - 1) * itemsPerPage
|
|
|
|
|
|
|
|
return { start, count: itemsPerPage }
|
|
|
|
}
|
|
|
|
|
2018-01-16 08:46:44 +01:00
|
|
|
function buildPath (path: string) {
|
|
|
|
if (isAbsolute(path)) return path
|
|
|
|
|
|
|
|
return join(root(), path)
|
|
|
|
}
|
|
|
|
|
2018-03-28 11:00:02 +02:00
|
|
|
// Consistent with .length, lodash truncate function is not
|
|
|
|
function peertubeTruncate (str: string, maxLength: number) {
|
|
|
|
const options = {
|
|
|
|
length: maxLength
|
|
|
|
}
|
|
|
|
const truncatedStr = truncate(str, options)
|
|
|
|
|
|
|
|
// The truncated string is okay, we can return it
|
|
|
|
if (truncatedStr.length <= maxLength) 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
|
|
|
|
return truncate(str, options)
|
|
|
|
}
|
|
|
|
|
2017-07-05 13:26:25 +02:00
|
|
|
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 promisify1WithVoid<T> (func: (arg: T, cb: (err: any) => void) => void): (arg: T) => Promise<void> {
|
|
|
|
return function promisified (arg: T): Promise<void> {
|
|
|
|
return new Promise<void>((resolve: () => void, reject: (err: any) => void) => {
|
|
|
|
func.apply(null, [ arg, (err: any) => err ? reject(err) : resolve() ])
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
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) ])
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function promisify2WithVoid<T, U> (func: (arg1: T, arg2: U, cb: (err: any) => void) => void): (arg1: T, arg2: U) => Promise<void> {
|
|
|
|
return function promisified (arg1: T, arg2: U): Promise<void> {
|
|
|
|
return new Promise<void>((resolve: () => void, reject: (err: any) => void) => {
|
|
|
|
func.apply(null, [ arg1, arg2, (err: any) => err ? reject(err) : resolve() ])
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-06-02 21:39:41 +02:00
|
|
|
const copyFilePromise = promisify2WithVoid<string, string>(copyFile)
|
2017-07-05 13:26:25 +02:00
|
|
|
const readFileBufferPromise = promisify1<string, Buffer>(readFile)
|
|
|
|
const unlinkPromise = promisify1WithVoid<string>(unlink)
|
|
|
|
const renamePromise = promisify2WithVoid<string, string>(rename)
|
2017-08-25 18:36:49 +02:00
|
|
|
const writeFilePromise = promisify2WithVoid<string, any>(writeFile)
|
2017-07-05 13:26:25 +02:00
|
|
|
const readdirPromise = promisify1<string, string[]>(readdir)
|
|
|
|
const mkdirpPromise = promisify1<string, string>(mkdirp)
|
2018-07-25 22:01:25 +02:00
|
|
|
// we cannot modify the Promise types, so we should make the promisify instance check mkdirp
|
2017-07-05 13:26:25 +02:00
|
|
|
const pseudoRandomBytesPromise = promisify1<number, Buffer>(pseudoRandomBytes)
|
2017-11-09 17:51:58 +01:00
|
|
|
const createPrivateKey = promisify1<number, { key: string }>(pem.createPrivateKey)
|
|
|
|
const getPublicKey = promisify1<string, { publicKey: string }>(pem.getPublicKey)
|
2017-07-05 13:26:25 +02:00
|
|
|
const bcryptComparePromise = promisify2<any, string, boolean>(bcrypt.compare)
|
|
|
|
const bcryptGenSaltPromise = promisify1<number, string>(bcrypt.genSalt)
|
2017-10-31 16:31:24 +01:00
|
|
|
const bcryptHashPromise = promisify2<any, string | number, string>(bcrypt.hash)
|
2017-07-05 13:26:25 +02:00
|
|
|
const createTorrentPromise = promisify2<string, any, any>(createTorrent)
|
2017-07-12 11:56:02 +02:00
|
|
|
const rimrafPromise = promisify1WithVoid<string>(rimraf)
|
2017-10-02 12:20:26 +02:00
|
|
|
const statPromise = promisify1<string, Stats>(stat)
|
2017-07-05 13:26:25 +02:00
|
|
|
|
2017-06-11 15:19:43 +02:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
export {
|
|
|
|
isTestInstance,
|
2017-07-05 13:26:25 +02:00
|
|
|
root,
|
2017-10-17 16:53:10 +02:00
|
|
|
escapeHTML,
|
2017-11-09 17:51:58 +01:00
|
|
|
pageToStartAndCount,
|
2017-12-21 09:56:59 +01:00
|
|
|
sanitizeUrl,
|
|
|
|
sanitizeHost,
|
2018-01-16 08:46:44 +01:00
|
|
|
buildPath,
|
2018-03-28 11:00:02 +02:00
|
|
|
peertubeTruncate,
|
2017-07-05 13:26:25 +02:00
|
|
|
|
|
|
|
promisify0,
|
|
|
|
promisify1,
|
2017-11-09 17:51:58 +01:00
|
|
|
|
2018-06-02 21:39:41 +02:00
|
|
|
copyFilePromise,
|
2017-07-05 13:26:25 +02:00
|
|
|
readdirPromise,
|
|
|
|
readFileBufferPromise,
|
|
|
|
unlinkPromise,
|
|
|
|
renamePromise,
|
|
|
|
writeFilePromise,
|
|
|
|
mkdirpPromise,
|
|
|
|
pseudoRandomBytesPromise,
|
2017-11-09 17:51:58 +01:00
|
|
|
createPrivateKey,
|
|
|
|
getPublicKey,
|
2017-07-05 13:26:25 +02:00
|
|
|
bcryptComparePromise,
|
|
|
|
bcryptGenSaltPromise,
|
|
|
|
bcryptHashPromise,
|
2017-07-12 11:56:02 +02:00
|
|
|
createTorrentPromise,
|
2017-10-02 12:20:26 +02:00
|
|
|
rimrafPromise,
|
2017-11-16 11:08:25 +01:00
|
|
|
statPromise
|
2017-06-11 15:19:43 +02:00
|
|
|
}
|