PeerTube/server/helpers/utils.ts

215 lines
6.1 KiB
TypeScript
Raw Normal View History

2017-12-12 17:53:50 +01:00
import { Model } from 'sequelize-typescript'
import * as ipaddr from 'ipaddr.js'
import { ResultList } from '../../shared'
2017-12-12 17:53:50 +01:00
import { VideoResolution } from '../../shared/models/videos'
2018-04-24 15:10:54 +02:00
import { CONFIG } from '../initializers'
2017-12-12 17:53:50 +01:00
import { UserModel } from '../models/account/user'
2017-12-14 17:38:41 +01:00
import { ActorModel } from '../models/activitypub/actor'
import { ApplicationModel } from '../models/application/application'
2018-08-07 09:54:36 +02:00
import { pseudoRandomBytesPromise, sha256, unlinkPromise } from './core-utils'
import { logger } from './logger'
2018-07-31 15:09:34 +02:00
import { isArray } from './custom-validators/misc'
2018-08-07 15:17:17 +02:00
import { join } from 'path'
2018-08-07 09:54:36 +02:00
import { Instance as ParseTorrent } from 'parse-torrent'
const isCidr = require('is-cidr')
2018-07-31 15:09:34 +02:00
function cleanUpReqFiles (req: { files: { [ fieldname: string ]: Express.Multer.File[] } | Express.Multer.File[] }) {
const files = req.files
if (!files) return
if (isArray(files)) {
(files as Express.Multer.File[]).forEach(f => deleteFileAsync(f.path))
return
}
for (const key of Object.keys(files)) {
const file = files[key]
if (isArray(file)) file.forEach(f => deleteFileAsync(f.path))
else deleteFileAsync(file.path)
}
}
function deleteFileAsync (path: string) {
unlinkPromise(path)
.catch(err => logger.error('Cannot delete the file %s asynchronously.', path, { err }))
}
async function generateRandomString (size: number) {
const raw = await pseudoRandomBytesPromise(size)
return raw.toString('hex')
2017-02-26 18:57:33 +01:00
}
interface FormattableToJSON {
toFormattedJSON (args?: any)
2017-06-17 11:28:11 +02:00
}
function getFormattedObjects<U, T extends FormattableToJSON> (objects: T[], objectsTotal: number, formattedArg?: any) {
2017-08-25 11:45:31 +02:00
const formattedObjects: U[] = []
2017-01-04 20:59:23 +01:00
2017-07-11 17:04:57 +02:00
objects.forEach(object => {
formattedObjects.push(object.toFormattedJSON(formattedArg))
2017-01-04 20:59:23 +01:00
})
return {
2017-01-04 20:59:23 +01:00
total: objectsTotal,
2017-08-25 11:45:31 +02:00
data: formattedObjects
} as ResultList<U>
2017-01-04 20:59:23 +01:00
}
async function isSignupAllowed () {
if (CONFIG.SIGNUP.ENABLED === false) {
return false
}
// No limit and signup is enabled
if (CONFIG.SIGNUP.LIMIT === -1) {
return true
}
2017-12-12 17:53:50 +01:00
const totalUsers = await UserModel.countTotal()
return totalUsers < CONFIG.SIGNUP.LIMIT
}
function isSignupAllowedForCurrentIP (ip: string) {
const addr = ipaddr.parse(ip)
let excludeList = [ 'blacklist' ]
let matched = ''
// if there is a valid, non-empty whitelist, we exclude all unknown adresses too
if (CONFIG.SIGNUP.FILTERS.CIDR.WHITELIST.filter(cidr => isCidr(cidr)).length > 0) {
excludeList.push('unknown')
}
if (addr.kind() === 'ipv4') {
const addrV4 = ipaddr.IPv4.parse(ip)
const rangeList = {
whitelist: CONFIG.SIGNUP.FILTERS.CIDR.WHITELIST.filter(cidr => isCidr.v4(cidr))
.map(cidr => ipaddr.IPv4.parseCIDR(cidr)),
blacklist: CONFIG.SIGNUP.FILTERS.CIDR.BLACKLIST.filter(cidr => isCidr.v4(cidr))
.map(cidr => ipaddr.IPv4.parseCIDR(cidr))
}
matched = ipaddr.subnetMatch(addrV4, rangeList, 'unknown')
} else if (addr.kind() === 'ipv6') {
const addrV6 = ipaddr.IPv6.parse(ip)
const rangeList = {
whitelist: CONFIG.SIGNUP.FILTERS.CIDR.WHITELIST.filter(cidr => isCidr.v6(cidr))
.map(cidr => ipaddr.IPv6.parseCIDR(cidr)),
blacklist: CONFIG.SIGNUP.FILTERS.CIDR.BLACKLIST.filter(cidr => isCidr.v6(cidr))
.map(cidr => ipaddr.IPv6.parseCIDR(cidr))
}
matched = ipaddr.subnetMatch(addrV6, rangeList, 'unknown')
}
return !excludeList.includes(matched)
}
function computeResolutionsToTranscode (videoFileHeight: number) {
const resolutionsEnabled: number[] = []
const configResolutions = CONFIG.TRANSCODING.RESOLUTIONS
// Put in the order we want to proceed jobs
const resolutions = [
VideoResolution.H_480P,
VideoResolution.H_360P,
VideoResolution.H_720P,
VideoResolution.H_240P,
VideoResolution.H_1080P
]
for (const resolution of resolutions) {
if (configResolutions[ resolution + 'p' ] === true && videoFileHeight > resolution) {
resolutionsEnabled.push(resolution)
}
}
return resolutionsEnabled
}
2018-07-21 23:00:25 +02:00
const timeTable = {
ms: 1,
second: 1000,
minute: 60000,
hour: 3600000,
day: 3600000 * 24,
week: 3600000 * 24 * 7,
month: 3600000 * 24 * 30
}
2018-07-24 14:35:11 +02:00
export function parseDuration (duration: number | string): number {
2018-07-21 23:00:25 +02:00
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)
}
}
2018-07-24 14:35:11 +02:00
throw new Error('Duration could not be properly parsed')
2018-07-21 23:00:25 +02:00
}
2017-12-12 17:53:50 +01:00
function resetSequelizeInstance (instance: Model<any>, savedFields: object) {
2017-10-25 11:55:06 +02:00
Object.keys(savedFields).forEach(key => {
const value = savedFields[key]
instance.set(key, value)
})
}
2017-12-14 17:38:41 +01:00
let serverActor: ActorModel
async function getServerActor () {
if (serverActor === undefined) {
const application = await ApplicationModel.load()
2018-07-26 10:45:10 +02:00
if (!application) throw Error('Could not load Application from database.')
2017-12-14 17:38:41 +01:00
serverActor = application.Account.Actor
2017-11-13 17:39:41 +01:00
}
2017-12-14 17:38:41 +01:00
if (!serverActor) {
logger.error('Cannot load server actor.')
process.exit(0)
}
2017-12-14 17:38:41 +01:00
return Promise.resolve(serverActor)
2017-11-13 17:39:41 +01:00
}
2018-08-07 09:54:36 +02:00
function generateVideoTmpPath (target: string | ParseTorrent) {
const id = typeof target === 'string' ? target : target.infoHash
const hash = sha256(id)
2018-08-06 17:13:39 +02:00
return join(CONFIG.STORAGE.VIDEOS_DIR, hash + '-import.mp4')
}
2018-08-07 09:54:36 +02:00
function getSecureTorrentName (originalName: string) {
return sha256(originalName) + '.torrent'
}
Handle blacklist (#84) * Client: Add list blacklist feature * Server: Add list blacklist feature * Client: Add videoId column * Server: Add some video infos in the REST api * Client: Add video information in the blacklist list * Fix sortable columns :) * Client: Add removeFromBlacklist feature * Server: Add removeFromBlacklist feature * Move to TypeScript * Move to TypeScript and Promises * Server: Fix blacklist list sort * Server: Fetch videos informations * Use common shared interface for client and server * Add check-params remove blacklisted video tests * Add check-params list blacklisted videos tests * Add list blacklist tests * Add remove from blacklist tests * Add video blacklist management tests * Fix rebase onto develop issues * Server: Add sort on blacklist id column * Server: Add blacklists library * Add blacklist id sort test * Add check-params tests for blacklist list pagination, count and sort * Fix coding style * Increase Remote API tests timeout * Increase Request scheduler API tests timeout * Fix typo * Increase video transcoding API tests timeout * Move tests to Typescript * Use lodash orderBy method * Fix typos * Client: Remove optional tests in blacklist model attributes * Move blacklist routes from 'blacklists' to 'blacklist' * CLient: Remove blacklist-list.component.scss * Rename 'blacklists' files to 'blacklist' * Use only BlacklistedVideo interface * Server: Use getFormattedObjects method in listBlacklist method * Client: Use new coding style * Server: Use new sort validator methods * Server: Use new checkParams methods * Client: Fix sortable columns
2017-09-22 09:13:43 +02:00
2018-08-07 09:54:36 +02:00
type SortType = { sortModel: any, sortValue: string }
2018-08-06 17:13:39 +02:00
// ---------------------------------------------------------------------------
2016-01-31 11:23:52 +01:00
2017-05-15 22:22:03 +02:00
export {
2018-07-31 15:09:34 +02:00
cleanUpReqFiles,
deleteFileAsync,
2017-05-15 22:22:03 +02:00
generateRandomString,
2017-08-25 11:45:31 +02:00
getFormattedObjects,
Handle blacklist (#84) * Client: Add list blacklist feature * Server: Add list blacklist feature * Client: Add videoId column * Server: Add some video infos in the REST api * Client: Add video information in the blacklist list * Fix sortable columns :) * Client: Add removeFromBlacklist feature * Server: Add removeFromBlacklist feature * Move to TypeScript * Move to TypeScript and Promises * Server: Fix blacklist list sort * Server: Fetch videos informations * Use common shared interface for client and server * Add check-params remove blacklisted video tests * Add check-params list blacklisted videos tests * Add list blacklist tests * Add remove from blacklist tests * Add video blacklist management tests * Fix rebase onto develop issues * Server: Add sort on blacklist id column * Server: Add blacklists library * Add blacklist id sort test * Add check-params tests for blacklist list pagination, count and sort * Fix coding style * Increase Remote API tests timeout * Increase Request scheduler API tests timeout * Fix typo * Increase video transcoding API tests timeout * Move tests to Typescript * Use lodash orderBy method * Fix typos * Client: Remove optional tests in blacklist model attributes * Move blacklist routes from 'blacklists' to 'blacklist' * CLient: Remove blacklist-list.component.scss * Rename 'blacklists' files to 'blacklist' * Use only BlacklistedVideo interface * Server: Use getFormattedObjects method in listBlacklist method * Client: Use new coding style * Server: Use new sort validator methods * Server: Use new checkParams methods * Client: Fix sortable columns
2017-09-22 09:13:43 +02:00
isSignupAllowed,
2018-08-07 09:54:36 +02:00
getSecureTorrentName,
isSignupAllowedForCurrentIP,
computeResolutionsToTranscode,
2017-10-25 11:55:06 +02:00
resetSequelizeInstance,
2017-12-14 17:38:41 +01:00
getServerActor,
2018-08-06 17:13:39 +02:00
SortType,
generateVideoTmpPath
2017-05-15 22:22:03 +02:00
}