server/models/user/user.ts

   1 import { col, FindOptions, fn, literal, Op, QueryTypes, where, WhereOptions } from 'sequelize'
   2 import {
   3   AfterDestroy,
   4   AfterUpdate,
   5   AllowNull,
   6   BeforeCreate,
   7   BeforeUpdate,
   8   Column,
   9   CreatedAt,
  10   DataType,
  11   Default,
  12   DefaultScope,
  13   HasMany,
  14   HasOne,
  15   Is,
  16   IsEmail,
  17   IsUUID,
  18   Model,
  19   Scopes,
  20   Table,
  21   UpdatedAt
  22 } from 'sequelize-typescript'
  23 import { TokensCache } from '@server/lib/auth/tokens-cache'
  24 import { LiveQuotaStore } from '@server/lib/live'
  25 import {
  26   MMyUserFormattable,
  27   MUser,
  28   MUserDefault,
  29   MUserFormattable,
  30   MUserNotifSettingChannelDefault,
  31   MUserWithNotificationSetting
  32 } from '@server/types/models'
  33 import { forceNumber } from '@shared/core-utils'
  34 import { AttributesOnly } from '@shared/typescript-utils'
  35 import { hasUserRight, USER_ROLE_LABELS } from '../../../shared/core-utils/users'
  36 import { AbuseState, MyUser, UserRight, VideoPlaylistType } from '../../../shared/models'
  37 import { User, UserRole } from '../../../shared/models/users'
  38 import { UserAdminFlag } from '../../../shared/models/users/user-flag.model'
  39 import { NSFWPolicyType } from '../../../shared/models/videos/nsfw-policy.type'
  40 import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
  41 import {
  42   isUserAdminFlagsValid,
  43   isUserAutoPlayNextVideoPlaylistValid,
  44   isUserAutoPlayNextVideoValid,
  45   isUserAutoPlayVideoValid,
  46   isUserBlockedReasonValid,
  47   isUserBlockedValid,
  48   isUserEmailVerifiedValid,
  49   isUserNoModal,
  50   isUserNSFWPolicyValid,
  51   isUserP2PEnabledValid,
  52   isUserPasswordValid,
  53   isUserRoleValid,
  54   isUserVideoLanguages,
  55   isUserVideoQuotaDailyValid,
  56   isUserVideoQuotaValid,
  57   isUserVideosHistoryEnabledValid
  58 } from '../../helpers/custom-validators/users'
  59 import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto'
  60 import { DEFAULT_USER_THEME_NAME, NSFW_POLICY_TYPES } from '../../initializers/constants'
  61 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
  62 import { AccountModel } from '../account/account'
  63 import { ActorModel } from '../actor/actor'
  64 import { ActorFollowModel } from '../actor/actor-follow'
  65 import { ActorImageModel } from '../actor/actor-image'
  66 import { OAuthTokenModel } from '../oauth/oauth-token'
  67 import { getAdminUsersSort, throwIfNotValid } from '../shared'
  68 import { VideoModel } from '../video/video'
  69 import { VideoChannelModel } from '../video/video-channel'
  70 import { VideoImportModel } from '../video/video-import'
  71 import { VideoLiveModel } from '../video/video-live'
  72 import { VideoPlaylistModel } from '../video/video-playlist'
  73 import { UserNotificationSettingModel } from './user-notification-setting'
  74
  75 enum ScopeNames {
  76   FOR_ME_API = 'FOR_ME_API',
  77   WITH_VIDEOCHANNELS = 'WITH_VIDEOCHANNELS',
  78   WITH_QUOTA = 'WITH_QUOTA',
  79   WITH_STATS = 'WITH_STATS'
  80 }
  81
  82 @DefaultScope(() => ({
  83   include: [
  84     {
  85       model: AccountModel,
  86       required: true
  87     },
  88     {
  89       model: UserNotificationSettingModel,
  90       required: true
  91     }
  92   ]
  93 }))
  94 @Scopes(() => ({
  95   [ScopeNames.FOR_ME_API]: {
  96     include: [
  97       {
  98         model: AccountModel,
  99         include: [
 100           {
 101             model: VideoChannelModel.unscoped(),
 102             include: [
 103               {
 104                 model: ActorModel,
 105                 required: true,
 106                 include: [
 107                   {
 108                     model: ActorImageModel,
 109                     as: 'Banners',
 110                     required: false
 111                   }
 112                 ]
 113               }
 114             ]
 115           },
 116           {
 117             attributes: [ 'id', 'name', 'type' ],
 118             model: VideoPlaylistModel.unscoped(),
 119             required: true,
 120             where: {
 121               type: {
 122                 [Op.ne]: VideoPlaylistType.REGULAR
 123               }
 124             }
 125           }
 126         ]
 127       },
 128       {
 129         model: UserNotificationSettingModel,
 130         required: true
 131       }
 132     ]
 133   },
 134   [ScopeNames.WITH_VIDEOCHANNELS]: {
 135     include: [
 136       {
 137         model: AccountModel,
 138         include: [
 139           {
 140             model: VideoChannelModel
 141           },
 142           {
 143             attributes: [ 'id', 'name', 'type' ],
 144             model: VideoPlaylistModel.unscoped(),
 145             required: true,
 146             where: {
 147               type: {
 148                 [Op.ne]: VideoPlaylistType.REGULAR
 149               }
 150             }
 151           }
 152         ]
 153       }
 154     ]
 155   },
 156   [ScopeNames.WITH_QUOTA]: {
 157     attributes: {
 158       include: [
 159         [
 160           literal(
 161             '(' +
 162               UserModel.generateUserQuotaBaseSQL({
 163                 withSelect: false,
 164                 whereUserId: '"UserModel"."id"',
 165                 daily: false
 166               }) +
 167             ')'
 168           ),
 169           'videoQuotaUsed'
 170         ],
 171         [
 172           literal(
 173             '(' +
 174               UserModel.generateUserQuotaBaseSQL({
 175                 withSelect: false,
 176                 whereUserId: '"UserModel"."id"',
 177                 daily: true
 178               }) +
 179             ')'
 180           ),
 181           'videoQuotaUsedDaily'
 182         ]
 183       ]
 184     }
 185   },
 186   [ScopeNames.WITH_STATS]: {
 187     attributes: {
 188       include: [
 189         [
 190           literal(
 191             '(' +
 192               'SELECT COUNT("video"."id") ' +
 193               'FROM "video" ' +
 194               'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
 195               'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
 196               'WHERE "account"."userId" = "UserModel"."id"' +
 197             ')'
 198           ),
 199           'videosCount'
 200         ],
 201         [
 202           literal(
 203             '(' +
 204               `SELECT concat_ws(':', "abuses", "acceptedAbuses") ` +
 205               'FROM (' +
 206                 'SELECT COUNT("abuse"."id") AS "abuses", ' +
 207                        `COUNT("abuse"."id") FILTER (WHERE "abuse"."state" = ${AbuseState.ACCEPTED}) AS "acceptedAbuses" ` +
 208                 'FROM "abuse" ' +
 209                 'INNER JOIN "account" ON "account"."id" = "abuse"."flaggedAccountId" ' +
 210                 'WHERE "account"."userId" = "UserModel"."id"' +
 211               ') t' +
 212             ')'
 213           ),
 214           'abusesCount'
 215         ],
 216         [
 217           literal(
 218             '(' +
 219               'SELECT COUNT("abuse"."id") ' +
 220               'FROM "abuse" ' +
 221               'INNER JOIN "account" ON "account"."id" = "abuse"."reporterAccountId" ' +
 222               'WHERE "account"."userId" = "UserModel"."id"' +
 223             ')'
 224           ),
 225           'abusesCreatedCount'
 226         ],
 227         [
 228           literal(
 229             '(' +
 230               'SELECT COUNT("videoComment"."id") ' +
 231               'FROM "videoComment" ' +
 232               'INNER JOIN "account" ON "account"."id" = "videoComment"."accountId" ' +
 233               'WHERE "account"."userId" = "UserModel"."id"' +
 234             ')'
 235           ),
 236           'videoCommentsCount'
 237         ]
 238       ]
 239     }
 240   }
 241 }))
 242 @Table({
 243   tableName: 'user',
 244   indexes: [
 245     {
 246       fields: [ 'username' ],
 247       unique: true
 248     },
 249     {
 250       fields: [ 'email' ],
 251       unique: true
 252     }
 253   ]
 254 })
 255 export class UserModel extends Model<Partial<AttributesOnly<UserModel>>> {
 256
 257   @AllowNull(true)
 258   @Is('UserPassword', value => throwIfNotValid(value, isUserPasswordValid, 'user password', true))
 259   @Column
 260   password: string
 261
 262   @AllowNull(false)
 263   @Column
 264   username: string
 265
 266   @AllowNull(false)
 267   @IsEmail
 268   @Column(DataType.STRING(400))
 269   email: string
 270
 271   @AllowNull(true)
 272   @IsEmail
 273   @Column(DataType.STRING(400))
 274   pendingEmail: string
 275
 276   @AllowNull(true)
 277   @Default(null)
 278   @Is('UserEmailVerified', value => throwIfNotValid(value, isUserEmailVerifiedValid, 'email verified boolean', true))
 279   @Column
 280   emailVerified: boolean
 281
 282   @AllowNull(false)
 283   @Is('UserNSFWPolicy', value => throwIfNotValid(value, isUserNSFWPolicyValid, 'NSFW policy'))
 284   @Column(DataType.ENUM(...Object.values(NSFW_POLICY_TYPES)))
 285   nsfwPolicy: NSFWPolicyType
 286
 287   @AllowNull(false)
 288   @Is('p2pEnabled', value => throwIfNotValid(value, isUserP2PEnabledValid, 'P2P enabled'))
 289   @Column
 290   p2pEnabled: boolean
 291
 292   @AllowNull(false)
 293   @Default(true)
 294   @Is('UserVideosHistoryEnabled', value => throwIfNotValid(value, isUserVideosHistoryEnabledValid, 'Videos history enabled'))
 295   @Column
 296   videosHistoryEnabled: boolean
 297
 298   @AllowNull(false)
 299   @Default(true)
 300   @Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean'))
 301   @Column
 302   autoPlayVideo: boolean
 303
 304   @AllowNull(false)
 305   @Default(false)
 306   @Is('UserAutoPlayNextVideo', value => throwIfNotValid(value, isUserAutoPlayNextVideoValid, 'auto play next video boolean'))
 307   @Column
 308   autoPlayNextVideo: boolean
 309
 310   @AllowNull(false)
 311   @Default(true)
 312   @Is(
 313     'UserAutoPlayNextVideoPlaylist',
 314     value => throwIfNotValid(value, isUserAutoPlayNextVideoPlaylistValid, 'auto play next video for playlists boolean')
 315   )
 316   @Column
 317   autoPlayNextVideoPlaylist: boolean
 318
 319   @AllowNull(true)
 320   @Default(null)
 321   @Is('UserVideoLanguages', value => throwIfNotValid(value, isUserVideoLanguages, 'video languages'))
 322   @Column(DataType.ARRAY(DataType.STRING))
 323   videoLanguages: string[]
 324
 325   @AllowNull(false)
 326   @Default(UserAdminFlag.NONE)
 327   @Is('UserAdminFlags', value => throwIfNotValid(value, isUserAdminFlagsValid, 'user admin flags'))
 328   @Column
 329   adminFlags?: UserAdminFlag
 330
 331   @AllowNull(false)
 332   @Default(false)
 333   @Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean'))
 334   @Column
 335   blocked: boolean
 336
 337   @AllowNull(true)
 338   @Default(null)
 339   @Is('UserBlockedReason', value => throwIfNotValid(value, isUserBlockedReasonValid, 'blocked reason', true))
 340   @Column
 341   blockedReason: string
 342
 343   @AllowNull(false)
 344   @Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role'))
 345   @Column
 346   role: number
 347
 348   @AllowNull(false)
 349   @Is('UserVideoQuota', value => throwIfNotValid(value, isUserVideoQuotaValid, 'video quota'))
 350   @Column(DataType.BIGINT)
 351   videoQuota: number
 352
 353   @AllowNull(false)
 354   @Is('UserVideoQuotaDaily', value => throwIfNotValid(value, isUserVideoQuotaDailyValid, 'video quota daily'))
 355   @Column(DataType.BIGINT)
 356   videoQuotaDaily: number
 357
 358   @AllowNull(false)
 359   @Default(DEFAULT_USER_THEME_NAME)
 360   @Is('UserTheme', value => throwIfNotValid(value, isThemeNameValid, 'theme'))
 361   @Column
 362   theme: string
 363
 364   @AllowNull(false)
 365   @Default(false)
 366   @Is(
 367     'UserNoInstanceConfigWarningModal',
 368     value => throwIfNotValid(value, isUserNoModal, 'no instance config warning modal')
 369   )
 370   @Column
 371   noInstanceConfigWarningModal: boolean
 372
 373   @AllowNull(false)
 374   @Default(false)
 375   @Is(
 376     'UserNoWelcomeModal',
 377     value => throwIfNotValid(value, isUserNoModal, 'no welcome modal')
 378   )
 379   @Column
 380   noWelcomeModal: boolean
 381
 382   @AllowNull(false)
 383   @Default(false)
 384   @Is(
 385     'UserNoAccountSetupWarningModal',
 386     value => throwIfNotValid(value, isUserNoModal, 'no account setup warning modal')
 387   )
 388   @Column
 389   noAccountSetupWarningModal: boolean
 390
 391   @AllowNull(true)
 392   @Default(null)
 393   @Column
 394   pluginAuth: string
 395
 396   @AllowNull(false)
 397   @Default(DataType.UUIDV4)
 398   @IsUUID(4)
 399   @Column(DataType.UUID)
 400   feedToken: string
 401
 402   @AllowNull(true)
 403   @Default(null)
 404   @Column
 405   lastLoginDate: Date
 406
 407   @AllowNull(true)
 408   @Default(null)
 409   @Column
 410   otpSecret: string
 411
 412   @CreatedAt
 413   createdAt: Date
 414
 415   @UpdatedAt
 416   updatedAt: Date
 417
 418   @HasOne(() => AccountModel, {
 419     foreignKey: 'userId',
 420     onDelete: 'cascade',
 421     hooks: true
 422   })
 423   Account: AccountModel
 424
 425   @HasOne(() => UserNotificationSettingModel, {
 426     foreignKey: 'userId',
 427     onDelete: 'cascade',
 428     hooks: true
 429   })
 430   NotificationSetting: UserNotificationSettingModel
 431
 432   @HasMany(() => VideoImportModel, {
 433     foreignKey: 'userId',
 434     onDelete: 'cascade'
 435   })
 436   VideoImports: VideoImportModel[]
 437
 438   @HasMany(() => OAuthTokenModel, {
 439     foreignKey: 'userId',
 440     onDelete: 'cascade'
 441   })
 442   OAuthTokens: OAuthTokenModel[]
 443
 444   // Used if we already set an encrypted password in user model
 445   skipPasswordEncryption = false
 446
 447   @BeforeCreate
 448   @BeforeUpdate
 449   static async cryptPasswordIfNeeded (instance: UserModel) {
 450     if (instance.skipPasswordEncryption) return
 451     if (!instance.changed('password')) return
 452     if (!instance.password) return
 453
 454     instance.password = await cryptPassword(instance.password)
 455   }
 456
 457   @AfterUpdate
 458   @AfterDestroy
 459   static removeTokenCache (instance: UserModel) {
 460     return TokensCache.Instance.clearCacheByUserId(instance.id)
 461   }
 462
 463   static countTotal () {
 464     return UserModel.unscoped().count()
 465   }
 466
 467   static listForAdminApi (parameters: {
 468     start: number
 469     count: number
 470     sort: string
 471     search?: string
 472     blocked?: boolean
 473   }) {
 474     const { start, count, sort, search, blocked } = parameters
 475     const where: WhereOptions = {}
 476
 477     if (search) {
 478       Object.assign(where, {
 479         [Op.or]: [
 480           {
 481             email: {
 482               [Op.iLike]: '%' + search + '%'
 483             }
 484           },
 485           {
 486             username: {
 487               [Op.iLike]: '%' + search + '%'
 488             }
 489           }
 490         ]
 491       })
 492     }
 493
 494     if (blocked !== undefined) {
 495       Object.assign(where, { blocked })
 496     }
 497
 498     const query: FindOptions = {
 499       offset: start,
 500       limit: count,
 501       order: getAdminUsersSort(sort),
 502       where
 503     }
 504
 505     return Promise.all([
 506       UserModel.unscoped().count(query),
 507       UserModel.scope([ 'defaultScope', ScopeNames.WITH_QUOTA ]).findAll(query)
 508     ]).then(([ total, data ]) => ({ total, data }))
 509   }
 510
 511   static listWithRight (right: UserRight): Promise<MUserDefault[]> {
 512     const roles = Object.keys(USER_ROLE_LABELS)
 513                         .map(k => parseInt(k, 10) as UserRole)
 514                         .filter(role => hasUserRight(role, right))
 515
 516     const query = {
 517       where: {
 518         role: {
 519           [Op.in]: roles
 520         }
 521       }
 522     }
 523
 524     return UserModel.findAll(query)
 525   }
 526
 527   static listUserSubscribersOf (actorId: number): Promise<MUserWithNotificationSetting[]> {
 528     const query = {
 529       include: [
 530         {
 531           model: UserNotificationSettingModel.unscoped(),
 532           required: true
 533         },
 534         {
 535           attributes: [ 'userId' ],
 536           model: AccountModel.unscoped(),
 537           required: true,
 538           include: [
 539             {
 540               attributes: [],
 541               model: ActorModel.unscoped(),
 542               required: true,
 543               where: {
 544                 serverId: null
 545               },
 546               include: [
 547                 {
 548                   attributes: [],
 549                   as: 'ActorFollowings',
 550                   model: ActorFollowModel.unscoped(),
 551                   required: true,
 552                   where: {
 553                     targetActorId: actorId
 554                   }
 555                 }
 556               ]
 557             }
 558           ]
 559         }
 560       ]
 561     }
 562
 563     return UserModel.unscoped().findAll(query)
 564   }
 565
 566   static listByUsernames (usernames: string[]): Promise<MUserDefault[]> {
 567     const query = {
 568       where: {
 569         username: usernames
 570       }
 571     }
 572
 573     return UserModel.findAll(query)
 574   }
 575
 576   static loadById (id: number): Promise<MUser> {
 577     return UserModel.unscoped().findByPk(id)
 578   }
 579
 580   static loadByIdFull (id: number): Promise<MUserDefault> {
 581     return UserModel.findByPk(id)
 582   }
 583
 584   static loadByIdWithChannels (id: number, withStats = false): Promise<MUserDefault> {
 585     const scopes = [
 586       ScopeNames.WITH_VIDEOCHANNELS
 587     ]
 588
 589     if (withStats) {
 590       scopes.push(ScopeNames.WITH_QUOTA)
 591       scopes.push(ScopeNames.WITH_STATS)
 592     }
 593
 594     return UserModel.scope(scopes).findByPk(id)
 595   }
 596
 597   static loadByUsername (username: string): Promise<MUserDefault> {
 598     const query = {
 599       where: {
 600         username
 601       }
 602     }
 603
 604     return UserModel.findOne(query)
 605   }
 606
 607   static loadForMeAPI (id: number): Promise<MUserNotifSettingChannelDefault> {
 608     const query = {
 609       where: {
 610         id
 611       }
 612     }
 613
 614     return UserModel.scope(ScopeNames.FOR_ME_API).findOne(query)
 615   }
 616
 617   static loadByEmail (email: string): Promise<MUserDefault> {
 618     const query = {
 619       where: {
 620         email
 621       }
 622     }
 623
 624     return UserModel.findOne(query)
 625   }
 626
 627   static loadByUsernameOrEmail (username: string, email?: string): Promise<MUserDefault> {
 628     if (!email) email = username
 629
 630     const query = {
 631       where: {
 632         [Op.or]: [
 633           where(fn('lower', col('username')), fn('lower', username) as any),
 634
 635           { email }
 636         ]
 637       }
 638     }
 639
 640     return UserModel.findOne(query)
 641   }
 642
 643   static loadByVideoId (videoId: number): Promise<MUserDefault> {
 644     const query = {
 645       include: [
 646         {
 647           required: true,
 648           attributes: [ 'id' ],
 649           model: AccountModel.unscoped(),
 650           include: [
 651             {
 652               required: true,
 653               attributes: [ 'id' ],
 654               model: VideoChannelModel.unscoped(),
 655               include: [
 656                 {
 657                   required: true,
 658                   attributes: [ 'id' ],
 659                   model: VideoModel.unscoped(),
 660                   where: {
 661                     id: videoId
 662                   }
 663                 }
 664               ]
 665             }
 666           ]
 667         }
 668       ]
 669     }
 670
 671     return UserModel.findOne(query)
 672   }
 673
 674   static loadByVideoImportId (videoImportId: number): Promise<MUserDefault> {
 675     const query = {
 676       include: [
 677         {
 678           required: true,
 679           attributes: [ 'id' ],
 680           model: VideoImportModel.unscoped(),
 681           where: {
 682             id: videoImportId
 683           }
 684         }
 685       ]
 686     }
 687
 688     return UserModel.findOne(query)
 689   }
 690
 691   static loadByChannelActorId (videoChannelActorId: number): Promise<MUserDefault> {
 692     const query = {
 693       include: [
 694         {
 695           required: true,
 696           attributes: [ 'id' ],
 697           model: AccountModel.unscoped(),
 698           include: [
 699             {
 700               required: true,
 701               attributes: [ 'id' ],
 702               model: VideoChannelModel.unscoped(),
 703               where: {
 704                 actorId: videoChannelActorId
 705               }
 706             }
 707           ]
 708         }
 709       ]
 710     }
 711
 712     return UserModel.findOne(query)
 713   }
 714
 715   static loadByAccountActorId (accountActorId: number): Promise<MUserDefault> {
 716     const query = {
 717       include: [
 718         {
 719           required: true,
 720           attributes: [ 'id' ],
 721           model: AccountModel.unscoped(),
 722           where: {
 723             actorId: accountActorId
 724           }
 725         }
 726       ]
 727     }
 728
 729     return UserModel.findOne(query)
 730   }
 731
 732   static loadByLiveId (liveId: number): Promise<MUser> {
 733     const query = {
 734       include: [
 735         {
 736           attributes: [ 'id' ],
 737           model: AccountModel.unscoped(),
 738           required: true,
 739           include: [
 740             {
 741               attributes: [ 'id' ],
 742               model: VideoChannelModel.unscoped(),
 743               required: true,
 744               include: [
 745                 {
 746                   attributes: [ 'id' ],
 747                   model: VideoModel.unscoped(),
 748                   required: true,
 749                   include: [
 750                     {
 751                       attributes: [],
 752                       model: VideoLiveModel.unscoped(),
 753                       required: true,
 754                       where: {
 755                         id: liveId
 756                       }
 757                     }
 758                   ]
 759                 }
 760               ]
 761             }
 762           ]
 763         }
 764       ]
 765     }
 766
 767     return UserModel.unscoped().findOne(query)
 768   }
 769
 770   static generateUserQuotaBaseSQL (options: {
 771     whereUserId: '$userId' | '"UserModel"."id"'
 772     withSelect: boolean
 773     daily: boolean
 774   }) {
 775     const andWhere = options.daily === true
 776       ? 'AND "video"."createdAt" > now() - interval \'24 hours\''
 777       : ''
 778
 779     const videoChannelJoin = 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
 780       'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
 781       `WHERE "account"."userId" = ${options.whereUserId} ${andWhere}`
 782
 783     const webtorrentFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
 784       'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' +
 785       videoChannelJoin
 786
 787     const hlsFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
 788       'INNER JOIN "videoStreamingPlaylist" ON "videoFile"."videoStreamingPlaylistId" = "videoStreamingPlaylist".id ' +
 789       'INNER JOIN "video" ON "videoStreamingPlaylist"."videoId" = "video"."id" ' +
 790       videoChannelJoin
 791
 792     return 'SELECT COALESCE(SUM("size"), 0) AS "total" ' +
 793       'FROM (' +
 794         `SELECT MAX("t1"."size") AS "size" FROM (${webtorrentFiles} UNION ${hlsFiles}) t1 ` +
 795         'GROUP BY "t1"."videoId"' +
 796       ') t2'
 797   }
 798
 799   static getTotalRawQuery (query: string, userId: number) {
 800     const options = {
 801       bind: { userId },
 802       type: QueryTypes.SELECT as QueryTypes.SELECT
 803     }
 804
 805     return UserModel.sequelize.query<{ total: string }>(query, options)
 806                     .then(([ { total } ]) => {
 807                       if (total === null) return 0
 808
 809                       return parseInt(total, 10)
 810                     })
 811   }
 812
 813   static async getStats () {
 814     function getActiveUsers (days: number) {
 815       const query = {
 816         where: {
 817           [Op.and]: [
 818             literal(`"lastLoginDate" > NOW() - INTERVAL '${days}d'`)
 819           ]
 820         }
 821       }
 822
 823       return UserModel.unscoped().count(query)
 824     }
 825
 826     const totalUsers = await UserModel.unscoped().count()
 827     const totalDailyActiveUsers = await getActiveUsers(1)
 828     const totalWeeklyActiveUsers = await getActiveUsers(7)
 829     const totalMonthlyActiveUsers = await getActiveUsers(30)
 830     const totalHalfYearActiveUsers = await getActiveUsers(180)
 831
 832     return {
 833       totalUsers,
 834       totalDailyActiveUsers,
 835       totalWeeklyActiveUsers,
 836       totalMonthlyActiveUsers,
 837       totalHalfYearActiveUsers
 838     }
 839   }
 840
 841   static autoComplete (search: string) {
 842     const query = {
 843       where: {
 844         username: {
 845           [Op.like]: `%${search}%`
 846         }
 847       },
 848       limit: 10
 849     }
 850
 851     return UserModel.findAll(query)
 852                     .then(u => u.map(u => u.username))
 853   }
 854
 855   hasRight (right: UserRight) {
 856     return hasUserRight(this.role, right)
 857   }
 858
 859   hasAdminFlag (flag: UserAdminFlag) {
 860     return this.adminFlags & flag
 861   }
 862
 863   isPasswordMatch (password: string) {
 864     return comparePassword(password, this.password)
 865   }
 866
 867   toFormattedJSON (this: MUserFormattable, parameters: { withAdminFlags?: boolean } = {}): User {
 868     const videoQuotaUsed = this.get('videoQuotaUsed')
 869     const videoQuotaUsedDaily = this.get('videoQuotaUsedDaily')
 870     const videosCount = this.get('videosCount')
 871     const [ abusesCount, abusesAcceptedCount ] = (this.get('abusesCount') as string || ':').split(':')
 872     const abusesCreatedCount = this.get('abusesCreatedCount')
 873     const videoCommentsCount = this.get('videoCommentsCount')
 874
 875     const json: User = {
 876       id: this.id,
 877       username: this.username,
 878       email: this.email,
 879       theme: getThemeOrDefault(this.theme, DEFAULT_USER_THEME_NAME),
 880
 881       pendingEmail: this.pendingEmail,
 882       emailVerified: this.emailVerified,
 883
 884       nsfwPolicy: this.nsfwPolicy,
 885
 886       // FIXME: deprecated in 4.1
 887       webTorrentEnabled: this.p2pEnabled,
 888       p2pEnabled: this.p2pEnabled,
 889
 890       videosHistoryEnabled: this.videosHistoryEnabled,
 891       autoPlayVideo: this.autoPlayVideo,
 892       autoPlayNextVideo: this.autoPlayNextVideo,
 893       autoPlayNextVideoPlaylist: this.autoPlayNextVideoPlaylist,
 894       videoLanguages: this.videoLanguages,
 895
 896       role: {
 897         id: this.role,
 898         label: USER_ROLE_LABELS[this.role]
 899       },
 900
 901       videoQuota: this.videoQuota,
 902       videoQuotaDaily: this.videoQuotaDaily,
 903
 904       videoQuotaUsed: videoQuotaUsed !== undefined
 905         ? forceNumber(videoQuotaUsed) + LiveQuotaStore.Instance.getLiveQuotaOf(this.id)
 906         : undefined,
 907
 908       videoQuotaUsedDaily: videoQuotaUsedDaily !== undefined
 909         ? forceNumber(videoQuotaUsedDaily) + LiveQuotaStore.Instance.getLiveQuotaOf(this.id)
 910         : undefined,
 911
 912       videosCount: videosCount !== undefined
 913         ? forceNumber(videosCount)
 914         : undefined,
 915       abusesCount: abusesCount
 916         ? forceNumber(abusesCount)
 917         : undefined,
 918       abusesAcceptedCount: abusesAcceptedCount
 919         ? forceNumber(abusesAcceptedCount)
 920         : undefined,
 921       abusesCreatedCount: abusesCreatedCount !== undefined
 922         ? forceNumber(abusesCreatedCount)
 923         : undefined,
 924       videoCommentsCount: videoCommentsCount !== undefined
 925         ? forceNumber(videoCommentsCount)
 926         : undefined,
 927
 928       noInstanceConfigWarningModal: this.noInstanceConfigWarningModal,
 929       noWelcomeModal: this.noWelcomeModal,
 930       noAccountSetupWarningModal: this.noAccountSetupWarningModal,
 931
 932       blocked: this.blocked,
 933       blockedReason: this.blockedReason,
 934
 935       account: this.Account.toFormattedJSON(),
 936
 937       notificationSettings: this.NotificationSetting
 938         ? this.NotificationSetting.toFormattedJSON()
 939         : undefined,
 940
 941       videoChannels: [],
 942
 943       createdAt: this.createdAt,
 944
 945       pluginAuth: this.pluginAuth,
 946
 947       lastLoginDate: this.lastLoginDate,
 948
 949       twoFactorEnabled: !!this.otpSecret
 950     }
 951
 952     if (parameters.withAdminFlags) {
 953       Object.assign(json, { adminFlags: this.adminFlags })
 954     }
 955
 956     if (Array.isArray(this.Account.VideoChannels) === true) {
 957       json.videoChannels = this.Account.VideoChannels
 958                                .map(c => c.toFormattedJSON())
 959                                .sort((v1, v2) => {
 960                                  if (v1.createdAt < v2.createdAt) return -1
 961                                  if (v1.createdAt === v2.createdAt) return 0
 962
 963                                  return 1
 964                                })
 965     }
 966
 967     return json
 968   }
 969
 970   toMeFormattedJSON (this: MMyUserFormattable): MyUser {
 971     const formatted = this.toFormattedJSON({ withAdminFlags: true })
 972
 973     const specialPlaylists = this.Account.VideoPlaylists
 974                                  .map(p => ({ id: p.id, name: p.name, type: p.type }))
 975
 976     return Object.assign(formatted, { specialPlaylists })
 977   }
 978 }