server/models/user/user.ts

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