1 import { col, FindOptions, fn, literal, Op, QueryTypes, where, WhereOptions } from 'sequelize'
21 } from 'sequelize-typescript'
22 import { hasUserRight, MyUser, USER_ROLE_LABELS, UserRight, VideoAbuseState, VideoPlaylistType, VideoPrivacy } from '../../../shared'
23 import { User, UserRole } from '../../../shared/models/users'
25 isNoInstanceConfigWarningModal,
27 isUserAdminFlagsValid,
28 isUserAutoPlayNextVideoPlaylistValid,
29 isUserAutoPlayNextVideoValid,
30 isUserAutoPlayVideoValid,
31 isUserBlockedReasonValid,
33 isUserEmailVerifiedValid,
34 isUserNSFWPolicyValid,
39 isUserVideoQuotaDailyValid,
40 isUserVideoQuotaValid,
41 isUserVideosHistoryEnabledValid,
42 isUserWebTorrentEnabledValid
43 } from '../../helpers/custom-validators/users'
44 import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto'
45 import { OAuthTokenModel } from '../oauth/oauth-token'
46 import { getSort, throwIfNotValid } from '../utils'
47 import { VideoChannelModel } from '../video/video-channel'
48 import { VideoPlaylistModel } from '../video/video-playlist'
49 import { AccountModel } from './account'
50 import { NSFWPolicyType } from '../../../shared/models/videos/nsfw-policy.type'
51 import { values } from 'lodash'
52 import { DEFAULT_USER_THEME_NAME, NSFW_POLICY_TYPES } from '../../initializers/constants'
53 import { clearCacheByUserId } from '../../lib/oauth-model'
54 import { UserNotificationSettingModel } from './user-notification-setting'
55 import { VideoModel } from '../video/video'
56 import { ActorModel } from '../activitypub/actor'
57 import { ActorFollowModel } from '../activitypub/actor-follow'
58 import { VideoImportModel } from '../video/video-import'
59 import { UserAdminFlag } from '../../../shared/models/users/user-flag.model'
60 import { isThemeNameValid } from '../../helpers/custom-validators/plugins'
61 import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
62 import * as Bluebird from 'bluebird'
68 MUserNotifSettingChannelDefault,
69 MUserWithNotificationSetting,
71 } from '@server/typings/models'
74 FOR_ME_API = 'FOR_ME_API',
75 WITH_VIDEOCHANNELS = 'WITH_VIDEOCHANNELS',
76 WITH_STATS = 'WITH_STATS'
79 @DefaultScope(() => ({
86 model: UserNotificationSettingModel,
92 [ScopeNames.FOR_ME_API]: {
98 model: VideoChannelModel
101 attributes: [ 'id', 'name', 'type' ],
102 model: VideoPlaylistModel.unscoped(),
106 [Op.ne]: VideoPlaylistType.REGULAR
113 model: UserNotificationSettingModel,
118 [ScopeNames.WITH_VIDEOCHANNELS]: {
124 model: VideoChannelModel
127 attributes: [ 'id', 'name', 'type' ],
128 model: VideoPlaylistModel.unscoped(),
132 [Op.ne]: VideoPlaylistType.REGULAR
140 [ScopeNames.WITH_STATS]: {
146 UserModel.generateUserQuotaBaseSQL({
148 whereUserId: '"UserModel"."id"'
157 'SELECT COUNT("video"."id") ' +
159 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
160 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
161 'WHERE "account"."userId" = "UserModel"."id"' +
169 `SELECT concat_ws(':', "abuses", "acceptedAbuses") ` +
171 'SELECT COUNT("videoAbuse"."id") AS "abuses", ' +
172 `COUNT("videoAbuse"."id") FILTER (WHERE "videoAbuse"."state" = ${VideoAbuseState.ACCEPTED}) AS "acceptedAbuses" ` +
173 'FROM "videoAbuse" ' +
174 'INNER JOIN "video" ON "videoAbuse"."videoId" = "video"."id" ' +
175 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
176 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
177 'WHERE "account"."userId" = "UserModel"."id"' +
186 'SELECT COUNT("videoAbuse"."id") ' +
187 'FROM "videoAbuse" ' +
188 'INNER JOIN "account" ON "account"."id" = "videoAbuse"."reporterAccountId" ' +
189 'WHERE "account"."userId" = "UserModel"."id"' +
192 'videoAbusesCreatedCount'
197 'SELECT COUNT("videoComment"."id") ' +
198 'FROM "videoComment" ' +
199 'INNER JOIN "account" ON "account"."id" = "videoComment"."accountId" ' +
200 'WHERE "account"."userId" = "UserModel"."id"' +
213 fields: [ 'username' ],
222 export class UserModel extends Model<UserModel> {
225 @Is('UserPassword', value => throwIfNotValid(value, isUserPasswordValid, 'user password', true))
230 @Is('UserUsername', value => throwIfNotValid(value, isUserUsernameValid, 'user name'))
236 @Column(DataType.STRING(400))
241 @Column(DataType.STRING(400))
246 @Is('UserEmailVerified', value => throwIfNotValid(value, isUserEmailVerifiedValid, 'email verified boolean', true))
248 emailVerified: boolean
251 @Is('UserNSFWPolicy', value => throwIfNotValid(value, isUserNSFWPolicyValid, 'NSFW policy'))
252 @Column(DataType.ENUM(...values(NSFW_POLICY_TYPES)))
253 nsfwPolicy: NSFWPolicyType
257 @Is('UserWebTorrentEnabled', value => throwIfNotValid(value, isUserWebTorrentEnabledValid, 'WebTorrent enabled'))
259 webTorrentEnabled: boolean
263 @Is('UserVideosHistoryEnabled', value => throwIfNotValid(value, isUserVideosHistoryEnabledValid, 'Videos history enabled'))
265 videosHistoryEnabled: boolean
269 @Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean'))
271 autoPlayVideo: boolean
275 @Is('UserAutoPlayNextVideo', value => throwIfNotValid(value, isUserAutoPlayNextVideoValid, 'auto play next video boolean'))
277 autoPlayNextVideo: boolean
282 'UserAutoPlayNextVideoPlaylist',
283 value => throwIfNotValid(value, isUserAutoPlayNextVideoPlaylistValid, 'auto play next video for playlists boolean')
286 autoPlayNextVideoPlaylist: boolean
290 @Is('UserVideoLanguages', value => throwIfNotValid(value, isUserVideoLanguages, 'video languages'))
291 @Column(DataType.ARRAY(DataType.STRING))
292 videoLanguages: string[]
295 @Default(UserAdminFlag.NONE)
296 @Is('UserAdminFlags', value => throwIfNotValid(value, isUserAdminFlagsValid, 'user admin flags'))
298 adminFlags?: UserAdminFlag
302 @Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean'))
308 @Is('UserBlockedReason', value => throwIfNotValid(value, isUserBlockedReasonValid, 'blocked reason', true))
310 blockedReason: string
313 @Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role'))
318 @Is('UserVideoQuota', value => throwIfNotValid(value, isUserVideoQuotaValid, 'video quota'))
319 @Column(DataType.BIGINT)
323 @Is('UserVideoQuotaDaily', value => throwIfNotValid(value, isUserVideoQuotaDailyValid, 'video quota daily'))
324 @Column(DataType.BIGINT)
325 videoQuotaDaily: number
328 @Default(DEFAULT_USER_THEME_NAME)
329 @Is('UserTheme', value => throwIfNotValid(value, isThemeNameValid, 'theme'))
336 'UserNoInstanceConfigWarningModal',
337 value => throwIfNotValid(value, isNoInstanceConfigWarningModal, 'no instance config warning modal')
340 noInstanceConfigWarningModal: boolean
345 'UserNoInstanceConfigWarningModal',
346 value => throwIfNotValid(value, isNoWelcomeModal, 'no welcome modal')
349 noWelcomeModal: boolean
362 @HasOne(() => AccountModel, {
363 foreignKey: 'userId',
367 Account: AccountModel
369 @HasOne(() => UserNotificationSettingModel, {
370 foreignKey: 'userId',
374 NotificationSetting: UserNotificationSettingModel
376 @HasMany(() => VideoImportModel, {
377 foreignKey: 'userId',
380 VideoImports: VideoImportModel[]
382 @HasMany(() => OAuthTokenModel, {
383 foreignKey: 'userId',
386 OAuthTokens: OAuthTokenModel[]
390 static cryptPasswordIfNeeded (instance: UserModel) {
391 if (instance.changed('password') && instance.password) {
392 return cryptPassword(instance.password)
394 instance.password = hash
402 static removeTokenCache (instance: UserModel) {
403 return clearCacheByUserId(instance.id)
406 static countTotal () {
410 static listForApi (start: number, count: number, sort: string, search?: string) {
411 let where: WhereOptions
418 [Op.iLike]: '%' + search + '%'
423 [Op.iLike]: '%' + search + '%'
430 const query: FindOptions = {
436 UserModel.generateUserQuotaBaseSQL({
438 whereUserId: '"UserModel"."id"'
443 ] as any // FIXME: typings
448 order: getSort(sort),
452 return UserModel.findAndCountAll(query)
453 .then(({ rows, count }) => {
461 static listWithRight (right: UserRight): Bluebird<MUserDefault[]> {
462 const roles = Object.keys(USER_ROLE_LABELS)
463 .map(k => parseInt(k, 10) as UserRole)
464 .filter(role => hasUserRight(role, right))
474 return UserModel.findAll(query)
477 static listUserSubscribersOf (actorId: number): Bluebird<MUserWithNotificationSetting[]> {
481 model: UserNotificationSettingModel.unscoped(),
485 attributes: [ 'userId' ],
486 model: AccountModel.unscoped(),
491 model: ActorModel.unscoped(),
499 as: 'ActorFollowings',
500 model: ActorFollowModel.unscoped(),
503 targetActorId: actorId
513 return UserModel.unscoped().findAll(query)
516 static listByUsernames (usernames: string[]): Bluebird<MUserDefault[]> {
523 return UserModel.findAll(query)
526 static loadById (id: number, withStats = false): Bluebird<MUserDefault> {
528 ScopeNames.WITH_VIDEOCHANNELS
531 if (withStats) scopes.push(ScopeNames.WITH_STATS)
533 return UserModel.scope(scopes).findByPk(id)
536 static loadByUsername (username: string): Bluebird<MUserDefault> {
539 username: { [Op.iLike]: username }
543 return UserModel.findOne(query)
546 static loadForMeAPI (username: string): Bluebird<MUserNotifSettingChannelDefault> {
549 username: { [Op.iLike]: username }
553 return UserModel.scope(ScopeNames.FOR_ME_API).findOne(query)
556 static loadByEmail (email: string): Bluebird<MUserDefault> {
563 return UserModel.findOne(query)
566 static loadByUsernameOrEmail (username: string, email?: string): Bluebird<MUserDefault> {
567 if (!email) email = username
572 where(fn('lower', col('username')), fn('lower', username)),
579 return UserModel.findOne(query)
582 static loadByVideoId (videoId: number): Bluebird<MUserDefault> {
587 attributes: [ 'id' ],
588 model: AccountModel.unscoped(),
592 attributes: [ 'id' ],
593 model: VideoChannelModel.unscoped(),
597 attributes: [ 'id' ],
598 model: VideoModel.unscoped(),
610 return UserModel.findOne(query)
613 static loadByVideoImportId (videoImportId: number): Bluebird<MUserDefault> {
618 attributes: [ 'id' ],
619 model: VideoImportModel.unscoped(),
627 return UserModel.findOne(query)
630 static loadByChannelActorId (videoChannelActorId: number): Bluebird<MUserDefault> {
635 attributes: [ 'id' ],
636 model: AccountModel.unscoped(),
640 attributes: [ 'id' ],
641 model: VideoChannelModel.unscoped(),
643 actorId: videoChannelActorId
651 return UserModel.findOne(query)
654 static loadByAccountActorId (accountActorId: number): Bluebird<MUserDefault> {
659 attributes: [ 'id' ],
660 model: AccountModel.unscoped(),
662 actorId: accountActorId
668 return UserModel.findOne(query)
671 static getOriginalVideoFileTotalFromUser (user: MUserId) {
672 // Don't use sequelize because we need to use a sub query
673 const query = UserModel.generateUserQuotaBaseSQL({
675 whereUserId: '$userId'
678 return UserModel.getTotalRawQuery(query, user.id)
681 // Returns cumulative size of all video files uploaded in the last 24 hours.
682 static getOriginalVideoFileTotalDailyFromUser (user: MUserId) {
683 // Don't use sequelize because we need to use a sub query
684 const query = UserModel.generateUserQuotaBaseSQL({
686 whereUserId: '$userId',
687 where: '"video"."createdAt" > now() - interval \'24 hours\''
690 return UserModel.getTotalRawQuery(query, user.id)
693 static async getStats () {
694 const totalUsers = await UserModel.count()
701 static autoComplete (search: string) {
705 [Op.like]: `%${search}%`
711 return UserModel.findAll(query)
712 .then(u => u.map(u => u.username))
715 canGetVideo (video: MVideoFullLight) {
716 const videoUserId = video.VideoChannel.Account.userId
718 if (video.isBlacklisted()) {
719 return videoUserId === this.id || this.hasRight(UserRight.MANAGE_VIDEO_BLACKLIST)
722 if (video.privacy === VideoPrivacy.PRIVATE) {
723 return video.VideoChannel && videoUserId === this.id || this.hasRight(UserRight.MANAGE_VIDEO_BLACKLIST)
726 if (video.privacy === VideoPrivacy.INTERNAL) return true
731 hasRight (right: UserRight) {
732 return hasUserRight(this.role, right)
735 hasAdminFlag (flag: UserAdminFlag) {
736 return this.adminFlags & flag
739 isPasswordMatch (password: string) {
740 return comparePassword(password, this.password)
743 toFormattedJSON (this: MUserFormattable, parameters: { withAdminFlags?: boolean } = {}): User {
744 const videoQuotaUsed = this.get('videoQuotaUsed')
745 const videoQuotaUsedDaily = this.get('videoQuotaUsedDaily')
746 const videosCount = this.get('videosCount')
747 const [ videoAbusesCount, videoAbusesAcceptedCount ] = (this.get('videoAbusesCount') as string || ':').split(':')
748 const videoAbusesCreatedCount = this.get('videoAbusesCreatedCount')
749 const videoCommentsCount = this.get('videoCommentsCount')
753 username: this.username,
755 theme: getThemeOrDefault(this.theme, DEFAULT_USER_THEME_NAME),
757 pendingEmail: this.pendingEmail,
758 emailVerified: this.emailVerified,
760 nsfwPolicy: this.nsfwPolicy,
761 webTorrentEnabled: this.webTorrentEnabled,
762 videosHistoryEnabled: this.videosHistoryEnabled,
763 autoPlayVideo: this.autoPlayVideo,
764 autoPlayNextVideo: this.autoPlayNextVideo,
765 autoPlayNextVideoPlaylist: this.autoPlayNextVideoPlaylist,
766 videoLanguages: this.videoLanguages,
769 roleLabel: USER_ROLE_LABELS[this.role],
771 videoQuota: this.videoQuota,
772 videoQuotaDaily: this.videoQuotaDaily,
773 videoQuotaUsed: videoQuotaUsed !== undefined
774 ? parseInt(videoQuotaUsed + '', 10)
776 videoQuotaUsedDaily: videoQuotaUsedDaily !== undefined
777 ? parseInt(videoQuotaUsedDaily + '', 10)
779 videosCount: videosCount !== undefined
780 ? parseInt(videosCount + '', 10)
782 videoAbusesCount: videoAbusesCount
783 ? parseInt(videoAbusesCount, 10)
785 videoAbusesAcceptedCount: videoAbusesAcceptedCount
786 ? parseInt(videoAbusesAcceptedCount, 10)
788 videoAbusesCreatedCount: videoAbusesCreatedCount !== undefined
789 ? parseInt(videoAbusesCreatedCount + '', 10)
791 videoCommentsCount: videoCommentsCount !== undefined
792 ? parseInt(videoCommentsCount + '', 10)
795 noInstanceConfigWarningModal: this.noInstanceConfigWarningModal,
796 noWelcomeModal: this.noWelcomeModal,
798 blocked: this.blocked,
799 blockedReason: this.blockedReason,
801 account: this.Account.toFormattedJSON(),
803 notificationSettings: this.NotificationSetting
804 ? this.NotificationSetting.toFormattedJSON()
809 createdAt: this.createdAt
812 if (parameters.withAdminFlags) {
813 Object.assign(json, { adminFlags: this.adminFlags })
816 if (Array.isArray(this.Account.VideoChannels) === true) {
817 json.videoChannels = this.Account.VideoChannels
818 .map(c => c.toFormattedJSON())
820 if (v1.createdAt < v2.createdAt) return -1
821 if (v1.createdAt === v2.createdAt) return 0
830 toMeFormattedJSON (this: MMyUserFormattable): MyUser {
831 const formatted = this.toFormattedJSON()
833 const specialPlaylists = this.Account.VideoPlaylists
834 .map(p => ({ id: p.id, name: p.name, type: p.type }))
836 return Object.assign(formatted, { specialPlaylists })
839 async isAbleToUploadVideo (videoFile: { size: number }) {
840 if (this.videoQuota === -1 && this.videoQuotaDaily === -1) return Promise.resolve(true)
842 const [ totalBytes, totalBytesDaily ] = await Promise.all([
843 UserModel.getOriginalVideoFileTotalFromUser(this),
844 UserModel.getOriginalVideoFileTotalDailyFromUser(this)
847 const uploadedTotal = videoFile.size + totalBytes
848 const uploadedDaily = videoFile.size + totalBytesDaily
850 if (this.videoQuotaDaily === -1) return uploadedTotal < this.videoQuota
851 if (this.videoQuota === -1) return uploadedDaily < this.videoQuotaDaily
853 return uploadedTotal < this.videoQuota && uploadedDaily < this.videoQuotaDaily
856 private static generateUserQuotaBaseSQL (options: {
857 whereUserId: '$userId' | '"UserModel"."id"'
861 const andWhere = options.where
862 ? 'AND ' + options.where
865 const videoChannelJoin = 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
866 'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
867 `WHERE "account"."userId" = ${options.whereUserId} ${andWhere}`
869 const webtorrentFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
870 'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' +
873 const hlsFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
874 'INNER JOIN "videoStreamingPlaylist" ON "videoFile"."videoStreamingPlaylistId" = "videoStreamingPlaylist".id ' +
875 'INNER JOIN "video" ON "videoStreamingPlaylist"."videoId" = "video"."id" ' +
878 return 'SELECT COALESCE(SUM("size"), 0) AS "total" ' +
880 `SELECT MAX("t1"."size") AS "size" FROM (${webtorrentFiles} UNION ${hlsFiles}) t1 ` +
881 'GROUP BY "t1"."videoId"' +
885 private static getTotalRawQuery (query: string, userId: number) {
888 type: QueryTypes.SELECT as QueryTypes.SELECT
891 return UserModel.sequelize.query<{ total: string }>(query, options)
892 .then(([ { total } ]) => {
893 if (total === null) return 0
895 return parseInt(total, 10)