X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fcore-utils.ts;h=f5ef187fe73ccc29841e9b5786d8eb532de3d9ec;hb=62689b942b71cd1dd0d050c6ed05f884a0b325c2;hp=f8dd45533f352a05c6f85e2c0de3948e3dd9d3a3;hpb=556ddc319242aafef51bae9301423ecf8701a3af;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/core-utils.ts b/server/helpers/core-utils.ts index f8dd45533..f5ef187fe 100644 --- a/server/helpers/core-utils.ts +++ b/server/helpers/core-utils.ts @@ -3,30 +3,127 @@ 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 { createHash, pseudoRandomBytes } from 'crypto' +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' + +const timeTable = { + ms: 1, + second: 1000, + minute: 60000, + hour: 3600000, + day: 3600000 * 24, + week: 3600000 * 24 * 7, + month: 3600000 * 24 * 30 +} +export function parseDuration (duration: number | string): number { + if (typeof duration === 'number') return duration + + if (typeof duration === 'string') { + const split = duration.match(/^([\d\.,]+)\s?(\w+)$/) + + if (split.length === 3) { + const len = parseFloat(split[1]) + let unit = split[2].replace(/s$/i,'').toLowerCase() + if (unit === 'm') { + unit = 'ms' + } + + return (len || 1) * (timeTable[unit] || 0) + } + } + + throw new Error('Duration could not be properly parsed') +} + +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 sha256 (str: string) { + return createHash('sha256').update(str).digest('hex') } function promisify0 (func: (cb: (err: any, result: A) => void) => void): () => Promise { @@ -70,43 +167,35 @@ function promisify2WithVoid (func: (arg1: T, arg2: U, cb: (err: any) => vo } } -const readFilePromise = promisify2(readFile) -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 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) // --------------------------------------------------------------------------- export { isTestInstance, root, + escapeHTML, + pageToStartAndCount, + sanitizeUrl, + sanitizeHost, + buildPath, + peertubeTruncate, + sha256, promisify0, promisify1, - readdirPromise, - readFilePromise, - readFileBufferPromise, - unlinkPromise, - renamePromise, - writeFilePromise, - mkdirpPromise, + pseudoRandomBytesPromise, - accessPromise, - opensslExecPromise, + createPrivateKey, + getPublicKey, bcryptComparePromise, bcryptGenSaltPromise, bcryptHashPromise, - createTorrentPromise, - rimrafPromise + createTorrentPromise }