-import * as express from 'express'
+import express from 'express'
import { createClient, RedisClient } from 'redis'
import { logger } from '../helpers/logger'
import { generateRandomString } from '../helpers/utils'
CONTACT_FORM_LIFETIME,
USER_EMAIL_VERIFY_LIFETIME,
USER_PASSWORD_RESET_LIFETIME,
- VIDEO_VIEW_LIFETIME,
- WEBSERVER
+ 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,
+ body: string
contentType?: string
statusCode?: string
}
private client: RedisClient
private prefix: string
- private constructor () {}
+ private constructor () {
+ }
init () {
// Already initialized
if (this.initialized === true) return
this.initialized = true
- this.client = createClient(Redis.getRedisClient())
+ this.client = createClient(Redis.getRedisClientOptions())
this.client.on('error', err => {
logger.error('Error in Redis client.', { err })
this.prefix = 'redis-' + WEBSERVER.HOST + '-'
}
- static getRedisClient () {
+ 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 }
+ (CONFIG.REDIS.HOSTNAME && CONFIG.REDIS.PORT)
+ ? { host: CONFIG.REDIS.HOSTNAME, port: CONFIG.REDIS.PORT }
+ : { path: CONFIG.REDIS.SOCKET }
)
}
- /************* Forgot password *************/
+ getClient () {
+ return this.client
+ }
+
+ getPrefix () {
+ return this.prefix
+ }
+
+ /* ************ Forgot password ************ */
async setResetPasswordVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
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 *************/
+ /* ************ Email verification ************ */
async setVerifyEmailVerificationString (userId: number) {
const generatedString = await generateRandomString(32)
return this.getValue(this.generateVerifyEmailKey(userId))
}
- /************* Contact form per IP *************/
+ /* ************ Contact form per IP ************ */
async setContactFormIp (ip: string) {
return this.setValue(this.generateContactFormKey(ip), '1', CONTACT_FORM_LIFETIME)
return this.exists(this.generateContactFormKey(ip))
}
- /************* Views per 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)
+ }
+
+ 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.generateViewKey(ip, videoUUID))
+ return this.exists(this.generateIPViewKey(ip, videoUUID))
}
- /************* API cache *************/
+ 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))
}
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
+ 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 *************/
+ /* ************ Video views stats ************ */
- addVideoView (videoId: number) {
- const keyIncr = this.generateVideoViewKey(videoId)
- const keySet = this.generateVideosViewKey()
+ addVideoViewStats (videoId: number) {
+ const { videoKey, setKey } = this.generateVideoViewStatsKeys({ videoId })
return Promise.all([
- this.addToSet(keySet, videoId.toString()),
- this.increment(keyIncr)
+ this.addToSet(setKey, videoId.toString()),
+ this.increment(videoKey)
])
}
- async getVideoViews (videoId: number, hour: number) {
- const key = this.generateVideoViewKey(videoId, hour)
+ async getVideoViewsStats (videoId: number, hour: number) {
+ const { videoKey } = this.generateVideoViewStatsKeys({ videoId, hour })
- const valueString = await this.getValue(key)
+ const valueString = await this.getValue(videoKey)
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)
+ 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 getVideosIdViewed (hour: number) {
- const key = this.generateVideosViewKey(hour)
+ async listVideosViewedForStats (hour: number) {
+ const { setKey } = this.generateVideoViewStatsKeys({ hour })
- const stringIds = await this.getSet(key)
+ 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)
+ 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.deleteFromSet(keySet, videoId.toString()),
- this.deleteKey(keyIncr)
+ this.addToSet(setKey, videoId.toString()),
+ this.increment(videoKey)
])
}
- /************* Keys generation *************/
+ 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 generateVideosViewKey (hour?: number) {
- if (!hour) hour = new Date().getHours()
-
- return `videos-view-h${hour}`
+ private generateLocalVideoViewsKeys (videoId?: Number) {
+ return { setKey: `local-video-views-buffer`, videoKey: `local-video-views-buffer-${videoId}` }
}
- private generateVideoViewKey (videoId: number, hour?: number) {
- if (!hour) hour = new Date().getHours()
+ private generateVideoViewStatsKeys (options: { videoId?: number, hour?: number }) {
+ const hour = exists(options.hour)
+ ? options.hour
+ : new Date().getHours()
- return `video-view-${videoId}-h${hour}`
+ return { setKey: `videos-view-h${hour}`, videoKey: `video-view-${options.videoId}-h${hour}` }
}
private generateResetPasswordKey (userId: number) {
return 'verify-email-' + userId
}
- private generateViewKey (ip: string, videoUUID: string) {
+ 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 *************/
+ /* ************ Redis helpers ************ */
private getValue (key: string) {
return new Promise<string>((res, rej) => {
}
private addToSet (key: string, value: string) {
- return new Promise<string[]>((res, rej) => {
+ return new Promise<void>((res, rej) => {
this.client.sadd(this.prefix + key, value, err => err ? rej(err) : res())
})
}
})
}
- private setObject (key: string, obj: { [ id: string ]: string }, expirationMilliseconds: number) {
+ 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)
}
private getObject (key: string) {
- return new Promise<{ [ id: string ]: string }>((res, rej) => {
+ return new Promise<{ [id: string]: string }>((res, rej) => {
this.client.hgetall(this.prefix + key, (err, value) => {
if (err) return rej(err)
projects / github / Chocobozzz / PeerTube.git / blobdiff