123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642 |
- import { FindOptions, literal, Op, QueryTypes } from 'sequelize'
- import {
- AfterDestroy,
- AfterUpdate,
- AllowNull,
- BeforeCreate,
- BeforeUpdate,
- Column,
- CreatedAt,
- DataType,
- Default,
- DefaultScope,
- HasMany,
- HasOne,
- Is,
- IsEmail,
- Model,
- Scopes,
- Table,
- UpdatedAt
- } from 'sequelize-typescript'
- import { hasUserRight, USER_ROLE_LABELS, UserRight } from '../../../shared'
- import { User, UserRole } from '../../../shared/models/users'
- import {
- isUserAdminFlagsValid,
- isUserAutoPlayVideoValid,
- isUserBlockedReasonValid,
- isUserBlockedValid,
- isUserEmailVerifiedValid,
- isUserNSFWPolicyValid,
- isUserPasswordValid,
- isUserRoleValid,
- isUserUsernameValid,
- isUserVideoLanguages,
- isUserVideoQuotaDailyValid,
- isUserVideoQuotaValid,
- isUserVideosHistoryEnabledValid,
- isUserWebTorrentEnabledValid
- } from '../../helpers/custom-validators/users'
- import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto'
- 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/constants'
- import { clearCacheByUserId } from '../../lib/oauth-model'
- import { UserNotificationSettingModel } from './user-notification-setting'
- import { VideoModel } from '../video/video'
- import { ActorModel } from '../activitypub/actor'
- import { ActorFollowModel } from '../activitypub/actor-follow'
- import { VideoImportModel } from '../video/video-import'
- import { UserAdminFlag } from '../../../shared/models/users/user-flag.model'
- enum ScopeNames {
- WITH_VIDEO_CHANNEL = 'WITH_VIDEO_CHANNEL'
- }
- @DefaultScope(() => ({
- include: [
- {
- model: AccountModel,
- required: true
- },
- {
- model: UserNotificationSettingModel,
- required: true
- }
- ]
- }))
- @Scopes(() => ({
- [ScopeNames.WITH_VIDEO_CHANNEL]: {
- include: [
- {
- model: AccountModel,
- required: true,
- include: [ VideoChannelModel ]
- },
- {
- model: UserNotificationSettingModel,
- required: true
- }
- ]
- }
- }))
- @Table({
- tableName: 'user',
- indexes: [
- {
- fields: [ 'username' ],
- unique: true
- },
- {
- fields: [ 'email' ],
- unique: true
- }
- ]
- })
- 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(true)
- @IsEmail
- @Column(DataType.STRING(400))
- pendingEmail: string
- @AllowNull(true)
- @Default(null)
- @Is('UserEmailVerified', value => throwIfNotValid(value, isUserEmailVerifiedValid, 'email verified boolean', true))
- @Column
- emailVerified: boolean
- @AllowNull(false)
- @Is('UserNSFWPolicy', value => throwIfNotValid(value, isUserNSFWPolicyValid, 'NSFW policy'))
- @Column(DataType.ENUM(...values(NSFW_POLICY_TYPES)))
- nsfwPolicy: NSFWPolicyType
- @AllowNull(false)
- @Default(true)
- @Is('UserWebTorrentEnabled', value => throwIfNotValid(value, isUserWebTorrentEnabledValid, 'WebTorrent enabled'))
- @Column
- webTorrentEnabled: boolean
- @AllowNull(false)
- @Default(true)
- @Is('UserVideosHistoryEnabled', value => throwIfNotValid(value, isUserVideosHistoryEnabledValid, 'Videos history enabled'))
- @Column
- videosHistoryEnabled: boolean
- @AllowNull(false)
- @Default(true)
- @Is('UserAutoPlayVideo', value => throwIfNotValid(value, isUserAutoPlayVideoValid, 'auto play video boolean'))
- @Column
- autoPlayVideo: boolean
- @AllowNull(true)
- @Default(null)
- @Is('UserVideoLanguages', value => throwIfNotValid(value, isUserVideoLanguages, 'video languages'))
- @Column(DataType.ARRAY(DataType.STRING))
- videoLanguages: string[]
- @AllowNull(false)
- @Default(UserAdminFlag.NONE)
- @Is('UserAdminFlags', value => throwIfNotValid(value, isUserAdminFlagsValid, 'user admin flags'))
- @Column
- adminFlags?: UserAdminFlag
- @AllowNull(false)
- @Default(false)
- @Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean'))
- @Column
- blocked: boolean
- @AllowNull(true)
- @Default(null)
- @Is('UserBlockedReason', value => throwIfNotValid(value, isUserBlockedReasonValid, 'blocked reason', true))
- @Column
- blockedReason: string
- @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
- @AllowNull(false)
- @Is('UserVideoQuotaDaily', value => throwIfNotValid(value, isUserVideoQuotaDailyValid, 'video quota daily'))
- @Column(DataType.BIGINT)
- videoQuotaDaily: number
- @CreatedAt
- createdAt: Date
- @UpdatedAt
- updatedAt: Date
- @HasOne(() => AccountModel, {
- foreignKey: 'userId',
- onDelete: 'cascade',
- hooks: true
- })
- Account: AccountModel
- @HasOne(() => UserNotificationSettingModel, {
- foreignKey: 'userId',
- onDelete: 'cascade',
- hooks: true
- })
- NotificationSetting: UserNotificationSettingModel
- @HasMany(() => VideoImportModel, {
- foreignKey: 'userId',
- onDelete: 'cascade'
- })
- VideoImports: VideoImportModel[]
- @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
- })
- }
- }
- @AfterUpdate
- @AfterDestroy
- static removeTokenCache (instance: UserModel) {
- return clearCacheByUserId(instance.id)
- }
- static countTotal () {
- return this.count()
- }
- static listForApi (start: number, count: number, sort: string, search?: string) {
- let where = undefined
- if (search) {
- where = {
- [Op.or]: [
- {
- email: {
- [Op.iLike]: '%' + search + '%'
- }
- },
- {
- username: {
- [ Op.iLike ]: '%' + search + '%'
- }
- }
- ]
- }
- }
- const query: FindOptions = {
- attributes: {
- include: [
- [
- literal(
- '(' +
- 'SELECT COALESCE(SUM("size"), 0) ' +
- '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" ' +
- 'WHERE "account"."userId" = "UserModel"."id" GROUP BY "video"."id"' +
- ') t' +
- ')'
- ),
- 'videoQuotaUsed'
- ]
- ]
- },
- offset: start,
- limit: count,
- order: getSort(sort),
- where
- }
- return UserModel.findAndCountAll(query)
- .then(({ rows, count }) => {
- return {
- data: rows,
- total: count
- }
- })
- }
- static listWithRight (right: UserRight) {
- const roles = Object.keys(USER_ROLE_LABELS)
- .map(k => parseInt(k, 10) as UserRole)
- .filter(role => hasUserRight(role, right))
- const query = {
- where: {
- role: {
- [Op.in]: roles
- }
- }
- }
- return UserModel.findAll(query)
- }
- static listUserSubscribersOf (actorId: number) {
- const query = {
- include: [
- {
- model: UserNotificationSettingModel.unscoped(),
- required: true
- },
- {
- attributes: [ 'userId' ],
- model: AccountModel.unscoped(),
- required: true,
- include: [
- {
- attributes: [ ],
- model: ActorModel.unscoped(),
- required: true,
- where: {
- serverId: null
- },
- include: [
- {
- attributes: [ ],
- as: 'ActorFollowings',
- model: ActorFollowModel.unscoped(),
- required: true,
- where: {
- targetActorId: actorId
- }
- }
- ]
- }
- ]
- }
- ]
- }
- return UserModel.unscoped().findAll(query)
- }
- static listByUsernames (usernames: string[]) {
- const query = {
- where: {
- username: usernames
- }
- }
- return UserModel.findAll(query)
- }
- static loadById (id: number) {
- return UserModel.findByPk(id)
- }
- static loadByUsername (username: string) {
- const query = {
- where: {
- username
- }
- }
- return UserModel.findOne(query)
- }
- static loadByUsernameAndPopulateChannels (username: string) {
- const query = {
- where: {
- username
- }
- }
- return UserModel.scope(ScopeNames.WITH_VIDEO_CHANNEL).findOne(query)
- }
- static loadByEmail (email: string) {
- const query = {
- where: {
- email
- }
- }
- return UserModel.findOne(query)
- }
- static loadByUsernameOrEmail (username: string, email?: string) {
- if (!email) email = username
- const query = {
- where: {
- [ Op.or ]: [ { username }, { email } ]
- }
- }
- return UserModel.findOne(query)
- }
- static loadByVideoId (videoId: number) {
- const query = {
- include: [
- {
- required: true,
- attributes: [ 'id' ],
- model: AccountModel.unscoped(),
- include: [
- {
- required: true,
- attributes: [ 'id' ],
- model: VideoChannelModel.unscoped(),
- include: [
- {
- required: true,
- attributes: [ 'id' ],
- model: VideoModel.unscoped(),
- where: {
- id: videoId
- }
- }
- ]
- }
- ]
- }
- ]
- }
- return UserModel.findOne(query)
- }
- static loadByVideoImportId (videoImportId: number) {
- const query = {
- include: [
- {
- required: true,
- attributes: [ 'id' ],
- model: VideoImportModel.unscoped(),
- where: {
- id: videoImportId
- }
- }
- ]
- }
- return UserModel.findOne(query)
- }
- static loadByChannelActorId (videoChannelActorId: number) {
- const query = {
- include: [
- {
- required: true,
- attributes: [ 'id' ],
- model: AccountModel.unscoped(),
- include: [
- {
- required: true,
- attributes: [ 'id' ],
- model: VideoChannelModel.unscoped(),
- where: {
- actorId: videoChannelActorId
- }
- }
- ]
- }
- ]
- }
- return UserModel.findOne(query)
- }
- static loadByAccountActorId (accountActorId: number) {
- const query = {
- include: [
- {
- required: true,
- attributes: [ 'id' ],
- model: AccountModel.unscoped(),
- where: {
- actorId: accountActorId
- }
- }
- ]
- }
- return UserModel.findOne(query)
- }
- static getOriginalVideoFileTotalFromUser (user: UserModel) {
- // Don't use sequelize because we need to use a sub query
- const query = UserModel.generateUserQuotaBaseSQL()
- return UserModel.getTotalRawQuery(query, user.id)
- }
- // Returns cumulative size of all video files uploaded in the last 24 hours.
- static getOriginalVideoFileTotalDailyFromUser (user: UserModel) {
- // Don't use sequelize because we need to use a sub query
- const query = UserModel.generateUserQuotaBaseSQL('"video"."createdAt" > now() - interval \'24 hours\'')
- return UserModel.getTotalRawQuery(query, user.id)
- }
- static async getStats () {
- const totalUsers = await UserModel.count()
- return {
- totalUsers
- }
- }
- static autoComplete (search: string) {
- const query = {
- where: {
- username: {
- [ Op.like ]: `%${search}%`
- }
- },
- limit: 10
- }
- return UserModel.findAll(query)
- .then(u => u.map(u => u.username))
- }
- hasRight (right: UserRight) {
- return hasUserRight(this.role, right)
- }
- hasAdminFlag (flag: UserAdminFlag) {
- return this.adminFlags & flag
- }
- isPasswordMatch (password: string) {
- return comparePassword(password, this.password)
- }
- toFormattedJSON (parameters: { withAdminFlags?: boolean } = {}): User {
- const videoQuotaUsed = this.get('videoQuotaUsed')
- const videoQuotaUsedDaily = this.get('videoQuotaUsedDaily')
- const json = {
- id: this.id,
- username: this.username,
- email: this.email,
- pendingEmail: this.pendingEmail,
- emailVerified: this.emailVerified,
- nsfwPolicy: this.nsfwPolicy,
- webTorrentEnabled: this.webTorrentEnabled,
- videosHistoryEnabled: this.videosHistoryEnabled,
- autoPlayVideo: this.autoPlayVideo,
- videoLanguages: this.videoLanguages,
- role: this.role,
- roleLabel: USER_ROLE_LABELS[ this.role ],
- videoQuota: this.videoQuota,
- videoQuotaDaily: this.videoQuotaDaily,
- createdAt: this.createdAt,
- blocked: this.blocked,
- blockedReason: this.blockedReason,
- account: this.Account.toFormattedJSON(),
- notificationSettings: this.NotificationSetting ? this.NotificationSetting.toFormattedJSON() : undefined,
- videoChannels: [],
- videoQuotaUsed: videoQuotaUsed !== undefined
- ? parseInt(videoQuotaUsed + '', 10)
- : undefined,
- videoQuotaUsedDaily: videoQuotaUsedDaily !== undefined
- ? parseInt(videoQuotaUsedDaily + '', 10)
- : undefined
- }
- if (parameters.withAdminFlags) {
- Object.assign(json, { adminFlags: this.adminFlags })
- }
- if (Array.isArray(this.Account.VideoChannels) === true) {
- json.videoChannels = this.Account.VideoChannels
- .map(c => c.toFormattedJSON())
- .sort((v1, v2) => {
- if (v1.createdAt < v2.createdAt) return -1
- if (v1.createdAt === v2.createdAt) return 0
- return 1
- })
- }
- return json
- }
- async isAbleToUploadVideo (videoFile: { size: number }) {
- if (this.videoQuota === -1 && this.videoQuotaDaily === -1) return Promise.resolve(true)
- const [ totalBytes, totalBytesDaily ] = await Promise.all([
- UserModel.getOriginalVideoFileTotalFromUser(this),
- UserModel.getOriginalVideoFileTotalDailyFromUser(this)
- ])
- const uploadedTotal = videoFile.size + totalBytes
- const uploadedDaily = videoFile.size + totalBytesDaily
- if (this.videoQuotaDaily === -1) return uploadedTotal < this.videoQuota
- if (this.videoQuota === -1) return uploadedDaily < this.videoQuotaDaily
- return uploadedTotal < this.videoQuota && uploadedDaily < this.videoQuotaDaily
- }
- private static generateUserQuotaBaseSQL (where?: string) {
- const andWhere = where ? 'AND ' + where : ''
- return '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" ' +
- 'WHERE "account"."userId" = $userId ' + andWhere +
- 'GROUP BY "video"."id"' +
- ') t'
- }
- private static getTotalRawQuery (query: string, userId: number) {
- const options = {
- bind: { userId },
- type: QueryTypes.SELECT as QueryTypes.SELECT
- }
- return UserModel.sequelize.query<{ total: string }>(query, options)
- .then(([ { total } ]) => {
- if (total === null) return 0
- return parseInt(total, 10)
- })
- }
- }
|