]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/models/account/user.ts
Refractor user quota SQL queries
[github/Chocobozzz/PeerTube.git] / server / models / account / user.ts
index 26f04dcb5457a5f227b4ea4d7ec62a32caf9cfc2..bae683b128d03b9362ab619101a1bb40b5ebcb9f 100644 (file)
@@ -3,29 +3,45 @@ import {
   AllowNull,
   BeforeCreate,
   BeforeUpdate,
-  Column, CreatedAt,
+  Column,
+  CreatedAt,
   DataType,
-  Default, DefaultScope,
+  Default,
+  DefaultScope,
   HasMany,
   HasOne,
   Is,
   IsEmail,
-  Model, Scopes,
-  Table, UpdatedAt
+  Model,
+  Scopes,
+  Table,
+  UpdatedAt
 } from 'sequelize-typescript'
 import { hasUserRight, USER_ROLE_LABELS, UserRight } from '../../../shared'
+import { User, UserRole } from '../../../shared/models/users'
 import {
-  comparePassword,
-  cryptPassword
-} from '../../helpers'
-import {
-  isUserDisplayNSFWValid, isUserPasswordValid, isUserRoleValid, isUserUsernameValid,
-  isUserVideoQuotaValid
+  isUserAutoPlayVideoValid,
+  isUserBlockedReasonValid,
+  isUserBlockedValid,
+  isUserNSFWPolicyValid,
+  isUserPasswordValid,
+  isUserRoleValid,
+  isUserUsernameValid,
+  isUserVideoQuotaValid,
+  isUserVideoQuotaDailyValid
 } from '../../helpers/custom-validators/users'
+import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto'
 import { OAuthTokenModel } from '../oauth/oauth-token'
 import { getSort, throwIfNotValid } from '../utils'
 import { VideoChannelModel } from '../video/video-channel'
 import { AccountModel } from './account'
+import { NSFWPolicyType } from '../../../shared/models/videos/nsfw-policy.type'
+import { values } from 'lodash'
+import { NSFW_POLICY_TYPES } from '../../initializers'
+
+enum ScopeNames {
+  WITH_VIDEO_CHANNEL = 'WITH_VIDEO_CHANNEL'
+}
 
 @DefaultScope({
   include: [
@@ -36,7 +52,7 @@ import { AccountModel } from './account'
   ]
 })
 @Scopes({
-  withVideoChannel: {
+  [ScopeNames.WITH_VIDEO_CHANNEL]: {
     include: [
       {
         model: () => AccountModel,
@@ -76,11 +92,28 @@ export class UserModel extends Model<UserModel> {
   @Column(DataType.STRING(400))
   email: string
 
+  @AllowNull(false)
+  @Is('UserNSFWPolicy', value => throwIfNotValid(value, isUserNSFWPolicyValid, 'NSFW policy'))
+  @Column(DataType.ENUM(values(NSFW_POLICY_TYPES)))
+  nsfwPolicy: NSFWPolicyType
+
+  @AllowNull(false)
+  @Default(true)
+  @Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean'))
+  @Column
+  autoPlayVideo: boolean
+
   @AllowNull(false)
   @Default(false)
-  @Is('UserDisplayNSFW', value => throwIfNotValid(value, isUserDisplayNSFWValid, 'display NSFW boolean'))
+  @Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean'))
+  @Column
+  blocked: boolean
+
+  @AllowNull(true)
+  @Default(null)
+  @Is('UserBlockedReason', value => throwIfNotValid(value, isUserBlockedReasonValid, 'blocked reason'))
   @Column
-  displayNSFW: boolean
+  blockedReason: string
 
   @AllowNull(false)
   @Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role'))
@@ -92,6 +125,11 @@ export class UserModel extends Model<UserModel> {
   @Column(DataType.BIGINT)
   videoQuota: number
 
+  @AllowNull(false)
+  @Is('UserVideoQuotaDaily', value => throwIfNotValid(value, isUserVideoQuotaDailyValid, 'video quota daily'))
+  @Column(DataType.BIGINT)
+  videoQuotaDaily: number
+
   @CreatedAt
   createdAt: Date
 
@@ -100,7 +138,8 @@ export class UserModel extends Model<UserModel> {
 
   @HasOne(() => AccountModel, {
     foreignKey: 'userId',
-    onDelete: 'cascade'
+    onDelete: 'cascade',
+    hooks: true
   })
   Account: AccountModel
 
@@ -126,22 +165,30 @@ export class UserModel extends Model<UserModel> {
     return this.count()
   }
 
-  static getByUsername (username: string) {
-    const query = {
-      where: {
-        username: username
-      },
-      include: [ { model: AccountModel, required: true } ]
-    }
-
-    return UserModel.findOne(query)
-  }
-
   static listForApi (start: number, count: number, sort: string) {
     const query = {
+      attributes: {
+        include: [
+          [
+            Sequelize.literal(
+              '(' +
+                'SELECT COALESCE(SUM("size"), 0) ' +
+                'FROM (' +
+                  'SELECT MAX("videoFile"."size") AS "size" FROM "videoFile" ' +
+                  'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' +
+                  'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
+                  'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
+                  'WHERE "account"."userId" = "UserModel"."id" GROUP BY "video"."id"' +
+                ') t' +
+              ')'
+            ),
+            'videoQuotaUsed'
+          ] as any // FIXME: typings
+        ]
+      },
       offset: start,
       limit: count,
-      order: [ getSort(sort) ]
+      order: getSort(sort)
     }
 
     return UserModel.findAndCountAll(query)
@@ -153,6 +200,25 @@ export class UserModel extends Model<UserModel> {
       })
   }
 
+  static listEmailsWithRight (right: UserRight) {
+    const roles = Object.keys(USER_ROLE_LABELS)
+      .map(k => parseInt(k, 10) as UserRole)
+      .filter(role => hasUserRight(role, right))
+
+    const query = {
+      attribute: [ 'email' ],
+      where: {
+        role: {
+          [Sequelize.Op.in]: roles
+        }
+      }
+    }
+
+    return UserModel.unscoped()
+      .findAll(query)
+      .then(u => u.map(u => u.email))
+  }
+
   static loadById (id: number) {
     return UserModel.findById(id)
   }
@@ -174,10 +240,22 @@ export class UserModel extends Model<UserModel> {
       }
     }
 
-    return UserModel.scope('withVideoChannel').findOne(query)
+    return UserModel.scope(ScopeNames.WITH_VIDEO_CHANNEL).findOne(query)
   }
 
-  static loadByUsernameOrEmail (username: string, email: string) {
+  static loadByEmail (email: string) {
+    const query = {
+      where: {
+        email
+      }
+    }
+
+    return UserModel.findOne(query)
+  }
+
+  static loadByUsernameOrEmail (username: string, email?: string) {
+    if (!email) email = username
+
     const query = {
       where: {
         [ Sequelize.Op.or ]: [ { username }, { email } ]
@@ -187,26 +265,27 @@ export class UserModel extends Model<UserModel> {
     return UserModel.findOne(query)
   }
 
-  private static getOriginalVideoFileTotalFromUser (user: UserModel) {
+  static getOriginalVideoFileTotalFromUser (user: UserModel) {
     // Don't use sequelize because we need to use a sub query
-    const query = 'SELECT SUM("size") AS "total" FROM ' +
-      '(SELECT MAX("videoFile"."size") AS "size" FROM "videoFile" ' +
-      'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' +
-      'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
-      'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
-      'INNER JOIN "user" ON "account"."userId" = "user"."id" ' +
-      'WHERE "user"."id" = $userId GROUP BY "video"."id") t'
+    const query = UserModel.generateUserQuotaBaseSQL()
 
-    const options = {
-      bind: { userId: user.id },
-      type: Sequelize.QueryTypes.SELECT
-    }
-    return UserModel.sequelize.query(query, options)
-      .then(([ { total } ]) => {
-        if (total === null) return 0
+    return UserModel.getTotalRawQuery(query, user.id)
+  }
 
-        return parseInt(total, 10)
-      })
+  // Returns cumulative size of all video files uploaded in the last 24 hours.
+  static getOriginalVideoFileTotalDailyFromUser (user: UserModel) {
+    // Don't use sequelize because we need to use a sub query
+    const query = UserModel.generateUserQuotaBaseSQL('"video"."createdAt" > now() - interval \'24 hours\'')
+
+    return UserModel.getTotalRawQuery(query, user.id)
+  }
+
+  static async getStats () {
+    const totalUsers = await UserModel.count()
+
+    return {
+      totalUsers
+    }
   }
 
   hasRight (right: UserRight) {
@@ -217,21 +296,35 @@ export class UserModel extends Model<UserModel> {
     return comparePassword(password, this.password)
   }
 
-  toFormattedJSON () {
+  toFormattedJSON (): User {
+    const videoQuotaUsed = this.get('videoQuotaUsed')
+    const videoQuotaUsedDaily = this.get('videoQuotaUsedDaily')
+
     const json = {
       id: this.id,
       username: this.username,
       email: this.email,
-      displayNSFW: this.displayNSFW,
+      nsfwPolicy: this.nsfwPolicy,
+      autoPlayVideo: this.autoPlayVideo,
       role: this.role,
       roleLabel: USER_ROLE_LABELS[ this.role ],
       videoQuota: this.videoQuota,
+      videoQuotaDaily: this.videoQuotaDaily,
       createdAt: this.createdAt,
-      account: this.Account.toFormattedJSON()
+      blocked: this.blocked,
+      blockedReason: this.blockedReason,
+      account: this.Account.toFormattedJSON(),
+      videoChannels: [],
+      videoQuotaUsed: videoQuotaUsed !== undefined
+            ? parseInt(videoQuotaUsed, 10)
+            : undefined,
+      videoQuotaUsedDaily: videoQuotaUsedDaily !== undefined
+            ? parseInt(videoQuotaUsedDaily, 10)
+            : undefined
     }
 
     if (Array.isArray(this.Account.VideoChannels) === true) {
-      json['videoChannels'] = this.Account.VideoChannels
+      json.videoChannels = this.Account.VideoChannels
         .map(c => c.toFormattedJSON())
         .sort((v1, v2) => {
           if (v1.createdAt < v2.createdAt) return -1
@@ -244,12 +337,52 @@ export class UserModel extends Model<UserModel> {
     return json
   }
 
-  isAbleToUploadVideo (videoFile: Express.Multer.File) {
-    if (this.videoQuota === -1) return Promise.resolve(true)
+  async isAbleToUploadVideo (videoFile: { size: number }) {
+    if (this.videoQuota === -1 && this.videoQuotaDaily === -1) return Promise.resolve(true)
 
-    return UserModel.getOriginalVideoFileTotalFromUser(this)
-      .then(totalBytes => {
-        return (videoFile.size + totalBytes) < this.videoQuota
-      })
+    const [ totalBytes, totalBytesDaily ] = await Promise.all([
+      UserModel.getOriginalVideoFileTotalFromUser(this),
+      UserModel.getOriginalVideoFileTotalDailyFromUser(this)
+    ])
+
+    const uploadedTotal = videoFile.size + totalBytes
+    const uploadedDaily = videoFile.size + totalBytesDaily
+    if (this.videoQuotaDaily === -1) {
+      return uploadedTotal < this.videoQuota
+    }
+    if (this.videoQuota === -1) {
+      return uploadedDaily < this.videoQuotaDaily
+    }
+
+    return (uploadedTotal < this.videoQuota) &&
+        (uploadedDaily < this.videoQuotaDaily)
+  }
+
+  private static generateUserQuotaBaseSQL (where?: string) {
+    const andWhere = where ? 'AND ' + where : ''
+
+    return 'SELECT SUM("size") AS "total" ' +
+      'FROM (' +
+        'SELECT MAX("videoFile"."size") AS "size" FROM "videoFile" ' +
+        'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' +
+        'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
+        'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
+        'WHERE "account"."userId" = $userId ' + andWhere +
+        'GROUP BY "video"."id"' +
+      ') t'
+  }
+
+  private static getTotalRawQuery (query: string, userId: number) {
+    const options = {
+      bind: { userId },
+      type: Sequelize.QueryTypes.SELECT
+    }
+
+    return UserModel.sequelize.query(query, options)
+                    .then(([ { total } ]) => {
+                      if (total === null) return 0
+
+                      return parseInt(total, 10)
+                    })
   }
 }