1
0
Fork 0
peertube/server/core/models/user/user.ts

1053 lines
27 KiB
TypeScript
Raw Normal View History

import { forceNumber, hasUserRight, USER_ROLE_LABELS } from '@peertube/peertube-core-utils'
import {
AbuseState,
MyUser,
User,
UserAdminFlag,
UserRightType,
VideoPlaylistType,
type NSFWPolicyType,
type UserAdminFlagType,
type UserRoleType
} from '@peertube/peertube-models'
import { AttributesOnly } from '@peertube/peertube-typescript-utils'
import { TokensCache } from '@server/lib/auth/tokens-cache.js'
import { LiveQuotaStore } from '@server/lib/live/index.js'
import {
MMyUserFormattable,
MUser,
MUserDefault,
MUserFormattable,
MUserNotifSettingChannelDefault,
MUserWithNotificationSetting
} from '@server/types/models/index.js'
import { col, FindOptions, fn, literal, Op, QueryTypes, where, WhereOptions } from 'sequelize'
2017-12-12 11:53:50 -05:00
import {
2018-11-19 11:08:18 -05:00
AfterDestroy,
2018-09-20 05:31:48 -04:00
AfterUpdate,
2018-03-01 07:02:09 -05:00
AllowNull,
BeforeCreate,
BeforeUpdate,
Column,
CreatedAt,
DataType,
Default,
DefaultScope,
HasMany,
HasOne,
Is,
IsEmail,
2020-12-08 08:30:29 -05:00
IsUUID,
2018-03-01 07:02:09 -05:00
Model,
Scopes,
Table,
2020-12-08 08:30:29 -05:00
UpdatedAt
2017-12-12 11:53:50 -05:00
} from 'sequelize-typescript'
import { isThemeNameValid } from '../../helpers/custom-validators/plugins.js'
2017-05-15 16:22:03 -04:00
import {
2019-04-15 04:49:46 -04:00
isUserAdminFlagsValid,
isUserAutoPlayNextVideoPlaylistValid,
isUserAutoPlayNextVideoValid,
isUserAutoPlayVideoValid,
2018-08-08 11:36:10 -04:00
isUserBlockedReasonValid,
2018-08-08 08:58:21 -04:00
isUserBlockedValid,
isUserEmailVerifiedValid,
isUserNoModal,
2018-09-04 04:22:10 -04:00
isUserNSFWPolicyValid,
2022-02-09 11:48:15 -05:00
isUserP2PEnabledValid,
2018-03-01 07:02:09 -05:00
isUserPasswordValid,
isUserRoleValid,
isUserVideoLanguages,
2018-09-04 04:22:10 -04:00
isUserVideoQuotaDailyValid,
isUserVideoQuotaValid,
2022-02-09 11:48:15 -05:00
isUserVideosHistoryEnabledValid
} from '../../helpers/custom-validators/users.js'
import { comparePassword, cryptPassword } from '../../helpers/peertube-crypto.js'
import { DEFAULT_USER_THEME_NAME, NSFW_POLICY_TYPES } from '../../initializers/constants.js'
import { getThemeOrDefault } from '../../lib/plugins/theme-utils.js'
import { AccountModel } from '../account/account.js'
import { ActorFollowModel } from '../actor/actor-follow.js'
import { ActorImageModel } from '../actor/actor-image.js'
import { ActorModel } from '../actor/actor.js'
import { OAuthTokenModel } from '../oauth/oauth-token.js'
import { getAdminUsersSort, throwIfNotValid } from '../shared/index.js'
import { VideoChannelModel } from '../video/video-channel.js'
import { VideoImportModel } from '../video/video-import.js'
import { VideoLiveModel } from '../video/video-live.js'
import { VideoPlaylistModel } from '../video/video-playlist.js'
import { VideoModel } from '../video/video.js'
import { UserNotificationSettingModel } from './user-notification-setting.js'
2024-02-12 04:47:52 -05:00
import { UserExportModel } from './user-export.js'
2017-12-12 11:53:50 -05:00
enum ScopeNames {
FOR_ME_API = 'FOR_ME_API',
WITH_VIDEOCHANNELS = 'WITH_VIDEOCHANNELS',
2022-05-04 04:07:06 -04:00
WITH_QUOTA = 'WITH_QUOTA',
WITH_TOTAL_FILE_SIZES = 'WITH_TOTAL_FILE_SIZES',
WITH_STATS = 'WITH_STATS'
}
2019-04-23 03:50:57 -04:00
@DefaultScope(() => ({
2017-12-14 04:07:57 -05:00
include: [
{
2019-04-23 03:50:57 -04:00
model: AccountModel,
2017-12-14 04:07:57 -05:00
required: true
2018-12-26 04:36:24 -05:00
},
{
2019-04-23 03:50:57 -04:00
model: UserNotificationSettingModel,
2018-12-26 04:36:24 -05:00
required: true
2017-12-14 04:07:57 -05:00
}
]
2019-04-23 03:50:57 -04:00
}))
@Scopes(() => ({
[ScopeNames.FOR_ME_API]: {
2017-12-14 04:07:57 -05:00
include: [
{
2019-04-23 03:50:57 -04:00
model: AccountModel,
include: [
{
2021-04-07 11:01:29 -04:00
model: VideoChannelModel.unscoped(),
include: [
{
model: ActorModel,
required: true,
include: [
{
model: ActorImageModel,
as: 'Banners',
2021-04-07 11:01:29 -04:00
required: false
}
]
}
]
},
{
attributes: [ 'id', 'name', 'type' ],
model: VideoPlaylistModel.unscoped(),
required: true,
where: {
type: {
2020-01-31 10:56:52 -05:00
[Op.ne]: VideoPlaylistType.REGULAR
}
}
}
]
2018-12-26 04:36:24 -05:00
},
{
2019-04-23 03:50:57 -04:00
model: UserNotificationSettingModel,
2018-12-26 04:36:24 -05:00
required: true
2017-12-14 04:07:57 -05:00
}
2019-04-23 03:50:57 -04:00
]
},
[ScopeNames.WITH_VIDEOCHANNELS]: {
include: [
{
model: AccountModel,
include: [
{
model: VideoChannelModel
},
{
attributes: [ 'id', 'name', 'type' ],
model: VideoPlaylistModel.unscoped(),
required: true,
where: {
type: {
[Op.ne]: VideoPlaylistType.REGULAR
}
}
}
]
}
]
},
2022-05-04 04:07:06 -04:00
[ScopeNames.WITH_QUOTA]: {
attributes: {
include: [
[
literal(
'(' +
UserModel.generateUserQuotaBaseSQL({
2022-05-04 04:07:06 -04:00
whereUserId: '"UserModel"."id"',
daily: false,
onlyMaxResolution: true
}) +
')'
),
'videoQuotaUsed'
],
2022-05-04 04:07:06 -04:00
[
literal(
'(' +
UserModel.generateUserQuotaBaseSQL({
whereUserId: '"UserModel"."id"',
daily: true,
onlyMaxResolution: true
2022-05-04 04:07:06 -04:00
}) +
')'
),
'videoQuotaUsedDaily'
]
]
}
},
[ScopeNames.WITH_TOTAL_FILE_SIZES]: {
attributes: {
include: [
[
literal(
'(' +
UserModel.generateUserQuotaBaseSQL({
whereUserId: '"UserModel"."id"',
daily: false,
onlyMaxResolution: false
}) +
')'
),
'totalVideoFileSize'
]
]
}
},
2022-05-04 04:07:06 -04:00
[ScopeNames.WITH_STATS]: {
attributes: {
include: [
[
literal(
'(' +
'SELECT COUNT("video"."id") ' +
'FROM "video" ' +
'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
'WHERE "account"."userId" = "UserModel"."id"' +
')'
),
'videosCount'
],
[
literal(
'(' +
`SELECT concat_ws(':', "abuses", "acceptedAbuses") ` +
'FROM (' +
2020-07-07 08:34:16 -04:00
'SELECT COUNT("abuse"."id") AS "abuses", ' +
`COUNT("abuse"."id") FILTER (WHERE "abuse"."state" = ${AbuseState.ACCEPTED}) AS "acceptedAbuses" ` +
'FROM "abuse" ' +
'INNER JOIN "account" ON "account"."id" = "abuse"."flaggedAccountId" ' +
'WHERE "account"."userId" = "UserModel"."id"' +
') t' +
')'
),
2020-07-07 08:34:16 -04:00
'abusesCount'
],
[
literal(
'(' +
2020-07-07 08:34:16 -04:00
'SELECT COUNT("abuse"."id") ' +
'FROM "abuse" ' +
'INNER JOIN "account" ON "account"."id" = "abuse"."reporterAccountId" ' +
'WHERE "account"."userId" = "UserModel"."id"' +
')'
),
2020-07-07 08:34:16 -04:00
'abusesCreatedCount'
],
[
literal(
'(' +
'SELECT COUNT("videoComment"."id") ' +
'FROM "videoComment" ' +
'INNER JOIN "account" ON "account"."id" = "videoComment"."accountId" ' +
'WHERE "account"."userId" = "UserModel"."id"' +
')'
),
'videoCommentsCount'
]
]
}
2017-12-14 04:07:57 -05:00
}
2019-04-23 03:50:57 -04:00
}))
2017-12-12 11:53:50 -05:00
@Table({
tableName: 'user',
indexes: [
2016-12-11 15:50:51 -05:00
{
2017-12-12 11:53:50 -05:00
fields: [ 'username' ],
unique: true
2016-12-11 15:50:51 -05:00
},
{
2017-12-12 11:53:50 -05:00
fields: [ 'email' ],
unique: true
2016-12-11 15:50:51 -05:00
}
2017-05-22 14:58:25 -04:00
]
2017-12-12 11:53:50 -05:00
})
2021-05-12 08:09:04 -04:00
export class UserModel extends Model<Partial<AttributesOnly<UserModel>>> {
2017-12-12 11:53:50 -05:00
2020-04-22 10:07:04 -04:00
@AllowNull(true)
@Is('UserPassword', value => throwIfNotValid(value, isUserPasswordValid, 'user password', true))
2017-12-12 11:53:50 -05:00
@Column
password: string
@AllowNull(false)
@Column
username: string
@AllowNull(false)
@IsEmail
@Column(DataType.STRING(400))
email: string
2019-06-11 05:54:33 -04:00
@AllowNull(true)
@IsEmail
@Column(DataType.STRING(400))
pendingEmail: string
@AllowNull(true)
@Default(null)
2019-04-18 05:28:17 -04:00
@Is('UserEmailVerified', value => throwIfNotValid(value, isUserEmailVerifiedValid, 'email verified boolean', true))
@Column
emailVerified: boolean
2017-12-12 11:53:50 -05:00
@AllowNull(false)
@Is('UserNSFWPolicy', value => throwIfNotValid(value, isUserNSFWPolicyValid, 'NSFW policy'))
2022-08-17 09:36:03 -04:00
@Column(DataType.ENUM(...Object.values(NSFW_POLICY_TYPES)))
nsfwPolicy: NSFWPolicyType
2017-12-12 11:53:50 -05:00
@AllowNull(false)
@Is('p2pEnabled', value => throwIfNotValid(value, isUserP2PEnabledValid, 'P2P enabled'))
2018-10-12 12:12:39 -04:00
@Column
p2pEnabled: 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(false)
@Default(false)
@Is('UserAutoPlayNextVideo', value => throwIfNotValid(value, isUserAutoPlayNextVideoValid, 'auto play next video boolean'))
@Column
autoPlayNextVideo: boolean
@AllowNull(false)
@Default(true)
2020-01-31 10:56:52 -05:00
@Is(
'UserAutoPlayNextVideoPlaylist',
value => throwIfNotValid(value, isUserAutoPlayNextVideoPlaylistValid, 'auto play next video for playlists boolean')
)
@Column
autoPlayNextVideoPlaylist: boolean
@AllowNull(true)
@Default(null)
@Is('UserVideoLanguages', value => throwIfNotValid(value, isUserVideoLanguages, 'video languages'))
@Column(DataType.ARRAY(DataType.STRING))
videoLanguages: string[]
2019-04-15 04:49:46 -04:00
@AllowNull(false)
@Default(UserAdminFlag.NONE)
@Is('UserAdminFlags', value => throwIfNotValid(value, isUserAdminFlagsValid, 'user admin flags'))
@Column
adminFlags?: UserAdminFlagType
2019-04-15 04:49:46 -04:00
2018-08-08 08:58:21 -04:00
@AllowNull(false)
@Default(false)
@Is('UserBlocked', value => throwIfNotValid(value, isUserBlockedValid, 'blocked boolean'))
@Column
blocked: boolean
2018-08-08 11:36:10 -04:00
@AllowNull(true)
@Default(null)
2019-04-18 05:28:17 -04:00
@Is('UserBlockedReason', value => throwIfNotValid(value, isUserBlockedReasonValid, 'blocked reason', true))
2018-08-08 11:36:10 -04:00
@Column
blockedReason: string
2017-12-12 11:53:50 -05:00
@AllowNull(false)
@Is('UserRole', value => throwIfNotValid(value, isUserRoleValid, 'role'))
@Column
role: UserRoleType
2017-12-12 11:53:50 -05:00
@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
2019-07-09 05:45:19 -04:00
@AllowNull(false)
@Default(DEFAULT_USER_THEME_NAME)
@Is('UserTheme', value => throwIfNotValid(value, isThemeNameValid, 'theme'))
2019-07-09 05:45:19 -04:00
@Column
theme: string
2019-08-28 08:40:06 -04:00
@AllowNull(false)
@Default(false)
@Is(
'UserNoInstanceConfigWarningModal',
value => throwIfNotValid(value, isUserNoModal, 'no instance config warning modal')
2019-08-28 08:40:06 -04:00
)
@Column
noInstanceConfigWarningModal: boolean
@AllowNull(false)
@Default(false)
@Is(
'UserNoWelcomeModal',
value => throwIfNotValid(value, isUserNoModal, 'no welcome modal')
2019-08-28 08:40:06 -04:00
)
@Column
noWelcomeModal: boolean
@AllowNull(false)
@Default(false)
@Is(
'UserNoAccountSetupWarningModal',
value => throwIfNotValid(value, isUserNoModal, 'no account setup warning modal')
)
@Column
noAccountSetupWarningModal: boolean
2020-04-22 10:07:04 -04:00
@AllowNull(true)
@Default(null)
@Column
pluginAuth: string
@AllowNull(false)
@Default(DataType.UUIDV4)
@IsUUID(4)
@Column(DataType.UUID)
feedToken: string
2020-05-07 04:39:09 -04:00
@AllowNull(true)
@Default(null)
@Column
lastLoginDate: Date
Add Podcast RSS feeds (#5487) * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Add correct feed image to RSS channel * Prefer HLS videos for podcast RSS Remove video/stream titles, add optional height attribute to podcast RSS * Prefix podcast RSS images with root server URL * Add optional video query support to include captions * Add transcripts & person images to podcast RSS feed * Prefer webseed/webtorrent files over HLS fragmented mp4s * Experimentally adding podcast fields to basic config page * Add validation for new basic config fields * Don't include "content" in podcast feed, use full description for "description" * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Add correct feed image to RSS channel * Prefer HLS videos for podcast RSS Remove video/stream titles, add optional height attribute to podcast RSS * Prefix podcast RSS images with root server URL * Add optional video query support to include captions * Add transcripts & person images to podcast RSS feed * Prefer webseed/webtorrent files over HLS fragmented mp4s * Experimentally adding podcast fields to basic config page * Add validation for new basic config fields * Don't include "content" in podcast feed, use full description for "description" * Add medium/socialInteract to podcast RSS feeds. Use HTML for description * Change base production image to bullseye, install prosody in image * Add liveItem and trackers to Podcast RSS feeds Remove height from alternateEnclosure, replaced with title. * Clear Podcast RSS feed cache when live streams start/end * Upgrade to Node 16 * Refactor clearCacheRoute to use ApiCache * Remove unnecessary type hint * Update dockerfile to node 16, install python-is-python2 * Use new file paths for captions/playlists * Fix legacy videos in RSS after migration to object storage * Improve method of identifying non-fragmented mp4s in podcast RSS feeds * Don't include fragmented MP4s in podcast RSS feeds * Add experimental support for podcast:categories on the podcast RSS item * Fix undefined category when no videos exist Allows for empty feeds to exist (important for feeds that might only go live) * Add support for podcast:locked -- user has to opt in to show their email * Use comma for podcast:categories delimiter * Make cache clearing async * Fix merge, temporarily test with pfeed-podcast * Syntax changes * Add EXT_MIMETYPE constants for captions * Update & fix tests, fix enclosure mimetypes, remove admin email * Add test for podacst:socialInteract * Add filters hooks for podcast customTags * Remove showdown, updated to pfeed-podcast 6.1.2 * Add 'action:api.live-video.state.updated' hook * Avoid assigning undefined category to podcast feeds * Remove nvmrc * Remove comment * Remove unused podcast config * Remove more unused podcast config * Fix MChannelAccountDefault type hint missed in merge * Remove extra line * Re-add newline in config * Fix lint errors for isEmailPublic * Fix thumbnails in podcast feeds * Requested changes based on review * Provide podcast rss 2.0 only on video channels * Misc cleanup for a less messy PR * Lint fixes * Remove pfeed-podcast * Add peertube version to new hooks * Don't use query include, remove TODO * Remove film medium hack * Clear podcast rss cache before video/channel update hooks * Clear podcast rss cache before video uploaded/deleted hooks * Refactor podcast feed cache clearing * Set correct person name from video channel * Styling * Fix tests --------- Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 10:00:05 -04:00
@AllowNull(false)
@Default(false)
@Column
emailPublic: boolean
@AllowNull(true)
@Default(null)
@Column
otpSecret: string
2017-12-12 11:53:50 -05:00
@CreatedAt
createdAt: Date
@UpdatedAt
updatedAt: Date
@HasOne(() => AccountModel, {
foreignKey: 'userId',
onDelete: 'cascade',
hooks: true
2017-12-12 11:53:50 -05:00
})
Account: Awaited<AccountModel>
2018-12-26 04:36:24 -05:00
@HasOne(() => UserNotificationSettingModel, {
foreignKey: 'userId',
onDelete: 'cascade',
hooks: true
})
NotificationSetting: Awaited<UserNotificationSettingModel>
2018-12-26 04:36:24 -05:00
@HasMany(() => VideoImportModel, {
foreignKey: 'userId',
onDelete: 'cascade'
})
VideoImports: Awaited<VideoImportModel>[]
2017-12-12 11:53:50 -05:00
@HasMany(() => OAuthTokenModel, {
foreignKey: 'userId',
onDelete: 'cascade'
})
OAuthTokens: Awaited<OAuthTokenModel>[]
2017-12-12 11:53:50 -05:00
2024-02-12 04:47:52 -05:00
@HasMany(() => UserExportModel, {
foreignKey: 'userId',
onDelete: 'cascade',
hooks: true
})
UserExports: Awaited<UserExportModel>[]
2023-01-19 03:27:16 -05:00
// Used if we already set an encrypted password in user model
skipPasswordEncryption = false
2017-12-12 11:53:50 -05:00
@BeforeCreate
@BeforeUpdate
2023-01-19 03:27:16 -05:00
static async cryptPasswordIfNeeded (instance: UserModel) {
if (instance.skipPasswordEncryption) return
if (!instance.changed('password')) return
if (!instance.password) return
instance.password = await cryptPassword(instance.password)
}
2016-08-25 11:57:37 -04:00
2018-09-20 05:31:48 -04:00
@AfterUpdate
2018-11-19 11:08:18 -05:00
@AfterDestroy
2018-09-20 05:31:48 -04:00
static removeTokenCache (instance: UserModel) {
return TokensCache.Instance.clearCacheByUserId(instance.id)
2018-09-20 05:31:48 -04:00
}
2017-12-12 11:53:50 -05:00
static countTotal () {
2023-01-19 09:23:06 -05:00
return UserModel.unscoped().count()
2017-12-12 11:53:50 -05:00
}
static listForAdminApi (parameters: {
start: number
count: number
sort: string
search?: string
blocked?: boolean
}) {
const { start, count, sort, search, blocked } = parameters
const where: WhereOptions = {}
2020-01-31 10:56:52 -05:00
2018-10-08 09:51:38 -04:00
if (search) {
Object.assign(where, {
2019-04-23 03:50:57 -04:00
[Op.or]: [
2018-10-08 09:51:38 -04:00
{
email: {
2019-04-23 03:50:57 -04:00
[Op.iLike]: '%' + search + '%'
2018-10-08 09:51:38 -04:00
}
},
{
username: {
2020-01-31 10:56:52 -05:00
[Op.iLike]: '%' + search + '%'
2018-10-08 09:51:38 -04:00
}
}
]
})
}
if (blocked !== undefined) {
2022-07-13 05:58:01 -04:00
Object.assign(where, { blocked })
2018-10-08 09:51:38 -04:00
}
2019-04-23 03:50:57 -04:00
const query: FindOptions = {
2017-12-12 11:53:50 -05:00
offset: start,
limit: count,
order: getAdminUsersSort(sort),
2018-10-08 09:51:38 -04:00
where
2017-12-12 11:53:50 -05:00
}
2017-10-24 13:41:09 -04:00
return Promise.all([
UserModel.unscoped().count(query),
UserModel.scope([ 'defaultScope', ScopeNames.WITH_QUOTA, ScopeNames.WITH_TOTAL_FILE_SIZES ]).findAll(query)
]).then(([ total, data ]) => ({ total, data }))
2017-10-24 13:41:09 -04:00
}
static listWithRight (right: UserRightType): Promise<MUserDefault[]> {
2018-02-01 05:08:10 -05:00
const roles = Object.keys(USER_ROLE_LABELS)
.map(k => parseInt(k, 10) as UserRoleType)
2020-01-31 10:56:52 -05:00
.filter(role => hasUserRight(role, right))
2018-02-01 05:08:10 -05:00
const query = {
where: {
role: {
2019-04-23 03:50:57 -04:00
[Op.in]: roles
2018-02-01 05:08:10 -05:00
}
}
}
2018-12-26 04:36:24 -05:00
return UserModel.findAll(query)
}
2020-12-08 08:30:29 -05:00
static listUserSubscribersOf (actorId: number): Promise<MUserWithNotificationSetting[]> {
2018-12-26 04:36:24 -05:00
const query = {
include: [
{
model: UserNotificationSettingModel.unscoped(),
required: true
},
{
attributes: [ 'userId' ],
model: AccountModel.unscoped(),
required: true,
include: [
{
2020-01-31 10:56:52 -05:00
attributes: [],
2018-12-26 04:36:24 -05:00
model: ActorModel.unscoped(),
required: true,
where: {
serverId: null
},
include: [
{
2020-01-31 10:56:52 -05:00
attributes: [],
2018-12-26 04:36:24 -05:00
as: 'ActorFollowings',
model: ActorFollowModel.unscoped(),
required: true,
where: {
state: 'accepted',
2018-12-26 04:36:24 -05:00
targetActorId: actorId
}
}
]
}
]
}
]
}
return UserModel.unscoped().findAll(query)
2018-02-01 05:08:10 -05:00
}
2020-12-08 08:30:29 -05:00
static listByUsernames (usernames: string[]): Promise<MUserDefault[]> {
const query = {
where: {
username: usernames
}
}
return UserModel.findAll(query)
}
2020-12-08 08:30:29 -05:00
static loadById (id: number): Promise<MUser> {
2020-09-25 10:19:35 -04:00
return UserModel.unscoped().findByPk(id)
}
static loadByIdFull (id: number): Promise<MUserDefault> {
return UserModel.findByPk(id)
}
2020-12-08 08:30:29 -05:00
static loadByIdWithChannels (id: number, withStats = false): Promise<MUserDefault> {
const scopes = [
ScopeNames.WITH_VIDEOCHANNELS
]
2022-05-04 04:07:06 -04:00
if (withStats) {
scopes.push(ScopeNames.WITH_QUOTA)
scopes.push(ScopeNames.WITH_STATS)
scopes.push(ScopeNames.WITH_TOTAL_FILE_SIZES)
2022-05-04 04:07:06 -04:00
}
return UserModel.scope(scopes).findByPk(id)
2017-12-12 11:53:50 -05:00
}
2016-12-11 15:50:51 -05:00
2020-12-08 08:30:29 -05:00
static loadByUsername (username: string): Promise<MUserDefault> {
2017-12-12 11:53:50 -05:00
const query = {
where: {
username
2017-12-14 04:07:57 -05:00
}
2017-12-12 11:53:50 -05:00
}
2017-12-12 11:53:50 -05:00
return UserModel.findOne(query)
2016-12-11 15:50:51 -05:00
}
static loadForMeAPI (id: number): Promise<MUserNotifSettingChannelDefault> {
2017-12-12 11:53:50 -05:00
const query = {
where: {
id
2017-12-14 04:07:57 -05:00
}
2017-12-12 11:53:50 -05:00
}
return UserModel.scope(ScopeNames.FOR_ME_API).findOne(query)
2016-12-11 15:50:51 -05:00
}
2020-12-08 08:30:29 -05:00
static loadByEmail (email: string): Promise<MUserDefault> {
2018-01-30 07:27:07 -05:00
const query = {
where: {
email
}
}
return UserModel.findOne(query)
}
2020-12-08 08:30:29 -05:00
static loadByUsernameOrEmail (username: string, email?: string): Promise<MUserDefault> {
2018-01-29 10:09:50 -05:00
if (!email) email = username
2017-12-12 11:53:50 -05:00
const query = {
where: {
2020-01-31 10:56:52 -05:00
[Op.or]: [
2022-02-09 11:48:15 -05:00
where(fn('lower', col('username')), fn('lower', username) as any),
{ email }
]
2017-12-12 11:53:50 -05:00
}
}
2017-12-14 04:07:57 -05:00
return UserModel.findOne(query)
2017-10-24 13:41:09 -04:00
}
2020-12-08 08:30:29 -05:00
static loadByVideoId (videoId: number): Promise<MUserDefault> {
2018-12-26 04:36:24 -05:00
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)
}
2020-12-08 08:30:29 -05:00
static loadByVideoImportId (videoImportId: number): Promise<MUserDefault> {
const query = {
include: [
{
required: true,
attributes: [ 'id' ],
model: VideoImportModel.unscoped(),
where: {
id: videoImportId
}
}
]
}
return UserModel.findOne(query)
}
2020-12-08 08:30:29 -05:00
static loadByChannelActorId (videoChannelActorId: number): Promise<MUserDefault> {
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)
}
2024-02-12 04:47:52 -05:00
static loadByAccountId (accountId: number): Promise<MUserDefault> {
const query = {
include: [
{
required: true,
attributes: [ 'id' ],
model: AccountModel.unscoped(),
where: {
id: accountId
}
}
]
}
return UserModel.findOne(query)
}
2020-12-08 08:30:29 -05:00
static loadByAccountActorId (accountActorId: number): Promise<MUserDefault> {
const query = {
include: [
{
required: true,
attributes: [ 'id' ],
model: AccountModel.unscoped(),
where: {
actorId: accountActorId
}
}
]
}
return UserModel.findOne(query)
}
2020-12-08 08:30:29 -05:00
static loadByLiveId (liveId: number): Promise<MUser> {
2020-09-25 10:19:35 -04:00
const query = {
include: [
{
attributes: [ 'id' ],
model: AccountModel.unscoped(),
required: true,
include: [
{
attributes: [ 'id' ],
model: VideoChannelModel.unscoped(),
required: true,
include: [
{
attributes: [ 'id' ],
model: VideoModel.unscoped(),
required: true,
include: [
{
2020-10-27 11:06:24 -04:00
attributes: [],
2020-09-25 10:19:35 -04:00
model: VideoLiveModel.unscoped(),
required: true,
where: {
id: liveId
}
}
]
}
]
}
]
}
]
}
2020-10-27 11:06:24 -04:00
return UserModel.unscoped().findOne(query)
2020-09-25 10:19:35 -04:00
}
static generateUserQuotaBaseSQL (options: {
2022-05-04 04:07:06 -04:00
daily: boolean
2024-02-12 04:47:52 -05:00
whereUserId: '$userId' | '"UserModel"."id"'
onlyMaxResolution: boolean
2020-09-25 10:19:35 -04:00
}) {
const { daily, whereUserId, onlyMaxResolution } = options
2024-02-12 04:47:52 -05:00
const andWhere = daily === true
2022-05-04 04:07:06 -04:00
? 'AND "video"."createdAt" > now() - interval \'24 hours\''
2020-09-25 10:19:35 -04:00
: ''
const videoChannelJoin = 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
'INNER JOIN "account" ON "videoChannel"."accountId" = "account"."id" ' +
2024-02-12 04:47:52 -05:00
`WHERE "account"."userId" = ${whereUserId} ${andWhere}`
2020-09-25 10:19:35 -04:00
const webVideoFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
'INNER JOIN "video" ON "videoFile"."videoId" = "video"."id" AND "video"."isLive" IS FALSE ' +
2020-09-25 10:19:35 -04:00
videoChannelJoin
const hlsFiles = 'SELECT "videoFile"."size" AS "size", "video"."id" AS "videoId" FROM "videoFile" ' +
'INNER JOIN "videoStreamingPlaylist" ON "videoFile"."videoStreamingPlaylistId" = "videoStreamingPlaylist".id ' +
'INNER JOIN "video" ON "videoStreamingPlaylist"."videoId" = "video"."id" AND "video"."isLive" IS FALSE ' +
2020-09-25 10:19:35 -04:00
videoChannelJoin
const sizeSelect = onlyMaxResolution
? 'MAX("t1"."size")'
: 'SUM("t1"."size")'
2020-09-25 10:19:35 -04:00
return 'SELECT COALESCE(SUM("size"), 0) AS "total" ' +
'FROM (' +
`SELECT ${sizeSelect} AS "size" FROM (${webVideoFiles} UNION ${hlsFiles}) t1 ` +
2020-09-25 10:19:35 -04:00
'GROUP BY "t1"."videoId"' +
') t2'
}
2024-02-12 04:47:52 -05:00
static async getUserQuota (options: {
userId: number
daily: boolean
}) {
const { daily, userId } = options
const sql = this.generateUserQuotaBaseSQL({ daily, whereUserId: '$userId', onlyMaxResolution: true })
2024-02-12 04:47:52 -05:00
const queryOptions = {
2020-09-25 10:19:35 -04:00
bind: { userId },
type: QueryTypes.SELECT as QueryTypes.SELECT
}
2024-02-12 04:47:52 -05:00
const [ { total } ] = await UserModel.sequelize.query<{ total: string }>(sql, queryOptions)
if (!total) return 0
2024-02-12 04:47:52 -05:00
return parseInt(total, 10)
2017-10-24 13:41:09 -04:00
}
2018-02-28 12:04:46 -05:00
static async getStats () {
2020-05-07 04:39:09 -04:00
function getActiveUsers (days: number) {
const query = {
where: {
[Op.and]: [
literal(`"lastLoginDate" > NOW() - INTERVAL '${days}d'`)
]
}
}
2022-06-17 10:16:28 -04:00
return UserModel.unscoped().count(query)
2020-05-07 04:39:09 -04:00
}
2022-06-17 10:16:28 -04:00
const totalUsers = await UserModel.unscoped().count()
2020-05-07 04:39:09 -04:00
const totalDailyActiveUsers = await getActiveUsers(1)
const totalWeeklyActiveUsers = await getActiveUsers(7)
const totalMonthlyActiveUsers = await getActiveUsers(30)
const totalHalfYearActiveUsers = await getActiveUsers(180)
2018-02-28 12:04:46 -05:00
return {
2020-05-07 04:39:09 -04:00
totalUsers,
totalDailyActiveUsers,
totalWeeklyActiveUsers,
totalMonthlyActiveUsers,
totalHalfYearActiveUsers
2018-02-28 12:04:46 -05:00
}
}
2018-09-04 04:22:10 -04:00
static autoComplete (search: string) {
const query = {
where: {
username: {
2020-01-31 10:56:52 -05:00
[Op.like]: `%${search}%`
2018-09-04 04:22:10 -04:00
}
},
limit: 10
}
return UserModel.findAll(query)
.then(u => u.map(u => u.username))
}
hasRight (right: UserRightType) {
2017-12-12 11:53:50 -05:00
return hasUserRight(this.role, right)
}
2017-10-24 13:41:09 -04:00
hasAdminFlag (flag: UserAdminFlagType) {
2019-04-15 04:49:46 -04:00
return this.adminFlags & flag
}
2017-12-12 11:53:50 -05:00
isPasswordMatch (password: string) {
if (!password || !this.password) return false
2017-12-12 11:53:50 -05:00
return comparePassword(password, this.password)
2016-12-11 15:50:51 -05:00
}
toFormattedJSON (this: MUserFormattable, parameters: { withAdminFlags?: boolean } = {}): User {
2018-08-14 11:56:51 -04:00
const videoQuotaUsed = this.get('videoQuotaUsed')
const videoQuotaUsedDaily = this.get('videoQuotaUsedDaily')
const videosCount = this.get('videosCount')
2020-07-07 08:34:16 -04:00
const [ abusesCount, abusesAcceptedCount ] = (this.get('abusesCount') as string || ':').split(':')
const abusesCreatedCount = this.get('abusesCreatedCount')
const videoCommentsCount = this.get('videoCommentsCount')
const totalVideoFileSize = this.get('totalVideoFileSize')
2018-08-14 11:56:51 -04:00
const json: User = {
2017-12-12 11:53:50 -05:00
id: this.id,
username: this.username,
email: this.email,
2019-08-28 08:40:06 -04:00
theme: getThemeOrDefault(this.theme, DEFAULT_USER_THEME_NAME),
2019-06-11 05:54:33 -04:00
pendingEmail: this.pendingEmail,
Add Podcast RSS feeds (#5487) * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Add correct feed image to RSS channel * Prefer HLS videos for podcast RSS Remove video/stream titles, add optional height attribute to podcast RSS * Prefix podcast RSS images with root server URL * Add optional video query support to include captions * Add transcripts & person images to podcast RSS feed * Prefer webseed/webtorrent files over HLS fragmented mp4s * Experimentally adding podcast fields to basic config page * Add validation for new basic config fields * Don't include "content" in podcast feed, use full description for "description" * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Add correct feed image to RSS channel * Prefer HLS videos for podcast RSS Remove video/stream titles, add optional height attribute to podcast RSS * Prefix podcast RSS images with root server URL * Add optional video query support to include captions * Add transcripts & person images to podcast RSS feed * Prefer webseed/webtorrent files over HLS fragmented mp4s * Experimentally adding podcast fields to basic config page * Add validation for new basic config fields * Don't include "content" in podcast feed, use full description for "description" * Add medium/socialInteract to podcast RSS feeds. Use HTML for description * Change base production image to bullseye, install prosody in image * Add liveItem and trackers to Podcast RSS feeds Remove height from alternateEnclosure, replaced with title. * Clear Podcast RSS feed cache when live streams start/end * Upgrade to Node 16 * Refactor clearCacheRoute to use ApiCache * Remove unnecessary type hint * Update dockerfile to node 16, install python-is-python2 * Use new file paths for captions/playlists * Fix legacy videos in RSS after migration to object storage * Improve method of identifying non-fragmented mp4s in podcast RSS feeds * Don't include fragmented MP4s in podcast RSS feeds * Add experimental support for podcast:categories on the podcast RSS item * Fix undefined category when no videos exist Allows for empty feeds to exist (important for feeds that might only go live) * Add support for podcast:locked -- user has to opt in to show their email * Use comma for podcast:categories delimiter * Make cache clearing async * Fix merge, temporarily test with pfeed-podcast * Syntax changes * Add EXT_MIMETYPE constants for captions * Update & fix tests, fix enclosure mimetypes, remove admin email * Add test for podacst:socialInteract * Add filters hooks for podcast customTags * Remove showdown, updated to pfeed-podcast 6.1.2 * Add 'action:api.live-video.state.updated' hook * Avoid assigning undefined category to podcast feeds * Remove nvmrc * Remove comment * Remove unused podcast config * Remove more unused podcast config * Fix MChannelAccountDefault type hint missed in merge * Remove extra line * Re-add newline in config * Fix lint errors for isEmailPublic * Fix thumbnails in podcast feeds * Requested changes based on review * Provide podcast rss 2.0 only on video channels * Misc cleanup for a less messy PR * Lint fixes * Remove pfeed-podcast * Add peertube version to new hooks * Don't use query include, remove TODO * Remove film medium hack * Clear podcast rss cache before video/channel update hooks * Clear podcast rss cache before video uploaded/deleted hooks * Refactor podcast feed cache clearing * Set correct person name from video channel * Styling * Fix tests --------- Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 10:00:05 -04:00
emailPublic: this.emailPublic,
emailVerified: this.emailVerified,
2019-08-28 08:40:06 -04:00
nsfwPolicy: this.nsfwPolicy,
p2pEnabled: this.p2pEnabled,
videosHistoryEnabled: this.videosHistoryEnabled,
autoPlayVideo: this.autoPlayVideo,
autoPlayNextVideo: this.autoPlayNextVideo,
autoPlayNextVideoPlaylist: this.autoPlayNextVideoPlaylist,
videoLanguages: this.videoLanguages,
2019-08-28 08:40:06 -04:00
role: {
id: this.role,
label: USER_ROLE_LABELS[this.role]
},
2019-08-28 08:40:06 -04:00
2017-12-12 11:53:50 -05:00
videoQuota: this.videoQuota,
videoQuotaDaily: this.videoQuotaDaily,
2022-05-04 04:07:06 -04:00
totalVideoFileSize: totalVideoFileSize !== undefined
? forceNumber(totalVideoFileSize)
: undefined,
2019-08-28 08:40:06 -04:00
videoQuotaUsed: videoQuotaUsed !== undefined
? forceNumber(videoQuotaUsed) + LiveQuotaStore.Instance.getLiveQuotaOfUser(this.id)
2019-08-28 08:40:06 -04:00
: undefined,
2022-05-04 04:07:06 -04:00
2019-08-28 08:40:06 -04:00
videoQuotaUsedDaily: videoQuotaUsedDaily !== undefined
? forceNumber(videoQuotaUsedDaily) + LiveQuotaStore.Instance.getLiveQuotaOfUser(this.id)
2019-08-28 08:40:06 -04:00
: undefined,
2022-05-04 04:07:06 -04:00
videosCount: videosCount !== undefined
? forceNumber(videosCount)
: undefined,
2020-07-07 08:34:16 -04:00
abusesCount: abusesCount
? forceNumber(abusesCount)
: undefined,
2020-07-07 08:34:16 -04:00
abusesAcceptedCount: abusesAcceptedCount
? forceNumber(abusesAcceptedCount)
: undefined,
2020-07-07 08:34:16 -04:00
abusesCreatedCount: abusesCreatedCount !== undefined
? forceNumber(abusesCreatedCount)
: undefined,
videoCommentsCount: videoCommentsCount !== undefined
? forceNumber(videoCommentsCount)
: undefined,
2019-08-28 08:40:06 -04:00
noInstanceConfigWarningModal: this.noInstanceConfigWarningModal,
noWelcomeModal: this.noWelcomeModal,
noAccountSetupWarningModal: this.noAccountSetupWarningModal,
2019-08-28 08:40:06 -04:00
2018-08-08 11:36:10 -04:00
blocked: this.blocked,
blockedReason: this.blockedReason,
2019-08-28 08:40:06 -04:00
2017-12-29 13:10:13 -05:00
account: this.Account.toFormattedJSON(),
2019-08-28 08:40:06 -04:00
notificationSettings: this.NotificationSetting
? this.NotificationSetting.toFormattedJSON()
: undefined,
2018-08-14 11:56:51 -04:00
videoChannels: [],
2019-08-28 08:40:06 -04:00
2020-05-05 03:44:53 -04:00
createdAt: this.createdAt,
2020-05-07 04:39:09 -04:00
pluginAuth: this.pluginAuth,
lastLoginDate: this.lastLoginDate,
twoFactorEnabled: !!this.otpSecret
2017-12-12 11:53:50 -05:00
}
2019-04-15 04:49:46 -04:00
if (parameters.withAdminFlags) {
Object.assign(json, { adminFlags: this.adminFlags })
}
2017-12-12 11:53:50 -05:00
if (Array.isArray(this.Account.VideoChannels) === true) {
2017-12-29 13:10:13 -05:00
json.videoChannels = this.Account.VideoChannels
2020-01-31 10:56:52 -05: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 03:29:59 -05:00
2020-01-31 10:56:52 -05:00
return 1
})
2017-02-18 03:29:59 -05:00
}
2017-12-12 11:53:50 -05:00
return json
2017-02-18 03:29:59 -05:00
}
toMeFormattedJSON (this: MMyUserFormattable): MyUser {
const formatted = this.toFormattedJSON({ withAdminFlags: true })
const specialPlaylists = this.Account.VideoPlaylists
2020-01-31 10:56:52 -05:00
.map(p => ({ id: p.id, name: p.name, type: p.type }))
return Object.assign(formatted, { specialPlaylists })
}
2017-09-04 14:07:54 -04:00
}