PeerTube/server/lib/redis.ts

335 lines
8.8 KiB
TypeScript
Raw Normal View History

2018-04-17 14:01:06 +02:00
import * as express from 'express'
2018-01-30 13:27:07 +01:00
import { createClient, RedisClient } from 'redis'
import { logger } from '../helpers/logger'
import { generateRandomString } from '../helpers/utils'
2019-01-09 15:14:29 +01:00
import {
CONTACT_FORM_LIFETIME,
USER_EMAIL_VERIFY_LIFETIME,
USER_PASSWORD_RESET_LIFETIME,
2019-04-11 11:33:44 +02:00
VIDEO_VIEW_LIFETIME,
WEBSERVER
} from '../initializers/constants'
2019-04-11 11:33:44 +02:00
import { CONFIG } from '../initializers/config'
2018-04-17 14:01:06 +02:00
type CachedRoute = {
2020-01-31 16:56:52 +01:00
body: string
2018-07-26 10:45:10 +02:00
contentType?: string
statusCode?: string
2018-04-17 14:01:06 +02:00
}
2018-01-30 13:27:07 +01:00
class Redis {
private static instance: Redis
private initialized = false
private client: RedisClient
private prefix: string
2020-01-31 16:56:52 +01:00
private constructor () {
}
2018-01-30 13:27:07 +01:00
init () {
// Already initialized
if (this.initialized === true) return
this.initialized = true
this.client = createClient(Redis.getRedisClientOptions())
2018-01-30 13:27:07 +01:00
this.client.on('error', err => {
2018-03-26 15:54:13 +02:00
logger.error('Error in Redis client.', { err })
2018-01-30 13:27:07 +01:00
process.exit(-1)
})
if (CONFIG.REDIS.AUTH) {
this.client.auth(CONFIG.REDIS.AUTH)
}
2019-04-11 11:33:44 +02:00
this.prefix = 'redis-' + WEBSERVER.HOST + '-'
2018-01-30 13:27:07 +01:00
}
static getRedisClientOptions () {
2018-05-14 17:51:15 +02:00
return Object.assign({},
(CONFIG.REDIS.AUTH && CONFIG.REDIS.AUTH != null) ? { password: CONFIG.REDIS.AUTH } : {},
(CONFIG.REDIS.DB) ? { db: CONFIG.REDIS.DB } : {},
2020-01-31 16:56:52 +01:00
(CONFIG.REDIS.HOSTNAME && CONFIG.REDIS.PORT)
? { host: CONFIG.REDIS.HOSTNAME, port: CONFIG.REDIS.PORT }
: { path: CONFIG.REDIS.SOCKET }
2018-05-14 17:51:15 +02:00
)
}
getClient () {
return this.client
}
getPrefix () {
return this.prefix
}
2020-01-31 16:56:52 +01:00
/* ************ Forgot password ************ */
2018-10-05 11:15:06 +02:00
2018-01-30 13:27:07 +01:00
async setResetPasswordVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
await this.setValue(this.generateResetPasswordKey(userId), generatedString, USER_PASSWORD_RESET_LIFETIME)
return generatedString
}
async getResetPasswordLink (userId: number) {
return this.getValue(this.generateResetPasswordKey(userId))
}
2020-01-31 16:56:52 +01:00
/* ************ Email verification ************ */
2018-10-05 11:15:06 +02:00
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))
}
2020-01-31 16:56:52 +01:00
/* ************ Contact form per IP ************ */
2019-01-09 15:14:29 +01:00
async setContactFormIp (ip: string) {
return this.setValue(this.generateContactFormKey(ip), '1', CONTACT_FORM_LIFETIME)
}
2019-03-19 09:26:50 +01:00
async doesContactFormIpExist (ip: string) {
2019-01-09 15:14:29 +01:00
return this.exists(this.generateContactFormKey(ip))
}
2020-01-31 16:56:52 +01:00
/* ************ Views per IP ************ */
2018-10-05 11:15:06 +02:00
2018-08-29 16:26:25 +02:00
setIPVideoView (ip: string, videoUUID: string) {
2018-10-05 11:15:06 +02:00
return this.setValue(this.generateViewKey(ip, videoUUID), '1', VIDEO_VIEW_LIFETIME)
2018-02-23 16:39:51 +01:00
}
2019-03-19 09:26:50 +01:00
async doesVideoIPViewExist (ip: string, videoUUID: string) {
2018-10-05 11:15:06 +02:00
return this.exists(this.generateViewKey(ip, videoUUID))
2018-02-23 16:39:51 +01:00
}
2020-01-31 16:56:52 +01:00
/* ************ API cache ************ */
2018-10-05 11:15:06 +02:00
2018-04-17 14:01:06 +02:00
async getCachedRoute (req: express.Request) {
2018-10-05 11:15:06 +02:00
const cached = await this.getObject(this.generateCachedRouteKey(req))
2018-04-17 14:01:06 +02:00
return cached as CachedRoute
}
2018-05-11 09:44:04 +02:00
setCachedRoute (req: express.Request, body: any, lifetime: number, contentType?: string, statusCode?: number) {
2020-01-31 16:56:52 +01:00
const cached: CachedRoute = Object.assign(
{},
{ body: body.toString() },
(contentType) ? { contentType } : null,
(statusCode) ? { statusCode: statusCode.toString() } : null
)
2018-04-17 14:01:06 +02:00
2018-10-05 11:15:06 +02:00
return this.setObject(this.generateCachedRouteKey(req), cached, lifetime)
2018-04-17 14:01:06 +02:00
}
2020-01-31 16:56:52 +01:00
/* ************ Video views ************ */
2018-10-05 11:15:06 +02:00
2018-08-29 16:26:25 +02:00
addVideoView (videoId: number) {
const keyIncr = this.generateVideoViewKey(videoId)
const keySet = this.generateVideosViewKey()
return Promise.all([
this.addToSet(keySet, videoId.toString()),
this.increment(keyIncr)
])
}
async getVideoViews (videoId: number, hour: number) {
const key = this.generateVideoViewKey(videoId, hour)
const valueString = await this.getValue(key)
2018-12-04 16:02:49 +01:00
const valueInt = parseInt(valueString, 10)
if (isNaN(valueInt)) {
logger.error('Cannot get videos views of video %d in hour %d: views number is NaN (%s).', videoId, hour, valueString)
return undefined
}
return valueInt
2018-08-29 16:26:25 +02:00
}
async getVideosIdViewed (hour: number) {
const key = this.generateVideosViewKey(hour)
const stringIds = await this.getSet(key)
return stringIds.map(s => parseInt(s, 10))
}
deleteVideoViews (videoId: number, hour: number) {
const keySet = this.generateVideosViewKey(hour)
const keyIncr = this.generateVideoViewKey(videoId, hour)
return Promise.all([
this.deleteFromSet(keySet, videoId.toString()),
this.deleteKey(keyIncr)
])
}
2020-01-31 16:56:52 +01:00
/* ************ Keys generation ************ */
2018-10-05 11:15:06 +02:00
generateCachedRouteKey (req: express.Request) {
return req.method + '-' + req.originalUrl
}
private generateVideosViewKey (hour?: number) {
2018-08-29 16:26:25 +02:00
if (!hour) hour = new Date().getHours()
return `videos-view-h${hour}`
}
2018-10-05 11:15:06 +02:00
private generateVideoViewKey (videoId: number, hour?: number) {
2018-08-29 16:26:25 +02:00
if (!hour) hour = new Date().getHours()
return `video-view-${videoId}-h${hour}`
}
2018-10-05 11:15:06 +02:00
private generateResetPasswordKey (userId: number) {
return 'reset-password-' + userId
}
2018-10-05 11:15:06 +02:00
private generateVerifyEmailKey (userId: number) {
return 'verify-email-' + userId
}
2018-10-05 11:15:06 +02:00
private generateViewKey (ip: string, videoUUID: string) {
2019-01-09 15:14:29 +01:00
return `views-${videoUUID}-${ip}`
}
private generateContactFormKey (ip: string) {
return 'contact-form-' + ip
}
2020-01-31 16:56:52 +01:00
/* ************ Redis helpers ************ */
2018-01-30 13:27:07 +01:00
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)
})
})
}
2018-08-29 16:26:25 +02:00
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<string[]>((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())
})
}
2018-10-05 11:15:06 +02:00
private deleteFieldInHash (key: string, field: string) {
return new Promise<void>((res, rej) => {
this.client.hdel(this.prefix + key, field, err => err ? rej(err) : res())
})
}
2018-01-30 13:27:07 +01:00
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)
2018-04-17 14:01:06 +02:00
if (ok !== 'OK') return rej(new Error('Redis set result is not OK.'))
2018-01-30 13:27:07 +01:00
return res()
})
})
}
2020-01-31 16:56:52 +01:00
private setObject (key: string, obj: { [id: string]: string }, expirationMilliseconds: number) {
2018-04-17 14:01:06 +02:00
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) {
2020-01-31 16:56:52 +01:00
return new Promise<{ [id: string]: string }>((res, rej) => {
2018-04-17 14:01:06 +02:00
this.client.hgetall(this.prefix + key, (err, value) => {
if (err) return rej(err)
return res(value)
})
})
}
2018-10-05 11:15:06 +02:00
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()
})
})
}
2018-08-29 16:26:25 +02:00
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)
})
})
}
2018-02-23 16:39:51 +01:00
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)
})
})
}
2018-01-30 13:27:07 +01:00
static get Instance () {
return this.instance || (this.instance = new this())
}
}
// ---------------------------------------------------------------------------
export {
Redis
}