PeerTube/server/core/lib/user.ts

301 lines
10 KiB
TypeScript
Raw Normal View History

import { Transaction } from 'sequelize'
import {
ActivityPubActorType,
UserAdminFlag,
UserAdminFlagType,
UserNotificationSetting,
UserNotificationSettingValue,
UserRole,
UserRoleType
} from '@peertube/peertube-models'
import { logger } from '@server/helpers/logger.js'
import { CONFIG } from '@server/initializers/config.js'
import { UserModel } from '@server/models/user/user.js'
import { MActorDefault } from '@server/types/models/actor/index.js'
import { SERVER_ACTOR_NAME, WEBSERVER } from '../initializers/constants.js'
import { sequelizeTypescript } from '../initializers/database.js'
import { AccountModel } from '../models/account/account.js'
import { UserNotificationSettingModel } from '../models/user/user-notification-setting.js'
import { MAccountDefault, MChannelActor } from '../types/models/index.js'
import { MRegistration, MUser, MUserDefault, MUserId } from '../types/models/user/index.js'
import { generateAndSaveActorKeys } from './activitypub/actors/index.js'
import { getLocalAccountActivityPubUrl } from './activitypub/url.js'
import { Emailer } from './emailer.js'
import { LiveQuotaStore } from './live/live-quota-store.js'
import { buildActorInstance, findAvailableLocalActorName } from './local-actor.js'
import { Redis } from './redis.js'
2024-02-14 09:21:53 +01:00
import { createLocalVideoChannelWithoutKeys } from './video-channel.js'
import { createWatchLaterPlaylist } from './video-playlist.js'
2020-09-25 16:19:35 +02:00
type ChannelNames = { name: string, displayName: string }
2019-08-15 11:53:26 +02:00
function buildUser (options: {
username: string
password: string
email: string
role?: UserRoleType // Default to UserRole.User
adminFlags?: UserAdminFlagType // Default to UserAdminFlag.NONE
emailVerified: boolean | null
videoQuota?: number // Default to CONFIG.USER.VIDEO_QUOTA
videoQuotaDaily?: number // Default to CONFIG.USER.VIDEO_QUOTA_DAILY
pluginAuth?: string
}): MUser {
const {
username,
password,
email,
role = UserRole.USER,
emailVerified,
videoQuota = CONFIG.USER.VIDEO_QUOTA,
videoQuotaDaily = CONFIG.USER.VIDEO_QUOTA_DAILY,
adminFlags = UserAdminFlag.NONE,
pluginAuth
} = options
return new UserModel({
username,
password,
email,
nsfwPolicy: CONFIG.INSTANCE.DEFAULT_NSFW_POLICY,
p2pEnabled: CONFIG.DEFAULTS.P2P.WEBAPP.ENABLED,
videosHistoryEnabled: CONFIG.USER.HISTORY.VIDEOS.ENABLED,
autoPlayVideo: true,
role,
emailVerified,
adminFlags,
2022-07-13 11:58:01 +02:00
videoQuota,
videoQuotaDaily,
pluginAuth
})
}
// ---------------------------------------------------------------------------
async function createUserAccountAndChannelAndPlaylist (parameters: {
2020-01-31 16:56:52 +01:00
userToCreate: MUser
userDisplayName?: string
channelNames?: ChannelNames
validateUser?: boolean
2019-08-20 19:05:31 +02:00
}): Promise<{ user: MUserDefault, account: MAccountDefault, videoChannel: MChannelActor }> {
const { userToCreate, userDisplayName, channelNames, validateUser = true } = parameters
const { user, account, videoChannel } = await sequelizeTypescript.transaction(async t => {
2017-10-24 19:41:09 +02:00
const userOptions = {
transaction: t,
validate: validateUser
}
2019-08-20 19:05:31 +02:00
const userCreated: MUserDefault = await userToCreate.save(userOptions)
2018-12-26 10:36:24 +01:00
userCreated.NotificationSetting = await createDefaultUserNotificationSettings(userCreated, t)
const accountCreated = await createLocalAccountWithoutKeys({
name: userCreated.username,
displayName: userDisplayName,
userId: userCreated.id,
applicationId: null,
2021-06-15 09:17:19 +02:00
t
})
userCreated.Account = accountCreated
2023-01-19 09:27:16 +01:00
const channelAttributes = await buildChannelAttributes({ user: userCreated, transaction: t, channelNames })
2024-02-14 09:21:53 +01:00
const videoChannel = await createLocalVideoChannelWithoutKeys(channelAttributes, accountCreated, t)
2019-03-05 10:58:44 +01:00
const videoPlaylist = await createWatchLaterPlaylist(accountCreated, t)
return { user: userCreated, account: accountCreated, videoChannel, videoPlaylist }
2017-10-24 19:41:09 +02:00
})
2019-08-15 11:53:26 +02:00
const [ accountActorWithKeys, channelActorWithKeys ] = await Promise.all([
generateAndSaveActorKeys(account.Actor),
generateAndSaveActorKeys(videoChannel.Actor)
2018-11-19 15:21:09 +01:00
])
2019-08-15 11:53:26 +02:00
account.Actor = accountActorWithKeys
videoChannel.Actor = channelActorWithKeys
2017-11-16 18:40:50 +01:00
2019-08-15 11:53:26 +02:00
return { user, account, videoChannel }
2017-10-24 19:41:09 +02:00
}
async function createLocalAccountWithoutKeys (parameters: {
2020-01-31 16:56:52 +01:00
name: string
displayName?: string
userId: number | null
applicationId: number | null
t: Transaction | undefined
type?: ActivityPubActorType
}) {
const { name, displayName, userId, applicationId, t, type = 'Person' } = parameters
2020-11-20 11:21:08 +01:00
const url = getLocalAccountActivityPubUrl(name)
2017-11-10 17:27:49 +01:00
2017-12-14 17:38:41 +01:00
const actorInstance = buildActorInstance(type, url, name)
2019-08-20 19:05:31 +02:00
const actorInstanceCreated: MActorDefault = await actorInstance.save({ transaction: t })
2017-12-14 11:18:49 +01:00
const accountInstance = new AccountModel({
name: displayName || name,
2017-11-10 17:27:49 +01:00
userId,
applicationId,
2018-03-13 16:00:39 +01:00
actorId: actorInstanceCreated.id
2019-04-18 11:28:17 +02:00
})
2017-11-10 17:27:49 +01:00
2019-08-20 19:05:31 +02:00
const accountInstanceCreated: MAccountDefault = await accountInstance.save({ transaction: t })
2017-12-14 11:18:49 +01:00
accountInstanceCreated.Actor = actorInstanceCreated
return accountInstanceCreated
2017-11-10 17:27:49 +01:00
}
2017-12-14 17:38:41 +01:00
async function createApplicationActor (applicationId: number) {
const accountCreated = await createLocalAccountWithoutKeys({
name: SERVER_ACTOR_NAME,
userId: null,
2022-07-13 11:58:01 +02:00
applicationId,
t: undefined,
type: 'Application'
})
2017-12-14 17:38:41 +01:00
accountCreated.Actor = await generateAndSaveActorKeys(accountCreated.Actor)
2017-12-14 17:38:41 +01:00
return accountCreated
}
// ---------------------------------------------------------------------------
2019-08-15 11:53:26 +02:00
async function sendVerifyUserEmail (user: MUser, isPendingEmail = false) {
2023-01-19 09:27:16 +01:00
const verificationString = await Redis.Instance.setUserVerifyEmailVerificationString(user.id)
let verifyEmailUrl = `${WEBSERVER.URL}/verify-account/email?userId=${user.id}&verificationString=${verificationString}`
2019-06-11 11:54:33 +02:00
2023-01-19 09:27:16 +01:00
if (isPendingEmail) verifyEmailUrl += '&isPendingEmail=true'
const to = isPendingEmail
? user.pendingEmail
: user.email
2019-06-11 11:54:33 +02:00
const username = user.username
2019-06-11 11:54:33 +02:00
2023-01-19 09:27:16 +01:00
Emailer.Instance.addVerifyEmailJob({ username, to, verifyEmailUrl, isRegistrationRequest: false })
}
async function sendVerifyRegistrationEmail (registration: MRegistration) {
const verificationString = await Redis.Instance.setRegistrationVerifyEmailVerificationString(registration.id)
const verifyEmailUrl = `${WEBSERVER.URL}/verify-account/email?registrationId=${registration.id}&verificationString=${verificationString}`
const to = registration.email
const username = registration.username
Emailer.Instance.addVerifyEmailJob({ username, to, verifyEmailUrl, isRegistrationRequest: true })
2019-06-11 11:54:33 +02:00
}
// ---------------------------------------------------------------------------
2020-09-25 16:19:35 +02:00
async function getOriginalVideoFileTotalFromUser (user: MUserId) {
2024-02-12 10:47:52 +01:00
const base = await UserModel.getUserQuota({ userId: user.id, daily: false })
2020-09-25 16:19:35 +02:00
return base + LiveQuotaStore.Instance.getLiveQuotaOfUser(user.id)
2020-09-25 16:19:35 +02:00
}
// Returns cumulative size of all video files uploaded in the last 24 hours.
async function getOriginalVideoFileTotalDailyFromUser (user: MUserId) {
2024-02-12 10:47:52 +01:00
const base = await UserModel.getUserQuota({ userId: user.id, daily: true })
2020-09-25 16:19:35 +02:00
return base + LiveQuotaStore.Instance.getLiveQuotaOfUser(user.id)
2020-09-25 16:19:35 +02:00
}
2024-02-12 10:47:52 +01:00
async function isUserQuotaValid (options: {
userId: number
uploadSize: number
checkDaily?: boolean // default true
}) {
const { userId, uploadSize, checkDaily = true } = options
2020-09-25 16:19:35 +02:00
const user = await UserModel.loadById(userId)
if (user.videoQuota === -1 && user.videoQuotaDaily === -1) return Promise.resolve(true)
const [ totalBytes, totalBytesDaily ] = await Promise.all([
2020-11-03 15:33:30 +01:00
getOriginalVideoFileTotalFromUser(user),
getOriginalVideoFileTotalDailyFromUser(user)
2020-09-25 16:19:35 +02:00
])
2024-02-12 10:47:52 +01:00
const uploadedTotal = uploadSize + totalBytes
const uploadedDaily = uploadSize + totalBytesDaily
2020-09-25 16:19:35 +02:00
2022-02-11 10:51:33 +01:00
logger.debug(
2024-02-12 10:47:52 +01:00
'Check user %d quota to upload content.', userId,
{ totalBytes, totalBytesDaily, videoQuota: user.videoQuota, videoQuotaDaily: user.videoQuotaDaily, uploadSize }
2022-02-11 10:51:33 +01:00
)
2024-02-12 10:47:52 +01:00
if (checkDaily && user.videoQuotaDaily !== -1 && uploadedDaily >= user.videoQuotaDaily) return false
if (user.videoQuota !== -1 && uploadedTotal >= user.videoQuota) return false
2020-09-25 16:19:35 +02:00
2024-02-12 10:47:52 +01:00
return true
2020-09-25 16:19:35 +02:00
}
2017-10-24 19:41:09 +02:00
// ---------------------------------------------------------------------------
export {
2020-09-25 16:19:35 +02:00
getOriginalVideoFileTotalFromUser,
getOriginalVideoFileTotalDailyFromUser,
2017-12-14 17:38:41 +01:00
createApplicationActor,
2019-03-05 10:58:44 +01:00
createUserAccountAndChannelAndPlaylist,
2019-06-11 11:54:33 +02:00
createLocalAccountWithoutKeys,
2023-01-19 09:27:16 +01:00
2020-09-25 16:19:35 +02:00
sendVerifyUserEmail,
2023-01-19 09:27:16 +01:00
sendVerifyRegistrationEmail,
2024-02-12 10:47:52 +01:00
isUserQuotaValid,
buildUser
2017-10-24 19:41:09 +02:00
}
2018-12-26 10:36:24 +01:00
// ---------------------------------------------------------------------------
2019-08-15 11:53:26 +02:00
function createDefaultUserNotificationSettings (user: MUserId, t: Transaction | undefined) {
const values: UserNotificationSetting & { userId: number } = {
2018-12-26 10:36:24 +01:00
userId: user.id,
2019-01-08 11:26:41 +01:00
newVideoFromSubscription: UserNotificationSettingValue.WEB,
newCommentOnMyVideo: UserNotificationSettingValue.WEB,
myVideoImportFinished: UserNotificationSettingValue.WEB,
myVideoPublished: UserNotificationSettingValue.WEB,
2020-07-07 14:34:16 +02:00
abuseAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
videoAutoBlacklistAsModerator: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
2019-01-08 11:26:41 +01:00
blacklistOnMyVideo: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
newUserRegistration: UserNotificationSettingValue.WEB,
commentMention: UserNotificationSettingValue.WEB,
newFollow: UserNotificationSettingValue.WEB,
newInstanceFollower: UserNotificationSettingValue.WEB,
abuseNewMessage: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
abuseStateChange: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
2021-03-11 16:54:52 +01:00
autoInstanceFollowing: UserNotificationSettingValue.WEB,
newPeerTubeVersion: UserNotificationSettingValue.WEB | UserNotificationSettingValue.EMAIL,
newPluginVersion: UserNotificationSettingValue.WEB,
2024-06-13 09:23:12 +02:00
myVideoStudioEditionFinished: UserNotificationSettingValue.WEB,
myVideoTranscriptionGenerated: UserNotificationSettingValue.WEB
}
return UserNotificationSettingModel.create(values, { transaction: t })
2018-12-26 10:36:24 +01:00
}
2023-01-19 09:27:16 +01:00
async function buildChannelAttributes (options: {
user: MUser
transaction?: Transaction
channelNames?: ChannelNames
}) {
const { user, transaction, channelNames } = options
if (channelNames) return channelNames
const channelName = await findAvailableLocalActorName(user.username + '_channel', transaction)
const videoChannelDisplayName = CONFIG.USER.DEFAULT_CHANNEL_NAME.replace('$1', user.username)
return {
name: channelName,
displayName: videoChannelDisplayName
}
}