X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fcore-utils.ts;h=884206aad0c4043830bf4e168346519e9bb97994;hb=19ca8ca93975d99c16ab94c1526a34be74f63b95;hp=d28c97f092acfc306d93d48b944997bfcab9e89d;hpb=f981dae8617271a2dc713bb683951730b306e0c5;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/core-utils.ts b/server/helpers/core-utils.ts index d28c97f09..884206aad 100644 --- a/server/helpers/core-utils.ts +++ b/server/helpers/core-utils.ts @@ -3,30 +3,96 @@ Useful to avoid circular dependencies. */ -import { join } from 'path' -import { pseudoRandomBytes } from 'crypto' -import { - readdir, - readFile, - rename, - unlink, - writeFile, - access -} from 'fs' -import * as mkdirp from 'mkdirp' 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 * as openssl from 'openssl-wrapper' -import * as Promise from 'bluebird' +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 && 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 { @@ -70,43 +136,53 @@ function promisify2WithVoid (func: (arg1: T, arg2: U, cb: (err: any) => vo } } -const readFilePromise = promisify2(readFile) +const copyFilePromise = promisify2WithVoid(copyFile) const readFileBufferPromise = promisify1(readFile) const unlinkPromise = promisify1WithVoid(unlink) const renamePromise = promisify2WithVoid(rename) -const writeFilePromise = promisify2(writeFile) +const writeFilePromise = promisify2WithVoid(writeFile) const readdirPromise = promisify1(readdir) const mkdirpPromise = promisify1(mkdirp) +// we cannot modify the Promise types, so we should make the promisify instance check mkdirp const pseudoRandomBytesPromise = promisify1(pseudoRandomBytes) -const accessPromise = promisify1WithVoid(access) -const opensslExecPromise = promisify2WithVoid(openssl.exec) +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 bcryptHashPromise = promisify2(bcrypt.hash) const createTorrentPromise = promisify2(createTorrent) const rimrafPromise = promisify1WithVoid(rimraf) +const statPromise = promisify1(stat) // --------------------------------------------------------------------------- export { isTestInstance, root, + escapeHTML, + pageToStartAndCount, + sanitizeUrl, + sanitizeHost, + buildPath, + peertubeTruncate, promisify0, promisify1, + + copyFilePromise, readdirPromise, - readFilePromise, readFileBufferPromise, unlinkPromise, renamePromise, writeFilePromise, mkdirpPromise, pseudoRandomBytesPromise, - accessPromise, - opensslExecPromise, + createPrivateKey, + getPublicKey, bcryptComparePromise, bcryptGenSaltPromise, bcryptHashPromise, createTorrentPromise, - rimrafPromise + rimrafPromise, + statPromise }