X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fcore-utils.ts;h=c560222d3d39fd3a39ce57c477e78c71adc1cdca;hb=98d3324db3b1c345fc30e5dbcef3b1e11169867e;hp=32b89b6dd583ff8175fc8d4581553341757cbbbd;hpb=1840c2f7c91f5f89602a3683d85b0a9df1454855;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/core-utils.ts b/server/helpers/core-utils.ts index 32b89b6dd..c560222d3 100644 --- a/server/helpers/core-utils.ts +++ b/server/helpers/core-utils.ts @@ -3,20 +3,185 @@ Useful to avoid circular dependencies. */ -import { join } from 'path' +import * as bcrypt from 'bcrypt' +import * as createTorrent from 'create-torrent' +import { pseudoRandomBytes } from 'crypto' +import { copyFile, readdir, readFile, rename, stat, Stats, unlink, writeFile } from 'fs' +import * as mkdirp from 'mkdirp' +import { isAbsolute, join } from 'path' +import * as pem from 'pem' +import * as rimraf from 'rimraf' +import { URL } from 'url' +import { truncate } from 'lodash' + +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) { + const toRemove = remoteScheme === 'https' ? 443 : 80 + + return host.replace(new RegExp(`:${toRemove}$`), '') +} function isTestInstance () { return process.env.NODE_ENV === 'test' } function root () { - // We are in /dist/helpers/utils.js - return join(__dirname, '..', '..', '..') + // We are in /helpers/utils.js + const paths = [ __dirname, '..', '..' ] + + // We are under /dist directory + if (process.mainModule.filename.endsWith('.ts') === false) { + paths.push('..') + } + + return join.apply(null, paths) +} + +// Thanks: https://stackoverflow.com/a/12034334 +function escapeHTML (stringParam) { + if (!stringParam) return '' + + const entityMap = { + '&': '&', + '<': '<', + '>': '>', + '"': '"', + "'": ''', + '/': '/', + '`': '`', + '=': '=' + } + + return String(stringParam).replace(/[&<>"'`=\/]/g, s => entityMap[s]) +} + +function pageToStartAndCount (page: number, itemsPerPage: number) { + const start = (page - 1) * itemsPerPage + + return { start, count: itemsPerPage } +} + +function buildPath (path: string) { + if (isAbsolute(path)) return path + + return join(root(), path) +} + +// 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) +} + +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) => { + func.apply(null, [ (err: any, res: A) => err ? reject(err) : resolve(res) ]) + }) + } +} + +// Thanks to https://gist.github.com/kumasento/617daa7e46f13ecdd9b2 +function promisify1 (func: (arg: T, cb: (err: any, result: A) => void) => void): (arg: T) => Promise { + return function promisified (arg: T): Promise { + return new Promise((resolve: (arg: A) => void, reject: (err: any) => void) => { + func.apply(null, [ arg, (err: any, res: A) => err ? reject(err) : resolve(res) ]) + }) + } } +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) => { + func.apply(null, [ arg1, arg2, (err: any, res: A) => err ? reject(err) : resolve(res) ]) + }) + } +} + +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 copyFilePromise = promisify2WithVoid(copyFile) +const readFileBufferPromise = promisify1(readFile) +const unlinkPromise = promisify1WithVoid(unlink) +const renamePromise = promisify2WithVoid(rename) +const writeFilePromise = promisify2WithVoid(writeFile) +const readdirPromise = promisify1(readdir) +const mkdirpPromise = promisify1(mkdirp) +const pseudoRandomBytesPromise = promisify1(pseudoRandomBytes) +const createPrivateKey = promisify1(pem.createPrivateKey) +const getPublicKey = promisify1(pem.getPublicKey) +const bcryptComparePromise = promisify2(bcrypt.compare) +const bcryptGenSaltPromise = promisify1(bcrypt.genSalt) +const bcryptHashPromise = promisify2(bcrypt.hash) +const createTorrentPromise = promisify2(createTorrent) +const rimrafPromise = promisify1WithVoid(rimraf) +const statPromise = promisify1(stat) + // --------------------------------------------------------------------------- export { isTestInstance, - root + root, + escapeHTML, + pageToStartAndCount, + sanitizeUrl, + sanitizeHost, + buildPath, + peertubeTruncate, + + promisify0, + promisify1, + + copyFilePromise, + readdirPromise, + readFileBufferPromise, + unlinkPromise, + renamePromise, + writeFilePromise, + mkdirpPromise, + pseudoRandomBytesPromise, + createPrivateKey, + getPublicKey, + bcryptComparePromise, + bcryptGenSaltPromise, + bcryptHashPromise, + createTorrentPromise, + rimrafPromise, + statPromise }