Instance homepage support (#4007)

[github/Chocobozzz/PeerTube.git] / server / lib / redis.ts

diff --git a/server/lib/redis.ts b/server/lib/redis.ts
index b4044bf0f62c27c00fcaf26338080ddec5376481..62641e313af34f63a72da710e815b4bedbc0c771 100644 (file)
--- a/server/lib/redis.ts
+++ b/server/lib/redis.ts
@@ -6,13 +6,15 @@ import {
   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
 } from '../initializers/constants'
 import { CONFIG } from '../initializers/config'
 
 type CachedRoute = {
-  body: string,
+  body: string
   contentType?: string
   statusCode?: string
 }
@@ -24,14 +26,15 @@ class Redis {
   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 })
@@ -45,17 +48,25 @@ class Redis {
     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)
@@ -65,11 +76,23 @@ class Redis {
     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)
@@ -83,7 +106,7 @@ class Redis {
     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)
@@ -93,17 +116,31 @@ class Redis {
     return this.exists(this.generateContactFormKey(ip))
   }
 
-  /************* Views per IP *************/
+  /* ************ Views per IP ************ */
+
+  setIPVideoView (ip: string, videoUUID: string, isLive: boolean) {
+    const lifetime = isLive
+      ? VIEW_LIFETIME.LIVE
+      : VIEW_LIFETIME.VIDEO
 
-  setIPVideoView (ip: string, videoUUID: string) {
-    return this.setValue(this.generateViewKey(ip, videoUUID), '1', VIDEO_VIEW_LIFETIME)
+    return this.setValue(this.generateViewKey(ip, videoUUID), '1', lifetime)
   }
 
   async doesVideoIPViewExist (ip: string, videoUUID: string) {
     return this.exists(this.generateViewKey(ip, videoUUID))
   }
 
-  /************* API cache *************/
+  /* ************ 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))
@@ -112,17 +149,17 @@ class Redis {
   }
 
   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 ************ */
 
   addVideoView (videoId: number) {
     const keyIncr = this.generateVideoViewKey(videoId)
@@ -165,7 +202,7 @@ class Redis {
     ])
   }
 
-  /************* Keys generation *************/
+  /* ************ Keys generation ************ */
 
   generateCachedRouteKey (req: express.Request) {
     return req.method + '-' + req.originalUrl
@@ -178,7 +215,7 @@ class Redis {
   }
 
   private generateVideoViewKey (videoId: number, hour?: number) {
-    if (!hour) hour = new Date().getHours()
+    if (hour === undefined || hour === null) hour = new Date().getHours()
 
     return `video-view-${videoId}-h${hour}`
   }
@@ -195,11 +232,15 @@ class Redis {
     return `views-${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) => {
@@ -222,7 +263,7 @@ class Redis {
   }
 
   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())
     })
   }
@@ -257,7 +298,17 @@ class Redis {
     })
   }
 
-  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)
@@ -274,7 +325,7 @@ class Redis {
   }
 
   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)