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