-import * as express from 'express'
-import { createClient, RedisClient } from 'redis'
+import IoRedis, { RedisOptions } from 'ioredis'
+import { exists } from '@server/helpers/custom-validators/misc'
+import { sha256 } from '@shared/extra-utils'
import { logger } from '../helpers/logger'
import { generateRandomString } from '../helpers/utils'
-import { CONFIG, USER_PASSWORD_RESET_LIFETIME, USER_EMAIL_VERIFY_LIFETIME, VIDEO_VIEW_LIFETIME } from '../initializers'
-
-type CachedRoute = {
- body: string,
- contentType?: string
- statusCode?: string
-}
+import { CONFIG } from '../initializers/config'
+import {
+ AP_CLEANER,
+ CONTACT_FORM_LIFETIME,
+ RESUMABLE_UPLOAD_SESSION_LIFETIME,
+ TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME,
+ EMAIL_VERIFY_LIFETIME,
+ USER_PASSWORD_CREATE_LIFETIME,
+ USER_PASSWORD_RESET_LIFETIME,
+ VIEW_LIFETIME,
+ WEBSERVER
+} from '../initializers/constants'
class Redis {
private static instance: Redis
private initialized = false
- private client: RedisClient
+ private connected = false
+ private client: IoRedis
private prefix: string
- private constructor () {}
+ private constructor () {
+ }
init () {
// Already initialized
if (this.initialized === true) return
this.initialized = true
- this.client = createClient(Redis.getRedisClient())
+ logger.info('Connecting to redis...')
+
+ this.client = new IoRedis(Redis.getRedisClientOptions('', { enableAutoPipelining: true }))
+ this.client.on('error', err => logger.error('Redis failed to connect', { err }))
+ this.client.on('connect', () => {
+ logger.info('Connected to redis.')
+
+ this.connected = true
+ })
+ this.client.on('reconnecting', (ms) => {
+ logger.error(`Reconnecting to redis in ${ms}.`)
+ })
+ this.client.on('close', () => {
+ logger.error('Connection to redis has closed.')
+ this.connected = false
+ })
- this.client.on('error', err => {
- logger.error('Error in Redis client.', { err })
- process.exit(-1)
+ this.client.on('end', () => {
+ logger.error('Connection to redis has closed and no more reconnects will be done.')
})
- if (CONFIG.REDIS.AUTH) {
- this.client.auth(CONFIG.REDIS.AUTH)
+ this.prefix = 'redis-' + WEBSERVER.HOST + '-'
+ }
+
+ static getRedisClientOptions (connectionName?: string, options: RedisOptions = {}): RedisOptions {
+ return {
+ connectionName: [ 'PeerTube', connectionName ].join(''),
+ connectTimeout: 20000, // Could be slow since node use sync call to compile PeerTube
+ password: CONFIG.REDIS.AUTH,
+ db: CONFIG.REDIS.DB,
+ host: CONFIG.REDIS.HOSTNAME,
+ port: CONFIG.REDIS.PORT,
+ path: CONFIG.REDIS.SOCKET,
+ showFriendlyErrorStack: true,
+ ...options
}
+ }
- this.prefix = 'redis-' + CONFIG.WEBSERVER.HOST + '-'
+ getClient () {
+ return this.client
}
- static getRedisClient () {
- 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 }
- )
+ getPrefix () {
+ return this.prefix
}
- /************* Forgot password *************/
+ isConnected () {
+ return this.connected
+ }
+
+ /* ************ Forgot password ************ */
async setResetPasswordVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
return generatedString
}
- async getResetPasswordLink (userId: number) {
+ 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 getResetPasswordVerificationString (userId: number) {
return this.getValue(this.generateResetPasswordKey(userId))
}
- /************* Email verification *************/
+ /* ************ Two factor auth request ************ */
+
+ async setTwoFactorRequest (userId: number, otpSecret: string) {
+ const requestToken = await generateRandomString(32)
+
+ await this.setValue(this.generateTwoFactorRequestKey(userId, requestToken), otpSecret, TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME)
- async setVerifyEmailVerificationString (userId: number) {
+ return requestToken
+ }
+
+ async getTwoFactorRequestToken (userId: number, requestToken: string) {
+ return this.getValue(this.generateTwoFactorRequestKey(userId, requestToken))
+ }
+
+ /* ************ Email verification ************ */
+
+ async setUserVerifyEmailVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
- await this.setValue(this.generateVerifyEmailKey(userId), generatedString, USER_EMAIL_VERIFY_LIFETIME)
+ await this.setValue(this.generateUserVerifyEmailKey(userId), generatedString, EMAIL_VERIFY_LIFETIME)
return generatedString
}
- async getVerifyEmailLink (userId: number) {
- return this.getValue(this.generateVerifyEmailKey(userId))
+ async getUserVerifyEmailLink (userId: number) {
+ return this.getValue(this.generateUserVerifyEmailKey(userId))
}
- /************* Views per IP *************/
+ async setRegistrationVerifyEmailVerificationString (registrationId: number) {
+ const generatedString = await generateRandomString(32)
+
+ await this.setValue(this.generateRegistrationVerifyEmailKey(registrationId), generatedString, EMAIL_VERIFY_LIFETIME)
+
+ return generatedString
+ }
+
+ async getRegistrationVerifyEmailLink (registrationId: number) {
+ return this.getValue(this.generateRegistrationVerifyEmailKey(registrationId))
+ }
+
+ /* ************ 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.generateViewKey(ip, videoUUID), '1', VIDEO_VIEW_LIFETIME)
+ return this.setValue(this.generateIPViewKey(ip, videoUUID), '1', VIEW_LIFETIME.VIEW)
}
- async isVideoIPViewExists (ip: string, videoUUID: string) {
- return this.exists(this.generateViewKey(ip, videoUUID))
+ async doesVideoIPViewExist (ip: string, videoUUID: string) {
+ return this.exists(this.generateIPViewKey(ip, videoUUID))
}
- /************* API cache *************/
+ /* ************ Video views stats ************ */
- async getCachedRoute (req: express.Request) {
- const cached = await this.getObject(this.generateCachedRouteKey(req))
+ addVideoViewStats (videoId: number) {
+ const { videoKey, setKey } = this.generateVideoViewStatsKeys({ videoId })
- return cached as CachedRoute
+ return Promise.all([
+ this.addToSet(setKey, videoId.toString()),
+ this.increment(videoKey)
+ ])
}
- 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
- )
+ async getVideoViewsStats (videoId: number, hour: number) {
+ const { videoKey } = this.generateVideoViewStatsKeys({ videoId, hour })
+
+ const valueString = await this.getValue(videoKey)
+ const valueInt = parseInt(valueString, 10)
- return this.setObject(this.generateCachedRouteKey(req), cached, lifetime)
+ 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
}
- /************* Video views *************/
+ async listVideosViewedForStats (hour: number) {
+ const { setKey } = this.generateVideoViewStatsKeys({ hour })
+
+ const stringIds = await this.getSet(setKey)
+ return stringIds.map(s => parseInt(s, 10))
+ }
- addVideoView (videoId: number) {
- const keyIncr = this.generateVideoViewKey(videoId)
- const keySet = this.generateVideosViewKey()
+ deleteVideoViewsStats (videoId: number, hour: number) {
+ const { setKey, videoKey } = this.generateVideoViewStatsKeys({ videoId, hour })
return Promise.all([
- this.addToSet(keySet, videoId.toString()),
- this.increment(keyIncr)
+ this.deleteFromSet(setKey, videoId.toString()),
+ this.deleteKey(videoKey)
])
}
- async getVideoViews (videoId: number, hour: number) {
- const key = this.generateVideoViewKey(videoId, hour)
+ /* ************ Local video views buffer ************ */
+
+ addLocalVideoView (videoId: number) {
+ const { videoKey, setKey } = this.generateLocalVideoViewsKeys(videoId)
- const valueString = await this.getValue(key)
- return parseInt(valueString, 10)
+ return Promise.all([
+ this.addToSet(setKey, videoId.toString()),
+ this.increment(videoKey)
+ ])
}
- async getVideosIdViewed (hour: number) {
- const key = this.generateVideosViewKey(hour)
+ async getLocalVideoViews (videoId: number) {
+ const { videoKey } = this.generateLocalVideoViewsKeys(videoId)
- const stringIds = await this.getSet(key)
+ 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))
}
- deleteVideoViews (videoId: number, hour: number) {
- const keySet = this.generateVideosViewKey(hour)
- const keyIncr = this.generateVideoViewKey(videoId, hour)
+ deleteLocalVideoViews (videoId: number) {
+ const { setKey, videoKey } = this.generateLocalVideoViewsKeys(videoId)
+
+ return Promise.all([
+ this.deleteFromSet(setKey, videoId.toString()),
+ this.deleteKey(videoKey)
+ ])
+ }
+
+ /* ************ Video viewers stats ************ */
+
+ getLocalVideoViewer (options: {
+ key?: string
+ // Or
+ ip?: string
+ videoId?: number
+ }) {
+ if (options.key) return this.getObject(options.key)
+
+ const { viewerKey } = this.generateLocalVideoViewerKeys(options.ip, options.videoId)
+
+ return this.getObject(viewerKey)
+ }
+
+ setLocalVideoViewer (ip: string, videoId: number, object: any) {
+ const { setKey, viewerKey } = this.generateLocalVideoViewerKeys(ip, videoId)
return Promise.all([
- this.deleteFromSet(keySet, videoId.toString()),
- this.deleteKey(keyIncr)
+ this.addToSet(setKey, viewerKey),
+ this.setObject(viewerKey, object)
])
}
- /************* Keys generation *************/
+ listLocalVideoViewerKeys () {
+ const { setKey } = this.generateLocalVideoViewerKeys()
- generateCachedRouteKey (req: express.Request) {
- return req.method + '-' + req.originalUrl
+ return this.getSet(setKey)
}
- private generateVideosViewKey (hour?: number) {
- if (!hour) hour = new Date().getHours()
+ deleteLocalVideoViewersKeys (key: string) {
+ const { setKey } = this.generateLocalVideoViewerKeys()
- return `videos-view-h${hour}`
+ return Promise.all([
+ this.deleteFromSet(setKey, key),
+ this.deleteKey(key)
+ ])
}
- private generateVideoViewKey (videoId: number, hour?: number) {
- if (!hour) hour = new Date().getHours()
+ /* ************ Resumable uploads final responses ************ */
- return `video-view-${videoId}-h${hour}`
+ 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
+ )
}
- private generateResetPasswordKey (userId: number) {
- return 'reset-password-' + userId
+ doesUploadSessionExist (uploadId: string) {
+ return this.exists('resumable-upload-' + uploadId)
}
- private generateVerifyEmailKey (userId: number) {
- return 'verify-email-' + userId
+ async getUploadSession (uploadId: string) {
+ const value = await this.getValue('resumable-upload-' + uploadId)
+
+ return value
+ ? JSON.parse(value)
+ : ''
}
- private generateViewKey (ip: string, videoUUID: string) {
- return videoUUID + '-' + ip
+ deleteUploadSession (uploadId: string) {
+ return this.deleteKey('resumable-upload-' + uploadId)
}
- /************* Redis helpers *************/
+ /* ************ AP resource unavailability ************ */
- private getValue (key: string) {
- return new Promise<string>((res, rej) => {
- this.client.get(this.prefix + key, (err, value) => {
- if (err) return rej(err)
+ async addAPUnavailability (url: string) {
+ const key = this.generateAPUnavailabilityKey(url)
- return res(value)
- })
- })
+ const value = await this.increment(key)
+ await this.setExpiration(key, AP_CLEANER.PERIOD * 2)
+
+ return value
}
- private getSet (key: string) {
- return new Promise<string[]>((res, rej) => {
- this.client.smembers(this.prefix + key, (err, value) => {
- if (err) return rej(err)
+ /* ************ Keys generation ************ */
- return res(value)
- })
- })
+ private generateLocalVideoViewsKeys (videoId: number): { setKey: string, videoKey: string }
+ private generateLocalVideoViewsKeys (): { setKey: string }
+ private generateLocalVideoViewsKeys (videoId?: number) {
+ return { setKey: `local-video-views-buffer`, videoKey: `local-video-views-buffer-${videoId}` }
}
- 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 generateLocalVideoViewerKeys (ip: string, videoId: number): { setKey: string, viewerKey: string }
+ private generateLocalVideoViewerKeys (): { setKey: string }
+ private generateLocalVideoViewerKeys (ip?: string, videoId?: number) {
+ return { setKey: `local-video-viewer-stats-keys`, viewerKey: `local-video-viewer-stats-${ip}-${videoId}` }
}
- 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 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 deleteKey (key: string) {
- return new Promise<void>((res, rej) => {
- this.client.del(this.prefix + key, err => err ? rej(err) : res())
- })
+ private generateResetPasswordKey (userId: number) {
+ return 'reset-password-' + userId
}
- 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 generateTwoFactorRequestKey (userId: number, token: string) {
+ return 'two-factor-request-' + userId + '-' + token
}
- 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)
+ private generateUserVerifyEmailKey (userId: number) {
+ return 'verify-email-user-' + userId
+ }
- if (ok !== 'OK') return rej(new Error('Redis set result is not OK.'))
+ private generateRegistrationVerifyEmailKey (registrationId: number) {
+ return 'verify-email-registration-' + registrationId
+ }
- return res()
- })
- })
+ private generateIPViewKey (ip: string, videoUUID: string) {
+ return `views-${videoUUID}-${ip}`
+ }
+
+ private generateContactFormKey (ip: string) {
+ return 'contact-form-' + ip
}
- 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.'))
+ private generateAPUnavailabilityKey (url: string) {
+ return 'ap-unavailability-' + sha256(url)
+ }
- 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.'))
+ /* ************ Redis helpers ************ */
- return res()
- })
- })
- })
+ private getValue (key: string) {
+ return this.client.get(this.prefix + key)
}
- 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)
+ private getSet (key: string) {
+ return this.client.smembers(this.prefix + key)
+ }
- return res(value)
- })
- })
+ private addToSet (key: string, value: string) {
+ return this.client.sadd(this.prefix + key, 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)
+ private deleteFromSet (key: string, value: string) {
+ return this.client.srem(this.prefix + key, value)
+ }
- return res()
- })
- })
+ private deleteKey (key: string) {
+ return this.client.del(this.prefix + key)
}
- private increment (key: string) {
- return new Promise<number>((res, rej) => {
- this.client.incr(this.prefix + key, (err, value) => {
- if (err) return rej(err)
+ private async getObject (key: string) {
+ const value = await this.getValue(key)
+ if (!value) return null
- return res(value)
- })
- })
+ return JSON.parse(value)
}
- private exists (key: string) {
- return new Promise<boolean>((res, rej) => {
- this.client.exists(this.prefix + key, (err, existsNumber) => {
- if (err) return rej(err)
+ private setObject (key: string, value: { [ id: string ]: number | string }, expirationMilliseconds?: number) {
+ return this.setValue(key, JSON.stringify(value), expirationMilliseconds)
+ }
- return res(existsNumber === 1)
- })
- })
+ private async setValue (key: string, value: string, expirationMilliseconds?: number) {
+ const result = expirationMilliseconds !== undefined
+ ? await this.client.set(this.prefix + key, value, 'PX', expirationMilliseconds)
+ : await this.client.set(this.prefix + key, value)
+
+ if (result !== 'OK') throw new Error('Redis set result is not OK.')
+ }
+
+ private removeValue (key: string) {
+ return this.client.del(this.prefix + key)
+ }
+
+ private increment (key: string) {
+ return this.client.incr(this.prefix + key)
+ }
+
+ private async exists (key: string) {
+ const result = await this.client.exists(this.prefix + key)
+
+ return result !== 0
+ }
+
+ private setExpiration (key: string, ms: number) {
+ return this.client.expire(this.prefix + key, ms / 1000)
}
static get Instance () {
projects / github / Chocobozzz / PeerTube.git / blobdiff