-import * as Sequelize from 'sequelize'
+import { FindOptions, literal, Op, QueryTypes } from 'sequelize'
import {
+ AfterDestroy,
+ AfterUpdate,
AllowNull,
BeforeCreate,
BeforeUpdate,
- Column, CreatedAt,
+ Column,
+ CreatedAt,
DataType,
Default,
+ DefaultScope,
HasMany,
HasOne,
Is,
IsEmail,
Model,
- Table, UpdatedAt
+ Scopes,
+ Table,
+ UpdatedAt
} from 'sequelize-typescript'
import { hasUserRight, USER_ROLE_LABELS, UserRight } from '../../../shared'
+import { User, UserRole } from '../../../shared/models/users'
import {
- comparePassword,
- cryptPassword
-} from '../../helpers'
-import {
- isUserDisplayNSFWValid, isUserPasswordValid, isUserRoleValid, isUserUsernameValid,
- isUserVideoQuotaValid
+ 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 { DEFAULT_THEME_NAME, DEFAULT_USER_THEME_NAME, 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'
+import { isThemeValid } from '../../helpers/custom-validators/plugins'
+import { getThemeOrDefault } from '../../lib/plugins/theme-utils'
+
+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: [
@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('UserDisplayNSFW', value => throwIfNotValid(value, isUserDisplayNSFWValid, 'display NSFW boolean'))
+ @Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean'))
@Column
- displayNSFW: boolean
+ 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(DataType.BIGINT)
videoQuota: number
+ @AllowNull(false)
+ @Is('UserVideoQuotaDaily', value => throwIfNotValid(value, isUserVideoQuotaDailyValid, 'video quota daily'))
+ @Column(DataType.BIGINT)
+ videoQuotaDaily: number
+
+ @AllowNull(false)
+ @Default(DEFAULT_THEME_NAME)
+ @Is('UserTheme', value => throwIfNotValid(value, isThemeValid, 'theme'))
+ @Column
+ theme: string
+
@CreatedAt
createdAt: Date
@HasOne(() => AccountModel, {
foreignKey: 'userId',
- onDelete: 'cascade'
+ 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'
}
}
+ @AfterUpdate
+ @AfterDestroy
+ static removeTokenCache (instance: UserModel) {
+ return clearCacheByUserId(instance.id)
+ }
+
static countTotal () {
return this.count()
}
- static getByUsername (username: string) {
- const query = {
- where: {
- username: username
- },
- include: [ { model: AccountModel, required: true } ]
+ 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 + '%'
+ }
+ }
+ ]
+ }
}
- return UserModel.findOne(query)
- }
-
- static listForApi (start: number, count: number, sort: string) {
- const query = {
+ 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) ],
- include: [ { model: AccountModel, required: true } ]
+ order: getSort(sort),
+ where
}
return UserModel.findAndCountAll(query)
})
}
- static loadById (id: number) {
- const options = {
- include: [ { model: AccountModel, required: true } ]
+ 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.findById(id, options)
+ 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
- },
- include: [ { model: AccountModel, required: true } ]
+ username: { [ Op.iLike ]: username }
+ }
}
return UserModel.findOne(query)
static loadByUsernameAndPopulateChannels (username: string) {
const query = {
where: {
- username
- },
+ username: { [ Op.iLike ]: 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: { [ Op.iLike ]: username } }, { email } ]
+ }
+ }
+
+ return UserModel.findOne(query)
+ }
+
+ static loadByVideoId (videoId: number) {
+ const query = {
include: [
{
- model: AccountModel,
required: true,
- include: [ VideoChannelModel ]
+ 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 loadByUsernameOrEmail (username: string, email: string) {
+ static loadByVideoImportId (videoImportId: number) {
const query = {
- include: [ { model: AccountModel, required: true } ],
- where: {
- [ Sequelize.Op.or ]: [ { username }, { email } ]
- }
+ 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
+ }
+ }
+ ]
+ }
+ ]
}
- // FIXME: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/18387
- return (UserModel as any).findOne(query)
+ return UserModel.findOne(query)
}
- private static getOriginalVideoFileTotalFromUser (user: UserModel) {
+ 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 = '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 query = UserModel.generateUserQuotaBaseSQL()
- const options = {
- bind: { userId: user.id },
- type: Sequelize.QueryTypes.SELECT
+ 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
}
- return UserModel.sequelize.query(query, options)
- .then(([ { total } ]) => {
- if (total === null) return 0
+ }
- return parseInt(total, 10)
- })
+ 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 () {
+ 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,
- displayNSFW: this.displayNSFW,
+ pendingEmail: this.pendingEmail,
+ emailVerified: this.emailVerified,
+ nsfwPolicy: this.nsfwPolicy,
+ webTorrentEnabled: this.webTorrentEnabled,
+ videosHistoryEnabled: this.videosHistoryEnabled,
+ autoPlayVideo: this.autoPlayVideo,
+ videoLanguages: this.videoLanguages,
role: this.role,
+ theme: getThemeOrDefault(this.theme, DEFAULT_USER_THEME_NAME),
roleLabel: USER_ROLE_LABELS[ this.role ],
videoQuota: this.videoQuota,
+ videoQuotaDaily: this.videoQuotaDaily,
createdAt: this.createdAt,
- account: this.Account.toFormattedJSON()
+ 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
+ json.videoChannels = this.Account.VideoChannels
.map(c => c.toFormattedJSON())
.sort((v1, v2) => {
if (v1.createdAt < v2.createdAt) return -1
return json
}
- isAbleToUploadVideo (videoFile: Express.Multer.File) {
- if (this.videoQuota === -1) return Promise.resolve(true)
+ async isAbleToUploadVideo (videoFile: { size: number }) {
+ if (this.videoQuota === -1 && this.videoQuotaDaily === -1) return Promise.resolve(true)
- return UserModel.getOriginalVideoFileTotalFromUser(this)
- .then(totalBytes => {
- return (videoFile.size + totalBytes) < this.videoQuota
- })
+ 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)
+ })
}
}
projects / github / Chocobozzz / PeerTube.git / blobdiff