1 import * as Sequelize from 'sequelize'
3 AllowNull, BeforeCreate, BeforeUpdate, Column, CreatedAt, DataType, Default, DefaultScope, HasMany, HasOne, Is, IsEmail, Model,
4 Scopes, Table, UpdatedAt
5 } from 'sequelize-typescript'
6 import { hasUserRight, USER_ROLE_LABELS, UserRight } from '../../../shared'
7 import { User } from '../../../shared/models/users'
9 isUserAutoPlayVideoValid, isUserDisplayNSFWValid, isUserPasswordValid, isUserRoleValid, isUserUsernameValid,
11 } from '../../helpers/custom-validators/users'
12 import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto'
13 import { OAuthTokenModel } from '../oauth/oauth-token'
14 import { getSort, throwIfNotValid } from '../utils'
15 import { VideoChannelModel } from '../video/video-channel'
16 import { AccountModel } from './account'
21 model: () => AccountModel,
30 model: () => AccountModel,
32 include: [ () => VideoChannelModel ]
41 fields: [ 'username' ],
50 export class UserModel extends Model<UserModel> {
53 @Is('UserPassword', value => throwIfNotValid(value, isUserPasswordValid, 'user password'))
58 @Is('UserPassword', value => throwIfNotValid(value, isUserUsernameValid, 'user name'))
64 @Column(DataType.STRING(400))
69 @Is('UserDisplayNSFW', value => throwIfNotValid(value, isUserDisplayNSFWValid, 'display NSFW boolean'))
75 @Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean'))
77 autoPlayVideo: boolean
80 @Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role'))
85 @Is('UserVideoQuota', value => throwIfNotValid(value, isUserVideoQuotaValid, 'video quota'))
86 @Column(DataType.BIGINT)
95 @HasOne(() => AccountModel, {
100 Account: AccountModel
102 @HasMany(() => OAuthTokenModel, {
103 foreignKey: 'userId',
106 OAuthTokens: OAuthTokenModel[]
110 static cryptPasswordIfNeeded (instance: UserModel) {
111 if (instance.changed('password')) {
112 return cryptPassword(instance.password)
114 instance.password = hash
120 static countTotal () {
124 static getByUsername (username: string) {
129 include: [ { model: AccountModel, required: true } ]
132 return UserModel.findOne(query)
135 static listForApi (start: number, count: number, sort: string) {
139 order: [ getSort(sort) ]
142 return UserModel.findAndCountAll(query)
143 .then(({ rows, count }) => {
151 static loadById (id: number) {
152 return UserModel.findById(id)
155 static loadByUsername (username: string) {
162 return UserModel.findOne(query)
165 static loadByUsernameAndPopulateChannels (username: string) {
172 return UserModel.scope('withVideoChannel').findOne(query)
175 static loadByUsernameOrEmail (username: string, email: string) {
178 [ Sequelize.Op.or ]: [ { username }, { email } ]
182 return UserModel.findOne(query)
185 static getOriginalVideoFileTotalFromUser (user: UserModel) {
186 // Don't use sequelize because we need to use a sub query
187 const query = 'SELECT SUM("size") AS "total" FROM ' +
188 '(SELECT MAX("videoFile"."size") AS "size" FROM "videoFile" ' +
189 'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' +
190 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
191 'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
192 'INNER JOIN "user" ON "account"."userId" = "user"."id" ' +
193 'WHERE "user"."id" = $userId GROUP BY "video"."id") t'
196 bind: { userId: user.id },
197 type: Sequelize.QueryTypes.SELECT
199 return UserModel.sequelize.query(query, options)
200 .then(([ { total } ]) => {
201 if (total === null) return 0
203 return parseInt(total, 10)
207 hasRight (right: UserRight) {
208 return hasUserRight(this.role, right)
211 isPasswordMatch (password: string) {
212 return comparePassword(password, this.password)
215 toFormattedJSON (): User {
218 username: this.username,
220 displayNSFW: this.displayNSFW,
221 autoPlayVideo: this.autoPlayVideo,
223 roleLabel: USER_ROLE_LABELS[ this.role ],
224 videoQuota: this.videoQuota,
225 createdAt: this.createdAt,
226 account: this.Account.toFormattedJSON(),
230 if (Array.isArray(this.Account.VideoChannels) === true) {
231 json.videoChannels = this.Account.VideoChannels
232 .map(c => c.toFormattedJSON())
234 if (v1.createdAt < v2.createdAt) return -1
235 if (v1.createdAt === v2.createdAt) return 0
244 isAbleToUploadVideo (videoFile: Express.Multer.File) {
245 if (this.videoQuota === -1) return Promise.resolve(true)
247 return UserModel.getOriginalVideoFileTotalFromUser(this)
248 .then(totalBytes => {
249 return (videoFile.size + totalBytes) < this.videoQuota