X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fredis.ts;h=158f3c08090e7106c165847cdac9c49ae14e4cfb;hb=b89b0bfce9bb79d81f9761b07b04d0c4e5aa25c1;hp=78b28986a0b4955f65286f90231fdf1b2156132f;hpb=94831479f5facff9469540a3d49dd347b88bdf5a;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/server/lib/redis.ts b/server/lib/redis.ts
index 78b28986a..158f3c080 100644
--- a/server/lib/redis.ts
+++ b/server/lib/redis.ts
@@ -1,47 +1,96 @@
-import * as express from 'express'
-import { createClient, RedisClient } from 'redis'
+import { createClient, RedisClientOptions, RedisModules, RedisScripts } from 'redis'
+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, 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,
+  TRACKER_RATE_LIMITS,
+  USER_EMAIL_VERIFY_LIFETIME,
+  USER_PASSWORD_CREATE_LIFETIME,
+  USER_PASSWORD_RESET_LIFETIME,
+  VIEW_LIFETIME,
+  WEBSERVER
+} from '../initializers/constants'
+
+// Only used for typings
+// TODO: remove when https://github.com/microsoft/TypeScript/issues/37181 is fixed
+const redisClientWrapperForType = () => createClient<{}, RedisScripts>()
 
 class Redis {
 
   private static instance: Redis
   private initialized = false
-  private client: RedisClient
+  private connected = false
+  private client: ReturnType<typeof redisClientWrapperForType>
   private prefix: string
 
-  private constructor () {}
+  private constructor () {
+  }
 
   init () {
     // Already initialized
     if (this.initialized === true) return
     this.initialized = true
 
-    this.client = createClient({
-      host: CONFIG.REDIS.HOSTNAME,
-      port: CONFIG.REDIS.PORT,
-      db: CONFIG.REDIS.DB
-    })
+    this.client = createClient(Redis.getRedisClientOptions())
 
-    this.client.on('error', err => {
-      logger.error('Error in Redis client.', { err })
-      process.exit(-1)
-    })
+    logger.info('Connecting to redis...')
+
+    this.client.connect()
+      .then(() => {
+        logger.info('Connected to redis.')
+
+        this.connected = true
+      }).catch(err => {
+        logger.error('Cannot connect to redis', { err })
+        process.exit(-1)
+      })
+
+    this.prefix = 'redis-' + WEBSERVER.HOST + '-'
+  }
+
+  static getRedisClientOptions () {
+    let config: RedisClientOptions<RedisModules, {}> = {
+      socket: {
+        connectTimeout: 20000 // Could be slow since node use sync call to compile PeerTube
+      }
+    }
 
     if (CONFIG.REDIS.AUTH) {
-      this.client.auth(CONFIG.REDIS.AUTH)
+      config = { ...config, password: CONFIG.REDIS.AUTH }
+    }
+
+    if (CONFIG.REDIS.DB) {
+      config = { ...config, database: CONFIG.REDIS.DB }
+    }
+
+    if (CONFIG.REDIS.HOSTNAME && CONFIG.REDIS.PORT) {
+      config.socket = { ...config.socket, host: CONFIG.REDIS.HOSTNAME, port: CONFIG.REDIS.PORT }
+    } else {
+      config.socket = { ...config.socket, path: CONFIG.REDIS.SOCKET }
     }
 
-    this.prefix = 'redis-' + CONFIG.WEBSERVER.HOST + '-'
+    return config
+  }
+
+  getClient () {
+    return this.client
+  }
+
+  getPrefix () {
+    return this.prefix
+  }
+
+  isConnected () {
+    return this.connected
   }
 
+  /* ************ Forgot password ************ */
+
   async setResetPasswordVerificationString (userId: number) {
     const generatedString = await generateRandomString(32)
 
@@ -50,102 +99,331 @@ 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))
   }
 
-  setView (ip: string, videoUUID: string) {
-    return this.setValue(this.buildViewKey(ip, videoUUID), '1', VIDEO_VIEW_LIFETIME)
+  /* ************ 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 isViewExists (ip: string, videoUUID: string) {
-    return this.exists(this.buildViewKey(ip, videoUUID))
+  async getVerifyEmailLink (userId: number) {
+    return this.getValue(this.generateVerifyEmailKey(userId))
   }
 
-  async getCachedRoute (req: express.Request) {
-    const cached = await this.getObject(this.buildCachedRouteKey(req))
+  /* ************ Contact form per IP ************ */
 
-    return cached as CachedRoute
+  async setContactFormIp (ip: string) {
+    return this.setValue(this.generateContactFormKey(ip), '1', CONTACT_FORM_LIFETIME)
   }
 
-  setCachedRoute (req: express.Request, body: any, lifetime: number, contentType?: string, statusCode?: number) {
-    const cached: CachedRoute = {
-      body: body.toString(),
-      contentType,
-      statusCode: statusCode.toString()
+  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)
+  }
+
+  async doesVideoIPViewExist (ip: string, videoUUID: string) {
+    return this.exists(this.generateIPViewKey(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))
+  }
+
+  /* ************ 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 this.setObject(this.buildCachedRouteKey(req), cached, lifetime)
+    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)
+    ])
+  }
+
+  /* ************ 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.addToSet(setKey, viewerKey),
+      this.setObject(viewerKey, object)
+    ])
+  }
+
+  listLocalVideoViewerKeys () {
+    const { setKey } = this.generateLocalVideoViewerKeys()
+
+    return this.getSet(setKey)
+  }
+
+  deleteLocalVideoViewersKeys (key: string) {
+    const { setKey } = this.generateLocalVideoViewerKeys()
+
+    return Promise.all([
+      this.deleteFromSet(setKey, key),
+      this.deleteKey(key)
+    ])
+  }
+
+  /* ************ 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)
   }
 
-  generateResetPasswordKey (userId: number) {
+  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)
+  }
+
+  /* ************ AP resource unavailability ************ */
+
+  async addAPUnavailability (url: string) {
+    const key = this.generateAPUnavailabilityKey(url)
+
+    const value = await this.increment(key)
+    await this.setExpiration(key, AP_CLEANER.PERIOD * 2)
+
+    return value
+  }
+
+  /* ************ Keys generation ************ */
+
+  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 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 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
   }
 
-  buildViewKey (ip: string, videoUUID: string) {
-    return videoUUID + '-' + ip
+  private generateVerifyEmailKey (userId: number) {
+    return 'verify-email-' + userId
+  }
+
+  private generateIPViewKey (ip: string, videoUUID: string) {
+    return `views-${videoUUID}-${ip}`
+  }
+
+  private generateTrackerBlockIPKey (ip: string) {
+    return `tracker-block-ip-${ip}`
+  }
+
+  private generateContactFormKey (ip: string) {
+    return 'contact-form-' + ip
   }
 
-  buildCachedRouteKey (req: express.Request) {
-    return req.method + '-' + req.originalUrl
+  private generateAPUnavailabilityKey (url: string) {
+    return 'ap-unavailability-' + sha256(url)
   }
 
+  /* ************ 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 this.client.get(this.prefix + key)
+  }
 
-        return res(value)
-      })
-    })
+  private getSet (key: string) {
+    return this.client.sMembers(this.prefix + key)
   }
 
-  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 addToSet (key: string, value: string) {
+    return this.client.sAdd(this.prefix + key, value)
+  }
 
-        if (ok !== 'OK') return rej(new Error('Redis set result is not OK.'))
+  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 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 async getObject (key: string) {
+    const value = await this.getValue(key)
+    if (!value) return null
 
-        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 JSON.parse(value)
+  }
 
-          return res()
-        })
-      })
-    })
+  private setObject (key: string, value: { [ id: string ]: number | string }) {
+    return this.setValue(key, JSON.stringify(value))
   }
 
-  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 async setValue (key: string, value: string, expirationMilliseconds?: number) {
+    const options = expirationMilliseconds
+      ? { PX: expirationMilliseconds }
+      : {}
 
-        return res(value)
-      })
-    })
+    const result = await this.client.set(this.prefix + key, value, options)
+
+    if (result !== 'OK') throw new Error('Redis set result is not OK.')
   }
 
-  private exists (key: string) {
-    return new Promise<boolean>((res, rej) => {
-      this.client.exists(this.prefix + key, (err, existsNumber) => {
-        if (err) return rej(err)
+  private removeValue (key: string) {
+    return this.client.del(this.prefix + key)
+  }
 
-        return res(existsNumber === 1)
-      })
-    })
+  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 () {