PeerTube/server/lib/user.ts

279 lines
9.6 KiB
TypeScript
Raw Normal View History

2020-09-25 16:19:35 +02:00
import { Transaction } from 'sequelize/types'
import { logger } from '@server/helpers/logger'
import { CONFIG } from '@server/initializers/config'
2021-05-11 11:15:29 +02:00
import { UserModel } from '@server/models/user/user'
import { MActorDefault } from '@server/types/models/actor'
import { buildUUID } from '@shared/extra-utils'
2017-12-14 17:38:41 +01:00
import { ActivityPubActorType } from '../../shared/models/activitypub'
import { UserAdminFlag, UserNotificationSetting, UserNotificationSettingValue, UserRole } from '../../shared/models/users'
2019-06-11 11:54:33 +02:00
import { SERVER_ACTOR_NAME, WEBSERVER } from '../initializers/constants'
2020-09-25 16:19:35 +02:00
import { sequelizeTypescript } from '../initializers/database'
2017-12-12 17:53:50 +01:00
import { AccountModel } from '../models/account/account'
2021-05-11 11:15:29 +02:00
import { ActorModel } from '../models/actor/actor'
import { UserNotificationSettingModel } from '../models/user/user-notification-setting'
import { MAccountDefault, MChannelActor } from '../types/models'
2020-06-18 10:45:25 +02:00
import { MUser, MUserDefault, MUserId } from '../types/models/user'
2021-06-03 16:02:29 +02:00
import { generateAndSaveActorKeys } from './activitypub/actors'
2020-11-20 11:21:08 +01:00
import { getLocalAccountActivityPubUrl } from './activitypub/url'
2020-09-25 16:19:35 +02:00
import { Emailer } from './emailer'
2021-06-16 15:14:41 +02:00
import { LiveQuotaStore } from './live/live-quota-store'
2021-06-03 16:02:29 +02:00
import { buildActorInstance } from './local-actor'
2020-09-25 16:19:35 +02:00
import { Redis } from './redis'
import { createLocalVideoChannel } from './video-channel'
import { createWatchLaterPlaylist } from './video-playlist'
type ChannelNames = { name: string, displayName: string }
2019-08-15 11:53:26 +02:00
function buildUser (options: {
username: string
password: string
email: string
role?: UserRole // Default to UserRole.User
adminFlags?: UserAdminFlag // 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,
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
2021-06-15 09:17:19 +02:00
const channelAttributes = await buildChannelAttributes(userCreated, t, channelNames)
2019-08-20 19:05:31 +02:00
const videoChannel = await createLocalVideoChannel(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) {
2019-06-11 11:54:33 +02:00
const verificationString = await Redis.Instance.setVerifyEmailVerificationString(user.id)
let url = WEBSERVER.URL + '/verify-account/email?userId=' + user.id + '&verificationString=' + verificationString
if (isPendingEmail) url += '&isPendingEmail=true'
const email = isPendingEmail ? user.pendingEmail : user.email
const username = user.username
2019-06-11 11:54:33 +02:00
Emailer.Instance.addVerifyEmailJob(username, email, url)
2019-06-11 11:54:33 +02:00
}
2020-09-25 16:19:35 +02:00
async function getOriginalVideoFileTotalFromUser (user: MUserId) {
// Don't use sequelize because we need to use a sub query
const query = UserModel.generateUserQuotaBaseSQL({
withSelect: true,
2022-05-04 10:07:06 +02:00
whereUserId: '$userId',
daily: false
2020-09-25 16:19:35 +02:00
})
const base = await UserModel.getTotalRawQuery(query, user.id)
2021-06-16 15:14:41 +02:00
return base + LiveQuotaStore.Instance.getLiveQuotaOf(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) {
// Don't use sequelize because we need to use a sub query
const query = UserModel.generateUserQuotaBaseSQL({
withSelect: true,
whereUserId: '$userId',
2022-05-04 10:07:06 +02:00
daily: true
2020-09-25 16:19:35 +02:00
})
const base = await UserModel.getTotalRawQuery(query, user.id)
2021-06-16 15:14:41 +02:00
return base + LiveQuotaStore.Instance.getLiveQuotaOf(user.id)
2020-09-25 16:19:35 +02:00
}
2021-06-16 15:14:41 +02:00
async function isAbleToUploadVideo (userId: number, newVideoSize: number) {
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
])
2021-06-16 15:14:41 +02:00
const uploadedTotal = newVideoSize + totalBytes
const uploadedDaily = newVideoSize + totalBytesDaily
2020-09-25 16:19:35 +02:00
2022-02-11 10:51:33 +01:00
logger.debug(
'Check user %d quota to upload another video.', userId,
{ totalBytes, totalBytesDaily, videoQuota: user.videoQuota, videoQuotaDaily: user.videoQuotaDaily, newVideoSize }
)
2020-09-25 16:19:35 +02:00
if (user.videoQuotaDaily === -1) return uploadedTotal < user.videoQuota
if (user.videoQuota === -1) return uploadedDaily < user.videoQuotaDaily
return uploadedTotal < user.videoQuota && uploadedDaily < user.videoQuotaDaily
}
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,
2020-09-25 16:19:35 +02:00
sendVerifyUserEmail,
isAbleToUploadVideo,
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,
2022-03-22 16:58:49 +01:00
myVideoStudioEditionFinished: UserNotificationSettingValue.WEB
}
return UserNotificationSettingModel.create(values, { transaction: t })
2018-12-26 10:36:24 +01:00
}
2021-06-15 09:17:19 +02:00
async function buildChannelAttributes (user: MUser, transaction?: Transaction, channelNames?: ChannelNames) {
if (channelNames) return channelNames
let channelName = user.username + '_channel'
// Conflict, generate uuid instead
2021-06-15 09:17:19 +02:00
const actor = await ActorModel.loadLocalByName(channelName, transaction)
if (actor) channelName = buildUUID()
const videoChannelDisplayName = `Main ${user.username} channel`
return {
name: channelName,
displayName: videoChannelDisplayName
}
}