import express from 'express'
import { createClient, RedisClient } from 'redis'
import { logger } from '../helpers/logger'
import { generateRandomString } from '../helpers/utils'
import {
CONTACT_FORM_LIFETIME,
USER_EMAIL_VERIFY_LIFETIME,
USER_PASSWORD_RESET_LIFETIME,
USER_PASSWORD_CREATE_LIFETIME,
VIEW_LIFETIME,
WEBSERVER,
TRACKER_RATE_LIMITS,
RESUMABLE_UPLOAD_SESSION_LIFETIME
} from '../initializers/constants'
import { CONFIG } from '../initializers/config'
import { exists } from '@server/helpers/custom-validators/misc'
type CachedRoute = {
body: string
contentType?: string
statusCode?: string
}
class Redis {
private static instance: Redis
private initialized = false
private client: RedisClient
private prefix: string
private constructor () {
}
init () {
// Already initialized
if (this.initialized === true) return
this.initialized = true
this.client = createClient(Redis.getRedisClientOptions())
this.client.on('error', err => {
logger.error('Error in Redis client.', { err })
process.exit(-1)
})
if (CONFIG.REDIS.AUTH) {
this.client.auth(CONFIG.REDIS.AUTH)
}
this.prefix = 'redis-' + WEBSERVER.HOST + '-'
}
static getRedisClientOptions () {
return Object.assign({},
(CONFIG.REDIS.AUTH && CONFIG.REDIS.AUTH != null) ? { password: CONFIG.REDIS.AUTH } : {},
(CONFIG.REDIS.DB) ? { db: CONFIG.REDIS.DB } : {},
(CONFIG.REDIS.HOSTNAME && CONFIG.REDIS.PORT)
? { host: CONFIG.REDIS.HOSTNAME, port: CONFIG.REDIS.PORT }
: { path: CONFIG.REDIS.SOCKET }
)
}
getClient () {
return this.client
}
getPrefix () {
return this.prefix
}
/* ************ Forgot password ************ */
async setResetPasswordVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
await this.setValue(this.generateResetPasswordKey(userId), generatedString, USER_PASSWORD_RESET_LIFETIME)
return generatedString
}
async setCreatePasswordVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
await this.setValue(this.generateResetPasswordKey(userId), generatedString, USER_PASSWORD_CREATE_LIFETIME)
return generatedString
}
async removePasswordVerificationString (userId: number) {
return this.removeValue(this.generateResetPasswordKey(userId))
}
async getResetPasswordLink (userId: number) {
return this.getValue(this.generateResetPasswordKey(userId))
}
/* ************ Email verification ************ */
async setVerifyEmailVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
await this.setValue(this.generateVerifyEmailKey(userId), generatedString, USER_EMAIL_VERIFY_LIFETIME)
return generatedString
}
async getVerifyEmailLink (userId: number) {
return this.getValue(this.generateVerifyEmailKey(userId))
}
/* ************ Contact form per IP ************ */
async setContactFormIp (ip: string) {
return this.setValue(this.generateContactFormKey(ip), '1', CONTACT_FORM_LIFETIME)
}
async doesContactFormIpExist (ip: string) {
return this.exists(this.generateContactFormKey(ip))
}
/* ************ Views per IP ************ */
setIPVideoView (ip: string, videoUUID: string) {
return this.setValue(this.generateIPViewKey(ip, videoUUID), '1', VIEW_LIFETIME.VIEW)
}
setIPVideoViewer (ip: string, videoUUID: string) {
return this.setValue(this.generateIPViewerKey(ip, videoUUID), '1', VIEW_LIFETIME.VIEWER)
}
async doesVideoIPViewExist (ip: string, videoUUID: string) {
return this.exists(this.generateIPViewKey(ip, videoUUID))
}
async doesVideoIPViewerExist (ip: string, videoUUID: string) {
return this.exists(this.generateIPViewerKey(ip, videoUUID))
}
/* ************ Tracker IP block ************ */
setTrackerBlockIP (ip: string) {
return this.setValue(this.generateTrackerBlockIPKey(ip), '1', TRACKER_RATE_LIMITS.BLOCK_IP_LIFETIME)
}
async doesTrackerBlockIPExist (ip: string) {
return this.exists(this.generateTrackerBlockIPKey(ip))
}
/* ************ API cache ************ */
async getCachedRoute (req: express.Request) {
const cached = await this.getObject(this.generateCachedRouteKey(req))
return cached as CachedRoute
}
setCachedRoute (req: express.Request, body: any, lifetime: number, contentType?: string, statusCode?: number) {
const cached: CachedRoute = Object.assign(
{},
{ body: body.toString() },
(contentType) ? { contentType } : null,
(statusCode) ? { statusCode: statusCode.toString() } : null
)
return this.setObject(this.generateCachedRouteKey(req), cached, lifetime)
}
/* ************ Video views stats ************ */
addVideoViewStats (videoId: number) {
const { videoKey, setKey } = this.generateVideoViewStatsKeys({ videoId })
return Promise.all([
this.addToSet(setKey, videoId.toString()),
this.increment(videoKey)
])
}
async getVideoViewsStats (videoId: number, hour: number) {
const { videoKey } = this.generateVideoViewStatsKeys({ videoId, hour })
const valueString = await this.getValue(videoKey)
const valueInt = parseInt(valueString, 10)
if (isNaN(valueInt)) {
logger.error('Cannot get videos views stats of video %d in hour %d: views number is NaN (%s).', videoId, hour, valueString)
return undefined
}
return valueInt
}
async listVideosViewedForStats (hour: number) {
const { setKey } = this.generateVideoViewStatsKeys({ hour })
const stringIds = await this.getSet(setKey)
return stringIds.map(s => parseInt(s, 10))
}
deleteVideoViewsStats (videoId: number, hour: number) {
const { setKey, videoKey } = this.generateVideoViewStatsKeys({ videoId, hour })
return Promise.all([
this.deleteFromSet(setKey, videoId.toString()),
this.deleteKey(videoKey)
])
}
/* ************ Local video views buffer ************ */
addLocalVideoView (videoId: number) {
const { videoKey, setKey } = this.generateLocalVideoViewsKeys(videoId)
return Promise.all([
this.addToSet(setKey, videoId.toString()),
this.increment(videoKey)
])
}
async getLocalVideoViews (videoId: number) {
const { videoKey } = this.generateLocalVideoViewsKeys(videoId)
const valueString = await this.getValue(videoKey)
const valueInt = parseInt(valueString, 10)
if (isNaN(valueInt)) {
logger.error('Cannot get videos views of video %d: views number is NaN (%s).', videoId, valueString)
return undefined
}
return valueInt
}
async listLocalVideosViewed () {
const { setKey } = this.generateLocalVideoViewsKeys()
const stringIds = await this.getSet(setKey)
return stringIds.map(s => parseInt(s, 10))
}
deleteLocalVideoViews (videoId: number) {
const { setKey, videoKey } = this.generateLocalVideoViewsKeys(videoId)
return Promise.all([
this.deleteFromSet(setKey, videoId.toString()),
this.deleteKey(videoKey)
])
}
/* ************ Resumable uploads final responses ************ */
setUploadSession (uploadId: string, response?: { video: { id: number, shortUUID: string, uuid: string } }) {
return this.setValue(
'resumable-upload-' + uploadId,
response
? JSON.stringify(response)
: '',
RESUMABLE_UPLOAD_SESSION_LIFETIME
)
}
doesUploadSessionExist (uploadId: string) {
return this.exists('resumable-upload-' + uploadId)
}
async getUploadSession (uploadId: string) {
const value = await this.getValue('resumable-upload-' + uploadId)
return value
? JSON.parse(value)
: ''
}
deleteUploadSession (uploadId: string) {
return this.deleteKey('resumable-upload-' + uploadId)
}
/* ************ Keys generation ************ */
generateCachedRouteKey (req: express.Request) {
return req.method + '-' + req.originalUrl
}
private generateLocalVideoViewsKeys (videoId?: Number) {
return { setKey: `local-video-views-buffer`, videoKey: `local-video-views-buffer-${videoId}` }
}
private generateVideoViewStatsKeys (options: { videoId?: number, hour?: number }) {
const hour = exists(options.hour)
? options.hour
: new Date().getHours()
return { setKey: `videos-view-h${hour}`, videoKey: `video-view-${options.videoId}-h${hour}` }
}
private generateResetPasswordKey (userId: number) {
return 'reset-password-' + userId
}
private generateVerifyEmailKey (userId: number) {
return 'verify-email-' + userId
}
private generateIPViewKey (ip: string, videoUUID: string) {
return `views-${videoUUID}-${ip}`
}
private generateIPViewerKey (ip: string, videoUUID: string) {
return `viewer-${videoUUID}-${ip}`
}
private generateTrackerBlockIPKey (ip: string) {
return `tracker-block-ip-${ip}`
}
private generateContactFormKey (ip: string) {
return 'contact-form-' + ip
}
/* ************ Redis helpers ************ */
private getValue (key: string) {
return new Promise<string>((res, rej) => {
this.client.get(this.prefix + key, (err, value) => {
if (err) return rej(err)
return res(value)
})
})
}
private getSet (key: string) {
return new Promise<string[]>((res, rej) => {
this.client.smembers(this.prefix + key, (err, value) => {
if (err) return rej(err)
return res(value)
})
})
}
private addToSet (key: string, value: string) {
return new Promise<void>((res, rej) => {
this.client.sadd(this.prefix + key, value, err => err ? rej(err) : res())
})
}
private deleteFromSet (key: string, value: string) {
return new Promise<void>((res, rej) => {
this.client.srem(this.prefix + key, value, err => err ? rej(err) : res())
})
}
private deleteKey (key: string) {
return new Promise<void>((res, rej) => {
this.client.del(this.prefix + key, err => err ? rej(err) : res())
})
}
private deleteFieldInHash (key: string, field: string) {
return new Promise<void>((res, rej) => {
this.client.hdel(this.prefix + key, field, err => err ? rej(err) : res())
})
}
private setValue (key: string, value: string, expirationMilliseconds: number) {
return new Promise<void>((res, rej) => {
this.client.set(this.prefix + key, value, 'PX', expirationMilliseconds, (err, ok) => {
if (err) return rej(err)
if (ok !== 'OK') return rej(new Error('Redis set result is not OK.'))
return res()
})
})
}
private removeValue (key: string) {
return new Promise<void>((res, rej) => {
this.client.del(this.prefix + key, err => {
if (err) return rej(err)
return res()
})
})
}
private setObject (key: string, obj: { [id: string]: string }, expirationMilliseconds: number) {
return new Promise<void>((res, rej) => {
this.client.hmset(this.prefix + key, obj, (err, ok) => {
if (err) return rej(err)
if (!ok) return rej(new Error('Redis mset result is not OK.'))
this.client.pexpire(this.prefix + key, expirationMilliseconds, (err, ok) => {
if (err) return rej(err)
if (!ok) return rej(new Error('Redis expiration result is not OK.'))
return res()
})
})
})
}
private getObject (key: string) {
return new Promise<{ [id: string]: string }>((res, rej) => {
this.client.hgetall(this.prefix + key, (err, value) => {
if (err) return rej(err)
return res(value)
})
})
}
private setValueInHash (key: string, field: string, value: string) {
return new Promise<void>((res, rej) => {
this.client.hset(this.prefix + key, field, value, (err) => {
if (err) return rej(err)
return res()
})
})
}
private increment (key: string) {
return new Promise<number>((res, rej) => {
this.client.incr(this.prefix + key, (err, value) => {
if (err) return rej(err)
return res(value)
})
})
}
private exists (key: string) {
return new Promise<boolean>((res, rej) => {
this.client.exists(this.prefix + key, (err, existsNumber) => {
if (err) return rej(err)
return res(existsNumber === 1)
})
})
}
static get Instance () {
return this.instance || (this.instance = new this())
}
}
// ---------------------------------------------------------------------------
export {
Redis
}