PeerTube/server/models/account/user.ts

323 lines
7.4 KiB
TypeScript
Raw Normal View History

2017-05-22 20:58:25 +02:00
import * as Sequelize from 'sequelize'
2017-12-12 17:53:50 +01:00
import {
2018-03-01 13:02:09 +01:00
AllowNull,
BeforeCreate,
BeforeUpdate,
Column,
CreatedAt,
DataType,
Default,
DefaultScope,
HasMany,
HasOne,
Is,
IsEmail,
Model,
Scopes,
Table,
UpdatedAt
2017-12-12 17:53:50 +01:00
} from 'sequelize-typescript'
2017-11-14 10:57:56 +01:00
import { hasUserRight, USER_ROLE_LABELS, UserRight } from '../../../shared'
2018-02-01 11:08:10 +01:00
import { User, UserRole } from '../../../shared/models/users'
2017-05-15 22:22:03 +02:00
import {
2018-03-01 13:02:09 +01:00
isUserAutoPlayVideoValid,
2018-08-08 17:36:10 +02:00
isUserBlockedReasonValid,
2018-08-08 14:58:21 +02:00
isUserBlockedValid,
isUserNSFWPolicyValid,
2018-03-01 13:02:09 +01:00
isUserPasswordValid,
isUserRoleValid,
isUserUsernameValid,
2017-12-14 17:38:41 +01:00
isUserVideoQuotaValid
2017-12-12 17:53:50 +01:00
} from '../../helpers/custom-validators/users'
2017-12-28 11:16:08 +01:00
import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto'
2017-12-12 17:53:50 +01:00
import { OAuthTokenModel } from '../oauth/oauth-token'
import { getSort, throwIfNotValid } from '../utils'
import { VideoChannelModel } from '../video/video-channel'
import { AccountModel } from './account'
import { NSFWPolicyType } from '../../../shared/models/videos/nsfw-policy.type'
import { values } from 'lodash'
import { NSFW_POLICY_TYPES } from '../../initializers'
2017-12-12 17:53:50 +01:00
enum ScopeNames {
WITH_VIDEO_CHANNEL = 'WITH_VIDEO_CHANNEL'
}
2017-12-14 10:07:57 +01:00
@DefaultScope({
include: [
{
model: () => AccountModel,
required: true
}
]
})
@Scopes({
[ScopeNames.WITH_VIDEO_CHANNEL]: {
2017-12-14 10:07:57 +01:00
include: [
{
model: () => AccountModel,
required: true,
include: [ () => VideoChannelModel ]
}
]
}
})
2017-12-12 17:53:50 +01:00
@Table({
tableName: 'user',
indexes: [
2016-12-11 21:50:51 +01:00
{
2017-12-12 17:53:50 +01:00
fields: [ 'username' ],
unique: true
2016-12-11 21:50:51 +01:00
},
{
2017-12-12 17:53:50 +01:00
fields: [ 'email' ],
unique: true
2016-12-11 21:50:51 +01:00
}
2017-05-22 20:58:25 +02:00
]
2017-12-12 17:53:50 +01:00
})
export class UserModel extends Model<UserModel> {
@AllowNull(false)
@Is('UserPassword', value => throwIfNotValid(value, isUserPasswordValid, 'user password'))
@Column
password: string
@AllowNull(false)
@Is('UserPassword', value => throwIfNotValid(value, isUserUsernameValid, 'user name'))
@Column
username: string
@AllowNull(false)
@IsEmail
@Column(DataType.STRING(400))
email: string
@AllowNull(false)
@Is('UserNSFWPolicy', value => throwIfNotValid(value, isUserNSFWPolicyValid, 'NSFW policy'))
@Column(DataType.ENUM(values(NSFW_POLICY_TYPES)))
nsfwPolicy: NSFWPolicyType
2017-12-12 17:53:50 +01:00
@AllowNull(false)
@Default(true)
@Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean'))
@Column
autoPlayVideo: boolean
2018-08-08 14:58:21 +02:00
@AllowNull(false)
@Default(false)
@Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean'))
@Column
blocked: boolean
2018-08-08 17:36:10 +02:00
@AllowNull(true)
@Default(null)
@Is('UserBlockedReason', value => throwIfNotValid(value, isUserBlockedReasonValid, 'blocked reason'))
@Column
blockedReason: string
2017-12-12 17:53:50 +01:00
@AllowNull(false)
@Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role'))
@Column
role: number
@AllowNull(false)
@Is('UserVideoQuota', value => throwIfNotValid(value, isUserVideoQuotaValid, 'video quota'))
@Column(DataType.BIGINT)
videoQuota: number
@CreatedAt
createdAt: Date
@UpdatedAt
updatedAt: Date
@HasOne(() => AccountModel, {
foreignKey: 'userId',
onDelete: 'cascade',
hooks: true
2017-12-12 17:53:50 +01:00
})
Account: AccountModel
2017-12-12 17:53:50 +01:00
@HasMany(() => OAuthTokenModel, {
foreignKey: 'userId',
onDelete: 'cascade'
})
OAuthTokens: OAuthTokenModel[]
@BeforeCreate
@BeforeUpdate
static cryptPasswordIfNeeded (instance: UserModel) {
if (instance.changed('password')) {
return cryptPassword(instance.password)
.then(hash => {
instance.password = hash
return undefined
})
}
}
2016-08-25 17:57:37 +02:00
2017-12-12 17:53:50 +01:00
static countTotal () {
return this.count()
}
2017-12-12 17:53:50 +01:00
static listForApi (start: number, count: number, sort: string) {
const query = {
offset: start,
limit: count,
2018-02-19 11:31:50 +01:00
order: getSort(sort)
2017-12-12 17:53:50 +01:00
}
2017-10-24 19:41:09 +02:00
2017-12-12 17:53:50 +01:00
return UserModel.findAndCountAll(query)
.then(({ rows, count }) => {
return {
data: rows,
total: count
}
2017-10-24 19:41:09 +02:00
})
}
2018-02-01 11:08:10 +01:00
static listEmailsWithRight (right: UserRight) {
const roles = Object.keys(USER_ROLE_LABELS)
.map(k => parseInt(k, 10) as UserRole)
.filter(role => hasUserRight(role, right))
console.log(roles)
const query = {
attribute: [ 'email' ],
where: {
role: {
[Sequelize.Op.in]: roles
}
}
}
return UserModel.unscoped()
.findAll(query)
.then(u => u.map(u => u.email))
}
2017-12-12 17:53:50 +01:00
static loadById (id: number) {
2017-12-14 10:07:57 +01:00
return UserModel.findById(id)
2017-12-12 17:53:50 +01:00
}
2016-12-11 21:50:51 +01:00
2017-12-12 17:53:50 +01:00
static loadByUsername (username: string) {
const query = {
where: {
username
2017-12-14 10:07:57 +01:00
}
2017-12-12 17:53:50 +01:00
}
2017-12-12 17:53:50 +01:00
return UserModel.findOne(query)
2016-12-11 21:50:51 +01:00
}
2017-12-12 17:53:50 +01:00
static loadByUsernameAndPopulateChannels (username: string) {
const query = {
where: {
username
2017-12-14 10:07:57 +01:00
}
2017-12-12 17:53:50 +01:00
}
return UserModel.scope(ScopeNames.WITH_VIDEO_CHANNEL).findOne(query)
2016-12-11 21:50:51 +01:00
}
2018-01-30 13:27:07 +01:00
static loadByEmail (email: string) {
const query = {
where: {
email
}
}
return UserModel.findOne(query)
}
2018-01-29 16:09:50 +01:00
static loadByUsernameOrEmail (username: string, email?: string) {
if (!email) email = username
2017-12-12 17:53:50 +01:00
const query = {
where: {
[ Sequelize.Op.or ]: [ { username }, { email } ]
}
}
2017-12-14 10:07:57 +01:00
return UserModel.findOne(query)
2017-10-24 19:41:09 +02:00
}
2018-01-08 12:53:09 +01:00
static getOriginalVideoFileTotalFromUser (user: UserModel) {
2017-12-12 17:53:50 +01:00
// Don't use sequelize because we need to use a sub query
const query = 'SELECT SUM("size") AS "total" FROM ' +
'(SELECT MAX("videoFile"."size") AS "size" FROM "videoFile" ' +
'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" ' +
'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
'INNER JOIN "user" ON "account"."userId" = "user"."id" ' +
'WHERE "user"."id" = $userId GROUP BY "video"."id") t'
const options = {
bind: { userId: user.id },
type: Sequelize.QueryTypes.SELECT
}
return UserModel.sequelize.query(query, options)
.then(([ { total } ]) => {
if (total === null) return 0
2017-12-12 17:53:50 +01:00
return parseInt(total, 10)
})
2017-10-24 19:41:09 +02:00
}
2018-02-28 18:04:46 +01:00
static async getStats () {
const totalUsers = await UserModel.count()
return {
totalUsers
}
}
2017-12-12 17:53:50 +01:00
hasRight (right: UserRight) {
return hasUserRight(this.role, right)
}
2017-10-24 19:41:09 +02:00
2017-12-12 17:53:50 +01:00
isPasswordMatch (password: string) {
return comparePassword(password, this.password)
2016-12-11 21:50:51 +01:00
}
2017-12-29 19:10:13 +01:00
toFormattedJSON (): User {
2017-12-12 17:53:50 +01:00
const json = {
id: this.id,
username: this.username,
email: this.email,
nsfwPolicy: this.nsfwPolicy,
autoPlayVideo: this.autoPlayVideo,
2017-12-12 17:53:50 +01:00
role: this.role,
roleLabel: USER_ROLE_LABELS[ this.role ],
videoQuota: this.videoQuota,
createdAt: this.createdAt,
2018-08-08 17:36:10 +02:00
blocked: this.blocked,
blockedReason: this.blockedReason,
2017-12-29 19:10:13 +01:00
account: this.Account.toFormattedJSON(),
videoChannels: []
2017-12-12 17:53:50 +01:00
}
if (Array.isArray(this.Account.VideoChannels) === true) {
2017-12-29 19:10:13 +01:00
json.videoChannels = this.Account.VideoChannels
2017-12-12 17:53:50 +01:00
.map(c => c.toFormattedJSON())
.sort((v1, v2) => {
if (v1.createdAt < v2.createdAt) return -1
if (v1.createdAt === v2.createdAt) return 0
2017-02-18 09:29:59 +01:00
2017-12-12 17:53:50 +01:00
return 1
})
2017-02-18 09:29:59 +01:00
}
2017-12-12 17:53:50 +01:00
return json
2017-02-18 09:29:59 +01:00
}
2018-08-07 10:07:53 +02:00
isAbleToUploadVideo (videoFile: { size: number }) {
2017-12-12 17:53:50 +01:00
if (this.videoQuota === -1) return Promise.resolve(true)
2017-09-04 20:07:54 +02:00
2017-12-12 17:53:50 +01:00
return UserModel.getOriginalVideoFileTotalFromUser(this)
.then(totalBytes => {
return (videoFile.size + totalBytes) < this.videoQuota
})
2017-09-04 20:07:54 +02:00
}
}