1 import { col, FindOptions, fn, literal, Op, QueryTypes, where, WhereOptions } from 'sequelize'
22 } from 'sequelize-typescript'
23 import { TokensCache } from '@server/lib/auth/tokens-cache'
24 import { LiveQuotaStore } from '@server/lib/live'
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'
42 isUserAdminFlagsValid,
43 isUserAutoPlayNextVideoPlaylistValid,
44 isUserAutoPlayNextVideoValid,
45 isUserAutoPlayVideoValid,
46 isUserBlockedReasonValid,
48 isUserEmailVerifiedValid,
50 isUserNSFWPolicyValid,
51 isUserP2PEnabledValid,
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'
76 FOR_ME_API = 'FOR_ME_API',
77 WITH_VIDEOCHANNELS = 'WITH_VIDEOCHANNELS',
78 WITH_QUOTA = 'WITH_QUOTA',
79 WITH_STATS = 'WITH_STATS'
82 @DefaultScope(() => ({
89 model: UserNotificationSettingModel,
95 [ScopeNames.FOR_ME_API]: {
101 model: VideoChannelModel.unscoped(),
108 model: ActorImageModel,
117 attributes: [ 'id', 'name', 'type' ],
118 model: VideoPlaylistModel.unscoped(),
122 [Op.ne]: VideoPlaylistType.REGULAR
129 model: UserNotificationSettingModel,
134 [ScopeNames.WITH_VIDEOCHANNELS]: {
140 model: VideoChannelModel
143 attributes: [ 'id', 'name', 'type' ],
144 model: VideoPlaylistModel.unscoped(),
148 [Op.ne]: VideoPlaylistType.REGULAR
156 [ScopeNames.WITH_QUOTA]: {
162 UserModel.generateUserQuotaBaseSQL({
164 whereUserId: '"UserModel"."id"',
174 UserModel.generateUserQuotaBaseSQL({
176 whereUserId: '"UserModel"."id"',
181 'videoQuotaUsedDaily'
186 [ScopeNames.WITH_STATS]: {
192 'SELECT COUNT("video"."id") ' +
194 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
195 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
196 'WHERE "account"."userId" = "UserModel"."id"' +
204 `SELECT concat_ws(':', "abuses", "acceptedAbuses") ` +
206 'SELECT COUNT("abuse"."id") AS "abuses", ' +
207 `COUNT("abuse"."id") FILTER (WHERE "abuse"."state" = ${AbuseState.ACCEPTED}) AS "acceptedAbuses" ` +
209 'INNER JOIN "account" ON "account"."id" = "abuse"."flaggedAccountId" ' +
210 'WHERE "account"."userId" = "UserModel"."id"' +
219 'SELECT COUNT("abuse"."id") ' +
221 'INNER JOIN "account" ON "account"."id" = "abuse"."reporterAccountId" ' +
222 'WHERE "account"."userId" = "UserModel"."id"' +
230 'SELECT COUNT("videoComment"."id") ' +
231 'FROM "videoComment" ' +
232 'INNER JOIN "account" ON "account"."id" = "videoComment"."accountId" ' +
233 'WHERE "account"."userId" = "UserModel"."id"' +
246 fields: [ 'username' ],
255 export class UserModel extends Model<Partial<AttributesOnly<UserModel>>> {
258 @Is('UserPassword', value => throwIfNotValid(value, isUserPasswordValid, 'user password', true))
268 @Column(DataType.STRING(400))
273 @Column(DataType.STRING(400))
278 @Is('UserEmailVerified', value => throwIfNotValid(value, isUserEmailVerifiedValid, 'email verified boolean', true))
280 emailVerified: boolean
283 @Is('UserNSFWPolicy', value => throwIfNotValid(value, isUserNSFWPolicyValid, 'NSFW policy'))
284 @Column(DataType.ENUM(...Object.values(NSFW_POLICY_TYPES)))
285 nsfwPolicy: NSFWPolicyType
288 @Is('p2pEnabled', value => throwIfNotValid(value, isUserP2PEnabledValid, 'P2P enabled'))
294 @Is('UserVideosHistoryEnabled', value => throwIfNotValid(value, isUserVideosHistoryEnabledValid, 'Videos history enabled'))
296 videosHistoryEnabled: boolean
300 @Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean'))
302 autoPlayVideo: boolean
306 @Is('UserAutoPlayNextVideo', value => throwIfNotValid(value, isUserAutoPlayNextVideoValid, 'auto play next video boolean'))
308 autoPlayNextVideo: boolean
313 'UserAutoPlayNextVideoPlaylist',
314 value => throwIfNotValid(value, isUserAutoPlayNextVideoPlaylistValid, 'auto play next video for playlists boolean')
317 autoPlayNextVideoPlaylist: boolean
321 @Is('UserVideoLanguages', value => throwIfNotValid(value, isUserVideoLanguages, 'video languages'))
322 @Column(DataType.ARRAY(DataType.STRING))
323 videoLanguages: string[]
326 @Default(UserAdminFlag.NONE)
327 @Is('UserAdminFlags', value => throwIfNotValid(value, isUserAdminFlagsValid, 'user admin flags'))
329 adminFlags?: UserAdminFlag
333 @Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean'))
339 @Is('UserBlockedReason', value => throwIfNotValid(value, isUserBlockedReasonValid, 'blocked reason', true))
341 blockedReason: string
344 @Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role'))
349 @Is('UserVideoQuota', value => throwIfNotValid(value, isUserVideoQuotaValid, 'video quota'))
350 @Column(DataType.BIGINT)
354 @Is('UserVideoQuotaDaily', value => throwIfNotValid(value, isUserVideoQuotaDailyValid, 'video quota daily'))
355 @Column(DataType.BIGINT)
356 videoQuotaDaily: number
359 @Default(DEFAULT_USER_THEME_NAME)
360 @Is('UserTheme', value => throwIfNotValid(value, isThemeNameValid, 'theme'))
367 'UserNoInstanceConfigWarningModal',
368 value => throwIfNotValid(value, isUserNoModal, 'no instance config warning modal')
371 noInstanceConfigWarningModal: boolean
376 'UserNoWelcomeModal',
377 value => throwIfNotValid(value, isUserNoModal, 'no welcome modal')
380 noWelcomeModal: boolean
385 'UserNoAccountSetupWarningModal',
386 value => throwIfNotValid(value, isUserNoModal, 'no account setup warning modal')
389 noAccountSetupWarningModal: boolean
397 @Default(DataType.UUIDV4)
399 @Column(DataType.UUID)
418 @HasOne(() => AccountModel, {
419 foreignKey: 'userId',
423 Account: AccountModel
425 @HasOne(() => UserNotificationSettingModel, {
426 foreignKey: 'userId',
430 NotificationSetting: UserNotificationSettingModel
432 @HasMany(() => VideoImportModel, {
433 foreignKey: 'userId',
436 VideoImports: VideoImportModel[]
438 @HasMany(() => OAuthTokenModel, {
439 foreignKey: 'userId',
442 OAuthTokens: OAuthTokenModel[]
444 // Used if we already set an encrypted password in user model
445 skipPasswordEncryption = false
449 static async cryptPasswordIfNeeded (instance: UserModel) {
450 if (instance.skipPasswordEncryption) return
451 if (!instance.changed('password')) return
452 if (!instance.password) return
454 instance.password = await cryptPassword(instance.password)
459 static removeTokenCache (instance: UserModel) {
460 return TokensCache.Instance.clearCacheByUserId(instance.id)
463 static countTotal () {
464 return UserModel.unscoped().count()
467 static listForAdminApi (parameters: {
474 const { start, count, sort, search, blocked } = parameters
475 const where: WhereOptions = {}
478 Object.assign(where, {
482 [Op.iLike]: '%' + search + '%'
487 [Op.iLike]: '%' + search + '%'
494 if (blocked !== undefined) {
495 Object.assign(where, { blocked })
498 const query: FindOptions = {
501 order: getAdminUsersSort(sort),
506 UserModel.unscoped().count(query),
507 UserModel.scope([ 'defaultScope', ScopeNames.WITH_QUOTA ]).findAll(query)
508 ]).then(([ total, data ]) => ({ total, data }))
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))
524 return UserModel.findAll(query)
527 static listUserSubscribersOf (actorId: number): Promise<MUserWithNotificationSetting[]> {
531 model: UserNotificationSettingModel.unscoped(),
535 attributes: [ 'userId' ],
536 model: AccountModel.unscoped(),
541 model: ActorModel.unscoped(),
549 as: 'ActorFollowings',
550 model: ActorFollowModel.unscoped(),
554 targetActorId: actorId
564 return UserModel.unscoped().findAll(query)
567 static listByUsernames (usernames: string[]): Promise<MUserDefault[]> {
574 return UserModel.findAll(query)
577 static loadById (id: number): Promise<MUser> {
578 return UserModel.unscoped().findByPk(id)
581 static loadByIdFull (id: number): Promise<MUserDefault> {
582 return UserModel.findByPk(id)
585 static loadByIdWithChannels (id: number, withStats = false): Promise<MUserDefault> {
587 ScopeNames.WITH_VIDEOCHANNELS
591 scopes.push(ScopeNames.WITH_QUOTA)
592 scopes.push(ScopeNames.WITH_STATS)
595 return UserModel.scope(scopes).findByPk(id)
598 static loadByUsername (username: string): Promise<MUserDefault> {
605 return UserModel.findOne(query)
608 static loadForMeAPI (id: number): Promise<MUserNotifSettingChannelDefault> {
615 return UserModel.scope(ScopeNames.FOR_ME_API).findOne(query)
618 static loadByEmail (email: string): Promise<MUserDefault> {
625 return UserModel.findOne(query)
628 static loadByUsernameOrEmail (username: string, email?: string): Promise<MUserDefault> {
629 if (!email) email = username
634 where(fn('lower', col('username')), fn('lower', username) as any),
641 return UserModel.findOne(query)
644 static loadByVideoId (videoId: number): Promise<MUserDefault> {
649 attributes: [ 'id' ],
650 model: AccountModel.unscoped(),
654 attributes: [ 'id' ],
655 model: VideoChannelModel.unscoped(),
659 attributes: [ 'id' ],
660 model: VideoModel.unscoped(),
672 return UserModel.findOne(query)
675 static loadByVideoImportId (videoImportId: number): Promise<MUserDefault> {
680 attributes: [ 'id' ],
681 model: VideoImportModel.unscoped(),
689 return UserModel.findOne(query)
692 static loadByChannelActorId (videoChannelActorId: number): Promise<MUserDefault> {
697 attributes: [ 'id' ],
698 model: AccountModel.unscoped(),
702 attributes: [ 'id' ],
703 model: VideoChannelModel.unscoped(),
705 actorId: videoChannelActorId
713 return UserModel.findOne(query)
716 static loadByAccountActorId (accountActorId: number): Promise<MUserDefault> {
721 attributes: [ 'id' ],
722 model: AccountModel.unscoped(),
724 actorId: accountActorId
730 return UserModel.findOne(query)
733 static loadByLiveId (liveId: number): Promise<MUser> {
737 attributes: [ 'id' ],
738 model: AccountModel.unscoped(),
742 attributes: [ 'id' ],
743 model: VideoChannelModel.unscoped(),
747 attributes: [ 'id' ],
748 model: VideoModel.unscoped(),
753 model: VideoLiveModel.unscoped(),
768 return UserModel.unscoped().findOne(query)
771 static generateUserQuotaBaseSQL (options: {
772 whereUserId: '$userId' | '"UserModel"."id"'
776 const andWhere = options.daily === true
777 ? 'AND "video"."createdAt" > now() - interval \'24 hours\''
780 const videoChannelJoin = 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
781 'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
782 `WHERE "account"."userId" = ${options.whereUserId} ${andWhere}`
784 const webtorrentFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
785 'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" AND "video"."isLive" IS FALSE ' +
788 const hlsFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
789 'INNER JOIN "videoStreamingPlaylist" ON "videoFile"."videoStreamingPlaylistId" = "videoStreamingPlaylist".id ' +
790 'INNER JOIN "video" ON "videoStreamingPlaylist"."videoId" = "video"."id" AND "video"."isLive" IS FALSE ' +
793 return 'SELECT COALESCE(SUM("size"), 0) AS "total" ' +
795 `SELECT MAX("t1"."size") AS "size" FROM (${webtorrentFiles} UNION ${hlsFiles}) t1 ` +
796 'GROUP BY "t1"."videoId"' +
800 static getTotalRawQuery (query: string, userId: number) {
803 type: QueryTypes.SELECT as QueryTypes.SELECT
806 return UserModel.sequelize.query<{ total: string }>(query, options)
807 .then(([ { total } ]) => {
808 if (total === null) return 0
810 return parseInt(total, 10)
814 static async getStats () {
815 function getActiveUsers (days: number) {
819 literal(`"lastLoginDate" > NOW() - INTERVAL '${days}d'`)
824 return UserModel.unscoped().count(query)
827 const totalUsers = await UserModel.unscoped().count()
828 const totalDailyActiveUsers = await getActiveUsers(1)
829 const totalWeeklyActiveUsers = await getActiveUsers(7)
830 const totalMonthlyActiveUsers = await getActiveUsers(30)
831 const totalHalfYearActiveUsers = await getActiveUsers(180)
835 totalDailyActiveUsers,
836 totalWeeklyActiveUsers,
837 totalMonthlyActiveUsers,
838 totalHalfYearActiveUsers
842 static autoComplete (search: string) {
846 [Op.like]: `%${search}%`
852 return UserModel.findAll(query)
853 .then(u => u.map(u => u.username))
856 hasRight (right: UserRight) {
857 return hasUserRight(this.role, right)
860 hasAdminFlag (flag: UserAdminFlag) {
861 return this.adminFlags & flag
864 isPasswordMatch (password: string) {
865 return comparePassword(password, this.password)
868 toFormattedJSON (this: MUserFormattable, parameters: { withAdminFlags?: boolean } = {}): User {
869 const videoQuotaUsed = this.get('videoQuotaUsed')
870 const videoQuotaUsedDaily = this.get('videoQuotaUsedDaily')
871 const videosCount = this.get('videosCount')
872 const [ abusesCount, abusesAcceptedCount ] = (this.get('abusesCount') as string || ':').split(':')
873 const abusesCreatedCount = this.get('abusesCreatedCount')
874 const videoCommentsCount = this.get('videoCommentsCount')
878 username: this.username,
880 theme: getThemeOrDefault(this.theme, DEFAULT_USER_THEME_NAME),
882 pendingEmail: this.pendingEmail,
883 emailVerified: this.emailVerified,
885 nsfwPolicy: this.nsfwPolicy,
887 // FIXME: deprecated in 4.1
888 webTorrentEnabled: this.p2pEnabled,
889 p2pEnabled: this.p2pEnabled,
891 videosHistoryEnabled: this.videosHistoryEnabled,
892 autoPlayVideo: this.autoPlayVideo,
893 autoPlayNextVideo: this.autoPlayNextVideo,
894 autoPlayNextVideoPlaylist: this.autoPlayNextVideoPlaylist,
895 videoLanguages: this.videoLanguages,
899 label: USER_ROLE_LABELS[this.role]
902 videoQuota: this.videoQuota,
903 videoQuotaDaily: this.videoQuotaDaily,
905 videoQuotaUsed: videoQuotaUsed !== undefined
906 ? forceNumber(videoQuotaUsed) + LiveQuotaStore.Instance.getLiveQuotaOf(this.id)
909 videoQuotaUsedDaily: videoQuotaUsedDaily !== undefined
910 ? forceNumber(videoQuotaUsedDaily) + LiveQuotaStore.Instance.getLiveQuotaOf(this.id)
913 videosCount: videosCount !== undefined
914 ? forceNumber(videosCount)
916 abusesCount: abusesCount
917 ? forceNumber(abusesCount)
919 abusesAcceptedCount: abusesAcceptedCount
920 ? forceNumber(abusesAcceptedCount)
922 abusesCreatedCount: abusesCreatedCount !== undefined
923 ? forceNumber(abusesCreatedCount)
925 videoCommentsCount: videoCommentsCount !== undefined
926 ? forceNumber(videoCommentsCount)
929 noInstanceConfigWarningModal: this.noInstanceConfigWarningModal,
930 noWelcomeModal: this.noWelcomeModal,
931 noAccountSetupWarningModal: this.noAccountSetupWarningModal,
933 blocked: this.blocked,
934 blockedReason: this.blockedReason,
936 account: this.Account.toFormattedJSON(),
938 notificationSettings: this.NotificationSetting
939 ? this.NotificationSetting.toFormattedJSON()
944 createdAt: this.createdAt,
946 pluginAuth: this.pluginAuth,
948 lastLoginDate: this.lastLoginDate,
950 twoFactorEnabled: !!this.otpSecret
953 if (parameters.withAdminFlags) {
954 Object.assign(json, { adminFlags: this.adminFlags })
957 if (Array.isArray(this.Account.VideoChannels) === true) {
958 json.videoChannels = this.Account.VideoChannels
959 .map(c => c.toFormattedJSON())
961 if (v1.createdAt < v2.createdAt) return -1
962 if (v1.createdAt === v2.createdAt) return 0
971 toMeFormattedJSON (this: MMyUserFormattable): MyUser {
972 const formatted = this.toFormattedJSON({ withAdminFlags: true })
974 const specialPlaylists = this.Account.VideoPlaylists
975 .map(p => ({ id: p.id, name: p.name, type: p.type }))
977 return Object.assign(formatted, { specialPlaylists })